【CMake编译】基础知识、流程结构、CMakeLists.txt命令、程序运行

CMake编译

Make工具

  • 主要用来管理C/C++项目。
  • 当源代码文件较多且有较多依赖时,通过Makefile书写的规则来对项目中的源代码文件进行编译,生成可执行的程序。
  • 如: Visual C++的 nmake、linux 下的 GNU make、Qt 的 qmake 等;
  • 使用make命令-make寻找当前目录下的Makefile文件,根据Makefile中指明的命令重新编译生成文件。

CMake

CMake可以看成一款自动生成Makefile的工具,编译和源代码分离 ,主要需要编写CMakelist.txt文件。

编译流程

【CMake编译】基础知识、流程结构、CMakeLists.txt命令、程序运行_第1张图片

  1. CMakelists.txt文件放在工程目录下;
  2. cmake命令指向CMakelists.txt文件所在目录;
  3. 创建build文件夹存放cmake生成的大量中间文件,同时在build里生成Makefile文件;
  4. make根据makefile文件编译程序。

项目结构

  • build 构建项目中间文件
  • include 包含放置头文件
  • lib 保存编译生成的库
  • src 源代码实现文件

CMakelist.txt

用于指导CMake工具生成构建脚本

注:

  • 命令(名称、小括号、参数且空格间隔)、注释(#)、空格组成;
  • 命令不区分大小写。

示例

基本命令

# cmake的最低版本要求
cmake_minimum_required(VERSION 3.4)

# 工程名称
project(Demo)

# 生成可执行文件demo
add_executable(demo demo.cpp)

其他命令

编译类型设置

# 生成可执行文件
add_executable(demo demo.cpp) 

# 生成静态库
add_library(common STATIC util.cpp) 

# 生成动态库或共享库
add_library(common SHARED util.cpp) 

注:add_library 默认生成静态库,在win下生成:

  • demo.exe
  • common.lib
  • common.dll

指定源文件

# 明确指定包含的源文件
add_library(demo demo.cpp test.cpp util.cpp)

# 搜索当前目录下的所有.cpp文件
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})
	# 或者
aux_source_directory(. SRC_LIST)
aux_source_directory(protocol SRC_PROTOCOL_LIST)
add_library(demo ${SRC_LIST} ${SRC_PROTOCOL_LIST})

# 搜集文件
file(GLOB files  LIST_DIRECTORIES false *)

查找指定的库文件

find_library( # 查找到指定的预编译库,并将它的路径存储在变量中
              log-lib
 
              # 默认的搜索路径为 cmake 包含的系统库,因此如果是 NDK 的公共库只需要指定库的 name 即可
              log )

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

设置包含的目录

include_directories(
    ${CMAKE_CURRENT_SOURCE_DIR}
    ${CMAKE_CURRENT_BINARY_DIR}
    ${CMAKE_CURRENT_SOURCE_DIR}/include
)

设置链接库搜索目录

link_directories(${CMAKE_CURRENT_SOURCE_DIR}/libs)

设置target需要链接的库

target_link_libraries( # 目标库
                       demo
 
                       # 目标库需要链接的库
                       # 上面 find_library 指定的变量名
                       ${log-lib} )

设置变量

set(SRC_LIST main.cpp)
set(SRC_LIST ${SRC_LIST} test.cpp) # 追加设置变量的值
list(APPEND SRC_LIST test.cpp) 
list(REMOVE_ITEM SRC_LIST main.cpp) # 追加或删除变量
add_executable(demo ${SRC_LIST})

条件控制

逻辑判断和比较:
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)
while(condition)
    ...
endwhile()
foreach(loop_var RANGE start stop [step])
    ...
endforeach(loop_var)

打印信息

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

包含其他cmake文件

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

常用变量

预定义

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:重新定义目标链接库文件的存放位置

环境变量

# 使用环境变量
$ENV{Name}

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

系统信息

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

开关选项

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) # 参数之间用空格分隔

CMakelists.txt常用命令参考

CMake-gui

下载安装:
https://cmake.org/download/
https://cmake.org/files/
https://cmake.org/files/v3.16/

【CMake编译】基础知识、流程结构、CMakeLists.txt命令、程序运行_第2张图片

使用:

  1. 创建build文件夹;
  2. CMake-gui程序配置文件路径( src:源文件目录、build目录);
  3. Configure;
  4. vs 2015、x64;
  5. Generate;
  6. Open project 编译。

你可能感兴趣的:(CMake,c++)