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