CMakeLists.txt学习笔记二

CMakeLists.txt学习笔记二

背景

对CMake常用命令的一个系统性的学习和记录。

指定cmake的最小版本

1
cmake_minimum_required(VERSION 2.8)

这行命令是可选的，我们可以不写这句话，但在有些情况下，如果 CMakeLists.txt 文件中使用了一些高版本 cmake 特有的一些命令的时候，就需要加上这样一行，提醒用户升级到该版本之后再执行cmake。

设置项目名称

1
project(exampleProject)

这个命令不是强制性的，但最好都加上。它会引入两个变量 exampleProject_BINARY_DIR 和 exampleProject_SOURCE_DIR，同时，cmake 自动定义了两个等价的变量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR。还会创建PROJECT_NAME
${PROJECT_SOURCE_DIR}：本CMakeLists.txt所在的文件夹路径
${PROJECT_NAME}：本CMakeLists.txt的project名称

如果代码需要支持C++11，就直接加上这句

1
SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++0x")

添加编译选项

1
add_definitions(编译选项)

比如，如果想要生成的可执行文件拥有符号表，可以gdb调试，就直接加上这句

1
add_definitions("-Wall -g")

如果需要fpermissive选项

1
ADD_DEFINITIONS("-fpermissive")

设置变量，下面的代码都可以用到

1
2
3
4
5
6
7
8
9
10
11
12
给文件名/路径名或其他字符串起别名，用${变量}获取变量内容
set(变量 文件名/或者路径名/或者其他字符串别名...)

如下：
set(GOOGLE_PROTOBUF_DIR ${PROJECT_SOURCE_DIR}/protobuf)
set(PROTO_PB_DIR ${PROJECT_SOURCE_DIR}/proto_pb2)
set(PROTO_BUF_DIR ${PROJECT_SOURCE_DIR}/proto_buf)

set还可以追加变量的值
set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp)
add_executable(demo ${SRC_LIST})

list追加或删除变量的值

1
2
3
4
set(SRC_LIST main.cpp)
list(APPEND SRC_LIST test.cpp)
list(REMOVE_ITEM SRC_LIST main.cpp)
add_executable(demo ${SRC_LIST})

打印消息

1
2
3
4
5
6
7
8
message(消息)

如下：
message(${PROJECT_SOURCE_DIR})
message("build with debug mode")
message(WARNING "this is warnning message")
message(FATAL_ERROR "this build has many error") 
注意：FATAL_ERROR 会导致编译失败

编译子文件夹的CMakeLists.txt

1
2
3
4
add_subdirectory(子文件夹名称)

如下：
add_subdirectory(proto_pb2)

获取路径下所有的.cpp/.c/.cc文件，并赋值给变量中

1
aux_source_directory(路径 变量)

设置.h头文件的路径

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
include_directories(路径)

Linux 下还可以通过如下方式设置包含的目录
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -I${CMAKE_CURRENT_SOURCE_DIR}")

如下：
include_directories(
    ${CMAKE_CURRENT_SOURCE_DIR}
    ${CMAKE_CURRENT_BINARY_DIR}
    ${CMAKE_CURRENT_SOURCE_DIR}/include
)
include_directories(
    ${PROJECT_SOURCE_DIR}
    ${PROTO_PB_DIR} 
    ${PROTO_BUF_DIR}
)

指定库文件路径

1
2
3
4
5
6
7
8
9
10
link_directories(路径)

Linux 下还可以通过如下方式设置包含的目录
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -L${CMAKE_CURRENT_SOURCE_DIR}/libs")

如下：
link_directories(
    ${CMAKE_CURRENT_SOURCE_DIR}/libs
)

设置编译最终结果类型

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
生成可执行文件
add_executable(可执行文件名称 文件)

生成静态库
add_library(库文件名称 STATIC 文件)

生成动态库或共享库
add_library(库文件名称 SHARED 文件)

注意，库文件名称通常为libxxx.so/libxxx.a，在这里只要写xxx即可（不必写完整名字）

如下：
add_executable(demo demo.cpp) 
add_executable(${PROJECT_NAME} example_person.cpp )
add_library(common STATIC util.cpp) 
add_library(common SHARED util.cpp) 
ADD_LIBRARY(fcmagazine SHARED ${source_files} )

对add_library或add_executable生成的文件进行链接操作

1
2
3
4
5
6
7
8
target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称)

注意，库文件名称通常为libxxx.so/libxxx.a，在这里只要写xxx即可（也可以写完整路径名）
在Windows下，系统会根据链接库目录，搜索xxx.lib 文件，Linux下会搜索 libxxx.so 或者 libxxx.a 文件，如果都存在会优先链接动态库（so 后缀）。

如下：
target_link_libraries(${PROJECT_NAME}
    general_pb2)

安装操作

1
2
3
4
将生成的执行程序/库文件/头文件等，安装到指定路径下
INSTALL(TARGETS fcmagazine DESTINATION lib/fc_plugin)
install(FILES ../include/magazine.h DESTINATION include/magazine)
install(FILES ../include/magazine_utility.h DESTINATION include/magazine)

搜索所有的cpp文件

1
2
3
4
5
6
7
aux_source_directory(dir VAR) 
发现dir目录下所有的源代码文件并将列表存储在变量VAR中。

如下：
搜索当前目录下的所有.cpp文件，然后编译生成库
aux_source_directory(. SRC_LIST) 
add_library(demo ${SRC_LIST})

自定义搜索规则

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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})

递归搜索
file(GLOB_RECURSE SRC_LIST "*.cpp")
相对protocol目录下搜索
FILE(GLOB SRC_PROTOCOL RELATIVE "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})

查找指定的库文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
find_library(VAR name path)查找到指定的预编译库，并将它的路径存储在变量中。

默认的搜索路径为 cmake 包含的系统库，因此如果是 NDK 的公共库只需要指定库的 name 即可。
find_library( # Sets the name of the path variable.
              log-lib
              # Specifies the name of the NDK library that
              # you want CMake to locate.
              log )

类似的命令还有 find_file()、find_path()、find_program()、find_package()。

比如
FIND_PACKAGE(wxWidgets REQUIRED core base adv)
INCLUDE(${wxWidgets_USE_FILE})

if…elseif…else…endif

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
逻辑判断和比较：
if (expression)：expression 不为空（0,N,NO,OFF,FALSE,NOTFOUND）时为真
if (not exp)：与上面相反
if (var1 AND var2)
if (var1 OR var2)
if (COMMAND cmd)：如果 cmd 确实是命令并可调用为真
if (EXISTS dir) if (EXISTS file)：如果目录或文件存在为真
if (file1 IS_NEWER_THAN file2)：当 file1 比 file2 新，或 file1/file2 中有一个不存在时为真，文件名需使用全路径
if (IS_DIRECTORY dir)：当 dir 是目录时为真
if (DEFINED var)：如果变量被定义为真
if (var MATCHES regex)：给定的变量或者字符串能够匹配正则表达式 regex 时为真，此处 var 可以用 var 名，也可以用 ${var}
if (string MATCHES regex)


数字比较：
if (variable LESS number)：LESS 小于
if (string LESS number)
if (variable GREATER number)：GREATER 大于
if (string GREATER number)
if (variable EQUAL number)：EQUAL 等于
if (string EQUAL number)


字母表顺序比较：
if (variable STRLESS string)
if (string STRLESS string)
if (variable STRGREATER string)
if (string STRGREATER string)
if (variable STREQUAL string)
if (string STREQUAL string)


如下：
if(MSVC)
    set(LINK_LIBS common)
else()
    set(boost_thread boost_log.a boost_system.a)
endif()
target_link_libraries(demo ${LINK_LIBS})

if(UNIX)
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fpermissive -g")
else()
    add_definitions(-D_SCL_SECURE_NO_WARNINGS
    D_CRT_SECURE_NO_WARNINGS
    -D_WIN32_WINNT=0x601
    -D_WINSOCK_DEPRECATED_NO_WARNINGS)
endif()
 
if(${CMAKE_BUILD_TYPE} MATCHES "debug")
    ...
else()
    ...
endif()

while…endwhile循环

1
2
3
while(condition)
...
endwhile()

foreach…endforeach循环

1
2
3
4
5
6
7
8
9
10
foreach(loop_var RANGE start stop [step])
    ...
endforeach(loop_var)
start 表示起始数，stop 表示终止数，step 表示步长，示例：

如下
foreach(i RANGE 1 9 2)
    message(${i})
endforeach(i)
输出：13579

预定义变量

1
2
3
4
5
6
7
8
9
10
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：重新定义目标链接库文件的存放位置

读写环境变量

1
2
3
4
5
6
7
使用环境变量
$ENV{Name}


写入环境变量
set(ENV{Name} value) 
注意：这里没有“$”符号

系统信息

1
2
3
4
5
6
7
8
9
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

主要开关选项

1
2
3
4
5
6
7
BUILD_SHARED_LIBS：这个开关用来控制默认的库编译方式，如果不进行设置，使用 add_library 又没有指定库类型的情况下，默认编译生成的库都是静态库。如果 set(BUILD_SHARED_LIBS ON) 后，默认生成的为动态库

CMAKE_C_FLAGS：设置 C 编译选项，也可以通过指令 add_definitions() 添加

CMAKE_CXX_FLAGS：设置 C++ 编译选项，也可以通过指令 add_definitions() 添加

add_definitions(-DENABLE_DEBUG -DABC) ：添加编译选项，参数之间用空格分隔

参考链接

https://blog.csdn.net/AgingMoon/article/details/123307248
//几乎全部摘抄自此链接

赏

谢谢鼓励
阅读量()

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

春日赏花撸猫<br>夏日饮茶撸猫<br>秋日看书撸猫<br>冬日玩雪撸猫<br>