Защита заголовков

Заголовки часто подключают другие заголовки. Поэтому один заголовок легко может оказаться подключённым дважды в одном исходном файле.

В таком случае каждое объявление в нём появляется дважды. Для определений типов, таких как struct или typedef, это ошибка компиляции: тип нельзя определить более одного раза.

Предположим, что a.h и b.h оба подключают types.h. В исходном файле, который подключает оба заголовка, types.h окажется вставлен дважды.

Препроцессор без каких-либо проверок копирует текст заголовка, поэтому определения из types.h дублируются и возникает ошибка повторного определения.

Защита от повторного включения — это небольшой приём препроцессора, делающий заголовок безопасным для многократного подключения.

Она оборачивает весь заголовок в условную конструкцию, поэтому содержимое обрабатывается только при первом подключении. Последующие подключения полностью пропускаются.

При первом обнаружении заголовка TYPES_H ещё не определён, поэтому #ifndef имеет значение true и содержимое обрабатывается. Затем #define задаёт этот макрос.

При последующем подключении TYPES_H уже существует, поэтому #ifndef имеет значение false, и препроцессор переходит к #endif.

Вот реалистичный заголовок с защитой определения типа.

Даже если множество файлов подключит point.h напрямую или косвенно, структура Point будет определена ровно один раз в каждой единице трансляции.

Имя макроса защиты должно быть уникальным во всём проекте, иначе два заголовка могут конфликтовать и незаметно скрывать друг друга.

Обычно имя получают из имени файла, записанного заглавными буквами: point.h превращается в POINT_H, а net/socket.h — в NET_SOCKET_H.

Идентификаторы, начинающиеся с подчёркивания и заглавной буквы или содержащие двойные подчёркивания, зарезервированы компилятором и стандартной библиотекой.

Избегайте таких защитных имён, как __POINT_H__. Обычная форма с подчёркиванием в конце, например POINT_H, безопасна и понятна.

Большинство современных компиляторов поддерживает #pragma once — одну строку в начале заголовка, выполняющую ту же задачу.

Она короче и предотвращает конфликты имён, но не входит в стандарт C. Традиционные защитные конструкции #ifndef работают везде.

Защитные конструкции #ifndef полностью переносимы и соответствуют стандарту, но требуют уникального макроса для каждого заголовка.

#pragma once компактна и не вызывает конфликтов, но зависит от поддержки компилятором. Некоторые проекты используют оба варианта: pragma вместе с классической защитной конструкцией для максимальной надёжности.

Защита от повторного включения предотвращает дублирование в одном исходном файле во время его компиляции.

Она не мешает обработать заголовок по одному разу в каждом отдельном файле .c. Это нормально, поскольку каждый исходный файл является отдельной единицей трансляции.

Добавляйте защиту от повторного включения в каждый создаваемый заголовок с самой первой строки. Это занимает три строки и предотвращает целый класс непонятных ошибок.

Даже простые заголовки позже могут подключаться косвенно через другие, поэтому защита с самого начала избавляет от проблем.

Проверьте, насколько хорошо Вы понимаете защиту от повторного включения.

Вы узнали, почему повторное включение заголовка вызывает ошибки повторного определения и как защитная конструкция предотвращает их.

Используйте #ifndef/#define/#endif с уникальным макросом или #pragma once. Далее мы рассмотрим обмен переменными между файлами с помощью extern.