ASCII Art:使用纯文本流程图

我们使用纯文本写代码,有了Markdown又可以使用纯文本写文档,那么对于更直观的信息表达方式——图片,能不能使用纯文本描述呢?

另外,你是否见到过这样的注释:

没错,这种逼格极高的ASCII图片注释方式就是我们要讨论的话题。

使用纯ASCII文本表达图像的方式有什么好处呢?大致有下面几点:

  1. 装B;没啥好解释的。
  2. 可以在代码注释里面用图像充分表达信息;没图say个jb?一图胜千言。迄今为止好像没有什么IDE可以支持直接在代码编辑里面放图片的,在另外一些纯文本的场合也是如此。比如RFC的文档都是txt,里面很多图都是纯ASCII表达。
  3. 你以为仅仅是一个纯文本图片这么简单?它可以转换为普通的诸如png格式的真正的图片,还支持SVG矢量图!

好了,也许有人说markdown的一些拓展格式不也是支持流程图的吗?它使用的flowchart.js 确实可以很好滴完成一些漂亮的流程图,还有 plantuml和图片DSL语言 dot及它的软件包graphviz等;没错,它们可以使用纯文本表达图像,但它们不是真正的图像;无法嵌入文本代码中,只有在经过渲染之后才能直观地看到图。

又有人说,我知道 asciiflow 这个网站,可以绘制这种流程图,完美解决我的需求。但是,你在手动绘制的时候,是不是要考虑图像的各种细节?大小,放置位置,对齐方式?我们关注的应该是图像本身,而不是如何绘制这个图。markdown为什么这么易用?就是因为我们不用关心文档的格式,不用考虑什么字体,几级标题等等繁琐的格式,可以专注于创作本身。

姑且你已经认同了这种使用ASCII表达图像方式的优点,但是…这种图难道要使用手一个个字符地敲出来吗??如果真的这么做,简直不要太麻烦!光在前面添加一个空格,后面的所有行都需要改;我们需要一个自动化工具。

Graph::Easy

Graph::Easy 就是今天要介绍的主角;它是 perl的一个软件包,可以使用perl代码直接描述图像;当然,我们肯定不会为了画个图专门去学习perl;

这个软件包的强大之处在于: 它定义了一套非常简单易用的专门用来描述图像的DSL(领域专用语言),我们可以像写代码一样表达我们需要描述的图像(放心,这个语法非常简单);不用关心图像里面如何布局;这种语言经过处理可以得到ASCII图像,直接放在代码注释中;如果需要还可以转换成png或者矢量图等格式。

先举个简单的例子,感受一下:

[ Bonn ] --> [ Koblenz ] --> [ Frankfurt ] --> [ Dresden ]

[ Koblenz ] --> [ Trier ] { origin: Koblenz; offset: 2, 2; }
  --> [ Frankfurt ]

这种DSL经过渲染之后得到的ASCII图是这样的:

+------+     +---------+                   +-----------+     +---------+
| Bonn | --> | Koblenz | ----------------> | Frankfurt | --> | Dresden |
+------+     +---------+                   +-----------+     +---------+
               |                             ^
               |                             |
               |                             |
               |             +-------+       |
               +-----------> | Trier | ------+
                             +-------+

安装

  1. 首先需要安装 graphviz 软件包,可以在graphviz官网下载;mac用户可以 brew install graphviz;其他linux发行版参考官网
  2. 安装perl;mac和linux用户可以略过;一般系统自带,没有的话和windows一起去perl官网查询如何安装; 据说windows下有傻瓜包activeperl;请自行搜索。
  3. 安装cpan; 这个是perl的软件包管理,类似npm, pip, apt-get; mac下直接在命令行输入 cpan 命令,一路next即可。其他系统参考cpan官网
  4. 安装Graph::Easy ;这一步就很容易了;在命令行输入cpan进入cpan shell;然后输入 install Graph::Easy即可。

使用

使用分为两步

  1. 使用Graph::Easy DSL的语法描述图像,存为文本文件,比如 simple.txt
  2. 使用 graph-easy 命令处理这个文件: graph-easy simple.txt

最简单的使用方式就是这样;当然,Graph::Easy 不仅仅支持自己的DSL语法,它还支持诸如dot 这种较为通用的图像描述语言;可以直接读取dot 格式的输入,产生其他的诸如 ascii,png,svg格式的图像。

语法

注释

注释用 # 表达;注意 # 之后,一定需要加空格;由于历史原因;Graph::Easy的颜色也使用了 # ,不加空格会解析失败。

##############################################################
# 合法的注释

##############################################################
#有问题的注释

node { label: \#5; }	  # 注意转义!
edge { color: #aabbcc; }  # 可以使用颜色值

空格

空格通常没有什么影响,多个空字符会合并成一个,换行的空字符会忽略;下面的表述是等价的。

[A]->[B][C]->[D]
[ A ] -> [ B ]
[ C ] -> [ D ]

节点(Node)

用中括号括起来的就是节点,我们简单可以理解为一些形状;比如流程图里面的矩形,圆等;

[ Single node ]
[ Node A ] --> [ Node B ]

可以用逗号分割多个节点:

[ A ], [ B ], [ C ] --> [ D ]

上面的代码图像如下:

+---+     +---+     +---+
| A | --> | D | <-- | C |
+---+     +---+     +---+
            ^
            |
            |
          +---+
          | B |
          +---+

边(Edges)

将节点连接起来的就是边;Graph::Easy 的DSL支持这几种风格的边:

->              实线
=>              双实线
.>              点线
~>              波浪线
- >             虚线
.->             点虚线
..->            dot-dot-dash
= >             double-dash

可以给边加标签,如下:

[ client ] - request -> [ server ]
``` 
结果如下:

```asciidoc
+--------+  request   +--------+
| client | ---------> | server |
+--------+            +--------+

属性(Attributes)

可以给节点和边添加属性;比如标签,方向等;使用大括号 {}表示,里面的内容类似css,attribute: value

[ "Monitor Size" ] --> { label: 21"; } [ Big ] { label: "Huge"; }

上面的DSL输入如下:

+----------------+  21"   +------+
| "Monitor Size" | -----> | Huge |
+----------------+        +------+

Graph::Easy提供了非常多的属性; 另外,Graph::Easy文档非常详细,建议通读一遍;了解其中的原理和细节,对于绘图和布局有巨大帮助。目前正在翻译,文档地址.

实例

语法是不是非常简单?有了这些知识,我们就可以建立自己的流程图了;Have a try!来个MVP模式的示意图试试~

  1. 新建文件,vi mvp.txt; 输入以下代码:
[ View ] {rows:3} - Parse calls to -> [ Presenter ] {flow: south; rows: 3} - Manipulates -> [ Model ]
[ Presenter ] - Updates -> [ View ]
  1. 保存然后退出;命令行执行 graph-easy mvp.txt, 输入效果如下:
+------+  Parse calls to   +--------------+
|      | ----------------> |              |
| View |                   |  Presenter   |
|      |  Updates          |              |
|      | <---------------- |              |
+------+                   +--------------+
                             |
                             | Manipulates
                             v
                           +--------------+
                           |    Model     |
                           +--------------+

两行代码就搞定了!自动对齐,调整位置,箭头,标签等等;我们完全不用管具体图形应该如何绘制,注意力集中在描述图像本身;还在等什么!赶紧试一试吧!!

原文:http://weishu.me/2016/01/03/use-pure-ascii-present-graph/

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏编程札记

数据库内部排序算法之两阶段多路归并排序算法实现

7123
来自专栏LET

谈谈3D Tiles(2):数据结构

3904
来自专栏ATYUN订阅号

使用Matplotlib绘制图的常见问题和答案

Matplotlib是最受欢迎的二维图形库,但有时让你的图变得像你想象中好并不容易。

6453
来自专栏猿人谷

memcpy和memmove的区别

memcpy()和memmove()都是C语言中的库函数,在头文件string.h中,其原型分别如下: void *memcpy(void *dst, con...

2655
来自专栏深度学习自然语言处理

matplotlib--python的数据可视化二

1032
来自专栏Fish

蓝桥杯 危险系数

题意就是求图中两点之间的割点的数目。 不知道被谁指导的说求割点可以用tarjan算法,就用了tarjan算法,但是tarjan算法求的是整个图的割点个数啊,至于...

2198
来自专栏吉浦迅科技

TensorFlow版本号升至1.0,正式版即将到来

2015年11月份,谷歌宣布开源了深度学习框架TensorFlow,一年之后,TensorFlow就已经成长为了GitHub上最受欢迎的深度学习框架,尽管那时候...

3719
来自专栏吉浦迅科技

DAY20:阅读Surface Memory

2192
来自专栏李海辰的专栏

Unity 引擎资源管理代码分析 ( 1 )

目前网络上已经有很多介绍 Unity 资源管理机制、和 API 使用方法的文章,但少有文章从 Unity源码层面对其实现进行深度解析。作为一名喜欢打破砂锅璺到底...

1.1K1
来自专栏IT开发技术与工作效率

Excel函数学习重点指南(官网)

1193

扫码关注云+社区

领取腾讯云代金券