CMake中include指令介绍

怼烎@ 2022-05-19 05:52 249阅读 0赞

**\[20210428更新\]：**补充了 CMakeList.txt 文件中遗漏的 include 指令相关内容。

--------------------

本文主要介绍 CMake 中 include 指令的相关知识。

# 1 概述 #

引用 CMake 官网对于 include 指令的介绍，如下：

> Load and run CMake code from a file or module.

include 指令的用法如下：

include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>] [NO_POLICY_SCOPE])

> **Load and run CMake code from the file given.** Variable reads and writes access the scope of the caller (dynamic scoping). If OPTIONAL is present, then no error is raised if the file does not exist. If RESULT\_VARIABLE is given, the variable will be set to the full filename which has been included or NOTFOUND if it failed.
> 
> If a module is specified instead of a file, the file with name <modulename>.cmake is searched first in CMAKE\_MODULE\_PATH, then in the CMake module directory. There is one exception to this: if the file which calls include() is located itself in the CMake builtin module directory, then first the CMake builtin module directory is searched and CMAKE\_MODULE\_PATH afterwards. See also policy CMP0017.
> 
> See the cmake\_policy() command documentation for discussion of the NO\_POLICY\_SCOPE option.

# 2 作用 #

从前面所述，可知 include 指令用来载入并运行来自于文件或模块的 CMake 代码。

在这里针对一些具体的问题场景，介绍 include 指令的具体用法。

## 2.1 多C++标准版本指定 ##

有时遇到这样一种需求，在使用同一个外层 CMakeLists.txt 的前提下，每个源码子目录中要求使用的 C++ 标准版本不同，有的源码要求使用 C++98 标准编译、有的源码要求使用 C++11 标准编译，这时就可以使用 include 指令来满足该需求。

### 2.1.1 项目代码结构及内容 ###

此处使用[《CMake介绍及其用法示例》][CMake]中的项目代码结构，并在其基础上做一些改动，改动后的项目代码结构如下：

![70][]

相比于之前的项目代码结构，这里新增了“cmake\_dir3”这个源码目录，同时，修改了最外层的  CMakeLists.txt。

cmake\_dir3 目录中包含的文件列表如下：

[root@node1 /opt/liitdar/mydemos/simples/cmake_test]# l cmake_dir3
    total 8
    -rw-r--r--. 1 root root 257 Jul 21 14:19 CMakeLists.txt
    -rw-r--r--. 1 root root 258 Jul 21 14:19 main.cpp
    [root@node1 /opt/liitdar/mydemos/simples/cmake_test]#

其中，CMakeLists.txt 内容如下：

# 遍历当前路径下的所有源文件，并将其添加到变量DIR_SRCS中
    aux_source_directory(. DIR_SRCS)
    
    # 添加名为cmake_test3的可执行文件，该文件会由变量DIR_SRCS中的源文件构建生成
    add_executable(cmake_test3 ${DIR_SRCS})

源码文件 main.cpp 内容如下：

#include <iostream>
    #include <string>
    
    using namespace std;
    
    int main()
    {
        int a = 100;
        string strTest;
    
        strTest = to_string(a) + " is a string.";
    
        cout << "a is: " << a << endl;
        cout << "pszTest is: " << strTest << endl;
    
        return 0;
    }

最外层的 CMakeLists.txt 改动部分（新增了 cmake\_dir3 源码目录）如下：

![70 1][]

### 2.1.2 项目构建 ###

对上述项目使用 CMake 进行构建，过程信息如下：

![70 2][]

通过上图可以看到，项目构建失败了，因为在 cmake\_dir3 中存在“to\_string”函数，该函数需要在 C++11 标准下进行编译，而项目默认使用的是 C++98 标准。

### 2.1.3 解决方案 ###

此时，就需要为 cmake\_dir3 设置不同的 C++ 标准进行编译了。具体步骤如下：

1. 在最外层的 CMakeList.txt 的同级目录下，增加一个文件 set\_cxx\_norm.cmake，如下：

![70 3][]

文件 set\_cxx\_norm.cmake 的内容如下：

# set c++ norm value, these values will be used for comparision later
    set(CXX_NORM_CXX98 1)   # C++98
    set(CXX_NORM_CXX03 2)   # C++03
    set(CXX_NORM_CXX11 3)   # C++11
    
    # Set the wanted C++ norm
    # Adds the good argument to the command line in function of the compiler
    macro(set_cxx_norm NORM)
        # Extract c++ compiler --version output
        exec_program(
            ${CMAKE_CXX_COMPILER}
            ARGS --version
            OUTPUT_VARIABLE _compiler_output
        )
        # Keep only the first line
        string(REGEX REPLACE
            "(\n.*$)"
            ""
            cxx_compiler_version "${_compiler_output}"
        )
        # Extract the version number
        string(REGEX REPLACE
            "([^0-9.])|([0-9.][^0-9.])"
            ""
            cxx_compiler_version "${cxx_compiler_version}"
        )
    
        # Set the specific C++ norm According 'NORM'
        if(${NORM} EQUAL ${CXX_NORM_CXX98})
            add_definitions("-std=c++98")
        elseif(${NORM} EQUAL ${CXX_NORM_CXX03})
            add_definitions("-std=c++03")
        elseif(${NORM} EQUAL ${CXX_NORM_CXX11})
            if(${cxx_compiler_version} VERSION_LESS "4.7.0")
                add_definitions("-std=c++0x")
            else()
                add_definitions("-std=c++11")
            endif()
        endif()
    
    endmacro()

2. 然后，通过修改最外层的 CMakeLists.txt，**使用include指令**引入 set\_cxx\_norm.cmake 文件，这样就可以在源码目录中设置想要使用的 C++ 标准了。CMakeList.txt 中新增的 include 指令如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpaXRkYXI_size_16_color_FFFFFF_t_70][]

3. 最后，修改 cmake\_dir3 的 CMakeLists.txt 文件，新增“要使用C++11标准”的语句，如下：

# 使用C++11标准
    set_cxx_norm(${CXX_NORM_CXX11})

完成上述修改后，再次进行项目构建，结果如下：

![70 4][]

通过上图能够知道，项目构建成功了。此时，cmake\_test1 和 cmake\_test2 使用的是 C++98（默认）标准；而 cmake\_test3 使用的是 C++11 标准。

运行 cmake\_test3 程序，运行结果如下：

![70 5][]

上面的运行结果表明，cmake\_test3 成功调用了 C++11 标准的“to\_string”函数，将整型转换为字符串类型了。

[CMake]: https://blog.csdn.net/liitdar/article/details/80670060
[70]: /images/20220519/42f1d30a20044e99a3d5e166dacfdca4.png
[70 1]: /images/20220519/f0808dff343c438ca1582084d9ae6d0f.png
[70 2]: /images/20220519/de5fdc60e0174b01a7d893d7c8bc3cb9.png
[70 3]: /images/20220519/31efa3d8fab04514a5849d38c3fa95cc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpaXRkYXI_size_16_color_FFFFFF_t_70]: /images/20220519/efc8f69acbce498f81444c81af5f2954.png
[70 4]: /images/20220519/7d11cbeb7322491b83d7bd89bda9afe6.png
[70 5]: /images/20220519/ff35908ff87e4d0d88c18700950a71e6.png