1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2001, 2002, 2003, 2004, 2005 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., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, 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-mode-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.")
122 (make-obsolete-variable 'compilation-finish-function
123 "Use `compilation-finish-functions', but it works a little differently."
127 (defvar compilation-finish-functions nil
128 "Functions to call when a compilation process finishes.
129 Each function is called with two arguments: the compilation buffer,
130 and a string describing how the process finished.")
132 (defvar compilation-in-progress nil
133 "List of compilation processes now running.")
134 (or (assq 'compilation-in-progress minor-mode-alist)
135 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
138 (defvar compilation-error "error"
139 "Stem of message to print when no matches are found.")
141 (defvar compilation-arguments nil
142 "Arguments that were given to `compilation-start'.")
144 (defvar compilation-num-errors-found)
146 (defconst compilation-error-regexp-alist-alist
148 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
149 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
152 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
155 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
158 "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):[0-9]+:[0-9]+:\\)?\
159 \\( warning\\)?" 1 2 3 (4))
162 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
165 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
166 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
167 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
170 "^ *File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
171 \\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning:\\)?\\)"
172 2 (3 . 4) (5 . 6) (7))
175 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
176 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
179 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
182 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
186 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
189 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
193 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
197 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
198 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
200 ;; fixme: should be `mips'
202 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
203 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
206 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
209 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
211 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
213 (2 (compilation-face '(3))))
216 "^\\(?:In file included\\| \\) from \
217 \\(.+\\):\\([0-9]+\\)\\(?:\\(:\\)\\|\\(,\\)\\)?" 1 2 nil (3 . 4))
220 "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\)?\
221 \\([/.]*[a-zA-Z]:?[^ \t\n:]*\\|{standard input}\\): ?\
222 \\([0-9]+\\)\\([.:]?\\)\\([0-9]+\\)?\
223 \\(?:-\\(?:\\([0-9]+\\)\\3\\)?\\.?\\([0-9]+\\)?\\)?:\
224 \\(?: *\\(\\(?:Future\\|Runtime\\)?[Ww]arning\\|W:\\)\\|\
225 *\\([Ii]nfo\\(?:\\>\\|rmationa?l?\\)\\|I:\\)\\)?"
226 1 (2 . 5) (4 . 6) (7 . 8))
229 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
233 "^makepp: \\(?:\\(?:warning\\(:\\).*?\\|\\(Scanning\\|[LR]e?l?oading makefile\\) \\|.*?\\)\
234 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
236 ("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]" nil nil
237 (2 compilation-info-face)
238 (3 compilation-line-face nil t)
239 (1 (compilation-error-properties 2 3 nil nil nil 0 nil)
242 ;; Should be lint-1, lint-2 (SysV lint)
244 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
246 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
249 "^\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
250 : \\(?:error\\|warnin\\(g\\)\\) C[0-9]+:" 2 3 nil (4))
253 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
254 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
255 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
259 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\)" 1 2)
262 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
263 \\([0-9]+\\) of file://\\(.+\\)"
267 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
268 [12][09][0-9][0-9] +\\(.*\\):$"
271 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
272 nil 3 nil (2) nil (1 (compilation-face '(2))))
273 (sparc-pascal-example
274 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
275 nil 1 nil (3) nil (2 (compilation-face '(3))))
278 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
279 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
283 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
286 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
287 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3))
290 "^ +-: \\(0\\):Source:\\(.+\\)$" 2 1 nil 0)
292 "^ +-: \\(0\\):Object:\\(?:.+\\)$" nil 1 nil 0)
293 (gcov-never-called-line
294 "^ +\\(#####\\): +\\([0-9]+\\):.+$" nil 2 nil 2 nil
295 (1 compilation-error-face))
297 "^ +[-0-9]+: +\\([1-9]\\|[0-9]\\{2,\\}\\):.*$" nil 1 nil 0)
299 "Alist of values for `compilation-error-regexp-alist'.")
301 (defcustom compilation-error-regexp-alist
302 (mapcar 'car compilation-error-regexp-alist-alist)
303 "Alist that specifies how to match errors in compiler output.
304 Note that on Unix everything is a valid filename, so these
305 matchers must make some common sense assumptions, which catch
306 normal cases. A shorter list will be lighter on resource usage.
308 Instead of an alist element, you can use a symbol, which is
309 looked up in `compilation-error-regexp-alist-alist'. You can see
310 the predefined symbols and their effects in the file
311 `etc/compilation.txt' (linked below if you are customizing this).
313 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
314 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
315 gives the file name, and the LINE'th subexpression gives the line
316 number. The COLUMN'th subexpression gives the column number on
319 If FILE, LINE or COLUMN are nil or that index didn't match, that
320 information is not present on the matched line. In that case the
321 file name is assumed to be the same as the previous one in the
322 buffer, line number defaults to 1 and column defaults to
323 beginning of line's indentation.
325 FILE can also have the form (FILE FORMAT...), where the FORMATs
326 \(e.g. \"%s.c\") will be applied in turn to the recognized file
327 name, until a file of that name is found. Or FILE can also be a
328 function to return the filename.
330 LINE can also be of the form (LINE . END-LINE) meaning a range
331 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
332 meaning a range of columns starting on LINE and ending on
333 END-LINE, if that matched.
335 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
336 TYPE can also be of the form (WARNING . INFO). In that case this
337 will be equivalent to 1 if the WARNING'th subexpression matched
338 or else equivalent to 0 if the INFO'th subexpression matched.
339 See `compilation-error-face', `compilation-warning-face',
340 `compilation-info-face' and `compilation-skip-threshold'.
342 What matched the HYPERLINK'th subexpression has `mouse-face' and
343 `compilation-message-face' applied. If this is nil, the text
344 matched by the whole REGEXP becomes the hyperlink.
346 Additional HIGHLIGHTs as described under `font-lock-keywords' can
348 :type `(set :menu-tag "Pick"
349 ,@(mapcar (lambda (elt)
350 (list 'const (car elt)))
351 compilation-error-regexp-alist-alist))
352 :link `(file-link :tag "example file"
353 ,(expand-file-name "compilation.txt" data-directory))
356 (defvar compilation-directory nil
357 "Directory to restore to when doing `recompile'.")
359 (defvar compilation-directory-matcher
360 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
361 "A list for tracking when directories are entered or left.
362 Nil means not to track directories, e.g. if all file names are absolute. The
363 first element is the REGEXP matching these messages. It can match any number
364 of variants, e.g. different languages. The remaining elements are all of the
365 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
366 matches, that is a directory name. If LEAVE is nil or the corresponding
367 LEAVE'th subexpression doesn't match, this message is about going into another
368 directory. If it does match anything, this message is about going back to the
369 directory we were in before the last entering message. If you change this,
370 you may also want to change `compilation-page-delimiter'.")
372 (defvar compilation-page-delimiter
373 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
374 "Value of `page-delimiter' in Compilation mode.")
376 (defvar compilation-mode-font-lock-keywords
377 '(;; configure output lines.
378 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
379 (1 font-lock-variable-name-face)
380 (2 (compilation-text-face '(4 . 3))))
381 ;; Command output lines. Recognize `make[n]:' lines too.
382 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
383 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
384 (" --?o\\(?:utfile\\|utput\\)?[= ]?\\(\\S +\\)" . 1)
385 ("^Compilation finished" . compilation-info-text-face)
386 ("^Compilation exited abnormally" . compilation-error-text-face))
387 "Additional things to highlight in Compilation mode.
388 This gets tacked on the end of the generated expressions.")
390 (defvar compilation-highlight-regexp t
391 "Regexp matching part of visited source lines to highlight temporarily.
392 Highlight entire line if t; don't highlight source lines if nil.")
394 (defvar compilation-highlight-overlay nil
395 "Overlay used to temporarily highlight compilation matches.")
397 (defcustom compilation-error-screen-columns t
398 "*If non-nil, column numbers in error messages are screen columns.
399 Otherwise they are interpreted as character positions, with
400 each character occupying one column.
401 The default is to use screen columns, which requires that the compilation
402 program and Emacs agree about the display width of the characters,
403 especially the TAB character."
408 (defcustom compilation-read-command t
409 "*Non-nil means \\[compile] reads the compilation command to use.
410 Otherwise, \\[compile] just uses the value of `compile-command'."
415 (defcustom compilation-ask-about-save t
416 "*Non-nil means \\[compile] asks which buffers to save before compiling.
417 Otherwise, it saves all modified buffers without asking."
422 (defcustom compilation-search-path '(nil)
423 "*List of directories to search for source files named in error messages.
424 Elements should be directory names, not file names of directories.
425 nil as an element means to try the default directory."
426 :type '(repeat (choice (const :tag "Default" nil)
427 (string :tag "Directory")))
430 (defcustom compile-command "make -k "
431 "*Last shell command used to do a compilation; default for next compilation.
433 Sometimes it is useful for files to supply local values for this variable.
434 You might also use mode hooks to specify it in certain modes, like this:
436 (add-hook 'c-mode-hook
438 (unless (or (file-exists-p \"makefile\")
439 (file-exists-p \"Makefile\"))
440 (set (make-local-variable 'compile-command)
442 (file-name-sans-extension buffer-file-name))))))"
446 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
447 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
448 ;; key. This holds the tree seen from root, for storing new nodes.
449 (defvar compilation-locs ())
451 (defvar compilation-debug nil
452 "*Set this to t before creating a *compilation* buffer.
453 Then every error line will have a debug text property with the matcher that
454 fit this line and the match data. Use `describe-text-properties'.")
456 (defvar compilation-exit-message-function nil "\
457 If non-nil, called when a compilation process dies to return a status message.
458 This should be a function of three arguments: process status, exit status,
459 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
460 write into the compilation buffer, and to put in its mode line.")
462 (defvar compilation-environment nil
463 "*List of environment variables for compilation to inherit.
464 Each element should be a string of the form ENVVARNAME=VALUE.
465 This list is temporarily prepended to `process-environment' prior to
466 starting the compilation process.")
468 ;; History of compile commands.
469 (defvar compile-history nil)
471 (defface compilation-error
472 '((t :inherit font-lock-warning-face))
473 "Face used to highlight compiler errors."
474 :group 'font-lock-highlighting-faces
477 (defface compilation-warning
478 '((((class color) (min-colors 16)) (:foreground "Orange" :weight bold))
479 (((class color)) (:foreground "cyan" :weight bold))
481 "Face used to highlight compiler warnings."
482 :group 'font-lock-highlighting-faces
484 ;; backward-compatibility alias
485 (put 'compilation-warning-face 'face-alias 'compilation-warning)
487 (defface compilation-info
488 '((((class color) (min-colors 16) (background light))
489 (:foreground "Green3" :weight bold))
490 (((class color) (min-colors 88) (background dark))
491 (:foreground "Green1" :weight bold))
492 (((class color) (min-colors 16) (background dark))
493 (:foreground "Green" :weight bold))
494 (((class color)) (:foreground "green" :weight bold))
496 "Face used to highlight compiler information."
497 :group 'font-lock-highlighting-faces
499 ;; backward-compatibility alias
500 (put 'compilation-info-face 'face-alias 'compilation-info)
502 (defface compilation-error-file-name
503 '((default :inherit compilation-error)
504 (((supports :underline t)) :underline t))
505 "Face for displaying file names in error messages."
506 :group 'font-lock-highlighting-faces
509 (defface compilation-warning-file-name
510 '((default :inherit compilation-warning)
511 (((supports :underline t)) :underline t))
512 "Face for displaying file names in warning messages."
513 :group 'font-lock-highlighting-faces
516 (defface compilation-info-file-name
517 '((default :inherit compilation-info)
518 (((supports :underline t)) :underline t))
519 "Face for displaying file names in informational messages."
520 :group 'font-lock-highlighting-faces
523 (defface compilation-line-number
524 '((default :inherit font-lock-variable-name-face)
525 (((supports :underline t)) :underline t))
526 "Face for displaying line numbers in compiler messages."
527 :group 'font-lock-highlighting-faces
530 (defface compilation-column-number
531 '((default :inherit font-lock-type-face)
532 (((supports :underline t)) :underline t))
533 "Face for displaying column numbers in compiler messages."
534 :group 'font-lock-highlighting-faces
537 (defvar compilation-message-face nil
538 "Face name to use for whole messages.
539 Faces `compilation-error-face', `compilation-warning-face',
540 `compilation-info-face', `compilation-line-face' and
541 `compilation-column-face' get prepended to this, when applicable.")
543 (defvar compilation-error-face 'compilation-error-file-name
544 "Face name to use for file name in error messages.")
546 (defvar compilation-error-text-face 'compilation-error
547 "Face name to use for text of error messages.")
549 (defvar compilation-warning-face 'compilation-warning-file-name
550 "Face name to use for file name in warning messages.")
552 (defvar compilation-warning-text-face 'compilation-warning
553 "Face name to use for text of warning messages.")
555 (defvar compilation-info-face 'compilation-info-file-name
556 "Face name to use for file name in informational messages.")
558 (defvar compilation-info-text-face 'compilation-info
559 "Face name to use for text of informational messages.")
561 (defvar compilation-line-face 'compilation-line-number
562 "Face name to use for line numbers in compiler message.")
564 (defvar compilation-column-face 'compilation-column-number
565 "Face name to use for column numbers in compiler messages.")
567 ;; same faces as dired uses
568 (defvar compilation-enter-directory-face 'font-lock-function-name-face
569 "Face name to use for entering directory messages.")
571 (defvar compilation-leave-directory-face 'font-lock-type-face
572 "Face name to use for leaving directory messages.")
576 ;; Used for compatibility with the old compile.el.
577 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
578 (defvar compilation-parsing-end (make-marker))
579 (defvar compilation-parse-errors-function nil)
580 (defvar compilation-error-list nil)
581 (defvar compilation-old-error-list nil)
583 (defun compilation-face (type)
584 (or (and (car type) (match-end (car type)) compilation-warning-face)
585 (and (cdr type) (match-end (cdr type)) compilation-info-face)
586 compilation-error-face))
588 (defun compilation-text-face (type)
589 (or (and (car type) (match-end (car type)) compilation-warning-text-face)
590 (and (cdr type) (match-end (cdr type)) compilation-info-text-face)
591 compilation-error-text-face))
593 ;; Internal function for calculating the text properties of a directory
594 ;; change message. The directory property is important, because it is
595 ;; the stack of nested enter-messages. Relative filenames on the following
596 ;; lines are relative to the top of the stack.
597 (defun compilation-directory-properties (idx leave)
598 (if leave (setq leave (match-end leave)))
599 ;; find previous stack, and push onto it, or if `leave' pop it
600 (let ((dir (previous-single-property-change (point) 'directory)))
601 (setq dir (if dir (or (get-text-property (1- dir) 'directory)
602 (get-text-property dir 'directory))))
604 compilation-leave-directory-face
605 compilation-enter-directory-face)
608 '(nil)) ; nil only isn't a property-change
609 (cons (match-string-no-properties idx) dir))
611 keymap compilation-button-map
612 help-echo "mouse-2: visit current directory")))
614 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
615 ;; KEY element from the ALIST, creating it in the right position if not already
616 ;; present. ALIST structure is
617 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
618 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
619 ;; may be nil. The other KEYs are ordered backwards so that growing line
620 ;; numbers can be inserted in front and searching can abort after half the
622 (eval-when-compile ;Don't keep it at runtime if not needed.
623 (defmacro compilation-assq (key alist)
626 (car (if (if (null ,key)
627 (if l2 (null (caar l2)))
628 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
631 (if l2 (eq ,key (caar l2))))
633 (setcdr l1 (cons (list ,key) l2)))))))
636 ;; This function is the central driver, called when font-locking to gather
637 ;; all information needed to later jump to corresponding source code.
638 ;; Return a property list with all meta information on this error location.
639 (defun compilation-error-properties (file line end-line col end-col type fmt)
640 (unless (< (next-single-property-change (match-beginning 0) 'directory nil (point))
644 (setq file (funcall file))
646 (setq file (match-string-no-properties file))
647 (unless (file-name-absolute-p file)
648 (setq dir (previous-single-property-change (point) 'directory)
649 dir (if dir (or (get-text-property (1- dir) 'directory)
650 (get-text-property dir 'directory)))))
651 (setq file (cons file (car dir)))))
652 ;; This message didn't mention one, get it from previous
653 (setq file (previous-single-property-change (point) 'message)
655 (car (nth 2 (car (or (get-text-property (1- file) 'message)
656 (get-text-property file 'message))))))
658 ;; All of these fields are optional, get them only if we have an index, and
659 ;; it matched some part of the message.
661 (setq line (match-string-no-properties line))
662 (setq line (string-to-number line)))
664 (setq end-line (match-string-no-properties end-line))
665 (setq end-line (string-to-number end-line)))
668 (setq col (funcall col))
670 (setq col (match-string-no-properties col))
671 (setq col (- (string-to-number col) compilation-first-column)))))
672 (if (and end-col (functionp end-col))
673 (setq end-col (funcall end-col))
674 (if (and end-col (setq end-col (match-string-no-properties end-col)))
675 (setq end-col (- (string-to-number end-col) compilation-first-column -1))
676 (if end-line (setq end-col -1))))
677 (if (consp type) ; not a static type, check what it is.
678 (setq type (or (and (car type) (match-end (car type)) 1)
679 (and (cdr type) (match-end (cdr type)) 0)
681 (compilation-internal-error-properties file line end-line col end-col type fmt)))
683 (defun compilation-move-to-column (col screen)
684 "Go to column COL on the current line.
685 If SCREEN is non-nil, columns are screen columns, otherwise, they are
689 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
691 (defun compilation-internal-error-properties (file line end-line col end-col type fmt)
692 "Get the meta-info that will be added as text-properties.
693 LINE, END-LINE, COL, END-COL are integers or nil.
694 TYPE can be 0, 1, or 2.
695 FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil."
696 (unless file (setq file '("*unknown*")))
697 (setq file (compilation-get-file-structure file fmt))
698 ;; Get first already existing marker (if any has one, all have one).
699 ;; Do this first, as the compilation-assq`s may create new nodes.
700 (let* ((marker-line (car (cddr file))) ; a line structure
701 (marker (nth 3 (cadr marker-line))) ; its marker
702 (compilation-error-screen-columns compilation-error-screen-columns)
703 end-marker loc end-loc)
704 (if (not (and marker (marker-buffer marker)))
705 (setq marker) ; no valid marker for this file
706 (setq loc (or line 1)) ; normalize no linenumber to line 1
707 (catch 'marker ; find nearest loc, at least one exists
708 (dolist (x (nthcdr 3 file)) ; loop over remaining lines
709 (if (> (car x) loc) ; still bigger
711 (if (> (- (or (car marker-line) 1) loc)
712 (- loc (car x))) ; current line is nearer
713 (setq marker-line x))
715 (setq marker (nth 3 (cadr marker-line))
716 marker-line (or (car marker-line) 1))
717 (with-current-buffer (marker-buffer marker)
720 (goto-char (marker-position marker))
721 (when (or end-col end-line)
722 (beginning-of-line (- (or end-line line) marker-line -1))
723 (if (or (null end-col) (< end-col 0))
725 (compilation-move-to-column
726 end-col compilation-error-screen-columns))
727 (setq end-marker (list (point-marker))))
728 (beginning-of-line (if end-line
730 (- loc marker-line -1)))
732 (compilation-move-to-column
733 col compilation-error-screen-columns)
734 (forward-to-indentation 0))
735 (setq marker (list (point-marker))))))
737 (setq loc (compilation-assq line (cdr file)))
739 (setq end-loc (compilation-assq end-line (cdr file))
740 end-loc (compilation-assq end-col end-loc))
741 (if end-col ; use same line element
742 (setq end-loc (compilation-assq end-col loc))))
743 (setq loc (compilation-assq col loc))
744 ;; If they are new, make the loc(s) reference the file they point to.
745 (or (cdr loc) (setcdr loc `(,line ,file ,@marker)))
747 (or (cdr end-loc) (setcdr end-loc `(,(or end-line line) ,file ,@end-marker))))
749 ;; Must start with face
750 `(face ,compilation-message-face
751 message (,loc ,type ,end-loc)
752 ,@(if compilation-debug
753 `(debug (,(assoc (with-no-warnings matcher) font-lock-keywords)
756 "mouse-2: visit this file, line and column"
758 "mouse-2: visit this file and line"
759 "mouse-2: visit this file"))
760 keymap compilation-button-map
761 mouse-face highlight)))
763 (defun compilation-mode-font-lock-keywords ()
764 "Return expressions to highlight in Compilation mode."
765 (if compilation-parse-errors-function
766 ;; An old package! Try the compatibility code.
767 '((compilation-compat-parse-errors))
769 ;; make directory tracking
770 (if compilation-directory-matcher
771 `((,(car compilation-directory-matcher)
772 ,@(mapcar (lambda (elt)
774 (compilation-directory-properties
775 ,(car elt) ,(cdr elt))
777 (cdr compilation-directory-matcher)))))
779 ;; Compiler warning/error lines.
783 (setq item (cdr (assq item
784 compilation-error-regexp-alist-alist))))
785 (let ((file (nth 1 item))
789 end-line end-col fmt)
790 (if (consp file) (setq fmt (cdr file) file (car file)))
791 (if (consp line) (setq end-line (cdr line) line (car line)))
792 (if (consp col) (setq end-col (cdr col) col (car col)))
795 ;; The old compile.el had here an undocumented hook that
796 ;; allowed `line' to be a function that computed the actual
797 ;; error location. Let's do our best.
800 (compilation-compat-error-properties
801 (funcall ',line (cons (match-string ,file)
802 (cons default-directory
804 ,(if col `(match-string ,col))))))
805 (,file compilation-error-face t))
807 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
808 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
812 ,@(when (integerp file)
813 `((,file ,(if (consp type)
814 `(compilation-face ',type)
815 (aref [compilation-info-face
816 compilation-warning-face
817 compilation-error-face]
821 `((,line compilation-line-face nil t)))
823 `((,end-line compilation-line-face nil t)))
825 ,@(when (integerp col)
826 `((,col compilation-column-face nil t)))
827 ,@(when (integerp end-col)
828 `((,end-col compilation-column-face nil t)))
831 (,(or (nth 5 item) 0)
832 (compilation-error-properties ',file ,line ,end-line
833 ,col ,end-col ',(or type 2)
835 append))))) ; for compilation-message-face
836 compilation-error-regexp-alist)
838 compilation-mode-font-lock-keywords)))
842 (defun compile (command &optional comint)
843 "Compile the program including the current buffer. Default: run `make'.
844 Runs COMMAND, a shell command, in a separate process asynchronously
845 with output going to the buffer `*compilation*'.
847 If optional second arg COMINT is t the buffer will be in Comint mode with
848 `compilation-shell-minor-mode'.
850 You can then use the command \\[next-error] to find the next error message
851 and move to the source code that caused it.
853 Interactively, prompts for the command if `compilation-read-command' is
854 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
855 Additionally, with universal prefix arg, compilation buffer will be in
856 comint mode, i.e. interactive.
858 To run more than one compilation at once, start one and rename
859 the \`*compilation*' buffer to some other name with
860 \\[rename-buffer]. Then start the next one. On most systems,
861 termination of the main compilation process kills its
864 The name used for the buffer is actually whatever is returned by
865 the function in `compilation-buffer-name-function', so you can set that
866 to a function that generates a unique name."
869 (let ((command (eval compile-command)))
870 (if (or compilation-read-command current-prefix-arg)
871 (read-from-minibuffer "Compile command: "
873 (if (equal (car compile-history) command)
874 '(compile-history . 1)
877 (consp current-prefix-arg)))
878 (unless (equal command (eval compile-command))
879 (setq compile-command command))
880 (save-some-buffers (not compilation-ask-about-save) nil)
881 (setq compilation-directory default-directory)
882 (compilation-start command comint))
884 ;; run compile with the default command line
886 "Re-compile the program including the current buffer.
887 If this is run in a Compilation mode buffer, re-use the arguments from the
888 original use. Otherwise, recompile using `compile-command'."
890 (save-some-buffers (not compilation-ask-about-save) nil)
891 (let ((default-directory
892 (or (and (not (eq major-mode (nth 1 compilation-arguments)))
893 compilation-directory)
895 (apply 'compilation-start (or compilation-arguments
896 `(,(eval compile-command))))))
898 (defcustom compilation-scroll-output nil
899 "*Non-nil to scroll the *compilation* buffer window as output appears.
901 Setting it causes the Compilation mode commands to put point at the
902 end of their output window so that the end of the output is always
903 visible rather than the beginning."
909 (defun compilation-buffer-name (mode-name name-function)
910 "Return the name of a compilation buffer to use.
911 If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
912 to determine the buffer name.
913 Likewise if `compilation-buffer-name-function' is non-nil.
914 If current buffer is in Compilation mode for the same mode name
915 return the name of the current buffer, so that it gets reused.
916 Otherwise, construct a buffer name from MODE-NAME."
918 (funcall name-function mode-name))
919 (compilation-buffer-name-function
920 (funcall compilation-buffer-name-function mode-name))
921 ((eq major-mode (nth 1 compilation-arguments))
924 (concat "*" (downcase mode-name) "*"))))
926 ;; This is a rough emulation of the old hack, until the transition to new
927 ;; compile is complete.
928 (defun compile-internal (command error-message
929 &optional name-of-mode parser
930 error-regexp-alist name-function
931 enter-regexp-alist leave-regexp-alist
932 file-regexp-alist nomessage-regexp-alist
933 no-async highlight-regexp local-map)
935 (error "Compile now works very differently, see `compilation-error-regexp-alist'"))
936 (let ((compilation-error-regexp-alist
937 (append file-regexp-alist (or error-regexp-alist
938 compilation-error-regexp-alist)))
939 (compilation-error (replace-regexp-in-string "^No more \\(.+\\)s\\.?"
940 "\\1" error-message)))
941 (compilation-start command nil name-function highlight-regexp)))
942 (make-obsolete 'compile-internal 'compilation-start)
944 (defun compilation-start (command &optional mode name-function highlight-regexp)
945 "Run compilation command COMMAND (low level interface).
946 If COMMAND starts with a cd command, that becomes the `default-directory'.
947 The rest of the arguments are optional; for them, nil means use the default.
949 MODE is the major mode to set in the compilation buffer. Mode
950 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
951 NAME-FUNCTION is a function called to name the buffer.
953 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
954 the matching section of the visited source line; the default is to use the
955 global value of `compilation-highlight-regexp'.
957 Returns the compilation buffer created."
958 (or mode (setq mode 'compilation-mode))
961 (prog1 "compilation" (require 'comint))
962 (replace-regexp-in-string "-mode$" "" (symbol-name mode))))
963 (thisdir default-directory)
968 (compilation-buffer-name name-of-mode name-function)))
969 (let ((comp-proc (get-buffer-process (current-buffer))))
971 (if (or (not (eq (process-status comp-proc) 'run))
973 (format "A %s process is running; kill it? "
977 (interrupt-process comp-proc)
979 (delete-process comp-proc))
981 (error "Cannot have two processes in `%s' at once"
983 (buffer-disable-undo (current-buffer))
984 ;; first transfer directory from where M-x compile was called
985 (setq default-directory thisdir)
986 ;; Make compilation buffer read-only. The filter can still write it.
987 ;; Clear out the compilation buffer.
988 (let ((inhibit-read-only t)
989 (default-directory thisdir))
990 ;; Then evaluate a cd command if any, but don't perform it yet, else start-command
991 ;; would do it again through the shell: (cd "..") AND sh -c "cd ..; make"
992 (cd (if (string-match "^\\s *cd\\(?:\\s +\\(\\S +?\\)\\)?\\s *[;&\n]" command)
994 (substitute-env-vars (match-string 1 command))
998 ;; Select the desired mode.
999 (if (not (eq mode t))
1001 (setq buffer-read-only nil)
1002 (with-no-warnings (comint-mode))
1003 (compilation-shell-minor-mode))
1004 (if highlight-regexp
1005 (set (make-local-variable 'compilation-highlight-regexp)
1007 ;; Output a mode setter, for saving and later reloading this buffer.
1008 (insert "-*- mode: " name-of-mode
1009 "; default-directory: " (prin1-to-string default-directory)
1010 " -*-\n" command "\n")
1011 (setq thisdir default-directory))
1012 (set-buffer-modified-p nil))
1013 ;; If we're already in the compilation buffer, go to the end
1014 ;; of the buffer, so point will track the compilation output.
1015 (if (eq outbuf (current-buffer))
1016 (goto-char (point-max)))
1017 ;; Pop up the compilation buffer.
1018 (setq outwin (display-buffer outbuf nil t))
1019 (with-current-buffer outbuf
1020 (let ((process-environment
1022 compilation-environment
1023 (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning
1024 system-uses-terminfo)
1025 (list "TERM=dumb" "TERMCAP="
1026 (format "COLUMNS=%d" (window-width)))
1028 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1030 ;; Set the EMACS variable, but
1031 ;; don't override users' setting of $EMACS.
1032 (unless (getenv "EMACS") '("EMACS=t"))
1033 (copy-sequence process-environment))))
1034 (set (make-local-variable 'compilation-arguments)
1035 (list command mode name-function highlight-regexp))
1036 (set (make-local-variable 'revert-buffer-function)
1037 'compilation-revert-buffer)
1038 (set-window-start outwin (point-min))
1039 (or (eq outwin (selected-window))
1040 (set-window-point outwin (if compilation-scroll-output
1043 ;; The setup function is called before compilation-set-window-height
1044 ;; so it can set the compilation-window-height buffer locally.
1045 (if compilation-process-setup-function
1046 (funcall compilation-process-setup-function))
1047 (compilation-set-window-height outwin)
1048 ;; Start the compilation.
1049 (if (fboundp 'start-process)
1050 (let ((proc (if (eq mode t)
1053 (comint-exec outbuf (downcase mode-name)
1054 shell-file-name nil `("-c" ,command))))
1055 (start-process-shell-command (downcase mode-name)
1057 ;; Make the buffer's mode line show process state.
1058 (setq mode-line-process '(":%s"))
1059 (set-process-sentinel proc 'compilation-sentinel)
1060 (set-process-filter proc 'compilation-filter)
1061 (set-marker (process-mark proc) (point) outbuf)
1062 (setq compilation-in-progress
1063 (cons proc compilation-in-progress)))
1064 ;; No asynchronous processes available.
1065 (message "Executing `%s'..." command)
1066 ;; Fake modeline display as if `start-process' were run.
1067 (setq mode-line-process ":run")
1068 (force-mode-line-update)
1069 (sit-for 0) ; Force redisplay
1070 (let* ((buffer-read-only nil) ; call-process needs to modify outbuf
1071 (status (call-process shell-file-name nil outbuf nil "-c"
1073 (cond ((numberp status)
1074 (compilation-handle-exit 'exit status
1078 exited abnormally with code %d\n"
1081 (compilation-handle-exit 'signal status
1082 (concat status "\n")))
1084 (compilation-handle-exit 'bizarre status status))))
1085 ;; Without async subprocesses, the buffer is not yet
1086 ;; fontified, so fontify it now.
1087 (let ((font-lock-verbose nil)) ; shut up font-lock messages
1088 (font-lock-fontify-buffer))
1089 (set-buffer-modified-p nil)
1090 (message "Executing `%s'...done" command)))
1091 ;; Now finally cd to where the shell started make/grep/...
1092 (setq default-directory thisdir))
1093 (if (buffer-local-value 'compilation-scroll-output outbuf)
1094 (save-selected-window
1095 (select-window outwin)
1096 (goto-char (point-max))))
1097 ;; Make it so the next C-x ` will use this buffer.
1098 (setq next-error-last-buffer outbuf)))
1100 (defun compilation-set-window-height (window)
1101 "Set the height of WINDOW according to `compilation-window-height'."
1102 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1104 (= (window-width window) (frame-width (window-frame window)))
1105 ;; If window is alone in its frame, aside from a minibuffer,
1106 ;; don't change its height.
1107 (not (eq window (frame-root-window (window-frame window))))
1108 ;; Stef said that doing the saves in this order is safer:
1110 (save-selected-window
1111 (select-window window)
1112 (enlarge-window (- height (window-height))))))))
1114 (defvar compilation-menu-map
1115 (let ((map (make-sparse-keymap "Errors")))
1116 (define-key map [stop-subjob]
1117 '("Stop Compilation" . kill-compilation))
1118 (define-key map [compilation-mode-separator2]
1120 (define-key map [compilation-first-error]
1121 '("First Error" . first-error))
1122 (define-key map [compilation-previous-error]
1123 '("Previous Error" . previous-error))
1124 (define-key map [compilation-next-error]
1125 '("Next Error" . next-error))
1128 (defvar compilation-minor-mode-map
1129 (let ((map (make-sparse-keymap)))
1130 (define-key map [mouse-2] 'compile-goto-error)
1131 (define-key map [follow-link] 'mouse-face)
1132 (define-key map "\C-c\C-c" 'compile-goto-error)
1133 (define-key map "\C-m" 'compile-goto-error)
1134 (define-key map "\C-c\C-k" 'kill-compilation)
1135 (define-key map "\M-n" 'compilation-next-error)
1136 (define-key map "\M-p" 'compilation-previous-error)
1137 (define-key map "\M-{" 'compilation-previous-file)
1138 (define-key map "\M-}" 'compilation-next-file)
1139 ;; Set up the menu-bar
1140 (define-key map [menu-bar compilation]
1141 (cons "Errors" compilation-menu-map))
1143 "Keymap for `compilation-minor-mode'.")
1145 (defvar compilation-shell-minor-mode-map
1146 (let ((map (make-sparse-keymap)))
1147 (define-key map "\M-\C-m" 'compile-goto-error)
1148 (define-key map "\M-\C-n" 'compilation-next-error)
1149 (define-key map "\M-\C-p" 'compilation-previous-error)
1150 (define-key map "\M-{" 'compilation-previous-file)
1151 (define-key map "\M-}" 'compilation-next-file)
1152 ;; Set up the menu-bar
1153 (define-key map [menu-bar compilation]
1154 (cons "Errors" compilation-menu-map))
1156 "Keymap for `compilation-shell-minor-mode'.")
1158 (defvar compilation-button-map
1159 (let ((map (make-sparse-keymap)))
1160 (define-key map [mouse-2] 'compile-goto-error)
1161 (define-key map [follow-link] 'mouse-face)
1162 (define-key map "\C-m" 'compile-goto-error)
1164 "Keymap for compilation-message buttons.")
1165 (fset 'compilation-button-map compilation-button-map)
1167 (defvar compilation-mode-map
1168 (let ((map (make-sparse-keymap)))
1169 ;; Don't inherit from compilation-minor-mode-map,
1170 ;; because that introduces a menu bar item we don't want.
1171 ;; That confuses C-down-mouse-3.
1172 (define-key map [mouse-2] 'compile-goto-error)
1173 (define-key map [follow-link] 'mouse-face)
1174 (define-key map "\C-c\C-c" 'compile-goto-error)
1175 (define-key map "\C-m" 'compile-goto-error)
1176 (define-key map "\C-c\C-k" 'kill-compilation)
1177 (define-key map "\M-n" 'compilation-next-error)
1178 (define-key map "\M-p" 'compilation-previous-error)
1179 (define-key map "\M-{" 'compilation-previous-file)
1180 (define-key map "\M-}" 'compilation-next-file)
1181 (define-key map "\t" 'compilation-next-error)
1182 (define-key map [backtab] 'compilation-previous-error)
1184 (define-key map " " 'scroll-up)
1185 (define-key map "\^?" 'scroll-down)
1186 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1188 ;; Set up the menu-bar
1189 (let ((submap (make-sparse-keymap "Compile")))
1190 (define-key map [menu-bar compilation]
1191 (cons "Compile" submap))
1192 (set-keymap-parent submap compilation-menu-map))
1193 (define-key map [menu-bar compilation compilation-separator2]
1195 (define-key map [menu-bar compilation compilation-grep]
1196 '("Search Files (grep)" . grep))
1197 (define-key map [menu-bar compilation compilation-recompile]
1198 '("Recompile" . recompile))
1199 (define-key map [menu-bar compilation compilation-compile]
1200 '("Compile..." . compile))
1202 "Keymap for compilation log buffers.
1203 `compilation-minor-mode-map' is a parent of this.")
1205 (put 'compilation-mode 'mode-class 'special)
1207 (defvar compilation-skip-to-next-location t
1208 "*If non-nil, skip multiple error messages for the same source location.")
1210 (defcustom compilation-skip-threshold 1
1211 "*Compilation motion commands skip less important messages.
1212 The value can be either 2 -- skip anything less than error, 1 --
1213 skip anything less than warning or 0 -- don't skip any messages.
1214 Note that all messages not positively identified as warning or
1215 info, are considered errors."
1216 :type '(choice (const :tag "Warnings and info" 2)
1217 (const :tag "Info" 1)
1218 (const :tag "None" 0))
1222 (defcustom compilation-skip-visited nil
1223 "*Compilation motion commands skip visited messages if this is t.
1224 Visited messages are ones for which the file, line and column have been jumped
1225 to from the current content in the current compilation buffer, even if it was
1226 from a different message."
1232 (defun compilation-mode (&optional name-of-mode)
1233 "Major mode for compilation log buffers.
1234 \\<compilation-mode-map>To visit the source for a line-numbered error,
1235 move point to the error message line and type \\[compile-goto-error].
1236 To kill the compilation, type \\[kill-compilation].
1238 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
1240 \\{compilation-mode-map}"
1242 (kill-all-local-variables)
1243 (use-local-map compilation-mode-map)
1244 (setq major-mode 'compilation-mode
1245 mode-name (or name-of-mode "Compilation"))
1246 (set (make-local-variable 'page-delimiter)
1247 compilation-page-delimiter)
1249 (setq buffer-read-only t)
1250 (run-mode-hooks 'compilation-mode-hook))
1252 (defmacro define-compilation-mode (mode name doc &rest body)
1253 "This is like `define-derived-mode' without the PARENT argument.
1254 The parent is always `compilation-mode' and the customizable `compilation-...'
1255 variables are also set from the name of the mode you have chosen, by replacing
1256 the fist word, e.g `compilation-scroll-output' from `grep-scroll-output' if that
1258 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1259 `(define-derived-mode ,mode compilation-mode ,name
1261 ,@(mapcar (lambda (v)
1263 (intern-soft (replace-regexp-in-string
1264 "^compilation" mode-name
1267 (or (boundp (cdr v))
1268 (if (boundp 'byte-compile-bound-variables)
1269 (memq (cdr v) byte-compile-bound-variables)))
1270 `(set (make-local-variable ',(car v)) ,(cdr v))))
1271 '(compilation-buffer-name-function
1272 compilation-directory-matcher
1274 compilation-error-regexp-alist
1275 compilation-error-regexp-alist-alist
1276 compilation-error-screen-columns
1277 compilation-finish-function
1278 compilation-finish-functions
1279 compilation-first-column
1280 compilation-mode-font-lock-keywords
1281 compilation-page-delimiter
1282 compilation-parse-errors-filename-function
1283 compilation-process-setup-function
1284 compilation-scroll-output
1285 compilation-search-path
1286 compilation-skip-threshold
1287 compilation-window-height))
1290 (defun compilation-revert-buffer (ignore-auto noconfirm)
1291 (if buffer-file-name
1292 (let (revert-buffer-function)
1293 (revert-buffer ignore-auto noconfirm))
1294 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1295 (apply 'compilation-start compilation-arguments))))
1297 (defvar compilation-current-error nil
1298 "Marker to the location from where the next error will be found.
1299 The global commands next/previous/first-error/goto-error use this.")
1301 (defvar compilation-messages-start nil
1302 "Buffer position of the beginning of the compilation messages.
1303 If nil, use the beginning of buffer.")
1305 ;; A function name can't be a hook, must be something with a value.
1306 (defconst compilation-turn-on-font-lock 'turn-on-font-lock)
1308 (defun compilation-setup (&optional minor)
1309 "Prepare the buffer for the compilation parsing commands to work.
1310 Optional argument MINOR indicates this is called from
1311 `compilation-minor-mode'."
1312 (make-local-variable 'compilation-current-error)
1313 (make-local-variable 'compilation-messages-start)
1314 (make-local-variable 'compilation-error-screen-columns)
1315 (make-local-variable 'overlay-arrow-position)
1316 (set (make-local-variable 'overlay-arrow-string) "")
1317 (setq next-error-overlay-arrow-position nil)
1318 (add-hook 'kill-buffer-hook
1319 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
1320 ;; Note that compilation-next-error-function is for interfacing
1321 ;; with the next-error function in simple.el, and it's only
1322 ;; coincidentally named similarly to compilation-next-error.
1323 (setq next-error-function 'compilation-next-error-function)
1324 (set (make-local-variable 'font-lock-extra-managed-props)
1325 '(directory message help-echo mouse-face debug))
1326 (set (make-local-variable 'compilation-locs)
1327 (make-hash-table :test 'equal :weakness 'value))
1328 ;; lazy-lock would never find the message unless it's scrolled to.
1329 ;; jit-lock might fontify some things too late.
1330 (set (make-local-variable 'font-lock-support-mode) nil)
1331 (set (make-local-variable 'font-lock-maximum-size) nil)
1332 (let ((fld font-lock-defaults))
1334 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1335 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t)))
1339 (font-lock-fontify-buffer)
1340 (font-lock-change-mode)
1341 (turn-on-font-lock))
1342 (turn-on-font-lock))
1343 ;; maybe defer font-lock till after derived mode is set up
1344 (run-mode-hooks 'compilation-turn-on-font-lock))))
1347 (define-minor-mode compilation-shell-minor-mode
1348 "Toggle compilation shell minor mode.
1349 With arg, turn compilation mode on if and only if arg is positive.
1350 In this minor mode, all the error-parsing commands of the
1351 Compilation major mode are available but bound to keys that don't
1352 collide with Shell mode. See `compilation-mode'.
1353 Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
1354 nil " Shell-Compile"
1356 (if compilation-shell-minor-mode
1357 (compilation-setup t)
1358 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1359 (font-lock-fontify-buffer)))
1362 (define-minor-mode compilation-minor-mode
1363 "Toggle compilation minor mode.
1364 With arg, turn compilation mode on if and only if arg is positive.
1365 In this minor mode, all the error-parsing commands of the
1366 Compilation major mode are available. See `compilation-mode'.
1367 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
1370 (if compilation-minor-mode
1371 (compilation-setup t)
1372 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1373 (font-lock-fontify-buffer)))
1375 (defun compilation-handle-exit (process-status exit-status msg)
1376 "Write MSG in the current buffer and hack its mode-line-process."
1377 (let ((inhibit-read-only t)
1378 (status (if compilation-exit-message-function
1379 (funcall compilation-exit-message-function
1380 process-status exit-status msg)
1381 (cons msg exit-status)))
1384 ;; Record where we put the message, so we can ignore it later on.
1386 (insert ?\n mode-name " " (car status))
1387 (if (and (numberp compilation-window-height)
1388 (zerop compilation-window-height))
1389 (message "%s" (cdr status)))
1392 (insert " at " (substring (current-time-string) 0 19))
1393 (goto-char (point-max))
1394 ;; Prevent that message from being recognized as a compilation error.
1395 (add-text-properties omax (point)
1396 (append '(compilation-handle-exit t) nil))
1397 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
1398 ;; Force mode line redisplay soon.
1399 (force-mode-line-update)
1400 (if (and opoint (< opoint omax))
1403 (if compilation-finish-function
1404 (funcall compilation-finish-function (current-buffer) msg)))
1405 (let ((functions compilation-finish-functions))
1407 (funcall (car functions) (current-buffer) msg)
1408 (setq functions (cdr functions))))))
1410 ;; Called when compilation process changes state.
1411 (defun compilation-sentinel (proc msg)
1412 "Sentinel for compilation buffers."
1413 (if (memq (process-status proc) '(exit signal))
1414 (let ((buffer (process-buffer proc)))
1415 (if (null (buffer-name buffer))
1417 (set-process-buffer proc nil)
1418 (with-current-buffer buffer
1419 ;; Write something in the compilation buffer
1420 ;; and hack its mode line.
1421 (compilation-handle-exit (process-status proc)
1422 (process-exit-status proc)
1424 ;; Since the buffer and mode line will show that the
1425 ;; process is dead, we can delete it now. Otherwise it
1426 ;; will stay around until M-x list-processes.
1427 (delete-process proc)))
1428 (setq compilation-in-progress (delq proc compilation-in-progress)))))
1430 (defun compilation-filter (proc string)
1431 "Process filter for compilation buffers.
1432 Just inserts the text, but uses `insert-before-markers'."
1433 (if (buffer-name (process-buffer proc))
1434 (with-current-buffer (process-buffer proc)
1435 (let ((inhibit-read-only t))
1437 (goto-char (process-mark proc))
1438 (insert-before-markers string)
1439 (run-hooks 'compilation-filter-hook))))))
1441 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
1442 (defsubst compilation-buffer-internal-p ()
1443 "Test if inside a compilation buffer."
1444 (local-variable-p 'compilation-locs))
1446 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
1447 (defsubst compilation-buffer-p (buffer)
1448 "Test if BUFFER is a compilation buffer."
1449 (with-current-buffer buffer
1450 (compilation-buffer-internal-p)))
1452 (defmacro compilation-loop (< property-change 1+ error)
1454 (or (setq pt (,property-change pt 'message))
1455 (error ,error compilation-error))
1456 ;; prop 'message usually has 2 changes, on and off, so re-search if off
1457 (or (setq msg (get-text-property pt 'message))
1458 (if (setq pt (,property-change pt 'message))
1459 (setq msg (get-text-property pt 'message)))
1460 (error ,error compilation-error))
1461 (or (< (cadr msg) compilation-skip-threshold)
1463 (eq (prog1 last (setq last (nth 2 (car msg))))
1465 (if compilation-skip-visited
1466 (nthcdr 4 (car msg)))
1467 (if compilation-skip-to-next-location
1469 ;; count this message only if none of the above are true
1472 (defun compilation-next-error (n &optional different-file pt)
1473 "Move point to the next error in the compilation buffer.
1474 Prefix arg N says how many error messages to move forwards (or
1475 backwards, if negative).
1476 Does NOT find the source line like \\[next-error]."
1478 (or (compilation-buffer-p (current-buffer))
1479 (error "Not in a compilation buffer"))
1480 (or pt (setq pt (point)))
1481 (let* ((msg (get-text-property pt 'message))
1485 (unless (or msg ; find message near here
1486 (setq msg (get-text-property (max (1- pt) (point-min))
1488 (setq pt (previous-single-property-change pt 'message nil
1489 (line-beginning-position)))
1490 (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message))
1491 (setq pt (next-single-property-change pt 'message nil
1492 (line-end-position)))
1493 (or (setq msg (get-text-property pt 'message))
1494 (setq pt (point)))))
1495 (setq last (nth 2 (car msg)))
1497 (compilation-loop > next-single-property-change 1-
1498 (if (get-buffer-process (current-buffer))
1500 "Moved past last %s"))
1501 ;; Don't move "back" to message at or before point.
1502 ;; Pass an explicit (point-min) to make sure pt is non-nil.
1503 (setq pt (previous-single-property-change pt 'message nil (point-min)))
1504 (compilation-loop < previous-single-property-change 1+
1505 "Moved back before first %s")))
1508 (error "No %s here" compilation-error))))
1510 (defun compilation-previous-error (n)
1511 "Move point to the previous error in the compilation buffer.
1512 Prefix arg N says how many error messages to move backwards (or
1513 forwards, if negative).
1514 Does NOT find the source line like \\[previous-error]."
1516 (compilation-next-error (- n)))
1518 (defun compilation-next-file (n)
1519 "Move point to the next error for a different file than the current one.
1520 Prefix arg N says how many files to move forwards (or backwards, if negative)."
1522 (compilation-next-error n t))
1524 (defun compilation-previous-file (n)
1525 "Move point to the previous error for a different file than the current one.
1526 Prefix arg N says how many files to move backwards (or forwards, if negative)."
1528 (compilation-next-file (- n)))
1530 (defun kill-compilation ()
1531 "Kill the process made by the \\[compile] or \\[grep] commands."
1533 (let ((buffer (compilation-find-buffer)))
1534 (if (get-buffer-process buffer)
1535 (interrupt-process (get-buffer-process buffer))
1536 (error "The compilation process is not running"))))
1538 (defalias 'compile-mouse-goto-error 'compile-goto-error)
1540 (defun compile-goto-error (&optional event)
1541 "Visit the source for the error message at point.
1542 Use this command in a compilation log buffer. Sets the mark at point there."
1543 (interactive (list last-input-event))
1544 (if event (posn-set-point (event-end event)))
1545 (or (compilation-buffer-p (current-buffer))
1546 (error "Not in a compilation buffer"))
1547 (if (get-text-property (point) 'directory)
1548 (dired-other-window (car (get-text-property (point) 'directory)))
1550 (setq compilation-current-error (point))
1553 ;; Return a compilation buffer.
1554 ;; If the current buffer is a compilation buffer, return it.
1555 ;; Otherwise, look for a compilation buffer and signal an error
1556 ;; if there are none.
1557 (defun compilation-find-buffer (&optional avoid-current)
1558 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p))
1561 (defun compilation-next-error-function (n &optional reset)
1562 "Advance to the next error message and visit the file where the error was.
1563 This is the value of `next-error-function' in Compilation buffers."
1566 (setq compilation-current-error nil))
1567 (let* ((columns compilation-error-screen-columns) ; buffer's local value
1569 (loc (compilation-next-error (or n 1) nil
1570 (or compilation-current-error
1571 compilation-messages-start
1573 (end-loc (nth 2 loc))
1574 (marker (point-marker)))
1575 (setq compilation-current-error (point-marker)
1576 overlay-arrow-position
1578 compilation-current-error
1579 (copy-marker (line-beginning-position)))
1581 ;; If loc contains no marker, no error in that file has been visited. If
1582 ;; the marker is invalid the buffer has been killed. So, recalculate all
1583 ;; markers for that file.
1584 (unless (and (nth 3 loc) (marker-buffer (nth 3 loc)))
1585 (with-current-buffer (compilation-find-file marker (caar (nth 2 loc))
1586 (or (cdar (nth 2 loc))
1590 (goto-char (point-min))
1591 ;; Treat file's found lines in forward order, 1 by 1.
1592 (dolist (line (reverse (cddr (nth 2 loc))))
1593 (when (car line) ; else this is a filename w/o a line#
1594 (beginning-of-line (- (car line) last -1))
1595 (setq last (car line)))
1596 ;; Treat line's found columns and store/update a marker for each.
1597 (dolist (col (cdr line))
1599 (if (eq (car col) -1) ; special case for range end
1601 (compilation-move-to-column (car col) columns))
1603 (skip-chars-forward " \t"))
1605 (set-marker (nth 3 col) (point))
1606 (setcdr (nthcdr 2 col) `(,(point-marker)))))))))
1607 (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc))
1608 (setcdr (nthcdr 3 loc) t))) ; Set this one as visited.
1610 (defvar compilation-gcpro nil
1611 "Internal variable used to keep some values from being GC'd.")
1612 (make-variable-buffer-local 'compilation-gcpro)
1614 (defun compilation-fake-loc (marker file &optional line col)
1615 "Preassociate MARKER with FILE.
1616 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
1617 This is useful when you compile temporary files, but want
1618 automatic translation of the messages to the real buffer from
1619 which the temporary file came. This only works if done before a
1620 message about FILE appears!
1622 Optional args LINE and COL default to 1 and beginning of
1623 indentation respectively. The marker is expected to reflect
1624 this. In the simplest case the marker points to the first line
1625 of the region that was saved to the temp file.
1627 If you concatenate several regions into the temp file (e.g. a
1628 header with variable assignments and a code region), you must
1629 call this several times, once each for the last line of one
1630 region and the first line of the next region."
1631 (or (consp file) (setq file (list file)))
1632 (setq file (compilation-get-file-structure file))
1633 ;; Between the current call to compilation-fake-loc and the first occurrence
1634 ;; of an error message referring to `file', the data is only kept is the
1635 ;; weak hash-table compilation-locs, so we need to prevent this entry
1636 ;; in compilation-locs from being GC'd away. --Stef
1637 (push file compilation-gcpro)
1638 (let ((loc (compilation-assq (or line 1) (cdr file))))
1639 (setq loc (compilation-assq col loc))
1641 (setcdr (cddr loc) (list marker))
1642 (setcdr loc (list line file marker)))
1645 (defcustom compilation-context-lines nil
1646 "Display this many lines of leading context before the current message.
1647 If nil and the left fringe is displayed, don't scroll the
1648 compilation output window; an arrow in the left fringe points to
1649 the current message. If nil and there is no left fringe, the message
1650 displays at the top of the window; there is no arrow."
1651 :type '(choice integer (const :tag "No window scrolling" nil))
1655 (defsubst compilation-set-window (w mk)
1656 "Align the compilation output window W with marker MK near top."
1657 (if (integerp compilation-context-lines)
1658 (set-window-start w (save-excursion
1661 (- 1 compilation-context-lines))
1663 ;; If there is no left fringe.
1664 (if (equal (car (window-fringes)) 0)
1665 (set-window-start w (save-excursion
1667 (beginning-of-line 1)
1669 (set-window-point w mk))
1671 (defvar next-error-highlight-timer)
1673 (defun compilation-goto-locus (msg mk end-mk)
1674 "Jump to an error corresponding to MSG at MK.
1675 All arguments are markers. If END-MK is non-nil, mark is set there
1676 and overlay is highlighted between MK and END-MK."
1677 (if (eq (window-buffer (selected-window))
1678 (marker-buffer msg))
1679 ;; If the compilation buffer window is selected,
1680 ;; keep the compilation buffer in this window;
1681 ;; display the source in another window.
1682 (let ((pop-up-windows t))
1683 (pop-to-buffer (marker-buffer mk)))
1684 (if (window-dedicated-p (selected-window))
1685 (pop-to-buffer (marker-buffer mk))
1686 (switch-to-buffer (marker-buffer mk))))
1687 ;; If narrowing gets in the way of going to the right place, widen.
1688 (unless (eq (goto-char mk) (point))
1692 (push-mark end-mk t)
1693 (if mark-active (setq mark-active)))
1694 ;; If hideshow got in the way of
1695 ;; seeing the right place, open permanently.
1696 (dolist (ov (overlays-at (point)))
1697 (when (eq 'hs (overlay-get ov 'invisible))
1701 ;; Show compilation buffer in other window, scrolled to this error.
1702 (let* ((pop-up-windows t)
1703 ;; Use an existing window if it is in a visible frame.
1704 (w (or (get-buffer-window (marker-buffer msg) 'visible)
1706 (display-buffer (marker-buffer msg))))
1707 (highlight-regexp (with-current-buffer (marker-buffer msg)
1708 ;; also do this while we change buffer
1709 (compilation-set-window w msg)
1710 compilation-highlight-regexp)))
1711 (compilation-set-window-height w)
1713 (when highlight-regexp
1714 (if (timerp next-error-highlight-timer)
1715 (cancel-timer next-error-highlight-timer))
1716 (unless compilation-highlight-overlay
1717 (setq compilation-highlight-overlay
1718 (make-overlay (point-min) (point-min)))
1719 (overlay-put compilation-highlight-overlay 'face 'next-error))
1720 (with-current-buffer (marker-buffer mk)
1722 (if end-mk (goto-char end-mk) (end-of-line))
1723 (let ((end (point)))
1724 (if mk (goto-char mk) (beginning-of-line))
1725 (if (and (stringp highlight-regexp)
1726 (re-search-forward highlight-regexp end t))
1728 (goto-char (match-beginning 0))
1729 (move-overlay compilation-highlight-overlay
1730 (match-beginning 0) (match-end 0)
1732 (move-overlay compilation-highlight-overlay
1733 (point) end (current-buffer)))
1734 (if (numberp next-error-highlight)
1735 (setq next-error-highlight-timer
1736 (run-at-time next-error-highlight nil 'delete-overlay
1737 compilation-highlight-overlay)))
1738 (if (not (or (eq next-error-highlight t)
1739 (numberp next-error-highlight)))
1740 (delete-overlay compilation-highlight-overlay))))))
1741 (when (and (eq next-error-highlight 'fringe-arrow))
1742 (setq next-error-overlay-arrow-position
1743 (copy-marker (line-beginning-position))))))
1746 (defun compilation-find-file (marker filename dir &rest formats)
1747 "Find a buffer for file FILENAME.
1748 Search the directories in `compilation-search-path'.
1749 A nil in `compilation-search-path' means to try the
1750 current directory, which is passed in DIR.
1751 If FILENAME is not found at all, ask the user where to find it.
1752 Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
1753 (or formats (setq formats '("%s")))
1755 (let ((dirs compilation-search-path)
1756 buffer thisdir fmts name)
1757 (if (file-name-absolute-p filename)
1758 ;; The file name is absolute. Use its explicit directory as
1759 ;; the first in the search path, and strip it from FILENAME.
1760 (setq filename (abbreviate-file-name (expand-file-name filename))
1761 dirs (cons (file-name-directory filename) dirs)
1762 filename (file-name-nondirectory filename)))
1763 ;; Now search the path.
1764 (while (and dirs (null buffer))
1765 (setq thisdir (or (car dirs) dir)
1767 ;; For each directory, try each format string.
1768 (while (and fmts (null buffer))
1769 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1770 buffer (and (file-exists-p name)
1771 (find-file-noselect name))
1773 (setq dirs (cdr dirs)))
1775 ;; The file doesn't exist. Ask the user where to find it.
1776 (let ((pop-up-windows t))
1777 (compilation-set-window (display-buffer (marker-buffer marker))
1779 (let ((name (expand-file-name
1781 (format "Find this error in: (default %s) "
1784 (if (file-directory-p name)
1785 (setq name (expand-file-name filename name)))
1786 (setq buffer (and (file-exists-p name)
1787 (find-file name))))))
1788 ;; Make intangible overlays tangible.
1789 (mapcar (function (lambda (ov)
1790 (when (overlay-get ov 'intangible)
1791 (overlay-put ov 'intangible nil))))
1792 (overlays-in (point-min) (point-max)))
1795 (defun compilation-get-file-structure (file &optional fmt)
1796 "Retrieve FILE's file-structure or create a new one.
1797 FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME)."
1799 (or (gethash file compilation-locs)
1800 ;; File was not previously encountered, at least not in the form passed.
1801 ;; Let's normalize it and look again.
1802 (let ((filename (car file))
1803 (default-directory (if (cdr file)
1804 (file-truename (cdr file))
1805 default-directory)))
1807 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1808 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1810 (if (boundp 'comint-file-name-prefix)
1811 (if (file-name-absolute-p filename)
1813 (concat (with-no-warnings comint-file-name-prefix) filename))
1814 (setq default-directory
1816 (concat (with-no-warnings comint-file-name-prefix) default-directory)))))
1818 ;; If compilation-parse-errors-filename-function is
1819 ;; defined, use it to process the filename.
1820 (when compilation-parse-errors-filename-function
1822 (funcall compilation-parse-errors-filename-function
1825 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
1826 ;; file names like "./bar//foo.c" for file "bar/foo.c";
1827 ;; expand-file-name will collapse these into "/foo.c" and fail to find
1828 ;; the appropriate file. So we look for doubled slashes in the file
1829 ;; name and fix them.
1830 (setq filename (command-line-normalize-file-name filename))
1832 ;; Now eliminate any "..", because find-file would get them wrong.
1833 ;; Make relative and absolute filenames, with or without links, the
1836 (list (abbreviate-file-name
1837 (file-truename (if (cdr file)
1838 (expand-file-name filename)
1841 ;; Store it for the possibly unnormalized name
1843 ;; Retrieve or create file-structure for normalized name
1844 (or (gethash filename compilation-locs)
1845 (puthash filename (list filename fmt) compilation-locs))
1846 compilation-locs))))
1848 (add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$")
1850 ;;; Compatibility with the old compile.el.
1852 (defun compile-buffer-substring (n) (if n (match-string n)))
1854 (defun compilation-compat-error-properties (err)
1855 "Map old-style error ERR to new-style message."
1856 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
1857 ;; (MARKER . MARKER).
1858 (let ((dst (cdr err)))
1860 ;; Must start with a face, for font-lock.
1862 message ,(list (list nil nil nil dst) 2)
1863 help-echo "mouse-2: visit the source location"
1864 keymap compilation-button-map
1865 mouse-face highlight)
1866 ;; Too difficult to do it by hand: dispatch to the normal code.
1867 (let* ((file (pop dst))
1870 (filename (pop file))
1871 (dirname (pop file))
1873 (compilation-internal-error-properties
1874 (cons filename dirname) line nil col nil 2 fmt)))))
1876 (defun compilation-compat-parse-errors (limit)
1877 (when compilation-parse-errors-function
1878 ;; FIXME: We should remove the rest of the compilation keywords
1879 ;; but we can't do that from here because font-lock is using
1880 ;; the value right now. --stef
1882 (setq compilation-error-list nil)
1883 ;; Reset compilation-parsing-end each time because font-lock
1884 ;; might force us the re-parse many times (typically because
1885 ;; some code adds some text-property to the output that we
1886 ;; already parsed). You might say "why reparse", well:
1887 ;; because font-lock has just removed the `message' property so
1888 ;; have to do it all over again.
1889 (if compilation-parsing-end
1890 (set-marker compilation-parsing-end (point))
1891 (setq compilation-parsing-end (point-marker)))
1893 ;; Ignore any error: we're calling this function earlier than
1894 ;; in the old compile.el so things might not all be setup yet.
1895 (funcall compilation-parse-errors-function limit nil)
1897 (dolist (err (if (listp compilation-error-list) compilation-error-list))
1898 (let* ((src (car err))
1900 (loc (cond ((markerp dst) (list nil nil nil dst))
1902 (list (nth 2 dst) (nth 1 dst)
1903 (cons (cdar dst) (caar dst)))))))
1906 ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face)
1907 (put-text-property src (line-end-position)
1908 'message (list loc 2)))))))
1912 ;; Beware: this is not only compatiblity code. New code stil uses it. --Stef
1913 (defun compilation-forget-errors ()
1914 ;; In case we hit the same file/line specs, we want to recompute a new
1915 ;; marker for them, so flush our cache.
1916 (setq compilation-locs (make-hash-table :test 'equal :weakness 'value))
1917 (setq compilation-gcpro nil)
1918 ;; FIXME: the old code reset the directory-stack, so maybe we should
1919 ;; put a `directory change' marker of some sort, but where? -stef
1921 ;; FIXME: The old code moved compilation-current-error (which was
1922 ;; virtually represented by a mix of compilation-parsing-end and
1923 ;; compilation-error-list) to point-min, but that was only meaningful for
1924 ;; the internal uses of compilation-forget-errors: all calls from external
1925 ;; packages seem to be followed by a move of compilation-parsing-end to
1926 ;; something equivalent to point-max. So we speculatively move
1927 ;; compilation-current-error to point-max (since the external package
1928 ;; won't know that it should do it). --stef
1929 (setq compilation-current-error nil)
1930 (let* ((proc (get-buffer-process (current-buffer)))
1931 (mark (if proc (process-mark proc)))
1932 (pos (or mark (point-max))))
1933 (setq compilation-messages-start
1934 ;; In the future, ignore the text already present in the buffer.
1935 ;; Since many process filter functions insert before markers,
1936 ;; we need to put ours just before the insertion point rather
1937 ;; than at the insertion point. If that's not possible, then
1938 ;; don't use a marker. --Stef
1939 (if (> pos (point-min)) (copy-marker (1- pos)) pos))))
1942 (add-to-list 'auto-mode-alist '("\\.gcov\\'" . compilation-mode))
1946 ;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
1947 ;;; compile.el ends here