1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages
3 ;; Copyright (C) 1985-1987, 1993-1999, 2001-2012
4 ;; Free Software Foundation, Inc.
6 ;; Authors: Roland McGrath <roland@gnu.org>,
7 ;; Daniel Pfeiffer <occitan@esperanto.org>
9 ;; Keywords: tools, processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 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))
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' (see `run-mode-hooks')."
50 (defcustom compilation-start-hook nil
51 "List of hook functions run by `compilation-start' on the compilation process.
52 \(See `run-hook-with-args').
53 If you use \"omake -P\" and do not want \\[save-buffers-kill-terminal] to ask whether you want
54 the compilation to be killed, you can use this hook:
55 (add-hook 'compilation-start-hook
56 (lambda (process) (set-process-query-on-exit-flag process nil)) nil t)"
61 (defcustom compilation-window-height nil
62 "Number of lines in a compilation window. If nil, use Emacs default."
63 :type '(choice (const :tag "Default" nil)
67 (defvar compilation-filter-hook nil
68 "Hook run after `compilation-filter' has inserted a string into the buffer.
69 It is called with the variable `compilation-filter-start' bound
70 to the position of the start of the inserted text, and point at
73 If Emacs lacks asynchronous process support, this hook is run
74 after `call-process' inserts the grep output into the buffer.")
76 (defvar compilation-filter-start nil
77 "Start of the text inserted by `compilation-filter'.
78 This is bound to a buffer position before running `compilation-filter-hook'.")
80 (defvar compilation-first-column 1
81 "*This is how compilers number the first column, usually 1 or 0.")
83 (defvar compilation-parse-errors-filename-function nil
84 "Function to call to post-process filenames while parsing error messages.
85 It takes one arg FILENAME which is the name of a file as found
86 in the compilation output, and should return a transformed file name.")
89 (defvar compilation-process-setup-function nil
90 "*Function to call to customize the compilation process.
91 This function is called immediately before the compilation process is
92 started. It can be used to set any variables or functions that are used
93 while processing the output of the compilation process.")
96 (defvar compilation-buffer-name-function nil
97 "Function to compute the name of a compilation buffer.
98 The function receives one argument, the name of the major mode of the
99 compilation buffer. It should return a string.
100 If nil, compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
103 (defvar compilation-finish-function nil
104 "Function to call when a compilation process finishes.
105 It is called with two arguments: the compilation buffer, and a string
106 describing how the process finished.")
108 (make-obsolete-variable 'compilation-finish-function
109 "use `compilation-finish-functions', but it works a little differently."
113 (defvar compilation-finish-functions nil
114 "Functions to call when a compilation process finishes.
115 Each function is called with two arguments: the compilation buffer,
116 and a string describing how the process finished.")
118 (defvar compilation-in-progress nil
119 "List of compilation processes now running.")
120 (or (assq 'compilation-in-progress minor-mode-alist)
121 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
124 (defvar compilation-error "error"
125 "Stem of message to print when no matches are found.")
127 (defvar compilation-arguments nil
128 "Arguments that were given to `compilation-start'.")
130 (defvar compilation-num-errors-found)
132 ;; If you make any changes to `compilation-error-regexp-alist-alist',
133 ;; be sure to run the ERT test in test/automated/compile-tests.el.
135 (defvar compilation-error-regexp-alist-alist
137 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
138 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
141 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
144 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
147 "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\):\\)?\
148 \\( warning\\)?" 1 (2 . 4) (3 . 5) (6))
151 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
154 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
155 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
156 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
158 (python-tracebacks-and-caml
159 "^[ \t]*File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
160 \\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning\\(?: [0-9]+\\)?:\\)?\\)"
161 2 (3 . 4) (5 . 6) (7))
164 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
165 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
168 "\\(?:^cucumber\\(?: -p [^[:space:]]+\\)?\\|#\\)\
169 \\(?: \\)\\([^\(].*\\):\\([1-9][0-9]*\\)" 1 2)
172 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
175 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
179 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
182 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
186 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
190 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
191 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
193 ;; fixme: should be `mips'
195 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
196 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
199 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
202 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
205 ;; This used to be pathologically slow on long lines (Bug#3441),
206 ;; due to matching filenames via \\(.*?\\). This might be faster.
208 ;; Maven is a popular free software build tool for Java.
209 "\\([0-9]*[^0-9\n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\):\\[\\([0-9]+\\),\\([0-9]+\\)\\] " 1 2 3)
212 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
214 (2 (compilation-face '(3))))
217 "^\\(?:In file included \\| \\|\t\\)from \
218 \\([0-9]*[^0-9\n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\):\
219 \\([0-9]+\\)\\(?::\\([0-9]+\\)\\)?\\(?:\\(:\\)\\|\\(,\\|$\\)\\)?"
223 "^[\t ]*\\[\\([^\(].*\\):\\([1-9][0-9]*\\)\\(\\]\\)?:in " 1 2)
226 ;; The first line matches the program name for
228 ;; PROGRAM:SOURCE-FILE-NAME:LINENO: MESSAGE
230 ;; format, which is used for non-interactive programs other than
231 ;; compilers (e.g. the "jade:" entry in compilation.txt).
233 ;; This first line makes things ambiguous with output such as
234 ;; "foo:344:50:blabla" since the "foo" part can match this first
235 ;; line (in which case the file name as "344"). To avoid this,
236 ;; the second line disallows filenames exclusively composed of
239 ;; Similarly, we get lots of false positives with messages including
240 ;; times of the form "HH:MM:SS" where MM is taken as a line number, so
241 ;; the last line tries to rule out message where the info after the
242 ;; line number starts with "SS". --Stef
244 ;; The core of the regexp is the one with *?. It says that a file name
245 ;; can be composed of any non-newline char, but it also rules out some
246 ;; valid but unlikely cases, such as a trailing space or a space
247 ;; followed by a -, or a colon followed by a space.
249 ;; The "in \\|from " exception was added to handle messages from Ruby.
250 "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\|[ \t]+\\(?:in \\|from \\)\\)?\
251 \\([0-9]*[^0-9\n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\): ?\
252 \\([0-9]+\\)\\(?:[.:]\\([0-9]+\\)\\)?\
253 \\(?:-\\([0-9]+\\)?\\(?:\\.\\([0-9]+\\)\\)?\\)?:\
254 \\(?: *\\(\\(?:Future\\|Runtime\\)?[Ww]arning\\|W:\\)\\|\
255 *\\([Ii]nfo\\(?:\\>\\|rmationa?l?\\)\\|I:\\|instantiated from\\|[Nn]ote\\)\\|\
256 *[Ee]rror\\|\[0-9]?\\(?:[^0-9\n]\\|$\\)\\|[0-9][0-9][0-9]\\)"
257 1 (2 . 4) (3 . 5) (6 . 7))
260 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
264 "^makepp\\(?:\\(?:: warning\\(:\\).*?\\|\\(: Scanning\\|: [LR]e?l?oading makefile\\|: Imported\\|log:.*?\\) \\|: .*?\\)\
265 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
267 (0 (progn (save-match-data
268 (compilation-parse-errors
269 (match-end 0) (line-end-position)
270 `("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]"
272 ,(cond ((match-end 1) 1) ((match-end 2) 0) (t 2))
277 ;; Should be lint-1, lint-2 (SysV lint)
279 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
281 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
284 ;; The message may be a "warning", "error", or "fatal error" with
285 ;; an error code, or "see declaration of" without an error code.
286 "^ *\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
287 : \\(?:see declaration\\|\\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:\\)"
291 ;; "omake -P" reports "file foo changed"
292 ;; (useful if you do "cvs up" and want to see what has changed)
293 "omake: file \\(.*\\) changed" 1 nil nil nil nil
294 ;; FIXME-omake: This tries to prevent reusing pre-existing markers
295 ;; for subsequent messages, since those messages's line numbers
296 ;; are about another version of the file.
297 (0 (progn (compilation--flush-file-structure (match-string 1))
301 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
302 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
303 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
306 ;; "during global destruction": This comes out under "use
307 ;; warnings" in recent perl when breaking circular references
308 ;; during program or thread exit.
310 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\| \
311 during global destruction\\.$\\)" 1 2)
314 "\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)"
318 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
319 \\([0-9]+\\) of file://\\(.+\\)"
323 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
324 [12][09][0-9][0-9] +\\(.*\\):$"
327 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
328 nil 3 nil (2) nil (1 (compilation-face '(2))))
329 (sparc-pascal-example
330 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
331 nil 1 nil (3) nil (2 (compilation-face '(3))))
334 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
335 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
339 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
342 "^[ \t]*\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)): ?\
343 \\(?:\\(Error! E[0-9]+\\)\\|\\(Warning! W[0-9]+\\)\\):"
347 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
348 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3))
351 "^ *-: *\\(0\\):Source:\\(.+\\)$"
354 "^ *-: *\\(0\\):\\(?:Object\\|Graph\\|Data\\|Runs\\|Programs\\):.+$"
356 ;; Underlines over all lines of gcov output are too uncomfortable to read.
357 ;; However, hyperlinks embedded in the lines are useful.
358 ;; So I put default face on the lines; and then put
359 ;; compilation-*-face by manually to eliminate the underlines.
360 ;; The hyperlinks are still effective.
362 "^ *-: *\\([1-9]\\|[0-9]\\{2,\\}\\):.*$"
365 (1 compilation-line-face))
367 "^ *\\([0-9]+\\): *\\([0-9]+\\):.*$"
370 (1 compilation-info-face) (2 compilation-line-face))
372 "^ *\\(#####\\): *\\([0-9]+\\):.*$"
375 (1 compilation-error-face) (2 compilation-line-face))
378 ;; podchecker error messages, per Pod::Checker.
379 ;; The style is from the Pod::Checker::poderror() function, eg.
380 ;; *** ERROR: Spurious text after =cut at line 193 in file foo.pm
382 ;; Plus end_pod() can give "at line EOF" instead of a
383 ;; number, so for that match "on line N" which is the
384 ;; originating spot, eg.
385 ;; *** ERROR: =over on line 37 without closing =back at line EOF in file bar.pm
387 ;; Plus command() can give both "on line N" and "at line N";
388 ;; the latter is desired and is matched because the .* is
390 ;; *** ERROR: =over on line 1 without closing =back (at head1) at line 3 in file x.pod
392 "^\\*\\*\\* \\(?:ERROR\\|\\(WARNING\\)\\).* \\(?:at\\|on\\) line \
393 \\([0-9]+\\) \\(?:.* \\)?in file \\([^ \t\n]+\\)"
396 ;; perl Test module error messages.
397 ;; Style per the ok() function "$context", eg.
398 ;; # Failed test 1 in foo.t at line 6
400 "^# Failed test [0-9]+ in \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
403 ;; Or when comparing got/want values, with a "fail #n" if repeated
404 ;; # Test 2 got: "xx" (t-compilation-perl-2.t at line 10)
405 ;; # Test 3 got: "xx" (t-compilation-perl-2.t at line 10 fail #2)
407 ;; And under Test::Harness they're preceded by progress stuff with
409 ;; ... NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
411 "^\\(.*NOK.*\\)?# Test [0-9]+ got:.* (\\([^ \t\r\n]+\\) at line \
412 \\([0-9]+\\)\\( fail #[0-9]+\\)?)"
415 ;; perl Test::Harness output, eg.
416 ;; NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
418 ;; Test::Harness is slightly designed for tty output, since
419 ;; it prints CRs to overwrite progress messages, but if you
420 ;; run it in with M-x compile this pattern can at least step
421 ;; through the failures.
423 "^.*NOK.* \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
426 ;; The style comes from HTML::Lint::Error::as_string(), eg.
427 ;; index.html (13:1) Unknown element <fdjsk>
429 ;; The pattern only matches filenames without spaces, since that
430 ;; should be usual and should help reduce the chance of a false
431 ;; match of a message from some unrelated program.
433 ;; This message style is quite close to the "ibm" entry which is
434 ;; for IBM C, though that ibm bit doesn't put a space after the
437 "^\\([^ \t\r\n(]+\\) (\\([0-9]+\\):\\([0-9]+\\)) "
440 "Alist of values for `compilation-error-regexp-alist'.")
442 (defcustom compilation-error-regexp-alist
443 (mapcar 'car compilation-error-regexp-alist-alist)
444 "Alist that specifies how to match errors in compiler output.
445 On GNU and Unix, any string is a valid filename, so these
446 matchers must make some common sense assumptions, which catch
447 normal cases. A shorter list will be lighter on resource usage.
449 Instead of an alist element, you can use a symbol, which is
450 looked up in `compilation-error-regexp-alist-alist'. You can see
451 the predefined symbols and their effects in the file
452 `etc/compilation.txt' (linked below if you are customizing this).
454 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
455 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
456 gives the file name, and the LINE'th subexpression gives the line
457 number. The COLUMN'th subexpression gives the column number on
460 If FILE, LINE or COLUMN are nil or that index didn't match, that
461 information is not present on the matched line. In that case the
462 file name is assumed to be the same as the previous one in the
463 buffer, line number defaults to 1 and column defaults to
464 beginning of line's indentation.
466 FILE can also have the form (FILE FORMAT...), where the FORMATs
467 \(e.g. \"%s.c\") will be applied in turn to the recognized file
468 name, until a file of that name is found. Or FILE can also be a
469 function that returns (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
470 In the former case, FILENAME may be relative or absolute.
472 LINE can also be of the form (LINE . END-LINE) meaning a range
473 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
474 meaning a range of columns starting on LINE and ending on
475 END-LINE, if that matched.
477 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
478 TYPE can also be of the form (WARNING . INFO). In that case this
479 will be equivalent to 1 if the WARNING'th subexpression matched
480 or else equivalent to 0 if the INFO'th subexpression matched.
481 See `compilation-error-face', `compilation-warning-face',
482 `compilation-info-face' and `compilation-skip-threshold'.
484 What matched the HYPERLINK'th subexpression has `mouse-face' and
485 `compilation-message-face' applied. If this is nil, the text
486 matched by the whole REGEXP becomes the hyperlink.
488 Additional HIGHLIGHTs take the shape (SUBMATCH FACE), where SUBMATCH is
489 the number of a submatch that should be highlighted when it matches,
490 and FACE is an expression returning the face to use for that submatch.."
491 :type '(repeat (choice (symbol :tag "Predefined symbol")
492 (sexp :tag "Error specification")))
493 :link `(file-link :tag "example file"
494 ,(expand-file-name "compilation.txt" data-directory))
497 ;;;###autoload(put 'compilation-directory 'safe-local-variable 'stringp)
498 (defvar compilation-directory nil
499 "Directory to restore to when doing `recompile'.")
501 (defvar compilation-directory-matcher
502 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
503 "A list for tracking when directories are entered or left.
504 If nil, do not track directories, e.g. if all file names are absolute. The
505 first element is the REGEXP matching these messages. It can match any number
506 of variants, e.g. different languages. The remaining elements are all of the
507 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
508 matches, that is a directory name. If LEAVE is nil or the corresponding
509 LEAVE'th subexpression doesn't match, this message is about going into another
510 directory. If it does match anything, this message is about going back to the
511 directory we were in before the last entering message. If you change this,
512 you may also want to change `compilation-page-delimiter'.")
514 (defvar compilation-page-delimiter
515 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
516 "Value of `page-delimiter' in Compilation mode.")
518 (defvar compilation-mode-font-lock-keywords
519 '(;; configure output lines.
520 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
521 (1 font-lock-variable-name-face)
522 (2 (compilation-face '(4 . 3))))
523 ;; Command output lines. Recognize `make[n]:' lines too.
524 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
525 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
526 (" --?o\\(?:utfile\\|utput\\)?[= ]\\(\\S +\\)" . 1)
527 ("^Compilation \\(finished\\).*"
528 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
529 (1 compilation-info-face))
530 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\|segmentation fault\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
531 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
532 (1 compilation-error-face)
533 (2 compilation-error-face nil t)))
534 "Additional things to highlight in Compilation mode.
535 This gets tacked on the end of the generated expressions.")
537 (defvar compilation-highlight-regexp t
538 "Regexp matching part of visited source lines to highlight temporarily.
539 Highlight entire line if t; don't highlight source lines if nil.")
541 (defvar compilation-highlight-overlay nil
542 "Overlay used to temporarily highlight compilation matches.")
544 (defcustom compilation-error-screen-columns t
545 "If non-nil, column numbers in error messages are screen columns.
546 Otherwise they are interpreted as character positions, with
547 each character occupying one column.
548 The default is to use screen columns, which requires that the compilation
549 program and Emacs agree about the display width of the characters,
550 especially the TAB character."
555 (defcustom compilation-read-command t
556 "Non-nil means \\[compile] reads the compilation command to use.
557 Otherwise, \\[compile] just uses the value of `compile-command'.
559 Note that changing this to nil may be a security risk, because a
560 file might define a malicious `compile-command' as a file local
561 variable, and you might not notice. Therefore, `compile-command'
562 is considered unsafe if this variable is nil."
567 (defcustom compilation-ask-about-save t
568 "Non-nil means \\[compile] asks which buffers to save before compiling.
569 Otherwise, it saves all modified buffers without asking."
573 (defcustom compilation-save-buffers-predicate nil
574 "The second argument (PRED) passed to `save-some-buffers' before compiling.
575 E.g., one can set this to
577 (string-prefix-p my-compilation-root (file-truename (buffer-file-name))))
578 to limit saving to files located under `my-compilation-root'.
579 Note, that, in general, `compilation-directory' cannot be used instead
580 of `my-compilation-root' here."
582 (const :tag "Default (save all file-visiting buffers)" nil)
583 (const :tag "Save all buffers" t)
589 (defcustom compilation-search-path '(nil)
590 "List of directories to search for source files named in error messages.
591 Elements should be directory names, not file names of directories.
592 The value nil as an element means to try the default directory."
593 :type '(repeat (choice (const :tag "Default" nil)
594 (string :tag "Directory")))
598 (defcustom compile-command (purecopy "make -k ")
599 "Last shell command used to do a compilation; default for next compilation.
601 Sometimes it is useful for files to supply local values for this variable.
602 You might also use mode hooks to specify it in certain modes, like this:
604 (add-hook 'c-mode-hook
606 (unless (or (file-exists-p \"makefile\")
607 (file-exists-p \"Makefile\"))
608 (set (make-local-variable 'compile-command)
610 (file-name-sans-extension buffer-file-name))))))"
613 ;;;###autoload(put 'compile-command 'safe-local-variable (lambda (a) (and (stringp a) (or (not (boundp 'compilation-read-command)) compilation-read-command))))
616 (defcustom compilation-disable-input nil
617 "If non-nil, send end-of-file as compilation process input.
618 This only affects platforms that support asynchronous processes (see
619 `start-process'); synchronous compilation processes never accept input."
624 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
625 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
626 ;; key. This holds the tree seen from root, for storing new nodes.
627 (defvar compilation-locs ())
629 (defvar compilation-debug nil
630 "*Set this to t before creating a *compilation* buffer.
631 Then every error line will have a debug text property with the matcher that
632 fit this line and the match data. Use `describe-text-properties'.")
634 (defvar compilation-exit-message-function nil "\
635 If non-nil, called when a compilation process dies to return a status message.
636 This should be a function of three arguments: process status, exit status,
637 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
638 write into the compilation buffer, and to put in its mode line.")
640 (defcustom compilation-environment nil
641 "List of environment variables for compilation to inherit.
642 Each element should be a string of the form ENVVARNAME=VALUE.
643 This list is temporarily prepended to `process-environment' prior to
644 starting the compilation process."
645 :type '(repeat (string :tag "ENVVARNAME=VALUE"))
646 :options '(("LANG=C"))
650 ;; History of compile commands.
651 (defvar compile-history nil)
653 (defface compilation-error
654 '((t :inherit error))
655 "Face used to highlight compiler errors."
659 (defface compilation-warning
660 '((t :inherit warning))
661 "Face used to highlight compiler warnings."
665 (defface compilation-info
666 '((t :inherit success))
667 "Face used to highlight compiler information."
671 (defface compilation-line-number
672 '((t :inherit font-lock-keyword-face))
673 "Face for displaying line numbers in compiler messages."
677 (defface compilation-column-number
678 '((t :inherit font-lock-doc-face))
679 "Face for displaying column numbers in compiler messages."
683 (defcustom compilation-message-face 'underline
684 "Face name to use for whole messages.
685 Faces `compilation-error-face', `compilation-warning-face',
686 `compilation-info-face', `compilation-line-face' and
687 `compilation-column-face' get prepended to this, when applicable."
692 (defvar compilation-error-face 'compilation-error
693 "Face name to use for file name in error messages.")
695 (defvar compilation-warning-face 'compilation-warning
696 "Face name to use for file name in warning messages.")
698 (defvar compilation-info-face 'compilation-info
699 "Face name to use for file name in informational messages.")
701 (defvar compilation-line-face 'compilation-line-number
702 "Face name to use for line numbers in compiler messages.")
704 (defvar compilation-column-face 'compilation-column-number
705 "Face name to use for column numbers in compiler messages.")
707 ;; same faces as dired uses
708 (defvar compilation-enter-directory-face 'font-lock-function-name-face
709 "Face name to use for entering directory messages.")
711 (defvar compilation-leave-directory-face 'font-lock-builtin-face
712 "Face name to use for leaving directory messages.")
716 ;; Used for compatibility with the old compile.el.
717 (defvar compilation-parse-errors-function nil)
718 (make-obsolete 'compilation-parse-errors-function
719 'compilation-error-regexp-alist "24.1")
721 (defcustom compilation-auto-jump-to-first-error nil
722 "If non-nil, automatically jump to the first error during compilation."
727 (defvar compilation-auto-jump-to-next nil
728 "If non-nil, automatically jump to the next error encountered.")
729 (make-variable-buffer-local 'compilation-auto-jump-to-next)
731 ;; (defvar compilation-buffer-modtime nil
732 ;; "The buffer modification time, for buffers not associated with files.")
733 ;; (make-variable-buffer-local 'compilation-buffer-modtime)
735 (defvar compilation-skip-to-next-location t
736 "*If non-nil, skip multiple error messages for the same source location.")
738 (defcustom compilation-skip-threshold 1
739 "Compilation motion commands skip less important messages.
740 The value can be either 2 -- skip anything less than error, 1 --
741 skip anything less than warning or 0 -- don't skip any messages.
742 Note that all messages not positively identified as warning or
743 info, are considered errors."
744 :type '(choice (const :tag "Skip warnings and info" 2)
745 (const :tag "Skip info" 1)
746 (const :tag "No skip" 0))
750 (defun compilation-set-skip-threshold (level)
751 "Switch the `compilation-skip-threshold' level."
754 (mod (if current-prefix-arg
755 (prefix-numeric-value current-prefix-arg)
756 (1+ compilation-skip-threshold))
758 (setq compilation-skip-threshold level)
759 (message "Skipping %s"
760 (case compilation-skip-threshold
763 (2 "Warnings and info"))))
765 (defcustom compilation-skip-visited nil
766 "Compilation motion commands skip visited messages if this is t.
767 Visited messages are ones for which the file, line and column have been jumped
768 to from the current content in the current compilation buffer, even if it was
769 from a different message."
774 (defun compilation-face (type)
775 (or (and (car type) (match-end (car type)) compilation-warning-face)
776 (and (cdr type) (match-end (cdr type)) compilation-info-face)
777 compilation-error-face))
779 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE nil nil)
781 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
782 ;; LINE will be nil for a message that doesn't contain them. Then the
783 ;; location refers to a indented beginning of line or beginning of file.
784 ;; Once any location in some file has been jumped to, the list is extended to
785 ;; (COLUMN LINE FILE-STRUCTURE MARKER TIMESTAMP . VISITED)
786 ;; for all LOCs pertaining to that file.
787 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
788 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
789 ;; before that point. VISITED is t if we have jumped there, else nil.
790 ;; FIXME-omake: TIMESTAMP was used to try and handle "incremental compilation":
791 ;; `omake -P' polls filesystem for changes and recompiles when a file is
792 ;; modified using the same *compilation* buffer. this necessitates
793 ;; re-parsing markers.
795 ;; (defstruct (compilation--loc
796 ;; (:constructor nil)
798 ;; (:constructor compilation--make-loc
799 ;; (file-struct line col marker))
800 ;; (:conc-name compilation--loc->))
801 ;; col line file-struct marker timestamp visited)
803 ;; FIXME: We don't use a defstruct because of compilation-assq which looks up
804 ;; and creates part of the LOC (only the first cons cell containing the COL).
806 (defmacro compilation--make-cdrloc (line file-struct marker)
807 `(list ,line ,file-struct ,marker nil))
808 (defmacro compilation--loc->col (loc) `(car ,loc))
809 (defmacro compilation--loc->line (loc) `(cadr ,loc))
810 (defmacro compilation--loc->file-struct (loc) `(nth 2 ,loc))
811 (defmacro compilation--loc->marker (loc) `(nth 3 ,loc))
812 ;; (defmacro compilation--loc->timestamp (loc) `(nth 4 ,loc))
813 (defmacro compilation--loc->visited (loc) `(nthcdr 5 ,loc))
815 ;; FILE-STRUCTURE is a list of
816 ;; ((FILENAME DIRECTORY) FORMATS (LINE LOC ...) ...)
818 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
819 ;; obtained by following directory change messages. DIRECTORY will be nil for
820 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
821 ;; a file of that name can't be found.
822 ;; The rest of the list is an alist of elements with LINE as key. The keys
823 ;; are either nil or line numbers. If present, nil comes first, followed by
824 ;; the numbers in decreasing order. The LOCs for each line are again an alist
825 ;; ordered the same way. Note that the whole file structure is referenced in
828 (defmacro compilation--make-file-struct (file-spec formats &optional loc-tree)
829 `(cons ,file-spec (cons ,formats ,loc-tree)))
830 (defmacro compilation--file-struct->file-spec (fs) `(car ,fs))
831 (defmacro compilation--file-struct->formats (fs) `(cadr ,fs))
832 ;; The FORMATS field plays the role of ANCHOR in the loc-tree.
833 (defmacro compilation--file-struct->loc-tree (fs) `(cdr ,fs))
835 ;; MESSAGE is a list of (LOC TYPE END-LOC)
837 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
838 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
839 ;; other end, if the parsed message contained a range. If the end of the
840 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
841 ;; These are the value of the `compilation-message' text-properties in the
842 ;; compilation buffer.
844 (defstruct (compilation--message
847 ;; (:type list) ;Old representation.
848 (:constructor compilation--make-message (loc type end-loc))
849 (:conc-name compilation--message->))
852 (defvar compilation--previous-directory-cache nil
853 "A pair (POS . RES) caching the result of previous directory search.
854 Basically, this pair says that calling
855 (previous-single-property-change POS 'compilation-directory)
856 returned RES, i.e. there is no change of `compilation-directory' between
858 (make-variable-buffer-local 'compilation--previous-directory-cache)
860 (defun compilation--flush-directory-cache (start _end)
862 ((or (not compilation--previous-directory-cache)
863 (<= (car compilation--previous-directory-cache) start)))
864 ((or (not (cdr compilation--previous-directory-cache))
865 (null (marker-buffer (cdr compilation--previous-directory-cache)))
866 (<= (cdr compilation--previous-directory-cache) start))
867 (set-marker (car compilation--previous-directory-cache) start))
868 (t (setq compilation--previous-directory-cache nil))))
870 (defun compilation--previous-directory (pos)
871 "Like (previous-single-property-change POS 'compilation-directory), but faster."
872 ;; This avoids an N² behavior when there's no/few compilation-directory
873 ;; entries, in which case each call to previous-single-property-change
874 ;; ends up having to walk very far back to find the last change.
875 (if (and compilation--previous-directory-cache
876 (< pos (car compilation--previous-directory-cache))
877 (or (null (cdr compilation--previous-directory-cache))
878 (< (cdr compilation--previous-directory-cache) pos)))
879 ;; No need to call previous-single-property-change.
880 (cdr compilation--previous-directory-cache)
882 (let* ((cache (and compilation--previous-directory-cache
883 (<= (car compilation--previous-directory-cache) pos)
884 (car compilation--previous-directory-cache)))
886 (previous-single-property-change
887 pos 'compilation-directory nil cache))
891 (setq compilation--previous-directory-cache
892 (cons (copy-marker pos) (if prev (copy-marker prev))))
894 ((and prev (= prev cache))
896 (set-marker (car compilation--previous-directory-cache) pos)
897 (setq compilation--previous-directory-cache
898 (cons (copy-marker pos) nil)))
899 (cdr compilation--previous-directory-cache))
903 (set-marker cache pos)
904 (setcdr compilation--previous-directory-cache
906 (setq compilation--previous-directory-cache
907 (cons (copy-marker pos) (if prev (copy-marker prev)))))
909 (if (markerp res) (marker-position res) res))))
911 ;; Internal function for calculating the text properties of a directory
912 ;; change message. The compilation-directory property is important, because it
913 ;; is the stack of nested enter-messages. Relative filenames on the following
914 ;; lines are relative to the top of the stack.
915 (defun compilation-directory-properties (idx leave)
916 (if leave (setq leave (match-end leave)))
917 ;; find previous stack, and push onto it, or if `leave' pop it
918 (let ((dir (compilation--previous-directory (match-beginning 0))))
919 (setq dir (if dir (or (get-text-property (1- dir) 'compilation-directory)
920 (get-text-property dir 'compilation-directory))))
921 `(font-lock-face ,(if leave
922 compilation-leave-directory-face
923 compilation-enter-directory-face)
924 compilation-directory ,(if leave
926 '(nil)) ; nil only isn't a property-change
927 (cons (match-string-no-properties idx) dir))
928 ;; Place a `compilation-message' everywhere we change text-properties
929 ;; so compilation--remove-properties can know what to remove.
930 compilation-message ,(compilation--make-message nil 0 nil)
932 keymap compilation-button-map
933 help-echo "mouse-2: visit destination directory")))
935 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
936 ;; KEY element from the ALIST, creating it in the right position if not already
937 ;; present. ALIST structure is
938 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
939 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
940 ;; may be nil. The other KEYs are ordered backwards so that growing line
941 ;; numbers can be inserted in front and searching can abort after half the
943 (eval-when-compile ;Don't keep it at runtime if not needed.
944 (defmacro compilation-assq (key alist)
947 (car (if (if (null ,key)
948 (if l2 (null (caar l2)))
949 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
952 (if l2 (eq ,key (caar l2))))
954 (setcdr l1 (cons (list ,key) l2)))))))
956 (defun compilation-auto-jump (buffer pos)
957 (with-current-buffer buffer
959 (let ((win (get-buffer-window buffer 0)))
960 (if win (set-window-point win pos)))
961 (if compilation-auto-jump-to-first-error
962 (compile-goto-error))))
964 ;; This function is the central driver, called when font-locking to gather
965 ;; all information needed to later jump to corresponding source code.
966 ;; Return a property list with all meta information on this error location.
968 (defun compilation-error-properties (file line end-line col end-col type fmt)
969 (unless (text-property-not-all (match-beginning 0) (point)
970 'compilation-message nil)
973 (setq file (if (functionp file) (funcall file)
974 (match-string-no-properties file))))
976 (unless (file-name-absolute-p file)
977 (let ((pos (compilation--previous-directory
978 (match-beginning 0))))
980 (or (get-text-property (1- pos) 'compilation-directory)
981 (get-text-property pos 'compilation-directory)))))))
982 (setq file (cons file (car dir)))))
983 ;; This message didn't mention one, get it from previous
985 ;; Find the previous message.
986 (previous-single-property-change (point) 'compilation-message)))
988 ;; Get the file structure that belongs to it.
990 (or (get-text-property (1- prev-pos) 'compilation-message)
991 (get-text-property prev-pos 'compilation-message)))
994 (compilation--loc->file-struct
995 (compilation--message->loc prev)))))
997 ;; Construct FILE . DIR from that.
999 (setq file (cons (caar prev-file-struct)
1000 (cadr (car prev-file-struct)))))))
1002 (setq file '("*unknown*")))))
1003 ;; All of these fields are optional, get them only if we have an index, and
1004 ;; it matched some part of the message.
1006 (setq line (match-string-no-properties line))
1007 (setq line (string-to-number line)))
1009 (setq end-line (match-string-no-properties end-line))
1010 (setq end-line (string-to-number end-line)))
1013 (setq col (funcall col))
1015 (setq col (match-string-no-properties col))
1016 (setq col (string-to-number col)))))
1017 (if (and end-col (functionp end-col))
1018 (setq end-col (funcall end-col))
1019 (if (and end-col (setq end-col (match-string-no-properties end-col)))
1020 (setq end-col (- (string-to-number end-col) -1))
1021 (if end-line (setq end-col -1))))
1022 (if (consp type) ; not a static type, check what it is.
1023 (setq type (or (and (car type) (match-end (car type)) 1)
1024 (and (cdr type) (match-end (cdr type)) 0)
1027 (when (and compilation-auto-jump-to-next
1028 (>= type compilation-skip-threshold))
1029 (kill-local-variable 'compilation-auto-jump-to-next)
1030 (run-with-timer 0 nil 'compilation-auto-jump
1031 (current-buffer) (match-beginning 0)))
1033 (compilation-internal-error-properties
1034 file line end-line col end-col type fmt)))
1036 (defun compilation-move-to-column (col screen)
1037 "Go to column COL on the current line.
1038 If SCREEN is non-nil, columns are screen columns, otherwise, they are
1040 (setq col (- col compilation-first-column))
1042 (move-to-column (max col 0))
1043 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
1045 (defun compilation-internal-error-properties (file line end-line col end-col type fmts)
1046 "Get the meta-info that will be added as text-properties.
1047 LINE, END-LINE, COL, END-COL are integers or nil.
1048 TYPE can be 0, 1, or 2, meaning error, warning, or just info.
1049 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil.
1050 FMTS is a list of format specs for transforming the file name.
1051 (See `compilation-error-regexp-alist'.)"
1052 (unless file (setq file '("*unknown*")))
1053 (let* ((file-struct (compilation-get-file-structure file fmts))
1054 ;; Get first already existing marker (if any has one, all have one).
1055 ;; Do this first, as the compilation-assq`s may create new nodes.
1056 (marker-line ; a line structure
1057 (cadr (compilation--file-struct->loc-tree file-struct)))
1059 (if marker-line (compilation--loc->marker (cadr marker-line))))
1060 (screen-columns compilation-error-screen-columns)
1061 end-marker loc end-loc)
1062 (if (not (and marker (marker-buffer marker)))
1063 (setq marker nil) ; no valid marker for this file
1064 (setq loc (or line 1)) ; normalize no linenumber to line 1
1065 (catch 'marker ; find nearest loc, at least one exists
1066 (dolist (x (cddr (compilation--file-struct->loc-tree
1067 file-struct))) ; Loop over remaining lines.
1068 (if (> (car x) loc) ; Still bigger.
1069 (setq marker-line x)
1070 (if (> (- (or (car marker-line) 1) loc)
1071 (- loc (car x))) ; Current line is nearer.
1072 (setq marker-line x))
1073 (throw 'marker t))))
1074 (setq marker (compilation--loc->marker (cadr marker-line))
1075 marker-line (or (car marker-line) 1))
1076 (with-current-buffer (marker-buffer marker)
1077 (let ((screen-columns
1078 ;; Obey the compilation-error-screen-columns of the target
1079 ;; buffer if its major mode set it buffer-locally.
1080 (if (local-variable-p 'compilation-error-screen-columns)
1081 compilation-error-screen-columns screen-columns)))
1085 (goto-char (marker-position marker))
1086 (when (or end-col end-line)
1087 (beginning-of-line (- (or end-line line) marker-line -1))
1088 (if (or (null end-col) (< end-col 0))
1090 (compilation-move-to-column end-col screen-columns))
1091 (setq end-marker (point-marker)))
1092 (beginning-of-line (if end-line
1093 (- line end-line -1)
1094 (- loc marker-line -1)))
1096 (compilation-move-to-column col screen-columns)
1097 (forward-to-indentation 0))
1098 (setq marker (point-marker)))))))
1100 (setq loc (compilation-assq line (compilation--file-struct->loc-tree
1105 end-col (compilation-assq
1106 end-line (compilation--file-struct->loc-tree
1108 (if end-col ; use same line element
1109 (compilation-assq end-col loc))))
1110 (setq loc (compilation-assq col loc))
1111 ;; If they are new, make the loc(s) reference the file they point to.
1112 ;; FIXME-omake: there's a problem with timestamps here: the markers
1113 ;; relative to which we computed the current `marker' have a timestamp
1114 ;; almost guaranteed to be different from compilation-buffer-modtime, so if
1115 ;; we use their timestamp, we'll never use `loc' since the timestamp won't
1116 ;; match compilation-buffer-modtime, and if we use
1117 ;; compilation-buffer-modtime then we have different timestamps for
1118 ;; locations that were computed together, which doesn't make sense either.
1119 ;; I think this points to a fundamental problem in our approach to the
1120 ;; "omake -P" problem. --Stef
1122 (setcdr loc (compilation--make-cdrloc line file-struct marker)))
1126 (compilation--make-cdrloc (or end-line line) file-struct
1129 ;; Must start with face
1130 `(font-lock-face ,compilation-message-face
1131 compilation-message ,(compilation--make-message loc type end-loc)
1133 "mouse-2: visit this file, line and column"
1135 "mouse-2: visit this file and line"
1136 "mouse-2: visit this file"))
1137 keymap compilation-button-map
1138 mouse-face highlight)))
1140 (defun compilation--put-prop (matchnum prop val)
1141 (when (and (integerp matchnum) (match-beginning matchnum))
1143 (match-beginning matchnum) (match-end matchnum)
1146 (defun compilation--remove-properties (&optional start end)
1147 (with-silent-modifications
1148 ;; When compile.el used font-lock directly, we could just remove all
1149 ;; our text-properties in one go, but now that we manually place
1150 ;; font-lock-face, we have to be careful to only remove the font-lock-face
1152 ;; (remove-list-of-text-properties
1153 ;; (or start (point-min)) (or end (point-max))
1154 ;; '(compilation-debug compilation-directory compilation-message
1155 ;; font-lock-face help-echo mouse-face))
1157 (unless start (setq start (point-min)))
1158 (unless end (setq end (point-max)))
1159 (compilation--flush-directory-cache start end)
1162 (setq next (or (next-single-property-change
1163 start 'compilation-message nil end)
1165 (when (get-text-property start 'compilation-message)
1166 (remove-list-of-text-properties
1168 '(compilation-debug compilation-directory compilation-message
1169 font-lock-face help-echo mouse-face)))
1171 (setq start next)))))
1173 (defun compilation--parse-region (start end)
1176 ;; We generally don't like to parse partial lines.
1178 (when (let ((proc (get-buffer-process (current-buffer))))
1179 (and proc (memq (process-status proc) '(run open))))
1180 (setq end (line-beginning-position))))
1181 (compilation--remove-properties start end)
1182 (if compilation-parse-errors-function
1183 ;; An old package! Try the compatibility code.
1186 (compilation--compat-parse-errors end))
1188 ;; compilation-directory-matcher is the only part that really needs to be
1189 ;; parsed sequentially. So we could split it out, handle directories
1190 ;; like syntax-propertize, and the rest as font-lock-keywords. But since
1191 ;; we want to have it work even when font-lock is off, we'd then need to
1192 ;; use our own compilation-parsed text-property to keep track of the parts
1193 ;; that have already been parsed.
1195 (while (re-search-forward (car compilation-directory-matcher)
1197 (compilation--flush-directory-cache (match-beginning 0) (match-end 0))
1198 (when compilation-debug
1199 (font-lock-append-text-property
1200 (match-beginning 0) (match-end 0)
1202 (vector 'directory compilation-directory-matcher)))
1203 (dolist (elt (cdr compilation-directory-matcher))
1204 (add-text-properties (match-beginning (car elt))
1205 (match-end (car elt))
1206 (compilation-directory-properties
1207 (car elt) (cdr elt)))))
1209 (compilation-parse-errors start end)))
1211 (defun compilation-parse-errors (start end &rest rules)
1212 "Parse errors between START and END.
1213 The errors recognized are the ones specified in RULES which default
1214 to `compilation-error-regexp-alist' if RULES is nil."
1215 (dolist (item (or rules compilation-error-regexp-alist))
1217 (setq item (cdr (assq item
1218 compilation-error-regexp-alist-alist))))
1219 (let ((file (nth 1 item))
1224 end-line end-col fmt
1227 ;; omake reports some error indented, so skip the indentation.
1228 ;; another solution is to modify (some?) regexps in
1229 ;; `compilation-error-regexp-alist'.
1230 ;; note that omake usage is not limited to ocaml and C (for stubs).
1231 ;; FIXME-omake: Doing it here seems wrong, at least it should depend on
1232 ;; whether or not omake's own error messages are recognized.
1234 ((not (memq 'omake compilation-error-regexp-alist)) nil)
1235 ((string-match "\\`\\([^^]\\|^\\( \\*\\|\\[\\)\\)" pat)
1236 nil) ;; Not anchored or anchored but already allows empty spaces.
1237 (t (setq pat (concat "^ *" (substring pat 1)))))
1239 (if (consp file) (setq fmt (cdr file) file (car file)))
1240 (if (consp line) (setq end-line (cdr line) line (car line)))
1241 (if (consp col) (setq end-col (cdr col) col (car col)))
1243 (if (functionp line)
1244 ;; The old compile.el had here an undocumented hook that
1245 ;; allowed `line' to be a function that computed the actual
1246 ;; error location. Let's do our best.
1249 (while (re-search-forward pat end t)
1251 (when compilation-debug
1252 (font-lock-append-text-property
1253 (match-beginning 0) (match-end 0)
1254 'compilation-debug (vector 'functionp item)))
1255 (add-text-properties
1256 (match-beginning 0) (match-end 0)
1257 (compilation--compat-error-properties
1258 (funcall line (cons (match-string file)
1259 (cons default-directory
1261 (if col (match-string col))))))
1262 (compilation--put-prop
1263 file 'font-lock-face compilation-error-face)))
1265 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
1266 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
1269 (while (re-search-forward pat end t)
1270 (when (setq props (compilation-error-properties
1271 file line end-line col end-col (or type 2) fmt))
1273 (when (integerp file)
1274 (compilation--put-prop
1275 file 'font-lock-face
1277 (compilation-face type)
1278 (symbol-value (aref [compilation-info-face
1279 compilation-warning-face
1280 compilation-error-face]
1283 (compilation--put-prop
1284 line 'font-lock-face compilation-line-face)
1285 (compilation--put-prop
1286 end-line 'font-lock-face compilation-line-face)
1288 (compilation--put-prop
1289 col 'font-lock-face compilation-column-face)
1290 (compilation--put-prop
1291 end-col 'font-lock-face compilation-column-face)
1293 (dolist (extra-item (nthcdr 6 item))
1294 (let ((mn (pop extra-item)))
1295 (when (match-beginning mn)
1296 (let ((face (eval (car extra-item))))
1301 (match-beginning mn) (match-end mn)
1302 'font-lock-face face))
1304 (error "Don't know how to handle face %S"
1306 (let ((mn (or (nth 5 item) 0)))
1307 (when compilation-debug
1308 (font-lock-append-text-property
1309 (match-beginning 0) (match-end 0)
1310 'compilation-debug (vector 'std item props)))
1311 (add-text-properties
1312 (match-beginning mn) (match-end mn)
1314 (font-lock-append-text-property
1315 (match-beginning mn) (match-end mn)
1316 'font-lock-face (cadr props)))))))))
1318 (defvar compilation--parsed -1)
1319 (make-variable-buffer-local 'compilation--parsed)
1321 (defun compilation--ensure-parse (limit)
1322 "Make sure the text has been parsed up to LIMIT."
1325 (setq limit (line-beginning-position 2))
1326 (unless (markerp compilation--parsed)
1327 ;; We use a marker for compilation--parsed so that users (such as
1328 ;; grep.el) don't need to flush-parse when they modify the buffer
1329 ;; in a way that impacts buffer positions but does not require
1331 (setq compilation--parsed (point-min-marker)))
1332 (when (< compilation--parsed limit)
1333 (let ((start (max compilation--parsed (point-min))))
1334 (move-marker compilation--parsed limit)
1336 (forward-line 0) ;Not line-beginning-position: ignore (comint) fields.
1337 (with-silent-modifications
1338 (compilation--parse-region (point) compilation--parsed)))))
1341 (defun compilation--flush-parse (start _end)
1342 "Mark the region between START and END for re-parsing."
1343 (if (markerp compilation--parsed)
1344 (move-marker compilation--parsed (min start compilation--parsed))))
1346 (defun compilation-mode-font-lock-keywords ()
1347 "Return expressions to highlight in Compilation mode."
1349 '((compilation--ensure-parse))
1350 compilation-mode-font-lock-keywords))
1352 (defun compilation-read-command (command)
1353 (read-shell-command "Compile command: " command
1354 (if (equal (car compile-history) command)
1355 '(compile-history . 1)
1360 (defun compile (command &optional comint)
1361 "Compile the program including the current buffer. Default: run `make'.
1362 Runs COMMAND, a shell command, in a separate process asynchronously
1363 with output going to the buffer `*compilation*'.
1365 You can then use the command \\[next-error] to find the next error message
1366 and move to the source code that caused it.
1368 If optional second arg COMINT is t the buffer will be in Comint mode with
1369 `compilation-shell-minor-mode'.
1371 Interactively, prompts for the command if `compilation-read-command' is
1372 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
1373 Additionally, with universal prefix arg, compilation buffer will be in
1374 comint mode, i.e. interactive.
1376 To run more than one compilation at once, start one then rename
1377 the \`*compilation*' buffer to some other name with
1378 \\[rename-buffer]. Then _switch buffers_ and start the new compilation.
1379 It will create a new \`*compilation*' buffer.
1381 On most systems, termination of the main compilation process
1382 kills its subprocesses.
1384 The name used for the buffer is actually whatever is returned by
1385 the function in `compilation-buffer-name-function', so you can set that
1386 to a function that generates a unique name."
1389 (let ((command (eval compile-command)))
1390 (if (or compilation-read-command current-prefix-arg)
1391 (compilation-read-command command)
1393 (consp current-prefix-arg)))
1394 (unless (equal command (eval compile-command))
1395 (setq compile-command command))
1396 (save-some-buffers (not compilation-ask-about-save)
1397 compilation-save-buffers-predicate)
1398 (setq-default compilation-directory default-directory)
1399 (compilation-start command comint))
1401 ;; run compile with the default command line
1402 (defun recompile (&optional edit-command)
1403 "Re-compile the program including the current buffer.
1404 If this is run in a Compilation mode buffer, re-use the arguments from the
1405 original use. Otherwise, recompile using `compile-command'.
1406 If the optional argument `edit-command' is non-nil, the command can be edited."
1408 (save-some-buffers (not compilation-ask-about-save)
1409 compilation-save-buffers-predicate)
1410 (let ((default-directory (or compilation-directory default-directory)))
1412 (setcar compilation-arguments
1413 (compilation-read-command (car compilation-arguments))))
1414 (apply 'compilation-start (or compilation-arguments
1415 `(,(eval compile-command))))))
1417 (defcustom compilation-scroll-output nil
1418 "Non-nil to scroll the *compilation* buffer window as output appears.
1420 Setting it causes the Compilation mode commands to put point at the
1421 end of their output window so that the end of the output is always
1422 visible rather than the beginning.
1424 The value `first-error' stops scrolling at the first error, and leaves
1425 point on its location in the *compilation* buffer."
1426 :type '(choice (const :tag "No scrolling" nil)
1427 (const :tag "Scroll compilation output" t)
1428 (const :tag "Stop scrolling at the first error" first-error))
1430 :group 'compilation)
1433 (defun compilation-buffer-name (name-of-mode mode-command name-function)
1434 "Return the name of a compilation buffer to use.
1435 If NAME-FUNCTION is non-nil, call it with one argument NAME-OF-MODE
1436 to determine the buffer name.
1437 Likewise if `compilation-buffer-name-function' is non-nil.
1438 If current buffer has the major mode MODE-COMMAND,
1439 return the name of the current buffer, so that it gets reused.
1440 Otherwise, construct a buffer name from NAME-OF-MODE."
1441 (cond (name-function
1442 (funcall name-function name-of-mode))
1443 (compilation-buffer-name-function
1444 (funcall compilation-buffer-name-function name-of-mode))
1445 ((eq mode-command major-mode)
1448 (concat "*" (downcase name-of-mode) "*"))))
1450 ;; This is a rough emulation of the old hack, until the transition to new
1451 ;; compile is complete.
1452 (defun compile-internal (command error-message
1453 &optional _name-of-mode parser
1454 error-regexp-alist name-function
1455 _enter-regexp-alist _leave-regexp-alist
1456 file-regexp-alist _nomessage-regexp-alist
1457 _no-async highlight-regexp _local-map)
1459 (error "Compile now works very differently, see `compilation-error-regexp-alist'"))
1460 (let ((compilation-error-regexp-alist
1461 (append file-regexp-alist (or error-regexp-alist
1462 compilation-error-regexp-alist)))
1463 (compilation-error (replace-regexp-in-string "^No more \\(.+\\)s\\.?"
1464 "\\1" error-message)))
1465 (compilation-start command nil name-function highlight-regexp)))
1466 (make-obsolete 'compile-internal 'compilation-start "22.1")
1469 (defun compilation-start (command &optional mode name-function highlight-regexp)
1470 "Run compilation command COMMAND (low level interface).
1471 If COMMAND starts with a cd command, that becomes the `default-directory'.
1472 The rest of the arguments are optional; for them, nil means use the default.
1474 MODE is the major mode to set in the compilation buffer. Mode
1475 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
1477 If NAME-FUNCTION is non-nil, call it with one argument (the mode name)
1478 to determine the buffer name. Otherwise, the default is to
1479 reuses the current buffer if it has the proper major mode,
1480 else use or create a buffer with name based on the major mode.
1482 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
1483 the matching section of the visited source line; the default is to use the
1484 global value of `compilation-highlight-regexp'.
1486 Returns the compilation buffer created."
1487 (or mode (setq mode 'compilation-mode))
1488 (let* ((name-of-mode
1491 (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1492 (thisdir default-directory)
1493 (thisenv compilation-environment)
1495 (with-current-buffer
1498 (compilation-buffer-name name-of-mode mode name-function)))
1499 (let ((comp-proc (get-buffer-process (current-buffer))))
1501 (if (or (not (eq (process-status comp-proc) 'run))
1503 (format "A %s process is running; kill it? "
1507 (interrupt-process comp-proc)
1509 (delete-process comp-proc))
1511 (error "Cannot have two processes in `%s' at once"
1513 ;; first transfer directory from where M-x compile was called
1514 (setq default-directory thisdir)
1515 ;; Make compilation buffer read-only. The filter can still write it.
1516 ;; Clear out the compilation buffer.
1517 (let ((inhibit-read-only t)
1518 (default-directory thisdir))
1519 ;; Then evaluate a cd command if any, but don't perform it yet, else
1520 ;; start-command would do it again through the shell: (cd "..") AND
1521 ;; sh -c "cd ..; make"
1522 (cd (if (string-match "\\`\\s *cd\\(?:\\s +\\(\\S +?\\)\\)?\\s *[;&\n]"
1525 (substitute-env-vars (match-string 1 command))
1529 ;; Select the desired mode.
1530 (if (not (eq mode t))
1532 (buffer-disable-undo)
1534 (setq buffer-read-only nil)
1535 (with-no-warnings (comint-mode))
1536 (compilation-shell-minor-mode))
1537 ;; Remember the original dir, so we can use it when we recompile.
1538 ;; default-directory' can't be used reliably for that because it may be
1539 ;; affected by the special handling of "cd ...;".
1540 ;; NB: must be done after (funcall mode) as that resets local variables
1541 (set (make-local-variable 'compilation-directory) thisdir)
1542 (set (make-local-variable 'compilation-environment) thisenv)
1543 (if highlight-regexp
1544 (set (make-local-variable 'compilation-highlight-regexp)
1546 (if (or compilation-auto-jump-to-first-error
1547 (eq compilation-scroll-output 'first-error))
1548 (set (make-local-variable 'compilation-auto-jump-to-next) t))
1549 ;; Output a mode setter, for saving and later reloading this buffer.
1550 (insert "-*- mode: " name-of-mode
1551 "; default-directory: "
1552 (prin1-to-string (abbreviate-file-name default-directory))
1554 (format "%s started at %s\n\n"
1556 (substring (current-time-string) 0 19))
1558 (setq thisdir default-directory))
1559 (set-buffer-modified-p nil))
1560 ;; Pop up the compilation buffer.
1561 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01638.html
1562 (setq outwin (display-buffer outbuf))
1563 (with-current-buffer outbuf
1564 (let ((process-environment
1566 compilation-environment
1567 (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning
1568 system-uses-terminfo)
1569 (list "TERM=dumb" "TERMCAP="
1570 (format "COLUMNS=%d" (window-width)))
1572 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1574 ;; Set the EMACS variable, but
1575 ;; don't override users' setting of $EMACS.
1576 (unless (getenv "EMACS")
1578 (list "INSIDE_EMACS=t")
1579 (copy-sequence process-environment))))
1580 (set (make-local-variable 'compilation-arguments)
1581 (list command mode name-function highlight-regexp))
1582 (set (make-local-variable 'revert-buffer-function)
1583 'compilation-revert-buffer)
1584 (set-window-start outwin (point-min))
1586 ;; Position point as the user will see it.
1587 (let ((desired-visible-point
1588 ;; Put it at the end if `compilation-scroll-output' is set.
1589 (if compilation-scroll-output
1591 ;; Normally put it at the top.
1593 (if (eq outwin (selected-window))
1594 (goto-char desired-visible-point)
1595 (set-window-point outwin desired-visible-point)))
1597 ;; The setup function is called before compilation-set-window-height
1598 ;; so it can set the compilation-window-height buffer locally.
1599 (if compilation-process-setup-function
1600 (funcall compilation-process-setup-function))
1601 (compilation-set-window-height outwin)
1602 ;; Start the compilation.
1603 (if (fboundp 'start-process)
1606 ;; comint uses `start-file-process'.
1610 outbuf (downcase mode-name)
1611 (if (file-remote-p default-directory)
1614 nil `("-c" ,command))))
1615 (start-file-process-shell-command (downcase mode-name)
1617 ;; Make the buffer's mode line show process state.
1618 (setq mode-line-process
1619 (list (propertize ":%s" 'face 'compilation-warning)))
1620 (set-process-sentinel proc 'compilation-sentinel)
1622 ;; Keep the comint filter, since it's needed for proper handling
1624 (set-process-filter proc 'compilation-filter))
1625 ;; Use (point-max) here so that output comes in
1626 ;; after the initial text,
1627 ;; regardless of where the user sees point.
1628 (set-marker (process-mark proc) (point-max) outbuf)
1629 (when compilation-disable-input
1631 (process-send-eof proc)
1632 ;; The process may have exited already.
1634 (run-hook-with-args 'compilation-start-hook proc)
1635 (setq compilation-in-progress
1636 (cons proc compilation-in-progress)))
1637 ;; No asynchronous processes available.
1638 (message "Executing `%s'..." command)
1639 ;; Fake modeline display as if `start-process' were run.
1640 (setq mode-line-process
1641 (list (propertize ":run" 'face 'compilation-warning)))
1642 (force-mode-line-update)
1643 (sit-for 0) ; Force redisplay
1645 ;; Insert the output at the end, after the initial text,
1646 ;; regardless of where the user sees point.
1647 (goto-char (point-max))
1648 (let* ((inhibit-read-only t) ; call-process needs to modify outbuf
1649 (compilation-filter-start (point))
1650 (status (call-process shell-file-name nil outbuf nil "-c"
1652 (run-hooks 'compilation-filter-hook)
1653 (cond ((numberp status)
1654 (compilation-handle-exit
1658 (format "exited abnormally with code %d\n" status))))
1660 (compilation-handle-exit 'signal status
1661 (concat status "\n")))
1663 (compilation-handle-exit 'bizarre status status)))))
1664 (set-buffer-modified-p nil)
1665 (message "Executing `%s'...done" command)))
1666 ;; Now finally cd to where the shell started make/grep/...
1667 (setq default-directory thisdir)
1668 ;; The following form selected outwin ever since revision 1.183,
1669 ;; so possibly messing up point in some other window (bug#1073).
1670 ;; Moved into the scope of with-current-buffer, though still with
1671 ;; complete disregard for the case when compilation-scroll-output
1672 ;; equals 'first-error (martin 2008-10-04).
1673 (when compilation-scroll-output
1674 (goto-char (point-max))))
1676 ;; Make it so the next C-x ` will use this buffer.
1677 (setq next-error-last-buffer outbuf)))
1679 (defun compilation-set-window-height (window)
1680 "Set the height of WINDOW according to `compilation-window-height'."
1681 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1683 (window-full-width-p window)
1684 ;; If window is alone in its frame, aside from a minibuffer,
1685 ;; don't change its height.
1686 (not (eq window (frame-root-window (window-frame window))))
1687 ;; Stef said that doing the saves in this order is safer:
1689 (save-selected-window
1690 (select-window window)
1691 (enlarge-window (- height (window-height))))))))
1693 (defvar compilation-menu-map
1694 (let ((map (make-sparse-keymap "Errors"))
1695 (opt-map (make-sparse-keymap "Skip")))
1696 (define-key map [stop-subjob]
1697 '(menu-item "Stop Compilation" kill-compilation
1698 :help "Kill the process made by the M-x compile or M-x grep commands"))
1699 (define-key map [compilation-mode-separator3]
1701 (define-key map [compilation-next-error-follow-minor-mode]
1703 "Auto Error Display" next-error-follow-minor-mode
1704 :help "Display the error under cursor when moving the cursor"
1705 :button (:toggle . next-error-follow-minor-mode)))
1706 (define-key map [compilation-skip]
1707 (cons "Skip Less Important Messages" opt-map))
1708 (define-key opt-map [compilation-skip-none]
1709 '(menu-item "Don't Skip Any Messages"
1712 (customize-set-variable 'compilation-skip-threshold 0))
1713 :help "Do not skip any type of messages"
1714 :button (:radio . (eq compilation-skip-threshold 0))))
1715 (define-key opt-map [compilation-skip-info]
1716 '(menu-item "Skip Info"
1719 (customize-set-variable 'compilation-skip-threshold 1))
1720 :help "Skip anything less than warning"
1721 :button (:radio . (eq compilation-skip-threshold 1))))
1722 (define-key opt-map [compilation-skip-warning-and-info]
1723 '(menu-item "Skip Warnings and Info"
1726 (customize-set-variable 'compilation-skip-threshold 2))
1727 :help "Skip over Warnings and Info, stop for errors"
1728 :button (:radio . (eq compilation-skip-threshold 2))))
1729 (define-key map [compilation-mode-separator2]
1731 (define-key map [compilation-first-error]
1732 '(menu-item "First Error" first-error
1733 :help "Restart at the first error, visit corresponding source code"))
1734 (define-key map [compilation-previous-error]
1735 '(menu-item "Previous Error" previous-error
1736 :help "Visit previous `next-error' message and corresponding source code"))
1737 (define-key map [compilation-next-error]
1738 '(menu-item "Next Error" next-error
1739 :help "Visit next `next-error' message and corresponding source code"))
1742 (defvar compilation-minor-mode-map
1743 (let ((map (make-sparse-keymap)))
1744 (set-keymap-parent map special-mode-map)
1745 (define-key map [mouse-2] 'compile-goto-error)
1746 (define-key map [follow-link] 'mouse-face)
1747 (define-key map "\C-c\C-c" 'compile-goto-error)
1748 (define-key map "\C-m" 'compile-goto-error)
1749 (define-key map "\C-c\C-k" 'kill-compilation)
1750 (define-key map "\M-n" 'compilation-next-error)
1751 (define-key map "\M-p" 'compilation-previous-error)
1752 (define-key map "\M-{" 'compilation-previous-file)
1753 (define-key map "\M-}" 'compilation-next-file)
1754 (define-key map "g" 'recompile) ; revert
1755 ;; Set up the menu-bar
1756 (define-key map [menu-bar compilation]
1757 (cons "Errors" compilation-menu-map))
1759 "Keymap for `compilation-minor-mode'.")
1761 (defvar compilation-shell-minor-mode-map
1762 (let ((map (make-sparse-keymap)))
1763 (define-key map "\M-\C-m" 'compile-goto-error)
1764 (define-key map "\M-\C-n" 'compilation-next-error)
1765 (define-key map "\M-\C-p" 'compilation-previous-error)
1766 (define-key map "\M-{" 'compilation-previous-file)
1767 (define-key map "\M-}" 'compilation-next-file)
1768 ;; Set up the menu-bar
1769 (define-key map [menu-bar compilation]
1770 (cons "Errors" compilation-menu-map))
1772 "Keymap for `compilation-shell-minor-mode'.")
1774 (defvar compilation-button-map
1775 (let ((map (make-sparse-keymap)))
1776 (define-key map [mouse-2] 'compile-goto-error)
1777 (define-key map [follow-link] 'mouse-face)
1778 (define-key map "\C-m" 'compile-goto-error)
1780 "Keymap for compilation-message buttons.")
1781 (fset 'compilation-button-map compilation-button-map)
1783 (defvar compilation-mode-map
1784 (let ((map (make-sparse-keymap)))
1785 ;; Don't inherit from compilation-minor-mode-map,
1786 ;; because that introduces a menu bar item we don't want.
1787 ;; That confuses C-down-mouse-3.
1788 (set-keymap-parent map special-mode-map)
1789 (define-key map [mouse-2] 'compile-goto-error)
1790 (define-key map [follow-link] 'mouse-face)
1791 (define-key map "\C-c\C-c" 'compile-goto-error)
1792 (define-key map "\C-m" 'compile-goto-error)
1793 (define-key map "\C-c\C-k" 'kill-compilation)
1794 (define-key map "\M-n" 'compilation-next-error)
1795 (define-key map "\M-p" 'compilation-previous-error)
1796 (define-key map "\M-{" 'compilation-previous-file)
1797 (define-key map "\M-}" 'compilation-next-file)
1798 (define-key map "\t" 'compilation-next-error)
1799 (define-key map [backtab] 'compilation-previous-error)
1800 (define-key map "g" 'recompile) ; revert
1802 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1804 ;; Set up the menu-bar
1805 (let ((submap (make-sparse-keymap "Compile")))
1806 (define-key map [menu-bar compilation]
1807 (cons "Compile" submap))
1808 (set-keymap-parent submap compilation-menu-map))
1809 (define-key map [menu-bar compilation compilation-separator2]
1811 (define-key map [menu-bar compilation compilation-grep]
1812 '(menu-item "Search Files (grep)..." grep
1813 :help "Run grep, with user-specified args, and collect output in a buffer"))
1814 (define-key map [menu-bar compilation compilation-recompile]
1815 '(menu-item "Recompile" recompile
1816 :help "Re-compile the program including the current buffer"))
1817 (define-key map [menu-bar compilation compilation-compile]
1818 '(menu-item "Compile..." compile
1819 :help "Compile the program including the current buffer. Default: run `make'"))
1821 "Keymap for compilation log buffers.
1822 `compilation-minor-mode-map' is a parent of this.")
1824 (defvar compilation-mode-tool-bar-map
1825 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
1826 ;; so don't do anything.
1827 (when (keymapp tool-bar-map)
1828 (let ((map (copy-keymap tool-bar-map)))
1829 (define-key map [undo] nil)
1830 (define-key map [separator-2] nil)
1831 (define-key-after map [separator-compile] menu-bar-separator)
1832 (tool-bar-local-item
1833 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
1835 :help "Goto previous error")
1836 (tool-bar-local-item
1837 "right-arrow" 'next-error-no-select 'next-error-no-select map
1839 :help "Goto next error")
1840 (tool-bar-local-item
1841 "cancel" 'kill-compilation 'kill-compilation map
1842 :enable '(let ((buffer (compilation-find-buffer)))
1843 (get-buffer-process buffer))
1844 :help "Stop compilation")
1845 (tool-bar-local-item
1846 "refresh" 'recompile 'recompile map
1847 :help "Restart compilation")
1850 (put 'compilation-mode 'mode-class 'special)
1853 (defun compilation-mode (&optional name-of-mode)
1854 "Major mode for compilation log buffers.
1855 \\<compilation-mode-map>To visit the source for a line-numbered error,
1856 move point to the error message line and type \\[compile-goto-error].
1857 To kill the compilation, type \\[kill-compilation].
1859 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
1861 \\{compilation-mode-map}"
1863 (kill-all-local-variables)
1864 (use-local-map compilation-mode-map)
1865 ;; Let windows scroll along with the output.
1866 (set (make-local-variable 'window-point-insertion-type) t)
1867 (set (make-local-variable 'tool-bar-map) compilation-mode-tool-bar-map)
1868 (setq major-mode 'compilation-mode ; FIXME: Use define-derived-mode.
1869 mode-name (or name-of-mode "Compilation"))
1870 (set (make-local-variable 'page-delimiter)
1871 compilation-page-delimiter)
1872 ;; (set (make-local-variable 'compilation-buffer-modtime) nil)
1874 (setq buffer-read-only t)
1875 (run-mode-hooks 'compilation-mode-hook))
1877 (defmacro define-compilation-mode (mode name doc &rest body)
1878 "This is like `define-derived-mode' without the PARENT argument.
1879 The parent is always `compilation-mode' and the customizable `compilation-...'
1880 variables are also set from the name of the mode you have chosen,
1881 by replacing the first word, e.g `compilation-scroll-output' from
1882 `grep-scroll-output' if that variable exists."
1883 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1884 `(define-derived-mode ,mode compilation-mode ,name
1886 ,@(mapcar (lambda (v)
1888 (intern-soft (replace-regexp-in-string
1889 "^compilation" mode-name
1892 (or (boundp (cdr v))
1893 ;; FIXME: This is hackish, using undocumented info.
1894 (if (boundp 'byte-compile-bound-variables)
1895 (memq (cdr v) byte-compile-bound-variables)))
1896 `(set (make-local-variable ',(car v)) ,(cdr v))))
1897 '(compilation-buffer-name-function
1898 compilation-directory-matcher
1900 compilation-error-regexp-alist
1901 compilation-error-regexp-alist-alist
1902 compilation-error-screen-columns
1903 compilation-finish-function
1904 compilation-finish-functions
1905 compilation-first-column
1906 compilation-mode-font-lock-keywords
1907 compilation-page-delimiter
1908 compilation-parse-errors-filename-function
1909 compilation-process-setup-function
1910 compilation-scroll-output
1911 compilation-search-path
1912 compilation-skip-threshold
1913 compilation-window-height))
1916 (defun compilation-revert-buffer (ignore-auto noconfirm)
1917 (if buffer-file-name
1918 (let (revert-buffer-function)
1919 (revert-buffer ignore-auto noconfirm))
1920 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1921 (apply 'compilation-start compilation-arguments))))
1923 (defvar compilation-current-error nil
1924 "Marker to the location from where the next error will be found.
1925 The global commands next/previous/first-error/goto-error use this.")
1927 (defvar compilation-messages-start nil
1928 "Buffer position of the beginning of the compilation messages.
1929 If nil, use the beginning of buffer.")
1931 (defun compilation-setup (&optional minor)
1932 "Prepare the buffer for the compilation parsing commands to work.
1933 Optional argument MINOR indicates this is called from
1934 `compilation-minor-mode'."
1935 (make-local-variable 'compilation-current-error)
1936 (make-local-variable 'compilation-messages-start)
1937 (make-local-variable 'compilation-error-screen-columns)
1938 (make-local-variable 'overlay-arrow-position)
1939 (set (make-local-variable 'overlay-arrow-string) "")
1940 (setq next-error-overlay-arrow-position nil)
1941 (add-hook 'kill-buffer-hook
1942 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
1943 ;; Note that compilation-next-error-function is for interfacing
1944 ;; with the next-error function in simple.el, and it's only
1945 ;; coincidentally named similarly to compilation-next-error.
1946 (setq next-error-function 'compilation-next-error-function)
1947 (set (make-local-variable 'comint-file-name-prefix)
1948 (or (file-remote-p default-directory) ""))
1949 (set (make-local-variable 'compilation-locs)
1950 (make-hash-table :test 'equal :weakness 'value))
1951 ;; It's generally preferable to use after-change-functions since they
1952 ;; can be subject to combine-after-change-calls, but if we do that, we risk
1953 ;; running our hook after font-lock, resulting in incorrect refontification.
1954 (add-hook 'before-change-functions 'compilation--flush-parse nil t)
1955 ;; Also for minor mode, since it's not permanent-local.
1956 (add-hook 'change-major-mode-hook #'compilation--remove-properties nil t)
1959 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1961 (font-lock-fontify-buffer)))
1962 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))))
1964 (defun compilation--unsetup ()
1965 ;; Only for minor mode.
1966 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1967 (remove-hook 'before-change-functions 'compilation--flush-parse t)
1968 (kill-local-variable 'compilation--parsed)
1969 (compilation--remove-properties)
1971 (font-lock-fontify-buffer)))
1974 (define-minor-mode compilation-shell-minor-mode
1975 "Toggle Compilation Shell minor mode.
1976 With a prefix argument ARG, enable Compilation Shell minor mode
1977 if ARG is positive, and disable it otherwise. If called from
1978 Lisp, enable the mode if ARG is omitted or nil.
1980 When Compilation Shell minor mode is enabled, all the
1981 error-parsing commands of the Compilation major mode are
1982 available but bound to keys that don't collide with Shell mode.
1983 See `compilation-mode'."
1984 nil " Shell-Compile"
1986 (if compilation-shell-minor-mode
1987 (compilation-setup t)
1988 (compilation--unsetup)))
1991 (define-minor-mode compilation-minor-mode
1992 "Toggle Compilation minor mode.
1993 With a prefix argument ARG, enable Compilation minor mode if ARG
1994 is positive, and disable it otherwise. If called from Lisp,
1995 enable the mode if ARG is omitted or nil.
1997 When Compilation minor mode is enabled, all the error-parsing
1998 commands of Compilation major mode are available. See
1999 `compilation-mode'."
2002 (if compilation-minor-mode
2003 (compilation-setup t)
2004 (compilation--unsetup)))
2006 (defun compilation-handle-exit (process-status exit-status msg)
2007 "Write MSG in the current buffer and hack its `mode-line-process'."
2008 (let ((inhibit-read-only t)
2009 (status (if compilation-exit-message-function
2010 (funcall compilation-exit-message-function
2011 process-status exit-status msg)
2012 (cons msg exit-status)))
2015 (cur-buffer (current-buffer)))
2016 ;; Record where we put the message, so we can ignore it later on.
2018 (insert ?\n mode-name " " (car status))
2019 (if (and (numberp compilation-window-height)
2020 (zerop compilation-window-height))
2021 (message "%s" (cdr status)))
2024 (insert " at " (substring (current-time-string) 0 19))
2025 (goto-char (point-max))
2026 ;; Prevent that message from being recognized as a compilation error.
2027 (add-text-properties omax (point)
2028 (append '(compilation-handle-exit t) nil))
2029 (setq mode-line-process
2030 (let ((out-string (format ":%s [%s]" process-status (cdr status)))
2031 (msg (format "%s %s" mode-name
2032 (replace-regexp-in-string "\n?$" ""
2035 (propertize out-string
2036 'help-echo msg 'face (if (> exit-status 0)
2038 'compilation-info))))
2039 ;; Force mode line redisplay soon.
2040 (force-mode-line-update)
2041 (if (and opoint (< opoint omax))
2044 (if compilation-finish-function
2045 (funcall compilation-finish-function cur-buffer msg)))
2046 (run-hook-with-args 'compilation-finish-functions cur-buffer msg)))
2048 ;; Called when compilation process changes state.
2049 (defun compilation-sentinel (proc msg)
2050 "Sentinel for compilation buffers."
2051 (if (memq (process-status proc) '(exit signal))
2052 (let ((buffer (process-buffer proc)))
2053 (if (null (buffer-name buffer))
2055 (set-process-buffer proc nil)
2056 (with-current-buffer buffer
2057 ;; Write something in the compilation buffer
2058 ;; and hack its mode line.
2059 (compilation-handle-exit (process-status proc)
2060 (process-exit-status proc)
2062 ;; Since the buffer and mode line will show that the
2063 ;; process is dead, we can delete it now. Otherwise it
2064 ;; will stay around until M-x list-processes.
2065 (delete-process proc)))
2066 (setq compilation-in-progress (delq proc compilation-in-progress)))))
2068 (defun compilation-filter (proc string)
2069 "Process filter for compilation buffers.
2070 Just inserts the text,
2071 handles carriage motion (see `comint-inhibit-carriage-motion'),
2072 and runs `compilation-filter-hook'."
2073 (when (buffer-live-p (process-buffer proc))
2074 (with-current-buffer (process-buffer proc)
2075 (let ((inhibit-read-only t)
2076 ;; `save-excursion' doesn't use the right insertion-type for us.
2077 (pos (copy-marker (point) t))
2078 ;; `save-restriction' doesn't use the right insertion type either:
2079 ;; If we are inserting at the end of the accessible part of the
2080 ;; buffer, keep the inserted text visible.
2081 (min (point-min-marker))
2082 (max (copy-marker (point-max) t))
2083 (compilation-filter-start (marker-position (process-mark proc))))
2087 (goto-char compilation-filter-start)
2088 ;; We used to use `insert-before-markers', so that windows with
2089 ;; point at `process-mark' scroll along with the output, but we
2090 ;; now use window-point-insertion-type instead.
2092 (unless comint-inhibit-carriage-motion
2093 (comint-carriage-motion (process-mark proc) (point)))
2094 (set-marker (process-mark proc) (point))
2095 ;; (set (make-local-variable 'compilation-buffer-modtime)
2097 (run-hooks 'compilation-filter-hook))
2099 (narrow-to-region min max)
2100 (set-marker pos nil)
2101 (set-marker min nil)
2102 (set-marker max nil))))))
2104 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
2105 (defsubst compilation-buffer-internal-p ()
2106 "Test if inside a compilation buffer."
2107 (local-variable-p 'compilation-locs))
2109 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
2110 (defsubst compilation-buffer-p (buffer)
2111 "Test if BUFFER is a compilation buffer."
2112 (with-current-buffer buffer
2113 (compilation-buffer-internal-p)))
2115 (defmacro compilation-loop (< property-change 1+ error limit)
2119 (or (setq pt (,property-change pt 'compilation-message))
2120 ;; Handle the case where where the first error message is
2121 ;; at the start of the buffer, and n < 0.
2122 (if (or (eq (get-text-property ,limit 'compilation-message)
2123 (get-text-property opt 'compilation-message))
2125 (error ,error compilation-error)
2127 ;; prop 'compilation-message usually has 2 changes, on and off, so
2129 (or (setq msg (get-text-property pt 'compilation-message))
2130 (if (setq pt (,property-change pt 'compilation-message nil ,limit))
2131 (setq msg (get-text-property pt 'compilation-message)))
2132 (error ,error compilation-error))
2133 (or (< (compilation--message->type msg) compilation-skip-threshold)
2136 (setq last (compilation--loc->file-struct
2137 (compilation--message->loc msg))))
2139 (if compilation-skip-visited
2140 (compilation--loc->visited (compilation--message->loc msg)))
2141 (if compilation-skip-to-next-location
2142 (eq (compilation--message->loc msg) loc))
2143 ;; count this message only if none of the above are true
2144 (setq n (,1+ n))))))
2146 (defun compilation-next-single-property-change (position prop
2147 &optional object limit)
2150 ;; We parse the buffer here "on-demand" by chunks of 500 chars.
2151 ;; But we could also just parse the whole buffer.
2152 (compilation--ensure-parse
2153 (setq parsed (max compilation--parsed
2154 (min (+ position 500)
2155 (or limit (point-max))))))
2156 (and (or (not (setq res (next-single-property-change
2157 position prop object limit)))
2159 (< position (or limit (point-max)))))
2160 (setq position parsed))
2163 (defun compilation-next-error (n &optional different-file pt)
2164 "Move point to the next error in the compilation buffer.
2165 This function does NOT find the source line like \\[next-error].
2166 Prefix arg N says how many error messages to move forwards (or
2167 backwards, if negative).
2168 Optional arg DIFFERENT-FILE, if non-nil, means find next error for a
2169 file that is different from the current one.
2170 Optional arg PT, if non-nil, specifies the value of point to start
2171 looking for the next message."
2173 (or (compilation-buffer-p (current-buffer))
2174 (error "Not in a compilation buffer"))
2175 (or pt (setq pt (point)))
2176 (let* ((msg (get-text-property pt 'compilation-message))
2177 ;; `loc', `msg', and `last' are used by the compilation-loop macro.
2178 (loc (and msg (compilation--message->loc msg)))
2181 (unless (or msg ; find message near here
2182 (setq msg (get-text-property (max (1- pt) (point-min))
2183 'compilation-message)))
2184 (setq pt (previous-single-property-change pt 'compilation-message nil
2185 (line-beginning-position)))
2186 (unless (setq msg (get-text-property (max (1- pt) (point-min))
2187 'compilation-message))
2188 (setq pt (next-single-property-change pt 'compilation-message nil
2189 (line-end-position)))
2190 (or (setq msg (get-text-property pt 'compilation-message))
2191 (setq pt (point)))))
2192 (setq last (compilation--loc->file-struct loc))
2194 (compilation-loop > compilation-next-single-property-change 1-
2195 (if (get-buffer-process (current-buffer))
2197 "Moved past last %s")
2199 (compilation--ensure-parse pt)
2200 ;; Don't move "back" to message at or before point.
2201 ;; Pass an explicit (point-min) to make sure pt is non-nil.
2202 (setq pt (previous-single-property-change
2203 pt 'compilation-message nil (point-min)))
2204 (compilation-loop < previous-single-property-change 1+
2205 "Moved back before first %s" (point-min))))
2208 (error "No %s here" compilation-error))))
2210 (defun compilation-previous-error (n)
2211 "Move point to the previous error in the compilation buffer.
2212 Prefix arg N says how many error messages to move backwards (or
2213 forwards, if negative).
2214 Does NOT find the source line like \\[previous-error]."
2216 (compilation-next-error (- n)))
2218 (defun compilation-next-file (n)
2219 "Move point to the next error for a different file than the current one.
2220 Prefix arg N says how many files to move forwards (or backwards, if negative)."
2222 (compilation-next-error n t))
2224 (defun compilation-previous-file (n)
2225 "Move point to the previous error for a different file than the current one.
2226 Prefix arg N says how many files to move backwards (or forwards, if negative)."
2228 (compilation-next-file (- n)))
2230 (defun kill-compilation ()
2231 "Kill the process made by the \\[compile] or \\[grep] commands."
2233 (let ((buffer (compilation-find-buffer)))
2234 (if (get-buffer-process buffer)
2235 (interrupt-process (get-buffer-process buffer))
2236 (error "The %s process is not running" (downcase mode-name)))))
2238 (defalias 'compile-mouse-goto-error 'compile-goto-error)
2240 (defun compile-goto-error (&optional event)
2241 "Visit the source for the error message at point.
2242 Use this command in a compilation log buffer. Sets the mark at point there."
2243 (interactive (list last-input-event))
2244 (if event (posn-set-point (event-end event)))
2245 (or (compilation-buffer-p (current-buffer))
2246 (error "Not in a compilation buffer"))
2247 (compilation--ensure-parse (point))
2248 (if (get-text-property (point) 'compilation-directory)
2250 (car (get-text-property (point) 'compilation-directory)))
2252 (setq compilation-current-error (point))
2253 (next-error-internal)))
2255 ;; This is mostly unused, but we keep it for the sake of some external
2256 ;; packages which seem to make use of it.
2257 (defun compilation-find-buffer (&optional avoid-current)
2258 "Return a compilation buffer.
2259 If AVOID-CURRENT is nil, and the current buffer is a compilation buffer,
2260 return it. If AVOID-CURRENT is non-nil, return the current buffer only
2262 (if (and (compilation-buffer-internal-p) (not avoid-current))
2264 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)))
2267 (defun compilation-next-error-function (n &optional reset)
2268 "Advance to the next error message and visit the file where the error was.
2269 This is the value of `next-error-function' in Compilation buffers."
2272 (setq compilation-current-error nil))
2273 (let* ((screen-columns compilation-error-screen-columns)
2275 (msg (compilation-next-error (or n 1) nil
2276 (or compilation-current-error
2277 compilation-messages-start
2279 (loc (compilation--message->loc msg))
2280 (end-loc (compilation--message->end-loc msg))
2281 (marker (point-marker)))
2282 (setq compilation-current-error (point-marker)
2283 overlay-arrow-position
2285 compilation-current-error
2286 (copy-marker (line-beginning-position))))
2287 ;; If loc contains no marker, no error in that file has been visited.
2288 ;; If the marker is invalid the buffer has been killed.
2289 ;; So, recalculate all markers for that file.
2290 (unless (and (compilation--loc->marker loc)
2291 (marker-buffer (compilation--loc->marker loc))
2292 ;; FIXME-omake: For "omake -P", which automatically recompiles
2293 ;; when the file is modified, the line numbers of new output
2294 ;; may not be related to line numbers from earlier output
2295 ;; (earlier markers), so we used to try to detect it here and
2296 ;; force a reparse. But that caused more problems elsewhere,
2297 ;; so instead we now flush the file-structure when we see
2298 ;; omake's message telling it's about to recompile a file.
2299 ;; (or (null (compilation--loc->timestamp loc)) ;A fake-loc
2300 ;; (equal (compilation--loc->timestamp loc)
2301 ;; (setq timestamp compilation-buffer-modtime)))
2303 (with-current-buffer
2304 (compilation-find-file
2306 (caar (compilation--loc->file-struct loc))
2307 (cadr (car (compilation--loc->file-struct loc))))
2308 (let ((screen-columns
2309 ;; Obey the compilation-error-screen-columns of the target
2310 ;; buffer if its major mode set it buffer-locally.
2311 (if (local-variable-p 'compilation-error-screen-columns)
2312 compilation-error-screen-columns screen-columns)))
2315 (goto-char (point-min))
2316 ;; Treat file's found lines in forward order, 1 by 1.
2317 (dolist (line (reverse (cddr (compilation--loc->file-struct loc))))
2318 (when (car line) ; else this is a filename w/o a line#
2319 (beginning-of-line (- (car line) last -1))
2320 (setq last (car line)))
2321 ;; Treat line's found columns and store/update a marker for each.
2322 (dolist (col (cdr line))
2323 (if (compilation--loc->col col)
2324 (if (eq (compilation--loc->col col) -1)
2325 ;; Special case for range end.
2327 (compilation-move-to-column (compilation--loc->col col)
2330 (skip-chars-forward " \t"))
2331 (if (compilation--loc->marker col)
2332 (set-marker (compilation--loc->marker col) (point))
2333 (setf (compilation--loc->marker col) (point-marker)))
2334 ;; (setf (compilation--loc->timestamp col) timestamp)
2336 (compilation-goto-locus marker (compilation--loc->marker loc)
2337 (compilation--loc->marker end-loc))
2338 (setf (compilation--loc->visited loc) t)))
2340 (defvar compilation-gcpro nil
2341 "Internal variable used to keep some values from being GC'd.")
2342 (make-variable-buffer-local 'compilation-gcpro)
2344 (defun compilation-fake-loc (marker file &optional line col)
2345 "Preassociate MARKER with FILE.
2346 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
2347 This is useful when you compile temporary files, but want
2348 automatic translation of the messages to the real buffer from
2349 which the temporary file came. This may also affect previous messages
2352 Optional args LINE and COL default to 1 and beginning of
2353 indentation respectively. The marker is expected to reflect
2354 this. In the simplest case the marker points to the first line
2355 of the region that was saved to the temp file.
2357 If you concatenate several regions into the temp file (e.g. a
2358 header with variable assignments and a code region), you must
2359 call this several times, once each for the last line of one
2360 region and the first line of the next region."
2361 (or (consp file) (setq file (list file)))
2362 (compilation--flush-file-structure file)
2363 (let ((fs (compilation-get-file-structure file)))
2364 ;; Between the current call to compilation-fake-loc and the first
2365 ;; occurrence of an error message referring to `file', the data is
2366 ;; only kept in the weak hash-table compilation-locs, so we need
2367 ;; to prevent this entry in compilation-locs from being GC'd
2369 (push fs compilation-gcpro)
2370 (let ((loc (compilation-assq (or line 1) (cdr fs))))
2371 (setq loc (compilation-assq col loc))
2372 (assert (null (cdr loc)))
2373 (setcdr loc (compilation--make-cdrloc line fs marker))
2376 (defcustom compilation-context-lines nil
2377 "Display this many lines of leading context before the current message.
2378 If nil and the left fringe is displayed, don't scroll the
2379 compilation output window; an arrow in the left fringe points to
2380 the current message. If nil and there is no left fringe, the message
2381 displays at the top of the window; there is no arrow."
2382 :type '(choice integer (const :tag "No window scrolling" nil))
2386 (defsubst compilation-set-window (w mk)
2387 "Align the compilation output window W with marker MK near top."
2388 (if (integerp compilation-context-lines)
2389 (set-window-start w (save-excursion
2392 (- 1 compilation-context-lines))
2394 ;; If there is no left fringe.
2395 (if (equal (car (window-fringes)) 0)
2396 (set-window-start w (save-excursion
2398 (beginning-of-line 1)
2400 (set-window-point w mk))
2402 (defvar next-error-highlight-timer)
2404 (defun compilation-goto-locus (msg mk end-mk)
2405 "Jump to an error corresponding to MSG at MK.
2406 All arguments are markers. If END-MK is non-nil, mark is set there
2407 and overlay is highlighted between MK and END-MK."
2408 ;; Show compilation buffer in other window, scrolled to this error.
2409 (let* ((from-compilation-buffer (eq (window-buffer (selected-window))
2410 (marker-buffer msg)))
2411 ;; Use an existing window if it is in a visible frame.
2412 (pre-existing (get-buffer-window (marker-buffer msg) 0))
2413 (w (if (and from-compilation-buffer pre-existing)
2414 ;; Calling display-buffer here may end up (partly) hiding
2415 ;; the error location if the two buffers are in two
2416 ;; different frames. So don't do it if it's not necessary.
2418 (let ((display-buffer-reuse-frames t)
2421 (display-buffer (marker-buffer msg)))))
2422 (highlight-regexp (with-current-buffer (marker-buffer msg)
2423 ;; also do this while we change buffer
2424 (compilation-set-window w msg)
2425 compilation-highlight-regexp)))
2426 ;; Ideally, the window-size should be passed to `display-buffer'
2427 ;; so it's only used when creating a new window.
2428 (unless pre-existing (compilation-set-window-height w))
2430 (if from-compilation-buffer
2431 ;; If the compilation buffer window was selected,
2432 ;; keep the compilation buffer in this window;
2433 ;; display the source in another window.
2434 (let ((pop-up-windows t))
2435 (pop-to-buffer (marker-buffer mk) 'other-window))
2436 (switch-to-buffer (marker-buffer mk)))
2437 (unless (eq (goto-char mk) (point))
2438 ;; If narrowing gets in the way of going to the right place, widen.
2440 (if next-error-move-function
2441 (funcall next-error-move-function msg mk)
2444 (push-mark end-mk t)
2445 (if mark-active (setq mark-active)))
2446 ;; If hideshow got in the way of
2447 ;; seeing the right place, open permanently.
2448 (dolist (ov (overlays-at (point)))
2449 (when (eq 'hs (overlay-get ov 'invisible))
2453 (when highlight-regexp
2454 (if (timerp next-error-highlight-timer)
2455 (cancel-timer next-error-highlight-timer))
2456 (unless compilation-highlight-overlay
2457 (setq compilation-highlight-overlay
2458 (make-overlay (point-min) (point-min)))
2459 (overlay-put compilation-highlight-overlay 'face 'next-error))
2460 (with-current-buffer (marker-buffer mk)
2462 (if end-mk (goto-char end-mk) (end-of-line))
2463 (let ((end (point)))
2464 (if mk (goto-char mk) (beginning-of-line))
2465 (if (and (stringp highlight-regexp)
2466 (re-search-forward highlight-regexp end t))
2468 (goto-char (match-beginning 0))
2469 (move-overlay compilation-highlight-overlay
2470 (match-beginning 0) (match-end 0)
2472 (move-overlay compilation-highlight-overlay
2473 (point) end (current-buffer)))
2474 (if (or (eq next-error-highlight t)
2475 (numberp next-error-highlight))
2476 ;; We want highlighting: delete overlay on next input.
2477 (add-hook 'pre-command-hook
2478 'compilation-goto-locus-delete-o)
2479 ;; We don't want highlighting: delete overlay now.
2480 (delete-overlay compilation-highlight-overlay))
2481 ;; We want highlighting for a limited time:
2482 ;; set up a timer to delete it.
2483 (when (numberp next-error-highlight)
2484 (setq next-error-highlight-timer
2485 (run-at-time next-error-highlight nil
2486 'compilation-goto-locus-delete-o)))))))
2487 (when (and (eq next-error-highlight 'fringe-arrow))
2488 ;; We want a fringe arrow (instead of highlighting).
2489 (setq next-error-overlay-arrow-position
2490 (copy-marker (line-beginning-position))))))
2492 (defun compilation-goto-locus-delete-o ()
2493 (delete-overlay compilation-highlight-overlay)
2494 ;; Get rid of timer and hook that would try to do this again.
2495 (if (timerp next-error-highlight-timer)
2496 (cancel-timer next-error-highlight-timer))
2497 (remove-hook 'pre-command-hook
2498 'compilation-goto-locus-delete-o))
2500 (defun compilation-find-file (marker filename directory &rest formats)
2501 "Find a buffer for file FILENAME.
2502 If FILENAME is not found at all, ask the user where to find it.
2503 Pop up the buffer containing MARKER and scroll to MARKER if we ask
2504 the user where to find the file.
2505 Search the directories in `compilation-search-path'.
2506 A nil in `compilation-search-path' means to try the
2507 \"current\" directory, which is passed in DIRECTORY.
2508 If DIRECTORY is relative, it is combined with `default-directory'.
2509 If DIRECTORY is nil, that means use `default-directory'.
2510 FORMATS, if given, is a list of formats to reformat FILENAME when
2511 looking for it: for each element FMT in FORMATS, this function
2512 attempts to find a file whose name is produced by (format FMT FILENAME)."
2513 (or formats (setq formats '("%s")))
2514 (let ((dirs compilation-search-path)
2515 (spec-dir (if directory
2516 (expand-file-name directory)
2518 buffer thisdir fmts name)
2519 (if (file-name-absolute-p filename)
2520 ;; The file name is absolute. Use its explicit directory as
2521 ;; the first in the search path, and strip it from FILENAME.
2522 (setq filename (abbreviate-file-name (expand-file-name filename))
2523 dirs (cons (file-name-directory filename) dirs)
2524 filename (file-name-nondirectory filename)))
2525 ;; Now search the path.
2526 (while (and dirs (null buffer))
2527 (setq thisdir (or (car dirs) spec-dir)
2529 ;; For each directory, try each format string.
2530 (while (and fmts (null buffer))
2531 (setq name (expand-file-name (format (car fmts) filename) thisdir)
2532 buffer (and (file-exists-p name)
2533 (find-file-noselect name))
2535 (setq dirs (cdr dirs)))
2536 (while (null buffer) ;Repeat until the user selects an existing file.
2537 ;; The file doesn't exist. Ask the user where to find it.
2538 (save-excursion ;This save-excursion is probably not right.
2539 (let ((pop-up-windows t))
2540 (compilation-set-window (display-buffer (marker-buffer marker))
2542 (let* ((name (read-file-name
2543 (format "Find this %s in (default %s): "
2544 compilation-error filename)
2545 spec-dir filename t nil
2546 ;; The predicate below is fine when called from
2547 ;; minibuffer-complete-and-exit, but it's too
2548 ;; restrictive otherwise, since it also prevents the
2549 ;; user from completing "fo" to "foo/" when she
2550 ;; wants to enter "foo/bar".
2552 ;; Try to make sure the user can only select
2553 ;; a valid answer. This predicate may be ignored,
2554 ;; tho, so we still have to double-check afterwards.
2555 ;; TODO: We should probably fix read-file-name so
2556 ;; that it never ignores this predicate, even when
2557 ;; using popup dialog boxes.
2559 ;; (if (file-directory-p name)
2560 ;; (setq name (expand-file-name filename name)))
2561 ;; (file-exists-p name))
2565 ((not (file-exists-p name))
2566 (message "Cannot find file `%s'" name)
2568 ((and (file-directory-p name)
2570 (setq name (expand-file-name filename name)))))
2571 (message "No `%s' in directory %s" filename origname)
2574 (setq buffer (find-file-noselect name))))))))
2575 ;; Make intangible overlays tangible.
2576 ;; This is weird: it's not even clear which is the current buffer,
2577 ;; so the code below can't be expected to DTRT here. -- Stef
2578 (dolist (ov (overlays-in (point-min) (point-max)))
2579 (when (overlay-get ov 'intangible)
2580 (overlay-put ov 'intangible nil)))
2583 (defun compilation-get-file-structure (file &optional fmt)
2584 "Retrieve FILE's file-structure or create a new one.
2585 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
2586 In the former case, FILENAME may be relative or absolute.
2588 The file-structure looks like this:
2589 ((FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)"
2590 (or (gethash file compilation-locs)
2591 ;; File was not previously encountered, at least not in the form passed.
2592 ;; Let's normalize it and look again.
2593 (let ((filename (car file))
2594 ;; Get the specified directory from FILE.
2595 (spec-directory (if (cdr file)
2596 (file-truename (cdr file)))))
2598 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2599 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2601 (when (and (boundp 'comint-file-name-prefix)
2602 (not (equal comint-file-name-prefix "")))
2603 (if (file-name-absolute-p filename)
2605 (concat comint-file-name-prefix filename))
2607 (setq spec-directory
2609 (concat comint-file-name-prefix spec-directory))))))
2611 ;; If compilation-parse-errors-filename-function is
2612 ;; defined, use it to process the filename.
2613 (when compilation-parse-errors-filename-function
2615 (funcall compilation-parse-errors-filename-function
2618 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
2619 ;; file names like "./bar//foo.c" for file "bar/foo.c";
2620 ;; expand-file-name will collapse these into "/foo.c" and fail to find
2621 ;; the appropriate file. So we look for doubled slashes in the file
2622 ;; name and fix them.
2623 (setq filename (command-line-normalize-file-name filename))
2625 ;; Store it for the possibly unnormalized name
2627 ;; Retrieve or create file-structure for normalized name
2628 ;; The gethash used to not use spec-directory, but
2629 ;; this leads to errors when files in different
2630 ;; directories have the same name:
2631 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00463.html
2632 (or (gethash (cons filename spec-directory) compilation-locs)
2633 (puthash (cons filename spec-directory)
2634 (compilation--make-file-struct
2635 (list filename spec-directory) fmt)
2637 compilation-locs))))
2639 (defun compilation--flush-file-structure (file)
2640 (or (consp file) (setq file (list file)))
2641 (let ((fs (compilation-get-file-structure file)))
2642 (assert (eq fs (gethash file compilation-locs)))
2643 (assert (eq fs (gethash (cons (caar fs) (cadr (car fs)))
2645 (maphash (lambda (k v)
2646 (if (eq v fs) (remhash k compilation-locs)))
2649 (add-to-list 'debug-ignored-errors "\\`No more [-a-z ]+s yet\\'")
2650 (add-to-list 'debug-ignored-errors "\\`Moved past last .*")
2652 ;;; Compatibility with the old compile.el.
2654 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
2655 (defvar compilation-parsing-end (make-marker))
2656 (defvar compilation-error-list nil)
2657 (defvar compilation-old-error-list nil)
2659 (defun compilation--compat-error-properties (err)
2660 "Map old-style error ERR to new-style message."
2661 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
2662 ;; (MARKER . MARKER).
2663 (let ((dst (cdr err)))
2665 `(compilation-message ,(compilation--make-message
2666 (cons nil (compilation--make-cdrloc
2669 help-echo "mouse-2: visit the source location"
2670 keymap compilation-button-map
2671 mouse-face highlight)
2672 ;; Too difficult to do it by hand: dispatch to the normal code.
2673 (let* ((file (pop dst))
2676 (filename (pop file))
2677 (dirname (pop file))
2679 (compilation-internal-error-properties
2680 (cons filename dirname) line nil col nil 2 fmt)))))
2682 (defun compilation--compat-parse-errors (limit)
2683 (when compilation-parse-errors-function
2684 ;; FIXME: We should remove the rest of the compilation keywords
2685 ;; but we can't do that from here because font-lock is using
2686 ;; the value right now. --Stef
2688 (setq compilation-error-list nil)
2689 ;; Reset compilation-parsing-end each time because font-lock
2690 ;; might force us the re-parse many times (typically because
2691 ;; some code adds some text-property to the output that we
2692 ;; already parsed). You might say "why reparse", well:
2693 ;; because font-lock has just removed the `compilation-message' property
2694 ;; so have to do it all over again.
2695 (if compilation-parsing-end
2696 (set-marker compilation-parsing-end (point))
2697 (setq compilation-parsing-end (point-marker)))
2699 ;; Ignore any error: we're calling this function earlier than
2700 ;; in the old compile.el so things might not all be setup yet.
2701 (funcall compilation-parse-errors-function limit nil)
2703 (dolist (err (if (listp compilation-error-list) compilation-error-list))
2704 (let* ((src (car err))
2706 (loc (cond ((markerp dst)
2708 (compilation--make-cdrloc nil nil dst)))
2711 (compilation--make-cdrloc
2713 (cons (cdar dst) (caar dst))
2717 ;; (put-text-property src (line-end-position)
2718 ;; 'font-lock-face 'font-lock-warning-face)
2719 (put-text-property src (line-end-position)
2720 'compilation-message
2721 (compilation--make-message loc 2 nil)))))))
2725 ;; Beware! this is not only compatibility code. New code also uses it. --Stef
2726 (defun compilation-forget-errors ()
2727 ;; In case we hit the same file/line specs, we want to recompute a new
2728 ;; marker for them, so flush our cache.
2729 (clrhash compilation-locs)
2730 (setq compilation-gcpro nil)
2731 ;; FIXME: the old code reset the directory-stack, so maybe we should
2732 ;; put a `directory change' marker of some sort, but where? -stef
2734 ;; FIXME: The old code moved compilation-current-error (which was
2735 ;; virtually represented by a mix of compilation-parsing-end and
2736 ;; compilation-error-list) to point-min, but that was only meaningful for
2737 ;; the internal uses of compilation-forget-errors: all calls from external
2738 ;; packages seem to be followed by a move of compilation-parsing-end to
2739 ;; something equivalent to point-max. So we heuristically move
2740 ;; compilation-current-error to point-max (since the external package
2741 ;; won't know that it should do it). --Stef
2742 (setq compilation-current-error nil)
2743 (let* ((proc (get-buffer-process (current-buffer)))
2744 (mark (if proc (process-mark proc)))
2745 (pos (or mark (point-max))))
2746 (setq compilation-messages-start
2747 ;; In the future, ignore the text already present in the buffer.
2748 ;; Since many process filter functions insert before markers,
2749 ;; we need to put ours just before the insertion point rather
2750 ;; than at the insertion point. If that's not possible, then
2751 ;; don't use a marker. --Stef
2752 (if (> pos (point-min)) (copy-marker (1- pos)) pos)))
2753 ;; Again, since this command is used in buffers that contain several
2754 ;; compilations, to set the beginning of "this compilation", it's a good
2755 ;; place to reset compilation-auto-jump-to-next.
2756 (set (make-local-variable 'compilation-auto-jump-to-next)
2757 (or compilation-auto-jump-to-first-error
2758 (eq compilation-scroll-output 'first-error))))
2762 ;;; compile.el ends here