linux编程 —— vscode 开发编译 CMakeList.txt 学习笔记

文档声明：
以下资料均属于本人在学习过程中产出的学习笔记，如果错误或者遗漏之处，请多多指正。并且该文档在后期会随着学习的深入不断补充完善。感谢各位的参考查看。

---

笔记资料仅供学习交流使用，转载请标明出处，谢谢配合。
如果存在相关知识点的遗漏，可以在评论区留言，看到后将在第一时间更新。
作者：Aliven888

1、简介

  cmake 是一个跨平台、开源的构建系统。它是一个集软件构建、测试、打包于一身的软件。它使用与平台和编译器独立的配置文件来对软件编译过程进行控制。

  编写 CMakeLists.txt 最常用的功能就是调用其他的 .h头文件 和 .so/.a库文件，将 .cpp/.c/.cc 文件编译成可执行文件或者新的库文件。

  在 CMakeList.txt 中会自动生成以下若干变量：

1. PROJECT_SOURCE_DIR ： CMakeList.txt 所在的文件夹路径
2. PROJECT_BINARY_DIR：运行 cmake 命令的目录，通常是 ${PROJECT_SOURCE_DIR}/build
3. PROJECT_NAME： 本CMakeLists.txt的project名称，由project 参数决定
4. CMAKE_BUILD_TYPE： CMAKE_BUILD_TYPE 构建类型（Debug & Release）
5. CMAKE_CURRENT_SOURCE_DIR：这是当前处理的CMakeLists.txt所在的目录
6. CMAKE_CURRENT_BINARY_DIR：target 编译目录
7. CMAKE_CURRENT_LIST_DIR：CMakeLists.txt 的完整路径
8. CMAKE_ARCHIVE_OUTPUT_DIRECTORY：默认存放静态库的文件夹位置；
9. CMAKE_LIBRARY_OUTPUT_DIRECTORY： 默认存放动态库的文件夹位置；
10. LIBRARY_OUTPUT_PATH： 重新定义目标链接库文件的存放位置，如果产生的是静态库并且没有指定 CMAKE_ARCHIVE_OUTPUT_DIRECTORY 则存放在该目录下，动态库也类似；
11. CMAKE_RUNTIME_OUTPUT_DIRECTORY： 存放可执行软件的目录；
12. CMAKE_MODULE_PATH：定义自己的 cmake 模块所在的路径，SET(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)，然后可以用INCLUDE命令来调用自己的模块
13. EXECUTABLE_OUTPUT_PATH：重新定义目标二进制可执行文件的存放位置

  可以通过 $ 符号使用这两个变量。（列如：${PROJECT_SOURCE_DIR} 、 ${PROJECT_NAME}）。

2、CMakeList.txt 语法

2.1、版本，项目名称，系统信息

#  指定 cmake 的最小版本
cmake_minimum_required(VERSION 2.8)  # cmake 版本号要求, 通常在 CMakeList.txt 文件的第一行

# 这个命令不是强制性的，但最好都加上。
# 它会引入两个变量 demo_BINARY_DIR 和 demo_SOURCE_DIR，同时，
# cmake 自动定义了两个等价的变量 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR
project(alivenProject) # 设置项目工程文件名称，可以任取， 其值可以通过 ${PROJECT_NAME} 获取。

注意事项：
  看了好多网上的文章，都说PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR是等价的；实际不然；一般来说，都是这样用

cmake ./

这样PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR是等价的。也就是当前源码的目录。

如果执行cmake的时候，并不在源码的路径的话，比如

cmake ../src

这样的好处是 cmake 生成的文件和编译出来的东西，就不放在源码路径下了，保证了源码路径的干净整洁。

比如可以在src的同级目录下建立 build 目录。

然后在build目录下执行

cmake ../src。

这样编译出来的东西和 cmake 生成的东西，都放到了 build 目录下了。并且

PROJECT_BINARY_DIR = 全路径/build

PROJECT_SOURCE_DIR = 全路径/src

系统信息：

­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

2.2、set / list 设置别名（赋值）

  给文件名/路径名或其他字符串起别名， 简单可以理解为变量赋值。

set(value 文件名/路径/...)  # ，用 ${value} 获取变量内容

# eg1: set直接设置变量的值:
set(SRC_LIST main.cpp test.cpp)
add_executable(demo ${SRC_LIST})

#eg2: set 追加设置变量的值
set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp)
add_executable(demo ${SRC_LIST})

list 追加或者删除变量的值:

eg:
set(SRC_LIST main.cpp)
list(APPEND SRC_LIST test.cpp)
list(REMOVE_ITEM SRC_LIST main.cpp)
add_executable(demo ${SRC_LIST})

2.3、message 打印消息

  打印需要输出消息，可以采用 message 来实现。

message("xxx" : ${value})

eg:
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 会导致编译失败

2.4、Release & Debug 编译模式

  可以用来设置编译模式。

IF(NOT CMAKE_BUILD_TYPE)  # CMAKE_BUILD_TYPE 构建类型
  SET(CMAKE_BUILD_TYPE Release)  # 设置为 release 模式编译
  # set(CMAKE_BUILD_TYPE debug)  # 设置为 debug 模式编译
ENDIF()
MESSAGE("current build type is :  " ${CMAKE_BUILD_TYPE})

2.5、add_definitions 添加编译选项

  添加编译选项, 调试阶段 和 发布阶段的参数设置存在差异。

1. BUILD_SHARED_LIBS：这个开关用来控制默认的库编译方式，如果不进行设置，使用 add_library 又没有指定库类型的情况下，默认编译生成的库都是静态库。如果 set(BUILD_SHARED_LIBS ON) 后，默认生成的为动态库。
2. CMAKE_C_FLAGS：设置 C 编译选项，也可以通过指令 add_definitions() 添加。
3. CMAKE_CXX_FLAGS：设置 C++ 编译选项，也可以通过指令 add_definitions() 添加。

add_definitions(编译选项)  # 编译选项 -g -c -o -S -Wall 等

# eg:
add_definitions("-Wall -g -o2")  # 设置编译选项
add_definitions(-std=c++14) # 设置 C++ 版本

add_definitions(-DENABLE_DEBUG -DABC) # 参数之间用空格分隔

2.6、aux_source_directory 搜索所有的 cpp 文件

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

aux_source_directory(路径 变量<集合>)

aux_source_directory(. SRC_LIST) # 搜索当前目录下的所有.cpp文件
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})
# 或者
file(GLOB_RECURSE SRC_LIST "*.cpp") #递归搜索
FILE(GLOB SRC_PROTOCOL 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})

2.7、add_subdirectory 编译子文件夹

  编译 子文件夹 中的CMakeList.txt 文件。

add_subdirectory(子文件夹名称) 

# eg:
add_subdirectory(test)  # 编译子文件夹 test

2.8、add_library 生成静态库 / 共享库 (.a / .so)

  在 Linux 中, 库文件分成静态库和共享库两种。静态库以 .a 作为后缀名,共享库以 .so 结尾。所有库都是一些函数打包后的集合,差别在于静态库每次被调用都会生成一个副本,而共享库则只有一个副本,更省空间。

add_library(静态库文件名称<xxx> STATIC xxx.cpp/.c<编译的目标文件>) #  编译后，我们就能得到一个 libxxx.a 的静态库文件

add_library(动态（共享）库名称<xxx_shared> SHARED xxx.cpp/.c<编译的目标文件>) # 编译后，我们就能得到一个 libxxx_shared.so 的静态库文件

# eg:
add_library(alienPro STATIC alivenPro.cpp)  # 将目标文件 alivenPro.cpp 编译成静态库 libalivenPro.a 

add_library(alienPro_shared SHARED alivenPro.cpp)  # 将目标文件 alivenPro.cpp 编译成静态库 libalivenPro_shared.so

注意：
1、静态库 与 共享库都使用 add_library 来生成的， 唯一区别在于第二个参数（指定了 STATIC 或者 SHARED ）。
2、最终生成的库文件名称通常为 libxxx.a 或者 libxxx_shared.so，编译指定名称是，只需要写 xxx 即可 。
3、add_library 默认生成是静态库，通过以上命令生成文件名字，

	在 Linux 下是：
	demo
	libcommon.a
	libcommon.so
	
	在 Windows 下是：
	demo.exe
	common.lib
	common.dll

2.9、add_executable 生成可执行文件

  将 .cpp/.c 文件生成可执行文件(类似于 windows 中的 xxx.exe 文件)。

// main.cpp
#include 
#include    //xxx库 头文件
int main(int argc, char *argv[])
{
	printf("hello world.");

	//调用 xxx 库接口（省略）

	return 0;
}

add_executable(可执行文件名称 文件)

# eg :
add_executable(main mian.cpp) # 生成名称为 main 可执行文件

2.10、include_directories 设置包含的目录

include_directories(路径)  # 所在目录,头文件(.h) 所在路径

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

2.11、link_directories 配置 .so/.a库文件路径

link_directories(路径)  # 所在目录

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

eg:
link_directories(${CMAKE_CURRENT_SOURCE_DIR}/libs)

2.12、target_link_libraries 库文件链接

  对 add_library 或 add_executable 生成的文件进行链接操作。在 Windows 下，系统会根据链接库目录，搜索xxx.lib 文件，Linux 下会搜索 xxx.so 或者 xxx.a 文件，如果都存在会优先链接动态库（so 后缀）。

注意，库文件名称通常为 libxxx_shared.so，在这里只要写 xxx_shared 即可。

target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称)


# eg :
add_library(alienPro_shared SHARED alivenPro.cpp)  # 将目标文件 alivenPro.cpp 编译成静态库 libalivenPro_shared.so
add_executable(main mian.cpp) # 生成名称为 main 可执行文件
target_link_libraries(main alienPro_shared) # 通过这句指令， mian 就能顺利使用 alienPro_shared 库中的代码了

# target_link_libraries(main ${CMAKE_CURRENT_SOURCE_DIR}/alienPro_shared) # 也可以指定全路径
# target_link_libraries(main ${CMAKE_CURRENT_SOURCE_DIR}/alienPro_shared1 alienPro_shared2) # 也可以指定多个库，空格分割即可

2.13、set_target_properties

# 按照一般的习惯，静态库名字跟动态库名字应该是一致的，只是扩展名不同；

# 即：静态库名为 libhello.a； 动态库名为libhello.so ；

# 所以，希望 "hello_static" 在输出时，不是"hello_static"，而是以"hello"的名字显示，故设置如下：

SET_TARGET_PROPERTIES (hello_static PROPERTIES OUTPUT_NAME "hello")

 

GET_TARGET_PROPERTY (OUTPUT_VALUE hello_static OUTPUT_NAME)

MESSAGE (STATUS "This is the hello_static OUTPUT_NAME: " ${OUTPUT_VALUE})

 

# cmake在构建一个新的target时，会尝试清理掉其他使用这个名字的库，

# 因此，在构建libhello.a时，就会清理掉libhello.so.

# 为了回避这个问题，比如再次使用SET_TARGET_PROPERTIES定义 CLEAN_DIRECT_OUTPUT属性。

SET_TARGET_PROPERTIES (hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

SET_TARGET_PROPERTIES (hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)

 

# 按照规则，动态库是应该包含一个版本号的，

# VERSION指代动态库版本，SOVERSION指代API版本。

SET_TARGET_PROPERTIES (hello PROPERTIES VERSION 1.2 SOVERSION 1)

2.14、option 自定义编译选项

  cmake 允许为项目增加编译选项，从而可以根据用户的环境和需求选择最合适的编译方案。

  例如，可以将 AlivenMathFunc 库设为一个可选的库，如果该选项为 ON ，就使用该库定义的数学函数来进行运算，否则就调用标准库中的数学函数库。

实例源码：

//修改 main.cc 文件，让其根据 USE_ALIVENMATHLIB 的预定义值来决定是否调用标准库还是 AlivenMathFunc 库：
#include "config.h"
#ifdef USE_ALIVENMATHLIB
    #include "AlivenMathFunc.h"
#else
    #include 
#endif
 
int main(int argc, char *argv[])
{
    if (argc < 3){
        printf("Usage: %s base exponent \n", argv[0]);
        return 1;
    }
    double base = atof(argv[1]);
    int exponent = atoi(argv[2]);
 
#ifdef USE_ALIVENMATHLIB
    printf("Now we use our own Math library. \n");
    double result = power(base, exponent);
#else
    printf("Now we use the standard library. \n");
    double result = pow(base, exponent);
#endif
    printf("%g ^ %d is %g\n", base, exponent, result);
    return 0;
}

CMakeLists.txt 脚本：

方式一：

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (AlivenDemo)

# 加入一个配置头文件，用于处理 CMake 对源码的设置
# configure_file 命令用于加入一个配置头文件 config.h ，这个文件由 cmake 从 config.h.in 生成，通过这样的机制，将可以通过预定义一些参数和变量来控制代码的生成。
configure_file (
    "${PROJECT_SOURCE_DIR}/config.h.in"
    "${PROJECT_BINARY_DIR}/config.h"
    )
# 是否使用自己的 AlivenMathFunc 库
# option 命令添加了一个 USE_MYMATH 选项，并且默认值为 ON 。
# 根据 USE_ALIVENMATHLIB 变量的值来决定是否使用我们自己编写的 AlivenMathFunc 库。
option (USE_ALIVENMATHLIB "Use provided math implementation" ON)
# 是否加入 AlivenMathFunc 库
if (USE_ALIVENMATHLIB)
    include_directories ("${PROJECT_SOURCE_DIR}/math")
    add_subdirectory (math)
    set (EXTRA_LIBS ${EXTRA_LIBS} AlivenMathFunc)
endif (USE_ALIVENMATHLIB)
# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
# 指定生成目标
add_executable(Demo ${DIR_SRCS})
target_link_libraries (Demo ${EXTRA_LIBS})

编写 config.h.in 文件

  注意 main.cc 的第一行，这里引用了一个 config.h 文件，这个文件预定义了 USE_ALIVENMATHLIB 的值。但我们并不直接编写这个文件，为了方便从 CMakeLists.txt 中导入配置，我们编写一个 config.h.in 文件，内容如下：

# config.h.in 
#cmakedefine USE_ALIVENMATHLIB

  这样 cmake 会自动根据 CMakeLists.txt 配置文件中的设置自动生成 config.h 文件。

方式二：

// 操作代码
#include 
int main()
{
#ifdef ALIVEN_VSOMEIP_METHOD
	printf("ALIVEN_VSOMEIP_METHOD \n");
#elif ALIVEN_VSOMEIP_EVENT
	printf("ALIVEN_VSOMEIP_EVENT \n");
#else
	printf("其他模式 \n");
#endif
	return 0；
}

# CMakeLists.txt 脚本

option(VSOMEIP_METHOD "method" OFF)    # mothod 通信方式
option(VSOMEIP_EVENT "event" ON)     # Event 通信方式

if(${VSOMEIP_METHOD})
    add_definitions(-DALIVEN_VSOMEIP_METHOD)  # 定义 ALIVEN_VSOMEIP_METHOD, 此处必须加 -D
    message("Aliven method open.")
elseif(${VSOMEIP_EVENT})
    add_definitions(-DALIVEN_VSOMEIP_EVENT) # 定义 ALIVEN_VSOMEIP_EVENT, 此处必须加 -D
    message("Aliven event open.")
else()
    message("Aliven method and event all not open.")
endif()

2.15、find_library 查找指定的库文件

  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()。

2.16、if…elseif…else…endif 条件控制

逻辑判断和比较：

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)

eg:

if(MSVC)
    set(LINK_LIBS common)
else()
    set(boost_thread boost_log boost_system)
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()

2.17、 while…endwhile

while(condition)
    ...
endwhile()

2.18、 foreach…endforeach

foreach(loop_var RANGE start stop [step])
    ...
endforeach(loop_var)

start 表示起始数，stop 表示终止数，step 表示步长，示例：

foreach(i RANGE 1 9 2)
    message(${i})
endforeach(i)

3、一个完整的 CMakeList.txt 文件

cmake_minimum_required(VERSION 2.8)  # 必须 cmake 版本号要求

project(alivenProject) # 必须 设置项目工程文件名称，可以任取， 其值可以通过 ${PROJECT_NAME} 获取。

add_subdirectory(子文件夹名称)                           #父目录必须，子目录不必

add_library(库文件名称 STATIC/SHARED 文件)               #通常子目录(二选一)  加载生成库
add_executable(可执行文件名称 文件)                       #通常父目录(二选一)

include_directories(路径)                              #必须  包含头文件 .h
link_directories(路径)                                 #必须  包含库文件 .a .so

target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称)       #必须 链接库文件