Vim插件开发实例

  1. 查看你的runtimepath
    在vim里输入:echo &runtimepath, 一般windows的话, 有两处我们比较关心:

    C:\Users\yourusrname\vimfiles
    C:\yourviminstalldir\vimfiles

    这样, 我们就可以在上面任一位置新建autoload目录, vim载入时(或者需要时)可以自动调用.

  2. 一个vimrc文件
    为了测试方便, 我给出一个简单的vimrc文件(放入vimfiles/)

    set nocp
    filetype plugin indent on
    syntax on
    set st=2
    set acd
    set wildmenu
    set wildmode=longest,list,full
    vnoremap ;x "*y
    vnoremap ;p "*p
    function! ToggleVerbose()
     if !&verbose
         set verbosefile=~/desktop/vimtex.log
         set verbose=15
     else
         set verbose=0
         set verbosefile=
     endif
    endfunction
    
  3. 第一个插件
    现在我们来写第一个插件

    "myfirst plugin for vim
    "put it in $VIM/vimfiles/autoload/myfirstplug.vim
    fu! Initial()
     echom "Initializing the plugin"
    endfu
    
    echom 'Loading myfirstplug.vim'
    fu! myfirstplug#internal()
     echom "This is a autoload function"
    endfu
    echom 'Loading done!'
    

    这样, 我们可以尝试调用call Initial(), 发现错误没有定义:

    E117: Unknown function: Initial

    再次尝试调用call myfirstplug#internal(), 此时正常, 且返回:

    Loading myfirstplug.vim
    Loading done!
    This is a autoload function

    可见, vim的autoload机制是先根据#前部分找到autoload下对应的文件, 并载入(source myfirstplug.vim), 然后执行#后面的函数internal(). 由于此时myfirstplug.vim已经载入, 故此时我们可以正常调用call Initial()了.

  4. 局部变量修饰的函数: 将我们的函数脚本改为

    "myfirst plugin for vim
    "put it in $VIM/vimfiles/autoload/myfirstplug.vim
    fu! Initial()
     echom "Initializing the plugin"
    endfu
    
    fu! s:initial()
     echom "Another initializing function, local to this script"
    endfu
    
    echom 'Loading myfirstplug.vim'
    fu! myfirstplug#internal()
     echom "This is a autoload function"
     call s:initial()
    endfu
    echom 'Loading done!'
    

    这里, 我们用到了一个变量前缀: s:, 表示只在当前脚本中有定义. 具体参考
    :h internal-variables

    前缀 含义
    g:varname 变量为全局变量
    s:varname 变量的范围为当前的脚本文件
    w:varname 变量的范围为当前的编辑器窗口
    t:varname 变量的范围为当前的编辑器选项卡
    b:varname 变量的范围为当前的编辑器缓冲区
    l:varname 变量的范围为当前的函数
    a:varname 变量是当前函数的一个参数
    v:varname 变量是 Vim 的预定义变量
    &varname 一个 Vim 选项(如果指定的话,则为本地选项,否则为全局选项)
    &l:varname 本地 Vim 选项
    &g:varname 全局 Vim 选项
    @varname 一个 Vim 注册器
    $varname 一个环境变量

    即使我们通过so %来重载myfirstplug.vim, 我们也不能通过:call s:internal()来调用函数. 但是你发现在该脚本内部, 我们是可以正常调用的. 请运行:call myfirstplug#internal(), 查看结果.

  5. 函数的abortdict 关键字, 我们增加如下函数

    fu! Callback(count) dict
     let thecounter=a:count
     while thecounter>0
         echom "call for " . self.name . "at the ". thecounter "times"
         let thecounter -=1
     endwhile
    endfu
    let context={"name": "dictfun"}
    let Func =function('Callback', [3], context)
    

    通过:call Func() 我们得到三次输出, 注意到self.name 被替换成dictfun.

  6. 断点调试
    我们可以通过设置文件断点和函数断点来调试脚本: 例如

    :breakadd func Callback
    :breakadd file 20 */myfirstplug.vim
    

    则在执行:so myfirstplug.vim时会停在第20行, 回车继续执行. 在执行:call Func()时, 会自动停在函数Callback开始处, 此时你可以通过echo a:count查看count值. 你甚至可以echo a:看看. 此外s/n/c表示step/next/continue.

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

推荐阅读更多精彩内容

  • Lua 5.1 参考手册 by Roberto Ierusalimschy, Luiz Henrique de F...
    苏黎九歌阅读 13,798评论 0 38
  • 这篇文章是手册的中文译版整理而来(英文看着太慢了,感谢前人铺路Orz...),vim的markdown插件和实时预...
    Himryang阅读 7,011评论 0 20
  • 安装依赖库(支持Python 3、Lua、Ruby) sudo apt-get install libncurse...
    Cyfeng阅读 2,113评论 0 2
  • 丘吉尔:“在人生的头25年我渴望自由,在接下来的25年我渴望自律,后25年,我意识到自律就是自由”。 在我没有立志...
    小蘑菇1990阅读 404评论 0 3
  • 1 在2018年8月29日的时候,我终于决定要正式写点什么了。毕竟就如我的ID 一样,坚持脱发二十年,貌似除了这个...
    烽火长歌阅读 2,009评论 0 0