CMake 入门2 —— 一个链接动态库的简单工程

这一章我们将从一个通用常规工程的角度来看一个 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 目录下。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,271评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,725评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,252评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,634评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,549评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,985评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,471评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,128评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,257评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,233评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,235评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,940评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,528评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,623评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,858评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,245评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,790评论 2 339

推荐阅读更多精彩内容