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 ;; This used to be less selective and allow characters other than
164 ;; parens around the line number, but that caused confusion for
165 ;; GNU-style error messages.
166 ;; This used to reject spaces and dashes in file names,
167 ;; but they are valudnow; so I made it more strict about the error
168 ;; message that follows.
169 ("\\(\\([a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
170 : \\(error\\|warning\\) C[0-9]+:" 1 3)
173 ;; Error ping.c 15: Unable to open include file 'sys/types.h'
174 ;; Warning ping.c 68: Call to function 'func' with no prototype
175 ("\\(Error\\|Warning\\) \\([a-zA-Z]?:?[^:( \t\n]+\\)\
176 \\([0-9]+\\)\\([) \t]\\|:[^0-9\n]\\)" 2 3)
178 ;; 4.3BSD lint pass 2
179 ;; strcmp: variable # of args. llib-lc(359) :: /usr/src/foo/foo.c(8)
180 (".*[ \t:]\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(](+[ \t]*\\([0-9]+\\))[:) \t]*$"
183 ;; 4.3BSD lint pass 3
184 ;; bloofle defined( /users/wolfgang/foo.c(4) ), but never used
186 ;; ("[ \t(]+\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]+" 1 2)
187 ;; which is regexp Impressionism - it matches almost anything!
188 (".*([ \t]*\\([a-zA-Z]?:?[^:( \t\n]+\\)[:(][ \t]*\\([0-9]+\\))" 1 2)
190 ;; MIPS lint pass<n>; looks good for SunPro lint also
191 ;; TrimMask (255) in solomon.c may be indistinguishable from TrimMasks (93) in solomon.c due to truncation
192 ("[^\n ]+ (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
193 ;; name defined but never used: LinInt in cmap_calc.c(199)
194 (".*in \\([^(\n]+\\)(\\([0-9]+\\))$" 1 2)
197 ;; fort: Severe: addstf.f, line 82: Missing operator or delimiter symbol
198 ;; Some SGI cc version:
199 ;; cfe: Warning 835: foo.c, line 2: something
200 ("\\(cfe\\|fort\\): [^:\n]*: \\([^ \n]*\\), line \\([0-9]+\\):" 2 3)
201 ;; Error on line 3 of t.f: Execution error unclassifiable statement
202 ;; Unknown who does this:
203 ;; Line 45 of "foo.c": bloofle undefined
204 ;; Absoft FORTRAN 77 Compiler 3.1.3
205 ;; error on line 19 of fplot.f: spelling error?
206 ;; warning on line 17 of fplot.f: data type is undefined for variable d
207 ("\\(.* on \\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
208 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2)
210 ;; Apollo cc, 4.3BSD fc:
211 ;; "foo.f", line 3: Error: syntax error near end of statement
213 ;; "vvouch.c", line 19.5: 1506-046 (S) Syntax error.
215 ;; "foo.c", line 32 pos 1; (E) syntax error; unexpected symbol: "lossage"
216 ;; GNAT (as of July 94):
217 ;; "foo.adb", line 2(11): warning: file name does not match ...
218 ;; IBM AIX xlc compiler:
219 ;; "src/swapping.c", line 30.34: 1506-342 (W) "/*" detected in comment.
220 (".*\"\\([^,\" \n\t]+\\)\", lines? \
221 \\([0-9]+\\)\\([\(.]\\([0-9]+\\)\)?\\)?[:., (-]" 1 2 4)
224 ;; File "foobar.ml", lines 5-8, characters 20-155: blah blah
225 ("^File \"\\([^,\" \n\t]+\\)\", lines? \\([0-9]+\\)[-0-9]*, characters? \\([0-9]+\\)" 1 2 3)
227 ;; MIPS RISC CC - the one distributed with Ultrix:
228 ;; ccom: Error: foo.c, line 2: syntax error
230 ;; /usr/lib/cmplrs/cc/cfe: Error: foo.c: 1: blah blah
231 ("[a-z/]+: \\([eE]rror\\|[wW]arning\\): \\([^,\" \n\t]+\\)[,:] \\(line \\)?\\([0-9]+\\):" 2 4)
233 ;; IBM AIX PS/2 C version 1.1:
234 ;; ****** Error number 140 in line 8 of file errors.c ******
235 (".*in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
236 ;; IBM AIX lint is too painful to do right this way. File name
237 ;; prefixes entire sections rather than being on each line.
239 ;; SPARCcompiler Pascal:
240 ;; 20 linjer : array[1..4] of linje;
241 ;; e 18480-----------^--- Inserted ';'
243 ;; E 18520 line 61 - 0 is undefined
244 ;; These messages don't contain a file name. Instead the compiler gives
245 ;; a message whenever the file being compiled is changed.
246 (" +\\([0-9]+\\) +.*\n[ew] [0-9]+-+" nil 1)
247 ("[Ew] +[0-9]+ line \\([0-9]+\\) - " nil 1)
249 ;; Lucid Compiler, lcc 3.x
250 ;; E, file.cc(35,52) Illegal operation on pointers
251 ("[EW], \\([^(\n]*\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)" 1 2 3)
253 ;;; This seems to be superfluous because the first pattern matches it.
254 ;;; ;; GNU messages with program name and optional column number.
255 ;;; ("[a-zA-Z]?:?[^0-9 \n\t:]+[^ \n\t:]*:[ \t]*\\([^ \n\t:]+\\):\
256 ;;;\\([0-9]+\\):\\(\\([0-9]+\\)[: \t]\\)?" 1 2 4)
258 ;; Cray C compiler error messages
259 ("\\(cc\\| cft\\)-[0-9]+ c\\(c\\|f77\\): ERROR \\([^,\n]+, \\)* File = \
260 \\([^,\n]+\\), Line = \\([0-9]+\\)" 4 5)
262 ;; IBM C/C++ Tools 2.01:
263 ;; foo.c(2:0) : informational EDC0804: Function foo is not referenced.
264 ;; foo.c(3:8) : warning EDC0833: Implicit return statement encountered.
265 ;; foo.c(5:5) : error EDC0350: Syntax error.
266 ("\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) : " 1 2 3)
268 ;; IAR Systems C Compiler:
269 ;; "foo.c",3 Error[32]: Error message
270 ;; "foo.c",3 Warning[32]: Error message
271 ("\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(Error\\|Warning\\)\\[[0-9]+\\]:" 1 2)
273 ;; Sun ada (VADS, Solaris):
274 ;; /home3/xdhar/rcds_rc/main.a, line 361, char 6:syntax error: "," inserted
275 ("\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
278 ;; syntax error at automake line 922, near "':'"
279 (".* at \\([^ ]+\\) line \\([0-9]+\\)," 1 2)
282 ;; Semantic error at line 528, column 5, file erosacqdb.pc:
283 ("Semantic error at line \\([0-9]+\\), column \\([0-9]+\\), file \\(.*\\):"
287 ;; Error 24 at (2:progran.f90) : syntax error
288 ("Error [0-9]+ at (\\([0-9]*\\):\\([^)\n]+\\))" 2 1)
290 "Alist that specifies how to match errors in compiler output.
291 Each elt has the form (REGEXP FILE-IDX LINE-IDX [COLUMN-IDX FILE-FORMAT...])
292 If REGEXP matches, the FILE-IDX'th subexpression gives the file name, and
293 the LINE-IDX'th subexpression gives the line number. If COLUMN-IDX is
294 given, the COLUMN-IDX'th subexpression gives the column number on that line.
295 If any FILE-FORMAT is given, each is a format string to produce a file name to
296 try; %s in the string is replaced by the text matching the FILE-IDX'th
299 (defvar compilation-enter-directory-regexp-alist
301 ;; Matches lines printed by the `-w' option of GNU Make.
302 (".*: Entering directory `\\(.*\\)'$" 1)
304 "Alist specifying how to match lines that indicate a new current directory.
305 Note that the match is done at the beginning of lines.
306 Each elt has the form (REGEXP IDX).
307 If REGEXP matches, the IDX'th subexpression gives the directory name.
309 The default value matches lines printed by the `-w' option of GNU Make.")
311 (defvar compilation-leave-directory-regexp-alist
313 ;; Matches lines printed by the `-w' option of GNU Make.
314 (".*: Leaving directory `\\(.*\\)'$" 1)
316 "Alist specifying how to match lines that indicate restoring current directory.
317 Note that the match is done at the beginning of lines.
318 Each elt has the form (REGEXP IDX).
319 If REGEXP matches, the IDX'th subexpression gives the name of the directory
320 being moved from. If IDX is nil, the last directory entered \(by a line
321 matching `compilation-enter-directory-regexp-alist'\) is assumed.
323 The default value matches lines printed by the `-w' option of GNU Make.")
325 (defvar compilation-file-regexp-alist
327 ;; This matches entries with date time year file-name: like
328 ;; Thu May 14 10:46:12 1992 mom3.p:
329 ("\\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)
331 "Alist specifying how to match lines that indicate a new current file.
332 Note that the match is done at the beginning of lines.
333 Each elt has the form (REGEXP IDX).
334 If REGEXP matches, the IDX'th subexpression gives the file name. This is
335 used with compilers that don't indicate file name in every error message.")
337 ;; There is no generally useful regexp that will match non messages, but
338 ;; in special cases there might be one. The lines that are not matched by
339 ;; a regexp take much longer time than the ones that are recognized so if
340 ;; you have same regexeps here, parsing is faster.
341 (defvar compilation-nomessage-regexp-alist
344 "Alist specifying how to match lines that have no message.
345 Note that the match is done at the beginning of lines.
346 Each elt has the form (REGEXP). This alist is by default empty, but if
347 you have some good regexps here, the parsing of messages will be faster.")
349 (defcustom compilation-read-command t
350 "*If not nil, M-x compile reads the compilation command to use.
351 Otherwise, M-x compile just uses the value of `compile-command'."
355 (defcustom compilation-ask-about-save t
356 "*If not nil, M-x compile asks which buffers to save before compiling.
357 Otherwise, it saves all modified buffers without asking."
361 (defvar grep-regexp-alist
362 '(("\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]" 1 2))
363 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
365 ;; The system null device. (Should reference NULL_DEVICE from C.)
366 (defvar grep-null-device "/dev/null" "The system null device.")
369 ;; Currently zgrep has trouble. It runs egrep instead of grep,
370 ;; and it doesn't pass along long options right.
372 ;;; (if (equal (condition-case nil ; in case "zgrep" isn't in exec-path
373 ;;; (call-process "zgrep" nil nil nil
374 ;;; "foo" grep-null-device)
379 "The default grep program for `grep-command' and `grep-find-command'.")
381 ;; Use -e if grep supports it,
382 ;; because that avoids lossage if the pattern starts with `-'.
384 (if (equal (condition-case nil ; in case "grep" isn't in exec-path
385 (call-process grep-program nil nil nil
386 "-e" "foo" grep-null-device)
389 (format "%s -n -e " grep-program)
390 (format "%s -n " grep-program))
391 "The default grep command for \\[grep].")
393 (defvar grep-find-use-xargs
394 (if (equal (call-process "find" nil nil nil
395 grep-null-device "-print0")
398 "Whether \\[grep-find] uses the `xargs' utility by default.
400 If nil, it uses `grep -exec'; if `gnu', it uses `find -print0' and `xargs -0';
401 if not nil and not `gnu', it uses `find -print' and `xargs'.
403 This variable's value takes effect when `compile.el' is loaded
404 by influencing the default value for the variable `grep-find-command'.")
406 (defvar grep-find-command
407 (cond ((eq grep-find-use-xargs 'gnu)
408 (format "find . -type f -print0 | xargs -0 -e %s" grep-command))
410 (format "find . -type f -print | xargs %s" grep-command))
411 (t (cons (format "find . -type f -exec %s {} /dev/null \\;"
413 (+ 22 (length grep-command)))))
414 "The default find command for \\[grep-find].")
417 (defcustom compilation-search-path '(nil)
418 "*List of directories to search for source files named in error messages.
419 Elements should be directory names, not file names of directories.
420 nil as an element means to try the default directory."
421 :type '(repeat (choice (const :tag "Default" nil)
422 (string :tag "Directory")))
425 (defcustom compile-command "make -k "
426 "*Last shell command used to do a compilation; default for next compilation.
428 Sometimes it is useful for files to supply local values for this variable.
429 You might also use mode hooks to specify it in certain modes, like this:
431 (add-hook 'c-mode-hook
434 (unless (or (file-exists-p \"makefile\")
435 (file-exists-p \"Makefile\"))
436 (make-local-variable 'compile-command)
437 (setq compile-command
439 (file-name-sans-extension buffer-file-name)))))))"
443 (defvar compilation-directory-stack nil
444 "Stack of previous directories for `compilation-leave-directory-regexp'.
445 The head element is the directory the compilation was started in.")
447 (defvar compilation-exit-message-function nil "\
448 If non-nil, called when a compilation process dies to return a status message.
449 This should be a function of three arguments: process status, exit status,
450 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
451 write into the compilation buffer, and to put in its mode line.")
453 ;; History of compile commands.
454 (defvar compile-history nil)
455 ;; History of grep commands.
456 (defvar grep-history nil)
457 (defvar grep-find-history nil)
459 (defun compilation-mode-font-lock-keywords ()
460 "Return expressions to highlight in Compilation mode."
463 ;; Compiler warning/error lines.
466 ;; Prepend "^", adjusting FILE-IDX and LINE-IDX accordingly.
467 (let ((file-idx (nth 1 item)) (line-idx (nth 2 item)) keyword)
468 (when (numberp line-idx)
470 (cons (list (1+ line-idx) 'font-lock-variable-name-face)
472 (when (numberp file-idx)
474 (cons (list (1+ file-idx) 'font-lock-warning-face)
476 (cons (concat "^\\(" (nth 0 item) "\\)") keyword))))
477 compilation-error-regexp-alist)
480 ;; Compiler output lines. Recognize `make[n]:' lines too.
481 '("^\\([A-Za-z_0-9/\.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
482 (1 font-lock-function-name-face) (3 font-lock-comment-face nil t)))
486 (defun compile (command)
487 "Compile the program including the current buffer. Default: run `make'.
488 Runs COMMAND, a shell command, in a separate process asynchronously
489 with output going to the buffer `*compilation*'.
491 You can then use the command \\[next-error] to find the next error message
492 and move to the source code that caused it.
494 Interactively, prompts for the command if `compilation-read-command' is
495 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
497 To run more than one compilation at once, start one and rename the
498 \`*compilation*' buffer to some other name with \\[rename-buffer].
499 Then start the next one.
501 The name used for the buffer is actually whatever is returned by
502 the function in `compilation-buffer-name-function', so you can set that
503 to a function that generates a unique name."
505 (if (or compilation-read-command current-prefix-arg)
506 (list (read-from-minibuffer "Compile command: "
507 compile-command nil nil
508 '(compile-history . 1)))
509 (list compile-command)))
510 (setq compile-command command)
511 (save-some-buffers (not compilation-ask-about-save) nil)
512 (compile-internal compile-command "No more errors"))
514 ;;; run compile with the default command line
516 "Re-compile the program including the current buffer."
518 (save-some-buffers (not compilation-ask-about-save) nil)
519 (compile-internal compile-command "No more errors"))
521 (defun grep-process-setup ()
522 "Set up `compilation-exit-message-function' for `grep'."
523 (set (make-local-variable 'compilation-exit-message-function)
524 (lambda (status code msg)
525 (if (eq status 'exit)
527 '("finished (matches found)\n" . "matched"))
529 '("finished with no matches found\n" . "no match"))
535 (defun grep (command-args)
536 "Run grep, with user-specified args, and collect output in a buffer.
537 While grep runs asynchronously, you can use the \\[next-error] command
538 to find the text that grep hits refer to.
540 This command uses a special history list for its arguments, so you can
541 easily repeat a grep command."
543 (list (read-from-minibuffer "Run grep (like this): "
544 grep-command nil nil 'grep-history)))
545 ;; Setting process-setup-function makes exit-message-function work
546 ;; even when async processes aren't supported.
547 (let* ((compilation-process-setup-function 'grep-process-setup)
548 (buf (compile-internal (if grep-null-device
549 (concat command-args " " grep-null-device)
551 "No more grep hits" "grep"
552 ;; Give it a simpler regexp to match.
553 nil grep-regexp-alist)))))
557 (defun grep-find (command-args)
558 "Run grep via find, with user-specified args, and collect output in a buffer.
559 While find runs asynchronously, you can use the \\[next-error] command
560 to find the text that grep hits refer to.
562 This command uses a special history list for its arguments, so you can
563 easily repeat a find command."
565 (list (read-from-minibuffer "Run find (like this): "
566 grep-find-command nil nil 'grep-find-history)))
567 (let ((grep-null-device nil)) ; see grep
568 (grep command-args)))
570 (defun compile-internal (command error-message
571 &optional name-of-mode parser
572 error-regexp-alist name-function
573 enter-regexp-alist leave-regexp-alist
574 file-regexp-alist nomessage-regexp-alist)
575 "Run compilation command COMMAND (low level interface).
576 ERROR-MESSAGE is a string to print if the user asks to see another error
577 and there are no more errors. The rest of the arguments, 3-10 are optional.
578 For them nil means use the default.
579 NAME-OF-MODE is the name to display as the major mode in the compilation
580 buffer. PARSER is the error parser function. ERROR-REGEXP-ALIST is the error
581 message regexp alist to use. NAME-FUNCTION is a function called to name the
582 buffer. ENTER-REGEXP-ALIST is the enter directory message regexp alist to use.
583 LEAVE-REGEXP-ALIST is the leave directory message regexp alist to use.
584 FILE-REGEXP-ALIST is the change current file message regexp alist to use.
585 NOMESSAGE-REGEXP-ALIST is the nomessage regexp alist to use.
586 The defaults for these variables are the global values of
587 \`compilation-parse-errors-function', `compilation-error-regexp-alist',
588 \`compilation-buffer-name-function', `compilation-enter-directory-regexp-alist',
589 \`compilation-leave-directory-regexp-alist', `compilation-file-regexp-alist',
590 \ and `compilation-nomessage-regexp-alist', respectively.
591 For arg 7-10 a value `t' means an empty alist.
593 Returns the compilation buffer created."
597 (setq name-of-mode "Compilation"))
600 (funcall (or name-function compilation-buffer-name-function
601 (function (lambda (mode)
602 (concat "*" (downcase mode) "*"))))
605 (let ((comp-proc (get-buffer-process (current-buffer))))
607 (if (or (not (eq (process-status comp-proc) 'run))
609 (format "A %s process is running; kill it? "
613 (interrupt-process comp-proc)
615 (delete-process comp-proc))
617 (error "Cannot have two processes in `%s' at once"
620 ;; In case the compilation buffer is current, make sure we get the global
621 ;; values of compilation-error-regexp-alist, etc.
622 (kill-all-local-variables))
623 (or error-regexp-alist
624 (setq error-regexp-alist compilation-error-regexp-alist))
625 (or enter-regexp-alist
626 (setq enter-regexp-alist compilation-enter-directory-regexp-alist))
627 (or leave-regexp-alist
628 (setq leave-regexp-alist compilation-leave-directory-regexp-alist))
629 (or file-regexp-alist
630 (setq file-regexp-alist compilation-file-regexp-alist))
631 (or nomessage-regexp-alist
632 (setq nomessage-regexp-alist compilation-nomessage-regexp-alist))
633 (or parser (setq parser compilation-parse-errors-function))
634 (let ((thisdir default-directory)
637 ;; Clear out the compilation buffer and make it writable.
638 ;; Change its default-directory to the directory where the compilation
639 ;; will happen, and insert a `cd' command to indicate this.
641 (setq buffer-read-only nil)
642 (buffer-disable-undo (current-buffer))
644 (buffer-enable-undo (current-buffer))
645 (setq default-directory thisdir)
646 (insert "cd " thisdir "\n" command "\n")
647 (set-buffer-modified-p nil))
648 ;; If we're already in the compilation buffer, go to the end
649 ;; of the buffer, so point will track the compilation output.
650 (if (eq outbuf (current-buffer))
651 (goto-char (point-max)))
652 ;; Pop up the compilation buffer.
653 (setq outwin (display-buffer outbuf))
657 ;; (setq buffer-read-only t) ;;; Non-ergonomic.
658 (set (make-local-variable 'compilation-parse-errors-function) parser)
659 (set (make-local-variable 'compilation-error-message) error-message)
660 (set (make-local-variable 'compilation-error-regexp-alist)
662 (set (make-local-variable 'compilation-enter-directory-regexp-alist)
664 (set (make-local-variable 'compilation-leave-directory-regexp-alist)
666 (set (make-local-variable 'compilation-file-regexp-alist)
668 (set (make-local-variable 'compilation-nomessage-regexp-alist)
669 nomessage-regexp-alist)
670 (set (make-local-variable 'compilation-arguments)
671 (list command error-message
673 error-regexp-alist name-function
674 enter-regexp-alist leave-regexp-alist
675 file-regexp-alist nomessage-regexp-alist))
676 (setq default-directory thisdir
677 compilation-directory-stack (list default-directory))
678 (set-window-start outwin (point-min))
679 (setq mode-name name-of-mode)
680 (or (eq outwin (selected-window))
681 (set-window-point outwin (point-min)))
682 (compilation-set-window-height outwin)
683 (if compilation-process-setup-function
684 (funcall compilation-process-setup-function))
685 ;; Start the compilation.
686 (if (fboundp 'start-process)
687 (let* ((process-environment (cons "EMACS=t" process-environment))
688 (proc (start-process-shell-command (downcase mode-name)
691 (set-process-sentinel proc 'compilation-sentinel)
692 (set-process-filter proc 'compilation-filter)
693 (set-marker (process-mark proc) (point) outbuf)
694 (setq compilation-in-progress
695 (cons proc compilation-in-progress)))
696 ;; No asynchronous processes available.
697 (message "Executing `%s'..." command)
698 ;; Fake modeline display as if `start-process' were run.
699 (setq mode-line-process ":run")
700 (force-mode-line-update)
701 (sit-for 0) ; Force redisplay
702 (let ((status (call-process shell-file-name nil outbuf nil "-c"
704 (cond ((numberp status)
705 (compilation-handle-exit 'exit status
709 exited abnormally with code %d\n"
712 (compilation-handle-exit 'signal status
713 (concat status "\n")))
715 (compilation-handle-exit 'bizarre status status))))
716 (message "Executing `%s'...done" command))))
717 ;; Make it so the next C-x ` will use this buffer.
718 (setq compilation-last-buffer outbuf)))
720 ;; Set the height of WINDOW according to compilation-window-height.
721 (defun compilation-set-window-height (window)
722 (and compilation-window-height
723 (= (window-width window) (frame-width (window-frame window)))
724 ;; If window is alone in its frame, aside from a minibuffer,
725 ;; don't change its height.
726 (not (eq window (frame-root-window (window-frame window))))
727 ;; This save-excursion prevents us from changing the current buffer,
728 ;; which might not be the same as the selected window's buffer.
730 (let ((w (selected-window)))
733 (select-window window)
734 (enlarge-window (- compilation-window-height
736 (select-window w))))))
738 (defvar compilation-minor-mode-map
739 (let ((map (make-sparse-keymap)))
740 (define-key map [mouse-2] 'compile-mouse-goto-error)
741 (define-key map "\C-c\C-c" 'compile-goto-error)
742 (define-key map "\C-m" 'compile-goto-error)
743 (define-key map "\C-c\C-k" 'kill-compilation)
744 (define-key map "\M-n" 'compilation-next-error)
745 (define-key map "\M-p" 'compilation-previous-error)
746 (define-key map "\M-{" 'compilation-previous-file)
747 (define-key map "\M-}" 'compilation-next-file)
749 "Keymap for `compilation-minor-mode'.")
751 (defvar compilation-shell-minor-mode-map
752 (let ((map (make-sparse-keymap)))
753 (define-key map [mouse-2] 'compile-mouse-goto-error)
754 (define-key map "\M-\C-m" 'compile-goto-error)
755 (define-key map "\M-\C-n" 'compilation-next-error)
756 (define-key map "\M-\C-p" 'compilation-previous-error)
757 (define-key map "\M-{" 'compilation-previous-file)
758 (define-key map "\M-}" 'compilation-next-file)
759 ;; Set up the menu-bar
760 (define-key map [menu-bar errors-menu]
761 (cons "Errors" (make-sparse-keymap "Errors")))
762 (define-key map [menu-bar errors-menu stop-subjob]
763 '("Stop" . comint-interrupt-subjob))
764 (define-key map [menu-bar errors-menu compilation-mode-separator2]
766 (define-key map [menu-bar errors-menu compilation-mode-first-error]
767 '("First Error" . first-error))
768 (define-key map [menu-bar errors-menu compilation-mode-previous-error]
769 '("Previous Error" . previous-error))
770 (define-key map [menu-bar errors-menu compilation-mode-next-error]
771 '("Next Error" . next-error))
773 "Keymap for `compilation-shell-minor-mode'.")
775 (defvar compilation-mode-map
776 (let ((map (cons 'keymap compilation-minor-mode-map)))
777 (define-key map " " 'scroll-up)
778 (define-key map "\^?" 'scroll-down)
779 ;; Set up the menu-bar
780 (define-key map [menu-bar compilation-menu]
781 (cons "Compile" (make-sparse-keymap "Compile")))
783 (define-key map [menu-bar compilation-menu compilation-mode-kill-compilation]
784 '("Stop Compilation" . kill-compilation))
785 (define-key map [menu-bar compilation-menu compilation-mode-separator2]
787 (define-key map [menu-bar compilation-menu compilation-mode-first-error]
788 '("First Error" . first-error))
789 (define-key map [menu-bar compilation-menu compilation-mode-previous-error]
790 '("Previous Error" . previous-error))
791 (define-key map [menu-bar compilation-menu compilation-mode-next-error]
792 '("Next Error" . next-error))
793 (define-key map [menu-bar compilation-menu compilation-separator2]
795 (define-key map [menu-bar compilation-menu compilation-mode-grep]
797 (define-key map [menu-bar compilation-menu compilation-mode-recompile]
798 '("Recompile" . recompile))
799 (define-key map [menu-bar compilation-menu compilation-mode-compile]
800 '("Compile..." . compile))
802 "Keymap for compilation log buffers.
803 `compilation-minor-mode-map' is a cdr of this.")
805 (put 'compilation-mode 'mode-class 'special)
808 (defun compilation-mode ()
809 "Major mode for compilation log buffers.
810 \\<compilation-mode-map>To visit the source for a line-numbered error,
811 move point to the error message line and type \\[compile-goto-error].
812 To kill the compilation, type \\[kill-compilation].
814 Runs `compilation-mode-hook' with `run-hooks' (which see)."
816 (kill-all-local-variables)
817 (use-local-map compilation-mode-map)
818 (setq major-mode 'compilation-mode
819 mode-name "Compilation")
821 (set (make-local-variable 'font-lock-defaults)
822 '(compilation-mode-font-lock-keywords t))
823 (set (make-local-variable 'revert-buffer-function)
824 'compilation-revert-buffer)
825 (run-hooks 'compilation-mode-hook))
827 (defun compilation-revert-buffer (ignore-auto noconfirm)
828 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
829 (apply 'compile-internal compilation-arguments)))
831 ;; Prepare the buffer for the compilation parsing commands to work.
832 (defun compilation-setup ()
833 ;; Make the buffer's mode line show process state.
834 (setq mode-line-process '(":%s"))
835 (set (make-local-variable 'compilation-error-list) nil)
836 (set (make-local-variable 'compilation-old-error-list) nil)
837 (set (make-local-variable 'compilation-parsing-end) 1)
838 (set (make-local-variable 'compilation-directory-stack) nil)
839 (setq compilation-last-buffer (current-buffer)))
841 (defvar compilation-shell-minor-mode nil
842 "Non-nil when in compilation-shell-minor-mode.
843 In this minor mode, all the error-parsing commands of the
844 Compilation major mode are available but bound to keys that don't
845 collide with Shell mode.")
846 (make-variable-buffer-local 'compilation-shell-minor-mode)
848 (or (assq 'compilation-shell-minor-mode minor-mode-alist)
849 (setq minor-mode-alist
850 (cons '(compilation-shell-minor-mode " Shell-Compile")
852 (or (assq 'compilation-shell-minor-mode minor-mode-map-alist)
853 (setq minor-mode-map-alist (cons (cons 'compilation-shell-minor-mode
854 compilation-shell-minor-mode-map)
855 minor-mode-map-alist)))
857 (defvar compilation-minor-mode nil
858 "Non-nil when in compilation-minor-mode.
859 In this minor mode, all the error-parsing commands of the
860 Compilation major mode are available.")
861 (make-variable-buffer-local 'compilation-minor-mode)
863 (or (assq 'compilation-minor-mode minor-mode-alist)
864 (setq minor-mode-alist (cons '(compilation-minor-mode " Compilation")
866 (or (assq 'compilation-minor-mode minor-mode-map-alist)
867 (setq minor-mode-map-alist (cons (cons 'compilation-minor-mode
868 compilation-minor-mode-map)
869 minor-mode-map-alist)))
872 (defun compilation-minor-mode (&optional arg)
873 "Toggle compilation minor mode.
874 With arg, turn compilation mode on if and only if arg is positive.
875 See `compilation-mode'.
876 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
878 (if (setq compilation-minor-mode (if (null arg)
879 (null compilation-minor-mode)
880 (> (prefix-numeric-value arg) 0)))
883 (run-hooks 'compilation-minor-mode-hook))))
885 ;; Write msg in the current buffer and hack its mode-line-process.
886 (defun compilation-handle-exit (process-status exit-status msg)
887 (let ((buffer-read-only nil)
888 (status (if compilation-exit-message-function
889 (funcall compilation-exit-message-function
890 process-status exit-status msg)
891 (cons msg exit-status)))
894 ;; Record where we put the message, so we can ignore it
897 (insert ?\n mode-name " " (car status))
899 (insert " at " (substring (current-time-string) 0 19))
901 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
902 ;; Force mode line redisplay soon.
903 (force-mode-line-update)
904 (if (and opoint (< opoint omax))
906 ;; Automatically parse (and mouse-highlight) error messages:
907 (cond ((eq compile-auto-highlight t)
908 (compile-reinitialize-errors nil (point-max)))
909 ((numberp compile-auto-highlight)
910 (compile-reinitialize-errors nil
912 (goto-line compile-auto-highlight)
914 (if compilation-finish-function
915 (funcall compilation-finish-function (current-buffer) msg))
916 (let ((functions compilation-finish-functions))
918 (funcall (car functions) (current-buffer) msg)
919 (setq functions (cdr functions))))))
921 ;; Called when compilation process changes state.
922 (defun compilation-sentinel (proc msg)
923 "Sentinel for compilation buffers."
924 (let ((buffer (process-buffer proc)))
925 (if (memq (process-status proc) '(signal exit))
927 (if (null (buffer-name buffer))
929 (set-process-buffer proc nil)
930 (let ((obuf (current-buffer)))
931 ;; save-excursion isn't the right thing if
932 ;; process-buffer is current-buffer
935 ;; Write something in the compilation buffer
936 ;; and hack its mode line.
938 (compilation-handle-exit (process-status proc)
939 (process-exit-status proc)
941 ;; Since the buffer and mode line will show that the
942 ;; process is dead, we can delete it now. Otherwise it
943 ;; will stay around until M-x list-processes.
944 (delete-process proc))
946 (setq compilation-in-progress (delq proc compilation-in-progress))
949 (defun compilation-filter (proc string)
950 "Process filter for compilation buffers.
951 Just inserts the text, but uses `insert-before-markers'."
952 (if (buffer-name (process-buffer proc))
954 (set-buffer (process-buffer proc))
955 (let ((buffer-read-only nil))
957 (goto-char (process-mark proc))
958 (insert-before-markers string)
959 (run-hooks 'compilation-filter-hook)
960 (set-marker (process-mark proc) (point)))))))
962 ;; Return the cdr of compilation-old-error-list for the error containing point.
963 (defun compile-error-at-point ()
964 (compile-reinitialize-errors nil (point))
965 (let ((errors compilation-old-error-list))
967 (> (point) (car (car errors))))
968 (setq errors (cdr errors)))
971 (defsubst compilation-buffer-p (buffer)
974 (or compilation-shell-minor-mode compilation-minor-mode
975 (eq major-mode 'compilation-mode))))
977 (defun compilation-next-error (n)
978 "Move point to the next error in the compilation buffer.
979 Does NOT find the source line like \\[next-error]."
981 (or (compilation-buffer-p (current-buffer))
982 (error "Not in a compilation buffer."))
983 (setq compilation-last-buffer (current-buffer))
985 (let ((errors (compile-error-at-point)))
987 ;; Move to the error after the one containing point.
988 (goto-char (car (if (< n 0)
990 (e compilation-old-error-list))
991 ;; See how many cdrs away ERRORS is from the start.
992 (while (not (eq e errors))
996 (error "Moved back past first error")
997 (nth (+ i n) compilation-old-error-list)))
998 (let ((compilation-error-list (cdr errors)))
999 (compile-reinitialize-errors nil nil n)
1000 (if compilation-error-list
1001 (nth (1- n) compilation-error-list)
1002 (error "Moved past last error"))))))))
1004 (defun compilation-previous-error (n)
1005 "Move point to the previous error in the compilation buffer.
1006 Does NOT find the source line like \\[next-error]."
1008 (compilation-next-error (- n)))
1011 ;; Given an elt of `compilation-error-list', return an object representing
1012 ;; the referenced file which is equal to (but not necessarily eq to) what
1013 ;; this function would return for another error in the same file.
1014 (defsubst compilation-error-filedata (data)
1015 (setq data (cdr data))
1017 (marker-buffer data)
1020 ;; Return a string describing a value from compilation-error-filedata.
1021 ;; This value is not necessarily useful as a file name, but should be
1022 ;; indicative to the user of what file's errors are being referred to.
1023 (defsubst compilation-error-filedata-file-name (filedata)
1024 (if (bufferp filedata)
1025 (buffer-file-name filedata)
1028 (defun compilation-next-file (n)
1029 "Move point to the next error for a different file than the current one."
1031 (or (compilation-buffer-p (current-buffer))
1032 (error "Not in a compilation buffer."))
1033 (setq compilation-last-buffer (current-buffer))
1035 (let ((reversed (< n 0))
1039 (setq errors (or (compile-error-at-point)
1040 (error "Moved past last error")))
1042 ;; Get a reversed list of the errors up through the one containing point.
1043 (compile-reinitialize-errors nil (point))
1044 (setq errors (reverse compilation-old-error-list)
1047 ;; Ignore errors after point. (car ERRORS) will be the error
1048 ;; containing point, (cadr ERRORS) the one before it.
1050 (< (point) (car (car errors))))
1051 (setq errors (cdr errors))))
1054 (setq filedata (compilation-error-filedata (car errors)))
1056 ;; Skip past the following errors for this file.
1057 (while (equal filedata
1058 (compilation-error-filedata
1061 (error "%s the first erring file"
1062 (compilation-error-filedata-file-name
1064 (let ((compilation-error-list nil))
1066 (compile-reinitialize-errors nil nil 2)
1067 (setq errors compilation-error-list)))
1068 (error "%s is the last erring file"
1069 (compilation-error-filedata-file-name
1071 (setq errors (cdr errors)))
1075 ;; Move to the following error.
1076 (goto-char (car (car (or errors
1078 (error "This is the first erring file")
1079 (let ((compilation-error-list nil))
1080 ;; Parse the last one.
1081 (compile-reinitialize-errors nil nil 1)
1082 compilation-error-list))))))))
1084 (defun compilation-previous-file (n)
1085 "Move point to the previous error for a different file than the current one."
1087 (compilation-next-file (- n)))
1090 (defun kill-compilation ()
1091 "Kill the process made by the \\[compile] command."
1093 (let ((buffer (compilation-find-buffer)))
1094 (if (get-buffer-process buffer)
1095 (interrupt-process (get-buffer-process buffer))
1096 (error "The compilation process is not running."))))
1099 ;; Parse any new errors in the compilation buffer,
1100 ;; or reparse from the beginning if the user has asked for that.
1101 (defun compile-reinitialize-errors (reparse
1102 &optional limit-search find-at-least)
1104 (set-buffer compilation-last-buffer)
1105 ;; If we are out of errors, or if user says "reparse",
1106 ;; discard the info we have, to force reparsing.
1107 (if (or (eq compilation-error-list t)
1109 (compilation-forget-errors))
1110 (if (and compilation-error-list
1111 (or (not limit-search)
1112 (> compilation-parsing-end limit-search))
1113 (or (not find-at-least)
1114 (>= (length compilation-error-list) find-at-least)))
1115 ;; Since compilation-error-list is non-nil, it points to a specific
1116 ;; error the user wanted. So don't move it around.
1118 ;; This was here for a long time (before my rewrite); why? --roland
1119 ;;(switch-to-buffer compilation-last-buffer)
1120 (set-buffer-modified-p nil)
1121 (if (< compilation-parsing-end (point-max))
1122 ;; compilation-error-list might be non-nil if we have a non-nil
1123 ;; LIMIT-SEARCH or FIND-AT-LEAST arg. In that case its value
1124 ;; records the current position in the error list, and we must
1125 ;; preserve that after reparsing.
1126 (let ((error-list-pos compilation-error-list))
1127 (funcall compilation-parse-errors-function
1130 ;; We only need enough new parsed errors to reach
1131 ;; FIND-AT-LEAST errors past the current
1133 (- find-at-least (length compilation-error-list))))
1134 ;; Remember the entire list for compilation-forget-errors. If
1135 ;; this is an incremental parse, append to previous list. If
1136 ;; we are parsing anew, compilation-forget-errors cleared
1137 ;; compilation-old-error-list above.
1138 (setq compilation-old-error-list
1139 (nconc compilation-old-error-list compilation-error-list))
1141 ;; We started in the middle of an existing list of parsed
1142 ;; errors before parsing more; restore that position.
1143 (setq compilation-error-list error-list-pos))
1144 ;; Mouse-Highlight (the first line of) each error message when the
1145 ;; mouse pointer moves over it:
1146 (let ((inhibit-read-only t)
1147 (error-list compilation-error-list))
1150 (put-text-property (goto-char (car (car error-list)))
1151 (progn (end-of-line) (point))
1152 'mouse-face 'highlight))
1153 (setq error-list (cdr error-list))))
1156 (defun compile-mouse-goto-error (event)
1159 (set-buffer (window-buffer (posn-window (event-end event))))
1160 (goto-char (posn-point (event-end event)))
1162 (or (compilation-buffer-p (current-buffer))
1163 (error "Not in a compilation buffer."))
1164 (setq compilation-last-buffer (current-buffer))
1165 ;; `compile-reinitialize-errors' needs to see the complete filename
1166 ;; on the line where they clicked the mouse. Since it only looks
1167 ;; up to point, moving point to eol makes sure the filename is
1168 ;; visible to `compile-reinitialize-errors'.
1170 (compile-reinitialize-errors nil (point))
1172 ;; Move to bol; the marker for the error on this line will point there.
1175 ;; Move compilation-error-list to the elt of compilation-old-error-list
1177 (setq compilation-error-list compilation-old-error-list)
1178 (while (and compilation-error-list
1179 (> (point) (car (car compilation-error-list))))
1180 (setq compilation-error-list (cdr compilation-error-list)))
1181 (or compilation-error-list
1182 (error "No error to go to")))
1183 (select-window (posn-window (event-end event)))
1184 ;; Move to another window, so that next-error's window changes
1185 ;; result in the desired setup.
1189 ;; other-window changed the selected buffer,
1190 ;; but we didn't want to do that.
1191 (set-buffer compilation-last-buffer)))
1196 (defun compile-goto-error (&optional argp)
1197 "Visit the source for the error message point is on.
1198 Use this command in a compilation log buffer. Sets the mark at point there.
1199 \\[universal-argument] as a prefix arg means to reparse the buffer's error messages first;
1200 other kinds of prefix arguments are ignored."
1202 (or (compilation-buffer-p (current-buffer))
1203 (error "Not in a compilation buffer."))
1204 (setq compilation-last-buffer (current-buffer))
1205 (compile-reinitialize-errors (consp argp) (point))
1207 ;; Move to bol; the marker for the error on this line will point there.
1210 ;; Move compilation-error-list to the elt of compilation-old-error-list
1212 (setq compilation-error-list compilation-old-error-list)
1213 (while (and compilation-error-list
1214 (> (point) (car (car compilation-error-list))))
1215 (setq compilation-error-list (cdr compilation-error-list)))
1217 ;; Move to another window, so that next-error's window changes
1218 ;; result in the desired setup.
1222 ;; other-window changed the selected buffer,
1223 ;; but we didn't want to do that.
1224 (set-buffer compilation-last-buffer)))
1229 ;; Return a compilation buffer.
1230 ;; If the current buffer is a compilation buffer, return it.
1231 ;; If compilation-last-buffer is set to a live buffer, use that.
1232 ;; Otherwise, look for a compilation buffer and signal an error
1233 ;; if there are none.
1234 (defun compilation-find-buffer (&optional other-buffer)
1235 (if (and (not other-buffer)
1236 (compilation-buffer-p (current-buffer)))
1237 ;; The current buffer is a compilation buffer.
1239 (if (and compilation-last-buffer (buffer-name compilation-last-buffer)
1240 (compilation-buffer-p compilation-last-buffer)
1241 (or (not other-buffer) (not (eq compilation-last-buffer
1242 (current-buffer)))))
1243 compilation-last-buffer
1244 (let ((buffers (buffer-list)))
1245 (while (and buffers (or (not (compilation-buffer-p (car buffers)))
1247 (eq (car buffers) (current-buffer)))))
1248 (setq buffers (cdr buffers)))
1251 (or (and other-buffer
1252 (compilation-buffer-p (current-buffer))
1253 ;; The current buffer is a compilation buffer.
1256 (message "This is the only compilation buffer."))
1258 (error "No compilation started!")))))))
1261 (defun next-error (&optional argp)
1262 "Visit next compilation error message and corresponding source code.
1263 This operates on the output from the \\[compile] command.
1264 If all preparsed error messages have been processed,
1265 the error message buffer is checked for new ones.
1267 A prefix arg specifies how many error messages to move;
1268 negative means move back to previous error messages.
1269 Just C-u as a prefix means reparse the error message buffer
1270 and start at the first error.
1272 \\[next-error] normally applies to the most recent compilation started,
1273 but as long as you are in the middle of parsing errors from one compilation
1274 output buffer, you stay with that compilation output buffer.
1276 Use \\[next-error] in a compilation output buffer to switch to
1277 processing errors from that compilation.
1279 See variables `compilation-parse-errors-function' and
1280 \`compilation-error-regexp-alist' for customization ideas."
1282 (setq compilation-last-buffer (compilation-find-buffer))
1283 (compilation-goto-locus (compilation-next-error-locus
1284 ;; We want to pass a number here only if
1285 ;; we got a numeric prefix arg, not just C-u.
1286 (and (not (consp argp))
1287 (prefix-numeric-value argp))
1289 ;;;###autoload (define-key ctl-x-map "`" 'next-error)
1291 (defun previous-error ()
1292 "Visit previous compilation error message and corresponding source code.
1293 This operates on the output from the \\[compile] command."
1297 (defun first-error ()
1298 "Reparse the error message buffer and start at the first error.
1299 Visit corresponding source code.
1300 This operates on the output from the \\[compile] command."
1304 (defvar compilation-skip-to-next-location nil
1305 "*If non-nil, skip multiple error messages for the same source location.")
1307 (defun compilation-next-error-locus (&optional move reparse silent)
1308 "Visit next compilation error and return locus in corresponding source code.
1309 This operates on the output from the \\[compile] command.
1310 If all preparsed error messages have been processed,
1311 the error message buffer is checked for new ones.
1313 Returns a cons (ERROR . SOURCE) of two markers: ERROR is a marker at the
1314 location of the error message in the compilation buffer, and SOURCE is a
1315 marker at the location in the source code indicated by the error message.
1317 Optional first arg MOVE says how many error messages to move forwards (or
1318 backwards, if negative); default is 1. Optional second arg REPARSE, if
1319 non-nil, says to reparse the error message buffer and reset to the first
1320 error (plus MOVE - 1). If optional third argument SILENT is non-nil, return
1321 nil instead of raising an error if there are no more errors.
1323 The current buffer should be the desired compilation output buffer."
1324 (or move (setq move 1))
1325 (compile-reinitialize-errors reparse nil (and (not reparse)
1326 (if (< move 1) 0 (1- move))))
1327 (let (next-errors next-error)
1328 (catch 'no-next-error
1330 (set-buffer compilation-last-buffer)
1331 ;; compilation-error-list points to the "current" error.
1335 compilation-error-list)
1336 ;; Zero or negative arg; we need to move back in the list.
1339 (e compilation-old-error-list))
1340 ;; See how many cdrs away the current error is from the start.
1341 (while (not (eq e compilation-error-list))
1345 (error "Moved back past first error")
1346 (nthcdr (+ i n) compilation-old-error-list))))
1347 next-error (car next-errors))
1349 (if (null next-error)
1351 (and move (/= move 1)
1352 (error (if (> move 0)
1353 "Moved past last error")
1354 "Moved back past first error"))
1355 ;; Forget existing error messages if compilation has finished.
1356 (if (not (and (get-buffer-process (current-buffer))
1361 (compilation-forget-errors))
1363 (throw 'no-next-error nil)
1364 (error (concat compilation-error-message
1365 (and (get-buffer-process (current-buffer))
1371 (setq compilation-error-list (cdr next-errors))
1372 (if (null (cdr next-error))
1373 ;; This error is boring. Go to the next.
1375 (or (markerp (cdr next-error))
1376 ;; This error has a filename/lineno pair.
1377 ;; Find the file and turn it into a marker.
1378 (let* ((fileinfo (car (cdr next-error)))
1379 (buffer (apply 'compilation-find-file
1380 (car next-error) fileinfo)))
1382 ;; We can't find this error's file.
1383 ;; Remove all errors in the same file.
1385 (setq next-errors compilation-old-error-list)
1387 (and (consp (cdr (car next-errors)))
1388 (equal (car (cdr (car next-errors)))
1391 (set-marker (car (car next-errors)) nil)
1392 (setcdr (car next-errors) nil)))
1393 (setq next-errors (cdr next-errors)))
1394 ;; Look for the next error.
1396 ;; We found the file. Get a marker for this error.
1397 ;; compilation-old-error-list is a buffer-local
1398 ;; variable, so we must be careful to extract its value
1399 ;; before switching to the source file buffer.
1400 (let ((errors compilation-old-error-list)
1401 (last-line (nth 1 (cdr next-error)))
1402 (column (nth 2 (cdr next-error))))
1407 (goto-line last-line)
1408 (if (and column (> column 0))
1409 ;; Columns in error msgs are 1-origin.
1410 (move-to-column (1- column))
1411 (beginning-of-line))
1412 (setcdr next-error (point-marker))
1413 ;; Make all the other error messages referring
1414 ;; to the same file have markers into the buffer.
1416 (and (consp (cdr (car errors)))
1417 (equal (car (cdr (car errors))) fileinfo)
1418 (let* ((this (nth 1 (cdr (car errors))))
1419 (column (nth 2 (cdr (car errors))))
1420 (lines (- this last-line)))
1421 (if (eq selective-display t)
1422 ;; When selective-display is t,
1423 ;; each C-m is a line boundary,
1424 ;; as well as each newline.
1426 (re-search-backward "[\n\C-m]"
1429 (re-search-forward "[\n\C-m]"
1432 (forward-line lines))
1433 (if (and column (> column 1))
1434 (move-to-column (1- column))
1435 (beginning-of-line))
1436 (setq last-line this)
1437 (setcdr (car errors) (point-marker))))
1438 (setq errors (cdr errors)))))))))
1439 ;; If we didn't get a marker for this error, or this
1440 ;; marker's buffer was killed, go on to the next one.
1441 (or (not (markerp (cdr next-error)))
1442 (not (marker-buffer (cdr next-error))))))
1443 (setq next-errors compilation-error-list
1444 next-error (car next-errors)))))
1446 (if compilation-skip-to-next-location
1447 ;; Skip over multiple error messages for the same source location,
1448 ;; so the next C-x ` won't go to an error in the same place.
1449 (while (and compilation-error-list
1450 (equal (cdr (car compilation-error-list))
1452 (setq compilation-error-list (cdr compilation-error-list))))
1454 ;; We now have a marker for the position of the error source code.
1455 ;; NEXT-ERROR is a cons (ERROR . SOURCE) of two markers.
1458 (defun compilation-goto-locus (next-error)
1459 "Jump to an error locus returned by `compilation-next-error-locus'.
1460 Takes one argument, a cons (ERROR . SOURCE) of two markers.
1461 Selects a window with point at SOURCE, with another window displaying ERROR."
1462 (if (and (window-dedicated-p (selected-window))
1463 (eq (selected-window) (frame-root-window)))
1464 (switch-to-buffer-other-frame (marker-buffer (cdr next-error)))
1465 (switch-to-buffer (marker-buffer (cdr next-error))))
1466 (goto-char (cdr next-error))
1467 ;; If narrowing got in the way of
1468 ;; going to the right place, widen.
1469 (or (= (point) (marker-position (cdr next-error)))
1472 (goto-char (cdr next-error))))
1474 ;; Show compilation buffer in other window, scrolled to this error.
1475 (let* ((pop-up-windows t)
1476 ;; Use an existing window if it is in a visible frame.
1477 (w (or (get-buffer-window (marker-buffer (car next-error)) 'visible)
1479 (display-buffer (marker-buffer (car next-error))))))
1480 (set-window-point w (car next-error))
1481 (set-window-start w (car next-error))
1482 (compilation-set-window-height w)))
1484 ;; Find a buffer for file FILENAME.
1485 ;; Search the directories in compilation-search-path.
1486 ;; A nil in compilation-search-path means to try the
1487 ;; current directory, which is passed in DIR.
1488 ;; If FILENAME is not found at all, ask the user where to find it.
1489 ;; Pop up the buffer containing MARKER and scroll to MARKER if we ask the user.
1490 (defun compilation-find-file (marker filename dir &rest formats)
1491 (or formats (setq formats '("%s")))
1492 (let ((dirs compilation-search-path)
1493 buffer thisdir fmts name)
1494 (if (file-name-absolute-p filename)
1495 ;; The file name is absolute. Use its explicit directory as
1496 ;; the first in the search path, and strip it from FILENAME.
1497 (setq filename (abbreviate-file-name (expand-file-name filename))
1498 dirs (cons (file-name-directory filename) dirs)
1499 filename (file-name-nondirectory filename)))
1500 ;; Now search the path.
1501 (while (and dirs (null buffer))
1502 (setq thisdir (or (car dirs) dir)
1504 ;; For each directory, try each format string.
1505 (while (and fmts (null buffer))
1506 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1507 buffer (and (file-exists-p name)
1508 (find-file-noselect name))
1510 (setq dirs (cdr dirs)))
1512 ;; The file doesn't exist.
1513 ;; Ask the user where to find it.
1514 ;; If he hits C-g, then the next time he does
1515 ;; next-error, he'll skip past it.
1516 (let* ((pop-up-windows t)
1517 (w (display-buffer (marker-buffer marker))))
1518 (set-window-point w marker)
1519 (set-window-start w marker)
1520 (let ((name (expand-file-name
1522 (format "Find this error in: (default %s) "
1525 (if (file-directory-p name)
1526 (setq name (expand-file-name filename name)))
1527 (and (file-exists-p name)
1528 (find-file-noselect name)))))))
1530 ;; Set compilation-error-list to nil, and unchain the markers that point to the
1531 ;; error messages and their text, so that they no longer slow down gap motion.
1532 ;; This would happen anyway at the next garbage collection, but it is better to
1533 ;; do it right away.
1534 (defun compilation-forget-errors ()
1535 (while compilation-old-error-list
1536 (let ((next-error (car compilation-old-error-list)))
1537 (set-marker (car next-error) nil)
1538 (if (markerp (cdr next-error))
1539 (set-marker (cdr next-error) nil)))
1540 (setq compilation-old-error-list (cdr compilation-old-error-list)))
1541 (setq compilation-error-list nil
1542 compilation-directory-stack nil
1543 compilation-parsing-end 1)
1544 ;; Remove the highlighting added by compile-reinitialize-errors:
1545 (let ((inhibit-read-only t))
1546 (remove-text-properties (point-min) (point-max) '(mouse-face highlight)))
1550 ;; This function is not needed any more by compilation mode.
1551 ;; Does anyone else need it or can it be deleted?
1552 (defun count-regexp-groupings (regexp)
1553 "Return the number of \\( ... \\) groupings in REGEXP (a string)."
1555 (len (length regexp))
1559 (setq c (aref regexp i)
1562 ;; Find the end of this [...].
1563 (while (and (< i len)
1564 (not (= (aref regexp i) ?\])))
1569 (setq c (aref regexp i)
1572 ;; We found the end of a grouping,
1573 ;; so bump our counter.
1574 (setq groupings (1+ groupings))))))))
1577 (defvar compilation-current-file nil
1578 "Used by compilation-parse-errors to store filename for file being compiled")
1580 ;; This variable is not used as a global variable. It's defined here just to
1581 ;; shut up the byte compiler. It's bound and used by compilation-parse-errors
1582 ;; and set by compile-collect-regexps.
1583 (defvar compilation-regexps nil)
1585 (defun compilation-parse-errors (limit-search find-at-least)
1586 "Parse the current buffer as grep, cc, lint or other error messages.
1587 See variable `compilation-parse-errors-function' for the interface it uses."
1588 (setq compilation-error-list nil)
1589 (message "Parsing error messages...")
1590 (if (null compilation-error-regexp-alist)
1591 (error "compilation-error-regexp-alist is empty!"))
1592 (let* ((compilation-regexps nil) ; Variable set by compile-collect-regexps.
1594 (compilation-num-errors-found 0)
1595 ;; Set up now the expanded, abbreviated directory variables
1596 ;; that compile-abbreviate-directory will need, so we can
1597 ;; compute them just once here.
1598 (orig (abbreviate-file-name default-directory))
1599 (orig-expanded (abbreviate-file-name
1600 (file-truename default-directory)))
1601 (parent-expanded (abbreviate-file-name
1602 (expand-file-name "../" orig-expanded))))
1604 ;; Make a list of all the regexps. Each element has the form
1605 ;; (REGEXP TYPE IDX1 IDX2 ...)
1606 ;; where TYPE is one of leave, enter, file, error or nomessage.
1607 (compile-collect-regexps 'leave compilation-leave-directory-regexp-alist)
1608 (compile-collect-regexps 'enter compilation-enter-directory-regexp-alist)
1609 (compile-collect-regexps 'file compilation-file-regexp-alist)
1610 (compile-collect-regexps 'nomessage compilation-nomessage-regexp-alist)
1611 (compile-collect-regexps 'error compilation-error-regexp-alist)
1613 ;; Don't reparse messages already seen at last parse.
1614 (goto-char compilation-parsing-end)
1616 (eq major-mode 'compilation-mode))
1617 (setq compilation-current-file nil) ; No current file at start.
1618 ;; Don't parse the first two lines as error messages.
1619 ;; This matters for grep.
1623 (while (not (or found-desired (eobp)))
1624 (let ((this compilation-regexps) (prev nil) (alist nil) type)
1625 ;; Go through the regular expressions. If a match is found,
1626 ;; variable alist is set to the corresponding alist and the
1627 ;; matching regexp is moved to the front of compilation-regexps
1628 ;; to make it match faster next time.
1629 (while (and this (null alist))
1630 (if (not (looking-at (car (car this))))
1631 (progn (setq prev this) ; No match, go to next.
1632 (setq this (cdr this)))
1633 (setq alist (cdr (car this))) ; Got a match.
1634 ;;; (if prev ; If not the first regexp,
1635 ;;; (progn ; move it to the front.
1636 ;;; (setcdr prev (cdr this))
1637 ;;; (setcdr this compilation-regexps)
1638 ;;; (setq compilation-regexps this)))
1640 (if (and alist ; Seen a match and not to
1641 (not (eq (setq type (car alist)) 'nomessage))) ; be ignored.
1642 (let* ((end-of-match (match-end 0))
1644 (compile-buffer-substring (car (setq alist (cdr alist)))))
1646 (if (eq type 'error) ; error message
1647 (let* ((linenum (if (numberp (car (setq alist (cdr alist))))
1649 (compile-buffer-substring (car alist)))
1650 ;; (car alist) is not a number, must be a
1651 ;; function that is called below to return
1652 ;; an error position descriptor.
1654 ;; Convert to integer later if linenum not a function.
1655 (column (compile-buffer-substring
1656 (car (setq alist (cdr alist)))))
1659 ;; Check that we have a file name.
1661 ;; No file name in message, we must have seen it before
1662 (setq filename compilation-current-file)
1664 An error message with no file name and no file name has been seen earlier."))
1666 ;; Check for a comint-file-name-prefix and prepend it if
1667 ;; appropriate. (This is very useful for
1668 ;; compilation-minor-mode in an rlogin-mode buffer.)
1669 (and (boundp 'comint-file-name-prefix)
1670 ;; If file name is relative, default-directory will
1671 ;; already contain the comint-file-name-prefix (done
1672 ;; by compile-abbreviate-directory).
1673 (file-name-absolute-p filename)
1675 (concat comint-file-name-prefix filename)))
1677 ;; Some compilers (e.g. Sun's java compiler, reportedly)
1678 ;; produce bogus file names like "./bar//foo.c" for file
1679 ;; "bar/foo.c"; expand-file-name will collapse these into
1680 ;; "/foo.c" and fail to find the appropriate file. So we
1681 ;; look for doubled slashes in the file name and fix them
1682 ;; up in the buffer.
1683 (setq filename (command-line-normalize-file-name filename))
1686 (cons filename (cons default-directory (cdr alist))))
1688 ;; Locate the erring file and line.
1689 ;; Make this-error a new elt for compilation-error-list,
1690 ;; giving a marker for the current compilation buffer
1691 ;; location, and the file and line number of the error.
1692 ;; Save, as the start of the error, the beginning of the
1693 ;; line containing the match.
1694 (if (setq this-error
1695 (if (numberp linenum)
1696 (list (point-marker) filename linenum
1697 (and column (string-to-int column)))
1698 ;; If linenum is not a number then it must be
1699 ;; a function returning an error position
1700 ;; descriptor or nil (meaning no position).
1702 (funcall linenum filename column))))
1704 ;; We have an error position descriptor.
1705 ;; If we have found as many new errors as the user
1706 ;; wants, or if we are past the buffer position he
1707 ;; indicated, then we continue to parse until we have
1708 ;; seen all consecutive errors in the same file. This
1709 ;; means that all the errors of a source file will be
1710 ;; seen in one parsing run, so that the error positions
1711 ;; will be recorded as markers in the source file
1712 ;; buffer that will move when the buffer is changed.
1713 (if (and (or (and find-at-least
1714 (>= compilation-num-errors-found
1717 (>= end-of-match limit-search)))
1718 compilation-error-list ;At least one previous.
1719 (not (equal ; Same filename?
1720 (car (cdr (car compilation-error-list)))
1721 (car (cdr this-error)))))
1722 ;; We are past the limits and the last error
1723 ;; parsed, didn't belong to the same source file
1724 ;; as the earlier ones i.e. we have seen all the
1725 ;; errors belonging to the earlier file. We don't
1726 ;; add the error just parsed so that the next
1727 ;; parsing run can get it and the following errors
1728 ;; in the same file all at once.
1729 (setq found-desired t)
1731 (goto-char end-of-match) ; Prepare for next message.
1732 ;; Don't add the same source line more than once.
1734 compilation-error-list
1735 (equal (cdr (car compilation-error-list))
1737 (setq compilation-error-list
1738 (cons this-error compilation-error-list)
1739 compilation-num-errors-found
1740 (1+ compilation-num-errors-found))))))
1742 ;; Not an error message.
1743 (if (eq type `file) ; Change current file.
1744 (and filename (setq compilation-current-file filename))
1745 ;; Enter or leave directory.
1746 (setq stack compilation-directory-stack)
1750 ;; The directory name in the message
1751 ;; is a truename. Try to convert it to a form
1752 ;; like what the user typed in.
1753 (compile-abbreviate-directory
1754 (file-name-as-directory
1755 (expand-file-name filename))
1756 orig orig-expanded parent-expanded)))
1757 (if (eq type 'leave)
1759 (not (string-equal (car stack)
1761 (setq stack (cdr stack)))
1762 (setq compilation-directory-stack
1763 (cons filename compilation-directory-stack)
1764 default-directory filename)))
1765 (and (eq type 'leave)
1767 (setq compilation-directory-stack (cdr stack))
1768 (setq stack (car compilation-directory-stack))
1769 (setq default-directory stack))
1770 (goto-char end-of-match) ; Prepare to look at next message.
1771 (and limit-search (>= end-of-match limit-search)
1772 ;; The user wanted a specific error, and we're past it.
1773 ;; We do this check here rather than at the end of the
1774 ;; loop because if the last thing seen is an error
1775 ;; message, we must carefully discard the last error
1776 ;; when it is the first in a new file (see above in
1777 ;; the error-message case)
1778 (setq found-desired t))))
1780 ;; Go to before the last character in the message so that we will
1781 ;; see the next line also when the message ended at end of line.
1782 ;; When we ignore the last error message above, this will
1783 ;; cancel the effect of forward-line below so that point
1787 ;; Is this message necessary any more? Parsing is now so fast
1788 ;; that you might not need to know how it proceeds.
1790 "Parsing error messages...%d found. %.0f%% of buffer seen."
1791 compilation-num-errors-found
1792 ;; Use floating-point because (* 100 (point)) frequently
1793 ;; exceeds the range of Emacs Lisp integers.
1794 (/ (* 100.0 (point)) (point-max)))
1797 (forward-line 1))) ; End of while loop. Look at next line.
1799 (setq compilation-parsing-end (point))
1800 (setq compilation-error-list (nreverse compilation-error-list))
1801 ;;; (message "Parsing error messages...done. %d found. %.0f%% of buffer seen."
1802 ;;; compilation-num-errors-found
1803 ;;; (/ (* 100.0 (point)) (point-max)))
1804 (message "Parsing error messages...done.")))
1806 (defun compile-collect-regexps (type this)
1807 ;; Add elements to variable compilation-regexps that is bound in
1808 ;; compilation-parse-errors.
1809 (and (not (eq this t))
1811 (setq compilation-regexps
1812 (cons (cons (car (car this)) (cons type (cdr (car this))))
1813 compilation-regexps))
1814 (setq this (cdr this)))))
1816 (defun compile-buffer-substring (index)
1817 ;; Get substring matched by INDEXth subexpression.
1819 (let ((beg (match-beginning index)))
1820 (if beg (buffer-substring beg (match-end index))))))
1822 ;; If directory DIR is a subdir of ORIG or of ORIG's parent,
1823 ;; return a relative name for it starting from ORIG or its parent.
1824 ;; ORIG-EXPANDED is an expanded version of ORIG.
1825 ;; PARENT-EXPANDED is an expanded version of ORIG's parent.
1826 ;; Those two args could be computed here, but we run faster by
1827 ;; having the caller compute them just once.
1828 (defun compile-abbreviate-directory (dir orig orig-expanded parent-expanded)
1829 ;; Apply canonical abbreviations to DIR first thing.
1830 ;; Those abbreviations are already done in the other arguments passed.
1831 (setq dir (abbreviate-file-name dir))
1833 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1834 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1836 (if (boundp 'comint-file-name-prefix)
1837 (setq dir (concat comint-file-name-prefix dir)))
1839 (if (and (> (length dir) (length orig-expanded))
1840 (string= orig-expanded
1841 (substring dir 0 (length orig-expanded))))
1844 (substring dir (length orig-expanded)))))
1845 (if (and (> (length dir) (length parent-expanded))
1846 (string= parent-expanded
1847 (substring dir 0 (length parent-expanded))))
1849 (concat (file-name-directory
1850 (directory-file-name orig))
1851 (substring dir (length parent-expanded)))))
1856 ;;; compile.el ends here