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