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