*if_ruby.txt* For Vim version 7.4. 最近更新: 2013年8月
VIM 参考手册 by Shugo Maeda
译者: Willis, tocer
http://vimcdoc.sf.net
Vim 的 Ruby 接口 *ruby* *Ruby*
1. 命令 |ruby-commands|
2. VIM 模块 |ruby-vim|
3. VIM::Buffer 对象 |ruby-buffer|
4. VIM::Window 对象 |ruby-window|
5. 全局变量 |ruby-globals|
6. 动态调入 |ruby-dynamic|
{Vi 无此功能}
*E266* *E267* *E268* *E269* *E270* *E271* *E272* *E273*
只有编译 Vim 时加入 |+ruby| 特性才会有 Ruby 接口功能。
ruby 的主页是 http://www.ruby-lang.org/。你可以在那里找到 Ruby 下载的链接。
1. 命令 *ruby-commands*
*:ruby* *:rub* :rub[y]{cmd}执行 Ruby 命令{cmd}。要试一试::ruby print "Hello":rub[y] <<{endpattern}{script}{endpattern}执行 Ruby 脚本{script}。{endpattern}_不能_有前导空白。如果{endpattern}省 略，缺省为单个句号 '.'，类似于 |:append| 和 |:insert| 命令。这种形式的 |:ruby| 命令主要用于在 vim 脚本里包含 ruby 代码。注意: 如果编译时没有加入 Ruby 特性，这个命令不会工作。 为了避免错误，参看 |script-here|。 示例 Vim 脚本:function! RedGem()ruby << EOFclass Garnetdef initialize(s)@buffer = VIM::Buffer.currentvimputs(s)enddef vimputs(s)@buffer.append(@buffer.count,s)endendgem = Garnet.new("pretty")EOFendfunction*:rubydo* *:rubyd* *E265* :[range]rubyd[o]{cmd}在[range]界定的每行上分别执行 Ruby 命令{cmd}，执行 时，$_ 设为相应的行文本，不含结尾的<EOL>。修改 $_ 就 会修改相应的行，不过要注意: 此命令不能用来增加或者删 除行。 缺省的[range]是整个文件: "1,$"。 *:rubyfile* *:rubyf* :rubyf[ile]{file}执行 Ruby 脚本文件{file}。这和 ":ruby load'file'" 相 当，但可用文件名自动补全功能。 |sandbox| 里不能执行 Ruby 命令。
2. VIM 模块 *ruby-vim*
Ruby 代码通过 "VIM" 模块调用所有的 vim 功能。 概述print "Hello" # 显示消息VIM.command(cmd) # 执行 ex 命令num = VIM::Window.count # 得到窗口行数w = VIM::Window[n] # 得到第 "n" 个窗口cw = VIM::Window.current # 得到当前窗口num = VIM::Buffer.count # 得到缓冲区的个数b = VIM::Buffer[n] # 得到第 "n" 个缓冲区cb = VIM::Buffer.current # 得到当前缓冲区w.height = lines # 设置窗口高度w.cursor = [row, col] # 设置窗口里的光标位置pos = w.cursor # 得到数组 [行, 列]name = b.name # 得到缓冲区的文件名line = b[n] # 得到缓冲区的某一行num = b.count # 得到总的行数b[n] = str # 设置缓冲区的某一行b.delete(n) # 删除某一行b.append(n, str) # 在第 n 行后增加一行line = VIM::Buffer.current.line # 得到当前行num = VIM::Buffer.current.line_number # 得到当前行号VIM::Buffer.current.line = "test" # 设置当前行模块函数: *ruby-message* VIM::message({msg}) 显示消息{msg}。 *ruby-set_option* VIM::set_option({arg}) 设置 vim 选项。{arg}可以是任何一个 ":set" 命令接受的命令。注意这意 味着参数里不能有空格！参见 |:set|。 *ruby-command* VIM::command({cmd}) 执行 Ex 命令{cmd}。 *ruby-evaluate* VIM::evaluate({expr}) 用 vim 内部的表达式分析器执行{expr}(参看 |expression|)。返回字符串 形式的执行结果。 |List| 通过连接项目并在项目间插入换行符来转化为字符串。
3. VIM::Buffer 对象 *ruby-buffer*
VIM::Buffer 对象代表 Vim 缓冲区。 类方法: current 返回当前缓冲区对象。 count 返回缓冲区的总数。 self[{n}] 返回第{n}个缓冲区。首个缓冲区的序号是 0。 方法: name 返回缓冲区的名字。 number 返回缓冲区的序号。 count 返回总行数。 length 返回总行数。 self[{n}] 从缓冲区中返回一行。{n}是行号。 self[{n}] ={str}设置缓冲区的一行。{n}是行号。 delete({n}) 删除缓冲区的一行。{n}是行号。 append({n},{str}) 在第{n}行后增加一行。 line 如果缓冲区激活，返回缓冲区的当前行。 line ={str}如果缓冲区激活，设置缓冲区的当前行。 line_number 如果缓冲区激活，返回当前行的行号。
4. VIM::Window 对象 *ruby-window*
VIM::Window 对象代表 Vim 窗口。 类方法: current 返回当前窗口对象。 count 返回窗口的总数。 self[{n}] 返回第{n}个窗口。首个窗口的序号是 0。 方法: buffer 返回显示的缓冲区对象。 height 返回窗口的高度。 height ={n}设置窗口的高度为{n}。 width 返回窗口的宽度。 width ={n}设置窗口的宽度为{n}。 cursor 返回光标位置数组: [行、列]。 cursor = [{row},{col}] 设置光标位置为行{row}和列{col}。
5. 全局变量 *ruby-globals*
有两个全局变量。 $curwin 当前窗口对象。 $curbuf 当前缓冲区对象。
6. 动态调入 *ruby-dynamic*
MS-Windows 和 Unix 上，可以动态调入 Ruby 库。|:version| 输出这时应包括 |+ruby/dyn|。 这意味着 Vim 只有在必要时才寻找 Ruby DLL 或动态库文件。如果不使用 Ruby 接口， 你就不需要它。这样，即使没有该 DLL 文件，你也可使用 Vim。 必须安装正确的 Ruby 版本才能工作。该包可以从这里下载: http://www.garbagecollect.jp/ruby/mswin32/en/download/release.html 目前的版本是 ruby-1.9.1-p429-i386-mswin32.zip 要使用 Ruby 接口，Ruby DLL 必须在搜索路径上。控制台窗口里输入 "path" 可以看到 (搜索路径) 当前使用的目录。 DLL 名必须匹配 Vim 编译时所使用的 Ruby 版本。目前，该名字为 "ruby191.dll"，也 就是 Ruby 1.9.1。要确信这一点，编辑 "gvim.exe" 文件并查找 "ruby\d*.dll\c"。 如果编译 Vim 时要使用 Ruby 1.9.1，需要编辑 config.h 文件，注释掉 _MSC_VER 的检 查。 可能还需要更改 include 目录名以匹配版本号，不过奇怪的是 Ruby 1.9.3 的目录名叫 1.9.1。
vim:tw=78:ts=8:ft=help:norl:
Generated by vim2html on Thu Sep 19 06:21:44 UTC 2013