(compilation-mode-font-lock-keywords): Do not prepend "^ *" to
[emacs.git] / lisp / progmodes / compile.el
blobc44ddfdb242f3ceb059a320877bf92b91eacd8b4
1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 ;; Free Software Foundation, Inc.
7 ;; Authors: Roland McGrath <roland@gnu.org>,
8 ;; Daniel Pfeiffer <occitan@esperanto.org>
9 ;; Maintainer: FSF
10 ;; Keywords: tools, processes
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; This package provides the compile facilities documented in the Emacs user's
30 ;; manual.
32 ;; This mode uses some complex data-structures:
34 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE)
36 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
37 ;; LINE will be nil for a message that doesn't contain them. Then the
38 ;; location refers to a indented beginning of line or beginning of file.
39 ;; Once any location in some file has been jumped to, the list is extended to
40 ;; (COLUMN LINE FILE-STRUCTURE MARKER TIMESTAMP . VISITED)
41 ;; for all LOCs pertaining to that file.
42 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
43 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
44 ;; before that point. VISITED is t if we have jumped there, else nil.
45 ;; TIMESTAMP is necessary because of "incremental compilation": `omake -P'
46 ;; polls filesystem for changes and recompiles when a file is modified
47 ;; using the same *compilation* buffer. this necessitates re-parsing markers.
49 ;; FILE-STRUCTURE is a list of
50 ;; ((FILENAME . DIRECTORY) FORMATS (LINE LOC ...) ...)
52 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
53 ;; obtained by following directory change messages. DIRECTORY will be nil for
54 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
55 ;; a file of that name can't be found.
56 ;; The rest of the list is an alist of elements with LINE as key. The keys
57 ;; are either nil or line numbers. If present, nil comes first, followed by
58 ;; the numbers in decreasing order. The LOCs for each line are again an alist
59 ;; ordered the same way. Note that the whole file structure is referenced in
60 ;; every LOC.
62 ;; MESSAGE is a list of (LOC TYPE END-LOC)
64 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
65 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
66 ;; other end, if the parsed message contained a range. If the end of the
67 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
68 ;; These are the value of the `message' text-properties in the compilation
69 ;; buffer.
71 ;;; Code:
73 (eval-when-compile (require 'cl))
74 (require 'tool-bar)
75 (require 'comint)
77 (defvar font-lock-extra-managed-props)
78 (defvar font-lock-keywords)
79 (defvar font-lock-maximum-size)
80 (defvar font-lock-support-mode)
83 (defgroup compilation nil
84 "Run compiler as inferior of Emacs, parse error messages."
85 :group 'tools
86 :group 'processes)
89 ;;;###autoload
90 (defcustom compilation-mode-hook nil
91 "List of hook functions run by `compilation-mode' (see `run-mode-hooks')."
92 :type 'hook
93 :group 'compilation)
95 ;;;###autoload
96 (defcustom compilation-start-hook nil
97 "List of hook functions run by `compilation-start' on the compilation process.
98 \(See `run-hook-with-args').
99 If you use \"omake -P\" and do not want \\[save-buffers-kill-terminal] to ask whether you want
100 the compilation to be killed, you can use this hook:
101 (add-hook 'compilation-start-hook
102 (lambda (process) (set-process-query-on-exit-flag process nil)) nil t)"
103 :type 'hook
104 :group 'compilation)
106 ;;;###autoload
107 (defcustom compilation-window-height nil
108 "Number of lines in a compilation window. If nil, use Emacs default."
109 :type '(choice (const :tag "Default" nil)
110 integer)
111 :group 'compilation)
113 (defvar compilation-first-column 1
114 "*This is how compilers number the first column, usually 1 or 0.")
116 (defvar compilation-parse-errors-filename-function nil
117 "Function to call to post-process filenames while parsing error messages.
118 It takes one arg FILENAME which is the name of a file as found
119 in the compilation output, and should return a transformed file name.")
121 ;;;###autoload
122 (defvar compilation-process-setup-function nil
123 "*Function to call to customize the compilation process.
124 This function is called immediately before the compilation process is
125 started. It can be used to set any variables or functions that are used
126 while processing the output of the compilation process. The function
127 is called with variables `compilation-buffer' and `compilation-window'
128 bound to the compilation buffer and window, respectively.")
130 ;;;###autoload
131 (defvar compilation-buffer-name-function nil
132 "Function to compute the name of a compilation buffer.
133 The function receives one argument, the name of the major mode of the
134 compilation buffer. It should return a string.
135 If nil, compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
137 ;;;###autoload
138 (defvar compilation-finish-function nil
139 "Function to call when a compilation process finishes.
140 It is called with two arguments: the compilation buffer, and a string
141 describing how the process finished.")
143 (make-obsolete-variable 'compilation-finish-function
144 "use `compilation-finish-functions', but it works a little differently."
145 "22.1")
147 ;;;###autoload
148 (defvar compilation-finish-functions nil
149 "Functions to call when a compilation process finishes.
150 Each function is called with two arguments: the compilation buffer,
151 and a string describing how the process finished.")
153 (defvar compilation-in-progress nil
154 "List of compilation processes now running.")
155 (or (assq 'compilation-in-progress minor-mode-alist)
156 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
157 minor-mode-alist)))
159 (defvar compilation-error "error"
160 "Stem of message to print when no matches are found.")
162 (defvar compilation-arguments nil
163 "Arguments that were given to `compilation-start'.")
165 (defvar compilation-num-errors-found)
167 (defconst compilation-error-regexp-alist-alist
168 '((absoft
169 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
170 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
172 (ada
173 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
175 (aix
176 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
178 (ant
179 "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):[0-9]+:[0-9]+:\\)?\
180 \\( warning\\)?" 1 2 3 (4))
182 (bash
183 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
185 (borland
186 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
187 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
188 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
190 (caml
191 "^ *File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
192 \\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning:\\)?\\)"
193 2 (3 . 4) (5 . 6) (7))
195 (comma
196 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
197 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
199 (edg-1
200 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
201 1 2 nil (3 . 4))
202 (edg-2
203 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
204 2 1 nil 0)
206 (epc
207 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
209 (ftnchek
210 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
211 4 2 3 (1))
213 (iar
214 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
215 1 2 nil (3))
217 (ibm
218 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
219 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
221 ;; fixme: should be `mips'
222 (irix
223 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
224 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
226 (java
227 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
229 (jikes-file
230 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
231 (jikes-line
232 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
233 nil 1 nil 2 0
234 (2 (compilation-face '(3))))
236 (gnu
237 ;; The first line matches the program name for
239 ;; PROGRAM:SOURCE-FILE-NAME:LINENO: MESSAGE
241 ;; format, which is used for non-interactive programs other than
242 ;; compilers (e.g. the "jade:" entry in compilation.txt).
244 ;; This first line makes things ambiguous with output such as
245 ;; "foo:344:50:blabla" since the "foo" part can match this first
246 ;; line (in which case the file name as "344"). To avoid this,
247 ;; the second line disallows filenames exclusively composed of
248 ;; digits.
250 ;; Similarly, we get lots of false positives with messages including
251 ;; times of the form "HH:MM:SS" where MM is taken as a line number, so
252 ;; the last line tries to rule out message where the info after the
253 ;; line number starts with "SS". --Stef
255 ;; The core of the regexp is the one with *?. It says that a file name
256 ;; can be composed of any non-newline char, but it also rules out some
257 ;; valid but unlikely cases, such as a trailing space or a space
258 ;; followed by a -.
259 "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\)?\
260 \\([0-9]*[^0-9\n]\\(?:[^\n ]\\| [^-/\n]\\)*?\\): ?\
261 \\([0-9]+\\)\\(?:\\([.:]\\)\\([0-9]+\\)\\)?\
262 \\(?:-\\([0-9]+\\)?\\(?:\\.\\([0-9]+\\)\\)?\\)?:\
263 \\(?: *\\(\\(?:Future\\|Runtime\\)?[Ww]arning\\|W:\\)\\|\
264 *\\([Ii]nfo\\(?:\\>\\|rmationa?l?\\)\\|I:\\|instantiated from\\|[Nn]ote\\)\\|\
265 \[0-9]?\\(?:[^0-9\n]\\|$\\)\\|[0-9][0-9][0-9]\\)"
266 1 (2 . 5) (4 . 6) (7 . 8))
268 ;; The `gnu' style above can incorrectly match gcc's "In file
269 ;; included from" message, so we process that first. -- cyd
270 (gcc-include
271 "^\\(?:In file included\\| \\) from \
272 \\(.+\\):\\([0-9]+\\)\\(?:\\(:\\)\\|\\(,\\)\\)?" 1 2 nil (3 . 4))
274 (lcc
275 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
276 2 3 4 (1))
278 (makepp
279 "^makepp\\(?:\\(?:: warning\\(:\\).*?\\|\\(: Scanning\\|: [LR]e?l?oading makefile\\|: Imported\\|log:.*?\\) \\|: .*?\\)\
280 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
281 4 5 nil (1 . 2) 3
282 ("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]" nil nil
283 (2 compilation-info-face)
284 (3 compilation-line-face nil t)
285 (1 (compilation-error-properties 2 3 nil nil nil 0 nil)
286 append)))
288 ;; This regexp is pathologically slow on long lines (Bug#3441).
289 ;; (maven
290 ;; ;; Maven is a popular build tool for Java. Maven is Free Software.
291 ;; "\\(.*?\\):\\[\\([0-9]+\\),\\([0-9]+\\)\\]" 1 2 3)
293 ;; Should be lint-1, lint-2 (SysV lint)
294 (mips-1
295 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
296 (mips-2
297 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
299 (msft
300 ;; AFAWK, The message may be a "warning", "error", or "fatal error".
301 "^\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
302 : \\(?:warnin\\(g\\)\\|[a-z ]+\\) C[0-9]+:" 2 3 nil (4))
304 (omake
305 ;; "omake -P" reports "file foo changed"
306 ;; (useful if you do "cvs up" and want to see what has changed)
307 "omake: file \\(.*\\) changed" 1)
309 (oracle
310 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
311 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
312 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
313 3 1 2)
315 ;; "during global destruction": This comes out under "use
316 ;; warnings" in recent perl when breaking circular references
317 ;; during program or thread exit.
318 (perl
319 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\| \
320 during global destruction\\.$\\)" 1 2)
322 (php
323 "\\(?:Parse\\|Fatal\\) error: \\(.*\\) in \\(.*\\) on line \\([0-9]+\\)"
324 2 3 nil nil)
326 (rxp
327 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
328 \\([0-9]+\\) of file://\\(.+\\)"
329 4 2 3 (1))
331 (sparc-pascal-file
332 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
333 [12][09][0-9][0-9] +\\(.*\\):$"
334 1 nil nil 0)
335 (sparc-pascal-line
336 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
337 nil 3 nil (2) nil (1 (compilation-face '(2))))
338 (sparc-pascal-example
339 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
340 nil 1 nil (3) nil (2 (compilation-face '(3))))
342 (sun
343 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
344 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
345 3 4 5 (1 . 2))
347 (sun-ada
348 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
350 (watcom
351 "\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)): ?\
352 \\(?:\\(Error! E[0-9]+\\)\\|\\(Warning! W[0-9]+\\)\\):"
353 1 2 nil (4))
355 (4bsd
356 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
357 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3))
359 (gcov-file
360 "^ *-: *\\(0\\):Source:\\(.+\\)$"
361 2 1 nil 0 nil
362 (1 compilation-line-face prepend) (2 compilation-info-face prepend))
363 (gcov-header
364 "^ *-: *\\(0\\):\\(?:Object\\|Graph\\|Data\\|Runs\\|Programs\\):.+$"
365 nil 1 nil 0 nil
366 (1 compilation-line-face prepend))
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 t)
376 (1 compilation-line-face prepend))
377 (gcov-called-line
378 "^ *\\([0-9]+\\): *\\([0-9]+\\):.*$"
379 nil 2 nil 0 nil
380 (0 'default t)
381 (1 compilation-info-face prepend) (2 compilation-line-face prepend))
382 (gcov-never-called
383 "^ *\\(#####\\): *\\([0-9]+\\):.*$"
384 nil 2 nil 2 nil
385 (0 'default t)
386 (1 compilation-error-face prepend) (2 compilation-line-face prepend))
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,
415 ;; # Test 2 got: "xx" (t-compilation-perl-2.t at line 10)
417 ;; And under Test::Harness they're preceded by progress stuff with
418 ;; \r and "NOK",
419 ;; ... NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
421 "^\\(.*NOK.*\\)?# Test [0-9]+ got:.* (\\([^ \t\r\n]+\\) at line \
422 \\([0-9]+\\))"
423 2 3)
424 (perl--Test::Harness
425 ;; perl Test::Harness output, eg.
426 ;; NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
428 ;; Test::Harness is slightly designed for tty output, since
429 ;; it prints CRs to overwrite progress messages, but if you
430 ;; run it in with M-x compile this pattern can at least step
431 ;; through the failures.
433 "^.*NOK.* \\([^ \t\r\n]+\\) at line \\([0-9]+\\)"
434 1 2)
435 (weblint
436 ;; The style comes from HTML::Lint::Error::as_string(), eg.
437 ;; index.html (13:1) Unknown element <fdjsk>
439 ;; The pattern only matches filenames without spaces, since that
440 ;; should be usual and should help reduce the chance of a false
441 ;; match of a message from some unrelated program.
443 ;; This message style is quite close to the "ibm" entry which is
444 ;; for IBM C, though that ibm bit doesn't put a space after the
445 ;; filename.
447 "^\\([^ \t\r\n(]+\\) (\\([0-9]+\\):\\([0-9]+\\)) "
448 1 2 3)
450 "Alist of values for `compilation-error-regexp-alist'.")
452 (defcustom compilation-error-regexp-alist
453 (mapcar 'car compilation-error-regexp-alist-alist)
454 "Alist that specifies how to match errors in compiler output.
455 On GNU and Unix, any string is a valid filename, so these
456 matchers must make some common sense assumptions, which catch
457 normal cases. A shorter list will be lighter on resource usage.
459 Instead of an alist element, you can use a symbol, which is
460 looked up in `compilation-error-regexp-alist-alist'. You can see
461 the predefined symbols and their effects in the file
462 `etc/compilation.txt' (linked below if you are customizing this).
464 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
465 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
466 gives the file name, and the LINE'th subexpression gives the line
467 number. The COLUMN'th subexpression gives the column number on
468 that line.
470 If FILE, LINE or COLUMN are nil or that index didn't match, that
471 information is not present on the matched line. In that case the
472 file name is assumed to be the same as the previous one in the
473 buffer, line number defaults to 1 and column defaults to
474 beginning of line's indentation.
476 FILE can also have the form (FILE FORMAT...), where the FORMATs
477 \(e.g. \"%s.c\") will be applied in turn to the recognized file
478 name, until a file of that name is found. Or FILE can also be a
479 function that returns (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
480 In the former case, FILENAME may be relative or absolute.
482 LINE can also be of the form (LINE . END-LINE) meaning a range
483 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
484 meaning a range of columns starting on LINE and ending on
485 END-LINE, if that matched.
487 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
488 TYPE can also be of the form (WARNING . INFO). In that case this
489 will be equivalent to 1 if the WARNING'th subexpression matched
490 or else equivalent to 0 if the INFO'th subexpression matched.
491 See `compilation-error-face', `compilation-warning-face',
492 `compilation-info-face' and `compilation-skip-threshold'.
494 What matched the HYPERLINK'th subexpression has `mouse-face' and
495 `compilation-message-face' applied. If this is nil, the text
496 matched by the whole REGEXP becomes the hyperlink.
498 Additional HIGHLIGHTs as described under `font-lock-keywords' can
499 be added."
500 :type `(set :menu-tag "Pick"
501 ,@(mapcar (lambda (elt)
502 (list 'const (car elt)))
503 compilation-error-regexp-alist-alist))
504 :link `(file-link :tag "example file"
505 ,(expand-file-name "compilation.txt" data-directory))
506 :group 'compilation)
508 ;;;###autoload(put 'compilation-directory 'safe-local-variable 'stringp)
509 (defvar compilation-directory nil
510 "Directory to restore to when doing `recompile'.")
512 (defvar compilation-directory-matcher
513 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
514 "A list for tracking when directories are entered or left.
515 If nil, do not track directories, e.g. if all file names are absolute. The
516 first element is the REGEXP matching these messages. It can match any number
517 of variants, e.g. different languages. The remaining elements are all of the
518 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
519 matches, that is a directory name. If LEAVE is nil or the corresponding
520 LEAVE'th subexpression doesn't match, this message is about going into another
521 directory. If it does match anything, this message is about going back to the
522 directory we were in before the last entering message. If you change this,
523 you may also want to change `compilation-page-delimiter'.")
525 (defvar compilation-page-delimiter
526 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
527 "Value of `page-delimiter' in Compilation mode.")
529 (defvar compilation-mode-font-lock-keywords
530 '(;; configure output lines.
531 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
532 (1 font-lock-variable-name-face)
533 (2 (compilation-face '(4 . 3))))
534 ;; Command output lines. Recognize `make[n]:' lines too.
535 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
536 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
537 (" --?o\\(?:utfile\\|utput\\)?[= ]?\\(\\S +\\)" . 1)
538 ("^Compilation \\(finished\\).*"
539 (0 '(face nil message nil help-echo nil mouse-face nil) t)
540 (1 compilation-info-face))
541 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\|segmentation fault\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
542 (0 '(face nil message nil help-echo nil mouse-face nil) t)
543 (1 compilation-error-face)
544 (2 compilation-error-face nil t)))
545 "Additional things to highlight in Compilation mode.
546 This gets tacked on the end of the generated expressions.")
548 (defvar compilation-highlight-regexp t
549 "Regexp matching part of visited source lines to highlight temporarily.
550 Highlight entire line if t; don't highlight source lines if nil.")
552 (defvar compilation-highlight-overlay nil
553 "Overlay used to temporarily highlight compilation matches.")
555 (defcustom compilation-error-screen-columns t
556 "If non-nil, column numbers in error messages are screen columns.
557 Otherwise they are interpreted as character positions, with
558 each character occupying one column.
559 The default is to use screen columns, which requires that the compilation
560 program and Emacs agree about the display width of the characters,
561 especially the TAB character."
562 :type 'boolean
563 :group 'compilation
564 :version "20.4")
566 (defcustom compilation-read-command t
567 "Non-nil means \\[compile] reads the compilation command to use.
568 Otherwise, \\[compile] just uses the value of `compile-command'."
569 :type 'boolean
570 :group 'compilation)
572 ;;;###autoload
573 (defcustom compilation-ask-about-save t
574 "Non-nil means \\[compile] asks which buffers to save before compiling.
575 Otherwise, it saves all modified buffers without asking."
576 :type 'boolean
577 :group 'compilation)
579 ;;;###autoload
580 (defcustom compilation-search-path '(nil)
581 "List of directories to search for source files named in error messages.
582 Elements should be directory names, not file names of directories.
583 The value nil as an element means to try the default directory."
584 :type '(repeat (choice (const :tag "Default" nil)
585 (string :tag "Directory")))
586 :group 'compilation)
588 ;;;###autoload
589 (defcustom compile-command "make -k "
590 "Last shell command used to do a compilation; default for next compilation.
592 Sometimes it is useful for files to supply local values for this variable.
593 You might also use mode hooks to specify it in certain modes, like this:
595 (add-hook 'c-mode-hook
596 (lambda ()
597 (unless (or (file-exists-p \"makefile\")
598 (file-exists-p \"Makefile\"))
599 (set (make-local-variable 'compile-command)
600 (concat \"make -k \"
601 (file-name-sans-extension buffer-file-name))))))"
602 :type 'string
603 :group 'compilation)
604 ;;;###autoload(put 'compile-command 'safe-local-variable 'stringp)
606 ;;;###autoload
607 (defcustom compilation-disable-input nil
608 "If non-nil, send end-of-file as compilation process input.
609 This only affects platforms that support asynchronous processes (see
610 `start-process'); synchronous compilation processes never accept input."
611 :type 'boolean
612 :group 'compilation
613 :version "22.1")
615 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
616 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
617 ;; key. This holds the tree seen from root, for storing new nodes.
618 (defvar compilation-locs ())
620 (defvar compilation-debug nil
621 "*Set this to t before creating a *compilation* buffer.
622 Then every error line will have a debug text property with the matcher that
623 fit this line and the match data. Use `describe-text-properties'.")
625 (defvar compilation-exit-message-function nil "\
626 If non-nil, called when a compilation process dies to return a status message.
627 This should be a function of three arguments: process status, exit status,
628 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
629 write into the compilation buffer, and to put in its mode line.")
631 (defvar compilation-environment nil
632 "*List of environment variables for compilation to inherit.
633 Each element should be a string of the form ENVVARNAME=VALUE.
634 This list is temporarily prepended to `process-environment' prior to
635 starting the compilation process.")
637 ;; History of compile commands.
638 (defvar compile-history nil)
640 (defface compilation-error
641 '((t :inherit font-lock-warning-face))
642 "Face used to highlight compiler errors."
643 :group 'compilation
644 :version "22.1")
646 (defface compilation-warning
647 '((((class color) (min-colors 16)) (:foreground "Orange" :weight bold))
648 (((class color)) (:foreground "cyan" :weight bold))
649 (t (:weight bold)))
650 "Face used to highlight compiler warnings."
651 :group 'compilation
652 :version "22.1")
654 (defface compilation-info
655 '((((class color) (min-colors 16) (background light))
656 (:foreground "Green3" :weight bold))
657 (((class color) (min-colors 88) (background dark))
658 (:foreground "Green1" :weight bold))
659 (((class color) (min-colors 16) (background dark))
660 (:foreground "Green" :weight bold))
661 (((class color)) (:foreground "green" :weight bold))
662 (t (:weight bold)))
663 "Face used to highlight compiler information."
664 :group 'compilation
665 :version "22.1")
667 (defface compilation-line-number
668 '((t :inherit font-lock-variable-name-face))
669 "Face for displaying line numbers in compiler messages."
670 :group 'compilation
671 :version "22.1")
673 (defface compilation-column-number
674 '((t :inherit font-lock-type-face))
675 "Face for displaying column numbers in compiler messages."
676 :group 'compilation
677 :version "22.1")
679 (defcustom compilation-message-face 'underline
680 "Face name to use for whole messages.
681 Faces `compilation-error-face', `compilation-warning-face',
682 `compilation-info-face', `compilation-line-face' and
683 `compilation-column-face' get prepended to this, when applicable."
684 :type 'face
685 :group 'compilation
686 :version "22.1")
688 (defvar compilation-error-face 'compilation-error
689 "Face name to use for file name in error messages.")
691 (defvar compilation-warning-face 'compilation-warning
692 "Face name to use for file name in warning messages.")
694 (defvar compilation-info-face 'compilation-info
695 "Face name to use for file name in informational messages.")
697 (defvar compilation-line-face 'compilation-line-number
698 "Face name to use for line numbers in compiler messages.")
700 (defvar compilation-column-face 'compilation-column-number
701 "Face name to use for column numbers in compiler messages.")
703 ;; same faces as dired uses
704 (defvar compilation-enter-directory-face 'font-lock-function-name-face
705 "Face name to use for entering directory messages.")
707 (defvar compilation-leave-directory-face 'font-lock-type-face
708 "Face name to use for leaving directory messages.")
712 ;; Used for compatibility with the old compile.el.
713 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
714 (defvar compilation-parsing-end (make-marker))
715 (defvar compilation-parse-errors-function nil)
716 (defvar compilation-error-list nil)
717 (defvar compilation-old-error-list nil)
719 (defcustom compilation-auto-jump-to-first-error nil
720 "If non-nil, automatically jump to the first error during compilation."
721 :type 'boolean
722 :group 'compilation
723 :version "23.1")
725 (defvar compilation-auto-jump-to-next nil
726 "If non-nil, automatically jump to the next error encountered.")
727 (make-variable-buffer-local 'compilation-auto-jump-to-next)
730 (defvar compilation-skip-to-next-location t
731 "*If non-nil, skip multiple error messages for the same source location.")
733 (defcustom compilation-skip-threshold 1
734 "Compilation motion commands skip less important messages.
735 The value can be either 2 -- skip anything less than error, 1 --
736 skip anything less than warning or 0 -- don't skip any messages.
737 Note that all messages not positively identified as warning or
738 info, are considered errors."
739 :type '(choice (const :tag "Warnings and info" 2)
740 (const :tag "Info" 1)
741 (const :tag "None" 0))
742 :group 'compilation
743 :version "22.1")
745 (defcustom compilation-skip-visited nil
746 "Compilation motion commands skip visited messages if this is t.
747 Visited messages are ones for which the file, line and column have been jumped
748 to from the current content in the current compilation buffer, even if it was
749 from a different message."
750 :type 'boolean
751 :group 'compilation
752 :version "22.1")
754 (defun compilation-face (type)
755 (or (and (car type) (match-end (car type)) compilation-warning-face)
756 (and (cdr type) (match-end (cdr type)) compilation-info-face)
757 compilation-error-face))
759 ;; Internal function for calculating the text properties of a directory
760 ;; change message. The directory property is important, because it is
761 ;; the stack of nested enter-messages. Relative filenames on the following
762 ;; lines are relative to the top of the stack.
763 (defun compilation-directory-properties (idx leave)
764 (if leave (setq leave (match-end leave)))
765 ;; find previous stack, and push onto it, or if `leave' pop it
766 (let ((dir (previous-single-property-change (point) 'directory)))
767 (setq dir (if dir (or (get-text-property (1- dir) 'directory)
768 (get-text-property dir 'directory))))
769 `(face ,(if leave
770 compilation-leave-directory-face
771 compilation-enter-directory-face)
772 directory ,(if leave
773 (or (cdr dir)
774 '(nil)) ; nil only isn't a property-change
775 (cons (match-string-no-properties idx) dir))
776 mouse-face highlight
777 keymap compilation-button-map
778 help-echo "mouse-2: visit destination directory")))
780 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
781 ;; KEY element from the ALIST, creating it in the right position if not already
782 ;; present. ALIST structure is
783 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
784 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
785 ;; may be nil. The other KEYs are ordered backwards so that growing line
786 ;; numbers can be inserted in front and searching can abort after half the
787 ;; list on average.
788 (eval-when-compile ;Don't keep it at runtime if not needed.
789 (defmacro compilation-assq (key alist)
790 `(let* ((l1 ,alist)
791 (l2 (cdr l1)))
792 (car (if (if (null ,key)
793 (if l2 (null (caar l2)))
794 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
795 (setq l1 l2
796 l2 (cdr l1)))
797 (if l2 (eq ,key (caar l2))))
799 (setcdr l1 (cons (list ,key) l2)))))))
801 (defun compilation-auto-jump (buffer pos)
802 (with-current-buffer buffer
803 (goto-char pos)
804 (let ((win (get-buffer-window buffer 0)))
805 (if win (set-window-point win pos)))
806 (if compilation-auto-jump-to-first-error
807 (compile-goto-error))))
809 ;; This function is the central driver, called when font-locking to gather
810 ;; all information needed to later jump to corresponding source code.
811 ;; Return a property list with all meta information on this error location.
813 (defun compilation-error-properties (file line end-line col end-col type fmt)
814 (unless (< (next-single-property-change (match-beginning 0)
815 'directory nil (point))
816 (point))
817 (if file
818 (if (functionp file)
819 (setq file (funcall file))
820 (let (dir)
821 (setq file (match-string-no-properties file))
822 (unless (file-name-absolute-p file)
823 (setq dir (previous-single-property-change (point) 'directory)
824 dir (if dir (or (get-text-property (1- dir) 'directory)
825 (get-text-property dir 'directory)))))
826 (setq file (cons file (car dir)))))
827 ;; This message didn't mention one, get it from previous
828 (let ((prev-pos
829 ;; Find the previous message.
830 (previous-single-property-change (point) 'message)))
831 (if prev-pos
832 ;; Get the file structure that belongs to it.
833 (let* ((prev
834 (or (get-text-property (1- prev-pos) 'message)
835 (get-text-property prev-pos 'message)))
836 (prev-struct
837 (car (nth 2 (car prev)))))
838 ;; Construct FILE . DIR from that.
839 (if prev-struct
840 (setq file (cons (car prev-struct)
841 (cadr prev-struct))))))
842 (unless file
843 (setq file '("*unknown*")))))
844 ;; All of these fields are optional, get them only if we have an index, and
845 ;; it matched some part of the message.
846 (and line
847 (setq line (match-string-no-properties line))
848 (setq line (string-to-number line)))
849 (and end-line
850 (setq end-line (match-string-no-properties end-line))
851 (setq end-line (string-to-number end-line)))
852 (if col
853 (if (functionp col)
854 (setq col (funcall col))
855 (and
856 (setq col (match-string-no-properties col))
857 (setq col (- (string-to-number col) compilation-first-column)))))
858 (if (and end-col (functionp end-col))
859 (setq end-col (funcall end-col))
860 (if (and end-col (setq end-col (match-string-no-properties end-col)))
861 (setq end-col (- (string-to-number end-col) compilation-first-column -1))
862 (if end-line (setq end-col -1))))
863 (if (consp type) ; not a static type, check what it is.
864 (setq type (or (and (car type) (match-end (car type)) 1)
865 (and (cdr type) (match-end (cdr type)) 0)
866 2)))
868 (when (and compilation-auto-jump-to-next
869 (>= type compilation-skip-threshold))
870 (kill-local-variable 'compilation-auto-jump-to-next)
871 (run-with-timer 0 nil 'compilation-auto-jump
872 (current-buffer) (match-beginning 0)))
874 (compilation-internal-error-properties file line end-line col end-col type fmt)))
876 (defun compilation-move-to-column (col screen)
877 "Go to column COL on the current line.
878 If SCREEN is non-nil, columns are screen columns, otherwise, they are
879 just char-counts."
880 (if screen
881 (move-to-column (max col 0))
882 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
884 (defun compilation-internal-error-properties (file line end-line col end-col type fmts)
885 "Get the meta-info that will be added as text-properties.
886 LINE, END-LINE, COL, END-COL are integers or nil.
887 TYPE can be 0, 1, or 2, meaning error, warning, or just info.
888 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil.
889 FMTS is a list of format specs for transforming the file name.
890 (See `compilation-error-regexp-alist'.)"
891 (unless file (setq file '("*unknown*")))
892 (let* ((file-struct (compilation-get-file-structure file fmts))
893 ;; Get first already existing marker (if any has one, all have one).
894 ;; Do this first, as the compilation-assq`s may create new nodes.
895 (marker-line (car (cddr file-struct))) ; a line structure
896 (marker (nth 3 (cadr marker-line))) ; its marker
897 (compilation-error-screen-columns compilation-error-screen-columns)
898 end-marker loc end-loc)
899 (if (not (and marker (marker-buffer marker)))
900 (setq marker nil) ; no valid marker for this file
901 (setq loc (or line 1)) ; normalize no linenumber to line 1
902 (catch 'marker ; find nearest loc, at least one exists
903 (dolist (x (nthcdr 3 file-struct)) ; loop over remaining lines
904 (if (> (car x) loc) ; still bigger
905 (setq marker-line x)
906 (if (> (- (or (car marker-line) 1) loc)
907 (- loc (car x))) ; current line is nearer
908 (setq marker-line x))
909 (throw 'marker t))))
910 (setq marker (nth 3 (cadr marker-line))
911 marker-line (or (car marker-line) 1))
912 (with-current-buffer (marker-buffer marker)
913 (save-excursion
914 (save-restriction
915 (widen)
916 (goto-char (marker-position marker))
917 (when (or end-col end-line)
918 (beginning-of-line (- (or end-line line) marker-line -1))
919 (if (or (null end-col) (< end-col 0))
920 (end-of-line)
921 (compilation-move-to-column
922 end-col compilation-error-screen-columns))
923 (setq end-marker (list (point-marker))))
924 (beginning-of-line (if end-line
925 (- line end-line -1)
926 (- loc marker-line -1)))
927 (if col
928 (compilation-move-to-column
929 col compilation-error-screen-columns)
930 (forward-to-indentation 0))
931 (setq marker (list (point-marker)))))))
933 (setq loc (compilation-assq line (cdr file-struct)))
934 (if end-line
935 (setq end-loc (compilation-assq end-line (cdr file-struct))
936 end-loc (compilation-assq end-col end-loc))
937 (if end-col ; use same line element
938 (setq end-loc (compilation-assq end-col loc))))
939 (setq loc (compilation-assq col loc))
940 ;; If they are new, make the loc(s) reference the file they point to.
941 (or (cdr loc) (setcdr loc `(,line ,file-struct ,@marker)))
942 (if end-loc
943 (or (cdr end-loc)
944 (setcdr end-loc `(,(or end-line line) ,file-struct ,@end-marker))))
946 ;; Must start with face
947 `(face ,compilation-message-face
948 message (,loc ,type ,end-loc)
949 ,@(if compilation-debug
950 `(debug (,(assoc (with-no-warnings matcher) font-lock-keywords)
951 ,@(match-data))))
952 help-echo ,(if col
953 "mouse-2: visit this file, line and column"
954 (if line
955 "mouse-2: visit this file and line"
956 "mouse-2: visit this file"))
957 keymap compilation-button-map
958 mouse-face highlight)))
960 (defun compilation-mode-font-lock-keywords ()
961 "Return expressions to highlight in Compilation mode."
962 (if compilation-parse-errors-function
963 ;; An old package! Try the compatibility code.
964 '((compilation-compat-parse-errors))
965 (append
966 ;; make directory tracking
967 (if compilation-directory-matcher
968 `((,(car compilation-directory-matcher)
969 ,@(mapcar (lambda (elt)
970 `(,(car elt)
971 (compilation-directory-properties
972 ,(car elt) ,(cdr elt))
973 t t))
974 (cdr compilation-directory-matcher)))))
976 ;; Compiler warning/error lines.
977 (mapcar
978 (lambda (item)
979 (if (symbolp item)
980 (setq item (cdr (assq item
981 compilation-error-regexp-alist-alist))))
982 (let ((file (nth 1 item))
983 (line (nth 2 item))
984 (col (nth 3 item))
985 (type (nth 4 item))
986 (pat (car item))
987 end-line end-col fmt)
988 ;; omake reports some error indented, so skip the indentation.
989 ;; another solution is to modify (some?) regexps in
990 ;; `compilation-error-regexp-alist'.
991 ;; note that omake usage is not limited to ocaml and C (for stubs).
992 (when (and (= ?^ (aref pat 0)) ; anchored: starts with "^"
993 ;; but does not allow an arbitrary number of leading spaces
994 (not (and (= ? (aref pat 1)) (= ?* (aref pat 1)))))
995 (setq pat (concat "^ *" (substring pat 1))))
996 (if (consp file) (setq fmt (cdr file) file (car file)))
997 (if (consp line) (setq end-line (cdr line) line (car line)))
998 (if (consp col) (setq end-col (cdr col) col (car col)))
1000 (if (functionp line)
1001 ;; The old compile.el had here an undocumented hook that
1002 ;; allowed `line' to be a function that computed the actual
1003 ;; error location. Let's do our best.
1004 `(,pat
1005 (0 (save-match-data
1006 (compilation-compat-error-properties
1007 (funcall ',line (cons (match-string ,file)
1008 (cons default-directory
1009 ',(nthcdr 4 item)))
1010 ,(if col `(match-string ,col))))))
1011 (,file compilation-error-face t))
1013 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
1014 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
1016 `(,pat
1018 ,@(when (integerp file)
1019 `((,file ,(if (consp type)
1020 `(compilation-face ',type)
1021 (aref [compilation-info-face
1022 compilation-warning-face
1023 compilation-error-face]
1024 (or type 2))))))
1026 ,@(when line
1027 `((,line compilation-line-face nil t)))
1028 ,@(when end-line
1029 `((,end-line compilation-line-face nil t)))
1031 ,@(when (integerp col)
1032 `((,col compilation-column-face nil t)))
1033 ,@(when (integerp end-col)
1034 `((,end-col compilation-column-face nil t)))
1036 ,@(nthcdr 6 item)
1037 (,(or (nth 5 item) 0)
1038 (compilation-error-properties ',file ,line ,end-line
1039 ,col ,end-col ',(or type 2)
1040 ',fmt)
1041 append))))) ; for compilation-message-face
1042 compilation-error-regexp-alist)
1044 compilation-mode-font-lock-keywords)))
1046 (defun compilation-read-command (command)
1047 (read-shell-command "Compile command: " command
1048 (if (equal (car compile-history) command)
1049 '(compile-history . 1)
1050 'compile-history)))
1053 ;;;###autoload
1054 (defun compile (command &optional comint)
1055 "Compile the program including the current buffer. Default: run `make'.
1056 Runs COMMAND, a shell command, in a separate process asynchronously
1057 with output going to the buffer `*compilation*'.
1059 You can then use the command \\[next-error] to find the next error message
1060 and move to the source code that caused it.
1062 If optional second arg COMINT is t the buffer will be in Comint mode with
1063 `compilation-shell-minor-mode'.
1065 Interactively, prompts for the command if `compilation-read-command' is
1066 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
1067 Additionally, with universal prefix arg, compilation buffer will be in
1068 comint mode, i.e. interactive.
1070 To run more than one compilation at once, start one then rename
1071 the \`*compilation*' buffer to some other name with
1072 \\[rename-buffer]. Then _switch buffers_ and start the new compilation.
1073 It will create a new \`*compilation*' buffer.
1075 On most systems, termination of the main compilation process
1076 kills its subprocesses.
1078 The name used for the buffer is actually whatever is returned by
1079 the function in `compilation-buffer-name-function', so you can set that
1080 to a function that generates a unique name."
1081 (interactive
1082 (list
1083 (let ((command (eval compile-command)))
1084 (if (or compilation-read-command current-prefix-arg)
1085 (compilation-read-command command)
1086 command))
1087 (consp current-prefix-arg)))
1088 (unless (equal command (eval compile-command))
1089 (setq compile-command command))
1090 (save-some-buffers (not compilation-ask-about-save) nil)
1091 (setq-default compilation-directory default-directory)
1092 (compilation-start command comint))
1094 ;; run compile with the default command line
1095 (defun recompile (&optional edit-command)
1096 "Re-compile the program including the current buffer.
1097 If this is run in a Compilation mode buffer, re-use the arguments from the
1098 original use. Otherwise, recompile using `compile-command'.
1099 If the optional argument `edit-command' is non-nil, the command can be edited."
1100 (interactive "P")
1101 (save-some-buffers (not compilation-ask-about-save) nil)
1102 (let ((default-directory (or compilation-directory default-directory)))
1103 (when edit-command
1104 (setcar compilation-arguments
1105 (compilation-read-command (car compilation-arguments))))
1106 (apply 'compilation-start (or compilation-arguments
1107 `(,(eval compile-command))))))
1109 (defcustom compilation-scroll-output nil
1110 "Non-nil to scroll the *compilation* buffer window as output appears.
1112 Setting it causes the Compilation mode commands to put point at the
1113 end of their output window so that the end of the output is always
1114 visible rather than the beginning.
1116 The value `first-error' stops scrolling at the first error, and leaves
1117 point on its location in the *compilation* buffer."
1118 :type '(choice (const :tag "No scrolling" nil)
1119 (const :tag "Scroll compilation output" t)
1120 (const :tag "Stop scrolling at the first error" first-error))
1121 :version "20.3"
1122 :group 'compilation)
1125 (defun compilation-buffer-name (mode-name mode-command name-function)
1126 "Return the name of a compilation buffer to use.
1127 If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
1128 to determine the buffer name.
1129 Likewise if `compilation-buffer-name-function' is non-nil.
1130 If current buffer has the major mode MODE-COMMAND,
1131 return the name of the current buffer, so that it gets reused.
1132 Otherwise, construct a buffer name from MODE-NAME."
1133 (cond (name-function
1134 (funcall name-function mode-name))
1135 (compilation-buffer-name-function
1136 (funcall compilation-buffer-name-function mode-name))
1137 ((eq mode-command major-mode)
1138 (buffer-name))
1140 (concat "*" (downcase mode-name) "*"))))
1142 ;; This is a rough emulation of the old hack, until the transition to new
1143 ;; compile is complete.
1144 (defun compile-internal (command error-message
1145 &optional name-of-mode parser
1146 error-regexp-alist name-function
1147 enter-regexp-alist leave-regexp-alist
1148 file-regexp-alist nomessage-regexp-alist
1149 no-async highlight-regexp local-map)
1150 (if parser
1151 (error "Compile now works very differently, see `compilation-error-regexp-alist'"))
1152 (let ((compilation-error-regexp-alist
1153 (append file-regexp-alist (or error-regexp-alist
1154 compilation-error-regexp-alist)))
1155 (compilation-error (replace-regexp-in-string "^No more \\(.+\\)s\\.?"
1156 "\\1" error-message)))
1157 (compilation-start command nil name-function highlight-regexp)))
1158 (make-obsolete 'compile-internal 'compilation-start "22.1")
1160 ;;;###autoload
1161 (defun compilation-start (command &optional mode name-function highlight-regexp)
1162 "Run compilation command COMMAND (low level interface).
1163 If COMMAND starts with a cd command, that becomes the `default-directory'.
1164 The rest of the arguments are optional; for them, nil means use the default.
1166 MODE is the major mode to set in the compilation buffer. Mode
1167 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
1169 If NAME-FUNCTION is non-nil, call it with one argument (the mode name)
1170 to determine the buffer name. Otherwise, the default is to
1171 reuses the current buffer if it has the proper major mode,
1172 else use or create a buffer with name based on the major mode.
1174 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
1175 the matching section of the visited source line; the default is to use the
1176 global value of `compilation-highlight-regexp'.
1178 Returns the compilation buffer created."
1179 (or mode (setq mode 'compilation-mode))
1180 (let* ((name-of-mode
1181 (if (eq mode t)
1182 "compilation"
1183 (replace-regexp-in-string "-mode$" "" (symbol-name mode))))
1184 (thisdir default-directory)
1185 outwin outbuf)
1186 (with-current-buffer
1187 (setq outbuf
1188 (get-buffer-create
1189 (compilation-buffer-name name-of-mode mode name-function)))
1190 (let ((comp-proc (get-buffer-process (current-buffer))))
1191 (if comp-proc
1192 (if (or (not (eq (process-status comp-proc) 'run))
1193 (yes-or-no-p
1194 (format "A %s process is running; kill it? "
1195 name-of-mode)))
1196 (condition-case ()
1197 (progn
1198 (interrupt-process comp-proc)
1199 (sit-for 1)
1200 (delete-process comp-proc))
1201 (error nil))
1202 (error "Cannot have two processes in `%s' at once"
1203 (buffer-name)))))
1204 ;; first transfer directory from where M-x compile was called
1205 (setq default-directory thisdir)
1206 ;; Make compilation buffer read-only. The filter can still write it.
1207 ;; Clear out the compilation buffer.
1208 (let ((inhibit-read-only t)
1209 (default-directory thisdir))
1210 ;; Then evaluate a cd command if any, but don't perform it yet, else
1211 ;; start-command would do it again through the shell: (cd "..") AND
1212 ;; sh -c "cd ..; make"
1213 (cd (if (string-match "^\\s *cd\\(?:\\s +\\(\\S +?\\)\\)?\\s *[;&\n]" command)
1214 (if (match-end 1)
1215 (substitute-env-vars (match-string 1 command))
1216 "~")
1217 default-directory))
1218 (erase-buffer)
1219 ;; Select the desired mode.
1220 (if (not (eq mode t))
1221 (progn
1222 (buffer-disable-undo)
1223 (funcall mode))
1224 (setq buffer-read-only nil)
1225 (with-no-warnings (comint-mode))
1226 (compilation-shell-minor-mode))
1227 ;; Remember the original dir, so we can use it when we recompile.
1228 ;; default-directory' can't be used reliably for that because it may be
1229 ;; affected by the special handling of "cd ...;".
1230 ;; NB: must be fone after (funcall mode) as that resets local variables
1231 (set (make-local-variable 'compilation-directory) thisdir)
1232 (if highlight-regexp
1233 (set (make-local-variable 'compilation-highlight-regexp)
1234 highlight-regexp))
1235 (if (or compilation-auto-jump-to-first-error
1236 (eq compilation-scroll-output 'first-error))
1237 (set (make-local-variable 'compilation-auto-jump-to-next) t))
1238 ;; Output a mode setter, for saving and later reloading this buffer.
1239 (insert "-*- mode: " name-of-mode
1240 "; default-directory: " (prin1-to-string default-directory)
1241 " -*-\n"
1242 (format "%s started at %s\n\n"
1243 mode-name
1244 (substring (current-time-string) 0 19))
1245 command "\n")
1246 (setq thisdir default-directory))
1247 (set-buffer-modified-p nil))
1248 ;; Pop up the compilation buffer.
1249 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01638.html
1250 (setq outwin (display-buffer outbuf))
1251 (with-current-buffer outbuf
1252 (let ((process-environment
1253 (append
1254 compilation-environment
1255 (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning
1256 system-uses-terminfo)
1257 (list "TERM=dumb" "TERMCAP="
1258 (format "COLUMNS=%d" (window-width)))
1259 (list "TERM=emacs"
1260 (format "TERMCAP=emacs:co#%d:tc=unknown:"
1261 (window-width))))
1262 ;; Set the EMACS variable, but
1263 ;; don't override users' setting of $EMACS.
1264 (unless (getenv "EMACS")
1265 (list "EMACS=t"))
1266 (list "INSIDE_EMACS=t")
1267 (copy-sequence process-environment))))
1268 (set (make-local-variable 'compilation-arguments)
1269 (list command mode name-function highlight-regexp))
1270 (set (make-local-variable 'revert-buffer-function)
1271 'compilation-revert-buffer)
1272 (set-window-start outwin (point-min))
1274 ;; Position point as the user will see it.
1275 (let ((desired-visible-point
1276 ;; Put it at the end if `compilation-scroll-output' is set.
1277 (if compilation-scroll-output
1278 (point-max)
1279 ;; Normally put it at the top.
1280 (point-min))))
1281 (if (eq outwin (selected-window))
1282 (goto-char desired-visible-point)
1283 (set-window-point outwin desired-visible-point)))
1285 ;; The setup function is called before compilation-set-window-height
1286 ;; so it can set the compilation-window-height buffer locally.
1287 (if compilation-process-setup-function
1288 (funcall compilation-process-setup-function))
1289 (compilation-set-window-height outwin)
1290 ;; Start the compilation.
1291 (if (fboundp 'start-process)
1292 (let ((proc
1293 (if (eq mode t)
1294 ;; comint uses `start-file-process'.
1295 (get-buffer-process
1296 (with-no-warnings
1297 (comint-exec
1298 outbuf (downcase mode-name)
1299 (if (file-remote-p default-directory)
1300 "/bin/sh"
1301 shell-file-name)
1302 nil `("-c" ,command))))
1303 (start-file-process-shell-command (downcase mode-name)
1304 outbuf command))))
1305 ;; Make the buffer's mode line show process state.
1306 (setq mode-line-process
1307 (list (propertize ":%s" 'face 'compilation-warning)))
1308 (set-process-sentinel proc 'compilation-sentinel)
1309 (unless (eq mode t)
1310 ;; Keep the comint filter, since it's needed for proper handling
1311 ;; of the prompts.
1312 (set-process-filter proc 'compilation-filter))
1313 ;; Use (point-max) here so that output comes in
1314 ;; after the initial text,
1315 ;; regardless of where the user sees point.
1316 (set-marker (process-mark proc) (point-max) outbuf)
1317 (when compilation-disable-input
1318 (condition-case nil
1319 (process-send-eof proc)
1320 ;; The process may have exited already.
1321 (error nil)))
1322 (run-hook-with-args 'compilation-start-hook proc)
1323 (setq compilation-in-progress
1324 (cons proc compilation-in-progress)))
1325 ;; No asynchronous processes available.
1326 (message "Executing `%s'..." command)
1327 ;; Fake modeline display as if `start-process' were run.
1328 (setq mode-line-process
1329 (list (propertize ":run" 'face 'compilation-warning)))
1330 (force-mode-line-update)
1331 (sit-for 0) ; Force redisplay
1332 (save-excursion
1333 ;; Insert the output at the end, after the initial text,
1334 ;; regardless of where the user sees point.
1335 (goto-char (point-max))
1336 (let* ((buffer-read-only nil) ; call-process needs to modify outbuf
1337 (status (call-process shell-file-name nil outbuf nil "-c"
1338 command)))
1339 (cond ((numberp status)
1340 (compilation-handle-exit
1341 'exit status
1342 (if (zerop status)
1343 "finished\n"
1344 (format "exited abnormally with code %d\n" status))))
1345 ((stringp status)
1346 (compilation-handle-exit 'signal status
1347 (concat status "\n")))
1349 (compilation-handle-exit 'bizarre status status)))))
1350 ;; Without async subprocesses, the buffer is not yet
1351 ;; fontified, so fontify it now.
1352 (let ((font-lock-verbose nil)) ; shut up font-lock messages
1353 (font-lock-fontify-buffer))
1354 (set-buffer-modified-p nil)
1355 (message "Executing `%s'...done" command)))
1356 ;; Now finally cd to where the shell started make/grep/...
1357 (setq default-directory thisdir)
1358 ;; The following form selected outwin ever since revision 1.183,
1359 ;; so possibly messing up point in some other window (bug#1073).
1360 ;; Moved into the scope of with-current-buffer, though still with
1361 ;; complete disregard for the case when compilation-scroll-output
1362 ;; equals 'first-error (martin 2008-10-04).
1363 (when compilation-scroll-output
1364 (goto-char (point-max))))
1366 ;; Make it so the next C-x ` will use this buffer.
1367 (setq next-error-last-buffer outbuf)))
1369 (defun compilation-set-window-height (window)
1370 "Set the height of WINDOW according to `compilation-window-height'."
1371 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1372 (and height
1373 (window-full-width-p window)
1374 ;; If window is alone in its frame, aside from a minibuffer,
1375 ;; don't change its height.
1376 (not (eq window (frame-root-window (window-frame window))))
1377 ;; Stef said that doing the saves in this order is safer:
1378 (save-excursion
1379 (save-selected-window
1380 (select-window window)
1381 (enlarge-window (- height (window-height))))))))
1383 (defvar compilation-menu-map
1384 (let ((map (make-sparse-keymap "Errors"))
1385 (opt-map (make-sparse-keymap "Skip")))
1386 (define-key map [stop-subjob]
1387 '(menu-item "Stop Compilation" kill-compilation
1388 :help "Kill the process made by the M-x compile or M-x grep commands"))
1389 (define-key map [compilation-mode-separator3]
1390 '("----" . nil))
1391 (define-key map [compilation-next-error-follow-minor-mode]
1392 '(menu-item
1393 "Auto Error Display" next-error-follow-minor-mode
1394 :help "Display the error under cursor when moving the cursor"
1395 :button (:toggle . next-error-follow-minor-mode)))
1396 (define-key map [compilation-skip]
1397 (cons "Skip Less Important Messages" opt-map))
1398 (define-key opt-map [compilation-skip-none]
1399 '(menu-item "Don't Skip Any Messages"
1400 (lambda ()
1401 (interactive)
1402 (customize-set-variable 'compilation-skip-threshold 0))
1403 :help "Do not skip any type of messages"
1404 :button (:radio . (eq compilation-skip-threshold 0))))
1405 (define-key opt-map [compilation-skip-info]
1406 '(menu-item "Skip Info"
1407 (lambda ()
1408 (interactive)
1409 (customize-set-variable 'compilation-skip-threshold 1))
1410 :help "Skip anything less than warning"
1411 :button (:radio . (eq compilation-skip-threshold 1))))
1412 (define-key opt-map [compilation-skip-warning-and-info]
1413 '(menu-item "Skip Warnings and Info"
1414 (lambda ()
1415 (interactive)
1416 (customize-set-variable 'compilation-skip-threshold 2))
1417 :help "Skip over Warnings and Info, stop for errors"
1418 :button (:radio . (eq compilation-skip-threshold 2))))
1419 (define-key map [compilation-mode-separator2]
1420 '("----" . nil))
1421 (define-key map [compilation-first-error]
1422 '(menu-item "First Error" first-error
1423 :help "Restart at the first error, visit corresponding source code"))
1424 (define-key map [compilation-previous-error]
1425 '(menu-item "Previous Error" previous-error
1426 :help "Visit previous `next-error' message and corresponding source code"))
1427 (define-key map [compilation-next-error]
1428 '(menu-item "Next Error" next-error
1429 :help "Visit next `next-error' message and corresponding source code"))
1430 map))
1432 (defvar compilation-minor-mode-map
1433 (let ((map (make-sparse-keymap)))
1434 (define-key map [mouse-2] 'compile-goto-error)
1435 (define-key map [follow-link] 'mouse-face)
1436 (define-key map "\C-c\C-c" 'compile-goto-error)
1437 (define-key map "\C-m" 'compile-goto-error)
1438 (define-key map "\C-c\C-k" 'kill-compilation)
1439 (define-key map "\M-n" 'compilation-next-error)
1440 (define-key map "\M-p" 'compilation-previous-error)
1441 (define-key map "\M-{" 'compilation-previous-file)
1442 (define-key map "\M-}" 'compilation-next-file)
1443 (define-key map "g" 'recompile) ; revert
1444 (define-key map "q" 'quit-window)
1445 ;; Set up the menu-bar
1446 (define-key map [menu-bar compilation]
1447 (cons "Errors" compilation-menu-map))
1448 map)
1449 "Keymap for `compilation-minor-mode'.")
1451 (defvar compilation-shell-minor-mode-map
1452 (let ((map (make-sparse-keymap)))
1453 (define-key map "\M-\C-m" 'compile-goto-error)
1454 (define-key map "\M-\C-n" 'compilation-next-error)
1455 (define-key map "\M-\C-p" 'compilation-previous-error)
1456 (define-key map "\M-{" 'compilation-previous-file)
1457 (define-key map "\M-}" 'compilation-next-file)
1458 ;; Set up the menu-bar
1459 (define-key map [menu-bar compilation]
1460 (cons "Errors" compilation-menu-map))
1461 map)
1462 "Keymap for `compilation-shell-minor-mode'.")
1464 (defvar compilation-button-map
1465 (let ((map (make-sparse-keymap)))
1466 (define-key map [mouse-2] 'compile-goto-error)
1467 (define-key map [follow-link] 'mouse-face)
1468 (define-key map "\C-m" 'compile-goto-error)
1469 map)
1470 "Keymap for compilation-message buttons.")
1471 (fset 'compilation-button-map compilation-button-map)
1473 (defvar compilation-mode-map
1474 (let ((map (make-sparse-keymap)))
1475 ;; Don't inherit from compilation-minor-mode-map,
1476 ;; because that introduces a menu bar item we don't want.
1477 ;; That confuses C-down-mouse-3.
1478 (define-key map [mouse-2] 'compile-goto-error)
1479 (define-key map [follow-link] 'mouse-face)
1480 (define-key map "\C-c\C-c" 'compile-goto-error)
1481 (define-key map "\C-m" 'compile-goto-error)
1482 (define-key map "\C-c\C-k" 'kill-compilation)
1483 (define-key map "\M-n" 'compilation-next-error)
1484 (define-key map "\M-p" 'compilation-previous-error)
1485 (define-key map "\M-{" 'compilation-previous-file)
1486 (define-key map "\M-}" 'compilation-next-file)
1487 (define-key map "\t" 'compilation-next-error)
1488 (define-key map [backtab] 'compilation-previous-error)
1489 (define-key map "g" 'recompile) ; revert
1490 (define-key map "q" 'quit-window)
1492 (define-key map " " 'scroll-up)
1493 (define-key map "\^?" 'scroll-down)
1494 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1496 ;; Set up the menu-bar
1497 (let ((submap (make-sparse-keymap "Compile")))
1498 (define-key map [menu-bar compilation]
1499 (cons "Compile" submap))
1500 (set-keymap-parent submap compilation-menu-map))
1501 (define-key map [menu-bar compilation compilation-separator2]
1502 '("----" . nil))
1503 (define-key map [menu-bar compilation compilation-grep]
1504 '(menu-item "Search Files (grep)..." grep
1505 :help "Run grep, with user-specified args, and collect output in a buffer"))
1506 (define-key map [menu-bar compilation compilation-recompile]
1507 '(menu-item "Recompile" recompile
1508 :help "Re-compile the program including the current buffer"))
1509 (define-key map [menu-bar compilation compilation-compile]
1510 '(menu-item "Compile..." compile
1511 :help "Compile the program including the current buffer. Default: run `make'"))
1512 map)
1513 "Keymap for compilation log buffers.
1514 `compilation-minor-mode-map' is a parent of this.")
1516 (defvar compilation-mode-tool-bar-map
1517 ;; When bootstrapping, tool-bar-map is not properly initialized yet,
1518 ;; so don't do anything.
1519 (when (keymapp (butlast tool-bar-map))
1520 (let ((map (butlast (copy-keymap tool-bar-map)))
1521 (help (last tool-bar-map))) ;; Keep Help last in tool bar
1522 (tool-bar-local-item
1523 "left-arrow" 'previous-error-no-select 'previous-error-no-select map
1524 :rtl "right-arrow"
1525 :help "Goto previous error")
1526 (tool-bar-local-item
1527 "right-arrow" 'next-error-no-select 'next-error-no-select map
1528 :rtl "left-arrow"
1529 :help "Goto next error")
1530 (tool-bar-local-item
1531 "cancel" 'kill-compilation 'kill-compilation map
1532 :enable '(let ((buffer (compilation-find-buffer)))
1533 (get-buffer-process buffer))
1534 :help "Stop compilation")
1535 (tool-bar-local-item
1536 "refresh" 'recompile 'recompile map
1537 :help "Restart compilation")
1538 (append map help))))
1540 (put 'compilation-mode 'mode-class 'special)
1542 ;;;###autoload
1543 (defun compilation-mode (&optional name-of-mode)
1544 "Major mode for compilation log buffers.
1545 \\<compilation-mode-map>To visit the source for a line-numbered error,
1546 move point to the error message line and type \\[compile-goto-error].
1547 To kill the compilation, type \\[kill-compilation].
1549 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
1551 \\{compilation-mode-map}"
1552 (interactive)
1553 (kill-all-local-variables)
1554 (use-local-map compilation-mode-map)
1555 ;; Let windows scroll along with the output.
1556 (set (make-local-variable 'window-point-insertion-type) t)
1557 (set (make-local-variable 'tool-bar-map) compilation-mode-tool-bar-map)
1558 (setq major-mode 'compilation-mode
1559 mode-name (or name-of-mode "Compilation"))
1560 (set (make-local-variable 'page-delimiter)
1561 compilation-page-delimiter)
1562 (compilation-setup)
1563 (setq buffer-read-only t)
1564 (run-mode-hooks 'compilation-mode-hook))
1566 (defmacro define-compilation-mode (mode name doc &rest body)
1567 "This is like `define-derived-mode' without the PARENT argument.
1568 The parent is always `compilation-mode' and the customizable `compilation-...'
1569 variables are also set from the name of the mode you have chosen,
1570 by replacing the first word, e.g `compilation-scroll-output' from
1571 `grep-scroll-output' if that variable exists."
1572 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1573 `(define-derived-mode ,mode compilation-mode ,name
1574 ,doc
1575 ,@(mapcar (lambda (v)
1576 (setq v (cons v
1577 (intern-soft (replace-regexp-in-string
1578 "^compilation" mode-name
1579 (symbol-name v)))))
1580 (and (cdr v)
1581 (or (boundp (cdr v))
1582 (if (boundp 'byte-compile-bound-variables)
1583 (memq (cdr v) byte-compile-bound-variables)))
1584 `(set (make-local-variable ',(car v)) ,(cdr v))))
1585 '(compilation-buffer-name-function
1586 compilation-directory-matcher
1587 compilation-error
1588 compilation-error-regexp-alist
1589 compilation-error-regexp-alist-alist
1590 compilation-error-screen-columns
1591 compilation-finish-function
1592 compilation-finish-functions
1593 compilation-first-column
1594 compilation-mode-font-lock-keywords
1595 compilation-page-delimiter
1596 compilation-parse-errors-filename-function
1597 compilation-process-setup-function
1598 compilation-scroll-output
1599 compilation-search-path
1600 compilation-skip-threshold
1601 compilation-window-height))
1602 ,@body)))
1604 (defun compilation-revert-buffer (ignore-auto noconfirm)
1605 (if buffer-file-name
1606 (let (revert-buffer-function)
1607 (revert-buffer ignore-auto noconfirm))
1608 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1609 (apply 'compilation-start compilation-arguments))))
1611 (defvar compilation-current-error nil
1612 "Marker to the location from where the next error will be found.
1613 The global commands next/previous/first-error/goto-error use this.")
1615 (defvar compilation-messages-start nil
1616 "Buffer position of the beginning of the compilation messages.
1617 If nil, use the beginning of buffer.")
1619 ;; A function name can't be a hook, must be something with a value.
1620 (defconst compilation-turn-on-font-lock 'turn-on-font-lock)
1622 (defun compilation-setup (&optional minor)
1623 "Prepare the buffer for the compilation parsing commands to work.
1624 Optional argument MINOR indicates this is called from
1625 `compilation-minor-mode'."
1626 (make-local-variable 'compilation-current-error)
1627 (make-local-variable 'compilation-messages-start)
1628 (make-local-variable 'compilation-error-screen-columns)
1629 (make-local-variable 'overlay-arrow-position)
1630 (set (make-local-variable 'overlay-arrow-string) "")
1631 (setq next-error-overlay-arrow-position nil)
1632 (add-hook 'kill-buffer-hook
1633 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
1634 ;; Note that compilation-next-error-function is for interfacing
1635 ;; with the next-error function in simple.el, and it's only
1636 ;; coincidentally named similarly to compilation-next-error.
1637 (setq next-error-function 'compilation-next-error-function)
1638 (set (make-local-variable 'comint-file-name-prefix)
1639 (or (file-remote-p default-directory) ""))
1640 (set (make-local-variable 'font-lock-extra-managed-props)
1641 '(directory message help-echo mouse-face debug))
1642 (set (make-local-variable 'compilation-locs)
1643 (make-hash-table :test 'equal :weakness 'value))
1644 ;; lazy-lock would never find the message unless it's scrolled to.
1645 ;; jit-lock might fontify some things too late.
1646 (set (make-local-variable 'font-lock-support-mode) nil)
1647 (set (make-local-variable 'font-lock-maximum-size) nil)
1648 (if minor
1649 (let ((fld font-lock-defaults))
1650 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1651 (if font-lock-mode
1652 (if fld
1653 (font-lock-fontify-buffer)
1654 (font-lock-change-mode)
1655 (turn-on-font-lock))
1656 (turn-on-font-lock)))
1657 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))
1658 ;; maybe defer font-lock till after derived mode is set up
1659 (run-mode-hooks 'compilation-turn-on-font-lock)))
1661 ;;;###autoload
1662 (define-minor-mode compilation-shell-minor-mode
1663 "Toggle compilation shell minor mode.
1664 With arg, turn compilation mode on if and only if arg is positive.
1665 In this minor mode, all the error-parsing commands of the
1666 Compilation major mode are available but bound to keys that don't
1667 collide with Shell mode. See `compilation-mode'.
1668 Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
1669 nil " Shell-Compile"
1670 :group 'compilation
1671 (if compilation-shell-minor-mode
1672 (compilation-setup t)
1673 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1674 (font-lock-fontify-buffer)))
1676 ;;;###autoload
1677 (define-minor-mode compilation-minor-mode
1678 "Toggle compilation minor mode.
1679 With arg, turn compilation mode on if and only if arg is positive.
1680 In this minor mode, all the error-parsing commands of the
1681 Compilation major mode are available. See `compilation-mode'.
1682 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
1683 nil " Compilation"
1684 :group 'compilation
1685 (if compilation-minor-mode
1686 (compilation-setup t)
1687 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1688 (font-lock-fontify-buffer)))
1690 (defun compilation-handle-exit (process-status exit-status msg)
1691 "Write MSG in the current buffer and hack its `mode-line-process'."
1692 (let ((inhibit-read-only t)
1693 (status (if compilation-exit-message-function
1694 (funcall compilation-exit-message-function
1695 process-status exit-status msg)
1696 (cons msg exit-status)))
1697 (omax (point-max))
1698 (opoint (point))
1699 (cur-buffer (current-buffer)))
1700 ;; Record where we put the message, so we can ignore it later on.
1701 (goto-char omax)
1702 (insert ?\n mode-name " " (car status))
1703 (if (and (numberp compilation-window-height)
1704 (zerop compilation-window-height))
1705 (message "%s" (cdr status)))
1706 (if (bolp)
1707 (forward-char -1))
1708 (insert " at " (substring (current-time-string) 0 19))
1709 (goto-char (point-max))
1710 ;; Prevent that message from being recognized as a compilation error.
1711 (add-text-properties omax (point)
1712 (append '(compilation-handle-exit t) nil))
1713 (setq mode-line-process
1714 (let ((out-string (format ":%s [%s]" process-status (cdr status)))
1715 (msg (format "%s %s" mode-name
1716 (replace-regexp-in-string "\n?$" "" (car status)))))
1717 (message "%s" msg)
1718 (propertize out-string
1719 'help-echo msg 'face (if (> exit-status 0)
1720 'compilation-error
1721 'compilation-info))))
1722 ;; Force mode line redisplay soon.
1723 (force-mode-line-update)
1724 (if (and opoint (< opoint omax))
1725 (goto-char opoint))
1726 (with-no-warnings
1727 (if compilation-finish-function
1728 (funcall compilation-finish-function cur-buffer msg)))
1729 (run-hook-with-args 'compilation-finish-functions cur-buffer msg)))
1731 ;; Called when compilation process changes state.
1732 (defun compilation-sentinel (proc msg)
1733 "Sentinel for compilation buffers."
1734 (if (memq (process-status proc) '(exit signal))
1735 (let ((buffer (process-buffer proc)))
1736 (if (null (buffer-name buffer))
1737 ;; buffer killed
1738 (set-process-buffer proc nil)
1739 (with-current-buffer buffer
1740 ;; Write something in the compilation buffer
1741 ;; and hack its mode line.
1742 (compilation-handle-exit (process-status proc)
1743 (process-exit-status proc)
1744 msg)
1745 ;; Since the buffer and mode line will show that the
1746 ;; process is dead, we can delete it now. Otherwise it
1747 ;; will stay around until M-x list-processes.
1748 (delete-process proc)))
1749 (setq compilation-in-progress (delq proc compilation-in-progress)))))
1751 (defun compilation-filter (proc string)
1752 "Process filter for compilation buffers.
1753 Just inserts the text,
1754 handles carriage motion (see `comint-inhibit-carriage-motion'),
1755 and runs `compilation-filter-hook'."
1756 (when (buffer-live-p (process-buffer proc))
1757 (with-current-buffer (process-buffer proc)
1758 (let ((inhibit-read-only t)
1759 ;; `save-excursion' doesn't use the right insertion-type for us.
1760 (pos (copy-marker (point) t))
1761 (min (point-min-marker))
1762 (max (point-max-marker)))
1763 (unwind-protect
1764 (progn
1765 ;; If we are inserting at the end of the accessible part
1766 ;; of the buffer, keep the inserted text visible.
1767 (set-marker-insertion-type max t)
1768 (widen)
1769 (goto-char (process-mark proc))
1770 ;; We used to use `insert-before-markers', so that windows with
1771 ;; point at `process-mark' scroll along with the output, but we
1772 ;; now use window-point-insertion-type instead.
1773 (insert string)
1774 (unless comint-inhibit-carriage-motion
1775 (comint-carriage-motion (process-mark proc) (point)))
1776 (set-marker (process-mark proc) (point))
1777 (run-hooks 'compilation-filter-hook))
1778 (goto-char pos)
1779 (narrow-to-region min max)
1780 (set-marker min nil)
1781 (set-marker max nil))))))
1783 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
1784 (defsubst compilation-buffer-internal-p ()
1785 "Test if inside a compilation buffer."
1786 (local-variable-p 'compilation-locs))
1788 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
1789 (defsubst compilation-buffer-p (buffer)
1790 "Test if BUFFER is a compilation buffer."
1791 (with-current-buffer buffer
1792 (compilation-buffer-internal-p)))
1794 (defmacro compilation-loop (< property-change 1+ error limit)
1795 `(let (opt)
1796 (while (,< n 0)
1797 (setq opt pt)
1798 (or (setq pt (,property-change pt 'message))
1799 ;; Handle the case where where the first error message is
1800 ;; at the start of the buffer, and n < 0.
1801 (if (or (eq (get-text-property ,limit 'message)
1802 (get-text-property opt 'message))
1803 (eq pt opt))
1804 (error ,error compilation-error)
1805 (setq pt ,limit)))
1806 ;; prop 'message usually has 2 changes, on and off, so
1807 ;; re-search if off
1808 (or (setq msg (get-text-property pt 'message))
1809 (if (setq pt (,property-change pt 'message nil ,limit))
1810 (setq msg (get-text-property pt 'message)))
1811 (error ,error compilation-error))
1812 (or (< (cadr msg) compilation-skip-threshold)
1813 (if different-file
1814 (eq (prog1 last (setq last (nth 2 (car msg))))
1815 last))
1816 (if compilation-skip-visited
1817 (nthcdr 5 (car msg)))
1818 (if compilation-skip-to-next-location
1819 (eq (car msg) loc))
1820 ;; count this message only if none of the above are true
1821 (setq n (,1+ n))))))
1823 (defun compilation-next-error (n &optional different-file pt)
1824 "Move point to the next error in the compilation buffer.
1825 This function does NOT find the source line like \\[next-error].
1826 Prefix arg N says how many error messages to move forwards (or
1827 backwards, if negative).
1828 Optional arg DIFFERENT-FILE, if non-nil, means find next error for a
1829 file that is different from the current one.
1830 Optional arg PT, if non-nil, specifies the value of point to start
1831 looking for the next message."
1832 (interactive "p")
1833 (or (compilation-buffer-p (current-buffer))
1834 (error "Not in a compilation buffer"))
1835 (or pt (setq pt (point)))
1836 (let* ((msg (get-text-property pt 'message))
1837 ;; `loc' is used by the compilation-loop macro.
1838 (loc (car msg))
1839 last)
1840 (if (zerop n)
1841 (unless (or msg ; find message near here
1842 (setq msg (get-text-property (max (1- pt) (point-min))
1843 'message)))
1844 (setq pt (previous-single-property-change pt 'message nil
1845 (line-beginning-position)))
1846 (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message))
1847 (setq pt (next-single-property-change pt 'message nil
1848 (line-end-position)))
1849 (or (setq msg (get-text-property pt 'message))
1850 (setq pt (point)))))
1851 (setq last (nth 2 (car msg)))
1852 (if (>= n 0)
1853 (compilation-loop > next-single-property-change 1-
1854 (if (get-buffer-process (current-buffer))
1855 "No more %ss yet"
1856 "Moved past last %s")
1857 (point-max))
1858 ;; Don't move "back" to message at or before point.
1859 ;; Pass an explicit (point-min) to make sure pt is non-nil.
1860 (setq pt (previous-single-property-change pt 'message nil (point-min)))
1861 (compilation-loop < previous-single-property-change 1+
1862 "Moved back before first %s" (point-min))))
1863 (goto-char pt)
1864 (or msg
1865 (error "No %s here" compilation-error))))
1867 (defun compilation-previous-error (n)
1868 "Move point to the previous error in the compilation buffer.
1869 Prefix arg N says how many error messages to move backwards (or
1870 forwards, if negative).
1871 Does NOT find the source line like \\[previous-error]."
1872 (interactive "p")
1873 (compilation-next-error (- n)))
1875 (defun compilation-next-file (n)
1876 "Move point to the next error for a different file than the current one.
1877 Prefix arg N says how many files to move forwards (or backwards, if negative)."
1878 (interactive "p")
1879 (compilation-next-error n t))
1881 (defun compilation-previous-file (n)
1882 "Move point to the previous error for a different file than the current one.
1883 Prefix arg N says how many files to move backwards (or forwards, if negative)."
1884 (interactive "p")
1885 (compilation-next-file (- n)))
1887 (defun kill-compilation ()
1888 "Kill the process made by the \\[compile] or \\[grep] commands."
1889 (interactive)
1890 (let ((buffer (compilation-find-buffer)))
1891 (if (get-buffer-process buffer)
1892 (interrupt-process (get-buffer-process buffer))
1893 (error "The %s process is not running" (downcase mode-name)))))
1895 (defalias 'compile-mouse-goto-error 'compile-goto-error)
1897 (defun compile-goto-error (&optional event)
1898 "Visit the source for the error message at point.
1899 Use this command in a compilation log buffer. Sets the mark at point there."
1900 (interactive (list last-input-event))
1901 (if event (posn-set-point (event-end event)))
1902 (or (compilation-buffer-p (current-buffer))
1903 (error "Not in a compilation buffer"))
1904 (if (get-text-property (point) 'directory)
1905 (dired-other-window (car (get-text-property (point) 'directory)))
1906 (push-mark)
1907 (setq compilation-current-error (point))
1908 (next-error-internal)))
1910 (defun compilation-find-buffer (&optional avoid-current)
1911 "Return a compilation buffer.
1912 If AVOID-CURRENT is nil, and the current buffer is a compilation buffer,
1913 return it. If AVOID-CURRENT is non-nil, return the current buffer only
1914 as a last resort."
1915 (if (and (compilation-buffer-internal-p) (not avoid-current))
1916 (current-buffer)
1917 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)))
1919 ;;;###autoload
1920 (defun compilation-next-error-function (n &optional reset)
1921 "Advance to the next error message and visit the file where the error was.
1922 This is the value of `next-error-function' in Compilation buffers."
1923 (interactive "p")
1924 (when reset
1925 (setq compilation-current-error nil))
1926 (let* ((columns compilation-error-screen-columns) ; buffer's local value
1927 (last 1) timestamp
1928 (loc (compilation-next-error (or n 1) nil
1929 (or compilation-current-error
1930 compilation-messages-start
1931 (point-min))))
1932 (end-loc (nth 2 loc))
1933 (marker (point-marker)))
1934 (setq compilation-current-error (point-marker)
1935 overlay-arrow-position
1936 (if (bolp)
1937 compilation-current-error
1938 (copy-marker (line-beginning-position)))
1939 loc (car loc))
1940 ;; If loc contains no marker, no error in that file has been visited.
1941 ;; If the marker is invalid the buffer has been killed.
1942 ;; If the file is newer than the timestamp, it has been modified
1943 ;; (`omake -P' polls filesystem for changes and recompiles when needed
1944 ;; in the same process and buffer).
1945 ;; So, recalculate all markers for that file.
1946 (unless (and (nth 3 loc) (marker-buffer (nth 3 loc)) (nthcdr 4 loc)
1947 ;; There may be no timestamp info if the loc is a `fake-loc',
1948 ;; but we just checked that the file has been visited before!
1949 (equal (nth 4 loc)
1950 (setq timestamp
1951 (with-current-buffer (marker-buffer (nth 3 loc))
1952 (visited-file-modtime)))))
1953 (with-current-buffer (compilation-find-file marker (caar (nth 2 loc))
1954 (cadr (car (nth 2 loc))))
1955 (save-restriction
1956 (widen)
1957 (goto-char (point-min))
1958 ;; Treat file's found lines in forward order, 1 by 1.
1959 (dolist (line (reverse (cddr (nth 2 loc))))
1960 (when (car line) ; else this is a filename w/o a line#
1961 (beginning-of-line (- (car line) last -1))
1962 (setq last (car line)))
1963 ;; Treat line's found columns and store/update a marker for each.
1964 (dolist (col (cdr line))
1965 (if (car col)
1966 (if (eq (car col) -1) ; special case for range end
1967 (end-of-line)
1968 (compilation-move-to-column (car col) columns))
1969 (beginning-of-line)
1970 (skip-chars-forward " \t"))
1971 (if (nth 3 col)
1972 (set-marker (nth 3 col) (point))
1973 (setcdr (nthcdr 2 col) `(,(point-marker)))))))))
1974 (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc))
1975 (setcdr (nthcdr 3 loc) (list timestamp))
1976 (setcdr (nthcdr 4 loc) t))) ; Set this one as visited.
1978 (defvar compilation-gcpro nil
1979 "Internal variable used to keep some values from being GC'd.")
1980 (make-variable-buffer-local 'compilation-gcpro)
1982 (defun compilation-fake-loc (marker file &optional line col)
1983 "Preassociate MARKER with FILE.
1984 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
1985 This is useful when you compile temporary files, but want
1986 automatic translation of the messages to the real buffer from
1987 which the temporary file came. This only works if done before a
1988 message about FILE appears!
1990 Optional args LINE and COL default to 1 and beginning of
1991 indentation respectively. The marker is expected to reflect
1992 this. In the simplest case the marker points to the first line
1993 of the region that was saved to the temp file.
1995 If you concatenate several regions into the temp file (e.g. a
1996 header with variable assignments and a code region), you must
1997 call this several times, once each for the last line of one
1998 region and the first line of the next region."
1999 (or (consp file) (setq file (list file)))
2000 (setq file (compilation-get-file-structure file))
2001 ;; Between the current call to compilation-fake-loc and the first occurrence
2002 ;; of an error message referring to `file', the data is only kept in the
2003 ;; weak hash-table compilation-locs, so we need to prevent this entry
2004 ;; in compilation-locs from being GC'd away. --Stef
2005 (push file compilation-gcpro)
2006 (let ((loc (compilation-assq (or line 1) (cdr file))))
2007 (setq loc (compilation-assq col loc))
2008 (if (cdr loc)
2009 (setcdr (cddr loc) (list marker))
2010 (setcdr loc (list line file marker)))
2011 loc))
2013 (defcustom compilation-context-lines nil
2014 "Display this many lines of leading context before the current message.
2015 If nil and the left fringe is displayed, don't scroll the
2016 compilation output window; an arrow in the left fringe points to
2017 the current message. If nil and there is no left fringe, the message
2018 displays at the top of the window; there is no arrow."
2019 :type '(choice integer (const :tag "No window scrolling" nil))
2020 :group 'compilation
2021 :version "22.1")
2023 (defsubst compilation-set-window (w mk)
2024 "Align the compilation output window W with marker MK near top."
2025 (if (integerp compilation-context-lines)
2026 (set-window-start w (save-excursion
2027 (goto-char mk)
2028 (beginning-of-line
2029 (- 1 compilation-context-lines))
2030 (point)))
2031 ;; If there is no left fringe.
2032 (if (equal (car (window-fringes)) 0)
2033 (set-window-start w (save-excursion
2034 (goto-char mk)
2035 (beginning-of-line 1)
2036 (point)))))
2037 (set-window-point w mk))
2039 (defvar next-error-highlight-timer)
2041 (defun compilation-goto-locus (msg mk end-mk)
2042 "Jump to an error corresponding to MSG at MK.
2043 All arguments are markers. If END-MK is non-nil, mark is set there
2044 and overlay is highlighted between MK and END-MK."
2045 ;; Show compilation buffer in other window, scrolled to this error.
2046 (let* ((from-compilation-buffer (eq (window-buffer (selected-window))
2047 (marker-buffer msg)))
2048 ;; Use an existing window if it is in a visible frame.
2049 (pre-existing (get-buffer-window (marker-buffer msg) 0))
2050 (w (if (and from-compilation-buffer pre-existing)
2051 ;; Calling display-buffer here may end up (partly) hiding
2052 ;; the error location if the two buffers are in two
2053 ;; different frames. So don't do it if it's not necessary.
2054 pre-existing
2055 (let ((display-buffer-reuse-frames t)
2056 (pop-up-windows t))
2057 ;; Pop up a window.
2058 (display-buffer (marker-buffer msg)))))
2059 (highlight-regexp (with-current-buffer (marker-buffer msg)
2060 ;; also do this while we change buffer
2061 (compilation-set-window w msg)
2062 compilation-highlight-regexp)))
2063 ;; Ideally, the window-size should be passed to `display-buffer' (via
2064 ;; something like special-display-buffer) so it's only used when
2065 ;; creating a new window.
2066 (unless pre-existing (compilation-set-window-height w))
2068 (if from-compilation-buffer
2069 ;; If the compilation buffer window was selected,
2070 ;; keep the compilation buffer in this window;
2071 ;; display the source in another window.
2072 (let ((pop-up-windows t))
2073 (pop-to-buffer (marker-buffer mk) 'other-window))
2074 (if (window-dedicated-p (selected-window))
2075 (pop-to-buffer (marker-buffer mk))
2076 (switch-to-buffer (marker-buffer mk))))
2077 (unless (eq (goto-char mk) (point))
2078 ;; If narrowing gets in the way of going to the right place, widen.
2079 (widen)
2080 (if next-error-move-function
2081 (funcall next-error-move-function msg mk)
2082 (goto-char mk)))
2083 (if end-mk
2084 (push-mark end-mk t)
2085 (if mark-active (setq mark-active)))
2086 ;; If hideshow got in the way of
2087 ;; seeing the right place, open permanently.
2088 (dolist (ov (overlays-at (point)))
2089 (when (eq 'hs (overlay-get ov 'invisible))
2090 (delete-overlay ov)
2091 (goto-char mk)))
2093 (when highlight-regexp
2094 (if (timerp next-error-highlight-timer)
2095 (cancel-timer next-error-highlight-timer))
2096 (unless compilation-highlight-overlay
2097 (setq compilation-highlight-overlay
2098 (make-overlay (point-min) (point-min)))
2099 (overlay-put compilation-highlight-overlay 'face 'next-error))
2100 (with-current-buffer (marker-buffer mk)
2101 (save-excursion
2102 (if end-mk (goto-char end-mk) (end-of-line))
2103 (let ((end (point)))
2104 (if mk (goto-char mk) (beginning-of-line))
2105 (if (and (stringp highlight-regexp)
2106 (re-search-forward highlight-regexp end t))
2107 (progn
2108 (goto-char (match-beginning 0))
2109 (move-overlay compilation-highlight-overlay
2110 (match-beginning 0) (match-end 0)
2111 (current-buffer)))
2112 (move-overlay compilation-highlight-overlay
2113 (point) end (current-buffer)))
2114 (if (or (eq next-error-highlight t)
2115 (numberp next-error-highlight))
2116 ;; We want highlighting: delete overlay on next input.
2117 (add-hook 'pre-command-hook
2118 'compilation-goto-locus-delete-o)
2119 ;; We don't want highlighting: delete overlay now.
2120 (delete-overlay compilation-highlight-overlay))
2121 ;; We want highlighting for a limited time:
2122 ;; set up a timer to delete it.
2123 (when (numberp next-error-highlight)
2124 (setq next-error-highlight-timer
2125 (run-at-time next-error-highlight nil
2126 'compilation-goto-locus-delete-o)))))))
2127 (when (and (eq next-error-highlight 'fringe-arrow))
2128 ;; We want a fringe arrow (instead of highlighting).
2129 (setq next-error-overlay-arrow-position
2130 (copy-marker (line-beginning-position))))))
2132 (defun compilation-goto-locus-delete-o ()
2133 (delete-overlay compilation-highlight-overlay)
2134 ;; Get rid of timer and hook that would try to do this again.
2135 (if (timerp next-error-highlight-timer)
2136 (cancel-timer next-error-highlight-timer))
2137 (remove-hook 'pre-command-hook
2138 'compilation-goto-locus-delete-o))
2140 (defun compilation-find-file (marker filename directory &rest formats)
2141 "Find a buffer for file FILENAME.
2142 If FILENAME is not found at all, ask the user where to find it.
2143 Pop up the buffer containing MARKER and scroll to MARKER if we ask
2144 the user where to find the file.
2145 Search the directories in `compilation-search-path'.
2146 A nil in `compilation-search-path' means to try the
2147 \"current\" directory, which is passed in DIRECTORY.
2148 If DIRECTORY is relative, it is combined with `default-directory'.
2149 If DIRECTORY is nil, that means use `default-directory'.
2150 FORMATS, if given, is a list of formats to reformat FILENAME when
2151 looking for it: for each element FMT in FORMATS, this function
2152 attempts to find a file whose name is produced by (format FMT FILENAME)."
2153 (or formats (setq formats '("%s")))
2154 (let ((dirs compilation-search-path)
2155 (spec-dir (if directory
2156 (expand-file-name directory)
2157 default-directory))
2158 buffer thisdir fmts name)
2159 (if (file-name-absolute-p filename)
2160 ;; The file name is absolute. Use its explicit directory as
2161 ;; the first in the search path, and strip it from FILENAME.
2162 (setq filename (abbreviate-file-name (expand-file-name filename))
2163 dirs (cons (file-name-directory filename) dirs)
2164 filename (file-name-nondirectory filename)))
2165 ;; Now search the path.
2166 (while (and dirs (null buffer))
2167 (setq thisdir (or (car dirs) spec-dir)
2168 fmts formats)
2169 ;; For each directory, try each format string.
2170 (while (and fmts (null buffer))
2171 (setq name (expand-file-name (format (car fmts) filename) thisdir)
2172 buffer (and (file-exists-p name)
2173 (find-file-noselect name))
2174 fmts (cdr fmts)))
2175 (setq dirs (cdr dirs)))
2176 (while (null buffer) ;Repeat until the user selects an existing file.
2177 ;; The file doesn't exist. Ask the user where to find it.
2178 (save-excursion ;This save-excursion is probably not right.
2179 (let ((pop-up-windows t))
2180 (compilation-set-window (display-buffer (marker-buffer marker))
2181 marker)
2182 (let* ((name (read-file-name
2183 (format "Find this %s in (default %s): "
2184 compilation-error filename)
2185 spec-dir filename t nil
2186 ;; The predicate below is fine when called from
2187 ;; minibuffer-complete-and-exit, but it's too
2188 ;; restrictive otherwise, since it also prevents the
2189 ;; user from completing "fo" to "foo/" when she
2190 ;; wants to enter "foo/bar".
2192 ;; Try to make sure the user can only select
2193 ;; a valid answer. This predicate may be ignored,
2194 ;; tho, so we still have to double-check afterwards.
2195 ;; TODO: We should probably fix read-file-name so
2196 ;; that it never ignores this predicate, even when
2197 ;; using popup dialog boxes.
2198 ;; (lambda (name)
2199 ;; (if (file-directory-p name)
2200 ;; (setq name (expand-file-name filename name)))
2201 ;; (file-exists-p name))
2203 (origname name))
2204 (cond
2205 ((not (file-exists-p name))
2206 (message "Cannot find file `%s'" name)
2207 (ding) (sit-for 2))
2208 ((and (file-directory-p name)
2209 (not (file-exists-p
2210 (setq name (expand-file-name filename name)))))
2211 (message "No `%s' in directory %s" filename origname)
2212 (ding) (sit-for 2))
2214 (setq buffer (find-file-noselect name))))))))
2215 ;; Make intangible overlays tangible.
2216 ;; This is weird: it's not even clear which is the current buffer,
2217 ;; so the code below can't be expected to DTRT here. -- Stef
2218 (dolist (ov (overlays-in (point-min) (point-max)))
2219 (when (overlay-get ov 'intangible)
2220 (overlay-put ov 'intangible nil)))
2221 buffer))
2223 (defun compilation-get-file-structure (file &optional fmt)
2224 "Retrieve FILE's file-structure or create a new one.
2225 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
2226 In the former case, FILENAME may be relative or absolute.
2228 The file-structure looks like this:
2229 (list (list FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)"
2230 (or (gethash file compilation-locs)
2231 ;; File was not previously encountered, at least not in the form passed.
2232 ;; Let's normalize it and look again.
2233 (let ((filename (car file))
2234 ;; Get the specified directory from FILE.
2235 (spec-directory (if (cdr file)
2236 (file-truename (cdr file)))))
2238 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2239 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2240 ;; buffer.)
2241 (when (and (boundp 'comint-file-name-prefix)
2242 (not (equal comint-file-name-prefix "")))
2243 (if (file-name-absolute-p filename)
2244 (setq filename
2245 (concat comint-file-name-prefix filename))
2246 (if spec-directory
2247 (setq spec-directory
2248 (file-truename
2249 (concat comint-file-name-prefix spec-directory))))))
2251 ;; If compilation-parse-errors-filename-function is
2252 ;; defined, use it to process the filename.
2253 (when compilation-parse-errors-filename-function
2254 (setq filename
2255 (funcall compilation-parse-errors-filename-function
2256 filename)))
2258 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
2259 ;; file names like "./bar//foo.c" for file "bar/foo.c";
2260 ;; expand-file-name will collapse these into "/foo.c" and fail to find
2261 ;; the appropriate file. So we look for doubled slashes in the file
2262 ;; name and fix them.
2263 (setq filename (command-line-normalize-file-name filename))
2265 ;; Store it for the possibly unnormalized name
2266 (puthash file
2267 ;; Retrieve or create file-structure for normalized name
2268 ;; The gethash used to not use spec-directory, but
2269 ;; this leads to errors when files in different
2270 ;; directories have the same name:
2271 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00463.html
2272 (or (gethash (cons filename spec-directory) compilation-locs)
2273 (puthash (cons filename spec-directory)
2274 (list (list filename spec-directory) fmt)
2275 compilation-locs))
2276 compilation-locs))))
2278 (add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$")
2280 ;;; Compatibility with the old compile.el.
2282 (defun compile-buffer-substring (n) (if n (match-string n)))
2284 (defun compilation-compat-error-properties (err)
2285 "Map old-style error ERR to new-style message."
2286 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
2287 ;; (MARKER . MARKER).
2288 (let ((dst (cdr err)))
2289 (if (markerp dst)
2290 ;; Must start with a face, for font-lock.
2291 `(face nil
2292 message ,(list (list nil nil nil dst) 2)
2293 help-echo "mouse-2: visit the source location"
2294 keymap compilation-button-map
2295 mouse-face highlight)
2296 ;; Too difficult to do it by hand: dispatch to the normal code.
2297 (let* ((file (pop dst))
2298 (line (pop dst))
2299 (col (pop dst))
2300 (filename (pop file))
2301 (dirname (pop file))
2302 (fmt (pop file)))
2303 (compilation-internal-error-properties
2304 (cons filename dirname) line nil col nil 2 fmt)))))
2306 (defun compilation-compat-parse-errors (limit)
2307 (when compilation-parse-errors-function
2308 ;; FIXME: We should remove the rest of the compilation keywords
2309 ;; but we can't do that from here because font-lock is using
2310 ;; the value right now. --stef
2311 (save-excursion
2312 (setq compilation-error-list nil)
2313 ;; Reset compilation-parsing-end each time because font-lock
2314 ;; might force us the re-parse many times (typically because
2315 ;; some code adds some text-property to the output that we
2316 ;; already parsed). You might say "why reparse", well:
2317 ;; because font-lock has just removed the `message' property so
2318 ;; have to do it all over again.
2319 (if compilation-parsing-end
2320 (set-marker compilation-parsing-end (point))
2321 (setq compilation-parsing-end (point-marker)))
2322 (condition-case nil
2323 ;; Ignore any error: we're calling this function earlier than
2324 ;; in the old compile.el so things might not all be setup yet.
2325 (funcall compilation-parse-errors-function limit nil)
2326 (error nil))
2327 (dolist (err (if (listp compilation-error-list) compilation-error-list))
2328 (let* ((src (car err))
2329 (dst (cdr err))
2330 (loc (cond ((markerp dst) (list nil nil nil dst))
2331 ((consp dst)
2332 (list (nth 2 dst) (nth 1 dst)
2333 (cons (cdar dst) (caar dst)))))))
2334 (when loc
2335 (goto-char src)
2336 ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face)
2337 (put-text-property src (line-end-position)
2338 'message (list loc 2)))))))
2339 (goto-char limit)
2340 nil)
2342 ;; Beware: this is not only compatiblity code. New code stil uses it. --Stef
2343 (defun compilation-forget-errors ()
2344 ;; In case we hit the same file/line specs, we want to recompute a new
2345 ;; marker for them, so flush our cache.
2346 (setq compilation-locs (make-hash-table :test 'equal :weakness 'value))
2347 (setq compilation-gcpro nil)
2348 ;; FIXME: the old code reset the directory-stack, so maybe we should
2349 ;; put a `directory change' marker of some sort, but where? -stef
2351 ;; FIXME: The old code moved compilation-current-error (which was
2352 ;; virtually represented by a mix of compilation-parsing-end and
2353 ;; compilation-error-list) to point-min, but that was only meaningful for
2354 ;; the internal uses of compilation-forget-errors: all calls from external
2355 ;; packages seem to be followed by a move of compilation-parsing-end to
2356 ;; something equivalent to point-max. So we heuristically move
2357 ;; compilation-current-error to point-max (since the external package
2358 ;; won't know that it should do it). --Stef
2359 (setq compilation-current-error nil)
2360 (let* ((proc (get-buffer-process (current-buffer)))
2361 (mark (if proc (process-mark proc)))
2362 (pos (or mark (point-max))))
2363 (setq compilation-messages-start
2364 ;; In the future, ignore the text already present in the buffer.
2365 ;; Since many process filter functions insert before markers,
2366 ;; we need to put ours just before the insertion point rather
2367 ;; than at the insertion point. If that's not possible, then
2368 ;; don't use a marker. --Stef
2369 (if (> pos (point-min)) (copy-marker (1- pos)) pos)))
2370 ;; Again, since this command is used in buffers that contain several
2371 ;; compilations, to set the beginning of "this compilation", it's a good
2372 ;; place to reset compilation-auto-jump-to-next.
2373 (set (make-local-variable 'compilation-auto-jump-to-next)
2374 (or compilation-auto-jump-to-first-error
2375 (eq compilation-scroll-output 'first-error))))
2377 ;;;###autoload
2378 (add-to-list 'auto-mode-alist '("\\.gcov\\'" . compilation-mode))
2380 (provide 'compile)
2382 ;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
2383 ;;; compile.el ends here