]> code.delx.au - gnu-emacs/blob - lisp/progmodes/compile.el
(compilation-mode-font-lock-keywords):
[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 Free Software Foundation, Inc.
5
6 ;; Authors: Roland McGrath <roland@gnu.org>,
7 ;; Daniel Pfeiffer <occitan@esperanto.org>
8 ;; Maintainer: FSF
9 ;; Keywords: tools, processes
10
11 ;; This file is part of GNU Emacs.
12
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
17
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
27
28 ;;; Commentary:
29
30 ;; This package provides the compile facilities documented in the Emacs user's
31 ;; manual.
32
33 ;; This mode uses some complex data-structures:
34
35 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE)
36
37 ;; COLUMN and LINE are numbers parsed from an error message. COLUMN and maybe
38 ;; LINE will be nil for a message that doesn't contain them. Then the
39 ;; location refers to a indented beginning of line or beginning of file.
40 ;; Once any location in some file has been jumped to, the list is extended to
41 ;; (COLUMN LINE FILE-STRUCTURE MARKER . VISITED) for all LOCs pertaining to
42 ;; that file.
43 ;; MARKER initially points to LINE and COLUMN in a buffer visiting that file.
44 ;; Being a marker it sticks to some text, when the buffer grows or shrinks
45 ;; before that point. VISITED is t if we have jumped there, else nil.
46
47 ;; FILE-STRUCTURE is a list of
48 ;; ((FILENAME . DIRECTORY) FORMATS (LINE LOC ...) ...)
49
50 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
51 ;; obtained by following directory change messages. DIRECTORY will be nil for
52 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
53 ;; a file of that name can't be found.
54 ;; The rest of the list is an alist of elements with LINE as key. The keys
55 ;; are either nil or line numbers. If present, nil comes first, followed by
56 ;; the numbers in decreasing order. The LOCs for each line are again an alist
57 ;; ordered the same way. Note that the whole file structure is referenced in
58 ;; every LOC.
59
60 ;; MESSAGE is a list of (LOC TYPE END-LOC)
61
62 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
63 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
64 ;; other end, if the parsed message contained a range. If the end of the
65 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
66 ;; These are the value of the `message' text-properties in the compilation
67 ;; buffer.
68
69 ;;; Code:
70
71 (eval-when-compile (require 'cl))
72
73 (defgroup compilation nil
74 "Run compiler as inferior of Emacs, parse error messages."
75 :group 'tools
76 :group 'processes)
77
78
79 ;;;###autoload
80 (defcustom compilation-mode-hook nil
81 "*List of hook functions run by `compilation-mode' (see `run-mode-hooks')."
82 :type 'hook
83 :group 'compilation)
84
85 ;;;###autoload
86 (defcustom compilation-window-height nil
87 "*Number of lines in a compilation window. If nil, use Emacs default."
88 :type '(choice (const :tag "Default" nil)
89 integer)
90 :group 'compilation)
91
92 (defvar compilation-first-column 1
93 "*This is how compilers number the first column, usually 1 or 0.")
94
95 (defvar compilation-parse-errors-filename-function nil
96 "Function to call to post-process filenames while parsing error messages.
97 It takes one arg FILENAME which is the name of a file as found
98 in the compilation output, and should return a transformed file name.")
99
100 ;;;###autoload
101 (defvar compilation-process-setup-function nil
102 "*Function to call to customize the compilation process.
103 This function is called immediately before the compilation process is
104 started. It can be used to set any variables or functions that are used
105 while processing the output of the compilation process. The function
106 is called with variables `compilation-buffer' and `compilation-window'
107 bound to the compilation buffer and window, respectively.")
108
109 ;;;###autoload
110 (defvar compilation-buffer-name-function nil
111 "Function to compute the name of a compilation buffer.
112 The function receives one argument, the name of the major mode of the
113 compilation buffer. It should return a string.
114 nil means compute the name with `(concat \"*\" (downcase major-mode) \"*\")'.")
115
116 ;;;###autoload
117 (defvar compilation-finish-function nil
118 "Function to call when a compilation process finishes.
119 It is called with two arguments: the compilation buffer, and a string
120 describing how the process finished.")
121
122 (make-obsolete-variable 'compilation-finish-function
123 "Use `compilation-finish-functions', but it works a little differently."
124 "22.1")
125
126 ;;;###autoload
127 (defvar compilation-finish-functions nil
128 "Functions to call when a compilation process finishes.
129 Each function is called with two arguments: the compilation buffer,
130 and a string describing how the process finished.")
131
132 (defvar compilation-in-progress nil
133 "List of compilation processes now running.")
134 (or (assq 'compilation-in-progress minor-mode-alist)
135 (setq minor-mode-alist (cons '(compilation-in-progress " Compiling")
136 minor-mode-alist)))
137
138 (defvar compilation-error "error"
139 "Stem of message to print when no matches are found.")
140
141 (defvar compilation-arguments nil
142 "Arguments that were given to `compilation-start'.")
143
144 (defvar compilation-num-errors-found)
145
146 (defconst compilation-error-regexp-alist-alist
147 '((absoft
148 "^\\(?:[Ee]rror on \\|[Ww]arning on\\( \\)\\)?[Ll]ine[ \t]+\\([0-9]+\\)[ \t]+\
149 of[ \t]+\"?\\([a-zA-Z]?:?[^\":\n]+\\)\"?:" 3 2 nil (1))
150
151 (ada
152 "\\(warning: .*\\)? at \\([^ \n]+\\):\\([0-9]+\\)$" 2 3 nil (1))
153
154 (aix
155 " in line \\([0-9]+\\) of file \\([^ \n]+[^. \n]\\)\\.? " 2 1)
156
157 (ant
158 "^[ \t]*\\[[^] \n]+\\][ \t]*\\([^: \n]+\\):\\([0-9]+\\):\\(?:\\([0-9]+\\):[0-9]+:[0-9]+:\\)?\
159 \\( warning\\)?" 1 2 3 (4))
160
161 (bash
162 "^\\([^: \n\t]+\\): line \\([0-9]+\\):" 1 2)
163
164 (borland
165 "^\\(?:Error\\|Warnin\\(g\\)\\) \\(?:[FEW][0-9]+ \\)?\
166 \\([a-zA-Z]?:?[^:( \t\n]+\\)\
167 \\([0-9]+\\)\\(?:[) \t]\\|:[^0-9\n]\\)" 2 3 nil (1))
168
169 (caml
170 "^ *File \\(\"?\\)\\([^,\" \n\t<>]+\\)\\1, lines? \\([0-9]+\\)-?\\([0-9]+\\)?\\(?:$\\|,\
171 \\(?: characters? \\([0-9]+\\)-?\\([0-9]+\\)?:\\)?\\([ \n]Warning:\\)?\\)"
172 2 (3 . 4) (5 . 6) (7))
173
174 (comma
175 "^\"\\([^,\" \n\t]+\\)\", line \\([0-9]+\\)\
176 \\(?:[(. pos]+\\([0-9]+\\))?\\)?[:.,; (-]\\( warning:\\|[-0-9 ]*(W)\\)?" 1 2 3 (4))
177
178 (edg-1
179 "^\\([^ \n]+\\)(\\([0-9]+\\)): \\(?:error\\|warnin\\(g\\)\\|remar\\(k\\)\\)"
180 1 2 nil (3 . 4))
181 (edg-2
182 "at line \\([0-9]+\\) of \"\\([^ \n]+\\)\"$"
183 2 1 nil 0)
184
185 (epc
186 "^Error [0-9]+ at (\\([0-9]+\\):\\([^)\n]+\\))" 2 1)
187
188 (ftnchek
189 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
190 4 2 3 (1))
191
192 (iar
193 "^\"\\(.*\\)\",\\([0-9]+\\)\\s-+\\(?:Error\\|Warnin\\(g\\)\\)\\[[0-9]+\\]:"
194 1 2 nil (3))
195
196 (ibm
197 "^\\([^( \n\t]+\\)(\\([0-9]+\\):\\([0-9]+\\)) :\
198 \\(?:warnin\\(g\\)\\|informationa\\(l\\)\\)?" 1 2 3 (4 . 5))
199
200 ;; fixme: should be `mips'
201 (irix
202 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
203 \\([^,\" \n\t]+\\)\\(?:, line\\|:\\) \\([0-9]+\\):" 3 4 nil (1 . 2))
204
205 (java
206 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
207
208 (jikes-file
209 "^\\(?:Found\\|Issued\\) .* compiling \"\\(.+\\)\":$" 1 nil nil 0)
210 (jikes-line
211 "^ *\\([0-9]+\\)\\.[ \t]+.*\n +\\(<-*>\n\\*\\*\\* \\(?:Error\\|Warnin\\(g\\)\\)\\)"
212 nil 1 nil 2 0
213 (2 (compilation-face '(3))))
214
215 (gcc-include
216 "^\\(?:In file included\\| \\) from \
217 \\(.+\\):\\([0-9]+\\)\\(?:\\(:\\)\\|\\(,\\)\\)?" 1 2 nil (3 . 4))
218
219 (gnu
220 "^\\(?:[[:alpha:]][-[:alnum:].]+: ?\\)?\
221 \\([/.]*[a-zA-Z]:?[^ \t\n:]*\\|{standard input}\\): ?\
222 \\([0-9]+\\)\\([.:]?\\)\\([0-9]+\\)?\
223 \\(?:-\\(?:\\([0-9]+\\)\\3\\)?\\.?\\([0-9]+\\)?\\)?:\
224 \\(?: *\\(\\(?:Future\\|Runtime\\)?[Ww]arning\\|W:\\)\\|\
225 *\\([Ii]nfo\\(?:\\>\\|rmationa?l?\\)\\|I:\\)\\)?"
226 1 (2 . 5) (4 . 6) (7 . 8))
227
228 (lcc
229 "^\\(?:E\\|\\(W\\)\\), \\([^(\n]+\\)(\\([0-9]+\\),[ \t]*\\([0-9]+\\)"
230 2 3 4 (1))
231
232 (makepp
233 "^makepp: \\(?:\\(?:warning\\(:\\).*?\\|\\(Scanning\\|[LR]e?l?oading makefile\\) \\|.*?\\)\
234 `\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]\\)"
235 4 5 nil (1 . 2) 3
236 ("`\\(\\(\\S +?\\)\\(?::\\([0-9]+\\)\\)?\\)['(]" nil nil
237 (2 compilation-info-face)
238 (3 compilation-line-face nil t)
239 (1 (compilation-error-properties 2 3 nil nil nil 0 nil)
240 append)))
241
242 ;; Should be lint-1, lint-2 (SysV lint)
243 (mips-1
244 " (\\([0-9]+\\)) in \\([^ \n]+\\)" 2 1)
245 (mips-2
246 " in \\([^()\n ]+\\)(\\([0-9]+\\))$" 1 2)
247
248 (msft
249 "^\\([0-9]+>\\)?\\(\\(?:[a-zA-Z]:\\)?[^:(\t\n]+\\)(\\([0-9]+\\)) \
250 : \\(?:error\\|warnin\\(g\\)\\) C[0-9]+:" 2 3 nil (4))
251
252 (oracle
253 "^\\(?:Semantic error\\|Error\\|PCC-[0-9]+:\\).* line \\([0-9]+\\)\
254 \\(?:\\(?:,\\| at\\)? column \\([0-9]+\\)\\)?\
255 \\(?:,\\| in\\| of\\)? file \\(.*?\\):?$"
256 3 1 2)
257
258 (perl
259 " at \\([^ \n]+\\) line \\([0-9]+\\)\\(?:[,.]\\|$\\)" 1 2)
260
261 (rxp
262 "^\\(?:Error\\|Warnin\\(g\\)\\):.*\n.* line \\([0-9]+\\) char\
263 \\([0-9]+\\) of file://\\(.+\\)"
264 4 2 3 (1))
265
266 (sparc-pascal-file
267 "^\\w\\w\\w \\w\\w\\w +[0-3]?[0-9] +[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\
268 [12][09][0-9][0-9] +\\(.*\\):$"
269 1 nil nil 0)
270 (sparc-pascal-line
271 "^\\(\\(?:E\\|\\(w\\)\\) +[0-9]+\\) line \\([0-9]+\\) - "
272 nil 3 nil (2) nil (1 (compilation-face '(2))))
273 (sparc-pascal-example
274 "^ +\\([0-9]+\\) +.*\n\\(\\(?:e\\|\\(w\\)\\) [0-9]+\\)-+"
275 nil 1 nil (3) nil (2 (compilation-face '(3))))
276
277 (sun
278 ": \\(?:ERROR\\|WARNIN\\(G\\)\\|REMAR\\(K\\)\\) \\(?:[[:alnum:] ]+, \\)?\
279 File = \\(.+\\), Line = \\([0-9]+\\)\\(?:, Column = \\([0-9]+\\)\\)?"
280 3 4 5 (1 . 2))
281
282 (sun-ada
283 "^\\([^, \n\t]+\\), line \\([0-9]+\\), char \\([0-9]+\\)[:., \(-]" 1 2 3)
284
285 (4bsd
286 "\\(?:^\\|:: \\|\\S ( \\)\\(/[^ \n\t()]+\\)(\\([0-9]+\\))\
287 \\(?:: \\(warning:\\)?\\|$\\| ),\\)" 1 2 nil (3))
288
289 (gcov-file
290 "^ +-: \\(0\\):Source:\\(.+\\)$" 2 1 nil 0)
291 (gcov-bb-file
292 "^ +-: \\(0\\):Object:\\(?:.+\\)$" nil 1 nil 0)
293 (gcov-never-called-line
294 "^ +\\(#####\\): +\\([0-9]+\\):.+$" nil 2 nil 2 nil
295 (1 compilation-error-face))
296 (gcov-called-line
297 "^ +[-0-9]+: +\\([1-9]\\|[0-9]\\{2,\\}\\):.*$" nil 1 nil 0)
298 )
299 "Alist of values for `compilation-error-regexp-alist'.")
300
301 (defcustom compilation-error-regexp-alist
302 (mapcar 'car compilation-error-regexp-alist-alist)
303 "Alist that specifies how to match errors in compiler output.
304 Note that on Unix everything is a valid filename, so these
305 matchers must make some common sense assumptions, which catch
306 normal cases. A shorter list will be lighter on resource usage.
307
308 Instead of an alist element, you can use a symbol, which is
309 looked up in `compilation-error-regexp-alist-alist'. You can see
310 the predefined symbols and their effects in the file
311 `etc/compilation.txt' (linked below if you are customizing this).
312
313 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
314 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
315 gives the file name, and the LINE'th subexpression gives the line
316 number. The COLUMN'th subexpression gives the column number on
317 that line.
318
319 If FILE, LINE or COLUMN are nil or that index didn't match, that
320 information is not present on the matched line. In that case the
321 file name is assumed to be the same as the previous one in the
322 buffer, line number defaults to 1 and column defaults to
323 beginning of line's indentation.
324
325 FILE can also have the form (FILE FORMAT...), where the FORMATs
326 \(e.g. \"%s.c\") will be applied in turn to the recognized file
327 name, until a file of that name is found. Or FILE can also be a
328 function to return the filename.
329
330 LINE can also be of the form (LINE . END-LINE) meaning a range
331 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
332 meaning a range of columns starting on LINE and ending on
333 END-LINE, if that matched.
334
335 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
336 TYPE can also be of the form (WARNING . INFO). In that case this
337 will be equivalent to 1 if the WARNING'th subexpression matched
338 or else equivalent to 0 if the INFO'th subexpression matched.
339 See `compilation-error-face', `compilation-warning-face',
340 `compilation-info-face' and `compilation-skip-threshold'.
341
342 What matched the HYPERLINK'th subexpression has `mouse-face' and
343 `compilation-message-face' applied. If this is nil, the text
344 matched by the whole REGEXP becomes the hyperlink.
345
346 Additional HIGHLIGHTs as described under `font-lock-keywords' can
347 be added."
348 :type `(set :menu-tag "Pick"
349 ,@(mapcar (lambda (elt)
350 (list 'const (car elt)))
351 compilation-error-regexp-alist-alist))
352 :link `(file-link :tag "example file"
353 ,(expand-file-name "compilation.txt" data-directory))
354 :group 'compilation)
355
356 (defvar compilation-directory nil
357 "Directory to restore to when doing `recompile'.")
358
359 (defvar compilation-directory-matcher
360 '("\\(?:Entering\\|Leavin\\(g\\)\\) directory `\\(.+\\)'$" (2 . 1))
361 "A list for tracking when directories are entered or left.
362 Nil means not to track directories, e.g. if all file names are absolute. The
363 first element is the REGEXP matching these messages. It can match any number
364 of variants, e.g. different languages. The remaining elements are all of the
365 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
366 matches, that is a directory name. If LEAVE is nil or the corresponding
367 LEAVE'th subexpression doesn't match, this message is about going into another
368 directory. If it does match anything, this message is about going back to the
369 directory we were in before the last entering message. If you change this,
370 you may also want to change `compilation-page-delimiter'.")
371
372 (defvar compilation-page-delimiter
373 "^\\(?:\f\\|.*\\(?:Entering\\|Leaving\\) directory `.+'\n\\)+"
374 "Value of `page-delimiter' in Compilation mode.")
375
376 (defvar compilation-mode-font-lock-keywords
377 '(;; configure output lines.
378 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
379 (1 font-lock-variable-name-face)
380 (2 (compilation-face '(4 . 3))))
381 ;; Command output lines. Recognize `make[n]:' lines too.
382 ("^\\([[:alnum:]_/.+-]+\\)\\(\\[\\([0-9]+\\)\\]\\)?[ \t]*:"
383 (1 font-lock-function-name-face) (3 compilation-line-face nil t))
384 (" --?o\\(?:utfile\\|utput\\)?[= ]?\\(\\S +\\)" . 1)
385 ("^Compilation finished" . compilation-info-face)
386 ("^Compilation exited abnormally" . compilation-error-face))
387 "Additional things to highlight in Compilation mode.
388 This gets tacked on the end of the generated expressions.")
389
390 (defvar compilation-highlight-regexp t
391 "Regexp matching part of visited source lines to highlight temporarily.
392 Highlight entire line if t; don't highlight source lines if nil.")
393
394 (defvar compilation-highlight-overlay nil
395 "Overlay used to temporarily highlight compilation matches.")
396
397 (defcustom compilation-error-screen-columns t
398 "*If non-nil, column numbers in error messages are screen columns.
399 Otherwise they are interpreted as character positions, with
400 each character occupying one column.
401 The default is to use screen columns, which requires that the compilation
402 program and Emacs agree about the display width of the characters,
403 especially the TAB character."
404 :type 'boolean
405 :group 'compilation
406 :version "20.4")
407
408 (defcustom compilation-read-command t
409 "*Non-nil means \\[compile] reads the compilation command to use.
410 Otherwise, \\[compile] just uses the value of `compile-command'."
411 :type 'boolean
412 :group 'compilation)
413
414 ;;;###autoload
415 (defcustom compilation-ask-about-save t
416 "*Non-nil means \\[compile] asks which buffers to save before compiling.
417 Otherwise, it saves all modified buffers without asking."
418 :type 'boolean
419 :group 'compilation)
420
421 ;;;###autoload
422 (defcustom compilation-search-path '(nil)
423 "*List of directories to search for source files named in error messages.
424 Elements should be directory names, not file names of directories.
425 nil as an element means to try the default directory."
426 :type '(repeat (choice (const :tag "Default" nil)
427 (string :tag "Directory")))
428 :group 'compilation)
429
430 (defcustom compile-command "make -k "
431 "*Last shell command used to do a compilation; default for next compilation.
432
433 Sometimes it is useful for files to supply local values for this variable.
434 You might also use mode hooks to specify it in certain modes, like this:
435
436 (add-hook 'c-mode-hook
437 (lambda ()
438 (unless (or (file-exists-p \"makefile\")
439 (file-exists-p \"Makefile\"))
440 (set (make-local-variable 'compile-command)
441 (concat \"make -k \"
442 (file-name-sans-extension buffer-file-name))))))"
443 :type 'string
444 :group 'compilation)
445
446 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
447 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
448 ;; key. This holds the tree seen from root, for storing new nodes.
449 (defvar compilation-locs ())
450
451 (defvar compilation-debug nil
452 "*Set this to t before creating a *compilation* buffer.
453 Then every error line will have a debug text property with the matcher that
454 fit this line and the match data. Use `describe-text-properties'.")
455
456 (defvar compilation-exit-message-function nil "\
457 If non-nil, called when a compilation process dies to return a status message.
458 This should be a function of three arguments: process status, exit status,
459 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
460 write into the compilation buffer, and to put in its mode line.")
461
462 (defvar compilation-environment nil
463 "*List of environment variables for compilation to inherit.
464 Each element should be a string of the form ENVVARNAME=VALUE.
465 This list is temporarily prepended to `process-environment' prior to
466 starting the compilation process.")
467
468 ;; History of compile commands.
469 (defvar compile-history nil)
470
471 (defface compilation-error
472 '((t :inherit font-lock-warning-face))
473 "Face used to highlight compiler errors."
474 :group 'font-lock-highlighting-faces
475 :version "22.1")
476
477 (defface compilation-warning
478 '((((class color) (min-colors 16)) (:foreground "Orange" :weight bold))
479 (((class color)) (:foreground "cyan" :weight bold))
480 (t (:weight bold)))
481 "Face used to highlight compiler warnings."
482 :group 'font-lock-highlighting-faces
483 :version "22.1")
484 ;; backward-compatibility alias
485 (put 'compilation-warning-face 'face-alias 'compilation-warning)
486
487 (defface compilation-info
488 '((((class color) (min-colors 16) (background light))
489 (:foreground "Green3" :weight bold))
490 (((class color) (min-colors 88) (background dark))
491 (:foreground "Green1" :weight bold))
492 (((class color) (min-colors 16) (background dark))
493 (:foreground "Green" :weight bold))
494 (((class color)) (:foreground "green" :weight bold))
495 (t (:weight bold)))
496 "Face used to highlight compiler information."
497 :group 'font-lock-highlighting-faces
498 :version "22.1")
499 ;; backward-compatibility alias
500 (put 'compilation-info-face 'face-alias 'compilation-info)
501
502 (defface compilation-line-number
503 '((t :inherit font-lock-variable-name-face))
504 "Face for displaying line numbers in compiler messages."
505 :group 'font-lock-highlighting-faces
506 :version "22.1")
507
508 (defface compilation-column-number
509 '((t :inherit font-lock-type-face))
510 "Face for displaying column numbers in compiler messages."
511 :group 'font-lock-highlighting-faces
512 :version "22.1")
513
514 (defvar compilation-message-face 'underline
515 "Face name to use for whole messages.
516 Faces `compilation-error-face', `compilation-warning-face',
517 `compilation-info-face', `compilation-line-face' and
518 `compilation-column-face' get prepended to this, when applicable.")
519
520 (defvar compilation-error-face 'compilation-error
521 "Face name to use for file name in error messages.")
522
523 (defvar compilation-warning-face 'compilation-warning
524 "Face name to use for file name in warning messages.")
525
526 (defvar compilation-info-face 'compilation-info
527 "Face name to use for file name in informational messages.")
528
529 (defvar compilation-line-face 'compilation-line-number
530 "Face name to use for line numbers in compiler messages.")
531
532 (defvar compilation-column-face 'compilation-column-number
533 "Face name to use for column numbers in compiler messages.")
534
535 ;; same faces as dired uses
536 (defvar compilation-enter-directory-face 'font-lock-function-name-face
537 "Face name to use for entering directory messages.")
538
539 (defvar compilation-leave-directory-face 'font-lock-type-face
540 "Face name to use for leaving directory messages.")
541
542
543
544 ;; Used for compatibility with the old compile.el.
545 (defvaralias 'compilation-last-buffer 'next-error-last-buffer)
546 (defvar compilation-parsing-end (make-marker))
547 (defvar compilation-parse-errors-function nil)
548 (defvar compilation-error-list nil)
549 (defvar compilation-old-error-list nil)
550
551 (defun compilation-face (type)
552 (or (and (car type) (match-end (car type)) compilation-warning-face)
553 (and (cdr type) (match-end (cdr type)) compilation-info-face)
554 compilation-error-face))
555
556 ;; Internal function for calculating the text properties of a directory
557 ;; change message. The directory property is important, because it is
558 ;; the stack of nested enter-messages. Relative filenames on the following
559 ;; lines are relative to the top of the stack.
560 (defun compilation-directory-properties (idx leave)
561 (if leave (setq leave (match-end leave)))
562 ;; find previous stack, and push onto it, or if `leave' pop it
563 (let ((dir (previous-single-property-change (point) 'directory)))
564 (setq dir (if dir (or (get-text-property (1- dir) 'directory)
565 (get-text-property dir 'directory))))
566 `(face ,(if leave
567 compilation-leave-directory-face
568 compilation-enter-directory-face)
569 directory ,(if leave
570 (or (cdr dir)
571 '(nil)) ; nil only isn't a property-change
572 (cons (match-string-no-properties idx) dir))
573 mouse-face highlight
574 keymap compilation-button-map
575 help-echo "mouse-2: visit current directory")))
576
577 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
578 ;; KEY element from the ALIST, creating it in the right position if not already
579 ;; present. ALIST structure is
580 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
581 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
582 ;; may be nil. The other KEYs are ordered backwards so that growing line
583 ;; numbers can be inserted in front and searching can abort after half the
584 ;; list on average.
585 (eval-when-compile ;Don't keep it at runtime if not needed.
586 (defmacro compilation-assq (key alist)
587 `(let* ((l1 ,alist)
588 (l2 (cdr l1)))
589 (car (if (if (null ,key)
590 (if l2 (null (caar l2)))
591 (while (if l2 (if (caar l2) (< ,key (caar l2)) t))
592 (setq l1 l2
593 l2 (cdr l1)))
594 (if l2 (eq ,key (caar l2))))
595 l2
596 (setcdr l1 (cons (list ,key) l2)))))))
597
598
599 ;; This function is the central driver, called when font-locking to gather
600 ;; all information needed to later jump to corresponding source code.
601 ;; Return a property list with all meta information on this error location.
602 (defun compilation-error-properties (file line end-line col end-col type fmt)
603 (unless (< (next-single-property-change (match-beginning 0) 'directory nil (point))
604 (point))
605 (if file
606 (if (functionp file)
607 (setq file (funcall file))
608 (let (dir)
609 (setq file (match-string-no-properties file))
610 (unless (file-name-absolute-p file)
611 (setq dir (previous-single-property-change (point) 'directory)
612 dir (if dir (or (get-text-property (1- dir) 'directory)
613 (get-text-property dir 'directory)))))
614 (setq file (cons file (car dir)))))
615 ;; This message didn't mention one, get it from previous
616 (setq file (previous-single-property-change (point) 'message)
617 file (or (if file
618 (car (nth 2 (car (or (get-text-property (1- file) 'message)
619 (get-text-property file 'message))))))
620 '("*unknown*"))))
621 ;; All of these fields are optional, get them only if we have an index, and
622 ;; it matched some part of the message.
623 (and line
624 (setq line (match-string-no-properties line))
625 (setq line (string-to-number line)))
626 (and end-line
627 (setq end-line (match-string-no-properties end-line))
628 (setq end-line (string-to-number end-line)))
629 (if col
630 (if (functionp col)
631 (setq col (funcall col))
632 (and
633 (setq col (match-string-no-properties col))
634 (setq col (- (string-to-number col) compilation-first-column)))))
635 (if (and end-col (functionp end-col))
636 (setq end-col (funcall end-col))
637 (if (and end-col (setq end-col (match-string-no-properties end-col)))
638 (setq end-col (- (string-to-number end-col) compilation-first-column -1))
639 (if end-line (setq end-col -1))))
640 (if (consp type) ; not a static type, check what it is.
641 (setq type (or (and (car type) (match-end (car type)) 1)
642 (and (cdr type) (match-end (cdr type)) 0)
643 2)))
644 (compilation-internal-error-properties file line end-line col end-col type fmt)))
645
646 (defun compilation-move-to-column (col screen)
647 "Go to column COL on the current line.
648 If SCREEN is non-nil, columns are screen columns, otherwise, they are
649 just char-counts."
650 (if screen
651 (move-to-column col)
652 (goto-char (min (+ (line-beginning-position) col) (line-end-position)))))
653
654 (defun compilation-internal-error-properties (file line end-line col end-col type fmt)
655 "Get the meta-info that will be added as text-properties.
656 LINE, END-LINE, COL, END-COL are integers or nil.
657 TYPE can be 0, 1, or 2.
658 FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil."
659 (unless file (setq file '("*unknown*")))
660 (setq file (compilation-get-file-structure file fmt))
661 ;; Get first already existing marker (if any has one, all have one).
662 ;; Do this first, as the compilation-assq`s may create new nodes.
663 (let* ((marker-line (car (cddr file))) ; a line structure
664 (marker (nth 3 (cadr marker-line))) ; its marker
665 (compilation-error-screen-columns compilation-error-screen-columns)
666 end-marker loc end-loc)
667 (if (not (and marker (marker-buffer marker)))
668 (setq marker) ; no valid marker for this file
669 (setq loc (or line 1)) ; normalize no linenumber to line 1
670 (catch 'marker ; find nearest loc, at least one exists
671 (dolist (x (nthcdr 3 file)) ; loop over remaining lines
672 (if (> (car x) loc) ; still bigger
673 (setq marker-line x)
674 (if (> (- (or (car marker-line) 1) loc)
675 (- loc (car x))) ; current line is nearer
676 (setq marker-line x))
677 (throw 'marker t))))
678 (setq marker (nth 3 (cadr marker-line))
679 marker-line (or (car marker-line) 1))
680 (with-current-buffer (marker-buffer marker)
681 (save-restriction
682 (widen)
683 (goto-char (marker-position marker))
684 (when (or end-col end-line)
685 (beginning-of-line (- (or end-line line) marker-line -1))
686 (if (or (null end-col) (< end-col 0))
687 (end-of-line)
688 (compilation-move-to-column
689 end-col compilation-error-screen-columns))
690 (setq end-marker (list (point-marker))))
691 (beginning-of-line (if end-line
692 (- line end-line -1)
693 (- loc marker-line -1)))
694 (if col
695 (compilation-move-to-column
696 col compilation-error-screen-columns)
697 (forward-to-indentation 0))
698 (setq marker (list (point-marker))))))
699
700 (setq loc (compilation-assq line (cdr file)))
701 (if end-line
702 (setq end-loc (compilation-assq end-line (cdr file))
703 end-loc (compilation-assq end-col end-loc))
704 (if end-col ; use same line element
705 (setq end-loc (compilation-assq end-col loc))))
706 (setq loc (compilation-assq col loc))
707 ;; If they are new, make the loc(s) reference the file they point to.
708 (or (cdr loc) (setcdr loc `(,line ,file ,@marker)))
709 (if end-loc
710 (or (cdr end-loc) (setcdr end-loc `(,(or end-line line) ,file ,@end-marker))))
711
712 ;; Must start with face
713 `(face ,compilation-message-face
714 message (,loc ,type ,end-loc)
715 ,@(if compilation-debug
716 `(debug (,(assoc (with-no-warnings matcher) font-lock-keywords)
717 ,@(match-data))))
718 help-echo ,(if col
719 "mouse-2: visit this file, line and column"
720 (if line
721 "mouse-2: visit this file and line"
722 "mouse-2: visit this file"))
723 keymap compilation-button-map
724 mouse-face highlight)))
725
726 (defun compilation-mode-font-lock-keywords ()
727 "Return expressions to highlight in Compilation mode."
728 (if compilation-parse-errors-function
729 ;; An old package! Try the compatibility code.
730 '((compilation-compat-parse-errors))
731 (append
732 ;; make directory tracking
733 (if compilation-directory-matcher
734 `((,(car compilation-directory-matcher)
735 ,@(mapcar (lambda (elt)
736 `(,(car elt)
737 (compilation-directory-properties
738 ,(car elt) ,(cdr elt))
739 t t))
740 (cdr compilation-directory-matcher)))))
741
742 ;; Compiler warning/error lines.
743 (mapcar
744 (lambda (item)
745 (if (symbolp item)
746 (setq item (cdr (assq item
747 compilation-error-regexp-alist-alist))))
748 (let ((file (nth 1 item))
749 (line (nth 2 item))
750 (col (nth 3 item))
751 (type (nth 4 item))
752 end-line end-col fmt)
753 (if (consp file) (setq fmt (cdr file) file (car file)))
754 (if (consp line) (setq end-line (cdr line) line (car line)))
755 (if (consp col) (setq end-col (cdr col) col (car col)))
756
757 (if (functionp line)
758 ;; The old compile.el had here an undocumented hook that
759 ;; allowed `line' to be a function that computed the actual
760 ;; error location. Let's do our best.
761 `(,(car item)
762 (0 (save-match-data
763 (compilation-compat-error-properties
764 (funcall ',line (cons (match-string ,file)
765 (cons default-directory
766 ',(nthcdr 4 item)))
767 ,(if col `(match-string ,col))))))
768 (,file compilation-error-face t))
769
770 (unless (or (null (nth 5 item)) (integerp (nth 5 item)))
771 (error "HYPERLINK should be an integer: %s" (nth 5 item)))
772
773 `(,(nth 0 item)
774
775 ,@(when (integerp file)
776 `((,file ,(if (consp type)
777 `(compilation-face ',type)
778 (aref [compilation-info-face
779 compilation-warning-face
780 compilation-error-face]
781 (or type 2))))))
782
783 ,@(when line
784 `((,line compilation-line-face nil t)))
785 ,@(when end-line
786 `((,end-line compilation-line-face nil t)))
787
788 ,@(when (integerp col)
789 `((,col compilation-column-face nil t)))
790 ,@(when (integerp end-col)
791 `((,end-col compilation-column-face nil t)))
792
793 ,@(nthcdr 6 item)
794 (,(or (nth 5 item) 0)
795 (compilation-error-properties ',file ,line ,end-line
796 ,col ,end-col ',(or type 2)
797 ',fmt)
798 append))))) ; for compilation-message-face
799 compilation-error-regexp-alist)
800
801 compilation-mode-font-lock-keywords)))
802
803 \f
804 ;;;###autoload
805 (defun compile (command &optional comint)
806 "Compile the program including the current buffer. Default: run `make'.
807 Runs COMMAND, a shell command, in a separate process asynchronously
808 with output going to the buffer `*compilation*'.
809
810 If optional second arg COMINT is t the buffer will be in Comint mode with
811 `compilation-shell-minor-mode'.
812
813 You can then use the command \\[next-error] to find the next error message
814 and move to the source code that caused it.
815
816 Interactively, prompts for the command if `compilation-read-command' is
817 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
818 Additionally, with universal prefix arg, compilation buffer will be in
819 comint mode, i.e. interactive.
820
821 To run more than one compilation at once, start one and rename
822 the \`*compilation*' buffer to some other name with
823 \\[rename-buffer]. Then start the next one. On most systems,
824 termination of the main compilation process kills its
825 subprocesses.
826
827 The name used for the buffer is actually whatever is returned by
828 the function in `compilation-buffer-name-function', so you can set that
829 to a function that generates a unique name."
830 (interactive
831 (list
832 (let ((command (eval compile-command)))
833 (if (or compilation-read-command current-prefix-arg)
834 (read-from-minibuffer "Compile command: "
835 command nil nil
836 (if (equal (car compile-history) command)
837 '(compile-history . 1)
838 'compile-history))
839 command))
840 (consp current-prefix-arg)))
841 (unless (equal command (eval compile-command))
842 (setq compile-command command))
843 (save-some-buffers (not compilation-ask-about-save) nil)
844 (setq compilation-directory default-directory)
845 (compilation-start command comint))
846
847 ;; run compile with the default command line
848 (defun recompile ()
849 "Re-compile the program including the current buffer.
850 If this is run in a Compilation mode buffer, re-use the arguments from the
851 original use. Otherwise, recompile using `compile-command'."
852 (interactive)
853 (save-some-buffers (not compilation-ask-about-save) nil)
854 (let ((default-directory
855 (or (and (not (eq major-mode (nth 1 compilation-arguments)))
856 compilation-directory)
857 default-directory)))
858 (apply 'compilation-start (or compilation-arguments
859 `(,(eval compile-command))))))
860
861 (defcustom compilation-scroll-output nil
862 "*Non-nil to scroll the *compilation* buffer window as output appears.
863
864 Setting it causes the Compilation mode commands to put point at the
865 end of their output window so that the end of the output is always
866 visible rather than the beginning."
867 :type 'boolean
868 :version "20.3"
869 :group 'compilation)
870
871
872 (defun compilation-buffer-name (mode-name name-function)
873 "Return the name of a compilation buffer to use.
874 If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
875 to determine the buffer name.
876 Likewise if `compilation-buffer-name-function' is non-nil.
877 If current buffer is in Compilation mode for the same mode name
878 return the name of the current buffer, so that it gets reused.
879 Otherwise, construct a buffer name from MODE-NAME."
880 (cond (name-function
881 (funcall name-function mode-name))
882 (compilation-buffer-name-function
883 (funcall compilation-buffer-name-function mode-name))
884 ((eq major-mode (nth 1 compilation-arguments))
885 (buffer-name))
886 (t
887 (concat "*" (downcase mode-name) "*"))))
888
889 ;; This is a rough emulation of the old hack, until the transition to new
890 ;; compile is complete.
891 (defun compile-internal (command error-message
892 &optional name-of-mode parser
893 error-regexp-alist name-function
894 enter-regexp-alist leave-regexp-alist
895 file-regexp-alist nomessage-regexp-alist
896 no-async highlight-regexp local-map)
897 (if parser
898 (error "Compile now works very differently, see `compilation-error-regexp-alist'"))
899 (let ((compilation-error-regexp-alist
900 (append file-regexp-alist (or error-regexp-alist
901 compilation-error-regexp-alist)))
902 (compilation-error (replace-regexp-in-string "^No more \\(.+\\)s\\.?"
903 "\\1" error-message)))
904 (compilation-start command nil name-function highlight-regexp)))
905 (make-obsolete 'compile-internal 'compilation-start)
906
907 (defun compilation-start (command &optional mode name-function highlight-regexp)
908 "Run compilation command COMMAND (low level interface).
909 If COMMAND starts with a cd command, that becomes the `default-directory'.
910 The rest of the arguments are optional; for them, nil means use the default.
911
912 MODE is the major mode to set in the compilation buffer. Mode
913 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
914 NAME-FUNCTION is a function called to name the buffer.
915
916 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
917 the matching section of the visited source line; the default is to use the
918 global value of `compilation-highlight-regexp'.
919
920 Returns the compilation buffer created."
921 (or mode (setq mode 'compilation-mode))
922 (let* ((name-of-mode
923 (if (eq mode t)
924 (prog1 "compilation" (require 'comint))
925 (replace-regexp-in-string "-mode$" "" (symbol-name mode))))
926 (thisdir default-directory)
927 outwin outbuf)
928 (with-current-buffer
929 (setq outbuf
930 (get-buffer-create
931 (compilation-buffer-name name-of-mode name-function)))
932 (let ((comp-proc (get-buffer-process (current-buffer))))
933 (if comp-proc
934 (if (or (not (eq (process-status comp-proc) 'run))
935 (yes-or-no-p
936 (format "A %s process is running; kill it? "
937 name-of-mode)))
938 (condition-case ()
939 (progn
940 (interrupt-process comp-proc)
941 (sit-for 1)
942 (delete-process comp-proc))
943 (error nil))
944 (error "Cannot have two processes in `%s' at once"
945 (buffer-name)))))
946 (buffer-disable-undo (current-buffer))
947 ;; first transfer directory from where M-x compile was called
948 (setq default-directory thisdir)
949 ;; Make compilation buffer read-only. The filter can still write it.
950 ;; Clear out the compilation buffer.
951 (let ((inhibit-read-only t)
952 (default-directory thisdir))
953 ;; Then evaluate a cd command if any, but don't perform it yet, else start-command
954 ;; would do it again through the shell: (cd "..") AND sh -c "cd ..; make"
955 (cd (if (string-match "^\\s *cd\\(?:\\s +\\(\\S +?\\)\\)?\\s *[;&\n]" command)
956 (if (match-end 1)
957 (substitute-env-vars (match-string 1 command))
958 "~")
959 default-directory))
960 (erase-buffer)
961 ;; Select the desired mode.
962 (if (not (eq mode t))
963 (funcall mode)
964 (setq buffer-read-only nil)
965 (with-no-warnings (comint-mode))
966 (compilation-shell-minor-mode))
967 (if highlight-regexp
968 (set (make-local-variable 'compilation-highlight-regexp)
969 highlight-regexp))
970 ;; Output a mode setter, for saving and later reloading this buffer.
971 (insert "-*- mode: " name-of-mode
972 "; default-directory: " (prin1-to-string default-directory)
973 " -*-\n" command "\n")
974 (setq thisdir default-directory))
975 (set-buffer-modified-p nil))
976 ;; If we're already in the compilation buffer, go to the end
977 ;; of the buffer, so point will track the compilation output.
978 (if (eq outbuf (current-buffer))
979 (goto-char (point-max)))
980 ;; Pop up the compilation buffer.
981 (setq outwin (display-buffer outbuf nil t))
982 (with-current-buffer outbuf
983 (let ((process-environment
984 (append
985 compilation-environment
986 (if (if (boundp 'system-uses-terminfo) ; `if' for compiler warning
987 system-uses-terminfo)
988 (list "TERM=dumb" "TERMCAP="
989 (format "COLUMNS=%d" (window-width)))
990 (list "TERM=emacs"
991 (format "TERMCAP=emacs:co#%d:tc=unknown:"
992 (window-width))))
993 ;; Set the EMACS variable, but
994 ;; don't override users' setting of $EMACS.
995 (unless (getenv "EMACS") '("EMACS=t"))
996 (copy-sequence process-environment))))
997 (set (make-local-variable 'compilation-arguments)
998 (list command mode name-function highlight-regexp))
999 (set (make-local-variable 'revert-buffer-function)
1000 'compilation-revert-buffer)
1001 (set-window-start outwin (point-min))
1002 (or (eq outwin (selected-window))
1003 (set-window-point outwin (if compilation-scroll-output
1004 (point)
1005 (point-min))))
1006 ;; The setup function is called before compilation-set-window-height
1007 ;; so it can set the compilation-window-height buffer locally.
1008 (if compilation-process-setup-function
1009 (funcall compilation-process-setup-function))
1010 (compilation-set-window-height outwin)
1011 ;; Start the compilation.
1012 (if (fboundp 'start-process)
1013 (let ((proc (if (eq mode t)
1014 (get-buffer-process
1015 (with-no-warnings
1016 (comint-exec outbuf (downcase mode-name)
1017 shell-file-name nil `("-c" ,command))))
1018 (start-process-shell-command (downcase mode-name)
1019 outbuf command))))
1020 ;; Make the buffer's mode line show process state.
1021 (setq mode-line-process '(":%s"))
1022 (set-process-sentinel proc 'compilation-sentinel)
1023 (set-process-filter proc 'compilation-filter)
1024 (set-marker (process-mark proc) (point) outbuf)
1025 (setq compilation-in-progress
1026 (cons proc compilation-in-progress)))
1027 ;; No asynchronous processes available.
1028 (message "Executing `%s'..." command)
1029 ;; Fake modeline display as if `start-process' were run.
1030 (setq mode-line-process ":run")
1031 (force-mode-line-update)
1032 (sit-for 0) ; Force redisplay
1033 (let* ((buffer-read-only nil) ; call-process needs to modify outbuf
1034 (status (call-process shell-file-name nil outbuf nil "-c"
1035 command)))
1036 (cond ((numberp status)
1037 (compilation-handle-exit 'exit status
1038 (if (zerop status)
1039 "finished\n"
1040 (format "\
1041 exited abnormally with code %d\n"
1042 status))))
1043 ((stringp status)
1044 (compilation-handle-exit 'signal status
1045 (concat status "\n")))
1046 (t
1047 (compilation-handle-exit 'bizarre status status))))
1048 ;; Without async subprocesses, the buffer is not yet
1049 ;; fontified, so fontify it now.
1050 (let ((font-lock-verbose nil)) ; shut up font-lock messages
1051 (font-lock-fontify-buffer))
1052 (set-buffer-modified-p nil)
1053 (message "Executing `%s'...done" command)))
1054 ;; Now finally cd to where the shell started make/grep/...
1055 (setq default-directory thisdir))
1056 (if (buffer-local-value 'compilation-scroll-output outbuf)
1057 (save-selected-window
1058 (select-window outwin)
1059 (goto-char (point-max))))
1060 ;; Make it so the next C-x ` will use this buffer.
1061 (setq next-error-last-buffer outbuf)))
1062
1063 (defun compilation-set-window-height (window)
1064 "Set the height of WINDOW according to `compilation-window-height'."
1065 (let ((height (buffer-local-value 'compilation-window-height (window-buffer window))))
1066 (and height
1067 (= (window-width window) (frame-width (window-frame window)))
1068 ;; If window is alone in its frame, aside from a minibuffer,
1069 ;; don't change its height.
1070 (not (eq window (frame-root-window (window-frame window))))
1071 ;; Stef said that doing the saves in this order is safer:
1072 (save-excursion
1073 (save-selected-window
1074 (select-window window)
1075 (enlarge-window (- height (window-height))))))))
1076
1077 (defvar compilation-menu-map
1078 (let ((map (make-sparse-keymap "Errors")))
1079 (define-key map [stop-subjob]
1080 '("Stop Compilation" . kill-compilation))
1081 (define-key map [compilation-mode-separator2]
1082 '("----" . nil))
1083 (define-key map [compilation-first-error]
1084 '("First Error" . first-error))
1085 (define-key map [compilation-previous-error]
1086 '("Previous Error" . previous-error))
1087 (define-key map [compilation-next-error]
1088 '("Next Error" . next-error))
1089 map))
1090
1091 (defvar compilation-minor-mode-map
1092 (let ((map (make-sparse-keymap)))
1093 (define-key map [mouse-2] 'compile-goto-error)
1094 (define-key map [follow-link] 'mouse-face)
1095 (define-key map "\C-c\C-c" 'compile-goto-error)
1096 (define-key map "\C-m" 'compile-goto-error)
1097 (define-key map "\C-c\C-k" 'kill-compilation)
1098 (define-key map "\M-n" 'compilation-next-error)
1099 (define-key map "\M-p" 'compilation-previous-error)
1100 (define-key map "\M-{" 'compilation-previous-file)
1101 (define-key map "\M-}" 'compilation-next-file)
1102 ;; Set up the menu-bar
1103 (define-key map [menu-bar compilation]
1104 (cons "Errors" compilation-menu-map))
1105 map)
1106 "Keymap for `compilation-minor-mode'.")
1107
1108 (defvar compilation-shell-minor-mode-map
1109 (let ((map (make-sparse-keymap)))
1110 (define-key map "\M-\C-m" 'compile-goto-error)
1111 (define-key map "\M-\C-n" 'compilation-next-error)
1112 (define-key map "\M-\C-p" 'compilation-previous-error)
1113 (define-key map "\M-{" 'compilation-previous-file)
1114 (define-key map "\M-}" 'compilation-next-file)
1115 ;; Set up the menu-bar
1116 (define-key map [menu-bar compilation]
1117 (cons "Errors" compilation-menu-map))
1118 map)
1119 "Keymap for `compilation-shell-minor-mode'.")
1120
1121 (defvar compilation-button-map
1122 (let ((map (make-sparse-keymap)))
1123 (define-key map [mouse-2] 'compile-goto-error)
1124 (define-key map [follow-link] 'mouse-face)
1125 (define-key map "\C-m" 'compile-goto-error)
1126 map)
1127 "Keymap for compilation-message buttons.")
1128 (fset 'compilation-button-map compilation-button-map)
1129
1130 (defvar compilation-mode-map
1131 (let ((map (make-sparse-keymap)))
1132 ;; Don't inherit from compilation-minor-mode-map,
1133 ;; because that introduces a menu bar item we don't want.
1134 ;; That confuses C-down-mouse-3.
1135 (define-key map [mouse-2] 'compile-goto-error)
1136 (define-key map [follow-link] 'mouse-face)
1137 (define-key map "\C-c\C-c" 'compile-goto-error)
1138 (define-key map "\C-m" 'compile-goto-error)
1139 (define-key map "\C-c\C-k" 'kill-compilation)
1140 (define-key map "\M-n" 'compilation-next-error)
1141 (define-key map "\M-p" 'compilation-previous-error)
1142 (define-key map "\M-{" 'compilation-previous-file)
1143 (define-key map "\M-}" 'compilation-next-file)
1144 (define-key map "\t" 'compilation-next-error)
1145 (define-key map [backtab] 'compilation-previous-error)
1146
1147 (define-key map " " 'scroll-up)
1148 (define-key map "\^?" 'scroll-down)
1149 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1150
1151 ;; Set up the menu-bar
1152 (let ((submap (make-sparse-keymap "Compile")))
1153 (define-key map [menu-bar compilation]
1154 (cons "Compile" submap))
1155 (set-keymap-parent submap compilation-menu-map))
1156 (define-key map [menu-bar compilation compilation-separator2]
1157 '("----" . nil))
1158 (define-key map [menu-bar compilation compilation-grep]
1159 '("Search Files (grep)" . grep))
1160 (define-key map [menu-bar compilation compilation-recompile]
1161 '("Recompile" . recompile))
1162 (define-key map [menu-bar compilation compilation-compile]
1163 '("Compile..." . compile))
1164 map)
1165 "Keymap for compilation log buffers.
1166 `compilation-minor-mode-map' is a parent of this.")
1167
1168 (put 'compilation-mode 'mode-class 'special)
1169
1170 (defvar compilation-skip-to-next-location t
1171 "*If non-nil, skip multiple error messages for the same source location.")
1172
1173 (defcustom compilation-skip-threshold 1
1174 "*Compilation motion commands skip less important messages.
1175 The value can be either 2 -- skip anything less than error, 1 --
1176 skip anything less than warning or 0 -- don't skip any messages.
1177 Note that all messages not positively identified as warning or
1178 info, are considered errors."
1179 :type '(choice (const :tag "Warnings and info" 2)
1180 (const :tag "Info" 1)
1181 (const :tag "None" 0))
1182 :group 'compilation
1183 :version "22.1")
1184
1185 (defcustom compilation-skip-visited nil
1186 "*Compilation motion commands skip visited messages if this is t.
1187 Visited messages are ones for which the file, line and column have been jumped
1188 to from the current content in the current compilation buffer, even if it was
1189 from a different message."
1190 :type 'boolean
1191 :group 'compilation
1192 :version "22.1")
1193
1194 ;;;###autoload
1195 (defun compilation-mode (&optional name-of-mode)
1196 "Major mode for compilation log buffers.
1197 \\<compilation-mode-map>To visit the source for a line-numbered error,
1198 move point to the error message line and type \\[compile-goto-error].
1199 To kill the compilation, type \\[kill-compilation].
1200
1201 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
1202
1203 \\{compilation-mode-map}"
1204 (interactive)
1205 (kill-all-local-variables)
1206 (use-local-map compilation-mode-map)
1207 (setq major-mode 'compilation-mode
1208 mode-name (or name-of-mode "Compilation"))
1209 (set (make-local-variable 'page-delimiter)
1210 compilation-page-delimiter)
1211 (compilation-setup)
1212 (setq buffer-read-only t)
1213 (run-mode-hooks 'compilation-mode-hook))
1214
1215 (defmacro define-compilation-mode (mode name doc &rest body)
1216 "This is like `define-derived-mode' without the PARENT argument.
1217 The parent is always `compilation-mode' and the customizable `compilation-...'
1218 variables are also set from the name of the mode you have chosen, by replacing
1219 the fist word, e.g `compilation-scroll-output' from `grep-scroll-output' if that
1220 variable exists."
1221 (let ((mode-name (replace-regexp-in-string "-mode\\'" "" (symbol-name mode))))
1222 `(define-derived-mode ,mode compilation-mode ,name
1223 ,doc
1224 ,@(mapcar (lambda (v)
1225 (setq v (cons v
1226 (intern-soft (replace-regexp-in-string
1227 "^compilation" mode-name
1228 (symbol-name v)))))
1229 (and (cdr v)
1230 (or (boundp (cdr v))
1231 (if (boundp 'byte-compile-bound-variables)
1232 (memq (cdr v) byte-compile-bound-variables)))
1233 `(set (make-local-variable ',(car v)) ,(cdr v))))
1234 '(compilation-buffer-name-function
1235 compilation-directory-matcher
1236 compilation-error
1237 compilation-error-regexp-alist
1238 compilation-error-regexp-alist-alist
1239 compilation-error-screen-columns
1240 compilation-finish-function
1241 compilation-finish-functions
1242 compilation-first-column
1243 compilation-mode-font-lock-keywords
1244 compilation-page-delimiter
1245 compilation-parse-errors-filename-function
1246 compilation-process-setup-function
1247 compilation-scroll-output
1248 compilation-search-path
1249 compilation-skip-threshold
1250 compilation-window-height))
1251 ,@body)))
1252
1253 (defun compilation-revert-buffer (ignore-auto noconfirm)
1254 (if buffer-file-name
1255 (let (revert-buffer-function)
1256 (revert-buffer ignore-auto noconfirm))
1257 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1258 (apply 'compilation-start compilation-arguments))))
1259
1260 (defvar compilation-current-error nil
1261 "Marker to the location from where the next error will be found.
1262 The global commands next/previous/first-error/goto-error use this.")
1263
1264 (defvar compilation-messages-start nil
1265 "Buffer position of the beginning of the compilation messages.
1266 If nil, use the beginning of buffer.")
1267
1268 ;; A function name can't be a hook, must be something with a value.
1269 (defconst compilation-turn-on-font-lock 'turn-on-font-lock)
1270
1271 (defun compilation-setup (&optional minor)
1272 "Prepare the buffer for the compilation parsing commands to work.
1273 Optional argument MINOR indicates this is called from
1274 `compilation-minor-mode'."
1275 (make-local-variable 'compilation-current-error)
1276 (make-local-variable 'compilation-messages-start)
1277 (make-local-variable 'compilation-error-screen-columns)
1278 (make-local-variable 'overlay-arrow-position)
1279 (set (make-local-variable 'overlay-arrow-string) "")
1280 (setq next-error-overlay-arrow-position nil)
1281 (add-hook 'kill-buffer-hook
1282 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
1283 ;; Note that compilation-next-error-function is for interfacing
1284 ;; with the next-error function in simple.el, and it's only
1285 ;; coincidentally named similarly to compilation-next-error.
1286 (setq next-error-function 'compilation-next-error-function)
1287 (set (make-local-variable 'font-lock-extra-managed-props)
1288 '(directory message help-echo mouse-face debug))
1289 (set (make-local-variable 'compilation-locs)
1290 (make-hash-table :test 'equal :weakness 'value))
1291 ;; lazy-lock would never find the message unless it's scrolled to.
1292 ;; jit-lock might fontify some things too late.
1293 (set (make-local-variable 'font-lock-support-mode) nil)
1294 (set (make-local-variable 'font-lock-maximum-size) nil)
1295 (let ((fld font-lock-defaults))
1296 (if (and minor fld)
1297 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1298 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t)))
1299 (if minor
1300 (if font-lock-mode
1301 (if fld
1302 (font-lock-fontify-buffer)
1303 (font-lock-change-mode)
1304 (turn-on-font-lock))
1305 (turn-on-font-lock))
1306 ;; maybe defer font-lock till after derived mode is set up
1307 (run-mode-hooks 'compilation-turn-on-font-lock))))
1308
1309 ;;;###autoload
1310 (define-minor-mode compilation-shell-minor-mode
1311 "Toggle compilation shell minor mode.
1312 With arg, turn compilation mode on if and only if arg is positive.
1313 In this minor mode, all the error-parsing commands of the
1314 Compilation major mode are available but bound to keys that don't
1315 collide with Shell mode. See `compilation-mode'.
1316 Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
1317 nil " Shell-Compile"
1318 :group 'compilation
1319 (if compilation-shell-minor-mode
1320 (compilation-setup t)
1321 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1322 (font-lock-fontify-buffer)))
1323
1324 ;;;###autoload
1325 (define-minor-mode compilation-minor-mode
1326 "Toggle compilation minor mode.
1327 With arg, turn compilation mode on if and only if arg is positive.
1328 In this minor mode, all the error-parsing commands of the
1329 Compilation major mode are available. See `compilation-mode'.
1330 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
1331 nil " Compilation"
1332 :group 'compilation
1333 (if compilation-minor-mode
1334 (compilation-setup t)
1335 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1336 (font-lock-fontify-buffer)))
1337
1338 (defun compilation-handle-exit (process-status exit-status msg)
1339 "Write MSG in the current buffer and hack its mode-line-process."
1340 (let ((inhibit-read-only t)
1341 (status (if compilation-exit-message-function
1342 (funcall compilation-exit-message-function
1343 process-status exit-status msg)
1344 (cons msg exit-status)))
1345 (omax (point-max))
1346 (opoint (point)))
1347 ;; Record where we put the message, so we can ignore it later on.
1348 (goto-char omax)
1349 (insert ?\n mode-name " " (car status))
1350 (if (and (numberp compilation-window-height)
1351 (zerop compilation-window-height))
1352 (message "%s" (cdr status)))
1353 (if (bolp)
1354 (forward-char -1))
1355 (insert " at " (substring (current-time-string) 0 19))
1356 (goto-char (point-max))
1357 ;; Prevent that message from being recognized as a compilation error.
1358 (add-text-properties omax (point)
1359 (append '(compilation-handle-exit t) nil))
1360 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
1361 ;; Force mode line redisplay soon.
1362 (force-mode-line-update)
1363 (if (and opoint (< opoint omax))
1364 (goto-char opoint))
1365 (with-no-warnings
1366 (if compilation-finish-function
1367 (funcall compilation-finish-function (current-buffer) msg)))
1368 (let ((functions compilation-finish-functions))
1369 (while functions
1370 (funcall (car functions) (current-buffer) msg)
1371 (setq functions (cdr functions))))))
1372
1373 ;; Called when compilation process changes state.
1374 (defun compilation-sentinel (proc msg)
1375 "Sentinel for compilation buffers."
1376 (if (memq (process-status proc) '(exit signal))
1377 (let ((buffer (process-buffer proc)))
1378 (if (null (buffer-name buffer))
1379 ;; buffer killed
1380 (set-process-buffer proc nil)
1381 (with-current-buffer buffer
1382 ;; Write something in the compilation buffer
1383 ;; and hack its mode line.
1384 (compilation-handle-exit (process-status proc)
1385 (process-exit-status proc)
1386 msg)
1387 ;; Since the buffer and mode line will show that the
1388 ;; process is dead, we can delete it now. Otherwise it
1389 ;; will stay around until M-x list-processes.
1390 (delete-process proc)))
1391 (setq compilation-in-progress (delq proc compilation-in-progress)))))
1392
1393 (defun compilation-filter (proc string)
1394 "Process filter for compilation buffers.
1395 Just inserts the text, but uses `insert-before-markers'."
1396 (if (buffer-name (process-buffer proc))
1397 (with-current-buffer (process-buffer proc)
1398 (let ((inhibit-read-only t))
1399 (save-excursion
1400 (goto-char (process-mark proc))
1401 (insert-before-markers string)
1402 (run-hooks 'compilation-filter-hook))))))
1403
1404 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
1405 (defsubst compilation-buffer-internal-p ()
1406 "Test if inside a compilation buffer."
1407 (local-variable-p 'compilation-locs))
1408
1409 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
1410 (defsubst compilation-buffer-p (buffer)
1411 "Test if BUFFER is a compilation buffer."
1412 (with-current-buffer buffer
1413 (compilation-buffer-internal-p)))
1414
1415 (defmacro compilation-loop (< property-change 1+ error)
1416 `(while (,< n 0)
1417 (or (setq pt (,property-change pt 'message))
1418 (error ,error compilation-error))
1419 ;; prop 'message usually has 2 changes, on and off, so re-search if off
1420 (or (setq msg (get-text-property pt 'message))
1421 (if (setq pt (,property-change pt 'message))
1422 (setq msg (get-text-property pt 'message)))
1423 (error ,error compilation-error))
1424 (or (< (cadr msg) compilation-skip-threshold)
1425 (if different-file
1426 (eq (prog1 last (setq last (nth 2 (car msg))))
1427 last))
1428 (if compilation-skip-visited
1429 (nthcdr 4 (car msg)))
1430 (if compilation-skip-to-next-location
1431 (eq (car msg) loc))
1432 ;; count this message only if none of the above are true
1433 (setq n (,1+ n)))))
1434
1435 (defun compilation-next-error (n &optional different-file pt)
1436 "Move point to the next error in the compilation buffer.
1437 Prefix arg N says how many error messages to move forwards (or
1438 backwards, if negative).
1439 Does NOT find the source line like \\[next-error]."
1440 (interactive "p")
1441 (or (compilation-buffer-p (current-buffer))
1442 (error "Not in a compilation buffer"))
1443 (or pt (setq pt (point)))
1444 (let* ((msg (get-text-property pt 'message))
1445 (loc (car msg))
1446 last)
1447 (if (zerop n)
1448 (unless (or msg ; find message near here
1449 (setq msg (get-text-property (max (1- pt) (point-min))
1450 'message)))
1451 (setq pt (previous-single-property-change pt 'message nil
1452 (line-beginning-position)))
1453 (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message))
1454 (setq pt (next-single-property-change pt 'message nil
1455 (line-end-position)))
1456 (or (setq msg (get-text-property pt 'message))
1457 (setq pt (point)))))
1458 (setq last (nth 2 (car msg)))
1459 (if (>= n 0)
1460 (compilation-loop > next-single-property-change 1-
1461 (if (get-buffer-process (current-buffer))
1462 "No more %ss yet"
1463 "Moved past last %s"))
1464 ;; Don't move "back" to message at or before point.
1465 ;; Pass an explicit (point-min) to make sure pt is non-nil.
1466 (setq pt (previous-single-property-change pt 'message nil (point-min)))
1467 (compilation-loop < previous-single-property-change 1+
1468 "Moved back before first %s")))
1469 (goto-char pt)
1470 (or msg
1471 (error "No %s here" compilation-error))))
1472
1473 (defun compilation-previous-error (n)
1474 "Move point to the previous error in the compilation buffer.
1475 Prefix arg N says how many error messages to move backwards (or
1476 forwards, if negative).
1477 Does NOT find the source line like \\[previous-error]."
1478 (interactive "p")
1479 (compilation-next-error (- n)))
1480
1481 (defun compilation-next-file (n)
1482 "Move point to the next error for a different file than the current one.
1483 Prefix arg N says how many files to move forwards (or backwards, if negative)."
1484 (interactive "p")
1485 (compilation-next-error n t))
1486
1487 (defun compilation-previous-file (n)
1488 "Move point to the previous error for a different file than the current one.
1489 Prefix arg N says how many files to move backwards (or forwards, if negative)."
1490 (interactive "p")
1491 (compilation-next-file (- n)))
1492
1493 (defun kill-compilation ()
1494 "Kill the process made by the \\[compile] or \\[grep] commands."
1495 (interactive)
1496 (let ((buffer (compilation-find-buffer)))
1497 (if (get-buffer-process buffer)
1498 (interrupt-process (get-buffer-process buffer))
1499 (error "The compilation process is not running"))))
1500
1501 (defalias 'compile-mouse-goto-error 'compile-goto-error)
1502
1503 (defun compile-goto-error (&optional event)
1504 "Visit the source for the error message at point.
1505 Use this command in a compilation log buffer. Sets the mark at point there."
1506 (interactive (list last-input-event))
1507 (if event (posn-set-point (event-end event)))
1508 (or (compilation-buffer-p (current-buffer))
1509 (error "Not in a compilation buffer"))
1510 (if (get-text-property (point) 'directory)
1511 (dired-other-window (car (get-text-property (point) 'directory)))
1512 (push-mark)
1513 (setq compilation-current-error (point))
1514 (next-error 0)))
1515
1516 ;; Return a compilation buffer.
1517 ;; If the current buffer is a compilation buffer, return it.
1518 ;; Otherwise, look for a compilation buffer and signal an error
1519 ;; if there are none.
1520 (defun compilation-find-buffer (&optional avoid-current)
1521 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p))
1522
1523 ;;;###autoload
1524 (defun compilation-next-error-function (n &optional reset)
1525 "Advance to the next error message and visit the file where the error was.
1526 This is the value of `next-error-function' in Compilation buffers."
1527 (interactive "p")
1528 (when reset
1529 (setq compilation-current-error nil))
1530 (let* ((columns compilation-error-screen-columns) ; buffer's local value
1531 (last 1)
1532 (loc (compilation-next-error (or n 1) nil
1533 (or compilation-current-error
1534 compilation-messages-start
1535 (point-min))))
1536 (end-loc (nth 2 loc))
1537 (marker (point-marker)))
1538 (setq compilation-current-error (point-marker)
1539 overlay-arrow-position
1540 (if (bolp)
1541 compilation-current-error
1542 (copy-marker (line-beginning-position)))
1543 loc (car loc))
1544 ;; If loc contains no marker, no error in that file has been visited. If
1545 ;; the marker is invalid the buffer has been killed. So, recalculate all
1546 ;; markers for that file.
1547 (unless (and (nth 3 loc) (marker-buffer (nth 3 loc)))
1548 (with-current-buffer (compilation-find-file marker (caar (nth 2 loc))
1549 (or (cdar (nth 2 loc))
1550 default-directory))
1551 (save-restriction
1552 (widen)
1553 (goto-char (point-min))
1554 ;; Treat file's found lines in forward order, 1 by 1.
1555 (dolist (line (reverse (cddr (nth 2 loc))))
1556 (when (car line) ; else this is a filename w/o a line#
1557 (beginning-of-line (- (car line) last -1))
1558 (setq last (car line)))
1559 ;; Treat line's found columns and store/update a marker for each.
1560 (dolist (col (cdr line))
1561 (if (car col)
1562 (if (eq (car col) -1) ; special case for range end
1563 (end-of-line)
1564 (compilation-move-to-column (car col) columns))
1565 (beginning-of-line)
1566 (skip-chars-forward " \t"))
1567 (if (nth 3 col)
1568 (set-marker (nth 3 col) (point))
1569 (setcdr (nthcdr 2 col) `(,(point-marker)))))))))
1570 (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc))
1571 (setcdr (nthcdr 3 loc) t))) ; Set this one as visited.
1572
1573 (defvar compilation-gcpro nil
1574 "Internal variable used to keep some values from being GC'd.")
1575 (make-variable-buffer-local 'compilation-gcpro)
1576
1577 (defun compilation-fake-loc (marker file &optional line col)
1578 "Preassociate MARKER with FILE.
1579 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
1580 This is useful when you compile temporary files, but want
1581 automatic translation of the messages to the real buffer from
1582 which the temporary file came. This only works if done before a
1583 message about FILE appears!
1584
1585 Optional args LINE and COL default to 1 and beginning of
1586 indentation respectively. The marker is expected to reflect
1587 this. In the simplest case the marker points to the first line
1588 of the region that was saved to the temp file.
1589
1590 If you concatenate several regions into the temp file (e.g. a
1591 header with variable assignments and a code region), you must
1592 call this several times, once each for the last line of one
1593 region and the first line of the next region."
1594 (or (consp file) (setq file (list file)))
1595 (setq file (compilation-get-file-structure file))
1596 ;; Between the current call to compilation-fake-loc and the first occurrence
1597 ;; of an error message referring to `file', the data is only kept is the
1598 ;; weak hash-table compilation-locs, so we need to prevent this entry
1599 ;; in compilation-locs from being GC'd away. --Stef
1600 (push file compilation-gcpro)
1601 (let ((loc (compilation-assq (or line 1) (cdr file))))
1602 (setq loc (compilation-assq col loc))
1603 (if (cdr loc)
1604 (setcdr (cddr loc) (list marker))
1605 (setcdr loc (list line file marker)))
1606 loc))
1607
1608 (defcustom compilation-context-lines nil
1609 "Display this many lines of leading context before the current message.
1610 If nil and the left fringe is displayed, don't scroll the
1611 compilation output window; an arrow in the left fringe points to
1612 the current message. If nil and there is no left fringe, the message
1613 displays at the top of the window; there is no arrow."
1614 :type '(choice integer (const :tag "No window scrolling" nil))
1615 :group 'compilation
1616 :version "22.1")
1617
1618 (defsubst compilation-set-window (w mk)
1619 "Align the compilation output window W with marker MK near top."
1620 (if (integerp compilation-context-lines)
1621 (set-window-start w (save-excursion
1622 (goto-char mk)
1623 (beginning-of-line
1624 (- 1 compilation-context-lines))
1625 (point)))
1626 ;; If there is no left fringe.
1627 (if (equal (car (window-fringes)) 0)
1628 (set-window-start w (save-excursion
1629 (goto-char mk)
1630 (beginning-of-line 1)
1631 (point)))))
1632 (set-window-point w mk))
1633
1634 (defvar next-error-highlight-timer)
1635
1636 (defun compilation-goto-locus (msg mk end-mk)
1637 "Jump to an error corresponding to MSG at MK.
1638 All arguments are markers. If END-MK is non-nil, mark is set there
1639 and overlay is highlighted between MK and END-MK."
1640 (if (eq (window-buffer (selected-window))
1641 (marker-buffer msg))
1642 ;; If the compilation buffer window is selected,
1643 ;; keep the compilation buffer in this window;
1644 ;; display the source in another window.
1645 (let ((pop-up-windows t))
1646 (pop-to-buffer (marker-buffer mk)))
1647 (if (window-dedicated-p (selected-window))
1648 (pop-to-buffer (marker-buffer mk))
1649 (switch-to-buffer (marker-buffer mk))))
1650 ;; If narrowing gets in the way of going to the right place, widen.
1651 (unless (eq (goto-char mk) (point))
1652 (widen)
1653 (goto-char mk))
1654 (if end-mk
1655 (push-mark end-mk t)
1656 (if mark-active (setq mark-active)))
1657 ;; If hideshow got in the way of
1658 ;; seeing the right place, open permanently.
1659 (dolist (ov (overlays-at (point)))
1660 (when (eq 'hs (overlay-get ov 'invisible))
1661 (delete-overlay ov)
1662 (goto-char mk)))
1663
1664 ;; Show compilation buffer in other window, scrolled to this error.
1665 (let* ((pop-up-windows t)
1666 ;; Use an existing window if it is in a visible frame.
1667 (w (or (get-buffer-window (marker-buffer msg) 'visible)
1668 ;; Pop up a window.
1669 (display-buffer (marker-buffer msg))))
1670 (highlight-regexp (with-current-buffer (marker-buffer msg)
1671 ;; also do this while we change buffer
1672 (compilation-set-window w msg)
1673 compilation-highlight-regexp)))
1674 (compilation-set-window-height w)
1675
1676 (when highlight-regexp
1677 (if (timerp next-error-highlight-timer)
1678 (cancel-timer next-error-highlight-timer))
1679 (unless compilation-highlight-overlay
1680 (setq compilation-highlight-overlay
1681 (make-overlay (point-min) (point-min)))
1682 (overlay-put compilation-highlight-overlay 'face 'next-error))
1683 (with-current-buffer (marker-buffer mk)
1684 (save-excursion
1685 (if end-mk (goto-char end-mk) (end-of-line))
1686 (let ((end (point)))
1687 (if mk (goto-char mk) (beginning-of-line))
1688 (if (and (stringp highlight-regexp)
1689 (re-search-forward highlight-regexp end t))
1690 (progn
1691 (goto-char (match-beginning 0))
1692 (move-overlay compilation-highlight-overlay
1693 (match-beginning 0) (match-end 0)
1694 (current-buffer)))
1695 (move-overlay compilation-highlight-overlay
1696 (point) end (current-buffer)))
1697 (if (numberp next-error-highlight)
1698 (setq next-error-highlight-timer
1699 (run-at-time next-error-highlight nil 'delete-overlay
1700 compilation-highlight-overlay)))
1701 (if (not (or (eq next-error-highlight t)
1702 (numberp next-error-highlight)))
1703 (delete-overlay compilation-highlight-overlay))))))
1704 (when (and (eq next-error-highlight 'fringe-arrow))
1705 (setq next-error-overlay-arrow-position
1706 (copy-marker (line-beginning-position))))))
1707
1708 \f
1709 (defun compilation-find-file (marker filename dir &rest formats)
1710 "Find a buffer for file FILENAME.
1711 Search the directories in `compilation-search-path'.
1712 A nil in `compilation-search-path' means to try the
1713 current directory, which is passed in DIR.
1714 If FILENAME is not found at all, ask the user where to find it.
1715 Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
1716 (or formats (setq formats '("%s")))
1717 (save-excursion
1718 (let ((dirs compilation-search-path)
1719 buffer thisdir fmts name)
1720 (if (file-name-absolute-p filename)
1721 ;; The file name is absolute. Use its explicit directory as
1722 ;; the first in the search path, and strip it from FILENAME.
1723 (setq filename (abbreviate-file-name (expand-file-name filename))
1724 dirs (cons (file-name-directory filename) dirs)
1725 filename (file-name-nondirectory filename)))
1726 ;; Now search the path.
1727 (while (and dirs (null buffer))
1728 (setq thisdir (or (car dirs) dir)
1729 fmts formats)
1730 ;; For each directory, try each format string.
1731 (while (and fmts (null buffer))
1732 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1733 buffer (and (file-exists-p name)
1734 (find-file-noselect name))
1735 fmts (cdr fmts)))
1736 (setq dirs (cdr dirs)))
1737 (or buffer
1738 ;; The file doesn't exist. Ask the user where to find it.
1739 (let ((pop-up-windows t))
1740 (compilation-set-window (display-buffer (marker-buffer marker))
1741 marker)
1742 (let ((name (expand-file-name
1743 (read-file-name
1744 (format "Find this error in: (default %s) "
1745 filename)
1746 dir filename t))))
1747 (if (file-directory-p name)
1748 (setq name (expand-file-name filename name)))
1749 (setq buffer (and (file-exists-p name)
1750 (find-file name))))))
1751 ;; Make intangible overlays tangible.
1752 (mapcar (function (lambda (ov)
1753 (when (overlay-get ov 'intangible)
1754 (overlay-put ov 'intangible nil))))
1755 (overlays-in (point-min) (point-max)))
1756 buffer)))
1757
1758 (defun compilation-get-file-structure (file &optional fmt)
1759 "Retrieve FILE's file-structure or create a new one.
1760 FILE should be (ABSOLUTE-FILENAME) or (RELATIVE-FILENAME . DIRNAME)."
1761
1762 (or (gethash file compilation-locs)
1763 ;; File was not previously encountered, at least not in the form passed.
1764 ;; Let's normalize it and look again.
1765 (let ((filename (car file))
1766 (default-directory (if (cdr file)
1767 (file-truename (cdr file))
1768 default-directory)))
1769
1770 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
1771 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
1772 ;; buffer.)
1773 (if (boundp 'comint-file-name-prefix)
1774 (if (file-name-absolute-p filename)
1775 (setq filename
1776 (concat (with-no-warnings comint-file-name-prefix) filename))
1777 (setq default-directory
1778 (file-truename
1779 (concat (with-no-warnings comint-file-name-prefix) default-directory)))))
1780
1781 ;; If compilation-parse-errors-filename-function is
1782 ;; defined, use it to process the filename.
1783 (when compilation-parse-errors-filename-function
1784 (setq filename
1785 (funcall compilation-parse-errors-filename-function
1786 filename)))
1787
1788 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
1789 ;; file names like "./bar//foo.c" for file "bar/foo.c";
1790 ;; expand-file-name will collapse these into "/foo.c" and fail to find
1791 ;; the appropriate file. So we look for doubled slashes in the file
1792 ;; name and fix them.
1793 (setq filename (command-line-normalize-file-name filename))
1794
1795 ;; Now eliminate any "..", because find-file would get them wrong.
1796 ;; Make relative and absolute filenames, with or without links, the
1797 ;; same.
1798 (setq filename
1799 (list (abbreviate-file-name
1800 (file-truename (if (cdr file)
1801 (expand-file-name filename)
1802 filename)))))
1803
1804 ;; Store it for the possibly unnormalized name
1805 (puthash file
1806 ;; Retrieve or create file-structure for normalized name
1807 (or (gethash filename compilation-locs)
1808 (puthash filename (list filename fmt) compilation-locs))
1809 compilation-locs))))
1810
1811 (add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$")
1812
1813 ;;; Compatibility with the old compile.el.
1814
1815 (defun compile-buffer-substring (n) (if n (match-string n)))
1816
1817 (defun compilation-compat-error-properties (err)
1818 "Map old-style error ERR to new-style message."
1819 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
1820 ;; (MARKER . MARKER).
1821 (let ((dst (cdr err)))
1822 (if (markerp dst)
1823 ;; Must start with a face, for font-lock.
1824 `(face nil
1825 message ,(list (list nil nil nil dst) 2)
1826 help-echo "mouse-2: visit the source location"
1827 keymap compilation-button-map
1828 mouse-face highlight)
1829 ;; Too difficult to do it by hand: dispatch to the normal code.
1830 (let* ((file (pop dst))
1831 (line (pop dst))
1832 (col (pop dst))
1833 (filename (pop file))
1834 (dirname (pop file))
1835 (fmt (pop file)))
1836 (compilation-internal-error-properties
1837 (cons filename dirname) line nil col nil 2 fmt)))))
1838
1839 (defun compilation-compat-parse-errors (limit)
1840 (when compilation-parse-errors-function
1841 ;; FIXME: We should remove the rest of the compilation keywords
1842 ;; but we can't do that from here because font-lock is using
1843 ;; the value right now. --stef
1844 (save-excursion
1845 (setq compilation-error-list nil)
1846 ;; Reset compilation-parsing-end each time because font-lock
1847 ;; might force us the re-parse many times (typically because
1848 ;; some code adds some text-property to the output that we
1849 ;; already parsed). You might say "why reparse", well:
1850 ;; because font-lock has just removed the `message' property so
1851 ;; have to do it all over again.
1852 (if compilation-parsing-end
1853 (set-marker compilation-parsing-end (point))
1854 (setq compilation-parsing-end (point-marker)))
1855 (condition-case nil
1856 ;; Ignore any error: we're calling this function earlier than
1857 ;; in the old compile.el so things might not all be setup yet.
1858 (funcall compilation-parse-errors-function limit nil)
1859 (error nil))
1860 (dolist (err (if (listp compilation-error-list) compilation-error-list))
1861 (let* ((src (car err))
1862 (dst (cdr err))
1863 (loc (cond ((markerp dst) (list nil nil nil dst))
1864 ((consp dst)
1865 (list (nth 2 dst) (nth 1 dst)
1866 (cons (cdar dst) (caar dst)))))))
1867 (when loc
1868 (goto-char src)
1869 ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face)
1870 (put-text-property src (line-end-position)
1871 'message (list loc 2)))))))
1872 (goto-char limit)
1873 nil)
1874
1875 ;; Beware: this is not only compatiblity code. New code stil uses it. --Stef
1876 (defun compilation-forget-errors ()
1877 ;; In case we hit the same file/line specs, we want to recompute a new
1878 ;; marker for them, so flush our cache.
1879 (setq compilation-locs (make-hash-table :test 'equal :weakness 'value))
1880 (setq compilation-gcpro nil)
1881 ;; FIXME: the old code reset the directory-stack, so maybe we should
1882 ;; put a `directory change' marker of some sort, but where? -stef
1883 ;;
1884 ;; FIXME: The old code moved compilation-current-error (which was
1885 ;; virtually represented by a mix of compilation-parsing-end and
1886 ;; compilation-error-list) to point-min, but that was only meaningful for
1887 ;; the internal uses of compilation-forget-errors: all calls from external
1888 ;; packages seem to be followed by a move of compilation-parsing-end to
1889 ;; something equivalent to point-max. So we speculatively move
1890 ;; compilation-current-error to point-max (since the external package
1891 ;; won't know that it should do it). --stef
1892 (setq compilation-current-error nil)
1893 (let* ((proc (get-buffer-process (current-buffer)))
1894 (mark (if proc (process-mark proc)))
1895 (pos (or mark (point-max))))
1896 (setq compilation-messages-start
1897 ;; In the future, ignore the text already present in the buffer.
1898 ;; Since many process filter functions insert before markers,
1899 ;; we need to put ours just before the insertion point rather
1900 ;; than at the insertion point. If that's not possible, then
1901 ;; don't use a marker. --Stef
1902 (if (> pos (point-min)) (copy-marker (1- pos)) pos))))
1903
1904 ;;;###autoload
1905 (add-to-list 'auto-mode-alist '("\\.gcov\\'" . compilation-mode))
1906
1907 (provide 'compile)
1908
1909 ;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
1910 ;;; compile.el ends here