// src/config.json
target : {
    "web"       : "js",
    "mac"       : "cpp",
    "windows"   : "cpp",
    "linux"     : "cpp",
    "android"   : "cpp",
    "ios"       : "cpp",
    "tvos"      : "cpp",
    "neko"      : "neko"
}

#if desktop
  desktop_code();
#else
  other_code();
#end

{
  project : {

    /**
    项目的显示名称, 对于 mobile 目标,将显示为菜单标题

    @type String
    @required 表示为必须提供这个参数
    */
    name : 'empty',

    /**
    版本号, 和 haxelib 版本无关.使用 "major.minor.patch"

    @type String
    @required
    */
    version : '1.0.0',

    /**
    项目的作者/所属人/管理者, 可以为任意字母和数字的字符串

    @type String
    */
    author : 'luxeengine',

    // {}
    app : {

      /**
      应用的二进制文件名称,不能包括特殊字符(需要符合系统文件名称规范)

      @type String
      @default "flow_app"
      */
      name : 'flow_app',

      /**
      bundle/package/app的标识符, 不能包括特殊字符和空格. 你应该更改这个属性

      @type String
      @default "org.snowkit.flow_app"
      */
      package : 'org.snowkit.flow_app'

      /**
      指定输出文件夹名称

      @type String
      @default "bin"
      */
      output : 'bin/'


      /**
      指定haxe的主类,不需要写 ".hx" 扩展名

      @type String
      @default "Main"
      */
      main : 'Main',

      /**
      指定源码所在目录, 等同于 haxe 的 `-cp` 参数所指定的目录

      @type Array<String>
      @default "src"
      */
      codepaths: ['src'],

      /**
      指定 icons 的文件位置. (TODO:文档描述的不明确,只参看了 luxe项目的 luxe.flow 文件)

      当值仅为 path 时, 这时假定图标的名称为 "icon" , 相当于 path => icon

      当值为 path => name时, 将使用指定的 name 作为图标名称,

      path 将相对于 project.flow 的文件所在位置

      文件目录示例参考: `flow/src/flow/cmd/icons/default`

      @type String
      @default 将使用flow内部的图标集,即上边示例
      */
      icon: 'path/to/ => icon',


      // node, 很明显这个节点用于 html5形式的 app.
      web : {

        /**
        这些名称将传递到模板中去.

        libname: 给定库名称
        path: 相对于 output 指定的目录, 可以为绝对路径如 http://
        @type node of keys {libname: 'path'}
        */
        libs : {
          jquery: "js/jquery.js",
          index: "index.js"
        }
      },

      // node, 用于 mobile 目标
      mobile : {

          /**
          if device fullscreen is used.

          @type Bool
          @default true
          */
          fullsceen: true,

          /**
          横屏(landscape)竖屏(portrait)

          可用值为: "landscape","landscape left","landscape both","portrait","portrait upside down","portrait both"

          @type String
          @default "landscape"
          */
          orientation: "landscape",

          //node
          ios : {

            /**
            在 xcode 中指定设备类型

            有效值为: "Universal","iPhone","iPad"
            @type String
            @default "Universal"
            */
            devices: "Universal",

            /**
            指定 ios 的最低版本

            @type String
            @default "6.0"
            */
            deployment_target: "6.0",

            /**
            xcode 工具包名用于cpp, 不需要更改,除非框架需求, 允许框架开发者定制 cpp 库,

            @type String
            default "libc++"
            */
            cpp: "libc++"
            		  },

          //node
          android : {
            /**
            debug/store 编译标记,可用值为: "store","debug"

            @type String
            @default "debug"
            */
            build_type: "debug",

            /**
            installLocation in android manifest:
            http://developer.android.com/guide/topics/manifest/manifest-element.html#install

            @type String
            @default "preferExternal"
            */
            install_location: "preferExternal",

            /**
            sdk min in android manifest:
            http://developer.android.com/guide/topics/manifest/uses-sdk-element.html

            @type String
            @default "10"
            */
            sdk_min: "10",

            /**
            sdk target in android manifest:
            http://developer.android.com/guide/topics/manifest/uses-sdk-element.html

            通常设置为可用的最高.

            @type String
            @default "19"
            */
            sdk_target: "19",

            /**
            android manifest permissions:
            http://developer.android.com/reference/android/Manifest.permission.html

            @type Array<String>
            @default []
            */
            permissions: [
              'android.permission.READ_EXTERNAL_STORAGE',
              'android.permission.INTERNET'
            ]
          }
      }
    },

    build : {
      /**
      haxe 编译标记, 将直接传递给 haxe.exe

      @type Array<String>
      @default []
      */
      flags : ['-v', '--macro keep(example)'],


      /**
      自定义 haxe defines, 通过`-D define` 形式传递给 haxe.exe

      @type Array<String>
      @default []
      */
      defines : ['no_sfx', 'no_music'],

      /**
      key/value 形式的hash列表. 指定 haxelib
      key 应该为 haxelib list 中列出的库, version 为 "*" 时表示为当前版本, 或者指定成 "1.0.0" 的形式.

      被依赖的库将会优先读取 .flow 文件, 如果不存在则读取 haxelib.json 文件分析内部的依赖
      @type {}, i.e. {depend: "version"}
      @default {}
      */
      dependencies : {
        hxnodejs : '*'
      },

      /**
      位于 project/build下的files,将复制文件到 output/target.build/ 下, 其它参考 project/files 的说明

      i.e bin/web.build/

      web.build目录和web目录的区别是: web.build 是存放haxe源码的,而web目录则为最终生成结果的目录
      */
      files:{
      }
    },


    /**
    位于 project 下的 files,将复制文件到 output/target/ 例: bin/web/
    位于 project/build/下的files 则复制文件到 output/target.build/ 例: bin/web.build/

    基本格式为: {filereference: "path/source.ext => dest/path/dest.ext"}, 注意 "=>" 符号

    source: 源文件位置, 相对于 project.flow 文件
    dest: 目标位置, 相对于目标文件夹
      - 将被创建, 包括目录, 可以被覆盖重写(后边描述如何禁止覆盖)
      - 部分为可选, 这时将表现为 `name: "source => source"`

    @type {}
    @default {}
    */
    files : {
      data : 'data/ => assets/',
      // 带有 not_listed 参数
      howlerjs : { path:'flow/web/lib/howler.min.js => lib/howler.js', not_listed:true }
      /**
      如需通过模板生成, 则写成这种形式, 模板使用 [handlebars](http://handlebarsjs.com/)
      */
      config : {
          /**
          @type String
          */
          path: 'config.template.json => config.json',
          /**
          指定的值为 flow文件的根节点(除了if节点),这些节点和自定义节点可以作为模板参数传递
          @type Array<String>|String
          */
          template:['project']
      },
          // example
          boot : { path:'flow/boot/SnowApp.hx => haxe/SnowApp.hx', template:['project', 'snow'] }
    }
  },
  if : {
    ...
  }
}