CMakeLists.txt学习笔记

一、Cmake概况

　　CMake是跨平台编译工具，比make更高级一些。其编译的主要工作是生成CMakeLists.txt文件，然后根据该文件生成Makefile，最后调用make来生成可执行程序或者动态库。所以基本步骤就只有两步：

• cmake生成CMakeLists.txt文件
• make执行编译

 

二、基本结构

1、Cmake最低版本

cmake_minimum_required(VERSION x.x.x)

2、项目名称

project(demo)

3、设置编译类型

add_executable(demo demo.cpp) # 生成可执行文件demo
add_library(common STATIC util.cpp) # 生成静态库
add_library(common SHARED util.cpp) # 生成动态库或共享库
#生成以下文件
#Linux ： demo、libcommon.a、libcommon.so
#windows ： demo.exe、common.lib、common.dll

4、指定源文件

1）明确指定

add_library(demo demo.cpp test.cpp util.cpp)

2）搜索所有

aux_source_directory(. SRC_LIST) # 搜索当前目录下的所有.cpp文件
add_library(demo ${SRC_LIST})

3）自定义

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})
# 或者
aux_source_directory(. SRC_LIST)
aux_source_directory(protocol SRC_PROTOCOL_LIST)
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

5、查找预编译库

 find_library()、find_file()、find_path()、find_program()、find_package()

6、设置include

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}")

7、设置链接库

link_directories(
    ${CMAKE_CURRENT_SOURCE_DIR}/libs
)
# 或者
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")

8、设置target链接库

在 Windows 下，系统会根据链接库目录，搜索xxx.lib 文件，Linux 下会搜索 xxx.so 或者 xxx.a 文件，如果都存在会优先链接动态库（so 后缀）

1）指定链接库

target_link_libraries(demo libface.a) # 链接libface.a
target_link_libraries(demo libface.so) # 链接libface.so

2）指定全路径/多个库

target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.a)
target_link_libraries(demo ${CMAKE_CURRENT_SOURCE_DIR}/libs/libface.so other.a)

 9、设置变量

9.1直接设置

set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})

9.2追加设置

set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp) # set追加
list(APPEND SRC_LIST test.cpp) # list追加
list(REMOVE_ITEM SRC_LIST main.cpp) # list删除
add_executable(demo ${SRC_LIST}))

10、条件控制

1） if…elseif…else…endif

2）while…endwhile

while(condition)
    ...
endwhile()

3）foreach…endforeach

foreach(loop_var RANGE start stop [step])
    ...
endforeach(loop_var)
# 例如
foreach(i RANGE 1 9 2)
    message(${i})
endforeach(i)
# 输出：13579

11、打印信息

message("build with debug mode")
message(WARNING "this is warnning message")

12、包含cmake

include(./common.cmake) # 指定包含文件的全路径
include(def) # 在搜索路径中搜索def.cmake文件
set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake) # 设置include的搜索路径