cmake系列教程之基本功

本教程为系列纯干货教程，内容原创，持续更新，欢迎关注转发

cmake_cross_platform.jpg

废话少说，直接干货。上面这张图可知cmake是可跨平台的编译工具，当公司一套代码运行到多平台的时候，比如：android，ios，windows，linux可以同时用cmake做编译。当然不同平台需要配置不同的编译环境，比如：android需要配置ndk，ios需要配置xcode，这个配置后续会持续输出，欢迎关注，今天先说基本的命令。

本文内容从简入繁，最后是一个小项目完整示例
本系列教程从本篇基本功开始，欢迎持续关注

cmake.jpg

cmake语法与shell语法类似，但是大小写都支持

命令名称(<必选>[可选])

project

项目的基础设置

project(<PROJECT-NAME> [LANGUAGES] [<language-name>...])
project(<PROJECT-NAME>
        [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
        [LANGUAGES <language-name>...])

• PROJECT-NAME必选项，给项目起的名字
• LANGUAGES可选项
  • C
  • CXX

示例1

project(test C) 

示例2

# 项目信息
project( demo1
         VERSION 1.2.3
         DESCRIPTION "项目描述，比如：本项目非常牛逼"
         HOMEPAGE_URL "项目地址，比如：https://github.com/XXX/YYY"
         LANGUAGES CXX
        )

set

set 命令是对一个变量的赋值，这个变量可以是cmake自带的，也可以是自定义的

set 系统自带的变量

set( CMAKE_CXX_FLAGS "-std=c++11" )//以flags的形式的实现通知使用版本
set(CMAKE_CXX_STANDARD 11)//以命令形式通知使用版本

set自定义的变量

set(THIRD_PART "${CMAKE_CURRENT_SOURCE_DIR}/src/third/include")//设置头文件的搜索路径
include_directories(${THIRD_PART})

add_definitions

添加一个flag用于预处理，其实就是添加一个宏定义

add_definitions(-DFOO -DBAR ...)

添加方式有两种：

• -D开头
• /D开头

示例:

比如，你在代码中可能有如下写法：

#ifdef TEST
//TODO if
#else
//TODO else
#endif

那么如何不修改代码而是通过编译脚本控制这个宏呢，这就使用到了本命令：add_definitions，如下所示

add_definitions("-DTEST")

此时这个TEST宏会在预处理阶段与源码结合。

include_directories

指定包含的头文件的搜索路径

include_directories([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])

• dir指定路径：我们通过参数可以发现：路径至少一个，可以有多个，多个路径以空格分隔
• AFTER|BEFORE 指定搜索顺序：默认是当前路径的后面，即after。这里可以修改为before，即：在当前头文件搜索之前进行搜索。
• SYSTEM:正如名字含义，这个是指定具体某一个系统平台的头文件，比如：windows特有的mfc

注意：路径中有空格，则需要用双引号将其括起来

aux_source_directory

将某目录下的所有的源码文件设定一个变量名称，便于后期使用变量名代替所有的源码文件，比如与add_library生成静态库一并使用，以便指定子构建系统的构建的库类型和名称。

aux_source_directory(<dir> <variable>)

• dir 必选项，是源码路径
• variable 是给这组源码设定的变量名

结合使用命令

• add_library：指定子构建系统编译类型，子构建通常会编译成库文件，比如.a

示例:

aux_source_directory(. DIR_LIB_SRC)
add_library(mylib STATIC ${DIR_LIB_SRC})

解析：将本目录下的所有的源码文件设置为变量DIR_LIB_SRC，然后构建一个动态库。

add_library

将源码编译成指定的库（类型+名称）

add_library(<name> [STATIC | SHARED | MODULE]
            [EXCLUDE_FROM_ALL]
            [source1] [source2 ...])

• name是库名称，必须指定
• STATIC | SHARED | MODULE 是库类型，注意这里是大写
• source 是源码文件

生成library的目的和作用

• 对外提供库文件
• 提供库文件供顶层目录使用

结合使用命令

• aux_source_directory
• target_link_libraries

示例1.1:对外提供库文件之android将源码编译成动态库

add_library(
        # Specifies the name of the library.
        libDemo

        # Sets the library as a shared library.
        SHARED

        # Provides a relative path to your source file(s).
        src/main/jni/test1.cpp
        src/main/jni/test2.cpp
        src/main/jni/test3.cpp
)

示例1.2:对外提供库文件之android将源码编译成动态库与aux_source_directory结合使用

aux_source_directory(./src/main/jni custom)
add_library(
        # Specifies the name of the library.
        libDemo

        # Sets the library as a shared library.
        SHARED

        # Provides a relative path to your source file(s).
        ${custom}
)

示例1.3:对外提供库文件之非android示例

与android示例本质上一样都属于子构建系统，区别是：android没有顶层构建直接与jni通信，非android有顶层构建通过add_subdirectory添加本子构建系统

aux_source_directory(. SUBLIB1_SRC)
add_library(subLib1 ${SUBLIB1_SRC})

示例2:与target_link_libraries结合执行顶级构建

add_library与target_link_libraries结合构建顶级编译系统，通常是为了对外提供的是库文件，比如android的构建

aux_source_directory(./ TOP_SRCS)
add_library(libraryLink SHARED ${TOP_SRCS})
target_link_libraries(
    libraryLink
)

add_subdirectory

多编译系统，即多个CMakeList.txt，非顶级的构建都属于子构建系统。子构建系统是通过add_library生成构建库文件的，但是顶级构建怎么关联子构建系统呢，就用到了本命令。

Add a subdirectory to the build.

add_subdirectory(source_dir [binary_dir]
                 [EXCLUDE_FROM_ALL])

• source_dir：子编译系统目录
• binary_dir：如果source_dir不是当前（CMakeList.txt）目录,那么需要显示指定binary_dir的值，binary_dir是用于指定source_dir经过编译后的输出文件的目录
• EXCLUDE_FROM_ALL 将指定目录排除编译

示例:

add_subdirectory(./subLib1)

注意：本命令的唯一的一个必选项是子编译系统目录，子编译系统目录，而非子编译系统生成的库名称

target_link_libraries

链接所有的library，子编译系统，库文件

• library：add_library
• 子编译系统：add_subdirectory
• 库文件：静态库文件.a和动态库文件.so

示例:

cmake_minmum_required(VERSION 3.4.1)
project(linkDemo CXX)
//1. 添加子编译系统
add_subdirectory(./sublib)
//2. 顶级编译系统
aux_source_directory(./ TOP_SRCS)
add_executable(linkDemo ${TOP_SRCS})
//3. 第三方库
set(THIRD_PART "${CMAKE_CURRENT_SOURCE_DIR}/src/third/include")
include_directories(${THIRD_PART})
message("third part include path = ${THIRD_PART}")
message("thrid part libs path = ${THIRD_PART}/libs/XXX.a")
//4. 链接：子系统+顶级系统+第三方库
target_link_libraries(
    linkDemo
    sublib
    "${THIRD_PART}/libs/XXX.a"
)

原创不易，添加个关注，做个转发

本系列教程未完待续，不定期更新，欢迎关注

欢迎关注公众号与我联系

image.png