CMake初始用

云端一散仙

已于 2024-02-04 10:55:00 修改

阅读量919

点赞数 18

分类专栏： c++ CMake 文章标签： c++

于 2023-12-19 13:26:24 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_44347020/article/details/135082409

版权

c++ 同时被 2 个专栏收录

43 篇文章

订阅专栏

CMake

1 篇文章

订阅专栏

CMake常见语法

CMakeLists.txt 的语法比较简单,由命令、注释和空格组成,其中命令是不区分大小写的,符号"#"后面的内容被认为是注释。命令由命令名称、小括号和参数组成,参数之间使用空格进行间隔。

PROJECT(hello_cmake)：该命令表示项目的名称是 hello_cmake。CMake构建包含一个项目名称，上面的命令会自动生成一些变量，在使用多个项目时引用某些变量会更加容易。比如生成了：PROJECT_NAME 这个变量。PROJECT_NAME是变量名，${PROJECT_NAME}是变量值，值为hello_cmake
CMAKE_MINIMUM_REQUIRED(VERSION 2.6) ：限定了 CMake 的版本。
AUX_SOURCE_DIRECTORY(< dir > < variable >)： AUX_SOURCE_DIRECTORY ( . DIR_SRCS)：将当前目录中的源文件名称赋值给变量 DIR_SRCS
INCLUDE_DIRECTORIES（添加头文件目录）：它相当于g++选项中的-I参数的作用，也相当于环境变量中增加路径到CPLUS_INCLUDE_PATH变量的作用（这里特指c++。c和Java中用法类似）。
LINK_DIRECTORIES（添加需要链接的库文件目录）：它相当于g++命令的-L选项的作用，也相当于环境变量中增加LD_LIBRARY_PATH的路径的作用。
LINK_LIBRARIES（添加需要链接的库文件路径，注意这里是全路径）：比如LINK_LIBRARIES(“/opt/MATLAB/R2012a/bin/glnxa64/libeng.so”)
ADD_SUBDIRECTORY(src)：指明本项目包含一个子目录 src
SET(SOURCES src/Hello.cpp src/main.cpp)：创建一个变量，名字叫SOURCE。它包含了这些cpp文件。
ADD_EXECUTABLE(main ${SOURCES })：指示变量 SOURCES 中的源文件需要编译成一个名称为 main 的可执行文件。 ADD_EXECUTABLE() 函数的第一个参数是可执行文件名，第二个参数是要编译的源文件列表。因为这里定义了SOURCE变量，所以就不需要罗列cpp文件了。等价于命令：ADD_EXECUTABLE(main src/Hello.cpp src/main.cpp)
ADD_LIBRARY(hello_library STATIC src/Hello.cpp)：用于从某些源文件创建一个库，默认生成在构建文件夹。在add_library调用中包含了源文件，用于创建名称为libhello_library.a的静态库。
TARGET_LINK_LIBRARIES( main Test )（设置要链接的库文件的名称）：指明可执行文件 main 需要连接一个名为Test的链接库。添加链接库。
TARGET_INCLUDE_DIRECTORIES(hello_library PUBLIC ${PROJECT_SOURCE_DIR}/include)：添加了一个目录，这个目录是库所包含的头文件的目录，并设置库属性为PUBLIC。
MESSAGE(STATUS “Using bundled Findlibdb.cmake…”)：命令 MESSAGE 会将参数的内容输出到终端。
FIND_PATH () ：指明头文件查找的路径，原型如下：find_path(< VAR > name1 [path1 path2 …]) 该命令在参数 path* 指示的目录中查找文件 name1 并将查找到的路径保存在变量 VAR 中。
FIND_LIBRARY()：同 FIND_PATH 类似,用于查找链接库并将结果保存在变量中。

CMake可用变量

CMake语法指定了许多变量，可用于帮助您在项目或源代码树中找到有用的目录。其中一些包括：

Variable	Info
CMAKE_SOURCE_DIR	根源代码目录，工程顶层目录。暂认为就是PROJECT_SOURCE_DIR
CMAKE_CURRENT_SOURCE_DIR	当前处理的 CMakeLists.txt 所在的路径
PROJECT_SOURCE_DIR	工程顶层目录
CMAKE_BINARY_DIR	运行cmake的目录。外部构建时就是build目录
CMAKE_CURRENT_BINARY_DIR	The build directory you are currently in.当前所在build目录
PROJECT_BINARY_DIR	暂认为就是CMAKE_BINARY_DIR

g++相关指令

-I,添加包含路径（大写i）
-I 在编译时用，告诉编译器去哪个路径下找文件
如：-I /home/hello/include
表示将/home/hello/include目录作为第一个寻找头文件的目录。
编译器的寻找顺序是：/home/hello/include–>/usr/include–>/usr/local/include。如果在/home/hello/include中有个文件hello.h，则在程序中用#include<hello.h>就能引用到这个文件。
可以加多个包含路径，编译器的寻找顺序为添加的顺序。
-l,添加引用链接库（小写L）
-l 在链接时用到，它的作用是告诉链接器，要用到哪个库。
如：-l pthread
告诉链接器(linker)，程序需要链接pthread这个库,这里的pthread是库名不是文件名，具体来说文件句是libpthread.so。
-L,添加链接库路径
-L 后跟路径，告诉链接器从哪找库(.so文件)，只有在链接时会用到。
如：-L /home/hello/lib
表示将/home/hello/lib目录作为第一个寻找库文件的目录，寻找顺序是：/home/hello/lib–>/usr/lib–>/usr/local/lib。
可以加多个包含路径，链接器的寻找顺序为添加的顺序。
-Wl，rpath,添加运行时库路径
-Wl:rpath 后面也是路径，运行的时候用。这条编译指令会在编译时记录到target文件中，所以编译之后的target文件在执行时会按这里给出的路径去找库文件。
如：-Wl:rpath=/home/hello/lib
表示将/home/hello/lib目录作为程序运行时第一个寻找库文件的目录，程序寻找顺序是：/home/hello/lib–>/usr/lib–>/usr/local/lib。
可以加多个包含路径，程序在运行时的寻找顺序为添加的顺序。

message输出信息

cmake_minimum_required(VERSION 3.18)

project(show_vars VERSION 1.0.1)

# 为了分行确定输出内容
message("")

message("1.PROJECT_BINARY_DIR = ${PROJECT_BINARY_DIR}")
message("2.PROJECT_SOURCE _DIR = ${_DIR}")
message("3.CMAKE_CURRENT_SOURCE_DIR = ${CMAKE_CURRENT_SOURCE_DIR}")
message("4.CMAKE_CURRRENT_BINARY_DIR = ${CMAKE_CURRRENT_BINARY_DIR}")
message("5.CMAKE_CURRENT_LIST_FILE = ${CMAKE_CURRENT_LIST_FILE}")
message("6.CMAKE_CURRENT_LIST_LINE = ${CMAKE_CURRENT_LIST_LINE}")
message("7.CMAKE_MODULE_PATH = ${CMAKE_MODULE_PATH}")
message("8.CMAKE_SOURCE_DIR = ${CMAKE_SOURCE_DIR}")
message("9.EXECUTABLE_OUTPUT_PATH = ${EXECUTABLE_OUTPUT_PATH}")
message("10.LIBRARY_OUTPUT_PATH = ${LIBRARY_OUTPUT_PATH}")
message("11.PROJECT_NAME = ${PROJECT_NAME}")
message("12.PROJECT_VERSION_MAJOR = ${PROJECT_VERSION_MAJOR}")
message("13.PROJECT_VERSION_MINOR = ${PROJECT_VERSION_MINOR}")
message("14.PROJECT_VERSION_PATCH = ${PROJECT_VERSION_PATCH}")
message("15.CMAKE_SYSTEM = ${CMAKE_SYSTEM}")
message("16.CMAKE_SYSTEM_NAME = ${CMAKE_SYSTEM_NAME}")
message("17.CMAKE_SYSTEM_VERSION = ${CMAKE_SYSTEM_VERSION}")
message("18.BUILD_SHARED_LIBS = ${BUILD_SHARED_LIBS}")
message("19.CMAKE_C_FLAGS = ${CMAKE_C_FLAGS}")
message("20.CMAKE_CXX_FLAGS = ${CMAKE_CXX_FLAGS}")
message("21.CMAKE_SYSTEM_PROCESSOR   = ${CMAKE_SYSTEM_PROCESSOR}")
# 为了分行确定输出内容
message("")

find_package

find_package的两种模式，一种是Module模式，也就是我们引入curl库的方式。另一种叫做Config模式，也就是引入glog库的模式。

在Module模式中，cmake需要找到一个叫做Find<LibraryName>.cmake的文件。这个文件负责找到库所在的路径，为项目引入头文件路径和库文件路径。cmake搜索这个文件的路径有两个，一个是cmake安装目录下的/usr/share/cmake-<version>/Modules目录，另一个是指定的CMAKE_MODULE_PATH的所在目录。
如果Module模式搜索失败，没有找到对应的Find<LibraryName>.cmake文件，则转入Config模式进行搜索。它主要通过<LibraryName>Config.cmake or <lower-case-package-name>-config.cmake这两个文件来引入我们需要的库。以glog库为例，安装之后，它在/usr/local/lib/cmake/glog/目录下生成了glog-config.cmake文件，而/usr/local/lib/cmake/<LibraryName>/正是find_package函数的搜索路径之一。（find_package的搜索路径是一系列的集合，而且在linux，windows，mac上都会有所区别，需要的可以参考官方文档find_package）

对于原生支持Cmake编译和安装的库通常会安装Config模式的配置文件到对应目录，这个配置文件直接配置了头文件库文件的路径以及各种cmake变量供find_package使用。而对于非由cmake编译的项目，通常会编写一个Find<LibraryName>.cmake，通过脚本来获取头文件、库文件等信息。通常，原生支持cmake的项目库安装时会拷贝一份XXXConfig.cmake到系统目录中，因此在没有显式指定搜索路径时也可以顺利找到。