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