annotate runtime/doc/quickfix.txt @ 3259:9eb7fdfb5e63 v7.3.398

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