一、CMake基本语法格式
二、重要指令和常用变量
1.重要指令
1. cmake_minimum_required -指定CMake的最小版本
#CMake最小版本要求为2.8.3
cmake_minimun_required(VERSION 2.8.3)
2. project -定义工程名称,并可指定工程支持的语言
语法:project(projectname[CXX][C][Java])
#指定工程名为HELLOWORLD
project(HELLOWORLD)
3. set -显式的定义变量
语法:set(VAR [VALUE] [CACHE TRPE DOCSTRING [FORCE]])
#定义SRC变量,其值为 sayhello.cpp hello.cpp
set(SRC sayhello.cpp hello.cpp)
4.include_directories -向工程添加多个特定的头文件搜索路径 -->相当于指定g++编译器的-I参数
语法:include_directories([AFTER|BEFORE][SYSTEM] dir1 dir2 …)
#将/usr/lib/mylibfolder 和 ./lib 添加到库文件搜索路径
link_directories(/usr/lib/mylibfolder ./lib)
5. link_directories -向工程添加多个特定的库文件搜索路径 -->相当于指定g++编译器的-L参数
语法:link_directories(dir1,dir2…)
#将/usr/lib/mylibfolder 和 ./lib添加到库文件搜索路径
link_directories(/usr/lib/mylibfolder ./lib)
6.add_library -生成库文件
语法:add_library(libname [SHARED|STATIC|MODULE][EXCLUDE_FROM_ALL] source1 source2 … sourceN )
#通过变量SRC生成 libhello.so 共享库
add_library(libhello SHARED ${SRC})
7.add_compile_options -添加编译参数
#添加编译参数 -wall -std=c++11
add_compile_options(-wall -std=c++11 -o2)
8.add_executable -生成可执行文件
语法: add_executable(exename source1 source2 … sourceN)
#编译main.cpp文件生成可执行文件main
add_executable(main main.cpp)
9.target_link_libraries -为target添加需要链接的共享库–>相当于指定g++编译-l参数
语法:target_link_libraries(target library1<debug | optimized>library2…)
#添加src子目录,src中需有一个CMakeLists.txt
target_link_libraries(main hello)
10.add_subdirectory -向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制存放的位置
语法:add_subdirectory(source_dir [linary_dir][EXCLUDE_FROM_ALL]
#添加src子目录,src中需要一个CMAKELists.txt
add_subdirectory(src)
11. aux_source_directory -发现一个目录下所有的源代码文件并将列表存储在一个变量中,这个指令临时被用来自动构建源文件列表
语法:aux_source_directory(dir VARIABLE)
#定义SRC变量,其值为当前目录下所有的源代码文件
aux_source_directory(. SRC)
#编译SRC变量所代表的源代码文件,生成main可执行文件
add_executable(main ${SRC})
2.常用变量
- CMAKE_C_FLAGS gcc编译选项
CMAKE_CXX_FLAGS g++编译选项
# 在CMAKE_CXX_FLAGS编译选项后追加 -std=c++11
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
2.CMAKE_BUILD_TYPE 编译类型(Debug,Release)
# 设定编译类型为debug,调试时需要选择debug
set(CMAKE_BUILD_TYPE Debug)
#设定编译类型为release,发布时需要选择release
set(CMAKE_BUILD_TYPE Release)
三、CMake编译工程
CMake目录结构:项目主目录存在一个CMakeLists.txt文件
两种方式设置编译规则:
1.包含源文件的子文件夹包含CMakeList.txt文件,主目录的CMakeLists.txt通过add_subdirectory添加子目录即可;
2.包含源文件的子文件夹未包含CMakeLists.txt文件,子目录编译规则体在主目录的CMakeLists.txt中;
1.编译流程
在linux平台下使用CMake构建C/C++工程的流程如下:
- 手动编写 CmakeLists.txt
- 执行命令 cmake PATH 生成Makefile(PATH 是顶层CMakeLists.txt所在的目录)。
- 执行命令 make进行编译
#important tips
. #表示当前目录
./ #表示当前目录
.. #表示上级目录
../ #表示上级目录
2.两种构建方式
- 内部构建(in-source build): 不推荐使用
内部构建会在同级目录下产生一大堆中间文件,这些中间文件并不是我们最终所需要的,和工程文件放在一起会显得杂乱无章。
#内部构建
# 在当前目录下,编译本目录的CMakeLists.txt, 生成Makefile和其他文件
cmake .
# 执行make命令,生成target
make
- 外部构建(in-source build): 推荐使用
将编译输出文件与源文件放到不同目录中
## 外部构建
# 1.在当前目录下,创建build文件夹
mkdir build
#2. 进入到build文件夹
cd build
#3. 编译上级目录的CMakeLists.txt, 生成Makefile和其他文件
cmake ..
# 4. 执行make命令,生成target
make
四、CMake代码实践
1.最小CMake工程
#set the minimum version of CMake that can be used
cmake_minimum_required(VERSION 3.0)
#Set the project name 设置项目名称
project(HELLO)
#add an execuable 可执行
add_executable(hello_cmake main.cpp)
2.多目录工程-直接编译
#set the minimum version of CMake that can be used
cmake_minimum_required(VERSION 3.0)
#project name
project(SWAP)
#head file pat
include_directories(include)
#source directory files to var
add_executale(main_cmake main.cpp src/swap.cpp)