1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1993-1999, 2001-2017 Free Software
6 ;; Authors: Roland McGrath <roland@gnu.org>,
7 ;; Daniel Pfeiffer <occitan@esperanto.org>
8 ;; Maintainer: emacs-devel@gnu.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/lisp/progmodes/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]*\\(\\(?:[A-Za-z]:\\\\\\)?[^: \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 "^CMake \\(?:Error\\|\\(Warning\\)\\) at \\(.*\\):\\([1-9][0-9]*\\) ([^)]+):$"
168 "^ \\(?: \\*\\)?\\(.*\\):\\([1-9][0-9]*\\) ([^)]+)$"
172 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
173 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
176 "\\(?:^cucumber\\(?: -p [^[:space:]]+\\)?\\|#\\)\
177 \\(?: \\)\\([^(].*\\):\\([1-9][0-9]*\\)" 1 2)
180 ;; Must be before edg-1, so that MSVC's longer messages are
181 ;; considered before EDG.
182 ;; The message may be a "warning", "error", or "fatal error" with
183 ;; an error code, or "see declaration of" without an error code.
184 "^ *\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) ?\
185 : \\(?:see declaration\\|\\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:\\)"
189 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
192 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
196 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
199 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
203 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
207 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
208 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 .
5))
210 ;; fixme: should be `mips'
212 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
213 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil
(1 .
2))
216 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil
(1))
219 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil
0)
222 ;; This used to be pathologically slow on long lines (Bug#3441),
223 ;; due to matching filenames via \\(.*?\\). This might be faster.
225 ;; Maven is a popular free software build tool for Java.
226 "\\(\\[WARNING\\] *\\)?\\([^ \n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\):\\[\\([0-9]+\\),\\([0-9]+\\)\\] " 2 3 4 (1))
229 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
231 (2 (compilation-face '(3))))
234 ,(rx bol
"In file included from "
235 (group (+ (not (any ?
\n ?
:)))) ?
:
236 (group (+ (any (?
0 . ?
9)))) ?
:
241 "^\\(?:In file included \\| \\|\t\\)from \
242 \\([0-9]*[^0-9\n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\):\
243 \\([0-9]+\\)\\(?::\\([0-9]+\\)\\)?\\(?:\\(:\\)\\|\\(,\\|$\\)\\)?"
247 "^[\t ]*\\[\\([^(].*\\):\\([1-9][0-9]*\\)\\(\\]\\)?:in " 1 2)
250 ;; The first line matches the program name for
252 ;; PROGRAM:SOURCE-FILE-NAME:LINENO: MESSAGE
254 ;; format, which is used for non-interactive programs other than
255 ;; compilers (e.g. the "jade:" entry in compilation.txt).
257 ;; This first line makes things ambiguous with output such as
258 ;; "foo:344:50:blabla" since the "foo" part can match this first
259 ;; line (in which case the file name as "344"). To avoid this,
260 ;; the second line disallows filenames exclusively composed of
263 ;; Similarly, we get lots of false positives with messages including
264 ;; times of the form "HH:MM:SS" where MM is taken as a line number, so
265 ;; the last line tries to rule out message where the info after the
266 ;; line number starts with "SS". --Stef
268 ;; The core of the regexp is the one with *?. It says that a file name
269 ;; can be composed of any non-newline char, but it also rules out some
270 ;; valid but unlikely cases, such as a trailing space or a space
271 ;; followed by a -, or a colon followed by a space.
273 ;; The "in \\|from " exception was added to handle messages from Ruby.
276 (?
(|
(regexp "[[:alpha:]][-[:alnum:].]+: ?")
277 (regexp "[ \t]+\\(?:in \\|from\\)")))
278 (group-n 1 (: (regexp "[0-9]*[^0-9\n]")
279 (*?
(|
(regexp "[^\n :]")
281 (regexp ":[^ \n]")))))
283 (group-n 2 (regexp "[0-9]+"))
285 (group-n 4 (regexp "[0-9]+"))
286 (?
"." (group-n 5 (regexp "[0-9]+"))))
288 (group-n 3 (regexp "[0-9]+"))
290 (?
(group-n 4 (regexp "[0-9]+")) ".")
291 (group-n 5 (regexp "[0-9]+"))))))
294 (group-n 6 (|
"FutureWarning"
300 (group-n 7 (|
(regexp "[Ii]nfo\\(?:\\>\\|rmationa?l?\\)")
302 (: "[ skipping " (+ ".") " ]")
305 (regexp "[Nn]ote"))))
309 (|
(regexp "[^0-9\n]")
311 (regexp "[0-9][0-9][0-9]")))
312 1 (2 .
4) (3 .
5) (6 .
7))
315 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
319 "^makepp\\(?:\\(?:: warning\\(:\\).*?\\|\\(: Scanning\\|: [LR]e?l?oading makefile\\|: Imported\\|log:.*?\\) \\|: .*?\\)\
320 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
322 (0 (progn (save-match-data
323 (compilation-parse-errors
324 (match-end 0) (line-end-position)
325 `("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]"
327 ,(cond ((match-end 1) 1) ((match-end 2) 0) (t 2))
332 ;; Should be lint-1, lint-2 (SysV lint)
334 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
336 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
339 ;; The message may be a "warning", "error", or "fatal error" with
340 ;; an error code, or "see declaration of" without an error code.
341 "^ *\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
342 : \\(?:see declaration\\|\\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:\\)"
346 ;; "omake -P" reports "file foo changed"
347 ;; (useful if you do "cvs up" and want to see what has changed)
348 "omake: file \\(.*\\) changed" 1 nil nil nil nil
349 ;; FIXME-omake: This tries to prevent reusing pre-existing markers
350 ;; for subsequent messages, since those messages's line numbers
351 ;; are about another version of the file.
352 (0 (progn (compilation--flush-file-structure (match-string 1))
356 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
357 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
358 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
361 ;; "during global destruction": This comes out under "use
362 ;; warnings" in recent perl when breaking circular references
363 ;; during program or thread exit.
365 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\| \
366 during global destruction\\.$\\)" 1 2)
369 "\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)"
373 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
374 \\([0-9]+\\) of file://\\(.+\\)"
378 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
379 [12][09][0-9][0-9] +\\(.*\\):$"
382 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
383 nil
3 nil
(2) nil
(1 (compilation-face '(2))))
384 (sparc-pascal-example
385 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
386 nil
1 nil
(3) nil
(2 (compilation-face '(3))))
389 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
390 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
394 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., (-]" 1 2 3)
397 "^[ \t]*\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)): ?\
398 \\(?:\\(Error! E[0-9]+\\)\\|\\(Warning! W[0-9]+\\)\\):"
402 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
403 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil
(3))
406 "^ *-: *\\(0\\):Source:\\(.+\\)$"
409 "^ *-: *\\(0\\):\\(?:Object\\|Graph\\|Data\\|Runs\\|Programs\\):.+$"
411 ;; Underlines over all lines of gcov output are too uncomfortable to read.
412 ;; However, hyperlinks embedded in the lines are useful.
413 ;; So I put default face on the lines; and then put
414 ;; compilation-*-face by manually to eliminate the underlines.
415 ;; The hyperlinks are still effective.
417 "^ *-: *\\([1-9]\\|[0-9]\\{2,\\}\\):.*$"
420 (1 compilation-line-face
))
422 "^ *\\([0-9]+\\): *\\([0-9]+\\):.*$"
425 (1 compilation-info-face
) (2 compilation-line-face
))
427 "^ *\\(#####\\): *\\([0-9]+\\):.*$"
430 (1 compilation-error-face
) (2 compilation-line-face
))
433 ;; podchecker error messages, per Pod::Checker.
434 ;; The style is from the Pod::Checker::poderror() function, eg.
435 ;; *** ERROR: Spurious text after =cut at line 193 in file foo.pm
437 ;; Plus end_pod() can give "at line EOF" instead of a
438 ;; number, so for that match "on line N" which is the
439 ;; originating spot, eg.
440 ;; *** ERROR: =over on line 37 without closing =back at line EOF in file bar.pm
442 ;; Plus command() can give both "on line N" and "at line N";
443 ;; the latter is desired and is matched because the .* is
445 ;; *** ERROR: =over on line 1 without closing =back (at head1) at line 3 in file x.pod
447 "^\\*\\*\\* \\(?:ERROR\\|\\(WARNING\\)\\).* \\(?:at\\|on\\) line \
448 \\([0-9]+\\) \\(?:.* \\)?in file \\([^ \t\n]+\\)"
451 ;; perl Test module error messages.
452 ;; Style per the ok() function "$context", eg.
453 ;; # Failed test 1 in foo.t at line 6
455 "^# Failed test [0-9]+ in \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
458 ;; Or when comparing got/want values, with a "fail #n" if repeated
459 ;; # Test 2 got: "xx" (t-compilation-perl-2.t at line 10)
460 ;; # Test 3 got: "xx" (t-compilation-perl-2.t at line 10 fail #2)
462 ;; And under Test::Harness they're preceded by progress stuff with
464 ;; ... NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
466 "^\\(.*NOK.*\\)?# Test [0-9]+ got:.* (\\([^ \t\r\n]+\\) at line \
467 \\([0-9]+\\)\\( fail #[0-9]+\\)?)"
470 ;; perl Test::Harness output, eg.
471 ;; NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
473 ;; Test::Harness is slightly designed for tty output, since
474 ;; it prints CRs to overwrite progress messages, but if you
475 ;; run it in with M-x compile this pattern can at least step
476 ;; through the failures.
478 "^.*NOK.* \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
481 ;; The style comes from HTML::Lint::Error::as_string(), eg.
482 ;; index.html (13:1) Unknown element <fdjsk>
484 ;; The pattern only matches filenames without spaces, since that
485 ;; should be usual and should help reduce the chance of a false
486 ;; match of a message from some unrelated program.
488 ;; This message style is quite close to the "ibm" entry which is
489 ;; for IBM C, though that ibm bit doesn't put a space after the
492 "^\\([^ \t\r\n(]+\\) (\\([0-9]+\\):\\([0-9]+\\)) "
495 ;; Guile compilation yields file-headers in the following format:
497 ;; In sourcefile.scm:
499 ;; We need to catch those, but we also need to be aware that Emacs
500 ;; byte-compilation yields compiler headers in similar form of
506 ;; We want to catch the Guile file-headers but not the Emacs
507 ;; byte-compilation headers, because that will cause next-error
508 ;; and prev-error to break, because the files "toplevel form" and
509 ;; "end of data" does not exist.
511 ;; To differentiate between these two cases, we require that the
512 ;; file-match must always contain an extension.
514 ;; We should also only treat this as "info", not "error", because
515 ;; we do not know what lines will follow.
516 (guile-file "^In \\(.+\\..+\\):\n" 1 nil nil
0)
517 (guile-line "^ *\\([0-9]+\\): *\\([0-9]+\\)" nil
1 2)
519 "Alist of values for `compilation-error-regexp-alist'.")
521 (defcustom compilation-error-regexp-alist
522 (mapcar 'car compilation-error-regexp-alist-alist
)
523 "Alist that specifies how to match errors in compiler output.
524 On GNU and Unix, any string is a valid filename, so these
525 matchers must make some common sense assumptions, which catch
526 normal cases. A shorter list will be lighter on resource usage.
528 Instead of an alist element, you can use a symbol, which is
529 looked up in `compilation-error-regexp-alist-alist'. You can see
530 the predefined symbols and their effects in the file
531 `etc/compilation.txt' (linked below if you are customizing this).
533 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
534 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
535 gives the file name, and the LINE'th subexpression gives the line
536 number. The COLUMN'th subexpression gives the column number on
539 If FILE, LINE or COLUMN are nil or that index didn't match, that
540 information is not present on the matched line. In that case the
541 file name is assumed to be the same as the previous one in the
542 buffer, line number defaults to 1 and column defaults to
543 beginning of line's indentation.
545 FILE can also have the form (FILE FORMAT...), where the FORMATs
546 \(e.g. \"%s.c\") will be applied in turn to the recognized file
547 name, until a file of that name is found. Or FILE can also be a
548 function that returns (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
549 In the former case, FILENAME may be relative or absolute.
551 LINE can also be of the form (LINE . END-LINE) meaning a range
552 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
553 meaning a range of columns starting on LINE and ending on
554 END-LINE, if that matched.
556 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
557 TYPE can also be of the form (WARNING . INFO). In that case this
558 will be equivalent to 1 if the WARNING'th subexpression matched
559 or else equivalent to 0 if the INFO'th subexpression matched.
560 See `compilation-error-face', `compilation-warning-face',
561 `compilation-info-face' and `compilation-skip-threshold'.
563 What matched the HYPERLINK'th subexpression has `mouse-face' and
564 `compilation-message-face' applied. If this is nil, the text
565 matched by the whole REGEXP becomes the hyperlink.
567 Additional HIGHLIGHTs take the shape (SUBMATCH FACE), where
568 SUBMATCH is the number of a submatch and FACE is an expression
569 which evaluates to a face name (a symbol or string).
570 Alternatively, FACE can evaluate to a property list of the
571 form (face FACE PROP1 VAL1 PROP2 VAL2 ...), in which case all the
572 listed text properties PROP# are given values VAL# as well."
573 :type
'(repeat (choice (symbol :tag
"Predefined symbol")
574 (sexp :tag
"Error specification")))
575 :link
`(file-link :tag
"example file"
576 ,(expand-file-name "compilation.txt" data-directory
))
579 ;;;###autoload(put 'compilation-directory 'safe-local-variable 'stringp)
580 (defvar compilation-directory nil
581 "Directory to restore to when doing `recompile'.")
583 (defvar compilation-directory-matcher
584 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory [`']\\(.+\\)'$" (2 .
1))
585 "A list for tracking when directories are entered or left.
586 If nil, do not track directories, e.g. if all file names are absolute. The
587 first element is the REGEXP matching these messages. It can match any number
588 of variants, e.g. different languages. The remaining elements are all of the
589 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
590 matches, that is a directory name. If LEAVE is nil or the corresponding
591 LEAVE'th subexpression doesn't match, this message is about going into another
592 directory. If it does match anything, this message is about going back to the
593 directory we were in before the last entering message. If you change this,
594 you may also want to change `compilation-page-delimiter'.")
596 (defvar compilation-page-delimiter
597 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory [`'].+'\n\\)+"
598 "Value of `page-delimiter' in Compilation mode.")
600 (defvar compilation-mode-font-lock-keywords
601 '(;; configure output lines.
602 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
603 (1 font-lock-variable-name-face
)
604 (2 (compilation-face '(4 .
3))))
605 ;; Command output lines. Recognize `make[n]:' lines too.
606 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
607 (1 font-lock-function-name-face
) (3 compilation-line-face nil t
))
608 (" --?o\\(?:utfile\\|utput\\)?[= ]\\(\\S +\\)" .
1)
609 ("^Compilation \\(finished\\).*"
610 (0 '(face nil compilation-message nil help-echo nil mouse-face nil
) t
)
611 (1 compilation-info-face
))
612 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\|segmentation fault\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
613 (0 '(face nil compilation-message nil help-echo nil mouse-face nil
) t
)
614 (1 compilation-error-face
)
615 (2 compilation-error-face nil t
)))
616 "Additional things to highlight in Compilation mode.
617 This gets tacked on the end of the generated expressions.")
619 (defvar compilation-highlight-regexp t
620 "Regexp matching part of visited source lines to highlight temporarily.
621 Highlight entire line if t; don't highlight source lines if nil.")
623 (defvar compilation-highlight-overlay nil
624 "Overlay used to temporarily highlight compilation matches.")
626 (defcustom compilation-error-screen-columns t
627 "If non-nil, column numbers in error messages are screen columns.
628 Otherwise they are interpreted as character positions, with
629 each character occupying one column.
630 The default is to use screen columns, which requires that the compilation
631 program and Emacs agree about the display width of the characters,
632 especially the TAB character.
633 If this is buffer-local in the destination buffer, Emacs obeys
634 that value, otherwise it uses the value in the *compilation*
635 buffer. This enables a major-mode to specify its own value."
640 (defcustom compilation-read-command t
641 "Non-nil means \\[compile] reads the compilation command to use.
642 Otherwise, \\[compile] just uses the value of `compile-command'.
644 Note that changing this to nil may be a security risk, because a
645 file might define a malicious `compile-command' as a file local
646 variable, and you might not notice. Therefore, `compile-command'
647 is considered unsafe if this variable is nil."
652 (defcustom compilation-ask-about-save t
653 "Non-nil means \\[compile] asks which buffers to save before compiling.
654 Otherwise, it saves all modified buffers without asking."
658 (defcustom compilation-save-buffers-predicate nil
659 "The second argument (PRED) passed to `save-some-buffers' before compiling.
660 E.g., one can set this to
662 (string-prefix-p my-compilation-root (file-truename (buffer-file-name))))
663 to limit saving to files located under `my-compilation-root'.
664 Note, that, in general, `compilation-directory' cannot be used instead
665 of `my-compilation-root' here."
667 (const :tag
"Default (save all file-visiting buffers)" nil
)
668 (const :tag
"Save all buffers" t
)
674 (defcustom compilation-search-path
'(nil)
675 "List of directories to search for source files named in error messages.
676 Elements should be directory names, not file names of directories.
677 The value nil as an element means to try the default directory."
678 :type
'(repeat (choice (const :tag
"Default" nil
)
679 (string :tag
"Directory")))
683 (defcustom compile-command
(purecopy "make -k ")
684 "Last shell command used to do a compilation; default for next compilation.
686 Sometimes it is useful for files to supply local values for this variable.
687 You might also use mode hooks to specify it in certain modes, like this:
689 (add-hook \\='c-mode-hook
691 (unless (or (file-exists-p \"makefile\")
692 (file-exists-p \"Makefile\"))
693 (set (make-local-variable \\='compile-command)
696 (shell-quote-argument
697 (file-name-sans-extension buffer-file-name))))))))
699 It's often useful to leave a space at the end of the value."
702 ;;;###autoload(put 'compile-command 'safe-local-variable (lambda (a) (and (stringp a) (or (not (boundp 'compilation-read-command)) compilation-read-command))))
705 (defcustom compilation-disable-input nil
706 "If non-nil, send end-of-file as compilation process input.
707 This only affects platforms that support asynchronous processes (see
708 `start-process'); synchronous compilation processes never accept input."
713 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
714 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
715 ;; key. This holds the tree seen from root, for storing new nodes.
716 (defvar compilation-locs
())
718 (defvar compilation-debug nil
719 "Set this to t before creating a *compilation* buffer.
720 Then every error line will have a debug text property with the matcher that
721 fit this line and the match data. Use `describe-text-properties'.")
723 (defvar compilation-exit-message-function nil
"\
724 If non-nil, called when a compilation process dies to return a status message.
725 This should be a function of three arguments: process status, exit status,
726 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
727 write into the compilation buffer, and to put in its mode line.")
729 (defcustom compilation-environment nil
730 "List of environment variables for compilation to inherit.
731 Each element should be a string of the form ENVVARNAME=VALUE.
732 This list is temporarily prepended to `process-environment' prior to
733 starting the compilation process."
734 :type
'(repeat (string :tag
"ENVVARNAME=VALUE"))
735 :options
'(("LANG=C"))
739 ;; History of compile commands.
740 (defvar compile-history nil
)
742 (defface compilation-error
743 '((t :inherit error
))
744 "Face used to highlight compiler errors."
748 (defface compilation-warning
749 '((t :inherit warning
))
750 "Face used to highlight compiler warnings."
754 (defface compilation-info
755 '((t :inherit success
))
756 "Face used to highlight compiler information."
760 ;; The next three faces must be able to stand out against the
761 ;; `mode-line' and `mode-line-inactive' faces.
763 (defface compilation-mode-line-fail
764 '((default :inherit compilation-error
)
765 (((class color
) (min-colors 16)) (:foreground
"Red1" :weight bold
))
766 (((class color
) (min-colors 8)) (:foreground
"red"))
767 (t (:inverse-video t
:weight bold
)))
768 "Face for Compilation mode's \"error\" mode line indicator."
772 (defface compilation-mode-line-run
773 '((t :inherit compilation-warning
))
774 "Face for Compilation mode's \"running\" mode line indicator."
778 (defface compilation-mode-line-exit
779 '((default :inherit compilation-info
)
780 (((class color
) (min-colors 16))
781 (:foreground
"ForestGreen" :weight bold
))
782 (((class color
)) (:foreground
"green" :weight bold
))
784 "Face for Compilation mode's \"exit\" mode line indicator."
788 (defface compilation-line-number
789 '((t :inherit font-lock-keyword-face
))
790 "Face for displaying line numbers in compiler messages."
794 (defface compilation-column-number
795 '((t :inherit font-lock-doc-face
))
796 "Face for displaying column numbers in compiler messages."
800 (defcustom compilation-message-face
'underline
801 "Face name to use for whole messages.
802 Faces `compilation-error-face', `compilation-warning-face',
803 `compilation-info-face', `compilation-line-face' and
804 `compilation-column-face' get prepended to this, when applicable."
809 (defvar compilation-error-face
'compilation-error
810 "Face name to use for file name in error messages.")
812 (defvar compilation-warning-face
'compilation-warning
813 "Face name to use for file name in warning messages.")
815 (defvar compilation-info-face
'compilation-info
816 "Face name to use for file name in informational messages.")
818 (defvar compilation-line-face
'compilation-line-number
819 "Face name to use for line numbers in compiler messages.")
821 (defvar compilation-column-face
'compilation-column-number
822 "Face name to use for column numbers in compiler messages.")
824 ;; same faces as dired uses
825 (defvar compilation-enter-directory-face
'font-lock-function-name-face
826 "Face name to use for entering directory messages.")
828 (defvar compilation-leave-directory-face
'font-lock-builtin-face
829 "Face name to use for leaving directory messages.")
831 ;; Used for compatibility with the old compile.el.
832 (defvar compilation-parse-errors-function nil
)
833 (make-obsolete-variable 'compilation-parse-errors-function
834 'compilation-error-regexp-alist
"24.1")
836 (defcustom compilation-auto-jump-to-first-error nil
837 "If non-nil, automatically jump to the first error during compilation."
842 (defvar compilation-auto-jump-to-next nil
843 "If non-nil, automatically jump to the next error encountered.")
844 (make-variable-buffer-local 'compilation-auto-jump-to-next
)
846 ;; (defvar compilation-buffer-modtime nil
847 ;; "The buffer modification time, for buffers not associated with files.")
848 ;; (make-variable-buffer-local 'compilation-buffer-modtime)
850 (defvar compilation-skip-to-next-location t
851 "If non-nil, skip multiple error messages for the same source location.")
853 (defcustom compilation-skip-threshold
1
854 "Compilation motion commands skip less important messages.
855 The value can be either 2 -- skip anything less than error, 1 --
856 skip anything less than warning or 0 -- don't skip any messages.
857 Note that all messages not positively identified as warning or
858 info, are considered errors."
859 :type
'(choice (const :tag
"Skip warnings and info" 2)
860 (const :tag
"Skip info" 1)
861 (const :tag
"No skip" 0))
865 (defun compilation-set-skip-threshold (level)
866 "Switch the `compilation-skip-threshold' level."
869 (mod (if current-prefix-arg
870 (prefix-numeric-value current-prefix-arg
)
871 (1+ compilation-skip-threshold
))
873 (setq compilation-skip-threshold level
)
874 (message "Skipping %s"
875 (pcase compilation-skip-threshold
878 (2 "Warnings and info"))))
880 (defcustom compilation-skip-visited nil
881 "Compilation motion commands skip visited messages if this is t.
882 Visited messages are ones for which the file, line and column have been jumped
883 to from the current content in the current compilation buffer, even if it was
884 from a different message."
889 (defun compilation-face (type)
890 (or (and (car type
) (match-end (car type
)) compilation-warning-face
)
891 (and (cdr type
) (match-end (cdr type
)) compilation-info-face
)
892 compilation-error-face
))
894 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE nil nil)
896 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
897 ;; LINE will be nil for a message that doesn't contain them. Then the
898 ;; location refers to a indented beginning of line or beginning of file.
899 ;; Once any location in some file has been jumped to, the list is extended to
900 ;; (COLUMN LINE FILE-STRUCTURE MARKER TIMESTAMP . VISITED)
901 ;; for all LOCs pertaining to that file.
902 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
903 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
904 ;; before that point. VISITED is t if we have jumped there, else nil.
905 ;; FIXME-omake: TIMESTAMP was used to try and handle "incremental compilation":
906 ;; `omake -P' polls filesystem for changes and recompiles when a file is
907 ;; modified using the same *compilation* buffer. this necessitates
908 ;; re-parsing markers.
910 ;; (cl-defstruct (compilation--loc
911 ;; (:constructor nil)
913 ;; (:constructor compilation--make-loc
914 ;; (file-struct line col marker))
915 ;; (:conc-name compilation--loc->))
916 ;; col line file-struct marker timestamp visited)
918 ;; FIXME: We don't use a defstruct because of compilation-assq which looks up
919 ;; and creates part of the LOC (only the first cons cell containing the COL).
921 (defmacro compilation--make-cdrloc
(line file-struct marker
)
922 `(list ,line
,file-struct
,marker nil
))
923 (defmacro compilation--loc-
>col
(loc) `(car ,loc
))
924 (defmacro compilation--loc-
>line
(loc) `(cadr ,loc
))
925 (defmacro compilation--loc-
>file-struct
(loc) `(nth 2 ,loc
))
926 (defmacro compilation--loc-
>marker
(loc) `(nth 3 ,loc
))
927 ;; (defmacro compilation--loc->timestamp (loc) `(nth 4 ,loc))
928 (defmacro compilation--loc-
>visited
(loc) `(nthcdr 5 ,loc
))
930 ;; FILE-STRUCTURE is a list of
931 ;; ((FILENAME DIRECTORY) FORMATS (LINE LOC ...) ...)
933 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
934 ;; obtained by following directory change messages. DIRECTORY will be nil for
935 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
936 ;; a file of that name can't be found.
937 ;; The rest of the list is an alist of elements with LINE as key. The keys
938 ;; are either nil or line numbers. If present, nil comes first, followed by
939 ;; the numbers in decreasing order. The LOCs for each line are again an alist
940 ;; ordered the same way. Note that the whole file structure is referenced in
943 (defmacro compilation--make-file-struct
(file-spec formats
&optional loc-tree
)
944 `(cons ,file-spec
(cons ,formats
,loc-tree
)))
945 (defmacro compilation--file-struct-
>file-spec
(fs) `(car ,fs
))
946 (defmacro compilation--file-struct-
>formats
(fs) `(cadr ,fs
))
947 ;; The FORMATS field plays the role of ANCHOR in the loc-tree.
948 (defmacro compilation--file-struct-
>loc-tree
(fs) `(cdr ,fs
))
950 ;; MESSAGE is a list of (LOC TYPE END-LOC)
952 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
953 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
954 ;; other end, if the parsed message contained a range. If the end of the
955 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
956 ;; These are the value of the `compilation-message' text-properties in the
957 ;; compilation buffer.
959 (cl-defstruct (compilation--message
962 ;; (:type list) ;Old representation.
963 (:constructor compilation--make-message
(loc type end-loc
))
964 (:conc-name compilation--message-
>))
967 (defvar compilation--previous-directory-cache nil
968 "A pair (POS . RES) caching the result of previous directory search.
969 Basically, this pair says that calling
970 (previous-single-property-change POS \\='compilation-directory)
971 returned RES, i.e. there is no change of `compilation-directory' between
973 (make-variable-buffer-local 'compilation--previous-directory-cache
)
975 (defun compilation--flush-directory-cache (start _end
)
977 ((or (not compilation--previous-directory-cache
)
978 (<= (car compilation--previous-directory-cache
) start
)))
979 ((or (not (cdr compilation--previous-directory-cache
))
980 (null (marker-buffer (cdr compilation--previous-directory-cache
)))
981 (<= (cdr compilation--previous-directory-cache
) start
))
982 (set-marker (car compilation--previous-directory-cache
) start
))
983 (t (setq compilation--previous-directory-cache nil
))))
985 (defun compilation--previous-directory (pos)
986 "Like (previous-single-property-change POS \\='compilation-directory), but faster."
987 ;; This avoids an N² behavior when there's no/few compilation-directory
988 ;; entries, in which case each call to previous-single-property-change
989 ;; ends up having to walk very far back to find the last change.
990 (if (and compilation--previous-directory-cache
991 (< pos
(car compilation--previous-directory-cache
))
992 (or (null (cdr compilation--previous-directory-cache
))
993 (< (cdr compilation--previous-directory-cache
) pos
)))
994 ;; No need to call previous-single-property-change.
995 (cdr compilation--previous-directory-cache
)
997 (let* ((cache (and compilation--previous-directory-cache
998 (<= (car compilation--previous-directory-cache
) pos
)
999 (car compilation--previous-directory-cache
)))
1001 (previous-single-property-change
1002 pos
'compilation-directory nil cache
))
1006 (setq compilation--previous-directory-cache
1007 (cons (copy-marker pos
) (if prev
(copy-marker prev
))))
1009 ((and prev
(= prev cache
))
1010 (set-marker (car compilation--previous-directory-cache
) pos
)
1011 (cdr compilation--previous-directory-cache
))
1013 (set-marker cache pos
)
1014 (setcdr compilation--previous-directory-cache
1017 (if (markerp res
) (marker-position res
) res
))))
1019 ;; Internal function for calculating the text properties of a directory
1020 ;; change message. The compilation-directory property is important, because it
1021 ;; is the stack of nested enter-messages. Relative filenames on the following
1022 ;; lines are relative to the top of the stack.
1023 (defun compilation-directory-properties (idx leave
)
1024 (if leave
(setq leave
(match-end leave
)))
1025 ;; find previous stack, and push onto it, or if `leave' pop it
1026 (let ((dir (compilation--previous-directory (match-beginning 0))))
1027 (setq dir
(if dir
(or (get-text-property (1- dir
) 'compilation-directory
)
1028 (get-text-property dir
'compilation-directory
))))
1029 `(font-lock-face ,(if leave
1030 compilation-leave-directory-face
1031 compilation-enter-directory-face
)
1032 compilation-directory
,(if leave
1034 '(nil)) ; nil only isn't a property-change
1035 (cons (match-string-no-properties idx
) dir
))
1036 ;; Place a `compilation-message' everywhere we change text-properties
1037 ;; so compilation--remove-properties can know what to remove.
1038 compilation-message
,(compilation--make-message nil
0 nil
)
1039 mouse-face highlight
1040 keymap compilation-button-map
1041 help-echo
"mouse-2: visit destination directory")))
1043 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
1044 ;; KEY element from the ALIST, creating it in the right position if not already
1045 ;; present. ALIST structure is
1046 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
1047 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
1048 ;; may be nil. The other KEYs are ordered backwards so that growing line
1049 ;; numbers can be inserted in front and searching can abort after half the
1051 (eval-when-compile ;Don't keep it at runtime if not needed.
1052 (defmacro compilation-assq
(key alist
)
1055 (car (if (if (null ,key
)
1056 (if l2
(null (caar l2
)))
1057 (while (if l2
(if (caar l2
) (< ,key
(caar l2
)) t
))
1060 (if l2
(eq ,key
(caar l2
))))
1062 (setcdr l1
(cons (list ,key
) l2
)))))))
1064 (defun compilation-auto-jump (buffer pos
)
1065 (with-current-buffer buffer
1067 (let ((win (get-buffer-window buffer
0)))
1068 (if win
(set-window-point win pos
)))
1069 (if compilation-auto-jump-to-first-error
1070 (compile-goto-error))))
1072 ;; This function is the central driver, called when font-locking to gather
1073 ;; all information needed to later jump to corresponding source code.
1074 ;; Return a property list with all meta information on this error location.
1076 (defun compilation-error-properties (file line end-line col end-col type fmt
)
1077 (unless (text-property-not-all (match-beginning 0) (point)
1078 'compilation-message nil
)
1081 (setq file
(if (functionp file
) (funcall file
)
1082 (match-string-no-properties file
))))
1084 (unless (file-name-absolute-p file
)
1085 (let ((pos (compilation--previous-directory
1086 (match-beginning 0))))
1088 (or (get-text-property (1- pos
) 'compilation-directory
)
1089 (get-text-property pos
'compilation-directory
)))))))
1090 (setq file
(cons file
(car dir
)))))
1091 ;; This message didn't mention one, get it from previous
1093 ;; Find the previous message.
1094 (previous-single-property-change (point) 'compilation-message
)))
1096 ;; Get the file structure that belongs to it.
1098 (or (get-text-property (1- prev-pos
) 'compilation-message
)
1099 (get-text-property prev-pos
'compilation-message
)))
1102 (compilation--loc->file-struct
1103 (compilation--message->loc prev
)))))
1105 ;; Construct FILE . DIR from that.
1106 (if prev-file-struct
1107 (setq file
(cons (caar prev-file-struct
)
1108 (cadr (car prev-file-struct
)))))))
1110 (setq file
'("*unknown*")))))
1111 ;; All of these fields are optional, get them only if we have an index, and
1112 ;; it matched some part of the message.
1114 (setq line
(match-string-no-properties line
))
1115 (setq line
(string-to-number line
)))
1117 (setq end-line
(match-string-no-properties end-line
))
1118 (setq end-line
(string-to-number end-line
)))
1121 (setq col
(funcall col
))
1123 (setq col
(match-string-no-properties col
))
1124 (setq col
(string-to-number col
)))))
1125 (if (and end-col
(functionp end-col
))
1126 (setq end-col
(funcall end-col
))
1127 (if (and end-col
(setq end-col
(match-string-no-properties end-col
)))
1128 (setq end-col
(- (string-to-number end-col
) -
1))
1129 (if end-line
(setq end-col -
1))))
1130 (if (consp type
) ; not a static type, check what it is.
1131 (setq type
(or (and (car type
) (match-end (car type
)) 1)
1132 (and (cdr type
) (match-end (cdr type
)) 0)
1135 (when (and compilation-auto-jump-to-next
1136 (>= type compilation-skip-threshold
))
1137 (kill-local-variable 'compilation-auto-jump-to-next
)
1138 (run-with-timer 0 nil
'compilation-auto-jump
1139 (current-buffer) (match-beginning 0)))
1141 (compilation-internal-error-properties
1142 file line end-line col end-col type fmt
)))
1144 (defun compilation-beginning-of-line (&optional n
)
1145 "Like `beginning-of-line', but accounts for lines hidden by `selective-display'."
1146 (if (or (not (eq selective-display t
))
1149 (beginning-of-line n
)
1150 (re-search-forward "[\n\r]" nil
'end
(1- n
))
1152 (beginning-of-line))))
1154 (defun compilation-move-to-column (col screen
)
1155 "Go to column COL on the current line.
1156 If SCREEN is non-nil, columns are screen columns, otherwise, they are
1158 (setq col
(- col compilation-first-column
))
1160 ;; Presumably, the compilation tool doesn't know about our current
1161 ;; `tab-width' setting, so it probably assumed 8-wide TABs (bug#21038).
1162 (let ((tab-width 8)) (move-to-column (max col
0)))
1163 (goto-char (min (+ (line-beginning-position) col
) (line-end-position)))))
1165 (defun compilation-internal-error-properties (file line end-line col end-col type fmts
)
1166 "Get the meta-info that will be added as text-properties.
1167 LINE, END-LINE, COL, END-COL are integers or nil.
1168 TYPE can be 0, 1, or 2, meaning error, warning, or just info.
1169 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil.
1170 FMTS is a list of format specs for transforming the file name.
1171 (See `compilation-error-regexp-alist'.)"
1172 (unless file
(setq file
'("*unknown*")))
1173 (let* ((file-struct (compilation-get-file-structure file fmts
))
1174 ;; Get first already existing marker (if any has one, all have one).
1175 ;; Do this first, as the compilation-assq`s may create new nodes.
1176 (marker-line ; a line structure
1177 (cadr (compilation--file-struct->loc-tree file-struct
)))
1179 (if marker-line
(compilation--loc->marker
(cadr marker-line
))))
1180 (screen-columns compilation-error-screen-columns
)
1181 (first-column compilation-first-column
)
1182 end-marker loc end-loc
)
1183 (if (not (and marker
(marker-buffer marker
)))
1184 (setq marker nil
) ; no valid marker for this file
1185 (unless line
(setq line
1)) ; normalize no linenumber to line 1
1186 (catch 'marker
; find nearest loc, at least one exists
1187 (dolist (x (cddr (compilation--file-struct->loc-tree
1188 file-struct
))) ; Loop over remaining lines.
1189 (if (> (car x
) line
) ; Still bigger.
1190 (setq marker-line x
)
1191 (if (> (- (or (car marker-line
) 1) line
)
1192 (- line
(car x
))) ; Current line is nearer.
1193 (setq marker-line x
))
1194 (throw 'marker t
))))
1195 (setq marker
(compilation--loc->marker
(cadr marker-line
))
1196 marker-line
(or (car marker-line
) 1))
1197 (with-current-buffer (marker-buffer marker
)
1198 (let ((screen-columns
1199 ;; Obey the compilation-error-screen-columns of the target
1200 ;; buffer if its major mode set it buffer-locally.
1201 (if (local-variable-p 'compilation-error-screen-columns
)
1202 compilation-error-screen-columns screen-columns
))
1203 (compilation-first-column
1204 (if (local-variable-p 'compilation-first-column
)
1205 compilation-first-column first-column
)))
1209 (goto-char (marker-position marker
))
1210 ;; Set end-marker if appropriate and go to line.
1211 (if (not (or end-col end-line
))
1212 (compilation-beginning-of-line (- line marker-line -
1))
1213 (compilation-beginning-of-line (- (or end-line line
)
1215 (if (or (null end-col
) (< end-col
0))
1217 (compilation-move-to-column end-col screen-columns
))
1218 (setq end-marker
(point-marker))
1220 (compilation-beginning-of-line (- line end-line -
1))))
1222 (compilation-move-to-column col screen-columns
)
1223 (forward-to-indentation 0))
1224 (setq marker
(point-marker)))))))
1226 (setq loc
(compilation-assq line
(compilation--file-struct->loc-tree
1231 end-col
(compilation-assq
1232 end-line
(compilation--file-struct->loc-tree
1234 (if end-col
; use same line element
1235 (compilation-assq end-col loc
))))
1236 (setq loc
(compilation-assq col loc
))
1237 ;; If they are new, make the loc(s) reference the file they point to.
1238 ;; FIXME-omake: there's a problem with timestamps here: the markers
1239 ;; relative to which we computed the current `marker' have a timestamp
1240 ;; almost guaranteed to be different from compilation-buffer-modtime, so if
1241 ;; we use their timestamp, we'll never use `loc' since the timestamp won't
1242 ;; match compilation-buffer-modtime, and if we use
1243 ;; compilation-buffer-modtime then we have different timestamps for
1244 ;; locations that were computed together, which doesn't make sense either.
1245 ;; I think this points to a fundamental problem in our approach to the
1246 ;; "omake -P" problem. --Stef
1248 (setcdr loc
(compilation--make-cdrloc line file-struct marker
)))
1252 (compilation--make-cdrloc (or end-line line
) file-struct
1255 ;; Must start with face
1256 `(font-lock-face ,compilation-message-face
1257 compilation-message
,(compilation--make-message loc type end-loc
)
1259 "mouse-2: visit this file, line and column"
1261 "mouse-2: visit this file and line"
1262 "mouse-2: visit this file"))
1263 keymap compilation-button-map
1264 mouse-face highlight
)))
1266 (defun compilation--put-prop (matchnum prop val
)
1267 (when (and (integerp matchnum
) (match-beginning matchnum
))
1269 (match-beginning matchnum
) (match-end matchnum
)
1272 (defun compilation--remove-properties (&optional start end
)
1273 (with-silent-modifications
1274 ;; When compile.el used font-lock directly, we could just remove all
1275 ;; our text-properties in one go, but now that we manually place
1276 ;; font-lock-face, we have to be careful to only remove the font-lock-face
1278 ;; (remove-list-of-text-properties
1279 ;; (or start (point-min)) (or end (point-max))
1280 ;; '(compilation-debug compilation-directory compilation-message
1281 ;; font-lock-face help-echo mouse-face))
1283 (unless start
(setq start
(point-min)))
1284 (unless end
(setq end
(point-max)))
1285 (compilation--flush-directory-cache start end
)
1288 (setq next
(or (next-single-property-change
1289 start
'compilation-message nil end
)
1291 (when (get-text-property start
'compilation-message
)
1292 (remove-list-of-text-properties
1294 '(compilation-debug compilation-directory compilation-message
1295 font-lock-face help-echo mouse-face
)))
1297 (setq start next
)))))
1299 (defun compilation--parse-region (start end
)
1302 ;; We generally don't like to parse partial lines.
1304 (when (let ((proc (get-buffer-process (current-buffer))))
1305 (and proc
(memq (process-status proc
) '(run open
))))
1306 (setq end
(line-beginning-position))))
1307 (compilation--remove-properties start end
)
1308 (if compilation-parse-errors-function
1309 ;; An old package! Try the compatibility code.
1312 (compilation--compat-parse-errors end
))
1314 ;; compilation-directory-matcher is the only part that really needs to be
1315 ;; parsed sequentially. So we could split it out, handle directories
1316 ;; like syntax-propertize, and the rest as font-lock-keywords. But since
1317 ;; we want to have it work even when font-lock is off, we'd then need to
1318 ;; use our own compilation-parsed text-property to keep track of the parts
1319 ;; that have already been parsed.
1321 (while (re-search-forward (car compilation-directory-matcher
)
1323 (compilation--flush-directory-cache (match-beginning 0) (match-end 0))
1324 (when compilation-debug
1325 (font-lock-append-text-property
1326 (match-beginning 0) (match-end 0)
1328 (vector 'directory compilation-directory-matcher
)))
1329 (dolist (elt (cdr compilation-directory-matcher
))
1330 (add-text-properties (match-beginning (car elt
))
1331 (match-end (car elt
))
1332 (compilation-directory-properties
1333 (car elt
) (cdr elt
)))))
1335 (compilation-parse-errors start end
)))
1337 (defun compilation-parse-errors (start end
&rest rules
)
1338 "Parse errors between START and END.
1339 The errors recognized are the ones specified in RULES which default
1340 to `compilation-error-regexp-alist' if RULES is nil."
1341 (dolist (item (or rules compilation-error-regexp-alist
))
1343 (setq item
(cdr (assq item
1344 compilation-error-regexp-alist-alist
))))
1345 (let ((file (nth 1 item
))
1350 end-line end-col fmt
1353 ;; omake reports some error indented, so skip the indentation.
1354 ;; another solution is to modify (some?) regexps in
1355 ;; `compilation-error-regexp-alist'.
1356 ;; note that omake usage is not limited to ocaml and C (for stubs).
1357 ;; FIXME-omake: Doing it here seems wrong, at least it should depend on
1358 ;; whether or not omake's own error messages are recognized.
1360 ((not (memq 'omake compilation-error-regexp-alist
)) nil
)
1361 ((string-match "\\`\\([^^]\\|\\^\\( \\*\\|\\[\\)\\)" pat
)
1362 nil
) ;; Not anchored or anchored but already allows empty spaces.
1363 (t (setq pat
(concat "^ *" (substring pat
1)))))
1365 (if (consp file
) (setq fmt
(cdr file
) file
(car file
)))
1366 (if (consp line
) (setq end-line
(cdr line
) line
(car line
)))
1367 (if (consp col
) (setq end-col
(cdr col
) col
(car col
)))
1369 (if (functionp line
)
1370 ;; The old compile.el had here an undocumented hook that
1371 ;; allowed `line' to be a function that computed the actual
1372 ;; error location. Let's do our best.
1375 (while (re-search-forward pat end t
)
1377 (when compilation-debug
1378 (font-lock-append-text-property
1379 (match-beginning 0) (match-end 0)
1380 'compilation-debug
(vector 'functionp item
)))
1381 (add-text-properties
1382 (match-beginning 0) (match-end 0)
1383 (compilation--compat-error-properties
1384 (funcall line
(cons (match-string file
)
1385 (cons default-directory
1387 (if col
(match-string col
))))))
1388 (compilation--put-prop
1389 file
'font-lock-face compilation-error-face
)))
1391 (unless (or (null (nth 5 item
)) (integerp (nth 5 item
)))
1392 (error "HYPERLINK should be an integer: %s" (nth 5 item
)))
1395 (while (re-search-forward pat end t
)
1396 (when (setq props
(compilation-error-properties
1397 file line end-line col end-col
(or type
2) fmt
))
1399 (when (integerp file
)
1400 (compilation--put-prop
1401 file
'font-lock-face
1403 (compilation-face type
)
1404 (symbol-value (aref [compilation-info-face
1405 compilation-warning-face
1406 compilation-error-face
]
1409 (compilation--put-prop
1410 line
'font-lock-face compilation-line-face
)
1411 (compilation--put-prop
1412 end-line
'font-lock-face compilation-line-face
)
1414 (compilation--put-prop
1415 col
'font-lock-face compilation-column-face
)
1416 (compilation--put-prop
1417 end-col
'font-lock-face compilation-column-face
)
1420 (dolist (extra-item (nthcdr 6 item
))
1421 (let ((mn (pop extra-item
)))
1422 (when (match-beginning mn
)
1423 (let ((face (eval (car extra-item
))))
1426 ((or (symbolp face
) (stringp face
))
1428 (match-beginning mn
) (match-end mn
)
1429 'font-lock-face face
))
1431 (eq (car face
) 'face
)
1432 (or (symbolp (cadr face
))
1433 (stringp (cadr face
))))
1434 (compilation--put-prop mn
'font-lock-face
(cadr face
))
1435 (add-text-properties
1436 (match-beginning mn
) (match-end mn
)
1439 (error "Don't know how to handle face %S"
1441 (let ((mn (or (nth 5 item
) 0)))
1442 (when compilation-debug
1443 (font-lock-append-text-property
1444 (match-beginning 0) (match-end 0)
1445 'compilation-debug
(vector 'std item props
)))
1446 (add-text-properties
1447 (match-beginning mn
) (match-end mn
)
1449 (font-lock-append-text-property
1450 (match-beginning mn
) (match-end mn
)
1451 'font-lock-face
(cadr props
)))))))))
1453 (defvar compilation--parsed -
1)
1454 (make-variable-buffer-local 'compilation--parsed
)
1456 (defun compilation--ensure-parse (limit)
1457 "Make sure the text has been parsed up to LIMIT."
1460 (setq limit
(line-beginning-position 2))
1461 (unless (markerp compilation--parsed
)
1462 ;; We use a marker for compilation--parsed so that users (such as
1463 ;; grep.el) don't need to flush-parse when they modify the buffer
1464 ;; in a way that impacts buffer positions but does not require
1466 (setq compilation--parsed
(point-min-marker)))
1467 (when (< compilation--parsed limit
)
1468 (let ((start (max compilation--parsed
(point-min))))
1469 (move-marker compilation--parsed limit
)
1471 (forward-line 0) ;Not line-beginning-position: ignore (comint) fields.
1472 (while (and (not (bobp))
1473 (get-text-property (1- (point)) 'compilation-multiline
))
1475 (with-silent-modifications
1476 (compilation--parse-region (point) compilation--parsed
)))))
1479 (defun compilation--flush-parse (start _end
)
1480 "Mark the region between START and END for re-parsing."
1481 (if (markerp compilation--parsed
)
1482 (move-marker compilation--parsed
(min start compilation--parsed
))))
1484 (defun compilation-mode-font-lock-keywords ()
1485 "Return expressions to highlight in Compilation mode."
1487 '((compilation--ensure-parse))
1488 compilation-mode-font-lock-keywords
))
1490 (defun compilation-read-command (command)
1491 (read-shell-command "Compile command: " command
1492 (if (equal (car compile-history
) command
)
1493 '(compile-history .
1)
1498 (defun compile (command &optional comint
)
1499 "Compile the program including the current buffer. Default: run `make'.
1500 Runs COMMAND, a shell command, in a separate process asynchronously
1501 with output going to the buffer `*compilation*'.
1503 You can then use the command \\[next-error] to find the next error message
1504 and move to the source code that caused it.
1506 If optional second arg COMINT is t the buffer will be in Comint mode with
1507 `compilation-shell-minor-mode'.
1509 Interactively, prompts for the command if the variable
1510 `compilation-read-command' is non-nil; otherwise uses `compile-command'.
1511 With prefix arg, always prompts.
1512 Additionally, with universal prefix arg, compilation buffer will be in
1513 comint mode, i.e. interactive.
1515 To run more than one compilation at once, start one then rename
1516 the `*compilation*' buffer to some other name with
1517 \\[rename-buffer]. Then _switch buffers_ and start the new compilation.
1518 It will create a new `*compilation*' buffer.
1520 On most systems, termination of the main compilation process
1521 kills its subprocesses.
1523 The name used for the buffer is actually whatever is returned by
1524 the function in `compilation-buffer-name-function', so you can set that
1525 to a function that generates a unique name."
1528 (let ((command (eval compile-command
)))
1529 (if (or compilation-read-command current-prefix-arg
)
1530 (compilation-read-command command
)
1532 (consp current-prefix-arg
)))
1533 (unless (equal command
(eval compile-command
))
1534 (setq compile-command command
))
1535 (save-some-buffers (not compilation-ask-about-save
)
1536 compilation-save-buffers-predicate
)
1537 (setq-default compilation-directory default-directory
)
1538 (compilation-start command comint
))
1540 ;; run compile with the default command line
1541 (defun recompile (&optional edit-command
)
1542 "Re-compile the program including the current buffer.
1543 If this is run in a Compilation mode buffer, re-use the arguments from the
1544 original use. Otherwise, recompile using `compile-command'.
1545 If the optional argument `edit-command' is non-nil, the command can be edited."
1547 (save-some-buffers (not compilation-ask-about-save
)
1548 compilation-save-buffers-predicate
)
1549 (let ((default-directory (or compilation-directory default-directory
))
1550 (command (eval compile-command
)))
1552 (setq command
(compilation-read-command (or (car compilation-arguments
)
1554 (if compilation-arguments
(setcar compilation-arguments command
)))
1555 (apply 'compilation-start
(or compilation-arguments
(list command
)))))
1557 (defcustom compilation-scroll-output nil
1558 "Non-nil to scroll the *compilation* buffer window as output appears.
1560 Setting it causes the Compilation mode commands to put point at the
1561 end of their output window so that the end of the output is always
1562 visible rather than the beginning.
1564 The value `first-error' stops scrolling at the first error, and leaves
1565 point on its location in the *compilation* buffer."
1566 :type
'(choice (const :tag
"No scrolling" nil
)
1567 (const :tag
"Scroll compilation output" t
)
1568 (const :tag
"Stop scrolling at the first error" first-error
))
1570 :group
'compilation
)
1573 (defun compilation-buffer-name (name-of-mode mode-command name-function
)
1574 "Return the name of a compilation buffer to use.
1575 If NAME-FUNCTION is non-nil, call it with one argument NAME-OF-MODE
1576 to determine the buffer name.
1577 Likewise if `compilation-buffer-name-function' is non-nil.
1578 If current buffer has the major mode MODE-COMMAND,
1579 return the name of the current buffer, so that it gets reused.
1580 Otherwise, construct a buffer name from NAME-OF-MODE."
1581 (cond (name-function
1582 (funcall name-function name-of-mode
))
1583 (compilation-buffer-name-function
1584 (funcall compilation-buffer-name-function name-of-mode
))
1585 ((eq mode-command major-mode
)
1588 (concat "*" (downcase name-of-mode
) "*"))))
1590 (defcustom compilation-always-kill nil
1591 "If t, always kill a running compilation process before starting a new one.
1592 If nil, ask to kill it."
1595 :group
'compilation
)
1598 (defun compilation-start (command &optional mode name-function highlight-regexp
)
1599 "Run compilation command COMMAND (low level interface).
1600 If COMMAND starts with a cd command, that becomes the `default-directory'.
1601 The rest of the arguments are optional; for them, nil means use the default.
1603 MODE is the major mode to set in the compilation buffer. Mode
1604 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
1606 If NAME-FUNCTION is non-nil, call it with one argument (the mode name)
1607 to determine the buffer name. Otherwise, the default is to
1608 reuses the current buffer if it has the proper major mode,
1609 else use or create a buffer with name based on the major mode.
1611 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
1612 the matching section of the visited source line; the default is to use the
1613 global value of `compilation-highlight-regexp'.
1615 Returns the compilation buffer created."
1616 (or mode
(setq mode
'compilation-mode
))
1617 (let* ((name-of-mode
1620 (replace-regexp-in-string "-mode\\'" "" (symbol-name mode
))))
1621 (thisdir default-directory
)
1622 (thisenv compilation-environment
)
1624 (with-current-buffer
1627 (compilation-buffer-name name-of-mode mode name-function
)))
1628 (let ((comp-proc (get-buffer-process (current-buffer))))
1630 (if (or (not (eq (process-status comp-proc
) 'run
))
1631 (eq (process-query-on-exit-flag comp-proc
) nil
)
1633 (format "A %s process is running; kill it? "
1637 (interrupt-process comp-proc
)
1639 (delete-process comp-proc
))
1641 (error "Cannot have two processes in `%s' at once"
1643 ;; first transfer directory from where M-x compile was called
1644 (setq default-directory thisdir
)
1645 ;; Make compilation buffer read-only. The filter can still write it.
1646 ;; Clear out the compilation buffer.
1647 (let ((inhibit-read-only t
)
1648 (default-directory thisdir
))
1649 ;; Then evaluate a cd command if any, but don't perform it yet, else
1650 ;; start-command would do it again through the shell: (cd "..") AND
1651 ;; sh -c "cd ..; make"
1653 ((not (string-match "\\`\\s *cd\\(?:\\s +\\(\\S +?\\|'[^']*'\\|\"\\(?:[^\"`$\\]\\|\\\\.\\)*\"\\)\\)?\\s *[;&\n]"
1656 ((not (match-end 1)) "~")
1657 ((eq (aref command
(match-beginning 1)) ?
\')
1658 (substring command
(1+ (match-beginning 1))
1659 (1- (match-end 1))))
1660 ((eq (aref command
(match-beginning 1)) ?
\")
1661 (replace-regexp-in-string
1663 (substring command
(1+ (match-beginning 1))
1664 (1- (match-end 1)))))
1665 ;; Try globbing as well (bug#15417).
1666 (t (let* ((substituted-dir
1667 (substitute-env-vars (match-string 1 command
)))
1668 ;; FIXME: This also tries to expand `*' that were
1669 ;; introduced by the envvar expansion!
1671 (file-expand-wildcards substituted-dir
)))
1672 (if (= (length expanded-dir
) 1)
1674 substituted-dir
)))))
1676 ;; Select the desired mode.
1677 (if (not (eq mode t
))
1679 (buffer-disable-undo)
1681 (setq buffer-read-only nil
)
1682 (with-no-warnings (comint-mode))
1683 (compilation-shell-minor-mode))
1684 ;; Remember the original dir, so we can use it when we recompile.
1685 ;; default-directory' can't be used reliably for that because it may be
1686 ;; affected by the special handling of "cd ...;".
1687 ;; NB: must be done after (funcall mode) as that resets local variables
1688 (set (make-local-variable 'compilation-directory
) thisdir
)
1689 (set (make-local-variable 'compilation-environment
) thisenv
)
1690 (if highlight-regexp
1691 (set (make-local-variable 'compilation-highlight-regexp
)
1693 (if (or compilation-auto-jump-to-first-error
1694 (eq compilation-scroll-output
'first-error
))
1695 (set (make-local-variable 'compilation-auto-jump-to-next
) t
))
1696 ;; Output a mode setter, for saving and later reloading this buffer.
1697 (insert "-*- mode: " name-of-mode
1698 "; default-directory: "
1699 (prin1-to-string (abbreviate-file-name default-directory
))
1701 (format "%s started at %s\n\n"
1703 (substring (current-time-string) 0 19))
1705 (setq thisdir default-directory
))
1706 (set-buffer-modified-p nil
))
1707 ;; Pop up the compilation buffer.
1708 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01638.html
1709 (setq outwin
(display-buffer outbuf
'(nil (allow-no-window . t
))))
1710 (with-current-buffer outbuf
1711 (let ((process-environment
1713 compilation-environment
1714 (if (if (boundp 'system-uses-terminfo
);`If' for compiler warning.
1715 system-uses-terminfo
)
1716 (list "TERM=dumb" "TERMCAP="
1717 (format "COLUMNS=%d" (window-width)))
1719 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1721 (list (format "INSIDE_EMACS=%s,compile" emacs-version
))
1722 (copy-sequence process-environment
))))
1723 (set (make-local-variable 'compilation-arguments
)
1724 (list command mode name-function highlight-regexp
))
1725 (set (make-local-variable 'revert-buffer-function
)
1726 'compilation-revert-buffer
)
1728 ;; Forcing the window-start overrides the usual redisplay
1729 ;; feature of bringing point into view, so setting the
1730 ;; window-start to top of the buffer risks losing the
1731 ;; effect of moving point to EOB below, per
1732 ;; compilation-scroll-output, if the command is long
1733 ;; enough to push point outside of the window. This
1734 ;; could happen, e.g., in `rgrep'.
1735 (not compilation-scroll-output
)
1736 (set-window-start outwin
(point-min)))
1738 ;; Position point as the user will see it.
1739 (let ((desired-visible-point
1740 ;; Put it at the end if `compilation-scroll-output' is set.
1741 (if compilation-scroll-output
1743 ;; Normally put it at the top.
1745 (goto-char desired-visible-point
)
1746 (when (and outwin
(not (eq outwin
(selected-window))))
1747 (set-window-point outwin desired-visible-point
)))
1749 ;; The setup function is called before compilation-set-window-height
1750 ;; so it can set the compilation-window-height buffer locally.
1751 (if compilation-process-setup-function
1752 (funcall compilation-process-setup-function
))
1753 (and outwin
(compilation-set-window-height outwin
))
1754 ;; Start the compilation.
1755 (if (fboundp 'make-process
)
1758 ;; comint uses `start-file-process'.
1762 outbuf
(downcase mode-name
)
1763 (if (file-remote-p default-directory
)
1766 nil
`("-c" ,command
))))
1767 (start-file-process-shell-command (downcase mode-name
)
1769 ;; Make the buffer's mode line show process state.
1770 (setq mode-line-process
1771 '(:propertize
":%s" face compilation-mode-line-run
))
1773 ;; Set the process as killable without query by default.
1774 ;; This allows us to start a new compilation without
1775 ;; getting prompted.
1776 (when compilation-always-kill
1777 (set-process-query-on-exit-flag proc nil
))
1779 (set-process-sentinel proc
'compilation-sentinel
)
1781 ;; Keep the comint filter, since it's needed for proper
1782 ;; handling of the prompts.
1783 (set-process-filter proc
'compilation-filter
))
1784 ;; Use (point-max) here so that output comes in
1785 ;; after the initial text,
1786 ;; regardless of where the user sees point.
1787 (set-marker (process-mark proc
) (point-max) outbuf
)
1788 (when compilation-disable-input
1790 (process-send-eof proc
)
1791 ;; The process may have exited already.
1793 (run-hook-with-args 'compilation-start-hook proc
)
1794 (setq compilation-in-progress
1795 (cons proc compilation-in-progress
)))
1796 ;; No asynchronous processes available.
1797 (message "Executing `%s'..." command
)
1798 ;; Fake mode line display as if `start-process' were run.
1799 (setq mode-line-process
1800 '(:propertize
":run" face compilation-mode-line-run
))
1801 (force-mode-line-update)
1802 (sit-for 0) ; Force redisplay
1804 ;; Insert the output at the end, after the initial text,
1805 ;; regardless of where the user sees point.
1806 (goto-char (point-max))
1807 (let* ((inhibit-read-only t
) ; call-process needs to modify outbuf
1808 (compilation-filter-start (point))
1809 (status (call-process shell-file-name nil outbuf nil
"-c"
1811 (run-hooks 'compilation-filter-hook
)
1812 (cond ((numberp status
)
1813 (compilation-handle-exit
1817 (format "exited abnormally with code %d\n" status
))))
1819 (compilation-handle-exit 'signal status
1820 (concat status
"\n")))
1822 (compilation-handle-exit 'bizarre status status
)))))
1823 (set-buffer-modified-p nil
)
1824 (message "Executing `%s'...done" command
)))
1825 ;; Now finally cd to where the shell started make/grep/...
1826 (setq default-directory thisdir
)
1827 ;; The following form selected outwin ever since revision 1.183,
1828 ;; so possibly messing up point in some other window (bug#1073).
1829 ;; Moved into the scope of with-current-buffer, though still with
1830 ;; complete disregard for the case when compilation-scroll-output
1831 ;; equals 'first-error (martin 2008-10-04).
1832 (when compilation-scroll-output
1833 (goto-char (point-max))))
1835 ;; Make it so the next C-x ` will use this buffer.
1836 (setq next-error-last-buffer outbuf
)))
1838 (defun compilation-set-window-height (window)
1839 "Set the height of WINDOW according to `compilation-window-height'."
1840 (let ((height (buffer-local-value 'compilation-window-height
(window-buffer window
))))
1842 (window-full-width-p window
)
1843 ;; If window is alone in its frame, aside from a minibuffer,
1844 ;; don't change its height.
1845 (not (eq window
(frame-root-window (window-frame window
))))
1846 ;; Stef said that doing the saves in this order is safer:
1848 (save-selected-window
1849 (select-window window
)
1850 (enlarge-window (- height
(window-height))))))))
1852 (defvar compilation-menu-map
1853 (let ((map (make-sparse-keymap "Errors"))
1854 (opt-map (make-sparse-keymap "Skip")))
1855 (define-key map
[stop-subjob
]
1856 '(menu-item "Stop Compilation" kill-compilation
1857 :help
"Kill the process made by the M-x compile or M-x grep commands"))
1858 (define-key map
[compilation-mode-separator3
]
1860 (define-key map
[compilation-next-error-follow-minor-mode
]
1862 "Auto Error Display" next-error-follow-minor-mode
1863 :help
"Display the error under cursor when moving the cursor"
1864 :button
(:toggle . next-error-follow-minor-mode
)))
1865 (define-key map
[compilation-skip
]
1866 (cons "Skip Less Important Messages" opt-map
))
1867 (define-key opt-map
[compilation-skip-none
]
1868 '(menu-item "Don't Skip Any Messages"
1871 (customize-set-variable 'compilation-skip-threshold
0))
1872 :help
"Do not skip any type of messages"
1873 :button
(:radio .
(eq compilation-skip-threshold
0))))
1874 (define-key opt-map
[compilation-skip-info
]
1875 '(menu-item "Skip Info"
1878 (customize-set-variable 'compilation-skip-threshold
1))
1879 :help
"Skip anything less than warning"
1880 :button
(:radio .
(eq compilation-skip-threshold
1))))
1881 (define-key opt-map
[compilation-skip-warning-and-info
]
1882 '(menu-item "Skip Warnings and Info"
1885 (customize-set-variable 'compilation-skip-threshold
2))
1886 :help
"Skip over Warnings and Info, stop for errors"
1887 :button
(:radio .
(eq compilation-skip-threshold
2))))
1888 (define-key map
[compilation-mode-separator2
]
1890 (define-key map
[compilation-first-error
]
1891 '(menu-item "First Error" first-error
1892 :help
"Restart at the first error, visit corresponding source code"))
1893 (define-key map
[compilation-previous-error
]
1894 '(menu-item "Previous Error" previous-error
1895 :help
"Visit previous `next-error' message and corresponding source code"))
1896 (define-key map
[compilation-next-error
]
1897 '(menu-item "Next Error" next-error
1898 :help
"Visit next `next-error' message and corresponding source code"))
1901 (defvar compilation-minor-mode-map
1902 (let ((map (make-sparse-keymap)))
1903 (set-keymap-parent map special-mode-map
)
1904 (define-key map
[mouse-2
] 'compile-goto-error
)
1905 (define-key map
[follow-link
] 'mouse-face
)
1906 (define-key map
"\C-c\C-c" 'compile-goto-error
)
1907 (define-key map
"\C-m" 'compile-goto-error
)
1908 (define-key map
"\C-o" 'compilation-display-error
)
1909 (define-key map
"\C-c\C-k" 'kill-compilation
)
1910 (define-key map
"\M-n" 'compilation-next-error
)
1911 (define-key map
"\M-p" 'compilation-previous-error
)
1912 (define-key map
"\M-{" 'compilation-previous-file
)
1913 (define-key map
"\M-}" 'compilation-next-file
)
1914 (define-key map
"g" 'recompile
) ; revert
1915 ;; Set up the menu-bar
1916 (define-key map
[menu-bar compilation
]
1917 (cons "Errors" compilation-menu-map
))
1919 "Keymap for `compilation-minor-mode'.")
1921 (defvar compilation-shell-minor-mode-map
1922 (let ((map (make-sparse-keymap)))
1923 (define-key map
"\M-\C-m" 'compile-goto-error
)
1924 (define-key map
"\M-\C-n" 'compilation-next-error
)
1925 (define-key map
"\M-\C-p" 'compilation-previous-error
)
1926 (define-key map
"\M-{" 'compilation-previous-file
)
1927 (define-key map
"\M-}" 'compilation-next-file
)
1928 ;; Set up the menu-bar
1929 (define-key map
[menu-bar compilation
]
1930 (cons "Errors" compilation-menu-map
))
1932 "Keymap for `compilation-shell-minor-mode'.")
1934 (defvar compilation-button-map
1935 (let ((map (make-sparse-keymap)))
1936 (define-key map
[mouse-2
] 'compile-goto-error
)
1937 (define-key map
[follow-link
] 'mouse-face
)
1938 (define-key map
"\C-m" 'compile-goto-error
)
1940 "Keymap for compilation-message buttons.")
1941 (fset 'compilation-button-map compilation-button-map
)
1943 (defvar compilation-mode-map
1944 (let ((map (make-sparse-keymap)))
1945 ;; Don't inherit from compilation-minor-mode-map,
1946 ;; because that introduces a menu bar item we don't want.
1947 ;; That confuses C-down-mouse-3.
1948 (set-keymap-parent map special-mode-map
)
1949 (define-key map
[mouse-2
] 'compile-goto-error
)
1950 (define-key map
[follow-link
] 'mouse-face
)
1951 (define-key map
"\C-c\C-c" 'compile-goto-error
)
1952 (define-key map
"\C-m" 'compile-goto-error
)
1953 (define-key map
"\C-o" 'compilation-display-error
)
1954 (define-key map
"\C-c\C-k" 'kill-compilation
)
1955 (define-key map
"\M-n" 'compilation-next-error
)
1956 (define-key map
"\M-p" 'compilation-previous-error
)
1957 (define-key map
"\M-{" 'compilation-previous-file
)
1958 (define-key map
"\M-}" 'compilation-next-file
)
1959 (define-key map
"\t" 'compilation-next-error
)
1960 (define-key map
[backtab] 'compilation-previous-error)
1961 (define-key map "g" 'recompile) ; revert
1963 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1965 ;; Set up the menu-bar
1966 (let ((submap (make-sparse-keymap "Compile")))
1967 (define-key map [menu-bar compilation]
1968 (cons "Compile" submap))
1969 (set-keymap-parent submap compilation-menu-map))
1970 (define-key map [menu-bar compilation compilation-separator2]
1972 (define-key map [menu-bar compilation compilation-grep]
1973 '(menu-item "Search Files (grep)..." grep
1974 :help "Run grep, with user-specified args, and collect output in a buffer"))
1975 (define-key map [menu-bar compilation compilation-recompile]
1976 '(menu-item "Recompile" recompile
1977 :help "Re-compile the program including the current buffer"))
1978 (define-key map [menu-bar compilation compilation-compile]
1979 '(menu-item "Compile..." compile
1980 :help "Compile the program including the current buffer. Default: run `make'"))
1982 "Keymap for compilation log buffers.
1983 `compilation-minor-mode-map' is a parent of this.")
1985 (defvar compilation-mode-tool-bar-map
1986 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
1987 ;; so don't do anything.
1988 (when (keymapp tool-bar-map)
1989 (let ((map (copy-keymap tool-bar-map)))
1990 (define-key map [undo] nil)
1991 (define-key map [separator-2] nil)
1992 (define-key-after map [separator-compile] menu-bar-separator)
1993 (tool-bar-local-item
1994 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
1996 :help "Goto previous error")
1997 (tool-bar-local-item
1998 "right-arrow" 'next-error-no-select 'next-error-no-select map
2000 :help "Goto next error")
2001 (tool-bar-local-item
2002 "cancel" 'kill-compilation 'kill-compilation map
2003 :enable '(let ((buffer (compilation-find-buffer)))
2004 (get-buffer-process buffer))
2005 :help "Stop compilation")
2006 (tool-bar-local-item
2007 "refresh" 'recompile 'recompile map
2008 :help "Restart compilation")
2011 (put 'compilation-mode 'mode-class 'special)
2014 (defun compilation-mode (&optional name-of-mode)
2015 "Major mode for compilation log buffers.
2016 \\<compilation-mode-map>To visit the source for a line-numbered error,
2017 move point to the error message line and type \\[compile-goto-error].
2018 To kill the compilation, type \\[kill-compilation].
2020 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
2022 \\{compilation-mode-map}"
2024 (kill-all-local-variables)
2025 (use-local-map compilation-mode-map)
2026 ;; Let windows scroll along with the output.
2027 (set (make-local-variable 'window-point-insertion-type) t)
2028 (set (make-local-variable 'tool-bar-map) compilation-mode-tool-bar-map)
2029 (setq major-mode 'compilation-mode ; FIXME: Use define-derived-mode.
2030 mode-name (or name-of-mode "Compilation"))
2031 (set (make-local-variable 'page-delimiter)
2032 compilation-page-delimiter)
2033 ;; (set (make-local-variable 'compilation-buffer-modtime) nil)
2035 ;; Turn off deferred fontifications in the compilation buffer, if
2036 ;; the user turned them on globally. This is because idle timers
2037 ;; aren't re-run after receiving input from a subprocess, so the
2038 ;; buffer is left unfontified after the compilation exits, until
2039 ;; some other input event happens.
2040 (set (make-local-variable 'jit-lock-defer-time) nil)
2041 (setq buffer-read-only t)
2042 (run-mode-hooks 'compilation-mode-hook))
2045 (put 'define-compilation-mode 'doc-string-elt 3)
2047 (defmacro define-compilation-mode (mode name doc &rest body)
2048 "This is like `define-derived-mode' without the PARENT argument.
2049 The parent is always `compilation-mode' and the customizable `compilation-...'
2050 variables are also set from the name of the mode you have chosen,
2051 by replacing the first word, e.g., `compilation-scroll-output' from
2052 `grep-scroll-output' if that variable exists."
2053 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
2054 `(define-derived-mode ,mode compilation-mode ,name
2056 ,@(mapcar (lambda (v)
2058 (intern-soft (replace-regexp-in-string
2059 "^compilation" mode-name
2062 (or (boundp (cdr v))
2063 ;; FIXME: This is hackish, using undocumented info.
2064 (if (boundp 'byte-compile-bound-variables)
2065 (memq (cdr v) byte-compile-bound-variables)))
2066 `(set (make-local-variable ',(car v)) ,(cdr v))))
2067 '(compilation-buffer-name-function
2068 compilation-directory-matcher
2070 compilation-error-regexp-alist
2071 compilation-error-regexp-alist-alist
2072 compilation-error-screen-columns
2073 compilation-finish-function
2074 compilation-finish-functions
2075 compilation-first-column
2076 compilation-mode-font-lock-keywords
2077 compilation-page-delimiter
2078 compilation-parse-errors-filename-function
2079 compilation-process-setup-function
2080 compilation-scroll-output
2081 compilation-search-path
2082 compilation-skip-threshold
2083 compilation-window-height))
2086 (defun compilation-revert-buffer (ignore-auto noconfirm)
2087 (if buffer-file-name
2088 (let (revert-buffer-function)
2089 (revert-buffer ignore-auto noconfirm))
2090 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
2091 (apply 'compilation-start compilation-arguments))))
2093 (defvar compilation-current-error nil
2094 "Marker to the location from where the next error will be found.
2095 The global commands next/previous/first-error/goto-error use this.")
2097 (defvar compilation-messages-start nil
2098 "Buffer position of the beginning of the compilation messages.
2099 If nil, use the beginning of buffer.")
2101 (defun compilation-setup (&optional minor)
2102 "Prepare the buffer for the compilation parsing commands to work.
2103 Optional argument MINOR indicates this is called from
2104 `compilation-minor-mode'."
2105 (make-local-variable 'compilation-current-error)
2106 (make-local-variable 'compilation-messages-start)
2107 (make-local-variable 'compilation-error-screen-columns)
2108 (make-local-variable 'overlay-arrow-position)
2109 (set (make-local-variable 'overlay-arrow-string) "")
2110 (setq next-error-overlay-arrow-position nil)
2111 (add-hook 'kill-buffer-hook
2112 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
2113 ;; Note that compilation-next-error-function is for interfacing
2114 ;; with the next-error function in simple.el, and it's only
2115 ;; coincidentally named similarly to compilation-next-error.
2116 (setq next-error-function 'compilation-next-error-function)
2117 (set (make-local-variable 'comint-file-name-prefix)
2118 (or (file-remote-p default-directory) ""))
2119 (set (make-local-variable 'compilation-locs)
2120 (make-hash-table :test 'equal :weakness 'value))
2121 ;; It's generally preferable to use after-change-functions since they
2122 ;; can be subject to combine-after-change-calls, but if we do that, we risk
2123 ;; running our hook after font-lock, resulting in incorrect refontification.
2124 (add-hook 'before-change-functions 'compilation--flush-parse nil t)
2125 ;; Also for minor mode, since it's not permanent-local.
2126 (add-hook 'change-major-mode-hook #'compilation--remove-properties nil t)
2129 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
2131 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))))
2133 (defun compilation--unsetup ()
2134 ;; Only for minor mode.
2135 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
2136 (remove-hook 'before-change-functions 'compilation--flush-parse t)
2137 (kill-local-variable 'compilation--parsed)
2138 (compilation--remove-properties)
2142 (define-minor-mode compilation-shell-minor-mode
2143 "Toggle Compilation Shell minor mode.
2144 With a prefix argument ARG, enable Compilation Shell minor mode
2145 if ARG is positive, and disable it otherwise. If called from
2146 Lisp, enable the mode if ARG is omitted or nil.
2148 When Compilation Shell minor mode is enabled, all the
2149 error-parsing commands of the Compilation major mode are
2150 available but bound to keys that don't collide with Shell mode.
2151 See `compilation-mode'."
2152 nil " Shell-Compile"
2154 (if compilation-shell-minor-mode
2155 (compilation-setup t)
2156 (compilation--unsetup)))
2159 (define-minor-mode compilation-minor-mode
2160 "Toggle Compilation minor mode.
2161 With a prefix argument ARG, enable Compilation minor mode if ARG
2162 is positive, and disable it otherwise. If called from Lisp,
2163 enable the mode if ARG is omitted or nil.
2165 When Compilation minor mode is enabled, all the error-parsing
2166 commands of Compilation major mode are available. See
2167 `compilation-mode'."
2170 (if compilation-minor-mode
2171 (compilation-setup t)
2172 (compilation--unsetup)))
2174 (defun compilation-handle-exit (process-status exit-status msg)
2175 "Write MSG in the current buffer and hack its `mode-line-process'."
2176 (let ((inhibit-read-only t)
2177 (status (if compilation-exit-message-function
2178 (funcall compilation-exit-message-function
2179 process-status exit-status msg)
2180 (cons msg exit-status)))
2183 (cur-buffer (current-buffer)))
2184 ;; Record where we put the message, so we can ignore it later on.
2186 (insert ?\n mode-name " " (car status))
2187 (if (and (numberp compilation-window-height)
2188 (zerop compilation-window-height))
2189 (message "%s" (cdr status)))
2192 (insert " at " (substring (current-time-string) 0 19))
2193 (goto-char (point-max))
2194 ;; Prevent that message from being recognized as a compilation error.
2195 (add-text-properties omax (point)
2196 (append '(compilation-handle-exit t) nil))
2197 (setq mode-line-process
2198 (let ((out-string (format ":%s [%s]" process-status (cdr status)))
2199 (msg (format "%s %s" mode-name
2200 (replace-regexp-in-string "\n?$" ""
2203 (propertize out-string
2205 'face (if (> exit-status 0)
2206 'compilation-mode-line-fail
2207 'compilation-mode-line-exit))))
2208 ;; Force mode line redisplay soon.
2209 (force-mode-line-update)
2210 (if (and opoint (< opoint omax))
2213 (if compilation-finish-function
2214 (funcall compilation-finish-function cur-buffer msg)))
2215 (run-hook-with-args 'compilation-finish-functions cur-buffer msg)))
2217 ;; Called when compilation process changes state.
2218 (defun compilation-sentinel (proc msg)
2219 "Sentinel for compilation buffers."
2220 (if (memq (process-status proc) '(exit signal))
2221 (let ((buffer (process-buffer proc)))
2222 (if (null (buffer-name buffer))
2224 (set-process-buffer proc nil)
2225 (with-current-buffer buffer
2226 ;; Write something in the compilation buffer
2227 ;; and hack its mode line.
2228 (compilation-handle-exit (process-status proc)
2229 (process-exit-status proc)
2231 ;; Since the buffer and mode line will show that the
2232 ;; process is dead, we can delete it now. Otherwise it
2233 ;; will stay around until M-x list-processes.
2234 (delete-process proc)))
2235 (setq compilation-in-progress (delq proc compilation-in-progress)))))
2237 (defun compilation-filter (proc string)
2238 "Process filter for compilation buffers.
2239 Just inserts the text,
2240 handles carriage motion (see `comint-inhibit-carriage-motion'),
2241 and runs `compilation-filter-hook'."
2242 (when (buffer-live-p (process-buffer proc))
2243 (with-current-buffer (process-buffer proc)
2244 (let ((inhibit-read-only t)
2245 ;; `save-excursion' doesn't use the right insertion-type for us.
2246 (pos (copy-marker (point) t))
2247 ;; `save-restriction' doesn't use the right insertion type either:
2248 ;; If we are inserting at the end of the accessible part of the
2249 ;; buffer, keep the inserted text visible.
2250 (min (point-min-marker))
2251 (max (copy-marker (point-max) t))
2252 (compilation-filter-start (marker-position (process-mark proc))))
2256 (goto-char compilation-filter-start)
2257 ;; We used to use `insert-before-markers', so that windows with
2258 ;; point at `process-mark' scroll along with the output, but we
2259 ;; now use window-point-insertion-type instead.
2261 (unless comint-inhibit-carriage-motion
2262 (comint-carriage-motion (process-mark proc) (point)))
2263 (set-marker (process-mark proc) (point))
2264 ;; (set (make-local-variable 'compilation-buffer-modtime)
2266 (run-hooks 'compilation-filter-hook))
2268 (narrow-to-region min max)
2269 (set-marker pos nil)
2270 (set-marker min nil)
2271 (set-marker max nil))))))
2273 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
2274 (defsubst compilation-buffer-internal-p ()
2275 "Test if inside a compilation buffer."
2276 (local-variable-p 'compilation-locs))
2278 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
2279 (defsubst compilation-buffer-p (buffer)
2280 "Test if BUFFER is a compilation buffer."
2281 (with-current-buffer buffer
2282 (compilation-buffer-internal-p)))
2284 (defmacro compilation-loop (< property-change 1+ error limit)
2288 (or (setq pt (,property-change pt 'compilation-message))
2289 ;; Handle the case where where the first error message is
2290 ;; at the start of the buffer, and n < 0.
2291 (if (or (eq (get-text-property ,limit 'compilation-message)
2292 (get-text-property opt 'compilation-message))
2294 (user-error ,error compilation-error)
2296 ;; prop 'compilation-message usually has 2 changes, on and off, so
2298 (or (setq msg (get-text-property pt 'compilation-message))
2299 (if (setq pt (,property-change pt 'compilation-message nil ,limit))
2300 (setq msg (get-text-property pt 'compilation-message)))
2301 (user-error ,error compilation-error))
2302 (or (< (compilation--message->type msg) compilation-skip-threshold)
2305 (setq last (compilation--loc->file-struct
2306 (compilation--message->loc msg))))
2308 (if compilation-skip-visited
2309 (compilation--loc->visited (compilation--message->loc msg)))
2310 (if compilation-skip-to-next-location
2311 (eq (compilation--message->loc msg) loc))
2312 ;; count this message only if none of the above are true
2313 (setq n (,1+ n))))))
2315 (defun compilation-next-single-property-change (position prop
2316 &optional object limit)
2319 ;; We parse the buffer here "on-demand" by chunks of 500 chars.
2320 ;; But we could also just parse the whole buffer.
2321 (compilation--ensure-parse
2322 (setq parsed (max compilation--parsed
2323 (min (+ position 500)
2324 (or limit (point-max))))))
2325 (and (or (not (setq res (next-single-property-change
2326 position prop object limit)))
2328 (< position (or limit (point-max)))))
2329 (setq position parsed))
2332 (defun compilation-next-error (n &optional different-file pt)
2333 "Move point to the next error in the compilation buffer.
2334 This function does NOT find the source line like \\[next-error].
2335 Prefix arg N says how many error messages to move forwards (or
2336 backwards, if negative).
2337 Optional arg DIFFERENT-FILE, if non-nil, means find next error for a
2338 file that is different from the current one.
2339 Optional arg PT, if non-nil, specifies the value of point to start
2340 looking for the next message."
2342 (or (compilation-buffer-p (current-buffer))
2343 (error "Not in a compilation buffer"))
2344 (or pt (setq pt (point)))
2345 (compilation--ensure-parse pt)
2346 (let* ((msg (get-text-property pt 'compilation-message))
2347 ;; `loc', `msg', and `last' are used by the compilation-loop macro.
2348 (loc (and msg (compilation--message->loc msg)))
2351 (unless (or msg ; find message near here
2352 (setq msg (get-text-property (max (1- pt) (point-min))
2353 'compilation-message)))
2354 (setq pt (previous-single-property-change pt 'compilation-message nil
2355 (line-beginning-position)))
2356 (unless (setq msg (get-text-property (max (1- pt) (point-min))
2357 'compilation-message))
2358 (setq pt (compilation-next-single-property-change
2359 pt 'compilation-message nil
2360 (line-end-position)))
2361 (or (setq msg (get-text-property pt 'compilation-message))
2362 (setq pt (point)))))
2363 (setq last (compilation--loc->file-struct loc))
2365 (compilation-loop > compilation-next-single-property-change 1-
2366 (if (get-buffer-process (current-buffer))
2368 "Moved past last %s")
2370 ;; Don't move "back" to message at or before point.
2371 ;; Pass an explicit (point-min) to make sure pt is non-nil.
2372 (setq pt (previous-single-property-change
2373 pt 'compilation-message nil (point-min)))
2374 (compilation-loop < previous-single-property-change 1+
2375 "Moved back before first %s" (point-min))))
2378 (error "No %s here" compilation-error))))
2380 (defun compilation-previous-error (n)
2381 "Move point to the previous error in the compilation buffer.
2382 Prefix arg N says how many error messages to move backwards (or
2383 forwards, if negative).
2384 Does NOT find the source line like \\[previous-error]."
2386 (compilation-next-error (- n)))
2388 (defun compilation-next-file (n)
2389 "Move point to the next error for a different file than the current one.
2390 Prefix arg N says how many files to move forwards (or backwards, if negative)."
2392 (compilation-next-error n t))
2394 (defun compilation-previous-file (n)
2395 "Move point to the previous error for a different file than the current one.
2396 Prefix arg N says how many files to move backwards (or forwards, if negative)."
2398 (compilation-next-file (- n)))
2400 (defun compilation-display-error ()
2401 "Display the source for current error in another window."
2403 (setq compilation-current-error (point))
2404 (next-error-no-select 0))
2406 (defun kill-compilation ()
2407 "Kill the process made by the \\[compile] or \\[grep] commands."
2409 (let ((buffer (compilation-find-buffer)))
2410 (if (get-buffer-process buffer)
2411 (interrupt-process (get-buffer-process buffer))
2412 (error "The %s process is not running" (downcase mode-name)))))
2414 (defalias 'compile-mouse-goto-error 'compile-goto-error)
2416 (defun compile-goto-error (&optional event)
2417 "Visit the source for the error message at point.
2418 Use this command in a compilation log buffer."
2419 (interactive (list last-input-event))
2420 (if event (posn-set-point (event-end event)))
2421 (or (compilation-buffer-p (current-buffer))
2422 (error "Not in a compilation buffer"))
2423 (compilation--ensure-parse (point))
2424 (if (get-text-property (point) 'compilation-directory)
2426 (car (get-text-property (point) 'compilation-directory)))
2427 (setq compilation-current-error (point))
2428 (next-error-internal)))
2430 ;; This is mostly unused, but we keep it for the sake of some external
2431 ;; packages which seem to make use of it.
2432 (defun compilation-find-buffer (&optional avoid-current)
2433 "Return a compilation buffer.
2434 If AVOID-CURRENT is nil, and the current buffer is a compilation buffer,
2435 return it. If AVOID-CURRENT is non-nil, return the current buffer only
2437 (if (and (compilation-buffer-internal-p) (not avoid-current))
2439 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)))
2442 (defun compilation-next-error-function (n &optional reset)
2443 "Advance to the next error message and visit the file where the error was.
2444 This is the value of `next-error-function' in Compilation buffers."
2447 (setq compilation-current-error nil))
2448 (let* ((screen-columns compilation-error-screen-columns)
2449 (first-column compilation-first-column)
2451 (msg (compilation-next-error (or n 1) nil
2452 (or compilation-current-error
2453 compilation-messages-start
2455 (loc (compilation--message->loc msg))
2456 (end-loc (compilation--message->end-loc msg))
2457 (marker (point-marker)))
2458 (setq compilation-current-error (point-marker)
2459 overlay-arrow-position
2461 compilation-current-error
2462 (copy-marker (line-beginning-position))))
2463 ;; If loc contains no marker, no error in that file has been visited.
2464 ;; If the marker is invalid the buffer has been killed.
2465 ;; So, recalculate all markers for that file.
2466 (unless (and (compilation--loc->marker loc)
2467 (marker-buffer (compilation--loc->marker loc))
2468 ;; FIXME-omake: For "omake -P", which automatically recompiles
2469 ;; when the file is modified, the line numbers of new output
2470 ;; may not be related to line numbers from earlier output
2471 ;; (earlier markers), so we used to try to detect it here and
2472 ;; force a reparse. But that caused more problems elsewhere,
2473 ;; so instead we now flush the file-structure when we see
2474 ;; omake's message telling it's about to recompile a file.
2475 ;; (or (null (compilation--loc->timestamp loc)) ;A fake-loc
2476 ;; (equal (compilation--loc->timestamp loc)
2477 ;; (setq timestamp compilation-buffer-modtime)))
2479 (with-current-buffer
2480 (apply #'compilation-find-file
2482 (caar (compilation--loc->file-struct loc))
2483 (cadr (car (compilation--loc->file-struct loc)))
2484 (compilation--file-struct->formats
2485 (compilation--loc->file-struct loc)))
2486 (let ((screen-columns
2487 ;; Obey the compilation-error-screen-columns of the target
2488 ;; buffer if its major mode set it buffer-locally.
2489 (if (local-variable-p 'compilation-error-screen-columns)
2490 compilation-error-screen-columns screen-columns))
2491 (compilation-first-column
2492 (if (local-variable-p 'compilation-first-column)
2493 compilation-first-column first-column)))
2496 (goto-char (point-min))
2497 ;; Treat file's found lines in forward order, 1 by 1.
2498 (dolist (line (reverse (cddr (compilation--loc->file-struct loc))))
2499 (when (car line) ; else this is a filename w/o a line#
2500 (compilation-beginning-of-line (- (car line) last -1))
2501 (setq last (car line)))
2502 ;; Treat line's found columns and store/update a marker for each.
2503 (dolist (col (cdr line))
2504 (if (compilation--loc->col col)
2505 (if (eq (compilation--loc->col col) -1)
2506 ;; Special case for range end.
2508 (compilation-move-to-column (compilation--loc->col col)
2511 (skip-chars-forward " \t"))
2512 (if (compilation--loc->marker col)
2513 (set-marker (compilation--loc->marker col) (point))
2514 (setf (compilation--loc->marker col) (point-marker)))
2515 ;; (setf (compilation--loc->timestamp col) timestamp)
2517 (compilation-goto-locus marker (compilation--loc->marker loc)
2518 (compilation--loc->marker end-loc))
2519 (setf (compilation--loc->visited loc) t)))
2521 (defvar compilation-gcpro nil
2522 "Internal variable used to keep some values from being GC'd.")
2523 (make-variable-buffer-local 'compilation-gcpro)
2525 (defun compilation-fake-loc (marker file &optional line col)
2526 "Preassociate MARKER with FILE.
2527 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
2528 This is useful when you compile temporary files, but want
2529 automatic translation of the messages to the real buffer from
2530 which the temporary file came. This may also affect previous messages
2533 Optional args LINE and COL default to 1 and beginning of
2534 indentation respectively. The marker is expected to reflect
2535 this. In the simplest case the marker points to the first line
2536 of the region that was saved to the temp file.
2538 If you concatenate several regions into the temp file (e.g. a
2539 header with variable assignments and a code region), you must
2540 call this several times, once each for the last line of one
2541 region and the first line of the next region."
2542 (or (consp file) (setq file (list file)))
2543 (compilation--flush-file-structure file)
2544 (let ((fs (compilation-get-file-structure file)))
2545 ;; Between the current call to compilation-fake-loc and the first
2546 ;; occurrence of an error message referring to `file', the data is
2547 ;; only kept in the weak hash-table compilation-locs, so we need
2548 ;; to prevent this entry in compilation-locs from being GC'd
2550 (push fs compilation-gcpro)
2551 (let ((loc (compilation-assq (or line 1) (cdr fs))))
2552 (setq loc (compilation-assq col loc))
2553 (cl-assert (null (cdr loc)))
2554 (setcdr loc (compilation--make-cdrloc line fs marker))
2557 (defcustom compilation-context-lines nil
2558 "Display this many lines of leading context before the current message.
2559 If nil and the left fringe is displayed, don't scroll the
2560 compilation output window; an arrow in the left fringe points to
2561 the current message. If nil and there is no left fringe, the message
2562 displays at the top of the window; there is no arrow."
2563 :type '(choice integer (const :tag "No window scrolling" nil))
2567 (defsubst compilation-set-window (w mk)
2568 "Align the compilation output window W with marker MK near top."
2569 (if (integerp compilation-context-lines)
2570 (set-window-start w (save-excursion
2572 (compilation-beginning-of-line
2573 (- 1 compilation-context-lines))
2575 ;; If there is no left fringe.
2576 (when (equal (car (window-fringes w)) 0)
2577 (set-window-start w (save-excursion
2579 (beginning-of-line 1)
2581 (set-window-point w mk))
2583 (defvar next-error-highlight-timer)
2585 (defun compilation-goto-locus (msg mk end-mk)
2586 "Jump to an error corresponding to MSG at MK.
2587 All arguments are markers. If END-MK is non-nil, mark is set there
2588 and overlay is highlighted between MK and END-MK."
2589 ;; Show compilation buffer in other window, scrolled to this error.
2590 (let* ((from-compilation-buffer (eq (window-buffer)
2591 (marker-buffer msg)))
2592 ;; Use an existing window if it is in a visible frame.
2593 (pre-existing (get-buffer-window (marker-buffer msg) 0))
2594 (w (if (and from-compilation-buffer pre-existing)
2595 ;; Calling display-buffer here may end up (partly) hiding
2596 ;; the error location if the two buffers are in two
2597 ;; different frames. So don't do it if it's not necessary.
2599 (display-buffer (marker-buffer msg) '(nil (allow-no-window . t)))))
2600 (highlight-regexp (with-current-buffer (marker-buffer msg)
2601 ;; also do this while we change buffer
2602 (goto-char (marker-position msg))
2603 (and w (compilation-set-window w msg))
2604 compilation-highlight-regexp)))
2605 ;; Ideally, the window-size should be passed to `display-buffer'
2606 ;; so it's only used when creating a new window.
2607 (when (and (not pre-existing) w)
2608 (compilation-set-window-height w))
2610 (if from-compilation-buffer
2611 ;; If the compilation buffer window was selected,
2612 ;; keep the compilation buffer in this window;
2613 ;; display the source in another window.
2614 (let ((pop-up-windows t))
2615 (pop-to-buffer (marker-buffer mk) 'other-window))
2616 (switch-to-buffer (marker-buffer mk)))
2617 (unless (eq (goto-char mk) (point))
2618 ;; If narrowing gets in the way of going to the right place, widen.
2620 (if next-error-move-function
2621 (funcall next-error-move-function msg mk)
2624 (push-mark end-mk t)
2625 (if mark-active (setq mark-active nil)))
2626 ;; If hideshow got in the way of
2627 ;; seeing the right place, open permanently.
2628 (dolist (ov (overlays-at (point)))
2629 (when (eq 'hs (overlay-get ov 'invisible))
2633 (when highlight-regexp
2634 (if (timerp next-error-highlight-timer)
2635 (cancel-timer next-error-highlight-timer))
2636 (unless compilation-highlight-overlay
2637 (setq compilation-highlight-overlay
2638 (make-overlay (point-min) (point-min)))
2639 (overlay-put compilation-highlight-overlay 'face 'next-error))
2640 (with-current-buffer (marker-buffer mk)
2642 (if end-mk (goto-char end-mk) (end-of-line))
2643 (let ((end (point)))
2644 (if mk (goto-char mk) (beginning-of-line))
2645 (if (and (stringp highlight-regexp)
2646 (re-search-forward highlight-regexp end t))
2648 (goto-char (match-beginning 0))
2649 (move-overlay compilation-highlight-overlay
2650 (match-beginning 0) (match-end 0)
2652 (move-overlay compilation-highlight-overlay
2653 (point) end (current-buffer)))
2654 (if (or (eq next-error-highlight t)
2655 (numberp next-error-highlight))
2656 ;; We want highlighting: delete overlay on next input.
2657 (add-hook 'pre-command-hook
2658 'compilation-goto-locus-delete-o)
2659 ;; We don't want highlighting: delete overlay now.
2660 (delete-overlay compilation-highlight-overlay))
2661 ;; We want highlighting for a limited time:
2662 ;; set up a timer to delete it.
2663 (when (numberp next-error-highlight)
2664 (setq next-error-highlight-timer
2665 (run-at-time next-error-highlight nil
2666 'compilation-goto-locus-delete-o)))))))
2667 (when (and (eq next-error-highlight 'fringe-arrow))
2668 ;; We want a fringe arrow (instead of highlighting).
2669 (setq next-error-overlay-arrow-position
2670 (copy-marker (line-beginning-position))))))
2672 (defun compilation-goto-locus-delete-o ()
2673 (delete-overlay compilation-highlight-overlay)
2674 ;; Get rid of timer and hook that would try to do this again.
2675 (if (timerp next-error-highlight-timer)
2676 (cancel-timer next-error-highlight-timer))
2677 (remove-hook 'pre-command-hook
2678 'compilation-goto-locus-delete-o))
2680 (defun compilation-find-file (marker filename directory &rest formats)
2681 "Find a buffer for file FILENAME.
2682 If FILENAME is not found at all, ask the user where to find it.
2683 Pop up the buffer containing MARKER and scroll to MARKER if we ask
2684 the user where to find the file.
2685 Search the directories in `compilation-search-path'.
2686 A nil in `compilation-search-path' means to try the
2687 \"current\" directory, which is passed in DIRECTORY.
2688 If DIRECTORY is relative, it is combined with `default-directory'.
2689 If DIRECTORY is nil, that means use `default-directory'.
2690 FORMATS, if given, is a list of formats to reformat FILENAME when
2691 looking for it: for each element FMT in FORMATS, this function
2692 attempts to find a file whose name is produced by (format FMT FILENAME)."
2693 (or formats (setq formats '("%s")))
2694 (let ((dirs compilation-search-path)
2695 (spec-dir (if directory
2696 (expand-file-name directory)
2698 buffer thisdir fmts name)
2699 (if (file-name-absolute-p filename)
2700 ;; The file name is absolute. Use its explicit directory as
2701 ;; the first in the search path, and strip it from FILENAME.
2702 (setq filename (abbreviate-file-name (expand-file-name filename))
2703 dirs (cons (file-name-directory filename) dirs)
2704 filename (file-name-nondirectory filename)))
2705 ;; Now search the path.
2706 (while (and dirs (null buffer))
2707 (setq thisdir (or (car dirs) spec-dir)
2709 ;; For each directory, try each format string.
2710 (while (and fmts (null buffer))
2711 (setq name (expand-file-name (format (car fmts) filename) thisdir)
2712 buffer (and (file-exists-p name)
2713 (find-file-noselect name))
2715 (setq dirs (cdr dirs)))
2716 (while (null buffer) ;Repeat until the user selects an existing file.
2717 ;; The file doesn't exist. Ask the user where to find it.
2718 (save-excursion ;This save-excursion is probably not right.
2719 (let ((w (let ((pop-up-windows t))
2720 (display-buffer (marker-buffer marker)
2721 '(nil (allow-no-window . t))))))
2722 (with-current-buffer (marker-buffer marker)
2724 (and w (compilation-set-window w marker)))
2725 (let* ((name (read-file-name
2726 (format "Find this %s in (default %s): "
2727 compilation-error filename)
2728 spec-dir filename t nil
2729 ;; The predicate below is fine when called from
2730 ;; minibuffer-complete-and-exit, but it's too
2731 ;; restrictive otherwise, since it also prevents the
2732 ;; user from completing "fo" to "foo/" when she
2733 ;; wants to enter "foo/bar".
2735 ;; Try to make sure the user can only select
2736 ;; a valid answer. This predicate may be ignored,
2737 ;; tho, so we still have to double-check afterwards.
2738 ;; TODO: We should probably fix read-file-name so
2739 ;; that it never ignores this predicate, even when
2740 ;; using popup dialog boxes.
2742 ;; (if (file-directory-p name)
2743 ;; (setq name (expand-file-name filename name)))
2744 ;; (file-exists-p name))
2748 ((not (file-exists-p name))
2749 (message "Cannot find file `%s'" name)
2751 ((and (file-directory-p name)
2753 (setq name (expand-file-name filename name)))))
2754 (message "No `%s' in directory %s" filename origname)
2757 (setq buffer (find-file-noselect name))))))))
2758 ;; Make intangible overlays tangible.
2759 ;; This is weird: it's not even clear which is the current buffer,
2760 ;; so the code below can't be expected to DTRT here. -- Stef
2761 (dolist (ov (overlays-in (point-min) (point-max)))
2762 (when (overlay-get ov 'intangible)
2763 (overlay-put ov 'intangible nil)))
2766 (defun compilation-get-file-structure (file &optional fmt)
2767 "Retrieve FILE's file-structure or create a new one.
2768 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
2769 In the former case, FILENAME may be relative or absolute.
2771 The file-structure looks like this:
2772 ((FILENAME [TRUE-DIRNAME]) FMT ...)
2774 TRUE-DIRNAME is the `file-truename' of DIRNAME, if given."
2775 (or (gethash file compilation-locs)
2776 ;; File was not previously encountered, at least not in the form passed.
2777 ;; Let's normalize it and look again.
2778 (let ((filename (car file))
2779 ;; Get the specified directory from FILE.
2780 (spec-directory (if (cdr file)
2781 (file-truename (cdr file)))))
2783 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2784 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2786 (when (and (boundp 'comint-file-name-prefix)
2787 (not (equal comint-file-name-prefix "")))
2788 (if (file-name-absolute-p filename)
2790 (concat comint-file-name-prefix filename))
2792 (setq spec-directory
2794 (concat comint-file-name-prefix spec-directory))))))
2796 ;; If compilation-parse-errors-filename-function is
2797 ;; defined, use it to process the filename.
2798 (when compilation-parse-errors-filename-function
2800 (funcall compilation-parse-errors-filename-function
2803 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
2804 ;; file names like "./bar//foo.c" for file "bar/foo.c";
2805 ;; expand-file-name will collapse these into "/foo.c" and fail to find
2806 ;; the appropriate file. So we look for doubled slashes in the file
2807 ;; name and fix them.
2808 (setq filename (command-line-normalize-file-name filename))
2810 ;; Store it for the possibly unnormalized name
2812 ;; Retrieve or create file-structure for normalized name
2813 ;; The gethash used to not use spec-directory, but
2814 ;; this leads to errors when files in different
2815 ;; directories have the same name:
2816 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00463.html
2817 (or (gethash (cons filename spec-directory) compilation-locs)
2818 (puthash (cons filename spec-directory)
2819 (compilation--make-file-struct
2820 (list filename spec-directory) fmt)
2822 compilation-locs))))
2824 (defun compilation--flush-file-structure (file)
2825 (or (consp file) (setq file (list file)))
2826 (let ((fs (compilation-get-file-structure file)))
2827 (cl-assert (eq fs (gethash file compilation-locs)))
2828 (cl-assert (eq fs (gethash (cons (caar fs) (cadr (car fs)))
2830 (maphash (lambda (k v)
2831 (if (eq v fs) (remhash k compilation-locs)))
2834 ;;; Compatibility with the old compile.el.
2836 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
2837 (defvar compilation-parsing-end (make-marker))
2838 (defvar compilation-error-list nil)
2839 (defvar compilation-old-error-list nil)
2841 (defun compilation--compat-error-properties (err)
2842 "Map old-style error ERR to new-style message."
2843 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
2844 ;; (MARKER . MARKER).
2845 (let ((dst (cdr err)))
2847 `(compilation-message ,(compilation--make-message
2848 (cons nil (compilation--make-cdrloc
2851 help-echo "mouse-2: visit the source location"
2852 keymap compilation-button-map
2853 mouse-face highlight)
2854 ;; Too difficult to do it by hand: dispatch to the normal code.
2855 (let* ((file (pop dst))
2858 (filename (pop file))
2859 (dirname (pop file))
2861 (compilation-internal-error-properties
2862 (cons filename dirname) line nil col nil 2 fmt)))))
2864 (defun compilation--compat-parse-errors (limit)
2865 (when compilation-parse-errors-function
2866 ;; FIXME: We should remove the rest of the compilation keywords
2867 ;; but we can't do that from here because font-lock is using
2868 ;; the value right now. --Stef
2870 (setq compilation-error-list nil)
2871 ;; Reset compilation-parsing-end each time because font-lock
2872 ;; might force us the re-parse many times (typically because
2873 ;; some code adds some text-property to the output that we
2874 ;; already parsed). You might say "why reparse", well:
2875 ;; because font-lock has just removed the `compilation-message' property
2876 ;; so have to do it all over again.
2877 (if compilation-parsing-end
2878 (set-marker compilation-parsing-end (point))
2879 (setq compilation-parsing-end (point-marker)))
2881 ;; Ignore any error: we're calling this function earlier than
2882 ;; in the old compile.el so things might not all be setup yet.
2883 (funcall compilation-parse-errors-function limit nil)
2885 (dolist (err (if (listp compilation-error-list) compilation-error-list))
2886 (let* ((src (car err))
2888 (loc (cond ((markerp dst)
2890 (compilation--make-cdrloc nil nil dst)))
2893 (compilation--make-cdrloc
2895 (cons (cdar dst) (caar dst))
2899 ;; (put-text-property src (line-end-position)
2900 ;; 'font-lock-face 'font-lock-warning-face)
2901 (put-text-property src (line-end-position)
2902 'compilation-message
2903 (compilation--make-message loc 2 nil)))))))
2907 ;; Beware! this is not only compatibility code. New code also uses it. --Stef
2908 (defun compilation-forget-errors ()
2909 ;; In case we hit the same file/line specs, we want to recompute a new
2910 ;; marker for them, so flush our cache.
2911 (clrhash compilation-locs)
2912 (setq compilation-gcpro nil)
2913 ;; FIXME: the old code reset the directory-stack, so maybe we should
2914 ;; put a `directory change' marker of some sort, but where? -stef
2916 ;; FIXME: The old code moved compilation-current-error (which was
2917 ;; virtually represented by a mix of compilation-parsing-end and
2918 ;; compilation-error-list) to point-min, but that was only meaningful for
2919 ;; the internal uses of compilation-forget-errors: all calls from external
2920 ;; packages seem to be followed by a move of compilation-parsing-end to
2921 ;; something equivalent to point-max. So we heuristically move
2922 ;; compilation-current-error to point-max (since the external package
2923 ;; won't know that it should do it). --Stef
2924 (setq compilation-current-error nil)
2925 (let* ((proc (get-buffer-process (current-buffer)))
2926 (mark (if proc (process-mark proc)))
2927 (pos (or mark (point-max))))
2928 (setq compilation-messages-start
2929 ;; In the future, ignore the text already present in the buffer.
2930 ;; Since many process filter functions insert before markers,
2931 ;; we need to put ours just before the insertion point rather
2932 ;; than at the insertion point. If that's not possible, then
2933 ;; don't use a marker. --Stef
2934 (if (> pos (point-min)) (copy-marker (1- pos)) pos)))
2935 ;; Again, since this command is used in buffers that contain several
2936 ;; compilations, to set the beginning of "this compilation", it's a good
2937 ;; place to reset compilation-auto-jump-to-next.
2938 (set (make-local-variable 'compilation-auto-jump-to-next)
2939 (or compilation-auto-jump-to-first-error
2940 (eq compilation-scroll-output 'first-error))))
2944 ;;; compile.el ends here