文档章节

xmake从入门到精通10:多个子工程目标的依赖配置

ruki
 ruki
发布于 2019/12/13 09:06
字数 1542
阅读 1.2K
收藏 6

xmake是一个基于Lua的轻量级现代化c/c++的项目构建工具,主要特点是:语法简单易上手,提供更加可读的项目维护,实现跨平台行为一致的构建体验。

本文主要详细讲解下,如果在一个项目中维护和生成多个目标文件的生成,以及它们之间的依赖关系设置。

target到底是什么?

xmake的概念定义里,一个独立的项目工程可能会有多个子工程组织在一起,每个子工程对应只能生成一个唯一的目标文件,例如:可执行程序,静态库或者动态库等。

而这里所说的每个子工程就是xmake里面所说的target,字面意思就是目标子工程

因此每个子工程,我们都可以通过新增一个target在xmake.lua里面维护,例如:

target("test1")
    set_kind("binary")
    add_files("src/test1/*.c")
    
target("test2")
    set_kind("binary")
    add_files("src/test2/*.c")    

上面我们就定义了两个独立的子工程目标,编译时候会生成两个互不依赖的可执行文件。

从根域继承全局设置

暂时先不谈target间的依赖问题,如果我们有许多通用设置,每个target下都得设置一遍,那会非常冗余,也不好维护。

因此,我们可以把这些配置移到target域的外面,也就是根作用域中去设置,这样对当前xmake.lua以及所有子xmake.lua中的target都会生效,例如:

add_links("tbox")
add_linkdirs("lib")
add_includedirs("include")

target("test1")
    set_kind("binary")
    add_files("src/test1/*.c")
    
target("test2")
    set_kind("binary")
    add_files("src/test2/*.c")    

比如这两target都需要链接tbox库,放置在外层根域设置,test1和test2都能加上对应links。

目标间的依赖设置

那如果某个target需要用到另外一个tatget生成的静态库,应该怎么配置呢?

一种方式就是通过add_linkdirsadd_links手动指定对应target最后生成的目录库所在目录,然后把链接加上。

target("foo")
    set_kind("static")
    add_files("foo/*.c")
    add_defines("FOO")

target("test1")
    set_kind("binary")
    add_includedirs("foo/inc")
    add_links("foo")
    add_linkdirs("$(buildir)")
    add_files("test1/*.c")
    add_defines("FOO")
    
target("test2")
    set_kind("binary")
    add_includedirs("foo/inc")
    add_links("foo")
    add_linkdirs("$(buildir)")
    add_files("test2/*.c")
    add_defines("FOO")

上述配置中,test1和test2都会用到libfoo库,并且需要获取到libfoo库的头文件路径,库路径和链接,并且在使用过程中还需要额外设置-DFOO宏定义开关才行。

看上去没啥,其实这么写有两个问题:

  1. test目标和另外两个库目标之间是有编译顺序依赖的,如果test先编译就会提示链接库找不到
  2. 配置太过繁琐不好维护,test1和test2有很多冗余配置

那有没有更加简单可靠的配置方式呢,其实我们只需要add_deps来对target间配置上依赖关系即可。

target("foo")
    set_kind("static")
    add_files("*.c")
    add_defines("FOO", {public = true})
    add_includedirs("foo/inc", {public = true})

target("test1")
    set_kind("binary")
    add_deps("foo")
    add_files("test1/*.c")
    
target("test2")
    set_kind("binary")
    add_deps("foo")
    add_files("test2/*.c")

对比下,test1和test2的配置,是不是精简了好多?仅仅通过add_deps("foo")就继承了libfoo的所有导出设置:linkdirs, links, includedirs以及defines

其中target自身生成的库默认就会自动导出链接设置,而includedirs和defines通过设置public属性,我们也将它们标记为导出,这样可以被test目标继承到。

并且,现在有了依赖关系,xmake在编译的时候,会自动处理这些target之间的编译顺序,保证不会出现链接的时候,libfoo库还没有生成的问题。

依赖继承的进一步解析

级联依赖继承

根据上文所说,target会自动继承依赖目标中的配置和属性,不需要额外调用add_links, add_linkdirsadd_rpathdirs等接口去关联依赖目标了。

并且继承关系是支持级联的,例如:

target("library1")
    set_kind("static")
    add_files("*.c")
    add_includedirs("inc") -- 默认私有头文件目录不会被继承
    add_includedirs("inc1", {public = true}) -- 此处的头文件相关目录也会被继承

target("library2")
    set_kind("static")
    add_deps("library1")
    add_files("*.c")

target("test")
    set_kind("binary")
    add_deps("library2")

上面的配置中,test依赖library2,然后library2又依赖library1,那么通过add_deps仅仅添加library2的依赖,test就可以完整继承整个依赖链上的所有导出设置。

禁用默认的继承行为

那如果我们不想继承依赖target的任何配置,如何操作呢?

add_deps("dep1", "dep2", {inherit = false})

通过显式设置inherit配置,来告诉xmake,这两个依赖的配置是否需要被继承,如果不设置,默认就是启用继承的。

可继承的导出属性详解

上文,我们还通过 add_includedirs("inc1", {public = true}), 设置public为true, 将includedirs的设置公开给其他依赖的子target继承。

目前对于target的编译链接flags相关接口设置,都是支持继承属性的,可以人为控制是否需要导出给其他target来依赖继承,目前支持的属性有:

属性 描述
private 默认设置,作为当前target的私有配置,不会被依赖的其他target所继承
public 公有配置,当前target,依赖的子target都会被设置
interface 接口设置,仅被依赖的子target所继承设置,当前target不参与

这个其实参考借鉴了cmake的设计,目前xmake中只要跟target相关的所有编译链接设置接口,都是支持可见性导出的,例如:add_includedirs, add_defines, add_cflags等等。

关于这块的详细信息,可以看下:https://github.com/xmake-io/xmake/issues/368

原文:https://tboox.org/cn/2019/12/13/quickstart-10-target-deps/

个人主页 个人项目

© 著作权归作者所有

ruki

ruki

粉丝 84
博文 110
码字总数 42725
作品 8
松江
高级程序员
私信 提问
xmake v2.2.2, 让C/C++拥有包依赖自动构建

历经四个多月,[xmake](https://github.com/tboox/xmake)终于更新了新版本v2.2.2,并且上线了重量级功能:原生支持的远程依赖包管理。 而这个特性,其实我陆陆续续写了将近一年的时间,才初步...

ruki
2018/10/17
9
0
xmake vs cmake对比分析

xmake vs cmake对比分析 waruqi 1分钟前暂无评论 阅读 1 次 首先,不得不承认,cmake很强大,发展了这么多年,整个生态已经相当完善,功能也相当丰富,这点xmake目前是比不了的。 当初我做x...

waruqi
2019/06/04
0
0
基于 Lua 的跨平台构建工具 - XMake

简介 XMake是一个基于Lua的轻量级跨平台自动构建工具,支持在各种主流平台上构建项目 xmake的目标是开发者更加关注于项目本身开发,简化项目的描述和构建,并且提供平台无关性,使得一次编写...

ruki
2015/07/16
1.4W
8
xmake v2.0.3 发布,基于 Lua 的跨平台构建工具

xmake v2.0.3 发布了,此版本主要修复一些bugs,以及部分功能性增强,并且增加一些新特性。 新特性 增加头文件依赖自动检测和增量编译,提高编译速度 在终端中进行颜色高亮提示 添加调试器支...

ruki
2016/07/18
1.5K
11
xmake-vscode 1.1.2 发布,断点调试支持

xmake-vscode插件深度集成了xmake和vscode,提供方便快速的跨平台c/c++构建。 此版本主要更新内容如下: 利用C/C++插件vscode-cpptools实现直接加载断点调试xmake编译的程序 多工程目录工作区...

ruki
2018/07/04
1.2K
0

没有更多内容

加载失败,请刷新页面

加载更多

MBTI助你成功,让你更了解你自己

MBTI助你成功,让你更了解你自己 生活总是一个七日接着又一个七日,相信看过第七日的小伙伴,很熟悉这段开场白,人生是一个测试接着又一个测试,上学的时候测试,是为了证明你的智力,可谓从...

蛤蟆丸子
今天
55
0
Android实现App版本自动更新

现在很多的App中都会有一个检查版本的功能。例如斗鱼TV App的设置界面下: 当我们点击检查更新的时候,就会向服务器发起版本检测的请求。一般的处理方式是:服务器返回的App版本与当前手机安...

shzwork
昨天
63
0
npm 发布webpack插件 webpack-html-cdn-plugin

初始化一个项目 npm init 切换到npm源 淘宝 npm config set registry https://registry.npm.taobao.org npm npm config set registry http://registry.npmjs.org 登录 npm login 登录状态......

阿豪boy
昨天
87
0
java基础(16)递归

一.说明 递归:方法内调用自己 public static void run1(){ //递归 run1(); } 二.入门: 三.执行流程: 四.无限循环:经常用 无限递归不要轻易使用,无限递归的终点是:栈内存溢出错误 五.递...

煌sir
昨天
63
0
REST接口设计规范总结

URI格式规范 URI中尽量使用连字符”-“代替下划线”_”的使用 URI中统一使用小写字母 URI中不要包含文件(脚本)的扩展名 URI命名规范 文档(Document)类型的资源用名词(短语)单数命名 集合(Co...

Treize
昨天
69
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部