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