Comint, term, and compile now set EMACS
[emacs.git] / lisp / progmodes / compile.el
blob0b15a283090ea98258dd29b6c3de2459cb5a9881
1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1993-1999, 2001-2016 Free Software
4 ;; Foundation, Inc.
6 ;; Authors: Roland McGrath <roland@gnu.org>,
7 ;; Daniel Pfeiffer <occitan@esperanto.org>
8 ;; Maintainer: emacs-devel@gnu.org
9 ;; Keywords: tools, processes
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This package provides the compile facilities documented in the Emacs user's
29 ;; manual.
31 ;;; Code:
33 (eval-when-compile (require 'cl-lib))
34 (require 'tool-bar)
35 (require 'comint)
37 (defgroup compilation nil
38 "Run compiler as inferior of Emacs, parse error messages."
39 :group 'tools
40 :group 'processes)
43 ;;;###autoload
44 (defcustom compilation-mode-hook nil
45 "List of hook functions run by `compilation-mode'."
46 :type 'hook
47 :group 'compilation)
49 ;;;###autoload
50 (defcustom compilation-start-hook nil
51 "Hook run after starting a new compilation process.
52 The hook is run with one argument, the new process."
53 :type 'hook
54 :group 'compilation)
56 ;;;###autoload
57 (defcustom compilation-window-height nil
58 "Number of lines in a compilation window.
59 If nil, use Emacs default."
60 :type '(choice (const :tag "Default" nil)
61 integer)
62 :group 'compilation)
64 (defvar compilation-filter-hook nil
65 "Hook run after `compilation-filter' has inserted a string into the buffer.
66 It is called with the variable `compilation-filter-start' bound
67 to the position of the start of the inserted text, and point at
68 its end.
70 If Emacs lacks asynchronous process support, this hook is run
71 after `call-process' inserts the grep output into the buffer.")
73 (defvar compilation-filter-start nil
74 "Position of the start of the text inserted by `compilation-filter'.
75 This is bound before running `compilation-filter-hook'.")
77 (defvar compilation-first-column 1
78 "This is how compilers number the first column, usually 1 or 0.
79 If this is buffer-local in the destination buffer, Emacs obeys
80 that value, otherwise it uses the value in the *compilation*
81 buffer. This enables a major-mode to specify its own value.")
83 (defvar compilation-parse-errors-filename-function nil
84 "Function to call to post-process filenames while parsing error messages.
85 It takes one arg FILENAME which is the name of a file as found
86 in the compilation output, and should return a transformed file name.")
88 ;;;###autoload
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.")
95 ;;;###autoload
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) \"*\")'.")
102 ;;;###autoload
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."
110 "22.1")
112 ;;;###autoload
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")
122 minor-mode-alist)))
124 (defvar compilation-error "error"
125 "Stem of message to print when no matches are found.")
127 (defvar compilation-arguments nil
128 "Arguments that were given to `compilation-start'.")
130 (defvar compilation-num-errors-found)
132 ;; If you make any changes to `compilation-error-regexp-alist-alist',
133 ;; be sure to run the ERT test in test/automated/compile-tests.el.
134 ;; emacs -batch -l compile-tests.el -f ert-run-tests-batch-and-exit
136 (defvar compilation-error-regexp-alist-alist
137 `((absoft
138 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
139 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
141 (ada
142 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
144 (aix
145 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
147 (ant
148 "^[ \t]*\\[[^] \n]+\\][ \t]*\\(\\(?:[A-Za-z]:\\\\\\)?[^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\):\\)?\
149 \\( warning\\)?" 1 (2 . 4) (3 . 5) (6))
151 (bash
152 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
154 (borland
155 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
156 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
157 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
159 (python-tracebacks-and-caml
160 "^[ \t]*File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
161 \\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning\\(?: [0-9]+\\)?:\\)?\\)"
162 2 (3 . 4) (5 . 6) (7))
164 (comma
165 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
166 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
168 (cucumber
169 "\\(?:^cucumber\\(?: -p [^[:space:]]+\\)?\\|#\\)\
170 \\(?: \\)\\([^(].*\\):\\([1-9][0-9]*\\)" 1 2)
172 (msft
173 ;; Must be before edg-1, so that MSVC's longer messages are
174 ;; considered before EDG.
175 ;; The message may be a "warning", "error", or "fatal error" with
176 ;; an error code, or "see declaration of" without an error code.
177 "^ *\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) ?\
178 : \\(?:see declaration\\|\\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:\\)"
179 2 3 nil (4))
181 (edg-1
182 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
183 1 2 nil (3 . 4))
184 (edg-2
185 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
186 2 1 nil 0)
188 (epc
189 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
191 (ftnchek
192 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
193 4 2 3 (1))
195 (iar
196 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
197 1 2 nil (3))
199 (ibm
200 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
201 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
203 ;; fixme: should be `mips'
204 (irix
205 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
206 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
208 (java
209 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
211 (jikes-file
212 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
215 ;; This used to be pathologically slow on long lines (Bug#3441),
216 ;; due to matching filenames via \\(.*?\\). This might be faster.
217 (maven
218 ;; Maven is a popular free software build tool for Java.
219 "\\(\\[WARNING\\] *\\)?\\([^ \n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\):\\[\\([0-9]+\\),\\([0-9]+\\)\\] " 2 3 4 (1))
221 (jikes-line
222 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
223 nil 1 nil 2 0
224 (2 (compilation-face '(3))))
226 (gcc-include
227 "^\\(?:In file included \\| \\|\t\\)from \
228 \\([0-9]*[^0-9\n]\\(?:[^\n :]\\| [^-/\n]\\|:[^ \n]\\)*?\\):\
229 \\([0-9]+\\)\\(?::\\([0-9]+\\)\\)?\\(?:\\(:\\)\\|\\(,\\|$\\)\\)?"
230 1 2 3 (4 . 5))
232 (ruby-Test::Unit
233 "^[\t ]*\\[\\([^(].*\\):\\([1-9][0-9]*\\)\\(\\]\\)?:in " 1 2)
235 (gnu
236 ;; The first line matches the program name for
238 ;; PROGRAM:SOURCE-FILE-NAME:LINENO: MESSAGE
240 ;; format, which is used for non-interactive programs other than
241 ;; compilers (e.g. the "jade:" entry in compilation.txt).
243 ;; This first line makes things ambiguous with output such as
244 ;; "foo:344:50:blabla" since the "foo" part can match this first
245 ;; line (in which case the file name as "344"). To avoid this,
246 ;; the second line disallows filenames exclusively composed of
247 ;; digits.
249 ;; Similarly, we get lots of false positives with messages including
250 ;; times of the form "HH:MM:SS" where MM is taken as a line number, so
251 ;; the last line tries to rule out message where the info after the
252 ;; line number starts with "SS". --Stef
254 ;; The core of the regexp is the one with *?. It says that a file name
255 ;; can be composed of any non-newline char, but it also rules out some
256 ;; valid but unlikely cases, such as a trailing space or a space
257 ;; followed by a -, or a colon followed by a space.
259 ;; The "in \\|from " exception was added to handle messages from Ruby.
260 ,(rx
262 (? (| (regexp "[[:alpha:]][-[:alnum:].]+: ?")
263 (regexp "[ \t]+\\(?:in \\|from\\)")))
264 (group-n 1 (: (regexp "[0-9]*[^0-9\n]")
265 (*? (| (regexp "[^\n :]")
266 (regexp " [^-/\n]")
267 (regexp ":[^ \n]")))))
268 (regexp ": ?")
269 (group-n 2 (regexp "[0-9]+"))
270 (? (| (: "-"
271 (group-n 4 (regexp "[0-9]+"))
272 (? "." (group-n 5 (regexp "[0-9]+"))))
273 (: (in ".:")
274 (group-n 3 (regexp "[0-9]+"))
275 (? "-"
276 (? (group-n 4 (regexp "[0-9]+")) ".")
277 (group-n 5 (regexp "[0-9]+"))))))
279 (| (: (* " ")
280 (group-n 6 (| "FutureWarning"
281 "RuntimeWarning"
282 "Warning"
283 "warning"
284 "W:")))
285 (: (* " ")
286 (group-n 7 (| (regexp "[Ii]nfo\\(?:\\>\\|rmationa?l?\\)")
287 "I:"
288 (: "[ skipping " (+ ".") " ]")
289 "instantiated from"
290 "required from"
291 (regexp "[Nn]ote"))))
292 (: (* " ")
293 (regexp "[Ee]rror"))
294 (: (regexp "[0-9]?")
295 (| (regexp "[^0-9\n]")
296 eol))
297 (regexp "[0-9][0-9][0-9]")))
298 1 (2 . 4) (3 . 5) (6 . 7))
300 (lcc
301 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
302 2 3 4 (1))
304 (makepp
305 "^makepp\\(?:\\(?:: warning\\(:\\).*?\\|\\(: Scanning\\|: [LR]e?l?oading makefile\\|: Imported\\|log:.*?\\) \\|: .*?\\)\
306 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
307 4 5 nil (1 . 2) 3
308 (0 (progn (save-match-data
309 (compilation-parse-errors
310 (match-end 0) (line-end-position)
311 `("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]"
312 2 3 nil
313 ,(cond ((match-end 1) 1) ((match-end 2) 0) (t 2))
314 1)))
315 (end-of-line)
316 nil)))
318 ;; Should be lint-1, lint-2 (SysV lint)
319 (mips-1
320 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
321 (mips-2
322 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
324 (msft
325 ;; The message may be a "warning", "error", or "fatal error" with
326 ;; an error code, or "see declaration of" without an error code.
327 "^ *\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
328 : \\(?:see declaration\\|\\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:\\)"
329 2 3 nil (4))
331 (omake
332 ;; "omake -P" reports "file foo changed"
333 ;; (useful if you do "cvs up" and want to see what has changed)
334 "omake: file \\(.*\\) changed" 1 nil nil nil nil
335 ;; FIXME-omake: This tries to prevent reusing pre-existing markers
336 ;; for subsequent messages, since those messages's line numbers
337 ;; are about another version of the file.
338 (0 (progn (compilation--flush-file-structure (match-string 1))
339 nil)))
341 (oracle
342 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
343 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
344 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
345 3 1 2)
347 ;; "during global destruction": This comes out under "use
348 ;; warnings" in recent perl when breaking circular references
349 ;; during program or thread exit.
350 (perl
351 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\| \
352 during global destruction\\.$\\)" 1 2)
354 (php
355 "\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)"
356 2 3 nil nil)
358 (rxp
359 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
360 \\([0-9]+\\) of file://\\(.+\\)"
361 4 2 3 (1))
363 (sparc-pascal-file
364 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
365 [12][09][0-9][0-9] +\\(.*\\):$"
366 1 nil nil 0)
367 (sparc-pascal-line
368 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
369 nil 3 nil (2) nil (1 (compilation-face '(2))))
370 (sparc-pascal-example
371 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
372 nil 1 nil (3) nil (2 (compilation-face '(3))))
374 (sun
375 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
376 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
377 3 4 5 (1 . 2))
379 (sun-ada
380 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., (-]" 1 2 3)
382 (watcom
383 "^[ \t]*\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)): ?\
384 \\(?:\\(Error! E[0-9]+\\)\\|\\(Warning! W[0-9]+\\)\\):"
385 1 2 nil (4))
387 (4bsd
388 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
389 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3))
391 (gcov-file
392 "^ *-: *\\(0\\):Source:\\(.+\\)$"
393 2 1 nil 0 nil)
394 (gcov-header
395 "^ *-: *\\(0\\):\\(?:Object\\|Graph\\|Data\\|Runs\\|Programs\\):.+$"
396 nil 1 nil 0 nil)
397 ;; Underlines over all lines of gcov output are too uncomfortable to read.
398 ;; However, hyperlinks embedded in the lines are useful.
399 ;; So I put default face on the lines; and then put
400 ;; compilation-*-face by manually to eliminate the underlines.
401 ;; The hyperlinks are still effective.
402 (gcov-nomark
403 "^ *-: *\\([1-9]\\|[0-9]\\{2,\\}\\):.*$"
404 nil 1 nil 0 nil
405 (0 'default)
406 (1 compilation-line-face))
407 (gcov-called-line
408 "^ *\\([0-9]+\\): *\\([0-9]+\\):.*$"
409 nil 2 nil 0 nil
410 (0 'default)
411 (1 compilation-info-face) (2 compilation-line-face))
412 (gcov-never-called
413 "^ *\\(#####\\): *\\([0-9]+\\):.*$"
414 nil 2 nil 2 nil
415 (0 'default)
416 (1 compilation-error-face) (2 compilation-line-face))
418 (perl--Pod::Checker
419 ;; podchecker error messages, per Pod::Checker.
420 ;; The style is from the Pod::Checker::poderror() function, eg.
421 ;; *** ERROR: Spurious text after =cut at line 193 in file foo.pm
423 ;; Plus end_pod() can give "at line EOF" instead of a
424 ;; number, so for that match "on line N" which is the
425 ;; originating spot, eg.
426 ;; *** ERROR: =over on line 37 without closing =back at line EOF in file bar.pm
428 ;; Plus command() can give both "on line N" and "at line N";
429 ;; the latter is desired and is matched because the .* is
430 ;; greedy.
431 ;; *** ERROR: =over on line 1 without closing =back (at head1) at line 3 in file x.pod
433 "^\\*\\*\\* \\(?:ERROR\\|\\(WARNING\\)\\).* \\(?:at\\|on\\) line \
434 \\([0-9]+\\) \\(?:.* \\)?in file \\([^ \t\n]+\\)"
435 3 2 nil (1))
436 (perl--Test
437 ;; perl Test module error messages.
438 ;; Style per the ok() function "$context", eg.
439 ;; # Failed test 1 in foo.t at line 6
441 "^# Failed test [0-9]+ in \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
442 1 2)
443 (perl--Test2
444 ;; Or when comparing got/want values, with a "fail #n" if repeated
445 ;; # Test 2 got: "xx" (t-compilation-perl-2.t at line 10)
446 ;; # Test 3 got: "xx" (t-compilation-perl-2.t at line 10 fail #2)
448 ;; And under Test::Harness they're preceded by progress stuff with
449 ;; \r and "NOK",
450 ;; ... NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
452 "^\\(.*NOK.*\\)?# Test [0-9]+ got:.* (\\([^ \t\r\n]+\\) at line \
453 \\([0-9]+\\)\\( fail #[0-9]+\\)?)"
454 2 3)
455 (perl--Test::Harness
456 ;; perl Test::Harness output, eg.
457 ;; NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
459 ;; Test::Harness is slightly designed for tty output, since
460 ;; it prints CRs to overwrite progress messages, but if you
461 ;; run it in with M-x compile this pattern can at least step
462 ;; through the failures.
464 "^.*NOK.* \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
465 1 2)
466 (weblint
467 ;; The style comes from HTML::Lint::Error::as_string(), eg.
468 ;; index.html (13:1) Unknown element <fdjsk>
470 ;; The pattern only matches filenames without spaces, since that
471 ;; should be usual and should help reduce the chance of a false
472 ;; match of a message from some unrelated program.
474 ;; This message style is quite close to the "ibm" entry which is
475 ;; for IBM C, though that ibm bit doesn't put a space after the
476 ;; filename.
478 "^\\([^ \t\r\n(]+\\) (\\([0-9]+\\):\\([0-9]+\\)) "
479 1 2 3)
481 ;; Guile compilation yields file-headers in the following format:
483 ;; In sourcefile.scm:
485 ;; We need to catch those, but we also need to be aware that Emacs
486 ;; byte-compilation yields compiler headers in similar form of
487 ;; those:
489 ;; In toplevel form:
490 ;; In end of data:
492 ;; We want to catch the Guile file-headers but not the Emacs
493 ;; byte-compilation headers, because that will cause next-error
494 ;; and prev-error to break, because the files "toplevel form" and
495 ;; "end of data" does not exist.
497 ;; To differentiate between these two cases, we require that the
498 ;; file-match must always contain an extension.
500 ;; We should also only treat this as "info", not "error", because
501 ;; we do not know what lines will follow.
502 (guile-file "^In \\(.+\\..+\\):\n" 1 nil nil 0)
503 (guile-line "^ *\\([0-9]+\\): *\\([0-9]+\\)" nil 1 2)
505 "Alist of values for `compilation-error-regexp-alist'.")
507 (defcustom compilation-error-regexp-alist
508 (mapcar 'car compilation-error-regexp-alist-alist)
509 "Alist that specifies how to match errors in compiler output.
510 On GNU and Unix, any string is a valid filename, so these
511 matchers must make some common sense assumptions, which catch
512 normal cases. A shorter list will be lighter on resource usage.
514 Instead of an alist element, you can use a symbol, which is
515 looked up in `compilation-error-regexp-alist-alist'. You can see
516 the predefined symbols and their effects in the file
517 `etc/compilation.txt' (linked below if you are customizing this).
519 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
520 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
521 gives the file name, and the LINE'th subexpression gives the line
522 number. The COLUMN'th subexpression gives the column number on
523 that line.
525 If FILE, LINE or COLUMN are nil or that index didn't match, that
526 information is not present on the matched line. In that case the
527 file name is assumed to be the same as the previous one in the
528 buffer, line number defaults to 1 and column defaults to
529 beginning of line's indentation.
531 FILE can also have the form (FILE FORMAT...), where the FORMATs
532 \(e.g. \"%s.c\") will be applied in turn to the recognized file
533 name, until a file of that name is found. Or FILE can also be a
534 function that returns (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
535 In the former case, FILENAME may be relative or absolute.
537 LINE can also be of the form (LINE . END-LINE) meaning a range
538 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
539 meaning a range of columns starting on LINE and ending on
540 END-LINE, if that matched.
542 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
543 TYPE can also be of the form (WARNING . INFO). In that case this
544 will be equivalent to 1 if the WARNING'th subexpression matched
545 or else equivalent to 0 if the INFO'th subexpression matched.
546 See `compilation-error-face', `compilation-warning-face',
547 `compilation-info-face' and `compilation-skip-threshold'.
549 What matched the HYPERLINK'th subexpression has `mouse-face' and
550 `compilation-message-face' applied. If this is nil, the text
551 matched by the whole REGEXP becomes the hyperlink.
553 Additional HIGHLIGHTs take the shape (SUBMATCH FACE), where
554 SUBMATCH is the number of a submatch and FACE is an expression
555 which evaluates to a face name (a symbol or string).
556 Alternatively, FACE can evaluate to a property list of the
557 form (face FACE PROP1 VAL1 PROP2 VAL2 ...), in which case all the
558 listed text properties PROP# are given values VAL# as well."
559 :type '(repeat (choice (symbol :tag "Predefined symbol")
560 (sexp :tag "Error specification")))
561 :link `(file-link :tag "example file"
562 ,(expand-file-name "compilation.txt" data-directory))
563 :group 'compilation)
565 ;;;###autoload(put 'compilation-directory 'safe-local-variable 'stringp)
566 (defvar compilation-directory nil
567 "Directory to restore to when doing `recompile'.")
569 (defvar compilation-directory-matcher
570 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory [`']\\(.+\\)'$" (2 . 1))
571 "A list for tracking when directories are entered or left.
572 If nil, do not track directories, e.g. if all file names are absolute. The
573 first element is the REGEXP matching these messages. It can match any number
574 of variants, e.g. different languages. The remaining elements are all of the
575 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
576 matches, that is a directory name. If LEAVE is nil or the corresponding
577 LEAVE'th subexpression doesn't match, this message is about going into another
578 directory. If it does match anything, this message is about going back to the
579 directory we were in before the last entering message. If you change this,
580 you may also want to change `compilation-page-delimiter'.")
582 (defvar compilation-page-delimiter
583 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory [`'].+'\n\\)+"
584 "Value of `page-delimiter' in Compilation mode.")
586 (defvar compilation-mode-font-lock-keywords
587 '(;; configure output lines.
588 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
589 (1 font-lock-variable-name-face)
590 (2 (compilation-face '(4 . 3))))
591 ;; Command output lines. Recognize `make[n]:' lines too.
592 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
593 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
594 (" --?o\\(?:utfile\\|utput\\)?[= ]\\(\\S +\\)" . 1)
595 ("^Compilation \\(finished\\).*"
596 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
597 (1 compilation-info-face))
598 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\|segmentation fault\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
599 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
600 (1 compilation-error-face)
601 (2 compilation-error-face nil t)))
602 "Additional things to highlight in Compilation mode.
603 This gets tacked on the end of the generated expressions.")
605 (defvar compilation-highlight-regexp t
606 "Regexp matching part of visited source lines to highlight temporarily.
607 Highlight entire line if t; don't highlight source lines if nil.")
609 (defvar compilation-highlight-overlay nil
610 "Overlay used to temporarily highlight compilation matches.")
612 (defcustom compilation-error-screen-columns t
613 "If non-nil, column numbers in error messages are screen columns.
614 Otherwise they are interpreted as character positions, with
615 each character occupying one column.
616 The default is to use screen columns, which requires that the compilation
617 program and Emacs agree about the display width of the characters,
618 especially the TAB character.
619 If this is buffer-local in the destination buffer, Emacs obeys
620 that value, otherwise it uses the value in the *compilation*
621 buffer. This enables a major-mode to specify its own value."
622 :type 'boolean
623 :group 'compilation
624 :version "20.4")
626 (defcustom compilation-read-command t
627 "Non-nil means \\[compile] reads the compilation command to use.
628 Otherwise, \\[compile] just uses the value of `compile-command'.
630 Note that changing this to nil may be a security risk, because a
631 file might define a malicious `compile-command' as a file local
632 variable, and you might not notice. Therefore, `compile-command'
633 is considered unsafe if this variable is nil."
634 :type 'boolean
635 :group 'compilation)
637 ;;;###autoload
638 (defcustom compilation-ask-about-save t
639 "Non-nil means \\[compile] asks which buffers to save before compiling.
640 Otherwise, it saves all modified buffers without asking."
641 :type 'boolean
642 :group 'compilation)
644 (defcustom compilation-save-buffers-predicate nil
645 "The second argument (PRED) passed to `save-some-buffers' before compiling.
646 E.g., one can set this to
647 (lambda ()
648 (string-prefix-p my-compilation-root (file-truename (buffer-file-name))))
649 to limit saving to files located under `my-compilation-root'.
650 Note, that, in general, `compilation-directory' cannot be used instead
651 of `my-compilation-root' here."
652 :type '(choice
653 (const :tag "Default (save all file-visiting buffers)" nil)
654 (const :tag "Save all buffers" t)
655 function)
656 :group 'compilation
657 :version "24.1")
659 ;;;###autoload
660 (defcustom compilation-search-path '(nil)
661 "List of directories to search for source files named in error messages.
662 Elements should be directory names, not file names of directories.
663 The value nil as an element means to try the default directory."
664 :type '(repeat (choice (const :tag "Default" nil)
665 (string :tag "Directory")))
666 :group 'compilation)
668 ;;;###autoload
669 (defcustom compile-command (purecopy "make -k ")
670 "Last shell command used to do a compilation; default for next compilation.
672 Sometimes it is useful for files to supply local values for this variable.
673 You might also use mode hooks to specify it in certain modes, like this:
675 (add-hook \\='c-mode-hook
676 (lambda ()
677 (unless (or (file-exists-p \"makefile\")
678 (file-exists-p \"Makefile\"))
679 (set (make-local-variable \\='compile-command)
680 (concat \"make -k \"
681 (if buffer-file-name
682 (shell-quote-argument
683 (file-name-sans-extension buffer-file-name))))))))"
684 :type 'string
685 :group 'compilation)
686 ;;;###autoload(put 'compile-command 'safe-local-variable (lambda (a) (and (stringp a) (or (not (boundp 'compilation-read-command)) compilation-read-command))))
688 ;;;###autoload
689 (defcustom compilation-disable-input nil
690 "If non-nil, send end-of-file as compilation process input.
691 This only affects platforms that support asynchronous processes (see
692 `start-process'); synchronous compilation processes never accept input."
693 :type 'boolean
694 :group 'compilation
695 :version "22.1")
697 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
698 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
699 ;; key. This holds the tree seen from root, for storing new nodes.
700 (defvar compilation-locs ())
702 (defvar compilation-debug nil
703 "Set this to t before creating a *compilation* buffer.
704 Then every error line will have a debug text property with the matcher that
705 fit this line and the match data. Use `describe-text-properties'.")
707 (defvar compilation-exit-message-function nil "\
708 If non-nil, called when a compilation process dies to return a status message.
709 This should be a function of three arguments: process status, exit status,
710 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
711 write into the compilation buffer, and to put in its mode line.")
713 (defcustom compilation-environment nil
714 "List of environment variables for compilation to inherit.
715 Each element should be a string of the form ENVVARNAME=VALUE.
716 This list is temporarily prepended to `process-environment' prior to
717 starting the compilation process."
718 :type '(repeat (string :tag "ENVVARNAME=VALUE"))
719 :options '(("LANG=C"))
720 :group 'compilation
721 :version "24.1")
723 ;; History of compile commands.
724 (defvar compile-history nil)
726 (defface compilation-error
727 '((t :inherit error))
728 "Face used to highlight compiler errors."
729 :group 'compilation
730 :version "22.1")
732 (defface compilation-warning
733 '((t :inherit warning))
734 "Face used to highlight compiler warnings."
735 :group 'compilation
736 :version "22.1")
738 (defface compilation-info
739 '((t :inherit success))
740 "Face used to highlight compiler information."
741 :group 'compilation
742 :version "22.1")
744 ;; The next three faces must be able to stand out against the
745 ;; `mode-line' and `mode-line-inactive' faces.
747 (defface compilation-mode-line-fail
748 '((default :inherit compilation-error)
749 (((class color) (min-colors 16)) (:foreground "Red1" :weight bold))
750 (((class color) (min-colors 8)) (:foreground "red"))
751 (t (:inverse-video t :weight bold)))
752 "Face for Compilation mode's \"error\" mode line indicator."
753 :group 'compilation
754 :version "24.3")
756 (defface compilation-mode-line-run
757 '((t :inherit compilation-warning))
758 "Face for Compilation mode's \"running\" mode line indicator."
759 :group 'compilation
760 :version "24.3")
762 (defface compilation-mode-line-exit
763 '((default :inherit compilation-info)
764 (((class color) (min-colors 16))
765 (:foreground "ForestGreen" :weight bold))
766 (((class color)) (:foreground "green" :weight bold))
767 (t (:weight bold)))
768 "Face for Compilation mode's \"exit\" mode line indicator."
769 :group 'compilation
770 :version "24.3")
772 (defface compilation-line-number
773 '((t :inherit font-lock-keyword-face))
774 "Face for displaying line numbers in compiler messages."
775 :group 'compilation
776 :version "22.1")
778 (defface compilation-column-number
779 '((t :inherit font-lock-doc-face))
780 "Face for displaying column numbers in compiler messages."
781 :group 'compilation
782 :version "22.1")
784 (defcustom compilation-message-face 'underline
785 "Face name to use for whole messages.
786 Faces `compilation-error-face', `compilation-warning-face',
787 `compilation-info-face', `compilation-line-face' and
788 `compilation-column-face' get prepended to this, when applicable."
789 :type 'face
790 :group 'compilation
791 :version "22.1")
793 (defvar compilation-error-face 'compilation-error
794 "Face name to use for file name in error messages.")
796 (defvar compilation-warning-face 'compilation-warning
797 "Face name to use for file name in warning messages.")
799 (defvar compilation-info-face 'compilation-info
800 "Face name to use for file name in informational messages.")
802 (defvar compilation-line-face 'compilation-line-number
803 "Face name to use for line numbers in compiler messages.")
805 (defvar compilation-column-face 'compilation-column-number
806 "Face name to use for column numbers in compiler messages.")
808 ;; same faces as dired uses
809 (defvar compilation-enter-directory-face 'font-lock-function-name-face
810 "Face name to use for entering directory messages.")
812 (defvar compilation-leave-directory-face 'font-lock-builtin-face
813 "Face name to use for leaving directory messages.")
815 ;; Used for compatibility with the old compile.el.
816 (defvar compilation-parse-errors-function nil)
817 (make-obsolete-variable 'compilation-parse-errors-function
818 'compilation-error-regexp-alist "24.1")
820 (defcustom compilation-auto-jump-to-first-error nil
821 "If non-nil, automatically jump to the first error during compilation."
822 :type 'boolean
823 :group 'compilation
824 :version "23.1")
826 (defvar compilation-auto-jump-to-next nil
827 "If non-nil, automatically jump to the next error encountered.")
828 (make-variable-buffer-local 'compilation-auto-jump-to-next)
830 ;; (defvar compilation-buffer-modtime nil
831 ;; "The buffer modification time, for buffers not associated with files.")
832 ;; (make-variable-buffer-local 'compilation-buffer-modtime)
834 (defvar compilation-skip-to-next-location t
835 "If non-nil, skip multiple error messages for the same source location.")
837 (defcustom compilation-skip-threshold 1
838 "Compilation motion commands skip less important messages.
839 The value can be either 2 -- skip anything less than error, 1 --
840 skip anything less than warning or 0 -- don't skip any messages.
841 Note that all messages not positively identified as warning or
842 info, are considered errors."
843 :type '(choice (const :tag "Skip warnings and info" 2)
844 (const :tag "Skip info" 1)
845 (const :tag "No skip" 0))
846 :group 'compilation
847 :version "22.1")
849 (defun compilation-set-skip-threshold (level)
850 "Switch the `compilation-skip-threshold' level."
851 (interactive
852 (list
853 (mod (if current-prefix-arg
854 (prefix-numeric-value current-prefix-arg)
855 (1+ compilation-skip-threshold))
856 3)))
857 (setq compilation-skip-threshold level)
858 (message "Skipping %s"
859 (pcase compilation-skip-threshold
860 (0 "Nothing")
861 (1 "Info messages")
862 (2 "Warnings and info"))))
864 (defcustom compilation-skip-visited nil
865 "Compilation motion commands skip visited messages if this is t.
866 Visited messages are ones for which the file, line and column have been jumped
867 to from the current content in the current compilation buffer, even if it was
868 from a different message."
869 :type 'boolean
870 :group 'compilation
871 :version "22.1")
873 (defun compilation-face (type)
874 (or (and (car type) (match-end (car type)) compilation-warning-face)
875 (and (cdr type) (match-end (cdr type)) compilation-info-face)
876 compilation-error-face))
878 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE nil nil)
880 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
881 ;; LINE will be nil for a message that doesn't contain them. Then the
882 ;; location refers to a indented beginning of line or beginning of file.
883 ;; Once any location in some file has been jumped to, the list is extended to
884 ;; (COLUMN LINE FILE-STRUCTURE MARKER TIMESTAMP . VISITED)
885 ;; for all LOCs pertaining to that file.
886 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
887 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
888 ;; before that point. VISITED is t if we have jumped there, else nil.
889 ;; FIXME-omake: TIMESTAMP was used to try and handle "incremental compilation":
890 ;; `omake -P' polls filesystem for changes and recompiles when a file is
891 ;; modified using the same *compilation* buffer. this necessitates
892 ;; re-parsing markers.
894 ;; (cl-defstruct (compilation--loc
895 ;; (:constructor nil)
896 ;; (:copier nil)
897 ;; (:constructor compilation--make-loc
898 ;; (file-struct line col marker))
899 ;; (:conc-name compilation--loc->))
900 ;; col line file-struct marker timestamp visited)
902 ;; FIXME: We don't use a defstruct because of compilation-assq which looks up
903 ;; and creates part of the LOC (only the first cons cell containing the COL).
905 (defmacro compilation--make-cdrloc (line file-struct marker)
906 `(list ,line ,file-struct ,marker nil))
907 (defmacro compilation--loc->col (loc) `(car ,loc))
908 (defmacro compilation--loc->line (loc) `(cadr ,loc))
909 (defmacro compilation--loc->file-struct (loc) `(nth 2 ,loc))
910 (defmacro compilation--loc->marker (loc) `(nth 3 ,loc))
911 ;; (defmacro compilation--loc->timestamp (loc) `(nth 4 ,loc))
912 (defmacro compilation--loc->visited (loc) `(nthcdr 5 ,loc))
914 ;; FILE-STRUCTURE is a list of
915 ;; ((FILENAME DIRECTORY) FORMATS (LINE LOC ...) ...)
917 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
918 ;; obtained by following directory change messages. DIRECTORY will be nil for
919 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
920 ;; a file of that name can't be found.
921 ;; The rest of the list is an alist of elements with LINE as key. The keys
922 ;; are either nil or line numbers. If present, nil comes first, followed by
923 ;; the numbers in decreasing order. The LOCs for each line are again an alist
924 ;; ordered the same way. Note that the whole file structure is referenced in
925 ;; every LOC.
927 (defmacro compilation--make-file-struct (file-spec formats &optional loc-tree)
928 `(cons ,file-spec (cons ,formats ,loc-tree)))
929 (defmacro compilation--file-struct->file-spec (fs) `(car ,fs))
930 (defmacro compilation--file-struct->formats (fs) `(cadr ,fs))
931 ;; The FORMATS field plays the role of ANCHOR in the loc-tree.
932 (defmacro compilation--file-struct->loc-tree (fs) `(cdr ,fs))
934 ;; MESSAGE is a list of (LOC TYPE END-LOC)
936 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
937 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
938 ;; other end, if the parsed message contained a range. If the end of the
939 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
940 ;; These are the value of the `compilation-message' text-properties in the
941 ;; compilation buffer.
943 (cl-defstruct (compilation--message
944 (:constructor nil)
945 (:copier nil)
946 ;; (:type list) ;Old representation.
947 (:constructor compilation--make-message (loc type end-loc))
948 (:conc-name compilation--message->))
949 loc type end-loc)
951 (defvar compilation--previous-directory-cache nil
952 "A pair (POS . RES) caching the result of previous directory search.
953 Basically, this pair says that calling
954 (previous-single-property-change POS \\='compilation-directory)
955 returned RES, i.e. there is no change of `compilation-directory' between
956 POS and RES.")
957 (make-variable-buffer-local 'compilation--previous-directory-cache)
959 (defun compilation--flush-directory-cache (start _end)
960 (cond
961 ((or (not compilation--previous-directory-cache)
962 (<= (car compilation--previous-directory-cache) start)))
963 ((or (not (cdr compilation--previous-directory-cache))
964 (null (marker-buffer (cdr compilation--previous-directory-cache)))
965 (<= (cdr compilation--previous-directory-cache) start))
966 (set-marker (car compilation--previous-directory-cache) start))
967 (t (setq compilation--previous-directory-cache nil))))
969 (defun compilation--previous-directory (pos)
970 "Like (previous-single-property-change POS \\='compilation-directory), but faster."
971 ;; This avoids an N² behavior when there's no/few compilation-directory
972 ;; entries, in which case each call to previous-single-property-change
973 ;; ends up having to walk very far back to find the last change.
974 (if (and compilation--previous-directory-cache
975 (< pos (car compilation--previous-directory-cache))
976 (or (null (cdr compilation--previous-directory-cache))
977 (< (cdr compilation--previous-directory-cache) pos)))
978 ;; No need to call previous-single-property-change.
979 (cdr compilation--previous-directory-cache)
981 (let* ((cache (and compilation--previous-directory-cache
982 (<= (car compilation--previous-directory-cache) pos)
983 (car compilation--previous-directory-cache)))
984 (prev
985 (previous-single-property-change
986 pos 'compilation-directory nil cache))
987 (res
988 (cond
989 ((null cache)
990 (setq compilation--previous-directory-cache
991 (cons (copy-marker pos) (if prev (copy-marker prev))))
992 prev)
993 ((and prev (= prev cache))
994 (set-marker (car compilation--previous-directory-cache) pos)
995 (cdr compilation--previous-directory-cache))
997 (set-marker cache pos)
998 (setcdr compilation--previous-directory-cache
999 (copy-marker prev))
1000 prev))))
1001 (if (markerp res) (marker-position res) res))))
1003 ;; Internal function for calculating the text properties of a directory
1004 ;; change message. The compilation-directory property is important, because it
1005 ;; is the stack of nested enter-messages. Relative filenames on the following
1006 ;; lines are relative to the top of the stack.
1007 (defun compilation-directory-properties (idx leave)
1008 (if leave (setq leave (match-end leave)))
1009 ;; find previous stack, and push onto it, or if `leave' pop it
1010 (let ((dir (compilation--previous-directory (match-beginning 0))))
1011 (setq dir (if dir (or (get-text-property (1- dir) 'compilation-directory)
1012 (get-text-property dir 'compilation-directory))))
1013 `(font-lock-face ,(if leave
1014 compilation-leave-directory-face
1015 compilation-enter-directory-face)
1016 compilation-directory ,(if leave
1017 (or (cdr dir)
1018 '(nil)) ; nil only isn't a property-change
1019 (cons (match-string-no-properties idx) dir))
1020 ;; Place a `compilation-message' everywhere we change text-properties
1021 ;; so compilation--remove-properties can know what to remove.
1022 compilation-message ,(compilation--make-message nil 0 nil)
1023 mouse-face highlight
1024 keymap compilation-button-map
1025 help-echo "mouse-2: visit destination directory")))
1027 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
1028 ;; KEY element from the ALIST, creating it in the right position if not already
1029 ;; present. ALIST structure is
1030 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
1031 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
1032 ;; may be nil. The other KEYs are ordered backwards so that growing line
1033 ;; numbers can be inserted in front and searching can abort after half the
1034 ;; list on average.
1035 (eval-when-compile ;Don't keep it at runtime if not needed.
1036 (defmacro compilation-assq (key alist)
1037 `(let* ((l1 ,alist)
1038 (l2 (cdr l1)))
1039 (car (if (if (null ,key)
1040 (if l2 (null (caar l2)))
1041 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
1042 (setq l1 l2
1043 l2 (cdr l1)))
1044 (if l2 (eq ,key (caar l2))))
1046 (setcdr l1 (cons (list ,key) l2)))))))
1048 (defun compilation-auto-jump (buffer pos)
1049 (with-current-buffer buffer
1050 (goto-char pos)
1051 (let ((win (get-buffer-window buffer 0)))
1052 (if win (set-window-point win pos)))
1053 (if compilation-auto-jump-to-first-error
1054 (compile-goto-error))))
1056 ;; This function is the central driver, called when font-locking to gather
1057 ;; all information needed to later jump to corresponding source code.
1058 ;; Return a property list with all meta information on this error location.
1060 (defun compilation-error-properties (file line end-line col end-col type fmt)
1061 (unless (text-property-not-all (match-beginning 0) (point)
1062 'compilation-message nil)
1063 (if file
1064 (when (stringp
1065 (setq file (if (functionp file) (funcall file)
1066 (match-string-no-properties file))))
1067 (let ((dir
1068 (unless (file-name-absolute-p file)
1069 (let ((pos (compilation--previous-directory
1070 (match-beginning 0))))
1071 (when pos
1072 (or (get-text-property (1- pos) 'compilation-directory)
1073 (get-text-property pos 'compilation-directory)))))))
1074 (setq file (cons file (car dir)))))
1075 ;; This message didn't mention one, get it from previous
1076 (let ((prev-pos
1077 ;; Find the previous message.
1078 (previous-single-property-change (point) 'compilation-message)))
1079 (if prev-pos
1080 ;; Get the file structure that belongs to it.
1081 (let* ((prev
1082 (or (get-text-property (1- prev-pos) 'compilation-message)
1083 (get-text-property prev-pos 'compilation-message)))
1084 (prev-file-struct
1085 (and prev
1086 (compilation--loc->file-struct
1087 (compilation--message->loc prev)))))
1089 ;; Construct FILE . DIR from that.
1090 (if prev-file-struct
1091 (setq file (cons (caar prev-file-struct)
1092 (cadr (car prev-file-struct)))))))
1093 (unless file
1094 (setq file '("*unknown*")))))
1095 ;; All of these fields are optional, get them only if we have an index, and
1096 ;; it matched some part of the message.
1097 (and line
1098 (setq line (match-string-no-properties line))
1099 (setq line (string-to-number line)))
1100 (and end-line
1101 (setq end-line (match-string-no-properties end-line))
1102 (setq end-line (string-to-number end-line)))
1103 (if col
1104 (if (functionp col)
1105 (setq col (funcall col))
1106 (and
1107 (setq col (match-string-no-properties col))
1108 (setq col (string-to-number col)))))
1109 (if (and end-col (functionp end-col))
1110 (setq end-col (funcall end-col))
1111 (if (and end-col (setq end-col (match-string-no-properties end-col)))
1112 (setq end-col (- (string-to-number end-col) -1))
1113 (if end-line (setq end-col -1))))
1114 (if (consp type) ; not a static type, check what it is.
1115 (setq type (or (and (car type) (match-end (car type)) 1)
1116 (and (cdr type) (match-end (cdr type)) 0)
1117 2)))
1119 (when (and compilation-auto-jump-to-next
1120 (>= type compilation-skip-threshold))
1121 (kill-local-variable 'compilation-auto-jump-to-next)
1122 (run-with-timer 0 nil 'compilation-auto-jump
1123 (current-buffer) (match-beginning 0)))
1125 (compilation-internal-error-properties
1126 file line end-line col end-col type fmt)))
1128 (defun compilation-beginning-of-line (&optional n)
1129 "Like `beginning-of-line', but accounts for lines hidden by `selective-display'."
1130 (if (or (not (eq selective-display t))
1131 (null n)
1132 (= n 1))
1133 (beginning-of-line n)
1134 (re-search-forward "[\n\r]" nil 'end (1- n))
1135 (if (< n 0)
1136 (beginning-of-line))))
1138 (defun compilation-move-to-column (col screen)
1139 "Go to column COL on the current line.
1140 If SCREEN is non-nil, columns are screen columns, otherwise, they are
1141 just char-counts."
1142 (setq col (- col compilation-first-column))
1143 (if screen
1144 ;; Presumably, the compilation tool doesn't know about our current
1145 ;; `tab-width' setting, so it probably assumed 8-wide TABs (bug#21038).
1146 (let ((tab-width 8)) (move-to-column (max col 0)))
1147 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
1149 (defun compilation-internal-error-properties (file line end-line col end-col type fmts)
1150 "Get the meta-info that will be added as text-properties.
1151 LINE, END-LINE, COL, END-COL are integers or nil.
1152 TYPE can be 0, 1, or 2, meaning error, warning, or just info.
1153 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil.
1154 FMTS is a list of format specs for transforming the file name.
1155 (See `compilation-error-regexp-alist'.)"
1156 (unless file (setq file '("*unknown*")))
1157 (let* ((file-struct (compilation-get-file-structure file fmts))
1158 ;; Get first already existing marker (if any has one, all have one).
1159 ;; Do this first, as the compilation-assq`s may create new nodes.
1160 (marker-line ; a line structure
1161 (cadr (compilation--file-struct->loc-tree file-struct)))
1162 (marker
1163 (if marker-line (compilation--loc->marker (cadr marker-line))))
1164 (screen-columns compilation-error-screen-columns)
1165 (first-column compilation-first-column)
1166 end-marker loc end-loc)
1167 (if (not (and marker (marker-buffer marker)))
1168 (setq marker nil) ; no valid marker for this file
1169 (unless line (setq line 1)) ; normalize no linenumber to line 1
1170 (catch 'marker ; find nearest loc, at least one exists
1171 (dolist (x (cddr (compilation--file-struct->loc-tree
1172 file-struct))) ; Loop over remaining lines.
1173 (if (> (car x) line) ; Still bigger.
1174 (setq marker-line x)
1175 (if (> (- (or (car marker-line) 1) line)
1176 (- line (car x))) ; Current line is nearer.
1177 (setq marker-line x))
1178 (throw 'marker t))))
1179 (setq marker (compilation--loc->marker (cadr marker-line))
1180 marker-line (or (car marker-line) 1))
1181 (with-current-buffer (marker-buffer marker)
1182 (let ((screen-columns
1183 ;; Obey the compilation-error-screen-columns of the target
1184 ;; buffer if its major mode set it buffer-locally.
1185 (if (local-variable-p 'compilation-error-screen-columns)
1186 compilation-error-screen-columns screen-columns))
1187 (compilation-first-column
1188 (if (local-variable-p 'compilation-first-column)
1189 compilation-first-column first-column)))
1190 (save-excursion
1191 (save-restriction
1192 (widen)
1193 (goto-char (marker-position marker))
1194 ;; Set end-marker if appropriate and go to line.
1195 (if (not (or end-col end-line))
1196 (compilation-beginning-of-line (- line marker-line -1))
1197 (compilation-beginning-of-line (- (or end-line line)
1198 marker-line -1))
1199 (if (or (null end-col) (< end-col 0))
1200 (end-of-line)
1201 (compilation-move-to-column end-col screen-columns))
1202 (setq end-marker (point-marker))
1203 (when end-line
1204 (compilation-beginning-of-line (- line end-line -1))))
1205 (if col
1206 (compilation-move-to-column col screen-columns)
1207 (forward-to-indentation 0))
1208 (setq marker (point-marker)))))))
1210 (setq loc (compilation-assq line (compilation--file-struct->loc-tree
1211 file-struct)))
1212 (setq end-loc
1213 (if end-line
1214 (compilation-assq
1215 end-col (compilation-assq
1216 end-line (compilation--file-struct->loc-tree
1217 file-struct)))
1218 (if end-col ; use same line element
1219 (compilation-assq end-col loc))))
1220 (setq loc (compilation-assq col loc))
1221 ;; If they are new, make the loc(s) reference the file they point to.
1222 ;; FIXME-omake: there's a problem with timestamps here: the markers
1223 ;; relative to which we computed the current `marker' have a timestamp
1224 ;; almost guaranteed to be different from compilation-buffer-modtime, so if
1225 ;; we use their timestamp, we'll never use `loc' since the timestamp won't
1226 ;; match compilation-buffer-modtime, and if we use
1227 ;; compilation-buffer-modtime then we have different timestamps for
1228 ;; locations that were computed together, which doesn't make sense either.
1229 ;; I think this points to a fundamental problem in our approach to the
1230 ;; "omake -P" problem. --Stef
1231 (or (cdr loc)
1232 (setcdr loc (compilation--make-cdrloc line file-struct marker)))
1233 (if end-loc
1234 (or (cdr end-loc)
1235 (setcdr end-loc
1236 (compilation--make-cdrloc (or end-line line) file-struct
1237 end-marker))))
1239 ;; Must start with face
1240 `(font-lock-face ,compilation-message-face
1241 compilation-message ,(compilation--make-message loc type end-loc)
1242 help-echo ,(if col
1243 "mouse-2: visit this file, line and column"
1244 (if line
1245 "mouse-2: visit this file and line"
1246 "mouse-2: visit this file"))
1247 keymap compilation-button-map
1248 mouse-face highlight)))
1250 (defun compilation--put-prop (matchnum prop val)
1251 (when (and (integerp matchnum) (match-beginning matchnum))
1252 (put-text-property
1253 (match-beginning matchnum) (match-end matchnum)
1254 prop val)))
1256 (defun compilation--remove-properties (&optional start end)
1257 (with-silent-modifications
1258 ;; When compile.el used font-lock directly, we could just remove all
1259 ;; our text-properties in one go, but now that we manually place
1260 ;; font-lock-face, we have to be careful to only remove the font-lock-face
1261 ;; we placed.
1262 ;; (remove-list-of-text-properties
1263 ;; (or start (point-min)) (or end (point-max))
1264 ;; '(compilation-debug compilation-directory compilation-message
1265 ;; font-lock-face help-echo mouse-face))
1266 (let (next)
1267 (unless start (setq start (point-min)))
1268 (unless end (setq end (point-max)))
1269 (compilation--flush-directory-cache start end)
1270 (while
1271 (progn
1272 (setq next (or (next-single-property-change
1273 start 'compilation-message nil end)
1274 end))
1275 (when (get-text-property start 'compilation-message)
1276 (remove-list-of-text-properties
1277 start next
1278 '(compilation-debug compilation-directory compilation-message
1279 font-lock-face help-echo mouse-face)))
1280 (< next end))
1281 (setq start next)))))
1283 (defun compilation--parse-region (start end)
1284 (goto-char end)
1285 (unless (bolp)
1286 ;; We generally don't like to parse partial lines.
1287 (cl-assert (eobp))
1288 (when (let ((proc (get-buffer-process (current-buffer))))
1289 (and proc (memq (process-status proc) '(run open))))
1290 (setq end (line-beginning-position))))
1291 (compilation--remove-properties start end)
1292 (if compilation-parse-errors-function
1293 ;; An old package! Try the compatibility code.
1294 (progn
1295 (goto-char start)
1296 (compilation--compat-parse-errors end))
1298 ;; compilation-directory-matcher is the only part that really needs to be
1299 ;; parsed sequentially. So we could split it out, handle directories
1300 ;; like syntax-propertize, and the rest as font-lock-keywords. But since
1301 ;; we want to have it work even when font-lock is off, we'd then need to
1302 ;; use our own compilation-parsed text-property to keep track of the parts
1303 ;; that have already been parsed.
1304 (goto-char start)
1305 (while (re-search-forward (car compilation-directory-matcher)
1306 end t)
1307 (compilation--flush-directory-cache (match-beginning 0) (match-end 0))
1308 (when compilation-debug
1309 (font-lock-append-text-property
1310 (match-beginning 0) (match-end 0)
1311 'compilation-debug
1312 (vector 'directory compilation-directory-matcher)))
1313 (dolist (elt (cdr compilation-directory-matcher))
1314 (add-text-properties (match-beginning (car elt))
1315 (match-end (car elt))
1316 (compilation-directory-properties
1317 (car elt) (cdr elt)))))
1319 (compilation-parse-errors start end)))
1321 (defun compilation-parse-errors (start end &rest rules)
1322 "Parse errors between START and END.
1323 The errors recognized are the ones specified in RULES which default
1324 to `compilation-error-regexp-alist' if RULES is nil."
1325 (dolist (item (or rules compilation-error-regexp-alist))
1326 (if (symbolp item)
1327 (setq item (cdr (assq item
1328 compilation-error-regexp-alist-alist))))
1329 (let ((file (nth 1 item))
1330 (line (nth 2 item))
1331 (col (nth 3 item))
1332 (type (nth 4 item))
1333 (pat (car item))
1334 end-line end-col fmt
1335 props)
1337 ;; omake reports some error indented, so skip the indentation.
1338 ;; another solution is to modify (some?) regexps in
1339 ;; `compilation-error-regexp-alist'.
1340 ;; note that omake usage is not limited to ocaml and C (for stubs).
1341 ;; FIXME-omake: Doing it here seems wrong, at least it should depend on
1342 ;; whether or not omake's own error messages are recognized.
1343 (cond
1344 ((not (memq 'omake compilation-error-regexp-alist)) nil)
1345 ((string-match "\\`\\([^^]\\|\\^\\( \\*\\|\\[\\)\\)" pat)
1346 nil) ;; Not anchored or anchored but already allows empty spaces.
1347 (t (setq pat (concat "^ *" (substring pat 1)))))
1349 (if (consp file) (setq fmt (cdr file) file (car file)))
1350 (if (consp line) (setq end-line (cdr line) line (car line)))
1351 (if (consp col) (setq end-col (cdr col) col (car col)))
1353 (if (functionp line)
1354 ;; The old compile.el had here an undocumented hook that
1355 ;; allowed `line' to be a function that computed the actual
1356 ;; error location. Let's do our best.
1357 (progn
1358 (goto-char start)
1359 (while (re-search-forward pat end t)
1360 (save-match-data
1361 (when compilation-debug
1362 (font-lock-append-text-property
1363 (match-beginning 0) (match-end 0)
1364 'compilation-debug (vector 'functionp item)))
1365 (add-text-properties
1366 (match-beginning 0) (match-end 0)
1367 (compilation--compat-error-properties
1368 (funcall line (cons (match-string file)
1369 (cons default-directory
1370 (nthcdr 4 item)))
1371 (if col (match-string col))))))
1372 (compilation--put-prop
1373 file 'font-lock-face compilation-error-face)))
1375 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
1376 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
1378 (goto-char start)
1379 (while (re-search-forward pat end t)
1380 (when (setq props (compilation-error-properties
1381 file line end-line col end-col (or type 2) fmt))
1383 (when (integerp file)
1384 (compilation--put-prop
1385 file 'font-lock-face
1386 (if (consp type)
1387 (compilation-face type)
1388 (symbol-value (aref [compilation-info-face
1389 compilation-warning-face
1390 compilation-error-face]
1391 (or type 2))))))
1393 (compilation--put-prop
1394 line 'font-lock-face compilation-line-face)
1395 (compilation--put-prop
1396 end-line 'font-lock-face compilation-line-face)
1398 (compilation--put-prop
1399 col 'font-lock-face compilation-column-face)
1400 (compilation--put-prop
1401 end-col 'font-lock-face compilation-column-face)
1403 ;; Obey HIGHLIGHT.
1404 (dolist (extra-item (nthcdr 6 item))
1405 (let ((mn (pop extra-item)))
1406 (when (match-beginning mn)
1407 (let ((face (eval (car extra-item))))
1408 (cond
1409 ((null face))
1410 ((or (symbolp face) (stringp face))
1411 (put-text-property
1412 (match-beginning mn) (match-end mn)
1413 'font-lock-face face))
1414 ((and (listp face)
1415 (eq (car face) 'face)
1416 (or (symbolp (cadr face))
1417 (stringp (cadr face))))
1418 (compilation--put-prop mn 'font-lock-face (cadr face))
1419 (add-text-properties
1420 (match-beginning mn) (match-end mn)
1421 (nthcdr 2 face)))
1423 (error "Don't know how to handle face %S"
1424 face)))))))
1425 (let ((mn (or (nth 5 item) 0)))
1426 (when compilation-debug
1427 (font-lock-append-text-property
1428 (match-beginning 0) (match-end 0)
1429 'compilation-debug (vector 'std item props)))
1430 (add-text-properties
1431 (match-beginning mn) (match-end mn)
1432 (cddr props))
1433 (font-lock-append-text-property
1434 (match-beginning mn) (match-end mn)
1435 'font-lock-face (cadr props)))))))))
1437 (defvar compilation--parsed -1)
1438 (make-variable-buffer-local 'compilation--parsed)
1440 (defun compilation--ensure-parse (limit)
1441 "Make sure the text has been parsed up to LIMIT."
1442 (save-excursion
1443 (goto-char limit)
1444 (setq limit (line-beginning-position 2))
1445 (unless (markerp compilation--parsed)
1446 ;; We use a marker for compilation--parsed so that users (such as
1447 ;; grep.el) don't need to flush-parse when they modify the buffer
1448 ;; in a way that impacts buffer positions but does not require
1449 ;; re-parsing.
1450 (setq compilation--parsed (point-min-marker)))
1451 (when (< compilation--parsed limit)
1452 (let ((start (max compilation--parsed (point-min))))
1453 (move-marker compilation--parsed limit)
1454 (goto-char start)
1455 (forward-line 0) ;Not line-beginning-position: ignore (comint) fields.
1456 (while (and (not (bobp))
1457 (get-text-property (1- (point)) 'compilation-multiline))
1458 (forward-line -1))
1459 (with-silent-modifications
1460 (compilation--parse-region (point) compilation--parsed)))))
1461 nil)
1463 (defun compilation--flush-parse (start _end)
1464 "Mark the region between START and END for re-parsing."
1465 (if (markerp compilation--parsed)
1466 (move-marker compilation--parsed (min start compilation--parsed))))
1468 (defun compilation-mode-font-lock-keywords ()
1469 "Return expressions to highlight in Compilation mode."
1470 (append
1471 '((compilation--ensure-parse))
1472 compilation-mode-font-lock-keywords))
1474 (defun compilation-read-command (command)
1475 (read-shell-command "Compile command: " command
1476 (if (equal (car compile-history) command)
1477 '(compile-history . 1)
1478 'compile-history)))
1481 ;;;###autoload
1482 (defun compile (command &optional comint)
1483 "Compile the program including the current buffer. Default: run `make'.
1484 Runs COMMAND, a shell command, in a separate process asynchronously
1485 with output going to the buffer `*compilation*'.
1487 You can then use the command \\[next-error] to find the next error message
1488 and move to the source code that caused it.
1490 If optional second arg COMINT is t the buffer will be in Comint mode with
1491 `compilation-shell-minor-mode'.
1493 Interactively, prompts for the command if the variable
1494 `compilation-read-command' is non-nil; otherwise uses `compile-command'.
1495 With prefix arg, always prompts.
1496 Additionally, with universal prefix arg, compilation buffer will be in
1497 comint mode, i.e. interactive.
1499 To run more than one compilation at once, start one then rename
1500 the `*compilation*' buffer to some other name with
1501 \\[rename-buffer]. Then _switch buffers_ and start the new compilation.
1502 It will create a new `*compilation*' buffer.
1504 On most systems, termination of the main compilation process
1505 kills its subprocesses.
1507 The name used for the buffer is actually whatever is returned by
1508 the function in `compilation-buffer-name-function', so you can set that
1509 to a function that generates a unique name."
1510 (interactive
1511 (list
1512 (let ((command (eval compile-command)))
1513 (if (or compilation-read-command current-prefix-arg)
1514 (compilation-read-command command)
1515 command))
1516 (consp current-prefix-arg)))
1517 (unless (equal command (eval compile-command))
1518 (setq compile-command command))
1519 (save-some-buffers (not compilation-ask-about-save)
1520 compilation-save-buffers-predicate)
1521 (setq-default compilation-directory default-directory)
1522 (compilation-start command comint))
1524 ;; run compile with the default command line
1525 (defun recompile (&optional edit-command)
1526 "Re-compile the program including the current buffer.
1527 If this is run in a Compilation mode buffer, re-use the arguments from the
1528 original use. Otherwise, recompile using `compile-command'.
1529 If the optional argument `edit-command' is non-nil, the command can be edited."
1530 (interactive "P")
1531 (save-some-buffers (not compilation-ask-about-save)
1532 compilation-save-buffers-predicate)
1533 (let ((default-directory (or compilation-directory default-directory))
1534 (command (eval compile-command)))
1535 (when edit-command
1536 (setq command (compilation-read-command (or (car compilation-arguments)
1537 command)))
1538 (if compilation-arguments (setcar compilation-arguments command)))
1539 (apply 'compilation-start (or compilation-arguments (list command)))))
1541 (defcustom compilation-scroll-output nil
1542 "Non-nil to scroll the *compilation* buffer window as output appears.
1544 Setting it causes the Compilation mode commands to put point at the
1545 end of their output window so that the end of the output is always
1546 visible rather than the beginning.
1548 The value `first-error' stops scrolling at the first error, and leaves
1549 point on its location in the *compilation* buffer."
1550 :type '(choice (const :tag "No scrolling" nil)
1551 (const :tag "Scroll compilation output" t)
1552 (const :tag "Stop scrolling at the first error" first-error))
1553 :version "20.3"
1554 :group 'compilation)
1557 (defun compilation-buffer-name (name-of-mode mode-command name-function)
1558 "Return the name of a compilation buffer to use.
1559 If NAME-FUNCTION is non-nil, call it with one argument NAME-OF-MODE
1560 to determine the buffer name.
1561 Likewise if `compilation-buffer-name-function' is non-nil.
1562 If current buffer has the major mode MODE-COMMAND,
1563 return the name of the current buffer, so that it gets reused.
1564 Otherwise, construct a buffer name from NAME-OF-MODE."
1565 (cond (name-function
1566 (funcall name-function name-of-mode))
1567 (compilation-buffer-name-function
1568 (funcall compilation-buffer-name-function name-of-mode))
1569 ((eq mode-command major-mode)
1570 (buffer-name))
1572 (concat "*" (downcase name-of-mode) "*"))))
1574 (defcustom compilation-always-kill nil
1575 "If t, always kill a running compilation process before starting a new one.
1576 If nil, ask to kill it."
1577 :type 'boolean
1578 :version "24.3"
1579 :group 'compilation)
1581 ;;;###autoload
1582 (defun compilation-start (command &optional mode name-function highlight-regexp)
1583 "Run compilation command COMMAND (low level interface).
1584 If COMMAND starts with a cd command, that becomes the `default-directory'.
1585 The rest of the arguments are optional; for them, nil means use the default.
1587 MODE is the major mode to set in the compilation buffer. Mode
1588 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
1590 If NAME-FUNCTION is non-nil, call it with one argument (the mode name)
1591 to determine the buffer name. Otherwise, the default is to
1592 reuses the current buffer if it has the proper major mode,
1593 else use or create a buffer with name based on the major mode.
1595 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
1596 the matching section of the visited source line; the default is to use the
1597 global value of `compilation-highlight-regexp'.
1599 Returns the compilation buffer created."
1600 (or mode (setq mode 'compilation-mode))
1601 (let* ((name-of-mode
1602 (if (eq mode t)
1603 "compilation"
1604 (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1605 (thisdir default-directory)
1606 (thisenv compilation-environment)
1607 outwin outbuf)
1608 (with-current-buffer
1609 (setq outbuf
1610 (get-buffer-create
1611 (compilation-buffer-name name-of-mode mode name-function)))
1612 (let ((comp-proc (get-buffer-process (current-buffer))))
1613 (if comp-proc
1614 (if (or (not (eq (process-status comp-proc) 'run))
1615 (eq (process-query-on-exit-flag comp-proc) nil)
1616 (yes-or-no-p
1617 (format "A %s process is running; kill it? "
1618 name-of-mode)))
1619 (condition-case ()
1620 (progn
1621 (interrupt-process comp-proc)
1622 (sit-for 1)
1623 (delete-process comp-proc))
1624 (error nil))
1625 (error "Cannot have two processes in `%s' at once"
1626 (buffer-name)))))
1627 ;; first transfer directory from where M-x compile was called
1628 (setq default-directory thisdir)
1629 ;; Make compilation buffer read-only. The filter can still write it.
1630 ;; Clear out the compilation buffer.
1631 (let ((inhibit-read-only t)
1632 (default-directory thisdir))
1633 ;; Then evaluate a cd command if any, but don't perform it yet, else
1634 ;; start-command would do it again through the shell: (cd "..") AND
1635 ;; sh -c "cd ..; make"
1636 (cd (cond
1637 ((not (string-match "\\`\\s *cd\\(?:\\s +\\(\\S +?\\|'[^']*'\\|\"\\(?:[^\"`$\\]\\|\\\\.\\)*\"\\)\\)?\\s *[;&\n]"
1638 command))
1639 default-directory)
1640 ((not (match-end 1)) "~")
1641 ((eq (aref command (match-beginning 1)) ?\')
1642 (substring command (1+ (match-beginning 1))
1643 (1- (match-end 1))))
1644 ((eq (aref command (match-beginning 1)) ?\")
1645 (replace-regexp-in-string
1646 "\\\\\\(.\\)" "\\1"
1647 (substring command (1+ (match-beginning 1))
1648 (1- (match-end 1)))))
1649 ;; Try globbing as well (bug#15417).
1650 (t (let* ((substituted-dir
1651 (substitute-env-vars (match-string 1 command)))
1652 ;; FIXME: This also tries to expand `*' that were
1653 ;; introduced by the envvar expansion!
1654 (expanded-dir
1655 (file-expand-wildcards substituted-dir)))
1656 (if (= (length expanded-dir) 1)
1657 (car expanded-dir)
1658 substituted-dir)))))
1659 (erase-buffer)
1660 ;; Select the desired mode.
1661 (if (not (eq mode t))
1662 (progn
1663 (buffer-disable-undo)
1664 (funcall mode))
1665 (setq buffer-read-only nil)
1666 (with-no-warnings (comint-mode))
1667 (compilation-shell-minor-mode))
1668 ;; Remember the original dir, so we can use it when we recompile.
1669 ;; default-directory' can't be used reliably for that because it may be
1670 ;; affected by the special handling of "cd ...;".
1671 ;; NB: must be done after (funcall mode) as that resets local variables
1672 (set (make-local-variable 'compilation-directory) thisdir)
1673 (set (make-local-variable 'compilation-environment) thisenv)
1674 (if highlight-regexp
1675 (set (make-local-variable 'compilation-highlight-regexp)
1676 highlight-regexp))
1677 (if (or compilation-auto-jump-to-first-error
1678 (eq compilation-scroll-output 'first-error))
1679 (set (make-local-variable 'compilation-auto-jump-to-next) t))
1680 ;; Output a mode setter, for saving and later reloading this buffer.
1681 (insert "-*- mode: " name-of-mode
1682 "; default-directory: "
1683 (prin1-to-string (abbreviate-file-name default-directory))
1684 " -*-\n"
1685 (format "%s started at %s\n\n"
1686 mode-name
1687 (substring (current-time-string) 0 19))
1688 command "\n")
1689 (setq thisdir default-directory))
1690 (set-buffer-modified-p nil))
1691 ;; Pop up the compilation buffer.
1692 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01638.html
1693 (setq outwin (display-buffer outbuf '(nil (allow-no-window . t))))
1694 (with-current-buffer outbuf
1695 (let ((process-environment
1696 (append
1697 compilation-environment
1698 (if (if (boundp 'system-uses-terminfo);`If' for compiler warning.
1699 system-uses-terminfo)
1700 (list "TERM=dumb" "TERMCAP="
1701 (format "COLUMNS=%d" (window-width)))
1702 (list "TERM=emacs"
1703 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1704 (window-width))))
1706 ;; Set the EMACS variable, but
1707 ;; don't override users' setting of $EMACS.
1708 ;; Remove this hack once Bash 4.4-or-later is common,
1709 ;; since it can break 'configure'.
1710 (unless (getenv "EMACS")
1711 (list "EMACS=t"))
1713 (list (format "INSIDE_EMACS=%s,compile" emacs-version))
1714 (copy-sequence process-environment))))
1715 (set (make-local-variable 'compilation-arguments)
1716 (list command mode name-function highlight-regexp))
1717 (set (make-local-variable 'revert-buffer-function)
1718 'compilation-revert-buffer)
1719 (and outwin
1720 ;; Forcing the window-start overrides the usual redisplay
1721 ;; feature of bringing point into view, so setting the
1722 ;; window-start to top of the buffer risks losing the
1723 ;; effect of moving point to EOB below, per
1724 ;; compilation-scroll-output, if the command is long
1725 ;; enough to push point outside of the window. This
1726 ;; could happen, e.g., in `rgrep'.
1727 (not compilation-scroll-output)
1728 (set-window-start outwin (point-min)))
1730 ;; Position point as the user will see it.
1731 (let ((desired-visible-point
1732 ;; Put it at the end if `compilation-scroll-output' is set.
1733 (if compilation-scroll-output
1734 (point-max)
1735 ;; Normally put it at the top.
1736 (point-min))))
1737 (goto-char desired-visible-point)
1738 (when (and outwin (not (eq outwin (selected-window))))
1739 (set-window-point outwin desired-visible-point)))
1741 ;; The setup function is called before compilation-set-window-height
1742 ;; so it can set the compilation-window-height buffer locally.
1743 (if compilation-process-setup-function
1744 (funcall compilation-process-setup-function))
1745 (and outwin (compilation-set-window-height outwin))
1746 ;; Start the compilation.
1747 (if (fboundp 'start-process)
1748 (let ((proc
1749 (if (eq mode t)
1750 ;; comint uses `start-file-process'.
1751 (get-buffer-process
1752 (with-no-warnings
1753 (comint-exec
1754 outbuf (downcase mode-name)
1755 (if (file-remote-p default-directory)
1756 "/bin/sh"
1757 shell-file-name)
1758 nil `("-c" ,command))))
1759 (start-file-process-shell-command (downcase mode-name)
1760 outbuf command))))
1761 ;; Make the buffer's mode line show process state.
1762 (setq mode-line-process
1763 '(:propertize ":%s" face compilation-mode-line-run))
1765 ;; Set the process as killable without query by default.
1766 ;; This allows us to start a new compilation without
1767 ;; getting prompted.
1768 (when compilation-always-kill
1769 (set-process-query-on-exit-flag proc nil))
1771 (set-process-sentinel proc 'compilation-sentinel)
1772 (unless (eq mode t)
1773 ;; Keep the comint filter, since it's needed for proper
1774 ;; handling of the prompts.
1775 (set-process-filter proc 'compilation-filter))
1776 ;; Use (point-max) here so that output comes in
1777 ;; after the initial text,
1778 ;; regardless of where the user sees point.
1779 (set-marker (process-mark proc) (point-max) outbuf)
1780 (when compilation-disable-input
1781 (condition-case nil
1782 (process-send-eof proc)
1783 ;; The process may have exited already.
1784 (error nil)))
1785 (run-hook-with-args 'compilation-start-hook proc)
1786 (setq compilation-in-progress
1787 (cons proc compilation-in-progress)))
1788 ;; No asynchronous processes available.
1789 (message "Executing `%s'..." command)
1790 ;; Fake mode line display as if `start-process' were run.
1791 (setq mode-line-process
1792 '(:propertize ":run" face compilation-mode-line-run))
1793 (force-mode-line-update)
1794 (sit-for 0) ; Force redisplay
1795 (save-excursion
1796 ;; Insert the output at the end, after the initial text,
1797 ;; regardless of where the user sees point.
1798 (goto-char (point-max))
1799 (let* ((inhibit-read-only t) ; call-process needs to modify outbuf
1800 (compilation-filter-start (point))
1801 (status (call-process shell-file-name nil outbuf nil "-c"
1802 command)))
1803 (run-hooks 'compilation-filter-hook)
1804 (cond ((numberp status)
1805 (compilation-handle-exit
1806 'exit status
1807 (if (zerop status)
1808 "finished\n"
1809 (format "exited abnormally with code %d\n" status))))
1810 ((stringp status)
1811 (compilation-handle-exit 'signal status
1812 (concat status "\n")))
1814 (compilation-handle-exit 'bizarre status status)))))
1815 (set-buffer-modified-p nil)
1816 (message "Executing `%s'...done" command)))
1817 ;; Now finally cd to where the shell started make/grep/...
1818 (setq default-directory thisdir)
1819 ;; The following form selected outwin ever since revision 1.183,
1820 ;; so possibly messing up point in some other window (bug#1073).
1821 ;; Moved into the scope of with-current-buffer, though still with
1822 ;; complete disregard for the case when compilation-scroll-output
1823 ;; equals 'first-error (martin 2008-10-04).
1824 (when compilation-scroll-output
1825 (goto-char (point-max))))
1827 ;; Make it so the next C-x ` will use this buffer.
1828 (setq next-error-last-buffer outbuf)))
1830 (defun compilation-set-window-height (window)
1831 "Set the height of WINDOW according to `compilation-window-height'."
1832 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1833 (and height
1834 (window-full-width-p window)
1835 ;; If window is alone in its frame, aside from a minibuffer,
1836 ;; don't change its height.
1837 (not (eq window (frame-root-window (window-frame window))))
1838 ;; Stef said that doing the saves in this order is safer:
1839 (save-excursion
1840 (save-selected-window
1841 (select-window window)
1842 (enlarge-window (- height (window-height))))))))
1844 (defvar compilation-menu-map
1845 (let ((map (make-sparse-keymap "Errors"))
1846 (opt-map (make-sparse-keymap "Skip")))
1847 (define-key map [stop-subjob]
1848 '(menu-item "Stop Compilation" kill-compilation
1849 :help "Kill the process made by the M-x compile or M-x grep commands"))
1850 (define-key map [compilation-mode-separator3]
1851 '("----" . nil))
1852 (define-key map [compilation-next-error-follow-minor-mode]
1853 '(menu-item
1854 "Auto Error Display" next-error-follow-minor-mode
1855 :help "Display the error under cursor when moving the cursor"
1856 :button (:toggle . next-error-follow-minor-mode)))
1857 (define-key map [compilation-skip]
1858 (cons "Skip Less Important Messages" opt-map))
1859 (define-key opt-map [compilation-skip-none]
1860 '(menu-item "Don't Skip Any Messages"
1861 (lambda ()
1862 (interactive)
1863 (customize-set-variable 'compilation-skip-threshold 0))
1864 :help "Do not skip any type of messages"
1865 :button (:radio . (eq compilation-skip-threshold 0))))
1866 (define-key opt-map [compilation-skip-info]
1867 '(menu-item "Skip Info"
1868 (lambda ()
1869 (interactive)
1870 (customize-set-variable 'compilation-skip-threshold 1))
1871 :help "Skip anything less than warning"
1872 :button (:radio . (eq compilation-skip-threshold 1))))
1873 (define-key opt-map [compilation-skip-warning-and-info]
1874 '(menu-item "Skip Warnings and Info"
1875 (lambda ()
1876 (interactive)
1877 (customize-set-variable 'compilation-skip-threshold 2))
1878 :help "Skip over Warnings and Info, stop for errors"
1879 :button (:radio . (eq compilation-skip-threshold 2))))
1880 (define-key map [compilation-mode-separator2]
1881 '("----" . nil))
1882 (define-key map [compilation-first-error]
1883 '(menu-item "First Error" first-error
1884 :help "Restart at the first error, visit corresponding source code"))
1885 (define-key map [compilation-previous-error]
1886 '(menu-item "Previous Error" previous-error
1887 :help "Visit previous `next-error' message and corresponding source code"))
1888 (define-key map [compilation-next-error]
1889 '(menu-item "Next Error" next-error
1890 :help "Visit next `next-error' message and corresponding source code"))
1891 map))
1893 (defvar compilation-minor-mode-map
1894 (let ((map (make-sparse-keymap)))
1895 (set-keymap-parent map special-mode-map)
1896 (define-key map [mouse-2] 'compile-goto-error)
1897 (define-key map [follow-link] 'mouse-face)
1898 (define-key map "\C-c\C-c" 'compile-goto-error)
1899 (define-key map "\C-m" 'compile-goto-error)
1900 (define-key map "\C-o" 'compilation-display-error)
1901 (define-key map "\C-c\C-k" 'kill-compilation)
1902 (define-key map "\M-n" 'compilation-next-error)
1903 (define-key map "\M-p" 'compilation-previous-error)
1904 (define-key map "\M-{" 'compilation-previous-file)
1905 (define-key map "\M-}" 'compilation-next-file)
1906 (define-key map "g" 'recompile) ; revert
1907 ;; Set up the menu-bar
1908 (define-key map [menu-bar compilation]
1909 (cons "Errors" compilation-menu-map))
1910 map)
1911 "Keymap for `compilation-minor-mode'.")
1913 (defvar compilation-shell-minor-mode-map
1914 (let ((map (make-sparse-keymap)))
1915 (define-key map "\M-\C-m" 'compile-goto-error)
1916 (define-key map "\M-\C-n" 'compilation-next-error)
1917 (define-key map "\M-\C-p" 'compilation-previous-error)
1918 (define-key map "\M-{" 'compilation-previous-file)
1919 (define-key map "\M-}" 'compilation-next-file)
1920 ;; Set up the menu-bar
1921 (define-key map [menu-bar compilation]
1922 (cons "Errors" compilation-menu-map))
1923 map)
1924 "Keymap for `compilation-shell-minor-mode'.")
1926 (defvar compilation-button-map
1927 (let ((map (make-sparse-keymap)))
1928 (define-key map [mouse-2] 'compile-goto-error)
1929 (define-key map [follow-link] 'mouse-face)
1930 (define-key map "\C-m" 'compile-goto-error)
1931 map)
1932 "Keymap for compilation-message buttons.")
1933 (fset 'compilation-button-map compilation-button-map)
1935 (defvar compilation-mode-map
1936 (let ((map (make-sparse-keymap)))
1937 ;; Don't inherit from compilation-minor-mode-map,
1938 ;; because that introduces a menu bar item we don't want.
1939 ;; That confuses C-down-mouse-3.
1940 (set-keymap-parent map special-mode-map)
1941 (define-key map [mouse-2] 'compile-goto-error)
1942 (define-key map [follow-link] 'mouse-face)
1943 (define-key map "\C-c\C-c" 'compile-goto-error)
1944 (define-key map "\C-m" 'compile-goto-error)
1945 (define-key map "\C-o" 'compilation-display-error)
1946 (define-key map "\C-c\C-k" 'kill-compilation)
1947 (define-key map "\M-n" 'compilation-next-error)
1948 (define-key map "\M-p" 'compilation-previous-error)
1949 (define-key map "\M-{" 'compilation-previous-file)
1950 (define-key map "\M-}" 'compilation-next-file)
1951 (define-key map "\t" 'compilation-next-error)
1952 (define-key map [backtab] 'compilation-previous-error)
1953 (define-key map "g" 'recompile) ; revert
1955 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1957 ;; Set up the menu-bar
1958 (let ((submap (make-sparse-keymap "Compile")))
1959 (define-key map [menu-bar compilation]
1960 (cons "Compile" submap))
1961 (set-keymap-parent submap compilation-menu-map))
1962 (define-key map [menu-bar compilation compilation-separator2]
1963 '("----" . nil))
1964 (define-key map [menu-bar compilation compilation-grep]
1965 '(menu-item "Search Files (grep)..." grep
1966 :help "Run grep, with user-specified args, and collect output in a buffer"))
1967 (define-key map [menu-bar compilation compilation-recompile]
1968 '(menu-item "Recompile" recompile
1969 :help "Re-compile the program including the current buffer"))
1970 (define-key map [menu-bar compilation compilation-compile]
1971 '(menu-item "Compile..." compile
1972 :help "Compile the program including the current buffer. Default: run `make'"))
1973 map)
1974 "Keymap for compilation log buffers.
1975 `compilation-minor-mode-map' is a parent of this.")
1977 (defvar compilation-mode-tool-bar-map
1978 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
1979 ;; so don't do anything.
1980 (when (keymapp tool-bar-map)
1981 (let ((map (copy-keymap tool-bar-map)))
1982 (define-key map [undo] nil)
1983 (define-key map [separator-2] nil)
1984 (define-key-after map [separator-compile] menu-bar-separator)
1985 (tool-bar-local-item
1986 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
1987 :rtl "right-arrow"
1988 :help "Goto previous error")
1989 (tool-bar-local-item
1990 "right-arrow" 'next-error-no-select 'next-error-no-select map
1991 :rtl "left-arrow"
1992 :help "Goto next error")
1993 (tool-bar-local-item
1994 "cancel" 'kill-compilation 'kill-compilation map
1995 :enable '(let ((buffer (compilation-find-buffer)))
1996 (get-buffer-process buffer))
1997 :help "Stop compilation")
1998 (tool-bar-local-item
1999 "refresh" 'recompile 'recompile map
2000 :help "Restart compilation")
2001 map)))
2003 (put 'compilation-mode 'mode-class 'special)
2005 ;;;###autoload
2006 (defun compilation-mode (&optional name-of-mode)
2007 "Major mode for compilation log buffers.
2008 \\<compilation-mode-map>To visit the source for a line-numbered error,
2009 move point to the error message line and type \\[compile-goto-error].
2010 To kill the compilation, type \\[kill-compilation].
2012 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
2014 \\{compilation-mode-map}"
2015 (interactive)
2016 (kill-all-local-variables)
2017 (use-local-map compilation-mode-map)
2018 ;; Let windows scroll along with the output.
2019 (set (make-local-variable 'window-point-insertion-type) t)
2020 (set (make-local-variable 'tool-bar-map) compilation-mode-tool-bar-map)
2021 (setq major-mode 'compilation-mode ; FIXME: Use define-derived-mode.
2022 mode-name (or name-of-mode "Compilation"))
2023 (set (make-local-variable 'page-delimiter)
2024 compilation-page-delimiter)
2025 ;; (set (make-local-variable 'compilation-buffer-modtime) nil)
2026 (compilation-setup)
2027 ;; Turn off deferred fontifications in the compilation buffer, if
2028 ;; the user turned them on globally. This is because idle timers
2029 ;; aren't re-run after receiving input from a subprocess, so the
2030 ;; buffer is left unfontified after the compilation exits, until
2031 ;; some other input event happens.
2032 (set (make-local-variable 'jit-lock-defer-time) nil)
2033 (setq buffer-read-only t)
2034 (run-mode-hooks 'compilation-mode-hook))
2036 ;;;###autoload
2037 (put 'define-compilation-mode 'doc-string-elt 3)
2039 (defmacro define-compilation-mode (mode name doc &rest body)
2040 "This is like `define-derived-mode' without the PARENT argument.
2041 The parent is always `compilation-mode' and the customizable `compilation-...'
2042 variables are also set from the name of the mode you have chosen,
2043 by replacing the first word, e.g., `compilation-scroll-output' from
2044 `grep-scroll-output' if that variable exists."
2045 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
2046 `(define-derived-mode ,mode compilation-mode ,name
2047 ,doc
2048 ,@(mapcar (lambda (v)
2049 (setq v (cons v
2050 (intern-soft (replace-regexp-in-string
2051 "^compilation" mode-name
2052 (symbol-name v)))))
2053 (and (cdr v)
2054 (or (boundp (cdr v))
2055 ;; FIXME: This is hackish, using undocumented info.
2056 (if (boundp 'byte-compile-bound-variables)
2057 (memq (cdr v) byte-compile-bound-variables)))
2058 `(set (make-local-variable ',(car v)) ,(cdr v))))
2059 '(compilation-buffer-name-function
2060 compilation-directory-matcher
2061 compilation-error
2062 compilation-error-regexp-alist
2063 compilation-error-regexp-alist-alist
2064 compilation-error-screen-columns
2065 compilation-finish-function
2066 compilation-finish-functions
2067 compilation-first-column
2068 compilation-mode-font-lock-keywords
2069 compilation-page-delimiter
2070 compilation-parse-errors-filename-function
2071 compilation-process-setup-function
2072 compilation-scroll-output
2073 compilation-search-path
2074 compilation-skip-threshold
2075 compilation-window-height))
2076 ,@body)))
2078 (defun compilation-revert-buffer (ignore-auto noconfirm)
2079 (if buffer-file-name
2080 (let (revert-buffer-function)
2081 (revert-buffer ignore-auto noconfirm))
2082 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
2083 (apply 'compilation-start compilation-arguments))))
2085 (defvar compilation-current-error nil
2086 "Marker to the location from where the next error will be found.
2087 The global commands next/previous/first-error/goto-error use this.")
2089 (defvar compilation-messages-start nil
2090 "Buffer position of the beginning of the compilation messages.
2091 If nil, use the beginning of buffer.")
2093 (defun compilation-setup (&optional minor)
2094 "Prepare the buffer for the compilation parsing commands to work.
2095 Optional argument MINOR indicates this is called from
2096 `compilation-minor-mode'."
2097 (make-local-variable 'compilation-current-error)
2098 (make-local-variable 'compilation-messages-start)
2099 (make-local-variable 'compilation-error-screen-columns)
2100 (make-local-variable 'overlay-arrow-position)
2101 (set (make-local-variable 'overlay-arrow-string) "")
2102 (setq next-error-overlay-arrow-position nil)
2103 (add-hook 'kill-buffer-hook
2104 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
2105 ;; Note that compilation-next-error-function is for interfacing
2106 ;; with the next-error function in simple.el, and it's only
2107 ;; coincidentally named similarly to compilation-next-error.
2108 (setq next-error-function 'compilation-next-error-function)
2109 (set (make-local-variable 'comint-file-name-prefix)
2110 (or (file-remote-p default-directory) ""))
2111 (set (make-local-variable 'compilation-locs)
2112 (make-hash-table :test 'equal :weakness 'value))
2113 ;; It's generally preferable to use after-change-functions since they
2114 ;; can be subject to combine-after-change-calls, but if we do that, we risk
2115 ;; running our hook after font-lock, resulting in incorrect refontification.
2116 (add-hook 'before-change-functions 'compilation--flush-parse nil t)
2117 ;; Also for minor mode, since it's not permanent-local.
2118 (add-hook 'change-major-mode-hook #'compilation--remove-properties nil t)
2119 (if minor
2120 (progn
2121 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
2122 (font-lock-flush))
2123 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))))
2125 (defun compilation--unsetup ()
2126 ;; Only for minor mode.
2127 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
2128 (remove-hook 'before-change-functions 'compilation--flush-parse t)
2129 (kill-local-variable 'compilation--parsed)
2130 (compilation--remove-properties)
2131 (font-lock-flush))
2133 ;;;###autoload
2134 (define-minor-mode compilation-shell-minor-mode
2135 "Toggle Compilation Shell minor mode.
2136 With a prefix argument ARG, enable Compilation Shell minor mode
2137 if ARG is positive, and disable it otherwise. If called from
2138 Lisp, enable the mode if ARG is omitted or nil.
2140 When Compilation Shell minor mode is enabled, all the
2141 error-parsing commands of the Compilation major mode are
2142 available but bound to keys that don't collide with Shell mode.
2143 See `compilation-mode'."
2144 nil " Shell-Compile"
2145 :group 'compilation
2146 (if compilation-shell-minor-mode
2147 (compilation-setup t)
2148 (compilation--unsetup)))
2150 ;;;###autoload
2151 (define-minor-mode compilation-minor-mode
2152 "Toggle Compilation minor mode.
2153 With a prefix argument ARG, enable Compilation minor mode if ARG
2154 is positive, and disable it otherwise. If called from Lisp,
2155 enable the mode if ARG is omitted or nil.
2157 When Compilation minor mode is enabled, all the error-parsing
2158 commands of Compilation major mode are available. See
2159 `compilation-mode'."
2160 nil " Compilation"
2161 :group 'compilation
2162 (if compilation-minor-mode
2163 (compilation-setup t)
2164 (compilation--unsetup)))
2166 (defun compilation-handle-exit (process-status exit-status msg)
2167 "Write MSG in the current buffer and hack its `mode-line-process'."
2168 (let ((inhibit-read-only t)
2169 (status (if compilation-exit-message-function
2170 (funcall compilation-exit-message-function
2171 process-status exit-status msg)
2172 (cons msg exit-status)))
2173 (omax (point-max))
2174 (opoint (point))
2175 (cur-buffer (current-buffer)))
2176 ;; Record where we put the message, so we can ignore it later on.
2177 (goto-char omax)
2178 (insert ?\n mode-name " " (car status))
2179 (if (and (numberp compilation-window-height)
2180 (zerop compilation-window-height))
2181 (message "%s" (cdr status)))
2182 (if (bolp)
2183 (forward-char -1))
2184 (insert " at " (substring (current-time-string) 0 19))
2185 (goto-char (point-max))
2186 ;; Prevent that message from being recognized as a compilation error.
2187 (add-text-properties omax (point)
2188 (append '(compilation-handle-exit t) nil))
2189 (setq mode-line-process
2190 (let ((out-string (format ":%s [%s]" process-status (cdr status)))
2191 (msg (format "%s %s" mode-name
2192 (replace-regexp-in-string "\n?$" ""
2193 (car status)))))
2194 (message "%s" msg)
2195 (propertize out-string
2196 'help-echo msg
2197 'face (if (> exit-status 0)
2198 'compilation-mode-line-fail
2199 'compilation-mode-line-exit))))
2200 ;; Force mode line redisplay soon.
2201 (force-mode-line-update)
2202 (if (and opoint (< opoint omax))
2203 (goto-char opoint))
2204 (with-no-warnings
2205 (if compilation-finish-function
2206 (funcall compilation-finish-function cur-buffer msg)))
2207 (run-hook-with-args 'compilation-finish-functions cur-buffer msg)))
2209 ;; Called when compilation process changes state.
2210 (defun compilation-sentinel (proc msg)
2211 "Sentinel for compilation buffers."
2212 (if (memq (process-status proc) '(exit signal))
2213 (let ((buffer (process-buffer proc)))
2214 (if (null (buffer-name buffer))
2215 ;; buffer killed
2216 (set-process-buffer proc nil)
2217 (with-current-buffer buffer
2218 ;; Write something in the compilation buffer
2219 ;; and hack its mode line.
2220 (compilation-handle-exit (process-status proc)
2221 (process-exit-status proc)
2222 msg)
2223 ;; Since the buffer and mode line will show that the
2224 ;; process is dead, we can delete it now. Otherwise it
2225 ;; will stay around until M-x list-processes.
2226 (delete-process proc)))
2227 (setq compilation-in-progress (delq proc compilation-in-progress)))))
2229 (defun compilation-filter (proc string)
2230 "Process filter for compilation buffers.
2231 Just inserts the text,
2232 handles carriage motion (see `comint-inhibit-carriage-motion'),
2233 and runs `compilation-filter-hook'."
2234 (when (buffer-live-p (process-buffer proc))
2235 (with-current-buffer (process-buffer proc)
2236 (let ((inhibit-read-only t)
2237 ;; `save-excursion' doesn't use the right insertion-type for us.
2238 (pos (copy-marker (point) t))
2239 ;; `save-restriction' doesn't use the right insertion type either:
2240 ;; If we are inserting at the end of the accessible part of the
2241 ;; buffer, keep the inserted text visible.
2242 (min (point-min-marker))
2243 (max (copy-marker (point-max) t))
2244 (compilation-filter-start (marker-position (process-mark proc))))
2245 (unwind-protect
2246 (progn
2247 (widen)
2248 (goto-char compilation-filter-start)
2249 ;; We used to use `insert-before-markers', so that windows with
2250 ;; point at `process-mark' scroll along with the output, but we
2251 ;; now use window-point-insertion-type instead.
2252 (insert string)
2253 (unless comint-inhibit-carriage-motion
2254 (comint-carriage-motion (process-mark proc) (point)))
2255 (set-marker (process-mark proc) (point))
2256 ;; (set (make-local-variable 'compilation-buffer-modtime)
2257 ;; (current-time))
2258 (run-hooks 'compilation-filter-hook))
2259 (goto-char pos)
2260 (narrow-to-region min max)
2261 (set-marker pos nil)
2262 (set-marker min nil)
2263 (set-marker max nil))))))
2265 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
2266 (defsubst compilation-buffer-internal-p ()
2267 "Test if inside a compilation buffer."
2268 (local-variable-p 'compilation-locs))
2270 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
2271 (defsubst compilation-buffer-p (buffer)
2272 "Test if BUFFER is a compilation buffer."
2273 (with-current-buffer buffer
2274 (compilation-buffer-internal-p)))
2276 (defmacro compilation-loop (< property-change 1+ error limit)
2277 `(let (opt)
2278 (while (,< n 0)
2279 (setq opt pt)
2280 (or (setq pt (,property-change pt 'compilation-message))
2281 ;; Handle the case where where the first error message is
2282 ;; at the start of the buffer, and n < 0.
2283 (if (or (eq (get-text-property ,limit 'compilation-message)
2284 (get-text-property opt 'compilation-message))
2285 (eq pt opt))
2286 (user-error ,error compilation-error)
2287 (setq pt ,limit)))
2288 ;; prop 'compilation-message usually has 2 changes, on and off, so
2289 ;; re-search if off
2290 (or (setq msg (get-text-property pt 'compilation-message))
2291 (if (setq pt (,property-change pt 'compilation-message nil ,limit))
2292 (setq msg (get-text-property pt 'compilation-message)))
2293 (user-error ,error compilation-error))
2294 (or (< (compilation--message->type msg) compilation-skip-threshold)
2295 (if different-file
2296 (eq (prog1 last
2297 (setq last (compilation--loc->file-struct
2298 (compilation--message->loc msg))))
2299 last))
2300 (if compilation-skip-visited
2301 (compilation--loc->visited (compilation--message->loc msg)))
2302 (if compilation-skip-to-next-location
2303 (eq (compilation--message->loc msg) loc))
2304 ;; count this message only if none of the above are true
2305 (setq n (,1+ n))))))
2307 (defun compilation-next-single-property-change (position prop
2308 &optional object limit)
2309 (let (parsed res)
2310 (while (progn
2311 ;; We parse the buffer here "on-demand" by chunks of 500 chars.
2312 ;; But we could also just parse the whole buffer.
2313 (compilation--ensure-parse
2314 (setq parsed (max compilation--parsed
2315 (min (+ position 500)
2316 (or limit (point-max))))))
2317 (and (or (not (setq res (next-single-property-change
2318 position prop object limit)))
2319 (eq res limit))
2320 (< position (or limit (point-max)))))
2321 (setq position parsed))
2322 res))
2324 (defun compilation-next-error (n &optional different-file pt)
2325 "Move point to the next error in the compilation buffer.
2326 This function does NOT find the source line like \\[next-error].
2327 Prefix arg N says how many error messages to move forwards (or
2328 backwards, if negative).
2329 Optional arg DIFFERENT-FILE, if non-nil, means find next error for a
2330 file that is different from the current one.
2331 Optional arg PT, if non-nil, specifies the value of point to start
2332 looking for the next message."
2333 (interactive "p")
2334 (or (compilation-buffer-p (current-buffer))
2335 (error "Not in a compilation buffer"))
2336 (or pt (setq pt (point)))
2337 (compilation--ensure-parse pt)
2338 (let* ((msg (get-text-property pt 'compilation-message))
2339 ;; `loc', `msg', and `last' are used by the compilation-loop macro.
2340 (loc (and msg (compilation--message->loc msg)))
2341 last)
2342 (if (zerop n)
2343 (unless (or msg ; find message near here
2344 (setq msg (get-text-property (max (1- pt) (point-min))
2345 'compilation-message)))
2346 (setq pt (previous-single-property-change pt 'compilation-message nil
2347 (line-beginning-position)))
2348 (unless (setq msg (get-text-property (max (1- pt) (point-min))
2349 'compilation-message))
2350 (setq pt (compilation-next-single-property-change
2351 pt 'compilation-message nil
2352 (line-end-position)))
2353 (or (setq msg (get-text-property pt 'compilation-message))
2354 (setq pt (point)))))
2355 (setq last (compilation--loc->file-struct loc))
2356 (if (>= n 0)
2357 (compilation-loop > compilation-next-single-property-change 1-
2358 (if (get-buffer-process (current-buffer))
2359 "No more %ss yet"
2360 "Moved past last %s")
2361 (point-max))
2362 ;; Don't move "back" to message at or before point.
2363 ;; Pass an explicit (point-min) to make sure pt is non-nil.
2364 (setq pt (previous-single-property-change
2365 pt 'compilation-message nil (point-min)))
2366 (compilation-loop < previous-single-property-change 1+
2367 "Moved back before first %s" (point-min))))
2368 (goto-char pt)
2369 (or msg
2370 (error "No %s here" compilation-error))))
2372 (defun compilation-previous-error (n)
2373 "Move point to the previous error in the compilation buffer.
2374 Prefix arg N says how many error messages to move backwards (or
2375 forwards, if negative).
2376 Does NOT find the source line like \\[previous-error]."
2377 (interactive "p")
2378 (compilation-next-error (- n)))
2380 (defun compilation-next-file (n)
2381 "Move point to the next error for a different file than the current one.
2382 Prefix arg N says how many files to move forwards (or backwards, if negative)."
2383 (interactive "p")
2384 (compilation-next-error n t))
2386 (defun compilation-previous-file (n)
2387 "Move point to the previous error for a different file than the current one.
2388 Prefix arg N says how many files to move backwards (or forwards, if negative)."
2389 (interactive "p")
2390 (compilation-next-file (- n)))
2392 (defun compilation-display-error ()
2393 "Display the source for current error in another window."
2394 (interactive)
2395 (setq compilation-current-error (point))
2396 (next-error-no-select 0))
2398 (defun kill-compilation ()
2399 "Kill the process made by the \\[compile] or \\[grep] commands."
2400 (interactive)
2401 (let ((buffer (compilation-find-buffer)))
2402 (if (get-buffer-process buffer)
2403 (interrupt-process (get-buffer-process buffer))
2404 (error "The %s process is not running" (downcase mode-name)))))
2406 (defalias 'compile-mouse-goto-error 'compile-goto-error)
2408 (defun compile-goto-error (&optional event)
2409 "Visit the source for the error message at point.
2410 Use this command in a compilation log buffer."
2411 (interactive (list last-input-event))
2412 (if event (posn-set-point (event-end event)))
2413 (or (compilation-buffer-p (current-buffer))
2414 (error "Not in a compilation buffer"))
2415 (compilation--ensure-parse (point))
2416 (if (get-text-property (point) 'compilation-directory)
2417 (dired-other-window
2418 (car (get-text-property (point) 'compilation-directory)))
2419 (setq compilation-current-error (point))
2420 (next-error-internal)))
2422 ;; This is mostly unused, but we keep it for the sake of some external
2423 ;; packages which seem to make use of it.
2424 (defun compilation-find-buffer (&optional avoid-current)
2425 "Return a compilation buffer.
2426 If AVOID-CURRENT is nil, and the current buffer is a compilation buffer,
2427 return it. If AVOID-CURRENT is non-nil, return the current buffer only
2428 as a last resort."
2429 (if (and (compilation-buffer-internal-p) (not avoid-current))
2430 (current-buffer)
2431 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)))
2433 ;;;###autoload
2434 (defun compilation-next-error-function (n &optional reset)
2435 "Advance to the next error message and visit the file where the error was.
2436 This is the value of `next-error-function' in Compilation buffers."
2437 (interactive "p")
2438 (when reset
2439 (setq compilation-current-error nil))
2440 (let* ((screen-columns compilation-error-screen-columns)
2441 (first-column compilation-first-column)
2442 (last 1)
2443 (msg (compilation-next-error (or n 1) nil
2444 (or compilation-current-error
2445 compilation-messages-start
2446 (point-min))))
2447 (loc (compilation--message->loc msg))
2448 (end-loc (compilation--message->end-loc msg))
2449 (marker (point-marker)))
2450 (setq compilation-current-error (point-marker)
2451 overlay-arrow-position
2452 (if (bolp)
2453 compilation-current-error
2454 (copy-marker (line-beginning-position))))
2455 ;; If loc contains no marker, no error in that file has been visited.
2456 ;; If the marker is invalid the buffer has been killed.
2457 ;; So, recalculate all markers for that file.
2458 (unless (and (compilation--loc->marker loc)
2459 (marker-buffer (compilation--loc->marker loc))
2460 ;; FIXME-omake: For "omake -P", which automatically recompiles
2461 ;; when the file is modified, the line numbers of new output
2462 ;; may not be related to line numbers from earlier output
2463 ;; (earlier markers), so we used to try to detect it here and
2464 ;; force a reparse. But that caused more problems elsewhere,
2465 ;; so instead we now flush the file-structure when we see
2466 ;; omake's message telling it's about to recompile a file.
2467 ;; (or (null (compilation--loc->timestamp loc)) ;A fake-loc
2468 ;; (equal (compilation--loc->timestamp loc)
2469 ;; (setq timestamp compilation-buffer-modtime)))
2471 (with-current-buffer
2472 (apply #'compilation-find-file
2473 marker
2474 (caar (compilation--loc->file-struct loc))
2475 (cadr (car (compilation--loc->file-struct loc)))
2476 (compilation--file-struct->formats
2477 (compilation--loc->file-struct loc)))
2478 (let ((screen-columns
2479 ;; Obey the compilation-error-screen-columns of the target
2480 ;; buffer if its major mode set it buffer-locally.
2481 (if (local-variable-p 'compilation-error-screen-columns)
2482 compilation-error-screen-columns screen-columns))
2483 (compilation-first-column
2484 (if (local-variable-p 'compilation-first-column)
2485 compilation-first-column first-column)))
2486 (save-restriction
2487 (widen)
2488 (goto-char (point-min))
2489 ;; Treat file's found lines in forward order, 1 by 1.
2490 (dolist (line (reverse (cddr (compilation--loc->file-struct loc))))
2491 (when (car line) ; else this is a filename w/o a line#
2492 (compilation-beginning-of-line (- (car line) last -1))
2493 (setq last (car line)))
2494 ;; Treat line's found columns and store/update a marker for each.
2495 (dolist (col (cdr line))
2496 (if (compilation--loc->col col)
2497 (if (eq (compilation--loc->col col) -1)
2498 ;; Special case for range end.
2499 (end-of-line)
2500 (compilation-move-to-column (compilation--loc->col col)
2501 screen-columns))
2502 (beginning-of-line)
2503 (skip-chars-forward " \t"))
2504 (if (compilation--loc->marker col)
2505 (set-marker (compilation--loc->marker col) (point))
2506 (setf (compilation--loc->marker col) (point-marker)))
2507 ;; (setf (compilation--loc->timestamp col) timestamp)
2508 ))))))
2509 (compilation-goto-locus marker (compilation--loc->marker loc)
2510 (compilation--loc->marker end-loc))
2511 (setf (compilation--loc->visited loc) t)))
2513 (defvar compilation-gcpro nil
2514 "Internal variable used to keep some values from being GC'd.")
2515 (make-variable-buffer-local 'compilation-gcpro)
2517 (defun compilation-fake-loc (marker file &optional line col)
2518 "Preassociate MARKER with FILE.
2519 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
2520 This is useful when you compile temporary files, but want
2521 automatic translation of the messages to the real buffer from
2522 which the temporary file came. This may also affect previous messages
2523 about FILE.
2525 Optional args LINE and COL default to 1 and beginning of
2526 indentation respectively. The marker is expected to reflect
2527 this. In the simplest case the marker points to the first line
2528 of the region that was saved to the temp file.
2530 If you concatenate several regions into the temp file (e.g. a
2531 header with variable assignments and a code region), you must
2532 call this several times, once each for the last line of one
2533 region and the first line of the next region."
2534 (or (consp file) (setq file (list file)))
2535 (compilation--flush-file-structure file)
2536 (let ((fs (compilation-get-file-structure file)))
2537 ;; Between the current call to compilation-fake-loc and the first
2538 ;; occurrence of an error message referring to `file', the data is
2539 ;; only kept in the weak hash-table compilation-locs, so we need
2540 ;; to prevent this entry in compilation-locs from being GC'd
2541 ;; away. --Stef
2542 (push fs compilation-gcpro)
2543 (let ((loc (compilation-assq (or line 1) (cdr fs))))
2544 (setq loc (compilation-assq col loc))
2545 (cl-assert (null (cdr loc)))
2546 (setcdr loc (compilation--make-cdrloc line fs marker))
2547 loc)))
2549 (defcustom compilation-context-lines nil
2550 "Display this many lines of leading context before the current message.
2551 If nil and the left fringe is displayed, don't scroll the
2552 compilation output window; an arrow in the left fringe points to
2553 the current message. If nil and there is no left fringe, the message
2554 displays at the top of the window; there is no arrow."
2555 :type '(choice integer (const :tag "No window scrolling" nil))
2556 :group 'compilation
2557 :version "22.1")
2559 (defsubst compilation-set-window (w mk)
2560 "Align the compilation output window W with marker MK near top."
2561 (if (integerp compilation-context-lines)
2562 (set-window-start w (save-excursion
2563 (goto-char mk)
2564 (compilation-beginning-of-line
2565 (- 1 compilation-context-lines))
2566 (point)))
2567 ;; If there is no left fringe.
2568 (when (equal (car (window-fringes w)) 0)
2569 (set-window-start w (save-excursion
2570 (goto-char mk)
2571 (beginning-of-line 1)
2572 (point)))))
2573 (set-window-point w mk))
2575 (defvar next-error-highlight-timer)
2577 (defun compilation-goto-locus (msg mk end-mk)
2578 "Jump to an error corresponding to MSG at MK.
2579 All arguments are markers. If END-MK is non-nil, mark is set there
2580 and overlay is highlighted between MK and END-MK."
2581 ;; Show compilation buffer in other window, scrolled to this error.
2582 (let* ((from-compilation-buffer (eq (window-buffer)
2583 (marker-buffer msg)))
2584 ;; Use an existing window if it is in a visible frame.
2585 (pre-existing (get-buffer-window (marker-buffer msg) 0))
2586 (w (if (and from-compilation-buffer pre-existing)
2587 ;; Calling display-buffer here may end up (partly) hiding
2588 ;; the error location if the two buffers are in two
2589 ;; different frames. So don't do it if it's not necessary.
2590 pre-existing
2591 (display-buffer (marker-buffer msg) '(nil (allow-no-window . t)))))
2592 (highlight-regexp (with-current-buffer (marker-buffer msg)
2593 ;; also do this while we change buffer
2594 (goto-char (marker-position msg))
2595 (and w (compilation-set-window w msg))
2596 compilation-highlight-regexp)))
2597 ;; Ideally, the window-size should be passed to `display-buffer'
2598 ;; so it's only used when creating a new window.
2599 (when (and (not pre-existing) w)
2600 (compilation-set-window-height w))
2602 (if from-compilation-buffer
2603 ;; If the compilation buffer window was selected,
2604 ;; keep the compilation buffer in this window;
2605 ;; display the source in another window.
2606 (let ((pop-up-windows t))
2607 (pop-to-buffer (marker-buffer mk) 'other-window))
2608 (switch-to-buffer (marker-buffer mk)))
2609 (unless (eq (goto-char mk) (point))
2610 ;; If narrowing gets in the way of going to the right place, widen.
2611 (widen)
2612 (if next-error-move-function
2613 (funcall next-error-move-function msg mk)
2614 (goto-char mk)))
2615 (if end-mk
2616 (push-mark end-mk t)
2617 (if mark-active (setq mark-active nil)))
2618 ;; If hideshow got in the way of
2619 ;; seeing the right place, open permanently.
2620 (dolist (ov (overlays-at (point)))
2621 (when (eq 'hs (overlay-get ov 'invisible))
2622 (delete-overlay ov)
2623 (goto-char mk)))
2625 (when highlight-regexp
2626 (if (timerp next-error-highlight-timer)
2627 (cancel-timer next-error-highlight-timer))
2628 (unless compilation-highlight-overlay
2629 (setq compilation-highlight-overlay
2630 (make-overlay (point-min) (point-min)))
2631 (overlay-put compilation-highlight-overlay 'face 'next-error))
2632 (with-current-buffer (marker-buffer mk)
2633 (save-excursion
2634 (if end-mk (goto-char end-mk) (end-of-line))
2635 (let ((end (point)))
2636 (if mk (goto-char mk) (beginning-of-line))
2637 (if (and (stringp highlight-regexp)
2638 (re-search-forward highlight-regexp end t))
2639 (progn
2640 (goto-char (match-beginning 0))
2641 (move-overlay compilation-highlight-overlay
2642 (match-beginning 0) (match-end 0)
2643 (current-buffer)))
2644 (move-overlay compilation-highlight-overlay
2645 (point) end (current-buffer)))
2646 (if (or (eq next-error-highlight t)
2647 (numberp next-error-highlight))
2648 ;; We want highlighting: delete overlay on next input.
2649 (add-hook 'pre-command-hook
2650 'compilation-goto-locus-delete-o)
2651 ;; We don't want highlighting: delete overlay now.
2652 (delete-overlay compilation-highlight-overlay))
2653 ;; We want highlighting for a limited time:
2654 ;; set up a timer to delete it.
2655 (when (numberp next-error-highlight)
2656 (setq next-error-highlight-timer
2657 (run-at-time next-error-highlight nil
2658 'compilation-goto-locus-delete-o)))))))
2659 (when (and (eq next-error-highlight 'fringe-arrow))
2660 ;; We want a fringe arrow (instead of highlighting).
2661 (setq next-error-overlay-arrow-position
2662 (copy-marker (line-beginning-position))))))
2664 (defun compilation-goto-locus-delete-o ()
2665 (delete-overlay compilation-highlight-overlay)
2666 ;; Get rid of timer and hook that would try to do this again.
2667 (if (timerp next-error-highlight-timer)
2668 (cancel-timer next-error-highlight-timer))
2669 (remove-hook 'pre-command-hook
2670 'compilation-goto-locus-delete-o))
2672 (defun compilation-find-file (marker filename directory &rest formats)
2673 "Find a buffer for file FILENAME.
2674 If FILENAME is not found at all, ask the user where to find it.
2675 Pop up the buffer containing MARKER and scroll to MARKER if we ask
2676 the user where to find the file.
2677 Search the directories in `compilation-search-path'.
2678 A nil in `compilation-search-path' means to try the
2679 \"current\" directory, which is passed in DIRECTORY.
2680 If DIRECTORY is relative, it is combined with `default-directory'.
2681 If DIRECTORY is nil, that means use `default-directory'.
2682 FORMATS, if given, is a list of formats to reformat FILENAME when
2683 looking for it: for each element FMT in FORMATS, this function
2684 attempts to find a file whose name is produced by (format FMT FILENAME)."
2685 (or formats (setq formats '("%s")))
2686 (let ((dirs compilation-search-path)
2687 (spec-dir (if directory
2688 (expand-file-name directory)
2689 default-directory))
2690 buffer thisdir fmts name)
2691 (if (file-name-absolute-p filename)
2692 ;; The file name is absolute. Use its explicit directory as
2693 ;; the first in the search path, and strip it from FILENAME.
2694 (setq filename (abbreviate-file-name (expand-file-name filename))
2695 dirs (cons (file-name-directory filename) dirs)
2696 filename (file-name-nondirectory filename)))
2697 ;; Now search the path.
2698 (while (and dirs (null buffer))
2699 (setq thisdir (or (car dirs) spec-dir)
2700 fmts formats)
2701 ;; For each directory, try each format string.
2702 (while (and fmts (null buffer))
2703 (setq name (expand-file-name (format (car fmts) filename) thisdir)
2704 buffer (and (file-exists-p name)
2705 (find-file-noselect name))
2706 fmts (cdr fmts)))
2707 (setq dirs (cdr dirs)))
2708 (while (null buffer) ;Repeat until the user selects an existing file.
2709 ;; The file doesn't exist. Ask the user where to find it.
2710 (save-excursion ;This save-excursion is probably not right.
2711 (let ((w (let ((pop-up-windows t))
2712 (display-buffer (marker-buffer marker)
2713 '(nil (allow-no-window . t))))))
2714 (with-current-buffer (marker-buffer marker)
2715 (goto-char marker)
2716 (and w (compilation-set-window w marker)))
2717 (let* ((name (read-file-name
2718 (format "Find this %s in (default %s): "
2719 compilation-error filename)
2720 spec-dir filename t nil
2721 ;; The predicate below is fine when called from
2722 ;; minibuffer-complete-and-exit, but it's too
2723 ;; restrictive otherwise, since it also prevents the
2724 ;; user from completing "fo" to "foo/" when she
2725 ;; wants to enter "foo/bar".
2727 ;; Try to make sure the user can only select
2728 ;; a valid answer. This predicate may be ignored,
2729 ;; tho, so we still have to double-check afterwards.
2730 ;; TODO: We should probably fix read-file-name so
2731 ;; that it never ignores this predicate, even when
2732 ;; using popup dialog boxes.
2733 ;; (lambda (name)
2734 ;; (if (file-directory-p name)
2735 ;; (setq name (expand-file-name filename name)))
2736 ;; (file-exists-p name))
2738 (origname name))
2739 (cond
2740 ((not (file-exists-p name))
2741 (message "Cannot find file `%s'" name)
2742 (ding) (sit-for 2))
2743 ((and (file-directory-p name)
2744 (not (file-exists-p
2745 (setq name (expand-file-name filename name)))))
2746 (message "No `%s' in directory %s" filename origname)
2747 (ding) (sit-for 2))
2749 (setq buffer (find-file-noselect name))))))))
2750 ;; Make intangible overlays tangible.
2751 ;; This is weird: it's not even clear which is the current buffer,
2752 ;; so the code below can't be expected to DTRT here. -- Stef
2753 (dolist (ov (overlays-in (point-min) (point-max)))
2754 (when (overlay-get ov 'intangible)
2755 (overlay-put ov 'intangible nil)))
2756 buffer))
2758 (defun compilation-get-file-structure (file &optional fmt)
2759 "Retrieve FILE's file-structure or create a new one.
2760 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
2761 In the former case, FILENAME may be relative or absolute.
2763 The file-structure looks like this:
2764 ((FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)"
2765 (or (gethash file compilation-locs)
2766 ;; File was not previously encountered, at least not in the form passed.
2767 ;; Let's normalize it and look again.
2768 (let ((filename (car file))
2769 ;; Get the specified directory from FILE.
2770 (spec-directory (if (cdr file)
2771 (file-truename (cdr file)))))
2773 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2774 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2775 ;; buffer.)
2776 (when (and (boundp 'comint-file-name-prefix)
2777 (not (equal comint-file-name-prefix "")))
2778 (if (file-name-absolute-p filename)
2779 (setq filename
2780 (concat comint-file-name-prefix filename))
2781 (if spec-directory
2782 (setq spec-directory
2783 (file-truename
2784 (concat comint-file-name-prefix spec-directory))))))
2786 ;; If compilation-parse-errors-filename-function is
2787 ;; defined, use it to process the filename.
2788 (when compilation-parse-errors-filename-function
2789 (setq filename
2790 (funcall compilation-parse-errors-filename-function
2791 filename)))
2793 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
2794 ;; file names like "./bar//foo.c" for file "bar/foo.c";
2795 ;; expand-file-name will collapse these into "/foo.c" and fail to find
2796 ;; the appropriate file. So we look for doubled slashes in the file
2797 ;; name and fix them.
2798 (setq filename (command-line-normalize-file-name filename))
2800 ;; Store it for the possibly unnormalized name
2801 (puthash file
2802 ;; Retrieve or create file-structure for normalized name
2803 ;; The gethash used to not use spec-directory, but
2804 ;; this leads to errors when files in different
2805 ;; directories have the same name:
2806 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00463.html
2807 (or (gethash (cons filename spec-directory) compilation-locs)
2808 (puthash (cons filename spec-directory)
2809 (compilation--make-file-struct
2810 (list filename spec-directory) fmt)
2811 compilation-locs))
2812 compilation-locs))))
2814 (defun compilation--flush-file-structure (file)
2815 (or (consp file) (setq file (list file)))
2816 (let ((fs (compilation-get-file-structure file)))
2817 (cl-assert (eq fs (gethash file compilation-locs)))
2818 (cl-assert (eq fs (gethash (cons (caar fs) (cadr (car fs)))
2819 compilation-locs)))
2820 (maphash (lambda (k v)
2821 (if (eq v fs) (remhash k compilation-locs)))
2822 compilation-locs)))
2824 ;;; Compatibility with the old compile.el.
2826 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
2827 (defvar compilation-parsing-end (make-marker))
2828 (defvar compilation-error-list nil)
2829 (defvar compilation-old-error-list nil)
2831 (defun compilation--compat-error-properties (err)
2832 "Map old-style error ERR to new-style message."
2833 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
2834 ;; (MARKER . MARKER).
2835 (let ((dst (cdr err)))
2836 (if (markerp dst)
2837 `(compilation-message ,(compilation--make-message
2838 (cons nil (compilation--make-cdrloc
2839 nil nil dst))
2840 2 nil)
2841 help-echo "mouse-2: visit the source location"
2842 keymap compilation-button-map
2843 mouse-face highlight)
2844 ;; Too difficult to do it by hand: dispatch to the normal code.
2845 (let* ((file (pop dst))
2846 (line (pop dst))
2847 (col (pop dst))
2848 (filename (pop file))
2849 (dirname (pop file))
2850 (fmt (pop file)))
2851 (compilation-internal-error-properties
2852 (cons filename dirname) line nil col nil 2 fmt)))))
2854 (defun compilation--compat-parse-errors (limit)
2855 (when compilation-parse-errors-function
2856 ;; FIXME: We should remove the rest of the compilation keywords
2857 ;; but we can't do that from here because font-lock is using
2858 ;; the value right now. --Stef
2859 (save-excursion
2860 (setq compilation-error-list nil)
2861 ;; Reset compilation-parsing-end each time because font-lock
2862 ;; might force us the re-parse many times (typically because
2863 ;; some code adds some text-property to the output that we
2864 ;; already parsed). You might say "why reparse", well:
2865 ;; because font-lock has just removed the `compilation-message' property
2866 ;; so have to do it all over again.
2867 (if compilation-parsing-end
2868 (set-marker compilation-parsing-end (point))
2869 (setq compilation-parsing-end (point-marker)))
2870 (condition-case nil
2871 ;; Ignore any error: we're calling this function earlier than
2872 ;; in the old compile.el so things might not all be setup yet.
2873 (funcall compilation-parse-errors-function limit nil)
2874 (error nil))
2875 (dolist (err (if (listp compilation-error-list) compilation-error-list))
2876 (let* ((src (car err))
2877 (dst (cdr err))
2878 (loc (cond ((markerp dst)
2879 (cons nil
2880 (compilation--make-cdrloc nil nil dst)))
2881 ((consp dst)
2882 (cons (nth 2 dst)
2883 (compilation--make-cdrloc
2884 (nth 1 dst)
2885 (cons (cdar dst) (caar dst))
2886 nil))))))
2887 (when loc
2888 (goto-char src)
2889 ;; (put-text-property src (line-end-position)
2890 ;; 'font-lock-face 'font-lock-warning-face)
2891 (put-text-property src (line-end-position)
2892 'compilation-message
2893 (compilation--make-message loc 2 nil)))))))
2894 (goto-char limit)
2895 nil)
2897 ;; Beware! this is not only compatibility code. New code also uses it. --Stef
2898 (defun compilation-forget-errors ()
2899 ;; In case we hit the same file/line specs, we want to recompute a new
2900 ;; marker for them, so flush our cache.
2901 (clrhash compilation-locs)
2902 (setq compilation-gcpro nil)
2903 ;; FIXME: the old code reset the directory-stack, so maybe we should
2904 ;; put a `directory change' marker of some sort, but where? -stef
2906 ;; FIXME: The old code moved compilation-current-error (which was
2907 ;; virtually represented by a mix of compilation-parsing-end and
2908 ;; compilation-error-list) to point-min, but that was only meaningful for
2909 ;; the internal uses of compilation-forget-errors: all calls from external
2910 ;; packages seem to be followed by a move of compilation-parsing-end to
2911 ;; something equivalent to point-max. So we heuristically move
2912 ;; compilation-current-error to point-max (since the external package
2913 ;; won't know that it should do it). --Stef
2914 (setq compilation-current-error nil)
2915 (let* ((proc (get-buffer-process (current-buffer)))
2916 (mark (if proc (process-mark proc)))
2917 (pos (or mark (point-max))))
2918 (setq compilation-messages-start
2919 ;; In the future, ignore the text already present in the buffer.
2920 ;; Since many process filter functions insert before markers,
2921 ;; we need to put ours just before the insertion point rather
2922 ;; than at the insertion point. If that's not possible, then
2923 ;; don't use a marker. --Stef
2924 (if (> pos (point-min)) (copy-marker (1- pos)) pos)))
2925 ;; Again, since this command is used in buffers that contain several
2926 ;; compilations, to set the beginning of "this compilation", it's a good
2927 ;; place to reset compilation-auto-jump-to-next.
2928 (set (make-local-variable 'compilation-auto-jump-to-next)
2929 (or compilation-auto-jump-to-first-error
2930 (eq compilation-scroll-output 'first-error))))
2932 (provide 'compile)
2934 ;;; compile.el ends here