Include-guards

Kopteksten sluiten vaak andere kopteksten in. Daardoor kan één koptekst eenvoudig twee keer in hetzelfde bronbestand worden opgenomen.

In dat geval komt elke declaratie erin twee keer voor. Voor typedefinities zoals struct of typedef is dat een compilatiefout: een type mag niet meer dan één keer worden gedefinieerd.

Stel dat a.h en b.h allebei types.h insluiten. Een bronbestand dat beide insluit, bevat uiteindelijk twee keer de tekst van types.h.

De preprocessor kopieert de tekst van de koptekst blind, waardoor de definities in types.h worden gedupliceerd en een fout wegens herdefinitie ontstaat.

Een insluitbeveiliging is een kleine preprocessortruc die ervoor zorgt dat een koptekst veilig meerdere keren kan worden ingesloten.

Deze wikkelt de hele koptekst in een voorwaarde, zodat de inhoud alleen de eerste keer wordt verwerkt. Latere insluitingen worden volledig overgeslagen.

De eerste keer dat de koptekst wordt gezien, is TYPES_H niet gedefinieerd. Daarom is #ifndef waar en wordt de inhoud verwerkt. Daarna stelt #define de macro in.

Bij elke latere insluiting bestaat TYPES_H al. Daarom is #ifndef onwaar en springt de preprocessor door naar #endif.

Hier staat een realistische koptekst met een beveiliging die een typedefinitie beschermt.

Zelfs als veel bestanden point.h direct of indirect insluiten, wordt de Point-structuur precies één keer per vertaaleenheid gedefinieerd.

De macronaam van de beveiliging moet uniek zijn binnen je hele project, anders kunnen twee kopteksten botsen en elkaar ongemerkt verbergen.

Een veelgebruikte conventie leidt de naam af van de bestandsnaam in hoofdletters: point.h wordt POINT_H en net/socket.h wordt NET_SOCKET_H.

Identifiers die beginnen met een underscore gevolgd door een hoofdletter, of die dubbele underscores bevatten, zijn gereserveerd voor de compiler en de standaardbibliotheek.

Vermijd beveiligingen zoals __POINT_H__. Een eenvoudige vorm met een underscore aan het einde, zoals POINT_H, is veilig en duidelijk.

De meeste moderne compilers ondersteunen #pragma once, één regel bovenaan een koptekst die hetzelfde doet.

Dit is korter en voorkomt botsingen tussen namen, maar maakt geen deel uit van de C-standaard. Traditionele #ifndef-beveiligingen werken overal.

#ifndef-beveiligingen zijn volledig overdraagbaar en standaard, maar vereisen voor elke koptekst een unieke macro.

#pragma once is compact en voorkomt botsingen, maar is afhankelijk van compilerondersteuning. Sommige projecten gebruiken beide: een pragma plus een klassieke beveiliging voor maximale veiligheid.

Een insluitbeveiliging voorkomt dubbele opname binnen één bronbestand terwijl dat wordt gecompileerd.

De beveiliging voorkomt niet dat een koptekst één keer wordt verwerkt in elk afzonderlijk .c-bestand. Dat is prima, omdat elk bronbestand een afzonderlijke vertaaleenheid is.

Voeg vanaf de allereerste regel een insluitbeveiliging toe aan elke koptekst die je schrijft. Dit kost drie regels en voorkomt een hele categorie verwarrende fouten.

Zelfs eenvoudige kopteksten kunnen later indirect via andere kopteksten worden ingesloten, dus vanaf het begin beveiligen bespaart problemen.

Je hebt geleerd waarom het tweemaal insluiten van een koptekst fouten wegens herdefinitie veroorzaakt en hoe een insluitbeveiliging dit voorkomt.

Gebruik #ifndef/#define/#endif met een unieke macro, of #pragma once. Vervolgens bekijken we hoe je variabelen met extern tussen bestanden deelt.