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