Search code examples
c++cmacrosinclude

Why doesn't the compiler automatically add or generate an include guard by default?

I know C or C++ code usually needs to use include guards like this:

#ifndef __A__H__
#define __A__H__
class A{
};
#endif

and to speed up compile time, in other cpp (e.g.:B.cpp), it can change

#include "A.h"

to:

#ifndef __A__H__
#include "A.h"
#endif

but the question is why doesn't the compiler automatically add or generate the include guard, and therefore why does the programmer need to add it manually if an include guard is usually required?

Solution

  • There are times when it is absolutely incorrect to generate the header guard. The standards contain an example: <assert.h> in C and <cassert> in C++.

    The effect of reincluding those headers depends on the state of the NDEBUG macro when the header is (re)included. It is legitimate to write:

    #undef NDEBUG
#include <assert.h>
…code using assert…
#define NDEBUG 1
#include <assert.h>
…more code using assert…

    If the compiler automatically generated a header guard, that would not work correctly. Therefore, compilers do not generate header guards automatically.

    Incidentally, user code should not use header guard macro names that start with double underscore, or underscore capital letter. Such names are reserved for the implementation. In C++, no user-defined name may legitimately contain a double underscore at all. Use something more like:

    #ifndef A_H_INCLUDED
#define A_H_INCLUDED
…body of header…
#endif