CMake构建一个静态链接库的实例

1. 首先是当前这个例子中要用到的一些命令

1.1. add_library

添加一个lib到工程中,指定这个lib的源文件
函数定义

add_library(<name> [STATIC | SHARED | MODULE]
            [EXCLUDE_FROM_ALL]
            source1 [source2 ...])

<name>是目标库的名字,这个名字在工程内全局唯一,最终编译出来的目标文件名字取决于目标平台(比如说lib<name>.a<name>.lib

STATIC, SHARED, 或MODULE用来指定要创建的lib的类型。

  • STATIC, 代表静态链接库,编译的时候link到工程中;
  • SHARED,代表动态链接库,运行时候加载;
  • MODULE,是一些插件,运行时候使用dlopen-like的功能进行动态加载;

EXCLUDE_FROM_ALL 会在目标文件上设置相应的属性(执行默认make的时候,这个目标文件会被排除在外,不被编译)


add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED
            [GLOBAL])

一个Imported Lib目标代表一个工程外部的库文件,当前这个工程内灭有命令来编译这个库,并且这个库的IMPORT属性是true。
没有设置GLOBAL的时候,这个目标名称的作用域只在创建它的目录以及子目录;设置了之后,全局可见。

NOTE: Imported Target通常代表一个工程的一个依赖,一般只能作为诸如target_link_libraries()这样命令的右值,不能修改


add_library(<name> OBJECT <src>...)

创建一个特殊的“object library” 目标。这种库只编译源文件生成目标文件,但是不把这些目标文件打包进一个lib。当其他的库或者目标文件要使用这些目标文件的时候,会以这样的形式来添加,objlib是这个库的名字

add_library(... $<TARGET_OBJECTS:objlib> ...)
add_executable(... $<TARGET_OBJECTS:objlib> ...)

add_library(<name> INTERFACE [IMPORTED [GLOBAL]])

创建一个Interface库,一个INTERFACE库不会直接创建编译目标文件,即使这个库可以设置一些属性并且可以被installed,exported和imported。通常来说使用set_property()target_link_libraries(INTERFACE)target_include_directories(INTERFACE)target_compile_options(INTERFACE)target_compile_definitions(INTERFACE)这些函数来设置INTERFACE_*属性,然后这个库可以像其他库一样作为target_link_libraries()命令的参数。

这里还可以通过设置IMPORTED标志来生成一个INTERFACE imported Target,表示这个库文件在工程外。

1.2. target_include_directories

target_include_directories(<target> [SYSTEM] [BEFORE]
  <INTERFACE|PUBLIC|PRIVATE> [items1...]
  [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])

指定编译目标文件的时候需要包含的路径和内容, <target> 必须是一个已经通过诸如 add_executable()或者add_library()函数创建了的目标,并且不是一个标注成IMPORTED目标。
INTERFACE, PUBLICPRIVATE这些关键字用来指定后面这些参数的作用范围。PUBLICINTERFACE的条目会产生目标对象的INTERFACE_INCLUDE_DIRECTORIES属性(也就是说添加了的公共默认搜索路径),后面的参数定义了包含路径。

指定的包含路径可以是绝对路径也可以是相对路径,重复调用相同的<target>会把这些条目按次序添加到对象上。如果指定了SYSTEM属性,则意味着这个路径是一个系统路径

target_include_directories 的参数可以使用“生成表达式”,语法是$<...>

包含路径的使用要求对于build树和instal树通常是不太一样的。BUILD_INTERFACEINSTALL_INTERFACE 生成表达式可以用来描述不同的使用要求。

target_include_directories(mylib PUBLIC
  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/mylib>
  $<INSTALL_INTERFACE:include/mylib>  # <prefix>/include/mylib
)

2. 实例

  1. 首先看一下当前工程的目录
.
├── CMakeLists.txt
├── include
│   └── Logger.hpp
└── src
    └── Logger.cpp

很简单的一个工程,提供了spdlog的一个简单封装,其他文件要使用日志功能的时候只要包含Logger.hpp头文件就可以了。

  1. 下面是CMakeLists.txt文件
set(module_name logger)
project(${module_name} CXX)

message(STATUS "Configuring ${module_name}")

set(sources 
    src/Logger.cpp
)

set(headers
    include/Logger.hpp
)

#依赖开源的interface库spdlog,添加一个interface类型的库目标
add_library(spdlog INTERFACE)
#给这个interface库添加属性,也就是这个spdlog的头文件的相对路径
target_include_directories(
    spdlog
    INTERFACE
    "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../../externals/spdlog/include>"
)

#spdlog依赖的线程库
find_package(Threads)

#添加要编译的logger库
add_library(${module_name} ${sources} ${headers})  
target_link_libraries(${module_name} spdlog ${CMAKE_THREAD_LIBS_INIT})

#和之前一样,指定需要包含的路径(这个时候spdlog库里面已经包含了spdlog的头文件搜索路径了,所以当前这个logger库就不用额外指定了)
target_include_directories(
    ${module_name} 
    PUBLIC
    "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>"
)
  1. 使用logger库的主工程
    这个cmake只要把logger库link进来就可以了,logger库内的头文件搜索路径都被一并继承了。
set(module_name sctp_proxy)
project(&{module_name} CXX)

add_subdirectory(libs)

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

推荐阅读更多精彩内容