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