Xmake 是一个基于 Lua 的轻量级跨平台构建工具。
它非常的轻量,没有任何依赖,因为它内置了 Lua 运行时。
它使用 xmake.lua 维护项目构建,相比 makefile/CMakeLists.txt,配置语法更加简洁直观,对新手非常友好,短时间内就能快速入门,能够让用户把更多的精力集中在实际的项目开发上。
我们能够使用它像 Make/Ninja 那样可以直接编译项目,也可以像 CMake/Meson 那样生成工程文件,另外它还有内置的包管理系统来帮助用户解决 C/C++ 依赖库的集成使用问题。
目前,Xmake 主要用于 C/C++ 项目的构建,但是同时也支持其他 native 语言的构建,可以实现跟 C/C++ 进行混合编译,同时编译速度也是非常的快,可以跟 Ninja 持平。
Xmake = Build backend + Project Generator + Package Manager + [Remote|Distributed] Build + Cache
尽管不是很准确,但我们还是可以把 Xmake 按下面的方式来理解:
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
- 项目源码
- 官方文档
- 入门课程
新特性介绍
支持 Haiku 系统
Xmake 现在已经完全可以在 Haiku 系统 上运行,并且我们对 Xmake 新增了一个 haiku 编译平台,用于在 Haiku 系统上进行代码编译。
效果如下:
改进 C++20 Modules 支持
最新构建的 clang-17 对 C++20 Modules 做了不少改进,因此我们在 Xmake 中也针对性地对其进行了更好的适配,并且修复了一些 std modules 相关的问题。
关于 C++ Modules 的完整工程例子,可以看下 C++ Modules Examples。
现在也有一些实际的 C++ Modules 项目已经使用了 Xmake 来构建,例如:
- async_simple
- StormKit
改进 API 检测
先前的版本,对 xmake.lua 的配置 API 的传参有效性检测比较弱,仅仅针对 add_includedirs
, add_files
等几个少数的 API 做了检测。
而新版中,我们新增了一个 xmake check
专门用于检测 API 和代码的插件,可以更好地对用户的配置进行检测,避免用户由于不熟悉 Xmake 导致各种配置值设置不对的问题。
另外,除了手动运行 xmake check
命令来触发检测,Xmake 在编译中,编译失败等各个阶段, 也会及时地自动触发一些常规 API 和配置的检测,毕竟不是所有用户都知道 xmake check
这个命令的存在。
默认检测所有 API
set_lanuages("c91") -- typo
$ xmake check ./xmake.lua:15: warning: unknown language value 'c91', it may be 'c90' 0 notes, 1 warnings, 0 errors
默认也可以指定检测特定组:
$ xmake check api $ xmake check api.target
显示详细输出
这会额外提供 note 级别的检测信息。
$ xmake check -v ./xmake.lua:15: warning: unknown language value 'cxx91', it may be 'cxx98' ./src/tbox/xmake.lua:43: note: unknown package value 'mbedtls' ./src/tbox/xmake.lua:43: note: unknown package value 'polarssl' ./src/tbox/xmake.lua:43: note: unknown package value 'openssl' ./src/tbox/xmake.lua:43: note: unknown package value 'pcre2' ./src/tbox/xmake.lua:43: note: unknown package value 'pcre' ./src/tbox/xmake.lua:43: note: unknown package value 'zlib' ./src/tbox/xmake.lua:43: note: unknown package value 'mysql' ./src/tbox/xmake.lua:43: note: unknown package value 'sqlite3' 8 notes, 1 warnings, 0 errors
检测指定的 API
$ xmake check api.target.languages ./xmake.lua:15: warning: unknown language value 'cxx91', it may be 'cxx98' 0 notes, 1 warnings, 0 errors
检测编译 flags
$ xmake check ./xmake.lua:10: warning: clang: unknown c compiler flag '-Ox' 0 notes, 1 warnings, 0 errors
检测 includedirs
除了 includedirs,还有 linkdirs 等路径都会去检测。
$ xmake check ./xmake.lua:11: warning: includedir 'xxx' not found 0 notes, 1 warnings, 0 errors
支持检测工程代码(clang-tidy)
显示 clang-tidy 检测列表
$ xmake check clang.tidy --list Enabled checks: clang-analyzer-apiModeling.StdCLibraryFunctions clang-analyzer-apiModeling.TrustNonnull clang-analyzer-apiModeling.google.GTest clang-analyzer-apiModeling.llvm.CastValue clang-analyzer-apiModeling.llvm.ReturnValue ...
检测所有 targets 中的源码
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
0
指定检测类型
我们可以在 --check=
中指定需要检测的类型,具体用法可以参考 clang-tidy
的 --check=
参数,完全一致的。
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
1
检测指定 target 的代码
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
2
检测给定的源文件列表
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
3
设置 .clang-tidy 配置文件
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
4
创建 .clang-tidy 配置文件
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
5
改进 target 配置来源分析
我们改进了 xmake show -t target
命令对 target 信息的展示,新增了配置来源分析,并且精简了一些相对冗余的信息。
我们可以用它更好地排查定位自己配置的一些 flags 实际来自那一行配置。
显示效果如下:
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
6
改进包的下载配置
如果有些包的 url 下载,需要设置特定 http headers 去鉴权后,才能通过下载,可以通过这个策略来指定。
这通常用于一些公司内部的私有仓库包的维护。
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
7
我们也可以设置指定的 urls 的 http headers:
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
8
改进 dlang 工具链支持
先前的版本,Xmake 仅仅提供了 dlang 这一个工具链,内部会自动取查找 dmd, ldc2, gdc 来适配选择能够获取到的 dlang 编译器去编译项目。
但是这种方式,对用户而言,无法更加灵活地去选择指定的编译器,如果同时安装了 dmd, ldc2,那么 Xmake 总是会优先使用 dmd 作为 dlang 的编译器。
因此,新版本中,xmake 额外提供了三个独立的工具链可以单独选择需要的 dlang 编译器。
比如,运行下面的命令,就可以快速切换到 ldc2 编译器去编译项目。
Xmake ≈ Make/Ninja + CMake/Meson + Vcpkg/Conan + distcc + ccache/sccache
9
除了 ldc 工具链,还有 dmd, gdc 这两个工具链可以单独选择使用。
并且,我们还改进了 dmd/ldc2 的编译优化选项配置,使得生产的 dlang 二进制程序更加的小而快。
支持外置构建目录配置
现有的内置构建目录模式
Xmake 目前提供的构建目录模式,属于内置构建目录,也就是如果我们在当前工程根目录下运行 xmake 命令,就会自动生成 build 目录,并且 .xmake 用于存放一些配置缓存。
set_lanuages("c91") -- typo
0
set_lanuages("c91") -- typo
1
当然,我们可以通过 xmake f -o ../build
去配置修改构建目录,但是 .xmake 目录还是在工程源码目录下。
set_lanuages("c91") -- typo
2
这对于一些喜欢完全代码目录保持完整干净的用户而言,可能并不喜欢这种方式。
新的外置构建目录模式
因此,新版本中,Xmake 提供了另外一种构建目录配置方式,也就是外置目录构建(类似 CMake)。
比如,我们想使用下面这种目录结构去构建项目,总是保持源码目录干净。
set_lanuages("c91") -- typo
3
我们只需要进入需要存储 build/.xmake 目录的工作目录下,然后使用 xmake f -P [projectdir]
配置命令去指定源码根目录即可。
set_lanuages("c91") -- typo
4
配置完成后,源码根目录就被完全记住了,后面的任何构建命令,都不需要再去设置它,就跟之前一样使用就行。
比如,构建,重建,运行或者安装等命令,跟之前的使用完全一致,用户感觉不到任何差异。
set_lanuages("c91") -- typo
5
我们同样可以使用 -o/--buildir
参数去单独设置构建目录到其他地方,例如设置成下面这个结构。
set_lanuages("c91") -- typo
6
set_lanuages("c91") -- typo
7
更新内容
新特性
- 添加 Haiku 支持
- #3326: 添加
xmake check
去检测工程代码 (clang-tidy) 和 API 参数配置 - #3332: 在包中配置添加自定义 http headers
改进
- #3318: 改进 dlang 工具链
- #2591: 改进 target 配置来源分析
- 为 dmd/ldc2 改进 strip/optimization
- #3342: 改进配置构建目录,支持外置目录构建,保持源码目录更加干净
- #3373: 为 clang-17 改进 std 模块支持
Bugs 修复
- #3317: 针对 Qt 工程,修复 lanuages 设置
- #3321: 修复隔天 configfiles 重新生成导致重编问题
- #3296: 修复 macOS arm64 上构建失败
还没有评论,来说两句吧...