在開始編寫外掛程式之前,你需要確認 Vim 是否支援 Ruby,通過以下命令來判別:
$ vim --version | grep +ruby
如果輸出為空白,則表示你當前的vim不支援Ruby,需要重新編譯一下,並啟用對Ruby的支援。
順便說下我當前的環境是:
vim 7.4
ruby 2.1.0
環境檢查沒有問題那麼就開始吧。 在~/.vim/plugin目錄下建立一個 demo.vim 檔案。
在開頭寫上以下代碼:
if !has('ruby') echo "Error: Required vim compiled with +ruby" finishendif
這段代碼就是用 VimL 編寫的,它將檢查 Vim 是否支援 Ruby。
接下來再判斷該外掛程式是否已經載入過了,以免重複載入:
if exists('g:loaded_ruby_demo_plugin') finishendiflet g:loaded_ruby_demo_plugin = 1
所有的檢查都沒有問題,則開始外掛程式的本文了。先定義一個函數。
function! DemoFun1()ruby<<EOFbuf = VIM::Buffer.currentputs "current buffer name: #{buf.name} number: #{buf.number} length: #{buf.length}"EOFendfunction
function與endfunction是vim中用於定義函數的,在”ruby<<EOF”和”EOF”之間部分的是Ruby代碼。這個例子是輸出當前緩衝區的名字、編號以及總行數。 執行命令:call DemoFun1(),應該就可以看到輸出結果了。
然後再舉個例子說下函數的參數處理。
function! DemoFun2(arg1)ruby<< EOFputs "you input: #{VIM.evaluate('a:arg1')}"EOFendfunction
這裡定義了一個函數接收一個參數,然後將其輸出。使用 VIM.evaluate 將vim的變數轉化為Ruby的變數。
為了方便我們再定義兩個命令,以簡化對這兩個函數的調用。
command! -nargs=0 DemoFun1 call DemoFun1()command! -nargs=1 -rang DemoFun2 call DemoFun2(<f-args>)
要擷取完整的代碼可以訪問: https://gist.github.com/wusuopu/c1182efefa85d4f6839b
接下來再簡單說下vim中Ruby的使用。
vim為Ruby提供了一個VIM模組,通過它可以在Ruby中訪問vim的介面。同時還提供了兩個全域變數:$curwin、$curbuf,它們分別代表了當前視窗對象以及當前緩衝區對象。
VIM模組中有 Buffer 和 Window 兩個對象,分別是用來對緩衝區和視窗進行操作的。同時VIM模組還提供了message、set_option、command和evaluate四個函數。
想要查看更多的幫忙資訊,可以在vim中執行如下命令:
好了,先寫這麼多吧,其餘的自己去嘗試吧。