Quelltext der Seite Include-Guard

Der '''Include-Guard''' oder '''Include-Wächter''' ist eine Programmiertechnik, um in [[C (Programmiersprache)|C]] und [[C++]] das Problem der mehrfachen Einbindung zu lösen.

Dieses Problem tritt auf, wenn innerhalb einer ''Übersetzungseinheit'' mehrmals die gleiche [[Header-Datei]] eingebunden wird. Das geschieht in der Regel unbeabsichtigt, z.&nbsp;B. wenn mehrere Module die gleiche [[Programmbibliothek|Bibliothek]] benutzen.

== Beispiel einer Mehrfacheinbindung ==
Gegeben seien die folgenden beiden [[Header-Datei]]en <code>A.h</code> und <code>B.h</code>, die u.&nbsp;a. jeweils eine [[Klasse (Programmierung)|Klasse]] definieren:
<syntaxhighlight lang="cpp">
// A.h
const int M = 123;

class A
{ /* ... */ };
</syntaxhighlight>

<syntaxhighlight lang="cpp">
// B.h
#include "A.h"

class B : public A
{ /* ... */ };
</syntaxhighlight>

Im Hauptprogramm sollen nun sowohl die Klasse ''A'' als auch ''B'' genutzt werden:

<syntaxhighlight lang="cpp">
// program.cpp
#include "A.h"
#include "B.h"

int main() { /* ... */ }
</syntaxhighlight>

Das Programm lässt sich nicht fehlerfrei kompilieren, weil die Klasse A doppelt definiert wird: Die erste Definition erfolgt beim Einbinden der Header-Datei <code>A.h</code> in Zeile 2. Die zweite Definition erfolgt, weil die Header-Datei <code>B.h</code>, die in Zeile 3 eingebunden wird, selbst wiederum <code>A.h</code> einbindet. Die Klasse (und ggf. weitere Variablen) aus dieser Datei wurden bereits zuvor definiert, was zu einem Fehler der [[Compiler|Kompilierung]] führt.

== Lösung mit Präprozessor-Makros (#ifndef) ==
Der ''[[C-Präprozessor#Bedingte Ersetzung|#ifndef]]-Wrapper'' ist der traditionelle und C-konforme Ansatz. Das Problem der Mehrfacheinbindung wird durch Definition eines eindeutigen [[C-Präprozessor#Definition und Ersetzung von Makros|Präprozessor-Makros]] beim ersten Einbinden der Header-Datei gelöst. War das Makro bereits definiert, werden die nachfolgenden Definitionen des Headers übersprungen:

<syntaxhighlight lang="cpp">
// A.h
#ifndef A_H
#define A_H

class A
{ /* ... */ };

#endif /* A_H */
</syntaxhighlight>

Die obenstehenden Präprozessor-Befehle bewirken, dass beim erstmaligen Einbinden von ''A.h'' (aus ''program.cpp'') das Makro ''A_H'' noch nicht definiert ist und der [[C-Präprozessor|Präprozessor]] die Definitionen durchläuft. Beim zweiten Einbinden (aus ''B.h'') ist das Makro bereits definiert und der Präprozessor überspringt den Block ''#ifndef … #endif''.

Da Makros im globalen Namensraum existieren, kann es hier zu Problemen kommen, wenn versucht wird, den gleichen Namen an anderer Stelle zu verwenden (sog. {{lang|en|''namespace pollution''}}). Dem kann durch die Festlegung von Namenskonventionen zwar vorgebeugt werden, es löst das Problem dennoch nicht.<ref>{{Toter Link |datum=2018-04 |url=http://blogs.msdn.com/b/ericflee/archive/2008/04/17/pragma-once.aspx |text=Eric Fleegal’s WebLog |archivebot=2018-04-15 22:40:35 InternetArchiveBot}} on [[MSDN]] Blogs; abgerufen am 19. August 2011.</ref>
Für compiler-eigene Definitionen und Definitionen in den Standard-Bibliotheken sind [[Bezeichner]] mit führendem Unterstrich (_) reserviert. Ein führender Unterstrich darf nach den aktuellen C- und C++-Standards daher nicht im Applikationscode verwendet werden.<ref>C++ standard (ISO/IEC 14882); [http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2011/n3242.pdf C++ working draft N3242] (PDF; 10&nbsp;MB), Abschnitt 17.6.4.3.2</ref><ref>C standard (ISO/IEC 9899); [http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1124.pdf Committee Draft N1124] (PDF; 3,3&nbsp;MB), Abschnitte 6.10.8 und 7.1.3/1.</ref>

Der ''CPP'', der Präprozessor der [[GNU Compiler Collection|GCC]], erkennt solche Konstrukte automatisch, merkt sich die entsprechenden Dateien und überspringt diese bei nochmaligem Einbinden.<ref name="cpp_onceonlyheaders">[https://gcc.gnu.org/onlinedocs/cpp/Once-Only-Headers.html#Once-Only-Headers Once-Only Headers] im GNU CPP Online Manual. Abgerufen am 19. August 2011.</ref>

== Lösung über Spracherweiterungen (#pragma once) ==
Die meisten gebräuchlichen C- und C++-Compiler unterstützen heute die Spracherweiterung <code>#pragma once</code>. Diese sorgt ebenfalls dafür, dass eine (Header-)Datei nur einmal eingebunden wird, setzt jedoch auf höherer Ebene, direkt am Präprozessor, an und führt auch keine Makros in den globalen Namensraum ein.

Zur Verwendung genügt es, innerhalb der Header-Datei die Präprozessordirektive <code>#pragma once</code> einzufügen:

<syntaxhighlight lang="cpp">
// A.h
#pragma once

class A
{ /* ... */ };
</syntaxhighlight>

Diese Spracherweiterung wird von den folgenden C++-Implementierungen unterstützt:
* [[GNU Compiler Collection|GCC]],<ref>[https://gcc.gnu.org/gcc-3.4/changes.html GCC 3.4 Release Series – Changes, New Features, and Fixes]. Abgerufen am 16. Mai 2014.</ref>
* [[Clang]],<ref> {{Webarchiv|text=clang: Pragma.cpp Source File |url=http://clang.llvm.org/doxygen/Pragma_8cpp-source.html |wayback=20140404052351 |archiv-bot=2018-04-15 22:40:35 InternetArchiveBot }}. Abgerufen am 16. Mai 2014.</ref>
* [[Microsoft Visual C++]],<ref>[http://msdn.microsoft.com/en-us/library/4141z1cx(v=vs.120).aspx MS Developer Network – once (C/C++)]. Abgerufen am 16. Mai 2014.</ref>
* [[Intel C++ Compiler]],
* [[Comeau C++|Comeau C/C++]],<ref>{{Webarchiv|url=http://www.comeaucomputing.com/4.0/docs/userman/pragma.html |wayback=20131211122659 |text=Comeau C++ 4.0 |archiv-bot=2019-09-11 17:36:32 InternetArchiveBot }}−{{Webarchiv|url=http://www.comeaucomputing.com/4.0/docs/userman/pragma.html |wayback=20131211122659 |text=Pre-Release – User-Documentation: Pragmas |archiv-bot=2019-09-11 17:36:32 InternetArchiveBot }}. Abgerufen am 16. Mai 2014.</ref>
* [[C++Builder]] XE3,<ref>[http://docwiki.embarcadero.com/RADStudio/XE3/en/Pragma_once #pragma once - RAD Studio XE3]. Abgerufen am 16. Mai 2014.</ref>
* [[Digital Mars C++]].<ref>[http://www.digitalmars.com/ctg/pragmas.html#once Pragmas #pragma once]. Abgerufen am 16. Mai 2014.</ref>

== Einzelnachweise ==
<references />

[[Kategorie:C (Programmiersprache)]]
[[Kategorie:C++]]