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