[C++][CMake][生成可执行文件][下]详细讲解_cmake生存可执行文件

---

1.搜索文件

• 如果一个项目里边的源文件很多，在编写CMakeLists.txt文件的时候不可能将项目目录的各个文件一一罗列出来，这样太麻烦也不现实
• CMake提供了搜索文件的命令，可以使用aux_source_directory命令或者file命令

1.aux_source_directory

• 在CMake中使用aux_source_directory命令可以查找某个路径下的所有源文件
• 语法：
  • dir：要搜索的目录
  • variable：将从dir目录下搜索到的源文件列表存储到该变量中

    aux_source_directory(< dir > < variable >)
    1

• 示例：

  aux_source_directory(${PROJECT_SOURCE_DIR}/src SRC)
  1

2.file

• file除了搜索以外还可以做其他事情
• 语法：
  • GLOB：将指定目录下搜索到的满足条件的所有文件名生成一个列表，并将其存储到变量中
  • GLOB_RECURSE：递归搜索指定目录，将搜索到的满足条件的文件名生成一个列表，并将其存储到变量中

    file(GLOB/GLOB_RECURSE 变量名 要搜索的文件路径和文件类型)
    1

• 示例：

  file(GLOB MAIN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp)
  1

• CMAKE_CURRENT_SOURCE_DIR宏表示当前访问的CMakeLists.txt文件所在的路径

---

2.包含头文件

• 在编译项目源文件的时候，很多时候都需要将源文件对应的头文件路径指定出来，这样才能保证在编译过程中编译器能够找到这些头文件，并顺利通过编译
• 在CMake中设置要包含的目录也很简单，通过include_directories即可
• 语法：

  include_directories(<directory1> [<directory2> ...])
  1

---

3.变量操作

1.追加

• 有时候项目中的源文件并不一定都在同一个目录中，但是这些源文件最终却需要一起进行编译来生成最终的可执行文件或者库文件，如果通过file命令对各个目录下的源文件进行搜索，最后还需要做一个字符串拼接的操作
• 关于字符串拼接可以使用set命令也可以使用list命令

1.使用set拼接

• 语法：

  set(变量名1 ${变量名1} ${变量名2} ...)
  1

• 本质：从第二个参数开始往后所有的字符串进行拼接，最后将结果存储到第一个参数中，如果第一个参数中原来有数据会对原数据就行覆盖
• 示例：

  cmake_minimum_required(VERSION 3.0)
  project(TEST)
  
  set(TEMP "DieSnowK")
  file(GLOB SRC_1 ${PROJECT_SOURCE_DIR}/src1/*.cpp)
  file(GLOB SRC_2 ${PROJECT_SOURCE_DIR}/src2/*.cpp)
  
  # 追加(拼接)
  set(SRC_1 ${SRC_1} ${SRC_2} ${TEMP})
  message(STATUS "message: ${SRC_1}")
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10

2.使用list拼接

• list命令的功能比set要强大，字符串拼接只是它的其中一个功能，所以需要在它第一个参数的位置指定出要做的操作，APPEND表示进行数据追加，后边的参数和set就一样了
• 语法：

  list(APPEND <list> [<element> ...])
  1

• 示例：

  cmake_minimum_required(VERSION 3.0)
  project(TEST)
  
  set(TEMP "DieSnowK")
  file(GLOB SRC_1 ${PROJECT_SOURCE_DIR}/src1/*.cpp)
  file(GLOB SRC_2 ${PROJECT_SOURCE_DIR}/src2/*.cpp)
  
  # 追加(拼接)
  list(APPEND SRC_1 ${SRC_1} ${SRC_2} ${TEMP})
  message(STATUS "message: ${SRC_1}")
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10

• 在CMake中，使用set命令可以创建一个list，一个在list内部是一个由分号;分割的一组字符串
  • 例如：set(var a b c d e)命令将会创建一个list:a;b;c;d;e，但是最终打印变量值的时候得到的是abcde

    set(tmp1 a;b;c;d;e)
    set(tmp2 a b c d e)
    message(${tmp1}) # 输出结果 abcde
    message(${tmp2}) # 输出结果 abcde
    1
    2
    3
    4

---

2.字符串移除

• 在通过file搜索某个目录就得到了该目录下所有的源文件，但是其中有些源文件并不是所需要的，需要从搜索到的数据中剔除出去，想要实现这个功能，也可以使用list
  • 删除和追加数据类似，只不过是第一个参数变成了REMOVE_ITEM
• 语法：

  list(REMOVE_ITEM <list> <value> [<value> ...])
  1

• 注意：通过file命令搜索源文件的时候得到的是文件的绝对路径(在list中每个文件对应的路径都是一个item，并且都是绝对路径)，那么在移除的时候也要将该文件的绝对路径指定出来才可以，否是移除操作不会成功
• 示例：

  cmake_minimum_required(VERSION 3.0)
  project(TEST)
  
  file(GLOB SRC_1 ${PROJECT_SOURCE_DIR}/*.cpp)
  # 移除前日志
  message(STATUS "message: ${SRC_1}")
  
  # 移除 main.cpp
  list(REMOVE_ITEM SRC_1 ${PROJECT_SOURCE_DIR}/main.cpp)
  # 移除后日志
  message(STATUS "message: ${SRC_1}")
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11

---

3.list其他操作

• 获取list的长度
  • 语法

    list(LENGTH <list> <output variable>)
    1

  • 参数：
    • LENGTH：子命令LENGTH用于读取列表长度
    • <list>：当前操作的列表
    • <output variable>：新创建的变量，用于存储列表的长度
• 读取列表中指定索引的的元素，可以指定多个索引
  • 语法：

    list(GET <list> <element index> [<element index> ...] <output variable>)
    1

  • 参数：
    • <list>：当前操作的列表
    • <element index：列表元素的索引
      • 从0开始编号，索引0的元素为列表中的第一个元素
      • 索引也可以是负数，-1表示列表的最后一个元素，-2表示列表倒数第二个元素，以此类推
      • 当索引(不管是正还是负)超过列表的长度，运行会报错
    • <output variable>：新创建的变量，存储指定索引元素的返回结果，也是一个列表
• 将列表中的元素用连接符(字符串)连接起来组成一个字符串
  • 语法：

    list (JOIN <list> <glue> <output variable>)
    1

  • 参数：
    • <list>：当前操作的列表
    • <glue>：指定的连接符(字符串)
    • <output variable>：新创建的变量，存储返回的字符串
• 查找列表是否存在指定的元素，若果未找到，返回-1
  • 语法：

    list(FIND <list> <value> <output variable>)
    1

  • 参数：
    • <list>：当前操作的列表
    • <value>：需要在列表中搜索的元素
    • <output variable>：新创建的变量
      • 如果列表<list>中存在<value>，那么返回<value>在列表中的索引
      • 如果未找到则返回-1
• 将元素追加到列表中

  list (APPEND <list> [<element> ...])
  1

• 在list中指定的位置插入若干元素

  list(INSERT <list> <element_index> <element> [<element> ...])
  1

• 将元素插入到列表的0索引位置

  list (PREPEND <list> [<element> ...])
  1

• 将列表中最后元素移除

  list (POP_BACK <list> [<out-var>...])
  1

• 将列表中第一个元素移除

  list (POP_FRONT <list> [<out-var>...])
  1

• 将指定的元素从列表中移除

  list (REMOVE_ITEM <list> <value> [<value> ...])
  1

• 将指定索引的元素从列表中移除

  list (REMOVE_AT <list> <index> [<index> ...])
  1

• 移除列表中的重复元素

  list (REMOVE_DUPLICATES <list>)
  1

• 列表翻转

  list(REVERSE <list>)
  1

• 列表排序
  • 语法：

    list (SORT <list> [COMPARE <compare>] [CASE <case>] [ORDER <order>])
    1

  • 参数：
    • COMPARE：指定排序方法
      • STRING：按照字典序排序，为默认的排序方法
      • FILE_BASENAME：如果是一系列路径名，会使用basename进行排序
      • NATURAL：使用自然数顺序排序
    • CASE：指明是否大小写铭感
      • SENSITIVE：按照大小写敏感的方式进行排序，为默认值
      • INSENSITIVE：按照大小写不敏感的方式进行排序
    • ORDER：指明排序的顺序
      • ASCENDING：按照升序排序，为默认值
      • DESCENDING：按照降序排列

---

4.宏定义

• 在进行程序测试的时候，可以在代码中添加一些宏定义，通过这些宏来控制这些代码是否生效

  #include <stdio.h>
  #define NUMBER  3
  
  int main()
  {
      int a = 10;
  #ifdef DEBUG
      printf("Pikachu~\n");
  #endif
      for(int i=0; i<NUMBER; ++i)
      {
          printf("DieSnowK\n");
      }
      return 0;
  }
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13
  14
  15

• 在上述程序的第七行对DEBUG宏进行了判断，如果该宏被定义了，那么第八行就会进行日志输出，如果没有定义这个宏，第八行就相当于被注释掉了，因此最终无法看到日志输出(上述代码中并没有定义这个宏)
• 为了让测试更灵活，可以不在代码中定义这个宏，而是在测试的时候去把它定义出来，其中一种方式就是在gcc/g++命令中去指定，通过参数-D指定出要定义的宏的名字，这样就相当于在代码中定义了一个宏，其名字为DEBUG

  gcc test.c -DDEBUG -o app
  1

• 在CMake中，对应的命令为add_definitions

  add_definitions(-D宏名称)
  1

• 示例：

  cmake_minimum_required(VERSION 3.0)
  project(test)
  
  add_definitions(-DDEBUG)
  add_executable(app ./main.c)
  1
  2
  3
  4
  5

---

5.预定义宏

• 以下为CMake中常用的一些预定义宏

  宏	功能
  PROJECT_SOURCE_DIR	使用cmake命令后紧跟的目录，一般是工程的根目录
  PROJECT_BINARY_DIR	执行cmake命令的目录
  CMAKE_CURRENT_SOURCE_DIR	当前处理的CMakeLists.txt所在的路径
  CMAKE_CURRENT_BINARY_DIR	target编译目录
  EXECUTABLE_OUTPUT_PATH	重新定义目标二进制可执行文件的存放位置
  LIBRARY_OUTPUT_PATH	重新定义目标链接库文件的存放位置
  PROJECT_NAME	返回通过PROJECT指令定义的项目名称
  CMAKE_BINARY_DIR	项目实际构建路径，假设在build目录进行的构建，那么得到的就是这个目录的路径