Include guard

From Wikipedia, the free encyclopedia

This page should be moved to the Wikibook on C programming.

If you disagree with this, please explain why on its talk page. If this page obviously does not meet the criteria for speedy deletion, or you intend to fix it, please remove this notice, but do not remove this notice from a page that you have created yourself. Administrators, remember to check if anything links here, the page history (last edit) and any revisions of CSD before moving.

The correct title of this article is #include guard. The substitution or omission of a # sign is because of technical restrictions.

In the C programming language, an #include guard is a particular construct used to avoid the problem of double inclusion when dealing with the #include directive, as demonstrated in the following sample C code:

1 Double inclusion
2 Use of #include guards
3 Difficulties
4 See also

[edit] Double inclusion

[edit] File "grandfather.h"

struct foo {
    int member;
};

[edit] File "father.h"

#include "grandfather.h"

[edit] File "child.c"

#include "grandfather.h"
#include "father.h"

Here, the file "child.c" has indirectly included two copies of the text in the header file "grandfather.h". This causes a compilation error, since the structure foo is apparently defined twice!

[edit] Use of #include guards

[edit] File "grandfather.h"

#ifndef H_GRANDFATHER
#define H_GRANDFATHER

struct foo {
    int member;
};

#endif

[edit] File "father.h"

#include "grandfather.h"

[edit] File "child.c"

#include "grandfather.h"
#include "father.h"

Here, the first inclusion of "grandfather.h" causes the macro H_GRANDFATHER to be defined. Then, when "father.h" includes "grandfather.h" the second time, the #ifndef test fails, and the compiler skips down to the #endif, thus avoiding the second definition of struct foo. The program compiles correctly.

[edit] Difficulties

In order for #include guards to work properly, each guard must test and conditionally set a different preprocessor macro. Therefore, a project using #include guards must work out a coherent naming scheme for its include guards, and make sure its scheme doesn't conflict with that of any third-party headers it uses, or with the names of any globally visible macros.

For this reason, many C and C++ implementations provide the non-standard directive #pragma once. This directive, inserted at the top of a header file, will ensure that the file is only included once.