在函数名上使用 CTRL-] 跳转到完整的功能说明。
用法 结果 描述
abs({expr}) 浮点或数值 {expr} 的绝对值
acos({expr}) 浮点 {expr} 的反余弦值
add({object}, {item}) 列表或 blob 在 {object} 最后附加 {item}
and({expr}, {expr}) 数值 按位与
append({lnum}, {text}) 数值 在第 {lnum} 行下附加 {text}
appendbufline({buf}, {lnum}, {text})
数值 在缓冲区 {buf} 第 {lnum} 行下附加
{text}
argc([{winid}]) 数值 参数列表的文件数目
argidx() 数值 参数列表的当前索引
arglistid([{winnr} [, {tabnr}]]) 数值 参数列表的 id
argv({nr} [, {winid}]) 字符串 参数列表第 {nr} 个参数
asin({expr}) 浮点 {expr} 的反正弦值
argv([-1, {winid}]) 列表 参数列表
assert_beeps({cmd}) 数值 断言 {cmd} 产生铃声
assert_equal({exp}, {act} [, {msg}])
数值 断言 {exp} 等于 {act}
assert_equalfile({fname-one}, {fname-two} [, {msg}])
数值 断言文件内容相同
assert_exception({error} [, {msg}])
数值 断言 v:exception 中有 {error}
assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
数值 断言 {cmd} 失败
assert_false({actual} [, {msg}])
数值 断言 {actual} 为假
assert_inrange({lower}, {upper}, {actual} [, {msg}])
数值 断言 {actual} 在指定范围内
assert_match({pat}, {text} [, {msg}])
数值 断言 {pat} 匹配 {text}
assert_nobeep({cmd}) 数值 断言 {cmd} 不导致响铃
assert_notequal({exp}, {act} [, {msg}])
数值 断言 {exp} 不等于 {act}
assert_notmatch({pat}, {text} [, {msg}])
数值 断言 {pat} 不匹配 {text}
assert_report({msg}) 数值 报告一个测试失败
assert_true({actual} [, {msg}]) 数值 断言 {actual} 为真
atan({expr}) 浮点 {expr} 的反正切值
atan2({expr1}, {expr2}) 浮点 {expr1} / {expr2} 的反正切值
autocmd_add({acmds}) 布尔型 新增一组自动命令及组
autocmd_delete({acmds}) 布尔型 删除一组自动命令及组
autocmd_get([{opts}]) 列表 返回自动命令的列表
balloon_gettext() 字符串 气泡的当前文本
balloon_show({expr}) 无 在气泡内显示{expr}
balloon_split({msg}) 列表 分割用于的 {msg}
base64_decode({string}) blob base64 解码 {string} 里的字符
base64_encode({blob}) 字符串 base64 编码 {blob} 里的字节
bindtextdomain({package}, {path})
布尔型 绑定文本域到特定路径
blob2list({blob}) 列表 把 {blob} 转换为数值列表
blob2str({blob} [, {options}]) 列表 把 {blob} 转换为字符串列表
browse({save}, {title}, {initdir}, {default})
字符串 启动文件请求窗口
browsedir({title}, {initdir}) 字符串 启动目录请求窗口
bufadd({name}) 数值 在缓冲区列表里加入缓冲区
bufexists({buf}) 数值 如果缓冲区 {buf} 存在则为 TRUE
buflisted({buf}) 数值 如果缓冲区 {buf} 在列表内则为 TRUE
bufload({buf}) 数值 如果还未载入，载入缓冲区 {buf}
bufloaded({buf}) 数值 如果缓冲区 {buf} 被载入则为 TRUE
bufname([{buf}]) 字符串 缓冲区 {buf} 的名字
bufnr([{buf} [, {create}]]) 数值 缓冲区 {buf} 的编号
bufwinid({buf}) 数值 缓冲区 {buf} 的窗口 ID
bufwinnr({buf}) 数值 缓冲区 {buf} 的窗口号
byte2line({byte}) 数值 第 {byte} 个字节所在的行号
byteidx({expr}, {nr} [, {utf16}])
数值 {expr} 里第 {nr} 个字符的字节位置
byteidxcomp({expr}, {nr} [, {utf16}])
数值 {expr} 里第 {nr} 个字符的字节位置
call({func}, {arglist} [, {dict}])
可变 调用函数 {func}，使用参数 {arglist}
ceil({expr}) 浮点 {expr} 向上取整
ch_canread({handle}) 数值 检查是否有可读的内容
ch_close({handle}) 无 关闭 {handle}
ch_close_in({handle}) 无 关闭 {handle} 的 in 部分
ch_evalexpr({handle}, {expr} [, {options}])
可变 在 JSON {handle} 上执行 {expr}
ch_evalraw({handle}, {string} [, {options}])
可变 在原始 {handle} 上执行 {string}
ch_getbufnr({handle}, {what}) 数值 获得 {handle}/{what} 的缓冲区号
ch_getjob({channel}) 作业 获得 {channel} 的相关作业
ch_info({handle}) 字符串 有关通道 {handle} 的信息
ch_log({msg} [, {handle}]) 无 在通道日志文件中写入 {msg}
ch_logfile({fname} [, {mode}]) 无 开始记录通道活动
ch_open({address} [, {options}])
通道 打开到 {address} 的通道
ch_read({handle} [, {options}]) 字符串 从 {handle} 读取
ch_readblob({handle} [, {options}])
blob 从 {handle} 读取 blob
ch_readraw({handle} [, {options}])
字符串 从 {handle} 读取原始格式
ch_sendexpr({handle}, {expr} [, {options}])
可变 在 JSON {handle} 上发送 {expr}
ch_sendraw({handle}, {expr} [, {options}])
可变 在原始 {handle} 上发送 {expr}
ch_setoptions({handle}, {options})
无 设置 {handle} 的选项
ch_status({handle} [, {options}])
字符串 通道 {handle} 的状态
changenr() 数值 当前改变号
char2nr({expr} [, {utf8}]) 数值 {expr} 里第一个字符串的 ASCII/UTF-8 值
charclass({string}) 数值 {string} 的字符类
charcol({expr} [, {winid}]) 数值 光标或位置标记的列号
charidx({string}, {idx} [, {countcc} [, {utf16}]])
数值 {string} 中字节 {idx} 对应的字符索引
chdir({dir}) 数值 改变当前目录
cindent({lnum}) 数值 第 {lnum} 行的 C 缩进
clearmatches([{win}]) 无 清除所有的匹配
cmdcomplete_info() 字典 获得当前命令行补全信息
col({expr} [, {winid}]) 数值 光标或位置标记的列字节索引
complete({startcol}, {matches}) 无 设置插入模式补全
complete_add({expr}) 数值 增加补全匹配
complete_check() 数值 补全时检查输入的键
complete_info([{what}]) 字典 获得当前补全信息
complete_match([{lnum}, {col}]) 列表 获得补全列和触发文本
confirm({msg} [, {choices} [, {default} [, {type}]]])
数值 用户选择的序号
copy({expr}) 可变 提供 {expr} 的浅备份
cos({expr}) 浮点 {expr} 的余弦值
cosh({expr}) 浮点 {expr} 的双曲余弦值
count({comp}, {expr} [, {ic} [, {start}]])
数值 计算 {comp} 里有多少个 {expr}
cscope_connection([{num} , {dbpath} [, {prepend}]])
数值 检查 cscope 连接是否存在
cursor({lnum}, {col} [, {off}])
数值 移动光标到 {lnum}，{col}，{off}
debugbreak({pid}) 数值 中断待调试的进程
cursor({list}) 数值 移动光标到 {list} 里的位置
deepcopy({expr} [, {noref}]) 可变 提供 {expr} 的完整备份
delete({fname} [, {flags}]) 数值 删除文件或目录 {fname}
deletebufline({buf}, {first} [, {last}])
数值 删除缓冲区 {buf} 的多行
did_filetype() 数值 用过 FileType 自动命令事件则为 TRUE
diff({fromlist}, {tolist} [, {options}])
列表 比较两个字符串列表
diff_filler({lnum}) 数值 {lnum} 行之上的 diff 填充行数
diff_hlID({lnum}, {col}) 数值 {lnum}/{col} 位置的 diff 高亮
digraph_get({chars}) 字符串 得到 {chars} 的 digraph
digraph_getlist([{listall}]) 列表 得到所有的 digraph
digraph_set({chars}, {digraph}) 布尔型 注册 digraph
digraph_setlist({digraphlist}) 布尔型 注册多个 digraph
echoraw({expr}) 无 照原样输出 {expr}
empty({expr}) 数值 如果 {expr} 为空则为 TRUE
environ() 字典 返回所有环境变量
err_teapot([{expr}]) 无 {expr} 为 TRUE 时给出 E418 或 E503
escape({string}, {chars}) 字符串 在 {string} 里用 '\' 转义 {chars}
eval({string}) 可变 计算 {string}，返回结果
eventhandler() 数值 如果在事件处理中则为 TRUE
executable({expr}) 数值 如果可执行文件 {expr} 存在则为 1
execute({command}) 字符串 执行 {command} 并取得输出结果
exepath({expr}) 字符串 命令 {expr} 的完整路径
exists({expr}) 数值 如果 {expr} 存在则为 TRUE
exists_compiled({expr}) 数值 如果 {expr} 编译时存在则为 TRUE
exp({expr}) 浮点 {expr} 的指数函数值
(译者注: 以 e 为底)
expand({expr} [, {nosuf} [, {list}]])
可变 扩展 {expr} 里的特殊关键字
expandcmd({string} [, {options}])
字符串 像 :edit 那样扩展 {string}
extend({expr1}, {expr2} [, {expr3}])
列表/字典 把 {expr2} 里的项目插入 {expr1}
extendnew({expr1}, {expr2} [, {expr3}])
列表/字典 和 extend() 类似，但建立新列表或字
典
feedkeys({string} [, {mode}]) 数值 给预输入缓冲区加入键序列
filecopy({from}, {to}) 数值 如果复制 {from} 文件到 {to} 成功则为
TRUE
filereadable({file}) 数值 如果 {file} 是个可读文件则为 TRUE
filewritable({file}) 数值 如果 {file} 是个可写文件则为 TRUE
filter({expr1}, {expr2}) 列表/字典/blob/字符串
删除 {expr1} 里 {expr2} 为 0 的项目
finddir({name} [, {path} [, {count}]])
字符串 在 {path} 里寻找目录 {name}
findfile({name} [, {path} [, {count}]])
字符串/列表 在 {path} 里寻找文件 {name}
flatten({list} [, {maxdepth}]) 列表 展平 {list}，最多到 {maxdepth} 层
flattennew({list} [, {maxdepth}])
列表 展平 {list} 的一个备份
float2nr({expr}) 数值 转换浮点数 {expr} 为数值
floor({expr}) 浮点 {expr} 向下取整
fmod({expr1}, {expr2}) 浮点 {expr1} / {expr2} 的浮点余数
fnameescape({fname}) 字符串 转义 {fname} 中的特殊字符
fnamemodify({fname}, {mods}) 字符串 修改文件名
foldclosed({lnum}) 数值 {lnum} 所在折叠的首行，如果是关闭的话
foldclosedend({lnum}) 数值 {lnum} 所在折叠的末行，如果是关闭的话
foldlevel({lnum}) 数值 {lnum} 的折叠级别
foldtext() 字符串 关闭的折叠显示的行
foldtextresult({lnum}) 字符串 {lnum} 所在的关闭的折叠的文本
foreach({expr1}, {expr2}) 列表/元组/字典/blob/字符串
对 {expr1} 里的每个项目，调用 {expr2}
foreground() 数值 把 Vim 窗口带到前台
fullcommand({name} [, {vim9}]) 字符串 得到 {name} 的完整命令
funcref({name} [, {arglist}] [, {dict}])
函数引用 函数 {name} 的引用
function({name} [, {arglist}] [, {dict}])
函数引用 函数 {name} 的命名引用
garbagecollect([{atexit}]) 无 释放内存，打破循环引用
get({list}, {idx} [, {def}]) 可变 得到 {list} 或 {def} 的项目 {idx}
get({dict}, {key} [, {def}]) 可变 得到 {dict} 或 {def} 的项目 {idx}
get({func}, {what}) 可变 得到函数引用/偏函数 {func} 的属性
getbufinfo([{buf}]) 列表 缓冲区信息
getbufline({buf}, {lnum} [, {end}])
列表 缓冲区 {buf} 第 {lnum} 到 {end} 行
getbufoneline({buf}, {lnum}) 字符串 缓冲区 {buf} 的第 {lnum} 行
getbufvar({buf}, {varname} [, {def}])
可变 缓冲区 {buf} 的变量 {varname}
getcellpixels() 列表 得到字符单元的像素尺寸
getcellwidths() 列表 得到字符单元的宽度覆盖
getchangelist([{buf}]) 列表 改变列表项目的列表
getchar([{expr} [, {opts}]]) 数值或字符串
让用户输入一个字符
getcharmod() 数值 最近输入字符的修饰符
getcharpos({expr}) 列表 光标、位置标记等的位置
getcharsearch() 字典 最近字符搜索选项
getcharstr([{expr} [, {opts}]]) 字符串 从用户处得到一个字符
getcmdcomplpat() 字符串 返回当前命令行补全的补全模式
getcmdcompltype() 字符串 返回当前命令行补全的类型
getcmdline() 字符串 返回当前命令行输入
getcmdpos() 数值 返回命令行的光标位置
getcmdprompt() 字符串 返回当前命令行提示
getcmdscreenpos() 数值 返回命令行的光标屏幕位置
getcmdtype() 字符串 返回当前命令行类型
getcmdwintype() 字符串 返回当前命令行窗口类型
getcompletion({pat}, {type} [, {filtered}])
列表 命令行补全匹配列表
getcompletiontype({pat}) 字符串 返回用 {pat} 时命令行补全的类型
getcurpos([{winnr}]) 列表 光标位置
getcursorcharpos([{winnr}]) 列表 光标的字符位置
getcwd([{winnr} [, {tabnr}]]) 字符串 当前工作目录
getenv({name}) 字符串 返回环境变量
getfontname([{name}]) 字符串 使用的字体名
getfperm({fname}) 字符串 文件 {fname} 的文件权限
getfsize({fname}) 数值 字节计算的文件 {fname} 大小
getftime({fname}) 数值 文件的最新修改时间
getftype({fname}) 字符串 文件 {fname} 类型的描述
getimstatus() 数值 如果 IME 处于激活状态则为 TRUE
getjumplist([{winnr} [, {tabnr}]])
列表 跳转列表项目的列表
getline({lnum}) 字符串 当前缓冲区的第 {lnum} 行
getline({lnum}, {end}) 列表 当前缓冲区第 {lnum} 到 {end} 行
getloclist({nr}) 列表 位置列表项目的列表
getloclist({nr}, {what}) 字典 获取指定的位置列表项目
getmarklist([{buf}]) 列表 全局/局部位置标记的列表
getmatches([{win}]) 列表 当前匹配的列表
getmousepos() 字典 最近已知的鼠标位置
getmouseshape() 字符串 当前鼠标外型名
getpid() 数值 Vim 的进程号
getpos({expr}) 列表 光标、位置标记等的位置
getqflist() 列表 快速修复项目的列表
getqflist([{what}]) 字典 获取指定快速修复列表的项目
getreg([{regname} [, 1 [, {list}]]])
字符串/列表 某寄存器内容
getreginfo([{regname}]) 字典 关于某寄存器的信息
getregion({pos1}, {pos2} [, {opts}])
列表 获取从 {pos1} 到 {pos2} 的文本
getregionpos({pos1}, {pos2} [, {opts}])
列表 获取指定区域的位置列表
getregtype([{regname}]) 字符串 某寄存器的类型
getscriptinfo([{opts}]) 列表 已执行脚本的列表
getstacktrace() 列表 获取 Vim 脚本的当前栈追踪
gettabinfo([{expr}]) 列表 标签页列表
gettabvar({nr}, {varname} [, {def}])
可变 {tabnr} 标签页的 {varname} 变量
gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
可变 {tabnr} 标签页 {winnr} 窗口的 {name}
gettagstack([{nr}]) 字典 获取窗口 {nr} 的标签栈
gettext({text} [, {package}]) 字符串 查找 {text} 的翻译
getwininfo([{winid}]) 列表 每个窗口信息的列表
getwinpos([{timeout}]) 列表 Vim 窗口以像素计的 X 和 Y 坐标
getwinposx() 数值 Vim 窗口以像素计的 X 坐标
getwinposy() 数值 Vim 窗口以像素计的 Y 坐标
getwinvar({nr}, {varname} [, {def}])
可变 窗口 {expr} 的变量 {varname}
glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
可变 扩展 {expr} 里的文件通配符
glob2regpat({expr}) 字符串 转化 glob 模式为搜索模式
globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
字符串 在 {path} 所有目录下执行 glob({expr})
has({feature} [, {check}]) 数值 如果支持特性 {feature} 则为 TRUE
has_key({dict}, {key}) 数值 如果 {dict} 有项目 {key} 则为 TRUE
haslocaldir([{winnr} [, {tabnr}]])
数值 如果当前窗口执行过 :lcd 则为 TRUE
hasmapto({what} [, {mode} [, {abbr}]])
数值 如果 {what} 的映射存在则为 TRUE
histadd({history},{item}) 数值 在历史里增加项目
histdel({history} [, {item}]) 数值 从历史里删除项目
histget({history} [, {index}]) 字符串 得到历史的第 {index} 项
histnr({history}) 数值 历史里最高的项目号
hlID({name}) 数值 高亮组 {name} 的语法 ID
hlexists({name}) 数值 如果高亮组 {name} 存在则为 TRUE
hlget([{name} [, {resolve}]]) 列表 得到高亮组属性
hlset({list}) 数值 设置高亮组属性
hostname() 字符串 Vim 运行的机器名字
iconv({expr}, {from}, {to}) 字符串 转换 {expr} 的编码
id({item}) 字符串 获取项目的唯一标识字符串
indent({lnum}) 数值 第 {lnum} 行的缩进
index({object}, {expr} [, {start} [, {ic}]])
数值 {object} 里出现 {expr} 的项目的索引
indexof({object}, {expr} [, {opts}]])
数值 {object} 里 {expr} 为真的项目的索引
input({prompt} [, {text} [, {completion}]])
字符串 从用户得到输入
inputdialog({prompt} [, {text} [, {cancelreturn}]])
字符串 类似于 input()，但使用 GUI 对话框
inputlist({textlist}) 数值 让用户从选择列表里挑选
inputrestore() 数值 恢复预输入
inputsave() 数值 保存和清除预输入
inputsecret({prompt} [, {text}]) 字符串 类似于 input()，但隐藏文本
insert({object}, {item} [, {idx}]) 列表 在 {object} 里插入 {item} [{idx} 之前]
instanceof({object}, {class}) 数值 如果 {object} 是 {class} 的实例则为
TRUE
interrupt() 无 中断脚本执行
invert({expr}) 数值 按位取反
isabsolutepath({path}) 数值 如果 {directory} 是绝对路径则为 TRUE
isdirectory({directory}) 数值 如果 {directory} 是目录则为 TRUE
islocked({expr}) 数值 如果 {expr} 被锁住则为 TRUE
isinf({expr}) 数值 决定 {expr} 是否为无限大 (正或负)
isnan({expr}) 数值 如果 {expr} 为 NaN 则为 TRUE
items({expr}) 列表 {expr} 里的键/索引-值组对
job_getchannel({job}) 通道 获取 {job} 的通道句柄
job_info([{job}]) 字典 获取 {job} 的信息
job_setoptions({job}, {options}) 无 设置 {job} 选项
job_start({command} [, {options}])
作业 启动作业
job_status({job}) 字符串 获取 {job} 的状态
job_stop({job} [, {how}]) 数值 停止 {job}
join({expr} [, {sep}]) 字符串 连接 {expr} 的项目成为一个字符串
js_decode({string}) 可变 解码 JS 风格的 JSON
js_encode({expr}) 字符串 编码 JS 风格的 JSON
json_decode({string}) 可变 解码 JSON
json_encode({expr}) 字符串 编码 JSON
keys({dict}) 列表 {dict} 的所有键
keytrans({string}) 字符串 把内部键值翻译为 :map 可接受的形式
len({expr}) 数值 {expr} 的长度
libcall({lib}, {func}, {arg}) 字符串 调用库 {lib} 的函数 {func}，使用参数
{arg}
libcallnr({lib}, {func}, {arg}) 数值 同上，但返回数值
line({expr} [, {winid}]) 数值 光标所在、末行或者位置标记所在的行号
line2byte({lnum}) 数值 行 {lnum} 的字节位置
lispindent({lnum}) 数值 行 {lnum} 的 Lisp 缩进
list2blob({list}) blob 把数值的 {list} 转成 blob
list2str({list} [, {utf8}]) 字符串 把数值的 {list} 转成字符串
list2tuple({list}) 元组 把 {list} 里的项目转为元组
listener_add({callback} [, {buf} [, {unbuffered}]])
数值 增加监听改动的回调
listener_flush([{buf}]) 无 激活监听器回调
listener_remove({id}) 无 删除监听器回调
localtime() 数值 当前时间
log({expr}) 浮点 {expr} 的自然对数 (以 e 为底)
log10({expr}) 浮点 {expr} 以 10 为底的对数
luaeval({expr} [, {expr}]) 可变 执行 Lua 表达式
map({expr1}, {expr2}) 列表/字典/blob/字符串
{expr1} 的每个项目改变为 {expr2}
maparg({name} [, {mode} [, {abbr} [, {dict}]]])
字符串/字典
模式 {mode} 的映射 {name} 的右手边
mapcheck({name} [, {mode} [, {abbr}]])
字符串 检查匹配 {name} 的映射
maplist([{abbr}]) 列表 所有映射的列表，每个映射对应一个字典
mapnew({expr1}, {expr2}) 列表/字典/blob/字符串
类似于 map() 但创建新列表或字典
mapset({mode}, {abbr}, {dict}) 无 从 maparg() 返回值恢复映射
match({expr}, {pat} [, {start} [, {count}]])
数值 {expr} 里 {pat} 的匹配位置
matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
数值 用 {group} 高亮 {pattern}
matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
数值 {group} 的高亮位置
matcharg({nr}) 列表 :match 的参数
matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict})
列表 缓冲区 {buf} 里的所有 {pat} 匹配
matchdelete({id} [, {win}]) 数值 删除 {id} 指定的匹配
matchend({expr}, {pat} [, {start} [, {count}]])
数值 {expr} 里 {pat} 的结束位置
matchfuzzy({list}, {str} [, {dict}])
列表 在 {list} 中模糊匹配 {str}
matchfuzzypos({list}, {str} [, {dict}])
列表 在 {list} 中模糊匹配 {str}
matchlist({expr}, {pat} [, {start} [, {count}]])
列表 {expr} 里 {pat} 的匹配和子匹配
matchstr({expr}, {pat} [, {start} [, {count}]])
字符串 {expr} 里 {pat} 的第 {count} 个匹配文
本
matchstrlist({list}, {pat} [, {dict})
列表 {list} 里所有的 {pat} 匹配
matchstrpos({expr}, {pat} [, {start} [, {count}]])
列表 {expr} 里 {pat} 的第 {count} 个匹配
max({expr}) 数值 {expr} 的项目的最大值
menu_info({name} [, {mode}]) 字典 获取菜单项目信息
min({expr}) 数值 {expr} 的项目的最小值
mkdir({name} [, {flags} [, {prot}]])
数值 建立目录 {name}
mode([{expr}]) 字符串 当前编辑模式
mzeval({expr}) 可变 计算 MzScheme 表达式
nextnonblank({lnum}) 数值 第一个 >= {lnum} 的非空白行的行号
ngettext({single}, {plural}, {number}[, {domain}])
字符串 根据 {number} 翻译文本
nr2char({expr} [, {utf8}]) 字符串 ASCII/UTF-8 值为 {expr} 的单个字符
or({expr}, {expr}) 数值 按位或
pathshorten({expr} [, {len}]) 字符串 缩短路径里的目录名
perleval({expr}) 可变 计算 Perl 表达式
popup_atcursor({what}, {options}) 数值 在光标附近创建弹出窗口
popup_beval({what}, {options}) 数值 为 'ballooneval' 创建弹出窗口
popup_clear() 无 关闭所有弹出窗口
popup_close({id} [, {result}]) 无 关闭弹出窗口 {id}
popup_create({what}, {options}) 数值 创建弹出窗口
popup_dialog({what}, {options}) 数值 创建弹出窗口用作对话框
popup_filter_menu({id}, {key}) 数值 菜单弹出窗口的过滤
popup_filter_yesno({id}, {key}) 数值 对话框弹出窗口的过滤
popup_findecho() 数值 获取 :echowin 的弹出窗口 ID
popup_findinfo() 数值 获取信息弹出窗口的窗口 ID
popup_findpreview() 数值 获取预览弹出窗口的窗口 ID
popup_getoptions({id}) 字典 获取弹出窗口 {id} 的选项
popup_getpos({id}) 字典 获取弹出窗口 {id} 的位置
popup_hide({id}) 无 隐藏弹出窗口 {id}
popup_list() 列表 获取所有弹出的窗口 ID 列表
popup_locate({row}, {col}) 数值 获取在给出位置的弹出窗口 ID
popup_menu({what}, {options}) 数值 创建弹出窗口用作菜单
popup_move({id}, {options}) 无 设置弹出窗口 {id} 的位置
popup_notification({what}, {options})
数值 创建通知弹出窗口
popup_setbuf({id}, {buf}) 布尔型 设置弹出窗口 {id} 的缓冲区
popup_setoptions({id}, {options})
无 设置弹出窗口 {id} 的选项
popup_settext({id}, {text}) 无 设置弹出窗口 {id} 的文本
popup_show({id}) 数值 撤销弹出窗口 {id} 的隐藏
pow({x}, {y}) 浮点 {x} 的 {y} 次方
preinserted() 数值 文本是否插入在光标后方
prevnonblank({lnum}) 数值 最后一个 <= {lnum} 的非空白行的行号
printf({fmt}, {expr1}...) 字符串 排版文本
prompt_getprompt({buf}) 字符串 获取提示文本
prompt_setcallback({buf}, {expr}) 无 设置提示回调函数
prompt_setinterrupt({buf}, {text}) 无 设置提示中断函数
prompt_setprompt({buf}, {text}) 无 设置提示文本
prop_add({lnum}, {col}, {props}) 无 新增一项文本属性
prop_add_list({props}, [[{lnum}, {col}, {end-lnum}, {end-col}], ...])
无 新增多项文本属性
prop_clear({lnum} [, {lnum-end} [, {props}]])
无 删除所有文本属性
prop_find({props} [, {direction}])
字典 查找文本属性
prop_list({lnum} [, {props}]) 列表 {lnum} 的文本属性
prop_remove({props} [, {lnum} [, {lnum-end}]])
数值 删除一个文本属性
prop_type_add({name}, {props}) 无 定义新的文本属性类型
prop_type_change({name}, {props})
无 改变已有的文本属性类型
prop_type_delete({name} [, {props}])
无 删除文本属性类型
prop_type_get({name} [, {props}])
字典 获取文本属性类型的值
prop_type_list([{props}]) 列表 获取文本属性类型的列表
pum_getpos() 字典 如果可见，pum 的位置和大小
pumvisible() 数值 弹出窗口是否可见
py3eval({expr} [, {locals}]) 可变 计算 python3 表达式
pyeval({expr} [, {locals}]) 可变 计算 Python 表达式
pyxeval({expr} [, {locals}]) 可变 计算 python_x 表达式
rand([{expr}]) 数值 得到伪随机数
range({expr} [, {max} [, {stride}]])
列表 从 {expr} 到 {max} 的序列
readblob({fname} [, {offset} [, {size}]])
blob 从 {fname} 读取 Blob
readdir({dir} [, {expr} [, {dict}]])
列表 {dir} 中 {expr} 所选择的文件名
readdirex({dir} [, {expr} [, {dict}]])
列表 {dir} 中 {expr} 所选择的文件信息
readfile({fname} [, {type} [, {max}]])
列表 得到文件 {fname} 的行列表
reduce({object}, {func} [, {initial}])
可变 用 {func} 缩减 {object}
reg_executing() 字符串 得到执行中的寄存器名
reg_recording() 字符串 得到记录中寄存器名
reltime([{start} [, {end}]]) 列表 得到时间值
reltimefloat({time}) 浮点数 把时间值转化为浮点数
reltimestr({time}) 字符串 把时间值转化为字符串
remote_expr({server}, {string} [, {idvar} [, {timeout}]])
字符串 发送表达式
remote_foreground({server}) 数值 把 Vim 服务器带到前台
remote_peek({serverid} [, {retvar}])
数值 检查应答字符串
remote_read({serverid} [, {timeout}])
字符串 读入应答字符串
remote_send({server}, {string} [, {idvar}])
字符串 发送键序列
remote_startserver({name}) 无 成为服务器 {name}
remove({list}, {idx} [, {end}]) 可变/列表
从 {list} 里删除项目 {idx}-{end}
remove({blob}, {idx} [, {end}]) 可变/blob
从 {blob} 里删除字节 {idx}-{end}
remove({dict}, {key}) 可变 从 {dict} 里删除项目 {key}
rename({from}, {to}) 数值 换名 (移动) 文件，从 {from} 到 {to}
repeat({expr}, {count}) 列表/元组/Blob/字符串
重复 {expr} {count} 次
resolve({filename}) 字符串 解析快捷方式对应的文件名
reverse({obj}) 列表/元组/Blob/字符串
反转 {obj}
round({expr}) 浮点 {expr} 四舍五入
rubyeval({expr}) 可变 计算 Ruby 表达式
screenattr({row}, {col}) 数值 当前光标所在的属性
screenchar({row}, {col}) 数值 当前光标所在的字符
screenchars({row}, {col}) 列表 当前光标所在的字符列表
screencol() 数值 当前光标列
screenpos({winid}, {lnum}, {col}) 字典 文本字符的屏幕行与列
screenrow() 数值 当前光标行
screenstring({row}, {col}) 字符串 当前光标所在的字符串
search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
数值 搜索 {pattern}
searchcount([{options}]) 字典 获取或更新搜索统计数据
searchdecl({name} [, {global} [, {thisblock}]])
数值 搜索变量声明
searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
数值 搜索 start/end 对的另一侧
searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
列表 搜索 start/end 队的另一侧
searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
列表 搜索 {pattern}
server2client({clientid}, {string})
数值 发送应答字符串
serverlist() 字符串 得到可用的服务器列表
setbufline({buf}, {lnum}, {text})
数值 设置缓冲区 {buf} 第 {lnum} 行为 {text}
setbufvar({buf}, {varname}, {val})
无 设置缓冲区 {buf} 的 {varname} 为 {val}
setcellwidths({list}) 无 设置字符单元宽度覆盖
setcharpos({expr}, {list}) 数值 设置 {expr} 的位置为 {list}
setcharsearch({dict}) 字典 从 {dict} 设置字符搜索选项
setcmdline({str} [, {pos}]) 数值 设置命令行
setcmdpos({pos}) 数值 设置命令行的光标位置
setcursorcharpos({list}) 数值 移动光标到 {list} 指定的位置
setenv({name}, {val}) 无 设置环境变量
setfperm({fname}, {mode}) 数值 设置 {fname} 文件权限为 {mode}
setline({lnum}, {line}) 数值 设置第 {lnum} 行的内容为 {line}
setloclist({nr}, {list} [, {action}])
数值 用 {list} 修改位置列表
setloclist({nr}, {list} [, {action} [, {what}]])
数值 修改指定的位置列表项目
setmatches({list} [, {win}]) 数值 还原匹配列表
setpos({expr}, {list}) 数值 设置 {expr} 的位置为 {list}
setqflist({list} [, {action}]) 数值 用 {list} 修改快速修复列表
setqflist({list} [, {action} [, {what}]])
数值 修改指定的快速修复列表项目
setreg({n}, {v} [, {opt}]) 数值 设置寄存器的值和类型
settabvar({nr}, {varname}, {val}) 无 设置标签页 {nr} 的 {varname} 变量为
{val}
settabwinvar({tabnr}, {winnr}, {varname}, {val})
无 设置标签页 {tabnr} 窗口 {winnr} 的
{varname} 变量为 {val}
settagstack({nr}, {dict} [, {action}])
数值 用 {dict} 修改标签栈
setwinvar({nr}, {varname}, {val}) 无 设置窗口 {expr} 的 {varname} 为 {val}
sha256({expr}) 字符串 字符串或 blob 的 SHA256 校验码
shellescape({string} [, {special}])
字符串 转义 {string} 以便用作外壳命令的参数
shiftwidth([{col}]) 数值 'shiftwidth' 的有效值
showdefinition({string} [, {options}])
无 在弹出中显示 {string} 的定义
sign_define({name} [, {dict}]) 数值 定义或更新标号
sign_define({list}) 列表 定义或更新一列标号
sign_getdefined([{name}]) 列表 得到已定义的标号的列表
sign_getplaced([{buf} [, {dict}]])
列表 得到已放置的标号的列表
sign_jump({id}, {group}, {buf})
数值 跳转到标号
sign_place({id}, {group}, {name}, {buf} [, {dict}])
数值 放置标号
sign_placelist({list}) 列表 放置一列标号
sign_undefine([{name}]) 数值 撤销标号的定义
sign_undefine({list}) 列表 撤销一列标号的定义
sign_unplace({group} [, {dict}])
数值 撤销标号的放置
sign_unplacelist({list}) 列表 撤销一列标号的放置
simplify({filename}) 字符串 尽可能简化文件名
sin({expr}) 浮点 {expr} 的正弦值
sinh({expr}) 浮点 {expr} 的双曲正弦值
slice({expr}, {start} [, {end}]) 字符串、列表或 blob
字符串、列表或 blob 的切片
sort({list} [, {how} [, {dict}]])
列表 排序 {list}，{how} 决定比较方式
sound_clear() 无 停止播放所有声音
sound_playevent({name} [, {callback}])
数值 播放事件声音
sound_playfile({path} [, {callback}])
数值 播放声音文件 {path}
sound_stop({id}) 无 停止播放声音 {id}
soundfold({word}) 字符串 按发音折叠 {word}
spellbadword() 字符串 光标所在的拼写错误的单词
spellsuggest({word} [, {max} [, {capital}]])
列表 拼写建议
split({expr} [, {pat} [, {keepempty}]])
列表 从 {pat} 分割的 {expr} 里构造 List
sqrt({expr}) 浮点 {expr} 的平方根
srand([{expr}]) 列表 取得 rand() 的种子
state([{what}]) 字符串 Vim 的当前状态
str2blob({list} [, {options}]) blob 转换字符串列表为 blob
str2float({expr} [, {quoted}]) 浮点 转换字符串为浮点数
str2list({expr} [, {utf8}]) 列表 把 {expr} 的每个字符转换为 ASCII/UTF-8
值
str2nr({expr} [, {base} [, {quoted}]])
数值 把字符串转换为数值
strcharlen({expr}) 数值 字符串 {expr} 的字符长度
strcharpart({str}, {start} [, {len} [, {skipcc}]])
字符串 {str} 从第 {start} 字符开始的 {len} 个
字符
strchars({expr} [, {skipcc}]) 数值 {expr} 字符串的字符计数
strdisplaywidth({expr} [, {col}]) 数值 {expr} 字符串的显示长度
strftime({format} [, {time}]) 字符串 使用指定格式排版时间
strgetchar({str}, {index}) 数值 从 {str} 取得字符 {index}
stridx({haystack}, {needle} [, {start}])
数值 {haystack} 里 {needle} 的位置
string({expr}) 字符串 {expr} 值得字符串表示
strlen({expr}) 数值 字符串 {expr} 的长度
strpart({str}, {start} [, {len} [, {chars}]])
字符串 {str} 从 {start} 字节开始的 {len} 个字
节/字符
strptime({format}, {timestring})
数值 把 {timestring} 转换为 unix 时间戳
strridx({haystack}, {needle} [, {start}])
数值 {haystack} 里最后一个 {needle} 的位置
strtrans({expr}) 字符串 翻译字符串，使之可以显示
strutf16len({string} [, {countcc}])
数值 {string} 里的 UTF-16 代码单元数
strwidth({expr}) 数值 {expr} 字符串的显示单元长度
submatch({nr} [, {list}]) 字符串/列表
":s" 或 substitute() 的特定匹配
substitute({expr}, {pat}, {sub}, {flags})
字符串 {expr} 里的所有 {pat} 被 {sub} 替代
swapfilelist() 列表 'directory' 找到的交换文件列表
swapinfo({fname}) 字典 关于交换文件 {fname} 的信息
swapname({buf}) 字符串 缓冲区 {buf} 的交换文件
synID({lnum}, {col}, {trans}) 数值 {lnum} 行 {col} 列所在的语法 ID
synIDattr({synID}, {what} [, {mode}])
字符串 syntax ID {synID} 的 {what} 属性
synIDtrans({synID}) 数值 {synID} 经过翻译的语法 ID
synconcealed({lnum}, {col}) 列表 关于隐藏的信息
synstack({lnum}, {col}) 列表 {lnum} 行 {col} 列所在的语法 ID 堆栈
system({expr} [, {input}]) 字符串 外壳命令/过滤 {expr} 的输出
systemlist({expr} [, {input}]) 列表 外壳命令/过滤 {expr} 的输出
tabpagebuflist([{arg}]) 列表 标签页里的缓冲区号列表
tabpagenr([{arg}]) 数值 当前或最后标签页的编号
tabpagewinnr({tabarg} [, {arg}]) 数值 标签页里当前窗口的编号
tagfiles() 列表 使用的标签文件
taglist({expr} [, {filename}]) 列表 匹配 {expr} 的标签列表
tan({expr}) 浮点 {expr} 的正切值
tanh({expr}) 浮点 {expr} 的双曲正切值
tempname() 字符串 临时文件的文件名
term_dumpdiff({filename}, {filename} [, {options}])
数值 显示两份截图的差异
term_dumpload({filename} [, {options}])
数值 显示一份屏幕截图
term_dumpwrite({buf}, {filename} [, {options}])
无 为终端窗口的内容进行截图
term_getaltscreen({buf}) 数值 取得备用屏幕标志位
term_getansicolors({buf}) 列表 取得 GUI 色彩模式的 ANSI 调色板
term_getattr({attr}, {what}) 数值 取得 {what} 属性的值
term_getcursor({buf}) 列表 取得终端光标位置
term_getjob({buf}) 作业 取得终端关联的作业
term_getline({buf}, {row}) 字符串 从终端取得一行文本行
term_getscrolled({buf}) 数值 取得终端的滚动数目
term_getsize({buf}) 列表 取得终端的大小
term_getstatus({buf}) 字符串 取得终端的状态
term_gettitle({buf}) 字符串 取得终端的标题
term_gettty({buf}, [{input}]) 字符串 取得终端的 tty 名
term_list() 列表 取得终端缓冲区的列表
term_scrape({buf}, {row}) 列表 取得终端屏幕的某行
term_sendkeys({buf}, {keys}) 无 给终端发送键序列
term_setansicolors({buf}, {colors})
无 设置 GUI 色彩模式的 ANSI 调色板
term_setapi({buf}, {expr}) 无 设置 terminal-api 函数名前缀
term_setkill({buf}, {how}) 无 设置停止终端作业的信号值
term_setrestore({buf}, {command}) 无 设置恢复终端的命令
term_setsize({buf}, {rows}, {cols})
无 设置终端的大小
term_start({cmd} [, {options}]) 数值 打开终端窗口并执行作业
term_wait({buf} [, {time}]) 数值 等待屏幕刷新
terminalprops() 字典 终端属性
test_alloc_fail({id}, {countdown}, {repeat})
无 使内存分配失败
test_autochdir() 无 系统启动中启动 'autochdir'
test_feedinput({string}) 无 给输入缓冲区增加键序列
test_garbagecollect_now() 无 为测试用，立即释放内存
test_garbagecollect_soon() 无 为测试用，尽快释放内存
test_getvalue({string}) 可变 得到内部变量的值
test_gui_event({event}, {args}) 布尔型 为测试用，生成 GUI 事件
test_ignore_error({expr}) 无 忽略特定的错误
test_mswin_event({event}, {args})
布尔型 为测试用，生成 MS-Windows 事件
test_null_blob() blob 用作测试的空值 (null)
test_null_channel() 通道 用作测试的空值 (null)
test_null_dict() 字典 用作测试的空值 (null)
test_null_function() 函数引用 用作测试的空值 (null)
test_null_job() 作业 用作测试的空值 (null)
test_null_list() 列表 用作测试的空值 (null)
test_null_partial() 函数引用 用作测试的空值 (null)
test_null_string() 字符串 用作测试的空值 (null)
test_null_tuple() 元组 用途测试的空元组
test_option_not_set({name}) 无 复位指示选项已设置的标志位
test_override({expr}, {val}) 无 Vim 内部覆盖用作测试
test_refcount({expr}) 数值 得到 {expr} 的引用计数
test_setmouse({row}, {col}) 无 为测试用，设置鼠标位置
test_settime({expr}) 无 用作测试的当前时间
test_srand_seed([{seed}]) 无 为 srand() 测试用，设置种子
test_unknown() 可变 用作测试的未知值
test_void() 可变 且作测试的无值 (void)
timer_info([{id}]) 列表 定时器信息
timer_pause({id}, {pause}) 无 暂停或继续定时器
timer_start({time}, {callback} [, {options}])
数值 新建定时器
timer_stop({timer}) 无 停止定时器
timer_stopall() 无 停止所有定时器
tolower({expr}) 字符串 字符串 {expr} 变为小写
toupper({expr}) 字符串 字符串 {expr} 变为大写
tr({src}, {fromstr}, {tostr}) 字符串 把 {src} 里的 {fromstr} 字符翻译为
{tostr} 字符
trim({text} [, {mask} [, {dir}]])
字符串 从 {text} 中删除 {mask} 中的字符
trunc({expr}) 浮点 浮点数 {expr} 截断小数点
tuple2list({tuple}) 列表 把 {tuple} 里的项目转为为列表
type({expr}) 数值 值 {expr} 的类型
typename({expr}) 字符串 {expr} 类型的描述
undofile({name}) 字符串 对应 {name} 的撤销文件名
undotree([{buf}]) 列表 撤销缓冲区 {buf} 的文件树
uniq({list} [, {func} [, {dict}]])
列表 从列表中删除相邻的重复项
uri_decode({string}) 字符串 URI-解码字符串
uri_encode({string}) 字符串 URI-编码字符串
utf16idx({string}, {idx} [, {countcc} [, {charidx}]])
数值 {string} 里 {idx} 字节的 UTF-16 索引
values({dict}) 列表 {dict} 的所有值
virtcol({expr} [, {list} [, {winid}])
数值或列表
光标或位置标记的屏幕列
virtcol2col({winid}, {lnum}, {col})
数值 屏幕上字符的字节索引
visualmode([{expr}]) 字符串 最近使用的可视模式
wildmenumode() 数值 'wildmenu' 模式是否激活
wildtrigger() 数值 开始通配扩展
win_execute({id}, {command} [, {silent}])
字符串 在窗口 {id} 执行 {command}
win_findbuf({bufnr}) 列表 寻找包含 {bufnr} 的窗口
win_getid([{win} [, {tab}]]) 数值 得到 {tab} 中 {win} 的窗口 ID
win_gettype([{nr}]) 字符串 窗口 {nr} 的类型
win_gotoid({expr}) 数值 转到 ID 为 {expr} 的窗口
win_id2tabwin({expr}) 列表 从窗口 ID 获得标签页与窗口
win_id2win({expr}) 数值 从窗口 ID 获得窗口号
win_move_separator({nr}) 数值 移动窗口的垂直分割符
win_move_statusline({nr}) 数值 移动窗口的状态行
win_screenpos({nr}) 列表 得到窗口 {nr} 的屏幕位置
win_splitmove({nr}, {target} [, {options}])
数值 移动窗口 {nr} 成为 {target} 的分割窗口
winbufnr({nr}) 数值 窗口 {nr} 的缓冲区号
wincol() 数值 光标所在的窗口列
windowsversion() 字符串 MS-Windows 操作系统版本
winheight({nr}) 数值 窗口 {nr} 的高度
winlayout([{tabnr}]) 列表 标签页 {tabnr} 的窗口布局
winline() 数值 光标所在的窗口行
winnr([{expr}]) 数值 当前窗口的编号
winrestcmd() 字符串 返回恢复窗口大小的命令
winrestview({dict}) 无 恢复当前窗口的视图
winsaveview() 字典 保存当前窗口的视图
winwidth({nr}) 数值 窗口 {nr} 的宽度
wordcount() 字典 字节/字符/单词统计
writefile({object}, {fname} [, {flags}])
数值 把行的 Blob 或 List 写到文件
{fname}
xor({expr}, {expr}) 数值 按位异或
此处并不包含所有函数，有些特定功能的函数移到了相应的单独帮助文件里。
返回类型指定 Vim9-script 使用的类型，见 vim9-types
abs({expr}) abs()
返回 {expr} 的绝对值。如果 {expr} 计算结果为 Float ，abs() 返
回 Float 。如果 {expr} 可以转换为 Number ，abs() 返回
Number 。否则报错并返回 -1。
示例:
echo abs(1.456)
1.456
echo abs(-5.456)
5.456
echo abs(-4)
4
也可用作 method :
Compute()->abs()
返回类型: Number 或 Float ，取决于 {expr}
acos({expr}) acos()
返回 {expr} 的反余弦值，类型为 Float ，范围在 [0, pi] 弧度之
间。
{expr} 的计算结果必须是 [-1, 1] 区间内的 Float 或 Number 。
否则 acos() 返回 "nan"。
示例:
:echo acos(0)
1.570796
:echo acos(-0.5)
2.094395
也可用作 method :
Compute()->acos()
返回类型: Float
add({object}, {expr}) add()
在 List 或 Blob {object} 末尾附加项目 {expr}。返回新生成的
List 或 Blob 。例如:
:let alist = add([1, 2, 3], item)
:call add(mylist, "woodstock")
注意 如果 {expr} 是 List ，它被作为单个项目追加。
extend() 则可用来连接 List 。
如果 {object} 是 Blob ，{expr} 必须是数值。
insert() 可用来在其它位置插入项目。
如果 {object} 不是 List 或 Blob ，返回 1。
也可用作 method :
mylist->add(val1)->add(val2)
返回类型: list<{type}> (取决于输入的 List ) 或 Blob
and({expr}, {expr}) and()
对两个参数进行按位与。参数会被转换为数值。参数如果是列表、字典
或浮点数会报错。
另见 or() 和 xor() 。
示例:
:let flag = and(bits, 0x80)
也可用作 method :
:let flag = bits->and(0x80)
返回类型: Number
append({lnum}, {text}) append()
当 {text} 为 List 时: 把 List 里的每个项目作为单独的文本
行，附加到当前缓冲区第 {lnum} 行之下。
否则，把 {text} 作为单个文本行，附加到当前缓冲区第 {lnum} 行之
下。
接受任何项目，并会被转换为字符串。
{lnum} 可为零，用于在第一行前插入一行。
{lnum} 的用法可见 getline() 。
如果失败 ({lnum} 越界或内存溢出)，返回 1，成功则返回 0。{text}
为空列表时，不管 {lnum} 为何，总返回零。
Vim9 脚本中非法参数或负数会报错。例如:
:let failed = append(line('$'), "# THE END")
:let failed = append(0, ["Chapter 1", "the beginning"])
mylist->append(lnum)
返回类型: Number
appendbufline({buf}, {lnum}, {text}) appendbufline()
类似于 append() ，但在指定缓冲区 {buf} 中附加文本。
此函数只能用于已载入的缓冲区。如有必要，可先调用 bufload() 。
{buf} 的用法可见 bufname() 。
{lnum} 是行号，在其下附加文本。注意 使用 line() 会引用当前缓
冲区而非正在追加的缓冲区。"$" 可用来附加于缓冲区末尾。除此以
外，不支持其他字符串值。
成功时返回 0，失败则返回 1。
Vim9 脚本中非法 {lnum} 会报错。
如果 {buf} 不是合法缓冲区或 {lnum} 不合法，报错。例如:
:let failed = appendbufline(13, 0, "# THE START")
不过，{text} 为空列表时，非法 {lnum} 也不会报错，因为并不实际
使用 {lnum}。
也可用作列表的 method ，基是作为第二个参数传递的:
mylist->appendbufline(buf, lnum)
返回类型: Number
argc([{winid}]) argc()
返回参数列表的文件数目。见 arglist 。
如果 {winid} 未给出，使用当前窗口的参数列表。
如果 {winid} 是 -1，使用全局参数列表。
不然，{winid} 指定参数列表所在的窗口: 窗口号或窗口 ID 均可。
如果 {winid} 参数不合法，返回 -1。
返回类型: Number
argidx() argidx()
返回参数列表的当前索引。0 对应首个文件。 argc() - 1 对应最后
一个文件。见 arglist 。
返回类型: Number
arglistid([{winnr} [, {tabnr}]]) arglistid()
返回参数列表 ID，该数值用于标识正在使用的参数列表。零代表全局
参数列表。见 arglist 。
参数非法时返回 -1。
如果没有参数，使用当前窗口。
如果只提供 {winnr}，使用当前标签页的指定窗口。
如果同时提供 {winnr} 和 {tabnr}，使用指定标签页的指定窗口。
{winnr} 可以是窗口号或 window-ID 。
返回类型: Number
argv([{nr} [, {winid}]]) argv()
返回参数列表第 {nr} 个参数。见 arglist 。"argv(0)" 对应首个参
数。例如:
:let i = 0
:while i < argc()
: let f = escape(fnameescape(argv(i)), '. ')
: exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
: let i = i + 1
:endwhile
如果 {nr} 参数未提供或为 -1，返回类型为 List 的完整
{arglist}。
{winid} 参数指定窗口 ID，见 argc() 。
关于 Vim 的命令行参数，可见 v:argv 。
如果参数列表中不存在第 {nr} 个参数，返回空串。如果 {winid} 参
数非法，则返回空列表。
返回类型: String
asin({expr}) asin()
返回 {expr} 的反正弦值，类型为 Float ，范围在 [-pi/2, pi/2]
弧度之间。
{expr} 的计算结果必须是 [-1, 1] 区间内的 Float 或 Number 。
如果 {expr} 越出 [-1, 1] 区间，返回 "nan"。如果 {expr} 不是
Float 或 Number ，返回 0.0。
示例:
:echo asin(0.8)
0.927295
:echo asin(-0.5)
-0.523599
也可用作 method :
Compute()->asin()
返回类型: Float
assert_ 函数文档在这里: assert-functions-details
atan({expr}) atan()
返回 {expr} 的反正切主值，类型为 Float ，范围在 [-pi/2, +pi/2]
弧度之间。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
:echo atan(100)
1.560797
:echo atan(-4.01)
-1.326405
也可用作 method :
Compute()->atan()
返回类型: Float
atan2({expr1}, {expr2}) atan2()
返回 {expr1} / {expr2} 的反正切值，类型为 Float ，范围在
[-pi, +pi] 弧度之间。
{expr1} 和 {expr2} 的计算结果必须是 Float 或 Number 。否则
返回 0.0。
示例:
:echo atan2(-1, 1)
-0.785398
:echo atan2(1, -1)
2.356194
也可用作 method :
Compute()->atan2(1)
返回类型: Float
autocmd_add({acmds}) autocmd_add()
新增一组自动命令和自动命令组。
{acmds} 参数是列表，其中每个项目为包含以下可选项目的字典:
bufnr 要新增局部于缓冲区的自动命令时使用的缓冲区号。
如果指定，忽略 "pattern" 项目。
cmd 此自动命令事件要执行的 Ex 命令
event 自动命令事件名。参见 autocmd-events 。参数可
以是单个事件名的字符串，也可以是包含多个事件名
的列表。
group 自动命令组名。参见 autocmd-groups 。如指定组
尚不存在，先创建之。如果不指定或为空，使用缺省
组。
nested 布尔型标志位，要新增支持嵌套的自动命令时设为
v:true。参见 autocmd-nested 。
once 布尔型标志位，要新增只执行一次的自动命令时设为
v:true。参见 autocmd-once 。
pattern 自动命令的模式串。参见 autocmd-patterns 。如
果指定 "bufnr" 项目，会忽略本项目。参数可以是
单个模式的字符串，也可以是包含多个模式的列表。
replace 布尔型标志位，设为 v:true 时，先删除和指定自动
命令事件和组关联的所有命令，再加入 {cmd}。这可
用于避免为同一组和同一事件重复添加相同的自动命
令。
成功时返回 v:true，而失败时返回 v:false。
示例:
" 为 5 号缓冲区创建局部于缓冲区的自动命令
let acmd = {}
let acmd.group = 'MyGroup'
let acmd.event = 'BufEnter'
let acmd.bufnr = 5
let acmd.cmd = 'call BufEnterFunc()'
call autocmd_add([acmd])
也可用作 method :
GetAutocmdList()->autocmd_add()
返回类型: vim9-boolean
autocmd_delete({acmds}) autocmd_delete()
删除一组自动命令和自动命令组。
{acmds} 参数是列表，其中每个项目为包含以下可选项目的字典:
bufnr 待删除的局部于缓冲区的自动命令的缓冲区号。如果
指定，忽略 "pattern" 项目。
cmd 此自动命令事件要执行的 Ex 命令
event 自动命令事件名。参见 autocmd-events 。如果为
'*'，删除此组中的所有自动命令事件。
group 自动命令组名。参见 autocmd-groups 。如果不指
定或为空，使用缺省组。
nested 布尔型标志位，要指定支持嵌套的自动命令时设为
v:true。参见 autocmd-nested 。
once 布尔型标志位，要指定只执行一次的自动命令时设为
v:true。参见 autocmd-once 。
pattern 自动命令的模式串。参见 autocmd-patterns 。如
果指定 "bufnr" 项目，会忽略本项目。
如果 {acmds} 字典只指定了 {group}，而未指定 {event}、{pattern}
和 {cmd}，删除整个自动命令组。
成功时返回 v:true，而失败时返回 v:false。
示例:
" :autocmd! BufLeave *.vim
let acmd = #{event: 'BufLeave', pattern: '*.vim'}
call autocmd_delete([acmd]})
" :autocmd! MyGroup1 BufLeave
let acmd = #{group: 'MyGroup1', event: 'BufLeave'}
call autocmd_delete([acmd])
" :autocmd! MyGroup2 BufEnter *.c
let acmd = #{group: 'MyGroup2', event: 'BufEnter',
\ pattern: '*.c'}
" :autocmd! MyGroup2 * *.c
let acmd = #{group: 'MyGroup2', event: '*',
\ pattern: '*.c'}
call autocmd_delete([acmd])
" :autocmd! MyGroup3
let acmd = #{group: 'MyGroup3'}
call autocmd_delete([acmd])
也可用作 method :
GetAutocmdList()->autocmd_delete()
返回类型: vim9-boolean
autocmd_get([{opts}]) autocmd_get()
返回自动命令 List 。如果不提供 {opts}，返回所有组里所有事件的
自动命令。
可选的 {opts} 字典参数支持以下项目:
group 自动命令组名。如果指定，只返回此组中定义的自动
命令。如果给出的组不存在，返回错误信息。如果设
为空串，使用缺省自动命令组。
event 自动命令事件名。如果指定，只返回为此事件定义的
自动命令。如为 "*"，返回所有事件的自动命令。如
果给出的事件不存在，返回错误信息。
pattern 自动命令模式。如果指定，只返回使用此模式定义的
自动命令。
{opts} 接受以上三者的组合。
返回列表中的每个项目是包含以下项目的字典:
bufnr 对局部于缓冲区的自动命令而言，此自动命令定义所
在的缓冲区号。
cmd 此自动命令执行的命令。
event 自动命令事件名。
group 自动命令组名。
nested 布尔型标志位，如果自动命令支持嵌套，设为
v:true。见 autocmd-nested 。
once 布尔型标志位，如果自动命令只执行一次，设为
v:true。参见 autocmd-once 。
pattern 自动命令模式。如果是局部于缓冲区的自动命令，
有以下形式 "<buffer=n>"。
如果同一组里的一个事件对应多个自动命令，每个命令都会作为单独的
项目返回。
如果对应指定组、事件或模式的自动命令不存在，返回空列表。
示例:
" :autocmd MyGroup
echo autocmd_get(#{group: 'Mygroup'})
" :autocmd G BufUnload
echo autocmd_get(#{group: 'G', event: 'BufUnload'})
" :autocmd G * *.ts
let acmd = #{group: 'G', event: '*', pattern: '*.ts'}
echo autocmd_get(acmd)
" :autocmd Syntax
echo autocmd_get(#{event: 'Syntax'})
" :autocmd G BufEnter *.ts
let acmd = #{group: 'G', event: 'BufEnter',
\ pattern: '*.ts'}
echo autocmd_get(acmd)
也可用作 method :
Getopts()->autocmd_get()
返回类型: list<dict<any>>
balloon_gettext() balloon_gettext()
返回气泡的当前文本。只用于字符串，不用于列表。如果气泡不存在，
返回空串。
返回类型: String
balloon_show({expr}) balloon_show()
在气泡中显示 {expr}。GUI 中 {expr} 作为字符串使用。而终端中
{expr} 可以是多行的列表。如果 {expr} 不是列表，将通过
balloon_split() 先进行分割。
如果 {expr} 为空，删除任何已存在的气泡。
示例:
func GetBalloonContent()
" ... 启动内容的获取
return ''
endfunc
set balloonexpr=GetBalloonContent()
func BalloonCallback(result)
call balloon_show(a:result)
endfunc
也可用作 method :
GetText()->balloon_show()
期待的用法是从 'balloonexpr' 启动气泡内容的获取。它应调用异步
方法，然后在其回调中执行 balloon_show()。'balloonexpr' 自
身可返回空字符串或任何占位符，例如 "载入中..."。
如果不能显示气泡，不做任何事，不会报错。
{仅当编译时加入 +balloon_eval 或 balloon_eval_term 特性才
有效}
返回类型: Number
balloon_split({msg}) balloon_split()
把字符串 {msg} 分割为方便在气泡中显示的多行。分割依据的是当前
窗口大小，并进行优化以显示调试器的输出。
返回分割后行的 List 。出错时返回空列表。
也可用作 method :
GetText()->balloon_split()->balloon_show()
{仅当编译时加入 balloon_eval_term 特性才有效}
返回类型: list<any> 或 list<string>
base64_decode({string}) base64_decode()
返回 blob，包含 {string} 里 base64 编码字符解码后的字节。
{string} 参数只能包含 base64-编码的字符，长度必须为 4 的倍数。
出错时返回空 blob。
示例:
" 把解码内容写到二进制文件
call writefile(base64_decode(s), 'tools.bmp')
" 解码 base64-编码的字符串
echo blob2str(base64_decode(encodedstr))
也可用作 method :
GetEncodedString()->base64_decode()
返回类型: Blob
base64_encode({blob}) base64_encode()
返回将 {blob} 里包含的字节进行 base64 编码后的字符串。使用 RFC
4648 定义的 base64 字母表。
示例:
" 对二进制文件内容进行编码
echo base64_encode(readblob('somefile.bin'))
" 对字符串进行编码
echo base64_encode(str2blob(somestr->split("\n")))
也可用作 method :
GetBinaryData()->base64_encode()
返回类型: String
bindtextdomain({package}, {path}) bindtextdomain()
将指定的 {package} 和 {path} 进行绑定，使得 gettext() 函数可
用于得到该包的特定语言翻译。{path} 为包含翻译文件的目录名。见
package-translation 。
成功时返回 v:true，而失败时返回 v:false (内存溢出)。
返回类型: vim9-boolean
blob2list({blob}) blob2list()
返回 {blob} 中每个字节对应的数值的列表。示例:
blob2list(0z0102.0304) 返回 [1, 2, 3, 4]
blob2list(0z) 返回 []
出错时返回空列表。 list2blob() 是其逆操作。
也可用作 method :
GetBlob()->blob2list()
返回类型: list<any> 或 list<number>
blob2str({blob} [, {options}]) blob2str()
返回 {blob} 中字节序列使用当前 'encoding' 转换为字符后组成的字
符串列表。
blob 里的每个 <NL> 字节视作字符串结束，并生成新列表项目。而
blob 里的每个 <NUL> 字节则被转换为 <NL> 字符。
如果 {options} 未提供，使用当前 'encoding' 值来解码 {blob} 里
的字节序列。
参数 {options} 为 Dict ，支持以下项目:
encoding 使用此编码来解码 {blob} 里的字节序列。 String
值。支持的值可见 encoding-names (加上特殊值
"none")。
E1515 E1516
当前 'encoding' 如为 "utf-8"，{blob} 发现非法字节序列时报错并
返回空列表。要抑制此种检验而不介意得到可能非法的字符串，将
{options} 里的 "encoding" 设为 "none"。
blob 为空时返回空列表。
另见 str2blob()
示例:
blob2str(0z6162) 返回 ['ab']
blob2str(0zC2ABC2BB) 返回 ['«»']
blob2str(0z610A62) 返回 ['a', 'b']
blob2str(0z610062) 返回 ['a\nb']
blob2str(0zABBB, {'encoding': 'latin1'}) 返回 ['«»']
也可用作 method :
GetBlob()->blob2str()
返回类型: list<string>
browse({save}, {title}, {initdir}, {default}) browse()
启动文件请求窗口。只有在 "has("browse")" 返回 TRUE 时 (只在
一些 GUI 版本里有效) 才可用。
输入的字段包括:
{save} TRUE 时，选择要写入的文件
{title} 请求窗口的标题
{initdir} 开始浏览的目录
{default} 缺省文件名
如果按了 "Cancel" 按钮、出错或者无法浏览，则返回空串。
返回类型: String
browsedir({title}, {initdir}) browsedir()
启动目录请求窗口。只有在 "has("browse")" 返回 TRUE 时 (只在
一些 GUI 版本里有效) 才可用。
有的系统上不支持目录浏览器，这时会使用文件浏览器。此种情况下:
请选择要用的目录里的一个文件。
输入的字段包括:
{title} 请求窗口的标题
{initdir} 开始浏览的目录
如果按了 "Cancel" 按钮、出错或者无法浏览，则返回空串。
返回类型: String
bufadd({name}) bufadd()
在缓冲区列表中加入名为 {name} (必须为字符串) 的缓冲区。
如果对应文件 {name} 的缓冲区已存在，返回该缓冲区号。否则返回新
建缓冲区的号。{name} 为空串时，总是建立新缓冲区。
该缓冲区未置位 'buflisted'，而且尚未加载。要在缓冲区中增加文
件:
let bufnr = bufadd('someName')
call bufload(bufnr)
call setbufline(bufnr, 1, ['some', 'text'])
出错时返回 0。
也可用作 method :
let bufnr = 'somename'->bufadd()
返回类型: Number
bufexists({buf}) bufexists()
返回数值，如果存在名为 {buf} 的缓冲区，返回 TRUE 。
{buf} 参数是数值时，指定缓冲区号。数值零指定当前窗口的轮换缓
冲区。
{buf} 参数是字符串时，必须完全匹配指定缓冲区名。该名可以是:
- 相对于当前目录的相对路径。
- 完整路径。
- 'buftype' 设为 "nofile" 时的缓冲区名。
- URL 名。
即使缓冲区不在列表中，也能被找到。
注意 帮助文件在 :buffers 里列出的是它们的短名字。但
bufexists() 需要它们的长名字才能找到它们。
bufexists() 可报告缓冲区存在，但要使用用于 :buffer 命令的名
字，可能需要借助 expand() 。尤其在 MS-Windows 中需要形如
"c:\DOCUME~1" 的 8.3 名字。
"bufexists(0)" 可用来测试轮换文件名是否存在。
也可用作 method :
let exists = 'somename'->bufexists()
返回类型: Number
已废弃的名字: buffer_exists()。 buffer_exists()
buflisted({buf}) buflisted()
返回数值，如果名为 {buf} 的缓冲区在列表中 (置位了 'buflisted'
选项)，返回 TRUE 。
{buf} 参数用法同 bufexists() 。
也可用作 method :
let listed = 'somename'->buflisted()
返回类型: Number
bufload({buf}) bufload()
确保缓冲区 {buf} 已加载。如果缓冲区名对应的文件存在件，读入该
文件。否则缓冲区保持为空。如果缓冲区已载入，则不作任何改变。如
果缓冲区不和文件相关 (例如 'buftype' 为 "nofile")，不读取文
件。如果缓冲区的文件已有交换文件，不弹出对话框，直接载入缓冲
区。
{buf} 参数的用法可见 bufexists() 。
也可用作 method :
eval 'somename'->bufload()
返回类型: Number
bufloaded({buf}) bufloaded()
返回数值，如果名为 {buf} 的缓冲区存在且已加载 (无论在窗口中显
示还是被隐藏)，返回 TRUE 。
{buf} 参数用法同 bufexists() 。
也可用作 method :
let loaded = 'somename'->bufloaded()
返回类型: Number
bufname([{buf}]) bufname()
返回缓冲区的名字，多数情况下与 ":ls" 命令显示的一致，但不会使
用诸如 "[未命名]" 那样的特别名称。
如果 {buf} 省略，使用当前缓冲区。
{buf} 参数为数值时，用来指定缓冲区号。数值零代表当前窗口的轮换
缓冲区。
{buf} 参数为字符串时，用作匹配缓冲区名字的 file-pattern 。这
里假设 'magic' 总是置位而 'cpoptions' 总为空。如果匹配超过一
个，返回空字符串。
可用 "" 或 "%" 来指定当前缓冲区，而 "#" 指定轮换缓冲区。
完整匹配优先，如果找不到，也接受在缓冲区名的开头，结尾或中间的
匹配。如果只接受完整匹配，在模式的开头加上 "^"，而结尾加 "$"。
列表内缓冲区优先。如果列表内有唯一的匹配，返回该缓冲区。否则，
继续在列表外的缓冲区里查找。
如果 {buf} 是字符串但想用作缓冲区号，可通过加零将它强制转化为
数值:
:echo bufname("3" + 0)
也可用作 method :
echo bufnr->bufname()
bufname("#") 轮换缓冲区名
bufname(3) 缓冲区 3 的名字
bufname("%") 当前缓冲区名
bufname("file2") 匹配 "file2" 的缓冲区名。
返回类型: String
buffer_name()
已废弃的名字: buffer_name()。
bufnr([{buf} [, {create}]]) bufnr()
返回缓冲区的编号，与 ":ls" 命令显示的一致。{buf} 的用法见上
bufname() 。
如果不存在符合条件的缓冲区，返回 -1。但如果提供了 {create} 参
数且为 TRUE，则会建立一个新的列表外缓冲区，并返回其编号。例
如:
let newbuf = bufnr('Scratch001', 1)
空名会指定当前缓冲区。要创建带空名的新缓冲区可用 bufadd() 。
bufnr("$") 对应最后一个缓冲区:
:let last_buffer = bufnr("$")
返回当前已存在缓冲区的最大编号，类型为数值。注意 较小的编号不
一定对应仍存在的缓冲区，因为可能已被 ":bwipeout" 永久删除。
bufexists() 可用来测试缓冲区是否存在。
也可用作 method :
echo bufref->bufnr()
返回类型: Number
已废弃的名字: buffer_number()。 buffer_number()
last_buffer_nr()
bufnr("$") 已废弃的名字: last_buffer_nr()。
bufwinid({buf}) bufwinid()
返回数值，与缓冲区 {buf} 相关联的首个窗口的 window-ID 。{buf}
的用法见上述 bufname() 。如果缓冲区 {buf} 不存在或没有对应窗
口，返回 -1。示例:
echo "包含缓冲区 1 的窗口是 " .. (bufwinid(1))
只处理当前标签页。要找到更多窗口可见 win_findbuf() 。
也可用作 method :
FindBuffer()->bufwinid()
返回类型: Number
bufwinnr({buf}) bufwinnr()
类似于 bufwinid() ，但返回窗口号而不是 window-ID 。
如果缓冲区 {buf} 不存在或没有对应窗口，返回 -1。例如:
echo "包含缓冲区 1 的窗口是 " .. (bufwinnr(1))
FindBuffer()->bufwinnr()
返回类型: Number
byte2line({byte}) byte2line()
返回当前缓冲区第 {byte} 个字节所在的行号。取决于当前缓冲区的
'fileformat' 选项，这可以包括不同的换行符。第一个字符的字节编
号为 1。
另见 line2byte() 、 go 和 :goto 。
如果 {byte} 值非法，返回 -1。
也可用作 method :
GetOffset()->byte2line()
返回类型: Number
{仅当编译时加入 +byte_offset 特性才有效}
byteidx({expr}, {nr} [, {utf16}]) byteidx()
返回字符串 {expr} 里第 {nr} 个字符的字节位置。零代表第一个字
符，此时返回零。
如果没有多字节字符，返回值总是等于 {nr}。
组合字符不单独计数，其字节长度加到其前导的基础字符上。要将组合
字符分别计数，见下 byteidxcomp() 。
如果给出 {utf16} 且为 TRUE，{nr} 用作字符串 {expr} 的 UTF-16
索引，而不是字符索引。UTF-16 索引是字符串以 16 位单词编码时的
索引。如果指定的 UTF-16 索引在某字符 (如 4-字节字符) 的内部，
返回该字符首个字节的字节索引。详见 string-offset-encoding 。
例如:
echo matchstr(str, ".", byteidx(str, 3))
显示第四个字符。另一个方法也能达到相同的效果:
let s = strpart(str, byteidx(str, 3))
echo strpart(s, 0, byteidx(s, 1))
另见 strgetchar() 和 strcharpart() 。
如果字符数不足 {nr}，返回 -1。
如果刚好有 {nr} 个字符，返回字符串的字节长度。
要从字节索引相应地获取字符索引和 UTF-16 索引，见 charidx()
和 utf16idx() 。
示例:
echo byteidx('a😊😊', 2) 返回 5
echo byteidx('a😊😊', 2, 1) 返回 1
echo byteidx('a😊😊', 3, 1) 返回 5
也可用作 method :
GetName()->byteidx(idx)
返回类型: Number
byteidxcomp({expr}, {nr} [, {utf16}]) byteidxcomp()
类似于 byteidx() ，但组合字符作为一个单独的字符计算。示例:
let s = 'e' .. nr2char(0x301)
echo byteidx(s, 1)
echo byteidxcomp(s, 1)
echo byteidxcomp(s, 2)
第一个和第三个 echo 返回 3 ('e' 加上组合字符是 3 个字节)，第二
个 echo 返回 1 ('e' 是一个字节)。
仅当 'encoding' 为某种 Unicode 编码时，结果才会和 byteidx()
有所不同。
也可用作 method :
GetName()->byteidxcomp(idx)
返回类型: Number
call({func}, {arglist} [, {dict}]) call() E699
调用函数 {func}，使用 List {arglist} 项目作为参数。
{func} 可以是 Funcref 或函数名。
调用时，a:firstline 和 a:lastline 都设为光标所在行。
返回所调函数的返回值。
{dict} 用于为函数指定 "dict" 属性。用于设置局部变量 "self"。
Dictionary-function
也可用作 method :
GetFunc()->call([arg, arg], dict)
返回类型: any，取决于 {func}
ceil({expr}) ceil()
返回浮点数形式的大于等于 {expr} 的最小整数 (向上取整)。
{expr} 的计算结果必须是浮点数或数值。
示例:
echo ceil(1.456)
2.0
echo ceil(-5.456)
-5.0
echo ceil(4.0)
4.0
如果 {expr} 不是 Float 或 Number ，返回 0.0。
也可用作 method :
Compute()->ceil()
返回类型: Float
ch_ 函数文档在这里: channel-functions-details
changenr() changenr()
返回最近的改变号。这和 :undolist 显示的编号一致，并可用于
:undo 命令。
对一般的改变，返回的是该改变的编号。对重做操作，返回的是重做改
变的编号。而对撤销操作，返回的是撤销改变的编号减一。
如果撤销列表为空，返回 0。
返回类型: Number
char2nr({string} [, {utf8}]) char2nr()
返回 {string} 首个字符，类型为数值。例如:
char2nr(" ") 返回 32
char2nr("ABC") 返回 65
{utf8} 省略或为零时，使用当前 'encoding'。
以 "utf-8" 为例:
char2nr("á") 返回 225
char2nr("á"[0]) 返回 195
{utf8} 为 TRUE 时，总是按 UTF-8 字符处理。
组合字符当作单独的字符。
nr2char() 是其逆操作。
要把字符串转换为字符对应数值的列表:
let str = "ABC"
let list = map(split(str, '\zs'), {_, val -> char2nr(val)})
结果是: [65, 66, 67]
如果 {string} 不是字符串型，返回 0。
也可用作 method :
GetChar()->char2nr()
返回类型: Number
charclass({string}) charclass()
返回 {string} 首个字符的字符类。
字符类为以下之一:
0 空白
1 标点
2 单词字符 (取决于 'iskeyword')
3 表情符号
其它 特定 Unicode 类 (译者注:
中日韩统一表意文字 0x4e00，或 19968
上标字符 0x2070，或 8304
下标字符 0x2080，或 8320
盲文 0x2800，或 10240
平假名 0x3040，或 12352
片假名 0x30a0，或 12448
谚文音节 0xac00，或 44032
)
此类用于模式匹配和单词动作。
如果 {string} 不是字符串型，返回 0。
返回类型: Number
charcol({expr} [, {winid}]) charcol()
同 col() ，但返回 {expr} 给出的列位置的字符索引，而非字节索
引。
示例:
当光标在第五行文本 "여보세요" 的 '세' 时:
charcol('.') 返回 3
col('.') 返回 7
GetPos()->col()
返回类型: Number
charidx({string}, {idx} [, {countcc} [, {utf16}]]) charidx()
返回 {string} 里第 {idx} 个字节所属字符的索引。
首个字符的索引为零。
如果字符串里不含多字节字符，返回值等于 {idx}。
{countcc} 省略或 FALSE 时，组合字符不单独计算，其字节长度会
加到前导的基本字符上。
{countcc} 为 TRUE 时，组合字符算作单独的字符。
{utf16} 给出且为 TRUE 时，{idx} 用作 {string} 的 UTF-16 索引，
而非字节索引。
如果参数非法或字节数不足 {idx}，返回 -1。如果正好有 {idx} 个字
节，返回字符串的字符长度。
如果首个参数不是字符串、第二个参数不是数值或第三个参数存在且非
零或一，报错。
想了解如何从字符索引得到字节索引，可参见 byteidx() 和
byteidxcomp() ，而要从字符索引得到 UTF-16 索引，可见
utf16idx 。
详见 string-offset-encoding 。
示例:
echo charidx('áb́ć', 3) 返回 1
echo charidx('áb́ć', 6, 1) 返回 4
echo charidx('áb́ć', 16) 返回 -1
echo charidx('a😊😊', 4, 0, 1) 返回 2
也可用作 method :
GetName()->charidx(idx)
返回类型: Number
chdir({dir} [, {scope}]) chdir()
将当前工作目录切换为 {dir}。改变目录的作用域见下:
{scope} 省略时，根据当前目录的作用域来切换当前工作目录:
- 如果设置了局部于窗口的目录 ( :lcd )，则在该作用域里改变
当前工作目录。
- 否则，如果设置了局部于标签页的目录 ( :tcd )，则在该作用
域里改变当前工作目录。
- 再不然，改变全局目录。
{scope} 给出时，只为其指定的作用域改变当前工作目录:
"window" 改变窗口局部目录。 :lcd
"tabpage" 改变标签页局部目录。 :tcd
"global" 改变全局目录。 :cd
{dir} 必须为字符串。
如果成功，返回上次的工作目录。把它传给下一个 chdir() 可以恢复
上次目录。
如果失败，返回空串。
示例:
let save_dir = chdir(newdir)
if save_dir != ""
" ... 做点事
call chdir(save_dir)
endif
GetDir()->chdir()
返回类型: String
cindent({lnum}) cindent()
返回第 {lnum} 行根据 C 缩进规则应有的缩进量，见 'cindent'。
缩进以空格计，因而与 'tabstop' 的值相关。{lnum} 的用法可见
getline() 。
如果 {lnum} 非法，返回 -1。
参见 C-indenting 。
也可用作 method :
GetLnum()->cindent()
返回类型: Number
clearmatches([{win}]) clearmatches()
清除当前窗口中之前通过 matchadd() 和 :match 命令定义的所有
匹配。
当 {win} 存在时，使用对应窗口号或窗口 ID 的窗口，而非默认的当
前窗口。
也可用作 method :
GetWin()->clearmatches()
返回类型: Number
cmdcomplete_info() cmdcomplete_info()
返回类型为 Dictionary 的命令行补全信息。见
cmdline-completion 。
其中的项目有:
cmdline_orig 补全开始前原始的命令行字符串。
pum_visible 弹出菜单可见则为 TRUE 。
见 pumvisible() 。
matches 所有补全候选组成的列表。每个项目都是字符串。
selected 选中项目的索引。首个项目的索引值为零。如果没选
中任何项目 (仅显示输入文本，或者在按 <Up> 或
<Down> 键查找历史记录时没有选中任何项目而重新
显示最近一次补全)，此值为 -1
如果没有尝试过补全、只有一个候选且已完整提供、或者出了错，返回
空 Dictionary 。
返回类型: dict<any>
col({expr} [, {winid}]) col()
返回 {expr} 给定的列位置的字节索引，类型为数值。
可接受的位置参见 getpos() 。
{expr} 为 "$" 表示光标行的行尾，此时返回光标行的字节总数加一。
{expr} 也可以是形如 [lnum, col] 的 List ，包含行号和列号。常
用于指定列号为 "$" 以得到特定行的末列列号。如果 "lnum" 或
"col" 超出范围，col() 返回零。
可选的 {winid} 参数表示从指定窗口而非从当前窗口中取值。
若需行号，可用 line() 。若同时需要行列号，可用 getpos() 。
若需屏幕列位置，可用 virtcol() 。而若需字符位置，可用
charcol() 。
注意 只能使用当前文件的位置标记。
例如:
col(".") 光标所在列
col("$") 光标行的长度加 1
col("'t") 位置标记 t 的列号
col("'" .. markname) 名为 markname 的位置标记的列号
首列的列号为 1。如果 {expr} 非法或找不到 ID 对应 {winid} 的窗
口，返回 0。
大写位置标记所指的列可能实际位于另一个缓冲区中。
激活 'virtualedit' 时，如果光标位于行尾之后，返回的光标所在列
位置为行尾列号加一。此外，使用 <Cmd> 的映射不移动光标，可以利
用此一特性获取插入模式下的列号:
:imap <F2> <Cmd>echowin col(".")<CR>
GetPos()->col()
返回类型: Number
complete({startcol}, {matches}) complete() E785
设置插入模式补全的匹配项列表。只能用于插入模式。通常在
CTRL-R = 的映射里调用 (见 i_CTRL-R )，在 <Cmd> 或
<ScriptCmd> 映射里调用也可。但不能在 CTRL-O 之后或表达式映射
里使用。
{startcol} 是行内待补全文本的起始字节偏移。从此位置到光标为止
的文本为原始文本，将要被匹配内容替代。这里用 col('.') 会得到空
串。而用 "col('.') - 1" 将使单个字符被匹配内容替代。
{matches} 必须是 List 。其中每个 List 项目是一个匹配项。
complete-items 说明匹配项可能的类型。忽略 'completeopt' 里的
"longest"。
注意 调用此函数后，不应插入任何会导致补全停止的内容。
像普通插入模式补全一样，可通过 CTRL-N 和 CTRL-P 选择匹配项。如
果设置了相关选项，会显示弹出菜单，见 ins-completion-menu 。
示例 (使用老式 Vim 脚本):
inoremap <F5> <C-R>=ListMonths()<CR>
func ListMonths()
call complete(col('.'), ['January', 'February', 'March',
\ 'April', 'May', 'June', 'July', 'August',
\ 'September', 'October', 'November', 'December'])
return ''
endfunc
示例 (使用 Vim9 脚本):
vim9script
def ListMonths(): string
const months = [ 'January', 'February', 'March', 'April',
'May', 'June', 'July', 'September', 'October',
'November', 'December']
complete(col('.'), months)
return ''
enddef
inoremap <F5> <ScriptCmd>ListMonths()<CR>
注意 此处返回空串，不然就会插
入一个零。
也可用作 method ，基是作为第二个参数传递的:
GetMatches()->complete(col('.'))
返回类型: Number
complete_add({expr}) complete_add()
把 {expr} 添加到匹配列表中。只能在用 'completefunc' 选项指定的
函数中调用。
失败时 (空字符串或者内存不足) 返回 0，匹配成功加入时返回 1，如
果匹配已在列表中，返回 2。
complete-functions 有 {expr} 的用法说明。与 'omnifunc' 返回
的列表中的单个项目相同。
也可用作 method :
GetMoreMatches()->complete_add()
返回类型: Number
complete_check() complete_check()
在寻找补全匹配时，检查输入的键。当匹配搜索可能耗时较长时使用。
如果匹配的搜索被中止，返回 TRUE 。否则返回零。
只能在用 'completefunc' 选项指定的函数中调用。
返回类型: Number
complete_info([{what}]) complete_info()
返回插入模式补全信息的 Dictionary 。见 ins-completion 。
其中包含的项目有:
completed 返回字典，包含当前选中项目在 "items" 中列出的
所有条目。
items 包含所有补全备选的列表。每个项目是一个字典，包
含 "word"、"abbr"、"menu"、"kind"、"info" 和
"user_data" 条目。
见 complete-items 。
matches 类似于 "items"，但只返回匹配当前查询的项目。如
果 "what" 里同时要求 "matches" 和 "items"，会
返回单个名叫 "items" 的列表，但每个项目会有一
个额外的 "match" 字段。
mode 包含当前补全模式名的字符串。
可用值见 complete_info_mode 。
preinserted_text
预插入的实际文本，见 preinserted() 。
pum_visible 弹出菜单可见则为 TRUE 。
见 pumvisible() 。
selected 选中项目的索引。首个项目的索引为零。如果没有选
中的项目(仅显示输入文本，或者在按 <Up> 或
<Down> 键时没有选中任何项目而重新显示最近一次
补全)，此值为 -1
complete_info_mode
mode 值是:
"" 不处于任何补全模式
"keyword" 关键字补全 i_CTRL-X_CTRL-N
"ctrl_x" 刚按下 CTRL-X i_CTRL-X
"scroll" i_CTRL-X_CTRL-E 或 i_CTRL-X_CTRL-Y 滚
动
"whole_line" 整行 i_CTRL-X_CTRL-L
"files" 文件名 i_CTRL-X_CTRL-F
"tags" 标签 i_CTRL-X_CTRL-]
"path_defines" 定义补全 i_CTRL-X_CTRL-D
"path_patterns" 头文件补全 i_CTRL-X_CTRL-I
"dictionary" 字典 i_CTRL-X_CTRL-K
"thesaurus" 同义词词典 i_CTRL-X_CTRL-T
"cmdline" Vim 命令行 i_CTRL-X_CTRL-V
"function" 用户定义补全 i_CTRL-X_CTRL-U
"omni" 全能补全 i_CTRL-X_CTRL-O
"spell" 拼写建议 i_CTRL-X_s
"eval" complete() 补全
"register" 寄存器中的单词 i_CTRL-X_CTRL-R
"unknown" 其它内部模式
提供可选的 {what} 列表参数时，仅返回 {what} 中列出的项目。
{what} 中不支持的项目被安静跳过。
要获取弹出菜单的位置和大小，可见 pum_getpos() 。也可以通过
CompleteChanged 事件中的 v:event 得到。
如果出错，返回空 Dictionary 。
示例:
" 取得所有项目
call complete_info()
" 只要 'mode'
call complete_info(['mode'])
" 只要 'mode' 和 'pum_visible'
call complete_info(['mode', 'pum_visible'])
GetItems()->complete_info()
返回类型: dict<any>
complete_match([{lnum}, {col}]) complete_match()
从给定位置开始反向查找，返回根据 'isexpand' 选项找到的匹配列
表。没有提供参数时，缺省使用当前光标位置。
每个匹配项表示为 [startcol, trigger_text]，其中:
- startcol: 补全应开始的列号，如果未找到触发器位置，则为 -1。
而对多字符触发器，返回其首个字符的列号。
- trigger_text: 匹配 'isexpand' 的触发器字符串，如果未找到匹配
或使用了缺省基于 'iskeyword' 的模式，则为空串。
'isexpand' 为空时，使用基于 'iskeyword' 的模式 "\k\+$" 来查找
当前关键字的开始位置。
示例:
set isexpand=.,->,/,/*,abc
func CustomComplete()
let res = complete_match()
if res->len() == 0 | return | endif
let [col, trigger] = res[0]
let items = []
if trigger == '/*'
let items = ['/** */']
elseif trigger == '/'
let items = ['/*! */', '// TODO:', '// fixme:']
elseif trigger == '.'
let items = ['length()']
elseif trigger =~ '^\->'
let items = ['map()', 'reduce()']
elseif trigger =~ '^\abc'
let items = ['def', 'ghk']
endif
if items->len() > 0
let startcol = trigger =~ '^/' ? col : col + len(trigger)
call complete(startcol, items)
endif
endfunc
inoremap <Tab> <Cmd>call CustomComplete()<CR>
返回类型: list<list<any>>
confirm({msg} [, {choices} [, {default} [, {type}]]]) confirm()
confirm() 弹出对话框，让用户从中进行选择。返回选项的序号。首个
个选项的序号为 1。
注意: 仅当编译时加入对话框支持，confirm() 才可用，见
+dialog_con 、 +dialog_con_gui 和 +dialog_gui 。
在 dialog 里显示 {msg} 消息，并提供可能的选项 {choices}。
{choices} 不存在或为空时，缺省使用 "&OK" (会经过翻译)。
{msg} 是字符串，其中 '\n' 用于换行。在有些系统上，字符串显示不
下时会自动回绕，但并非所有系统都如此。
{choices} 是字符串，其中 '\n' 用于分隔各个选项，例如
confirm("Save changes?", "&Yes\n&No\n&Cancel")
'&' 之后的字符用作快捷键。例如，可以输入 'c' 来选择 "Cancel"。
快捷键不必是首字符:
confirm("file has been modified", "&Save\nSave &All")
控制台里，每个选项的首个字符用作缺省的快捷键。忽略大小写。
可选的 {default} 参数指定按 <CR> 时使用的选项序号。1 使得首选
项成为缺省，0 则不设定任何缺省。{default} 省略时，默认值为 1。
可选的 {type} 字符串参数指定对话框的类型。仅在 GTK、Mac、Motif
和 Win32 GUI 上生效，用于指定图标。可选值为: "Error"、
"Question"、"Info"、"Warning" 或 "Generic"。仅首字符起作用。
{type} 省略时，默认值为 "Generic"。
如果用户按 <Esc>、CTRL-C 或其它合法的中断键中止了对话框，
confirm() 返回 0。
示例:
let choice = confirm("想吃点什么？",
\ "苹果(&A)\n桔子(&O)\n香蕉(&B)", 2)
if choice == 0
echo "快下定决心！"
elseif choice == 3
echo "好吃"
else
echo "我还是喜欢香蕉。"
endif
GUI 对话框使用按钮。按钮的排列方式取决于 'guioptions' 中的 'v'
标志位。如果包含，按钮总为竖排。否则，confirm() 会先尝试横向排
列按钮。放不下时，再改为竖排。有的系统上，无论设置如何，总为横
排。
也可用作 method :
BuildMessage()->confirm("&Yes\n&No")
返回类型: Number
copy({expr}) copy()
构造 {expr} 的备份。对于数值和字符串，这与直接使用 {expr} 并无
不同。
{expr} 是 List 时，建立一个浅备份。这意味着原 List 上的修
改不会影响新建的备份。反之亦然。不过，各项目共用同一对象，所以
项目的修改会同时影响两个 List 。
Tuple 或 Dictionary 的复制方式与 List 类同。
另见 deepcopy() 。
也可用作 method :
mylist->copy()
返回类型: any，取决于 {expr}
cos({expr}) cos()
返回以弧度测量的 {expr} 的余弦值，类型为 Float 。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
:echo cos(100)
0.862319
:echo cos(-4.01)
-0.646043
也可用作 method :
Compute()->cos()
返回类型: Float
cosh({expr}) cosh()
返回 {expr} 的双曲余弦值，类型为 Float ，范围在 [1, inf] 之
间。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
:echo cosh(0.5)
1.127626
:echo cosh(-0.5)
-1.127626
也可用作 method :
Compute()->cosh()
返回类型: Float
count({comp}, {expr} [, {ic} [, {start}]]) count() E706
返回 String 、 List 、 Tuple 或 Dictionary 类型的 {comp}
中，等于 {expr} 的元素个数。
{start} 给出时，从该索引指定的项目开始。{start} 只能用于
List 或 Tuple 。
{ic} 给出且为 TRUE 时，忽略大小写。
{comp} 为字符串时返回 {expr} 不重叠出现的次数。{expr} 为空串时
返回零。
也可用作 method :
mylist->count(val)
返回类型: Number
cscope_connection([{num} , {dbpath} [, {prepend}]]) cscope_connection()
检查 cscope 连接是否存在。无参数时，函数返回:
0，表示 cscope 不可用 (编译时未启用该特性) 或者没有任
何 cscope 连接；
1，表示至少存在一个 cscope 连接。
参数给出时，{num} 值指定 cscope 连接是否存在的检查方式:
{num} 存在检查方式的描述
----- ------------------------------
0 等同于无参数 (例如，"cscope_connection()")。
1 忽略 {prepend}，部分匹配 {dbpath} 字符串。
2 忽略 {prepend}，完整匹配 {dbpath} 字符串。
3 使用 {prepend}，部分匹配 {dbpath} 和 {prepend} 字符
串。
4 使用 {prepend}，完整匹配 {dbpath} 和 {prepend} 字符
串。
注意: 所有字符串比较均对大小写敏感！
示例。假定我们有如下设置 (来自 ":cs show" 的输出):
# pid database name prepend path
0 27664 cscope.out /usr/local
启动方式 返回值
---------- ----------
cscope_connection() 1
cscope_connection(1, "out") 1
cscope_connection(2, "out") 0
cscope_connection(3, "out") 0
cscope_connection(3, "out", "local") 1
cscope_connection(4, "out") 0
cscope_connection(4, "out", "local") 0
cscope_connection(4, "cscope.out", "/usr/local") 1
返回类型: Number
cursor({lnum}, {col} [, {off}]) cursor()
cursor({list})
定位光标到第 {lnum} 行第 {col} 列 (按字节计数)。首列列号为 1。
只有一个参数 {list} 时，用作带两、三或四个参数的 List :
[{lnum}, {col}]
[{lnum}, {col}, {off}]
[{lnum}, {col}, {off}, {curswant}]
这与 getpos() 和 getcurpos() 的返回值类似，但不包含第一
项。
要按字符计数使用 {col} 来定位光标，可用 setcursorcharpos() 。
不改变跳转表。
{lnum} 的用法可见 getline() ，但 {lnum} 为零除外，此时光标留
在当前行。
如果 {lnum} 超过缓冲区的总行数，光标定位在缓冲区末行。
如果 {col} 超过该行的字节总数，光标定位在该行的末字符上。
如果 {col} 为零，光标留在当前列。
{curswant} 给出时，用于设置垂直移动的首选列，否则使用 {col}。
'virtualedit' 激活时，{off} 指定从该字符开始按屏幕列计算的偏
移量。例如 <Tab> 内部或行尾之后的位置。
定位成功时返回 0，否则返回 -1。
也可用作 method :
GetCursorPos()->cursor()
返回类型: Number
debugbreak({pid}) debugbreak()
专用于中断待调试的程序。给进程 {uid} 发送 SIGTRAP。其它进程的
行为未指定。见 terminal-debugger 。
{仅适用于 MS-Windows}
如果成功中断了程序返回 TRUE 。否则返回 FALSE 。
也可用作 method :
GetPid()->debugbreak()
返回类型: Number
deepcopy({expr} [, {noref}]) deepcopy() E698
构造 {expr} 的备份。对数值和字符串而言，这和直接使用 {expr}
并无不同。
如果 {expr} 是 List ，建立一个完整的备份。这意味着，原来的
List 可以被改变，而不会影响新建的备份。反之亦然。如果某个项
目是 List 或 Dictionary ，递归地建立它的备份。这样，备份里
项目的修改也不会影响到原来 List 的内容。
Tuple 或 Dictionary 的复制和 List 类似。
如果省略 {noref} 或为零，包含的 List 或 Dictionary 只复制
一次。所有指向它的引用指向此一备份。如果 {noref} 设为 1，每次
List 或 Dictionary 的出现会导致建立一个新的备份。这意味着
循环引用会使得 deepcopy() 失败。
E724
嵌套可达 100 层。如果有指向较高层的引用，{noref} 为 1 的深备份
会失败。
另见 copy() 。
也可用作 method :
GetObject()->deepcopy()
返回类型: any，取决于 {expr}
delete({fname} [, {flags}]) delete()
无 {flags} 或 {flags} 为空: 删除名为 {fname} 的文件。
{fname} 可以是符号链接。符号链接本身被删除，而不是它链接到的文
件。
如果 {flags} 是 "d": 删除名为 {fname} 的目录。如果目录 {fname}
非空会失败。
如果 {flags} 是 "rf": 递归删除名为 {fname} 的目录和其下的所有
文件。 要小心 ！
备注: 在 MS-Windows 上不能删除正在使用的目录。
返回类型为数值。如果成功删除文件，返回 0/false，如果删除失败或
部分失败，返回 -1/御前。
从 List 里删除项目请用 remove() 。
要删除缓冲区的行用 :delete 或 deletebufline() 。
也可用作 method :
GetName()->delete()
返回类型: Number
deletebufline({buf}, {first} [, {last}]) deletebufline()
删除缓冲区 {buf} 中 {first} 到 {last} (闭区间) 的文本行。
如果省略 {last}，只删除第 {first} 行。
成功时返回 0，失败时返回 1。
此函数只能用于已载入的缓冲区。有必要的话先调用 bufload() 。
{buf} 的用法见上述的 bufname() 。
{first} 和 {last} 的用法可见 getline() 。注意 line() 指定当
前缓冲区。"$" 指定缓冲区 {buf} 的末行。
也可用作 method :
GetBuffer()->deletebufline(1)
返回类型: Number
did_filetype() did_filetype()
如果执行自动命令时，激活 FileType 事件至少一次，则返回
TRUE 。可以用于防止在检测文件类型的脚本里再次激活 FileType 事
件。 FileType
如果用过 ":setf FALLBACK"，返回 FALSE 。
如果编辑另外一个文件，该计数被复位，因而这只能检查 FileType 事
件是否在当前缓冲区里激活过。它允许开始编辑另一个缓冲区的自动命
令设置 'filetype' 并载入语法文件。
返回类型: Number
diff({fromlist}, {tolist} [, {options}]) diff()
返回包含 {fromlist} 和 {tolist} 里字符串的差异的字符串或列
表。使用 Vim 内部 diff 库来计算差异。
E106
{options} 里可选的 "output" 项目指定返回的 diff 格式。支持以下
值:
indices 返回每个差异块的起始与结束索引还有字符串计数的
列表。
unified 返回合并风格的 (unified) diff 输出字符串。这是
缺省。
如果 {options} 里的 "output" 项目为 "indices"，返回列表。每个
列表项目包含对应一个差异块的带以下字段的字典:
from_idx 此差异块在 {fromlist} 里的开始索引。
from_count 此差异块在 {fromlist} 里被新增/删除/修改的字符
串数目。
to_idx 此差异块在 {tolist} 里的开始索引。
to_count 此差异块在 {tolist} 里被新增/删除/修改的字符串
数目。
{options} 字典参数也能指定比较选项 (类似于 'diffopt')，支持以
下项目:
algorithm 指定使用的比较算法的字典。支持的布尔
项目为 "myers"、"minimal"、"patience"
和 "histogram"。
context 差异文上下文行数。缺省为 0。
iblank 忽略全空白行的改动。
icase 忽略文本大小写的更改。
indent-heuristic 内部比较库使用缩进启发。
iwhite 忽略空白字符数目的更改。
iwhiteall 忽略所有空白字符的更改。
iwhiteeol 忽略行尾空白字符的更改。
这些选项的更多信息详见 'diffopt'。
为了计算合并风格的 diff，用换行符连接 {fromlist} 里的所有项
目，然后对 {tolist} 同样处理。合并风格的 diff 输出使用行号。
如果 {fromlist} 和 {tolist} 等同，返回空列表或空串。
示例:
:echo diff(['abc'], ['xxx'])
@@ -1 +1 @@
-abc
+xxx
:echo diff(['abc'], ['xxx'], {'output': 'indices'})
[{'from_idx': 0, 'from_count': 1, 'to_idx': 0, 'to_count': 1}]
:echo diff(readfile('oldfile'), readfile('newfile'))
:echo diff(getbufline(5, 1, '$'), getbufline(6, 1, '$'))
更多例子可见 diff-func-examples
也可用作 method :
GetFromList->diff(to_list)
返回类型: String 或 list<dict<number>> 或 list<any>
取决于 {options}
diff_filler({lnum}) diff_filler()
返回第 {lnum} 行之上的填充行的数目。
这些是在另一个进行比较的窗口里在此位置插入的行。这些填充行在屏
幕上显示，但缓冲区里并不存在。
{lnum} 的用法可见 getline() 。所以 "." 是当前行，"'m" 是位置
标记 m，等等。
如果当前窗口不处于比较模式，返回 0。
也可用作 method :
GetLnum()->diff_filler()
返回类型: Number
diff_hlID({lnum}, {col}) diff_hlID()
返回比较模式下行 {lnum} 和列 {col} (字节位置) 所在的高亮 ID。
如果当前行没有差异，返回零。
{lnum} 的用法可见 getline() 。所以 "." 是当前行，"'m" 是位置
标记 m，等等。
最左列的 {col} 为 1，第一行的 {lnum} 为 1。
高亮 ID 可以用于 synIDattr() ，以得到高亮对应的语法信息。
也可用作 method :
GetLnum()->diff_hlID(col)
返回类型: Number
digraph_get({chars}) digraph_get() E1214
返回 {chars} 对应的二合字母。必须是包含两个字符的字符串。如果
{chars} 不是两个字符或者 {chars} 对应的二合字母不存在，报错并
返回空串。
如有需要，字符会从 Unicode 转化为 'encoding'。此种转换必须可
行，有时可能会失败。
另见 digraph_getlist() 。
示例:
" 得到内建的二合字母
:echo digraph_get('00') " 返回 '∞'
" 得到用户定义的二合字母
:call digraph_set('aa', 'あ')
:echo digraph_get('aa') " 返回 'あ'
也可用作 method :
GetChars()->digraph_get()
返回类型: String
仅当编译时加入 +digraphs 特性才有效。如果此特性被关闭，此函
数会报错。
digraph_getlist([{listall}]) digraph_getlist()
返回二合字母的列表。如果给出 {listall} 参数且为 TRUE，返回所有
二合字母，包括缺省的二合字母。不然，只返回用户定义的二合字母。
如有需要，字符会从 Unicode 转化为 'encoding'。此种转换必须可
行，有时可能会失败。
另见 digraph_get() 。
示例:
" 得到用户定义的二合字母
:echo digraph_getlist()
" 得到所有的二合字母，包括缺省的二合字母
:echo digraph_getlist(1)
也可用作 method :
GetNumber()->digraph_getlist()
返回类型: list<list<string>>
仅当编译时加入 +digraphs 特性才有效。如果此特性被关闭，此函
数会报错。
digraph_set({chars}, {digraph}) digraph_set()
把二合字母 {chars} 加到列表。{chars} 必须是包含两个字符的字符
串。{digraph} 为包含单个 UTF-8 编码字符的字符串。 E1215
小心， 不 忽略组合字符。此函数和 :digraphs 命令类似，但对加
入由空白开始的二合字母有用。
如果 digraph 已注册，函数返回 v:true。如果失败，报错并返回
v:false。
要同时定义多个二合字母，可用 digraph_setlist() 。
示例:
call digraph_set(' ', 'あ')
也可用作 method :
GetString()->digraph_set('あ')
返回类型: vim9-boolean
仅当编译时加入 +digraphs 特性才有效。如果此特性被关闭，此函
数会报错。
digraph_setlist({digraphlist}) digraph_setlist()
类似于 digraph_set() ，但此函数一次加入多个二合字母。
{digraphlist} 为列表组成的列表，每个列表包含两个字符串，即
digraph_set() 里描述的 {chars} 和 {digraph}。 E1216
示例:
call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
功能相当于:
for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
call digraph_set(chars, digraph)
endfor
区别在于，如果出现第一个错误，函数立即返回，后续的二合字母不再
加入。
也可用作 method :
GetList()->digraph_setlist()
返回类型: vim9-boolean
仅当编译时加入 +digraphs 特性才有效。如果此特性被关闭，此函
数会报错。
echoraw({expr}) echoraw()
照原样输出 {expr}，包括非显示字符。可用于输出终端代码。例如，
要关闭 modifyOtherKeys:
call echoraw(&t_TE)
要再次打开之:
call echoraw(&t_TI)
使用时要小心，容易把终端搞乱。
返回类型: Number
empty({expr}) empty()
如果 {expr} 为空，返回数值 1，否则返回 0。
- List 、 Tuple 或 Dictionary 没有项目时为空。
- String 的长度为零时为空。
- Number 或 Float 的值为零时为空。
- v:false 、 v:none 和 v:null 为空， v:true 不是。
- 启动失败的 Job 为空。
- 己关闭的 Channel 为空。
- Blob 的长度为零时为空。
- Object (如果对象存在) 的 empty() 方法返回真值时为空
如果 List 很大，这比把长度和零比较要快得多。
也可用作 method :
mylist->empty()
返回类型: Number
environ() environ()
返回所有的环境变量构成的字典。可以这样检查某个环境变量是否存
在:
:echo has_key(environ(), 'HOME')
注意 变量名可以是驼峰式 (CamelCase) 的，要忽略大小写，可以这
样:
:echo index(keys(environ()), 'HOME', 0, 1) != -1
返回类型: dict<string>
err_teapot([{expr}]) err_teapot()
生成编号为 418 的错误，为实现 RFC 2324 而设计。
如果 {expr} 存在且为 TRUE，给出 503 错误，指示咖啡暂未准备好。
{expr} 存在时必须为字符串 (译者注: 原文如此)。
返回类型: Number
escape({string}, {chars}) escape()
在 {string} 里用反斜杠转义 {chars} 里的字符。例如:
:echo escape('c:\program files\vim', ' \')
返回:
c:\\program\ files\\vim
另见 shellescape() 和 fnameescape() 。
也可用作 method :
GetText()->escape(' \')
返回类型: String
eval({string}) eval()
计算 {string} 并返回其结果。这对把 string() 的结果转换为原来
的值尤其有用。适用于数值、浮点数、字符串、blob 和它们的复合类
型。也可用于指向已有函数的 Funcref 。 Vim9 脚本里，可用于从
enum 的完全限定名获取对应的值。
也可用作 method :
argv->join()->eval()
返回类型: any，取决于 {string}
eventhandler() eventhandler()
如果在事件处理中则返回 1。此时，Vim 在等待用户输入一个字符的时
候被中断，比如，在 Vim 上拖放了一个文件。这也意味着此时不能使
用交互的命令。如果不是，返回零。
返回类型: Number
executable({expr}) executable()
本函数检查名字由 {expr} 指定的可执行文件存在与否。{expr} 必须
是程序不带任何参数的名字。
executable() 使用 $PATH 的值和/或程序的普通的搜索路径。
PATHEXT
MS-Windows 上，可以可选地包含 ".exe"、".bat" 等。为此，
$PATHEXT 里的扩展名会被尝试。这样，如果 "foo.exe" 不存在，可能
会找到 "foo.exe.bat"。如果没有设置 $PATHEXT，使用的是
".com;.exe;.bat;.cmd"。$PATHEXT 里可以使用单独的句号，以尝试没
有扩展名的名字。如果 'shell' 看起来像 Unix 外壳，那么也尝试没
有扩展名的名字。
MS-Windows 上，只检查是否文件存在且不是目录，并不检查它是否真
的可以执行。
MS-Windows 上，和 Vim 程序在同一目录的可执行文件通常能找到。因
为这个目录加到了 $PATH 里，执行应该也没有问题 win32-PATH 。
NoDefaultCurrentDirectoryInExePath
MS-Windows 上，Vim 当前工作目录下的可执行文件通常也能找到，但
此行为可通过设置 $NoDefaultCurrentDirectoryInExePath 环境变量
来关闭。
返回数值:
1 存在
0 不存在
-1 此系统中没有实现
exepath() 可用于获取可执行文件的完整路径。
也可用作 method :
GetCommand()->executable()
返回类型: Number
execute({command} [, {silent}]) execute()
执行 Ex 命令或命令序列，返回结果为字符串。
{command} 可以是字符串或列表。如果是列表，逐行执行命令。
这或多或少等价于:
redir => var
{command}
redir END
但不识别 {command} 里的续行。
可选的 {silent} 参数可取以下的值:
"" 不用 :silent
"silent" 用 :silent
"silent!" 用 :silent!
缺省是 "silent"。注意 用 "silent!" 时，和 :redir 不同，错误
被忽略。使用外部命令时，屏幕可能会搞乱，可用 system() 代替。
E930
{command} 里不可用 :redir 。
要得到行的列表，在结果上用 split() :
execute('args')->split("\n")
GetCommand()->execute()
返回类型: String
exepath({expr}) exepath()
如果 {expr} 是可执行文件并且是绝对路径、相对路径或可在 $PATH
是找到，返回完整路径。
注意 如果 {expr} 以 "./" 开始，使用当前路径，这对 Vim 可能是个
问题:
echo exepath(v:progpath)
如果 {expr} 在 $PATH 里找不到，或者不可执行，返回空字符串。
也可用作 method :
GetCommand()->exepath()
返回类型: String
exists({expr}) exists()
返回数值，如果 {expr} 被定义，返回 TRUE ，不然返回零。
备注: 在编译过的 :def 函数里，计算在运行时完成。要在编译时计
算表达式，可用 exists_compiled() 。
要检查某特性是否支持，用 has() 。
要检查文件是否存在，用 filereadable() 。
{expr} 参数是字符串，可以使用以下选择之一:
varname 内部变量 (见 internal-variables )。也
dict.key 适用于 curly-braces-names 、
list[i] Dictionary 项目、 List 项目、类和对
import.Func 象方法、导入项目等等。
class.Func 不适用于编译过的 :def 函数里的局部变
object.Func 量。
class.varname 也可用于 Vim9 脚本里的函数，因为它被
object.varname 视作函数引用。
小心计算索引时可能会因为非法的表达式产
生错误信息。例如:
:let l = [1, 2, 3]
:echo exists("l[5]")
0
:echo exists("l[xx]")
E121: Undefined variable: xx
0
&option-name Vim 选项 (只检查是否存在，而不是是否工
作)
+option-name 能工作的 Vim 选项。
$ENVNAME 环境变量 (也可以通过和空字符串比较完
成)
*funcname 已实现的内建函数 (见 functions ) 或者
用户定义的函数 (见 user-functions )。
也可用于指向函数引用的变量。
?funcname 可实现的内建函数；用于检查 "funcname"
是否合法
:cmdname Ex 命令: 内建命令、用户命令或者命令修
饰符 :command 。
返回:
1 匹配命令的开始
2 完整匹配命令
3 匹配多个用户命令
要检查命令是否支持，检查返回值是否为
2。
:2match :2match 命令。
:3match :3match 命令 (你可能用不上，这是为内
部保留的)。
#event 符合此事件的自动命令
#event#pattern 符合此事件和此模式的自动命令 (模式按本
义出现，和自动命令的模式逐字符比较)
#group 存在自动命令组
#group#event 在该组里定义并符合此事件的自动命令。
#group#event#pattern
为该组定义、符合事件和模式的自动命令。
##event 支持此事件的自动命令。
例如:
exists("&shortname")
exists("$HOSTNAME")
exists("*strftime")
exists("*s:MyFunc") " 只适用于老式脚本
exists("*MyFunc")
exists("bufcount")
exists(":Make")
exists("#CursorHold")
exists("#BufReadPre#*.gz")
exists("#filetypeindent")
exists("#filetypeindent#FileType")
exists("#filetypeindent#FileType#*")
exists("##ColorScheme")
符号 (&/$/*/#) 和名字之间不能有空格。
名字之后不能有附加字符，虽然现在有一些情况下会忽略这些字符，但
将来的检查可能更严格。所以不要依赖此行为！
可以通过的例子:
exists(":make")
不 能通过的例子:
exists(":make install")
注意 参数必须是字符串，不是变量的名字本身。例如:
exists(bufcount)
不检查 "bufcount" 变量是否存在，而是提取 "bufcount" 的值，并检
查其 (根据此处的语法) 是否存在。
也可用作 method :
Varname()->exists()
返回类型: String
exists_compiled({expr}) exists_compiled()
类似于 exists() 但在编译时计算。可用于跳过函数未定义时会报错
的程序块:
if exists_compiled('*ThatFunction')
ThatFunction('works')
endif
如果用 exists() ，ThatFunction() 未定义时会报告编译错误。
{expr} 必须是按本义出现的字符串。 E1232
只可用于 :def 函数中。 E1233
不能用于检查参数或局部变量。
返回类型: String
exp({expr}) exp()
返回 {expr} 的指数函数值，返回值为 [0, inf] 区间内的浮点数。
{expr} 的计算结果必须是 Float 或者 Number 。否则返回 0.0。
示例:
:echo exp(2)
7.389056
:echo exp(-1)
0.367879
也可用作 method :
Compute()->exp()
返回类型: Float
expand({string} [, {nosuf} [, {list}]]) expand()
扩展 {string} 里的通配符和下列特殊关键字。
'wildignorecase' 此处适用。
如果给出 {list} 且为 TRUE ，返回列表。否则返回的是字符串，且
如果返回多个匹配，以 <NL> 字符分隔 [备注: 5.0 版本使用空格。但
是文件名如果也包含空格就会有问题]。
如果扩展失败，返回空字符串。如果 {string} 以 '%'，'#' 或 '<'
开始，不返回不存在的文件名。详见下。
:terminal 窗口里 '%' 扩展为 '!' 后跟运行中的命令或外壳。
terminal-bufname
如果 {string} 以 '%'、'#' 或 '<' 开始，以类似于
cmdline-special 变量的方式扩展，包括相关的修饰符。这里是一个
简短的小结:
% 当前文件名
# 轮换文件名
#n 轮换文件名 n
<cfile> 光标所在的文件名
<afile> 自动命令文件名
<abuf> 自动命令缓冲区号 (以字符串形式出现！)
<amatch> 自动命令匹配的名字
<cexpr> 光标所在的 C 表达式
<sfile> 载入的脚本文件或函数名
<slnum> 载入脚本文件行号或函数行号
<sflnum> 脚本文件行号，即使在函数中亦然
<SID> "<SNR>123_" 其中 "123" 是当前脚本 ID
<SID>
<script> 执行中的脚本文件，或当前函数定义所在的
脚本文件
<stack> 调用栈
<cword> 光标所在的单词
<cWORD> 光标所在的字串 (WORD)
<client> 最近收到的消息的 {clientid}
server2client()
修饰符:
:p 扩展为完整的路径
:h 头部 (去掉最后一个部分)
:t 尾部 (只保留最后一个部分)
:r 根部 (去掉一个扩展名)
:e 只有扩展名
还支持其它修饰符，完整列表见 filename-modifiers 。
例如:
:let &tags = expand("%:p:h") .. "/tags"
注意 扩展 '%'、'#' 或者 '<' 开头的字符串的时候，其后的文本被忽
略。这样 不 行:
:let doesntwork = expand("%:h.bak")
应该这样:
:let doeswork = expand("%:h") .. ".bak"
还要 注意 扩展 "<cfile>" 和其它形式只能返回被引用的文件名，而
不会进一步扩展。如果 "<cfile>" 是 "~/.cshrc"，你需要执行另一个
expand() 把 "~/" 扩展为主目录的路径:
:echo expand(expand("<cfile>"))
变量名和其后的修饰符之间不能有空白。 fnamemodify() 函数可以用
来修改普通的文件名。
使用 '%' 或 '#' 但当前或轮换文件名没有定义的时候，使用空字符
串。在无名缓冲区使用 "%:p" 生成当前目录，后加一个 '/'。
如果设置了 'verbose'，'%'、'#' 和 <> 项目的扩展如果失败会报
错。
如果 {string} 不以 '%'、'#' 或 '<' 开始，它以命令行上的文件名
那样被扩展。使用 'suffixes' 和 'wildignore'，除非给出可选的
{nosuf} 参数而且为 TRUE 。
这里可以有不存在的文件的名字。"**" 项目可以用来在目录树里查
找。例如，要寻找当前目录及其下目录的所有的 "README":
:echo expand("**/README")
expand() 也可用来扩展变量和只有外壳知道的环境变量。但这会很
慢，因为需要使用外壳才能进行扩展。见 expr-env-expand 。
扩展后的变量还是被当作文件名的列表处理。如果不能扩展环境变量，
保留其不变。这样，":echo expand('$FOOBAR')" 返回的还是
"$FOOBAR"。
glob() 说明如何找到存在的文件。 system() 说明如何得到外部命
令的原始输出。
也可用作 method :
Getpattern()->expand()
返回类型: String 或 list<string>，取决于 {list}
expandcmd({string} [, {options}]) expandcmd()
像 :edit 这样的 Ex 命令那样扩展字符串 {string} 里的特殊项
目。在 {string} 的所有位置像 expand() 那样扩展特殊关键字，也
扩展环境变量。"~user" 和 "~/path" 只在开始处被扩展。
{option} 字典参数支持以下项目:
errmsg 设为 TRUE 时，报告扩展时出现的错误。缺省不回显
错误信息。
返回扩展后的字符串。如果扩展时出错，返回未修改的 {string}。
示例:
:echo expandcmd('make %<.o')
make /path/runtime/doc/builtin.o
:echo expandcmd('make %<.o', {'errmsg': v:true})
也可用作 method :
GetCommand()->expandcmd()
返回类型: String 或 list<string>，取决于 {list}
extend({expr1}, {expr2} [, {expr3}]) extend()
{expr1} 和 {expr2} 必须都是 List 或者都是 Dictionary 。
如果都是 List : 把 {expr2} 附加到 {expr1} 之后。
如果给出 {expr3}，把 {expr2} 里的项目加到 {expr1} 中索引为
{expr3} 的项目之前。如果 {expr3} 为零，插在第一个项目之前。如
果 {expr3} 等于 len({expr1})，那么 {expr2} 会附加在最后。
例如:
:echo sort(extend(mylist, [7, 5]))
:call extend(mylist, [2, 3], 1)
如果 {expr1} 和 {expr2} 是同一个列表，复制的项目数等于列表原来
的长度。例如，如果 {expr} 为 1，则复制列表首值 N 次 (N 是列表
原来的长度)。
用 add() 把一个项目加入列表。要连接两个列表成为一个新列表，
用 + 操作符:
:let newlist = [1, 2, 3] + [4, 5]
如果都是 Dictionary : 把 {expr2} 里的所有项目加入 {expr1}。
如果 {expr1} 和 {expr2} 包含相同的键，那么 {expr3} 决定应该怎
么做:
{expr3} = "keep": 保持 {expr1} 的值
{expr3} = "force": 使用 {expr2} 的值
{expr3} = "error": 给出错误信息 E737
如果省略 {expr3}，假设使用 "force"。
只要 {expr2} 非空，{expr1} 就被改变。如果需要，给 {expr1} 先做
个备份，或者用 extendnew() 返回新的列表/字典。
{expr2} 保持不变。
如果 {expr1} 被锁住且 {expr2} 非空，操作失败。
返回 {expr1}。出错时返回 0。
也可用作 method :
mylist->extend(otherlist)
返回类型: list<{type}> 或 dict<{type}>，取决于 {expr1} 和
{expr2}，出错时: Number
extendnew({expr1}, {expr2} [, {expr3}]) extendnew()
和 extend() 类似，但不是新增项目到 {expr1}，而是创建并返回新
列表或字典。{expr1} 保持不变。
返回类型: list<{type}> 或 dict<{type}>，取决于 {expr1} 和
{expr2}，出错时: Number
feedkeys({string} [, {mode}]) feedkeys()
将 {string} 里的字符放在队列里等候处理，就像它们来自映射或者用
户输入一样。
缺省它们加在预输入 (typeahead) 缓冲区的尾端，所以如果
仍然在执行映射，这些字符会出现在映射内容之后。用 'i' 标志位则
插入位置在其它字符之前，这样，它们在映射其它字符之前就会执行。
该函数不会等待 {string} 包含的键处理完毕。
{string} 如果要包含特殊键，可以使用双引号和 "\..." 记法
expr-quote 。例如，feedkeys("\<CR>") 会模拟 <Enter> 键击。但
feedkeys('\<CR>') 却实际压入五个字符。
一个可能有用的特殊代码是 <Ignore>，它会结束等待字符输入而不做
任何事。 <Ignore>
{mode} 是字符串，包含以下字符标志位:
'm' 对键重映射。缺省。如果不给出 {mode}，键会经过重映射。
'n' 不对键重映射。
't' 像用户输入那样处理键；如果不包含，像来自映射一样处理。
这会影响撤销、打开折叠等行为。
'L' 底层输入。只用于 Unix 或 GUI。键的使用就像来自终端那
样。不使用其它标志位。 E980
CTRL-C 中断且包含 't' 标志位时，设置内部 "got_int" 标
志位。
'i' 插入字符串而不是附加 (见上)。
'x' 执行命令，直至预输入为空为止。和 ":normal!" 类似。可以
不带 'x' 执行 feedkeys() 数次，然后一次性执行带 'x' 的
(可以只带空 {string}) 来执行所有的输入。注意 Vim 退出
插入模式时行为就如同按了 <Esc> 那样，以避免在脚本可以
继续前等待字符键入的阻塞情况。
注意 你执行命令时调用了 feedkeys()，会导致递归调用，而
所有的预输入会被最后的那个调用消耗。
'c' 执行时移除脚本上下文，以便应用老式的脚本语法，不适用
"s:var" 等等。注意 如果放入队列的字符串是用于设置脚本
上下文的，这依然有效。
'!' 使用 'x' 时不停止插入模式。可用于使定时器稍晚点才退出
插入状态的测试环境。对测试 CursorHoldI 有用。
返回值总为 0。
也可用作 method :
GetInput()->feedkeys()
返回类型: Number
filecopy({from}, {to}) filecopy()
复制文件 {from} 到 {to}。返回值为数值，文件复制成功为 TRUE ，
失败则为 FALSE 。
如果名为 {to} 的文件已存在，此函数会失败。
注意 此函数 (尚) 不处理目录。
该函数在沙盘里不可用 sandbox 。
也可用作 method :
GetOldName()->filecopy(newname)
返回类型: Number
filereadable({file}) filereadable()
返回数值，如果名为 {file} 的文件存在且可读，则为 TRUE 。如果
{file} 不存在，或者是一个目录，返回 FALSE 。{file} 可以是任何
返回字符串的表达式。
如果你不关心文件是否可读，可用 glob() 。
按本义使用 {file}，你可能需要先扩展通配符:
echo filereadable('~/.vimrc')
0
echo filereadable(expand('~/.vimrc'))
1
GetName()->filereadable()
返回类型: Number
file_readable()
已废弃的名字: file_readable()。
filewritable({file}) filewritable()
返回数值，如果名为 {file} 的文件存在且可写，则为 1。如果
{file} 不存在，或者不可写，返回 0。如果 {file} 是一个目录但是
可写，返回 2。
也可用作 method :
GetName()->filewritable()
返回类型: Number
filter({expr1}, {expr2}) filter()
{expr1} 必须是 List 、 String 、 Blob 或者 Dictionary 。
对 {expr1} 里的每个项目计算 {expr2}，如果结果为零或假值，从该
List 或 Dictionary 里删除该项目。类似方法用于检视 Blob
里的每个字节和 String 里的每个字符。
{expr2} 必须是 string 或 Funcref 。
如果 {expr2} 是 string ，{expr2} 内的 v:val 包含当前项目的
值。 Dictionary 中 v:key 包含当前项目的键。 List 中
v:key 包含当前项目的索引。 Blob 中 v:key 包含当前字节的索
引。 String 中 v:key 包含当前字符的索引。
例如:
call filter(mylist, 'v:val !~ "OLD"')
删除所有出现 "OLD" 的项目。
call filter(mydict, 'v:key >= 8')
删除所有键小于 8 的值。
call filter(var, 0)
删除所有的值，从而清除该 List 或 Dictionary 。
如果 {expr2} 是 Funcref ，它必须接受两个参数:
1. 当前项目的键或索引。
2. 当前项目的值。
如果该项目应保留，此函数必须返回 TRUE 。
例如要保留列表中奇数项目:
func Odd(idx, val)
return a:idx % 2 == 1
endfunc
call filter(mylist, function('Odd'))
使用 lambda 会更短。 Vim9 语法:
call filter(myList, (idx, val) => idx * val <= 42)
老式脚本语法:
call filter(myList, {idx, val -> idx * val <= 42})
如果不用 "val"，可以不写:
call filter(myList, {idx -> idx % 2 == 1})
Vim9 脚本中，计算结果必须为真值、假值、零或一。其他值会报告
类型错误。
对 List 和 Dictionary 而言，该操作是原位操作 (直接在输入上
修改)。要想不更动，先建立备份:
:let l = filter(copy(mylist), 'v:val =~ "KEEP"')
{expr1}，即经过过滤的 List 或 Dictionary ，或者新的
Blob 或 String 。
如果执行 {expr2} 有错，不再处理 {expr1} 的其余项目。{expr2} 是
函数引用时，忽略函数里的错误，除非该函数用 "abort" 标志位定
义。
也可用作 method :
mylist->filter(expr2)
返回类型: String 、 Blob 、list<{type}> 或 dict<{type}>，
取决于 {expr1}
finddir({name} [, {path} [, {count}]]) finddir()
在 {path} 里查找目录 {name}。支持向下和向上的递归目录搜索。
{path} 的语法参见 file-searching 。
返回第一个找到的路径。如果找到的路径在当前目录之下，返回相对路
径。否则，返回完整路径。
如果省略 {path}，使用 'path'。
如果给出可选的 {count}，寻找 {path} 里 {name} 第 {count} 次出
现，而不是第一次。
如果 {count} 为负，返回所有的匹配的列表。
如果目录没找到，返回空串。
这和 ex 命令 :find 非常类似。
也可用作 method :
GetName()->finddir()
返回类型: {count} 为负时是 list<string>，否则是 String
findfile({name} [, {path} [, {count}]]) findfile()
类似于 finddir() ，不过寻找文件而不是目录。
使用 'suffixesadd'。
例如:
:echo findfile("tags.vim", ".;")
从当前文件所在的目录开始往上搜索，直到找到文件 "tags.vim" 为
止。
也可用作 method :
GetName()->findfile()
返回类型: {count} 为负时是 list<string>，否则是 String
flatten({list} [, {maxdepth}]) flatten()
展平 {list}，最多到 {maxdepth} 层。不给出 {maxdepth} 时返回完
全无嵌套的 List ，如同 {maxdepth} 为非常大的数值。
{list} 在原位被修改，如果不想如此，可用 flattennew() 。
Vim9 脚本中不能用 flatten()，必须使用 flattennew() 。
E900
{maxdepth} 代表展平嵌套列表的最深层数。
{maxdepth} 为零时，不修改 {list}。
{maxdepth} 必须为正数。
如果有错，返回数值零。
示例:
:echo flatten([1, [2, [3, 4]], 5])
[1, 2, 3, 4, 5]
:echo flatten([1, [2, [3, 4]], 5], 1)
[1, 2, [3, 4], 5]
也可用作 method :
mylist->flatten()
返回类型: list<{type}>
flattennew({list} [, {maxdepth}]) flattennew()
同 flatten() ，但先创建 {list} 的备份。
返回类型: list<{type}>
float2nr({expr}) float2nr()
返回数值，即 {expr} 省略小数点部分的结果。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0。
如果 {expr} 的值超出 Number 的范围，结果为 0x7fffffff 或
-0x7fffffff (有 64-位 数值支持时，则为 0x7fffffffffffffff 或
-0x7fffffffffffffff)。而 NaN 转换为 -0x80000000 (有64-位数
值支持时，则为 -0x8000000000000000)。
示例:
echo float2nr(3.95)
3
echo float2nr(-23.45)
-23
echo float2nr(1.0e100)
2147483647 (或 9223372036854775807)
echo float2nr(-1.0e150)
-2147483647 (或 -9223372036854775807)
echo float2nr(1.0e-100)
0
也可用作 method :
Compute()->float2nr()
返回类型: Number
floor({expr}) floor()
返回浮点数，即小于等于 {expr} 的最大整数 (向下取整)。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0。
示例:
echo floor(1.856)
1.0
echo floor(-5.456)
-6.0
echo floor(4.0)
4.0
也可用作 method :
Compute()->floor()
返回类型: Float
fmod({expr1}, {expr2}) fmod()
返回 {expr1} / {expr2} 的余数，该除法可能实际无法表达出来。选
择某整数 i，返回 {expr1} - i * {expr2}，使得如果 {expr2} 非
零，结果和 {expr1} 同号而绝对值小于 {expr2} 的绝对值。如果
{expr2} 为零，返回零。返回值为 Float 。
{expr1} 和 {expr2} 的计算结果必须是 Float 或 Number 。
否则返回 0.0。
示例:
:echo fmod(12.33, 1.22)
0.13
:echo fmod(-12.33, 1.22)
-0.13
也可用作 method :
Compute()->fmod(1.22)
返回类型: Float
fnameescape({string}) fnameescape()
转义 {string} 以便用作命令的文件名参数。有特殊意义的字符，如
'%' 和 '|'，会用反斜杠转义。
多数系统上，会转义的字符是 " \t\n*?[{`$\\%#'\"|!<"。在反斜杠可
以出现在文件名中的系统上，此字符集取决于 'isfname'。
也转义出现在开头的 '+' 和 '>' 字符 ( :edit 和 :write 之后有
特殊意义)，还有单个出现的 "-" ( :cd 之后有特殊意义)。
出错时返回空串。
示例:
:let fname = '+some str%nge|name'
:exe "edit " .. fnameescape(fname)
则会执行:
edit \+some\ str\%nge\|name
也可用作 method :
GetName()->fnameescape()
返回类型: String
fnamemodify({fname}, {mods}) fnamemodify()
根据 {mods} 修改文件名 {fname}。{mods} 是一个字符序列组成的字
符串，就像命令行上使用的文件名那样。见 filename-modifiers 。
例如:
:echo fnamemodify("main.c", ":p:h")
返回:
/home/user/vim/vim/src
如果 {mods} 为空或使用了不支持的修饰符，返回 {fname}。
如果 {fname} 为空，{mods} ":h" 返回 "."，以便 :cd 所用。这不
同于不带缓冲区名的 expand('%:h')，后者返回空串。
注意: 环境变量不能用于 {fname}，需要先用 expand() 扩展。
也可用作 method :
GetName()->fnamemodify(':p:h')
返回类型: String
foldclosed({lnum}) foldclosed()
返回数值，如果行 {lnum} 在关闭的折叠中，返回该折叠开始的行号。
如果行 {lnum} 不在关闭的折叠中，返回 -1。
{lnum} 的用法可见 getline() 。因而 "." 是当前行，"'m" 是位置
标记 m，等等。
也可用作 method :
GetLnum()->foldclosed()
返回类型: Number
foldclosedend({lnum}) foldclosedend()
返回数值，如果行 {lnum} 在关闭的折叠中，返回该折叠结束的行号。
如果行 {lnum} 不在关闭的折叠中，返回 -1。
{lnum} 的用法可见 getline() 。因而 "." 是当前行，"'m" 是位置
标记 m，等等。
也可用作 method :
GetLnum()->foldclosedend()
返回类型: Number
foldlevel({lnum}) foldlevel()
返回数值，当前缓冲区第 {lnum} 行的折叠级别。如果在嵌套的折叠
里，返回最深的那层。如果行 {lnum} 没有折叠，返回零。这和折叠是
打开还是关闭无关。在更新折叠时 (在 'foldexpr' 里)，如果折叠还
在更新而相应的折叠级别未知，返回 -1。一个特例是前一行的级别通
常总是知道的。
{lnum} 的用法可见 getline() 。因而 "." 是当前行，"'m" 是位置
标记 m，等等。
也可用作 method :
GetLnum()->foldlevel()
返回类型: Number
foldtext() foldtext()
返回关闭的折叠所显示的行。这是 'foldtext' 选项使用的缺省函数，
而且也只应该在计算 'foldtext' 时使用。它使用 v:foldstart 、
v:foldend 和 v:folddashes 变量。
返回的字符串看起来像:
+-- 45 lines: abcdef
开头的连字符的数目取决于折叠级别。"45" 是折叠的行数。"abcdef"
是折叠第一个非空白行的文本。开头的空白、"//" 和 "/*" 还有
'foldmarker' 和 'commentstring' 选项的文本都被去除。
用于描绘实际的折叠文本时，行的其余部分用 'fillchars' 设置的
fold 字符来填充。
如果没有折叠，返回空串。
返回类型: String
{仅当编译时加入 +folding 特性才有效}
foldtextresult({lnum}) foldtextresult()
返回行 {lnum} 所在的关闭的折叠显示的文本。在合适的上下文里计算
'foldtext'。
如果 {lnum} 没有关闭的折叠，返回空字符串。
{lnum} 的用法可见 getline() 。所以 "." 是当前行，"'m" 是位置
标记 m，等等。
可用于输出折叠文本，例如，到 HTML 格式。
{仅当编译时加入 +folding 特性才有效}
也可用作 method :
GetLnum()->foldtextresult()
返回类型: String
foreach({expr1}, {expr2}) foreach() E1525
{expr1} 必须为 List 、 Tuple 、 String 、 Blob 或
Dictionary 。
对 {expr1} 的每个项目执行 {expr2}。{expr1} 不能被修改；但其值
可以，行为等同于 :lockvar 深度 1。 E741
要修改 {expr1}，参见 map() 和 filter() 。
{expr2} 必须为 string 或 Funcref 。
当 {expr2} 是 string 时，在 {expr2} 里 v:val 是当前项目的
值。对 Dictionary 而言， v:key 是当前项目的键值，对 List
或 Tuple 而言， v:key 是当前项目的索引。对 Blob 而言，
v:key 是当前字节的索引。对 String 而言， v:key 是当前字符
的索引。
示例:
call foreach(mylist, 'used[v:val] = true')
这会记录在 {expr1} 列表里的所有项目。
注意 {expr2} 是表达式的计算结果但用作命令。这里往往
literal-string 比较好用，因为可以避免双重反斜杠转义。
当 {expr2} 是 Funcref 时，其应接受两个参数:
1. 当前项目的键值或索引。
2. 当前项目的值。
如果只接受一个参数，老式匿名函数不会报错，但 Vim9 匿名函数会报
错 "E1106: One argument too many"，参数数目必须匹配。
函数如果有返回值，会被忽略。
所有情况下，返回 {expr1}。
执行 {expr2} 遇错时，不再处理 {expr1} 的其余项目。
{expr2} 是 Funcref 时，忽略函数内的错误，除非使用了 "abort" 标
志位。
也可用作 method :
mylist->foreach(expr2)
返回类型: String 、 Blob 、list<{type}>、tuple<{type}> 或
dict<{type}>，取决于 {expr1}
foreground() foreground()
把 Vim 窗口带到前台。用于从客户发送到 Vim 服务器的时候。
remote_send()
在 Win32 系统上，可能不行，操作系统并不总能允许窗口把自己带到
前台。这时应使用 remote_foreground() 。
返回类型: Number
{仅当使用 Win32、Motif 和 GTK GUI 版本和 Win32 控制台版本时才
有效}
fullcommand({name} [, {vim9}]) fullcommand()
获取简短缩写命令的完整命令名；关于命令缩写，详见 20.2 。
字符串参数 {name} 可以 : 开始，也可以包含 [range]，这些部分
被跳过，且不会返回。
如果命令不存在、有二义性 (出现于用户定义命令) 或不能缩短
vim9-no-shorten ，返回空串。
无 {vim9} 参数时使用当前脚本版本。{vim9} 存在且为 FALSE 时使用
老式脚本规则。{vim9} 存在且为 TRUE 时使用 Vim9 规则，例如 "en"
不能用作 "endif" 的缩写。
例如 fullcommand('s') 、`fullcommand('sub')`、
fullcommand(':%substitute') 都返回 "substitute"。
也可用作 method :
GetName()->fullcommand()
返回类型: String
funcref({name} [, {arglist}] [, {dict}]) funcref()
类似于 function() ，但返回的函数引用通过引用来查找函数，而不
是名字。如果函数 {name} 之后被重定义，这很有意义。
和 function() 不同，{name} 必须是已经定义的用户函数。自动载
入函数也可以，但必须已经载入 (以避免因为只是引用函数名而不小心
载入自动载入脚本，可用 function() 代替)。{name} 不能是内建函
数。
出错时返回 0。
也可用作 method :
GetFuncname()->funcref([arg])
返回类型: func(...): any 或出错时 Number
function({name} [, {arglist}] [, {dict}]) function() partial E700 E923
返回指向函数 {name} 的 Funcref 变量。{name} 可以是用户定义的
函数或者内部函数的名字。
{name} 可以是函数引用或偏函数。如果是偏函数，会使用其保存的字
典，而不接受 {dict} 参数。例如:
let FuncWithArg = function(dict.Func, [arg])
let Broken = function(dict.Func, [arg], dict)
使用函数引用时，通过 {name} 查找函数，即使以后被重定义了亦然。
要保留相同的函数，用 funcref() 。
提供 {arglist} 或 {dict} 则会建立偏函数。这意味着参数列表和/或
字典会存放在函数引用里，并在调用函数引用时使用。
参数被传递到函数里，在其它参数之前，但在来自 method 的参数之
后。例如:
func Callback(arg1, arg2, name)
...
let Partial = function('Callback', ['one', 'two'])
...
call Partial('name')
函数的调用就类似于:
call Callback('one', 'two', 'name')
func Callback(one, two, three)
...
let Partial = function('Callback', ['two'])
...
eval 'one'->Partial('three')
函数的调用就类似于:
call Callback('one', 'two', 'three')
func Callback(arg1, arg2, name)
"...
let Func = function('Callback', ['one'])
let Func2 = function(Func, ['two'])
"...
call Func2('name')
函数的调用就类似于:
call Callback('one', 'two', 'name')
{dict} 作为 "self"
传入。例如:
function Callback() dict
echo "called for " .. self.name
endfunction
"...
let context = {"name": "example"}
let Func = function('Callback', context)
"...
call Func() " 会回显: called for example
如果不需额外参数，function() 是没有必要的。这两者等价:
let Func = function('Callback', context)
let Func = context.Callback
function Callback(arg1, count) dict
"...
let context = {"name": "example"}
let Func = function('Callback', ['one'], context)
"...
call Func(500)
函数的调用就类似于:
call context.Callback('one', 500)
出错时返回 0。
也可用作 method :
GetFuncname()->function([arg])
{atexit}]) garbagecollect()
清理不再使用但有循环引用的 List 、 Dictionary 、 Channel 和
Job 。
几乎没有需要调用这个函数，因为 Vim 内存不足或者 'updatetime'
之后等待用户按键时会自动执行此功能。没有循环引用的项目总是在不
再使用的时候就被立即释放了。
可用于删除很大的 List 和/或 Dictionary 而且有循环引用的时
候，尤其是在要运行很长时间的脚本里。
如果可选的 {atexit} 参数为一，并且之前还没做过的话，Vim 即使在
退出时也会执行垃圾回收。可用于检查内存泄漏。
垃圾清理不是立即进行的，它会等待安全的时机，就是等待用户输入字
符的时候。要强制立即进行垃圾清理，可用
test_garbagecollect_now() 。
返回类型: String
get({list}, {idx} [, {default}]) get() get()-list
获取 List {list} 的第 {idx} 个项目。如果不存在此项目，返回
{default}。如果省略 {default}，返回零。
建议用作 method :
mylist->get(idx)
返回类型: any，取决于 {list}
get({tuple}, {idx} [, {default}]) get()-tuple
获取 Tuple {tuple} 的第 {idx} 个项目。如果不存在此项目，返回
{default}。如果省略 {default}，返回零。
建议用作 method :
mytuple->get(idx)
返回类型: any，取决于 {tuple}
get({blob}, {idx} [, {default}]) get()-blob
获取 Blob {blob} 的第 {idx} 个字节。如果不存在此字节，返回
{default}。如果省略 {default}，返回 -1。
建议用作 method :
myblob->get(idx)
返回类型: Number
get({dict}, {key} [, {default}]) get()-dict
获取 Dictionary {dict} 键为 {key} 的项目。如果不存在此项目，
返回 {default}。如果省略 {default}，返回零。有用的例子:
let val = get(g:, 'var_name', 'default')
如果 g:var_name 存在，返回它的值，如果不存在返回 'default'。
建议用作 method :
mydict->get(key)
返回类型: any，取决于 {dict}
get({func}, {what}) get()-func
获取函数引用 {func} 的项目 {what}。{what} 的可能值是:
"name" 函数名
"func" 函数
"dict" 字典
"args" 参数列表
"arity" 包含函数接受的参数数目 (不包括 {arglist}) 相关信息
的字典，有以下字段:
required 位置参数的数目
optional 必选参数之外的可选参数的数目
varargs 如果此函数接受可变参数数目 ... 则
为 TRUE
注意: 如果函数引用的 {arglist} 包含了参数个数
多于函数引用本身期待的数目，不会报错，这里不检
查。
出错时返回零。
建议用作 method :
myfunc->get(what)
返回类型: any，取决于 {func} 和 {what}
getbufinfo([{buf}]) getbufinfo()
getbufinfo([{dict}])
获取字典列表形式的缓冲区信息。
不带参数则返回关于所有缓冲区的信息。
只给出 Dictionary 参数时，返回匹配相关条件的缓冲区。{dict}
中可指定以下键值:
buflisted 只包含在列表内的缓冲区。
bufloaded 只包含已载入的缓冲区。
bufmodified 只包含修改过的缓冲区。
否则，{buf} 指定特定的单个缓冲区并返回其信息。{buf} 的用法见上
述 bufname() 。如果找到缓冲区，返回的列表有一个项目。不然返回
空列表。
每个返回的列表项目是带有以下项目的字典:
bufnr 缓冲区号。
changed 若缓冲区已修改则为 TRUE。
changedtick 缓冲区作过的改动次数。
hidden 若缓冲区隐藏则为 TRUE。
lastused 缓冲区最近修改时间， localtime() 那样
的以秒计的时间戳。
{仅当编译时加入 +viminfo 特性才有效}
listed 若缓冲区在列表内，则为 TRUE。
lnum 在当前窗口里打开本缓冲区时所用的行号。
仅当该缓冲区在此窗口中曾经显示过才有
效。
如果要某个窗口最近已知的光标位置的行
号，可用 line() :
:echo line('.', {winid})
linecount 缓冲区行数 (仅当缓冲区载入后才有效)
loaded 若缓冲区已载入则为 TRUE。
name 缓冲区文件的完整列表。
signs 缓冲区内放置的标号的列表。
每个列表项目是以下项目的字典:
id 标号的识别符
lnum 行号
name 标号名
variables 缓冲区局部变量的字典的引用。
windows 显示此缓冲区的所有 window-ID 的列表
popups 显示此缓冲区的弹出窗口 window-ID 的
列表
示例:
for buf in getbufinfo()
echo buf.name
endfor
for buf in getbufinfo({'buflisted':1})
if buf.changed
....
endif
endfor
要获取缓冲区局部选项，可用:
getbufvar({bufnr}, '&option_name')
也可用作 method :
GetBufnr()->getbufinfo()
返回类型: list<dict<any>>
getbufline({buf}, {lnum} [, {end}]) getbufline()
返回 {buf} 缓冲区的第 {lnum} 到 {end} (包含) 行的 List 。如果
省略 {end}，返回只有一行 {lnum} 的 List 。如果只要该行，可用
getbufoneline() 。
{buf} 的用法见上述 bufname() 。
{lnum} 和 {end} 可以使用 "$" 来表示缓冲区的最后一行。除此以
外，必须用数值。
如果 {lnum} 小于 1 或大于缓冲区的行数，返回空 List 。
如果 {end} 大于缓冲区的行数，就把它当成缓冲区的行数。如果
{end} 在 {lnum} 之前，返回空 List 。
此函数只能用于已经载入的缓冲区。未载入或不存在的缓冲区总是返回
空 List 。
例如:
:let lines = getbufline(bufnr("myfile"), 1, "$")
GetBufnr()->getbufline(lnum)
返回类型: list<string>
getbufoneline({buf}, {lnum}) getbufoneline()
类似于 getbufline() ，但只获取一行且以字符串形式返回。
返回类型: String
getbufvar({buf}, {varname} [, {def}]) getbufvar()
返回缓冲区 {buf} 里的选项或者局部变量 {varname} 的值。注意 必
须使用不带 "b:" 的名字。
{varname} 参数为字符串。
如果 {varname} 为空，返回包含所有缓冲区局部变量的
Dictionary 。
如果 {varname} 为 "&"，返回包含所有缓冲区局部选项的
Dictionary 。
否则，如果 {varname} 以 "&" 开始，返回单个缓冲区局部选项值。
也可用于全局或者局部于缓冲区的选项，但不能用于全局或者局部于窗
口的变量，还有局部于窗口的选项。
{buf} 的用法见上述 bufname() 。
如果缓冲区或者变量不存在，返回 {def} 或空字符串。不会有错误消
息。
示例:
:let bufmodified = getbufvar(1, "&mod")
:echo "todo myvar = " .. getbufvar("todo", "myvar")
GetBufnr()->getbufvar(varname)
返回类型: any，取决于 {varname}
getcellpixels() getcellpixels()
返回终端单元的像素尺寸 List 。
列表格式是 [xpixel, ypixel]。
仅对 Unix (终端和 gVim) 和 Windows (仅 gVim) 有效。
其他系统返回 [] 或报错。
注意 不同终端可能会有变种。macOS 上系统的 Terminal.app 返回的
尺寸以点 (point) 计 (在视网膜缩放之前)，而第三方终端返回原始像
素尺寸 (在视网膜缩放之后)。
MacVim 里，启动后或改变了 'guifont' 时，此选项会有少许延迟才会
返回更新后的值。
返回类型: list<any>
getcellwidths() getcellwidths()
返回 setcellwidths() 覆盖的字符范围的单元宽度的 List 。
其格式和 setcellwidths() 的参数相同。如果没有单元宽度被覆盖
的字符范围，返回空列表。
返回类型: list<any>
getchangelist([{buf}]) getchangelist()
返回缓冲区 {buf} 里的 changelist 。{buf} 的用法可见上述
bufname() 。缓冲区 {buf} 不存在时返回空列表。
返回列表包含两个项目: 包含改变位置的列表以及在该列表中的当前位
置。改变位置列表的每个项目是包含以下内容的字典:
col 列号
coladd 用于 'virtualedit' 的列偏移
lnum 行号
如果缓冲区 {buf} 是当前缓冲区，当前位置指的是在列表中的位置。
如果是其它缓冲区，它设为列表的长度。
也可用作 method :
GetBufnr()->getchangelist()
返回类型: list<any>
getchar([{expr} [, {opts}]]) getchar()
从用户或输入流中提取单个字符。
如果忽略 {expr} 为 -1，等待直到有字符输入为止。
如果 {expr} 为 0，只有在有字符可用时才取得字符，否则返回零。
如果 {expr} 为 1，只检查是否有字符可用，并不消耗该字符。如果没
有字符，返回零。
如果希望返回总是字符串形式，用 getcharstr() 或 {opts} 里的
"number" 设为 FALSE 。
如果省略 {expr} 或者 {expr} 为零，返回整个字符或者特殊键。如果
是单个字符，以数值形式返回。用 nr2char() 把它转化成字符串。
否则返回经过编码的字符构成的字符串。如果是特殊键，返回以 0x80
(十进制: 128) 开始的一串字节构成的字符串。它和字符串 "\<Key>"
等值，例如 "\<Left>"。如果用带修饰符 (Shift，Control， Alt) 的
字符而字符本身不包含该修饰符时，返回值也用字符串类型。也可以用
keytrans() 把返回的字符串转为可读的形式。
如果 {expr} 为 0 并已键入 Esc，会有短暂的延迟，以便 Vim 有机会
判断是否是转义序序列的开始。
如果 {expr} 为 1，只返回第一个字节。如果是单字节字符，返回的就
是该字符自身的数值形式。用 nr2char() 把它转化为字符串。
getcharmod() 可用于得到附加的修饰符。
可选参数 {opts} 是支持以下项目的字典:
cursor 指定等待字符时光标行为的字符串。
"hide": 隐藏光标。
"keep": 保持当前光标不变。
"msg": 移动光标到消息区。
(缺省: "msg")
number 如为 TRUE ，提取到单个字符时返回数
值。
如为 FALSE ，总把返回值转换为字符串，
无字符可用时返回空串 (而非 0)。
(缺省: TRUE )
simplify 如为 TRUE ，字符包含修饰符 (如有)。例
如 CTRL-I 和 <Tab> 返回相同值。
如为 FALSE ，字符不包含修饰符。
(缺省: TRUE )
用户点击鼠标时，返回鼠标事件。所在的位置可以在 v:mouse_col 、
v:mouse_lnum 、 v:mosue_winid 和 v:mouse_win 里找到。也可
用 getmousepos() 。鼠标移动事件被忽略。
下例用通常的处理方法定位鼠标:
let c = getchar()
if c == "\<LeftMouse>" && v:mouse_win > 0
exe v:mouse_win .. "wincmd w"
exe v:mouse_lnum
exe "normal " .. v:mouse_col .. "|"
endif
使用括号内粘贴模式时，只返回首个字符。粘贴文本其余部分被丢弃。
xterm-bracketed-paste 。
这里没有提示，你需要想办法告诉用户，需要输入一个字符。屏幕不重
画，例如在窗口改变大小时也是如此。使用弹出窗口时，最好使用
popup-filter 。
字符不通过映射。
键码被替换。因而，用户输入 <Del> 键时，你得到 <Del> 的键码，而
不是原始的字符序列。比如:
getchar() == "\<Del>"
getchar() == "\<S-Left>"
下例重新定义 "f"，使它忽略大小写:
:nmap f :call FindChar()<CR>
:function FindChar()
: let c = nr2char(getchar())
: while col('.') < col('$') - 1
: normal l
: if getline('.')[col('.') - 1] ==? c
: break
: endif
: endwhile
:endfunction
也可能收到模拟字符，例如 <CursorHold> 。通常你想忽略之跳到下
个字符:
:function GetKey()
: let c = getchar()
: while c == "\<CursorHold>"
: let c = getchar()
: endwhile
: return c
:endfunction
返回类型: Number 或 String
getcharmod() getcharmod()
返回数值，反映最近用 getchar() 或其它方式输入字符的修饰符状
态。这些值可以相加:
2 Shift
4 Control
8 Alt (Meta)
16 Meta (当和 ALT 不同时)
32 鼠标双击
64 鼠标三击
96 鼠标四击 (== 32 + 64)
128 Command (Mac) 或 Super (GTK)
只有没有包含字符本身的修饰符被返回。因而，Shift-a 产生没有修饰
符的 "A"。如果没有使用修饰符，返回 0。
返回类型: Number
getcharpos({expr}) getcharpos()
得到字符串 {expr} 的位置。和 getpos() 相同，但返回列表的列号
是字符索引而不是字节索引。
如果 getpos() 返回等于 v:maxcol 的很大列号，那么
getcharpos() 会返回末字符的字符索引。
示例:
如果光标在第五行文本 "여보세요" 的 '세' 时:
getcharpos('.') 返回 [0, 5, 3, 0]
getpos('.') 返回 [0, 5, 7, 0]
也可用作 method :
GetMark()->getcharpos()
返回类型: list<number>
getcharsearch() getcharsearch()
以 {dict} 形式返回当前字符搜索信息，带有以下项目:
char 上次字符搜索 ( t 、 f 、 T 或 F ) 使用的字
符；空字符串代表没有字符搜索进行过
forward 字符搜索的方向；1 为正向，0 为反向
until 字符搜索的类型；1 为 t 为 T 字符搜索，0 为
f 或 F 字符搜索
可用于使 ; 和 , 永远进行正向/反向搜索而不管上次字符搜索的
方向:
:nnoremap <expr> ; getcharsearch().forward ? ';' : ','
:nnoremap <expr> , getcharsearch().forward ? ',' : ';'
另见 setcharsearch() 。
返回类型: dict<any>
getcharstr([{expr} [, {opts}]]) getcharstr()
和 getchar() 相同，但总是返回字符串形式，且 {opts} 里不允许
设置 "number"。
返回类型: String
getcmdcomplpat() getcmdcomplpat()
返回当前命令行的补全模式。
只有在编辑命令行时有效，所以必须在 c_CTRL-\_e 或
c_CTRL-R_= 里使用。
另见 getcmdtype() 、 setcmdpos() 、 getcmdline() 、
getcmdprompt() 、 getcmdcompltype() 和 setcmdline() 。
补全没有定义时，返回空串。
返回类型: String
getcmdcompltype() getcmdcompltype()
返回当前命令行补全的类型。只有在编辑命令行时有效，所以必须在
c_CTRL-\_e 或 c_CTRL-R_= 里使用。
返回字符串可见 :command-completion 。
另见 getcmdtype() 、 setcmdpos() 、 getcmdline() 、
getcmdprompt() 、 getcmdcomplpat() 或 setcmdline() 。
如果没有定义补全，返回空串。
要获取为指定字符串所使用的命令行补全的类型，可用
getcompletiontype() 。
返回类型: String
getcmdline() getcmdline()
返回当前命令行输入。只有在编辑命令行时有效，所以必须在
c_CTRL-\_e 或 c_CTRL-R_= 里使用。
例如:
:cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
另见 getcmdtype() 、 getcmdpos() 、 setcmdpos() 、
getcmdprompt() 和 setcmdline() 。
输入密码或用 inputsecret() 时返回空串。
返回类型: String
getcmdpos() getcmdpos()
返回命令行的字节计算的光标位置。第一列为 1。
只有在编辑命令行时有效，所以必须在 c_CTRL-\_e 或
c_CTRL-R_= 或表达式映射里使用。
不然，返回 0。
另见 getcmdtype() 、 setcmdpos() 、 getcmdline() 、
getcmdprompt() 和 setcmdline() 。
返回类型: Number
getcmdprompt() getcmdprompt()
返回当前命令行在使用 input() 或 confirm() 之类的函数时的提
示。
只有在编辑命令行时有效，所以必须在 c_CTRL-\_e 或
c_CTRL-R_= 或表达式映射里使用。
另见 getcmdtype() 、 getcmdline() 、 getcmdpos() 、
setcmdpos() 和 setcmdline() 。
返回类型: String
getcmdscreenpos() getcmdscreenpos()
返回命令行的字节计算的光标屏幕位置。第一列为 1。
和 getcmdpos() 不同，它把提示位置也加入在内。
只有在编辑命令行时有效，所以必须在 c_CTRL-\_e 或
c_CTRL-R_= 或表达式映射里使用。
不然，返回 0。
另见 getcmdpos() 、 setcmdpos() 、 getcmdline() 和
setcmdline() 。
返回类型: Number
getcmdtype() getcmdtype()
返回当前命令行类型。可能的返回值是:
: 普通 Ex 命令
> 调试模式命令 debug-mode
/ 正向搜索命令
? 反向搜索命令
@ input() 命令
- :insert 或 :append 命令
= i_CTRL-R_=
只能在编辑命令行时调用，因而必须在 c_CTRL-\_e 或
c_CTRL-R_= 或表达式映射里使用。
否则，返回空字符串。
另见 getcmdpos() 、 setcmdpos() 和 getcmdline() 。
返回类型: String
getcmdwintype() getcmdwintype()
返回当前 command-line-window 类型。可能的返回值和
getcmdtype() 相同。如果不在命令行窗口内，返回空字符串。
返回类型: String
getcompletion({pat}, {type} [, {filtered}]) getcompletion()
返回命令行补全匹配列表。字符串 {type} 指定类型。支持以下的匹配
类型:
arglist 参数列表中的文件名
augroup 自动命令组
buffer 缓冲区名
behave :behave 子选项
breakpoint :breakadd 和 :breakdel 子选项
color 色彩方案
command Ex 命令
cmdline cmdline-completion 结果
compiler 编译器
cscope :cscope 子选项
custom,{func} {func} 定义的定制补全
customlist,{func} {func} 定义的定制补全
diff_buffer :diffget 和 :diffput 补全
dir 目录名
dir_in_path 'cdpath' 里的目录名
environment 环境变量名
event 自动命令事件
expression Vim 表达式
file 文件和目录名
file_in_path 'path' 中的文件和目录名
filetype 文件类型名 'filetype'
filetypecmd :filetype 子选项
function 函数名
help 帮助主题
highlight 高亮组
history :history 子选项
keymap 键盘映射
locale locale 名 (可见 locale -a 的输出)
mapclear 缓冲区参数
mapping 映射名
menu 菜单
messages :messages 子选项
option 选项
packadd 可选包 pack-add 名
retab :retab 子选项
scriptnames 执行过的脚本名 :scriptnames
shellcmd 外壳命令
shellcmdline 带文件名参数的外壳命令行
sign :sign 子选项
syntax 语法文件名 'syntax'
syntime :syntime 子选项
tag 标签
tag_listfiles 标签、文件名
user 用户名
var 用户变量
如果 {pat} 为空串，返回所有匹配。否则只返回匹配 {pat} 的项目。
关于 {pat} 中特殊字符的使用，见 wildcards 。
如果可选的 {filtered} 标志位设为 1，应用 'wildignore' 来过滤结
果。否则返回所有匹配。'wildignorecase' 选项则总是有效。
如果 'wildoptions' 选项包含 'fuzzy'，补全匹配使用模糊匹配，否
则使用正则表达式匹配。因此，此函数和用户在命令行的偏好保持一
致。如果不想如此，可在调用 getcompletion() 前清空
'wildoptions'，之后再复原。
如果 {type} 为 "cmdline"，返回 cmdline-completion 的结果。例
如，要补全 ":call" 命令之后可能的取值:
echo getcompletion('call ', 'cmdline')
如果没有匹配，返回空列表。如果 {type} 为非法值，报错。
也可用作 method :
GetPattern()->getcompletion('color')
返回类型: list<string>
getcompletiontype({pat}) getcompletiontype()
返回 {pat} 使用的命令补全的类型。如果找不到对应的补全类型，返
回空串。
要得到当前命令行补全类型，可用 getcmdcompltype() 。
返回类型: list<string>
getcurpos([{winid}]) getcurpos()
返回光标位置。类似于 getpos('.')，但返回列表中包含一个额外的
"curswant" 项目:
[0, lnum, col, off, curswant]
"curswant" 数值是垂直移动光标时的首选列。 $ 命令后，它将是等
同于 v:maxcol 的一个很大的值。另见 getcursorcharpos() 和
getpos() 。
首个 "bufnum" 项目总是为零。'col' 返回的是光标的字节位置。要得
到字符位置，用 getcursorcharpos() 。
可选的 {winid} 参数可指定窗口。可以是窗口号或 window-ID 。返
回最近已知的光标位置，如果缓冲区的当前值不是当前窗口，可能会非
法。{winid} 非法时返回零组成的列表。
可用于保存和恢复光标位置:
let save_cursor = getcurpos()
移动光标
call setpos('.', save_cursor)
注意 这只适用于同一窗口内的移动。要恢复更多状态，见
winrestview() 。
也可用作 method :
GetWinid()->getcurpos()
返回类型: list<number>
getcursorcharpos([{winid}]) getcursorcharpos()
同 getcurpos() ，但返回列表中的列号是字符索引而不是字节索引。
示例:
如果光标在第三行文本 "여보세요" 的 '보' 时:
getcursorcharpos() 返回 [0, 3, 2, 0, 3]
getcurpos() 返回 [0, 3, 4, 0, 3]
也可用作 method :
GetWinid()->getcursorcharpos()
返回类型: list<number>
getcwd([{winnr} [, {tabnr}]]) getcwd()
返回字符串，当前工作目录的名字。忽略 'autochdir'。
有 {winr} 则返回当前标签页的该窗口的本地当前目录。{winr} 可以
是窗口号或 window-ID 。
{winr} 为 -1 时返回全局工作目录名。另见 haslocaldir() 。
有 {winr} 和 {tabnr} 则返回指定标签页和窗口的本地当前目录。如
果 {winnr} 为 -1，返回指定标签页的当前目录。
如果 {winr} 为零使用当前窗口。如果 {tabnr} 为零使用当前标签
页。
无参数时，返回当前窗口的实际工作目录。
参数非法时返回空串。
示例:
" 返回当前窗口的工作目录
:echo getcwd()
:echo getcwd(0)
:echo getcwd(0, 0)
" 返回标签页 2 中的窗口 3 的工作目录
:echo getcwd(3, 2)
" 返回全局工作目录
:echo getcwd(-1)
" 返回标签页 3 的工作目录
:echo getcwd(-1, 3)
" 返回当前标签页的工作目录
:echo getcwd(-1, 0)
GetWinnr()->getcwd()
返回类型: String
getenv({name}) getenv()
返回环境变量 {name} 的值。{name} 参数为不带前导 '$' 的字符串。
例如:
myHome = getenv('HOME')
GetVarname()->getenv()
返回类型: String 或 Number
getfontname([{name}]) getfontname()
如果没有参数，返回使用的正常字体的名字，也就是 Normal 高亮组
hl-Normal 使用的。
如果带了参数，检查字符串 {name} 是否合法的字体名。如果不是，返
回空字符串。否则，返回实际的字体名，或者如果 GUI 不支持取得真
正的名字，返回 {name}。
只有在 GUI 运行的时候才能用，所以不能用于你的 vimrc 和 gvimrc
文件。用 GUIEnter 自动命令可以在 GUI 刚开始之后使用此函数。
注意 GTK GUI 接受任何字体名，所以不会检查名字是否合法。
返回类型: String
getfperm({fname}) getfperm()
返回字符串，给定文件 {fname} 的读、写、执行权限。
如果 {fname} 不存在或者它所在的目录无法读取，返回空字符串。
返回值的形式是 "rwxrwxrwx"，其中每组 "rwx" 标志位分别代表文件
所有者、文件所属组和其它用户的权限。如果用户没有某权限，相应的
标志位被字符串 "-" 代替。例如:
:echo getfperm("/etc/passwd")
:echo getfperm(expand("~/.vimrc"))
希望它会 (从安全角度而言) 显示字符串 "rw-r--r--" 或者甚至
"rw-------"。
也可用作 method :
GetFilename()->getfperm()
返回类型: String
要设置权限，可用 setfperm() 。
getfsize({fname}) getfsize()
返回数值，文件 {fname} 以字节数计算的大小。
如果 {fname} 是目录，返回 0。
如果找不到文件 {fname}，返回 -1。
如果 {fname} 文件过大，超出了 Vim 的数值的范围，返回 -2。
也可用作 method :
GetFilename()->getfsize()
返回类型: Number
getftime({fname}) getftime()
返回数值，给定文件 {fname} 的最新修改时间。该时间为 1970 年 1
月 1 日开始计算的秒数，可以传给 strftime() 。
另见 localtime() 和 strftime() 。
如果找不到文件 {fname}，返回 -1。
也可用作 method :
GetFilename()->getftime()
返回类型: Number
getftype({fname}) getftype()
返回字符串，给定文件 {fname} 的文件类型的描述。
如果 {fname} 不存在，返回空字符串。
下表列出各种不同文件类型的返回值:
普通文件 "file"
目录 "dir"
符号链接 "link"
块设备 "bdev"
字符设备 "cdev"
套接字 "socket"
FIFO "fifo"
其它 "other"
例如:
getftype("/home")
注意 只有在能支持的系统上才会返回 "link" 这样的类型。有的系统
只支持 "dir" 和 "file"。MS-Windows 上目录的符号链接返回 "dir"
而不是 "link"。
也可用作 method :
GetFilename()->getftype()
返回类型: String
getimstatus() getimstatus()
返回数值，IME 状态激活时为 TRUE ，否则为 FALSE 。
见 'imstatusfunc'。
返回类型: Number
getjumplist([{winnr} [, {tabnr}]]) getjumplist()
返回指定窗口的 jumplist 。
无参数时使用当前窗口。
如果只带 {winnr}，使用当前标签页的指定窗口。
{winnr} 也可以是 window-ID 。
有 {winr} 和 {tabnr} 则返回指定标签页的指定窗口。如果 {winnr}
或 {tabnr} 非法，返回空列表。
返回列表包含两个项目: 包含跳转位置的列表以及在该列表中的最近使
用的跳转位置号。跳转位置列表的每个项目是包含以下内容的字典:
bufnr 缓冲区号
col 列号
coladd 用于 'virtualedit' 的列偏移
filename 文件名，如有的话
lnum 行号
也可用作 method :
GetWinnr()->getjumplist()
返回类型: list<any>
getline({lnum} [, {end}]) getline()
如果没有 {end}，返回字符串，即当前缓冲区第 {lnum} 行文本。
例如:
getline(1)
如果 {lnum} 是不以数字开始的字符串，调用 line() 来把该字符串
转化成数值。要得到光标所在的行:
getline(".")
如果 {lnum} 是小于 1 或者大于缓冲区的总行数的数值，返回空串。
如果给出 {end}，返回 List ，其中每个项目是当前缓冲区从 {lnum}
到 {end} (包含) 范围的一行。
{end} 的用法同 {lnum}。
安静地忽略不存在的行。
如果 {end} 在 {lnum} 之前，返回空 List 。
例如:
:let start = line('.')
:let end = search("^$") - 1
:let lines = getline(start, end)
ComputeLnum()->getline()
返回类型: list<string> 或 String ，取决于 {end}
要获取其它缓冲区的文本行，见 getbufline() 和
getbufoneline() 。
getloclist({nr} [, {what}]) getloclist()
返回 List ，包含窗口 {nr} 的位置列表的所有项目。{nr} 可以是窗
口号或 window-ID 。如果 {nr} 为 0，使用当前窗口。
如果是位置列表窗口，返回其显示的位置列表。如果窗口号 {nr} 非
法，返回空列表。其它的情况和 getqflist() 相同。
如果提供了可选的 {what} 字典参数，以字典形式返回 {what} 列出的
项目。关于 {what} 支持的项目，可参考 getqflist() 。
除了 getqflist() 的 {what} 支持的项目以外， getloclist() 还
支持以下项目:
filewinid 用于显示来自位置列表的文件的窗口的
id。只有当调用来自位置列表窗口时此域才
可用。详见
location-list-file-window 。
如果窗口 {nr} 没有位置列表，返回带缺省值的 Dictionary 。
如果窗口 {nr} 不存在，返回空字典。
示例 (另见 getqflist-examples ):
:echo getloclist(3, {'all': 0})
:echo getloclist(5, {'filewinid': 0})
返回类型: list<dict<any>> 或 list<any>
getmarklist([{buf}]) getmarklist()
无 {buf} 参数时，返回 List ，给出所有全局位置标记的信息。
mark
给出可选的 {buf} 参数时，返回缓冲区 {buf} 中定义的局部位置标
记。{buf} 的用法可见 bufname() 。{buf} 非法时返回空列表。
返回列表的每个项目是包含以下内容的 Dict :
mark 带 "'" 前缀的位置标记名
pos 位置标记所在位置的 List :
[bufnum, lnum, col, off]
详情请参考 getpos() 。
file 文件名
要获取特定位置标记的信息，参见 getpos() 。
也可用作 method :
GetBufnr()->getmarklist()
返回类型: list<dict<any>> 或 list<any>
getmatches([{win}]) getmatches()
返回之前 matchadd() 和 :match 命令为当前窗口定义的所有匹配
组成的列表 List 。 getmatches() 常和 setmatches() 组合使
用，因为 setmatches() 可以恢复 getmatches() 保存的匹配列
表。
如果指定 {win}，使用对应此窗口号或窗口 ID 的窗口，而不是当前窗
口。{win} 非法时返回空列表。
示例:
:echo getmatches()
[{'group': 'MyGroup1', 'pattern': 'TODO',
'priority': 10, 'id': 1}, {'group': 'MyGroup2',
'pattern': 'FIXME', 'priority': 10, 'id': 2}]
:let m = getmatches()
:call clearmatches()
:echo getmatches()
[]
:call setmatches(m)
:echo getmatches()
[{'group': 'MyGroup1', 'pattern': 'TODO',
'priority': 10, 'id': 1}, {'group': 'MyGroup2',
'pattern': 'FIXME', 'priority': 10, 'id': 2}]
:unlet m
返回类型: list<dict<any>> 或 list<any>
getmousepos() getmousepos()
返回鼠标最近已知位置的 Dictionary 。可用于鼠标点击的映射或弹
出窗口的过滤。项目是:
screenrow 屏幕行
screencol 屏幕列
winid 点击所在的窗口 ID
winrow "winid" 里的行
wincol "winid" 里的列
line "winid" 里的文本内容行
column "winid" 里的文本列
coladd 点击所在字符开始处的 (以屏幕列计) 偏移
所有的数值从 1 开始。
如果鼠标不在窗口上，比如在命令行或 tabpanel 里，则只有
"screenrow" 和 "screencol" 是合法的，其它的值均为零。
如果鼠标在窗口底下的状态行上或窗口右侧的垂直分割线上，"line"
和 "column" 的值为零。
如果位置在文本之后，那么 "column" 是文本以字节计的长度加一。
如果鼠标在弹出窗口上，使用该窗口。
使用 getchar() 时，Vim 变量 v:mouse_lnum 、 v:mouse_col 和
v:mouse_winid 也能提供相应的这些值。
返回类型: dict<number>
getmouseshape() getmouseshape()
返回当前显示的鼠标指针的外型名。如果不支持 +mouseshape 特性
或外型未知，返回空串。
本函数主要用于测试。
返回类型: String
getpid() getpid()
返回数值，即 Vim 进程的进程号。Unix 和 MS-Windows 上这是个唯一
的数值，直到 Vim 退出为止。
返回类型: Number
getpos({expr}) getpos()
得到字符串 {expr} 的位置。
可接受的位置是: E1209
. 光标位置。
$ 当前缓冲区的最后一行。
'x 位置标记 x 的位置 (如果该位置标记没有设置，所有值
返回 0)。
w0 当前窗口可见部分的首行 (如果显示不刷新，如安静 Ex
模式下，则为一)。
w$ 当前窗口可见部分的末行 (如果无行可见，返回比 w0 小
一的值)。
v 不在可视模式下，返回光标位置。可视模式下，返回可视
区域另一端。一个容易理解的方法是记住在可视模式下，
"v" 和 ".": 总是互补。"." 指向光标位置，而 "v" 指
向 v_o 会移动光标到的地方。所以，可用 "v" 和 "."
组合进行面向字符的可视模式的各种选择。如果光标在面
向字符的可视模式的结尾，"v" 指向相同可视区域的开始
处。而如果光标在面向字符的可视模式的开始处，"v" 指
向相同可视区域的结尾。"v" 和 '< 及 '> 不同，因
为它会立即更新。
注意 可以使用其它文件的位置标记。此时行号应用于那个缓冲区。
返回 List ，包含四个数值:
[bufnum, lnum, col, off]
"bufnum" 为零，除非使用了 '0 或 'A 这样的位置标记，这时它是此
位置标记所在的缓冲区号。
"lnum" 和 "col" 是缓冲区里的位置。第一列为 1。
除非使用了 'virtualedit'。"off" 值为零，这是从对应字符开始位置
的以屏幕列计的位移。例如，在制表之中或最后一个字符之后的某个位
置。
要得到光标位置，见 getcurpos() 。
返回列表中的列号是行内的字节位置。要得行内的字符位置，用
getcharpos() 。
注意 '< 和 '> 和可视模式有关: "V" (可视行模式) 时 '< 的列为
零，'> 的列是等于 v:maxcol 的一个大数。
可返回等于 v:maxcol 的大列号，这种情况代表 "在行尾之后"。
{expr} 如非法，返回全零组成的列表。
可以用来保存和恢复光标位置:
let save_a_mark = getpos("'a")
...
call setpos("'a", save_a_mark)
另见 getcharpos() 、 getcurpos() 和 setpos() 。
也可用作 method :
GetMark()->getpos()
返回类型: list<number>
getqflist([{what}]) getqflist()
返回 List ，包含所有当前快速修复错误。列表的每个项目是包含以
下项目的字典:
bufnr 有此文件名的缓冲区号， bufname() 得到缓冲区名
module 模块名
lnum 缓冲区里的行号 (第一行是 1)
end_lnum
如果项目为多行，末行的行号
col 列号 (第一列是 1)
end_col 如果项目有范围，末列的列号
vcol TRUE : "col" 是可视列
FALSE : "col" 是字节位置
nr 错误号
pattern 用于定位错误的搜索模式
text 错误描述
type 错误类型，'E'、'1' 等。
valid TRUE : 能识别该错误信息
user_data
和项目关联的定制数据，可为任何类型。
如果没有错误列表或者它为空，返回空列表。快速修复列表项目如果包
含不存在的缓冲区号，返回的 "bufnr" 置为零 (注意 有些函数接受缓
冲区号零，代表轮换缓冲区，为此，可能需要显式检查零值)。
应用: 在多个文件里寻找模式的匹配，并对之进行处理:
:vimgrep /theword/jg *.c
:for d in getqflist()
: echo bufname(d.bufnr) ':' d.lnum '=' d.text
:endfor
如果提供了可选的 {what} 字典参数，以字典形式返回 {what} 列出的
项目。{what} 支持以下字符串项目:
changedtick quickfix-changedtick 列表改变的总数
context 获取 quickfix-context
efm 解析 "lines" 时使用的 errorformat。如果没有给
出，使用 'errorformat' 选项值。
id 获取快速修复列表 quickfix-ID 说明的信息。
零代表当前列表或 "nr" 指定的列表
idx 获取由 'id' 或 'nr' 指定的快速修复列表中在此索
引的项目信息。
如果设为零，使用当前项目。
见 quickfix-index
items 获取快速修复列表的项目
lines 用 'efm' 解析文本行列表并返回其结果项目。只支
持 List 类型。不修改当前快速修复列表。见
quickfix-parse 。
nr 获取关于指定快速修复列表的信息；零代表当前快速
修复列表，"$" 代表最后的快速修复列表
qfbufnr 快速修复窗口显示的缓冲区号。快速修复缓冲区不存
在时返回 0。见 quickfix-buffer 。
size 快速修复列表的项目总数
title 获取列表标题 quickfix-title
winid 获取快速修复 window-ID
all 上述所有的快速修复属性
忽略 {what} 中非字符串项。要获取某个特定项之值，先设为零。
如果不给出 "nr"，使用当前快速修复列表。
同时给出 "nr" 和非零 "id" 时，使用 "id" 指定的列表。
要取得快速修复栈的列表数目，在 {what} 中设置 'nr' 为 "$"。返回
字典中的 "nr" 值会告诉你快速修复的栈大小。
如果给出 "lines"，忽略除 "efm" 外的所有其它项。返回的字典包
含 "items" 项，给出所有项目的列表。
返回字典包含以下项目:
changedtick quickfix-changedtick 列表改变的总数
context 快速修复列表的上下文，见 quickfix-context
如果不存在，设为 ""。
id 快速修复列表 ID quickfix-ID 。如果不存在，设
为 0。
idx 列表中快速修复项目的索引。如果不存在，设为 0。
items 快速修复列表的项目。如果不存在，设为空列表。
nr 快速修复列表号。如果不存在，设为 0
qfbufnr 快速修复窗口显示的缓冲区号。如果不存在，设为
0。
size 快速修复列表的项数。如果不存在，设为 0。
title 快速修复列表标题文本。如果不存在，设为 ""。
winid 快速修复 window-ID 。如果不存在，设为 0
示例 (另见 getqflist-examples ):
:echo getqflist({'all': 1})
:echo getqflist({'nr': 2, 'title': 1})
:echo getqflist({'lines' : ["F1:10:L10"]})
返回类型: list<dict<any>> 或 list<any>
getreg([{regname} [, 1 [, {list}]]]) getreg()
返回字符串，寄存器 {regname} 的内容。例如:
:let cliptext = getreg('*')
如果 {regname} 对应的寄存器没有设过，返回空串。
{regname} 参数必须为字符串。 E1162
getreg('=') 返回最近一次表达式寄存器计算的返回值 (用于映射)。
getreg('=', 1) 返回表达式自身，以便用 setreg() 恢复。对于其
它寄存器，这个额外的参数被忽略，所以给出此参数总是无妨。
如果 {list} 给出且为 TRUE ，改变返回值为列表。每个列表项是一
个文本行。如果你在意寄存器内可能存在的零字节，可以用这种形式:
不用第三个参数时 NL 和零字节都用 NL 表示 (见
NL-used-for-Nul )。
如果 {regname} 对应的寄存器没有设过，返回空列表。
如果 {regname} 为 ""，使用无名寄存器 '"'。
如果没有指定 {regname}，使用 v:register 。
Vim9-script 中 {regname} 必须为单个字符。
也可用作 method :
GetRegname()->getreg()
返回类型: String 或 list<string>，取决于 {list}
getreginfo([{regname}]) getreginfo()
返回寄存器 {regname} 的详细信息，即带下列项目的字典:
regcontents 寄存器 {regname} 包含的行列表，相当于
getreg ({regname}, 1, 1)。
regtype 寄存器 {regname} 的类型，见
getregtype() 。
isunnamed 布尔标志位，如果无名寄存器当前指向此寄
存器，返回 v:true。
points_to 用于无名寄存器，给出当前指向的寄存器的
单字母名 (见 quotequote )。例如，用
dd 删除一行后，此字段设为 "1"，这是
包含被删除文本的寄存器。
{regname} 参数为字符串。{regname} 非法或对应的寄存器没有设过
时，返回空列表。
如果 {regname} 为 "" 或 "@"，使用无名寄存器 '"'。
如果没有指定 {regname}，使用 v:register 。
返回的字典可传递给 setreg() 。
Vim9-script 中 {regname} 必须为单个字符。
也可用作 method :
GetRegname()->getreginfo()
返回类型: dict<any>
getregion({pos1}, {pos2} [, {opts}]) getregion()
返回缓冲区从 {pos1} 到 {pos2} 的字符串列表。
{pos1} 和 {pos2} 必须为带四个数值的 List 。列表的格式见
getpos() 。可以指定另一缓冲区的位置，但请先看一下
getregion-notes 的限制说明。
可选参数 {opts} 是支持以下项目的字典:
type 指定区域的选择类型。可能值见
getregtype() ，但宽度可以省略，且不能
用空串。
(缺省: "v")
exclusive 如为 TRUE ，结束位置为开的。
(缺省: 跟随 'selection')
可用 visualmode() 得到最近的选择类型。如果可视模式现在激活，
用 mode() 得到可视模式 (如在 :vmap 里)。
此函数可用于获取 characterwise-visual 这种文本开始和结束处可
以在不同列的选择方式。
getregion-notes
请注意:
- {pos1} 和 {pos2} 的顺序无关紧要。总是返回从左上角到右下角的
内容。
- 'virtualedit' 打开时，区域会跨越行尾，生成行里以空格填充。
- 区域面向列块时，如果它的开始或结束处在某多单元字符的中间，不
包括此字符，选中的部分以空格代替。
- {pos1} 和 {pos2} 如不在同一缓冲区，返回空列表。
- {pos1} 和 {pos2} 必须属于一个 bufloaded() 的缓冲区。
- 在当前窗口上下文下计算，如果缓冲区在带有不同的 'virtualedit'
或 'list' 值的窗口中显示，会导致区别。
- 指定开的选择区且 {pos1} 和 {pos2} 相同时，返回列表包含单个字
符，就像选择的是闭区间那样，这匹配可视模式下空的开选择区的行
为。
示例:
:xnoremap <CR>
\ <Cmd>echow getregion(
\ getpos('v'), getpos('.'), #{ type: mode() })<CR>
也可用作 method :
getpos('.')->getregion(getpos("'a"))
返回类型: list<string>
getregionpos({pos1}, {pos2} [, {opts}]) getregionpos()
同 getregion() ，但返回 {pos1} 和 {pos2} 定界的缓冲区文本片段
的位置列表。
片段指的是对应每行上的一对位置:
[[{start_pos}, {end_pos}], ...]
位置是包含四个数值的 List :
[bufnum, lnum, col, off]
"bufnum" 为缓冲区号。
"lnum" 和 "col" 是缓冲区里的位置。首列的列号为 1。
如果起始位置的 "off" 值非零，它指定相对于字符开始处以屏幕列计
的偏移值。如 <Tab> 中间和末字符之后的某个位置。如果结束位置的
"off" 值非零，它指定该字符的首个不在选择范围的单元偏移值，否则
该字符的所有单元都被选择。
除了 getregion() 支持的选项以外，{opts} 也支持下列值:
eol 如为 TRUE ，"col" 用行长加一来指示行
尾之后的位置。
如为 FALSE ，位置被局限在行范围内，如
果行为空或选择区完全在行尾之外，两个位
置的 "col" 都使用 0 值。
(缺省: FALSE )
也可用作 method :
getpos('.')->getregionpos(getpos("'a"))
示例可见高亮-抽出插件 52.6
返回类型: list<list<list<number>>>
getregtype([{regname}]) getregtype()
返回字符串，寄存器 {regname} 的类型。
该值会是以下可能之一:
"v" characterwise (面向字符) 的文本
"V" linewise (面向行) 的文本
"<CTRL-V>{width}" blockwise-visual (面向列块) 的文本
"" 空或者未知的寄存器
<CTRL-V> 是一个字符，其值为 0x16。
{regname} 参数为字符串。如果 {regname} 为 ""，使用无名寄存器
'"'。
如果没有指定 {regname}，使用 v:register 。
Vim9-script 中 {regname} 必须为单个字符。
也可用作 method :
GetRegname()->getregtype()
返回类型: String
getscriptinfo([{opts}]) getscriptinfo()
返回 List ，包含所有已执行的 Vim 脚本的信息，依执行的顺序排
列，类似于 :scriptnames 显示的结果。
可选的字典参数 {opts} 支持以下可选项目:
name 脚本名匹配模式，如指定此项目而不指定 "sid"，返
回名字匹配模式 "name" 的脚本的信息。
sid 脚本 ID <SID> 。如果指定，只返回 ID 为 "sid"
的脚本的信息，忽略 "name"。
返回列表的每个项目是包含以下项目的 Dict :
autoload 脚本用 `import autoload` 载入但尚未真正执行时
为真 (见 import-autoload )。
functions 脚本中定义的局部于脚本的函数名列表。仅为
{opts} 中用 "sid" 项目指定的特定脚本给出。
name Vim 脚本文件名。
sid 脚本 ID <SID> 。
sourced 如有，此脚本名链接到的实际执行的脚本 ID。否则
为零。
variables 脚本中定义的局部于脚本的变量列表。仅为 {opts}
中用 "sid" 项目指定的特定脚本给出。
注意 这是备份，不可用此字典来修改脚本局部变量
的值。
version Vim 脚本版本号 ( scriptversion )
示例:
:echo getscriptinfo({'name': 'myscript'})
:echo getscriptinfo({'sid': 15})[0].variables
返回类型: list<dict<any>>
getstacktrace() getstacktrace()
返回 Vim 脚本的当前栈追踪。
栈追踪是每个项目为包含以下项目的 Dictionary 的 List :
funcref 堆栈在函数上时对应的函数引用，否则此项省略。
event 堆栈在自动命令事件上时对应的事件描述，否则此项
省略。
lnum 堆栈在脚本的行号。
filepath 堆栈在脚本的文件路径。
返回类型: list<dict<any>>
gettabinfo([{tabnr}]) gettabinfo()
如果没指定 {tabnr}，返回 List ，包含所有标签页的信息。每个列
表项是 Dictionary 。
否则，{tabnr} 指定标签页号，返回关于该标签页的信息。如果该标志
页不存在，返回空列表。
每个列表项是包含以下项目的 Dictionary :
tabnr 标签页号
variables 包含标签页局部变量的字典的引用
windows 标签页中的 window-ID 列表。
也可用作 method :
GetTabnr()->gettabinfo()
返回类型: list<dict<any>>
gettabvar({tabnr}, {varname} [, {def}]) gettabvar()
得到标签页 {tabnr} 的标签页局部变量 {varname} 的值。 t:var
标签页的编号从一开始。
{varname} 参数为字符串。如果 {varname} 为空，返回包含所有标签
页局部变量的字典。
注意 必须使用不带 "t:" 的名字。
如果标签页或者变量不存在，返回 {def} 或空字符串。不会有错误消
息。
也可用作 method :
GetTabnr()->gettabvar(varname)
返回类型: any，取决于 {varname}
gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) gettabwinvar()
得到标签页 {tabnr} 的窗口 {winnr} 的窗口局部变量 {varname} 的
值。
{varname} 参数为字符串。如果 {varname} 为空，返回一个包含所有
窗口局部变量的字典。
如果 {varname} 为 "&"，返回包含所有窗口局部选项的
Dictionary 。
否则，如果 {varname} 以 "&" 打头，得到窗口局部选项的值。
注意 {varname} 必须为不带 "w:" 的名字。
标签页的编号从一开始。当前标签页可用 getwinvar() 。
{winnr} 可以是窗口号或 window-ID 。
如果 {winnr} 为零，使用当前窗口。
也可用于全局或者局部于缓冲区或局部于窗口的选项，但不能用于全局
或者局部于缓冲区的变量。
如果标签页、窗口或者变量不存在，返回 {def} 或空字符串。不会有
错误消息。
例如:
:let list_is_on = gettabwinvar(1, 2, '&list')
:echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
要得到所有窗口局部变量，可用:
gettabwinvar({tabnr}, {winnr}, '&')
GetTabnr()->gettabwinvar(winnr, varname)
返回类型: any，取决于 {varname}
gettagstack([{winnr}]) gettagstack()
返回字典，窗口 {winnr} 的标签栈。
{winnr} 可以是窗口号或 window-ID 。
如果没有给出 {winnr}，使用当前窗口。
如果窗口 {winnr} 不存在，返回空字典。
返回字典包含如下项目:
curidx 栈的当前索引。如果在栈顶，设为
(length + 1)。栈底的索引为 1。
items 栈中的项目列表。每个项目是包含下述项的
字典。
length 栈中的项目数。
栈中的每个项目是以下项的字典:
bufnr 当前跳转的缓冲区号
from 标签跳转之前的光标位置。 getpos() 说
明返回列表的格式。
matchnr 当前的匹配标签号。用于同一名字有多个匹
配标签的时候。
tagname 标签名
tagstack 说明标签栈的更多信息。
也可用作 method :
GetWinnr()->gettagstack()
返回类型: dict<any>
gettext({text} [, {package}]) gettext()
对字符串 {text} 进行翻译。
用于 Vim 脚本。要生成消息翻译时，由 xgettext 对 {text} 进行
提取，翻译者会把翻译后的消息加到 .po 文件，调用 gettext() 时，
Vim 会依此查找翻译内容。
{text} 推荐使用双引号括起，因为 xgettext 不理解单引号字符串
里的转义。
给出 {package} 时，只寻找特定于该包的翻译。主要用于第三方 Vim
脚本。需要在使用 gettext() 函数前先用 bindtextdomain() 来指
定翻译所在的路径。
返回类型: String
getwininfo([{winid}]) getwininfo()
返回窗口信息，返回值是字典的 List 。
如果给出 {winid}，返回给定 ID 的窗口的信息，为包含单个项目的
List 。如果窗口是 popup 窗口，返回该弹出窗口的信息。如果窗
口不存在，返回空列表。
如果没有给出 {winid}，返回所有标签页中所有窗口 (但不包括
popup 窗口) 的信息。
每个列表项是包含以下项目的 Dictionary :
botline 最近完整显示的缓冲区行
bufnr 窗口中的缓冲区号
height 窗口高度 (不计窗口工具条 winbar)
leftcol 显示的首列；仅用于 'wrap' 关闭时
loclist 1 如果显示了位置列表
{仅当加入 +quickfix 特性才有效}
quickfix 1 如果是快速修复或位置列表窗口
{仅当加入 +quickfix 特性才有效}
terminal 1 如果是终端窗口
{仅当加入 +terminal 特性才有效}
tabnr 标签页号
topline 首个显示的缓冲区行
variables 包含窗口局部变量的字典的引用
width 窗口宽度
winbar 1 如果窗口有工具条，0 反之
wincol 窗口最左侧屏幕列，
win_screenpos() 中的 "col"
textoff 文本前由 'foldcolumn'、'signcolumn' 和
行号所占据的列数
winid window-ID
winnr 窗口号
winrow 窗口最顶侧屏幕行，
win_screenpos() 中的 "row"
也可用作 method :
GetWinnr()->getwininfo()
返回类型: list<dict<any>>
getwinpos([{timeout}]) getwinpos()
返回两个数值组成的 List ，即 getwinposx() 和 getwinposy()
结果的混合:
[x-pos, y-pos]
{timeout} 可用于以毫秒计的等待终端反馈的超时。省略时缺省为 100
毫秒。远程终端可用更长的超时。
如果取值小于 10 且在指定时限内没有收到反馈，返回如果有的上次报
告的位置。可用于轮询位置并在同时并发做其它的事:
while 1
let res = getwinpos(1)
if res[0] >= 0
break
endif
" 干些话
endwhile
也可用作 method :
GetTimeout()->getwinpos()
返回类型: list<number>
getwinposx() getwinposx()
返回数值，即 GUI Vim 窗口以像素计从左起算的 X 坐标。也适用于
xterm (100 毫秒超时)。
如果该信息得不到 (如在 Wayland 后台上)，返回 -1。
返回值可用于 ":winpos"。
返回类型: Number
getwinposy() getwinposy()
返回数值，即 GUI Vim 窗口以像素计从顶部起算的 Y 坐标。也适用于
xterm (100 毫秒超时)。
如果该信息得不到 (如在 Wayland 后台上)，返回 -1。
返回值可用于 ":winpos"。
返回类型: Number
getwinvar({winnr}, {varname} [, {def}]) getwinvar()
类似于 gettabwinvar() ，只用当前标签页。
例如:
:let list_is_on = getwinvar(2, '&list')
:echo "myvar = " .. getwinvar(1, 'myvar')
GetWinnr()->getwinvar(varname)
返回类型: any，取决于 {varname}
glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) glob()
扩展 {expr} 里的文件通配符。 wildcards 说明其中特殊字符的使用
方法。
除非给出可选的 {nosuf} 参数且为 TRUE ，应用 'suffixes' 和
'wildignore' 选项: 跳过匹配任何 'wildignore' 模式的名字，而
'suffixes' 影响匹配结果的排序。
'wildignorecase' 则总是适用。
如果给出 {list} 且为 TRUE ，返回 List ，包含所有匹配的文件。
使用列表的优点是可以正确得到包含换行符的文件名。
否则返回的是字符串，且如果返回多个匹配，以 <NL> 字符分隔。
如果扩展失败，返回空字符串或空列表。
扩展结果不包含不存在文件的名字。仅当符号链接指向已存在文件时才
会包含在扩展结果内。但若给出了 {alllinks} 参数且为 TRUE ，则
包含所有符号链接。
多数系统上，可以用反引号从外部命令得到文件名。例如:
:let tagfiles = glob("`find . -name tags -print`")
:let &tags = substitute(tagfiles, "\n", ",", "g")
反引号包围的程序的输出结果必须每个项目一行。项目内部可以使用空
格。
特殊 Vim 变量的扩展见 expand() 。 system() 说明如何得到外部
命令的原始输出。
也可用作 method :
GetExpr()->glob()
返回类型: String 或 list<string> 或 list<any>，取决于 {list}
glob2regpat({string}) glob2regpat()
转换 glob() 所用有文件模式为搜索模式。结果可用来匹配包含文件
名的字符串。例如
if filename =~ glob2regpat('Make*.mak')
等价于:
if filename =~ '^Make.*\.mak$'
如果 {string} 为空串，返回值是 "^$"，匹配空串。
备注 结果与所用系统有关。MS-Windows 上反斜杠通常用作路径分隔
符。
也可用作 method :
GetExpr()->glob2regpat()
返回类型: String
globpath()
globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
在 {path} 的所有目录下的字符串 {expr} 执行 glob() 并连接所有
的返回结果。例如:
:echo globpath(&rtp, "syntax/c.vim")
{path} 是逗号分隔的目录名的列表。每个目录名都附加在 {expr} 之
前，然后如同 glob() 那样被扩展。必要的话，插入路径分隔符。
要在目录名字里加上逗号，可以使用反斜杠转义。注意 在 MS-Windows
上目录的最后可能有一个反斜杠。如果你要在后面加上逗号进行分隔，
先把反斜杠去掉。
如果某个目录下的扩展失败，不会有错误信息。
除非给出可选的 {nosuf} 参数且为 TRUE ，应用 'suffixes' 和
'wildignore' 选项: 跳过匹配任何 'wildignore' 模式的名字，而
'suffixes' 影响匹配结果的排序。
如果给出 {list} 且为 TRUE ，返回匹配文件的列表。列表的好处是
会正确处理包含换行符的文件名，否则返回字符串，有多个匹配时，以
<NL> 字符分隔。例如:
:echo globpath(&rtp, "syntax/c.vim", 0, 1)
{alllinks} 的用法可见 glob() 。
可以用 "**" 项目来搜索目录树。例如，寻找在 'runtimepath' 和它
之下所有目录里的 "README.txt" 文件:
:echo globpath(&rtp, "**/README.txt")
不支持向上搜索和 "**" 的深度限制，所以 'path' 的使用不一定总能
正确工作。
也可用作 method ，基是作为第二个参数传递的:
GetExpr()->globpath(&rtp)
返回类型: String 或 list<string> 或 list<any>，取决于 {list}
has({feature} [, {check}]) has()
如果 {check} 省略或为零: 返回数值，如果支持特性 {feature} 则为
1，不然为零。{feature} 参数是大小写忽略的字符串。见下面的
feature-list 。
如果 {check} 给出且非零: 返回数值，如果特性 {feature} 可以支
持，则为 1，不然为零。可用于检查 {feature} 是否有拼写错误，也
可用于检测死代码。要记住旧版本的 Vim 不知道新增的特性，而当前
版本的 Vim 也不会知道已废弃的特性。
另见 exists() 和 exists_compiled() 。
注意 特性不可用时，要跳过会有语法错误的代码，Vim 可能会跳过行
的其余部分，从而丢失其中跟随的 endif 。所以， endif 请另起一
行:
if has('feature')
let x = this->breaks->without->the->feature
endif
如果试图把 endif 移到第二行成为 "| endif"，它不会被找到。
返回类型: Number
has_key({dict}, {key}) has_key()
返回数值，如果 Dictionary {dict} 里存在键为 {key} 的项目，则
为 TRUE，不然为 FALSE。
{key} 参数是字符串。 Vim9 脚本中也接受数值 (并转换为字符串)，
但其它类型都不行。
老式脚本中进行通常的自动转换，转为字符串。
也可用作 method :
mydict->has_key(key)
返回类型: Number
haslocaldir([{winnr} [, {tabnr}]]) haslocaldir()
返回数值:
1 如果窗口用 :lcd 设置过局部目录
2 如果标签页用 :tcd 设置过局部目录
0 其它。
无参数时使用当前窗口。
有 {winr} 则使用当前标签页的该窗口。
有 {winr} 和 {tabnr} 则使用指定标签页的该窗口。
{winr} 可以是窗口号或 window-ID 。
如果 {winnr} 为 -1，它被忽略，只使用标签页。
参数非法时返回 0。
示例:
if haslocaldir() == 1
" 窗口的局部目录情况
elseif haslocaldir() == 2
" 标签页的局部目录情况
else
" 全局目录情况
endif
" 当前窗口
:echo haslocaldir()
:echo haslocaldir(0)
:echo haslocaldir(0, 0)
" 当前标签页的窗口 n
:echo haslocaldir(n)
:echo haslocaldir(n, 0)
" 标签页 m 的窗口 n
:echo haslocaldir(n, m)
" 标签页 m
:echo haslocaldir(-1, m)
也可用作 method :
GetWinnr()->haslocaldir()
返回类型: Number
hasmapto({what} [, {mode} [, {abbr}]]) hasmapto()
返回数值，如果存在某映射，其右边的表达式 (被映射到的部分) 的某
处包含 {what}，并且该映射在 {mode} 指定的模式下存在，返回
TRUE。
参数 {what} 和 {mode} 为字符串。
如果提供 {abbr} 且为 TRUE ，使用缩写而不是映射。不要忘记指定
插入和/或命令行模式。
同时检查全局映射和局部于当前缓冲区的映射以寻找匹配。
如果没有匹配的映射，返回 FALSE。
{mode} 识别下列字符:
n 普通模式
v 可视和选择模式
x 可视模式
s 选择模式
o 操作符等待模式
i 插入模式
l Language-Argument ("r"、"f"、"t" 等等) 模式
c 命令行模式
如果没有提供 {mode}，使用 "nvo"。
该函数可用于检查是否存在映射到 Vim 脚本的某个函数的映射。例
如:
:if !hasmapto('\ABCdoit')
: map <Leader>d \ABCdoit
:endif
这样，到 "\ABCdoit" 的映射只有在到 "\ABCdoit" 的映射还不存在的
时候才会进行。
也可用作 method :
GetRHS()->hasmapto()
返回类型: Number
histadd({history}, {item}) histadd()
把字符串 {item} 加到历史 {history} 里。后者可以是:
hist-names
"cmd" 或 ":" 命令行历史
"search" 或 "/" 搜索模式历史
"expr" 或 "=" 输入表达式历史
"input" 或 "@" 输入行历史
"debug" 或 ">" 调试命令历史
空 当前或最后使用的历史
{history} 字符串无须是完整名字，一个字符就够了。
如果 {item} 已经在历史里存在，它会被调整位置，从而成为最新的一
项。
返回结果为数值: 如果操作成功则为 TRUE，不然返回 FALSE。
例如:
:call histadd("input", strftime("%Y %b %d"))
:let date=input("Enter date: ")
该函数在沙盘里不可用 sandbox 。
也可用作 method ，基是作为第二个参数传递的:
GetHistory()->histadd('search')
返回类型: Number
histdel({history} [, {item}]) histdel()
清除 {history}，换而言之，删除它所有的项目。 hist-names 解释
{history} 的所有可能值。
如果 {item} 计算结果为字符串，它被看作正则表达式。从历史里删除
所有匹配该模式的项目 (如果有的话)。
必须匹配大小写，除非使用 "\c" /\c 。
如果 {item} 的计算结果为数值，它被解释为索引值，见
:history-indexing 。如果该索引存在，删除相应的项目。
返回结果为数值: 如果操作成功则为 TRUE，不然返回 FALSE。
例如:
清除表达式寄存器历史:
:call histdel("expr")
删除所有 "*" 开始的搜索历史:
:call histdel("/", '^\*')
下面三者是等价的:
:call histdel("search", histnr("search"))
:call histdel("search", -1)
:call histdel("search", '^' .. histget("search", -1) .. '$')
要删除最后的搜索模式，并在 "n" 命令和 'hlsearch' 里使用倒数第
二个模式:
:call histdel("search", -1)
:let @/ = histget("search", -1)
也可用作 method :
GetHistory()->histdel()
返回类型: Number
histget({history} [, {index}]) histget()
返回字符串，即 {history} 历史的第 {index} 项。 hist-names 解
释 {history} 的所有可能值，而 :history-indexing 解释
{index}。如果没有这个项目，返回空字符串。如果忽略 {index}，返
回历史里最近使用的项目。
例如:
重做历史里的倒数第二个搜索
:execute '/' .. histget("search", -2)
{num}"，以重新执行 :history 输出的第 {num}
项。
:command -nargs=1 H execute histget("cmd", 0+<args>)
也可用作 method :
GetHistory()->histget()
返回类型: String
histnr({history}) histnr()
返回当前项目在 {history} 里的编号。 hist-names 解释 {history}
的所有可能值。
如果有错，返回 -1。
例如:
:let inp_index = histnr("expr")
GetHistory()->histnr()
返回类型: Number
hlexists({name}) hlexists()
返回数值。只要名为 {name} 的高亮组用某种方法定义过，返回
TRUE。不一定要为该组定义过高亮属性。一些语法项目可能已经使用该
组。
highlight_exists()
已废弃的名字: highlight_exists()。
也可用作 method :
GetName()->hlexists()
返回类型: Number
hlget([{name} [, {resolve}]]) hlget()
返回包含所有高亮组属性的列表。如果给出可选 {name}，只返回指定
高亮组的属性的列表。如果高亮组 {name} 不存在，返回空列表。
如果可选的 {resolve} 参数设为 v:true 而且高亮组 {name} 链接到
另一个组，递归解析链接，并返回最终解析结果的高亮组的属性。
返回列表的每个项目是包含以下项目的字典:
cleared 布尔型标志位，如果高亮组属性被清除或还未指定，
设为 v:true。见 highlight-clear 。
cterm cterm 属性。见 highlight-cterm 。
ctermbg cterm 背景色。见 highlight-ctermbg 。
ctermfg cterm 前景色。见 highlight-ctermfg 。
ctermul cterm 下划线颜色。见 highlight-ctermul 。
default 布尔型标志位，如果高亮组链接是缺省链接，设为
v:true。见 highlight-default 。
font 高亮组字体。见 highlight-font 。
gui gui 属性。见 highlight-gui 。
guibg gui 背景色。见 highlight-guibg 。
guifg gui 前景色。见 highlight-guifg 。
guisp gui 特殊颜色。见 highlight-guisp 。
id 高亮组 ID。
linksto 链接目标高亮组名。见 :highlight-link 。
name 高亮组名。见 group-name 。
start start 终端转义码。见 highlight-start 。
stop stop 终端转义码。见 highlight-stop 。
term 终端属性。见 highlight-term 。
上述字典里的 'term'、'cterm' 和 'gui' 项目本身为字典，带以下可
选布尔型项目: 'bold'、'standout'、'underline'、'undercurl'、
'italic'、'reverse'、'inverse' 和 'strikethrough'。
示例:
:echo hlget()
:echo hlget('ModeMsg')
:echo hlget('Number', v:true)
也可用作 method :
GetName()->hlget()
返回类型: list<dict<any>>
hlset({list}) hlset()
建立或修改一组高亮组的属性。{list} 中的每项对应一个高亮组的属
性字典。此字典支持的项目列表见 hlget 。
除了 hlget() 描述的项目以外，字典还支持以下附加项目:
force 布尔型标志位，强制建立带属性的已有高亮
组的链接。
通过 'name' 项目指定高亮组，忽略 'id' 项目 (如有提供)。如果指
定名字的高亮组不存在，建立之。否则已有的高亮组的属性将被修改。
如果 'term'、'cterm' 或 'gui' 项目指定了空字典，清除对应的属
性。如果 'cleared' 项目设为了 v:true，清除高亮组的所有属性。
'linksto' 项目可用来链接一个高亮组到另一高亮组。见
:highlight-link 。
成功时返回零，而失败时返回 -1。
示例:
" 为 Visual 高亮组加入 bold 属性
:call hlset([#{name: 'Visual',
\ term: #{reverse: 1 , bold: 1}}])
:call hlset([#{name: 'Type', guifg: 'DarkGreen'}])
:let l = hlget()
:call hlset(l)
" 清除 Search 高亮组
:call hlset([#{name: 'Search', cleared: v:true}])
" 清除高亮组的 'term' 属性
:call hlset([#{name: 'Title', term: {}}])
" 建立 MyHlg 组，链接到 DiffAdd
:call hlset([#{name: 'MyHlg', linksto: 'DiffAdd'}])
" 删除 MyHlg 组的链接
:call hlset([#{name: 'MyHlg', linksto: 'NONE'}])
" 清除属性和链接
:call hlset([#{name: 'MyHlg', cleared: v:true,
\ linksto: 'NONE'}])
也可用作 method :
GetAttrList()->hlset()
返回类型: Number
hlID({name}) hlID()
返回数值，即名为 {name} 的高亮组的 ID。如果该高亮组不存在，返
回零。
可用于提取高亮组的信息。比如，要得到 "Comment" 组的背景颜色:
:echo synIDattr(synIDtrans(hlID("Comment")), "bg")
highlightID()
已废弃的名字: highlightID()。
也可用作 method :
GetName()->hlID()
返回类型: Number
hostname() hostname()
返回字符串，即 Vim 运行的机器名字。超过 256 字符串长度的机器名
被截短。
返回类型: String
iconv({string}, {from}, {to}) iconv()
返回字符串，即文本 {string} 从 {from} 编码转到 {to} 编码以后的
文本。
如果转换完全失败，返回空字符串。如果部分字符无法转换，以 "?"
代替之。
编码名字可以是任何 iconv() 库函数接受的名字，见
":!man 3 iconv"。
大多数转换需要 Vim 编译时加入 +iconv 特性。不然，只支持
UTF-8 和 latin1 的相互转换。
这可以用来显示包含特殊字符的消息。不管 'encoding' 设为何值，总
可以用 UTF-8 书写消息，然后使用:
echo iconv(utf8_str, "utf-8", &enc)
注意 Vim 使用 UTF-8 进行所有的 Unicode 编码，从/到 UCS-2 的转
换都自动转为 UTF-8。你不能在字符串里使用 UCS-2，因为那里有 NUL
字节。
也可用作 method :
GetText()->iconv('latin1', 'utf-8')
返回类型: String
id({item}) id()
返回和 {item} 相关联而不是 {item} 内容绑定的唯一字符串。仅当
{item} 存在且被引用时才有效，且仅在生成结果的 vim 实例中有效。
基本想法是 id({item}) 不应随 {item} 内容的改变而改变。这可用
于给字典作 key 时基于身分而不是值的相等。
此操作不引用 {item}，也没有函数可以把 id 转换为 {item}。为
此，可保有一个 id 到 {item} 的映射。下例
var referenceMap: dict<any>
var id = item->id()
referenceMap[id] = item
会防止 {item} 被垃圾回收，同时提供了从 id 取得 {item} 的一种
方法。
{item} 可为列表、元组、字典、对象、作业、通道或 blob。如果
item 不是这些可接受的类型之一或为 null 值，返回空串。
也可用作 method :
GetItem()->id()
返回类型: String
indent({lnum}) indent()
返回数值，第 {lnum} 行的缩进距离。缩进的计算以空格计，因而它和
'tabstop' 的值是有关系的。{lnum} 的使用方式和 getline() 相
同。
{lnum} 非法时返回 -1。 Vim9 脚本会报错。
也可用作 method :
GetLnum()->indent()
返回类型: Number
index({object}, {expr} [, {start} [, {ic}]]) index()
寻找 {object} 中的 {expr}，并返回其索引。要通过匿名函数来选择
项目，可见 indexof() 。
如果 {object} 为 List 或 Tuple ，返回值等于 {expr} 的最小项
目索引。这里不进行自动转换，字符串 "4" 不同于数值 4，数值 4 也
不等同于浮点数 4.0。'ignorecase' 的值此处不适用，大小写是否敏
感由 {ic} 参数决定。
如果 {object} 为 Blob ，返回字节值等于 {expr} 的最小索引。
如果给出 {start}，从索引为 {start} 的项目开始寻找 (可以为负，
指定相对于尾部的项目)。
如果给出 {ic} 且为 TRUE ，忽略大小写。否则，必须匹配大小写。
如果在 {object} 里找不到 {expr}，返回 -1。
示例:
:let idx = index(words, "the")
:if index(numbers, 123) >= 0
GetObject()->index(what)
返回类型: Number
indexof({object}, {expr} [, {opts}]) indexof()
返回 {object} 中的 {expr} 为 v:true 的项目的索引。
{object} 必须为 List 、 Tuple 或 Blob 。
如果 {object} 为 List 或 Tuple ，为列表或元组中的每个项目计
算 {expr}，直到结果结果为 v:true 为止，返回该项目的索引。
如果 {object} 为 Blob ，为 Blob 中的每个字节计算 {expr}，直到
结果结果为 v:true 为止，返回该字节的索引。
{expr} 必须为 string 或 Funcref 。
{expr} 为 string 时: 如果 {object} 为 List 或 Tuple ,
{expr} 中的 v:key 包含当前列表或元组项目的索引，而 v:val
为当前项目值。如果 {object} 为 Blob ，{expr} 中的 v:key 包
含当前字节的索引，而 v:val 为当前字节值。
{expr} 为 Funcref 时，它必须接受两个参数:
1. 当前项目的键值或索引。
2. 当前项目的值。
找到项目时函数必须返回 TRUE ，此时搜索停止。
可选参数 {opts} 为字典，包含以下项目:
startidx 从带此索引的项目开始计算 {expr}；可为负值，索
引值相对于列表尾部
所有项目上的 {expr} 计算结果均为 v:false 时，返回 -1。
示例:
:let l = [#{n: 10}, #{n: 20}, #{n: 30}]
:echo indexof(l, "v:val.n == 20")
:echo indexof(l, {i, v -> v.n == 30})
:echo indexof(l, "v:val.n == 20", #{startidx: 1})
mylist->indexof(expr)
返回类型: Number
input({prompt} [, {text} [, {completion}]]) input()
返回字符串，即用户在命令行上的输入内容，可以为任何值。参数
{prompt} 或者是一个提示字符串，或者是一个空白字符串 (没有提
示)。'\n' 可以在提示里使用，以开始新行。
该提示使用 :echohl 设置的高亮。
输入方法和命令行相似，也使用相同的编辑命令和映射。但 input()
输入的行使用另外的历史。
示例:
:if input("咖啡还是啤酒？") == "啤酒"
: echo "干杯！"
:endif
如果给出可选的 {text} 参数，它被用作缺省的回答，就像是用户输入
的那样。例如:
:let color = input("Color? ", "white")
{completion} 参数指定输入支持的补全类型。如果不给出，不
使用补全。支持的补全类型和用户定义命令用 "-complete=" 参数能给
出的类型相同。详情见 :command-completion 。例如:
let fname = input("File: ", "", "file")
注意: 在只能运行于 GUI 模式的版本里 (比如 Win32 GUI)，此函数不
能在启动文件里使用。
注意: input() 在映射里调用时，它会消耗该映射余下的字符，因为映
射的处理就像那些字符被键盘输入一样。在 input() 前使用
inputsave() 然后在 input() 输入之后 inputrestore() 可以避
免这一点。另一个方法是避免在映射的后面提供任何字符，比如，使用
:execute 或 :normal 。
使用映射的例子:
:nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
:function GetFoo()
: call inputsave()
: let g:Foo = input("enter search pattern: ")
: call inputrestore()
:endfunction
GetPrompt()->input()
返回类型: String
inputdialog({prompt} [, {text} [, {cancelreturn}]]) inputdialog()
类似于 input() ，但如果运行 GUI 且支持文本对话框，弹出一个对
话框窗口来输入文本。
例如:
:let n = inputdialog("value for shiftwidth", shiftwidth())
:if n != ""
: let &sw = n
:endif
如果对话框被取消，返回 {cancelreturn}。如果忽略，返回空字符
串。
输入 <Enter> 和按 OK 按钮相同。按 <Esc> 和按 Cancel 按钮相同。
备注: 不支持命令行补全。
也可用作 method :
GetPrompt()->inputdialog()
返回类型: String
inputlist({textlist}) inputlist()
{textlist} 必须是字符串的 List 。显示此 List ，每个字符串一
行。用户得到提示要输入一个数值，返回此值。
如果命令行上打开鼠标 ('mouse' 为 "a" 或包含 "c")，用户也可以用
鼠标点击项目来进行选择。第一个字符串返回 0。在第一个项目之上点
击返回负数。在提示行上点击返回 {textlist} 的长度加一。
确保 {textlist} 不超过 'lines' 个项目，否则无法使用。建议把项
目编号放在每个字符串的开始处，并在第一项上加上提示。例如:
let color = inputlist(['Select color:', '1. red',
\ '2. green', '3. blue'])
GetChoices()->inputlist()
返回类型: Number
inputrestore() inputrestore()
恢复前一个 inputsave() 保存的预输入。应该和 inputsave() 调
用的次数相同，不过调用更多次也无妨。
如果没有可以恢复的，返回 TRUE，不然返回 FALSE。
返回类型: Number
inputsave() inputsave()
保存预输入 (也包括映射的) 并清除之，使得下一个提示能从用户得到
输入。在提示之后应该跟上配套的 inputrestore() 。可以多次使
用，此时应该有同样多次的 inputrestore() 调用。
如果内存不足，返回 TRUE，不然返回 FALSE。
返回类型: Number
inputsecret({prompt} [, {text}]) inputsecret()
该函数和 input() 函数类似，但有两个例外:
a) 用户的应答显示为一串星号 ("*")，从而输入可以保密，还有
b) 用户的应答不会记录在输入 history 栈中。
返回字符串，即用户在命令行上根据提示输入的应答。
备注: 不支持命令行补全。
也可用作 method :
GetPrompt()->inputsecret()
返回类型: String
insert({object}, {item} [, {idx}]) insert()
如果 {object} 为 List 或 Blob ，在开始处插入 {item}。
如果指定 {idx}，{item} 的插入位置在索引 {idx} 之前。如果
{idx} 为零，插入在第一个项目之前，和省略 {idx} 效果相同。也可
用负的 {idx}，见 list-index 。-1 插入在最后一个项目之前。
返回新产生的 List 或 Blob 。例如:
:let mylist = insert([2, 3, 5], 1)
:call insert(mylist, 4, -1)
:call insert(mylist, 6, len(mylist))
用 add() 可以更简单的完成最后一个例子。
注意 如 {item} 是 List ，它被作为单个项目来插入。 extend()
用来连接多个 List 。
也可用作 method :
mylist->insert(item)
返回类型: Number
instanceof({object}, {class}) instanceof() E614 E616 E693
返回数值，如果 {object} 参数为 {class} 指定的 Class 、
Interface 或类 :type 别名的直接或间接实例，返回 TRUE 。
{class} 是可变参数时，如果 {object} 为其中指定类之一的实例，返
回 TRUE 。
示例:
instanceof(animal, Dog, Cat)
myobj->instanceof(mytype)
返回类型: Number
interrupt() interrupt()
中断脚本的执行。它或多或少像用户按了 CTRL-C 一样。多数命令不再
执行，控制权还给用户。可用于中止较底层如自动命令等的执行。
如:
:function s:check_typoname(file)
: if fnamemodify(a:file, ':t') == '['
: echomsg 'Maybe typo'
: call interrupt()
: endif
:endfunction
:au BufWritePre * call s:check_typoname(expand('<amatch>'))
返回类型: void
invert({expr}) invert()
按位取反。参数须转换为数值。列表、字典或浮点数参数会报错。
示例:
:let bits = invert(bits)
:let bits = bits->invert()
返回类型: Number
isabsolutepath({path}) isabsolutepath()
返回数值，如果 {path} 为绝对路径则为 TRUE 。
Unix 上，绝对路径是指 '/' 开始的路径。
MS-Windows 上，绝对路径是指由可选的驱动器前缀前导，后跟 '\' 或
'/' 的路径。UNC 路径总是绝对的。
示例:
echo isabsolutepath('/usr/share/') " 1
echo isabsolutepath('./foobar') " 0
echo isabsolutepath('C:\Windows') " 1
echo isabsolutepath('foobar') " 0
echo isabsolutepath('\\remote\file') " 1
也可用作 method :
GetName()->isabsolutepath()
返回类型: Number
isdirectory({directory}) isdirectory()
返回数值，如果名为 {directory} 的目录存在，返回 TRUE 。如果
{directory} 不存在或者不是目录，返回 FALSE 。{directory} 可以
是任何表达式，最终用作字符串。
也可用作 method :
GetName()->isdirectory()
返回类型: Number
isinf({expr}) isinf()
如果 {expr} 是正无穷大返回 1，负无穷大返回 -1，否则返回 0。
:echo isinf(1.0 / 0.0)
1
:echo isinf(-1.0 / 0.0)
-1
也可用作 method :
Compute()->isinf()
返回类型: Number
islocked({expr}) islocked() E786
返回数值，如果 {expr} 是某个加锁的变量名，返回 TRUE 。
字符串 {expr} 必须是变量名、 List 项目，或 Dictionary 项
目，不是变量本身！例如:
:let alist = [0, ['a', 'b'], 2, 3]
:lockvar 1 alist
:echo islocked('alist') " 1
:echo islocked('alist[1]') " 0
{expr} 是不存在的变量，返回 -1。如果 {expr} 使用越界的范
围、列表或字典索引，报错。用 exists() 可以检查变量是否存在。
Vim9 脚本里，此函数不适用于局部函数变量。
也可用作 method :
GetName()->islocked()
返回类型: Number
isnan({expr}) isnan()
如果 {expr} 是值为 NaN 的浮点数，返回 TRUE 。
echo isnan(0.0 / 0.0)
1
也可用作 method :
Compute()->isnan()
返回类型: Number
items({expr}) items()
返回 List ，{expr} 的所有键/索引-值组对。每个 List 项目是两
个项目的列表:
- 对 Dict 而言: 键和值
- 对 List 、 Tuple 、 Blob 和 String 而言: 索引和值
对 Dict 而言，返回的 List 项目的顺序不定。否则，依索引值升
序排序。
另见 keys() 和 values() 。
示例:
let mydict = #{a: 'red', b: 'blue'}
for [key, value] in items(mydict)
echo $"{key} = {value}"
endfor
echo items([1, 2, 3])
echo items(('a', 'b', 'c'))
echo items("foobar")
echo items(0z0102)
也可用作 method :
mydict->items()
返回类型: list<list<any>> 或 list<any>
job_ 函数文档在这里: job-functions-details
join({expr} [, {sep}]) join()
连接所有 {expr} 项目成为字符串。{expr} 可以是 List 或
Tuple 。
如果指定 {sep}，该分隔符出现在项目之间。如果省略 {sep}，用单个
空格。
注意 尾部不加 {sep}。如果你坚持要加入:
let lines = join(mylist, "\n") .. "\n"
字符串项目照原样使用。用类似 string() 的方式把 List 、
Tuple 和 Dictionary 转化为字符串。逆函数是 split() 。
也可用作 method :
mylist->join()
返回类型: String
js_decode({string}) js_decode()
和 json_decode() 类似，但有以下区别:
- 对象键名不需用引号括起。
- 字符串可以用单引号括起。
- 接受数组的空项目 (两个逗句之间)，返回 v:none 项目。
也可用作 method :
ReadObject()->js_decode()
返回类型: any，取决于 {varname}
js_encode({expr}) js_encode()
和 json_encode() 类似，但有以下区别:
- 对象键名不用引号括起。
- 数组里的 v:none 项目生成逗号之间的空项目。
例如，Vim 对象:
[1,v:none,{"one":1},v:none]
会被编码为:
[1,,{one:1},,]
而 json_encode() 会生成:
[1,null,{"one":1},null]
对 Javscript，这种编码也是合法的。但比 JSON 更高效，尤其是使用
有可选项目的数组时。
也可用作 method :
GetObject()->js_encode()
返回类型: String
json_decode({string}) json_decode() E491
解析 JSON 格式的字符串，返回等价的 Vim 值。见 json_encode()
了解 JSON 和 Vim 值的关系。
解码是容错的:
- 忽略数组和对象拖尾的逗号，例如 "[1, 2, ]" 等同 "[1, 2]"。
- 对象中接受整数键，如 {1:2} 和 {"1":2} 相同。
- 识别更多浮点数，例如 "1." 相当于 "1.0"，而 "001.2" 相当于
"1.2"。接受特殊浮点值 "Infinity"、"-Infinity" 和 "NaN" (大小
写无关)。
- 忽略整数值前导零，例如 "012" 相当于 "12"，而 "-012" 相当于
"-12"。
- 按本义名 null、true 或 false 的大小写无关，例如 "NULL" 相当
于 "null"，"True" 相当于 "true"。
- 接受字符串中不转义的控制字符 U+0000 到 U+001F，例如 " "
(字符串中的制表符) 相当于 "\t"。
- 接受空或只有空白组成的 JSON 表达式，生成 v:none。
- 忽略非法的两字符转义序列中的反斜杠，例如 "\a" 解码为 "a"。
- JSON 字符串中正确的代理对正常应是 12 字符的序列，如
"\uD834\uDD1E"，但 json_decode() 安静地接受截断的代理对，例
如 "\uD834" 或 "\uD834\u"。
E938
对象里的重复键值，虽然在 rfc7159 中合法，便不被 json_decode()
接受，因为转换结果必须是合法的 Vim 类型，例如，这样不行:
{"a":"b", "a":"c"}
也可用作 method :
ReadObject()->json_decode()
返回类型: any，取决于 {varname}
json_encode({expr}) json_encode()
对 {expr} 进行 JSON 编码，返回字符串。
编码格式在此指定:
https://tools.ietf.org/html/rfc7159.html
Vim 值的转换如下: E1161
Number 十进制数
Float 浮点数
Float nan "NaN"
Float inf "Infinity"
Float -inf "-Infinity"
String 双引号括起 (可为 null)
Funcref 不接受，报错
List 作为数组 (可为 null)；若递归使用: []
Tuple 作为数组 (可为 null)；若递归使用: []
Dict 作为对象 (可为 null)；若递归使用: {}
Blob 作为一个个字节组成的数组
v:false "false"
v:true "true"
v:none "null"
v:null "null"
备注 NaN 和 Infinity 作为值传递。这在 JSON 标准里没有提到，但
若干实现支持。如果不支持，可能会报错。
字符串时包含非法字符时，使用字符 0xfffd 替代。
也可用作 method :
GetObject()->json_encode()
返回类型: String
keys({dict}) keys()
返回 List ，{dict} 的所有键。 List 项目的顺序不定。另见
items() 和 values() 。
也可用作 method :
mydict->keys()
返回类型: list<string>
keytrans({string}) keytrans()
把键值的内部字节表示方式转换为 :map 可接受的形式。如
:let xx = "\<C-Home>"
:echo keytrans(xx)
<C-Home>
也可用作 method :
"\<C-Home>"->keytrans()
返回类型: String
len({expr}) len() E701
返回数值，参数的长度。
如果 {expr} 为字符串或数值，返回它使用的字节数，和 strlen()
相同。
如果 {expr} 为 List ，返回 List 的项目数量。
如果 {expr} 为 Tuple ，返回 Tuple 的项目数量。
如果 {expr} 为 Blob ，返回字节数。
如果 {expr} 为 Dictionary ，返回 Dictionary 的项目数量。
如果 {expr} 为 {Object|，调用对象 (如有) 的 len() 方法来取得长
度值 ( object-len() )。
否则报错并返回零。
也可用作 method :
mylist->len()
返回类型: Number
libcall({libname}, {funcname}, {argument}) libcall() E364 E368
在运行库 {libname} 里调用函数 {funcname} 并给出单个参数
{argument}。
这可以用于调用库里的函数，尤其是 Vim 里用到的那些。因为只能使
用单个参数，所以可以调用的标准库函数相当有限。
结果是函数返回的字符串。如果函数返回 NULL，在 Vim 里会以空字符
串 "" 出现。
如果函数返回数值，请使用 libcallnr() ！
如果 {argument} 是数值，它以 int 类型传给函数；如果 {argument}
是字符串，它以 null 结尾的字符串类型传入。
在 restricted-mode 里，该函数不能运行。
libcall() 允许你写自己的 Vim '插件' 扩展，而无须重新编译程序。
它并 不 是用来调用系统函数的一个方法！如果你试图这么做，Vim 很
有可能会崩溃。
Win32 上，你写的函数必须在 DLL 里提供，而且必须使用普通的 C 调
用惯例 ( 不是 Windows 系统 DLL 使用的 Pascal 惯例)。函数必须
只能接受单个参数，或者是字符指针，或者是长整数，而且必须返回字
符指针或者 NULL。返回的字符指针必须指向在函数返回之后仍然指向
合法的内存 (比如 DLL 的静态区域)。如果指向分配的区域，那么内存
会发生泄漏。在函数里使用静态缓冲区应该可以，在 DLL 卸载时会被
释放。
警 告: 如果函数返回不合法的指针，Vim 会崩溃！如果函数返回数值
也会发生同样的问题，因为 Vim 把它当作指针看待。
Win32 系统上，{libname} 必须是不带 ".DLL" 后缀的 DLL 文件名。
只有 DLL 不在常见的位置的时候，才需要指定完整的路径名。
Unix 上: 如果编译你自己的插件，记住目标代码必须生成位置无关代
码 ('PIC')。
{仅当使用 Win32 和一些 Unix 版本且带有 +libcall 特性时才有
效}
例如:
:echo libcall("libc.so", "getenv", "HOME")
GetValue()->libcall("libc.so", "getenv")
libcallnr({libname}, {funcname}, {argument}) libcallnr()
和 libcall() 类似，但函数返回 int，而不是字符串。
{仅当使用 Win32 和一些 Unix 版本且带有 +libcall 特性时才有
效}
例如:
:echo libcallnr("/usr/lib/libc.so", "getpid", "")
:call libcallnr("libc.so", "printf", "Hello World!\n")
:call libcallnr("libc.so", "sleep", 10)
也可用作 method ，基是作为第三个参数传递的:
GetValue()->libcallnr("libc.so", "printf")
返回类型: String
line({expr} [, {winid}]) line()
返回数值，即 {expr} 给定的文件位置行号。{expr} 参数是字符串。
可接受的位置见 getpos() 。
要得到列号用 col() 。两者都要可用 getpos() 。
给出可选的 {winid} 参数时，从该窗口取值而不是当前窗口。
{expr} 和 {winid} 有非法值时返回 0。
例如:
line(".") 光标所在的行号
line(".", winid) 同上，但取自窗口 "winid"
line("'t") 位置标记 t 的行号
line("'" .. marker) 名为 marker 的位置标记的行号
要在打开文件后跳转到最近已知的位置，见 last-position-jump 。
也可用作 method :
GetValue()->line()
返回类型: Number
line2byte({lnum}) line2byte()
返回当前缓冲区第 {lnum} 行从缓冲区开始计算的字节数。这里包括换
行符，但它具体的值取决于当前缓冲区的 'fileformat' 选项，第一行
返回 1。这和 'encoding' 有关但忽略 'fileencoding'。
这也可以用来得到最后一行之后的 "那行" 的字节计数:
line2byte(line("$") + 1)
这就等于缓冲区大小加一。如果 'fileencoding' 为空则等于文件大小
加一。{lnum} 的用法可见 getline() 。{lnum} 非法或者编译时关闭
了 +byte_offset 特性时返回 -1。
另见 byte2line() 、 go 和 :goto 。
也可用作 method :
GetLnum()->line2byte()
返回类型: Number
lispindent({lnum}) lispindent()
得到第 {lnum} 行根据 lisp 缩进规则应有的缩进距离，见 'lisp'。
缩进的计算以空格计，因而和 'tabstop' 的值是有关系的。
{lnum} 的使用方式和 getline() 相同。
{lnum} 非法时返回 -1。 Vim9 脚本会报错。
也可用作 method :
GetLnum()->lispindent()
返回类型: Number
list2blob({list}) list2blob()
返回连接 {list} 中所有数值的 blob。例如:
list2blob([1, 2, 3, 4]) returns 0z01020304
list2blob([]) returns 0z
出错时返回空 blob。如果有数值为负或大于 255，报错
E1239 。
blob2list() 是其逆操作。
也可用作 method :
GetList()->list2blob()
返回类型: Blob
list2str({list} [, {utf8}]) list2str()
把 {list} 中的每个数值转换为字符，并连接成字符串。例如:
list2str([32]) 返回 " "
list2str([65, 66, 67]) 返回 "ABC"
也可以这样实现 (慢):
join(map(list, {nr, val -> nr2char(val)}), '')
str2list() 是其逆操作。
{utf8} 省略或为零时，使用当前 'encoding'。
{utf8} 为 TRUE 时，总是返回 UTF-8 字符。
使用 UTF-8 时，组合字符正常工作:
list2str([97, 769]) 返回 "á"
出错时返回空串。
也可用作 method :
GetList()->list2str()
返回类型: String
list2tuple({list}) list2tuple()
从列表项目的浅备份建立元组。示例:
list2tuple([1, 2, 3]) 返回 (1, 2, 3)
tuple2list() 是其逆操作。
此函数不会递归转换 {list} 里的所有列表项目为元组。注意列表和元
组的项目只有一份，所以修改项目会同时修改元组和列表里的内容。
出错时返回空元组。
也可用作 method :
GetList()->list2tuple()
返回类型: tuple<{type}> (取决于给定的 List )
listener_add({callback} [, {buf} [, {unbuffered}]]) listener_add()
添加缓冲区 {buf} 有改动时会被执行的回调函数。
{buf} 可以是缓冲区名或号。它可接受的值见 bufname() 。省略
{buf} 时使用当前缓冲区。
返回唯一的 ID，可传递给 listener_remove() 。
如果 {buf} 已注册过回调，这等价于在增加新回调之前，先调用
listener_flush({buf})
函数。
{callback} 调用时带五个参数:
bufnr 发生改动的缓冲区
start 改动发生的首行行号
end 改动区域之下的首行行号
added 增加的行数，如果删除行则为负数
changes 关于改动细节的项目列表
示例:
func Listener(bufnr, start, end, added, changes)
echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed'
endfunc
call listener_add('Listener', bufnr)
译者注: 应为末？) 个删除行之下
的那行
added 负数，删除的行数
col 1
行发生改动时:
lnum 首个改动行
end 最后改动行之下的那行
added 0
col 改动发生的首列，或 1
{unbuffered} 为 FALSE 或未给出时，调用 {callback} 的时刻为:
1. 在屏幕刚刚刷新前。
2. 调用 listener_flush() 时。
3. 发生了影响行计数的改动，以致于修改列表里的某行的行号不再有
效。
依改动发生的次序列出项目，这样最近发生的改动在最后。
因为上面列出的触发回调的第三个触发的原因，传递给的回调的行号未
必能保证有效。如果这会导致问题，把 {unbuffered} 设为 TRUE 。
{unbuffered} 为 TRUE 时，每一个改动都会触发 {callback}。改动
列表只保留单一字典，字典里的 "start"、"end" 和 "added" 值和对
应的回调参数相同。调用回调时的行号一定是合法的，但之后的改动可
能会使之非法，所以不建议保留其备份为之后使用。
{callback} 调用时文本被锁定，见 textlock 。如果需要改动缓冲
区，使用定时器可以在之后某时进行需要的改动 timer_start() 。
{callback} 中不能调用 listener_add()。 E1569
缓冲区初次载入时不调用 {callback}。 BufReadPost 自动命令事件
可用来处理缓冲区的初始文本。
缓冲区被卸载时也不调用 {callback}， BufUnload 自动事件可用于
此。
{callback} 或 {buf} 非法时返回零。
也可用作 method ，基是作为第二个参数传递的:
GetBuffer()->listener_add(callback)
返回类型: Number
listener_flush([{buf}]) listener_flush()
调用缓冲区 {buf} 的监听器回调。如果没有待处理的改动则不调用回
调。
{buf} 可以是缓冲区名或号。它可接受的值见 bufname() 。省略
{buf} 时使用当前缓冲区。
也可用作 method :
GetBuffer()->listener_flush()
返回类型: Number
listener_remove({id}) listener_remove()
删除之前用 listener_add() 加的监听器。
如果 {id} 找不到返回 FALSE，{id} 已删除时返回 TRUE。
也可用作 method :
GetListenerId()->listener_remove()
返回类型: Number
localtime() localtime()
返回当前时间，以 1970 年 1 月 1 日开始的秒数计算。另见
strftime() 、 strptime() 和 getftime() 。
返回类型: Number
log({expr}) log()
返回浮点数，即浮点数 {expr} 的自然对数 (即以 e 为底)。
{expr} 计算结果必须为 (0, inf] 区间内的 Float 或 Number 。
如果 {expr} 不是 Float 或 Number ，返回 0.0。
示例:
:echo log(10)
2.302585
:echo log(exp(5))
5.0
也可用作 method :
Compute()->log()
返回类型: Float
log10({expr}) log10()
返回浮点数，即浮点数 {expr} 以 10 为底的对数。
{expr} 计算结果必须为 Float 或 Number 。
如果 {expr} 不是 Float 或 Number ，返回 0.0。
示例:
:echo log10(1000)
3.0
:echo log10(0.01)
-2.0
也可用作 method :
Compute()->log10()
返回类型: Float
luaeval({expr} [, {expr}]) luaeval()
执行 Lua 表达式 {expr} 并把结果转换为 Vim 数据结构。第二个
{expr} 指定在第一个 {expr} 里可以使用的额外参数，可以 _A 形式
访问。
字符串原样返回。
布尔值对象转换为数值。
数值转换为 Float 。
vim.eval() 得到的字典和列表以原样返回。
lua-luaeval 有更多详情。
注意 :def 函数里的局部变量对 {expr} 不可见。
也可用作 method :
GetExpr()->luaeval()
返回类型: any，取决于 {expr}
{仅当编译时加入 +lua 特性才有效}
map({expr1}, {expr2}) map()
{expr1} 必须是 List 、 String 、 Blob 或 Dictionary 。
{expr1} 是 List 或 Dictionary 时，{expr1} 里的每个项目被
{expr2} 的计算结果替代。
Blob 的每个字节被替代。
String 的每个字符，包括组合字符，被替代。
如果项目的类型发生变化，可以考虑用 mapnew() 来创建新的列表或
字典。Vim9 脚本里这是必须的。
{expr2} 必须是 String 或 Funcref 。
如果 {expr2} 是 String ，{expr2} 内的 v:val 包含当前项目的
值。 Dictionary 中 v:key 包含当前项目的键。 List 中
v:key 包含当前项目的索引。 Blob 中 v:key 包含当前字节的索
引。 String 中 v:key 包含当前字符的索引。
例如:
:call map(mylist, '"> " .. v:val .. " <"')
"mylist" 里的每个项目之前放上 "> "，而之后放上 " <"。
注意 {string} 是表达式的计算结果，而它本身又用作表达式。通常，
最好用 literal-string 来避免反斜杠加倍。当然，你仍然需要加倍
' 引号。
如果 {expr2} 是 Funcref ，它必须接受两个参数:
1. 当前项目的键或索引。
2. 当前项目的值。
用老式脚本匿名函数时如果它只接受一个参数，不报错。但 Vim9 匿名
函数会报错 "E1106: One argument too many"，参数数目必须匹配。
函数必须返回项目的新值。例如要改变每个值为 "键-值":
func KeyValue(key, val)
return a:key .. '-' .. a:val
endfunc
call map(myDict, function('KeyValue'))
使用 lambda 会更短:
call map(myDict, {key, val -> key .. '-' .. val})
如果不用 "val"，可以不写:
call map(myDict, {key -> 'item: ' .. key})
如果不用 "key"，可以使用短名:
call map(myDict, {_, val -> 'item: ' .. val})
对 List 或 Dictionary 而言，本操作是原位操作 (直接在输入上
修改)。要想不更动原始输入，先建立备份:
:let tlist = map(copy(mylist), ' v:val .. "\t"')
{expr1}，经过过滤的 List 或 Dictionary ，或者新的
Blob 或 String 。
执行 {expr2} 出现错误时，不再处理 {expr1} 的其余项目。
{expr2} 是函数引用时，忽略函数里的错误，除非该函数用 "abort"
标志位定义。
也可用作 method :
mylist->map(expr2)
返回类型: String 、 Blob 、list<{type}> 或 dict<{type}>，
取决于 {expr1}
maparg({name} [, {mode} [, {abbr} [, {dict}]]]) maparg()
当 {dict} 省略或为零，返回模式 {mode} 名为 {name} 的映射的右手
边 (rhs)。返回字符串中的特殊字符用和 ":map" 命令输出的同样方式
进行翻译。如果 {dict} 为 TRUE，返回字典，见下。要得到所有映射
的列表，可用 maplist() 。
如果没有名为 {name} 的映射，{dict} 为 FALSE 时返回空串，否则返
回空字典。如果名为 {name} 的映射为空，返回 "<Nop>"。
{name} 可包含特殊键名，一如 ":map" 命令。
{mode} 可以使用下列字符串之一:
"n" 普通模式
"v" 可视模式 (包括选择)
"o" 操作符等待模式
"i" 插入模式
"c" 命令行模式
"s" 选择模式
"x" 可视模式
"l" 语言映射 language-mapping
"t" 终端-作业
"" 普通、可视和操作符等待模式。
如果没有提供 {mode}，使用 "" 指定的模式。
如果提供 {abbr} 且为 TRUE ，使用缩写而不是映射。
如果提供 {dict} 且为 TRUE ，返回字典，包含关于映射的所有信
息。有如下项目: mapping-dict
"lhs" 映射的 {lhs}，作为键盘输入
"lhsraw" 映射的 {lhs}，保留原始字节
"lhsrawalt" 映射的 {lhs}，保留原始字节，这是一种替代形式，仅
当和 "lhsraw" 不同时才会存在
"rhs" 映射的 {rhs}，作为键盘输入。
"silent" 1 若是 :map-silent 映射，否则为 0。
"noremap" 1 若是映射的 {rhs} 不能再映射。
"script" 1 若是映射使用 <script> 定义。
"expr" 1 若是表达式映射 ( :map-<expr> )。
"buffer" 1 若是缓冲区本地映射 ( :map-local )。
"mode" 映射定义使用的模式。除了以上提到的模式以外，还会
使用:
" " 普通、可视和操作符等待模式
"!" 插入和命令行模式
( mapmode-ic )
"sid" 脚本局部 ID，用于 <sid> 映射 ( <SID> )。负值用于
特殊上下文。
"scriptversion" 脚本版本。 Vim9 脚本返回 999999。
"lnum" "sid" 中的行号，如果未知则为零。
"nowait" 不等待其它更长的映射。( :map-<nowait> )。
"abbr" 如为缩写 abbreviations 则为真。
"mode_bits" "mode" 的 Vim 内部二进制表示。 mapset() 忽略
之，只用 "mode"。用法举例可见 maplist() 。其值来
自 src/vim.h，将来可能会改变。
此字典可用 mapset() 来恢复映射。
先检查局部于当前缓冲区的映射，然后再检查全局映射。
此函数可以用来给键映射。如果已经映射过，还可以使用原来映射的内
容。大意:
exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
GetKey()->maparg('n')
返回类型: String 或 dict<any>，取决于 {dict}
mapcheck({name} [, {mode} [, {abbr}]]) mapcheck()
检查是否有模式 {mode} 下匹配 {name} 的映射。 maparg() 说明
{mode} 和 {name} 里的特殊键名。
如果提供 {abbr} 且为 TRUE ，使用缩写而不是映射。
匹配在映射名以 {name} 开始或者映射名等于 {name} 的开始部分时候
发生。
匹配映射 "a" "ab" "abc"
mapcheck("a") 是 是 是
mapcheck("abc") 是 是 是
mapcheck("ax") 是 否 否
mapcheck("b") 否 否 否
和 maparg() 的差别是，mapcheck() 查找匹配 {name} 的映射，而
maparg() 只查找名字完全符合 {name} 的映射。
如果没有 {name} 开始的映射，返回空字符串。如果有一个，返回该映
射的右手边。如果有多个，返回其中某一个的右手边。如果该右手边为
空，返回 "<Nop>"。
先检查局部于当前缓冲区的映射，然后再检查全局映射。
该函数用于检查是否可以无二义性地添加映射。例如:
:if mapcheck("_vv") == ""
: map _vv :set guifont=7x13<CR>
:endif
就避免了在已有 "_v" 或者 "_vvv" 映射的时候添加 "_vv" 映射。
也可用作 method :
GetKey()->mapcheck('n')
返回类型: String
maplist([{abbr}]) maplist()
返回所有映射的 List 。每个列表项目是 Dict ，和 maparg() 返
回值相同，见 mapping-dict 。如果给出 {abbr} 且为 TRUE ，使用
缩写而不是映射。
显示后手边使用 'MultiMatch' 的所有映射的例子:
vim9script
echo maplist()->filter(
(_, m) => match(m.rhs, 'MultiMatch') >= 0)
要找到特定 :map-modes 的所有映射需要点技巧。 mapping-dict
里的 "mode_bits" 可以简化。例如，对应普通、插入或命令行模式的
mode_bits 是 0x19。要找到所有这些模式的映射:
vim9script
var saved_maps = []
for m in maplist()
if and(m.mode_bits, 0x19) != 0
saved_maps->add(m)
endif
endfor
echo saved_maps->mapnew((_, m) => m.lhs)
mode_bits 的值在 Vim 的 src/vim.h 源代码里定义，运行时可用
:map-commands 和 "maplist()" 找到。例如:
vim9script
omap xyzzy <Nop>
var op_bit = maplist()->filter(
(_, m) => m.lhs == 'xyzzy')[0].mode_bits
ounmap xyzzy
echo printf("Operator-pending mode bit: 0x%x", op_bit)
返回类型: list<dict<any>>
mapnew({expr1}, {expr2}) mapnew()
类似于 map() ，但生成并返回新的列表或字典而不是替换 {expr1}
里的项目。{expr1} 保持不变。项目仍然可由 {expr2} 改变，如果不
想如此，先用 deepcopy() 。
返回类型: String 、 Blob 、list<{type}> 或 dict<{type}>，
取决于 {expr1}
mapset({mode}, {abbr}, {dict}) mapset()
mapset({dict})
从 maparg() 或 maplist() 返回的字典中恢复映射。dict.buffer
为真时，使用缓冲区映射，此时在当前缓冲区上设置映射；调用者应确
保要操作的缓冲区是当前缓冲区。此特性可以把一个缓冲区上的映射复
制到另一个缓冲区里。dict.mode 值可以恢复适用于多个模式的单个映
射，比如使用 mode 值 '!'、' '、'nox' 或 'v'。 E1276
第一种形式里，{mode} 和 {abbr} 应和 maparg() 调用时所用之值
相同。 E460
{mode} 用于定义映射设置所在的模式，而不是 {dict} 中的 "mode"
项目。
保存和恢复映射的示例:
let save_map = maparg('K', 'n', 0, 1)
nnoremap K 其它映射值
...
call mapset('n', 0, save_map)
注意 要替换适用于若干模式下的映射，如 :map! 这样的，你需要分
别保存/恢复所有模式下的映射，它们可能不同。
第二种形式里，{dict} 是唯一的参数，mode 和 abbr 取自于 dict。
示例:
vim9script
var save_maps = maplist()->filter(
(_, m) => m.lhs == 'K')
nnoremap K somethingelse
cnoremap K somethingelse2
# ...
unmap K
for d in save_maps
mapset(d)
endfor
返回类型: Number
match({expr}, {pat} [, {start} [, {count}]]) match()
如果 {expr} 是 List ，返回匹配 {pat} 的第一个项目的索引。每个
项目用作字符串， List 和 Dictionary 使用回显的形式。
否则，{expr} 用作字符串。返回数值，给出 {expr} 里 {pat} 匹配的
(字节计算的偏移量) 位置。
在第一个字符或 List 项目上的匹配返回零。若无匹配，返回 -1。
要得到子匹配，见 matchlist() 。
例如:
:echo match("testing", "ing") " 返回 4
:echo match([1, 'x'], '\a') " 返回 1
string-match 说明如何使用 {pat}。
strpbrk()
Vim 没有 strpbrk() 函数。但你可以这么做:
:let sepidx = match(line, '[.,;: \t]')
strcasestr()
Vim 没有 strcasestr() 函数。但你可以在模式里加入 "\c" 以忽略大
小写:
:let idx = match(haystack, '\cneedle')
如果给出 {start}，搜索从字符串的字节位置 {start} 或 List 索
引为 {start} 的项目开始。
不过，结果仍然从第一个字符/项目开始算起。比如:
:echo match("testing", "ing", 2)
返回结果是 "4"。
:echo match("testing", "ing", 4)
返回结果还是 "4"。
:echo match("testing", "t", 2)
返回 "3"。
对字符串而言，如果 {start} > 0，其行为就像该字符串在 {start}
个字节后开始，因而 "^" 会从 {start} 开始匹配。如果给出 {count}
时则不是如此，此时忽略 {start} 字节前的匹配 (有一点复杂，这是
为了后向兼容)。
对字符串而言，如果 {start} < 0，它被置为 0。对列表而言，此索引
从尾部起算。
如果 {start} 越界 (字符串 {start} > strlen({expr})，而 List
{start} > len({expr}))，返回 -1。
如果给出 {count}，使用第 {count} 个匹配。如果字符串里找到一个
匹配，下一匹配从此匹配之后一个字符开始寻找。所以下例返回 1:
echo match("testing", "..", 0, 2)
List 里，搜索从下一个项目开始。
注意 如果加入 {count}，{start} 使用的方式有所改变。见上。
match-pattern
pattern 说明可以接受的模式。
'ignorecase' 选项用来设定模式是否忽略大小写。 不 使用
'smartcase'。匹配总是假定置位了 'magic' 而 'cpoptions' 为空。
注意 优先考虑开始处的匹配，所以使用 "*" (任意数目的匹配) 时，
模式倾向于寻找开始处的零匹配而不是文本内部的多数目匹配。
也可用作 method :
GetText()->match('word')
GetList()->match('word')
返回类型: Number
matchadd() E290 E798 E799 E801 E957
matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
定义模式 (一个 "匹配")， 在当前窗口用高亮组 {group} 高亮。返回
标识号 (ID)， matchdelete() 可用该 ID 来删除匹配。该 ID 是和
窗口绑定的。
匹配是大小写敏感和带魔术的，但大小写敏感性和魔术性在 {pattern}
里可被显式关闭。不使用 'magic'、'smartcase' 和
'ignorecase' 选项。
"Conceal" 值是特别的，它使匹配被隐藏。
可选的 {priority} 参数指定匹配的优先级。高优先级的匹配的高亮会
否决低优先级匹配的高亮。优先级用整数指定 (负整数也无不可)。如
果未指定 {priority} 参数，缺省优先级为 10。'hlsearch' 的优先级
为零，这样所有正优先级的匹配都可以否决它。语法高亮 (见
'syntax') 采用不同的机制，无论选择的优先级如何，匹配总会否决语
法的高亮。
可选的 {id} 参数请求特定的匹配 ID。如果指定的 ID 已用，报错，
并不加入该匹配。ID 用正整数指定 (不含零)。ID 1、2 和 3 分别为
:match 、 :2match 和 :3match 命令保留。3 是为 matchparen
插件保留的。
如果 {id} 未指定或为 -1， matchadd() 自动选择一个可用的 ID，
至少为 1000。
可选的 {dict} 参数允许更多定制。目前，可用来指定特定于匹配的隐
藏字符，使用 hl-Conceal 高亮匹配来显示。该字典有以下成员:
conceal 显示的特殊字符，而非匹配 (只用于
hl-Conceal 高亮匹配，见 :syn-cchar )
window 不使用当前窗口，而使用指定窗口号或窗口 ID
的其它窗口。
匹配的数目不限， :match 诸命令则有此局限。
出错时返回 -1。
示例:
:highlight MyGroup ctermbg=green guibg=green
:let m = matchadd("MyGroup", "TODO")
要删除该模式:
:call matchdelete(m)
GetGroup()->matchadd('TODO')
返回类型: Number
matchaddpos()
matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
和 matchadd() 相同，但需要位置列表 {pos} 而非匹配模式。比
matchadd() 更快，因为无需处理正则表达式并设置缓冲区行边界以
重画屏幕。主要用于需要快速增加或删除匹配的场合，如匹配括号的高
亮。
{pos} 是位置的列表。每个位置为以下之一:
- 数值。该行整行被高亮。首行的行号为 1。
- 单个数值的列表。如 [23]。该行整行被高亮。
- 包含两个数值的列表，如 [23, 11]。前面的数是行号，后面的是列
号 (首列为 1，必须对应 col() 返回的字节索引)。此位置的字符
被高亮。
- 包含三个数值的列表，如 [23, 11, 3]。同上，但第三个数给出高亮
字节计的长度。
出错时返回 -1。
示例:
:highlight MyGroup ctermbg=green guibg=green
:let m = matchaddpos("MyGroup", [[23, 24], 34])
模式的删除:
:call matchdelete(m)
GetGroup()->matchaddpos([23, 11])
返回类型: Number
matcharg({nr}) matcharg()
选择 {nr} 号匹配的项目，它们分别用 :match 、 :2match 或
:3match 命令设置。
返回两个项目的 List :
使用的高亮组名
使用的模式。
如果 {nr} 不是 1、2 或 3，返回空 List 。
如果没有匹配的项目，返回 ['', '']。
这用来保存和恢复 :match 。
用 :match 命令高亮的匹配限于三个。 matchadd() 无此限制。
也可用作 method :
GetMatch()->matcharg()
返回类型: list<string>
matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict}]) matchbufline()
返回缓冲区 {buf} 从 {lnum} 到 {end} 行上模式 {pat} 的所有匹配
组成的 List 。
{lnum} 和 {end} 可以是行号或者代表 {buf} 末行的 "$"。
{dict} 参数支持以下项目:
submatches 包含子表达式信息 ( /\( )
对每个匹配，返回以下项目的 Dict :
byteidx 匹配的开始字节索引
lnum 匹配所在的行号
text 匹配内容字符串
注意 一行上可能有多处匹配。
此函数只适用于已载入的缓冲区。有必要的话先调用 bufload() 。
match-pattern 说明模式相关选项设定的效果。
{buf} 不是合法缓冲区、缓冲区未载入以及 {lnum} 或 {end} 不合法
时，报错并返回空 List 。
示例:
" 假定缓冲区 5 第 3 行包含了 "a"
:echo matchbufline(5, '\<\k\+\>', 3, 3)
[{'lnum': 3, 'byteidx': 0, 'text': 'a'}]
" 假定缓冲区 10 第 4 行包含了 "tik tok"
:echo matchbufline(10, '\<\k\+\>', 1, 4)
[{'lnum': 4, 'byteidx': 0, 'text': 'tik'},
{'lnum': 4, 'byteidx': 4, 'text': 'tok'}]
如果给出 {submatch} 且为 v:true，同时返回 "\1"、"\2" 等的子表
达式。例如:
" 假定缓冲区 2 第 2 行包含了 "acd"
:echo matchbufline(2, '\(a\)\?\(b\)\?\(c\)\?\(.*\)', 2, 2
\ {'submatches': v:true})
[{'lnum': 2, 'byteidx': 0, 'text': 'acd', 'submatches':
['a', '', 'c', 'd', '', '', '', '', '']}]
"submatches" 列表永远包含 9 个项目。如果没找到某子表达式，对应
位置返回空串。
也可用作 method :
GetBuffer()->matchbufline('mypat', 1, '$')
返回类型: list<dict<any>> 或 list<any>
matchdelete({id} [, {win}) matchdelete() E802 E803
删除之前用 matchadd() 或 :match 诸命令定义的 ID 为 {id} 的
匹配。如果成功，返回 0，不然返回 -1。示例见 matchadd() 。
clearmatches() 可一次删除所有的匹配。
如果指定 {win}，使用指定窗口号或窗口 ID 的窗口而不是当前窗口。
也可用作 method :
GetMatch()->matchdelete()
返回类型: Number
matchend({expr}, {pat} [, {start} [, {count}]]) matchend()
和 match() 相同，但返回匹配之后的第一个字符的位置。比如:
:echo matchend("testing", "ing")
返回 "7"。
strspn() strcspn()
Vim 没有 strspn() 或 strcspn() 函数，但可用 matchend() 实现:
:let span = matchend(line, '[a-zA-Z]')
:let span = matchend(line, '[^a-zA-Z]')
不过没有匹配时，它返回 -1。
如果给出 {start}，和 match() 里的用法相同。
:echo matchend("testing", "ing", 2)
返回 "7"。
:echo matchend("testing", "ing", 5)
返回 "-1"。
如果 {expr} 是 List ，结果和 match() 相同。
也可用作 method :
GetText()->matchend('word')
返回类型: Number
matchfuzzy({list}, {str} [, {dict}]) matchfuzzy()
如果 {list} 为字符串列表，返回 List ，包含 {list} 中的所有模
糊匹配 {str} 的字符串。返回列表中的字符串依匹配分数排序。
可选的 {dict} 参数总是支持以下项目:
matchseq 如果此项目存在，只返回按照 {str} 里字符的出现
顺序的匹配。
limit {list} 里返回的最大匹配数。零代表没有限制。
如果 {list} 为字典列表，则可选的 {dict} 参数还支持以下项目:
key 用于模糊匹配 {str} 项目的键。该项目值必须为字
符串。
text_cb 对 {list} 中每个项目都会调用的 Funcref ，用于
获取模糊匹配的文本。此函数应接受字典项目作为参
数，并返回该项目用于模糊匹配的文本。
{str} 视作字符串常数， 不 支持正则表达式匹配。{str} 支持的最大
长度为 256。
如果 {str} 包含空白分隔的多个单词，返回包含所有这些单词的字符
串的列表。
如果没有匹配的字符串或有错误，返回空列表。如果 {str} 的长度大
于 256，也返回空列表。
如果给出 {limit}，matchfuzzy() 会找到 {list} 里最多那么多的匹
配，排序后返回。
参考 fuzzy-matching 关于模式匹配的详细说明。
示例:
:echo matchfuzzy(["clay", "crow"], "cay")
返回 ["clay"].
:echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
返回模糊匹配 "ndl" 的缓冲区名的列表。
:echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
返回模糊匹配 "ndl" 的缓冲区信息字典的列表。
:echo getbufinfo()->matchfuzzy("spl",
\ {'text_cb' : {v -> v.name}})
返回模糊匹配 "spl" 的缓冲区信息字典的列表。
:echo v:oldfiles->matchfuzzy("test")
返回模糊匹配 "test" 的文件名的列表。
:let l = readfile("buffer.c")->matchfuzzy("str")
返回 "buffer.c" 文件中模糊匹配 "str" 的行的列表。
:echo ['one two', 'two one']->matchfuzzy('two one')
返回 ['two one', 'one two']。
:echo ['one two', 'two one']->matchfuzzy('two one',
\ {'matchseq': 1})
返回 ['two one']。
返回类型: list<string> 或 list<any>
matchfuzzypos({list}, {str} [, {dict}]) matchfuzzypos()
和 matchfuzzy() 相同，但返回列表，包含匹配字符串的列表、匹配
{str} 中的字符的字符位置的列表、和匹配分数的列表。可用
byteidx() 把字符位置转为字节位置。
如果 {str} 在字符串中有多个匹配，只返回最佳匹配的位置。
如果没有匹配的字符串或有错，返回包含三个空列表项目的列表。
示例:
:echo matchfuzzypos(['testing'], 'tsg')
返回 [['testing'], [[0, 2, 6]], [99]]
:echo matchfuzzypos(['clay', 'lacy'], 'la')
返回 [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]]
:echo [{'text': 'hello', 'id' : 10}]
\ ->matchfuzzypos('ll', {'key' : 'text'})
返回 [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]]
返回类型: list<list<any>>
matchlist({expr}, {pat} [, {start} [, {count}]]) matchlist()
和 match() 相同，但返回 List 。列表第一项是匹配的字符串，和
matchstr() 返回值相同。其后的项目是子匹配，类似
:substitute 的 "\1"、"\2" 等。如果某个可选的子匹配不匹配，用
空字符串代替。例如:
echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
返回: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
如果没有匹配，返回空列表。
可以接受列表，但没什么用处。
也可用作 method :
GetText()->matchlist('word')
返回类型: list<string> 或 list<any>
matchstrlist({list}, {pat} [, {dict}]) matchstrlist()
返回 {list} 里模式 {pat} 的所有匹配组成的 List 。
{list} 是字符串 List 。{pat} 用来匹配 {list} 里的每个字符串。
{dict} 参数支持以下项目:
submatches 包含子表达式信息 ( /\( )
对每个匹配，返回以下项目的 Dict :
byteidx 匹配的开始字节索引。
lnum 匹配所在的 {list} 索引。
text 匹配内容字符串
submatches 子表达式列表。仅当 {dict} 里的 "submatches" 设
为 v:true 时才存在。
match-pattern 说明模式相关选项设定的效果。
示例:
:echo matchstrlist(['tik tok'], '\<\k\+\>')
[{'idx': 0, 'byteidx': 0, 'text': 'tik'},
{'idx': 0, 'byteidx': 4, 'text': 'tok'}]
:echo matchstrlist(['a', 'b'], '\<\k\+\>')
[{'idx': 0, 'byteidx': 0, 'text': 'a'},
{'idx': 1, 'byteidx': 0, 'text': 'b'}]
如果给出 {submatch} 且为 v:true，同时返回 "\1"、"\2" 等的子表
达式。例如:
:echo matchstrlist(['acd'], '\(a\)\?\(b\)\?\(c\)\?\(.*\)',
\ #{submatches: v:true})
[{'idx': 0, 'byteidx': 0, 'text': 'acd',
'submatches': ['a', '', 'c', 'd', '', '', '', '', '']}]
"submatches" 列表永远包含 9 个项目。如果没找到某子表达式，对应
位置返回空串。
也可用作 method :
GetListOfStrings()->matchstrlist('mypat')
返回类型: list<dict<any>> 或 list<any>
matchstr({expr}, {pat} [, {start} [, {count}]]) matchstr()
和 match() 相同，但返回匹配的字符串。例如:
:echo matchstr("testing", "ing")
返回 "ing"。
如果没有匹配，返回 ""。
如果给出 {start}，它和 match() 里的用法相同。
:echo matchstr("testing", "ing", 2)
返回 "ing"。
:echo matchstr("testing", "ing", 5)
返回 ""。
如果 {expr} 是 List ，返回匹配的项目。其类型不改变，因而不一
定是字符串。
也可用作 method :
GetText()->matchstr('word')
返回类型: String
matchstrpos({expr}, {pat} [, {start} [, {count}]]) matchstrpos()
和 matchstr() 相同，但返回匹配的字符串和匹配的始末位置。例
如:
:echo matchstrpos("testing", "ing")
返回 ["ing", 4, 7]。
如果没有匹配，返回 ["", -1, -1]。
如果给出 {start}，它和 match() 里的用法相同。
:echo matchstrpos("testing", "ing", 2)
返回 ["ing", 4, 7]。
:echo matchstrpos("testing", "ing", 5)
返回 ["", -1, -1]。
如果 {expr} 是 List ，返回匹配项目，{pat} 匹配的首个项目的索
引，匹配的开始位置和结束位置。
:echo matchstrpos([1, '__x'], '\a')
返回 ["x", 1, 2, 3]。
不改变类型，不必然是字符串。
也可用作 method :
GetText()->matchstrpos('word')
返回类型: list<any>
max({expr}) max()
返回 {expr} 所有项目的最大值。例如:
echo max([apples, pears, oranges])
{expr} 可以是 List 、 Tuple 或 Dictionary 。如果是字典，返
回字典中所有值的最大值。如果 {expr} 不是列表、元组或字典，或者
其中某个项目不能用作数值，出错。空 List 、 Tuple 或
Dictionary 返回零。
也可用作 method :
mylist->max()
返回类型: any，取决于 {expr}
menu_info({name} [, {mode}]) menu_info()
返回指定模式 {mode} 下的菜单 {name} 的信息。须指定不带快捷字符
('&') 的菜单名。{name} 为 "" 时，返回顶层菜单名。
{mode} 可为下列字符串之一:
"n" 普通
"v" 可视 (包括选择)
"o" 操作符等待
"i" 插入
"c" 命令行
"s" 选择
"x" 可视
"t" 终端作业
"" 普通、可视和操作符等待
"!" 插入和命令行
{mode} 省略时使用 "" 作为模式。
返回包含以下项的 Dictionary :
accel 菜单项目加速文本 menu-text
display 显示名 (不带 '&' 的名字)
enabled 如果此菜单项目打开，返回 v:true
参考 :menu-enable
icon 图标文件名 (用于工具栏) toolbar-icon
iconidx 内建图标的索引
modes 菜单为之定义的模式。除了上述模式以外，还使用以
下字符:
" " 普通、可视和操作符等待
name 菜单项目名。
noremenu 如果菜单项目的 {rhs} 不可重映射返回 v:true，否
则返回 v:false。
priority 菜单顺序优先级 menu-priority
rhs 菜单项目的右手边。返回字符串中的特殊字符以
":menu" 命令列表输出的同样的方式进行翻译。如果
菜单的 {rhs} 为空，返回 "<Nop>"。
script 如果 {rhs} 允许局部于脚本的重映射，返回
v:true，否则返回 v:false。见 :menu-script 。
shortcut 快捷键 (菜单名中 '&' 之后的字符)
menu-shortcut
silent 菜单项目创建时如带 <silent> 参数，返回 v:true
:menu-silent
submenus 包含返回子菜单名的 List 。仅当菜单项目有子菜
单时才存在。
如果菜单项目找不到，返回空字典。
示例:
:echo menu_info('Edit.Cut')
:echo menu_info('File.Save', 'n')
" 显示缓冲区里的整个菜单树
func ShowMenu(name, pfx)
let m = menu_info(a:name)
call append(line('$'), a:pfx .. m.display)
for child in m->get('submenus', [])
call ShowMenu(a:name .. '.' .. escape(child, '.'),
\ a:pfx .. ' ')
endfor
endfunc
new
for topmenu in menu_info('').submenus
call ShowMenu(topmenu, '')
endfor
也可用作 method :
GetMenuName()->menu_info('v')
返回类型: dict<any>
min({expr}) min()
返回 {expr} 所有项目的最小值。例如:
echo min([apples, pears, oranges])
{expr} 可以是 List 、 Tuple 或 Dictionary 。如果是字典，返
回字典中所有值的最小值。如果 {expr} 不是列表、元组或字典，或者
其中某个项目不能用作数值，出错。空 List 、 Tuple 或
Dictionary 返回零。
也可用作 method :
mylist->min()
返回类型: any，取决于 {expr}
mkdir({name} [, {flags} [, {prot}]]) mkdir() E739
建立目录 {name}。
{flags} 给出时，必须为字符串。空串无效果。
{flags} 包含以下字符标志位:
"p" 必要时建立中间目录
"D" 当前函数结束时删除 {name}，但不会递归删除 :defer
"R" 当前函数结束时递归删除 {name} :defer
注意 {name} 多于一个目录部分且使用 "p" 时，有些目录可能已经存
在。此时只有真正创建的那层目录和其包含的部分会被调度删除。
如用:
call mkdir('subdir/tmp/autoload', 'pR')
而 "subdir" 已存在时，那么调度删除的会是 "subdir/tmp"，相当
于:
defer delete('subdir/tmp', 'rf')
注意 如果延迟调度失败，目录不会删除。应该只有内存溢出时才会出
现这种情况。
如果给出 {prot}，它用于设置新目录的权限。缺省为 0o755
(rwxr-xr-x: 用户自己可读写，其它人可读)。用 0o700 使其它人不可
读。这只用于新创建的那些目录。注意: umask 适用于 {prot} (Unix
上)。
示例:
:call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
:if exists("*mkdir")
GetName()->mkdir()
返回类型: Number
mode([{expr}]) mode()
返回指示当前模式的字符串。
如果指定 {expr} 并且其值为非零的数值或非空的字符串
( non-zero-arg )，返回完整模式，不然，返回第一个字母。
另见 state() 。
n 普通模式
no 操作符等待模式
nov 操作符等待模式 (强制面向字符 o_v )
noV 操作符等待模式 (强制面向行 o_V )
noCTRL-v 操作符等待模式 (强制面向列块 o_CTRL-V )；
CTRL-V 是单个字符
niI Insert-mode 用 i_CTRL-O 进入的普通模式
niR Replace-mode 用 i_CTRL-O 进入的普通模式
niV Virtual-Replace-mode 用 i_CTRL-O 进入的普通模
式
nt 终端-普通 (插入会转到终端-作业模式)
v 面向字符的可视模式
vs 选择模式用 v_CTRL-O 进入的面向字符的可视模式
V 面向行的可视模式
Vs 选择模式用 v_CTRL-O 进入的面向行的可视模式
CTRL-V 面向列块的可视模式
CTRL-Vs 选择模式用 v_CTRL-O 进入的面向列块的可视模式
s 面向字符的选择模式
S 面向行的选择模式
CTRL-S 面向列块的选择模式
i 插入模式
ic 插入模式补全 compl-generic
ix 插入模式 i_CTRL-X 补全
R 替换模式 R
Rc 替换模式补全 compl-generic
Rx 替换模式 i_CTRL-X 补全
Rv 虚拟替换模式 gR
Rvc 虚拟替换模式补全 compl-generic
Rvx 虚拟替换模式 i_CTRL-X 补全
Rvc 虚拟替换模式补全 gR
Rvx 虚拟替换模式 gR
c 命令行编辑模式
ct 终端-作业模式下的命令行编辑
cr 命令行编辑替换模式 c_<Insert>
cv Vim Ex 模式 gQ
cvr Vim Ex 替换模式 c_<Insert>
ce 普通 Ex 模式 Q
r 输入回车的提示
rm -- more -- 提示
r? :confirm 等等的询问
! 执行外壳或外部命令时
t 终端-作业模式: 键入传给作业
可用于 'statusline' 选项或 remote_expr() 。在其它的多数地方，
它总是返回 "c" 或 "n"。
注意将来可能会加入更多模式和更多特定模式。最好不要比较整个字符
串而只比较开头的字符 (一或多个)。
另见 visualmode() 。
也可用作 method :
DoFull()->mode()
返回类型: String
mzeval({expr}) mzeval()
计算 MzScheme 表达式 {expr} 并返回计算结果，转换为 Vim 本身的
数据结构。
数值和字符串返回本身。
组对 (pair) (包含列表 (list) 和非常规列表 (improper list)) 和
向量 (vector) 以 Vim List 形式返回。
哈希表 (hash table) 以 Vim Dictionary 形式返回，其键转换成字
符串。
所有其它类型依 display 函数调用的结果转换为字符串。
示例:
:mz (define l (list 1 2 3))
:mz (define h (make-hash)) (hash-set! h "list" l)
:echo mzeval("l")
:echo mzeval("h")
注意 :def 函数里的局部变量对 {expr} 不可见。
也可用作 method :
GetExpr()->mzeval()
返回类型: any，取决于 {expr}
{仅当编译时带 +mzscheme 特性才有效}
nextnonblank({lnum}) nextnonblank()
返回第一个从 {lnum} 开始的非空白行的行号。例如:
if getline(nextnonblank(1)) =~ "Java"
{lnum} 非法或者在从该行开始都没有非空白行时，返回零。
{lnum} 用法类似于 getline() 。
另见 prevnonblank() 。
也可用作 method :
GetLnum()->nextnonblank()
返回类型: Number
ngettext({single}, {plural}, {number}[, {domain}) ngettext()
根据语言的单复数形式规则，返回包含消息正确值的字符串。例如:
ngettext("File", "Files", 2) # 返回 "Files"
也可用作 method :
1->ngettext("File", "Files") # 返回 "File"
gettext() 说明 domain 参数。
返回类型: String
nr2char({expr} [, {utf8}]) nr2char()
返回单个字符组成的字符串，该字符的数值为 {expr}。例如:
nr2char(64) 返回 "@"
nr2char(32) 返回 " "
如果 {utf8} 省略或为零，使用当前的 'encoding'。比如对 "utf-8"
来说:
nr2char(300) 返回带有弓形的 I
如果 {utf8} 为 TRUE，则总返回 utf-8 字符。
注意 文件里的 NUL 字符须用 nr2char(10) 指定。因为 Vim 用换行符
来表示 NUL。真正的 NUL 是 nr2char(0)，而它会终结字符串，因而返
回空串。
要把字符值的列表转换为字符串:
let list = [65, 66, 67]
let str = join(map(list, {_, val -> nr2char(val)}), '')
结果是: "ABC"
也可用作 method :
GetNumber()->nr2char()
返回类型: String
or({expr}, {expr}) or()
对两个参数进行按位或。参数须转换为数值。列表、字典或浮点数参数
会报错。
另见 and() 和 xor() 。
示例:
:let bits = or(bits, 0x80)
也可用作 method :
:let bits = bits->or(0x80)
{path} [, {len}]) pathshorten()
缩短路径 {path} 里的目录名，返回其结果。路径的尾部亦即文件名，
保持不变。路径的其余部分被缩短为 {len} 个字符。如果 {len} 省略
或小于 1，则假定为 1 (单个字母)。保持每个部分引导的 '~' 和 '.'
字符不变。例如:
:echo pathshorten('~/.vim/autoload/myfile.vim')
~/.v/a/myfile.vim
:echo pathshorten('~/.vim/autoload/myfile.vim', 2)
~/.vi/au/myfile.vim
该路径实际存在与否并不相干。
出错时返回空串。
也可用作 method :
GetDirectories()->pathshorten()
返回类型: String
perleval({expr}) perleval()
在标量上下文计算 Perl 表达式 {expr}，返回结果转换为 Vim 数据结
构。如果其值不能转换，返回 Perl 表示的字符串形式。
备注: 如果要数组或哈希表，{expr} 必须返回它们的引用。
例如:
:echo perleval('[1 .. 4]')
[1, 2, 3, 4]
注意 :def 函数里的局部变量对 {expr} 不可见。
也可用作 method :
GetExpr()->perleval()
返回类型: any，取决于 {expr}
{仅当编译时加入 +perl 特性才有效}
popup_ 函数文档在这里: popup-functions
pow({x}, {y}) pow()
返回浮点数，即 {x} 的 {y} 次方。
{x} 和 {y} 的计算结果必须是 Float 或 Number 。否则返回
0.0。
示例:
:echo pow(3, 3)
27.0
:echo pow(2, 16)
65536.0
:echo pow(32, 0.20)
2.0
也可用作 method :
Compute()->pow(3)
返回类型: Number
preinserted() preinserted()
如果文本在光标后插入，返回非零值。这是因为 'completeopt' 里有
"preinsert"，或 'completeopt' 里有 "longest" 且 'autocomplete'
已激活。否则返回零。
返回类型: Number
prevnonblank({lnum}) prevnonblank()
返回第一个 {lnum} 所在或之上的非空白行的行号。例如:
let ind = indent(prevnonblank(v:lnum - 1))
{lnum} 非法或者在该行和它之前都没有非空白行时，返回零。
{lnum} 的用法可见 getline() 。
另见 nextnonblank() 。
也可用作 method :
GetLnum()->prevnonblank()
返回类型: Number
printf({fmt}, {expr1} ...) printf()
返回 {fmt} 指定的字符串，其中每个 "%" 项目被它们对应的参数排版
后的形式取代。例如:
printf("%4d: E%d %.30s", lnum, errno, msg)
可能的返回结果:
" 99: E42 asdfasdfasdfasdfasdfasdfasdfas"
也可用作 method ，基是作为第二个参数传递的:
Compute()->printf("result: %d")
要用列表来传递项目，可用 call() 。
常用的项目有:
%s 字符串
%6S 右对齐到 6 个显示单元的字符串
%6s 右对齐到 6 个字节的字符串
%.9s 截短到 9 个字节的字符串
%c 单个字节
%d 十进制数
%5d 十进制数，用空格补足到 5 个字符
%x 十六进制数
%04x 十六进制数，用 0 补足到 4 个字符
%X 十六进制数，用大写字母的十六进制字母
%o 八进制数
%08b 二进制数，用 0 补足到 8 个字符
%f 浮点数，形如 12.23、inf、-inf 或 nan
%F 浮点数，形如 12.23、INF、-INF 或 NAN
%e 浮点数，形如 1.23e3、inf、-inf 或 nan
%E 浮点数，形如 1.23E3、INF、-INF 或 NAN
%g 浮点数，根据不同的值，使用合适的 %f 或 %e
%G 浮点数，根据不同的值，使用合适的 %F 或 %E
%% % 字符本身
转换规格说明以 '%' 开始，以转换类型结束。所有其它的字符按原样
复制到结果中。
"%" 开始转换规格说明。其后的参数依序如下:
% [pos-argument] [flags] [field-width] [.precision] type
pos-argument
至多一个的位置参数标识符。形式为 {n$}，其中 n >= 1。
flags
零或多个下面的标志位:
# 转换值为 "替换形式"。对 c、d 和 s 转换，此选项无
效。对 o 转换，增加数值的精度，使得输出字符串的
第一个字符总是 0 (除非打印零值，且显式地使用精度
0)。
对 b 和 B 转换，非零值在前面加上字符串 "0b" (B
转换用 "0B")。
对 x 和 X 转换，非零值在前面加上字符串 "0x" (X
转换用 "0X")。
0 (零) 以 0 填充。对所有的转换，左侧用 0 而非空格填充。
如果对数值的转换给出精度 (d、b、B、o、x 和 X)，
忽略 0 标志位。
- 负域宽度标志位；转换后的值被左对齐到域边界上。该
值右侧用空格填充，而不是在左侧用空格或 0 填充。
如果两个标志位同时给出，- 否决 0。
' ' (空格) 带符号转换 (d) 产生的正数左侧加上空格。
+ 带符号转换产生的数值之前总加上符号。如果两个标志
位同时给出，+ 否决空格。
field-width
可选的十进制数位字符串，指定最小的字段宽度。如果转换后
的值的字节数小于字段宽度，在左侧 (或右侧，如果给定左对
齐标志位的话) 用空格填充到字段宽度。S 转换以显示单元计
数。
.precision
可选的精度，形式为句号 '.' 后跟一个可选的数位字符串。
如果省略了数位字符串，假设精度为零。
它给出 d、o、x 和 X 转换显示的最小数位数量，或 s 转换
显示的字符串的字节的最大数量，或 S 转换显示的字符串的
显示单元的最大数量。
对浮点数而言，指定小数点后的数位个数。
type
指定要进行的转换类型的单个字符，见下。
字段宽度、精度 (两者都有亦可) 可以用星号 '*' 代替数位字符串。
此情形下，一个数值参数指定字段宽度或精度。负的字段宽度被理解为
带左对齐的标志位后跟一个正数字段宽度；负的精度被理解为就像不存
在一样。例如:
:echo printf("%d: %.*s", nr, width, line)
限制 "line" 文本的长度为 "width" 个字节。
如果要排版的参数以位置参数标识符指定而又用 '*' 来指示用于指定
宽度或精度的数值参数，后者也必须用 {n$} 位置参数标识符来指定。
见 printf-$ 。
转换标识符和它们的含义如下:
printf-d printf-b printf-B printf-o
printf-x printf-X
dbBoxX 数值参数被转换为带符号十进制 (d)，无符号二进制 (b 和
B)、无符号八进制 (o) 或无符号十六进制 (x 和 X) 记法。x
转换用字母 "abcdef"；X 转换用 "ABCDEF" 字母。
如果提供了精度，它给出必须出现的数位的最少数目；如果转
换后的值不需要那么多数位，左侧用 0 填充。
任何情况下数值字段都不会被未给定或者更小的字段宽度所截
短；如果转换后的值宽于字段宽度，字段会扩展以容纳转换后
的值。
'h' 修饰符指示参数为 16 位。
'l' 修饰符指示参数为长整型，具体是 32 位还是 64 位取决
于你的系统。
'L' 修饰符指示参数为 64 位。
b 和 B 转换标识符不接受宽度修饰符而总假定为 64 位整型
参数。
通常这些修饰符不怎么有用。如果类型可从参数推知，修饰符
被忽略。
i d 的别名
D ld 的别名
U lu 的别名
O lo 的别名
printf-c
c 数值参数被转换为字节，写入产生的字符。
printf-s
s 使用字符串参数的文本。如果指定精度，使用不多于给定数目
的字节数。
如果参数不是字符串型，使用 ":echo" 相同的格式自动转换
到文本。
printf-S
S 使用字符串参数的文本。如果指定精度，使用不多于给定数目
的显示单元数。
printf-f E807
f F 浮点数参数被转换为形如 123.456 的字符串。精度指定小数
点后面的位数。如果精度为零，则省略小数点本身。如果未指
定精度，缺省为 6。那个很大很大的数 (超出返回或除以零的
结果) 用 %f 显示 "inf" 或 "-inf" (%F 则显示 INF 或
-INF)。
"0.0 / 0.0" 用 %f 显示 "nan" (%F 显示 NAN)。
示例:
echo printf("%.2f", 12.115)
12.12
注意 截断方式取决于系统库。如不确定，使用 round() 。
printf-e printf-E
e E 浮点数参数被转换为形如 1.234e+03 或用 'E' 的话
1.234E+03 的字符串。精度指定小数点后面的位数，和 'f'
一样。
printf-g printf-G
g G 如果浮点数参数在 0.001 (含) 和 10000000.0 (不含) 之
间，则其转换同 'f'，不然，'g' 同 'e' 而 'G' 同 'E'。如
果未指定精度，除了小数点之后的那个零以外，不显示多余的
零和 '+' 负号。因而，10000000.0 显示为 1.0e7。
printf-%
% 写入 '%'。不转换参数。这里完整的转换规格说明是 "%%"。
如果期待数值参数，字符串参数也被接受并自动转换。
如果期待浮点数或字符串参数，数值参数也被接受并自动转换。
其它参数类型产生错误信息。
E766 E767
{exprN} 参数的数量必须和 "%" 项目的数量完全匹配。不论参数不足
还是过多，都会给出错误。至多可用 18 个参数。
printf-$
若干语言中，错误和资讯消息使用与对应的英语消息不同的单词次序会
更可读。可用指定位置参数来完成使用不同单词次序的翻译。例如:
#, c-format
msgid "%s returning %s"
msgstr "返回值 %2$s 来自 %1$s"
此例中，输出句子里的两个字符串参数顺序被颠倒。
echo printf(
"In The Netherlands, vim's creator's name is: %1$s %2$s",
"Bram", "Moolenaar")
In The Netherlands, vim's creator's name is: Bram Moolenaar
echo printf(
"In Belgium, vim's creator's name is: %2$s %1$s",
"Bram", "Moolenaar")
In Belgium, vim's creator's name is: Moolenaar Bram
可用 '*' 标识符来指定宽度 (还有精度)。此时，必须给出字段宽度对
应在参数列表中的位置。
echo printf("%1$*2$.*3$d", 1, 2, 3)
001
echo printf("%2$*3$.*1$d", 1, 2, 3)
2
echo printf("%3$*1$.*2$d", 1, 2, 3)
03
echo printf("%1$*2$.*3$g", 1.4142, 2, 3)
1.414
可以通过直接值或者位置参数混合给出宽度和/或精度:
echo printf("%1$4.*2$f", 1.4142135, 6)
1.414214
echo printf("%1$*2$.4f", 1.4142135, 6)
1.4142
echo printf("%1$*2$.*3$f", 1.4142135, 6, 2)
1.41
因为字段宽度或精度导致字符串超过 1 MiB (1024*1024 = 1048576)
个字符时。会出现溢出错误 E1510 。
E1500
不能混合位置和非位置参数:
echo printf("%s%1$s", "One", "Two")
E1500: Cannot mix positional and non-positional arguments:
%s%1$s
E1501
排版字符串里不能跳过位置参数:
echo printf("%3$s%1$s", "One", "Two", "Three")
E1501: format argument 2 unused in $-style format:
%3$s%1$s
E1502
[field-width] (或 [precision]) 参数可以重用:
echo printf("%1$d at width %2$d is: %01$*2$d", 1, 2)
1 at width 2 is: 01
但不能用于不同的类型:
echo printf("%1$d at width %2$ld is: %01$*2$d", 1, 2)
E1502: Positional argument 2 used as field width reused as
different type: long int/int
E1503
使用位置参数时，如果给出错误位置或参数，报错:
echo printf("%1$d at width %2$d is: %01$*2$.*3$d", 1, 2)
E1503: Positional argument 3 out of bounds: %1$d at width
%2$d is: %01$*2$.*3$d
只报首个错误:
echo printf("%01$*2$.*3$d %4$d", 1, 2)
E1503: Positional argument 3 out of bounds: %01$*2$.*3$d
%4$d
E1504
位置参数可多次使用:
echo printf("%1$s %2$s %1$s", "One", "Two")
One Two One
但不能用于不同的类型:
echo printf("%1$s %2$s %1$d", "One", "Two")
E1504: Positional argument 1 type used inconsistently:
int/string
E1505
排版字符串的若干其他排版错误会报此错:
echo printf("%1$d at width %2$d is: %01$*2$.3$d", 1, 2)
E1505: Invalid format specifier: %1$d at width %2$d is:
%01$*2$.3$d
E1507
此内部错误指示位置格式参数的解析产生了已知错误之外的其他问题。
请给 Vim 发送错误报告并提供当时使用的准确格式字符串和参数。
返回类型: String
prompt_getprompt({buf}) prompt_getprompt()
返回缓冲区 {buf} 的实际提示文本。{buf} 可以是缓冲区名或号。
prompt-buffer 。
如果缓冲区不存在或不是提示缓冲区，返回空串。
也可用作 method :
GetBuffer()->prompt_getprompt()
返回类型: String
{仅当编译时加入 +channel 特性才有效}
prompt_setcallback({buf}, {expr}) prompt_setcallback()
设置缓冲区 {buf} 的提示回调为 {expr}。{expr} 为空串时删除回
调。只对 'buftype' 为 "prompt" 的 {buf} 有效。
按下回车时触发本回调。此时当前缓冲区总是提示缓冲区。在回调触发
前，会加入一行新的提示行，因此，触发该回调的提示行会是倒数第二
行。
如果回调要为缓冲区增加新文本，必须在最后一行之前插入，因为那是
当前提示所在的位置，此操作可以异步进行。
回调调用时所带的一个参数是提示行输入的文本。如果用户直接按了回
车，这会是一个空串。
示例:
func s:TextEntered(text)
if a:text == 'exit' || a:text == 'quit'
stopinsert
" 复位 'modified'，这样缓冲区才可以被关闭。
" 假定没有需要保存的内容。
set nomodified
close
else
" 应用 "a:text" 的实际操作，此例只是重复一次。
call append(line('$') - 1, 'Entered: "' .. a:text .. '"')
endif
endfunc
call prompt_setcallback(bufnr(), function('s:TextEntered'))
GetBuffer()->prompt_setcallback(callback)
{仅当编译时加入 +channel 特性才有效}
prompt_setinterrupt({buf}, {expr}) prompt_setinterrupt()
设置缓冲区 {buf} 的回调为 {expr}。{expr} 为空串时删除回调。只
对 'buftype' 为 "prompt" 的 {buf} 有效。
插入模式按 CTRL-C 时触发本回调。不设置回调会使 Vim 退出插入模
式，就和其它缓冲区一样。
也可用作 method :
GetBuffer()->prompt_setinterrupt(callback)
返回类型: Number
{仅当编译时加入 +channel 特性才有效}
prompt_setprompt({buf}, {text}) prompt_setprompt()
设置缓冲区 {buf} 的提示文本为 {text}。{text} 多数会以空格结
尾。
结果只对 'buftype' 为 "prompt" 的 {buf} 可见。示例:
call prompt_setprompt(bufnr(), 'command: ')
也可用作 method :
GetBuffer()->prompt_setprompt('command: ')
返回类型: Number
{仅当编译时加入 +channel 特性才有效}
prop_ 函数文档在这里: text-prop-functions
pum_getpos() pum_getpos()
如果弹出菜单 (见 ins-completion-menu ) 不可见，返回空
Dictionary ，不然，返回带以下键的 Dictionary :
height 可见项目数
width 屏幕单元格数
row 顶部屏幕行号 (0 为初行)
col 最左侧屏幕列号 (0 为初列)
size 项目总数
scrollbar 如果滚动条为可见则为 TRUE
这里的值和 CompleteChanged 发生时 v:event 的一样。
返回类型: dict<any>
pumvisible() pumvisible()
如果弹出菜单可见，返回非零，不然返回零。见
ins-completion-menu 。
可以用来避免一些会删除弹出菜单的动作。
返回类型: Number
py3eval({expr} [, {locals}]) py3eval()
计算 Python 表达式 {expr} 并返回计算结果，转换为 Vim 本身的数
据结构。
给出 {locals} 字典时，它定义了表达式里可用的局部变量。键是变量
名，而值是变量值。 Dictionary 、 List 和 Tuple 的值都是引
用，因此可通过表达式更新 (一如使用了 python-bindeval 一样)。
数值和字符串返回本身 (字符串经过复制，Unicode 字符串还须额外用
'encoding' 转换)。
列表返回 Vim List 类型。
元组返回 Vim Tuple 类型。
字典返回 Vim Dictionary 类型，键值转换为字符串。
注意 :def 函数里的局部变量对 {expr} 不可见。
也可用作 method :
GetExpr()->py3eval()
'b",".join(l)'->py3eval({'l': ['a', 'b', 'c']})
返回类型: any，取决于 {expr}
{仅当编译时加入 +python3 特性才有效}
E858 E859
pyeval({expr} [, {locals}]) pyeval()
计算 Python 表达式 {expr} 并返回计算结果，转换为 Vim 本身的数
据结构。
{locals} 见 py3eval() 。
数值和字符串返回本身 (字符串经过复制)。
列表返回 Vim List 类型。
元组返回 Vim Tuple 类型。
字典返回 Vim Dictionary 类型，出现非字符串的键值报错。
注意 :def 函数里的局部变量对 {expr} 不可见。
也可用作 method :
GetExpr()->pyeval()
返回类型: any，取决于 {expr}
{仅当编译时加入 +python 特性才有效}
pyxeval({expr} [, {locals}]) pyxeval()
计算 Python 表达式 {expr} 并返回计算结果，转换为 Vim 本身的数
据结构。
{locals} 见 py3eval() 。
使用 Python 2 或 3，见 python_x 和 'pyxversion'。
另见: pyeval() 、 py3eval()
也可用作 method :
GetExpr()->pyxeval()
返回类型: any，取决于 {expr}
{仅当编译时加入 +python 或 +python3 特性才有效}
rand([{expr}]) rand() random
用 {expr} 作为种子，返回 xoshiro128** 算法产生的伪随机数。返回
数值是 32 位的，为了统一起见，即使是 64 位系统上也是。
可由 srand() 初始化 {expr}，rand() 会进行更新。如果省略
{expr}，使用并更新一个内部的种子值。
{expr} 非法时返回 -1。
示例:
:echo rand()
:let seed = srand()
:echo rand(seed)
:echo rand(seed) % 16 " 随机数 0 - 15
返回类型: Number
E726 E727
range({expr} [, {max} [, {stride}]]) range()
返回数值的 List :
- 如果只有指定 {expr}: [0, 1, ..., {expr} - 1]
- 如果指定了 {max}: [{expr}, {expr} + 1, ..., {max}]
- 如果指定了 {stride}: [{expr}, {expr} + {stride}, ..., {max}]
(每次给 {expr} 递增 {stride}，但不会产生超过 {max} 的值)。
如果最大值比开始值小一，返回空列表。如果更小，报错。
例如:
range(4) " [0, 1, 2, 3]
range(2, 4) " [2, 3, 4]
range(2, 9, 3) " [2, 5, 8]
range(2, -2, -1) " [2, 1, 0, -1, -2]
range(0) " []
range(2, 0) " 出错！
也可用作 method :
GetExpr()->range()
返回类型: list<number>
readblob({fname} [, {offset} [, {size}]]) readblob()
以二进制方式读取文件 {fname}，并返回 Blob 。
给出 {offset} 时，从指定的偏移开始读取文件。如果给出的是负值，
指定从文件尾开始计算的偏移。如要读取最后的 12 个字节:
readblob('file.bin', -12)
给出 {size} 时，只读取指定的长度。如要读取文件开始的 100 个字
节:
readblob('file.bin', 0, 100)
{size} 为 -1 或省略时，读取从 {offset} 开始的全部数据。
Unix 上也可用于从字符设备读取数据，须显式指定 {size}。仅当设备
支持定位时，可指定 {offset}。否则它必须为零。例如要从串行终端
读取 10 个字节:
readblob('/dev/ttyS0', 0, 10)
文件不能打开时报错，返回空 Blob 。
如果偏移超过文件尾，返回空 blob。
试图读取比实际可用更多的字节时，结果被截短。
另见 readfile() 和 writefile() 。
返回类型: Blob
readdir({directory} [, {expr} [, {dict}]]) readdir()
返回 {directory} 中的文件和目录名的列表。如果不需要复杂的处
理，如限制匹配的数目等等，也可用 glob() 。
列表经过排序 (大小写敏感)，要改变排序顺序，见下 {dict} 参数。
{expr} 省略时包含所有的项目。
如果给出 {expr}，计算其值决定如何处理:
如果 {expr} 结果为 -1， 不处理后续的项目。
如果 {expr} 结果为 0，不把本项加入列表。
如果 {expr} 结果为 1，把本项加入列表。
总是排除 "." 和 ".." 项目。
每次计算 {expr} 时 v:val 设为项目名。
{expr} 如果是函数，把名字作为参数传递。
例如，要得到 ".txt" 结尾的文件列表:
readdir(dirname, {n -> n =~ '.txt$'})
要跳隐藏和备份文件:
readdir(dirname, {n -> n !~ '^\.\|\~$'})
E857
可选的 {dict} 参数允许更多定制。目前可用于指定排序是否和如何进
行。此字典有以下成员:
sort 如何对系统返回值进行排序。
合法值是:
"none" 不排序 (最快速的方法)
"case" 大小写敏感排序 (按每个字符的字节
值，技术上，使用 strcmp()) (缺省)
"icase" 大小写不敏感排序 (技术上，使用
strcasecmp())
"collate" 使用 "POSIX" 或 "C" locale 的排
序规则排序 (技术上，使用
strcoll())
其它值被忽略，不报错。
例如，要得到当前目录下的所有文件的列表，而不对个别项目排序:
readdir('.', '1', #{sort: 'none'})
要想得到目录树:
function! s:tree(dir)
return {a:dir : map(readdir(a:dir),
\ {_, x -> isdirectory(x) ?
\ {x : s:tree(a:dir .. '/' .. x)} : x})}
endfunction
echo s:tree(".")
出错时返回空列表。
也可用作 method :
GetDirName()->readdir()
返回类型: list<string> 或 list<any>
readdirex({directory} [, {expr} [, {dict}]]) readdirex()
readdir() 的扩展版。
返回 {directory} 中的文件和目录信息字典的列表。
可用于在读取目录列表的同时获得这些文件和目录的属性。这比先调用
readdir() 然后为每个文件和目录分别调用 getfperm() 、
getfsize() 、 getftime() 和 getftype() 要快得多，尤其是在
MS-Windows 上。
列表缺省按名字排序 (大小写敏感)，可选的 {dict} 参数可用来改变
如何排序，见 readdir() 。
文件和目录信息字典包含以下项:
group 项目的组名。(仅用于 Unix)
name 项目名。
perm 项目权限。见 getfperm() 。
size 项目大小。见 getfsize() 。
time 项目时间戳。见 getftime() 。
type 项目类型。
Unix 上，大致相当于 getftype() ，除了以下例
外:
目录的符号链接 "linkd"
其它符号链接 "link"
MS-Windows 上:
普通文件 "file"
目录 "dir"
连接点 "junction"
目录的符号链接 "linkd"
其它符号链接 "link"
其它重解析点 "reparse"
user 项目拥有者的名字。(仅用于 Unix)
Unix 上，如果项目是符号链接，字典包含链接目标的信息 (除了
"type" 项外)。
MS-Windows 上，由于性能方面的原因，同样情况包含的是符号链接本
身的信息。
{expr} 省略时包含所有的项目。
如果给出 {expr}，计算其值决定如何处理:
如果 {expr} 结果为 -1， 不处理后续的项目。
如果 {expr} 结果为 0，不把本项加入列表。
如果 {expr} 结果为 1，把本项加入列表。
总是排除 "." 和 ".." 项目。
每次计算 {expr} 时， v:val 设为对应项目的 Dictionary 。
如果 {expr} 为函数，此项目被作为参数传入。
例如，要获取所有以 ".txt" 结尾的文件列表:
readdirex(dirname, {e -> e.name =~ '.txt$'})
例如，要得到当前目录下的所有文件的列表，而不对个别项目排序:
readdirex(dirname, '1', #{sort: 'none'})
也可用作 method :
GetDirName()->readdirex()
返回类型: list<dict<any>> 或 list<any>
readfile({fname} [, {type} [, {max}]]) readfile()
读入文件 {fname} 并返回 List 。，文件每行一项。在 NL 字符处断
开行。以 CR 分隔的 Macintosh 文件会返回单个长行 (除非某处出现
了 NL)。
所有的 NUL 字符被 NL 字符替代。
如果 {type} 包含 "b"，使用二进制模式:
- 如果末行以 NL 结尾，附加额外的一个空列表项。
- 不删除 CR 字符。
否则:
- NL 之前的 CR 字符被删除。
- 末行是否以 NL 结尾没有影响。
- 'encoding' 如是 Unicode 编码，删除文本可能有的 UTF-8 字节顺
序标识。
如果给出 {max}，指定读入的最大行数。可用于只想检查文件开始十行
这样的场合:
:for line in readfile(fname, '', 10)
: if line =~ 'Date' | echo line | endif
:endfor
如果 {max} 为负，返回从文件尾部起算 -{max} 行，有多少算多少。
如果 {max} 为零，返回空列表。
注意 如果没有 {max}，把整个文件读到内存。
也要 注意 这里不识别编码。如果需要，把文件读到缓冲区里。
已废弃 (用 readblob() 代之): 如果 {type} 包含 "B"，返回
Blob ，包含未经修改的文件二进制数据。
如果文件不能打开，给出错误信息，并返回空列表。
另见 writefile() 。
也可用作 method :
GetFileName()->readfile()
返回类型: list<string> 或 list<any>
reduce({object}, {func} [, {initial}]) reduce() E998
为 {object} 中的每个项目调用 {func}，其中 {object} 为
String 、 List 、 Tuple 或 Blob 。{func} 调用时带两个参数:
目前的结果，和当前项目。处理完所有项目，返回最终结果。 E1132
{initial} 为初始值。如果省略，使用 {object} 的首个项目，而从第
二个项目开始调用 {func}。如果 {initial} 未给出且 {object} 为
空，则结果不能进行计算，报错 E998。
示例:
echo reduce([1, 3, 5], { acc, val -> acc + val })
echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
echo reduce(0z1122, { acc, val -> 2 * acc + val })
echo reduce('xyz', { acc, val -> acc .. ',' .. val })
也可用作 method :
echo mylist->reduce({ acc, val -> acc + val }, 0)
返回类型: String 、 Blob 、list<{type}> 或 dict<{type}>，
取决于 {object} 和 {func}
reg_executing() reg_executing()
返回在执行中的单个字母寄存器名。如果没有在执行的寄存器，返回空
串。见 @ 。
返回类型: String
reg_recording() reg_recording()
返回在记录中的单个字母寄存器名。如果没有在记录的寄存器，返回空
串。见 q 。
返回类型: String
reltime() reltime()
reltime({start})
reltime({start}, {end})
返回代表时间值的项目。此项目为项目列表，成员项目取决于不同的系
统。Vim 9 脚本中其类型可用 list<any>。
可以把此项目传递给 reltimestr() 以转换为字符串，或
reltimefloat() 以转换为浮点数。例如，要看到 Work() 函数花费
的时间:
var startTime = reltime()
Work()
echo startTime->reltime()->reltimestr()
没有参数时，返回当前时间 (具体表示方式和系统相关，不能当作挂钟
(wall-clock) 时间，为此，可用 localtime() )。
带一个参数时，返回参数指定的时间以来的时间。
带两个参数时，返回 {start} 和 {end} 之间跨越的时间。
{start} 和 {end} 参数必须是 reltime() 返回的值。出错时在老式脚
本里返回空列表，Vim9 脚本里报错。
也可用作 method :
GetStart()->reltime()
返回类型: list<number>
{仅当编译时加入 +reltime 特性才有效}
reltimefloat({time}) reltimefloat()
返回代表 {time} 的时间值的浮点数。
示例:
let start = reltime()
call MyFunction()
let seconds = reltimefloat(reltime(start))
参见 reltimestr() 关于开销的注释。
另见 profiling 。
出错时在老式脚本里返回 0.0，Vim9 脚本里报错。
也可用作 method :
reltime(start)->reltimefloat()
返回类型: Float
{仅当编译时加入 +reltime 特性才有效}
reltimestr({time}) reltimestr()
返回字符串，代表 {time} 的时间值。
形式是秒数、句号和毫秒数。例如:
let start = reltime()
call MyFunction()
echo reltimestr(reltime(start))
注意 命令本身额外的开销也计算在时间里。时间的准确度取决于系
统。 reltimefloat() 会给出最高准确度，一些系统里可达纳秒极。
返回结果包含引导的空格，使字符串能很好地对齐。如果你不需要，用
split() 可以删掉。
echo split(reltimestr(reltime(start)))[0]
另见 profiling 。
出错时在老式脚本里返回空串，Vim9 脚本里报错。
也可用作 method :
reltime(start)->reltimestr()
返回类型: String
{仅当编译时加入 +reltime 特性才有效}
remote_expr() E449
remote_expr({server}, {string} [, {idvar} [, {timeout}]])
发送 {string} 到 {server}。{server} 参数是字符串，另见
{server} 。
该发送的字符串是一个表达式，而返回的是远端执行的结果。这个结果
必然是字符串或 List 。其它类型会转换为字符串。 List 转换成字
符串的方法是把项目用换行符连接起来 (末项之后没有)，就像用
join(expr, "\n") 那样。
如果给出 {idvar} 且非空，将 {serverid} 保存在以它命令的变量
里，此后的 remote_read() 需要使用此值。
如果给出 {timeout}，在给定的秒数后读取超时。否则，使用 600 秒
超时。
另见 clientserver RemoteReply 。
该函数在沙盘里不可用 sandbox 。
{仅当编译时加入 +clientserver 特性才有效}
注意: 任何错误会在本地产生错误信息，但返回的结果只是一个空字符
串。
在全局命名空间中计算变量，而和当前激活的函数无关。调试模式例
外，此时会计算局部于函数的变量和参数。
例如:
:echo remote_expr("gvim", "2+2")
:echo remote_expr("gvim1", "b:current_syntax")
也可用作 method :
ServerName()->remote_expr(expr)
返回类型: String 或 list<{type}>
remote_foreground({server}) remote_foreground()
把名为 {server} 的 Vim 服务器带到前台。{server} 参数是字符串，
另见 {server} 。
这类似于:
remote_expr({server}, "foreground()")
Win32 系统除外。那里，客户端完成实际的工作。因为操作系统不
总能允许服务器把自己带到前台。
注意: 如果窗口最小化，并不恢复之， foreground() 会这么做。
该函数在沙盘里不可用 sandbox 。
也可用作 method :
ServerName()->remote_foreground()
返回类型: Number
{仅可用在 Win32、Motif 和 GTK GUI 版本和 Win32 的控制台版本}
remote_peek({serverid} [, {retvar}]) remote_peek()
如果 {serverid} 有可用的字符串，返回正数。如果指定了
{retvar}，复制任何应答字符串到 {retvar} 指定的变量。{retvar}
必须是一个用来指定变量名的字符串。
如果没有可用的应答，返回 0。
出错时返回 -1。
另见 clientserver 。
该函数在沙盘里不可用 sandbox 。
{仅当编译时加入 +clientserver 特性才有效}
示例:
:let repl = ""
:echo "PEEK: " .. remote_peek(id, "repl") .. ": " .. repl
ServerId()->remote_peek()
返回类型: Number
remote_read({serverid}, [{timeout}]) remote_read()
返回从 {serverid} 发送的存在时间最长的应答，并删除之。除非给出
以秒计的 {timeout}，该调用会等待直到有应答为止。如果没有应答或
出错，返回空串。
另见 clientserver 。
该函数在沙盘里不可用 sandbox 。
{仅当编译时加入 +clientserver 特性才有效}
例如:
:echo remote_read(id)
ServerId()->remote_read()
返回类型: String
remote_send({server}, {string} [, {idvar}]) remote_send() E241
发送 {string} 到 {server}。{server} 参数是字符串，另见
{server} 。
发送的字符串是输入键的序列。函数立即返回。Vim 的服务器端不对键
进行映射 :map 。
如果给出 {idvar}，将 {serverid} 保存在以它命令的变量里，此后的
remote_read() 需要使用此值。
另见 clientserver RemoteReply 。
该函数在沙盘里不可用 sandbox 。
{仅当编译时加入 +clientserver 特性才有效}
注意: 任何错误会在服务器端报告，从而影响那里的显示。
例如:
:echo remote_send("gvim", ":DropAndReply " .. file,
\ "serverid") .. remote_read(serverid)
:autocmd NONE RemoteReply *
\ echo remote_read(expand("<amatch>"))
:echo remote_send("gvim", ":sleep 10 | echo " ..
\ 'server2client(expand("<client>"), "HELLO")<CR>')
也可用作 method :
ServerName()->remote_send(keys)
返回类型: String
remote_startserver({name}) remote_startserver() E941 E942
成为服务器 {name}。{name} 不能为空串。
如果已作为服务器运行，也即 v:servername 不为空时此操作失败。
也可用作 method :
ServerName()->remote_startserver()
返回类型: Number
{仅当编译时加入 +clientserver 特性才有效}
remove({list}, {idx}) remove()
remove({list}, {idx}, {end})
没有 {end}: 删除 List {list} 里索引为 {idx} 的项目并返回之。
有 {end}: 删除从 {idx} 到 {end} (闭区间) 的项目，并返回这些项
目的 List 。如果 {idx} 指向和 {end} 相同的项目，返回单个项目
的列表。如果 {end} 指向 {idx} 之前的项目，报错。
list-index 说明 {idx} 和 {end} 可能的取值。
出错时返回零。
例如:
:echo "last item: " .. remove(mylist, -1)
:call remove(mylist, 0, 9)
用 delete() 来删除文件。
也可用作 method :
mylist->remove(idx)
返回类型: any，取决于 {list}
remove({blob}, {idx})
remove({blob}, {idx}, {end})
没有 {end}: 删除 Blob {blob} 里索引为 {idx} 的字节并返回之。
有 {end}: 删除从 {idx} 到 {end} (闭区间) 的字节，并返回这些字
节构成的的 Blob 。如果 {idx} 指向和 {end} 相同的字节，返回单
个字节构成的 Blob 。如果 {end} 指向 {idx} 之前的字节，报错。
出错时返回零。
示例:
:echo "last byte: " .. remove(myblob, -1)
:call remove(mylist, 0, 9)
返回类型: Number
remove({dict}, {key})
删除 {dict} 里键为 {key} 的项目并返回其值。例如:
:echo "removed " .. remove(dict, "one")
如果 {dict} 里没有键 {key}，报错。
出错时返回零。
返回类型: any，取决于 {dict}
rename({from}, {to}) rename()
把文件名 {from} 换成 {to}。这也可用来在文件系统间移动文件。返
回数值，如果文件成功换名，返回零，如果换名失败，返回非零。
注意 如果 {to} 已存在，它被覆盖且没有提示。
该函数在沙盘里不可用 sandbox 。
也可用作 method :
GetOldName()->rename(newname)
返回类型: Number
repeat({expr}, {count}) repeat()
重复 {expr} {count} 次，并返回连接后的结果。例如:
:let separator = repeat('-', 80)
如果 {count} 为零或负，返回空。
如果 {expr} 是 List 、 Tuple 或 Blob 类型，返回连接 {expr}
{count} 次的结果。例如:
:let longlist = repeat(['a', 'b'], 3)
返回 ['a', 'b', 'a', 'b', 'a', 'b']。
也可用作 method :
mylist->repeat(count)
返回类型: String 、 Blob 、list<{type}> 或 tuple<{type}>，取
决于 {expr}
resolve({filename}) resolve() E655
在 MS-Windows 上，如果 {filename} 是一个快捷方式 (.lnk 文件)，
返回简化的快捷方式指向的路径。当 {filename} 为符号链接或连接点
(junction point) 时，返回目的地的完整路径。如果该连接
(junction) 的目的地已被删除，返回 {filename}。
在 Unix 上，反复分析 {filename} 的所有路径部分的符号链接的真正
路径，直到返回最简化的结果为止。为了处理循环链接的问题，符号链
接的分析在 100 次叠代之后停止。
在其它系统上，返回简化了的 {filename}。
简化的工作通过 simplify() 完成。
resolve() 保留指向当前目录的首个路径部分 (保证结果仍然是相对路
径名)，也保留出现在尾部的路径分隔符。
也可用作 method :
GetName()->resolve()
返回类型: String
reverse({object}) reverse()
反转 {object} 项目的顺序。{object} 必须是 List 、 Tuple 、
Blob 或者 String 。如果是列表或 Blob，直接对 {object} 进行
原位修改。
如果是元组，返回新元组。
如果是字符串，返回新字符串。
如果 {object} 不是列表、元组、blob 或字符串，返回零。
如果你不想修改列表或 Blob，先构建一个备份:
:let revlist = reverse(copy(mylist))
也可用作 method :
mylist->reverse()
返回类型: String 、 Blob 、list<{type}> 或 tuple<{type}>，取
决于 {object}
round({expr}) round()
返回浮点数，即最接近于 {expr} 的整数。如果 {expr} 在两个整数的
正中间，使用 (译者注: 绝对值) 较大 (远离零的) 那个。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
echo round(0.456)
0.0
echo round(4.5)
5.0
echo round(-4.5)
-5.0
也可用作 method :
Compute()->round()
返回类型: Float
rubyeval({expr}) rubyeval()
计算 Ruby 表达式 {expr} 并返回计算结果，转换为 Vim 本身的数
据结构。
数值、浮点数和字符串返回本身 (字符串经过复制)。
数值返回 Vim List 类型。
哈希表返回 Vim Dictionary 类型。
其它对象返回它们 "Object#to_s" 方法返回的字符串。
注意 :def 函数里的局部变量对 {expr} 不可见。
也可用作 method :
GetRubyExpr()->rubyeval()
返回类型: any，取决于 {expr}
{仅当编译时加入 +ruby 特性才有效}
screenattr({row}, {col}) screenattr()
类似于 screenchar() ，但返回属性。是个相当任意的值，只可用于
和其他位置的属性进行比较。
如果 row 或 col 越界，返回 -1。
也可用作 method :
GetRow()->screenattr(col)
返回类型: Number
screenchar({row}, {col}) screenchar()
返回数值，即屏幕 [row, col] 位置的字符。可用于任何可能的屏幕
位置，包括状态行，窗口分隔符和命令行。左上位置的行列号都为一。
返回字符不包括组合字符。双字节编码可能只返回第一个字节。
主要用于调试。
行号或列号越界时返回 -1。
也可用作 method :
GetRow()->screenchar(col)
返回类型: Number
screenchars({row}, {col}) screenchars()
返回数值 List 。第一个数值和 screenchar() 返回的相同。其后
的数值是附加于基础字符之上的组合字符。
主要用于测试。
如果 row 或 col 超出范围返回空列表。
也可用作 method :
GetRow()->screenchars(col)
返回类型: list<number> 或 list<any>
screencol() screencol()
返回数值，即当前光标的屏幕列号。最左列的列号为 1。
主要用于调试。
注意: 总是返回当前屏幕列，所以直接用于命令 (例如 ":echo
screencol()") 时会返回命令行内的列号，其在命令执行时永远为 1。
要得到文件中的光标位置，可用下面这些映射:
nnoremap <expr> GG ":echom " .. screencol() .. "\n"
nnoremap <silent> GG :echom screencol()<CR>
nnoremap GG <Cmd>echom screencol()<CR>
返回类型: Number
screenpos({winid}, {lnum}, {col}) screenpos()
返回字典，窗口 {winid} 在缓冲区行 {lnum} 和列 {col} 上的文本字
符的屏幕位置。{col} 是从一开始的字节索引。
字典有以下成员:
row 屏幕行
col 首个屏幕列
endcol 末尾屏幕列
curscol 光标所在屏幕列
如果指定位置不可见，所有的值均为零。
当字符占据多于一个屏幕单元格时，"endcol" 和 "col" 的值会不同。
例如制表符的 "col" 可能是 1 而 "eolcol" 会是 8。
"curscol" 值是光标会放置的地方。对于制表符而言会和 "endcol" 相
同。而对双宽字符来说，就会为 "col" 相同。
此处忽略 conceal 特性，列号的行算假定 'conceallevel' 为零。
要得到 conceal 考虑在内的值，可以把光标放在合适的位置，然后
用 screencol() 。
如果位置在关闭的折叠里，返回其首个字符的屏幕位置，不使用
{col}。
{winid} 非法时返回空字典。
也可用作 method :
GetWinid()->screenpos(lnum, col)
返回类型: dict<number> 或 dict<any>
screenrow() screenrow()
返回数值，即当前光标的屏幕行号。最顶行的行号为 1。
主要用于调试。
代为替代，也可用 winline() 。
注意: 和 screencol() 的限制相同。
返回类型: Number
screenstring({row}, {col}) screenstring()
返回字符串，包含在屏幕位置 [row, col] 上的基本字符和任何组合字
符。类似于 screenchars() ，但返回字符组成的字符串。
主要用于测试。
如果行或列超出范围，返回空串。
也可用作 method :
GetRow()->screenstring(col)
返回类型: String
search()
search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
搜索正则表达式模式 {pattern}。搜索从光标位置 (用 cursor() 可
以得到) 开始。
如果找到了匹配，返回其所在的行号。
如果找不到匹配，返回 0 并且光标位置不改变。不会给出错误信息。
要取得匹配的字符串，可用 matchbufline() 。
{flags} 是字符串，可以包含以下字符标志位:
'b' 反向 (Backward) 搜索，而不是正向搜索
'c' 接受光标 (Cursor) 位置上的匹配
'e' 移到匹配的尾部 (End)
'n' 不 (Not) 移动光标
'p' 返回匹配的子模式 (Pattern) 号 (见下)
's' 在光标上次的位置上设置 (Set) ' 位置标记
'w' 在文件尾部处回绕 (Wrap) 到文件开始处
'W' 不在文件尾部处回绕 (Wrap)
'z' 从光标列开始搜索而不是第零 (Zero) 列
如果 'w' 和 'W' 都没有给出，根据 'wrapscan' 选项决定。
如果提供 's' 标志位，只有在光标移动的时候才设置 ' 位置标记。
's' 标志位不能和 'n' 标志位一起使用。
适用 'ignorecase'、'smartcase' 和 'magic' 标志位。
如果没给出 'z' 标志位，正向搜索总是从第零列开始，然后跳过光标
之前的匹配。如果 'cpo' 中有 'c' 标志位，下次搜索从匹配之后的位
置开始。没有 'c' 标志位则下次搜索从匹配开始处的后一列开始。这
对有重叠的匹配会有关系。见 cpo-c 。也可插入 "\ze" 来改变匹配
结束的位置，见 /\ze 。
反向搜索给出 'z' 标志位时，搜索从第零列开始，所以不会找到当前
行的任何匹配 (除非从文件尾回绕)。
如果给出 {stopline} 参数，搜索在搜索完该行后结束。可用于限制搜
索在给出的行范围内。例如:
let match = search('(', 'b', line("w0"))
let end = search('END', '', line("w$"))
如果使用了 {stopline} 且非零，隐含意味着搜索不会在文件尾回绕。
零就相当于没给出该参数。
E1285 E1286 E1287 E1288 E1289
如果给出 {timeout} 参数，搜索在超过给出的毫秒数后中止。这样，
如果 {timeout} 为 500，搜索在半秒钟后中止。该值不能为负。
零就相当于没给出该参数。
注意: 超时仅在搜索时考虑，计算 {skip} 表达式时不会。
{仅当在编译时加入 +reltime 特性才有效}
如果给出 {skip} 表达式，对匹配开始处的光标位置进行计算。如果计
算结果非零，跳过此匹配。可用于，比如说，跳过注释或字符串内部的
匹配。
{skip} 可以是作为表达式计算的字符串、函数引用或匿名函数。
{skip} 省略或为空时，接受所有匹配。
计算 {skip} 时如果出错，中断搜索并返回 -1。
search()-sub-match
如果有 'p' 标志位，返回值比第一个匹配的 \(\) 里的子模式的编号
多一。如果所有子模式都不匹配但整个模式匹配，返回一。
要得到列号，使用 searchpos() 。
光标定位在匹配的文本上，除非使用了 'n' 标志位。
示例 (遍历参数列表里的所有文件):
:let n = 1
:while n <= argc() " 循环遍历参数列表的每个文件
: exe "argument " .. n
: " 从文件最后一个字符开始并回绕，这样第一个搜索可以找到
: " 文件开始的匹配
: normal G$
: let flags = "w"
: while search("foo", flags) > 0
: s/foo/bar/g
: let flags = "W"
: endwhile
: update " 如果修改过，写入文件
: let n = n + 1
:endwhile
使用一些标志位的示例:
:echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
这会在光标之下或之后寻找关键字 "if"、"else" 和 "endif"。因为有
'p' 标志位，会根据找到的是哪 个关键字返回 1、2 或 3，如果找不
到会返回 0。如果光标在行的第一个单词上:
if (foo == 0) | let foo = foo + 1 | endif
此函数返回 1。没有 'c' 标志位的话，函数会找到 "endif" 并返回
3。如果没有 'e' 标志位且光标在 "if" 的 "f" 上也会同样如此。'n'
标志位告诉函数不移动光标。
也可用作 method :
GetPattern()->search()
返回类型: Number
searchcount([{options}]) searchcount()
获取或更新最近搜索计数，就像不带 "S" 标志位的 'shoftmess' 所显
示的那样。即便 'shortmess' 包含 "S" 标志位，此函数同样适用。
返回 Dictionary 。如果没有设置前次模式且未指定 "pattern"，此
字典为空。
键 类型 意义
current Number 匹配的当前位置；
0 如果光标位置在首个匹配之前
exact_match Boolean 1 如果 "current" 在 "pos" 上匹
配，否则为 0
total Number 找到的匹配总数
incomplete Number 0: 搜索全部完成
1: 重计算超时
2: 超过最大计数
{options} 见下。
要取得最近一次按下 n 或 N 时的搜索计数，调用此函数，并带上
`recompute: 0`。有时，因为 'maxsearchcount'，这会返回错误的信
息。如果计数超过 'maxsearchcount'，结果必是
'maxsearchcount' + 1。如果要得到正确的信息，指定
`recompute: 1`:
" result == 'maxsearchcount' + 1 如果有很多匹配
let result = searchcount(#{recompute: 0})
" 以下则返回正确结果 (recompute 缺省为 1)
let result = searchcount()
此函数可用于给 'statusline' 加入计数:
function! LastSearchCount() abort
let result = searchcount(#{recompute: 0})
if empty(result)
return ''
endif
if result.incomplete ==# 1 " 超时
return printf(' /%s [?/??]', @/)
elseif result.incomplete ==# 2 " 超过最大计数
if result.total > result.maxcount &&
\ result.current > result.maxcount
return printf(' /%s [>%d/>%d]', @/,
\ result.current, result.total)
elseif result.total > result.maxcount
return printf(' /%s [%d/>%d]', @/,
\ result.current, result.total)
endif
endif
return printf(' /%s [%d/%d]', @/,
\ result.current, result.total)
endfunction
let &statusline ..= '%{LastSearchCount()}'
" 如果只想打开 'hlsearch' 时显示计数，也可以如此
" let &statusline ..=
" \ '%{v:hlsearch ? LastSearchCount() : ""}'
也可以更新搜索计数，可用于 CursorMoved 或 CursorMovedI 自
动命令:
autocmd CursorMoved,CursorMovedI *
\ let s:searchcount_timer = timer_start(
\ 200, function('s:update_searchcount'))
function! s:update_searchcount(timer) abort
if a:timer ==# s:searchcount_timer
call searchcount(#{
\ recompute: 1, maxcount: 0, timeout: 100})
redrawstatus
endif
endfunction
也可用 "pattern" 来统计在当前缓冲区里匹配指定模式的文本数目:
" 统计此缓冲区中的 '\<foo\>' 数
" (注意 这也会更新搜索计数)
let result = searchcount(#{pattern: '\<foo\>'})
" 要恢复旧模式的旧搜索计数，可再次搜索
call searchcount()
{options} 必须为 Dictionary 。可包含:
键 类型 含义
recompute Boolean 如果为 TRUE ，就像执行了 n
或 N 那样重新计算计数。
否则，返回最近的计算结果 (当执
行了 n 或 N 假定
'shortmess' 里没有 "S"，此函数
执行时有同样效果)。
(缺省: TRUE )
pattern String 就像给出和 @/ 不同的模式那样
重新计算。
和在调用此函数前执行以下命令的
效果相同
let @/ = pattern
(缺省: @/ )
timeout Number 0 或负数代表无超时。
以毫秒计的对结果重计算的超时
(缺省: 0)
maxcount Number 0 或负数代表无限制。对结果重计
算时匹配文本的最大计数。如果搜
索超过总数，"total" 值成为
`maxcount + 1`
(缺省: 'maxsearchcount')
pos List 重计算结果时的
`[lnum, col, off]` 值。
这会改变 "current" 返回值。见
cursor() 、 getpos()
(缺省: 光标所在位置)
也可用作 method :
GetSearchOpts()->searchcount()
返回类型: dict<number>
searchdecl({name} [, {global} [, {thisblock}]]) searchdecl()
搜索 {name} 的声明。
如果 {global} 参数非零，使用 gD 的工作方式，寻找文件的第一个
匹配。否则使用 gd 的工作方式，寻找函数里的第一个匹配。
如果 {thisblock} 参数非零，忽略光标位置前结束的 {} 块里的匹
配。可以避免只有在别的作用域里才有效的变量声明。
移动光标到找到的匹配上。
返回零代表成功，非零代表失败。
例如:
if searchdecl('myvar') == 0
echo getline('.')
endif
也可用作 method :
GetName()->searchdecl()
返回类型: Number
searchpair()
searchpair({start}, {middle}, {end} [, {flags} [, {skip}
[, {stopline} [, {timeout}]]]])
搜索嵌套的 start-end 组对的匹配。这可以用来查找匹配 "if" 的
"endif"。在这里面的其它的 if/endif 组对被忽略。搜索从光标开
始。缺省正向搜索，在 {flags} 里包含 'b' 的时候反向搜索。
如果找到一个匹配，光标移动到那里并返回行号。如果没有匹配，
返回 0 或者 -1，光标不移动。不会给出错误信息。
{start}、{middle} 和 {end} 都是模式，见 pattern 。它们不能包
含 \( \) 对，但可以使用 \%( \)。如果 {middle} 非空，在相应的方
向试图寻找它 (如果找到，停留在哪里)，但在嵌套的 start-end 组对
里面的不算。一个典型的应用是:
searchpair('\<if\>', '\<else\>', '\<endif\>')
如果 {middle} 为空，跳过 "else"。
{flags} 'b'、'c'、'n'、's'、'w' 和 'W' 的使用方式和 search()
类似。此外，还可用:
'r' 重复 (Repeat) 直到没有更多匹配位置；会找到最外层的组
对。隐含 'W' 标志位。
'm' 返回匹配 (Match) 的数目而不是匹配的行号；使用 'r' 时会
> 1。
备注: 最好使用 'W' 标志位，避免在文件尾回绕。
如果找到 {start}、{middle} 或 {end} 的匹配，计算 {skip} 表达
式，此时假定光标定位在匹配的开始处。如果返回零，该匹配被跳过。
比如，可能是出现在注释里的匹配。
如果 {skip} 不提供或者为空，接受每一个匹配。如果计算 {skip} 时
出现错误，搜索被中止，并返回 -1。
{skip} 可以是字符串、匿名函数、函数引用或偏函数。其它类型会报
错。
:def 函数里，{skip} 参数如是字符串常量，会编译为指令的一部
分。
{stopline} 和 {timeout} 见 search() 。
使用 'ignorecase' 的值。忽略 'magic'，使用模式时假设它总是置位
的。
搜索从准确的光标处开始。根据搜索方向，寻找从下一个字符开始的
{start}、{middle} 或 {end}。比如:
if 1
if 2
endif 2
endif 1
如果从 "if 2" 开始且光标在 "i" 上并正向搜索，找到的是
"endif 2"。如果刚好在 "if 2" 之前开始，找到的是 "endif 1"。因
为先找到的了 "if 2"，而它被认为是嵌套的 if/endif，以 "if 2"
开始，以 "endif 2" 结束。
如果反向搜索且 {end} 多于一个字符，在模式的最后加上 "\zs" 可能
有用，这样光标在 end 匹配的中间某位置的时候，仍然可以找到匹配
的 start 匹配。
例如，要找到 Vim 脚本里的 "endif" 命令:
:echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
\ 'getline(".") =~ "^\\s*\""')
注意 单引号字符串的使
用，它避免了反斜杠的麻烦。skip 表达式只用来发现行首的注释，命
令之后的不行。另外，一行中间的单词 "en" 或 "if" 也被认为是匹
配。
另一个例子，搜索匹配 "}" 的 "{":
:echo searchpair('{', '', '}', 'bW')
:echo searchpair('{', '', '}', 'bW',
\ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
返回类型: Number
searchpairpos()
searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
[, {stopline} [, {timeout}]]]])
和 searchpair() 相同，但返回 List ，包含匹配的行号和列号。
List 的第一个元素是行号，而第二个元素是匹配所在的列位置的字
节位置。如果没有匹配，返回 [0, 0]。
:let [lnum,col] = searchpairpos('{', '', '}', 'n')
match-parens 提供一个更复杂更有用的例子。
返回类型: list<number>
searchpos()
searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
和 search() 相同，但返回 List ，包含匹配的行号和列号。
List 的第一个元素是行号，而第二个元素是匹配所在的列位置的字
节位置。如果没有匹配，返回 [0, 0]。
例如:
:let [lnum, col] = searchpos('mypattern', 'n')
:let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
此例中如果找到小写字母 /\l "submatch" 为 2，如果找到大写字母
/\u 则为 3。
也可用作 method :
GetPattern()->searchpos()
返回类型: list<number>
server2client({clientid}, {string}) server2client()
发送应答字符串到 {clientid}。最近刚发送过字符串的 {clientid}
可以通过 expand("<client>") 得到。
{仅当在编译时加入 +clientserver 特性才有效}
返回零代表成功，-1 代表失败。
备注:
该 id 应在接受下一个命令前保存。也就是，在接收命令返回之前 (译
者注: 似应为 "之后") 和任何等待输入的命令之前。
另见 clientserver 。
示例:
:echo server2client(expand("<client>"), "HELLO")
GetClientId()->server2client(string)
返回类型: Number
serverlist() serverlist()
返回可用的服务器名字列表，每行一个。如果没有服务器或者该信息
无法得到，返回空字符串。另见 clientserver 。
{仅当编译时加入 +clientserver 特性才有效}
示例:
:echo serverlist()
返回类型: String
setbufline({buf}, {lnum}, {text}) setbufline()
设置缓冲区 {buf} 的第 {lnum} 行为 {text}。相当于为指定缓冲区
调用 setline() 。
此函数只能用于已载入的缓冲区。有必要的话先调用 bufload() 。
要插入行可用 appendbufline() 。
清除 {lnum} 中的任何文本属性。
{text} 可以是字符串，用来设置单行文本，也可以是字符串列表，用
来设置多行文本。如果列表范围超出末行之下，则添加额外的行。如果
列表为空，不作任何改变并返回零。
{buf} 的用法可见上述 bufname() 。
{lnum} 的用法可见 setline() 。
"$" 指定 {buf} 缓冲区的末行。
如果 {lnum} 正好在末行之下，在末行之下添加 {text}。
如果 {buf} 不是合法缓冲区、缓冲区未载入、或 {lnum} 不合法，返
回 1。 Vim9 脚本里会报错。
成功时返回 0。
也可用作 method ，基是作为第三个参数传递的:
GetText()->setbufline(buf, lnum)
返回类型: Number
setbufvar({buf}, {varname}, {val}) setbufvar()
设置缓冲区 {buf} 的选项或局部变量 {varname} 的值为 {val}。
也可用于全局或者局部于窗口的选项，但不能用于全局或者局部于窗口
的变量。
如果设置局部于窗口的选项，全局值不会改变。
{buf} 的使用方式见上 bufname() 。
{varname} 参数是字符串。
注意必须使用不带 "b:" 的变量名。
示例:
:call setbufvar(1, "&mod", 1)
:call setbufvar("todo", "myvar", "foobar")
该命令在沙盘里不可用 sandbox 。
也可用作 method ，基是作为第三个参数传递的:
GetValue()->setbufvar(buf, varname)
返回类型: Number
setcellwidths({list}) setcellwidths()
指定字符范围的单元宽度覆盖。用于告知 Vim 在终端显示时字符以屏
幕单元计的宽度。此设置超越 'ambiwidth'。示例:
call setcellwidths([
\ [0x111, 0x111, 1],
\ [0x2194, 0x2199, 2],
\ ])
{list} 参数为三个数值组成的列表的列表:
[{low}, {high}, {width}]。 E1109 E1110
"low" 和 "high" 可以相同，代表单个字符。否则，它们指定从 "low"
到 "high" (闭区间) 的字符范围。 E1111 E1114
只能指定值为 0x80 和更高的字符。
"width" 可为 1 或 2，指定以屏幕单元计的字符宽度。
E1112
如果参数不合法或范围相互有重叠，报错。 E1113
如果新值导致 'fillchars' 或 'listchars' 非法，拒绝新值并报错。
要清除覆盖，传递空 {list}:
setcellwidths([]);
{list} 参数。
返回类型: Number
setcharpos({expr}, {list}) setcharpos()
同 setpos() ，但使用指定列号作为行内字符索引，而不是字节索
引。
示例:
在第 8 行的文本 "여보세요" 上:
call setcharpos('.', [0, 8, 4, 0])
定位光标在第四个字符 '요' 上。
call setpos('.', [0, 8, 4, 0])
定位光标在第二个字符 '보' 上。
也可用作 method :
GetPosition()->setcharpos('.')
返回类型: Number
setcharsearch({dict}) setcharsearch()
用 {dict} 设置当前字符搜索信息，带有以下项目:
char 下次 , 或 ; 命令使用的字符；空字符串清除字
符搜索
forward 字符搜索的方向；1 为正向，0 为反向
until 字符搜索的类型；1 为 t 为 T 字符搜索，0 为
f 或 F 字符搜索
可用于在脚本中保存/恢复用户的字符搜索:
:let prevsearch = getcharsearch()
:" 执行改写用户搜索的命令
:call setcharsearch(prevsearch)
另见 getcharsearch() 。
也可用作 method :
SavedSearch()->setcharsearch()
返回类型: dict<any>
setcmdline({str} [, {pos}]) setcmdline()
设置命令行为 {str}，并设置光标位置为 {pos}。
{pos} 如省略，光标会定位于文本后。
如果成功，返回 0，如果不在编辑命令行，返回 1。
也可用作 method :
GetText()->setcmdline()
返回类型: Number
setcmdpos({pos}) setcmdpos()
设置命令行的光标位置到字节位置 {pos}。第一个位置为 1。
用 getcmdpos() 得到当前的位置。
只有在编辑命令行时有效，所以必须在 c_CTRL-\_e 、 c_CTRL-R_=
或带 '=' 的 c_CTRL-R_CTRL-R 里使用。对于 c_CTRL-\_e 和带
'=' 的 c_CTRL-R_CTRL-R ，在命令行设为表达式的内容之后才设置位
置。对于 c_CTRL-R_= ，在计算表达式之后但在插入返回的文本之前
设置位置。
如果数值太大，光标放在行尾。如果小于 1，结果没有定义。
如果成功，返回 0，如果不在编辑命令行，返回 1。
也可用作 method :
GetPos()->setcmdpos()
返回类型: Number
setcursorcharpos({lnum}, {col} [, {off}]) setcursorcharpos()
setcursorcharpos({list})
同 cursor() ，但使用指定列号作为行内的字符索引，而不是字节索
引。
示例:
在第 4 行的文本 "여보세요" 上:
call setcursorcharpos(4, 3)
定位光标在第三个字符 '세' 上。
call cursor(4, 3)
定位光标在第一个字符 '여' 上。
也可用作 method :
GetCursorPos()->setcursorcharpos()
位置可以设置时返回 0，否则返回 -1。
返回类型: Number
setenv({name}, {val}) setenv()
设置环境变量 {name} 值为 {val}。例如:
call setenv('HOME', '/home/myhome')
{val} 为 v:null ，删除该环境变量。
另见 expr-env 。
也可用作 method ，基是作为第二个参数传递的:
GetPath()->setenv('PATH')
返回类型: Number
setfperm({fname}, {mode}) setfperm() chmod
设置 {fname} 的文件权限为 {mode}。
{mode} 必须是 9 个字符的字符串。形如 "rwxrwxrwx"，每组 "rwx"
标志位代表着，按次序，文件拥有者、文件所属组和其他用户的权限。
'-' 字符代表关闭权限，其他字符代表打开。不支持多字节字符。
例如 "rw-r-----" 意味着用户可读写，组只读，其他不可访问。
"xx-x-----" 作用相同。
返回非零代表成功，零代表失败。
也可用作 method :
GetFilename()->setfperm(mode)
要读取权限可见 getfperm() 。
返回类型: Number
setline({lnum}, {text}) setline()
设置当前缓冲区第 {lnum} 行的内容为 {text}。要插入新行，用
append() 。要设置其它缓冲区的行，可用 setbufline() 。
清除 {lnum} 中的任何文本属性。见 text-prop-cleared
{lnum} 的用法可见 getline() 。
如果 {lnum} 正好在末行之下，在末行之下添加 {text}。
{text} 可以是任何类型或任何类型的列表，每个项目会被转换为字符
串。{text} 为空列表时，不进行任何改变且返回 FALSE。
如果成功，返回 FALSE。如果失败 (多数是因为 {lnum} 不合法) 返回
TRUE。
Vim9 脚本里如果 {lnum} 非法会报错。
例如:
:call setline(5, strftime("%c"))
{text} 为 List ，那么第 {lnum} 行和其后的行被设为列表里
的项目。例如:
:call setline(5, ['aaa', 'bbb', 'ccc'])
等价于:
:for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
: call setline(n, l)
:endfor
注意: 这里不会设置 '[ 和 '] 位置标记。
也可用作 method ，基是作为第二个参数传递的:
GetText()->setline(lnum)
返回类型: Number
setloclist({nr}, {list} [, {action} [, {what}]]) setloclist()
创建或替代或加入到窗口 {nr} 的位置列表。
{nr} 可以是窗口号或 window-ID 。
如果 {nr} 为零，使用当前窗口。
如果是位置列表窗口，修改所显示的位置列表。如果窗口号 {nr} 非
法，返回 -1。
其它同 setqflist() 。
另见 location-list 。
关于 {action}，可见 setqflist-action 。
如果给出可选的 {what} 字典参数，只设置 {what} 中列出的项目。
关于 {what} 支持的键值的列表，参见 setqflist() 。
也可用作 method ，基是作为第二个参数传递的:
GetLoclist()->setloclist(winnr)
返回类型: Number
setmatches({list} [, {win}]) setmatches()
恢复 getmatches() 为当前窗口保存的匹配列表。如果成功，返回
0，否则返回 -1。原有的所有匹配都被清除。示例见
getmatches() 。
如果给出 {win}，使用带此窗口号或窗口 ID 的窗口而不是当前窗口。
也可用作 method :
GetMatches()->setmatches()
返回类型: Number
setpos({expr}, {list}) setpos()
设置字符串 {expr} 的位置。可能的值:
. 光标
'x 位置标记 x
{list} 必须是带四个或五个数值的 List :
[bufnum, lnum, col, off]
[bufnum, lnum, col, off, curswant]
"bufnum" 是缓冲区号。零代表当前缓冲区。如果设置大写位置标记，
"bufnum" 是位置标记位置的一部分。对其它的位置标记，它用于指定
设置位置标记的缓冲区。可以用 bufnr() 函数把文件名转化为缓冲
区号。
设置光标和 ' 位置标记时忽略 "bufnum"，因为它们和窗口相关，而不
是缓冲区相关。
不修改跳转表。
"lnum" 和 "col" 是缓冲区里的位置。第一列为 1。"lnum" 为零则删
除位置标记。"col" 如小于 1，则以 1 代替。要使用字符计数而不是
字节计数，用 setcharpos() 。
除非使用了 'virtualedit'，不用 "off" 值。这是从对应字符开始位
置以屏幕列计的位移。例如，在制表之中或最后一个字符之后的某个位
置。
"curswant" 值只用于设置光标位置。它指定垂直移动光标时的首选
列。如果没有 "curswants" 值，不设置首选列。如果有但用于设置位
置标记时，也没有效果。
注意对 '< 和 '> 而言，改变行号可能会使两者在实际中被调换，以保
证 '< 总是在 '> 之前。
如果位置可以设置，返回 0，否则返回 -1。如果 {expr} 不合法，报
错。
另见 setcharpos() 、 getpos() 和 getcurpos() 。
这并不能恢复垂直移动使用的列；如果用它设置了光标位置， j 和
k 动作会跳转到上次的列上！ cursor() 也可设置首选列。另见
winrestview() 的 "curswant" 键。
也可用作 method :
GetPosition()->setpos('.')
返回类型: Number
setqflist({list} [, {action} [, {what}]]) setqflist()
创建或替代或加入到快速修复表。
如果提供了可选的 {what} 字典参数，只设置 {what} 列出的项目，忽
略首个参数 {list}。{what} 支持的项目见下。
setqflist-what
如果不给出 {what}，使用 {list} 里的项目。每个 {list} 项目是一
个字典。{list} 里非字典的项目被忽略。每个字典项目可以包含以下
的项目:
bufnr 缓冲区号；必须为某个合法缓冲区的编号
filename 文件名；仅当 "bufnr" 不存在或者不合法时才使用
module 模块名；如果给出，在快速修复错误窗口用它而不是
文件名
lnum 缓冲区里的行号
end_lnum 如果项目跨越多行，末行的行号
pattern 用于定位错误的模式
col 列号
vcol 非零: "col" 是可视列
零: "col" 是字节位置
end_col 如果项目跨越多列，末列的列号
nr 错误号
text 错误描述
type 错误类型，'E'、'W' 等。
valid 经过识别的错误信息
user_data 项目关联的定制数据，可为任意类型。
"col"、"vcol"、"nr"、"type" 和 "text" 项目是可选的。"lnum" 或
"pattern" 项目用来定位匹配的错误行。
如果 "filename" 和 "bufnr" 项目都不存在或者 "lnum" 和
"pattern" 项目都不存在，那么此项目不被当作错误行处理。
如果 "pattern" 和 "lnum" 都存在，使用 "pattern"。
如果不提供 "valid" 项目，则在 "bufnr" 为合法的缓冲区或
"filename" 存在时，置位 valid 标志位。
如果 {list} 为空，快速修复列表被清除。
注意 此列表和 getqflist() 返回之值不尽相同。
{action} 值: setqflist-action E927
'a' 把 {list} 项目加入已有的快速修复列表。如果该列表尚不存
在，建立新表。
'r' {list} 项目替换当前快速修复列表项目。也可用于清除列
表:
:call setqflist([], 'r')
'u' 和 'r' 类似，但试图保留快速修复列表里的当前选择。
'f' 释放快速修复堆栈上的所有快速修复列表。
如果 {action} 不存在或者设为 ' '，那么建立新表。栈中在当前快速
修复列表之后加入新快速修复列表并释放其后的所有列表。要在栈的尾
部加入新快速修复列表，把 {what} 中的 "nr" 设为 "$"。
{what} 支持以下项目:
context 快速修复列表上下文。见 quickfix-context
efm 解析 "lines" 时使用的 errorformat。如果没有给
出，使用 'errorformat' 选项值。
见 quickfix-parse
id 快速修复列表标识号 quickfix-ID
idx 'id' 或 'nr' 指定的快速修复列表的当前项的索
引。如果设为 '$'，列表的末项设为当前项。见
quickfix-index
items 快速修复项目的列表，同 {list} 参数。
lines 用 'efm' (译者注: 原文作 'errorformat'，似不
妥) 解析文本行列表并其结果项目加入快速修复列表
{nr} 或 {id} 中。只支持 List 类型。
见 quickfix-parse
nr 快速修复堆栈中的列表号；零代表当前快速修复列
表，"$" 代表最后的快速修复列表。
quickfixtextfunc
获取显示在快速修复窗口的文本的函数。值可取函数
名、函数引用或匿名函数。参见
quickfix-window-function 解释如何写此函数并
给出示例。
title 快速修复列表标题。见 quickfix-title
忽略 {what} 中不支持的项目。
如果不给出 "nr"，修改当前快速修复列表。要创建新的快速修复列
表，"nr" 可设为比快速修复栈大小大一的值。
在修改快速修复列表时，要保证修改的是正确的列表，应用 "id" 而不
是 "nr" 来指定列表。
示例 (另见 setqflist-examples ):
:call setqflist([], 'r', {'title': 'My search'})
:call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
:call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
返回零代表成功，-1 代表失败。
该函数用来独立于 'errorformat' 的设置建立快速修复列表。
`:cc 1` 这样的命令可以跳转到第一个位置上。
也可用作 method ，基是作为第二个参数传递的:
GetErrorlist()->setqflist()
返回类型: Number
setreg({regname}, {value} [, {options}]) setreg()
设置寄存器 {regname} 的值为 {value}。
如果 {regname} 为 "" 或 "@"，使用无名寄存器 '"'。
{regname} 参数为字符串。 Vim9-script 中 {regname} 必须为单个
字符。
{value} 可以是 getreg() 或 getreginfo() 返回的任何类型，包
括 List 或 Dict 。
如果 {options} 包含 "a" 或者 {regname} 为大写，该值被附加于现
有值之后。
{options} 还可以指定寄存器新类型的规格:
"c" 或 "v" characterwise (面向字符) 模式
"l" 或 "V" linewise (面向行) 模式
"b" 或 "<CTRL-V>" blockwise-visual (面向列块) 模式
如果 "b" 或 "<CTRL-V>" 之后紧跟数值，那么该数值用作选择的宽度
- 如果没有指定，那么列块的宽度设为最长的行字符数 (把 <Tab>
看作一个字符)。
如果 {options} 没有寄存器设置，那么字符串值 {value} 缺省使用面
向字符模式，除非 {value} 以 <NL> 结尾，列表值的 {value} 缺省使
用面向行模式。不会自动选择面向列块模式。
返回零代表成功，非零代表失败。
E883
备注: 设置搜索和表达式寄存器时，不可使用多于一个项目的
List 。无项目的列表相当于空串。
示例:
:call setreg(v:register, @*)
:call setreg('*', @%, 'ac')
:call setreg('a', "1\n2\n3", 'b5')
:call setreg('"', { 'points_to': 'a'})
:let var_a = getreginfo()
:call setreg('a', var_a)
或:
:let var_a = getreg('a'， 1)
:let var_amode = getregtype('a')
....
:call setreg('a', var_a, var_amode)
备注: 如果不提供 getreg() 的第三个参数，就不能可靠地恢复寄存
器值，因为此时，换行符和 Nul 字节都用换行符表示，见
NL-used-for-Nul )。
你可以通过附加空串来改变寄存器的类型:
:call setreg('a', '', 'al')
GetText()->setreg('a')
返回类型: Number
settabvar({tabnr}, {varname}, {val}) settabvar()
设置标签页 {tabnr} 的标签页局部变量 {varname} 的值为 {val}。
t:var
{varname} 参数是字符串。
注意 自动命令是阻塞的，可能不会触发副作用，比如设置 'filetype'
的时候。
注意 必须使用不带 "t:" 的名字。
标签页的编号从一开始。
该命令在沙盘里不可用 sandbox 。
也可用作 method ，基是作为第三个参数传递的:
GetValue()->settabvar(tab, name)
返回类型: Number
settabwinvar({tabnr}, {winnr}, {varname}, {val}) settabwinvar()
设置窗口 {nr} 的选项或局部变量 {varname} 的值为 {val}。
标签页的编号从一开始。 setwinvar() 总是使用当前标签页。
{winnr} 可以是窗口号或 window-ID 。
如果 {winnr} 为零，使用当前窗口。
注意 自动命令是阻塞的，可能不会触发副作用，比如设置 'filetype'
或 'syntax' 的时候。
也可用于全局或者局部于缓冲区的选项，但不能用于全局或者局部于缓
冲区的变量。
如果设置局部于缓冲区的选项，全局值不会改变。
注意 必须使用不带 "w:" 的变量名。
示例:
:call settabwinvar(1, 1, "&list", 0)
:call settabwinvar(3, 2, "myvar", "foobar")
该命令在沙盘里不可用 sandbox 。
也可用作 method ，基是作为第四个参数传递的:
GetValue()->settabwinvar(tab, winnr, name)
返回类型: Number
settagstack({nr}, {dict} [, {action}]) settagstack()
用 {dict} 修改窗口 {nr} 标签栈。
{nr} 可以是窗口号或 window-ID 。
要查阅 {dict} 支持项的列表，可参考 gettagstack() 。
"curidx" 在标签栈修改之前生效。
E962
标签栈如何修改取决于 {action} 参数:
- 如果 {action} 没给出或是 'r'，标签栈被替换。
- 如果 {action} 是 'a'，则 {dict} 中的新项被压进标签栈里。
- 如果 {action} 是 't'，删除标签栈的当前项或 {dict} 中的
"curidx" 项里面的所有项目，然后把新项压进标签栈里。
当前索引设为修改之后的标签栈的长度之后的那项。
成功时返回零，失败则返回 -1。
示例 (更多示例可见 tag-stack-examples ):
清空窗口 3 的标签栈:
call settagstack(3, {'items' : []})
let stack = gettagstack(1003)
" do something else
call settagstack(1003, stack)
unlet stack
也可用作 method ，基是作为第二个参数传递的:
GetStack()->settagstack(winnr)
返回类型: Number
setwinvar({winnr}, {varname}, {val}) setwinvar()
类似于 settabwinvar() ，只用当前标签页。
示例:
:call setwinvar(1, "&list", 0)
:call setwinvar(2, "myvar", "foobar")
GetValue()->setwinvar(winnr, name)
返回类型: Number
sha256({expr}) sha256()
返回 64 位十六进制字符串，即 {expr} 的 SHA256 校验码。
{expr} 可以是字符串或 blob。
也可用作 method :
GetText()->sha256()
GetBlob()->sha256()
返回类型: String
{仅当编译时加入 +cryptv 特性才有效}
shellescape({string} [, {special}]) shellescape()
转义 {string} 以便用作外壳命令的参数。
如果 'shell' 包含 powershell (MS-Windows) 或 pwsh
(MS-Windows、Linux 和 macOS)，用单引号包围 {string}，并给内部
的单引号加倍。
在 MS-Windows 上，如果未设定 'shellslash'，用双引号包围
{string}，并给 {string} 内的双引号加倍。
否则，用单引号包围，并把所有的 "'" 替换为 "'\''"。
{special} 参数为 Vim 命令中使用的关键字进行额外转义。当它给出
且不是零值或空串时 ( non-zero-arg )，特殊项目如 "!"、"%"、"#"
和 "<cword>" 等 ( expand() 列出) 会在前面加上反斜杠。
:! 命令会再把此反斜杠删除。
如果 'shell' 以 "csh" 结尾，"!" 字符会被转义 (仍是当 {special}
为 non-zero-arg 时)。这是因为 csh 和 tcsh 即使在单引号内仍然
使用 "!" 用于历史替换。
如果 {special} 为 non-zero-arg ，<NL> 也被转义。'shell' 以
"csh" 结尾时，转义两次。
'shell' 以 "fish" 结尾时，"\" 字符被转义。这是因为 fish 把 "\"
作为单引号内的转义字符。
:! 命令的示例:
:exe '!dir ' .. shellescape(expand('<cfile>'), 1)
返回光标所在文件给出的目录列表。 system() 的示例:
:call system("chmod +w -- " .. shellescape(expand("%")))
另见 ::S 。
也可用作 method :
GetCommand()->shellescape()
返回类型: String
shiftwidth([{col}]) shiftwidth()
返回 'shiftwidth' 的有效值。即 'shiftwidth' 值，除非其为零时则
返回 'tabstop' 的值。此函数是 2012 年 7.3.694 补丁版本引入的，
现在应该大家都有了 (不过可选的 {col} 参数是 8.1.542 以后才有
的)。
给出一个参数 {col} 时，指定列号，返回它所用的 'shiftwidth'
值。这和 'vartabstop' 特性有关。如果打开 'vartabstop' 设置没有
给出 {col}，假定为列 1。
也可用作 method :
GetColumn()->shiftwidth()
返回类型: Number
showdefinition({string} [, {options}]) showdefinition()
打开 macOS 弹出窗口使用 macOS 内建的查找功能来显示 {string} 的
定义。查找的行为取决于文本的上下文。通常是 Siri 知识库文章的字
典字义。如果是 URL，会显示网页的预览；如果是地址，会显示地图。
相当于 Ctrl-Cmd-D 或触控板来查找鼠标下的数据。
弹出的位置在光标处。可传递 {options} 覆盖，这是包含两个成员的
Dict: "row" 和 "col"，代表弹出显示所在的屏幕行和列。也可直接传
递 screenpos() 的返回值给 {options}。
也可用作 method :
GetText()->showdefinition()
{仅适用于 MacVim GUI}
sign_ 函数文档在这里: sign-functions-details 。
simplify({filename}) simplify()
在不改变含义的前提下，尽可能简化文件名。快捷方式 (MS-Windows
上) 或者符号链接 (Unix 上) 不会被解析。如果 {filename} 第一个
路径部分指定了当前目录，结果也会是如此。而结尾的路径分隔符也不
会被删除。在 Unix 上 "//path" 不作改动，但 "///path" 被简化为
"/path" (这符合 posix 规范)。
示例:
simplify("./dir/.././/file/") == "./file/"
注意: 组合 "dir/.." 只有在 "dir" 是可以遍历的或者不存在的目录
才会被删掉。Unix 上，如果 "dir" 是同一目录下的符号链接，也会删
除该组合。为了在简化路径名之前解析所有牵涉到的符号链接，使用
resolve() 。
也可用作 method :
GetName()->simplify()
返回类型: String
sin({expr}) sin()
返回以弧度测量的 {expr} 的正弦值，类型为 Float 。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
:echo sin(100)
-0.506366
:echo sin(-4.01)
0.763301
也可用作 method :
Compute()->sin()
返回类型: Float
sinh({expr}) sinh()
返回 {expr} 的双曲正弦值，类型为 Float ，范围在 [-inf, inf]
之间。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
:echo sinh(0.5)
0.521095
:echo sinh(-0.9)
-1.026517
也可用作 method :
Compute()->sinh()
返回类型: Float
slice({expr}, {start} [, {end}]) slice()
类似 slice 表达式 "expr[start : end]"，但 "end" 的用法是闭
的。而且对字符串而言，索引使用的是字符索引而不是字节索引，就像
vim9script 里的处理方式一样。另外，组合字符被视为前导的基准
字符的一部分。
如果 {end} 省略，分片会继续到末项为止。
如果 {end} 为 -1，则末项会被排除。
{start} 或 {end} 非法时返回空值。
也可用作 method :
GetList()->slice(offset)
返回类型: list<{type}> 或 tuple<{type}>
sort({list} [, {how} [, {dict}]]) sort() E702
给 {list} 项目排序，原地直接修改列表。返回 {list}。
如果你不想修改列表，先构建一个备份:
:let sortedlist = sort(copy(mylist))
{how} 省略或为字符串，则 sort() 对每个项目使用字符串表示
形式进行排序。数值排在字符串之后， List 排在数值之后。要给当
前缓冲区的文本排序，用 :sort 。
如果给出 {how} 且为 'i'，忽略大小写。老式脚本里为了后向兼容，
值为一也可用于忽略大小写。零代表不忽略大小写。
如果给出 {how} 且为 'l'，排序使用当前排序规则 locale。实现细
节: 用 strcoll() 来进行字符串比较。关于如何查看或设置排序规则
locale，参见 :language 。 v:collate 也可用于检查当前
locale。按 locale 的排序通常忽略大小写。示例:
" ö 的排位顺序类似于英语 locale 的 o。
:language collate en_US.UTF8
:echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
['n', 'o', 'O', 'ö', 'p', 'z']
" ö 在瑞典 locale 里排在 z 之后。
:language collate sv_SE.UTF8
:echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
['n', 'o', 'O', 'p', 'z', 'ö']
Mac 上此功能不能正常工作。
如果给出 {how} 且为 'n'，按数值顺序排序 (实现细节: 用 strtod()
函数来解析数值。字符串、列表、字典和函数引用均视作 0)。注意 这
里不能用来排序包含数值的字符串！
如果给出 {how} 且为 'N'，按数值顺序排序。和 'n' 类似，但包含数
位的字符串会被当作数值。
如果给出 {how} 且为 'f'，按数值顺序排序。所有值的类型必须是数
值或浮点数。
如果 {how} 为 Funcref 或函数名，调用该函数来比较项目。函数调
用时使用两个项目作为参数，函数返回时，0 代表相等，1 或更高代表
第一个排在第二个之后，-1 或更小代表第一个排在第二个之前。
{dict} 用于带 "dict" 属性的函数，并设为局部变量 "self"。
Dictionary-function
排序是稳定的，相同值 (数值或字符串) 的项目保持原有的顺序不变。
例如，按数值顺序排序时，文本字符串会紧挨在一起，按原先的顺序出
现。
也可用作 method :
mylist->sort()
func MyCompare(i1, i2)
return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
endfunc
eval mylist->sort("MyCompare")
对这个简单的例子，有更简短的一个比较版本，不考虑溢出情况:
func MyCompare(i1, i2)
return a:i1 - a:i2
endfunc
简单表达式可用匿名函数:
eval mylist->sort({i1, i2 -> i1 - i2})
返回类型: list<{type}>
sound_clear() sound_clear()
停止播放所有声音。
有些 Linux 系统可能需要 libcanberra-pulse 包，否则声音不会停
止。
返回类型: Number
{仅当编译时加入 +sound 特性才有效}
sound_playevent({name} [, {callback}]) sound_playevent()
播放 {name} 定义的声音。支持的事件名取决于系统。通常使用的是
XDG 声音名。Ubuntu 上可以在
/usr/share/sounds/freedesktop/stereo 中找到。例如:
call sound_playevent('bell')
MS-Windows 上，{name} 可以是 SystemAsterisk、SystemDefault、
SystemExclamation、SystemExit、SystemHand、SystemQuestion、
SystemStart、SystemWelcome 等等。
{callback} 给出时，在声音结束后调用。首个参数是声音 ID，第二个
参数是状态:
0 声音播放到结束
1 声音被中断
2 声音启动后出错
示例:
func Callback(id, status)
echomsg "sound " .. a:id .. " finished with " .. a:status
endfunc
call sound_playevent('bell', 'Callback')
{callback}。
返回声音 ID，可传递给 sound_stop() 。
如果声音不能播放，返回零。
也可用作 method :
GetSoundName()->sound_playevent()
返回类型: Number
{仅当编译时加入 +sound 特性才有效}
sound_playfile({path} [, {callback}]) sound_playfile()
类似于 sound_playevent() 但播放声音文件 {path}。{path} 必须
是完整路径。Ubuntu 上可以用此命令找可播放的文件:
:!find /usr/share/sounds -type f | grep -v index.theme
GetSoundPath()->sound_playfile()
返回类型: Number
{仅当编译时加入 +sound 特性才有效}
sound_stop({id}) sound_stop()
停止播放声音 {id}。{id} 必须是之前 sound_playevent() 或
sound_playfile() 的返回值。
有些 Linux 系统可能需要 libcanberra-pulse 包，否则声音不会停
止。
MS-Windows 上，本函数不能用于 sound_playevent() 启动的事件声
音。要停止事件声音，用 sound_clear() 。
也可用作 method :
soundid->sound_stop()
返回类型: Number
{仅当编译时加入 +sound 特性才有效}
soundfold({word}) soundfold()
返回 {word} 按发音折叠的等价形式。使用当前窗口的 'spelllang'
中第一个支持按发音折叠的语言。'spell' 必须置位。如果不能按发音
折叠，按原样返回 {word}。
可用来提供拼写建议。注意 此方法可能很慢。
也可用作 method :
GetWord()->soundfold()
返回类型: String
spellbadword([{sentence}]) spellbadword()
没有参数: 返回光标所在或之后的拼写错误的单词。光标移动到这个坏
词的开始处。如果光标行上没有坏词，返回空字符串，不移动光标。
有参数: 返回 {sentence} 里第一个拼写错误的单词。如果没有拼写错
误，返回空字符串。
返回值是两个项目的列表:
- 错误拼写的单词，或空字符串。
- 拼写错误的类型:
"bad" 拼写错误
"rare" 偏僻词
"local" 只在其它区域里合法的单词
"caps" 单词应该大写开头
例如:
echo spellbadword("the quik brown fox")
['quik', 'bad']
使用当前窗口的拼写信息和 'spelllang' 的值。
也可用作 method :
GetText()->spellbadword()
返回类型: list<string>
spellsuggest({word} [, {max} [, {capital}]]) spellsuggest()
返回 List ，包含替代 {word} 的拼写建议。
如果给出 {max}，返回的建议不超过此数目。否则，返回不超过 25 个
建议。
如果给出 {capital} 参数且非零，只给出大写开头的拼写建议。
'spellcapcheck' 匹配后再使用此功能。
{word} 可以是后跟其它文本的错误拼写单词。这样可以对两个被分开
的单词进行连接。建议里也包含附加文本，以便你替换整行。
{word} 也可以是个好词。返回和它类似的单词。建议里不包含 {word}
自身，但可能会出现其大写开头的形式。
使用当前窗口的拼写信息、 'spelllang' 和 'spellsuggest' 的值。
也可用作 method :
GetWord()->spellsuggest()
返回类型: list<string> 或 list<any>
split({string} [, {pattern} [, {keepempty}]]) split()
从 {string} 构造 List 。
如果 {pattern} 省略或为空，用每个空白分隔的字符序列构造一个项
目。
否则，在匹配 {pattern} 的地方分割字符串，删除匹配部分的字符。
'ignorecase' 此处不适用，要忽略大小写，加上 \c。 /\c
如果列表的首末项目为空，省略它们，除非 {keepempty} 参数给出且
非零。其它空项目在 {pattern} 匹配至少一个字符或者 {keepempty}
非零的时候被保留。
例如:
:let words = split(getline('.'), '\W\+')
要把字符串分割到每个字符:
:for c in split(mystring, '\zs')
如果你想保留分隔符，可以在模式尾部用 '\zs':
:echo split('abc:def:ghi', ':\zs')
['abc:', 'def:', 'ghi']
分割首项可能为空的表格:
:let items = split(line, ':', 1)
逆函数是 join() 。
也可用作 method :
GetString()->split()
返回类型: list<string>
sqrt({expr}) sqrt()
返回 Float ，即 {expr} 的非负平方根。
{expr} 的计算结果必须是 Float 或 Number ，否则返回 0.0。
如果 {expr} 为负，返回 NaN (Not a Number，非数)。
示例:
:echo sqrt(100)
10.0
:echo sqrt(-4.01)
nan
"nan" 可能不同，取决于系统库。
也可用作 method :
Compute()->sqrt()
返回类型: Float
srand([{expr}]) srand()
初始化 rand() 用的种子:
- 如果没给出 {expr}，如果可以，读取 /dev/urandom 并用作种子，
否则，用 time(NULL) 也就是 epoch 时间；后者只有秒级精确度。
- {expr} 给出时必须是数值。用于初始种子值。可用于测试或需要可
预测序列的场合。
示例:
:let seed = srand()
:let seed = srand(userinput)
:echo rand(seed)
返回类型: list<number>
state([{what}]) state()
返回字符串，包含指示当前状态的字符。主要用于要做一些可能不总是
安全的操作的回调。大致上，做的事是:
- 回调使用 state() 检查工作是否安全。
是: 马上开始做。
否: 加入工作队列，新增 SafeState 和/或 SafeStateAgain
自动命令 ( SafeState 在顶层触发， SafeStateAgain 在处
理完信息和回调后触发)。
- SafeState 或 SafeStateAgain 触发时执行你的自动命令，检查
state() 看看工作现在是否可以了，如果是的话从队列中删除之并
执行，如果队列为空也删除自动命令。
另见 mode() 。
{what} 给出时只加入此字符串中的字符。例如，下例检查屏幕是否有
滚动:
if state('s') == ''
" 屏幕还未滚动
这些字符指示状态，一般而言指示有东西在忙:
m 映射、 :normal 命令、 feedkeys() 或庞大的命令进行到
中途时
o 操作符等待状态，如 d 之后
a 插入模式自动补全激活时
x 执行自动命令时
w 处于阻塞等待时，如 ch_evalexpr() 、 ch_read() 或
ch_readraw() 读入 json 时
S 不触发 SafeState 或 SafeStateAgain，如 f 或计数之后
c 调用了包括定时器在内的回调 (递归时会重复，多至 "ccc")
s 屏幕已经为消息滚动过
返回类型: String
str2blob({list} [, {options}]) str2blob()
返回 blob，把字符串列表 {list} 里的字符转换为字节序列。
每个列表项目后，在 blob 里加入 <NL> 字节。而字符串里的换行符在
blob 里转换为 <NUL> 字节。
{options} 如不提供，使用当前 'encoding' 值把字符转换为字节。
参数 {options} 是 Dict ，支持以下项目:
encoding 构造 blob 前用此编码进行字符转换。
值为 String 。支持的值见 encoding-names 。
如果字符编码失败，报错且返回空 blob。
{list} 为空时返回空 blob。
另见 blob2str()
示例:
str2blob(["ab"]) 返回 0z6162
str2blob(["«»"]) 返回 0zC2ABC2BB
str2blob(["a\nb"]) 返回 0z610062
str2blob(["a","b"]) 返回 0z610A62
str2blob(["«»"], {'encoding': 'latin1'}) 返回 0zABBB
str2blob(readfile('myfile.txt'))
也可用作 method :
GetListOfStrings()->str2blob()
返回类型: Blob
str2float({string} [, {quoted}]) str2float()
把字符串 {string} 转换为浮点数。这和使用浮点数的工作方式一样，
见 floating-point-format ，但稍稍宽松一点。例如，接受
"1e40"，而表达式中你必须书写 "1.0e40"。也接受十六进制形式
"0x123"，但其它的如二进制或八进制不行。
如果 {quoted} 存在且非零，忽略小数点之前的内嵌单引号，也就是
"1'000.0" 等于一千。
安静地忽略数值之后的文本。
小数点必须是 '.'，和当前的 locale 无关。逗号会使数值转换结束:
"12,345.67" 转换为 12.0。用 substitute() 可以拿掉千分位分
隔符:
let f = str2float(substitute(text, ',', '', 'g'))
如果转换失败，返回 0.0。
也可用作 method :
let f = text->substitute(',', '', 'g')->str2float()
返回类型: Float
str2list({string} [, {utf8}]) str2list()
返回包含代表字符串 {string} 中的每个字符数值的列表。例如:
str2list(" ") 返回 [32]
str2list("ABC") 返回 [65, 66, 67]
list2str() 是其逆操作。
{utf8} 省略或为零时，使用当前 'encoding'。
{utf8} 为 TRUE 时，总是把字符串当作 UTF-8 字符。
使用 UTF-8 时，组合字符正常工作:
str2list("á") 返回 [97, 769]
GetString()->str2list()
返回类型: list<number>
str2nr({string} [, {base} [, {quoted}]]) str2nr()
把字符串 {string} 转化为数值。
{base} 是转换的基底，可以为 2、8、10 或 16。
给出 {quoted} 且非零时，忽略内嵌的单引号，所以 "1'000'000" 是
一百万。
如果省略 {base}，使用基底 10。这也意味着开头的零不会导致八进制
的转换，缺省的字符串到数值的转化并非如此。例如:
let nr = str2nr('0123')
如果 {base} 为 16，忽略开头的 "0x" 或 "0X"。如果使用别的基底，
返回零。类似的，如果 {base} 为 8，忽略开头的 "0"、"0o" 或
"0O"，如果 {base} 为 2，忽略开头的 "0b" 或 "0B"。
安静地忽略数值之后的文本。
如果 {string} 为空或出错，返回 0。
也可用作 method :
GetText()->str2nr()
返回类型: Number
strcharlen({string}) strcharlen()
返回数值，给出字符串 {string} 中的字符数。忽略组合字符。
strchars() 可计算组合字符分别计算的字符数目。
如果 {string} 为空或出错，返回 0。
另见 strlen() 、 strdisplaywidth() 和 strwidth() 。
也可用作 method :
GetText()->strcharlen()
返回类型: Number
strcharpart({src}, {start} [, {len} [, {skipcc}]]) strcharpart()
和 strpart() 类似，但用字符索引和长度而不是字节索引和长度。
{skipcc} 省略或为零时，组合字符也算一个字符。
{skipcc} 设为 1 时，组合字符被视作前导的基准字符的一部分，这和
slice() 类似。
使用字符索引时如果字符不存在，返回值里忽略之但算作一个字符。例
如:
strcharpart('abc', -1, 2)
返回 'a'。
出错时返回空串。
也可用作 method :
GetText()->strcharpart(5)
返回类型: String
strchars({string} [, {skipcc}]) strchars()
返回数值，给出字符串 {string} 中的字符数。
{skipcc} 省略或为零时，组合字符也算一个字符。
{skipcc} 设为 1 时，计算时忽略组合字符。
strcharlen() 的行为总是如此。
出错时返回零。
另见 strlen() 、 strdisplaywidth() 和 strwidth() 。
{skipcc} 只在 7.4.755 之后才出现。为了后向兼容，可以这样定义
包装函数:
if has("patch-7.4.755")
function s:strchars(str, skipcc)
return strchars(a:str, a:skipcc)
endfunction
else
function s:strchars(str, skipcc)
if a:skipcc
return strlen(substitute(a:str, ".", "x", "g"))
else
return strchars(a:str)
endif
endfunction
endif
也可用作 method :
GetText()->strchars()
返回类型: Number
strdisplaywidth({string} [, {col}]) strdisplaywidth()
返回数值，给出字符串 {string} 在 {col} 开始时在屏幕上占据的显
示单元的数目 (首列为零)。{col} 省略时假定为零。否则给出开始计
算的屏幕列号。该值对制表符的计算有影响。
使用当前窗口的选项设置。其中影响显示的选项也对返回值有影响，如
'tabstop' 和 'display'。
{string} 如包含东亚二义性宽度字符类，'ambiwidth' 也会影响返回
结果。
出错时返回零。
另见 strlen() 、 strwidth() 和 strchars() 。
也可用作 method :
GetText()->strdisplaywidth()
返回类型: Number
strftime({format} [, {time}]) strftime()
返回字符串，即经过 {format} 字符串的格式转换的日期和时间。使用
给定的 {time}，如果没有给出时间，使用当前时间。可以接受的
{format} 取决于你的系统。这意味着该函数不是可移植的！
可用的格式参见 C 函数 strftime() 的参考手册。返回结果的最大长
度是 80 个字符。另见 localtime() 、 getftime() 和
strptime() 。
可以用 :language 命令改变语言。
示例:
:echo strftime("%c") Sun Apr 27 11:49:23 1997
:echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
:echo strftime("%y%m%d %T") 970427 11:53:55
:echo strftime("%H:%M") 11:55
:echo strftime("%c", getftime("file.c"))
显示 file.c 的修改时间。
并非所有系统都可以用。要检查这一点，用:
:if exists("*strftime")
GetFormat()->strftime()
返回类型: String
strgetchar({str}, {index}) strgetchar()
获取 {str} 中的第 {index} 个字符对应的数值。使用以零为基底的字
符索引而不是字节索引。这里，组合字符当作单独的字符。
nr2char() 可用来把数值转换为字符串。
{index} 非法时返回 -1。
另见 strcharpart() 和 strchars() 。
也可用作 method :
GetText()->strgetchar(5)
返回类型: Number
stridx({haystack}, {needle} [, {start}]) stridx()
返回数值，给出字符串 {haystack} 里第一个字符串 {needle} 出现的
字节位置。
如果给出 {start}，搜索从 {start} 位置开始。可用来寻找第二个匹
配:
:let colon1 = stridx(line, ":")
:let colon2 = stridx(line, ":", colon1 + 1)
搜索对大小写敏感。
模式搜索可用 match() 。
如果 {needle} 不出现在 {haystack} 里，返回 -1。
另见 strridx() 。示例:
:echo stridx("An Example", "Example") 3
:echo stridx("Starting point", "Start") 0
:echo stridx("Starting point", "start") -1
strstr() strchr()
stridx() 和 C 函数 strstr() 类似。如果使用单个字符，和
strchr() 类似。
也可用作 method :
GetHaystack()->stridx(needle)
返回类型: Number
string({expr}) string()
返回 {expr} 转换后的字符串。如果 {expr} 为数值、浮点数、字符
串、blob 或它们的复合形式，那么用 eval() 可以把结果转回去。
{expr} 类型 返回值
字符串 'string' (单引号加倍)
数值 123
浮点数 123.123456 或 1.23456e8
函数引用 function('name')
blob 0z00112233.44556677.8899
列表 [item, item]
元组 (item, item)
字典 {key: value, key: value}
类 class SomeName
对象 object of SomeName {lnum: 1, col: 3}
枚举 enum Enumname
枚举值 enum name.value {name: str,
ordinal: nr}
List 、 Tuple 或 Dictionary 中如有递归引用，被替换为
"[...]"、"(...)" 或 "{...}"。在此结果上运行 eval() 会出错。
对对象而言，调用 string() 方法以得到对象的文本表示。如果此方法
不存在，使用缺省表示。 object-string()
也可用作 method :
mylist->string()
{string}) strlen()
返回数值，即字符串 {string} 的字节长度。
如果参数为数值，先把它转化为字符串。
其它类型报错并返回零。
要计算多字节字符的数目，可用 strchars() 。
另见 len() 、 strdisplaywidth() 和 strwidth() 。
也可用作 method :
GetString()->strlen()
返回类型: Number
strpart({src}, {start} [, {len} [, {chars}]]) strpart()
返回字符串，{src} 从第 {start} 个字节开始字节长度为 {len} 的子
串。
{chars} 存在且为 TRUE 时，{len} 为字符位置的个数 (组合字符不单
独统计，因此 "1" 代表一个基本字符并可后跟任意的组合字符)。
要以字符而不是字节计算 {start}，用 strcharpart() 。
如果选择不存在的字节，不会产生错误。只是那些字节被忽略而已。
如果没有提供 {len}，子串从 {start} 开始直到 {src} 的结尾。
strpart("abcdefg", 3, 2) == "de"
strpart("abcdefg", -2, 4) == "ab"
strpart("abcdefg", 5, 4) == "fg"
strpart("abcdefg", 3) == "defg"
注意: 要得到第一个字符，{start} 必须是零。比如，要得到光标所在
的字符:
strpart(getline("."), col(".") - 1, 1, v:true)
出错时返回空串。
也可用作 method :
GetText()->strpart(5)
返回类型: String
strptime({format}, {timestring}) strptime()
返回数值，代表期待能匹配 {format} 指定格式的 {timestring} 中的
日期和时间的 unix 时间戳。
可接受的 {format} 取决于系统，所以不可移植！具体格式见 C 函数
strptime() 的手册页。特别要注意避免 "%c"。$TZ 的值也相关。
如果 {timestring} 不能用 {format} 格式解析，返回零。如果不知道
{timestring} 的格式，可以尝试不同的 {format} 值直到返回非零值
为止。
另见 strftime() 。
示例:
:echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
862156163
:echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
Sun Apr 27 11:53:55 1997
:echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
Sun Apr 27 12:53:55 1997
也可用作 method :
GetFormat()->strptime(timestring)
不是在所有系统都可用。要确认:
:if exists("*strptime")
返回类型: Number
strridx({haystack}, {needle} [, {start}]) strridx()
返回数值，给出字符串 {haystack} 里最后一个字符串 {needle} 出现
的字节位置。
如果给出 {start}，此位置之外的匹配被忽略。可用来寻找上次匹配之
前的匹配:
:let lastcomma = strridx(line, ",")
:let comma2 = strridx(line, ",", lastcomma - 1)
搜索对大小写敏感。
模式搜索可用 match() 。
如果 {needle} 不出现在 {haystack} 里，返回 -1。
如果 {needle} 为空，返回 {haystack} 的长度。
另见 stridx() 。示例:
:echo strridx("an angry armadillo", "an") 3
strrchr()
如果使用单个字符，和 C 函数 strrchr() 类似。
也可用作 method :
GetHaystack()->strridx(needle)
返回类型: Number
strtrans({string}) strtrans()
返回等于 {string} 的字符串，但所有的不可显示字符被翻译成可显示
的字符序列 'isprint'，类似于窗口里显示的形式。例如:
echo strtrans(@a)
会显示寄存器里的换行符为 "^@" 而不是开启新行。
出错时返回空串。
也可用作 method :
GetString()->strtrans()
返回类型: String
strutf16len({string} [, {countcc}]) strutf16len()
返回数值，给出字符串 {string} (转换为 utf-16 后) utf-16 代码单
元数。
{countcc} 为真时，组合字符单独计算。
{countcc} 忽略或为假时，忽略组合字符。
出错时返回零。
另见 strlen() 和 strcharlen() 。
示例:
echo strutf16len('a') 返回 1
echo strutf16len('©') 返回 1
echo strutf16len('😊') 返回 2
echo strutf16len('ą́') 返回 1
echo strutf16len('ą́', v:true) 返回 3
也可用作 method :
gettext()->strutf16len()
返回类型: Number
strwidth({string}) strwidth()
返回数值，给出字符串 {string} 在屏幕上占据的显示单元的数目。制
表符算作一个单元。如果不想这样，可用 strdisplaywidth() 。
{string} 如包含东亚二义性宽度字符类，'ambiwidth' 也会影响返回
结果。
出错时返回零。
另见 strlen() 、 strdisplaywidth() 和 strchars() 。
也可用作 method :
GetString()->strwidth()
返回类型: Number
submatch({nr} [, {list}]) submatch() E935
只用于 :substitute 命令或 substitute() 函数中的表达式内。
返回匹配文本的第 {nr} 个子匹配。{nr} 为 0 则返回整个匹配的文
本。
注意 字符串中的 NL 既可以代表多行匹配的行尾，也可以是文件中的
NUL 字符。
另见 sub-replace-expression 。
如果给出 {list} 且非零，submatch() 返回字符串的列表，和带两个
参数的 getline() 类似。文本中的 NL 代表文件中的 NUL 字符。
只在 :substitute 中可能返回多于一个项目， substitute() 中此
列表总是包含一个或零个项目，因为没有真正的行尾。
递归使用 substitute() 时，只能得到当前 (最深的) 调用的子匹
配。
出错时返回空字符串或空列表。
例如:
:s/\d\+/\=submatch(0) + 1/
:echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
找到行内第一个数值并加 1。
使用 <NL> 可以包含换行符。
也可用作 method :
GetNr()->submatch()
返回类型: String 或 list<string>，取决于 {list}
substitute({string}, {pat}, {sub}, {flags}) substitute()
返回相当于 {string} 的字符串，但其中 {pat} 的首个匹配被替代成
{sub}。
如果 {flags} 为 "g"，替换 {string} 里的所有 {pat} 匹配。否则，
{flags} 应该为 ""。
和 ":substitute" 命令 (不带任何标志位) 类似。但此处 {pat} 的匹
配总假定 'magic' 选项已置位且 'cpoptions' 为空 (为了脚本的可移
植性)。
'ignorecase' 仍然适用， /\c 或 /\C 可用来直接指定是否忽略或
匹配大小写并忽略 'ignorecase' 的设置。
'smartcase' 此处不适用。
string-match 说明如何使用 {pat}。
{sub} 里的 '~' 不会被换成前一个 {sub}。
注意 {sub} 里的一些代码有特殊含义 sub-replace-special 。比
如，要替换若干文本为 "\n" (两个字符)，要用 "\\\\n" 或 '\\n'。
如果 {pat} 在 {string} 里不能匹配，返回没有修改的 {string}。
示例:
:let &path = substitute(&path, ",\\=[^,]*$", "", "")
删除 'path' 选项的最后一部分。
:echo substitute("testing", ".*", "\\U\\0", "")
返回 "TESTING"。
{sub} 参数以 \= 开始时，其余部分视为一个表达式，见
sub-replace-expression 。示例:
:echo substitute(s, '%\(\x\x\)',
\ '\=nr2char("0x" .. submatch(1))', 'g')
{sub} 若是函数引用，调用该函数，带一个可选参数。示例:
:echo substitute(s, '%\(\x\x\)', SubNr, 'g')
可选参数是包含完整匹配及多达九个子匹配的列表，就像
submatch() 的返回值那样。示例:
:echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g')
GetString()->substitute(pat, sub, flags)
返回类型: String
swapfilelist() swapfilelist()
返回交换文件名的列表，就像 "vim -r" 显示的那样。参见 -r 命令
参数。'directory' 选项指定检视的目录。如果只想看到当前目录下的
交换文件，可临时设置 'directory' 为点号:
let save_dir = &directory
let &directory = '.'
let swapfiles = swapfilelist()
let &directory = save_dir
返回类型: list<string>
swapinfo({fname}) swapinfo()
返回字曲，保存关于交换文件 {fname} 的信息。可用的域是:
version Vim 版本
user 用户名
host 主机名
fname 原始文件名
pid 创建交换文件的 Vim 进程的 PID
mtime 以秒计的最近修改时间
inode 可选: 文件的 INODE 值
dirty 如果文件修改过为 1，否则为 0
注意 "user" 和 "host" 被缩短为最多 39 个字节。如果失败，加入
"error" 项目说明相关原因:
Cannot open file: 文件找不到或不能访问
Cannot read file: 不能读入首块
Not a swap file: 没有包含正确的块 ID
Magic number mismatch: 首块的信息不正确
也可用作 method :
GetFilename()->swapinfo()
返回类型: dict<any> 或 dict<string>
swapname({buf}) swapname()
返回缓冲区 {buf} 所用的交换文件路径。
{buf} 的使用方式见上 bufname() 。
如果缓冲区 {buf} 是当前缓冲区，结果相当于 :swapname (除非没
有交换文件)。
如果缓冲区 {buf} 无交换文件，返回空串。
也可用作 method :
GetBufname()->swapname()
返回类型: String
synID({lnum}, {col}, {trans}) synID()
返回数值，即当前窗口 {lnum} 行 {col} 列所在的语法 ID。
语法 ID 可以用在 synIDattr() 和 synIDtrans() ，以得到文本
的语法信息。
最左列的 {col} 为 1。第一行的 {lnum} 为 1。适用 'synmaxcol' 的
值，如果行比它更长，就返回零。
注意 位置在最后一个字符之后是插入模式下可能的光标位置。此时，
synID() 返回零。{lnum} 的用法见 getline() 。
如果 {trans} 为 TRUE ，透明的项目被简约为它们实际显露的项目。
这可以用于你想知道实际使用的颜色的情形。如果 {trans} 为
FALSE ，返回透明的项目本身。这可用于想知道实际有效的语法项目
的情形 (比如，在括号内部)。
警告: 本函数可能很慢。最佳速度可以通过正向遍历文件获得。
出错时返回零。
例如 (回显光标所在的语法项目的名字):
:echo synIDattr(synID(line("."), col("."), 1), "name")
返回类型: Number
synIDattr({synID}, {what} [, {mode}]) synIDattr()
返回字符串，syntax ID {synID} 的 {what} 属性。可用于得到语法项
目的相关信息。
{mode} 可以是 "gui"、"cterm" 或 "term"，从而得到的是该模式下的
属性。如果忽略 {mode} 或者指定了非法的值，使用当前激活的高亮方
式的属性 (GUI、cterm 或 term)。
使用 synIDtrans() 来跟随链接的高亮组。
{what} 结果
"name" 语法项目的名字
"fg" 前景色 (GUI: 用于设置颜色的色彩名，cterm: 色彩
号，以字符串形式出现，term: 空字符串)
"bg" 背景色 (细节同 "fg")
"font" 字体名 (只适用于 GUI) highlight-font
"sp" 用于 GUI 的特殊颜色 (细节同 "fg")
highlight-guisp
"ul" 用于 cterm 的下划线颜色: 字符串形式出现的数值
"fg#" 类似于 "fg"，但只适用于 GUI，而且 GUI 使用的名
字形如 "#RRGGBB"。
"bg#" "bg"，细节同 "fg#"
"sp#" "sp"，细节同 "fg#"
"bold" "1" 如果粗体
"italic" "1" 如果斜体
"reverse" "1" 如果反显
"inverse" "1" 如果反显 (= reverse)
"standout" "1" 如果突出
"underline" "1" 如果下划线
"undercurl" "1" 如果下曲线
"strike" "1" 如果删除线
"nocombine" "1" 如果指定了 nocombine
出错时返回空串。
示例 (回显光标所在的语法项目的颜色):
:echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
也可用作 method :
:echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
返回类型: String
synIDtrans({synID}) synIDtrans()
返回数值，即 {synID} 经过翻译的语法 ID。这是用于高亮字符的语法
组的 ID。":highlight link" 给出的高亮组被跟随，以找到实际使用
的组。
出错时返回零。
也可用作 method :
:echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
返回类型: Number
synconcealed({lnum}, {col}) synconcealed()
返回 List ，目前包含三个值:
1. 如果 {lnum} 和 {col} 所在位置的字符不在可隐藏区域，列表的第
一个项目为 0，否则为 1。{lnum} 的用法可见 getline() 。
2. 列表的第二个项目为字符串。如果第一个值为 1，第二个值包含代
替被隐藏文本实际显示的文本，视乎 'conceallevel' 和
'listchars' 的当前值而定。
3. 列表的第三个，也即最后一个项目是代表匹配的特定语法区域的唯
一的数值。这用于在有两个连续的使用相同替代字符的区域时，检
测此处是否是一个新的可隐藏区域的开始。例如，如果文本是
"123456"，"23" 和 "45" 都被隐藏，而替代字符是 "X"，则:
call returns
synconcealed(lnum, 1) [0, '', 0]
synconcealed(lnum, 2) [1, 'X', 1]
synconcealed(lnum, 3) [1, 'X', 1]
synconcealed(lnum, 4) [1, 'X', 2]
synconcealed(lnum, 5) [1, 'X', 2]
synconcealed(lnum, 6) [0, '', 0]
注意: 不考虑 matchadd() 高亮项目，因为语法和匹配高亮是两种不
同的机制 syntax-vs-match 。
返回类型: list<any>
synstack({lnum}, {col}) synstack()
返回 List ，即当前窗口在 {lnum} 行 {col} 列语法项目的堆栈。
{lnum} 的用法可见 getline() 。列表的每个项目是像 synID() 返
回那样的 ID。
列表的第一个项目是最外层区域，其后依次是包含在内的项目。末项即
synID() 返回的项目，除非不是整个项目都被高亮，或者它是一个透
明项目。
此函数可用于调试语法文件。
显示光标所在的语法项目栈的示例:
for id in synstack(line("."), col("."))
echo synIDattr(id, "name")
endfor
{lnum} 和 {col} 指定的位置非法时，返回空列表。行末字符之后的位
置以及空行的第一个位置是合法的位置。
返回类型: list<number> 或 list<any>
system({expr} [, {input}]) system() E677
得到外壳命令 {expr} String 形式的输出结果。要得到 List 形
式的输出结果，见 systemlist() 。
如果给出 {input} 且为 String ，该字符串被写到文件里，并传给外
壳命令作为标准输入。字符串照原样写入，你需要自己注意使用合适的
换行符。
如果给出 {input} 且为 List ，它被写到文件里，就像
writefile() 带 {binary} 设为 "b" 的工作方式那样 (即，列表项
目间写入换行符，列表项目内部的换行符改写为 NUL)。
如果给出 {input} 且为数值，代表已存在的缓冲区的合法缓冲区号，
逐行将该缓冲区的内容写入文件，每行以 NL 结尾，文本内的 NL 以
NUL 字符代替。
不使用管道，也不使用 'shelltemp' 选项。
如果加上前缀 :silent ，终端不设为加工 (cooked) 模式。这用于不
需要用户输入的命令，以避免屏幕上显示多余的字符而需要用
CTRL-L 来清除。
:silent let f = system('ls *.vim')
注意: shellescape() 或 expand() 的 ::S 或
fnamemodify() 可以转义命令参数里的特殊字符。{expr} 里的换行
可能会使命令失败。'shellquote' 和 'shellxquote' 里的字符也可能
会引起麻烦。
这不是用来执行交互命令的。
返回字符串。示例:
:let files = system('ls ' .. shellescape(expand('%:h')))
:let files = system('ls ' .. expand('%:h:S'))
<CR> 被换成 <NL>，而 DOS 系列的系统上 <CR><NL> 也被换成 <NL>。
为了避免字符串在 NUL 处被截断，所有的 NUL 的字符被替换为 SOH
(0x01)。
使用若干选项，以下面的方法构造要执行的命令:
'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
({tmp} 是自动生成的一个文件名)。
Unix 上，{expr} 用大括号包围，以便支持连接的多条命令。
以加工 ("cooked") 模式执行命令，这样 CTRL-C 可以用来中止命令
(至少在 Unix 上是如此)。
返回的错误代码可以在 v:shell_error 里找到。
该函数不能运行于 restricted-mode 。
注意 上面提到的选项值如有错误，该函数就会失败。使用若干安全代
理应用时也有报告说它会失败。
不同于 ":!cmd"，没有自动对改变过的文件的检查。使用
:checktime 来强制这种检查。
也可用作 method :
:echo GetCmd()->system()
返回类型: String
systemlist({expr} [, {input}]) systemlist()
和 system() 相同，但返回由行组成的 List (以 NL 分隔的输出
各部分)，NUL 转换为 NL。输出的工作方式和 readfile() 带
{binary} 参数设为 "b" 相同，除了结果以 NL 结尾时不会有额外的空
项目以外。
注意 MS-Windows 上可能会有拖尾的 CR 字符。
要看到 "echo hello" 和 "echo -n hello" 的区别，参见 system()
和 split() :
echo system('echo hello')->split('\n', 1)
有错时，返回空串。
也可用作 method :
:echo GetCmd()->systemlist()
返回类型: list<string>
tabpagebuflist([{arg}]) tabpagebuflist()
返回 List ，每个项目是当前标签页里每个窗口相关联的缓冲区的编
号。
{arg} 指定使用的标签页的编号。如果省略，使用当前标签页。
{arg} 非法时返回数值零。
要得到所有标签页里的所有缓冲区的列表，这样用:
let buflist = []
for i in range(tabpagenr('$'))
call extend(buflist, tabpagebuflist(i + 1))
endfor
注意 缓冲区可能出现于多于一个窗口里。
也可用作 method :
GetTabpage()->tabpagebuflist()
返回类型: list<number>
tabpagenr([{arg}]) tabpagenr()
返回数值，当前标签页号。第一个标签页的编号为 1。
可选参数 {arg} 支持以下值:
$ 最后一个标签页的编号 (即标签页总数)。
# 最近访问的标签页编号 ( g<Tab> 对应)。如果没有
前次标签页，返回 0。
该数值可用于 :tab 命令。
出错时返回零。
返回类型: Number
tabpagewinnr({tabarg} [, {arg}]) tabpagewinnr()
类似于 winnr() ，但使用标签页 {tabarg}。
{tabarg} 指定要使用的标签页号。
{arg} 的用法类似于 winnr() :
- 如果省略，返回当前窗口号，也就是转到该标签页时会使用的窗口。
- 如果是 "$"，返回窗口的总数。
- 如果是 "#"，返回上次的窗口编号。
用于的例子:
tabpagewinnr(1) " 标签页 1 的当前窗口
tabpagewinnr(4, '$') " 标签页 4 的窗口总数
{tabarg} 非法时返回零。
也可用作 method :
GetTabpage()->tabpagewinnr()
返回类型: Number
tagfiles() tagfiles()
返回 List ，当前缓冲区用于搜索的标签文件名。这是 'tags' 选项
扩展后的内容。
返回类型: list<string> 或 list<any>
taglist({expr} [, {filename}]) taglist()
返回匹配正则表达式 {expr} 的标签 List 。
如果传入 {filename}，用于像 :tselect 那样给结果排序。见
tag-priority 。{filename} 必须是文件的完整路径。
每个列表项目是一个至少包含以下项目的字典:
name 标签名。
filename 标签定义的文件名。它或者相对于当前目
录，或者包含完整路径。
cmd 用于在文件里定位标签的 Ex 命令。
kind 标签类型。该项目的值取决于特定于语言的
类型值。只在 Universal/Exuberant ctags
或 hdrtag 生成的标签文件里存在。
static 特定于文件的标签。详见 static-tag 。
可能还有一些其它项目，取决于标签文件的内容: access、
implementation、inherits 和 signature。这些字段的信息参见
ctags 文档。C 代码里可能出现字段 "struct"、"class" 和 "enum"，
它们给出标签所在的实体的名字。
ex 命令 "cmd" 可以是 ex 搜索模式、行号或者行号后跟字节位置。
如果没有匹配的标签，返回空列表。
要得到标签的准确匹配，{expr} 里必须使用 '^' 和 '$'。这也可加快
函数的工作速度。
关于标签搜索正则表达式模式的详情见 tag-regexp 。
'tags' 提供 Vim 如何定位标签文件的信息。 tags-file-format 说
明不同的 ctags 工具生成的标签文件的格式。
也可用作 method :
GetTagpattern()->taglist()
返回类型: list<dict<any>> 或 list<any>
tan({expr}) tan()
返回以弧度测量的 {expr} 的正切值，类型为 Float ，范围在
[-inf, inf] 之间。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
:echo tan(10)
0.648361
:echo tan(-4.01)
-1.181502
也可用作 method :
Compute()->tan()
返回类型: Float
tanh({expr}) tanh()
返回 {expr} 的双曲正切值，类型为 Float ，范围在 [-1, 1] 之
间。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
:echo tanh(0.5)
0.462117
:echo tanh(-1)
-0.761594
也可用作 method :
Compute()->tanh()
返回类型: Float
tempname() tempname() temp-file-name
返回字符串，它是一个不存在的文件名。可以用作临时文件。该文件在
至少 26 个接连的调用内不会重复。例如:
:let tmpfile = tempname()
:exe "redir > " .. tmpfile
Unix 上，文件会存在用户个人的目录中 tempfile ，Vim 退出时会被
递归删除，而其他系统上退出时不会自动清除临时文件。
MS-Windows 上，如果置位了 'shellslash' 选项或者 'shellcmdflag'
以 '-' 开始且 'shell' 不包含 powershell 或 pwsh 的时候，使用正
斜杠。
返回类型: String
term_ 函数文档在这里: terminal-functions-details
terminalprops() terminalprops()
返回 Vim 从 t_RV 请求得到的响应中检测到的终端属性的
Dictionary 。响应本身见 v:termresponse 。如果
v:termresponse 为空，这里的多数值会是 'u'，代表未知。
cursor_style 是否可发送 t_RS **
cursor_blink_mode 是否可发送 t_RC **
underline_rgb t_8u 是否可用 **
mouse 支持的鼠标类型
kitty 是否检测到 Kitty 终端
** 值 'u' 代表未知，'y' 代表是，'n' 代表否
如果没有 +termresponse 特性，返回空字典。
如果 "cursor_style" 是 'y'，则发送 t_RS 以请求当前光标风格。
如果 "cursor_blink_mode" 是 'y'，则发送 t_RC 以请求当前光标
闪烁状态。
如果 t_u7 非空，也会置位 "cursor_style" 和
"cursor_blink_mode"，此时 Vim 会在启动时检测 t_RS 和 t_RC
是否可发送。
如果 "underline_rgb" 不是 'y'， t_8u 会设为空。这会避免把它发
送到 xterm 以清除色彩。
"mouse" 对应的值 'u' 代表未知
另见:
- 'ambiwidth' - 由 t_u7 检测。
- v:termstyleresp 和 v:termblinkresp ，对应 t_RS 和
t_RC 的响应。
返回类型: dict<string>
test_ 函数文档在这里: test-functions-details
timer_info([{id}]) timer_info()
返回定时器信息的列表。
给出 {id} 时只返回此定时器的信息。如果定时器 {id} 不存在，返回
空列表。
省略 {id} 时，返回所有定时器的信息。
每个定时器的信息以 Dictionary 形式保存，有以下项目:
"id" 定时器号
"time" 定时器开始时间
"remaining" 定时器剩余时间
"repeat" 定时器激活的次数；-1 代表永远
"callback" 回调
"paused" 如果定时器暂停为 1，否则为 0
也可用作 method :
GetTimer()->timer_info()
返回类型: list<dict<any>> 或 list<any>
{仅当编译时加入 +timers 特性才有效}
timer_pause({timer}, {paused}) timer_pause()
暂停或恢复定时器。暂停的定时器在到期是不调用回调。如果经过足够
时间，恢复定时器会使回调几乎被立即调用。
暂停定时器可用于短期停止回调的调用。
如果 {paused} 计算为非零的数值或非空的字符串，暂停定时器，否则
恢复定时器。
见 non-zero-arg 。
也可用作 method :
GetTimer()->timer_pause(1)
返回类型: Number
{仅当编译时加入 +timers 特性才有效}
timer_start() timer timers
timer_start({time}, {callback} [, {options}])
新建定时器并返回定时器号。
{time} 是毫秒计的等待时间。指示调用回调的最短时间。系统如果繁
忙或 Vim 不在等待输入时，时间会更长。可用零值，此时回调会在
Vim 回到主循环时执行。
{callback} 是要调用的函数。可以是函数名或 Funcref 。调用时接
受一个参数，即定时器号。只有在 Vim 等待输入时才会调用回调。
如果要显示信息，看看 popup_notification() ，以避免信息显示干
扰用户的操作。
{options} 是字典。支持的项目:
"repeat" 重复调用回调的次数。-1 代表永远。无定义时，调
用回调一次。
如果定时器连续出错三次，取消重复。这避免了 Vim
因为过多的错误信息导致的不可用的情形。
出错时返回 -1。
示例:
func MyHandler(timer)
echo 'Handler called'
endfunc
let timer = timer_start(500, 'MyHandler',
\ {'repeat': 3})
这会以 500 毫秒间隔调用 MyHandle() 三次。
也可用作 method :
GetMsec()->timer_start(callback)
{仅当编译时加入 +timers 特性才有效}
timer_stop({timer}) timer_stop()
停止定时器。不再调用定时器回调。
{timer} 是 timer_start() 返回的定时器号，所以必须是数值。如
果 {timer} 不存在，不报错。
也可用作 method :
GetTimer()->timer_stop()
返回类型: Number
{仅当编译时加入 +timers 特性才有效}
timer_stopall() timer_stopall()
停止所有定时器。不再调用定时器回调。用于有定时器工作不正常的场
合。如果没有任何定时器，不报错。
返回类型: Number
{仅当编译时加入 +timers 特性才有效}
tolower({expr}) tolower()
返回给出字符串的备份，但所有的大写字符变为小写 (就如同在字符串
上应用了 gu 一样)。出错时返回空串。
也可用作 method :
GetText()->tolower()
返回类型: String
toupper({expr}) toupper()
返回给出字符串的备份，但所有的小写字符变为大写 (就如同在字符串
上应用了 gU 一样)。出错时返回空串。
也可用作 method :
GetText()->toupper()
返回类型: String
tr({src}, {fromstr}, {tostr}) tr()
返回 {src} 字符串的备份，其中 {fromstr} 里的每个字符被 {tostr}
字符串里同样的位置的字符替代。也就是，{fromstr} 的第一个字符被
翻译成 {tostr} 的第一个字符，依此类推。和 unix 命令 "tr" 完全
相同。
能正确处理多字节字符。
出错时返回空串。
例如:
echo tr("hello there", "ht", "HT")
返回 "Hello THere"
echo tr("<blob>", "<>", "{}")
返回 "{blob}"
也可用作 method :
GetText()->tr(from, to)
返回类型: String
trim({text} [, {mask} [, {dir}]]) trim()
返回 {text} 从头部和/或尾部删除 {mask} 里出现的字符后的字符
串。
如果 {mask} 没给出或为空串，{mask} 是所有直到 0x20 的字符，包
括 Tab、空格、NL 和 CR，加上不换行空格 0xa0。
可选的 {dir} 参数指定删除字符的位置:
0 从 {text} 的头部和尾部删除
1 只从 {text} 的头部删除
2 只从 {text} 的尾部删除
省略时两端都进行删除。
此函数能正确处理多字节字符。
出错时返回空串。
示例:
echo trim(" some text ")
返回 "some text"
echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL"
返回 "RESERVE_TAIL"
echo trim("rm<Xrm<>X>rrm", "rm<>")
返回 "Xrm<>X" (不删除中间部分的字符)
echo trim(" vim ", " ", 2)
返回 " vim"
也可用作 method :
GetText()->trim()
返回类型: String
trunc({expr}) trunc()
返回浮点数，即绝对值小于等于 {expr} 的最大整数 (向零取整)。
{expr} 的计算结果必须是 Float 或 Number 。否则返回 0.0。
示例:
echo trunc(1.456)
1.0
echo trunc(-5.456)
-5.0
echo trunc(4.0)
4.0
也可用作 method :
Compute()->trunc()
返回类型: Float
tuple2list({tuple}) tuple2list()
从元组项目的浅备份建立列表。示例:
tuple2list((1, 2, 3)) 返回 [1, 2, 3]
list2tuple() 是其逆操作。
此函数不会递归转换 {tuple} 里的所有元组项目为列表。注意列表和
元组的项目只有一份，所以修改项目会同时修改元组和列表里的内容。
出错时返回空列表。
也可用作 method :
GetTuple()->tuple2list()
返回类型: list<{type}> (取决于给出的 Tuple )
type({expr}) type()
返回数值，代表 {expr} 的类型。
不要直接使用此值，最好用含有此值的 v:t_ 变量:
数值: 0 v:t_number
字符串: 1 v:t_string
函数引用: 2 v:t_func
列表: 3 v:t_list
字典: 4 v:t_dict
浮点数: 5 v:t_float
布尔值: 6 v:t_bool (v:false 和 v:true)
None: 7 v:t_none (v:null 和 v:none)
作业: 8 v:t_job
通道: 9 v:t_channel
blob: 10 v:t_blob
类: 12 v:t_class
对象: 13 v:t_object
类型别名: 14 v:t_typealias
枚举: 15 v:t_enum
枚举值: 16 v:t_enumvalue
元组: 17 v:t_tuple
为了后向兼容，可以这样用此函数:
:if type(myvar) == type(0)
:if type(myvar) == type("")
:if type(myvar) == type(function("tr"))
:if type(myvar) == type([])
:if type(myvar) == type({})
:if type(myvar) == type(0.0)
:if type(myvar) == type(v:false)
:if type(myvar) == type(v:none)
要检查 v:t_ 这些变量是否存在，可用:
:if exists('v:t_number')
mylist->type()
返回类型: Number
typename({expr}) typename()
返回 {expr} 类型的字符串描述。
例如:
echo typename([1, 2, 3])
list<number>
返回类型: String
undofile({name}) undofile()
返回用于名为 {name} 的文件的撤销文件名。使用 'undodir' 选项并
寻找实际存在的目录。并不检查该撤销文件是否存在。
{name} 总是扩展为完整路径，因为内部是这么使用的。
{name} 为空时 undofile() 也返回空字符串，因为无名缓冲区不写入
任何撤销文件。
可用于 :wundo 和 :rundo 。
如果编译时没有 +persistent_undo 选项，总是返回空字符串。
也可用作 method :
GetFilename()->undofile()
返回类型: String
undotree([{buf}]) undotree()
返回当前缓冲区或 {buf} 给出时所指定的缓冲区的撤销树的当前状
态。
返回值是包含以下项目的 Dictionary :
"seq_last" 最大使用的撤销序列号。
"seq_cur" 撤销树中当前位置的序列号。如果有撤销过的改变，
和 "seq_last" 会有不同。
"time_cur" 最近用于 :earlier 和相关命令的时间。
可用 strftime() 转换成可读的格式。
"save_last" 最后的文件写入编号。如果没有写入，返回零。
"save_cur" 撤销树当前位置的编号。
"synced" 如果最后的撤销块已经同步，返回非零值。等待用户
输入时会发生。见 undo-blocks 。
"entries" 关于撤销块的信息的字典的列表。
"entries" 列表的第一个值是最老的撤销项目。每个列表项目是一个包
含以下项目的字典:
"seq" 撤销序列号。和 :undolist 显示的相同。
"time" 改变发生的时间。可用 strftime() 转换成可读的
格式。
"newhead" 只出现在最后加入的项目。标识最后的改变，并指示
将来的改变加入所在的位置。
"curhead" 只出现在最后撤销的项目。表示撤销树当前的位置，
该块可用于 redo 命令。如果最后改变之后没有撤销
动作，此项目不出现。
"save" 只出现在文件写入前最后的块。该值为写入计数。首
次写入的编号为 1，最后一次是上面提及的
"save_last"。
"alt" 替代项。这又是一个撤销块的列表。每个项目又可以
有 "alt" 项目。
返回类型: dict<any>
uniq({list} [, {func} [, {dict}]]) uniq() E882
原地删除重复相邻的 {list} 项目的第二个及之后的版本。返回
{list}。如果不想对列表进行修改，先建立一个备份:
:let newlist = uniq(copy(mylist))
缺省比较函数使用每个项目的字符串表示形式。关于 {func} 和
{dict} 的使用可见 sort() 。
要删除当前缓冲区里的重复文本，可见 :uniq 。
{list} 不是 List 时返回零。
也可用作 method :
mylist->uniq()
返回类型: list<{type}>
uri_decode({string}) uri_decode()
返回 {string} 的 URI 解码形式。逆转百分号编码 (把 "%3D" 这样的
序列还原为对应的字符)。
解码遵循如下标准的百分符解码规则:
- "%HH" 被替换为十六进制 HH 对应的字符。
- 如果解码的字节序列构成合法的 UTF-8，合并为对应的字符。否
则，保留原先的字节序列。
- 非法或不完整的编码 (如 "%GZ"、"%3" 或拖尾的 "%") 保持不
变。
{string} 为空时返回空串。
示例:
:echo uri_decode('c%3A%5Cmy%5Cdir%5Cfoo%20bar')
c:\my\dir\foo bar
:echo uri_decode('%CE%B1%CE%B2%CE%B3')
αβγ
也可用作 method :
mystr->uri_decode()
Return type: String
uri_encode({string}) uri_encode()
返回 {string} 的 URI 编码形式。URI 编码把不安全或保留的字符替
换为百分号编码的序列。
编码遵循如下标准的百分符编码规则:
- 字母数字字符 [0-9A-Za-z] 保持不变。
- "-"、"_"、"." 和 "~" 也保持不变。
- 所有其它字符被替换为 "%HH"，其中的 HH 是两位大写十六进制
数字。
- 已有的百分符编码序列不作修改。
{string} 为空时返回空串。
示例:
:echo uri_encode('c:\my\dir\foo bar')
c%3A%5Cmy%5Cdir%5Cfoo%20bar
:echo uri_encode('key=value&name=αβγ')
key%3Dvalue%26name%3D%CE%B1%CE%B2%CE%B3
也可用作 method :
mystr->uri_encode()
返回类型: String
utf16idx({string}, {idx} [, {countcc} [, {charidx}]]) utf16idx()
类似于 charidx() ，但返回 {string} {idx} 字节对应的 (转换为
UTF-16 后) UTF-16 代码单元索引。
{charidx} 给出且为 TRUE 时，{idx} 用于给出字符串 {string} 里的
字符索引而不是字节索引。
出现在 UTF-8 序列中间的 {idx} 会向下取整到该序列的开始位置。
如果参数非法或者 {string} 里少于 {idx} 个字节，返回 -1。如果正
好有 {idx} 个字节，返回整个字符串以 UTF-16 代码单元计的长度。
关于如何从 UTF-16 索引来获取字节索引，可见 byteidx() 和
byteidxcomp() ，而要从 UTF-16 索引获取字符索引，可见
charidx 。
更多详情可参见 string-offset-encoding 。
示例:
echo utf16idx('a😊😊', 3) 返回 2
echo utf16idx('a😊😊', 7) 返回 4
echo utf16idx('a😊😊', 1, 0, 1) 返回 2
echo utf16idx('a😊😊', 2, 0, 1) 返回 4
echo utf16idx('aą́c', 6) 返回 2
echo utf16idx('aą́c', 6, 1) 返回 4
echo utf16idx('a😊😊', 9) 返回 -1
也可用作 method :
GetName()->utf16idx(idx)
返回类型: Number
values({dict}) values()
返回 List ，{dict} 的所有值。 List 项目的顺序不定。另见
items() 和 keys() 。
{dict} 不是 Dict 时返回零。
也可用作 method :
mydict->values()
返回类型: list<any>
virtcol({expr} [, {list} [, {winid}]]) virtcol()
返回数值，即 {expr} 给定的文件位置的屏幕列号。也就是，直到该位
置的字符为止的行的部分所占据的屏幕单元数目。如果该位置是一个
<Tab>，返回的数值是 <Tab> 占据的最后一列。比如，如果 <Tab> 在
第 1 列，而 'ts' 设为 8 的话，返回 8。忽略 conceal() 因素。
关于字节位置，见 col() 。
{expr} 用法见 getpos() 和 col() 。
{expr} 为 "$" 时代表光标行的行尾，所以返回值是光标行的单元数加
一。
如果使用 'virtualedit'，{expr} 可以用 [lnum, col, off]，其中
"off" 是字符位置开始计算的屏幕列。例如，制表中或最后一个字符之
后的某个位置。"off" 若省略，则假定为零。如果在当前模式下使用了
虚拟编辑，也可能返回行尾之后的位置。另见 'virtualedit'
{list} 如果存在且非零，virtcol() 返回字符占据的首个和末个屏幕
位置组成的列表。
如果给出可选的 {winid} 参数，从该窗口取值而不是当前窗口。
注意 只能使用当前文件的位置标记。
示例:
" 文本 "foo^Lbar" 光标在 "^L" 上:
virtcol(".") " 返回 5
virtcol(".", 1) " 返回 [4, 5]
virtcol("$") " 返回 9
" 文本 " there"，'t 在 'h' 上:
virtcol("'t") " 返回 6
第一列为 1。返回 0 或 [0,0] 代表错误。
一个更高级的示例，显示所有行的最大长度:
echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
GetPos()->virtcol()
返回类型: Number
virtcol2col({winid}, {lnum}, {col}) virtcol2col()
返回数值，窗口 {winid} 在缓冲区行 {lnum} 和虚拟列 {col} 所在的
字符的字节索引。
如果缓冲区行 {lnum} 为空行，返回 0。
如果 {col} 大于 {lnum} 行的最后的虚拟列，返回最后虚拟列所在的
字符的字节索引。
多字节字符返回该字符首个字节的列号。
{winid} 参数可以是窗口号或 window-ID 。如果为零，使用当前窗
口。
窗口 {winid} 不存在或缓冲区行 {lnum} 或虚拟列 {col} 非法时，返
回 -1。
另见 screenpos() 、 virtcol() 和 col() 。
也可用作 method :
GetWinid()->virtcol2col(lnum, col)
返回类型: Number
visualmode([{expr}]) visualmode()
返回字符串，它描述当前缓冲区最近使用的可视模式。一开始，它返回
空字符串，一旦使用了可视模式，返回 "v"、"V" 或 "<CTRL-V>" (单
个 CTRL-V 字符)，分别代表面向字符、面向行、和面向列块的可视模
式。
例如:
:exe "normal " .. visualmode()
进入和上次相同的可视模式。也可以用于在脚本里根据最近的可视模式
采取不同的行动。
如果当前正处于可视模式中， mode() 可得到具体的可视模式 (例如
在 :vmap 中可用)。
如果提供 {expr} 并且计算结果是非零数值或者是非空字符串，那么将
清除可视模式，并返回旧的值。见 non-zero-arg 。
返回类型: String
wildmenumode() wildmenumode()
如果 wildmenu 打开，返回 TRUE ，否则返回 FALSE 。参见
'wildmenu' 和 'wildmode'。
可用于在映射中方便地处理 'wildcharm' 选项。(只对 mapmode-c
映射有意义)。
例如要使 <c-j> 在 wildmode 中等价于 <down>，可用:
:cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
(备注: 这需要 'wildcharm' 合适的设置配合)。
返回类型: Number
wildtrigger() wildtrigger()
启动命令行上的通配扩展，其行为应用 'wildmode' 和 'wildoptions'
设置的定义。
此函数也打开搜索模式的补全，如 / 、 ? 、 :s 、 :g 、 :v 和
:vimgrep 。
不像手动按 'wildchar' 那样，此函数在找不到匹配时不响铃，一般而
言操作会更安静。这样更适合补全的自动触发，
注意: 在浏览命令行历史后，wildtrigger() 的首个调用是空操作；需
要第二次调用来启动扩展。这是为了在命令行自动补全里支持历史浏
览。
见 cmdline-completion 。
返回值永远是 0。
返回类型: Number
win_execute({id}, {command} [, {silent}]) win_execute()
类似于 execute() 但在窗口 {id} 的上下文中执行。该窗口会被临
时设为当前窗口，不触发自动命令，也不会改变目录。执行 {command}
时会触发自动命令，这可能有意想不到的副作用。如有必要可用
:noautocmd 。
示例:
call win_execute(winid, 'set syntax=python')
和 setwinvar() 相同但不触发自动命令也不实际显示语法高亮。
E994
不是所有的命令都允许在弹出窗口中使用。
窗口 {id} 不存在时不报错，且返回空字符串。
也可用作 method ，基是作为第二个参数传递的:
GetCommand()->win_execute(winid)
返回类型: String
win_findbuf({bufnr}) win_findbuf()
返回包含缓冲区 {bufnr} 的窗口的所有 window-ID 的 List 。如
果没有这样的窗口，返回空列表。
也可用作 method :
GetBufnr()->win_findbuf()
返回类型: list<number> 或 list<any>
win_getid([{win} [, {tab}]]) win_getid()
返回指定窗口的 window-ID 。
忽略 {win} 则使用当前窗口。
给定 {win} 时，这是窗口号。顶部窗口的窗口号为 1。
忽略 {tab} 则使用当前标签页，否则使用标签页 {tab}。首个标签页
的标签页号为一。
如果找不到这样的窗口，返回零。
也可用作 method :
GetWinnr()->win_getid()
返回类型: Number
win_gettype([{nr}]) win_gettype()
返回窗口类型:
"autocmd" 自动命令窗口。用于执行自动命令的临时窗
口。
"command" 命令行窗口 cmdwin
(空) 正常窗口
"loclist" location-list-window
"popup" 弹出窗口 popup
"preview" 预览窗口 preview-window
"quickfix" quickfix-window
"unknown" 窗口 {nr} 找不到
{nr} 省略时返回当前窗口的类型。
给出 {nr} 时返回给出窗口号或 window-ID 的窗口的类型。
另见 'buftype' 选项。在弹出窗口中运行终端时，'buftype' 为
"terminal" 而 win_gettype() 返回 "popup"。
也可用作 method :
GetWinid()->win_gettype()
返回类型: String
win_gotoid({expr}) win_gotoid()
转到 ID 为 {expr} 的窗口。可能会改变当前标签页。
成功时返回 TRUE，如果找不到这样的窗口，返回 FALSE。
也可用作 method :
GetWinid()->win_gotoid()
返回类型: Number
win_id2tabwin({expr}) win_id2tabwin()
返回包含 ID 为 {expr} 的窗口的标签页号和窗口号的列表:
[tabnr, winnr]。
如果找不到这样的窗口，返回 [0, 0]。
也可用作 method :
GetWinid()->win_id2tabwin()
返回类型: list<number>
win_id2win({expr}) win_id2win()
返回 ID 为 {expr} 的窗口号。
如果在当前标签页下找不到这样的窗口，返回零。
也可用作 method :
GetWinid()->win_id2win()
返回类型: Number
win_move_separator({nr}, {offset}) win_move_separator()
把窗口 {nr} 的垂直分割符 (也就是右边界) 移动 {offset} 列，就像
用鼠标拖动一样。{nr} 可是以是窗口号或 window-ID 。正 {offset}
向右移动，负 {offset} 向左移动。移动窗口的垂直分割符会改变窗口
的宽度以及其它紧贴着同一分割符的相邻窗口的宽度。移动幅度可能小
于指定的位移 (如因为维持 'winminwidth' 的需要)。如果该窗口能找
到，返回 TRUE，否则 FALSE。
最右侧的窗口或者全宽窗口上会失败，因为此时右侧没有分割符。
只适用于当前标签页。 E1308
也可用作 method :
GetWinnr()->win_move_separator(offset)
返回类型: Number
win_move_statusline({nr}, {offset}) win_move_statusline()
把窗口 {nr} 的状态行 (也就是下边界) 移动 {offset} 行，就像用鼠
标拖动一样。{nr} 可是以是窗口号或 window-ID 。正 {offset} 向
下移动，负 {offset} 向上移动。移动窗口的状态行会改变窗口的高度
以及其它紧贴着同一状态行的相邻窗口的高度。移动幅度可能小于指定
的位移 (如因为维持 'winminheight' 的需要)。如果该窗口能找到，
返回 TRUE，否则 FALSE。
只适用于当前标签页。
也可用作 method :
GetWinnr()->win_move_statusline(offset)
返回类型: Number
win_screenpos({nr}) win_screenpos()
返回两个数值的列表，即窗口 {nr} 的屏幕位置: [row, col]。首个窗
口的位置总是 [1, 1]，除非它有标签页行，此时为 [2, 1]。
{nr} 可以是窗口号或 window-ID 。零代表当前窗口。
如果找不到窗口，返回 [0, 0]。
也可用作 method :
GetWinid()->win_screenpos()
返回类型: list<number>
win_splitmove({nr}, {target} [, {options}]) win_splitmove()
暂时切换到窗口 {target}，移动窗口 {nr} 为紧贴 {target} 的新分
割窗口。
和 :split 之类的命令不同，不创建新窗口 (移动后窗口 {nr} 的窗
口 ID 不变)。
{nr} 和 {target} 都可以是窗口号或 window-ID 。两者必须都在当
前标签页中。
成功时返回零，而失败时返回非零。
{options} 是包含以下可选项的 Dictionary :
"vertical" 为 TRUE 时垂直分割，类似于 :vsplit 。
"rightbelow" 为 TRUE 时分割在下方或右方 (垂直时)。为 FALSE
时分割在上方或左方 (垂直时)。如果未给出，使用
'splitbelow' 和 'splitright'。
也可用作 method :
GetWinid()->win_splitmove(target)
返回类型: Number
winbufnr({nr}) winbufnr()
返回数值，即窗口 {nr} 相关联的缓冲区号。{nr} 可以是窗口号或
window-ID 。
如果 {nr} 为零，返回当前窗口的缓冲区号。
如果窗口 {nr} 不存在，返回 -1。
示例:
:echo "当前窗口的文件是 " .. bufname(winbufnr(0))
也可用作 method :
FindWindow()->winbufnr()->bufname()
返回类型: Number
wincol() wincol()
返回数值，窗口光标的虚拟列。亦即从窗口左侧起算的屏幕列数。最左
列为第一列。
返回类型: Number
windowsversion() windowsversion()
返回字符串。MS-Windows 上指示 OS 版本。例如，Windows 10 是
"10.0"。Windows 8 是 "6.2"，Windows XP 是 "5.1"。非 MS-Windows
系统上返回空串。
返回类型: String
winheight({nr}) winheight()
返回数值，窗口 {nr} 的高度。
{nr} 可以是窗口号或 window-ID 。
如果 {nr} 为零，返回当前窗口的高度。如果窗口 {nr} 不存在，返回
-1。
存在的窗口的高度至少为零。
不计入任何窗口工具条行。
示例:
:echo "当前窗口有 " .. winheight(0) .. " 行。"
GetWinid()->winheight()
返回类型: Number
winlayout([{tabnr}]) winlayout()
返回嵌套列表，包含标签页中的窗口布局。
未给出 {tabnr} 则使用当前标签页，否则使用号码为 {tabnr} 的标签
页。如果标签页 {tabnr} 找不到，返回空列表。
叶窗口返回:
['leaf', {winid}]
水平分割的窗口构成一列，它们返回:
['col', [{nested list of windows}]]
垂直分割的窗口构成一行，它们返回:
['row', [{nested list of windows}]]
示例:
" 标签页中只有一个窗口
:echo winlayout()
['leaf', 1000]
" 两个水平分割的窗口
:echo winlayout()
['col', [['leaf', 1000], ['leaf', 1001]]]
" 第二个标签页，其中有三个水平分割的窗口，中间窗口有两
" 个垂直分割的窗口
:echo winlayout(2)
['col', [['leaf', 1002], ['row', [['leaf', 1003],
['leaf', 1001]]], ['leaf', 1000]]]
也可用作 method :
GetTabnr()->winlayout()
返回类型: list<any>
winline() winline()
返回数值，窗口光标所在的屏幕行，亦即，从窗口顶部起算的屏幕行
数。第一行返回 1。
如果光标移动，文件的视图会先更新，这可能会导致滚动。
返回类型: Number
winnr([{arg}]) winnr()
返回数值，当前窗口的编号。最上面的窗口的编号为 1。
弹出窗口返回零。
可选参数 {arg} 支持以下值:
$ 返回最后一个窗口的编号 (即窗口的总数)。
# 返回最近访问的窗口号 ( CTRL-W_p 到的地
方)。如果没有上次窗口或它在另一个标签页中，返
回 0。有些情况下可指向当前窗口 (如计算
'statusline' 表达式时)。
{N}j 当前窗口之下第 N 个窗口的窗口号 ( CTRL-W_j 到
的地方)。
{N}k 当前窗口之上第 N 个窗口的窗口号 ( CTRL-W_k 到
的地方)。
{N}h 当前窗口之左第 N 个窗口的窗口号 ( CTRL-W_h 到
的地方)。
{N}l 当前窗口之右第 N 个窗口的窗口号 ( CTRL-W_l 到
的地方)。
此编号可用于 CTRL-W_w 和 ":wincmd w" :wincmd 。
{arg} 非法时，报错并返回零。
另见 tabpagewinnr() 和 win_getid() 。
示例:
let window_count = winnr('$')
let prev_window = winnr('#')
let wnum = winnr('3k')
GetWinval()->winnr()
返回类型: Number
winrestcmd() winrestcmd()
返回 :resize 命令序列，该序列应该能够恢复当前窗口的大小。只
有在没有窗口被打开或关闭且当前窗口和标签页都没有改变的时候才能
正确工作。
示例:
:let cmd = winrestcmd()
:call MessWithWindowSizes()
:exe cmd
返回类型: String
winrestview({dict}) winrestview()
使用 winsaveview() 返回的 Dictionary 来恢复当前窗口的视
图。
注意 {dict} 不需要包含所有的 winsaveview() 返回的值。如果不
提供某值，则不恢复相应的设置。所以可以用:
:call winrestview({'curswant': 4})
它只会设置光标的 curswant 值 (垂直移动的光标想移动到的列) 到第
5 列 (是的，第 5 列)，而其它设置保持不变。这可用于手动设置光标
位置。
如果你改变了其中的值，结果无法预测。如果窗口大小改变了，结果不
会完全一样。
也可用作 method :
GetView()->winrestview()
返回类型: Number
winsaveview() winsaveview()
返回 Dictionary ，包含当前窗口的信息，这些信息可用来恢复视
图。
winrestview() 进行视图的恢复。
可用于定义在缓冲区里跳转后想恢复的原来视图的映射。
这里不保存折叠的信息。用 'foldenable' 选项来暂时关闭折叠功能，
这样在移动时折叠就不会打开。这可能有副作用。
返回值包括:
lnum 光标行号
col 光标列号 (注意: 首列为零，和
getcurpos() 不同)
coladd 'virtualedit' 使用的光标列偏移
curswant 垂直移动使用的列 (注意: 首列为零，和
getcurpos() 不同)。 $ 命令后，设为
等于 v:maxcol 的一个大值。
topline 窗口的第一行
topfill 填充行，只用于比较模式
leftcol 显示的第一列；只用于 'wrap' 关闭时
skipcol 跳过的列数
注意 这里不保存任何选项值。
返回类型: dict<number>
winwidth({nr}) winwidth()
返回数值，窗口 {nr} 的宽度。
{nr} 可以是窗口号或 window-ID 。
如果 {nr} 为零，返回当前窗口的宽度。如果窗口 {nr} 不存在，返回
-1。
存在的窗口的宽度至少为零。
示例:
:echo "当前窗口有 " .. winwidth(0) .. " 列。"
:if winwidth(0) <= 50
: 50 wincmd |
:endif
要得到终端或屏幕大小，可见 'columns' 选项。
也可用作 method :
GetWinid()->winwidth()
返回类型: Number
wordcount() wordcount()
返回字典，包含当前缓冲区的字节/字符/单词的统计。和 g_CTRL-G
包含的信息相同。
返回值包括:
bytes 缓冲区的字节数
chars 缓冲区的字符数
words 缓冲区的单词数
cursor_bytes 光标前的字节数 (不在可视模式下)
cursor_chars 光标前的字符数 (不在可视模式下)
cursor_words 光标前的单词数 (不在可视模式下)
visual_bytes 可视选择的字节数 (只在可视模式下)
visual_chars 可视选择的字符数 (只在可视模式下)
visual_words 可视选择的单词数 (只在可视模式下)
返回类型: dict<number>
writefile({object}, {fname} [, {flags}]) writefile()
{object} 为 List 时，把列表写到文件 {fname} 里。列表的项目间
以 NL 分隔。每个列表项必须是字符串或数值。
所有的 NL 字符被 NUL 字符代替。
CR 字符的插入需要在把 {list} 传递给 writefile() 之前先做好。
{object} 为 Blob 时，把这些字节不加修改地写到文件 {fname}
里，即使不指定二进制模式也是如此。
{flags} 必须为字符串。识别以下字符:
'b' 使用二进制模式: 最后一个列表项目之后没有 NL，最后的空项目
使得文件的末行以 NL 结尾。
'a' 使用附加模式，写入行附加到文件之后:
:call writefile(["foo"], "event.log", "a")
:call writefile(["bar"], "event.log", "a")
'D' 当前函数结束时删除文件。相当于:
:defer delete({fname})
不在函数中执行时失败。另见 :defer 。
's' 写入文件后总是调用 fsync()。在可能的情况下它把文件刷新到
盘上。这会多花些时间，但避免系统崩溃时丢失文件的风险。
'S' 无论 'fsync' 选项是否置位都不调用 fsync()。
如果 {flags} 不包含 "S" 或 "s"，仅当 'fsync' 选项置位时调
用 fsync()。
如果可能，覆盖已有的文件。
如果写入失败，返回 -1，否则返回 0。如果文件不能建立或者写入失
败，会有错误信息。
另见 readfile() 。
要按字节复制文件:
:let fl = readfile("foo", "b")
:call writefile(fl, "foocopy", "b")
GetText()->writefile("thefile")
返回类型: Number
xor({expr}, {expr}) xor()
对两个参数进行按位异或。参数须转换为数值。列表、字典或浮点数参
数会报错。
另见 and() 和 or() 。
示例:
:let bits = xor(bits, 0x80)
也可用作 method :
:let bits = bits->xor(0x80)
返回类型: Number
有三种类型的特性:
1. 只有在 Vim 编译时加入才会支持的特性 +feature-list 。例如:
:if has("cindent")
gui_running
2. 只有特定条件满足才会支持的特性。例如:
:if has("gui_running")
has-patch
3. 特定版本之后或在特定版本上并包含了特定补丁。"patch-7.4.248" 特性意味着 Vim
版本是 7.5 或之后，或 7.4 并包含了补丁 248。例如:
:if has("patch-7.4.248")
注意 包含了补丁 249 但不包含补丁 248 是可能的，但这只适用于 cherrypick 补
丁的情况。
注意 此形式只可用于 7.4.237 补丁或之后版本，在这之前，你需要检查补丁号和
v:version。例如 (确定是 version 6.2.148 或更新的版本):
:if v:version > 602 || v:version == 602 && has("patch148")
CTRL-X 扩展命令的支持。(总为真)
job 编译时加入了 channel 和 job 的支持
ipv6 编译时加入了 channel 的 IPv6 网络支持
jumplist 编译时加入了 jumplist 的支持。(总为真)
keymap 编译时加入了 'keymap' 的支持。
lambda 编译时加入了 lambda 的支持。
langmap 编译时加入了 'langmap' 的支持。
libcall 编译时加入了 libcall() 的支持。
linebreak 编译时加入了 'linebreak'、'breakat'、'showbreak' 和
'breakindent' 的支持。
linux Vim 的 Linux 版本。
lispindent 编译时加入了 lisp 缩进的支持。(总为真)
listcmds 编译时加入了缓冲区列表 :files 和参数列表 arglist
的命令。
localmap 编译时加入了局部映射和缩写。 :map-local
lua 编译时加入了 Lua 接口 Lua 。
mac Vim 的 Macintosh 版本，参照 osx
macunix 同 osxdarwin
menu 编译时加入了 :menu 的支持。
mksession 编译时加入了 :mksession 的支持。
modify_fname 编译时加入了文件名的修饰符支持。 filename-modifiers
(总为真)
mouse 编译时加入了鼠标的支持。
mouse_dec 编译时加入了 Dec 终端的鼠标支持。
mouse_gpm 编译时加入了 gpm (Linux 控制台鼠标) 的支持。
mouse_gpm_enabled GPM 鼠标可用
mouse_netterm 编译时加入了 netterm 的鼠标支持。
mouse_pterm 编译时加入了 qnx 的鼠标支持。
mouse_sysmouse 编译时加入了 sysmouse 支持 (*BSD 控制台鼠标)
mouse_sgr 编译时加入了 sgr 的鼠标支持。
mouse_urxvt 编译时加入了 urxvt 的鼠标支持。
mouse_xterm 编译时加入了 xterm 的鼠标支持。
mouseshape 编译时加入了 'mouseshape' 的支持。
multi_byte 编译时加入了 'encoding' 的支持 (总为真)
multi_byte_encoding 'encoding' 设为某个多字节的编码。
multi_byte_ime 编译时加入了 IME 输入方法的支持。
multi_lang 编译时加入了多语言的支持。
mzscheme 编译时加入了 MzScheme 接口支持 mzscheme 。
nanotime 编译时加入了次秒级的时间戳检查。
netbeans_enabled 编译时加入了 netbeans 的支持并且已连接上。
netbeans_intg 编译时加入了 netbeans 的支持。
num64 编译时加入了64 位 Number 的支持。(总为真)
ole 编译时加入了 Win32 OLE automation 的支持。
osx 为 macOS 编译，参照 mac
osxdarwin 为 macOS 编译，带有 mac-darwin-feature
packages 编译时加入了 packages 的支持。
path_extra 编译时加入了 'path' 和 'tags' 上下搜索的支持。
perl 编译时加入了 Perl 接口。
persistent_undo 编译时加入了持久化撤销历史的支持。
postscript 编译时加入了 PostScript 文件打印的支持。
printer 编译时加入了 :hardcopy 的支持。
profile 编译时加入了 :profile 的支持。
prof_nsec 剖视结果以纳秒计。
python Python 2.x 接口可用。 has-python
python_compiled 编译时加入了 Python 2.x 接口。 has-python
python_dynamic Python 2.x 接口已动态载入。 has-python
python3 Python 3.x 接口可用。 has-python
python3_compiled 编译时加入了 Python 3.x 接口。 has-python
python3_dynamic Python 3.x 接口已动态载入。 has-python
python3_stable Python 3.x 接口使用 Python 稳定 ABI。 has-python
pythonx Python 2.x 和/或 3.x 接口可用。 pythonx
qnx Vim 的 QNX 版本。
quickfix 编译时加入了 quickfix 的支持。
reltime 编译时加入了 reltime() 的支持。
rightleft 编译时加入了 'rightleft' 的支持。
ruby 编译时加入了 Ruby 接口 ruby 。
scrollbind 编译时加入了 'scrollbind' 的支持。(总为真)
showcmd 编译时加入了 'showcmd' 的支持。
signs 编译时加入了 :sign 的支持。
smartindent 编译时加入了 'smartindent' 的支持。(总为真)
socketserver 编译时加入了套接字服务器功能。(只限 Unix)
sodium 编译时加入了 libsodium 以提供更好的加密支持
sound 编译时加入了声音的支持，例如 sound_playevent()
spell 编译时加入了拼写检查的支持 spell 。
startuptime 编译时加入了 --startuptime 支持。
statusline 编译时加入了 'statusline' 和 'rulerformat' 还有
'titlestring' 和 'iconstring' 的特殊格式的支持。
sun Vim 的 SunOS 版本。
sun_workshop 删除了 Sun workshop 的支持。
syntax 编译时加入了语法高亮的支持 syntax 。
syntax_items 当前缓冲区有激活的语法高亮项目。
system 编译时决定使用 system() 而不是 fork()/exec()。
tag_binary 编译时加入了标签文件的二分搜索 tag-binary-search 。
(总为真)
tag_old_static 删除了老的静态标签的支持，见 tag-old-static 。
tcl 编译时加入了 Tcl 接口。
termguicolors 编译时加入了终端的真彩支持。
terminal 编译时加入 terminal 的支持。
terminfo 编译时决定使用 terminfo 而不是 termcap。
termresponse 编译时加入了 t_RV 和 v:termresponse 的支持。
textobjects 编译时加入了 text-objects 的支持。
textprop 编译时加入了 text-properties 的支持。
tgetent 编译时加入了 tgetent 的支持，可以使用外部 termcap 或
terminfo 文件。
timers 编译时加入了 timer_start() 支持。
title 编译时加入了窗口标题的支持。'title'。(总为真)
toolbar 编译时加入了 gui-toolbar 的支持。
ttyin 输入是终端 (tty)
ttyout 输出是终端 (tty)
unix Vim 的 Unix 版本。 +unix
unnamedplus 编译时加入了 'clipboard' 对 "unnamedplus" 的支持。
user_commands 用户定义命令支持。(总为真)
vartabs 编译时加入了可变制表位的支持 'vartabstop'。
vcon Win32: 有虚拟终端支持，可用 'termguicolors'。另见
+vtp 。
vertsplit 编译时加入了垂直分割窗口的支持 :vsplit 。(总为真)
vim_starting 如果在启动载入脚本的阶段则为真。 startup
vim_starting
vim9script 编译时加入 Vim9 脚本支持
viminfo 编译时加入了 viminfo 的支持。
vimscript-1 编译时加入了 Vim 脚本版本 1 的支持
vimscript-2 编译时加入了 Vim 脚本版本 2 的支持
vimscript-3 编译时加入了 Vim 脚本版本 3 的支持
vimscript-4 编译时加入了 Vim 脚本版本 4 的支持
virtualedit 编译时加入了 'virtualedit' 选项支持。(总为真)
visual 编译时加入了可视模式的支持。(总为真)
visualextra 编译时加入了附加的可视模式命令支持。(总为真)
blockwise-operators 。
vms Vim 的 VMS 版本。
vreplace 编译时加入了 gR 和 gr 命令支持。(总为真)
vtp 编译时加入了 vcon 支持 +vtp (检查 vcon 可知当前控制
台是否支持)。
wayland 编译时加入了 Wayland 协议支持。
wayland_clipboard 编译时加入了 Wayland 剪贴板支持。
wayland_focus_steal 编译时加入了 Wayland 剪贴板焦点盗取支持。
wildignore 编译时加入了 'wildignore' 选项支持。
wildmenu 编译时加入了 'wildmenu' 选项支持。
win16 旧版本 MS-Windows 3.1 (总为假)
win32 Vim 的 Win32 版本。(MS-Windows 95 及其后的 32 或 64 位
版本)。
win32unix Vim 的 Win32 版本。使用 Unix 文件命名 (Cygwin)
win64 Vim 的 Win64 版本。(MS-Windows 64 位)。
win95 支持 MS-Windows 95/98/ME 的 Win32 版本 (总为假)
winaltkeys 编译时加入了 'winaltkeys' 选项。
windows 编译时加入了多窗口的支持。(总为真)
writebackup 编译时决定缺省打开 'writebackup'。
xattr 编译时加入了扩展属性支持 xattr (目前只有 Linux 支
持)。
xfontset 编译时加入了 X 字体集 的支持。 xfontset 。
xim 编译时加入了 X 输入法 的支持。 xim 。
xpm 编译时加入了 pixmap 的支持。
xpm_w32 编译时加入了 Win32 的 pixmap 的支持。(只为后向兼容而
保留，用 "xpm" 代替)
xsmp 编译时加入了 X 会话管理 的支持。
xsmp_interact 编译时加入了交互的 X 会话管理 的支持。
xterm_clipboard 编译时加入了 xterm 剪贴板的支持。
xterm_save 编译时加入了保存和恢复 xterm 屏幕的支持。
x11 编译时加入了 X11 的支持。
这是若干函数共同的功能。 pattern 说明的正则表达式通常用于寻找缓冲区行的匹配。
如果匹配用来在字符串里寻找匹配，几乎所有的功能都相同。唯一的区别是，字符串是作
为单行处理的。如果字符串里包含了 "\n" 字符，它并不看作是模式里的换行。它可以匹
配模式里的 "\n"，甚至于 "."。示例:
:let a = "aaaa\nxxxx"
:echo matchstr(a, "..\n..")
aa
xx
:echo matchstr(a, "a.x")
a
x