usr_43.txt 适用于 Vim 9.0 版本。 最近更新: 2017年8月
VIM 用户手册 - by Bram Moolenaar
译者: lang2
使用文件类型
当你在编辑某一类型文件时，例如一个 C 程序或者一个外壳脚本，你通常重复使用同样
的设置和键盘映射。很快你就会对每一次都要手动设置这些感到厌烦。这一章就告诉你如
果自动化这些设置。
43.1 为一类文件编写的插件
43.2 添加一个文件类型
后一章: usr_44.txt 自定义语法高亮
前一章: usr_42.txt 添加新的菜单
目录: usr_toc.txt
如何使用文件类型插件已经在 add-filetype-plugin 这里讨论过了。不过你很可能对
缺省的最基本的设定不满意。假定对于所有 C 文件你希望将 'softtabstop' 选项定为 4
并定义一个插入三行注释的键盘映射。下面的两步可以做到:
your-runtime-dir
1. 创建你自己的运行时目录。在 Unix 上通常是 "~/.vim"。在这个目录下创建
"ftplugin" 目录:
mkdir ~/.vim
mkdir ~/.vim/ftplugin
如果你不是 Unix 用户的话，看看 'runtimepath' 选项的值就知道 Vim 在哪里找
"ftplugin" 目录了:
set runtimepath
setlocal softtabstop=4
noremap <buffer> <LocalLeader>c o/**************<CR><CR>/<Esc>
let b:undo_ftplugin = "setl softtabstop< | unmap <buffer> <LocalLeader>c"
注意到 'softtabstop' 选项的值已经被设为 4 了。
但是当你编辑另外的文件的时候就会被复位到 0。那是因为用了 ":setlocal" 命令。这
样，对 'softtabstop' 选项的设置仅对本缓冲区有效。一旦你编辑另外一个文件，该选
项的值就会被设定成那个缓冲区的缺省值，或者最近一次被 ":set" 命令设定的值。
同样地，键盘映射 "\c" 在编辑另外一个缓冲区时就不起作用了。":map <buffer>" 命令
建立了一个仅对当前缓冲区有效的映射。其它映射命令 ":map!"，":vmap" 等也是如此。
映射中的 <LocalLeader> 被 "maplocalleader" 变量的值所替代。
b:undo_ftplugin 的设定用于文件类型被设成其它值的时候。那种情况下你会想撤销自己
的首选项。此 b:undo_ftplugin 变量作为命令执行。小心字符串里有特殊含义的字符，
如反斜杠。
在下面这个目录里你可以找到一些文件类型插件的例子:
$VIMRUNTIME/ftplugin/
43.2 添加一个文件类型
如果你正在使用一种 Vim 不认识的文件，这一节告诉你怎么将这种文件介绍给 Vim。你
需要一个自己的运行时目录。参阅上面的 your-runtime-dir 。
创建一个文件 "filetype.vim" 并加入一个为你的文件类型编写的自动命令。(关于自动
命令的阐述在 40.3 。) 例:
augroup filetypedetect
au BufNewFile,BufRead *.xyz setf xyz
augroup END
augroup filetypedetect
au BufNewFile,BufRead *.xyz setf xyz
au BufNewFile,BufRead /usr/share/scripts/* setf ruby
augroup END
augroup filetypedetect
au BufNewFile,BufRead *.txt setf text
augroup END
augroup filetypedetect
au BufNewFile,BufRead /usr/share/scripts/* setf ruby
augroup END
#!/bin/xyz
为了认出这个脚本，在你的运行时目录 (和你的 filetype.vim 在同一个目录) 下创建一
个 "scripts.vim" 文件。类似这样:
if did_filetype()
finish
endif
if getline(1) =~ '^#!.*[/\\]xyz\>'
setf xyz
endif