更新内容(此版本重构了 90%的代码):
- 重构整个 xmake.lua 描述文件的解释器,更加的灵活可扩展
- 更加严格的语法检测机制
- 更加严格的作用域管理,实现沙盒引擎,对 xmake.lua 中脚本进行沙盒化处理,使得 xmake.lua 更加的安全
- 简化模板的开发,简单几行描述就可以扩展一个新的自定义工程模板
- 增加 task 任务机制,可运行自定义任务脚本
- 实现 plugin 扩展机制,可以很方便扩展实现自定义插件,目前已实现的一些内置插件
- project 文件导出插件(目前已支持 makefile 的生成,后续会支持: vs, xcode 等工程的生成)
- hello xmake 插件(插件 demo )
- doxygen 文档生成插件
- 自定义宏脚本插件(支持动态宏记录、宏回放、匿名宏、批量导入、导出等功能)
- 完全模块化 platforms 、 tools 、 templates 、 actions ,以及通过自注册机制,只需把自定义的脚本放入对应目录,就可实现快速扩展
- 针对所有可扩展脚本所需 api 进行大量简化,并实现大量类库,通过 import 机制进行导入使用
- 移除对 gnu make/nmake 等 make 工具的依赖,不再需要 makefile ,实现自己的 make 算法,
- 优化构建速度,支持多任务编译(支持 vs 编译器)(实测:比 v1.0.4 提升 x4 倍的构建性能)
- 优化自动检测机制,更加的稳定和准确
- 修改部分工程描述 api ,增强扩展性,减少一些命名歧义(对低版本向下兼容)
- 实现异常捕获机制,简化上层调用逻辑
- 优化静态库合并: add_files("*.a"),修复一些 bug
- 增加显示全局构建进度
- 优化交叉编译,通过--sdk=xxx 参数实现更加方便智能的进行交叉编译配置,简化 mingw 平台的编译配置
- 简化命令行配置开关, 支持 xmake config --xxx=[y|n|yes|no|true|false]等开关值
- 增加多个 option 进行宏绑定,实现配置一个参数,就可以同时对多个配置进行生效
- 合并 iphoneos 和 iphonesimulator 平台,以及 watchos 和 watchsimulator 平台,通过 arch 来区分,使得打包更加方便,能够支持一次性打包 iphoneos 的所有 arch 到一个包中
简介
XMake 是一个跨平台自动构建工具,支持在各种主流平台上构建项目,类似 cmake 、 automake 、 premake ,但是更加的方便易用,工程描述语法更简洁直观,支持平台更多,并且集创建、配置、编译、打包、安装、卸载、运行于一体。
支持特性
-
支持 windows 、 mac 、 linux 、 ios 、 android 等平台,自动检测不同平台上的编译工具链(也可手动配置) 编译 windows 项目采用原生 vs 的工具链,不需要使用 cygwin 、 mingw (当然这些也支持)
-
支持自定义平台编译配置,可以很方便的扩展第三方平台支持
-
采用 lua 脚本语法描述项目,描述规则简单高效,逻辑规则可灵活修改,并且不会生成相关平台的工程文件,是工程更加简单明了
-
支持创建模板工程、配置项目、编译项目、运行、打包、安装和卸载等常用功能(后续还会增加:自动生成文档、调试等模块)
-
支持编译 c/c++/objc/swift 成静态库、动态库、命令行可执行程序
-
提供丰富的工程描述 api ,使用简单灵活,例如添加编译文件只需(还支持过滤排除):
add_files("src/*.c", "src/asm/**.S", "src/*.m") -
支持头文件、接口、链接库依赖、类型的自动检测,并可自动生成配置头文件 config.h
-
支持自定义编译配置开关,例如如果在工程描述文件中增加了 enable_xxx 的开关,那么配置编译的时候就可以手动进行配置来启用它:
xmake config --enable_xxx=y -
提供一键打包功能,不管在哪个平台上进行打包,都只需要执行一条相同的命令,非常的方便
-
支持全局配置,一些常用的项目配置,例如工具链、规则描述等等,都可以进行全局配置,这样就不需要每次编译不同工程,都去配置一遍
-
除了可以自动检测依赖模块,也支持手动强制配置模块,还有各种编译 flags 。
-
支持插件扩展、平台扩展、模板扩展、选项自定义等高级功能
-
提供一些内置的常用插件(例如:自动生成 doxygen 文档插件,宏脚本记录和运行插件)
-
宏记录插件里面提供了一些内置的宏脚本(例如:批量打包一个平台的所有 archs 等),也可以在命令行中手动记录宏并回放执行
-
提供强大的 task 任务机制
-
不依赖 makefile 和 make ,实现直接编译,内置自动多任务加速编译, xmake 是一个真正的构架工具,而不仅仅是一个工程文件生成器
-
自动检测 ccache ,进行自动缓存提升构建速度
简单例子
创建一个 c++ console 项目:
xmake create -l c++ -t 1 console
or xmake create --language=c++ --template=1 console
工程描述文件: xmake.lua
target("console")
set_kind("binary")
add_files("src/*.c")
配置工程:
这个是可选的步骤,如果只想编译当前主机平台的项目,是可以不用配置的,默认编译 release 版本。
xmake f -p iphoneos -m debug
or xmake f --plat=macosx --arch=x86_64
or xmake f -p windows
or xmake config --plat=iphoneos --mode=debug
or xmake config --plat=android --arch=armv7-a --ndk=xxxxx
or xmake config -p linux -a i386
or xmake config -p mingw --cross=i386-mingw32- --toolchains=/xxx/bin
or xmake config -p mingw --sdk=/mingwsdk
or xmake config --help
编译工程:
xmake
or xmake -r
or xmake --rebuild
运行目标:
xmake r console
or xmake run console
打包所有:
xmake p
or xmake package
or xmake package console
or xmake package -o /tmp
or xmake package --output=/tmp
通过宏脚本打包所有架构:
xmake m package
or xmake m package -p iphoneos
or xmake m package -p macosx -f "-m debug" -o /tmp/
or xmake m package --help
安装目标:
xmake i
or xmake install
or xmake install console
or xmake install -o /tmp
or xmake install --output=/tmp
详细使用方式和参数说明,请参考文档 或者运行:
xmake -h
or xmake --help
or xmake config --help
or xmake package --help
or xmake macro --help
...
一些使用 xmake 的项目:
后续工作
- 实现生成.ipa 、.apk 、.app 、.deb 、.rmp 的打包插件
- 实现包的自动依赖管理,如果依赖包不存在,会去自动下载编译安装后,继续进行构建,支持交叉平台的包管理
- 实现转换 automake 、 cmake 的工到 xmake 的描述文件的插件,实现无缝编译
- 实现 vs 、 xcode 等工程文件生成插件
简单例子
-- the debug mode
if is_mode("debug") then
-- enable the debug symbols
set_symbols("debug")
-- disable optimization
set_optimize("none")
end
-- the release mode
if is_mode("release") then
-- set the symbols visibility: hidden
set_symbols("hidden")
-- enable fastest optimization
set_optimize("fastest")
-- strip all symbols
set_strip("all")
end
-- add target
target("test")
-- set kind
set_kind("static")
-- add files
add_files("src/*.c")

