|
874
|
1 *quickfix.txt* For Vim version 7.0. Last change: 2006 Apr 30
|
|
7
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
|
5
|
|
|
6
|
|
|
7 This subject is introduced in section |30.1| of the user manual.
|
|
|
8
|
|
|
9 1. Using QuickFix commands |quickfix|
|
|
|
10 2. The error window |quickfix-window|
|
|
|
11 3. Using more than one list of errors |quickfix-error-lists|
|
|
|
12 4. Using :make |:make_makeprg|
|
|
|
13 5. Using :grep |grep|
|
|
|
14 6. Selecting a compiler |compiler-select|
|
|
|
15 7. The error format |error-file-format|
|
|
|
16 8. The directory stack |quickfix-directory-stack|
|
|
|
17 9. Specific error file formats |errorformats|
|
|
|
18
|
|
|
19 {Vi does not have any of these commands}
|
|
|
20
|
|
|
21 The quickfix commands are not available when the |+quickfix| feature was
|
|
|
22 disabled at compile time.
|
|
|
23
|
|
|
24 =============================================================================
|
|
|
25 1. Using QuickFix commands *quickfix* *Quickfix* *E42*
|
|
|
26
|
|
|
27 Vim has a special mode to speedup the edit-compile-edit cycle. This is
|
|
|
28 inspired by the quickfix option of the Manx's Aztec C compiler on the Amiga.
|
|
|
29 The idea is to save the error messages from the compiler in a file and use Vim
|
|
|
30 to jump to the errors one by one. You can examine each problem and fix it,
|
|
|
31 without having to remember all the error messages.
|
|
|
32
|
|
170
|
33 In Vim the quickfix commands are used more generally to find a list of
|
|
|
34 positions in files. For example, |:vimgrep| finds pattern matches. You can
|
|
231
|
35 use the positions in a script with the |getqflist()| function. Thus you can
|
|
170
|
36 do a lot more than the edit/compile/fix cycle!
|
|
|
37
|
|
7
|
38 If you are using Manx's Aztec C compiler on the Amiga look here for how to use
|
|
|
39 it with Vim: |quickfix-manx|. If you are using another compiler you should
|
|
|
40 save the error messages in a file and start Vim with "vim -q filename". An
|
|
|
41 easy way to do this is with the |:make| command (see below). The
|
|
|
42 'errorformat' option should be set to match the error messages from your
|
|
|
43 compiler (see |errorformat| below).
|
|
|
44
|
|
644
|
45 *location-list* *E776*
|
|
648
|
46 A location list is similar to a quickfix list and contains a list of positions
|
|
|
47 in files. A location list is associated with a window and each window can
|
|
|
48 have a separate location list. A location list can be associated with only
|
|
|
49 one window. The location list is independent of the quickfix list.
|
|
644
|
50
|
|
648
|
51 When a window with a location list is split, the new window gets a copy of the
|
|
|
52 location list. When there are no references to a location list, the location
|
|
|
53 list is destroyed.
|
|
|
54
|
|
|
55 The following quickfix commands can be used. The location list commands are
|
|
|
56 similar to the quickfix commands, replacing the 'c' prefix in the quickfix
|
|
|
57 command with 'l'.
|
|
7
|
58
|
|
|
59 *:cc*
|
|
|
60 :cc[!] [nr] Display error [nr]. If [nr] is omitted, the same
|
|
|
61 error is displayed again. Without [!] this doesn't
|
|
|
62 work when jumping to another buffer, the current buffer
|
|
|
63 has been changed, there is the only window for the
|
|
|
64 buffer and both 'hidden' and 'autowrite' are off.
|
|
|
65 When jumping to another buffer with [!] any changes to
|
|
|
66 the current buffer are lost, unless 'hidden' is set or
|
|
|
67 there is another window for this buffer.
|
|
|
68 The 'switchbuf' settings are respected when jumping
|
|
|
69 to a buffer.
|
|
|
70
|
|
644
|
71 *:ll*
|
|
|
72 :ll[!] [nr] Same as ":cc", except the location list for the
|
|
|
73 current window is used instead of the quickfix list.
|
|
|
74
|
|
7
|
75 *:cn* *:cnext* *E553*
|
|
|
76 :[count]cn[ext][!] Display the [count] next error in the list that
|
|
|
77 includes a file name. If there are no file names at
|
|
|
78 all, go to the [count] next error. See |:cc| for
|
|
|
79 [!] and 'switchbuf'.
|
|
|
80
|
|
647
|
81 *:lne* *:lnext*
|
|
|
82 :[count]lne[xt][!] Same as ":cnext", except the location list for the
|
|
644
|
83 current window is used instead of the quickfix list.
|
|
|
84
|
|
7
|
85 :[count]cN[ext][!] *:cp* *:cprevious* *:cN* *:cNext*
|
|
|
86 :[count]cp[revious][!] Display the [count] previous error in the list that
|
|
|
87 includes a file name. If there are no file names at
|
|
|
88 all, go to the [count] previous error. See |:cc| for
|
|
|
89 [!] and 'switchbuf'.
|
|
|
90
|
|
856
|
91
|
|
647
|
92 :[count]lN[ext][!] *:lp* *:lprevious* *:lN* *:lNext*
|
|
644
|
93 :[count]lp[revious][!] Same as ":cNext" and ":cprevious", except the location
|
|
|
94 list for the current window is used instead of the
|
|
|
95 quickfix list.
|
|
|
96
|
|
7
|
97 *:cnf* *:cnfile*
|
|
|
98 :[count]cnf[ile][!] Display the first error in the [count] next file in
|
|
|
99 the list that includes a file name. If there are no
|
|
|
100 file names at all or if there is no next file, go to
|
|
|
101 the [count] next error. See |:cc| for [!] and
|
|
|
102 'switchbuf'.
|
|
|
103
|
|
644
|
104 *:lnf* *:lnfile*
|
|
|
105 :[count]lnf[ile][!] Same as ":cnfile", except the location list for the
|
|
|
106 current window is used instead of the quickfix list.
|
|
|
107
|
|
7
|
108 :[count]cNf[ile][!] *:cpf* *:cpfile* *:cNf* *:cNfile*
|
|
|
109 :[count]cpf[ile][!] Display the last error in the [count] previous file in
|
|
|
110 the list that includes a file name. If there are no
|
|
|
111 file names at all or if there is no next file, go to
|
|
|
112 the [count] previous error. See |:cc| for [!] and
|
|
|
113 'switchbuf'.
|
|
|
114
|
|
647
|
115
|
|
|
116 :[count]lNf[ile][!] *:lpf* *:lpfile* *:lNf* *:lNfile*
|
|
644
|
117 :[count]lpf[ile][!] Same as ":cNfile" and ":cpfile", except the location
|
|
|
118 list for the current window is used instead of the
|
|
|
119 quickfix list.
|
|
|
120
|
|
7
|
121 *:crewind* *:cr*
|
|
|
122 :cr[ewind][!] [nr] Display error [nr]. If [nr] is omitted, the FIRST
|
|
|
123 error is displayed. See |:cc|.
|
|
|
124
|
|
644
|
125 *:lrewind* *:lr*
|
|
|
126 :lr[ewind][!] [nr] Same as ":crewind", except the location list for the
|
|
|
127 current window is used instead of the quickfix list.
|
|
|
128
|
|
7
|
129 *:cfirst* *:cfir*
|
|
|
130 :cfir[st][!] [nr] Same as ":crewind".
|
|
|
131
|
|
644
|
132 *:lfirst* *:lfir*
|
|
|
133 :lfir[st][!] [nr] Same as ":lrewind".
|
|
|
134
|
|
7
|
135 *:clast* *:cla*
|
|
|
136 :cla[st][!] [nr] Display error [nr]. If [nr] is omitted, the LAST
|
|
|
137 error is displayed. See |:cc|.
|
|
|
138
|
|
644
|
139 *:llast* *:lla*
|
|
|
140 :lla[st][!] [nr] Same as ":clast", except the location list for the
|
|
|
141 current window is used instead of the quickfix list.
|
|
|
142
|
|
7
|
143 *:cq* *:cquit*
|
|
|
144 :cq[uit] Quit Vim with an error code, so that the compiler
|
|
|
145 will not compile the same file again.
|
|
|
146
|
|
|
147 *:cf* *:cfile*
|
|
|
148 :cf[ile][!] [errorfile] Read the error file and jump to the first error.
|
|
|
149 This is done automatically when Vim is started with
|
|
|
150 the -q option. You can use this command when you
|
|
|
151 keep Vim running while compiling. If you give the
|
|
|
152 name of the errorfile, the 'errorfile' option will
|
|
|
153 be set to [errorfile]. See |:cc| for [!].
|
|
|
154
|
|
644
|
155 *:lf* *:lfile*
|
|
|
156 :lf[ile][!] [errorfile] Same as ":cfile", except the location list for the
|
|
|
157 current window is used instead of the quickfix list.
|
|
|
158 You can not use the -q command-line option to set
|
|
|
159 the location list.
|
|
|
160
|
|
856
|
161
|
|
647
|
162 :cg[etfile][!] [errorfile] *:cg* *:cgetfile*
|
|
7
|
163 Read the error file. Just like ":cfile" but don't
|
|
|
164 jump to the first error.
|
|
|
165
|
|
856
|
166
|
|
647
|
167 :lg[etfile][!] [errorfile] *:lg* *:lgetfile*
|
|
644
|
168 Same as ":cgetfile", except the location list for the
|
|
|
169 current window is used instead of the quickfix list.
|
|
|
170
|
|
625
|
171 *:caddf* *:caddfile*
|
|
|
172 :caddf[ile] [errorfile] Read the error file and add the errors from the
|
|
446
|
173 errorfile to the current quickfix list. If a quickfix
|
|
|
174 list is not present, then a new list is created.
|
|
|
175
|
|
644
|
176 *:laddf* *:laddfile*
|
|
|
177 :laddf[ile] [errorfile] Same as ":caddfile", except the location list for the
|
|
|
178 current window is used instead of the quickfix list.
|
|
|
179
|
|
41
|
180 *:cb* *:cbuffer* *E681*
|
|
|
181 :cb[uffer] [bufnr] Read the error list from the current buffer.
|
|
|
182 When [bufnr] is given it must be the number of a
|
|
|
183 loaded buffer. That buffer will then be used instead
|
|
|
184 of the current buffer.
|
|
|
185 A range can be specified for the lines to be used.
|
|
|
186 Otherwise all lines in the buffer are used.
|
|
|
187
|
|
644
|
188 *:lb* *:lbuffer*
|
|
|
189 :lb[uffer] [bufnr] Same as ":cbuffer", except the location list for the
|
|
|
190 current window is used instead of the quickfix list.
|
|
|
191
|
|
798
|
192 *:cgetb* *:cgetbuffer*
|
|
|
193 :cgetb[uffer] [bufnr] Read the error list from the current buffer. Just
|
|
|
194 like ":cbuffer" but don't jump to the first error.
|
|
|
195
|
|
|
196 *:lgetb* *:lgetbuffer*
|
|
|
197 :lgetb[uffer] [bufnr] Same as ":cgetbuffer", except the location list for
|
|
|
198 the current window is used instead of the quickfix
|
|
|
199 list.
|
|
|
200
|
|
658
|
201 *:caddb* *:caddbuffer*
|
|
|
202 :caddb[uffer] [bufnr] Read the error list from the current buffer and add
|
|
|
203 the errors to the current quickfix list. If a
|
|
|
204 quickfix list is not present, then a new list is
|
|
|
205 created. Otherwise, same as ":cbuffer".
|
|
|
206
|
|
|
207 *:laddb* *:laddbuffer*
|
|
|
208 :laddb[uffer] [bufnr] Same as ":caddbuffer", except the location list for
|
|
|
209 the current window is used instead of the quickfix
|
|
|
210 list.
|
|
|
211
|
|
626
|
212 *:cex* *:cexpr* *E777*
|
|
625
|
213 :cex[pr][!] {expr} Create a quickfix list using the result of {expr} and
|
|
|
214 jump to the first error. If {expr} is a String, then
|
|
|
215 each new-line terminated line in the String is
|
|
|
216 processed using 'errorformat' and the result is added
|
|
|
217 to the quickfix list. If {expr} is a List, then each
|
|
|
218 String item in the list is processed and added to the
|
|
|
219 quickfix list. Non String items in the List are
|
|
|
220 ignored. See |:cc|
|
|
446
|
221 for [!].
|
|
|
222 Examples: >
|
|
|
223 :cexpr system('grep -n xyz *')
|
|
|
224 :cexpr getline(1, '$')
|
|
|
225 <
|
|
644
|
226 *:lex* *:lexpr*
|
|
|
227 :lex[pr][!] {expr} Same as ":cexpr", except the location list for the
|
|
|
228 current window is used instead of the quickfix list.
|
|
|
229
|
|
800
|
230 *:cgete* *:cgetexpr*
|
|
|
231 :cgete[xpr][!] {expr} Create a quickfix list using the result of {expr}.
|
|
|
232 Just like ":cexpr", but don't jump to the first error.
|
|
|
233
|
|
|
234 *:lgete* *:lgetexpr*
|
|
|
235 :lgete[xpr][!] {expr} Same as ":cgetexpr", except the location list for the
|
|
|
236 current window is used instead of the quickfix list.
|
|
|
237
|
|
625
|
238 *:cad* *:caddexpr*
|
|
|
239 :cad[dexpr][!] {expr} Evaluate {expr} and add the resulting lines to the
|
|
|
240 current quickfix list. If a quickfix list is not
|
|
|
241 present, then a new list is created. The current
|
|
|
242 cursor position will not be changed. See |:cexpr| for
|
|
|
243 more information.
|
|
|
244 Example: >
|
|
|
245 :g/mypattern/caddexpr expand("%") . ":" . line(".") . ":" . getline(".")
|
|
|
246 <
|
|
644
|
247 *:lad* *:laddexpr*
|
|
|
248 :lad[dexpr][!] {expr} Same as ":caddexpr", except the location list for the
|
|
|
249 current window is used instead of the quickfix list.
|
|
|
250
|
|
7
|
251 *:cl* *:clist*
|
|
|
252 :cl[ist] [from] [, [to]]
|
|
|
253 List all errors that are valid |quickfix-valid|.
|
|
|
254 If numbers [from] and/or [to] are given, the respective
|
|
237
|
255 range of errors is listed. A negative number counts
|
|
7
|
256 from the last error backwards, -1 being the last error.
|
|
|
257 The 'switchbuf' settings are respected when jumping
|
|
|
258 to a buffer.
|
|
|
259
|
|
|
260 :cl[ist]! [from] [, [to]]
|
|
|
261 List all errors.
|
|
|
262
|
|
644
|
263 *:lli* *:llist*
|
|
|
264 :lli[st] [from] [, [to]]
|
|
|
265 Same as ":clist", except the location list for the
|
|
|
266 current window is used instead of the quickfix list.
|
|
|
267
|
|
|
268 :lli[st]! [from] [, [to]]
|
|
|
269 List all the entries in the location list for the
|
|
|
270 current window.
|
|
|
271
|
|
7
|
272 If you insert or delete lines, mostly the correct error location is still
|
|
|
273 found because hidden marks are used. Sometimes, when the mark has been
|
|
|
274 deleted for some reason, the message "line changed" is shown to warn you that
|
|
|
275 the error location may not be correct. If you quit Vim and start again the
|
|
|
276 marks are lost and the error locations may not be correct anymore.
|
|
|
277
|
|
163
|
278 If vim is built with |+autocmd| support, two autocommands are available for
|
|
|
279 running commands before and after a quickfix command (':make', ':grep' and so
|
|
|
280 on) is executed. See |QuickFixCmdPre| and |QuickFixCmdPost| for details.
|
|
|
281
|
|
7
|
282 =============================================================================
|
|
|
283 2. The error window *quickfix-window*
|
|
|
284
|
|
|
285 *:cope* *:copen*
|
|
|
286 :cope[n] [height] Open a window to show the current list of errors.
|
|
|
287 When [height] is given, the window becomes that high
|
|
|
288 (if there is room). Otherwise the window is made ten
|
|
|
289 lines high.
|
|
|
290 The window will contain a special buffer, with
|
|
|
291 'buftype' equal to "quickfix". Don't change this!
|
|
|
292 If there already is a quickfix window, it will be made
|
|
|
293 the current window. It is not possible to open a
|
|
|
294 second quickfix window.
|
|
|
295
|
|
647
|
296 *:lop* *:lopen*
|
|
|
297 :lop[en] [height] Open a window to show the location list for the
|
|
644
|
298 current window. Works only when the location list for
|
|
647
|
299 the current window is present. You can have more than
|
|
|
300 one location window opened at a time. Otherwise, it
|
|
648
|
301 acts the same as ":copen".
|
|
644
|
302
|
|
7
|
303 *:ccl* *:cclose*
|
|
|
304 :ccl[ose] Close the quickfix window.
|
|
|
305
|
|
644
|
306 *:lcl* *:lclose*
|
|
|
307 :lcl[ose] Close the window showing the location list for the
|
|
|
308 current window.
|
|
|
309
|
|
7
|
310 *:cw* *:cwindow*
|
|
|
311 :cw[indow] [height] Open the quickfix window when there are recognized
|
|
|
312 errors. If the window is already open and there are
|
|
|
313 no recognized errors, close the window.
|
|
|
314
|
|
644
|
315 *:lw* *:lwindow*
|
|
|
316 :lw[indow] [height] Same as ":cwindow", except use the window showing the
|
|
|
317 location list for the current window.
|
|
7
|
318
|
|
|
319 Normally the quickfix window is at the bottom of the screen. If there are
|
|
|
320 vertical splits, it's at the bottom of the rightmost column of windows. To
|
|
|
321 make it always occupy the full width: >
|
|
|
322 :botright cwindow
|
|
|
323 You can move the window around with |window-moving| commands.
|
|
|
324 For example, to move it to the top: CTRL-W K
|
|
|
325 The 'winfixheight' option will be set, which means that the window will mostly
|
|
|
326 keep its height, ignoring 'winheight' and 'equalalways'. You can change the
|
|
|
327 height manually (e.g., by dragging the status line above it with the mouse).
|
|
|
328
|
|
|
329 In the quickfix window, each line is one error. The line number is equal to
|
|
|
330 the error number. You can use ":.cc" to jump to the error under the cursor.
|
|
170
|
331 Hitting the <Enter> key or double-clicking the mouse on a line has the same
|
|
7
|
332 effect. The file containing the error is opened in the window above the
|
|
|
333 quickfix window. If there already is a window for that file, it is used
|
|
|
334 instead. If the buffer in the used window has changed, and the error is in
|
|
|
335 another file, jumping to the error will fail. You will first have to make
|
|
|
336 sure the window contains a buffer which can be abandoned.
|
|
170
|
337 *CTRL-W_<Enter>* *CTRL-W_<CR>*
|
|
|
338 You can use CTRL-W <Enter> to open a new window and jump to the error there.
|
|
7
|
339
|
|
|
340 When the quickfix window has been filled, two autocommand events are
|
|
|
341 triggered. First the 'filetype' option is set to "qf", which triggers the
|
|
651
|
342 FileType event. Then the BufReadPost event is triggered, using "quickfix" for
|
|
|
343 the buffer name. This can be used to perform some action on the listed
|
|
|
344 errors. Example: >
|
|
648
|
345 au BufReadPost quickfix setlocal modifiable
|
|
|
346 \ | silent exe 'g/^/s//\=line(".")." "/'
|
|
|
347 \ | setlocal nomodifiable
|
|
7
|
348 This prepends the line number to each line. Note the use of "\=" in the
|
|
|
349 substitute string of the ":s" command, which is used to evaluate an
|
|
|
350 expression.
|
|
651
|
351 The BufWinEnter event is also triggered, again using "quickfix" for the buffer
|
|
|
352 name.
|
|
7
|
353
|
|
|
354 Note: Making changes in the quickfix window has no effect on the list of
|
|
|
355 errors. 'modifiable' is off to avoid making changes. If you delete or insert
|
|
|
356 lines anyway, the relation between the text and the error number is messed up.
|
|
|
357 If you really want to do this, you could write the contents of the quickfix
|
|
|
358 window to a file and use ":cfile" to have it parsed and used as the new error
|
|
|
359 list.
|
|
|
360
|
|
644
|
361 *location-list-window*
|
|
648
|
362 The location list window displays the entries in a location list. When you
|
|
|
363 open a location list window, it is created below the current window and
|
|
|
364 displays the location list for the current window. The location list window
|
|
|
365 is similar to the quickfix window, except that you can have more than one
|
|
651
|
366 location list window open at a time. When you use a location list command in
|
|
|
367 this window, the displayed location list is used.
|
|
648
|
368
|
|
|
369 When you select a file from the location list window, the following steps are
|
|
|
370 used to find a window to edit the file:
|
|
644
|
371
|
|
648
|
372 1. If a window with the location list displayed in the location list window is
|
|
|
373 present, then the file is opened in that window.
|
|
|
374 2. If the above step fails and if the file is already opened in another
|
|
|
375 window, then that window is used.
|
|
|
376 3. If the above step fails then an existing window showing a buffer with
|
|
|
377 'buftype' not set is used.
|
|
|
378 4. If the above step fails, then the file is edited in a new window.
|
|
|
379
|
|
|
380 In all of the above cases, if the location list for the selected window is not
|
|
|
381 yet set, then it is set to the location list displayed in the location list
|
|
|
382 window.
|
|
644
|
383
|
|
7
|
384 =============================================================================
|
|
|
385 3. Using more than one list of errors *quickfix-error-lists*
|
|
|
386
|
|
|
387 So far has been assumed that there is only one list of errors. Actually the
|
|
|
388 ten last used lists are remembered. When starting a new list, the previous
|
|
|
389 ones are automatically kept. Two commands can be used to access older error
|
|
|
390 lists. They set one of the existing error lists as the current one.
|
|
|
391
|
|
|
392 *:colder* *:col* *E380*
|
|
|
393 :col[der] [count] Go to older error list. When [count] is given, do
|
|
|
394 this [count] times. When already at the oldest error
|
|
|
395 list, an error message is given.
|
|
|
396
|
|
644
|
397 *:lolder* *:lol*
|
|
|
398 :lol[der] [count] Same as ":colder", except use the location list for
|
|
|
399 the current window instead of the quickfix list.
|
|
|
400
|
|
7
|
401 *:cnewer* *:cnew* *E381*
|
|
|
402 :cnew[er] [count] Go to newer error list. When [count] is given, do
|
|
|
403 this [count] times. When already at the newest error
|
|
|
404 list, an error message is given.
|
|
|
405
|
|
644
|
406 *:lnewer* *:lnew*
|
|
|
407 :lnew[er] [count] Same as ":cnewer", except use the location list for
|
|
|
408 the current window instead of the quickfix list.
|
|
|
409
|
|
7
|
410 When adding a new error list, it becomes the current list.
|
|
|
411
|
|
|
412 When ":colder" has been used and ":make" or ":grep" is used to add a new error
|
|
|
413 list, one newer list is overwritten. This is especially useful if you are
|
|
|
414 browsing with ":grep" |grep|. If you want to keep the more recent error
|
|
|
415 lists, use ":cnewer 99" first.
|
|
|
416
|
|
|
417 =============================================================================
|
|
|
418 4. Using :make *:make_makeprg*
|
|
|
419
|
|
|
420 *:mak* *:make*
|
|
163
|
421 :mak[e][!] [arguments] 1. If vim was built with |+autocmd|, all relevant
|
|
|
422 |QuickFixCmdPre| autocommands are executed.
|
|
|
423 2. If the 'autowrite' option is on, write any changed
|
|
7
|
424 buffers
|
|
163
|
425 3. An errorfile name is made from 'makeef'. If
|
|
7
|
426 'makeef' doesn't contain "##", and a file with this
|
|
|
427 name already exists, it is deleted.
|
|
163
|
428 4. The program given with the 'makeprg' option is
|
|
7
|
429 started (default "make") with the optional
|
|
|
430 [arguments] and the output is saved in the
|
|
|
431 errorfile (for Unix it is also echoed on the
|
|
|
432 screen).
|
|
163
|
433 5. The errorfile is read using 'errorformat'.
|
|
|
434 6. If [!] is not given the first error is jumped to.
|
|
|
435 7. The errorfile is deleted.
|
|
|
436 8. If vim was built with |+autocmd|, all relevant
|
|
|
437 |QuickFixCmdPost| autocommands are executed.
|
|
|
438 9. You can now move through the errors with commands
|
|
7
|
439 like |:cnext| and |:cprevious|, see above.
|
|
|
440 This command does not accept a comment, any "
|
|
|
441 characters are considered part of the arguments.
|
|
|
442
|
|
658
|
443 *:lmak* *:lmake*
|
|
|
444 :lmak[e][!] [arguments]
|
|
|
445 Same as ":make", except the location list for the
|
|
|
446 current window is used instead of the quickfix list.
|
|
|
447
|
|
7
|
448 The ":make" command executes the command given with the 'makeprg' option.
|
|
|
449 This is done by passing the command to the shell given with the 'shell'
|
|
|
450 option. This works almost like typing
|
|
|
451
|
|
|
452 ":!{makeprg} [arguments] {shellpipe} {errorfile}".
|
|
|
453
|
|
|
454 {makeprg} is the string given with the 'makeprg' option. Any command can be
|
|
|
455 used, not just "make". Characters '%' and '#' are expanded as usual on a
|
|
|
456 command-line. You can use "%<" to insert the current file name without
|
|
|
457 extension, or "#<" to insert the alternate file name without extension, for
|
|
|
458 example: >
|
|
|
459 :set makeprg=make\ #<.o
|
|
|
460
|
|
|
461 [arguments] is anything that is typed after ":make".
|
|
|
462 {shellpipe} is the 'shellpipe' option.
|
|
|
463 {errorfile} is the 'makeef' option, with ## replaced to make it unique.
|
|
|
464
|
|
|
465 The placeholder "$*" can be used for the argument list in {makeprog} if the
|
|
|
466 command needs some additional characters after its arguments. The $* is
|
|
|
467 replaced then by all arguments. Example: >
|
|
|
468 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
|
|
|
469 or simpler >
|
|
|
470 :let &mp = 'latex \\nonstopmode \\input\{$*}'
|
|
|
471 "$*" can be given multiple times, for example: >
|
|
|
472 :set makeprg=gcc\ -o\ $*\ $*
|
|
|
473
|
|
|
474 The 'shellpipe' option defaults to ">" for the Amiga, MS-DOS and Win32. This
|
|
|
475 means that the output of the compiler is saved in a file and not shown on the
|
|
|
476 screen directly. For Unix "| tee" is used. The compiler output is shown on
|
|
|
477 the screen and saved in a file the same time. Depending on the shell used
|
|
|
478 "|& tee" or "2>&1| tee" is the default, so stderr output will be included.
|
|
|
479
|
|
|
480 If 'shellpipe' is empty, the {errorfile} part will be omitted. This is useful
|
|
|
481 for compilers that write to an errorfile themselves (e.g., Manx's Amiga C).
|
|
|
482
|
|
|
483 ==============================================================================
|
|
41
|
484 5. Using :vimgrep and :grep *grep* *lid*
|
|
|
485
|
|
|
486 Vim has two ways to find matches for a pattern: Internal and external. The
|
|
|
487 advantage of the internal grep is that it works on all systems and uses the
|
|
|
488 powerful Vim search patterns. An external grep program can be used when the
|
|
|
489 Vim grep does not do what you want.
|
|
|
490
|
|
43
|
491 The internal method will be slower, because files are read into memory. The
|
|
|
492 advantages are:
|
|
|
493 - Line separators and encoding are automatically recognized, as if a file is
|
|
|
494 being edited.
|
|
|
495 - Uses Vim search patterns. Multi-line patterns can be used.
|
|
|
496 - When plugins are enabled: compressed and remote files can be searched.
|
|
|
497 |gzip| |netrw|
|
|
717
|
498
|
|
|
499 To be able to do this Vim loads each file as if it is being edited. When
|
|
720
|
500 there is no match in the file the associated buffer is wiped out again. The
|
|
717
|
501 'hidden' option is ignored here to avoid running out of memory or file
|
|
|
502 descriptors when searching many files. However, when the |:hide| command
|
|
|
503 modifier is used the buffers are kept loaded. This makes following searches
|
|
|
504 in the same files a lot faster.
|
|
41
|
505
|
|
|
506
|
|
|
507 5.1 using Vim's internal grep
|
|
|
508
|
|
86
|
509 *:vim* *:vimgrep* *E682* *E683*
|
|
170
|
510 :vim[grep][!] /{pattern}/[g][j] {file} ...
|
|
41
|
511 Search for {pattern} in the files {file} ... and set
|
|
|
512 the error list to the matches.
|
|
170
|
513 Without the 'g' flag each line is added only once.
|
|
|
514 With 'g' every match is added.
|
|
|
515
|
|
|
516 {pattern} is a Vim search pattern. Instead of
|
|
|
517 enclosing it in / any non-ID character (see
|
|
|
518 |'isident'|) can be used, so long as it does not
|
|
|
519 appear in {pattern}.
|
|
|
520 'ignorecase' applies. To overrule it put |/\c| in the
|
|
|
521 pattern to ignore case or |/\C| to match case.
|
|
|
522 'smartcase' is not used.
|
|
|
523
|
|
716
|
524 When a number is put before the command this is used
|
|
|
525 as the maximum number of matches to find. Use
|
|
|
526 ":1vimgrep pattern file" to find only the first.
|
|
|
527 Useful if you only want to check if there is a match
|
|
|
528 and quit quickly when it's found.
|
|
|
529
|
|
170
|
530 Without the 'j' flag Vim jumps to the first match.
|
|
|
531 With 'j' only the quickfix list is updated.
|
|
|
532 With the [!] any changes in the current buffer are
|
|
|
533 abandoned.
|
|
|
534
|
|
123
|
535 Every second or so the searched file name is displayed
|
|
|
536 to give you an idea of the progress made.
|
|
43
|
537 Examples: >
|
|
|
538 :vimgrep /an error/ *.c
|
|
|
539 :vimgrep /\<FileName\>/ *.h include/*
|
|
445
|
540 :vimgrep /myfunc/ **/*.c
|
|
|
541 < For the use of "**" see |starstar-wildcard|.
|
|
41
|
542
|
|
43
|
543 :vim[grep][!] {pattern} {file} ...
|
|
|
544 Like above, but instead of enclosing the pattern in a
|
|
|
545 non-ID character use a white-separated pattern. The
|
|
|
546 pattern must start with an ID character.
|
|
|
547 Example: >
|
|
|
548 :vimgrep Error *.c
|
|
|
549 <
|
|
658
|
550 *:lv* *:lvimgrep*
|
|
|
551 :lv[imgrep][!] /{pattern}/[g][j] {file} ...
|
|
|
552 :lv[imgrep][!] {pattern} {file} ...
|
|
|
553 Same as ":vimgrep", except the location list for the
|
|
|
554 current window is used instead of the quickfix list.
|
|
|
555
|
|
41
|
556 *:vimgrepa* *:vimgrepadd*
|
|
170
|
557 :vimgrepa[dd][!] /{pattern}/[g][j] {file} ...
|
|
|
558 :vimgrepa[dd][!] {pattern} {file} ...
|
|
41
|
559 Just like ":vimgrep", but instead of making a new list
|
|
|
560 of errors the matches are appended to the current
|
|
|
561 list.
|
|
|
562
|
|
658
|
563 *:lvimgrepa* *:lvimgrepadd*
|
|
|
564 :lvimgrepa[dd][!] /{pattern}/[g][j] {file} ...
|
|
|
565 :lvimgrepa[dd][!] {pattern} {file} ...
|
|
|
566 Same as ":vimgrepadd", except the location list for
|
|
|
567 the current window is used instead of the quickfix
|
|
|
568 list.
|
|
41
|
569
|
|
|
570 5.2 External grep
|
|
7
|
571
|
|
|
572 Vim can interface with "grep" and grep-like programs (such as the GNU
|
|
|
573 id-utils) in a similar way to its compiler integration (see |:make| above).
|
|
|
574
|
|
|
575 [Unix trivia: The name for the Unix "grep" command comes from ":g/re/p", where
|
|
|
576 "re" stands for Regular Expression.]
|
|
|
577
|
|
|
578 *:gr* *:grep*
|
|
|
579 :gr[ep][!] [arguments] Just like ":make", but use 'grepprg' instead of
|
|
|
580 'makeprg' and 'grepformat' instead of 'errorformat'.
|
|
41
|
581 When 'grepprg' is "internal" this works like
|
|
|
582 |:vimgrep|. Note that the pattern needs to be
|
|
|
583 enclosed in separator characters then.
|
|
658
|
584
|
|
|
585 *:lgr* *:lgrep*
|
|
|
586 :lgr[ep][!] [arguments] Same as ":grep", except the location list for the
|
|
|
587 current window is used instead of the quickfix list.
|
|
|
588
|
|
7
|
589 *:grepa* *:grepadd*
|
|
|
590 :grepa[dd][!] [arguments]
|
|
|
591 Just like ":grep", but instead of making a new list of
|
|
|
592 errors the matches are appended to the current list.
|
|
|
593 Example: >
|
|
|
594 :grep nothing %
|
|
|
595 :bufdo grepadd! something %
|
|
|
596 < The first command makes a new error list which is
|
|
|
597 empty. The second command executes "grepadd" for each
|
|
|
598 listed buffer. Note the use of ! to avoid that
|
|
|
599 ":grepadd" jumps to the first error, which is not
|
|
|
600 allowed with |:bufdo|.
|
|
|
601
|
|
658
|
602 *:lgrepa* *:lgrepadd*
|
|
|
603 :lgrepa[dd][!] [arguments]
|
|
|
604 Same as ":grepadd", except the location list for the
|
|
|
605 current window is used instead of the quickfix list.
|
|
|
606
|
|
41
|
607 5.3 Setting up external grep
|
|
7
|
608
|
|
|
609 If you have a standard "grep" program installed, the :grep command may work
|
|
237
|
610 well with the defaults. The syntax is very similar to the standard command: >
|
|
7
|
611
|
|
|
612 :grep foo *.c
|
|
|
613
|
|
237
|
614 Will search all files with the .c extension for the substring "foo". The
|
|
7
|
615 arguments to :grep are passed straight to the "grep" program, so you can use
|
|
|
616 whatever options your "grep" supports.
|
|
|
617
|
|
|
618 By default, :grep invokes grep with the -n option (show file and line
|
|
237
|
619 numbers). You can change this with the 'grepprg' option. You will need to set
|
|
7
|
620 'grepprg' if:
|
|
|
621
|
|
|
622 a) You are using a program that isn't called "grep"
|
|
|
623 b) You have to call grep with a full path
|
|
|
624 c) You want to pass other options automatically (e.g. case insensitive
|
|
|
625 search.)
|
|
|
626
|
|
|
627 Once "grep" has executed, Vim parses the results using the 'grepformat'
|
|
|
628 option. This option works in the same way as the 'errorformat' option - see
|
|
|
629 that for details. You may need to change 'grepformat' from the default if
|
|
|
630 your grep outputs in a non-standard format, or you are using some other
|
|
|
631 program with a special format.
|
|
|
632
|
|
|
633 Once the results are parsed, Vim loads the first file containing a match and
|
|
|
634 jumps to the appropriate line, in the same way that it jumps to a compiler
|
|
|
635 error in |quickfix| mode. You can then use the |:cnext|, |:clist|, etc.
|
|
|
636 commands to see the other matches.
|
|
|
637
|
|
|
638
|
|
41
|
639 5.4 Using :grep with id-utils
|
|
7
|
640
|
|
|
641 You can set up :grep to work with the GNU id-utils like this: >
|
|
|
642
|
|
|
643 :set grepprg=lid\ -Rgrep\ -s
|
|
|
644 :set grepformat=%f:%l:%m
|
|
|
645
|
|
|
646 then >
|
|
|
647 :grep (regexp)
|
|
|
648
|
|
|
649 works just as you'd expect.
|
|
|
650 (provided you remembered to mkid first :)
|
|
|
651
|
|
|
652
|
|
41
|
653 5.5 Browsing source code with :vimgrep or :grep
|
|
7
|
654
|
|
|
655 Using the stack of error lists that Vim keeps, you can browse your files to
|
|
|
656 look for functions and the functions they call. For example, suppose that you
|
|
|
657 have to add an argument to the read_file() function. You enter this command: >
|
|
|
658
|
|
41
|
659 :vimgrep /\<read_file\>/ *.c
|
|
7
|
660
|
|
|
661 You use ":cn" to go along the list of matches and add the argument. At one
|
|
|
662 place you have to get the new argument from a higher level function msg(), and
|
|
|
663 need to change that one too. Thus you use: >
|
|
|
664
|
|
41
|
665 :vimgrep /\<msg\>/ *.c
|
|
7
|
666
|
|
|
667 While changing the msg() functions, you find another function that needs to
|
|
41
|
668 get the argument from a higher level. You can again use ":vimgrep" to find
|
|
|
669 these functions. Once you are finished with one function, you can use >
|
|
7
|
670
|
|
|
671 :colder
|
|
|
672
|
|
|
673 to go back to the previous one.
|
|
|
674
|
|
41
|
675 This works like browsing a tree: ":vimgrep" goes one level deeper, creating a
|
|
7
|
676 list of branches. ":colder" goes back to the previous level. You can mix
|
|
41
|
677 this use of ":vimgrep" and "colder" to browse all the locations in a tree-like
|
|
7
|
678 way. If you do this consistently, you will find all locations without the
|
|
|
679 need to write down a "todo" list.
|
|
|
680
|
|
|
681 =============================================================================
|
|
|
682 6. Selecting a compiler *compiler-select*
|
|
|
683
|
|
|
684 *:comp* *:compiler* *E666*
|
|
|
685 :comp[iler][!] {name} Set options to work with compiler {name}.
|
|
|
686 Without the "!" options are set for the
|
|
|
687 current buffer. With "!" global options are
|
|
|
688 set.
|
|
|
689 If you use ":compiler foo" in "file.foo" and
|
|
|
690 then ":compiler! bar" in another buffer, Vim
|
|
|
691 will keep on using "foo" in "file.foo".
|
|
|
692 {not available when compiled without the
|
|
|
693 |+eval| feature}
|
|
|
694
|
|
|
695
|
|
|
696 The Vim plugins in the "compiler" directory will set options to use the
|
|
|
697 selected compiler. For ":compiler" local options are set, for ":compiler!"
|
|
|
698 global options.
|
|
|
699 *current_compiler*
|
|
|
700 To support older Vim versions, the plugins always use "current_compiler" and
|
|
|
701 not "b:current_compiler". What the command actually does is the following:
|
|
|
702
|
|
|
703 - Delete the "current_compiler" and "b:current_compiler" variables.
|
|
|
704 - Define the "CompilerSet" user command. With "!" it does ":set", without "!"
|
|
|
705 it does ":setlocal".
|
|
|
706 - Execute ":runtime! compiler/{name}.vim". The plugins are expected to set
|
|
|
707 options with "CompilerSet" and set the "current_compiler" variable to the
|
|
|
708 name of the compiler.
|
|
170
|
709 - Delete the "CompilerSet" user command.
|
|
7
|
710 - Set "b:current_compiler" to the value of "current_compiler".
|
|
|
711 - Without "!" the old value of "current_compiler" is restored.
|
|
|
712
|
|
|
713
|
|
|
714 For writing a compiler plugin, see |write-compiler-plugin|.
|
|
|
715
|
|
|
716
|
|
|
717 MANX AZTEC C *quickfix-manx* *compiler-manx*
|
|
|
718
|
|
|
719 To use Vim with Manx's Aztec C compiler on the Amiga you should do the
|
|
|
720 following:
|
|
|
721 - Set the CCEDIT environment variable with the command: >
|
|
|
722 mset "CCEDIT=vim -q"
|
|
|
723 - Compile with the -qf option. If the compiler finds any errors, Vim is
|
|
|
724 started and the cursor is positioned on the first error. The error message
|
|
|
725 will be displayed on the last line. You can go to other errors with the
|
|
|
726 commands mentioned above. You can fix the errors and write the file(s).
|
|
|
727 - If you exit Vim normally the compiler will re-compile the same file. If you
|
|
|
728 exit with the :cq command, the compiler will terminate. Do this if you
|
|
|
729 cannot fix the error, or if another file needs to be compiled first.
|
|
|
730
|
|
|
731 There are some restrictions to the Quickfix mode on the Amiga. The
|
|
|
732 compiler only writes the first 25 errors to the errorfile (Manx's
|
|
|
733 documentation does not say how to get more). If you want to find the others,
|
|
|
734 you will have to fix a few errors and exit the editor. After recompiling,
|
|
|
735 up to 25 remaining errors will be found.
|
|
|
736
|
|
|
737 If Vim was started from the compiler, the :sh and some :! commands will not
|
|
|
738 work, because Vim is then running in the same process as the compiler and
|
|
|
739 stdin (standard input) will not be interactive.
|
|
|
740
|
|
|
741
|
|
|
742 PYUNIT COMPILER *compiler-pyunit*
|
|
|
743
|
|
|
744 This is not actually a compiler, but a unit testing framework for the
|
|
237
|
745 Python language. It is included into standard Python distribution
|
|
|
746 starting from version 2.0. For older versions, you can get it from
|
|
7
|
747 http://pyunit.sourceforge.net.
|
|
|
748
|
|
|
749 When you run your tests with the help of the framework, possible errors
|
|
|
750 are parsed by Vim and presented for you in quick-fix mode.
|
|
|
751
|
|
|
752 Unfortunately, there is no standard way to run the tests.
|
|
|
753 The alltests.py script seems to be used quite often, that's all.
|
|
|
754 Useful values for the 'makeprg' options therefore are:
|
|
|
755 setlocal makeprg=./alltests.py " Run a testsuite
|
|
|
756 setlocal makeprg=python % " Run a single testcase
|
|
|
757
|
|
|
758 Also see http://vim.sourceforge.net/tip_view.php?tip_id=280.
|
|
|
759
|
|
|
760
|
|
|
761 TEX COMPILER *compiler-tex*
|
|
|
762
|
|
|
763 Included in the distribution compiler for TeX ($VIMRUNTIME/compiler/tex.vim)
|
|
237
|
764 uses make command if possible. If the compiler finds a file named "Makefile"
|
|
7
|
765 or "makefile" in the current directory, it supposes that you want to process
|
|
237
|
766 your *TeX files with make, and the makefile does the right work. In this case
|
|
|
767 compiler sets 'errorformat' for *TeX output and leaves 'makeprg' untouched. If
|
|
7
|
768 neither "Makefile" nor "makefile" is found, the compiler will not use make.
|
|
|
769 You can force the compiler to ignore makefiles by defining
|
|
|
770 b:tex_ignore_makefile or g:tex_ignore_makefile variable (they are checked for
|
|
|
771 existence only).
|
|
|
772
|
|
|
773 If the compiler chose not to use make, it need to choose a right program for
|
|
237
|
774 processing your input. If b:tex_flavor or g:tex_flavor (in this precedence)
|
|
7
|
775 variable exists, it defines TeX flavor for :make (actually, this is the name
|
|
|
776 of executed command), and if both variables do not exist, it defaults to
|
|
237
|
777 "latex". For example, while editing chapter2.tex \input-ed from mypaper.tex
|
|
7
|
778 written in AMS-TeX: >
|
|
|
779
|
|
|
780 :let b:tex_flavor = 'amstex'
|
|
|
781 :compiler tex
|
|
|
782 < [editing...] >
|
|
|
783 :make mypaper
|
|
|
784
|
|
|
785 Note that you must specify a name of the file to process as an argument (to
|
|
|
786 process the right file when editing \input-ed or \include-ed file; portable
|
|
237
|
787 solution for substituting % for no arguments is welcome). This is not in the
|
|
7
|
788 semantics of make, where you specify a target, not source, but you may specify
|
|
|
789 filename without extension ".tex" and mean this as "make filename.dvi or
|
|
|
790 filename.pdf or filename.some_result_extension according to compiler".
|
|
|
791
|
|
|
792 Note: tex command line syntax is set to usable both for MikTeX (suggestion
|
|
237
|
793 by Srinath Avadhanula) and teTeX (checked by Artem Chuprina). Suggestion
|
|
7
|
794 from |errorformat-LaTeX| is too complex to keep it working for different
|
|
|
795 shells and OSes and also does not allow to use other available TeX options,
|
|
237
|
796 if any. If your TeX doesn't support "-interaction=nonstopmode", please
|
|
7
|
797 report it with different means to express \nonstopmode from the command line.
|
|
|
798
|
|
|
799 =============================================================================
|
|
|
800 7. The error format *error-file-format*
|
|
|
801
|
|
|
802 *errorformat* *E372* *E373* *E374*
|
|
|
803 *E375* *E376* *E377* *E378*
|
|
|
804 The 'errorformat' option specifies a list of formats that are recognized. The
|
|
|
805 first format that matches with an error message is used. You can add several
|
|
|
806 formats for different messages your compiler produces, or even entries for
|
|
|
807 multiple compilers. See |efm-entries|.
|
|
|
808
|
|
|
809 Each entry in 'errorformat' is a scanf-like string that describes the format.
|
|
|
810 First, you need to know how scanf works. Look in the documentation of your
|
|
|
811 C compiler. Below you find the % items that Vim understands. Others are
|
|
|
812 invalid.
|
|
|
813
|
|
|
814 Special characters in 'errorformat' are comma and backslash. See
|
|
|
815 |efm-entries| for how to deal with them. Note that a literal "%" is matched
|
|
|
816 by "%%", thus it is not escaped with a backslash.
|
|
|
817
|
|
|
818 Note: By default the difference between upper and lowercase is ignored. If
|
|
|
819 you want to match case, add "\C" to the pattern |/\C|.
|
|
|
820
|
|
|
821
|
|
|
822 Basic items
|
|
|
823
|
|
|
824 %f file name (finds a string)
|
|
|
825 %l line number (finds a number)
|
|
|
826 %c column number (finds a number representing character
|
|
|
827 column of the error, (1 <tab> == 1 character column))
|
|
|
828 %v virtual column number (finds a number representing
|
|
|
829 screen column of the error (1 <tab> == 8 screen
|
|
237
|
830 columns))
|
|
7
|
831 %t error type (finds a single character)
|
|
|
832 %n error number (finds a number)
|
|
|
833 %m error message (finds a string)
|
|
|
834 %r matches the "rest" of a single-line file message %O/P/Q
|
|
|
835 %p pointer line (finds a sequence of '-', '.' or ' ' and
|
|
|
836 uses the length for the column number)
|
|
|
837 %*{conv} any scanf non-assignable conversion
|
|
|
838 %% the single '%' character
|
|
231
|
839 %s search text (finds a string)
|
|
7
|
840
|
|
502
|
841 The "%f" conversion may depend on the current 'isfname' setting. "~/" is
|
|
279
|
842 expanded to the home directory and environment variables are expanded.
|
|
7
|
843
|
|
502
|
844 The "%f" and "%m" conversions have to detect the end of the string. This
|
|
534
|
845 normally happens by matching following characters and items. When nothing is
|
|
502
|
846 following the rest of the line is matched. If "%f" is followed by a '%' or a
|
|
|
847 backslash, it will look for a sequence of 'isfname' characters.
|
|
7
|
848
|
|
|
849 On MS-DOS, MS-Windows and OS/2 a leading "C:" will be included in "%f", even
|
|
|
850 when using "%f:". This means that a file name which is a single alphabetical
|
|
|
851 letter will not be detected.
|
|
|
852
|
|
|
853 The "%p" conversion is normally followed by a "^". It's used for compilers
|
|
|
854 that output a line like: >
|
|
|
855 ^
|
|
|
856 or >
|
|
|
857 ---------^
|
|
|
858 to indicate the column of the error. This is to be used in a multi-line error
|
|
|
859 message. See |errorformat-javac| for a useful example.
|
|
|
860
|
|
231
|
861 The "%s" conversion specifies the text to search for to locate the error line.
|
|
|
862 The text is used as a literal string. The anchors "^" and "$" are added to
|
|
|
863 the text to locate the error line exactly matching the search text and the
|
|
|
864 text is prefixed with the "\V" atom to make it "very nomagic". The "%s"
|
|
|
865 conversion can be used to locate lines without a line number in the error
|
|
|
866 output. Like the output of the "grep" shell command.
|
|
|
867 When the pattern is present the line number will not be used.
|
|
7
|
868
|
|
|
869 Changing directory
|
|
|
870
|
|
|
871 The following uppercase conversion characters specify the type of special
|
|
|
872 format strings. At most one of them may be given as a prefix at the begin
|
|
|
873 of a single comma-separated format pattern.
|
|
|
874 Some compilers produce messages that consist of directory names that have to
|
|
237
|
875 be prepended to each file name read by %f (example: GNU make). The following
|
|
7
|
876 codes can be used to scan these directory names; they will be stored in an
|
|
|
877 internal directory stack. *E379*
|
|
|
878 %D "enter directory" format string; expects a following
|
|
|
879 %f that finds the directory name
|
|
|
880 %X "leave directory" format string; expects following %f
|
|
|
881
|
|
|
882 When defining an "enter directory" or "leave directory" format, the "%D" or
|
|
237
|
883 "%X" has to be given at the start of that substring. Vim tracks the directory
|
|
7
|
884 changes and prepends the current directory to each erroneous file found with a
|
|
|
885 relative path. See |quickfix-directory-stack| for details, tips and
|
|
|
886 limitations.
|
|
|
887
|
|
|
888
|
|
|
889 Multi-line messages *errorformat-multi-line*
|
|
|
890
|
|
|
891 It is possible to read the output of programs that produce multi-line
|
|
237
|
892 messages, i.e. error strings that consume more than one line. Possible
|
|
7
|
893 prefixes are:
|
|
|
894 %E start of a multi-line error message
|
|
|
895 %W start of a multi-line warning message
|
|
|
896 %I start of a multi-line informational message
|
|
|
897 %A start of a multi-line message (unspecified type)
|
|
791
|
898 %> for next line start with current pattern again |efm-%>|
|
|
7
|
899 %C continuation of a multi-line message
|
|
|
900 %Z end of a multi-line message
|
|
|
901 These can be used with '+' and '-', see |efm-ignore| below.
|
|
|
902
|
|
787
|
903 Using "\n" in the pattern won't work to match multi-line messages.
|
|
|
904
|
|
7
|
905 Example: Your compiler happens to write out errors in the following format
|
|
|
906 (leading line numbers not being part of the actual output):
|
|
|
907
|
|
787
|
908 1 Error 275 ~
|
|
|
909 2 line 42 ~
|
|
|
910 3 column 3 ~
|
|
|
911 4 ' ' expected after '--' ~
|
|
7
|
912
|
|
|
913 The appropriate error format string has to look like this: >
|
|
|
914 :set efm=%EError\ %n,%Cline\ %l,%Ccolumn\ %c,%Z%m
|
|
|
915
|
|
|
916 And the |:clist| error message generated for this error is:
|
|
|
917
|
|
|
918 1:42 col 3 error 275: ' ' expected after '--'
|
|
|
919
|
|
|
920 Another example: Think of a Python interpreter that produces the following
|
|
|
921 error message (line numbers are not part of the actual output):
|
|
|
922
|
|
|
923 1 ==============================================================
|
|
|
924 2 FAIL: testGetTypeIdCachesResult (dbfacadeTest.DjsDBFacadeTest)
|
|
|
925 3 --------------------------------------------------------------
|
|
|
926 4 Traceback (most recent call last):
|
|
|
927 5 File "unittests/dbfacadeTest.py", line 89, in testFoo
|
|
|
928 6 self.assertEquals(34, dtid)
|
|
|
929 7 File "/usr/lib/python2.2/unittest.py", line 286, in
|
|
|
930 8 failUnlessEqual
|
|
|
931 9 raise self.failureException, \
|
|
|
932 10 AssertionError: 34 != 33
|
|
|
933 11
|
|
|
934 12 --------------------------------------------------------------
|
|
|
935 13 Ran 27 tests in 0.063s
|
|
|
936
|
|
|
937 Say you want |:clist| write the relevant information of this message only,
|
|
|
938 namely:
|
|
|
939 5 unittests/dbfacadeTest.py:89: AssertionError: 34 != 33
|
|
|
940
|
|
|
941 Then the error format string could be defined as follows: >
|
|
|
942 :set efm=%C\ %.%#,%A\ \ File\ \"%f\"\\,\ line\ %l%.%#,%Z%[%^\ ]%\\@=%m
|
|
|
943
|
|
|
944 Note that the %C string is given before the %A here: since the expression
|
|
|
945 ' %.%#' (which stands for the regular expression ' .*') matches every line
|
|
|
946 starting with a space, followed by any characters to the end of the line,
|
|
|
947 it also hides line 7 which would trigger a separate error message otherwise.
|
|
|
948 Error format strings are always parsed pattern by pattern until the first
|
|
|
949 match occurs.
|
|
791
|
950 *efm-%>*
|
|
|
951 The %> item can be used to avoid trying patterns that appear earlier in
|
|
|
952 'errorformat'. This is useful for patterns that match just about anything.
|
|
|
953 For example, if the error looks like this:
|
|
|
954
|
|
|
955 Error in line 123 of foo.c: ~
|
|
|
956 unknown variable "i" ~
|
|
|
957
|
|
|
958 This can be found with: >
|
|
|
959 :set efm=xxx,%E%>Error in line %l of %f:,%Z%m
|
|
|
960 Where "xxx" has a pattern that would also match the second line.
|
|
7
|
961
|
|
787
|
962 Important: There is no memory of what part of the errorformat matched before;
|
|
|
963 every line in the error file gets a complete new run through the error format
|
|
|
964 lines. For example, if one has: >
|
|
|
965 setlocal efm=aa,bb,cc,dd,ee
|
|
|
966 Where aa, bb, etc. are error format strings. Each line of the error file will
|
|
|
967 be matched to the pattern aa, then bb, then cc, etc. Just because cc matched
|
|
|
968 the previous error line does _not_ mean that dd will be tried first on the
|
|
|
969 current line, even if cc and dd are multi-line errorformat strings.
|
|
|
970
|
|
|
971
|
|
7
|
972
|
|
|
973 Separate file name *errorformat-separate-filename*
|
|
|
974
|
|
|
975 These prefixes are useful if the file name is given once and multiple messages
|
|
|
976 follow that refer to this file name.
|
|
|
977 %O single-line file message: overread the matched part
|
|
|
978 %P single-line file message: push file %f onto the stack
|
|
|
979 %Q single-line file message: pop the last file from stack
|
|
|
980
|
|
|
981 Example: Given a compiler that produces the following error logfile (without
|
|
|
982 leading line numbers):
|
|
|
983
|
|
|
984 1 [a1.tt]
|
|
|
985 2 (1,17) error: ';' missing
|
|
|
986 3 (21,2) warning: variable 'z' not defined
|
|
|
987 4 (67,3) error: end of file found before string ended
|
|
|
988 5
|
|
|
989 6 [a2.tt]
|
|
|
990 7
|
|
|
991 8 [a3.tt]
|
|
|
992 9 NEW compiler v1.1
|
|
|
993 10 (2,2) warning: variable 'x' not defined
|
|
|
994 11 (67,3) warning: 's' already defined
|
|
|
995
|
|
|
996 This logfile lists several messages for each file enclosed in [...] which are
|
|
|
997 properly parsed by an error format like this: >
|
|
|
998 :set efm=%+P[%f],(%l\\,%c)%*[\ ]%t%*[^:]:\ %m,%-Q
|
|
|
999
|
|
|
1000 A call of |:clist| writes them accordingly with their correct filenames:
|
|
|
1001
|
|
|
1002 2 a1.tt:1 col 17 error: ';' missing
|
|
|
1003 3 a1.tt:21 col 2 warning: variable 'z' not defined
|
|
|
1004 4 a1.tt:67 col 3 error: end of file found before string ended
|
|
|
1005 8 a3.tt:2 col 2 warning: variable 'x' not defined
|
|
|
1006 9 a3.tt:67 col 3 warning: 's' already defined
|
|
|
1007
|
|
|
1008 Unlike the other prefixes that all match against whole lines, %P, %Q and %O
|
|
237
|
1009 can be used to match several patterns in the same line. Thus it is possible
|
|
7
|
1010 to parse even nested files like in the following line:
|
|
|
1011 {"file1" {"file2" error1} error2 {"file3" error3 {"file4" error4 error5}}}
|
|
|
1012 The %O then parses over strings that do not contain any push/pop file name
|
|
|
1013 information. See |errorformat-LaTeX| for an extended example.
|
|
|
1014
|
|
|
1015
|
|
|
1016 Ignoring and using whole messages *efm-ignore*
|
|
|
1017
|
|
|
1018 The codes '+' or '-' can be combined with the uppercase codes above; in that
|
|
237
|
1019 case they have to precede the letter, e.g. '%+A' or '%-G':
|
|
7
|
1020 %- do not include the matching multi-line in any output
|
|
|
1021 %+ include the whole matching line in the %m error string
|
|
|
1022
|
|
237
|
1023 One prefix is only useful in combination with '+' or '-', namely %G. It parses
|
|
7
|
1024 over lines containing general information like compiler version strings or
|
|
|
1025 other headers that can be skipped.
|
|
|
1026 %-G ignore this message
|
|
|
1027 %+G general message
|
|
|
1028
|
|
|
1029
|
|
|
1030 Pattern matching
|
|
|
1031
|
|
|
1032 The scanf()-like "%*[]" notation is supported for backward-compatibility
|
|
|
1033 with previous versions of Vim. However, it is also possible to specify
|
|
|
1034 (nearly) any Vim supported regular expression in format strings.
|
|
|
1035 Since meta characters of the regular expression language can be part of
|
|
|
1036 ordinary matching strings or file names (and therefore internally have to
|
|
|
1037 be escaped), meta symbols have to be written with leading '%':
|
|
787
|
1038 %\ The single '\' character. Note that this has to be
|
|
7
|
1039 escaped ("%\\") in ":set errorformat=" definitions.
|
|
787
|
1040 %. The single '.' character.
|
|
|
1041 %# The single '*'(!) character.
|
|
|
1042 %^ The single '^' character. Note that this is not
|
|
|
1043 useful, the pattern already matches start of line.
|
|
|
1044 %$ The single '$' character. Note that this is not
|
|
|
1045 useful, the pattern already matches end of line.
|
|
|
1046 %[ The single '[' character for a [] character range.
|
|
|
1047 %~ The single '~' character.
|
|
7
|
1048 When using character classes in expressions (see |/\i| for an overview),
|
|
|
1049 terms containing the "\+" quantifier can be written in the scanf() "%*"
|
|
237
|
1050 notation. Example: "%\\d%\\+" ("\d\+", "any number") is equivalent to "%*\\d".
|
|
7
|
1051 Important note: The \(...\) grouping of sub-matches can not be used in format
|
|
|
1052 specifications because it is reserved for internal conversions.
|
|
|
1053
|
|
|
1054
|
|
|
1055 Multiple entries in 'errorformat' *efm-entries*
|
|
|
1056
|
|
|
1057 To be able to detect output from several compilers, several format patterns
|
|
|
1058 may be put in 'errorformat', separated by commas (note: blanks after the comma
|
|
|
1059 are ignored). The first pattern that has a complete match is used. If no
|
|
|
1060 match is found, matching parts from the last one will be used, although the
|
|
|
1061 file name is removed and the error message is set to the whole message. If
|
|
|
1062 there is a pattern that may match output from several compilers (but not in a
|
|
|
1063 right way), put it after one that is more restrictive.
|
|
|
1064
|
|
|
1065 To include a comma in a pattern precede it with a backslash (you have to type
|
|
|
1066 two in a ":set" command). To include a backslash itself give two backslashes
|
|
|
1067 (you have to type four in a ":set" command). You also need to put a backslash
|
|
|
1068 before a space for ":set".
|
|
|
1069
|
|
|
1070
|
|
|
1071 Valid matches *quickfix-valid*
|
|
|
1072
|
|
|
1073 If a line does not completely match one of the entries in 'errorformat', the
|
|
|
1074 whole line is put in the error message and the entry is marked "not valid"
|
|
|
1075 These lines are skipped with the ":cn" and ":cp" commands (unless there is
|
|
|
1076 no valid line at all). You can use ":cl!" to display all the error messages.
|
|
|
1077
|
|
|
1078 If the error format does not contain a file name Vim cannot switch to the
|
|
|
1079 correct file. You will have to do this by hand.
|
|
|
1080
|
|
|
1081
|
|
|
1082 Examples
|
|
|
1083
|
|
|
1084 The format of the file from the Amiga Aztec compiler is:
|
|
|
1085
|
|
|
1086 filename>linenumber:columnnumber:errortype:errornumber:errormessage
|
|
|
1087
|
|
|
1088 filename name of the file in which the error was detected
|
|
|
1089 linenumber line number where the error was detected
|
|
|
1090 columnnumber column number where the error was detected
|
|
|
1091 errortype type of the error, normally a single 'E' or 'W'
|
|
|
1092 errornumber number of the error (for lookup in the manual)
|
|
|
1093 errormessage description of the error
|
|
|
1094
|
|
|
1095 This can be matched with this 'errorformat' entry:
|
|
|
1096 %f>%l:%c:%t:%n:%m
|
|
|
1097
|
|
|
1098 Some examples for C compilers that produce single-line error outputs:
|
|
|
1099 %f:%l:\ %t%*[^0123456789]%n:\ %m for Manx/Aztec C error messages
|
|
|
1100 (scanf() doesn't understand [0-9])
|
|
|
1101 %f\ %l\ %t%*[^0-9]%n:\ %m for SAS C
|
|
|
1102 \"%f\"\\,%*[^0-9]%l:\ %m for generic C compilers
|
|
|
1103 %f:%l:\ %m for GCC
|
|
|
1104 %f:%l:\ %m,%Dgmake[%*\\d]:\ Entering\ directory\ `%f',
|
|
|
1105 %Dgmake[%*\\d]:\ Leaving\ directory\ `%f'
|
|
|
1106 for GCC with gmake (concat the lines!)
|
|
|
1107 %f(%l)\ :\ %*[^:]:\ %m old SCO C compiler (pre-OS5)
|
|
|
1108 %f(%l)\ :\ %t%*[^0-9]%n:\ %m idem, with error type and number
|
|
|
1109 %f:%l:\ %m,In\ file\ included\ from\ %f:%l:,\^I\^Ifrom\ %f:%l%m
|
|
|
1110 for GCC, with some extras
|
|
|
1111
|
|
|
1112 Extended examples for the handling of multi-line messages are given below,
|
|
|
1113 see |errorformat-Jikes| and |errorformat-LaTeX|.
|
|
|
1114
|
|
|
1115 Note the backslash in front of a space and double quote. It is required for
|
|
|
1116 the :set command. There are two backslashes in front of a comma, one for the
|
|
|
1117 :set command and one to avoid recognizing the comma as a separator of error
|
|
|
1118 formats.
|
|
|
1119
|
|
|
1120
|
|
|
1121 Filtering messages
|
|
|
1122
|
|
|
1123 If you have a compiler that produces error messages that do not fit in the
|
|
|
1124 format string, you could write a program that translates the error messages
|
|
|
1125 into this format. You can use this program with the ":make" command by
|
|
|
1126 changing the 'makeprg' option. For example: >
|
|
|
1127 :set mp=make\ \\\|&\ error_filter
|
|
|
1128 The backslashes before the pipe character are required to avoid it to be
|
|
|
1129 recognized as a command separator. The backslash before each space is
|
|
|
1130 required for the set command.
|
|
|
1131
|
|
|
1132 =============================================================================
|
|
|
1133 8. The directory stack *quickfix-directory-stack*
|
|
|
1134
|
|
|
1135 Quickfix maintains a stack for saving all used directories parsed from the
|
|
237
|
1136 make output. For GNU-make this is rather simple, as it always prints the
|
|
|
1137 absolute path of all directories it enters and leaves. Regardless if this is
|
|
7
|
1138 done via a 'cd' command in the makefile or with the parameter "-C dir" (change
|
|
237
|
1139 to directory before reading the makefile). It may be useful to use the switch
|
|
7
|
1140 "-w" to force GNU-make to print out the working directory before and after
|
|
|
1141 processing.
|
|
|
1142
|
|
|
1143 Maintaining the correct directory is more complicated if you don't use
|
|
237
|
1144 GNU-make. AIX-make for example doesn't print any information about its
|
|
|
1145 working directory. Then you need to enhance the makefile. In the makefile of
|
|
|
1146 LessTif there is a command which echoes "Making {target} in {dir}". The
|
|
|
1147 special problem here is that it doesn't print informations on leaving the
|
|
|
1148 directory and that it doesn't print the absolute path.
|
|
7
|
1149
|
|
|
1150 To solve the problem with relative paths and missing "leave directory"
|
|
|
1151 messages Vim uses following algorithm:
|
|
|
1152
|
|
|
1153 1) Check if the given directory is a subdirectory of the current directory.
|
|
|
1154 If this is true, store it as the current directory.
|
|
|
1155 2) If it is not a subdir of the current directory, try if this is a
|
|
|
1156 subdirectory of one of the upper directories.
|
|
|
1157 3) If the directory still isn't found, it is assumed to be a subdirectory
|
|
|
1158 of Vim's current directory.
|
|
|
1159
|
|
|
1160 Additionally it is checked for every file, if it really exists in the
|
|
|
1161 identified directory. If not, it is searched in all other directories of the
|
|
237
|
1162 directory stack (NOT the directory subtree!). If it is still not found, it is
|
|
7
|
1163 assumed that it is in Vim's current directory.
|
|
|
1164
|
|
237
|
1165 There are limitation in this algorithm. This examples assume that make just
|
|
7
|
1166 prints information about entering a directory in the form "Making all in dir".
|
|
|
1167
|
|
|
1168 1) Assume you have following directories and files:
|
|
|
1169 ./dir1
|
|
|
1170 ./dir1/file1.c
|
|
|
1171 ./file1.c
|
|
|
1172
|
|
|
1173 If make processes the directory "./dir1" before the current directory and
|
|
|
1174 there is an error in the file "./file1.c", you will end up with the file
|
|
|
1175 "./dir1/file.c" loaded by Vim.
|
|
|
1176
|
|
|
1177 This can only be solved with a "leave directory" message.
|
|
|
1178
|
|
|
1179 2) Assume you have following directories and files:
|
|
|
1180 ./dir1
|
|
|
1181 ./dir1/dir2
|
|
|
1182 ./dir2
|
|
|
1183
|
|
|
1184 You get the following:
|
|
|
1185
|
|
|
1186 Make output Directory interpreted by Vim
|
|
|
1187 ------------------------ ----------------------------
|
|
|
1188 Making all in dir1 ./dir1
|
|
|
1189 Making all in dir2 ./dir1/dir2
|
|
|
1190 Making all in dir2 ./dir1/dir2
|
|
|
1191
|
|
|
1192 This can be solved by printing absolute directories in the "enter directory"
|
|
|
1193 message or by printing "leave directory" messages..
|
|
|
1194
|
|
|
1195 To avoid this problems, ensure to print absolute directory names and "leave
|
|
|
1196 directory" messages.
|
|
|
1197
|
|
|
1198 Examples for Makefiles:
|
|
|
1199
|
|
|
1200 Unix:
|
|
|
1201 libs:
|
|
|
1202 for dn in $(LIBDIRS); do \
|
|
|
1203 (cd $$dn; echo "Entering dir '$$(pwd)'"; make); \
|
|
|
1204 echo "Leaving dir"; \
|
|
|
1205 done
|
|
|
1206
|
|
|
1207 Add
|
|
|
1208 %DEntering\ dir\ '%f',%XLeaving\ dir
|
|
|
1209 to your 'errorformat' to handle the above output.
|
|
|
1210
|
|
|
1211 Note that Vim doesn't check if the directory name in a "leave directory"
|
|
237
|
1212 messages is the current directory. This is why you could just use the message
|
|
7
|
1213 "Leaving dir".
|
|
|
1214
|
|
|
1215 =============================================================================
|
|
|
1216 9. Specific error file formats *errorformats*
|
|
|
1217
|
|
|
1218 *errorformat-Jikes*
|
|
|
1219 Jikes(TM), a source-to-bytecode Java compiler published by IBM Research,
|
|
|
1220 produces simple multi-line error messages.
|
|
|
1221
|
|
|
1222 An 'errorformat' string matching the produced messages is shown below.
|
|
|
1223 The following lines can be placed in the user's |vimrc| to overwrite Vim's
|
|
|
1224 recognized default formats, or see |:set+=| how to install this format
|
|
|
1225 additionally to the default. >
|
|
|
1226
|
|
|
1227 :set efm=%A%f:%l:%c:%*\\d:%*\\d:,
|
|
|
1228 \%C%*\\s%trror:%m,
|
|
|
1229 \%+C%*[^:]%trror:%m,
|
|
|
1230 \%C%*\\s%tarning:%m,
|
|
|
1231 \%C%m
|
|
|
1232 <
|
|
|
1233 Jikes(TM) produces a single-line error message when invoked with the option
|
|
|
1234 "+E", and can be matched with the following: >
|
|
|
1235
|
|
|
1236 :set efm=%f:%l:%v:%*\\d:%*\\d:%*\\s%m
|
|
|
1237 <
|
|
|
1238 *errorformat-javac*
|
|
|
1239 This 'errorformat' has been reported to work well for javac, which outputs a
|
|
|
1240 line with "^" to indicate the column of the error: >
|
|
|
1241 :set efm=%A%f:%l:\ %m,%-Z%p^,%-C%.%#
|
|
|
1242 or: >
|
|
|
1243 :set efm=%A%f:%l:\ %m,%+Z%p^,%+C%.%#,%-G%.%#
|
|
|
1244 <
|
|
|
1245 *errorformat-ant*
|
|
|
1246 For ant (http://jakarta.apache.org/) the above errorformat has to be modified
|
|
|
1247 to honour the leading [javac] in front of each javac output line: >
|
|
|
1248 :set efm=%A\ %#[javac]\ %f:%l:\ %m,%-Z\ %#[javac]\ %p^,%-C%.%#
|
|
|
1249
|
|
|
1250 The 'errorformat' can also be configured to handle ant together with either
|
|
|
1251 javac or jikes. If you're using jikes, you should tell ant to use jikes' +E
|
|
|
1252 command line switch which forces jikes to generate one-line error messages.
|
|
|
1253 This is what the second line (of a build.xml file) below does: >
|
|
|
1254 <property name = "build.compiler" value = "jikes"/>
|
|
|
1255 <property name = "build.compiler.emacs" value = "true"/>
|
|
|
1256
|
|
|
1257 The 'errorformat' which handles ant with both javac and jikes is: >
|
|
|
1258 :set efm=\ %#[javac]\ %#%f:%l:%c:%*\\d:%*\\d:\ %t%[%^:]%#:%m,
|
|
|
1259 \%A\ %#[javac]\ %f:%l:\ %m,%-Z\ %#[javac]\ %p^,%-C%.%#
|
|
|
1260 <
|
|
|
1261 *errorformat-jade*
|
|
|
1262 parsing jade (see http://www.jclark.com/) errors is simple: >
|
|
|
1263 :set efm=jade:%f:%l:%c:%t:%m
|
|
|
1264 <
|
|
|
1265 *errorformat-LaTeX*
|
|
|
1266 The following is an example how an 'errorformat' string can be specified
|
|
|
1267 for the (La)TeX typesetting system which displays error messages over
|
|
|
1268 multiple lines. The output of ":clist" and ":cc" etc. commands displays
|
|
|
1269 multi-lines in a single line, leading white space is removed.
|
|
|
1270 It should be easy to adopt the above LaTeX errorformat to any compiler output
|
|
|
1271 consisting of multi-line errors.
|
|
|
1272
|
|
|
1273 The commands can be placed in a |vimrc| file or some other Vim script file,
|
|
237
|
1274 e.g. a script containing LaTeX related stuff which is loaded only when editing
|
|
7
|
1275 LaTeX sources.
|
|
|
1276 Make sure to copy all lines of the example (in the given order), afterwards
|
|
|
1277 remove the comment lines. For the '\' notation at the start of some lines see
|
|
|
1278 |line-continuation|.
|
|
|
1279
|
|
|
1280 First prepare 'makeprg' such that LaTeX will report multiple
|
|
|
1281 errors; do not stop when the first error has occurred: >
|
|
|
1282 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
|
|
|
1283 <
|
|
|
1284 Start of multi-line error messages: >
|
|
|
1285 :set efm=%E!\ LaTeX\ %trror:\ %m,
|
|
|
1286 \%E!\ %m,
|
|
|
1287 < Start of multi-line warning messages; the first two also
|
|
237
|
1288 include the line number. Meaning of some regular expressions:
|
|
7
|
1289 - "%.%#" (".*") matches a (possibly empty) string
|
|
|
1290 - "%*\\d" ("\d\+") matches a number >
|
|
|
1291 \%+WLaTeX\ %.%#Warning:\ %.%#line\ %l%.%#,
|
|
|
1292 \%+W%.%#\ at\ lines\ %l--%*\\d,
|
|
|
1293 \%WLaTeX\ %.%#Warning:\ %m,
|
|
|
1294 < Possible continuations of error/warning messages; the first
|
|
|
1295 one also includes the line number: >
|
|
|
1296 \%Cl.%l\ %m,
|
|
|
1297 \%+C\ \ %m.,
|
|
|
1298 \%+C%.%#-%.%#,
|
|
|
1299 \%+C%.%#[]%.%#,
|
|
|
1300 \%+C[]%.%#,
|
|
|
1301 \%+C%.%#%[{}\\]%.%#,
|
|
|
1302 \%+C<%.%#>%.%#,
|
|
|
1303 \%C\ \ %m,
|
|
|
1304 < Lines that match the following patterns do not contain any
|
|
|
1305 important information; do not include them in messages: >
|
|
|
1306 \%-GSee\ the\ LaTeX%m,
|
|
|
1307 \%-GType\ \ H\ <return>%m,
|
|
|
1308 \%-G\ ...%.%#,
|
|
|
1309 \%-G%.%#\ (C)\ %.%#,
|
|
|
1310 \%-G(see\ the\ transcript%.%#),
|
|
|
1311 < Generally exclude any empty or whitespace-only line from
|
|
|
1312 being displayed: >
|
|
|
1313 \%-G\\s%#,
|
|
|
1314 < The LaTeX output log does not specify the names of erroneous
|
|
|
1315 source files per line; rather they are given globally,
|
|
|
1316 enclosed in parentheses.
|
|
|
1317 The following patterns try to match these names and store
|
|
|
1318 them in an internal stack. The patterns possibly scan over
|
|
|
1319 the same input line (one after another), the trailing "%r"
|
|
|
1320 conversion indicates the "rest" of the line that will be
|
|
|
1321 parsed in the next go until the end of line is reached.
|
|
|
1322
|
|
|
1323 Overread a file name enclosed in '('...')'; do not push it
|
|
|
1324 on a stack since the file apparently does not contain any
|
|
|
1325 error: >
|
|
|
1326 \%+O(%f)%r,
|
|
237
|
1327 < Push a file name onto the stack. The name is given after '(': >
|
|
7
|
1328 \%+P(%f%r,
|
|
|
1329 \%+P\ %\\=(%f%r,
|
|
|
1330 \%+P%*[^()](%f%r,
|
|
|
1331 \%+P[%\\d%[^()]%#(%f%r,
|
|
|
1332 < Pop the last stored file name when a ')' is scanned: >
|
|
|
1333 \%+Q)%r,
|
|
|
1334 \%+Q%*[^()])%r,
|
|
|
1335 \%+Q[%\\d%*[^()])%r
|
|
|
1336
|
|
|
1337 Note that in some cases file names in the LaTeX output log cannot be parsed
|
|
|
1338 properly. The parser might have been messed up by unbalanced parentheses
|
|
|
1339 then. The above example tries to catch the most relevant cases only.
|
|
|
1340 You can customize the given setting to suit your own purposes, for example,
|
|
|
1341 all the annoying "Overfull ..." warnings could be excluded from being
|
|
|
1342 recognized as an error.
|
|
|
1343 Alternatively to filtering the LaTeX compiler output, it is also possible
|
|
|
1344 to directly read the *.log file that is produced by the [La]TeX compiler.
|
|
|
1345 This contains even more useful information about possible error causes.
|
|
|
1346 However, to properly parse such a complex file, an external filter should
|
|
|
1347 be used. See the description further above how to make such a filter known
|
|
|
1348 by Vim.
|
|
|
1349
|
|
|
1350 *errorformat-Perl*
|
|
|
1351 In $VIMRUNTIME/tools you can find the efm_perl.pl script, which filters Perl
|
|
|
1352 error messages into a format that quickfix mode will understand. See the
|
|
|
1353 start of the file about how to use it.
|
|
|
1354
|
|
|
1355
|
|
|
1356
|
|
|
1357 vim:tw=78:ts=8:ft=help:norl:
|
