Defining an extern variable in the same header file

4
votes

I am wondering if it is possible to both declare and define an extern variable in the same header file. I need the variable to be referenced across multiple files, and while I realize there are better ways to achieve this, using extern is the only option in this case. So is it possible to do:

// in main.h
extern int foo;
int foo;

etc...

And then any file which includes main.h will have access to foo? Many examples reference defining the extern'd variable in a separate cpp file, but I'm just wondering if the way I suggested will cause problems across the rest of the project.

3
c++cextern
Read up on the one definition rule. You are asking if you can violate it. – Drew Dormann
It's possible, but not a good idea. There's supposed to be only one actual definition, shared by everything that needs it, that everything else will link to -- if you define it in the header, you get multiple definitions (one in each translation unit that includes the header), which defeats the purpose of using extern. If you only use the header once it'll work, though. – Dmitri
See, amongst other SO questions, How do I use extern to share variables between source files in C? – Jonathan Leffler
it is (almost) always a bad idea to declare ANY variable, struct instance, union instance in a header file, because there will be another instance of such variable for each and every file the header is included in. Strongly suggest: declare the variable instance in some source file and only have the 'extern' statement in the header file. – user3629249

3 Answers

12
votes

If you put a definition in a header file, you will end up with multiple definitions when multiple source files are involved.

For example, suppose both main.c and other.c include foo.h. When you compile each of these files you'll get main.o and other.o, both of which have a definition of int foo. If you then attempt to link main.o and other.o into a single executable, you'll get a linker error stating that int foo was defined twice.

To do this properly, you declare your variable in the header file as extern int foo. Then, in one (and only one) source file you define the variable with int foo.

4
votes

Real definitions (not extern) should not be in a header file.

If you want to have one global variable available from different cpp, you should make two things: definition in one cpp and extern declaration in h.

E.g.:

// global.h
extern int foo;

and 

// global.cpp
int foo;

Then in any file where foo is needed:

#include "global.h"

And, of course, global.cpp have to be part of project (compiled with other files)

1
votes

What you are doing is perfectly legal in C++ only if there aren't multiple files which are defining the same variable.

The variable or function may be defined in another source file, or later in the same file. Declarations of variables and functions at file scope are external by default.

Normally we extern a global variable declared in some other file.

This is as good as a global variable initialized to 0.