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