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