在開始編寫插件之前,你需要確認 Vim 是否支持 Ruby,通過以下命令來判別:
1
|
$ vim --version | grep +ruby |
如果輸出為空,則表示你當前的vim不支持Ruby,需要重新編譯一下,并啟用對Ruby的支持。
順便說下我當前的環境是:
vim 7.4
ruby 2.1.0
環境檢查沒有問題那么就開始吧。 在~/.vim/plugin目錄下創建一個 demo.vim 文件。
在開頭寫上以下代碼:
1
2
3
4
|
if !has( 'ruby' ) echo "Error: Required vim compiled with +ruby" finish endif |
這段代碼就是用 VimL 編寫的,它將檢查 Vim 是否支持 Ruby。
接下來再判斷該插件是否已經加載過了,以免重復加載:
1
2
3
4
|
if exists( 'g:loaded_ruby_demo_plugin' ) finish endif let g :loaded_ruby_demo_plugin = 1 |
所有的檢查都沒有問題,則開始插件的正文了。先定義一個函數。
1
2
3
4
5
6
|
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中用于定義函數的,在”ruby<<EOF”和”EOF”之間部分的是Ruby代碼。這個例子是輸出當前緩沖區的名字、編號以及總行數。 執行命令:call DemoFun1(),應該就可以看到輸出結果了。
然后再舉個例子說下函數的參數處理。
1
2
3
4
5
|
function! DemoFun2(arg1) ruby<< EOF puts "you input: #{VIM.evaluate('a:arg1')}" EOF endfunction |
這里定義了一個函數接收一個參數,然后將其輸出。使用 VIM.evaluate 將vim的變量轉化為Ruby的變量。
為了方便我們再定義兩個命令,以簡化對這兩個函數的調用。
1
2
|
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中執行如下命令:
1
|
:help ruby |
好了,先寫這么多吧,其余的自己去嘗試吧。