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