1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
<!DOCTYPE html>
<html lang="ja-JP">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="nsfisis">
<meta name="copyright" content="© nsfisis">
<meta name="description" content="Vim の autocmd events における BufWrite/BufWritePre がどう違うのかを調べた結果、 違いはないことがわかった。">
<meta name="keywords" content="Vim">
<link rel="icon" type="image/svg+xml" href="/favicon.svg">
<title>【Vim】autocmd events の BufWrite/BufWritePre の違い | REPL: Rest-Eat-Program Loop</title>
<link rel="stylesheet" href="/hl.css?208c52e3b7c9db1cad782c5d30b4698f">
<link rel="stylesheet" href="/style.css?779b1a3debcaeba619f6fe500e93d525">
<link rel="stylesheet" href="/custom.css?a649ea3528d4b626fb636505d94c1144">
</head>
<body class="single">
<header class="header">
<nav class="nav">
<p class="logo">
<a href="/">REPL: Rest-Eat-Program Loop</a>
</p>
</nav>
</header>
<main class="main">
<article class="post-single">
<header class="post-header">
<h1 class="post-title">【Vim】autocmd events の BufWrite/BufWritePre の違い</h1>
<ul class="post-tags">
<li class="tag">
<a href="/tags/vim/">Vim</a>
</li>
</ul>
</header>
<div class="post-content">
<section>
<h2 id="changelog">更新履歴</h2>
<ol>
<li class="revision">
<time datetime="2021-10-02">2021-10-02</time>: Qiita から移植
</li>
</ol>
</section>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>この記事は Qiita から移植してきたものです。 元 URL:
<a href="https://qiita.com/nsfisis/items/79ab4db8564032de0b25" class="bare">https://qiita.com/nsfisis/items/79ab4db8564032de0b25</a></p>
</div>
<hr>
</div>
</div>
<section class="section-1">
<h2 id="" class="section-header">
TL; DR
</h2>
<div class="section-body">
<div class="paragraph">
<p>違いはない。ただのエイリアス。</p>
</div>
</div>
</section>
<section class="section-1">
<h2 id="" class="section-header">
調査記録
</h2>
<div class="section-body">
<div class="paragraph">
<p>Vim の autocmd events には似通った名前のものがいくつかある。大抵は
<code>:help</code>
に説明があるが、この記事のタイトルにある2つを含めた以下のイベントには、その違いについて説明がない。</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>BufRead</code>/<code>BufReadPost</code></p>
</li>
<li>
<p><code>BufWrite</code>/<code>BufWritePre</code></p>
</li>
<li>
<p><code>BufAdd</code>/<code>BufCreate</code></p>
</li>
</ul>
</div>
<div class="paragraph">
<p>このうち、<code>BufAdd</code>/<code>BufCreate</code> に関しては、<code>:help BufCreate</code> に</p>
</div>
<div class="quoteblock">
<blockquote>
<div class="paragraph">
<p>The BufCreate event is for historic reasons.</p>
</div>
</blockquote>
</div>
<div class="paragraph">
<p>とあり、おそらくは <code>BufAdd</code>
のエイリアスであろうということがわかる。他の2組も同様ではないかと予想されるが、確認のため
vim と neovim のソースコードを調査した。</p>
</div>
<div class="quoteblock">
<blockquote>
<div class="paragraph">
<p>ソースコードへのリンク
<a href="https://github.com/vim/vim/tree/8e6be34338f13a6a625f19bcef82019c9adc65f2">vim
(調査時点での master branch)</a>
<a href="https://github.com/neovim/neovim/tree/71d4f5851f068eeb432af34850dddda8cc1c71e3">neovim
(上に同じ)</a></p>
</div>
</blockquote>
</div>
<section class="section-2">
<h3 id="" class="section-header">
vim のソースコード
</h3>
<div class="section-body">
<div class="paragraph">
<p>以下は、autocmd events
の名前と内部で使われている整数値とのマッピングを定義している箇所である。見ての通り、上でエイリアスではないかと述べた3組には、それぞれ同じ内部値が使われている。</p>
</div>
<div class="paragraph">
<p><a href="https://github.com/vim/vim/blob/8e6be34338f13a6a625f19bcef82019c9adc65f2/src/autocmd.c#L85-L86" class="bare">https://github.com/vim/vim/blob/8e6be34338f13a6a625f19bcef82019c9adc65f2/src/autocmd.c#L85-L86</a></p>
</div>
<div id="source." class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="c"> <span class="p">{</span><span class="s">"BufAdd"</span><span class="p">,</span> <span class="n">EVENT_BUFADD</span><span class="p">},</span>
<span class="p">{</span><span class="s">"BufCreate"</span><span class="p">,</span> <span class="n">EVENT_BUFADD</span><span class="p">},</span></code></pre>
</div>
</div>
<div class="paragraph">
<p><a href="https://github.com/vim/vim/blob/8e6be34338f13a6a625f19bcef82019c9adc65f2/src/autocmd.c#L95-L97" class="bare">https://github.com/vim/vim/blob/8e6be34338f13a6a625f19bcef82019c9adc65f2/src/autocmd.c#L95-L97</a></p>
</div>
<div id="source." class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="c"> <span class="p">{</span><span class="s">"BufRead"</span><span class="p">,</span> <span class="n">EVENT_BUFREADPOST</span><span class="p">},</span>
<span class="p">{</span><span class="s">"BufReadCmd"</span><span class="p">,</span> <span class="n">EVENT_BUFREADCMD</span><span class="p">},</span>
<span class="p">{</span><span class="s">"BufReadPost"</span><span class="p">,</span> <span class="n">EVENT_BUFREADPOST</span><span class="p">},</span></code></pre>
</div>
</div>
<div class="paragraph">
<p><a href="https://github.com/vim/vim/blob/8e6be34338f13a6a625f19bcef82019c9adc65f2/src/autocmd.c#L103-L105" class="bare">https://github.com/vim/vim/blob/8e6be34338f13a6a625f19bcef82019c9adc65f2/src/autocmd.c#L103-L105</a></p>
</div>
<div id="source." class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="c"> <span class="p">{</span><span class="s">"BufWrite"</span><span class="p">,</span> <span class="n">EVENT_BUFWRITEPRE</span><span class="p">},</span>
<span class="p">{</span><span class="s">"BufWritePost"</span><span class="p">,</span> <span class="n">EVENT_BUFWRITEPOST</span><span class="p">},</span>
<span class="p">{</span><span class="s">"BufWritePre"</span><span class="p">,</span> <span class="n">EVENT_BUFWRITEPRE</span><span class="p">},</span></code></pre>
</div>
</div>
</div>
</section>
<section class="section-2">
<h3 id="" class="section-header">
neovim のソースコード
</h3>
<div class="section-body">
<div class="paragraph">
<p>neovim の場合でも同様のマッピングが定義されているが、こちらの場合は Lua
で書かれている。以下にある通り、はっきり <code>aliases</code> と書かれている。</p>
</div>
<div class="paragraph">
<p><a href="https://github.com/neovim/neovim/blob/71d4f5851f068eeb432af34850dddda8cc1c71e3/src/nvim/auevents.lua#L119-L124" class="bare">https://github.com/neovim/neovim/blob/71d4f5851f068eeb432af34850dddda8cc1c71e3/src/nvim/auevents.lua#L119-L124</a></p>
</div>
<div id="source." class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="lua"> <span class="n">aliases</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">BufCreate</span> <span class="o">=</span> <span class="s1">'BufAdd'</span><span class="p">,</span>
<span class="n">BufRead</span> <span class="o">=</span> <span class="s1">'BufReadPost'</span><span class="p">,</span>
<span class="n">BufWrite</span> <span class="o">=</span> <span class="s1">'BufWritePre'</span><span class="p">,</span>
<span class="n">FileEncoding</span> <span class="o">=</span> <span class="s1">'EncodingChanged'</span><span class="p">,</span>
<span class="p">},</span></code></pre>
</div>
</div>
<div class="paragraph">
<p>ところで、上では取り上げなかった <code>FileEncoding</code> だが、これは
<code>:help FileEncoding</code> にしっかりと書いてある。</p>
</div>
<div class="literalblock">
<div class="content">
<pre> *FileEncoding*
FileEncoding Obsolete. It still works and is equivalent
to |EncodingChanged|.</pre>
</div>
</div>
</div>
</section>
<section class="section-2">
<h3 id="" class="section-header">
まとめ
</h3>
<div class="section-body">
<div class="paragraph">
<p>記事タイトルについて言えば、どちらも変わらないので好きな方を使えばよい。あえて言えば、次のようになるだろう。</p>
</div>
<div class="ulist">
<ul>
<li>
<p><code>BufAdd</code>/<code>BufCreate</code></p>
<div class="ulist">
<ul>
<li>
<p>→ <code>BufCreate</code> は歴史的な理由により (<code>`for historic reasons'')
存在しているため、新しい方 (`BufAdd</code>) を使う</p>
</li>
</ul>
</div>
</li>
<li>
<p><code>BufRead</code>/<code>BufReadPost</code></p>
<div class="ulist">
<ul>
<li>
<p>→ <code>BufReadPre</code> との対称性のため、あるいは <code>BufWritePost</code>
との対称性のため <code>BufReadPost</code> を使う</p>
</li>
</ul>
</div>
</li>
<li>
<p><code>BufWrite</code>/<code>BufWritePre</code></p>
<div class="ulist">
<ul>
<li>
<p>→ <code>BufWritePost</code> との対称性のため、あるいは <code>BufReadPre</code>
との対称性のため <code>BufWritePre</code> を使う</p>
</li>
</ul>
</div>
</li>
<li>
<p><code>FileEncoding</code>/<code>EncodingChanged</code></p>
<div class="ulist">
<ul>
<li>
<p>→ <code>FileEncoding</code> は <code>`Obsolete''
と明言されているので、`EncodingChanged</code> を使う</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="paragraph">
<p>ところでこの調査で知ったのだが、<code>BufRead</code> と <code>BufWrite</code>
は上にある通り発火するタイミングが「後」と「前」で対称性がない。可能なら
<code>Pre</code>/<code>Post</code> 付きのものを使った方が分かりやすいだろう。</p>
</div>
</div>
</section>
</div>
</section>
</div>
</article>
</main>
<footer class="footer">
© 2021 nsfisis
</footer>
</body>
</html>
|
