源文件包含
来自 cppreference.com
将其他源文件包含到当前源文件中的指令后的下一行。
内容 |
[编辑] 语法
#include < h-char-sequence > new-line |
(1) | ||||||||
#include " q-char-sequence " new-line |
(2) | ||||||||
#include pp-tokens new-line |
(3) | ||||||||
__has_include ( " q-char-sequence " ) __has_include ( < h-char-sequence > ) |
(4) | (自 C++17 起) | |||||||
__has_include ( string-literal ) __has_include ( < h-pp-tokens > ) |
(5) | (自 C++17 起) | |||||||
1) 搜索由 h-char-sequence 唯一标识的头文件,并用头文件的全部内容替换该指令。
2) 搜索由 q-char-sequence 标识的源文件,并用源文件的全部内容替换该指令。它可能会回退到 (1) 并将 q-char-sequence 视为头文件标识符。
3) 如果 (1) 和 (2) 均不匹配,则 pp-tokens 将进行宏替换。替换后的指令将再次尝试与 (1) 或 (2) 匹配。
4) 检查是否有可用于包含的头文件或源文件。
5) 如果 (4) 不匹配,则 h-pp-tokens 将进行宏替换。替换后的指令将再次尝试与 (4) 匹配。
new-line | - | 换行符 |
h-char-sequence | - | 一个或多个 h-char 的序列,其中以下任何一个的出现都是有条件支持的,具有实现定义的语义
|
h-char | - | 源字符集(直到 C++23)翻译字符集(自 C++23 起) 的任何成员,除了换行符和 > |
q-char-sequence | - | 一个或多个 q-char 的序列,其中以下任何一个的出现都是有条件支持的,具有实现定义的语义
|
q-char | - | 源字符集(直到 C++23)翻译字符集(自 C++23 起) 的任何成员,除了换行符和 " |
pp-tokens | - | 一个或多个 预处理标记 的序列 |
string-literal | - | 一个 字符串文字 |
h-pp-tokens | - | 一个或多个 预处理标记 的序列,除了 > |
[编辑] 解释
1) 在实现定义的一系列位置中搜索由 h-char-sequence 唯一标识的头文件,并用头文件的全部内容替换该指令。这些位置的指定方式或头文件的标识方式是实现定义的。
2) 使该指令被标识符 q-char-sequence 所标识的源文件中的全部内容替换。命名源文件以实现定义的方式进行搜索。如果不支持此搜索,或者搜索失败,则该指令会重新处理,就好像它读取语法 (1) 并包含原始指令中相同的序列(包括任何 > 字符)一样。
3) 指令中
include
之后的预处理标记的处理方式与普通文本相同(即,当前定义为宏名称的每个标识符都将被其替换列表中的预处理标记替换)。如果所有替换后产生的指令与前两种形式都不匹配,则行为未定义。将 < 和 > 预处理标记对或一对 " 字符之间的预处理标记序列组合成单个头文件名称预处理标记的方法是实现定义的。4) 由 h-char-sequence 或 q-char-sequence 标识的头文件或源文件被搜索,就好像该预处理标记序列是语法 (3) 中的 pp-tokens 一样,除了不再执行进一步的宏扩展。如果这样的指令不能满足
#include
指令的语法要求,则程序格式错误。如果成功找到源文件,则 __has_include
表达式将计算为 1,如果搜索失败,则计算为 0。5) 只有当语法 (4) 不匹配时才会考虑此形式,在这种情况下,预处理标记的处理方式与普通文本相同。
如果由 header-name(即
|
(自 C++20 起) |
的 import 指令 替换是实现定义的。
__has_include
可以扩展为 #if 和 #elif 表达式的一部分。它被 #ifdef、 #ifndef, #elifdef, #elifndef(自 C++23 起) 和 defined 视为已定义的宏,但不能用于其他任何地方。
[edit] 备注
典型的实现只搜索标准包含目录以查找语法 (1)。标准 C++ 库和标准 C 库隐式包含在这些标准包含目录中。标准包含目录通常可以通过编译器选项由用户控制。
语法 (2) 的意图是搜索不受实现控制的文件。典型的实现首先搜索当前文件所在的目录,然后回退到 (1)。
#ifndef FOO_H_INCLUDED /* any name uniquely mapped to file name */ #define FOO_H_INCLUDED // contents of the file are here #endif
当包含文件时,它将被 翻译阶段 1-4 处理,这可能包括(递归地)扩展嵌套的 #include
指令,直到实现定义的嵌套限制。为了避免重复包含同一个文件以及当文件包含自身(可能间接)时出现无限递归,通常使用头文件保护:整个头文件被包裹在
许多编译器还实现了非标准的 pragma #pragma once,其效果类似:如果已经包含了同一个文件(其中文件标识以特定于操作系统的方式确定),则它会禁用对该文件的处理。
在 q-char-sequence 或 h-char-sequence 中类似于转义序列的字符序列可能会导致错误、被解释为与转义序列对应的字符,或具有完全不同的含义,具体取决于实现。
__has_include
的结果为 1 仅表示存在具有指定名称的头文件或源文件。它并不意味着头文件或源文件在包含时不会导致错误,或者包含任何有用的内容。例如,在一个支持 C++14 和 C++17 两种模式(并在其 C++14 模式中提供 __has_include 作为符合标准的扩展)的 C++ 实现中,__has_include(<optional>) 在 C++14 模式下可能为 1,但实际上 #include <optional> 可能会导致错误。
[edit] 示例
#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 # include <utility> template<class V> class optional_t { V v_{}; bool has_{false}; public: optional_t() = default; optional_t(V&& v) : v_(v), has_{true} {} V value_or(V&& alt) const& { return has_ ? v_ : alt; } /*...*/ }; #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
输出
[edit] 缺陷报告
以下更改行为的缺陷报告已追溯应用于以前发布的 C++ 标准。 | DR | 应用于 | 已发布的行为 |
---|---|---|---|
正确行为 | CWG 787 | C++98 如果在 q-char-sequence 或 h-char-sequence 中出现转义序列,则行为未定义 |
它是有条件支持的 |
[edit] 另请参见
C++ 标准库头文件列表 | |
C 文档 关于 源文件包含
|