How To Initialize Private Static Members in C++ - Stack Overflow

Download as pdf or txt
Download as pdf or txt
You are on page 1of 18

2021/10/16 下午11:16 initialization - How to initialize private static members in C++?

- Stack Overflow

How to initialize private static members in C++?


stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848

569

What is the best way to initialize a private, static data member in C++? I tried this in my
header file, but it gives me weird linker errors:

class foo

private:

static int i;

};

int foo::i = 0;

I'm guessing this is because I can't initialize a private member from outside the class. So
what's the best way to do this?

c++ initialization static-members


edited Mar 20 '18 at 21:27

Ciro Santilli 新疆再教育营六四事件法轮功郝海东


274k7777 gold badges10111011 silver badges816816 bronze badges

asked Oct 9 '08 at 3:34

Jason Baker
176k125125 gold badges355355 silver badges502502 bronze badges

Hi Jason. I didn't find a comment on default initialization of static members (esp.


integral ones). In fact you need to write int foo::i so that the linker can find it, but it will
be automatically initialized with 0! This line would be sufficient: int foo::i; (This is valid
for all objects stored in the static memory, the linker is in charge of initializing the
static objects.)
– Nico
Jul 18 '12 at 9:59
1

The answers below do not apply for a template class. They say: the initialization must
go into the source file. For a template class, this is neither possible, nor necessary.
– Joachim W
Jun 9 '16 at 15:20

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 1/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

C++17 allows inline initialization of static data members (even for non-integer types):
inline static int x[] = {1, 2, 3}; . See
en.cppreference.com/w/cpp/language/static#Static_data_members
– Vladimir Reshetnikov
Feb 14 '18 at 21:59

Add a comment

18 Answers

Active
Oldest
Votes
613

The class declaration should be in the header file (Or in the source file if not shared).
File: foo.h

class foo

private:

static int i;

};

But the initialization should be in source file.


File: foo.cpp

int foo::i = 0;

If the initialization is in the header file then each file that includes the header file will have a
definition of the static member. Thus during the link phase you will get linker errors as the
code to initialize the variable will be defined in multiple source files.
The initialisation of the
static int i must be done outside of any function.

Note: Matt Curtis: points out that C++ allows the simplification of the above if the static
member variable is of const int type (e.g. int , bool , char ). You can then declare and
initialize the member variable directly inside the class declaration in the header file:

class foo

private:

static int const i = 42;

};

edited Oct 26 '19 at 17:41

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 2/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

Mark
6921212 silver badges2525 bronze badges

answered Oct 9 '08 at 3:36

Martin York
240k7777 gold badges314314 silver badges536536 bronze badges

Yes. But I am assuming the question has been simplified. Technically the declaration
and definition can all be in a single source file. But that then limits the use of class by
other classes.
– Martin York
Oct 9 '08 at 3:40
11

Note that this isn't just a question of how the value is initialized: const integral types
defined like this may be turned into compile time constants by the implementation.
This isn't always what you want, since it ups the binary dependency: client code needs
recompilation if the value changes.
– Steve Jessop
Oct 9 '08 at 11:19
5

@Martin: in addition to the correction s/POD/integral type/, if the address is ever


taken then there needs to be a definition also. Strange as it may sound, the declaration
with initializer, in the class definition, is not a definition. The templated const idiom
provides a workaround for the cases where you need the definition in a header file.
Another and simpler workaround is a function that produces the value of a local static
constant. Cheers & hth.,
– Cheers and hth. - Alf
Oct 15 '10 at 18:13
3

You might add a clarification that int foo::i =0; should not be inside a function
(including the main function). I had it at the beginning of my main function and it
doesn't like that.
– qwerty9967
Apr 15 '13 at 19:33

Show 18 more comments

100

For a variable:

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 3/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

foo.h:

class foo

private:

static int i;

};

foo.cpp:

int foo::i = 0;

This is because there can only be one instance of foo::i in your program. It's sort of the
equivalent of extern int i in a header file and int i in a source file.

For a constant you can put the value straight in the class declaration:

class foo

private:

static int i;

const static int a = 42;

};

answered Oct 9 '08 at 3:41

Matt Curtis
22k88 gold badges5858 silver badges6363 bronze badges

Since when, C++ allows to be just good with declaration in-class and no definition for
integral types. Since C++98 itself or C++03 or when ? Please share authentic links
please. C++ standard wording is not in sync with the compilers. They mention the
member shall still be defined if they are used. So, I don't need the C++ Standard
quoting though
– smRaj
Sep 20 '14 at 15:42
2

Show 3 more comments


65

Since C++17, static members may be defined in the header with the inline keyword.

http://en.cppreference.com/w/cpp/language/static

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 4/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

"A static data member may be declared inline. An inline static data member can be defined in
the class definition and may specify a default member initializer. It does not need an out-of-
class definition:"

struct X

inline static int n = 1;

};

edited Sep 8 '17 at 1:29

Xunie
38222 silver badges1616 bronze badges

answered Jul 12 '17 at 15:34

Die in Sente
8,99522 gold badges3333 silver badges3838 bronze badges

33

For future viewers of this question, I want to point out that you should avoid what
monkey0506 is suggesting.

Header files are for declarations.

Header files get compiled once for every .cpp file that directly or indirectly #includes
them, and code outside of any function is run at program initialization, before main() .

By putting: foo::i = VALUE; into the header, foo:i will be assigned the value VALUE
(whatever that is) for every .cpp file, and these assignments will happen in an
indeterminate order (determined by the linker) before main() is run.

What if we #define VALUE to be a different number in one of our .cpp files? It will
compile fine and we will have no way of knowing which one wins until we run the program.

Never put executed code into a header for the same reason that you never #include a
.cpp file.

include guards (which I agree you should always use) protect you from something different:
the same header being indirectly #include d multiple times while compiling a single .cpp
file

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 5/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

edited May 23 '17 at 11:47

CommunityBot
111 silver badge

answered Dec 27 '12 at 15:37

Joshua Clayton
1,5671616 silver badges2525 bronze badges

You're right about this of course, except in the case of a class template (which isn't
asked about, but I happen to be dealing with a lot). So if the class is fully defined and
not a class template, then put these static members in a separate CPP file, but for class
templates the definition has to be in the same translation unit (e.g., the header file).
– monkey0506
Jan 18 '13 at 20:22

@monkey_05_06: That just seems to be an argument to avoid static member in


templated code: You already end up with one static member for each instantiation of
the class. the problem is worsened by possibly compiling the header into multiple cpp
files... You could get a raft of conflicting definitions.
– Joshua Clayton
Feb 26 '13 at 5:13
1

Your argument is really huge stretch. First you cannot #define VALUE because macros
name has ot be a valid identifier. And Even if you could - who would do that? Header
files are for declaration - ? C'mon.. The only cases where you should avoid putting
values in the header is to fight odr-used. And putting the value in the header may lead
to unnecessary recompilation whenever you need to change the value.
– Aleksander Fular
Mar 4 '16 at 15:39

Add a comment
23

With a Microsoft compiler[1], static variables that are not int -like can also be defined in a
header file, but outside of the class declaration, using the Microsoft specific
__declspec(selectany) .

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 6/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

class A

static B b;

__declspec(selectany) A::b;

Note that I'm not saying this is good, I just say it can be done.

[1] These days, more compilers than MSC support __declspec(selectany) - at least gcc and
clang. Maybe even more.

edited Mar 24 '15 at 8:59

answered Oct 9 '08 at 5:45

Johann Gerell
23.8k99 gold badges6666 silver badges119119 bronze badges

Add a comment
18

int foo::i = 0;

Is the correct syntax for initializing the variable, but it must go in the source file (.cpp) rather
than in the header.

Because it is a static variable the compiler needs to create only one copy of it. You have to
have a line "int foo:i" some where in your code to tell the compiler where to put it otherwise
you get a link error. If that is in a header you will get a copy in every file that includes the
header, so get multiply defined symbol errors from the linker.

answered Oct 9 '08 at 3:42

David Dibben
17.2k66 gold badges4040 silver badges4141 bronze badges

Add a comment
14

If you want to initialize some compound type (f.e. string) you can do something like that:

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 7/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

class SomeClass {

static std::list<string> _list;

public:

static const std::list<string>& getList() {

struct Initializer {

Initializer() {

// Here you may want to put mutex

_list.push_back("FIRST");

_list.push_back("SECOND");

....

static Initializer ListInitializationGuard;

return _list;

};

As the ListInitializationGuard is a static variable inside SomeClass::getList() method


it will be constructed only once, which means that constructor is called once. This will
initialize _list variable to value you need. Any subsequent call to getList will simply
return already initialized _list object.

Of course you have to access _list object always by calling getList() method.

edited Oct 6 '15 at 21:09

Ziezi
6,05333 gold badges3434 silver badges4646 bronze badges

answered Nov 23 '14 at 11:43

Kris Kwiatkowski
32122 silver badges88 bronze badges

Here is a version of this idiom that does not require creating one method per member
object: stackoverflow.com/a/48337288/895245
– Ciro Santilli 新疆再教育营六四事件法轮功郝海东
Jan 19 '18 at 8:56

Add a comment
11

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 8/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

I don't have enough rep here to add this as a comment, but IMO it's good style to write your
headers with #include guards anyway, which as noted by Paranaix a few hours ago would
prevent a multiple-definition error. Unless you're already using a separate CPP file, it's not
necessary to use one just to initialize static non-integral members.

#ifndef FOO_H

#define FOO_H

#include "bar.h"

class foo

private:

static bar i;

};

bar foo::i = VALUE;

#endif

I see no need to use a separate CPP file for this. Sure, you can, but there's no technical reason
why you should have to.

answered Jan 7 '12 at 19:42

monkey0506
2,25611 gold badge1919 silver badges2626 bronze badges

24

#include guards just prevent multiple definitions per translation unit.


– Paul Fultz II
Apr 20 '12 at 15:43
3

regarding good style:you should add comment on the closing endif: #endif // FOO_H
– Riga
Jul 4 '12 at 13:08

12

This only works if you have only one compile unit that includes foo.h. If two or more
cpps include foo.h, which is a typical situation, each cpp would declare the same static
variable so the linker would complain with multiple definition of `foo::i' unless you use
a package compilation with the files (compile only one file that include all cpps). But
although package compilation is great the solution to the problem is to declare (int
foo::i = 0;) in a cpp!
– Alejadro Xalabarder
Dec 31 '13 at 2:51
1

Or just use #pragma once


– tambre
Oct 25 '16 at 13:36

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 9/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

Add a comment
11

C++11 static constructor pattern that works for multiple objects

One idiom was proposed at: https://stackoverflow.com/a/27088552/895245 but here goes a


cleaner version that does not require creating a new method per member.

main.cpp

#include <cassert>

#include <vector>

// Normally on the .hpp file.

class MyClass {

public:

static std::vector<int> v, v2;

static struct StaticConstructor {

StaticConstructor() {

v.push_back(1);

v.push_back(2);

v2.push_back(3);

v2.push_back(4);

} _staticConstructor;

};

// Normally on the .cpp file.

std::vector<int> MyClass::v;

std::vector<int> MyClass::v2;

// Must come after every static member.

MyClass::StaticConstructor MyClass::_staticConstructor;

int main() {

assert(MyClass::v[0] == 1);

assert(MyClass::v[1] == 2);

assert(MyClass::v2[0] == 3);

assert(MyClass::v2[1] == 4);

GitHub upstream.

Compile and run:

g++ -ggdb3 -O0 -std=c++11 -Wall -Wextra -pedantic -o main.out main.cpp

./main.out

See also: static constructors in C++? I need to initialize private static objects

Tested on Ubuntu 19.04.

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 10/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

C++17 inline variable

Mentioned at: https://stackoverflow.com/a/45062055/895245 but here is a multifile


runnable example to make it even clearer: How do inline variables work?

edited Nov 12 '19 at 9:32

answered Jan 19 '18 at 8:55

Ciro Santilli 新疆再教育营六四事件法轮功郝海东


274k7777 gold badges10111011 silver badges816816 bronze badges

Add a comment
5

You can also include the assignment in the header file if you use header guards. I have used
this technique for a C++ library I have created. Another way to achieve the same result is to
use static methods. For example...

class Foo

public:

int GetMyStatic() const

return *MyStatic();

private:

static int* MyStatic()

static int mStatic = 0;

return &mStatic;

The above code has the "bonus" of not requiring a CPP/source file. Again, a method I use for
my C++ libraries.

answered Apr 11 '13 at 21:50

user2225284

Add a comment
4

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 11/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

I follow the idea from Karl. I like it and now I use it as well. I've changed a little bit the
notation and add some functionality

#include <stdio.h>

class Foo

public:

int GetMyStaticValue () const { return MyStatic(); }

int & GetMyStaticVar () { return MyStatic(); }

static bool isMyStatic (int & num) { return & num == & MyStatic(); }

private:

static int & MyStatic ()

static int mStatic = 7;

return mStatic;

};

int main (int, char **)

Foo obj;

printf ("mystatic value %d\n", obj.GetMyStaticValue());

obj.GetMyStaticVar () = 3;

printf ("mystatic value %d\n", obj.GetMyStaticValue());

int valMyS = obj.GetMyStaticVar ();

int & iPtr1 = obj.GetMyStaticVar ();

int & iPtr2 = valMyS;

printf ("is my static %d %d\n", Foo::isMyStatic(iPtr1), Foo::isMyStatic(iPtr2));

this outputs

mystatic value 7

mystatic value 3

is my static 1 0

answered Dec 31 '13 at 14:45

Alejadro Xalabarder
1,3031717 silver badges1313 bronze badges

Add a comment
4

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 12/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

The linker problem you encountered is probably caused by:

Providing both class and static member definition in header file,


Including this header in two or more source files.

This is a common problem for those who starts with C++. Static class member must be
initialized in single translation unit i.e. in single source file.

Unfortunately, the static class member must be initialized outside of the class body. This
complicates writing header-only code, and, therefore, I am using quite different approach.
You can provide your static object through static or non-static class function for example:

class Foo

// int& getObjectInstance() const {

static int& getObjectInstance() {

static int object;

return object;

void func() {

int &object = getValueInstance();

object += 5;

};

answered Sep 10 '17 at 10:20

no one special
1,35977 silver badges2323 bronze badges

I'm still a complete n00b as far as C++ goes, but this looks brilliant to me, thank you so
much! I get perfect life-cycle management of the singleton object for free.
– Rafael Kitover
Nov 6 '19 at 15:18

Add a comment
3

Also working in privateStatic.cpp file :

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 13/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

#include <iostream>

using namespace std;

class A

private:

static int v;

};

int A::v = 10; // possible initializing

int main()

A a;

//cout << A::v << endl; // no access because of private scope

return 0;

// g++ privateStatic.cpp -o privateStatic && ./privateStatic

answered Jan 26 '14 at 11:21

andrew
2,83733 gold badges2323 silver badges2727 bronze badges

Add a comment
3

What about a set_default() method?

class foo

public:

static void set_default(int);

private:

static int i;

};

void foo::set_default(int x) {

i = x;

We would only have to use the set_default(int x) method and our static variable
would be initialized.

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 14/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

This would not be in disagreement with the rest of the comments, actually it follows the same
principle of initializing the variable in a global scope, but by using this method we make it
explicit (and easy to see-understand) instead of having the definition of the variable hanging
there.

edited Oct 6 '15 at 20:12

Ziezi
6,05333 gold badges3434 silver badges4646 bronze badges

answered May 23 '14 at 14:28

Arturo Ruiz Mañas


6311 silver badge33 bronze badges

Add a comment
2

One "old-school" way to define constants is to replace them by a enum :

class foo

private:

enum {i = 0}; // default type = int

enum: int64_t {HUGE = 1000000000000}; // may specify another type

};

This way doesn't require providing a definition, and avoids making the constant lvalue,
which can save you some headaches, e.g. when you accidentally ODR-use it.

answered Jun 13 '18 at 21:27

anatolyg
23.8k88 gold badges5151 silver badges116116 bronze badges

Add a comment
1

I just wanted to mention something a little strange to me when I first encountered this.

I needed to initialize a private static data member in a template class.

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 15/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

in the .h or .hpp, it looks something like this to initialize a static data member of a template
class:

template<typename T>

Type ClassName<T>::dataMemberName = initialValue;

edited Oct 1 '16 at 1:27

answered Oct 1 '16 at 1:11

Tyler Heers
11444 bronze badges

Add a comment
1

Here are all possibilities and errors in one simple example ...

#ifndef Foo_h

#define Foo_h

class Foo

static const int a = 42; // OK

static const int b {7}; // OK

//static int x = 42; // ISO C++ forbids in-class initialization of non-const static member
'Foo::x'

//static int y {7}; // ISO C++ forbids in-class initialization of non-const static member
'Foo::x'

static int x;

static int y;

int m = 42;

int n {7};

};

// Foo::x = 42; // error: 'int Foo::x' is private

int Foo::x = 42; // OK in Foo.h if included in only one *.cpp -> *.o file!

int Foo::y {7}; // OK

// int Foo::y {7}; // error: redefinition of 'int Foo::y'

// ONLY if the compiler can see both declarations at the same time it,

// OTHERWISE you get a linker error

#endif // Foo_h

But better place this in Foo.cpp. This way you can separately compile each file and link them
later, otherwise Foo:x will be present in multiple object files and cause a linker error. ...

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 16/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

// Foo::x = 42; // error: 'int Foo::x' is private, bad if Foo::X is public!

int Foo::x = 42; // OK in Foo.h if included in only one *.cpp -> *.o file!

int Foo::y {7}; // OK

answered Sep 22 at 7:34

cat
2,76111 gold badge2121 silver badges2828 bronze badges

Add a comment
0

Does this serves your purpose?

//header file

struct MyStruct {

public:

const std::unordered_map<std::string, uint32_t> str_to_int{

{ "a", 1 },

{ "b", 2 },

...

{ "z", 26 }
};

const std::unordered_map<int , std::string> int_to_str{

{ 1, "a" },

{ 2, "b" },

...

{ 26, "z" }
};

std::string some_string = "justanotherstring";

uint32_t some_int = 42;

static MyStruct & Singleton() {

static MyStruct instance;

return instance;

private:

MyStruct() {};
};

//Usage in cpp file

int main(){

std::cout<<MyStruct::Singleton().some_string<<std::endl;

std::cout<<MyStruct::Singleton().some_int<<std::endl;

return 0;

answered Sep 2 '16 at 11:50

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 17/18
2021/10/16 下午11:16 initialization - How to initialize private static members in C++? - Stack Overflow

David Nogueira
35211 silver badge1414 bronze badges

Add a comment

Highly active question. Earn 10 reputation (not counting the association bonus) in order
to answer this question. The reputation requirement helps protect this question from spam
and non-answer activity.

Not the answer you're looking for? Browse other questions tagged
c++ initialization static-members or ask your own question.

https://stackoverflow.com/questions/185844/how-to-initialize-private-static-members-in-c/185848 18/18

You might also like