在 C++ 中我们写头文件时经常需要使用 #include
来包含其他头文件,使用该头文件的程序为了使用其他头文件的内容,就需要再一次包含其他头文件。所以就会出现同一头文件被多次包含进同一源文件的情况。
例如:一个头文件中用到 string
类型的变量,而包含这个头文件的程序中也用到 string
类型的变量,这个时候 string
头文件就被包含了两次:一次是通过程序本身直接包含,另一次随着包含头文件被隐式地包含进来的。
有必要在书写头文件时做适当处理,使其遇到多次包含的情况也能安全和正常的工作。确保头文件多次包含仍能正常工作的常用技术是使用预处理器功能中的头文件保护符(header guard)。
头文件保护符依赖于预处理变量
预处理变量有两种状态:已定义和未定义。
① #define
指令把一个名字设定为预处理变量(定义);
另外两个指令则分别检查某个指定的预处理变量是否已经定义:
② #ifdef
当且仅当变量已定义时为真;
③ #ifndef
当且仅当变量变量未定义时为真。
一旦检查结果为真,则执行后续操作直至遇到 #endif
指令为止。
整个程序中的预处理变量包括头文件表示符必须唯一,通常的做法是基于头文件中类的名字来构建头文件保护符的名字,以确保唯一性,且一般把预处理变量的名字全部大写。
#ifndef SALES_DATA_H
#define SALES_DATA_H
#include <string>
struct Sales_data {
std::string bookNo;
unsigned units_sold = 0;
double revenue = 0.0;
}:
#endif
第一次包含 Sales_data.h
时,#ifndef
的检查结果为真,预处理器将顺序执行后面的操作直至遇到 #endif
为止。此时,预处理变量 SALAS_DATA_H
的值将变为已定义,而且 Sales_data.h
也会被拷贝到我们的程序中来。
后面如果再一次包含 Salas_data.h
时,则 #ifndef
的而检查结果将为假,编译器将忽略 #ifndef
到 #endif
之间的部分。
头文件即使(目前还)没有被包含在任何其他头文件中,也应该设置保护符。头文件保护符很简单,程序员只要习惯性地加上就可以了,没必要太在乎你的程序到底需不需要。