Pragma once

Материал из Википедии — свободной энциклопедии
Перейти к: навигация, поиск
Правильный заголовок этой статьи — #pragma once. Он показан некорректно из-за технических ограничений.

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

В статье об 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 Да[3]
Comeau C/C++ Да [4]
C++Builder XE3 Да[5]
Digital Mars C++ Да[6]
GCC Да[7] (с версии 3.4[8])
HP C/aC++ Да[9] (по крайней мере с версии A.06.12)
IBM XL C/C++ Да[10] (с версии 13.1.1)
Intel C++ Compiler Да[11]
Microsoft Visual C++ Да[12] (с версии 4.2)
Pelles C Да[13]
ARM DS-5 Да[14]
IAR C/C++ Да[15]
Solaris Studio C/C++ Нет [16][17]

Достоинства и недостатки[править | править вики-текст]

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

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

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

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

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

File «grandfather.h»
#pragma once
#ifndef GRANDFATHER_H
#define GRANDFATHER_H

struct foo
{
    int member;
};

#endif /* GRANDFATHER_H */

Примечания[править | править вики-текст]

  1. 1 2 3 The C Preprocessor. Once-Only Include Files
  2. Bug 11569 – there's no substitute for #pragma once
  3. clang: clang: Pragma.cpp Source File. Clang.llvm.org. Проверено 19 августа 2013.
  4. Comeau C++ Pre-Release User Documentation: Pragmas. Comeaucomputing.com. Проверено 19 августа 2013.
  5. #pragma once - RAD Studio XE3. Docwiki.embarcadero.com (2 декабря 2010). Проверено 19 августа 2013.
  6. Pragmas. Digital Mars. Проверено 19 августа 2013.
  7. Alternatives to Wrapper #ifndef. Gcc.gnu.org. Проверено 20 августа 2013.
  8. GCC 3.4 Release Series — Changes, New Features, and Fixes. Gcc.gnu.org. Проверено 19 августа 2013.
  9. HP aC++/HP ANSI C A.06.26 Release Notes HP Integrity servers (англ.). HP Support Center. Проверено 5 июня 2016.
  10. Supported GCC pragmas. IBM. Проверено 20 февраля 2015.
  11. Diagnostic 1782: #pragma once is obsolete. Use #ifndef guard instead.. Intel Developer Zones. Проверено 4 декабря 2013.
  12. once (C/C++). Msdn.microsoft.com. Проверено 19 августа 2013.
  13. IDE help/documentation
  14. ARM Information Center. ARM. Проверено 17 декабря 2013.
  15. IAR C/C++ Development Guide. IAR Systems. Проверено 4 декабря 2013.
  16. Solaris Studio 12.4: C++ User's Guide. Oracle. Проверено 20 февраля 2015.
  17. Solaris Studio 12.4: C User's Guide. Oracle. Проверено 20 февраля 2015.
  18. Сообщение из обсуждения standard change. Lcc-win32 accepts and implements #pragma once
  19. Сообщение из обсуждения thoughts on an old proposal: #once
  20. Obsolete once-only headers
  21. GCC 3.4 Release Series. Changes, New Features, and Fixes

Дополнительные источники[править | править вики-текст]