Include guards

Headere inkluderer ofte andre headere. Det er nemt for én header at ende med at blive inkluderet to gange i den samme kildefil.

Når det sker, forekommer alle deklarationer i den to gange. For typedefinitioner som struct eller typedef er det en kompileringsfejl: en type kan ikke defineres mere end én gang.

Antag, at a.h og b.h begge inkluderer types.h. En kildefil, der inkluderer begge, ender med at have types.h indsat to gange.

Præprocessoren kopierer blindt headerteksten, så definitionerne i types.h bliver duplikeret, hvilket udløser en fejl om gentagen definition.

En inklusionsbeskyttelse er et lille præprocessortrick, der gør en header sikker at inkludere mange gange.

Den omslutter hele headeren i en betingelse, så indholdet kun behandles første gang. Senere inklusioner springes helt over.

Første gang headeren ses, er TYPES_H ikke defineret, så #ifndef er sand, og indholdet behandles. Derefter sætter #define makroen.

Ved alle senere inklusioner findes TYPES_H allerede, så #ifndef er falsk, og præprocessoren springer frem til #endif.

Her er en realistisk header med en beskyttelse, der beskytter en typedefinition.

Selv hvis mange filer inkluderer point.h direkte eller indirekte, defineres Point-strukturen præcis én gang pr. translationsenhed.

Beskyttelsesmakroen skal være unik i hele projektet, ellers kan to headere kollidere og skjule hinanden uden en tydelig fejl.

En almindelig konvention danner navnet ud fra filnavnet med store bogstaver: point.h bliver til POINT_H, og net/socket.h bliver til NET_SOCKET_H.

Identifikatorer, der begynder med en understregning efterfulgt af et stort bogstav, eller som indeholder dobbelte understregninger, er reserveret til compileren og standardbiblioteket.

Undgå beskyttelser som __POINT_H__. En enkel afsluttende form som POINT_H er sikker og tydelig.

De fleste moderne compilere understøtter #pragma once, en enkelt linje øverst i en header, der udfører den samme opgave.

Det er kortere og undgår navnekollisioner, men det er ikke en del af C-standarden. Traditionelle #ifndef-beskyttelser fungerer overalt.

#ifndef-beskyttelser er fuldt portable og standardiserede, men kræver en unik makro for hver header.

#pragma once er kompakt og uden kollisionsrisiko, men afhænger af compilerens understøttelse. Nogle projekter bruger begge dele: en pragma plus en klassisk beskyttelse for maksimal sikkerhed.

En inklusionsbeskyttelse forhindrer dobbelt inklusion i en enkelt kildefil, mens den kompileres.

Den forhindrer ikke, at en header behandles én gang i hver separat .c-fil. Det er helt i orden, fordi hver kildefil er en særskilt translationsenhed.

Tilføj en inklusionsbeskyttelse til hver header, du skriver, helt fra første linje. Det koster tre linjer og forhindrer en hel klasse af forvirrende fejl.

Selv simple headere kan senere blive inkluderet indirekte gennem andre, så du sparer problemer ved at beskytte dem fra starten.

Du har lært, hvorfor inklusion af en header to gange forårsager fejl med gentagne definitioner, og hvordan en inklusionsbeskyttelse forhindrer det.

Brug #ifndef/#define/#endif med en unik makro eller #pragma once. Derefter ser vi på, hvordan variabler deles mellem filer med extern.