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