这一章我们将从一个通用常规工程的角度来看一个 CMake 工程的常用阻止结构。先来看看工程目录结构：
.
├── CMakeLists.txt
├── build
├── include
│ └── mylib.h
├── lib
│ ├── libmylib.a
└── src
└── main.cpp
我们有 4 个文件夹，1 个 CMakeLists.txt 文件。
- build 是用来存放使用 CMake 编译时所产生的中间文件。
- include 存放我们源码所需要依赖的头文件。
- lib 存放我们工程所需依赖的外部动态库。
- src 存放我们的源码文件。
本章节的目的是，通过编写 CMakeLists.txt 来组织编译流程：编译 map.cpp，其中使用了 mylib.h 中声明的方法，方法定义在 libmylib.a 中，因此还需要链接 libmylib.a。
准备工作
我们需要先编译出 libmylib.a。
mylib.h 文件内容如下：
int myadd(int a, int b);
void myprint(int s);
mylib.cpp 文件内容如下：
#include <iostream>
#include "mylib.h"
int myadd(int a, int b) {
return a + b;
}
void myprint(int s) {
std::cout << s << std::endl;
}
将它们两个放在同一个目录下，使用命令 gcc -c mylib.cpp -o mylib.o 编译出目标文件（只是编译，没有链接，也就是引用的外部头文件中的方法将没有实现），然后用命令 ar rcv libmylib.a mylib.o 将目标文件 mylib.o 打包成动态库 libmylib.a。
将 libmylib.a 放在 lib 目录下，这样我们就完成了准备工作。
编写 CMakeLists.txt
先看下最后的 CMakeLists.txt：
cmake_minimum_required(VERSION 3.0)
project(hello)
include_directories(${CMAKE_CURRENT_LIST_DIR}/include)
aux_source_directory(${CMAKE_CURRENT_LIST_DIR}/src hello_src)
link_directories(${CMAKE_CURRENT_LIST_DIR}/lib)
add_executable(${PROJECT_NAME} ${hello_src})
target_link_libraries(${PROJECT_NAME} libmylib.a)
set(CMAKE_CXX_COMPILER "clang++") # 显式指定所使用的 C++ 编译器
set(CMAKE_CXX_FLAGS "-std=c++11") # c++11
set(CMAKE_CXX_FLAGS "-g") # 调试信息
set(CMAKE_CXX_FLAGS "-Wall") # 开启所有警告
set(CMAKE_CXX_FLAGS_DEBUG "-O0") # 调试包不优化
set(CMAKE_CXX_FLAGS_RELEASE "-O2 -DNDEBUG") # release 包优化
最低版本要求
cmake_minimum_required(VERSION 3.0)，通过这条代码指定该 CMakeLists.txt 中所使用的语法向下兼容到 3.0 版本。
给工程起个名字
project(hello)，将工程名字设置为 hello。该方法将同时设置 CMake 的全局变量 ${PROJECT_NAME}。
让 CMake 找到工程所需头文件
include_directories(${CMAKE_CURRENT_LIST_DIR}/include)。其中 ${CMAKE_CURRENT_LIST_DIR} 是 CMake 自带变量，表示正在执行的 CMake 文件所在目录。
- 注意这个命令所接受的参数是目录路径，该目录下的所有头文件都将被搜索到。因此，如果工程是一个对外发布的库，那么比较好的实践是 将其对外接口的头文件都放在统一的 include 文件夹中。这样，使用者只用 include 该头文件目录即可。
- 该命令所添加的头文件搜索路径同样将向下传递到子 CMakeLists.txt 的头文件搜索路径中。
- 该命令不递归搜索文件。
让 CMake 找到工程所需源文件
aux_source_directory(${CMAKE_CURRENT_LIST_DIR}/src hello_src)。第一个参数代表包含源文件的目录，不会递归搜索目录。将搜索到的源码文件（*.h, *.hpp 等结尾的头文件不会被搜索在内）路径会保存到变量 ${hello_src} 中。
官方文档上说，像这种自动搜索的命令（包括
file(GLOB_RECURSE ...)等）会有一个问题：搜索的结果只会在运行cmake时被更新。因此，如果在源码文件路径下新增了一个源码文件的话，make并不会编译这个新增的源码文件。需要再次调用cmake进行搜索。
让 CMake 找到库文件
link_directories(${CMAKE_CURRENT_LIST_DIR}/lib)。和 include_directories 一样，cmake 将在该目录下搜索需要链接的动态库。
告诉 CMake 我的构建目标
add_executable(${PROJECT_NAME} ${hello_src})。第一个参数是构建出来的可执行文件的名字，第二个参数是一个所有需要编译的源码文件 List，这里我们使用了 aux_source_directory 中所设置的变量 ${hello_src}。这条函数会生成名为 ${hello_src} 的可执行文件。
告诉 CMake 我要链接的库文件
target_link_libraries(${PROJECT_NAME} libmylib.a)。如果写了上面的 link_directories，那么这条函数就只用写库名就可以了。这里的库名可以使用 libmylib.a 这样的全名，也可以是 mylib 这样的只用按规则指定文件名。如果使用 mylib，那么会优先搜索 libmylib.a，其次搜索 libmylib.so。
传递 FLAGS 给 C++ 编译器
如果 main.cpp 中用到了 C++11，那么就需要在生成的 Makefile 中告诉编译器启动 C++11。
set(CMAKE_CXX_COMPILER "clang++") # 显式指定所使用的 C++ 编译器
set(CMAKE_CXX_FLAGS "-std=c++11") # c++11
set(CMAKE_CXX_FLAGS "-g") # 调试信息
set(CMAKE_CXX_FLAGS "-Wall") # 开启所有警告
set(CMAKE_CXX_FLAGS_DEBUG "-O0") # 调试包不优化
set(CMAKE_CXX_FLAGS_RELEASE "-O2 -DNDEBUG") # release 包优化
开始构建
同 CMake 入门1 —— CMake Hello World 中一样，我们在 build 文件夹中执行 cmake ..，生成 Makefile 后执行 make，即可得到可执行文件 hello。
hello 会生成在 build 文件夹下，如果想该自定义一个生成路径，那么可以使用 set(EXECUTABLE_OUTPUT_PATH ${CMAKE_CURRENT_LIST_DIR}/bin)，该命令会在 CMakeLists.txt 所在目录下自动创建一个 bin 文件夹。make 所生成的可执行文件将放在 bin 目录下。
网友评论