Урок №23. Header guards

В этом уроке мы рассмотрим, что такое header guards, зачем они нужны и как их использовать.

Оглавление:

Проблема дублирования определений
Header guards
#pragma once
Тест

Проблема дублирования определений

Как мы уже знаем из урока о предварительных объявлениях, идентификатор может иметь только одно определение. Таким образом, программа с двумя определениями одной переменной получит ошибку компиляции:

int main()
{
    int x; // это определение идентификатора x
    int x; // ошибка компиляции: дублирование определений
 
    return 0;
}

int main()

{

int x; // это определение идентификатора x

int x; // ошибка компиляции: дублирование определений

return 0;

}

То же самое касается и функций:

#include <iostream>
 
int boo()
{
    return 7;
}
 
int boo() // ошибка компиляции: дублирование определений
{
    return 7;
}
 
int main()
{
    std::cout << boo();
    return 0;
}

#include <iostream>

int boo()

{

return 7;

}

int boo() // ошибка компиляции: дублирование определений

{

return 7;

}

int main()

{

std::cout << boo();

return 0;

}

Хотя эти ошибки легко исправить (достаточно просто удалить дублирование), с заголовочными файлами дела обстоят несколько иначе. Довольно легко можно попасть в ситуацию, когда определения одних и тех же заголовочных файлов будут подключаться больше одного раза в файл .cpp. Очень часто это случается при подключении одного заголовочного файла другим.

Рассмотрим следующую программу:

math.h:

int getSquareSides()
{
    return 4;
}

int getSquareSides()

{

return 4;

}

geometry.h:

#include "math.h"

1	#include "math.h"

main.cpp:

#include "math.h"
#include "geometry.h"
 
int main()
{
    return 0;
}

#include "math.h"

#include "geometry.h"

int main()

{

return 0;

}

Эта, казалось бы, невинная программа, не скомпилируется! Проблема кроется в определении функции в файле 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 будет выглядеть следующим образом:

int getSquareSides()  // с math.h
{
    return 4;
}
 
int getSquareSides() // с geometry.h
{
    return 4;
}
 
int main()
{
    return 0;
}

int getSquareSides() // с math.h

{

return 4;

}

int getSquareSides() // с geometry.h

{

return 4;

}

int main()

{

return 0;

}

Мы получим дублирование определений и ошибку компиляции. Если рассматривать каждый файл по отдельности, то ошибок нет. Однако, в main.cpp, который #include сразу два заголовочных файла с одним и тем же определением функции, мы столкнёмся с проблемами. Если для geometry.h нужна функция getSquareSides, а для main.cpp нужен как geometry.h, так и math.h, то какое же решение?

Header guards

На самом деле решение простое — header guards. Header guards — это директивы условной компиляции, которые состоят из следующего:

#ifndef SOME_UNIQUE_NAME_HERE
#define SOME_UNIQUE_NAME_HERE
 
// основная часть кода 
 
#endif

#ifndef SOME_UNIQUE_NAME_HERE

#define SOME_UNIQUE_NAME_HERE

// основная часть кода

#endif

Если подключить этот заголовочный файл, то первое, что он сделает — это проверит, был ли ранее определён идентификатор SOME_UNIQUE_NAME_HERE. Если мы впервые подключаем этот заголовок, то SOME_UNIQUE_NAME_HERE еще не был определён. Следовательно, мы определяем SOME_UNIQUE_NAME_HERE (с помощью директивы #define) и выполняется основная часть заголовочного файла. Если же мы раньше подключали этот заголовочный файл, то SOME_UNIQUE_NAME_HERE уже был определён. В таком случае, при подключении этого заголовочного файла во второй раз, его содержимое будет проигнорировано.

Все ваши заголовочные файлы должны иметь header guards. SOME_UNIQUE_NAME_HERE может быть любым идентификатором, но, как правило, в качестве идентификатора используется имя заголовочного файла с окончанием _H. Например, в файле math.h идентификатор будет MATH_H:

math.h:

#ifndef MATH_H
#define MATH_H
 
int getSquareSides()
{
    return 4;
}
 
#endif

#ifndef MATH_H

#define MATH_H

int getSquareSides()

{

return 4;

}

#endif

Даже заголовочные файлы из стандартной библиотеки С++ используют header guards. Если бы вы взглянули на содержимое заголовочного файла iostream, то вы бы увидели:

#ifndef _IOSTREAM_
#define _IOSTREAM_
 
// основная часть кода
 
#endif

#ifndef _IOSTREAM_

#define _IOSTREAM_

// основная часть кода

#endif

Но сейчас вернёмся к нашему примеру с math.h, где мы попытаемся исправить ситуацию с помощью header guards:

math.h:

#ifndef MATH_H
#define MATH_H
 
int getSquareSides()
{
    return 4;
}
 
#endif

#ifndef MATH_H

#define MATH_H

int getSquareSides()

{

return 4;

}

#endif

geometry.h:

#include "math.h"

1	#include "math.h"

main.cpp:

#include "math.h"
#include "geometry.h"
 
int main()
{
    return 0;
}

#include "math.h"

#include "geometry.h"

int main()

{

return 0;

}

Теперь, при подключении main.cpp заголовочного файла math.h, препроцессор увидит, что MATH_H не был определён, следовательно, выполнится директива определения MATH_H и содержимое math.h скопируется в main.cpp. Затем main.cpp подключает заголовочный файл geometry.h, который, в свою очередь, подключает math.h. Препроцессор видит, что MATH_H уже был ранее определён и содержимое geometry.h не будет скопировано в main.cpp.

Вот так можно бороться с дублированием определений с помощью header guards.

#pragma once

Большинство компиляторов поддерживают более простую, альтернативную форму header guards — директиву #pragma:

#pragma once
 
// основная часть кода

#pragma once

// основная часть кода

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

Однако, #pragma once не является официальной частью языка C++, и не все компиляторы её поддерживают (хотя большинство современных компиляторов поддерживают).

Мы же рекомендуем использовать header guards, дабы сохранить максимальную совместимость вашего кода.

Тест

Добавьте header guards к следующему заголовочному файлу:

add.h:

int add(int x, int y);

1	int add(int x, int y);

Ответ

#ifndef ADD_H
#define ADD_H
 
int add(int x, int y);
 
#endif

#ifndef ADD_H

#define ADD_H

int add(int x, int y);

#endif

Оценить статью:

(192 оценок, среднее: 4,76 из 5)

Загрузка...

Комментариев: 13

Alex:

14 февраля 2019 в 13:44

Старина!
Крутой курс!
Реально простым языком!
Круто, что ты пишешь о таких вещах, о которых обычно никто и не пишет(например header guards).
все по-порядку, и обо всех тонкостях!
Это реально "для начинающих".
Буда многих курсов- они сразу приучают будущих быдлокодеров в принципу "не думай как работает эта библиотека/функция, просто юзай ее". Я ни разу не встречал чтоб кто-то хоть чуток попытался объяснить зачем эти namespace, #ifdef.

Дружище, я с радостью приобрету PDF вариеант, но в полном объеме, все 200+ уроков, что есть на данный момент.
Не проблема заплатить в 2 раза больше, я вижу содержаник курса и у меня перья шевелятся от осознания как много времени ты потратил на подготовку материала!!!
Мне напрашивается мысль о трех вариантах PDFок- 100 уроков, и 200 уроков, и 200+ уроков, с разными ценниками.

Продолжай!

Ответить
1. Юрий:
  
  14 февраля 2019 в 17:10
  
  Хорошо, зафиксировал. Спасибо, что читаешь 🙂
  
  Ответить
Kaladgan:

7 февраля 2019 в 17:12

На счет добавления pch.h во все файлы проекта, у меня почему-то компилятор ругался на все файлы в которых не было этой строчки #include "pch.h" Когда добваил во все 3 файла только тогда все нормально отработало.

Ответить
nickatin:

27 января 2019 в 22:59

Юрий, очень приятно читать ваши уроки. Все очень доступно!

Ответить
1. Юрий:
  
  28 января 2019 в 13:07
  
  И мне приятно, что читаете 🙂
  
  Ответить
Коля:

29 декабря 2018 в 13:18

Добрый день, подскажите пожалуйста, в чём может быть проблема. Сделал все по уроку , проверил несколько раз , использовал и header guards и #pragma once, все равно выдает ошибку. Использую Visual Studio 2017.

Ответить
1. Юрий:
  
  29 декабря 2018 в 17:16
  
  Код добавьте.
  
  Ответить
  1. Коля:
    
    29 декабря 2018 в 19:16
    
    math.h
    
    #include "pch.h" #ifndef MATH_H #define MATH_H int getSquareSides() { return 4; } #endif
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    
    #include "pch.h"
    #ifndef MATH_H
    #define MATH_H
    
    int getSquareSides()
    {
    return 4;
    }
    
    #endif
    
    geometry.h
    
    #include "pch.h" #include "math.h"
    
    1
    2
    
    #include "pch.h"
    #include "math.h"
    
    main.cpp
    
    #include "pch.h" #include "math.h" #include "geometry.h" int main() { return 0; }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    
    #include "pch.h"
    #include "math.h"
    #include "geometry.h"
    
    int main()
    {
    return 0;
    }
    
    Ответить
    1. Юрий:
      
      31 декабря 2018 в 03:07
      
      Во-первых, предварительно скомпилированный заголовок pch.h подключается в угловых скобках, а не в кавычках:
      
      #include <pch.h>
      
      1
      
      #include <pch.h>
      
      Во-вторых, зачем вы его подключаете во всех файлах одного и того же проекта? Это вызовет ошибку дублирования кода. Подключать нужно только в main.cpp.
      
      В-третьих, зачем вы подключаете в main.cpp файлы math.h и geometry.h? Файл geometry.h уже подключает math.h и используется для того, чтобы не прописывать в main.cpp строчку:
      
      #include "math.h"
      
      1
      
      #include "math.h"
      
      Перечитайте внимательнее этот урок и два предыдущих.
  2. Коля:
    
    16 января 2019 в 14:10
    
    Перечитал, и правда был не внимателен в пред идущих уроках, все получилось, спасибо вам, за ваш проект
    
    Ответить
    1. Юрий:
      
      16 января 2019 в 21:36
      
      Пожалуйста 🙂

Олег:

7 ноября 2018 в 15:31

Не совсем понятно. В предыдущем уроке вы говорили, что директивы распространяются только на код, написанный в данном файле, а здесь выходит так, что #ifndef из geometry.h видит #define из math.h.

Ответить

Андрей:

4 декабря 2018 в 05:42

Он видит #define из math.h потому, что весь math.h был #include в geometry.h. В том числе и со всеми его #define. А geometry.h в свою очередь уже был #include в main.cpp, т.е. полностью переписан туда. Так же, как и math.h.
В итоге, когда препроцессор закончит (надеюсь так правильно говорить) со всеми нашими .h файлами (но не закончит еще с main.cpp), мы получим какой-то такой "ужас", хотя по сути и не увидим его глазами(наверное поэтому сложно это воспринимать?):

// здесь тоже должен быть переписан весь набор iostream, а не эта строчка
#include <iostream> 

#ifndef MATH_H
#define MATH_H

int getSquareSides()
{
    return 4;
}

#endif // MATH_H

#ifndef GEOMETRY_H
#define GEOMETRY_H

#ifndef MATH_H
#define MATH_H

int getSquareSides()
{
    return 4;
}

#endif // MATH_H

#endif // GEOMETRY_H

using namespace std;

main()
{
    cout << "Square sides: " << getSquareSides();
    return 0;
}

// здесь тоже должен быть переписан весь набор iostream, а не эта строчка

#endif // MATH_H

#ifndef GEOMETRY_H

#define GEOMETRY_H

#endif // GEOMETRY_H

using namespace std;

main()

cout << "Square sides: " << getSquareSides();

И только потом будут выполнены следующие команды препроцессора в main.cpp(помним, что они выполняются по очереди, т.е. сначала переписывается весь #include, а потом ниже по тексту все наши #define), после чего все это уже компилируется и отрабатывает. А cout вполне отлично будет выводить циферку 4.

P.S.
Я наверное так "хорошо" объяснил этот момент, что стало только еще более непонятно?))
А вообще хотелось бы услышать и ответ Юрия — так оно или не так работает? Вдруг я не правильно понял, но решил что правильно только потому, что оно у меня работает?)) Хотя если работает, то видимо таки правильно)

Урок №23. Header guards

Проблема дублирования определений

Header guards

#pragma once

Тест

По теме:

Комментариев: 13

Добавить комментарий Отменить ответ