CMake | include_guard命令详解

目录

一、命令详解

二、简单使用

1.CMakeLists.txt

2.cmake/custom.cmake

3.配置

三、为低于3.10的版本自定义“包含保护”机制

1.cmake变量介绍

（1）CMAKE_CURRENT_LIST_FILE

2.修改CMakeLists.txt

3.cmake/my_module.cmake

4.配置

---

        模块可能被include多次，为了避免多次包含一个模块，CMake从3.10版开始引入内置的 include_guard 命令，对于C/C++头文件，它的行为就像 #pragma 一样。

一、命令详解

include_guard([DIRECTORY|GLOBAL])

为CMake当前正在处理的文件提供包含保护，可选参数指定保护的范围：

• DIRECTORY：include guard适用于当前目录及以下子目录。该文件只会在该目录范围内包含一次，但可能会被该目录以外的其他文件再次包含（即父目录或其他目录，而不是由当前文件或其子目录中的add_subdirectory（）或include（）拉入）。
• GLOBAL：include guard适用于整个构建。无论范围如何，当前文件只包含一次。

二、简单使用

1.CMakeLists.txt

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)

project(recipe-05 LANGUAGES NONE)

include(cmake/custom.cmake)
#第二次包含
include(cmake/custom.cmake)

2.cmake/custom.cmake

message(STATUS "custom.cmake0")

include_guard(GLOBAL)

message(STATUS "custom.cmake1")

3.配置

        如果当前文件已在适用范围内处理，则CMake将在include_guard（）命令的位置结束对当前文件的处理。这提供了类似于源标题中常用的#pragma-once指令的功能。如果之前针对适用范围处理过当前文件，其效果就像调用了return( )。不要在当前文件定义的函数中调用include_guard命令。

三、为低于3.10的版本自定义“包含保护”机制

1.cmake变量介绍

（1）CMAKE_CURRENT_LIST_FILE

        当前正在处理的列表文件的完整路径。

        在CMake处理项目中的列表文件时，此变量将始终设置为当前正在处理的变量。该值具有动态范围。当CMake开始处理源文件中的命令时，它会将此变量设置为文件的位置。当CMake处理完文件中的命令后，它将恢复以前的值。因此，宏或函数中变量的值是调用调用堆栈最底层项的文件，而不是包含宏或函数定义的文件。

2.修改CMakeLists.txt

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)

project(recipe-05 LANGUAGES NONE)

#注意这行
include(cmake/my_module.cmake)

include(cmake/custom.cmake)

include(cmake/custom.cmake)

3.cmake/my_module.cmake

        重新定义include_guard。

• 在小于3.10的版本中，如果第一次调用宏，则 included_modules 变量没有定义，因此我们将其设置为空列表。然后检查 ${CMAKE_CURRENT_LIST_FILE} 是否是 included_modules 列表中的元素。如果是，则会发出警告；如果没有，我们将 ${CMAKE_CURRENT_LIST_FILE} 追加到这个列表。
• CMake 3.10及更高版本的情况有所不同，我们会调用内置的 include_guard。

macro(include_guard)
    if(CMAKE_VERSION VERSION_LESS "3.10")
  
        message(STATUS "calling our custom include_guard")

        if(NOT DEFINED included_modules)
            set(included_modules)
        endif()

        if ("${CMAKE_CURRENT_LIST_FILE}" IN_LIST included_modules)
            message(WARNING "module ${CMAKE_CURRENT_LIST_FILE} processed more than once")
        else()
            list(APPEND included_modules ${CMAKE_CURRENT_LIST_FILE})
	    endif()
    else()
        message(STATUS "calling the built-in include_guard")
		#_include_guard(${ARGV}) 指向内置的 include_guard,重新定义函数和宏
		_include_guard(${ARGV})
		message(STATUS "test")
	endif()
endmacro()

4.配置

当cmake版本小于3.10时：

 当cmake版本大于3.10时：