21、C语言输入输出与预处理器详解

C语言输入输出与预处理器详解

1. 二进制文件的读取操作

在C语言中，若要读取二进制文件，可使用 rb 模式打开文件。为使示例更具趣味性，程序通常会读取并打印特定信号的信息，而非读取整个文件。例如，我们可以将读取的信号硬编码为第二个信号。具体操作步骤如下：
1. 设置文件位置指示器 ：调用 fseek 函数设置文件位置指示器，该指示器决定了后续I/O操作的文件位置。对于二进制流，可通过将偏移量（以字节为单位）与最终参数指定的位置（如由 SEEK_SET 指定的文件开头）相加来设置新位置。首个信号位于文件的位置0，后续每个信号位于从文件开头起该结构体大小的整数倍位置处。
2. 读取数据 ：在文件位置指示器定位到第二个信号的起始位置后，调用 fread 函数将二进制文件中的数据读取到 &sigrec 引用的结构体中。 fread 函数从 fp 指向的流中读取一个大小由 sizeof(rec) 指定的元素。读取成功后，流的文件位置指示器会按成功读取的字符数向前移动。同时，需检查 fread 函数的返回值，确保读取的元素数量正确（此处为一个）。

2. 字节序相关知识

2.1 字节序的概念

除字符类型外的对象类型可能包含填充位和值表示位。不同的目标平台以不同方式将字节打包成多字节字，这种方式称为字节序。字节序分为大端序（big-endian）和小端序（little-endian）：
- 大端序 ：将最高有效字节放在首位，最低有效字节放在末尾。例如，无符号十六进制数 0x1234 ，在大端序中表示为 0x12, 0x34 。
- 小端序 ：与大端序相反，将最低有效字节放在首位，最高有效字节放在末尾。上述例子在小端序中表示为 0x34, 0x12 。

常见处理器的字节序情况如下：
| 处理器类型 | 字节序 |
| ---- | ---- |
| Intel和AMD处理器 | 小端序 |
| ARM和POWER系列处理器 | 可在小端序和大端序之间切换 |
| 网络协议（如IP、TCP、UDP） | 大端序为主 |

2.2 C23中的字节序判断机制

C23新增了一种在运行时确定实现的字节序的机制，通过三个扩展为整数常量表达式的宏来实现：
- __STDC_ENDIAN_LITTLE__ ：表示字节序存储中最低有效字节放在首位，其余按升序排列。
- __STDC_ENDIAN_BIG__ ：表示字节序存储中最高有效字节放在首位，其余按降序排列。
- __STDC_ENDIAN_NATIVE__ ：描述执行环境相对于位精确整数类型、标准整数类型和大多数扩展整数类型的字节序。

以下是一个判断执行环境字节序的示例代码：

#include <stdbit.h>
#include <stdio.h>
int main (int argc, char* argv[]) {
  if (__STDC_ENDIAN_NATIVE__ == __STDC_ENDIAN_LITTLE__) {
    puts("little endian");
  }
  else if (__STDC_ENDIAN_NATIVE__ == __STDC_ENDIAN_BIG__) {
    puts("big endian");
  }
  else {
    puts("other byte ordering");
  }
  return 0;
}

2.3 跨主机通信中的字节序处理

由于不同平台的字节序存在差异，在跨主机通信时，应采用外部格式标准，并使用格式转换函数在外部数据数组和多字节本机对象（使用精确宽度类型）之间进行数据编组。POSIX提供了一些适合此目的的函数，如 htonl 、 htons 、 ntohl 和 ntohs ，用于在主机字节序和网络字节序之间转换值。此外，要实现二进制数据格式的字节序独立性，可通过始终以固定字节序存储数据或在二进制文件中包含一个字段来指示数据的字节序。

3. 预处理器的基本概念

预处理器是C编译器在编译早期运行的部分，它会在源代码被翻译之前对其进行转换，例如将一个文件（通常是头文件）的代码插入到另一个文件（通常是源文件）中。预处理器还允许在宏展开期间指定标识符自动替换为源代码段。预处理器的运行在翻译器将源代码转换为目标代码之前，这使得它能够在翻译器处理之前修改用户编写的源代码。不过，预处理器对正在编译的程序的语义信息了解有限，它不理解函数、变量或类型，仅对基本元素（如头文件名、标识符、字面量和标点字符等）有意义，这些基本元素称为标记，是编译器能理解的计算机程序的最小元素。

预处理器通过源代码中包含的预处理指令来编程其行为。预处理指令以 # 标记开头，后跟指令名称，如 #include 、 #define 、 #embed 或 #if ，每个预处理指令以换行符结尾。例如：

#define THIS_IS_FINE 1
#  define SO_IS_THIS 1

编译器通常提供查看预处理输出（即传递给翻译器的翻译单元）的方法，虽然查看预处理输出并非必需，但有助于了解传递给翻译器的实际代码。常见编译器输出翻译单元的标志如下表所示：
| 编译器 | 示例命令行 |
| ---- | ---- |
| Clang | clang other-options -E -o tu.i tu.c |
| GCC | gcc other-options -E -o tu.i tu.c |
| Visual C++ | cl other-options /P /Fitu.i tu.c |

4. 预处理器的文件包含功能

4.1 文件包含的基本原理

预处理器的一个强大功能是使用 #include 预处理指令将一个源文件的内容插入到另一个源文件中。被包含的文件称为头文件，用于与程序的其他部分共享函数、对象和数据类型的外部声明。例如，有一个名为 bar.h 的头文件和一个名为 foo.c 的源文件， foo.c 中未直接包含 func 的声明，但通过 #include "bar.h" 指令，在预处理时会将 bar.h 的内容插入到 foo.c 中，从而可在 main 函数中成功引用 func 。

4.2 包含的传递性及最佳实践

预处理器在遇到 #include 指令时会立即执行，因此包含具有传递性。若一个源文件包含的头文件本身又包含另一个头文件，预处理输出将包含两个头文件的内容。例如， foo.c 包含 bar.h ，而 bar.h 又包含 baz.h ，则预处理后的输出会包含 baz.h 和 bar.h 的内容。不过，最好避免依赖传递性包含，因为这会使代码变得脆弱。可考虑使用 include-what-you-use 工具自动消除对传递性包含的依赖。

4.3 C23中的文件存在性测试

从C23开始，可使用 __has_include 预处理运算符在执行 #include 指令之前测试包含文件是否存在。该运算符以头文件名作为唯一操作数，若能找到指定文件则返回 true ，否则返回 false 。可结合条件包含使用该运算符，在无法包含文件时提供替代实现。例如：

#if __has_include(<threads.h>)
#  include <threads.h>
   typedef thrd_t thread_handle;
#elif __has_include(<pthread.h>)
   typedef pthread_t thread_handle;
#endif

4.4 包含文件的指定方式

可使用引号包含字符串（如 #include "foo.h" ）或尖括号包含字符串（如 #include <foo.h> ）指定要包含的文件。这两种语法的差异由实现定义，通常会影响查找包含文件的搜索路径。例如，Clang和GCC会尝试在以下路径查找文件：
- 尖括号：在系统包含路径中查找，可使用 -isystem 标志指定。
- 引号字符串：在引号包含路径中查找，可使用 -iquote 和 -isystem 标志指定。

__has_include 预处理运算符的头操作数也需使用引号或尖括号指定，且该运算符使用与 #include 指令相同的搜索路径启发式方法，因此为确保结果一致， #include 指令和对应的 __has_include 运算符应使用相同的形式。

5. 预处理器的条件包含功能

5.1 条件包含的基本概念

在编写代码时，常需根据不同实现编写不同代码。可使用预处理指令（如 #if 、 #elif 或 #else ）结合谓词条件来有条件地包含源代码。谓词条件是一个控制常量表达式，用于确定预处理器应选择的程序分支，通常与 defined 运算符一起使用，该运算符用于确定给定标识符是否为已定义的宏。

5.2 条件包含的执行逻辑

条件包含指令与 if 和 else 语句类似。当谓词条件计算为非零预处理值时，处理 #if 分支，其他分支不处理；当谓词条件计算为零时，若有 #elif 分支，则测试其谓词是否包含；若所有谓词条件都不为非零，则处理 #else 分支（若有）。 #endif 预处理指令表示条件包含代码的结束。

5.3 条件包含的示例

以下是一个根据不同宏定义有条件地包含头文件的示例：

#if defined(_WIN32)
#  include <Windows.h>
#elif defined(__ANDROID__)
#  include <android/log.h>
#endif

与 if 和 else 关键字不同，预处理器条件包含不能使用花括号表示由谓词控制的语句块，而是包含从 #if 、 #elif 或 #else 指令（谓词之后）到下一个平衡的 #elif 、 #else 或 #endif 标记的所有标记，同时跳过未选择的条件包含分支中的任何标记。条件包含指令可以嵌套，并且C23引入了一些简写形式，如 #elifdef 、 #elifndef 等。

5.4 生成诊断信息

在条件包含指令中，若预处理器无法选择任何条件分支且没有合理的回退行为，可能需要生成错误信息。例如，在选择包含C标准库头文件 <threads.h> 或POSIX线程库头文件 <pthread.h> 时，若两者都不可用，可使用 #error 预处理指令生成编译时诊断消息。示例代码如下：

#if __STDC__ && __STDC_NO_THREADS__ != 1
#  include <threads.h>
#elif POSIX_THREADS == 200809L
#  include <pthread.h>
#else
#  error "Neither <threads.h> nor <pthread.h> is available"
#endif

此外，C23还添加了 #warning 指令，它与 #error 指令类似，都会使实现生成诊断信息，但 #warning 指令不会终止编译，而是继续正常编译（除非其他命令行选项禁用警告或将其升级为错误）。 #error 指令适用于致命问题（如缺少无回退实现的库），而 #warning 指令适用于非致命问题（如缺少低质量回退实现的库）。

6. 头文件保护机制

6.1 头文件重复包含问题

在编写头文件时，一个常见问题是防止程序员在一个翻译单元中多次包含同一个文件。由于头文件包含具有传递性，可能会意外多次包含同一个头文件，甚至可能导致头文件之间的无限递归。

6.2 头文件保护的实现

头文件保护机制可确保一个头文件在每个翻译单元中只包含一次。头文件保护是一种基于特定头文件宏是否已定义来有条件地包含头文件内容的设计模式。若宏未定义，则定义该宏，后续对头文件保护的测试将不会有条件地包含代码。例如， bar.h 使用头文件保护防止从 foo.c 中意外重复包含：

#ifndef BAR_H
#define BAR_H
inline
int func() { return 1; }
#endif /* BAR_H */

6.3 头文件保护标识符的选择

选择用作头文件保护的标识符时，常见做法是使用文件路径、文件名和扩展名的重要部分，用下划线分隔并全部大写。例如，若头文件通过 #include "foo/bar/baz.h" 包含，可选择 FOO_BAR_BAZ_H 作为头文件保护标识符。同时，应避免使用保留标识符作为头文件保护标识符，因为这可能会引入未定义行为。以下划线后跟大写字母开头的标识符是保留的，使用保留标识符可能会与实现定义的宏发生冲突，导致编译错误或代码不正确。

7. 宏定义相关知识

7.1 宏定义的基本语法

使用 #define 预处理指令定义宏，宏可用于定义常量值或带有通用参数的类函数构造。宏定义包含一个（可能为空）替换列表，在预处理器展开宏时，该替换列表会被注入到翻译单元中。语法如下：

#define identifier replacement-list

例如：

#define ARRAY_SIZE 100
int array[ARRAY_SIZE];

上述代码中， ARRAY_SIZE 标识符在宏展开时会被替换为100。若未指定替换列表，预处理器会简单地移除宏名。也可在编译器的命令行中指定宏定义，如Clang和GCC使用 -D 标志，Visual C++使用 /D 标志。

7.2 宏的作用域

宏的作用域持续到预处理器遇到指定该宏的 #undef 预处理指令或翻译单元结束。与变量或函数声明不同，宏的作用域独立于任何块结构。

7.3 宏的类型

可使用 #define 指令定义对象式宏或函数式宏：
- 对象式宏 ：是一个简单的标识符，会被替换为一个代码片段。例如：

#define FOO (1 + 1)
int i = FOO;

• 函数式宏 ：是参数化的，调用时需要传递一组（可能为空）参数，类似于调用函数。例如：

#define BAR(x) (1 + (x))
int j = BAR(10);

7.4 宏定义的注意事项

函数式宏定义的左括号必须紧跟宏名，中间不能有空格，否则括号会成为替换列表的一部分。宏替换列表以宏定义中的第一个换行符结束，但可使用反斜杠 \ 连接多个源行，使宏定义更易读。定义宏时需注意，在程序的其余部分使用宏的标识符可能会导致宏替换，可通过遵循一致的命名习惯（如使用全大写字母定义宏名或为宏名添加前缀）来解决此问题。定义宏后，若要重新定义，需先使用 #undef 指令取消定义。

以下是一个定义、使用和取消定义宏的示例：

// 定义函数式宏
#define BAR(x) (1 + (x))
// 包含使用该宏的头文件
// ...
// 取消宏定义
#undef BAR
// 后续可重新定义宏

综上所述，预处理器在C语言编程中起着重要作用，它能帮助我们灵活处理文件包含、条件编译、头文件保护和宏定义等问题，提高代码的可维护性和可移植性。通过合理使用预处理器的功能，我们可以编写出更加高效、健壮的C语言程序。

8. 预处理器操作流程总结

8.1 预处理器操作步骤

预处理器在编译过程中的操作可以总结为以下步骤：
1. 识别预处理指令 ：扫描源代码，识别以 # 开头的预处理指令，如 #include 、 #define 、 #if 等。
2. 执行文件包含 ：对于 #include 指令，根据指定的搜索路径查找并插入头文件内容。
3. 宏展开 ：遇到宏定义时，将宏标识符替换为其替换列表。
4. 条件包含判断 ：根据 #if 、 #elif 、 #else 等指令的谓词条件，决定是否包含相应代码。
5. 生成诊断信息 ：根据 #error 和 #warning 指令，生成编译时的错误或警告信息。

8.2 预处理器操作流程图

graph TD;
    A[开始] --> B[识别预处理指令];
    B --> C{是否为#include指令};
    C -- 是 --> D[执行文件包含];
    C -- 否 --> E{是否为#define指令};
    E -- 是 --> F[宏展开];
    E -- 否 --> G{是否为条件包含指令};
    G -- 是 --> H[条件包含判断];
    G -- 否 --> I{是否为诊断指令};
    I -- 是 --> J[生成诊断信息];
    I -- 否 --> K[继续扫描];
    D --> K;
    F --> K;
    H --> K;
    J --> K;
    K --> L{是否结束};
    L -- 否 --> B;
    L -- 是 --> M[结束];

9. 常见问题及解决方案

9.1 头文件重复包含问题

• 问题描述 ：由于头文件包含的传递性，可能会导致同一个头文件在一个翻译单元中被多次包含，引发编译错误或代码异常。
• 解决方案 ：使用头文件保护机制，如 #ifndef 、 #define 和 #endif 组合，确保头文件只被包含一次。示例代码如下：

#ifndef HEADER_NAME_H
#define HEADER_NAME_H
// 头文件内容
#endif /* HEADER_NAME_H */

9.2 宏定义冲突问题

• 问题描述 ：在不同的头文件或源文件中可能会定义相同名称的宏，导致宏替换出现意外结果。
• 解决方案 ：遵循一致的命名习惯，如使用全大写字母定义宏名或为宏名添加前缀，避免宏名冲突。例如：

#define MY_MACRO 10

9.3 条件包含逻辑错误问题

• 问题描述 ：在使用条件包含指令时，谓词条件可能编写错误，导致代码包含不符合预期。
• 解决方案 ：仔细检查谓词条件，确保逻辑正确。可以使用 #error 指令在条件不满足时给出明确的错误信息，帮助调试。示例代码如下：

#if !defined(SOME_MACRO)
#error "SOME_MACRO is not defined"
#endif

10. 实际应用案例

10.1 跨平台代码开发

在开发跨平台的C语言程序时，不同的操作系统和平台可能有不同的库和特性。可以使用预处理器的条件包含功能，根据不同的平台宏定义选择合适的代码实现。例如：

#if defined(_WIN32)
// Windows平台代码
#  include <Windows.h>
#elif defined(__ANDROID__)
// Android平台代码
#  include <android/log.h>
#else
#  error "Unsupported platform"
#endif

10.2 代码调试和优化

在调试和优化代码时，可以使用宏定义来控制代码的行为。例如，定义一个调试宏，在调试阶段输出详细的调试信息，在发布版本中关闭调试信息。示例代码如下：

#ifdef DEBUG
#define DEBUG_PRINT(fmt, ...) printf(fmt, __VA_ARGS__)
#else
#define DEBUG_PRINT(fmt, ...)
#endif

int main() {
    DEBUG_PRINT("Entering main function\n");
    // 主函数代码
    return 0;
}

10.3 代码复用和模块化

通过头文件包含和宏定义，可以实现代码的复用和模块化。将常用的函数和数据结构定义在头文件中，通过 #include 指令在不同的源文件中使用。使用宏定义可以定义一些通用的常量和函数，提高代码的可维护性和可扩展性。

10.4 实际应用案例总结

应用场景	实现方式	示例代码
跨平台代码开发	使用条件包含根据平台宏选择代码	见上述跨平台代码开发示例
代码调试和优化	使用宏定义控制调试信息输出	见上述代码调试和优化示例
代码复用和模块化	通过头文件包含和宏定义实现	-

11. 总结与建议

11.1 总结

预处理器是C语言编译过程中的重要组成部分，它能够在源代码翻译之前对其进行修改和转换。通过文件包含、条件包含、宏定义等功能，预处理器可以提高代码的可维护性、可移植性和复用性。同时，使用头文件保护机制可以避免头文件的重复包含问题，使用合理的命名习惯可以避免宏定义冲突问题。

11.2 建议

• 在编写头文件时，始终使用头文件保护机制，确保头文件只被包含一次。
• 遵循一致的命名习惯，如使用全大写字母定义宏名或为宏名添加前缀，避免宏名冲突。
• 在使用条件包含指令时，仔细检查谓词条件，确保逻辑正确。可以使用 #error 指令在条件不满足时给出明确的错误信息。
• 在调试和优化代码时，使用宏定义来控制代码的行为，如输出调试信息、启用或禁用某些功能。
• 合理使用预处理器的功能，避免过度使用宏定义导致代码难以理解和维护。

通过掌握预处理器的相关知识和技巧，可以编写出更加高效、健壮的C语言程序。希望以上内容对您在C语言编程中使用预处理器有所帮助。