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