我可以在我的 cmake 代码中手动使用 CMake 的 cpp 文件依赖扫描器吗?
Can I manually use CMake's cpp file dependency-scanner in my cmake code?
我正在尝试使用 CMake 添加一个自定义目标,它为每个给定的 .cpp 文件执行一个命令。仅当源文件本身或包含的源文件之一发生更改时,才应重新执行该命令。据我所知,为了实现这一点,我需要一个所有包含文件的列表,并将它们添加到属于我的自定义目标的 add_custom_command()
调用的 DEPENDS
选项中。
那么有没有内置的方法来获取包含文件的列表?
我知道 add_custom_command()
函数的 IMPLICIT_DEPENDS
选项,但它只适用于 Makefile 生成器。我想让它适用于所有生成器。
感谢您的宝贵时间
编辑:
根据要求,我将 post 一些 cmake 代码来展示我想要实现的目标。
我想添加一个自定义目标,在所有给定的 .cpp 文件上 运行s clang-tidy。当增量构建自定义目标时,只要 .cpp 文件或其直接或间接包含的头文件之一发生更改,clang-tidy 命令就应该重新 运行。就像编译器的re-运行s一样处理。
# ----------------------------------------------------------------------------------------
# mainTargetName The name of the target that shall be analyzed
# files A list of all the main targets .cpp files
#
function( addStaticAnalysisTarget mainTargetName files )
set(targetName runStaticAnalysis_${mainTargetName})
set(command "clang-tidy-4.0 -checks=* -p ${CMAKE_BINARY_DIR}")
foreach( file ${files} )
get_filename_component( baseName ${file} NAME_WE)
set(stampFile ${CMAKE_CURRENT_BINARY_DIR}/analyze_${baseName}.stamp )
set(fullFile ${CMAKE_CURRENT_SOURCE_DIR}/${file})
set(commandWithFile "${command} ${fullFile}")
separate_arguments_for_platform( commandList ${commandWithFile})
add_custom_command(
OUTPUT ${stampFile}
DEPENDS "${fullFile}"
IMPLICIT_DEPENDS CXX "${fullFile}"
COMMAND ${commandList}
COMMAND cmake -E touch "${stampFile}" # without creating a file as a touch-stone the command will always be re-run.
WORKING_DIRECTORY ${CPPCODEBASE_ROOT_DIR}
COMMENT "${commandWithFile}"
VERBATIM
)
list(APPEND stampFiles ${stampFile})
endforeach()
set_source_files_properties(${stampFiles} PROPERTIES GENERATED TRUE) # make the stamp files known to cmake as generated files.
add_custom_target(
${targetName}
DEPENDS ${stampFiles}
)
endfunction()
问题在于它似乎不起作用。当我更改包含的文件时,clang-tidy 不会重新 运行 受影响的文件。
我在此示例中使用了 "Unix Makefile" 生成器,因此它至少应该可以与 make 一起使用。有什么提示为什么没有吗?
我希望通过在 cmake 时以某种方式获取文件依赖项,然后将它们添加到 ''''DEPENDS'''' 列表中,我可以为所有生成器实现所需的行为。但是每次命令运行都要进行依赖扫描,所以不能在cmake的时候进行。这意味着扫描必须由 cmake 实现,而目前不是。
一个有类似问题的人:
https://gitlab.kitware.com/cmake/cmake/issues/16830
编辑 2:
我认为 IMPLICIT_DEPENDS 选项不起作用的问题是因为我没有使用正确的文件名。我在截取的代码中更改了它,但我还没有测试它是否适用于项目。
我想我的问题的答案是...
不,你不能在cmake代码中使用cmakes依赖扫描器。
说得有道理,因为这个问题在cmake的时候是解决不了的,因为一个.cpp文件的依赖关系可能会在不cmake重新运行的情况下改变。
该问题必须在 make 时在 cmake 本身内解决。这是在使用 IMPLICIT_DEPENDS
选项时完成的。
此外,我试图解决一个我并没有真正遇到的问题,因为此时我只能在 linux 上 运行 clang-tidy。但是,clang-tidy 也可能在 windows 上可用,然后我可能会再次遇到问题。
总结评论:
Tambre 表示 CMake 不是编译器,因此不能这样做。
我认为这是错误的。根据这个 article,CMake 可以解析 cpp include 依赖项,因为 make 本身没有这样的依赖项搜索器。这对我来说是个新闻,但我主要靠 Windows 生活,所以我对 make 不是很熟悉。也有可能在此期间 make 被扩展以进行自己的依赖项搜索。这也解释了为什么 IMPLICIT_DEPENDS
选项仅适用于 make。
Florian 指出没有必要为 运行ning clang-tidy 创建自己的自定义目标。相反,可以在编译每个文件后使用 CXX_CLANG_TIDY
目标 属性 到 运行 clang-tidy。然而,这意味着静态分析不能与构建分开,这可能导致不可接受的构建时间。
有 cmake -E cmake_depends
命令行,可用于在 cmake 时检索依赖项。但是如上所述,我错误地认为我在 cmake 时需要依赖项,而我在 运行 时需要它们。
IMPLICIT_DEPENDS
选项不起作用,因为我的 cmake 代码有错误。
我正在尝试使用 CMake 添加一个自定义目标,它为每个给定的 .cpp 文件执行一个命令。仅当源文件本身或包含的源文件之一发生更改时,才应重新执行该命令。据我所知,为了实现这一点,我需要一个所有包含文件的列表,并将它们添加到属于我的自定义目标的 add_custom_command()
调用的 DEPENDS
选项中。
那么有没有内置的方法来获取包含文件的列表?
我知道 add_custom_command()
函数的 IMPLICIT_DEPENDS
选项,但它只适用于 Makefile 生成器。我想让它适用于所有生成器。
感谢您的宝贵时间
编辑:
根据要求,我将 post 一些 cmake 代码来展示我想要实现的目标。 我想添加一个自定义目标,在所有给定的 .cpp 文件上 运行s clang-tidy。当增量构建自定义目标时,只要 .cpp 文件或其直接或间接包含的头文件之一发生更改,clang-tidy 命令就应该重新 运行。就像编译器的re-运行s一样处理。
# ----------------------------------------------------------------------------------------
# mainTargetName The name of the target that shall be analyzed
# files A list of all the main targets .cpp files
#
function( addStaticAnalysisTarget mainTargetName files )
set(targetName runStaticAnalysis_${mainTargetName})
set(command "clang-tidy-4.0 -checks=* -p ${CMAKE_BINARY_DIR}")
foreach( file ${files} )
get_filename_component( baseName ${file} NAME_WE)
set(stampFile ${CMAKE_CURRENT_BINARY_DIR}/analyze_${baseName}.stamp )
set(fullFile ${CMAKE_CURRENT_SOURCE_DIR}/${file})
set(commandWithFile "${command} ${fullFile}")
separate_arguments_for_platform( commandList ${commandWithFile})
add_custom_command(
OUTPUT ${stampFile}
DEPENDS "${fullFile}"
IMPLICIT_DEPENDS CXX "${fullFile}"
COMMAND ${commandList}
COMMAND cmake -E touch "${stampFile}" # without creating a file as a touch-stone the command will always be re-run.
WORKING_DIRECTORY ${CPPCODEBASE_ROOT_DIR}
COMMENT "${commandWithFile}"
VERBATIM
)
list(APPEND stampFiles ${stampFile})
endforeach()
set_source_files_properties(${stampFiles} PROPERTIES GENERATED TRUE) # make the stamp files known to cmake as generated files.
add_custom_target(
${targetName}
DEPENDS ${stampFiles}
)
endfunction()
问题在于它似乎不起作用。当我更改包含的文件时,clang-tidy 不会重新 运行 受影响的文件。 我在此示例中使用了 "Unix Makefile" 生成器,因此它至少应该可以与 make 一起使用。有什么提示为什么没有吗?
我希望通过在 cmake 时以某种方式获取文件依赖项,然后将它们添加到 ''''DEPENDS'''' 列表中,我可以为所有生成器实现所需的行为。但是每次命令运行都要进行依赖扫描,所以不能在cmake的时候进行。这意味着扫描必须由 cmake 实现,而目前不是。
一个有类似问题的人: https://gitlab.kitware.com/cmake/cmake/issues/16830
编辑 2: 我认为 IMPLICIT_DEPENDS 选项不起作用的问题是因为我没有使用正确的文件名。我在截取的代码中更改了它,但我还没有测试它是否适用于项目。
我想我的问题的答案是...
不,你不能在cmake代码中使用cmakes依赖扫描器。
说得有道理,因为这个问题在cmake的时候是解决不了的,因为一个.cpp文件的依赖关系可能会在不cmake重新运行的情况下改变。
该问题必须在 make 时在 cmake 本身内解决。这是在使用 IMPLICIT_DEPENDS
选项时完成的。
此外,我试图解决一个我并没有真正遇到的问题,因为此时我只能在 linux 上 运行 clang-tidy。但是,clang-tidy 也可能在 windows 上可用,然后我可能会再次遇到问题。
总结评论:
Tambre 表示 CMake 不是编译器,因此不能这样做。 我认为这是错误的。根据这个 article,CMake 可以解析 cpp include 依赖项,因为 make 本身没有这样的依赖项搜索器。这对我来说是个新闻,但我主要靠 Windows 生活,所以我对 make 不是很熟悉。也有可能在此期间 make 被扩展以进行自己的依赖项搜索。这也解释了为什么
IMPLICIT_DEPENDS
选项仅适用于 make。Florian 指出没有必要为 运行ning clang-tidy 创建自己的自定义目标。相反,可以在编译每个文件后使用
CXX_CLANG_TIDY
目标 属性 到 运行 clang-tidy。然而,这意味着静态分析不能与构建分开,这可能导致不可接受的构建时间。有
cmake -E cmake_depends
命令行,可用于在 cmake 时检索依赖项。但是如上所述,我错误地认为我在 cmake 时需要依赖项,而我在 运行 时需要它们。IMPLICIT_DEPENDS
选项不起作用,因为我的 cmake 代码有错误。