pragma once (pragma once)

Правильный заголовок этой статьи — #pragma once. Он заменён на другой из-за технических ограничений.

В языках программирования Си и C++ #pragma once — нестандартная, но широко распространённая препроцессорная директива, разработанная для контроля за тем, чтобы конкретный исходный файл при компиляции подключался строго один раз. То есть, #pragma once применяется для тех же целей, что и include guard, но требует меньше кода и не допускает возможности коллизии имён. В наборе компиляторов GCC до версии 3.4 считалась устаревшей и для применения не рекомендовалась. Однако, из-за широкого применения это решение было изменено.

В статье об include guard приводится пример ситуации, в которой нужно использовать тот или иной метод. Выходом является использование #include guard, приведённое там же; вариантом использования #pragma once может быть:

File «grandfather.h»

#pragma once

struct foo {
    int member;
};

File «father.h»

#include "grandfather.h"

File «child.c»

#include "grandfather.h"
#include "father.h"

Поддержка компиляторов

Компилятор	#pragma once
Clang	Да
Comeau C/C++	Да
C++Builder XE3	Да
Digital Mars C++	Да
GCC	Да (с версии 3.4)
HP C/aC++	Да (по крайней мере с версии A.06.12)
IBM XL C/C++	Да (с версии 13.1.1)
Intel C++ Compiler	Да
Microsoft Visual C++	Да (с версии 4.2)
Pelles C	Да
ARM DS-5	Да
IAR C/C++	Да
Solaris Studio C/C++	Нет

Достоинства и недостатки

Применение #pragma once вместо include guard увеличит скорость компиляции во многих случаях благодаря высокоуровневому механизму; компилятор может самостоятельно сравнивать имена файлов или inode'ы без необходимости вызова препроцессора Си для проверки заголовка на наличие #ifndef и #endif.

С другой стороны, некоторые компиляторы, как например, GCC, также используют специальный код для распознавания и оптимизации обработки include guard.

Из-за того, что компилятор сам по себе отвечает за обработку #pragma once, программисту нет необходимости создавать новые имена, например, GRANDFATHER_H. Это исключает риск коллизии имён, то есть заголовочный файл не сможет вызвать ошибку при его подключении. Также приходится набирать меньше текста, нежели при использовании include guard.

Тем не менее, такая высокоуровневая обработка ускоряется в обоих случаях, но программисту приходится полагаться на корректную обработку компилятором #pragma once. Если компилятор совершает ошибку, например, не может распознать ситуацию, когда две символьные ссылки с различными именами указывают на один и тот же файл, то компиляция завершается с ошибкой. Компиляторами, содержащими ошибки, связанные с #pragma once, являются LCC-Win32 версии 2004 года и GCC версии 1998 года. GCC первоначально выдавал предупреждение об отключении #pragma once, если компилируемый код использовал её. Тем не менее, в релизе 3.4 GCC код обработки команды #pragma once был исправлен для корректной работы с символьными и жёсткими ссылками. Данная возможность была сочтена полезной и предупреждение было убрано.

Можно использовать обе команды, #pragma once и include guards, для написания переносимого кода, что также может принести выгоду от применения #pragma once при оптимизации (если компилятор её поддерживает):

File «grandfather.h»

#pragma once
#ifndef GRANDFATHER_H
#define GRANDFATHER_H

struct foo
{
    int member;
};

#endif /* GRANDFATHER_H */

Дополнительные источники

• «Pragma Directives (C/C++)» на сайте MSDN
• GCC Pragma и другие команды на сайте GNU Org