调试CMake：如何查找变量的定义与赋值位置？

针对你遇到的动态拼接变量（如set("${scope}_${variable_name}" value)）难以追踪赋值位置的问题，给你几个实用的解决方法：

• 正确使用variable_watch捕获赋值操作
  默认的variable_watch只输出读操作，你需要自定义回调函数来监听赋值（SET_ACCESS）和修改（MODIFIED_ACCESS）事件。比如：

  function(track_var_assignment var access value current_file stack)
      if(access STREQUAL "SET_ACCESS" OR access STREQUAL "MODIFIED_ACCESS")
          message(WARNING "变量 ${var} 被${access}：")
          message(WARNING "位置：${current_file}:${CMAKE_CURRENT_LIST_LINE}")
          message(WARNING "调用栈：${stack}")
          message(WARNING "赋值内容：${value}")
      endif()
  endfunction()
  
  # 替换成你要追踪的目标变量名，如果是动态拼接的，先通过缓存确认实际名称
  variable_watch("MY_TARGET_VAR" track_var_assignment)
  

  将这段代码放在CMake项目的最开头（比如根目录的CMakeLists.txt第一行），就能捕获该变量的所有赋值操作。

• 用--trace-expand追踪所有CMake指令
  直接在运行CMake时添加--trace-expand参数，它会展开所有变量并输出每一行执行的指令，包括set操作。结合grep过滤目标变量：

  cmake .. --trace-expand | grep "set(YOUR_TARGET_VAR_NAME"
  

  输出结果会显示该变量赋值所在的文件、行号以及完整的指令内容，即使变量是动态拼接生成的，--trace-expand也会显示最终展开后的变量名。

• 拦截set命令实现全局变量监控
  如果不知道具体变量名，只知道命名模式（比如以特定scope开头），可以通过自定义set函数拦截所有赋值操作：

  1. 创建一个debug_set.cmake文件，内容如下：

     # 保存原始set命令
     rename_command(set _set)
     
     function(set)
         set(var_name ${ARGV0})
         # 替换成你的变量命名匹配规则，比如以"MY_SCOPE_"开头
         if(var_name MATCHES "^MY_SCOPE_")
             message(WARNING "匹配到目标变量赋值：")
             message(WARNING "变量名：${var_name}")
             message(WARNING "位置：${CMAKE_CURRENT_LIST_FILE}:${CMAKE_CURRENT_LIST_LINE}")
             message(WARNING "赋值内容：${ARGV1}")
         endif()
         # 执行原始set命令
         _set(${ARGV})
     endfunction()
     

  2. 运行CMake时注入这个文件：

     cmake .. -DCMAKE_PROJECT_INCLUDE=debug_set.cmake
     

  这样所有符合命名规则的变量赋值都会被输出位置和内容，不用修改原项目代码。

• 先从缓存获取变量实际名称
  如果你连变量的最终名称都不确定，可以查看CMake生成的CMakeCache.txt文件，里面存储了所有缓存变量的最终值和名称，找到目标变量后再用上面的方法精准追踪。

内容的提问来源于stack exchange，提问作者Kapitan