cmake学习1

原创已于 2024-09-20 11:56:31 修改 · 1.1k 阅读

28 ·

CC 4.0 BY-SA版权

文章标签：

#学习 #开发语言 #c++ #c语言

于 2024-09-20 11:23:11 首次发布

cmake学习专栏收录该内容

4 篇文章

订阅专栏

官网链接 https://cmake.org/

单个c文件构建

构建一个最简单的CMakeLists.txt只需要三步：

cmake_minimum_required(VERSION 3.20)
project(Hello)
add_executable(Hello Hello.c)

cmake_minimum_required设置cmake的最小版本要求，写上比较稳妥。

project设置项目名称。

add_executable构建可执行文件。

通常我们在顶层CMakeLists.txt上建立一个文件夹build，是使用 out-of-source 方式，构建在build文件夹下执行命令cmake ..，make.

2.如果有多个源文件的情况下

其中mian.c需要用到hello.c里面的函数

project(HELLO)

set(SRC_LIST main.c hello.c)

add_executable(hello ${SRC_LIST})

在本例子中，CMakeLists.txt 文件中使用到了 set 命令，set 命令用于设置变量，如果变量不存在则创建该变量并设置它；在本例中，我们定义了一个 SRC_LIST 变量，SRC_LIST 变量是一个源文件列表，记录生成可执行文件 hello 所需的源文件 main.c 和 hello.c，而在 add_executable 命令引用了该变量；当然我们也可以不去定义 SRC_LIST 变量，直接将源文件列表写在 add_executable 命令中，如下：

add_executable(hello main.c hello.c)

也可以使用这个命令

file(GLOB_RECURSE MODULE_COMMON_SRC ./*.c)

也可以使用这个命令

aux_source_directory(./ MODULE_COMMON_SRC )

这条语句的作用是在当前目录及其子目录中递归地搜索所有的.c文件，并将搜索到的文件路径列表存储在MODULE_COMMON_SRC变量中。

最后

add_executable(hello ${MODULE_COMMON_SRC})

3.生成库文件

我们还需要将 hello.c 编译为静态库文件或者动态库文件，在示例二的基础上对 CMakeLists.txt 文件进行修改，如下所示：

project(HELLO)

add_library(libhello hello.c)

add_executable(hello main.c)

target_link_libraries(hello libhello)

add_library 命令用于生成库文件，在本例中我们传入了两个参数，第一个参数表示库文件的名字，需要注意的是，这个名字是不包含前缀和后缀的名字；在 Linux 系统中，库文件的前缀是 lib，动态库文件的后缀是.so，而静态库文件的后缀是.a；所以，意味着最终生成的库文件对应的名字会自动添加上前缀和后缀。

第二个参数表示库文件对应的源文件。

add_library(libhello SHARED hello.c) #生成动态库文件

add_library(libhello STATIC hello.c) #生成静态库文件

target_link_libraries 命令为目标指定依赖库，在本例中，hello.c 被编译为库文件，并将其链接进 hello 程序。

修改生成的库文件名字

本例中有一点非常不爽，生成的库为 liblibhello.a，名字非常不好看；如果想生成 libhello.a 该怎么办？直接修改 add_library 命令的参数，像下面这样可以吗？

add_library(hello hello.c)

答案是不行的，因为 hello 这个目标已经存在了（add_executable(hello main.c)），目标名对于整个工程来说是唯一的，不可出现相同名字的目标，所以这种方法肯定是不行的，实际上我们只需要在 CMakeLists.txt 文件中添加下面这条命令即可：

set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")

set_target_properties 用于设置目标的属性，这里通过 set_target_properties 命令对 libhello 目标的 OUTPUT_NAME 属性进行了设置，将其设置为 hello。

cmake_minimum_required(VERSION 3.5)

project(HELLO)

add_library(libhello SHARED hello.c)

set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")

add_executable(hello main.c)

target_link_libraries(hello libhello)

示例四：将源文件组织到不同的目录

上面的示例中，我们已经加入了多个源文件，但是这些源文件都是放在同一个目录下，这样还是不太正规，我们应该将这些源文件按照类型、功能、模块给它们放置到不同的目录下，于是笔者将工程源码进行了整理，当前目录结构如下所示：

我们来看看每一个 CMakeLists.txt 文件的内容。

顶层 CMakeLists.txt

cmake_minimum_required(VERSION 3.5)

project(HELLO)

add_subdirectory(libhello)

add_subdirectory(src)

src 目录下的 CMakeLists.txt

include_directories(${PROJECT_SOURCE_DIR}/libhello)

add_executable(hello main.c)

target_link_libraries(hello libhello)

上述使用这个命令也行

include_directories(${CMAKE_CURRENT_LIST_DIR})

libhello 目录下的 CMakeLists.txt

add_library(libhello hello.c)

set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")

顶层 CMakeLists.txt 中使用了 add_subdirectory 命令，该命令告诉 cmake 去子目录中寻找新的

CMakeLists.txt 文件并解析它；而在 src 的 CMakeList.txt 文件中，新增加了 include_directories 命令用来指明头文件所在的路径，并且使用到了 PROJECT_SOURCE_DIR 变量，该变量指向了一个路径，从命名上可知，该变量表示工程源码的目录。CMAKE_CURRENT_LIST_DIR变量指的是当前cmakelists所在路径。

示例五：将生成的可执行文件和库文件放置到单独的目录下

前面还有一点不爽，在默认情况下，make 编译生成的可执行文件和库文件会与 cmake 命令产生的中间文件（CMakeCache.txt、CmakeFiles、cmake_install.cmake 以及 Makefile 等）混在一起，也就是它们在同一个目录下；如果我想让可执行文件单独放置在 bin 目录下，而库文件单独放置在 lib 目录下，就像下面这样：

将库文件存放在 build 目录下的 lib 目录中，而将可执行文件存放在 build 目录下的 bin 目录中，这个时候又该怎么做呢？这个时候我们可以通过两个变量来实现，将 src 目录下的 CMakeList.txt 文件进行修改，如下所示：

include_directories(${PROJECT_SOURCE_DIR}/libhello)

set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

add_executable(hello main.c)

target_link_libraries(hello libhello)

然后再对 libhello 目录下的 CMakeList.txt 文件进行修改，如下所示：