如何在 VimScript 中使用缓冲区本地自动命令？

Question

我正在尝试write a snippet of VimL 以允许用户切换使用热键突出显示不需要的尾随空格。 （这是我的第一个 Vim 脚本，除了将内容复制粘贴到我的 .vimrc 之外，所以......盐粒：P）

我希望“我们当前是否突出显示尾随空格？”是特定于缓冲区的状态；但我在弄清楚自动命令如何与缓冲区交互时遇到了很多麻烦。

例如，here's 我第一次尝试 buffer-local autocmds 的 augroup：

augroup  ExtraWhitespace
   au!
   au BufEnter    <buffer=abuf> match ExtraWhitespace /\s\+$/
   au InsertEnter <buffer=abuf> match ExtraWhitespace /\s\+\%#\@<!$/
   au InsertLeave <buffer=abuf> match ExtraWhiteSpace /\s\+$/
augroup END

…不幸的是，这在调用时会立即出错：

Error detected while processing function ToggleExtraWhitespace: 
line   19:
E680: <buffer=0>: invalid buffer number 
line   20:
E680: <buffer=0>: invalid buffer number 
line   21:
E680: <buffer=0>: invalid buffer number 
No matching autocommands

我不明白为什么<abuf> 是0，而bufnr('%') 是1，或者如何让自动命令执行缓冲区1。 （当然0无效！）

---

目前，I've swapped out <buffer=abuf> 为 *；但是当加载了多个缓冲区时，这会破坏此函数的功能，这很糟糕。因此，欢迎任何帮助解决这个问题。 /=

Answer 1

首先，我不知道<buffer=abuf> 是如何工作的。它的文档似乎有冲突。 看来<buffer=abuf> 的行为已被patch 7.4.637 更改/修复，即使使用正确也会导致问题。 <buffer=abuf> 只能在 autocmd 运行时使用。因此，如果您在 VimEnter 或 BufAdd 中调用它，您的函数可能会起作用。

---

以下是您尝试的修改版本，不使用<buffer=abuf>

  augroup ExtraWhitespace
     autocmd! * <buffer>
     autocmd BufEnter    <buffer> match ExtraWhitespace /\s\+$/
     autocmd InsertEnter <buffer> match ExtraWhitespace /\s\+\%#\@<!$/
     autocmd InsertLeave <buffer> match ExtraWhitespace /\s\+$/
  augroup END

您应该注意到的第一件事是au! 已被autocmd! * <buffer> 替换。 au! 不应该存在，因为这将从所有缓冲区中删除 ExtraWhitespace 组中的所有 autocmd。这意味着您只能在一个缓冲区中定义它。 （autocmd! * <buffer> 只删除当前缓冲区中的自动命令）

您应该注意的第二件事是使用了<buffer>。这意味着当调用该函数时，将只为当前缓冲区创建 autocmd。必须为要定义的每个缓冲区调用缓冲区本地 autocmd。

---

其他杂项cmets

你有

fun! HighlightExtraWhitespace()
   if exists('b:ews') && b:ews == 1
     "echom "-- Adding ExtraWhitespace hilighting"
      highlight ExtraWhitespace ctermbg=red guibg=red
   else
     "echom "-- Removing ExtraWhitespace hilighting"
      highlight clear ExtraWhitespace
   endif
endfun
au ColorScheme * call HighlightExtraWhitespace()

高亮是全局的，所以在一个缓冲区中清除它会在所有地方删除高亮组。所以最好只保留突出显示并在每次颜色方案更改时重新定义它。

autocmd ColorScheme * highlight ExtraWhitespace ctermbg=red guibg=red

建议在脚本中使用长格式的命令名。 （仅用于打字的简短形式）。长格式更易读且易于识别，因此au 将变为autocmd。