zhikuiguo的个人博客分享 http://blog.sciencenet.cn/u/zhikuiguo

博文

GMT语法高亮-智能提示-代码补全插件

已有 370 次阅读 2020-6-15 01:28 |个人分类:科研作图很简单|系统分类:科研笔记

摘要

GMT(Generic Mappint Tools)是地学界应用非常广泛的一款绘图兼数据处理的开源软件。其开发团队也是非常活跃,此软件还在不断的发展和更新中,变得越来越强大。目前已经有164个模块,而每一个模块又有很多命令参数。因为gmt是命令行软件,没有GUI界面,所以用户必须记住,或知道怎么从官方文档中查询这些参数并知道如何使用它。说起来容易,做起来难,如此大量的命令及参数,就连作者这样的深度用户都无法记住,也需要常常去访问文档查找命令和参数。这是gmt用户面临的一大难题,也是初学者望而生畏的原因。 本文将介绍作者自己开发的一款VScode (Visual Studio Code插件,不仅可以提升gmt脚本文件的颜值,而且还具有强大的代码自动补全功能和智能提示功能,再也不用担心-J后面跟啥参数这样的问题了!

GMT的工作方式

GMT其实是由一系列的命令行程序组成的,每一个模块(比如 pscoast)就是一个单独的程序。而要完成一张图的绘制,直接在终端一个一个敲命令肯定不现实,效率太低。一般可取的处理方式就是将一系列命令写在一个脚本文件中:windows系统中就是大家熟悉的批处理文件,通常以 .bat 为后缀名;而Mac系统和Linux系统中是bash脚本文件,通常以 .sh 为后缀名。 这样用脚本文件的方式处理,对代码的二次利用有很大的益处。比如下面这样一段GMT的命令,

gmt begin ex22    gmt set FONT_ANNOT_PRIMARY 10p FONT_TITLE 18p FORMAT_GEO_MAP ddd:mm:ssF    file=`gmt which @usgs_quakes_22.txt -G`    n=`gmt info $file -h1 -Fi -o2`    first=`gmt info -h1 -f0T -i0 $file -C --TIME_UNIT=d -I1 -o0 --FORMAT_CLOCK_OUT=-`    last=`gmt info -h1 -f0T -i0 $file -C --TIME_UNIT=d -I1 -o1 --FORMAT_CLOCK_OUT=-`    me="GMT guru @@ GMTbox"    gmt makecpt -Cred,green,blue -T0,100,300,10000 -N    gmt coast -Rg -JK180/9i -B45g30 -B+t"World-wide earthquake activity" -Gburlywood -Slightblue -A1000 -Y2.75i    gmt plot -C -Sci -Wfaint -hi1 -i2,1,3,4+s0.015 $file    gmt legend -DJBC+o0/0.4i+w7i/1.7i -F+p+glightyellow neis.legend gmt end show

Copy to clipboard

可以绘制一张如下图所示的全球的地震分布的图,还是非常美观的。这个例子来源于GMT的官方例子: example-22.

https://scibyte.oss-cn-beijing.aliyuncs.com/blog/post/gmt_ex22.jpg

图 12 GMT官方例子22

这个例子是最新版的gmt的语法,使用了所谓的modern模式,比之前的版本在使用上精简了很多,功能也更强大了。

GMT脚本编辑器 : VScode

既然我们要用脚本文件的方式来编辑和运行GMT命令集,那么准备一个强大且美观的代码编辑器是必须的,工欲善其事必先利其器嘛!这种神器有没有呢,答案是肯定的,而且还不止一种选择,比如常用的 VScodesublimeatom ,这三款都是跨平台的,而且其用户也都非常多,都有自己的一部分铁粉。当然了,很多大神看到了可能就不服气了,说为啥不提我 vim ,这个是很强大,但是本人就是不喜欢用。除此之外还有windows下的 notePad++ ,这个似乎没有Mac版本。当年还在用win系统的时候,用过一段时间,还凑合,不过放弃它已经很久了。

工具这么多,萝卜青菜各有所爱,本人最喜欢VScode。这是个跨平台的,也就是你所有的使用习惯和软件配置以及插件,换了系统照样使用,完全不影响。VScode的用户社区越来越庞大,很多大神们也贡献了各种各样的插件,使得VScode相当的好用!虽然像C++, python, java script这样的编程语言已经有了太多太多好用的插件,但是GMT至今还没有人贡献GMT的插件(包括代码高亮)。虽然GMT算不上编程语言,但是其命令之多参数之复杂,在某种程度上也可以算成一种脚本语言了。由于没有GMT插件,导致在使用的时候很难忍受它的颜值,那就来自己开发一个插件。下面我就来介绍这个插件:vscode-GMT

vscode-GMT

功能

代码高亮

这个是基本款,只有代码高亮功能。目前是v0.0.2版本,可以高亮显示的内容有:

  • gmt : gmt 这个词

  • gmt的所有模块名称: 比如 pscoast

  • gmt的所有模块的参数名称:比如 -J, -G 等

  • gmt的所有配置参数,比如 MAP_GRID_CROSS_SIZE_PRIMARY

  • gmt内置的所有颜色名称,比如 lightblue

  • gmt的所有投影参数,比如 -JM, -JX

  • 一些其他的bash类语法,比如数字,变量等

比如上面绘图的这段代码,如果没有使用vscode-GMT插件,其显示效果如下图所示的素颜代码:

https://scibyte.oss-cn-beijing.aliyuncs.com/blog/post/ex22_noHighlight.png

图 13 没有使用vscode-GMT插件的素颜代码

有人会问了,gmt的脚本文件就是bash文件呀,vscode已经有了bash的代码高亮插件了,为啥还是没有高亮?因为vscode的bash代码高亮的插件只是针对一小部分的bash语法和关键词进行高亮的,其效果非常有限,正如上图所示。大量的gmt命令它是识别不了的,想想这也是不可能的事儿。

使用了vscode-GMT插件之后的美颜效果如下图所示:

https://scibyte.oss-cn-beijing.aliyuncs.com/blog/post/ex22_highlight.png

图 14 使用vscode-GMT插件之后的美颜照

颜色主题

这个代码高亮效果可以随着VScode的颜色主题的改变而改变,按自己喜好选择light类主题或者dark类主题。此外,vscode-GMT插件还自带了两款增强版的主题:

  • OneLight-gmt

  • OneDark-gmt

一个是亮色主题一个是暗色主题,自带的主题会对gmt的一些特有的语法进行增强高亮,已达到更好的高亮效果。这两者的高亮效果分别如下图所示。

https://scibyte.oss-cn-beijing.aliyuncs.com/blog/post/ex22_onelight_gmt.png

图 15 vscode-GMT增强型亮色主题(OneLight-gmt)显示效果

https://scibyte.oss-cn-beijing.aliyuncs.com/blog/post/ex22_onedark_gmt.png

图 16 vscode-GMT增强型暗色主题(OneDark-gmt)显示效果

安装

vscode-GMT的安装非常简单,跟vscode的常规插件安装方法相同,可以在线安装。因为我已经将此插件发布到了vscode Marketplace上了,见下图。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT/vscode_GMT_marketplace.png

图 17 vscode-GMT插件在Marketplace上的效果截图

可以直接在vscode上联网安装,在插件管理器中输入 gmt 就可以搜到我的插件了,然后点击安装即可生效,见下图。

https://scibyte.oss-cn-beijing.aliyuncs.com/blog/post/vscode_GMT_install.png

图 18 在vscode插件管理器中在线安装的界面截图

小技巧

切换专属增强型主题的方法与正常切换主题的方法一样,只需要在主题搜索栏中输入gmt就可以过滤出来 OneLight-gmt 和 OneDark-gmt 这两个专属主题。操作流程为 ctrl+p -> 输入>color theme -> 点击第一个 -> 输入gmt 即可看到这两个主题名字,点击即可。 第二种方法更简单,在插件管理器中搜索gmt,就可以找到已经安装了的gmt插件,点击就可以看到右边窗口中logo旁边有一个 Set Color Theme 按钮,然后就会弹出这两个主题,选择点击其中一个即可生效。

vscode-GMT Pro

上面介绍的这个vscode-GMT是基本款,而vscode-GMT-Pro具有更强大的功能,具体如下。

功能

语法高亮

代码高亮功能与vscode-GMT插件完全相同。

代码自动补全

目前版本的代码补全功能包括以下几项:

  • gmt模块名称: 输入gmt然后按空格就会提示所有的gmt模块命令和相应的解释说明,可以按上下键进行选择,选中后按Tab键就可以自动补全命令。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT-Pro/completion_modules.gif

图 19 gmt模块自动补全演示

  • gmt模块的参数:当输入 gmt 然后选择某个模块命令之后,只要按下 - 键就可以自动提示所有的与此模块有关的参数和解释,这个是非常实用的功能。同样可以按Tab键进行补全。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT-Pro/completion_arguments.gif

图 20 模块参数自动补全演示

  • -J参数后面的投影方式: 当输入 -J 后会自动弹出提示可选的投影方式,同样用上下键选择,可以看到每个投影方式的解释,然后用Tab键生效(补全)。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT-Pro/completion_projection.gif

图 21 投影参数自动补全演示

  • -G和-S参数后面的颜色:与-J参数的自动补全类似,只不过这两个参数后面跟的是可选的颜色名称。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT-Pro/completion_GS_color.gif

图 22 -G和-S颜色参数自动补全演示

  • 所有的gmt内置变量: 比如当你输入 map 就会自动提示所有与map相关的内置变量,支持模糊输入,这对于没有准确记住内置变量名称的情况非常有帮助。大大提升了效率。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT-Pro/completion_defaults.gif

图 23 gmt内置变量的自动补全演示

代码智能提示快捷键

上面的代码提示功能是键盘输入驱动的,比如当你输入 - 的时候回驱动参数自动补全功能。但是如果你输入 -之后失去了鼠标焦点,或者将一个参数删除到了 - 的时候,这种情况下是不会自动驱动代码补全功能的。但是可以用快捷键进行强制启动智能提示功能,快捷键为 ctrl+D 或者Mac系统下的 cmd+D 组合键盘。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT-Pro/completion_keybinding.gif

图 24 智能提示快捷键 ctrl+D 或 cmd+D

鼠标悬停提示

鼠标悬停提示功能就是当你鼠标放在一个命令或者参数上的时候,会自动提示这个命令或者参数的相关解释。此功能已经实现,但是需要花时间补充相关的解释文档,会很快跟大家见面的。注意:鼠标悬停提示只针对gmt的命令区域有效,不在其他地方出现,就如下面的动图中演示的那样。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT-Pro/completion_hover.gif

图 25 鼠标悬停提示演示

安装

由于Pro版插件的开发耗费了大量的时间和精力,所以没有免费发行。或许众筹是个思路!如果想使用,请从 此链接 获取下载口令,然后在我的公众号里面回复此口令就可以得到安装包下载地址。 下载完成后按下图的方式安装即可,也是非常容易的。

https://scibyte.oss-cn-beijing.aliyuncs.com/vscode-extensions/GMT-Pro/install_gmt_pro.gif

图 26 Pro版插件安装流程截图




http://blog.sciencenet.cn/blog-621290-1237876.html

上一篇:GMT三维绘图有BUG? 修复它!
下一篇:Nature论文中的三维图原来是这么画的

0

该博文允许注册用户评论 请点击登录 评论 (0 个评论)

数据加载中...

Archiver|手机版|科学网 ( 京ICP备07017567号-12 )

GMT+8, 2020-10-29 14:08

Powered by ScienceNet.cn

Copyright © 2007- 中国科学报社

返回顶部