CMake 脚本的命名约定是什么?

Sam*_*tep 3 convention filenames conventions naming-conventions cmake

我知道 CMake 使用标准名称“CMakeLists.txt”和add_subdirectory在构建过程中直接调用脚本的函数。

我有一些 CMake 代码,可用于将文件转换为 C++ 字符串,然后可以使用#include指令将其烘焙到程序中。我的根 CMakeLists 文件中的相关代码如下所示(当然大大简化了):

add_custom_command(
  OUTPUT ${CMAKE_BINARY_DIR}/path/to/example.json.txt
  COMMAND ${CMAKE_COMMAND} ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR} ${STRING_PATH} -P BuildString.cmake
  DEPENDS ${CMAKE_SOURCE_DIR}/path/to/example.json
  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
)
add_custom_target(strings DEPENDS ${CMAKE_BINARY_DIR}/path/to/example.json.txt)
Run Code Online (Sandbox Code Playgroud)

(在实际代码中,我调用add_custom_command每个需要转换为字符串的文件,然后将所有输出文件名作为列表传递给add_custom_target.)

这是 BuildString.cmake:

set(DELIMITER "")

set(SOURCE ${CMAKE_ARGV1})
set(BUILD ${CMAKE_ARGV2})
set(PATH ${CMAKE_ARGV3})

file(READ ${SOURCE}/${PATH} STRING)
# add semicolons back into string
string(REGEX REPLACE ";" "\\\\;" STRING "${STRING}")
file(WRITE ${BUILD}/${PATH}.txt R\"${DELIMITER}\(${STRING}\)${DELIMITER}\")
Run Code Online (Sandbox Code Playgroud)

如您所见,BuildString.cmake 只需要一个输入文件并将该文件的内容(使用 C++ 原始字符串文字表示法${DELIMITER}作为分隔符包装)输出到构建目录中。

我应该怎么称呼 BuildString.cmake?使用所有带下划线的小写字母 (build_string.cmake) 还是小写字母 (buildString.cmake) 的约定?或者名称应该是名词而不是动词(StringBuilder.cmake)?

(作为旁注,如果您能看到一种无关的方式,我可以改进此代码中的任何一个,那也将不胜感激。)

tam*_*nez 5

CMake 模块有一个约定:snake-casefunction_or_macro()在 CamelCaseFunctionOrMacro.cmake文件中实现。因此,如有疑问,请使用 CamelCase。

并使用动词,名词用于类。

  • @RedRoboHood:CMake 附带的所有 cmake 和 shell 脚本都遵循此约定(不仅是宏或函数)。但是因为对于脚本,我认为它不像函数/宏定义那样强大,所以我想说,如果你需要一个约定,请使用这个,因为没有其他约定。但是您可以随意命名您的脚本。这就是为什么我说“有疑问时”的原因。 (2认同)