一、Linux下安装CMake

1.1 源码安装

sudo apt-get install build-essential
sudo wget https://cmake.org/files/v3.28/cmake-3.28.0.tar.gz
tar -zxvf cmake-3.28.0.tar.gz
cd cmake-3.28.0
/configure
sudo make
sudo make install
cmake --version 检查是否安装成功

1.2 初体验

下面就可以写一段代码来简单使用一下CMake,
hello.cc:

#include <iostream>
int main() {std::cout << "hello cmake" << std::endl;return 0;
}

CMakeLists.txt:

cmake_minimum_required(VERSION 3.20.0) 
project(hello)
add_executable(hello hello.cc)

生成makefile文件：

cmake -B build

生成二进制可执行文件：

cmake --build build

运行可执行文件：

build/hello

二、CMake Language

如果不用上述的通过CMakeLists.txt运行cmake，还可以使用cmake -P filename.cmake来运行cmake文件，本写法较少在项目中用到，但适合学习cmake语法。

2.1 message打印

# 单行打印
message(hello cmake)
message("hello cmake")
# 多行打印
message("hello
cmake")
message([[hello
cmake]])

此外，还可以使用message获取关于cmake的信息，使用时需要加上${}表示获取变量，如获取版本号message(\${CMAKE_VERSION})

2.2 变量的操作 set list

cmake的变量分为两种：

• cmake自带
• 自定义
• CMake变量的命名区分大小写
• CMake中的变量在存储时都是字符串
• CMake获取变量：${变量名}
• 变量的基础操作是set()与unset()，但也可以用list或是string操作变量

2.2.1 Set 方法

• set(<variable> <value>... [CACHE <type> <docstring> [FORCE]])
  • <variable>：要设置的变量名称。
  • <value>：变量的值，可以是单个值，也可以是多个值。
  • CACHE：如果需要将变量存储到 CMake 缓存中，可以使用此选项。
  • <type>：缓存变量的类型，例如 BOOL、STRING、FILEPATH 等。
  • <docstring>：缓存变量的描述信息，通常是对变量用途的说明。
  • FORCE：强制更新缓存变量，即使它已经存在。
• set可以给一个变量设置多个值
  设置一个值：

set(MY_VAR "Hello World")
message(${MY_VAR})  # 输出 "Hello World"

设置多个值：

set(MY_LIST 1 2 3 4)
message("${MY_LIST}")  # 输出 "1;2;3;4"

2.2.2 List 方法

在 CMake 中，list 命令用于操作列表变量，包括添加、获取、插入、删除、查找和分割列表元素等。CMake 中的列表是用分号 (😉 分隔的一系列字符串。

• list(<COMMAND> <LIST_NAME> [ARGS...])
  • <COMMAND>具体的列表操作命令。
  • <LIST_NAME>：操作的列表变量名称。
  • ARGS…：根据具体命令传递的参数。

1. APPEND：向列表末尾添加元素

set(MY_LIST "A" "B")
list(APPEND MY_LIST "C" "D")
message("${MY_LIST}")  # 输出 "A;B;C;D"

2. PREPEND：向列表开头添加元素

set(MY_LIST "A" "B")
list(PREPEND MY_LIST "C" "D")
message("${MY_LIST}")  # 输出 "C;D;A;B"

3. INSERT：向指定位置插入元素

set(MY_LIST "A" "B" "C")
list(INSERT MY_LIST 1 "X" "Y")
message("${MY_LIST}")  # 输出 "A;X;Y;B;C"

4. REMOVE_ITEM：移除指定的元素

set(MY_LIST "A" "B" "C" "B")
list(REMOVE_ITEM MY_LIST "B")
message("${MY_LIST}")  # 输出 "A;C"

5. REMOVE_AT：移除指定位置的元素

set(MY_LIST "A" "B" "C" "D")
list(REMOVE_AT MY_LIST 1 3)
message("${MY_LIST}")  # 输出 "A;C"

6. REMOVE_DUPLICATES：移除重复元素

set(MY_LIST "A" "B" "A" "C" "B")
list(REMOVE_DUPLICATES MY_LIST)
message("${MY_LIST}")  # 输出 "A;B;C"

7. LENGTH：获取列表长度

set(MY_LIST "A" "B" "C")
list(LENGTH MY_LIST LEN)
message("Length: ${LEN}")  # 输出 "Length: 3"

8. GET：获取指定位置的元素

set(MY_LIST "A" "B" "C")
list(GET MY_LIST 1 ITEM)
message("Item: ${ITEM}")  # 输出 "Item: B"

9. FIND：查找元素的位置

set(MY_LIST "A" "B" "C")
list(FIND MY_LIST "B" INDEX)
message("Index: ${INDEX}")  # 输出 "Index: 1"

10. SORT：对列表排序

set(MY_LIST "C" "A" "B")
list(SORT MY_LIST)
message("${MY_LIST}")  # 输出 "A;B;C"

11. REVERSE：反转列表

set(MY_LIST "A" "B" "C")
list(REVERSE MY_LIST)
message("${MY_LIST}")  # 输出 "C;B;A"

三、CMake 流程控制

3.1 if 条件

3.1.1 基本语法

if (CONDITION)# 当 CONDITION 为真时执行的代码块
elseif (ANOTHER_CONDITION)# 当 ANOTHER_CONDITION 为真时执行的代码块
else()# 当上述条件均不满足时执行的代码块
endif()

• if：开始条件判断。
• elseif：可选的分支，用于添加额外的条件。
• else：可选分支，处理所有未满足的情况。
• endif：结束 if 块。

3.1.2 常用的条件判断

1. 布尔值

set(VAR TRUE)
if (VAR)message("VAR is true")
else()message("VAR is false")
endif()

布尔值判断支持 TRUE、FALSE，以及空字符串（视为 FALSE）。
2. 数值比较

set(VAR 10)
if (VAR EQUAL 10)message("VAR is 10")
elseif (VAR GREATER 10)message("VAR is greater than 10")
else()message("VAR is less than 10")
endif()

• EQUAL：等于
• LESS：小于
• GREATER：大于
• LESS_EQUAL：小于等于
• GREATER_EQUAL：大于等于
• NOT：取反

3. 字符串比较

set(VAR "hello")
if (VAR STREQUAL "hello")message("VAR equals hello")
endif()

• STREQUAL：字符串相等
• MATCHES：正则表达式匹配

4. 文件和路径

if (EXISTS "CMakeLists.txt")message("CMakeLists.txt exists")
endif()

• EXISTS：检查文件或目录是否存在
• IS_DIRECTORY：检查是否为目录
• IS_SYMLINK：检查是否为符号链接

5. 变量自定义检查

if (DEFINED MY_VAR)message("MY_VAR is defined")
endif()

3.1.3 组合条件

条件可以用逻辑运算符组合：

• AND：逻辑与
• OR：逻辑或
• NOT：逻辑非

if (VAR1 EQUAL 10 AND VAR2 STREQUAL "hello")message("Both conditions are true")
endif()

3.2 loop 循环

CMake 支持循环控制语句，用于多次重复执行一段代码，主要包括 foreach 和 while 两种循环形式。

3.2.1. foreach 循环

基本语法

foreach(item RANGE)# 循环体，item 是当前值
endforeach()

foreach 用于遍历列表、范围或变量。其具体形式包括三种：
1. 遍历列表
❗️这可能是最常见的用法

set(LIST_VAR a b c d)
foreach(item IN LISTS LIST_VAR)message("Item: ${item}")
endforeach()#也可以直接指定值列表：
foreach(item a b c d)message("Item: ${item}")
endforeach()

这类似于C++11的增强for循环，item相当于auto+变量
2. 遍历范围
从0开始，左闭右闭：

foreach(i RANGE 5) # 从0开始message("Index: ${i}")
endforeach()

RANGE 5 表示 [0, 1, 2, 3, 4, 5]。

• 除此之外，也可以指定起始与结束：

foreach(i RANGE 2 5)message("Index: ${i}")
endforeach()

• 还可以指定步长

foreach(i RANGE 2 10 3) # 依次为 始点 终点 步长message("Index: ${i}")
endforeach()

3. 遍历zip拼接
方式1:

set(L1 key1 key2 key3)
set(L2 value1 value2 value3)
foreach(key value IN ZIP_LISTS L1 L2)message("Key: ${key}, Value: ${value}")
endforeach()

方式2:

set(L1 key1 key2 key3 key4)
set(L2 value1 value2 value3 value4)
set(L3 a b c)
foreach(num IN ZIP_LISTS L1 L2 L3)message("Key: ${num_0}, Value: ${num_1}, alphabet=${num_2}")
endforeach()

当某列表为空但另一列表非空时，不会报错，为空的列表也会被打印成空
### 3.2.2 while 循环

基本语法

while(CONDITION)# 循环体
endwhile()

while 不经常使用，这里就不展开说了

四、CMake 语法函数

4.1 基本语法

使用function关键字定义函数：

function(<name> [arg1 [arg2 ...]])# 函数体# 使用 ${arg1}, ${arg2} 来访问参数
endfunction()

• <name> 是函数名。
• [arg1, arg2…] 是可选的参数。

4.2 函数特性

4.2.1 作用域

• 函数内部定义的变量是局部变量，超出函数范围后会被销毁。
• 如果需要修改全局变量，可以使用 PARENT_SCOPE。

function(set_global_var value)set(MY_VAR ${value} PARENT_SCOPE)
endfunction()set_global_var("Global Value")
message(${MY_VAR})  # 输出: Global Value

4.2.2 可变参数

• 使用 ARGV 和 ARGN 访问所有参数或从固定参数后的可变参数。
• ARGV：包含所有传递的参数。
  • 可以使用ARGV0、ARGV1指定传递的参数
• ARGN：从定义的固定参数之后的所有额外参数。

function(print_all_args)message("All arguments: ${ARGV}")message("First arguments: ${ARGV0}")message("Second arguments: ${ARGV1}")
endfunction()print_all_args(1 2 3 4)  # 输出: All arguments: 1;2;3;4