TBOOX开源工程

• xmake进阶之简化你的构建描述

  2018-06-08

  xmake

  xmake  lua  工程描述  xmake.lua  简化

  xmake的初衷就是为了让用户能够用最简单直接的方式去描述工程，提供跨平台项目构建，因此，简洁，灵活 是xmake.lua的核心设计思想。

  通过之前的那篇文章:xmake入门，构建项目原来可以如此简单，我们对如何使用xmake去构建项目有了大概的了解，并且能够编写一些简单的xmake.lua去描述项目，例如:

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

  但是平常我们实际的项目维护，不可能这么简单，会有各种各样的配置需求，例如: 添加每个平台特有的flags，处理debug/release编译模式，多个target的依赖编译等等，在混杂了用户各种配置需求后，xmake.lua的维护很容易变得很臃肿，可读性变差。

  因此本文会介绍一些常用的编写模式，去尽可能的利用xmake的设计特性，去简化对工程的描述，提高可读性和易维护性，避免用户因为不了解xmake而导致的一些错误写法。

  在根域添加通用配置

  xmake的配置关系是根据tree结构继承，子xmake.lua会集成父xmake.lua中的配置，同一个xmake.lua中，所有target的配置会集成根作用域的配置，因此一些通用配置，可以放置在根域，避免重复设置，例如:

  阅读全文

  ---

• xmake新增对Qt编译环境支持

  2018-05-30

  xmake

  xmake  lua  Qt  Widgets  QuickApplication

  在最新的xmake v2.2.1版本中，新增了对Qt SDK环境的支持，我们完全可以脱离Qt Creater进行Qt应用程序的开发，甚至配合vscode/idea等编辑器+xmake插件(xmake-vscode, xmake-idea …)， 用户完全可以切换到自己最常用的编辑器环境中去开发和构建Qt程序，例如这样：

  

  通过模板创建空工程

  xmake内置了一些工程模板可以用来快速创建一个基于Qt的空工程，例如：

  $ xmake create -l c++ -t console_qt test
  $ xmake create -l c++ -t static_qt test
  $ xmake create -l c++ -t shared_qt test
  $ xmake create -l c++ -t quickapp_qt test
  

  目前主要提供上述四种工程模板，对应：控制台程序、静态库、动态库、ui应用程序。

  以quickapp工程为例，最后生成的空工程xmake.lua内容大概长这样：

  target("qt_demo")
  
      -- add rules
      add_rules("qt.application")
  
      -- add headers
      add_headers("src/*.h")
  
      -- add files
      add_files("src/*.cpp") 
      add_files("src/qml.qrc")
  
      -- add frameworks
      add_frameworks("QtQuick")
  

  Read English 阅读全文

  ---

• xmake入门，构建项目原来可以如此简单

  2018-03-26

  xmake

  xmake  lua  build  project

  前言

  在开发xmake之前，我一直在使用gnumake/makefile来维护个人C/C++项目，一开始还好，然而等项目越来越庞大后，维护起来就非常吃力了，后续也用过一阵子automake系列工具，并不是很好用。

  由于C/C++程序的构建过程比较繁琐，如果不借助IDE工具，很难快速构建一个新的C/C++程序，想要跨平台构建就更加麻烦了。

  虽然IDE很好用，也很强大，但是还是有很多不足的地方，例如:

  • 跨平台开发支持不完善
  • 自身环境不一定跨平台
  • 过于臃肿
  • 不利于服务端自动化部署构建
  • 不够灵活，定制化配置构建过程有局限性

  当然如果你熟悉makefile的话，也可以手敲makefile，不过不同平台用的make也不相同，比如: gnumake, nmake等，导致makefile语法存在差异性，无法做到一致性编译，而且对开发者有一定的使用门槛。

  在win上使用gnumake还得装cygwin，mingw-msys等环境，也非常麻烦，折腾完环境就得半天时间。

  目前已经有了很多现代化的构建工具，方便开发者构建和维护C/C++项目，例如:cmake, scons, premake, bazel, gn, gyp等等。

  其中很多只能生成对应的IDE工程，然后再通过对应IDE来维护和构建，这种只是解决了C/C++项目的一致性维护问题，但是构建方式不一致，因此还是没解决之前列举的大部分不足点，也无法直接快速构建。

  而cmake, scons虽然很强大，但是cmake语法怪异不直观，本人实在是不习惯，scons使用还需要依赖python，py2/py3的问题折腾起来也比较蛋疼。

  鉴于此，我采用了lua来描述工程，利用lua的轻量，简洁，灵活，跨平台等特性，来解决上述遇到的各种问题，使用xmake将会带来不一样的构建体验:

  • 轻量，跨平台，无依赖，无需额外安装python等第三方环境，直接内置lua运行时，一个安装包(或者命令)直接搞定
  • 工程描述直观简洁，更符合用户正常的思维习惯
  • 支持直接构建，强大的命令行工具，终端用户的福音，装逼用户必备
  • vscode, idea, clion, sublime, vim等编辑器插件支持
  • 智能检测支持，简化用户编译配置过程
  • 插件支持，灵活的用户可扩展性
  • vcproj等IDE项目文件生成也支持的哦
  • 更多隐藏特性等你来体验

  

  快速上手

  不会写makefile？没关系，直接在源码目录运行以下命令即可直接编译:

  xmake
  

  xmake会自动扫描在当前目录下的源码结构，生成一个xmake.lua工程描述文件，然后尝试直接编译。

  想要直接运行编译后的可执行程序，简单，直接敲:

  $ xmake run
  

  阅读全文

  ---

• xmake新增对Cuda代码编译支持

  2018-03-09

  xmake

  xmake  lua  cuda  NVIDIA  GPU

  最近研究了下NVIDIA Cuda Toolkit的编译环境，并且在xmake 2.1.10开发版中，新增了对cuda编译环境的支持，可以直接编译*.cu代码。

  关于Cuda Toolkit相关说明以及安装文档，可参考官方文档：CUDA Toolkit Documentation。

  下载安装好Cuda SDK后，在macosx上回默认安装到/Developer/NVIDIA/CUDA-x.x目录下，Windows上可以通过CUDA_PATH的环境变量找到对应的SDK目录，而 Linux下默认会安装到/usr/local/cuda目录下。

  xmake在执行$ xmake 命令编译*.cu代码的时候，会尝试探测这些默认的安装目录，然后尝试调用nvcc编译器直接编译cuda程序，大部分情况下只需要执行：

  $ xmake
  

  创建和编译Cuda工程

  我之前编译之前，我们可以通过xmake创建一个空的cuda工程，例如：

  $ xmake create -l cuda test
  $ cd test
  $ xmake
  

  通过-l参数指定创建一个cuda代码工程，工程名为test，执行输出如下：

  [00%]: ccache compiling.release src/main.cu
  [100%]: linking.release test
  

  我们也可以尝试直接运行这个cuda程序：

  $ xmake run
  

  阅读全文

  ---

• xmake v2.1.9版本发布，增加可视化图形菜单配置

  2018-02-03

  xmake

  xmake  lua  版本更新

  此版本主要增加xmake f --menu实现用户自定义图形菜单配置，界面风格类似linux的make menuconfig：

  

  更多使用说明，请阅读：文档手册。

  项目源码：Github, Gitee.

  新特性

  • 添加del_files()接口去从已添加的文件列表中移除一些文件
  • 添加rule(), add_rules()接口实现自定义构建规则，并且改进add_files("src/*.md", {rule = "markdown"})
  • 添加os.filesize()接口
  • 添加core.ui.xxx等cui组件模块，实现终端可视化界面，用于实现跟用户进行短暂的交互
  • 通过xmake f --menu实现可视化菜单交互配置，简化工程的编译配置
  • 添加set_values接口到option
  • 改进option，支持根据工程中用户自定义的option，自动生成可视化配置菜单
  • 在调用api设置工程配置时以及在配置菜单中添加源文件位置信息

  改进

  • 改进交叉工具链配置，通过指定工具别名定向到已知的工具链来支持未知编译工具名配置, 例如: xmake f --cc=gcc@ccmips.exe
  • #151: 改进mingw平台下动态库生成
  • 改进生成makefile插件
  • 改进检测错误提示
  • 改进add_cxflags等flags api的设置，添加force参数，来禁用自动检测和映射，强制设置选项：add_cxflags("-DTEST", {force = true})
  • 改进add_files的flags设置，添加force域，用于设置不带自动检测和映射的原始flags：add_files("src/*.c", {force = {cxflags = "-DTEST"}})
  • 改进搜索工程根目录策略
  • 改进vs环境探测，支持加密文件系统下vs环境的探测
  • 升级luajit到最新2.1.0-beta3
  • 增加对linux/arm, arm64的支持，可以在arm linux上运行xmake
  • 改进vs201x工程生成插件，更好的includedirs设置支持

  Bugs修复

  • 修复依赖修改编译和链接问题
  • #151: 修复os.nuldev()在mingw上传入gcc时出现问题
  • #150: 修复windows下ar.exe打包过长obj列表参数，导致失败问题
  • 修复xmake f --cross无法配置问题
  • 修复os.cd到windows根路径问题

  新特性介绍

  新增del_files接口实现从源文件列表中删除指定文件

  通过此接口，可以从前面add_files接口添加的文件列表中，删除指定的文件，例如：

  target("test")
      add_files("src/*.c")
      del_files("src/test.c")
  

  Read English 阅读全文

  ---