【Vim】 autocmd events の BufWrite/BufWritePre の違い

更新履歴

1. 2021-10-02: Qiita から移植

TL; DR

違いはない。ただのエイリアス。

調査記録

Vim の autocmd events には似通った名前のものがいくつかある。大抵は :help に説明があるが、この記事のタイトルにある2つを含めた以下のイベントには、その違いについて説明がない。

• BufRead/BufReadPost
• BufWrite/BufWritePre
• BufAdd/BufCreate

このうち、BufAdd/BufCreate に関しては、:help BufCreate に

The BufCreate event is for historic reasons.

とあり、おそらくは BufAdd のエイリアスであろうということがわかる。他の2組も同様ではないかと予想されるが、確認のため vim と neovim のソースコードを調査した。

ソースコードへのリンク

• vim (調査時点での master branch)
• neovim (上に同じ)

{"BufAdd",      EVENT_BUFADD},
{"BufCreate",   EVENT_BUFADD},

{"BufRead",     EVENT_BUFREADPOST},
{"BufReadCmd",  EVENT_BUFREADCMD},
{"BufReadPost", EVENT_BUFREADPOST},

{"BufWrite",    EVENT_BUFWRITEPRE},
{"BufWritePost",    EVENT_BUFWRITEPOST},
{"BufWritePre", EVENT_BUFWRITEPRE},

aliases = {
  BufCreate = 'BufAdd',
  BufRead = 'BufReadPost',
  BufWrite = 'BufWritePre',
  FileEncoding = 'EncodingChanged',
},

                                                              *FileEncoding*
FileEncoding                    Obsolete.  It still works and is equivalent
                                to |EncodingChanged|.

まとめ

記事タイトルについて言えば、どちらも変わらないので好きな方を使えばよい。あえて言えば、次のようになるだろう。

• BufAdd/BufCreate
  • → BufCreate は歴史的な理由により (“for historic reasons”) 存在しているため、新しい方 (BufAdd) を使う
• BufRead/BufReadPost
  • → BufReadPre との対称性のため、あるいは BufWritePost との対称性のため BufReadPost を使う
• BufWrite/BufWritePre
  • → BufWritePost との対称性のため、あるいは BufReadPre との対称性のため BufWritePre を使う
• FileEncoding/EncodingChanged
  • → FileEncoding は “Obsolete” と明言されているので、EncodingChanged を使う

ところでこの調査で知ったのだが、BufRead と BufWrite は上にある通り発火するタイミングが「後」と「前」で対称性がない。可能なら Pre/Post 付きのものを使った方が分かりやすいだろう。