C++：CMake语法指令【cmake_minimum_required、project，set】

柔情只为你懂 2023-09-25 13:05 50阅读 0赞

## CMake语法特性 ##

基本语法格式：指令(参数 1 参数 2…)

*  参数使用括弧括起；
 *  参数之间使用空格或分号分开；

指令是大小写无关的，参数和变量是大小写相关的

*  set(HELLO hello.cpp)
 *  add\_executable(hello main.cpp hello.cpp)
 *  ADD\_EXECUTABLE(hello main.cpp $\{HELLO\})

变量使用`${}`方式取值，但是在 IF 控制语句中是直接使用变量名

## 一、CMake重要指令 ##

### 1、重要指令 ###

#### 1.1 cmake\_minimum\_required【指定CMake的最小版本要求】 ####

语法：cmake\_minimum\_required(VERSION versionNumber \[FATAL\_ERROR\])

# CMake最小版本要求为2.8.3
    cmake_minimum_required(VERSION 2.8.3)

#### 1.2 project【定义工程名称，并可指定工程支持的语言 】 ####

语法：project(projectname \[CXX\] \[C\] \[Java\])

# 指定工程名为HELLOWORLD
    project(HELLOWORLD)

project(HELLOWORLD LANGUAGES CXX C)

#### 1.3 set【显式的定义变量 】 ####

语法：set(VAR \[VALUE\] \[CACHE TYPE DOCSTRING \[FORCE\]\])

# 定义SRC变量，其值为main.cpp hello.cpp
    set(SRC main.cpp hello.cpp)

#### 1.4 include\_directories【向工程添加多个特定的头文件搜索路径 —>相当于指定g++编译器的-I参数】 ####

语法：include\_directories(\[AFTER|BEFORE\] \[SYSTEM\] dir1 dir2 …)

# 将/usr/include/myincludefolder 和 ./include 添加到头文件搜索路径
    include_directories(/usr/include/myincludefolder ./include)

#### 1.5 link\_directories【向工程添加多个特定的库文件搜索路径 —>相当于指定g++编译器的-L参数】 ####

语法：link\_directories(dir1 dir2 …)

# 将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径
    link_directories(/usr/lib/mylibfolder ./lib)

#### 1.6 add\_library【生成库文件】 ####

语法：add\_library(libname \[SHARED|STATIC|MODULE\] \[EXCLUDE\_FROM\_ALL\] source1 source2 … sourceN)

# 通过变量 SRC 生成 libhello.so 共享库
    add_library(hello SHARED ${SRC})

#### 1.7 add\_compile\_options【添加编译参数】 ####

语法：add\_compile\_options()

# 添加编译参数 -Wall -std=c++11
    add_compile_options(-Wall -std=c++11 -O2)

#### 1.8 add\_executable【生成可执行文件】 ####

语法：add\_library(exename source1 source2 … sourceN)

# 编译main.cpp生成可执行文件main
    add_executable(main main.cpp)

#### 1.9 target\_link\_libraries【为 target 添加需要链接的共享库 —>相同于指定g++编译器-l参数】 ####

语法：target\_link\_libraries(target library1library2…)

# 将hello动态库文件链接到可执行文件main
    target_link_libraries(main hello)

#### 1.10 add\_subdirectory【向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置】 ####

语法：add\_subdirectory(source\_dir \[binary\_dir\] \[EXCLUDE\_FROM\_ALL\])

# 添加src子目录，src中需有一个CMakeLists.txt
    add_subdirectory(src)

#### 1.11 aux\_source\_directory【发现一个目录下所有的源代码文件并将列表存储在一个变量中，这个指令临时被用来自动构建源文件列表】 ####

语法：aux\_source\_directory(dir VARIABLE)

# 定义SRC变量，其值为当前目录下所有的源代码文件
    aux_source_directory(. SRC)
    # 编译SRC变量所代表的源代码文件，生成main可执行文件
    add_executable(main ${SRC})

#### 1.12 message ####

cmake 中的 message 命令就像是 C 语言中的 printf 函数，该命令可以将变量的值显示到终端。因此我们可以使用 message 命令查看变量值是否正确。但是，message 命令要比 printf 函数的功能强大，该命令可以终止编译系统的构建。而且这通常也是我们想要的效果。

语法：message(\[\] “message text” …)

*  "message text"为显示在终端的内容。
 *  mode 的值包括 FATAL\_ERROR、WARNING、AUTHOR\_WARNING、STATUS、VERBOSE等。我主要使用其中的 2 个——FATAL\_ERROR、STATUS。
    
     *  FATAL\_ERROR：产生 CMake Error，会停止编译系统的构建过程；
     *  STATUS：最常用的命令，常用于查看变量值，类似于编程语言中的 DEBUG 级别信息。

CMakeLists.txt：

cmake_minimum_required(VERSION 3.5)
    
    project(test-message)
    
    # MSG_SIZE 合法值
    set(MSG_SIZE_LIST 5k 500k 1m 20m)
    
    #查询传入的 MSG_SIZE 值是否在 list 中
    list(FIND MSG_SIZE_LIST ${MSG_SIZE} RET)
    
    message(STATUS "result:${RET}")
    
    if(${RET} EQUAL -1)
        #如果传入的参数不合法，那么就停止 cmake 程序
        message(FATAL_ERROR "invalid msg size")
    endif()

测试命令：

> cmake -DMSG\_SIZE=10m …

执行结果：

-- The C compiler identification is GNU 5.4.0
    -- The CXX compiler identification is GNU 5.4.0
    -- Detecting C compiler ABI info
    -- Detecting C compiler ABI info - done
    -- Check for working C compiler: /usr/bin/cc - skipped
    -- Detecting C compile features
    -- Detecting C compile features - done
    -- Detecting CXX compiler ABI info
    -- Detecting CXX compiler ABI info - done
    -- Check for working CXX compiler: /usr/bin/c++ - skipped
    -- Detecting CXX compile features
    -- Detecting CXX compile features - done
    -- result:-1
    CMake Error at CMakeLists.txt:12 (message):
      invalid msg size
    
    
    -- Configuring incomplete, errors occurred!
    See also "/home/sdc/project/msg/build/CMakeFiles/CMakeOutput.log".

由于传入的 MSG\_SIZE 值非法，所以 CMakeLists.txt 中的 if 语句判断为真，执行 message(FATAL\_ERROR …) 语句，终止编译系统的构建。

#### 1.13 STREQUAL 用于比较字符串，相同返回 true 。 ####

如果您要比较两个字符串(而不是变量)，则只需将其引用为：

if("${A}" STREQUAL"some string")