Include-Guards

Header binden häufig andere Header ein. Daher kann ein Header leicht zweimal in derselben Quelldatei eingebunden werden.

In diesem Fall erscheint jede darin enthaltene Deklaration zweimal. Bei Typdefinitionen wie struct oder typedef führt das zu einem Kompilierungsfehler: Ein Typ kann nicht mehr als einmal definiert werden.

Angenommen, a.h und b.h binden beide types.h ein. Eine Quelldatei, die beide Header einbindet, enthält types.h anschließend zweimal.

Der Präprozessor kopiert den Text von Headern blind. Dadurch werden die Definitionen aus types.h dupliziert und ein Fehler wegen einer Neudefinition ausgelöst.

Ein Include-Guard ist ein kleiner Trick des Präprozessors, der dafür sorgt, dass ein Header gefahrlos mehrfach eingebunden werden kann.

Er umschließt den gesamten Header mit einer Bedingung, sodass der Inhalt nur beim ersten Mal verarbeitet wird. Spätere Einbindungen werden vollständig übersprungen.

Beim ersten Einlesen des Headers ist TYPES_H noch nicht definiert. Daher ist #ifndef wahr und der Inhalt wird verarbeitet. Anschließend definiert #define das Makro.

Bei jeder späteren Einbindung existiert TYPES_H bereits. Deshalb ist #ifndef falsch und der Präprozessor springt zu #endif.

Hier sehen Sie einen realistischen Header, dessen Include-Guard eine Typdefinition schützt.

Selbst wenn viele Dateien point.h direkt oder indirekt einbinden, wird die Struktur Point pro Übersetzungseinheit genau einmal definiert.

Das Guard-Makro muss im gesamten Projekt eindeutig sein, da sonst zwei Header miteinander in Konflikt geraten und sich gegenseitig unbemerkt ausblenden könnten.

Eine verbreitete Konvention leitet den Namen in Großbuchstaben vom Dateinamen ab: Aus point.h wird POINT_H, aus net/socket.h wird NET_SOCKET_H.

Bezeichner, die mit einem Unterstrich gefolgt von einem Großbuchstaben beginnen oder doppelte Unterstriche enthalten, sind für den Compiler und die Standardbibliothek reserviert.

Vermeiden Sie Guards wie __POINT_H__. Eine einfache Form mit nachgestelltem Unterstrich wie POINT_H ist sicher und eindeutig.

Die meisten modernen Compiler unterstützen #pragma once. Eine einzige Zeile am Anfang eines Headers erfüllt damit dieselbe Aufgabe.

Diese Lösung ist kürzer und vermeidet Namenskonflikte, gehört aber nicht zum C-Standard. Herkömmliche #ifndef-Guards funktionieren überall.

#ifndef-Guards sind vollständig portabel und standardkonform, erfordern aber ein eindeutiges Makro für jeden Header.

#pragma once ist kompakt und konfliktfrei, setzt jedoch die Unterstützung durch den Compiler voraus. Manche Projekte verwenden beides: ein Pragma zusammen mit einem klassischen Guard für maximale Sicherheit.

Ein Include-Guard verhindert das doppelte Einbinden innerhalb einer einzelnen Quelldatei während ihrer Kompilierung.

Er verhindert nicht, dass ein Header in jeder separaten .c-Datei einmal verarbeitet wird. Das ist unproblematisch, da jede Quelldatei eine eigene Übersetzungseinheit bildet.

Fügen Sie jeder Header-Datei, die Sie schreiben, bereits ab der ersten Zeile einen Include-Guard hinzu. Das kostet drei Zeilen und verhindert eine ganze Klasse schwer verständlicher Fehler.

Selbst einfache Header können später indirekt über andere Header eingebunden werden. Wenn Sie sie von Anfang an schützen, ersparen Sie sich daher Probleme.

Überprüfen Sie Ihr Verständnis von Include-Guards.

Sie haben gelernt, warum das zweimalige Einbinden eines Headers zu Fehlern wegen Neudefinitionen führt und wie ein Include-Guard dies verhindert.

Verwenden Sie #ifndef/#define/#endif mit einem eindeutigen Makro oder #pragma once. Als Nächstes sehen wir uns an, wie Sie mit extern Variablen zwischen Dateien gemeinsam verwenden.