xmake
/
xmake-docs
zrkadlo https://github.com/xmake-io/xmake-docs


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628
							<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>xmake</title>
  <link rel="icon" href="/assets/img/favicon.ico">
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
  <meta name="description" content="Description">
  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
  <link href="/assets/npm/github-markdown/github-markdown.min.css" rel="stylesheet">
  <style>
	.markdown-body {
		box-sizing: border-box;
		min-width: 200px;
		max-width: 980px;
		margin: 0 auto;
		padding: 45px;
	}

	@media (max-width: 767px) {
		.markdown-body {
			padding: 15px;
		}
	}
  </style>
</head>
<body>
<article class="markdown-body">
<h4>This is a mirror page, please see the original page: </h4><a href="https://xmake.io/#/zh-cn/manual/helper_interfaces">https://xmake.io/#/zh-cn/manual/helper_interfaces</a>
<div id="wwads-panel" class="wwads-cn wwads-vertical wwads-sticky" data-id="239" style="max-width:180px;bottom:20px;right:20px;width:200px;height:260px;background:#fff;position:fixed"></div>
</br>
    <script type="text/javascript" charset="UTF-8" src="https://cdn.wwads.cn/js/makemoney.js" async></script>
<script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CE7I52QU&placement=xmakeio" id="_carbonads_js"></script>
<style>
#carbonads {
  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu,
  Cantarell, "Helvetica Neue", Helvetica, Arial, sans-serif;
}

#carbonads {
  display: flex;
  max-width: 330px;
  background-color: hsl(0, 0%, 98%);
  box-shadow: 0 1px 4px 1px hsla(0, 0%, 0%, .1);
}

#carbonads a {
  color: inherit;
  text-decoration: none;
}

#carbonads a:hover {
  color: inherit;
}

#carbonads span {
  position: relative;
  display: block;
  overflow: hidden;
}

#carbonads .carbon-wrap {
  display: flex;
}

.carbon-img {
  display: block;
  margin: 0;
  line-height: 1;
}

.carbon-img img {
  display: block;
}

.carbon-text {
  font-size: 13px;
  padding: 10px;
  line-height: 1.5;
  text-align: left;
}

.carbon-poweredby {
  display: block;
  padding: 8px 10px;
  background: repeating-linear-gradient(-45deg, transparent, transparent 5px, hsla(0, 0%, 0%, .025) 5px, hsla(0, 0%, 0%, .025) 10px) hsla(203, 11%, 95%, .4);
  text-align: center;
  text-transform: uppercase;
  letter-spacing: .5px;
  font-weight: 600;
  font-size: 9px;
  line-height: 1;
}
</style>
    <h3 id="">自动检测辅助接口</h3>
<p>另外，此接口在 2.2.5 之后的版本，提供了一些内置的辅助函数，可以直接使用 includes 导入，具体有哪些内置函数可以看下：<a href="https://github.com/xmake-io/xmake/tree/master/xmake/includes">Helper functions</a></p>
<p>我们可以使用这些接口，检测links, c/c++ type, includes 和 编译器特性，并且写入宏定义到config.h</p>
<p>其中，我们提供了两类接口，<code>check_xxx</code> 和 <code>configvar_check_xxx</code>，带有 <code>configvar_</code> 前缀的接口会在检测通过后，写入 <code>add_configfiles</code> 指定的 config.h.in 模板文件。</p>
<p>而 <code>check_xxx</code> 仅仅只是定义相关 macros 参与编译，但不会持久化到 <code>config.h.in</code> 中去。</p>
<p>相关 issues 见：</p>
<ul>
<li><a href="https://github.com/xmake-io/xmake/issues/342">#342</a></li>
<li><a href="https://github.com/xmake-io/xmake/issues/1715">#1715</a></li>
</ul>
<p>注：如果是 2.8.5 以上版本，就不需要通过 <code>includes("check_links.lua")</code> 分别引入这些接口了，而是使用更加方便的</p>
<pre><code class="lang-lua">includes("@builtin/check")
</code></pre>
<p>一次性引入所有检测接口，当然我们也可以按需引入单个脚本：</p>
<pre><code class="lang-lua">includes("@builtin/check/check_links.lua")
</code></pre>
<p>而原有的引入路径，没有区分是否为用户路径，不方便管理维护，且容易被用户配置干扰，后面会逐步废弃。</p>
<h4 id="links">检测 links</h4>
<p>我们可以通过尝试链接来检测指定的 links 是否通过。</p>
<pre><code class="lang-lua">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"})
</code></pre>
<p>config.h.in</p>
<pre><code class="lang-c">${define HAS_PTHREAD}
</code></pre>
<p>config.h</p>
<pre><code class="lang-c">#define HAS_PTHREAD 1
/* #undef HAS_PTHREAD */
</code></pre>
<h4 id="cc">检测 c/c++ 类型</h4>
<p>我们也能够检测 c/c++ 类型是否存在。</p>
<p><code>configvar_check_ctypes</code> 用于检测 c 代码类型，<code>configvar_check_cxxtypes</code> 用于检测 c++ 代码类型。</p>
<pre><code class="lang-lua">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"})
</code></pre>
<p>config.h.in</p>
<pre><code class="lang-c">${define HAS_WCHAR}
${define HAS_WCHAR_AND_FLOAT}
</code></pre>
<p>config.h</p>
<pre><code class="lang-c">/* #undef HAS_WCHAR */
/* #undef HAS_WCHAR_AND_FLOAT */
</code></pre>
<h4 id="cc">检测 c/c++ 函数</h4>
<p><code>configvar_check_cfuncs</code> 用于检测 c 代码函数，<code>configvar_check_cxxfuncs</code> 用于检测 c++ 代码函数。</p>
<pre><code class="lang-lua">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"}})
</code></pre>
<p>config.h.in</p>
<pre><code class="lang-c">${define HAS_SETJMP}
</code></pre>
<p>config.h</p>
<pre><code class="lang-c">#define HAS_SETJMP 1
/* #undef HAS_SETJMP */
</code></pre>
<h4 id="cc">检测 c/c++ 头文件</h4>
<p><code>configvar_check_cincludes</code> 用于检测 c 代码头文件，<code>configvar_check_cxxincludes</code> 用于检测 c++ 代码头文件。</p>
<pre><code class="lang-lua">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"})
</code></pre>
<p>config.h.in</p>
<pre><code class="lang-c">${define HAS_STRING_H}
${define HAS_STRING_AND_STDIO_H}
</code></pre>
<p>config.h</p>
<pre><code class="lang-c">/* #undef HAS_STRING_H */
#define HAS_STRING_AND_STDIO_H 1
</code></pre>
<h4 id="cc">检测 c/c++ 代码片段</h4>
<p><code>configvar_check_csnippets</code> 用于检测 c 代码片段，<code>configvar_check_cxxsnippets</code> 用于检测 c++ 代码片段。</p>
<pre><code class="lang-lua">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, \"\");")
</code></pre>
<p>config.h.in</p>
<pre><code class="lang-c">${define HAS_STATIC_ASSERT}
</code></pre>
<p>config.h</p>
<pre><code class="lang-c">#define HAS_STATIC_ASSERT 1
</code></pre>
<p>v2.5.7 之后对 check_csnippets 做了改进，新增 <code>tryrun</code> 和 <code>output</code> 参数去尝试运行和捕获输出。</p>
<pre><code class="lang-lua">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", &#39;printf("%d", sizeof(int)); return 0;&#39;, {output = true, number = true})
    configvar_check_csnippets("HAS_LONG_8", "return (sizeof(long) == 8)? 0 : -1;", {tryrun = true})
    configvar_check_csnippets("PTR_SIZE", &#39;printf("%d", sizeof(void*)); return 0;&#39;, {output = true, number = true})
</code></pre>
<p>如果启用捕获输出，<code>config.h.in</code> 的 <code>${define PTR_SIZE}</code> 会自动生成 <code>#define PTR_SIZE 4</code>。</p>
<p>其中，<code>number = true</code> 设置，可以强制作为 number 而不是字符串值，否则默认会定义为 <code>#define PTR_SIZE "4"</code></p>
<h4 id="">检测编译器特性</h4>
<pre><code class="lang-lua">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"})
</code></pre>
<p>config.h.in</p>
<pre><code class="lang-c">${define HAS_CONSTEXPR}
${define HAS_CONSEXPR_AND_STATIC_ASSERT}
</code></pre>
<p>config.h</p>
<pre><code class="lang-c">/* #undef HAS_CONSTEXPR */
#define HAS_CONSEXPR_AND_STATIC_ASSERT 1
</code></pre>
<p>所有 c 编译器特性列表：</p>
<table>
<thead>
<tr>
<th>特性名</th>
</tr>
</thead>
<tbody>
<tr>
<td>c_static_assert</td>
</tr>
<tr>
<td>c_restrict</td>
</tr>
<tr>
<td>c_variadic_macros</td>
</tr>
<tr>
<td>c_function_prototypes</td>
</tr>
</tbody>
</table>
<p>所有 c++ 编译器特性列表：</p>
<table>
<thead>
<tr>
<th>特性名</th>
</tr>
</thead>
<tbody>
<tr>
<td>cxx_variable_templates</td>
</tr>
<tr>
<td>cxx_relaxed_constexpr</td>
</tr>
<tr>
<td>cxx_aggregate_default_initializers</td>
</tr>
<tr>
<td>cxx_contextual_conversions</td>
</tr>
<tr>
<td>cxx_attribute_deprecated</td>
</tr>
<tr>
<td>cxx_decltype_auto</td>
</tr>
<tr>
<td>cxx_digit_separators</td>
</tr>
<tr>
<td>cxx_generic_lambdas</td>
</tr>
<tr>
<td>cxx_lambda_init_captures</td>
</tr>
<tr>
<td>cxx_binary_literals</td>
</tr>
<tr>
<td>cxx_return_type_deduction</td>
</tr>
<tr>
<td>cxx_decltype_incomplete_return_types</td>
</tr>
<tr>
<td>cxx_reference_qualified_functions</td>
</tr>
<tr>
<td>cxx_alignof</td>
</tr>
<tr>
<td>cxx_attributes</td>
</tr>
<tr>
<td>cxx_inheriting_constructors</td>
</tr>
<tr>
<td>cxx_thread_local</td>
</tr>
<tr>
<td>cxx_alias_templates</td>
</tr>
<tr>
<td>cxx_delegating_constructors</td>
</tr>
<tr>
<td>cxx_extended_friend_declarations</td>
</tr>
<tr>
<td>cxx_final</td>
</tr>
<tr>
<td>cxx_nonstatic_member_init</td>
</tr>
<tr>
<td>cxx_override</td>
</tr>
<tr>
<td>cxx_user_literals</td>
</tr>
<tr>
<td>cxx_constexpr</td>
</tr>
<tr>
<td>cxx_defaulted_move_initializers</td>
</tr>
<tr>
<td>cxx_enum_forward_declarations</td>
</tr>
<tr>
<td>cxx_noexcept</td>
</tr>
<tr>
<td>cxx_nullptr</td>
</tr>
<tr>
<td>cxx_range_for</td>
</tr>
<tr>
<td>cxx_unrestricted_unions</td>
</tr>
<tr>
<td>cxx_explicit_conversions</td>
</tr>
<tr>
<td>cxx_lambdas</td>
</tr>
<tr>
<td>cxx_local_type_template_args</td>
</tr>
<tr>
<td>cxx_raw_string_literals</td>
</tr>
<tr>
<td>cxx_auto_type</td>
</tr>
<tr>
<td>cxx_defaulted_functions</td>
</tr>
<tr>
<td>cxx_deleted_functions</td>
</tr>
<tr>
<td>cxx_generalized_initializers</td>
</tr>
<tr>
<td>cxx_inline_namespaces</td>
</tr>
<tr>
<td>cxx_sizeof_member</td>
</tr>
<tr>
<td>cxx_strong_enums</td>
</tr>
<tr>
<td>cxx_trailing_return_types</td>
</tr>
<tr>
<td>cxx_unicode_literals</td>
</tr>
<tr>
<td>cxx_uniform_initialization</td>
</tr>
<tr>
<td>cxx_variadic_templates</td>
</tr>
<tr>
<td>cxx_decltype</td>
</tr>
<tr>
<td>cxx_default_function_template_args</td>
</tr>
<tr>
<td>cxx_long_long_type</td>
</tr>
<tr>
<td>cxx_right_angle_brackets</td>
</tr>
<tr>
<td>cxx_rvalue_references</td>
</tr>
<tr>
<td>cxx_static_assert</td>
</tr>
<tr>
<td>cxx_extern_templates</td>
</tr>
<tr>
<td>cxx_func_identifier</td>
</tr>
<tr>
<td>cxx_variadic_macros</td>
</tr>
<tr>
<td>cxx_template_template_parameters</td>
</tr>
</tbody>
</table>
<p>v2.5.9 新增 c++17 特性检测：</p>
<table>
<thead>
<tr>
<th>特性名</th>
</tr>
</thead>
<tbody>
<tr>
<td>cxx_aggregate_bases</td>
</tr>
<tr>
<td>cxx_aligned_new</td>
</tr>
<tr>
<td>cxx_capture_star_this</td>
</tr>
<tr>
<td>cxx_constexpr</td>
</tr>
<tr>
<td>cxx_deduction_guides</td>
</tr>
<tr>
<td>cxx_enumerator_attributes</td>
</tr>
<tr>
<td>cxx_fold_expressions</td>
</tr>
<tr>
<td>cxx_guaranteed_copy_elision</td>
</tr>
<tr>
<td>cxx_hex_float</td>
</tr>
<tr>
<td>cxx_if_constexpr</td>
</tr>
<tr>
<td>cxx_inheriting_constructors</td>
</tr>
<tr>
<td>cxx_inline_variables</td>
</tr>
<tr>
<td>cxx_namespace_attributes</td>
</tr>
<tr>
<td>cxx_noexcept_function_type</td>
</tr>
<tr>
<td>cxx_nontype_template_args</td>
</tr>
<tr>
<td>cxx_nontype_template_parameter_auto</td>
</tr>
<tr>
<td>cxx_range_based_for</td>
</tr>
<tr>
<td>cxx_static_assert</td>
</tr>
<tr>
<td>cxx_structured_bindings</td>
</tr>
<tr>
<td>cxx_template_template_args</td>
</tr>
<tr>
<td>cxx_variadic_using</td>
</tr>
</tbody>
</table>
<p>v2.5.9 新增 c++20 特性检测：</p>
<table>
<thead>
<tr>
<th>特性名</th>
</tr>
</thead>
<tbody>
<tr>
<td>cxx_aggregate_paren_init</td>
</tr>
<tr>
<td>cxx_char8_t</td>
</tr>
<tr>
<td>cxx_concepts</td>
</tr>
<tr>
<td>cxx_conditional_explicit</td>
</tr>
<tr>
<td>cxx_consteval</td>
</tr>
<tr>
<td>cxx_constexpr</td>
</tr>
<tr>
<td>cxx_constexpr_dynamic_alloc</td>
</tr>
<tr>
<td>cxx_constexpr_in_decltype</td>
</tr>
<tr>
<td>cxx_constinit</td>
</tr>
<tr>
<td>cxx_deduction_guides</td>
</tr>
<tr>
<td>cxx_designated_initializers</td>
</tr>
<tr>
<td>cxx_generic_lambdas</td>
</tr>
<tr>
<td>cxx_impl_coroutine</td>
</tr>
<tr>
<td>cxx_impl_destroying_delete</td>
</tr>
<tr>
<td>cxx_impl_three_way_comparison</td>
</tr>
<tr>
<td>cxx_init_captures</td>
</tr>
<tr>
<td>cxx_modules</td>
</tr>
<tr>
<td>cxx_nontype_template_args</td>
</tr>
<tr>
<td>cxx_using_enum</td>
</tr>
</tbody>
</table>
<p>2.5.8 之后，新增对 cstd 和 c++ std 版本支持，相关 issues: <a href="https://github.com/xmake-io/xmake/issues/1715">#1715</a></p>
<pre><code class="lang-lua">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"})
</code></pre>
<h4 id="">检测内置宏定义</h4>
<p>编译器存在一些内置的宏定义，比如：<code>__GNUC__</code> 等，我们可以通过 <code>check_macros</code> 和 <code>configvar_check_macros</code> 辅助脚本来检测它们是否存在。</p>
<p>相关 issues: <a href="https://github.com/xmake-io/xmake/issues/1715">#1715</a></p>
<pre><code class="lang-lua">-- 检测宏是否定义
configvar_check_macros("HAS_GCC", "__GNUC__")
-- 检测宏没有被定义
configvar_check_macros("NO_GCC", "__GNUC__", {defined = false})
-- 检测宏条件
configvar_check_macros("HAS_CXX20", "__cplusplus >= 202002L", {languages = "c++20"})
</code></pre>
<h4 id="">检测类型大小</h4>
<p>在先前的版本中，我们可以通过 <code>check_csnippets</code> 和 <code>output = true</code> 的方式，来实现类型检测。</p>
<pre><code class="lang-lua">check_csnippets("INT_SIZE", &#39;printf("%d", sizeof(int)); return 0;&#39;, {output = true, number = true})
</code></pre>
<p>但是这种方式，是通过尝试运行测试代码，然后获取运行输出结果，提取类型大小信息。</p>
<p>这对于交叉编译，就不适用了。</p>
<p>在 2.8.5 版本中，我们新增了 <code>check_sizeof</code> 辅助接口，可以通过直接解析测试程序的二进制文件，提取类型大小信息。</p>
<p>由于不需要运行测试，这种方式不仅可以支持交叉编译，而且对检测效率也有极大的提升，使用也更加的简单。</p>
<pre><code class="lang-lua">includes("@builtin/check")

target("test")
    set_kind("static")
    add_files("*.cpp")
    check_sizeof("LONG_SIZE", "long")
    check_sizeof("STRING_SIZE", "std::string", {includes = "string"})
</code></pre>
<pre><code class="lang-bash">$ xmake f -c
checking for LONG_SIZE ... 8
checking for STRING_SIZE ... 24
</code></pre>
<p>另外，我也可以通过 <code>target:check_sizeof</code> 在脚本域进行检测。</p>
<h4 id="">检测大小端</h4>
<p>在 2.8.9 版本之后，我们新增了 <code>check_bigendian</code> 接口，来判断当前编译目标是否为大端模式。</p>
<pre><code class="lang-lua">includes("@builtin/check")

target("test")
    set_kind("static")
    add_files("*.cpp")
    check_bigendian("IS_BIG_ENDIAN")
</code></pre>
<p>如果检测通过，当前是大端模式，那么会定义 <code>IS_BIG_ENDIAN=1</code>。</p>
</article>
</body>
</html>