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