blob: 4814a09d6ca5fcc5455aa4d26ff0c8f43ff26c72 [file] [log] [blame]
Bram Moolenaarb3656ed2006-03-20 21:59:49 +00001*quickfix.txt* For Vim version 7.0aa. Last change: 2006 Mar 20
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7This subject is introduced in section |30.1| of the user manual.
8
91. Using QuickFix commands |quickfix|
102. The error window |quickfix-window|
113. Using more than one list of errors |quickfix-error-lists|
124. Using :make |:make_makeprg|
135. Using :grep |grep|
146. Selecting a compiler |compiler-select|
157. The error format |error-file-format|
168. The directory stack |quickfix-directory-stack|
179. Specific error file formats |errorformats|
18
19{Vi does not have any of these commands}
20
21The quickfix commands are not available when the |+quickfix| feature was
22disabled at compile time.
23
24=============================================================================
251. Using QuickFix commands *quickfix* *Quickfix* *E42*
26
27Vim has a special mode to speedup the edit-compile-edit cycle. This is
28inspired by the quickfix option of the Manx's Aztec C compiler on the Amiga.
29The idea is to save the error messages from the compiler in a file and use Vim
30to jump to the errors one by one. You can examine each problem and fix it,
31without having to remember all the error messages.
32
Bram Moolenaar05159a02005-02-26 23:04:13 +000033In Vim the quickfix commands are used more generally to find a list of
34positions in files. For example, |:vimgrep| finds pattern matches. You can
Bram Moolenaar2641f772005-03-25 21:58:17 +000035use the positions in a script with the |getqflist()| function. Thus you can
Bram Moolenaar05159a02005-02-26 23:04:13 +000036do a lot more than the edit/compile/fix cycle!
37
Bram Moolenaar071d4272004-06-13 20:20:40 +000038If you are using Manx's Aztec C compiler on the Amiga look here for how to use
39it with Vim: |quickfix-manx|. If you are using another compiler you should
40save the error messages in a file and start Vim with "vim -q filename". An
41easy 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
43compiler (see |errorformat| below).
44
Bram Moolenaard12f5c12006-01-25 22:10:52 +000045 *location-list* *E776*
Bram Moolenaar280f1262006-01-30 00:14:18 +000046A location list is similar to a quickfix list and contains a list of positions
47in files. A location list is associated with a window and each window can
48have a separate location list. A location list can be associated with only
49one window. The location list is independent of the quickfix list.
Bram Moolenaard12f5c12006-01-25 22:10:52 +000050
Bram Moolenaar280f1262006-01-30 00:14:18 +000051When a window with a location list is split, the new window gets a copy of the
52location list. When there are no references to a location list, the location
53list is destroyed.
54
55The following quickfix commands can be used. The location list commands are
56similar to the quickfix commands, replacing the 'c' prefix in the quickfix
57command with 'l'.
Bram Moolenaar071d4272004-06-13 20:20:40 +000058
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
Bram Moolenaard12f5c12006-01-25 22:10:52 +000071 *:ll*
72:ll[!] [nr] Same as ":cc", except the location list for the
73 current window is used instead of the quickfix list.
74
Bram Moolenaar071d4272004-06-13 20:20:40 +000075 *: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
Bram Moolenaar17c7c012006-01-26 22:25:15 +000081 *:lne* *:lnext*
82:[count]lne[xt][!] Same as ":cnext", except the location list for the
Bram Moolenaard12f5c12006-01-25 22:10:52 +000083 current window is used instead of the quickfix list.
84
Bram Moolenaar071d4272004-06-13 20:20:40 +000085:[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
Bram Moolenaar17c7c012006-01-26 22:25:15 +000091
92:[count]lN[ext][!] *:lp* *:lprevious* *:lN* *:lNext*
Bram Moolenaard12f5c12006-01-25 22:10:52 +000093:[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
Bram Moolenaar071d4272004-06-13 20:20:40 +000097 *: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
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000104 *: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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000108:[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
Bram Moolenaar17c7c012006-01-26 22:25:15 +0000115
116:[count]lNf[ile][!] *:lpf* *:lpfile* *:lNf* *:lNfile*
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000117:[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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000121 *:crewind* *:cr*
122:cr[ewind][!] [nr] Display error [nr]. If [nr] is omitted, the FIRST
123 error is displayed. See |:cc|.
124
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000125 *: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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129 *:cfirst* *:cfir*
130:cfir[st][!] [nr] Same as ":crewind".
131
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000132 *:lfirst* *:lfir*
133:lfir[st][!] [nr] Same as ":lrewind".
134
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135 *:clast* *:cla*
136:cla[st][!] [nr] Display error [nr]. If [nr] is omitted, the LAST
137 error is displayed. See |:cc|.
138
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000139 *: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
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143 *: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
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000155 *: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
Bram Moolenaar17c7c012006-01-26 22:25:15 +0000161
162:cg[etfile][!] [errorfile] *:cg* *:cgetfile*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000163 Read the error file. Just like ":cfile" but don't
164 jump to the first error.
165
Bram Moolenaar17c7c012006-01-26 22:25:15 +0000166
167:lg[etfile][!] [errorfile] *:lg* *:lgetfile*
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000168 Same as ":cgetfile", except the location list for the
169 current window is used instead of the quickfix list.
170
Bram Moolenaar4770d092006-01-12 23:22:24 +0000171 *:caddf* *:caddfile*
172:caddf[ile] [errorfile] Read the error file and add the errors from the
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000173 errorfile to the current quickfix list. If a quickfix
174 list is not present, then a new list is created.
175
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000176 *: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
Bram Moolenaar86b68352004-12-27 21:59:20 +0000180 *: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
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000188 *: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
Bram Moolenaar9f2c6e12006-02-04 22:45:44 +0000192 *:caddb* *:caddbuffer*
193:caddb[uffer] [bufnr] Read the error list from the current buffer and add
194 the errors to the current quickfix list. If a
195 quickfix list is not present, then a new list is
196 created. Otherwise, same as ":cbuffer".
197
198 *:laddb* *:laddbuffer*
199:laddb[uffer] [bufnr] Same as ":caddbuffer", except the location list for
200 the current window is used instead of the quickfix
201 list.
202
Bram Moolenaara40ceaf2006-01-13 22:35:40 +0000203 *:cex* *:cexpr* *E777*
Bram Moolenaar4770d092006-01-12 23:22:24 +0000204:cex[pr][!] {expr} Create a quickfix list using the result of {expr} and
205 jump to the first error. If {expr} is a String, then
206 each new-line terminated line in the String is
207 processed using 'errorformat' and the result is added
208 to the quickfix list. If {expr} is a List, then each
209 String item in the list is processed and added to the
210 quickfix list. Non String items in the List are
211 ignored. See |:cc|
Bram Moolenaar87e25fd2005-07-27 21:13:01 +0000212 for [!].
213 Examples: >
214 :cexpr system('grep -n xyz *')
215 :cexpr getline(1, '$')
216<
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000217 *:lex* *:lexpr*
218:lex[pr][!] {expr} Same as ":cexpr", except the location list for the
219 current window is used instead of the quickfix list.
220
Bram Moolenaar4770d092006-01-12 23:22:24 +0000221 *:cad* *:caddexpr*
222:cad[dexpr][!] {expr} Evaluate {expr} and add the resulting lines to the
223 current quickfix list. If a quickfix list is not
224 present, then a new list is created. The current
225 cursor position will not be changed. See |:cexpr| for
226 more information.
227 Example: >
228 :g/mypattern/caddexpr expand("%") . ":" . line(".") . ":" . getline(".")
229<
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000230 *:lad* *:laddexpr*
231:lad[dexpr][!] {expr} Same as ":caddexpr", except the location list for the
232 current window is used instead of the quickfix list.
233
Bram Moolenaar071d4272004-06-13 20:20:40 +0000234 *:cl* *:clist*
235:cl[ist] [from] [, [to]]
236 List all errors that are valid |quickfix-valid|.
237 If numbers [from] and/or [to] are given, the respective
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000238 range of errors is listed. A negative number counts
Bram Moolenaar071d4272004-06-13 20:20:40 +0000239 from the last error backwards, -1 being the last error.
240 The 'switchbuf' settings are respected when jumping
241 to a buffer.
242
243:cl[ist]! [from] [, [to]]
244 List all errors.
245
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000246 *:lli* *:llist*
247:lli[st] [from] [, [to]]
248 Same as ":clist", except the location list for the
249 current window is used instead of the quickfix list.
250
251:lli[st]! [from] [, [to]]
252 List all the entries in the location list for the
253 current window.
254
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255If you insert or delete lines, mostly the correct error location is still
256found because hidden marks are used. Sometimes, when the mark has been
257deleted for some reason, the message "line changed" is shown to warn you that
258the error location may not be correct. If you quit Vim and start again the
259marks are lost and the error locations may not be correct anymore.
260
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +0000261If vim is built with |+autocmd| support, two autocommands are available for
262running commands before and after a quickfix command (':make', ':grep' and so
263on) is executed. See |QuickFixCmdPre| and |QuickFixCmdPost| for details.
264
Bram Moolenaar071d4272004-06-13 20:20:40 +0000265=============================================================================
2662. The error window *quickfix-window*
267
268 *:cope* *:copen*
269:cope[n] [height] Open a window to show the current list of errors.
270 When [height] is given, the window becomes that high
271 (if there is room). Otherwise the window is made ten
272 lines high.
273 The window will contain a special buffer, with
274 'buftype' equal to "quickfix". Don't change this!
275 If there already is a quickfix window, it will be made
276 the current window. It is not possible to open a
277 second quickfix window.
278
Bram Moolenaar17c7c012006-01-26 22:25:15 +0000279 *:lop* *:lopen*
280:lop[en] [height] Open a window to show the location list for the
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000281 current window. Works only when the location list for
Bram Moolenaar17c7c012006-01-26 22:25:15 +0000282 the current window is present. You can have more than
283 one location window opened at a time. Otherwise, it
Bram Moolenaar280f1262006-01-30 00:14:18 +0000284 acts the same as ":copen".
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000285
Bram Moolenaar071d4272004-06-13 20:20:40 +0000286 *:ccl* *:cclose*
287:ccl[ose] Close the quickfix window.
288
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000289 *:lcl* *:lclose*
290:lcl[ose] Close the window showing the location list for the
291 current window.
292
Bram Moolenaar071d4272004-06-13 20:20:40 +0000293 *:cw* *:cwindow*
294:cw[indow] [height] Open the quickfix window when there are recognized
295 errors. If the window is already open and there are
296 no recognized errors, close the window.
297
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000298 *:lw* *:lwindow*
299:lw[indow] [height] Same as ":cwindow", except use the window showing the
300 location list for the current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301
302Normally the quickfix window is at the bottom of the screen. If there are
303vertical splits, it's at the bottom of the rightmost column of windows. To
304make it always occupy the full width: >
305 :botright cwindow
306You can move the window around with |window-moving| commands.
307For example, to move it to the top: CTRL-W K
308The 'winfixheight' option will be set, which means that the window will mostly
309keep its height, ignoring 'winheight' and 'equalalways'. You can change the
310height manually (e.g., by dragging the status line above it with the mouse).
311
312In the quickfix window, each line is one error. The line number is equal to
313the error number. You can use ":.cc" to jump to the error under the cursor.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000314Hitting the <Enter> key or double-clicking the mouse on a line has the same
Bram Moolenaar071d4272004-06-13 20:20:40 +0000315effect. The file containing the error is opened in the window above the
316quickfix window. If there already is a window for that file, it is used
317instead. If the buffer in the used window has changed, and the error is in
318another file, jumping to the error will fail. You will first have to make
319sure the window contains a buffer which can be abandoned.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000320 *CTRL-W_<Enter>* *CTRL-W_<CR>*
321You can use CTRL-W <Enter> to open a new window and jump to the error there.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000322
323When the quickfix window has been filled, two autocommand events are
324triggered. First the 'filetype' option is set to "qf", which triggers the
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000325FileType event. Then the BufReadPost event is triggered, using "quickfix" for
326the buffer name. This can be used to perform some action on the listed
327errors. Example: >
Bram Moolenaar280f1262006-01-30 00:14:18 +0000328 au BufReadPost quickfix setlocal modifiable
329 \ | silent exe 'g/^/s//\=line(".")." "/'
330 \ | setlocal nomodifiable
Bram Moolenaar071d4272004-06-13 20:20:40 +0000331This prepends the line number to each line. Note the use of "\=" in the
332substitute string of the ":s" command, which is used to evaluate an
333expression.
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000334The BufWinEnter event is also triggered, again using "quickfix" for the buffer
335name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000336
337Note: Making changes in the quickfix window has no effect on the list of
338errors. 'modifiable' is off to avoid making changes. If you delete or insert
339lines anyway, the relation between the text and the error number is messed up.
340If you really want to do this, you could write the contents of the quickfix
341window to a file and use ":cfile" to have it parsed and used as the new error
342list.
343
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000344 *location-list-window*
Bram Moolenaar280f1262006-01-30 00:14:18 +0000345The location list window displays the entries in a location list. When you
346open a location list window, it is created below the current window and
347displays the location list for the current window. The location list window
348is similar to the quickfix window, except that you can have more than one
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000349location list window open at a time. When you use a location list command in
350this window, the displayed location list is used.
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000351
Bram Moolenaar280f1262006-01-30 00:14:18 +0000352When you select a file from the location list window, the following steps are
353used to find a window to edit the file:
354
3551. If a window with the location list displayed in the location list window is
356 present, then the file is opened in that window.
3572. If the above step fails and if the file is already opened in another
358 window, then that window is used.
3593. If the above step fails then an existing window showing a buffer with
360 'buftype' not set is used.
3614. If the above step fails, then the file is edited in a new window.
362
363In all of the above cases, if the location list for the selected window is not
364yet set, then it is set to the location list displayed in the location list
365window.
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000366
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367=============================================================================
3683. Using more than one list of errors *quickfix-error-lists*
369
370So far has been assumed that there is only one list of errors. Actually the
371ten last used lists are remembered. When starting a new list, the previous
372ones are automatically kept. Two commands can be used to access older error
373lists. They set one of the existing error lists as the current one.
374
375 *:colder* *:col* *E380*
376:col[der] [count] Go to older error list. When [count] is given, do
377 this [count] times. When already at the oldest error
378 list, an error message is given.
379
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000380 *:lolder* *:lol*
381:lol[der] [count] Same as ":colder", except use the location list for
382 the current window instead of the quickfix list.
383
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 *:cnewer* *:cnew* *E381*
385:cnew[er] [count] Go to newer error list. When [count] is given, do
386 this [count] times. When already at the newest error
387 list, an error message is given.
388
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000389 *:lnewer* *:lnew*
390:lnew[er] [count] Same as ":cnewer", except use the location list for
391 the current window instead of the quickfix list.
392
Bram Moolenaar071d4272004-06-13 20:20:40 +0000393When adding a new error list, it becomes the current list.
394
395When ":colder" has been used and ":make" or ":grep" is used to add a new error
396list, one newer list is overwritten. This is especially useful if you are
397browsing with ":grep" |grep|. If you want to keep the more recent error
398lists, use ":cnewer 99" first.
399
400=============================================================================
4014. Using :make *:make_makeprg*
402
403 *:mak* *:make*
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +0000404:mak[e][!] [arguments] 1. If vim was built with |+autocmd|, all relevant
405 |QuickFixCmdPre| autocommands are executed.
406 2. If the 'autowrite' option is on, write any changed
Bram Moolenaar071d4272004-06-13 20:20:40 +0000407 buffers
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +0000408 3. An errorfile name is made from 'makeef'. If
Bram Moolenaar071d4272004-06-13 20:20:40 +0000409 'makeef' doesn't contain "##", and a file with this
410 name already exists, it is deleted.
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +0000411 4. The program given with the 'makeprg' option is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000412 started (default "make") with the optional
413 [arguments] and the output is saved in the
414 errorfile (for Unix it is also echoed on the
415 screen).
Bram Moolenaarb11bd7e2005-02-07 22:05:52 +0000416 5. The errorfile is read using 'errorformat'.
417 6. If [!] is not given the first error is jumped to.
418 7. The errorfile is deleted.
419 8. If vim was built with |+autocmd|, all relevant
420 |QuickFixCmdPost| autocommands are executed.
421 9. You can now move through the errors with commands
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422 like |:cnext| and |:cprevious|, see above.
423 This command does not accept a comment, any "
424 characters are considered part of the arguments.
425
Bram Moolenaar9f2c6e12006-02-04 22:45:44 +0000426 *:lmak* *:lmake*
427:lmak[e][!] [arguments]
428 Same as ":make", except the location list for the
429 current window is used instead of the quickfix list.
430
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431The ":make" command executes the command given with the 'makeprg' option.
432This is done by passing the command to the shell given with the 'shell'
433option. This works almost like typing
434
435 ":!{makeprg} [arguments] {shellpipe} {errorfile}".
436
437{makeprg} is the string given with the 'makeprg' option. Any command can be
438used, not just "make". Characters '%' and '#' are expanded as usual on a
439command-line. You can use "%<" to insert the current file name without
440extension, or "#<" to insert the alternate file name without extension, for
441example: >
442 :set makeprg=make\ #<.o
443
444[arguments] is anything that is typed after ":make".
445{shellpipe} is the 'shellpipe' option.
446{errorfile} is the 'makeef' option, with ## replaced to make it unique.
447
448The placeholder "$*" can be used for the argument list in {makeprog} if the
449command needs some additional characters after its arguments. The $* is
450replaced then by all arguments. Example: >
451 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
452or simpler >
453 :let &mp = 'latex \\nonstopmode \\input\{$*}'
454"$*" can be given multiple times, for example: >
455 :set makeprg=gcc\ -o\ $*\ $*
456
457The 'shellpipe' option defaults to ">" for the Amiga, MS-DOS and Win32. This
458means that the output of the compiler is saved in a file and not shown on the
459screen directly. For Unix "| tee" is used. The compiler output is shown on
460the screen and saved in a file the same time. Depending on the shell used
461"|& tee" or "2>&1| tee" is the default, so stderr output will be included.
462
463If 'shellpipe' is empty, the {errorfile} part will be omitted. This is useful
464for compilers that write to an errorfile themselves (e.g., Manx's Amiga C).
465
466==============================================================================
Bram Moolenaar86b68352004-12-27 21:59:20 +00004675. Using :vimgrep and :grep *grep* *lid*
468
469Vim has two ways to find matches for a pattern: Internal and external. The
470advantage of the internal grep is that it works on all systems and uses the
471powerful Vim search patterns. An external grep program can be used when the
472Vim grep does not do what you want.
473
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000474The internal method will be slower, because files are read into memory. The
475advantages are:
476- Line separators and encoding are automatically recognized, as if a file is
477 being edited.
478- Uses Vim search patterns. Multi-line patterns can be used.
479- When plugins are enabled: compressed and remote files can be searched.
480 |gzip| |netrw|
Bram Moolenaara3227e22006-03-08 21:32:40 +0000481
482To be able to do this Vim loads each file as if it is being edited. When
Bram Moolenaar1056d982006-03-09 22:37:52 +0000483there is no match in the file the associated buffer is wiped out again. The
Bram Moolenaara3227e22006-03-08 21:32:40 +0000484'hidden' option is ignored here to avoid running out of memory or file
485descriptors when searching many files. However, when the |:hide| command
486modifier is used the buffers are kept loaded. This makes following searches
487in the same files a lot faster.
Bram Moolenaar86b68352004-12-27 21:59:20 +0000488
489
4905.1 using Vim's internal grep
491
Bram Moolenaare49b69a2005-01-08 16:11:57 +0000492 *:vim* *:vimgrep* *E682* *E683*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000493:vim[grep][!] /{pattern}/[g][j] {file} ...
Bram Moolenaar86b68352004-12-27 21:59:20 +0000494 Search for {pattern} in the files {file} ... and set
495 the error list to the matches.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000496 Without the 'g' flag each line is added only once.
497 With 'g' every match is added.
498
499 {pattern} is a Vim search pattern. Instead of
500 enclosing it in / any non-ID character (see
501 |'isident'|) can be used, so long as it does not
502 appear in {pattern}.
503 'ignorecase' applies. To overrule it put |/\c| in the
504 pattern to ignore case or |/\C| to match case.
505 'smartcase' is not used.
506
Bram Moolenaar1f35bf92006-03-07 22:38:47 +0000507 When a number is put before the command this is used
508 as the maximum number of matches to find. Use
509 ":1vimgrep pattern file" to find only the first.
510 Useful if you only want to check if there is a match
511 and quit quickly when it's found.
512
Bram Moolenaar05159a02005-02-26 23:04:13 +0000513 Without the 'j' flag Vim jumps to the first match.
514 With 'j' only the quickfix list is updated.
515 With the [!] any changes in the current buffer are
516 abandoned.
517
Bram Moolenaardcaf10e2005-01-21 11:55:25 +0000518 Every second or so the searched file name is displayed
519 to give you an idea of the progress made.
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000520 Examples: >
521 :vimgrep /an error/ *.c
522 :vimgrep /\<FileName\>/ *.h include/*
Bram Moolenaar231334e2005-07-25 20:46:57 +0000523 :vimgrep /myfunc/ **/*.c
524< For the use of "**" see |starstar-wildcard|.
Bram Moolenaar86b68352004-12-27 21:59:20 +0000525
Bram Moolenaar8fc061c2004-12-29 21:03:02 +0000526:vim[grep][!] {pattern} {file} ...
527 Like above, but instead of enclosing the pattern in a
528 non-ID character use a white-separated pattern. The
529 pattern must start with an ID character.
530 Example: >
531 :vimgrep Error *.c
532<
Bram Moolenaar9f2c6e12006-02-04 22:45:44 +0000533 *:lv* *:lvimgrep*
534:lv[imgrep][!] /{pattern}/[g][j] {file} ...
535:lv[imgrep][!] {pattern} {file} ...
536 Same as ":vimgrep", except the location list for the
537 current window is used instead of the quickfix list.
538
Bram Moolenaar86b68352004-12-27 21:59:20 +0000539 *:vimgrepa* *:vimgrepadd*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000540:vimgrepa[dd][!] /{pattern}/[g][j] {file} ...
541:vimgrepa[dd][!] {pattern} {file} ...
Bram Moolenaar86b68352004-12-27 21:59:20 +0000542 Just like ":vimgrep", but instead of making a new list
543 of errors the matches are appended to the current
544 list.
545
Bram Moolenaar9f2c6e12006-02-04 22:45:44 +0000546 *:lvimgrepa* *:lvimgrepadd*
547:lvimgrepa[dd][!] /{pattern}/[g][j] {file} ...
548:lvimgrepa[dd][!] {pattern} {file} ...
549 Same as ":vimgrepadd", except the location list for
550 the current window is used instead of the quickfix
551 list.
Bram Moolenaar86b68352004-12-27 21:59:20 +0000552
5535.2 External grep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
555Vim can interface with "grep" and grep-like programs (such as the GNU
556id-utils) in a similar way to its compiler integration (see |:make| above).
557
558[Unix trivia: The name for the Unix "grep" command comes from ":g/re/p", where
559"re" stands for Regular Expression.]
560
561 *:gr* *:grep*
562:gr[ep][!] [arguments] Just like ":make", but use 'grepprg' instead of
563 'makeprg' and 'grepformat' instead of 'errorformat'.
Bram Moolenaar86b68352004-12-27 21:59:20 +0000564 When 'grepprg' is "internal" this works like
565 |:vimgrep|. Note that the pattern needs to be
566 enclosed in separator characters then.
Bram Moolenaar9f2c6e12006-02-04 22:45:44 +0000567
568 *:lgr* *:lgrep*
569:lgr[ep][!] [arguments] Same as ":grep", except the location list for the
570 current window is used instead of the quickfix list.
571
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572 *:grepa* *:grepadd*
573:grepa[dd][!] [arguments]
574 Just like ":grep", but instead of making a new list of
575 errors the matches are appended to the current list.
576 Example: >
577 :grep nothing %
578 :bufdo grepadd! something %
579< The first command makes a new error list which is
580 empty. The second command executes "grepadd" for each
581 listed buffer. Note the use of ! to avoid that
582 ":grepadd" jumps to the first error, which is not
583 allowed with |:bufdo|.
584
Bram Moolenaar9f2c6e12006-02-04 22:45:44 +0000585 *:lgrepa* *:lgrepadd*
586:lgrepa[dd][!] [arguments]
587 Same as ":grepadd", except the location list for the
588 current window is used instead of the quickfix list.
589
Bram Moolenaar86b68352004-12-27 21:59:20 +00005905.3 Setting up external grep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591
592If you have a standard "grep" program installed, the :grep command may work
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000593well with the defaults. The syntax is very similar to the standard command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594
595 :grep foo *.c
596
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000597Will search all files with the .c extension for the substring "foo". The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598arguments to :grep are passed straight to the "grep" program, so you can use
599whatever options your "grep" supports.
600
601By default, :grep invokes grep with the -n option (show file and line
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000602numbers). You can change this with the 'grepprg' option. You will need to set
Bram Moolenaar071d4272004-06-13 20:20:40 +0000603'grepprg' if:
604
605a) You are using a program that isn't called "grep"
606b) You have to call grep with a full path
607c) You want to pass other options automatically (e.g. case insensitive
608 search.)
609
610Once "grep" has executed, Vim parses the results using the 'grepformat'
611option. This option works in the same way as the 'errorformat' option - see
612that for details. You may need to change 'grepformat' from the default if
613your grep outputs in a non-standard format, or you are using some other
614program with a special format.
615
616Once the results are parsed, Vim loads the first file containing a match and
617jumps to the appropriate line, in the same way that it jumps to a compiler
618error in |quickfix| mode. You can then use the |:cnext|, |:clist|, etc.
619commands to see the other matches.
620
621
Bram Moolenaar86b68352004-12-27 21:59:20 +00006225.4 Using :grep with id-utils
Bram Moolenaar071d4272004-06-13 20:20:40 +0000623
624You can set up :grep to work with the GNU id-utils like this: >
625
626 :set grepprg=lid\ -Rgrep\ -s
627 :set grepformat=%f:%l:%m
628
629then >
630 :grep (regexp)
631
632works just as you'd expect.
633(provided you remembered to mkid first :)
634
635
Bram Moolenaar86b68352004-12-27 21:59:20 +00006365.5 Browsing source code with :vimgrep or :grep
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637
638Using the stack of error lists that Vim keeps, you can browse your files to
639look for functions and the functions they call. For example, suppose that you
640have to add an argument to the read_file() function. You enter this command: >
641
Bram Moolenaar86b68352004-12-27 21:59:20 +0000642 :vimgrep /\<read_file\>/ *.c
Bram Moolenaar071d4272004-06-13 20:20:40 +0000643
644You use ":cn" to go along the list of matches and add the argument. At one
645place you have to get the new argument from a higher level function msg(), and
646need to change that one too. Thus you use: >
647
Bram Moolenaar86b68352004-12-27 21:59:20 +0000648 :vimgrep /\<msg\>/ *.c
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649
650While changing the msg() functions, you find another function that needs to
Bram Moolenaar86b68352004-12-27 21:59:20 +0000651get the argument from a higher level. You can again use ":vimgrep" to find
652these functions. Once you are finished with one function, you can use >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653
654 :colder
655
656to go back to the previous one.
657
Bram Moolenaar86b68352004-12-27 21:59:20 +0000658This works like browsing a tree: ":vimgrep" goes one level deeper, creating a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000659list of branches. ":colder" goes back to the previous level. You can mix
Bram Moolenaar86b68352004-12-27 21:59:20 +0000660this use of ":vimgrep" and "colder" to browse all the locations in a tree-like
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661way. If you do this consistently, you will find all locations without the
662need to write down a "todo" list.
663
664=============================================================================
6656. Selecting a compiler *compiler-select*
666
667 *:comp* *:compiler* *E666*
668:comp[iler][!] {name} Set options to work with compiler {name}.
669 Without the "!" options are set for the
670 current buffer. With "!" global options are
671 set.
672 If you use ":compiler foo" in "file.foo" and
673 then ":compiler! bar" in another buffer, Vim
674 will keep on using "foo" in "file.foo".
675 {not available when compiled without the
676 |+eval| feature}
677
678
679The Vim plugins in the "compiler" directory will set options to use the
680selected compiler. For ":compiler" local options are set, for ":compiler!"
681global options.
682 *current_compiler*
683To support older Vim versions, the plugins always use "current_compiler" and
684not "b:current_compiler". What the command actually does is the following:
685
686- Delete the "current_compiler" and "b:current_compiler" variables.
687- Define the "CompilerSet" user command. With "!" it does ":set", without "!"
688 it does ":setlocal".
689- Execute ":runtime! compiler/{name}.vim". The plugins are expected to set
690 options with "CompilerSet" and set the "current_compiler" variable to the
691 name of the compiler.
Bram Moolenaar05159a02005-02-26 23:04:13 +0000692- Delete the "CompilerSet" user command.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693- Set "b:current_compiler" to the value of "current_compiler".
694- Without "!" the old value of "current_compiler" is restored.
695
696
697For writing a compiler plugin, see |write-compiler-plugin|.
698
699
700MANX AZTEC C *quickfix-manx* *compiler-manx*
701
702To use Vim with Manx's Aztec C compiler on the Amiga you should do the
703following:
704- Set the CCEDIT environment variable with the command: >
705 mset "CCEDIT=vim -q"
706- Compile with the -qf option. If the compiler finds any errors, Vim is
707 started and the cursor is positioned on the first error. The error message
708 will be displayed on the last line. You can go to other errors with the
709 commands mentioned above. You can fix the errors and write the file(s).
710- If you exit Vim normally the compiler will re-compile the same file. If you
711 exit with the :cq command, the compiler will terminate. Do this if you
712 cannot fix the error, or if another file needs to be compiled first.
713
714There are some restrictions to the Quickfix mode on the Amiga. The
715compiler only writes the first 25 errors to the errorfile (Manx's
716documentation does not say how to get more). If you want to find the others,
717you will have to fix a few errors and exit the editor. After recompiling,
718up to 25 remaining errors will be found.
719
720If Vim was started from the compiler, the :sh and some :! commands will not
721work, because Vim is then running in the same process as the compiler and
722stdin (standard input) will not be interactive.
723
724
725PYUNIT COMPILER *compiler-pyunit*
726
727This is not actually a compiler, but a unit testing framework for the
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000728Python language. It is included into standard Python distribution
729starting from version 2.0. For older versions, you can get it from
Bram Moolenaar071d4272004-06-13 20:20:40 +0000730http://pyunit.sourceforge.net.
731
732When you run your tests with the help of the framework, possible errors
733are parsed by Vim and presented for you in quick-fix mode.
734
735Unfortunately, there is no standard way to run the tests.
736The alltests.py script seems to be used quite often, that's all.
737Useful values for the 'makeprg' options therefore are:
738 setlocal makeprg=./alltests.py " Run a testsuite
739 setlocal makeprg=python % " Run a single testcase
740
741Also see http://vim.sourceforge.net/tip_view.php?tip_id=280.
742
743
744TEX COMPILER *compiler-tex*
745
746Included in the distribution compiler for TeX ($VIMRUNTIME/compiler/tex.vim)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000747uses make command if possible. If the compiler finds a file named "Makefile"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748or "makefile" in the current directory, it supposes that you want to process
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000749your *TeX files with make, and the makefile does the right work. In this case
750compiler sets 'errorformat' for *TeX output and leaves 'makeprg' untouched. If
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751neither "Makefile" nor "makefile" is found, the compiler will not use make.
752You can force the compiler to ignore makefiles by defining
753b:tex_ignore_makefile or g:tex_ignore_makefile variable (they are checked for
754existence only).
755
756If the compiler chose not to use make, it need to choose a right program for
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000757processing your input. If b:tex_flavor or g:tex_flavor (in this precedence)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758variable exists, it defines TeX flavor for :make (actually, this is the name
759of executed command), and if both variables do not exist, it defaults to
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000760"latex". For example, while editing chapter2.tex \input-ed from mypaper.tex
Bram Moolenaar071d4272004-06-13 20:20:40 +0000761written in AMS-TeX: >
762
763 :let b:tex_flavor = 'amstex'
764 :compiler tex
765< [editing...] >
766 :make mypaper
767
768Note that you must specify a name of the file to process as an argument (to
769process the right file when editing \input-ed or \include-ed file; portable
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000770solution for substituting % for no arguments is welcome). This is not in the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771semantics of make, where you specify a target, not source, but you may specify
772filename without extension ".tex" and mean this as "make filename.dvi or
773filename.pdf or filename.some_result_extension according to compiler".
774
775Note: tex command line syntax is set to usable both for MikTeX (suggestion
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000776by Srinath Avadhanula) and teTeX (checked by Artem Chuprina). Suggestion
Bram Moolenaar071d4272004-06-13 20:20:40 +0000777from |errorformat-LaTeX| is too complex to keep it working for different
778shells and OSes and also does not allow to use other available TeX options,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000779if any. If your TeX doesn't support "-interaction=nonstopmode", please
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780report it with different means to express \nonstopmode from the command line.
781
782=============================================================================
7837. The error format *error-file-format*
784
785 *errorformat* *E372* *E373* *E374*
786 *E375* *E376* *E377* *E378*
787The 'errorformat' option specifies a list of formats that are recognized. The
788first format that matches with an error message is used. You can add several
789formats for different messages your compiler produces, or even entries for
790multiple compilers. See |efm-entries|.
791
792Each entry in 'errorformat' is a scanf-like string that describes the format.
793First, you need to know how scanf works. Look in the documentation of your
794C compiler. Below you find the % items that Vim understands. Others are
795invalid.
796
797Special characters in 'errorformat' are comma and backslash. See
798|efm-entries| for how to deal with them. Note that a literal "%" is matched
799by "%%", thus it is not escaped with a backslash.
800
801Note: By default the difference between upper and lowercase is ignored. If
802you want to match case, add "\C" to the pattern |/\C|.
803
804
805Basic items
806
807 %f file name (finds a string)
808 %l line number (finds a number)
809 %c column number (finds a number representing character
810 column of the error, (1 <tab> == 1 character column))
811 %v virtual column number (finds a number representing
812 screen column of the error (1 <tab> == 8 screen
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000813 columns))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000814 %t error type (finds a single character)
815 %n error number (finds a number)
816 %m error message (finds a string)
817 %r matches the "rest" of a single-line file message %O/P/Q
818 %p pointer line (finds a sequence of '-', '.' or ' ' and
819 uses the length for the column number)
820 %*{conv} any scanf non-assignable conversion
821 %% the single '%' character
Bram Moolenaar2641f772005-03-25 21:58:17 +0000822 %s search text (finds a string)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823
Bram Moolenaare344bea2005-09-01 20:46:49 +0000824The "%f" conversion may depend on the current 'isfname' setting. "~/" is
Bram Moolenaarf4630b62005-05-20 21:31:17 +0000825expanded to the home directory and environment variables are expanded.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
Bram Moolenaare344bea2005-09-01 20:46:49 +0000827The "%f" and "%m" conversions have to detect the end of the string. This
Bram Moolenaar482aaeb2005-09-29 18:26:07 +0000828normally happens by matching following characters and items. When nothing is
Bram Moolenaare344bea2005-09-01 20:46:49 +0000829following the rest of the line is matched. If "%f" is followed by a '%' or a
830backslash, it will look for a sequence of 'isfname' characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000831
832On MS-DOS, MS-Windows and OS/2 a leading "C:" will be included in "%f", even
833when using "%f:". This means that a file name which is a single alphabetical
834letter will not be detected.
835
836The "%p" conversion is normally followed by a "^". It's used for compilers
837that output a line like: >
838 ^
839or >
840 ---------^
841to indicate the column of the error. This is to be used in a multi-line error
842message. See |errorformat-javac| for a useful example.
843
Bram Moolenaar2641f772005-03-25 21:58:17 +0000844The "%s" conversion specifies the text to search for to locate the error line.
845The text is used as a literal string. The anchors "^" and "$" are added to
846the text to locate the error line exactly matching the search text and the
847text is prefixed with the "\V" atom to make it "very nomagic". The "%s"
848conversion can be used to locate lines without a line number in the error
849output. Like the output of the "grep" shell command.
850When the pattern is present the line number will not be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851
852Changing directory
853
854The following uppercase conversion characters specify the type of special
855format strings. At most one of them may be given as a prefix at the begin
856of a single comma-separated format pattern.
857Some compilers produce messages that consist of directory names that have to
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000858be prepended to each file name read by %f (example: GNU make). The following
Bram Moolenaar071d4272004-06-13 20:20:40 +0000859codes can be used to scan these directory names; they will be stored in an
860internal directory stack. *E379*
861 %D "enter directory" format string; expects a following
862 %f that finds the directory name
863 %X "leave directory" format string; expects following %f
864
865When defining an "enter directory" or "leave directory" format, the "%D" or
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000866"%X" has to be given at the start of that substring. Vim tracks the directory
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867changes and prepends the current directory to each erroneous file found with a
868relative path. See |quickfix-directory-stack| for details, tips and
869limitations.
870
871
872Multi-line messages *errorformat-multi-line*
873
874It is possible to read the output of programs that produce multi-line
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000875messages, i.e. error strings that consume more than one line. Possible
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876prefixes are:
877 %E start of a multi-line error message
878 %W start of a multi-line warning message
879 %I start of a multi-line informational message
880 %A start of a multi-line message (unspecified type)
Bram Moolenaarb3656ed2006-03-20 21:59:49 +0000881 %> for next line start with current pattern again |efm-%>|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000882 %C continuation of a multi-line message
883 %Z end of a multi-line message
884These can be used with '+' and '-', see |efm-ignore| below.
885
Bram Moolenaarceaf7b82006-03-19 22:18:55 +0000886Using "\n" in the pattern won't work to match multi-line messages.
887
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888Example: Your compiler happens to write out errors in the following format
889(leading line numbers not being part of the actual output):
890
Bram Moolenaarceaf7b82006-03-19 22:18:55 +0000891 1 Error 275 ~
892 2 line 42 ~
893 3 column 3 ~
894 4 ' ' expected after '--' ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895
896The appropriate error format string has to look like this: >
897 :set efm=%EError\ %n,%Cline\ %l,%Ccolumn\ %c,%Z%m
898
899And the |:clist| error message generated for this error is:
900
901 1:42 col 3 error 275: ' ' expected after '--'
902
903Another example: Think of a Python interpreter that produces the following
904error message (line numbers are not part of the actual output):
905
906 1 ==============================================================
907 2 FAIL: testGetTypeIdCachesResult (dbfacadeTest.DjsDBFacadeTest)
908 3 --------------------------------------------------------------
909 4 Traceback (most recent call last):
910 5 File "unittests/dbfacadeTest.py", line 89, in testFoo
911 6 self.assertEquals(34, dtid)
912 7 File "/usr/lib/python2.2/unittest.py", line 286, in
913 8 failUnlessEqual
914 9 raise self.failureException, \
915 10 AssertionError: 34 != 33
916 11
917 12 --------------------------------------------------------------
918 13 Ran 27 tests in 0.063s
919
920Say you want |:clist| write the relevant information of this message only,
921namely:
922 5 unittests/dbfacadeTest.py:89: AssertionError: 34 != 33
923
924Then the error format string could be defined as follows: >
925 :set efm=%C\ %.%#,%A\ \ File\ \"%f\"\\,\ line\ %l%.%#,%Z%[%^\ ]%\\@=%m
926
927Note that the %C string is given before the %A here: since the expression
928' %.%#' (which stands for the regular expression ' .*') matches every line
929starting with a space, followed by any characters to the end of the line,
930it also hides line 7 which would trigger a separate error message otherwise.
931Error format strings are always parsed pattern by pattern until the first
932match occurs.
Bram Moolenaarb3656ed2006-03-20 21:59:49 +0000933 *efm-%>*
934The %> item can be used to avoid trying patterns that appear earlier in
935'errorformat'. This is useful for patterns that match just about anything.
936For example, if the error looks like this:
937
938 Error in line 123 of foo.c: ~
939 unknown variable "i" ~
940
941This can be found with: >
942 :set efm=xxx,%E%>Error in line %l of %f:,%Z%m
943Where "xxx" has a pattern that would also match the second line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944
Bram Moolenaarceaf7b82006-03-19 22:18:55 +0000945Important: There is no memory of what part of the errorformat matched before;
946every line in the error file gets a complete new run through the error format
947lines. For example, if one has: >
948 setlocal efm=aa,bb,cc,dd,ee
949Where aa, bb, etc. are error format strings. Each line of the error file will
950be matched to the pattern aa, then bb, then cc, etc. Just because cc matched
951the previous error line does _not_ mean that dd will be tried first on the
952current line, even if cc and dd are multi-line errorformat strings.
953
954
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956Separate file name *errorformat-separate-filename*
957
958These prefixes are useful if the file name is given once and multiple messages
959follow that refer to this file name.
960 %O single-line file message: overread the matched part
961 %P single-line file message: push file %f onto the stack
962 %Q single-line file message: pop the last file from stack
963
964Example: Given a compiler that produces the following error logfile (without
965leading line numbers):
966
967 1 [a1.tt]
968 2 (1,17) error: ';' missing
969 3 (21,2) warning: variable 'z' not defined
970 4 (67,3) error: end of file found before string ended
971 5
972 6 [a2.tt]
973 7
974 8 [a3.tt]
975 9 NEW compiler v1.1
976 10 (2,2) warning: variable 'x' not defined
977 11 (67,3) warning: 's' already defined
978
979This logfile lists several messages for each file enclosed in [...] which are
980properly parsed by an error format like this: >
981 :set efm=%+P[%f],(%l\\,%c)%*[\ ]%t%*[^:]:\ %m,%-Q
982
983A call of |:clist| writes them accordingly with their correct filenames:
984
985 2 a1.tt:1 col 17 error: ';' missing
986 3 a1.tt:21 col 2 warning: variable 'z' not defined
987 4 a1.tt:67 col 3 error: end of file found before string ended
988 8 a3.tt:2 col 2 warning: variable 'x' not defined
989 9 a3.tt:67 col 3 warning: 's' already defined
990
991Unlike the other prefixes that all match against whole lines, %P, %Q and %O
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +0000992can be used to match several patterns in the same line. Thus it is possible
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993to parse even nested files like in the following line:
994 {"file1" {"file2" error1} error2 {"file3" error3 {"file4" error4 error5}}}
995The %O then parses over strings that do not contain any push/pop file name
996information. See |errorformat-LaTeX| for an extended example.
997
998
999Ignoring and using whole messages *efm-ignore*
1000
1001The codes '+' or '-' can be combined with the uppercase codes above; in that
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001002case they have to precede the letter, e.g. '%+A' or '%-G':
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 %- do not include the matching multi-line in any output
1004 %+ include the whole matching line in the %m error string
1005
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001006One prefix is only useful in combination with '+' or '-', namely %G. It parses
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007over lines containing general information like compiler version strings or
1008other headers that can be skipped.
1009 %-G ignore this message
1010 %+G general message
1011
1012
1013Pattern matching
1014
1015The scanf()-like "%*[]" notation is supported for backward-compatibility
1016with previous versions of Vim. However, it is also possible to specify
1017(nearly) any Vim supported regular expression in format strings.
1018Since meta characters of the regular expression language can be part of
1019ordinary matching strings or file names (and therefore internally have to
1020be escaped), meta symbols have to be written with leading '%':
Bram Moolenaarceaf7b82006-03-19 22:18:55 +00001021 %\ The single '\' character. Note that this has to be
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 escaped ("%\\") in ":set errorformat=" definitions.
Bram Moolenaarceaf7b82006-03-19 22:18:55 +00001023 %. The single '.' character.
1024 %# The single '*'(!) character.
1025 %^ The single '^' character. Note that this is not
1026 useful, the pattern already matches start of line.
1027 %$ The single '$' character. Note that this is not
1028 useful, the pattern already matches end of line.
1029 %[ The single '[' character for a [] character range.
1030 %~ The single '~' character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031When using character classes in expressions (see |/\i| for an overview),
1032terms containing the "\+" quantifier can be written in the scanf() "%*"
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001033notation. Example: "%\\d%\\+" ("\d\+", "any number") is equivalent to "%*\\d".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034Important note: The \(...\) grouping of sub-matches can not be used in format
1035specifications because it is reserved for internal conversions.
1036
1037
1038Multiple entries in 'errorformat' *efm-entries*
1039
1040To be able to detect output from several compilers, several format patterns
1041may be put in 'errorformat', separated by commas (note: blanks after the comma
1042are ignored). The first pattern that has a complete match is used. If no
1043match is found, matching parts from the last one will be used, although the
1044file name is removed and the error message is set to the whole message. If
1045there is a pattern that may match output from several compilers (but not in a
1046right way), put it after one that is more restrictive.
1047
1048To include a comma in a pattern precede it with a backslash (you have to type
1049two in a ":set" command). To include a backslash itself give two backslashes
1050(you have to type four in a ":set" command). You also need to put a backslash
1051before a space for ":set".
1052
1053
1054Valid matches *quickfix-valid*
1055
1056If a line does not completely match one of the entries in 'errorformat', the
1057whole line is put in the error message and the entry is marked "not valid"
1058These lines are skipped with the ":cn" and ":cp" commands (unless there is
1059no valid line at all). You can use ":cl!" to display all the error messages.
1060
1061If the error format does not contain a file name Vim cannot switch to the
1062correct file. You will have to do this by hand.
1063
1064
1065Examples
1066
1067The format of the file from the Amiga Aztec compiler is:
1068
1069 filename>linenumber:columnnumber:errortype:errornumber:errormessage
1070
1071 filename name of the file in which the error was detected
1072 linenumber line number where the error was detected
1073 columnnumber column number where the error was detected
1074 errortype type of the error, normally a single 'E' or 'W'
1075 errornumber number of the error (for lookup in the manual)
1076 errormessage description of the error
1077
1078This can be matched with this 'errorformat' entry:
1079 %f>%l:%c:%t:%n:%m
1080
1081Some examples for C compilers that produce single-line error outputs:
1082%f:%l:\ %t%*[^0123456789]%n:\ %m for Manx/Aztec C error messages
1083 (scanf() doesn't understand [0-9])
1084%f\ %l\ %t%*[^0-9]%n:\ %m for SAS C
1085\"%f\"\\,%*[^0-9]%l:\ %m for generic C compilers
1086%f:%l:\ %m for GCC
1087%f:%l:\ %m,%Dgmake[%*\\d]:\ Entering\ directory\ `%f',
1088%Dgmake[%*\\d]:\ Leaving\ directory\ `%f'
1089 for GCC with gmake (concat the lines!)
1090%f(%l)\ :\ %*[^:]:\ %m old SCO C compiler (pre-OS5)
1091%f(%l)\ :\ %t%*[^0-9]%n:\ %m idem, with error type and number
1092%f:%l:\ %m,In\ file\ included\ from\ %f:%l:,\^I\^Ifrom\ %f:%l%m
1093 for GCC, with some extras
1094
1095Extended examples for the handling of multi-line messages are given below,
1096see |errorformat-Jikes| and |errorformat-LaTeX|.
1097
1098Note the backslash in front of a space and double quote. It is required for
1099the :set command. There are two backslashes in front of a comma, one for the
1100:set command and one to avoid recognizing the comma as a separator of error
1101formats.
1102
1103
1104Filtering messages
1105
1106If you have a compiler that produces error messages that do not fit in the
1107format string, you could write a program that translates the error messages
1108into this format. You can use this program with the ":make" command by
1109changing the 'makeprg' option. For example: >
1110 :set mp=make\ \\\|&\ error_filter
1111The backslashes before the pipe character are required to avoid it to be
1112recognized as a command separator. The backslash before each space is
1113required for the set command.
1114
1115=============================================================================
11168. The directory stack *quickfix-directory-stack*
1117
1118Quickfix maintains a stack for saving all used directories parsed from the
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001119make output. For GNU-make this is rather simple, as it always prints the
1120absolute path of all directories it enters and leaves. Regardless if this is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121done via a 'cd' command in the makefile or with the parameter "-C dir" (change
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001122to directory before reading the makefile). It may be useful to use the switch
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123"-w" to force GNU-make to print out the working directory before and after
1124processing.
1125
1126Maintaining the correct directory is more complicated if you don't use
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001127GNU-make. AIX-make for example doesn't print any information about its
1128working directory. Then you need to enhance the makefile. In the makefile of
1129LessTif there is a command which echoes "Making {target} in {dir}". The
1130special problem here is that it doesn't print informations on leaving the
1131directory and that it doesn't print the absolute path.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132
1133To solve the problem with relative paths and missing "leave directory"
1134messages Vim uses following algorithm:
1135
11361) Check if the given directory is a subdirectory of the current directory.
1137 If this is true, store it as the current directory.
11382) If it is not a subdir of the current directory, try if this is a
1139 subdirectory of one of the upper directories.
11403) If the directory still isn't found, it is assumed to be a subdirectory
1141 of Vim's current directory.
1142
1143Additionally it is checked for every file, if it really exists in the
1144identified directory. If not, it is searched in all other directories of the
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001145directory stack (NOT the directory subtree!). If it is still not found, it is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146assumed that it is in Vim's current directory.
1147
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001148There are limitation in this algorithm. This examples assume that make just
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149prints information about entering a directory in the form "Making all in dir".
1150
11511) Assume you have following directories and files:
1152 ./dir1
1153 ./dir1/file1.c
1154 ./file1.c
1155
1156 If make processes the directory "./dir1" before the current directory and
1157 there is an error in the file "./file1.c", you will end up with the file
1158 "./dir1/file.c" loaded by Vim.
1159
1160 This can only be solved with a "leave directory" message.
1161
11622) Assume you have following directories and files:
1163 ./dir1
1164 ./dir1/dir2
1165 ./dir2
1166
1167 You get the following:
1168
1169 Make output Directory interpreted by Vim
1170 ------------------------ ----------------------------
1171 Making all in dir1 ./dir1
1172 Making all in dir2 ./dir1/dir2
1173 Making all in dir2 ./dir1/dir2
1174
1175 This can be solved by printing absolute directories in the "enter directory"
1176 message or by printing "leave directory" messages..
1177
1178To avoid this problems, ensure to print absolute directory names and "leave
1179directory" messages.
1180
1181Examples for Makefiles:
1182
1183Unix:
1184 libs:
1185 for dn in $(LIBDIRS); do \
1186 (cd $$dn; echo "Entering dir '$$(pwd)'"; make); \
1187 echo "Leaving dir"; \
1188 done
1189
1190Add
1191 %DEntering\ dir\ '%f',%XLeaving\ dir
1192to your 'errorformat' to handle the above output.
1193
1194Note that Vim doesn't check if the directory name in a "leave directory"
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001195messages is the current directory. This is why you could just use the message
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196"Leaving dir".
1197
1198=============================================================================
11999. Specific error file formats *errorformats*
1200
1201 *errorformat-Jikes*
1202Jikes(TM), a source-to-bytecode Java compiler published by IBM Research,
1203produces simple multi-line error messages.
1204
1205An 'errorformat' string matching the produced messages is shown below.
1206The following lines can be placed in the user's |vimrc| to overwrite Vim's
1207recognized default formats, or see |:set+=| how to install this format
1208additionally to the default. >
1209
1210 :set efm=%A%f:%l:%c:%*\\d:%*\\d:,
1211 \%C%*\\s%trror:%m,
1212 \%+C%*[^:]%trror:%m,
1213 \%C%*\\s%tarning:%m,
1214 \%C%m
1215<
1216Jikes(TM) produces a single-line error message when invoked with the option
1217"+E", and can be matched with the following: >
1218
1219 :set efm=%f:%l:%v:%*\\d:%*\\d:%*\\s%m
1220<
1221 *errorformat-javac*
1222This 'errorformat' has been reported to work well for javac, which outputs a
1223line with "^" to indicate the column of the error: >
1224 :set efm=%A%f:%l:\ %m,%-Z%p^,%-C%.%#
1225or: >
1226 :set efm=%A%f:%l:\ %m,%+Z%p^,%+C%.%#,%-G%.%#
1227<
1228 *errorformat-ant*
1229For ant (http://jakarta.apache.org/) the above errorformat has to be modified
1230to honour the leading [javac] in front of each javac output line: >
1231 :set efm=%A\ %#[javac]\ %f:%l:\ %m,%-Z\ %#[javac]\ %p^,%-C%.%#
1232
1233The 'errorformat' can also be configured to handle ant together with either
1234javac or jikes. If you're using jikes, you should tell ant to use jikes' +E
1235command line switch which forces jikes to generate one-line error messages.
1236This is what the second line (of a build.xml file) below does: >
1237 <property name = "build.compiler" value = "jikes"/>
1238 <property name = "build.compiler.emacs" value = "true"/>
1239
1240The 'errorformat' which handles ant with both javac and jikes is: >
1241 :set efm=\ %#[javac]\ %#%f:%l:%c:%*\\d:%*\\d:\ %t%[%^:]%#:%m,
1242 \%A\ %#[javac]\ %f:%l:\ %m,%-Z\ %#[javac]\ %p^,%-C%.%#
1243<
1244 *errorformat-jade*
1245parsing jade (see http://www.jclark.com/) errors is simple: >
1246 :set efm=jade:%f:%l:%c:%t:%m
1247<
1248 *errorformat-LaTeX*
1249The following is an example how an 'errorformat' string can be specified
1250for the (La)TeX typesetting system which displays error messages over
1251multiple lines. The output of ":clist" and ":cc" etc. commands displays
1252multi-lines in a single line, leading white space is removed.
1253It should be easy to adopt the above LaTeX errorformat to any compiler output
1254consisting of multi-line errors.
1255
1256The commands can be placed in a |vimrc| file or some other Vim script file,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001257e.g. a script containing LaTeX related stuff which is loaded only when editing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258LaTeX sources.
1259Make sure to copy all lines of the example (in the given order), afterwards
1260remove the comment lines. For the '\' notation at the start of some lines see
1261|line-continuation|.
1262
1263 First prepare 'makeprg' such that LaTeX will report multiple
1264 errors; do not stop when the first error has occurred: >
1265 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
1266<
1267 Start of multi-line error messages: >
1268 :set efm=%E!\ LaTeX\ %trror:\ %m,
1269 \%E!\ %m,
1270< Start of multi-line warning messages; the first two also
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001271 include the line number. Meaning of some regular expressions:
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 - "%.%#" (".*") matches a (possibly empty) string
1273 - "%*\\d" ("\d\+") matches a number >
1274 \%+WLaTeX\ %.%#Warning:\ %.%#line\ %l%.%#,
1275 \%+W%.%#\ at\ lines\ %l--%*\\d,
1276 \%WLaTeX\ %.%#Warning:\ %m,
1277< Possible continuations of error/warning messages; the first
1278 one also includes the line number: >
1279 \%Cl.%l\ %m,
1280 \%+C\ \ %m.,
1281 \%+C%.%#-%.%#,
1282 \%+C%.%#[]%.%#,
1283 \%+C[]%.%#,
1284 \%+C%.%#%[{}\\]%.%#,
1285 \%+C<%.%#>%.%#,
1286 \%C\ \ %m,
1287< Lines that match the following patterns do not contain any
1288 important information; do not include them in messages: >
1289 \%-GSee\ the\ LaTeX%m,
1290 \%-GType\ \ H\ <return>%m,
1291 \%-G\ ...%.%#,
1292 \%-G%.%#\ (C)\ %.%#,
1293 \%-G(see\ the\ transcript%.%#),
1294< Generally exclude any empty or whitespace-only line from
1295 being displayed: >
1296 \%-G\\s%#,
1297< The LaTeX output log does not specify the names of erroneous
1298 source files per line; rather they are given globally,
1299 enclosed in parentheses.
1300 The following patterns try to match these names and store
1301 them in an internal stack. The patterns possibly scan over
1302 the same input line (one after another), the trailing "%r"
1303 conversion indicates the "rest" of the line that will be
1304 parsed in the next go until the end of line is reached.
1305
1306 Overread a file name enclosed in '('...')'; do not push it
1307 on a stack since the file apparently does not contain any
1308 error: >
1309 \%+O(%f)%r,
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001310< Push a file name onto the stack. The name is given after '(': >
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 \%+P(%f%r,
1312 \%+P\ %\\=(%f%r,
1313 \%+P%*[^()](%f%r,
1314 \%+P[%\\d%[^()]%#(%f%r,
1315< Pop the last stored file name when a ')' is scanned: >
1316 \%+Q)%r,
1317 \%+Q%*[^()])%r,
1318 \%+Q[%\\d%*[^()])%r
1319
1320Note that in some cases file names in the LaTeX output log cannot be parsed
1321properly. The parser might have been messed up by unbalanced parentheses
1322then. The above example tries to catch the most relevant cases only.
1323You can customize the given setting to suit your own purposes, for example,
1324all the annoying "Overfull ..." warnings could be excluded from being
1325recognized as an error.
1326Alternatively to filtering the LaTeX compiler output, it is also possible
1327to directly read the *.log file that is produced by the [La]TeX compiler.
1328This contains even more useful information about possible error causes.
1329However, to properly parse such a complex file, an external filter should
1330be used. See the description further above how to make such a filter known
1331by Vim.
1332
1333 *errorformat-Perl*
1334In $VIMRUNTIME/tools you can find the efm_perl.pl script, which filters Perl
1335error messages into a format that quickfix mode will understand. See the
1336start of the file about how to use it.
1337
1338
1339
1340 vim:tw=78:ts=8:ft=help:norl: