使用python编写简单vim插件

海鸥一飞

       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>

       1举个简单的例子

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

1. function! Comment()  #自己使用的插件函数名
   
2. python << EOF   #标志性开头
   
3. #####下面便是python代码部分#####
   
4. import vim      
   
5. import re
   
6. 
   
7. def add_comment():
   
8.     cb = vim.current.buffer
   
9.     cw = vim.current.window
   
10.     row = cw.cursor[0]
    
11.     line_str = cb[row-1]
    
12.     print line_str
    
13. 
    
14.     const_str0 = '/**'
    
15.     const_str1 = ' * '
    
16.     const_str2 = ' */'
    
17.     str_list = []
    
18.     str_list.append(const_str0)
    
19. 
    
20.     largs = re.findall(r'\w+', line_str)
    
21.     print largs
    
22.     if len(largs) <=1:
    
23.         print 'you maybe at wrong line now'
    
24.         return
    
25. 
    
26.     ret = largs[0]
    
27.     del largs[0]
    
28. 
    
29.     fun_name = largs[0]
    
30.     del largs[0]
    
31.     str_list.append(const_str1 + fun_name + ' - ')
    
32.     str_list.append(const_str1 + '@return:' + ' - ')
    
33. 
    
34.     for i,item in enumerate(largs):
    
35.         if i%2 == 1:
    
36.             str_list.append(const_str1 + '@' + item + ' - ')
    
37. 
    
38.     str_list.append(const_str2)
    
39.     cb[row-1:row-1] = str_list
    
40.     return
    
41. 
    
42. add_comment()  #执行上面所编写函数
    
43. #####python代码结束#####
    
44. EOF            #与之前的EOF相对应
    
45. endfunction    #函数编写结束

复制代码

梦想家