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)
266 "Alist that specifies how to match errors in compiler output.
267 Each elt has the form (REGEXP FILE-IDX LINE-IDX [COLUMN-IDX FILE-FORMAT...])
268 If REGEXP matches, the FILE-IDX'th subexpression gives the file name, and
269 the LINE-IDX'th subexpression gives the line number. If COLUMN-IDX is
270 given, the COLUMN-IDX'th subexpression gives the column number on that line.
271 If any FILE-FORMAT is given, each is a format string to produce a file name to
272 try; %s in the string is replaced by the text matching the FILE-IDX'th
275 (defvar compilation-enter-directory-regexp-alist
277 ;; Matches lines printed by the `-w' option of GNU Make.
278 (".*: Entering directory `\\(.*\\)'$" 1)
280 "Alist specifying how to match lines that indicate a new current directory.
281 Note that the match is done at the beginning of lines.
282 Each elt has the form (REGEXP IDX).
283 If REGEXP matches, the IDX'th subexpression gives the directory name.
285 The default value matches lines printed by the `-w' option of GNU Make.")
287 (defvar compilation-leave-directory-regexp-alist
289 ;; Matches lines printed by the `-w' option of GNU Make.
290 (".*: Leaving directory `\\(.*\\)'$" 1)
292 "Alist specifying how to match lines that indicate restoring current directory.
293 Note that the match is done at the beginning of lines.
294 Each elt has the form (REGEXP IDX).
295 If REGEXP matches, the IDX'th subexpression gives the name of the directory
296 being moved from. If IDX is nil, the last directory entered \(by a line
297 matching `compilation-enter-directory-regexp-alist'\) is assumed.
299 The default value matches lines printed by the `-w' option of GNU Make.")
301 (defvar compilation-file-regexp-alist
303 ;; This matches entries with date time year file-name: like
304 ;; Thu May 14 10:46:12 1992 mom3.p:
305 ("\\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)
307 "Alist specifying how to match lines that indicate a new current file.
308 Note that the match is done at the beginning of lines.
309 Each elt has the form (REGEXP IDX).
310 If REGEXP matches, the IDX'th subexpression gives the file name. This is
311 used with compilers that don't indicate file name in every error message.")
313 ;; There is no generally useful regexp that will match non messages, but
314 ;; in special cases there might be one. The lines that are not matched by
315 ;; a regexp take much longer time than the ones that are recognized so if
316 ;; you have same regexeps here, parsing is faster.
317 (defvar compilation-nomessage-regexp-alist
320 "Alist specifying how to match lines that have no message.
321 Note that the match is done at the beginning of lines.
322 Each elt has the form (REGEXP). This alist is by default empty, but if
323 you have some good regexps here, the parsing of messages will be faster.")
325 (defcustom compilation-read-command t
326 "*If not nil, M-x compile reads the compilation command to use.
327 Otherwise, M-x compile just uses the value of `compile-command'."
331 (defcustom compilation-ask-about-save t
332 "*If not nil, M-x compile asks which buffers to save before compiling.
333 Otherwise, it saves all modified buffers without asking."
337 (defvar grep-regexp-alist
338 '(("\\([a-zA-Z]?:?[^:( \t\n]+\\)[:( \t]+\\([0-9]+\\)[:) \t]" 1 2))
339 "Regexp used to match grep hits. See `compilation-error-regexp-alist'.")
341 ;; The system null device. (Should reference NULL_DEVICE from C.)
342 (defvar grep-null-device "/dev/null" "The system null device.")
345 ;; Currently zgrep has trouble. It runs egrep instead of grep,
346 ;; and it doesn't pass along long options right.
348 ;;; (if (equal (condition-case nil ; in case "zgrep" isn't in exec-path
349 ;;; (call-process "zgrep" nil nil nil
350 ;;; "foo" grep-null-device)
355 "The default grep program for `grep-command' and `grep-find-command'.")
357 ;; Use -e if grep supports it,
358 ;; because that avoids lossage if the pattern starts with `-'.
360 (if (equal (condition-case nil ; in case "grep" isn't in exec-path
361 (call-process grep-program nil nil nil
362 "-e" "foo" grep-null-device)
365 (format "%s -n -e " grep-program)
366 (format "%s -n " grep-program))
367 "The default grep command for \\[grep].")
369 (defvar grep-find-use-xargs
370 (if (equal (call-process "find" nil nil nil
371 grep-null-device "-print0")
374 "Whether \\[grep-find] uses the `xargs' utility by default.
376 If nil, it uses `grep -exec'; if `gnu', it uses `find -print0' and `xargs -0';
377 if not nil and not `gnu', it uses `find -print' and `xargs'.
379 This variable's value takes effect when `compile.el' is loaded
380 by influencing the default value for the variable `grep-find-command'.")
382 (defvar grep-find-command
383 (cond ((eq grep-find-use-xargs 'gnu)
384 (format "find . -type f -print0 | xargs -0 -e %s" grep-command))
386 (format "find . -type f -print | xargs %s" grep-command))
387 (t (cons (format "find . -type f -exec %s {} /dev/null \\;"
389 (+ 22 (length grep-command)))))
390 "The default find command for \\[grep-find].")
393 (defcustom compilation-search-path '(nil)
394 "*List of directories to search for source files named in error messages.
395 Elements should be directory names, not file names of directories.
396 nil as an element means to try the default directory."
397 :type '(repeat (choice (const :tag "Default" nil)
398 (string :tag "Directory")))
401 (defcustom compile-command "make -k "
402 "*Last shell command used to do a compilation; default for next compilation.
404 Sometimes it is useful for files to supply local values for this variable.
405 You might also use mode hooks to specify it in certain modes, like this:
408 '(lambda () (or (file-exists-p \"makefile\") (file-exists-p \"Makefile\")
409 (progn (make-local-variable 'compile-command)
410 (setq compile-command
412 buffer-file-name))))))"
416 (defvar compilation-directory-stack nil
417 "Stack of previous directories for `compilation-leave-directory-regexp'.
418 The head element is the directory the compilation was started in.")
420 (defvar compilation-exit-message-function nil "\
421 If non-nil, called when a compilation process dies to return a status message.
422 This should be a function of three arguments: process status, exit status,
423 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
424 write into the compilation buffer, and to put in its mode line.")
426 ;; History of compile commands.
427 (defvar compile-history nil)
428 ;; History of grep commands.
429 (defvar grep-history nil)
430 (defvar grep-find-history nil)
432 (defun compilation-mode-font-lock-keywords ()
433 "Return expressions to highlight in Compilation mode."
436 ;; Compiler warning/error lines.
437 (mapcar #'(lambda (item)
439 (list (nth 1 item) 'font-lock-warning-face nil t)
440 (list (nth 2 item) 'font-lock-variable-name-face nil t)))
441 compilation-error-regexp-alist)
444 ;; Compiler output lines. Recognize `make[n]:' lines too.
445 '("^\\([A-Za-z_0-9/\.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
446 (1 font-lock-function-name-face) (3 font-lock-comment-face nil t)))
450 (defun compile (command)
451 "Compile the program including the current buffer. Default: run `make'.
452 Runs COMMAND, a shell command, in a separate process asynchronously
453 with output going to the buffer `*compilation*'.
455 You can then use the command \\[next-error] to find the next error message
456 and move to the source code that caused it.
458 Interactively, prompts for the command if `compilation-read-command' is
459 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
461 To run more than one compilation at once, start one and rename the
462 \`*compilation*' buffer to some other name with \\[rename-buffer].
463 Then start the next one.
465 The name used for the buffer is actually whatever is returned by
466 the function in `compilation-buffer-name-function', so you can set that
467 to a function that generates a unique name."
469 (if (or compilation-read-command current-prefix-arg)
470 (list (read-from-minibuffer "Compile command: "
471 compile-command nil nil
472 '(compile-history . 1)))
473 (list compile-command)))
474 (setq compile-command command)
475 (save-some-buffers (not compilation-ask-about-save) nil)
476 (compile-internal compile-command "No more errors"))
478 ;;; run compile with the default command line
480 "Re-compile the program including the current buffer."
482 (save-some-buffers (not compilation-ask-about-save) nil)
483 (compile-internal compile-command "No more errors"))
485 (defun grep-process-setup ()
486 "Set up `compilation-exit-message-function' for `grep'."
487 (set (make-local-variable 'compilation-exit-message-function)
488 (lambda (status code msg)
489 (if (eq status 'exit)
491 '("finished (matches found)\n" . "matched"))
493 '("finished with no matches found\n" . "no match"))
499 (defun grep (command-args)
500 "Run grep, with user-specified args, and collect output in a buffer.
501 While grep runs asynchronously, you can use the \\[next-error] command
502 to find the text that grep hits refer to.
504 This command uses a special history list for its arguments, so you can
505 easily repeat a grep command."
507 (list (read-from-minibuffer "Run grep (like this): "
508 grep-command nil nil 'grep-history)))
509 ;; Setting process-setup-function makes exit-message-function work
510 ;; even when async processes aren't supported.
511 (let* ((compilation-process-setup-function 'grep-process-setup)
512 (buf (compile-internal (if grep-null-device
513 (concat command-args " " grep-null-device)
515 "No more grep hits" "grep"
516 ;; Give it a simpler regexp to match.
517 nil grep-regexp-alist)))))
521 (defun grep-find (command-args)
522 "Run grep via find, with user-specified args, and collect output in a buffer.
523 While find runs asynchronously, you can use the \\[next-error] command
524 to find the text that grep hits refer to.
526 This command uses a special history list for its arguments, so you can
527 easily repeat a find command."
529 (list (read-from-minibuffer "Run find (like this): "
530 grep-find-command nil nil 'grep-find-history)))
531 (let ((grep-null-device nil)) ; see grep
532 (grep command-args)))
534 (defun compile-internal (command error-message
535 &optional name-of-mode parser
536 error-regexp-alist name-function
537 enter-regexp-alist leave-regexp-alist
538 file-regexp-alist nomessage-regexp-alist)
539 "Run compilation command COMMAND (low level interface).
540 ERROR-MESSAGE is a string to print if the user asks to see another error
541 and there are no more errors. The rest of the arguments, 3-10 are optional.
542 For them nil means use the default.
543 NAME-OF-MODE is the name to display as the major mode in the compilation
544 buffer. PARSER is the error parser function. ERROR-REGEXP-ALIST is the error
545 message regexp alist to use. NAME-FUNCTION is a function called to name the
546 buffer. ENTER-REGEXP-ALIST is the enter directory message regexp alist to use.
547 LEAVE-REGEXP-ALIST is the leave directory message regexp alist to use.
548 FILE-REGEXP-ALIST is the change current file message regexp alist to use.
549 NOMESSAGE-REGEXP-ALIST is the nomessage regexp alist to use.
550 The defaults for these variables are the global values of
551 \`compilation-parse-errors-function', `compilation-error-regexp-alist',
552 \`compilation-buffer-name-function', `compilation-enter-directory-regexp-alist',
553 \`compilation-leave-directory-regexp-alist', `compilation-file-regexp-alist',
554 \ and `compilation-nomessage-regexp-alist', respectively.
555 For arg 7-10 a value `t' means an empty alist.
557 Returns the compilation buffer created."
561 (setq name-of-mode "Compilation"))
564 (funcall (or name-function compilation-buffer-name-function
565 (function (lambda (mode)
566 (concat "*" (downcase mode) "*"))))
569 (let ((comp-proc (get-buffer-process (current-buffer))))
571 (if (or (not (eq (process-status comp-proc) 'run))
573 (format "A %s process is running; kill it? "
577 (interrupt-process comp-proc)
579 (delete-process comp-proc))
581 (error "Cannot have two processes in `%s' at once"
584 ;; In case the compilation buffer is current, make sure we get the global
585 ;; values of compilation-error-regexp-alist, etc.
586 (kill-all-local-variables))
587 (or error-regexp-alist
588 (setq error-regexp-alist compilation-error-regexp-alist))
589 (or enter-regexp-alist
590 (setq enter-regexp-alist compilation-enter-directory-regexp-alist))
591 (or leave-regexp-alist
592 (setq leave-regexp-alist compilation-leave-directory-regexp-alist))
593 (or file-regexp-alist
594 (setq file-regexp-alist compilation-file-regexp-alist))
595 (or nomessage-regexp-alist
596 (setq nomessage-regexp-alist compilation-nomessage-regexp-alist))
597 (or parser (setq parser compilation-parse-errors-function))
598 (let ((thisdir default-directory)
601 ;; Clear out the compilation buffer and make it writable.
602 ;; Change its default-directory to the directory where the compilation
603 ;; will happen, and insert a `cd' command to indicate this.
605 (setq buffer-read-only nil)
606 (buffer-disable-undo (current-buffer))
608 (buffer-enable-undo (current-buffer))
609 (setq default-directory thisdir)
610 (insert "cd " thisdir "\n" command "\n")
611 (set-buffer-modified-p nil))
612 ;; If we're already in the compilation buffer, go to the end
613 ;; of the buffer, so point will track the compilation output.
614 (if (eq outbuf (current-buffer))
615 (goto-char (point-max)))
616 ;; Pop up the compilation buffer.
617 (setq outwin (display-buffer outbuf))
621 ;; (setq buffer-read-only t) ;;; Non-ergonomic.
622 (set (make-local-variable 'compilation-parse-errors-function) parser)
623 (set (make-local-variable 'compilation-error-message) error-message)
624 (set (make-local-variable 'compilation-error-regexp-alist)
626 (set (make-local-variable 'compilation-enter-directory-regexp-alist)
628 (set (make-local-variable 'compilation-leave-directory-regexp-alist)
630 (set (make-local-variable 'compilation-file-regexp-alist)
632 (set (make-local-variable 'compilation-nomessage-regexp-alist)
633 nomessage-regexp-alist)
634 (set (make-local-variable 'compilation-arguments)
635 (list command error-message
637 error-regexp-alist name-function
638 enter-regexp-alist leave-regexp-alist
639 file-regexp-alist nomessage-regexp-alist))
640 (setq default-directory thisdir
641 compilation-directory-stack (list default-directory))
642 (set-window-start outwin (point-min))
643 (setq mode-name name-of-mode)
644 (or (eq outwin (selected-window))
645 (set-window-point outwin (point-min)))
646 (compilation-set-window-height outwin)
647 (if compilation-process-setup-function
648 (funcall compilation-process-setup-function))
649 ;; Start the compilation.
650 (if (fboundp 'start-process)
651 (let* ((process-environment (cons "EMACS=t" process-environment))
652 (proc (start-process-shell-command (downcase mode-name)
655 (set-process-sentinel proc 'compilation-sentinel)
656 (set-process-filter proc 'compilation-filter)
657 (set-marker (process-mark proc) (point) outbuf)
658 (setq compilation-in-progress
659 (cons proc compilation-in-progress)))
660 ;; No asynchronous processes available.
661 (message "Executing `%s'..." command)
662 ;; Fake modeline display as if `start-process' were run.
663 (setq mode-line-process ":run")
664 (force-mode-line-update)
665 (sit-for 0) ; Force redisplay
666 (let ((status (call-process shell-file-name nil outbuf nil "-c"
668 (cond ((numberp status)
669 (compilation-handle-exit 'exit status
673 exited abnormally with code %d\n"
676 (compilation-handle-exit 'signal status
677 (concat status "\n")))
679 (compilation-handle-exit 'bizarre status status))))
680 (message "Executing `%s'...done" command))))
681 ;; Make it so the next C-x ` will use this buffer.
682 (setq compilation-last-buffer outbuf)))
684 ;; Set the height of WINDOW according to compilation-window-height.
685 (defun compilation-set-window-height (window)
686 (and compilation-window-height
687 (= (window-width window) (frame-width (window-frame window)))
688 ;; If window is alone in its frame, aside from a minibuffer,
689 ;; don't change its height.
690 (not (eq window (frame-root-window (window-frame window))))
691 ;; This save-excursion prevents us from changing the current buffer,
692 ;; which might not be the same as the selected window's buffer.
694 (let ((w (selected-window)))
697 (select-window window)
698 (enlarge-window (- compilation-window-height
700 (select-window w))))))
702 (defvar compilation-minor-mode-map
703 (let ((map (make-sparse-keymap)))
704 (define-key map [mouse-2] 'compile-mouse-goto-error)
705 (define-key map "\C-c\C-c" 'compile-goto-error)
706 (define-key map "\C-m" 'compile-goto-error)
707 (define-key map "\C-c\C-k" 'kill-compilation)
708 (define-key map "\M-n" 'compilation-next-error)
709 (define-key map "\M-p" 'compilation-previous-error)
710 (define-key map "\M-{" 'compilation-previous-file)
711 (define-key map "\M-}" 'compilation-next-file)
713 "Keymap for `compilation-minor-mode'.")
715 (defvar compilation-shell-minor-mode-map
716 (let ((map (make-sparse-keymap)))
717 (define-key map [mouse-2] 'compile-mouse-goto-error)
718 (define-key map "\M-\C-m" 'compile-goto-error)
719 (define-key map "\M-\C-n" 'compilation-next-error)
720 (define-key map "\M-\C-p" 'compilation-previous-error)
721 (define-key map "\M-{" 'compilation-previous-file)
722 (define-key map "\M-}" 'compilation-next-file)
723 ;; Set up the menu-bar
724 (define-key map [menu-bar errors-menu]
725 (cons "Errors" (make-sparse-keymap "Errors")))
726 (define-key map [menu-bar errors-menu stop-subjob]
727 '("Stop" . comint-interrupt-subjob))
728 (define-key map [menu-bar errors-menu compilation-mode-separator2]
730 (define-key map [menu-bar errors-menu compilation-mode-first-error]
731 '("First Error" . first-error))
732 (define-key map [menu-bar errors-menu compilation-mode-previous-error]
733 '("Previous Error" . previous-error))
734 (define-key map [menu-bar errors-menu compilation-mode-next-error]
735 '("Next Error" . next-error))
737 "Keymap for `compilation-shell-minor-mode'.")
739 (defvar compilation-mode-map
740 (let ((map (cons 'keymap compilation-minor-mode-map)))
741 (define-key map " " 'scroll-up)
742 (define-key map "\^?" 'scroll-down)
743 ;; Set up the menu-bar
744 (define-key map [menu-bar compilation-menu]
745 (cons "Compile" (make-sparse-keymap "Compile")))
747 (define-key map [menu-bar compilation-menu compilation-mode-kill-compilation]
748 '("Stop Compilation" . kill-compilation))
749 (define-key map [menu-bar compilation-menu compilation-mode-separator2]
751 (define-key map [menu-bar compilation-menu compilation-mode-first-error]
752 '("First Error" . first-error))
753 (define-key map [menu-bar compilation-menu compilation-mode-previous-error]
754 '("Previous Error" . previous-error))
755 (define-key map [menu-bar compilation-menu compilation-mode-next-error]
756 '("Next Error" . next-error))
757 (define-key map [menu-bar compilation-menu compilation-separator2]
759 (define-key map [menu-bar compilation-menu compilation-mode-grep]
761 (define-key map [menu-bar compilation-menu compilation-mode-recompile]
762 '("Recompile" . recompile))
763 (define-key map [menu-bar compilation-menu compilation-mode-compile]
764 '("Compile..." . compile))
766 "Keymap for compilation log buffers.
767 `compilation-minor-mode-map' is a cdr of this.")
769 (put 'compilation-mode 'mode-class 'special)
772 (defun compilation-mode ()
773 "Major mode for compilation log buffers.
774 \\<compilation-mode-map>To visit the source for a line-numbered error,
775 move point to the error message line and type \\[compile-goto-error].
776 To kill the compilation, type \\[kill-compilation].
778 Runs `compilation-mode-hook' with `run-hooks' (which see)."
780 (kill-all-local-variables)
781 (use-local-map compilation-mode-map)
782 (setq major-mode 'compilation-mode
783 mode-name "Compilation")
785 (set (make-local-variable 'font-lock-defaults)
786 '(compilation-mode-font-lock-keywords t))
787 (set (make-local-variable 'revert-buffer-function)
788 'compilation-revert-buffer)
789 (run-hooks 'compilation-mode-hook))
791 (defun compilation-revert-buffer (ignore-auto noconfirm)
792 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
793 (apply 'compile-internal compilation-arguments)))
795 ;; Prepare the buffer for the compilation parsing commands to work.
796 (defun compilation-setup ()
797 ;; Make the buffer's mode line show process state.
798 (setq mode-line-process '(":%s"))
799 (set (make-local-variable 'compilation-error-list) nil)
800 (set (make-local-variable 'compilation-old-error-list) nil)
801 (set (make-local-variable 'compilation-parsing-end) 1)
802 (set (make-local-variable 'compilation-directory-stack) nil)
803 (setq compilation-last-buffer (current-buffer)))
805 (defvar compilation-shell-minor-mode nil
806 "Non-nil when in compilation-shell-minor-mode.
807 In this minor mode, all the error-parsing commands of the
808 Compilation major mode are available but bound to keys that don't
809 collide with Shell mode.")
810 (make-variable-buffer-local 'compilation-shell-minor-mode)
812 (or (assq 'compilation-shell-minor-mode minor-mode-alist)
813 (setq minor-mode-alist
814 (cons '(compilation-shell-minor-mode " Shell-Compile")
816 (or (assq 'compilation-shell-minor-mode minor-mode-map-alist)
817 (setq minor-mode-map-alist (cons (cons 'compilation-shell-minor-mode
818 compilation-shell-minor-mode-map)
819 minor-mode-map-alist)))
821 (defvar compilation-minor-mode nil
822 "Non-nil when in compilation-minor-mode.
823 In this minor mode, all the error-parsing commands of the
824 Compilation major mode are available.")
825 (make-variable-buffer-local 'compilation-minor-mode)
827 (or (assq 'compilation-minor-mode minor-mode-alist)
828 (setq minor-mode-alist (cons '(compilation-minor-mode " Compilation")
830 (or (assq 'compilation-minor-mode minor-mode-map-alist)
831 (setq minor-mode-map-alist (cons (cons 'compilation-minor-mode
832 compilation-minor-mode-map)
833 minor-mode-map-alist)))
836 (defun compilation-minor-mode (&optional arg)
837 "Toggle compilation minor mode.
838 With arg, turn compilation mode on if and only if arg is positive.
839 See `compilation-mode'.
840 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
842 (if (setq compilation-minor-mode (if (null arg)
843 (null compilation-minor-mode)
844 (> (prefix-numeric-value arg) 0)))
847 (run-hooks 'compilation-minor-mode-hook))))
849 ;; Write msg in the current buffer and hack its mode-line-process.
850 (defun compilation-handle-exit (process-status exit-status msg)
851 (let ((buffer-read-only nil)
852 (status (if compilation-exit-message-function
853 (funcall compilation-exit-message-function
854 process-status exit-status msg)
855 (cons msg exit-status)))
858 ;; Record where we put the message, so we can ignore it
861 (insert ?\n mode-name " " (car status))
863 (insert " at " (substring (current-time-string) 0 19))
865 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
866 ;; Force mode line redisplay soon.
867 (force-mode-line-update)
868 (if (and opoint (< opoint omax))
870 ;; Automatically parse (and mouse-highlight) error messages:
871 (cond ((eq compile-auto-highlight t)
872 (compile-reinitialize-errors nil (point-max)))
873 ((numberp compile-auto-highlight)
874 (compile-reinitialize-errors nil
876 (goto-line compile-auto-highlight)
878 (if compilation-finish-function
879 (funcall compilation-finish-function (current-buffer) msg))
880 (let ((functions compilation-finish-functions))
882 (funcall (car functions) (current-buffer) msg)
883 (setq functions (cdr functions))))))
885 ;; Called when compilation process changes state.
886 (defun compilation-sentinel (proc msg)
887 "Sentinel for compilation buffers."
888 (let ((buffer (process-buffer proc)))
889 (if (memq (process-status proc) '(signal exit))
891 (if (null (buffer-name buffer))
893 (set-process-buffer proc nil)
894 (let ((obuf (current-buffer)))
895 ;; save-excursion isn't the right thing if
896 ;; process-buffer is current-buffer
899 ;; Write something in the compilation buffer
900 ;; and hack its mode line.
902 (compilation-handle-exit (process-status proc)
903 (process-exit-status proc)
905 ;; Since the buffer and mode line will show that the
906 ;; process is dead, we can delete it now. Otherwise it
907 ;; will stay around until M-x list-processes.
908 (delete-process proc))
910 (setq compilation-in-progress (delq proc compilation-in-progress))
913 (defun compilation-filter (proc string)
914 "Process filter for compilation buffers.
915 Just inserts the text, but uses `insert-before-markers'."
916 (if (buffer-name (process-buffer proc))
918 (set-buffer (process-buffer proc))
919 (let ((buffer-read-only nil))
921 (goto-char (process-mark proc))
922 (insert-before-markers string)
923 (run-hooks 'compilation-filter-hook)
924 (set-marker (process-mark proc) (point)))))))
926 ;; Return the cdr of compilation-old-error-list for the error containing point.
927 (defun compile-error-at-point ()
928 (compile-reinitialize-errors nil (point))
929 (let ((errors compilation-old-error-list))
931 (> (point) (car (car errors))))
932 (setq errors (cdr errors)))
935 (defsubst compilation-buffer-p (buffer)
938 (or compilation-shell-minor-mode compilation-minor-mode
939 (eq major-mode 'compilation-mode))))
941 (defun compilation-next-error (n)
942 "Move point to the next error in the compilation buffer.
943 Does NOT find the source line like \\[next-error]."
945 (or (compilation-buffer-p (current-buffer))
946 (error "Not in a compilation buffer."))
947 (setq compilation-last-buffer (current-buffer))
949 (let ((errors (compile-error-at-point)))
951 ;; Move to the error after the one containing point.
952 (goto-char (car (if (< n 0)
954 (e compilation-old-error-list))
955 ;; See how many cdrs away ERRORS is from the start.
956 (while (not (eq e errors))
960 (error "Moved back past first error")
961 (nth (+ i n) compilation-old-error-list)))
962 (let ((compilation-error-list (cdr errors)))
963 (compile-reinitialize-errors nil nil n)
964 (if compilation-error-list
965 (nth (1- n) compilation-error-list)
966 (error "Moved past last error"))))))))
968 (defun compilation-previous-error (n)
969 "Move point to the previous error in the compilation buffer.
970 Does NOT find the source line like \\[next-error]."
972 (compilation-next-error (- n)))
975 ;; Given an elt of `compilation-error-list', return an object representing
976 ;; the referenced file which is equal to (but not necessarily eq to) what
977 ;; this function would return for another error in the same file.
978 (defsubst compilation-error-filedata (data)
979 (setq data (cdr data))
984 ;; Return a string describing a value from compilation-error-filedata.
985 ;; This value is not necessarily useful as a file name, but should be
986 ;; indicative to the user of what file's errors are being referred to.
987 (defsubst compilation-error-filedata-file-name (filedata)
988 (if (bufferp filedata)
989 (buffer-file-name filedata)
992 (defun compilation-next-file (n)
993 "Move point to the next error for a different file than the current one."
995 (or (compilation-buffer-p (current-buffer))
996 (error "Not in a compilation buffer."))
997 (setq compilation-last-buffer (current-buffer))
999 (let ((reversed (< n 0))
1003 (setq errors (or (compile-error-at-point)
1004 (error "Moved past last error")))
1006 ;; Get a reversed list of the errors up through the one containing point.
1007 (compile-reinitialize-errors nil (point))
1008 (setq errors (reverse compilation-old-error-list)
1011 ;; Ignore errors after point. (car ERRORS) will be the error
1012 ;; containing point, (cadr ERRORS) the one before it.
1014 (< (point) (car (car errors))))
1015 (setq errors (cdr errors))))
1018 (setq filedata (compilation-error-filedata (car errors)))
1020 ;; Skip past the following errors for this file.
1021 (while (equal filedata
1022 (compilation-error-filedata
1025 (error "%s the first erring file"
1026 (compilation-error-filedata-file-name
1028 (let ((compilation-error-list nil))
1030 (compile-reinitialize-errors nil nil 2)
1031 (setq errors compilation-error-list)))
1032 (error "%s is the last erring file"
1033 (compilation-error-filedata-file-name
1035 (setq errors (cdr errors)))
1039 ;; Move to the following error.
1040 (goto-char (car (car (or errors
1042 (error "This is the first erring file")
1043 (let ((compilation-error-list nil))
1044 ;; Parse the last one.
1045 (compile-reinitialize-errors nil nil 1)
1046 compilation-error-list))))))))
1048 (defun compilation-previous-file (n)
1049 "Move point to the previous error for a different file than the current one."
1051 (compilation-next-file (- n)))
1054 (defun kill-compilation ()
1055 "Kill the process made by the \\[compile] command."
1057 (let ((buffer (compilation-find-buffer)))
1058 (if (get-buffer-process buffer)
1059 (interrupt-process (get-buffer-process buffer))
1060 (error "The compilation process is not running."))))
1063 ;; Parse any new errors in the compilation buffer,
1064 ;; or reparse from the beginning if the user has asked for that.
1065 (defun compile-reinitialize-errors (reparse
1066 &optional limit-search find-at-least)
1068 (set-buffer compilation-last-buffer)
1069 ;; If we are out of errors, or if user says "reparse",
1070 ;; discard the info we have, to force reparsing.
1071 (if (or (eq compilation-error-list t)
1073 (compilation-forget-errors))
1074 (if (and compilation-error-list
1075 (or (not limit-search)
1076 (> compilation-parsing-end limit-search))
1077 (or (not find-at-least)
1078 (>= (length compilation-error-list) find-at-least)))
1079 ;; Since compilation-error-list is non-nil, it points to a specific
1080 ;; error the user wanted. So don't move it around.
1082 ;; This was here for a long time (before my rewrite); why? --roland
1083 ;;(switch-to-buffer compilation-last-buffer)
1084 (set-buffer-modified-p nil)
1085 (if (< compilation-parsing-end (point-max))
1086 ;; compilation-error-list might be non-nil if we have a non-nil
1087 ;; LIMIT-SEARCH or FIND-AT-LEAST arg. In that case its value
1088 ;; records the current position in the error list, and we must
1089 ;; preserve that after reparsing.
1090 (let ((error-list-pos compilation-error-list))
1091 (funcall compilation-parse-errors-function
1094 ;; We only need enough new parsed errors to reach
1095 ;; FIND-AT-LEAST errors past the current
1097 (- find-at-least (length compilation-error-list))))
1098 ;; Remember the entire list for compilation-forget-errors. If
1099 ;; this is an incremental parse, append to previous list. If
1100 ;; we are parsing anew, compilation-forget-errors cleared
1101 ;; compilation-old-error-list above.
1102 (setq compilation-old-error-list
1103 (nconc compilation-old-error-list compilation-error-list))
1105 ;; We started in the middle of an existing list of parsed
1106 ;; errors before parsing more; restore that position.
1107 (setq compilation-error-list error-list-pos))
1108 ;; Mouse-Highlight (the first line of) each error message when the
1109 ;; mouse pointer moves over it:
1110 (let ((inhibit-read-only t)
1111 (error-list compilation-error-list))
1114 (put-text-property (goto-char (car (car error-list)))
1115 (progn (end-of-line) (point))
1116 'mouse-face 'highlight))
1117 (setq error-list (cdr error-list))))
1120 (defun compile-mouse-goto-error (event)
1123 (set-buffer (window-buffer (posn-window (event-end event))))
1124 (goto-char (posn-point (event-end event)))
1126 (or (compilation-buffer-p (current-buffer))
1127 (error "Not in a compilation buffer."))
1128 (setq compilation-last-buffer (current-buffer))
1129 ;; `compile-reinitialize-errors' needs to see the complete filename
1130 ;; on the line where they clicked the mouse. Since it only looks
1131 ;; up to point, moving point to eol makes sure the filename is
1132 ;; visible to `compile-reinitialize-errors'.
1134 (compile-reinitialize-errors nil (point))
1136 ;; Move to bol; the marker for the error on this line will point there.
1139 ;; Move compilation-error-list to the elt of compilation-old-error-list
1141 (setq compilation-error-list compilation-old-error-list)
1142 (while (and compilation-error-list
1143 (> (point) (car (car compilation-error-list))))
1144 (setq compilation-error-list (cdr compilation-error-list)))
1145 (or compilation-error-list
1146 (error "No error to go to")))
1147 (select-window (posn-window (event-end event)))
1148 ;; Move to another window, so that next-error's window changes
1149 ;; result in the desired setup.
1153 ;; other-window changed the selected buffer,
1154 ;; but we didn't want to do that.
1155 (set-buffer compilation-last-buffer)))
1160 (defun compile-goto-error (&optional argp)
1161 "Visit the source for the error message point is on.
1162 Use this command in a compilation log buffer. Sets the mark at point there.
1163 \\[universal-argument] as a prefix arg means to reparse the buffer's error messages first;
1164 other kinds of prefix arguments are ignored."
1166 (or (compilation-buffer-p (current-buffer))
1167 (error "Not in a compilation buffer."))
1168 (setq compilation-last-buffer (current-buffer))
1169 (compile-reinitialize-errors (consp argp) (point))
1171 ;; Move to bol; the marker for the error on this line will point there.
1174 ;; Move compilation-error-list to the elt of compilation-old-error-list
1176 (setq compilation-error-list compilation-old-error-list)
1177 (while (and compilation-error-list
1178 (> (point) (car (car compilation-error-list))))
1179 (setq compilation-error-list (cdr compilation-error-list)))
1181 ;; Move to another window, so that next-error's window changes
1182 ;; result in the desired setup.
1186 ;; other-window changed the selected buffer,
1187 ;; but we didn't want to do that.
1188 (set-buffer compilation-last-buffer)))
1193 ;; Return a compilation buffer.
1194 ;; If the current buffer is a compilation buffer, return it.
1195 ;; If compilation-last-buffer is set to a live buffer, use that.
1196 ;; Otherwise, look for a compilation buffer and signal an error
1197 ;; if there are none.
1198 (defun compilation-find-buffer (&optional other-buffer)
1199 (if (and (not other-buffer)
1200 (compilation-buffer-p (current-buffer)))
1201 ;; The current buffer is a compilation buffer.
1203 (if (and compilation-last-buffer (buffer-name compilation-last-buffer)
1204 (compilation-buffer-p compilation-last-buffer)
1205 (or (not other-buffer) (not (eq compilation-last-buffer
1206 (current-buffer)))))
1207 compilation-last-buffer
1208 (let ((buffers (buffer-list)))
1209 (while (and buffers (or (not (compilation-buffer-p (car buffers)))
1211 (eq (car buffers) (current-buffer)))))
1212 (setq buffers (cdr buffers)))
1215 (or (and other-buffer
1216 (compilation-buffer-p (current-buffer))
1217 ;; The current buffer is a compilation buffer.
1220 (message "This is the only compilation buffer."))
1222 (error "No compilation started!")))))))
1225 (defun next-error (&optional argp)
1226 "Visit next compilation error message and corresponding source code.
1227 This operates on the output from the \\[compile] command.
1228 If all preparsed error messages have been processed,
1229 the error message buffer is checked for new ones.
1231 A prefix arg specifies how many error messages to move;
1232 negative means move back to previous error messages.
1233 Just C-u as a prefix means reparse the error message buffer
1234 and start at the first error.
1236 \\[next-error] normally applies to the most recent compilation started,
1237 but as long as you are in the middle of parsing errors from one compilation
1238 output buffer, you stay with that compilation output buffer.
1240 Use \\[next-error] in a compilation output buffer to switch to
1241 processing errors from that compilation.
1243 See variables `compilation-parse-errors-function' and
1244 \`compilation-error-regexp-alist' for customization ideas."
1246 (setq compilation-last-buffer (compilation-find-buffer))
1247 (compilation-goto-locus (compilation-next-error-locus
1248 ;; We want to pass a number here only if
1249 ;; we got a numeric prefix arg, not just C-u.
1250 (and (not (consp argp))
1251 (prefix-numeric-value argp))
1253 ;;;###autoload (define-key ctl-x-map "`" 'next-error)
1255 (defun previous-error ()
1256 "Visit previous compilation error message and corresponding source code.
1257 This operates on the output from the \\[compile] command."
1261 (defun first-error ()
1262 "Reparse the error message buffer and start at the first error.
1263 Visit corresponding source code.
1264 This operates on the output from the \\[compile] command."
1268 (defvar compilation-skip-to-next-location nil
1269 "*If non-nil, skip multiple error messages for the same source location.")
1271 (defun compilation-next-error-locus (&optional move reparse silent)
1272 "Visit next compilation error and return locus in corresponding source code.
1273 This operates on the output from the \\[compile] command.
1274 If all preparsed error messages have been processed,
1275 the error message buffer is checked for new ones.
1277 Returns a cons (ERROR . SOURCE) of two markers: ERROR is a marker at the
1278 location of the error message in the compilation buffer, and SOURCE is a
1279 marker at the location in the source code indicated by the error message.
1281 Optional first arg MOVE says how many error messages to move forwards (or
1282 backwards, if negative); default is 1. Optional second arg REPARSE, if
1283 non-nil, says to reparse the error message buffer and reset to the first
1284 error (plus MOVE - 1). If optional third argument SILENT is non-nil, return
1285 nil instead of raising an error if there are no more errors.
1287 The current buffer should be the desired compilation output buffer."
1288 (or move (setq move 1))
1289 (compile-reinitialize-errors reparse nil (and (not reparse)
1290 (if (< move 1) 0 (1- move))))
1291 (let (next-errors next-error)
1292 (catch 'no-next-error
1294 (set-buffer compilation-last-buffer)
1295 ;; compilation-error-list points to the "current" error.
1299 compilation-error-list)
1300 ;; Zero or negative arg; we need to move back in the list.
1303 (e compilation-old-error-list))
1304 ;; See how many cdrs away the current error is from the start.
1305 (while (not (eq e compilation-error-list))
1309 (error "Moved back past first error")
1310 (nthcdr (+ i n) compilation-old-error-list))))
1311 next-error (car next-errors))
1313 (if (null next-error)
1315 (and move (/= move 1)
1316 (error (if (> move 0)
1317 "Moved past last error")
1318 "Moved back past first error"))
1319 ;; Forget existing error messages if compilation has finished.
1320 (if (not (and (get-buffer-process (current-buffer))
1325 (compilation-forget-errors))
1327 (throw 'no-next-error nil)
1328 (error (concat compilation-error-message
1329 (and (get-buffer-process (current-buffer))
1335 (setq compilation-error-list (cdr next-errors))
1336 (if (null (cdr next-error))
1337 ;; This error is boring. Go to the next.
1339 (or (markerp (cdr next-error))
1340 ;; This error has a filename/lineno pair.
1341 ;; Find the file and turn it into a marker.
1342 (let* ((fileinfo (car (cdr next-error)))
1343 (buffer (apply 'compilation-find-file
1344 (car next-error) fileinfo)))
1346 ;; We can't find this error's file.
1347 ;; Remove all errors in the same file.
1349 (setq next-errors compilation-old-error-list)
1351 (and (consp (cdr (car next-errors)))
1352 (equal (car (cdr (car next-errors)))
1355 (set-marker (car (car next-errors)) nil)
1356 (setcdr (car next-errors) nil)))
1357 (setq next-errors (cdr next-errors)))
1358 ;; Look for the next error.
1360 ;; We found the file. Get a marker for this error.
1361 ;; compilation-old-error-list is a buffer-local
1362 ;; variable, so we must be careful to extract its value
1363 ;; before switching to the source file buffer.
1364 (let ((errors compilation-old-error-list)
1365 (last-line (nth 1 (cdr next-error)))
1366 (column (nth 2 (cdr next-error))))
1371 (goto-line last-line)
1372 (if (and column (> column 0))
1373 ;; Columns in error msgs are 1-origin.
1374 (move-to-column (1- column))
1375 (beginning-of-line))
1376 (setcdr next-error (point-marker))
1377 ;; Make all the other error messages referring
1378 ;; to the same file have markers into the buffer.
1380 (and (consp (cdr (car errors)))
1381 (equal (car (cdr (car errors))) fileinfo)
1382 (let* ((this (nth 1 (cdr (car errors))))
1383 (column (nth 2 (cdr (car errors))))
1384 (lines (- this last-line)))
1385 (if (eq selective-display t)
1386 ;; When selective-display is t,
1387 ;; each C-m is a line boundary,
1388 ;; as well as each newline.
1390 (re-search-backward "[\n\C-m]"
1393 (re-search-forward "[\n\C-m]"
1396 (forward-line lines))
1397 (if (and column (> column 1))
1398 (move-to-column (1- column))
1399 (beginning-of-line))
1400 (setq last-line this)
1401 (setcdr (car errors) (point-marker))))
1402 (setq errors (cdr errors)))))))))
1403 ;; If we didn't get a marker for this error, or this
1404 ;; marker's buffer was killed, go on to the next one.
1405 (or (not (markerp (cdr next-error)))
1406 (not (marker-buffer (cdr next-error))))))
1407 (setq next-errors compilation-error-list
1408 next-error (car next-errors)))))
1410 (if compilation-skip-to-next-location
1411 ;; Skip over multiple error messages for the same source location,
1412 ;; so the next C-x ` won't go to an error in the same place.
1413 (while (and compilation-error-list
1414 (equal (cdr (car compilation-error-list))
1416 (setq compilation-error-list (cdr compilation-error-list))))
1418 ;; We now have a marker for the position of the error source code.
1419 ;; NEXT-ERROR is a cons (ERROR . SOURCE) of two markers.
1422 (defun compilation-goto-locus (next-error)
1423 "Jump to an error locus returned by `compilation-next-error-locus'.
1424 Takes one argument, a cons (ERROR . SOURCE) of two markers.
1425 Selects a window with point at SOURCE, with another window displaying ERROR."
1426 (if (and (window-dedicated-p (selected-window))
1427 (eq (selected-window) (frame-root-window)))
1428 (switch-to-buffer-other-frame (marker-buffer (cdr next-error)))
1429 (switch-to-buffer (marker-buffer (cdr next-error))))
1430 (goto-char (cdr next-error))
1431 ;; If narrowing got in the way of
1432 ;; going to the right place, widen.
1433 (or (= (point) (marker-position (cdr next-error)))
1436 (goto-char (cdr next-error))))
1438 ;; Show compilation buffer in other window, scrolled to this error.
1439 (let* ((pop-up-windows t)
1440 ;; Use an existing window if it is in a visible frame.
1441 (w (or (get-buffer-window (marker-buffer (car next-error)) 'visible)
1443 (display-buffer (marker-buffer (car next-error))))))
1444 (set-window-point w (car next-error))
1445 (set-window-start w (car next-error))
1446 (compilation-set-window-height w)))
1448 ;; Find a buffer for file FILENAME.
1449 ;; Search the directories in compilation-search-path.
1450 ;; A nil in compilation-search-path means to try the
1451 ;; current directory, which is passed in DIR.
1452 ;; If FILENAME is not found at all, ask the user where to find it.
1453 ;; Pop up the buffer containing MARKER and scroll to MARKER if we ask the user.
1454 (defun compilation-find-file (marker filename dir &rest formats)
1455 (or formats (setq formats '("%s")))
1456 (let ((dirs compilation-search-path)
1457 buffer thisdir fmts name)
1458 (if (file-name-absolute-p filename)
1459 ;; The file name is absolute. Use its explicit directory as
1460 ;; the first in the search path, and strip it from FILENAME.
1461 (setq filename (abbreviate-file-name (expand-file-name filename))
1462 dirs (cons (file-name-directory filename) dirs)
1463 filename (file-name-nondirectory filename)))
1464 ;; Now search the path.
1465 (while (and dirs (null buffer))
1466 (setq thisdir (or (car dirs) dir)
1468 ;; For each directory, try each format string.
1469 (while (and fmts (null buffer))
1470 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1471 buffer (and (file-exists-p name)
1472 (find-file-noselect name))
1474 (setq dirs (cdr dirs)))
1476 ;; The file doesn't exist.
1477 ;; Ask the user where to find it.
1478 ;; If he hits C-g, then the next time he does
1479 ;; next-error, he'll skip past it.
1480 (let* ((pop-up-windows t)
1481 (w (display-buffer (marker-buffer marker))))
1482 (set-window-point w marker)
1483 (set-window-start w marker)
1484 (let ((name (expand-file-name
1486 (format "Find this error in: (default %s) "
1489 (if (file-directory-p name)
1490 (setq name (expand-file-name filename name)))
1491 (and (file-exists-p name)
1492 (find-file-noselect name)))))))
1494 ;; Set compilation-error-list to nil, and unchain the markers that point to the
1495 ;; error messages and their text, so that they no longer slow down gap motion.
1496 ;; This would happen anyway at the next garbage collection, but it is better to
1497 ;; do it right away.
1498 (defun compilation-forget-errors ()
1499 (while compilation-old-error-list
1500 (let ((next-error (car compilation-old-error-list)))
1501 (set-marker (car next-error) nil)
1502 (if (markerp (cdr next-error))
1503 (set-marker (cdr next-error) nil)))
1504 (setq compilation-old-error-list (cdr compilation-old-error-list)))
1505 (setq compilation-error-list nil
1506 compilation-directory-stack nil
1507 compilation-parsing-end 1)
1508 ;; Remove the highlighting added by compile-reinitialize-errors:
1509 (let ((inhibit-read-only t))
1510 (remove-text-properties (point-min) (point-max) '(mouse-face highlight)))
1514 ;; This function is not needed any more by compilation mode.
1515 ;; Does anyone else need it or can it be deleted?
1516 (defun count-regexp-groupings (regexp)
1517 "Return the number of \\( ... \\) groupings in REGEXP (a string)."
1519 (len (length regexp))
1523 (setq c (aref regexp i)
1526 ;; Find the end of this [...].
1527 (while (and (< i len)
1528 (not (= (aref regexp i) ?\])))
1533 (setq c (aref regexp i)
1536 ;; We found the end of a grouping,
1537 ;; so bump our counter.
1538 (setq groupings (1+ groupings))))))))
1541 (defvar compilation-current-file nil
1542 "Used by compilation-parse-errors to store filename for file being compiled")
1544 ;; This variable is not used as a global variable. It's defined here just to
1545 ;; shut up the byte compiler. It's bound and used by compilation-parse-errors
1546 ;; and set by compile-collect-regexps.
1547 (defvar compilation-regexps nil)
1549 (defun compilation-parse-errors (limit-search find-at-least)
1550 "Parse the current buffer as grep, cc, lint or other error messages.
1551 See variable `compilation-parse-errors-function' for the interface it uses."
1552 (setq compilation-error-list nil)
1553 (message "Parsing error messages...")
1554 (if (null compilation-error-regexp-alist)
1555 (error "compilation-error-regexp-alist is empty!"))
1556 (let* ((compilation-regexps nil) ; Variable set by compile-collect-regexps.
1558 (compilation-num-errors-found 0)
1559 ;; Set up now the expanded, abbreviated directory variables
1560 ;; that compile-abbreviate-directory will need, so we can
1561 ;; compute them just once here.
1562 (orig (abbreviate-file-name default-directory))
1563 (orig-expanded (abbreviate-file-name
1564 (file-truename default-directory)))
1565 (parent-expanded (abbreviate-file-name
1566 (expand-file-name "../" orig-expanded))))
1568 ;; Make a list of all the regexps. Each element has the form
1569 ;; (REGEXP TYPE IDX1 IDX2 ...)
1570 ;; where TYPE is one of leave, enter, file, error or nomessage.
1571 (compile-collect-regexps 'leave compilation-leave-directory-regexp-alist)
1572 (compile-collect-regexps 'enter compilation-enter-directory-regexp-alist)
1573 (compile-collect-regexps 'file compilation-file-regexp-alist)
1574 (compile-collect-regexps 'nomessage compilation-nomessage-regexp-alist)
1575 (compile-collect-regexps 'error compilation-error-regexp-alist)
1577 ;; Don't reparse messages already seen at last parse.
1578 (goto-char compilation-parsing-end)
1581 (setq compilation-current-file nil) ; No current file at start.
1582 ;; Don't parse the first two lines as error messages.
1583 ;; This matters for grep.
1587 (while (not (or found-desired (eobp)))
1588 (let ((this compilation-regexps) (prev nil) (alist nil) type)
1589 ;; Go through the regular expressions. If a match is found,
1590 ;; variable alist is set to the corresponding alist and the
1591 ;; matching regexp is moved to the front of compilation-regexps
1592 ;; to make it match faster next time.
1593 (while (and this (null alist))
1594 (if (not (looking-at (car (car this))))
1595 (progn (setq prev this) ; No match, go to next.
1596 (setq this (cdr this)))
1597 (setq alist (cdr (car this))) ; Got a match.
1598 ;;; (if prev ; If not the first regexp,
1599 ;;; (progn ; move it to the front.
1600 ;;; (setcdr prev (cdr this))
1601 ;;; (setcdr this compilation-regexps)
1602 ;;; (setq compilation-regexps this)))
1604 (if (and alist ; Seen a match and not to
1605 (not (eq (setq type (car alist)) 'nomessage))) ; be ignored.
1606 (let* ((end-of-match (match-end 0))
1608 (compile-buffer-substring (car (setq alist (cdr alist)))))
1610 (if (eq type 'error) ; error message
1611 (let* ((linenum (if (numberp (car (setq alist (cdr alist))))
1613 (compile-buffer-substring (car alist)))
1614 ;; (car alist) is not a number, must be a
1615 ;; function that is called below to return
1616 ;; an error position descriptor.
1618 ;; Convert to integer later if linenum not a function.
1619 (column (compile-buffer-substring
1620 (car (setq alist (cdr alist)))))
1623 ;; Check that we have a file name.
1625 ;; No file name in message, we must have seen it before
1626 (setq filename compilation-current-file)
1628 An error message with no file name and no file name has been seen earlier."))
1630 ;; Check for a comint-file-name-prefix and prepend it if
1631 ;; appropriate. (This is very useful for
1632 ;; compilation-minor-mode in an rlogin-mode buffer.)
1633 (and (boundp 'comint-file-name-prefix)
1634 ;; If file name is relative, default-directory will
1635 ;; already contain the comint-file-name-prefix (done
1636 ;; by compile-abbreviate-directory).
1637 (file-name-absolute-p filename)
1639 (concat comint-file-name-prefix filename)))
1641 ;; Some compilers (e.g. Sun's java compiler, reportedly)
1642 ;; produce bogus file names like "./bar//foo.c" for file
1643 ;; "bar/foo.c"; expand-file-name will collapse these into
1644 ;; "/foo.c" and fail to find the appropriate file. So we
1645 ;; look for doubled slashes in the file name and fix them
1646 ;; up in the buffer.
1647 (setq filename (command-line-normalize-file-name filename))
1650 (cons filename (cons default-directory (cdr alist))))
1652 ;; Locate the erring file and line.
1653 ;; Make this-error a new elt for compilation-error-list,
1654 ;; giving a marker for the current compilation buffer
1655 ;; location, and the file and line number of the error.
1656 ;; Save, as the start of the error, the beginning of the
1657 ;; line containing the match.
1658 (if (setq this-error
1659 (if (numberp linenum)
1660 (list (point-marker) filename linenum
1661 (and column (string-to-int column)))
1662 ;; If linenum is not a number then it must be
1663 ;; a function returning an error position
1664 ;; descriptor or nil (meaning no position).
1666 (funcall linenum filename column))))
1668 ;; We have an error position descriptor.
1669 ;; If we have found as many new errors as the user
1670 ;; wants, or if we are past the buffer position he
1671 ;; indicated, then we continue to parse until we have
1672 ;; seen all consecutive errors in the same file. This
1673 ;; means that all the errors of a source file will be
1674 ;; seen in one parsing run, so that the error positions
1675 ;; will be recorded as markers in the source file
1676 ;; buffer that will move when the buffer is changed.
1677 (if (and (or (and find-at-least
1678 (>= compilation-num-errors-found
1681 (>= end-of-match limit-search)))
1682 compilation-error-list ;At least one previous.
1683 (not (equal ; Same filename?
1684 (car (cdr (car compilation-error-list)))
1685 (car (cdr this-error)))))
1686 ;; We are past the limits and the last error
1687 ;; parsed, didn't belong to the same source file
1688 ;; as the earlier ones i.e. we have seen all the
1689 ;; errors belonging to the earlier file. We don't
1690 ;; add the error just parsed so that the next
1691 ;; parsing run can get it and the following errors
1692 ;; in the same file all at once.
1693 (setq found-desired t)
1695 (goto-char end-of-match) ; Prepare for next message.
1696 ;; Don't add the same source line more than once.
1698 compilation-error-list
1699 (equal (cdr (car compilation-error-list))
1701 (setq compilation-error-list
1702 (cons this-error compilation-error-list)
1703 compilation-num-errors-found
1704 (1+ compilation-num-errors-found))))))
1706 ;; Not an error message.
1707 (if (eq type `file) ; Change current file.
1708 (and filename (setq compilation-current-file filename))
1709 ;; Enter or leave directory.
1710 (setq stack compilation-directory-stack)
1714 ;; The directory name in the message
1715 ;; is a truename. Try to convert it to a form
1716 ;; like what the user typed in.
1717 (compile-abbreviate-directory
1718 (file-name-as-directory
1719 (expand-file-name filename))
1720 orig orig-expanded parent-expanded)))
1721 (if (eq type 'leave)
1723 (not (string-equal (car stack)
1725 (setq stack (cdr stack)))
1726 (setq compilation-directory-stack
1727 (cons filename compilation-directory-stack)
1728 default-directory filename)))
1729 (and (eq type 'leave)
1731 (setq compilation-directory-stack (cdr stack))
1732 (setq stack (car compilation-directory-stack))
1733 (setq default-directory stack))
1734 (goto-char end-of-match) ; Prepare to look at next message.
1735 (and limit-search (>= end-of-match limit-search)
1736 ;; The user wanted a specific error, and we're past it.
1737 ;; We do this check here rather than at the end of the
1738 ;; loop because if the last thing seen is an error
1739 ;; message, we must carefully discard the last error
1740 ;; when it is the first in a new file (see above in
1741 ;; the error-message case)
1742 (setq found-desired t))))
1744 ;; Go to before the last character in the message so that we will
1745 ;; see the next line also when the message ended at end of line.
1746 ;; When we ignore the last error message above, this will
1747 ;; cancel the effect of forward-line below so that point
1751 ;; Is this message necessary any more? Parsing is now so fast
1752 ;; that you might not need to know how it proceeds.
1754 "Parsing error messages...%d found. %.0f%% of buffer seen."
1755 compilation-num-errors-found
1756 ;; Use floating-point because (* 100 (point)) frequently
1757 ;; exceeds the range of Emacs Lisp integers.
1758 (/ (* 100.0 (point)) (point-max)))
1761 (forward-line 1))) ; End of while loop. Look at next line.
1763 (setq compilation-parsing-end (point))
1764 (setq compilation-error-list (nreverse compilation-error-list))
1765 ;;; (message "Parsing error messages...done. %d found. %.0f%% of buffer seen."
1766 ;;; compilation-num-errors-found
1767 ;;; (/ (* 100.0 (point)) (point-max)))
1768 (message "Parsing error messages...done.")))
1770 (defun compile-collect-regexps (type this)
1771 ;; Add elements to variable compilation-regexps that is bound in
1772 ;; compilation-parse-errors.
1773 (and (not (eq this t))
1775 (setq compilation-regexps
1776 (cons (cons (car (car this)) (cons type (cdr (car this))))
1777 compilation-regexps))
1778 (setq this (cdr this)))))
1780 (defun compile-buffer-substring (index)
1781 ;; Get substring matched by INDEXth subexpression.
1783 (let ((beg (match-beginning index)))
1784 (if beg (buffer-substring beg (match-end index))))))
1786 ;; If directory DIR is a subdir of ORIG or of ORIG's parent,
1787 ;; return a relative name for it starting from ORIG or its parent.
1788 ;; ORIG-EXPANDED is an expanded version of ORIG.
1789 ;; PARENT-EXPANDED is an expanded version of ORIG's parent.
1790 ;; Those two args could be computed here, but we run faster by
1791 ;; having the caller compute them just once.
1792 (defun compile-abbreviate-directory (dir orig orig-expanded parent-expanded)
1793 ;; Apply canonical abbreviations to DIR first thing.
1794 ;; Those abbreviations are already done in the other arguments passed.
1795 (setq dir (abbreviate-file-name dir))
1797 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1798 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1800 (if (boundp 'comint-file-name-prefix)
1801 (setq dir (concat comint-file-name-prefix dir)))
1803 (if (and (> (length dir) (length orig-expanded))
1804 (string= orig-expanded
1805 (substring dir 0 (length orig-expanded))))
1808 (substring dir (length orig-expanded)))))
1809 (if (and (> (length dir) (length parent-expanded))
1810 (string= parent-expanded
1811 (substring dir 0 (length parent-expanded))))
1813 (concat (file-name-directory
1814 (directory-file-name orig))
1815 (substring dir (length parent-expanded)))))
1820 ;;; compile.el ends here