1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages
3 ;; Copyright (C) 1985, 86, 87, 93, 94, 95, 96, 97, 98, 1999, 2001, 03, 2004
4 ;; Free Software Foundation, Inc.
6 ;; Authors: Roland McGrath <roland@gnu.org>,
7 ;; Daniel Pfeiffer <occitan@esperanto.org>
9 ;; Keywords: tools, processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; This package provides the compile facilities documented in the Emacs user's
33 ;; This mode uses some complex data-structures:
35 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE)
37 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
38 ;; LINE will be nil for a message that doesn't contain them. Then the
39 ;; location refers to a indented beginning of line or beginning of file.
40 ;; Once any location in some file has been jumped to, the list is extended to
41 ;; (COLUMN LINE FILE-STRUCTURE MARKER . VISITED) for all LOCs pertaining to
43 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
44 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
45 ;; before that point. VISITED is t if we have jumped there, else nil.
47 ;; FILE-STRUCTURE is a list of
48 ;; ((FILENAME . DIRECTORY) FORMATS (LINE LOC ...) ...)
50 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
51 ;; obtained by following directory change messages. DIRECTORY will be nil for
52 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
53 ;; a file of that name can't be found.
54 ;; The rest of the list is an alist of elements with LINE as key. The keys
55 ;; are either nil or line numbers. If present, nil comes first, followed by
56 ;; the numbers in decreasing order. The LOCs for each line are again an alist
57 ;; ordered the same way. Note that the whole file structure is referenced in
60 ;; MESSAGE is a list of (LOC TYPE END-LOC)
62 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
63 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
64 ;; other end, if the parsed message contained a range. If the end of the
65 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
66 ;; These are the value of the `message' text-properties in the compilation
71 (eval-when-compile (require 'cl))
73 (defgroup compilation nil
74 "Run compiler as inferior of Emacs, parse error messages."
80 (defcustom compilation-mode-hook nil
81 "*List of hook functions run by `compilation-mode' (see `run-hooks')."
86 (defcustom compilation-window-height nil
87 "*Number of lines in a compilation window. If nil, use Emacs default."
88 :type '(choice (const :tag "Default" nil)
92 (defvar compilation-first-column 1
93 "*This is how compilers number the first column, usually 1 or 0.")
95 (defvar compilation-parse-errors-filename-function nil
96 "Function to call to post-process filenames while parsing error messages.
97 It takes one arg FILENAME which is the name of a file as found
98 in the compilation output, and should return a transformed file name.")
101 (defvar compilation-process-setup-function nil
102 "*Function to call to customize the compilation process.
103 This function is called immediately before the compilation process is
104 started. It can be used to set any variables or functions that are used
105 while processing the output of the compilation process. The function
106 is called with variables `compilation-buffer' and `compilation-window'
107 bound to the compilation buffer and window, respectively.")
110 (defvar compilation-buffer-name-function nil
111 "Function to compute the name of a compilation buffer.
112 The function receives one argument, the name of the major mode of the
113 compilation buffer. It should return a string.
114 nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
117 (defvar compilation-finish-function nil
118 "Function to call when a compilation process finishes.
119 It is called with two arguments: the compilation buffer, and a string
120 describing how the process finished.")
123 (defvar compilation-finish-functions nil
124 "Functions to call when a compilation process finishes.
125 Each function is called with two arguments: the compilation buffer,
126 and a string describing how the process finished.")
128 (defvar compilation-in-progress nil
129 "List of compilation processes now running.")
130 (or (assq 'compilation-in-progress minor-mode-alist)
131 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
134 (defvar compilation-error "error"
135 "Stem of message to print when no matches are found.")
137 (defvar compilation-arguments nil
138 "Arguments that were given to `compilation-start'.")
140 (defvar compilation-num-errors-found)
142 (defconst compilation-error-regexp-alist-alist
144 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
145 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
148 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
151 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
154 "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):[0-9]+:[0-9]+:\\)?\
155 \\( warning\\)?" 1 2 3 (4))
158 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
161 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
162 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
163 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
166 "^ *File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
167 \\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning:\\)?\\)"
168 2 (3 . 4) (5 . 6) (7))
171 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
172 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
175 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
178 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
182 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
185 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
189 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
190 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
192 ;; fixme: should be `mips'
194 "^[-[:alnum:]_/]+: \\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*:\
195 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
198 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
201 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
203 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
205 (2 (compilation-face '(3))))
208 "^\\(?:In file included\\| \\) from \
209 \\(.+\\):\\([0-9]+\\)\\(?:\\(:\\)\\|\\(,\\)\\)?" 1 2 nil (3 . 4))
212 "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\)?\
213 \\([/.]*[a-zA-Z]:?[^ \t\n:]*\\): ?\
214 \\([0-9]+\\)\\([.:]?\\)\\([0-9]+\\)?\
215 \\(?:-\\(?:\\([0-9]+\\)\\3\\)?\\.?\\([0-9]+\\)?\\)?:\
216 \\(?: *\\(\\(?:Future\\|Runtime\\)?[Ww]arning\\|W:\\)\\|\
217 *\\([Ii]nfo\\(?:\\>\\|rmationa?l?\\)\\|I:\\)\\)?"
218 1 (2 . 5) (4 . 6) (7 . 8))
221 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
225 "^makepp: \\(?:\\(?:warning\\(:\\).*?\\|\\(Scanning\\|[LR]e?l?oading makefile\\) \\|.*?\\)\
226 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)'\\)"
228 ("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)'" nil nil
229 (2 compilation-info-face)
230 (3 compilation-line-face nil t)
231 (1 (compilation-error-properties 2 3 nil nil nil 0 nil)
234 ;; Should be lint-1, lint-2 (SysV lint)
236 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
238 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
241 "^\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
242 : \\(?:error\\|warnin\\(g\\)\\) C[0-9]+:" 1 2 nil (3))
245 "^Semantic error at line \\([0-9]+\\), column \\([0-9]+\\), file \\(.*\\):$"
249 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\)" 1 2)
252 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
253 \\([0-9]+\\) of file://\\(.+\\)"
257 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
258 [12][09][0-9][0-9] +\\(.*\\):$"
261 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
262 nil 3 nil (2) nil (1 (compilation-face '(2))))
263 (sparc-pascal-example
264 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
265 nil 1 nil (3) nil (2 (compilation-face '(3))))
268 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
269 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
273 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
276 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
277 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3)))
278 "Alist of values for `compilation-error-regexp-alist'.")
280 (defcustom compilation-error-regexp-alist
281 (mapcar 'car compilation-error-regexp-alist-alist)
282 "Alist that specifies how to match errors in compiler output.
283 Note that on Unix everything is a valid filename, so these
284 matchers must make some common sense assumptions, which catch
285 normal cases. A shorter list will be lighter on resource usage.
287 Instead of an alist element, you can use a symbol, which is
288 looked up in `compilation-error-regexp-alist-alist'. You can see
289 the predefined symbols and their effects in the file
290 `etc/compilation.txt' (linked below if you are customizing this).
292 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
293 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
294 gives the file name, and the LINE'th subexpression gives the line
295 number. The COLUMN'th subexpression gives the column number on
298 If FILE, LINE or COLUMN are nil or that index didn't match, that
299 information is not present on the matched line. In that case the
300 file name is assumed to be the same as the previous one in the
301 buffer, line number defaults to 1 and column defaults to
302 beginning of line's indentation.
304 FILE can also have the form (FILE FORMAT...), where the FORMATs
305 \(e.g. \"%s.c\") will be applied in turn to the recognized file
306 name, until a file of that name is found. Or FILE can also be a
307 function to return the filename.
309 LINE can also be of the form (LINE . END-LINE) meaning a range
310 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
311 meaning a range of columns starting on LINE and ending on
312 END-LINE, if that matched.
314 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
315 TYPE can also be of the form (WARNING . INFO). In that case this
316 will be equivalent to 1 if the WARNING'th subexpression matched
317 or else equivalent to 0 if the INFO'th subexpression matched.
318 See `compilation-error-face', `compilation-warning-face',
319 `compilation-info-face' and `compilation-skip-threshold'.
321 What matched the HYPERLINK'th subexpression has `mouse-face' and
322 `compilation-message-face' applied. If this is nil, the text
323 matched by the whole REGEXP becomes the hyperlink.
325 Additional HIGHLIGHTs as described under `font-lock-keywords' can
327 :type `(set :menu-tag "Pick"
328 ,@(mapcar (lambda (elt)
329 (list 'const (car elt)))
330 compilation-error-regexp-alist-alist))
331 :link `(file-link :tag "example file"
332 ,(concat doc-directory "compilation.txt"))
335 (defvar compilation-directory nil
336 "Directory to restore to when doing `recompile'.")
338 (defvar compilation-directory-matcher
339 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
340 "A list for tracking when directories are entered or left.
341 Nil means not to track directories, e.g. if all file names are absolute. The
342 first element is the REGEXP matching these messages. It can match any number
343 of variants, e.g. different languages. The remaining elements are all of the
344 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
345 matches, that is a directory name. If LEAVE is nil or the corresponding
346 LEAVE'th subexpression doesn't match, this message is about going into another
347 directory. If it does match anything, this message is about going back to the
348 directory we were in before the last entering message. If you change this,
349 you may also want to change `compilation-page-delimiter'.")
351 (defvar compilation-page-delimiter
352 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
353 "Value of `page-delimiter' in Compilation mode.")
355 (defvar compilation-mode-font-lock-keywords
356 '(;; configure output lines.
357 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
358 (1 font-lock-variable-name-face)
359 (2 (compilation-face '(4 . 3))))
360 ;; Command output lines. Recognize `make[n]:' lines too.
361 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
362 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
363 (" --?o\\(?:utfile\\|utput\\)?[= ]?\\(\\S +\\)" . 1)
364 ("^Compilation finished" . compilation-info-face)
365 ("^Compilation exited abnormally" . compilation-error-face))
366 "Additional things to highlight in Compilation mode.
367 This gets tacked on the end of the generated expressions.")
369 (defvar compilation-highlight-regexp t
370 "Regexp matching part of visited source lines to highlight temporarily.
371 Highlight entire line if t; don't highlight source lines if nil.")
373 (defvar compilation-highlight-overlay nil
374 "Overlay used to temporarily highlight compilation matches.")
376 (defcustom compilation-error-screen-columns t
377 "*If non-nil, column numbers in error messages are screen columns.
378 Otherwise they are interpreted as character positions, with
379 each character occupying one column.
380 The default is to use screen columns, which requires that the compilation
381 program and Emacs agree about the display width of the characters,
382 especially the TAB character."
387 (defcustom compilation-read-command t
388 "*Non-nil means \\[compile] reads the compilation command to use.
389 Otherwise, \\[compile] just uses the value of `compile-command'."
394 (defcustom compilation-ask-about-save t
395 "*Non-nil means \\[compile] asks which buffers to save before compiling.
396 Otherwise, it saves all modified buffers without asking."
401 (defcustom compilation-search-path '(nil)
402 "*List of directories to search for source files named in error messages.
403 Elements should be directory names, not file names of directories.
404 nil as an element means to try the default directory."
405 :type '(repeat (choice (const :tag "Default" nil)
406 (string :tag "Directory")))
409 (defcustom compile-command "make -k "
410 "*Last shell command used to do a compilation; default for next compilation.
412 Sometimes it is useful for files to supply local values for this variable.
413 You might also use mode hooks to specify it in certain modes, like this:
415 (add-hook 'c-mode-hook
417 (unless (or (file-exists-p \"makefile\")
418 (file-exists-p \"Makefile\"))
419 (set (make-local-variable 'compile-command)
421 (file-name-sans-extension buffer-file-name))))))"
425 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
426 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
427 ;; key. This holds the tree seen from root, for storing new nodes.
428 (defvar compilation-locs ())
430 (defvar compilation-debug nil
431 "*Set this to t before creating a *compilation* buffer.
432 Then every error line will have a debug text property with the matcher that
433 fit this line and the match data. Use `describe-text-properties'.")
435 (defvar compilation-exit-message-function nil "\
436 If non-nil, called when a compilation process dies to return a status message.
437 This should be a function of three arguments: process status, exit status,
438 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
439 write into the compilation buffer, and to put in its mode line.")
441 (defvar compilation-environment nil
442 "*List of environment variables for compilation to inherit.
443 Each element should be a string of the form ENVVARNAME=VALUE.
444 This list is temporarily prepended to `process-environment' prior to
445 starting the compilation process.")
447 ;; History of compile commands.
448 (defvar compile-history nil)
450 (defface compilation-warning-face
451 '((((type tty) (class color)) (:foreground "cyan" :weight bold))
452 (((class color)) (:foreground "Orange" :weight bold))
454 "Face used to highlight compiler warnings."
455 :group 'font-lock-highlighting-faces
458 (defface compilation-info-face
459 '((((type tty) (class color)) (:foreground "green" :weight bold))
460 (((class color) (background light)) (:foreground "Green3" :weight bold))
461 (((class color) (background dark)) (:foreground "Green" :weight bold))
463 "Face used to highlight compiler warnings."
464 :group 'font-lock-highlighting-faces
467 (defvar compilation-message-face nil
468 "Face name to use for whole messages.
469 Faces `compilation-error-face', `compilation-warning-face',
470 `compilation-info-face', `compilation-line-face' and
471 `compilation-column-face' get prepended to this, when applicable.")
473 (defvar compilation-error-face 'font-lock-warning-face
474 "Face name to use for file name in error messages.")
476 (defvar compilation-warning-face 'compilation-warning-face
477 "Face name to use for file name in warning messages.")
479 (defvar compilation-info-face 'compilation-info-face
480 "Face name to use for file name in informational messages.")
482 (defvar compilation-line-face 'font-lock-variable-name-face
483 "Face name to use for line number in message.")
485 (defvar compilation-column-face 'font-lock-type-face
486 "Face name to use for column number in message.")
488 ;; same faces as dired uses
489 (defvar compilation-enter-directory-face 'font-lock-function-name-face
490 "Face name to use for column number in message.")
492 (defvar compilation-leave-directory-face 'font-lock-type-face
493 "Face name to use for column number in message.")
497 ;; Used for compatibility with the old compile.el.
498 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
499 (defvar compilation-parsing-end (make-marker))
500 (defvar compilation-parse-errors-function nil)
501 (defvar compilation-error-list nil)
502 (defvar compilation-old-error-list nil)
504 (defun compilation-face (type)
505 (or (and (car type) (match-end (car type)) compilation-warning-face)
506 (and (cdr type) (match-end (cdr type)) compilation-info-face)
507 compilation-error-face))
509 (defun compilation-directory-properties (idx leave)
510 (if leave (setq leave (match-end leave)))
511 ;; find previous stack, and push onto it, or if `leave' pop it
512 (let ((dir (previous-single-property-change (point) 'directory)))
513 (setq dir (if dir (or (get-text-property (1- dir) 'directory)
514 (get-text-property dir 'directory))))
516 compilation-leave-directory-face
517 compilation-enter-directory-face)
520 '(nil)) ; nil only isn't a property-change
521 (cons (match-string-no-properties idx) dir))
523 keymap compilation-button-map
524 help-echo "mouse-2: visit current directory")))
526 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
527 ;; KEY element from the ALIST, creating it in the right position if not already
528 ;; present. ALIST structure is
529 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
530 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
531 ;; may be nil. The other KEYs are ordered backwards so that growing line
532 ;; numbers can be inserted in front and searching can abort after half the
534 (eval-when-compile ;Don't keep it at runtime if not needed.
535 (defmacro compilation-assq (key alist)
538 (car (if (if (null ,key)
539 (if l2 (null (caar l2)))
540 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
543 (if l2 (eq ,key (caar l2))))
545 (setcdr l1 (cons (list ,key) l2)))))))
548 ;; This function is the central driver, called when font-locking to gather
549 ;; all information needed to later jump to corresponding source code.
550 ;; Return a property list with all meta information on this error location.
551 (defun compilation-error-properties (file line end-line col end-col type fmt)
552 (unless (< (next-single-property-change (match-beginning 0) 'directory nil (point))
556 (setq file (funcall file))
558 (setq file (match-string-no-properties file))
559 (unless (file-name-absolute-p file)
560 (setq dir (previous-single-property-change (point) 'directory)
561 dir (if dir (or (get-text-property (1- dir) 'directory)
562 (get-text-property dir 'directory)))))
563 (setq file (cons file (car dir)))))
564 ;; This message didn't mention one, get it from previous
565 (setq file (previous-single-property-change (point) 'message)
567 (car (nth 2 (car (or (get-text-property (1- file) 'message)
568 (get-text-property file 'message))))))
570 ;; All of these fields are optional, get them only if we have an index, and
571 ;; it matched some part of the message.
573 (setq line (match-string-no-properties line))
574 (setq line (string-to-number line)))
576 (setq end-line (match-string-no-properties end-line))
577 (setq end-line (string-to-number end-line)))
579 (setq col (match-string-no-properties col))
580 (setq col (- (string-to-number col) compilation-first-column)))
581 (if (and end-col (setq end-col (match-string-no-properties end-col)))
582 (setq end-col (- (string-to-number end-col) compilation-first-column))
583 (if end-line (setq end-col -1)))
584 (if (consp type) ; not a static type, check what it is.
585 (setq type (or (and (car type) (match-end (car type)) 1)
586 (and (cdr type) (match-end (cdr type)) 0)
588 (compilation-internal-error-properties file line end-line col end-col type fmt)))
590 (defun compilation-internal-error-properties (file line end-line col end-col type fmt)
591 "Get the meta-info that will be added as text-properties.
592 LINE, END-LINE, COL, END-COL are integers or nil.
593 TYPE can be 0, 1, or 2.
594 FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil."
595 (unless file (setq file '("*unknown*")))
596 (setq file (compilation-get-file-structure file fmt))
597 ;; Get first already existing marker (if any has one, all have one).
598 ;; Do this first, as the compilation-assq`s may create new nodes.
599 (let* ((marker-line (car (cddr file))) ; a line structure
600 (marker (nth 3 (cadr marker-line))) ; its marker
601 (compilation-error-screen-columns compilation-error-screen-columns)
602 end-marker loc end-loc)
603 (if (not (and marker (marker-buffer marker)))
604 (setq marker) ; no valid marker for this file
605 (setq loc (or line 1)) ; normalize no linenumber to line 1
606 (catch 'marker ; find nearest loc, at least one exists
607 (dolist (x (nthcdr 3 file)) ; loop over remaining lines
608 (if (> (car x) loc) ; still bigger
610 (if (> (- (or (car marker-line) 1) loc)
611 (- loc (car x))) ; current line is nearer
612 (setq marker-line x))
614 (setq marker (nth 3 (cadr marker-line))
615 marker-line (or (car marker-line) 1))
616 (with-current-buffer (marker-buffer marker)
619 (goto-char (marker-position marker))
620 (when (or end-col end-line)
621 (beginning-of-line (- (or end-line line) marker-line -1))
624 (if compilation-error-screen-columns
625 (move-to-column end-col)
626 (forward-char end-col)))
627 (setq end-marker (list (point-marker))))
628 (beginning-of-line (if end-line
630 (- loc marker-line -1)))
632 (if compilation-error-screen-columns
635 (forward-to-indentation 0))
636 (setq marker (list (point-marker))))))
638 (setq loc (compilation-assq line (cdr file)))
640 (setq end-loc (compilation-assq end-line (cdr file))
641 end-loc (compilation-assq end-col end-loc))
642 (if end-col ; use same line element
643 (setq end-loc (compilation-assq end-col loc))))
644 (setq loc (compilation-assq col loc))
645 ;; If they are new, make the loc(s) reference the file they point to.
646 (or (cdr loc) (setcdr loc `(,line ,file ,@marker)))
648 (or (cdr end-loc) (setcdr end-loc `(,(or end-line line) ,file ,@end-marker))))
650 ;; Must start with face
651 `(face ,compilation-message-face
652 message (,loc ,type ,end-loc)
653 ,@(if compilation-debug
654 `(debug (,(assoc (with-no-warnings matcher) font-lock-keywords)
657 "mouse-2: visit this file, line and column"
659 "mouse-2: visit this file and line"
660 "mouse-2: visit this file"))
661 keymap compilation-button-map
662 mouse-face highlight)))
664 (defun compilation-mode-font-lock-keywords ()
665 "Return expressions to highlight in Compilation mode."
666 (if compilation-parse-errors-function
667 ;; An old package! Try the compatibility code.
668 '((compilation-compat-parse-errors))
670 ;; make directory tracking
671 (if compilation-directory-matcher
672 `((,(car compilation-directory-matcher)
673 ,@(mapcar (lambda (elt)
675 (compilation-directory-properties
676 ,(car elt) ,(cdr elt))
678 (cdr compilation-directory-matcher)))))
680 ;; Compiler warning/error lines.
684 (setq item (cdr (assq item
685 compilation-error-regexp-alist-alist))))
686 (let ((file (nth 1 item))
690 end-line end-col fmt)
691 (if (consp file) (setq fmt (cdr file) file (car file)))
692 (if (consp line) (setq end-line (cdr line) line (car line)))
693 (if (consp col) (setq end-col (cdr col) col (car col)))
696 ;; The old compile.el had here an undocumented hook that
697 ;; allowed `line' to be a function that computed the actual
698 ;; error location. Let's do our best.
700 (0 (compilation-compat-error-properties
701 (funcall ',line (cons (match-string ,file)
702 (cons default-directory
704 ,(if col `(match-string ,col)))))
705 (,file compilation-error-face t))
707 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
708 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
712 ,@(when (integerp file)
713 `((,file ,(if (consp type)
714 `(compilation-face ',type)
715 (aref [compilation-info-face
716 compilation-warning-face
717 compilation-error-face]
721 `((,line compilation-line-face nil t)))
723 `((,end-line compilation-line-face nil t)))
726 `((,col compilation-column-face nil t)))
728 `((,end-col compilation-column-face nil t)))
731 (,(or (nth 5 item) 0)
732 (compilation-error-properties ',file ,line ,end-line
733 ,col ,end-col ',(or type 2)
735 append))))) ; for compilation-message-face
736 compilation-error-regexp-alist)
738 compilation-mode-font-lock-keywords)))
742 (defun compile (command &optional comint)
743 "Compile the program including the current buffer. Default: run `make'.
744 Runs COMMAND, a shell command, in a separate process asynchronously
745 with output going to the buffer `*compilation*'.
747 If optional second arg COMINT is t the buffer will be in Comint mode with
748 `compilation-shell-minor-mode'.
750 You can then use the command \\[next-error] to find the next error message
751 and move to the source code that caused it.
753 Interactively, prompts for the command if `compilation-read-command' is
754 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
755 Additionally, with universal prefix arg, compilation buffer will be in
756 comint mode, i.e. interactive.
758 To run more than one compilation at once, start one and rename
759 the \`*compilation*' buffer to some other name with
760 \\[rename-buffer]. Then start the next one. On most systems,
761 termination of the main compilation process kills its
764 The name used for the buffer is actually whatever is returned by
765 the function in `compilation-buffer-name-function', so you can set that
766 to a function that generates a unique name."
769 (if (or compilation-read-command current-prefix-arg)
770 (read-from-minibuffer "Compile command: "
771 (eval compile-command) nil nil
772 '(compile-history . 1))
773 (eval compile-command))
774 (consp current-prefix-arg)))
775 (unless (equal command (eval compile-command))
776 (setq compile-command command))
777 (save-some-buffers (not compilation-ask-about-save) nil)
778 (setq compilation-directory default-directory)
779 (compilation-start command comint))
781 ;; run compile with the default command line
783 "Re-compile the program including the current buffer.
784 If this is run in a Compilation mode buffer, re-use the arguments from the
785 original use. Otherwise, recompile using `compile-command'."
787 (save-some-buffers (not compilation-ask-about-save) nil)
788 (let ((default-directory (or compilation-directory default-directory)))
789 (apply 'compilation-start (or compilation-arguments
790 `(,(eval compile-command))))))
792 (defcustom compilation-scroll-output nil
793 "*Non-nil to scroll the *compilation* buffer window as output appears.
795 Setting it causes the Compilation mode commands to put point at the
796 end of their output window so that the end of the output is always
797 visible rather than the beginning."
803 (defun compilation-buffer-name (mode-name name-function)
804 "Return the name of a compilation buffer to use.
805 If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
806 to determine the buffer name.
807 Likewise if `compilation-buffer-name-function' is non-nil.
808 If current buffer is in Compilation mode for the same mode name
809 return the name of the current buffer, so that it gets reused.
810 Otherwise, construct a buffer name from MODE-NAME."
812 (funcall name-function mode-name))
813 (compilation-buffer-name-function
814 (funcall compilation-buffer-name-function mode-name))
815 ((and (eq major-mode 'compilation-mode)
816 (equal mode-name (nth 2 compilation-arguments)))
819 (concat "*" (downcase mode-name) "*"))))
821 ;; This is a rough emulation of the old hack, until the transition to new
822 ;; compile is complete.
823 (defun compile-internal (command error-message
824 &optional name-of-mode parser
825 error-regexp-alist name-function
826 enter-regexp-alist leave-regexp-alist
827 file-regexp-alist nomessage-regexp-alist
828 no-async highlight-regexp local-map)
830 (error "Compile now works very differently, see `compilation-error-regexp-alist'"))
831 (let ((compilation-error-regexp-alist
832 (append file-regexp-alist (or error-regexp-alist
833 compilation-error-regexp-alist)))
834 (compilation-error (replace-regexp-in-string "^No more \\(.+\\)s\\.?"
835 "\\1" error-message)))
836 (compilation-start command nil name-function highlight-regexp)))
837 (make-obsolete 'compile-internal 'compilation-start)
839 (defun compilation-start (command &optional mode name-function highlight-regexp)
840 "Run compilation command COMMAND (low level interface).
841 The rest of the arguments are optional; for them, nil means use the default.
843 MODE is the major mode to set in the compilation buffer. Mode
844 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
845 NAME-FUNCTION is a function called to name the buffer.
847 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
848 the matching section of the visited source line; the default is to use the
849 global value of `compilation-highlight-regexp'.
851 Returns the compilation buffer created."
852 (or mode (setq mode 'compilation-mode))
855 (prog1 "compilation" (require 'comint))
856 (replace-regexp-in-string "-mode$" "" (symbol-name mode))))
859 compilation-environment
860 (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning
861 system-uses-terminfo)
862 (list "TERM=dumb" "TERMCAP="
863 (format "COLUMNS=%d" (window-width)))
865 (format "TERMCAP=emacs:co#%d:tc=unknown:"
867 ;; Set the EMACS variable, but
868 ;; don't override users' setting of $EMACS.
869 (unless (getenv "EMACS") '("EMACS=t"))
870 process-environment))
871 (thisdir default-directory)
876 (compilation-buffer-name name-of-mode name-function)))
877 (let ((comp-proc (get-buffer-process (current-buffer))))
879 (if (or (not (eq (process-status comp-proc) 'run))
881 (format "A %s process is running; kill it? "
885 (interrupt-process comp-proc)
887 (delete-process comp-proc))
889 (error "Cannot have two processes in `%s' at once"
891 ;; Clear out the compilation buffer and make it writable.
892 ;; Change its default-directory to the directory where the compilation
893 ;; will happen, and insert a `cd' command to indicate this.
894 (setq buffer-read-only nil)
895 (buffer-disable-undo (current-buffer))
897 (buffer-enable-undo (current-buffer))
898 (setq default-directory thisdir)
899 ;; output a mode setter, for saving and later reloading this buffer
900 (insert "cd " thisdir " # -*-" name-of-mode
901 "-*-\nEntering directory `" thisdir "'\n" command "\n")
902 (set-buffer-modified-p nil))
903 ;; If we're already in the compilation buffer, go to the end
904 ;; of the buffer, so point will track the compilation output.
905 (if (eq outbuf (current-buffer))
906 (goto-char (point-max)))
907 ;; Pop up the compilation buffer.
908 (setq outwin (display-buffer outbuf nil t))
909 (with-current-buffer outbuf
910 (if (not (eq mode t))
912 (with-no-warnings (comint-mode))
913 (compilation-shell-minor-mode))
914 ;; In what way is it non-ergonomic ? -stef
915 ;; (toggle-read-only 1) ;;; Non-ergonomic.
917 (set (make-local-variable 'compilation-highlight-regexp)
919 (set (make-local-variable 'compilation-arguments)
920 (list command mode name-function highlight-regexp))
921 (set (make-local-variable 'revert-buffer-function)
922 'compilation-revert-buffer)
923 (set-window-start outwin (point-min))
924 (or (eq outwin (selected-window))
925 (set-window-point outwin (if compilation-scroll-output
928 ;; The setup function is called before compilation-set-window-height
929 ;; so it can set the compilation-window-height buffer locally.
930 (if compilation-process-setup-function
931 (funcall compilation-process-setup-function))
932 (compilation-set-window-height outwin)
933 ;; Start the compilation.
934 (if (fboundp 'start-process)
935 (let ((proc (if (eq mode t)
938 (comint-exec outbuf (downcase mode-name)
939 shell-file-name nil `("-c" ,command))))
940 (start-process-shell-command (downcase mode-name)
942 ;; Make the buffer's mode line show process state.
943 (setq mode-line-process '(":%s"))
944 (set-process-sentinel proc 'compilation-sentinel)
945 (set-process-filter proc 'compilation-filter)
946 (set-marker (process-mark proc) (point) outbuf)
947 (setq compilation-in-progress
948 (cons proc compilation-in-progress)))
949 ;; No asynchronous processes available.
950 (message "Executing `%s'..." command)
951 ;; Fake modeline display as if `start-process' were run.
952 (setq mode-line-process ":run")
953 (force-mode-line-update)
954 (sit-for 0) ; Force redisplay
955 (let ((status (call-process shell-file-name nil outbuf nil "-c"
957 (cond ((numberp status)
958 (compilation-handle-exit 'exit status
962 exited abnormally with code %d\n"
965 (compilation-handle-exit 'signal status
966 (concat status "\n")))
968 (compilation-handle-exit 'bizarre status status))))
969 ;; Without async subprocesses, the buffer is not yet
970 ;; fontified, so fontify it now.
971 (let ((font-lock-verbose nil)) ; shut up font-lock messages
972 (font-lock-fontify-buffer))
973 (message "Executing `%s'...done" command)))
974 (if (buffer-local-value 'compilation-scroll-output outbuf)
975 (save-selected-window
976 (select-window outwin)
977 (goto-char (point-max))))
978 ;; Make it so the next C-x ` will use this buffer.
979 (setq next-error-last-buffer outbuf)))
981 (defun compilation-set-window-height (window)
982 "Set the height of WINDOW according to `compilation-window-height'."
983 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
985 (= (window-width window) (frame-width (window-frame window)))
986 ;; If window is alone in its frame, aside from a minibuffer,
987 ;; don't change its height.
988 (not (eq window (frame-root-window (window-frame window))))
989 ;; This save-current-buffer prevents us from changing the current
990 ;; buffer, which might not be the same as the selected window's buffer.
992 (save-selected-window
994 (select-window window)
995 (enlarge-window (- height (window-height)))))))))
997 (defvar compilation-menu-map
998 (let ((map (make-sparse-keymap "Errors")))
999 (define-key map [stop-subjob]
1000 '("Stop Compilation" . kill-compilation))
1001 (define-key map [compilation-mode-separator2]
1003 (define-key map [compilation-first-error]
1004 '("First Error" . first-error))
1005 (define-key map [compilation-previous-error]
1006 '("Previous Error" . previous-error))
1007 (define-key map [compilation-next-error]
1008 '("Next Error" . next-error))
1011 (defvar compilation-minor-mode-map
1012 (let ((map (make-sparse-keymap)))
1013 (define-key map [mouse-2] 'compile-goto-error)
1014 (define-key map "\C-c\C-c" 'compile-goto-error)
1015 (define-key map "\C-m" 'compile-goto-error)
1016 (define-key map "\C-c\C-k" 'kill-compilation)
1017 (define-key map "\M-n" 'compilation-next-error)
1018 (define-key map "\M-p" 'compilation-previous-error)
1019 (define-key map "\M-{" 'compilation-previous-file)
1020 (define-key map "\M-}" 'compilation-next-file)
1021 ;; Set up the menu-bar
1022 (define-key map [menu-bar compilation]
1023 (cons "Errors" compilation-menu-map))
1025 "Keymap for `compilation-minor-mode'.")
1027 (defvar compilation-shell-minor-mode-map
1028 (let ((map (make-sparse-keymap)))
1029 (define-key map "\M-\C-m" 'compile-goto-error)
1030 (define-key map "\M-\C-n" 'compilation-next-error)
1031 (define-key map "\M-\C-p" 'compilation-previous-error)
1032 (define-key map "\M-{" 'compilation-previous-file)
1033 (define-key map "\M-}" 'compilation-next-file)
1034 ;; Set up the menu-bar
1035 (define-key map [menu-bar compilation]
1036 (cons "Errors" compilation-menu-map))
1038 "Keymap for `compilation-shell-minor-mode'.")
1040 (defvar compilation-button-map
1041 (let ((map (make-sparse-keymap)))
1042 (define-key map [mouse-2] 'compile-goto-error)
1043 (define-key map "\C-m" 'compile-goto-error)
1045 "Keymap for compilation-message buttons.")
1046 (fset 'compilation-button-map compilation-button-map)
1048 (defvar compilation-mode-map
1049 (let ((map (make-sparse-keymap)))
1050 (set-keymap-parent map compilation-minor-mode-map)
1051 (define-key map " " 'scroll-up)
1052 (define-key map "\^?" 'scroll-down)
1054 ;; Set up the menu-bar
1055 (define-key map [menu-bar compilation]
1056 (cons "Compile" (make-sparse-keymap "Compile")))
1057 (define-key map [menu-bar compilation compilation-separator2]
1059 (define-key map [menu-bar compilation compilation-grep]
1060 '("Search Files (grep)" . grep))
1061 (define-key map [menu-bar compilation compilation-recompile]
1062 '("Recompile" . recompile))
1063 (define-key map [menu-bar compilation compilation-compile]
1064 '("Compile..." . compile))
1066 "Keymap for compilation log buffers.
1067 `compilation-minor-mode-map' is a parent of this.")
1069 (put 'compilation-mode 'mode-class 'special)
1071 (defvar compilation-skip-to-next-location t
1072 "*If non-nil, skip multiple error messages for the same source location.")
1074 (defcustom compilation-skip-threshold 1
1075 "*Compilation motion commands skip less important messages.
1076 The value can be either 2 -- skip anything less than error, 1 --
1077 skip anything less than warning or 0 -- don't skip any messages.
1078 Note that all messages not positively identified as warning or
1079 info, are considered errors."
1080 :type '(choice (const :tag "Warnings and info" 2)
1081 (const :tag "Info" 1)
1082 (const :tag "None" 0))
1086 (defcustom compilation-skip-visited nil
1087 "*Compilation motion commands skip visited messages if this is t.
1088 Visited messages are ones for which the file, line and column have been jumped
1089 to from the current content in the current compilation buffer, even if it was
1090 from a different message."
1096 (defun compilation-mode ()
1097 "Major mode for compilation log buffers.
1098 \\<compilation-mode-map>To visit the source for a line-numbered error,
1099 move point to the error message line and type \\[compile-goto-error].
1100 To kill the compilation, type \\[kill-compilation].
1102 Runs `compilation-mode-hook' with `run-hooks' (which see)."
1104 (kill-all-local-variables)
1105 (use-local-map compilation-mode-map)
1106 (setq major-mode 'compilation-mode
1107 mode-name "Compilation")
1108 (set (make-local-variable 'page-delimiter)
1109 compilation-page-delimiter)
1111 (run-mode-hooks 'compilation-mode-hook))
1113 (defmacro define-compilation-mode (mode name doc &rest body)
1114 "This is like `define-derived-mode' without the PARENT argument.
1115 The parent is always `compilation-mode' and the customizable `compilation-...'
1116 variables are also set from the name of the mode you have chosen, by replacing
1117 the fist word, e.g `compilation-scroll-output' from `grep-scroll-output' if that
1119 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1120 `(define-derived-mode ,mode compilation-mode ,name
1122 ,@(mapcar (lambda (v)
1124 (intern-soft (replace-regexp-in-string
1125 "^compilation" mode-name
1128 (or (boundp (cdr v))
1129 (if (boundp 'byte-compile-bound-variables)
1130 (memq (cdr v) byte-compile-bound-variables)))
1131 `(set (make-local-variable ',(car v)) ,(cdr v))))
1132 '(compilation-buffer-name-function
1133 compilation-directory-matcher
1135 compilation-error-regexp-alist
1136 compilation-error-regexp-alist-alist
1137 compilation-error-screen-columns
1138 compilation-finish-function
1139 compilation-finish-functions
1140 compilation-first-column
1141 compilation-mode-font-lock-keywords
1142 compilation-page-delimiter
1143 compilation-parse-errors-filename-function
1144 compilation-process-setup-function
1145 compilation-scroll-output
1146 compilation-search-path
1147 compilation-skip-threshold
1148 compilation-window-height))
1151 (defun compilation-revert-buffer (ignore-auto noconfirm)
1152 (if buffer-file-name
1153 (let (revert-buffer-function)
1154 (revert-buffer ignore-auto noconfirm))
1155 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1156 (apply 'compilation-start compilation-arguments))))
1158 (defvar compilation-current-error nil
1159 "Marker to the location from where the next error will be found.
1160 The global commands next/previous/first-error/goto-error use this.")
1162 (defvar compilation-messages-start nil
1163 "Buffer position of the beginning of the compilation messages.
1164 If nil, use the beginning of buffer.")
1166 ;; A function name can't be a hook, must be something with a value.
1167 (defconst compilation-turn-on-font-lock 'turn-on-font-lock)
1169 (defun compilation-setup (&optional minor)
1170 "Prepare the buffer for the compilation parsing commands to work.
1171 Optional argument MINOR indicates this is called from
1172 `compilation-minor-mode'."
1173 (make-local-variable 'compilation-current-error)
1174 (make-local-variable 'compilation-messages-start)
1175 (make-local-variable 'compilation-error-screen-columns)
1176 (make-local-variable 'overlay-arrow-position)
1177 ;; Note that compilation-next-error-function is for interfacing
1178 ;; with the next-error function in simple.el, and it's only
1179 ;; coincidentally named similarly to compilation-next-error.
1180 (setq next-error-function 'compilation-next-error-function)
1181 (set (make-local-variable 'font-lock-extra-managed-props)
1182 '(directory message help-echo mouse-face debug))
1183 (set (make-local-variable 'compilation-locs)
1184 (make-hash-table :test 'equal :weakness 'value))
1185 ;; lazy-lock would never find the message unless it's scrolled to.
1186 ;; jit-lock might fontify some things too late.
1187 (set (make-local-variable 'font-lock-support-mode) nil)
1188 (set (make-local-variable 'font-lock-maximum-size) nil)
1189 (let ((fld font-lock-defaults))
1191 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1192 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t)))
1196 (font-lock-fontify-buffer)
1197 (font-lock-change-mode)
1198 (turn-on-font-lock))
1199 (turn-on-font-lock))
1200 ;; maybe defer font-lock till after derived mode is set up
1201 (run-mode-hooks 'compilation-turn-on-font-lock))))
1204 (define-minor-mode compilation-shell-minor-mode
1205 "Toggle compilation shell minor mode.
1206 With arg, turn compilation mode on if and only if arg is positive.
1207 In this minor mode, all the error-parsing commands of the
1208 Compilation major mode are available but bound to keys that don't
1209 collide with Shell mode. See `compilation-mode'.
1210 Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
1211 nil " Shell-Compile"
1213 (if compilation-shell-minor-mode
1214 (compilation-setup t)
1215 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1216 (font-lock-fontify-buffer)))
1219 (define-minor-mode compilation-minor-mode
1220 "Toggle compilation minor mode.
1221 With arg, turn compilation mode on if and only if arg is positive.
1222 In this minor mode, all the error-parsing commands of the
1223 Compilation major mode are available. See `compilation-mode'.
1224 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
1227 (if compilation-minor-mode
1228 (compilation-setup t)
1229 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1230 (font-lock-fontify-buffer)))
1232 (defun compilation-handle-exit (process-status exit-status msg)
1233 "Write MSG in the current buffer and hack its mode-line-process."
1234 (let ((buffer-read-only nil)
1235 (status (if compilation-exit-message-function
1236 (funcall compilation-exit-message-function
1237 process-status exit-status msg)
1238 (cons msg exit-status)))
1241 ;; Record where we put the message, so we can ignore it later on.
1243 (insert ?\n mode-name " " (car status))
1244 (if (and (numberp compilation-window-height)
1245 (zerop compilation-window-height))
1246 (message "%s" (cdr status)))
1249 (insert " at " (substring (current-time-string) 0 19))
1250 (goto-char (point-max))
1251 ;; Prevent that message from being recognized as a compilation error.
1252 (add-text-properties omax (point)
1253 (append '(compilation-handle-exit t) nil))
1254 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
1255 ;; Force mode line redisplay soon.
1256 (force-mode-line-update)
1257 (if (and opoint (< opoint omax))
1259 (if compilation-finish-function
1260 (funcall compilation-finish-function (current-buffer) msg))
1261 (let ((functions compilation-finish-functions))
1263 (funcall (car functions) (current-buffer) msg)
1264 (setq functions (cdr functions))))))
1266 ;; Called when compilation process changes state.
1267 (defun compilation-sentinel (proc msg)
1268 "Sentinel for compilation buffers."
1269 (if (memq (process-status proc) '(exit signal))
1270 (let ((buffer (process-buffer proc)))
1271 (if (null (buffer-name buffer))
1273 (set-process-buffer proc nil)
1274 (with-current-buffer buffer
1275 ;; Write something in the compilation buffer
1276 ;; and hack its mode line.
1277 (compilation-handle-exit (process-status proc)
1278 (process-exit-status proc)
1280 ;; Since the buffer and mode line will show that the
1281 ;; process is dead, we can delete it now. Otherwise it
1282 ;; will stay around until M-x list-processes.
1283 (delete-process proc)))
1284 (setq compilation-in-progress (delq proc compilation-in-progress)))))
1286 (defun compilation-filter (proc string)
1287 "Process filter for compilation buffers.
1288 Just inserts the text, but uses `insert-before-markers'."
1289 (if (buffer-name (process-buffer proc))
1290 (with-current-buffer (process-buffer proc)
1291 (let ((inhibit-read-only t))
1293 (goto-char (process-mark proc))
1294 (insert-before-markers string)
1295 (run-hooks 'compilation-filter-hook))))))
1297 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
1298 (defsubst compilation-buffer-internal-p ()
1299 "Test if inside a compilation buffer."
1300 (local-variable-p 'compilation-locs))
1302 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
1303 (defsubst compilation-buffer-p (buffer)
1304 "Test if BUFFER is a compilation buffer."
1305 (with-current-buffer buffer
1306 (compilation-buffer-internal-p)))
1308 (defmacro compilation-loop (< property-change 1+ error)
1310 (or (setq pt (,property-change pt 'message))
1311 (error ,error compilation-error))
1312 ;; prop 'message usually has 2 changes, on and off, so re-search if off
1313 (or (setq msg (get-text-property pt 'message))
1314 (if (setq pt (,property-change pt 'message))
1315 (setq msg (get-text-property pt 'message)))
1316 (error ,error compilation-error))
1317 (or (< (cadr msg) compilation-skip-threshold)
1319 (eq (prog1 last (setq last (nth 2 (car msg))))
1321 (if compilation-skip-visited
1322 (nthcdr 4 (car msg)))
1323 (if compilation-skip-to-next-location
1325 ;; count this message only if none of the above are true
1328 (defun compilation-next-error (n &optional different-file pt)
1329 "Move point to the next error in the compilation buffer.
1330 Prefix arg N says how many error messages to move forwards (or
1331 backwards, if negative).
1332 Does NOT find the source line like \\[next-error]."
1334 (or (compilation-buffer-p (current-buffer))
1335 (error "Not in a compilation buffer"))
1336 (or pt (setq pt (point)))
1337 (let* ((msg (get-text-property pt 'message))
1341 (unless (or msg ; find message near here
1342 (setq msg (get-text-property (max (1- pt) (point-min))
1344 (setq pt (previous-single-property-change pt 'message nil
1345 (line-beginning-position)))
1346 (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message))
1347 (setq pt (next-single-property-change pt 'message nil
1348 (line-end-position)))
1349 (or (setq msg (get-text-property pt 'message))
1350 (setq pt (point)))))
1351 (setq last (nth 2 (car msg)))
1353 (compilation-loop > next-single-property-change 1-
1354 (if (get-buffer-process (current-buffer))
1356 "Moved past last %s"))
1357 ;; Don't move "back" to message at or before point.
1358 ;; Pass an explicit (point-min) to make sure pt is non-nil.
1359 (setq pt (previous-single-property-change pt 'message nil (point-min)))
1360 (compilation-loop < previous-single-property-change 1+
1361 "Moved back before first %s")))
1364 (error "No %s here" compilation-error))))
1366 (defun compilation-previous-error (n)
1367 "Move point to the previous error in the compilation buffer.
1368 Prefix arg N says how many error messages to move backwards (or
1369 forwards, if negative).
1370 Does NOT find the source line like \\[previous-error]."
1372 (compilation-next-error (- n)))
1374 (defun compilation-next-file (n)
1375 "Move point to the next error for a different file than the current one.
1376 Prefix arg N says how many files to move forwards (or backwards, if negative)."
1378 (compilation-next-error n t))
1380 (defun compilation-previous-file (n)
1381 "Move point to the previous error for a different file than the current one.
1382 Prefix arg N says how many files to move backwards (or forwards, if negative)."
1384 (compilation-next-file (- n)))
1386 (defun kill-compilation ()
1387 "Kill the process made by the \\[compile] or \\[grep] commands."
1389 (let ((buffer (compilation-find-buffer)))
1390 (if (get-buffer-process buffer)
1391 (interrupt-process (get-buffer-process buffer))
1392 (error "The compilation process is not running"))))
1394 (defalias 'compile-mouse-goto-error 'compile-goto-error)
1396 (defun compile-goto-error (&optional event)
1397 "Visit the source for the error message at point.
1398 Use this command in a compilation log buffer. Sets the mark at point there."
1399 (interactive (list last-input-event))
1400 (if event (posn-set-point (event-end event)))
1401 (or (compilation-buffer-p (current-buffer))
1402 (error "Not in a compilation buffer"))
1403 (if (get-text-property (point) 'directory)
1404 (dired-other-window (car (get-text-property (point) 'directory)))
1406 (setq compilation-current-error (point))
1409 ;; Return a compilation buffer.
1410 ;; If the current buffer is a compilation buffer, return it.
1411 ;; Otherwise, look for a compilation buffer and signal an error
1412 ;; if there are none.
1413 (defun compilation-find-buffer (&optional other-buffer)
1414 (next-error-find-buffer other-buffer 'compilation-buffer-internal-p))
1417 (defun compilation-next-error-function (n &optional reset)
1419 (set-buffer (compilation-find-buffer))
1421 (setq compilation-current-error nil))
1422 (let* ((columns compilation-error-screen-columns) ; buffer's local value
1424 (loc (compilation-next-error (or n 1) nil
1425 (or compilation-current-error
1426 compilation-messages-start
1428 (end-loc (nth 2 loc))
1429 (marker (point-marker)))
1430 (setq compilation-current-error (point-marker)
1431 overlay-arrow-position
1433 compilation-current-error
1434 (copy-marker (line-beginning-position)))
1436 ;; If loc contains no marker, no error in that file has been visited. If
1437 ;; the marker is invalid the buffer has been killed. So, recalculate all
1438 ;; markers for that file.
1439 (unless (and (nth 3 loc) (marker-buffer (nth 3 loc)))
1440 (with-current-buffer (compilation-find-file marker (caar (nth 2 loc))
1441 (or (cdar (nth 2 loc))
1445 (goto-char (point-min))
1446 ;; Treat file's found lines in forward order, 1 by 1.
1447 (dolist (line (reverse (cddr (nth 2 loc))))
1448 (when (car line) ; else this is a filename w/o a line#
1449 (beginning-of-line (- (car line) last -1))
1450 (setq last (car line)))
1451 ;; Treat line's found columns and store/update a marker for each.
1452 (dolist (col (cdr line))
1454 (if (eq (car col) -1) ; special case for range end
1457 (move-to-column (car col))
1459 (forward-char (car col))))
1461 (skip-chars-forward " \t"))
1463 (set-marker (nth 3 col) (point))
1464 (setcdr (nthcdr 2 col) `(,(point-marker)))))))))
1465 (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc))
1466 (setcdr (nthcdr 3 loc) t))) ; Set this one as visited.
1468 (defvar compilation-gcpro nil
1469 "Internal variable used to keep some values from being GC'd.")
1470 (make-variable-buffer-local 'compilation-gcpro)
1472 (defun compilation-fake-loc (marker file &optional line col)
1473 "Preassociate MARKER with FILE.
1474 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
1475 This is useful when you compile temporary files, but want
1476 automatic translation of the messages to the real buffer from
1477 which the temporary file came. This only works if done before a
1478 message about FILE appears!
1480 Optional args LINE and COL default to 1 and beginning of
1481 indentation respectively. The marker is expected to reflect
1482 this. In the simplest case the marker points to the first line
1483 of the region that was saved to the temp file.
1485 If you concatenate several regions into the temp file (e.g. a
1486 header with variable assignments and a code region), you must
1487 call this several times, once each for the last line of one
1488 region and the first line of the next region."
1489 (or (consp file) (setq file (list file)))
1490 (setq file (compilation-get-file-structure file))
1491 ;; Between the current call to compilation-fake-loc and the first occurrence
1492 ;; of an error message referring to `file', the data is only kept is the
1493 ;; weak hash-table compilation-locs, so we need to prevent this entry
1494 ;; in compilation-locs from being GC'd away. --Stef
1495 (push file compilation-gcpro)
1496 (let ((loc (compilation-assq (or line 1) (cdr file))))
1497 (setq loc (compilation-assq col loc))
1499 (setcdr (cddr loc) (list marker))
1500 (setcdr loc (list line file marker)))
1503 (defcustom compilation-context-lines 0
1504 "*Display this many lines of leading context before message.
1505 If nil, don't scroll the compilation output window."
1506 :type '(choice integer (const :tag "No window scrolling" nil))
1510 (defsubst compilation-set-window (w mk)
1511 "Align the compilation output window W with marker MK near top."
1512 (if (integerp compilation-context-lines)
1513 (set-window-start w (save-excursion
1515 (beginning-of-line (- 1 compilation-context-lines))
1517 (set-window-point w mk))
1519 (defun compilation-goto-locus (msg mk end-mk)
1520 "Jump to an error corresponding to MSG at MK.
1521 All arguments are markers. If END-MK is non nil, mark is set there."
1522 (if (eq (window-buffer (selected-window))
1523 (marker-buffer msg))
1524 ;; If the compilation buffer window is selected,
1525 ;; keep the compilation buffer in this window;
1526 ;; display the source in another window.
1527 (let ((pop-up-windows t))
1528 (pop-to-buffer (marker-buffer mk)))
1529 (if (window-dedicated-p (selected-window))
1530 (pop-to-buffer (marker-buffer mk))
1531 (switch-to-buffer (marker-buffer mk))))
1532 ;; If narrowing gets in the way of going to the right place, widen.
1533 (unless (eq (goto-char mk) (point))
1537 (push-mark end-mk nil t)
1538 (if mark-active (setq mark-active)))
1539 ;; If hideshow got in the way of
1540 ;; seeing the right place, open permanently.
1541 (dolist (ov (overlays-at (point)))
1542 (when (eq 'hs (overlay-get ov 'invisible))
1546 ;; Show compilation buffer in other window, scrolled to this error.
1547 (let* ((pop-up-windows t)
1548 ;; Use an existing window if it is in a visible frame.
1549 (w (or (get-buffer-window (marker-buffer msg) 'visible)
1551 (display-buffer (marker-buffer msg))))
1552 (highlight-regexp (with-current-buffer (marker-buffer msg)
1553 ;; also do this while we change buffer
1554 (compilation-set-window w msg)
1555 compilation-highlight-regexp)))
1556 (compilation-set-window-height w)
1558 (when (and highlight-regexp
1559 (not (and end-mk transient-mark-mode)))
1560 (unless compilation-highlight-overlay
1561 (setq compilation-highlight-overlay
1562 (make-overlay (point-min) (point-min)))
1563 (overlay-put compilation-highlight-overlay 'face 'region))
1564 (with-current-buffer (marker-buffer mk)
1567 (let ((end (point)))
1569 (if (and (stringp highlight-regexp)
1570 (re-search-forward highlight-regexp end t))
1572 (goto-char (match-beginning 0))
1573 (move-overlay compilation-highlight-overlay (match-beginning 0) (match-end 0)))
1574 (move-overlay compilation-highlight-overlay (point) end))
1576 (delete-overlay compilation-highlight-overlay)))))))
1579 (defun compilation-find-file (marker filename dir &rest formats)
1580 "Find a buffer for file FILENAME.
1581 Search the directories in `compilation-search-path'.
1582 A nil in `compilation-search-path' means to try the
1583 current directory, which is passed in DIR.
1584 If FILENAME is not found at all, ask the user where to find it.
1585 Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
1586 (or formats (setq formats '("%s")))
1588 (let ((dirs compilation-search-path)
1589 buffer thisdir fmts name)
1590 (if (file-name-absolute-p filename)
1591 ;; The file name is absolute. Use its explicit directory as
1592 ;; the first in the search path, and strip it from FILENAME.
1593 (setq filename (abbreviate-file-name (expand-file-name filename))
1594 dirs (cons (file-name-directory filename) dirs)
1595 filename (file-name-nondirectory filename)))
1596 ;; Now search the path.
1597 (while (and dirs (null buffer))
1598 (setq thisdir (or (car dirs) dir)
1600 ;; For each directory, try each format string.
1601 (while (and fmts (null buffer))
1602 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1603 buffer (and (file-exists-p name)
1604 (find-file-noselect name))
1606 (setq dirs (cdr dirs)))
1608 ;; The file doesn't exist. Ask the user where to find it.
1609 (let ((pop-up-windows t))
1610 (compilation-set-window (display-buffer (marker-buffer marker))
1612 (let ((name (expand-file-name
1614 (format "Find this error in: (default %s) "
1617 (if (file-directory-p name)
1618 (setq name (expand-file-name filename name)))
1619 (setq buffer (and (file-exists-p name)
1620 (find-file name))))))
1621 ;; Make intangible overlays tangible.
1622 (mapcar (function (lambda (ov)
1623 (when (overlay-get ov 'intangible)
1624 (overlay-put ov 'intangible nil))))
1625 (overlays-in (point-min) (point-max)))
1628 (defun compilation-get-file-structure (file &optional fmt)
1629 "Retrieve FILE's file-structure or create a new one.
1630 FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME)."
1632 (or (gethash file compilation-locs)
1633 ;; File was not previously encountered, at least not in the form passed.
1634 ;; Let's normalize it and look again.
1635 (let ((filename (car file))
1636 (default-directory (if (cdr file)
1637 (file-truename (cdr file))
1638 default-directory)))
1640 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1641 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1643 (if (boundp 'comint-file-name-prefix)
1644 (if (file-name-absolute-p filename)
1646 (concat (with-no-warnings comint-file-name-prefix) filename))
1647 (setq default-directory
1649 (concat (with-no-warnings comint-file-name-prefix) default-directory)))))
1651 ;; If compilation-parse-errors-filename-function is
1652 ;; defined, use it to process the filename.
1653 (when compilation-parse-errors-filename-function
1655 (funcall compilation-parse-errors-filename-function
1658 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
1659 ;; file names like "./bar//foo.c" for file "bar/foo.c";
1660 ;; expand-file-name will collapse these into "/foo.c" and fail to find
1661 ;; the appropriate file. So we look for doubled slashes in the file
1662 ;; name and fix them.
1663 (setq filename (command-line-normalize-file-name filename))
1665 ;; Now eliminate any "..", because find-file would get them wrong.
1666 ;; Make relative and absolute filenames, with or without links, the
1669 (list (abbreviate-file-name
1670 (file-truename (if (cdr file)
1671 (expand-file-name filename)
1674 ;; Store it for the possibly unnormalized name
1676 ;; Retrieve or create file-structure for normalized name
1677 (or (gethash filename compilation-locs)
1678 (puthash filename (list filename fmt) compilation-locs))
1679 compilation-locs))))
1681 (add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$")
1683 ;;; Compatibility with the old compile.el.
1685 (defun compile-buffer-substring (n) (if n (match-string n)))
1687 (defun compilation-compat-error-properties (err)
1688 "Map old-style error ERR to new-style message."
1689 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
1690 ;; (MARKER . MARKER).
1691 (let ((dst (cdr err)))
1693 ;; Must start with a face, for font-lock.
1695 message ,(list (list nil nil nil dst) 2)
1696 help-echo "mouse-2: visit the source location"
1697 keymap compilation-button-map
1698 mouse-face highlight)
1699 ;; Too difficult to do it by hand: dispatch to the normal code.
1700 (let* ((file (pop dst))
1703 (filename (pop file))
1704 (dirname (pop file))
1706 (compilation-internal-error-properties
1707 (cons filename dirname) line nil col nil 2 fmt)))))
1709 (defun compilation-compat-parse-errors (limit)
1710 (when compilation-parse-errors-function
1711 ;; FIXME: We should remove the rest of the compilation keywords
1712 ;; but we can't do that from here because font-lock is using
1713 ;; the value right now. --stef
1715 (setq compilation-error-list nil)
1716 ;; Reset compilation-parsing-end each time because font-lock
1717 ;; might force us the re-parse many times (typically because
1718 ;; some code adds some text-property to the output that we
1719 ;; already parsed). You might say "why reparse", well:
1720 ;; because font-lock has just removed the `message' property so
1721 ;; have to do it all over again.
1722 (if compilation-parsing-end
1723 (set-marker compilation-parsing-end (point))
1724 (setq compilation-parsing-end (point-marker)))
1726 ;; Ignore any error: we're calling this function earlier than
1727 ;; in the old compile.el so things might not all be setup yet.
1728 (funcall compilation-parse-errors-function limit nil)
1730 (dolist (err (if (listp compilation-error-list) compilation-error-list))
1731 (let* ((src (car err))
1733 (loc (cond ((markerp dst) (list nil nil nil dst))
1735 (list (nth 2 dst) (nth 1 dst)
1736 (cons (cdar dst) (caar dst)))))))
1739 ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face)
1740 (put-text-property src (line-end-position)
1741 'message (list loc 2)))))))
1745 ;; Beware: this is not only compatiblity code. New code stil uses it. --Stef
1746 (defun compilation-forget-errors ()
1747 ;; In case we hit the same file/line specs, we want to recompute a new
1748 ;; marker for them, so flush our cache.
1749 (setq compilation-locs (make-hash-table :test 'equal :weakness 'value))
1750 (setq compilation-gcpro nil)
1751 ;; FIXME: the old code reset the directory-stack, so maybe we should
1752 ;; put a `directory change' marker of some sort, but where? -stef
1754 ;; FIXME: The old code moved compilation-current-error (which was
1755 ;; virtually represented by a mix of compilation-parsing-end and
1756 ;; compilation-error-list) to point-min, but that was only meaningful for
1757 ;; the internal uses of compilation-forget-errors: all calls from external
1758 ;; packages seem to be followed by a move of compilation-parsing-end to
1759 ;; something equivalent to point-max. So we speculatively move
1760 ;; compilation-current-error to point-max (since the external package
1761 ;; won't know that it should do it). --stef
1762 (setq compilation-current-error nil)
1763 (let* ((proc (get-buffer-process (current-buffer)))
1764 (mark (if proc (process-mark proc)))
1765 (pos (or mark (point-max))))
1766 (setq compilation-messages-start
1767 ;; In the future, ignore the text already present in the buffer.
1768 ;; Since many process filter functions insert before markers,
1769 ;; we need to put ours just before the insertion point rather
1770 ;; than at the insertion point. If that's not possible, then
1771 ;; don't use a marker. --Stef
1772 (if (> pos (point-min)) (copy-marker (1- pos)) pos))))
1776 ;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
1777 ;;; compile.el ends here