(xic_set_preeditarea): Add the left fringe width to spot.x.
[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)
d3cb357b 440 )
40d63d1f 441
6c43f2f9 442 "Alist that specifies how to match errors in compiler output.
20c1daec 443Each elt has the form (REGEXP FILE-IDX LINE-IDX [COLUMN-IDX FILE-FORMAT...])
72244bea
RM
444If REGEXP matches, the FILE-IDX'th subexpression gives the file name, and
445the LINE-IDX'th subexpression gives the line number. If COLUMN-IDX is
20c1daec
RM
446given, the COLUMN-IDX'th subexpression gives the column number on that line.
447If any FILE-FORMAT is given, each is a format string to produce a file name to
448try; %s in the string is replaced by the text matching the FILE-IDX'th
449subexpression.")
55dfd2c4 450
a24770bc
RS
451(defvar compilation-enter-directory-regexp-alist
452 '(
453 ;; Matches lines printed by the `-w' option of GNU Make.
454 (".*: Entering directory `\\(.*\\)'$" 1)
3b5fb045
RS
455 ;; Matches lines made by Emacs byte compiler.
456 ("^Entering directory `\\(.*\\)'$" 1)
a24770bc
RS
457 )
458 "Alist specifying how to match lines that indicate a new current directory.
459Note that the match is done at the beginning of lines.
460Each elt has the form (REGEXP IDX).
461If REGEXP matches, the IDX'th subexpression gives the directory name.
462
463The default value matches lines printed by the `-w' option of GNU Make.")
464
465(defvar compilation-leave-directory-regexp-alist
466 '(
467 ;; Matches lines printed by the `-w' option of GNU Make.
468 (".*: Leaving directory `\\(.*\\)'$" 1)
3b5fb045
RS
469 ;; Matches lines made by Emacs byte compiler.
470 ("^Leaving directory `\\(.*\\)'$" 1)
a24770bc
RS
471 )
472"Alist specifying how to match lines that indicate restoring current directory.
473Note that the match is done at the beginning of lines.
474Each elt has the form (REGEXP IDX).
475If REGEXP matches, the IDX'th subexpression gives the name of the directory
851231e9 476being moved from. If IDX is nil, the last directory entered \(by a line
a24770bc
RS
477matching `compilation-enter-directory-regexp-alist'\) is assumed.
478
479The default value matches lines printed by the `-w' option of GNU Make.")
480
481(defvar compilation-file-regexp-alist
482 '(
483 ;; This matches entries with date time year file-name: like
484 ;; Thu May 14 10:46:12 1992 mom3.p:
485 ("\\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)
486 )
487 "Alist specifying how to match lines that indicate a new current file.
488Note that the match is done at the beginning of lines.
489Each elt has the form (REGEXP IDX).
851231e9 490If REGEXP matches, the IDX'th subexpression gives the file name. This is
a24770bc
RS
491used with compilers that don't indicate file name in every error message.")
492
493;; There is no generally useful regexp that will match non messages, but
494;; in special cases there might be one. The lines that are not matched by
495;; a regexp take much longer time than the ones that are recognized so if
496;; you have same regexeps here, parsing is faster.
497(defvar compilation-nomessage-regexp-alist
498 '(
499 )
500 "Alist specifying how to match lines that have no message.
501Note that the match is done at the beginning of lines.
851231e9 502Each elt has the form (REGEXP). This alist is by default empty, but if
a24770bc
RS
503you have some good regexps here, the parsing of messages will be faster.")
504
f8e03ecb
AS
505(defcustom compilation-error-screen-columns t
506 "*If non-nil, column numbers in error messages are screen columns.
507Otherwise they are interpreted as character positions, with
508each character occupying one column.
509The default is to use screen columns, which requires that the compilation
510program and Emacs agree about the display width of the characters,
511especially the TAB character."
512 :type 'boolean
513 :group 'compilation
514 :version "20.4")
515
c5049fa0 516(defcustom compilation-read-command t
851231e9
DL
517 "*Non-nil means \\[compile] reads the compilation command to use.
518Otherwise, \\[compile] just uses the value of `compile-command'."
c5049fa0
RS
519 :type 'boolean
520 :group 'compilation)
90016295 521
e83be080 522;;;###autoload
c5049fa0 523(defcustom compilation-ask-about-save t
851231e9 524 "*Non-nil means \\[compile] asks which buffers to save before compiling.
c5049fa0
RS
525Otherwise, it saves all modified buffers without asking."
526 :type 'boolean
527 :group 'compilation)
90016295 528
0d140e65
EZ
529;; Note: the character class after the optional drive letter does not
530;; include a space to support file names with blanks.
15d1a8da 531(defvar grep-regexp-alist
0d140e65 532 '(("\\([a-zA-Z]?:?[^:(\t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]" 1 2))
15d1a8da
RM
533 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
534
201bf332 535(defvar grep-program
000a6a76
RS
536 ;; Currently zgrep has trouble. It runs egrep instead of grep,
537 ;; and it doesn't pass along long options right.
538 "grep"
5b6858da
SM
539 ;; (if (equal (condition-case nil ; in case "zgrep" isn't in exec-path
540 ;; (call-process "zgrep" nil nil nil
541 ;; "foo" null-device)
542 ;; (error nil))
543 ;; 1)
544 ;; "zgrep"
545 ;; "grep")
1ffddaf4
RS
546 "The default grep program for `grep-command' and `grep-find-command'.
547This variable's value takes effect when `grep-compute-defaults' is called.")
201bf332 548
005e3bb6
SS
549(defvar find-program "find"
550 "The default find program for `grep-find-command'.
551This variable's value takes effect when `grep-compute-defaults' is called.")
552
1ffddaf4 553(defvar grep-find-use-xargs nil
201bf332
RS
554 "Whether \\[grep-find] uses the `xargs' utility by default.
555
dc2feacf 556If nil, it uses `find -exec'; if `gnu', it uses `find -print0' and `xargs -0';
201bf332
RS
557if not nil and not `gnu', it uses `find -print' and `xargs'.
558
1ffddaf4 559This variable's value takes effect when `grep-compute-defaults' is called.")
201bf332 560
7c163413 561;;;###autoload
c5049fa0 562(defcustom compilation-search-path '(nil)
7c163413 563 "*List of directories to search for source files named in error messages.
d3cb357b 564Elements should be directory names, not file names of directories.
c5049fa0
RS
565nil as an element means to try the default directory."
566 :type '(repeat (choice (const :tag "Default" nil)
567 (string :tag "Directory")))
568 :group 'compilation)
55dfd2c4 569
c5049fa0
RS
570(defcustom compile-command "make -k "
571 "*Last shell command used to do a compilation; default for next compilation.
55dfd2c4
RS
572
573Sometimes it is useful for files to supply local values for this variable.
574You might also use mode hooks to specify it in certain modes, like this:
575
61c4aaf8 576 (add-hook 'c-mode-hook
61c4aaf8
RS
577 (lambda ()
578 (unless (or (file-exists-p \"makefile\")
579 (file-exists-p \"Makefile\"))
5b6858da
SM
580 (set (make-local-variable 'compile-command)
581 (concat \"make -k \"
582 (file-name-sans-extension buffer-file-name))))))"
c5049fa0
RS
583 :type 'string
584 :group 'compilation)
55dfd2c4 585
d3cb357b 586(defvar compilation-directory-stack nil
6c43f2f9 587 "Stack of previous directories for `compilation-leave-directory-regexp'.
aa53db6a 588The last element is the directory the compilation was started in.")
d3cb357b 589
01f89d11
RM
590(defvar compilation-exit-message-function nil "\
591If non-nil, called when a compilation process dies to return a status message.
fd5e58d7
RM
592This should be a function of three arguments: process status, exit status,
593and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
594write into the compilation buffer, and to put in its mode line.")
01f89d11 595
770970cb
RS
596;; History of compile commands.
597(defvar compile-history nil)
598;; History of grep commands.
599(defvar grep-history nil)
201bf332 600(defvar grep-find-history nil)
770970cb 601
e93b2a55
SM
602(defun compilation-mode-font-lock-keywords ()
603 "Return expressions to highlight in Compilation mode."
604 (nconc
605 ;;
606 ;; Compiler warning/error lines.
5dfa3d35
RS
607 (mapcar (function
608 (lambda (item)
609 ;; Prepend "^", adjusting FILE-IDX and LINE-IDX accordingly.
22052f1d
KH
610 (let ((file-idx (nth 1 item))
611 (line-idx (nth 2 item))
612 (col-idx (nth 3 item))
613 keyword)
614 (when (numberp col-idx)
615 (setq keyword
616 (cons (list (1+ col-idx) 'font-lock-type-face nil t)
617 keyword)))
5dfa3d35
RS
618 (when (numberp line-idx)
619 (setq keyword
620 (cons (list (1+ line-idx) 'font-lock-variable-name-face)
621 keyword)))
622 (when (numberp file-idx)
623 (setq keyword
624 (cons (list (1+ file-idx) 'font-lock-warning-face)
625 keyword)))
626 (cons (concat "^\\(" (nth 0 item) "\\)") keyword))))
e93b2a55
SM
627 compilation-error-regexp-alist)
628 (list
629 ;;
a24770bc 630 ;; Compiler output lines. Recognize `make[n]:' lines too.
e93b2a55
SM
631 '("^\\([A-Za-z_0-9/\.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
632 (1 font-lock-function-name-face) (3 font-lock-comment-face nil t)))
633 ))
01f89d11 634\f
d3cb357b 635;;;###autoload
55dfd2c4
RS
636(defun compile (command)
637 "Compile the program including the current buffer. Default: run `make'.
638Runs COMMAND, a shell command, in a separate process asynchronously
639with output going to the buffer `*compilation*'.
d3cb357b 640
55dfd2c4
RS
641You can then use the command \\[next-error] to find the next error message
642and move to the source code that caused it.
643
08b1edf4
RM
644Interactively, prompts for the command if `compilation-read-command' is
645non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
646
c72095b3
RS
647To run more than one compilation at once, start one and rename
648the \`*compilation*' buffer to some other name with
649\\[rename-buffer]. Then start the next one. On most systems,
650termination of the main compilation process kills its
651subprocesses.
d3cb357b
RM
652
653The name used for the buffer is actually whatever is returned by
654the function in `compilation-buffer-name-function', so you can set that
655to a function that generates a unique name."
90016295 656 (interactive
08b1edf4 657 (if (or compilation-read-command current-prefix-arg)
90016295 658 (list (read-from-minibuffer "Compile command: "
5b6858da 659 (eval compile-command) nil nil
90016295 660 '(compile-history . 1)))
5b6858da
SM
661 (list (eval compile-command))))
662 (unless (equal command (eval compile-command))
663 (setq compile-command command))
90016295 664 (save-some-buffers (not compilation-ask-about-save) nil)
5b6858da 665 (compile-internal command "No more errors"))
55dfd2c4 666
5b6858da 667;; run compile with the default command line
e60476ca 668(defun recompile ()
6867356a
RS
669 "Re-compile the program including the current buffer.
670If this is run in a compilation-mode buffer, re-use the arguments from the
671original use. Otherwise, it recompiles using `compile-command'."
e60476ca
RS
672 (interactive)
673 (save-some-buffers (not compilation-ask-about-save) nil)
6867356a
RS
674 (apply 'compile-internal (or compilation-arguments
675 `(,(eval compile-command) "No more errors"))))
09843b4a 676
acffd065
EZ
677(defun grep-process-setup ()
678 "Set up `compilation-exit-message-function' for `grep'."
679 (set (make-local-variable 'compilation-exit-message-function)
680 (lambda (status code msg)
681 (if (eq status 'exit)
682 (cond ((zerop code)
683 '("finished (matches found)\n" . "matched"))
684 ((= code 1)
685 '("finished with no matches found\n" . "no match"))
686 (t
687 (cons msg code)))
688 (cons msg code)))))
689
31902997
MR
690(defun grep-compute-defaults ()
691 (unless (or (not grep-use-null-device) (eq grep-use-null-device t))
692 (setq grep-use-null-device
693 (with-temp-buffer
694 (let ((hello-file (expand-file-name "HELLO" data-directory)))
695 (not
696 (and (equal (condition-case nil
697 (if grep-command
698 ;; `grep-command' is already set, so
699 ;; use that for testing.
700 (call-process-shell-command
701 grep-command nil t nil
702 "^English" hello-file)
703 ;; otherwise use `grep-program'
704 (call-process grep-program nil t nil
705 "-nH" "^English" hello-file))
706 (error nil))
707 0)
708 (progn
709 (goto-char (point-min))
710 (looking-at
711 (concat (regexp-quote hello-file)
712 ":[0-9]+:English")))))))))
713 (unless grep-command
714 (setq grep-command
715 (let ((required-options (if grep-use-null-device "-n" "-nH")))
716 (if (equal (condition-case nil ; in case "grep" isn't in exec-path
717 (call-process grep-program nil nil nil
718 "-e" "foo" null-device)
719 (error nil))
720 1)
721 (format "%s %s -e " grep-program required-options)
722 (format "%s %s " grep-program required-options)))))
723 (unless grep-find-use-xargs
724 (setq grep-find-use-xargs
725 (if (and
726 (equal (call-process "find" nil nil nil
727 null-device "-print0")
728 0)
729 (equal (call-process "xargs" nil nil nil
730 "-0" "-e" "echo")
731 0))
732 'gnu)))
733 (unless grep-find-command
734 (setq grep-find-command
735 (cond ((eq grep-find-use-xargs 'gnu)
736 (format "%s . -type f -print0 | xargs -0 -e %s"
737 find-program grep-command))
738 (grep-find-use-xargs
739 (format "%s . -type f -print | xargs %s"
740 find-program grep-command))
741 (t (cons (format "%s . -type f -exec %s {} %s \\;"
742 find-program grep-command null-device)
743 (+ 22 (length grep-command)))))))
744 (unless grep-tree-command
745 (setq grep-tree-command
746 (let* ((glen (length grep-program))
747 (gcmd (concat grep-program " <C>" (substring grep-command glen))))
748 (cond ((eq grep-find-use-xargs 'gnu)
749 (format "%s <D> <X> -type f <F> -print0 | xargs -0 -e %s <R>"
750 find-program gcmd))
751 (grep-find-use-xargs
752 (format "%s <D> <X> -type f <F> -print | xargs %s <R>"
753 find-program gcmd))
754 (t (format "%s <D> <X> -type f <F> -exec %s <R> {} %s \\;"
755 find-program gcmd null-device)))))))
756
4282eba1
SM
757(defun grep-default-command ()
758 (let ((tag-default
759 (funcall (or find-tag-default-function
760 (get major-mode 'find-tag-default-function)
761 ;; We use grep-tag-default instead of
762 ;; find-tag-default, to avoid loading etags.
763 'grep-tag-default)))
764 (sh-arg-re "\\(\\(?:\"\\(?:[^\"]\\|\\\\\"\\)+\"\\|'[^']+'\\|[^\"' \t\n]\\)+\\)")
765 (grep-default (or (car grep-history) grep-command)))
766 ;; Replace the thing matching for with that around cursor.
767 (when (or (string-match
768 (concat "[^ ]+\\s +\\(?:-[^ ]+\\s +\\)*"
769 sh-arg-re "\\(\\s +\\(\\S +\\)\\)?")
770 grep-default)
771 ;; If the string is not yet complete.
772 (string-match "\\(\\)\\'" grep-default))
773 (unless (or (not (stringp buffer-file-name))
774 (when (match-beginning 2)
775 (save-match-data
776 (string-match
777 (wildcard-to-regexp
778 (file-name-nondirectory
779 (match-string 3 grep-default)))
780 (file-name-nondirectory buffer-file-name)))))
781 (setq grep-default (concat (substring grep-default
782 0 (match-beginning 2))
783 " *."
784 (file-name-extension buffer-file-name))))
785 (replace-match (or tag-default "") t t grep-default 1))))
786
d3cb357b 787;;;###autoload
55dfd2c4
RS
788(defun grep (command-args)
789 "Run grep, with user-specified args, and collect output in a buffer.
966c0a72
RS
790While grep runs asynchronously, you can use \\[next-error] (M-x next-error),
791or \\<compilation-minor-mode-map>\\[compile-goto-error] in the grep \
792output buffer, to go to the lines
793where grep found matches.
d3cb357b 794
ffb4b7a1 795This command uses a special history list for its COMMAND-ARGS, so you can
7cd960e6
RS
796easily repeat a grep command.
797
798A prefix argument says to default the argument based upon the current
d1208263
KH
799tag the cursor is over, substituting it into the last grep command
800in the grep command history (or into `grep-command'
801if that history list is empty)."
55dfd2c4 802 (interactive
4282eba1 803 (progn
a45717da
MB
804 (unless (and grep-command
805 (or (not grep-use-null-device) (eq grep-use-null-device t)))
1ffddaf4 806 (grep-compute-defaults))
4282eba1
SM
807 (let ((default (grep-default-command)))
808 (list (read-from-minibuffer "Run grep (like this): "
809 (if current-prefix-arg
810 default grep-command)
811 nil nil 'grep-history
812 (if current-prefix-arg nil default))))))
7cd960e6 813
acffd065
EZ
814 ;; Setting process-setup-function makes exit-message-function work
815 ;; even when async processes aren't supported.
816 (let* ((compilation-process-setup-function 'grep-process-setup)
a45717da 817 (buf (compile-internal (if (and grep-use-null-device null-device)
cb60918c 818 (concat command-args " " null-device)
201bf332 819 command-args)
acffd065
EZ
820 "No more grep hits" "grep"
821 ;; Give it a simpler regexp to match.
822 nil grep-regexp-alist)))))
55dfd2c4 823
7cd960e6
RS
824;; This is a copy of find-tag-default from etags.el.
825(defun grep-tag-default ()
826 (save-excursion
827 (while (looking-at "\\sw\\|\\s_")
828 (forward-char 1))
829 (when (or (re-search-backward "\\sw\\|\\s_"
830 (save-excursion (beginning-of-line) (point))
831 t)
832 (re-search-forward "\\(\\sw\\|\\s_\\)+"
833 (save-excursion (end-of-line) (point))
834 t))
835 (goto-char (match-end 0))
836 (buffer-substring (point)
837 (progn (forward-sexp -1)
838 (while (looking-at "\\s'")
839 (forward-char 1))
840 (point))))))
201bf332
RS
841
842;;;###autoload
843(defun grep-find (command-args)
851231e9
DL
844 "Run grep via find, with user-specified args COMMAND-ARGS.
845Collect output in a buffer.
201bf332
RS
846While find runs asynchronously, you can use the \\[next-error] command
847to find the text that grep hits refer to.
848
849This command uses a special history list for its arguments, so you can
850easily repeat a find command."
851 (interactive
1ffddaf4
RS
852 (progn
853 (unless grep-find-command
854 (grep-compute-defaults))
855 (list (read-from-minibuffer "Run find (like this): "
856 grep-find-command nil nil
857 'grep-find-history))))
cb60918c 858 (let ((null-device nil)) ; see grep
201bf332
RS
859 (grep command-args)))
860
9ebd759d
KS
861(defun grep-expand-command-macros (command &optional regexp files dir excl case-fold)
862 "Patch grep COMMAND replacing <D>, etc."
863 (setq command
864 (replace-regexp-in-string "<D>"
865 (or dir ".") command t t))
866 (setq command
867 (replace-regexp-in-string "<X>"
868 (or excl "") command t t))
869 (setq command
870 (replace-regexp-in-string "<F>"
871 (or files "") command t t))
872 (setq command
873 (replace-regexp-in-string "<C>"
874 (if case-fold "-i" "") command t t))
875 (setq command
876 (replace-regexp-in-string "<R>"
877 (or regexp "") command t t))
878 command)
879
9ebd759d
KS
880(defvar grep-tree-last-regexp "")
881(defvar grep-tree-last-files (car (car grep-tree-files-aliases)))
882
cf3d4f6d 883;;;###autoload
dafe5452
KS
884(defun grep-tree (regexp files dir &optional subdirs)
885 "Grep for REGEXP in FILES in directory tree rooted at DIR.
9ebd759d 886Collect output in a buffer.
dafe5452
KS
887Interactively, prompt separately for each search parameter.
888With prefix arg, reuse previous REGEXP.
889The search is limited to file names matching shell pattern FILES.
890FILES may use abbreviations defined in `grep-tree-files-aliases', e.g.
891entering `ch' is equivalent to `*.[ch]'.
892
9ebd759d
KS
893While find runs asynchronously, you can use the \\[next-error] command
894to find the text that grep hits refer to.
895
896This command uses a special history list for its arguments, so you can
dafe5452
KS
897easily repeat a find command.
898
899When used non-interactively, optional arg SUBDIRS limits the search to
900those sub directories of DIR."
9ebd759d
KS
901 (interactive
902 (let* ((regexp
903 (if current-prefix-arg
904 grep-tree-last-regexp
905 (let* ((default (current-word))
906 (spec (read-string
907 (concat "Search for"
908 (if (and default (> (length default) 0))
909 (format " (default %s): " default) ": ")))))
910 (if (equal spec "") default spec))))
911 (files
912 (read-string (concat "Search for \"" regexp "\" in files (default " grep-tree-last-files "): ")))
913 (dir
914 (read-directory-name "Base directory: " nil default-directory t)))
915 (list regexp files dir)))
916 (unless grep-tree-command
917 (grep-compute-defaults))
918 (unless (and (stringp files) (> (length files) 0))
919 (setq files grep-tree-last-files))
920 (when files
921 (setq grep-tree-last-files files)
cf3d4f6d 922 (let ((mf (assoc files grep-tree-files-aliases)))
9ebd759d
KS
923 (if mf
924 (setq files (cdr mf)))))
925 (let ((command-args (grep-expand-command-macros
926 grep-tree-command
927 (setq grep-tree-last-regexp regexp)
928 (and files (concat "-name '" files "'"))
dafe5452
KS
929 (if subdirs
930 (if (stringp subdirs)
931 subdirs
932 (mapconcat 'identity subdirs " "))
dc2feacf 933 nil) ;; we change default-directory to dir
9ebd759d
KS
934 (and grep-tree-ignore-CVS-directories "-path '*/CVS' -prune -o ")
935 grep-tree-ignore-case))
936 (default-directory dir)
937 (null-device nil)) ; see grep
938 (grep command-args)))
939
b5812513
DL
940(defcustom compilation-scroll-output nil
941 "*Non-nil to scroll the *compilation* buffer window as output appears.
942
943Setting it causes the compilation-mode commands to put point at the
944end of their output window so that the end of the output is always
945visible rather than the begining."
946 :type 'boolean
a46fddeb 947 :version "20.3"
b5812513
DL
948 :group 'compilation)
949
7bdb67b2
GM
950
951(defun compilation-buffer-name (mode-name name-function)
952 "Return the name of a compilation buffer to use.
953If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
954to determine the buffer name.
955Likewise if `compilation-buffer-name-function' is non-nil.
956If current buffer is in Compilation mode for the same mode name
957return the name of the current buffer, so that it gets reused.
958Otherwise, construct a buffer name from MODE-NAME."
dc2feacf 959 (cond (name-function
7bdb67b2 960 (funcall name-function mode-name))
dc2feacf 961 (compilation-buffer-name-function
7bdb67b2
GM
962 (funcall compilation-buffer-name-function mode-name))
963 ((and (eq major-mode 'compilation-mode)
964 (equal mode-name (nth 2 compilation-arguments)))
965 (buffer-name))
966 (t
967 (concat "*" (downcase mode-name) "*"))))
968
969
55dfd2c4 970(defun compile-internal (command error-message
a24770bc
RS
971 &optional name-of-mode parser
972 error-regexp-alist name-function
973 enter-regexp-alist leave-regexp-alist
23b0c5fc
CW
974 file-regexp-alist nomessage-regexp-alist
975 no-async)
55dfd2c4
RS
976 "Run compilation command COMMAND (low level interface).
977ERROR-MESSAGE is a string to print if the user asks to see another error
a24770bc
RS
978and there are no more errors. The rest of the arguments, 3-10 are optional.
979For them nil means use the default.
980NAME-OF-MODE is the name to display as the major mode in the compilation
981buffer. PARSER is the error parser function. ERROR-REGEXP-ALIST is the error
982message regexp alist to use. NAME-FUNCTION is a function called to name the
983buffer. ENTER-REGEXP-ALIST is the enter directory message regexp alist to use.
984LEAVE-REGEXP-ALIST is the leave directory message regexp alist to use.
985FILE-REGEXP-ALIST is the change current file message regexp alist to use.
986NOMESSAGE-REGEXP-ALIST is the nomessage regexp alist to use.
987 The defaults for these variables are the global values of
988\`compilation-parse-errors-function', `compilation-error-regexp-alist',
989\`compilation-buffer-name-function', `compilation-enter-directory-regexp-alist',
990\`compilation-leave-directory-regexp-alist', `compilation-file-regexp-alist',
991\ and `compilation-nomessage-regexp-alist', respectively.
08815e25 992For arg 7-10 a value t means an empty alist.
646bd331 993
23b0c5fc
CW
994If NO-ASYNC is non-nil, start the compilation process synchronously.
995
646bd331 996Returns the compilation buffer created."
23b0c5fc
CW
997 (unless no-async
998 (setq no-async (not (fboundp 'start-process))))
d3cb357b 999 (let (outbuf)
55dfd2c4 1000 (save-excursion
d3cb357b
RM
1001 (or name-of-mode
1002 (setq name-of-mode "Compilation"))
1003 (setq outbuf
7bdb67b2
GM
1004 (get-buffer-create (compilation-buffer-name name-of-mode
1005 name-function)))
d3cb357b
RM
1006 (set-buffer outbuf)
1007 (let ((comp-proc (get-buffer-process (current-buffer))))
1008 (if comp-proc
1009 (if (or (not (eq (process-status comp-proc) 'run))
1010 (yes-or-no-p
bea1d57a
JB
1011 (format "A %s process is running; kill it? "
1012 name-of-mode)))
d3cb357b
RM
1013 (condition-case ()
1014 (progn
1015 (interrupt-process comp-proc)
1016 (sit-for 1)
1017 (delete-process comp-proc))
1018 (error nil))
1019 (error "Cannot have two processes in `%s' at once"
1020 (buffer-name))
1021 )))
1022 ;; In case the compilation buffer is current, make sure we get the global
1023 ;; values of compilation-error-regexp-alist, etc.
1024 (kill-all-local-variables))
a24770bc
RS
1025 (or error-regexp-alist
1026 (setq error-regexp-alist compilation-error-regexp-alist))
1027 (or enter-regexp-alist
1028 (setq enter-regexp-alist compilation-enter-directory-regexp-alist))
1029 (or leave-regexp-alist
1030 (setq leave-regexp-alist compilation-leave-directory-regexp-alist))
1031 (or file-regexp-alist
1032 (setq file-regexp-alist compilation-file-regexp-alist))
1033 (or nomessage-regexp-alist
1034 (setq nomessage-regexp-alist compilation-nomessage-regexp-alist))
1035 (or parser (setq parser compilation-parse-errors-function))
1036 (let ((thisdir default-directory)
501cf428 1037 outwin)
d3cb357b
RM
1038 (save-excursion
1039 ;; Clear out the compilation buffer and make it writable.
1040 ;; Change its default-directory to the directory where the compilation
1041 ;; will happen, and insert a `cd' command to indicate this.
1042 (set-buffer outbuf)
1043 (setq buffer-read-only nil)
5d5ab7ac 1044 (buffer-disable-undo (current-buffer))
d3cb357b 1045 (erase-buffer)
5d5ab7ac 1046 (buffer-enable-undo (current-buffer))
d3cb357b
RM
1047 (setq default-directory thisdir)
1048 (insert "cd " thisdir "\n" command "\n")
1049 (set-buffer-modified-p nil))
1050 ;; If we're already in the compilation buffer, go to the end
1051 ;; of the buffer, so point will track the compilation output.
1052 (if (eq outbuf (current-buffer))
1053 (goto-char (point-max)))
1054 ;; Pop up the compilation buffer.
92d8844e 1055 (setq outwin (display-buffer outbuf nil t))
812fade8 1056 (with-current-buffer outbuf
aa53db6a 1057 (compilation-mode name-of-mode)
5b6858da
SM
1058 ;; In what way is it non-ergonomic ? -stef
1059 ;; (toggle-read-only 1) ;;; Non-ergonomic.
d4ece679
RS
1060 (set (make-local-variable 'compilation-parse-errors-function) parser)
1061 (set (make-local-variable 'compilation-error-message) error-message)
a24770bc
RS
1062 (set (make-local-variable 'compilation-error-regexp-alist)
1063 error-regexp-alist)
1064 (set (make-local-variable 'compilation-enter-directory-regexp-alist)
1065 enter-regexp-alist)
1066 (set (make-local-variable 'compilation-leave-directory-regexp-alist)
1067 leave-regexp-alist)
1068 (set (make-local-variable 'compilation-file-regexp-alist)
1069 file-regexp-alist)
1070 (set (make-local-variable 'compilation-nomessage-regexp-alist)
1071 nomessage-regexp-alist)
58856335
RS
1072 (set (make-local-variable 'compilation-arguments)
1073 (list command error-message
1074 name-of-mode parser
1075 error-regexp-alist name-function
1076 enter-regexp-alist leave-regexp-alist
1077 file-regexp-alist nomessage-regexp-alist))
b5812513
DL
1078 ;; This proves a good idea if the buffer's going to scroll
1079 ;; with lazy-lock on.
32d6fffb 1080 (set (make-local-variable 'lazy-lock-defer-on-scrolling) t)
d4ece679
RS
1081 (setq default-directory thisdir
1082 compilation-directory-stack (list default-directory))
1083 (set-window-start outwin (point-min))
d4ece679
RS
1084 (or (eq outwin (selected-window))
1085 (set-window-point outwin (point-min)))
c94b02d6 1086 (compilation-set-window-height outwin)
49683a13
EZ
1087 (if compilation-process-setup-function
1088 (funcall compilation-process-setup-function))
d4ece679 1089 ;; Start the compilation.
23b0c5fc 1090 (if (not no-async)
75da8302
RS
1091 (let* ((process-environment
1092 (append
1093 (if (and (boundp 'system-uses-terminfo)
1094 system-uses-terminfo)
1095 (list "TERM=dumb" "TERMCAP="
1096 (format "COLUMNS=%d" (window-width)))
1097 (list "TERM=emacs"
1098 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1099 (window-width))))
1100 ;; Set the EMACS variable, but
1101 ;; don't override users' setting of $EMACS.
1102 (if (getenv "EMACS")
1103 process-environment
1104 (cons "EMACS=t" process-environment))))
2bb240a9
RS
1105 (proc (start-process-shell-command (downcase mode-name)
1106 outbuf
1107 command)))
35f7e85b
RS
1108 (set-process-sentinel proc 'compilation-sentinel)
1109 (set-process-filter proc 'compilation-filter)
1110 (set-marker (process-mark proc) (point) outbuf)
501cf428 1111 (setq compilation-in-progress
35f7e85b 1112 (cons proc compilation-in-progress)))
fd5e58d7
RM
1113 ;; No asynchronous processes available.
1114 (message "Executing `%s'..." command)
d3e56891
RS
1115 ;; Fake modeline display as if `start-process' were run.
1116 (setq mode-line-process ":run")
fd5e58d7
RM
1117 (force-mode-line-update)
1118 (sit-for 0) ; Force redisplay
35f7e85b 1119 (let ((status (call-process shell-file-name nil outbuf nil "-c"
fd5e58d7
RM
1120 command)))
1121 (cond ((numberp status)
1122 (compilation-handle-exit 'exit status
1123 (if (zerop status)
1124 "finished\n"
1125 (format "\
1126exited abnormally with code %d\n"
1127 status))))
1128 ((stringp status)
1129 (compilation-handle-exit 'signal status
1130 (concat status "\n")))
1131 (t
1132 (compilation-handle-exit 'bizarre status status))))
b5812513
DL
1133 (message "Executing `%s'...done" command)))
1134 (if compilation-scroll-output
bccc6e3d 1135 (save-selected-window
b5812513 1136 (select-window outwin)
bccc6e3d 1137 (goto-char (point-max)))))
d3cb357b
RM
1138 ;; Make it so the next C-x ` will use this buffer.
1139 (setq compilation-last-buffer outbuf)))
55dfd2c4 1140
c94b02d6 1141(defun compilation-set-window-height (window)
851231e9 1142 "Set the height of WINDOW according to `compilation-window-height'."
c94b02d6
RS
1143 (and compilation-window-height
1144 (= (window-width window) (frame-width (window-frame window)))
1145 ;; If window is alone in its frame, aside from a minibuffer,
1146 ;; don't change its height.
1147 (not (eq window (frame-root-window (window-frame window))))
812fade8
SM
1148 ;; This save-current-buffer prevents us from changing the current
1149 ;; buffer, which might not be the same as the selected window's buffer.
1150 (save-current-buffer
1151 (save-selected-window
1152 (select-window window)
1153 (enlarge-window (- compilation-window-height
1154 (window-height)))))))
c94b02d6 1155
4282eba1
SM
1156(defvar compilation-menu-map
1157 (let ((map (make-sparse-keymap "Errors")))
1158 (define-key map [stop-subjob]
37bf89ab 1159 '("Stop Compilation" . kill-compilation))
4282eba1
SM
1160 (define-key map [compilation-mode-separator2]
1161 '("----" . nil))
1162 (define-key map [compilation-mode-first-error]
1163 '("First Error" . first-error))
1164 (define-key map [compilation-mode-previous-error]
1165 '("Previous Error" . previous-error))
1166 (define-key map [compilation-mode-next-error]
1167 '("Next Error" . next-error))
1168 map))
1169
0b18a8f6 1170(defvar compilation-minor-mode-map
55dfd2c4 1171 (let ((map (make-sparse-keymap)))
f98494a4 1172 (define-key map [mouse-2] 'compile-mouse-goto-error)
55dfd2c4 1173 (define-key map "\C-c\C-c" 'compile-goto-error)
4e7ce12e 1174 (define-key map "\C-m" 'compile-goto-error)
d3cb357b 1175 (define-key map "\C-c\C-k" 'kill-compilation)
646bd331
RM
1176 (define-key map "\M-n" 'compilation-next-error)
1177 (define-key map "\M-p" 'compilation-previous-error)
d1ed4475
RM
1178 (define-key map "\M-{" 'compilation-previous-file)
1179 (define-key map "\M-}" 'compilation-next-file)
4282eba1
SM
1180 ;; Set up the menu-bar
1181 (define-key map [menu-bar compilation]
1182 (cons "Errors" compilation-menu-map))
55dfd2c4 1183 map)
4f6e4ad6 1184 "Keymap for `compilation-minor-mode'.")
0b18a8f6 1185
a24770bc
RS
1186(defvar compilation-shell-minor-mode-map
1187 (let ((map (make-sparse-keymap)))
1188 (define-key map [mouse-2] 'compile-mouse-goto-error)
1189 (define-key map "\M-\C-m" 'compile-goto-error)
1190 (define-key map "\M-\C-n" 'compilation-next-error)
1191 (define-key map "\M-\C-p" 'compilation-previous-error)
1192 (define-key map "\M-{" 'compilation-previous-file)
1193 (define-key map "\M-}" 'compilation-next-file)
1194 ;; Set up the menu-bar
4282eba1
SM
1195 (define-key map [menu-bar compilation]
1196 (cons "Errors" compilation-menu-map))
a24770bc
RS
1197 map)
1198 "Keymap for `compilation-shell-minor-mode'.")
1199
0b18a8f6 1200(defvar compilation-mode-map
4282eba1
SM
1201 (let ((map (make-sparse-keymap)))
1202 (set-keymap-parent map compilation-minor-mode-map)
0b18a8f6
RM
1203 (define-key map " " 'scroll-up)
1204 (define-key map "\^?" 'scroll-down)
e60476ca 1205 ;; Set up the menu-bar
4282eba1 1206 (define-key map [menu-bar compilation]
e60476ca 1207 (cons "Compile" (make-sparse-keymap "Compile")))
4282eba1 1208 (define-key map [menu-bar compilation compilation-separator2]
e60476ca 1209 '("----" . nil))
4282eba1 1210 (define-key map [menu-bar compilation compilation-mode-grep]
7933678b 1211 '("Search Files (grep)" . grep))
4282eba1 1212 (define-key map [menu-bar compilation compilation-mode-recompile]
e60476ca 1213 '("Recompile" . recompile))
4282eba1 1214 (define-key map [menu-bar compilation compilation-mode-compile]
32f4ab17 1215 '("Compile..." . compile))
0b18a8f6
RM
1216 map)
1217 "Keymap for compilation log buffers.
4282eba1 1218`compilation-minor-mode-map' is a parent of this.")
55dfd2c4 1219
0a35bd79
RS
1220(put 'compilation-mode 'mode-class 'special)
1221
501cf428 1222;;;###autoload
aa53db6a 1223(defun compilation-mode (&optional name-of-mode)
55dfd2c4
RS
1224 "Major mode for compilation log buffers.
1225\\<compilation-mode-map>To visit the source for a line-numbered error,
d3cb357b 1226move point to the error message line and type \\[compile-goto-error].
7c163413
RM
1227To kill the compilation, type \\[kill-compilation].
1228
1229Runs `compilation-mode-hook' with `run-hooks' (which see)."
55dfd2c4 1230 (interactive)
9af0d309 1231 (kill-all-local-variables)
55dfd2c4 1232 (use-local-map compilation-mode-map)
0b18a8f6 1233 (setq major-mode 'compilation-mode
aa53db6a 1234 mode-name (or name-of-mode "Compilation"))
0b18a8f6 1235 (compilation-setup)
63a2daf6
SM
1236 (set (make-local-variable 'font-lock-defaults)
1237 '(compilation-mode-font-lock-keywords t))
58856335
RS
1238 (set (make-local-variable 'revert-buffer-function)
1239 'compilation-revert-buffer)
0b18a8f6
RM
1240 (run-hooks 'compilation-mode-hook))
1241
58856335 1242(defun compilation-revert-buffer (ignore-auto noconfirm)
9ed2ab9f
RS
1243 (if buffer-file-name
1244 (let (revert-buffer-function)
1245 (revert-buffer ignore-auto noconfirm preserve-modes))
1246 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1247 (apply 'compile-internal compilation-arguments))))
58856335 1248
0b18a8f6 1249(defun compilation-setup ()
851231e9 1250 "Prepare the buffer for the compilation parsing commands to work."
0b18a8f6 1251 ;; Make the buffer's mode line show process state.
ebf0b439 1252 (setq mode-line-process '(":%s"))
d3cb357b
RM
1253 (set (make-local-variable 'compilation-error-list) nil)
1254 (set (make-local-variable 'compilation-old-error-list) nil)
c4d7c00a 1255 (set (make-local-variable 'compilation-parsing-end) (copy-marker 1))
474d71ae
RS
1256 (set (make-local-variable 'compilation-directory-stack)
1257 (list default-directory))
18aac618 1258 (make-local-variable 'compilation-error-screen-columns)
0b18a8f6
RM
1259 (setq compilation-last-buffer (current-buffer)))
1260
7052680b 1261;;;###autoload
4282eba1 1262(define-minor-mode compilation-shell-minor-mode
7052680b
RS
1263 "Toggle compilation shell minor mode.
1264With arg, turn compilation mode on if and only if arg is positive.
4282eba1
SM
1265In this minor mode, all the error-parsing commands of the
1266Compilation major mode are available but bound to keys that don't
1267collide with Shell mode. See `compilation-mode'.
7052680b 1268Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
4282eba1 1269 nil " Shell-Compile" nil
d408fed8 1270 :group 'compilation
4282eba1
SM
1271 (let (mode-line-process)
1272 (compilation-setup)))
7052680b 1273
d6bd8dca 1274;;;###autoload
4282eba1 1275(define-minor-mode compilation-minor-mode
0b18a8f6
RM
1276 "Toggle compilation minor mode.
1277With arg, turn compilation mode on if and only if arg is positive.
4282eba1
SM
1278In this minor mode, all the error-parsing commands of the
1279Compilation major mode are available. See `compilation-mode'.
fee3f63a 1280Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
4282eba1 1281 nil " Compilation" nil
d408fed8 1282 :group 'compilation
4282eba1
SM
1283 (let ((mode-line-process))
1284 (compilation-setup)))
55dfd2c4 1285
fd5e58d7 1286(defun compilation-handle-exit (process-status exit-status msg)
851231e9 1287 "Write msg in the current buffer and hack its mode-line-process."
fd5e58d7
RM
1288 (let ((buffer-read-only nil)
1289 (status (if compilation-exit-message-function
1290 (funcall compilation-exit-message-function
1291 process-status exit-status msg)
1292 (cons msg exit-status)))
1293 (omax (point-max))
1294 (opoint (point)))
1295 ;; Record where we put the message, so we can ignore it
1296 ;; later on.
1297 (goto-char omax)
1298 (insert ?\n mode-name " " (car status))
0eac1faa
RS
1299 (if (and (numberp compilation-window-height)
1300 (zerop compilation-window-height))
1301 (message "%s" (cdr status)))
01c50447
RS
1302 (if (bolp)
1303 (forward-char -1))
fd5e58d7 1304 (insert " at " (substring (current-time-string) 0 19))
01c50447 1305 (goto-char (point-max))
47092737
RS
1306 ;; Prevent that message from being recognized as a compilation error.
1307 (add-text-properties omax (point)
1308 (append '(compilation-handle-exit t) nil))
52f84622 1309 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
fd5e58d7
RM
1310 ;; Force mode line redisplay soon.
1311 (force-mode-line-update)
1312 (if (and opoint (< opoint omax))
1313 (goto-char opoint))
01e6e8c9
RS
1314 ;; Automatically parse (and mouse-highlight) error messages:
1315 (cond ((eq compile-auto-highlight t)
37f5f978 1316 (compile-reinitialize-errors nil (point-max)))
01e6e8c9
RS
1317 ((numberp compile-auto-highlight)
1318 (compile-reinitialize-errors nil
1319 (save-excursion
1320 (goto-line compile-auto-highlight)
1321 (point)))))
fd5e58d7 1322 (if compilation-finish-function
4cc36b17
RS
1323 (funcall compilation-finish-function (current-buffer) msg))
1324 (let ((functions compilation-finish-functions))
1325 (while functions
1326 (funcall (car functions) (current-buffer) msg)
1327 (setq functions (cdr functions))))))
fd5e58d7 1328
55dfd2c4 1329;; Called when compilation process changes state.
55dfd2c4 1330(defun compilation-sentinel (proc msg)
d3cb357b
RM
1331 "Sentinel for compilation buffers."
1332 (let ((buffer (process-buffer proc)))
ebff767c
RM
1333 (if (memq (process-status proc) '(signal exit))
1334 (progn
1335 (if (null (buffer-name buffer))
1336 ;; buffer killed
1337 (set-process-buffer proc nil)
fd5e58d7 1338 (let ((obuf (current-buffer)))
ebff767c
RM
1339 ;; save-excursion isn't the right thing if
1340 ;; process-buffer is current-buffer
1341 (unwind-protect
1342 (progn
1343 ;; Write something in the compilation buffer
1344 ;; and hack its mode line.
1345 (set-buffer buffer)
fd5e58d7
RM
1346 (compilation-handle-exit (process-status proc)
1347 (process-exit-status proc)
1348 msg)
1349 ;; Since the buffer and mode line will show that the
1350 ;; process is dead, we can delete it now. Otherwise it
1351 ;; will stay around until M-x list-processes.
1352 (delete-process proc))
6c43f2f9 1353 (set-buffer obuf))))
ebff767c
RM
1354 (setq compilation-in-progress (delq proc compilation-in-progress))
1355 ))))
55dfd2c4 1356
ad62b7f1
RM
1357(defun compilation-filter (proc string)
1358 "Process filter for compilation buffers.
4f6e4ad6 1359Just inserts the text, but uses `insert-before-markers'."
991c70f8 1360 (if (buffer-name (process-buffer proc))
ad62b7f1 1361 (save-excursion
991c70f8 1362 (set-buffer (process-buffer proc))
c4d7c00a
RS
1363 (let ((buffer-read-only nil)
1364 (end (marker-position compilation-parsing-end)))
991c70f8
RS
1365 (save-excursion
1366 (goto-char (process-mark proc))
1367 (insert-before-markers string)
c4d7c00a 1368 (set-marker compilation-parsing-end end) ;don't move it
d89793b7 1369 (run-hooks 'compilation-filter-hook)
c4d7c00a
RS
1370 ;; this seems redundant since we insert-before-marks -stefan
1371 ;;(set-marker (process-mark proc) (point))
1372 )))))
ad62b7f1 1373
b5bb472e 1374(defun compile-error-at-point ()
851231e9 1375 "Return the cdr of `compilation-old-error-list' for error containing point."
b5bb472e
RM
1376 (compile-reinitialize-errors nil (point))
1377 (let ((errors compilation-old-error-list))
1378 (while (and errors
1379 (> (point) (car (car errors))))
1380 (setq errors (cdr errors)))
1381 errors))
1382
51ba27e7 1383(defsubst compilation-buffer-p (buffer)
20c1daec
RM
1384 (save-excursion
1385 (set-buffer buffer)
a24770bc
RS
1386 (or compilation-shell-minor-mode compilation-minor-mode
1387 (eq major-mode 'compilation-mode))))
51ba27e7 1388
646bd331
RM
1389(defun compilation-next-error (n)
1390 "Move point to the next error in the compilation buffer.
851231e9
DL
1391Prefix arg N says how many error messages to move forwards (or
1392backwards, if negative).
646bd331
RM
1393Does NOT find the source line like \\[next-error]."
1394 (interactive "p")
1395 (or (compilation-buffer-p (current-buffer))
851231e9 1396 (error "Not in a compilation buffer"))
646bd331 1397 (setq compilation-last-buffer (current-buffer))
b5bb472e
RM
1398
1399 (let ((errors (compile-error-at-point)))
1400
1401 ;; Move to the error after the one containing point.
1402 (goto-char (car (if (< n 0)
1403 (let ((i 0)
1404 (e compilation-old-error-list))
1405 ;; See how many cdrs away ERRORS is from the start.
1406 (while (not (eq e errors))
1407 (setq i (1+ i)
1408 e (cdr e)))
1409 (if (> (- n) i)
1410 (error "Moved back past first error")
1411 (nth (+ i n) compilation-old-error-list)))
83b5c8e0 1412 (save-excursion
c72095b3 1413 (while (and (> n 0) errors)
83b5c8e0 1414 ;; Discard the current error and any previous.
c72095b3 1415 (while (and errors (>= (point) (car (car errors))))
83b5c8e0
RS
1416 (setq errors (cdr errors)))
1417 ;; Now (car errors) is the next error.
1418 ;; If we want to move down more errors,
1419 ;; put point at this one and start again.
1420 (setq n (1- n))
1421 (if (and errors (> n 0))
1422 (goto-char (car (car errors))))))
1423 (let ((compilation-error-list errors))
b5bb472e
RM
1424 (compile-reinitialize-errors nil nil n)
1425 (if compilation-error-list
1426 (nth (1- n) compilation-error-list)
1427 (error "Moved past last error"))))))))
646bd331
RM
1428
1429(defun compilation-previous-error (n)
1430 "Move point to the previous error in the compilation buffer.
851231e9
DL
1431Prefix arg N says how many error messages to move backwards (or
1432forwards, if negative).
646bd331
RM
1433Does NOT find the source line like \\[next-error]."
1434 (interactive "p")
1435 (compilation-next-error (- n)))
1436
1437
fc0094d7
RM
1438;; Given an elt of `compilation-error-list', return an object representing
1439;; the referenced file which is equal to (but not necessarily eq to) what
1440;; this function would return for another error in the same file.
1441(defsubst compilation-error-filedata (data)
b5bb472e
RM
1442 (setq data (cdr data))
1443 (if (markerp data)
fc0094d7 1444 (marker-buffer data)
aead2f9f 1445 (car data)))
b5bb472e 1446
fc0094d7
RM
1447;; Return a string describing a value from compilation-error-filedata.
1448;; This value is not necessarily useful as a file name, but should be
1449;; indicative to the user of what file's errors are being referred to.
1450(defsubst compilation-error-filedata-file-name (filedata)
1451 (if (bufferp filedata)
1452 (buffer-file-name filedata)
1453 (car filedata)))
1454
b5bb472e
RM
1455(defun compilation-next-file (n)
1456 "Move point to the next error for a different file than the current one."
1457 (interactive "p")
1458 (or (compilation-buffer-p (current-buffer))
851231e9 1459 (error "Not in a compilation buffer"))
b5bb472e
RM
1460 (setq compilation-last-buffer (current-buffer))
1461
1462 (let ((reversed (< n 0))
fc0094d7 1463 errors filedata)
b5bb472e
RM
1464
1465 (if (not reversed)
1466 (setq errors (or (compile-error-at-point)
1467 (error "Moved past last error")))
1468
1469 ;; Get a reversed list of the errors up through the one containing point.
1470 (compile-reinitialize-errors nil (point))
1471 (setq errors (reverse compilation-old-error-list)
1472 n (- n))
1473
1474 ;; Ignore errors after point. (car ERRORS) will be the error
1475 ;; containing point, (cadr ERRORS) the one before it.
1476 (while (and errors
1477 (< (point) (car (car errors))))
1478 (setq errors (cdr errors))))
1479
1480 (while (> n 0)
fc0094d7
RM
1481 (setq filedata (compilation-error-filedata (car errors)))
1482
1483 ;; Skip past the following errors for this file.
1484 (while (equal filedata
1485 (compilation-error-filedata
1486 (car (or errors
1487 (if reversed
1488 (error "%s the first erring file"
1489 (compilation-error-filedata-file-name
1490 filedata))
1491 (let ((compilation-error-list nil))
1492 ;; Parse some more.
1493 (compile-reinitialize-errors nil nil 2)
1494 (setq errors compilation-error-list)))
501cf428 1495 (error "%s is the last erring file"
fc0094d7
RM
1496 (compilation-error-filedata-file-name
1497 filedata))))))
b5bb472e
RM
1498 (setq errors (cdr errors)))
1499
1500 (setq n (1- n)))
1501
1502 ;; Move to the following error.
1503 (goto-char (car (car (or errors
1504 (if reversed
1505 (error "This is the first erring file")
1506 (let ((compilation-error-list nil))
1507 ;; Parse the last one.
1508 (compile-reinitialize-errors nil nil 1)
1509 compilation-error-list))))))))
1510
1511(defun compilation-previous-file (n)
1512 "Move point to the previous error for a different file than the current one."
1513 (interactive "p")
1514 (compilation-next-file (- n)))
1515
55dfd2c4 1516(defun kill-compilation ()
b765ba64 1517 "Kill the process made by the \\[compile] or \\[grep] commands."
55dfd2c4 1518 (interactive)
d3cb357b 1519 (let ((buffer (compilation-find-buffer)))
55dfd2c4 1520 (if (get-buffer-process buffer)
d3cb357b 1521 (interrupt-process (get-buffer-process buffer))
851231e9 1522 (error "The compilation process is not running"))))
d3cb357b 1523
b765ba64 1524(defalias 'kill-grep 'kill-compilation)
55dfd2c4 1525
d3cb357b
RM
1526;; Parse any new errors in the compilation buffer,
1527;; or reparse from the beginning if the user has asked for that.
eaa3cac5
RM
1528(defun compile-reinitialize-errors (reparse
1529 &optional limit-search find-at-least)
d3cb357b
RM
1530 (save-excursion
1531 (set-buffer compilation-last-buffer)
1532 ;; If we are out of errors, or if user says "reparse",
1533 ;; discard the info we have, to force reparsing.
1534 (if (or (eq compilation-error-list t)
eaa3cac5 1535 reparse)
51ba27e7 1536 (compilation-forget-errors))
c540863c 1537 (if (and compilation-error-list
b5bb472e
RM
1538 (or (not limit-search)
1539 (> compilation-parsing-end limit-search))
c540863c 1540 (or (not find-at-least)
a72ba929 1541 (>= (length compilation-error-list) find-at-least)))
d3cb357b
RM
1542 ;; Since compilation-error-list is non-nil, it points to a specific
1543 ;; error the user wanted. So don't move it around.
1544 nil
51ba27e7
RM
1545 ;; This was here for a long time (before my rewrite); why? --roland
1546 ;;(switch-to-buffer compilation-last-buffer)
55dfd2c4 1547 (set-buffer-modified-p nil)
b5bb472e 1548 (if (< compilation-parsing-end (point-max))
51ba27e7 1549 ;; compilation-error-list might be non-nil if we have a non-nil
676a14e1 1550 ;; LIMIT-SEARCH or FIND-AT-LEAST arg. In that case its value
51ba27e7
RM
1551 ;; records the current position in the error list, and we must
1552 ;; preserve that after reparsing.
1553 (let ((error-list-pos compilation-error-list))
b5bb472e 1554 (funcall compilation-parse-errors-function
51ba27e7
RM
1555 limit-search
1556 (and find-at-least
1557 ;; We only need enough new parsed errors to reach
1558 ;; FIND-AT-LEAST errors past the current
1559 ;; position.
1560 (- find-at-least (length compilation-error-list))))
1561 ;; Remember the entire list for compilation-forget-errors. If
1562 ;; this is an incremental parse, append to previous list. If
1563 ;; we are parsing anew, compilation-forget-errors cleared
1564 ;; compilation-old-error-list above.
1565 (setq compilation-old-error-list
1566 (nconc compilation-old-error-list compilation-error-list))
1567 (if error-list-pos
1568 ;; We started in the middle of an existing list of parsed
1569 ;; errors before parsing more; restore that position.
1570 (setq compilation-error-list error-list-pos))
01e6e8c9 1571 ;; Mouse-Highlight (the first line of) each error message when the
37f5f978
RS
1572 ;; mouse pointer moves over it:
1573 (let ((inhibit-read-only t)
474d71ae
RS
1574 (buffer-undo-list t)
1575 deactivate-mark
311ff235 1576 (buffer-was-modified (buffer-modified-p))
37f5f978
RS
1577 (error-list compilation-error-list))
1578 (while error-list
1579 (save-excursion
08de70d7
EZ
1580 (add-text-properties (goto-char (car (car error-list)))
1581 (progn (end-of-line) (point))
1582 '(mouse-face highlight help-echo "\
1583mouse-2: visit this file and line")))
311ff235
JB
1584 (setq error-list (cdr error-list)))
1585 (set-buffer-modified-p buffer-was-modified))
b5bb472e 1586 )))))
55dfd2c4 1587
f98494a4 1588(defun compile-mouse-goto-error (event)
d28701c7
RS
1589 "Visit the source for the error message the mouse is pointing at.
1590This is like `compile-goto-error' called without prefix arg
1591at the end of the line."
f98494a4 1592 (interactive "e")
e78e10ca
KH
1593 (save-excursion
1594 (set-buffer (window-buffer (posn-window (event-end event))))
1595 (goto-char (posn-point (event-end event)))
1596
1597 (or (compilation-buffer-p (current-buffer))
851231e9 1598 (error "Not in a compilation buffer"))
e78e10ca 1599 (setq compilation-last-buffer (current-buffer))
167d1418
EZ
1600 ;; `compile-reinitialize-errors' needs to see the complete filename
1601 ;; on the line where they clicked the mouse. Since it only looks
a24770bc 1602 ;; up to point, moving point to eol makes sure the filename is
167d1418
EZ
1603 ;; visible to `compile-reinitialize-errors'.
1604 (end-of-line)
e78e10ca
KH
1605 (compile-reinitialize-errors nil (point))
1606
1607 ;; Move to bol; the marker for the error on this line will point there.
1608 (beginning-of-line)
1609
1610 ;; Move compilation-error-list to the elt of compilation-old-error-list
1611 ;; we want.
1612 (setq compilation-error-list compilation-old-error-list)
1613 (while (and compilation-error-list
41a3354e
DL
1614 ;; The marker can point nowhere if we previously
1615 ;; failed to find the relevant file. See
1616 ;; compilation-next-error-locus.
1617 (or (null (marker-buffer (caar compilation-error-list)))
8f36a284 1618 (and (> (point) (caar compilation-error-list))
2827a3c1
RS
1619 (>= (point)
1620 ;; Don't skip too far: the text between
1621 ;; two errors belongs to the first. This
1622 ;; in-between text might be other errors
1623 ;; on the same line (see
1624 ;; compilation-skip-to-next-location).
1625 (if (null (cdr compilation-error-list))
1626 compilation-parsing-end
1627 (caar (cdr compilation-error-list)))))))
e78e10ca
KH
1628 (setq compilation-error-list (cdr compilation-error-list)))
1629 (or compilation-error-list
1630 (error "No error to go to")))
1631 (select-window (posn-window (event-end event)))
e78e10ca
KH
1632
1633 (push-mark)
1634 (next-error 1))
f98494a4 1635
55dfd2c4
RS
1636(defun compile-goto-error (&optional argp)
1637 "Visit the source for the error message point is on.
31efa7c9 1638Use this command in a compilation log buffer. Sets the mark at point there.
b2bb6ec8 1639\\[universal-argument] as a prefix arg means to reparse the buffer's error messages first;
55dfd2c4
RS
1640other kinds of prefix arguments are ignored."
1641 (interactive "P")
d3cb357b 1642 (or (compilation-buffer-p (current-buffer))
851231e9 1643 (error "Not in a compilation buffer"))
d3cb357b 1644 (setq compilation-last-buffer (current-buffer))
eaa3cac5 1645 (compile-reinitialize-errors (consp argp) (point))
646bd331 1646
15d1a8da
RM
1647 ;; Move to bol; the marker for the error on this line will point there.
1648 (beginning-of-line)
1649
646bd331 1650 ;; Move compilation-error-list to the elt of compilation-old-error-list
643f763f 1651 ;; we want.
646bd331 1652 (setq compilation-error-list compilation-old-error-list)
643f763f 1653 (while (and compilation-error-list
41a3354e
DL
1654 ;; The marker can point nowhere if we previously
1655 ;; failed to find the relevant file. See
1656 ;; compilation-next-error-locus.
1657 (or (null (marker-buffer (caar compilation-error-list)))
8f36a284 1658 (and (> (point) (caar compilation-error-list))
2827a3c1
RS
1659 (>= (point)
1660 ;; Don't skip too far: the text between
1661 ;; two errors belongs to the first. This
1662 ;; in-between text might be other errors
1663 ;; on the same line (see
1664 ;; compilation-skip-to-next-location).
1665 (if (null (cdr compilation-error-list))
1666 compilation-parsing-end
1667 (caar (cdr compilation-error-list)))))))
646bd331
RM
1668 (setq compilation-error-list (cdr compilation-error-list)))
1669
31efa7c9 1670 (push-mark)
643f763f 1671 (next-error 1))
55dfd2c4 1672
d3cb357b
RM
1673;; Return a compilation buffer.
1674;; If the current buffer is a compilation buffer, return it.
1675;; If compilation-last-buffer is set to a live buffer, use that.
1676;; Otherwise, look for a compilation buffer and signal an error
1677;; if there are none.
4746118a
JB
1678(defun compilation-find-buffer (&optional other-buffer)
1679 (if (and (not other-buffer)
1680 (compilation-buffer-p (current-buffer)))
d3cb357b
RM
1681 ;; The current buffer is a compilation buffer.
1682 (current-buffer)
4746118a 1683 (if (and compilation-last-buffer (buffer-name compilation-last-buffer)
95d219b5 1684 (compilation-buffer-p compilation-last-buffer)
4746118a
JB
1685 (or (not other-buffer) (not (eq compilation-last-buffer
1686 (current-buffer)))))
d3cb357b
RM
1687 compilation-last-buffer
1688 (let ((buffers (buffer-list)))
4746118a
JB
1689 (while (and buffers (or (not (compilation-buffer-p (car buffers)))
1690 (and other-buffer
1691 (eq (car buffers) (current-buffer)))))
d3cb357b
RM
1692 (setq buffers (cdr buffers)))
1693 (if buffers
1694 (car buffers)
4746118a
JB
1695 (or (and other-buffer
1696 (compilation-buffer-p (current-buffer))
1697 ;; The current buffer is a compilation buffer.
1698 (progn
1699 (if other-buffer
1700 (message "This is the only compilation buffer."))
1701 (current-buffer)))
1702 (error "No compilation started!")))))))
d3cb357b
RM
1703
1704;;;###autoload
55dfd2c4
RS
1705(defun next-error (&optional argp)
1706 "Visit next compilation error message and corresponding source code.
966c0a72
RS
1707
1708If all the error messages parsed so far have been processed already,
1709the message buffer is checked for new ones.
55dfd2c4 1710
ffb4b7a1 1711A prefix ARGP specifies how many error messages to move;
55dfd2c4 1712negative means move back to previous error messages.
ffb4b7a1 1713Just \\[universal-argument] as a prefix means reparse the error message buffer
55dfd2c4
RS
1714and start at the first error.
1715
966c0a72
RS
1716\\[next-error] normally uses the most recently started compilation or
1717grep buffer. However, it can operate on any buffer with output from
1718the \\[compile] and \\[grep] commands, or, more generally, on any
1719buffer in Compilation mode or with Compilation Minor mode enabled. To
1720specify use of a particular buffer for error messages, type
1721\\[next-error] in that buffer.
55dfd2c4 1722
966c0a72
RS
1723Once \\[next-error] has chosen the buffer for error messages,
1724it stays with that buffer until you use it in some other buffer which
1725uses Compilation mode or Compilation Minor mode.
55dfd2c4 1726
d3cb357b
RM
1727See variables `compilation-parse-errors-function' and
1728\`compilation-error-regexp-alist' for customization ideas."
55dfd2c4 1729 (interactive "P")
d3cb357b 1730 (setq compilation-last-buffer (compilation-find-buffer))
eaa3cac5
RM
1731 (compilation-goto-locus (compilation-next-error-locus
1732 ;; We want to pass a number here only if
1733 ;; we got a numeric prefix arg, not just C-u.
1734 (and (not (consp argp))
1735 (prefix-numeric-value argp))
1736 (consp argp))))
1737;;;###autoload (define-key ctl-x-map "`" 'next-error)
1738
e60476ca
RS
1739(defun previous-error ()
1740 "Visit previous compilation error message and corresponding source code.
1741This operates on the output from the \\[compile] command."
1742 (interactive)
eae2c972 1743 (next-error -1))
e60476ca
RS
1744
1745(defun first-error ()
d9b73ccc 1746 "Reparse the error message buffer and start at the first error.
e60476ca
RS
1747Visit corresponding source code.
1748This operates on the output from the \\[compile] command."
1749 (interactive)
eae2c972 1750 (next-error '(4)))
e60476ca 1751
c41fe446
KH
1752(defvar compilation-skip-to-next-location nil
1753 "*If non-nil, skip multiple error messages for the same source location.")
1754
b4300a1a 1755(defun compilation-next-error-locus (&optional move reparse silent)
eaa3cac5
RM
1756 "Visit next compilation error and return locus in corresponding source code.
1757This operates on the output from the \\[compile] command.
1758If all preparsed error messages have been processed,
1759the error message buffer is checked for new ones.
1760
1761Returns a cons (ERROR . SOURCE) of two markers: ERROR is a marker at the
1762location of the error message in the compilation buffer, and SOURCE is a
1763marker at the location in the source code indicated by the error message.
1764
1765Optional first arg MOVE says how many error messages to move forwards (or
1766backwards, if negative); default is 1. Optional second arg REPARSE, if
1767non-nil, says to reparse the error message buffer and reset to the first
501cf428 1768error (plus MOVE - 1). If optional third argument SILENT is non-nil, return
b4300a1a 1769nil instead of raising an error if there are no more errors.
eaa3cac5
RM
1770
1771The current buffer should be the desired compilation output buffer."
1772 (or move (setq move 1))
667aec94 1773 (compile-reinitialize-errors reparse nil (and (not reparse) (max 0 move)))
d3cb357b 1774 (let (next-errors next-error)
7fb63acd
RS
1775 (catch 'no-next-error
1776 (save-excursion
1777 (set-buffer compilation-last-buffer)
1778 ;; compilation-error-list points to the "current" error.
501cf428 1779 (setq next-errors
7fb63acd
RS
1780 (if (> move 0)
1781 (nthcdr (1- move)
1782 compilation-error-list)
1783 ;; Zero or negative arg; we need to move back in the list.
1784 (let ((n (1- move))
1785 (i 0)
1786 (e compilation-old-error-list))
1787 ;; See how many cdrs away the current error is from the start.
1788 (while (not (eq e compilation-error-list))
1789 (setq i (1+ i)
1790 e (cdr e)))
1791 (if (> (- n) i)
1792 (error "Moved back past first error")
1793 (nthcdr (+ i n) compilation-old-error-list))))
1794 next-error (car next-errors))
1795 (while
1796 (if (null next-error)
1797 (progn
1798 (and move (/= move 1)
1799 (error (if (> move 0)
1800 "Moved past last error")
1801 "Moved back past first error"))
1802 ;; Forget existing error messages if compilation has finished.
1803 (if (not (and (get-buffer-process (current-buffer))
1804 (eq (process-status
1805 (get-buffer-process
1806 (current-buffer)))
1807 'run)))
1808 (compilation-forget-errors))
1809 (if silent
1810 (throw 'no-next-error nil)
1811 (error (concat compilation-error-message
1812 (and (get-buffer-process (current-buffer))
1813 (eq (process-status
1814 (get-buffer-process
1815 (current-buffer)))
1816 'run)
b4300a1a 1817 " yet")))))
7fb63acd
RS
1818 (setq compilation-error-list (cdr next-errors))
1819 (if (null (cdr next-error))
1820 ;; This error is boring. Go to the next.
1821 t
1822 (or (markerp (cdr next-error))
1823 ;; This error has a filename/lineno pair.
1824 ;; Find the file and turn it into a marker.
1825 (let* ((fileinfo (car (cdr next-error)))
20c1daec
RM
1826 (buffer (apply 'compilation-find-file
1827 (car next-error) fileinfo)))
7fb63acd
RS
1828 (if (null buffer)
1829 ;; We can't find this error's file.
1830 ;; Remove all errors in the same file.
1831 (progn
1832 (setq next-errors compilation-old-error-list)
1833 (while next-errors
1834 (and (consp (cdr (car next-errors)))
1835 (equal (car (cdr (car next-errors)))
1836 fileinfo)
1837 (progn
1838 (set-marker (car (car next-errors)) nil)
1839 (setcdr (car next-errors) nil)))
1840 (setq next-errors (cdr next-errors)))
1841 ;; Look for the next error.
1842 t)
1843 ;; We found the file. Get a marker for this error.
47d1bc29
KH
1844 ;; compilation-old-error-list and
1845 ;; compilation-error-screen-columns are buffer-local
1846 ;; so we must be careful to extract their value
7fb63acd
RS
1847 ;; before switching to the source file buffer.
1848 (let ((errors compilation-old-error-list)
47d1bc29 1849 (columns compilation-error-screen-columns)
7fb63acd
RS
1850 (last-line (nth 1 (cdr next-error)))
1851 (column (nth 2 (cdr next-error))))
1852 (set-buffer buffer)
1853 (save-excursion
1854 (save-restriction
1855 (widen)
1856 (goto-line last-line)
4dbf8a2c 1857 (if (and column (> column 0))
4ad26d84 1858 ;; Columns in error msgs are 1-origin.
47d1bc29 1859 (if columns
f8e03ecb
AS
1860 (move-to-column (1- column))
1861 (forward-char (1- column)))
7fb63acd
RS
1862 (beginning-of-line))
1863 (setcdr next-error (point-marker))
1864 ;; Make all the other error messages referring
1865 ;; to the same file have markers into the buffer.
1866 (while errors
1867 (and (consp (cdr (car errors)))
1868 (equal (car (cdr (car errors))) fileinfo)
1869 (let* ((this (nth 1 (cdr (car errors))))
1870 (column (nth 2 (cdr (car errors))))
1871 (lines (- this last-line)))
1872 (if (eq selective-display t)
1873 ;; When selective-display is t,
1874 ;; each C-m is a line boundary,
1875 ;; as well as each newline.
1876 (if (< lines 0)
1877 (re-search-backward "[\n\C-m]"
1878 nil 'end
1879 (- lines))
1880 (re-search-forward "[\n\C-m]"
1881 nil 'end
1882 lines))
1883 (forward-line lines))
eae2c972 1884 (if (and column (> column 1))
47d1bc29 1885 (if columns
f8e03ecb
AS
1886 (move-to-column (1- column))
1887 (forward-char (1- column)))
eae2c972 1888 (beginning-of-line))
7fb63acd
RS
1889 (setq last-line this)
1890 (setcdr (car errors) (point-marker))))
1891 (setq errors (cdr errors)))))))))
1892 ;; If we didn't get a marker for this error, or this
1893 ;; marker's buffer was killed, go on to the next one.
1894 (or (not (markerp (cdr next-error)))
1895 (not (marker-buffer (cdr next-error))))))
1896 (setq next-errors compilation-error-list
b4300a1a 1897 next-error (car next-errors)))))
d3cb357b 1898
c41fe446
KH
1899 (if compilation-skip-to-next-location
1900 ;; Skip over multiple error messages for the same source location,
1901 ;; so the next C-x ` won't go to an error in the same place.
1902 (while (and compilation-error-list
a24770bc
RS
1903 (equal (cdr (car compilation-error-list))
1904 (cdr next-error)))
c41fe446 1905 (setq compilation-error-list (cdr compilation-error-list))))
d3cb357b 1906
eaa3cac5
RM
1907 ;; We now have a marker for the position of the error source code.
1908 ;; NEXT-ERROR is a cons (ERROR . SOURCE) of two markers.
1909 next-error))
1910
1911(defun compilation-goto-locus (next-error)
1912 "Jump to an error locus returned by `compilation-next-error-locus'.
1913Takes one argument, a cons (ERROR . SOURCE) of two markers.
1914Selects a window with point at SOURCE, with another window displaying ERROR."
d28701c7
RS
1915 (if (eq (window-buffer (selected-window))
1916 (marker-buffer (car next-error)))
1917 ;; If the compilation buffer window is selected,
1918 ;; keep the compilation buffer in this window;
1919 ;; display the source in another window.
1920 (let ((pop-up-windows t))
1921 (pop-to-buffer (marker-buffer (cdr next-error))))
8f36a284
SM
1922 (if (window-dedicated-p (selected-window))
1923 (pop-to-buffer (marker-buffer (cdr next-error)))
d28701c7 1924 (switch-to-buffer (marker-buffer (cdr next-error)))))
eaa3cac5
RM
1925 (goto-char (cdr next-error))
1926 ;; If narrowing got in the way of
1927 ;; going to the right place, widen.
1928 (or (= (point) (marker-position (cdr next-error)))
1929 (progn
1930 (widen)
1931 (goto-char (cdr next-error))))
721cfafe
TTN
1932 ;; If hideshow got in the way of
1933 ;; seeing the right place, open permanently.
1934 (mapcar (function (lambda (ov)
1935 (when (eq 'hs (overlay-get ov 'invisible))
1936 (delete-overlay ov)
1937 (goto-char (cdr next-error)))))
1938 (overlays-at (point)))
eaa3cac5
RM
1939
1940 ;; Show compilation buffer in other window, scrolled to this error.
1941 (let* ((pop-up-windows t)
eae2c972 1942 ;; Use an existing window if it is in a visible frame.
c94b02d6 1943 (w (or (get-buffer-window (marker-buffer (car next-error)) 'visible)
eae2c972 1944 ;; Pop up a window.
c94b02d6 1945 (display-buffer (marker-buffer (car next-error))))))
eaa3cac5 1946 (set-window-point w (car next-error))
c94b02d6
RS
1947 (set-window-start w (car next-error))
1948 (compilation-set-window-height w)))
eaa3cac5 1949\f
20c1daec 1950(defun compilation-find-file (marker filename dir &rest formats)
851231e9 1951 "Find a buffer for file FILENAME.
ffb4b7a1
SM
1952Search the directories in `compilation-search-path'.
1953A nil in `compilation-search-path' means to try the
851231e9
DL
1954current directory, which is passed in DIR.
1955If FILENAME is not found at all, ask the user where to find it.
1956Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
20c1daec 1957 (or formats (setq formats '("%s")))
721cfafe
TTN
1958 (save-excursion
1959 (let ((dirs compilation-search-path)
1960 buffer thisdir fmts name)
1961 (if (file-name-absolute-p filename)
5b6858da
SM
1962 ;; The file name is absolute. Use its explicit directory as
1963 ;; the first in the search path, and strip it from FILENAME.
1964 (setq filename (abbreviate-file-name (expand-file-name filename))
1965 dirs (cons (file-name-directory filename) dirs)
1966 filename (file-name-nondirectory filename)))
721cfafe
TTN
1967 ;; Now search the path.
1968 (while (and dirs (null buffer))
1969 (setq thisdir (or (car dirs) dir)
1970 fmts formats)
1971 ;; For each directory, try each format string.
1972 (while (and fmts (null buffer))
1973 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1974 buffer (and (file-exists-p name)
ffb4b7a1 1975 (find-file-noselect name))
721cfafe
TTN
1976 fmts (cdr fmts)))
1977 (setq dirs (cdr dirs)))
1978 (or buffer
1979 ;; The file doesn't exist.
1980 ;; Ask the user where to find it.
1981 ;; If he hits C-g, then the next time he does
1982 ;; next-error, he'll skip past it.
1983 (let* ((pop-up-windows t)
1984 (w (display-buffer (marker-buffer marker))))
1985 (set-window-point w marker)
1986 (set-window-start w marker)
1987 (let ((name (expand-file-name
1988 (read-file-name
1989 (format "Find this error in: (default %s) "
1990 filename)
1991 dir filename t))))
1992 (if (file-directory-p name)
1993 (setq name (expand-file-name filename name)))
1994 (setq buffer (and (file-exists-p name)
1995 (find-file name))))))
1996 ;; Make intangible overlays tangible.
1997 (mapcar (function (lambda (ov)
1998 (when (overlay-get ov 'intangible)
1999 (overlay-put ov 'intangible nil))))
2000 (overlays-in (point-min) (point-max)))
2001 buffer)))
2002
56ce04a3
RS
2003(defun compilation-normalize-filename (filename)
2004 "Convert a filename string found in an error message to make it usable."
2005
2006 ;; Check for a comint-file-name-prefix and prepend it if
2007 ;; appropriate. (This is very useful for
2008 ;; compilation-minor-mode in an rlogin-mode buffer.)
2009 (and (boundp 'comint-file-name-prefix)
2010 ;; If file name is relative, default-directory will
2011 ;; already contain the comint-file-name-prefix (done
2012 ;; by compile-abbreviate-directory).
2013 (file-name-absolute-p filename)
2014 (setq filename
2015 (concat comint-file-name-prefix filename)))
2016
2017 ;; If compilation-parse-errors-filename-function is
2018 ;; defined, use it to process the filename.
2019 (when compilation-parse-errors-filename-function
2020 (setq filename
2021 (funcall compilation-parse-errors-filename-function
2022 filename)))
2023
2024 ;; Some compilers (e.g. Sun's java compiler, reportedly)
2025 ;; produce bogus file names like "./bar//foo.c" for file
2026 ;; "bar/foo.c"; expand-file-name will collapse these into
2027 ;; "/foo.c" and fail to find the appropriate file. So we
2028 ;; look for doubled slashes in the file name and fix them
2029 ;; up in the buffer.
2030 (setq filename (command-line-normalize-file-name filename)))
d3cb357b
RM
2031
2032;; Set compilation-error-list to nil, and unchain the markers that point to the
2033;; error messages and their text, so that they no longer slow down gap motion.
2034;; This would happen anyway at the next garbage collection, but it is better to
646bd331 2035;; do it right away.
e7512168 2036(defun compilation-forget-errors ()
55dfd2c4
RS
2037 (while compilation-old-error-list
2038 (let ((next-error (car compilation-old-error-list)))
2039 (set-marker (car next-error) nil)
d3cb357b
RM
2040 (if (markerp (cdr next-error))
2041 (set-marker (cdr next-error) nil)))
55dfd2c4 2042 (setq compilation-old-error-list (cdr compilation-old-error-list)))
bd3910fe 2043 (setq compilation-error-list nil
c4d7c00a 2044 compilation-directory-stack (list default-directory))
347c9140
RS
2045 (if compilation-parsing-end
2046 (set-marker compilation-parsing-end 1))
37f5f978 2047 ;; Remove the highlighting added by compile-reinitialize-errors:
474d71ae
RS
2048 (let ((inhibit-read-only t)
2049 (buffer-undo-list t)
2050 deactivate-mark)
08de70d7
EZ
2051 (remove-text-properties (point-min) (point-max)
2052 '(mouse-face highlight help-echo nil))))
d3cb357b
RM
2053
2054
a24770bc
RS
2055;; This function is not needed any more by compilation mode.
2056;; Does anyone else need it or can it be deleted?
d3cb357b
RM
2057(defun count-regexp-groupings (regexp)
2058 "Return the number of \\( ... \\) groupings in REGEXP (a string)."
2059 (let ((groupings 0)
2060 (len (length regexp))
2061 (i 0)
2062 c)
2063 (while (< i len)
2064 (setq c (aref regexp i)
2065 i (1+ i))
2066 (cond ((= c ?\[)
2067 ;; Find the end of this [...].
2068 (while (and (< i len)
2069 (not (= (aref regexp i) ?\])))
2070 (setq i (1+ i))))
2071 ((= c ?\\)
2072 (if (< i len)
2073 (progn
2074 (setq c (aref regexp i)
2075 i (1+ i))
2076 (if (= c ?\))
2077 ;; We found the end of a grouping,
2078 ;; so bump our counter.
2079 (setq groupings (1+ groupings))))))))
2080 groupings))
55dfd2c4 2081
a24770bc 2082(defvar compilation-current-file nil
851231e9 2083 "Used by `compilation-parse-errors' to store filename for file being compiled.")
a24770bc
RS
2084
2085;; This variable is not used as a global variable. It's defined here just to
2086;; shut up the byte compiler. It's bound and used by compilation-parse-errors
2087;; and set by compile-collect-regexps.
2088(defvar compilation-regexps nil)
2089
c540863c 2090(defun compilation-parse-errors (limit-search find-at-least)
a24770bc 2091 "Parse the current buffer as grep, cc, lint or other error messages.
d3cb357b 2092See variable `compilation-parse-errors-function' for the interface it uses."
55dfd2c4
RS
2093 (setq compilation-error-list nil)
2094 (message "Parsing error messages...")
a24770bc
RS
2095 (if (null compilation-error-regexp-alist)
2096 (error "compilation-error-regexp-alist is empty!"))
2097 (let* ((compilation-regexps nil) ; Variable set by compile-collect-regexps.
aa53db6a 2098 (default-directory (car compilation-directory-stack))
a24770bc
RS
2099 (found-desired nil)
2100 (compilation-num-errors-found 0)
2101 ;; Set up now the expanded, abbreviated directory variables
2102 ;; that compile-abbreviate-directory will need, so we can
2103 ;; compute them just once here.
2104 (orig (abbreviate-file-name default-directory))
2105 (orig-expanded (abbreviate-file-name
2106 (file-truename default-directory)))
2107 (parent-expanded (abbreviate-file-name
2108 (expand-file-name "../" orig-expanded))))
2109
2110 ;; Make a list of all the regexps. Each element has the form
2111 ;; (REGEXP TYPE IDX1 IDX2 ...)
2112 ;; where TYPE is one of leave, enter, file, error or nomessage.
2113 (compile-collect-regexps 'leave compilation-leave-directory-regexp-alist)
2114 (compile-collect-regexps 'enter compilation-enter-directory-regexp-alist)
2115 (compile-collect-regexps 'file compilation-file-regexp-alist)
a24770bc 2116 (compile-collect-regexps 'error compilation-error-regexp-alist)
2497076e 2117 (compile-collect-regexps 'nomessage compilation-nomessage-regexp-alist)
d3cb357b 2118
55dfd2c4
RS
2119 ;; Don't reparse messages already seen at last parse.
2120 (goto-char compilation-parsing-end)
9cab952d 2121 (when (and (bobp)
9dd1cf67 2122 (compilation-buffer-p (current-buffer)))
9cab952d
RS
2123 (setq compilation-current-file nil) ; No current file at start.
2124 ;; Don't parse the first two lines as error messages.
2125 ;; This matters for grep.
2126 (forward-line 2))
a24770bc
RS
2127
2128 ;; Parse messages.
47092737
RS
2129 (while (not (or found-desired (eobp)
2130 ;; Don't parse the "compilation finished" message
2131 ;; as a compilation error.
2132 (get-text-property (point) 'compilation-handle-exit)))
a24770bc
RS
2133 (let ((this compilation-regexps) (prev nil) (alist nil) type)
2134 ;; Go through the regular expressions. If a match is found,
2135 ;; variable alist is set to the corresponding alist and the
2136 ;; matching regexp is moved to the front of compilation-regexps
2137 ;; to make it match faster next time.
2138 (while (and this (null alist))
2139 (if (not (looking-at (car (car this))))
2140 (progn (setq prev this) ; No match, go to next.
2141 (setq this (cdr this)))
2142 (setq alist (cdr (car this))) ; Got a match.
2143;;; (if prev ; If not the first regexp,
2144;;; (progn ; move it to the front.
2145;;; (setcdr prev (cdr this))
2146;;; (setcdr this compilation-regexps)
2147;;; (setq compilation-regexps this)))
2148 ))
2149 (if (and alist ; Seen a match and not to
2150 (not (eq (setq type (car alist)) 'nomessage))) ; be ignored.
2151 (let* ((end-of-match (match-end 0))
2152 (filename
2153 (compile-buffer-substring (car (setq alist (cdr alist)))))
2154 stack)
2155 (if (eq type 'error) ; error message
2156 (let* ((linenum (if (numberp (car (setq alist (cdr alist))))
2157 (string-to-int
2158 (compile-buffer-substring (car alist)))
2159 ;; (car alist) is not a number, must be a
2160 ;; function that is called below to return
2161 ;; an error position descriptor.
2162 (car alist)))
2163 ;; Convert to integer later if linenum not a function.
2164 (column (compile-buffer-substring
2165 (car (setq alist (cdr alist)))))
2166 this-error)
2167
2168 ;; Check that we have a file name.
2169 (or filename
2170 ;; No file name in message, we must have seen it before
2171 (setq filename compilation-current-file)
2172 (error "\
851231e9 2173An error message with no file name and no file name has been seen earlier"))
a24770bc 2174
56ce04a3
RS
2175 ;; Clean up the file name string in several ways.
2176 (setq filename (compilation-normalize-filename filename))
a24770bc
RS
2177
2178 (setq filename
2179 (cons filename (cons default-directory (cdr alist))))
2180
2181 ;; Locate the erring file and line.
2182 ;; Make this-error a new elt for compilation-error-list,
2183 ;; giving a marker for the current compilation buffer
2184 ;; location, and the file and line number of the error.
2185 ;; Save, as the start of the error, the beginning of the
2186 ;; line containing the match.
bb40e751
RS
2187 (setq this-error
2188 (if (numberp linenum)
2189 (list (point-marker) filename linenum
2190 (and column (string-to-int column)))
2191 ;; If linenum is not a number then it must be
2192 ;; a function returning an error position
2193 ;; descriptor or nil (meaning no position).
2194 (save-excursion
2195 (funcall linenum filename column))))
721cfafe 2196
bb40e751
RS
2197 ;; We have an error position descriptor.
2198 ;; If we have found as many new errors as the user
2199 ;; wants, or if we are past the buffer position he
2200 ;; indicated, then we continue to parse until we have
2201 ;; seen all consecutive errors in the same file. This
2202 ;; means that all the errors of a source file will be
2203 ;; seen in one parsing run, so that the error positions
2204 ;; will be recorded as markers in the source file
2205 ;; buffer that will move when the buffer is changed.
2206 (if (and this-error
2207 compilation-error-list ; At least one previous.
2208 (or (and find-at-least
2209 (>= compilation-num-errors-found
2210 find-at-least))
2211 (and limit-search
2212 (>= end-of-match limit-search)))
5b6858da
SM
2213 ;; `this-error' could contain a pair of
2214 ;; markers already.
2215 (let ((thispos (cdr this-error))
2216 (lastpos (cdar compilation-error-list)))
2217 (not (equal
2218 (if (markerp thispos)
2219 (marker-buffer thispos)
2220 (car thispos))
2221 (if (markerp lastpos)
2222 (marker-buffer lastpos)
2223 (car lastpos))))))
bb40e751
RS
2224 ;; We are past the limits and the last error
2225 ;; parsed, didn't belong to the same source file
2226 ;; as the earlier ones i.e. we have seen all the
2227 ;; errors belonging to the earlier file. We don't
2228 ;; add the error just parsed so that the next
2229 ;; parsing run can get it and the following errors
2230 ;; in the same file all at once.
2231 (setq found-desired t)
2232
2233 (goto-char end-of-match) ; Prepare for next message.
2234 ;; Don't add the same source line more than once.
2235 (and this-error
2236 (not (and
2237 compilation-error-list
2238 (equal (cdr (car compilation-error-list))
2239 (cdr this-error))))
2240 (setq compilation-error-list
2241 (cons this-error compilation-error-list)
2242 compilation-num-errors-found
2243 (1+ compilation-num-errors-found)))))
a24770bc
RS
2244
2245 ;; Not an error message.
2246 (if (eq type `file) ; Change current file.
56ce04a3
RS
2247 (when filename
2248 (setq compilation-current-file
2249 ;; Clean up the file name string in several ways.
2250 (compilation-normalize-filename filename)))
a24770bc
RS
2251 ;; Enter or leave directory.
2252 (setq stack compilation-directory-stack)
56ce04a3
RS
2253 ;; Don't check if it is really a directory.
2254 ;; Let the code to search and clean up file names
2255 ;; try to use it in any case.
2256 (when filename
2257 ;; Clean up the directory name string in several ways.
2258 (setq filename (compilation-normalize-filename filename))
2259 (setq filename
2260 ;; The directory name in the message
2261 ;; is a truename. Try to convert it to a form
2262 ;; like what the user typed in.
2263 (compile-abbreviate-directory
2264 (file-name-as-directory
2265 (expand-file-name filename))
2266 orig orig-expanded parent-expanded))
2267 (if (eq type 'leave)
2268 ;; If we are leaving a specific directory,
2269 ;; as preparation, pop out of all other directories
2270 ;; that we entered nested within it.
2271 (while (and stack
2272 (not (string-equal (car stack)
2273 filename)))
2274 (setq stack (cdr stack)))
2275 (setq compilation-directory-stack
2276 (cons filename compilation-directory-stack)
2277 default-directory filename)))
58856335
RS
2278 (and (eq type 'leave)
2279 stack
2280 (setq compilation-directory-stack (cdr stack))
2281 (setq stack (car compilation-directory-stack))
bb40e751
RS
2282 (setq default-directory stack)))
2283 (goto-char end-of-match) ; Prepare to look at next message.
2284 (and limit-search (>= end-of-match limit-search)
2285 ;; The user wanted a specific error, and we're past it.
2286 ;; We do this check here rather than at the end of the
2287 ;; loop because if the last thing seen is an error
2288 ;; message, we must carefully discard the last error
2289 ;; when it is the first in a new file (see above in
2290 ;; the error-message case)
2291 (setq found-desired t)))
a24770bc
RS
2292
2293 ;; Go to before the last character in the message so that we will
2294 ;; see the next line also when the message ended at end of line.
2295 ;; When we ignore the last error message above, this will
2296 ;; cancel the effect of forward-line below so that point
2297 ;; doesn't move.
2298 (forward-char -1)
2299
2300 ;; Is this message necessary any more? Parsing is now so fast
2301 ;; that you might not need to know how it proceeds.
2302 (message
2303 "Parsing error messages...%d found. %.0f%% of buffer seen."
6c43f2f9 2304 compilation-num-errors-found
51ba27e7
RM
2305 ;; Use floating-point because (* 100 (point)) frequently
2306 ;; exceeds the range of Emacs Lisp integers.
2307 (/ (* 100.0 (point)) (point-max)))
47092737 2308 )))
a24770bc 2309
47092737 2310 (forward-line 1)) ; End of while loop. Look at next line.
a24770bc 2311
c4d7c00a 2312 (set-marker compilation-parsing-end (point))
a24770bc 2313 (setq compilation-error-list (nreverse compilation-error-list))
5b6858da
SM
2314 ;; (message "Parsing error messages...done. %d found. %.0f%% of buffer seen."
2315 ;; compilation-num-errors-found
2316 ;; (/ (* 100.0 (point)) (point-max)))
a24770bc
RS
2317 (message "Parsing error messages...done.")))
2318
2319(defun compile-collect-regexps (type this)
2320 ;; Add elements to variable compilation-regexps that is bound in
2321 ;; compilation-parse-errors.
2322 (and (not (eq this t))
02c1bd08
SM
2323 (dolist (el this)
2324 (push (cons (car el) (cons type (cdr el))) compilation-regexps))))
a24770bc
RS
2325
2326(defun compile-buffer-substring (index)
851231e9 2327 "Get substring matched by INDEXth subexpression."
a24770bc
RS
2328 (if index
2329 (let ((beg (match-beginning index)))
2330 (if beg (buffer-substring beg (match-end index))))))
55dfd2c4 2331
51501e54
RS
2332;; If directory DIR is a subdir of ORIG or of ORIG's parent,
2333;; return a relative name for it starting from ORIG or its parent.
2334;; ORIG-EXPANDED is an expanded version of ORIG.
2335;; PARENT-EXPANDED is an expanded version of ORIG's parent.
2336;; Those two args could be computed here, but we run faster by
2337;; having the caller compute them just once.
2338(defun compile-abbreviate-directory (dir orig orig-expanded parent-expanded)
cd494de4
RM
2339 ;; Apply canonical abbreviations to DIR first thing.
2340 ;; Those abbreviations are already done in the other arguments passed.
2341 (setq dir (abbreviate-file-name dir))
2342
1e0e614d
RM
2343 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2344 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2345 ;; buffer.)
2346 (if (boundp 'comint-file-name-prefix)
2347 (setq dir (concat comint-file-name-prefix dir)))
2348
51501e54
RS
2349 (if (and (> (length dir) (length orig-expanded))
2350 (string= orig-expanded
2351 (substring dir 0 (length orig-expanded))))
2352 (setq dir
2353 (concat orig
2354 (substring dir (length orig-expanded)))))
2355 (if (and (> (length dir) (length parent-expanded))
2356 (string= parent-expanded
2357 (substring dir 0 (length parent-expanded))))
2358 (setq dir
2359 (concat (file-name-directory
2360 (directory-file-name orig))
2361 (substring dir (length parent-expanded)))))
2362 dir)
2363
f1ed9461
DL
2364(add-to-list 'debug-ignored-errors "^No more errors\\( yet\\|\\)$")
2365
4746118a 2366(provide 'compile)
fad160d5
ER
2367
2368;;; compile.el ends here