命名空间
变体
操作

源文件包含

来自 cppreference.cn

在紧接指令的行处将另一个源文件包含到当前源文件中。

目录

[编辑] 语法

#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) (自 C23 起)
__has_include ( string-literal )
__has_include ( < h-pp-tokens > )
(5) (自 C23 起)
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 - 源字符集 中的任何成员,除了换行符和 >
q-char-sequence - 一个或多个 q-char 序列,其中出现以下任何字符都会导致未定义行为
  • 字符 '
  • 字符 \
  • 字符序列 //
  • 字符序列 /*
q-char - 源字符集 中的任何成员,除了换行符和 "
pp-tokens - 一个或多个预处理标记序列
string-literal - 字符串字面量
h-pp-tokens - 一个或多个预处理标记序列,除了 >

[编辑] 解释

1) 以实现定义的方式搜索由 h-char-sequence 标识的文件。此语法的目的是搜索受实现控制的文件。典型的实现只搜索标准包含目录。标准 C 库隐式包含在这些标准包含目录中。标准包含目录通常可以通过编译器选项由用户控制。
2) 以实现定义的方式搜索由 q-char-sequence 标识的文件。此语法的目的是搜索不受实现控制的文件。典型的实现首先搜索当前文件所在的目录,并且只有在找不到文件时,才像 (1) 那样搜索标准包含目录。
3) 指令中 include 后的预处理标记像普通文本一样处理(即,当前定义为宏名称的每个标识符都替换为其预处理标记的替换列表)。所有替换后产生的指令应与前两种形式之一匹配。<> 预处理标记对之间或一对 " 字符之间的预处理标记序列如何组合成单个头文件名称预处理标记是实现定义的。
4) 搜索由 h-char-sequenceq-char-sequence 标识的头文件或源文件,就像该预处理标记序列是语法 (3) 中的 pp-tokens 一样,只是不再执行宏展开。如果此类指令不满足 #include 指令的语法要求,则程序格式错误。如果源文件搜索成功,__has_include 表达式求值为 1,如果搜索失败,则求值为 0
5) 仅当语法 (4) 不匹配时才考虑此形式,在这种情况下,预处理标记像普通文本一样处理。

如果找不到文件,则程序格式错误。

__has_include 可以在 #if #elif 的表达式中展开。它被 #ifdef #ifndef #elifdef #elifndefdefined 视为已定义宏,但不能在其他任何地方使用。

(自 C23 起)

[编辑] 注意

对于语法 (1),典型的实现只搜索标准包含目录。标准 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,其效果类似:如果同一个文件(文件身份以操作系统特定的方式确定)已经被包含,则禁用该文件的处理。

__has_include 结果为 1 仅表示存在具有指定名称的头文件或源文件。这并不意味着包含该头文件或源文件时不会导致错误或包含任何有用的内容。

[编辑] 示例

[编辑] 参考

  • C23 标准 (ISO/IEC 9899:2024)
  • 6.4.7 头文件名 (p: 69)
  • 6.10.1 条件包含 (p: 165-169)
  • 6.10.2 源文件包含 (p: 169-170)
  • C17 标准 (ISO/IEC 9899:2018)
  • 6.10.2 源文件包含 (p: 119-120)
  • C11 标准 (ISO/IEC 9899:2011)
  • 6.10.2 源文件包含 (p: 164-166)
  • C99 标准 (ISO/IEC 9899:1999)
  • 6.10.2 源文件包含 (p: 149-151)
  • C89/C90 标准 (ISO/IEC 9899:1990)
  • 3.8.2 源文件包含

[编辑] 另见

C 标准库头文件列表
C++ 文档 关于 源文件包含