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