Vim技能修炼教程(3) - 语法高亮进阶

语法高亮进阶

首先我们复习一下上节学到的三个命令:

  • syntax match用于定义正则表达式和规则的对应
  • highlight default定义配色方案
  • highlight link将正则规则和配色方案对应起来

但是,定义好了规则,如何让它自动生效呢?我们需要识别文件类型。

识别文件类型

我们创建一个新插件,建立一个ftdetect目录,然后为这个类型创建一个vim文件,比如之前logcat的例子,我们就建立一个logcat.vim。
例子我们还是找github上的:https://github.com/serpent7776/vim-logcat/blob/master/ftdetect/logcat.vim

au BufNewFile,BufRead logcat set filetype=logcat

au是autocmd的缩写,BufNewFile和BufRead是触发自动命令的事件。
BufNewFile是创建一个新文件,BufRead是将文件读入一个新缓冲区时触发。
具体事件可以参看:help autocmd
logcat是文件名匹配的模式。当符合这种模式之后,将filetype设成logcat,就激活了logcat.vim中配置的高亮。

光比较文件名还是有点low的,还可以通过文件内容来识别.我们来看个复杂一点的例子:https://github.com/thinca/vim-logcat/blob/master/ftdetect/logcat.vim
例:

autocmd BufReadPost,BufNewFile *.logcat setlocal filetype=logcat
autocmd BufReadPost,BufNewFile * if getline(1) =~# '^-\{9} beginning of.*$'
\                              |   setfiletype logcat
\                              | endif

更高级的写法,可以将文件内容识别封装成函数:
例子来源于:https://github.com/gburca/vim-logcat/blob/master/ftdetect/logcat.vim

fun! s:DetectLogcat()
    " Detect from the 2nd line. The 1st line could be:
    " -------- beginning of system
    if line('$') > 1 && getline(2) =~# '.*[F|E|W|I|D|V]/\S*\s*(.*\d'
        set filetype=logcat
    endif
endfun

au BufNewFile,BufRead *.lc set filetype=logcat
au BufNewFile,BufRead *.logcat set filetype=logcat
au BufNewFile,BufRead Boot-*_Set-*_Stream-*.txt set filetype=logcat
au BufNewFile,BufRead * call s:DetectLogcat()

如果自动命令没生效,我们也可以通过手动的方式来设置:set filetype=文件类型。filetype太常用了,也可以简写成ft.

vim插件的目录结构

第一讲我们是通过vundle插件来管理插件路径的。在古老的年代里,插件要么写在.vimrc里,要么放在~/.vim/下面。后来,可以通过指定runtimepath,简写为rtp来指定。

每个runtimepath指定的目录都可以包含下面的文件和子目录:

  • filetype.vim 根据文件名来判断文件类型
  • scripts.vim 根据内容还判断文件类型
  • autoload/ 每次启动vim时都自动加载的脚本。相当于是对.vimrc中的autocmd命令的扩展,需要做autocmd的,都可以写进这个目录。详情请参见:help autoload-functions
  • colors/ 配色方案,详情请参见:help :colorscheme
  • compiler/ 跟各种语言编译器打交道的脚本,后面会讲,详情可参见:help :comp。可以运行下:comp命令试试,会列出一系列的编译器相关的vim文件,可以打开几个看看。
  • doc/ 文档。这个需要强调一下,vim是以文档完备而著称的。详情参见:help write-local-help
  • ftplugin/ 只处理本缓冲区的file type处理的plugin
  • indent/ 处理格式缩进的脚本。详情请看:help :indent-expression
  • keymap/ 有点类似于输入法的意思,将一串英文字符转化成多语言的字符,比如中文
  • lang/ 菜单文字的翻译
  • menu.vim 图形模式下的菜单
  • pack/ 插件包。详情可参见:help :packadd
  • plugin/ 通用的plugin
  • print/ 用于postscript打印的插件
  • spell/ 用于拼写检查的插件
  • syntax/ 语法高亮,详情请参见:help mysyntaxfile
  • tutor/ 教程

对于我们的语法高亮的插件来说,我们可以建立doc, ftdetect和syntax三个目录,分别放文档,类型判断脚本和语法高亮脚本。

关键字高亮

我们上次讲的syn match其实才是高亮的核心武器。不过,针对于一些比较简单的情况,比如语言中的关键字,就可以更简单一些,只要全字匹配就好。

这时候可以用到syntax keyword命令。

我们来看个llvm的例子:

syn keyword llvmType void half float double x86_fp80 fp128 ppc_fp128
syn keyword llvmType label metadata x86_mmx
syn keyword llvmType type label opaque
syn match   llvmType /\<i\d\+\>/

关键字定义了之后,还是要通过hi def link命令跟预定义的配色方案对应起来。

例:

hi def link llvmType Type
hi def link llvmStatement Statement

常用的预定义的配色方案有:

  • Comment: 注释
  • Identifier:标识符
  • Statement:语句
  • PreProc:预处理语句
  • Type: 数据类型,如int, long, double
  • Special: 特殊符号
  • Underlined: 带下划线的符号,如超文本链接
  • Ignore: 留空
  • Error:错误信息
  • Todo: TODO, FIXME之类的信息

实际操作练习

下面我们通过一个最简单的例子来检验一下前面的学习成果。

首先,我们在~/.vim/下建立一个ftdetect目录,随便起个文件名字,比如就叫test.vim吧,先做类型匹配:

 autocmd BufNewFile,BufRead *.test set filetype=test

第二步,我们定义几个类型关键字。在~/.vim/下建立syntax目录,还叫test.vim:

if exists("b:current_syntax")
    finish
endif 
syntax keyword TestType int long short byte
 
highlight default link TestType Type

let b:current_syntax = "test"

最后一步,检验一下我们的成果,随便写几句用类型的语名吧,叫xxx.test之类的

int x = 10;
long y = 20;

可以看到,int和long已经被作为关键字被识别出来了。

小作业:在github上建立一个插件,用vunble来下载您的这个插件,实现语法高亮的功能

扩展阅读:

  • :help group-name,除了上面介绍的常用预定义组之外,这里有更详细的说明

不过,关键字对于很多情况是不够用的,我们还是要回到上一讲的三步曲上写正则表达式。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 227,837评论 6 531
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 98,196评论 3 414
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 175,688评论 0 373
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 62,654评论 1 309
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 71,456评论 6 406
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 54,955评论 1 321
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 43,044评论 3 440
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 42,195评论 0 287
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 48,725评论 1 333
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 40,608评论 3 354
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 42,802评论 1 369
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 38,318评论 5 358
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 44,048评论 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 34,422评论 0 26
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 35,673评论 1 281
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 51,424评论 3 390
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 47,762评论 2 372

推荐阅读更多精彩内容

  • 语法高亮速成 我们继续在人间修行Vim技能之旅。上一次我们学习了如何通过vundle安装插件,这次我们迅速向写插件...
    Jtag特工阅读 661评论 0 0
  • 这篇文章是手册的中文译版整理而来(英文看着太慢了,感谢前人铺路Orz...),vim的markdown插件和实时预...
    Himryang阅读 7,078评论 0 20
  • Ubuntu的发音 Ubuntu,源于非洲祖鲁人和科萨人的语言,发作 oo-boon-too 的音。了解发音是有意...
    萤火虫de梦阅读 99,419评论 9 467
  • 安装依赖库(支持Python 3、Lua、Ruby) sudo apt-get install libncurse...
    Cyfeng阅读 2,128评论 0 2
  • “五十六个民族、五十六枝花、五十六个兄弟姐妹是一家……” 一方有难,八方支援。大旱无情,人间有爱。 当我在电视上看...
    遥望彼岸阅读 178评论 0 0