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