CMake 简单使用

发表于 更新于 分类于 ， ，

笔记索引

CMake 简单使用

命令行

1
2
3
4
生成构建系统
 cmake [<options>] <path-to-source>
 cmake [<options>] <path-to-existing-build>
 cmake [<options>] -S <path-to-source> -B <path-to-build>
  • -D <var>:<type>=<value> 设定变量
  • -G <generator-name> 指定生成器
  • --graphviz=[file] 生成依赖图
  • -A <platform-name> 指定平台
1
2
构建一个项目
 cmake --build <dir> [<options>] [-- <build-tool-options>]

CMakeLists.txt

1
2
3
4
5
6
7
8
.
├── CMakeLists.txt
├── src
│   ├── a.c
│   └── b.c
└── include
   ├── a.h
   └── b.h
1
2
3
4
5
6
7
8
9
10
11
12
13
cmake_minimum_required(VERSION 3.10)

# 项目名称
project(Tutorial)

# 生成目标
add_executable(Tutorial src/a.c src/b.c include/a.h include/b.h)

# 链接库
target_link_libraries(Tutorial PUBLIC m)

# 链接头文件
target_include_directories(Tutorial PUBLIC include/)
  • 变量使用 ${...} 访问

基本命令

命令存在作用域，一般会以前缀方式表示，尽量避免全局函数

定义变量与属性

注意：变量是存在作用域的

  • 定义变量
1
set(<variable> <value>... [PARENT_SCOPE])
  • 定义布尔变量
1
option(<variable> "<help_text>" [value])
  • 定义对象属性
1
2
3
4
5
6
7
8
9
10
11
set_property(<GLOBAL                      |
              DIRECTORY [<dir>]           |
              TARGET    [<target1> ...]   |
              SOURCE    [<src1> ...]
                        [DIRECTORY <dirs> ...] |
                        [TARGET_DIRECTORY <targets> ...]
              INSTALL   [<file1> ...]     |
              TEST      [<test1> ...]     |
              CACHE     [<entry1> ...]    >
             [APPEND] [APPEND_STRING]
             PROPERTY <name> [<value1> ...])

file

  1. 将 <globbing-expr> 匹配内容列表存储到 <variable> 中
1
2
3
4
5
6
file(GLOB <variable>
     [LIST_DIRECTORIES true|false] [RELATIVE <path>] [CONFIGURE_DEPENDS]
     [<globbing-expressions>...])
file(GLOB_RECURSE <variable> [FOLLOW_SYMLINKS]
     [LIST_DIRECTORIES true|false] [RELATIVE <path>] [CONFIGURE_DEPENDS]
     [<globbing-expressions>...])
  • CONFIGURE_DEPENDS 会使编译工具在构建时重新读取variable

项目命令

只能在 CMake 项目内使用

project

  1. 定义项目名及属性
1
2
3
4
5
6
7
project(<PROJECT-NAME> [<language-name>...])

project(<PROJECT-NAME>
        [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
        [DESCRIPTION <project-description-string>]
        [HOMEPAGE_URL <url-string>]
        [LANGUAGES <language-name>...])

定义二进制目标（target）

  1. 可执行文件

    1
    2
    3
    add_executable(<name> [WIN32] [MACOSX_BUNDLE]
                [EXCLUDE_FROM_ALL]
                [source1] [source2 ...])
    • source 应包含头文件

  2. 库

    1
    2
    3
    add_library(<name> [STATIC | SHARED | MODULE]
                [EXCLUDE_FROM_ALL]
                [<source>...])

target_*

e.g:

  • target_include_directories()：指定目标包含的头文件路径

  • target_link_libraries()：指定目标链接的库

  • target_compile_options()：指定目标的编译选项

以

1
2
3
target_include_directories(<target>
  <INTERFACE|PUBLIC|PRIVATE> [items1...]
  [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])

为例：

  • target为add_library或add_executable创建

  • PRIVATE：私有，item仅对本级c文件可用，上级不可用

  • INTERFACE：接口，item对本级h文件可用，上级可用

  • PUBLIC：公有，等于前二者并集

变量

变量一般是全局的、cmake 预设或者用户定义的

  • ENV{NAME}: 环境变量，可set值

  • CMAKE_BUILD_TYPE：目标构建类型

  • CMAKE_SYSTEM_NAME：目标系统

  • CMAKE_SYSTEM_PROCESSOR 目标构架

  • CMAKE_<LANG>_COMPILER 指定语言编译器

  • CMAKE_C_COMPILER_TARGET 对支持指定编译目标的系统传入目标

  • CMAKE_BINARY_DIR、PROJECT_BINARY_DIR、<projectname>_BINARY_DIR：工程编译发生的目录

  • CMAKE_SOURCE_DIR、PROJECT_SOURCE_DIR、<projectname>_SOURCE_DIR: 工程顶层目录

  • CMAKE_CURRENT_SOURCE_DIR: 当前处理的 CMakeLists.txt 所在路径

  • CMAKE_SYSTEM：系统名称,比如 Linux-2.6.22

  • CMAKE_SYSTEM_NAME： 不包含版本的系统名,比如 Linux

  • CMAKE_SYSTEM_VERSION： 系统版本,比如 2.6.22

  • CMAKE_SYSTEM_PROCESSOR： 处理器名称,比如 i686.

属性

GLOBAL、DIRECTORY、TARGET等对象的属性

TARGET

  • LIBRARY_OUTPUT_DIRECTORY 库输出路径

  • LIBRARY_OUTPUT_NAME 库名称

  • RUNTIME_OUTPUT_DIRECTORY 最终二进制可执行文件输出目录

  • RUNTIME_NAME_DIRECTORY 可执行文件名称

  • C_STANDARD C 语言标准

  • CXX_STANDARD C++语言标准