(compilation-sentinel): Use the local value of
[emacs.git] / lisp / progmodes / compile.el
blob172a4622791eca491217cc9555e84316fe129da6
1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages.
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 1995 Free Software Foundation, Inc.
5 ;; Author: Roland McGrath <roland@prep.ai.mit.edu>
6 ;; Maintainer: FSF
7 ;; Keywords: tools, processes
9 ;; This file is part of GNU Emacs.
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.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
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.
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.
25 ;;; Commentary:
27 ;; This package provides the compile and grep facilities documented in
28 ;; the Emacs user's manual.
30 ;;; Code:
32 ;;;###autoload
33 (defvar compilation-mode-hook nil
34 "*List of hook functions run by `compilation-mode' (see `run-hooks').")
36 ;;;###autoload
37 (defvar compilation-window-height nil
38 "*Number of lines in a compilation window. If nil, use Emacs default.")
40 (defvar compilation-error-list nil
41 "List of error message descriptors for visiting erring functions.
42 Each error descriptor is a cons (or nil). Its car is a marker pointing to
43 an error message. If its cdr is a marker, it points to the text of the
44 line 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
46 error is not interesting.
48 The value may be t instead of a list; this means that the buffer of
49 error messages should be reparsed the next time the list of errors is wanted.
51 Some other commands (like `diff') use this list to control the error
52 message tracking facilites; if you change its structure, you should make
53 sure you also change those packages. Perhaps it is better not to change
54 it at all.")
56 (defvar compilation-old-error-list nil
57 "Value of `compilation-error-list' after errors were parsed.")
59 (defvar compilation-parse-errors-function 'compilation-parse-errors
60 "Function to call to parse error messages from a compilation.
61 It takes args LIMIT-SEARCH and FIND-AT-LEAST.
62 If LIMIT-SEARCH is non-nil, don't bother parsing past that location.
63 If FIND-AT-LEAST is non-nil, don't bother parsing after finding that
64 many new errors.
65 It 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
67 found. See that variable for more info.")
69 ;;;###autoload
70 (defvar compilation-buffer-name-function nil
71 "Function to compute the name of a compilation buffer.
72 The function receives one argument, the name of the major mode of the
73 compilation buffer. It should return a string.
74 nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
76 ;;;###autoload
77 (defvar compilation-finish-function nil
78 "*Function to call when a compilation process finishes.
79 It is called with two arguments: the compilation buffer, and a string
80 describing how the process finished.")
82 (defvar compilation-last-buffer nil
83 "The most recent compilation buffer.
84 A buffer becomes most recent when its compilation is started
85 or when it is used with \\[next-error] or \\[compile-goto-error].")
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)))
93 (defvar compilation-parsing-end nil
94 "Position of end of buffer when last error messages were parsed.")
96 (defvar compilation-error-message "No more errors"
97 "Message to print when no more matches are found.")
99 (defvar compilation-num-errors-found)
101 (defvar compilation-error-regexp-alist
103 ;; NOTE! See also grep-regexp-alist, below.
105 ;; 4.3BSD grep, cc, lint pass 1:
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
111 ;; or GNU utilities with column (GNAT 1.82):
112 ;; foo.adb:2:1: Unit name does not match file name
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.
117 ("\n\
118 \\([^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\)\\([) \t]\\|\
119 :\\([^0-9\n]\\|\\([0-9]+:\\)\\)\\)" 1 2 5)
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)
127 ;; 4.3BSD lint pass 2
128 ;; strcmp: variable # of args. llib-lc(359) :: /usr/src/foo/foo.c(8)
129 ("[ \t:]\\([^:( \t\n]+\\)[:(](+[ \t]*\\([0-9]+\\))[:) \t]*$" 1 2)
131 ;; 4.3BSD lint pass 3
132 ;; bloofle defined( /users/wolfgang/foo.c(4) ), but never used
133 ;; This used to be
134 ;; ("[ \t(]+\\([^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]+" 1 2)
135 ;; which is regexp Impressionism - it matches almost anything!
136 ("([ \t]*\\([^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\))" 1 2)
138 ;; Ultrix 3.0 f77:
139 ;; fort: Severe: addstf.f, line 82: Missing operator or delimiter symbol
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)
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
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]+\
150 of[ \t]+\"?\\([^\":\n]+\\)\"?:" 3 2)
152 ;; Apollo cc, 4.3BSD fc:
153 ;; "foo.f", line 3: Error: syntax error near end of statement
154 ;; IBM RS6000:
155 ;; "vvouch.c", line 19.5: 1506-046 (S) Syntax error.
156 ;; Unknown compiler:
157 ;; File "foobar.ml", lines 5-8, characters 20-155: blah blah
158 ;; Microtec mcc68k:
159 ;; "foo.c", line 32 pos 1; (E) syntax error; unexpected symbol: "lossage"
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)
164 ;; MIPS RISC CC - the one distributed with Ultrix:
165 ;; ccom: Error: foo.c, line 2: syntax error
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)
170 ;; IBM AIX PS/2 C version 1.1:
171 ;; ****** Error number 140 in line 8 of file errors.c ******
172 ("in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
173 ;; IBM AIX lint is too painful to do right this way. File name
174 ;; prefixes entire sections rather than being on each line.
176 ;; Lucid Compiler, lcc 3.x
177 ;; E, file.cc(35,52) Illegal operation on pointers
178 ("\n[EW], \\([^(\n]*\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)" 1 2 3)
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)
184 ;; Cray C compiler error messages
185 ("\n\\(cc\\| cft\\)-[0-9]+ c\\(c\\|f77\\): ERROR \\([^,\n]+, \\)* File = \\([^,\n]+\\), Line = \\([0-9]+\\)" 4 5)
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.
191 ("\n\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) : " 1 2 3)
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)
197 "Alist that specifies how to match errors in compiler output.
198 Each elt has the form (REGEXP FILE-IDX LINE-IDX [COLUMN-IDX FILE-FORMAT...])
199 If REGEXP matches, the FILE-IDX'th subexpression gives the file name, and
200 the LINE-IDX'th subexpression gives the line number. If COLUMN-IDX is
201 given, the COLUMN-IDX'th subexpression gives the column number on that line.
202 If any FILE-FORMAT is given, each is a format string to produce a file name to
203 try; %s in the string is replaced by the text matching the FILE-IDX'th
204 subexpression.")
206 (defvar compilation-read-command t
207 "If not nil, M-x compile reads the compilation command to use.
208 Otherwise, M-x compile just uses the value of `compile-command'.")
210 (defvar compilation-ask-about-save t
211 "If not nil, M-x compile asks which buffers to save before compiling.
212 Otherwise, it saves all modified buffers without asking.")
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'.")
218 (defvar grep-command "grep -n "
219 "Last grep command used in \\[grep]; default for next grep.")
221 ;;;###autoload
222 (defvar compilation-search-path '(nil)
223 "*List of directories to search for source files named in error messages.
224 Elements should be directory names, not file names of directories.
225 nil as an element means to try the default directory.")
227 (defvar compile-command "make -k "
228 "Last shell command used to do a compilation; default for next compilation.
230 Sometimes it is useful for files to supply local values for this variable.
231 You might also use mode hooks to specify it in certain modes, like this:
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))))))")
240 (defvar compilation-enter-directory-regexp
241 ": Entering directory `\\(.*\\)'$"
242 "Regular expression matching lines that indicate a new current directory.
243 This must contain one \\(, \\) pair around the directory name.
245 The default value matches lines printed by the `-w' option of GNU Make.")
247 (defvar compilation-leave-directory-regexp
248 ": Leaving directory `\\(.*\\)'$"
249 "Regular expression matching lines that indicate restoring current directory.
250 This may contain one \\(, \\) pair around the name of the directory
251 being moved from. If it does not, the last directory entered \(by a
252 line matching `compilation-enter-directory-regexp'\) is assumed.
254 The default value matches lines printed by the `-w' option of GNU Make.")
256 (defvar compilation-directory-stack nil
257 "Stack of previous directories for `compilation-leave-directory-regexp'.
258 The head element is the directory the compilation was started in.")
260 (defvar compilation-exit-message-function nil "\
261 If non-nil, called when a compilation process dies to return a status message.
262 This 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
264 strings to write into the compilation buffer, and to put in its mode line.")
266 ;; History of compile commands.
267 (defvar compile-history nil)
268 ;; History of grep commands.
269 (defvar grep-history nil)
271 (defvar compilation-mode-font-lock-keywords
272 ;; This regexp needs a bit of rewriting. What is the third grouping for?
273 '(("^\\([^ \n:]*:\\([0-9]+:\\)+\\)\\(.*\\)$" 1 font-lock-function-name-face))
274 ;;; ("^\\([^\n:]*:\\([0-9]+:\\)+\\)\\(.*\\)$" 0 font-lock-keyword-face keep)
275 "Additional expressions to highlight in Compilation mode.")
277 ;;;###autoload
278 (defun compile (command)
279 "Compile the program including the current buffer. Default: run `make'.
280 Runs COMMAND, a shell command, in a separate process asynchronously
281 with output going to the buffer `*compilation*'.
283 You can then use the command \\[next-error] to find the next error message
284 and move to the source code that caused it.
286 Interactively, prompts for the command if `compilation-read-command' is
287 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
289 To run more than one compilation at once, start one and rename the
290 \`*compilation*' buffer to some other name with \\[rename-buffer].
291 Then start the next one.
293 The name used for the buffer is actually whatever is returned by
294 the function in `compilation-buffer-name-function', so you can set that
295 to a function that generates a unique name."
296 (interactive
297 (if (or compilation-read-command current-prefix-arg)
298 (list (read-from-minibuffer "Compile command: "
299 compile-command nil nil
300 '(compile-history . 1)))
301 (list compile-command)))
302 (setq compile-command command)
303 (save-some-buffers (not compilation-ask-about-save) nil)
304 (compile-internal compile-command "No more errors"))
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"))
313 ;; The system null device. (Should reference NULL_DEVICE from C.)
314 (defvar grep-null-device "/dev/null" "The system null device.")
316 ;;;###autoload
317 (defun grep (command-args)
318 "Run grep, with user-specified args, and collect output in a buffer.
319 While grep runs asynchronously, you can use the \\[next-error] command
320 to find the text that grep hits refer to.
322 This command uses a special history list for its arguments, so you can
323 easily repeat a grep command."
324 (interactive
325 (list (read-from-minibuffer "Run grep (like this): "
326 grep-command nil nil 'grep-history)))
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"))
342 (cons msg code)))
343 (cons msg code))))))))
345 (defun compile-internal (command error-message
346 &optional name-of-mode parser regexp-alist
347 name-function)
348 "Run compilation command COMMAND (low level interface).
349 ERROR-MESSAGE is a string to print if the user asks to see another error
350 and there are no more errors. Third argument NAME-OF-MODE is the name
351 to display as the major mode in the compilation buffer.
353 Fourth arg PARSER is the error parser function (nil means the default). Fifth
354 arg REGEXP-ALIST is the error message regexp alist to use (nil means the
355 default). Sixth arg NAME-FUNCTION is a function called to name the buffer (nil
356 means the default). The defaults for these variables are the global values of
357 \`compilation-parse-errors-function', `compilation-error-regexp-alist', and
358 \`compilation-buffer-name-function', respectively.
360 Returns the compilation buffer created."
361 (let (outbuf)
362 (save-excursion
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
376 (format "A %s process is running; kill it? "
377 name-of-mode)))
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))
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)
400 (buffer-disable-undo (current-buffer))
401 (erase-buffer)
402 (buffer-enable-undo (current-buffer))
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))
412 (save-excursion
413 (set-buffer outbuf)
414 (compilation-mode)
415 ;; (setq buffer-read-only t) ;;; Non-ergonomic.
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)))
425 (compilation-set-window-height outwin)
426 ;; Start the compilation.
427 (if (fboundp 'start-process)
428 (let* ((process-environment (cons "EMACS=t" process-environment))
429 (proc (start-process-shell-command (downcase mode-name)
430 outbuf
431 command)))
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))
439 (sit-for 0) ;; Force redisplay
440 (let ((status (call-process shell-file-name nil outbuf nil "-c"
441 command))))
442 (message (format "Executing `%s'...done" command)))))
443 ;; Make it so the next C-x ` will use this buffer.
444 (setq compilation-last-buffer outbuf)))
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))))
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))))))
464 (defvar compilation-minor-mode-map
465 (let ((map (make-sparse-keymap)))
466 (define-key map [mouse-2] 'compile-mouse-goto-error)
467 (define-key map "\C-c\C-c" 'compile-goto-error)
468 (define-key map "\C-m" 'compile-goto-error)
469 (define-key map "\C-c\C-k" 'kill-compilation)
470 (define-key map "\M-n" 'compilation-next-error)
471 (define-key map "\M-p" 'compilation-previous-error)
472 (define-key map "\M-{" 'compilation-previous-file)
473 (define-key map "\M-}" 'compilation-next-file)
474 map)
475 "Keymap for `compilation-minor-mode'.")
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)
481 ;; Set up the menu-bar
482 (define-key map [menu-bar compilation-menu]
483 (cons "Compile" (make-sparse-keymap "Compile")))
485 (define-key map [menu-bar compilation-menu compilation-mode-kill-compilation]
486 '("Stop Compilation" . kill-compilation))
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]
490 '("First Error" . first-error))
491 (define-key map [menu-bar compilation-menu compilation-mode-previous-error]
492 '("Previous Error" . previous-error))
493 (define-key map [menu-bar compilation-menu compilation-mode-next-error]
494 '("Next Error" . next-error))
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))
503 map)
504 "Keymap for compilation log buffers.
505 `compilation-minor-mode-map' is a cdr of this.")
507 (defun compilation-mode ()
508 "Major mode for compilation log buffers.
509 \\<compilation-mode-map>To visit the source for a line-numbered error,
510 move point to the error message line and type \\[compile-goto-error].
511 To kill the compilation, type \\[kill-compilation].
513 Runs `compilation-mode-hook' with `run-hooks' (which see)."
514 (interactive)
515 (kill-all-local-variables)
516 (use-local-map compilation-mode-map)
517 (setq major-mode 'compilation-mode
518 mode-name "Compilation")
519 (compilation-setup)
520 (set (make-local-variable 'font-lock-defaults)
521 '(compilation-mode-font-lock-keywords t))
522 (run-hooks 'compilation-mode-hook))
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.
527 (setq mode-line-process '(":%s"))
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)
532 (setq compilation-last-buffer (current-buffer)))
534 (defvar compilation-minor-mode nil
535 "Non-nil when in compilation-minor-mode.
536 In this minor mode, all the error-parsing commands of the
537 Compilation major mode are available.")
538 (make-variable-buffer-local 'compilation-minor-mode)
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)
544 (setq minor-mode-map-alist (cons (cons 'compilation-minor-mode
545 compilation-minor-mode-map)
546 minor-mode-map-alist)))
548 ;;;###autoload
549 (defun compilation-minor-mode (&optional arg)
550 "Toggle compilation minor mode.
551 With arg, turn compilation mode on if and only if arg is positive.
552 See `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)))
559 ;; Called when compilation process changes state.
560 (defun compilation-sentinel (proc msg)
561 "Sentinel for compilation buffers."
562 (let ((buffer (process-buffer proc)))
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))
569 omax opoint)
570 ;; save-excursion isn't the right thing if
571 ;; process-buffer is current-buffer
572 (unwind-protect
573 (progn
574 ;; Write something in the compilation buffer
575 ;; and hack its mode line.
576 (set-buffer buffer)
577 (let ((buffer-read-only nil)
578 (status (if compilation-exit-message-function
579 (funcall compilation-exit-message-function
580 proc msg)
581 (cons msg (process-exit-status proc)))))
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.
587 (insert ?\n mode-name " " (car status))
588 (forward-char -1)
589 (insert " at " (substring (current-time-string) 0 19))
590 (forward-char 1)
591 (setq mode-line-process
592 (format ":%s [%s]"
593 (process-status proc) (cdr status)))
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.
599 (force-mode-line-update))
600 (if (and opoint (< opoint omax))
601 (goto-char opoint))
602 (if compilation-finish-function
603 (funcall compilation-finish-function buffer msg)))
604 (set-buffer obuf))))
605 (setq compilation-in-progress (delq proc compilation-in-progress))
606 ))))
608 (defun compilation-filter (proc string)
609 "Process filter for compilation buffers.
610 Just inserts the text, but uses `insert-before-markers'."
611 (if (buffer-name (process-buffer proc))
612 (save-excursion
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)))))))
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))
629 (defsubst compilation-buffer-p (buffer)
630 (save-excursion
631 (set-buffer buffer)
632 (or compilation-minor-mode (eq major-mode 'compilation-mode))))
634 (defun compilation-next-error (n)
635 "Move point to the next error in the compilation buffer.
636 Does 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))
642 (let ((errors (compile-error-at-point)))
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"))))))))
661 (defun compilation-previous-error (n)
662 "Move point to the previous error in the compilation buffer.
663 Does NOT find the source line like \\[next-error]."
664 (interactive "p")
665 (compilation-next-error (- n)))
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)
672 (setq data (cdr data))
673 (if (markerp data)
674 (marker-buffer data)
675 (car data)))
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)))
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))
692 (let ((reversed (< n 0))
693 errors filedata)
695 (if (not reversed)
696 (setq errors (or (compile-error-at-point)
697 (error "Moved past last error")))
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))
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))))
710 (while (> n 0)
711 (setq filedata (compilation-error-filedata (car errors)))
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))))))
728 (setq errors (cdr errors)))
730 (setq n (1- n)))
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))))))))
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)))
747 (defun kill-compilation ()
748 "Kill the process made by the \\[compile] command."
749 (interactive)
750 (let ((buffer (compilation-find-buffer)))
751 (if (get-buffer-process buffer)
752 (interrupt-process (get-buffer-process buffer))
753 (error "The compilation process is not running."))))
756 ;; Parse any new errors in the compilation buffer,
757 ;; or reparse from the beginning if the user has asked for that.
758 (defun compile-reinitialize-errors (reparse
759 &optional limit-search find-at-least)
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)
765 reparse)
766 (compilation-forget-errors))
767 (if (and compilation-error-list
768 (or (not limit-search)
769 (> compilation-parsing-end limit-search))
770 (or (not find-at-least)
771 (>= (length compilation-error-list) find-at-least)))
772 ;; Since compilation-error-list is non-nil, it points to a specific
773 ;; error the user wanted. So don't move it around.
775 ;; This was here for a long time (before my rewrite); why? --roland
776 ;;(switch-to-buffer compilation-last-buffer)
777 (set-buffer-modified-p nil)
778 (if (< compilation-parsing-end (point-max))
779 ;; compilation-error-list might be non-nil if we have a non-nil
780 ;; LIMIT-SEARCH or FIND-AT-LEAST arg. In that case its value
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))
784 (funcall compilation-parse-errors-function
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))
801 )))))
803 (defun compile-mouse-goto-error (event)
804 (interactive "e")
805 (save-excursion
806 (set-buffer (window-buffer (posn-window (event-end event))))
807 (goto-char (posn-point (event-end event)))
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))
814 ;; Move to bol; the marker for the error on this line will point there.
815 (beginning-of-line)
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)))
835 (push-mark)
836 (next-error 1))
838 (defun compile-goto-error (&optional argp)
839 "Visit the source for the error message point is on.
840 Use this command in a compilation log buffer. Sets the mark at point there.
841 \\[universal-argument] as a prefix arg means to reparse the buffer's error messages first;
842 other kinds of prefix arguments are ignored."
843 (interactive "P")
844 (or (compilation-buffer-p (current-buffer))
845 (error "Not in a compilation buffer."))
846 (setq compilation-last-buffer (current-buffer))
847 (compile-reinitialize-errors (consp argp) (point))
849 ;; Move to bol; the marker for the error on this line will point there.
850 (beginning-of-line)
852 ;; Move compilation-error-list to the elt of compilation-old-error-list
853 ;; we want.
854 (setq compilation-error-list compilation-old-error-list)
855 (while (and compilation-error-list
856 (> (point) (car (car compilation-error-list))))
857 (setq compilation-error-list (cdr compilation-error-list)))
859 ;; Move to another window, so that next-error's window changes
860 ;; result in the desired setup.
861 (or (one-window-p)
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)))
868 (push-mark)
869 (next-error 1))
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.
876 (defun compilation-find-buffer (&optional other-buffer)
877 (if (and (not other-buffer)
878 (compilation-buffer-p (current-buffer)))
879 ;; The current buffer is a compilation buffer.
880 (current-buffer)
881 (if (and compilation-last-buffer (buffer-name compilation-last-buffer)
882 (or (not other-buffer) (not (eq compilation-last-buffer
883 (current-buffer)))))
884 compilation-last-buffer
885 (let ((buffers (buffer-list)))
886 (while (and buffers (or (not (compilation-buffer-p (car buffers)))
887 (and other-buffer
888 (eq (car buffers) (current-buffer)))))
889 (setq buffers (cdr buffers)))
890 (if buffers
891 (car buffers)
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!")))))))
901 ;;;###autoload
902 (defun next-error (&optional argp)
903 "Visit next compilation error message and corresponding source code.
904 This operates on the output from the \\[compile] command.
905 If all preparsed error messages have been processed,
906 the error message buffer is checked for new ones.
908 A prefix arg specifies how many error messages to move;
909 negative means move back to previous error messages.
910 Just C-u as a prefix means reparse the error message buffer
911 and start at the first error.
913 \\[next-error] normally applies to the most recent compilation started,
914 but as long as you are in the middle of parsing errors from one compilation
915 output buffer, you stay with that compilation output buffer.
917 Use \\[next-error] in a compilation output buffer to switch to
918 processing errors from that compilation.
920 See variables `compilation-parse-errors-function' and
921 \`compilation-error-regexp-alist' for customization ideas."
922 (interactive "P")
923 (setq compilation-last-buffer (compilation-find-buffer))
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)
932 (defun previous-error ()
933 "Visit previous compilation error message and corresponding source code.
934 This operates on the output from the \\[compile] command."
935 (interactive)
936 (next-error -1))
938 (defun first-error ()
939 "Reparse the error message buffer and start at the first error
940 Visit corresponding source code.
941 This operates on the output from the \\[compile] command."
942 (interactive)
943 (next-error '(4)))
945 (defun compilation-next-error-locus (&optional move reparse silent)
946 "Visit next compilation error and return locus in corresponding source code.
947 This operates on the output from the \\[compile] command.
948 If all preparsed error messages have been processed,
949 the error message buffer is checked for new ones.
951 Returns a cons (ERROR . SOURCE) of two markers: ERROR is a marker at the
952 location of the error message in the compilation buffer, and SOURCE is a
953 marker at the location in the source code indicated by the error message.
955 Optional first arg MOVE says how many error messages to move forwards (or
956 backwards, if negative); default is 1. Optional second arg REPARSE, if
957 non-nil, says to reparse the error message buffer and reset to the first
958 error (plus MOVE - 1). If optional third argument SILENT is non-nil, return
959 nil instead of raising an error if there are no more errors.
961 The 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))))
965 (let (next-errors next-error)
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)
1008 " yet")))))
1009 (setq compilation-error-list (cdr next-errors))
1010 (if (null (cdr next-error))
1011 ;; This error is boring. Go to the next.
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)))
1017 (buffer (apply 'compilation-find-file
1018 (car next-error) fileinfo)))
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.
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)
1046 (if (and column (> column 0))
1047 ;; Columns in error msgs are 1-origin.
1048 (move-to-column (1- column))
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))
1071 (if (and column (> column 1))
1072 (move-to-column (1- column))
1073 (beginning-of-line))
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
1082 next-error (car next-errors)))))
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)))
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))
1094 (defun compilation-goto-locus (next-error)
1095 "Jump to an error locus returned by `compilation-next-error-locus'.
1096 Takes one argument, a cons (ERROR . SOURCE) of two markers.
1097 Selects a window with point at SOURCE, with another window displaying ERROR."
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))))
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))))
1110 ;; Show compilation buffer in other window, scrolled to this error.
1111 (let* ((pop-up-windows t)
1112 ;; Use an existing window if it is in a visible frame.
1113 (w (or (get-buffer-window (marker-buffer (car next-error)) 'visible)
1114 ;; Pop up a window.
1115 (display-buffer (marker-buffer (car next-error))))))
1116 (set-window-point w (car next-error))
1117 (set-window-start w (car next-error))
1118 (compilation-set-window-height w)))
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.
1126 (defun compilation-find-file (marker filename dir &rest formats)
1127 (or formats (setq formats '("%s")))
1128 (let ((dirs compilation-search-path)
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))
1138 (setq thisdir (or (car dirs) dir)
1139 fmts formats)
1140 ;; For each directory, try each format string.
1141 (while (and fmts (null buffer))
1142 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1143 buffer (and (file-exists-p name)
1144 (find-file-noselect name))
1145 fmts (cdr fmts)))
1146 (setq dirs (cdr dirs)))
1147 (or buffer
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.
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)))))))
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
1169 ;; do it right away.
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)
1174 (if (markerp (cdr next-error))
1175 (set-marker (cdr next-error) nil)))
1176 (setq compilation-old-error-list (cdr compilation-old-error-list)))
1177 (setq compilation-error-list nil
1178 compilation-directory-stack nil
1179 compilation-parsing-end 1))
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)
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))
1207 (defun compilation-parse-errors (limit-search find-at-least)
1208 "Parse the current buffer as grep, cc or lint error messages.
1209 See variable `compilation-parse-errors-function' for the interface it uses."
1210 (setq compilation-error-list nil)
1211 (message "Parsing error messages...")
1212 (let (text-buffer orig orig-expanded parent-expanded
1213 regexp enter-group leave-group error-group
1214 alist subexpr error-regexp-groups
1215 (found-desired nil)
1216 (compilation-num-errors-found 0))
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)
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)))
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 "\\|") "\\)"))
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)
1248 error-group (+ leave-group
1249 (count-regexp-groupings
1250 compilation-leave-directory-regexp)
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).
1257 (setq alist (or compilation-error-regexp-alist
1258 (error "compilation-error-regexp-alist is empty!"))
1259 subexpr (1+ error-group))
1260 (while alist
1261 (setq error-regexp-groups
1262 (cons (list subexpr
1263 (+ subexpr (nth 1 (car alist)))
1264 (+ subexpr (nth 2 (car alist)))
1265 (and (nth 3 (car alist))
1266 (+ subexpr (nth 3 (car alist)))))
1267 error-regexp-groups))
1268 (setq subexpr (+ subexpr 1 (count-regexp-groupings (car (car alist)))))
1269 (setq alist (cdr alist)))
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)))
1280 (while (and (not found-desired)
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.
1284 (re-search-forward regexp nil t))
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)))))))
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))
1300 (setq compilation-directory-stack
1301 (cons dir compilation-directory-stack))
1302 (and (file-directory-p dir)
1303 (setq default-directory dir)))
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)))
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)))))))
1325 ;; The directory name in the "leaving" message
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))
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))
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)))
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))
1358 (error "compilation-parse-errors: impossible regexp match!"))
1360 ;; Extract the file name and line number from the error message.
1361 (let ((beginning-of-match (match-beginning 0)) ;looking-at nukes
1362 (filename (buffer-substring (match-beginning (nth 1 alist))
1363 (match-end (nth 1 alist))))
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)
1369 (match-beginning (nth 3 alist))
1370 (string-to-int
1371 (buffer-substring
1372 (match-beginning (nth 3 alist))
1373 (match-end (nth 3 alist)))))))
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)))
1384 (setq filename (cons filename (cons default-directory
1385 (nthcdr 4 alist))))
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
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))
1398 (let ((this (cons (point-marker)
1399 (list filename linenum column))))
1400 ;; Don't add the same source line more than once.
1401 (if (equal (cdr this) (cdr (car compilation-error-list)))
1403 (setq compilation-error-list
1404 (cons this
1405 compilation-error-list))
1406 (setq compilation-num-errors-found
1407 (1+ compilation-num-errors-found)))))
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.
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)))
1433 (error "compilation-parse-errors: known groups didn't match!")))
1435 (message "Parsing error messages...%d (%.0f%% of buffer)"
1436 compilation-num-errors-found
1437 ;; Use floating-point because (* 100 (point)) frequently
1438 ;; exceeds the range of Emacs Lisp integers.
1439 (/ (* 100.0 (point)) (point-max)))
1441 (and limit-search (>= (point) limit-search)
1442 ;; The user wanted a specific error, and we're past it.
1443 (setq found-desired t)))
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"))
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)
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))
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)))
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)
1483 (provide 'compile)
1485 ;;; compile.el ends here