vim 的erlang插件vimerl

原文来自 http://jzhihui.iteye.com/blog/1305473

谢谢作者的分享

最近开始学习Erlang，一方面出于对其主要语言特征（高并发）的兴趣，另一方面，当前项目的压力测试希望用Tsung（http://tsung.erlang-projects.org/，基于Erlang，很好的压力测试工具）来做，而当前Tsung的协议支持还不能满足我们的要求（XMPP over Websocket），所以希望对其进行扩展（下一篇会讲到Tsung的具体扩展实现）。当然，学习一门语言就需要一个简单方便的工具来进行一些简单的实验。一开始试用了下Erlide（http://erlide.org/），但是配起来后，发现保存文件的时候有时候不会自动编译，然后运行一次程序会开一个新的Erlang交互进程，总觉得不太舒服，就放弃了。然后，对vim也挺有兴趣的，就开始配置使用vimerl（https://github.com/jimenezrick/vimerl）。

 

为了方便，直接下了个Window版的vim，装好后安装vim-pathogen（方便管理vim插件的工具，https://github.com/tpope/vim-pathogen），按vim-pathogen的说明，在vimfiles（Windows下）目录下新建了个bundle目录，然后gitclone https://github.com/jimenezrick/vimerl。新建个简单的Erlang文件，修改，保存...

呃… Windows下的cmd窗口一闪而过，也不知道发生什么事情，也不太了解vim的插件工作机制，可一有点是好的，就是有vimerl的源代码，然后就开始苦逼的开始研究它的代码，经过各种调试（对一个从没接触vim脚本，也没写过Erlang程序的苦逼程序员来说，这个时间稍微有点长），最后问题定位在保存文件后，调用外部程序来编译Erlang文件的命令上，源代码如下（vimerl\compiler\erlang.vim）：

[1]    execute "setlocal makeprg=" .s:erlang_check_file . "\\ \%"

其中s:erlang_check_file=vimerl\compiler\erlang_check.erl，看了下这个文件的内容：调用Erlang的compile:file来编译一个Erlang源代码文件，并返回编译结果。上面那条命令的主要作用MS就是想调用Erlang的编译器来编译当前的文件，并把结果反馈回vim，但是没有成功。但是，在上条命令的上面有一条类似的命令：

[2]    setlocal makeprg=escript\ -s\ %（%代表当前文件）

先不管其它的，看看这个escript程序是干什么的，Google后了解到，这个程序提供的功能跟Linux下的bash一样，可以执行一个标记为Erlang Script（通过#!/usr/bin/env escript来实现，具体可查看vimerl\compiler\erlang_check.erl）的文件。那么命令[1]的目的就是想通过escript程序来执行erlang_check.erl来编译程序，但在Windows下调用没有成功（在Linux下，这个应该不会是问题），问题查明后，修改也就很简单了：

[3]    execute "setlocal makeprg=" ."escript.exe\\ " . s:erlang_check_file . "\\ \%"

修改后，再保存，有编译错误时，可正确在vim的状态栏提示，OK。

 

         再看一下，发现vimerl还有自动补全的功能，输入Erlang模块名后（erlang:，lists:的形式），按Ctrl+X+O后，会出现提出列表。不过这个功能需要先安装Erlang的man文档，从官网下载后安装。再打开一个Erlang源文件，按下Ctrl+X+O… 呃…，也有问题，不过这次的错误比较明显，找不到grep程序:vimerl\autoload\erlang_complete.vim。Window下当然没有grep程序，不过还好有个Window下的开源Grep实现（http://gnuwin32.sourceforge.net/packages/grep.htm），下载安装后，再修改vimerl中相应的参数（let g:erlang_completion_grep= 'Grep'），不过这样还不是不能正常工作，主要是vimerl中使用grep的主要目的是从Erlang的man文件中搜索函数定义，但使用的匹配模式是类似/man?/lists.?/（熟悉Linux的都应该知道man文档一般会有好几个目录，以数字区分，比如man1,man2等等，而同一个函数也会有类似的形式lists.1，lists.2，当然这里的lists代表Erlang里的模块）的形式，在Linux下，这种模式可以正确的工作，但是在Windows下，这种形式无法工作，会提示/man?/文件不存在的错误。其实也就是说Windows下的Grep不能递归匹配，那怎么解决呢，只有先找到man的正确目录，在调用Grep去匹配，这样就需要一个类似Linux下find命令的程序来找到正确的man目录。还好，有个Windows版的findutils（http://gnuwin32.sourceforge.net/packages/findutils.htm），安装后，再按上面的思路修改erlang_complete.vim相关实现（代码见后面说明），再试，终于OK。

 

         功能是好了，不过进行自动补全时，对同一个模块，如果重新打开一个Erlang源文件，vimerl会重新进行匹配，在Linux下问题可能不是很大，但在Windows下，那个cmd窗口每次就不停的弹出，一般一个模块有多少个函数就弹多少次（Linux下没有这个问题，在cmd命令下使用vim也不会有这个问题），多少让人有点烦恼；而且每次打开一个新文件，都重新查找同一个模块的匹配，从速度上来说，也无法忍受。要加快速度，最简单的办法就是加缓存：一个模块在第一次匹配后，将匹配结果缓存到磁盘，并且在打开一个Erlang源文件时，从磁盘加载缓存的匹配结果，这样，在下一次匹配同一个模块时，就直接从缓存里匹配。

加快匹配速度后，还有一个问题，就是在没有Erlang模块名做前缀的情况下，vimerl会尝试从当前模块，或者同一目录下的其它模块匹配函数名（本地函数）。用过Eclipse的同学都知道，这时候，我可能想输入的并不是当前模块（或者同一目录下的其它模块内）的函数名，可能想输入一个内置函数名（Erlang的BIFs）或者也有可能只是想输入一个模块名。

有了这些想法就着手实现，缓存放在vimerl\autoload\ erlang_index中，每一行对应一个模块中的函数列表：模块名为键，函数列表为值。在保存一个Erlang源文件编译时，会先加载缓存，然后从缓存中匹配。在加载缓存时，会自动生成一个以module为键，所有已缓存的模块名列表为值的对象，在进行本地函数名（不带模块名的形式）匹配时，先按照默认的方式匹配，再匹配模块名，然后再匹配BIFs，最后将三者的结果都加入到匹配结果列表中。

         总体的实现就是这样的，上述的修改和扩展都可以在我的github上找到（https://github.com/onlychoice/vimerl/tree/win-vimerl ）找到，欢迎有兴趣的同学下载试用，有什么问题可以留言讨论。

 

 

PS：有了这些功能后，编辑小的Erlang程序应该够了，但是如果要管理一个稍微有点规模的工程，可能就有点不太方便，后续可能会实现这方面的功能。

下面是我自己的经历：

安装完vimerl之后，使用vim打开.erl 文件，发现当:w保存一个文件后 ，自动编译时， -include( ).的宏定义的地方总是有编译报错。

我的vimerl安装在.vim/目录下面，于是找到这个目录，打开

.vim/bundle/vimerl/compiler/erlang_check.erl 文件，发现里面有很多熟悉的东西，例如下面：

原来是因为{i, Dir}指定了编译时的包含路径所导致

main([File]) ->
    Dir = filename:dirname(File),
    Defs = [strong_validation,
%            warn_export_all,
            warn_export_vars,
            warn_shadow_vars,
            warn_obsolete_guard,
            warn_unused_import,
            report,
            {i, Dir ++ "/include"},
            {i, Dir ++ "/../include"},
            {i, Dir ++ "/../../include"},
            {i, Dir ++ "/../../../include"},
            {i, Dir ++ "/../../../../include"}],
    RebarFile = rebar_file(Dir),
    RebarOpts = rebar_opts(RebarFile),
    code:add_patha(filename:absname("ebin")),
    compile:file(File, Defs ++ RebarOpts);

原来它对于单个文件的编译，是需要先定义规则的，嘿嘿，warn_export_all就是当你使用-compile(export_all).的时候，它就会报警告，

而我的-include() 出问题，是因为代码嵌套层数过多，那么，{i, Dir}， 这里的include选项出，多加个几层，就ok了，嘿嘿，当然，还有rebar_opts，有需要的，也可以去设置你自己的规则。

好了，问题解决