Update FSF's address.
[bpt/emacs.git] / lisp / progmodes / compile.el
CommitLineData
daa37602 1;;; compile.el --- run compiler as inferior of Emacs, parse error messages.
fad160d5 2
fd5e58d7 3;; Copyright (C) 1985, 86, 87, 93, 94, 1995, 1996 Free Software Foundation, Inc.
3a801d0c 4
29add8b9 5;; Author: Roland McGrath <roland@prep.ai.mit.edu>
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
7c163413
RM
33;;;###autoload
34(defvar compilation-mode-hook nil
4f6e4ad6 35 "*List of hook functions run by `compilation-mode' (see `run-hooks').")
7c163413
RM
36
37;;;###autoload
6e1dbafa 38(defvar compilation-window-height nil
d3cb357b
RM
39 "*Number of lines in a compilation window. If nil, use Emacs default.")
40
55dfd2c4
RS
41(defvar compilation-error-list nil
42 "List of error message descriptors for visiting erring functions.
fc0094d7
RM
43Each error descriptor is a cons (or nil). Its car is a marker pointing to
44an error message. If its cdr is a marker, it points to the text of the
533304f8
RM
45line the message is about. If its cdr is a cons, it is a list
46\(\(DIRECTORY . FILE\) LINE [COLUMN]\). Or its cdr may be nil if that
47error is not interesting.
d3cb357b
RM
48
49The value may be t instead of a list; this means that the buffer of
29478cc5
JB
50error messages should be reparsed the next time the list of errors is wanted.
51
52Some other commands (like `diff') use this list to control the error
9c09c008 53message tracking facilities; if you change its structure, you should make
29478cc5
JB
54sure you also change those packages. Perhaps it is better not to change
55it at all.")
55dfd2c4
RS
56
57(defvar compilation-old-error-list nil
58 "Value of `compilation-error-list' after errors were parsed.")
59
501cf428 60(defvar compilation-parse-errors-function 'compilation-parse-errors
b2bb6ec8 61 "Function to call to parse error messages from a compilation.
c540863c
RM
62It takes args LIMIT-SEARCH and FIND-AT-LEAST.
63If LIMIT-SEARCH is non-nil, don't bother parsing past that location.
501cf428 64If FIND-AT-LEAST is non-nil, don't bother parsing after finding that
e78e10ca 65many new errors.
d3cb357b
RM
66It should read in the source files which have errors and set
67`compilation-error-list' to a list with an element for each error message
68found. See that variable for more info.")
55dfd2c4 69
aa228418 70;;;###autoload
d3cb357b 71(defvar compilation-buffer-name-function nil
6c43f2f9
RS
72 "Function to compute the name of a compilation buffer.
73The function receives one argument, the name of the major mode of the
74compilation buffer. It should return a string.
75nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
55dfd2c4 76
aa228418 77;;;###autoload
d3cb357b 78(defvar compilation-finish-function nil
aa228418 79 "*Function to call when a compilation process finishes.
d3cb357b
RM
80It is called with two arguments: the compilation buffer, and a string
81describing how the process finished.")
55dfd2c4 82
d3cb357b 83(defvar compilation-last-buffer nil
6c43f2f9
RS
84 "The most recent compilation buffer.
85A buffer becomes most recent when its compilation is started
86or when it is used with \\[next-error] or \\[compile-goto-error].")
55dfd2c4 87
ebff767c
RM
88(defvar compilation-in-progress nil
89 "List of compilation processes now running.")
90(or (assq 'compilation-in-progress minor-mode-alist)
91 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
92 minor-mode-alist)))
93
d3cb357b
RM
94(defvar compilation-parsing-end nil
95 "Position of end of buffer when last error messages were parsed.")
96
97(defvar compilation-error-message "No more errors"
6c43f2f9
RS
98 "Message to print when no more matches are found.")
99
100(defvar compilation-num-errors-found)
d3cb357b
RM
101
102(defvar compilation-error-regexp-alist
103 '(
d86bdede 104 ;; NOTE! See also grep-regexp-alist, below.
7ee790ac 105
d3cb357b 106 ;; 4.3BSD grep, cc, lint pass 1:
7ee790ac
RM
107 ;; /usr/src/foo/foo.c(8): warning: w may be used before set
108 ;; or GNU utilities:
109 ;; foo.c:8: error message
110 ;; or HP-UX 7.0 fc:
111 ;; foo.f :16 some horrible error message
08b1edf4
RM
112 ;; or GNU utilities with column (GNAT 1.82):
113 ;; foo.adb:2:1: Unit name does not match file name
501cf428 114 ;;
57c8389c
JB
115 ;; We'll insist that the number be followed by a colon or closing
116 ;; paren, because otherwise this matches just about anything
117 ;; containing a number with spaces around it.
08b1edf4 118 ("\n\
3e8258e7 119\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\)\\([) \t]\\|\
08b1edf4 120:\\([^0-9\n]\\|\\([0-9]+:\\)\\)\\)" 1 2 5)
69d4d27f
RS
121
122 ;; Borland C++:
123 ;; Error ping.c 15: Unable to open include file 'sys/types.h'
124 ;; Warning ping.c 68: Call to function 'func' with no prototype
3e8258e7 125 ("\n\\(Error\\|Warning\\) \\([a-zA-Z]?:?[^:( \t\n]+\\)\
69d4d27f 126 \\([0-9]+\\)\\([) \t]\\|:[^0-9\n]\\)" 2 3)
7ee790ac 127
d3cb357b 128 ;; 4.3BSD lint pass 2
7ee790ac 129 ;; strcmp: variable # of args. llib-lc(359) :: /usr/src/foo/foo.c(8)
3e8258e7
RM
130 ("[ \t:]\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(](+[ \t]*\\([0-9]+\\))[:) \t]*$"
131 1 2)
7ee790ac 132
d3cb357b 133 ;; 4.3BSD lint pass 3
7ee790ac 134 ;; bloofle defined( /users/wolfgang/foo.c(4) ), but never used
daa37602 135 ;; This used to be
3e8258e7 136 ;; ("[ \t(]+\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]+" 1 2)
daa37602 137 ;; which is regexp Impressionism - it matches almost anything!
3e8258e7 138 ("([ \t]*\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\))" 1 2)
7ee790ac 139
369d3cdc
RM
140 ;; MIPS lint pass<n>; looks good for SunPro lint also
141 ;; TrimMask (255) in solomon.c may be indistinguishable from TrimMasks (93) in solomon.c due to truncation
142 ("[^ ]+ (\\([0-9]+\\)) in \\([^ ]+\\)" 2 1)
143 ;; name defined but never used: LinInt in cmap_calc.c(199)
144 ("in \\([^(]+\\)(\\([0-9]+\\))$" 1 2)
145
ff735134 146 ;; Ultrix 3.0 f77:
f89fdaed 147 ;; fort: Severe: addstf.f, line 82: Missing operator or delimiter symbol
984ae4ed
RM
148 ;; Some SGI cc version:
149 ;; cfe: Warning 835: foo.c, line 2: something
150 ("\n\\(cfe\\|fort\\): [^:\n]*: \\([^ \n]*\\), line \\([0-9]+\\):" 2 3)
501cf428 151 ;; Error on line 3 of t.f: Execution error unclassifiable statement
ff735134 152 ;; Unknown who does this:
9c09c008 153 ;; Line 45 of "foo.c": bloofle undefined
5ff3b093
RM
154 ;; Absoft FORTRAN 77 Compiler 3.1.3
155 ;; error on line 19 of fplot.f: spelling error?
156 ;; warning on line 17 of fplot.f: data type is undefined for variable d
157 ("\\(\n\\|on \\)[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
3e8258e7 158of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2)
7ee790ac
RM
159
160 ;; Apollo cc, 4.3BSD fc:
161 ;; "foo.f", line 3: Error: syntax error near end of statement
6d68d793
RS
162 ;; IBM RS6000:
163 ;; "vvouch.c", line 19.5: 1506-046 (S) Syntax error.
cacf1905
RM
164 ;; Unknown compiler:
165 ;; File "foobar.ml", lines 5-8, characters 20-155: blah blah
a0c567b5
RM
166 ;; Microtec mcc68k:
167 ;; "foo.c", line 32 pos 1; (E) syntax error; unexpected symbol: "lossage"
501cf428 168 ;; GNAT (as of July 94):
37fd2208 169 ;; "foo.adb", line 2(11): warning: file name does not match ...
b1707ae4
RM
170 ;; IBM AIX xlc compiler:
171 ;; "src/swapping.c", line 30.34: 1506-342 (W) "/*" detected in comment.
172 ("\"\\([^,\" \n\t]+\\)\", lines? \
173\\([0-9]+\\)\\([\(.]\\([0-9]+\\)\)?\\)?[:., (-]" 1 2 4)
18710add
JB
174
175 ;; MIPS RISC CC - the one distributed with Ultrix:
7ee790ac 176 ;; ccom: Error: foo.c, line 2: syntax error
dfb89664 177 ;; DEC AXP OSF/1 cc
501cf428 178 ;; /usr/lib/cmplrs/cc/cfe: Error: foo.c: 1: blah blah
dfb89664 179 ("rror: \\([^,\" \n\t]+\\)[,:] \\(line \\)?\\([0-9]+\\):" 1 3)
7ee790ac
RM
180
181 ;; IBM AIX PS/2 C version 1.1:
182 ;; ****** Error number 140 in line 8 of file errors.c ******
daa37602 183 ("in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
d3cb357b
RM
184 ;; IBM AIX lint is too painful to do right this way. File name
185 ;; prefixes entire sections rather than being on each line.
57c8389c 186
72244bea
RM
187 ;; Lucid Compiler, lcc 3.x
188 ;; E, file.cc(35,52) Illegal operation on pointers
c021b7a5 189 ("\n[EW], \\([^(\n]*\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)" 1 2 3)
72244bea 190
08b1edf4 191 ;; GNU messages with program name and optional column number.
3e8258e7 192 ("\n[a-zA-Z]?:?[^0-9 \n\t:]+:[ \t]*\\([^ \n\t:]+\\):\
08b1edf4 193\\([0-9]+\\):\\(\\([0-9]+\\)[: \t]\\)?" 1 2 4)
4dbf8a2c
RM
194
195 ;; Cray C compiler error messages
19ae9cb0 196 ("\n\\(cc\\| cft\\)-[0-9]+ c\\(c\\|f77\\): ERROR \\([^,\n]+, \\)* File = \\([^,\n]+\\), Line = \\([0-9]+\\)" 4 5)
4dbf8a2c
RM
197
198 ;; IBM C/C++ Tools 2.01:
199 ;; foo.c(2:0) : informational EDC0804: Function foo is not referenced.
200 ;; foo.c(3:8) : warning EDC0833: Implicit return statement encountered.
201 ;; foo.c(5:5) : error EDC0350: Syntax error.
54de3248 202 ("\n\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) : " 1 2 3)
cfda7e6d
RM
203
204 ;; Sun ada (VADS, Solaris):
205 ;; /home3/xdhar/rcds_rc/main.a, line 361, char 6:syntax error: "," inserted
206 ("\n\\([^, ]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
d3cb357b 207 )
6c43f2f9 208 "Alist that specifies how to match errors in compiler output.
20c1daec 209Each elt has the form (REGEXP FILE-IDX LINE-IDX [COLUMN-IDX FILE-FORMAT...])
72244bea
RM
210If REGEXP matches, the FILE-IDX'th subexpression gives the file name, and
211the LINE-IDX'th subexpression gives the line number. If COLUMN-IDX is
20c1daec
RM
212given, the COLUMN-IDX'th subexpression gives the column number on that line.
213If any FILE-FORMAT is given, each is a format string to produce a file name to
214try; %s in the string is replaced by the text matching the FILE-IDX'th
215subexpression.")
55dfd2c4 216
90016295
RS
217(defvar compilation-read-command t
218 "If not nil, M-x compile reads the compilation command to use.
219Otherwise, M-x compile just uses the value of `compile-command'.")
220
221(defvar compilation-ask-about-save t
222 "If not nil, M-x compile asks which buffers to save before compiling.
223Otherwise, it saves all modified buffers without asking.")
224
15d1a8da 225(defvar grep-regexp-alist
3e8258e7 226 '(("^\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]" 1 2))
15d1a8da
RM
227 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
228
98b63c41 229(defvar grep-command "grep -n "
203a5711 230 "Last grep command used in \\[grep]; default for next grep.")
98b63c41 231
7c163413 232;;;###autoload
d3cb357b 233(defvar compilation-search-path '(nil)
7c163413 234 "*List of directories to search for source files named in error messages.
d3cb357b
RM
235Elements should be directory names, not file names of directories.
236nil as an element means to try the default directory.")
55dfd2c4
RS
237
238(defvar compile-command "make -k "
239 "Last shell command used to do a compilation; default for next compilation.
240
241Sometimes it is useful for files to supply local values for this variable.
242You might also use mode hooks to specify it in certain modes, like this:
243
244 (setq c-mode-hook
245 '(lambda () (or (file-exists-p \"makefile\") (file-exists-p \"Makefile\")
246 (progn (make-local-variable 'compile-command)
247 (setq compile-command
248 (concat \"make -k \"
249 buffer-file-name))))))")
250
6e1dbafa 251(defvar compilation-enter-directory-regexp
daa37602 252 ": Entering directory `\\(.*\\)'$"
6c43f2f9
RS
253 "Regular expression matching lines that indicate a new current directory.
254This must contain one \\(, \\) pair around the directory name.
d3cb357b
RM
255
256The default value matches lines printed by the `-w' option of GNU Make.")
257
6e1dbafa 258(defvar compilation-leave-directory-regexp
daa37602 259 ": Leaving directory `\\(.*\\)'$"
6c43f2f9
RS
260 "Regular expression matching lines that indicate restoring current directory.
261This may contain one \\(, \\) pair around the name of the directory
262being moved from. If it does not, the last directory entered \(by a
263line matching `compilation-enter-directory-regexp'\) is assumed.
d3cb357b
RM
264
265The default value matches lines printed by the `-w' option of GNU Make.")
266
267(defvar compilation-directory-stack nil
6c43f2f9
RS
268 "Stack of previous directories for `compilation-leave-directory-regexp'.
269The head element is the directory the compilation was started in.")
d3cb357b 270
01f89d11
RM
271(defvar compilation-exit-message-function nil "\
272If non-nil, called when a compilation process dies to return a status message.
fd5e58d7
RM
273This should be a function of three arguments: process status, exit status,
274and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
275write into the compilation buffer, and to put in its mode line.")
01f89d11 276
770970cb
RS
277;; History of compile commands.
278(defvar compile-history nil)
279;; History of grep commands.
280(defvar grep-history nil)
281
9af0d309 282(defvar compilation-mode-font-lock-keywords
c81b38d3 283 ;; This regexp needs a bit of rewriting. What is the third grouping for?
3e8258e7
RM
284 '(("^\\([a-zA-Z]?:?[^ \n:]*:\\([0-9]+:\\)+\\)\\(.*\\)$"
285 1 font-lock-function-name-face))
9af0d309
RS
286;;; ("^\\([^\n:]*:\\([0-9]+:\\)+\\)\\(.*\\)$" 0 font-lock-keyword-face keep)
287 "Additional expressions to highlight in Compilation mode.")
01f89d11 288\f
d3cb357b 289;;;###autoload
55dfd2c4
RS
290(defun compile (command)
291 "Compile the program including the current buffer. Default: run `make'.
292Runs COMMAND, a shell command, in a separate process asynchronously
293with output going to the buffer `*compilation*'.
d3cb357b 294
55dfd2c4
RS
295You can then use the command \\[next-error] to find the next error message
296and move to the source code that caused it.
297
08b1edf4
RM
298Interactively, prompts for the command if `compilation-read-command' is
299non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
300
55dfd2c4 301To run more than one compilation at once, start one and rename the
d3cb357b
RM
302\`*compilation*' buffer to some other name with \\[rename-buffer].
303Then start the next one.
304
305The name used for the buffer is actually whatever is returned by
306the function in `compilation-buffer-name-function', so you can set that
307to a function that generates a unique name."
90016295 308 (interactive
08b1edf4 309 (if (or compilation-read-command current-prefix-arg)
90016295
RS
310 (list (read-from-minibuffer "Compile command: "
311 compile-command nil nil
312 '(compile-history . 1)))
313 (list compile-command)))
55dfd2c4 314 (setq compile-command command)
90016295 315 (save-some-buffers (not compilation-ask-about-save) nil)
d3cb357b 316 (compile-internal compile-command "No more errors"))
55dfd2c4 317
e60476ca
RS
318;;; run compile with the default command line
319(defun recompile ()
320 "Re-compile the program including the current buffer."
321 (interactive)
322 (save-some-buffers (not compilation-ask-about-save) nil)
323 (compile-internal compile-command "No more errors"))
09843b4a
RS
324
325;; The system null device. (Should reference NULL_DEVICE from C.)
326(defvar grep-null-device "/dev/null" "The system null device.")
327
d3cb357b 328;;;###autoload
55dfd2c4
RS
329(defun grep (command-args)
330 "Run grep, with user-specified args, and collect output in a buffer.
331While grep runs asynchronously, you can use the \\[next-error] command
d3cb357b
RM
332to find the text that grep hits refer to.
333
770970cb
RS
334This command uses a special history list for its arguments, so you can
335easily repeat a grep command."
55dfd2c4 336 (interactive
770970cb 337 (list (read-from-minibuffer "Run grep (like this): "
98b63c41 338 grep-command nil nil 'grep-history)))
01f89d11
RM
339 (let ((buf (compile-internal (concat command-args " " grep-null-device)
340 "No more grep hits" "grep"
341 ;; Give it a simpler regexp to match.
342 nil grep-regexp-alist)))
343 (save-excursion
344 (set-buffer buf)
345 (set (make-local-variable 'compilation-exit-message-function)
fd5e58d7
RM
346 (lambda (status code msg)
347 (if (eq status 'exit)
348 (cond ((zerop code)
349 '("finished (matches found)\n" . "matched"))
350 ((= code 1)
351 '("finished with no matches found\n" . "no match"))
352 (t
353 (cons msg code)))
354 (cons msg code)))))))
55dfd2c4
RS
355
356(defun compile-internal (command error-message
d3cb357b
RM
357 &optional name-of-mode parser regexp-alist
358 name-function)
55dfd2c4
RS
359 "Run compilation command COMMAND (low level interface).
360ERROR-MESSAGE is a string to print if the user asks to see another error
361and there are no more errors. Third argument NAME-OF-MODE is the name
d3cb357b
RM
362to display as the major mode in the compilation buffer.
363
364Fourth arg PARSER is the error parser function (nil means the default). Fifth
365arg REGEXP-ALIST is the error message regexp alist to use (nil means the
366default). Sixth arg NAME-FUNCTION is a function called to name the buffer (nil
367means the default). The defaults for these variables are the global values of
368\`compilation-parse-errors-function', `compilation-error-regexp-alist', and
646bd331
RM
369\`compilation-buffer-name-function', respectively.
370
371Returns the compilation buffer created."
d3cb357b 372 (let (outbuf)
55dfd2c4 373 (save-excursion
d3cb357b
RM
374 (or name-of-mode
375 (setq name-of-mode "Compilation"))
376 (setq outbuf
377 (get-buffer-create
378 (funcall (or name-function compilation-buffer-name-function
379 (function (lambda (mode)
380 (concat "*" (downcase mode) "*"))))
381 name-of-mode)))
382 (set-buffer outbuf)
383 (let ((comp-proc (get-buffer-process (current-buffer))))
384 (if comp-proc
385 (if (or (not (eq (process-status comp-proc) 'run))
386 (yes-or-no-p
bea1d57a
JB
387 (format "A %s process is running; kill it? "
388 name-of-mode)))
d3cb357b
RM
389 (condition-case ()
390 (progn
391 (interrupt-process comp-proc)
392 (sit-for 1)
393 (delete-process comp-proc))
394 (error nil))
395 (error "Cannot have two processes in `%s' at once"
396 (buffer-name))
397 )))
398 ;; In case the compilation buffer is current, make sure we get the global
399 ;; values of compilation-error-regexp-alist, etc.
400 (kill-all-local-variables))
401 (let ((regexp-alist (or regexp-alist compilation-error-regexp-alist))
402 (parser (or parser compilation-parse-errors-function))
403 (thisdir default-directory)
501cf428 404 outwin)
d3cb357b
RM
405 (save-excursion
406 ;; Clear out the compilation buffer and make it writable.
407 ;; Change its default-directory to the directory where the compilation
408 ;; will happen, and insert a `cd' command to indicate this.
409 (set-buffer outbuf)
410 (setq buffer-read-only nil)
5d5ab7ac 411 (buffer-disable-undo (current-buffer))
d3cb357b 412 (erase-buffer)
5d5ab7ac 413 (buffer-enable-undo (current-buffer))
d3cb357b
RM
414 (setq default-directory thisdir)
415 (insert "cd " thisdir "\n" command "\n")
416 (set-buffer-modified-p nil))
417 ;; If we're already in the compilation buffer, go to the end
418 ;; of the buffer, so point will track the compilation output.
419 (if (eq outbuf (current-buffer))
420 (goto-char (point-max)))
421 ;; Pop up the compilation buffer.
422 (setq outwin (display-buffer outbuf))
d4ece679
RS
423 (save-excursion
424 (set-buffer outbuf)
425 (compilation-mode)
a72ba929 426 ;; (setq buffer-read-only t) ;;; Non-ergonomic.
d4ece679
RS
427 (set (make-local-variable 'compilation-parse-errors-function) parser)
428 (set (make-local-variable 'compilation-error-message) error-message)
429 (set (make-local-variable 'compilation-error-regexp-alist) regexp-alist)
430 (setq default-directory thisdir
431 compilation-directory-stack (list default-directory))
432 (set-window-start outwin (point-min))
433 (setq mode-name name-of-mode)
434 (or (eq outwin (selected-window))
435 (set-window-point outwin (point-min)))
c94b02d6 436 (compilation-set-window-height outwin)
d4ece679 437 ;; Start the compilation.
35f7e85b 438 (if (fboundp 'start-process)
2bb240a9
RS
439 (let* ((process-environment (cons "EMACS=t" process-environment))
440 (proc (start-process-shell-command (downcase mode-name)
441 outbuf
442 command)))
35f7e85b
RS
443 (set-process-sentinel proc 'compilation-sentinel)
444 (set-process-filter proc 'compilation-filter)
445 (set-marker (process-mark proc) (point) outbuf)
501cf428 446 (setq compilation-in-progress
35f7e85b 447 (cons proc compilation-in-progress)))
fd5e58d7
RM
448 ;; No asynchronous processes available.
449 (message "Executing `%s'..." command)
d3e56891
RS
450 ;; Fake modeline display as if `start-process' were run.
451 (setq mode-line-process ":run")
fd5e58d7
RM
452 (force-mode-line-update)
453 (sit-for 0) ; Force redisplay
35f7e85b 454 (let ((status (call-process shell-file-name nil outbuf nil "-c"
fd5e58d7
RM
455 command)))
456 (cond ((numberp status)
457 (compilation-handle-exit 'exit status
458 (if (zerop status)
459 "finished\n"
460 (format "\
461exited abnormally with code %d\n"
462 status))))
463 ((stringp status)
464 (compilation-handle-exit 'signal status
465 (concat status "\n")))
466 (t
467 (compilation-handle-exit 'bizarre status status))))
468 (message "Executing `%s'...done" command))))
d3cb357b
RM
469 ;; Make it so the next C-x ` will use this buffer.
470 (setq compilation-last-buffer outbuf)))
55dfd2c4 471
c94b02d6
RS
472;; Set the height of WINDOW according to compilation-window-height.
473(defun compilation-set-window-height (window)
474 (and compilation-window-height
475 (= (window-width window) (frame-width (window-frame window)))
476 ;; If window is alone in its frame, aside from a minibuffer,
477 ;; don't change its height.
478 (not (eq window (frame-root-window (window-frame window))))
8205cbfc
RS
479 ;; This save-excursion prevents us from changing the current buffer,
480 ;; which might not be the same as the selected window's buffer.
481 (save-excursion
482 (let ((w (selected-window)))
483 (unwind-protect
484 (progn
485 (select-window window)
486 (enlarge-window (- compilation-window-height
487 (window-height))))
488 (select-window w))))))
c94b02d6 489
0b18a8f6 490(defvar compilation-minor-mode-map
55dfd2c4 491 (let ((map (make-sparse-keymap)))
f98494a4 492 (define-key map [mouse-2] 'compile-mouse-goto-error)
55dfd2c4 493 (define-key map "\C-c\C-c" 'compile-goto-error)
4e7ce12e 494 (define-key map "\C-m" 'compile-goto-error)
d3cb357b 495 (define-key map "\C-c\C-k" 'kill-compilation)
646bd331
RM
496 (define-key map "\M-n" 'compilation-next-error)
497 (define-key map "\M-p" 'compilation-previous-error)
d1ed4475
RM
498 (define-key map "\M-{" 'compilation-previous-file)
499 (define-key map "\M-}" 'compilation-next-file)
55dfd2c4 500 map)
4f6e4ad6 501 "Keymap for `compilation-minor-mode'.")
0b18a8f6
RM
502
503(defvar compilation-mode-map
504 (let ((map (cons 'keymap compilation-minor-mode-map)))
505 (define-key map " " 'scroll-up)
506 (define-key map "\^?" 'scroll-down)
e60476ca
RS
507 ;; Set up the menu-bar
508 (define-key map [menu-bar compilation-menu]
509 (cons "Compile" (make-sparse-keymap "Compile")))
510
511 (define-key map [menu-bar compilation-menu compilation-mode-kill-compilation]
0949ba2b 512 '("Stop Compilation" . kill-compilation))
e60476ca
RS
513 (define-key map [menu-bar compilation-menu compilation-mode-separator2]
514 '("----" . nil))
515 (define-key map [menu-bar compilation-menu compilation-mode-first-error]
0949ba2b 516 '("First Error" . first-error))
e60476ca 517 (define-key map [menu-bar compilation-menu compilation-mode-previous-error]
0949ba2b 518 '("Previous Error" . previous-error))
e60476ca 519 (define-key map [menu-bar compilation-menu compilation-mode-next-error]
0949ba2b 520 '("Next Error" . next-error))
e60476ca
RS
521 (define-key map [menu-bar compilation-menu compilation-separator2]
522 '("----" . nil))
523 (define-key map [menu-bar compilation-menu compilation-mode-grep]
524 '("Grep" . grep))
525 (define-key map [menu-bar compilation-menu compilation-mode-recompile]
526 '("Recompile" . recompile))
527 (define-key map [menu-bar compilation-menu compilation-mode-compile]
528 '("Compile" . compile))
0b18a8f6
RM
529 map)
530 "Keymap for compilation log buffers.
4f6e4ad6 531`compilation-minor-mode-map' is a cdr of this.")
55dfd2c4 532
501cf428 533;;;###autoload
55dfd2c4
RS
534(defun compilation-mode ()
535 "Major mode for compilation log buffers.
536\\<compilation-mode-map>To visit the source for a line-numbered error,
d3cb357b 537move point to the error message line and type \\[compile-goto-error].
7c163413
RM
538To kill the compilation, type \\[kill-compilation].
539
540Runs `compilation-mode-hook' with `run-hooks' (which see)."
55dfd2c4 541 (interactive)
9af0d309 542 (kill-all-local-variables)
55dfd2c4 543 (use-local-map compilation-mode-map)
0b18a8f6
RM
544 (setq major-mode 'compilation-mode
545 mode-name "Compilation")
546 (compilation-setup)
63a2daf6
SM
547 (set (make-local-variable 'font-lock-defaults)
548 '(compilation-mode-font-lock-keywords t))
0b18a8f6
RM
549 (run-hooks 'compilation-mode-hook))
550
551;; Prepare the buffer for the compilation parsing commands to work.
552(defun compilation-setup ()
553 ;; Make the buffer's mode line show process state.
ebf0b439 554 (setq mode-line-process '(":%s"))
d3cb357b
RM
555 (set (make-local-variable 'compilation-error-list) nil)
556 (set (make-local-variable 'compilation-old-error-list) nil)
557 (set (make-local-variable 'compilation-parsing-end) 1)
558 (set (make-local-variable 'compilation-directory-stack) nil)
0b18a8f6
RM
559 (setq compilation-last-buffer (current-buffer)))
560
561(defvar compilation-minor-mode nil
562 "Non-nil when in compilation-minor-mode.
563In this minor mode, all the error-parsing commands of the
564Compilation major mode are available.")
d6bd8dca 565(make-variable-buffer-local 'compilation-minor-mode)
0b18a8f6
RM
566
567(or (assq 'compilation-minor-mode minor-mode-alist)
568 (setq minor-mode-alist (cons '(compilation-minor-mode " Compilation")
569 minor-mode-alist)))
570(or (assq 'compilation-minor-mode minor-mode-map-alist)
4f6e4ad6
RS
571 (setq minor-mode-map-alist (cons (cons 'compilation-minor-mode
572 compilation-minor-mode-map)
0b18a8f6
RM
573 minor-mode-map-alist)))
574
d6bd8dca 575;;;###autoload
0b18a8f6
RM
576(defun compilation-minor-mode (&optional arg)
577 "Toggle compilation minor mode.
578With arg, turn compilation mode on if and only if arg is positive.
579See `compilation-mode'."
580 (interactive "P")
581 (if (setq compilation-minor-mode (if (null arg)
582 (null compilation-minor-mode)
583 (> (prefix-numeric-value arg) 0)))
584 (compilation-setup)))
55dfd2c4 585
fd5e58d7
RM
586;; Write msg in the current buffer and hack its mode-line-process.
587(defun compilation-handle-exit (process-status exit-status msg)
588 (let ((buffer-read-only nil)
589 (status (if compilation-exit-message-function
590 (funcall compilation-exit-message-function
591 process-status exit-status msg)
592 (cons msg exit-status)))
593 (omax (point-max))
594 (opoint (point)))
595 ;; Record where we put the message, so we can ignore it
596 ;; later on.
597 (goto-char omax)
598 (insert ?\n mode-name " " (car status))
599 (forward-char -1)
600 (insert " at " (substring (current-time-string) 0 19))
601 (forward-char 1)
602 (setq mode-line-process
603 (format ":%s [%s]"
604 (process-status proc) (cdr status)))
605 ;; Force mode line redisplay soon.
606 (force-mode-line-update)
607 (if (and opoint (< opoint omax))
608 (goto-char opoint))
609 (if compilation-finish-function
610 (funcall compilation-finish-function buffer msg))))
611
55dfd2c4 612;; Called when compilation process changes state.
55dfd2c4 613(defun compilation-sentinel (proc msg)
d3cb357b
RM
614 "Sentinel for compilation buffers."
615 (let ((buffer (process-buffer proc)))
ebff767c
RM
616 (if (memq (process-status proc) '(signal exit))
617 (progn
618 (if (null (buffer-name buffer))
619 ;; buffer killed
620 (set-process-buffer proc nil)
fd5e58d7 621 (let ((obuf (current-buffer)))
ebff767c
RM
622 ;; save-excursion isn't the right thing if
623 ;; process-buffer is current-buffer
624 (unwind-protect
625 (progn
626 ;; Write something in the compilation buffer
627 ;; and hack its mode line.
628 (set-buffer buffer)
fd5e58d7
RM
629 (compilation-handle-exit (process-status proc)
630 (process-exit-status proc)
631 msg)
632 ;; Since the buffer and mode line will show that the
633 ;; process is dead, we can delete it now. Otherwise it
634 ;; will stay around until M-x list-processes.
635 (delete-process proc))
6c43f2f9 636 (set-buffer obuf))))
ebff767c
RM
637 (setq compilation-in-progress (delq proc compilation-in-progress))
638 ))))
55dfd2c4 639
ad62b7f1
RM
640(defun compilation-filter (proc string)
641 "Process filter for compilation buffers.
4f6e4ad6 642Just inserts the text, but uses `insert-before-markers'."
991c70f8 643 (if (buffer-name (process-buffer proc))
ad62b7f1 644 (save-excursion
991c70f8
RS
645 (set-buffer (process-buffer proc))
646 (let ((buffer-read-only nil))
647 (save-excursion
648 (goto-char (process-mark proc))
649 (insert-before-markers string)
650 (set-marker (process-mark proc) (point)))))))
ad62b7f1 651
b5bb472e
RM
652;; Return the cdr of compilation-old-error-list for the error containing point.
653(defun compile-error-at-point ()
654 (compile-reinitialize-errors nil (point))
655 (let ((errors compilation-old-error-list))
656 (while (and errors
657 (> (point) (car (car errors))))
658 (setq errors (cdr errors)))
659 errors))
660
51ba27e7 661(defsubst compilation-buffer-p (buffer)
20c1daec
RM
662 (save-excursion
663 (set-buffer buffer)
664 (or compilation-minor-mode (eq major-mode 'compilation-mode))))
51ba27e7 665
646bd331
RM
666(defun compilation-next-error (n)
667 "Move point to the next error in the compilation buffer.
668Does NOT find the source line like \\[next-error]."
669 (interactive "p")
670 (or (compilation-buffer-p (current-buffer))
671 (error "Not in a compilation buffer."))
672 (setq compilation-last-buffer (current-buffer))
b5bb472e
RM
673
674 (let ((errors (compile-error-at-point)))
675
676 ;; Move to the error after the one containing point.
677 (goto-char (car (if (< n 0)
678 (let ((i 0)
679 (e compilation-old-error-list))
680 ;; See how many cdrs away ERRORS is from the start.
681 (while (not (eq e errors))
682 (setq i (1+ i)
683 e (cdr e)))
684 (if (> (- n) i)
685 (error "Moved back past first error")
686 (nth (+ i n) compilation-old-error-list)))
687 (let ((compilation-error-list (cdr errors)))
688 (compile-reinitialize-errors nil nil n)
689 (if compilation-error-list
690 (nth (1- n) compilation-error-list)
691 (error "Moved past last error"))))))))
646bd331
RM
692
693(defun compilation-previous-error (n)
694 "Move point to the previous error in the compilation buffer.
695Does NOT find the source line like \\[next-error]."
696 (interactive "p")
697 (compilation-next-error (- n)))
698
699
fc0094d7
RM
700;; Given an elt of `compilation-error-list', return an object representing
701;; the referenced file which is equal to (but not necessarily eq to) what
702;; this function would return for another error in the same file.
703(defsubst compilation-error-filedata (data)
b5bb472e
RM
704 (setq data (cdr data))
705 (if (markerp data)
fc0094d7 706 (marker-buffer data)
aead2f9f 707 (car data)))
b5bb472e 708
fc0094d7
RM
709;; Return a string describing a value from compilation-error-filedata.
710;; This value is not necessarily useful as a file name, but should be
711;; indicative to the user of what file's errors are being referred to.
712(defsubst compilation-error-filedata-file-name (filedata)
713 (if (bufferp filedata)
714 (buffer-file-name filedata)
715 (car filedata)))
716
b5bb472e
RM
717(defun compilation-next-file (n)
718 "Move point to the next error for a different file than the current one."
719 (interactive "p")
720 (or (compilation-buffer-p (current-buffer))
721 (error "Not in a compilation buffer."))
722 (setq compilation-last-buffer (current-buffer))
723
724 (let ((reversed (< n 0))
fc0094d7 725 errors filedata)
b5bb472e
RM
726
727 (if (not reversed)
728 (setq errors (or (compile-error-at-point)
729 (error "Moved past last error")))
730
731 ;; Get a reversed list of the errors up through the one containing point.
732 (compile-reinitialize-errors nil (point))
733 (setq errors (reverse compilation-old-error-list)
734 n (- n))
735
736 ;; Ignore errors after point. (car ERRORS) will be the error
737 ;; containing point, (cadr ERRORS) the one before it.
738 (while (and errors
739 (< (point) (car (car errors))))
740 (setq errors (cdr errors))))
741
742 (while (> n 0)
fc0094d7
RM
743 (setq filedata (compilation-error-filedata (car errors)))
744
745 ;; Skip past the following errors for this file.
746 (while (equal filedata
747 (compilation-error-filedata
748 (car (or errors
749 (if reversed
750 (error "%s the first erring file"
751 (compilation-error-filedata-file-name
752 filedata))
753 (let ((compilation-error-list nil))
754 ;; Parse some more.
755 (compile-reinitialize-errors nil nil 2)
756 (setq errors compilation-error-list)))
501cf428 757 (error "%s is the last erring file"
fc0094d7
RM
758 (compilation-error-filedata-file-name
759 filedata))))))
b5bb472e
RM
760 (setq errors (cdr errors)))
761
762 (setq n (1- n)))
763
764 ;; Move to the following error.
765 (goto-char (car (car (or errors
766 (if reversed
767 (error "This is the first erring file")
768 (let ((compilation-error-list nil))
769 ;; Parse the last one.
770 (compile-reinitialize-errors nil nil 1)
771 compilation-error-list))))))))
772
773(defun compilation-previous-file (n)
774 "Move point to the previous error for a different file than the current one."
775 (interactive "p")
776 (compilation-next-file (- n)))
777
778
55dfd2c4
RS
779(defun kill-compilation ()
780 "Kill the process made by the \\[compile] command."
781 (interactive)
d3cb357b 782 (let ((buffer (compilation-find-buffer)))
55dfd2c4 783 (if (get-buffer-process buffer)
d3cb357b
RM
784 (interrupt-process (get-buffer-process buffer))
785 (error "The compilation process is not running."))))
786
55dfd2c4 787
d3cb357b
RM
788;; Parse any new errors in the compilation buffer,
789;; or reparse from the beginning if the user has asked for that.
eaa3cac5
RM
790(defun compile-reinitialize-errors (reparse
791 &optional limit-search find-at-least)
d3cb357b
RM
792 (save-excursion
793 (set-buffer compilation-last-buffer)
794 ;; If we are out of errors, or if user says "reparse",
795 ;; discard the info we have, to force reparsing.
796 (if (or (eq compilation-error-list t)
eaa3cac5 797 reparse)
51ba27e7 798 (compilation-forget-errors))
c540863c 799 (if (and compilation-error-list
b5bb472e
RM
800 (or (not limit-search)
801 (> compilation-parsing-end limit-search))
c540863c 802 (or (not find-at-least)
a72ba929 803 (>= (length compilation-error-list) find-at-least)))
d3cb357b
RM
804 ;; Since compilation-error-list is non-nil, it points to a specific
805 ;; error the user wanted. So don't move it around.
806 nil
51ba27e7
RM
807 ;; This was here for a long time (before my rewrite); why? --roland
808 ;;(switch-to-buffer compilation-last-buffer)
55dfd2c4 809 (set-buffer-modified-p nil)
b5bb472e 810 (if (< compilation-parsing-end (point-max))
51ba27e7 811 ;; compilation-error-list might be non-nil if we have a non-nil
676a14e1 812 ;; LIMIT-SEARCH or FIND-AT-LEAST arg. In that case its value
51ba27e7
RM
813 ;; records the current position in the error list, and we must
814 ;; preserve that after reparsing.
815 (let ((error-list-pos compilation-error-list))
b5bb472e 816 (funcall compilation-parse-errors-function
51ba27e7
RM
817 limit-search
818 (and find-at-least
819 ;; We only need enough new parsed errors to reach
820 ;; FIND-AT-LEAST errors past the current
821 ;; position.
822 (- find-at-least (length compilation-error-list))))
823 ;; Remember the entire list for compilation-forget-errors. If
824 ;; this is an incremental parse, append to previous list. If
825 ;; we are parsing anew, compilation-forget-errors cleared
826 ;; compilation-old-error-list above.
827 (setq compilation-old-error-list
828 (nconc compilation-old-error-list compilation-error-list))
829 (if error-list-pos
830 ;; We started in the middle of an existing list of parsed
831 ;; errors before parsing more; restore that position.
832 (setq compilation-error-list error-list-pos))
b5bb472e 833 )))))
55dfd2c4 834
f98494a4
RS
835(defun compile-mouse-goto-error (event)
836 (interactive "e")
e78e10ca
KH
837 (save-excursion
838 (set-buffer (window-buffer (posn-window (event-end event))))
839 (goto-char (posn-point (event-end event)))
840
841 (or (compilation-buffer-p (current-buffer))
842 (error "Not in a compilation buffer."))
843 (setq compilation-last-buffer (current-buffer))
844 (compile-reinitialize-errors nil (point))
845
846 ;; Move to bol; the marker for the error on this line will point there.
847 (beginning-of-line)
848
849 ;; Move compilation-error-list to the elt of compilation-old-error-list
850 ;; we want.
851 (setq compilation-error-list compilation-old-error-list)
852 (while (and compilation-error-list
853 (> (point) (car (car compilation-error-list))))
854 (setq compilation-error-list (cdr compilation-error-list)))
855 (or compilation-error-list
856 (error "No error to go to")))
857 (select-window (posn-window (event-end event)))
858 ;; Move to another window, so that next-error's window changes
859 ;; result in the desired setup.
860 (or (one-window-p)
861 (progn
862 (other-window -1)
863 ;; other-window changed the selected buffer,
864 ;; but we didn't want to do that.
865 (set-buffer compilation-last-buffer)))
866
867 (push-mark)
868 (next-error 1))
f98494a4 869
55dfd2c4
RS
870(defun compile-goto-error (&optional argp)
871 "Visit the source for the error message point is on.
31efa7c9 872Use this command in a compilation log buffer. Sets the mark at point there.
b2bb6ec8 873\\[universal-argument] as a prefix arg means to reparse the buffer's error messages first;
55dfd2c4
RS
874other kinds of prefix arguments are ignored."
875 (interactive "P")
d3cb357b
RM
876 (or (compilation-buffer-p (current-buffer))
877 (error "Not in a compilation buffer."))
878 (setq compilation-last-buffer (current-buffer))
eaa3cac5 879 (compile-reinitialize-errors (consp argp) (point))
646bd331 880
15d1a8da
RM
881 ;; Move to bol; the marker for the error on this line will point there.
882 (beginning-of-line)
883
646bd331 884 ;; Move compilation-error-list to the elt of compilation-old-error-list
643f763f 885 ;; we want.
646bd331 886 (setq compilation-error-list compilation-old-error-list)
643f763f
RM
887 (while (and compilation-error-list
888 (> (point) (car (car compilation-error-list))))
646bd331
RM
889 (setq compilation-error-list (cdr compilation-error-list)))
890
55dfd2c4
RS
891 ;; Move to another window, so that next-error's window changes
892 ;; result in the desired setup.
893 (or (one-window-p)
646bd331
RM
894 (progn
895 (other-window -1)
896 ;; other-window changed the selected buffer,
897 ;; but we didn't want to do that.
898 (set-buffer compilation-last-buffer)))
899
31efa7c9 900 (push-mark)
643f763f 901 (next-error 1))
55dfd2c4 902
d3cb357b
RM
903;; Return a compilation buffer.
904;; If the current buffer is a compilation buffer, return it.
905;; If compilation-last-buffer is set to a live buffer, use that.
906;; Otherwise, look for a compilation buffer and signal an error
907;; if there are none.
4746118a
JB
908(defun compilation-find-buffer (&optional other-buffer)
909 (if (and (not other-buffer)
910 (compilation-buffer-p (current-buffer)))
d3cb357b
RM
911 ;; The current buffer is a compilation buffer.
912 (current-buffer)
4746118a
JB
913 (if (and compilation-last-buffer (buffer-name compilation-last-buffer)
914 (or (not other-buffer) (not (eq compilation-last-buffer
915 (current-buffer)))))
d3cb357b
RM
916 compilation-last-buffer
917 (let ((buffers (buffer-list)))
4746118a
JB
918 (while (and buffers (or (not (compilation-buffer-p (car buffers)))
919 (and other-buffer
920 (eq (car buffers) (current-buffer)))))
d3cb357b
RM
921 (setq buffers (cdr buffers)))
922 (if buffers
923 (car buffers)
4746118a
JB
924 (or (and other-buffer
925 (compilation-buffer-p (current-buffer))
926 ;; The current buffer is a compilation buffer.
927 (progn
928 (if other-buffer
929 (message "This is the only compilation buffer."))
930 (current-buffer)))
931 (error "No compilation started!")))))))
d3cb357b
RM
932
933;;;###autoload
55dfd2c4
RS
934(defun next-error (&optional argp)
935 "Visit next compilation error message and corresponding source code.
936This operates on the output from the \\[compile] command.
937If all preparsed error messages have been processed,
938the error message buffer is checked for new ones.
939
940A prefix arg specifies how many error messages to move;
941negative means move back to previous error messages.
942Just C-u as a prefix means reparse the error message buffer
943and start at the first error.
944
945\\[next-error] normally applies to the most recent compilation started,
946but as long as you are in the middle of parsing errors from one compilation
947output buffer, you stay with that compilation output buffer.
948
949Use \\[next-error] in a compilation output buffer to switch to
950processing errors from that compilation.
951
d3cb357b
RM
952See variables `compilation-parse-errors-function' and
953\`compilation-error-regexp-alist' for customization ideas."
55dfd2c4 954 (interactive "P")
d3cb357b 955 (setq compilation-last-buffer (compilation-find-buffer))
eaa3cac5
RM
956 (compilation-goto-locus (compilation-next-error-locus
957 ;; We want to pass a number here only if
958 ;; we got a numeric prefix arg, not just C-u.
959 (and (not (consp argp))
960 (prefix-numeric-value argp))
961 (consp argp))))
962;;;###autoload (define-key ctl-x-map "`" 'next-error)
963
e60476ca
RS
964(defun previous-error ()
965 "Visit previous compilation error message and corresponding source code.
966This operates on the output from the \\[compile] command."
967 (interactive)
eae2c972 968 (next-error -1))
e60476ca
RS
969
970(defun first-error ()
971 "Reparse the error message buffer and start at the first error
972Visit corresponding source code.
973This operates on the output from the \\[compile] command."
974 (interactive)
eae2c972 975 (next-error '(4)))
e60476ca 976
b4300a1a 977(defun compilation-next-error-locus (&optional move reparse silent)
eaa3cac5
RM
978 "Visit next compilation error and return locus in corresponding source code.
979This operates on the output from the \\[compile] command.
980If all preparsed error messages have been processed,
981the error message buffer is checked for new ones.
982
983Returns a cons (ERROR . SOURCE) of two markers: ERROR is a marker at the
984location of the error message in the compilation buffer, and SOURCE is a
985marker at the location in the source code indicated by the error message.
986
987Optional first arg MOVE says how many error messages to move forwards (or
988backwards, if negative); default is 1. Optional second arg REPARSE, if
989non-nil, says to reparse the error message buffer and reset to the first
501cf428 990error (plus MOVE - 1). If optional third argument SILENT is non-nil, return
b4300a1a 991nil instead of raising an error if there are no more errors.
eaa3cac5
RM
992
993The current buffer should be the desired compilation output buffer."
994 (or move (setq move 1))
995 (compile-reinitialize-errors reparse nil (and (not reparse)
996 (if (< move 1) 0 (1- move))))
d3cb357b 997 (let (next-errors next-error)
7fb63acd
RS
998 (catch 'no-next-error
999 (save-excursion
1000 (set-buffer compilation-last-buffer)
1001 ;; compilation-error-list points to the "current" error.
501cf428 1002 (setq next-errors
7fb63acd
RS
1003 (if (> move 0)
1004 (nthcdr (1- move)
1005 compilation-error-list)
1006 ;; Zero or negative arg; we need to move back in the list.
1007 (let ((n (1- move))
1008 (i 0)
1009 (e compilation-old-error-list))
1010 ;; See how many cdrs away the current error is from the start.
1011 (while (not (eq e compilation-error-list))
1012 (setq i (1+ i)
1013 e (cdr e)))
1014 (if (> (- n) i)
1015 (error "Moved back past first error")
1016 (nthcdr (+ i n) compilation-old-error-list))))
1017 next-error (car next-errors))
1018 (while
1019 (if (null next-error)
1020 (progn
1021 (and move (/= move 1)
1022 (error (if (> move 0)
1023 "Moved past last error")
1024 "Moved back past first error"))
1025 ;; Forget existing error messages if compilation has finished.
1026 (if (not (and (get-buffer-process (current-buffer))
1027 (eq (process-status
1028 (get-buffer-process
1029 (current-buffer)))
1030 'run)))
1031 (compilation-forget-errors))
1032 (if silent
1033 (throw 'no-next-error nil)
1034 (error (concat compilation-error-message
1035 (and (get-buffer-process (current-buffer))
1036 (eq (process-status
1037 (get-buffer-process
1038 (current-buffer)))
1039 'run)
b4300a1a 1040 " yet")))))
7fb63acd
RS
1041 (setq compilation-error-list (cdr next-errors))
1042 (if (null (cdr next-error))
1043 ;; This error is boring. Go to the next.
1044 t
1045 (or (markerp (cdr next-error))
1046 ;; This error has a filename/lineno pair.
1047 ;; Find the file and turn it into a marker.
1048 (let* ((fileinfo (car (cdr next-error)))
20c1daec
RM
1049 (buffer (apply 'compilation-find-file
1050 (car next-error) fileinfo)))
7fb63acd
RS
1051 (if (null buffer)
1052 ;; We can't find this error's file.
1053 ;; Remove all errors in the same file.
1054 (progn
1055 (setq next-errors compilation-old-error-list)
1056 (while next-errors
1057 (and (consp (cdr (car next-errors)))
1058 (equal (car (cdr (car next-errors)))
1059 fileinfo)
1060 (progn
1061 (set-marker (car (car next-errors)) nil)
1062 (setcdr (car next-errors) nil)))
1063 (setq next-errors (cdr next-errors)))
1064 ;; Look for the next error.
1065 t)
1066 ;; We found the file. Get a marker for this error.
1067 ;; compilation-old-error-list is a buffer-local
1068 ;; variable, so we must be careful to extract its value
1069 ;; before switching to the source file buffer.
1070 (let ((errors compilation-old-error-list)
1071 (last-line (nth 1 (cdr next-error)))
1072 (column (nth 2 (cdr next-error))))
1073 (set-buffer buffer)
1074 (save-excursion
1075 (save-restriction
1076 (widen)
1077 (goto-line last-line)
4dbf8a2c 1078 (if (and column (> column 0))
4ad26d84
RM
1079 ;; Columns in error msgs are 1-origin.
1080 (move-to-column (1- column))
7fb63acd
RS
1081 (beginning-of-line))
1082 (setcdr next-error (point-marker))
1083 ;; Make all the other error messages referring
1084 ;; to the same file have markers into the buffer.
1085 (while errors
1086 (and (consp (cdr (car errors)))
1087 (equal (car (cdr (car errors))) fileinfo)
1088 (let* ((this (nth 1 (cdr (car errors))))
1089 (column (nth 2 (cdr (car errors))))
1090 (lines (- this last-line)))
1091 (if (eq selective-display t)
1092 ;; When selective-display is t,
1093 ;; each C-m is a line boundary,
1094 ;; as well as each newline.
1095 (if (< lines 0)
1096 (re-search-backward "[\n\C-m]"
1097 nil 'end
1098 (- lines))
1099 (re-search-forward "[\n\C-m]"
1100 nil 'end
1101 lines))
1102 (forward-line lines))
eae2c972
RM
1103 (if (and column (> column 1))
1104 (move-to-column (1- column))
1105 (beginning-of-line))
7fb63acd
RS
1106 (setq last-line this)
1107 (setcdr (car errors) (point-marker))))
1108 (setq errors (cdr errors)))))))))
1109 ;; If we didn't get a marker for this error, or this
1110 ;; marker's buffer was killed, go on to the next one.
1111 (or (not (markerp (cdr next-error)))
1112 (not (marker-buffer (cdr next-error))))))
1113 (setq next-errors compilation-error-list
b4300a1a 1114 next-error (car next-errors)))))
d3cb357b
RM
1115
1116 ;; Skip over multiple error messages for the same source location,
1117 ;; so the next C-x ` won't go to an error in the same place.
1118 (while (and compilation-error-list
1119 (equal (cdr (car compilation-error-list)) (cdr next-error)))
1120 (setq compilation-error-list (cdr compilation-error-list)))
1121
eaa3cac5
RM
1122 ;; We now have a marker for the position of the error source code.
1123 ;; NEXT-ERROR is a cons (ERROR . SOURCE) of two markers.
1124 next-error))
1125
1126(defun compilation-goto-locus (next-error)
1127 "Jump to an error locus returned by `compilation-next-error-locus'.
1128Takes one argument, a cons (ERROR . SOURCE) of two markers.
1129Selects a window with point at SOURCE, with another window displaying ERROR."
e89a7d77
RS
1130 (if (and (window-dedicated-p (selected-window))
1131 (eq (selected-window) (frame-root-window)))
1132 (switch-to-buffer-other-frame (marker-buffer (cdr next-error)))
1133 (switch-to-buffer (marker-buffer (cdr next-error))))
eaa3cac5
RM
1134 (goto-char (cdr next-error))
1135 ;; If narrowing got in the way of
1136 ;; going to the right place, widen.
1137 (or (= (point) (marker-position (cdr next-error)))
1138 (progn
1139 (widen)
1140 (goto-char (cdr next-error))))
1141
1142 ;; Show compilation buffer in other window, scrolled to this error.
1143 (let* ((pop-up-windows t)
eae2c972 1144 ;; Use an existing window if it is in a visible frame.
c94b02d6 1145 (w (or (get-buffer-window (marker-buffer (car next-error)) 'visible)
eae2c972 1146 ;; Pop up a window.
c94b02d6 1147 (display-buffer (marker-buffer (car next-error))))))
eaa3cac5 1148 (set-window-point w (car next-error))
c94b02d6
RS
1149 (set-window-start w (car next-error))
1150 (compilation-set-window-height w)))
eaa3cac5 1151\f
d3cb357b
RM
1152;; Find a buffer for file FILENAME.
1153;; Search the directories in compilation-search-path.
1154;; A nil in compilation-search-path means to try the
1155;; current directory, which is passed in DIR.
1156;; If FILENAME is not found at all, ask the user where to find it.
1157;; Pop up the buffer containing MARKER and scroll to MARKER if we ask the user.
20c1daec
RM
1158(defun compilation-find-file (marker filename dir &rest formats)
1159 (or formats (setq formats '("%s")))
d3cb357b 1160 (let ((dirs compilation-search-path)
cd494de4
RM
1161 buffer thisdir fmts name)
1162 (if (file-name-absolute-p filename)
1163 ;; The file name is absolute. Use its explicit directory as
1164 ;; the first in the search path, and strip it from FILENAME.
1165 (setq filename (abbreviate-file-name (expand-file-name filename))
1166 dirs (cons (file-name-directory filename) dirs)
1167 filename (file-name-nondirectory filename)))
1168 ;; Now search the path.
1169 (while (and dirs (null buffer))
20c1daec
RM
1170 (setq thisdir (or (car dirs) dir)
1171 fmts formats)
cd494de4
RM
1172 ;; For each directory, try each format string.
1173 (while (and fmts (null buffer))
20c1daec 1174 (setq name (expand-file-name (format (car fmts) filename) thisdir)
cd494de4 1175 buffer (and (file-exists-p name)
20c1daec
RM
1176 (find-file-noselect name))
1177 fmts (cdr fmts)))
1178 (setq dirs (cdr dirs)))
cd494de4 1179 (or buffer
d3cb357b
RM
1180 ;; The file doesn't exist.
1181 ;; Ask the user where to find it.
1182 ;; If he hits C-g, then the next time he does
1183 ;; next-error, he'll skip past it.
cd494de4
RM
1184 (let* ((pop-up-windows t)
1185 (w (display-buffer (marker-buffer marker))))
1186 (set-window-point w marker)
1187 (set-window-start w marker)
1188 (let ((name (expand-file-name
1189 (read-file-name
1190 (format "Find this error in: (default %s) "
1191 filename)
1192 dir filename t))))
1193 (if (file-directory-p name)
1194 (setq name (expand-file-name filename name)))
1195 (and (file-exists-p name)
1196 (find-file-noselect name)))))))
d3cb357b
RM
1197
1198;; Set compilation-error-list to nil, and unchain the markers that point to the
1199;; error messages and their text, so that they no longer slow down gap motion.
1200;; This would happen anyway at the next garbage collection, but it is better to
646bd331 1201;; do it right away.
55dfd2c4
RS
1202(defun compilation-forget-errors ()
1203 (while compilation-old-error-list
1204 (let ((next-error (car compilation-old-error-list)))
1205 (set-marker (car next-error) nil)
d3cb357b
RM
1206 (if (markerp (cdr next-error))
1207 (set-marker (cdr next-error) nil)))
55dfd2c4 1208 (setq compilation-old-error-list (cdr compilation-old-error-list)))
bd3910fe 1209 (setq compilation-error-list nil
51ba27e7
RM
1210 compilation-directory-stack nil
1211 compilation-parsing-end 1))
d3cb357b
RM
1212
1213
1214(defun count-regexp-groupings (regexp)
1215 "Return the number of \\( ... \\) groupings in REGEXP (a string)."
1216 (let ((groupings 0)
1217 (len (length regexp))
1218 (i 0)
1219 c)
1220 (while (< i len)
1221 (setq c (aref regexp i)
1222 i (1+ i))
1223 (cond ((= c ?\[)
1224 ;; Find the end of this [...].
1225 (while (and (< i len)
1226 (not (= (aref regexp i) ?\])))
1227 (setq i (1+ i))))
1228 ((= c ?\\)
1229 (if (< i len)
1230 (progn
1231 (setq c (aref regexp i)
1232 i (1+ i))
1233 (if (= c ?\))
1234 ;; We found the end of a grouping,
1235 ;; so bump our counter.
1236 (setq groupings (1+ groupings))))))))
1237 groupings))
55dfd2c4 1238
c540863c 1239(defun compilation-parse-errors (limit-search find-at-least)
55dfd2c4 1240 "Parse the current buffer as grep, cc or lint error messages.
d3cb357b 1241See variable `compilation-parse-errors-function' for the interface it uses."
55dfd2c4
RS
1242 (setq compilation-error-list nil)
1243 (message "Parsing error messages...")
51501e54 1244 (let (text-buffer orig orig-expanded parent-expanded
d3cb357b 1245 regexp enter-group leave-group error-group
b2bb6ec8 1246 alist subexpr error-regexp-groups
c540863c 1247 (found-desired nil)
6c43f2f9 1248 (compilation-num-errors-found 0))
d3cb357b 1249
55dfd2c4
RS
1250 ;; Don't reparse messages already seen at last parse.
1251 (goto-char compilation-parsing-end)
1252 ;; Don't parse the first two lines as error messages.
1253 ;; This matters for grep.
1254 (if (bobp)
2e4301ef
RM
1255 (progn
1256 (forward-line 2)
1257 ;; Move back so point is before the newline.
1258 ;; This matters because some error regexps use \n instead of ^
1259 ;; to be faster.
1260 (forward-char -1)))
d3cb357b
RM
1261
1262 ;; Compile all the regexps we want to search for into one.
1263 (setq regexp (concat "\\(" compilation-enter-directory-regexp "\\)\\|"
1264 "\\(" compilation-leave-directory-regexp "\\)\\|"
1265 "\\(" (mapconcat (function
1266 (lambda (elt)
1267 (concat "\\(" (car elt) "\\)")))
1268 compilation-error-regexp-alist
1269 "\\|") "\\)"))
1270
1271 ;; Find out how many \(...\) groupings are in each of the regexps, and set
1272 ;; *-GROUP to the grouping containing each constituent regexp (whose
1273 ;; subgroups will come immediately thereafter) of the big regexp we have
1274 ;; just constructed.
1275 (setq enter-group 1
1276 leave-group (+ enter-group
1277 (count-regexp-groupings
1278 compilation-enter-directory-regexp)
1279 1)
1280 error-group (+ leave-group
1281 (count-regexp-groupings
1282 compilation-leave-directory-regexp)
1283 1))
1284
72244bea
RM
1285 ;; Compile an alist (IDX FILE LINE [COL]), where IDX is the number of
1286 ;; the subexpression for an entire error-regexp, and FILE and LINE (and
1287 ;; possibly COL) are the numbers for the subexpressions giving the file
1288 ;; name and line number (and possibly column number).
d4035a26
RM
1289 (setq alist (or compilation-error-regexp-alist
1290 (error "compilation-error-regexp-alist is empty!"))
d3cb357b
RM
1291 subexpr (1+ error-group))
1292 (while alist
72244bea
RM
1293 (setq error-regexp-groups
1294 (cons (list subexpr
1295 (+ subexpr (nth 1 (car alist)))
1296 (+ subexpr (nth 2 (car alist)))
8425a49a
RM
1297 (and (nth 3 (car alist))
1298 (+ subexpr (nth 3 (car alist)))))
72244bea 1299 error-regexp-groups))
d3cb357b
RM
1300 (setq subexpr (+ subexpr 1 (count-regexp-groupings (car (car alist)))))
1301 (setq alist (cdr alist)))
1302
cd494de4
RM
1303 ;; Set up now the expanded, abbreviated directory variables
1304 ;; that compile-abbreviate-directory will need, so we can
1305 ;; compute them just once here.
1306 (setq orig (abbreviate-file-name default-directory)
1307 orig-expanded (abbreviate-file-name
1308 (file-truename default-directory))
1309 parent-expanded (abbreviate-file-name
1310 (expand-file-name "../" orig-expanded)))
51501e54 1311
646bd331 1312 (while (and (not found-desired)
b2bb6ec8
RM
1313 ;; We don't just pass LIMIT-SEARCH to re-search-forward
1314 ;; because we want to find matches containing LIMIT-SEARCH
1315 ;; but which extend past it.
646bd331 1316 (re-search-forward regexp nil t))
dadb11fb 1317
d3cb357b
RM
1318 ;; Figure out which constituent regexp matched.
1319 (cond ((match-beginning enter-group)
1320 ;; The match was the enter-directory regexp.
1321 (let ((dir
1322 (file-name-as-directory
1323 (expand-file-name
1324 (buffer-substring (match-beginning (+ enter-group 1))
1325 (match-end (+ enter-group 1)))))))
51501e54
RS
1326 ;; The directory name in the "entering" message
1327 ;; is a truename. Try to convert it to a form
1328 ;; like what the user typed in.
1329 (setq dir
1330 (compile-abbreviate-directory dir orig orig-expanded
1331 parent-expanded))
d3cb357b
RM
1332 (setq compilation-directory-stack
1333 (cons dir compilation-directory-stack))
1334 (and (file-directory-p dir)
51ba27e7
RM
1335 (setq default-directory dir)))
1336
1337 (and limit-search (>= (point) limit-search)
1338 ;; The user wanted a specific error, and we're past it.
1339 ;; We do this check here (and in the leave-group case)
1340 ;; rather than at the end of the loop because if the last
1341 ;; thing seen is an error message, we must carefully
1342 ;; discard the last error when it is the first in a new
1343 ;; file (see below in the error-group case).
1344 (setq found-desired t)))
1345
d3cb357b
RM
1346 ((match-beginning leave-group)
1347 ;; The match was the leave-directory regexp.
1348 (let ((beg (match-beginning (+ leave-group 1)))
1349 (stack compilation-directory-stack))
1350 (if beg
1351 (let ((dir
1352 (file-name-as-directory
1353 (expand-file-name
1354 (buffer-substring beg
1355 (match-end (+ leave-group
1356 1)))))))
cd494de4 1357 ;; The directory name in the "leaving" message
51501e54
RS
1358 ;; is a truename. Try to convert it to a form
1359 ;; like what the user typed in.
1360 (setq dir
1361 (compile-abbreviate-directory dir orig orig-expanded
1362 parent-expanded))
d3cb357b
RM
1363 (while (and stack
1364 (not (string-equal (car stack) dir)))
1365 (setq stack (cdr stack)))))
1366 (setq compilation-directory-stack (cdr stack))
1367 (setq stack (car compilation-directory-stack))
1368 (if stack
1369 (setq default-directory stack))
51ba27e7
RM
1370 )
1371
1372 (and limit-search (>= (point) limit-search)
1373 ;; The user wanted a specific error, and we're past it.
1374 ;; We do this check here (and in the enter-group case)
1375 ;; rather than at the end of the loop because if the last
1376 ;; thing seen is an error message, we must carefully
1377 ;; discard the last error when it is the first in a new
1378 ;; file (see below in the error-group case).
1379 (setq found-desired t)))
1380
d3cb357b
RM
1381 ((match-beginning error-group)
1382 ;; The match was the composite error regexp.
1383 ;; Find out which individual regexp matched.
1384 (setq alist error-regexp-groups)
1385 (while (and alist
1386 (null (match-beginning (car (car alist)))))
1387 (setq alist (cdr alist)))
1388 (if alist
1389 (setq alist (car alist))
d4035a26 1390 (error "compilation-parse-errors: impossible regexp match!"))
501cf428 1391
d3cb357b 1392 ;; Extract the file name and line number from the error message.
1f82d0e4 1393 (let ((beginning-of-match (match-beginning 0)) ;looking-at nukes
1e0e614d
RM
1394 (filename (buffer-substring (match-beginning (nth 1 alist))
1395 (match-end (nth 1 alist))))
72244bea
RM
1396 (linenum (string-to-int
1397 (buffer-substring
1398 (match-beginning (nth 2 alist))
1399 (match-end (nth 2 alist)))))
1400 (column (and (nth 3 alist)
08b1edf4 1401 (match-beginning (nth 3 alist))
72244bea
RM
1402 (string-to-int
1403 (buffer-substring
1404 (match-beginning (nth 3 alist))
1405 (match-end (nth 3 alist)))))))
1406
1e0e614d
RM
1407 ;; Check for a comint-file-name-prefix and prepend it if
1408 ;; appropriate. (This is very useful for
1409 ;; compilation-minor-mode in an rlogin-mode buffer.)
1410 (and (boundp 'comint-file-name-prefix)
1411 ;; If the file name is relative, default-directory will
1412 ;; already contain the comint-file-name-prefix (done by
1413 ;; compile-abbreviate-directory).
1414 (file-name-absolute-p filename)
1415 (setq filename (concat comint-file-name-prefix filename)))
20c1daec
RM
1416 (setq filename (cons filename (cons default-directory
1417 (nthcdr 4 alist))))
501cf428 1418
1e0e614d 1419
d3cb357b
RM
1420 ;; Locate the erring file and line.
1421 ;; Cons a new elt onto compilation-error-list,
1422 ;; giving a marker for the current compilation buffer
1423 ;; location, and the file and line number of the error.
1424 (save-excursion
eae2c972
RM
1425 ;; Save as the start of the error the beginning of the
1426 ;; line containing the match unless the match starts at a
1427 ;; newline, in which case the beginning of the next line.
1428 (goto-char beginning-of-match)
1429 (forward-line (if (eolp) 1 0))
ba2700db 1430 (let ((this (cons (point-marker)
533304f8 1431 (list filename linenum column))))
ba2700db
RS
1432 ;; Don't add the same source line more than once.
1433 (if (equal (cdr this) (cdr (car compilation-error-list)))
1434 nil
1435 (setq compilation-error-list
1436 (cons this
1437 compilation-error-list))
1438 (setq compilation-num-errors-found
1439 (1+ compilation-num-errors-found)))))
51ba27e7
RM
1440 (and (or (and find-at-least (> compilation-num-errors-found
1441 find-at-least))
1442 (and limit-search (>= (point) limit-search)))
1443 ;; We have found as many new errors as the user wants,
1444 ;; or past the buffer position he indicated. We
1445 ;; continue to parse until we have seen all the
1446 ;; consecutive errors in the same file, so the error
1447 ;; positions will be recorded as markers in this buffer
1448 ;; that might change.
1f82d0e4
RM
1449 (cdr compilation-error-list) ; Must check at least two.
1450 (not (equal (car (cdr (nth 0 compilation-error-list)))
1451 (car (cdr (nth 1 compilation-error-list)))))
1452 (progn
1453 ;; Discard the error just parsed, so that the next
1454 ;; parsing run can get it and the following errors in
1455 ;; the same file all at once. If we didn't do this, we
1456 ;; would have the same problem we are trying to avoid
1457 ;; with the test above, just delayed until the next run!
1458 (setq compilation-error-list
1459 (cdr compilation-error-list))
1460 (goto-char beginning-of-match)
1461 (setq found-desired t)))
1462 )
41acdfa9 1463 )
d3cb357b 1464 (t
d4035a26 1465 (error "compilation-parse-errors: known groups didn't match!")))
dadb11fb 1466
51ba27e7 1467 (message "Parsing error messages...%d (%.0f%% of buffer)"
6c43f2f9 1468 compilation-num-errors-found
51ba27e7
RM
1469 ;; Use floating-point because (* 100 (point)) frequently
1470 ;; exceeds the range of Emacs Lisp integers.
1471 (/ (* 100.0 (point)) (point-max)))
dadb11fb 1472
b2bb6ec8
RM
1473 (and limit-search (>= (point) limit-search)
1474 ;; The user wanted a specific error, and we're past it.
1475 (setq found-desired t)))
c540863c
RM
1476 (setq compilation-parsing-end (if found-desired
1477 (point)
1478 ;; We have searched the whole buffer.
1479 (point-max))))
1480 (setq compilation-error-list (nreverse compilation-error-list))
1481 (message "Parsing error messages...done"))
55dfd2c4 1482
51501e54
RS
1483;; If directory DIR is a subdir of ORIG or of ORIG's parent,
1484;; return a relative name for it starting from ORIG or its parent.
1485;; ORIG-EXPANDED is an expanded version of ORIG.
1486;; PARENT-EXPANDED is an expanded version of ORIG's parent.
1487;; Those two args could be computed here, but we run faster by
1488;; having the caller compute them just once.
1489(defun compile-abbreviate-directory (dir orig orig-expanded parent-expanded)
cd494de4
RM
1490 ;; Apply canonical abbreviations to DIR first thing.
1491 ;; Those abbreviations are already done in the other arguments passed.
1492 (setq dir (abbreviate-file-name dir))
1493
1e0e614d
RM
1494 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1495 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1496 ;; buffer.)
1497 (if (boundp 'comint-file-name-prefix)
1498 (setq dir (concat comint-file-name-prefix dir)))
1499
51501e54
RS
1500 (if (and (> (length dir) (length orig-expanded))
1501 (string= orig-expanded
1502 (substring dir 0 (length orig-expanded))))
1503 (setq dir
1504 (concat orig
1505 (substring dir (length orig-expanded)))))
1506 (if (and (> (length dir) (length parent-expanded))
1507 (string= parent-expanded
1508 (substring dir 0 (length parent-expanded))))
1509 (setq dir
1510 (concat (file-name-directory
1511 (directory-file-name orig))
1512 (substring dir (length parent-expanded)))))
1513 dir)
1514
4746118a 1515(provide 'compile)
fad160d5
ER
1516
1517;;; compile.el ends here