TBOOX开源工程

• TBOOX开源工程2019总结和明年规划

  2019-12-31

  tboox

  tboox  tbox  xmake

  今年一年总体还是有不少收获的，尤其是xmake，今年大部分时间都花在这个项目上面，总共发了5个大版本，大小特性改动不下百处，新增1000多次commit，处理issues超过300个。

  不过tbox也陆陆续续做了一些更新，还是有不少改进的地方。

  关于今年整体的项目进展，这边也做个简单的总结吧，这里主要总结一些比较大的特性改进，一些零散的小模块改动就不一一列举了。

  完成了远程包依赖管理

  这也是是今年最大的收获了，毕竟陆陆续续耗时了将近一年时间，虽然还有不少需要改进的地方，自建的包仓库也还不是很丰富，明年我会继续去完善它。

  add_requires("libuv master", "ffmpeg", "zlib 1.20.*")
  add_requires("tbox >1.6.1", {optional = true, debug = true})
  target("test")
      set_kind("binary")
      add_files("src/*.c")
      add_packages("libuv", "ffmpeg", "tbox", "zlib")
  

  

  新增vsxmake生成插件

  新版本xmake重新实现了一个vs工程的生成插件（非常感谢@OpportunityLiu的贡献），跟之前的生成vs的插件处理模式上有很大的不同，原先生成的vs工程是把所有源文件展开后，转交给vs来处理编译。

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

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

  具体使用方式跟老版本类似：

  $ xmake project -k [vsxmake2010|vsxmake2013|vsxmake2015|..] -m "debug;release"
  

  

  上线了新版的文档站点

  由于之前的docute文档站仅支持单页markdown，随着文档的不断增多，维护起来越来越臃肿，因此今年我整体切到了docsify来管理。

  文档站点：https://xmake.io/#/zh-cn/

  阅读全文

  ---

• xmake v2.2.9 发布, 新增c++20 modules的实验性支持

  2019-12-21

  xmake

  xmake  lua  C/C++  c++20  ts-modules

  这个版本没啥太大新特性，主要对c++20 modules进行了实验性支持，目前支持clang/msvc编译器，除此之外改进了不少使用体验，并且提高了一些稳定性。

  另外，这个版本新增了socket.io支持以及对应协程io的调度支持，为下个版本的远程编译，以及后续的分布式编译做准备。

  • 项目源码
  • 官方文档

  新特性介绍

  c++20 modules

  c++ modules已经正式纳入了c++20草案，msvc和clang也已经基本实现了对modules-ts的支持，随着c++20的脚步离我们越来越近，xmake也开始对c++modules提前做好了支持。

  目前xmake已经完全支持了msvc/clang的modules-ts构建实现，而对于gcc，由于它的cxx-modules分支还在开发中，还没有正式进入master，我看了下里面的changelog，相关flags还在不断变动，感觉还没稳定下来，因此这里暂时还没对其进行支持。

  关于xmake对c++modules的相关进展见：https://github.com/xmake-io/xmake/pull/569

  Hello Module

  关于c++modules的相关介绍我就不多说了，这边主要还是介绍下xmake下如何去构建c++modules项目，我们先来看一个简单的例子：

  target("hello")
      set_kind("binary")
      add_files("src/*.cpp", "src/*.mpp") 
  

  上面是一个支持构建c++modules文件的xmake.lua描述，其中hello.mpp就是模块文件：

  #include <cstdio>
  export module hello;
  using namespace std;
  
  export namespace hello {
      void say(const char* str) {
          printf("%s\n", str);
      }
  }
  

  而main.cpp是使用了hello模块的主程序：

  import hello;
  
  int main() {
      hello::say("hello module!");
      return 0;
  }
  

  接下来我们执行xmake来构建下这个程序吧：

  ruki:hello ruki$ xmake 
  [  0%]: ccache compiling.release src/hello.mpp
  [ 50%]: ccache compiling.release src/main.cpp
  [100%]: linking.release hello
  build ok!
  

  Read English 阅读全文

  ---

• xmake从入门到精通10：多个子工程目标的依赖配置

  2019-12-13

  xmake

  xmake  lua  交叉编译

  xmake是一个基于Lua的轻量级现代化c/c++的项目构建工具，主要特点是：语法简单易上手，提供更加可读的项目维护，实现跨平台行为一致的构建体验。

  本文主要详细讲解下，如果在一个项目中维护和生成多个目标文件的生成，以及它们之间的依赖关系设置。

  • 项目源码
  • 官方文档

  target到底是什么？

  xmake的概念定义里，一个独立的项目工程可能会有多个子工程组织在一起，每个子工程对应只能生成一个唯一的目标文件，例如：可执行程序，静态库或者动态库等。

  而这里所说的每个子工程就是xmake里面所说的target，字面意思就是目标子工程。

  因此每个子工程，我们都可以通过新增一个target在xmake.lua里面维护，例如：

  target("test1")
      set_kind("binary")
      add_files("src/test1/*.c")
      
  target("test2")
      set_kind("binary")
      add_files("src/test2/*.c")    
  

  上面我们就定义了两个独立的子工程目标，编译时候会生成两个互不依赖的可执行文件。

  从根域继承全局设置

  暂时先不谈target间的依赖问题，如果我们有许多通用设置，每个target下都得设置一遍，那会非常冗余，也不好维护。

  因此，我们可以把这些配置移到target域的外面，也就是根作用域中去设置，这样对当前xmake.lua以及所有子xmake.lua中的target都会生效，例如：

  add_links("tbox")
  add_linkdirs("lib")
  add_includedirs("include")
  
  target("test1")
      set_kind("binary")
      add_files("src/test1/*.c")
      
  target("test2")
      set_kind("binary")
      add_files("src/test2/*.c")    
  

  比如这两target都需要链接tbox库，放置在外层根域设置，test1和test2都能加上对应links。

  目标间的依赖设置

  那如果某个target需要用到另外一个tatget生成的静态库，应该怎么配置呢？

  一种方式就是通过add_linkdirs和add_links手动指定对应target最后生成的目录库所在目录，然后把链接加上。

  阅读全文

  ---

• xmake从入门到精通9：交叉编译详解

  2019-12-05

  xmake

  xmake  lua  交叉编译

  xmake是一个基于Lua的轻量级现代化c/c++的项目构建工具，主要特点是：语法简单易上手，提供更加可读的项目维护，实现跨平台行为一致的构建体验。

  除了win, linux, macOS平台，以及android, ios等移动端平台的内建构建支持，xmake也支持对各种其他工具链的交叉编译支持，本文我们将会详细介绍下如何使用xmake进行交叉编译。

  • 项目源码
  • 官方文档

  交叉编译工具链简介

  通常，如果我们需要在当前pc环境编译生成其他设备上才能运行的目标文件时候，就需要通过对应的交叉编译工具链来编译生成它们，比如在win/macos上编译linux的程序，或者在linux上编译其他嵌入式设备的目标文件等。

  通常的交叉编译工具链都是基于gcc/clang的，大都具有类似如下的结构：

  /home/toolchains_sdkdir
     - bin
         - arm-linux-armeabi-gcc
         - arm-linux-armeabi-ld
         - ...
     - lib
         - libxxx.a
     - include
         - xxx.h
  

  每个工具链都有对应的include/lib目录，用于放置一些系统库和头文件，例如libc, stdc++等，而bin目录下放置的就是编译工具链一系列工具。例如：

  arm-linux-armeabi-ar
  arm-linux-armeabi-as
  arm-linux-armeabi-c++
  arm-linux-armeabi-cpp
  arm-linux-armeabi-g++
  arm-linux-armeabi-gcc
  arm-linux-armeabi-ld
  arm-linux-armeabi-nm
  arm-linux-armeabi-strip
  

  其中arm-linux-armeabi-前缀就是cross，通过用来标示目标平台和架构，主要用于跟主机自身的gcc/clang进行区分。

  里面的gcc/g++就是c/c++的编译器，通常也可以作为链接器使用，链接的时候内部会去调用ld来链接，并且自动追加一些c++库。 cpp是预处理器，as是汇编器，ar用于生成静态库，strip用于裁剪掉一些符号信息，使得目标程序会更加的小。nm用于查看导出符号列表。

  自动探测和编译

  如果我们的交叉编译工具链是上文的结构，xmake会自动检测识别这个sdk的结构，提取里面的cross，以及include/lib路径位置，用户通常不需要做额外的参数设置，只需要配置好sdk根目录就可以编译了，例如：

  $ xmake f -p cross --sdk=/home/toolchains_sdkdir
  $ xmake
  

  其中，-p cross用于指定当前的平台是交叉编译平台，--sdk=用于指定交叉工具链的根目录。

  注：我们也可以指定-p linux平台来配置交叉编译，效果是一样的，唯一的区别是额外标识了linux平台名，方便xmake.lua里面通过is_plat("linux")来判断平台。

  这个时候，xmake会去自动探测gcc等编译器的前缀名cross：arm-linux-armeabi-，并且编译的时候，也会自动加上链接库和头文件的搜索选项，例如：

  -I/home/toolchains_sdkdir/include 
  -L/home/toolchains_sdkdir/lib
  

  这些都是xmake自动处理的，不需要手动配置他们。

  阅读全文

  ---

• xmake从入门到精通8：切换编译模式

  2019-12-05

  xmake

  xmake  lua  编译模式

  xmake是一个基于Lua的轻量级现代化c/c++的项目构建工具，主要特点是：语法简单易上手，提供更加可读的项目维护，实现跨平台行为一致的构建体验。

  本文我们会详细介绍下如何在项目构建过程中切换debug/release等常用构建模式，以及自定义其他编译模式。

  • 项目源码
  • 官方文档

  调试和发布模式

  通常，如果我们是通过xmake create命令创建的项目，会在xmake.lua里面自动添加一行编译规则的配置，如下：

  add_rules("mode.release", "mode.debug")
  target("hello")
      set_kind("binary")
      add_files("src/*.c")
  

  通过add_rules接口，我们默认添加了release和debug两个常用的内置规则，它们会在编译的时候附带上对应模式相关的一些编译flags，来开启优化用于发布或者调试编译。

  如果仅仅执行了xmake命令，没有额外的配置，那么默认就会是release编译，等价于：

  $ xmake f -m release
  $ xmake
  [  0%]: ccache compiling.release src/main.cpp
  [100%]: linking.release test
  build ok!
  

  如果我们要切换到debug编译模式，只需要：

  $ xmake f -m debug
  $ xmake
  [  0%]: ccache compiling.debug src/main.cpp
  [100%]: linking.debug test
  build ok!
  

  上面的-m/--mode=参数就是用来设置编译模式，会跟mode.release和mode.debug这两个规则做关联。

  阅读全文

  ---