CMake如何获取当前活跃工作目录路径(Get active folder path)？

Question

在CMake项目中，如何正确获取当前活跃工作目录路径是一个常见的需求。例如，当需要动态指定配置文件路径或生成特定目录结构时，了解当前工作目录至关重要。然而，许多开发者可能会混淆`CMAKE_CURRENT_SOURCE_DIR`、`CMAKE_CURRENT_BINARY_DIR`与实际运行时的工作目录。 问题：在CMake脚本执行期间，如何准确获取当前活跃工作目录路径（即运行CMake时所在的目录）？如果直接使用`CMAKE_CURRENT_SOURCE_DIR`或`CMAKE_CURRENT_BINARY_DIR`，是否能完全满足需求？若不能，应如何结合`FILE(GET_RUNTIME_DEPENDENCIES)`或`execute_process`命令来实现更灵活的路径获取？ 注意：此问题旨在探讨CMake内置变量与外部命令结合使用的最佳实践，帮助开发者避免常见误区。

Answer 1

1. 理解CMake内置变量

在CMake中，`CMAKE_CURRENT_SOURCE_DIR`和`CMAKE_CURRENT_BINARY_DIR`是两个常用的内置变量。`CMAKE_CURRENT_SOURCE_DIR`表示当前处理的CMakeLists.txt所在的源代码目录，而`CMAKE_CURRENT_BINARY_DIR`则指向与之对应的构建输出目录。然而，这些变量并不直接对应运行CMake时的工作目录。

• `CMAKE_CURRENT_SOURCE_DIR`：源代码目录。
• `CMAKE_CURRENT_BINARY_DIR`：构建输出目录。

例如： ```cmake message("Source Dir: ${CMAKE_CURRENT_SOURCE_DIR}") message("Binary Dir: ${CMAKE_CURRENT_BINARY_DIR}") ``` 这些变量在配置文件路径或生成特定目录结构时非常有用，但它们并不能满足获取实际运行时工作目录的需求。

2. 获取运行时工作目录的误区

许多开发者可能误以为`CMAKE_CURRENT_SOURCE_DIR`或`CMAKE_CURRENT_BINARY_DIR`能够提供运行时的工作目录路径。实际上，运行时的工作目录是指执行CMake命令时所在的目录。要准确获取这一路径，需要借助外部命令。

变量	描述
`CMAKE_CURRENT_SOURCE_DIR`	源代码目录路径。
`CMAKE_CURRENT_BINARY_DIR`	构建输出目录路径。

如果仅依赖上述变量，可能会导致路径错误，特别是在跨平台开发环境中。

3. 使用`execute_process`命令

为了准确获取运行时的工作目录，可以使用CMake中的`execute_process`命令调用系统命令。以下是一个示例： ```cmake execute_process( COMMAND pwd OUTPUT_VARIABLE CURRENT_WORKING_DIR OUTPUT_STRIP_TRAILING_WHITESPACE ) message("Current Working Directory: ${CURRENT_WORKING_DIR}") ``` 在Windows平台上，可以将`pwd`替换为`cd`以实现相同功能。

4. 结合`FILE(GET_RUNTIME_DEPENDENCIES)`

虽然`FILE(GET_RUNTIME_DEPENDENCIES)`主要用于解决运行时依赖问题，但它也可以间接帮助我们理解路径的动态变化。例如，在某些复杂项目中，可以通过此命令分析依赖项的路径，从而推导出当前工作目录的相对位置。

    FILE(GET_RUNTIME_DEPENDENCIES
        RESOLVED_DEPENDENCIES_VAR resolved_deps
        UNRESOLVED_DEPENDENCIES_VAR unresolved_deps
        LIBRARIES "${target}"
        DIRECTORIES "${CMAKE_CURRENT_BINARY_DIR}"
    )
    

上述代码片段展示了如何通过指定构建目录来解析依赖项路径。

5. 最佳实践总结

综合以上方法，推荐的最佳实践如下：

1. 优先使用`execute_process`命令获取运行时工作目录。
2. 结合`CMAKE_CURRENT_SOURCE_DIR`和`CMAKE_CURRENT_BINARY_DIR`完成其他路径相关操作。
3. 避免直接假设内置变量能完全满足运行时需求。

下面是一个完整的流程图，展示如何结合不同方法获取路径：

graph TD;
            A[开始] --> B{是否需要运行时路径};
            B -- 是 --> C[使用 execute_process];
            B -- 否 --> D[使用 CMAKE_CURRENT_SOURCE_DIR 或 CMAKE_CURRENT_BINARY_DIR];
            C --> E[完成路径获取];
            D --> E;