1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages
3 ;; Copyright (C) 1985-1987, 1993-1999, 2001-2013 Free Software
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 3 of the License, or
16 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
28 ;; This package provides the compile facilities documented in the Emacs user's
33 (eval-when-compile (require 'cl-lib))
37 (defgroup compilation nil
38 "Run compiler as inferior of Emacs, parse error messages."
44 (defcustom compilation-mode-hook nil
45 "List of hook functions run by `compilation-mode'."
50 (defcustom compilation-start-hook nil
51 "Hook run after starting a new compilation process.
52 The hook is run with one argument, the new process."
57 (defcustom compilation-window-height nil
58 "Number of lines in a compilation window.
59 If nil, use Emacs default."
60 :type '(choice (const :tag "Default" nil)
64 (defvar compilation-filter-hook nil
65 "Hook run after `compilation-filter' has inserted a string into the buffer.
66 It is called with the variable `compilation-filter-start' bound
67 to the position of the start of the inserted text, and point at
70 If Emacs lacks asynchronous process support, this hook is run
71 after `call-process' inserts the grep output into the buffer.")
73 (defvar compilation-filter-start nil
74 "Position of the start of the text inserted by `compilation-filter'.
75 This is bound before running `compilation-filter-hook'.")
77 (defvar compilation-first-column 1
78 "This is how compilers number the first column, usually 1 or 0.
79 If this is buffer-local in the destination buffer, Emacs obeys
80 that value, otherwise it uses the value in the *compilation*
81 buffer. This enables a major-mode to specify its own value.")
83 (defvar compilation-parse-errors-filename-function nil
84 "Function to call to post-process filenames while parsing error messages.
85 It takes one arg FILENAME which is the name of a file as found
86 in the compilation output, and should return a transformed file name.")
89 (defvar compilation-process-setup-function nil
90 "Function to call to customize the compilation process.
91 This function is called immediately before the compilation process is
92 started. It can be used to set any variables or functions that are used
93 while processing the output of the compilation process.")
96 (defvar compilation-buffer-name-function nil
97 "Function to compute the name of a compilation buffer.
98 The function receives one argument, the name of the major mode of the
99 compilation buffer. It should return a string.
100 If nil, compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
103 (defvar compilation-finish-function nil
104 "Function to call when a compilation process finishes.
105 It is called with two arguments: the compilation buffer, and a string
106 describing how the process finished.")
108 (make-obsolete-variable 'compilation-finish-function
109 "use `compilation-finish-functions', but it works a little differently."
113 (defvar compilation-finish-functions nil
114 "Functions to call when a compilation process finishes.
115 Each function is called with two arguments: the compilation buffer,
116 and a string describing how the process finished.")
118 (defvar compilation-in-progress nil
119 "List of compilation processes now running.")
120 (or (assq 'compilation-in-progress minor-mode-alist)
121 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
124 (defvar compilation-error "error"
125 "Stem of message to print when no matches are found.")
127 (defvar compilation-arguments nil
128 "Arguments that were given to `compilation-start'.")
130 (defvar compilation-num-errors-found)
132 ;; If you make any changes to `compilation-error-regexp-alist-alist',
133 ;; be sure to run the ERT test in test/automated/compile-tests.el.
134 ;; emacs -batch -l compile-tests.el -f ert-run-tests-batch-and-exit
136 (defvar compilation-error-regexp-alist-alist
138 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
139 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
142 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
145 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
148 "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\):\\)?\
149 \\( warning\\)?" 1 (2 . 4) (3 . 5) (6))
152 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
155 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
156 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
157 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
159 (python-tracebacks-and-caml
160 "^[ \t]*File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
161 \\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning\\(?: [0-9]+\\)?:\\)?\\)"
162 2 (3 . 4) (5 . 6) (7))
165 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
166 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
169 "\\(?:^cucumber\\(?: -p [^[:space:]]+\\)?\\|#\\)\
170 \\(?: \\)\\([^\(].*\\):\\([1-9][0-9]*\\)" 1 2)
173 ;; Must be before edg-1, so that MSVC's longer messages are
174 ;; considered before EDG.
175 ;; The message may be a "warning", "error", or "fatal error" with
176 ;; an error code, or "see declaration of" without an error code.
177 "^ *\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) ?\
178 : \\(?:see declaration\\|\\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:\\)"
182 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
185 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
189 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
192 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
196 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
200 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
201 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
203 ;; fixme: should be `mips'
205 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
206 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
209 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
212 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
215 ;; This used to be pathologically slow on long lines (Bug#3441),
216 ;; due to matching filenames via \\(.*?\\). This might be faster.
218 ;; Maven is a popular free software build tool for Java.
219 "\\([^ \n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\):\\[\\([0-9]+\\),\\([0-9]+\\)\\] " 1 2 3)
222 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
224 (2 (compilation-face '(3))))
227 "^\\(?:In file included \\| \\|\t\\)from \
228 \\([0-9]*[^0-9\n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\):\
229 \\([0-9]+\\)\\(?::\\([0-9]+\\)\\)?\\(?:\\(:\\)\\|\\(,\\|$\\)\\)?"
233 "^[\t ]*\\[\\([^\(].*\\):\\([1-9][0-9]*\\)\\(\\]\\)?:in " 1 2)
236 ;; The first line matches the program name for
238 ;; PROGRAM:SOURCE-FILE-NAME:LINENO: MESSAGE
240 ;; format, which is used for non-interactive programs other than
241 ;; compilers (e.g. the "jade:" entry in compilation.txt).
243 ;; This first line makes things ambiguous with output such as
244 ;; "foo:344:50:blabla" since the "foo" part can match this first
245 ;; line (in which case the file name as "344"). To avoid this,
246 ;; the second line disallows filenames exclusively composed of
249 ;; Similarly, we get lots of false positives with messages including
250 ;; times of the form "HH:MM:SS" where MM is taken as a line number, so
251 ;; the last line tries to rule out message where the info after the
252 ;; line number starts with "SS". --Stef
254 ;; The core of the regexp is the one with *?. It says that a file name
255 ;; can be composed of any non-newline char, but it also rules out some
256 ;; valid but unlikely cases, such as a trailing space or a space
257 ;; followed by a -, or a colon followed by a space.
259 ;; The "in \\|from " exception was added to handle messages from Ruby.
260 "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\|[ \t]+\\(?:in \\|from \\)\\)?\
261 \\([0-9]*[^0-9\n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\): ?\
262 \\([0-9]+\\)\\(?:-\\(?4:[0-9]+\\)\\(?:\\.\\(?5:[0-9]+\\)\\)?\
263 \\|[.:]\\(?3:[0-9]+\\)\\(?:-\\(?:\\(?4:[0-9]+\\)\\.\\)?\\(?5:[0-9]+\\)\\)?\\)?:\
264 \\(?: *\\(\\(?:Future\\|Runtime\\)?[Ww]arning\\|W:\\)\\|\
265 *\\([Ii]nfo\\(?:\\>\\|rmationa?l?\\)\\|I:\\|\\[ skipping .+ \\]\\|\
266 \\(?:instantiated\\|required\\) from\\|[Nn]ote\\)\\|\
267 *[Ee]rror\\|[0-9]?\\(?:[^0-9\n]\\|$\\)\\|[0-9][0-9][0-9]\\)"
268 1 (2 . 4) (3 . 5) (6 . 7))
271 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
275 "^makepp\\(?:\\(?:: warning\\(:\\).*?\\|\\(: Scanning\\|: [LR]e?l?oading makefile\\|: Imported\\|log:.*?\\) \\|: .*?\\)\
276 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
278 (0 (progn (save-match-data
279 (compilation-parse-errors
280 (match-end 0) (line-end-position)
281 `("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]"
283 ,(cond ((match-end 1) 1) ((match-end 2) 0) (t 2))
288 ;; Should be lint-1, lint-2 (SysV lint)
290 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
292 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
295 ;; The message may be a "warning", "error", or "fatal error" with
296 ;; an error code, or "see declaration of" without an error code.
297 "^ *\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
298 : \\(?:see declaration\\|\\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:\\)"
302 ;; "omake -P" reports "file foo changed"
303 ;; (useful if you do "cvs up" and want to see what has changed)
304 "omake: file \\(.*\\) changed" 1 nil nil nil nil
305 ;; FIXME-omake: This tries to prevent reusing pre-existing markers
306 ;; for subsequent messages, since those messages's line numbers
307 ;; are about another version of the file.
308 (0 (progn (compilation--flush-file-structure (match-string 1))
312 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
313 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
314 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
317 ;; "during global destruction": This comes out under "use
318 ;; warnings" in recent perl when breaking circular references
319 ;; during program or thread exit.
321 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\| \
322 during global destruction\\.$\\)" 1 2)
325 "\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)"
329 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
330 \\([0-9]+\\) of file://\\(.+\\)"
334 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
335 [12][09][0-9][0-9] +\\(.*\\):$"
338 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
339 nil 3 nil (2) nil (1 (compilation-face '(2))))
340 (sparc-pascal-example
341 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
342 nil 1 nil (3) nil (2 (compilation-face '(3))))
345 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
346 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
350 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
353 "^[ \t]*\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)): ?\
354 \\(?:\\(Error! E[0-9]+\\)\\|\\(Warning! W[0-9]+\\)\\):"
358 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
359 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3))
362 "^ *-: *\\(0\\):Source:\\(.+\\)$"
365 "^ *-: *\\(0\\):\\(?:Object\\|Graph\\|Data\\|Runs\\|Programs\\):.+$"
367 ;; Underlines over all lines of gcov output are too uncomfortable to read.
368 ;; However, hyperlinks embedded in the lines are useful.
369 ;; So I put default face on the lines; and then put
370 ;; compilation-*-face by manually to eliminate the underlines.
371 ;; The hyperlinks are still effective.
373 "^ *-: *\\([1-9]\\|[0-9]\\{2,\\}\\):.*$"
376 (1 compilation-line-face))
378 "^ *\\([0-9]+\\): *\\([0-9]+\\):.*$"
381 (1 compilation-info-face) (2 compilation-line-face))
383 "^ *\\(#####\\): *\\([0-9]+\\):.*$"
386 (1 compilation-error-face) (2 compilation-line-face))
389 ;; podchecker error messages, per Pod::Checker.
390 ;; The style is from the Pod::Checker::poderror() function, eg.
391 ;; *** ERROR: Spurious text after =cut at line 193 in file foo.pm
393 ;; Plus end_pod() can give "at line EOF" instead of a
394 ;; number, so for that match "on line N" which is the
395 ;; originating spot, eg.
396 ;; *** ERROR: =over on line 37 without closing =back at line EOF in file bar.pm
398 ;; Plus command() can give both "on line N" and "at line N";
399 ;; the latter is desired and is matched because the .* is
401 ;; *** ERROR: =over on line 1 without closing =back (at head1) at line 3 in file x.pod
403 "^\\*\\*\\* \\(?:ERROR\\|\\(WARNING\\)\\).* \\(?:at\\|on\\) line \
404 \\([0-9]+\\) \\(?:.* \\)?in file \\([^ \t\n]+\\)"
407 ;; perl Test module error messages.
408 ;; Style per the ok() function "$context", eg.
409 ;; # Failed test 1 in foo.t at line 6
411 "^# Failed test [0-9]+ in \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
414 ;; Or when comparing got/want values, with a "fail #n" if repeated
415 ;; # Test 2 got: "xx" (t-compilation-perl-2.t at line 10)
416 ;; # Test 3 got: "xx" (t-compilation-perl-2.t at line 10 fail #2)
418 ;; And under Test::Harness they're preceded by progress stuff with
420 ;; ... NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
422 "^\\(.*NOK.*\\)?# Test [0-9]+ got:.* (\\([^ \t\r\n]+\\) at line \
423 \\([0-9]+\\)\\( fail #[0-9]+\\)?)"
426 ;; perl Test::Harness output, eg.
427 ;; NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
429 ;; Test::Harness is slightly designed for tty output, since
430 ;; it prints CRs to overwrite progress messages, but if you
431 ;; run it in with M-x compile this pattern can at least step
432 ;; through the failures.
434 "^.*NOK.* \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
437 ;; The style comes from HTML::Lint::Error::as_string(), eg.
438 ;; index.html (13:1) Unknown element <fdjsk>
440 ;; The pattern only matches filenames without spaces, since that
441 ;; should be usual and should help reduce the chance of a false
442 ;; match of a message from some unrelated program.
444 ;; This message style is quite close to the "ibm" entry which is
445 ;; for IBM C, though that ibm bit doesn't put a space after the
448 "^\\([^ \t\r\n(]+\\) (\\([0-9]+\\):\\([0-9]+\\)) "
451 "Alist of values for `compilation-error-regexp-alist'.")
453 (defcustom compilation-error-regexp-alist
454 (mapcar 'car compilation-error-regexp-alist-alist)
455 "Alist that specifies how to match errors in compiler output.
456 On GNU and Unix, any string is a valid filename, so these
457 matchers must make some common sense assumptions, which catch
458 normal cases. A shorter list will be lighter on resource usage.
460 Instead of an alist element, you can use a symbol, which is
461 looked up in `compilation-error-regexp-alist-alist'. You can see
462 the predefined symbols and their effects in the file
463 `etc/compilation.txt' (linked below if you are customizing this).
465 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
466 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
467 gives the file name, and the LINE'th subexpression gives the line
468 number. The COLUMN'th subexpression gives the column number on
471 If FILE, LINE or COLUMN are nil or that index didn't match, that
472 information is not present on the matched line. In that case the
473 file name is assumed to be the same as the previous one in the
474 buffer, line number defaults to 1 and column defaults to
475 beginning of line's indentation.
477 FILE can also have the form (FILE FORMAT...), where the FORMATs
478 \(e.g. \"%s.c\") will be applied in turn to the recognized file
479 name, until a file of that name is found. Or FILE can also be a
480 function that returns (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
481 In the former case, FILENAME may be relative or absolute.
483 LINE can also be of the form (LINE . END-LINE) meaning a range
484 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
485 meaning a range of columns starting on LINE and ending on
486 END-LINE, if that matched.
488 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
489 TYPE can also be of the form (WARNING . INFO). In that case this
490 will be equivalent to 1 if the WARNING'th subexpression matched
491 or else equivalent to 0 if the INFO'th subexpression matched.
492 See `compilation-error-face', `compilation-warning-face',
493 `compilation-info-face' and `compilation-skip-threshold'.
495 What matched the HYPERLINK'th subexpression has `mouse-face' and
496 `compilation-message-face' applied. If this is nil, the text
497 matched by the whole REGEXP becomes the hyperlink.
499 Additional HIGHLIGHTs take the shape (SUBMATCH FACE), where
500 SUBMATCH is the number of a submatch and FACE is an expression
501 which evaluates to a face name (a symbol or string).
502 Alternatively, FACE can evaluate to a property list of the
503 form (face FACE PROP1 VAL1 PROP2 VAL2 ...), in which case all the
504 listed text properties PROP# are given values VAL# as well."
505 :type '(repeat (choice (symbol :tag "Predefined symbol")
506 (sexp :tag "Error specification")))
507 :link `(file-link :tag "example file"
508 ,(expand-file-name "compilation.txt" data-directory))
511 ;;;###autoload(put 'compilation-directory 'safe-local-variable 'stringp)
512 (defvar compilation-directory nil
513 "Directory to restore to when doing `recompile'.")
515 (defvar compilation-directory-matcher
516 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
517 "A list for tracking when directories are entered or left.
518 If nil, do not track directories, e.g. if all file names are absolute. The
519 first element is the REGEXP matching these messages. It can match any number
520 of variants, e.g. different languages. The remaining elements are all of the
521 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
522 matches, that is a directory name. If LEAVE is nil or the corresponding
523 LEAVE'th subexpression doesn't match, this message is about going into another
524 directory. If it does match anything, this message is about going back to the
525 directory we were in before the last entering message. If you change this,
526 you may also want to change `compilation-page-delimiter'.")
528 (defvar compilation-page-delimiter
529 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
530 "Value of `page-delimiter' in Compilation mode.")
532 (defvar compilation-mode-font-lock-keywords
533 '(;; configure output lines.
534 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
535 (1 font-lock-variable-name-face)
536 (2 (compilation-face '(4 . 3))))
537 ;; Command output lines. Recognize `make[n]:' lines too.
538 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
539 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
540 (" --?o\\(?:utfile\\|utput\\)?[= ]\\(\\S +\\)" . 1)
541 ("^Compilation \\(finished\\).*"
542 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
543 (1 compilation-info-face))
544 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\|segmentation fault\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
545 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
546 (1 compilation-error-face)
547 (2 compilation-error-face nil t)))
548 "Additional things to highlight in Compilation mode.
549 This gets tacked on the end of the generated expressions.")
551 (defvar compilation-highlight-regexp t
552 "Regexp matching part of visited source lines to highlight temporarily.
553 Highlight entire line if t; don't highlight source lines if nil.")
555 (defvar compilation-highlight-overlay nil
556 "Overlay used to temporarily highlight compilation matches.")
558 (defcustom compilation-error-screen-columns t
559 "If non-nil, column numbers in error messages are screen columns.
560 Otherwise they are interpreted as character positions, with
561 each character occupying one column.
562 The default is to use screen columns, which requires that the compilation
563 program and Emacs agree about the display width of the characters,
564 especially the TAB character.
565 If this is buffer-local in the destination buffer, Emacs obeys
566 that value, otherwise it uses the value in the *compilation*
567 buffer. This enables a major-mode to specify its own value."
572 (defcustom compilation-read-command t
573 "Non-nil means \\[compile] reads the compilation command to use.
574 Otherwise, \\[compile] just uses the value of `compile-command'.
576 Note that changing this to nil may be a security risk, because a
577 file might define a malicious `compile-command' as a file local
578 variable, and you might not notice. Therefore, `compile-command'
579 is considered unsafe if this variable is nil."
584 (defcustom compilation-ask-about-save t
585 "Non-nil means \\[compile] asks which buffers to save before compiling.
586 Otherwise, it saves all modified buffers without asking."
590 (defcustom compilation-save-buffers-predicate nil
591 "The second argument (PRED) passed to `save-some-buffers' before compiling.
592 E.g., one can set this to
594 (string-prefix-p my-compilation-root (file-truename (buffer-file-name))))
595 to limit saving to files located under `my-compilation-root'.
596 Note, that, in general, `compilation-directory' cannot be used instead
597 of `my-compilation-root' here."
599 (const :tag "Default (save all file-visiting buffers)" nil)
600 (const :tag "Save all buffers" t)
606 (defcustom compilation-search-path '(nil)
607 "List of directories to search for source files named in error messages.
608 Elements should be directory names, not file names of directories.
609 The value nil as an element means to try the default directory."
610 :type '(repeat (choice (const :tag "Default" nil)
611 (string :tag "Directory")))
615 (defcustom compile-command (purecopy "make -k ")
616 "Last shell command used to do a compilation; default for next compilation.
618 Sometimes it is useful for files to supply local values for this variable.
619 You might also use mode hooks to specify it in certain modes, like this:
621 (add-hook 'c-mode-hook
623 (unless (or (file-exists-p \"makefile\")
624 (file-exists-p \"Makefile\"))
625 (set (make-local-variable 'compile-command)
627 (file-name-sans-extension buffer-file-name))))))"
630 ;;;###autoload(put 'compile-command 'safe-local-variable (lambda (a) (and (stringp a) (or (not (boundp 'compilation-read-command)) compilation-read-command))))
633 (defcustom compilation-disable-input nil
634 "If non-nil, send end-of-file as compilation process input.
635 This only affects platforms that support asynchronous processes (see
636 `start-process'); synchronous compilation processes never accept input."
641 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
642 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
643 ;; key. This holds the tree seen from root, for storing new nodes.
644 (defvar compilation-locs ())
646 (defvar compilation-debug nil
647 "Set this to t before creating a *compilation* buffer.
648 Then every error line will have a debug text property with the matcher that
649 fit this line and the match data. Use `describe-text-properties'.")
651 (defvar compilation-exit-message-function nil "\
652 If non-nil, called when a compilation process dies to return a status message.
653 This should be a function of three arguments: process status, exit status,
654 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
655 write into the compilation buffer, and to put in its mode line.")
657 (defcustom compilation-environment nil
658 "List of environment variables for compilation to inherit.
659 Each element should be a string of the form ENVVARNAME=VALUE.
660 This list is temporarily prepended to `process-environment' prior to
661 starting the compilation process."
662 :type '(repeat (string :tag "ENVVARNAME=VALUE"))
663 :options '(("LANG=C"))
667 ;; History of compile commands.
668 (defvar compile-history nil)
670 (defface compilation-error
671 '((t :inherit error))
672 "Face used to highlight compiler errors."
676 (defface compilation-warning
677 '((t :inherit warning))
678 "Face used to highlight compiler warnings."
682 (defface compilation-info
683 '((t :inherit success))
684 "Face used to highlight compiler information."
688 ;; The next three faces must be able to stand out against the
689 ;; `mode-line' and `mode-line-inactive' faces.
691 (defface compilation-mode-line-fail
692 '((default :inherit compilation-error)
693 (((class color) (min-colors 16)) (:foreground "Red1" :weight bold))
694 (((class color) (min-colors 8)) (:foreground "red"))
695 (t (:inverse-video t :weight bold)))
696 "Face for Compilation mode's \"error\" mode line indicator."
700 (defface compilation-mode-line-run
701 '((t :inherit compilation-warning))
702 "Face for Compilation mode's \"running\" mode line indicator."
706 (defface compilation-mode-line-exit
707 '((default :inherit compilation-info)
708 (((class color) (min-colors 16))
709 (:foreground "ForestGreen" :weight bold))
710 (((class color)) (:foreground "green" :weight bold))
712 "Face for Compilation mode's \"exit\" mode line indicator."
716 (defface compilation-line-number
717 '((t :inherit font-lock-keyword-face))
718 "Face for displaying line numbers in compiler messages."
722 (defface compilation-column-number
723 '((t :inherit font-lock-doc-face))
724 "Face for displaying column numbers in compiler messages."
728 (defcustom compilation-message-face 'underline
729 "Face name to use for whole messages.
730 Faces `compilation-error-face', `compilation-warning-face',
731 `compilation-info-face', `compilation-line-face' and
732 `compilation-column-face' get prepended to this, when applicable."
737 (defvar compilation-error-face 'compilation-error
738 "Face name to use for file name in error messages.")
740 (defvar compilation-warning-face 'compilation-warning
741 "Face name to use for file name in warning messages.")
743 (defvar compilation-info-face 'compilation-info
744 "Face name to use for file name in informational messages.")
746 (defvar compilation-line-face 'compilation-line-number
747 "Face name to use for line numbers in compiler messages.")
749 (defvar compilation-column-face 'compilation-column-number
750 "Face name to use for column numbers in compiler messages.")
752 ;; same faces as dired uses
753 (defvar compilation-enter-directory-face 'font-lock-function-name-face
754 "Face name to use for entering directory messages.")
756 (defvar compilation-leave-directory-face 'font-lock-builtin-face
757 "Face name to use for leaving directory messages.")
759 ;; Used for compatibility with the old compile.el.
760 (defvar compilation-parse-errors-function nil)
761 (make-obsolete-variable 'compilation-parse-errors-function
762 'compilation-error-regexp-alist "24.1")
764 (defcustom compilation-auto-jump-to-first-error nil
765 "If non-nil, automatically jump to the first error during compilation."
770 (defvar compilation-auto-jump-to-next nil
771 "If non-nil, automatically jump to the next error encountered.")
772 (make-variable-buffer-local 'compilation-auto-jump-to-next)
774 ;; (defvar compilation-buffer-modtime nil
775 ;; "The buffer modification time, for buffers not associated with files.")
776 ;; (make-variable-buffer-local 'compilation-buffer-modtime)
778 (defvar compilation-skip-to-next-location t
779 "If non-nil, skip multiple error messages for the same source location.")
781 (defcustom compilation-skip-threshold 1
782 "Compilation motion commands skip less important messages.
783 The value can be either 2 -- skip anything less than error, 1 --
784 skip anything less than warning or 0 -- don't skip any messages.
785 Note that all messages not positively identified as warning or
786 info, are considered errors."
787 :type '(choice (const :tag "Skip warnings and info" 2)
788 (const :tag "Skip info" 1)
789 (const :tag "No skip" 0))
793 (defun compilation-set-skip-threshold (level)
794 "Switch the `compilation-skip-threshold' level."
797 (mod (if current-prefix-arg
798 (prefix-numeric-value current-prefix-arg)
799 (1+ compilation-skip-threshold))
801 (setq compilation-skip-threshold level)
802 (message "Skipping %s"
803 (pcase compilation-skip-threshold
806 (2 "Warnings and info"))))
808 (defcustom compilation-skip-visited nil
809 "Compilation motion commands skip visited messages if this is t.
810 Visited messages are ones for which the file, line and column have been jumped
811 to from the current content in the current compilation buffer, even if it was
812 from a different message."
817 (defun compilation-face (type)
818 (or (and (car type) (match-end (car type)) compilation-warning-face)
819 (and (cdr type) (match-end (cdr type)) compilation-info-face)
820 compilation-error-face))
822 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE nil nil)
824 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
825 ;; LINE will be nil for a message that doesn't contain them. Then the
826 ;; location refers to a indented beginning of line or beginning of file.
827 ;; Once any location in some file has been jumped to, the list is extended to
828 ;; (COLUMN LINE FILE-STRUCTURE MARKER TIMESTAMP . VISITED)
829 ;; for all LOCs pertaining to that file.
830 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
831 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
832 ;; before that point. VISITED is t if we have jumped there, else nil.
833 ;; FIXME-omake: TIMESTAMP was used to try and handle "incremental compilation":
834 ;; `omake -P' polls filesystem for changes and recompiles when a file is
835 ;; modified using the same *compilation* buffer. this necessitates
836 ;; re-parsing markers.
838 ;; (cl-defstruct (compilation--loc
839 ;; (:constructor nil)
841 ;; (:constructor compilation--make-loc
842 ;; (file-struct line col marker))
843 ;; (:conc-name compilation--loc->))
844 ;; col line file-struct marker timestamp visited)
846 ;; FIXME: We don't use a defstruct because of compilation-assq which looks up
847 ;; and creates part of the LOC (only the first cons cell containing the COL).
849 (defmacro compilation--make-cdrloc (line file-struct marker)
850 `(list ,line ,file-struct ,marker nil))
851 (defmacro compilation--loc->col (loc) `(car ,loc))
852 (defmacro compilation--loc->line (loc) `(cadr ,loc))
853 (defmacro compilation--loc->file-struct (loc) `(nth 2 ,loc))
854 (defmacro compilation--loc->marker (loc) `(nth 3 ,loc))
855 ;; (defmacro compilation--loc->timestamp (loc) `(nth 4 ,loc))
856 (defmacro compilation--loc->visited (loc) `(nthcdr 5 ,loc))
858 ;; FILE-STRUCTURE is a list of
859 ;; ((FILENAME DIRECTORY) FORMATS (LINE LOC ...) ...)
861 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
862 ;; obtained by following directory change messages. DIRECTORY will be nil for
863 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
864 ;; a file of that name can't be found.
865 ;; The rest of the list is an alist of elements with LINE as key. The keys
866 ;; are either nil or line numbers. If present, nil comes first, followed by
867 ;; the numbers in decreasing order. The LOCs for each line are again an alist
868 ;; ordered the same way. Note that the whole file structure is referenced in
871 (defmacro compilation--make-file-struct (file-spec formats &optional loc-tree)
872 `(cons ,file-spec (cons ,formats ,loc-tree)))
873 (defmacro compilation--file-struct->file-spec (fs) `(car ,fs))
874 (defmacro compilation--file-struct->formats (fs) `(cadr ,fs))
875 ;; The FORMATS field plays the role of ANCHOR in the loc-tree.
876 (defmacro compilation--file-struct->loc-tree (fs) `(cdr ,fs))
878 ;; MESSAGE is a list of (LOC TYPE END-LOC)
880 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
881 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
882 ;; other end, if the parsed message contained a range. If the end of the
883 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
884 ;; These are the value of the `compilation-message' text-properties in the
885 ;; compilation buffer.
887 (cl-defstruct (compilation--message
890 ;; (:type list) ;Old representation.
891 (:constructor compilation--make-message (loc type end-loc))
892 (:conc-name compilation--message->))
895 (defvar compilation--previous-directory-cache nil
896 "A pair (POS . RES) caching the result of previous directory search.
897 Basically, this pair says that calling
898 (previous-single-property-change POS 'compilation-directory)
899 returned RES, i.e. there is no change of `compilation-directory' between
901 (make-variable-buffer-local 'compilation--previous-directory-cache)
903 (defun compilation--flush-directory-cache (start _end)
905 ((or (not compilation--previous-directory-cache)
906 (<= (car compilation--previous-directory-cache) start)))
907 ((or (not (cdr compilation--previous-directory-cache))
908 (null (marker-buffer (cdr compilation--previous-directory-cache)))
909 (<= (cdr compilation--previous-directory-cache) start))
910 (set-marker (car compilation--previous-directory-cache) start))
911 (t (setq compilation--previous-directory-cache nil))))
913 (defun compilation--previous-directory (pos)
914 "Like (previous-single-property-change POS 'compilation-directory), but faster."
915 ;; This avoids an N² behavior when there's no/few compilation-directory
916 ;; entries, in which case each call to previous-single-property-change
917 ;; ends up having to walk very far back to find the last change.
918 (if (and compilation--previous-directory-cache
919 (< pos (car compilation--previous-directory-cache))
920 (or (null (cdr compilation--previous-directory-cache))
921 (< (cdr compilation--previous-directory-cache) pos)))
922 ;; No need to call previous-single-property-change.
923 (cdr compilation--previous-directory-cache)
925 (let* ((cache (and compilation--previous-directory-cache
926 (<= (car compilation--previous-directory-cache) pos)
927 (car compilation--previous-directory-cache)))
929 (previous-single-property-change
930 pos 'compilation-directory nil cache))
934 (setq compilation--previous-directory-cache
935 (cons (copy-marker pos) (if prev (copy-marker prev))))
937 ((and prev (= prev cache))
939 (set-marker (car compilation--previous-directory-cache) pos)
940 (setq compilation--previous-directory-cache
941 (cons (copy-marker pos) nil)))
942 (cdr compilation--previous-directory-cache))
946 (set-marker cache pos)
947 (setcdr compilation--previous-directory-cache
949 (setq compilation--previous-directory-cache
950 (cons (copy-marker pos) (if prev (copy-marker prev)))))
952 (if (markerp res) (marker-position res) res))))
954 ;; Internal function for calculating the text properties of a directory
955 ;; change message. The compilation-directory property is important, because it
956 ;; is the stack of nested enter-messages. Relative filenames on the following
957 ;; lines are relative to the top of the stack.
958 (defun compilation-directory-properties (idx leave)
959 (if leave (setq leave (match-end leave)))
960 ;; find previous stack, and push onto it, or if `leave' pop it
961 (let ((dir (compilation--previous-directory (match-beginning 0))))
962 (setq dir (if dir (or (get-text-property (1- dir) 'compilation-directory)
963 (get-text-property dir 'compilation-directory))))
964 `(font-lock-face ,(if leave
965 compilation-leave-directory-face
966 compilation-enter-directory-face)
967 compilation-directory ,(if leave
969 '(nil)) ; nil only isn't a property-change
970 (cons (match-string-no-properties idx) dir))
971 ;; Place a `compilation-message' everywhere we change text-properties
972 ;; so compilation--remove-properties can know what to remove.
973 compilation-message ,(compilation--make-message nil 0 nil)
975 keymap compilation-button-map
976 help-echo "mouse-2: visit destination directory")))
978 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
979 ;; KEY element from the ALIST, creating it in the right position if not already
980 ;; present. ALIST structure is
981 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
982 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
983 ;; may be nil. The other KEYs are ordered backwards so that growing line
984 ;; numbers can be inserted in front and searching can abort after half the
986 (eval-when-compile ;Don't keep it at runtime if not needed.
987 (defmacro compilation-assq (key alist)
990 (car (if (if (null ,key)
991 (if l2 (null (caar l2)))
992 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
995 (if l2 (eq ,key (caar l2))))
997 (setcdr l1 (cons (list ,key) l2)))))))
999 (defun compilation-auto-jump (buffer pos)
1000 (with-current-buffer buffer
1002 (let ((win (get-buffer-window buffer 0)))
1003 (if win (set-window-point win pos)))
1004 (if compilation-auto-jump-to-first-error
1005 (compile-goto-error))))
1007 ;; This function is the central driver, called when font-locking to gather
1008 ;; all information needed to later jump to corresponding source code.
1009 ;; Return a property list with all meta information on this error location.
1011 (defun compilation-error-properties (file line end-line col end-col type fmt)
1012 (unless (text-property-not-all (match-beginning 0) (point)
1013 'compilation-message nil)
1016 (setq file (if (functionp file) (funcall file)
1017 (match-string-no-properties file))))
1019 (unless (file-name-absolute-p file)
1020 (let ((pos (compilation--previous-directory
1021 (match-beginning 0))))
1023 (or (get-text-property (1- pos) 'compilation-directory)
1024 (get-text-property pos 'compilation-directory)))))))
1025 (setq file (cons file (car dir)))))
1026 ;; This message didn't mention one, get it from previous
1028 ;; Find the previous message.
1029 (previous-single-property-change (point) 'compilation-message)))
1031 ;; Get the file structure that belongs to it.
1033 (or (get-text-property (1- prev-pos) 'compilation-message)
1034 (get-text-property prev-pos 'compilation-message)))
1037 (compilation--loc->file-struct
1038 (compilation--message->loc prev)))))
1040 ;; Construct FILE . DIR from that.
1041 (if prev-file-struct
1042 (setq file (cons (caar prev-file-struct)
1043 (cadr (car prev-file-struct)))))))
1045 (setq file '("*unknown*")))))
1046 ;; All of these fields are optional, get them only if we have an index, and
1047 ;; it matched some part of the message.
1049 (setq line (match-string-no-properties line))
1050 (setq line (string-to-number line)))
1052 (setq end-line (match-string-no-properties end-line))
1053 (setq end-line (string-to-number end-line)))
1056 (setq col (funcall col))
1058 (setq col (match-string-no-properties col))
1059 (setq col (string-to-number col)))))
1060 (if (and end-col (functionp end-col))
1061 (setq end-col (funcall end-col))
1062 (if (and end-col (setq end-col (match-string-no-properties end-col)))
1063 (setq end-col (- (string-to-number end-col) -1))
1064 (if end-line (setq end-col -1))))
1065 (if (consp type) ; not a static type, check what it is.
1066 (setq type (or (and (car type) (match-end (car type)) 1)
1067 (and (cdr type) (match-end (cdr type)) 0)
1070 (when (and compilation-auto-jump-to-next
1071 (>= type compilation-skip-threshold))
1072 (kill-local-variable 'compilation-auto-jump-to-next)
1073 (run-with-timer 0 nil 'compilation-auto-jump
1074 (current-buffer) (match-beginning 0)))
1076 (compilation-internal-error-properties
1077 file line end-line col end-col type fmt)))
1079 (defun compilation-move-to-column (col screen)
1080 "Go to column COL on the current line.
1081 If SCREEN is non-nil, columns are screen columns, otherwise, they are
1083 (setq col (- col compilation-first-column))
1085 (move-to-column (max col 0))
1086 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
1088 (defun compilation-internal-error-properties (file line end-line col end-col type fmts)
1089 "Get the meta-info that will be added as text-properties.
1090 LINE, END-LINE, COL, END-COL are integers or nil.
1091 TYPE can be 0, 1, or 2, meaning error, warning, or just info.
1092 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil.
1093 FMTS is a list of format specs for transforming the file name.
1094 (See `compilation-error-regexp-alist'.)"
1095 (unless file (setq file '("*unknown*")))
1096 (let* ((file-struct (compilation-get-file-structure file fmts))
1097 ;; Get first already existing marker (if any has one, all have one).
1098 ;; Do this first, as the compilation-assq`s may create new nodes.
1099 (marker-line ; a line structure
1100 (cadr (compilation--file-struct->loc-tree file-struct)))
1102 (if marker-line (compilation--loc->marker (cadr marker-line))))
1103 (screen-columns compilation-error-screen-columns)
1104 (first-column compilation-first-column)
1105 end-marker loc end-loc)
1106 (if (not (and marker (marker-buffer marker)))
1107 (setq marker nil) ; no valid marker for this file
1108 (unless line (setq line 1)) ; normalize no linenumber to line 1
1109 (catch 'marker ; find nearest loc, at least one exists
1110 (dolist (x (cddr (compilation--file-struct->loc-tree
1111 file-struct))) ; Loop over remaining lines.
1112 (if (> (car x) line) ; Still bigger.
1113 (setq marker-line x)
1114 (if (> (- (or (car marker-line) 1) line)
1115 (- line (car x))) ; Current line is nearer.
1116 (setq marker-line x))
1117 (throw 'marker t))))
1118 (setq marker (compilation--loc->marker (cadr marker-line))
1119 marker-line (or (car marker-line) 1))
1120 (with-current-buffer (marker-buffer marker)
1121 (let ((screen-columns
1122 ;; Obey the compilation-error-screen-columns of the target
1123 ;; buffer if its major mode set it buffer-locally.
1124 (if (local-variable-p 'compilation-error-screen-columns)
1125 compilation-error-screen-columns screen-columns))
1126 (compilation-first-column
1127 (if (local-variable-p 'compilation-first-column)
1128 compilation-first-column first-column)))
1132 (goto-char (marker-position marker))
1133 ;; Set end-marker if appropriate and go to line.
1134 (if (not (or end-col end-line))
1135 (beginning-of-line (- line marker-line -1))
1136 (beginning-of-line (- (or end-line line) marker-line -1))
1137 (if (or (null end-col) (< end-col 0))
1139 (compilation-move-to-column end-col screen-columns))
1140 (setq end-marker (point-marker))
1141 (when end-line (beginning-of-line (- line end-line -1))))
1143 (compilation-move-to-column col screen-columns)
1144 (forward-to-indentation 0))
1145 (setq marker (point-marker)))))))
1147 (setq loc (compilation-assq line (compilation--file-struct->loc-tree
1152 end-col (compilation-assq
1153 end-line (compilation--file-struct->loc-tree
1155 (if end-col ; use same line element
1156 (compilation-assq end-col loc))))
1157 (setq loc (compilation-assq col loc))
1158 ;; If they are new, make the loc(s) reference the file they point to.
1159 ;; FIXME-omake: there's a problem with timestamps here: the markers
1160 ;; relative to which we computed the current `marker' have a timestamp
1161 ;; almost guaranteed to be different from compilation-buffer-modtime, so if
1162 ;; we use their timestamp, we'll never use `loc' since the timestamp won't
1163 ;; match compilation-buffer-modtime, and if we use
1164 ;; compilation-buffer-modtime then we have different timestamps for
1165 ;; locations that were computed together, which doesn't make sense either.
1166 ;; I think this points to a fundamental problem in our approach to the
1167 ;; "omake -P" problem. --Stef
1169 (setcdr loc (compilation--make-cdrloc line file-struct marker)))
1173 (compilation--make-cdrloc (or end-line line) file-struct
1176 ;; Must start with face
1177 `(font-lock-face ,compilation-message-face
1178 compilation-message ,(compilation--make-message loc type end-loc)
1180 "mouse-2: visit this file, line and column"
1182 "mouse-2: visit this file and line"
1183 "mouse-2: visit this file"))
1184 keymap compilation-button-map
1185 mouse-face highlight)))
1187 (defun compilation--put-prop (matchnum prop val)
1188 (when (and (integerp matchnum) (match-beginning matchnum))
1190 (match-beginning matchnum) (match-end matchnum)
1193 (defun compilation--remove-properties (&optional start end)
1194 (with-silent-modifications
1195 ;; When compile.el used font-lock directly, we could just remove all
1196 ;; our text-properties in one go, but now that we manually place
1197 ;; font-lock-face, we have to be careful to only remove the font-lock-face
1199 ;; (remove-list-of-text-properties
1200 ;; (or start (point-min)) (or end (point-max))
1201 ;; '(compilation-debug compilation-directory compilation-message
1202 ;; font-lock-face help-echo mouse-face))
1204 (unless start (setq start (point-min)))
1205 (unless end (setq end (point-max)))
1206 (compilation--flush-directory-cache start end)
1209 (setq next (or (next-single-property-change
1210 start 'compilation-message nil end)
1212 (when (get-text-property start 'compilation-message)
1213 (remove-list-of-text-properties
1215 '(compilation-debug compilation-directory compilation-message
1216 font-lock-face help-echo mouse-face)))
1218 (setq start next)))))
1220 (defun compilation--parse-region (start end)
1223 ;; We generally don't like to parse partial lines.
1225 (when (let ((proc (get-buffer-process (current-buffer))))
1226 (and proc (memq (process-status proc) '(run open))))
1227 (setq end (line-beginning-position))))
1228 (compilation--remove-properties start end)
1229 (if compilation-parse-errors-function
1230 ;; An old package! Try the compatibility code.
1233 (compilation--compat-parse-errors end))
1235 ;; compilation-directory-matcher is the only part that really needs to be
1236 ;; parsed sequentially. So we could split it out, handle directories
1237 ;; like syntax-propertize, and the rest as font-lock-keywords. But since
1238 ;; we want to have it work even when font-lock is off, we'd then need to
1239 ;; use our own compilation-parsed text-property to keep track of the parts
1240 ;; that have already been parsed.
1242 (while (re-search-forward (car compilation-directory-matcher)
1244 (compilation--flush-directory-cache (match-beginning 0) (match-end 0))
1245 (when compilation-debug
1246 (font-lock-append-text-property
1247 (match-beginning 0) (match-end 0)
1249 (vector 'directory compilation-directory-matcher)))
1250 (dolist (elt (cdr compilation-directory-matcher))
1251 (add-text-properties (match-beginning (car elt))
1252 (match-end (car elt))
1253 (compilation-directory-properties
1254 (car elt) (cdr elt)))))
1256 (compilation-parse-errors start end)))
1258 (defun compilation-parse-errors (start end &rest rules)
1259 "Parse errors between START and END.
1260 The errors recognized are the ones specified in RULES which default
1261 to `compilation-error-regexp-alist' if RULES is nil."
1262 (dolist (item (or rules compilation-error-regexp-alist))
1264 (setq item (cdr (assq item
1265 compilation-error-regexp-alist-alist))))
1266 (let ((file (nth 1 item))
1271 end-line end-col fmt
1274 ;; omake reports some error indented, so skip the indentation.
1275 ;; another solution is to modify (some?) regexps in
1276 ;; `compilation-error-regexp-alist'.
1277 ;; note that omake usage is not limited to ocaml and C (for stubs).
1278 ;; FIXME-omake: Doing it here seems wrong, at least it should depend on
1279 ;; whether or not omake's own error messages are recognized.
1281 ((not (memq 'omake compilation-error-regexp-alist)) nil)
1282 ((string-match "\\`\\([^^]\\|\\^\\( \\*\\|\\[\\)\\)" pat)
1283 nil) ;; Not anchored or anchored but already allows empty spaces.
1284 (t (setq pat (concat "^ *" (substring pat 1)))))
1286 (if (consp file) (setq fmt (cdr file) file (car file)))
1287 (if (consp line) (setq end-line (cdr line) line (car line)))
1288 (if (consp col) (setq end-col (cdr col) col (car col)))
1290 (if (functionp line)
1291 ;; The old compile.el had here an undocumented hook that
1292 ;; allowed `line' to be a function that computed the actual
1293 ;; error location. Let's do our best.
1296 (while (re-search-forward pat end t)
1298 (when compilation-debug
1299 (font-lock-append-text-property
1300 (match-beginning 0) (match-end 0)
1301 'compilation-debug (vector 'functionp item)))
1302 (add-text-properties
1303 (match-beginning 0) (match-end 0)
1304 (compilation--compat-error-properties
1305 (funcall line (cons (match-string file)
1306 (cons default-directory
1308 (if col (match-string col))))))
1309 (compilation--put-prop
1310 file 'font-lock-face compilation-error-face)))
1312 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
1313 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
1316 (while (re-search-forward pat end t)
1317 (when (setq props (compilation-error-properties
1318 file line end-line col end-col (or type 2) fmt))
1320 (when (integerp file)
1321 (compilation--put-prop
1322 file 'font-lock-face
1324 (compilation-face type)
1325 (symbol-value (aref [compilation-info-face
1326 compilation-warning-face
1327 compilation-error-face]
1330 (compilation--put-prop
1331 line 'font-lock-face compilation-line-face)
1332 (compilation--put-prop
1333 end-line 'font-lock-face compilation-line-face)
1335 (compilation--put-prop
1336 col 'font-lock-face compilation-column-face)
1337 (compilation--put-prop
1338 end-col 'font-lock-face compilation-column-face)
1341 (dolist (extra-item (nthcdr 6 item))
1342 (let ((mn (pop extra-item)))
1343 (when (match-beginning mn)
1344 (let ((face (eval (car extra-item))))
1347 ((or (symbolp face) (stringp face))
1349 (match-beginning mn) (match-end mn)
1350 'font-lock-face face))
1352 (eq (car face) 'face)
1353 (or (symbolp (cadr face))
1354 (stringp (cadr face))))
1356 (match-beginning mn) (match-end mn)
1357 'font-lock-face (cadr face))
1358 (add-text-properties
1359 (match-beginning mn) (match-end mn)
1362 (error "Don't know how to handle face %S"
1364 (let ((mn (or (nth 5 item) 0)))
1365 (when compilation-debug
1366 (font-lock-append-text-property
1367 (match-beginning 0) (match-end 0)
1368 'compilation-debug (vector 'std item props)))
1369 (add-text-properties
1370 (match-beginning mn) (match-end mn)
1372 (font-lock-append-text-property
1373 (match-beginning mn) (match-end mn)
1374 'font-lock-face (cadr props)))))))))
1376 (defvar compilation--parsed -1)
1377 (make-variable-buffer-local 'compilation--parsed)
1379 (defun compilation--ensure-parse (limit)
1380 "Make sure the text has been parsed up to LIMIT."
1383 (setq limit (line-beginning-position 2))
1384 (unless (markerp compilation--parsed)
1385 ;; We use a marker for compilation--parsed so that users (such as
1386 ;; grep.el) don't need to flush-parse when they modify the buffer
1387 ;; in a way that impacts buffer positions but does not require
1389 (setq compilation--parsed (point-min-marker)))
1390 (when (< compilation--parsed limit)
1391 (let ((start (max compilation--parsed (point-min))))
1392 (move-marker compilation--parsed limit)
1394 (forward-line 0) ;Not line-beginning-position: ignore (comint) fields.
1395 (with-silent-modifications
1396 (compilation--parse-region (point) compilation--parsed)))))
1399 (defun compilation--flush-parse (start _end)
1400 "Mark the region between START and END for re-parsing."
1401 (if (markerp compilation--parsed)
1402 (move-marker compilation--parsed (min start compilation--parsed))))
1404 (defun compilation-mode-font-lock-keywords ()
1405 "Return expressions to highlight in Compilation mode."
1407 '((compilation--ensure-parse))
1408 compilation-mode-font-lock-keywords))
1410 (defun compilation-read-command (command)
1411 (read-shell-command "Compile command: " command
1412 (if (equal (car compile-history) command)
1413 '(compile-history . 1)
1418 (defun compile (command &optional comint)
1419 "Compile the program including the current buffer. Default: run `make'.
1420 Runs COMMAND, a shell command, in a separate process asynchronously
1421 with output going to the buffer `*compilation*'.
1423 You can then use the command \\[next-error] to find the next error message
1424 and move to the source code that caused it.
1426 If optional second arg COMINT is t the buffer will be in Comint mode with
1427 `compilation-shell-minor-mode'.
1429 Interactively, prompts for the command if the variable
1430 `compilation-read-command' is non-nil; otherwise uses`compile-command'.
1431 With prefix arg, always prompts.
1432 Additionally, with universal prefix arg, compilation buffer will be in
1433 comint mode, i.e. interactive.
1435 To run more than one compilation at once, start one then rename
1436 the \`*compilation*' buffer to some other name with
1437 \\[rename-buffer]. Then _switch buffers_ and start the new compilation.
1438 It will create a new \`*compilation*' buffer.
1440 On most systems, termination of the main compilation process
1441 kills its subprocesses.
1443 The name used for the buffer is actually whatever is returned by
1444 the function in `compilation-buffer-name-function', so you can set that
1445 to a function that generates a unique name."
1448 (let ((command (eval compile-command)))
1449 (if (or compilation-read-command current-prefix-arg)
1450 (compilation-read-command command)
1452 (consp current-prefix-arg)))
1453 (unless (equal command (eval compile-command))
1454 (setq compile-command command))
1455 (save-some-buffers (not compilation-ask-about-save)
1456 compilation-save-buffers-predicate)
1457 (setq-default compilation-directory default-directory)
1458 (compilation-start command comint))
1460 ;; run compile with the default command line
1461 (defun recompile (&optional edit-command)
1462 "Re-compile the program including the current buffer.
1463 If this is run in a Compilation mode buffer, re-use the arguments from the
1464 original use. Otherwise, recompile using `compile-command'.
1465 If the optional argument `edit-command' is non-nil, the command can be edited."
1467 (save-some-buffers (not compilation-ask-about-save)
1468 compilation-save-buffers-predicate)
1469 (let ((default-directory (or compilation-directory default-directory)))
1471 (setcar compilation-arguments
1472 (compilation-read-command (car compilation-arguments))))
1473 (apply 'compilation-start (or compilation-arguments
1474 `(,(eval compile-command))))))
1476 (defcustom compilation-scroll-output nil
1477 "Non-nil to scroll the *compilation* buffer window as output appears.
1479 Setting it causes the Compilation mode commands to put point at the
1480 end of their output window so that the end of the output is always
1481 visible rather than the beginning.
1483 The value `first-error' stops scrolling at the first error, and leaves
1484 point on its location in the *compilation* buffer."
1485 :type '(choice (const :tag "No scrolling" nil)
1486 (const :tag "Scroll compilation output" t)
1487 (const :tag "Stop scrolling at the first error" first-error))
1489 :group 'compilation)
1492 (defun compilation-buffer-name (name-of-mode mode-command name-function)
1493 "Return the name of a compilation buffer to use.
1494 If NAME-FUNCTION is non-nil, call it with one argument NAME-OF-MODE
1495 to determine the buffer name.
1496 Likewise if `compilation-buffer-name-function' is non-nil.
1497 If current buffer has the major mode MODE-COMMAND,
1498 return the name of the current buffer, so that it gets reused.
1499 Otherwise, construct a buffer name from NAME-OF-MODE."
1500 (cond (name-function
1501 (funcall name-function name-of-mode))
1502 (compilation-buffer-name-function
1503 (funcall compilation-buffer-name-function name-of-mode))
1504 ((eq mode-command major-mode)
1507 (concat "*" (downcase name-of-mode) "*"))))
1509 (defcustom compilation-always-kill nil
1510 "If t, always kill a running compilation process before starting a new one.
1511 If nil, ask to kill it."
1514 :group 'compilation)
1517 (defun compilation-start (command &optional mode name-function highlight-regexp)
1518 "Run compilation command COMMAND (low level interface).
1519 If COMMAND starts with a cd command, that becomes the `default-directory'.
1520 The rest of the arguments are optional; for them, nil means use the default.
1522 MODE is the major mode to set in the compilation buffer. Mode
1523 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
1525 If NAME-FUNCTION is non-nil, call it with one argument (the mode name)
1526 to determine the buffer name. Otherwise, the default is to
1527 reuses the current buffer if it has the proper major mode,
1528 else use or create a buffer with name based on the major mode.
1530 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
1531 the matching section of the visited source line; the default is to use the
1532 global value of `compilation-highlight-regexp'.
1534 Returns the compilation buffer created."
1535 (or mode (setq mode 'compilation-mode))
1536 (let* ((name-of-mode
1539 (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1540 (thisdir default-directory)
1541 (thisenv compilation-environment)
1543 (with-current-buffer
1546 (compilation-buffer-name name-of-mode mode name-function)))
1547 (let ((comp-proc (get-buffer-process (current-buffer))))
1549 (if (or (not (eq (process-status comp-proc) 'run))
1550 (eq (process-query-on-exit-flag comp-proc) nil)
1552 (format "A %s process is running; kill it? "
1556 (interrupt-process comp-proc)
1558 (delete-process comp-proc))
1560 (error "Cannot have two processes in `%s' at once"
1562 ;; first transfer directory from where M-x compile was called
1563 (setq default-directory thisdir)
1564 ;; Make compilation buffer read-only. The filter can still write it.
1565 ;; Clear out the compilation buffer.
1566 (let ((inhibit-read-only t)
1567 (default-directory thisdir))
1568 ;; Then evaluate a cd command if any, but don't perform it yet, else
1569 ;; start-command would do it again through the shell: (cd "..") AND
1570 ;; sh -c "cd ..; make"
1572 ((not (string-match "\\`\\s *cd\\(?:\\s +\\(\\S +?\\|'[^']*'\\|\"\\(?:[^\"`$\\]\\|\\\\.\\)*\"\\)\\)?\\s *[;&\n]"
1575 ((not (match-end 1)) "~")
1576 ((eq (aref command (match-beginning 1)) ?\')
1577 (substring command (1+ (match-beginning 1))
1578 (1- (match-end 1))))
1579 ((eq (aref command (match-beginning 1)) ?\")
1580 (replace-regexp-in-string
1582 (substring command (1+ (match-beginning 1))
1583 (1- (match-end 1)))))
1584 (t (substitute-env-vars (match-string 1 command)))))
1586 ;; Select the desired mode.
1587 (if (not (eq mode t))
1589 (buffer-disable-undo)
1591 (setq buffer-read-only nil)
1592 (with-no-warnings (comint-mode))
1593 (compilation-shell-minor-mode))
1594 ;; Remember the original dir, so we can use it when we recompile.
1595 ;; default-directory' can't be used reliably for that because it may be
1596 ;; affected by the special handling of "cd ...;".
1597 ;; NB: must be done after (funcall mode) as that resets local variables
1598 (set (make-local-variable 'compilation-directory) thisdir)
1599 (set (make-local-variable 'compilation-environment) thisenv)
1600 (if highlight-regexp
1601 (set (make-local-variable 'compilation-highlight-regexp)
1603 (if (or compilation-auto-jump-to-first-error
1604 (eq compilation-scroll-output 'first-error))
1605 (set (make-local-variable 'compilation-auto-jump-to-next) t))
1606 ;; Output a mode setter, for saving and later reloading this buffer.
1607 (insert "-*- mode: " name-of-mode
1608 "; default-directory: "
1609 (prin1-to-string (abbreviate-file-name default-directory))
1611 (format "%s started at %s\n\n"
1613 (substring (current-time-string) 0 19))
1614 ;; The command could be split into several lines, see
1615 ;; `rgrep' for example. We want to display it as one
1617 (apply 'concat (split-string command (regexp-quote "\\\n") t))
1619 (setq thisdir default-directory))
1620 (set-buffer-modified-p nil))
1621 ;; Pop up the compilation buffer.
1622 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01638.html
1623 (setq outwin (display-buffer outbuf))
1624 (with-current-buffer outbuf
1625 (let ((process-environment
1627 compilation-environment
1628 (if (if (boundp 'system-uses-terminfo);`If' for compiler warning.
1629 system-uses-terminfo)
1630 (list "TERM=dumb" "TERMCAP="
1631 (format "COLUMNS=%d" (window-width)))
1633 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1635 ;; Set the EMACS variable, but
1636 ;; don't override users' setting of $EMACS.
1637 (unless (getenv "EMACS")
1639 (list "INSIDE_EMACS=t")
1640 (copy-sequence process-environment))))
1641 (set (make-local-variable 'compilation-arguments)
1642 (list command mode name-function highlight-regexp))
1643 (set (make-local-variable 'revert-buffer-function)
1644 'compilation-revert-buffer)
1645 (set-window-start outwin (point-min))
1647 ;; Position point as the user will see it.
1648 (let ((desired-visible-point
1649 ;; Put it at the end if `compilation-scroll-output' is set.
1650 (if compilation-scroll-output
1652 ;; Normally put it at the top.
1654 (if (eq outwin (selected-window))
1655 (goto-char desired-visible-point)
1656 (set-window-point outwin desired-visible-point)))
1658 ;; The setup function is called before compilation-set-window-height
1659 ;; so it can set the compilation-window-height buffer locally.
1660 (if compilation-process-setup-function
1661 (funcall compilation-process-setup-function))
1662 (compilation-set-window-height outwin)
1663 ;; Start the compilation.
1664 (if (fboundp 'start-process)
1667 ;; comint uses `start-file-process'.
1671 outbuf (downcase mode-name)
1672 (if (file-remote-p default-directory)
1675 nil `("-c" ,command))))
1676 (start-file-process-shell-command (downcase mode-name)
1678 ;; Make the buffer's mode line show process state.
1679 (setq mode-line-process
1680 '(:propertize ":%s" face compilation-mode-line-run))
1682 ;; Set the process as killable without query by default.
1683 ;; This allows us to start a new compilation without
1684 ;; getting prompted.
1685 (when compilation-always-kill
1686 (set-process-query-on-exit-flag proc nil))
1688 (set-process-sentinel proc 'compilation-sentinel)
1690 ;; Keep the comint filter, since it's needed for proper
1691 ;; handling of the prompts.
1692 (set-process-filter proc 'compilation-filter))
1693 ;; Use (point-max) here so that output comes in
1694 ;; after the initial text,
1695 ;; regardless of where the user sees point.
1696 (set-marker (process-mark proc) (point-max) outbuf)
1697 (when compilation-disable-input
1699 (process-send-eof proc)
1700 ;; The process may have exited already.
1702 (run-hook-with-args 'compilation-start-hook proc)
1703 (setq compilation-in-progress
1704 (cons proc compilation-in-progress)))
1705 ;; No asynchronous processes available.
1706 (message "Executing `%s'..." command)
1707 ;; Fake mode line display as if `start-process' were run.
1708 (setq mode-line-process
1709 '(:propertize ":run" face compilation-mode-line-run))
1710 (force-mode-line-update)
1711 (sit-for 0) ; Force redisplay
1713 ;; Insert the output at the end, after the initial text,
1714 ;; regardless of where the user sees point.
1715 (goto-char (point-max))
1716 (let* ((inhibit-read-only t) ; call-process needs to modify outbuf
1717 (compilation-filter-start (point))
1718 (status (call-process shell-file-name nil outbuf nil "-c"
1720 (run-hooks 'compilation-filter-hook)
1721 (cond ((numberp status)
1722 (compilation-handle-exit
1726 (format "exited abnormally with code %d\n" status))))
1728 (compilation-handle-exit 'signal status
1729 (concat status "\n")))
1731 (compilation-handle-exit 'bizarre status status)))))
1732 (set-buffer-modified-p nil)
1733 (message "Executing `%s'...done" command)))
1734 ;; Now finally cd to where the shell started make/grep/...
1735 (setq default-directory thisdir)
1736 ;; The following form selected outwin ever since revision 1.183,
1737 ;; so possibly messing up point in some other window (bug#1073).
1738 ;; Moved into the scope of with-current-buffer, though still with
1739 ;; complete disregard for the case when compilation-scroll-output
1740 ;; equals 'first-error (martin 2008-10-04).
1741 (when compilation-scroll-output
1742 (goto-char (point-max))))
1744 ;; Make it so the next C-x ` will use this buffer.
1745 (setq next-error-last-buffer outbuf)))
1747 (defun compilation-set-window-height (window)
1748 "Set the height of WINDOW according to `compilation-window-height'."
1749 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1751 (window-full-width-p window)
1752 ;; If window is alone in its frame, aside from a minibuffer,
1753 ;; don't change its height.
1754 (not (eq window (frame-root-window (window-frame window))))
1755 ;; Stef said that doing the saves in this order is safer:
1757 (save-selected-window
1758 (select-window window)
1759 (enlarge-window (- height (window-height))))))))
1761 (defvar compilation-menu-map
1762 (let ((map (make-sparse-keymap "Errors"))
1763 (opt-map (make-sparse-keymap "Skip")))
1764 (define-key map [stop-subjob]
1765 '(menu-item "Stop Compilation" kill-compilation
1766 :help "Kill the process made by the M-x compile or M-x grep commands"))
1767 (define-key map [compilation-mode-separator3]
1769 (define-key map [compilation-next-error-follow-minor-mode]
1771 "Auto Error Display" next-error-follow-minor-mode
1772 :help "Display the error under cursor when moving the cursor"
1773 :button (:toggle . next-error-follow-minor-mode)))
1774 (define-key map [compilation-skip]
1775 (cons "Skip Less Important Messages" opt-map))
1776 (define-key opt-map [compilation-skip-none]
1777 '(menu-item "Don't Skip Any Messages"
1780 (customize-set-variable 'compilation-skip-threshold 0))
1781 :help "Do not skip any type of messages"
1782 :button (:radio . (eq compilation-skip-threshold 0))))
1783 (define-key opt-map [compilation-skip-info]
1784 '(menu-item "Skip Info"
1787 (customize-set-variable 'compilation-skip-threshold 1))
1788 :help "Skip anything less than warning"
1789 :button (:radio . (eq compilation-skip-threshold 1))))
1790 (define-key opt-map [compilation-skip-warning-and-info]
1791 '(menu-item "Skip Warnings and Info"
1794 (customize-set-variable 'compilation-skip-threshold 2))
1795 :help "Skip over Warnings and Info, stop for errors"
1796 :button (:radio . (eq compilation-skip-threshold 2))))
1797 (define-key map [compilation-mode-separator2]
1799 (define-key map [compilation-first-error]
1800 '(menu-item "First Error" first-error
1801 :help "Restart at the first error, visit corresponding source code"))
1802 (define-key map [compilation-previous-error]
1803 '(menu-item "Previous Error" previous-error
1804 :help "Visit previous `next-error' message and corresponding source code"))
1805 (define-key map [compilation-next-error]
1806 '(menu-item "Next Error" next-error
1807 :help "Visit next `next-error' message and corresponding source code"))
1810 (defvar compilation-minor-mode-map
1811 (let ((map (make-sparse-keymap)))
1812 (set-keymap-parent map special-mode-map)
1813 (define-key map [mouse-2] 'compile-goto-error)
1814 (define-key map [follow-link] 'mouse-face)
1815 (define-key map "\C-c\C-c" 'compile-goto-error)
1816 (define-key map "\C-m" 'compile-goto-error)
1817 (define-key map "\C-c\C-k" 'kill-compilation)
1818 (define-key map "\M-n" 'compilation-next-error)
1819 (define-key map "\M-p" 'compilation-previous-error)
1820 (define-key map "\M-{" 'compilation-previous-file)
1821 (define-key map "\M-}" 'compilation-next-file)
1822 (define-key map "g" 'recompile) ; revert
1823 ;; Set up the menu-bar
1824 (define-key map [menu-bar compilation]
1825 (cons "Errors" compilation-menu-map))
1827 "Keymap for `compilation-minor-mode'.")
1829 (defvar compilation-shell-minor-mode-map
1830 (let ((map (make-sparse-keymap)))
1831 (define-key map "\M-\C-m" 'compile-goto-error)
1832 (define-key map "\M-\C-n" 'compilation-next-error)
1833 (define-key map "\M-\C-p" 'compilation-previous-error)
1834 (define-key map "\M-{" 'compilation-previous-file)
1835 (define-key map "\M-}" 'compilation-next-file)
1836 ;; Set up the menu-bar
1837 (define-key map [menu-bar compilation]
1838 (cons "Errors" compilation-menu-map))
1840 "Keymap for `compilation-shell-minor-mode'.")
1842 (defvar compilation-button-map
1843 (let ((map (make-sparse-keymap)))
1844 (define-key map [mouse-2] 'compile-goto-error)
1845 (define-key map [follow-link] 'mouse-face)
1846 (define-key map "\C-m" 'compile-goto-error)
1848 "Keymap for compilation-message buttons.")
1849 (fset 'compilation-button-map compilation-button-map)
1851 (defvar compilation-mode-map
1852 (let ((map (make-sparse-keymap)))
1853 ;; Don't inherit from compilation-minor-mode-map,
1854 ;; because that introduces a menu bar item we don't want.
1855 ;; That confuses C-down-mouse-3.
1856 (set-keymap-parent map special-mode-map)
1857 (define-key map [mouse-2] 'compile-goto-error)
1858 (define-key map [follow-link] 'mouse-face)
1859 (define-key map "\C-c\C-c" 'compile-goto-error)
1860 (define-key map "\C-m" 'compile-goto-error)
1861 (define-key map "\C-c\C-k" 'kill-compilation)
1862 (define-key map "\M-n" 'compilation-next-error)
1863 (define-key map "\M-p" 'compilation-previous-error)
1864 (define-key map "\M-{" 'compilation-previous-file)
1865 (define-key map "\M-}" 'compilation-next-file)
1866 (define-key map "\t" 'compilation-next-error)
1867 (define-key map [backtab] 'compilation-previous-error)
1868 (define-key map "g" 'recompile) ; revert
1870 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1872 ;; Set up the menu-bar
1873 (let ((submap (make-sparse-keymap "Compile")))
1874 (define-key map [menu-bar compilation]
1875 (cons "Compile" submap))
1876 (set-keymap-parent submap compilation-menu-map))
1877 (define-key map [menu-bar compilation compilation-separator2]
1879 (define-key map [menu-bar compilation compilation-grep]
1880 '(menu-item "Search Files (grep)..." grep
1881 :help "Run grep, with user-specified args, and collect output in a buffer"))
1882 (define-key map [menu-bar compilation compilation-recompile]
1883 '(menu-item "Recompile" recompile
1884 :help "Re-compile the program including the current buffer"))
1885 (define-key map [menu-bar compilation compilation-compile]
1886 '(menu-item "Compile..." compile
1887 :help "Compile the program including the current buffer. Default: run `make'"))
1889 "Keymap for compilation log buffers.
1890 `compilation-minor-mode-map' is a parent of this.")
1892 (defvar compilation-mode-tool-bar-map
1893 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
1894 ;; so don't do anything.
1895 (when (keymapp tool-bar-map)
1896 (let ((map (copy-keymap tool-bar-map)))
1897 (define-key map [undo] nil)
1898 (define-key map [separator-2] nil)
1899 (define-key-after map [separator-compile] menu-bar-separator)
1900 (tool-bar-local-item
1901 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
1903 :help "Goto previous error")
1904 (tool-bar-local-item
1905 "right-arrow" 'next-error-no-select 'next-error-no-select map
1907 :help "Goto next error")
1908 (tool-bar-local-item
1909 "cancel" 'kill-compilation 'kill-compilation map
1910 :enable '(let ((buffer (compilation-find-buffer)))
1911 (get-buffer-process buffer))
1912 :help "Stop compilation")
1913 (tool-bar-local-item
1914 "refresh" 'recompile 'recompile map
1915 :help "Restart compilation")
1918 (put 'compilation-mode 'mode-class 'special)
1921 (defun compilation-mode (&optional name-of-mode)
1922 "Major mode for compilation log buffers.
1923 \\<compilation-mode-map>To visit the source for a line-numbered error,
1924 move point to the error message line and type \\[compile-goto-error].
1925 To kill the compilation, type \\[kill-compilation].
1927 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
1929 \\{compilation-mode-map}"
1931 (kill-all-local-variables)
1932 (use-local-map compilation-mode-map)
1933 ;; Let windows scroll along with the output.
1934 (set (make-local-variable 'window-point-insertion-type) t)
1935 (set (make-local-variable 'tool-bar-map) compilation-mode-tool-bar-map)
1936 (setq major-mode 'compilation-mode ; FIXME: Use define-derived-mode.
1937 mode-name (or name-of-mode "Compilation"))
1938 (set (make-local-variable 'page-delimiter)
1939 compilation-page-delimiter)
1940 ;; (set (make-local-variable 'compilation-buffer-modtime) nil)
1942 (setq buffer-read-only t)
1943 (run-mode-hooks 'compilation-mode-hook))
1946 (put 'define-compilation-mode 'doc-string-elt 3)
1948 (defmacro define-compilation-mode (mode name doc &rest body)
1949 "This is like `define-derived-mode' without the PARENT argument.
1950 The parent is always `compilation-mode' and the customizable `compilation-...'
1951 variables are also set from the name of the mode you have chosen,
1952 by replacing the first word, e.g., `compilation-scroll-output' from
1953 `grep-scroll-output' if that variable exists."
1954 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1955 `(define-derived-mode ,mode compilation-mode ,name
1957 ,@(mapcar (lambda (v)
1959 (intern-soft (replace-regexp-in-string
1960 "^compilation" mode-name
1963 (or (boundp (cdr v))
1964 ;; FIXME: This is hackish, using undocumented info.
1965 (if (boundp 'byte-compile-bound-variables)
1966 (memq (cdr v) byte-compile-bound-variables)))
1967 `(set (make-local-variable ',(car v)) ,(cdr v))))
1968 '(compilation-buffer-name-function
1969 compilation-directory-matcher
1971 compilation-error-regexp-alist
1972 compilation-error-regexp-alist-alist
1973 compilation-error-screen-columns
1974 compilation-finish-function
1975 compilation-finish-functions
1976 compilation-first-column
1977 compilation-mode-font-lock-keywords
1978 compilation-page-delimiter
1979 compilation-parse-errors-filename-function
1980 compilation-process-setup-function
1981 compilation-scroll-output
1982 compilation-search-path
1983 compilation-skip-threshold
1984 compilation-window-height))
1987 (defun compilation-revert-buffer (ignore-auto noconfirm)
1988 (if buffer-file-name
1989 (let (revert-buffer-function)
1990 (revert-buffer ignore-auto noconfirm))
1991 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1992 (apply 'compilation-start compilation-arguments))))
1994 (defvar compilation-current-error nil
1995 "Marker to the location from where the next error will be found.
1996 The global commands next/previous/first-error/goto-error use this.")
1998 (defvar compilation-messages-start nil
1999 "Buffer position of the beginning of the compilation messages.
2000 If nil, use the beginning of buffer.")
2002 (defun compilation-setup (&optional minor)
2003 "Prepare the buffer for the compilation parsing commands to work.
2004 Optional argument MINOR indicates this is called from
2005 `compilation-minor-mode'."
2006 (make-local-variable 'compilation-current-error)
2007 (make-local-variable 'compilation-messages-start)
2008 (make-local-variable 'compilation-error-screen-columns)
2009 (make-local-variable 'overlay-arrow-position)
2010 (set (make-local-variable 'overlay-arrow-string) "")
2011 (setq next-error-overlay-arrow-position nil)
2012 (add-hook 'kill-buffer-hook
2013 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
2014 ;; Note that compilation-next-error-function is for interfacing
2015 ;; with the next-error function in simple.el, and it's only
2016 ;; coincidentally named similarly to compilation-next-error.
2017 (setq next-error-function 'compilation-next-error-function)
2018 (set (make-local-variable 'comint-file-name-prefix)
2019 (or (file-remote-p default-directory) ""))
2020 (set (make-local-variable 'compilation-locs)
2021 (make-hash-table :test 'equal :weakness 'value))
2022 ;; It's generally preferable to use after-change-functions since they
2023 ;; can be subject to combine-after-change-calls, but if we do that, we risk
2024 ;; running our hook after font-lock, resulting in incorrect refontification.
2025 (add-hook 'before-change-functions 'compilation--flush-parse nil t)
2026 ;; Also for minor mode, since it's not permanent-local.
2027 (add-hook 'change-major-mode-hook #'compilation--remove-properties nil t)
2030 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
2032 (font-lock-fontify-buffer)))
2033 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))))
2035 (defun compilation--unsetup ()
2036 ;; Only for minor mode.
2037 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
2038 (remove-hook 'before-change-functions 'compilation--flush-parse t)
2039 (kill-local-variable 'compilation--parsed)
2040 (compilation--remove-properties)
2042 (font-lock-fontify-buffer)))
2045 (define-minor-mode compilation-shell-minor-mode
2046 "Toggle Compilation Shell minor mode.
2047 With a prefix argument ARG, enable Compilation Shell minor mode
2048 if ARG is positive, and disable it otherwise. If called from
2049 Lisp, enable the mode if ARG is omitted or nil.
2051 When Compilation Shell minor mode is enabled, all the
2052 error-parsing commands of the Compilation major mode are
2053 available but bound to keys that don't collide with Shell mode.
2054 See `compilation-mode'."
2055 nil " Shell-Compile"
2057 (if compilation-shell-minor-mode
2058 (compilation-setup t)
2059 (compilation--unsetup)))
2062 (define-minor-mode compilation-minor-mode
2063 "Toggle Compilation minor mode.
2064 With a prefix argument ARG, enable Compilation minor mode if ARG
2065 is positive, and disable it otherwise. If called from Lisp,
2066 enable the mode if ARG is omitted or nil.
2068 When Compilation minor mode is enabled, all the error-parsing
2069 commands of Compilation major mode are available. See
2070 `compilation-mode'."
2073 (if compilation-minor-mode
2074 (compilation-setup t)
2075 (compilation--unsetup)))
2077 (defun compilation-handle-exit (process-status exit-status msg)
2078 "Write MSG in the current buffer and hack its `mode-line-process'."
2079 (let ((inhibit-read-only t)
2080 (status (if compilation-exit-message-function
2081 (funcall compilation-exit-message-function
2082 process-status exit-status msg)
2083 (cons msg exit-status)))
2086 (cur-buffer (current-buffer)))
2087 ;; Record where we put the message, so we can ignore it later on.
2089 (insert ?\n mode-name " " (car status))
2090 (if (and (numberp compilation-window-height)
2091 (zerop compilation-window-height))
2092 (message "%s" (cdr status)))
2095 (insert " at " (substring (current-time-string) 0 19))
2096 (goto-char (point-max))
2097 ;; Prevent that message from being recognized as a compilation error.
2098 (add-text-properties omax (point)
2099 (append '(compilation-handle-exit t) nil))
2100 (setq mode-line-process
2101 (let ((out-string (format ":%s [%s]" process-status (cdr status)))
2102 (msg (format "%s %s" mode-name
2103 (replace-regexp-in-string "\n?$" ""
2106 (propertize out-string
2108 'face (if (> exit-status 0)
2109 'compilation-mode-line-fail
2110 'compilation-mode-line-exit))))
2111 ;; Force mode line redisplay soon.
2112 (force-mode-line-update)
2113 (if (and opoint (< opoint omax))
2116 (if compilation-finish-function
2117 (funcall compilation-finish-function cur-buffer msg)))
2118 (run-hook-with-args 'compilation-finish-functions cur-buffer msg)))
2120 ;; Called when compilation process changes state.
2121 (defun compilation-sentinel (proc msg)
2122 "Sentinel for compilation buffers."
2123 (if (memq (process-status proc) '(exit signal))
2124 (let ((buffer (process-buffer proc)))
2125 (if (null (buffer-name buffer))
2127 (set-process-buffer proc nil)
2128 (with-current-buffer buffer
2129 ;; Write something in the compilation buffer
2130 ;; and hack its mode line.
2131 (compilation-handle-exit (process-status proc)
2132 (process-exit-status proc)
2134 ;; Since the buffer and mode line will show that the
2135 ;; process is dead, we can delete it now. Otherwise it
2136 ;; will stay around until M-x list-processes.
2137 (delete-process proc)))
2138 (setq compilation-in-progress (delq proc compilation-in-progress)))))
2140 (defun compilation-filter (proc string)
2141 "Process filter for compilation buffers.
2142 Just inserts the text,
2143 handles carriage motion (see `comint-inhibit-carriage-motion'),
2144 and runs `compilation-filter-hook'."
2145 (when (buffer-live-p (process-buffer proc))
2146 (with-current-buffer (process-buffer proc)
2147 (let ((inhibit-read-only t)
2148 ;; `save-excursion' doesn't use the right insertion-type for us.
2149 (pos (copy-marker (point) t))
2150 ;; `save-restriction' doesn't use the right insertion type either:
2151 ;; If we are inserting at the end of the accessible part of the
2152 ;; buffer, keep the inserted text visible.
2153 (min (point-min-marker))
2154 (max (copy-marker (point-max) t))
2155 (compilation-filter-start (marker-position (process-mark proc))))
2159 (goto-char compilation-filter-start)
2160 ;; We used to use `insert-before-markers', so that windows with
2161 ;; point at `process-mark' scroll along with the output, but we
2162 ;; now use window-point-insertion-type instead.
2164 (unless comint-inhibit-carriage-motion
2165 (comint-carriage-motion (process-mark proc) (point)))
2166 (set-marker (process-mark proc) (point))
2167 ;; (set (make-local-variable 'compilation-buffer-modtime)
2169 (run-hooks 'compilation-filter-hook))
2171 (narrow-to-region min max)
2172 (set-marker pos nil)
2173 (set-marker min nil)
2174 (set-marker max nil))))))
2176 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
2177 (defsubst compilation-buffer-internal-p ()
2178 "Test if inside a compilation buffer."
2179 (local-variable-p 'compilation-locs))
2181 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
2182 (defsubst compilation-buffer-p (buffer)
2183 "Test if BUFFER is a compilation buffer."
2184 (with-current-buffer buffer
2185 (compilation-buffer-internal-p)))
2187 (defmacro compilation-loop (< property-change 1+ error limit)
2191 (or (setq pt (,property-change pt 'compilation-message))
2192 ;; Handle the case where where the first error message is
2193 ;; at the start of the buffer, and n < 0.
2194 (if (or (eq (get-text-property ,limit 'compilation-message)
2195 (get-text-property opt 'compilation-message))
2197 (user-error ,error compilation-error)
2199 ;; prop 'compilation-message usually has 2 changes, on and off, so
2201 (or (setq msg (get-text-property pt 'compilation-message))
2202 (if (setq pt (,property-change pt 'compilation-message nil ,limit))
2203 (setq msg (get-text-property pt 'compilation-message)))
2204 (user-error ,error compilation-error))
2205 (or (< (compilation--message->type msg) compilation-skip-threshold)
2208 (setq last (compilation--loc->file-struct
2209 (compilation--message->loc msg))))
2211 (if compilation-skip-visited
2212 (compilation--loc->visited (compilation--message->loc msg)))
2213 (if compilation-skip-to-next-location
2214 (eq (compilation--message->loc msg) loc))
2215 ;; count this message only if none of the above are true
2216 (setq n (,1+ n))))))
2218 (defun compilation-next-single-property-change (position prop
2219 &optional object limit)
2222 ;; We parse the buffer here "on-demand" by chunks of 500 chars.
2223 ;; But we could also just parse the whole buffer.
2224 (compilation--ensure-parse
2225 (setq parsed (max compilation--parsed
2226 (min (+ position 500)
2227 (or limit (point-max))))))
2228 (and (or (not (setq res (next-single-property-change
2229 position prop object limit)))
2231 (< position (or limit (point-max)))))
2232 (setq position parsed))
2235 (defun compilation-next-error (n &optional different-file pt)
2236 "Move point to the next error in the compilation buffer.
2237 This function does NOT find the source line like \\[next-error].
2238 Prefix arg N says how many error messages to move forwards (or
2239 backwards, if negative).
2240 Optional arg DIFFERENT-FILE, if non-nil, means find next error for a
2241 file that is different from the current one.
2242 Optional arg PT, if non-nil, specifies the value of point to start
2243 looking for the next message."
2245 (or (compilation-buffer-p (current-buffer))
2246 (error "Not in a compilation buffer"))
2247 (or pt (setq pt (point)))
2248 (let* ((msg (get-text-property pt 'compilation-message))
2249 ;; `loc', `msg', and `last' are used by the compilation-loop macro.
2250 (loc (and msg (compilation--message->loc msg)))
2253 (unless (or msg ; find message near here
2254 (setq msg (get-text-property (max (1- pt) (point-min))
2255 'compilation-message)))
2256 (setq pt (previous-single-property-change pt 'compilation-message nil
2257 (line-beginning-position)))
2258 (unless (setq msg (get-text-property (max (1- pt) (point-min))
2259 'compilation-message))
2260 (setq pt (next-single-property-change pt 'compilation-message nil
2261 (line-end-position)))
2262 (or (setq msg (get-text-property pt 'compilation-message))
2263 (setq pt (point)))))
2264 (setq last (compilation--loc->file-struct loc))
2266 (compilation-loop > compilation-next-single-property-change 1-
2267 (if (get-buffer-process (current-buffer))
2269 "Moved past last %s")
2271 (compilation--ensure-parse pt)
2272 ;; Don't move "back" to message at or before point.
2273 ;; Pass an explicit (point-min) to make sure pt is non-nil.
2274 (setq pt (previous-single-property-change
2275 pt 'compilation-message nil (point-min)))
2276 (compilation-loop < previous-single-property-change 1+
2277 "Moved back before first %s" (point-min))))
2280 (error "No %s here" compilation-error))))
2282 (defun compilation-previous-error (n)
2283 "Move point to the previous error in the compilation buffer.
2284 Prefix arg N says how many error messages to move backwards (or
2285 forwards, if negative).
2286 Does NOT find the source line like \\[previous-error]."
2288 (compilation-next-error (- n)))
2290 (defun compilation-next-file (n)
2291 "Move point to the next error for a different file than the current one.
2292 Prefix arg N says how many files to move forwards (or backwards, if negative)."
2294 (compilation-next-error n t))
2296 (defun compilation-previous-file (n)
2297 "Move point to the previous error for a different file than the current one.
2298 Prefix arg N says how many files to move backwards (or forwards, if negative)."
2300 (compilation-next-file (- n)))
2302 (defun kill-compilation ()
2303 "Kill the process made by the \\[compile] or \\[grep] commands."
2305 (let ((buffer (compilation-find-buffer)))
2306 (if (get-buffer-process buffer)
2307 (interrupt-process (get-buffer-process buffer))
2308 (error "The %s process is not running" (downcase mode-name)))))
2310 (defalias 'compile-mouse-goto-error 'compile-goto-error)
2312 (defun compile-goto-error (&optional event)
2313 "Visit the source for the error message at point.
2314 Use this command in a compilation log buffer. Sets the mark at point there."
2315 (interactive (list last-input-event))
2316 (if event (posn-set-point (event-end event)))
2317 (or (compilation-buffer-p (current-buffer))
2318 (error "Not in a compilation buffer"))
2319 (compilation--ensure-parse (point))
2320 (if (get-text-property (point) 'compilation-directory)
2322 (car (get-text-property (point) 'compilation-directory)))
2324 (setq compilation-current-error (point))
2325 (next-error-internal)))
2327 ;; This is mostly unused, but we keep it for the sake of some external
2328 ;; packages which seem to make use of it.
2329 (defun compilation-find-buffer (&optional avoid-current)
2330 "Return a compilation buffer.
2331 If AVOID-CURRENT is nil, and the current buffer is a compilation buffer,
2332 return it. If AVOID-CURRENT is non-nil, return the current buffer only
2334 (if (and (compilation-buffer-internal-p) (not avoid-current))
2336 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)))
2339 (defun compilation-next-error-function (n &optional reset)
2340 "Advance to the next error message and visit the file where the error was.
2341 This is the value of `next-error-function' in Compilation buffers."
2344 (setq compilation-current-error nil))
2345 (let* ((screen-columns compilation-error-screen-columns)
2346 (first-column compilation-first-column)
2348 (msg (compilation-next-error (or n 1) nil
2349 (or compilation-current-error
2350 compilation-messages-start
2352 (loc (compilation--message->loc msg))
2353 (end-loc (compilation--message->end-loc msg))
2354 (marker (point-marker)))
2355 (setq compilation-current-error (point-marker)
2356 overlay-arrow-position
2358 compilation-current-error
2359 (copy-marker (line-beginning-position))))
2360 ;; If loc contains no marker, no error in that file has been visited.
2361 ;; If the marker is invalid the buffer has been killed.
2362 ;; So, recalculate all markers for that file.
2363 (unless (and (compilation--loc->marker loc)
2364 (marker-buffer (compilation--loc->marker loc))
2365 ;; FIXME-omake: For "omake -P", which automatically recompiles
2366 ;; when the file is modified, the line numbers of new output
2367 ;; may not be related to line numbers from earlier output
2368 ;; (earlier markers), so we used to try to detect it here and
2369 ;; force a reparse. But that caused more problems elsewhere,
2370 ;; so instead we now flush the file-structure when we see
2371 ;; omake's message telling it's about to recompile a file.
2372 ;; (or (null (compilation--loc->timestamp loc)) ;A fake-loc
2373 ;; (equal (compilation--loc->timestamp loc)
2374 ;; (setq timestamp compilation-buffer-modtime)))
2376 (with-current-buffer
2377 (compilation-find-file
2379 (caar (compilation--loc->file-struct loc))
2380 (cadr (car (compilation--loc->file-struct loc))))
2381 (let ((screen-columns
2382 ;; Obey the compilation-error-screen-columns of the target
2383 ;; buffer if its major mode set it buffer-locally.
2384 (if (local-variable-p 'compilation-error-screen-columns)
2385 compilation-error-screen-columns screen-columns))
2386 (compilation-first-column
2387 (if (local-variable-p 'compilation-first-column)
2388 compilation-first-column first-column)))
2391 (goto-char (point-min))
2392 ;; Treat file's found lines in forward order, 1 by 1.
2393 (dolist (line (reverse (cddr (compilation--loc->file-struct loc))))
2394 (when (car line) ; else this is a filename w/o a line#
2395 (beginning-of-line (- (car line) last -1))
2396 (setq last (car line)))
2397 ;; Treat line's found columns and store/update a marker for each.
2398 (dolist (col (cdr line))
2399 (if (compilation--loc->col col)
2400 (if (eq (compilation--loc->col col) -1)
2401 ;; Special case for range end.
2403 (compilation-move-to-column (compilation--loc->col col)
2406 (skip-chars-forward " \t"))
2407 (if (compilation--loc->marker col)
2408 (set-marker (compilation--loc->marker col) (point))
2409 (setf (compilation--loc->marker col) (point-marker)))
2410 ;; (setf (compilation--loc->timestamp col) timestamp)
2412 (compilation-goto-locus marker (compilation--loc->marker loc)
2413 (compilation--loc->marker end-loc))
2414 (setf (compilation--loc->visited loc) t)))
2416 (defvar compilation-gcpro nil
2417 "Internal variable used to keep some values from being GC'd.")
2418 (make-variable-buffer-local 'compilation-gcpro)
2420 (defun compilation-fake-loc (marker file &optional line col)
2421 "Preassociate MARKER with FILE.
2422 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
2423 This is useful when you compile temporary files, but want
2424 automatic translation of the messages to the real buffer from
2425 which the temporary file came. This may also affect previous messages
2428 Optional args LINE and COL default to 1 and beginning of
2429 indentation respectively. The marker is expected to reflect
2430 this. In the simplest case the marker points to the first line
2431 of the region that was saved to the temp file.
2433 If you concatenate several regions into the temp file (e.g. a
2434 header with variable assignments and a code region), you must
2435 call this several times, once each for the last line of one
2436 region and the first line of the next region."
2437 (or (consp file) (setq file (list file)))
2438 (compilation--flush-file-structure file)
2439 (let ((fs (compilation-get-file-structure file)))
2440 ;; Between the current call to compilation-fake-loc and the first
2441 ;; occurrence of an error message referring to `file', the data is
2442 ;; only kept in the weak hash-table compilation-locs, so we need
2443 ;; to prevent this entry in compilation-locs from being GC'd
2445 (push fs compilation-gcpro)
2446 (let ((loc (compilation-assq (or line 1) (cdr fs))))
2447 (setq loc (compilation-assq col loc))
2448 (cl-assert (null (cdr loc)))
2449 (setcdr loc (compilation--make-cdrloc line fs marker))
2452 (defcustom compilation-context-lines nil
2453 "Display this many lines of leading context before the current message.
2454 If nil and the left fringe is displayed, don't scroll the
2455 compilation output window; an arrow in the left fringe points to
2456 the current message. If nil and there is no left fringe, the message
2457 displays at the top of the window; there is no arrow."
2458 :type '(choice integer (const :tag "No window scrolling" nil))
2462 (defsubst compilation-set-window (w mk)
2463 "Align the compilation output window W with marker MK near top."
2464 (if (integerp compilation-context-lines)
2465 (set-window-start w (save-excursion
2468 (- 1 compilation-context-lines))
2470 ;; If there is no left fringe.
2471 (if (equal (car (window-fringes)) 0)
2472 (set-window-start w (save-excursion
2474 (beginning-of-line 1)
2476 (set-window-point w mk))
2478 (defvar next-error-highlight-timer)
2480 (defun compilation-goto-locus (msg mk end-mk)
2481 "Jump to an error corresponding to MSG at MK.
2482 All arguments are markers. If END-MK is non-nil, mark is set there
2483 and overlay is highlighted between MK and END-MK."
2484 ;; Show compilation buffer in other window, scrolled to this error.
2485 (let* ((from-compilation-buffer (eq (window-buffer (selected-window))
2486 (marker-buffer msg)))
2487 ;; Use an existing window if it is in a visible frame.
2488 (pre-existing (get-buffer-window (marker-buffer msg) 0))
2489 (w (if (and from-compilation-buffer pre-existing)
2490 ;; Calling display-buffer here may end up (partly) hiding
2491 ;; the error location if the two buffers are in two
2492 ;; different frames. So don't do it if it's not necessary.
2494 (display-buffer (marker-buffer msg))))
2495 (highlight-regexp (with-current-buffer (marker-buffer msg)
2496 ;; also do this while we change buffer
2497 (compilation-set-window w msg)
2498 compilation-highlight-regexp)))
2499 ;; Ideally, the window-size should be passed to `display-buffer'
2500 ;; so it's only used when creating a new window.
2501 (unless pre-existing (compilation-set-window-height w))
2503 (if from-compilation-buffer
2504 ;; If the compilation buffer window was selected,
2505 ;; keep the compilation buffer in this window;
2506 ;; display the source in another window.
2507 (let ((pop-up-windows t))
2508 (pop-to-buffer (marker-buffer mk) 'other-window))
2509 (switch-to-buffer (marker-buffer mk)))
2510 (unless (eq (goto-char mk) (point))
2511 ;; If narrowing gets in the way of going to the right place, widen.
2513 (if next-error-move-function
2514 (funcall next-error-move-function msg mk)
2517 (push-mark end-mk t)
2518 (if mark-active (setq mark-active)))
2519 ;; If hideshow got in the way of
2520 ;; seeing the right place, open permanently.
2521 (dolist (ov (overlays-at (point)))
2522 (when (eq 'hs (overlay-get ov 'invisible))
2526 (when highlight-regexp
2527 (if (timerp next-error-highlight-timer)
2528 (cancel-timer next-error-highlight-timer))
2529 (unless compilation-highlight-overlay
2530 (setq compilation-highlight-overlay
2531 (make-overlay (point-min) (point-min)))
2532 (overlay-put compilation-highlight-overlay 'face 'next-error))
2533 (with-current-buffer (marker-buffer mk)
2535 (if end-mk (goto-char end-mk) (end-of-line))
2536 (let ((end (point)))
2537 (if mk (goto-char mk) (beginning-of-line))
2538 (if (and (stringp highlight-regexp)
2539 (re-search-forward highlight-regexp end t))
2541 (goto-char (match-beginning 0))
2542 (move-overlay compilation-highlight-overlay
2543 (match-beginning 0) (match-end 0)
2545 (move-overlay compilation-highlight-overlay
2546 (point) end (current-buffer)))
2547 (if (or (eq next-error-highlight t)
2548 (numberp next-error-highlight))
2549 ;; We want highlighting: delete overlay on next input.
2550 (add-hook 'pre-command-hook
2551 'compilation-goto-locus-delete-o)
2552 ;; We don't want highlighting: delete overlay now.
2553 (delete-overlay compilation-highlight-overlay))
2554 ;; We want highlighting for a limited time:
2555 ;; set up a timer to delete it.
2556 (when (numberp next-error-highlight)
2557 (setq next-error-highlight-timer
2558 (run-at-time next-error-highlight nil
2559 'compilation-goto-locus-delete-o)))))))
2560 (when (and (eq next-error-highlight 'fringe-arrow))
2561 ;; We want a fringe arrow (instead of highlighting).
2562 (setq next-error-overlay-arrow-position
2563 (copy-marker (line-beginning-position))))))
2565 (defun compilation-goto-locus-delete-o ()
2566 (delete-overlay compilation-highlight-overlay)
2567 ;; Get rid of timer and hook that would try to do this again.
2568 (if (timerp next-error-highlight-timer)
2569 (cancel-timer next-error-highlight-timer))
2570 (remove-hook 'pre-command-hook
2571 'compilation-goto-locus-delete-o))
2573 (defun compilation-find-file (marker filename directory &rest formats)
2574 "Find a buffer for file FILENAME.
2575 If FILENAME is not found at all, ask the user where to find it.
2576 Pop up the buffer containing MARKER and scroll to MARKER if we ask
2577 the user where to find the file.
2578 Search the directories in `compilation-search-path'.
2579 A nil in `compilation-search-path' means to try the
2580 \"current\" directory, which is passed in DIRECTORY.
2581 If DIRECTORY is relative, it is combined with `default-directory'.
2582 If DIRECTORY is nil, that means use `default-directory'.
2583 FORMATS, if given, is a list of formats to reformat FILENAME when
2584 looking for it: for each element FMT in FORMATS, this function
2585 attempts to find a file whose name is produced by (format FMT FILENAME)."
2586 (or formats (setq formats '("%s")))
2587 (let ((dirs compilation-search-path)
2588 (spec-dir (if directory
2589 (expand-file-name directory)
2591 buffer thisdir fmts name)
2592 (if (file-name-absolute-p filename)
2593 ;; The file name is absolute. Use its explicit directory as
2594 ;; the first in the search path, and strip it from FILENAME.
2595 (setq filename (abbreviate-file-name (expand-file-name filename))
2596 dirs (cons (file-name-directory filename) dirs)
2597 filename (file-name-nondirectory filename)))
2598 ;; Now search the path.
2599 (while (and dirs (null buffer))
2600 (setq thisdir (or (car dirs) spec-dir)
2602 ;; For each directory, try each format string.
2603 (while (and fmts (null buffer))
2604 (setq name (expand-file-name (format (car fmts) filename) thisdir)
2605 buffer (and (file-exists-p name)
2606 (find-file-noselect name))
2608 (setq dirs (cdr dirs)))
2609 (while (null buffer) ;Repeat until the user selects an existing file.
2610 ;; The file doesn't exist. Ask the user where to find it.
2611 (save-excursion ;This save-excursion is probably not right.
2612 (let ((pop-up-windows t))
2613 (compilation-set-window (display-buffer (marker-buffer marker))
2615 (let* ((name (read-file-name
2616 (format "Find this %s in (default %s): "
2617 compilation-error filename)
2618 spec-dir filename t nil
2619 ;; The predicate below is fine when called from
2620 ;; minibuffer-complete-and-exit, but it's too
2621 ;; restrictive otherwise, since it also prevents the
2622 ;; user from completing "fo" to "foo/" when she
2623 ;; wants to enter "foo/bar".
2625 ;; Try to make sure the user can only select
2626 ;; a valid answer. This predicate may be ignored,
2627 ;; tho, so we still have to double-check afterwards.
2628 ;; TODO: We should probably fix read-file-name so
2629 ;; that it never ignores this predicate, even when
2630 ;; using popup dialog boxes.
2632 ;; (if (file-directory-p name)
2633 ;; (setq name (expand-file-name filename name)))
2634 ;; (file-exists-p name))
2638 ((not (file-exists-p name))
2639 (message "Cannot find file `%s'" name)
2641 ((and (file-directory-p name)
2643 (setq name (expand-file-name filename name)))))
2644 (message "No `%s' in directory %s" filename origname)
2647 (setq buffer (find-file-noselect name))))))))
2648 ;; Make intangible overlays tangible.
2649 ;; This is weird: it's not even clear which is the current buffer,
2650 ;; so the code below can't be expected to DTRT here. -- Stef
2651 (dolist (ov (overlays-in (point-min) (point-max)))
2652 (when (overlay-get ov 'intangible)
2653 (overlay-put ov 'intangible nil)))
2656 (defun compilation-get-file-structure (file &optional fmt)
2657 "Retrieve FILE's file-structure or create a new one.
2658 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
2659 In the former case, FILENAME may be relative or absolute.
2661 The file-structure looks like this:
2662 ((FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)"
2663 (or (gethash file compilation-locs)
2664 ;; File was not previously encountered, at least not in the form passed.
2665 ;; Let's normalize it and look again.
2666 (let ((filename (car file))
2667 ;; Get the specified directory from FILE.
2668 (spec-directory (if (cdr file)
2669 (file-truename (cdr file)))))
2671 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2672 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2674 (when (and (boundp 'comint-file-name-prefix)
2675 (not (equal comint-file-name-prefix "")))
2676 (if (file-name-absolute-p filename)
2678 (concat comint-file-name-prefix filename))
2680 (setq spec-directory
2682 (concat comint-file-name-prefix spec-directory))))))
2684 ;; If compilation-parse-errors-filename-function is
2685 ;; defined, use it to process the filename.
2686 (when compilation-parse-errors-filename-function
2688 (funcall compilation-parse-errors-filename-function
2691 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
2692 ;; file names like "./bar//foo.c" for file "bar/foo.c";
2693 ;; expand-file-name will collapse these into "/foo.c" and fail to find
2694 ;; the appropriate file. So we look for doubled slashes in the file
2695 ;; name and fix them.
2696 (setq filename (command-line-normalize-file-name filename))
2698 ;; Store it for the possibly unnormalized name
2700 ;; Retrieve or create file-structure for normalized name
2701 ;; The gethash used to not use spec-directory, but
2702 ;; this leads to errors when files in different
2703 ;; directories have the same name:
2704 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00463.html
2705 (or (gethash (cons filename spec-directory) compilation-locs)
2706 (puthash (cons filename spec-directory)
2707 (compilation--make-file-struct
2708 (list filename spec-directory) fmt)
2710 compilation-locs))))
2712 (defun compilation--flush-file-structure (file)
2713 (or (consp file) (setq file (list file)))
2714 (let ((fs (compilation-get-file-structure file)))
2715 (cl-assert (eq fs (gethash file compilation-locs)))
2716 (cl-assert (eq fs (gethash (cons (caar fs) (cadr (car fs)))
2718 (maphash (lambda (k v)
2719 (if (eq v fs) (remhash k compilation-locs)))
2722 ;;; Compatibility with the old compile.el.
2724 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
2725 (defvar compilation-parsing-end (make-marker))
2726 (defvar compilation-error-list nil)
2727 (defvar compilation-old-error-list nil)
2729 (defun compilation--compat-error-properties (err)
2730 "Map old-style error ERR to new-style message."
2731 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
2732 ;; (MARKER . MARKER).
2733 (let ((dst (cdr err)))
2735 `(compilation-message ,(compilation--make-message
2736 (cons nil (compilation--make-cdrloc
2739 help-echo "mouse-2: visit the source location"
2740 keymap compilation-button-map
2741 mouse-face highlight)
2742 ;; Too difficult to do it by hand: dispatch to the normal code.
2743 (let* ((file (pop dst))
2746 (filename (pop file))
2747 (dirname (pop file))
2749 (compilation-internal-error-properties
2750 (cons filename dirname) line nil col nil 2 fmt)))))
2752 (defun compilation--compat-parse-errors (limit)
2753 (when compilation-parse-errors-function
2754 ;; FIXME: We should remove the rest of the compilation keywords
2755 ;; but we can't do that from here because font-lock is using
2756 ;; the value right now. --Stef
2758 (setq compilation-error-list nil)
2759 ;; Reset compilation-parsing-end each time because font-lock
2760 ;; might force us the re-parse many times (typically because
2761 ;; some code adds some text-property to the output that we
2762 ;; already parsed). You might say "why reparse", well:
2763 ;; because font-lock has just removed the `compilation-message' property
2764 ;; so have to do it all over again.
2765 (if compilation-parsing-end
2766 (set-marker compilation-parsing-end (point))
2767 (setq compilation-parsing-end (point-marker)))
2769 ;; Ignore any error: we're calling this function earlier than
2770 ;; in the old compile.el so things might not all be setup yet.
2771 (funcall compilation-parse-errors-function limit nil)
2773 (dolist (err (if (listp compilation-error-list) compilation-error-list))
2774 (let* ((src (car err))
2776 (loc (cond ((markerp dst)
2778 (compilation--make-cdrloc nil nil dst)))
2781 (compilation--make-cdrloc
2783 (cons (cdar dst) (caar dst))
2787 ;; (put-text-property src (line-end-position)
2788 ;; 'font-lock-face 'font-lock-warning-face)
2789 (put-text-property src (line-end-position)
2790 'compilation-message
2791 (compilation--make-message loc 2 nil)))))))
2795 ;; Beware! this is not only compatibility code. New code also uses it. --Stef
2796 (defun compilation-forget-errors ()
2797 ;; In case we hit the same file/line specs, we want to recompute a new
2798 ;; marker for them, so flush our cache.
2799 (clrhash compilation-locs)
2800 (setq compilation-gcpro nil)
2801 ;; FIXME: the old code reset the directory-stack, so maybe we should
2802 ;; put a `directory change' marker of some sort, but where? -stef
2804 ;; FIXME: The old code moved compilation-current-error (which was
2805 ;; virtually represented by a mix of compilation-parsing-end and
2806 ;; compilation-error-list) to point-min, but that was only meaningful for
2807 ;; the internal uses of compilation-forget-errors: all calls from external
2808 ;; packages seem to be followed by a move of compilation-parsing-end to
2809 ;; something equivalent to point-max. So we heuristically move
2810 ;; compilation-current-error to point-max (since the external package
2811 ;; won't know that it should do it). --Stef
2812 (setq compilation-current-error nil)
2813 (let* ((proc (get-buffer-process (current-buffer)))
2814 (mark (if proc (process-mark proc)))
2815 (pos (or mark (point-max))))
2816 (setq compilation-messages-start
2817 ;; In the future, ignore the text already present in the buffer.
2818 ;; Since many process filter functions insert before markers,
2819 ;; we need to put ours just before the insertion point rather
2820 ;; than at the insertion point. If that's not possible, then
2821 ;; don't use a marker. --Stef
2822 (if (> pos (point-min)) (copy-marker (1- pos)) pos)))
2823 ;; Again, since this command is used in buffers that contain several
2824 ;; compilations, to set the beginning of "this compilation", it's a good
2825 ;; place to reset compilation-auto-jump-to-next.
2826 (set (make-local-variable 'compilation-auto-jump-to-next)
2827 (or compilation-auto-jump-to-first-error
2828 (eq compilation-scroll-output 'first-error))))
2832 ;;; compile.el ends here