Home Explore Help
Sign In
xmake
/
xmake-docs
mirror of https://github.com/xmake-io/xmake-docs
2
0
Fork 0
Files Issues 0 Wiki
Branch: docsify
Branches Tags
xmake-docs
/
mirror
/
zh-cn
/
plugin
/
builtin_plugins.html

builtin_plugins.html 45 KB
Permalink History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4.   <meta charset="UTF-8">
    5. 

  5.   <title>xmake</title>
    6. 

  6.   <link rel="icon" href="/assets/img/favicon.ico">
    7. 

  7.   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
    8. 

  8.   <meta name="description" content="Description">
    9. 

  9.   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    10. 

  10.   <link href="/assets/npm/github-markdown/github-markdown.min.css" rel="stylesheet">
    11. 

  11.   <style>
    12. 

  12. 	.markdown-body {
    13. 

  13. 		box-sizing: border-box;
    14. 

  14. 		min-width: 200px;
    15. 

  15. 		max-width: 980px;
    16. 

  16. 		margin: 0 auto;
    17. 

  17. 		padding: 45px;
    18. 

  18. 	}
    19. 

  19. 

  20. 	@media (max-width: 767px) {
    21. 

  21. 		.markdown-body {
    22. 

  22. 			padding: 15px;
    23. 

  23. 		}
    24. 

  24. 	}
    25. 

  25.   </style>
    26. 

  26. </head>
    27. 

  27. <body>
    28. 

  28. <article class="markdown-body">
    29. 

  29. <h4>This is a mirror page, please see the original page: </h4><a href="https://xmake.io/#/zh-cn/plugin/builtin_plugins">https://xmake.io/#/zh-cn/plugin/builtin_plugins</a>
    30. 

  30. <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>
    31. 

  31. </br>
    32. 

  32.     <script type="text/javascript" charset="UTF-8" src="https://cdn.wwads.cn/js/makemoney.js" async></script>
    33. 

  33. <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?serve=CE7I52QU&placement=xmakeio" id="_carbonads_js"></script>
    34. 

  34. <style>
    35. 

  35. #carbonads {
    36. 

  36.   font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu,
    37. 

  37.   Cantarell, "Helvetica Neue", Helvetica, Arial, sans-serif;
    38. 

  38. }
    39. 

  39. 

  40. #carbonads {
    41. 

  41.   display: flex;
    42. 

  42.   max-width: 330px;
    43. 

  43.   background-color: hsl(0, 0%, 98%);
    44. 

  44.   box-shadow: 0 1px 4px 1px hsla(0, 0%, 0%, .1);
    45. 

  45. }
    46. 

  46. 

  47. #carbonads a {
    48. 

  48.   color: inherit;
    49. 

  49.   text-decoration: none;
    50. 

  50. }
    51. 

  51. 

  52. #carbonads a:hover {
    53. 

  53.   color: inherit;
    54. 

  54. }
    55. 

  55. 

  56. #carbonads span {
    57. 

  57.   position: relative;
    58. 

  58.   display: block;
    59. 

  59.   overflow: hidden;
    60. 

  60. }
    61. 

  61. 

  62. #carbonads .carbon-wrap {
    63. 

  63.   display: flex;
    64. 

  64. }
    65. 

  65. 

  66. .carbon-img {
    67. 

  67.   display: block;
    68. 

  68.   margin: 0;
    69. 

  69.   line-height: 1;
    70. 

  70. }
    71. 

  71. 

  72. .carbon-img img {
    73. 

  73.   display: block;
    74. 

  74. }
    75. 

  75. 

  76. .carbon-text {
    77. 

  77.   font-size: 13px;
    78. 

  78.   padding: 10px;
    79. 

  79.   line-height: 1.5;
    80. 

  80.   text-align: left;
    81. 

  81. }
    82. 

  82. 

  83. .carbon-poweredby {
    84. 

  84.   display: block;
    85. 

  85.   padding: 8px 10px;
    86. 

  86.   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);
    87. 

  87.   text-align: center;
    88. 

  88.   text-transform: uppercase;
    89. 

  89.   letter-spacing: .5px;
    90. 

  90.   font-weight: 600;
    91. 

  91.   font-size: 9px;
    92. 

  92.   line-height: 1;
    93. 

  93. }
    94. 

  94. </style>
    95. 

  95.     <h2 id="ide">生成IDE工程文件</h2>
    96. 

  96. <h3 id="">简介</h3>
    97. 

  97. <p>XMake跟<code>cmake</code>, <code>premake</code>等其他一些构建工具的区别在于：</p>
    98. 

  98. <p>!> <code>xmake</code>默认是直接构建运行的，生成第三方的IDE的工程文件仅仅作为<code>插件</code>来提供。</p>
    99. 

  99. <p>这样做的一个好处是：插件更加容易扩展，维护也更加独立和方便。</p>
    100. 

  100. <h3 id="makefile">生成Makefile</h3>
    101. 

  101. <pre><code class="lang-console">$ xmake project -k makefile
    102. 

  102. </code></pre>
    103. 

  103. <h3 id="cmakeliststxt">生成CMakelists.txt</h3>
    104. 

  104. <pre><code class="lang-console">$ xmake project -k cmakelists
    105. 

  105. </code></pre>
    106. 

  106. <h3 id="buildninja">生成build.ninja</h3>
    107. 

  107. <p>!> 2.3.1以上版本才支持</p>
    108. 

  108. <pre><code class="lang-console">$ xmake project -k ninja
    109. 

  109. </code></pre>
    110. 

  110. <h3 id="compiler_flags">生成compiler_flags</h3>
    111. 

  111. <pre><code class="lang-console">$ xmake project -k compiler_flags
    112. 

  112. </code></pre>
    113. 

  113. <h3 id="compile_commands">生成compile_commands</h3>
    114. 

  114. <p>导出每个源文件的编译信息，生成基于clang的编译数据库文件，json格式，可用于跟ide，编辑器，静态分析工具进行交互。</p>
    115. 

  115. <pre><code class="lang-console">$ xmake project -k compile_commands
    116. 

  116. </code></pre>
    117. 

  117. <p>输出的内容格式如下：</p>
    118. 

  118. <pre><code>[
    119. 

  119.   { "directory": "/home/user/llvm/build",
    120. 

  120.     "command": "/usr/bin/clang++ -Irelative -DSOMEDEF=\"With spaces, quotes and \\-es.\" -c -o file.o file.cc",
    121. 

  121.     "file": "file.cc" },
    122. 

  122.   ...
    123. 

  123. ]
    124. 

  124. 

  125. </code></pre><p>对于<code>compile_commands</code>的详细说明见：<a href="#https://clang.llvm.org/docs/JSONCompilationDatabase.html">JSONCompilationDatabase</a></p>
    126. 

  126. <h3 id="xcode">生成Xcode工程文件</h3>
    127. 

  127. <p>目前，我们还没有时间去自己实现xcode工程的生成，但不代表不支持，因为xmake支持生成cmakelists.txt文件，而cmake是支持xcode工程文件生成的，在官方还没有实现之前，<br>我们也可以通过cmake变相支持它，xmake会自动内部调用cmake中转下生成结果，对用户而言使用上没啥区别，只需要确保cmake已经安装即可：</p>
    128. 

  128. <pre><code class="lang-console">$ xmake project -k xcode
    129. 

  129. </code></pre>
    130. 

  130. <p>!> 等之后有时间，我们会重新自己实现各更加完善的xcode输出插件，也欢迎大家帮忙贡献。</p>
    131. 

  131. <h3 id="visualstudio">生成VisualStudio工程</h3>
    132. 

  132. <h4 id="xmake">使用xmake集成编译</h4>
    133. 

  133. <p>v2.2.8以上版本，提供了新版本的vs工程生成插件扩展，跟之前的生成vs的插件处理模式上有很大的不同，之前生成的vs工程是把所有文件的编译展开后，转交给vs来处理编译。</p>
    134. 

  134. <p>但是这种模式，对xmake的rules是没法支持的。因为xmake的rules里面用了很多的<code>on_build</code>此类自定义脚本，无法展开，所以像qt， wdk此类的项目就没法支持导出到vs里面进行编译了。</p>
    135. 

  135. <p>因此，为了解决这个问题，新版本的vs生成插件通过在vs下直接调用xmake命令，去执行编译操作，并且对intellsence和定义跳转，还有断点调试也做了支持。</p>
    136. 

  136. <p>具体使用方式跟老版本类似：</p>
    137. 

  137. <pre><code class="lang-console">$ xmake project -k [vsxmake2010|vsxmake2013|vsxmake2015|..] -m "debug;release"
    138. 

  138. </code></pre>
    139. 

  139. <p>如果没指明版本，那么xmake会自动探测当前已有的vs版本来生成：</p>
    140. 

  140. <pre><code class="lang-bash">$ xmake project -k vsxmake -m "debug,release"
    141. 

  141. </code></pre>
    142. 

  142. <p><img src="/assets/img/manual/qt_vs.png" alt=""></p>
    143. 

  143. <p>另外，vsxmake插件还会额外生成一个自定义的配置属性页，用于在vs里面，方便灵活的修改和追加一些xmake编译配置，甚至可以在里面配置切换到其他交叉工具链，实现在vs中对android, linux等其他平台的交叉编译。</p>
    144. 

  144. <p><img src="/assets/img/manual/property_page_vsxmake.png" alt=""></p>
    145. 

  145. <p>v2.5.1 版本提供了一个 <code>add_rules("plugin.vsxmake.autoupdate")</code> 规则，如果应用此规则，生产的vs工程在编译完成后，会检测 xmake.lua 和代码文件列表的改动，如果有变化，就会自动更新 vs 工程。</p>
    146. 

  146. <pre><code class="lang-lua">add_rules("plugin.vsxmake.autoupdate")
    147. 

  147. target("test")
    148. 

  148.     set_kind("binary")
    149. 

  149.     add_files("src/*.c")
    150. 

  150. </code></pre>
    151. 

  151. <p>另外，我们可以通过 <code>set_group</code> 接口对每个 target 设置分组，使得生成的 vs 工程可以按指定结构进行分组。更多详情见：<a href="https://github.com/xmake-io/xmake/issues/1026">issue 1026</a></p>
    152. 

  152. <h4 id="vs">使用vs内置编译机制</h4>
    153. 

  153. <p>!> 建议尽量使用上文提到的v2.2.8之后提供的新版的vs生成插件，支持更加完善，此处的生成方式不支持xmake的rules，以及对qt等工程的生成。</p>
    154. 

  154. <pre><code class="lang-console">$ xmake project -k [vs2008|vs2013|vs2015|..]
    155. 

  155. </code></pre>
    156. 

  156. <p>v2.1.2以上版本，增强了vs201x版本工程的生成，支持多模式+多架构生成，生成的时候只需要指定：</p>
    157. 

  157. <pre><code class="lang-console">$ xmake project -k vs2017 -m "debug,release"
    158. 

  158. </code></pre>
    159. 

  159. <p>生成后的工程文件，同时支持<code>debug|x86</code>, <code>debug|x64</code>, <code>release|x86</code>, <code>release|x64</code>四种配置模式。</p>
    160. 

  160. <p>如果不想每次生成的时候，指定模式，可以把模式配置加到<code>xmake.lua</code>的中，例如：</p>
    161. 

  161. <pre><code class="lang-lua">-- 配置当前的工程，支持哪些编译模式
    162. 

  162. add_rules("mode.debug", "mode.release")
    163. 

  163. </code></pre>
    164. 

  164. <p>另外，我们可以通过 <code>set_group</code> 接口对每个 target 设置分组，使得生成的 vs 工程可以按指定结构进行分组。更多详情见：<a href="https://github.com/xmake-io/xmake/issues/1026">issue 1026</a></p>
    165. 

  165. <h2 id="lua">运行自定义lua脚本</h2>
    166. 

  166. <p>这个跟宏脚本类似，只是省去了导入导出操作，直接指定lua脚本来加载运行，这对于想要快速测试一些接口模块，验证自己的某些思路，都是一个不错的方式。</p>
    167. 

  167. <h3 id="">运行指定的脚本文件</h3>
    168. 

  168. <p>我们先写个简单的lua脚本：</p>
    169. 

  169. <pre><code class="lang-lua">function main()
    170. 

  170.     print("hello xmake!")
    171. 

  171. end
    172. 

  172. </code></pre>
    173. 

  173. <p>然后直接运行它就行了：</p>
    174. 

  174. <pre><code class="lang-console">$ xmake lua /tmp/test.lua
    175. 

  175. </code></pre>
    176. 

  176. <p><p class="tip"><br>    当然，你也可以像宏脚本那样，使用<code>import</code>接口导入扩展模块，实现复杂的功能。<br></p>
    177. 

  177. 

  178. </p>
    179. 

  179. <h3 id="">运行内置的脚本命令</h3>
    180. 

  180. <p>你可以运行 <code>xmake lua -l</code> 来列举所有内置的脚本名，例如：</p>
    181. 

  181. <pre><code class="lang-console">$ xmake lua -l
    182. 

  182. scripts:
    183. 

  183.     cat
    184. 

  184.     cp
    185. 

  185.     echo
    186. 

  186.     versioninfo
    187. 

  187.     ...
    188. 

  188. </code></pre>
    189. 

  189. <p>并且运行它们：</p>
    190. 

  190. <pre><code class="lang-console">$ xmake lua cat ~/file.txt
    191. 

  191. $ xmake lua echo "hello xmake"
    192. 

  192. $ xmake lua cp /tmp/file /tmp/file2
    193. 

  193. $ xmake lua versioninfo
    194. 

  194. </code></pre>
    195. 

  195. <h3 id="repl">运行交互命令 (REPL)</h3>
    196. 

  196. <p>有时候在交互模式下，运行命令更加的方便测试和验证一些模块和api，也更加的灵活，不需要再去额外写一个脚本文件来加载。</p>
    197. 

  197. <p>我们先看下，如何进入交互模式：</p>
    198. 

  198. <pre><code class="lang-console"># 不带任何参数执行，就可以进入
    199. 

  199. $ xmake lua
    200. 

  200. >
    201. 

  201. 

  202. # 进行表达式计算
    203. 

  203. > 1 + 2
    204. 

  204. 3
    205. 

  205. 

  206. # 赋值和打印变量值
    207. 

  207. > a = 1
    208. 

  208. > a
    209. 

  209. 1
    210. 

  210. 

  211. # 多行输入和执行
    212. 

  212. > for _, v in pairs({1, 2, 3}) do
    213. 

  213. >> print(v)
    214. 

  214. >> end
    215. 

  215. 1
    216. 

  216. 2
    217. 

  217. 3
    218. 

  218. </code></pre>
    219. 

  219. <p>我们也能够通过 <code>import</code> 来导入扩展模块：</p>
    220. 

  220. <pre><code class="lang-console">> task = import("core.project.task")
    221. 

  221. > task.run("hello")
    222. 

  222. hello xmake!
    223. 

  223. </code></pre>
    224. 

  224. <p>如果要中途取消多行输入，只需要输入字符：<code>q</code> 就行了</p>
    225. 

  225. <pre><code class="lang-console">> for _, v in ipairs({1, 2}) do
    226. 

  226. >> print(v)
    227. 

  227. >> q             <--  取消多行输入，清空先前的输入数据
    228. 

  228. > 1 + 2
    229. 

  229. 3
    230. 

  230. </code></pre>
    231. 

  231. <h2 id="">显示指定信息和列表</h2>
    232. 

  232. <h3 id="xmake">显示xmake自身和当前项目的基础信息</h3>
    233. 

  233. <pre><code class="lang-bash">$ xmake show
    234. 

  234. The information of xmake:
    235. 

  235.     version: 2.3.3+202006011009
    236. 

  236.     host: macosx/x86_64
    237. 

  237.     programdir: /Users/ruki/.local/share/xmake
    238. 

  238.     programfile: /Users/ruki/.local/bin/xmake
    239. 

  239.     globaldir: /Users/ruki/.xmake
    240. 

  240.     tmpdir: /var/folders/32/w9cz0y_14hs19lkbs6v6_fm80000gn/T/.xmake501/200603
    241. 

  241.     workingdir: /Users/ruki/projects/personal/tbox
    242. 

  242.     packagedir: /Users/ruki/.xmake/packages
    243. 

  243.     packagedir(cache): /Users/ruki/.xmake/cache/packages/2006
    244. 

  244. 

  245. The information of project: tbox
    246. 

  246.     version: 1.6.5
    247. 

  247.     plat: macosx
    248. 

  248.     arch: x86_64
    249. 

  249.     mode: release
    250. 

  250.     buildir: build
    251. 

  251.     configdir: /Users/ruki/projects/personal/tbox/.xmake/macosx/x86_64
    252. 

  252.     projectdir: /Users/ruki/projects/personal/tbox
    253. 

  253.     projectfile: /Users/ruki/projects/personal/tbox/xmake.lua
    254. 

  254. </code></pre>
    255. 

  255. <h3 id="">显示工具链列表</h3>
    256. 

  256. <pre><code class="lang-bash">$ xmake show -l toolchains
    257. 

  257. xcode         Xcode IDE
    258. 

  258. vs            VisualStudio IDE
    259. 

  259. yasm          The Yasm Modular Assembler
    260. 

  260. clang         A C language family frontend for LLVM
    261. 

  261. go            Go Programming Language Compiler
    262. 

  262. dlang         D Programming Language Compiler
    263. 

  263. sdcc          Small Device C Compiler
    264. 

  264. cuda          CUDA Toolkit
    265. 

  265. ndk           Android NDK
    266. 

  266. rust          Rust Programming Language Compiler
    267. 

  267. llvm          A collection of modular and reusable compiler and toolchain technologies
    268. 

  268. cross         Common cross compilation toolchain
    269. 

  269. nasm          NASM Assembler
    270. 

  270. gcc           GNU Compiler Collection
    271. 

  271. mingw         Minimalist GNU for Windows
    272. 

  272. gnu-rm        GNU Arm Embedded Toolchain
    273. 

  273. envs          Environment variables toolchain
    274. 

  274. fasm          Flat Assembler
    275. 

  275. </code></pre>
    276. 

  276. <h3 id="target">显示指定 target 配置信息</h3>
    277. 

  277. <p>我们可以用它来快速追溯定位一些特定配置的位置。</p>
    278. 

  278. <pre><code class="lang-bash">$ xmake show -t tbox
    279. 

  279. The information of target(tbox):
    280. 

  280.     at: /Users/ruki/projects/personal/tbox/src/tbox/xmake.lua
    281. 

  281.     kind: static
    282. 

  282.     targetfile: build/macosx/x86_64/release/libtbox.a
    283. 

  283.     rules:
    284. 

  284.       -> mode.release -> ./xmake.lua:26
    285. 

  285.       -> mode.debug -> ./xmake.lua:26
    286. 

  286.       -> mode.profile -> ./xmake.lua:26
    287. 

  287.       -> mode.coverage -> ./xmake.lua:26
    288. 

  288.       -> utils.install.cmake_importfiles -> ./src/tbox/xmake.lua:15
    289. 

  289.       -> utils.install.pkgconfig_importfiles -> ./src/tbox/xmake.lua:16
    290. 

  290.     options:
    291. 

  291.       -> info -> ./src/tbox/xmake.lua:50
    292. 

  292.       -> float -> ./src/tbox/xmake.lua:50
    293. 

  293.       -> wchar -> ./src/tbox/xmake.lua:50
    294. 

  294.       -> exception -> ./src/tbox/xmake.lua:50
    295. 

  295.       -> force-utf8 -> ./src/tbox/xmake.lua:50
    296. 

  296.       -> deprecated -> ./src/tbox/xmake.lua:50
    297. 

  297.       -> xml -> ./src/tbox/xmake.lua:53
    298. 

  298.       -> zip -> ./src/tbox/xmake.lua:53
    299. 

  299.       -> hash -> ./src/tbox/xmake.lua:53
    300. 

  300.       -> regex -> ./src/tbox/xmake.lua:53
    301. 

  301.       -> coroutine -> ./src/tbox/xmake.lua:53
    302. 

  302.       -> object -> ./src/tbox/xmake.lua:53
    303. 

  303.       -> charset -> ./src/tbox/xmake.lua:53
    304. 

  304.       -> database -> ./src/tbox/xmake.lua:53
    305. 

  305.     packages:
    306. 

  306.       -> mbedtls -> ./src/tbox/xmake.lua:43
    307. 

  307.       -> polarssl -> ./src/tbox/xmake.lua:43
    308. 

  308.       -> openssl -> ./src/tbox/xmake.lua:43
    309. 

  309.       -> pcre2 -> ./src/tbox/xmake.lua:43
    310. 

  310.       -> pcre -> ./src/tbox/xmake.lua:43
    311. 

  311.       -> zlib -> ./src/tbox/xmake.lua:43
    312. 

  312.       -> mysql -> ./src/tbox/xmake.lua:43
    313. 

  313.       -> sqlite3 -> ./src/tbox/xmake.lua:43
    314. 

  314.     links:
    315. 

  315.       -> pthread -> option(__keyword_thread_local) -> @programdir/includes/check_csnippets.lua:100
    316. 

  316.     syslinks:
    317. 

  317.       -> pthread -> ./xmake.lua:71
    318. 

  318.       -> dl -> ./xmake.lua:71
    319. 

  319.       -> m -> ./xmake.lua:71
    320. 

  320.       -> c -> ./xmake.lua:71
    321. 

  321.     defines:
    322. 

  322.       -> __tb_small__ -> ./xmake.lua:42
    323. 

  323.       -> __tb_prefix__="tbox" -> ./src/tbox/xmake.lua:19
    324. 

  324.       -> _GNU_SOURCE=1 -> option(__systemv_semget) -> @programdir/includes/check_cfuncs.lua:104
    325. 

  325.     cxflags:
    326. 

  326.       -> -Wno-error=deprecated-declarations -> ./xmake.lua:22
    327. 

  327.       -> -fno-strict-aliasing -> ./xmake.lua:22
    328. 

  328.       -> -Wno-error=expansion-to-defined -> ./xmake.lua:22
    329. 

  329.       -> -fno-stack-protector -> ./xmake.lua:51
    330. 

  330.     frameworks:
    331. 

  331.       -> CoreFoundation -> ./src/tbox/xmake.lua:38
    332. 

  332.       -> CoreServices -> ./src/tbox/xmake.lua:38
    333. 

  333.     mxflags:
    334. 

  334.       -> -Wno-error=deprecated-declarations -> ./xmake.lua:23
    335. 

  335.       -> -fno-strict-aliasing -> ./xmake.lua:23
    336. 

  336.       -> -Wno-error=expansion-to-defined -> ./xmake.lua:23
    337. 

  337.     includedirs:
    338. 

  338.       -> src -> ./src/tbox/xmake.lua:26
    339. 

  339.       -> build/macosx/x86_64/release -> ./src/tbox/xmake.lua:27
    340. 

  340.     headerfiles:
    341. 

  341.       -> src/(tbox/**.h)|**/impl/**.h -> ./src/tbox/xmake.lua:30
    342. 

  342.       -> src/(tbox/prefix/**/prefix.S) -> ./src/tbox/xmake.lua:31
    343. 

  343.       -> src/(tbox/math/impl/*.h) -> ./src/tbox/xmake.lua:32
    344. 

  344.       -> src/(tbox/utils/impl/*.h) -> ./src/tbox/xmake.lua:33
    345. 

  345.       -> build/macosx/x86_64/release/tbox.config.h -> ./src/tbox/xmake.lua:34
    346. 

  346.     files:
    347. 

  347.       -> src/tbox/*.c -> ./src/tbox/xmake.lua:56
    348. 

  348.       -> src/tbox/hash/bkdr.c -> ./src/tbox/xmake.lua:57
    349. 

  349.       -> src/tbox/hash/fnv32.c -> ./src/tbox/xmake.lua:57
    350. 

  350.       -> src/tbox/hash/adler32.c -> ./src/tbox/xmake.lua:57
    351. 

  351.       -> src/tbox/math/**.c -> ./src/tbox/xmake.lua:58
    352. 

  352.       -> src/tbox/libc/**.c|string/impl/**.c -> ./src/tbox/xmake.lua:59
    353. 

  353.       -> src/tbox/utils/*.c|option.c -> ./src/tbox/xmake.lua:60
    354. 

  354.       -> src/tbox/prefix/**.c -> ./src/tbox/xmake.lua:61
    355. 

  355.       -> src/tbox/memory/**.c -> ./src/tbox/xmake.lua:62
    356. 

  356.       -> src/tbox/string/**.c -> ./src/tbox/xmake.lua:63
    357. 

  357.       -> src/tbox/stream/**.c|**/charset.c|**/zip.c -> ./src/tbox/xmake.lua:64
    358. 

  358.       -> src/tbox/network/**.c|impl/ssl/*.c -> ./src/tbox/xmake.lua:65
    359. 

  359.       -> src/tbox/algorithm/**.c -> ./src/tbox/xmake.lua:66
    360. 

  360.       -> src/tbox/container/**.c|element/obj.c -> ./src/tbox/xmake.lua:67
    361. 

  361.       -> src/tbox/libm/impl/libm.c -> ./src/tbox/xmake.lua:68
    362. 

  362.       -> src/tbox/libm/idivi8.c -> ./src/tbox/xmake.lua:73
    363. 

  363.       -> src/tbox/libm/ilog2i.c -> ./src/tbox/xmake.lua:70
    364. 

  364.       -> src/tbox/libm/isqrti.c -> ./src/tbox/xmake.lua:71
    365. 

  365.       -> src/tbox/libm/isqrti64.c -> ./src/tbox/xmake.lua:72
    366. 

  366.       -> src/tbox/platform/*.c|context.c|exception.c -> ./src/tbox/xmake.lua:74
    367. 

  367.       -> src/tbox/platform/impl/*.c|charset.c|poller_fwatcher.c -> ./src/tbox/xmake.lua:74
    368. 

  368.       -> src/tbox/libm/*.c -> ./src/tbox/xmake.lua:77
    369. 

  369.     compiler (cc): /usr/bin/xcrun -sdk macosx clang
    370. 

  370.       -> -Qunused-arguments -target x86_64-apple-macos12.6 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX13.0.sdk
    371. 

  371.     linker (ar): /usr/bin/xcrun -sdk macosx ar
    372. 

  372.       -> -cr
    373. 

  373.     compflags (cc):
    374. 

  374.       -> -Qunused-arguments -target x86_64-apple-macos12.6 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX13.0.sdk -Wall -Werror -Oz -std=c99 -Isrc -Ibuild/macosx/x86_64/release -D__tb_small__ -D__tb_prefix__=\"tbox\" -D_GNU_SOURCE=1 -framework CoreFoundation -framework CoreServices -Wno-error=deprecated-declarations -fno-strict-aliasing -Wno-error=expansion-to-defined -fno-stack-protector
    375. 

  375.     linkflags (ar):
    376. 

  376.       -> -cr
    377. 

  377. </code></pre>
    378. 

  378. <h3 id="">显示内置编译模式列表</h3>
    379. 

  379. <pre><code class="lang-bash">$ xmake show -l buildmodes
    380. 

  380. </code></pre>
    381. 

  381. <h3 id="">显示内置编译规则列表</h3>
    382. 

  382. <pre><code class="lang-bash">$ xmake show -l rules
    383. 

  383. </code></pre>
    384. 

  384. <h3 id="">显示其他信息</h3>
    385. 

  385. <p>还在完善中，详情见：<a href="https://github.com/xmake-io/xmake/issues/798">https://github.com/xmake-io/xmake/issues/798</a></p>
    386. 

  386. <p>或者运行：</p>
    387. 

  387. <pre><code class="lang-bash">$ xmake show --help
    388. 

  388. </code></pre>
    389. 

  389. <h2 id="">监视文件更新</h2>
    390. 

  390. <p>v2.7.1 版本新增了 <code>xmake watch</code> 插件命令，可以自动监视项目文件更新，然后触发自动构建，或者运行一些自定义命令。</p>
    391. 

  391. <p>这通常用于个人开发时候，实现快速的实时增量编译，而不需要每次手动执行编译命令，提高开发效率。</p>
    392. 

  392. <h3 id="">项目更新后自动构建</h3>
    393. 

  393. <p>默认行为就是监视整个项目根目录，任何文件改动都会触发项目的增量编译。</p>
    394. 

  394. <pre><code class="lang-bash">$ xmake watch
    395. 

  395. watching /private/tmp/test/src/** ..
    396. 

  396. watching /private/tmp/test/* ..
    397. 

  397. /private/tmp/test/src/main.cpp modified
    398. 

  398. [ 25%]: cache compiling.release src/main.cpp
    399. 

  399. [ 50%]: linking.release test
    400. 

  400. [100%]: build ok!
    401. 

  401. </code></pre>
    402. 

  402. <h3 id="">监视指定目录</h3>
    403. 

  403. <p>我们也可以监视指定的代码目录，缩小监视范围，提升监视性能。</p>
    404. 

  404. <pre><code class="lang-bash">$ xmake watch -d src
    405. 

  405. $ xmake watch -d "src;tests/*"
    406. 

  406. </code></pre>
    407. 

  407. <p>上面的命令，会去递归监视所有子目录，如果想要紧紧监视当前目录下的文件，不进行递归监视，可以使用下面的命令。</p>
    408. 

  408. <pre><code class="lang-bash">$ xmake watch -p src
    409. 

  409. $ xmake watch -p "src;tests/*"
    410. 

  410. </code></pre>
    411. 

  411. <h3 id="">监视并运行指定命令</h3>
    412. 

  412. <p>如果想在自动构建后，还想自动运行构建的程序，我们可以使用自定义的命令集。</p>
    413. 

  413. <pre><code class="lang-bash">$ xmake watch -c "xmake; xmake run"
    414. 

  414. </code></pre>
    415. 

  415. <p>上面的命令列表是作为字符串传递，这对于复杂命令参数，需要转义比较繁琐不够灵活，那么我们可以使用下面的方式进行任意命令的设置。</p>
    416. 

  416. <pre><code class="lang-bash">$ xmake watch -- echo hello xmake!
    417. 

  417. $ xmake watch -- xmake run --help
    418. 

  418. </code></pre>
    419. 

  419. <h3 id="">监视并运行目标程序</h3>
    420. 

  420. <p>尽管我们可以通过自定义命令来实现目标程序的自动运行，但是我们也提供了更加方便的参数来实现这个行为。</p>
    421. 

  421. <pre><code class="lang-bash">$ xmake watch -r
    422. 

  422. $ xmake watch --run
    423. 

  423. [100%]: build ok!
    424. 

  424. hello world!
    425. 

  425. </code></pre>
    426. 

  426. <h3 id="lua">监视并运行 lua 脚本</h3>
    427. 

  427. <p>我们还可以监视文件更新后，运行指定的 lua 脚本，实现更加灵活复杂的命令定制。</p>
    428. 

  428. <pre><code class="lang-bash">$ xmake watch -s /tmp/test.lua
    429. 

  429. </code></pre>
    430. 

  430. <p>我们还可以再脚本中获取所有更新的文件路径列表和事件。</p>
    431. 

  431. <pre><code class="lang-lua">function main(events)
    432. 

  432.     -- TODO handle events
    433. 

  433. end
    434. 

  434. </code></pre>
    435. 

  435. <h2 id="">分析诊断工程配置和代码</h2>
    436. 

  436. <h3 id="">检测工程配置</h3>
    437. 

  437. <h4 id="api">默认检测所有 API</h4>
    438. 

  438. <pre><code class="lang-lua">set_lanuages("c91") -- typo
    439. 

  439. </code></pre>
    440. 

  440. <pre><code class="lang-console">$ xmake check
    441. 

  441. ./xmake.lua:15: warning: unknown language value &#39;c91&#39;, it may be &#39;c90&#39;
    442. 

  442. 0 notes, 1 warnings, 0 errors
    443. 

  443. </code></pre>
    444. 

  444. <p>默认也可以指定检测特定组：</p>
    445. 

  445. <pre><code class="lang-console">$ xmake check api
    446. 

  446. $ xmake check api.target
    447. 

  447. </code></pre>
    448. 

  448. <h4 id="">显示详细输出</h4>
    449. 

  449. <p>这会额外提供 note 级别的检测信息。</p>
    450. 

  450. <pre><code class="lang-console">$ xmake check -v
    451. 

  451. ./xmake.lua:15: warning: unknown language value &#39;cxx91&#39;, it may be &#39;cxx98&#39;
    452. 

  452. ./src/tbox/xmake.lua:43: note: unknown package value &#39;mbedtls&#39;
    453. 

  453. ./src/tbox/xmake.lua:43: note: unknown package value &#39;polarssl&#39;
    454. 

  454. ./src/tbox/xmake.lua:43: note: unknown package value &#39;openssl&#39;
    455. 

  455. ./src/tbox/xmake.lua:43: note: unknown package value &#39;pcre2&#39;
    456. 

  456. ./src/tbox/xmake.lua:43: note: unknown package value &#39;pcre&#39;
    457. 

  457. ./src/tbox/xmake.lua:43: note: unknown package value &#39;zlib&#39;
    458. 

  458. ./src/tbox/xmake.lua:43: note: unknown package value &#39;mysql&#39;
    459. 

  459. ./src/tbox/xmake.lua:43: note: unknown package value &#39;sqlite3&#39;
    460. 

  460. 8 notes, 1 warnings, 0 errors
    461. 

  461. </code></pre>
    462. 

  462. <h4 id="api">检测指定的 API</h4>
    463. 

  463. <pre><code class="lang-console">$ xmake check api.target.languages
    464. 

  464. ./xmake.lua:15: warning: unknown language value &#39;cxx91&#39;, it may be &#39;cxx98&#39;
    465. 

  465. 0 notes, 1 warnings, 0 errors
    466. 

  466. </code></pre>
    467. 

  467. <h4 id="flags">检测编译 flags</h4>
    468. 

  468. <pre><code class="lang-console">$ xmake check
    469. 

  469. ./xmake.lua:10: warning: clang: unknown c compiler flag &#39;-Ox&#39;
    470. 

  470. 0 notes, 1 warnings, 0 errors
    471. 

  471. </code></pre>
    472. 

  472. <h4 id="includedirs">检测 includedirs</h4>
    473. 

  473. <p>除了 includedirs，还有 linkdirs 等路径都会去检测。</p>
    474. 

  474. <pre><code class="lang-console">$ xmake check
    475. 

  475. ./xmake.lua:11: warning: includedir &#39;xxx&#39; not found
    476. 

  476. 0 notes, 1 warnings, 0 errors
    477. 

  477. </code></pre>
    478. 

  478. <h3 id="clangtidy">检测工程代码（clang-tidy）</h3>
    479. 

  479. <h4 id="clangtidy">显示 clang-tidy 检测列表</h4>
    480. 

  480. <pre><code class="lang-console">$ xmake check clang.tidy --list
    481. 

  481. Enabled checks:
    482. 

  482.     clang-analyzer-apiModeling.StdCLibraryFunctions
    483. 

  483.     clang-analyzer-apiModeling.TrustNonnull
    484. 

  484.     clang-analyzer-apiModeling.google.GTest
    485. 

  485.     clang-analyzer-apiModeling.llvm.CastValue
    486. 

  486.     clang-analyzer-apiModeling.llvm.ReturnValue
    487. 

  487.     ...
    488. 

  488. </code></pre>
    489. 

  489. <h4 id="targets">检测所有 targets 中的源码</h4>
    490. 

  490. <pre><code class="lang-console">$ xmake check clang.tidy
    491. 

  491. 1 error generated.
    492. 

  492. Error while processing /private/tmp/test2/src/main.cpp.
    493. 

  493. /tmp/test2/src/main.cpp:1:10: error: &#39;iostr&#39; file not found [clang-diagnostic-error]
    494. 

  494. #include <iostr>
    495. 

  495.          ^~~~~~~
    496. 

  496. Found compiler error(s).
    497. 

  497. error: execv(/usr/local/opt/llvm/bin/clang-tidy -p compile_commands.json /private/tmp/test2/src
    498. 

  498. /main.cpp) failed(1)
    499. 

  499. </code></pre>
    500. 

  500. <h4 id="">指定检测类型</h4>
    501. 

  501. <p>我们可以在 <code>--check=</code> 中指定需要检测的类型，具体用法可以参考 <code>clang-tidy</code> 的 <code>--check=</code> 参数，完全一致的。</p>
    502. 

  502. <pre><code class="lang-console">$ xmake check clang.tidy --checks="*"
    503. 

  503. 6 warnings and 1 error generated.
    504. 

  504. Error while processing /private/tmp/test2/src/main.cpp.
    505. 

  505. /tmp/test2/src/main.cpp:1:10: error: &#39;iostr&#39; file not found [clang-diagnostic-error]
    506. 

  506. #include <iostr>
    507. 

  507.          ^~~~~~~
    508. 

  508. /tmp/test2/src/main.cpp:3:1: warning: do not use namespace using-directives; use using-declarat
    509. 

  509. ions instead [google-build-using-namespace]
    510. 

  510. using namespace std;
    511. 

  511. ^
    512. 

  512. /tmp/test2/src/main.cpp:3:17: warning: declaration must be declared within the &#39;__llvm_libc&#39; na
    513. 

  513. mespace [llvmlibc-implementation-in-namespace]
    514. 

  514. using namespace std;
    515. 

  515.                 ^
    516. 

  516. /tmp/test2/src/main.cpp:5:5: warning: declaration must be declared within the &#39;__llvm_libc&#39; nam
    517. 

  517. espace [llvmlibc-implementation-in-namespace]
    518. 

  518. int main(int argc, char **argv) {
    519. 

  519.     ^
    520. 

  520. /tmp/test2/src/main.cpp:5:5: warning: use a trailing return type for this function [modernize-u
    521. 

  521. se-trailing-return-type]
    522. 

  522. int main(int argc, char **argv) {
    523. 

  523. ~~~ ^
    524. 

  524. auto                            -> int
    525. 

  525. /tmp/test2/src/main.cpp:5:14: warning: parameter &#39;argc&#39; is unused [misc-unused-parameters]
    526. 

  526. int main(int argc, char **argv) {
    527. 

  527.              ^~~~
    528. 

  528.               /*argc*/
    529. 

  529. /tmp/test2/src/main.cpp:5:27: warning: parameter &#39;argv&#39; is unused [misc-unused-parameters]
    530. 

  530. int main(int argc, char **argv) {
    531. 

  531.                           ^~~~
    532. 

  532.                            /*argv*/
    533. 

  533. Found compiler error(s).
    534. 

  534. error: execv(/usr/local/opt/llvm/bin/clang-tidy --checks=* -p compile_commands.json /private/tm
    535. 

  535. p/test2/src/main.cpp) failed(1)
    536. 

  536. </code></pre>
    537. 

  537. <h4 id="target">检测指定 target 的代码</h4>
    538. 

  538. <pre><code class="lang-console">$ xmake check clang.tidy [targetname]
    539. 

  539. </code></pre>
    540. 

  540. <h4 id="">检测给定的源文件列表</h4>
    541. 

  541. <pre><code class="lang-console">$ xmake check clang.tidy -f src/main.c
    542. 

  542. $ xmake check clang.tidy -f &#39;src/*.c:src/**.cpp&#39;
    543. 

  543. </code></pre>
    544. 

  544. <h4 id="clangtidy">设置 .clang-tidy 配置文件</h4>
    545. 

  545. <pre><code class="lang-console">$ xmake check clang.tidy --configfile=/tmp/.clang-tidy
    546. 

  546. </code></pre>
    547. 

  547. <h4 id="clangtidy">创建 .clang-tidy 配置文件</h4>
    548. 

  548. <pre><code class="lang-console">$ xmake check clang.tidy --checks="*" --create
    549. 

  549. $ cat .clang-tidy
    550. 

  550. ---
    551. 

  551. Checks:          &#39;clang-diagnostic-*,clang-analyzer-*,*&#39;
    552. 

  552. WarningsAsErrors: &#39;&#39;
    553. 

  553. HeaderFilterRegex: &#39;&#39;
    554. 

  554. AnalyzeTemporaryDtors: false
    555. 

  555. FormatStyle:     none
    556. 

  556. User:            ruki
    557. 

  557. CheckOptions:
    558. 

  558.   - key:             readability-suspicious-call-argument.PrefixSimilarAbove
    559. 

  559.     value:           &#39;30&#39;
    560. 

  560.   - key:             cppcoreguidelines-no-malloc.Reallocations
    561. 

  561.     value:           &#39;::realloc&#39;
    562. 

  562. 

  563. </code></pre>
    564. 

  564. <h4 id="">自动修复错误代码</h4>
    565. 

  565. <p>我们可以使用下面的命令参数，自动修复 clang tidy 检测出来的问题代码。</p>
    566. 

  566. <pre><code class="lang-console">$ xmake check clang.tidy --fix
    567. 

  567. $ xmake check clang.tidy --fix_errors
    568. 

  568. $ xmake check clang.tidy --fix_notes
    569. 

  569. </code></pre>
    570. 

  570. <h2 id="xpack">生成安装包 (XPack)</h2>
    571. 

  571. <h3 id="">简介</h3>
    572. 

  572. <p>这个插件可以帮助用户快速生成不同平台的安装包，源码包，它会生成下面一些安装包格式：</p>
    573. 

  573. <ul>
    574. 

  574. <li>Windows NSIS 二进制安装包</li>
    575. 

  575. <li>Windows WIX 二进制安装包</li>
    576. 

  576. <li>runself (shell) 自编译安装包</li>
    577. 

  577. <li>zip/tar.gz 二进制包</li>
    578. 

  578. <li>zip/tar.gz 源码包</li>
    579. 

  579. <li>RPM 二进制安装包</li>
    580. 

  580. <li>SRPM 源码安装包</li>
    581. 

  581. <li>DEB 二进制安装包</li>
    582. 

  582. </ul>
    583. 

  583. <p>下面是一个完整例子，我们可以先简单看下：</p>
    584. 

  584. <pre><code class="lang-lua">set_version("1.0.0")
    585. 

  585. add_rules("mode.debug", "mode.release")
    586. 

  586. 

  587. includes("@builtin/xpack")
    588. 

  588. 

  589. target("test")
    590. 

  590.     set_kind("binary")
    591. 

  591.     add_files("src/*.cpp")
    592. 

  592. 

  593. xpack("test")
    594. 

  594.     set_formats("nsis", "zip", "targz", "runself")
    595. 

  595.     set_title("hello")
    596. 

  596.     set_author("ruki")
    597. 

  597.     set_description("A test installer.")
    598. 

  598.     set_homepage("https://xmake.io")
    599. 

  599.     set_licensefile("LICENSE.md")
    600. 

  600.     add_targets("test")
    601. 

  601.     add_installfiles("src/(assets/*.png)", {prefixdir = "images"})
    602. 

  602.     add_sourcefiles("(src/**)")
    603. 

  603.     set_iconfile("src/assets/xmake.ico")
    604. 

  604. 

  605.     after_installcmd(function (package, batchcmds)
    606. 

  606.         batchcmds:mkdir(package:installdir("resources"))
    607. 

  607.         batchcmds:cp("src/assets/*.txt", package:installdir("resources"), {rootdir = "src"})
    608. 

  608.         batchcmds:mkdir(package:installdir("stub"))
    609. 

  609.     end)
    610. 

  610. 

  611.     after_uninstallcmd(function (package, batchcmds)
    612. 

  612.         batchcmds:rmdir(package:installdir("resources"))
    613. 

  613.         batchcmds:rmdir(package:installdir("stub"))
    614. 

  614.     end)
    615. 

  615. </code></pre>
    616. 

  616. <p>我们通过 <code>includes("@builtin/xpack")</code> 引入 xpack 的所有配置接口，包括 xpack 配置域，以及它的所有域接口。</p>
    617. 

  617. <p>然后我们执行：</p>
    618. 

  618. <pre><code class="lang-bash">$ xmake pack
    619. 

  619. </code></pre>
    620. 

  620. <p>即可生成所有安装包。</p>
    621. 

  621. <h3 id="nsis">生成 NSIS 安装包</h3>
    622. 

  622. <p>只要配置了 <code>set_formats("nsis")</code> 格式，然后执行 <code>xmake pack</code> 命令，就能生成 NSIS 格式的安装包。</p>
    623. 

  623. <p>另外，xmake 还会自动安装生成 NSIS 包所需的工具，实现真正的一键打包。</p>
    624. 

  624. <pre><code class="lang-bash">$ xmake pack
    625. 

  625. note: install or modify (m) these packages (pass -y to skip confirm)?
    626. 

  626. in xmake-repo:
    627. 

  627.   -> nsis 3.09
    628. 

  628. please input: y (y/n/m)
    629. 

  629. 

  630.   => install nsis 3.09 .. ok
    631. 

  631. 

  632. [ 25%]: compiling.release src\main.cpp
    633. 

  633. [ 37%]: compiling.release src\main.cpp
    634. 

  634. [ 50%]: linking.release foo.dll
    635. 

  635. [ 62%]: linking.release test.exe
    636. 

  636. packing build\xpack\test\test-windows-x64-v1.0.0.exe
    637. 

  637. pack ok
    638. 

  638. </code></pre>
    639. 

  639. <p><code>test-windows-x64-v1.0.0.exe</code> 就是我们生成的安装包，双击运行它，就能安装我们的二进制文件到指定目录。</p>
    640. 

  640. <p><img src="/assets/img/manual/nsis_1.png" alt=""><br><img src="/assets/img/manual/nsis_2.png" alt=""><br><img src="/assets/img/manual/nsis_3.png" alt=""></p>
    641. 

  641. <h4 id="">增加组件安装</h4>
    642. 

  642. <p>我们还可以给 NSIS 增加组件安装命令，只有当用户选择指定组件的时候，它的安装命令才会被执行。</p>
    643. 

  643. <pre><code class="lang-lua">xpack("test")
    644. 

  644.     add_components("LongPath")
    645. 

  645. 

  646. xpack_component("LongPath")
    647. 

  647.     set_default(false)
    648. 

  648.     set_title("Enable Long Path")
    649. 

  649.     set_description("Increases the maximum path length limit, up to 32,767 characters (before 256).")
    650. 

  650.     on_installcmd(function (component, batchcmds)
    651. 

  651.         batchcmds:rawcmd("nsis", [[
    652. 

  652.   ${If} $NoAdmin == "false"
    653. 

  653.     ; Enable long path
    654. 

  654.     WriteRegDWORD ${HKLM} "SYSTEM\CurrentControlSet\Control\FileSystem" "LongPathsEnabled" 1
    655. 

  655.   ${EndIf}]])
    656. 

  656.     end)
    657. 

  657. </code></pre>
    658. 

  658. <p>这个例子中，我们在里面添加了一个 NSIS 特有的自定义命令，去实现对长路径的支持。</p>
    659. 

  659. <p><img src="/assets/img/manual/nsis_4.png" alt=""></p>
    660. 

  660. <h3 id="">生成自安装包</h3>
    661. 

  661. <p>我们也可以生成基于 shell 脚本的自编译安装包。我们需要配置 runself 打包格式，然后通过 <code>add_sourcefiles</code> 添加需要参与编译安装的源文件。</p>
    662. 

  662. <p>接着，我们需要自定义 on_installcmd 安装脚本，里面去配置如果编译源码包，我们可以简单的调用一个内置的编译安装脚本文件，也可以直接配置 <code>make install</code> 等编译安装命令。</p>
    663. 

  663. <p>例如：</p>
    664. 

  664. <pre><code class="lang-lua">xpack("test")
    665. 

  665.     set_formats("runself")
    666. 

  666.     add_sourcefiles("(src/**)")
    667. 

  667.     on_installcmd(function (package, batchcmds)
    668. 

  668.         batchcmds:runv("make", {"install"})
    669. 

  669.     end)
    670. 

  670. </code></pre>
    671. 

  671. <p>然后，我们执行 <code>xmake pack</code> 命令，就可以生成一个自安装的 xxx.gz.run 包，默认采用 gzip 压缩。</p>
    672. 

  672. <pre><code class="lang-bash">$ xmake pack
    673. 

  673. packing build/xpack/test/test-macosx-src-v1.0.0.gz.run
    674. 

  674. pack ok
    675. 

  675. </code></pre>
    676. 

  676. <p>我们可以使用 sh 去加载运行它来安装我们的程序。</p>
    677. 

  677. <pre><code class="lang-bash">$ sh ./build/xpack/test/test-macosx-src-v1.0.0.gz.run
    678. 

  678. </code></pre>
    679. 

  679. <p>我们也可以看一个比较完整的例子：</p>
    680. 

  680. <pre><code class="lang-lua">xpack("xmakesrc")
    681. 

  681.     set_formats("runself")
    682. 

  682.     set_basename("xmake-v$(version)")
    683. 

  683.     set_prefixdir("xmake-$(version)")
    684. 

  684.     before_package(function (package)
    685. 

  685.         import("devel.git")
    686. 

  686. 

  687.         local rootdir = path.join(os.tmpfile(package:basename()) .. ".dir", "repo")
    688. 

  688.         if not os.isdir(rootdir) then
    689. 

  689.             os.tryrm(rootdir)
    690. 

  690.             os.cp(path.directory(os.projectdir()), rootdir)
    691. 

  691. 

  692.             git.clean({repodir = rootdir, force = true, all = true})
    693. 

  693.             git.reset({repodir = rootdir, hard = true})
    694. 

  694.             if os.isfile(path.join(rootdir, ".gitmodules")) then
    695. 

  695.                 git.submodule.clean({repodir = rootdir, force = true, all = true})
    696. 

  696.                 git.submodule.reset({repodir = rootdir, hard = true})
    697. 

  697.             end
    698. 

  698.         end
    699. 

  699. 

  700.         local extraconf = {rootdir = rootdir}
    701. 

  701.         package:add("sourcefiles", path.join(rootdir, "core/**|src/pdcurses/**|src/luajit/**|src/tbox/tbox/src/demo/**"), extraconf)
    702. 

  702.         package:add("sourcefiles", path.join(rootdir, "xmake/**"), extraconf)
    703. 

  703.         package:add("sourcefiles", path.join(rootdir, "*.md"), extraconf)
    704. 

  704.         package:add("sourcefiles", path.join(rootdir, "configure"), extraconf)
    705. 

  705.         package:add("sourcefiles", path.join(rootdir, "scripts/*.sh"), extraconf)
    706. 

  706.         package:add("sourcefiles", path.join(rootdir, "scripts/man/**"), extraconf)
    707. 

  707.         package:add("sourcefiles", path.join(rootdir, "scripts/debian/**"), extraconf)
    708. 

  708.         package:add("sourcefiles", path.join(rootdir, "scripts/msys/**"), extraconf)
    709. 

  709.     end)
    710. 

  710. 

  711.     on_installcmd(function (package, batchcmds)
    712. 

  712.         batchcmds:runv("./scripts/get.sh", {"__local__"})
    713. 

  713.     end)
    714. 

  714. </code></pre>
    715. 

  715. <p>它是 xmake 自身源码的安装包配置脚本，更完整的配置可以参考：<a href="https://github.com/xmake-io/xmake/blob/master/core/xpack.lua">xpack.lua</a></p>
    716. 

  716. <p>这里，它通过调用源码包内置的 <code>./scripts/get.sh</code> 安装脚本去执行编译安装。</p>
    717. 

  717. <h3 id="">生成源码归档包</h3>
    718. 

  718. <p>另外，我们也可以配置 <code>srczip</code> 和 <code>srctargz</code> 格式，来生成源码压缩包，它不是完整的安装包，也没有安装命令，仅仅用于源码包分发。</p>
    719. 

  719. <pre><code class="lang-lua">xpack("test")
    720. 

  720.     set_formats("srczip", "srctargz")
    721. 

  721.     add_sourcefiles("(src/**)")
    722. 

  722. </code></pre>
    723. 

  723. <pre><code class="lang-bash">$ xmake pack
    724. 

  724. packing build/xpack/test/test-macosx-src-v1.0.0.zip ..
    725. 

  725. packing build/xpack/test/test-macosx-src-v1.0.0.tar.gz ..
    726. 

  726. pack ok
    727. 

  727. </code></pre>
    728. 

  728. <h3 id="">生成二进制归档包</h3>
    729. 

  729. <p>我们也可以配置 <code>zip</code> 和 <code>targz</code> 来生成二进制的压缩包，它会先自动编译所有绑定的 target 目标程序，将所有需要的二进制程序，库文件打包到 zip/tar.gz 格式。</p>
    730. 

  730. <p>这通常用于制作绿色版的安装包，内部不太任何自动安装脚本，用户需要自己设置 PATH 等环境变量。</p>
    731. 

  731. <pre><code class="lang-lua">xpack("test")
    732. 

  732.     set_formats("zip", "targz")
    733. 

  733.     add_installfiles("(src/**)")
    734. 

  734. </code></pre>
    735. 

  735. <pre><code class="lang-bash">$ xmake pack
    736. 

  736. packing build/xpack/test/test-macosx-v1.0.0.zip ..
    737. 

  737. packing build/xpack/test/test-macosx-v1.0.0.tar.gz ..
    738. 

  738. pack ok
    739. 

  739. </code></pre>
    740. 

  740. <p>!> 需要注意的是，打二进制文件到包里，使用的是 <code>add_installfiles</code> 而不是 <code>add_sourcefiles</code>。</p>
    741. 

  741. <p>我们也可以通过 <code>add_targets</code> 去绑定需要安装的 target 目标程序和库。更多详情见下面关于 <code>add_targets</code> 的接口描述。</p>
    742. 

  742. <h3 id="srpm">生成 SRPM 源码安装包</h3>
    743. 

  743. <p>它可以生成 <code>.src.rpm</code> 格式的源码安装包。</p>
    744. 

  744. <p>我们可以通过配置 add_targets 关联需要构建的目标，在生成的 srpm 包中，它会自动调用 <code>xmake build</code> 和 <code>xmake install</code> 去构建和安装包。</p>
    745. 

  745. <pre><code class="lang-lua">xpack("test")
    746. 

  746.     set_homepage("https://xmake.io")
    747. 

  747.     set_license("Apache-2.0")
    748. 

  748.     set_description("A cross-platform build utility based on Lua.")
    749. 

  749. 

  750.     set_formats("srpm")
    751. 

  751.     add_sourcefiles("(src/**)")
    752. 

  752.     add_sourcefiles("./xmake.lua")
    753. 

  753. 

  754.     add_targets("demo")
    755. 

  755. </code></pre>
    756. 

  756. <p>它会生成类似下面的 spec 文件，然后自动调用 rpmbuild 去生成 <code>.src.rpm</code> 包。</p>
    757. 

  757. <pre><code>Name:       test
    758. 

  758. Version:    1.0.0
    759. 

  759. Release:    1%{?dist}
    760. 

  760. Summary:    hello
    761. 

  761. 

  762. License:    Apache-2.0
    763. 

  763. URL:        https://xmake.io
    764. 

  764. Source0:    test-linux-src-v1.0.0.tar.gz
    765. 

  765. 

  766. BuildRequires: xmake
    767. 

  767. BuildRequires: gcc
    768. 

  768. BuildRequires: gcc-c++
    769. 

  769. 

  770. %description
    771. 

  771. A test installer.
    772. 

  772. 

  773. %prep
    774. 

  774. %autosetup -n test-1.0.0 -p1
    775. 

  775. 

  776. %build
    777. 

  777. xmake build -y test
    778. 

  778. 

  779. %install
    780. 

  780. xmake install -o %{buildroot}/%{_exec_prefix} test
    781. 

  781. cd %{buildroot}
    782. 

  782. find . -type f | sed &#39;s!^\./!/!&#39; > %{_builddir}/_installedfiles.txt
    783. 

  783. 

  784. %check
    785. 

  785. 

  786. %files -f %{_builddir}/_installedfiles.txt
    787. 

  787. 

  788. %changelog
    789. 

  789. * Fri Dec 22 2023 ruki - 1.0.0-1
    790. 

  790. - Update to 1.0.0
    791. 

  791. </code></pre><p>我们也可以通过 <code>on_buildcmd</code> 和 <code>on_installcmd</code> 自定义构建和安装脚本。</p>
    792. 

  792. <pre><code class="lang-lua">xpack("test")
    793. 

  793.     set_homepage("https://xmake.io")
    794. 

  794.     set_license("Apache-2.0")
    795. 

  795.     set_description("A cross-platform build utility based on Lua.")
    796. 

  796. 

  797.     set_formats("srpm")
    798. 

  798.     add_sourcefiles("(src/**)")
    799. 

  799.     add_sourcefiles("./configure")
    800. 

  800. 

  801.     on_buildcmd(function (package, batchcmds)
    802. 

  802.         batchcmds:runv("./configure")
    803. 

  803.         batchcmds:runv("make")
    804. 

  804.     end)
    805. 

  805. 

  806.     on_installcmd(function (package, batchcmds)
    807. 

  807.         batchcmds:runv("make", {"install", "PREFIX=%{buildroot}"})
    808. 

  808.     end)
    809. 

  809. </code></pre>
    810. 

  810. <h3 id="rpm">生成 RPM 二进制安装包</h3>
    811. 

  811. <p>RPM 包将会直接生成编译好的二进制安装包。xmake 会自动调用 <code>rpmbuild --rebuild</code> 命令去构建 SRPM 包生成它。</p>
    812. 

  812. <p>而在 XPack 中，我们仅仅只需要配置 <code>set_formats("rpm")</code> 即可支持 rpm 包生成，其他配置与 srpm 包完全一致。</p>
    813. 

  813. <pre><code class="lang-lua">xpack("test")
    814. 

  814.     set_formats("rpm")
    815. 

  815.     -- TODO
    816. 

  816. </code></pre>
    817. 

  817. <h3 id="">打包命令参数</h3>
    818. 

  818. <h4 id="">指定打包格式</h4>
    819. 

  819. <p>如果我们在配置文件中已经使用 <code>set_formats</code> 配置了多个打包格式，那么默认情况下，<code>xmake pack</code> 会自动生成所有这些格式的包。</p>
    820. 

  820. <p>当然，我们也可以通过 <code>xmake pack --formats=nsis,targz</code> 来选择性指定当前需要打哪些格式的包。</p>
    821. 

  821. <h4 id="">修改打包文件名</h4>
    822. 

  822. <p>我们可以在配置文件中，通过 <code>set_basename()</code> 来修改包名，也可以通过命令行去修改它。</p>
    823. 

  823. <pre><code class="lang-bash">$ xmake pack --basename="foo"
    824. 

  824. packing build/xpack/test/foo.zip ..
    825. 

  825. pack ok
    826. 

  826. </code></pre>
    827. 

  827. <h4 id="">指定输出目录</h4>
    828. 

  828. <p>默认的输出目录是在 build 目录下，但我们也可以修改输出的路径。</p>
    829. 

  829. <pre><code class="lang-bash">$ xmake pack -o /tmp/output
    830. 

  830. </code></pre>
    831. 

  831. <h4 id="">禁用自动构建</h4>
    832. 

  832. <p>如果是打 NSIS 等二进制包，<code>xmake pack</code> 会先自动编译所有被绑定的 target 目标文件，然后再去执行打包逻辑。</p>
    833. 

  833. <p>但是如果我们已经编译过了，不想每次都去编译它，而是直接去打包，可以通过下面的参数禁用自动构建。</p>
    834. 

  834. <pre><code class="lang-bash">$ xmake pack --autobuild=n
    835. 

  835. </code></pre>
    836. 

  836. <h3 id="">接口描述</h3>
    837. 

  837. <p>更多 XPack 打包接口描述见：<a href="https://xmake.io/#/zh-cn/manual/xpack">XPack 打包接口文档</a>。</p>
    838. 

  838. <h2 id="">宏记录和回放</h2>
    839. 

  839. <h3 id="">简介</h3>
    840. 

  840. <p>我们可以通过这个插件，快速记录和回放我们平常频繁使用到的一些xmake操作，来简化我们日常的开发工作。</p>
    841. 

  841. <p>它提供了一些功能：</p>
    842. 

  842. <ul>
    843. 

  843. <li>手动记录和回放多条执行过的xmake命令</li>
    844. 

  844. <li>支持快速的匿名宏创建和回放</li>
    845. 

  845. <li>支持命名宏的长久记录和重用</li>
    846. 

  846. <li>支持宏脚本的批量导入和导出</li>
    847. 

  847. <li>支持宏脚本的删除、显示等管理功能</li>
    848. 

  848. <li>支持自定义高级宏脚本，以及参数配置</li>
    849. 

  849. </ul>
    850. 

  850. <h3 id="">记录操作</h3>
    851. 

  851. <pre><code class="lang-console"># 开始记录宏
    852. 

  852. $ xmake macro --begin
    853. 

  853. 

  854. # 执行一些xmake命令
    855. 

  855. $ xmake f -p android --ndk=/xxx/ndk -a arm64-v8a
    856. 

  856. $ xmake p
    857. 

  857. $ xmake f -p mingw --sdk=/mingwsdk
    858. 

  858. $ xmake p
    859. 

  859. $ xmake f -p linux --sdk=/toolsdk --toolchains=/xxxx/bin
    860. 

  860. $ xmake p
    861. 

  861. $ xmake f -p iphoneos -a armv7
    862. 

  862. $ xmake p
    863. 

  863. $ xmake f -p iphoneos -a arm64
    864. 

  864. $ xmake p
    865. 

  865. $ xmake f -p iphoneos -a armv7s
    866. 

  866. $ xmake p
    867. 

  867. $ xmake f -p iphoneos -a i386
    868. 

  868. $ xmake p
    869. 

  869. $ xmake f -p iphoneos -a x86_64
    870. 

  870. $ xmake p
    871. 

  871. 

  872. # 结束宏记录，这里不设置宏名字，所以记录的是一个匿名宏
    873. 

  873. xmake macro --end
    874. 

  874. </code></pre>
    875. 

  875. <h3 id="">回放</h3>
    876. 

  876. <pre><code class="lang-console"># 回放一个匿名宏
    877. 

  877. $ xmake macro .
    878. 

  878. </code></pre>
    879. 

  879. <h3 id="">命名宏</h3>
    880. 

  880. <p>匿名宏的好处就是快速记录，快速回放，如果需要长久保存，就需要给宏取个名字。</p>
    881. 

  881. <pre><code class="lang-console">$ xmake macro --begin
    882. 

  882. $ ...
    883. 

  883. $ xmake macro --end macroname
    884. 

  884. $ xmake macro macroname
    885. 

  885. </code></pre>
    886. 

  886. <h3 id="">导入导出宏</h3>
    887. 

  887. <p>导入指定的宏脚本或者宏目录：</p>
    888. 

  888. <pre><code class="lang-console">$ xmake macro --import=/xxx/macro.lua macroname
    889. 

  889. $ xmake macro --import=/xxx/macrodir
    890. 

  890. </code></pre>
    891. 

  891. <p>导出指定的宏到脚本或者目录：</p>
    892. 

  892. <pre><code class="lang-console">$ xmake macro --export=/xxx/macro.lua macroname
    893. 

  893. $ xmake macro --export=/xxx/macrodir
    894. 

  894. </code></pre>
    895. 

  895. <h3 id="">列举显示宏</h3>
    896. 

  896. <p>列举所有<code>xmake</code>内置的宏脚本：</p>
    897. 

  897. <pre><code class="lang-console">$ xmake macro --list
    898. 

  898. </code></pre>
    899. 

  899. <p>显示指定的宏脚本内容：</p>
    900. 

  900. <pre><code class="lang-console">$ xmake macro --show macroname
    901. 

  901. </code></pre>
    902. 

  902. <h3 id="">自定义宏脚本</h3>
    903. 

  903. <p>我们也可以自己编写个宏脚本 <code>macro.lua</code> 然后导入到xmake中去。</p>
    904. 

  904. <pre><code class="lang-lua">function main()
    905. 

  905.     os.exec("xmake f -p android --ndk=/xxx/ndk -a arm64-v8a")
    906. 

  906.     os.exec("xmake p")
    907. 

  907.     os.exec("xmake f -p mingw --sdk=/mingwsdk")
    908. 

  908.     os.exec("xmake p")
    909. 

  909.     os.exec("xmake f -p linux --sdk=/toolsdk --toolchains=/xxxx/bin")
    910. 

  910.     os.exec("xmake p")
    911. 

  911.     os.exec("xmake f -p iphoneos -a armv7")
    912. 

  912.     os.exec("xmake p")
    913. 

  913.     os.exec("xmake f -p iphoneos -a arm64")
    914. 

  914.     os.exec("xmake p")
    915. 

  915.     os.exec("xmake f -p iphoneos -a armv7s")
    916. 

  916.     os.exec("xmake p")
    917. 

  917.     os.exec("xmake f -p iphoneos -a i386")
    918. 

  918.     os.exec("xmake p")
    919. 

  919.     os.exec("xmake f -p iphoneos -a x86_64")
    920. 

  920.     os.exec("xmake p")
    921. 

  921. end
    922. 

  922. </code></pre>
    923. 

  923. <p>导入到xmake，并且定义宏名字：</p>
    924. 

  924. <pre><code class="lang-console">$ xmake macro --import=/xxx/macro.lua [macroname]
    925. 

  925. </code></pre>
    926. 

  926. <p>回放这个宏脚本：</p>
    927. 

  927. <pre><code class="lang-console">$ xmake macro [.|macroname]
    928. 

  928. </code></pre>
    929. 

  929. <h3 id="">内置的宏脚本</h3>
    930. 

  930. <p>XMake 提供了一些内置的宏脚本，来简化我们的日常开发工作。</p>
    931. 

  931. <p>例如，我们可以使用 <code>package</code> 宏来对<code>iphoneos</code>平台的所有架构，一次性批量构建和打包：</p>
    932. 

  932. <pre><code class="lang-console">$ xmake macro package -p iphoneos
    933. 

  933. </code></pre>
    934. 

  934. <h3 id="">高级的宏脚本编写</h3>
    935. 

  935. <p>以上面提到的<code>package</code>宏为例，我们看下其具体代码，里面通过<code>import</code>导入一些扩展模块，实现了复杂的脚本操作。</p>
    936. 

  936. <pre><code class="lang-lua">-- imports
    937. 

  937. import("core.base.option")
    938. 

  938. import("core.project.config")
    939. 

  939. import("core.project.project")
    940. 

  940. import("core.platform.platform")
    941. 

  941. 

  942. -- the options
    943. 

  943. local options =
    944. 

  944. {
    945. 

  945.     {&#39;p&#39;, "plat",       "kv",  os.host(),   "Set the platform."                                    }
    946. 

  946. ,   {&#39;f&#39;, "config",     "kv",  nil,         "Pass the config arguments to \"xmake config\" .."     }
    947. 

  947. ,   {&#39;o&#39;, "outputdir",  "kv",  nil,         "Set the output directory of the package."             }
    948. 

  948. }
    949. 

  949. 

  950. -- package all
    951. 

  951. --
    952. 

  952. -- .e.g
    953. 

  953. -- xmake m package
    954. 

  954. -- xmake m package -f "-m debug"
    955. 

  955. -- xmake m package -p linux
    956. 

  956. -- xmake m package -p iphoneos -f "-m debug --xxx ..." -o /tmp/xxx
    957. 

  957. -- xmake m package -f \"--mode=debug\"
    958. 

  958. --
    959. 

  959. function main(argv)
    960. 

  960. 

  961.     -- parse arguments
    962. 

  962.     local args = option.parse(argv, options, "Package all architectures for the given the platform."
    963. 

  963.                                            , ""
    964. 

  964.                                            , "Usage: xmake macro package [options]")
    965. 

  965. 

  966.     -- package all archs
    967. 

  967.     local plat = args.plat
    968. 

  968.     for _, arch in ipairs(platform.archs(plat)) do
    969. 

  969. 

  970.         -- config it
    971. 

  971.         os.exec("xmake f -p %s -a %s %s -c %s", plat, arch, args.config or "", (option.get("verbose") and "-v" or ""))
    972. 

  972. 

  973.         -- package it
    974. 

  974.         if args.outputdir then
    975. 

  975.             os.exec("xmake p -o %s %s", args.outputdir, (option.get("verbose") and "-v" or ""))
    976. 

  976.         else
    977. 

  977.             os.exec("xmake p %s", (option.get("verbose") and "-v" or ""))
    978. 

  978.         end
    979. 

  979.     end
    980. 

  980. 

  981.     -- package universal for iphoneos, watchos ...
    982. 

  982.     if plat == "iphoneos" or plat == "watchos" then
    983. 

  983. 

  984.         -- load configure
    985. 

  985.         config.load()
    986. 

  986. 

  987.         -- load project
    988. 

  988.         project.load()
    989. 

  989. 

  990.         -- enter the project directory
    991. 

  991.         os.cd(project.directory())
    992. 

  992. 

  993.         -- the outputdir directory
    994. 

  994.         local outputdir = args.outputdir or config.get("buildir")
    995. 

  995. 

  996.         -- package all targets
    997. 

  997.         for _, target in pairs(project.targets()) do
    998. 

  998. 

  999.             -- get all modes
    1000. 

  1000.             local modedirs = os.match(format("%s/%s.pkg/lib/*", outputdir, target:name()), true)
    1001. 

  1001.             for _, modedir in ipairs(modedirs) do
    1002. 

  1002. 

  1003.                 -- get mode
    1004. 

  1004.                 local mode = path.basename(modedir)
    1005. 

  1005. 

  1006.                 -- make lipo arguments
    1007. 

  1007.                 local lipoargs = nil
    1008. 

  1008.                 for _, arch in ipairs(platform.archs(plat)) do
    1009. 

  1009.                     local archfile = format("%s/%s.pkg/lib/%s/%s/%s/%s", outputdir, target:name(), mode, plat, arch, path.filename(target:targetfile()))
    1010. 

  1010.                     if os.isfile(archfile) then
    1011. 

  1011.                         lipoargs = format("%s -arch %s %s", lipoargs or "", arch, archfile)
    1012. 

  1012.                     end
    1013. 

  1013.                 end
    1014. 

  1014.                 if lipoargs then
    1015. 

  1015. 

  1016.                     -- make full lipo arguments
    1017. 

  1017.                     lipoargs = format("-create %s -output %s/%s.pkg/lib/%s/%s/universal/%s", lipoargs, outputdir, target:name(), mode, plat, path.filename(target:targetfile()))
    1018. 

  1018. 

  1019.                     -- make universal directory
    1020. 

  1020.                     os.mkdir(format("%s/%s.pkg/lib/%s/%s/universal", outputdir, target:name(), mode, plat))
    1021. 

  1021. 

  1022.                     -- package all archs
    1023. 

  1023.                     os.execv("xmake", {"l", "lipo", lipoargs})
    1024. 

  1024.                 end
    1025. 

  1025.             end
    1026. 

  1026.         end
    1027. 

  1027.     end
    1028. 

  1028. end
    1029. 

  1029. </code></pre>
    1030. 

  1030. <p>!> 如果你想要获取更多宏参数选项信息，请运行： <code>xmake macro --help</code></p>
    1031. 

  1031. <h2 id="doxygen">生成doxygen文档</h2>
    1032. 

  1032. <p>请先确保本机已安装<code>doxygen</code>工具，然后在工程目录下运行：</p>
    1033. 

  1033. <pre><code class="lang-console">$ xmake doxygen
    1034. 

  1034. </code></pre>
    1035. 

  1035. </article>
    1036. 

  1036. </body>
    1037. 

  1037. </html>
    1038.