This is a mirror page, please see the original page:

Automatic detection of auxiliary interface

In addition, the version of this interface after 2.2.5 provides some built-in helper functions, which can be imported directly using includes. See the specific built-in functions: Helper functions

We can use these interfaces to detect links, c/c++ type, includes and compiler features, and write macro definitions to config.h

Among them, we provide two types of interfaces, check_xxx and configvar_check_xxx. The interfaces prefixed with configvar_ will be written into the config.h.in template file specified by add_configfiles after passing the test.

And check_xxx only defines related macros to participate in compilation, but it will not be persisted in config.h.in.

For related issues, see:

-#342
-#1715

Check links

We can check whether the specified links pass or not by trying to link.

includes("check_links.lua")

target("test")
    set_kind("binary")
    add_files("*.c")
    add_configfiles("config.h.in")
    configvar_check_links("HAS_PTHREAD", {"pthread", "m", "dl"})

config.h.in

${define HAS_PTHREAD}

config.h

#define HAS_PTHREAD 1
/* #undef HAS_PTHREAD */

Detect c/c++ type

We can also detect the existence of c/c++ types.

configvar_check_ctypes is used to detect c code types, and configvar_check_cxxtypes is used to detect c++ code types.

includes("check_ctypes.lua")

target("test")
    set_kind("binary")
    add_files("*.c")
    add_configfiles("config.h.in")
    configvar_check_ctypes("HAS_WCHAR", "wchar_t")
    configvar_check_ctypes("HAS_WCHAR_AND_FLOAT", {"wchar_t", "float"})

config.h.in

${define HAS_WCHAR}
${define HAS_WCHAR_AND_FLOAT}

config.h

/* #undef HAS_WCHAR */
/* #undef HAS_WCHAR_AND_FLOAT */

Detect c/c++ functions

configvar_check_cfuncs is used to detect c code functions, and configvar_check_cxxfuncs is used to detect c++ code functions.

includes("check_cfuncs.lua")

target("test")
    set_kind("binary")
    add_files("*.c")
    add_configfiles("config.h.in")
    configvar_check_cfuncs("HAS_SETJMP", "setjmp", {includes = {"signal.h", "setjmp.h"}})

config.h.in

${define HAS_SETJMP}

config.h

#define HAS_SETJMP 1
/* #undef HAS_SETJMP */

Detect c/c++ header files

configvar_check_cincludes is used to detect c code header files, and configvar_check_cxxincludes is used to detect c++ code header files.

includes("check_cincludes.lua")

target("test")
    set_kind("binary")
    add_files("*.c")
    add_configfiles("config.h.in")
    configvar_check_cincludes("HAS_STRING_H", "string.h")
    configvar_check_cincludes("HAS_STRING_AND_STDIO_H", {"string.h", "stdio.h"})

config.h.in

${define HAS_STRING_H}
${define HAS_STRING_AND_STDIO_H}

config.h

/* #undef HAS_STRING_H */
#define HAS_STRING_AND_STDIO_H 1

Detect c/c++ code snippets

configvar_check_csnippets is used to detect c code snippets, and configvar_check_cxxsnippets is used to detect c++ code snippets.

includes("check_csnippets.lua")

target("test")
    set_kind("binary")
    add_files("*.c")
    add_configfiles("config.h.in")
    configvar_check_csnippets("HAS_STATIC_ASSERT", "_Static_assert(1, \"\");")

config.h.in

${define HAS_STATIC_ASSERT}

config.h

#define HAS_STATIC_ASSERT 1

After v2.5.7, check_csnippets has been improved, adding tryrun and output parameters to try to run and capture output.

includes("check_csnippets.lua")

target("test")
    set_kind("binary")
    add_files("*.c")
    add_configfiles("config.h.in")

    check_csnippets("HAS_INT_4", "return (sizeof(int) == 4)? 0: -1;", {tryrun = true})
    check_csnippets("INT_SIZE",'printf("%d", sizeof(int)); return 0;', {output = true, number = true})
    configvar_check_csnippets("HAS_LONG_8", "return (sizeof(long) == 8)? 0: -1;", {tryrun = true})
    configvar_check_csnippets("PTR_SIZE",'printf("%d", sizeof(void*)); return 0;', {output = true, number = true})

If capture output is enabled, ${define PTR_SIZE} in config.h.in will automatically generate #define PTR_SIZE 4.

Among them, the number = true setting can be forced as a number instead of a string value, otherwise it will be defined as #define PTR_SIZE "4" by default

Detecting compiler features

includes("check_features.lua")

target("test")
    set_kind("binary")
    add_files("*.c")
    add_configfiles("config.h.in")
    configvar_check_features("HAS_CONSTEXPR", "cxx_constexpr")
    configvar_check_features("HAS_CONSEXPR_AND_STATIC_ASSERT", {"cxx_constexpr", "c_static_assert"}, {languages = "c++11"})

config.h.in

${define HAS_CONSTEXPR}
${define HAS_CONSEXPR_AND_STATIC_ASSERT}

config.h

/* #undef HAS_CONSTEXPR */
#define HAS_CONSEXPR_AND_STATIC_ASSERT 1

List of all c compiler features:

List of all c++ compiler features:

After 2.5.8, support for cstd and c++ std versions are added, related issues: #1715

configvar_check_features("HAS_CXX_STD_98", "cxx_std_98")
configvar_check_features("HAS_CXX_STD_11", "cxx_std_11", {languages = "c++11"})
configvar_check_features("HAS_CXX_STD_14", "cxx_std_14", {languages = "c++14"})
configvar_check_features("HAS_CXX_STD_17", "cxx_std_17", {languages = "c++17"})
configvar_check_features("HAS_CXX_STD_20", "cxx_std_20", {languages = "c++20"})
configvar_check_features("HAS_C_STD_89", "c_std_89")
configvar_check_features("HAS_C_STD_99", "c_std_99")
configvar_check_features("HAS_C_STD_11", "c_std_11", {languages = "c11"})
configvar_check_features("HAS_C_STD_17", "c_std_17", {languages = "c17"})

Detect built-in macro definitions

There are some built-in macro definitions in the compiler, such as __GNUC__, etc. We can use the check_macros and configvar_check_macros auxiliary scripts to detect their existence.

Related issues: #1715

- Check whether the macro is defined
configvar_check_macros("HAS_GCC", "__GNUC__")
- The detection macro is not defined
configvar_check_macros("NO_GCC", "__GNUC__", {defined = false})
- Detect macro conditions
configvar_check_macros("HAS_CXX20", "__cplusplus >= 202002L", {languages = "c++20"})