cmake：不同目录下多个源文件

心已赠人 2022-12-30 13:50 161阅读 0赞

>  *  此文为：[轻松入门cmake系列教程][cmake]
>  *  前文为：[cmake：同一目录下多个源文件][cmake 1]

一般来说，当程序文件比较多时，我们会进行分类管理，把代码根据功能放在不同的目录下，这样方便查找。那么这种情况下如何编写CMakeLists.txt呢？

# 实验 #

## 实验一 ##

我们把之前的源文件整理一下（新建2个目录test\_func和test\_func1），整理好后整体文件结构如下：  
![在这里插入图片描述][20200630111232577.png]

修改**CMakeLists.txt**：

cmake_minimum_required (VERSION 2.8)
    
    project (demo)
    
    # 向工程添加多个指定头文件的搜索路径，路径之间用空格分隔
    include_directories (test_func test_func1)
    
    #使用aux_source_directory把当前目录下的源文件存列表存放到变量SRC_LIST里
    aux_source_directory (test_func SRC_LIST)
    aux_source_directory (test_func1 SRC_LIST1)
    
    add_executable (main main.c ${
        SRC_LIST} ${
        SRC_LIST1})

这里出现了一个新的命令：include\_directories。该命令是用来向工程添加多个指定头文件的搜索路径，路径之间用空格分隔。  
因为main.c里include了testFunc.h和testFunc1.h，如果没有这个命令来指定头文件所在位置，就会无法编译。当然，也可以在main.c里使用include来指定路径【就算制定了，CMakeLists.txt还是需要改的】，如下

#include "test_func/testFunc.h"
    #include "test_func1/testFunc1.h"

只是这种写法不好看。  
另外，我们使用了2次aux\_source\_directory，因为源文件分布在2个目录下，所以添加2次

## 优化：正规一点的组织结构 ##

正规一点来说，一般会把源文件放到src目录下，把头文件放入到include文件下，生成的对象文件放入到build目录下，最终输出的elf文件会放到bin目录下，这样整个结构更加清晰。让我们把前面的文件再次重新组织下，  
![在这里插入图片描述][20200630120356608.png]  
我们在最外层目录下新建一个CMakeLists.txt，内容如下，

cmake_minimum_required (VERSION 2.8)
    
    project (demo)
    
    add_subdirectory (src)

这里出现一个新的命令add\_subdirectory()，这个命令可以向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制的存放位置，具体用法可以百度。  
这里指定src目录下存放了源文件，当执行cmake时，就会进入src目录下去找src目录下的CMakeLists.txt，所以在src目录下也建立一个CMakeLists.txt，内容如下：

aux_source_directory (. SRC_LIST)
    
    # include_directories (${PROJECT_SOURCE_DIR}/include)
    include_directories (../include)
    
    add_executable (main ${SRC_LIST})
    
    set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

这里又出现一个新的命令set，是用于定义变量的。

EXECUTABLE\_OUT\_PATH和PROJECT\_SOURCE\_DIR是CMake自带的预定义变量，其意义如下，

*  EXECUTABLE\_OUTPUT\_PATH ：目标二进制可执行文件的存放位置
 *  PROJECT\_SOURCE\_DIR：工程的根目录

所以，这里set的意思是把存放elf文件的位置设置为工程根目录下的bin目录。（cmake有很多预定义变量，详细的可以网上搜索一下）

添加好以上这2个CMakeLists.txt后，整体文件结构如下，  
![在这里插入图片描述][20200630120455469.png]  
下面来运行cmake，不过这次先让我们切到build目录下，然后输入以下命令，  
`cmake ..`  
Makefile会在build目录下生成，然后在build目录下运行make，  
![在这里插入图片描述][20200630120534478.png]  
运行ok，我们再切到bin目录下，发现main已经生成，并运行测试，  
![在这里插入图片描述][20200630120546459.png]  
测试OK！

这里解释一下为什么在build目录下运行cmake？从前面几个case中可以看到，如果不这样做，cmake运行时生成的附带文件就会跟源码文件混在一起，这样会对程序的目录结构造成污染，而在build目录下运行cmake，生成的附带文件就只会待在build目录下，如果我们不想要这些文件了就可以直接清空build目录，非常方便。

**另外一种写法：**  
前面的工程使用了2个CMakeLists.txt，这种写法是为了处理需要生成多个elf文件的情况，最外层的CMakeLists.txt用于掌控全局，使用add\_subdirectory来添加要生成elf文件的源码目录。

如果只生成一个elf文件，那么上面的例子可以只使用一个CMakeLists.txt，可以把最外层的CMakeLists.txt内容改成如下

cmake_minimum_required (VERSION 2.8)
    
    project (demo)
    
    aux_source_directory (src SRC_LIST)
    
    include_directories (include)
    
    add_executable (main ${SRC_LIST})
    
    set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

同时，还要把src目录下的CMakeLists.txt删除。

# 总结 #

命令总结：

<table> 
 <thead> 
  <tr> 
   <th>命令</th> 
   <th>说明</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>include_directories</td> 
   <td>该命令是用来向工程添加多个指定头文件的搜索路径，路径之间用空格分隔</td> 
   <td><code>include_directories (../include)</code></td> 
  </tr> 
  <tr> 
   <td>add_subdirectory()</td> 
   <td>向当前工程添加存放源文件的子目录</td> 
   <td><code>add_subdirectory (src)</code></td> 
  </tr> 
  <tr> 
   <td>set</td> 
   <td>用于定义变量的</td> 
   <td><code>set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)</code></td> 
  </tr> 
 </tbody> 
</table>

CMake自带的预定义变量总结：

<table> 
 <thead> 
  <tr> 
   <th>示例</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>EXECUTABLE_OUTPUT_PATH</td> 
   <td>目标二进制可执行文件的存放位置</td> 
  </tr> 
  <tr> 
   <td>PROJECT_SOURCE_DIR</td> 
   <td>工程的根目录</td> 
  </tr> 
 </tbody> 
</table>

[cmake]: https://blog.csdn.net/zhizhengguan/article/details/107034372
[cmake 1]: https://blog.csdn.net/zhizhengguan/article/details/111713182
[20200630111232577.png]: /images/20221120/df5d9ce21ad64ed987579ab19c861bdf.png
[20200630120356608.png]: https://img-blog.csdnimg.cn/20200630120356608.png
[20200630120455469.png]: https://img-blog.csdnimg.cn/20200630120455469.png
[20200630120534478.png]: https://img-blog.csdnimg.cn/20200630120534478.png
[20200630120546459.png]: https://img-blog.csdnimg.cn/20200630120546459.png