CMake 的基本使用

准备工作

  • 最新版的 CMake(3.8)
  • C/C++ 编译器(GCC,MSVC,clang)。
  • 编辑器(CLion,Vim,Sublime Text)。

Hello World

  • 建立一个 CMakeDemo 文件夹,作为项目的根文件夹。
  • 新建一个主文件 main.cpp
#include <iostream>

int main() {
    std::cout << "Hello, World!" << std::endl;
    return 0;
}
  • 在文件夹内新建一个 CMakeLists.txt 文件
cmake_minimum_required(VERSION 3.8)
project(CMakeDemo)

set(CMAKE_CXX_STANDARD 11)

set(SOURCE_FILES main.cpp)
add_executable(Demo ${SOURCE_FILES})

第一行代表运行此项目需要的 CMake 最小版本为 3.8,第二行为项目名,第三行和第四行的 set 表示设置一个变量,括号里的第一个值为 key,后续的值为 value,最后一行表示添加一个可执行文件。
bash 中输入以下命令。

cmake .
make

第一行表示生成 Makefile 文件,第二行代表编译。
输入 ./Demo,运行结果

Hello, World!

这是一个简单的 demo,下面开始正式的内容。

标准 C++ 工程的目录结构

通常的,一个 C++ 项目包含以下几个目录:

  • 源代码目录
  • 第三方库的包含目录
  • 第三方库的库目录
  • 文档目录
  • 二进制目录
  • README 和 License 等

所以我们在 CMakeDemo 的根目录新建一个 src 文件夹,用来放置源码,将 main.cpp 移入其中,并新建一个 CMakeLists.txt

CMakeDemo
└─src
|  └─main.cpp
|  └─CMakeLists.txt
└─CMakeLists.txt

我们在 CMakeDemo/src/CMakeLists.txt 写入如下内容

add_executable(Demo main.cpp)

CMakeDemo/CMakeLists.txt 的内容修改为

cmake_minimum_required(VERSION 3.8)
project(CMakeDemo)

set(CMAKE_CXX_STANDARD 11)

add_subdirectory(src bin)

add_subdirectory 表示生成一个子目录,src 是目录名,bin 是生成二进制的位置(可缺省)。
我们采用 out-of-source 外部构建,即将编译后的文件与源代码分离。所以在 CMakeDemo 文件夹下新建一个 build 文件夹,并 cd 进入(即当前的文件夹位置为 CMakeDemo/build),在 bash 中输入

cmake ..
make

可以看到在 build/bin 目录下,生成了二进制文件。

动态链接库

src 目录的下的内容删除,新建 hello.hhello.cpp,内容如下:

hello.h

#ifndef CMAKEDEMO_HELLO_H
#define CMAKEDEMO_HELLO_H

#ifdef __cplusplus
extern "C" {
#endif

void say(const char *str);

#ifdef __cplusplus
}
#endif

#endif //CMAKEDEMO_HELLO_H

hello.cpp

#include <cstdio>
#include "hello.h"

void say(const char *str) {
    printf("%s\n", str);
}

修改 src/CMakeLists.txt

set(LIBHELLO hello.cpp hello.h)

add_library(hello_static STATIC ${LIBHELLO})
add_library(hello SHARED ${LIBHELLO})
set_target_properties(hello PROPERTIES LINKER_LANGUAGE C)

add_library 表示生成一个库,SHARED 表示生成的是动态库,STATIC 表示生成的是静态库,在这里我们全部选择。最后一行为设置目标参数 LINKER_LANGUAGE C 表示 C 语言导出。

修改 CMakeDemo/CMakeLists.txt

cmake_minimum_required(VERSION 3.8)
project(CMakeDemo)

set(CMAKE_CXX_STANDARD 11)

add_subdirectory(src lib)

即将输出文件夹命名为 lib

在项目根目录下新建一个 build 文件,按照上节的方式编译,可以看到,在 lib 目录生成了 libhello.solibhello_static.a 两个库文件。

调用共享库

按照如下目录建立文件

CMakeDemo
└─src
|  └─CMakeLists.txt
|  └─hello
|    └─CMakeLists.txt
|    └─hello.h
|    └─hello.cpp
|  └─demo
|    └─CMakeLists.txt
|    └─demo.cpp
└─CMakeLists.txt

按照规范,我们应为每个文件夹建立一个 CMakeLists.txtsrc/hello 是我们的主项目,src/demo 是一个需要调用前者的 demo,下面填写代码

  • CMakeDemo/CMakeLists.txt
cmake_minimum_required(VERSION 3.8)
project(CMakeDemo)

set(CMAKE_CXX_STANDARD 11)

add_subdirectory(src)
  • src/CMakeLists.txt
include_directories(hello)

add_subdirectory(demo bin)
add_subdirectory(hello lib)
  • src/demo/CMakeLists.txt
add_executable(hellodemo demo.cpp)
target_link_libraries(hellodemo hello)
  • src/demo/demo.cpp
#include <hello.h>
#include <cstdio>

int main()
{
    const char *p = "Hello";
    say(p);
    printf("Done\n");
    return 0;
}
  • src/hello 目录的内容不变

按照上一节的方式编译,可以在 build/src/bin 目录中找到 demo 文件,在 build/src/lib 中找到共享库文件。
运行 demo 文件

***@ubuntu:~/CMakeDemo/build/src/bin$ ./hellodemo
Hello
Done

使用外部共享库

一般情况下,我们习惯将第三方包的头文件放到 include 目录下,库文件放到 lib 目录下。所以我们将 CMakeDemo 文件夹备份,然后清空,按照如下结构建立文件

CMakeDemo
├── CMakeLists.txt
├── include
│   └── hello
│       ├── CMakeLists.txt
│       ├── hello.cpp
│       └── hello.h
├── lib
│   └── libhello.so
└── src
    ├── CMakeLists.txt
    └── main.cpp

将原文件中的 hello 目录直接拷贝到 include 目录,上一步生成的共享库 libhello.so 拷贝到 lib 文件夹下。

  • CMakeDemo/CMakeLists.txt
cmake_minimum_required(VERSION 3.8)
project(CMakeDemo)

set(CMAKE_CXX_STANDARD 11)

include_directories(include)
link_directories(lib)

add_subdirectory(src bin)
  • CMakeDemo/src/CMakeLists.txt
add_executable(main main.cpp)
target_link_libraries(main hello)
  • CMakeDemo/src/main.cpp
#include <hello/hello.h>
#include <cstdio>

int main()
{
    const char *p = "Hello";
    say(p);
    printf("Done\n");
    return 0;
}

编译,运行

***@ubuntu:~/CMakeDemo/bin$ ./main
Hello
Done

其他常用操作

添加 OpenMP 支持

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

推荐阅读更多精彩内容