1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages.
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 1997 Free Software Foundation, Inc.
5 ;; Author: Roland McGrath <roland@prep.ai.mit.edu>
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)
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 the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; This package provides the compile and grep facilities documented in
29 ;; the Emacs user's manual.
33 (defgroup compilation nil
34 "Run compiler as inferior of Emacs, parse error messages."
40 (defcustom compilation-mode-hook nil
41 "*List of hook functions run by `compilation-mode' (see `run-hooks')."
46 (defcustom compilation-window-height nil
47 "*Number of lines in a compilation window. If nil, use Emacs default."
48 :type '(choice (const :tag "Default" nil)
52 (defvar compile-auto-highlight nil
53 "*Specify how many compiler errors to highlight (and parse) initially.
54 \(Highlighting applies to an error message when the mouse is over it.)
55 If this is a number N, all compiler error messages in the first N lines
56 are highlighted and parsed as soon as they arrive in Emacs.
57 If t, highlight and parse the whole compilation output as soon as it arrives.
58 If nil, don't highlight or parse any of the buffer until you try to
59 move to the error messages.
61 Those messages which are not parsed and highlighted initially
62 will be parsed and highlighted as soon as you try to move to them.")
64 (defvar compilation-error-list nil
65 "List of error message descriptors for visiting erring functions.
66 Each error descriptor is a cons (or nil). Its car is a marker pointing to
67 an error message. If its cdr is a marker, it points to the text of the
68 line the message is about. If its cdr is a cons, it is a list
69 \(\(DIRECTORY . FILE\) LINE [COLUMN]\). Or its cdr may be nil if that
70 error is not interesting.
72 The value may be t instead of a list; this means that the buffer of
73 error messages should be reparsed the next time the list of errors is wanted.
75 Some other commands (like `diff') use this list to control the error
76 message tracking facilities; if you change its structure, you should make
77 sure you also change those packages. Perhaps it is better not to change
80 (defvar compilation-old-error-list nil
81 "Value of `compilation-error-list' after errors were parsed.")
83 (defvar compilation-parse-errors-function 'compilation-parse-errors
84 "Function to call to parse error messages from a compilation.
85 It takes args LIMIT-SEARCH and FIND-AT-LEAST.
86 If LIMIT-SEARCH is non-nil, don't bother parsing past that location.
87 If FIND-AT-LEAST is non-nil, don't bother parsing after finding that
89 It should read in the source files which have errors and set
90 `compilation-error-list' to a list with an element for each error message
91 found. See that variable for more info.")
94 (defvar compilation-process-setup-function nil
95 "*Function to call to customize the compilation process.
96 This functions is called immediately before the compilation process is
97 started. It can be used to set any variables or functions that are used
98 while processing the output of the compilation process.")
101 (defvar compilation-buffer-name-function nil
102 "Function to compute the name of a compilation buffer.
103 The function receives one argument, the name of the major mode of the
104 compilation buffer. It should return a string.
105 nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
108 (defvar compilation-finish-function nil
109 "Function to call when a compilation process finishes.
110 It is called with two arguments: the compilation buffer, and a string
111 describing how the process finished.")
114 (defvar compilation-finish-functions nil
115 "Functions to call when a compilation process finishes.
116 Each function is called with two arguments: the compilation buffer,
117 and a string describing how the process finished.")
119 (defvar compilation-last-buffer nil
120 "The most recent compilation buffer.
121 A buffer becomes most recent when its compilation is started
122 or when it is used with \\[next-error] or \\[compile-goto-error].")
124 (defvar compilation-in-progress nil
125 "List of compilation processes now running.")
126 (or (assq 'compilation-in-progress minor-mode-alist)
127 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
130 (defvar compilation-parsing-end nil
131 "Position of end of buffer when last error messages were parsed.")
133 (defvar compilation-error-message "No more errors"
134 "Message to print when no more matches are found.")
136 (defvar compilation-arguments nil
137 "Arguments that were given to `compile-internal'.")
139 (defvar compilation-num-errors-found)
141 (defvar compilation-error-regexp-alist
143 ;; NOTE! See also grep-regexp-alist, below.
145 ;; 4.3BSD grep, cc, lint pass 1:
146 ;; /usr/src/foo/foo.c(8): warning: w may be used before set
148 ;; foo.c:8: error message
150 ;; foo.f :16 some horrible error message
151 ;; or GNU utilities with column (GNAT 1.82):
152 ;; foo.adb:2:1: Unit name does not match file name
154 ;; We'll insist that the number be followed by a colon or closing
155 ;; paren, because otherwise this matches just about anything
156 ;; containing a number with spaces around it.
157 ("\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\)\\([) \t]\\|\
158 :\\([^0-9\n]\\|\\([0-9]+:\\)\\)\\)" 1 2 5)
161 ;; keyboard.c(537) : warning C4005: 'min' : macro redefinition
162 ;; d:\tmp\test.c(23) : error C2143: syntax error : missing ';' before 'if'
163 ("\\(\\([a-zA-Z]:\\)?[^:( \t\n-]+\\)[:(][ \t]*\\([0-9]+\\)[:) \t]" 1 3)
166 ;; Error ping.c 15: Unable to open include file 'sys/types.h'
167 ;; Warning ping.c 68: Call to function 'func' with no prototype
168 ("\\(Error\\|Warning\\) \\([a-zA-Z]?:?[^:( \t\n]+\\)\
169 \\([0-9]+\\)\\([) \t]\\|:[^0-9\n]\\)" 2 3)
171 ;; 4.3BSD lint pass 2
172 ;; strcmp: variable # of args. llib-lc(359) :: /usr/src/foo/foo.c(8)
173 (".*[ \t:]\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(](+[ \t]*\\([0-9]+\\))[:) \t]*$"
176 ;; 4.3BSD lint pass 3
177 ;; bloofle defined( /users/wolfgang/foo.c(4) ), but never used
179 ;; ("[ \t(]+\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]+" 1 2)
180 ;; which is regexp Impressionism - it matches almost anything!
181 (".*([ \t]*\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\))" 1 2)
183 ;; MIPS lint pass<n>; looks good for SunPro lint also
184 ;; TrimMask (255) in solomon.c may be indistinguishable from TrimMasks (93) in solomon.c due to truncation
185 ("[^\n ]+ (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
186 ;; name defined but never used: LinInt in cmap_calc.c(199)
187 (".*in \\([^(\n]+\\)(\\([0-9]+\\))$" 1 2)
190 ;; fort: Severe: addstf.f, line 82: Missing operator or delimiter symbol
191 ;; Some SGI cc version:
192 ;; cfe: Warning 835: foo.c, line 2: something
193 ("\\(cfe\\|fort\\): [^:\n]*: \\([^ \n]*\\), line \\([0-9]+\\):" 2 3)
194 ;; Error on line 3 of t.f: Execution error unclassifiable statement
195 ;; Unknown who does this:
196 ;; Line 45 of "foo.c": bloofle undefined
197 ;; Absoft FORTRAN 77 Compiler 3.1.3
198 ;; error on line 19 of fplot.f: spelling error?
199 ;; warning on line 17 of fplot.f: data type is undefined for variable d
200 ("\\(.* on \\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
201 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2)
203 ;; Apollo cc, 4.3BSD fc:
204 ;; "foo.f", line 3: Error: syntax error near end of statement
206 ;; "vvouch.c", line 19.5: 1506-046 (S) Syntax error.
208 ;; File "foobar.ml", lines 5-8, characters 20-155: blah blah
210 ;; "foo.c", line 32 pos 1; (E) syntax error; unexpected symbol: "lossage"
211 ;; GNAT (as of July 94):
212 ;; "foo.adb", line 2(11): warning: file name does not match ...
213 ;; IBM AIX xlc compiler:
214 ;; "src/swapping.c", line 30.34: 1506-342 (W) "/*" detected in comment.
215 (".*\"\\([^,\" \n\t]+\\)\", lines? \
216 \\([0-9]+\\)\\([\(.]\\([0-9]+\\)\)?\\)?[:., (-]" 1 2 4)
218 ;; MIPS RISC CC - the one distributed with Ultrix:
219 ;; ccom: Error: foo.c, line 2: syntax error
221 ;; /usr/lib/cmplrs/cc/cfe: Error: foo.c: 1: blah blah
222 (".*rror: \\([^,\" \n\t]+\\)[,:] \\(line \\)?\\([0-9]+\\):" 1 3)
224 ;; IBM AIX PS/2 C version 1.1:
225 ;; ****** Error number 140 in line 8 of file errors.c ******
226 (".*in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
227 ;; IBM AIX lint is too painful to do right this way. File name
228 ;; prefixes entire sections rather than being on each line.
230 ;; SPARCcompiler Pascal:
231 ;; 20 linjer : array[1..4] of linje;
232 ;; e 18480-----------^--- Inserted ';'
234 ;; E 18520 line 61 - 0 is undefined
235 ;; These messages don't contain a file name. Instead the compiler gives
236 ;; a message whenever the file being compiled is changed.
237 (" +\\([0-9]+\\) +.*\n[ew] [0-9]+-+" nil 1)
238 ("[Ew] +[0-9]+ line \\([0-9]+\\) - " nil 1)
240 ;; Lucid Compiler, lcc 3.x
241 ;; E, file.cc(35,52) Illegal operation on pointers
242 ("[EW], \\([^(\n]*\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)" 1 2 3)
244 ;; GNU messages with program name and optional column number.
245 ("[a-zA-Z]?:?[^0-9 \n\t:]+[^ \n\t:]*:[ \t]*\\([^ \n\t:]+\\):\
246 \\([0-9]+\\):\\(\\([0-9]+\\)[: \t]\\)?" 1 2 4)
248 ;; Cray C compiler error messages
249 ("\\(cc\\| cft\\)-[0-9]+ c\\(c\\|f77\\): ERROR \\([^,\n]+, \\)* File = \
250 \\([^,\n]+\\), Line = \\([0-9]+\\)" 4 5)
252 ;; IBM C/C++ Tools 2.01:
253 ;; foo.c(2:0) : informational EDC0804: Function foo is not referenced.
254 ;; foo.c(3:8) : warning EDC0833: Implicit return statement encountered.
255 ;; foo.c(5:5) : error EDC0350: Syntax error.
256 ("\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) : " 1 2 3)
258 ;; Sun ada (VADS, Solaris):
259 ;; /home3/xdhar/rcds_rc/main.a, line 361, char 6:syntax error: "," inserted
260 ("\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
263 ;; syntax error at automake line 922, near "':'"
264 (".* at \\([^ ]+\\) line \\([0-9]+\\)," 1 2)
267 ;; Semantic error at line 528, column 5, file erosacqdb.pc:
268 ("Semantic error at line \\([0-9]+\\), column \\([0-9]+\\), file \\(.*\\):"
271 "Alist that specifies how to match errors in compiler output.
272 Each elt has the form (REGEXP FILE-IDX LINE-IDX [COLUMN-IDX FILE-FORMAT...])
273 If REGEXP matches, the FILE-IDX'th subexpression gives the file name, and
274 the LINE-IDX'th subexpression gives the line number. If COLUMN-IDX is
275 given, the COLUMN-IDX'th subexpression gives the column number on that line.
276 If any FILE-FORMAT is given, each is a format string to produce a file name to
277 try; %s in the string is replaced by the text matching the FILE-IDX'th
280 (defvar compilation-enter-directory-regexp-alist
282 ;; Matches lines printed by the `-w' option of GNU Make.
283 (".*: Entering directory `\\(.*\\)'$" 1)
285 "Alist specifying how to match lines that indicate a new current directory.
286 Note that the match is done at the beginning of lines.
287 Each elt has the form (REGEXP IDX).
288 If REGEXP matches, the IDX'th subexpression gives the directory name.
290 The default value matches lines printed by the `-w' option of GNU Make.")
292 (defvar compilation-leave-directory-regexp-alist
294 ;; Matches lines printed by the `-w' option of GNU Make.
295 (".*: Leaving directory `\\(.*\\)'$" 1)
297 "Alist specifying how to match lines that indicate restoring current directory.
298 Note that the match is done at the beginning of lines.
299 Each elt has the form (REGEXP IDX).
300 If REGEXP matches, the IDX'th subexpression gives the name of the directory
301 being moved from. If IDX is nil, the last directory entered \(by a line
302 matching `compilation-enter-directory-regexp-alist'\) is assumed.
304 The default value matches lines printed by the `-w' option of GNU Make.")
306 (defvar compilation-file-regexp-alist
308 ;; This matches entries with date time year file-name: like
309 ;; Thu May 14 10:46:12 1992 mom3.p:
310 ("\\w\\w\\w \\w\\w\\w +[0-9]+ [0-9][0-9]:[0-9][0-9]:[0-9][0-9] [0-9][0-9][0-9][0-9] \\(.*\\):$" 1)
312 "Alist specifying how to match lines that indicate a new current file.
313 Note that the match is done at the beginning of lines.
314 Each elt has the form (REGEXP IDX).
315 If REGEXP matches, the IDX'th subexpression gives the file name. This is
316 used with compilers that don't indicate file name in every error message.")
318 ;; There is no generally useful regexp that will match non messages, but
319 ;; in special cases there might be one. The lines that are not matched by
320 ;; a regexp take much longer time than the ones that are recognized so if
321 ;; you have same regexeps here, parsing is faster.
322 (defvar compilation-nomessage-regexp-alist
325 "Alist specifying how to match lines that have no message.
326 Note that the match is done at the beginning of lines.
327 Each elt has the form (REGEXP). This alist is by default empty, but if
328 you have some good regexps here, the parsing of messages will be faster.")
330 (defcustom compilation-read-command t
331 "*If not nil, M-x compile reads the compilation command to use.
332 Otherwise, M-x compile just uses the value of `compile-command'."
336 (defcustom compilation-ask-about-save t
337 "*If not nil, M-x compile asks which buffers to save before compiling.
338 Otherwise, it saves all modified buffers without asking."
342 (defvar grep-regexp-alist
343 '(("\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]" 1 2))
344 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
346 ;; The system null device. (Should reference NULL_DEVICE from C.)
347 (defvar grep-null-device "/dev/null" "The system null device.")
350 ;; Currently zgrep has trouble. It runs egrep instead of grep,
351 ;; and it doesn't pass along long options right.
353 ;;; (if (equal (condition-case nil ; in case "zgrep" isn't in exec-path
354 ;;; (call-process "zgrep" nil nil nil
355 ;;; "foo" grep-null-device)
360 "The default grep program for `grep-command' and `grep-find-command'.")
362 ;; Use -e if grep supports it,
363 ;; because that avoids lossage if the pattern starts with `-'.
365 (if (equal (condition-case nil ; in case "grep" isn't in exec-path
366 (call-process grep-program nil nil nil
367 "-e" "foo" grep-null-device)
370 (format "%s -n -e " grep-program)
371 (format "%s -n " grep-program))
372 "The default grep command for \\[grep].")
374 (defvar grep-find-use-xargs
375 (if (equal (call-process "find" nil nil nil
376 grep-null-device "-print0")
379 "Whether \\[grep-find] uses the `xargs' utility by default.
381 If nil, it uses `grep -exec'; if `gnu', it uses `find -print0' and `xargs -0';
382 if not nil and not `gnu', it uses `find -print' and `xargs'.
384 This variable's value takes effect when `compile.el' is loaded
385 by influencing the default value for the variable `grep-find-command'.")
387 (defvar grep-find-command
388 (cond ((eq grep-find-use-xargs 'gnu)
389 (format "find . -type f -print0 | xargs -0 -e %s" grep-command))
391 (format "find . -type f -print | xargs %s" grep-command))
392 (t (cons (format "find . -type f -exec %s {} /dev/null \\;"
394 (+ 22 (length grep-command)))))
395 "The default find command for \\[grep-find].")
398 (defcustom compilation-search-path '(nil)
399 "*List of directories to search for source files named in error messages.
400 Elements should be directory names, not file names of directories.
401 nil as an element means to try the default directory."
402 :type '(repeat (choice (const :tag "Default" nil)
403 (string :tag "Directory")))
406 (defcustom compile-command "make -k "
407 "*Last shell command used to do a compilation; default for next compilation.
409 Sometimes it is useful for files to supply local values for this variable.
410 You might also use mode hooks to specify it in certain modes, like this:
413 '(lambda () (or (file-exists-p \"makefile\") (file-exists-p \"Makefile\")
414 (progn (make-local-variable 'compile-command)
415 (setq compile-command
417 buffer-file-name))))))"
421 (defvar compilation-directory-stack nil
422 "Stack of previous directories for `compilation-leave-directory-regexp'.
423 The head element is the directory the compilation was started in.")
425 (defvar compilation-exit-message-function nil "\
426 If non-nil, called when a compilation process dies to return a status message.
427 This should be a function of three arguments: process status, exit status,
428 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
429 write into the compilation buffer, and to put in its mode line.")
431 ;; History of compile commands.
432 (defvar compile-history nil)
433 ;; History of grep commands.
434 (defvar grep-history nil)
435 (defvar grep-find-history nil)
437 (defun compilation-mode-font-lock-keywords ()
438 "Return expressions to highlight in Compilation mode."
441 ;; Compiler warning/error lines.
442 (mapcar #'(lambda (item)
444 (list (nth 1 item) 'font-lock-warning-face nil t)
445 (list (nth 2 item) 'font-lock-variable-name-face nil t)))
446 compilation-error-regexp-alist)
449 ;; Compiler output lines. Recognize `make[n]:' lines too.
450 '("^\\([A-Za-z_0-9/\.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
451 (1 font-lock-function-name-face) (3 font-lock-comment-face nil t)))
455 (defun compile (command)
456 "Compile the program including the current buffer. Default: run `make'.
457 Runs COMMAND, a shell command, in a separate process asynchronously
458 with output going to the buffer `*compilation*'.
460 You can then use the command \\[next-error] to find the next error message
461 and move to the source code that caused it.
463 Interactively, prompts for the command if `compilation-read-command' is
464 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
466 To run more than one compilation at once, start one and rename the
467 \`*compilation*' buffer to some other name with \\[rename-buffer].
468 Then start the next one.
470 The name used for the buffer is actually whatever is returned by
471 the function in `compilation-buffer-name-function', so you can set that
472 to a function that generates a unique name."
474 (if (or compilation-read-command current-prefix-arg)
475 (list (read-from-minibuffer "Compile command: "
476 compile-command nil nil
477 '(compile-history . 1)))
478 (list compile-command)))
479 (setq compile-command command)
480 (save-some-buffers (not compilation-ask-about-save) nil)
481 (compile-internal compile-command "No more errors"))
483 ;;; run compile with the default command line
485 "Re-compile the program including the current buffer."
487 (save-some-buffers (not compilation-ask-about-save) nil)
488 (compile-internal compile-command "No more errors"))
490 (defun grep-process-setup ()
491 "Set up `compilation-exit-message-function' for `grep'."
492 (set (make-local-variable 'compilation-exit-message-function)
493 (lambda (status code msg)
494 (if (eq status 'exit)
496 '("finished (matches found)\n" . "matched"))
498 '("finished with no matches found\n" . "no match"))
504 (defun grep (command-args)
505 "Run grep, with user-specified args, and collect output in a buffer.
506 While grep runs asynchronously, you can use the \\[next-error] command
507 to find the text that grep hits refer to.
509 This command uses a special history list for its arguments, so you can
510 easily repeat a grep command."
512 (list (read-from-minibuffer "Run grep (like this): "
513 grep-command nil nil 'grep-history)))
514 ;; Setting process-setup-function makes exit-message-function work
515 ;; even when async processes aren't supported.
516 (let* ((compilation-process-setup-function 'grep-process-setup)
517 (buf (compile-internal (if grep-null-device
518 (concat command-args " " grep-null-device)
520 "No more grep hits" "grep"
521 ;; Give it a simpler regexp to match.
522 nil grep-regexp-alist)))))
526 (defun grep-find (command-args)
527 "Run grep via find, with user-specified args, and collect output in a buffer.
528 While find runs asynchronously, you can use the \\[next-error] command
529 to find the text that grep hits refer to.
531 This command uses a special history list for its arguments, so you can
532 easily repeat a find command."
534 (list (read-from-minibuffer "Run find (like this): "
535 grep-find-command nil nil 'grep-find-history)))
536 (let ((grep-null-device nil)) ; see grep
537 (grep command-args)))
539 (defun compile-internal (command error-message
540 &optional name-of-mode parser
541 error-regexp-alist name-function
542 enter-regexp-alist leave-regexp-alist
543 file-regexp-alist nomessage-regexp-alist)
544 "Run compilation command COMMAND (low level interface).
545 ERROR-MESSAGE is a string to print if the user asks to see another error
546 and there are no more errors. The rest of the arguments, 3-10 are optional.
547 For them nil means use the default.
548 NAME-OF-MODE is the name to display as the major mode in the compilation
549 buffer. PARSER is the error parser function. ERROR-REGEXP-ALIST is the error
550 message regexp alist to use. NAME-FUNCTION is a function called to name the
551 buffer. ENTER-REGEXP-ALIST is the enter directory message regexp alist to use.
552 LEAVE-REGEXP-ALIST is the leave directory message regexp alist to use.
553 FILE-REGEXP-ALIST is the change current file message regexp alist to use.
554 NOMESSAGE-REGEXP-ALIST is the nomessage regexp alist to use.
555 The defaults for these variables are the global values of
556 \`compilation-parse-errors-function', `compilation-error-regexp-alist',
557 \`compilation-buffer-name-function', `compilation-enter-directory-regexp-alist',
558 \`compilation-leave-directory-regexp-alist', `compilation-file-regexp-alist',
559 \ and `compilation-nomessage-regexp-alist', respectively.
560 For arg 7-10 a value `t' means an empty alist.
562 Returns the compilation buffer created."
566 (setq name-of-mode "Compilation"))
569 (funcall (or name-function compilation-buffer-name-function
570 (function (lambda (mode)
571 (concat "*" (downcase mode) "*"))))
574 (let ((comp-proc (get-buffer-process (current-buffer))))
576 (if (or (not (eq (process-status comp-proc) 'run))
578 (format "A %s process is running; kill it? "
582 (interrupt-process comp-proc)
584 (delete-process comp-proc))
586 (error "Cannot have two processes in `%s' at once"
589 ;; In case the compilation buffer is current, make sure we get the global
590 ;; values of compilation-error-regexp-alist, etc.
591 (kill-all-local-variables))
592 (or error-regexp-alist
593 (setq error-regexp-alist compilation-error-regexp-alist))
594 (or enter-regexp-alist
595 (setq enter-regexp-alist compilation-enter-directory-regexp-alist))
596 (or leave-regexp-alist
597 (setq leave-regexp-alist compilation-leave-directory-regexp-alist))
598 (or file-regexp-alist
599 (setq file-regexp-alist compilation-file-regexp-alist))
600 (or nomessage-regexp-alist
601 (setq nomessage-regexp-alist compilation-nomessage-regexp-alist))
602 (or parser (setq parser compilation-parse-errors-function))
603 (let ((thisdir default-directory)
606 ;; Clear out the compilation buffer and make it writable.
607 ;; Change its default-directory to the directory where the compilation
608 ;; will happen, and insert a `cd' command to indicate this.
610 (setq buffer-read-only nil)
611 (buffer-disable-undo (current-buffer))
613 (buffer-enable-undo (current-buffer))
614 (setq default-directory thisdir)
615 (insert "cd " thisdir "\n" command "\n")
616 (set-buffer-modified-p nil))
617 ;; If we're already in the compilation buffer, go to the end
618 ;; of the buffer, so point will track the compilation output.
619 (if (eq outbuf (current-buffer))
620 (goto-char (point-max)))
621 ;; Pop up the compilation buffer.
622 (setq outwin (display-buffer outbuf))
626 ;; (setq buffer-read-only t) ;;; Non-ergonomic.
627 (set (make-local-variable 'compilation-parse-errors-function) parser)
628 (set (make-local-variable 'compilation-error-message) error-message)
629 (set (make-local-variable 'compilation-error-regexp-alist)
631 (set (make-local-variable 'compilation-enter-directory-regexp-alist)
633 (set (make-local-variable 'compilation-leave-directory-regexp-alist)
635 (set (make-local-variable 'compilation-file-regexp-alist)
637 (set (make-local-variable 'compilation-nomessage-regexp-alist)
638 nomessage-regexp-alist)
639 (set (make-local-variable 'compilation-arguments)
640 (list command error-message
642 error-regexp-alist name-function
643 enter-regexp-alist leave-regexp-alist
644 file-regexp-alist nomessage-regexp-alist))
645 (setq default-directory thisdir
646 compilation-directory-stack (list default-directory))
647 (set-window-start outwin (point-min))
648 (setq mode-name name-of-mode)
649 (or (eq outwin (selected-window))
650 (set-window-point outwin (point-min)))
651 (compilation-set-window-height outwin)
652 (if compilation-process-setup-function
653 (funcall compilation-process-setup-function))
654 ;; Start the compilation.
655 (if (fboundp 'start-process)
656 (let* ((process-environment (cons "EMACS=t" process-environment))
657 (proc (start-process-shell-command (downcase mode-name)
660 (set-process-sentinel proc 'compilation-sentinel)
661 (set-process-filter proc 'compilation-filter)
662 (set-marker (process-mark proc) (point) outbuf)
663 (setq compilation-in-progress
664 (cons proc compilation-in-progress)))
665 ;; No asynchronous processes available.
666 (message "Executing `%s'..." command)
667 ;; Fake modeline display as if `start-process' were run.
668 (setq mode-line-process ":run")
669 (force-mode-line-update)
670 (sit-for 0) ; Force redisplay
671 (let ((status (call-process shell-file-name nil outbuf nil "-c"
673 (cond ((numberp status)
674 (compilation-handle-exit 'exit status
678 exited abnormally with code %d\n"
681 (compilation-handle-exit 'signal status
682 (concat status "\n")))
684 (compilation-handle-exit 'bizarre status status))))
685 (message "Executing `%s'...done" command))))
686 ;; Make it so the next C-x ` will use this buffer.
687 (setq compilation-last-buffer outbuf)))
689 ;; Set the height of WINDOW according to compilation-window-height.
690 (defun compilation-set-window-height (window)
691 (and compilation-window-height
692 (= (window-width window) (frame-width (window-frame window)))
693 ;; If window is alone in its frame, aside from a minibuffer,
694 ;; don't change its height.
695 (not (eq window (frame-root-window (window-frame window))))
696 ;; This save-excursion prevents us from changing the current buffer,
697 ;; which might not be the same as the selected window's buffer.
699 (let ((w (selected-window)))
702 (select-window window)
703 (enlarge-window (- compilation-window-height
705 (select-window w))))))
707 (defvar compilation-minor-mode-map
708 (let ((map (make-sparse-keymap)))
709 (define-key map [mouse-2] 'compile-mouse-goto-error)
710 (define-key map "\C-c\C-c" 'compile-goto-error)
711 (define-key map "\C-m" 'compile-goto-error)
712 (define-key map "\C-c\C-k" 'kill-compilation)
713 (define-key map "\M-n" 'compilation-next-error)
714 (define-key map "\M-p" 'compilation-previous-error)
715 (define-key map "\M-{" 'compilation-previous-file)
716 (define-key map "\M-}" 'compilation-next-file)
718 "Keymap for `compilation-minor-mode'.")
720 (defvar compilation-shell-minor-mode-map
721 (let ((map (make-sparse-keymap)))
722 (define-key map [mouse-2] 'compile-mouse-goto-error)
723 (define-key map "\M-\C-m" 'compile-goto-error)
724 (define-key map "\M-\C-n" 'compilation-next-error)
725 (define-key map "\M-\C-p" 'compilation-previous-error)
726 (define-key map "\M-{" 'compilation-previous-file)
727 (define-key map "\M-}" 'compilation-next-file)
728 ;; Set up the menu-bar
729 (define-key map [menu-bar errors-menu]
730 (cons "Errors" (make-sparse-keymap "Errors")))
731 (define-key map [menu-bar errors-menu stop-subjob]
732 '("Stop" . comint-interrupt-subjob))
733 (define-key map [menu-bar errors-menu compilation-mode-separator2]
735 (define-key map [menu-bar errors-menu compilation-mode-first-error]
736 '("First Error" . first-error))
737 (define-key map [menu-bar errors-menu compilation-mode-previous-error]
738 '("Previous Error" . previous-error))
739 (define-key map [menu-bar errors-menu compilation-mode-next-error]
740 '("Next Error" . next-error))
742 "Keymap for `compilation-shell-minor-mode'.")
744 (defvar compilation-mode-map
745 (let ((map (cons 'keymap compilation-minor-mode-map)))
746 (define-key map " " 'scroll-up)
747 (define-key map "\^?" 'scroll-down)
748 ;; Set up the menu-bar
749 (define-key map [menu-bar compilation-menu]
750 (cons "Compile" (make-sparse-keymap "Compile")))
752 (define-key map [menu-bar compilation-menu compilation-mode-kill-compilation]
753 '("Stop Compilation" . kill-compilation))
754 (define-key map [menu-bar compilation-menu compilation-mode-separator2]
756 (define-key map [menu-bar compilation-menu compilation-mode-first-error]
757 '("First Error" . first-error))
758 (define-key map [menu-bar compilation-menu compilation-mode-previous-error]
759 '("Previous Error" . previous-error))
760 (define-key map [menu-bar compilation-menu compilation-mode-next-error]
761 '("Next Error" . next-error))
762 (define-key map [menu-bar compilation-menu compilation-separator2]
764 (define-key map [menu-bar compilation-menu compilation-mode-grep]
766 (define-key map [menu-bar compilation-menu compilation-mode-recompile]
767 '("Recompile" . recompile))
768 (define-key map [menu-bar compilation-menu compilation-mode-compile]
769 '("Compile..." . compile))
771 "Keymap for compilation log buffers.
772 `compilation-minor-mode-map' is a cdr of this.")
774 (put 'compilation-mode 'mode-class 'special)
777 (defun compilation-mode ()
778 "Major mode for compilation log buffers.
779 \\<compilation-mode-map>To visit the source for a line-numbered error,
780 move point to the error message line and type \\[compile-goto-error].
781 To kill the compilation, type \\[kill-compilation].
783 Runs `compilation-mode-hook' with `run-hooks' (which see)."
785 (kill-all-local-variables)
786 (use-local-map compilation-mode-map)
787 (setq major-mode 'compilation-mode
788 mode-name "Compilation")
790 (set (make-local-variable 'font-lock-defaults)
791 '(compilation-mode-font-lock-keywords t))
792 (set (make-local-variable 'revert-buffer-function)
793 'compilation-revert-buffer)
794 (run-hooks 'compilation-mode-hook))
796 (defun compilation-revert-buffer (ignore-auto noconfirm)
797 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
798 (apply 'compile-internal compilation-arguments)))
800 ;; Prepare the buffer for the compilation parsing commands to work.
801 (defun compilation-setup ()
802 ;; Make the buffer's mode line show process state.
803 (setq mode-line-process '(":%s"))
804 (set (make-local-variable 'compilation-error-list) nil)
805 (set (make-local-variable 'compilation-old-error-list) nil)
806 (set (make-local-variable 'compilation-parsing-end) 1)
807 (set (make-local-variable 'compilation-directory-stack) nil)
808 (setq compilation-last-buffer (current-buffer)))
810 (defvar compilation-shell-minor-mode nil
811 "Non-nil when in compilation-shell-minor-mode.
812 In this minor mode, all the error-parsing commands of the
813 Compilation major mode are available but bound to keys that don't
814 collide with Shell mode.")
815 (make-variable-buffer-local 'compilation-shell-minor-mode)
817 (or (assq 'compilation-shell-minor-mode minor-mode-alist)
818 (setq minor-mode-alist
819 (cons '(compilation-shell-minor-mode " Shell-Compile")
821 (or (assq 'compilation-shell-minor-mode minor-mode-map-alist)
822 (setq minor-mode-map-alist (cons (cons 'compilation-shell-minor-mode
823 compilation-shell-minor-mode-map)
824 minor-mode-map-alist)))
826 (defvar compilation-minor-mode nil
827 "Non-nil when in compilation-minor-mode.
828 In this minor mode, all the error-parsing commands of the
829 Compilation major mode are available.")
830 (make-variable-buffer-local 'compilation-minor-mode)
832 (or (assq 'compilation-minor-mode minor-mode-alist)
833 (setq minor-mode-alist (cons '(compilation-minor-mode " Compilation")
835 (or (assq 'compilation-minor-mode minor-mode-map-alist)
836 (setq minor-mode-map-alist (cons (cons 'compilation-minor-mode
837 compilation-minor-mode-map)
838 minor-mode-map-alist)))
841 (defun compilation-minor-mode (&optional arg)
842 "Toggle compilation minor mode.
843 With arg, turn compilation mode on if and only if arg is positive.
844 See `compilation-mode'.
845 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
847 (if (setq compilation-minor-mode (if (null arg)
848 (null compilation-minor-mode)
849 (> (prefix-numeric-value arg) 0)))
852 (run-hooks 'compilation-minor-mode-hook))))
854 ;; Write msg in the current buffer and hack its mode-line-process.
855 (defun compilation-handle-exit (process-status exit-status msg)
856 (let ((buffer-read-only nil)
857 (status (if compilation-exit-message-function
858 (funcall compilation-exit-message-function
859 process-status exit-status msg)
860 (cons msg exit-status)))
863 ;; Record where we put the message, so we can ignore it
866 (insert ?\n mode-name " " (car status))
868 (insert " at " (substring (current-time-string) 0 19))
870 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
871 ;; Force mode line redisplay soon.
872 (force-mode-line-update)
873 (if (and opoint (< opoint omax))
875 ;; Automatically parse (and mouse-highlight) error messages:
876 (cond ((eq compile-auto-highlight t)
877 (compile-reinitialize-errors nil (point-max)))
878 ((numberp compile-auto-highlight)
879 (compile-reinitialize-errors nil
881 (goto-line compile-auto-highlight)
883 (if compilation-finish-function
884 (funcall compilation-finish-function (current-buffer) msg))
885 (let ((functions compilation-finish-functions))
887 (funcall (car functions) (current-buffer) msg)
888 (setq functions (cdr functions))))))
890 ;; Called when compilation process changes state.
891 (defun compilation-sentinel (proc msg)
892 "Sentinel for compilation buffers."
893 (let ((buffer (process-buffer proc)))
894 (if (memq (process-status proc) '(signal exit))
896 (if (null (buffer-name buffer))
898 (set-process-buffer proc nil)
899 (let ((obuf (current-buffer)))
900 ;; save-excursion isn't the right thing if
901 ;; process-buffer is current-buffer
904 ;; Write something in the compilation buffer
905 ;; and hack its mode line.
907 (compilation-handle-exit (process-status proc)
908 (process-exit-status proc)
910 ;; Since the buffer and mode line will show that the
911 ;; process is dead, we can delete it now. Otherwise it
912 ;; will stay around until M-x list-processes.
913 (delete-process proc))
915 (setq compilation-in-progress (delq proc compilation-in-progress))
918 (defun compilation-filter (proc string)
919 "Process filter for compilation buffers.
920 Just inserts the text, but uses `insert-before-markers'."
921 (if (buffer-name (process-buffer proc))
923 (set-buffer (process-buffer proc))
924 (let ((buffer-read-only nil))
926 (goto-char (process-mark proc))
927 (insert-before-markers string)
928 (run-hooks 'compilation-filter-hook)
929 (set-marker (process-mark proc) (point)))))))
931 ;; Return the cdr of compilation-old-error-list for the error containing point.
932 (defun compile-error-at-point ()
933 (compile-reinitialize-errors nil (point))
934 (let ((errors compilation-old-error-list))
936 (> (point) (car (car errors))))
937 (setq errors (cdr errors)))
940 (defsubst compilation-buffer-p (buffer)
943 (or compilation-shell-minor-mode compilation-minor-mode
944 (eq major-mode 'compilation-mode))))
946 (defun compilation-next-error (n)
947 "Move point to the next error in the compilation buffer.
948 Does NOT find the source line like \\[next-error]."
950 (or (compilation-buffer-p (current-buffer))
951 (error "Not in a compilation buffer."))
952 (setq compilation-last-buffer (current-buffer))
954 (let ((errors (compile-error-at-point)))
956 ;; Move to the error after the one containing point.
957 (goto-char (car (if (< n 0)
959 (e compilation-old-error-list))
960 ;; See how many cdrs away ERRORS is from the start.
961 (while (not (eq e errors))
965 (error "Moved back past first error")
966 (nth (+ i n) compilation-old-error-list)))
967 (let ((compilation-error-list (cdr errors)))
968 (compile-reinitialize-errors nil nil n)
969 (if compilation-error-list
970 (nth (1- n) compilation-error-list)
971 (error "Moved past last error"))))))))
973 (defun compilation-previous-error (n)
974 "Move point to the previous error in the compilation buffer.
975 Does NOT find the source line like \\[next-error]."
977 (compilation-next-error (- n)))
980 ;; Given an elt of `compilation-error-list', return an object representing
981 ;; the referenced file which is equal to (but not necessarily eq to) what
982 ;; this function would return for another error in the same file.
983 (defsubst compilation-error-filedata (data)
984 (setq data (cdr data))
989 ;; Return a string describing a value from compilation-error-filedata.
990 ;; This value is not necessarily useful as a file name, but should be
991 ;; indicative to the user of what file's errors are being referred to.
992 (defsubst compilation-error-filedata-file-name (filedata)
993 (if (bufferp filedata)
994 (buffer-file-name filedata)
997 (defun compilation-next-file (n)
998 "Move point to the next error for a different file than the current one."
1000 (or (compilation-buffer-p (current-buffer))
1001 (error "Not in a compilation buffer."))
1002 (setq compilation-last-buffer (current-buffer))
1004 (let ((reversed (< n 0))
1008 (setq errors (or (compile-error-at-point)
1009 (error "Moved past last error")))
1011 ;; Get a reversed list of the errors up through the one containing point.
1012 (compile-reinitialize-errors nil (point))
1013 (setq errors (reverse compilation-old-error-list)
1016 ;; Ignore errors after point. (car ERRORS) will be the error
1017 ;; containing point, (cadr ERRORS) the one before it.
1019 (< (point) (car (car errors))))
1020 (setq errors (cdr errors))))
1023 (setq filedata (compilation-error-filedata (car errors)))
1025 ;; Skip past the following errors for this file.
1026 (while (equal filedata
1027 (compilation-error-filedata
1030 (error "%s the first erring file"
1031 (compilation-error-filedata-file-name
1033 (let ((compilation-error-list nil))
1035 (compile-reinitialize-errors nil nil 2)
1036 (setq errors compilation-error-list)))
1037 (error "%s is the last erring file"
1038 (compilation-error-filedata-file-name
1040 (setq errors (cdr errors)))
1044 ;; Move to the following error.
1045 (goto-char (car (car (or errors
1047 (error "This is the first erring file")
1048 (let ((compilation-error-list nil))
1049 ;; Parse the last one.
1050 (compile-reinitialize-errors nil nil 1)
1051 compilation-error-list))))))))
1053 (defun compilation-previous-file (n)
1054 "Move point to the previous error for a different file than the current one."
1056 (compilation-next-file (- n)))
1059 (defun kill-compilation ()
1060 "Kill the process made by the \\[compile] command."
1062 (let ((buffer (compilation-find-buffer)))
1063 (if (get-buffer-process buffer)
1064 (interrupt-process (get-buffer-process buffer))
1065 (error "The compilation process is not running."))))
1068 ;; Parse any new errors in the compilation buffer,
1069 ;; or reparse from the beginning if the user has asked for that.
1070 (defun compile-reinitialize-errors (reparse
1071 &optional limit-search find-at-least)
1073 (set-buffer compilation-last-buffer)
1074 ;; If we are out of errors, or if user says "reparse",
1075 ;; discard the info we have, to force reparsing.
1076 (if (or (eq compilation-error-list t)
1078 (compilation-forget-errors))
1079 (if (and compilation-error-list
1080 (or (not limit-search)
1081 (> compilation-parsing-end limit-search))
1082 (or (not find-at-least)
1083 (>= (length compilation-error-list) find-at-least)))
1084 ;; Since compilation-error-list is non-nil, it points to a specific
1085 ;; error the user wanted. So don't move it around.
1087 ;; This was here for a long time (before my rewrite); why? --roland
1088 ;;(switch-to-buffer compilation-last-buffer)
1089 (set-buffer-modified-p nil)
1090 (if (< compilation-parsing-end (point-max))
1091 ;; compilation-error-list might be non-nil if we have a non-nil
1092 ;; LIMIT-SEARCH or FIND-AT-LEAST arg. In that case its value
1093 ;; records the current position in the error list, and we must
1094 ;; preserve that after reparsing.
1095 (let ((error-list-pos compilation-error-list))
1096 (funcall compilation-parse-errors-function
1099 ;; We only need enough new parsed errors to reach
1100 ;; FIND-AT-LEAST errors past the current
1102 (- find-at-least (length compilation-error-list))))
1103 ;; Remember the entire list for compilation-forget-errors. If
1104 ;; this is an incremental parse, append to previous list. If
1105 ;; we are parsing anew, compilation-forget-errors cleared
1106 ;; compilation-old-error-list above.
1107 (setq compilation-old-error-list
1108 (nconc compilation-old-error-list compilation-error-list))
1110 ;; We started in the middle of an existing list of parsed
1111 ;; errors before parsing more; restore that position.
1112 (setq compilation-error-list error-list-pos))
1113 ;; Mouse-Highlight (the first line of) each error message when the
1114 ;; mouse pointer moves over it:
1115 (let ((inhibit-read-only t)
1116 (error-list compilation-error-list))
1119 (put-text-property (goto-char (car (car error-list)))
1120 (progn (end-of-line) (point))
1121 'mouse-face 'highlight))
1122 (setq error-list (cdr error-list))))
1125 (defun compile-mouse-goto-error (event)
1128 (set-buffer (window-buffer (posn-window (event-end event))))
1129 (goto-char (posn-point (event-end event)))
1131 (or (compilation-buffer-p (current-buffer))
1132 (error "Not in a compilation buffer."))
1133 (setq compilation-last-buffer (current-buffer))
1134 ;; `compile-reinitialize-errors' needs to see the complete filename
1135 ;; on the line where they clicked the mouse. Since it only looks
1136 ;; up to point, moving point to eol makes sure the filename is
1137 ;; visible to `compile-reinitialize-errors'.
1139 (compile-reinitialize-errors nil (point))
1141 ;; Move to bol; the marker for the error on this line will point there.
1144 ;; Move compilation-error-list to the elt of compilation-old-error-list
1146 (setq compilation-error-list compilation-old-error-list)
1147 (while (and compilation-error-list
1148 (> (point) (car (car compilation-error-list))))
1149 (setq compilation-error-list (cdr compilation-error-list)))
1150 (or compilation-error-list
1151 (error "No error to go to")))
1152 (select-window (posn-window (event-end event)))
1153 ;; Move to another window, so that next-error's window changes
1154 ;; result in the desired setup.
1158 ;; other-window changed the selected buffer,
1159 ;; but we didn't want to do that.
1160 (set-buffer compilation-last-buffer)))
1165 (defun compile-goto-error (&optional argp)
1166 "Visit the source for the error message point is on.
1167 Use this command in a compilation log buffer. Sets the mark at point there.
1168 \\[universal-argument] as a prefix arg means to reparse the buffer's error messages first;
1169 other kinds of prefix arguments are ignored."
1171 (or (compilation-buffer-p (current-buffer))
1172 (error "Not in a compilation buffer."))
1173 (setq compilation-last-buffer (current-buffer))
1174 (compile-reinitialize-errors (consp argp) (point))
1176 ;; Move to bol; the marker for the error on this line will point there.
1179 ;; Move compilation-error-list to the elt of compilation-old-error-list
1181 (setq compilation-error-list compilation-old-error-list)
1182 (while (and compilation-error-list
1183 (> (point) (car (car compilation-error-list))))
1184 (setq compilation-error-list (cdr compilation-error-list)))
1186 ;; Move to another window, so that next-error's window changes
1187 ;; result in the desired setup.
1191 ;; other-window changed the selected buffer,
1192 ;; but we didn't want to do that.
1193 (set-buffer compilation-last-buffer)))
1198 ;; Return a compilation buffer.
1199 ;; If the current buffer is a compilation buffer, return it.
1200 ;; If compilation-last-buffer is set to a live buffer, use that.
1201 ;; Otherwise, look for a compilation buffer and signal an error
1202 ;; if there are none.
1203 (defun compilation-find-buffer (&optional other-buffer)
1204 (if (and (not other-buffer)
1205 (compilation-buffer-p (current-buffer)))
1206 ;; The current buffer is a compilation buffer.
1208 (if (and compilation-last-buffer (buffer-name compilation-last-buffer)
1209 (compilation-buffer-p compilation-last-buffer)
1210 (or (not other-buffer) (not (eq compilation-last-buffer
1211 (current-buffer)))))
1212 compilation-last-buffer
1213 (let ((buffers (buffer-list)))
1214 (while (and buffers (or (not (compilation-buffer-p (car buffers)))
1216 (eq (car buffers) (current-buffer)))))
1217 (setq buffers (cdr buffers)))
1220 (or (and other-buffer
1221 (compilation-buffer-p (current-buffer))
1222 ;; The current buffer is a compilation buffer.
1225 (message "This is the only compilation buffer."))
1227 (error "No compilation started!")))))))
1230 (defun next-error (&optional argp)
1231 "Visit next compilation error message and corresponding source code.
1232 This operates on the output from the \\[compile] command.
1233 If all preparsed error messages have been processed,
1234 the error message buffer is checked for new ones.
1236 A prefix arg specifies how many error messages to move;
1237 negative means move back to previous error messages.
1238 Just C-u as a prefix means reparse the error message buffer
1239 and start at the first error.
1241 \\[next-error] normally applies to the most recent compilation started,
1242 but as long as you are in the middle of parsing errors from one compilation
1243 output buffer, you stay with that compilation output buffer.
1245 Use \\[next-error] in a compilation output buffer to switch to
1246 processing errors from that compilation.
1248 See variables `compilation-parse-errors-function' and
1249 \`compilation-error-regexp-alist' for customization ideas."
1251 (setq compilation-last-buffer (compilation-find-buffer))
1252 (compilation-goto-locus (compilation-next-error-locus
1253 ;; We want to pass a number here only if
1254 ;; we got a numeric prefix arg, not just C-u.
1255 (and (not (consp argp))
1256 (prefix-numeric-value argp))
1258 ;;;###autoload (define-key ctl-x-map "`" 'next-error)
1260 (defun previous-error ()
1261 "Visit previous compilation error message and corresponding source code.
1262 This operates on the output from the \\[compile] command."
1266 (defun first-error ()
1267 "Reparse the error message buffer and start at the first error.
1268 Visit corresponding source code.
1269 This operates on the output from the \\[compile] command."
1273 (defvar compilation-skip-to-next-location nil
1274 "*If non-nil, skip multiple error messages for the same source location.")
1276 (defun compilation-next-error-locus (&optional move reparse silent)
1277 "Visit next compilation error and return locus in corresponding source code.
1278 This operates on the output from the \\[compile] command.
1279 If all preparsed error messages have been processed,
1280 the error message buffer is checked for new ones.
1282 Returns a cons (ERROR . SOURCE) of two markers: ERROR is a marker at the
1283 location of the error message in the compilation buffer, and SOURCE is a
1284 marker at the location in the source code indicated by the error message.
1286 Optional first arg MOVE says how many error messages to move forwards (or
1287 backwards, if negative); default is 1. Optional second arg REPARSE, if
1288 non-nil, says to reparse the error message buffer and reset to the first
1289 error (plus MOVE - 1). If optional third argument SILENT is non-nil, return
1290 nil instead of raising an error if there are no more errors.
1292 The current buffer should be the desired compilation output buffer."
1293 (or move (setq move 1))
1294 (compile-reinitialize-errors reparse nil (and (not reparse)
1295 (if (< move 1) 0 (1- move))))
1296 (let (next-errors next-error)
1297 (catch 'no-next-error
1299 (set-buffer compilation-last-buffer)
1300 ;; compilation-error-list points to the "current" error.
1304 compilation-error-list)
1305 ;; Zero or negative arg; we need to move back in the list.
1308 (e compilation-old-error-list))
1309 ;; See how many cdrs away the current error is from the start.
1310 (while (not (eq e compilation-error-list))
1314 (error "Moved back past first error")
1315 (nthcdr (+ i n) compilation-old-error-list))))
1316 next-error (car next-errors))
1318 (if (null next-error)
1320 (and move (/= move 1)
1321 (error (if (> move 0)
1322 "Moved past last error")
1323 "Moved back past first error"))
1324 ;; Forget existing error messages if compilation has finished.
1325 (if (not (and (get-buffer-process (current-buffer))
1330 (compilation-forget-errors))
1332 (throw 'no-next-error nil)
1333 (error (concat compilation-error-message
1334 (and (get-buffer-process (current-buffer))
1340 (setq compilation-error-list (cdr next-errors))
1341 (if (null (cdr next-error))
1342 ;; This error is boring. Go to the next.
1344 (or (markerp (cdr next-error))
1345 ;; This error has a filename/lineno pair.
1346 ;; Find the file and turn it into a marker.
1347 (let* ((fileinfo (car (cdr next-error)))
1348 (buffer (apply 'compilation-find-file
1349 (car next-error) fileinfo)))
1351 ;; We can't find this error's file.
1352 ;; Remove all errors in the same file.
1354 (setq next-errors compilation-old-error-list)
1356 (and (consp (cdr (car next-errors)))
1357 (equal (car (cdr (car next-errors)))
1360 (set-marker (car (car next-errors)) nil)
1361 (setcdr (car next-errors) nil)))
1362 (setq next-errors (cdr next-errors)))
1363 ;; Look for the next error.
1365 ;; We found the file. Get a marker for this error.
1366 ;; compilation-old-error-list is a buffer-local
1367 ;; variable, so we must be careful to extract its value
1368 ;; before switching to the source file buffer.
1369 (let ((errors compilation-old-error-list)
1370 (last-line (nth 1 (cdr next-error)))
1371 (column (nth 2 (cdr next-error))))
1376 (goto-line last-line)
1377 (if (and column (> column 0))
1378 ;; Columns in error msgs are 1-origin.
1379 (move-to-column (1- column))
1380 (beginning-of-line))
1381 (setcdr next-error (point-marker))
1382 ;; Make all the other error messages referring
1383 ;; to the same file have markers into the buffer.
1385 (and (consp (cdr (car errors)))
1386 (equal (car (cdr (car errors))) fileinfo)
1387 (let* ((this (nth 1 (cdr (car errors))))
1388 (column (nth 2 (cdr (car errors))))
1389 (lines (- this last-line)))
1390 (if (eq selective-display t)
1391 ;; When selective-display is t,
1392 ;; each C-m is a line boundary,
1393 ;; as well as each newline.
1395 (re-search-backward "[\n\C-m]"
1398 (re-search-forward "[\n\C-m]"
1401 (forward-line lines))
1402 (if (and column (> column 1))
1403 (move-to-column (1- column))
1404 (beginning-of-line))
1405 (setq last-line this)
1406 (setcdr (car errors) (point-marker))))
1407 (setq errors (cdr errors)))))))))
1408 ;; If we didn't get a marker for this error, or this
1409 ;; marker's buffer was killed, go on to the next one.
1410 (or (not (markerp (cdr next-error)))
1411 (not (marker-buffer (cdr next-error))))))
1412 (setq next-errors compilation-error-list
1413 next-error (car next-errors)))))
1415 (if compilation-skip-to-next-location
1416 ;; Skip over multiple error messages for the same source location,
1417 ;; so the next C-x ` won't go to an error in the same place.
1418 (while (and compilation-error-list
1419 (equal (cdr (car compilation-error-list))
1421 (setq compilation-error-list (cdr compilation-error-list))))
1423 ;; We now have a marker for the position of the error source code.
1424 ;; NEXT-ERROR is a cons (ERROR . SOURCE) of two markers.
1427 (defun compilation-goto-locus (next-error)
1428 "Jump to an error locus returned by `compilation-next-error-locus'.
1429 Takes one argument, a cons (ERROR . SOURCE) of two markers.
1430 Selects a window with point at SOURCE, with another window displaying ERROR."
1431 (if (and (window-dedicated-p (selected-window))
1432 (eq (selected-window) (frame-root-window)))
1433 (switch-to-buffer-other-frame (marker-buffer (cdr next-error)))
1434 (switch-to-buffer (marker-buffer (cdr next-error))))
1435 (goto-char (cdr next-error))
1436 ;; If narrowing got in the way of
1437 ;; going to the right place, widen.
1438 (or (= (point) (marker-position (cdr next-error)))
1441 (goto-char (cdr next-error))))
1443 ;; Show compilation buffer in other window, scrolled to this error.
1444 (let* ((pop-up-windows t)
1445 ;; Use an existing window if it is in a visible frame.
1446 (w (or (get-buffer-window (marker-buffer (car next-error)) 'visible)
1448 (display-buffer (marker-buffer (car next-error))))))
1449 (set-window-point w (car next-error))
1450 (set-window-start w (car next-error))
1451 (compilation-set-window-height w)))
1453 ;; Find a buffer for file FILENAME.
1454 ;; Search the directories in compilation-search-path.
1455 ;; A nil in compilation-search-path means to try the
1456 ;; current directory, which is passed in DIR.
1457 ;; If FILENAME is not found at all, ask the user where to find it.
1458 ;; Pop up the buffer containing MARKER and scroll to MARKER if we ask the user.
1459 (defun compilation-find-file (marker filename dir &rest formats)
1460 (or formats (setq formats '("%s")))
1461 (let ((dirs compilation-search-path)
1462 buffer thisdir fmts name)
1463 (if (file-name-absolute-p filename)
1464 ;; The file name is absolute. Use its explicit directory as
1465 ;; the first in the search path, and strip it from FILENAME.
1466 (setq filename (abbreviate-file-name (expand-file-name filename))
1467 dirs (cons (file-name-directory filename) dirs)
1468 filename (file-name-nondirectory filename)))
1469 ;; Now search the path.
1470 (while (and dirs (null buffer))
1471 (setq thisdir (or (car dirs) dir)
1473 ;; For each directory, try each format string.
1474 (while (and fmts (null buffer))
1475 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1476 buffer (and (file-exists-p name)
1477 (find-file-noselect name))
1479 (setq dirs (cdr dirs)))
1481 ;; The file doesn't exist.
1482 ;; Ask the user where to find it.
1483 ;; If he hits C-g, then the next time he does
1484 ;; next-error, he'll skip past it.
1485 (let* ((pop-up-windows t)
1486 (w (display-buffer (marker-buffer marker))))
1487 (set-window-point w marker)
1488 (set-window-start w marker)
1489 (let ((name (expand-file-name
1491 (format "Find this error in: (default %s) "
1494 (if (file-directory-p name)
1495 (setq name (expand-file-name filename name)))
1496 (and (file-exists-p name)
1497 (find-file-noselect name)))))))
1499 ;; Set compilation-error-list to nil, and unchain the markers that point to the
1500 ;; error messages and their text, so that they no longer slow down gap motion.
1501 ;; This would happen anyway at the next garbage collection, but it is better to
1502 ;; do it right away.
1503 (defun compilation-forget-errors ()
1504 (while compilation-old-error-list
1505 (let ((next-error (car compilation-old-error-list)))
1506 (set-marker (car next-error) nil)
1507 (if (markerp (cdr next-error))
1508 (set-marker (cdr next-error) nil)))
1509 (setq compilation-old-error-list (cdr compilation-old-error-list)))
1510 (setq compilation-error-list nil
1511 compilation-directory-stack nil
1512 compilation-parsing-end 1)
1513 ;; Remove the highlighting added by compile-reinitialize-errors:
1514 (let ((inhibit-read-only t))
1515 (remove-text-properties (point-min) (point-max) '(mouse-face highlight)))
1519 ;; This function is not needed any more by compilation mode.
1520 ;; Does anyone else need it or can it be deleted?
1521 (defun count-regexp-groupings (regexp)
1522 "Return the number of \\( ... \\) groupings in REGEXP (a string)."
1524 (len (length regexp))
1528 (setq c (aref regexp i)
1531 ;; Find the end of this [...].
1532 (while (and (< i len)
1533 (not (= (aref regexp i) ?\])))
1538 (setq c (aref regexp i)
1541 ;; We found the end of a grouping,
1542 ;; so bump our counter.
1543 (setq groupings (1+ groupings))))))))
1546 (defvar compilation-current-file nil
1547 "Used by compilation-parse-errors to store filename for file being compiled")
1549 ;; This variable is not used as a global variable. It's defined here just to
1550 ;; shut up the byte compiler. It's bound and used by compilation-parse-errors
1551 ;; and set by compile-collect-regexps.
1552 (defvar compilation-regexps nil)
1554 (defun compilation-parse-errors (limit-search find-at-least)
1555 "Parse the current buffer as grep, cc, lint or other error messages.
1556 See variable `compilation-parse-errors-function' for the interface it uses."
1557 (setq compilation-error-list nil)
1558 (message "Parsing error messages...")
1559 (if (null compilation-error-regexp-alist)
1560 (error "compilation-error-regexp-alist is empty!"))
1561 (let* ((compilation-regexps nil) ; Variable set by compile-collect-regexps.
1563 (compilation-num-errors-found 0)
1564 ;; Set up now the expanded, abbreviated directory variables
1565 ;; that compile-abbreviate-directory will need, so we can
1566 ;; compute them just once here.
1567 (orig (abbreviate-file-name default-directory))
1568 (orig-expanded (abbreviate-file-name
1569 (file-truename default-directory)))
1570 (parent-expanded (abbreviate-file-name
1571 (expand-file-name "../" orig-expanded))))
1573 ;; Make a list of all the regexps. Each element has the form
1574 ;; (REGEXP TYPE IDX1 IDX2 ...)
1575 ;; where TYPE is one of leave, enter, file, error or nomessage.
1576 (compile-collect-regexps 'leave compilation-leave-directory-regexp-alist)
1577 (compile-collect-regexps 'enter compilation-enter-directory-regexp-alist)
1578 (compile-collect-regexps 'file compilation-file-regexp-alist)
1579 (compile-collect-regexps 'nomessage compilation-nomessage-regexp-alist)
1580 (compile-collect-regexps 'error compilation-error-regexp-alist)
1582 ;; Don't reparse messages already seen at last parse.
1583 (goto-char compilation-parsing-end)
1586 (setq compilation-current-file nil) ; No current file at start.
1587 ;; Don't parse the first two lines as error messages.
1588 ;; This matters for grep.
1592 (while (not (or found-desired (eobp)))
1593 (let ((this compilation-regexps) (prev nil) (alist nil) type)
1594 ;; Go through the regular expressions. If a match is found,
1595 ;; variable alist is set to the corresponding alist and the
1596 ;; matching regexp is moved to the front of compilation-regexps
1597 ;; to make it match faster next time.
1598 (while (and this (null alist))
1599 (if (not (looking-at (car (car this))))
1600 (progn (setq prev this) ; No match, go to next.
1601 (setq this (cdr this)))
1602 (setq alist (cdr (car this))) ; Got a match.
1603 ;;; (if prev ; If not the first regexp,
1604 ;;; (progn ; move it to the front.
1605 ;;; (setcdr prev (cdr this))
1606 ;;; (setcdr this compilation-regexps)
1607 ;;; (setq compilation-regexps this)))
1609 (if (and alist ; Seen a match and not to
1610 (not (eq (setq type (car alist)) 'nomessage))) ; be ignored.
1611 (let* ((end-of-match (match-end 0))
1613 (compile-buffer-substring (car (setq alist (cdr alist)))))
1615 (if (eq type 'error) ; error message
1616 (let* ((linenum (if (numberp (car (setq alist (cdr alist))))
1618 (compile-buffer-substring (car alist)))
1619 ;; (car alist) is not a number, must be a
1620 ;; function that is called below to return
1621 ;; an error position descriptor.
1623 ;; Convert to integer later if linenum not a function.
1624 (column (compile-buffer-substring
1625 (car (setq alist (cdr alist)))))
1628 ;; Check that we have a file name.
1630 ;; No file name in message, we must have seen it before
1631 (setq filename compilation-current-file)
1633 An error message with no file name and no file name has been seen earlier."))
1635 ;; Check for a comint-file-name-prefix and prepend it if
1636 ;; appropriate. (This is very useful for
1637 ;; compilation-minor-mode in an rlogin-mode buffer.)
1638 (and (boundp 'comint-file-name-prefix)
1639 ;; If file name is relative, default-directory will
1640 ;; already contain the comint-file-name-prefix (done
1641 ;; by compile-abbreviate-directory).
1642 (file-name-absolute-p filename)
1644 (concat comint-file-name-prefix filename)))
1646 ;; Some compilers (e.g. Sun's java compiler, reportedly)
1647 ;; produce bogus file names like "./bar//foo.c" for file
1648 ;; "bar/foo.c"; expand-file-name will collapse these into
1649 ;; "/foo.c" and fail to find the appropriate file. So we
1650 ;; look for doubled slashes in the file name and fix them
1651 ;; up in the buffer.
1652 (setq filename (command-line-normalize-file-name filename))
1655 (cons filename (cons default-directory (cdr alist))))
1657 ;; Locate the erring file and line.
1658 ;; Make this-error a new elt for compilation-error-list,
1659 ;; giving a marker for the current compilation buffer
1660 ;; location, and the file and line number of the error.
1661 ;; Save, as the start of the error, the beginning of the
1662 ;; line containing the match.
1663 (if (setq this-error
1664 (if (numberp linenum)
1665 (list (point-marker) filename linenum
1666 (and column (string-to-int column)))
1667 ;; If linenum is not a number then it must be
1668 ;; a function returning an error position
1669 ;; descriptor or nil (meaning no position).
1671 (funcall linenum filename column))))
1673 ;; We have an error position descriptor.
1674 ;; If we have found as many new errors as the user
1675 ;; wants, or if we are past the buffer position he
1676 ;; indicated, then we continue to parse until we have
1677 ;; seen all consecutive errors in the same file. This
1678 ;; means that all the errors of a source file will be
1679 ;; seen in one parsing run, so that the error positions
1680 ;; will be recorded as markers in the source file
1681 ;; buffer that will move when the buffer is changed.
1682 (if (and (or (and find-at-least
1683 (>= compilation-num-errors-found
1686 (>= end-of-match limit-search)))
1687 compilation-error-list ;At least one previous.
1688 (not (equal ; Same filename?
1689 (car (cdr (car compilation-error-list)))
1690 (car (cdr this-error)))))
1691 ;; We are past the limits and the last error
1692 ;; parsed, didn't belong to the same source file
1693 ;; as the earlier ones i.e. we have seen all the
1694 ;; errors belonging to the earlier file. We don't
1695 ;; add the error just parsed so that the next
1696 ;; parsing run can get it and the following errors
1697 ;; in the same file all at once.
1698 (setq found-desired t)
1700 (goto-char end-of-match) ; Prepare for next message.
1701 ;; Don't add the same source line more than once.
1703 compilation-error-list
1704 (equal (cdr (car compilation-error-list))
1706 (setq compilation-error-list
1707 (cons this-error compilation-error-list)
1708 compilation-num-errors-found
1709 (1+ compilation-num-errors-found))))))
1711 ;; Not an error message.
1712 (if (eq type `file) ; Change current file.
1713 (and filename (setq compilation-current-file filename))
1714 ;; Enter or leave directory.
1715 (setq stack compilation-directory-stack)
1719 ;; The directory name in the message
1720 ;; is a truename. Try to convert it to a form
1721 ;; like what the user typed in.
1722 (compile-abbreviate-directory
1723 (file-name-as-directory
1724 (expand-file-name filename))
1725 orig orig-expanded parent-expanded)))
1726 (if (eq type 'leave)
1728 (not (string-equal (car stack)
1730 (setq stack (cdr stack)))
1731 (setq compilation-directory-stack
1732 (cons filename compilation-directory-stack)
1733 default-directory filename)))
1734 (and (eq type 'leave)
1736 (setq compilation-directory-stack (cdr stack))
1737 (setq stack (car compilation-directory-stack))
1738 (setq default-directory stack))
1739 (goto-char end-of-match) ; Prepare to look at next message.
1740 (and limit-search (>= end-of-match limit-search)
1741 ;; The user wanted a specific error, and we're past it.
1742 ;; We do this check here rather than at the end of the
1743 ;; loop because if the last thing seen is an error
1744 ;; message, we must carefully discard the last error
1745 ;; when it is the first in a new file (see above in
1746 ;; the error-message case)
1747 (setq found-desired t))))
1749 ;; Go to before the last character in the message so that we will
1750 ;; see the next line also when the message ended at end of line.
1751 ;; When we ignore the last error message above, this will
1752 ;; cancel the effect of forward-line below so that point
1756 ;; Is this message necessary any more? Parsing is now so fast
1757 ;; that you might not need to know how it proceeds.
1759 "Parsing error messages...%d found. %.0f%% of buffer seen."
1760 compilation-num-errors-found
1761 ;; Use floating-point because (* 100 (point)) frequently
1762 ;; exceeds the range of Emacs Lisp integers.
1763 (/ (* 100.0 (point)) (point-max)))
1766 (forward-line 1))) ; End of while loop. Look at next line.
1768 (setq compilation-parsing-end (point))
1769 (setq compilation-error-list (nreverse compilation-error-list))
1770 ;;; (message "Parsing error messages...done. %d found. %.0f%% of buffer seen."
1771 ;;; compilation-num-errors-found
1772 ;;; (/ (* 100.0 (point)) (point-max)))
1773 (message "Parsing error messages...done.")))
1775 (defun compile-collect-regexps (type this)
1776 ;; Add elements to variable compilation-regexps that is bound in
1777 ;; compilation-parse-errors.
1778 (and (not (eq this t))
1780 (setq compilation-regexps
1781 (cons (cons (car (car this)) (cons type (cdr (car this))))
1782 compilation-regexps))
1783 (setq this (cdr this)))))
1785 (defun compile-buffer-substring (index)
1786 ;; Get substring matched by INDEXth subexpression.
1788 (let ((beg (match-beginning index)))
1789 (if beg (buffer-substring beg (match-end index))))))
1791 ;; If directory DIR is a subdir of ORIG or of ORIG's parent,
1792 ;; return a relative name for it starting from ORIG or its parent.
1793 ;; ORIG-EXPANDED is an expanded version of ORIG.
1794 ;; PARENT-EXPANDED is an expanded version of ORIG's parent.
1795 ;; Those two args could be computed here, but we run faster by
1796 ;; having the caller compute them just once.
1797 (defun compile-abbreviate-directory (dir orig orig-expanded parent-expanded)
1798 ;; Apply canonical abbreviations to DIR first thing.
1799 ;; Those abbreviations are already done in the other arguments passed.
1800 (setq dir (abbreviate-file-name dir))
1802 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1803 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1805 (if (boundp 'comint-file-name-prefix)
1806 (setq dir (concat comint-file-name-prefix dir)))
1808 (if (and (> (length dir) (length orig-expanded))
1809 (string= orig-expanded
1810 (substring dir 0 (length orig-expanded))))
1813 (substring dir (length orig-expanded)))))
1814 (if (and (> (length dir) (length parent-expanded))
1815 (string= parent-expanded
1816 (substring dir 0 (length parent-expanded))))
1818 (concat (file-name-directory
1819 (directory-file-name orig))
1820 (substring dir (length parent-expanded)))))
1825 ;;; compile.el ends here