使用python编写简单vim插件

最新推荐文章于 2020-03-06 16:38:01 发布

原创最新推荐文章于 2020-03-06 16:38:01 发布 · 4.1k 阅读

3 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#vim 插件 #python

vim学习专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何使用Python为Vim开发插件，包括编写方法、文件放置位置及使用方式。通过实例演示了如何创建一个自动添加C语言函数注释模板的插件。

1 脚本编写方法

在vim的normal模式中输入:h python可以查看编写vim插件时python的具体写法，包括:

vim插件的标准函数开头 结尾
vim提供给python的包vim
python如何操作vim中的内容，包括buffer、window、cursor等
vim的大部分元素都可以当成list来处理

2 放置位置

在编写完自己的vim插件后，只需要将其放入~/.vim目录中即可，同样放入~/.vim/comment/目录中也行，其中comment名字可以根据自己情况去修改

3 使用方法

在.vimrc最后添加source ~/.vim/comment/comment.vim，这里修改成自己所编写插件的路径即可
在vim的normal模式中:call Comment()调用对应函数，这里我插件所使用的函数名字为Comment()，需要根据自己的情况做对应修改
(可以不做)在.vimrc中添加，本质上就是vim的按键映射，详细用法见vim键盘映射

:map <F5> <Esc>:call Comment()<CR>

举个简单的例子

下面是我所编写自动添加C语言函数注释模板插件comment.vim

function! Comment()  #自己使用的插件函数名
python << EOF   #标志性开头
#####下面便是python代码部分#####
import vim      
import re

def add_comment():
    cb = vim.current.buffer
    cw = vim.current.window
    row = cw.cursor[0]
    line_str = cb[row-1]
    print line_str

    const_str0 = '/**'
    const_str1 = ' * '
    const_str2 = ' */'
    str_list = []
    str_list.append(const_str0)

    largs = re.findall(r'\w+', line_str)
    print largs
    if len(largs) <=1:
        print 'you maybe at wrong line now'
        return

    ret = largs[0]
    del largs[0]

    fun_name = largs[0]
    del largs[0]
    str_list.append(const_str1 + fun_name + ' - ')
    str_list.append(const_str1 + '@return:' + ' - ')

    for i,item in enumerate(largs):
        if i%2 == 1:
            str_list.append(const_str1 + '@' + item + ' - ')

    str_list.append(const_str2)
    cb[row-1:row-1] = str_list
    return

add_comment()  #执行上面所编写函数
#####python代码结束#####
EOF            #与之前的EOF相对应
endfunction    #函数编写结束