配置选项

定义和设置选项开关，每个option对应一个选项，可用于自定义编译配置选项、开关设置。

注意

除了target以外的所有域接口，例如option，task等的接口，默认不能放置在外面的全局作用域中的（除非部分跟target共用的接口除外）。如果要设置值影响所有option，task等选项，可以通过匿名全局域来设置。

例如：

lua

-- 进入option的匿名全局域，里面的设置会同时影响test和test2选项
option()
    add_defines("DEBUG")

option("test")
    -- ...
    -- 尽量保持缩进，因为这个之后的所有设置，都是针对test选项的

option("test2")
    -- ...

注意

option域是可以重复进入来实现分离设置的，如果要显示离开当前选项的作用域设置，可以手动调用option_end接口。

option

定义选项

函数原型

API

lua

option(name: <string>)

参数说明

参数	描述
name	选项名称字符串

用法说明

定义和设置选项开关，可用于自定义编译配置选项、开关设置。

例如，定义一个是否启用test的选项：

lua

option("test")
    set_default(false)
    add_defines("TEST")

然后关联到指定的target中去：

lua

target("demo")
    add_options("test")

这样，一个选项就算定义好了，如果这个选项被启用，那么编译这个target的时候，就会自动加上-DTEST的宏定义。

lua

-- 手动启用这个选项
$ xmake f --test=y
$ xmake

option_end

结束定义选项

函数原型

API

lua

option_end()

参数说明

参数	描述
-	无参数

用法说明

这是一个可选api，显示离开选项作用域，用法和target_end类似。

add_deps

添加选项依赖

函数原型

API

lua

add_deps(deps: <string|array>, ...)

参数说明

参数	描述
deps	依赖选项名称字符串或数组
...	可变参数，可传递多个依赖名称

用法说明

通过设置依赖，可以调整选项的检测顺序，一般用于on_check等检测脚本的调用时机。

lua

option("small")
    set_default(true)
    on_check(function (option)
        -- ...
    end)

option("test")
    add_deps("small")
    set_default(true)
    after_check(function (option)
        if option:dep("small"):enabled() then
            option:enable(false)
        end
    end)

当依赖的small选项检测完成后，通过判断small选项的状态，来控制test的选项状态。

注意

由于 on_check 只有在没有设置 default 值的情况下才会被执行，因此如果设置了 default 值，那么可以在 after_check 阶段处理自定义逻辑。

before_check

选项检测之前执行此脚本

函数原型

API

lua

before_check(script: <function (option)>)

参数说明

参数	描述
script	检测前脚本函数，参数为option

用法说明

lua

option("zlib")
    before_check(function (option)
    end)

on_check

自定义选项检测脚本

函数原型

API

lua

on_check(script: <function (option)>)

参数说明

参数	描述
script	检测脚本函数，参数为option

用法说明

此脚本会覆盖内置的选项检测逻辑。

lua

option("test")
    add_deps("small")
    on_check(function (option)
        option:enable(true)
    end)

注意

仅仅在 set_default 没有被设置的情况下，才会执行 on_check 进行自定义的选项检测脚本。

after_check

选项检测之后执行此脚本

函数原型

API

lua

after_check(script: <function (option)>)

参数说明

参数	描述
script	检测后脚本函数，参数为option

用法说明

在选项检测完成后，执行此脚本做一些后期处理，也可以在此时重新禁用选项：

lua

option("test")
    add_deps("small")
    add_links("pthread")
    after_check(function (option)
        option:enable(false)
    end)

set_values

设置选项值列表

函数原型

API

lua

set_values(values: <string|array>, ...)

参数说明

参数	描述
values	选项值字符串或数组
...	可变参数，可传递多个值

用法说明

仅用于xmake f --menu的图形菜单配置时，提供选项值列表供用户快速选择使用，例如：

lua

option("test")
    set_default("b")
    set_values("a", "b", "c")

效果图如下：

set_default

设置选项默认值

函数原型

API

lua

set_default(value: <string|boolean|number>)

参数说明

参数	描述
value	默认值（字符串、布尔值或数字）

用法说明

在没有通过xmake f --option=[y|n}等命令修改选项值的时候，这个选项本身也是有个默认值的，可以通过这个接口来设置：

lua

option("test")
    -- 默认禁用这个选项
    set_default(false)

选项的值不仅支持boolean类型，也可以是字符串类型，例如：

lua

option("test")
    set_default("value")

值类型	描述	配置
boolean	一般用作参数开关，值范围：`true/false`	`xmake f --optionname=[y/n/yes/no/true/false]`
string	可以是任意字符串，一般用于模式判断	`xmake f --optionname=value`

如果是boolean值的选项，可以通过has_config来进行判断，选项是否被启用。

可以通过get_config和has_config接口来获取定义的选项状态，也就是用户通过xmake f --option1=xxx设置的状态值。

如果是string类型的选项，可以在内建变量中直接使用，例如：

lua

-- 定义一个路径配置选项，默认使用临时目录
option("rootdir")
    set_default("$(tmpdir)")

target("test")
    -- 添加指定选项目录中的源文件
    add_files("$(rootdir)/*.c")

其中，$(rootdir) 就是自定义的选项内建变量，通过手动配置，可以动态修改它的值：

$ xmake f --rootdir=~/projectdir/src
$ xmake

给这个rootdir选项指定一个其他的源码目录路径，然后编译。

选项的检测行为：

default值	检测行为
没有设置	优先手动配置修改，默认禁用，否则会启用自动检测，也会执行 on_check，可根据手动传入的值类型，自动切换boolean和string类型
false	开关选项，不自动检测，默认禁用，可手动配置修改
true	开关选项，不自动检测，默认启用，可手动配置修改
string类型	无开关状态，不自动检测，可手动配置修改，一般用于配置变量传递

set_showmenu

设置是否启用菜单显示

函数原型

API

lua

set_showmenu(showmenu: <boolean>)

参数说明

参数	描述
showmenu	是否显示菜单（布尔值）

用法说明

如果设置为true，那么在xmake f --help里面就会出现这个选项，也就能通过xmake f --optionname=xxx进行配置，否则只能在xmake.lua内部使用，无法手动配置修改。

lua

option("test")
    set_showmenu(true)

设置为启用菜单后，执行xmake f --help可以看到，帮助菜单里面多了一项：

Options:
    ...

    --test=TEST

注意

2.6.8 之后，此选项默认改为启用，通常都不需要额外配置它。

set_category

设置选项分类，仅用于菜单显示

函数原型

API

lua

set_category(category: <string>)

参数说明

参数	描述
category	分类名称字符串

用法说明

这个是个可选配置，仅用于在帮助菜单中，进行分类显示选项，同一类别的选项，会在同一个分组里面显示，这样菜单看起来更加的美观。

例如：

lua

option("test1")
    set_category("test")

option("test2")
    set_category("test")

option("demo1")
    set_category("demo")

option("demo2")
    set_category("demo")

这里四个选项分别归类于两个分组：test和demo，那么显示的布局类似这样：

Options:
    ...

    --test1=TEST1
    --test2=TEST2

    --demo1=DEMO1
    --demo2=DEMO2

这个接口，仅仅是为了调整显示布局，更加美观而已，没其他用途。

在2.1.9版本中，可以通过category设置分级路径名set_category("root/submenu/submenu2")，来配置xmake f --menu的图形菜单界面，例如：

lua

-- 'boolean' option
option("test1")
    set_default(true)
    set_category("root menu/test1")

-- 'choice' option with values: "a", "b", "c"
option("test2")
    set_default("a")
    set_values("a", "b", "c")
    set_category("root menu/test2")

-- 'string' option
option("test3")
    set_default("xx")
    set_category("root menu/test3/test3")

-- 'number' option
option("test4")
    set_default(6)
    set_category("root menu/test4")

上述配置最后显示的菜单界面路径结构：

root menu
- test1
- test2
- test3
  - test3
- test4

效果图如下：

set_description

设置菜单显示描述

函数原型

API

lua

set_description(description: <string|array>, ...)

参数说明

参数	描述
description	描述信息字符串或数组
...	可变参数，可传递多行描述

用法说明

设置选项菜单显示时，右边的描述信息，用于帮助用户更加清楚的知道这个选项的用途，例如：

lua

option("test")
    set_default(false)
    set_description("Enable or disable test")

生成的菜单内容如下：

Options:
    ...

    --test=TEST                       Enable or disable test (default: false)

这个接口也支持多行显示，输出更加详细的描述信息，例如：

lua

option("mode")
    set_default("debug")
    set_description("Set build mode",
                    "    - debug",
                    "    - release",
                    "    - profile")

生成的菜单内容如下：

Options:
    ...

    --mode=MODE                       Set build mode (default: debug)
                                          - debug
                                          - release
                                          - profile

看到这个菜单，用户就能清楚地知道，定义的这个mode选项的具体用处，以及如何使用了：

$ xmake f --mode=release

add_links

添加链接库检测

函数原型

API

lua

add_links(links: <string|array>, ...)

参数说明

参数	描述
links	链接库名称字符串或数组
...	可变参数，可传递多个库名称

用法说明

如果指定的链接库检测通过，此选项将被启用，并且对应关联的target会自动加上此链接，例如：

lua

option("pthread")
    add_links("pthread")
    add_linkdirs("/usr/local/lib")

target("test")
    add_options("pthread")

如果检测通过，test目标编译的时候就会自动加上：-L/usr/local/lib -lpthread 编译选项

add_linkdirs

添加链接库检测时候需要的搜索目录

函数原型

API

lua

add_linkdirs(linkdirs: <string|array>, ...)

参数说明

参数	描述
linkdirs	链接目录路径字符串或数组
...	可变参数，可传递多个目录路径

用法说明

这个是可选的，一般系统库不需要加这个，也能检测通过，如果确实没找到，可以自己追加搜索目录，提高检测通过率。具体使用见：add_links

add_rpathdirs

添加程序运行时动态库的加载搜索目录

函数原型

API

lua

add_rpathdirs(rpathdirs: <string|array>, ...)

参数说明

参数	描述
rpathdirs	rpath目录路径字符串或数组
...	可变参数，可传递多个目录路径

用法说明

在选项通过检测后，会自动添加到对应的target上去，具体使用见：target:add_rpathdirs。

add_cincludes

添加c头文件检测

函数原型

API

lua

add_cincludes(includes: <string|array>, ...)

参数说明

参数	描述
includes	头文件名称字符串或数组
...	可变参数，可传递多个头文件名称

用法说明

如果c头文件检测通过，此选项将被启用，例如：

lua

option("pthread")
    add_cincludes("pthread.h")
    add_defines("ENABLE_PTHREAD")

target("test")
    add_options("pthread")

此选项检测是否存在pthread.h的头文件，如果检测通过那么test目标程序将会加上ENABLE_PTHREAD的宏定义。

如果想要更加灵活的检测，可以通过lib.detect.has_cincludes在option.on_check中去实现。

add_cxxincludes

添加c++头文件检测

函数原型

API

lua

add_cxxincludes(includes: <string|array>, ...)

参数说明

参数	描述
includes	头文件名称字符串或数组
...	可变参数，可传递多个头文件名称

用法说明

与add_cincludes类似，只是检测的头文件类型是c++头文件。

add_ctypes

添加c类型检测

函数原型

API

lua

add_ctypes(types: <string|array>, ...)

参数说明

参数	描述
types	类型名称字符串或数组
...	可变参数，可传递多个类型名称

用法说明

如果c类型检测通过，此选项将被启用，例如：

lua

option("wchar")
    add_ctypes("wchar_t")
    add_defines("HAVE_WCHAR")

target("test")
    add_options("wchar")

此选项检测是否存在wchar_t的类型，如果检测通过那么test目标程序将会加上HAVE_WCHAR的宏定义。

如果想要更加灵活的检测，可以通过lib.detect.has_ctypes在option.on_check中去实现。

add_cxxtypes

添加c++类型检测

函数原型

API

lua

add_cxxtypes(types: <string|array>, ...)

参数说明

参数	描述
types	类型名称字符串或数组
...	可变参数，可传递多个类型名称

用法说明

与add_ctypes类似，只是检测的类型是c++类型。

add_csnippets

添加c代码片段检测

函数原型

API

lua

add_csnippets(name: <string>, code: <string>, {
    tryrun = <boolean>,
    output = <boolean>,
    number = <boolean>
})

参数说明

参数	描述
name	代码片段名称字符串
code	代码片段字符串
tryrun	是否尝试运行检测
output	是否捕获输出
number	是否输出数字

用法说明

如果现有的add_ctypes, add_cfuncs等不能满足当前的检测需求，可以用这个接口实现更加定制化检测一些编译器特性检测，具体见: add_cxxsnippets。

add_cxxsnippets

添加c++代码片段检测

函数原型

API

lua

add_cxxsnippets(name: <string>, code: <string>, {
    tryrun = <boolean>,
    output = <boolean>,
    number = <boolean>
})

参数说明

参数	描述
name	代码片段名称字符串
code	代码片段字符串
tryrun	是否尝试运行检测
output	是否捕获输出
number	是否输出数字

用法说明

可以用这个接口实现更加定制化检测一些编译器特性检测，尤其是c++的各种特性的检测支持，例如：

lua

option("constexpr")
    add_cxxsnippets("constexpr", "constexpr int f(int x) { int sum=0; for (int i=0; i<=x; ++i) sum += i; return sum; } constexpr int x = f(5);  static_assert(x == 15);")

第一个参数设置代码片段的名字作为标示，检测输出信息时候会有显示。

上述代码，实现对c++的constexpr特性的检测，如果检测通过，则启用constexpr选项，当然这里只是个例子。

对于编译器特性的检测，有更加方便高效的检测模块，提供更强大的检测支持，具体见：compiler.has_features和detect.check_cxsnippets

如果想要更加灵活的检测，可以通过lib.detect.check_cxsnippets在option.on_check中去实现。

v2.5.7 版本后，新增 {tryrun = true} 和 {output = true} 两个选项用于尝试运行检测和捕获输出。

设置 tryrun 可以尝试运行来检测：

lua

option("test")
    add_cxxsnippets("HAS_INT_4", "return (sizeof(int) == 4)? 0 : -1;", {tryrun = true})

设置 output 也会尝试去检测，并且额外捕获运行的输出内容。

lua

option("test")
    add_cxxsnippets("INT_SIZE", 'printf("%d", sizeof(int)); return 0;', {output = true, number = true})

注意

设置为捕获输出，当前 option 不能再设置其他 snippets

我们也可以通过 is_config 获取绑定到option的输出。

lua

if is_config("test", "8") then
    -- xxx
end

add_cfuncs

添加c库函数检测

函数原型

API

lua

add_cfuncs(funcs: <string|array>, ...)

参数说明

参数	描述
funcs	函数名称字符串或数组
...	可变参数，可传递多个函数名称

用法说明

lua

option("setjmp")
    add_cincludes("setjmp.h")
    add_cfuncs("sigsetjmp", "setjmp")
    add_defines("HAVE_SETJMP")

target("test")
    add_options("setjmp")

此选项检测是否存在setjmp的一些接口，如果检测通过那么test 目标程序将会加上 HAVE_SETJMP 的宏定义。

里面的函数片段支持下面几种语法格式：

lua

-- 单纯检测函数地址是否存在，内部会尝试去它的地址来判断
sigsetjmp

-- 如果有些函数是宏定义 wrap 的，可以通过这种方式绕通过检测
sigsetjmp((void*)0, 0)

-- 也可以指定一个完整函数语句，例如：funcname{codebody}
sigsetjmp{sigsetjmp((void*)0, 0);}
sigsetjmp{int a = 0; sigsetjmp((void*)a, a);}

NOTE

注意，检测的函数通常需要附带 add_cincludes 确保函数能够被正常 include 进来，否则检测会失败。

add_cxxfuncs

添加c++库函数检测

函数原型

API

lua

add_cxxfuncs(funcs: <string|array>, ...)

参数说明

参数	描述
funcs	函数名称字符串或数组
...	可变参数，可传递多个函数名称

用法说明

用法跟 add_cfuncs 一致。

配置选项 ​

option ​

定义选项 ​

函数原型 ​

参数说明 ​

用法说明 ​

option_end ​

结束定义选项 ​

函数原型 ​

参数说明 ​

用法说明 ​

add_deps ​

添加选项依赖 ​

函数原型 ​

参数说明 ​

用法说明 ​

before_check ​

选项检测之前执行此脚本 ​

函数原型 ​

参数说明 ​

用法说明 ​

on_check ​

自定义选项检测脚本 ​

函数原型 ​

参数说明 ​

用法说明 ​

after_check ​

选项检测之后执行此脚本 ​

函数原型 ​

参数说明 ​

用法说明 ​

set_values ​

设置选项值列表 ​

函数原型 ​

参数说明 ​

用法说明 ​

set_default ​

设置选项默认值 ​

函数原型 ​

参数说明 ​

用法说明 ​

set_showmenu ​

设置是否启用菜单显示 ​

函数原型 ​

参数说明 ​

用法说明 ​

set_category ​

设置选项分类，仅用于菜单显示 ​

函数原型 ​

参数说明 ​

用法说明 ​

set_description ​

设置菜单显示描述 ​

函数原型 ​

参数说明 ​

用法说明 ​

add_links ​

添加链接库检测 ​

函数原型 ​

参数说明 ​

用法说明 ​

add_linkdirs ​

添加链接库检测时候需要的搜索目录 ​

函数原型 ​

参数说明 ​

用法说明 ​

add_rpathdirs ​

添加程序运行时动态库的加载搜索目录 ​

函数原型 ​

参数说明 ​

用法说明 ​

add_cincludes ​

添加c头文件检测 ​

函数原型 ​

参数说明 ​

用法说明 ​

add_cxxincludes ​

添加c++头文件检测 ​

函数原型 ​

参数说明 ​

配置选项

option

定义选项

函数原型

参数说明

用法说明

option_end

结束定义选项

函数原型

参数说明

用法说明

add_deps

添加选项依赖

函数原型

参数说明

用法说明

before_check

选项检测之前执行此脚本

函数原型

参数说明

用法说明

on_check

自定义选项检测脚本

函数原型

参数说明

用法说明

after_check

选项检测之后执行此脚本

函数原型

参数说明

用法说明

set_values

设置选项值列表

函数原型

参数说明

用法说明

set_default

设置选项默认值

函数原型

参数说明

用法说明

set_showmenu

设置是否启用菜单显示

函数原型

参数说明

用法说明

set_category

设置选项分类，仅用于菜单显示

函数原型

参数说明

用法说明

set_description

设置菜单显示描述

函数原型

参数说明

用法说明

add_links

添加链接库检测

函数原型

参数说明

用法说明

add_linkdirs

添加链接库检测时候需要的搜索目录

函数原型

参数说明

用法说明

add_rpathdirs

添加程序运行时动态库的加载搜索目录

函数原型

参数说明

用法说明

add_cincludes

添加c头文件检测

函数原型

参数说明

用法说明

add_cxxincludes

添加c++头文件检测

函数原型

参数说明