简介
- cmake 常用函数
cmake get_target_property() 详解
get_target_property() 是 CMake 中用于获取目标（target）属性的命令。它可以从指定的目标中检索特定的属性值，并将其存储在变量中。其常见语法如下：
1
get_target_property(<variable> <target> <property>)
参数说明
-
<variable>：这是存储属性值的变量名。如果属性存在，其值将存储在此变量中。如果属性不存在，变量将设置为特殊值NOTFOUND。 -
<target>：这是你希望查询属性的目标（通常是通过add_executable()、add_library()或add_custom_target()创建的目标）。 -
<property>：这是要查询的属性名称。CMake 中有许多内置的属性，比如INTERFACE_INCLUDE_DIRECTORIES、LOCATION、LINK_LIBRARIES等。
使用示例
假设有以下 CMake 配置：
1
2
add_executable(my_executable main.cpp)
set_target_properties(my_executable PROPERTIES VERSION 1.0 SOVERSION 1)
你可以使用 get_target_property() 获取属性值：
1
2
get_target_property(version my_executable VERSION)
message("my_executable version is: ${version}")
输出可能为：
1
my_executable version is: 1.0
常见属性
LOCATION：目标生成的二进制文件路径。INTERFACE_INCLUDE_DIRECTORIES：指定此目标暴露给依赖它的目标的包含目录列表。LINK_LIBRARIES：链接到该目标的库列表。COMPILE_DEFINITIONS：目标的编译定义列表。
注意事项
- 如果指定的属性不存在，结果变量会被设置为
NOTFOUND，这在处理未定义属性时要特别注意。 - 使用
get_target_property()时，目标必须已经定义，否则会报错。
进阶用法
可以结合 get_target_property() 和条件判断来实现动态配置，例如：
1
2
3
4
get_target_property(is_shared my_library TYPE)
if(is_shared STREQUAL "SHARED_LIBRARY")
message("my_library is a shared library")
endif()
这种用法对于复杂的 CMake 构建系统非常有用，能够动态获取目标的属性并做进一步操作。
cmake add_custom_command()
add_custom_command() 是 CMake 中的一个常用函数，用于为目标（target）添加自定义命令。这个函数可以配置在构建过程中生成文件、执行脚本、生成资源等操作。add_custom_command() 有两种主要的使用方式：一种是作为生成文件的一部分（OUTPUT），另一种是作为构建目标的依赖项（TARGET）。
1. 基本语法
1
2
3
4
5
6
7
8
9
10
11
add_custom_command(
OUTPUT output1 [output2 ...]
COMMAND command1 [ARGS [arg1 [arg2 ...]]] [command2 ...]
[MAIN_DEPENDENCY depend]
[DEPENDS [depend1 [depend2 ...]]]
[BYPRODUCTS [files ...]]
[IMPLICIT_DEPENDS <lang1> depend1 [<lang2> depend2] ...]
[WORKING_DIRECTORY dir]
[COMMENT comment]
[VERBATIM] [APPEND] [USES_TERMINAL]
)
或者
1
2
3
4
5
6
7
8
9
add_custom_command(
TARGET target
PRE_BUILD | PRE_LINK | POST_BUILD
COMMAND command1 [ARGS [arg1 [arg2 ...]]] [command2 ...]
[BYPRODUCTS [files ...]]
[WORKING_DIRECTORY dir]
[COMMENT comment]
[VERBATIM] [USES_TERMINAL]
)
2. 参数说明
通用参数
-
OUTPUT: 指定自定义命令生成的文件列表。这些文件将被 CMake 认为是构建过程中的产物，因此可以在后续的构建步骤中使用。通常与
DEPENDS配合使用。 -
COMMAND: 这是最重要的部分，指定要运行的命令。可以有多个
COMMAND，它们会按顺序执行。可以使用ARGS指定命令的参数。 -
DEPENDS: 指定该命令依赖的文件或目标。在这些依赖项发生变化时，自定义命令会重新运行。
-
MAIN_DEPENDENCY: 为某些工具链优化时指定主依赖文件，通常与编译相关。
-
BYPRODUCTS: 指定命令生成的副产物文件。特别是在多线程构建中有用，帮助 CMake 正确处理文件的生成顺序。
-
WORKING_DIRECTORY: 指定命令运行的工作目录。
-
COMMENT: 在执行命令时，显示的注释信息。
-
VERBATIM: 确保命令行是精确传递的，防止 CMake 对命令进行不必要的转义。通常建议使用。
-
USES_TERMINAL: 指示该命令需要一个终端运行，适用于需要用户交互的命令。
针对目标的参数
-
TARGET: 指定一个目标（例如可执行文件或库）。
-
PRE_BUILD: 命令在目标构建之前执行。
-
PRE_LINK: 命令在目标链接之前执行。
-
POST_BUILD: 命令在目标构建完成后执行。
3. 常见用法示例
生成文件的自定义命令
1
2
3
4
5
6
add_custom_command(
OUTPUT ${CMAKE_BINARY_DIR}/generated_file.cpp
COMMAND python ${CMAKE_SOURCE_DIR}/generate_script.py ${CMAKE_BINARY_DIR}/generated_file.cpp
DEPENDS ${CMAKE_SOURCE_DIR}/generate_script.py
COMMENT "Generating source file"
)
这个例子展示了如何在构建过程中调用一个 Python 脚本生成源文件，并将其作为后续构建步骤的一部分。
为目标添加构建步骤
1
2
3
4
5
add_custom_command(
TARGET MyExecutable
POST_BUILD
COMMAND ${CMAKE_COMMAND} -E echo "Build finished!"
)
这个命令将在 MyExecutable 构建完成后，打印一条信息。
4. 注意事项
- 如果你使用
OUTPUT参数，必须确保这些输出文件在命令成功执行后生成，否则 CMake 可能会重复运行命令。 - 使用
VERBATIM参数通常是最佳实践，因为它可以确保命令行正确传递，无需担心平台相关的转义问题。 - 在复杂项目中，自定义命令应合理使用依赖关系，确保构建顺序的正确性。
add_custom_command() 在处理自定义构建步骤时非常强大，合理利用可以显著提高项目构建的灵活性。
cmake add_subdirectory() 函数 详解
add_subdirectory() 是 CMake 中的一个函数，用于向 CMake 构建系统添加一个子目录。当你的项目结构比较复杂，需要将代码分割成多个目录时，add_subdirectory() 可以很方便地帮助你组织代码和构建系统。
这个函数的语法是：
1
add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
source_dir：要添加的子目录的路径。binary_dir：可选参数，用于指定存放构建输出的目录。如果省略，则默认为source_dir下的bin目录。EXCLUDE_FROM_ALL：可选参数，如果设置了这个选项，则生成的构建目标将不会被默认构建。
使用 add_subdirectory() 的典型场景是，你的项目主目录下有多个子目录，每个子目录都包含了一个独立的 CMakeLists.txt 文件来描述这个子目录的构建过程。例如，一个简单的项目结构可能是这样的：
1
2
3
4
5
6
7
8
9
10
project_root/
CMakeLists.txt
src/
CMakeLists.txt
file1.cpp
file2.cpp
test/
CMakeLists.txt
test1.cpp
test2.cpp
project_root/CMakeLists.txt 中可以通过 add_subdirectory() 来引入 src/ 和 test/ 目录的构建规则：
1
2
3
4
5
cmake_minimum_required(VERSION 3.10)
project(MyProject)
add_subdirectory(src)
add_subdirectory(test)
然后在 src/CMakeLists.txt 和 test/CMakeLists.txt 中分别描述 src/ 和 test/ 目录下的构建规则。
通过这种方式，可以将项目的各个部分分开管理，每个部分有独立的构建规则，便于项目的组织和维护。
cmake target_link_directories() 函数 详解
在 CMake 中，target_link_directories() 函数用于为一个目标（target）指定要搜索链接库的目录。这允许你为特定目标指定链接库的搜索路径，而不是全局设置。
函数原型：
1
2
3
4
target_link_directories(target
[BEFORE]
directory1 [directory2 ...]
)
-
target：要指定链接库搜索路径的目标名称。 -
directory1 [directory2 ...]：一个或多个链接库搜索路径。 -
BEFORE：可选参数，用于指定搜索路径的添加位置。如果使用BEFORE，则新的搜索路径将插入到当前搜索路径列表的最前面；否则，它们将添加到列表的末尾。
使用示例：
1
2
3
4
5
6
7
8
9
10
11
cmake_minimum_required(VERSION 3.10)
project(MyProject)
# 添加可执行文件
add_executable(my_executable main.cpp)
# 指定链接库搜索路径
target_link_directories(my_executable PRIVATE
/path/to/library/directory
/another/path/to/library
)
在这个示例中，target_link_directories() 函数为目标 my_executable 指定了两个链接库搜索路径。这意味着在构建 my_executable 时，CMake 将会在这两个目录中查找链接库。
需要注意的是，推荐使用 target_link_directories() 函数是因为它允许你为每个目标指定不同的链接库搜索路径。如果你只想全局指定链接库搜索路径，可以使用 link_directories() 函数。
1
2
3
4
5
# 全局指定链接库搜索路径
link_directories(
/path/to/library/directory
/another/path/to/library
)
虽然 link_directories() 也可以用于指定链接库搜索路径，但在现代 CMake 中，更推荐使用 target_link_directories() 以提供更好的目标特定性。
cmake message()函数 详解
在CMake中，message() 函数用于在构建过程中输出消息。这对于调试CMake脚本或者提供一些提示信息非常有用。message()函数的基本语法如下：
1
message([<mode>] "message string" ...)
其中：
<mode>是可选的，用于指定消息的模式，包括STATUS、WARNING、AUTHOR_WARNING、SEND_ERROR和FATAL_ERROR等。如果省略<mode>，则默认是STATUS模式。"message string"是要输出的消息字符串。
以下是一些使用message()函数的示例：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 输出一般消息
message("This is a general message")
# 输出带有 STATUS 模式的消息
message(STATUS "This is a status message")
# 输出带有 WARNING 模式的消息
message(WARNING "This is a warning message")
# 输出带有 AUTHOR_WARNING 模式的消息
message(AUTHOR_WARNING "This is an author warning message")
# 输出带有 SEND_ERROR 模式的消息
message(SEND_ERROR "This is a send error message")
# 输出带有 FATAL_ERROR 模式的消息
message(FATAL_ERROR "This is a fatal error message")
在输出消息时，message()函数会根据指定的模式在终端上显示不同的颜色和标识。例如，STATUS模式通常是蓝色的，而WARNING模式是黄色的。SEND_ERROR和FATAL_ERROR模式将导致构建过程中的错误，FATAL_ERROR还会停止构建过程。
message()函数对于在构建过程中提供有用的信息以及与开发者和用户进行交互非常有用。
cmake target_link_include() 详解
在CMake中，target_link_libraries() 和 target_include_directories() 是两个常用的命令，它们用于配置构建目标（通常是可执行文件或库）的依赖关系和包含目录。以下是对这两个命令的详解：
1. target_link_libraries()
target_link_libraries() 命令用于指定一个目标（可执行文件、库等）所依赖的库。它的基本语法如下：
1
2
3
4
5
target_link_libraries(target-name
library1
library2
...
libraryN)
target-name是你要链接的目标的名称。library1,library2, …,libraryN是要链接到目标的库的名称。
示例：
1
2
3
4
5
add_executable(my_app main.cpp)
target_link_libraries(my_app
my_lib1
my_lib2
)
在上面的例子中，my_app 可执行文件依赖于 my_lib1 和 my_lib2 库。
2. target_include_directories()
target_include_directories() 命令用于为目标指定包含目录。它的基本语法如下：
1
2
3
4
5
6
target_include_directories(target-name
PRIVATE|PUBLIC|INTERFACE
directory1
directory2
...
directoryN)
target-name是你要配置的目标的名称。PRIVATE,PUBLIC, 或INTERFACE用于指定目录的使用范围。directory1,directory2, …,directoryN是要包含的目录路径。
示例：
1
2
3
4
5
add_library(my_lib my_source.cpp)
target_include_directories(my_lib
PUBLIC
${CMAKE_CURRENT_SOURCE_DIR}/include
)
在上面的例子中，my_lib 库将公开包含目录 ${CMAKE_CURRENT_SOURCE_DIR}/include，这意味着在使用该库的目标中，这个目录将被添加到编译器的包含路径中。
总体而言，target_link_libraries() 用于指定目标依赖的库，而 target_include_directories() 用于指定目标的包含目录。这两个命令允许你在 CMake 中有效地管理项目的依赖关系和包含路径。
cmake find_package() 函数 详解
find_package() 函数是 CMake 中用于查找和引入外部软件包（例如库）的关键函数。它被用于在 CMake 项目中引入依赖项，让 CMake 知道如何定位并使用外部库或工具。
该函数的一般形式如下：
1
find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE] [REQUIRED] [[COMPONENTS] [components...]] [OPTIONAL_COMPONENTS components...])
其中：
<PackageName>：指定要查找的软件包的名称，可以是已知的软件包，也可以是自定义的软件包。[version]：可选，用于指定软件包的版本号要求。[EXACT]：可选，如果指定了版本号要求，使用 EXACT 表示需要精确匹配指定版本。[QUIET]：可选，不显示查找过程中的详细信息。[MODULE]：可选，明确指定要查找的是 CMake 模块文件。[REQUIRED]：可选，如果软件包未找到，则停止 CMake 过程，报错。[[COMPONENTS] [components...]]：可选，指定软件包的组件（如果软件包有多个组件）。[OPTIONAL_COMPONENTS components...]：可选，指定可选的软件包组件。
下面是一个例子，演示如何使用 find_package() 查找并引入 Boost 库：
1
2
3
4
5
6
7
8
9
10
11
12
13
cmake_minimum_required(VERSION 3.12)
project(MyProject)
# 查找 Boost 库
find_package(Boost 1.65.0 REQUIRED COMPONENTS filesystem system)
# 如果找到 Boost 库，则输出信息
if (Boost_FOUND)
message("Boost found. Include dirs: ${Boost_INCLUDE_DIRS}")
message("Boost libraries: ${Boost_LIBRARIES}")
else()
message(FATAL_ERROR "Boost not found.")
endif()
在这个例子中，find_package(Boost 1.65.0 REQUIRED COMPONENTS filesystem system) 表示查找 Boost 库的版本号至少为 1.65.0，必须包含 filesystem 和 system 两个组件。如果找到了 Boost 库，则输出相应的信息，否则停止 CMake 过程并报错。
总体而言，find_package() 函数使得在 CMake 项目中集成外部依赖项变得更加灵活和方便。
CMakeLists add_definitions() 详解
add_definitions() 是 CMake 中用于添加编译器宏定义的命令。它允许您在整个项目中为源代码文件添加全局宏定义，以实现条件编译或其他编译时配置。以下是有关 add_definitions() 的详解：
语法：
1
add_definitions(-D<DEFINE_1> -D<DEFINE_2> ... -D<DEFINE_N>)
-D<DEFINE>: 指定一个宏定义，-D后跟宏的名称。您可以使用多个-D来指定多个宏定义。
示例：
假设您希望在整个项目中定义一个宏，例如 ENABLE_FEATURE_X，以便在源代码文件中进行条件编译。您可以在项目的 CMakeLists.txt 文件中使用 add_definitions() 来定义宏：
1
add_definitions(-DENABLE_FEATURE_X)
这将使 -DENABLE_FEATURE_X 添加到编译器命令行，以便在编译源文件时启用该宏。您可以在源代码文件中使用 #ifdef 或 #ifndef 指令来检查该宏的存在，然后根据需要执行不同的代码。
1
2
3
4
5
6
7
#ifdef ENABLE_FEATURE_X
// 这部分代码只在 ENABLE_FEATURE_X 定义时编译
// 执行 Feature X 相关的操作
#else
// 这部分代码在 ENABLE_FEATURE_X 未定义时编译
// 执行其他操作
#endif
注意事项：
add_definitions()命令将全局宏定义应用于整个项目，因此请确保不会意外地影响其他目标或源文件。如果需要更精确的控制，可以考虑使用target_compile_definitions()命令来为特定目标添加宏定义。- 如果您需要定义带有值的宏，例如
-DVERSION_NUMBER=42，只需在-D后添加宏的名称和值即可。 - 使用
add_definitions()命令会为所有目标和源文件添加宏定义，这可能会导致不必要的宏定义冲突。因此，在 CMake 3.12 及更高版本中，推荐使用target_compile_definitions()来更精确地控制宏定义的作用范围。
总之，add_definitions() 是用于添加全局宏定义的 CMake 命令，它可以帮助您在整个项目中进行条件编译和其他编译时配置。
cmake CMakeLists.txt include_directories()函数 详解
include_directories()函数是CMake中的一个用于指定头文件包含路径的函数。它用于告诉CMake编译器在哪里查找头文件。在CMakeLists.txt文件中使用include_directories()函数非常有用，因为它允许您配置项目以便正确找到所有所需的头文件。
下面是关于include_directories()函数的详细解释：
1
include_directories(directory1 [directory2 ...])
directory1,directory2, …：这些参数是包含头文件的目录路径。您可以指定一个或多个目录，用于告诉CMake查找头文件的位置。通常，这些目录路径是相对于CMakeLists.txt文件的。
include_directories()函数的作用是将指定的目录路径添加到CMake项目的头文件包含路径中，以使编译器能够找到所需的头文件。当您使用#include指令包含头文件时，编译器将在这些目录中查找头文件。
示例用法：
1
2
3
4
5
6
7
include_directories(include) # 添加一个名为"include"的头文件目录
# 或者指定多个头文件目录
include_directories(
include
common
)
在上面的示例中，include_directories()函数用于指定项目的头文件搜索路径，通常这些路径包括项目中的include目录和common目录。这使得您可以在CMake项目中使用相对路径来包含头文件，而无需手动指定完整的文件路径。
请注意，从CMake 3.15开始，更推荐使用target_include_directories()函数，它允许更好的目标级别控制，以及更容易实现接口库的目录传递。这是一个更现代和更具有可维护性的做法。
1
2
3
4
5
6
target_include_directories(target_name
PUBLIC
include
PRIVATE
private_include
)
上述示例中，target_include_directories()函数将头文件目录添加到名为target_name的目标（可执行文件或库）中，可以使用PUBLIC和PRIVATE修饰符来指定头文件目录的可见性。这提供了更灵活的控制选项。
cmake CMakeLists.txt 内置变量
CMake提供了一些内置变量，用于获取有关项目和构建环境的信息，您可以在CMakeLists.txt文件中使用这些变量来进行配置和生成目标。以下是一些常用的内置变量：
-
CMAKE_SOURCE_DIR：指向CMakeLists.txt文件所在的源代码根目录的路径。 -
CMAKE_BINARY_DIR：指向CMake生成构建文件的根目录的路径。这通常是项目构建的目录，与源代码分开。 -
CMAKE_CURRENT_SOURCE_DIR：指向当前处理的CMakeLists.txt文件所在的目录。 -
CMAKE_CURRENT_BINARY_DIR：指向与当前处理的CMakeLists.txt文件关联的构建目录。 -
CMAKE_PROJECT_NAME：包含当前项目的名称，通常由project()命令指定。 -
CMAKE_VERSION：CMake的版本信息。 -
CMAKE_CXX_COMPILER：指向C++编译器的可执行文件路径。 -
CMAKE_C_COMPILER：指向C编译器的可执行文件路径。 -
CMAKE_SYSTEM：指定操作系统的名称。 -
CMAKE_SYSTEM_NAME：指定操作系统的名称，通常是与CMAKE_SYSTEM相同。 -
CMAKE_SYSTEM_VERSION：指定操作系统的版本号。 -
CMAKE_SYSTEM_PROCESSOR：指定操作系统的处理器架构。 -
CMAKE_BUILD_TYPE：用于指定构建类型（例如，Debug、Release、RelWithDebInfo等）。可以使用此变量来控制编译器标志和优化级别。 -
CMAKE_INSTALL_PREFIX：指定安装目标的根目录。默认情况下，它通常是/usr/local（Linux）或C:\Program Files（Windows）。 -
CMAKE_MODULE_PATH：用于指定查找CMake模块的路径。模块通常用于共享一些通用的CMake配置。
这些内置变量可用于配置项目的不同方面，包括源文件路径、构建文件路径、编译器信息、操作系统信息和其他构建选项。您可以在CMakeLists.txt文件中使用这些变量，以根据项目的需求自定义构建过程。
cmake 构建选项 打开开关
在 CMake 中，你可以使用 option 命令创建构建选项开关，以便在构建时根据用户的选择来开启或关闭某些功能。这些选项通常用于控制编译和构建过程中的一些特定配置。以下是如何在 CMake 中创建和使用构建选项开关的示例：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# 在 CMakeLists.txt 中添加以下代码
option(BUILD_FEATURE_X "Build feature X" ON)
option(BUILD_FEATURE_Y "Build feature Y" OFF)
# 在合适的位置，根据选项的状态来设置相关内容
if(BUILD_FEATURE_X)
message("Building feature X")
add_subdirectory(feature_x)
endif()
if(BUILD_FEATURE_Y)
message("Building feature Y")
add_subdirectory(feature_y)
endif()
在这个示例中，我们定义了两个构建选项：BUILD_FEATURE_X 和 BUILD_FEATURE_Y。选项的初始状态分别设置为 ON 和 OFF。如果用户希望构建时开启 “Feature X”，可以在构建命令中使用 -DBUILD_FEATURE_X=ON，而如果希望关闭 “Feature Y”，可以使用 -DBUILD_FEATURE_Y=OFF。
根据选项的状态，我们在适当的位置添加了相关的配置。在这个例子中，如果选项 BUILD_FEATURE_X 被设置为 ON，就会构建名为 feature_x 的子目录中的内容。类似地，如果选项 BUILD_FEATURE_Y 被设置为 ON，就会构建 feature_y 子目录中的内容。
在实际项目中，你可以根据需要添加更多的选项和配置。这样的构建选项使得用户能够根据项目需求自定义构建过程，只构建他们需要的功能。
cmake 变量
在CMake中，变量用于存储和操作数据，可以在CMake脚本中定义、设置和使用。下面是对CMake变量的详细解释：
-
CMake缓存变量（CMake Cache Variables）：这些变量存储在CMake缓存中，并可以通过CMake GUI或命令行进行设置。它们在多次运行CMake时保持持久，并且可以影响项目的配置。常见的CMake缓存变量包括
CMAKE_INSTALL_PREFIX（安装路径）、CMAKE_BUILD_TYPE（构建类型）等。 -
CMake内部变量（CMake Internal Variables）：这些变量由CMake自身设置和使用，用于控制CMake的行为和功能。它们具有特殊的前缀或名称，例如
CMAKE_SOURCE_DIR（项目根目录路径）、CMAKE_BINARY_DIR（构建目录路径）等。 -
用户定义变量：这些变量由用户在CMake脚本中定义和设置。使用
set()函数可以创建用户定义变量，并使用${}语法引用它们。例如：1
set(MY_VARIABLE "Hello, world!")
-
环境变量：CMake可以读取和使用系统环境变量。可以使用
$ENV{VAR_NAME}语法引用环境变量。例如：1
message("Home directory: $ENV{HOME}")
-
Cache Entry变量：CMake提供了
set()函数的高级形式，用于创建带有用户友好描述和其他属性的缓存变量。例如：1
set(MY_VARIABLE "Hello, world!" CACHE STRING "A user-friendly description")
这将创建一个名为
MY_VARIABLE的缓存变量，它具有用户友好的描述和其他属性，可以在CMake GUI中显示和设置。 -
List变量：List变量是一种特殊类型的变量，可以包含多个值。你可以使用
set()函数将多个值存储到List变量中，并使用${}语法访问和操作它们。例如：1 2
set(LIST_VARIABLE "value1" "value2" "value3") message("List variable: ${LIST_VARIABLE}")
输出结果将是
value1;value2;value3。
这些是CMake中常见的变量类型和用法。在CMake脚本中，你可以根据需要使用这些变量来控制和配置项目。
cmake 3.10.2 option
在CMake 3.10.2版本中，option命令用于定义和处理用户选项。它允许您在CMake配置过程中提供一些可配置的选项，以便用户可以根据需要进行选择。
以下是option命令的语法：
1
option(<option_variable> "<option_description>" [initial_value])
<option_variable>：要定义的选项的变量名。<option_description>：选项的描述文本，将在配置过程中显示给用户。[initial_value]：选项的初始值，默认情况下为OFF。如果用户选择了该选项，则变量的值为ON。
使用option命令定义选项后，可以通过${<option_variable>}来引用选项的值。
以下是一个示例，展示了CMake 3.10.2中option命令的使用：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
option(BUILD_TESTS "Build test targets" ON)
option(DEBUG_LOGGING "Enable debug logging" OFF)
if(BUILD_TESTS)
message("Building test targets")
else()
message("Not building test targets")
endif()
if(DEBUG_LOGGING)
message("Debug logging is enabled")
else()
message("Debug logging is disabled")
endif()
在上述示例中，定义了两个选项：BUILD_TESTS和DEBUG_LOGGING。BUILD_TESTS的初始值为ON，而DEBUG_LOGGING的初始值为OFF。
根据选项的值，使用if语句来执行相应的操作。如果BUILD_TESTS为ON，则输出”Building test targets”；否则输出”Not building test targets”。如果DEBUG_LOGGING为ON，则输出”Debug logging is enabled”；否则输出”Debug logging is disabled”。
在CMake的配置过程中，用户可以通过设置这些选项来控制构建的行为。
请注意，选项的值是通过CMake缓存系统进行保存的，可以通过命令行选项或图形界面工具来修改选项的值。
cmake find_library 和 find_package
find_library 和 find_package 是 CMake 中用于查找库的两个不同的命令，它们各自适用于不同的场景和目的。
find_library:
- 用途：
find_library用于查找和定位系统中的库文件。 - 语法：
find_library(<VAR> names...) - 示例：
1 2 3 4 5 6
find_library(MY_LIBRARY mylib) if(MY_LIBRARY) message("Library found: ${MY_LIBRARY}") else() message(FATAL_ERROR "Library not found") endif()
- 说明：
find_library将库文件的名称传递给names参数，并尝试在系统中找到该库文件。如果找到，它将设置<VAR>变量为库文件的完整路径。在上述示例中，如果找到名为libmylib.so的库文件，MY_LIBRARY变量将被设置为该库文件的完整路径。
find_package:
- 用途：
find_package用于查找和配置第三方软件包，通常用于查找 CMake 模块。 - 语法：
find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE] [REQUIRED] [COMPONENTS [components...]]) - 示例：
1 2 3 4 5 6 7
find_package(Boost 1.70 REQUIRED COMPONENTS filesystem system) if(Boost_FOUND) message("Boost found: ${Boost_INCLUDE_DIRS}") message("Boost libraries: ${Boost_LIBRARIES}") else() message(FATAL_ERROR "Boost not found") endif()
- 说明：
find_package用于查找并配置第三方软件包，通常使用 CMake 模块来实现。在上述示例中，find_package尝试查找 Boost 库，并确保找到指定版本以及必需的组件（filesystem 和 system）。如果找到，它将设置相应的变量（例如，Boost_INCLUDE_DIRS和Boost_LIBRARIES）以供后续使用。
选择使用：
- 如果你只需要查找和链接系统中的某个库文件，可以使用
find_library。 - 如果你需要查找和配置第三方软件包，使用
find_package通常更方便，因为它可以利用 CMake 模块提供的更多信息。
总体来说，选择使用哪一个命令取决于你的具体需求和项目的复杂性。