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