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