Should variable definition be in header files?

c linker c-preprocessor header-files include-guards
Methos picture Methos · Feb 7, 2010 · Viewed 30.8k times · Source

My very basic knowledge of C and compilation process has gone rusty lately. I was trying to figure out answer to the following question but I could not connect compilation, link and pre-processing phase basics. A quick search on the Google did not help much either. So, I decided to come to the ultimate source of knowledge :)

I know: Variables should not be defined in the .h files. Its ok to declare them there.

Why: Because a header file might get included from multiple places, thus redefining the variable more than one time (Linker gives the error).

Possible work-around: Use header-guards in header files and define variable in that.

Is it really a solution: No. Because header-guards are for preprocessing phase. That is to tell compiler that this part has been already included and do not include it once again. But our multiple definition error comes in the linker part - much after the compilation.

This whole thing has got me confused about how preprocessing & linking work. I thought that preprocessing will just not include the code, if the header guard symbol has been defined. In that case, shouldn't multiple definition of a variable problem also get solved?

What happens that these preprocessing directives save the compilation process from redefining symbols under header guards, but the linker still gets multiple definitions of the symbol?

Answer

Richard Pennington picture Richard Pennington · Feb 7, 2010

One thing that I've used in the past (when global variables were in vogue):

var.h file:

...
#ifdef DEFINE_GLOBALS
#define EXTERN
#else
#define EXTERN extern
#endif
EXTERN int global1;
EXTERN int global2;
...

Then in one .c file (usually the one containing main()):

#define DEFINE_GLOBALS
#include "var.h"

The rest of the source files just include "var.h" normally.

Notice that DEFINE_GLOBALS is not a header guard, but rather allows declaring/defining the variables depending on whether it is defined. This technique allows one copy of the declarations/definitions.

Related questions

Why am I getting "undefined reference to sqrt" error even though I include math.h header?

I'm very new to C and I have this code: #include <stdio.h> #include <math.h> int main(void) { double x = 0.5; double result = sqrt(x); printf("The square root of %lf is %lf\n", x, result); …

Read More
shared global variables in C

How can I create global variables that are shared in C? If I put it in a header file, then the linker complains that the variables are already defined. Is the only way to declare the variable in one of …

Read More
Difference between shared objects (.so), static libraries (.a), and DLL's (.so)?

I have been involved in some debate with respect to libraries in Linux, and would like to confirm some things. It is to my understanding (please correct me if I am wrong and I will edit my post later), that …

Read More