https://github.com/qwli7/cmake

cmake 学习教程
https://github.com/qwli7/cmake

cmake cmakelists cpp cpp11

Last synced: 10 months ago
JSON representation

cmake 学习教程

• Host: GitHub
• URL: https://github.com/qwli7/cmake
• Owner: qwli7
• Created: 2025-02-11T02:05:57.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2025-03-18T12:59:01.000Z (10 months ago)
• Last Synced: 2025-03-18T13:47:21.225Z (10 months ago)
• Topics: cmake, cmakelists, cpp, cpp11
• Language: CMake
• Homepage:
• Size: 26.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## `CMake` 官方学习文档

翻译采用个人习惯进行翻译

- [Step01 一个基本的入口点](Step01/README.md)

- [Step02 添加库](Step02/README.md)

- [Step03 添加库的使用依赖](Step03/README.md)

## `CMake` 命令行工具

安装好 `CMake` 后，将 `bin` 目录添加到环境变量中，通过 `cmake --version` 来验证是否安装成功 

### 生成工程

进入到顶层 `CMakeLists.txt` 文件夹下，执行 `cmake .` 指令（默认生成的是 `VS` 工程代码，如果你的电脑上安装了 `VS`）

```shell

cmake .

```

### 指定生成平台

通过 `-G` 选项，可以指定生成平台，例如生成 `MinGW Makefiles`

```shell

cmake . -G "MinGW Makefiles"

```

### 构建

利用生成的工程进行构建

```shell

cmake --build .  

```

其他命令可以通过 `cmake --help` 查看具体的用法

## `CMake` 常用指令

[CMake命令官网地址](https://cmake.org/cmake/help/latest/manual/cmake-commands.7.html)

- `cmake_minimum_required(VERSION )` 指定运行此 `CMakeLists.txt` 文件的最低 `CMake` 版本

- `project( [ ...])` 设定项目名称和语言，也可设置版本号等，运行时会设置 `CMAKE_PROJECT_NAME` 属性

    - 执行后，内置四种变量

        - `_VERSION_MAJOR` 主版本

        - `_VERSION_MINOR` 次版本

        - `_VERSION_PATCH`

        - `_VERSION_TWEAK`  

    ```cmake

    # project( [VERSION [.[.[.]]]])

    # 执行后，内置四种变量

    project(cmake_demo VERSION 3.1.2.1)

    message(STATUS ${${CMAKE_PROJECT_NAME}_VERSION_MAJOR}) #3

    message(STATUS ${${CMAKE_PROJECT_NAME}_VERSION_MINOR}) #1

    message(STATUS ${${CMAKE_PROJECT_NAME}_VERSION_PATCH}) #2

    message(STATUS ${${CMAKE_PROJECT_NAME}_VERSION_TWEAK}) #1

    ```

- `add_executable( ...)` 指定要生成的可执行文件和源文件

    ```cmake

        add_executable(MyExecutable main.cpp other_file.cpp)

    ```

- `add_library( ...)` 创建一个库文件（静态库或者动态库，默认是静态库）

    ```cmake

    add_library(MyLibrary STATIC library.cpp) #静态库，不指定 STATIC，也默认为 STATIC

    add_library(MyLibrary SHARED library.cpp) #共享库，动态库

    #可以定义 BUILD_SHARED_LIBS 这个属性，告诉 cmake 当这个属性开启时，不指定会默认构建成动态库

    option(BUILD_SHARED_LIBS "Building using shared libraries" ON) 

    ```

- `target_link_libraries( ...)`  链接目标文件和其他库

    ```cmake

    target_link_libraries(MyExecutable MyLibrary) 

    ```

- `include_directories(...)` 添加头文件搜索路径

    - 使用该属性后，目录会被填充到 `INCLUDE_DIRECTORIES` 中，生成器将使用该属性为编译器设置包含目录（头文件目录）

    - 推荐使用 `target_include_directories()` 替代，可以设置依赖关系

    ```cmake

    include_directories(${PROJECT_SOURCE_DIR}/include)

    ```

- `target_include_directories(  [items1...]  [items2...]...)` 给目标添加包含目录

    - 编译给定的目标时，指定包含目录；多次调用会被追加

    - `target` 必须是被 `add_executable()` 或者 `add_library()` 命令创建的对象

    - `PUBLIC` `INTERFACE` `PRIVATE` 指明了后面参数传递的范围

 

- `set( ...)` 设置变量的值

- `option( "" [value])` 提供一个选项值，OFF是默认值，该值一旦被设置后，将会被缓存；

- `configure_file( )` 从 input 拷贝文件到 output，

    - input 路径是从 `CMAKE_CURRENT_SOURCE_DIR` 开始

    - output 输出路径默认是从 `CMAKE_CURRENT_BINARY_DIR` 处理，可以指定输出路径

    ```cmake

    configure_file(common.h.in, common.h); //common.h 放置到可执行文件同级目录

    configure_file(common.h.in, "include/common.h"); //可执行文件创建文件夹

    ```

- `message([] "message text...")` 打印日志，`mode` 通常设置为 `STATUS` 即可，常见的可以参考 [message mode 定义](https://cmake.org/cmake/help/latest/command/message.html)

    ```cmake

    message(STATUS "hello world"); //打印消息

    ```

- `aux_source_directory( )` 查找源文件，指定的目录中  

    ```cmake

    aux_source_directory(. SRC_LIST) # 从当前的目录中，查找所有的源文件，放到 SRC_LIST 中

    message(STATUS ${SRC_LIST})

    ```

- `add_subdirectory(source_dir [binary_dir])`  向生成添加一个子目录，默认添加到可执行文件的生成目录中

    ```cmake

    # MyFunctions/CMakeLists.txt 中

    add_library(MyFunc STATIC myfunction.cpp) # 添加一个静态库

    target_include_directories(MyFunc INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}) # 默认把头文件也包含进去

    

    # CMakeLists.txt

    add_subdirectory(MyFunctions) # 把 MyFunctions 这个目录添加到可执行文件目录下

    add_executable(cmake_project main.cpp)

    target_link_libraries(cmake_project MyFunc) #链接 MyFunc 这个库，给可执行文件

    ```

-  `target_compile_features(   [....])` 给编译器提供特征

    ```cmake

    # 这里的设置是全局的，假设我这里设置了标准为 11 ，但是代码中使用 17 提供的 string_view，构建就会报错

    # set(CMAKE_CXX_STANDARD 11)

    # set(CMAKE_CXX_STANDARD_REQUIRED true)

    ```