Add arch taglines
[bpt/emacs.git] / lisp / progmodes / compile.el
CommitLineData
55535639 1;;; compile.el --- run compiler as inferior of Emacs, parse error messages
fad160d5 2
812fade8 3;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 97, 98, 1999, 2001, 2003
e335e194 4;; Free Software Foundation, Inc.
3a801d0c 5
c4d7c00a 6;; Author: Roland McGrath <roland@gnu.org>
d1c7011d 7;; Maintainer: FSF
e9571d2a 8;; Keywords: tools, processes
d1c7011d 9
55dfd2c4
RS
10;; This file is part of GNU Emacs.
11
29add8b9
RM
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
55dfd2c4 17;; GNU Emacs is distributed in the hope that it will be useful,
29add8b9
RM
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
b578f267
EN
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
55dfd2c4 26
5cc57841
ER
27;;; Commentary:
28
29;; This package provides the compile and grep facilities documented in
30;; the Emacs user's manual.
31
d1c7011d
ER
32;;; Code:
33
c5049fa0
RS
34(defgroup compilation nil
35 "Run compiler as inferior of Emacs, parse error messages."
36 :group 'tools
37 :group 'processes)
38
39
7c163413 40;;;###autoload
c5049fa0
RS
41(defcustom compilation-mode-hook nil
42 "*List of hook functions run by `compilation-mode' (see `run-hooks')."
43 :type 'hook
44 :group 'compilation)
7c163413
RM
45
46;;;###autoload
c5049fa0
RS
47(defcustom compilation-window-height nil
48 "*Number of lines in a compilation window. If nil, use Emacs default."
49 :type '(choice (const :tag "Default" nil)
50 integer)
51 :group 'compilation)
d3cb357b 52
c72095b3 53(defcustom compile-auto-highlight t
37f5f978 54 "*Specify how many compiler errors to highlight (and parse) initially.
a24770bc 55\(Highlighting applies to an error message when the mouse is over it.)
37f5f978
RS
56If this is a number N, all compiler error messages in the first N lines
57are highlighted and parsed as soon as they arrive in Emacs.
01e6e8c9 58If t, highlight and parse the whole compilation output as soon as it arrives.
37f5f978
RS
59If nil, don't highlight or parse any of the buffer until you try to
60move to the error messages.
61
01e6e8c9 62Those messages which are not parsed and highlighted initially
4315d68e
RS
63will be parsed and highlighted as soon as you try to move to them."
64 :type '(choice (const :tag "All" t)
65 (const :tag "None" nil)
66 (integer :tag "First N lines"))
67 :group 'compilation)
37f5f978 68
bcdb34a4
GM
69(defcustom grep-command nil
70 "The default grep command for \\[grep].
a45717da
MB
71If the grep program used supports an option to always include file names
72in its output (such as the `-H' option to GNU grep), it's a good idea to
73include it when specifying `grep-command'.
74
bcdb34a4
GM
75The default value of this variable is set up by `grep-compute-defaults';
76call that function before using this variable in your program."
3755bc9c
MR
77 :type '(choice string
78 (const :tag "Not Set" nil))
bcdb34a4
GM
79 :group 'compilation)
80
a45717da 81(defcustom grep-use-null-device 'auto-detect
3755bc9c 82 "If t, append the value of `null-device' to `grep' commands.
a45717da
MB
83This is done to ensure that the output of grep includes the filename of
84any match in the case where only a single file is searched, and is not
85necessary if the grep program used supports the `-H' option.
86
87The default value of this variable is set up by `grep-compute-defaults';
88call that function before using this variable in your program."
89 :type 'boolean
3755bc9c
MR
90 :type '(choice (const :tag "Do Not Append Null Device" nil)
91 (const :tag "Append Null Device" t)
92 (other :tag "Not Set" auto-detect))
a45717da
MB
93 :group 'compilation)
94
bcdb34a4
GM
95(defcustom grep-find-command nil
96 "The default find command for \\[grep-find].
97The default value of this variable is set up by `grep-compute-defaults';
98call that function before using this variable in your program."
3755bc9c
MR
99 :type '(choice string
100 (const :tag "Not Set" nil))
bcdb34a4
GM
101 :group 'compilation)
102
9ebd759d
KS
103(defcustom grep-tree-command nil
104 "The default find command for \\[grep-tree].
105The default value of this variable is set up by `grep-compute-defaults';
106call that function before using this variable in your program.
107The following place holders should be present in the string:
108 <D> - base directory for find
109 <X> - find options to restrict or expand the directory list
110 <F> - find options to limit the files matched
111 <C> - place to put -i if case insensitive grep
112 <R> - the regular expression searched for."
3755bc9c
MR
113 :type '(choice string
114 (const :tag "Not Set" nil))
9ebd759d 115 :version "21.4"
9ebd759d
KS
116 :group 'compilation)
117
118(defcustom grep-tree-files-aliases '(
119 ("ch" . "*.[ch]")
120 ("c" . "*.c")
121 ("h" . "*.h")
122 ("m" . "[Mm]akefile*")
123 ("asm" . "*.[sS]")
124 ("all" . "*")
125 ("el" . "*.el")
126 )
127 "*Alist of aliases for the FILES argument to `grep-tree'."
128 :type 'alist
129 :group 'compilation)
130
131(defcustom grep-tree-ignore-case t
132 "*If non-nil, `grep-tree' ignores case in matches."
133 :type 'boolean
134 :group 'compilation)
135
136(defcustom grep-tree-ignore-CVS-directories t
137 "*If non-nil, `grep-tree' does no recurse into CVS directories."
138 :type 'boolean
139 :group 'compilation)
140
55dfd2c4
RS
141(defvar compilation-error-list nil
142 "List of error message descriptors for visiting erring functions.
fc0094d7
RM
143Each error descriptor is a cons (or nil). Its car is a marker pointing to
144an error message. If its cdr is a marker, it points to the text of the
533304f8
RM
145line the message is about. If its cdr is a cons, it is a list
146\(\(DIRECTORY . FILE\) LINE [COLUMN]\). Or its cdr may be nil if that
147error is not interesting.
d3cb357b
RM
148
149The value may be t instead of a list; this means that the buffer of
29478cc5
JB
150error messages should be reparsed the next time the list of errors is wanted.
151
152Some other commands (like `diff') use this list to control the error
9c09c008 153message tracking facilities; if you change its structure, you should make
29478cc5
JB
154sure you also change those packages. Perhaps it is better not to change
155it at all.")
55dfd2c4
RS
156
157(defvar compilation-old-error-list nil
158 "Value of `compilation-error-list' after errors were parsed.")
159
501cf428 160(defvar compilation-parse-errors-function 'compilation-parse-errors
b2bb6ec8 161 "Function to call to parse error messages from a compilation.
c540863c
RM
162It takes args LIMIT-SEARCH and FIND-AT-LEAST.
163If LIMIT-SEARCH is non-nil, don't bother parsing past that location.
501cf428 164If FIND-AT-LEAST is non-nil, don't bother parsing after finding that
e78e10ca 165many new errors.
d3cb357b
RM
166It should read in the source files which have errors and set
167`compilation-error-list' to a list with an element for each error message
168found. See that variable for more info.")
55dfd2c4 169
e335e194
GM
170(defvar compilation-parse-errors-filename-function nil
171 "Function to call to post-process filenames while parsing error messages.
172It takes one arg FILENAME which is the name of a file as found
173in the compilation output, and should return a transformed file name.")
174
49683a13
EZ
175;;;###autoload
176(defvar compilation-process-setup-function nil
177 "*Function to call to customize the compilation process.
178This functions is called immediately before the compilation process is
179started. It can be used to set any variables or functions that are used
180while processing the output of the compilation process.")
181
aa228418 182;;;###autoload
d3cb357b 183(defvar compilation-buffer-name-function nil
6c43f2f9
RS
184 "Function to compute the name of a compilation buffer.
185The function receives one argument, the name of the major mode of the
186compilation buffer. It should return a string.
187nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
55dfd2c4 188
aa228418 189;;;###autoload
d3cb357b 190(defvar compilation-finish-function nil
c5049fa0 191 "Function to call when a compilation process finishes.
d3cb357b
RM
192It is called with two arguments: the compilation buffer, and a string
193describing how the process finished.")
55dfd2c4 194
4cc36b17
RS
195;;;###autoload
196(defvar compilation-finish-functions nil
c5049fa0 197 "Functions to call when a compilation process finishes.
4cc36b17
RS
198Each function is called with two arguments: the compilation buffer,
199and a string describing how the process finished.")
200
d3cb357b 201(defvar compilation-last-buffer nil
6c43f2f9
RS
202 "The most recent compilation buffer.
203A buffer becomes most recent when its compilation is started
204or when it is used with \\[next-error] or \\[compile-goto-error].")
55dfd2c4 205
ebff767c
RM
206(defvar compilation-in-progress nil
207 "List of compilation processes now running.")
208(or (assq 'compilation-in-progress minor-mode-alist)
209 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
210 minor-mode-alist)))
211
d3cb357b 212(defvar compilation-parsing-end nil
c4d7c00a 213 "Marker position of end of buffer when last error messages were parsed.")
d3cb357b
RM
214
215(defvar compilation-error-message "No more errors"
6c43f2f9
RS
216 "Message to print when no more matches are found.")
217
58856335
RS
218(defvar compilation-arguments nil
219 "Arguments that were given to `compile-internal'.")
220
6c43f2f9 221(defvar compilation-num-errors-found)
d3cb357b
RM
222
223(defvar compilation-error-regexp-alist
224 '(
d86bdede 225 ;; NOTE! See also grep-regexp-alist, below.
7ee790ac 226
d3cb357b 227 ;; 4.3BSD grep, cc, lint pass 1:
7ee790ac
RM
228 ;; /usr/src/foo/foo.c(8): warning: w may be used before set
229 ;; or GNU utilities:
230 ;; foo.c:8: error message
231 ;; or HP-UX 7.0 fc:
232 ;; foo.f :16 some horrible error message
08b1edf4
RM
233 ;; or GNU utilities with column (GNAT 1.82):
234 ;; foo.adb:2:1: Unit name does not match file name
9b7dee86
DL
235 ;; or with column and program name:
236 ;; jade:dbcommon.dsl:133:17:E: missing argument for function call
501cf428 237 ;;
57c8389c
JB
238 ;; We'll insist that the number be followed by a colon or closing
239 ;; paren, because otherwise this matches just about anything
240 ;; containing a number with spaces around it.
d914bed5
KH
241
242 ;; We insist on a non-digit in the file name
243 ;; so that we don't mistake the file name for a command name
244 ;; and take the line number as the file name.
a0730fbd 245 ("\\([a-zA-Z][-a-zA-Z._0-9]+: ?\\)?\
d914bed5 246\\([a-zA-Z]?:?[^:( \t\n]*[^:( \t\n0-9][^:( \t\n]*\\)[:(][ \t]*\\([0-9]+\\)\
e228c7e2 247\\([) \t]\\|:\\(\\([0-9]+:\\)\\|[0-9]*[^:0-9]\\)\\)" 2 3 6)
69d4d27f 248
fb49f36a
RS
249 ;; GNU utilities with precise locations (line and columns),
250 ;; possibly ranges:
251 ;; foo.c:8.23-9.1: error message
ccc41714 252 ("\\([a-zA-Z][-a-zA-Z._0-9]+\\): ?\
fb49f36a
RS
253\\([0-9]+\\)\\.\\([0-9]+\\)\
254-\\([0-9]+\\)\\.\\([0-9]+\\)\
255:" 1 2 3) ;; When ending points are supported, add line = 4 and col = 5.
256 ;; foo.c:8.23-45: error message
ccc41714 257 ("\\([a-zA-Z][-a-zA-Z._0-9]+\\): ?\
fb49f36a
RS
258\\([0-9]+\\)\\.\\([0-9]+\\)\
259-\\([0-9]+\\)\
260:" 1 2 3) ;; When ending points are supported, add line = 2 and col = 4.
261 ;; foo.c:8-45.3: error message
ccc41714 262 ("\\([a-zA-Z][-a-zA-Z._0-9]+\\): ?\
fb49f36a
RS
263\\([0-9]+\\)\
264-\\([0-9]+\\)\\.\\([0-9]+\\)\
265:" 1 2 nil) ;; When ending points are supported, add line = 2 and col = 4.
266 ;; foo.c:8.23: error message
ccc41714 267 ("\\([a-zA-Z][-a-zA-Z._0-9]+\\): ?\
fb49f36a
RS
268\\([0-9]+\\)\\.\\([0-9]+\\)\
269:" 1 2 3)
270 ;; foo.c:8-23: error message
ccc41714 271 ("\\([a-zA-Z][-a-zA-Z._0-9]+\\): ?\
fb49f36a
RS
272\\([0-9]+\\)\
273-\\([0-9]+\\)\
274:" 1 2 nil);; When ending points are supported, add line = 3.
275
0c43cc89
RS
276 ;; Microsoft C/C++:
277 ;; keyboard.c(537) : warning C4005: 'min' : macro redefinition
278 ;; d:\tmp\test.c(23) : error C2143: syntax error : missing ';' before 'if'
9cab952d
RS
279 ;; This used to be less selective and allow characters other than
280 ;; parens around the line number, but that caused confusion for
281 ;; GNU-style error messages.
d2705a18 282 ;; This used to reject spaces and dashes in file names,
717149ec 283 ;; but they are valid now; so I made it more strict about the error
d2705a18
RS
284 ;; message that follows.
285 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
286: \\(error\\|warning\\) C[0-9]+:" 1 3)
0c43cc89 287
717149ec 288 ;; Borland C++, C++Builder:
69d4d27f
RS
289 ;; Error ping.c 15: Unable to open include file 'sys/types.h'
290 ;; Warning ping.c 68: Call to function 'func' with no prototype
717149ec
KH
291 ;; Error E2010 ping.c 15: Unable to open include file 'sys/types.h'
292 ;; Warning W1022 ping.c 68: Call to function 'func' with no prototype
293 ("\\(Error\\|Warning\\) \\(\\([FEW][0-9]+\\) \\)?\
294\\([a-zA-Z]?:?[^:( \t\n]+\\)\
295 \\([0-9]+\\)\\([) \t]\\|:[^0-9\n]\\)" 4 5)
7ee790ac 296
56ce04a3
RS
297 ;; Valgrind (memory debugger for x86 GNU/Linux):
298 ;; ==1332== at 0x8008621: main (vtest.c:180)
299 ;; Currently this regexp only matches the first error.
300 ;; Thanks to Hans Petter Jansson <hpj@ximian.com> for his regexp wisdom.
301 ("^==[0-9]+==[^(]+\(([^:]+):([0-9]+)" 1 2)
302
d3cb357b 303 ;; 4.3BSD lint pass 2
7ee790ac 304 ;; strcmp: variable # of args. llib-lc(359) :: /usr/src/foo/foo.c(8)
2fa55e20 305 (".*[ \t:]\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(](+[ \t]*\\([0-9]+\\))[:) \t]*$"
3e8258e7 306 1 2)
7ee790ac 307
d3cb357b 308 ;; 4.3BSD lint pass 3
7ee790ac 309 ;; bloofle defined( /users/wolfgang/foo.c(4) ), but never used
daa37602 310 ;; This used to be
3e8258e7 311 ;; ("[ \t(]+\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]+" 1 2)
daa37602 312 ;; which is regexp Impressionism - it matches almost anything!
2fa55e20 313 (".*([ \t]*\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\))" 1 2)
7ee790ac 314
369d3cdc
RM
315 ;; MIPS lint pass<n>; looks good for SunPro lint also
316 ;; TrimMask (255) in solomon.c may be indistinguishable from TrimMasks (93) in solomon.c due to truncation
2fa55e20 317 ("[^\n ]+ (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
369d3cdc 318 ;; name defined but never used: LinInt in cmap_calc.c(199)
2fa55e20 319 (".*in \\([^(\n]+\\)(\\([0-9]+\\))$" 1 2)
369d3cdc 320
ff735134 321 ;; Ultrix 3.0 f77:
f89fdaed 322 ;; fort: Severe: addstf.f, line 82: Missing operator or delimiter symbol
984ae4ed
RM
323 ;; Some SGI cc version:
324 ;; cfe: Warning 835: foo.c, line 2: something
2fa55e20 325 ("\\(cfe\\|fort\\): [^:\n]*: \\([^ \n]*\\), line \\([0-9]+\\):" 2 3)
501cf428 326 ;; Error on line 3 of t.f: Execution error unclassifiable statement
ff735134 327 ;; Unknown who does this:
9c09c008 328 ;; Line 45 of "foo.c": bloofle undefined
5ff3b093
RM
329 ;; Absoft FORTRAN 77 Compiler 3.1.3
330 ;; error on line 19 of fplot.f: spelling error?
331 ;; warning on line 17 of fplot.f: data type is undefined for variable d
a24770bc 332 ("\\(.* on \\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
3e8258e7 333of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2)
7ee790ac
RM
334
335 ;; Apollo cc, 4.3BSD fc:
336 ;; "foo.f", line 3: Error: syntax error near end of statement
6d68d793
RS
337 ;; IBM RS6000:
338 ;; "vvouch.c", line 19.5: 1506-046 (S) Syntax error.
a0c567b5
RM
339 ;; Microtec mcc68k:
340 ;; "foo.c", line 32 pos 1; (E) syntax error; unexpected symbol: "lossage"
501cf428 341 ;; GNAT (as of July 94):
37fd2208 342 ;; "foo.adb", line 2(11): warning: file name does not match ...
b1707ae4
RM
343 ;; IBM AIX xlc compiler:
344 ;; "src/swapping.c", line 30.34: 1506-342 (W) "/*" detected in comment.
2fa55e20 345 (".*\"\\([^,\" \n\t]+\\)\", lines? \
b1707ae4 346\\([0-9]+\\)\\([\(.]\\([0-9]+\\)\)?\\)?[:., (-]" 1 2 4)
18710add 347
154b2b10
RS
348 ;; Python:
349 ;; File "foobar.py", line 5, blah blah
350 ("^File \"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)," 1 2)
351
96db060f
RS
352 ;; Caml compiler:
353 ;; File "foobar.ml", lines 5-8, characters 20-155: blah blah
354 ("^File \"\\([^,\" \n\t]+\\)\", lines? \\([0-9]+\\)[-0-9]*, characters? \\([0-9]+\\)" 1 2 3)
355
18710add 356 ;; MIPS RISC CC - the one distributed with Ultrix:
7ee790ac 357 ;; ccom: Error: foo.c, line 2: syntax error
dfb89664 358 ;; DEC AXP OSF/1 cc
501cf428 359 ;; /usr/lib/cmplrs/cc/cfe: Error: foo.c: 1: blah blah
4d60e093 360 ("[a-z0-9/]+: \\([eE]rror\\|[wW]arning\\): \\([^,\" \n\t]+\\)[,:] \\(line \\)?\\([0-9]+\\):" 2 4)
7ee790ac
RM
361
362 ;; IBM AIX PS/2 C version 1.1:
363 ;; ****** Error number 140 in line 8 of file errors.c ******
2fa55e20 364 (".*in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
d3cb357b
RM
365 ;; IBM AIX lint is too painful to do right this way. File name
366 ;; prefixes entire sections rather than being on each line.
57c8389c 367
a24770bc
RS
368 ;; SPARCcompiler Pascal:
369 ;; 20 linjer : array[1..4] of linje;
370 ;; e 18480-----------^--- Inserted ';'
371 ;; and
372 ;; E 18520 line 61 - 0 is undefined
373 ;; These messages don't contain a file name. Instead the compiler gives
374 ;; a message whenever the file being compiled is changed.
375 (" +\\([0-9]+\\) +.*\n[ew] [0-9]+-+" nil 1)
376 ("[Ew] +[0-9]+ line \\([0-9]+\\) - " nil 1)
377
72244bea
RM
378 ;; Lucid Compiler, lcc 3.x
379 ;; E, file.cc(35,52) Illegal operation on pointers
2fa55e20 380 ("[EW], \\([^(\n]*\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)" 1 2 3)
72244bea 381
5b6858da
SM
382 ;; This seems to be superfluous because the first pattern matches it.
383 ;; ;; GNU messages with program name and optional column number.
384 ;; ("[a-zA-Z]?:?[^0-9 \n\t:]+[^ \n\t:]*:[ \t]*\\([^ \n\t:]+\\):\
385 ;;\\([0-9]+\\):\\(\\([0-9]+\\)[: \t]\\)?" 1 2 4)
4dbf8a2c
RM
386
387 ;; Cray C compiler error messages
a24770bc
RS
388 ("\\(cc\\| cft\\)-[0-9]+ c\\(c\\|f77\\): ERROR \\([^,\n]+, \\)* File = \
389\\([^,\n]+\\), Line = \\([0-9]+\\)" 4 5)
4dbf8a2c
RM
390
391 ;; IBM C/C++ Tools 2.01:
392 ;; foo.c(2:0) : informational EDC0804: Function foo is not referenced.
393 ;; foo.c(3:8) : warning EDC0833: Implicit return statement encountered.
394 ;; foo.c(5:5) : error EDC0350: Syntax error.
2fa55e20 395 ("\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) : " 1 2 3)
cfda7e6d 396
b1b56e01
RS
397 ;; IAR Systems C Compiler:
398 ;; "foo.c",3 Error[32]: Error message
399 ;; "foo.c",3 Warning[32]: Error message
400 ("\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(Error\\|Warning\\)\\[[0-9]+\\]:" 1 2)
401
cfda7e6d
RM
402 ;; Sun ada (VADS, Solaris):
403 ;; /home3/xdhar/rcds_rc/main.a, line 361, char 6:syntax error: "," inserted
2fa55e20 404 ("\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
cbf7f476
RS
405
406 ;; Perl -w:
407 ;; syntax error at automake line 922, near "':'"
3d8be0c9
RS
408 ;; Perl debugging traces
409 ;; store::odrecall('File_A', 'x2') called at store.pm line 90
410 (".* at \\([^ \n]+\\) line \\([0-9]+\\)[,.\n]" 1 2)
7ce22b41
RS
411
412 ;; Oracle pro*c:
413 ;; Semantic error at line 528, column 5, file erosacqdb.pc:
414 ("Semantic error at line \\([0-9]+\\), column \\([0-9]+\\), file \\(.*\\):"
415 3 1 2)
5dfa3d35
RS
416
417 ;; EPC F90 compiler:
418 ;; Error 24 at (2:progran.f90) : syntax error
419 ("Error [0-9]+ at (\\([0-9]*\\):\\([^)\n]+\\))" 2 1)
c7c5bbc0 420
04f12e57 421 ;; SGI IRIX MipsPro 7.3 compilers:
e3c0f9de
RS
422 ;; cc-1070 cc: ERROR File = linkl.c, Line = 38
423 (".*: ERROR File = \\(.+\\), Line = \\([0-9]+\\)" 1 2)
424 (".*: WARNING File = \\(.+\\), Line = \\([0-9]+\\)" 1 2)
425
c7c5bbc0 426 ;; Sun F90 error messages:
851231e9 427 ;; cf90-113 f90comp: ERROR NSE, File = Hoved.f90, Line = 16, Column = 3
c7c5bbc0
KH
428 (".* ERROR [a-zA-Z0-9 ]+, File = \\(.+\\), Line = \\([0-9]+\\), Column = \\([0-9]+\\)"
429 1 2 3)
c299126f
MB
430
431 ;; RXP - GPL XML validator at http://www.cogsci.ed.ac.uk/~richard/rxp.html:
432 ;; Error: Mismatched end tag: expected </geroup>, got </group>
433 ;; in unnamed entity at line 71 char 8 of file:///home/reto/test/group.xml
434 ("Error:.*\n.* line \\([0-9]+\\) char \\([0-9]+\\) of file://\\(.+\\)"
435 3 1 2)
436 ;; Warning: Start tag for undeclared element geroup
437 ;; in unnamed entity at line 4 char 8 of file:///home/reto/test/group.xml
438 ("Warning:.*\n.* line \\([0-9]+\\) char \\([0-9]+\\) of file://\\(.+\\)"
439 3 1 2)
e1f540f2
AS
440
441 ;; See http://ant.apache.org/faq.html
442 ;; Ant Java: works for jikes
443 ("^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):\\([0-9]+\\):[0-9]+:[0-9]+:" 1 2 3)
444
445 ;; Ant Java: works for javac
446 ("^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):" 1 2)
447
d3cb357b 448 )
40d63d1f 449
6c43f2f9 450 "Alist that specifies how to match errors in compiler output.
20c1daec 451Each elt has the form (REGEXP FILE-IDX LINE-IDX [COLUMN-IDX FILE-FORMAT...])
72244bea
RM
452If REGEXP matches, the FILE-IDX'th subexpression gives the file name, and
453the LINE-IDX'th subexpression gives the line number. If COLUMN-IDX is
20c1daec
RM
454given, the COLUMN-IDX'th subexpression gives the column number on that line.
455If any FILE-FORMAT is given, each is a format string to produce a file name to
456try; %s in the string is replaced by the text matching the FILE-IDX'th
457subexpression.")
55dfd2c4 458
a24770bc
RS
459(defvar compilation-enter-directory-regexp-alist
460 '(
461 ;; Matches lines printed by the `-w' option of GNU Make.
462 (".*: Entering directory `\\(.*\\)'$" 1)
3b5fb045
RS
463 ;; Matches lines made by Emacs byte compiler.
464 ("^Entering directory `\\(.*\\)'$" 1)
a24770bc
RS
465 )
466 "Alist specifying how to match lines that indicate a new current directory.
467Note that the match is done at the beginning of lines.
468Each elt has the form (REGEXP IDX).
469If REGEXP matches, the IDX'th subexpression gives the directory name.
470
471The default value matches lines printed by the `-w' option of GNU Make.")
472
473(defvar compilation-leave-directory-regexp-alist
474 '(
475 ;; Matches lines printed by the `-w' option of GNU Make.
476 (".*: Leaving directory `\\(.*\\)'$" 1)
3b5fb045
RS
477 ;; Matches lines made by Emacs byte compiler.
478 ("^Leaving directory `\\(.*\\)'$" 1)
a24770bc
RS
479 )
480"Alist specifying how to match lines that indicate restoring current directory.
481Note that the match is done at the beginning of lines.
482Each elt has the form (REGEXP IDX).
483If REGEXP matches, the IDX'th subexpression gives the name of the directory
851231e9 484being moved from. If IDX is nil, the last directory entered \(by a line
a24770bc
RS
485matching `compilation-enter-directory-regexp-alist'\) is assumed.
486
487The default value matches lines printed by the `-w' option of GNU Make.")
488
489(defvar compilation-file-regexp-alist
490 '(
491 ;; This matches entries with date time year file-name: like
492 ;; Thu May 14 10:46:12 1992 mom3.p:
493 ("\\w\\w\\w \\w\\w\\w +[0-9]+ [0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9][0-9][0-9][0-9] \\(.*\\):$" 1)
494 )
495 "Alist specifying how to match lines that indicate a new current file.
496Note that the match is done at the beginning of lines.
497Each elt has the form (REGEXP IDX).
851231e9 498If REGEXP matches, the IDX'th subexpression gives the file name. This is
a24770bc
RS
499used with compilers that don't indicate file name in every error message.")
500
501;; There is no generally useful regexp that will match non messages, but
502;; in special cases there might be one. The lines that are not matched by
503;; a regexp take much longer time than the ones that are recognized so if
504;; you have same regexeps here, parsing is faster.
505(defvar compilation-nomessage-regexp-alist
506 '(
507 )
508 "Alist specifying how to match lines that have no message.
509Note that the match is done at the beginning of lines.
851231e9 510Each elt has the form (REGEXP). This alist is by default empty, but if
a24770bc
RS
511you have some good regexps here, the parsing of messages will be faster.")
512
f8e03ecb
AS
513(defcustom compilation-error-screen-columns t
514 "*If non-nil, column numbers in error messages are screen columns.
515Otherwise they are interpreted as character positions, with
516each character occupying one column.
517The default is to use screen columns, which requires that the compilation
518program and Emacs agree about the display width of the characters,
519especially the TAB character."
520 :type 'boolean
521 :group 'compilation
522 :version "20.4")
523
c5049fa0 524(defcustom compilation-read-command t
851231e9
DL
525 "*Non-nil means \\[compile] reads the compilation command to use.
526Otherwise, \\[compile] just uses the value of `compile-command'."
c5049fa0
RS
527 :type 'boolean
528 :group 'compilation)
90016295 529
e83be080 530;;;###autoload
c5049fa0 531(defcustom compilation-ask-about-save t
851231e9 532 "*Non-nil means \\[compile] asks which buffers to save before compiling.
c5049fa0
RS
533Otherwise, it saves all modified buffers without asking."
534 :type 'boolean
535 :group 'compilation)
90016295 536
0d140e65
EZ
537;; Note: the character class after the optional drive letter does not
538;; include a space to support file names with blanks.
15d1a8da 539(defvar grep-regexp-alist
0d140e65 540 '(("\\([a-zA-Z]?:?[^:(\t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]" 1 2))
15d1a8da
RM
541 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
542
201bf332 543(defvar grep-program
000a6a76
RS
544 ;; Currently zgrep has trouble. It runs egrep instead of grep,
545 ;; and it doesn't pass along long options right.
546 "grep"
5b6858da
SM
547 ;; (if (equal (condition-case nil ; in case "zgrep" isn't in exec-path
548 ;; (call-process "zgrep" nil nil nil
549 ;; "foo" null-device)
550 ;; (error nil))
551 ;; 1)
552 ;; "zgrep"
553 ;; "grep")
1ffddaf4
RS
554 "The default grep program for `grep-command' and `grep-find-command'.
555This variable's value takes effect when `grep-compute-defaults' is called.")
201bf332 556
005e3bb6
SS
557(defvar find-program "find"
558 "The default find program for `grep-find-command'.
559This variable's value takes effect when `grep-compute-defaults' is called.")
560
1ffddaf4 561(defvar grep-find-use-xargs nil
201bf332
RS
562 "Whether \\[grep-find] uses the `xargs' utility by default.
563
dc2feacf 564If nil, it uses `find -exec'; if `gnu', it uses `find -print0' and `xargs -0';
201bf332
RS
565if not nil and not `gnu', it uses `find -print' and `xargs'.
566
1ffddaf4 567This variable's value takes effect when `grep-compute-defaults' is called.")
201bf332 568
7c163413 569;;;###autoload
c5049fa0 570(defcustom compilation-search-path '(nil)
7c163413 571 "*List of directories to search for source files named in error messages.
d3cb357b 572Elements should be directory names, not file names of directories.
c5049fa0
RS
573nil as an element means to try the default directory."
574 :type '(repeat (choice (const :tag "Default" nil)
575 (string :tag "Directory")))
576 :group 'compilation)
55dfd2c4 577
c5049fa0
RS
578(defcustom compile-command "make -k "
579 "*Last shell command used to do a compilation; default for next compilation.
55dfd2c4
RS
580
581Sometimes it is useful for files to supply local values for this variable.
582You might also use mode hooks to specify it in certain modes, like this:
583
61c4aaf8 584 (add-hook 'c-mode-hook
61c4aaf8
RS
585 (lambda ()
586 (unless (or (file-exists-p \"makefile\")
587 (file-exists-p \"Makefile\"))
5b6858da
SM
588 (set (make-local-variable 'compile-command)
589 (concat \"make -k \"
590 (file-name-sans-extension buffer-file-name))))))"
c5049fa0
RS
591 :type 'string
592 :group 'compilation)
55dfd2c4 593
d3cb357b 594(defvar compilation-directory-stack nil
6c43f2f9 595 "Stack of previous directories for `compilation-leave-directory-regexp'.
aa53db6a 596The last element is the directory the compilation was started in.")
d3cb357b 597
01f89d11
RM
598(defvar compilation-exit-message-function nil "\
599If non-nil, called when a compilation process dies to return a status message.
fd5e58d7
RM
600This should be a function of three arguments: process status, exit status,
601and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
602write into the compilation buffer, and to put in its mode line.")
01f89d11 603
c20f961b
JPW
604(defvar compilation-environment nil
605 "*List of environment variables for compilation to inherit.
606Each element should be a string of the form ENVVARNAME=VALUE.
607This list is temporarily prepended to `process-environment' prior to
608starting the compilation process.")
609
770970cb
RS
610;; History of compile commands.
611(defvar compile-history nil)
612;; History of grep commands.
613(defvar grep-history nil)
201bf332 614(defvar grep-find-history nil)
770970cb 615
e93b2a55
SM
616(defun compilation-mode-font-lock-keywords ()
617 "Return expressions to highlight in Compilation mode."
618 (nconc
619 ;;
620 ;; Compiler warning/error lines.
5dfa3d35
RS
621 (mapcar (function
622 (lambda (item)
623 ;; Prepend "^", adjusting FILE-IDX and LINE-IDX accordingly.
22052f1d
KH
624 (let ((file-idx (nth 1 item))
625 (line-idx (nth 2 item))
626 (col-idx (nth 3 item))
627 keyword)
628 (when (numberp col-idx)
629 (setq keyword
630 (cons (list (1+ col-idx) 'font-lock-type-face nil t)
631 keyword)))
5dfa3d35
RS
632 (when (numberp line-idx)
633 (setq keyword
634 (cons (list (1+ line-idx) 'font-lock-variable-name-face)
635 keyword)))
636 (when (numberp file-idx)
637 (setq keyword
638 (cons (list (1+ file-idx) 'font-lock-warning-face)
639 keyword)))
640 (cons (concat "^\\(" (nth 0 item) "\\)") keyword))))
e93b2a55
SM
641 compilation-error-regexp-alist)
642 (list
643 ;;
a24770bc 644 ;; Compiler output lines. Recognize `make[n]:' lines too.
e93b2a55
SM
645 '("^\\([A-Za-z_0-9/\.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
646 (1 font-lock-function-name-face) (3 font-lock-comment-face nil t)))
647 ))
01f89d11 648\f
d3cb357b 649;;;###autoload
55dfd2c4
RS
650(defun compile (command)
651 "Compile the program including the current buffer. Default: run `make'.
652Runs COMMAND, a shell command, in a separate process asynchronously
653with output going to the buffer `*compilation*'.
d3cb357b 654
55dfd2c4
RS
655You can then use the command \\[next-error] to find the next error message
656and move to the source code that caused it.
657
08b1edf4
RM
658Interactively, prompts for the command if `compilation-read-command' is
659non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
660
c72095b3
RS
661To run more than one compilation at once, start one and rename
662the \`*compilation*' buffer to some other name with
663\\[rename-buffer]. Then start the next one. On most systems,
664termination of the main compilation process kills its
665subprocesses.
d3cb357b
RM
666
667The name used for the buffer is actually whatever is returned by
668the function in `compilation-buffer-name-function', so you can set that
669to a function that generates a unique name."
90016295 670 (interactive
08b1edf4 671 (if (or compilation-read-command current-prefix-arg)
90016295 672 (list (read-from-minibuffer "Compile command: "
5b6858da 673 (eval compile-command) nil nil
90016295 674 '(compile-history . 1)))
5b6858da
SM
675 (list (eval compile-command))))
676 (unless (equal command (eval compile-command))
677 (setq compile-command command))
90016295 678 (save-some-buffers (not compilation-ask-about-save) nil)
5b6858da 679 (compile-internal command "No more errors"))
55dfd2c4 680
5b6858da 681;; run compile with the default command line
e60476ca 682(defun recompile ()
6867356a
RS
683 "Re-compile the program including the current buffer.
684If this is run in a compilation-mode buffer, re-use the arguments from the
685original use. Otherwise, it recompiles using `compile-command'."
e60476ca
RS
686 (interactive)
687 (save-some-buffers (not compilation-ask-about-save) nil)
6867356a
RS
688 (apply 'compile-internal (or compilation-arguments
689 `(,(eval compile-command) "No more errors"))))
09843b4a 690
acffd065
EZ
691(defun grep-process-setup ()
692 "Set up `compilation-exit-message-function' for `grep'."
693 (set (make-local-variable 'compilation-exit-message-function)
694 (lambda (status code msg)
695 (if (eq status 'exit)
696 (cond ((zerop code)
697 '("finished (matches found)\n" . "matched"))
698 ((= code 1)
699 '("finished with no matches found\n" . "no match"))
700 (t
701 (cons msg code)))
702 (cons msg code)))))
703
31902997
MR
704(defun grep-compute-defaults ()
705 (unless (or (not grep-use-null-device) (eq grep-use-null-device t))
706 (setq grep-use-null-device
707 (with-temp-buffer
708 (let ((hello-file (expand-file-name "HELLO" data-directory)))
709 (not
710 (and (equal (condition-case nil
711 (if grep-command
712 ;; `grep-command' is already set, so
713 ;; use that for testing.
714 (call-process-shell-command
715 grep-command nil t nil
716 "^English" hello-file)
717 ;; otherwise use `grep-program'
718 (call-process grep-program nil t nil
719 "-nH" "^English" hello-file))
720 (error nil))
721 0)
722 (progn
723 (goto-char (point-min))
724 (looking-at
725 (concat (regexp-quote hello-file)
726 ":[0-9]+:English")))))))))
727 (unless grep-command
728 (setq grep-command
729 (let ((required-options (if grep-use-null-device "-n" "-nH")))
730 (if (equal (condition-case nil ; in case "grep" isn't in exec-path
731 (call-process grep-program nil nil nil
732 "-e" "foo" null-device)
733 (error nil))
734 1)
735 (format "%s %s -e " grep-program required-options)
736 (format "%s %s " grep-program required-options)))))
737 (unless grep-find-use-xargs
738 (setq grep-find-use-xargs
739 (if (and
740 (equal (call-process "find" nil nil nil
741 null-device "-print0")
742 0)
743 (equal (call-process "xargs" nil nil nil
744 "-0" "-e" "echo")
745 0))
746 'gnu)))
747 (unless grep-find-command
748 (setq grep-find-command
749 (cond ((eq grep-find-use-xargs 'gnu)
750 (format "%s . -type f -print0 | xargs -0 -e %s"
751 find-program grep-command))
752 (grep-find-use-xargs
753 (format "%s . -type f -print | xargs %s"
754 find-program grep-command))
755 (t (cons (format "%s . -type f -exec %s {} %s \\;"
756 find-program grep-command null-device)
757 (+ 22 (length grep-command)))))))
758 (unless grep-tree-command
759 (setq grep-tree-command
760 (let* ((glen (length grep-program))
761 (gcmd (concat grep-program " <C>" (substring grep-command glen))))
762 (cond ((eq grep-find-use-xargs 'gnu)
763 (format "%s <D> <X> -type f <F> -print0 | xargs -0 -e %s <R>"
764 find-program gcmd))
765 (grep-find-use-xargs
766 (format "%s <D> <X> -type f <F> -print | xargs %s <R>"
767 find-program gcmd))
768 (t (format "%s <D> <X> -type f <F> -exec %s <R> {} %s \\;"
769 find-program gcmd null-device)))))))
770
4282eba1
SM
771(defun grep-default-command ()
772 (let ((tag-default
773 (funcall (or find-tag-default-function
774 (get major-mode 'find-tag-default-function)
775 ;; We use grep-tag-default instead of
776 ;; find-tag-default, to avoid loading etags.
777 'grep-tag-default)))
778 (sh-arg-re "\\(\\(?:\"\\(?:[^\"]\\|\\\\\"\\)+\"\\|'[^']+'\\|[^\"' \t\n]\\)+\\)")
779 (grep-default (or (car grep-history) grep-command)))
780 ;; Replace the thing matching for with that around cursor.
781 (when (or (string-match
782 (concat "[^ ]+\\s +\\(?:-[^ ]+\\s +\\)*"
783 sh-arg-re "\\(\\s +\\(\\S +\\)\\)?")
784 grep-default)
785 ;; If the string is not yet complete.
786 (string-match "\\(\\)\\'" grep-default))
787 (unless (or (not (stringp buffer-file-name))
788 (when (match-beginning 2)
789 (save-match-data
790 (string-match
791 (wildcard-to-regexp
792 (file-name-nondirectory
793 (match-string 3 grep-default)))
794 (file-name-nondirectory buffer-file-name)))))
795 (setq grep-default (concat (substring grep-default
796 0 (match-beginning 2))
797 " *."
798 (file-name-extension buffer-file-name))))
799 (replace-match (or tag-default "") t t grep-default 1))))
800
d3cb357b 801;;;###autoload
55dfd2c4
RS
802(defun grep (command-args)
803 "Run grep, with user-specified args, and collect output in a buffer.
966c0a72
RS
804While grep runs asynchronously, you can use \\[next-error] (M-x next-error),
805or \\<compilation-minor-mode-map>\\[compile-goto-error] in the grep \
806output buffer, to go to the lines
807where grep found matches.
d3cb357b 808
ffb4b7a1 809This command uses a special history list for its COMMAND-ARGS, so you can
7cd960e6
RS
810easily repeat a grep command.
811
812A prefix argument says to default the argument based upon the current
d1208263
KH
813tag the cursor is over, substituting it into the last grep command
814in the grep command history (or into `grep-command'
815if that history list is empty)."
55dfd2c4 816 (interactive
4282eba1 817 (progn
a45717da
MB
818 (unless (and grep-command
819 (or (not grep-use-null-device) (eq grep-use-null-device t)))
1ffddaf4 820 (grep-compute-defaults))
4282eba1
SM
821 (let ((default (grep-default-command)))
822 (list (read-from-minibuffer "Run grep (like this): "
823 (if current-prefix-arg
824 default grep-command)
825 nil nil 'grep-history
826 (if current-prefix-arg nil default))))))
7cd960e6 827
acffd065
EZ
828 ;; Setting process-setup-function makes exit-message-function work
829 ;; even when async processes aren't supported.
830 (let* ((compilation-process-setup-function 'grep-process-setup)
a45717da 831 (buf (compile-internal (if (and grep-use-null-device null-device)
cb60918c 832 (concat command-args " " null-device)
201bf332 833 command-args)
acffd065
EZ
834 "No more grep hits" "grep"
835 ;; Give it a simpler regexp to match.
836 nil grep-regexp-alist)))))
55dfd2c4 837
7cd960e6
RS
838;; This is a copy of find-tag-default from etags.el.
839(defun grep-tag-default ()
840 (save-excursion
841 (while (looking-at "\\sw\\|\\s_")
842 (forward-char 1))
843 (when (or (re-search-backward "\\sw\\|\\s_"
844 (save-excursion (beginning-of-line) (point))
845 t)
846 (re-search-forward "\\(\\sw\\|\\s_\\)+"
847 (save-excursion (end-of-line) (point))
848 t))
849 (goto-char (match-end 0))
850 (buffer-substring (point)
851 (progn (forward-sexp -1)
852 (while (looking-at "\\s'")
853 (forward-char 1))
854 (point))))))
201bf332
RS
855
856;;;###autoload
857(defun grep-find (command-args)
851231e9
DL
858 "Run grep via find, with user-specified args COMMAND-ARGS.
859Collect output in a buffer.
201bf332
RS
860While find runs asynchronously, you can use the \\[next-error] command
861to find the text that grep hits refer to.
862
863This command uses a special history list for its arguments, so you can
864easily repeat a find command."
865 (interactive
1ffddaf4
RS
866 (progn
867 (unless grep-find-command
868 (grep-compute-defaults))
869 (list (read-from-minibuffer "Run find (like this): "
870 grep-find-command nil nil
871 'grep-find-history))))
cb60918c 872 (let ((null-device nil)) ; see grep
201bf332
RS
873 (grep command-args)))
874
9ebd759d
KS
875(defun grep-expand-command-macros (command &optional regexp files dir excl case-fold)
876 "Patch grep COMMAND replacing <D>, etc."
877 (setq command
878 (replace-regexp-in-string "<D>"
879 (or dir ".") command t t))
880 (setq command
881 (replace-regexp-in-string "<X>"
882 (or excl "") command t t))
883 (setq command
884 (replace-regexp-in-string "<F>"
885 (or files "") command t t))
886 (setq command
887 (replace-regexp-in-string "<C>"
888 (if case-fold "-i" "") command t t))
889 (setq command
890 (replace-regexp-in-string "<R>"
891 (or regexp "") command t t))
892 command)
893
9ebd759d
KS
894(defvar grep-tree-last-regexp "")
895(defvar grep-tree-last-files (car (car grep-tree-files-aliases)))
896
cf3d4f6d 897;;;###autoload
dafe5452
KS
898(defun grep-tree (regexp files dir &optional subdirs)
899 "Grep for REGEXP in FILES in directory tree rooted at DIR.
9ebd759d 900Collect output in a buffer.
dafe5452
KS
901Interactively, prompt separately for each search parameter.
902With prefix arg, reuse previous REGEXP.
903The search is limited to file names matching shell pattern FILES.
904FILES may use abbreviations defined in `grep-tree-files-aliases', e.g.
905entering `ch' is equivalent to `*.[ch]'.
906
9ebd759d
KS
907While find runs asynchronously, you can use the \\[next-error] command
908to find the text that grep hits refer to.
909
910This command uses a special history list for its arguments, so you can
dafe5452
KS
911easily repeat a find command.
912
913When used non-interactively, optional arg SUBDIRS limits the search to
914those sub directories of DIR."
9ebd759d
KS
915 (interactive
916 (let* ((regexp
917 (if current-prefix-arg
918 grep-tree-last-regexp
919 (let* ((default (current-word))
920 (spec (read-string
921 (concat "Search for"
922 (if (and default (> (length default) 0))
923 (format " (default %s): " default) ": ")))))
924 (if (equal spec "") default spec))))
925 (files
926 (read-string (concat "Search for \"" regexp "\" in files (default " grep-tree-last-files "): ")))
927 (dir
928 (read-directory-name "Base directory: " nil default-directory t)))
929 (list regexp files dir)))
930 (unless grep-tree-command
931 (grep-compute-defaults))
932 (unless (and (stringp files) (> (length files) 0))
933 (setq files grep-tree-last-files))
934 (when files
935 (setq grep-tree-last-files files)
cf3d4f6d 936 (let ((mf (assoc files grep-tree-files-aliases)))
9ebd759d
KS
937 (if mf
938 (setq files (cdr mf)))))
939 (let ((command-args (grep-expand-command-macros
940 grep-tree-command
941 (setq grep-tree-last-regexp regexp)
942 (and files (concat "-name '" files "'"))
dafe5452
KS
943 (if subdirs
944 (if (stringp subdirs)
945 subdirs
946 (mapconcat 'identity subdirs " "))
dc2feacf 947 nil) ;; we change default-directory to dir
9ebd759d
KS
948 (and grep-tree-ignore-CVS-directories "-path '*/CVS' -prune -o ")
949 grep-tree-ignore-case))
950 (default-directory dir)
951 (null-device nil)) ; see grep
952 (grep command-args)))
953
b5812513
DL
954(defcustom compilation-scroll-output nil
955 "*Non-nil to scroll the *compilation* buffer window as output appears.
956
957Setting it causes the compilation-mode commands to put point at the
958end of their output window so that the end of the output is always
959visible rather than the begining."
960 :type 'boolean
a46fddeb 961 :version "20.3"
b5812513
DL
962 :group 'compilation)
963
7bdb67b2
GM
964
965(defun compilation-buffer-name (mode-name name-function)
966 "Return the name of a compilation buffer to use.
967If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
968to determine the buffer name.
969Likewise if `compilation-buffer-name-function' is non-nil.
970If current buffer is in Compilation mode for the same mode name
971return the name of the current buffer, so that it gets reused.
972Otherwise, construct a buffer name from MODE-NAME."
dc2feacf 973 (cond (name-function
7bdb67b2 974 (funcall name-function mode-name))
dc2feacf 975 (compilation-buffer-name-function
7bdb67b2
GM
976 (funcall compilation-buffer-name-function mode-name))
977 ((and (eq major-mode 'compilation-mode)
978 (equal mode-name (nth 2 compilation-arguments)))
979 (buffer-name))
980 (t
981 (concat "*" (downcase mode-name) "*"))))
982
983
55dfd2c4 984(defun compile-internal (command error-message
a24770bc
RS
985 &optional name-of-mode parser
986 error-regexp-alist name-function
987 enter-regexp-alist leave-regexp-alist
23b0c5fc
CW
988 file-regexp-alist nomessage-regexp-alist
989 no-async)
55dfd2c4
RS
990 "Run compilation command COMMAND (low level interface).
991ERROR-MESSAGE is a string to print if the user asks to see another error
a24770bc
RS
992and there are no more errors. The rest of the arguments, 3-10 are optional.
993For them nil means use the default.
994NAME-OF-MODE is the name to display as the major mode in the compilation
995buffer. PARSER is the error parser function. ERROR-REGEXP-ALIST is the error
996message regexp alist to use. NAME-FUNCTION is a function called to name the
997buffer. ENTER-REGEXP-ALIST is the enter directory message regexp alist to use.
998LEAVE-REGEXP-ALIST is the leave directory message regexp alist to use.
999FILE-REGEXP-ALIST is the change current file message regexp alist to use.
1000NOMESSAGE-REGEXP-ALIST is the nomessage regexp alist to use.
1001 The defaults for these variables are the global values of
1002\`compilation-parse-errors-function', `compilation-error-regexp-alist',
1003\`compilation-buffer-name-function', `compilation-enter-directory-regexp-alist',
1004\`compilation-leave-directory-regexp-alist', `compilation-file-regexp-alist',
1005\ and `compilation-nomessage-regexp-alist', respectively.
08815e25 1006For arg 7-10 a value t means an empty alist.
646bd331 1007
23b0c5fc
CW
1008If NO-ASYNC is non-nil, start the compilation process synchronously.
1009
646bd331 1010Returns the compilation buffer created."
23b0c5fc
CW
1011 (unless no-async
1012 (setq no-async (not (fboundp 'start-process))))
d3cb357b 1013 (let (outbuf)
55dfd2c4 1014 (save-excursion
d3cb357b
RM
1015 (or name-of-mode
1016 (setq name-of-mode "Compilation"))
1017 (setq outbuf
7bdb67b2
GM
1018 (get-buffer-create (compilation-buffer-name name-of-mode
1019 name-function)))
d3cb357b
RM
1020 (set-buffer outbuf)
1021 (let ((comp-proc (get-buffer-process (current-buffer))))
1022 (if comp-proc
1023 (if (or (not (eq (process-status comp-proc) 'run))
1024 (yes-or-no-p
bea1d57a
JB
1025 (format "A %s process is running; kill it? "
1026 name-of-mode)))
d3cb357b
RM
1027 (condition-case ()
1028 (progn
1029 (interrupt-process comp-proc)
1030 (sit-for 1)
1031 (delete-process comp-proc))
1032 (error nil))
1033 (error "Cannot have two processes in `%s' at once"
1034 (buffer-name))
1035 )))
1036 ;; In case the compilation buffer is current, make sure we get the global
1037 ;; values of compilation-error-regexp-alist, etc.
1038 (kill-all-local-variables))
a24770bc
RS
1039 (or error-regexp-alist
1040 (setq error-regexp-alist compilation-error-regexp-alist))
1041 (or enter-regexp-alist
1042 (setq enter-regexp-alist compilation-enter-directory-regexp-alist))
1043 (or leave-regexp-alist
1044 (setq leave-regexp-alist compilation-leave-directory-regexp-alist))
1045 (or file-regexp-alist
1046 (setq file-regexp-alist compilation-file-regexp-alist))
1047 (or nomessage-regexp-alist
1048 (setq nomessage-regexp-alist compilation-nomessage-regexp-alist))
1049 (or parser (setq parser compilation-parse-errors-function))
1050 (let ((thisdir default-directory)
501cf428 1051 outwin)
d3cb357b
RM
1052 (save-excursion
1053 ;; Clear out the compilation buffer and make it writable.
1054 ;; Change its default-directory to the directory where the compilation
1055 ;; will happen, and insert a `cd' command to indicate this.
1056 (set-buffer outbuf)
1057 (setq buffer-read-only nil)
5d5ab7ac 1058 (buffer-disable-undo (current-buffer))
d3cb357b 1059 (erase-buffer)
5d5ab7ac 1060 (buffer-enable-undo (current-buffer))
d3cb357b
RM
1061 (setq default-directory thisdir)
1062 (insert "cd " thisdir "\n" command "\n")
1063 (set-buffer-modified-p nil))
1064 ;; If we're already in the compilation buffer, go to the end
1065 ;; of the buffer, so point will track the compilation output.
1066 (if (eq outbuf (current-buffer))
1067 (goto-char (point-max)))
1068 ;; Pop up the compilation buffer.
92d8844e 1069 (setq outwin (display-buffer outbuf nil t))
812fade8 1070 (with-current-buffer outbuf
aa53db6a 1071 (compilation-mode name-of-mode)
5b6858da
SM
1072 ;; In what way is it non-ergonomic ? -stef
1073 ;; (toggle-read-only 1) ;;; Non-ergonomic.
d4ece679
RS
1074 (set (make-local-variable 'compilation-parse-errors-function) parser)
1075 (set (make-local-variable 'compilation-error-message) error-message)
a24770bc
RS
1076 (set (make-local-variable 'compilation-error-regexp-alist)
1077 error-regexp-alist)
1078 (set (make-local-variable 'compilation-enter-directory-regexp-alist)
1079 enter-regexp-alist)
1080 (set (make-local-variable 'compilation-leave-directory-regexp-alist)
1081 leave-regexp-alist)
1082 (set (make-local-variable 'compilation-file-regexp-alist)
1083 file-regexp-alist)
1084 (set (make-local-variable 'compilation-nomessage-regexp-alist)
1085 nomessage-regexp-alist)
58856335
RS
1086 (set (make-local-variable 'compilation-arguments)
1087 (list command error-message
1088 name-of-mode parser
1089 error-regexp-alist name-function
1090 enter-regexp-alist leave-regexp-alist
1091 file-regexp-alist nomessage-regexp-alist))
b5812513
DL
1092 ;; This proves a good idea if the buffer's going to scroll
1093 ;; with lazy-lock on.
32d6fffb 1094 (set (make-local-variable 'lazy-lock-defer-on-scrolling) t)
d4ece679
RS
1095 (setq default-directory thisdir
1096 compilation-directory-stack (list default-directory))
1097 (set-window-start outwin (point-min))
d4ece679
RS
1098 (or (eq outwin (selected-window))
1099 (set-window-point outwin (point-min)))
c94b02d6 1100 (compilation-set-window-height outwin)
49683a13
EZ
1101 (if compilation-process-setup-function
1102 (funcall compilation-process-setup-function))
d4ece679 1103 ;; Start the compilation.
23b0c5fc 1104 (if (not no-async)
75da8302
RS
1105 (let* ((process-environment
1106 (append
c20f961b 1107 compilation-environment
75da8302
RS
1108 (if (and (boundp 'system-uses-terminfo)
1109 system-uses-terminfo)
1110 (list "TERM=dumb" "TERMCAP="
1111 (format "COLUMNS=%d" (window-width)))
1112 (list "TERM=emacs"
1113 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1114 (window-width))))
1115 ;; Set the EMACS variable, but
1116 ;; don't override users' setting of $EMACS.
1117 (if (getenv "EMACS")
1118 process-environment
1119 (cons "EMACS=t" process-environment))))
2bb240a9
RS
1120 (proc (start-process-shell-command (downcase mode-name)
1121 outbuf
1122 command)))
35f7e85b
RS
1123 (set-process-sentinel proc 'compilation-sentinel)
1124 (set-process-filter proc 'compilation-filter)
1125 (set-marker (process-mark proc) (point) outbuf)
501cf428 1126 (setq compilation-in-progress
35f7e85b 1127 (cons proc compilation-in-progress)))
fd5e58d7
RM
1128 ;; No asynchronous processes available.
1129 (message "Executing `%s'..." command)
d3e56891
RS
1130 ;; Fake modeline display as if `start-process' were run.
1131 (setq mode-line-process ":run")
fd5e58d7
RM
1132 (force-mode-line-update)
1133 (sit-for 0) ; Force redisplay
35f7e85b 1134 (let ((status (call-process shell-file-name nil outbuf nil "-c"
fd5e58d7
RM
1135 command)))
1136 (cond ((numberp status)
1137 (compilation-handle-exit 'exit status
1138 (if (zerop status)
1139 "finished\n"
1140 (format "\
1141exited abnormally with code %d\n"
1142 status))))
1143 ((stringp status)
1144 (compilation-handle-exit 'signal status
1145 (concat status "\n")))
1146 (t
1147 (compilation-handle-exit 'bizarre status status))))
b5812513
DL
1148 (message "Executing `%s'...done" command)))
1149 (if compilation-scroll-output
bccc6e3d 1150 (save-selected-window
b5812513 1151 (select-window outwin)
bccc6e3d 1152 (goto-char (point-max)))))
d3cb357b
RM
1153 ;; Make it so the next C-x ` will use this buffer.
1154 (setq compilation-last-buffer outbuf)))
55dfd2c4 1155
c94b02d6 1156(defun compilation-set-window-height (window)
851231e9 1157 "Set the height of WINDOW according to `compilation-window-height'."
c94b02d6
RS
1158 (and compilation-window-height
1159 (= (window-width window) (frame-width (window-frame window)))
1160 ;; If window is alone in its frame, aside from a minibuffer,
1161 ;; don't change its height.
1162 (not (eq window (frame-root-window (window-frame window))))
812fade8
SM
1163 ;; This save-current-buffer prevents us from changing the current
1164 ;; buffer, which might not be the same as the selected window's buffer.
1165 (save-current-buffer
1166 (save-selected-window
1167 (select-window window)
1168 (enlarge-window (- compilation-window-height
1169 (window-height)))))))
c94b02d6 1170
4282eba1
SM
1171(defvar compilation-menu-map
1172 (let ((map (make-sparse-keymap "Errors")))
1173 (define-key map [stop-subjob]
37bf89ab 1174 '("Stop Compilation" . kill-compilation))
4282eba1
SM
1175 (define-key map [compilation-mode-separator2]
1176 '("----" . nil))
1177 (define-key map [compilation-mode-first-error]
1178 '("First Error" . first-error))
1179 (define-key map [compilation-mode-previous-error]
1180 '("Previous Error" . previous-error))
1181 (define-key map [compilation-mode-next-error]
1182 '("Next Error" . next-error))
1183 map))
1184
0b18a8f6 1185(defvar compilation-minor-mode-map
55dfd2c4 1186 (let ((map (make-sparse-keymap)))
f98494a4 1187 (define-key map [mouse-2] 'compile-mouse-goto-error)
55dfd2c4 1188 (define-key map "\C-c\C-c" 'compile-goto-error)
4e7ce12e 1189 (define-key map "\C-m" 'compile-goto-error)
d3cb357b 1190 (define-key map "\C-c\C-k" 'kill-compilation)
646bd331
RM
1191 (define-key map "\M-n" 'compilation-next-error)
1192 (define-key map "\M-p" 'compilation-previous-error)
d1ed4475
RM
1193 (define-key map "\M-{" 'compilation-previous-file)
1194 (define-key map "\M-}" 'compilation-next-file)
4282eba1
SM
1195 ;; Set up the menu-bar
1196 (define-key map [menu-bar compilation]
1197 (cons "Errors" compilation-menu-map))
55dfd2c4 1198 map)
4f6e4ad6 1199 "Keymap for `compilation-minor-mode'.")
0b18a8f6 1200
a24770bc
RS
1201(defvar compilation-shell-minor-mode-map
1202 (let ((map (make-sparse-keymap)))
1203 (define-key map [mouse-2] 'compile-mouse-goto-error)
1204 (define-key map "\M-\C-m" 'compile-goto-error)
1205 (define-key map "\M-\C-n" 'compilation-next-error)
1206 (define-key map "\M-\C-p" 'compilation-previous-error)
1207 (define-key map "\M-{" 'compilation-previous-file)
1208 (define-key map "\M-}" 'compilation-next-file)
1209 ;; Set up the menu-bar
4282eba1
SM
1210 (define-key map [menu-bar compilation]
1211 (cons "Errors" compilation-menu-map))
a24770bc
RS
1212 map)
1213 "Keymap for `compilation-shell-minor-mode'.")
1214
0b18a8f6 1215(defvar compilation-mode-map
4282eba1
SM
1216 (let ((map (make-sparse-keymap)))
1217 (set-keymap-parent map compilation-minor-mode-map)
0b18a8f6
RM
1218 (define-key map " " 'scroll-up)
1219 (define-key map "\^?" 'scroll-down)
e60476ca 1220 ;; Set up the menu-bar
4282eba1 1221 (define-key map [menu-bar compilation]
e60476ca 1222 (cons "Compile" (make-sparse-keymap "Compile")))
4282eba1 1223 (define-key map [menu-bar compilation compilation-separator2]
e60476ca 1224 '("----" . nil))
4282eba1 1225 (define-key map [menu-bar compilation compilation-mode-grep]
7933678b 1226 '("Search Files (grep)" . grep))
4282eba1 1227 (define-key map [menu-bar compilation compilation-mode-recompile]
e60476ca 1228 '("Recompile" . recompile))
4282eba1 1229 (define-key map [menu-bar compilation compilation-mode-compile]
32f4ab17 1230 '("Compile..." . compile))
0b18a8f6
RM
1231 map)
1232 "Keymap for compilation log buffers.
4282eba1 1233`compilation-minor-mode-map' is a parent of this.")
55dfd2c4 1234
0a35bd79
RS
1235(put 'compilation-mode 'mode-class 'special)
1236
501cf428 1237;;;###autoload
aa53db6a 1238(defun compilation-mode (&optional name-of-mode)
55dfd2c4
RS
1239 "Major mode for compilation log buffers.
1240\\<compilation-mode-map>To visit the source for a line-numbered error,
d3cb357b 1241move point to the error message line and type \\[compile-goto-error].
7c163413
RM
1242To kill the compilation, type \\[kill-compilation].
1243
1244Runs `compilation-mode-hook' with `run-hooks' (which see)."
55dfd2c4 1245 (interactive)
9af0d309 1246 (kill-all-local-variables)
55dfd2c4 1247 (use-local-map compilation-mode-map)
0b18a8f6 1248 (setq major-mode 'compilation-mode
aa53db6a 1249 mode-name (or name-of-mode "Compilation"))
0b18a8f6 1250 (compilation-setup)
63a2daf6
SM
1251 (set (make-local-variable 'font-lock-defaults)
1252 '(compilation-mode-font-lock-keywords t))
58856335
RS
1253 (set (make-local-variable 'revert-buffer-function)
1254 'compilation-revert-buffer)
0b18a8f6
RM
1255 (run-hooks 'compilation-mode-hook))
1256
58856335 1257(defun compilation-revert-buffer (ignore-auto noconfirm)
9ed2ab9f
RS
1258 (if buffer-file-name
1259 (let (revert-buffer-function)
1260 (revert-buffer ignore-auto noconfirm preserve-modes))
1261 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1262 (apply 'compile-internal compilation-arguments))))
58856335 1263
0b18a8f6 1264(defun compilation-setup ()
851231e9 1265 "Prepare the buffer for the compilation parsing commands to work."
0b18a8f6 1266 ;; Make the buffer's mode line show process state.
ebf0b439 1267 (setq mode-line-process '(":%s"))
d3cb357b
RM
1268 (set (make-local-variable 'compilation-error-list) nil)
1269 (set (make-local-variable 'compilation-old-error-list) nil)
c4d7c00a 1270 (set (make-local-variable 'compilation-parsing-end) (copy-marker 1))
474d71ae
RS
1271 (set (make-local-variable 'compilation-directory-stack)
1272 (list default-directory))
18aac618 1273 (make-local-variable 'compilation-error-screen-columns)
0b18a8f6
RM
1274 (setq compilation-last-buffer (current-buffer)))
1275
7052680b 1276;;;###autoload
4282eba1 1277(define-minor-mode compilation-shell-minor-mode
7052680b
RS
1278 "Toggle compilation shell minor mode.
1279With arg, turn compilation mode on if and only if arg is positive.
4282eba1
SM
1280In this minor mode, all the error-parsing commands of the
1281Compilation major mode are available but bound to keys that don't
1282collide with Shell mode. See `compilation-mode'.
7052680b 1283Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
4282eba1 1284 nil " Shell-Compile" nil
d408fed8 1285 :group 'compilation
4282eba1
SM
1286 (let (mode-line-process)
1287 (compilation-setup)))
7052680b 1288
d6bd8dca 1289;;;###autoload
4282eba1 1290(define-minor-mode compilation-minor-mode
0b18a8f6
RM
1291 "Toggle compilation minor mode.
1292With arg, turn compilation mode on if and only if arg is positive.
4282eba1
SM
1293In this minor mode, all the error-parsing commands of the
1294Compilation major mode are available. See `compilation-mode'.
fee3f63a 1295Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
4282eba1 1296 nil " Compilation" nil
d408fed8 1297 :group 'compilation
4282eba1
SM
1298 (let ((mode-line-process))
1299 (compilation-setup)))
55dfd2c4 1300
fd5e58d7 1301(defun compilation-handle-exit (process-status exit-status msg)
851231e9 1302 "Write msg in the current buffer and hack its mode-line-process."
fd5e58d7
RM
1303 (let ((buffer-read-only nil)
1304 (status (if compilation-exit-message-function
1305 (funcall compilation-exit-message-function
1306 process-status exit-status msg)
1307 (cons msg exit-status)))
1308 (omax (point-max))
1309 (opoint (point)))
1310 ;; Record where we put the message, so we can ignore it
1311 ;; later on.
1312 (goto-char omax)
1313 (insert ?\n mode-name " " (car status))
0eac1faa
RS
1314 (if (and (numberp compilation-window-height)
1315 (zerop compilation-window-height))
1316 (message "%s" (cdr status)))
01c50447
RS
1317 (if (bolp)
1318 (forward-char -1))
fd5e58d7 1319 (insert " at " (substring (current-time-string) 0 19))
01c50447 1320 (goto-char (point-max))
47092737
RS
1321 ;; Prevent that message from being recognized as a compilation error.
1322 (add-text-properties omax (point)
1323 (append '(compilation-handle-exit t) nil))
52f84622 1324 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
fd5e58d7
RM
1325 ;; Force mode line redisplay soon.
1326 (force-mode-line-update)
1327 (if (and opoint (< opoint omax))
1328 (goto-char opoint))
01e6e8c9
RS
1329 ;; Automatically parse (and mouse-highlight) error messages:
1330 (cond ((eq compile-auto-highlight t)
37f5f978 1331 (compile-reinitialize-errors nil (point-max)))
01e6e8c9
RS
1332 ((numberp compile-auto-highlight)
1333 (compile-reinitialize-errors nil
1334 (save-excursion
1335 (goto-line compile-auto-highlight)
1336 (point)))))
fd5e58d7 1337 (if compilation-finish-function
4cc36b17
RS
1338 (funcall compilation-finish-function (current-buffer) msg))
1339 (let ((functions compilation-finish-functions))
1340 (while functions
1341 (funcall (car functions) (current-buffer) msg)
1342 (setq functions (cdr functions))))))
fd5e58d7 1343
55dfd2c4 1344;; Called when compilation process changes state.
55dfd2c4 1345(defun compilation-sentinel (proc msg)
d3cb357b
RM
1346 "Sentinel for compilation buffers."
1347 (let ((buffer (process-buffer proc)))
ebff767c
RM
1348 (if (memq (process-status proc) '(signal exit))
1349 (progn
1350 (if (null (buffer-name buffer))
1351 ;; buffer killed
1352 (set-process-buffer proc nil)
fd5e58d7 1353 (let ((obuf (current-buffer)))
ebff767c
RM
1354 ;; save-excursion isn't the right thing if
1355 ;; process-buffer is current-buffer
1356 (unwind-protect
1357 (progn
1358 ;; Write something in the compilation buffer
1359 ;; and hack its mode line.
1360 (set-buffer buffer)
fd5e58d7
RM
1361 (compilation-handle-exit (process-status proc)
1362 (process-exit-status proc)
1363 msg)
1364 ;; Since the buffer and mode line will show that the
1365 ;; process is dead, we can delete it now. Otherwise it
1366 ;; will stay around until M-x list-processes.
1367 (delete-process proc))
6c43f2f9 1368 (set-buffer obuf))))
ebff767c
RM
1369 (setq compilation-in-progress (delq proc compilation-in-progress))
1370 ))))
55dfd2c4 1371
ad62b7f1
RM
1372(defun compilation-filter (proc string)
1373 "Process filter for compilation buffers.
4f6e4ad6 1374Just inserts the text, but uses `insert-before-markers'."
991c70f8 1375 (if (buffer-name (process-buffer proc))
ad62b7f1 1376 (save-excursion
991c70f8 1377 (set-buffer (process-buffer proc))
c4d7c00a
RS
1378 (let ((buffer-read-only nil)
1379 (end (marker-position compilation-parsing-end)))
991c70f8
RS
1380 (save-excursion
1381 (goto-char (process-mark proc))
1382 (insert-before-markers string)
c4d7c00a 1383 (set-marker compilation-parsing-end end) ;don't move it
d89793b7 1384 (run-hooks 'compilation-filter-hook)
c4d7c00a
RS
1385 ;; this seems redundant since we insert-before-marks -stefan
1386 ;;(set-marker (process-mark proc) (point))
1387 )))))
ad62b7f1 1388
b5bb472e 1389(defun compile-error-at-point ()
851231e9 1390 "Return the cdr of `compilation-old-error-list' for error containing point."
b5bb472e
RM
1391 (compile-reinitialize-errors nil (point))
1392 (let ((errors compilation-old-error-list))
1393 (while (and errors
1394 (> (point) (car (car errors))))
1395 (setq errors (cdr errors)))
1396 errors))
1397
51ba27e7 1398(defsubst compilation-buffer-p (buffer)
20c1daec
RM
1399 (save-excursion
1400 (set-buffer buffer)
a24770bc
RS
1401 (or compilation-shell-minor-mode compilation-minor-mode
1402 (eq major-mode 'compilation-mode))))
51ba27e7 1403
646bd331
RM
1404(defun compilation-next-error (n)
1405 "Move point to the next error in the compilation buffer.
851231e9
DL
1406Prefix arg N says how many error messages to move forwards (or
1407backwards, if negative).
646bd331
RM
1408Does NOT find the source line like \\[next-error]."
1409 (interactive "p")
1410 (or (compilation-buffer-p (current-buffer))
851231e9 1411 (error "Not in a compilation buffer"))
646bd331 1412 (setq compilation-last-buffer (current-buffer))
b5bb472e
RM
1413
1414 (let ((errors (compile-error-at-point)))
1415
1416 ;; Move to the error after the one containing point.
1417 (goto-char (car (if (< n 0)
1418 (let ((i 0)
1419 (e compilation-old-error-list))
1420 ;; See how many cdrs away ERRORS is from the start.
1421 (while (not (eq e errors))
1422 (setq i (1+ i)
1423 e (cdr e)))
1424 (if (> (- n) i)
1425 (error "Moved back past first error")
1426 (nth (+ i n) compilation-old-error-list)))
83b5c8e0 1427 (save-excursion
c72095b3 1428 (while (and (> n 0) errors)
83b5c8e0 1429 ;; Discard the current error and any previous.
c72095b3 1430 (while (and errors (>= (point) (car (car errors))))
83b5c8e0
RS
1431 (setq errors (cdr errors)))
1432 ;; Now (car errors) is the next error.
1433 ;; If we want to move down more errors,
1434 ;; put point at this one and start again.
1435 (setq n (1- n))
1436 (if (and errors (> n 0))
1437 (goto-char (car (car errors))))))
1438 (let ((compilation-error-list errors))
b5bb472e
RM
1439 (compile-reinitialize-errors nil nil n)
1440 (if compilation-error-list
1441 (nth (1- n) compilation-error-list)
1442 (error "Moved past last error"))))))))
646bd331
RM
1443
1444(defun compilation-previous-error (n)
1445 "Move point to the previous error in the compilation buffer.
851231e9
DL
1446Prefix arg N says how many error messages to move backwards (or
1447forwards, if negative).
646bd331
RM
1448Does NOT find the source line like \\[next-error]."
1449 (interactive "p")
1450 (compilation-next-error (- n)))
1451
1452
fc0094d7
RM
1453;; Given an elt of `compilation-error-list', return an object representing
1454;; the referenced file which is equal to (but not necessarily eq to) what
1455;; this function would return for another error in the same file.
1456(defsubst compilation-error-filedata (data)
b5bb472e
RM
1457 (setq data (cdr data))
1458 (if (markerp data)
fc0094d7 1459 (marker-buffer data)
aead2f9f 1460 (car data)))
b5bb472e 1461
fc0094d7
RM
1462;; Return a string describing a value from compilation-error-filedata.
1463;; This value is not necessarily useful as a file name, but should be
1464;; indicative to the user of what file's errors are being referred to.
1465(defsubst compilation-error-filedata-file-name (filedata)
1466 (if (bufferp filedata)
1467 (buffer-file-name filedata)
1468 (car filedata)))
1469
b5bb472e
RM
1470(defun compilation-next-file (n)
1471 "Move point to the next error for a different file than the current one."
1472 (interactive "p")
1473 (or (compilation-buffer-p (current-buffer))
851231e9 1474 (error "Not in a compilation buffer"))
b5bb472e
RM
1475 (setq compilation-last-buffer (current-buffer))
1476
1477 (let ((reversed (< n 0))
fc0094d7 1478 errors filedata)
b5bb472e
RM
1479
1480 (if (not reversed)
1481 (setq errors (or (compile-error-at-point)
1482 (error "Moved past last error")))
1483
1484 ;; Get a reversed list of the errors up through the one containing point.
1485 (compile-reinitialize-errors nil (point))
1486 (setq errors (reverse compilation-old-error-list)
1487 n (- n))
1488
1489 ;; Ignore errors after point. (car ERRORS) will be the error
1490 ;; containing point, (cadr ERRORS) the one before it.
1491 (while (and errors
1492 (< (point) (car (car errors))))
1493 (setq errors (cdr errors))))
1494
1495 (while (> n 0)
fc0094d7
RM
1496 (setq filedata (compilation-error-filedata (car errors)))
1497
1498 ;; Skip past the following errors for this file.
1499 (while (equal filedata
1500 (compilation-error-filedata
1501 (car (or errors
1502 (if reversed
1503 (error "%s the first erring file"
1504 (compilation-error-filedata-file-name
1505 filedata))
1506 (let ((compilation-error-list nil))
1507 ;; Parse some more.
1508 (compile-reinitialize-errors nil nil 2)
1509 (setq errors compilation-error-list)))
501cf428 1510 (error "%s is the last erring file"
fc0094d7
RM
1511 (compilation-error-filedata-file-name
1512 filedata))))))
b5bb472e
RM
1513 (setq errors (cdr errors)))
1514
1515 (setq n (1- n)))
1516
1517 ;; Move to the following error.
1518 (goto-char (car (car (or errors
1519 (if reversed
1520 (error "This is the first erring file")
1521 (let ((compilation-error-list nil))
1522 ;; Parse the last one.
1523 (compile-reinitialize-errors nil nil 1)
1524 compilation-error-list))))))))
1525
1526(defun compilation-previous-file (n)
1527 "Move point to the previous error for a different file than the current one."
1528 (interactive "p")
1529 (compilation-next-file (- n)))
1530
55dfd2c4 1531(defun kill-compilation ()
b765ba64 1532 "Kill the process made by the \\[compile] or \\[grep] commands."
55dfd2c4 1533 (interactive)
d3cb357b 1534 (let ((buffer (compilation-find-buffer)))
55dfd2c4 1535 (if (get-buffer-process buffer)
d3cb357b 1536 (interrupt-process (get-buffer-process buffer))
851231e9 1537 (error "The compilation process is not running"))))
d3cb357b 1538
b765ba64 1539(defalias 'kill-grep 'kill-compilation)
55dfd2c4 1540
d3cb357b
RM
1541;; Parse any new errors in the compilation buffer,
1542;; or reparse from the beginning if the user has asked for that.
eaa3cac5
RM
1543(defun compile-reinitialize-errors (reparse
1544 &optional limit-search find-at-least)
d3cb357b
RM
1545 (save-excursion
1546 (set-buffer compilation-last-buffer)
1547 ;; If we are out of errors, or if user says "reparse",
1548 ;; discard the info we have, to force reparsing.
1549 (if (or (eq compilation-error-list t)
eaa3cac5 1550 reparse)
51ba27e7 1551 (compilation-forget-errors))
c540863c 1552 (if (and compilation-error-list
b5bb472e
RM
1553 (or (not limit-search)
1554 (> compilation-parsing-end limit-search))
c540863c 1555 (or (not find-at-least)
a72ba929 1556 (>= (length compilation-error-list) find-at-least)))
d3cb357b
RM
1557 ;; Since compilation-error-list is non-nil, it points to a specific
1558 ;; error the user wanted. So don't move it around.
1559 nil
51ba27e7
RM
1560 ;; This was here for a long time (before my rewrite); why? --roland
1561 ;;(switch-to-buffer compilation-last-buffer)
55dfd2c4 1562 (set-buffer-modified-p nil)
b5bb472e 1563 (if (< compilation-parsing-end (point-max))
51ba27e7 1564 ;; compilation-error-list might be non-nil if we have a non-nil
676a14e1 1565 ;; LIMIT-SEARCH or FIND-AT-LEAST arg. In that case its value
51ba27e7
RM
1566 ;; records the current position in the error list, and we must
1567 ;; preserve that after reparsing.
1568 (let ((error-list-pos compilation-error-list))
b5bb472e 1569 (funcall compilation-parse-errors-function
51ba27e7
RM
1570 limit-search
1571 (and find-at-least
1572 ;; We only need enough new parsed errors to reach
1573 ;; FIND-AT-LEAST errors past the current
1574 ;; position.
1575 (- find-at-least (length compilation-error-list))))
1576 ;; Remember the entire list for compilation-forget-errors. If
1577 ;; this is an incremental parse, append to previous list. If
1578 ;; we are parsing anew, compilation-forget-errors cleared
1579 ;; compilation-old-error-list above.
1580 (setq compilation-old-error-list
1581 (nconc compilation-old-error-list compilation-error-list))
1582 (if error-list-pos
1583 ;; We started in the middle of an existing list of parsed
1584 ;; errors before parsing more; restore that position.
1585 (setq compilation-error-list error-list-pos))
01e6e8c9 1586 ;; Mouse-Highlight (the first line of) each error message when the
37f5f978
RS
1587 ;; mouse pointer moves over it:
1588 (let ((inhibit-read-only t)
474d71ae
RS
1589 (buffer-undo-list t)
1590 deactivate-mark
311ff235 1591 (buffer-was-modified (buffer-modified-p))
37f5f978
RS
1592 (error-list compilation-error-list))
1593 (while error-list
1594 (save-excursion
08de70d7
EZ
1595 (add-text-properties (goto-char (car (car error-list)))
1596 (progn (end-of-line) (point))
1597 '(mouse-face highlight help-echo "\
1598mouse-2: visit this file and line")))
311ff235
JB
1599 (setq error-list (cdr error-list)))
1600 (set-buffer-modified-p buffer-was-modified))
b5bb472e 1601 )))))
55dfd2c4 1602
f98494a4 1603(defun compile-mouse-goto-error (event)
d28701c7
RS
1604 "Visit the source for the error message the mouse is pointing at.
1605This is like `compile-goto-error' called without prefix arg
1606at the end of the line."
f98494a4 1607 (interactive "e")
e78e10ca
KH
1608 (save-excursion
1609 (set-buffer (window-buffer (posn-window (event-end event))))
1610 (goto-char (posn-point (event-end event)))
1611
1612 (or (compilation-buffer-p (current-buffer))
851231e9 1613 (error "Not in a compilation buffer"))
e78e10ca 1614 (setq compilation-last-buffer (current-buffer))
167d1418
EZ
1615 ;; `compile-reinitialize-errors' needs to see the complete filename
1616 ;; on the line where they clicked the mouse. Since it only looks
a24770bc 1617 ;; up to point, moving point to eol makes sure the filename is
167d1418
EZ
1618 ;; visible to `compile-reinitialize-errors'.
1619 (end-of-line)
e78e10ca
KH
1620 (compile-reinitialize-errors nil (point))
1621
1622 ;; Move to bol; the marker for the error on this line will point there.
1623 (beginning-of-line)
1624
1625 ;; Move compilation-error-list to the elt of compilation-old-error-list
1626 ;; we want.
1627 (setq compilation-error-list compilation-old-error-list)
1628 (while (and compilation-error-list
41a3354e
DL
1629 ;; The marker can point nowhere if we previously
1630 ;; failed to find the relevant file. See
1631 ;; compilation-next-error-locus.
1632 (or (null (marker-buffer (caar compilation-error-list)))
8f36a284 1633 (and (> (point) (caar compilation-error-list))
2827a3c1
RS
1634 (>= (point)
1635 ;; Don't skip too far: the text between
1636 ;; two errors belongs to the first. This
1637 ;; in-between text might be other errors
1638 ;; on the same line (see
1639 ;; compilation-skip-to-next-location).
1640 (if (null (cdr compilation-error-list))
1641 compilation-parsing-end
1642 (caar (cdr compilation-error-list)))))))
e78e10ca
KH
1643 (setq compilation-error-list (cdr compilation-error-list)))
1644 (or compilation-error-list
1645 (error "No error to go to")))
1646 (select-window (posn-window (event-end event)))
e78e10ca
KH
1647
1648 (push-mark)
1649 (next-error 1))
f98494a4 1650
55dfd2c4
RS
1651(defun compile-goto-error (&optional argp)
1652 "Visit the source for the error message point is on.
31efa7c9 1653Use this command in a compilation log buffer. Sets the mark at point there.
b2bb6ec8 1654\\[universal-argument] as a prefix arg means to reparse the buffer's error messages first;
55dfd2c4
RS
1655other kinds of prefix arguments are ignored."
1656 (interactive "P")
d3cb357b 1657 (or (compilation-buffer-p (current-buffer))
851231e9 1658 (error "Not in a compilation buffer"))
d3cb357b 1659 (setq compilation-last-buffer (current-buffer))
eaa3cac5 1660 (compile-reinitialize-errors (consp argp) (point))
646bd331 1661
15d1a8da
RM
1662 ;; Move to bol; the marker for the error on this line will point there.
1663 (beginning-of-line)
1664
646bd331 1665 ;; Move compilation-error-list to the elt of compilation-old-error-list
643f763f 1666 ;; we want.
646bd331 1667 (setq compilation-error-list compilation-old-error-list)
643f763f 1668 (while (and compilation-error-list
41a3354e
DL
1669 ;; The marker can point nowhere if we previously
1670 ;; failed to find the relevant file. See
1671 ;; compilation-next-error-locus.
1672 (or (null (marker-buffer (caar compilation-error-list)))
8f36a284 1673 (and (> (point) (caar compilation-error-list))
2827a3c1
RS
1674 (>= (point)
1675 ;; Don't skip too far: the text between
1676 ;; two errors belongs to the first. This
1677 ;; in-between text might be other errors
1678 ;; on the same line (see
1679 ;; compilation-skip-to-next-location).
1680 (if (null (cdr compilation-error-list))
1681 compilation-parsing-end
1682 (caar (cdr compilation-error-list)))))))
646bd331
RM
1683 (setq compilation-error-list (cdr compilation-error-list)))
1684
31efa7c9 1685 (push-mark)
643f763f 1686 (next-error 1))
55dfd2c4 1687
d3cb357b
RM
1688;; Return a compilation buffer.
1689;; If the current buffer is a compilation buffer, return it.
1690;; If compilation-last-buffer is set to a live buffer, use that.
1691;; Otherwise, look for a compilation buffer and signal an error
1692;; if there are none.
4746118a
JB
1693(defun compilation-find-buffer (&optional other-buffer)
1694 (if (and (not other-buffer)
1695 (compilation-buffer-p (current-buffer)))
d3cb357b
RM
1696 ;; The current buffer is a compilation buffer.
1697 (current-buffer)
4746118a 1698 (if (and compilation-last-buffer (buffer-name compilation-last-buffer)
95d219b5 1699 (compilation-buffer-p compilation-last-buffer)
4746118a
JB
1700 (or (not other-buffer) (not (eq compilation-last-buffer
1701 (current-buffer)))))
d3cb357b
RM
1702 compilation-last-buffer
1703 (let ((buffers (buffer-list)))
4746118a
JB
1704 (while (and buffers (or (not (compilation-buffer-p (car buffers)))
1705 (and other-buffer
1706 (eq (car buffers) (current-buffer)))))
d3cb357b
RM
1707 (setq buffers (cdr buffers)))
1708 (if buffers
1709 (car buffers)
4746118a
JB
1710 (or (and other-buffer
1711 (compilation-buffer-p (current-buffer))
1712 ;; The current buffer is a compilation buffer.
1713 (progn
1714 (if other-buffer
1715 (message "This is the only compilation buffer."))
1716 (current-buffer)))
1717 (error "No compilation started!")))))))
d3cb357b
RM
1718
1719;;;###autoload
55dfd2c4
RS
1720(defun next-error (&optional argp)
1721 "Visit next compilation error message and corresponding source code.
966c0a72
RS
1722
1723If all the error messages parsed so far have been processed already,
1724the message buffer is checked for new ones.
55dfd2c4 1725
ffb4b7a1 1726A prefix ARGP specifies how many error messages to move;
55dfd2c4 1727negative means move back to previous error messages.
ffb4b7a1 1728Just \\[universal-argument] as a prefix means reparse the error message buffer
55dfd2c4
RS
1729and start at the first error.
1730
966c0a72
RS
1731\\[next-error] normally uses the most recently started compilation or
1732grep buffer. However, it can operate on any buffer with output from
1733the \\[compile] and \\[grep] commands, or, more generally, on any
1734buffer in Compilation mode or with Compilation Minor mode enabled. To
1735specify use of a particular buffer for error messages, type
1736\\[next-error] in that buffer.
55dfd2c4 1737
966c0a72
RS
1738Once \\[next-error] has chosen the buffer for error messages,
1739it stays with that buffer until you use it in some other buffer which
1740uses Compilation mode or Compilation Minor mode.
55dfd2c4 1741
d3cb357b
RM
1742See variables `compilation-parse-errors-function' and
1743\`compilation-error-regexp-alist' for customization ideas."
55dfd2c4 1744 (interactive "P")
d3cb357b 1745 (setq compilation-last-buffer (compilation-find-buffer))
eaa3cac5
RM
1746 (compilation-goto-locus (compilation-next-error-locus
1747 ;; We want to pass a number here only if
1748 ;; we got a numeric prefix arg, not just C-u.
1749 (and (not (consp argp))
1750 (prefix-numeric-value argp))
1751 (consp argp))))
1752;;;###autoload (define-key ctl-x-map "`" 'next-error)
1753
00c8f418 1754(defun previous-error (argp)
e60476ca 1755 "Visit previous compilation error message and corresponding source code.
00c8f418
EZ
1756
1757A prefix ARGP specifies how many error messages to move;
1758negative means move forward to next error messages.
1759
1760This operates on the output from the \\[compile] and \\[grep] commands."
1761 (interactive "P")
1762 (next-error (- (prefix-numeric-value argp))))
e60476ca
RS
1763
1764(defun first-error ()
d9b73ccc 1765 "Reparse the error message buffer and start at the first error.
e60476ca
RS
1766Visit corresponding source code.
1767This operates on the output from the \\[compile] command."
1768 (interactive)
eae2c972 1769 (next-error '(4)))
e60476ca 1770
c41fe446
KH
1771(defvar compilation-skip-to-next-location nil
1772 "*If non-nil, skip multiple error messages for the same source location.")
1773
b4300a1a 1774(defun compilation-next-error-locus (&optional move reparse silent)
eaa3cac5
RM
1775 "Visit next compilation error and return locus in corresponding source code.
1776This operates on the output from the \\[compile] command.
1777If all preparsed error messages have been processed,
1778the error message buffer is checked for new ones.
1779
1780Returns a cons (ERROR . SOURCE) of two markers: ERROR is a marker at the
1781location of the error message in the compilation buffer, and SOURCE is a
1782marker at the location in the source code indicated by the error message.
1783
1784Optional first arg MOVE says how many error messages to move forwards (or
1785backwards, if negative); default is 1. Optional second arg REPARSE, if
1786non-nil, says to reparse the error message buffer and reset to the first
501cf428 1787error (plus MOVE - 1). If optional third argument SILENT is non-nil, return
b4300a1a 1788nil instead of raising an error if there are no more errors.
eaa3cac5
RM
1789
1790The current buffer should be the desired compilation output buffer."
1791 (or move (setq move 1))
667aec94 1792 (compile-reinitialize-errors reparse nil (and (not reparse) (max 0 move)))
d3cb357b 1793 (let (next-errors next-error)
7fb63acd
RS
1794 (catch 'no-next-error
1795 (save-excursion
1796 (set-buffer compilation-last-buffer)
1797 ;; compilation-error-list points to the "current" error.
501cf428 1798 (setq next-errors
7fb63acd
RS
1799 (if (> move 0)
1800 (nthcdr (1- move)
1801 compilation-error-list)
1802 ;; Zero or negative arg; we need to move back in the list.
1803 (let ((n (1- move))
1804 (i 0)
1805 (e compilation-old-error-list))
1806 ;; See how many cdrs away the current error is from the start.
1807 (while (not (eq e compilation-error-list))
1808 (setq i (1+ i)
1809 e (cdr e)))
1810 (if (> (- n) i)
1811 (error "Moved back past first error")
1812 (nthcdr (+ i n) compilation-old-error-list))))
1813 next-error (car next-errors))
1814 (while
1815 (if (null next-error)
1816 (progn
1817 (and move (/= move 1)
1818 (error (if (> move 0)
1819 "Moved past last error")
1820 "Moved back past first error"))
1821 ;; Forget existing error messages if compilation has finished.
1822 (if (not (and (get-buffer-process (current-buffer))
1823 (eq (process-status
1824 (get-buffer-process
1825 (current-buffer)))
1826 'run)))
1827 (compilation-forget-errors))
1828 (if silent
1829 (throw 'no-next-error nil)
1830 (error (concat compilation-error-message
1831 (and (get-buffer-process (current-buffer))
1832 (eq (process-status
1833 (get-buffer-process
1834 (current-buffer)))
1835 'run)
b4300a1a 1836 " yet")))))
7fb63acd
RS
1837 (setq compilation-error-list (cdr next-errors))
1838 (if (null (cdr next-error))
1839 ;; This error is boring. Go to the next.
1840 t
1841 (or (markerp (cdr next-error))
1842 ;; This error has a filename/lineno pair.
1843 ;; Find the file and turn it into a marker.
1844 (let* ((fileinfo (car (cdr next-error)))
20c1daec
RM
1845 (buffer (apply 'compilation-find-file
1846 (car next-error) fileinfo)))
7fb63acd
RS
1847 (if (null buffer)
1848 ;; We can't find this error's file.
1849 ;; Remove all errors in the same file.
1850 (progn
1851 (setq next-errors compilation-old-error-list)
1852 (while next-errors
1853 (and (consp (cdr (car next-errors)))
1854 (equal (car (cdr (car next-errors)))
1855 fileinfo)
1856 (progn
1857 (set-marker (car (car next-errors)) nil)
1858 (setcdr (car next-errors) nil)))
1859 (setq next-errors (cdr next-errors)))
1860 ;; Look for the next error.
1861 t)
1862 ;; We found the file. Get a marker for this error.
47d1bc29
KH
1863 ;; compilation-old-error-list and
1864 ;; compilation-error-screen-columns are buffer-local
1865 ;; so we must be careful to extract their value
7fb63acd
RS
1866 ;; before switching to the source file buffer.
1867 (let ((errors compilation-old-error-list)
47d1bc29 1868 (columns compilation-error-screen-columns)
7fb63acd
RS
1869 (last-line (nth 1 (cdr next-error)))
1870 (column (nth 2 (cdr next-error))))
1871 (set-buffer buffer)
1872 (save-excursion
1873 (save-restriction
1874 (widen)
1875 (goto-line last-line)
4dbf8a2c 1876 (if (and column (> column 0))
4ad26d84 1877 ;; Columns in error msgs are 1-origin.
47d1bc29 1878 (if columns
f8e03ecb
AS
1879 (move-to-column (1- column))
1880 (forward-char (1- column)))
7fb63acd
RS
1881 (beginning-of-line))
1882 (setcdr next-error (point-marker))
1883 ;; Make all the other error messages referring
1884 ;; to the same file have markers into the buffer.
1885 (while errors
1886 (and (consp (cdr (car errors)))
1887 (equal (car (cdr (car errors))) fileinfo)
1888 (let* ((this (nth 1 (cdr (car errors))))
1889 (column (nth 2 (cdr (car errors))))
1890 (lines (- this last-line)))
1891 (if (eq selective-display t)
1892 ;; When selective-display is t,
1893 ;; each C-m is a line boundary,
1894 ;; as well as each newline.
1895 (if (< lines 0)
1896 (re-search-backward "[\n\C-m]"
1897 nil 'end
1898 (- lines))
1899 (re-search-forward "[\n\C-m]"
1900 nil 'end
1901 lines))
1902 (forward-line lines))
eae2c972 1903 (if (and column (> column 1))
47d1bc29 1904 (if columns
f8e03ecb
AS
1905 (move-to-column (1- column))
1906 (forward-char (1- column)))
eae2c972 1907 (beginning-of-line))
7fb63acd
RS
1908 (setq last-line this)
1909 (setcdr (car errors) (point-marker))))
1910 (setq errors (cdr errors)))))))))
1911 ;; If we didn't get a marker for this error, or this
1912 ;; marker's buffer was killed, go on to the next one.
1913 (or (not (markerp (cdr next-error)))
1914 (not (marker-buffer (cdr next-error))))))
1915 (setq next-errors compilation-error-list
b4300a1a 1916 next-error (car next-errors)))))
d3cb357b 1917
c41fe446
KH
1918 (if compilation-skip-to-next-location
1919 ;; Skip over multiple error messages for the same source location,
1920 ;; so the next C-x ` won't go to an error in the same place.
1921 (while (and compilation-error-list
a24770bc
RS
1922 (equal (cdr (car compilation-error-list))
1923 (cdr next-error)))
c41fe446 1924 (setq compilation-error-list (cdr compilation-error-list))))
d3cb357b 1925
eaa3cac5
RM
1926 ;; We now have a marker for the position of the error source code.
1927 ;; NEXT-ERROR is a cons (ERROR . SOURCE) of two markers.
1928 next-error))
1929
1930(defun compilation-goto-locus (next-error)
1931 "Jump to an error locus returned by `compilation-next-error-locus'.
1932Takes one argument, a cons (ERROR . SOURCE) of two markers.
1933Selects a window with point at SOURCE, with another window displaying ERROR."
d28701c7
RS
1934 (if (eq (window-buffer (selected-window))
1935 (marker-buffer (car next-error)))
1936 ;; If the compilation buffer window is selected,
1937 ;; keep the compilation buffer in this window;
1938 ;; display the source in another window.
1939 (let ((pop-up-windows t))
1940 (pop-to-buffer (marker-buffer (cdr next-error))))
8f36a284
SM
1941 (if (window-dedicated-p (selected-window))
1942 (pop-to-buffer (marker-buffer (cdr next-error)))
d28701c7 1943 (switch-to-buffer (marker-buffer (cdr next-error)))))
eaa3cac5
RM
1944 (goto-char (cdr next-error))
1945 ;; If narrowing got in the way of
1946 ;; going to the right place, widen.
1947 (or (= (point) (marker-position (cdr next-error)))
1948 (progn
1949 (widen)
1950 (goto-char (cdr next-error))))
721cfafe
TTN
1951 ;; If hideshow got in the way of
1952 ;; seeing the right place, open permanently.
1953 (mapcar (function (lambda (ov)
1954 (when (eq 'hs (overlay-get ov 'invisible))
1955 (delete-overlay ov)
1956 (goto-char (cdr next-error)))))
1957 (overlays-at (point)))
eaa3cac5
RM
1958
1959 ;; Show compilation buffer in other window, scrolled to this error.
1960 (let* ((pop-up-windows t)
eae2c972 1961 ;; Use an existing window if it is in a visible frame.
c94b02d6 1962 (w (or (get-buffer-window (marker-buffer (car next-error)) 'visible)
eae2c972 1963 ;; Pop up a window.
c94b02d6 1964 (display-buffer (marker-buffer (car next-error))))))
eaa3cac5 1965 (set-window-point w (car next-error))
c94b02d6
RS
1966 (set-window-start w (car next-error))
1967 (compilation-set-window-height w)))
eaa3cac5 1968\f
20c1daec 1969(defun compilation-find-file (marker filename dir &rest formats)
851231e9 1970 "Find a buffer for file FILENAME.
ffb4b7a1
SM
1971Search the directories in `compilation-search-path'.
1972A nil in `compilation-search-path' means to try the
851231e9
DL
1973current directory, which is passed in DIR.
1974If FILENAME is not found at all, ask the user where to find it.
1975Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
20c1daec 1976 (or formats (setq formats '("%s")))
721cfafe
TTN
1977 (save-excursion
1978 (let ((dirs compilation-search-path)
1979 buffer thisdir fmts name)
1980 (if (file-name-absolute-p filename)
5b6858da
SM
1981 ;; The file name is absolute. Use its explicit directory as
1982 ;; the first in the search path, and strip it from FILENAME.
1983 (setq filename (abbreviate-file-name (expand-file-name filename))
1984 dirs (cons (file-name-directory filename) dirs)
1985 filename (file-name-nondirectory filename)))
721cfafe
TTN
1986 ;; Now search the path.
1987 (while (and dirs (null buffer))
1988 (setq thisdir (or (car dirs) dir)
1989 fmts formats)
1990 ;; For each directory, try each format string.
1991 (while (and fmts (null buffer))
1992 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1993 buffer (and (file-exists-p name)
ffb4b7a1 1994 (find-file-noselect name))
721cfafe
TTN
1995 fmts (cdr fmts)))
1996 (setq dirs (cdr dirs)))
1997 (or buffer
1998 ;; The file doesn't exist.
1999 ;; Ask the user where to find it.
2000 ;; If he hits C-g, then the next time he does
2001 ;; next-error, he'll skip past it.
2002 (let* ((pop-up-windows t)
2003 (w (display-buffer (marker-buffer marker))))
2004 (set-window-point w marker)
2005 (set-window-start w marker)
2006 (let ((name (expand-file-name
2007 (read-file-name
2008 (format "Find this error in: (default %s) "
2009 filename)
2010 dir filename t))))
2011 (if (file-directory-p name)
2012 (setq name (expand-file-name filename name)))
2013 (setq buffer (and (file-exists-p name)
2014 (find-file name))))))
2015 ;; Make intangible overlays tangible.
2016 (mapcar (function (lambda (ov)
2017 (when (overlay-get ov 'intangible)
2018 (overlay-put ov 'intangible nil))))
2019 (overlays-in (point-min) (point-max)))
2020 buffer)))
2021
56ce04a3
RS
2022(defun compilation-normalize-filename (filename)
2023 "Convert a filename string found in an error message to make it usable."
2024
2025 ;; Check for a comint-file-name-prefix and prepend it if
2026 ;; appropriate. (This is very useful for
2027 ;; compilation-minor-mode in an rlogin-mode buffer.)
2028 (and (boundp 'comint-file-name-prefix)
2029 ;; If file name is relative, default-directory will
2030 ;; already contain the comint-file-name-prefix (done
2031 ;; by compile-abbreviate-directory).
2032 (file-name-absolute-p filename)
2033 (setq filename
2034 (concat comint-file-name-prefix filename)))
2035
2036 ;; If compilation-parse-errors-filename-function is
2037 ;; defined, use it to process the filename.
2038 (when compilation-parse-errors-filename-function
2039 (setq filename
2040 (funcall compilation-parse-errors-filename-function
2041 filename)))
2042
2043 ;; Some compilers (e.g. Sun's java compiler, reportedly)
2044 ;; produce bogus file names like "./bar//foo.c" for file
2045 ;; "bar/foo.c"; expand-file-name will collapse these into
2046 ;; "/foo.c" and fail to find the appropriate file. So we
2047 ;; look for doubled slashes in the file name and fix them
2048 ;; up in the buffer.
2049 (setq filename (command-line-normalize-file-name filename)))
d3cb357b
RM
2050
2051;; Set compilation-error-list to nil, and unchain the markers that point to the
2052;; error messages and their text, so that they no longer slow down gap motion.
2053;; This would happen anyway at the next garbage collection, but it is better to
646bd331 2054;; do it right away.
e7512168 2055(defun compilation-forget-errors ()
55dfd2c4
RS
2056 (while compilation-old-error-list
2057 (let ((next-error (car compilation-old-error-list)))
2058 (set-marker (car next-error) nil)
d3cb357b
RM
2059 (if (markerp (cdr next-error))
2060 (set-marker (cdr next-error) nil)))
55dfd2c4 2061 (setq compilation-old-error-list (cdr compilation-old-error-list)))
bd3910fe 2062 (setq compilation-error-list nil
c4d7c00a 2063 compilation-directory-stack (list default-directory))
347c9140
RS
2064 (if compilation-parsing-end
2065 (set-marker compilation-parsing-end 1))
37f5f978 2066 ;; Remove the highlighting added by compile-reinitialize-errors:
474d71ae
RS
2067 (let ((inhibit-read-only t)
2068 (buffer-undo-list t)
2069 deactivate-mark)
08de70d7
EZ
2070 (remove-text-properties (point-min) (point-max)
2071 '(mouse-face highlight help-echo nil))))
d3cb357b
RM
2072
2073
a24770bc
RS
2074;; This function is not needed any more by compilation mode.
2075;; Does anyone else need it or can it be deleted?
d3cb357b
RM
2076(defun count-regexp-groupings (regexp)
2077 "Return the number of \\( ... \\) groupings in REGEXP (a string)."
2078 (let ((groupings 0)
2079 (len (length regexp))
2080 (i 0)
2081 c)
2082 (while (< i len)
2083 (setq c (aref regexp i)
2084 i (1+ i))
2085 (cond ((= c ?\[)
2086 ;; Find the end of this [...].
2087 (while (and (< i len)
2088 (not (= (aref regexp i) ?\])))
2089 (setq i (1+ i))))
2090 ((= c ?\\)
2091 (if (< i len)
2092 (progn
2093 (setq c (aref regexp i)
2094 i (1+ i))
2095 (if (= c ?\))
2096 ;; We found the end of a grouping,
2097 ;; so bump our counter.
2098 (setq groupings (1+ groupings))))))))
2099 groupings))
55dfd2c4 2100
a24770bc 2101(defvar compilation-current-file nil
851231e9 2102 "Used by `compilation-parse-errors' to store filename for file being compiled.")
a24770bc
RS
2103
2104;; This variable is not used as a global variable. It's defined here just to
2105;; shut up the byte compiler. It's bound and used by compilation-parse-errors
2106;; and set by compile-collect-regexps.
2107(defvar compilation-regexps nil)
2108
c540863c 2109(defun compilation-parse-errors (limit-search find-at-least)
a24770bc 2110 "Parse the current buffer as grep, cc, lint or other error messages.
d3cb357b 2111See variable `compilation-parse-errors-function' for the interface it uses."
55dfd2c4
RS
2112 (setq compilation-error-list nil)
2113 (message "Parsing error messages...")
a24770bc
RS
2114 (if (null compilation-error-regexp-alist)
2115 (error "compilation-error-regexp-alist is empty!"))
2116 (let* ((compilation-regexps nil) ; Variable set by compile-collect-regexps.
aa53db6a 2117 (default-directory (car compilation-directory-stack))
a24770bc
RS
2118 (found-desired nil)
2119 (compilation-num-errors-found 0)
2120 ;; Set up now the expanded, abbreviated directory variables
2121 ;; that compile-abbreviate-directory will need, so we can
2122 ;; compute them just once here.
2123 (orig (abbreviate-file-name default-directory))
2124 (orig-expanded (abbreviate-file-name
2125 (file-truename default-directory)))
2126 (parent-expanded (abbreviate-file-name
2127 (expand-file-name "../" orig-expanded))))
2128
2129 ;; Make a list of all the regexps. Each element has the form
2130 ;; (REGEXP TYPE IDX1 IDX2 ...)
2131 ;; where TYPE is one of leave, enter, file, error or nomessage.
2132 (compile-collect-regexps 'leave compilation-leave-directory-regexp-alist)
2133 (compile-collect-regexps 'enter compilation-enter-directory-regexp-alist)
2134 (compile-collect-regexps 'file compilation-file-regexp-alist)
a24770bc 2135 (compile-collect-regexps 'error compilation-error-regexp-alist)
2497076e 2136 (compile-collect-regexps 'nomessage compilation-nomessage-regexp-alist)
d3cb357b 2137
55dfd2c4
RS
2138 ;; Don't reparse messages already seen at last parse.
2139 (goto-char compilation-parsing-end)
9cab952d 2140 (when (and (bobp)
9dd1cf67 2141 (compilation-buffer-p (current-buffer)))
9cab952d
RS
2142 (setq compilation-current-file nil) ; No current file at start.
2143 ;; Don't parse the first two lines as error messages.
2144 ;; This matters for grep.
2145 (forward-line 2))
a24770bc
RS
2146
2147 ;; Parse messages.
47092737
RS
2148 (while (not (or found-desired (eobp)
2149 ;; Don't parse the "compilation finished" message
2150 ;; as a compilation error.
2151 (get-text-property (point) 'compilation-handle-exit)))
a24770bc
RS
2152 (let ((this compilation-regexps) (prev nil) (alist nil) type)
2153 ;; Go through the regular expressions. If a match is found,
2154 ;; variable alist is set to the corresponding alist and the
2155 ;; matching regexp is moved to the front of compilation-regexps
2156 ;; to make it match faster next time.
2157 (while (and this (null alist))
2158 (if (not (looking-at (car (car this))))
2159 (progn (setq prev this) ; No match, go to next.
2160 (setq this (cdr this)))
2161 (setq alist (cdr (car this))) ; Got a match.
2162;;; (if prev ; If not the first regexp,
2163;;; (progn ; move it to the front.
2164;;; (setcdr prev (cdr this))
2165;;; (setcdr this compilation-regexps)
2166;;; (setq compilation-regexps this)))
2167 ))
2168 (if (and alist ; Seen a match and not to
2169 (not (eq (setq type (car alist)) 'nomessage))) ; be ignored.
2170 (let* ((end-of-match (match-end 0))
2171 (filename
2172 (compile-buffer-substring (car (setq alist (cdr alist)))))
2173 stack)
2174 (if (eq type 'error) ; error message
2175 (let* ((linenum (if (numberp (car (setq alist (cdr alist))))
2176 (string-to-int
2177 (compile-buffer-substring (car alist)))
2178 ;; (car alist) is not a number, must be a
2179 ;; function that is called below to return
2180 ;; an error position descriptor.
2181 (car alist)))
2182 ;; Convert to integer later if linenum not a function.
2183 (column (compile-buffer-substring
2184 (car (setq alist (cdr alist)))))
2185 this-error)
2186
2187 ;; Check that we have a file name.
2188 (or filename
2189 ;; No file name in message, we must have seen it before
2190 (setq filename compilation-current-file)
2191 (error "\
851231e9 2192An error message with no file name and no file name has been seen earlier"))
a24770bc 2193
56ce04a3
RS
2194 ;; Clean up the file name string in several ways.
2195 (setq filename (compilation-normalize-filename filename))
a24770bc
RS
2196
2197 (setq filename
2198 (cons filename (cons default-directory (cdr alist))))
2199
2200 ;; Locate the erring file and line.
2201 ;; Make this-error a new elt for compilation-error-list,
2202 ;; giving a marker for the current compilation buffer
2203 ;; location, and the file and line number of the error.
2204 ;; Save, as the start of the error, the beginning of the
2205 ;; line containing the match.
bb40e751
RS
2206 (setq this-error
2207 (if (numberp linenum)
2208 (list (point-marker) filename linenum
2209 (and column (string-to-int column)))
2210 ;; If linenum is not a number then it must be
2211 ;; a function returning an error position
2212 ;; descriptor or nil (meaning no position).
2213 (save-excursion
2214 (funcall linenum filename column))))
721cfafe 2215
bb40e751
RS
2216 ;; We have an error position descriptor.
2217 ;; If we have found as many new errors as the user
2218 ;; wants, or if we are past the buffer position he
2219 ;; indicated, then we continue to parse until we have
2220 ;; seen all consecutive errors in the same file. This
2221 ;; means that all the errors of a source file will be
2222 ;; seen in one parsing run, so that the error positions
2223 ;; will be recorded as markers in the source file
2224 ;; buffer that will move when the buffer is changed.
2225 (if (and this-error
2226 compilation-error-list ; At least one previous.
2227 (or (and find-at-least
2228 (>= compilation-num-errors-found
2229 find-at-least))
2230 (and limit-search
2231 (>= end-of-match limit-search)))
5b6858da
SM
2232 ;; `this-error' could contain a pair of
2233 ;; markers already.
2234 (let ((thispos (cdr this-error))
2235 (lastpos (cdar compilation-error-list)))
2236 (not (equal
2237 (if (markerp thispos)
2238 (marker-buffer thispos)
2239 (car thispos))
2240 (if (markerp lastpos)
2241 (marker-buffer lastpos)
2242 (car lastpos))))))
bb40e751
RS
2243 ;; We are past the limits and the last error
2244 ;; parsed, didn't belong to the same source file
2245 ;; as the earlier ones i.e. we have seen all the
2246 ;; errors belonging to the earlier file. We don't
2247 ;; add the error just parsed so that the next
2248 ;; parsing run can get it and the following errors
2249 ;; in the same file all at once.
2250 (setq found-desired t)
2251
2252 (goto-char end-of-match) ; Prepare for next message.
2253 ;; Don't add the same source line more than once.
2254 (and this-error
2255 (not (and
2256 compilation-error-list
2257 (equal (cdr (car compilation-error-list))
2258 (cdr this-error))))
2259 (setq compilation-error-list
2260 (cons this-error compilation-error-list)
2261 compilation-num-errors-found
2262 (1+ compilation-num-errors-found)))))
a24770bc
RS
2263
2264 ;; Not an error message.
2265 (if (eq type `file) ; Change current file.
56ce04a3
RS
2266 (when filename
2267 (setq compilation-current-file
2268 ;; Clean up the file name string in several ways.
2269 (compilation-normalize-filename filename)))
a24770bc
RS
2270 ;; Enter or leave directory.
2271 (setq stack compilation-directory-stack)
56ce04a3
RS
2272 ;; Don't check if it is really a directory.
2273 ;; Let the code to search and clean up file names
2274 ;; try to use it in any case.
2275 (when filename
2276 ;; Clean up the directory name string in several ways.
2277 (setq filename (compilation-normalize-filename filename))
2278 (setq filename
2279 ;; The directory name in the message
2280 ;; is a truename. Try to convert it to a form
2281 ;; like what the user typed in.
2282 (compile-abbreviate-directory
2283 (file-name-as-directory
2284 (expand-file-name filename))
2285 orig orig-expanded parent-expanded))
2286 (if (eq type 'leave)
2287 ;; If we are leaving a specific directory,
2288 ;; as preparation, pop out of all other directories
2289 ;; that we entered nested within it.
2290 (while (and stack
2291 (not (string-equal (car stack)
2292 filename)))
2293 (setq stack (cdr stack)))
2294 (setq compilation-directory-stack
2295 (cons filename compilation-directory-stack)
2296 default-directory filename)))
58856335
RS
2297 (and (eq type 'leave)
2298 stack
2299 (setq compilation-directory-stack (cdr stack))
2300 (setq stack (car compilation-directory-stack))
bb40e751
RS
2301 (setq default-directory stack)))
2302 (goto-char end-of-match) ; Prepare to look at next message.
2303 (and limit-search (>= end-of-match limit-search)
2304 ;; The user wanted a specific error, and we're past it.
2305 ;; We do this check here rather than at the end of the
2306 ;; loop because if the last thing seen is an error
2307 ;; message, we must carefully discard the last error
2308 ;; when it is the first in a new file (see above in
2309 ;; the error-message case)
2310 (setq found-desired t)))
a24770bc
RS
2311
2312 ;; Go to before the last character in the message so that we will
2313 ;; see the next line also when the message ended at end of line.
2314 ;; When we ignore the last error message above, this will
2315 ;; cancel the effect of forward-line below so that point
2316 ;; doesn't move.
2317 (forward-char -1)
2318
2319 ;; Is this message necessary any more? Parsing is now so fast
2320 ;; that you might not need to know how it proceeds.
2321 (message
2322 "Parsing error messages...%d found. %.0f%% of buffer seen."
6c43f2f9 2323 compilation-num-errors-found
51ba27e7
RM
2324 ;; Use floating-point because (* 100 (point)) frequently
2325 ;; exceeds the range of Emacs Lisp integers.
2326 (/ (* 100.0 (point)) (point-max)))
47092737 2327 )))
a24770bc 2328
47092737 2329 (forward-line 1)) ; End of while loop. Look at next line.
a24770bc 2330
c4d7c00a 2331 (set-marker compilation-parsing-end (point))
a24770bc 2332 (setq compilation-error-list (nreverse compilation-error-list))
5b6858da
SM
2333 ;; (message "Parsing error messages...done. %d found. %.0f%% of buffer seen."
2334 ;; compilation-num-errors-found
2335 ;; (/ (* 100.0 (point)) (point-max)))
a24770bc
RS
2336 (message "Parsing error messages...done.")))
2337
2338(defun compile-collect-regexps (type this)
2339 ;; Add elements to variable compilation-regexps that is bound in
2340 ;; compilation-parse-errors.
2341 (and (not (eq this t))
02c1bd08
SM
2342 (dolist (el this)
2343 (push (cons (car el) (cons type (cdr el))) compilation-regexps))))
a24770bc
RS
2344
2345(defun compile-buffer-substring (index)
851231e9 2346 "Get substring matched by INDEXth subexpression."
a24770bc
RS
2347 (if index
2348 (let ((beg (match-beginning index)))
2349 (if beg (buffer-substring beg (match-end index))))))
55dfd2c4 2350
51501e54
RS
2351;; If directory DIR is a subdir of ORIG or of ORIG's parent,
2352;; return a relative name for it starting from ORIG or its parent.
2353;; ORIG-EXPANDED is an expanded version of ORIG.
2354;; PARENT-EXPANDED is an expanded version of ORIG's parent.
2355;; Those two args could be computed here, but we run faster by
2356;; having the caller compute them just once.
2357(defun compile-abbreviate-directory (dir orig orig-expanded parent-expanded)
cd494de4
RM
2358 ;; Apply canonical abbreviations to DIR first thing.
2359 ;; Those abbreviations are already done in the other arguments passed.
2360 (setq dir (abbreviate-file-name dir))
2361
1e0e614d
RM
2362 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2363 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2364 ;; buffer.)
2365 (if (boundp 'comint-file-name-prefix)
2366 (setq dir (concat comint-file-name-prefix dir)))
2367
51501e54
RS
2368 (if (and (> (length dir) (length orig-expanded))
2369 (string= orig-expanded
2370 (substring dir 0 (length orig-expanded))))
2371 (setq dir
2372 (concat orig
2373 (substring dir (length orig-expanded)))))
2374 (if (and (> (length dir) (length parent-expanded))
2375 (string= parent-expanded
2376 (substring dir 0 (length parent-expanded))))
2377 (setq dir
2378 (concat (file-name-directory
2379 (directory-file-name orig))
2380 (substring dir (length parent-expanded)))))
2381 dir)
2382
f1ed9461
DL
2383(add-to-list 'debug-ignored-errors "^No more errors\\( yet\\|\\)$")
2384
4746118a 2385(provide 'compile)
fad160d5 2386
ab5796a9 2387;;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
fad160d5 2388;;; compile.el ends here