--- url: /zh/api/description/project-target.md --- # 工程目标 {#project-target} 定义和设置子工程模块，每个`target`对应一个子工程，最后会生成一个目标程序，有可能是可执行程序，也有可能是库模块。 关于如何快速上手目标配置，请参阅[配置目标指南](/zh/guide/project-configuration/configure-targets)。在脚本域（如 `on_load`、`on_build` 等回调中）访问目标实例的接口，请参阅 [target 实例接口](/zh/api/scripts/target-instance)。 :::tip 注意 target的接口，都是可以放置在target外面的全局作用域中的，如果在全局中设置，那么会影响所有子工程target。 ::: 例如： ```lua -- 会同时影响test和test2目标 add_defines("DEBUG") target("test") add_files("*.c") target("test2") add_files("*.c") ``` :::tip 注意 `target`域是可以重复进入来实现分离设置的。 ::: ## 可见性设置 (Visibility) {#visibility} 在 xmake 中，许多接口支持 `visibility` 配置参数，用于控制配置的可见性范围。`visibility` 参数接受一个对象，其中包含以下键值对： | 键名 | 描述 | 示例 | |------|------|------| | `public` | 导出给依赖的子目标，当其他目标依赖此目标时，会继承这些配置 | `{public = true}` | | `interface` | 作为接口导出，仅对依赖此目标的其他目标生效，对当前目标本身不生效 | `{interface = true}` | | `private` | 仅对当前目标生效，不会传递给依赖此目标的其他目标 | `{private = true}` | ### 使用示例 ```lua -- 设置公共可见性，会传递给依赖此目标的其他目标 add_defines("PUBLIC_DEFINE", {public = true}) -- 设置接口可见性，仅对依赖此目标的其他目标生效 add_includedirs("include", {interface = true}) -- 设置私有可见性，仅对当前目标生效 add_defines("PRIVATE_DEFINE", {private = true}) ``` ### 默认行为 如果不指定 `visibility` 参数，大多数接口默认使用 `private` 可见性，即配置仅对当前目标生效。 ## target ### 定义工程目标 #### 函数原型 ::: tip API ```lua target(name: , { kind = , files = , ... }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | name | 目标名称字符串，用于标识工程目标 | | kind | 目标类型字符串，可选值：binary、static、shared、object、headeronly、phony | | files | 源文件路径字符串或数组，支持通配符匹配模式 | | ... | 其他配置选项，如 deps、defines、includedirs 等 | #### 用法说明 定义一个新的控制台工程目标，工程名为`test`，最后生成的目标名也是`test`。 ```lua target("test") set_kind("binary") add_files("src/*.c") ``` 可以重复调用这个api，进入target域修改设置 ```lua -- 定义目标demo，并进入demo设置模式 target("demo") set_kind("binary") add_files("src/demo.c") -- 定义和设置其他目标 target("other") ... -- 重新进入demo目标域，添加test.c文件 target("demo") add_files("src/test.c") ``` :::tip 注意 所有根域的设置，会全局影响所有target目标，但是不会影响option的定义。 ::: ```lua -- 在根域对所有target添加-DDEBUG的宏定义，影响所有target（demo和test都会加上此宏定义） add_defines("DEBUG") target("demo") set_kind("binary") add_files("src/demo.c") target("test") set_kind("binary") add_files("src/test.c") ``` ## target\_end ### 结束定义工程目标 #### 函数原型 ::: tip API ```lua target_end() ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | 无参数 | 此接口不需要任何参数 | #### 用法说明 这是一个可选的api，如果不调用，那么`target("xxx")`之后的所有设置都是针对这个target进行的，除非进入其他`target`, `option`, `task`域。 如果想设置完当前`target`后，显示离开`target`域，进入根域设置，那么可以通过这个api才操作，例如： ```lua target("test") set_kind("static") add_files("src/*.c") target_end() -- 此处已在根域 -- ... ``` 如果不调用这个api的话: ```lua target("test") set_kind("static") add_files("src/*.c") -- 此处还在上面target域中，之后的设置还是针对test进行的设置 -- ... -- 这个时候才离开test，进入另外一个target域中 target("test2") ... ``` ## set\_kind ### 设置目标编译类型 #### 函数原型 ::: tip API ```lua set_kind(kind: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | kind | 目标类型字符串，指定编译目标的类型 | #### 用法说明 设置目标类型，目前支持的类型有： | 值 | 描述 | | ------ | -----------| | phony | 假的目标程序 | | binary | 二进制程序 | | static | 静态库程序 | | shared | 动态库程序 | | object | 仅仅编译对象集合 | | headeronly | 仅仅头文件集合 | #### binary * 可执行文件类型 ```lua target("demo") set_kind("binary") add_files("src/*.c") ``` :::tip 注意 2.5.5 开始，如果没有设置 set\_kind 接口，默认就是 binary 类型。 ::: 所以我们简化为： ```lua target("demo") add_files("src/*.c") ``` 甚至: ```lua target("demo", {files = "src/*.c"}) ``` #### static * 静态库目标类型 ```lua target("demo") set_kind("static") add_files("src/*.c") ``` #### shared * 动态库目标类型 ```lua target("demo") set_kind("shared") add_files("src/*.c") ``` #### object * 纯对象文件列表类型 通常用于两个目标程序间，部分对象文件共享，仅仅编译一次。也可以用于分离对象文件列表，配置不同的编译参数。 #### phony * 空目标类型 它是一个特殊的目标程序类型，它不生成任何实际的程序文件，仅仅用于组合其他目标程序的依赖关系。 ```lua target("test1") set_kind("binary") add_files("src/*.c") target("test2") set_kind("binary") add_files("src/*.c") target("demo") set_kind("phony") add_deps("test1", "test2") ``` 比如上述配置，我们就可以在执行 `xmake build demo` 编译的时候，同时编译相关的两个依赖程序：test1和test2。 #### headeronly * 纯头文件目标类型 2.5.9 之后，我们新增了 `headeronly` 目标类型，这个类型的目标程序，我们不会实际编译它们，因为它没有源文件需要被编译。 但是它包含了头文件列表，这通常用于 headeronly 库项目的安装，IDE 工程的文件列表生成，以及安装阶段的 cmake/pkgconfig 导入文件的生成。 例如： ```lua add_rules("mode.release", "mode.debug") target("foo") set_kind("headeronly") add_headerfiles("src/foo.h") add_rules("utils.install.cmake_importfiles") add_rules("utils.install.pkgconfig_importfiles") ``` 更多详情见：[#1747](https://github.com/xmake-io/xmake/issues/1747) ## set\_strip ### 设置是否strip信息 #### 函数原型 ::: tip API ```lua set_strip(strip: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | strip | strip模式字符串，可选值：debug、all | #### 用法说明 设置当前目标的strip模式，目前支持一下模式： | 值 | 描述 | | ------ | ----------------------------------------- | | debug | 链接的时候，strip掉调试符号 | | all | 链接的时候，strip掉所有符号，包括调试符号 | 这个api一般在release模式下使用，可以生成更小的二进制程序。。 ```lua target("xxxx") set_strip("all") ``` :::tip 注意 这个api不一定非得在target之后使用，如果没有target指定，那么将会设置到全局模式。。 ::: ## set\_enabled ### 设置是否启用或禁用目标 #### 函数原型 ::: tip API ```lua set_enabled(enabled: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | enabled | 是否启用目标，true表示启用，false表示禁用 | #### 用法说明 如果设置`set_enabled(false)`，则会直接禁用对应的target，包括target的加载和信息获取，而[set\_default](#set_default)仅仅只是设置默认不去编译，但是target还是能获取到相关信息的，默认也会被加载。 ## set\_default ### 设置是否为默认构建安装目标 #### 函数原型 ::: tip API ```lua set_default(default: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | default | 是否作为默认构建目标，true表示默认构建，false表示不默认构建 | #### 用法说明 这个接口用于设置给定工程目标是否作为默认构建，如果没有调用此接口进行设置，那么这个目标就是默认被构建的，例如： ```lua target("test1") set_default(false) target("test2") set_default(true) target("test3") ... ``` 上述代码的三个目标，在执行`xmake`, `xmake install`, `xmake package`, `xmake run`等命令的时候，如果不指定目标名，那么： | 目标名 | 行为 | | ------ | -------------------------------- | | test1 | 不会被默认构建、安装、打包和运行 | | test2 | 默认构建、安装、打包和运行 | | test3 | 默认构建、安装、打包和运行 | 通过上面的例子，可以看到默认目标可以设置多个，运行的时候也会依次运行。 :::tip 注意 需要注意的是，`xmake uninstall`和`xmake clean`命令不受此接口设置影响，因为用户大部分情况下都是喜欢清除和卸载所有。 ::: 如果不想使用默认的目标，那么可以手动指定需要构建安装的目标： ```sh $ xmake build targetname $ xmake install targetname ``` 如果要强制构建安装所有目标，可以传入`[-a|--all]`参数： ```sh $ xmake build [-a|--all] $ xmake install [-a|--all] ``` ## set\_options ### 设置关联选项 #### 函数原型 ::: tip API ```lua set_options(options: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | options | 选项名称字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个选项名称字符串 | #### 用法说明 添加选项依赖，如果通过[option](/zh/api/description/configuration-option#option)接口自定义了一些选项，那么只有在指定`target`目标域下，添加此选项，才能进行关联生效。 ```lua -- 定义一个hello选项 option("hello") set_default(false) set_showmenu(true) add_defines("HELLO_ENABLE") target("test") -- 如果hello选项被启用了，这个时候就会将-DHELLO_ENABLE宏应用到test目标上去 set_options("hello") ``` :::tip WARN 只有调用`set_options`进行关联生效后，[option](/zh/api/description/configuration-option#option) 中定义的一些设置才会影响到此`target`目标，例如：宏定义、链接库、编译选项等等 ::: ## set\_symbols ### 设置符号信息 #### 函数原型 ::: tip API ```lua set_symbols(symbols: , { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | symbols | 符号模式字符串，可选值：debug、hidden、none | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 设置目标的符号模式，如果当前没有定义target，那么将会设置到全局状态中，影响所有后续的目标。 目前主要支持一下几个级别： | 值 | 描述 | gcc/clang | msvc | | ------ | ---------------------- | ----- | ---- | | debug | 添加调试符号 | -g | /Zi /Pdxxx.pdb | | debug, edit | 仅 msvc 生效，配合debug级别使用 | 忽略 | /ZI /Pdxxx.pdb | | debug, embed | 仅 msvc 生效，配合debug级别使用 | 忽略 | /Z7 | | hidden | 设置符号不可见 | -fvisibility=hidden | 忽略 | 这两个值也可以同时被设置，例如： ```lua -- 添加调试符号, 设置符号不可见 set_symbols("debug", "hidden") ``` 如果没有调用这个api，默认是禁用调试符号的。。 :::tip 注意 在v2.3.3以上版本，通过跟`set_strip("all")`配合同时设置，可以自动生成独立的调试符号，例如对于ios程序，就是.dSYM文件，对于android等其他程序，就是.sym符号文件。 ::: 如果target同时设置了下面两个设置，就会启用符号文件生成 ```lua target("test") set_symbols("debug") set_strip("all") ``` 对于内置的release模式，默认不启用符号生成，仅仅只是strip targetfile，如果要启用，只需要再额外开启debug符号就行，因为mode.release内部默认已经启用了strip了。 ```lua add_rules("mode.release") target("test") set_symbols("debug") ``` ios程序会生成.dSYM文件，然后同时Strip自身符号 ```sh [ 62%]: linking.release libtest.dylib [ 62%]: generating.release test.dSYM ``` android程序会生成.sym文件（其实就是带符号的so/binary程序），然后同时Strip自身符号 ```sh [ 62%]: linking.release libtest.so [ 62%]: generating.release test.sym ``` v2.3.9 以上版本，新增了 `edit` 和 `embed` 两个额外的附属级别，需要组合 `debug` 级别一起使用，仅用于进一步细分 msvc 编译器的调试符号格式，例如： ```lua set_symbols("debug", "edit") ``` 会从默认的 `-Zi -Pdxxx.pdb` 切换到 `-ZI -Pdxxx.pdb` 编译选项，开启 `Edit and Continue` 调试符号格式信息，当然这并不会影响 gcc/clang 的处理，所以也是完全兼容的。 ## set\_basename ### 设置目标文件名 #### 函数原型 ::: tip API ```lua set_basename(basename: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | basename | 目标文件基础名称字符串 | #### 用法说明 默认情况下，生成的目标文件名基于`target("name")`中配置的值，例如： ```lua -- 目标文件名为：libxxx.a target("xxx") set_kind("static") -- 目标文件名为：libxxx2.so target("xxx2") set_kind("shared") ``` 默认的命名方式，基本上可以满足大部分情况下的需求，但是如果有时候想要更加定制化目标文件名 例如，按编译模式和架构区分目标名，这个时候可以使用这个接口，来设置： ```lua target("xxx") set_kind("static") set_basename("xxx_$(mode)_$(arch)") ``` 如果这个时候，编译配置为：`xmake f -m debug -a armv7`，那么生成的文件名为：`libxxx_debug_armv7.a` 如果还想进一步定制目标文件的目录名，可参考：[set\_targetdir](#set_targetdir)。 或者通过编写自定义脚本，实现更高级的逻辑，具体见：[after\_build](#after_build)和[os.mv](/zh/api/scripts/builtin-modules/os#os-mv)。 ## set\_filename ### 设置目标文件全名 #### 函数原型 ::: tip API ```lua set_filename(filename: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | filename | 目标文件全名字符串，包括前后缀 | #### 用法说明 它跟[set\_basename](#set_basename)的区别在于，[set\_basename](#set_basename)设置名字不带后缀跟前缀，例如：`libtest.a`，basename如果改成test2后就变成了`libtest2.a`。 而filename的修改，是修改整个目标文件名，包括前后缀，例如可以直接把`libtest.a`改成`test.dll`，这个对于[set\_basename](#set_basename)是做不到的。 ## set\_prefixname ### 设置目标文件的前置名 #### 函数原型 ::: tip API ```lua set_prefixname(prefixname: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | prefixname | 目标文件前置名字符串，如 "lib" 或 "" | #### 用法说明 2.5.5 之后版本才支持，可以修改设置目标文件的前置名，例如将默认的：`libtest.so` 改成 `test.so` ```lua target("test") set_prefixname("") ``` ## set\_suffixname ### 设置目标文件的后置名 #### 函数原型 ::: tip API ```lua set_suffixname(suffixname: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | suffixname | 目标文件后置名字符串，如 "-d" 或 "" | #### 用法说明 2.5.5 之后版本才支持，可以修改设置目标文件的后置名，例如将默认的：`libtest.so` 改成 `libtest-d.so` ```lua target("test") set_suffixname("-d") ``` ## set\_extension ### 设置目标文件的扩展名 #### 函数原型 ::: tip API ```lua set_extension(extension: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | extension | 目标文件扩展名字符串，如 ".dll" 或 ".so" | #### 用法说明 2.5.5 之后版本才支持，可以修改设置目标文件的扩展名，例如将默认的：`libtest.so` 改成 `test.dll` ```lua target("test") set_prefixname("") set_extension(".dll") ``` ## set\_warnings ### 设置警告级别 #### 函数原型 ::: tip API ```lua set_warnings(warnings: , { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | warnings | 警告级别字符串，可选值：none、less、more、all、error | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 设置当前目标的编译的警告级别，一般支持一下几个级别： | 值 | 描述 | gcc/clang | msvc | | ----- | ---------------------- | ---------- | ----------------------------- | | none | 禁用所有警告 | -w | -W0 | | less | 启用较少的警告 | -W1 | -W1 | | more | 启用较多的警告 | -W3 | -W3 | | extra | 启用额外警告 | -Wextra | | | pedantic | 启用非语言标准的使用警告| -Wpedantic | | | all | 启用所有警告 | -Wall | -W3 | | allextra | 启用所有警告+额外的警告 | -Wall -Wextra | -W4 | | everything | 启用全部支持的警告 | -Wall -Wextra -Weffc++ / -Weverything | -Wall | | error | 将所有警告作为编译错误 | -Werror | -WX | 这个api的参数是可以混合添加的，例如： ```lua -- 启用所有警告，并且作为编译错误处理 set_warnings("all", "error") ``` 如果当前没有目标，调用这个api将会设置到全局模式。。 ## set\_optimize ### 设置优化级别 #### 函数原型 ::: tip API ```lua set_optimize(optimize: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | optimize | 优化级别字符串，可选值：none、fast、faster、fastest、smallest、aggressive | #### 用法说明 设置目标的编译优化等级，如果当前没有设置目标，那么将会设置到全局状态中，影响所有后续的目标。 目前主要支持一下几个级别： | 值 | 描述 | gcc/clang | msvc | | ---------- | ---------------------- | ---------- | ------------ | | none | 禁用优化 | -O0 | -Od | | fast | 快速优化 | -O1 | default | | faster | 更快的优化 | -O2 | -O2 | | fastest | 最快运行速度的优化 | -O3 | -Ox -fp:fast | | smallest | 最小化代码优化 | -Os | -O1 -GL | | aggressive | 过度优化 | -Ofast | -Ox -fp:fast | 例如： ```lua -- 最快运行速度的优化 set_optimize("fastest") ``` ## set\_languages ### 设置代码语言标准 #### 函数原型 ::: tip API ```lua set_languages(languages: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | languages | 语言标准字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个语言标准字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 设置目标代码编译的语言标准，如果当前没有目标存在，将会设置到全局模式中。。。 支持的语言标准目前主要有以下几个： | 值 | 描述 | | ---------- | ---------------------- | | ansi | c语言标准: ansi | | c89 | c语言标准: c89 | | gnu89 | c语言标准: gnu89 | | c99 | c语言标准: c99 | | gnu99 | c语言标准: gnu99 | | c11 | c语言标准: c11 | | c17 | c语言标准: c17 | | clatest | c语言标准: clatest | | 值 | 描述 | | ---------- | ---------------------- | | cxx98 | c++语言标准: `c++98` | | gnuxx98 | c++语言标准: `gnu++98` | | cxx11 | c++语言标准: `c++11` | | gnuxx11 | c++语言标准: `gnu++11` | | cxx14 | c++语言标准: `c++14` | | gnuxx14 | c++语言标准: `gnu++14` | | cxx1z | c++语言标准: `c++1z` | | gnuxx1z | c++语言标准: `gnu++1z` | | cxx17 | c++语言标准: `c++17` | | gnuxx17 | c++语言标准: `gnu++17` | | cxx20 | c++语言标准: `c++20` | | gnuxx20 | c++语言标准: `gnu++20` | | cxxlatest | c++语言标准: `c++latest` | | gnuxxlatest | c++语言标准: `gnu++latest` | c标准和c++标准可同时进行设置，例如： ```lua -- 设置c代码标准：c99， c++代码标准：c++11 set_languages("c99", "cxx11") ``` 并不是设置了指定的标准，编译器就一定会按这个标准来编译，毕竟每个编译器支持的力度不一样，但是xmake会尽最大可能的去适配当前编译工具的支持标准。 msvc 的编译器并不支持按 c99 的标准来编译c代码，只能支持到c89，但是xmake为了尽可能的支持它，所以在设置c99的标准后，xmake会强制按c++代码模式去编译c代码，从一定程度上解决了windows下编译c99的c代码问题。。 用户不需要去额外做任何修改。 不过最新的 msvc 编译已经支持上了 c11/c17 标准，xmake 也就不会再做额外的特殊处理。 ## set\_fpmodels ### 设置float-point编译模式 #### 函数原型 ::: tip API ```lua set_fpmodels(fpmodels: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | fpmodels | 浮点模式字符串或数组，可选值：fast、strict、except、precise | | ... | 可变参数，可传入多个浮点模式字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 此接口用于设置浮点的编译模式，对数学计算相关优化的编译抽象设置，提供：fast, strict, except, precise 等几种常用的级别，有些可同时设置，有些是有冲突的，最后设置的生效。 关于这些级别的说明，可以参考下微软的文档：[Specify floating-point behavior](https://docs.microsoft.com/en-us/cpp/build/reference/fp-specify-floating-point-behavior?view=vs-2019) 当然，对应gcc/icc等其他编译器，xmake 会映射到不同的编译flags。 ```lua set_fpmodels("fast") set_fpmodels("strict") set_fpmodels("fast", "except") set_fpmodels("precise") -- default ``` 关于这块详情见： ## set\_targetdir ### 设置生成目标文件目录 #### 函数原型 ::: tip API ```lua set_targetdir(targetdir: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | targetdir | 目标文件输出目录路径字符串 | #### 用法说明 设置目标程序文件的输出目录，一般情况下，不需要设置，默认会输出在build目录下 而build的目录可以在工程配置的时候，手动修改： ```sh xmake f -o /tmp/build ``` 修改成`/tmp/build`后，目标文件默认输出到`/tmp/build`下面。 而如果用这个接口去设置，就不需要每次敲命令修改了，例如： ```lua target("test") set_targetdir("/tmp/build") ``` :::tip 注意 如果显示设置了`set_targetdir`， 那么优先选择`set_targetdir`指定的目录为目标文件的输出目录。 ::: 从 3.0 开始，我们还可以配置 bindir, libdir, includedir 等构建输出的子目录，例如： ```lua target("test") set_kind("shared") add_files("src/x.cpp") set_targetdir("$(builddir)/out", { bindir = "bin", libdir = "lib" }) ``` ## set\_objectdir ### 设置对象文件生成目录 #### 函数原型 ::: tip API ```lua set_objectdir(objectdir: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | objectdir | 对象文件输出目录路径字符串 | #### 用法说明 设置目标target的对象文件(`*.o/obj`)的输出目录，例如: ```lua target("test") set_objectdir("$(builddir)/.objs") ``` ## set\_dependir ### 设置依赖文件生成目录 #### 函数原型 ::: tip API ```lua set_dependir(dependir: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | dependir | 依赖文件输出目录路径字符串 | #### 用法说明 设置目标target的编译依赖文件(`.deps`)的输出目录，例如: ```lua target("test") set_dependir("$(builddir)/.deps") ``` ## add\_imports ### 为自定义脚本预先导入扩展模块 #### 函数原型 ::: tip API ```lua add_imports(imports: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | imports | 模块名称字符串或数组，如 "core.base.task" | | ... | 可变参数，可传入多个模块名称字符串 | #### 用法说明 通常，我们在[on\_build](#on_build)等自定义脚本内部，可以通过`import("core.base.task")`的方式导入扩展模块， 但是对于自定义脚本比较多的情况下，每个自定义脚本都重复导入一遍，非常的繁琐，那么可以通过这个接口，实现预先导入，例如： ```lua target("test") on_load(function (target) import("core.base.task") import("core.project.project") task.run("xxxx") end) on_build(function (target) import("core.base.task") import("core.project.project") task.run("xxxx") end) on_install(function (target) import("core.base.task") import("core.project.project") task.run("xxxx") end) ``` 通过此接口可以简化为： ```lua target("test") add_imports("core.base.task", "core.project.project") on_load(function (target) task.run("xxxx") end) on_build(function (target) task.run("xxxx") end) on_install(function (target) task.run("xxxx") end) ``` ## add\_rules ### 添加规则到目标 #### 函数原型 ::: tip API ```lua add_rules(rules: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | rules | 规则名称字符串或数组，如 "markdown" | | ... | 可变参数，可传入多个规则名称字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 我们可以通过预先设置规则支持的文件后缀，来扩展其他文件的构建支持： ```lua -- 定义一个markdown文件的构建规则 rule("markdown") set_extensions(".md", ".markdown") on_build(function (target, sourcefile) os.cp(sourcefile, path.join(targetdir(), path.basename(sourcefile) .. ".html")) end) target("test") set_kind("binary") -- 使test目标支持markdown文件的构建规则 add_rules("markdown") -- 添加markdown文件的构建 add_files("src/*.md") add_files("src/*.markdown") ``` 我们可以在add\_rules时传参： ```lua rule("my_rule") on_load(function (target) local my_arg = extraconf("rules", "my_rule", "my_arg") -- "my arg" end) target("test") add_rules("my_rule", { my_arg = "my arg"}) ``` 我们也可以指定应用局部文件到规则，具体使用见：[add\_files](#add_files)。 ## on\_load ### 自定义目标加载脚本 #### 函数原型 ::: tip API ```lua on_load(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 加载脚本函数，接收 target 参数 | #### 用法说明 在target初始化加载的时候，将会执行此脚本，在里面可以做一些动态的目标配置，实现更灵活的目标描述定义，例如： ```lua target("test") on_load(function (target) add("defines", "DEBUG", "TEST=\"hello\"") add("linkdirs", "/usr/lib", "/usr/local/lib") add({includedirs = "/usr/include", "links" = "pthread"}) end) ``` 可以在`on_load`里面，通过`set`, `add` 来动态添加各种target属性。 ## on\_config ### 自定义配置脚本 #### 函数原型 ::: tip API ```lua on_config(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 配置脚本函数，接收 target 参数 | #### 用法说明 在 `xmake config` 执行完成后，Build 之前会执行此脚本，通常用于编译前的配置工作。它与 on\_load 不同的是，on\_load 只要 target 被加载就会执行，执行时机更早。 如果一些配置，无法在 on\_load 中过早配置，那么都可以在 on\_config 中去配置它。 另外，它的执行时机比 before\_build 还要早，大概的执行流程如下： ``` on_load -> after_load -> on_config -> before_build -> on_build -> after_build ``` ## on\_prepare ### 自定义准备阶段脚本 #### 函数原型 ::: tip API ```lua on_prepare(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 准备阶段脚本函数，接收 target, opt 参数 | #### 用法说明 3.0 新增了 on\_prepare 阶段，实现二阶段编译。prepare 阶段会专门用于处理各种源码级的预处理、codegen 以及源码依赖分析，后续才会进入 build 阶段。 on\_prepare 脚本会在所有 build 脚本之前被调用，我们可以在这里做一些准备工作，比如扫描 C++ module 源文件、自动生成代码等。 ```lua rule("scan_module_files") on_prepare(function (target, opt) -- 扫描模块文件 end) ``` on\_prepare 还支持 jobgraph 参数，可以实现并行任务调度： ```lua rule("scan_module_files") on_prepare(function (target, jobgraph, opt) jobgraph:add(target:name() .. "/scanfiles", function (index, total, opt) -- 扫描模块文件 end) end, {jobgraph = true}) ``` ## on\_prepare\_file ### 自定义准备阶段单文件处理脚本 #### 函数原型 ::: tip API ```lua on_prepare_file(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 单文件处理脚本函数，接收 target, sourcefile, opt 参数 | #### 用法说明 通过此接口，可以 hook 内置的准备阶段流程，在 prepare 阶段对每个源文件进行预处理、分析、自动生成等操作。 ```lua target("test") set_kind("binary") add_files("src/*.c") on_prepare_file(function (target, sourcefile, opt) -- 处理单个源文件 end) ``` ## on\_prepare\_files ### 自定义准备阶段批量文件处理脚本 #### 函数原型 ::: tip API ```lua on_prepare_files(script: , {jobgraph = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 批量文件处理脚本函数，接收 target, jobgraph, sourcebatch, opt 参数 | | jobgraph | 是否启用并行任务处理，可选值：true、false | #### 用法说明 通过此接口，可以 hook 内置的准备阶段流程，在 prepare 阶段对一批同类型源文件进行批量预处理、分析、自动生成等操作，支持 jobgraph 并行任务。 通常结合 set\_extensions 使用，针对特定类型文件批量处理： ```lua rule("scan_module_files") set_extensions("*.mpp") on_prepare_files(function (target, jobgraph, sourcebatch, opt) jobgraph:add(target:name() .. "/scanfiles", function (index, total, opt) -- 批量扫描模块文件 end) end, {jobgraph = true}) ``` 参数说明： * `target`：当前目标对象 * `jobgraph`：任务调度对象（可选，需 {jobgraph = true}） * `sourcebatch`：同类型源文件批次对象，sourcebatch.sourcefiles() 获取文件列表 * `opt`：可选参数 ## on\_link ### 自定义链接脚本 #### 函数原型 ::: tip API ```lua on_link(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 链接脚本函数，接收 target 参数 | #### 用法说明 这个是在v2.2.7之后新加的接口，用于定制化处理target的链接过程。 ```lua target("test") on_link(function (target) print("link it") end) ``` ## on\_build ### 自定义编译脚本 #### 函数原型 ::: tip API ```lua on_build(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 编译脚本函数，接收 target 参数 | #### 用法说明 覆盖target目标默认的构建行为，实现自定义的编译过程，一般情况下，并不需要这么做，除非确实需要做一些xmake默认没有提供的编译操作。 你可以通过下面的方式覆盖它，来自定义编译操作： ```lua target("test") -- 设置自定义编译脚本 on_build(function (target) print("build it") end) ``` 注：2.1.5版本之后，所有target的自定义脚本都可以针对不同平台和架构，分别处理，例如： ```lua target("test") on_build("iphoneos|arm*", function (target) print("build for iphoneos and arm") end) ``` 其中如果第一个参数为字符串，那么就是指定这个脚本需要在哪个`平台|架构`下，才会被执行，并且支持模式匹配，例如`arm*`匹配所有arm架构。 当然也可以只设置平台，不设置架构，这样就是匹配指定平台下，执行脚本： ```lua target("test") on_build("windows", function (target) print("build for windows") end) ``` :::tip 注意 一旦对这个target目标设置了自己的build过程，那么xmake默认的构建过程将不再被执行。 ::: ## on\_build\_file ### 自定义编译脚本, 实现单文件构建 #### 函数原型 ::: tip API ```lua on_build_file(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 单文件编译脚本函数，接收 target, sourcefile, opt 参数 | #### 用法说明 通过此接口，可以用来hook指定target内置的构建过程，替换每个源文件编译过程： ```lua target("test") set_kind("binary") add_files("src/*.c") on_build_file(function (target, sourcefile, opt) end) ``` 如果不想重写内置的编译脚本，仅仅只是在编译前后添加一些自己的处理，其实用：[target.before\_build\_file](#before_build_file)和[target.after\_build\_file](#after_build_file)会更加方便，不需要调用`opt.origin`。 ## on\_build\_files ### 自定义编译脚本, 实现多文件构建 #### 函数原型 ::: tip API ```lua on_build_files(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 多文件编译脚本函数，接收 target, sourcebatch, opt 参数 | #### 用法说明 通过此接口，可以用来hook指定target内置的构建过程，替换一批同类型源文件编译过程： ```lua target("test") set_kind("binary") add_files("src/*.c") on_build_files(function (target, sourcebatch, opt) end) ``` 设置此接口后，对应源文件列表中文件，就不会出现在自定义的[target.on\_build\_file](#on_build_file)了，因为这个是包含关系。 其中sourcebatch描述了这批同类型源文件： * `sourcebatch.sourcekind`: 获取这批源文件的类型，比如：cc, as, .. * `sourcebatch.sourcefiles()`: 获取源文件列表 * `sourcebatch.objectfiles()`: 获取对象文件列表 * `sourcebatch.dependfiles()`: 获取对应依赖文件列表，存有源文件中编译依赖信息，例如：xxx.d ## on\_clean ### 自定义清理脚本 #### 函数原型 ::: tip API ```lua on_clean(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 清理脚本函数，接收 target 参数 | #### 用法说明 覆盖target目标的`xmake [c|clean}`的清理操作，实现自定义清理过程。 ```lua target("test") -- 设置自定义清理脚本 on_clean(function (target) -- 仅删掉目标文件 os.rm(targetfile()) end) ``` 一些target接口描述如下： | target接口 | 描述 | | ----------------------------------- | ---------------------------------------------------------------- | | name() | 获取目标名 | | targetfile() | 获取目标文件路径 | | get("kind") | 获取目标的构建类型 | | get("defines") | 获取目标的宏定义 | | get("xxx") | 其他通过 `set_/add_`接口设置的target信息，都可以通过此接口来获取 | | add("links", "pthread") | 添加目标设置 | | set("links", "pthread", "z") | 覆写目标设置 | | deps() | 获取目标的所有依赖目标 | | dep("depname") | 获取指定的依赖目标 | | sourcebatches() | 获取目标的所有源文件列表 | ## on\_package ### 自定义打包脚本 #### 函数原型 ::: tip API ```lua on_package(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 打包脚本函数，接收 target 参数 | #### 用法说明 覆盖target目标的`xmake [p|package}`的打包操作，实现自定义打包过程，如果你想对指定target打包成自己想要的格式，可以通过这个接口自定义它。 这个接口还是挺实用的，例如，编译完jni后，将生成的so，打包进apk包中。 ```lua -- 定义一个android app的测试demo target("demo") -- 生成动态库：libdemo.so set_kind("shared") -- 设置对象的输出目录，可选 set_objectdir("$(builddir)/.objs") -- 每次编译完的libdemo.so的生成目录，设置为app/libs/armeabi set_targetdir("libs/armeabi") -- 添加jni的代码文件 add_files("jni/*.c") -- 设置自定义打包脚本，在使用xmake编译完libdemo.so后，执行xmake p进行打包 -- 会自动使用ant将app编译成apk文件 -- on_package(function (target) -- 使用ant编译app成apk文件，输出信息重定向到日志文件 os.run("ant debug") end) ``` ## on\_install ### 自定义安装脚本 #### 函数原型 ::: tip API ```lua on_install(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 安装脚本函数，接收 target 参数 | #### 用法说明 覆盖target目标的`xmake [i|install}`的安装操作，实现自定义安装过程。 例如，将生成的apk包，进行安装。 ```lua target("test") -- 设置自定义安装脚本，自动安装apk文件 on_install(function (target) -- 使用adb安装打包生成的apk文件 os.run("adb install -r ./bin/Demo-debug.apk") end) ``` ## on\_uninstall ### 自定义卸载脚本 #### 函数原型 ::: tip API ```lua on_uninstall(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 卸载脚本函数，接收 target 参数 | #### 用法说明 覆盖target目标的`xmake [u|uninstall}`的卸载操作，实现自定义卸载过程。 ```lua target("test") on_uninstall(function (target) ... end) ``` ## on\_run ### 自定义运行脚本 #### 函数原型 ::: tip API ```lua on_run(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 运行脚本函数，接收 target 参数 | #### 用法说明 覆盖target目标的`xmake [r|run}`的运行操作，实现自定义运行过程。 例如，运行安装好的apk程序： ```lua target("test") -- 设置自定义运行脚本，自动运行安装好的app程序，并且自动获取设备输出信息 on_run(function (target) os.run("adb shell am start -n com.demo/com.demo.DemoTest") os.run("adb logcat") end) ``` ## before\_prepare ### 在准备阶段之前执行自定义脚本 #### 函数原型 ::: tip API ```lua before_prepare(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 准备前脚本函数，接收 target 参数 | #### 用法说明 不会覆盖默认的准备操作，只是在准备阶段之前增加一些自定义操作。 ```lua target("test") before_prepare(function (target) print("before prepare") end) ``` ## before\_prepare\_file ### 在准备阶段单文件处理前执行自定义脚本 #### 函数原型 ::: tip API ```lua before_prepare_file(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 单文件准备前脚本函数，接收 target, sourcefile, opt 参数 | #### 用法说明 不会覆盖默认的单文件处理操作，只是在 on\_prepare\_file 之前增加一些自定义操作。 ```lua target("test") before_prepare_file(function (target, sourcefile, opt) print("before prepare file") end) ``` ## before\_prepare\_files ### 在准备阶段批量文件处理前执行自定义脚本 #### 函数原型 ::: tip API ```lua before_prepare_files(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 批量文件准备前脚本函数，接收 target, sourcebatch, opt 参数 | #### 用法说明 不会覆盖默认的批量处理操作，只是在 on\_prepare\_files 之前增加一些自定义操作。 ```lua target("test") before_prepare_files(function (target, sourcebatch, opt) print("before prepare files") end) ``` ## before\_link ### 在链接之前执行一些自定义脚本 #### 函数原型 ::: tip API ```lua before_link(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 链接前脚本函数，接收 target 参数 | #### 用法说明 这个是在v2.2.7之后新加的接口，用于在链接之前增加一些自定义的操作。 ```lua target("test") before_link(function (target) print("") end) ``` ## before\_build ### 在构建之前执行一些自定义脚本 #### 函数原型 ::: tip API ```lua before_build(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 构建前脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的构建操作，只是在构建之前增加一些自定义的操作。 ```lua target("test") before_build(function (target) print("") end) ``` ## before\_build\_file ### 自定义编译前的脚本, 实现单文件构建 #### 函数原型 ::: tip API ```lua before_build_file(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 单文件构建前脚本函数，接收 target, sourcefile, opt 参数 | #### 用法说明 通过此接口，可以用来hook指定target内置的构建过程，在每个源文件编译过程之前执行一些自定义脚本： ```lua target("test") set_kind("binary") add_files("src/*.c") before_build_file(function (target, sourcefile, opt) end) ``` ## before\_build\_files ### 自定义编译前的脚本, 实现多文件构建 #### 函数原型 ::: tip API ```lua before_build_files(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 多文件构建前脚本函数，接收 target, sourcebatch, opt 参数 | #### 用法说明 通过此接口，可以用来hook指定target内置的构建过程，在一批同类型源文件编译过程之前执行一些自定义脚本： ```lua target("test") set_kind("binary") add_files("src/*.c") before_build_files(function (target, sourcebatch, opt) end) ``` ## before\_clean ### 在清理之前执行一些自定义脚本 #### 函数原型 ::: tip API ```lua before_clean(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 清理前脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的清理操作，只是在清理之前增加一些自定义的操作。 ```lua target("test") before_clean(function (target) print("") end) ``` ## before\_package ### 在打包之前执行一些自定义脚本 #### 函数原型 ::: tip API ```lua before_package(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 打包前脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的打包操作，只是在打包之前增加一些自定义的操作。 ```lua target("test") before_package(function (target) print("") end) ``` ## before\_install ### 在安装之前执行一些自定义脚本 #### 函数原型 ::: tip API ```lua before_install(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 安装前脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的安装操作，只是在安装之前增加一些自定义的操作。 ```lua target("test") before_install(function (target) print("") end) ``` ## before\_uninstall ### 在卸载之前执行一些自定义脚本 #### 函数原型 ::: tip API ```lua before_uninstall(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 卸载前脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的卸载操作，只是在卸载之前增加一些自定义的操作。 ```lua target("test") before_uninstall(function (target) print("") end) ``` ## before\_run ### 在运行之前执行一些自定义脚本 #### 函数原型 ::: tip API ```lua before_run(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 运行前脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的运行操作，只是在运行之前增加一些自定义的操作。 ```lua target("test") before_run(function (target) print("") end) ``` ## after\_prepare ### 在准备阶段之后执行自定义脚本 #### 函数原型 ::: tip API ```lua after_prepare(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 准备后脚本函数，接收 target 参数 | #### 用法说明 不会覆盖默认的准备操作，只是在准备阶段之后增加一些自定义操作。 ```lua target("test") after_prepare(function (target) print("after prepare") end) ``` ## after\_prepare\_file ### 在准备阶段单文件处理后执行自定义脚本 #### 函数原型 ::: tip API ```lua after_prepare_file(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 单文件准备后脚本函数，接收 target, sourcefile, opt 参数 | #### 用法说明 不会覆盖默认的单文件处理操作，只是在 on\_prepare\_file 之后增加一些自定义操作。 ```lua target("test") after_prepare_file(function (target, sourcefile, opt) print("after prepare file") end) ``` ## after\_prepare\_files ### 在准备阶段批量文件处理后执行自定义脚本 #### 函数原型 ::: tip API ```lua after_prepare_files(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 批量文件准备后脚本函数，接收 target, sourcebatch, opt 参数 | #### 用法说明 不会覆盖默认的批量处理操作，只是在 on\_prepare\_files 之后增加一些自定义操作。 ```lua target("test") after_prepare_files(function (target, sourcebatch, opt) print("after prepare files") end) ``` ## after\_link ### 在链接之后执行一些自定义脚本 #### 函数原型 ::: tip API ```lua after_link(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 链接后脚本函数，接收 target 参数 | #### 用法说明 这个是在v2.2.7之后新加的接口，用于在链接之后增加一些自定义的操作。 ```lua target("test") after_link(function (target) print("") end) ``` ## after\_build ### 在构建之后执行一些自定义脚本 #### 函数原型 ::: tip API ```lua after_build(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 构建后脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的构建操作，只是在构建之后增加一些自定义的操作。 例如，对于ios的越狱开发，构建完程序后，需要用`ldid`进行签名操作 ```lua target("test") after_build(function (target) os.run("ldid -S %s", targetfile()) end) ``` ## after\_build\_file ### 自定义编译前的脚本, 实现单文件构建 #### 函数原型 ::: tip API ```lua after_build_file(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 单文件构建后脚本函数，接收 target, sourcefile, opt 参数 | #### 用法说明 通过此接口，可以用来hook指定target内置的构建过程，在每个源文件编译过程之后执行一些自定义脚本： ```lua target("test") set_kind("binary") add_files("src/*.c") after_build_file(function (target, sourcefile, opt) end) ``` ## after\_build\_files ### 自定义编译前的脚本, 实现多文件构建 #### 函数原型 ::: tip API ```lua after_build_files(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 多文件构建后脚本函数，接收 target, sourcebatch, opt 参数 | #### 用法说明 通过此接口，可以用来hook指定target内置的构建过程，在一批同类型源文件编译过程之后执行一些自定义脚本： ```lua target("test") set_kind("binary") add_files("src/*.c") after_build_files(function (target, sourcebatch, opt) end) ``` ## after\_clean ### 在清理之后执行一些自定义脚本 #### 函数原型 ::: tip API ```lua after_clean(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 清理后脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的清理操作，只是在清理之后增加一些自定义的操作。 一般可用于清理编译某target自动生成的一些额外的临时文件，这些文件xmake默认的清理规则可能没有清理到，例如： ```lua target("test") after_clean(function (target) os.rm("$(builddir)/otherfiles") end) ``` ## after\_package ### 在打包之后执行一些自定义脚本 #### 函数原型 ::: tip API ```lua after_package(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 打包后脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的打包操作，只是在打包之后增加一些自定义的操作。 ```lua target("test") after_package(function (target) print("") end) ``` ## after\_install ### 在安装之后执行一些自定义脚本 #### 函数原型 ::: tip API ```lua after_install(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 安装后脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的安装操作，只是在安装之后增加一些自定义的操作。 ```lua target("test") after_install(function (target) print("") end) ``` ## after\_uninstall ### 在卸载之后执行一些自定义脚本 #### 函数原型 ::: tip API ```lua after_uninstall(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 卸载后脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的卸载操作，只是在卸载之后增加一些自定义的操作。 ```lua target("test") after_uninstall(function (target) print("") end) ``` ## after\_run ### 在运行之后执行一些自定义脚本 #### 函数原型 ::: tip API ```lua after_run(script: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | script | 运行后脚本函数，接收 target 参数 | #### 用法说明 并不会覆盖默认的运行操作，只是在运行之后增加一些自定义的操作。 ```lua target("test") after_run(function (target) print("") end) ``` ## set\_pcheader ### 设置 C 预编译头文件 #### 函数原型 ::: tip API ```lua set_pcheader(header: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | header | C预编译头文件路径字符串 | #### 用法说明 xmake支持通过预编译头文件去加速c程序编译，目前支持的编译器有：gcc, clang和msvc。 使用方式如下： ```lua target("test") set_pcheader("header.h") ``` ## set\_pcxxheader ### 设置 C++ 预编译头文件 #### 函数原型 ::: tip API ```lua set_pcxxheader(header: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | header | C++预编译头文件路径字符串 | #### 用法说明 xmake支持通过预编译头文件去加速c++程序编译，目前支持的编译器有：gcc, clang和msvc。 使用方式如下： ```lua target("test") set_pcxxheader("header.h") ``` ## set\_pmheader ### 设置 ObjC 预编译头文件 #### 函数原型 ::: tip API ```lua set_pmheader(header: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | header | ObjC预编译头文件路径字符串 | #### 用法说明 xmake支持通过预编译头文件去加速 ObjC 程序编译，目前支持的编译器有：gcc, clang和msvc。 使用方式如下： ```lua target("test") set_pmheader("header.h") ``` ## set\_pmxxheader ### 设置 ObjC++ 预编译头文件 #### 函数原型 ::: tip API ```lua set_pmxxheader(header: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | header | ObjC++预编译头文件路径字符串 | #### 用法说明 xmake支持通过预编译头文件去加速 ObjC++ 程序编译，目前支持的编译器有：gcc, clang和msvc。 使用方式如下： ```lua target("test") set_pmxxheader("header.h") ``` ## add\_deps ### 添加子工程目标依赖 #### 函数原型 ::: tip API ```lua add_deps(deps: , ..., { inherit = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | deps | 依赖目标名称字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个依赖目标名称字符串 | | inherit | 是否继承依赖目标的配置，可选值：true（继承）、false（不继承） | #### 用法说明 添加当前目标的依赖目标，编译的时候，会去优先编译依赖的目标，然后再编译当前目标。。。 ```lua target("test1") set_kind("static") set_files("*.c") target("test2") set_kind("static") set_files("*.c") target("demo") add_deps("test1", "test2") ``` 上面的例子，在编译目标demo的时候，需要先编译test1, test2目标，因为demo会去用到他们 :::tip 注意 target会自动继承依赖目标中的配置和属性，不需要额外调用`add_links`, `add_linkdirs`和`add_rpathdirs`等接口去关联依赖目标了。 ::: 并且继承关系是支持级联的，例如： ```lua 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") ``` 如果我们不想继承依赖target的任何配置，如何操作呢？ ```lua add_deps("dep1", "dep2", {inherit = false}) ``` 通过显式设置inherit配置，来告诉xmake，这两个依赖的配置是否需要被继承，如果不设置，默认就是启用继承的。 2.2.5版本之后，可通过 `add_includedirs("inc1", {public = true})`, 设置public为true, 将includedirs的设置公开给其他依赖的子target继承。 目前对于target的编译链接flags相关接口设置，都是支持继承属性的，可以人为控制是否需要导出给其他target来依赖继承，目前支持的属性有： | 属性 | 描述 | | ---- | ---- | | private | 默认设置，作为当前target的私有配置，不会被依赖的其他target所继承 | | public | 公有配置，当前target，依赖的子target都会被设置 | | interface | 接口设置，仅被依赖的子target所继承设置，当前target不参与 | 对于这块的详细说明，可以看下：https://github.com/xmake-io/xmake/issues/368 ## add\_links ### 添加链接库名 #### 函数原型 ::: tip API ```lua add_links(links: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | links | 链接库名称字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个链接库名称字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 为当前目标添加链接库，一般这个要与[add\_linkdirs](#add_linkdirs)配对使用。 ```lua target("demo") -- 添加对libtest.a的链接，相当于 -ltest add_links("test") -- 添加链接搜索目录 add_linkdirs("$(builddir)/lib") ``` 2.8.1 版本开始，add\_links 还支持添加库的完整路径，例如：`add_links("/tmp/libfoo.a")`，显式的指定库文件。 ## add\_syslinks ### 添加系统链接库名 #### 函数原型 ::: tip API ```lua add_syslinks(syslinks: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | syslinks | 系统链接库名称字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个系统链接库名称字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 这个接口使用上跟[add\_links](#add_links)类似，唯一的区别就是，通过这个接口添加的链接库顺序在所有`add_links`之后。 因此主要用于添加系统库依赖，因为系统库的链接顺序是非常靠后的，例如： ```lua add_syslinks("pthread", "m", "dl") target("demo") add_links("a", "b") add_linkdirs("$(builddir)/lib") ``` 上面的配置，即使`add_syslinks`被优先提前设置了，但最后的链接顺序依然是：`-la -lb -lpthread -lm -ldl` ## add\_linkorders ### 调整链接顺序 #### 函数原型 ::: tip API ```lua add_linkorders(linkorders: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | linkorders | 链接顺序字符串或数组，如 "dep1", "dep2" | | ... | 可变参数，可传入多个链接顺序字符串 | #### 用法说明 这是 xmake 2.8.5 以后的版本才支持的特性，主要用于调整 target 内部的链接顺序。 由于 xmake 提供了 `add_links`, `add_deps`, `add_packages`, `add_options` 接口，可以配置目标、依赖，包和选项中的链接。 但是它们之间的链接顺序，在之前可控性比较弱，只能按固定顺序生成，这对于一些复杂的项目，就有点显得力不从心了。 更多详情和背景见：[#1452](https://github.com/xmake-io/xmake/issues/1452) #### 排序链接 为了更加灵活的调整 target 内部的各种链接顺序，我们新增了 `add_linkorders` 接口，用于配置目标、依赖、包、选项、链接组引入的各种链接顺序。 例如： ```lua add_links("a", "b", "c", "d", "e") -- e -> b -> a add_linkorders("e", "b", "a") -- e -> d add_linkorders("e", "d") ``` add\_links 是配置的初始链接顺序，然后我们通过 add\_linkorders 配置了两个局部链接依赖 `e -> b -> a` 和 `e -> d` 后。 xmake 内部就会根据这些配置，生成 DAG 图，通过拓扑排序的方式，生成最终的链接顺序，提供给链接器。 当然，如果存在循环依赖，产生了环，它也会提供警告信息。 #### 排序链接和链接组 另外，对于循环依赖，我们也可以通过 `add_linkgroups` 配置链接组的方式也解决。 并且 `add_linkorders` 也能够对链接组进行排序。 ```lua add_links("a", "b", "c", "d", "e") add_linkgroups("c", "d", {name = "foo", group = true}) add_linkorders("e", "linkgroup::foo") ``` 如果要排序链接组，我们需要对每个链接组取个名，`{name = "foo"}` ，然后就能在 `add_linkorders` 里面通过 `linkgroup::foo` 去引用配置了。 2.9.6 版本新增 as\_needed 配置项，可以用于禁用 as\_needed。（默认不配置，就是开启状态。） ```lua add_linkgroups("c", "d", {as_needed = false}) ``` 对应的 flags 如下。 ```sh -Wl,--no-as-needed c d -Wl,--as-needed ``` #### 排序链接和frameworks 我们也可以排序链接和 macOS/iPhoneOS 的 frameworks。 ```lua add_links("a", "b", "c", "d", "e") add_frameworks("Foundation", "CoreFoundation") add_linkorders("e", "framework::CoreFoundation") ``` #### 完整例子 相关的完整例子，我们可以看下： ```lua add_rules("mode.debug", "mode.release") add_requires("libpng") target("bar") set_kind("shared") add_files("src/foo.cpp") add_linkgroups("m", "pthread", {whole = true}) target("foo") set_kind("static") add_files("src/foo.cpp") add_packages("libpng", {public = true}) target("demo") set_kind("binary") add_deps("foo") add_files("src/main.cpp") if is_plat("linux", "macosx") then add_syslinks("pthread", "m", "dl") end if is_plat("macosx") then add_frameworks("Foundation", "CoreFoundation") end add_linkorders("framework::Foundation", "png16", "foo") add_linkorders("dl", "linkgroup::syslib") add_linkgroups("m", "pthread", {name = "syslib", group = true}) ``` 完整工程在：[linkorders example](https://github.com/xmake-io/xmake/blob/master/tests/projects/c%2B%2B/linkorders/xmake.lua) ## add\_linkgroups ### 添加链接组 #### 函数原型 ::: tip API ```lua add_linkgroups(linkgroups: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | linkgroups | 链接组名称字符串或数组，如 "group1", "group2" | | ... | 可变参数，可传入多个链接组名称字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 这是 xmake 2.8.5 以后的版本才支持的特性，这个链接组的特性，目前主要用于 linux 平台的编译，仅支持 gcc/clang 编译器。 需要注意的是 gcc/clang 里面的链接组概念主要特指：`-Wl,--start-group` 而 xmake 对齐进行了封装，做了进一步抽象，并且不仅仅用于处理 `-Wl,--start-group`，还可以处理 `-Wl,--whole-archive` 和 `-Wl,-Bstatic`。 下面我们会一一对其进行讲解。 更多详情见：[#1452](https://github.com/xmake-io/xmake/issues/1452) #### --start-group 支持 `-Wl,--start-group` 和 `-Wl,--end-group` 是用于处理复杂库依赖关系的链接器选项，确保链接器可以解决符号依赖并成功连接多个库。 在 xmake 中，我们可以通过下面的方式实现： ```lua add_linkgroups("a", "b", {group = true}) ``` 它会对应生成 `-Wl,--start-group -la -lb -Wl,--end-group` 链接选项。 如果 a 和 b 库之间有符号的循环依赖，也不会报链接错误，能够正常链接成功。 对于不支持的平台和编译，会退化成 `-la -lb` #### --whole-archive 支持 `--whole-archive` 是一个链接器选项，通常用于处理静态库。 它的作用是告诉链接器将指定的静态库中的所有目标文件都包含到最终可执行文件中，而不仅仅是满足当前符号依赖的目标文件。 这可以用于确保某些库的所有代码都被链接，即使它们在当前的符号依赖关系中没有直接引用。 更多信息，可以参考 gcc/clang 的文档。 在 xmake 中，我们可以通过下面的方式实现： ```lua add_linkgroups("a", "b", {whole = true}) ``` 它会对应生成 `-Wl,--whole-archive -la -lb -Wl,--no-whole-archive` 链接选项。 对于不支持的平台和编译，会退化成 `-la -lb` 另外，我们可以同时配置 group/whole： ```lua add_linkgroups("a", "b", {whole = true, group = true}) ``` #### -Bstatic 支持 `-Bstatic` 也是用于编译器（如gcc）的选项，用于指示编译器在链接时只使用静态库而不使用共享库。 更多信息，可以参考 gcc/clang 的文档。 在 xmake 中，我们可以通过下面的方式实现： ```lua add_linkgroups("a", "b", {static = true}) ``` 它会对应生成 `-Wl,-Bstatic -la -lb -Wl,-Bdynamic` 链接选项。 ## add\_files ### 添加源代码文件 #### 函数原型 ::: tip API ```lua add_files(files: , ..., { defines = , languages = , includedirs = , rules = , force = {$flags}, sourcekind = , $flags = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | files | 文件路径字符串或文件路径数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个文件路径字符串 | | defines | 宏定义字符串或数组，为指定文件设置编译宏定义 | | languages | 语言标准字符串，如 "c99", "c++11" 等 | | includedirs | 头文件搜索目录字符串或数组 | | rules | 自定义构建规则名称字符串 | | force | 强制编译选项对象，禁用自动检测，可包含各种编译选项 | | sourcekind | 强制指定源文件类型字符串，如 "cc", "cxx" 等 | | $flags | 各种编译和链接选项，包括 cflags, cxflags, cxxflags, mflags, mxflags, mxxflags, scflags, asflags, gcflags, dcflags, rcflags, fcflags, zcflags, cuflags, culdflags, cugencodes, ldflags, arflags, shflags 等 | #### 用法说明 用于添加目标工程的源文件，甚至库文件，目前支持的一些文件类型： | 支持的源文件类型 | 描述 | | ------------------ | ---------------------------------- | | .c/.cpp/.cc/.cxx | c++文件 | | .s/.S/.asm | 汇编文件 | | .m/.mm | objc文件 | | .swift | swift文件 | | .go | golang文件 | | .o/.obj | 对象文件 | | .a/.lib | 静态库文件，会自动合并库到目标程序 | | .rc | msvc的资源文件 | | .manifest | windows manifest 文件 | | .def | windows dll 导出文件 | | .ld/.lds | linker scripts 文件，通常用于 gcc/clang | | .map/.ver | version script 文件，通常用于 gcc/clang | 其中通配符`*`表示匹配当前目录下文件，而`**`则匹配多级目录下的文件。 例如： ```lua add_files("src/test_*.c") add_files("src/xxx/**.cpp") add_files("src/asm/*.S", "src/objc/**/hello.m") ``` `add_files`的使用其实是相当灵活方便的，其匹配模式借鉴了premake的风格，但是又对其进行了改善和增强。 使得不仅可以匹配文件，还有可以在添加文件同时，过滤排除指定模式的一批文件。 例如： ```lua -- 递归添加src下的所有c文件，但是不包括src/impl/下的所有c文件 add_files("src/**.c|impl/*.c") -- 添加src下的所有cpp文件，但是不包括src/test.cpp、src/hello.cpp以及src下所有带xx_前缀的cpp文件 add_files("src/*.cpp|test.cpp|hello.cpp|xx_*.cpp") ``` 其中分隔符`|`之后的都是需要排除的文件，这些文件也同样支持匹配模式，并且可以同时添加多个过滤模式，只要中间用`|`分割就行了。。 添加文件的时候支持过滤一些文件的一个好处就是，可以为后续根据不同开关逻辑添加文件提供基础。 :::tip 注意 为了使得描述上更加的精简，`|`之后的过滤描述都是基于起一个模式：`src/*.cpp` 中`*`之前的目录为基础的。 所以上面的例子后面过滤的都是在src下的文件，这个是要注意的。 ::: 2.1.6版本之后，对`add_files`进行了改进，支持基于files更细粒度的编译选项控制，例如： ```lua target("test") add_defines("TEST1") add_files("src/*.c") add_files("test/*.c", "test2/test2.c", {defines = "TEST2", languages = "c99", includedirs = ".", cflags = "-O0"}) ``` 可以在`add_files`的最后一个参数，传入一个配置table，去控制指定files的编译选项，里面的配置参数跟target的一致，并且这些文件还会继承target的通用配置`-DTEST1`。 2.1.9版本之后，支持添加未知的代码文件，通过设置rule自定义规则，实现这些文件的自定义构建，例如： ```lua target("test") -- ... add_files("src/test/*.md", {rule = "markdown"}) ``` 关于自定义构建规则的使用说明，详细见：[构建规则](#构建规则)。 并且在2.1.9版本之后，可以通过force参数来强制禁用cxflags,cflags等编译选项的自动检测，直接传入编译器，哪怕编译器有可能不支持，也会设置： ```lua add_files("src/*.c", {force = {cxflags = "-DTEST", mflags = "-framework xxx"}}) ``` 2.3.1版本之后，可以通过sourcekind参数强制使用c或c++编译器： ```lua add_files("*.c", {sourcekind = "cxx"}) -- force to compile as c++ add_files("*.cpp", {sourcekind = "cc"}) -- force to compile as c ``` ## remove\_files ### 从前面的源代码文件列表中删除指定文件 #### 函数原型 ::: tip API ```lua remove_files(files: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | files | 文件路径字符串或文件路径数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个文件路径字符串 | #### 用法说明 通过此接口，可以从前面[add\_files](#add_files)接口添加的文件列表中，删除指定的文件，例如： ```lua target("test") add_files("src/*.c") remove_files("src/test.c") ``` 上面的例子，可以从`src`目录下添加除`test.c`以外的所有文件，当然这个也可以通过`add_files("src/*.c|test.c")`来达到相同的目的，但是这种方式更加灵活。 例如，我们可以条件判断来控制删除哪些文件，并且此接口也支持[add\_files](#add_files)的匹配模式，过滤模式，进行批量移除。 ```lua target("test") add_files("src/**.c") remove_files("src/test*.c") remove_files("src/subdir/*.c|xxx.c") if is_plat("iphoneos") then add_files("xxx.m") end ``` 通过上面的例子，我们可以看出`add_files`和`remove_files`是根据调用顺序，进行顺序添加和删除的，并且通过`remove_files("src/subdir/*.c|xxx.c")`删除一批文件， 并且排除`src/subdir/xxx.c`（就是说，不删除这个文件）。 注： 这个接口 v2.6.3 版本才提供，之前的版本是 del\_files，已经废弃。 如果向下要兼容以前的版本，可以通过下面的配置解决。 ```lua remove_files = remove_files or del_files ``` ## remove\_headerfiles ### 从前面的头文件列表中删除指定文件 #### 函数原型 ::: tip API ```lua remove_headerfiles(headerfiles: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | headerfiles | 头文件路径字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个头文件路径字符串 | #### 用法说明 主要用于从 `add_headerfiles` 设置的头文件列表中删除文件，用法与 `remove_files` 类似。 这个接口，v2.6.3 版本才提供。 ## add\_linkdirs ### 添加链接库搜索目录 #### 函数原型 ::: tip API ```lua add_linkdirs(linkdirs: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | linkdirs | 链接库搜索目录字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个链接库搜索目录字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 设置链接库的搜索目录，这个接口的使用方式如下： ```lua target("test") add_linkdirs("$(builddir)/lib") ``` 此接口相当于gcc的`-Lxxx`链接选项。 一般他是与[add\_links](#add_links)配合使用的，当然也可以直接通过[add\_ldflags](#add_ldflags)或者[add\_shflags](#add_shflags)接口来添加，也是可以的。 :::tip 注意 如果不想在工程中写死，可以通过：`xmake f --linkdirs=xxx`或者`xmake f --ldflags="-L/xxx"`的方式来设置，当然这种手动设置的目录搜索优先级更高。 ::: ## add\_rpathdirs ### 添加程序运行时动态库的加载搜索目录 #### 函数原型 ::: tip API ```lua add_rpathdirs(rpathdirs: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | rpathdirs | 运行时库搜索目录字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个运行时库搜索目录字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 通过[add\_linkdirs](#add_linkdirs)设置动态库的链接搜索目录后，程序被正常链接，但是在linux平台想要正常运行编译后的程序，会报加载动态库失败。 因为没找到动态库的加载目录，想要正常运行依赖动态库的程序，需要设置`LD_LIBRARY_PATH`环境变量，指定需要加载的动态库目录。 但是这种方式是全局的，影响太广，更好的方式是通过`-rpath=xxx`的链接器选项，在链接程序的时候设置好需要加载的动态库搜索路径，而xmake对其进行了封装，通过`add_rpathdirs`更好的处理跨平台问题。 具体使用如下： ```lua target("test") set_kind("binary") add_linkdirs("$(builddir)/lib") add_rpathdirs("$(builddir)/lib") ``` 只需要在链接的时候，在设置下rpath目录就好了，虽然也可以通过`add_ldflags("-Wl,-rpath=xxx")`达到相同的目的，但是这个接口更加通用。 内部会对不同平台进行处理，像在macOS下，是不需要`-rpath`设置的，也是可以正常加载运行程序，因此针对这个平台，xmake内部会直接忽略器设置，避免链接报错。 而在为dlang程序进行动态库链接时，xmake会自动处理成`-L-rpath=xxx`来传入dlang的链接器，这样就避免了直接使用`add_ldflags`需要自己判断和处理不同平台和编译器问题。 2.1.7版本对这个接口进行了改进，支持：`@loader_path`, `@executable_path` 和 `$ORIGIN`的内置变量，来指定程序的加载目录，它们的效果基本上是一样的，主要是为了同时兼容macho, elf。 例如： ```lua target("test") set_kind("binary") add_linkdirs("$(builddir)/lib") add_rpathdirs("@loader_path/lib") ``` 指定test程序加载当前执行目录下`lib/*.[so|dylib]`的动态库文件，这将有助于提升程序的可移植性，不用写死绝对路径和相对路径，导致程序和目录切换引起程序加载动态库失败。 :::tip 注意 需要注意的是，在macos下，要想 add\_rpathdirs 设置生效，需要对dylib做一些预处理，添加`@rpath/xxx`路径设置： ::: `$install_name_tool -add_rpath @rpath/libxxx.dylib xxx/libxxx.dylib` 我们也可以通过`otool -L libxxx.dylib`查看是否存在带@rpath的路径 对于 gcc，未指定 `runpath` 时，`add_rpathdirs` 只传递 `-Wl,-rpath=...`；最终生成 ELF 的 `RUNPATH` 还是 `RPATH`，取决于链接器是否默认启用 new dtags。 可以用 `add_rpathdirs("xxx", {runpath = true})` 显式请求 `RUNPATH`（`--enable-new-dtags`），或用 `add_rpathdirs("xxx", {runpath = false})` 请求 `RPATH`（`--disable-new-dtags`），前提是链接器支持相应参数。 相关背景细节见：[#5109](https://github.com/xmake-io/xmake/issues/5109) 2.9.4 之后，我们新增了 `add_rpathdirs("xxx", {installonly = true})` ，可以单独配置安装后的 rpath 路径。 ## add\_includedirs ### 添加头文件搜索目录 #### 函数原型 ::: tip API ```lua add_includedirs(includedirs: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | includedirs | 头文件搜索目录字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个头文件搜索目录字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 设置头文件的搜索目录，这个接口的使用方式如下： ```lua target("test") add_includedirs("$(builddir)/include") ``` 当然也可以直接通过[add\_cxflags](#add_cxflags)或者[add\_mxflags](#add_mxflags)等接口来设置，也是可以的。 2.2.5之后，可通过额外的`{public|interface = true}`属性设置，将includedirs导出给依赖的子target，例如： ```lua target("test") set_kind("static") add_includedirs("src/include") -- 仅对当前target生效 add_includedirs("$(builddir)/include", {public = true})，当前target和子target都会被设置 target("demo") set_kind("binary") add_deps("test") ``` 更多关于这块的说明，见：[add\_deps](#add_deps) :::tip 注意 如果不想在工程中写死，可以通过：`xmake f --includedirs=xxx`或者`xmake f --cxflags="-I/xxx"`的方式来设置，当然这种手动设置的目录搜索优先级更高。 ::: :::tip 注意 头文件默认不支持模式匹配，也不推荐这么做， 容易引入一些不需要的子目录，导致各种头文件引用冲突干扰，出了问题更难查。 ::: 如果用户非要这么做，可以通过 `add_includedirs(os.dirs(path.join(os.scriptdir(), "xxx/**")))` 来实现。 ## add\_sysincludedirs ### 添加系统头文件搜索目录 #### 函数原型 ::: tip API ```lua add_sysincludedirs(includedirs: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | includedirs | 系统头文件搜索目录字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个系统头文件搜索目录字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 `add_includedirs` 通常用于添加工程头文件搜索目录，而一些系统库头文件的引入，有可能会触发一些内部的警告信息，但是这些警告对于用户来讲也许是无法避免，也修复不了的。 那么，每次显示这些警告反而会干扰用户，因此，gcc/clang 提供了 `-isystem` 专门用来设置系统头文件搜索路径，通过此接口设置的头文件，会压制一些警告信息来避免干扰用户。 msvc 也通提供了 `/external:I` 编译选项来设置它，但是需要高版本 msvc 才支持。 因此，xmake 提供了 `add_sysincludedirs` 来抽象适配设置系统库头文件搜索路径，如果当前编译器不支持，会自动切换回 `-I` 编译选项。 ```lua target("test") add_sysincludedirs("/usr/include") ``` 生成的编译选项如下： ```sh -isystem /usr/include ``` 如果是 msvc 编译器，则会是： ```sh /experimental:external /external:W0 /external:I /usr/include ``` :::tip 注意 另外，使用 `add_requires()` 引入的依赖包，默认也会使用 `-isystem` 作为外部系统头文件。 ::: ## add\_embeddirs ### 添加 #embed 搜索目录 #### 函数原型 ::: tip API ```lua add_embeddirs(embeddirs: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | embeddirs | #embed 搜索目录字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个 #embed 搜索目录字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 设置 C23 `#embed` 预处理器的搜索目录，类似于 `add_includedirs` 的工作方式。此接口用于配置编译器在查找 `#embed` 指令引用的文件时搜索的目录路径。 clang 和 gcc 都支持 C23 `#embed` 特性，并且都提供了 `--embed-dir=` 参数来设置搜索路径。 ```lua target("test") set_kind("binary") set_languages("c23") add_embeddirs("./my_dir") add_files("src/*.c") ``` 也可以根据平台或配置条件设置不同的搜索路径： ```lua target("test") set_kind("binary") set_languages("c23") add_embeddirs("./my_dir") on_config("linux", function(target) target:add("embeddirs", "./linux/embeds") end) add_files("src/*.c") ``` 生成的编译选项如下： ```sh --embed-dir=./my_dir --embed-dir=./linux/embeds ``` :::tip 注意 使用 `#embed` 特性需要设置 C23 语言标准，通过 `set_languages("c23")` 来启用。如果不想在工程中写死，也可以通过 `cxflags`/`cxxflags` 来设置，但需要根据不同编译器提供不同的参数格式，使用 `add_embeddirs` 可以自动适配不同编译器。 ::: :::tip 提示 关于使用 `#embed` 嵌入二进制文件，也可以参考 [utils.bin2c](builtin-rules.md#utilsbin2c) 规则，它提供了另一种将二进制文件嵌入到代码中的方式。 ::: ## add\_defines ### 添加宏定义 #### 函数原型 ::: tip API ```lua add_defines(defines: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | defines | 宏定义字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个宏定义字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 ```lua add_defines("DEBUG", "TEST=0", "TEST2=\"hello\"") ``` 相当于设置了编译选项： ``` -DDEBUG -DTEST=0 -DTEST2=\"hello\" ``` ## add\_undefines ### 取消宏定义 #### 函数原型 ::: tip API ```lua add_undefines(undefines: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | undefines | 宏定义名称字符串或数组，如 "DEBUG" | | ... | 可变参数，可传入多个宏定义名称字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 ```lua add_undefines("DEBUG") ``` 相当于设置了编译选项：`-UDEBUG` 在代码中相当于：`#undef DEBUG` ## add\_cflags ### 添加c编译选项 #### 函数原型 ::: tip API ```lua add_cflags(cflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | cflags | C编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个C编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 仅对c代码添加编译选项 ```lua add_cflags("-g", "-O2", "-DDEBUG") ``` :::tip 注意 所有选项值都基于gcc的定义为标准，如果其他编译器不兼容（例如：vc），xmake会自动内部将其转换成对应编译器支持的选项值。 ::: 用户无需操心其兼容性，如果其他编译器没有对应的匹配值，那么xmake会自动忽略器设置。 在2.1.9版本之后，可以通过force参数来强制禁用flags的自动检测，直接传入编译器，哪怕编译器有可能不支持，也会设置： ```lua add_cflags("-g", "-O2", {force = true}) ``` ## add\_cxflags ### 添加c/c++编译选项 #### 函数原型 ::: tip API ```lua add_cxflags(cxflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | cxflags | C/C++编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个C/C++编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 同时对c/c++代码添加编译选项，用法跟 add\_cflags 一致。 ## add\_cxxflags ### 添加c++编译选项 #### 函数原型 ::: tip API ```lua add_cxxflags(cxxflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | cxxflags | C++编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个C++编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 仅对c++代码添加编译选项，用法跟 add\_cflags 一致。 #### 添加特定编译器 flags 2.7.3 版本中，我们改进了所有 flags 添加接口，可以仅仅对特定编译器指定 flags，例如： ```lua add_cxxflags("clang::-stdlib=libc++") add_cxxflags("gcc::-stdlib=libc++") add_cxxflags("cl::/GR-") add_cxxflags("clang_cl::/GR-") ``` 或者： ```lua add_cxxflags("-stdlib=libc++", {tools = "clang"}) add_cxxflags("-stdlib=libc++", {tools = "gcc"}) add_cxxflags("/GR-", {tools = {"clang_cl", "cl"}}) ``` :::tip 注意 不仅仅是编译flags，对 add\_ldflags 等链接 flags，也是同样生效的。 ::: ## add\_mflags ### 添加objc编译选项 #### 函数原型 ::: tip API ```lua add_mflags(mflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | mflags | ObjC编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个ObjC编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 仅对objc代码添加编译选项 ```lua add_mflags("-g", "-O2", "-DDEBUG") ``` 在2.1.9版本之后，可以通过force参数来强制禁用flags的自动检测，直接传入编译器，哪怕编译器有可能不支持，也会设置： ```lua add_mflags("-g", "-O2", {force = true}) ``` ## add\_mxflags ### 添加objc/objc++编译选项 #### 函数原型 ::: tip API ```lua add_mxflags(mxflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | mxflags | ObjC/ObjC++编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个ObjC/ObjC++编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 同时对objc/objc++代码添加编译选项 ```lua add_mxflags("-framework CoreFoundation") ``` ## add\_mxxflags ### 添加objc++编译选项 #### 函数原型 ::: tip API ```lua add_mxxflags(mxxflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | mxxflags | ObjC++编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个ObjC++编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 仅对objc++代码添加编译选项 ```lua add_mxxflags("-framework CoreFoundation") ``` ## add\_scflags ### 添加swift编译选项 #### 函数原型 ::: tip API ```lua add_scflags(scflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | scflags | Swift编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个Swift编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对swift代码添加编译选项 ```lua add_scflags("xxx") ``` ## add\_asflags ### 添加汇编编译选项 #### 函数原型 ::: tip API ```lua add_asflags(asflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | asflags | 汇编编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个汇编编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对汇编代码添加编译选项 ```lua add_asflags("xxx") ``` ## add\_gcflags ### 添加go编译选项 #### 函数原型 ::: tip API ```lua add_gcflags(gcflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | gcflags | Go编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个Go编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对golang代码添加编译选项 ```lua add_gcflags("xxx") ``` ## add\_dcflags ### 添加dlang编译选项 #### 函数原型 ::: tip API ```lua add_dcflags(dcflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | dcflags | D语言编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个D语言编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对dlang代码添加编译选项 ```lua add_dcflags("xxx") ``` ## add\_rcflags ### 添加rust编译选项 #### 函数原型 ::: tip API ```lua add_rcflags(rcflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | rcflags | Rust编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个Rust编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对rust代码添加编译选项 ```lua add_rcflags("xxx") ``` ## add\_fcflags ### 添加fortran编译选项 #### 函数原型 ::: tip API ```lua add_fcflags(fcflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | fcflags | Fortran编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个Fortran编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对fortran代码添加编译选项 ```lua add_fcflags("xxx") ``` ## add\_zcflags ### 添加zig编译选项 #### 函数原型 ::: tip API ```lua add_zcflags(zcflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | zcflags | Zig编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个Zig编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对zig代码添加编译选项 ```lua add_zcflags("xxx") ``` ## add\_cuflags ### 添加cuda编译选项 #### 函数原型 ::: tip API ```lua add_cuflags(cuflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | cuflags | CUDA编译选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个CUDA编译选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对cuda代码添加编译选项 ```lua add_cuflags("-gencode arch=compute_30,code=sm_30") ``` ## add\_culdflags ### 添加cuda设备链接选项 #### 函数原型 ::: tip API ```lua add_culdflags(culdflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | culdflags | CUDA设备链接选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个CUDA设备链接选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 v2.2.7之后，cuda默认构建会使用device-link，这个阶段如果要设置一些链接flags，则可以通过这个接口来设置。 而最终的程序链接，会使用ldflags，不会调用nvcc，直接通过gcc/clang等c/c++链接器来链接。 关于device-link的说明，可以参考：https://devblogs.nvidia.com/separate-compilation-linking-cuda-device-code/ ```lua add_culdflags("-gencode arch=compute_30,code=sm_30") ``` ## add\_cugencodes ### 添加cuda设备的gencode设置 #### 函数原型 ::: tip API ```lua add_cugencodes(cugencodes: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | cugencodes | CUDA设备gencode设置字符串或数组，如 "sm\_30", "sm\_50" | | ... | 可变参数，可传入多个CUDA设备gencode设置字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 `add_cugencodes()`接口其实就是对`add_cuflags("-gencode arch=compute_xx,code=compute_xx")`编译flags设置的简化封装，其内部参数值对应的实际flags映射关系如下： ```lua - compute_xx --> `-gencode arch=compute_xx,code=compute_xx` - sm_xx --> `-gencode arch=compute_xx,code=sm_xx` - sm_xx,sm_yy --> `-gencode arch=compute_xx,code=[sm_xx,sm_yy]` - compute_xx,sm_yy --> `-gencode arch=compute_xx,code=sm_yy` - compute_xx,sm_yy,sm_zz --> `-gencode arch=compute_xx,code=[sm_yy,sm_zz]` - native --> match the fastest cuda device on current host, eg. for a Tesla P100, `-gencode arch=compute_60,code=sm_60` will be added, if no available device is found, no `-gencode` flags will be added ``` 例如： ```lua add_cugencodes("sm_30") ``` 就等价为 ```lua add_cuflags("-gencode arch=compute_30,code=sm_30") add_culdflags("-gencode arch=compute_30,code=sm_30") ``` 是不是上面的更加精简些，这其实就是个用于简化设置的辅助接口。 而如果我们设置了native值，那么xmake会自动探测当前主机的cuda设备，然后快速匹配到它对应的gencode设置，自动追加到整个构建过程中。 例如，如果我们主机目前的GPU是Tesla P100，并且能够被xmake自动检测到，那么下面的设置： ```lua add_cugencodes("native") ``` 等价于： ```lua add_cugencodes("sm_60") ``` ## add\_ascnpuarchs ### 添加华为昇腾 Ascend C 的 NPU 架构 #### 函数原型 ::: tip API ```lua add_ascnpuarchs(archs: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | archs | 昇腾 NPU 架构字符串或数组，如 "dav-2201" | | ... | 可变参数，可传入多个 NPU 架构字符串 | #### 用法说明 配合 [Ascend C 工具链](custom-toolchain.md) 一起使用，为 `.asc`（Ascend C 内核）和 `.aicpu`（AI-CPU）源文件指定目标 NPU 架构。该值会映射成 Bisheng 编译器的 `--npu-arch=...` 参数。 ```lua target("ascendc_mixed") set_kind("binary") add_files("src/main.asc", "src/helper.aicpu") add_ascnpuarchs("dav-2201") ``` 也支持指定多个架构： ```lua target("ascendc_mixed") set_kind("binary") add_files("src/main.asc") add_ascnpuarchs("dav-2201", "dav-2202") ``` ## add\_ldflags ### 添加链接选项 #### 函数原型 ::: tip API ```lua add_ldflags(ldflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | ldflags | 链接选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个链接选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 添加静态链接选项 ```lua add_ldflags("-L/xxx", "-lxxx") ``` 在添加链接选项时，默认无法支持参数内有空格，使用expand = false： ```lua -- add_ldflags("-L/my lib") ERROR: Invalid arguments add_ldflags({"-L/my lib"}, {expand = false}) -- OK ``` ## add\_arflags ### 添加静态库归档选项 #### 函数原型 ::: tip API ```lua add_arflags(arflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | arflags | 静态库归档选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个静态库归档选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 影响对静态库的生成 ```lua add_arflags("xxx") ``` ## add\_shflags ### 添加动态库链接选项 #### 函数原型 ::: tip API ```lua add_shflags(shflags: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | shflags | 动态库链接选项字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个动态库链接选项字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 影响对动态库的生成 ```lua add_shflags("xxx") ``` ## add\_options ### 添加关联选项 #### 用法说明 这个接口跟[set\_options](#set_options)类似，唯一的区别就是，此处是追加选项，而[set\_options](#set_options)每次设置会覆盖先前的设置。 ## add\_packages ### 添加包依赖 #### 函数原型 ::: tip API ```lua add_packages(packages: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | packages | 包名称字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个包名称字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 在target作用域中，添加集成包依赖，例如： ```lua target("test") add_packages("zlib", "polarssl", "pcre", "mysql") ``` 这样，在编译test目标时，如果这个包存在的，将会自动追加包里面的宏定义、头文件搜索路径、链接库目录，也会自动链接包中所有库。 用户不再需要自己单独调用[add\_links](#add_links)，[add\_includedirs](#add_includedirs), [add\_ldflags](#add_ldflags)等接口，来配置依赖库链接了。 而在v2.2.2版本之后，此接口也同时支持远程依赖包管理中[add\_requires](/zh/api/description/global-interfaces#add-requires)定义的包。 ```lua add_requires("zlib", "polarssl") target("test") add_packages("zlib", "polarssl") ``` v2.2.3之后，还支持覆写内置的links，控制实际链接的库： ```lua -- 默认会有 ncurses, panel, form等links add_requires("ncurses") target("test") -- 显示指定，只使用ncurses一个链接库 add_packages("ncurses", {links = "ncurses"}) ``` 或者干脆禁用links，只使用头文件： ```lua add_requires("lua") target("test") add_packages("lua", {links = {}}) ``` ## add\_languages ### 添加语言标准 #### 函数原型 ::: tip API ```lua add_languages(languages: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | languages | 语言标准字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个语言标准字符串 | 与[set\_languages](#set_languages)类似，唯一区别是这个接口不会覆盖掉之前的设置，而是追加设置。 ## add\_vectorexts ### 添加向量扩展指令 #### 函数原型 ::: tip API ```lua add_vectorexts(vectorexts: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | vectorexts | 向量扩展指令字符串或数组，如 "mmx", "neon", "avx" | | ... | 可变参数，可传入多个向量扩展指令字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | 添加扩展指令优化选项，目前支持以下几种扩展指令集： ```lua add_vectorexts("mmx") add_vectorexts("neon") add_vectorexts("avx", "avx2", "avx512") add_vectorexts("sse", "sse2", "sse3", "ssse3", "sse4.2") ``` :::tip 注意 如果当前设置的指令集编译器不支持，xmake会自动忽略掉，所以不需要用户手动去判断维护，只需要将你需要的指令集全部设置上就行了。 ::: 2.8.2 新增了一个 `all` 配置项，可以用于尽可能的开启所有扩展指令优化。 ```lua add_vectorexts("all") ``` ## add\_frameworks ### 添加链接框架 #### 函数原型 ::: tip API ```lua add_frameworks(frameworks: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | frameworks | 框架名称字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个框架名称字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 目前主要用于`ios`和`macosx`平台的`objc`和`swift`程序，例如： ```lua target("test") add_frameworks("Foundation", "CoreFoundation") ``` 当然也可以使用[add\_mxflags](#add_mxflags)和[add\_ldflags](#add_ldflags)来设置，不过比较繁琐，不建议这样设置。 ```lua target("test") add_mxflags("-framework Foundation", "-framework CoreFoundation") add_ldflags("-framework Foundation", "-framework CoreFoundation") ``` 如果不是这两个平台，这些设置将会被忽略。 ## add\_frameworkdirs ### 添加链接框架搜索目录 #### 函数原型 ::: tip API ```lua add_frameworkdirs(frameworkdirs: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | frameworkdirs | 框架搜索目录字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个框架搜索目录字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | #### 用法说明 对于一些第三方framework，那么仅仅通过[add\_frameworks](#add_frameworks)是没法找到的，还需要通过这个接口来添加搜索目录。 ```lua target("test") add_frameworks("MyFramework") add_frameworkdirs("/tmp/frameworkdir", "/tmp/frameworkdir2") ``` ## set\_toolset ### 设置工具集 #### 函数原型 ::: tip API ```lua set_toolset(toolname: , tool: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | toolname | 工具名称字符串，如 "cc", "cxx", "ld", "ar" | | tool | 工具路径字符串，如 "/usr/bin/gcc" | #### 用法说明 针对特定target单独设置切换某个编译器，链接器，不过我们更推荐使用[set\_toolchains](#set_toolchains)对某个target进行整体工具链的切换。 与set\_toolchains相比，此接口只切换工具链某个特定的编译器或者链接器。 :::tip 注意 2.3.4以上版本才支持此接口，2.3.4之前的set\_toolchain/set\_tool接口会逐步弃用，采用此新接口，用法相同。 ::: 对于`add_files("*.c")`添加的源码文件，默认都是会调用系统最匹配的编译工具去编译，或者通过`xmake f --cc=clang`命令手动去修改，不过这些都是全局影响所有target目标的。 如果有些特殊需求，需要对当前工程下某个特定的target目标单独指定不同的编译器、链接器或者特定版本的编译器，这个时候此接口就可以排上用途了，例如： ```lua target("test1") add_files("*.c") target("test2") add_files("*.c") set_toolset("cc", "$(projectdir)/tools/bin/clang-5.0") ``` 上述描述仅对test2目标的编译器进行特殊设置，使用特定的clang-5.0编译器来编译test2，而test1还是使用默认设置。 :::tip 注意 每次设置都会覆盖当前target目标下之前的那次设置，不同target之间不会被覆盖，互相独立，如果在根域设置，会影响所有子target。 ::: 前一个参数是key，用于指定工具类型，目前支持的有（编译器、链接器、归档器）： | 工具类型 | 描述 | | ------------ | ------------------------------------ | | cc | c编译器 | | cxx | c++编译器 | | mm | objc编译器 | | mxx | objc++编译器 | | gc | go编译器 | | as | 汇编器 | | sc | swift编译器 | | rc | rust编译器 | | dc | dlang编译器 | | fc | fortran编译器 | | sc | swift编译器 | | rust | rust编译器 | | strip | strip程序 | | ld | c/c++/asm/objc等通用可执行程序链接器 | | sh | c/c++/asm/objc等通用动态库链接器 | | ar | c/c++/asm/objc等通用静态库归档器 | | dcld | dlang可执行链接器, rcld/gcld等类似 | | dcsh | dlang动态库链接器, rcsh/gcsh等类似 | 对于一些编译器文件名不规则，导致xmake无法正常识别处理为已知的编译器名的情况下，我们也可以加一个工具名提示，例如： ```lua set_toolset("cc", "gcc@$(projectdir)/tools/bin/mipscc.exe") ``` 上述描述设置mipscc.exe作为c编译器，并且提示xmake作为gcc的传参处理方式进行编译。 ## set\_toolchains ### 设置工具链 #### 函数原型 ::: tip API ```lua set_toolchains(toolchains: , ..., { vs = , plat = , arch = , clang = , gcc = , vs_sdkver = , vs_toolset = , ... = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | toolchains | 工具链名称字符串或数组，如 "gcc", "clang", "msvc", "ndk\[gcc]", "mingw\[clang]@llvm-mingw", "msvc\[vs=2025]" | | vs | Visual Studio 版本，如 "2022", "2025" | | plat | 平台名称，如 "android", "ios" | | arch | 架构名称，如 "arm64", "x64" | | clang | 在 MinGW 工具链中使用 Clang 编译器，布尔值 | | gcc | 在 Android NDK 工具链中使用 GCC 编译器，布尔值 | | vs\_sdkver | Visual Studio SDK 版本 | | vs\_toolset | Visual Studio 工具集版本 | | ... | 可变参数，可传入多个工具链名称字符串 | #### 用法说明 这对某个特定的target单独切换设置不同的工具链，和set\_toolset不同的是，此接口是对完整工具链的整体切换，比如cc/ld/sh等一系列工具集。 这也是推荐做法，因为像gcc/clang等大部分编译工具链，编译器和链接器都是配套使用的，要切就得整体切，单独零散的切换设置会很繁琐。 ### 工具链配置语法 从 xmake 3.0.5 开始，可以使用简化的语法进行工具链配置： ```lua -- 基础工具链名称 set_toolchains("gcc", "clang", "msvc") -- 带配置选项（新语法） set_toolchains("ndk[gcc]") -- 在 Android NDK 中使用 GCC set_toolchains("mingw[clang]@llvm-mingw") -- 在 MinGW 中使用 Clang，来自 llvm-mingw 包 set_toolchains("msvc[vs=2025]") -- 使用 Visual Studio 2025 -- 传统配置语法 set_toolchains("ndk", {gcc = true}) -- 在 Android NDK 中使用 GCC set_toolchains("mingw", {clang = true}) -- 在 MinGW 中使用 Clang（需要 add_requires("llvm-mingw")） set_toolchains("msvc", {vs = "2025"}) set_toolchains("msvc", {vs = "2022", vs_sdkver = "10.0.19041.0"}) set_toolchains("ndk", {plat = "android", arch = "arm64", gcc = true}) ``` ### 包依赖 使用 `mingw[clang]@llvm-mingw` 语法时，需要添加包依赖： ```lua add_requires("llvm-mingw") set_toolchains("mingw[clang]@llvm-mingw") ``` 或使用传统语法： ```lua add_requires("llvm-mingw") set_toolchains("mingw", {clang = true}) ``` ### 命令行使用 也可以通过命令行指定工具链配置： ```bash # 切换到 Android NDK 中的 GCC xmake f -p android --ndk=~/Downloads/android-ndk-r14b/ --toolchain=ndk[gcc] -c # 切换到 MinGW 中的 Clang（包依赖自动处理） xmake f --toolchain=mingw[clang]@llvm-mingw -c # 切换到 Visual Studio 2025 xmake f --toolchain=msvc[vs=2025] -c ``` 比如我们切换test目标到clang+yasm两个工具链： ```lua target("test") set_kind("binary") add_files("src/*.c") set_toolchains("clang", "yasm") ``` 只需要指定工具链名字即可，具体xmake支持哪些工具链，可以通过下面的命令查看： ```sh $ xmake show -l toolchains xcode Xcode IDE vs VisualStudio IDE yasm The Yasm Modular Assembler clang A C language family frontend for LLVM go Go Programming Language Compiler dlang D Programming Language Compiler sdcc Small Device C Compiler cuda CUDA Toolkit ndk Android NDK rust Rust Programming Language Compiler llvm A collection of modular and reusable compiler and toolchain technologies cross Common cross compilation toolchain nasm NASM Assembler gcc GNU Compiler Collection mingw Minimalist GNU for Windows gnu-rm GNU Arm Embedded Toolchain envs Environment variables toolchain fasm Flat Assembler ``` 当然，我们也可以通过命令行全局切换到其他工具链： ```sh $ xmake f --toolchain=clang $ xmake ``` 另外，我们也可以在xmake.lua中自定义toolchain，然后通过`set_toolchains`指定进去，例如： ```lua toolchain("myclang") set_kind("standalone") set_toolset("cc", "clang") set_toolset("cxx", "clang", "clang++") set_toolset("ld", "clang++", "clang") set_toolset("sh", "clang++", "clang") set_toolset("ar", "ar") set_toolset("ex", "ar") set_toolset("strip", "strip") set_toolset("mm", "clang") set_toolset("mxx", "clang", "clang++") set_toolset("as", "clang") -- ... ``` 关于这块的详情介绍，可以到[自定义工具链](/zh/api/description/custom-toolchain)章节查看 更多详情见：[#780](https://github.com/xmake-io/xmake/issues/780) 2.3.5版本开始，新增对toolchains平台和架构的单独设置和切换，比如： ```lua target("test") set_toolchains("xcode", {plat = os.host(), arch = os.arch()}) ``` 如果当前是在交叉编译模式，那么这个test还是会强制切到xcode的本地编译工具链和对应的pc平台上去，这对于想要同时支持部分target使用主机工具链，部分target使用交叉编译工具链时候，非常有用。 但是，这还不是特别方便，尤其是跨平台编译时候，不同平台的pc工具链都是不同的，有msvc, xcode, clang等，还需要判断平台来指定。 因此，我们可以直接使用[set\_plat](#set_plat)和[set\_arch](#set_arch)接口，直接设置特定target到主机平台，就可以内部自动选择host工具链了，例如： ```lua target("test") set_plat(os.host()) set_arch(os.arch()) ``` 这块的应用场景和example可以看下：https://github.com/xmake-io/xmake-repo/blob/dev/packages/l/luajit/port/xmake.lua luajit里面就需要同时编译host平台的minilua/buildvm来生成jit相关代码，然后开始针对性编译luajit自身到不同的交叉工具链。 关于这块详情，可以参考：https://github.com/xmake-io/xmake/pull/857 v2.5.1 对 set\_toolchains 做了进一步的改进，更好地对特定 target 支持独立工具链切换，比如不同 target 支持切换到不同的 vs 版本，例如： ```lua target("test") set_toolchains("msvc", {vs = "2015"}) ``` 默认 xmake 会使用全局 vs 工具链，比如当前检测到 vs2019，但是用户同时还安装了 vs2015，那么可以通过上面的配置将 test 目标切换到 vs2015 来编译。 甚至还可以配合 `set_arch` 来指定特定的架构到 x86，而不是默认的 x64。 ```lua target("test") set_arch("x86") set_toolchains("msvc", {vs = "2015"}) ``` 上面的效果跟 `set_toolchains("msvc", {vs = "2015", arch = "x86"})` 类似，不过 `set_arch` 是针对 target 粒度的，而 `set_toolchains` 里面的 arch 设置仅仅针对特定工具链粒度。 通常，我们更推荐使用 `set_arch` 来对整个target实现架构切换。 v3.0.4 以上版本，对于 mingw 工具链，我们还可以通过 `msystem` 参数来指定使用特定的 MSYS2 环境，例如： ```lua target("ucrt64") set_arch("x86_64") set_kind("binary") add_files("src/*.c") set_toolchains("mingw", {msystem = "ucrt64"}) ``` 这样可以让 xmake 使用 MSYS2 的 ucrt64 环境中的 mingw 工具链来编译，支持的 msystem 值包括：`mingw32`、`mingw64`、`ucrt64`、`clang64` 等。 ## set\_plat ### 设置指定目标的编译平台 #### 函数原型 ::: tip API ```lua set_plat(plat: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | plat | 平台名称字符串，如 "linux", "macosx", "windows", "android" | #### 用法说明 通常配合[set\_arch](#set_arch)使用，将指定target的编译平台切换到指定平台，xmake会自动根据切换的平台，选择合适的工具链。 一般用于需要同时编译host平台目标、交叉编译目标的场景，更多详情见：[set\_toolchains](#set_toolchains) 例如： ```sh $ xmake f -p android --ndk=/xxx ``` 即使正在使用android ndk编译android平台目标，但是其依赖的host目标，还是会切换到主机平台，使用xcode, msvc等host工具链来编译。 ```lua target("host") set_kind("binary") set_plat(os.host()) set_arch(os.arch()) add_files("src/host/*.c") target("test") set_kind("binary") add_deps("host") add_files("src/test/*.c") ``` ## set\_arch ### 设置指定目标的编译架构 #### 函数原型 ::: tip API ```lua set_arch(arch: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | arch | 架构名称字符串，如 "x86", "x64", "arm64", "armv7" | #### 用法说明 详情见：[set\_plat](#set_plat) ## set\_values ### 设置一些扩展配置值 #### 函数原型 ::: tip API ```lua set_values(name: , values: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | name | 配置名称字符串，如 "markdown\_flags" | | values | 配置值，可以是任意类型 | | ... | 可变参数，可传入多个配置值 | #### 用法说明 给target设置一些扩展的配置值，这些配置没有像`set_ldflags`这种内置的api可用，通过第一个参数传入一个配置名，来扩展配置。 一般用于传入配置参数给自定义rule中的脚本使用，例如： ```lua rule("markdown") on_build_file(function (target, sourcefile, opt) -- compile .markdown with flags local flags = values("markdown.flags") if flags then -- .. end end) target("test") add_files("src/*.md", {rule = "markdown"}) set_values("markdown.flags", "xxx", "xxx") ``` 上述代码例子中，可以看出，在target应用markdown规则的时候，通过set\_values去设置一些flags值，提供给markdown规则去处理。 在规则脚本中可以通过`values("markdown.flags")`获取到target中设置的扩展flags值。 :::tip 注意 具体扩展配置名，根据不同的rule，会有所不同，目前有哪些，可以参考相关规则的描述：[内建规则](/zh/api/description/builtin-rules)。 ::: 下面是一些 xmake 目前支持的一些内置的扩展配置项列表。 | 扩展配置名 | 配置描述 | | --- | --- | | fortran.moduledir | 设置 fortran 模块的输出目录 | | ndk.arm\_mode | 设置 ndk 的 arm 编译模式 (arm/thumb) | | objc.build.arc | 设置启用或禁用 objc 的 arc | | objc++.build.arc | 设置启用或禁用 objc++ 的 arc | | xcode.bundle\_identifier | 设置 xcode 工具链的 Bundle Identifier | | xcode.mobile\_provision | 设置 xcode 工具链的证书信息 | | xcode.codesign\_identity | 设置 xcode 工具链的代码签名标识 | | wasm.preloadfiles | 设置 wasm 打包的预加载文件 (preload file) | | wdk.env.winver | 设置 wdk 的 win 支持版本 | | wdk.umdf.sdkver | 设置 wdk 的 umdf sdk 版本 | | wdk.kmdf.sdkver | 设置 wdk 的 kmdf sdk 版本 | | wdk.sign.mode | 设置 wdk 的代码签名模式 | | wdk.sign.store | 设置 wdk 的代码签名 store | | wdk.sign.certfile | 设置 wdk 的代码签名证书文件 | | wdk.sign.thumbprint | 设置 wdk 的代码签名指纹 | | wdk.sign.digest\_algorithm | 设置 wdk 的代码签名摘要算法 | ## add\_values ### 添加一些扩展配置值 #### 函数原型 ::: tip API ```lua add_values(name: , values: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | name | 配置名称字符串，如 "markdown\_flags" | | values | 配置值，可以是任意类型 | | ... | 可变参数，可传入多个配置值 | #### 用法说明 用法跟[set\_values](#set_values)类似，区别就是这个接口是追加设置，而不会每次覆盖设置。 ## set\_rundir ### 设置运行目录 #### 函数原型 ::: tip API ```lua set_rundir(rundir: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | rundir | 运行目录路径字符串 | #### 用法说明 此接口用于设置默认运行target程序的当前运行目录，如果不设置，默认情况下，target是在可执行文件所在目录加载运行。 如果用户想要修改加载目录，一种是通过`on_run()`的方式自定义运行逻辑，里面去做切换，但仅仅为了切个目录就这么做，太过繁琐。 因此可以通过这个接口快速的对默认执行的目录环境做设置切换。 ```lua target("test") set_kind("binary") add_files("src/*.c") set_rundir("$(projectdir)/xxx") ``` ## set\_runargs ### 设置运行参数列表 #### 函数原型 ::: tip API ```lua set_runargs(runargs: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | runargs | 运行参数字符串或数组，如 "-x", "--arg1=val" | | ... | 可变参数，可传入多个运行参数字符串 | #### 用法说明 2.6.9 新增接口，可用于设置 `xmake run` 的默认运行参数，通过它，我们可以避免每次命令行输入运行参数，`xmake run -x --arg1=val` ```lua set_runargs("-x", "--arg1=val") ``` ## add\_runenvs ### 添加运行环境变量 #### 函数原型 ::: tip API ```lua add_runenvs(name: , values: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | name | 环境变量名称字符串，如 "PATH", "LD\_LIBRARY\_PATH" | | values | 环境变量值字符串或数组，支持多个值 | | ... | 可变参数，可传入多个环境变量值 | #### 用法说明 此接口用于添加设置默认运行target程序的环境变量，跟[set\_runenv](#set_runenv)不同的是，此接口是对已有系统env中的值进行追加，并不会覆盖。 所以，对于PATH这种，通过此接口追加值是非常方便的，而且此接口支持多值设置，所以通常就是用来设置带有path sep的多值env。。 ```lua target("test") set_kind("binary") add_files("src/*.c") add_runenvs("PATH", "/tmp/bin", "xxx/bin") add_runenvs("LD_LIBRARY_PATH", "/tmp/lib", "xxx/lib") ``` ## set\_runenv ### 设置运行环境变量 #### 函数原型 ::: tip API ```lua set_runenv(name: , value: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | name | 环境变量名称字符串，如 "PATH", "LD\_LIBRARY\_PATH" | | value | 环境变量值字符串 | 此接口跟[add\_runenvs](#add_runenvs)不同的是，`set_runenv`是对某个环境变量的覆盖设置，会覆盖原有系统环境的env值，并且此接口是单数设置，不能传递多参。 所以，如果要覆盖设置PATH这中多路径的env，需要自己去拼接： ```lua target("test") set_kind("binary") add_files("src/*.c") set_runenv("PATH", path.joinenv("/tmp/bin", "xxx/bin")) set_runenv("NAME", "value") ``` ## set\_installdir ### 设置安装目录 #### 函数原型 ::: tip API ```lua set_installdir(installdir: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | installdir | 安装目录路径字符串 | #### 用法说明 2.2.5版本新增接口，用于针对每个target设置不同的默认安装目录，一般用于`xmake install/uninstall`命令。 默认情况下执行`xmake install`会安装到系统`/usr/local`目录，我们除了可以通过`xmake install -o /usr/local`指定其他安装目录外， 还可以在xmake.lua中针对target设置不同的安装目录来替代默认目录。 除了上述两种方式，我们也可以通过`INSTALLDIR`和`DESTDIR`环境变量设置默认的安装目录。 ## set\_prefixdir ### 设置安装前置子目录 #### 函数原型 ::: tip API ```lua set_prefixdir(prefixdir: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | prefixdir | 安装前置子目录路径字符串 | #### 用法说明 尽管通过 `set_installdir` 和 `xmake install -o [installdir]` 设置了安装根目录，但是如果我们还想进一步调整 bin, lib 和 include 的子路径。 那么，我们可以使用这个接口，默认情况下，安装目录会按照这个结构： ```sh installdir - bin - lib - include ``` 如果我们配置： ```lua set_prefixdir("prefixdir") ``` 就是增加一个总的子目录： ```sh installdir - prefixdir - bin - lib - include ``` 我们还可以单独配置 bin, lib 和 include 子目录，例如： ```lua set_prefixdir("prefixdir", {bindir = "mybin", libdir = "mylib", includedir = "myinc"}) ``` ```sh installdir - prefixdir - mybin - mylib - myinc ``` 如果，我们不配置 prefixdir，仅仅修改 bin 子目录，可以将 prefixdir 配置成 `/`。 ```lua set_prefixdir("/", {bindir = "mybin", libdir = "mylib", includedir = "myinc"}) ``` ```sh installdir - mybin - mylib - myinc ``` ## add\_installfiles ### 添加安装文件 #### 函数原型 ::: tip API ```lua add_installfiles(installfiles: , ..., { prefixdir = , rootdir = , filename = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | installfiles | 安装文件路径字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个安装文件路径字符串 | | prefixdir | 安装前缀目录，可选 | | rootdir | 根目录，可选 | | filename | 文件名，可选 | #### 用法说明 2.2.5版本新增接口，用于针对每个target设置对应需要安装的文件，一般用于`xmake install/uninstall`命令。 比如我们可以指定安装各种类型的文件到安装目录： ```lua target("test") add_installfiles("src/*.h") add_installfiles("doc/*.md") ``` 默认在linux等系统上，我们会安装到`/usr/local/*.h, /usr/local/*.md`，不过我们也可以指定安装到特定子目录： ```lua target("test") add_installfiles("src/*.h", {prefixdir = "include"}) add_installfiles("doc/*.md", {prefixdir = "share/doc"}) ``` 上面的设置，我们会安装到`/usr/local/include/*.h, /usr/local/share/doc/*.md` 注：默认安装不会保留目录结构，会完全展开，当然我们也可以通过`()`去提取源文件中的子目录结构来安装，例如： ```lua target("test") add_installfiles("src/(tbox/*.h)", {prefixdir = "include"}) add_installfiles("doc/(tbox/*.md)", {prefixdir = "share/doc"}) ``` 我们把`src/tbox/*.h`中的文件，提取`tbox/*.h`子目录结构后，在进行安装：`/usr/local/include/tbox/*.h, /usr/local/share/doc/tbox/*.md` 当然，用户也可以通过[set\_installdir](#set_installdir)接口，来配合使用。 关于此接口的详细说明，见：https://github.com/xmake-io/xmake/issues/318 ## add\_headerfiles ### 添加安装头文件 #### 函数原型 ::: tip API ```lua add_headerfiles(headerfiles: , ..., { prefixdir = , rootdir = , filename = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | headerfiles | 头文件路径字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个头文件路径字符串 | | prefixdir | 安装前缀目录，可选 | | rootdir | 根目录，可选 | | filename | 文件名，可选 | #### 用法说明 2.2.5版本新增接口，用于针对每个target设置对应需要安装的头文件，一般用于`xmake install/uninstall`命令。 此接口使用方式跟[add\_installfiles](#add_installfiles)接口几乎完全一样，都可以用来添加安装文件，不过此接口仅用于安装头文件。 因此，使用上比`add_installfiles`简化了不少，默认不设置prefixdir，也会自动将头文件安装到对应的`include`子目录中。 并且此接口对于`xmake project -k vs201x`等插件生成的IDE文件，也会添加对应的头文件进去。 我注：默认安装不会保留目录结构，会完全展开，当然们也可以通过`()`去提取源文件中的子目录结构来安装，例如： ```lua target("test") add_headerfiles("src/(tbox/*.h)", {prefixdir = "include"}) ``` v2.7.1 之后，我们可以通过 `{install = false}` 参数，禁用默认的头文件安装行为，仅仅对设置的头文件用于 project generator 的文件列表展示和编辑，例如 vs project。 ```lua add_headerfiles("src/foo.h") add_headerfiles("src/test.h", {install = false}) ``` 上面两个头文件，在 vs 工程中都会展示出来，但是仅仅 foo.h 会被发布安装到系统。 ## set\_configdir ### 设置模板配置文件的输出目录 #### 函数原型 ::: tip API ```lua set_configdir(configdir: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | configdir | 模板配置文件输出目录路径字符串 | #### 用法说明 2.2.5版本新增接口，主要用于[add\_configfiles](#add_configfiles)接口设置的模板配置文件的输出目录。 ## set\_configvar ### 设置模板配置变量 #### 函数原型 ::: tip API ```lua set_configvar(name: , value: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | name | 配置变量名称字符串，如 "HAS\_FOO" | | value | 配置变量值，可以是任意类型 | #### 用法说明 2.2.5版本新增接口，用于在编译前，添加一些需要预处理的模板配置变量，一般用于[add\_configfiles](#add_configfiles)接口。 ```lua target("test") set_kind("binary") add_files("main.c") set_configvar("HAS_FOO", 1) set_configvar("HAS_BAR", "bar") set_configvar("HAS_ZOO", "zoo", {quote = false}) add_configfiles("config.h.in") ``` config.h.in ```c ${define HAS_FOO} ${define HAS_BAR} ${define HAS_ZOO} ``` 生成的 config.h 内容如下： ```c define HAS_FOO 1 define HAS_BAR "bar" define HAS_ZOO zoo ``` set\_configvar 可以设置 number，string 和 boolean 类型值，如果是 string 值，默认生成的宏定义带有引号，如果要去掉引号，可以设置 `{quote = false}`。 相关 issues 见：[#1694](https://github.com/xmake-io/xmake/issues/1694) 对于，宏定义里面有路径，需要转义处理路径分隔符的，我们也可以配置开启路径字符转义。 ```lua set_configvar("TEST", "C:\\hello", {escape = true}) ``` 它会自动转义成 `#define TEST "C:\\hello"` ，如果没开启转义，则会变成：`#define TEST "C:\hello"` 相关 issues 见：[#1872](https://github.com/xmake-io/xmake/issues/1872) ## add\_configfiles ### 添加模板配置文件 #### 函数原型 ::: tip API ```lua add_configfiles(configfiles: , ..., { prefixdir = , rootdir = , filename = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | configfiles | 配置文件路径字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个配置文件路径字符串 | | prefixdir | 安装前缀目录，可选 | | rootdir | 根目录，可选 | | filename | 文件名，可选 | #### 用法说明 2.2.5版本新增接口，用于在编译前，添加一些需要预处理的配置文件。 先来一个简单的例子： ```lua target("test") set_kind("binary") add_files("src/*.c") set_configdir("$(builddir)/config") add_configfiles("src/config.h.in") ``` 上面的设置，会在编译前，自动的将`config.h.in`这个头文件配置模板，经过预处理后，生成输出到指定的`build/config/config.h`。 如果`set_configdir`不设置，那么默认输出到`build`目录下。 其中`.in`后缀会被自动识别处理掉，如果想要输出存储为其他文件名，可以通过： ```lua add_configfiles("src/config.h", {filename = "myconfig.h"}) ``` 的方式，来重命名输出，同样，这个接口跟[add\_installfiles](#add_configfiles)类似，也是支持prefixdir和子目录提取设置： ```lua add_configfiles("src/*.h.in", {prefixdir = "subdir"}) add_configfiles("src/(tbox/config.h)") ``` #### 变量替换 这个接口的一个最重要的特性就是，可以在预处理的时候，对里面的一些模板变量进行预处理替换，例如： config.h.in ``` define VAR1 "${VAR1}" define VAR2 "${VAR2}" define HELLO "${HELLO}" ``` ```lua set_configvar("VAR1", "1") target("test") set_kind("binary") add_files("main.c") set_configvar("VAR2", 2) add_configfiles("config.h.in", {variables = {hello = "xmake"}}) add_configfiles("*.man", {onlycopy = true}) ``` 通过[set\_configvar](#set_configvar)接口设置模板变量，裹着通过`{variables = {xxx = ""}}`中设置的变量进行替换处理。 预处理后的文件`config.h`内容为： ``` define VAR1 "1" define VAR2 "2" define HELLO "xmake" ``` 而`{onlycopy = true}`设置，会强制将`*.man`作为普通文件处理，仅在预处理阶段copy文件，不进行变量替换。 默认的模板变量匹配模式为`${var}`，当然我们也可以设置其他的匹配模式，例如，改为`@var@`匹配规则： ```lua target("test") add_configfiles("config.h.in", {pattern = "@(.-)@"}) ``` #### 内置变量 我们也有提供了一些内置的变量，即使不通过此接口设置，也是可以进行默认变量替换的： ``` ${VERSION} -> 1.6.3 ${VERSION_MAJOR} -> 1 ${VERSION_MINOR} -> 6 ${VERSION_ALTER} -> 3 ${VERSION_BUILD} -> set_version("1.6.3", {build = "%Y%m%d%H%M"}) -> 201902031421 ${PLAT} and ${plat} -> MACOS and macosx ${ARCH} and ${arch} -> ARM and arm ${MODE} and ${mode} -> DEBUG/RELEASE and debug/release ${DEBUG} and ${debug} -> 1 or 0 ${OS} and ${os} -> IOS or ios ``` 例如： config.h.in ```c define CONFIG_VERSION "${VERSION}" define CONFIG_VERSION_MAJOR ${VERSION_MAJOR} define CONFIG_VERSION_MINOR ${VERSION_MINOR} define CONFIG_VERSION_ALTER ${VERSION_ALTER} define CONFIG_VERSION_BUILD ${VERSION_BUILD} ``` config.h ```c define CONFIG_VERSION "1.6.3" define CONFIG_VERSION_MAJOR 1 define CONFIG_VERSION_MINOR 6 define CONFIG_VERSION_ALTER 3 define CONFIG_VERSION_BUILD 201902031401 ``` v2.5.3 后新增 git 相关内置变量： ```c define GIT_COMMIT "${GIT_COMMIT}" define GIT_COMMIT_LONG "${GIT_COMMIT_LONG}" define GIT_COMMIT_DATE "${GIT_COMMIT_DATE}" define GIT_BRANCH "${GIT_BRANCH}" define GIT_TAG "${GIT_TAG}" define GIT_TAG_LONG "${GIT_TAG_LONG}" define GIT_CUSTOM "${GIT_TAG}-${GIT_COMMIT}" ``` ```c define GIT_COMMIT "8c42b2c2" define GIT_COMMIT_LONG "8c42b2c251793861eb85ffdf7e7c2307b129c7ae" define GIT_COMMIT_DATE "20210121225744" define GIT_BRANCH "dev" define GIT_TAG "v1.6.6" define GIT_TAG_LONG "v1.6.6-0-g8c42b2c2" define GIT_CUSTOM "v1.6.6-8c42b2c2" ``` #### 宏定义 我们还可以对`#define`定义进行一些变量状态控制处理： config.h.in ```c ${define FOO_ENABLE} ``` ```lua set_configvar("FOO_ENABLE", 1) -- or pass true set_configvar("FOO_STRING", "foo") ``` 通过上面的变量设置后，`${define xxx}`就会替换成： ```c define FOO_ENABLE 1 define FOO_STRING "foo" ``` 或者（设置为0禁用的时候） ```c /* #undef FOO_ENABLE */ /* #undef FOO_STRING */ ``` 这种方式，对于一些自动检测生成config.h非常有用，比如配合option来做自动检测： ```lua option("foo") set_default(true) set_description("Enable Foo") set_configvar("FOO_ENABLE", 1) -- 或者传递true，启用FOO_ENABLE变量 set_configvar("FOO_STRING", "foo") target("test") add_configfiles("config.h.in") -- 如果启用foo选项 -> 添加 FOO_ENABLE 和 FOO_STRING 定义 add_options("foo") ``` config.h.in ```c ${define FOO_ENABLE} ${define FOO_STRING} ``` config.h ```c define FOO_ENABLE 1 define FOO_STRING "foo" ``` 关于option选项检测，以及config.h的自动生成，有一些辅助函数，可以看下：https://github.com/xmake-io/xmake/issues/342 除了`#define`，如果想要对其他非`#define xxx`也做状态切换处理，可以使用 `${default xxx 0}` 模式，设置默认值，例如： ``` HAVE_SSE2 equ ${default VAR_HAVE_SSE2 0} ``` 通过`set_configvar("HAVE_SSE2", 1)`启用变量后，变为`HAVE_SSE2 equ 1`，如果没有设置变量，则使用默认值：`HAVE_SSE2 equ 0` 关于这个的详细说明，见：https://github.com/xmake-io/xmake/issues/320 #### 定义导出宏 v2.9.8 新增的特性，可以生成动态库的导出宏定义，通常用于 windows 下 dll 库的符号导出和导入。 在 config.h.in 中定义： ```c ${define_export MYLIB} ``` 就会生成 ```c ifdef MYLIB_STATIC define MYLIB_EXPORT else if defined(_WIN32) define MYLIB_EXPORT __declspec(dllexport) elif defined(__GNUC__) && ((__GNUC__ >= 4) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)) define MYLIB_EXPORT __attribute__((visibility("default"))) else define MYLIB_EXPORT endif endif ``` 我们在定义动态库导出符号时，可以通过这个宏来控制导入导出。 ```c MYLIB_EXPORT void foo(); ``` 它跟 CMake 的 [GenerateExportHeader](https://cmake.org/cmake/help/latest/module/GenerateExportHeader.html) 的功能类似。 不过，它不会额外生成一个独立的导出头文件，而是直接在 config.h 中去生成它。 更多详情见：[#6088](https://github.com/xmake-io/xmake/issues/6088) #### 自定义预处理器 如果 xmake 内置的生成规则不满足需求，也可以自定义处理器去重写生成规则，例如重写 `${define_export XXX}`： ```lua target("test") set_kind("binary") add_files("main.c") add_configfiles("config.h.in", { preprocessor = function (preprocessor_name, name, value, opt) if preprocessor_name == "define_export" then value = ([[#ifdef %s_STATIC define %s_EXPORT else if defined(_WIN32) define %s_EXPORT __declspec(dllexport) elif defined(__GNUC__) && ((__GNUC__ >= 4) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)) define %s_EXPORT __attribute__((visibility("default"))) else define %s_EXPORT endif endif ]]):format(name, name, name, name, name) return value end end}) ``` 我们也可以重写对 `${define XXX}` 和 `${default XXX}` 的生成，甚至自定义扩展其他预处理配置。 例如： ```lua target("test") set_kind("binary") add_files("main.c") set_configvar("FOO", "foo") add_configfiles("config.h.in", { preprocessor = function (preprocessor_name, name, value, opt) local argv = opt.argv if preprocessor_name == "define_custom" then return string.format("#define CUSTOM_%s %s", name, value) end end}) ``` 然后我们在 config.h.in 中配置： ```c ${define_custom FOO arg1 arg2} ``` 其中，`define_custom` 是自定义的预处理器名，FOO 是变量名，可以从 `set_configvar` 中获取变量值。 而 arg1, arg2 是可选的预处理参数列表，根据实际的需求来判断是否需要使用，如果想要使用参数，可以通过 `opt.argv` 来获取，它是一个参数列表 table。 在运行 `xmake config` 后，就会在 config.h 中自动生成如下配置： ```c define CUSTOM_FOO foo ``` ## set\_policy ### 设置构建行为策略 #### 函数原型 ::: tip API ```lua set_policy(policy: , value: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | policy | 策略名称字符串，如 "check.auto\_ignore\_flags", "build.warning" | | value | 策略值，true表示启用，false表示禁用 | #### 用法说明 xmake有很多的默认行为，比如：自动检测和映射flags、跨target并行构建等，虽然提供了一定的智能化处理，但重口难调，不一定满足所有的用户的使用习惯和需求。 因此，从v2.3.4开始，xmake提供默认构建策略的修改设置，开放给用户一定程度上的可配置性。 使用方式如下： ```lua set_policy("check.auto_ignore_flags", false) ``` 只需要在项目根域设置这个配置，就可以禁用flags的自动检测和忽略机制，另外`set_policy`也可以针对某个特定的target局部生效。 ```lua target("test") set_policy("check.auto_ignore_flags", false) ``` ## set\_runtimes ### 设置编译目标依赖的运行时库 #### 函数原型 ::: tip API ```lua set_runtimes(runtimes: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | runtimes | 运行时库字符串或数组，如 "MT", "MD", "MTd", "MDd" | | ... | 可变参数，可传入多个运行时库字符串 | 这是 v2.5.1 开始新增的接口，用于抽象化设置编译目标依赖的运行时库，目前仅仅支持对 msvc 运行时库的抽象，但后续也许会扩展对其他编译器运行时库的映射。 目前支持的一些配置值说明如下： | 值 | 描述 | | ------ | ----------------------------------------- | | MT | msvc 运行时库：多线程静态库 | | MTd | msvc 运行时库：多线程静态库（调试） | | MD | msvc 运行时库：多线程动态库 | | MDd | msvc 运行时库：多线程动态库（调试） | | c++\_static | clang 的 c++ 运行时库，静态库 | | c++\_shared | clang 的 c++ 运行时库，动态库 | | stdc++\_static | gcc 的 c++ 运行时库，静态库 | | stdc++\_shared | gcc 的 c++ 运行时库，动态库 | | gnustl\_static | android 的 c++ 运行时库，静态库，高版本 NDK 已废弃 | | gnustl\_shared | android 的 c++ 运行时库，静态库，高版本 NDK 已废弃 | | stlport\_static | android 的 c++ 运行时库，静态库，高版本 NDK 已废弃 | | stlport\_static | android 的 c++ 运行时库，静态库，高版本 NDK 已废弃 | 关于 vs 运行时，可以参考：[msvc 运行时说明](https://docs.microsoft.com/en-us/cpp/build/reference/md-mt-ld-use-run-time-library?view=msvc-160) 而这个接口传入 MT/MTd 参数配置，xmake 会自动配置上 `/MT /nodefaultlib:msvcrt.lib` 参数。 我们可以针对不同的 target 设置不同的运行时。 另外，如果我们将 `set_runtimes` 设置在全局根域，那么所有的 `add_requires("xx")` 包定义也会全局同步切换到对应的 vs runtime 配置 ```lua set_runtimes("MD") add_requires("libcurl", "fmt") target("test") set_kind("binary") add_files("src/*.c") ``` 当然，我们也可以通过 `add_requires("xx", {configs = {vs_runtime = "MD"}})` 对特定包修改 vs 运行时库。 我们也可以通过 `xmake f --vs_runtime='MD'` 通过参数配置来全局切换它。 与此 api 相关的 issue：[#1071](https://github.com/xmake-io/xmake/issues/1071#issuecomment-750817681) ## set\_group ### 设置目标分组 #### 函数原型 ::: tip API ```lua set_group(group: ) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | group | 分组名称字符串，如 "test", "libs", "tools" | #### 用于工程文件分组展示 此接口可用于 vs/vsxmake 工程生成，对 vs 工程内部子工程目录树按指定结构分组展示，不过后续也可能对其他模块增加分组支持。 比如对于下面的分组配置： ```lua add_rules("mode.debug", "mode.release") target("test1") set_kind("binary") add_files("src/*.cpp") set_group("group1") target("test2") set_kind("binary") add_files("src/*.cpp") set_group("group1") target("test3") set_kind("binary") add_files("src/*.cpp") set_group("group1/group2") target("test4") set_kind("binary") add_files("src/*.cpp") set_group("group3/group4") target("test5") set_kind("binary") add_files("src/*.cpp") target("test6") set_kind("binary") add_files("src/*.cpp") ``` 生成的 vs 工程目录结构效果如下： ![](/assets/img/manual/set_group.png) 其中 `set_group("group1/group2")` 可以将 target 设置到二级分组中去。 更多详情见：[#1026](https://github.com/xmake-io/xmake/issues/1026) #### 编译指定一批目标程序 我们可以使用 `set_group()` 将给定的目标标记为 `test/benchmark/...` 并使用 `set_default(false)` 禁用来默认构建它。 然后，通过 `xmake -g xxx` 命令就能指定构建一批目标程序了。 比如，我们可以使用此功能来构建所有测试。 ```lua target("test1") set_kind("binary") set_default(false) set_group("test") add_files("src/*.cpp") target("test2") set_kind("binary") set_default(false) set_group("test") add_files("src/*.cpp") ``` ```sh $ xmake -g test $ xmake --group=test ``` #### 运行指定一批目标程序 我们也可以通过设置分组，来指定运行所有带有 `test` 分组的测试程序。 ```sh $ xmake run -g test $ xmake run --group=test ``` 另外，我们还可以支持分组的模式匹配： ``` $ xmake build -g test_* $ xmake run -g test/foo_* $ xmake build -g bench* $ xmake run -g bench* ``` 更多信息见：[#1913](https://github.com/xmake-io/xmake/issues/1913) ## add\_filegroups ### 添加源文件分组 #### 函数原型 ::: tip API ```lua add_filegroups(name: , files: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | name | 分组名称字符串，如 "source", "header", "test" | | files | 源文件路径字符串或数组，支持通配符匹配模式 | | ... | 可变参数，可传入多个源文件路径字符串 | 这个接口目前主要用于对 vs/vsxmake/cmakelists generator 生成的工程文件进行源文件分组展示。 如果不设置分组展示，Xmake 也会默认按照树状模式展示，但是有些极端情况下，目录层级显示不是很好，例如： ```lua target("test") set_kind("binary") add_files("../../../../src/**.cpp") ``` ![](/assets/img/manual/filegroup1.png) 目前主要支持两种展示模式： * plain: 平坦模式 * tree: 树形展示，这也是默认模式 另外，它也支持对 `add_headerfiles` 添加的文件进行分组。 #### 设置分组并指定根目录 ```lua target("test") set_kind("binary") add_files("../../../../src/**.cpp") add_filegroups("group1/group2", {rootdir = "../../../../"}) ``` ![](/assets/img/manual/filegroup2.png) #### 设置分组并指定文件匹配模式 ```lua target("test") set_kind("binary") add_files("../../../../src/**.cpp") add_filegroups("group1/group2", {rootdir = "../../../../", files = {"src/**.cpp"}}) ``` #### 作为平坦模式展示 这种模式下，所有源文件忽略嵌套的目录层级，在分组下同一层级展示。 ```lua target("test") set_kind("binary") add_files("../../../../src/**.cpp") add_filegroups("group1/group2", {rootdir = "../../../../", mode = "plain"}) ``` ![](/assets/img/manual/filegroup3.png) ## set\_exceptions ### 启用或者禁用异常 #### 函数原型 ::: tip API ```lua set_exceptions(exceptions: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | exceptions | 异常模式字符串或数组，如 "cxx", "objc", "no-cxx" | | ... | 可变参数，可传入多个异常模式字符串 | 我们可以通过这个配置，配置启用和禁用 C++/Objc 的异常。 通常，如果我们通过 add\_cxxflags 接口去配置它们，需要根据不同的平台，编译器分别处理它们，非常繁琐。 例如： ```lua on_config(function (target) if (has_tool("cxx", "cl")) then add("cxflags", "/EHsc", {force = true}) add("defines", "_HAS_EXCEPTIONS=1", {force = true}) elseif(has_tool("cxx", "clang") or has_tool("cxx", "clang-cl")) then add("cxflags", "-fexceptions", {force = true}) add("cxflags", "-fcxx-exceptions", {force = true}) end end) ``` 而通过这个接口，我们就可以抽象化成编译器无关的方式去配置它们。 开启 C++ 异常: ```lua set_exceptions("cxx") ``` 禁用 C++ 异常: ```lua set_exceptions("no-cxx") ``` 我们也可以同时配置开启 objc 异常。 ```lua set_exceptions("cxx", "objc") ``` 或者禁用它们。 ```lua set_exceptions("no-cxx", "no-objc") ``` Xmake 会在内部自动根据不同的编译器，去适配对应的 flags。 ## set\_encodings ### 设置编码 #### 函数原型 ::: tip API ```lua set_encodings(encodings: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | encodings | 编码字符串或数组，如 "utf-8", "gb2312" | | ... | 可变参数，可传入多个编码字符串 | 这是 2.8.2 版本新增的接口，我们可以用这个接口设置源文件、目标执行文件的编码。 目前支持的编码：utf-8, gb2312 (msvc) 默认情况下，我们仅仅指定编码，是会同时对源文件，目标文件生效。 ```lua -- for all source/target encodings set_encodings("utf-8") -- msvc: /utf-8 ``` 它等价于： ```lua set_encodings("source:utf-8", "utf-8") ``` 并且，目前仅仅支持设置成 utf-8 编码，将来会不断扩展。 如果，我们仅仅想单独设置源文件编码，或者目标文件编码，也是可以的。 #### 设置源文件编码 通常指的是编译的代码源文件的编码，我们可以这么设置。 ```lua -- gcc/clang: -finput-charset=UTF-8, msvc: -source-charset=utf-8 set_encodings("source:utf-8") ``` #### 设置目标文件编码 它通常指的是目标可执行文件的运行输出编码。 ```lua -- gcc/clang: -fexec-charset=UTF-8, msvc: -target-charset=utf-8 set_encodings("utf-8") ``` ## add\_forceincludes ### 强制添加 includes #### 函数原型 ::: tip API ```lua add_forceincludes(includes: , ..., { public|interface|private = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | includes | 头文件路径字符串或数组，如 "config.h" | | ... | 可变参数，可传入多个头文件路径字符串 | | public|interface|private | 可见性设置，详见[可见性设置](#visibility) | 这是 2.8.2 新增的接口，用于在配置文件中直接强制添加 `includes` 头文件。 ```lua add_forceincludes("config.h") ``` 它的效果类似于 `#include `，但是不需要在源码中显式添加它了。 另外，它的搜索路径也是需要通过 `add_includedirs` 来控制，而不是直接配置文件路径。 ```lua add_forceincludes("config.h") add_includedirs("src") ``` 默认 add\_forceincludes 匹配 c/c++/objc。如果仅仅只想匹配 c++ 可以这么配置： ```lua add_forceincludes("config.h", {sourcekinds = "cxx"}) ``` 如果想同时匹配多个源文件类型，也是可以的： ```lua add_forceincludes("config.h", {sourcekinds = {"cxx", "mxx"}}) ``` ## add\_extrafiles ### 添加额外的文件 #### 函数原型 ::: tip API ```lua add_extrafiles(extrafiles: , ...) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | extrafiles | 额外文件路径字符串或数组，如 "assets/other.txt" | | ... | 可变参数，可传入多个额外文件路径字符串 | #### 用法说明 这个接口也是 2.8.2 新加的，主要用于 vs/vsxmake project generator 生成的工程中，添加额外的文件到工程列表中去，这样，用户也可以快速点击编辑它们，尽管它们不是代码文件。 将来，我们也可能用此接口做更多其他的事情。 ```lua add_extrafiles("assets/other.txt") ``` ## add\_tests ### 添加测试用例 #### 函数原型 ::: tip API ```lua add_tests(tests: , ..., { runargs = , runenvs = , timeout = , ... = }) ``` ::: #### 参数说明 | 参数 | 描述 | |------|------| | tests | 测试用例名称字符串或数组，如 "test1", "test2" | | ... | 可变参数，可传入多个测试用例名称字符串 | | runargs | 测试运行参数字符串或数组，可选 | | runenvs | 测试运行环境变量表，可选 | | timeout | 测试超时时间（秒），可选 | | ... | 其他测试配置参数，可选 | #### 用法说明 2.8.5 版本开始，我们增加了内置的测试命令：`xmake test`，我们只需要在需要测试的 target 上通过 add\_tests 配置一些测试用例，就可以自动执行测试。 即使当前 target 被设置成了 `set_default(false)`，在执行测试的时候，xmake 也还是会先自动编译它们，然后自动运行所有的测试。 我们可以先看个整体的例子，大概知道下它是怎么样子的。 ```lua add_rules("mode.debug", "mode.release") for _, file in ipairs(os.files("src/test_*.cpp")) do local name = path.basename(file) target(name) set_kind("binary") set_default(false) add_files("src/" .. name .. ".cpp") add_tests("default") add_tests("args", {runargs = {"foo", "bar"}}) add_tests("pass_output", {trim_output = true, runargs = "foo", pass_outputs = "hello foo"}) add_tests("fail_output", {fail_outputs = {"hello2 .*", "hello xmake"}}) end ``` 这个例子，自动扫描源码目录下的 `test_*.cpp` 源文件，然后每个文件自动创建一个测试目标，它被设置成了 `set_default(false)`，也就是正常情况下，默认不会编译它们。 但是，如果执行 `xmake test` 进行测试，它们就会被自动编译，然后测试运行，运行效果如下： ```sh ruki-2:test ruki$ xmake test running tests ... [ 2%]: test_1/args .................................... passed 7.000s [ 5%]: test_1/default .................................... passed 5.000s [ 8%]: test_1/fail_output .................................... passed 5.000s [ 11%]: test_1/pass_output .................................... passed 6.000s [ 13%]: test_2/args .................................... passed 7.000s [ 16%]: test_2/default .................................... passed 6.000s [ 19%]: test_2/fail_output .................................... passed 6.000s [ 22%]: test_2/pass_output .................................... passed 6.000s [ 25%]: test_3/args .................................... passed 7.000s [ 27%]: test_3/default .................................... passed 7.000s [ 30%]: test_3/fail_output .................................... passed 6.000s [ 33%]: test_3/pass_output .................................... passed 6.000s [ 36%]: test_4/args .................................... passed 6.000s [ 38%]: test_4/default .................................... passed 6.000s [ 41%]: test_4/fail_output .................................... passed 5.000s [ 44%]: test_4/pass_output .................................... passed 6.000s [ 47%]: test_5/args .................................... passed 5.000s [ 50%]: test_5/default .................................... passed 6.000s [ 52%]: test_5/fail_output .................................... failed 6.000s [ 55%]: test_5/pass_output .................................... failed 5.000s [ 58%]: test_6/args .................................... passed 7.000s [ 61%]: test_6/default .................................... passed 6.000s [ 63%]: test_6/fail_output .................................... passed 6.000s [ 66%]: test_6/pass_output .................................... passed 6.000s [ 69%]: test_7/args .................................... failed 6.000s [ 72%]: test_7/default .................................... failed 7.000s [ 75%]: test_7/fail_output .................................... failed 6.000s [ 77%]: test_7/pass_output .................................... failed 5.000s [ 80%]: test_8/args .................................... passed 7.000s [ 83%]: test_8/default .................................... passed 6.000s [ 86%]: test_8/fail_output .................................... passed 6.000s [ 88%]: test_8/pass_output .................................... failed 5.000s [ 91%]: test_9/args .................................... passed 6.000s [ 94%]: test_9/default .................................... passed 6.000s [ 97%]: test_9/fail_output .................................... passed 6.000s [100%]: test_9/pass_output .................................... passed 6.000s 80% tests passed, 7 tests failed out of 36, spent 0.242s ``` ![](/assets/img/manual/xmake-test1.png) 我们也可以执行 `xmake test -vD` 查看详细的测试失败的错误信息： ![](/assets/img/manual/xmake-test2.png) #### 运行指定测试目标 我们也可以指定运行指定 target 的某个测试： ```sh $ xmake test targetname/testname ``` 或者按模式匹配的方式，运行一个 target 的所有测试，或者一批测试： ```sh $ xmake test targetname/* $ xmake test targetname/foo* ``` 也可以运行所有 target 的同名测试： ```sh $ xmake test */testname ``` #### 并行化运行测试 其实，默认就是并行化运行的，但是我们可以通过 `-jN` 调整运行的并行度。 ```sh $ xmake test -jN ``` #### 分组运行测试 ```sh $ xmake test -g "foo" $ xmake test -g "foo*" ``` #### 添加测试到目标（无参数） 如果没有配置任何参数，仅仅配置了测试名到 `add_tests`，那么仅仅测试这个目标程序的是否会运行失败，根据退出代码来判断是否通过测试。 ``` target("test") add_tests("testname") ``` #### 配置运行参数 我们也可以通过 `{runargs = {"arg1", "arg2"}}` 的方式，给 `add_tests` 配置指定测试需要运行的参数。 另外，一个 target 可以同时配置多个测试用例，每个测试用例可独立运行，互不冲突。 ```lua target("test") add_tests("testname", {runargs = "arg1"}) add_tests("testname", {runargs = {"arg1", "arg2"}}) ``` 如果我们没有配置 runargs 到 `add_tests`，那么我们也会尝试从被绑定的 target 中，获取 `set_runargs` 设置的运行参数。 ```lua target("test") add_tests("testname") set_runargs("arg1", "arg2") ``` #### 配置运行目录 我们也可以通过 rundir 设置测试运行的当前工作目录，例如： ```lua target("test") add_tests("testname", {rundir = os.projectdir()}) ``` 如果我们没有配置 rundir 到 `add_tests`，那么我们也会尝试从被绑定的 target 中，获取 `set_rundir` 设置的运行目录。 ```lua target("test") add_tests("testname") set_rundir("$(projectdir)") ``` #### 配置运行环境 我们也可以通过 runenvs 设置一些运行时候的环境变量，例如： ```lua target("test") add_tests("testname", {runenvs = {LD_LIBRARY_PATH = "/lib"}}) ``` 如果我们没有配置 runenvs 到 `add_tests`，那么我们也会尝试从被绑定的 target 中，获取 `add_runenvs` 设置的运行环境。 ```lua target("test") add_tests("testname") add_runenvs("LD_LIBRARY_PATH", "/lib") ``` #### 实时输出支持 从 v3.0.5 开始，可以为测试启用实时输出支持，允许测试输出在测试运行时实时显示，而不是等到测试完成后再缓冲输出。这对于长时间运行的测试或产生连续输出的测试特别有用。 要为测试启用实时输出，在测试配置中设置 `realtime_output = true`： ```lua target("test") set_kind("binary") add_tests("stub_n", {realtime_output = true, files = "tests/stub_n*.cpp", defines = "STUB_N"}) ``` 当启用 `realtime_output` 时，测试输出将在测试运行时直接流式传输到终端，使得实时监控测试进度和调试问题变得更加容易。 #### 匹配输出结果 默认情况下，`xmake test` 会根据测试运行的退出代码是否为 0，来判断是否测试通过。 当然，我们也可以通过配置测试运行的输出结果是否满足我们的指定的匹配模式，来判断是否测试通过。 主要通过这两个参数控制： | 参数 | 说明 | | --- | --- | | pass\_outputs | 如果输出匹配，则测试通过 | | fail\_outputs | 如果输出匹配，则测试失败 | 传入 `pass_outputs` 和 `fail_outputs` 的是一个 lua 匹配模式的列表，但模式稍微做了一些简化，比如对 `*` 的处理。 如果要匹配成功，则测试通过，可以这么配置： ```lua target("test") add_tests("testname1", {pass_outputs = "hello"}) add_tests("testname2", {pass_outputs = "hello *"}) add_tests("testname3", {pass_outputs = {"hello", "hello *"}}) ``` 如果要匹配成功，则测试失败，可以这么配置： ```lua target("test") add_tests("testname1", {fail_outputs = "hello"}) add_tests("testname2", {fail_outputs = "hello *"}) add_tests("testname3", {fail_outputs = {"hello", "hello *"}}) ``` 我们也可以同时配置它们： ```lua target("test") add_tests("testname", {pass_outputs = "foo", fail_outputs = "hello"}) ``` 由于一些测试输出的结果，尾部会有一些换行什么的空白字符，干扰匹配模式，我们可以再配置 `trim_output = true`，先截断空白字符后，再做匹配。 ```lua target("test") add_tests("testname", {trim_output = true, pass_outputs = "foo", fail_outputs = "hello"}) ``` 我们还可以配置 `{plain = true}` 是禁用 lua 模式匹配，仅仅做最基础的平坦文本匹配。 ```lua target("test") add_tests("testname", {plain = true, pass_outputs = "foo", fail_outputs = "hello"}) ``` 我们也可以通过 `pass_output_files` 和 `fail_output_files` 来匹配文件内容，里面的路径是相对于当前 `xmake.lua` 脚本目录的。 `pass_output_files` 指定的文件内容将作为期望的标准输出，如果实际输出跟文件内容匹配，则测试通过。 ```lua target("test") set_kind("binary") add_files("src/*.cpp") add_tests("test1", { runargs = {"arg1"}, pass_output_files = "test1.out" }) ``` #### 配置测试组 我们也可以通过 `group = "foo"` 来配置一个测试组，进行分组测试： ```lua target("test") add_tests("testname1", {group = "foo"}) add_tests("testname2", {group = "foo"}) add_tests("testname3", {group = "bar"}) add_tests("testname4", {group = "bae"}) ``` 其中 testname1/testname2 是一个组 foo，另外两个是在另外一个组。 然后，我们就可以使用 `xmake test -g groupname` 来进行分组测试了。 ```sh $ xmake test -g "foo" $ xmake test -g "foo*" ``` :::tip 注意 运行分组，也是支持模式匹配的。 ::: 另外，如果没有设置 `group` 参数给 `add_tests`，我们也可以默认获取绑定到 target 的组名。 ```lua target("test") add_tests("testname") set_group("foo") ``` #### 自定义测试脚本 我们还新增了 `before_test`, `on_test` 和 `after_test` 配置脚本，用户可以在 rule 和 target 域，自定义配置它们实现定制化的测试执行。 ```lua target("test") on_test(function (target, opt) print(opt.name, opt.runenvs, opt.runargs, opt.pass_outputs) -- do test -- ... -- passed return true -- failied return false, errors end) ``` 其中，opt 里面可以获取到所有传入 `add_tests` 的参数，我们在 on\_test 里面自定义测试逻辑，然后返回 true 就是测试通过，返回 false 就是测试失败，然后继续返回测试失败的错误信息。 #### 自动化构建 由于测试目标在正常开发构建阶段，通常是不需要被构建的，因此我们会设置 `set_default(false)`。 ```lua target("test") add_tests("testname") set_default(false) ``` 但是运行 `xmake test` 进行测试时候，这些测试对应的 target 还是会被自动构建，确保能够被运行。 ```sh $ xmake test [ 25%]: cache compiling.release src/main.cpp [ 50%]: linking.release test running tests ... [100%]: test/testname .................................... passed 6.000s 100% tests passed, 0 tests failed out of 1, spent 0.006s ``` #### 标记测试为预期失败 你可以使用 `should_fail` 选项将测试标记为预期失败。这在验证以下情况时非常有用： * 崩溃处理 * 断言或契约违规 * 正在开发或已知存在问题的功能 如果一个设置了 `should_fail = true` 的测试在执行时失败了，它将被视为成功。但如果它意外通过，则会在测试报告中高亮显示为 **unexpected pass**，并将该测试标记为失败。 测试摘要也会将预期失败和意外通过的测试进行分组展示。 ```lua target("test") set_kind("binary") add_files("tests/test_foo.cpp") add_tests("crash_div_by_zero", { runargs = { "--div-zero" }, should_fail = true }) add_tests("crash_div_by_zero_fails", { runargs = { "--div-zero" } }) add_tests("normal_behavior", { runargs = { "--safe" } }) add_tests("normal_behavior_unexpected_pass", { runargs = { "--safe" }, should_fail = true }) ``` 示例输出： ``` ... report of tests: [ 25%]: test/crash_div_by_zero ............. expected failure 0.004s [ 50%]: test/crash_div_by_zero_fails........ failed 0.004s [ 75%]: test/normal_behavior ............... passed 0.015s [100%]: test/normal_behavior_unexpected_pass unexpected pass 0.015s Detailed summary: Failed tests: - test/crash_div_by_zero_fails Unexpected passes: - test/normal_behavior_unexpected_pass Expected failures: - test/crash_div_by_zero 50% tests passed, 1 test(s) failed, 1 unexpected pass(es), 1 expected failure(s) out of 4, spent 0.038s ``` #### 首次测试失败就终止 默认情况下，`xmake test` 会等到所有测试都运行完，不管里面有多少是没通过的。 而有时候，我们想在第一个测试没通过，就直接中断测试，那么我们可以通过下面的配置启用： ```lua set_policy("test.stop_on_first_failure", true) ``` #### 测试失败返回0 默认情况下，只要有一个测试没通过，等到 `xmake test` 运行完成，它都会返回非0退出代码，这对于一些 CI 环境非常有用，可以中断 CI 的其他脚本继续运行。 然后触发信号告诉 CI，我们需要生成测试报告和告警了。 然后，如果我们想要压制这种行为，可以强制将 `xmake test` 的退出代码总是设置成 0。 ```lua set_policy("test.return_zero_on_failure", true) ``` #### 仅仅测试编译 有时候，我们仅仅想要测试代码是否通过编译，或者没有通过编译，不需要运行它们，那么可以通过配置 `build_should_pass` 和 `build_should_fail` 来实现。 ```lua target("test_10") set_kind("binary") set_default(false) add_files("src/compile.cpp") add_tests("compile_fail", {build_should_fail = true}) target("test_11") set_kind("binary") set_default(false) add_files("src/compile.cpp") add_tests("compile_pass", {build_should_pass = true}) ``` 这通常用于一些测试代码中带有 `static_assert` 的场景，例如： ```c++ template bool foo(T val) { if constexpr (std::is_same_v) { printf("int!\n"); } else if constexpr (std::is_same_v) { printf("float!\n"); } else { static_assert(false, "unsupported type"); } } int main(int, char**) { foo("BAD"); return 0; } ``` #### 配置额外的代码编译 我们还可以在配置测试用例的时候，对每个测试配置额外需要编译的代码，以及一些宏定义，实现内联测试。 xmake 会为每个测试单独编译一个独立的可执行程序去运行它，但这并不会影响到 target 在生产环境的编译结果。 ```lua target("test_13") set_kind("binary") set_default(false) add_files("src/test_1.cpp") add_tests("stub_1", {files = "tests/stub_1.cpp", defines = "STUB_1"}) target("test_14") set_kind("binary") set_default(false) add_files("src/test_2.cpp") add_tests("stub_2", {files = "tests/stub_2.cpp", defines = "STUB_2"}) target("test_15") set_kind("binary") set_default(false) add_files("src/test_1.cpp") add_tests("stub_n", {files = "tests/stub_n*.cpp", defines = "STUB_N"}) ``` 以 doctest 为例，我们可以在不修改任何 main.cpp 的情况下，外置单元测试： ```lua add_rules("mode.debug", "mode.release") add_requires("doctest") target("doctest") set_kind("binary") add_files("src/*.cpp") for _, testfile in ipairs(os.files("tests/*.cpp")) do add_tests(path.basename(testfile), { files = testfile, remove_files = "src/main.cpp", languages = "c++11", packages = "doctest", defines = "DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN"}) end ``` 定义 DOCTEST\_CONFIG\_IMPLEMENT\_WITH\_MAIN 会引入额外的 main 入口函数，因此我们需要配置 remove\_files 去移除已有的 main.cpp 文件。 运行效果如下： ```sh ruki-2:doctest ruki$ xmake test running tests ... [ 50%]: doctest/test_1 .................................... failed 0.009s [100%]: doctest/test_2 .................................... passed 0.009s 50% tests passed, 1 tests failed out of 2, spent 0.019s ruki-2:doctest ruki$ xmake test -v running tests ... [ 50%]: doctest/test_1 .................................... failed 0.026s [doctest] doctest version is "2.4.11" [doctest] run with "--help" for options =============================================================================== tests/test_1.cpp:7: TEST CASE: testing the factorial function tests/test_1.cpp:8: ERROR: CHECK( factorial(1) == 10 ) is NOT correct! values: CHECK( 1 == 10 ) =============================================================================== [doctest] test cases: 1 | 0 passed | 1 failed | 0 skipped [doctest] assertions: 4 | 3 passed | 1 failed | [doctest] Status: FAILURE! run failed, exit code: 1 [100%]: doctest/test_2 .................................... passed 0.010s 50% tests passed, 1 tests failed out of 2, spent 0.038s ``` #### 测试动态库 通常，`add_tests` 仅用于对可执行程序进行运行测试，运行动态库需要有一个额外的 main 主入口，因此我们需要额外配置一个可执行程序去加载它，例如： ```lua target("doctest_shared") set_kind("shared") add_files("src/foo.cpp") for _, testfile in ipairs(os.files("tests/*.cpp")) do add_tests(path.basename(testfile), { kind = "binary", files = testfile, languages = "c++11", packages = "doctest", defines = "DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN"}) end ``` 通过 `kind = "binary"` 可以将每个单元测试改为 binary 可执行程序，并通过 DOCTEST\_CONFIG\_IMPLEMENT\_WITH\_MAIN 引入 main 入口函数。 这样就能实现动态库目标中外置可运行的单元测试。 #### 配置运行超时 如果一些测试程序长时间运行不退出，就会卡住，我们可以通过配置超时时间，强制退出，并返回失败。 ```lua target("test_timeout") set_kind("binary") set_default(false) add_files("src/run_timeout.cpp") add_tests("run_timeout", {run_timeout = 1000}) ``` ```sh $ xmake test [100%]: test_timeout/run_timeout .................................... failed 1.006s run failed, exit code: -1, exit error: wait process timeout ```