简介
CMake是一个跨平台的安装(编译)工具,可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件,能测试编译器所支持的C++特性,类似UNIX下的automake。只是 CMake 的组态档取名为 CMakeLists.txt。Cmake 并不直接建构出最终的软件,而是产生标准的建构档(如 Unix 的 Makefile 或 Windows Visual C++ 的 projects/workspaces),然后再依一般的建构方式使用。这使得熟悉某个集成开发环境(IDE)的开发者可以用标准的方式建构他的软件,这种可以使用各平台的原生建构系统的能力是 CMake 和 SCons 等其他类似系统的区别之处。
简言之,cmake是一个可以支持多个平台的编译工具,CMake主要是编写CMakeLists.txt文件,然后用cmake命令将CMakeLists.txt文件转化为make所需要的makefile文件,最后用make命令编译源码生成可执行程序或共享库(so(shared object))
优点
(1) 自动搜索你的软件所依赖的库、头文件,CMake在搜索的时候会将环境变量和注册表(Windows平台)也包含
在内;
(2) 项目的构建目录和源码目录分离:也就是说可以在项目源码目录之外单独建立一个构建目录,用于存放构建过程
中生成的文件
(3) 在配置阶段选择可选的组件:
(4) 很容易在共享库和静态库的构建上进行切换
(5) CMake能自动生成项目文件的依赖关系,同时绝大多数平台上支持并行构建
编译
CMake的编译基本就两个步骤:
cmake
make
cmake 指向CMakeLists.txt所在的目录,cmake后会生成很多编译的中间文件以及makefile文件,所以一般建议新建一个新的目录,专门用来编译
mkdir build
cd build
cmake ../
make
make根据生成makefile文件,编译程序
CMakeLists.txt文件编写
# 指定 cmake 的最小版本
cmake_minimum_required(VERSION 3.4.1)
# 设置项目名
project(demo)
#打印相关消息消息
message("Project: ${PROJECT_NAME}")
message("Project Directory: ${PROJECT_SOURCE_DIR}")
message(WARNING "this is warnning message")
message(FATAL_ERROR "this build has many error") # FATAL_ERROR 会导致编译失败
# 设置编译类型
add_executable(demo demo.cpp) # 生成可执行文件
add_library(demo STATIC util.cpp) # 生成静态库
add_library(demo SHARED util.cpp) # 生成动态库或共享库
# 搜索当前目录下的所有.cpp文件,并存储在SRC_LIST变量中
aux_source_directory(. SRC_LIST)
add_library(demo ${SRC_LIST}) #默认是静态库
# 自定义搜素规则
file(GLOB SRC_LIST "*.cpp" "protocol/*.cpp")
add_library(demo ${SRC_LIST})
# 或者
file(GLOB SRC_LIST "*.cpp")
file(GLOB SRC_PROTOCOL_LIST "protocol/*.cpp")
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})
# 查找到指定的预编译库log ,并将它的路径存储在变量logLib 中
find_library(logLib log )
# 设置包含的目录,可包含头文件所在目录
include_directories(
${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_BINARY_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/include
)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_CURRENT_SOURCE_DIR}")
# 设置链接库搜索目录
link_directories( ${CMAKE_CURRENT_SOURCE_DIR}/libs )
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")
# 设置链接库
target_link_libraries( demo ${log-lib} log)
# 指定链接动态库或静态库
target_link_libraries(demo liblog.so) # 链接libface.so
# 指定库全路径
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so)
#库名可以是lib***.so 、 全路径、 ***
set(CMAKE_C_FLAGS_DEBUG "-g -Wall") #C
set(CMAKE_CXX_FLAGS_DEBUG "-g -Wall") #C++
set(SRC_LIST main.cpp test.cpp) #设置变量的值
set(SRC_LIST ${SRC_LIST} test.cpp) #追加变量的值
list(APPEND SRC_LIST test.cpp) #追加变量的值
list(REMOVE_ITEM SRC_LIST main.cpp) #删除变量的值
# 包含其他make文件
include(./common.cmake) # 指定包含文件的全路径
include(def) # 在搜索路径中搜索def.cmake文件
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # 设置include的搜索路径
# 条件控制 if…elseif…else…endif
if(${USER_TARGET_OS} STREQUAL “qnx”)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=gnu++14 -Wall -DHAS_SOMEIP_BINDING")
elseif(${USER_TARGET_OS} STREQUAL “linux”)
set(CMAKE_CXX_FLAGS “${CMAKE_CXX_FLAGS} -std=gnu++14 -pthread -Wall -DHAS_SOMEIP_BINDING”)
endif()
# 循环
while(condition)
...
endwhile()
# start 表示起始数,stop 表示终止数,step 表示步长
foreach(loop_var RANGE start stop [step])
...
endforeach(loop_var)
# 示例
foreach(i RANGE 1 9 2)
message(${i})
endforeach(i)
# 输出:13579
CMakeLists.txt中常用变量
1. 预定义变量
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 的完整路径
CMAKE_CURRENT_LIST_LINE:当前所在的行
CMAKE_MODULE_PATH:定义自己的 cmake 模块所在的路径,SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake),然后可以用INCLUDE命令来调用自己的模块
EXECUTABLE_OUTPUT_PATH:重新定义目标二进制可执行文件的存放位置
LIBRARY_OUTPUT_PATH:重新定义目标链接库文件的存放位置
2. 环境变量
使用环境变量
$ENV{Name}
写入环境变量
set(ENV{Name} value) # 这里没有“$”符号
3. 系统信息
CMAKE_MAJOR_VERSION:cmake 主版本号,比如 3.4.1 中的 3
CMAKE_MINOR_VERSION:cmake 次版本号,比如 3.4.1 中的 4
CMAKE_PATCH_VERSION:cmake 补丁等级,比如 3.4.1 中的 1
CMAKE_SYSTEM:系统名称,比如 Linux-2.6.22
CMAKE_SYSTEM_NAME:不包含版本的系统名,比如 Linux
CMAKE_SYSTEM_VERSION:系统版本,比如 2.6.22
CMAKE_SYSTEM_PROCESSOR:处理器名称,比如 i686
UNIX:在所有的类 UNIX 平台下该值为 TRUE,包括 OS X 和 cygwin
WIN32:在所有的 win32 平台下该值为 TRUE,包括 cygwin
4. 主要开关选项
BUILD_SHARED_LIBS:这个开关用来控制默认的库编译方式,如果不进行设置,使用 add_library 又没有指定库类型的情况下,默认编译生成的库都是静态库。如果 set(BUILD_SHARED_LIBS ON) 后,默认生成的为动态库
CMAKE_C_FLAGS:设置 C 编译选项,也可以通过指令 add_definitions() 添加
CMAKE_CXX_FLAGS:设置 C++ 编译选项,也可以通过指令 add_definitions() 添加
参考资料:
https://blog.csdn.net/afei__/article/details/81201039