haxelib run hxcpp Build.xml -Dios

# TODO
@:abi                   # Function ABI/calling convention

# 嵌入 xml 到 build.xml, 文件格式参看下边 buildXml
@:buildXml              # Specify xml data to be injected into Build.xml

# 附加于 类 上. 代码注入于 namespace 的前边
@:cppFileCode           # Inject code into top of cpp file

# 附加于 类 上.. 在 .cpp 文件中头部添加　头文件引用, 注意: 只能添加一个
# 示例: @:cppInclude("stdlib.h") => #include "stdlib.h"
@:cppInclude            # File to be included in generated cpp file

# 附加于 类 上. 代码注入于 类 的前边.并包含当前类. 命名空间为 haxe 包名.
@:cppNamespaceCode      #

# __declspec 参看 hxcpp/include/hxcpp.h
@:decl                  #

# 注入代码到 函数开始处
@:functionCode          # Inject code into top of function - eg, whole implementation.

# 注入代码到 函数结尾处, 在 return 之前. 
# 注: 由于 haxe 转换成的 cpp 用 {} 包围形成了闭包, 因此无法访问函数内部定义的局部变量, 但是可以访问函数的参数
@:functionTailCode      # Inject code into end of function 

# 注入 cpp 代码到 头文件(.h) Class 的内部 - 用于声明　成员变量或成员方法 例如: @:headerClassCode("int a,b")
@:headerClassCode       # Code to be injected into the generated class, in the header

# 注入 cpp 代码到 头文件(.h) Class 的外部 - 用于 添加 头文件引用或 宏定义 例如: @:headerCode("#include <stdio.h>")
@:headerCode()          # Code to be injected into the generated header file

# 附加在 class 上, 在 头文件(.h) 中 注入 例如: @headerInclude("stdio.h") - 只能添加一个头文件
@:headerInclude(String) # File to be included in generated header file

@:headerNamespaceCode   # 头文件类声明, 类 的外部　命名空间内部

# @:include("path/file.h") - 用于 extern 类, 指示 这个类应该导入哪个 头文件　和 @:sourceFile 一起使用
@:include               # Generate "#include ..." to .h/.cpp where the class is being imported.

# TODO
@:nativeProperty        # Use native properties which will execute even with dynamic usage

# 编译的cpp代码中不包含有类似于 HX_STACK_LINE...这些调试用的代码, 只用于字段或方法(但是好像无法作用于构造函数),
@:noStack               # 

@:nonVirtual            # Declares function to be non-virtual in cpp (cpp only)

# @:sourceFile("path/file.cpp") - 用于 external class,路径以当前 hx 文件所在为当前目录,参考 hxcpp/test/native 目录
@:sourceFile            # Source code filename for external class

# 重要: 用于 extern 类, 
@:structAccess          # Marks an extern class as using struct access('.') not pointer('->')

# 如果你不需要使用 Reflect 来动态查找类上的成员, 则可以加上这个标记
@:unreflective          # not generate __Field and __SetField bodies by default

@:void                  # Use Cpp native 'void' return type (cpp only)

# 文件依赖, 也就是当依赖的文件发生过改动,将重将编译.
# 附加在 extern 类上, 哪个类调用了这个 extern 类, 就会在 build.xml 中相关 cpp 新增一条 <depend name="file.h" />
@:depend                # Add a dependency in the build.xml file.

<set name="var1" value="v1" if="D1" />          <!-- 如果 D1 存在, 则设置 var1=v1 -->
<set name="var2" value="v2" if="D1 D2" />       <!-- 如果 D1 与 D2 定义同时存在, ... -->
<set name="var3" value="v3" if="D1 || D2" />    <!-- 如果 D1 或 D2 定义存在, ... -->

<echo value="hello" unless="D1" />      <!-- 只有当 D1 不存在时, 才打印 hello , 支持:或(||),与(" ") -->
<echo value="world" ifExists="path/to/file" />  <!-- 检测文件或目录存在 -->
<echo value="${var1}" />
<echo value="hello ${var1}" />
<set name="" value="" />        <!-- 设置变量 name=value, 在其它元素中通过 ${name} 来引用 value 的值　-->
                                <!-- 可用于变量条件检测, 示例 -->
    <set name="someMsg" value="Hello world!" />
    <echo value="${someMsg}" if="someMsg" />                                

<unset name="" />               <!-- 移除变量 或 haxe -D -->

<!-- hxcpp编译设置, 细节查看 Setup.hx -->
<setup name="androidNdk|blackberry|msvc|mingw|emscripten" />                

<echo value="" />               <!-- log -->
<error value="" />              <!-- error, 将中断编译 -->

<setevn name="" value="" />     <!-- 设置环境变量, 通过 Sys.putEnv 阶段性(session)  -->

<path name="" />                <!-- 设置环境路径, 通过 Sys.putEnv("PATH",) 阶段性(session)  -->

<include name="path/to/file.xml" />     <!-- 导入另一个 xml, 覆盖到当前 -->

<!-- copyFile, 当你需要复制 文件 到输出文件夹(target.outputDir)时 -->
  <!-- name: 要复制的文件名,可以是任意文件 -->
  <!-- form: 从哪个目录 -->
  <!-- [toolId]: 可选, 所选择 编译工具的 id 值, 某个 linker 元素的 id 值   -->
  <!-- [allowMissing]: 是否允许缺失, 值为 1|t|true 时为真, 其它为假 -->
<copyFile name="libstdc++-6.dll" from="${MINGW_ROOT}/bin" toolId="exe" allowMissing="true" unless="no_shared_libs" />

<section if="Some"></section>           <!-- 所有条件相同的元素集合, 用于避免给每个元素加上同样的条件检测 -->


<pleaseUpdateHxcppTool version="1" />   <!-- Int类型. 如果 hxcpp.n 小于某个版本,将出错误. 这个值似乎很久没用了 -->

<!-- 文件组,id 为文件组标识符, 用于被其它元素引用, 同 id 的文件组, 后边的将覆盖前边的  -->
<files id="__main__">                                                       
  <compilerflag value="-Iinclude" />    <!-- 文件分组编译参数 -->
  <file name="src/__main__.cpp" />      <!-- 分组内的文件 -->
    <depend name="include/Main.h" />    <!-- 所依剌的头文件,位于 file 元素内部只能有 name 属性  -->
    <depend name="include/other.h" />
  </file>

  <depend name="path/file.h" />         <!-- 依赖另一个文件,　注意 depend 属性要么是 name 或 files -->
  <depend files="id" />                 <!-- 依赖另一个文件组内的所有 depend.has.name 元素  -->

  <!-- TODO:  fxc.exe /nologo /T %profile% %file% /Vn %variable% /Fh %target% -->
  <hlsl name="path/tofile.fx" profile="" variable="" target="" />   

  <options name="Options.txt"/>         <!-- TODO: 不明确,反正都是 Options.txt -->
  <precompiledheader name="" dir="" />  <!-- 预编译头文件,name:文件名, dir:目录  -->

  <include name="path/to/file.xml" />   <!-- 导入另一个 xml, 覆盖到当前 -->
  <section></section>
</files>

<!-- 编译, 将源码编译为中间文件时用到 -->
  <!-- id: 名称标识符 -->
  <!-- exe: 编译器命令名, 如 gcc, cl.exe ... -->
<compiler id="android-gcc" exe="g++">
 <exe name="${EXEPREFIX}-g++" if="" />  <!-- 同上,一般写在这里的会有条件检测, 如果重复将覆盖前边设置 -->
 <flag value="" />                      <!-- 编译器参数,用于所有 .c .cpp .m .mm -->
 <flag value="-Dsome=value" />
 <flag value="-I${HXCPP}/include" />

 <cflag value="" />             <!-- 仅用于 .c 的编译参数 -->
 <cppflag value="" />           <!-- 仅用于 .cpp 或 .c++ 的编译参数 -->
 <objcflag value="" />          <!-- 仅用于 .m(object-c) 的编译参数 -->
 <mmflag value="" />            <!-- 仅用于 .mm(object-c++) 的编译参数 -->
 <pchflag value="" />           <!-- 仅用于 .pch(预编译头文件) 的编译参数 -->

 <objdir value="" />            <!-- 输出文件夹目录, 默认为 obj -->
 <outflag value="" />           <!-- 输出　编译标记, 通常为 -o 或 --output -->
 <pch value="" />               <!-- TODO: 未知 - if(pch == "gcc"){...} -->
 <getversion value="some.exe" /><!-- TODO: 一个输出一些字符到 stderr　的工具命令,输出的字符将通过 md5 计算  -->
 <ext value="" />               <!-- 输出　扩展名, 默认为 .o -->
 <include name="" />            <!-- 导入另一个 xml, 覆盖到当前 -->
 <section unless=""></section>  
</compiler>


<!-- strip 是一个去除编译生成的调试内容工具 -->
  <!-- id: 名称标识符 -->
  <!-- exe: strip 工具命令 -->
<stripper id="strip" exe="strip" unless="nostrip">
  <exe name="strip"/>               <!-- 执行 strip 命令名称 -->
  <exe name="arm-none-linux-gnueabi-strip" if="webos" />
  <exe name="${EXEPREFIX}-strip" if="EXEPREFIX" />
  <exe name="${HXCPP_STRIP}" if="HXCPP_STRIP" />
  <exe name="mipsel-linux-strip" if="gcw0" />

  <flag value="-u" if="macos"/>     <!-- strip 命令参数 -->
  <flag value="-r" if="macos"/>
  <flag value="-x" if="macos"/>
  <flag value="-d" if="linux"/>
</stripper>



<!-- 链接器 -->
   <!-- id: 链接器标识符 -->
   <!-- exe: 链接器命令名称 -->
<linker id="dll" exe="link.exe" if="windows">
  <exe name="" if="" />             <!-- 链接器命令名称 -->
  <flag value="-nologo"/>           <!-- linker 命令行参数 -->

  <lib name="libm.so" if="demo" />  <!-- 依赖的链接库 -->
  <lib name="-llog" if="demo"/>
  <lib name="${dll_import_link}" if="dll_import_link" />    

  <libdir name="obj/lib" />         <!-- 依赖的链接库的文件夹 -->

  <fromfile value="@" />            <!-- 如果为 @,所有.obj　将以清单的形式写入到 all_objs. 默认为 @ -->
                                    <!-- windows 需要这个 @ 符号 -->

  <ext value=".dll" />              <!-- 输出扩展名, .exe,.dll,"",.so -->
  <outflag value="-out:" />         <!-- 输出参数: windows通常是 -out:,而非windows通常为 -o -->

  <prefix value="" />           <!-- 输出文件名前缀 -->  
  <ranlib name="" />            <!-- 命令工具,用于更新静态库的符号索引表,似乎只适用于 gcc 编译器 -->
  <recreate value="1" />        <!-- 是否删除输出重新建立, 留空为 false,否则为 true.  -->
  <expandAr value="" />         <!-- 解开 .a 库文件为多个 .o, 留空为 false,否则为 true.-->
  <section></section>
</linker>

<!-- linker 示例 -->
<linker id="exe" exe="link.exe" unless="winrt"> 
  <fromfile value="@"/>
  <flag value="-nologo"/>
  <flag value="-machine:${MACHINE}"/>
  <flag value="-debug" if="HXCPP_DEBUG_LINK"/>
  <flag value="-subsystem:windows${SUBSYSTEM_VER}" if="SUBSYSTEMWINDOWS" />
  <flag value="-subsystem:console${SUBSYSTEM_VER}" if="SUBSYSTEMCONSOLE" />
  <flag value="-libpath:lib"/>
  <flag value="user32.lib"/>
  <ext value=".exe"/>
  <outflag value="-out:"/>
</linker>

<!-- 预链接器, 似乎根本没使用过这个. 子元素参考 linker -->
<prelinker id="" exe="">        
  <exe name="" />               
  <flag value="" />     
  <outflag value="" />          
  <expandAr value="" />         
  <fromfile value="" />
  <section></section>
</prelinker>

<!-- 目标, 所属的一些元素将覆盖 linker 的设定,所以通过 target 元素来修改或增加 linker 的设定 -->
  <!-- id: 标识符, 可以被其它 target 元素当子模块引用, 如果是主 target,请设值为 "default" -->
  <!-- tool: 只有 "linker"" 这一个值,   -->
  <!-- toolid: id值用于链接器选择, 编译顺序将从 prelinker 到 linker  -->
  <!-- output:  输出文件名,不带扩展名.-->
  <!-- overwrite: 重写, 自已看源码定义 -->
<target id="msvccompat" output="" tool="linker" toolid="${STD_MODULE_LINK}" >
  <target id="" />              <!-- 子模块, 指定 id 值就行了 -->
  <lib name="some.lib" />       <!-- 库名, [将覆盖加到 linker] -->
  <flag value="" />             <!-- 编译参数,[将覆盖加到 linker]  -->
  <depend name="" />            <!-- 文件依赖,将检测这些文件是否发生改动来决定是否重新编译 -->
  <dir name="" />               <!-- (好像没用), 当调用 target.clean 时被将删除的目录 -->
  <outdir name="path/to/" />    <!-- 最终输出文件存放目录 -->
  <builddir name="" />          <!-- 设置编译时的当前目录, 目录必须存在. 之后所有相对目录以这个为基准 -->
  <ext value="" />              <!-- 输出扩展名, 如果指定将覆盖 linker 的设定 --> 
  <files id="__main__" />       <!-- 选择需要编译的文件分组, 不同 id 表示不同分组 -->
  <section></section>
</target>

<!-- 最后建议参考 hxcpp/toolchain/haxe-target.xml -->