当初对cmake也是怀有恐惧心理,但是想着总要学会,便花了一个周末时间带着问题去查资料,在解决问题中也算是对cmake入门了。
有很多事情都是有个大概的想法就要开始做,不可能一下就能想到完美(我们不是上帝),因为会在做事的过程中遇见很多新的问题,在解决问题过程中增强对事物了解的同时,也增强了自己的能力。对于编程,更要勤敲代码,“Talk is cheap ,show me the code! ”。
发现很多时候阻碍我们学习的就是恐惧、害怕本身,“看着好难啊?我能学得会吗?”,害怕作为拦路虎阻碍了我们跨出第一步。学习在初期往往是枯燥的,需要有坐冷板凳、咬定青山不放松、“扎硬寨,打呆仗”的精神,最好能够带着问题去学习(目标要明确),从小处去入手,由浅入深。
最后,引用一下朱熹关于学习过程的语录:读书,始读,未知有疑;其次,则渐渐有疑;中则节节是疑。过了这一番,疑渐渐释,以至融会贯通,都无所疑,方始是学。
cmake官方教程翻译版
CMake Cookbook中文版
cmake 备忘录
需要注意的一点:Qt 6采用cmake作为编译系统,可见cmake在现阶段是大势所趋的跨平台编译工具。
编译四个阶段
1)预处理(Preprocessing)
2)编译(Compilation)
3)汇编(Assemble) -->‘as’
4)链接(Linking) -->‘ld’
编译:把高级语言的源文件进行一系列处理,最终得到二进制代码的可执行文件(传说中的binary)
一般情况下,我们只需要知道编译和链接两个阶段即可,编译阶段是将源程序(*.c)转换成为目标代码(一般是obj文件),链接阶段就是把目标代码(obj文件)与调用库函数代码连接起来形成可执行文件(exe文件)。
静态库:链接阶段,库中目标文件所含的所有将被程序使用的函数的机器码,被copy到最终的可执行文件中。有调用的地方,就会有一个完整的拷贝,造成空间的浪费。
动态库:程序编译时并不会链接到目标代码中,而是在程序运行时才被载入。动态内存库只在内存中存在一份拷贝,避免了静态库浪费空间的问题。
c语言编译
c语言在编译过程中会经过预处理(需要头文件)、 编译、汇编、链接(需要库文件),执行的时候还可能有动态链接过程。在编译的时候只需要头文件的声明就可以了,在链接的时候,把已经链接好的.obj和现有的.lib文件进行链接,这时就可以最终生成可执行文件了。
头文件是告诉编译器函数是如何调用如何返回的,所有实现都是分别编译,最后在链接阶段链在一起。
文件夹:源码 && 库文件
include目录放置头文件
src目录下放置的是.c/.cpp源文件
build目录是用来构建的项目
lib目录用来放置我们生成库文件。
符号 | 表示目录 |
---|---|
./ | 当前目录 |
…或者 …/ | 上一级目录 |
…/…或者 …/…/ | 上上一级目录 |
cmake简介
CMake是一种跨平台编译工具,CMake主要是编写CMakeLists.txt文件,然后通过cmake命令将CMakeLists.txt文件转化为make所需要的Makefile文件,最后用make命令编译源码生成可执行程序或者库文件。
基本语法规则
cmake变量使用${}方式取值,但是在IF控制语句中是直接使用变量名。
环境变量使用$ENV{}方式取值,使用SET(ENV{VAR} VALUE)赋值。
指令不区分大小写,一般推荐使用大写。
cmake本身不提供任何搜索库的便捷方法,所有搜索库并’给变量赋值’的操作必须由’cmake代码’完成
指令是大小写无关的,参数和变量是大小写相关的。但是推荐你全部使用大写指令。
可以使用双引号“”将源文件包含起来。处理特别难处理的名字比如fun c.c,则使用SET(SRC_LIST “fun c.c”)可以防止报错。
CMake项目的主要目录存在一个 CMakeLists.txt 文件
我们有两种当时设置编译规则
包含源文件的子文件夹包含 CMakeLists.txt 文件,主目录的 CMakeLists.txt 通过 add_subdirectory 添加子目录即可
包含源文件的子文件夹未包含 CMakeLists.txt 文件,子目录编译规则体现在主目录的 CMakeLists.txt 文件
在 Linux 平台下使用 CMake 构建 C/C++ 工程的流程如下:
推荐采用外部构建(out-of-source build),而不是内部构建(in-source build)。
外部编译一个最大的好处是,对于原有的工程没有任何影响,所有动作全部发生在编译目录。
内部构建会产生很多中间文件(Generated files,编译的中间文件和makefile文件),这些文件并不是我们最终想要的,和工程源代码文件放在一起会显得杂乱无章。
## 内部构建
# 在当前目录下,编译本目录的CMakeLists.txt,生成Makefile和其他文件
$ cmake .
# 执行make命令,生成target
$ make
将编译的目录和源代码目录区分开来,放在不同目录中
## 外部构建
# 1. 在当前目录下,创建build文件夹
$ mkdir build
# 2. 进入到build文件夹
$ cd build
# 3. 编译上级目录的CMakeLists.txt,生成Makefile和其他文件
$ cmake …
# 4. 执行make命令,生成target
$ make
两种方式设置编译规则:
1. 包含源文件的子文件夹包含CMakeLists.txt文件,主目录的CMakeLists.txt通过add_subdirectory添加子目录即可
2. 包含源文件的子文件夹未包含CMakeLists.txt文件,子目录编译规则体现在主目录的CMakeLists.txt中
• MESSAGE
MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] “message to display” …)
向终端输出用户定义的信息或变量的值,SEND_ERROR:产生错误,生成过程被跳过;STATUS:输出前缀为—的信息;FATAL_ERROR:立即终止所有cmake过程
targets
Executable——add_executable、Libraries——add_library都可以算是target
最低版本要求
cmake_minimum_required (VERSION 2.8.7)
项目名称
project (projectname)
项目名称变量存储在PROJECT_NAME里。
该指定隐式引入了两个CMAKE的变量:
_BINARY_DIR,本例中是 projectname_BINARY_DIR(二进制文件保存路径)
_SOURCE_DIR,本例中是 projectname_SOURCE_DIR(源代码路径)
PROJECT_SOURCE_DIR
项目根目录,也就是CmakeLists.txt目录的绝对路径。
cmake变量
PROJECT_SOURCE_DIR:工程的根目录
PROJECT_BINARY_DIR:运行cmake命令的目录,通常为${PROJECT_SOURCE_DIR}/build
PROJECT_NAME:返回通过 project 命令定义的项目名称
CMAKE_CURRENT_SOURCE_DIR:当前处理的 CMakeLists.txt 所在的路径
CMAKE_CURRENT_BINARY_DIR:target 编译目录
CMAKE_CURRENT_LIST_DIR:CMakeLists.txt 的完整路径
EXECUTABLE_OUTPUT_PATH:可执行文件的存放位置
LIBRARY_OUTPUT_PATH:生成库的文件目录
find_package
项目通过该语句找到外部库、程序、文件等。
可以通过以下标准变量找到模块:
XXX_FOUND——如果没有找到则为false
XXX_INCLUDE_DIRS
XXX_LIBRARIES——要link的库,
XXX_DEFINITIONS
XXX_EXECUTABLE
XXX_LIBRARY DIRS
CMAKE_BUILD_TYPE
编译类型,默认为Debug
set(CMAKE_BUILD_TYPE Debug)
set(CMAKE_BUILD_TYPE Release)
set
SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
定义变量(可以定义多个VALUE,如SET(SRC_LIST main.c util.c reactor.c))
set(KEY VALUE)接受两个参数,用来声明变量。在camke语法中使用KEY并不能直接取到VALUE,必须使用${KEY}这种写法来取到VALUE。
include_directories
指定’查找头文件’的搜索路径,它提供了一个’搜索头文件暂时的根目录’,相当于VS工程中设置“包含目录”,避免了在引用头文件时添加很长的路径。
include_directories(directories)
补充: 官网’不推荐’使用INCLUDE_DIRECTORIES
target_include_directories
target_include_directories( [SYSTEM] [AFTER|BEFORE]
[
为指定目标(target)添加搜索路径,指定目标是指通过如add_executable(),add_library()这样的命令生成的。
INTERFACE、PUBLIC、PRIVATE会限制后面包含路径的作用范围,一般用PUBLIC即可;[items1…]即为头文件搜索路径。
target_include_directories 只会为指定目标包含头文件搜索路径。如果想为不同目标设置不同的搜索路径,那么用target_include_directories更合适。
include_directories和target_include_directories关系有点类似VS工程中的“包含目录”和“附加包含目录”区别,一个是全局,一个是针对单个工程而言。
举个栗子:
add_library(${PROJECT_NAME} SHARED Message.cpp)
target_include_directories(${PROJECT_NAME} PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include)
搜集源文件——aux_source_directory
#包含原程序,即把给定目录下的源程序复制给变量DIR_SRC,但是这里一般都把生成的可执行文件放在bin目录中。
aux_source_directory(DIR_SRC ./)
aux_source_directory(src SRC_SUB)//src对应目录里搜索源文件,保存在文件列表SRC_SUB里
aux_source_directory(. SRC_CUR) //在当前目录进行同样操作
aux_source_directory(. SRC) // 定义SRC变量,其值为当前目录下所有的源代码文件
生成可执行程序——add_executable
语法:add_executable( [WIN32] [MACOSX_BUNDLE][EXCLUDE_FROM_ALL] source1 source2 … sourceN)
用于指定从一组源文件 source1 source2 … sourceN 编译出一个可执行文件且命名为 name。
add_executable(变量名 源文件名)
add_executable(helloworld ${DIR_SRC})
executable(nicp_cloud_visualization nicp_cloud_visualization.cpp)
强调: add_executable’不包括’头’(.h)'文件
添加运行库——add_library
生成/添加静态库或者动态库
语法: add_library( [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL] source1 [source2 …])
指定生成的库文件名称,会自动加上前缀和后缀
STATIC 生成静态库
SHARED 生成动态链接库
MODULE 在使用dyld的系统有效,若不支持dyld,等同于SHARED;EXCLUDE_FROM_ALL 表示该库不会被默认构建。
例:add_library(${PROJECT_NAME} SHARED library.cpp library.h)
如果指定库类型,默认编译生成的是静态库。
说明1: 每个’add_library’只能生成一个库–>‘静态|动态’,默认是’静态’库
说明2: 一个’.h’头文件对应的’.c|.cpp’可能有多个,这个时候需要’aux_source_directory’的指令–>‘同上’
SET(LIBHELLO_SRC hello.c java.c) -->‘再多就要使用’ -->‘aux_source_directory’
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
SET_TARGET_PROPERTIES
设置输出的名称,设置动态库的版本和API版本
添加静态/动态库——link_directories
库文件搜索路径,一般用在add_executable之前。假设我们程序用到了在/usr/lib下的一个静态库libmy.a,那就需要添加如下两个命令
#库所在位置
link_directories(/usr/lib)
设置要链接的库——target_link_libraries
#程序编译时候链接库,将’库’和’二进制可执行程序’进行’链接’
语法: target_link_libraries( [item1 [item2 […]]][[debug|optimized|general] ] …)
用于指定 target 链接的依赖项 item1 item2 …。
target_link_libraries(helloworld my)
表示helloworld要连接my,需要需要保证my必须在helloworld之前生成。
TARGET_LINK_LIBRARIES(target lib1 lib2 …)
为target添加需要链接的共享库
target_link_libraries:添加’链接库’;
target_link_libraries(demo Hello) 将’可执行文件’与’Hello连接’成’最终’文件demo
细节: 换句话说’add_executable(demo ${SRC_LIST})‘还不是最终的’demo’,没有经过’链接’的环节
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-UIP0Gn7O-1670820599867)(设置要链接的库.png)]
细节: ‘TARGET_LINK_LIBRARIES’要写在’ADD_EXECUTABLE’后面
target_link_libraries里库文件的顺序’符合gcc链接顺序’的规则,即’被依赖的库’放在’依赖它的库’的后面
1)cmake中链接库的顺序是’a依赖b’,那么b放在a的后面。
2)例如’二进制可执行程序test’依赖a库,b库, ‘a库又依赖b 库’, 那么’顺序如下’:
TARGET_LINK_LIBRARIES(test a;b)
备注: 空格或’;'都可以
属性PRIVATE、PUBLIC、INTERFACE使用主要看头文件、源文件是否包含第三方文件头
头文件(.h,.hpp文件) | 源文件(.cpp文件) | 属性 |
---|---|---|
✔ | INTERFACE | |
✔ | PRIVATE | |
✔ | ✔ | PUBLIC |
link_directories
链接路径,指定动态链接库或静态链接库的搜索路径。也相当于环境变量中增加’LD_LIBRARY_PATH’的路径的作用。该指令的作用’主要’是指定’要链接的库文件(static|dynamic)‘的路径,相当于vs工程的“库目录”。
可以指定’多个路径’,以’空格’分开,
link_directories仅对’其后面’的targets起作用!!!
link_directories(“${PROJECT_SOURCE_DIR}/library”)
add_subdirectory
如果想添加一个子项目或者模块,可以用它进行构建的子目录。
向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制的存放位置
可以包含.h、.c和.cpp文件,这种方式可以直接添加头文件和源文件,不需要通过INCLUDE_DIRECTORIES指定头文件。
语法:add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
add_subdirectory(${OPEN_SOURCES_DIRECTORY}/cpp_redis)
file APPEND命令
file(APPEND … )
用于向文件中追加内容,如果文件不存在,会创建该文件,如果该文件存在不会覆盖文件中的旧内容,将内容追加到文件末尾。
set(TEST_CONTENT “\nI am coming”)
file(APPEND ${PROJECT_SOURCE_DIR}/test.cpp ${TEST_CONTENT})
file GLOB命令
file(GLOB [LIST_DIRECTORIES true[false] [RELATIVE ] [CONFIGURE_DEPENDS] [ …])
主要用于匹配规则在指定的目录内匹配到所需要的文件,并将文件赋值给变量。
file (GLOB Copy_Files “.qml" ".xml”)
file (COPY ${Copy_Files} DESTINATION ${CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG})
file RENAME命令
file(RENAME )
将旧文件重新命名为新名称newname.
file(RENAME test_2.cpp test.cpp)
file MAKE_DIRECTORY命令
file(MAKE_DIRECTORY [ …])
用来创建新目录
file COPY命令
file(COPY … DESTINATION
install 命令
将动态库、可执行程序安装到指定目录
操作系统CMAKE_SYSTEM_NAME
if(CMAKE_SYSTEM_NAME STREQUAL “Linux”)
message(STATUS “Configuring on/for Linux”)
elseif(CMAKE_SYSTEM_NAME STREQUAL “Darwin”)
message(STATUS “Configuring on/for macOS”)
elseif(CMAKE_SYSTEM_NAME STREQUAL “Windows”)
message(STATUS “Configuring on/for Windows”)
elseif(CMAKE_SYSTEM_NAME STREQUAL “AIX”)
message(STATUS “Configuring on/for IBM AIX”)
else()
message(STATUS “Configuring on/for ${CMAKE_SYSTEM_NAME}”)
endif()
检测处理器体系结构——32位or64位
if(CMAKE_SIZEOF_VOID_P EQUAL 8)
target_compile_definitions(arch-dependent PUBLIC “IS_64_BIT_ARCH”)
message(STATUS “Target is 64 bits”)
else()
target_compile_definitions(arch-dependent PUBLIC “IS_32_BIT_ARCH”)
message(STATUS “Target is 32 bits”)
endif()
文件输出目录设置
注意:设置的时候要放在add_executable、add_library前面
方法一(常用):
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
注:CMAKE_RUNTIME_OUTPUT_DIRECTORY是指定可执行文件的输出目录,CMAKE_LIBRARY_OUTPUT_DIRECTORY是指定动态库或者静态库的输出目录,CMAKE_ARCHIVE_OUTPUT_DIRECTORY用于设置 ARCHIVE 目标的输出路径。
方法二:
set_target_properties( targets…
PROPERTIES
ARCHIVE_OUTPUT_DIRECTORY “${CMAKE_BINARY_DIR}/lib”
LIBRARY_OUTPUT_DIRECTORY “${CMAKE_BINARY_DIR}/lib”
RUNTIME_OUTPUT_DIRECTORY “${CMAKE_BINARY_DIR}/bin”
)
方法三:
# set output directories for all builds (Debug, Release, etc.)
foreach( OUTPUTCONFIG ${CMAKE_CONFIGURATION_TYPES} )
string( TOUPPER ${OUTPUTCONFIG} OUTPUTCONFIG )
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_${OUTPUTCONFIG} KaTeX parse error: Expected group after '_' at position 65: …UTPUT_DIRECTORY_̲{OUTPUTCONFIG} ${CMAKE_SOURCE_DIR}/lib )
set( CMAKE_RUNTIME_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${CMAKE_SOURCE_DIR}/bin )
endforeach( OUTPUTCONFIG CMAKE_CONFIGURATION_TYPES )
常用变量
变量 | 含义 |
---|---|
CMAKE_CURRENT_LIST_DIR | 表示正在处理的CMakeLists.txt 文件的所在的目录的绝对路径(2.8.3 以及以后版本才支持) |
CMAKE_ARCHIVE_OUTPUT_DIRECTORY | 静、动态库的lib文件存放位置, |
CMAKE_LIBRARY_OUTPUT_DIRECTORY | ? |
CMAKE_RUNTIME_OUTPUT_DIRECTORY | 设置可执行程序、动态库dll的存储目录 |
CMAKE_SOURCE_DIR | 程顶层目录所在路径 |
CMAKE_CURRENT_SOURCE_DIR | 当前CMakeLists.txt所在的路径,建议使用CURRENT_SOURCE,不建议使用SOURCE_DIR,因为如果主工程目录改变了,SOURCE_DIR也就会改变,很容易造成编译错误 |
CMAKE_BINARY_DIR | 工程编译时的路径 |
EXECUTABLE_OUTPUT_PATH | 可执行文件.exe的输出路径 |
LIBRARY_OUTPUT_PATH | 静、动态库lib、dll文件的输出路径 |
include_directories 和target_include_directories的区别
target_include_directories() 的功能完全可以使用 include_directories() 实现,但还是建议使用 target_include_directories()。
target_include_directories为指定目标(target)添加搜索路径,指定目标是指通过如add_executable(),add_library()这样的命令生成的。
target_include_directories 只会为指定目标包含头文件搜索路径。如果想为不同目标设置不同的搜索路径,那么用target_include_directories更合适。
include_directories(header-dir) 是一个全局包含,针对的是所有target(而target_include_directorie只针对一个target),会向下传递。什么意思呢?就是说如果某个目录的 CMakeLists.txt 中使用了该指令,其下所有的子目录默认也包含了header-dir 目录,会增加搜索时间。
当然了,在最终子目录的 CMakeLists.txt 文件中,使用 include_directories() 和 target_include_directories() 的效果是相同的。
每一个目录都是一个模块,目录内部应将对外和对内的头文件进行区分,由模块的调用者决定模块是否被传递(PRIVATE,INTERFACE,PUBLIC)。
么用target_include_directories更合适。
include_directories(header-dir) 是一个全局包含,针对的是所有target(而target_include_directorie只针对一个target),会向下传递。什么意思呢?就是说如果某个目录的 CMakeLists.txt 中使用了该指令,其下所有的子目录默认也包含了header-dir 目录,会增加搜索时间。
当然了,在最终子目录的 CMakeLists.txt 文件中,使用 include_directories() 和 target_include_directories() 的效果是相同的。
每一个目录都是一个模块,目录内部应将对外和对内的头文件进行区分,由模块的调用者决定模块是否被传递(PRIVATE,INTERFACE,PUBLIC)。
#另外一种方法,未验证
#设置exe目录,
SET(EXECUTABLE_OUTPUT_PATH “${PROJECT_SOURCE_DIR}/bin”)
#设置lib文件目录,
SET(LIBRARY_OUTPUT_PATH “${PROJECT_SOURCE_DIR}/lib”)
# 文件放到该目录下
INSTALL(FILES hello.h DESTINATION include/hello)
# 二进制,静态库,动态库安装都用TARGETS
# ARCHIVE 特指静态库,LIBRARY 特指动态库,RUNTIME 特指可执行目标二进制。
INSTALL(TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)
${CMAKE_CURRENT_LIST_DIR}/…/库文件/${PROJECT_NAME}/bin)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/…/库文件/${PROJECT_NAME}/lib)
#查找头文件并将其复制到指定目录
file (GLOB Copy_Files ${CMAKE_CURRENT_LIST_DIR}/include/.h ${CMAKE_CURRENT_LIST_DIR}/include/.hpp)
file (COPY ${Copy_Files} DESTINATION ${CMAKE_CURRENT_LIST_DIR}/…/库文件/${PROJECT_NAME}/include)
win32或x64
cmake … -G “Visual Studio 16 2019” -A Win32
其中,-G 指示CMake指定的kit,根据电脑上已安装的编译器填写;-A 指示CMake编译的版本,如32位为Win32,64位为x64。
变量Win32表示是否是Windows系统
if (WIN32)
message(STATUS “Now is windows”)
elseif (APPLE)
message(STATUS “Now is Apple systens.”)
elseif (UNIX)
message(STATUS “Now is UNIX-like OS’s.”)
endif ()
Debug或Realease
windows系统下默认是Debug构建,想要改为Release的话将命令"cmake --build .“替换为"cmake --build . --config Release”(设置CMAKE_BUILD_TYPE,CMAKE_CONFIGURATION_TYPES没有用,因为该变量适用于Unix makefile,而不适用于Visual项目)
x64(默认) | Win32 | |
---|---|---|
Debug(默认) | cmake … cmake --build . |
cmake … -G “Visual Studio 16 2019” -A Win32 cmake --build . |
Release | cmake … cmake --build . --config Release |
cmake … -G “Visual Studio 16 2019” -A Win32 cmake --build . --config Release |
库的调试版本加上-d或d
命令:外部构建:
(暂不清楚自己电脑为什么不能直接使用make命令进行构建生成exe)
使用add_library命令将生成库用到的头文件、源文件添加进去即可,例如:
add_library(message
STATIC
Message.hpp
Message.cpp
)
在使用库的时候,除了要使用add_subdirectory添加子工程外,还需要target_link_libraries命令添加库的头文件,最后在add_executable生成exe后链接库(使用target_link_libraries命令)
直接在主CMakeLists.txt中add_library,无需添加头文件目录
分别使用include_directories,link_directories添加库的头文件和库文件(.lib)目录,最后使用target_link_libraries命令将库进行链接即可。
注意:
通过简单的QT单工程测试,不需要在CmakeLists.txt中添加qt头文件目录,与qt的相关的ui、qrc文件也不必添加到参与生成target的源文件中。
(温馨提示:不保证其他工程也是这样)
#设置自动生成moc文件,一定要设置
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTOUIC ON)
set(CMAKE_AUTORCC ON)
问题一:默认找到的QT库为x86类型,默认方式build构建会报如下错误
解决方法:在cmake时需要指定编译类型为x86还是x64,在指定x86的情况下能生成x86、x64可执行文件,但既然默认是x86,那如何指定
X64版本(以前默认是x64版本)