Strażniki dołączania

Nagłówki często dołączają inne nagłówki. Łatwo więc doprowadzić do sytuacji, w której jeden nagłówek zostanie dołączony dwukrotnie do tego samego pliku źródłowego.

W takim przypadku każda deklaracja z tego nagłówka pojawia się dwa razy. W przypadku definicji typów, takich jak struct lub typedef, powoduje to błąd kompilacji: typu nie można definiować więcej niż raz.

Załóżmy, że a.h i b.h oba dołączają types.h. Plik źródłowy, który dołącza oba nagłówki, otrzyma types.h wstawiony dwukrotnie.

Preprocesor bezwarunkowo kopiuje tekst nagłówków, więc definicje z types.h zostają zduplikowane, powodując błąd ponownej definicji.

Strażnik dołączania to niewielki mechanizm preprocesora, który pozwala bezpiecznie dołączać nagłówek wiele razy.

Obejmuje on cały nagłówek warunkiem, dzięki czemu jego treść jest przetwarzana tylko za pierwszym razem. Kolejne dołączenia są całkowicie pomijane.

Przy pierwszym napotkaniu nagłówka TYPES_H nie jest zdefiniowane, więc warunek #ifndef jest prawdziwy i treść zostaje przetworzona. Następnie #define definiuje to makro.

Przy każdym kolejnym dołączeniu TYPES_H już istnieje, więc warunek #ifndef jest fałszywy, a preprocesor przechodzi do #endif.

Oto realistyczny nagłówek ze strażnikiem chroniącym definicję typu.

Nawet jeśli wiele plików dołączy point.h bezpośrednio lub pośrednio, struktura Point zostanie zdefiniowana dokładnie raz w każdej jednostce translacji.

Makro strażnika musi mieć unikatową nazwę w całym projekcie, ponieważ w przeciwnym razie dwa nagłówki mogą wejść ze sobą w konflikt i po cichu wzajemnie się ukryć.

Typowa konwencja polega na utworzeniu nazwy na podstawie nazwy pliku, zapisanej wielkimi literami: point.h staje się POINT_H, a net/socket.h — NET_SOCKET_H.

Identyfikatory zaczynające się od podkreślenia, po którym występuje wielka litera, oraz identyfikatory zawierające podwójne podkreślenie są zastrzeżone dla kompilatora i biblioteki standardowej.

Należy unikać strażników takich jak __POINT_H__. Zwykła forma z podkreśleniem na końcu, na przykład POINT_H, jest bezpieczna i czytelna.

Większość współczesnych kompilatorów obsługuje #pragma once — pojedynczą linię na początku nagłówka, która pełni tę samą funkcję.

To rozwiązanie jest krótsze i eliminuje kolizje nazw, ale nie należy do standardu C. Tradycyjne strażniki #ifndef działają wszędzie.

Strażniki #ifndef są w pełni przenośne i zgodne ze standardem, ale wymagają unikatowego makra dla każdego nagłówka.

#pragma once jest zwięzłe i nie powoduje kolizji, ale zależy od obsługi przez kompilator. Niektóre projekty używają obu rozwiązań: pragmy oraz klasycznego strażnika dla maksymalnego bezpieczeństwa.

Strażnik dołączania zapobiega wielokrotnemu dołączeniu nagłówka w obrębie jednego pliku źródłowego podczas jego kompilacji.

Nie zapobiega przetworzeniu nagłówka po razie w każdym osobnym pliku .c. To prawidłowe działanie, ponieważ każdy plik źródłowy jest odrębną jednostką translacji.

Do każdego tworzonego nagłówka należy dodać strażnik już od pierwszej linii. Wymaga to trzech linii kodu i zapobiega całej klasie trudnych do zrozumienia błędów.

Nawet proste nagłówki mogą później zostać dołączone pośrednio przez inne pliki, dlatego dodanie strażnika od początku pozwala uniknąć problemów.

Sprawdź znajomość strażników dołączania.

Wiesz już, dlaczego dwukrotne dołączenie nagłówka powoduje błędy ponownej definicji oraz jak zapobiega im strażnik dołączania.

Używaj #ifndef/#define/#endif z unikatowym makrem albo #pragma once. Następnie przyjrzymy się udostępnianiu zmiennych między plikami za pomocą extern.