TBOOX开源工程

• 插件使用之批量打包

  2016-06-09

  xmake

  xmake  插件  宏脚本  打包

  xmake提供了一些比较实用的内置宏脚本，比如 批量打包宏脚本 xmake macro package

  这个宏脚本可以批量打包指定平台的所有架构，例如：

      # 批量打包当前平台的所有架构
      xmake macro package 
  
      # 批量打包iphoneos平台的所有架构
      xmake macro package -p iphoneos
  
      # 批量打包iphoneos平台的所有架构，并且传入"-m debug"给 `xmake config` 进行打包debug版本，包输出到/tmp/output目录
      xmake macro package -p iphoneos -f "-m debug" -o /tmp/output
  

  这个打包宏针对iphoneos平台，还会自动将所有arch的包打成一个universal包。

  针对这个宏的详细使用说明，可以参看：xmake macro package --help

  阅读全文

  ---

• 插件开发之hello xmake

  2016-06-09

  xmake

  xmake  插件  hello  makefile  doxygen  宏脚本

  xmake从v2.0开始，全面支持插件模式，我们可以很方便的扩展实现自己的插件，并且xmake也提供了一些内建的使用插件

  我们可以执行下 xmake -h 看下当前支持的插件：

      Plugins: 
          l, lua                                 Run the lua script.
          m, macro                               Run the given macro.
             doxygen                             Generate the doxygen document.
             hello                               Hello xmake!
             project                             Create the project file.
  

  • lua: 运行lua脚本的插件
  • macro: 这个很实用，宏脚本插件，可以手动录制多条xmake命令并且回放，也可以通过脚本实现一些复杂的宏脚本，这个我们后续会更加详细的介绍
  • doxygen：一键生成doxygen文档的插件
  • hello: 插件demo，仅仅显示一句话：’hello xmake!’
  • project： 生成工程文件的插件，目前仅支持(makefile)，后续还会支持(vs,xcode等工程)的生成
  阅读全文

  ---

• 插件开发之参数配置

  2016-06-09

  xmake

  xmake  插件  菜单选项

  我们继续以之前讲解的hello插件为基础，现在为其增加参数配置选项，并且指定一个独立的脚本文件中进行开发，这样我们就可以写一些更复杂的插件

      -- 定义一个名叫hello的插件任务
      task("hello")
  
          -- 设置类型为插件
          set_category("plugin")
  
          -- 插件运行的入口，这里指定main，说明从当前插件目录的main.lua脚本中加载插件入口
          on_run("main")
  
          -- 设置插件的命令行选项，这里没有任何参数选项，仅仅显示插件描述
          set_menu({
                          -- usage
                          usage = "xmake hello [options]"
  
                          -- description
                      ,   description = "Hello xmake!"
  
                          -- 定义两个参数选项
                          -- xmake hello --output="xxx" 指定输出的内容
                          -- xmake hello -v 显示插件版本
                      ,   options = 
                          {
                              -- 第一个值设置简写：xmake hello -o xxx
                              -- 第二个值设置全称：xmake hello --output=xxx
                              -- 第三个值设置类型：kv是键值对，k是仅有key没有值(-v --version)，v是值类型没有key
                              -- 第四个值指定参数描述信息
                              {'o', "output",     "kv", nil,      "Set the output content."  }
                          ,   {'v', "version",    "k",  "1.0",    "Show the version."        }
                          }
                      }) 
  

  这个插件的文件结构如下：

      hello
       - xmake.lua
       - main.lua
  

  xmake.lua为插件的描述文件，指定一些描述信息，main.lua为插件运行入口，代码如下：

      -- 导入选项模块
      import("core.base.option")
  
      -- main.lua入口函数
      function main()
       
          -- 显示版本？
          if option.get("version") then
              print("version: %s", option.get("version"))
          else
              -- 显示内容
              print("hello %s!", option.get("output") or "xmake")
          end
      end
  

  到此一个稍微高级些插件就完成了，我们只需要执行：

      xmake hello --version
      xmake hello -v
  

  来显示版本，执行：

      xmake hello -o xxx
      xmake hello --output=xxx
  

  来显示内容，或者执行：

      xmake hello -h
      xmake hello --help
  

  来显示菜单，这个选项是内置的，不需要自定义

  其中，我们用到了import这个api，这个api主要用于导入一些扩展的类库，实现一些高级的功能

  并且还可以导入一些自定义的模块，例如我想在当前这个插件目录下新增一个模块 echo 用于回显信息，可以在hello目录下增加一个脚本文件：

      hello
       - xmake.lua
       - main.lua
       - echo.lua
  

  echo.lua的内容如下：

      -- 增加一个显示信息的接口show
      function show(info)
          print(info)
      end
  

  然后在main.lua里面导入这个模块就可以使用了：

      -- 导入选项模块
      import("core.project.option")
  
      -- 导入当前插件目录下echo模块
      import("echo")
  
      -- main.lua入口函数
      function main()
       
          -- 使用echo模块来显示
          if option.get("version") then
              echo.show("version: %s", option.get("version"))
          else
              -- 显示内容
              echo.show("hello %s!", option.get("output") or "xmake")
          end
      end
  

  怎么样，简单吧import后，就可以直接使用这个模块的所有公有接口，像show就是被导出的公有接口

  如果一些接口是私有的不想被导出怎么办呢，只需要加上 _ 前缀就行了，例如：

      -- 私有接口
      function _print(info)
          print(info)
          print(_g.info)
      end
  
      -- 公有接口
      function show(info)
          _print(info)
          _g.info = info
      end
  

  注：其中_g是全局私有变量，用于模块内部全局私有数据的维护和传递

  阅读全文

  ---

• 高级特性之自定义task任务

  2016-06-09

  xmake

  xmake  task  自定义脚本  插件

  task是xmake 2.0开始新增的特性，也是插件开发的核心，在 插件开发之hello xmake 中我们简单介绍了下task的定义和使用

  当然task不仅可以用来写插件，而且还可以写一些简单的自定义任务。。

  我们先看下一个简单task实现：

      -- 定义一个名叫hello的task任务
      task("hello")
  
          -- task运行的入口
          on_run(function ()
  
              -- 显示hello xmake!
              print("hello xmake!")
  
          end)
  

  这是一个最简单的task，相比插件task，它少了对 set_menu 的设置，当然你也可以加上，好、这样就个可以在命令行中调用它。。

  阅读全文

  ---

• 高级特性之自定义脚本使用

  2016-06-09

  xmake

  xmake  自定义脚本  安装  打包  android  apk  jni

  xmake提供了自定义打包、安装、运行脚本，可以更加灵活的针对个人实际需求来操作xmake

  这里用一个例子详细说明下，比如有个需求，我需要自动编译、安装、运行android app工程，并且能够支持jni 可以进行如下操作

  首先创建个基于ant的android app工程，目录结构如下：

  阅读全文

  ---