CMake 中的变量：全面解析 CMake 中的变量类型和使用方法

# 1. 什么是 CMake 变量

在 CMake 中，变量是用来存储和管理数据的重要概念。通过使用变量，可以在 CMake 脚本中传递信息、控制流程和配置构建过程。

### 1.1 CMake 变量的概念

- 变量是在 CMake 中用于存储数据的标识符。
- 变量可以存储各种类型的数据，如字符串、列表、布尔值等。
- 通过设置和引用变量，可以在 CMake 脚本中传递信息和控制行为。

### 1.2 变量命名规则

在 CMake 中，变量的命名遵循以下规则：

- 变量名区分大小写。
- 变量名必须以字母开头，可以包含字母、数字和下划线。
- 推荐使用驼峰命名法或下划线命名法。

变量的命名应具有描述性，帮助理解变量的用途和含义，提高代码的可读性和维护性。

总结：本节介绍了 CMake 中变量的概念，以及变量的命名规则。变量是在 CMake 中用于存储数据的标识符，通过合适的命名和设置，可以更好地管理和利用变量。

# 2. CMake 中的变量类型

在 CMake 中，变量可以分为字符串变量、列表变量和布尔变量三种类型。下面将分别介绍它们的定义和使用方法。

### 2.1 字符串变量

字符串变量是最常见的一种变量类型，在 CMake 中用于存储文本信息。可以使用 `set()` 命令来定义和设置字符串变量，例如：

set(MY_STRING "Hello, CMake!")
message("String variable: ${MY_STRING}")

在上面的代码中，我们定义了一个名为 `MY_STRING` 的字符串变量，并输出其内容。

### 2.2 列表变量

列表变量用于存储多个值，以空格分隔。可以使用 `set()` 命令将多个值存储在一个列表变量中，例如：

set(MY_LIST 1 2 3 4 5)
message("List variable: ${MY_LIST}")

上面的代码定义了一个名为 `MY_LIST` 的列表变量，其中包含了 1 到 5 的整数值。

### 2.3 布尔变量

布尔变量用于存储真（TRUE）或假（FALSE）值。可以使用 `set()` 命令将一个变量定义为布尔类型，例如：

set(MY_BOOL TRUE)
if(MY_BOOL)
    message("Boolean variable is TRUE")
else()
    message("Boolean variable is FALSE")
endif()

以上代码中，我们定义了一个名为 `MY_BOOL` 的布尔变量，并根据其取值输出不同的消息。

在 CMake 中，合理使用不同类型的变量可以更灵活地控制项目的配置和构建过程。

# 3. 在 CMake 中定义和设置变量

在 CMake 中，我们可以通过多种方式定义和设置变量，这些变量可以是字符串、列表或布尔类型。以下是一些常用的设置变量的方法和命令：

### 3.1 set() 命令

`set()` 命令是用于设置变量的主要方法，语法如下：

set(VAR value [CACHE TYPE DOCSTRING [FORCE]])

- `VAR`：变量名
- `value`：变量的值
- `CACHE`：可选参数，将变量标记为缓存变量
- `TYPE`：可选参数，指定变量的类型
- `DOCSTRING`：可选参数，变量的描述信息
- `FORCE`：可选参数，强制设置变量的值

例如，定义一个字符串变量 `MY_VAR`：

set(MY_VAR "Hello, CMake!")

### 3.2 cache 变量

`set()` 命令中的 `CACHE` 参数可以将变量设定为缓存变量，该变量的值将会在 CMake 缓存中保存。这在需要用户交互输入配置信息时非常有用。

set(MY_VAR "default value" CACHE STRING "Description of MY_VAR")

### option() 命令

`option()` 命令用于定义一个具有用户友好界面的布尔选择项，语法如下：

option(OPTION_NAME "Help string" ON/OFF)

- `OPTION_NAME`：选项名称
- `"Help string"`：选项的描述信息
- `ON/OFF`：默认值为 ON 或 OFF

例如，定义一个开关选项：

option(USE_FEATURE_A "Enable feature A" ON)

以上是在 CMake 中定义和设置变量的常用方法，通过这些命令和参数，可以灵活管理项目中的各种变量。

# 4. 使用 CMake 变量

在 CMake 中，变量的使用涉及到引用、修改和删除等操作，下面将详细介绍如何使用 CMake 变量。

### 4.1 引用变量
- 在 CMake 中，使用 `${}` 语法来引用变量的值。
- 示例：

    set(my_var "Hello, World!")
    message(STATUS "my_var 的值为: ${my_var}")

### 4.2 修改变量
- 可以通过 `set()` 命令来修改变量的值。
- 示例：

    set(my_var "Hello, World!")
    set(my_var "Hello, CMake!" PARENT_SCOPE)

### 4.3 删除变量
- 可以使用 `unset()` 命令来删除一个变量。
- 示例：

    set(my_var "Hello, World!")
    unset(my_var)
    message(STATUS "my_var 是否存在: ${my_var}")

### 4.4 示例：变量交换值

下面是一个交换两个变量值的示例代码:

set(var1 "apple")
set(var2 "banana")

message(STATUS "交换前：var1 的值为 ${var1}，var2 的值为 ${var2}")

set(temp ${var1})
set(var1 ${var2})
set(var2 ${temp})

message(STATUS "交换后：var1 的值为 ${var1}，var2 的值为 ${var2}")

### 4.5 结果说明
通过使用以上方法，能够灵活地引用、修改和删除 CMake 中的变量，使得变量的管理更加便捷和可控。

# 5. CMake 中的预定义变量

在 CMake 中，除了用户自定义变量外，还存在一些预定义变量，它们可以方便地获取系统信息或用户指定的信息。

### 5.1 CMake 系统预定义变量

下表列出了一些常用的 CMake 系统预定义变量及其含义：

| 变量名 | 含义 |
|-----------------------|--------------------------|
| CMAKE_SOURCE_DIR | 项目根目录的路径 |
| CMAKE_BINARY_DIR | 编译目录的路径 |
| CMAKE_CURRENT_BINARY_DIR | 当前处理 CMakeLists.txt 文件的二进制输出目录 |
| CMAKE_CURRENT_SOURCE_DIR | 当前处理 CMakeLists.txt 文件的源码目录 |
| CMAKE_PROJECT_NAME | 当前项目名称 |
| CMAKE_VERSION | 当前 CMake 版本 |
| WIN32 | 在 Windows 环境中为 TRUE |
| UNIX | 在 UNIX 环境中为 TRUE |
| APPLE | 在苹果 macOS 环境下为 TRUE |

### 5.2 用户指定的预定义变量

除了系统预定义变量外，用户也可以在 CMakeLists.txt 文件中自定义预定义变量，例如：

# 自定义预定义变量
set(MY_CUSTOM_VAR "Hello, CMake!")

# 使用自定义预定义变量
message(STATUS "Custom variable MY_CUSTOM_VAR: ${MY_CUSTOM_VAR}")

通过上述代码示例，我们可以定义一个自定义的预定义变量 `MY_CUSTOM_VAR`，并在 CMake 编译过程中使用它。

使用预定义变量能够帮助我们更方便地获取项目信息或者自定义信息，提高了 CMake 脚本的灵活性和可维护性。

# 6. 变量作用域和共享

在 CMake 中，变量的作用域和共享机制对于变量的使用具有重要影响。了解变量的作用域可以帮助开发者避免意外覆盖变量值或者使用不正确的变量值。

#### 6.1 文件间变量传递

在 CMake 中，文件间变量传递主要通过 `PARENT_SCOPE` 和 `CACHE` 来实现。下表总结了不同方式在 CMake 中传递变量的情况：

| 方式 | 变量传递 | 作用域 |
| ------------- | ----------------- | ---------------------- |
| set() | 局部传递 | 当前作用域 |
| PARENT_SCOPE | 向上传递 | 直接父级作用域 |
| CACHE | 缓存传递 | 全局作用域 |

下面是一个文件间变量传递的示例代码：

# 文件A.cmake
set(global_var "A" CACHE STRING "Global variable")

# 文件B.cmake
message("In B.cmake, global_var: ${global_var}")  # 输出：In B.cmake, global_var: A

#### 6.2 函数中的变量作用域

在 CMake 中，函数内定义的变量默认是局部变量，函数的参数也只在函数内部有效。如果需要在函数内部修改全局变量，可以使用 `PARENT_SCOPE` 关键字。下面是一个函数内变量作用域的示例代码：

set(global_var "A" CACHE STRING "Global variable")

function(modify_global_var)
    set(global_var "B" PARENT_SCOPE)
endfunction()

modify_global_var()

message("After modifying, global_var: ${global_var}")  # 输出：After modifying, global_var: B

流程图如下所示:

graph TB
    A[开始] --> B{条件判断}
    B -- 是 --> C[执行函数]
    B -- 否 --> D[结束]

通过以上内容，我们可以更好地了解 CMake 中变量的作用域和共享机制，确保在项目中正确使用和传递变量。

# 7. 最佳实践和常见问题

在 CMake 中使用变量时，需要遵循一些最佳实践和解决常见问题，以保证项目的可维护性和稳定性。

### 变量命名建议
在命名变量时，建议遵循以下几点：
1. 使用具有描述性的变量名，尽量避免使用单个字符或简单数字命名。
2. 使用小写字母和下划线的组合来命名变量，例如：my_variable。
3. 对于全局变量，可以使用项目名前缀以区分，例如：MY_PROJECT_VARIABLE。

### 变量冲突解决方法
在 CMake 中，变量名的冲突是一个常见的问题。为了避免变量冲突，可以采取以下几种方法：
1. 使用局部变量而非全局变量，尽量减少全局变量的使用。
2. 使用命名空间来区分不同模块或组件的变量，例如：PROJECT_NAME_VARIABLE。
3. 在引入外部脚本或模块时，注意查看其定义的变量，避免与已有变量重名。

### 最佳实践示例
以下是一个基于 CMake 的最佳实践示例，展示了如何定义、设置和使用变量的方法：

# 定义一个字符串变量
set(MY_MESSAGE "Hello, CMake!")

# 输出变量的值
message(STATUS "Message: ${MY_MESSAGE}")

# 定义一个布尔变量
set(ENABLE_FEATURE ON)

# 检查布尔变量值并进行条件判断
if(ENABLE_FEATURE)
    message(STATUS "Feature is enabled!")
else()
    message(STATUS "Feature is disabled!")
endif()

在上述示例中，我们展示了如何定义字符串变量和布尔变量，并通过 `message()` 函数输出变量值以及进行条件判断。这种清晰、规范的变量使用方式有助于提高项目的可读性和可维护性。

通过以上最佳实践和常见问题的解决方法，我们可以更好地利用 CMake 中的变量机制，避免潜在的问题并提高项目的开发效率和可靠性。