CMake是一个跨平台、开源的构建系统。他是一个集软件构建、测试、打包于一身的软件。它使用与平台和编译器独立的配置文件来对软件编译过程进行控制。
一、语法特性简介
1、基本语法格式:指令(参数1 参数2)
1、参数使用括弧括起
2、参数之间使用空格或者分号分开
2、指令是大小写无关的,参数和变量是大小写相关的
3、变量使用 ${} 方式取值,但是在 IF 控制语句中是直接使用变量名
二、常用的重要指令和CMake变量
2.1、重要指令
1、cmake_minimum_required:用来指定CMake的最小版本要求。这个命令是可选的,我们可以不写这句话,但在有些情况下,如果 CMakeLists.txt 文件中使用了一些高版本的 cmake 特有的一些命令时,就需要加上这样一行,提醒用户升级到该版本之后再执行 cmake。
语法:cmake_minimum_required(VERSION versionNumber)
示例:cmake_minimum_required(VERSION 2.8.3) #CMake最小版本要求为2.8.3
2、project:定义工程名称,并指定工程支持的语言。这个命令不是强制的,但是最好都加上。他会引入两个变量 demo_BINARY_DIR 和 demo_SOURCE_DIR,同时,cmake自动定义了两个等价的变量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR。
语法:project(projectname[CXX][C][JAVA])
示例:project(HELLOWORLD) #指定工程名为HELLOWORLD
3、set:显示的定义变量。
语法:set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
示例:set(SRC sayhello.cpp hello.cpp) #定义SRC变量,其值为sayhello.cpp hello.cpp
3.1、set 直接设置变量的值
set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})
3.2、set 追加设置变量的值
set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp)
add_executable(demo ${SRC_LIST})
3.3、list 追加或者删除变量的值
set(SRC_LIST main.cpp)
list(APPEND SRC_LIST test.cpp)
list(REMOVE_ITEM SRC_LIST main.cpp)
add_executable(demo ${SRC_LIST})
4、include_directories:向工程中添加多个特定的头文件搜索路径,设置包含的目录。(相当于指定g++中的-l参数)
语法:include_directories([AFTER] [BEFORE] [SYSTEM] dir1 dir2...)
示例:include_directories(/usr/include/myincludefolder ./include) #将 /usr/include/myincludefolder 和 ./include 添加到头文件搜索路径
include_directories(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/include)
Linux下还可以通过如下设置包含的目录:
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_CURRENT_SOURCE_DIR}")
5、link_directories:向工程中添加特定的库文件搜索路径,设置链接库搜索路径。(相当于指定g++编译器中的-L参数)
语法:link_directories(dir1 dir2 ...)
示例:link_directories(/usr/lib/mylibfolder ./lib) #将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径
link_directories(${CMAKE_CURRENT_SOURCE_DIR}/libs)
Linux下还可以通过如下方式设置包含的目录:
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")
6、add_library:生成库文件
语法:add_library(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL] source1 source2 ... sourceN)
示例:add_library(hello SHARED ${SRC}) #通过变量 SRC 生成 libhello.so 共享库
add_library(common STATIC util.coo) #生成静态库
add_library(common SHARED util.cpp) #生成动态库或者共享库
在Linux下生成:libcommon.a 与 libcommon.so
在Windows下生成:common.lib 与 common.dll
6.1、明确指定包含哪些源文件
add_library(demo demo.cpp test.cpp util.cpp)
6.2、搜索所有的 cpp 文件
aux_source_directory(dir VAR) #发现一个目录下所有的源代码文件,并将列表存储在一个变量中
aux_source_directory(. SRC_LIST) #搜索当前目录下的所有.cpp文件
add_library(demo ${SRC_LIST})
6.3、自定义搜索规则
file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
add_library(demo ${SRC_LIST})
#或者
file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
#或者
file(GLOB_RECURSE SRC_LIST "*.cpp") #递归搜索
FILE(GLOB SRC_PROTOCOL_LIST RELATIVE "protocol" "*.cpp") #相对 protocol 目录下搜索
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
#或者
aux_source_directory(. SRC_LIST)
aux_source_directory(protocol SRC_PROTOCOL_LIST)
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
7、add_compile_options:添加编译参数
语法:add_compile_options(param1 ... paramN)
示例:add_compile_options(-wall -std=c++11 -o2) #添加编译参数 -wall -std=c++11 -o2
8、add_executable:生成可执行文件
语法:add_executable(exename source1 source2 ... sourceN)
示例:add_executable(main main.cpp) #编译 main.cpp 生成可执行文件main
9、target_link_libraries:为target添加需要链接的共享库,设置target需要链接的库(相当于指定g++编译器中的-l参数)
语法:target_link_libraries(target library1<debug | optimized> library2...)
示例:target_link_libraries(main hello) #将 hello 动态库文件链接到可执行文件 main。在Windows下,系统会根据链接库目录,搜索xxx.lib文件,Linux下会搜索xxx.so或者xxx.a文件,如果都存在会优先链接动态库(.so后缀)。
9.1指定链接动态库或者静态库
target_link_libraries(demo libface.a) #链接libface.a
target_link_libraries(demo libface.so) #链接libface.so
9.2、指定全路径
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)
9.3、指定链接多个库
target_link_libraries(${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a boost_system.a boost_thread pthread)
10、add_subdirectory:向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制存放的位置
语法:add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
示例:add_subdirectory(src) #添加 src 子目录,src中需要一个CMakeLists.txt
11、aux_source_directory:发现一个目录下面所有的源代码文件并将列表存储在一个变量中,这个指令临时被用来自动构建源文件列表
语法:add_subdirectory(dir VARIABLE)
示例:add_subdirectory(. SRC) #定义SRC变量,其值为当前目录下所有的源代码文件
add_executable(main ${SRC}) #编译 SRC 变量所代表的源代码文件,生成main可执行文件。
2.2、CMake常用变量
1、CMAKE_C_FLAGS:gcc编译选项
2、CMAKE_CXX_FLAGS:g++编译选项
示例:set( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11") #在CMAKE_CXX_FLAGS编译选项后追加 -std=c++11
3、CMAKE_BUILD_TYPE 编译类型(Debug, Release)
示例:set(CMAKE_BUILD_TYPE Debug) #设定编译类型未Debug,调试时需要选择debug
set(CMAKE_BUILD_TYPE Release) #设定编译类型未release,发布时需要选择release
4、CMAKE_C_COMPILER:指定C编译器
5、CMAKE_CXX_COMPILER:指定C++编译器
6、EXECUTABLE_OUTPUT_PATH:可执行文件输出的存放路径
7、LIBRARY_OUTPUT_PATH:库文件输出的存放路径
8、CMAKE_BINARY_DIR / PROJECT_BINARY_DIR / _BINARY_DIR
这三个变量指代的内容分时一致的。如果是in source build,指的就是工程顶层目录。如果是 out-of-source编译,指的是工程编译发生的目录。
9、CMAKE_SOURCE_DIR / PROJECT_SOURCE_DIR / _SOURCE_DIR
这三个变量指代的内容是一致的,不论采用何种编译方式,都是工程顶层目录。也就是在 in source build 时,他跟CMAKE_BINARY_DIR等变量一致。PROJECT_SOURCE_DIR跟其他指令稍有区别,现在,你可以理解为他们是一致的。
三、CMake编译工程
CMake目录结构:项目主目录存在一个 CMakeLists.txt 文件
两种方式设置编译规则:
1、包含源文件的子文件夹包含 CMakeLists.txt 文件,主目录的CMakeLists.txt通过
add_subdirectory 添加子目录即可。
2、包含源文件的子文件夹未包含 CMakeLists.txt 文件,子目录编译规则体现在主目录的
CMakeLists.txt中。
四、编译流程
在Linux平台下使用CMake构建C/C++工程的流程如下:
1、手动编写 CMakeLists.txt 。
2、执行命令 cmake PATH 生成 Makefile (PATH是顶层CMakeLists.txt所在的目录)。
3、执行命令 make 进行编译。
五、两种构建方式
1、内部构建(in source build) :不推荐使用,内部构建会在同级目录下产生一大堆中间文件,这些中间文件并不是我们最终所需要的,和工程源文件放在一起会显得杂乱无章。
2、外部构建(out-of-source build):推荐使用,将编译输出文件和源文件放在不同的目录中。