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:]*\\|{standard input}\\): ?\
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\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
246 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
247 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
251 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\)" 1 2)
254 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
255 \\([0-9]+\\) of file://\\(.+\\)"
259 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
260 [12][09][0-9][0-9] +\\(.*\\):$"
263 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
264 nil 3 nil (2) nil (1 (compilation-face '(2))))
265 (sparc-pascal-example
266 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
267 nil 1 nil (3) nil (2 (compilation-face '(3))))
270 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
271 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
275 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
278 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
279 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3)))
280 "Alist of values for `compilation-error-regexp-alist'.")
282 (defcustom compilation-error-regexp-alist
283 (mapcar 'car compilation-error-regexp-alist-alist)
284 "Alist that specifies how to match errors in compiler output.
285 Note that on Unix everything is a valid filename, so these
286 matchers must make some common sense assumptions, which catch
287 normal cases. A shorter list will be lighter on resource usage.
289 Instead of an alist element, you can use a symbol, which is
290 looked up in `compilation-error-regexp-alist-alist'. You can see
291 the predefined symbols and their effects in the file
292 `etc/compilation.txt' (linked below if you are customizing this).
294 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
295 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
296 gives the file name, and the LINE'th subexpression gives the line
297 number. The COLUMN'th subexpression gives the column number on
300 If FILE, LINE or COLUMN are nil or that index didn't match, that
301 information is not present on the matched line. In that case the
302 file name is assumed to be the same as the previous one in the
303 buffer, line number defaults to 1 and column defaults to
304 beginning of line's indentation.
306 FILE can also have the form (FILE FORMAT...), where the FORMATs
307 \(e.g. \"%s.c\") will be applied in turn to the recognized file
308 name, until a file of that name is found. Or FILE can also be a
309 function to return the filename.
311 LINE can also be of the form (LINE . END-LINE) meaning a range
312 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
313 meaning a range of columns starting on LINE and ending on
314 END-LINE, if that matched.
316 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
317 TYPE can also be of the form (WARNING . INFO). In that case this
318 will be equivalent to 1 if the WARNING'th subexpression matched
319 or else equivalent to 0 if the INFO'th subexpression matched.
320 See `compilation-error-face', `compilation-warning-face',
321 `compilation-info-face' and `compilation-skip-threshold'.
323 What matched the HYPERLINK'th subexpression has `mouse-face' and
324 `compilation-message-face' applied. If this is nil, the text
325 matched by the whole REGEXP becomes the hyperlink.
327 Additional HIGHLIGHTs as described under `font-lock-keywords' can
329 :type `(set :menu-tag "Pick"
330 ,@(mapcar (lambda (elt)
331 (list 'const (car elt)))
332 compilation-error-regexp-alist-alist))
333 :link `(file-link :tag "example file"
334 ,(expand-file-name "compilation.txt" data-directory))
337 (defvar compilation-directory nil
338 "Directory to restore to when doing `recompile'.")
340 (defvar compilation-directory-matcher
341 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
342 "A list for tracking when directories are entered or left.
343 Nil means not to track directories, e.g. if all file names are absolute. The
344 first element is the REGEXP matching these messages. It can match any number
345 of variants, e.g. different languages. The remaining elements are all of the
346 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
347 matches, that is a directory name. If LEAVE is nil or the corresponding
348 LEAVE'th subexpression doesn't match, this message is about going into another
349 directory. If it does match anything, this message is about going back to the
350 directory we were in before the last entering message. If you change this,
351 you may also want to change `compilation-page-delimiter'.")
353 (defvar compilation-page-delimiter
354 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
355 "Value of `page-delimiter' in Compilation mode.")
357 (defvar compilation-mode-font-lock-keywords
358 '(;; configure output lines.
359 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
360 (1 font-lock-variable-name-face)
361 (2 (compilation-face '(4 . 3))))
362 ;; Command output lines. Recognize `make[n]:' lines too.
363 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
364 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
365 (" --?o\\(?:utfile\\|utput\\)?[= ]?\\(\\S +\\)" . 1)
366 ("^Compilation finished" . compilation-info-face)
367 ("^Compilation exited abnormally" . compilation-error-face))
368 "Additional things to highlight in Compilation mode.
369 This gets tacked on the end of the generated expressions.")
371 (defvar compilation-highlight-regexp t
372 "Regexp matching part of visited source lines to highlight temporarily.
373 Highlight entire line if t; don't highlight source lines if nil.")
375 (defvar compilation-highlight-overlay nil
376 "Overlay used to temporarily highlight compilation matches.")
378 (defcustom compilation-error-screen-columns t
379 "*If non-nil, column numbers in error messages are screen columns.
380 Otherwise they are interpreted as character positions, with
381 each character occupying one column.
382 The default is to use screen columns, which requires that the compilation
383 program and Emacs agree about the display width of the characters,
384 especially the TAB character."
389 (defcustom compilation-read-command t
390 "*Non-nil means \\[compile] reads the compilation command to use.
391 Otherwise, \\[compile] just uses the value of `compile-command'."
396 (defcustom compilation-ask-about-save t
397 "*Non-nil means \\[compile] asks which buffers to save before compiling.
398 Otherwise, it saves all modified buffers without asking."
403 (defcustom compilation-search-path '(nil)
404 "*List of directories to search for source files named in error messages.
405 Elements should be directory names, not file names of directories.
406 nil as an element means to try the default directory."
407 :type '(repeat (choice (const :tag "Default" nil)
408 (string :tag "Directory")))
411 (defcustom compile-command "make -k "
412 "*Last shell command used to do a compilation; default for next compilation.
414 Sometimes it is useful for files to supply local values for this variable.
415 You might also use mode hooks to specify it in certain modes, like this:
417 (add-hook 'c-mode-hook
419 (unless (or (file-exists-p \"makefile\")
420 (file-exists-p \"Makefile\"))
421 (set (make-local-variable 'compile-command)
423 (file-name-sans-extension buffer-file-name))))))"
427 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
428 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
429 ;; key. This holds the tree seen from root, for storing new nodes.
430 (defvar compilation-locs ())
432 (defvar compilation-debug nil
433 "*Set this to t before creating a *compilation* buffer.
434 Then every error line will have a debug text property with the matcher that
435 fit this line and the match data. Use `describe-text-properties'.")
437 (defvar compilation-exit-message-function nil "\
438 If non-nil, called when a compilation process dies to return a status message.
439 This should be a function of three arguments: process status, exit status,
440 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
441 write into the compilation buffer, and to put in its mode line.")
443 (defvar compilation-environment nil
444 "*List of environment variables for compilation to inherit.
445 Each element should be a string of the form ENVVARNAME=VALUE.
446 This list is temporarily prepended to `process-environment' prior to
447 starting the compilation process.")
449 ;; History of compile commands.
450 (defvar compile-history nil)
452 (defface compilation-warning-face
453 '((((class color) (min-colors 16)) (:foreground "Orange" :weight bold))
454 (((class color)) (:foreground "cyan" :weight bold))
456 "Face used to highlight compiler warnings."
457 :group 'font-lock-highlighting-faces
460 (defface compilation-info-face
461 '((((class color) (min-colors 16) (background light))
462 (:foreground "Green3" :weight bold))
463 (((class color) (min-colors 16) (background dark))
464 (:foreground "Green" :weight bold))
465 (((class color)) (:foreground "green" :weight bold))
467 "Face used to highlight compiler warnings."
468 :group 'font-lock-highlighting-faces
471 (defvar compilation-message-face nil
472 "Face name to use for whole messages.
473 Faces `compilation-error-face', `compilation-warning-face',
474 `compilation-info-face', `compilation-line-face' and
475 `compilation-column-face' get prepended to this, when applicable.")
477 (defvar compilation-error-face 'font-lock-warning-face
478 "Face name to use for file name in error messages.")
480 (defvar compilation-warning-face 'compilation-warning-face
481 "Face name to use for file name in warning messages.")
483 (defvar compilation-info-face 'compilation-info-face
484 "Face name to use for file name in informational messages.")
486 (defvar compilation-line-face 'font-lock-variable-name-face
487 "Face name to use for line number in message.")
489 (defvar compilation-column-face 'font-lock-type-face
490 "Face name to use for column number in message.")
492 ;; same faces as dired uses
493 (defvar compilation-enter-directory-face 'font-lock-function-name-face
494 "Face name to use for column number in message.")
496 (defvar compilation-leave-directory-face 'font-lock-type-face
497 "Face name to use for column number in message.")
501 ;; Used for compatibility with the old compile.el.
502 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
503 (defvar compilation-parsing-end (make-marker))
504 (defvar compilation-parse-errors-function nil)
505 (defvar compilation-error-list nil)
506 (defvar compilation-old-error-list nil)
508 (defun compilation-face (type)
509 (or (and (car type) (match-end (car type)) compilation-warning-face)
510 (and (cdr type) (match-end (cdr type)) compilation-info-face)
511 compilation-error-face))
513 (defun compilation-directory-properties (idx leave)
514 (if leave (setq leave (match-end leave)))
515 ;; find previous stack, and push onto it, or if `leave' pop it
516 (let ((dir (previous-single-property-change (point) 'directory)))
517 (setq dir (if dir (or (get-text-property (1- dir) 'directory)
518 (get-text-property dir 'directory))))
520 compilation-leave-directory-face
521 compilation-enter-directory-face)
524 '(nil)) ; nil only isn't a property-change
525 (cons (match-string-no-properties idx) dir))
527 keymap compilation-button-map
528 help-echo "mouse-2: visit current directory")))
530 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
531 ;; KEY element from the ALIST, creating it in the right position if not already
532 ;; present. ALIST structure is
533 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
534 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
535 ;; may be nil. The other KEYs are ordered backwards so that growing line
536 ;; numbers can be inserted in front and searching can abort after half the
538 (eval-when-compile ;Don't keep it at runtime if not needed.
539 (defmacro compilation-assq (key alist)
542 (car (if (if (null ,key)
543 (if l2 (null (caar l2)))
544 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
547 (if l2 (eq ,key (caar l2))))
549 (setcdr l1 (cons (list ,key) l2)))))))
552 ;; This function is the central driver, called when font-locking to gather
553 ;; all information needed to later jump to corresponding source code.
554 ;; Return a property list with all meta information on this error location.
555 (defun compilation-error-properties (file line end-line col end-col type fmt)
556 (unless (< (next-single-property-change (match-beginning 0) 'directory nil (point))
560 (setq file (funcall file))
562 (setq file (match-string-no-properties file))
563 (unless (file-name-absolute-p file)
564 (setq dir (previous-single-property-change (point) 'directory)
565 dir (if dir (or (get-text-property (1- dir) 'directory)
566 (get-text-property dir 'directory)))))
567 (setq file (cons file (car dir)))))
568 ;; This message didn't mention one, get it from previous
569 (setq file (previous-single-property-change (point) 'message)
571 (car (nth 2 (car (or (get-text-property (1- file) 'message)
572 (get-text-property file 'message))))))
574 ;; All of these fields are optional, get them only if we have an index, and
575 ;; it matched some part of the message.
577 (setq line (match-string-no-properties line))
578 (setq line (string-to-number line)))
580 (setq end-line (match-string-no-properties end-line))
581 (setq end-line (string-to-number end-line)))
584 (setq col (funcall col))
586 (setq col (match-string-no-properties col))
587 (setq col (- (string-to-number col) compilation-first-column)))))
588 (if (and end-col (functionp end-col))
589 (setq end-col (funcall end-col))
590 (if (and end-col (setq end-col (match-string-no-properties end-col)))
591 (setq end-col (- (string-to-number end-col) compilation-first-column -1))
592 (if end-line (setq end-col -1))))
593 (if (consp type) ; not a static type, check what it is.
594 (setq type (or (and (car type) (match-end (car type)) 1)
595 (and (cdr type) (match-end (cdr type)) 0)
597 (compilation-internal-error-properties file line end-line col end-col type fmt)))
599 (defun compilation-internal-error-properties (file line end-line col end-col type fmt)
600 "Get the meta-info that will be added as text-properties.
601 LINE, END-LINE, COL, END-COL are integers or nil.
602 TYPE can be 0, 1, or 2.
603 FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil."
604 (unless file (setq file '("*unknown*")))
605 (setq file (compilation-get-file-structure file fmt))
606 ;; Get first already existing marker (if any has one, all have one).
607 ;; Do this first, as the compilation-assq`s may create new nodes.
608 (let* ((marker-line (car (cddr file))) ; a line structure
609 (marker (nth 3 (cadr marker-line))) ; its marker
610 (compilation-error-screen-columns compilation-error-screen-columns)
611 end-marker loc end-loc)
612 (if (not (and marker (marker-buffer marker)))
613 (setq marker) ; no valid marker for this file
614 (setq loc (or line 1)) ; normalize no linenumber to line 1
615 (catch 'marker ; find nearest loc, at least one exists
616 (dolist (x (nthcdr 3 file)) ; loop over remaining lines
617 (if (> (car x) loc) ; still bigger
619 (if (> (- (or (car marker-line) 1) loc)
620 (- loc (car x))) ; current line is nearer
621 (setq marker-line x))
623 (setq marker (nth 3 (cadr marker-line))
624 marker-line (or (car marker-line) 1))
625 (with-current-buffer (marker-buffer marker)
628 (goto-char (marker-position marker))
629 (when (or end-col end-line)
630 (beginning-of-line (- (or end-line line) marker-line -1))
633 (if compilation-error-screen-columns
634 (move-to-column end-col)
635 (forward-char end-col)))
636 (setq end-marker (list (point-marker))))
637 (beginning-of-line (if end-line
639 (- loc marker-line -1)))
641 (if compilation-error-screen-columns
644 (forward-to-indentation 0))
645 (setq marker (list (point-marker))))))
647 (setq loc (compilation-assq line (cdr file)))
649 (setq end-loc (compilation-assq end-line (cdr file))
650 end-loc (compilation-assq end-col end-loc))
651 (if end-col ; use same line element
652 (setq end-loc (compilation-assq end-col loc))))
653 (setq loc (compilation-assq col loc))
654 ;; If they are new, make the loc(s) reference the file they point to.
655 (or (cdr loc) (setcdr loc `(,line ,file ,@marker)))
657 (or (cdr end-loc) (setcdr end-loc `(,(or end-line line) ,file ,@end-marker))))
659 ;; Must start with face
660 `(face ,compilation-message-face
661 message (,loc ,type ,end-loc)
662 ,@(if compilation-debug
663 `(debug (,(assoc (with-no-warnings matcher) font-lock-keywords)
666 "mouse-2: visit this file, line and column"
668 "mouse-2: visit this file and line"
669 "mouse-2: visit this file"))
670 keymap compilation-button-map
671 mouse-face highlight)))
673 (defun compilation-mode-font-lock-keywords ()
674 "Return expressions to highlight in Compilation mode."
675 (if compilation-parse-errors-function
676 ;; An old package! Try the compatibility code.
677 '((compilation-compat-parse-errors))
679 ;; make directory tracking
680 (if compilation-directory-matcher
681 `((,(car compilation-directory-matcher)
682 ,@(mapcar (lambda (elt)
684 (compilation-directory-properties
685 ,(car elt) ,(cdr elt))
687 (cdr compilation-directory-matcher)))))
689 ;; Compiler warning/error lines.
693 (setq item (cdr (assq item
694 compilation-error-regexp-alist-alist))))
695 (let ((file (nth 1 item))
699 end-line end-col fmt)
700 (if (consp file) (setq fmt (cdr file) file (car file)))
701 (if (consp line) (setq end-line (cdr line) line (car line)))
702 (if (consp col) (setq end-col (cdr col) col (car col)))
705 ;; The old compile.el had here an undocumented hook that
706 ;; allowed `line' to be a function that computed the actual
707 ;; error location. Let's do our best.
709 (0 (compilation-compat-error-properties
710 (funcall ',line (cons (match-string ,file)
711 (cons default-directory
713 ,(if col `(match-string ,col)))))
714 (,file compilation-error-face t))
716 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
717 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
721 ,@(when (integerp file)
722 `((,file ,(if (consp type)
723 `(compilation-face ',type)
724 (aref [compilation-info-face
725 compilation-warning-face
726 compilation-error-face]
730 `((,line compilation-line-face nil t)))
732 `((,end-line compilation-line-face nil t)))
734 ,@(when (integerp col)
735 `((,col compilation-column-face nil t)))
736 ,@(when (integerp end-col)
737 `((,end-col compilation-column-face nil t)))
740 (,(or (nth 5 item) 0)
741 (compilation-error-properties ',file ,line ,end-line
742 ,col ,end-col ',(or type 2)
744 append))))) ; for compilation-message-face
745 compilation-error-regexp-alist)
747 compilation-mode-font-lock-keywords)))
751 (defun compile (command &optional comint)
752 "Compile the program including the current buffer. Default: run `make'.
753 Runs COMMAND, a shell command, in a separate process asynchronously
754 with output going to the buffer `*compilation*'.
756 If optional second arg COMINT is t the buffer will be in Comint mode with
757 `compilation-shell-minor-mode'.
759 You can then use the command \\[next-error] to find the next error message
760 and move to the source code that caused it.
762 Interactively, prompts for the command if `compilation-read-command' is
763 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
764 Additionally, with universal prefix arg, compilation buffer will be in
765 comint mode, i.e. interactive.
767 To run more than one compilation at once, start one and rename
768 the \`*compilation*' buffer to some other name with
769 \\[rename-buffer]. Then start the next one. On most systems,
770 termination of the main compilation process kills its
773 The name used for the buffer is actually whatever is returned by
774 the function in `compilation-buffer-name-function', so you can set that
775 to a function that generates a unique name."
778 (if (or compilation-read-command current-prefix-arg)
779 (read-from-minibuffer "Compile command: "
780 (eval compile-command) nil nil
781 '(compile-history . 1))
782 (eval compile-command))
783 (consp current-prefix-arg)))
784 (unless (equal command (eval compile-command))
785 (setq compile-command command))
786 (save-some-buffers (not compilation-ask-about-save) nil)
787 (setq compilation-directory default-directory)
788 (compilation-start command comint))
790 ;; run compile with the default command line
792 "Re-compile the program including the current buffer.
793 If this is run in a Compilation mode buffer, re-use the arguments from the
794 original use. Otherwise, recompile using `compile-command'."
796 (save-some-buffers (not compilation-ask-about-save) nil)
797 (let ((default-directory
798 (or (and (not (eq major-mode (nth 1 compilation-arguments)))
799 compilation-directory)
801 (apply 'compilation-start (or compilation-arguments
802 `(,(eval compile-command))))))
804 (defcustom compilation-scroll-output nil
805 "*Non-nil to scroll the *compilation* buffer window as output appears.
807 Setting it causes the Compilation mode commands to put point at the
808 end of their output window so that the end of the output is always
809 visible rather than the beginning."
815 (defun compilation-buffer-name (mode-name name-function)
816 "Return the name of a compilation buffer to use.
817 If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
818 to determine the buffer name.
819 Likewise if `compilation-buffer-name-function' is non-nil.
820 If current buffer is in Compilation mode for the same mode name
821 return the name of the current buffer, so that it gets reused.
822 Otherwise, construct a buffer name from MODE-NAME."
824 (funcall name-function mode-name))
825 (compilation-buffer-name-function
826 (funcall compilation-buffer-name-function mode-name))
827 ((eq major-mode (nth 1 compilation-arguments))
830 (concat "*" (downcase mode-name) "*"))))
832 ;; This is a rough emulation of the old hack, until the transition to new
833 ;; compile is complete.
834 (defun compile-internal (command error-message
835 &optional name-of-mode parser
836 error-regexp-alist name-function
837 enter-regexp-alist leave-regexp-alist
838 file-regexp-alist nomessage-regexp-alist
839 no-async highlight-regexp local-map)
841 (error "Compile now works very differently, see `compilation-error-regexp-alist'"))
842 (let ((compilation-error-regexp-alist
843 (append file-regexp-alist (or error-regexp-alist
844 compilation-error-regexp-alist)))
845 (compilation-error (replace-regexp-in-string "^No more \\(.+\\)s\\.?"
846 "\\1" error-message)))
847 (compilation-start command nil name-function highlight-regexp)))
848 (make-obsolete 'compile-internal 'compilation-start)
850 (defun compilation-start (command &optional mode name-function highlight-regexp)
851 "Run compilation command COMMAND (low level interface).
852 If COMMAND starts with a cd command, that becomes the `default-directory'.
853 The rest of the arguments are optional; for them, nil means use the default.
855 MODE is the major mode to set in the compilation buffer. Mode
856 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
857 NAME-FUNCTION is a function called to name the buffer.
859 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
860 the matching section of the visited source line; the default is to use the
861 global value of `compilation-highlight-regexp'.
863 Returns the compilation buffer created."
864 (or mode (setq mode 'compilation-mode))
867 (prog1 "compilation" (require 'comint))
868 (replace-regexp-in-string "-mode$" "" (symbol-name mode))))
869 (thisdir default-directory)
874 (compilation-buffer-name name-of-mode name-function)))
875 (let ((comp-proc (get-buffer-process (current-buffer))))
877 (if (or (not (eq (process-status comp-proc) 'run))
879 (format "A %s process is running; kill it? "
883 (interrupt-process comp-proc)
885 (delete-process comp-proc))
887 (error "Cannot have two processes in `%s' at once"
889 (buffer-disable-undo (current-buffer))
890 ;; first transfer directory from where M-x compile was called
891 (setq default-directory thisdir)
892 ;; Make compilation buffer read-only. The filter can still write it.
893 ;; Clear out the compilation buffer.
894 (let ((inhibit-read-only t)
895 (default-directory thisdir))
896 ;; Then evaluate a cd command if any, but don't perform it yet, else start-command
897 ;; would do it again through the shell: (cd "..") AND sh -c "cd ..; make"
898 (cd (if (string-match "^\\s *cd\\(?:\\s +\\(\\S +?\\)\\)?\\s *[;&\n]" command)
900 (match-string 1 command)
904 ;; output a mode setter, for saving and later reloading this buffer
905 (insert "-*- mode: " name-of-mode
906 "; default-directory: " (prin1-to-string default-directory)
907 " -*-\n" command "\n")
908 (setq thisdir default-directory))
909 (set-buffer-modified-p nil))
910 ;; If we're already in the compilation buffer, go to the end
911 ;; of the buffer, so point will track the compilation output.
912 (if (eq outbuf (current-buffer))
913 (goto-char (point-max)))
914 ;; Pop up the compilation buffer.
915 (setq outwin (display-buffer outbuf nil t))
916 (with-current-buffer outbuf
917 (let ((process-environment
919 compilation-environment
920 (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning
921 system-uses-terminfo)
922 (list "TERM=dumb" "TERMCAP="
923 (format "COLUMNS=%d" (window-width)))
925 (format "TERMCAP=emacs:co#%d:tc=unknown:"
927 ;; Set the EMACS variable, but
928 ;; don't override users' setting of $EMACS.
929 (unless (getenv "EMACS") '("EMACS=t"))
930 (copy-sequence process-environment))))
931 (if (not (eq mode t))
933 (setq buffer-read-only nil)
934 (with-no-warnings (comint-mode))
935 (compilation-shell-minor-mode))
937 (set (make-local-variable 'compilation-highlight-regexp)
939 (set (make-local-variable 'compilation-arguments)
940 (list command mode name-function highlight-regexp))
941 (set (make-local-variable 'revert-buffer-function)
942 'compilation-revert-buffer)
943 (set-window-start outwin (point-min))
944 (or (eq outwin (selected-window))
945 (set-window-point outwin (if compilation-scroll-output
948 ;; The setup function is called before compilation-set-window-height
949 ;; so it can set the compilation-window-height buffer locally.
950 (if compilation-process-setup-function
951 (funcall compilation-process-setup-function))
952 (compilation-set-window-height outwin)
953 ;; Start the compilation.
954 (if (fboundp 'start-process)
955 (let ((proc (if (eq mode t)
958 (comint-exec outbuf (downcase mode-name)
959 shell-file-name nil `("-c" ,command))))
960 (start-process-shell-command (downcase mode-name)
962 ;; Make the buffer's mode line show process state.
963 (setq mode-line-process '(":%s"))
964 (set-process-sentinel proc 'compilation-sentinel)
965 (set-process-filter proc 'compilation-filter)
966 (set-marker (process-mark proc) (point) outbuf)
967 (setq compilation-in-progress
968 (cons proc compilation-in-progress)))
969 ;; No asynchronous processes available.
970 (message "Executing `%s'..." command)
971 ;; Fake modeline display as if `start-process' were run.
972 (setq mode-line-process ":run")
973 (force-mode-line-update)
974 (sit-for 0) ; Force redisplay
975 (let ((status (call-process shell-file-name nil outbuf nil "-c"
977 (cond ((numberp status)
978 (compilation-handle-exit 'exit status
982 exited abnormally with code %d\n"
985 (compilation-handle-exit 'signal status
986 (concat status "\n")))
988 (compilation-handle-exit 'bizarre status status))))
989 ;; Without async subprocesses, the buffer is not yet
990 ;; fontified, so fontify it now.
991 (let ((font-lock-verbose nil)) ; shut up font-lock messages
992 (font-lock-fontify-buffer))
993 (message "Executing `%s'...done" command)))
994 ;; Now finally cd to where the shell started make/grep/...
995 (setq default-directory thisdir))
996 (if (buffer-local-value 'compilation-scroll-output outbuf)
997 (save-selected-window
998 (select-window outwin)
999 (goto-char (point-max))))
1000 ;; Make it so the next C-x ` will use this buffer.
1001 (setq next-error-last-buffer outbuf)))
1003 (defun compilation-set-window-height (window)
1004 "Set the height of WINDOW according to `compilation-window-height'."
1005 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1007 (= (window-width window) (frame-width (window-frame window)))
1008 ;; If window is alone in its frame, aside from a minibuffer,
1009 ;; don't change its height.
1010 (not (eq window (frame-root-window (window-frame window))))
1011 ;; Stef said that doing the saves in this order is safer:
1013 (save-selected-window
1014 (select-window window)
1015 (enlarge-window (- height (window-height))))))))
1017 (defvar compilation-menu-map
1018 (let ((map (make-sparse-keymap "Errors")))
1019 (define-key map [stop-subjob]
1020 '("Stop Compilation" . kill-compilation))
1021 (define-key map [compilation-mode-separator2]
1023 (define-key map [compilation-first-error]
1024 '("First Error" . first-error))
1025 (define-key map [compilation-previous-error]
1026 '("Previous Error" . previous-error))
1027 (define-key map [compilation-next-error]
1028 '("Next Error" . next-error))
1031 (defvar compilation-minor-mode-map
1032 (let ((map (make-sparse-keymap)))
1033 (define-key map [mouse-2] 'compile-goto-error)
1034 (define-key map "\C-c\C-c" 'compile-goto-error)
1035 (define-key map "\C-m" 'compile-goto-error)
1036 (define-key map "\C-c\C-k" 'kill-compilation)
1037 (define-key map "\M-n" 'compilation-next-error)
1038 (define-key map "\M-p" 'compilation-previous-error)
1039 (define-key map "\M-{" 'compilation-previous-file)
1040 (define-key map "\M-}" 'compilation-next-file)
1041 ;; Set up the menu-bar
1042 (define-key map [menu-bar compilation]
1043 (cons "Errors" compilation-menu-map))
1045 "Keymap for `compilation-minor-mode'.")
1047 (defvar compilation-shell-minor-mode-map
1048 (let ((map (make-sparse-keymap)))
1049 (define-key map "\M-\C-m" 'compile-goto-error)
1050 (define-key map "\M-\C-n" 'compilation-next-error)
1051 (define-key map "\M-\C-p" 'compilation-previous-error)
1052 (define-key map "\M-{" 'compilation-previous-file)
1053 (define-key map "\M-}" 'compilation-next-file)
1054 ;; Set up the menu-bar
1055 (define-key map [menu-bar compilation]
1056 (cons "Errors" compilation-menu-map))
1058 "Keymap for `compilation-shell-minor-mode'.")
1060 (defvar compilation-button-map
1061 (let ((map (make-sparse-keymap)))
1062 (define-key map [mouse-2] 'compile-goto-error)
1063 (define-key map "\C-m" 'compile-goto-error)
1065 "Keymap for compilation-message buttons.")
1066 (fset 'compilation-button-map compilation-button-map)
1068 (defvar compilation-mode-map
1069 (let ((map (make-sparse-keymap)))
1070 (set-keymap-parent map compilation-minor-mode-map)
1071 (define-key map " " 'scroll-up)
1072 (define-key map "\^?" 'scroll-down)
1073 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1075 ;; Set up the menu-bar
1076 (define-key map [menu-bar compilation]
1077 (cons "Compile" (make-sparse-keymap "Compile")))
1078 (define-key map [menu-bar compilation compilation-separator2]
1080 (define-key map [menu-bar compilation compilation-grep]
1081 '("Search Files (grep)" . grep))
1082 (define-key map [menu-bar compilation compilation-recompile]
1083 '("Recompile" . recompile))
1084 (define-key map [menu-bar compilation compilation-compile]
1085 '("Compile..." . compile))
1087 "Keymap for compilation log buffers.
1088 `compilation-minor-mode-map' is a parent of this.")
1090 (put 'compilation-mode 'mode-class 'special)
1092 (defvar compilation-skip-to-next-location t
1093 "*If non-nil, skip multiple error messages for the same source location.")
1095 (defcustom compilation-skip-threshold 1
1096 "*Compilation motion commands skip less important messages.
1097 The value can be either 2 -- skip anything less than error, 1 --
1098 skip anything less than warning or 0 -- don't skip any messages.
1099 Note that all messages not positively identified as warning or
1100 info, are considered errors."
1101 :type '(choice (const :tag "Warnings and info" 2)
1102 (const :tag "Info" 1)
1103 (const :tag "None" 0))
1107 (defcustom compilation-skip-visited nil
1108 "*Compilation motion commands skip visited messages if this is t.
1109 Visited messages are ones for which the file, line and column have been jumped
1110 to from the current content in the current compilation buffer, even if it was
1111 from a different message."
1117 (defun compilation-mode (&optional name-of-mode)
1118 "Major mode for compilation log buffers.
1119 \\<compilation-mode-map>To visit the source for a line-numbered error,
1120 move point to the error message line and type \\[compile-goto-error].
1121 To kill the compilation, type \\[kill-compilation].
1123 Runs `compilation-mode-hook' with `run-hooks' (which see).
1125 \\{compilation-mode-map}"
1127 (kill-all-local-variables)
1128 (use-local-map compilation-mode-map)
1129 (setq major-mode 'compilation-mode
1130 mode-name (or name-of-mode "Compilation"))
1131 (set (make-local-variable 'page-delimiter)
1132 compilation-page-delimiter)
1134 (run-mode-hooks 'compilation-mode-hook))
1136 (defmacro define-compilation-mode (mode name doc &rest body)
1137 "This is like `define-derived-mode' without the PARENT argument.
1138 The parent is always `compilation-mode' and the customizable `compilation-...'
1139 variables are also set from the name of the mode you have chosen, by replacing
1140 the fist word, e.g `compilation-scroll-output' from `grep-scroll-output' if that
1142 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1143 `(define-derived-mode ,mode compilation-mode ,name
1145 ,@(mapcar (lambda (v)
1147 (intern-soft (replace-regexp-in-string
1148 "^compilation" mode-name
1151 (or (boundp (cdr v))
1152 (if (boundp 'byte-compile-bound-variables)
1153 (memq (cdr v) byte-compile-bound-variables)))
1154 `(set (make-local-variable ',(car v)) ,(cdr v))))
1155 '(compilation-buffer-name-function
1156 compilation-directory-matcher
1158 compilation-error-regexp-alist
1159 compilation-error-regexp-alist-alist
1160 compilation-error-screen-columns
1161 compilation-finish-function
1162 compilation-finish-functions
1163 compilation-first-column
1164 compilation-mode-font-lock-keywords
1165 compilation-page-delimiter
1166 compilation-parse-errors-filename-function
1167 compilation-process-setup-function
1168 compilation-scroll-output
1169 compilation-search-path
1170 compilation-skip-threshold
1171 compilation-window-height))
1174 (defun compilation-revert-buffer (ignore-auto noconfirm)
1175 (if buffer-file-name
1176 (let (revert-buffer-function)
1177 (revert-buffer ignore-auto noconfirm))
1178 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1179 (apply 'compilation-start compilation-arguments))))
1181 (defvar compilation-current-error nil
1182 "Marker to the location from where the next error will be found.
1183 The global commands next/previous/first-error/goto-error use this.")
1185 (defvar compilation-messages-start nil
1186 "Buffer position of the beginning of the compilation messages.
1187 If nil, use the beginning of buffer.")
1189 ;; A function name can't be a hook, must be something with a value.
1190 (defconst compilation-turn-on-font-lock 'turn-on-font-lock)
1192 (defun compilation-setup (&optional minor)
1193 "Prepare the buffer for the compilation parsing commands to work.
1194 Optional argument MINOR indicates this is called from
1195 `compilation-minor-mode'."
1197 (setq buffer-read-only t))
1198 (make-local-variable 'compilation-current-error)
1199 (make-local-variable 'compilation-messages-start)
1200 (make-local-variable 'compilation-error-screen-columns)
1201 (make-local-variable 'overlay-arrow-position)
1202 ;; Note that compilation-next-error-function is for interfacing
1203 ;; with the next-error function in simple.el, and it's only
1204 ;; coincidentally named similarly to compilation-next-error.
1205 (setq next-error-function 'compilation-next-error-function)
1206 (set (make-local-variable 'font-lock-extra-managed-props)
1207 '(directory message help-echo mouse-face debug))
1208 (set (make-local-variable 'compilation-locs)
1209 (make-hash-table :test 'equal :weakness 'value))
1210 ;; lazy-lock would never find the message unless it's scrolled to.
1211 ;; jit-lock might fontify some things too late.
1212 (set (make-local-variable 'font-lock-support-mode) nil)
1213 (set (make-local-variable 'font-lock-maximum-size) nil)
1214 (let ((fld font-lock-defaults))
1216 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1217 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t)))
1221 (font-lock-fontify-buffer)
1222 (font-lock-change-mode)
1223 (turn-on-font-lock))
1224 (turn-on-font-lock))
1225 ;; maybe defer font-lock till after derived mode is set up
1226 (run-mode-hooks 'compilation-turn-on-font-lock))))
1229 (define-minor-mode compilation-shell-minor-mode
1230 "Toggle compilation shell minor mode.
1231 With arg, turn compilation mode on if and only if arg is positive.
1232 In this minor mode, all the error-parsing commands of the
1233 Compilation major mode are available but bound to keys that don't
1234 collide with Shell mode. See `compilation-mode'.
1235 Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
1236 nil " Shell-Compile"
1238 (if compilation-shell-minor-mode
1239 (compilation-setup t)
1240 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1241 (font-lock-fontify-buffer)))
1244 (define-minor-mode compilation-minor-mode
1245 "Toggle compilation minor mode.
1246 With arg, turn compilation mode on if and only if arg is positive.
1247 In this minor mode, all the error-parsing commands of the
1248 Compilation major mode are available. See `compilation-mode'.
1249 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
1252 (if compilation-minor-mode
1253 (compilation-setup t)
1254 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1255 (font-lock-fontify-buffer)))
1257 (defun compilation-handle-exit (process-status exit-status msg)
1258 "Write MSG in the current buffer and hack its mode-line-process."
1259 (let ((inhibit-read-only t)
1260 (status (if compilation-exit-message-function
1261 (funcall compilation-exit-message-function
1262 process-status exit-status msg)
1263 (cons msg exit-status)))
1266 ;; Record where we put the message, so we can ignore it later on.
1268 (insert ?\n mode-name " " (car status))
1269 (if (and (numberp compilation-window-height)
1270 (zerop compilation-window-height))
1271 (message "%s" (cdr status)))
1274 (insert " at " (substring (current-time-string) 0 19))
1275 (goto-char (point-max))
1276 ;; Prevent that message from being recognized as a compilation error.
1277 (add-text-properties omax (point)
1278 (append '(compilation-handle-exit t) nil))
1279 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
1280 ;; Force mode line redisplay soon.
1281 (force-mode-line-update)
1282 (if (and opoint (< opoint omax))
1284 (if compilation-finish-function
1285 (funcall compilation-finish-function (current-buffer) msg))
1286 (let ((functions compilation-finish-functions))
1288 (funcall (car functions) (current-buffer) msg)
1289 (setq functions (cdr functions))))))
1291 ;; Called when compilation process changes state.
1292 (defun compilation-sentinel (proc msg)
1293 "Sentinel for compilation buffers."
1294 (if (memq (process-status proc) '(exit signal))
1295 (let ((buffer (process-buffer proc)))
1296 (if (null (buffer-name buffer))
1298 (set-process-buffer proc nil)
1299 (with-current-buffer buffer
1300 ;; Write something in the compilation buffer
1301 ;; and hack its mode line.
1302 (compilation-handle-exit (process-status proc)
1303 (process-exit-status proc)
1305 ;; Since the buffer and mode line will show that the
1306 ;; process is dead, we can delete it now. Otherwise it
1307 ;; will stay around until M-x list-processes.
1308 (delete-process proc)))
1309 (setq compilation-in-progress (delq proc compilation-in-progress)))))
1311 (defun compilation-filter (proc string)
1312 "Process filter for compilation buffers.
1313 Just inserts the text, but uses `insert-before-markers'."
1314 (if (buffer-name (process-buffer proc))
1315 (with-current-buffer (process-buffer proc)
1316 (let ((inhibit-read-only t))
1318 (goto-char (process-mark proc))
1319 (insert-before-markers string)
1320 (run-hooks 'compilation-filter-hook))))))
1322 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
1323 (defsubst compilation-buffer-internal-p ()
1324 "Test if inside a compilation buffer."
1325 (local-variable-p 'compilation-locs))
1327 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
1328 (defsubst compilation-buffer-p (buffer)
1329 "Test if BUFFER is a compilation buffer."
1330 (with-current-buffer buffer
1331 (compilation-buffer-internal-p)))
1333 (defmacro compilation-loop (< property-change 1+ error)
1335 (or (setq pt (,property-change pt 'message))
1336 (error ,error compilation-error))
1337 ;; prop 'message usually has 2 changes, on and off, so re-search if off
1338 (or (setq msg (get-text-property pt 'message))
1339 (if (setq pt (,property-change pt 'message))
1340 (setq msg (get-text-property pt 'message)))
1341 (error ,error compilation-error))
1342 (or (< (cadr msg) compilation-skip-threshold)
1344 (eq (prog1 last (setq last (nth 2 (car msg))))
1346 (if compilation-skip-visited
1347 (nthcdr 4 (car msg)))
1348 (if compilation-skip-to-next-location
1350 ;; count this message only if none of the above are true
1353 (defun compilation-next-error (n &optional different-file pt)
1354 "Move point to the next error in the compilation buffer.
1355 Prefix arg N says how many error messages to move forwards (or
1356 backwards, if negative).
1357 Does NOT find the source line like \\[next-error]."
1359 (or (compilation-buffer-p (current-buffer))
1360 (error "Not in a compilation buffer"))
1361 (or pt (setq pt (point)))
1362 (let* ((msg (get-text-property pt 'message))
1366 (unless (or msg ; find message near here
1367 (setq msg (get-text-property (max (1- pt) (point-min))
1369 (setq pt (previous-single-property-change pt 'message nil
1370 (line-beginning-position)))
1371 (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message))
1372 (setq pt (next-single-property-change pt 'message nil
1373 (line-end-position)))
1374 (or (setq msg (get-text-property pt 'message))
1375 (setq pt (point)))))
1376 (setq last (nth 2 (car msg)))
1378 (compilation-loop > next-single-property-change 1-
1379 (if (get-buffer-process (current-buffer))
1381 "Moved past last %s"))
1382 ;; Don't move "back" to message at or before point.
1383 ;; Pass an explicit (point-min) to make sure pt is non-nil.
1384 (setq pt (previous-single-property-change pt 'message nil (point-min)))
1385 (compilation-loop < previous-single-property-change 1+
1386 "Moved back before first %s")))
1389 (error "No %s here" compilation-error))))
1391 (defun compilation-previous-error (n)
1392 "Move point to the previous error in the compilation buffer.
1393 Prefix arg N says how many error messages to move backwards (or
1394 forwards, if negative).
1395 Does NOT find the source line like \\[previous-error]."
1397 (compilation-next-error (- n)))
1399 (defun compilation-next-file (n)
1400 "Move point to the next error for a different file than the current one.
1401 Prefix arg N says how many files to move forwards (or backwards, if negative)."
1403 (compilation-next-error n t))
1405 (defun compilation-previous-file (n)
1406 "Move point to the previous error for a different file than the current one.
1407 Prefix arg N says how many files to move backwards (or forwards, if negative)."
1409 (compilation-next-file (- n)))
1411 (defun kill-compilation ()
1412 "Kill the process made by the \\[compile] or \\[grep] commands."
1414 (let ((buffer (compilation-find-buffer)))
1415 (if (get-buffer-process buffer)
1416 (interrupt-process (get-buffer-process buffer))
1417 (error "The compilation process is not running"))))
1419 (defalias 'compile-mouse-goto-error 'compile-goto-error)
1421 (defun compile-goto-error (&optional event)
1422 "Visit the source for the error message at point.
1423 Use this command in a compilation log buffer. Sets the mark at point there."
1424 (interactive (list last-input-event))
1425 (if event (posn-set-point (event-end event)))
1426 (or (compilation-buffer-p (current-buffer))
1427 (error "Not in a compilation buffer"))
1428 (if (get-text-property (point) 'directory)
1429 (dired-other-window (car (get-text-property (point) 'directory)))
1431 (setq compilation-current-error (point))
1434 ;; Return a compilation buffer.
1435 ;; If the current buffer is a compilation buffer, return it.
1436 ;; Otherwise, look for a compilation buffer and signal an error
1437 ;; if there are none.
1438 (defun compilation-find-buffer (&optional other-buffer)
1439 (next-error-find-buffer other-buffer 'compilation-buffer-internal-p))
1442 (defun compilation-next-error-function (n &optional reset)
1444 (set-buffer (compilation-find-buffer))
1446 (setq compilation-current-error nil))
1447 (let* ((columns compilation-error-screen-columns) ; buffer's local value
1449 (loc (compilation-next-error (or n 1) nil
1450 (or compilation-current-error
1451 compilation-messages-start
1453 (end-loc (nth 2 loc))
1454 (marker (point-marker)))
1455 (setq compilation-current-error (point-marker)
1456 overlay-arrow-position
1458 compilation-current-error
1459 (copy-marker (line-beginning-position)))
1461 ;; If loc contains no marker, no error in that file has been visited. If
1462 ;; the marker is invalid the buffer has been killed. So, recalculate all
1463 ;; markers for that file.
1464 (unless (and (nth 3 loc) (marker-buffer (nth 3 loc)))
1465 (with-current-buffer (compilation-find-file marker (caar (nth 2 loc))
1466 (or (cdar (nth 2 loc))
1470 (goto-char (point-min))
1471 ;; Treat file's found lines in forward order, 1 by 1.
1472 (dolist (line (reverse (cddr (nth 2 loc))))
1473 (when (car line) ; else this is a filename w/o a line#
1474 (beginning-of-line (- (car line) last -1))
1475 (setq last (car line)))
1476 ;; Treat line's found columns and store/update a marker for each.
1477 (dolist (col (cdr line))
1479 (if (eq (car col) -1) ; special case for range end
1482 (move-to-column (car col))
1484 (forward-char (car col))))
1486 (skip-chars-forward " \t"))
1488 (set-marker (nth 3 col) (point))
1489 (setcdr (nthcdr 2 col) `(,(point-marker)))))))))
1490 (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc))
1491 (setcdr (nthcdr 3 loc) t))) ; Set this one as visited.
1493 (defvar compilation-gcpro nil
1494 "Internal variable used to keep some values from being GC'd.")
1495 (make-variable-buffer-local 'compilation-gcpro)
1497 (defun compilation-fake-loc (marker file &optional line col)
1498 "Preassociate MARKER with FILE.
1499 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
1500 This is useful when you compile temporary files, but want
1501 automatic translation of the messages to the real buffer from
1502 which the temporary file came. This only works if done before a
1503 message about FILE appears!
1505 Optional args LINE and COL default to 1 and beginning of
1506 indentation respectively. The marker is expected to reflect
1507 this. In the simplest case the marker points to the first line
1508 of the region that was saved to the temp file.
1510 If you concatenate several regions into the temp file (e.g. a
1511 header with variable assignments and a code region), you must
1512 call this several times, once each for the last line of one
1513 region and the first line of the next region."
1514 (or (consp file) (setq file (list file)))
1515 (setq file (compilation-get-file-structure file))
1516 ;; Between the current call to compilation-fake-loc and the first occurrence
1517 ;; of an error message referring to `file', the data is only kept is the
1518 ;; weak hash-table compilation-locs, so we need to prevent this entry
1519 ;; in compilation-locs from being GC'd away. --Stef
1520 (push file compilation-gcpro)
1521 (let ((loc (compilation-assq (or line 1) (cdr file))))
1522 (setq loc (compilation-assq col loc))
1524 (setcdr (cddr loc) (list marker))
1525 (setcdr loc (list line file marker)))
1528 (defcustom compilation-context-lines 0
1529 "*Display this many lines of leading context before message.
1530 If nil, don't scroll the compilation output window."
1531 :type '(choice integer (const :tag "No window scrolling" nil))
1535 (defsubst compilation-set-window (w mk)
1536 "Align the compilation output window W with marker MK near top."
1537 (if (integerp compilation-context-lines)
1538 (set-window-start w (save-excursion
1540 (beginning-of-line (- 1 compilation-context-lines))
1542 (set-window-point w mk))
1544 (defun compilation-goto-locus (msg mk end-mk)
1545 "Jump to an error corresponding to MSG at MK.
1546 All arguments are markers. If END-MK is non-nil, mark is set there
1547 and overlay is highlighted between MK and END-MK."
1548 (if (eq (window-buffer (selected-window))
1549 (marker-buffer msg))
1550 ;; If the compilation buffer window is selected,
1551 ;; keep the compilation buffer in this window;
1552 ;; display the source in another window.
1553 (let ((pop-up-windows t))
1554 (pop-to-buffer (marker-buffer mk)))
1555 (if (window-dedicated-p (selected-window))
1556 (pop-to-buffer (marker-buffer mk))
1557 (switch-to-buffer (marker-buffer mk))))
1558 ;; If narrowing gets in the way of going to the right place, widen.
1559 (unless (eq (goto-char mk) (point))
1563 (push-mark end-mk t)
1564 (if mark-active (setq mark-active)))
1565 ;; If hideshow got in the way of
1566 ;; seeing the right place, open permanently.
1567 (dolist (ov (overlays-at (point)))
1568 (when (eq 'hs (overlay-get ov 'invisible))
1572 ;; Show compilation buffer in other window, scrolled to this error.
1573 (let* ((pop-up-windows t)
1574 ;; Use an existing window if it is in a visible frame.
1575 (w (or (get-buffer-window (marker-buffer msg) 'visible)
1577 (display-buffer (marker-buffer msg))))
1578 (highlight-regexp (with-current-buffer (marker-buffer msg)
1579 ;; also do this while we change buffer
1580 (compilation-set-window w msg)
1581 compilation-highlight-regexp)))
1582 (compilation-set-window-height w)
1584 (when highlight-regexp
1585 (unless compilation-highlight-overlay
1586 (setq compilation-highlight-overlay
1587 (make-overlay (point-min) (point-min)))
1588 (overlay-put compilation-highlight-overlay 'face 'next-error))
1589 (with-current-buffer (marker-buffer mk)
1591 (if end-mk (goto-char end-mk) (end-of-line))
1592 (let ((end (point)))
1593 (if mk (goto-char mk) (beginning-of-line))
1594 (if (and (stringp highlight-regexp)
1595 (re-search-forward highlight-regexp end t))
1597 (goto-char (match-beginning 0))
1598 (move-overlay compilation-highlight-overlay
1599 (match-beginning 0) (match-end 0)
1601 (move-overlay compilation-highlight-overlay
1602 (point) end (current-buffer)))
1603 (if (numberp next-error-highlight)
1604 (sit-for next-error-highlight))
1605 (if (not (eq next-error-highlight t))
1606 (delete-overlay compilation-highlight-overlay))))))
1607 (when (and (eq next-error-highlight 'fringe-arrow))
1608 (set (make-local-variable 'overlay-arrow-position)
1609 (copy-marker (line-beginning-position))))))
1611 (defun compilation-find-file (marker filename dir &rest formats)
1612 "Find a buffer for file FILENAME.
1613 Search the directories in `compilation-search-path'.
1614 A nil in `compilation-search-path' means to try the
1615 current directory, which is passed in DIR.
1616 If FILENAME is not found at all, ask the user where to find it.
1617 Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
1618 (or formats (setq formats '("%s")))
1620 (let ((dirs compilation-search-path)
1621 buffer thisdir fmts name)
1622 (if (file-name-absolute-p filename)
1623 ;; The file name is absolute. Use its explicit directory as
1624 ;; the first in the search path, and strip it from FILENAME.
1625 (setq filename (abbreviate-file-name (expand-file-name filename))
1626 dirs (cons (file-name-directory filename) dirs)
1627 filename (file-name-nondirectory filename)))
1628 ;; Now search the path.
1629 (while (and dirs (null buffer))
1630 (setq thisdir (or (car dirs) dir)
1632 ;; For each directory, try each format string.
1633 (while (and fmts (null buffer))
1634 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1635 buffer (and (file-exists-p name)
1636 (find-file-noselect name))
1638 (setq dirs (cdr dirs)))
1640 ;; The file doesn't exist. Ask the user where to find it.
1641 (let ((pop-up-windows t))
1642 (compilation-set-window (display-buffer (marker-buffer marker))
1644 (let ((name (expand-file-name
1646 (format "Find this error in: (default %s) "
1649 (if (file-directory-p name)
1650 (setq name (expand-file-name filename name)))
1651 (setq buffer (and (file-exists-p name)
1652 (find-file name))))))
1653 ;; Make intangible overlays tangible.
1654 (mapcar (function (lambda (ov)
1655 (when (overlay-get ov 'intangible)
1656 (overlay-put ov 'intangible nil))))
1657 (overlays-in (point-min) (point-max)))
1660 (defun compilation-get-file-structure (file &optional fmt)
1661 "Retrieve FILE's file-structure or create a new one.
1662 FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME)."
1664 (or (gethash file compilation-locs)
1665 ;; File was not previously encountered, at least not in the form passed.
1666 ;; Let's normalize it and look again.
1667 (let ((filename (car file))
1668 (default-directory (if (cdr file)
1669 (file-truename (cdr file))
1670 default-directory)))
1672 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1673 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1675 (if (boundp 'comint-file-name-prefix)
1676 (if (file-name-absolute-p filename)
1678 (concat (with-no-warnings comint-file-name-prefix) filename))
1679 (setq default-directory
1681 (concat (with-no-warnings comint-file-name-prefix) default-directory)))))
1683 ;; If compilation-parse-errors-filename-function is
1684 ;; defined, use it to process the filename.
1685 (when compilation-parse-errors-filename-function
1687 (funcall compilation-parse-errors-filename-function
1690 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
1691 ;; file names like "./bar//foo.c" for file "bar/foo.c";
1692 ;; expand-file-name will collapse these into "/foo.c" and fail to find
1693 ;; the appropriate file. So we look for doubled slashes in the file
1694 ;; name and fix them.
1695 (setq filename (command-line-normalize-file-name filename))
1697 ;; Now eliminate any "..", because find-file would get them wrong.
1698 ;; Make relative and absolute filenames, with or without links, the
1701 (list (abbreviate-file-name
1702 (file-truename (if (cdr file)
1703 (expand-file-name filename)
1706 ;; Store it for the possibly unnormalized name
1708 ;; Retrieve or create file-structure for normalized name
1709 (or (gethash filename compilation-locs)
1710 (puthash filename (list filename fmt) compilation-locs))
1711 compilation-locs))))
1713 (add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$")
1715 ;;; Compatibility with the old compile.el.
1717 (defun compile-buffer-substring (n) (if n (match-string n)))
1719 (defun compilation-compat-error-properties (err)
1720 "Map old-style error ERR to new-style message."
1721 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
1722 ;; (MARKER . MARKER).
1723 (let ((dst (cdr err)))
1725 ;; Must start with a face, for font-lock.
1727 message ,(list (list nil nil nil dst) 2)
1728 help-echo "mouse-2: visit the source location"
1729 keymap compilation-button-map
1730 mouse-face highlight)
1731 ;; Too difficult to do it by hand: dispatch to the normal code.
1732 (let* ((file (pop dst))
1735 (filename (pop file))
1736 (dirname (pop file))
1738 (compilation-internal-error-properties
1739 (cons filename dirname) line nil col nil 2 fmt)))))
1741 (defun compilation-compat-parse-errors (limit)
1742 (when compilation-parse-errors-function
1743 ;; FIXME: We should remove the rest of the compilation keywords
1744 ;; but we can't do that from here because font-lock is using
1745 ;; the value right now. --stef
1747 (setq compilation-error-list nil)
1748 ;; Reset compilation-parsing-end each time because font-lock
1749 ;; might force us the re-parse many times (typically because
1750 ;; some code adds some text-property to the output that we
1751 ;; already parsed). You might say "why reparse", well:
1752 ;; because font-lock has just removed the `message' property so
1753 ;; have to do it all over again.
1754 (if compilation-parsing-end
1755 (set-marker compilation-parsing-end (point))
1756 (setq compilation-parsing-end (point-marker)))
1758 ;; Ignore any error: we're calling this function earlier than
1759 ;; in the old compile.el so things might not all be setup yet.
1760 (funcall compilation-parse-errors-function limit nil)
1762 (dolist (err (if (listp compilation-error-list) compilation-error-list))
1763 (let* ((src (car err))
1765 (loc (cond ((markerp dst) (list nil nil nil dst))
1767 (list (nth 2 dst) (nth 1 dst)
1768 (cons (cdar dst) (caar dst)))))))
1771 ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face)
1772 (put-text-property src (line-end-position)
1773 'message (list loc 2)))))))
1777 ;; Beware: this is not only compatiblity code. New code stil uses it. --Stef
1778 (defun compilation-forget-errors ()
1779 ;; In case we hit the same file/line specs, we want to recompute a new
1780 ;; marker for them, so flush our cache.
1781 (setq compilation-locs (make-hash-table :test 'equal :weakness 'value))
1782 (setq compilation-gcpro nil)
1783 ;; FIXME: the old code reset the directory-stack, so maybe we should
1784 ;; put a `directory change' marker of some sort, but where? -stef
1786 ;; FIXME: The old code moved compilation-current-error (which was
1787 ;; virtually represented by a mix of compilation-parsing-end and
1788 ;; compilation-error-list) to point-min, but that was only meaningful for
1789 ;; the internal uses of compilation-forget-errors: all calls from external
1790 ;; packages seem to be followed by a move of compilation-parsing-end to
1791 ;; something equivalent to point-max. So we speculatively move
1792 ;; compilation-current-error to point-max (since the external package
1793 ;; won't know that it should do it). --stef
1794 (setq compilation-current-error nil)
1795 (let* ((proc (get-buffer-process (current-buffer)))
1796 (mark (if proc (process-mark proc)))
1797 (pos (or mark (point-max))))
1798 (setq compilation-messages-start
1799 ;; In the future, ignore the text already present in the buffer.
1800 ;; Since many process filter functions insert before markers,
1801 ;; we need to put ours just before the insertion point rather
1802 ;; than at the insertion point. If that's not possible, then
1803 ;; don't use a marker. --Stef
1804 (if (> pos (point-min)) (copy-marker (1- pos)) pos))))
1808 ;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
1809 ;;; compile.el ends here