Что такое guard block в заголовочном файле c
Заголовочные файлы и стражи включения C/C++
Любой заголовочный файл C/C++ должен иметь следующую структуру.
Например, заголовочный файл myFunctions.h, в котором размещены объявления функций f и g, будет выглядеть так:
Зачем нужны заголовочные файлы
В языке C существует соглашение, идущее из основополагающей книги Кернигана и Ритчи, о том, что в месте первого вызова любой функции компилятор должен «знать» тип аргументов и возвращаемого значения функции. В C++ это соглашение было превращено в требование языка. Как показывает практика это соглашение помогает избежать многих нетривиальных ошибок.
Указанное требование тривиально выполняется в простых случаях наподобие (считается, что компилятор просматривает программу сверху-вниз один раз — что, вообще говоря, неверно для современных компиляторов):
Однако если программу немного изменить, то требование уже нарушится:
Хотя в остальном эта программа вполне корректна. В случаях, когда такой порядок определения функций (сначала main, потом f) по какой-то причине более предпочтителен, можно использовать специальный элемент языка, называемый объявлением или прототипом функции f:
Объявление в первой строке сообщает компилятору, что вызовы функции f в дальнейшем тексте предполагают, что эта функция принимает один аргумент типа int и возвращает void.
Объявления следует также использовать, когда одна функция (например, main) вызывает другую (например, f), и при этом вторая функция определена в отдельном исходном файле.
Если функция определена в отдельном файле, то она может использоваться во многих других файлах, и в каждом таком файле придётся добавлять её объявление. Заголовочный файл представляет собой место, где собирается информация, которая возможно потребуется многим другим файлам. Объявления функций представляют классический пример такой информации. Директива препроцессора наподобие
вставляет целиком содержимое указанного заголовочного файла в текущее место исходного файла перед компиляцией (например, в main.c, если в нём встретилась эта строка). После такой вставки в main.c окажутся все объявления функций из файла myFunctions.h и компилятор будет счастлив.
В чём смысл стражей включения
Вкратце, директивы ifndef-define-endif, которые обрамляют любой грамотно оформленный заголовочный файл, являются трюком препроцессора: они обеспечивают то, что любой заголовочный файл будет включён в любой исходный файл не более одного раза.
Более подробно. Каждому заг. файлу «вручную» ставится в соответствие некоторый «символ», обычно связанный с именем этого файла, чтобы обеспечить уникальность. В первой строке проверяется, был ли уже определён этот символ ранее, если да, то весь остальной текст игнорируется. Если нет, то этот символ определяется, а затем вставляется и весь остальной текст заголовочного файла. Последняя строка (endif) просто означает закрытие такого «условного оператора».
На самом деле, если написать две подряд одинаковые директивы include для одного заголовочного файла, содержащего только объявления функций, то ничего страшного не произойдёт, даже если он не содержит стражей включения. Однако для более сложных элементов заголовочных файлов попадание нескольких их экземпляров в один исходный файл может привести к проблемам. Так как заголовочные файлы имеют тенденцию быстро изменяться и расти, считается необходимым всегда использовать стражи включения.
Что такое защитный блок для заголовочного файла в C++?
Я пытаюсь создать класс C++, используя Code::Blocks IDE, и есть поле под названием «Guard block.», я сделал поиск и не смог найти никакой полезной информации. Для чего это поле? Спасибо.
2 ответа
Я хочу знать, что такое статический блок в c или c++ с примером? Я знаю, что такое статика, но в чем разница между статикой и статическим блоком?
Защитные блоки используются для защиты от многократного включения файла заголовка одним и тем же блоком компиляции (файл c++). Они выглядят примерно так:
Если вы включите в один и тот же файл несколько файлов, вы получите ошибку с несколькими определениями. Использование охранников включения не является необходимым в небольших проектах, но становится критичным в любых средних и крупных проектах. Я регулярно использую его в любых заголовочных файлах, которые пишу.
Защитные блоки используются для предотвращения многократного включения файла заголовка в одну единицу перевода. Это часто является проблемой, когда вы включаете несколько файлов заголовков, которые, в свою очередь, включают общие стандартные файлы заголовков.
Проблема с несколькими включениями одного и того же файла заключается в том, что в результате один и тот же символ определяется несколько раз.
Похожие вопросы:
Я создал библиотеку функций, из которой хочу создать DLL и создать библиотеку экспорта. Создание DLL-это не проблема. Проблема в том, что я не хочу, чтобы разработчик/пользователь заглядывал внутрь.
Мне нужно разобрать заголовочный файл. Моя цель-найти конкретную структуру из заголовочного файла и извлечь значения и смещения структурных переменных. Может ли кто-нибудь предложить лучший способ.
Я изучаю C, но как мне заглянуть внутрь заголовочного файла? Таким образом, в Python вы бы сделали help(str), чтобы увидеть все функции части строки класса. Что эквивалентно этому в C?
Я хочу знать, что такое статический блок в c или c++ с примером? Я знаю, что такое статика, но в чем разница между статикой и статическим блоком?
Я знаю, что в C#. нет концепции заголовочных файлов, я создал заголовочный файл с некоторыми определениями и структурами для проекта c++. Теперь мне нужно разработать тот же проект, используя C#, в.
Я работаю в процессе удаления связки кода C, который использовал переменные, объявленные в заголовочном файле. Мой компилятор по какой-либо причине не предупреждает о неиспользуемой переменной из.
Урок №23. Header guards и #pragma once
Обновл. 11 Сен 2021 |
На этом уроке мы рассмотрим, что такое header guards и #pragma once в языке C++, а также зачем они нужны и как их правильно использовать.
Проблема дублирования объявлений
Как мы уже знаем из урока о предварительных объявлениях, идентификатор может иметь только одно объявление. Таким образом, программа с двумя объявлениями одной переменной получит ошибку компиляции:
То же самое касается и функций:
Рассмотрим следующую программу:
Эта, казалось бы, невинная программа, не скомпилируется! Проблема кроется в определении функции в файле math.h. Давайте детально рассмотрим, что здесь происходит:
Сначала main.cpp подключает заголовочный файл math.h, вследствие чего определение функции getSquareSides копируется в main.cpp.
Затем main.cpp подключает заголовочный файл geometry.h, который, в свою очередь, подключает math.h.
В geometry.h находится копия функции getSquareSides() (из файла math.h), которая уже во второй раз копируется в main.cpp.
Таким образом, после выполнения всех директив #include, main.cpp будет выглядеть следующим образом:
Мы получим дублирование определений и ошибку компиляции. Если рассматривать каждый файл по отдельности, то ошибок нет. Однако в main.cpp, который подключает сразу два заголовочных файла с одним и тем же определением функции, мы столкнемся с проблемами. Если для geometry.h нужна функция getSquareSides(), а для main.cpp нужен как geometry.h, так и math.h, то какое же решение?
Header guards
На самом деле решение простое — использовать header guards (защиту подключения в языке C++). Header guards — это директивы условной компиляции, которые состоят из следующего:
2.11 – Защита заголовков
Проблема повторяющегося определения
В уроке «2.6 – Предварительные объявления и определения» мы отметили, что идентификатор переменной или функции может иметь только одно определение (правило одного определения). Таким образом, программа, которая определяет идентификатор переменной более одного раза, вызовет ошибку компиляции:
Точно так же программы, которые определяют функцию более одного раза, также вызовут ошибку компиляции:
Хотя эти программы легко исправить (удалить повторяющееся определение), с помощью заголовочных файлов довольно легко попасть в ситуацию, когда определение в заголовочный файл включается более одного раза. Это может произойти, если заголовочный файл включает с #include другой заголовочный файл (что является обычным явлением).
Рассмотрим следующий академический пример:
Таким образом, после разрешения всех директив #include файл main.cpp будет выглядеть так:
Защита заголовка
Хорошей новостью является то, что мы можем избежать указанной выше проблемы с помощью механизма, называемого защитой заголовка (или защитой включения). Защита заголовка – это директивы условной компиляции, которые имеют следующую форму:
Все ваши заголовочные файлы должны иметь защиту заголовков. Имя SOME_UNIQUE_NAME_HERE может быть любым, но по соглашению устанавливается равным полному имени заголовочного файла, набранному заглавными буквами, с использованием подчеркивания вместо пробелов и знаков препинания. Например, у square.h будет защита заголовка будет следующей:
Даже заголовочные файлы стандартной библиотеки используют защиту заголовков. Если бы вы взглянули на заголовочный файл iostream из Visual Studio, вы бы увидели:
Для продвинутых читателей
Обновление нашего предыдущего примера с помощью защиты заголовков
После того, как препроцессор разрешит все включения, эта программа будет выглядеть так:
Как видно из примера, второе включение содержимого square.h (из geometry.h ) игнорируется потому, что SQUARE_H уже был определен при первом включении. Следовательно, функция getSquareSides включается только один раз.
Защита заголовков не препятствует одиночным включениям заголовка в разные файлы исходного кода.
Обратите внимание, что цель защиты заголовков – предотвратить получение файлом исходного кода более одной копии защищенного заголовка. По замыслу, защита заголовков не препятствует включению данного заголовочного файла (однократно) в отдельные исходные файлы. Это также может вызвать непредвиденные проблемы. Рассмотрим следующую возможность:
Разве мы не можем просто избежать определений в файлах заголовков?
Обычно мы советуем вам не включать определения функций в заголовки. Итак, вам может быть интересно, зачем вам включать защиту заголовков, если она защищают вас от чего-то, чего вы не должны делать.
В будущем мы покажем вам довольно много случаев, когда в файл заголовка необходимо поместить определения, не являющиеся функциями. Например, C++ позволяет вам создавать свои собственные типы. Эти пользовательские типы обычно определяются в файлах заголовков, чтобы эти определения можно было распространить на исходные файлы, которые должны их использовать. Без защиты заголовков ваши исходные файлы могут иметь несколько идентичных копий этих определений, что приведет к ошибке компиляции повторяющихся определений.
Таким образом, хотя на данном этапе этой серии обучающих статей не обязательно иметь защиту заголовков, но мы вырабатываем хорошие привычки, чтобы вам не приходилось отказываться от вредных привычек позже.
#pragma once
Многие компиляторы поддерживают более простую альтернативную форму защиты заголовков с помощью директивы #pragma :
#pragma когда-то служила той же цели, что и защита заголовков, а ее дополнительное преимущество заключается в том, что она короче и менее подвержена ошибкам.
Однако #pragma once не является официальной частью языка C++, и не все компиляторы поддерживают ее (хотя большинство современных компиляторов поддерживает).
В целях совместимости мы рекомендуем придерживаться традиционной защиты заголовков. Она не требуют много работы и гарантированно поддерживаются всеми компиляторами.
Резюме
Защита заголовков предназначена для того, чтобы содержимое заданного заголовочного файла не копировалось более одного раза в любой отдельный файл, чтобы предотвратить дублирование определений.
Обратите внимание, что дублирование объявлений – это нормально, поскольку объявление может быть объявлено несколько раз без инцидентов, но даже если ваш заголовочный файл состоит только из объявлений (без определений), всё равно рекомендуется включать защиту заголовков.
Обратите внимание, что защита заголовков не предотвращает копирование содержимого заголовочного файла (один раз) в отдельные файлы проекта. Это хорошо потому, что нам часто нужно ссылаться на содержимое заданного заголовка из разных файлов проекта.
Небольшой тест
Вопрос 1
Добавьте защиту заголовка в этот заголовочный файл:
/guard (включение защиты потока управления)
Включение создания компилятором проверок безопасности для защиты потока управления.
Синтаксис
Примечания
Параметр /guard:cf указывает компилятору на необходимость анализа потока управления для целевых объектов косвенного вызова во время компиляции и последующей вставки кода для проверки целевых объектов во время выполнения. По умолчанию /guard:cf выключен и должен быть явным образом включен. Для отключения явным образом этого параметра используйте /guard:cf-.
Visual Studio 2017 и более поздних версий: этот параметр добавляет условия для инструкций, создающих таблицы переходов.
Если указан параметр /guard:cf защиты потока управления (CFG), компилятор и компоновщик вставляют дополнительные проверки безопасности среды выполнения для обнаружения компрометации вашего кода. Во время компиляции и компоновки анализируются все косвенные вызовы в коде, чтобы найти любое расположение, доступное коду, когда он работает правильно. Эти сведения хранятся в дополнительных структурах в заголовках двоичных файлов. Компилятор также вставляет проверку перед каждым косвенным вызовом в коде, позволяющую убедиться, что целевой объект — одно из проверенных расположений. Если проверка завершается сбоем во время выполнения в операционной системе, которая поддерживает CFG, то операционная система закрывает программу.
Параметр /guard:cf несовместим с /ZI (Изменить и продолжить отладочную информацию) или /clr (компиляция CLR).
Установка данного параметра компилятора в среде разработки Visual Studio
Откройте диалоговое окно Страницы свойств проекта. Подробнее см. в статье Настройка компилятора C++ и свойства сборки в Visual Studio.