CMakeLists 入门

前言
makefile文件的编写实在是个繁琐的事,于是,CMake出现了,使得这一切变得简单,CMake通过CMakeLists.txt读入所有源文件自动生成makefile,进而将源文件编译成可执行文件或库文件

一、CMake常用的命令

# 设置cmake最低版本
cmake_minimum_required(VERSION 3.2)

# project命令用于指定cmake工程的名称,实际上,它还可以指定cmake工程的版本号(VERSION关键字)、简短的描述(DESCRIPTION关键字)、主页URL(HOMEPAGE_URL关键字)和编译工程使用的语言(LANGUAGES关键字)
# project(<PROJECT-NAME> [<language-name>...])
# project(<PROJECT-NAME> [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]] [DESCRIPTION <project-description-string>][HOMEPAGE_URL <url-string>] [LANGUAGES <language-name>...])
# ${PROJECT_SOURCE_DIR} 和 <PROJECT-NAME>_SOURCE_DIR:本CMakeLists.txt所在的文件夹路径
# ${PROJECT_NAME}:本CMakeLists.txt的project名称
project(xxx)
project(mytest VERSION 1.2.3.4)
project (mytest HOMEPAGE_URL “https://www.XXX(示例).com”)

# 获取路径下所有的.cpp/.c/.cc文件(不包括子目录),并赋值给变量中
aux_source_directory(路径 变量)

# GLOB_RECURSE 获取目录下的所有cpp文件(不包括子目录),并赋值给SOURCES
file(
        GLOB SOURCES
        ${PROJECT_SOURCE_DIR}/*.c

)
# GLOB_RECURSE 获取目录下的所有cpp文件(包括子目录),并赋值给NATIVE_SRC
file(
      GLOB_RECURSE NATIVE_SRC 
      ${PROJECT_SOURCE_DIR}/lib/*.cpp
)

# 给文件名/路径名或其他字符串起别名,用${变量}获取变量内容
set(变量 文件名/路径/...)

# 添加编译选项FOO BAR
# add_definitions定义宏,但是这种定义方式无法给宏具体值 等价C语言中的#define  MG_ENABLE_OPENSSL
add_definitions(-DFOO -DBAR ...)

# add_compile_definitions定义宏,这种方式可以给宏具体值,但是这个指令只要高版本的cmake支持 等价C语言中 #define  MG_ENABLE_OPENSSL   1 
add_compile_definitions(MG_ENABLE_OPENSSL=1)

# 打印消息
message(消息)

# 编译子文件夹的CMakeLists.txt
add_subdirectory(子文件夹名称)

# 将.cpp/.c/.cc文件生成.a静态库
# 注意,库文件名称通常为libxxx.so,在这里只要写xxx即可
add_library(库文件名称 STATIC 文件)

# 将.cpp/.c/.cc文件生成可执行文件
add_executable(可执行文件名称 文件)

# 规定.h头文件路径
include_directories(路径)

# 规定.so/.a库文件路径
link_directories(路径)

# 设置编译选项及默认值
option(TEST_DEBUG "option for debug" OFF)

# 对add_library或add_executable生成的文件进行链接操作
# 注意,库文件名称通常为libxxx.so,在这里只要写xxx即可
target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称)

通常一个CMakeLists.txt需按照下面的流程:

project(xxx)                                          #必须

add_subdirectory(子文件夹名称)                         #父目录必须,子目录不必

add_library(库文件名称 STATIC 文件)                    #通常子目录(二选一)
add_executable(可执行文件名称 文件)                     #通常父目录(二选一)

include_directories(路径)                              #必须
link_directories(路径)                                 #必须

target_link_libraries(库文件名称/可执行文件名称 链接的库文件名称)       #必须

二、CMakeLists实例

示例1:只有一个源文件main.c

目录结构如下:

+
| 
+--- main.c
+--- CMakeLists.txt
|

代码如下:

// main.c
#include <stdio.h>
int main()
{
printf("hello world");
return 0;
}
# CMakeLists
cmake_minimum_required(VERSION 3.0)
project(HELLO VERSION 1.0 LANGUAGES C CXX)
set(SOURCES main.c)
add_executable(hello ${SOURCES})

⚠️警告
project设置VERSION,要求cmake的最低版本3.0

注意:
为了简单起见,我们从一开始就采用cmake的 out-of-source 方式来构建(即生成中间产物与源代码分离),并始终坚持这种方法,这也就是此处为什么单独创建一个目录,然后在该目录下执行 cmake 的原因

在CMakeLists.txt目录下执行以下命令

mkdir build
cd build
cmake ..
make

即可生成可执行程序 hello(.exe)
目录结构如下

+
| 
+--- main.c
+--- CMakeLists.txt
|
/--+ build/
   |
   +--- hello(exec)
  • project 会引入两个变量HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR,这两个变量和PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR等价
  • message(${PROJECT_SOURCE_DIR}) 打印变量的值
  • set 命令用来设置变量
  • add_exectuable 告诉工程生成一个可执行文件。
  • add_library 则告诉生成一个库文件
示例2:拆成3个文件 hello.h hello.c main.c

目录结构如下:

+
| 
+--- main.c
+--- hello.h
+--- hello.c
+--- CMakeLists.txt
|

代码如下:

// main.c
#include "hello.h"
int main()
{
    hello("World");
    return 0;
}
// hello.h
#ifndef DBZHANG_HELLO_
#define DBZHANG_HELLO_
void hello(const char* name);
#endif //DBZHANG_HELLO_
// hello.c
#include <stdio.h>
#include "hello.h"

void hello(const char * name)
{
    printf ("Hello %s! \n", name);
}
# CMakeLists
cmake_minimum_required(VERSION 3.0)
project(HELLO VERSION 1.0 LANGUAGES C CXX)
set(SOURCES hello.c main.c)
add_executable(hello ${SOURCES})

执行cmake的过程同上,目录结构

+
| 
+--- main.c
+--- hello.h
+--- hello.c
+--- CMakeLists.txt
|
/--+ build/
   |
   +--- hello(exec)
示例3:在示例2的基础上,先将 hello.c 生成一个库hellolib,再给main.c使用

我们只需修改下CMakeLists即可

# CMakeLists
cmake_minimum_required(VERSION 3.0)
project(HELLO VERSION 1.0 LANGUAGES C CXX)
set(LIB_SRC hello.c)
add_library(libhello ${LIB_SRC})
set(APP_SRC main.c)
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)

执行cmake的过程同上,目录结构如下

+
| 
+--- main.c
+--- hello.h
+--- hello.c
+--- CMakeLists.txt
|
/--+ build/
   |
   +--- liblibhello.a
   +--- hello(exec)
  • target_link_libraries 该指令的作用为将目标文件与库文件进行链接。该指令的语法如下:
    target_link_libraries(<target> [item1] [item2] [...]
    [[debug|optimized|general] <item>] ...)
    上述指令中的<target>是指通过add_executable()和add_library()指令生成已经创建的目标文件。而[item]表示库文件没有后缀的名字。默认情况下,库依赖项是传递的。当这个目标链接到另一个目标时,链接到这个目标的库也会出现在另一个目标的连接线上
    target_link_libraries里库文件的顺序符合gcc链接顺序的规则,即被依赖的库放在依赖它的库的后面,比如
    target_link_libraries(hello A B.a C.so)
    在上面的命令中,libA.so可能依赖于libB.a和libC.so,如果顺序有错,链接时会报错。还有一点,B.a会告诉CMake优先使用静态链接库libB.a,C.so会告诉CMake优先使用动态链接库libC.so,也可直接使用库文件的相对路径或绝对路径。使用绝对路径的好处 于,当依赖的库被更新时,make的时候也会重新链接

  • set_target_properties(...)是一个便捷功能,因为它允许设置多个目标的多个属性

set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")

重命名libhello为hello

set_target_properties(Thirdlib PROPERTIES IMPORTED_LOCATION ${CMAKE_CURRENT_SOURCE_DIR}/jniLibs/libThirdlib.so)

cmakelist 添加依赖库

set_target_properties(test PROPERTIES LINKER_LANGUAGE CXX) // 指定C++
set_target_properties(test PROPERTIES LINKER_LANGUAGE C) // 指定C

该目标属性用于指定编译器的语言。即当调用可执行程序、共享库和模块时,用于指定编译器链接语言(C or CXX),若是没有设置,则默认具有最高链接器首选项值的语言

示例4:将源文件放置到不同的目录

在示例2的基础上,我们修改下目录结构
目录结构如下:

+
|
+--- CMakeLists.txt
/--+ src/
|  |
|  +--- main.c
|  +--- CMakeLists.txt
|
/--+ libhello/
|  |
|  +--- hello.h
|  +--- hello.c
|  +--- CMakeLists.txt

顶层的CMakeLists.txt

# CMakeLists
cmake_minimum_required(VERSION 3.0)
project(HELLO VERSION 1.0 LANGUAGES C CXX)
add_subdirectory(src)
add_subdirectory(libhello)

src的CMakeLists.txt

# src CMakeLists
include_directories(${PROJECT_SOURCE_DIR}/libhello)
set(APP_SRC main.c)
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)

libhello的CMakeLists.txt

#libhello CMakeLists
set(LIB_SRC hello.c)
add_library(libhello ${LIB_SRC})

执行cmake的过程同上,目录结构如下

+
|
+--- CMakeLists.txt
/--+ src/
   |
   +--- main.c
   +--- CMakeLists.txt

/--+ libhello/
   |
   +--- hello.h
   +--- hello.c
   +--- CMakeLists.txt

/--+ build/
   |
   / --+ src/
      | 
      +--- hello(exec)

   / --+ libhello/ 
      |
      +--- liblibhello.a

  • add_subdirectory (source_dir [binary_dir] [EXCLUDE_FROM_ALL])
    添加一个子目录并构建该子目录

    • source_dir
      必选参数。该参数指定一个子目录,子目录下应该包含CMakeLists.txt文件和代码文件。子目录可以是相对路径也可以是绝对路径,如果是相对路径,则是相对当前目录的一个相对路径。
    • binary_dir
      可选参数。该参数指定一个目录,用于存放输出文件。可以是相对路径也可以是绝对路径,如果是相对路径,则是相对当前输出目录的一个相对路径。如果该参数没有指定,则默认的输出目录使用source_dir。
    • EXCLUDE_FROM_ALL
      可选参数。当指定了该参数,则子目录下的目标不会被父目录下的目标文件包含进去,父目录的CMakeLists.txt不会构建子目录的目标文件,必须在子目录下显式去构建。例外情况:当父目录的目标依赖于子目录的目标,则子目录的目标仍然会被构建出来以满足依赖关系(例如使用了target_link_libraries)
  • include_directories ([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])
    将指定目录添加到编译器的头文件搜索路径之下,指定的目录被解释成当前源码路径的相对路径

示例5:在示例4的基础上,将可执行文件和lib都放到对应的bin目录下

方法一:修改顶层CMakeLists.txt中的add_subdirectory方法

# 顶层CMakeLists
cmake_minimum_required(VERSION 3.0)
project(HELLO VERSION 1.0 LANGUAGES C CXX)
add_subdirectory(src ./bin)
add_subdirectory(libhello ./lib)

生成的可执行文件在build/bin中,生成的lib文件在build/lib中

方法二:修改其他两个文件CMakeLists.txt

# src CMakeLists
include_directories(${PROJECT_SOURCE_DIR}/libhello)
set(APP_SRC main.c)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)
# libhello CMakeLists
set(LIB_SRC hello.c)
set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
add_library(libhello ${LIB_SRC})
  • set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin) 设置可执行文件输出路径
  • set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib) 设置lib库输出路径
示例6:在示例4的基础上,编译动态库
add_library(libhello SHARED ${LIB_SRC})
# 顶层 CMakeLists
cmake_minimum_required(VERSION 3.0)
project(HELLO VERSION 1.0 LANGUAGES C CXX)
option(TEST_DEBUG "option for debug" OFF)
if (TEST_DEBUG)
add_definitions(-DTEST_DEBUG)
endif()
add_definitions(-DBUILD_SHARED)
add_subdirectory(src)
add_subdirectory(libhello)
# src CMakeLists
include_directories(${PROJECT_SOURCE_DIR}/libhello)
set(APP_SRC main.c)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)
# libhello CMakeLists
set(LIB_SRC hello.c)
set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

if(BUILD_SHARED)
  add_library(libhello SHARED ${LIB_SRC})
else()
  add_library(libhello STATIC ${LIB_SRC})
endif()

我们在main.c中使用CMakeLists中定义的宏TEST_DEBUG

// main.c
#include "hello.h"
#include <stdio.h>
int main()
{
    hello("World");
#ifdef TEST_DEBUG
    printf ("DEBUG \n");
#endif
    return 0;
}

执行cmake

cmake .. -DBUILD_SHARED = 1 #生成动态库
cmake .. -DTEST_DEBUG=ON #main.c中的“DEBUG“会打印

参考文章:
https://blog.csdn.net/qq_38410730/article/details/102477162

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 141,469评论 1 298
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 60,715评论 1 254
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 93,259评论 0 211
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 40,730评论 0 173
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 48,426评论 1 252
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,606评论 1 170
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,277评论 2 267
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,066评论 0 163
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 28,821评论 6 227
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,410评论 0 212
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,180评论 2 213
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,498评论 1 223
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,162评论 0 31
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,035评论 2 211
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,412评论 3 201
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,586评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 25,933评论 0 163
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,370评论 2 228
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,487评论 2 229

推荐阅读更多精彩内容

  • 什么是 CMake CMake是个一个开源的跨平台自动化建构系统,用来管理软件建置的程序,并不相依于某特定编译器。...
    苏州韭菜明阅读 22,507评论 6 75
  • 最近在负责一个大型工程的CMake编译系统管理,整理一些工作过程中积累下来的知识片段和技巧。CMake是一个跨平台...
    啊呀哟嘿阅读 8,318评论 0 2
  • CMake 入门实战 从实例入手,讲解 CMake 的常见用法。 什么是 CMake All problems i...
    Nothing_655f阅读 534评论 0 0
  • JNI入门 [TOC] 说明 关于jni api的使用,引用的深入学习,异常与使用优化,请参见我的另一篇文章:JN...
    云佾风徽阅读 1,489评论 0 1
  • 1.cmake_minimum_required(VERSION 3.4.1) 指定cmake最低指示版本2.添...
    yuLiangC阅读 563评论 0 0