Правильное управление подключениями include

@Bretbas · Регистрация: 05.08.2013

Студворк — интернет-сервис помощи студентам

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

C++
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
#pragma once
 
//--------------------------------------------------------------------------------------------------
// Версия
//--------------------------------------------------------------------------------------------------
#define FRAMEWORK_VERSION 1.0
 
//--------------------------------------------------------------------------------------------------
// Инклуды
//--------------------------------------------------------------------------------------------------
#include "BTSPhysics.h"
#include "BTSGraphics.h"
#include "BTSAssets.h"
#include "BTSWindow.h"
#include "BTSInput.h"
#include "BTSMath.h"
#include "BTSAudio.h"
#include "BTSCore.h"
 
#include "Graphics/BTSBufferManager.h"
#include "Graphics/Buffers/BTSVertexBuffer.h"
#include "Graphics/Buffers/BTSIndexBuffer.h"
#include "Graphics/Buffers/BTSConstantBuffer.h"
#include "Graphics/Buffers/BTSBuffer.h"
 
#include "Graphics/BTSStateManager.h"
#include "Graphics/States/BTSBlendState.h"
#include "Graphics/States/BTSRasterizerState.h"
#include "Graphics/States/BTSDepthStencilState.h"
#include "Graphics/States/BTSSampleState.h"
 
// Глобальные
#include "Global/BTSSystem.h"
#include "Global/BTSComponent.h"
#include "Global/BTSSystemManager.h"
#include "Global/BTSObject.h"
#include "Global/BTSScene.h"
#include "Global/BTSEventManager.h"
#include "Global/BTSTechnique.h"
#include "Global/BTSTechniqueManager.h"
 
...

Также есть еще одна либа BTSAdditional, которая является дополнением к первой, она включает тоже заголовочный файл своих инклудов:

C++
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#pragma once
 
// Системы
#include "Systems/BTSCameraSystem.h"
#include "Systems/BTSLightSystem.h"
#include "Systems/BTSMeshRenderSystem.h"
#include "Systems/BTSPhysicsRigidBodySystem.h"
#include "Systems/BTSPhysicsColliderSystem.h"
#include "Systems/BTSSpriteRenderSystem.h"
#include "Systems/BTSAudioSourceSystem.h"
#include "Systems/BTSAudioListenerSystem.h"
#include "Systems/BTSParticleSystem.h"
#include "Systems/BTSSkyboxSystem.h"
#include "Systems/BTSAnimationSystem.h"
#include "Systems/Shadow Mapping/BTSMeshRendererSystem.h"
#include "Systems/BTSTextSystem.h"
#include "Systems/BTSTimerSystem.h"
#include "Systems/BTSUISystem.h"
 
// Компоненты
#include "Components/Mesh/BTSComponentMeshFilter.h"
#include "Components/Mesh/BTSComponentMeshRenderer.h"
#include "Components/Mesh/BTSComponentMaterial.h"
#include "Components/Rendering/BTSComponentCamera.h"
#include "Components/Rendering/BTSComponentLight.h"
#include "Components/Rendering/BTSComponentTextRenderer.h"
#include "Components/Rendering/BTSComponentSpriteRenderer.h"
#include "Components/Rendering/BTSComponentSkybox.h"
...

В своем проекте, когда использую BTSEngine и BTSAdditional я пишу вот так:

C++
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#pragma once
 
//--------------------------------------------------------------------------------------------------
// Инклуды
//--------------------------------------------------------------------------------------------------
#include "BTSEngine.h"
#include "BTSAdditional.h"
 
//--------------------------------------------------------------------------------------------------
// Пространства имен
//--------------------------------------------------------------------------------------------------
using namespace BTSEngine;
using namespace BTSAdditional;
 
class Someclass
{
public:
...
};

Теперь вопрос, правильно ли организованы подключения хедеров? Может по отдельности нужно подключать каждый хедер из BTSEngine и BTSAdditional?

Evg · 08.07.2017, 13:48

Сообщение от Croessmah

просто оставлю здесь:

Видимо, ты не понял смысл настроечного макроса

Сообщение от Croessmah

обычная проблема при копипасте - недокопировал

А тут по ходу и суть не понял. Возможно, я коряво объяснил

Croessmah · 08.07.2017, 13:57

Сообщение от Evg

Возможно, я коряво объяснил

Нормально, вроде.

Сообщение от Evg

А тут по ходу и суть не понял.

Все всё поняли. Пример тоже годный, но я к тому,
что виноваты в этом не инклуды, а автор кода.

Evg · 08.07.2017, 14:17

А я и не говорю, что кто-то виноват. Я показал один из случаев, когда можно нарваться в ситуации, когда пытаешься минимизировать подключение хидеров. Причём нарваться так, что проконтролировать будет сложно. Правда забыл сказать, что к изначальной проблеме это никакого отношения не имеет. Отсюда я по крайней мере для себя делаю вывод, что в проекте должен быть хотя бы один общий инклюд, который будет подключается в КАЖДЫЙ файл проекта (у меня это что-нибудь типа defines.h)

Croessmah · 08.07.2017, 14:30

Сообщение от Evg

хотя бы один общий инклюд, который будет подключается в КАЖДЫЙ файл проекта

Один, который включается во все файлы, и один, в который включаются все файлы, несколько разные случаи.
Да, Ваш случай к изначальной проблеме не очень подходит. Поэтому и "поругались". <здесь улыбка>

@hoggy · 08.07.2017, 23:11

Сообщение от Evg

когда пытаешься минимизировать подключение хидеров.

обычная практика для "кейса с предварительного скомпилированным заголовков".

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

и что бы кто нибудь чего нибудь не профакапил,
юзается следующий дизайн:

C++
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
// stream_help.h
 
#pragma once
 
#ifdef dUSING_PRECOMPILED_HEADER
    #ifndef _STDEXCEPT_
        #error #include <stdexcept> first
    #endif
    #ifndef _FSTREAM_
        #error #include <fstream> first
    #endif
    #ifndef _CODECVT_
        #error #include <codecvt> first
    #endif
    #ifndef _STRING_
        #error #include <string> first
    #endif
    #ifndef _TYPE_TRAITS_
        #error #include <type_traits> first
    #endif
    #ifndef dTOOLS_CONV_USED_
        #error #include <tools/conv.h> first
    #endif
#else
    #include <type_traits>
    #include <stdexcept>
    #include <fstream>
    #include <codecvt>
    #include <cassert>
    #include <string>
 
    #include <tools/conv.h>
#endif
 
#define dTOOLS_STREAM_HELP_USED_
 
...  // собственно сам хедер

а самым первым файликом в спп подключается
предварительно скомпилированный заголовок.

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

а если вдруг программист что-то где-то ничайно забыл,
то препроцессор ему услужливо напомнит.

Новые блоги и статьи Все статьи Все блоги /
Сезонность и суточность закисления почв anaschu 04.07.2026 200 часов это все равно моловато. Есть ситуации, но нестандартные, когда смена происходит за 5 лет. Но обычно это 50 лет и более. Наверное, закисление почвы происходит сезонно в средней. . .	В чем ценность человеческого опыта в глобальном смысле? kumehtar 03.07.2026 Возможно, ценность человека не в том, что он однажды достигает мудрости, а в том, что он становится носителем карты пути. Он знает не только истину, но и последовательность внутренних изменений,. . .	интеграция AnyLogic с самописным REST API и переход на Odoo anaschu 03.07.2026 Успешная интеграция AnyLogic с самописным REST API и переход на промышленную Odoo WMS Сегодня проделал огромный путь от простой симуляции физических процессов до построения полноценной. . .	Поиск всех путей на ориентированном графе. Linux dcc0 02.07.2026 Переработка старого кода из моей статьи. Через несколько переработок от PHP кода к C89 (надеюсь, 89). Но довольно запутанно получилось. Код для Linux. Но если убрать time и то, что с ним. . .
Сам себя обучал rest api anaschu 02.07.2026 Педагогический лайфхак: Почему чистый REST API для ученика намного круче, чем готовые библиотеки Когда мы отказались от капризного JAR-файла AnyLogic и переписали код на стандартный HttpClient,. . .	rest api anylogic - выполнение модели на своём русском сайте anaschu 02.07.2026 Как подружиться с AnyLogic Cloud API, победить провайдеров и развернуться Java-бэкенд в Docker на бесплатном хостинге: Двухдневный лог борьбы Всем привет! Хочу поделиться свежим (и довольно. . .	Где деньги лежат kumehtar 02.07.2026 Это - японская подводная лодка I-52 (тип C2, кодовое имя Momi) вышла из Японии в марте 1944 года с миссией в оккупированную немцами Францию (Лорьян). Это была одна из «Янаги»-миссий по обмену. . .	Krabik для WoW 3.3.5a, многоязычный AmbA 02.07.2026 Допилил бота, думаю что окончательно. Изменения: - добавлена многоязычность - добавлено снятие скриншотов - добавлено поддержание бафов хождения по воде (для жреца, дк и шамана) - и так, по. . .

Evg 21281 / 8305 / 637 Регистрация: 30.03.2009 Сообщений: 22,660 Записей в блоге: 30
	08.07.2017, 14:17
	А я и не говорю, что кто-то виноват. Я показал один из случаев, когда можно нарваться в ситуации, когда пытаешься минимизировать подключение хидеров. Причём нарваться так, что проконтролировать будет сложно. Правда забыл сказать, что к изначальной проблеме это никакого отношения не имеет. Отсюда я по крайней мере для себя делаю вывод, что в проекте должен быть хотя бы один общий инклюд, который будет подключается в КАЖДЫЙ файл проекта (у меня это что-нибудь типа defines.h) 0