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