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