cmake-3

本节内容，转载文章：https://www.zhihu.com/column/c_200294809 ；参考程序：https://github.com/BrightXiaoHan/CMakeTutorial

实验环境：MacOS

find_package引入外部库

为了方便我们在项目中引入外部依赖包，cmake官方为我们预定义了许多寻找依赖包的Module，他们存储在path_to_your_cmake/share/cmake-/Modules目录下。每个以Find.cmake命名的文件都可以帮我们找到一个包。我们也可以在官方文档中【https://cmake.org/cmake/help/latest/module/FindCURL.html】查看到哪些库官方已经为我们定义好了。

find_package用于引入外部库，通过查找依赖库的文件路径，有两种模式：

（1）Module模式

在Module模式中，cmake需要找到一个叫做Find.cmake的文件。这个文件负责找到库所在的路径，为我们的项目引入头文件路径和库文件路径。cmake搜索这个文件的路径有两个，一个是cmake安装目录下的share/cmake-/Modules目录，另一个使我们指定的CMAKE_MODULE_PATH的所在目录。

（2）Config模式

如果Module模式搜索失败，没有找到对应的Find.cmake文件，则转入Config模式进行搜索。它主要通过Config.cmake 或者-config.cmake这两个文件来引入我们需要的库。以我们下面安装的glog库为例，在我们安装之后，它在/usr/local/lib/cmake/glog/目录下生成了glog-config.cmake文件，而/usr/local/lib/cmake//正是find_package函数的搜索路径之一。

通过模式Module引入外部库

引入外部库：curl库

curl是Linux下一个非常著名的下载库，通过这个库，可以很简单的实现文件的下载等操作。支持http, https, ftp, gopher, telnet, dict, file, 和ldap 协议。libcurl同样支持HTTPS证书授权，HTTP POST, HTTP PUT, FTP 上传, HTTP基本表单上传，代理，cookies,和用户认证。

官方定义好的

我们看到官方已经定义好了FindCURL.cmake。所以我们在CMakeLists.txt中可以直接用find_pakcage进行引用，可以看作安装CMake时自带的！

（1）引用

find_package(CURL)
add_executable(curltest curltest.cc)
if(CURL_FOUND)
    target_include_directories(curltest PRIVATE ${CURL_INCLUDE_DIR})
    target_link_libraries(curltest ${CURL_LIBRARY})
else(CURL_FOUND)
    message(FATAL_ERROR "CURL library not found")
endif(CURL_FOUND)

对于系统预定义的 Find.cmake 模块，使用方法一般如上例所示。

每一个模块都会定义以下几个变量 -

<LibaryName>_FOUND
<LibaryName>_INCLUDE_DIR or <LibaryName>_INCLUDES <LibaryName>_LIBRARY or <LibaryName>_LIBRARIES

你可以通过_FOUND 来判断模块是否被找到，如果没有找到，按照工程的需要关闭 某些特性、给出提醒或者中止编译，上面的例子就是报出致命错误并终止构建。 如果_FOUND 为真，则将_INCLUDE_DIR 加入 INCLUDE_DIRECTORIES。

通过模式Config引入非官方的库

假设此时我们需要引入glog库来进行日志的记录，我们在Module目录下并没有找到 FindGlog.cmake。所以我们需要自行安装glog库，再进行引用。

glog库：Google glog是一个基于程序级记录日志信息的C++库，编程使用方式与c++的stream操作类似，例如：LOG(INFO) << “one” << “two” << “three”;

其中“LOG”宏为日志输出关键字，”INFO”为严重性程度

（1）安装

# clone该项目
git clone https://github.com/google/glog.git
# 切换到需要的版本
cd glog
git checkout v0.40  

# 根据官网的指南进行安装
cmake -H. -Bbuild -G "Unix Makefiles"
cmake --build build
cmake --build build --target install

在我们安装之后，它在/usr/local/lib/cmake/glog/目录下生成了glog-config.cmake文件，而/usr/local/lib/cmake//正是find_package函数的搜索路径之一。

（2）引用

find_package(glog)
add_executable(glogtest glogtest.cc)
if(GLOG_FOUND)
    # 由于glog在连接时将头文件直接链接到了库里面，所以这里不用显示调用target_include_directories
    target_link_libraries(glogtest glog::glog)
else(GLOG_FOUND)
    message(FATAL_ERROR ”glog library not found”)
endif(GLOG_FOUND)

引入自定义库

编写了一个新的函数库，我们希望别的项目可以通过find_package对它进行引用

在当前目录下新建一个ModuleMode的文件夹，在里面我们编写一个计算两个整数之和的一个简单的函数库。库函数以手工编写Makefile的方式进行安装，库文件安装在/usr/lib目录下，头文件放在/usr/include目录下。

（1）Makefile文件

# 1、准备工作，编译方式、目标文件名、依赖库路径的定义。
CC = g++
CFLAGS  := -Wall -O3 -std=c++11 

OBJS = libadd.o #.o文件与.cpp文件同名
LIB = libadd.so # 目标文件名
INCLUDE = ./ # 头文件目录
HEADER = libadd.h

all : $(LIB)

# 2. 生成.o文件
$(OBJS) : libadd.cc
	$(CC) $(CFLAGS) -I ./ -fpic -c $< -o $@

# 3. 生成动态库文件
$(LIB) : $(OBJS)
	rm -f $@
	g++ $(OBJS) -shared -o $@
	rm -f $(OBJS)

# 4. 删除中间过程生成的文件
clean:
	rm -f $(OBJS) $(TARGET) $(LIB)

# 5.安装文件
install:
	mkdir -p /usr/lib/add
	cp $(LIB) /usr/lib/add
	cp $(HEADER) /usr/include

（2）编译安装

make
sudo make install

（3）接下来我们回到我们的Cmake项目中来，在cmake文件夹下新建一个FindAdd.cmake的文件。我们的目标是找到库的头文件所在目录和共享库文件的所在位置。

# 在指定目录下寻找头文件和动态库文件的位置，可以指定多个目标路径
find_path(ADD_INCLUDE_DIR libadd.h /usr/include/ /usr/local/include ${CMAKE_SOURCE_DIR}/ModuleMode)
find_library(ADD_LIBRARY NAMES add PATHS /usr/lib/add /usr/local/lib/add ${CMAKE_SOURCE_DIR}/ModuleMode)

if (ADD_INCLUDE_DIR AND ADD_LIBRARY)
    set(ADD_FOUND TRUE)
endif (ADD_INCLUDE_DIR AND ADD_LIBRARY)

这时我们便可以像引用curl一样引入我们自定义的库了。

（4）在CMakeLists.txt中添加

# 将项目目录下的cmake文件夹加入到CMAKE_MODULE_PATH中，让find_pakcage能够找到我们自定义的函数库
set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake;${CMAKE_MODULE_PATH}")
add_executable(addtest addtest.cc)
find_package(ADD)
if(ADD_FOUND)
    target_include_directories(addtest PRIVATE ${ADD_INCLUDE_DIR})
    target_link_libraries(addtest ${ADD_LIBRARY})
else(ADD_FOUND)
    message(FATAL_ERROR "ADD library not found")
endif(ADD_FOUND)