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