Delete Emacs 25 test in mode-local.el
[emacs.git] / lisp / progmodes / compile.el
bloba6e9ed8889aa76b98211fed2cd515b26d0358c18
1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages -*- lexical-binding:t -*-
3 ;; Copyright (C) 1985-1987, 1993-1999, 2001-2015 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]*\\([^: \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)
480 (guile-file "^In \\(.+\\):\n" 1)
481 (guile-line "^ *\\([0-9]+\\): *\\([0-9]+\\)" nil 1 2)
483 "Alist of values for `compilation-error-regexp-alist'.")
485 (defcustom compilation-error-regexp-alist
486 (mapcar 'car compilation-error-regexp-alist-alist)
487 "Alist that specifies how to match errors in compiler output.
488 On GNU and Unix, any string is a valid filename, so these
489 matchers must make some common sense assumptions, which catch
490 normal cases. A shorter list will be lighter on resource usage.
492 Instead of an alist element, you can use a symbol, which is
493 looked up in `compilation-error-regexp-alist-alist'. You can see
494 the predefined symbols and their effects in the file
495 `etc/compilation.txt' (linked below if you are customizing this).
497 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
498 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
499 gives the file name, and the LINE'th subexpression gives the line
500 number. The COLUMN'th subexpression gives the column number on
501 that line.
503 If FILE, LINE or COLUMN are nil or that index didn't match, that
504 information is not present on the matched line. In that case the
505 file name is assumed to be the same as the previous one in the
506 buffer, line number defaults to 1 and column defaults to
507 beginning of line's indentation.
509 FILE can also have the form (FILE FORMAT...), where the FORMATs
510 \(e.g. \"%s.c\") will be applied in turn to the recognized file
511 name, until a file of that name is found. Or FILE can also be a
512 function that returns (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
513 In the former case, FILENAME may be relative or absolute.
515 LINE can also be of the form (LINE . END-LINE) meaning a range
516 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
517 meaning a range of columns starting on LINE and ending on
518 END-LINE, if that matched.
520 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
521 TYPE can also be of the form (WARNING . INFO). In that case this
522 will be equivalent to 1 if the WARNING'th subexpression matched
523 or else equivalent to 0 if the INFO'th subexpression matched.
524 See `compilation-error-face', `compilation-warning-face',
525 `compilation-info-face' and `compilation-skip-threshold'.
527 What matched the HYPERLINK'th subexpression has `mouse-face' and
528 `compilation-message-face' applied. If this is nil, the text
529 matched by the whole REGEXP becomes the hyperlink.
531 Additional HIGHLIGHTs take the shape (SUBMATCH FACE), where
532 SUBMATCH is the number of a submatch and FACE is an expression
533 which evaluates to a face name (a symbol or string).
534 Alternatively, FACE can evaluate to a property list of the
535 form (face FACE PROP1 VAL1 PROP2 VAL2 ...), in which case all the
536 listed text properties PROP# are given values VAL# as well."
537 :type '(repeat (choice (symbol :tag "Predefined symbol")
538 (sexp :tag "Error specification")))
539 :link `(file-link :tag "example file"
540 ,(expand-file-name "compilation.txt" data-directory))
541 :group 'compilation)
543 ;;;###autoload(put 'compilation-directory 'safe-local-variable 'stringp)
544 (defvar compilation-directory nil
545 "Directory to restore to when doing `recompile'.")
547 (defvar compilation-directory-matcher
548 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory [`']\\(.+\\)'$" (2 . 1))
549 "A list for tracking when directories are entered or left.
550 If nil, do not track directories, e.g. if all file names are absolute. The
551 first element is the REGEXP matching these messages. It can match any number
552 of variants, e.g. different languages. The remaining elements are all of the
553 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
554 matches, that is a directory name. If LEAVE is nil or the corresponding
555 LEAVE'th subexpression doesn't match, this message is about going into another
556 directory. If it does match anything, this message is about going back to the
557 directory we were in before the last entering message. If you change this,
558 you may also want to change `compilation-page-delimiter'.")
560 (defvar compilation-page-delimiter
561 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory [`'].+'\n\\)+"
562 "Value of `page-delimiter' in Compilation mode.")
564 (defvar compilation-mode-font-lock-keywords
565 '(;; configure output lines.
566 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
567 (1 font-lock-variable-name-face)
568 (2 (compilation-face '(4 . 3))))
569 ;; Command output lines. Recognize `make[n]:' lines too.
570 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
571 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
572 (" --?o\\(?:utfile\\|utput\\)?[= ]\\(\\S +\\)" . 1)
573 ("^Compilation \\(finished\\).*"
574 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
575 (1 compilation-info-face))
576 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\|segmentation fault\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
577 (0 '(face nil compilation-message nil help-echo nil mouse-face nil) t)
578 (1 compilation-error-face)
579 (2 compilation-error-face nil t)))
580 "Additional things to highlight in Compilation mode.
581 This gets tacked on the end of the generated expressions.")
583 (defvar compilation-highlight-regexp t
584 "Regexp matching part of visited source lines to highlight temporarily.
585 Highlight entire line if t; don't highlight source lines if nil.")
587 (defvar compilation-highlight-overlay nil
588 "Overlay used to temporarily highlight compilation matches.")
590 (defcustom compilation-error-screen-columns t
591 "If non-nil, column numbers in error messages are screen columns.
592 Otherwise they are interpreted as character positions, with
593 each character occupying one column.
594 The default is to use screen columns, which requires that the compilation
595 program and Emacs agree about the display width of the characters,
596 especially the TAB character.
597 If this is buffer-local in the destination buffer, Emacs obeys
598 that value, otherwise it uses the value in the *compilation*
599 buffer. This enables a major-mode to specify its own value."
600 :type 'boolean
601 :group 'compilation
602 :version "20.4")
604 (defcustom compilation-read-command t
605 "Non-nil means \\[compile] reads the compilation command to use.
606 Otherwise, \\[compile] just uses the value of `compile-command'.
608 Note that changing this to nil may be a security risk, because a
609 file might define a malicious `compile-command' as a file local
610 variable, and you might not notice. Therefore, `compile-command'
611 is considered unsafe if this variable is nil."
612 :type 'boolean
613 :group 'compilation)
615 ;;;###autoload
616 (defcustom compilation-ask-about-save t
617 "Non-nil means \\[compile] asks which buffers to save before compiling.
618 Otherwise, it saves all modified buffers without asking."
619 :type 'boolean
620 :group 'compilation)
622 (defcustom compilation-save-buffers-predicate nil
623 "The second argument (PRED) passed to `save-some-buffers' before compiling.
624 E.g., one can set this to
625 (lambda ()
626 (string-prefix-p my-compilation-root (file-truename (buffer-file-name))))
627 to limit saving to files located under `my-compilation-root'.
628 Note, that, in general, `compilation-directory' cannot be used instead
629 of `my-compilation-root' here."
630 :type '(choice
631 (const :tag "Default (save all file-visiting buffers)" nil)
632 (const :tag "Save all buffers" t)
633 function)
634 :group 'compilation
635 :version "24.1")
637 ;;;###autoload
638 (defcustom compilation-search-path '(nil)
639 "List of directories to search for source files named in error messages.
640 Elements should be directory names, not file names of directories.
641 The value nil as an element means to try the default directory."
642 :type '(repeat (choice (const :tag "Default" nil)
643 (string :tag "Directory")))
644 :group 'compilation)
646 ;;;###autoload
647 (defcustom compile-command (purecopy "make -k ")
648 "Last shell command used to do a compilation; default for next compilation.
650 Sometimes it is useful for files to supply local values for this variable.
651 You might also use mode hooks to specify it in certain modes, like this:
653 (add-hook \\='c-mode-hook
654 (lambda ()
655 (unless (or (file-exists-p \"makefile\")
656 (file-exists-p \"Makefile\"))
657 (set (make-local-variable \\='compile-command)
658 (concat \"make -k \"
659 (if buffer-file-name
660 (shell-quote-argument
661 (file-name-sans-extension buffer-file-name))))))))"
662 :type 'string
663 :group 'compilation)
664 ;;;###autoload(put 'compile-command 'safe-local-variable (lambda (a) (and (stringp a) (or (not (boundp 'compilation-read-command)) compilation-read-command))))
666 ;;;###autoload
667 (defcustom compilation-disable-input nil
668 "If non-nil, send end-of-file as compilation process input.
669 This only affects platforms that support asynchronous processes (see
670 `start-process'); synchronous compilation processes never accept input."
671 :type 'boolean
672 :group 'compilation
673 :version "22.1")
675 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
676 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
677 ;; key. This holds the tree seen from root, for storing new nodes.
678 (defvar compilation-locs ())
680 (defvar compilation-debug nil
681 "Set this to t before creating a *compilation* buffer.
682 Then every error line will have a debug text property with the matcher that
683 fit this line and the match data. Use `describe-text-properties'.")
685 (defvar compilation-exit-message-function nil "\
686 If non-nil, called when a compilation process dies to return a status message.
687 This should be a function of three arguments: process status, exit status,
688 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
689 write into the compilation buffer, and to put in its mode line.")
691 (defcustom compilation-environment nil
692 "List of environment variables for compilation to inherit.
693 Each element should be a string of the form ENVVARNAME=VALUE.
694 This list is temporarily prepended to `process-environment' prior to
695 starting the compilation process."
696 :type '(repeat (string :tag "ENVVARNAME=VALUE"))
697 :options '(("LANG=C"))
698 :group 'compilation
699 :version "24.1")
701 ;; History of compile commands.
702 (defvar compile-history nil)
704 (defface compilation-error
705 '((t :inherit error))
706 "Face used to highlight compiler errors."
707 :group 'compilation
708 :version "22.1")
710 (defface compilation-warning
711 '((t :inherit warning))
712 "Face used to highlight compiler warnings."
713 :group 'compilation
714 :version "22.1")
716 (defface compilation-info
717 '((t :inherit success))
718 "Face used to highlight compiler information."
719 :group 'compilation
720 :version "22.1")
722 ;; The next three faces must be able to stand out against the
723 ;; `mode-line' and `mode-line-inactive' faces.
725 (defface compilation-mode-line-fail
726 '((default :inherit compilation-error)
727 (((class color) (min-colors 16)) (:foreground "Red1" :weight bold))
728 (((class color) (min-colors 8)) (:foreground "red"))
729 (t (:inverse-video t :weight bold)))
730 "Face for Compilation mode's \"error\" mode line indicator."
731 :group 'compilation
732 :version "24.3")
734 (defface compilation-mode-line-run
735 '((t :inherit compilation-warning))
736 "Face for Compilation mode's \"running\" mode line indicator."
737 :group 'compilation
738 :version "24.3")
740 (defface compilation-mode-line-exit
741 '((default :inherit compilation-info)
742 (((class color) (min-colors 16))
743 (:foreground "ForestGreen" :weight bold))
744 (((class color)) (:foreground "green" :weight bold))
745 (t (:weight bold)))
746 "Face for Compilation mode's \"exit\" mode line indicator."
747 :group 'compilation
748 :version "24.3")
750 (defface compilation-line-number
751 '((t :inherit font-lock-keyword-face))
752 "Face for displaying line numbers in compiler messages."
753 :group 'compilation
754 :version "22.1")
756 (defface compilation-column-number
757 '((t :inherit font-lock-doc-face))
758 "Face for displaying column numbers in compiler messages."
759 :group 'compilation
760 :version "22.1")
762 (defcustom compilation-message-face 'underline
763 "Face name to use for whole messages.
764 Faces `compilation-error-face', `compilation-warning-face',
765 `compilation-info-face', `compilation-line-face' and
766 `compilation-column-face' get prepended to this, when applicable."
767 :type 'face
768 :group 'compilation
769 :version "22.1")
771 (defvar compilation-error-face 'compilation-error
772 "Face name to use for file name in error messages.")
774 (defvar compilation-warning-face 'compilation-warning
775 "Face name to use for file name in warning messages.")
777 (defvar compilation-info-face 'compilation-info
778 "Face name to use for file name in informational messages.")
780 (defvar compilation-line-face 'compilation-line-number
781 "Face name to use for line numbers in compiler messages.")
783 (defvar compilation-column-face 'compilation-column-number
784 "Face name to use for column numbers in compiler messages.")
786 ;; same faces as dired uses
787 (defvar compilation-enter-directory-face 'font-lock-function-name-face
788 "Face name to use for entering directory messages.")
790 (defvar compilation-leave-directory-face 'font-lock-builtin-face
791 "Face name to use for leaving directory messages.")
793 ;; Used for compatibility with the old compile.el.
794 (defvar compilation-parse-errors-function nil)
795 (make-obsolete-variable 'compilation-parse-errors-function
796 'compilation-error-regexp-alist "24.1")
798 (defcustom compilation-auto-jump-to-first-error nil
799 "If non-nil, automatically jump to the first error during compilation."
800 :type 'boolean
801 :group 'compilation
802 :version "23.1")
804 (defvar compilation-auto-jump-to-next nil
805 "If non-nil, automatically jump to the next error encountered.")
806 (make-variable-buffer-local 'compilation-auto-jump-to-next)
808 ;; (defvar compilation-buffer-modtime nil
809 ;; "The buffer modification time, for buffers not associated with files.")
810 ;; (make-variable-buffer-local 'compilation-buffer-modtime)
812 (defvar compilation-skip-to-next-location t
813 "If non-nil, skip multiple error messages for the same source location.")
815 (defcustom compilation-skip-threshold 1
816 "Compilation motion commands skip less important messages.
817 The value can be either 2 -- skip anything less than error, 1 --
818 skip anything less than warning or 0 -- don't skip any messages.
819 Note that all messages not positively identified as warning or
820 info, are considered errors."
821 :type '(choice (const :tag "Skip warnings and info" 2)
822 (const :tag "Skip info" 1)
823 (const :tag "No skip" 0))
824 :group 'compilation
825 :version "22.1")
827 (defun compilation-set-skip-threshold (level)
828 "Switch the `compilation-skip-threshold' level."
829 (interactive
830 (list
831 (mod (if current-prefix-arg
832 (prefix-numeric-value current-prefix-arg)
833 (1+ compilation-skip-threshold))
834 3)))
835 (setq compilation-skip-threshold level)
836 (message "Skipping %s"
837 (pcase compilation-skip-threshold
838 (0 "Nothing")
839 (1 "Info messages")
840 (2 "Warnings and info"))))
842 (defcustom compilation-skip-visited nil
843 "Compilation motion commands skip visited messages if this is t.
844 Visited messages are ones for which the file, line and column have been jumped
845 to from the current content in the current compilation buffer, even if it was
846 from a different message."
847 :type 'boolean
848 :group 'compilation
849 :version "22.1")
851 (defun compilation-face (type)
852 (or (and (car type) (match-end (car type)) compilation-warning-face)
853 (and (cdr type) (match-end (cdr type)) compilation-info-face)
854 compilation-error-face))
856 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE nil nil)
858 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
859 ;; LINE will be nil for a message that doesn't contain them. Then the
860 ;; location refers to a indented beginning of line or beginning of file.
861 ;; Once any location in some file has been jumped to, the list is extended to
862 ;; (COLUMN LINE FILE-STRUCTURE MARKER TIMESTAMP . VISITED)
863 ;; for all LOCs pertaining to that file.
864 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
865 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
866 ;; before that point. VISITED is t if we have jumped there, else nil.
867 ;; FIXME-omake: TIMESTAMP was used to try and handle "incremental compilation":
868 ;; `omake -P' polls filesystem for changes and recompiles when a file is
869 ;; modified using the same *compilation* buffer. this necessitates
870 ;; re-parsing markers.
872 ;; (cl-defstruct (compilation--loc
873 ;; (:constructor nil)
874 ;; (:copier nil)
875 ;; (:constructor compilation--make-loc
876 ;; (file-struct line col marker))
877 ;; (:conc-name compilation--loc->))
878 ;; col line file-struct marker timestamp visited)
880 ;; FIXME: We don't use a defstruct because of compilation-assq which looks up
881 ;; and creates part of the LOC (only the first cons cell containing the COL).
883 (defmacro compilation--make-cdrloc (line file-struct marker)
884 `(list ,line ,file-struct ,marker nil))
885 (defmacro compilation--loc->col (loc) `(car ,loc))
886 (defmacro compilation--loc->line (loc) `(cadr ,loc))
887 (defmacro compilation--loc->file-struct (loc) `(nth 2 ,loc))
888 (defmacro compilation--loc->marker (loc) `(nth 3 ,loc))
889 ;; (defmacro compilation--loc->timestamp (loc) `(nth 4 ,loc))
890 (defmacro compilation--loc->visited (loc) `(nthcdr 5 ,loc))
892 ;; FILE-STRUCTURE is a list of
893 ;; ((FILENAME DIRECTORY) FORMATS (LINE LOC ...) ...)
895 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
896 ;; obtained by following directory change messages. DIRECTORY will be nil for
897 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
898 ;; a file of that name can't be found.
899 ;; The rest of the list is an alist of elements with LINE as key. The keys
900 ;; are either nil or line numbers. If present, nil comes first, followed by
901 ;; the numbers in decreasing order. The LOCs for each line are again an alist
902 ;; ordered the same way. Note that the whole file structure is referenced in
903 ;; every LOC.
905 (defmacro compilation--make-file-struct (file-spec formats &optional loc-tree)
906 `(cons ,file-spec (cons ,formats ,loc-tree)))
907 (defmacro compilation--file-struct->file-spec (fs) `(car ,fs))
908 (defmacro compilation--file-struct->formats (fs) `(cadr ,fs))
909 ;; The FORMATS field plays the role of ANCHOR in the loc-tree.
910 (defmacro compilation--file-struct->loc-tree (fs) `(cdr ,fs))
912 ;; MESSAGE is a list of (LOC TYPE END-LOC)
914 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
915 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
916 ;; other end, if the parsed message contained a range. If the end of the
917 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
918 ;; These are the value of the `compilation-message' text-properties in the
919 ;; compilation buffer.
921 (cl-defstruct (compilation--message
922 (:constructor nil)
923 (:copier nil)
924 ;; (:type list) ;Old representation.
925 (:constructor compilation--make-message (loc type end-loc))
926 (:conc-name compilation--message->))
927 loc type end-loc)
929 (defvar compilation--previous-directory-cache nil
930 "A pair (POS . RES) caching the result of previous directory search.
931 Basically, this pair says that calling
932 (previous-single-property-change POS 'compilation-directory)
933 returned RES, i.e. there is no change of `compilation-directory' between
934 POS and RES.")
935 (make-variable-buffer-local 'compilation--previous-directory-cache)
937 (defun compilation--flush-directory-cache (start _end)
938 (cond
939 ((or (not compilation--previous-directory-cache)
940 (<= (car compilation--previous-directory-cache) start)))
941 ((or (not (cdr compilation--previous-directory-cache))
942 (null (marker-buffer (cdr compilation--previous-directory-cache)))
943 (<= (cdr compilation--previous-directory-cache) start))
944 (set-marker (car compilation--previous-directory-cache) start))
945 (t (setq compilation--previous-directory-cache nil))))
947 (defun compilation--previous-directory (pos)
948 "Like (previous-single-property-change POS 'compilation-directory), but faster."
949 ;; This avoids an N² behavior when there's no/few compilation-directory
950 ;; entries, in which case each call to previous-single-property-change
951 ;; ends up having to walk very far back to find the last change.
952 (if (and compilation--previous-directory-cache
953 (< pos (car compilation--previous-directory-cache))
954 (or (null (cdr compilation--previous-directory-cache))
955 (< (cdr compilation--previous-directory-cache) pos)))
956 ;; No need to call previous-single-property-change.
957 (cdr compilation--previous-directory-cache)
959 (let* ((cache (and compilation--previous-directory-cache
960 (<= (car compilation--previous-directory-cache) pos)
961 (car compilation--previous-directory-cache)))
962 (prev
963 (previous-single-property-change
964 pos 'compilation-directory nil cache))
965 (res
966 (cond
967 ((null cache)
968 (setq compilation--previous-directory-cache
969 (cons (copy-marker pos) (if prev (copy-marker prev))))
970 prev)
971 ((and prev (= prev cache))
972 (set-marker (car compilation--previous-directory-cache) pos)
973 (cdr compilation--previous-directory-cache))
975 (set-marker cache pos)
976 (setcdr compilation--previous-directory-cache
977 (copy-marker prev))
978 prev))))
979 (if (markerp res) (marker-position res) res))))
981 ;; Internal function for calculating the text properties of a directory
982 ;; change message. The compilation-directory property is important, because it
983 ;; is the stack of nested enter-messages. Relative filenames on the following
984 ;; lines are relative to the top of the stack.
985 (defun compilation-directory-properties (idx leave)
986 (if leave (setq leave (match-end leave)))
987 ;; find previous stack, and push onto it, or if `leave' pop it
988 (let ((dir (compilation--previous-directory (match-beginning 0))))
989 (setq dir (if dir (or (get-text-property (1- dir) 'compilation-directory)
990 (get-text-property dir 'compilation-directory))))
991 `(font-lock-face ,(if leave
992 compilation-leave-directory-face
993 compilation-enter-directory-face)
994 compilation-directory ,(if leave
995 (or (cdr dir)
996 '(nil)) ; nil only isn't a property-change
997 (cons (match-string-no-properties idx) dir))
998 ;; Place a `compilation-message' everywhere we change text-properties
999 ;; so compilation--remove-properties can know what to remove.
1000 compilation-message ,(compilation--make-message nil 0 nil)
1001 mouse-face highlight
1002 keymap compilation-button-map
1003 help-echo "mouse-2: visit destination directory")))
1005 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
1006 ;; KEY element from the ALIST, creating it in the right position if not already
1007 ;; present. ALIST structure is
1008 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
1009 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
1010 ;; may be nil. The other KEYs are ordered backwards so that growing line
1011 ;; numbers can be inserted in front and searching can abort after half the
1012 ;; list on average.
1013 (eval-when-compile ;Don't keep it at runtime if not needed.
1014 (defmacro compilation-assq (key alist)
1015 `(let* ((l1 ,alist)
1016 (l2 (cdr l1)))
1017 (car (if (if (null ,key)
1018 (if l2 (null (caar l2)))
1019 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
1020 (setq l1 l2
1021 l2 (cdr l1)))
1022 (if l2 (eq ,key (caar l2))))
1024 (setcdr l1 (cons (list ,key) l2)))))))
1026 (defun compilation-auto-jump (buffer pos)
1027 (with-current-buffer buffer
1028 (goto-char pos)
1029 (let ((win (get-buffer-window buffer 0)))
1030 (if win (set-window-point win pos)))
1031 (if compilation-auto-jump-to-first-error
1032 (compile-goto-error))))
1034 ;; This function is the central driver, called when font-locking to gather
1035 ;; all information needed to later jump to corresponding source code.
1036 ;; Return a property list with all meta information on this error location.
1038 (defun compilation-error-properties (file line end-line col end-col type fmt)
1039 (unless (text-property-not-all (match-beginning 0) (point)
1040 'compilation-message nil)
1041 (if file
1042 (when (stringp
1043 (setq file (if (functionp file) (funcall file)
1044 (match-string-no-properties file))))
1045 (let ((dir
1046 (unless (file-name-absolute-p file)
1047 (let ((pos (compilation--previous-directory
1048 (match-beginning 0))))
1049 (when pos
1050 (or (get-text-property (1- pos) 'compilation-directory)
1051 (get-text-property pos 'compilation-directory)))))))
1052 (setq file (cons file (car dir)))))
1053 ;; This message didn't mention one, get it from previous
1054 (let ((prev-pos
1055 ;; Find the previous message.
1056 (previous-single-property-change (point) 'compilation-message)))
1057 (if prev-pos
1058 ;; Get the file structure that belongs to it.
1059 (let* ((prev
1060 (or (get-text-property (1- prev-pos) 'compilation-message)
1061 (get-text-property prev-pos 'compilation-message)))
1062 (prev-file-struct
1063 (and prev
1064 (compilation--loc->file-struct
1065 (compilation--message->loc prev)))))
1067 ;; Construct FILE . DIR from that.
1068 (if prev-file-struct
1069 (setq file (cons (caar prev-file-struct)
1070 (cadr (car prev-file-struct)))))))
1071 (unless file
1072 (setq file '("*unknown*")))))
1073 ;; All of these fields are optional, get them only if we have an index, and
1074 ;; it matched some part of the message.
1075 (and line
1076 (setq line (match-string-no-properties line))
1077 (setq line (string-to-number line)))
1078 (and end-line
1079 (setq end-line (match-string-no-properties end-line))
1080 (setq end-line (string-to-number end-line)))
1081 (if col
1082 (if (functionp col)
1083 (setq col (funcall col))
1084 (and
1085 (setq col (match-string-no-properties col))
1086 (setq col (string-to-number col)))))
1087 (if (and end-col (functionp end-col))
1088 (setq end-col (funcall end-col))
1089 (if (and end-col (setq end-col (match-string-no-properties end-col)))
1090 (setq end-col (- (string-to-number end-col) -1))
1091 (if end-line (setq end-col -1))))
1092 (if (consp type) ; not a static type, check what it is.
1093 (setq type (or (and (car type) (match-end (car type)) 1)
1094 (and (cdr type) (match-end (cdr type)) 0)
1095 2)))
1097 (when (and compilation-auto-jump-to-next
1098 (>= type compilation-skip-threshold))
1099 (kill-local-variable 'compilation-auto-jump-to-next)
1100 (run-with-timer 0 nil 'compilation-auto-jump
1101 (current-buffer) (match-beginning 0)))
1103 (compilation-internal-error-properties
1104 file line end-line col end-col type fmt)))
1106 (defun compilation-move-to-column (col screen)
1107 "Go to column COL on the current line.
1108 If SCREEN is non-nil, columns are screen columns, otherwise, they are
1109 just char-counts."
1110 (setq col (- col compilation-first-column))
1111 (if screen
1112 ;; Presumably, the compilation tool doesn't know about our current
1113 ;; `tab-width' setting, so it probably assumed 8-wide TABs (bug#21038).
1114 (let ((tab-width 8)) (move-to-column (max col 0)))
1115 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
1117 (defun compilation-internal-error-properties (file line end-line col end-col type fmts)
1118 "Get the meta-info that will be added as text-properties.
1119 LINE, END-LINE, COL, END-COL are integers or nil.
1120 TYPE can be 0, 1, or 2, meaning error, warning, or just info.
1121 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil.
1122 FMTS is a list of format specs for transforming the file name.
1123 (See `compilation-error-regexp-alist'.)"
1124 (unless file (setq file '("*unknown*")))
1125 (let* ((file-struct (compilation-get-file-structure file fmts))
1126 ;; Get first already existing marker (if any has one, all have one).
1127 ;; Do this first, as the compilation-assq`s may create new nodes.
1128 (marker-line ; a line structure
1129 (cadr (compilation--file-struct->loc-tree file-struct)))
1130 (marker
1131 (if marker-line (compilation--loc->marker (cadr marker-line))))
1132 (screen-columns compilation-error-screen-columns)
1133 (first-column compilation-first-column)
1134 end-marker loc end-loc)
1135 (if (not (and marker (marker-buffer marker)))
1136 (setq marker nil) ; no valid marker for this file
1137 (unless line (setq line 1)) ; normalize no linenumber to line 1
1138 (catch 'marker ; find nearest loc, at least one exists
1139 (dolist (x (cddr (compilation--file-struct->loc-tree
1140 file-struct))) ; Loop over remaining lines.
1141 (if (> (car x) line) ; Still bigger.
1142 (setq marker-line x)
1143 (if (> (- (or (car marker-line) 1) line)
1144 (- line (car x))) ; Current line is nearer.
1145 (setq marker-line x))
1146 (throw 'marker t))))
1147 (setq marker (compilation--loc->marker (cadr marker-line))
1148 marker-line (or (car marker-line) 1))
1149 (with-current-buffer (marker-buffer marker)
1150 (let ((screen-columns
1151 ;; Obey the compilation-error-screen-columns of the target
1152 ;; buffer if its major mode set it buffer-locally.
1153 (if (local-variable-p 'compilation-error-screen-columns)
1154 compilation-error-screen-columns screen-columns))
1155 (compilation-first-column
1156 (if (local-variable-p 'compilation-first-column)
1157 compilation-first-column first-column)))
1158 (save-excursion
1159 (save-restriction
1160 (widen)
1161 (goto-char (marker-position marker))
1162 ;; Set end-marker if appropriate and go to line.
1163 (if (not (or end-col end-line))
1164 (beginning-of-line (- line marker-line -1))
1165 (beginning-of-line (- (or end-line line) marker-line -1))
1166 (if (or (null end-col) (< end-col 0))
1167 (end-of-line)
1168 (compilation-move-to-column end-col screen-columns))
1169 (setq end-marker (point-marker))
1170 (when end-line (beginning-of-line (- line end-line -1))))
1171 (if col
1172 (compilation-move-to-column col screen-columns)
1173 (forward-to-indentation 0))
1174 (setq marker (point-marker)))))))
1176 (setq loc (compilation-assq line (compilation--file-struct->loc-tree
1177 file-struct)))
1178 (setq end-loc
1179 (if end-line
1180 (compilation-assq
1181 end-col (compilation-assq
1182 end-line (compilation--file-struct->loc-tree
1183 file-struct)))
1184 (if end-col ; use same line element
1185 (compilation-assq end-col loc))))
1186 (setq loc (compilation-assq col loc))
1187 ;; If they are new, make the loc(s) reference the file they point to.
1188 ;; FIXME-omake: there's a problem with timestamps here: the markers
1189 ;; relative to which we computed the current `marker' have a timestamp
1190 ;; almost guaranteed to be different from compilation-buffer-modtime, so if
1191 ;; we use their timestamp, we'll never use `loc' since the timestamp won't
1192 ;; match compilation-buffer-modtime, and if we use
1193 ;; compilation-buffer-modtime then we have different timestamps for
1194 ;; locations that were computed together, which doesn't make sense either.
1195 ;; I think this points to a fundamental problem in our approach to the
1196 ;; "omake -P" problem. --Stef
1197 (or (cdr loc)
1198 (setcdr loc (compilation--make-cdrloc line file-struct marker)))
1199 (if end-loc
1200 (or (cdr end-loc)
1201 (setcdr end-loc
1202 (compilation--make-cdrloc (or end-line line) file-struct
1203 end-marker))))
1205 ;; Must start with face
1206 `(font-lock-face ,compilation-message-face
1207 compilation-message ,(compilation--make-message loc type end-loc)
1208 help-echo ,(if col
1209 "mouse-2: visit this file, line and column"
1210 (if line
1211 "mouse-2: visit this file and line"
1212 "mouse-2: visit this file"))
1213 keymap compilation-button-map
1214 mouse-face highlight)))
1216 (defun compilation--put-prop (matchnum prop val)
1217 (when (and (integerp matchnum) (match-beginning matchnum))
1218 (put-text-property
1219 (match-beginning matchnum) (match-end matchnum)
1220 prop val)))
1222 (defun compilation--remove-properties (&optional start end)
1223 (with-silent-modifications
1224 ;; When compile.el used font-lock directly, we could just remove all
1225 ;; our text-properties in one go, but now that we manually place
1226 ;; font-lock-face, we have to be careful to only remove the font-lock-face
1227 ;; we placed.
1228 ;; (remove-list-of-text-properties
1229 ;; (or start (point-min)) (or end (point-max))
1230 ;; '(compilation-debug compilation-directory compilation-message
1231 ;; font-lock-face help-echo mouse-face))
1232 (let (next)
1233 (unless start (setq start (point-min)))
1234 (unless end (setq end (point-max)))
1235 (compilation--flush-directory-cache start end)
1236 (while
1237 (progn
1238 (setq next (or (next-single-property-change
1239 start 'compilation-message nil end)
1240 end))
1241 (when (get-text-property start 'compilation-message)
1242 (remove-list-of-text-properties
1243 start next
1244 '(compilation-debug compilation-directory compilation-message
1245 font-lock-face help-echo mouse-face)))
1246 (< next end))
1247 (setq start next)))))
1249 (defun compilation--parse-region (start end)
1250 (goto-char end)
1251 (unless (bolp)
1252 ;; We generally don't like to parse partial lines.
1253 (cl-assert (eobp))
1254 (when (let ((proc (get-buffer-process (current-buffer))))
1255 (and proc (memq (process-status proc) '(run open))))
1256 (setq end (line-beginning-position))))
1257 (compilation--remove-properties start end)
1258 (if compilation-parse-errors-function
1259 ;; An old package! Try the compatibility code.
1260 (progn
1261 (goto-char start)
1262 (compilation--compat-parse-errors end))
1264 ;; compilation-directory-matcher is the only part that really needs to be
1265 ;; parsed sequentially. So we could split it out, handle directories
1266 ;; like syntax-propertize, and the rest as font-lock-keywords. But since
1267 ;; we want to have it work even when font-lock is off, we'd then need to
1268 ;; use our own compilation-parsed text-property to keep track of the parts
1269 ;; that have already been parsed.
1270 (goto-char start)
1271 (while (re-search-forward (car compilation-directory-matcher)
1272 end t)
1273 (compilation--flush-directory-cache (match-beginning 0) (match-end 0))
1274 (when compilation-debug
1275 (font-lock-append-text-property
1276 (match-beginning 0) (match-end 0)
1277 'compilation-debug
1278 (vector 'directory compilation-directory-matcher)))
1279 (dolist (elt (cdr compilation-directory-matcher))
1280 (add-text-properties (match-beginning (car elt))
1281 (match-end (car elt))
1282 (compilation-directory-properties
1283 (car elt) (cdr elt)))))
1285 (compilation-parse-errors start end)))
1287 (defun compilation-parse-errors (start end &rest rules)
1288 "Parse errors between START and END.
1289 The errors recognized are the ones specified in RULES which default
1290 to `compilation-error-regexp-alist' if RULES is nil."
1291 (dolist (item (or rules compilation-error-regexp-alist))
1292 (if (symbolp item)
1293 (setq item (cdr (assq item
1294 compilation-error-regexp-alist-alist))))
1295 (let ((file (nth 1 item))
1296 (line (nth 2 item))
1297 (col (nth 3 item))
1298 (type (nth 4 item))
1299 (pat (car item))
1300 end-line end-col fmt
1301 props)
1303 ;; omake reports some error indented, so skip the indentation.
1304 ;; another solution is to modify (some?) regexps in
1305 ;; `compilation-error-regexp-alist'.
1306 ;; note that omake usage is not limited to ocaml and C (for stubs).
1307 ;; FIXME-omake: Doing it here seems wrong, at least it should depend on
1308 ;; whether or not omake's own error messages are recognized.
1309 (cond
1310 ((not (memq 'omake compilation-error-regexp-alist)) nil)
1311 ((string-match "\\`\\([^^]\\|\\^\\( \\*\\|\\[\\)\\)" pat)
1312 nil) ;; Not anchored or anchored but already allows empty spaces.
1313 (t (setq pat (concat "^ *" (substring pat 1)))))
1315 (if (consp file) (setq fmt (cdr file) file (car file)))
1316 (if (consp line) (setq end-line (cdr line) line (car line)))
1317 (if (consp col) (setq end-col (cdr col) col (car col)))
1319 (if (functionp line)
1320 ;; The old compile.el had here an undocumented hook that
1321 ;; allowed `line' to be a function that computed the actual
1322 ;; error location. Let's do our best.
1323 (progn
1324 (goto-char start)
1325 (while (re-search-forward pat end t)
1326 (save-match-data
1327 (when compilation-debug
1328 (font-lock-append-text-property
1329 (match-beginning 0) (match-end 0)
1330 'compilation-debug (vector 'functionp item)))
1331 (add-text-properties
1332 (match-beginning 0) (match-end 0)
1333 (compilation--compat-error-properties
1334 (funcall line (cons (match-string file)
1335 (cons default-directory
1336 (nthcdr 4 item)))
1337 (if col (match-string col))))))
1338 (compilation--put-prop
1339 file 'font-lock-face compilation-error-face)))
1341 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
1342 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
1344 (goto-char start)
1345 (while (re-search-forward pat end t)
1346 (when (setq props (compilation-error-properties
1347 file line end-line col end-col (or type 2) fmt))
1349 (when (integerp file)
1350 (compilation--put-prop
1351 file 'font-lock-face
1352 (if (consp type)
1353 (compilation-face type)
1354 (symbol-value (aref [compilation-info-face
1355 compilation-warning-face
1356 compilation-error-face]
1357 (or type 2))))))
1359 (compilation--put-prop
1360 line 'font-lock-face compilation-line-face)
1361 (compilation--put-prop
1362 end-line 'font-lock-face compilation-line-face)
1364 (compilation--put-prop
1365 col 'font-lock-face compilation-column-face)
1366 (compilation--put-prop
1367 end-col 'font-lock-face compilation-column-face)
1369 ;; Obey HIGHLIGHT.
1370 (dolist (extra-item (nthcdr 6 item))
1371 (let ((mn (pop extra-item)))
1372 (when (match-beginning mn)
1373 (let ((face (eval (car extra-item))))
1374 (cond
1375 ((null face))
1376 ((or (symbolp face) (stringp face))
1377 (put-text-property
1378 (match-beginning mn) (match-end mn)
1379 'font-lock-face face))
1380 ((and (listp face)
1381 (eq (car face) 'face)
1382 (or (symbolp (cadr face))
1383 (stringp (cadr face))))
1384 (compilation--put-prop mn 'font-lock-face (cadr face))
1385 (add-text-properties
1386 (match-beginning mn) (match-end mn)
1387 (nthcdr 2 face)))
1389 (error "Don't know how to handle face %S"
1390 face)))))))
1391 (let ((mn (or (nth 5 item) 0)))
1392 (when compilation-debug
1393 (font-lock-append-text-property
1394 (match-beginning 0) (match-end 0)
1395 'compilation-debug (vector 'std item props)))
1396 (add-text-properties
1397 (match-beginning mn) (match-end mn)
1398 (cddr props))
1399 (font-lock-append-text-property
1400 (match-beginning mn) (match-end mn)
1401 'font-lock-face (cadr props)))))))))
1403 (defvar compilation--parsed -1)
1404 (make-variable-buffer-local 'compilation--parsed)
1406 (defun compilation--ensure-parse (limit)
1407 "Make sure the text has been parsed up to LIMIT."
1408 (save-excursion
1409 (goto-char limit)
1410 (setq limit (line-beginning-position 2))
1411 (unless (markerp compilation--parsed)
1412 ;; We use a marker for compilation--parsed so that users (such as
1413 ;; grep.el) don't need to flush-parse when they modify the buffer
1414 ;; in a way that impacts buffer positions but does not require
1415 ;; re-parsing.
1416 (setq compilation--parsed (point-min-marker)))
1417 (when (< compilation--parsed limit)
1418 (let ((start (max compilation--parsed (point-min))))
1419 (move-marker compilation--parsed limit)
1420 (goto-char start)
1421 (forward-line 0) ;Not line-beginning-position: ignore (comint) fields.
1422 (while (and (not (bobp))
1423 (get-text-property (1- (point)) 'compilation-multiline))
1424 (forward-line -1))
1425 (with-silent-modifications
1426 (compilation--parse-region (point) compilation--parsed)))))
1427 nil)
1429 (defun compilation--flush-parse (start _end)
1430 "Mark the region between START and END for re-parsing."
1431 (if (markerp compilation--parsed)
1432 (move-marker compilation--parsed (min start compilation--parsed))))
1434 (defun compilation-mode-font-lock-keywords ()
1435 "Return expressions to highlight in Compilation mode."
1436 (append
1437 '((compilation--ensure-parse))
1438 compilation-mode-font-lock-keywords))
1440 (defun compilation-read-command (command)
1441 (read-shell-command "Compile command: " command
1442 (if (equal (car compile-history) command)
1443 '(compile-history . 1)
1444 'compile-history)))
1447 ;;;###autoload
1448 (defun compile (command &optional comint)
1449 "Compile the program including the current buffer. Default: run `make'.
1450 Runs COMMAND, a shell command, in a separate process asynchronously
1451 with output going to the buffer `*compilation*'.
1453 You can then use the command \\[next-error] to find the next error message
1454 and move to the source code that caused it.
1456 If optional second arg COMINT is t the buffer will be in Comint mode with
1457 `compilation-shell-minor-mode'.
1459 Interactively, prompts for the command if the variable
1460 `compilation-read-command' is non-nil; otherwise uses `compile-command'.
1461 With prefix arg, always prompts.
1462 Additionally, with universal prefix arg, compilation buffer will be in
1463 comint mode, i.e. interactive.
1465 To run more than one compilation at once, start one then rename
1466 the `*compilation*' buffer to some other name with
1467 \\[rename-buffer]. Then _switch buffers_ and start the new compilation.
1468 It will create a new `*compilation*' buffer.
1470 On most systems, termination of the main compilation process
1471 kills its subprocesses.
1473 The name used for the buffer is actually whatever is returned by
1474 the function in `compilation-buffer-name-function', so you can set that
1475 to a function that generates a unique name."
1476 (interactive
1477 (list
1478 (let ((command (eval compile-command)))
1479 (if (or compilation-read-command current-prefix-arg)
1480 (compilation-read-command command)
1481 command))
1482 (consp current-prefix-arg)))
1483 (unless (equal command (eval compile-command))
1484 (setq compile-command command))
1485 (save-some-buffers (not compilation-ask-about-save)
1486 compilation-save-buffers-predicate)
1487 (setq-default compilation-directory default-directory)
1488 (compilation-start command comint))
1490 ;; run compile with the default command line
1491 (defun recompile (&optional edit-command)
1492 "Re-compile the program including the current buffer.
1493 If this is run in a Compilation mode buffer, re-use the arguments from the
1494 original use. Otherwise, recompile using `compile-command'.
1495 If the optional argument `edit-command' is non-nil, the command can be edited."
1496 (interactive "P")
1497 (save-some-buffers (not compilation-ask-about-save)
1498 compilation-save-buffers-predicate)
1499 (let ((default-directory (or compilation-directory default-directory))
1500 (command (eval compile-command)))
1501 (when edit-command
1502 (setq command (compilation-read-command (or (car compilation-arguments)
1503 command)))
1504 (if compilation-arguments (setcar compilation-arguments command)))
1505 (apply 'compilation-start (or compilation-arguments (list command)))))
1507 (defcustom compilation-scroll-output nil
1508 "Non-nil to scroll the *compilation* buffer window as output appears.
1510 Setting it causes the Compilation mode commands to put point at the
1511 end of their output window so that the end of the output is always
1512 visible rather than the beginning.
1514 The value `first-error' stops scrolling at the first error, and leaves
1515 point on its location in the *compilation* buffer."
1516 :type '(choice (const :tag "No scrolling" nil)
1517 (const :tag "Scroll compilation output" t)
1518 (const :tag "Stop scrolling at the first error" first-error))
1519 :version "20.3"
1520 :group 'compilation)
1523 (defun compilation-buffer-name (name-of-mode mode-command name-function)
1524 "Return the name of a compilation buffer to use.
1525 If NAME-FUNCTION is non-nil, call it with one argument NAME-OF-MODE
1526 to determine the buffer name.
1527 Likewise if `compilation-buffer-name-function' is non-nil.
1528 If current buffer has the major mode MODE-COMMAND,
1529 return the name of the current buffer, so that it gets reused.
1530 Otherwise, construct a buffer name from NAME-OF-MODE."
1531 (cond (name-function
1532 (funcall name-function name-of-mode))
1533 (compilation-buffer-name-function
1534 (funcall compilation-buffer-name-function name-of-mode))
1535 ((eq mode-command major-mode)
1536 (buffer-name))
1538 (concat "*" (downcase name-of-mode) "*"))))
1540 (defcustom compilation-always-kill nil
1541 "If t, always kill a running compilation process before starting a new one.
1542 If nil, ask to kill it."
1543 :type 'boolean
1544 :version "24.3"
1545 :group 'compilation)
1547 ;;;###autoload
1548 (defun compilation-start (command &optional mode name-function highlight-regexp)
1549 "Run compilation command COMMAND (low level interface).
1550 If COMMAND starts with a cd command, that becomes the `default-directory'.
1551 The rest of the arguments are optional; for them, nil means use the default.
1553 MODE is the major mode to set in the compilation buffer. Mode
1554 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
1556 If NAME-FUNCTION is non-nil, call it with one argument (the mode name)
1557 to determine the buffer name. Otherwise, the default is to
1558 reuses the current buffer if it has the proper major mode,
1559 else use or create a buffer with name based on the major mode.
1561 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
1562 the matching section of the visited source line; the default is to use the
1563 global value of `compilation-highlight-regexp'.
1565 Returns the compilation buffer created."
1566 (or mode (setq mode 'compilation-mode))
1567 (let* ((name-of-mode
1568 (if (eq mode t)
1569 "compilation"
1570 (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1571 (thisdir default-directory)
1572 (thisenv compilation-environment)
1573 outwin outbuf)
1574 (with-current-buffer
1575 (setq outbuf
1576 (get-buffer-create
1577 (compilation-buffer-name name-of-mode mode name-function)))
1578 (let ((comp-proc (get-buffer-process (current-buffer))))
1579 (if comp-proc
1580 (if (or (not (eq (process-status comp-proc) 'run))
1581 (eq (process-query-on-exit-flag comp-proc) nil)
1582 (yes-or-no-p
1583 (format "A %s process is running; kill it? "
1584 name-of-mode)))
1585 (condition-case ()
1586 (progn
1587 (interrupt-process comp-proc)
1588 (sit-for 1)
1589 (delete-process comp-proc))
1590 (error nil))
1591 (error "Cannot have two processes in `%s' at once"
1592 (buffer-name)))))
1593 ;; first transfer directory from where M-x compile was called
1594 (setq default-directory thisdir)
1595 ;; Make compilation buffer read-only. The filter can still write it.
1596 ;; Clear out the compilation buffer.
1597 (let ((inhibit-read-only t)
1598 (default-directory thisdir))
1599 ;; Then evaluate a cd command if any, but don't perform it yet, else
1600 ;; start-command would do it again through the shell: (cd "..") AND
1601 ;; sh -c "cd ..; make"
1602 (cd (cond
1603 ((not (string-match "\\`\\s *cd\\(?:\\s +\\(\\S +?\\|'[^']*'\\|\"\\(?:[^\"`$\\]\\|\\\\.\\)*\"\\)\\)?\\s *[;&\n]"
1604 command))
1605 default-directory)
1606 ((not (match-end 1)) "~")
1607 ((eq (aref command (match-beginning 1)) ?\')
1608 (substring command (1+ (match-beginning 1))
1609 (1- (match-end 1))))
1610 ((eq (aref command (match-beginning 1)) ?\")
1611 (replace-regexp-in-string
1612 "\\\\\\(.\\)" "\\1"
1613 (substring command (1+ (match-beginning 1))
1614 (1- (match-end 1)))))
1615 ;; Try globbing as well (bug#15417).
1616 (t (let* ((substituted-dir
1617 (substitute-env-vars (match-string 1 command)))
1618 ;; FIXME: This also tries to expand `*' that were
1619 ;; introduced by the envvar expansion!
1620 (expanded-dir
1621 (file-expand-wildcards substituted-dir)))
1622 (if (= (length expanded-dir) 1)
1623 (car expanded-dir)
1624 substituted-dir)))))
1625 (erase-buffer)
1626 ;; Select the desired mode.
1627 (if (not (eq mode t))
1628 (progn
1629 (buffer-disable-undo)
1630 (funcall mode))
1631 (setq buffer-read-only nil)
1632 (with-no-warnings (comint-mode))
1633 (compilation-shell-minor-mode))
1634 ;; Remember the original dir, so we can use it when we recompile.
1635 ;; default-directory' can't be used reliably for that because it may be
1636 ;; affected by the special handling of "cd ...;".
1637 ;; NB: must be done after (funcall mode) as that resets local variables
1638 (set (make-local-variable 'compilation-directory) thisdir)
1639 (set (make-local-variable 'compilation-environment) thisenv)
1640 (if highlight-regexp
1641 (set (make-local-variable 'compilation-highlight-regexp)
1642 highlight-regexp))
1643 (if (or compilation-auto-jump-to-first-error
1644 (eq compilation-scroll-output 'first-error))
1645 (set (make-local-variable 'compilation-auto-jump-to-next) t))
1646 ;; Output a mode setter, for saving and later reloading this buffer.
1647 (insert "-*- mode: " name-of-mode
1648 "; default-directory: "
1649 (prin1-to-string (abbreviate-file-name default-directory))
1650 " -*-\n"
1651 (format "%s started at %s\n\n"
1652 mode-name
1653 (substring (current-time-string) 0 19))
1654 command "\n")
1655 (setq thisdir default-directory))
1656 (set-buffer-modified-p nil))
1657 ;; Pop up the compilation buffer.
1658 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01638.html
1659 (setq outwin (display-buffer outbuf '(nil (allow-no-window . t))))
1660 (with-current-buffer outbuf
1661 (let ((process-environment
1662 (append
1663 compilation-environment
1664 (if (if (boundp 'system-uses-terminfo);`If' for compiler warning.
1665 system-uses-terminfo)
1666 (list "TERM=dumb" "TERMCAP="
1667 (format "COLUMNS=%d" (window-width)))
1668 (list "TERM=emacs"
1669 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1670 (window-width))))
1671 (list (format "INSIDE_EMACS=%s,compile" emacs-version))
1672 (copy-sequence process-environment))))
1673 (set (make-local-variable 'compilation-arguments)
1674 (list command mode name-function highlight-regexp))
1675 (set (make-local-variable 'revert-buffer-function)
1676 'compilation-revert-buffer)
1677 (and outwin
1678 ;; Forcing the window-start overrides the usual redisplay
1679 ;; feature of bringing point into view, so setting the
1680 ;; window-start to top of the buffer risks losing the
1681 ;; effect of moving point to EOB below, per
1682 ;; compilation-scroll-output, if the command is long
1683 ;; enough to push point outside of the window. This
1684 ;; could happen, e.g., in `rgrep'.
1685 (not compilation-scroll-output)
1686 (set-window-start outwin (point-min)))
1688 ;; Position point as the user will see it.
1689 (let ((desired-visible-point
1690 ;; Put it at the end if `compilation-scroll-output' is set.
1691 (if compilation-scroll-output
1692 (point-max)
1693 ;; Normally put it at the top.
1694 (point-min))))
1695 (goto-char desired-visible-point)
1696 (when (and outwin (not (eq outwin (selected-window))))
1697 (set-window-point outwin desired-visible-point)))
1699 ;; The setup function is called before compilation-set-window-height
1700 ;; so it can set the compilation-window-height buffer locally.
1701 (if compilation-process-setup-function
1702 (funcall compilation-process-setup-function))
1703 (and outwin (compilation-set-window-height outwin))
1704 ;; Start the compilation.
1705 (if (fboundp 'start-process)
1706 (let ((proc
1707 (if (eq mode t)
1708 ;; comint uses `start-file-process'.
1709 (get-buffer-process
1710 (with-no-warnings
1711 (comint-exec
1712 outbuf (downcase mode-name)
1713 (if (file-remote-p default-directory)
1714 "/bin/sh"
1715 shell-file-name)
1716 nil `("-c" ,command))))
1717 (start-file-process-shell-command (downcase mode-name)
1718 outbuf command))))
1719 ;; Make the buffer's mode line show process state.
1720 (setq mode-line-process
1721 '(:propertize ":%s" face compilation-mode-line-run))
1723 ;; Set the process as killable without query by default.
1724 ;; This allows us to start a new compilation without
1725 ;; getting prompted.
1726 (when compilation-always-kill
1727 (set-process-query-on-exit-flag proc nil))
1729 (set-process-sentinel proc 'compilation-sentinel)
1730 (unless (eq mode t)
1731 ;; Keep the comint filter, since it's needed for proper
1732 ;; handling of the prompts.
1733 (set-process-filter proc 'compilation-filter))
1734 ;; Use (point-max) here so that output comes in
1735 ;; after the initial text,
1736 ;; regardless of where the user sees point.
1737 (set-marker (process-mark proc) (point-max) outbuf)
1738 (when compilation-disable-input
1739 (condition-case nil
1740 (process-send-eof proc)
1741 ;; The process may have exited already.
1742 (error nil)))
1743 (run-hook-with-args 'compilation-start-hook proc)
1744 (setq compilation-in-progress
1745 (cons proc compilation-in-progress)))
1746 ;; No asynchronous processes available.
1747 (message "Executing `%s'..." command)
1748 ;; Fake mode line display as if `start-process' were run.
1749 (setq mode-line-process
1750 '(:propertize ":run" face compilation-mode-line-run))
1751 (force-mode-line-update)
1752 (sit-for 0) ; Force redisplay
1753 (save-excursion
1754 ;; Insert the output at the end, after the initial text,
1755 ;; regardless of where the user sees point.
1756 (goto-char (point-max))
1757 (let* ((inhibit-read-only t) ; call-process needs to modify outbuf
1758 (compilation-filter-start (point))
1759 (status (call-process shell-file-name nil outbuf nil "-c"
1760 command)))
1761 (run-hooks 'compilation-filter-hook)
1762 (cond ((numberp status)
1763 (compilation-handle-exit
1764 'exit status
1765 (if (zerop status)
1766 "finished\n"
1767 (format "exited abnormally with code %d\n" status))))
1768 ((stringp status)
1769 (compilation-handle-exit 'signal status
1770 (concat status "\n")))
1772 (compilation-handle-exit 'bizarre status status)))))
1773 (set-buffer-modified-p nil)
1774 (message "Executing `%s'...done" command)))
1775 ;; Now finally cd to where the shell started make/grep/...
1776 (setq default-directory thisdir)
1777 ;; The following form selected outwin ever since revision 1.183,
1778 ;; so possibly messing up point in some other window (bug#1073).
1779 ;; Moved into the scope of with-current-buffer, though still with
1780 ;; complete disregard for the case when compilation-scroll-output
1781 ;; equals 'first-error (martin 2008-10-04).
1782 (when compilation-scroll-output
1783 (goto-char (point-max))))
1785 ;; Make it so the next C-x ` will use this buffer.
1786 (setq next-error-last-buffer outbuf)))
1788 (defun compilation-set-window-height (window)
1789 "Set the height of WINDOW according to `compilation-window-height'."
1790 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1791 (and height
1792 (window-full-width-p window)
1793 ;; If window is alone in its frame, aside from a minibuffer,
1794 ;; don't change its height.
1795 (not (eq window (frame-root-window (window-frame window))))
1796 ;; Stef said that doing the saves in this order is safer:
1797 (save-excursion
1798 (save-selected-window
1799 (select-window window)
1800 (enlarge-window (- height (window-height))))))))
1802 (defvar compilation-menu-map
1803 (let ((map (make-sparse-keymap "Errors"))
1804 (opt-map (make-sparse-keymap "Skip")))
1805 (define-key map [stop-subjob]
1806 '(menu-item "Stop Compilation" kill-compilation
1807 :help "Kill the process made by the M-x compile or M-x grep commands"))
1808 (define-key map [compilation-mode-separator3]
1809 '("----" . nil))
1810 (define-key map [compilation-next-error-follow-minor-mode]
1811 '(menu-item
1812 "Auto Error Display" next-error-follow-minor-mode
1813 :help "Display the error under cursor when moving the cursor"
1814 :button (:toggle . next-error-follow-minor-mode)))
1815 (define-key map [compilation-skip]
1816 (cons "Skip Less Important Messages" opt-map))
1817 (define-key opt-map [compilation-skip-none]
1818 '(menu-item "Don't Skip Any Messages"
1819 (lambda ()
1820 (interactive)
1821 (customize-set-variable 'compilation-skip-threshold 0))
1822 :help "Do not skip any type of messages"
1823 :button (:radio . (eq compilation-skip-threshold 0))))
1824 (define-key opt-map [compilation-skip-info]
1825 '(menu-item "Skip Info"
1826 (lambda ()
1827 (interactive)
1828 (customize-set-variable 'compilation-skip-threshold 1))
1829 :help "Skip anything less than warning"
1830 :button (:radio . (eq compilation-skip-threshold 1))))
1831 (define-key opt-map [compilation-skip-warning-and-info]
1832 '(menu-item "Skip Warnings and Info"
1833 (lambda ()
1834 (interactive)
1835 (customize-set-variable 'compilation-skip-threshold 2))
1836 :help "Skip over Warnings and Info, stop for errors"
1837 :button (:radio . (eq compilation-skip-threshold 2))))
1838 (define-key map [compilation-mode-separator2]
1839 '("----" . nil))
1840 (define-key map [compilation-first-error]
1841 '(menu-item "First Error" first-error
1842 :help "Restart at the first error, visit corresponding source code"))
1843 (define-key map [compilation-previous-error]
1844 '(menu-item "Previous Error" previous-error
1845 :help "Visit previous `next-error' message and corresponding source code"))
1846 (define-key map [compilation-next-error]
1847 '(menu-item "Next Error" next-error
1848 :help "Visit next `next-error' message and corresponding source code"))
1849 map))
1851 (defvar compilation-minor-mode-map
1852 (let ((map (make-sparse-keymap)))
1853 (set-keymap-parent map special-mode-map)
1854 (define-key map [mouse-2] 'compile-goto-error)
1855 (define-key map [follow-link] 'mouse-face)
1856 (define-key map "\C-c\C-c" 'compile-goto-error)
1857 (define-key map "\C-m" 'compile-goto-error)
1858 (define-key map "\C-o" 'compilation-display-error)
1859 (define-key map "\C-c\C-k" 'kill-compilation)
1860 (define-key map "\M-n" 'compilation-next-error)
1861 (define-key map "\M-p" 'compilation-previous-error)
1862 (define-key map "\M-{" 'compilation-previous-file)
1863 (define-key map "\M-}" 'compilation-next-file)
1864 (define-key map "g" 'recompile) ; revert
1865 ;; Set up the menu-bar
1866 (define-key map [menu-bar compilation]
1867 (cons "Errors" compilation-menu-map))
1868 map)
1869 "Keymap for `compilation-minor-mode'.")
1871 (defvar compilation-shell-minor-mode-map
1872 (let ((map (make-sparse-keymap)))
1873 (define-key map "\M-\C-m" 'compile-goto-error)
1874 (define-key map "\M-\C-n" 'compilation-next-error)
1875 (define-key map "\M-\C-p" 'compilation-previous-error)
1876 (define-key map "\M-{" 'compilation-previous-file)
1877 (define-key map "\M-}" 'compilation-next-file)
1878 ;; Set up the menu-bar
1879 (define-key map [menu-bar compilation]
1880 (cons "Errors" compilation-menu-map))
1881 map)
1882 "Keymap for `compilation-shell-minor-mode'.")
1884 (defvar compilation-button-map
1885 (let ((map (make-sparse-keymap)))
1886 (define-key map [mouse-2] 'compile-goto-error)
1887 (define-key map [follow-link] 'mouse-face)
1888 (define-key map "\C-m" 'compile-goto-error)
1889 map)
1890 "Keymap for compilation-message buttons.")
1891 (fset 'compilation-button-map compilation-button-map)
1893 (defvar compilation-mode-map
1894 (let ((map (make-sparse-keymap)))
1895 ;; Don't inherit from compilation-minor-mode-map,
1896 ;; because that introduces a menu bar item we don't want.
1897 ;; That confuses C-down-mouse-3.
1898 (set-keymap-parent map special-mode-map)
1899 (define-key map [mouse-2] 'compile-goto-error)
1900 (define-key map [follow-link] 'mouse-face)
1901 (define-key map "\C-c\C-c" 'compile-goto-error)
1902 (define-key map "\C-m" 'compile-goto-error)
1903 (define-key map "\C-o" 'compilation-display-error)
1904 (define-key map "\C-c\C-k" 'kill-compilation)
1905 (define-key map "\M-n" 'compilation-next-error)
1906 (define-key map "\M-p" 'compilation-previous-error)
1907 (define-key map "\M-{" 'compilation-previous-file)
1908 (define-key map "\M-}" 'compilation-next-file)
1909 (define-key map "\t" 'compilation-next-error)
1910 (define-key map [backtab] 'compilation-previous-error)
1911 (define-key map "g" 'recompile) ; revert
1913 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1915 ;; Set up the menu-bar
1916 (let ((submap (make-sparse-keymap "Compile")))
1917 (define-key map [menu-bar compilation]
1918 (cons "Compile" submap))
1919 (set-keymap-parent submap compilation-menu-map))
1920 (define-key map [menu-bar compilation compilation-separator2]
1921 '("----" . nil))
1922 (define-key map [menu-bar compilation compilation-grep]
1923 '(menu-item "Search Files (grep)..." grep
1924 :help "Run grep, with user-specified args, and collect output in a buffer"))
1925 (define-key map [menu-bar compilation compilation-recompile]
1926 '(menu-item "Recompile" recompile
1927 :help "Re-compile the program including the current buffer"))
1928 (define-key map [menu-bar compilation compilation-compile]
1929 '(menu-item "Compile..." compile
1930 :help "Compile the program including the current buffer. Default: run `make'"))
1931 map)
1932 "Keymap for compilation log buffers.
1933 `compilation-minor-mode-map' is a parent of this.")
1935 (defvar compilation-mode-tool-bar-map
1936 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
1937 ;; so don't do anything.
1938 (when (keymapp tool-bar-map)
1939 (let ((map (copy-keymap tool-bar-map)))
1940 (define-key map [undo] nil)
1941 (define-key map [separator-2] nil)
1942 (define-key-after map [separator-compile] menu-bar-separator)
1943 (tool-bar-local-item
1944 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
1945 :rtl "right-arrow"
1946 :help "Goto previous error")
1947 (tool-bar-local-item
1948 "right-arrow" 'next-error-no-select 'next-error-no-select map
1949 :rtl "left-arrow"
1950 :help "Goto next error")
1951 (tool-bar-local-item
1952 "cancel" 'kill-compilation 'kill-compilation map
1953 :enable '(let ((buffer (compilation-find-buffer)))
1954 (get-buffer-process buffer))
1955 :help "Stop compilation")
1956 (tool-bar-local-item
1957 "refresh" 'recompile 'recompile map
1958 :help "Restart compilation")
1959 map)))
1961 (put 'compilation-mode 'mode-class 'special)
1963 ;;;###autoload
1964 (defun compilation-mode (&optional name-of-mode)
1965 "Major mode for compilation log buffers.
1966 \\<compilation-mode-map>To visit the source for a line-numbered error,
1967 move point to the error message line and type \\[compile-goto-error].
1968 To kill the compilation, type \\[kill-compilation].
1970 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
1972 \\{compilation-mode-map}"
1973 (interactive)
1974 (kill-all-local-variables)
1975 (use-local-map compilation-mode-map)
1976 ;; Let windows scroll along with the output.
1977 (set (make-local-variable 'window-point-insertion-type) t)
1978 (set (make-local-variable 'tool-bar-map) compilation-mode-tool-bar-map)
1979 (setq major-mode 'compilation-mode ; FIXME: Use define-derived-mode.
1980 mode-name (or name-of-mode "Compilation"))
1981 (set (make-local-variable 'page-delimiter)
1982 compilation-page-delimiter)
1983 ;; (set (make-local-variable 'compilation-buffer-modtime) nil)
1984 (compilation-setup)
1985 ;; Turn off deferred fontifications in the compilation buffer, if
1986 ;; the user turned them on globally. This is because idle timers
1987 ;; aren't re-run after receiving input from a subprocess, so the
1988 ;; buffer is left unfontified after the compilation exits, until
1989 ;; some other input event happens.
1990 (set (make-local-variable 'jit-lock-defer-time) nil)
1991 (setq buffer-read-only t)
1992 (run-mode-hooks 'compilation-mode-hook))
1994 ;;;###autoload
1995 (put 'define-compilation-mode 'doc-string-elt 3)
1997 (defmacro define-compilation-mode (mode name doc &rest body)
1998 "This is like `define-derived-mode' without the PARENT argument.
1999 The parent is always `compilation-mode' and the customizable `compilation-...'
2000 variables are also set from the name of the mode you have chosen,
2001 by replacing the first word, e.g., `compilation-scroll-output' from
2002 `grep-scroll-output' if that variable exists."
2003 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
2004 `(define-derived-mode ,mode compilation-mode ,name
2005 ,doc
2006 ,@(mapcar (lambda (v)
2007 (setq v (cons v
2008 (intern-soft (replace-regexp-in-string
2009 "^compilation" mode-name
2010 (symbol-name v)))))
2011 (and (cdr v)
2012 (or (boundp (cdr v))
2013 ;; FIXME: This is hackish, using undocumented info.
2014 (if (boundp 'byte-compile-bound-variables)
2015 (memq (cdr v) byte-compile-bound-variables)))
2016 `(set (make-local-variable ',(car v)) ,(cdr v))))
2017 '(compilation-buffer-name-function
2018 compilation-directory-matcher
2019 compilation-error
2020 compilation-error-regexp-alist
2021 compilation-error-regexp-alist-alist
2022 compilation-error-screen-columns
2023 compilation-finish-function
2024 compilation-finish-functions
2025 compilation-first-column
2026 compilation-mode-font-lock-keywords
2027 compilation-page-delimiter
2028 compilation-parse-errors-filename-function
2029 compilation-process-setup-function
2030 compilation-scroll-output
2031 compilation-search-path
2032 compilation-skip-threshold
2033 compilation-window-height))
2034 ,@body)))
2036 (defun compilation-revert-buffer (ignore-auto noconfirm)
2037 (if buffer-file-name
2038 (let (revert-buffer-function)
2039 (revert-buffer ignore-auto noconfirm))
2040 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
2041 (apply 'compilation-start compilation-arguments))))
2043 (defvar compilation-current-error nil
2044 "Marker to the location from where the next error will be found.
2045 The global commands next/previous/first-error/goto-error use this.")
2047 (defvar compilation-messages-start nil
2048 "Buffer position of the beginning of the compilation messages.
2049 If nil, use the beginning of buffer.")
2051 (defun compilation-setup (&optional minor)
2052 "Prepare the buffer for the compilation parsing commands to work.
2053 Optional argument MINOR indicates this is called from
2054 `compilation-minor-mode'."
2055 (make-local-variable 'compilation-current-error)
2056 (make-local-variable 'compilation-messages-start)
2057 (make-local-variable 'compilation-error-screen-columns)
2058 (make-local-variable 'overlay-arrow-position)
2059 (set (make-local-variable 'overlay-arrow-string) "")
2060 (setq next-error-overlay-arrow-position nil)
2061 (add-hook 'kill-buffer-hook
2062 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
2063 ;; Note that compilation-next-error-function is for interfacing
2064 ;; with the next-error function in simple.el, and it's only
2065 ;; coincidentally named similarly to compilation-next-error.
2066 (setq next-error-function 'compilation-next-error-function)
2067 (set (make-local-variable 'comint-file-name-prefix)
2068 (or (file-remote-p default-directory) ""))
2069 (set (make-local-variable 'compilation-locs)
2070 (make-hash-table :test 'equal :weakness 'value))
2071 ;; It's generally preferable to use after-change-functions since they
2072 ;; can be subject to combine-after-change-calls, but if we do that, we risk
2073 ;; running our hook after font-lock, resulting in incorrect refontification.
2074 (add-hook 'before-change-functions 'compilation--flush-parse nil t)
2075 ;; Also for minor mode, since it's not permanent-local.
2076 (add-hook 'change-major-mode-hook #'compilation--remove-properties nil t)
2077 (if minor
2078 (progn
2079 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
2080 (font-lock-flush))
2081 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))))
2083 (defun compilation--unsetup ()
2084 ;; Only for minor mode.
2085 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
2086 (remove-hook 'before-change-functions 'compilation--flush-parse t)
2087 (kill-local-variable 'compilation--parsed)
2088 (compilation--remove-properties)
2089 (font-lock-flush))
2091 ;;;###autoload
2092 (define-minor-mode compilation-shell-minor-mode
2093 "Toggle Compilation Shell minor mode.
2094 With a prefix argument ARG, enable Compilation Shell minor mode
2095 if ARG is positive, and disable it otherwise. If called from
2096 Lisp, enable the mode if ARG is omitted or nil.
2098 When Compilation Shell minor mode is enabled, all the
2099 error-parsing commands of the Compilation major mode are
2100 available but bound to keys that don't collide with Shell mode.
2101 See `compilation-mode'."
2102 nil " Shell-Compile"
2103 :group 'compilation
2104 (if compilation-shell-minor-mode
2105 (compilation-setup t)
2106 (compilation--unsetup)))
2108 ;;;###autoload
2109 (define-minor-mode compilation-minor-mode
2110 "Toggle Compilation minor mode.
2111 With a prefix argument ARG, enable Compilation minor mode if ARG
2112 is positive, and disable it otherwise. If called from Lisp,
2113 enable the mode if ARG is omitted or nil.
2115 When Compilation minor mode is enabled, all the error-parsing
2116 commands of Compilation major mode are available. See
2117 `compilation-mode'."
2118 nil " Compilation"
2119 :group 'compilation
2120 (if compilation-minor-mode
2121 (compilation-setup t)
2122 (compilation--unsetup)))
2124 (defun compilation-handle-exit (process-status exit-status msg)
2125 "Write MSG in the current buffer and hack its `mode-line-process'."
2126 (let ((inhibit-read-only t)
2127 (status (if compilation-exit-message-function
2128 (funcall compilation-exit-message-function
2129 process-status exit-status msg)
2130 (cons msg exit-status)))
2131 (omax (point-max))
2132 (opoint (point))
2133 (cur-buffer (current-buffer)))
2134 ;; Record where we put the message, so we can ignore it later on.
2135 (goto-char omax)
2136 (insert ?\n mode-name " " (car status))
2137 (if (and (numberp compilation-window-height)
2138 (zerop compilation-window-height))
2139 (message "%s" (cdr status)))
2140 (if (bolp)
2141 (forward-char -1))
2142 (insert " at " (substring (current-time-string) 0 19))
2143 (goto-char (point-max))
2144 ;; Prevent that message from being recognized as a compilation error.
2145 (add-text-properties omax (point)
2146 (append '(compilation-handle-exit t) nil))
2147 (setq mode-line-process
2148 (let ((out-string (format ":%s [%s]" process-status (cdr status)))
2149 (msg (format "%s %s" mode-name
2150 (replace-regexp-in-string "\n?$" ""
2151 (car status)))))
2152 (message "%s" msg)
2153 (propertize out-string
2154 'help-echo msg
2155 'face (if (> exit-status 0)
2156 'compilation-mode-line-fail
2157 'compilation-mode-line-exit))))
2158 ;; Force mode line redisplay soon.
2159 (force-mode-line-update)
2160 (if (and opoint (< opoint omax))
2161 (goto-char opoint))
2162 (with-no-warnings
2163 (if compilation-finish-function
2164 (funcall compilation-finish-function cur-buffer msg)))
2165 (run-hook-with-args 'compilation-finish-functions cur-buffer msg)))
2167 ;; Called when compilation process changes state.
2168 (defun compilation-sentinel (proc msg)
2169 "Sentinel for compilation buffers."
2170 (if (memq (process-status proc) '(exit signal))
2171 (let ((buffer (process-buffer proc)))
2172 (if (null (buffer-name buffer))
2173 ;; buffer killed
2174 (set-process-buffer proc nil)
2175 (with-current-buffer buffer
2176 ;; Write something in the compilation buffer
2177 ;; and hack its mode line.
2178 (compilation-handle-exit (process-status proc)
2179 (process-exit-status proc)
2180 msg)
2181 ;; Since the buffer and mode line will show that the
2182 ;; process is dead, we can delete it now. Otherwise it
2183 ;; will stay around until M-x list-processes.
2184 (delete-process proc)))
2185 (setq compilation-in-progress (delq proc compilation-in-progress)))))
2187 (defun compilation-filter (proc string)
2188 "Process filter for compilation buffers.
2189 Just inserts the text,
2190 handles carriage motion (see `comint-inhibit-carriage-motion'),
2191 and runs `compilation-filter-hook'."
2192 (when (buffer-live-p (process-buffer proc))
2193 (with-current-buffer (process-buffer proc)
2194 (let ((inhibit-read-only t)
2195 ;; `save-excursion' doesn't use the right insertion-type for us.
2196 (pos (copy-marker (point) t))
2197 ;; `save-restriction' doesn't use the right insertion type either:
2198 ;; If we are inserting at the end of the accessible part of the
2199 ;; buffer, keep the inserted text visible.
2200 (min (point-min-marker))
2201 (max (copy-marker (point-max) t))
2202 (compilation-filter-start (marker-position (process-mark proc))))
2203 (unwind-protect
2204 (progn
2205 (widen)
2206 (goto-char compilation-filter-start)
2207 ;; We used to use `insert-before-markers', so that windows with
2208 ;; point at `process-mark' scroll along with the output, but we
2209 ;; now use window-point-insertion-type instead.
2210 (insert string)
2211 (unless comint-inhibit-carriage-motion
2212 (comint-carriage-motion (process-mark proc) (point)))
2213 (set-marker (process-mark proc) (point))
2214 ;; (set (make-local-variable 'compilation-buffer-modtime)
2215 ;; (current-time))
2216 (run-hooks 'compilation-filter-hook))
2217 (goto-char pos)
2218 (narrow-to-region min max)
2219 (set-marker pos nil)
2220 (set-marker min nil)
2221 (set-marker max nil))))))
2223 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
2224 (defsubst compilation-buffer-internal-p ()
2225 "Test if inside a compilation buffer."
2226 (local-variable-p 'compilation-locs))
2228 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
2229 (defsubst compilation-buffer-p (buffer)
2230 "Test if BUFFER is a compilation buffer."
2231 (with-current-buffer buffer
2232 (compilation-buffer-internal-p)))
2234 (defmacro compilation-loop (< property-change 1+ error limit)
2235 `(let (opt)
2236 (while (,< n 0)
2237 (setq opt pt)
2238 (or (setq pt (,property-change pt 'compilation-message))
2239 ;; Handle the case where where the first error message is
2240 ;; at the start of the buffer, and n < 0.
2241 (if (or (eq (get-text-property ,limit 'compilation-message)
2242 (get-text-property opt 'compilation-message))
2243 (eq pt opt))
2244 (user-error ,error compilation-error)
2245 (setq pt ,limit)))
2246 ;; prop 'compilation-message usually has 2 changes, on and off, so
2247 ;; re-search if off
2248 (or (setq msg (get-text-property pt 'compilation-message))
2249 (if (setq pt (,property-change pt 'compilation-message nil ,limit))
2250 (setq msg (get-text-property pt 'compilation-message)))
2251 (user-error ,error compilation-error))
2252 (or (< (compilation--message->type msg) compilation-skip-threshold)
2253 (if different-file
2254 (eq (prog1 last
2255 (setq last (compilation--loc->file-struct
2256 (compilation--message->loc msg))))
2257 last))
2258 (if compilation-skip-visited
2259 (compilation--loc->visited (compilation--message->loc msg)))
2260 (if compilation-skip-to-next-location
2261 (eq (compilation--message->loc msg) loc))
2262 ;; count this message only if none of the above are true
2263 (setq n (,1+ n))))))
2265 (defun compilation-next-single-property-change (position prop
2266 &optional object limit)
2267 (let (parsed res)
2268 (while (progn
2269 ;; We parse the buffer here "on-demand" by chunks of 500 chars.
2270 ;; But we could also just parse the whole buffer.
2271 (compilation--ensure-parse
2272 (setq parsed (max compilation--parsed
2273 (min (+ position 500)
2274 (or limit (point-max))))))
2275 (and (or (not (setq res (next-single-property-change
2276 position prop object limit)))
2277 (eq res limit))
2278 (< position (or limit (point-max)))))
2279 (setq position parsed))
2280 res))
2282 (defun compilation-next-error (n &optional different-file pt)
2283 "Move point to the next error in the compilation buffer.
2284 This function does NOT find the source line like \\[next-error].
2285 Prefix arg N says how many error messages to move forwards (or
2286 backwards, if negative).
2287 Optional arg DIFFERENT-FILE, if non-nil, means find next error for a
2288 file that is different from the current one.
2289 Optional arg PT, if non-nil, specifies the value of point to start
2290 looking for the next message."
2291 (interactive "p")
2292 (or (compilation-buffer-p (current-buffer))
2293 (error "Not in a compilation buffer"))
2294 (or pt (setq pt (point)))
2295 (compilation--ensure-parse pt)
2296 (let* ((msg (get-text-property pt 'compilation-message))
2297 ;; `loc', `msg', and `last' are used by the compilation-loop macro.
2298 (loc (and msg (compilation--message->loc msg)))
2299 last)
2300 (if (zerop n)
2301 (unless (or msg ; find message near here
2302 (setq msg (get-text-property (max (1- pt) (point-min))
2303 'compilation-message)))
2304 (setq pt (previous-single-property-change pt 'compilation-message nil
2305 (line-beginning-position)))
2306 (unless (setq msg (get-text-property (max (1- pt) (point-min))
2307 'compilation-message))
2308 (setq pt (compilation-next-single-property-change
2309 pt 'compilation-message nil
2310 (line-end-position)))
2311 (or (setq msg (get-text-property pt 'compilation-message))
2312 (setq pt (point)))))
2313 (setq last (compilation--loc->file-struct loc))
2314 (if (>= n 0)
2315 (compilation-loop > compilation-next-single-property-change 1-
2316 (if (get-buffer-process (current-buffer))
2317 "No more %ss yet"
2318 "Moved past last %s")
2319 (point-max))
2320 ;; Don't move "back" to message at or before point.
2321 ;; Pass an explicit (point-min) to make sure pt is non-nil.
2322 (setq pt (previous-single-property-change
2323 pt 'compilation-message nil (point-min)))
2324 (compilation-loop < previous-single-property-change 1+
2325 "Moved back before first %s" (point-min))))
2326 (goto-char pt)
2327 (or msg
2328 (error "No %s here" compilation-error))))
2330 (defun compilation-previous-error (n)
2331 "Move point to the previous error in the compilation buffer.
2332 Prefix arg N says how many error messages to move backwards (or
2333 forwards, if negative).
2334 Does NOT find the source line like \\[previous-error]."
2335 (interactive "p")
2336 (compilation-next-error (- n)))
2338 (defun compilation-next-file (n)
2339 "Move point to the next error for a different file than the current one.
2340 Prefix arg N says how many files to move forwards (or backwards, if negative)."
2341 (interactive "p")
2342 (compilation-next-error n t))
2344 (defun compilation-previous-file (n)
2345 "Move point to the previous error for a different file than the current one.
2346 Prefix arg N says how many files to move backwards (or forwards, if negative)."
2347 (interactive "p")
2348 (compilation-next-file (- n)))
2350 (defun compilation-display-error ()
2351 "Display the source for current error in another window."
2352 (interactive)
2353 (setq compilation-current-error (point))
2354 (next-error-no-select 0))
2356 (defun kill-compilation ()
2357 "Kill the process made by the \\[compile] or \\[grep] commands."
2358 (interactive)
2359 (let ((buffer (compilation-find-buffer)))
2360 (if (get-buffer-process buffer)
2361 (interrupt-process (get-buffer-process buffer))
2362 (error "The %s process is not running" (downcase mode-name)))))
2364 (defalias 'compile-mouse-goto-error 'compile-goto-error)
2366 (defun compile-goto-error (&optional event)
2367 "Visit the source for the error message at point.
2368 Use this command in a compilation log buffer."
2369 (interactive (list last-input-event))
2370 (if event (posn-set-point (event-end event)))
2371 (or (compilation-buffer-p (current-buffer))
2372 (error "Not in a compilation buffer"))
2373 (compilation--ensure-parse (point))
2374 (if (get-text-property (point) 'compilation-directory)
2375 (dired-other-window
2376 (car (get-text-property (point) 'compilation-directory)))
2377 (setq compilation-current-error (point))
2378 (next-error-internal)))
2380 ;; This is mostly unused, but we keep it for the sake of some external
2381 ;; packages which seem to make use of it.
2382 (defun compilation-find-buffer (&optional avoid-current)
2383 "Return a compilation buffer.
2384 If AVOID-CURRENT is nil, and the current buffer is a compilation buffer,
2385 return it. If AVOID-CURRENT is non-nil, return the current buffer only
2386 as a last resort."
2387 (if (and (compilation-buffer-internal-p) (not avoid-current))
2388 (current-buffer)
2389 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)))
2391 ;;;###autoload
2392 (defun compilation-next-error-function (n &optional reset)
2393 "Advance to the next error message and visit the file where the error was.
2394 This is the value of `next-error-function' in Compilation buffers."
2395 (interactive "p")
2396 (when reset
2397 (setq compilation-current-error nil))
2398 (let* ((screen-columns compilation-error-screen-columns)
2399 (first-column compilation-first-column)
2400 (last 1)
2401 (msg (compilation-next-error (or n 1) nil
2402 (or compilation-current-error
2403 compilation-messages-start
2404 (point-min))))
2405 (loc (compilation--message->loc msg))
2406 (end-loc (compilation--message->end-loc msg))
2407 (marker (point-marker)))
2408 (setq compilation-current-error (point-marker)
2409 overlay-arrow-position
2410 (if (bolp)
2411 compilation-current-error
2412 (copy-marker (line-beginning-position))))
2413 ;; If loc contains no marker, no error in that file has been visited.
2414 ;; If the marker is invalid the buffer has been killed.
2415 ;; So, recalculate all markers for that file.
2416 (unless (and (compilation--loc->marker loc)
2417 (marker-buffer (compilation--loc->marker loc))
2418 ;; FIXME-omake: For "omake -P", which automatically recompiles
2419 ;; when the file is modified, the line numbers of new output
2420 ;; may not be related to line numbers from earlier output
2421 ;; (earlier markers), so we used to try to detect it here and
2422 ;; force a reparse. But that caused more problems elsewhere,
2423 ;; so instead we now flush the file-structure when we see
2424 ;; omake's message telling it's about to recompile a file.
2425 ;; (or (null (compilation--loc->timestamp loc)) ;A fake-loc
2426 ;; (equal (compilation--loc->timestamp loc)
2427 ;; (setq timestamp compilation-buffer-modtime)))
2429 (with-current-buffer
2430 (apply #'compilation-find-file
2431 marker
2432 (caar (compilation--loc->file-struct loc))
2433 (cadr (car (compilation--loc->file-struct loc)))
2434 (compilation--file-struct->formats
2435 (compilation--loc->file-struct loc)))
2436 (let ((screen-columns
2437 ;; Obey the compilation-error-screen-columns of the target
2438 ;; buffer if its major mode set it buffer-locally.
2439 (if (local-variable-p 'compilation-error-screen-columns)
2440 compilation-error-screen-columns screen-columns))
2441 (compilation-first-column
2442 (if (local-variable-p 'compilation-first-column)
2443 compilation-first-column first-column)))
2444 (save-restriction
2445 (widen)
2446 (goto-char (point-min))
2447 ;; Treat file's found lines in forward order, 1 by 1.
2448 (dolist (line (reverse (cddr (compilation--loc->file-struct loc))))
2449 (when (car line) ; else this is a filename w/o a line#
2450 (beginning-of-line (- (car line) last -1))
2451 (setq last (car line)))
2452 ;; Treat line's found columns and store/update a marker for each.
2453 (dolist (col (cdr line))
2454 (if (compilation--loc->col col)
2455 (if (eq (compilation--loc->col col) -1)
2456 ;; Special case for range end.
2457 (end-of-line)
2458 (compilation-move-to-column (compilation--loc->col col)
2459 screen-columns))
2460 (beginning-of-line)
2461 (skip-chars-forward " \t"))
2462 (if (compilation--loc->marker col)
2463 (set-marker (compilation--loc->marker col) (point))
2464 (setf (compilation--loc->marker col) (point-marker)))
2465 ;; (setf (compilation--loc->timestamp col) timestamp)
2466 ))))))
2467 (compilation-goto-locus marker (compilation--loc->marker loc)
2468 (compilation--loc->marker end-loc))
2469 (setf (compilation--loc->visited loc) t)))
2471 (defvar compilation-gcpro nil
2472 "Internal variable used to keep some values from being GC'd.")
2473 (make-variable-buffer-local 'compilation-gcpro)
2475 (defun compilation-fake-loc (marker file &optional line col)
2476 "Preassociate MARKER with FILE.
2477 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
2478 This is useful when you compile temporary files, but want
2479 automatic translation of the messages to the real buffer from
2480 which the temporary file came. This may also affect previous messages
2481 about FILE.
2483 Optional args LINE and COL default to 1 and beginning of
2484 indentation respectively. The marker is expected to reflect
2485 this. In the simplest case the marker points to the first line
2486 of the region that was saved to the temp file.
2488 If you concatenate several regions into the temp file (e.g. a
2489 header with variable assignments and a code region), you must
2490 call this several times, once each for the last line of one
2491 region and the first line of the next region."
2492 (or (consp file) (setq file (list file)))
2493 (compilation--flush-file-structure file)
2494 (let ((fs (compilation-get-file-structure file)))
2495 ;; Between the current call to compilation-fake-loc and the first
2496 ;; occurrence of an error message referring to `file', the data is
2497 ;; only kept in the weak hash-table compilation-locs, so we need
2498 ;; to prevent this entry in compilation-locs from being GC'd
2499 ;; away. --Stef
2500 (push fs compilation-gcpro)
2501 (let ((loc (compilation-assq (or line 1) (cdr fs))))
2502 (setq loc (compilation-assq col loc))
2503 (cl-assert (null (cdr loc)))
2504 (setcdr loc (compilation--make-cdrloc line fs marker))
2505 loc)))
2507 (defcustom compilation-context-lines nil
2508 "Display this many lines of leading context before the current message.
2509 If nil and the left fringe is displayed, don't scroll the
2510 compilation output window; an arrow in the left fringe points to
2511 the current message. If nil and there is no left fringe, the message
2512 displays at the top of the window; there is no arrow."
2513 :type '(choice integer (const :tag "No window scrolling" nil))
2514 :group 'compilation
2515 :version "22.1")
2517 (defsubst compilation-set-window (w mk)
2518 "Align the compilation output window W with marker MK near top."
2519 (if (integerp compilation-context-lines)
2520 (set-window-start w (save-excursion
2521 (goto-char mk)
2522 (beginning-of-line
2523 (- 1 compilation-context-lines))
2524 (point)))
2525 ;; If there is no left fringe.
2526 (when (equal (car (window-fringes w)) 0)
2527 (set-window-start w (save-excursion
2528 (goto-char mk)
2529 (beginning-of-line 1)
2530 (point)))))
2531 (set-window-point w mk))
2533 (defvar next-error-highlight-timer)
2535 (defun compilation-goto-locus (msg mk end-mk)
2536 "Jump to an error corresponding to MSG at MK.
2537 All arguments are markers. If END-MK is non-nil, mark is set there
2538 and overlay is highlighted between MK and END-MK."
2539 ;; Show compilation buffer in other window, scrolled to this error.
2540 (let* ((from-compilation-buffer (eq (window-buffer)
2541 (marker-buffer msg)))
2542 ;; Use an existing window if it is in a visible frame.
2543 (pre-existing (get-buffer-window (marker-buffer msg) 0))
2544 (w (if (and from-compilation-buffer pre-existing)
2545 ;; Calling display-buffer here may end up (partly) hiding
2546 ;; the error location if the two buffers are in two
2547 ;; different frames. So don't do it if it's not necessary.
2548 pre-existing
2549 (display-buffer (marker-buffer msg) '(nil (allow-no-window . t)))))
2550 (highlight-regexp (with-current-buffer (marker-buffer msg)
2551 ;; also do this while we change buffer
2552 (goto-char (marker-position msg))
2553 (and w (compilation-set-window w msg))
2554 compilation-highlight-regexp)))
2555 ;; Ideally, the window-size should be passed to `display-buffer'
2556 ;; so it's only used when creating a new window.
2557 (when (and (not pre-existing) w)
2558 (compilation-set-window-height w))
2560 (if from-compilation-buffer
2561 ;; If the compilation buffer window was selected,
2562 ;; keep the compilation buffer in this window;
2563 ;; display the source in another window.
2564 (let ((pop-up-windows t))
2565 (pop-to-buffer (marker-buffer mk) 'other-window))
2566 (switch-to-buffer (marker-buffer mk)))
2567 (unless (eq (goto-char mk) (point))
2568 ;; If narrowing gets in the way of going to the right place, widen.
2569 (widen)
2570 (if next-error-move-function
2571 (funcall next-error-move-function msg mk)
2572 (goto-char mk)))
2573 (if end-mk
2574 (push-mark end-mk t)
2575 (if mark-active (setq mark-active)))
2576 ;; If hideshow got in the way of
2577 ;; seeing the right place, open permanently.
2578 (dolist (ov (overlays-at (point)))
2579 (when (eq 'hs (overlay-get ov 'invisible))
2580 (delete-overlay ov)
2581 (goto-char mk)))
2583 (when highlight-regexp
2584 (if (timerp next-error-highlight-timer)
2585 (cancel-timer next-error-highlight-timer))
2586 (unless compilation-highlight-overlay
2587 (setq compilation-highlight-overlay
2588 (make-overlay (point-min) (point-min)))
2589 (overlay-put compilation-highlight-overlay 'face 'next-error))
2590 (with-current-buffer (marker-buffer mk)
2591 (save-excursion
2592 (if end-mk (goto-char end-mk) (end-of-line))
2593 (let ((end (point)))
2594 (if mk (goto-char mk) (beginning-of-line))
2595 (if (and (stringp highlight-regexp)
2596 (re-search-forward highlight-regexp end t))
2597 (progn
2598 (goto-char (match-beginning 0))
2599 (move-overlay compilation-highlight-overlay
2600 (match-beginning 0) (match-end 0)
2601 (current-buffer)))
2602 (move-overlay compilation-highlight-overlay
2603 (point) end (current-buffer)))
2604 (if (or (eq next-error-highlight t)
2605 (numberp next-error-highlight))
2606 ;; We want highlighting: delete overlay on next input.
2607 (add-hook 'pre-command-hook
2608 'compilation-goto-locus-delete-o)
2609 ;; We don't want highlighting: delete overlay now.
2610 (delete-overlay compilation-highlight-overlay))
2611 ;; We want highlighting for a limited time:
2612 ;; set up a timer to delete it.
2613 (when (numberp next-error-highlight)
2614 (setq next-error-highlight-timer
2615 (run-at-time next-error-highlight nil
2616 'compilation-goto-locus-delete-o)))))))
2617 (when (and (eq next-error-highlight 'fringe-arrow))
2618 ;; We want a fringe arrow (instead of highlighting).
2619 (setq next-error-overlay-arrow-position
2620 (copy-marker (line-beginning-position))))))
2622 (defun compilation-goto-locus-delete-o ()
2623 (delete-overlay compilation-highlight-overlay)
2624 ;; Get rid of timer and hook that would try to do this again.
2625 (if (timerp next-error-highlight-timer)
2626 (cancel-timer next-error-highlight-timer))
2627 (remove-hook 'pre-command-hook
2628 'compilation-goto-locus-delete-o))
2630 (defun compilation-find-file (marker filename directory &rest formats)
2631 "Find a buffer for file FILENAME.
2632 If FILENAME is not found at all, ask the user where to find it.
2633 Pop up the buffer containing MARKER and scroll to MARKER if we ask
2634 the user where to find the file.
2635 Search the directories in `compilation-search-path'.
2636 A nil in `compilation-search-path' means to try the
2637 \"current\" directory, which is passed in DIRECTORY.
2638 If DIRECTORY is relative, it is combined with `default-directory'.
2639 If DIRECTORY is nil, that means use `default-directory'.
2640 FORMATS, if given, is a list of formats to reformat FILENAME when
2641 looking for it: for each element FMT in FORMATS, this function
2642 attempts to find a file whose name is produced by (format FMT FILENAME)."
2643 (or formats (setq formats '("%s")))
2644 (let ((dirs compilation-search-path)
2645 (spec-dir (if directory
2646 (expand-file-name directory)
2647 default-directory))
2648 buffer thisdir fmts name)
2649 (if (file-name-absolute-p filename)
2650 ;; The file name is absolute. Use its explicit directory as
2651 ;; the first in the search path, and strip it from FILENAME.
2652 (setq filename (abbreviate-file-name (expand-file-name filename))
2653 dirs (cons (file-name-directory filename) dirs)
2654 filename (file-name-nondirectory filename)))
2655 ;; Now search the path.
2656 (while (and dirs (null buffer))
2657 (setq thisdir (or (car dirs) spec-dir)
2658 fmts formats)
2659 ;; For each directory, try each format string.
2660 (while (and fmts (null buffer))
2661 (setq name (expand-file-name (format (car fmts) filename) thisdir)
2662 buffer (and (file-exists-p name)
2663 (find-file-noselect name))
2664 fmts (cdr fmts)))
2665 (setq dirs (cdr dirs)))
2666 (while (null buffer) ;Repeat until the user selects an existing file.
2667 ;; The file doesn't exist. Ask the user where to find it.
2668 (save-excursion ;This save-excursion is probably not right.
2669 (let ((w (let ((pop-up-windows t))
2670 (display-buffer (marker-buffer marker)
2671 '(nil (allow-no-window . t))))))
2672 (with-current-buffer (marker-buffer marker)
2673 (goto-char marker)
2674 (and w (compilation-set-window w marker)))
2675 (let* ((name (read-file-name
2676 (format "Find this %s in (default %s): "
2677 compilation-error filename)
2678 spec-dir filename t nil
2679 ;; The predicate below is fine when called from
2680 ;; minibuffer-complete-and-exit, but it's too
2681 ;; restrictive otherwise, since it also prevents the
2682 ;; user from completing "fo" to "foo/" when she
2683 ;; wants to enter "foo/bar".
2685 ;; Try to make sure the user can only select
2686 ;; a valid answer. This predicate may be ignored,
2687 ;; tho, so we still have to double-check afterwards.
2688 ;; TODO: We should probably fix read-file-name so
2689 ;; that it never ignores this predicate, even when
2690 ;; using popup dialog boxes.
2691 ;; (lambda (name)
2692 ;; (if (file-directory-p name)
2693 ;; (setq name (expand-file-name filename name)))
2694 ;; (file-exists-p name))
2696 (origname name))
2697 (cond
2698 ((not (file-exists-p name))
2699 (message "Cannot find file `%s'" name)
2700 (ding) (sit-for 2))
2701 ((and (file-directory-p name)
2702 (not (file-exists-p
2703 (setq name (expand-file-name filename name)))))
2704 (message "No `%s' in directory %s" filename origname)
2705 (ding) (sit-for 2))
2707 (setq buffer (find-file-noselect name))))))))
2708 ;; Make intangible overlays tangible.
2709 ;; This is weird: it's not even clear which is the current buffer,
2710 ;; so the code below can't be expected to DTRT here. -- Stef
2711 (dolist (ov (overlays-in (point-min) (point-max)))
2712 (when (overlay-get ov 'intangible)
2713 (overlay-put ov 'intangible nil)))
2714 buffer))
2716 (defun compilation-get-file-structure (file &optional fmt)
2717 "Retrieve FILE's file-structure or create a new one.
2718 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
2719 In the former case, FILENAME may be relative or absolute.
2721 The file-structure looks like this:
2722 ((FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)"
2723 (or (gethash file compilation-locs)
2724 ;; File was not previously encountered, at least not in the form passed.
2725 ;; Let's normalize it and look again.
2726 (let ((filename (car file))
2727 ;; Get the specified directory from FILE.
2728 (spec-directory (if (cdr file)
2729 (file-truename (cdr file)))))
2731 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2732 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2733 ;; buffer.)
2734 (when (and (boundp 'comint-file-name-prefix)
2735 (not (equal comint-file-name-prefix "")))
2736 (if (file-name-absolute-p filename)
2737 (setq filename
2738 (concat comint-file-name-prefix filename))
2739 (if spec-directory
2740 (setq spec-directory
2741 (file-truename
2742 (concat comint-file-name-prefix spec-directory))))))
2744 ;; If compilation-parse-errors-filename-function is
2745 ;; defined, use it to process the filename.
2746 (when compilation-parse-errors-filename-function
2747 (setq filename
2748 (funcall compilation-parse-errors-filename-function
2749 filename)))
2751 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
2752 ;; file names like "./bar//foo.c" for file "bar/foo.c";
2753 ;; expand-file-name will collapse these into "/foo.c" and fail to find
2754 ;; the appropriate file. So we look for doubled slashes in the file
2755 ;; name and fix them.
2756 (setq filename (command-line-normalize-file-name filename))
2758 ;; Store it for the possibly unnormalized name
2759 (puthash file
2760 ;; Retrieve or create file-structure for normalized name
2761 ;; The gethash used to not use spec-directory, but
2762 ;; this leads to errors when files in different
2763 ;; directories have the same name:
2764 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00463.html
2765 (or (gethash (cons filename spec-directory) compilation-locs)
2766 (puthash (cons filename spec-directory)
2767 (compilation--make-file-struct
2768 (list filename spec-directory) fmt)
2769 compilation-locs))
2770 compilation-locs))))
2772 (defun compilation--flush-file-structure (file)
2773 (or (consp file) (setq file (list file)))
2774 (let ((fs (compilation-get-file-structure file)))
2775 (cl-assert (eq fs (gethash file compilation-locs)))
2776 (cl-assert (eq fs (gethash (cons (caar fs) (cadr (car fs)))
2777 compilation-locs)))
2778 (maphash (lambda (k v)
2779 (if (eq v fs) (remhash k compilation-locs)))
2780 compilation-locs)))
2782 ;;; Compatibility with the old compile.el.
2784 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
2785 (defvar compilation-parsing-end (make-marker))
2786 (defvar compilation-error-list nil)
2787 (defvar compilation-old-error-list nil)
2789 (defun compilation--compat-error-properties (err)
2790 "Map old-style error ERR to new-style message."
2791 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
2792 ;; (MARKER . MARKER).
2793 (let ((dst (cdr err)))
2794 (if (markerp dst)
2795 `(compilation-message ,(compilation--make-message
2796 (cons nil (compilation--make-cdrloc
2797 nil nil dst))
2798 2 nil)
2799 help-echo "mouse-2: visit the source location"
2800 keymap compilation-button-map
2801 mouse-face highlight)
2802 ;; Too difficult to do it by hand: dispatch to the normal code.
2803 (let* ((file (pop dst))
2804 (line (pop dst))
2805 (col (pop dst))
2806 (filename (pop file))
2807 (dirname (pop file))
2808 (fmt (pop file)))
2809 (compilation-internal-error-properties
2810 (cons filename dirname) line nil col nil 2 fmt)))))
2812 (defun compilation--compat-parse-errors (limit)
2813 (when compilation-parse-errors-function
2814 ;; FIXME: We should remove the rest of the compilation keywords
2815 ;; but we can't do that from here because font-lock is using
2816 ;; the value right now. --Stef
2817 (save-excursion
2818 (setq compilation-error-list nil)
2819 ;; Reset compilation-parsing-end each time because font-lock
2820 ;; might force us the re-parse many times (typically because
2821 ;; some code adds some text-property to the output that we
2822 ;; already parsed). You might say "why reparse", well:
2823 ;; because font-lock has just removed the `compilation-message' property
2824 ;; so have to do it all over again.
2825 (if compilation-parsing-end
2826 (set-marker compilation-parsing-end (point))
2827 (setq compilation-parsing-end (point-marker)))
2828 (condition-case nil
2829 ;; Ignore any error: we're calling this function earlier than
2830 ;; in the old compile.el so things might not all be setup yet.
2831 (funcall compilation-parse-errors-function limit nil)
2832 (error nil))
2833 (dolist (err (if (listp compilation-error-list) compilation-error-list))
2834 (let* ((src (car err))
2835 (dst (cdr err))
2836 (loc (cond ((markerp dst)
2837 (cons nil
2838 (compilation--make-cdrloc nil nil dst)))
2839 ((consp dst)
2840 (cons (nth 2 dst)
2841 (compilation--make-cdrloc
2842 (nth 1 dst)
2843 (cons (cdar dst) (caar dst))
2844 nil))))))
2845 (when loc
2846 (goto-char src)
2847 ;; (put-text-property src (line-end-position)
2848 ;; 'font-lock-face 'font-lock-warning-face)
2849 (put-text-property src (line-end-position)
2850 'compilation-message
2851 (compilation--make-message loc 2 nil)))))))
2852 (goto-char limit)
2853 nil)
2855 ;; Beware! this is not only compatibility code. New code also uses it. --Stef
2856 (defun compilation-forget-errors ()
2857 ;; In case we hit the same file/line specs, we want to recompute a new
2858 ;; marker for them, so flush our cache.
2859 (clrhash compilation-locs)
2860 (setq compilation-gcpro nil)
2861 ;; FIXME: the old code reset the directory-stack, so maybe we should
2862 ;; put a `directory change' marker of some sort, but where? -stef
2864 ;; FIXME: The old code moved compilation-current-error (which was
2865 ;; virtually represented by a mix of compilation-parsing-end and
2866 ;; compilation-error-list) to point-min, but that was only meaningful for
2867 ;; the internal uses of compilation-forget-errors: all calls from external
2868 ;; packages seem to be followed by a move of compilation-parsing-end to
2869 ;; something equivalent to point-max. So we heuristically move
2870 ;; compilation-current-error to point-max (since the external package
2871 ;; won't know that it should do it). --Stef
2872 (setq compilation-current-error nil)
2873 (let* ((proc (get-buffer-process (current-buffer)))
2874 (mark (if proc (process-mark proc)))
2875 (pos (or mark (point-max))))
2876 (setq compilation-messages-start
2877 ;; In the future, ignore the text already present in the buffer.
2878 ;; Since many process filter functions insert before markers,
2879 ;; we need to put ours just before the insertion point rather
2880 ;; than at the insertion point. If that's not possible, then
2881 ;; don't use a marker. --Stef
2882 (if (> pos (point-min)) (copy-marker (1- pos)) pos)))
2883 ;; Again, since this command is used in buffers that contain several
2884 ;; compilations, to set the beginning of "this compilation", it's a good
2885 ;; place to reset compilation-auto-jump-to-next.
2886 (set (make-local-variable 'compilation-auto-jump-to-next)
2887 (or compilation-auto-jump-to-first-error
2888 (eq compilation-scroll-output 'first-error))))
2890 (provide 'compile)
2892 ;;; compile.el ends here