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