Включение исходного файла

Включает другой исходный файл в текущий исходный файл на строке сразу после директивы.

Синтаксис

Пояснение

• Если такая директива не удовлетворяет синтаксическим требованиям директивы #include, программа некорректна.
• В противном случае выражение __has_include принимает значение 1, если поиск исходного файла завершается успешно, и 0, если поиск завершается неудачей.

__has_include можно раскрыть в выражении #if и #elif. Он рассматривается как определённый макрос в #ifdef, #ifndef, #elifdef, #elifndef(начиная с C++23) и defined, но не может использоваться где-либо ещё.

Примечания

Типичные реализации выполняют поиск только в стандартных каталогах включения для синтаксиса (1). Стандартная библиотека C++ и стандартная библиотека C неявно включены в эти стандартные каталоги включения. Пользователь обычно может управлять стандартными каталогами включения с помощью параметров компилятора.

Синтаксис (2) предназначен для поиска файлов, не контролируемых реализацией. Типичные реализации сначала выполняют поиск в каталоге, где находится текущий файл, а затем переходят к форме (1).

При включении файла он обрабатывается на этапах трансляции 1–4, которые могут включать рекурсивное раскрытие вложенных директив #include вплоть до предела вложенности, определяемого реализацией. Чтобы избежать повторного включения одного и того же файла и бесконечной рекурсии, когда файл включает сам себя, возможно транзитивно, обычно используют защиту заголовка: весь заголовок помещают внутрь

#ifndef FOO_H_INCLUDED /* any name uniquely mapped to file name */
#define FOO_H_INCLUDED
// contents of the file are here
#endif

Многие компиляторы также реализуют нестандартную директиву pragma #pragma once с похожим эффектом: она отключает обработку файла, если тот же файл (идентичность файла определяется способом, зависящим от операционной системы) уже был включён.

Последовательность символов, похожая на escape-последовательность в q-char-sequence или h-char-sequence, в зависимости от реализации может привести к ошибке, интерпретироваться как соответствующий escape-последовательности символ или иметь совершенно иное значение.

Результат __has_include, равный 1, означает только то, что существует заголовок или исходный файл с указанным именем. Это не означает, что при включении заголовок или исходный файл не вызовет ошибку или будет содержать что-либо полезное. Например, в реализации C++, поддерживающей режимы C++14 и C++17 (и предоставляющей __has_include в режиме C++14 в качестве соответствующего расширения), __has_include(<optional>) может быть 1 в режиме C++14, но фактическое использование #include <optional> может привести к ошибке.

Пример

#if __has_include(<optional>)
    #include <optional>
    #define has_optional 1
    template<class T>
    using optional_t = std::optional<T>;
#elif __has_include(<experimental/optional>)
    #include <experimental/optional>
    #define has_optional -1
    template<class T>
    using optional_t = std::experimental::optional<T>;
#else
    #define has_optional 0
    template<class V>
    class optional_t
    {
        V v{};
        bool has{};

    public:
        optional_t() = default;
        optional_t(V&& v) : v(v), has{true} {}
        V value_or(V&& alt) const&
        {
            return has ? v : alt;
        }
        // etc.
    };
#endif

#include <iostream>

int main()
{
    if (has_optional > 0)
        std::cout << "<optional> is present\n";
    else if (has_optional < 0)
        std::cout << "<experimental/optional> is present\n";
    else
        std::cout << "<optional> is not present\n";

    optional_t<int> op;
    std::cout << "op = " << op.value_or(-1) << '\n';
    op = 42;
    std::cout << "op = " << op.value_or(-1) << '\n';
}

<optional> is present
op = -1
op = 42

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены задним числом к ранее опубликованным стандартам C++.

См. также

• Включение ресурса (начиная с C++26)