cmake的使用方法: 将源文件组织到不同的目录

一.  简介

前面几篇文章学习了cmake工具针对单个 .c文件的编译方法。

cmake针对含有多个 .c文件的工程的使用编译。cmake工程编译是如何实现编译生成库文件。

本文学习一下另一种情况：当源文件组织到不同的目录下时，cmake工具该如何编译工程。

二.  cmake的使用方法:  将源文件组织到不同的目录

1.  工程目录

前面的多个.c文件的工程中，我们已经加入了多个源文件，但是这些源文件都是放在同一个目录下，这样还是不太正规。

我们应该将这些源文件按照类型、功能、模块给它们放置到不同的目录下，于是笔者将工程源码进行了整理。于是我这里将工程源码进行了整理，当前目录结构如下所示：

在工程目录下，我们创建了 src 和 libhello 目录，并将 hello.c 和 hello.h 文件移动到 libhello 目录下，将 main.c 文件移动到 src 目录下，并且在顶层目录、libhello 目录以及 src 目录下都有一个 CMakeLists.txt 文件。

CMakeLists.txt 文件的数量从 1 个一下变成了 3 个，顿时感觉到有点触不及防！还好每一个都不复杂！

我们来看看每一个 CMakeLists.txt 文件的内容。

(1) 顶层CMakeLists.txt 文件

顶层CMakeLists.txt 文件内容如下：

cmake_minimum_required(VERSION 3.5) #cmake版本号
project(HELLO)             #设置工程名
add_subdirectory(libhello) #告诉cmake，去子目录查找新的CMakeLists.txt并解析
add_subdirectory(src)      #告诉cmake，去子目录查找新的CMakeLists.txt并解析

(2) src 目录下的 CMakeLists.txt

src 目录下的 CMakeLists.txt 文件内容如下：

include_directories(${PROJECT_SOURCE_DIR}/libhello)  #设置头文件路径
add_executable(hello main.c) #生成目标文件名
target_link_libraries(hello libhello) #设置所链接的库文件

(3)  libhello 目录下的 CMakeLists.txt

libhello 目录下的 CMakeLists.txt文件内容如下：

add_library(libhello hello.c) #设置生成的库文件名+所需的源文件
#重新设置库文件名
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello") 

三 个 CMakeLists.txt文件分析：

顶层 CMakeLists.txt 中使用了 add_subdirectory 命令，该命令告诉 cmake 去子目录中寻找新的

CMakeLists.txt 文件并解析它；

而在 src 的 CMakeList.txt 文件中，新增加了 include_directories 命令用来指明头文件所在的路径，并且使用到了 PROJECT_SOURCE_DIR 变量，该变量指向了一个路径，从命名上可知， 该变量表示工程源码的目录。

三.   cmake 编译工程

和前面一样，进入到 build 目录下进行构建、编译，即进入工程根目录下输入如下命令：

cd build/
cmake ../
make

工程目录为：

├── build
│ ├── libhello
│ │ └── libhello.a
│ └── src
│   └── hello
├── CMakeLists.txt
├── libhello
│ ├── CMakeLists.txt
│ ├── hello.c
│ └── hello.h
└── src
 ├── CMakeLists.txt
 └── main.c

最终会在 build文件目录下生成可执行文件 hello（build/src/hello）和库文件 libhello.a（build/libhello/libhello.a）。

hello可执行文件所在目录： /build/src/

libhello.o库文件所在目录：/build/libhello/

运行 hello可执行程序：

可以看出，可执行程序正常运行。