CMakeLists.txt文件编写详解
一、CMakeLists.txt基础知识
CMakeLists.txt 是 CMake 构建系统用于定义项目的配置文件。CMake 是一个跨平台的自动化构建系统，它使用一个名为 CMakeLists.txt 的文件来指定如何构建项目。这个文件可以包含各种命令，用于指定项目名称、源文件、编译选项、库依赖等。下面是一个详细的指南，介绍如何使用 CMakeLists.txt 文件。
1.1 基本结构
一个基本的 CMakeLists.txt 文件可能如下所示：
cmake_minimum_required(VERSION 3.10)
# 设置项目名称和版本
project(MyProject VERSION 1.0)
# 添加一个可执行文件
add_executable(MyExecutable main.cpp)
1.2 主要命令
1.2.1 cmake_minimum_required
- 用来指定CMake的最小版本要求。
- 语法：
cmake_minimum_required(VERSION major.minor[.patch[.tweak[.id]]])
1.2.2 project
- 定义项目的名称和可选的版本号。
- 语法：
project(ProjectName [VERSION major.minor[.patch[.tweak[.id]]]] [DESCRIPTION summary])
1.2.3 add_executable
- 添加一个可执行文件到项目中。
- 语法：
add_executable(<name> [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL] source1 source2 ... sourceN)
1.2.4 add_library
- 添加一个库到项目中。
- 语法：
add_library(<name> [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL] source1 source2 ... sourceN)
1.2.5 include_directories
- 向编译过程添加包含目录。
- 语法：
include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)
1.2.6 target_include_directories
- 为目标（如可执行文件或库）添加包含目录。
- 语法：
target_include_directories(<target> [SYSTEM] [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...] [...])
1.2.7 find_package
- 查找并加载外部项目。
- 语法：
find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE] [REQUIRED] [COMPONENTS [components...]] [OPTIONAL_COMPONENTS [components...]] [CONFIG|NO_MODULE|NO_CONFIG|NO_POLICY_SCOPE] [NAMES name1 [...]])
1.2.8 target_link_libraries
- 为目标（如可执行文件或库）添加需要链接的库。
- 语法：
target_link_libraries(<target> ... <PRIVATE|PUBLIC|INTERFACE> <item>... [...])
假设你有一个项目，它包含两个源文件 main.cpp 和 MyClass.cpp，以及对应的头文件 MyClass.h。你想编译这两个源文件为一个可执行文件，并且链接到一个名为 MyLibrary 的外部库。
cmake_minimum_required(VERSION 3.10)
project(MyProject)
# 设置包含目录
include_directories(${CMAKE_SOURCE_DIR}/include)
# 添加一个可执行文件
add_executable(MyExecutable main.cpp MyClass.cpp)
# 查找并链接外部库
find_package(MyLibrary REQUIRED)
target_link_libraries(MyExecutable MyLibrary::MyLibrary)
# 如果MyLibrary是一个CMake库，可能需要使用下面的语法
# target_link_libraries(MyExecutable PRIVATE MyLibrary)
1.2.7 message，信息打印
我们可以通过message打印变量信息。
有时候我们需要打印一些变量信息用于定位我们的CMakelists.txt中出现的问题，我们可以使用message来打印。
message(${CMAKE_SOURCE_DIR})
二、CMakelists 常用的变量
CMakeLists.txt 文件中使用的变量在 CMake 构建系统中扮演着重要角色，它们用于存储和传递配置信息、路径、选项等。CMake 提供了许多预定义的变量，同时也允许用户定义自己的变量。以下是一些在 CMakeLists.txt 文件中常用的变量：
2.1 CMake 预定义变量
-
CMAKE_BINARY_DIR：- 当前处理的二进制目录的绝对路径（即构建目录）。
-
CMAKE_SOURCE_DIR：- 当前处理的源代码目录的绝对路径（即源代码的顶层目录）。
-
CMAKE_CURRENT_SOURCE_DIR：- 当前正在处理的 CMakeLists.txt 文件所在的目录的绝对路径。
-
CMAKE_CURRENT_BINARY_DIR：- 当前正在处理的 CMakeLists.txt 文件对应的二进制目录的绝对路径。这可能与源代码目录不同，尤其是在使用 out-of-source 构建时。
-
CMAKE_INSTALL_PREFIX：- 安装路径的前缀，用于
make install时的安装目标路径。
- 安装路径的前缀，用于
-
CMAKE_CXX_COMPILER、CMAKE_C_COMPILER：- 分别用于指定 C++ 和 C 编译器的完整路径。
-
CMAKE_BUILD_TYPE：- 构建类型（如 Debug、Release、MinSizeRel、RelWithDebInfo），用于设置优化和调试信息级别。
-
CMAKE_CXX_FLAGS、CMAKE_C_FLAGS：- 分别用于设置 C++ 和 C 编译器的标志（flags）。
-
CMAKE_LIBRARY_OUTPUT_DIRECTORY、CMAKE_ARCHIVE_OUTPUT_DIRECTORY、CMAKE_RUNTIME_OUTPUT_DIRECTORY：- 分别用于设置库、归档文件（如静态库）和可执行文件的输出目录。
-
PROJECT_NAME- 项目名称，这个名称由project设置
2.2 CMakeLists.txt 中定义的变量
在 CMakeLists.txt 文件中，你可以使用 set() 命令来定义自己的变量。这些变量可以是任何类型的数据，如字符串、列表或路径。
set(MY_VARIABLE "SomeValue")
set(MY_LIST_VARIABLE my_file1.cpp my_file2.cpp)
2.3 使用变量
在 CMakeLists.txt 文件中，你可以通过 ${} 语法来引用变量。
add_executable(MyExecutable ${MY_LIST_VARIABLE})
2.4 变量作用域
CMake 中的变量有作用域的概念。在 CMakeLists.txt 文件中定义的变量默认具有函数作用域（如果你在函数或宏中定义它们）或目录作用域（如果你在顶层 CMakeLists.txt 或子目录的 CMakeLists.txt 中定义它们）。这意味着在函数或宏内部定义的变量在外部是不可见的，除非你使用 set() 命令的 PARENT_SCOPE 选项来显式地修改父作用域中的变量。
三、cmake安装编写
在 CMakeLists.txt 文件中编写关于安装的部分，主要是使用 install() 命令来指定哪些文件、目标（如可执行文件、库等）以及目录需要被安装到指定的位置。这通常在项目的顶层 CMakeLists.txt 文件中进行配置，但也可以在子目录的 CMakeLists.txt 中配置特定于该子目录的安装指令。
以下是一些常用的 install() 命令示例：
3.1 cmake安装可执行文件
add_executable(my_executable main.cpp)
install(TARGETS my_executable DESTINATION bin)
这条命令将 my_executable 安装到 ${CMAKE_INSTALL_PREFIX}/bin 目录下，其中 ${CMAKE_INSTALL_PREFIX} 是通过 cmake 命令行选项 -DCMAKE_INSTALL_PREFIX=/path/to/prefix 指定的安装前缀，或者在 CMakeLists.txt 文件中通过 set(CMAKE_INSTALL_PREFIX "/path/to/prefix") 设置。
3.2 cmake安装库
对于库，你可能想要安装库文件本身以及任何相关的头文件或模块文件。
add_library(my_library SHARED my_library.cpp)
install(TARGETS my_library LIBRARY DESTINATION lib ARCHIVE DESTINATION lib RUNTIME DESTINATION bin)
install(FILES my_library.h DESTINATION include/my_library)
在这个例子中，my_library 是一个共享库，它被安装到 ${CMAKE_INSTALL_PREFIX}/lib 目录下。对于静态库（ARCHIVE），通常也会安装到同一个目录，但在这里我们显式地指定了库文件的安装目录。头文件 my_library.h 被安装到 ${CMAKE_INSTALL_PREFIX}/include/my_library 目录下。
3.3 cmake安装目录
如果你想要安装一个完整的目录（比如文档、资源等），可以使用 install(DIRECTORY ...) 命令。
install(DIRECTORY doc/ DESTINATION share/doc/my_project)
这条命令将 doc/ 目录及其内容安装到 ${CMAKE_INSTALL_PREFIX}/share/doc/my_project 目录下。注意，默认情况下，install(DIRECTORY ...) 命令会安装目录中的所有内容，但你可以通过 FILES_MATCHING 选项来指定要安装的文件模式。
四、CMake测试
在 CMakeLists.txt 文件中编写关于测试的部分，主要是使用 enable_testing() 命令来启用测试，并通过 add_test() 命令来添加具体的测试用例。CMake 提供了一个基本的测试框架，它允许你定义和执行测试，但并不直接提供断言或测试报告工具，这些通常需要与像 Google Test（GTest）这样的外部测试库结合使用。
以下是一个基本的 CMakeLists.txt 测试部分示例：
4.1 启用测试
首先，你需要在 CMakeLists.txt 文件中调用 enable_testing() 命令来启用测试功能。这通常放在文件的顶部或靠近配置指令（如 project()）的地方。
cmake_minimum_required(VERSION 3.10)
project(MyProject)
# 启用测试
enable_testing()
4.2 添加测试
然后，你可以使用 add_test() 命令来添加测试用例。这个命令可以接收一个名称和一个命令行命令作为参数，当测试被触发时，CMake 会执行这个命令。
4.3 直接运行可执行文件作为测试
# 假设你有一个名为 my_test 的可执行文件
add_executable(my_test test/my_test.cpp)
# 添加测试，运行 my_test 可执行文件
add_test(NAME MyTest COMMAND my_test)
在这个例子中，my_test 是一个可执行文件，它应该能够自行报告测试的成功或失败（例如，通过返回 0 表示成功，非 0 表示失败）。
4.4 使用外部测试框架（如 Google Test）
如果你使用的是像 Google Test 这样的外部测试框架，你的测试命令可能会更复杂一些，因为你需要设置环境变量、指定测试筛选器等。
# 假设你有一个使用 Google Test 编写的测试可执行文件
add_executable(my_tests test/my_tests.cpp)
target_link_libraries(my_tests GTest::GTest GTest::Main)
# 添加测试，使用 Google Test 的命令行界面来运行测试
# 注意：这里假设你的 Google Test 可执行文件能够接收 --gtest_filter 等参数
add_test(NAME MyTests COMMAND my_tests --gtest_filter=SomeTest.SomeCase)
# 或者，如果你想为所有测试用例都运行测试可执行文件
add_test(NAME MyTests COMMAND my_tests)
在这个例子中，my_tests 是一个使用 Google Test 编写的测试可执行文件。我们将其链接到 Google Test 库，并通过 add_test() 命令添加了一个测试，该测试将运行 my_tests 并可能通过 --gtest_filter 参数来指定要运行的特定测试用例。
4.5 运行测试
在 CMake 中配置并生成项目后，你可以使用 ctest 命令来运行测试。ctest 是 CMake 提供的一个命令行工具，用于运行 CMakeLists.txt 文件中定义的测试。
cmake -S . -B build
cmake --build build
ctest --test-dir build
这些命令将分别在源代码目录（.）中配置项目，在 build 目录中生成项目，并在 build 目录中运行测试。
五、CMake其他
5.1 GLOB_RECURSE引用全局内容
在CMake中，GLOB_RECURSE命令用于在指定目录及其子目录中寻找文件。如果你想要排除某些目录，可以使用LIST_EXCLUDE选项配合正则表达式来实现。
以下是一个简单的例子，展示了如何使用GLOB_RECURSE命令并排除特定的目录：
cmake_minimum_required(VERSION 3.0)
project(ExcludeDirectories)
-
假设我们要寻找所有的源文件，但是要排除名为"exclude_dir"的目录
file(GLOB_RECURSE ALL_SOURCES
RELATIVE “ C M A K E C U R R E N T S O U R C E D I R " " {CMAKE_CURRENT_SOURCE_DIR}" " CMAKECURRENTSOURCEDIR""{CMAKE_CURRENT_SOURCE_DIR}/.cpp"
"${CMAKE_CURRENT_SOURCE_DIR}/.h”
) -
排除名为"exclude_dir"的目录
list(FILTER ALL_SOURCES EXCLUDE REGEX “exclude_dir/”)
message(STATUS “All Sources: ${ALL_SOURCES}”)
在这个例子中，我们使用file(GLOB_RECURSE)命令寻找当前源代码目录下的所有.cpp和.h文件。然后，我们使用list(FILTER)命令配合EXCLUDE和REGEX选项来排除名为exclude_dir的目录。这样，在ALL_SOURCES变量中就不会包含该目录下的任何文件。
5.2 CMAKE调试
通过以下命令可以调试cmake的过程，看到更多的错误信息。
cmake --trace ..
5.3 execute_process
在CMakeLists.txt文件中，execute_process命令是一个非常有用的命令，它允许CMake在配置阶段执行一个或多个外部命令或程序，并捕获其输出和返回状态。以下是execute_process命令在CMakeLists.txt中的基本使用方法和一些常见选项的说明：
- 基本用法
execute_process(
COMMAND <cmd1> [<arg1> ...]
[COMMAND <cmd2> [<arg2> ...] [...]]
[WORKING_DIRECTORY <directory>]
[TIMEOUT <seconds>]
[RESULT_VARIABLE <variable>]
[OUTPUT_VARIABLE <variable>]
[ERROR_VARIABLE <variable>]
[... 其他选项 ...]
)
- 常用选项解释
COMMAND：要执行的命令及其参数。可以指定多个命令，它们会按照顺序执行，且上一个命令的输出可以作为下一个命令的输入（类似于管道）。WORKING_DIRECTORY：设置命令执行的工作目录。TIMEOUT：设置命令执行的超时时间（以秒为单位），如果命令在指定时间内未完成，则会被终止。RESULT_VARIABLE：存储命令执行后的返回状态（或错误代码）。OUTPUT_VARIABLE：存储命令的标准输出内容。ERROR_VARIABLE：存储命令的标准错误输出内容。INPUT_FILE指定标准输入重定向的文件名OUTPUT_FILE指定标准输出重定向的文件名ERROR_FILE指定标准错误输出重定向的文件名- 设置
OUTPUT_QUIET和ERROR_QUIET后，CMake将静默地忽略标准输出和标准错误。 - 设置
OUTPUT_STRIP_TRAILING_WHITESPACE，可以删除运行命令的标准输出中的任何尾随空格 设置ERROR_STRIP_TRAILING_WHITESPACE，可以删除运行命令的错误输出中的任何尾随空格
- 示例1：执行单个命令
execute_process(
COMMAND uname -a
OUTPUT_VARIABLE uname_output
)
message(STATUS "uname -a output: ${uname_output}")
这个示例执行了uname -a命令，并将输出存储在变量uname_output中。
- 示例2：执行多个命令
execute_process(
COMMAND ls -l
COMMAND grep "CMakeLists.txt"
COMMAND awk '{print $9}'
OUTPUT_VARIABLE file_name
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
)
message(STATUS "Found CMakeLists.txt file: ${file_name}")
这个示例演示了如何执行多个命令，其中ls -l命令的输出被传递给grep命令，grep的输出又被传递给awk命令。最终，awk命令的输出（即文件名）被存储在file_name变量中。
5.4 获取版本号
find_package(Git)
if(GIT_FOUND)
execute_process(
COMMAND ${GIT_EXECUTABLE} describe --abbrev=0 --always
OUTPUT_VARIABLE GIT_CURRENT_TAGS
ERROR_VARIABLE ERROR_TEXT
RESULT_VARIABLE RESULT_CODE
OUTPUT_STRIP_TRAILINK_WHITESPACE
)
message(STATUS "Found CMakeLists.txt file: ${file_name}")
5.5 利用-D设置变量
例如:设置CMAKE_BUILD_TYPE
cmake -DCMAKE_BUILD_TYPE=Release …
六、其他问题
6.1 CMake Error: Error required internal CMake variable not set, cmake may be not be built correctly.
Missing variable is:
CMAKE_VERSION_COMPILER_ENV_VAR
CMake Error: Error required internal CMake variable not set, cmake may be not be built correctly.
Missing variable is:
CMAKE_VERSION_COMPILER_ENV_VAR
CMake Error: Error required internal CMake variable not set, cmake may be not be built correctly.
Missing variable is:
CMAKE_VERSION_COMPILER
CMake Error: Could not find cmake module file: /home/arv000/Desktop/arp_scan/build/CMakeFiles/2.8.12.2/CMakeVERSIONCompiler.cmake
CMake Error: Error required internal CMake variable not set, cmake may be not be built correctly.
Missing variable is:
CMAKE_1.0_COMPILER_ENV_VAR
CMake Error: Error required internal CMake variable not set, cmake may be not be built correctly.
Missing variable is:
CMAKE_1.0_COMPILER
CMake Error: Could not find cmake module file: /home/arv000/Desktop/arp_scan/build/CMakeFiles/2.8.12.2/CMake1.0Compiler.cmake
CMake Error: Could not find cmake module file: CMakeVERSIONInformation.cmake
CMake Error: Could not find cmake module file: CMake1.0Information.cmake
CMake Error: CMAKE_VERSION_COMPILER not set, after EnableLanguage
CMake Error: CMAKE_1.0_COMPILER not set, after EnableLanguage
-- Configuring incomplete, errors occurred!
See also "/home/arv000/Desktop/arp_scan/build/CMakeFiles/CMakeOutput.log".
- 解决方案
这些错误表明 CMake 在配置项目时遇到了一些问题，特别是与 CMake 版本和编译器设置相关的问题。这通常是由于以下原因之一引起的：
-
CMake 版本太旧：CentOS 7 自带的 CMake 版本可能非常旧（例如，2.8.12.2），而许多现代项目需要更高版本的 CMake。
-
编译器未正确设置：CMake 无法找到合适的编译器，可能是因为环境变量未正确设置或者缺少必要的编译器。
解决步骤
-
更新 CMake 版本：
由于 CentOS 7 自带的 CMake 版本太旧，建议你安装一个较新的 CMake 版本。可以通过 EPEL 仓库或者从源代码编译来更新 CMake。
使用 EPEL 仓库安装较新的 CMake：
sudo yum install epel-release -y sudo yum install cmake3 -y安装完成后，你可以使用
cmake3命令代替cmake，例如：cmake3 . -
从源代码编译安装 CMake：
如果需要更高版本的 CMake，可以从官方源代码编译：
wget https://cmake.org/files/v3.24/cmake-3.24.1.tar.gz tar -zxvf cmake-3.24.1.tar.gz cd cmake-3.24.1 ./bootstrap make sudo make install这会将 CMake 安装到
/usr/local/bin目录下，确保你的PATH环境变量包含/usr/local/bin。 -
检查和设置编译器：
如果错误与编译器相关，你可能需要确保已经安装了一个合适的编译器（如 GCC）。
安装 GCC：
sudo yum install gcc gcc-c++ -y设置编译器环境变量：
在运行 CMake 之前，可以手动设置编译器：
export CC=/usr/bin/gcc export CXX=/usr/bin/g++然后重新运行 CMake：
cmake . -
清理之前的构建缓存：
在尝试重新配置项目之前，最好清除以前的构建文件：
rm -rf build/* cd build cmake ..
通过这些步骤，你应该能够解决这些与 CMake 和编译器设置相关的问题。如果仍然遇到问题，请查看 /home/arv000/Desktop/arp_scan/build/CMakeFiles/CMakeOutput.log 文件，获取更多详细信息，以进一步诊断问题。
6.2 VERSION not allowed unless CMP0048 is set to NEW
CMake Error at CMakeLists.txt:3 (project):
VERSION not allowed unless CMP0048 is set to NEW
-- Configuring incomplete, errors occurred!
minimum_required(VERSION 2.8) —> minimum_required(VERSION 3.10)
扫一扫
471
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
