在開(kāi)始編寫(xiě)插件之前，你需要確認(rèn) Vim 是否支持 Ruby，通過(guò)以下命令來(lái)判別：

$ vim --version | grep +ruby

如果輸出為空，則表示你當(dāng)前的vim不支持Ruby，需要重新編譯一下，并啟用對(duì)Ruby的支持。

順便說(shuō)下我當(dāng)前的環(huán)境是：

vim 7.4
ruby 2.1.0
環(huán)境檢查沒(méi)有問(wèn)題那么就開(kāi)始吧。 在~/.vim/plugin目錄下創(chuàng)建一個(gè) demo.vim 文件。

在開(kāi)頭寫(xiě)上以下代碼：

if !has('ruby')
 echo "Error: Required vim compiled with +ruby"
 finish
endif

這段代碼就是用 VimL 編寫(xiě)的，它將檢查 Vim 是否支持 Ruby。

接下來(lái)再判斷該插件是否已經(jīng)加載過(guò)了，以免重復(fù)加載：

if exists('g:loaded_ruby_demo_plugin')
 finish
endif
let g:loaded_ruby_demo_plugin = 1

所有的檢查都沒(méi)有問(wèn)題，則開(kāi)始插件的正文了。先定義一個(gè)函數(shù)。

function! DemoFun1()
ruby<<EOF
buf = VIM::Buffer.current
puts "current buffer name: #{buf.name} number: #{buf.number} length: #{buf.length}"
EOF
endfunction

function與endfunction是vim中用于定義函數(shù)的，在”ruby<<EOF”和”EOF”之間部分的是Ruby代碼。這個(gè)例子是輸出當(dāng)前緩沖區(qū)的名字、編號(hào)以及總行數(shù)。 執(zhí)行命令:call DemoFun1()，應(yīng)該就可以看到輸出結(jié)果了。

然后再舉個(gè)例子說(shuō)下函數(shù)的參數(shù)處理。

function! DemoFun2(arg1)
ruby<< EOF
puts "you input: #{VIM.evaluate('a:arg1')}"
EOF
endfunction

這里定義了一個(gè)函數(shù)接收一個(gè)參數(shù)，然后將其輸出。使用 VIM.evaluate 將vim的變量轉(zhuǎn)化為Ruby的變量。

為了方便我們?cè)俣x兩個(gè)命令，以簡(jiǎn)化對(duì)這兩個(gè)函數(shù)的調(diào)用。

command! -nargs=0 DemoFun1 call DemoFun1()
command! -nargs=1 -rang DemoFun2 call DemoFun2(<f-args>)

要獲取完整的代碼可以訪問(wèn)： https://gist.github.com/wusuopu/c1182efefa85d4f6839b

接下來(lái)再簡(jiǎn)單說(shuō)下vim中Ruby的使用。

vim為Ruby提供了一個(gè)VIM模塊，通過(guò)它可以在Ruby中訪問(wèn)vim的接口。同時(shí)還提供了兩個(gè)全局變量：$curwin、$curbuf，它們分別代表了當(dāng)前窗口對(duì)象以及當(dāng)前緩沖區(qū)對(duì)象。

VIM模塊中有 Buffer 和 Window 兩個(gè)對(duì)象，分別是用來(lái)對(duì)緩沖區(qū)和窗口進(jìn)行操作的。同時(shí)VIM模塊還提供了message、set_option、command和evaluate四個(gè)函數(shù)。

想要查看更多的幫忙信息，可以在vim中執(zhí)行如下命令：

:help ruby

好了，先寫(xiě)這么多吧，其余的自己去嘗試吧。

最新評(píng)論