What exactly do C include guards do?

by

It’s a preprocessor macro.

All of it is preprocessor syntax, that basically says, if this macro has not already been defined, define it and include all code between the #ifndef and #endif

What it accomplishes is preventing the inclusion of file more than once, which can lead to problems in your code.

Your question:

And why is it okay to forget the include guard in which case we can also forgot adding #define HEADER_FILE?

It’s OK to forget it because it’s still legal C code without it. The preprocessor processes your file before it’s compiled and includes the specified code in your final program if there’s no logic specifying why it shouldn’t. It’s simply a common practice, but it’s not required.

A simple example might help illustrate how this works:

Your header file, header_file.h we’ll say, contains this:

#ifndef HEADER_FILE
#define HEADER_FILE

int two(void){
    return 2;
}

#endif

In another file (foo.c), you might have:

#include "header_file.h"

void foo() {
    int value = two();
    printf("foo value=%d\n", value);       
}

What this will translate to once it’s “preprocessed” and ready for compilation is this:

int two(void){
    return 2;
}

void foo() {
    int value = two();
    printf("foo value=%d\n", value);       
}

All the include guard is accomplishing here is determining whether or not the header contents between the #ifndef ... and #endif should be pasted in place of the original #include.

However, since that function is not declared extern or static, and is actually implemented in a header file, you’d have a problem if you tried to use it in another source file, since the function definition would not be included.

More Related Contents:

  1. Should variable definition be in header files?
  2. The need for parentheses in macros in C [duplicate]
  3. Overloading Macro on Number of Arguments
  4. C macros and use of arguments in parentheses
  5. Real-world use of X-Macros
  6. Macro definition to determine big endian or little endian machine?
  7. Are typedef and #define the same in c?
  8. Array-size macro that rejects pointers
  9. Header guards in C++ and C
  10. What are C macros useful for?
  11. Opposite of C preprocessor “stringification”
  12. C Macros to create strings
  13. Macro and function with same name
  14. offsetof at compile time
  15. Macros to create strings in C
  16. Creating C macro with ## and __LINE__ (token concatenation with positioning macro)
  17. What are the applications of the ## preprocessor operator and gotchas to consider?
  18. Comma in C/C++ macro
  19. How does the C offsetof macro work? [duplicate]
  20. What does ## mean for the C(C++) preprocessor?
  21. #ifdef inside #define
  22. Is there a good reason for always enclosing a define in parentheses in C?
  23. undefined reference when calling inline function
  24. How do header and source files in C work?
  25. C preprocessor: expand macro in a #warning
  26. What is a good reference documenting patterns of use of X-Macros in C (or possibly C++)?
  27. Do variables declared in a header file give separate copies of the variables to each .c file that includes the header?
  28. Inline function v. Macro in C — What’s the Overhead (Memory/Speed)?
  29. What is ‘:-!!’ in C?
  30. How do I run the preprocessor on local headers only?

Leave a Comment