通过CMake的option启用或禁用特定功能

1 介绍

option 命令用于定义布尔型选项，可以在构建项目时启用或禁用特定的功能。

option可以在CMake配置时被打开或关闭，从而影响构建流程。通过option，我们可以为用户提供灵活的配置方式，使其可以根据需要启用或禁用某些功能。

2 语法

option(<option_variable> "description" <initial_value>)

• <option_variable>: 选项变量的名称。
• "description": 选项的描述。
• <initial_value>: 选项的初始值，通常是 ON 或 OFF。

例如，定义一个选项来控制是否启用日志功能：

option(ENABLE_LOGGING "Enable logging functionality" ON)

在CMakeLists.txt中，可以通过if语句来使用这个选项：

if(ENABLE_LOGGING)
    add_definitions(-DENABLE_LOGGING)
endif()

3 示例

点击下载本文的所有代码示例

下面是一个完整的示例，通过option来控制日志功能的启用与否。
CMakeLists.txt示例代码：

cmake_minimum_required(VERSION 3.10)
project(CMakeOptionExample)

# 定义选项, 默认开启
option(ENABLE_LOGGING "Enable logging functionality" ON)

# 根据选项设置编译定义
if(ENABLE_LOGGING)
    add_definitions(-DENABLE_LOGGING)
endif()

# 添加源文件
add_executable(CMakeOptionExample main.cpp) 

main.cpp示例代码：

#include <iostream>

#ifdef ENABLE_LOGGING
void log(const std::string& message) {
    std::cout << "LOG: " << message << std::endl;
}
#else
void log(const std::string&) {}
#endif

int main() {
    log("This is a log message.");
    std::cout << "Hello, World!" << std::endl;
    return 0;
}

4 不修改CMakeLists情况下启用或禁用option

4.1 使用CMake命令行构建项目

如果你是通过CMake命令行来构建项目：

cmake -DENABLE_LOGGING=OFF ..

4.2 使用VS code IDE构建代码

1. 打开VS Code并加载你的CMake项目。
2. 确保已安装CMake Tools扩展。
3. 打开命令面板（Ctrl+Shift+P），输入并选择CMake: Edit User-Local CMake Kits。
4. 在.vscode目录下找到或创建settings.json文件，添加或修改对应的配置：

   {
   	"cmake.configureSettings": {
       	"ENABLE_LOGGING": "OFF"
   	}
   }
   

5. 打开命令面板（Ctrl+Shift+P），然后选择CMake: Configure命令来重新配置项目以应用新的设置。

4.3 使用Visual Studio IDE构建代码

1. 打开Visual Studio并加载你的CMake项目。
2. 右键点击项目名称，选择CMake Settings。
3. 在CMake Settings窗口中，找到你的CMake配置（例如x64-Debug）。
4. 点击Edit JSON，编辑CMakeSettings.json文件。
5. 在configurations部分中，添加或修改variables字段：

   {
       "variables": [
           {
               "name": "ENABLE_LOGGING",
               "value": "OFF"
           }
       ]
   }
   

6. 保存文件，Visual Studio会自动重新配置和生成项目。

4.4 Qt Creator

1. 打开Qt Creator并加载你的CMake项目。
2. 进入项目视图，选择左侧的构建和运行标签。
3. 在构建设置下，找到CMake部分。
4. 在CMake部分，你会看到CMake选项，可以在这里添加自定义的CMake选项。
5. 添加如下选项来禁用日志功能：

   -DENABLE_LOGGING=OFF
   

6. 点击应用，然后重新构建项目。

5 使用场景

5.1 调试和发布配置

可以定义选项来启用或禁用调试信息、日志记录等。

启用调试宏：

option(ENABLE_DEBUG "Enable debug mode" OFF)
if(ENABLE_DEBUG)
    add_definitions(-DDEBUG_MODE)
    set(CMAKE_BUILD_TYPE Debug)
endif()

5.2 可选功能模块或与子模块结合

例如启用或禁用特定功能模块，如数据库支持、网络支持等。
例如某些工程需要依赖子模块才能编译，通过选项可实现无需子模块也能编译。

option(USE_CUSTOM_LIB "Use custom library" OFF)

if(USE_CUSTOM_LIB)
    find_package(CustomLib REQUIRED)
    target_link_libraries(MyProject CustomLib)
endif()

5.3 跨平台构建

根据不同平台启用或禁用某些特性