cmakefile 里面的 option

CMake 中的 `option` 命令用于创建一个开关选项，该选项可在 CMake GUI 中显示，并允许用户在构建期间选择是否启用某些功能。该命令的语法如下：

option(<option_variable> "help string" [initial value])

其中，`<option_variable>` 是选项的名称，`"help string"` 是选项的说明文本，`[initial value]` 是选项的初始值（默认值为 `OFF`）。

例如，以下代码创建了一个名为 `USE_OPENMP` 的选项，用于控制是否启用 OpenMP 并行编程：

option(USE_OPENMP "Enable OpenMP support" OFF)

在 CMake GUI 中，用户可以看到一个名为 `USE_OPENMP` 的复选框，勾选表示启用 OpenMP 支持，不勾选表示禁用。在 CMakeLists.txt 文件中，可以使用 `${USE_OPENMP}` 变量来获取用户选择的值，例如：

if(USE_OPENMP)
  find_package(OpenMP REQUIRED)
  target_link_libraries(myapp OpenMP::OpenMP_CXX)
endif()

相关问题

cmake option

在CMake中，option可以用来定义一个可选的开关选项。它允许用户在构建过程中选择是否启用某些功能或选项。

使用option命令，可以在CMakeLists.txt文件中创建一个选项，并为其提供一个默认值和一个描述。语法如下：

option(<option_name> "<option_description>" <default_value>)

其中，<option_name>是选项的名称，<option_description>是对选项的描述，<default_value>是选项的默认值。

例如，我们可以创建一个名为ENABLE_DEBUG的选项，并将其默认值设置为OFF：

option(ENABLE_DEBUG "Enable debug mode" OFF)

在构建过程中，用户可以使用cmake命令行或CMake GUI来选择是否启用DEBUG模式。如果用户选择启用了该选项，那么在生成构建系统时，相关的编译选项或宏定义就会被设置为相应的值。

在CMakeLists.txt文件中，我们可以使用if语句来根据选项的值执行不同的操作。例如：

if(ENABLE_DEBUG)
    # 执行调试模式相关的操作
    add_definitions(-DDEBUG_MODE)
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g")
else()
    # 执行非调试模式相关的操作
endif()

这样，我们可以根据用户的选择来灵活地配置项目的构建过程。

vscode cmake option 参数设置

### 如何在 VSCode 中设置 CMake 的 Option 参数

为了在 Visual Studio Code (VSCode) 中配置 CMake 项目的 `option` 参数，可以通过修改 `CMakeLists.txt` 文件来定义这些选项，并通过命令行传递给 CMake 配置过程。

#### 修改 `CMakeLists.txt`

在 `CMakeLists.txt` 文件中声明所需的选项。例如：

option(USE_OPENMP "Enable OpenMP support" OFF)
if(USE_OPENMP)
    find_package(OpenMP REQUIRED)
    add_compile_options(${OpenMP_CXX_FLAGS})
endif()

这段代码创建了一个名为 `USE_OPENMP` 的布尔型选项，默认关闭[^1]。

#### 使用命令行传递 CMake Options

当首次配置项目时，可以在终端中指定自定义的 CMake 变量。对于上述例子中的 `USE_OPENMP` 选项，可以这样做：

mkdir build && cd build
cmake .. -DUSE_OPENMP=ON

这会启用 `USE_OPENMP` 功能并将其应用于整个构建过程中[^2]。

#### 更新 `.vscode/settings.json`

为了让 VSCode 正确识别新的 CMake 编译器标志和其他设置，可能还需要更新工作区下的 `.vscode/settings.json` 文件以包含特定于环境的配置项。比如指明要使用的工具链或额外的预处理器宏定义等[^3]。

#### 调试配置调整

如果计划利用 VSCode 内置调试功能，则应相应地编辑 `launch.json` 文件内的 `"preLaunchTask"` 字段指向正确的构建目标以及确保程序路径正确无误[^4]。