If_ruby

Nvim :help 页面，生成于源使用 tree-sitter-vimdoc 解析器。

Vim 的 Ruby 接口 ruby Ruby

Ruby 的主页是 https://www.ruby-lang.org.cn/。您可以在那里找到 Ruby 下载链接。

1. 命令 ruby-commands

:ruby :rub :rub[y] {cmd} 执行 Ruby 命令 {cmd}。一个尝试它的命令

:ruby print "Hello"

:rub[y] << [trim] [{endmarker}] {script} {endmarker} 执行 Ruby 脚本 {script}。

如果 [endmarker] 被省略，它将默认为一个点 '.'，就像 :append 和 :insert 命令一样。有关更多信息，请参阅 :let-heredoc。

这种形式的 :ruby 命令主要用于在 vim 脚本中包含 ruby 代码。

示例 Vim 脚本

function! RedGem()
ruby << EOF
class Garnet
        def initialize(s)
                @buffer = VIM::Buffer.current
                vimputs(s)
        end
        def vimputs(s)
                @buffer.append(@buffer.count,s)
        end
end
gem = Garnet.new("pretty")
EOF
endfunction

要查看您拥有的 Ruby 版本

:ruby print RUBY_VERSION

:rubydo :rubyd E265 :[range]rubyd[o] {cmd} 针对 [range] 中的每一行对 Ruby 命令 {cmd} 进行求值，其中 $_ 被设置为每一行的文本，后面不带 <EOL>。设置 $_ 会更改文本，但请注意，无法使用此命令添加或删除行。[range] 的默认值为整个文件："1,$"。

:rubyfile :rubyf :rubyf[ile] {file} 执行 {file} 中的 Ruby 脚本。这与 :ruby load 'file' 相同，但允许文件名完成。

在沙盒中无法执行 Ruby 命令。

2. VIM 模块 ruby-vim

Ruby 代码通过 "VIM" 模块获得对 vim 的所有访问权限。

概述

print "Hello"                              # displays a message
VIM.command(cmd)                      # execute an Ex command
num = VIM::Window.count                      # gets the number of windows
w = VIM::Window[n]                      # gets window "n"
cw = VIM::Window.current              # gets the current window
num = VIM::Buffer.count                      # gets the number of buffers
b = VIM::Buffer[n]                      # gets buffer "n"
cb = VIM::Buffer.current              # gets the current buffer
w.height = lines                      # sets the window height
w.cursor = [row, col]                      # sets the window cursor position
pos = w.cursor                              # gets an array [row, col]
name = b.name                              # gets the buffer file name
line = b[n]                              # gets a line from the buffer
num = b.count                              # gets the number of lines
b[n] = str                              # sets a line in the buffer
b.delete(n)                              # deletes a line
b.append(n, str)                      # appends a line after n
line = VIM::Buffer.current.line       # gets the current line
num = VIM::Buffer.current.line_number # gets the current line number
VIM::Buffer.current.line = "test"     # sets the current line number

模块函数

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 内部表达式求值器 (参见 expression) 对 {expr} 进行求值。将表达式结果作为字符串返回。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 返回游标位置的 [row, col] 数组。第一行编号为 1，第一列编号为 0。cursor = [{row}, {col}] 将游标位置设置为 {row} 和 {col}。

5. 全局变量 ruby-globals

有两个全局变量。

$curwin 当前窗口对象。$curbuf 当前缓冲区对象。

6. rubyeval() Vim 函数 ruby-rubyeval

为了促进双向接口，您可以使用 rubyeval() 函数来评估 Ruby 表达式并将它们的值传递给 Vim 脚本。

Ruby 值 "true"、"false" 和 "nil" 分别转换为 v:true、v:false 和 v:null。