xmake-docs/docs/api/description/conditions.md

Conditions

Conditions are generally used to handle some special compilation platforms.

is_os

Is the current compilation target system

Function Prototype

::: tip API

is_os(os: <string>, ...)

:::

Parameter Description

Parameter	Description
os	Operating system name string
...	Variable parameters, can pass multiple OS names

Usage

if is_os("ios") then
    add_files("src/xxx/*.m")
end

Support operation systems:

• windows
• linux
• android
• macosx
• ios

is_arch

Is the current compilation architecture

Function Prototype

::: tip API

is_arch(arch: <string>, ...)

:::

Parameter Description

Parameter	Description
arch	Architecture name string
...	Variable parameters, can pass multiple architecture names

Usage

You can use this api to check the configuration command: xmake f -a armv7

-- if the current architecture is x86_64 or i386
if is_arch("x86_64", "i386") then
    add_files("src/xxx/*.c")
end

-- if the current architecture is armv7 or arm64 or armv7s or armv7-a
if is_arch("armv7", "arm64", "armv7s", "armv7-a") then
    -- ...
end

And you can also use the lua regular expression: .* to check all matched architectures.

-- if the current architecture is arm which contains armv7, arm64, armv7s and armv7-a ...
if is_arch("arm.*") then
    -- ...
end

is_plat

Is the current compilation platform

Function Prototype

::: tip API

is_plat(plat: <string>, ...)

:::

Parameter Description

Parameter	Description
plat	Platform name string
...	Variable parameters, can pass multiple platform names

Usage

You can use this api to check the configuration command: xmake f -p iphoneos

-- if the current platform is android
if is_plat("android") then
    add_files("src/xxx/*.c")
end

-- if the current platform is macosx or iphoneos
if is_plat("macosx", "iphoneos") then
    add_frameworks("Foundation")
end

Available platforms:

Platform
android
appletvos
applexros
bsd
cross
cygwin
haiku
iphoneos
linux
macosx
mingw
msys
wasm
watchos
windows

is_host

Is the current compilation host system

Function Prototype

::: tip API

is_host(host: <string>, ...)

:::

Parameter Description

Parameter	Description
host	Host system name string
...	Variable parameters, can pass multiple host names

Usage

Some compilation platforms can be built on multiple different operating systems, for example: android ndk (on linux, macOS and windows).

So, we can use this api to determine the current host operating system.

if is_host("windows") then
    add_includedirs("C:\\includes")
else
    add_includedirs("/usr/includess")
end

Support hosts:

• windows
• linux
• macosx

We can also get it from $(host) or os.host.

is_subhost

Determine the subsystem environment of the current host

Function Prototype

::: tip API

is_subhost(subhost: <string>, ...)

:::

Parameter Description

Parameter	Description
subhost	Subsystem name string
...	Variable parameters, can pass multiple subsystem names

Usage

At present, it is mainly used for detection of cygwin, msys2 and other subsystem environments on windows systems. If you run xmake in the msys2 shell environment, then is_subhost("windows") will return false, and is_host("windows") It will still return true.

Currently supported subsystems:

• msys
• cygwin

Configuration example:

if is_subhost("msys", "cygwin") then
    - Currently in the shell environment of msys2/cygwin
end

We can also quickly check the current subsystem platform by executing xmake l os.subhost.

::: tip NOTE It may also support other subsystem environments under linux and macos systems later, if they exist. :::

is_subarch

Determine the architecture of the current host subsystem environment

Function Prototype

::: tip API

is_subarch(subarch: <string>, ...)

:::

Parameter Description

Parameter	Description
subarch	Subsystem architecture name string
...	Variable parameters, can pass multiple subsystem architecture names

Usage

At present, it is mainly used for the detection of the architecture under the subsystem environment such as cygwin and msys2 on the windows system. The msvc tool chain is usually used on the windows compilation platform, and the architecture is x64, x86. In the msys/cygwin subsystem environment, the compiler architecture defaults to x86_64/i386, which is different.

We can also quickly view the current subsystem architecture by executing xmake l os.subarch.

is_cross

Determines whether the current platform is cross-compiled or not.

Function Prototype

::: tip API

is_cross()

:::

Parameter Description

Parameter	Description
-	No parameters

Usage

This interface returns true if the current target architecture and platform, which is not the current host platform, is cross-compiled.

is_mode

Is the current compilation mode

Function Prototype

::: tip API

is_mode(mode: <string>, ...)

:::

Parameter Description

Parameter	Description
mode	Compilation mode name string
...	Variable parameters, can pass multiple mode names

Usage

You can use this api to check the configuration command: xmake f -m debug

The compilation mode is not builtin mode for xmake, so you can set the mode value by yourself.

We often use these configuration values: debug, release, profile, etc.

-- if the current compilation mode is debug?
if is_mode("debug") then
    add_defines("DEBUG")
    set_symbols("debug")
    set_optimize("none")
end

-- if the current compilation mode is release?
if is_mode("release") then
    set_symbols("hidden")
    set_strip("all")
end

is_kind

Is the current target kind

Function Prototype

::: tip API

is_kind(kind: <string>, ...)

:::

Parameter Description

Parameter	Description
kind	Target kind name string
...	Variable parameters, can pass multiple kind names

Usage

You can use this api to check the configuration command: xmake f -k [static|shared]

target("test")

    -- set target kind from the configuration command
    set_kind("$(kind)")
    add_files("src/*c")

    -- compile target for static?
    if is_kind("static") then
        add_files("src/xxx.c")
    end

You can switch the target kind by configuration command.

# compile as static library
$ xmake f -k static
$ xmake

# compile as shared library
$ xmake f -k shared
$ xmake

is_config

Is the given config values?

Function Prototype

::: tip API

is_config(name: <string>, values: <string>, ...)

:::

Parameter Description

Parameter	Description
name	Configuration option name string
values	Configuration value string
...	Variable parameters, can pass multiple values

Usage

This interface is introduced from version 2.2.2 to determine whether the specified configuration is a given value.

For example:

$ xmake f --test=hello1

option("test")
    set_showmenu(true)
    set_description("The test config option")
option_end()

if is_config("test", "hello1", "hello2") then
    add_defines("HELLO")
end

Can be used for conditional package requirements, eg. ：

-- Add lua or luajit package requirements, depending on the lua_flavor option value
option("lua_flavor")
    set_showmenu(true)
    set_values("luajit", "lua")
option_end()
if is_config("lua_flavor", "luajit") then
    add_requires("luajit")
elseif is_config("lua_flavor", "lua") then
    add_requires("lua")
end

Not only that, we can also set pattern matching rules to determine values, such as:

if is_config("test", "hello.*") then
    add_defines("HELLO")
end

::: tip NOTE This interface is not only able to determine the custom options defined through the option, but also to determine the built-in global and local configuration. :::

has_config

Is the given configs enabled?

Function Prototype

::: tip API

has_config(configs: <string>, ...)

:::

Parameter Description

Parameter	Description
configs	Configuration name string
...	Variable parameters, can pass multiple configuration names

Usage

This interface is introduced from version 2.2.2 to detect whether a custom or built-in option/configuration exists or is enabled.

For example, the following configuration will be true:

# enable the given config or option (if be boolean type)
$ xmake f --test1=y
$ xmake f --test1=yes
$ xmake f --test1=true

# set the config value
$ xmake f --test2=value

if has_config("test1", "test2") then
    add_defines("TEST")
end

And the following configuration will be false:

# disable config/option（if be boolean type）
$ xmake f --test1=n
$ xmake f --test1=no
$ xmake f --test1=false

::: tip NOTE This interface can determine not only the built-in global and local configs, but also the custom options defined through the option.

This interface works together with the get_config interface to completely get and determine the option state set by the user through xmake f --option1=xxx. :::

has_package

Is the given dependent package enabled?

Function Prototype

::: tip API

has_package(packages: <string>, ...)

:::

Parameter Description

Parameter	Description
packages	Package name string
...	Variable parameters, can pass multiple package names

Usage

This interface is introduced from version 2.2.3 to detect whether a dependent package exists or is enabled.

It is usually used to add_requires.

add_requires("tbox", {optional = true})

target("test")
    set_kind("binary")
    add_files("src/*.c")
    add_packages("tbox")

    if has_package("tbox") then
        add_defines("HAVE_TBOX")
    end

If the remote dependencies are added via the optional add-on package added by add_requires, or the current platform does not support the actual installation, then has_package will return false. Indicates that it does not exist, and then does some special processing for other flags definitions and even source file compilation controls.

::: tip NOTE The difference between this interface and has_config is that has_config is used for option whereas this is used for add_requires. :::