一些常见的CMakeList构建语法

最新推荐文章于 2024-06-01 18:28:10 发布

说给我左耳

最新推荐文章于 2024-06-01 18:28:10 发布

阅读量979

点赞数 18

文章标签： c++ linux

本文链接：https://blog.csdn.net/qq_38104450/article/details/134153375

版权

1. CMake

CMake与Makefile不同，Makefile的编写比较依赖平台，在不同的平台上兼容性比较差，CMake作为一个构建工具最明显的优点是可以跨平台使用，并且目前市面上大部分的集成编译器都自带CMake，这使得CMake使用更加方便快捷。
其步骤如下：
编写源代码–编写CMakeList.txt–执行CMake命令–生成Makefile文件–make–生成可执行文件
在Linux构建项目时候对应的步骤如下：

cd 项目文件夹
mkdir build
cmake ..
make

最后在build文件夹中生成./可执行文件

2. 基础CMake命令

2.1 注释

单行注释：

# 后面写注释内容

多行注释：

#[[***********]] ***为注释的内容

2.2 CMake版本定义

CMakeList在编写时候一般前几行都会写上CMake的版本以及C++的版本号。

# cmake最小所需版本号
cmake_minimum_required(VERSION 3.26)
# 项目名称
project(cmake_test)
# C++标准
set(CMAKE_CXX_STANDARD 17)

其中这个set(CMAKE_CXX_STANDARD 17)表示此程序是以C++17作为标准进行编译的有一些像g++在编译程序时候指定版本一样：

 g++ test.cpp -std=c++17 -o test

2.3 设置变量的值set

在CMake中，set命令用于设置变量的值。它的语法是：

# SET 指令的语法是：
# [] 中的参数为可选项, 如不需要可以不写
SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

var 是要设置的变量的名称。
value 是要为变量设置的值。
CACHE 是一个可选项，它用于将变量缓存，以便在后续构建中保留其值。
type 是变量的数据类型（例如，STRING，FILEPATH，BOOL等）。
docstring 是对变量的描述文档
比如我现在有四个 .cpp文件，我想把这几个cpp文件设置成一个变量，我可以用一下的语法修改：

set(LIB_LIB a.cpp b.cpp c.cpp d.cpp)

如果下次需要同时访问这几个cpp文件时直接访问LIB_LIB就可以，注意要写成${LIB_LIB}的形式比如：

add_executable(app  ${LIB_LIB}) # 吧LIB_LIB生成一个可以执行的文件

2.4 文件搜索

当我们一个项目中含有很多原文件但是我们不想一个一个添加的时候需要用到搜索命令来进行处理：
**aux_source_directory**命令：

aux_source_directory(< dir > < variable >)

dir：要搜索的目录
variable：把要搜索的目录下的原文件存储在variable变量中
假如有一个文件结构如下：

Tree
	test
		-include
			-a.h
			-b.h
			-c.h
			-d.h
		-src
			-a.cpp
			-b.cpp
			-c.cpp
			-d.cpp
		main.cpp

则CMakeList.txt构建如下:

cmake_minimum_required(VERSION 3.0)
project(test)
set(CMAKE_CXX_STANDARD 17)
#[[这行代码的效果是，告诉编译器在编译时要查找 ${PROJECT_SOURCE_DIR}/include 目录，以便正确地找到并包含在源代码中引用的头文件。
]]
# ${PROJECT_SOURCE_DIR} 是当前根目录
# 包含头文件的意思
include_directories(${PROJECT_SOURCE_DIR}/include)
# 搜索 src 目录下的源文件
# {CMAKE_CURRENT_SOURCE_DIR} 当前cmakelist所在的目录
aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src SRC_LIST)
add_executable(app  ${SRC_LIST})

2.5 动态库与静态库（重点）

动态库与静态库的区别？
动态库（Dynamic Link Library，DLL）是一种包含可执行代码和数据的文件，它可以在运行时被加载到内存中并供多个程序共享使用。与静态库不同，动态库在程序运行时动态加载，这意味着多个程序可以共享同一个动态库文件，从而节省磁盘空间和内存，并使库的更新更加方便。

如何找到动态库？
要找到动态库，需要告诉编译器和链接器库的位置。

在Linux系统上，动态库通常位于 /lib、/usr/lib 或自定义的库路径下。如果你自己编译了一个动态库，库文件通常会在当前目录下或自定义的库路径下。
在Windows系统上，动态库通常具有 .dll 扩展名，它们可以位于系统目录、应用程序目录或自定义路径下。系统目录通常是 C:\Windows\System32。应用程序目录是包含可执行文件的目录。

找不到动态库怎么办？

确保库文件位于你指定的搜索路径中。你可以使用绝对路径或相对路径，但要确保路径是正确的。
确保你使用了正确的库文件名。在 -l 选项中，通常不需要包含库文件的前缀（如 lib）或扩展名（如 .dll 或 .so）。
在Windows系统中，确保动态库文件位于系统的 PATH 环境变量指定的路径中。这样可以使操作系统能够找到库文件。
确保库文件实际存在于指定的路径中。你可以使用文件浏览器或命令行来验证。
如果你的库依赖于其他库，确保这些依赖库也可用，并且路径正确。如果依赖关系出现问题，可能导致库加载失败。
注意不同操作系统下，库文件的扩展名和路径可能会有所不同。在Linux中，通常使用 .so 扩展名，而在Windows中使用 .dll 扩展名。

2.5.1静态库的制作

制作静态库最后会生成lib.a的文件,语法如下：

add_library(库名称 STATIC 源文件1 源文件2 ...)

比如上面的程序结构要是制作动态库语法如下：

cmake_minimum_required(VERSION 3.0)
project(test)
include_directories(${PROJECT_SOURCE_DIR}/include)
aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src SRC_LIST)
# 制作成名字为sly静态库含有a b c d.cpp
add_library(sly STATIC ${SRC_LIST})

最后生成对应的 libsly.a静态库文件。

2.5.2 动态库的制作

制作动态库最后会生成.so的文件,语法如下：

add_library(库名称 SHARED 源文件1 源文件2 ...)

cmake_minimum_required(VERSION 3.0)
project(test)
include_directories(${PROJECT_SOURCE_DIR}/include)
aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src SRC_LIST)
# 制作成名字为sly静态库含有a b c d.cpp
add_library(sly SHARED ${SRC_LIST})

最后生成对应的 libsly.so动态库文件。

2.5.3 指定动态库静态库生成路径

可以指定生成路径，也可以默认生成路径都可以：

# 设置动态库/静态库生成路径
set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)

这样静态库或者动态库就会生成在${PROJECT_SOURCE_DIR}/lib路径下了，${PROJECT_SOURCE_DIR}这个宏为工程的根目录。

2.6 链接动态库静态库

制作好的动态库与静态库要与工程文件进行链接，要不然程序编译的时候还是会有未找到相应库文件的编译错误。具体链接方法如下：

2.6.1 静态库的链接

涉及到两种情况，第一种是自己制作的静态库，用如下命令进行连接即可：

link_libraries(<static lib> [<static lib>...])

参数1：指定出要链接的静态库的名字（上面例子中的sly即可）
参数2-N：要链接的其它静态库的名字

如果第三方的静态库需要连接就需要使用如下命令了：

# 在对应第三方库的地址中找到.a文件所在的地址文件目录lib path
link_directories(<lib path>)
# 把这个.a文件加到link_libraries中
link_libraries(<static lib> [<static lib>...])

比如上一片JSONCPP构建cmake文章中的例子一样，找到对应的.a文件以及头文件，把找到的 .a文件命名问JSON_CPP。

include_directories(/home/ubuntu/jsoncpp-1.9.5/build/lib/)
link_directories(/home/ubuntu/jsoncpp-1.9.5/build/lib/)

find_library(JSON_CPP libjsoncpp.a)

link_libraries 和 find_library 是两个在 CMake 中用于处理库的不同命令。
link_libraries：用于在目标（target）上链接一个或多个库。
find_library：用于在系统上查找一个特定的库，并将其路径存储在一个变量中。

2.6.2 动态库的链接

动态库连接语法：

target_link_libraries(
    <target> 
    <PRIVATE|PUBLIC|INTERFACE> <item>... 
    [<PRIVATE|PUBLIC|INTERFACE> <item>...]...)

target: 指定要加载的动态库的可执行文件的名字
item 动态库文件

与静态库的一点区别就是，静态库会在生成可执行程序的链接阶段被打包到可执行程序中，所以可执行程序启动，静态库就被加载到内存中了。而动态库一定是在可以行程序创建完成之后才能进行连接的。所以一般这句放在cmake最后。
引入了一个第三方动态库该如何写：还是类似于上面JSON的写法

cmake_minimum_required(VERSION 3.0)
project(TEST)
file(GLOB SRC_LIST ${CMAKE_CURRENT_SOURCE_DIR}/*.cpp)
# 指定源文件或者动态库对应的头文件路径
include_directories(${PROJECT_SOURCE_DIR}/include)
# 指定要链接的动态库的路径
link_directories(${PROJECT_SOURCE_DIR}/lib)
# 添加并生成一个可执行程序
add_executable(app ${SRC_LIST})
# 指定要链接的动态库
target_link_libraries(app pthread calc)