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