CMake学习4 - 炉火纯青

一、内容概述

本篇为这一系列的最后一篇,cmake 内容较多,掌握这四篇可应付常规的项目需求。

标准工程
所谓的 “标准工程” 是指发布结构符合如下标准的工程:

  • 头文件位于 "/usr/local/include"
  • 库文件位于 “/usr/local/lib”
  • 可执行文件 “/usr/local/bin”

这种发布方式多适用于作为标准库或第三方库发布。
优点:第三方开发者引用头文件和库文件时非常方便。
缺点:当遇到同名或不同版本库时,可能误引用其它库文件。

发布工程
所谓的 “发布工程” 是指类似 Qt 等涉及共享库、可执行程序等,所需的库文件和头文件并非发布至标准的 “/usr/local” 相关目录,而是与应用程序位于同一或上下级目录的情况。

这种发布方式多适用于一套完整的可执行程序系统。
优点:可确保引用的库为自己提供的依赖库,且不会污染标准库文件。
缺点:相关的库文件仅限于该工程自身使用,不适合其它库或可执行程序复用。

两个示例程序涉及的头文件和源文件参考《CMake学习3 - 渐入佳境》 相关文件内容。

二、基础工程

2.1 工程说明

此工程是 “标准工程” 与 “发布工程” 的基础版本,包含了未经调整和公用的基础代码,便于大家循序渐进掌握。
  • 基本结构

    • CMakeLists.txt 工程组织结构及构建规则
    • include 所有头文件
    • src 所有源文件
  • 安装目录

    • 头文件目录 /usr/local/include
    • 库文件目录 /usr/local/lib
    • 可执行文件 /usr/local/bin
  • 构建选项

    • 这两个选项是可选项而不是必选项
    • 设置 CMAKE_BUILD_TYPE 构建 Debug 或 Release 版本(默认Release)
    • 设置 BUILD_SHARED_LIBS 构建共享库或静态库(默认静态库)
  • 构建步骤

    mkdir build
    cd build    
    cmake ..
    make    
    sudo make install

2.2 工程结构

.
├── app
│   ├── CMakeLists.txt
│   ├── include
│   └── src
│       ├── CMakeLists.txt
│       └── main.cpp
├── CMakeLists.txt
├── math
│   ├── CMakeLists.txt
│   ├── include
│   │   └── math
│   │       └── math.h
│   └── src
│       ├── CMakeLists.txt
│       └── math.cpp
└── ui
    ├── CMakeLists.txt
    ├── include
    │   └── ui
    │       ├── button.h
    │       ├── edit.h
    │       └── element.hpp
    └── src
        ├── button.cpp
        ├── CMakeLists.txt
        └── edit.cpp

2.3 文件内容

  • CMakeLists.txt

    # 所需 cmake 工具的最低版本
    cmake_minimum_required(VERSION 3.1)
    
    # 工程名称
    project(AppProject)
    
    # 指定工程的构建类型(取值包括 Debug, Release, RelWithDebInfo, MinSizeRel)
    set(CMAKE_BUILD_TYPE Release)
    
    # 生成共享库或静态库(取值包括 on,off)
    set(BUILD_SHARED_LIBS on)
    
    # 包含子工程
    add_subdirectory(math)
    add_subdirectory(ui)
    add_subdirectory(app)
  • app/CMakeLists.txt

    project(app)
    add_subdirectory(src)
  • app/src/CMakeLists.txt

    # 生成可执行程序
    add_executable(${PROJECT_NAME} main.cpp)
    
    # 包含依赖头文件
    target_include_directories(${PROJECT_NAME} PUBLIC
        "${App_SOURCE_DIR}/include"
        "${Math_SOURCE_DIR}/include"
        "${Ui_SOURCE_DIR}/include"
    )
    
    # 链接依赖动态库
    target_link_libraries(${PROJECT_NAME}
        Math
        Ui
    )
    
    # 安装可执行文件
    install(TARGETS ${PROJECT_NAME} DESTINATION /usr/local/bin)
  • math/CMakeLists.txt

    project(Math)
    add_subdirectory(src)
  • math/src/CMakeLists.txt

    # 创建静态库或共享库
    add_library(${PROJECT_NAME} math.cpp)
    
    # 包含依赖头文件
    target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
    
    # 安装头文件
    install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/" DESTINATION "/usr/local/include")
    
    # 安装库文件
    install(TARGETS ${PROJECT_NAME} DESTINATION /usr/local/lib)
  • ui/CMakeLists.txt

    project(Ui)
    add_subdirectory(src)
  • ui/src/CMakeLists.txt

    # 创建静态库或共享库
    add_library(${PROJECT_NAME} button.cpp edit.cpp)
    
    # 包含依赖头文件
    target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
    
    # 安装头文件
    install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/" DESTINATION "/usr/local/include")
    
    # 安装库文件
    install(TARGETS ${PROJECT_NAME} DESTINATION /usr/local/lib)

三、标准工程

3.1 工程说明

  • 所有头文件和源文件没有任何更改
  • 修改只涉及包含 install 指令的 CMakeLists.txt 文件
  • 思路为把原本的绝对路径修改为通过top层的变量实现路径控制
  1. 可通过修改 CMAKE_INSTALL_PREFIX 变量,实现发布根目录的位置指定。
  2. 可通过修改 INSTALL_INCLUDE_PATH 变量,实现发布头文件的位置指定。
  3. 可通过修改 INSTALL_LIB_PATH 变量,实现发布库文件目录的位置指定。
  4. 可通过修改 INSTALL_BIN_PATH 变量,实现发布可执行文件的位置指定。

3.2 工程结构

总体结构不变,仅列出有内容变更文件的工程结构。
.
├── app
│   └── src
│       └── CMakeLists.txt
├── CMakeLists.txt
├── math
│   └── src
│       └── CMakeLists.txt
└── ui
    └── src
        └── CMakeLists.txt

3.3 文件内容

  • CMakeLists.txt

    # 所需 cmake 工具的最低版本
    cmake_minimum_required(VERSION 3.1)
    
    # 工程名称
    project(AppProject)
    
    # 指定工程的构建类型(取值包括 Debug, Release, RelWithDebInfo, MinSizeRel)
    #set(CMAKE_BUILD_TYPE Release)
    
    # 生成共享库或静态库(取值包括 on,off)
    #set(BUILD_SHARED_LIBS on)
    
    # 指定安装根目录
    set(CMAKE_INSTALL_PREFIX "/usr/local")
    
    # 指定头文件安装目录
    set(INSTALL_INCLUDE_PATH ${CMAKE_INSTALL_PREFIX}/include)
    
    # 指定库文件安装目录
    set(INSTALL_LIB_PATH ${CMAKE_INSTALL_PREFIX}/lib)
    
    # 指定可执行文件安装目录
    set(INSTALL_BIN_PATH ${CMAKE_INSTALL_PREFIX}/bin)
    
    # 包含子工程
    add_subdirectory(math)
    add_subdirectory(ui)
    add_subdirectory(app)
  • app/src/CMakeLists.txt

    # 生成可执行程序
    add_executable(${PROJECT_NAME} main.cpp)
    
    # 包含依赖头文件
    target_include_directories(${PROJECT_NAME} PUBLIC
        "${App_SOURCE_DIR}/include"
        "${Math_SOURCE_DIR}/include"
        "${Ui_SOURCE_DIR}/include"
    )
    
    # 链接依赖动态库
    target_link_libraries(${PROJECT_NAME}
        Math
        Ui
    )
    
    # 安装库文件
    install(TARGETS ${PROJECT_NAME} DESTINATION ${INSTALL_BIN_PATH})
  • math/src/CMakeLists.txt

    # 创建静态库或共享库
    add_library(${PROJECT_NAME} math.cpp)
    
    # 包含依赖头文件
    target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
    
    # 安装头文件
    install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/" DESTINATION ${INSTALL_INCLUDE_PATH})
    
    # 安装库文件
    install(TARGETS ${PROJECT_NAME} DESTINATION ${INSTALL_LIB_PATH})
  • ui/src/CMakeLists.txt

    # 创建静态库或共享库
    add_library(${PROJECT_NAME} button.cpp edit.cpp)
    
    # 包含依赖头文件
    target_include_directories(${PROJECT_NAME} PUBLIC ${PROJECT_SOURCE_DIR}/include)
    
    # 安装头文件
    install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/" DESTINATION ${INSTALL_INCLUDE_PATH})
    
    # 安装库文件
    install(TARGETS ${PROJECT_NAME} DESTINATION ${INSTALL_LIB_PATH})

四、发布工程

该工程基于 “标准工程”,只修改了顶层的 CMakeLists.txt 文件。

4.1 工程说明

  1. 执行 "make install" 命令后,安装至当前目录的 deploy 目录。
  2. 该目录内的程序调用采用相对路径,deploy 目录可移动至任意位置。
  3. deploy 目录内的目录结构不能调整,因为相对路径已写入 'rpath'。

4.2 工程结构

  • 修改文件结构

    .
    └── 
  • 安装目录结构

    .
    ├── app
    ├── include
    └── lib

4.3 文件内容

  • CMakeLists.txt

    # 所需 cmake 工具的最低版本
    cmake_minimum_required(VERSION 3.1)
    
    # 工程名称
    project(AppProject)
    
    # 指定工程的构建类型(取值包括 Debug, Release, RelWithDebInfo, MinSizeRel)
    set(CMAKE_BUILD_TYPE Release)
    
    # 生成共享库或静态库(取值包括 on,off)
    set(BUILD_SHARED_LIBS on)
    
    # 安装时生成'rpath'
    set(CMAKE_SKIP_INSTALL_RPATH FALSE)
    
    # 指定'rpath'路径
    set(CMAKE_INSTALL_RPATH "./lib")
    
    # 指定安装根目录
    set(CMAKE_INSTALL_PREFIX "../deploy/")
    
    # 指定头文件安装目录
    set(INSTALL_INCLUDE_PATH ${CMAKE_INSTALL_PREFIX}/include)
    
    # 指定库文件安装目录
    set(INSTALL_LIB_PATH ${CMAKE_INSTALL_PREFIX}/lib)
    
    # 指定可执行文件安装目录
    set(INSTALL_BIN_PATH ${CMAKE_INSTALL_PREFIX})
    
    # 包含子工程
    add_subdirectory(math)
    add_subdirectory(ui)
    add_subdirectory(app)

五、其它知识点

5.1 关于 rpath

Build 时期的 rpath 作用于 make 后产生的可执行文件和库文件

  • CMAKE_SKIP_BUILD_RPATH
  • CMAKE_BUILD_RPATH

Install 时期的 rpath 作用于 make install 后产生的可执行文件和库文件

  • CMAKE_SKIP_INSTALL_RPATH
  • CMAKE_INSTALL_RPATH

正常只需关注 Install 时期的 rpath 即可,且发布文件不是位于标准路径的情况。

5.2 关于 uninstall

cmake 官方并没有相应的 “make uninstall” 指令,因为官方并不推荐从系统中删除文件。可通过如下命令实现:

sudo xargs rm < install_manifest.txt

五、参考链接

  • Can I do "make uninstall" with CMake?

评论

暂无评论