| blob | 6781862889cca9d1e22583dd0a73dcba5d962dcf |
1 ;;; compile.el --- run compiler as inferior of Emacs, parse error messages
3 ;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Authors: Roland McGrath <roland@gnu.org>,
7 ;; Daniel Pfeiffer <occitan@esperanto.org>
8 ;; Maintainer: FSF
9 ;; Keywords: tools, processes
11 ;; This file is part of GNU Emacs.
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 3, or (at your option)
16 ;; any later version.
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.
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.
28 ;;; Commentary:
30 ;; This package provides the compile facilities documented in the Emacs user's
31 ;; manual.
33 ;; This mode uses some complex data-structures:
35 ;; LOC (or location) is a list of (COLUMN LINE FILE-STRUCTURE)
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 TIMESTAMP . VISITED)
42 ;; for all LOCs pertaining to 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 ;; TIMESTAMP is necessary because of "incremental compilation": `omake -P'
47 ;; polls filesystem for changes and recompiles when a file is modified
48 ;; using the same *compilation* buffer. this necessitates re-parsing markers.
50 ;; FILE-STRUCTURE is a list of
51 ;; ((FILENAME . DIRECTORY) FORMATS (LINE LOC ...) ...)
53 ;; FILENAME is a string parsed from an error message. DIRECTORY is a string
54 ;; obtained by following directory change messages. DIRECTORY will be nil for
55 ;; an absolute filename. FORMATS is a list of formats to apply to FILENAME if
56 ;; a file of that name can't be found.
57 ;; The rest of the list is an alist of elements with LINE as key. The keys
58 ;; are either nil or line numbers. If present, nil comes first, followed by
59 ;; the numbers in decreasing order. The LOCs for each line are again an alist
60 ;; ordered the same way. Note that the whole file structure is referenced in
61 ;; every LOC.
63 ;; MESSAGE is a list of (LOC TYPE END-LOC)
65 ;; TYPE is 0 for info or 1 for warning if the message matcher identified it as
66 ;; such, 2 otherwise (for a real error). END-LOC is a LOC pointing to the
67 ;; other end, if the parsed message contained a range. If the end of the
68 ;; range didn't specify a COLUMN, it defaults to -1, meaning end of line.
69 ;; These are the value of the `message' text-properties in the compilation
70 ;; buffer.
72 ;;; Code:
83 "Run compiler as inferior of Emacs, parse error messages."
88 ;;;###autoload
90 "List of hook functions run by `compilation-mode' (see `run-mode-hooks')."
94 ;;;###autoload
96 "Number of lines in a compilation window. If nil, use Emacs default."
98 integer)
105 "Function to call to post-process filenames while parsing error messages.
106 It takes one arg FILENAME which is the name of a file as found
109 ;;;###autoload
111 "*Function to call to customize the compilation process.
112 This function is called immediately before the compilation process is
113 started. It can be used to set any variables or functions that are used
114 while processing the output of the compilation process. The function
115 is called with variables `compilation-buffer' and `compilation-window'
118 ;;;###autoload
120 "Function to compute the name of a compilation buffer.
121 The function receives one argument, the name of the major mode of the
122 compilation buffer. It should return a string.
125 ;;;###autoload
127 "Function to call when a compilation process finishes.
128 It is called with two arguments: the compilation buffer, and a string
132 "use `compilation-finish-functions', but it works a little differently."
135 ;;;###autoload
137 "Functions to call when a compilation process finishes.
138 Each function is called with two arguments: the compilation buffer,
145 minor-mode-alist)))
171 ;; Maven is a popular build tool for Java. Maven is Free Software.
202 "\\(^Warning .*\\)? line[ \n]\\([0-9]+\\)[ \n]\\(?:col \\([0-9]+\\)[ \n]\\)?file \\([^ :;\n]+\\)"
213 ;; fixme: should be `mips'
215 "^[-[:alnum:]_/ ]+: \\(?:\\(?:[sS]evere\\|[eE]rror\\|[wW]arnin\\(g\\)\\|[iI]nf\\(o\\)\\)[0-9 ]*: \\)?\
219 "^\\(?:[ \t]+at \\|==[0-9]+== +\\(?:at\\|b\\(y\\)\\)\\).+(\\([^()\n]+\\):\\([0-9]+\\))$" 2 3 nil (1))
229 ;; I have no idea what this first line is supposed to match, but it
230 ;; makes things ambiguous with output such as "foo:344:50:blabla" since
231 ;; the "foo" part can match this first line (in which case the file
232 ;; name as "344"). To avoid this, the second line disallows filenames
233 ;; exclusively composed of digits. --Stef
234 ;; Similarly, we get lots of false positives with messages including
235 ;; times of the form "HH:MM:SS" where MM is taken as a line number, so
236 ;; the last line tries to rule out message where the info after the
237 ;; line number starts with "SS". --Stef
247 ;; The `gnu' style above can incorrectly match gcc's "In file
248 ;; included from" message, so we process that first. -- cyd
258 "^makepp\\(?:\\(?:: warning\\(:\\).*?\\|\\(: Scanning\\|: [LR]e?l?oading makefile\\|: Imported\\|log:.*?\\) \\|: .*?\\)\
265 append)))
267 ;; Should be lint-1, lint-2 (SysV lint)
322 ;; Underlines over all lines of gcov output are too uncomfortable to read.
323 ;; However, hyperlinks embedded in the lines are useful.
324 ;; So I put default face on the lines; and then put
325 ;; compilation-*-face by manually to eliminate the underlines.
326 ;; The hyperlinks are still effective.
344 ;; podchecker error messages, per Pod::Checker.
345 ;; The style is from the Pod::Checker::poderror() function, eg.
346 ;; *** ERROR: Spurious text after =cut at line 193 in file foo.pm
347 ;;
348 ;; Plus end_pod() can give "at line EOF" instead of a
349 ;; number, so for that match "on line N" which is the
350 ;; originating spot, eg.
351 ;; *** ERROR: =over on line 37 without closing =back at line EOF in file bar.pm
352 ;;
353 ;; Plus command() can give both "on line N" and "at line N";
354 ;; the latter is desired and is matched because the .* is
355 ;; greedy.
356 ;; *** ERROR: =over on line 1 without closing =back (at head1) at line 3 in file x.pod
357 ;;
362 ;; perl Test module error messages.
363 ;; Style per the ok() function "$context", eg.
364 ;; # Failed test 1 in foo.t at line 6
365 ;;
369 ;; perl Test::Harness output, eg.
370 ;; NOK 1# Test 1 got: "1234" (t/foo.t at line 46)
371 ;;
372 ;; Test::Harness is slightly designed for tty output, since
373 ;; it prints CRs to overwrite progress messages, but if you
374 ;; run it in with M-x compile this pattern can at least step
375 ;; through the failures.
376 ;;
380 ;; The style comes from HTML::Lint::Error::as_string(), eg.
381 ;; index.html (13:1) Unknown element <fdjsk>
382 ;;
383 ;; The pattern only matches filenames without spaces, since that
384 ;; should be usual and should help reduce the chance of a false
385 ;; match of a message from some unrelated program.
386 ;;
387 ;; This message style is quite close to the "ibm" entry which is
388 ;; for IBM C, though that ibm bit doesn't put a space after the
389 ;; filename.
390 ;;
393 )
398 "Alist that specifies how to match errors in compiler output.
399 On GNU and Unix, any string is a valid filename, so these
400 matchers must make some common sense assumptions, which catch
401 normal cases. A shorter list will be lighter on resource usage.
403 Instead of an alist element, you can use a symbol, which is
404 looked up in `compilation-error-regexp-alist-alist'. You can see
405 the predefined symbols and their effects in the file
406 `etc/compilation.txt' (linked below if you are customizing this).
408 Each elt has the form (REGEXP FILE [LINE COLUMN TYPE HYPERLINK
409 HIGHLIGHT...]). If REGEXP matches, the FILE'th subexpression
410 gives the file name, and the LINE'th subexpression gives the line
411 number. The COLUMN'th subexpression gives the column number on
412 that line.
414 If FILE, LINE or COLUMN are nil or that index didn't match, that
415 information is not present on the matched line. In that case the
416 file name is assumed to be the same as the previous one in the
417 buffer, line number defaults to 1 and column defaults to
418 beginning of line's indentation.
420 FILE can also have the form (FILE FORMAT...), where the FORMATs
422 name, until a file of that name is found. Or FILE can also be a
423 function that returns (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
424 In the former case, FILENAME may be relative or absolute.
426 LINE can also be of the form (LINE . END-LINE) meaning a range
427 of lines. COLUMN can also be of the form (COLUMN . END-COLUMN)
428 meaning a range of columns starting on LINE and ending on
429 END-LINE, if that matched.
431 TYPE is 2 or nil for a real error or 1 for warning or 0 for info.
432 TYPE can also be of the form (WARNING . INFO). In that case this
433 will be equivalent to 1 if the WARNING'th subexpression matched
434 or else equivalent to 0 if the INFO'th subexpression matched.
435 See `compilation-error-face', `compilation-warning-face',
436 `compilation-info-face' and `compilation-skip-threshold'.
438 What matched the HYPERLINK'th subexpression has `mouse-face' and
439 `compilation-message-face' applied. If this is nil, the text
440 matched by the whole REGEXP becomes the hyperlink.
442 Additional HIGHLIGHTs as described under `font-lock-keywords' can
443 be added."
447 compilation-error-regexp-alist-alist))
452 ;;;###autoload(put 'compilation-directory 'safe-local-variable 'stringp)
458 "A list for tracking when directories are entered or left.
459 If nil, do not track directories, e.g. if all file names are absolute. The
460 first element is the REGEXP matching these messages. It can match any number
461 of variants, e.g. different languages. The remaining elements are all of the
462 form (DIR . LEAVE). If for any one of these the DIR'th subexpression
463 matches, that is a directory name. If LEAVE is nil or the corresponding
464 LEAVE'th subexpression doesn't match, this message is about going into another
465 directory. If it does match anything, this message is about going back to the
466 directory we were in before the last entering message. If you change this,
475 ("^[Cc]hecking \\(?:[Ff]or \\|[Ii]f \\|[Ww]hether \\(?:to \\)?\\)?\\(.+\\)\\.\\.\\. *\\(?:(cached) *\\)?\\(\\(yes\\(?: .+\\)?\\)\\|no\\|\\(.*\\)\\)$"
478 ;; Command output lines. Recognize `make[n]:' lines too.
485 ("^Compilation \\(exited abnormally\\|interrupt\\|killed\\|terminated\\|segmentation fault\\)\\(?:.*with code \\([0-9]+\\)\\)?.*"
489 "Additional things to highlight in Compilation mode.
493 "Regexp matching part of visited source lines to highlight temporarily.
500 "If non-nil, column numbers in error messages are screen columns.
501 Otherwise they are interpreted as character positions, with
502 each character occupying one column.
503 The default is to use screen columns, which requires that the compilation
504 program and Emacs agree about the display width of the characters,
505 especially the TAB character."
516 ;;;###autoload
519 Otherwise, it saves all modified buffers without asking."
523 ;;;###autoload
525 "List of directories to search for source files named in error messages.
526 Elements should be directory names, not file names of directories.
527 The value nil as an element means to try the default directory."
532 ;;;###autoload
534 "Last shell command used to do a compilation; default for next compilation.
536 Sometimes it is useful for files to supply local values for this variable.
537 You might also use mode hooks to specify it in certain modes, like this:
539 (add-hook 'c-mode-hook
540 (lambda ()
543 (set (make-local-variable 'compile-command)
545 (file-name-sans-extension buffer-file-name))))))"
548 ;;;###autoload(put 'compile-command 'safe-local-variable 'stringp)
550 ;;;###autoload
552 "If non-nil, send end-of-file as compilation process input.
553 This only affects platforms that support asynchronous processes (see
554 `start-process'); synchronous compilation processes never accept input."
559 ;; A weak per-compilation-buffer hash indexed by (FILENAME . DIRECTORY). Each
560 ;; value is a FILE-STRUCTURE as described above, with the car eq to the hash
561 ;; key. This holds the tree seen from root, for storing new nodes.
565 "*Set this to t before creating a *compilation* buffer.
566 Then every error line will have a debug text property with the matcher that
570 If non-nil, called when a compilation process dies to return a status message.
571 This should be a function of three arguments: process status, exit status,
572 and exit message; it returns a cons (MESSAGE . MODELINE) of the strings to
576 "*List of environment variables for compilation to inherit.
577 Each element should be a string of the form ENVVARNAME=VALUE.
578 This list is temporarily prepended to `process-environment' prior to
581 ;; History of compile commands.
586 "Face used to highlight compiler errors."
594 "Face used to highlight compiler warnings."
607 "Face used to highlight compiler information."
613 "Face for displaying line numbers in compiler messages."
619 "Face for displaying column numbers in compiler messages."
624 "Face name to use for whole messages.
625 Faces `compilation-error-face', `compilation-warning-face',
626 `compilation-info-face', `compilation-line-face' and
627 `compilation-column-face' get prepended to this, when applicable."
647 ;; same faces as dired uses
656 ;; Used for compatibility with the old compile.el.
664 "If non-nil, automatically jump to the first error after `compile'."
678 "Compilation motion commands skip less important messages.
679 The value can be either 2 -- skip anything less than error, 1 --
680 skip anything less than warning or 0 -- don't skip any messages.
681 Note that all messages not positively identified as warning or
682 info, are considered errors."
690 "Compilation motion commands skip visited messages if this is t.
691 Visited messages are ones for which the file, line and column have been jumped
692 to from the current content in the current compilation buffer, even if it was
693 from a different message."
701 compilation-error-face))
703 ;; Internal function for calculating the text properties of a directory
704 ;; change message. The directory property is important, because it is
705 ;; the stack of nested enter-messages. Relative filenames on the following
706 ;; lines are relative to the top of the stack.
709 ;; find previous stack, and push onto it, or if `leave' pop it
714 compilation-leave-directory-face
715 compilation-enter-directory-face)
720 mouse-face highlight
721 keymap compilation-button-map
724 ;; Data type `reverse-ordered-alist' retriever. This function retrieves the
725 ;; KEY element from the ALIST, creating it in the right position if not already
726 ;; present. ALIST structure is
727 ;; '(ANCHOR (KEY1 ...) (KEY2 ...)... (KEYn ALIST ...))
728 ;; ANCHOR is ignored, but necessary so that elements can be inserted. KEY1
729 ;; may be nil. The other KEYs are ordered backwards so that growing line
730 ;; numbers can be inserted in front and searching can abort after half the
731 ;; list on average.
742 l2
750 ;; This function is the central driver, called when font-locking to gather
751 ;; all information needed to later jump to corresponding source code.
752 ;; Return a property list with all meta information on this error location.
768 ;; This message didn't mention one, get it from previous
770 ;; Find the previous message.
773 ;; Get the file structure that belongs to it.
779 ;; Construct FILE . DIR from that.
785 ;; All of these fields are optional, get them only if we have an index, and
786 ;; it matched some part of the message.
818 "Go to column COL on the current line.
819 If SCREEN is non-nil, columns are screen columns, otherwise, they are
820 just char-counts."
826 "Get the meta-info that will be added as text-properties.
827 LINE, END-LINE, COL, END-COL are integers or nil.
828 TYPE can be 0, 1, or 2, meaning error, warning, or just info.
829 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME) or nil.
830 FMTS is a list of format specs for transforming the file name.
831 (See `compilation-error-regexp-alist'.)"
834 ;; Get first already existing marker (if any has one, all have one).
835 ;; Do this first, as the compilation-assq`s may create new nodes.
839 end-marker loc end-loc)
863 end-col compilation-error-screen-columns))
870 col compilation-error-screen-columns)
881 ;; If they are new, make the loc(s) reference the file they point to.
887 ;; Must start with face
894 "mouse-2: visit this file, line and column"
896 "mouse-2: visit this file and line"
898 keymap compilation-button-map
899 mouse-face highlight)))
902 "Return expressions to highlight in Compilation mode."
904 ;; An old package! Try the compatibility code.
907 ;; make directory tracking
914 t t))
917 ;; Compiler warning/error lines.
922 compilation-error-regexp-alist-alist))))
927 end-line end-col fmt)
933 ;; The old compile.el had here an undocumented hook that
934 ;; allowed `line' to be a function that computed the actual
935 ;; error location. Let's do our best.
954 compilation-warning-face
955 compilation-error-face]
974 compilation-error-regexp-alist)
976 compilation-mode-font-lock-keywords)))
978 \f
979 ;;;###autoload
981 "Compile the program including the current buffer. Default: run `make'.
982 Runs COMMAND, a shell command, in a separate process asynchronously
983 with output going to the buffer `*compilation*'.
986 and move to the source code that caused it.
988 If optional second arg COMINT is t the buffer will be in Comint mode with
989 `compilation-shell-minor-mode'.
991 Interactively, prompts for the command if `compilation-read-command' is
992 non-nil; otherwise uses `compile-command'. With prefix arg, always prompts.
993 Additionally, with universal prefix arg, compilation buffer will be in
994 comint mode, i.e. interactive.
996 To run more than one compilation at once, start one then rename
997 the \`*compilation*' buffer to some other name with
999 It will create a new \`*compilation*' buffer.
1001 On most systems, termination of the main compilation process
1002 kills its subprocesses.
1004 The name used for the buffer is actually whatever is returned by
1005 the function in `compilation-buffer-name-function', so you can set that
1006 to a function that generates a unique name."
1012 command nil nil
1016 command))
1024 ;; run compile with the default command line
1026 "Re-compile the program including the current buffer.
1027 If this is run in a Compilation mode buffer, re-use the arguments from the
1028 original use. Otherwise, recompile using `compile-command'."
1036 "Non-nil to scroll the *compilation* buffer window as output appears.
1038 Setting it causes the Compilation mode commands to put point at the
1039 end of their output window so that the end of the output is always
1040 visible rather than the beginning."
1047 "Return the name of a compilation buffer to use.
1048 If NAME-FUNCTION is non-nil, call it with one argument MODE-NAME
1049 to determine the buffer name.
1050 Likewise if `compilation-buffer-name-function' is non-nil.
1051 If current buffer has the major mode MODE-COMMAND,
1052 return the name of the current buffer, so that it gets reused.
1053 Otherwise, construct a buffer name from MODE-NAME."
1063 ;; This is a rough emulation of the old hack, until the transition to new
1064 ;; compile is complete.
1066 &optional name-of-mode parser
1067 error-regexp-alist name-function
1068 enter-regexp-alist leave-regexp-alist
1069 file-regexp-alist nomessage-regexp-alist
1070 no-async highlight-regexp local-map)
1075 compilation-error-regexp-alist)))
1081 ;;;###autoload
1083 "Run compilation command COMMAND (low level interface).
1084 If COMMAND starts with a cd command, that becomes the `default-directory'.
1085 The rest of the arguments are optional; for them, nil means use the default.
1087 MODE is the major mode to set in the compilation buffer. Mode
1088 may also be t meaning use `compilation-shell-minor-mode' under `comint-mode'.
1090 If NAME-FUNCTION is non-nil, call it with one argument (the mode name)
1091 to determine the buffer name. Otherwise, the default is to
1092 reuses the current buffer if it has the proper major mode,
1093 else use or create a buffer with name based on the major mode.
1095 If HIGHLIGHT-REGEXP is non-nil, `next-error' will temporarily highlight
1096 the matching section of the visited source line; the default is to use the
1097 global value of `compilation-highlight-regexp'.
1099 Returns the compilation buffer created."
1106 outwin outbuf)
1116 name-of-mode)))
1126 ;; first transfer directory from where M-x compile was called
1128 ;; Remember the original dir, so we can use it when we recompile.
1129 ;; default-directory' can't be used reliably for that because it may be
1130 ;; affected by the special handling of "cd ...;".
1132 ;; Make compilation buffer read-only. The filter can still write it.
1133 ;; Clear out the compilation buffer.
1136 ;; Then evaluate a cd command if any, but don't perform it yet, else
1137 ;; start-command would do it again through the shell: (cd "..") AND
1138 ;; sh -c "cd ..; make"
1143 default-directory))
1145 ;; Select the desired mode.
1153 highlight-regexp))
1156 ;; Output a mode setter, for saving and later reloading this buffer.
1161 mode-name
1166 ;; Pop up the compilation buffer.
1167 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01638.html
1172 compilation-environment
1174 system-uses-terminfo)
1180 ;; Set the EMACS variable, but
1181 ;; don't override users' setting of $EMACS.
1192 ;; Position point as the user will see it.
1194 ;; Put it at the end if `compilation-scroll-output' is set.
1197 ;; Normally put it at the top.
1203 ;; The setup function is called before compilation-set-window-height
1204 ;; so it can set the compilation-window-height buffer locally.
1208 ;; Start the compilation.
1211 ;; comint uses `start-file-process'.
1217 "/bin/sh"
1218 shell-file-name)
1221 outbuf command))))
1222 ;; Make the buffer's mode line show process state.
1226 ;; Use (point-max) here so that output comes in
1227 ;; after the initial text,
1228 ;; regardless of where the user sees point.
1233 ;; The process may have exited already.
1237 ;; Now finally cd to where the shell started make/grep/...
1243 ;; Make it so the next C-x ` will use this buffer.
1247 "Set the height of WINDOW according to `compilation-window-height'."
1251 ;; If window is alone in its frame, aside from a minibuffer,
1252 ;; don't change its height.
1254 ;; Stef said that doing the saves in this order is safer:
1272 map))
1285 ;; Set up the menu-bar
1288 map)
1298 ;; Set up the menu-bar
1301 map)
1309 map)
1315 ;; Don't inherit from compilation-minor-mode-map,
1316 ;; because that introduces a menu bar item we don't want.
1317 ;; That confuses C-down-mouse-3.
1330 (define-key map " " 'scroll-up)
1331 (define-key map "\^?" 'scroll-down)
1332 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
1334 ;; Set up the menu-bar
1335 (let ((submap (make-sparse-keymap "Compile")))
1336 (define-key map [menu-bar compilation]
1337 (cons "Compile" submap))
1338 (set-keymap-parent submap compilation-menu-map))
1339 (define-key map [menu-bar compilation compilation-separator2]
1340 '("----" . nil))
1341 (define-key map [menu-bar compilation compilation-grep]
1342 '("Search Files (grep)..." . grep))
1343 (define-key map [menu-bar compilation compilation-recompile]
1344 '("Recompile" . recompile))
1345 (define-key map [menu-bar compilation compilation-compile]
1346 '("Compile..." . compile))
1347 map)
1348 "Keymap for compilation log buffers.
1349 `compilation-minor-mode-map' is a parent of this.")
1351 (put 'compilation-mode 'mode-class 'special)
1353 ;;;###autoload
1354 (defun compilation-mode (&optional name-of-mode)
1355 "Major mode for compilation log buffers.
1360 Runs `compilation-mode-hook' with `run-mode-hooks' (which see).
1363 (interactive)
1364 (kill-all-local-variables)
1365 (use-local-map compilation-mode-map)
1366 (setq major-mode 'compilation-mode
1367 mode-name (or name-of-mode "Compilation"))
1368 (set (make-local-variable 'page-delimiter)
1369 compilation-page-delimiter)
1370 (compilation-setup)
1371 (setq buffer-read-only t)
1372 (run-mode-hooks 'compilation-mode-hook))
1374 (defmacro define-compilation-mode (mode name doc &rest body)
1375 "This is like `define-derived-mode' without the PARENT argument.
1376 The parent is always `compilation-mode' and the customizable `compilation-...'
1377 variables are also set from the name of the mode you have chosen,
1378 by replacing the first word, e.g `compilation-scroll-output' from
1379 `grep-scroll-output' if that variable exists."
1381 `(define-derived-mode ,mode compilation-mode ,name
1382 ,doc
1383 ,@(mapcar (lambda (v)
1384 (setq v (cons v
1385 (intern-soft (replace-regexp-in-string
1386 "^compilation" mode-name
1387 (symbol-name v)))))
1388 (and (cdr v)
1389 (or (boundp (cdr v))
1390 (if (boundp 'byte-compile-bound-variables)
1391 (memq (cdr v) byte-compile-bound-variables)))
1392 `(set (make-local-variable ',(car v)) ,(cdr v))))
1393 '(compilation-buffer-name-function
1394 compilation-directory-matcher
1395 compilation-error
1396 compilation-error-regexp-alist
1397 compilation-error-regexp-alist-alist
1398 compilation-error-screen-columns
1399 compilation-finish-function
1400 compilation-finish-functions
1401 compilation-first-column
1402 compilation-mode-font-lock-keywords
1403 compilation-page-delimiter
1404 compilation-parse-errors-filename-function
1405 compilation-process-setup-function
1406 compilation-scroll-output
1407 compilation-search-path
1408 compilation-skip-threshold
1409 compilation-window-height))
1410 ,@body)))
1412 (defun compilation-revert-buffer (ignore-auto noconfirm)
1413 (if buffer-file-name
1414 (let (revert-buffer-function)
1415 (revert-buffer ignore-auto noconfirm))
1416 (if (or noconfirm (yes-or-no-p (format "Restart compilation? ")))
1417 (apply 'compilation-start compilation-arguments))))
1419 (defvar compilation-current-error nil
1420 "Marker to the location from where the next error will be found.
1421 The global commands next/previous/first-error/goto-error use this.")
1423 (defvar compilation-messages-start nil
1424 "Buffer position of the beginning of the compilation messages.
1425 If nil, use the beginning of buffer.")
1427 ;; A function name can't be a hook, must be something with a value.
1428 (defconst compilation-turn-on-font-lock 'turn-on-font-lock)
1430 (defun compilation-setup (&optional minor)
1431 "Prepare the buffer for the compilation parsing commands to work.
1432 Optional argument MINOR indicates this is called from
1433 `compilation-minor-mode'."
1434 (make-local-variable 'compilation-current-error)
1435 (make-local-variable 'compilation-messages-start)
1436 (make-local-variable 'compilation-error-screen-columns)
1437 (make-local-variable 'overlay-arrow-position)
1438 (set (make-local-variable 'overlay-arrow-string) "")
1439 (setq next-error-overlay-arrow-position nil)
1440 (add-hook 'kill-buffer-hook
1441 (lambda () (setq next-error-overlay-arrow-position nil)) nil t)
1442 ;; Note that compilation-next-error-function is for interfacing
1443 ;; with the next-error function in simple.el, and it's only
1444 ;; coincidentally named similarly to compilation-next-error.
1445 (setq next-error-function 'compilation-next-error-function)
1446 (set (make-local-variable 'comint-file-name-prefix)
1447 (or (file-remote-p default-directory) ""))
1448 (set (make-local-variable 'font-lock-extra-managed-props)
1449 '(directory message help-echo mouse-face debug))
1450 (set (make-local-variable 'compilation-locs)
1451 (make-hash-table :test 'equal :weakness 'value))
1452 ;; lazy-lock would never find the message unless it's scrolled to.
1453 ;; jit-lock might fontify some things too late.
1454 (set (make-local-variable 'font-lock-support-mode) nil)
1455 (set (make-local-variable 'font-lock-maximum-size) nil)
1456 (if minor
1457 (let ((fld font-lock-defaults))
1458 (font-lock-add-keywords nil (compilation-mode-font-lock-keywords))
1459 (if font-lock-mode
1460 (if fld
1461 (font-lock-fontify-buffer)
1462 (font-lock-change-mode)
1463 (turn-on-font-lock))
1464 (turn-on-font-lock)))
1465 (setq font-lock-defaults '(compilation-mode-font-lock-keywords t))
1466 ;; maybe defer font-lock till after derived mode is set up
1467 (run-mode-hooks 'compilation-turn-on-font-lock)))
1469 ;;;###autoload
1470 (define-minor-mode compilation-shell-minor-mode
1471 "Toggle compilation shell minor mode.
1472 With arg, turn compilation mode on if and only if arg is positive.
1473 In this minor mode, all the error-parsing commands of the
1474 Compilation major mode are available but bound to keys that don't
1475 collide with Shell mode. See `compilation-mode'.
1476 Turning the mode on runs the normal hook `compilation-shell-minor-mode-hook'."
1477 nil " Shell-Compile"
1478 :group 'compilation
1479 (if compilation-shell-minor-mode
1480 (compilation-setup t)
1481 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1482 (font-lock-fontify-buffer)))
1484 ;;;###autoload
1485 (define-minor-mode compilation-minor-mode
1486 "Toggle compilation minor mode.
1487 With arg, turn compilation mode on if and only if arg is positive.
1488 In this minor mode, all the error-parsing commands of the
1489 Compilation major mode are available. See `compilation-mode'.
1490 Turning the mode on runs the normal hook `compilation-minor-mode-hook'."
1491 nil " Compilation"
1492 :group 'compilation
1493 (if compilation-minor-mode
1494 (compilation-setup t)
1495 (font-lock-remove-keywords nil (compilation-mode-font-lock-keywords))
1496 (font-lock-fontify-buffer)))
1498 (defun compilation-handle-exit (process-status exit-status msg)
1499 "Write MSG in the current buffer and hack its `mode-line-process'."
1500 (let ((inhibit-read-only t)
1501 (status (if compilation-exit-message-function
1502 (funcall compilation-exit-message-function
1503 process-status exit-status msg)
1504 (cons msg exit-status)))
1505 (omax (point-max))
1506 (opoint (point))
1507 (cur-buffer (current-buffer)))
1508 ;; Record where we put the message, so we can ignore it later on.
1509 (goto-char omax)
1511 (if (and (numberp compilation-window-height)
1512 (zerop compilation-window-height))
1513 (message "%s" (cdr status)))
1514 (if (bolp)
1515 (forward-char -1))
1516 (insert " at " (substring (current-time-string) 0 19))
1517 (goto-char (point-max))
1518 ;; Prevent that message from being recognized as a compilation error.
1519 (add-text-properties omax (point)
1520 (append '(compilation-handle-exit t) nil))
1521 (setq mode-line-process (format ":%s [%s]" process-status (cdr status)))
1522 ;; Force mode line redisplay soon.
1523 (force-mode-line-update)
1524 (if (and opoint (< opoint omax))
1525 (goto-char opoint))
1526 (with-no-warnings
1527 (if compilation-finish-function
1528 (funcall compilation-finish-function cur-buffer msg)))
1529 (run-hook-with-args 'compilation-finish-functions cur-buffer msg)))
1531 ;; Called when compilation process changes state.
1532 (defun compilation-sentinel (proc msg)
1533 "Sentinel for compilation buffers."
1534 (if (memq (process-status proc) '(exit signal))
1535 (let ((buffer (process-buffer proc)))
1536 (if (null (buffer-name buffer))
1537 ;; buffer killed
1538 (set-process-buffer proc nil)
1539 (with-current-buffer buffer
1540 ;; Write something in the compilation buffer
1541 ;; and hack its mode line.
1542 (compilation-handle-exit (process-status proc)
1543 (process-exit-status proc)
1544 msg)
1545 ;; Since the buffer and mode line will show that the
1546 ;; process is dead, we can delete it now. Otherwise it
1547 ;; will stay around until M-x list-processes.
1548 (delete-process proc)))
1549 (setq compilation-in-progress (delq proc compilation-in-progress)))))
1551 (defun compilation-filter (proc string)
1552 "Process filter for compilation buffers.
1553 Just inserts the text, but uses `insert-before-markers'."
1554 (if (buffer-name (process-buffer proc))
1555 (with-current-buffer (process-buffer proc)
1556 (let ((inhibit-read-only t))
1557 (save-excursion
1558 (goto-char (process-mark proc))
1559 (insert-before-markers string)
1560 (run-hooks 'compilation-filter-hook))))))
1562 ;;; test if a buffer is a compilation buffer, assuming we're in the buffer
1563 (defsubst compilation-buffer-internal-p ()
1564 "Test if inside a compilation buffer."
1565 (local-variable-p 'compilation-locs))
1567 ;;; test if a buffer is a compilation buffer, using compilation-buffer-internal-p
1568 (defsubst compilation-buffer-p (buffer)
1569 "Test if BUFFER is a compilation buffer."
1570 (with-current-buffer buffer
1571 (compilation-buffer-internal-p)))
1573 (defmacro compilation-loop (< property-change 1+ error limit)
1574 `(let (opt)
1575 (while (,< n 0)
1576 (setq opt pt)
1577 (or (setq pt (,property-change pt 'message))
1578 ;; Handle the case where where the first error message is
1579 ;; at the start of the buffer, and n < 0.
1580 (if (or (eq (get-text-property ,limit 'message)
1581 (get-text-property opt 'message))
1582 (eq pt opt))
1583 (error ,error compilation-error)
1584 (setq pt ,limit)))
1585 ;; prop 'message usually has 2 changes, on and off, so
1586 ;; re-search if off
1587 (or (setq msg (get-text-property pt 'message))
1588 (if (setq pt (,property-change pt 'message nil ,limit))
1589 (setq msg (get-text-property pt 'message)))
1590 (error ,error compilation-error))
1591 (or (< (cadr msg) compilation-skip-threshold)
1592 (if different-file
1593 (eq (prog1 last (setq last (nth 2 (car msg))))
1594 last))
1595 (if compilation-skip-visited
1596 (nthcdr 5 (car msg)))
1597 (if compilation-skip-to-next-location
1598 (eq (car msg) loc))
1599 ;; count this message only if none of the above are true
1600 (setq n (,1+ n))))))
1602 (defun compilation-next-error (n &optional different-file pt)
1603 "Move point to the next error in the compilation buffer.
1604 Prefix arg N says how many error messages to move forwards (or
1605 backwards, if negative).
1607 (interactive "p")
1608 (or (compilation-buffer-p (current-buffer))
1609 (error "Not in a compilation buffer"))
1610 (or pt (setq pt (point)))
1611 (let* ((msg (get-text-property pt 'message))
1612 (loc (car msg))
1613 last)
1614 (if (zerop n)
1615 (unless (or msg ; find message near here
1616 (setq msg (get-text-property (max (1- pt) (point-min))
1617 'message)))
1618 (setq pt (previous-single-property-change pt 'message nil
1619 (line-beginning-position)))
1620 (unless (setq msg (get-text-property (max (1- pt) (point-min)) 'message))
1621 (setq pt (next-single-property-change pt 'message nil
1622 (line-end-position)))
1623 (or (setq msg (get-text-property pt 'message))
1624 (setq pt (point)))))
1625 (setq last (nth 2 (car msg)))
1626 (if (>= n 0)
1627 (compilation-loop > next-single-property-change 1-
1628 (if (get-buffer-process (current-buffer))
1629 "No more %ss yet"
1630 "Moved past last %s")
1631 (point-max))
1632 ;; Don't move "back" to message at or before point.
1633 ;; Pass an explicit (point-min) to make sure pt is non-nil.
1634 (setq pt (previous-single-property-change pt 'message nil (point-min)))
1635 (compilation-loop < previous-single-property-change 1+
1636 "Moved back before first %s" (point-min))))
1637 (goto-char pt)
1638 (or msg
1639 (error "No %s here" compilation-error))))
1641 (defun compilation-previous-error (n)
1642 "Move point to the previous error in the compilation buffer.
1643 Prefix arg N says how many error messages to move backwards (or
1644 forwards, if negative).
1646 (interactive "p")
1647 (compilation-next-error (- n)))
1649 (defun compilation-next-file (n)
1650 "Move point to the next error for a different file than the current one.
1651 Prefix arg N says how many files to move forwards (or backwards, if negative)."
1652 (interactive "p")
1653 (compilation-next-error n t))
1655 (defun compilation-previous-file (n)
1656 "Move point to the previous error for a different file than the current one.
1657 Prefix arg N says how many files to move backwards (or forwards, if negative)."
1658 (interactive "p")
1659 (compilation-next-file (- n)))
1661 (defun kill-compilation ()
1663 (interactive)
1664 (let ((buffer (compilation-find-buffer)))
1665 (if (get-buffer-process buffer)
1666 (interrupt-process (get-buffer-process buffer))
1667 (error "The %s process is not running" (downcase mode-name)))))
1669 (defalias 'compile-mouse-goto-error 'compile-goto-error)
1671 (defun compile-goto-error (&optional event)
1672 "Visit the source for the error message at point.
1673 Use this command in a compilation log buffer. Sets the mark at point there."
1674 (interactive (list last-input-event))
1675 (if event (posn-set-point (event-end event)))
1676 (or (compilation-buffer-p (current-buffer))
1677 (error "Not in a compilation buffer"))
1678 (if (get-text-property (point) 'directory)
1679 (dired-other-window (car (get-text-property (point) 'directory)))
1680 (push-mark)
1681 (setq compilation-current-error (point))
1682 (next-error-internal)))
1684 (defun compilation-find-buffer (&optional avoid-current)
1685 "Return a compilation buffer.
1686 If AVOID-CURRENT is nil, and the current buffer is a compilation buffer,
1687 return it. If AVOID-CURRENT is non-nil, return the current buffer only
1688 as a last resort."
1689 (if (and (compilation-buffer-internal-p) (not avoid-current))
1690 (current-buffer)
1691 (next-error-find-buffer avoid-current 'compilation-buffer-internal-p)))
1693 ;;;###autoload
1694 (defun compilation-next-error-function (n &optional reset)
1695 "Advance to the next error message and visit the file where the error was.
1696 This is the value of `next-error-function' in Compilation buffers."
1697 (interactive "p")
1698 (when reset
1699 (setq compilation-current-error nil))
1700 (let* ((columns compilation-error-screen-columns) ; buffer's local value
1701 (last 1) timestamp
1702 (loc (compilation-next-error (or n 1) nil
1703 (or compilation-current-error
1704 compilation-messages-start
1705 (point-min))))
1706 (end-loc (nth 2 loc))
1707 (marker (point-marker)))
1708 (setq compilation-current-error (point-marker)
1709 overlay-arrow-position
1710 (if (bolp)
1711 compilation-current-error
1712 (copy-marker (line-beginning-position)))
1713 loc (car loc))
1714 ;; If loc contains no marker, no error in that file has been visited.
1715 ;; If the marker is invalid the buffer has been killed.
1716 ;; If the file is newer than the timestamp, it has been modified
1717 ;; (`omake -P' polls filesystem for changes and recompiles when needed
1718 ;; in the same process and buffer).
1719 ;; So, recalculate all markers for that file.
1720 (unless (and (nth 3 loc) (marker-buffer (nth 3 loc))
1721 ;; There may be no timestamp info if the loc is a `fake-loc'.
1722 ;; So we skip the time-check here, although we should maybe
1723 ;; change `compilation-fake-loc' to add timestamp info.
1724 (or (null (nth 4 loc))
1725 (equal (nth 4 loc)
1726 (setq timestamp
1727 (with-current-buffer
1728 (marker-buffer (nth 3 loc))
1729 (visited-file-modtime))))))
1730 (with-current-buffer (compilation-find-file marker (caar (nth 2 loc))
1731 (cadr (car (nth 2 loc))))
1732 (save-restriction
1733 (widen)
1734 (goto-char (point-min))
1735 ;; Treat file's found lines in forward order, 1 by 1.
1736 (dolist (line (reverse (cddr (nth 2 loc))))
1737 (when (car line) ; else this is a filename w/o a line#
1738 (beginning-of-line (- (car line) last -1))
1739 (setq last (car line)))
1740 ;; Treat line's found columns and store/update a marker for each.
1741 (dolist (col (cdr line))
1742 (if (car col)
1743 (if (eq (car col) -1) ; special case for range end
1744 (end-of-line)
1745 (compilation-move-to-column (car col) columns))
1746 (beginning-of-line)
1748 (if (nth 3 col)
1749 (set-marker (nth 3 col) (point))
1750 (setcdr (nthcdr 2 col) `(,(point-marker)))))))))
1751 (compilation-goto-locus marker (nth 3 loc) (nth 3 end-loc))
1752 (setcdr (nthcdr 3 loc) (list timestamp))
1753 (setcdr (nthcdr 4 loc) t))) ; Set this one as visited.
1755 (defvar compilation-gcpro nil
1756 "Internal variable used to keep some values from being GC'd.")
1757 (make-variable-buffer-local 'compilation-gcpro)
1759 (defun compilation-fake-loc (marker file &optional line col)
1760 "Preassociate MARKER with FILE.
1761 FILE should be ABSOLUTE-FILENAME or (RELATIVE-FILENAME . DIRNAME).
1762 This is useful when you compile temporary files, but want
1763 automatic translation of the messages to the real buffer from
1764 which the temporary file came. This only works if done before a
1765 message about FILE appears!
1767 Optional args LINE and COL default to 1 and beginning of
1768 indentation respectively. The marker is expected to reflect
1769 this. In the simplest case the marker points to the first line
1770 of the region that was saved to the temp file.
1772 If you concatenate several regions into the temp file (e.g. a
1773 header with variable assignments and a code region), you must
1774 call this several times, once each for the last line of one
1775 region and the first line of the next region."
1776 (or (consp file) (setq file (list file)))
1777 (setq file (compilation-get-file-structure file))
1778 ;; Between the current call to compilation-fake-loc and the first occurrence
1779 ;; of an error message referring to `file', the data is only kept in the
1780 ;; weak hash-table compilation-locs, so we need to prevent this entry
1781 ;; in compilation-locs from being GC'd away. --Stef
1782 (push file compilation-gcpro)
1783 (let ((loc (compilation-assq (or line 1) (cdr file))))
1784 (setq loc (compilation-assq col loc))
1785 (if (cdr loc)
1786 (setcdr (cddr loc) (list marker))
1787 (setcdr loc (list line file marker)))
1788 loc))
1790 (defcustom compilation-context-lines nil
1791 "Display this many lines of leading context before the current message.
1792 If nil and the left fringe is displayed, don't scroll the
1793 compilation output window; an arrow in the left fringe points to
1794 the current message. If nil and there is no left fringe, the message
1795 displays at the top of the window; there is no arrow."
1796 :type '(choice integer (const :tag "No window scrolling" nil))
1797 :group 'compilation
1798 :version "22.1")
1800 (defsubst compilation-set-window (w mk)
1801 "Align the compilation output window W with marker MK near top."
1802 (if (integerp compilation-context-lines)
1803 (set-window-start w (save-excursion
1804 (goto-char mk)
1805 (beginning-of-line
1806 (- 1 compilation-context-lines))
1807 (point)))
1808 ;; If there is no left fringe.
1809 (if (equal (car (window-fringes)) 0)
1810 (set-window-start w (save-excursion
1811 (goto-char mk)
1812 (beginning-of-line 1)
1813 (point)))))
1814 (set-window-point w mk))
1816 (defvar next-error-highlight-timer)
1818 (defun compilation-goto-locus (msg mk end-mk)
1819 "Jump to an error corresponding to MSG at MK.
1820 All arguments are markers. If END-MK is non-nil, mark is set there
1821 and overlay is highlighted between MK and END-MK."
1822 ;; Show compilation buffer in other window, scrolled to this error.
1823 (let* ((from-compilation-buffer (eq (window-buffer (selected-window))
1824 (marker-buffer msg)))
1825 ;; Use an existing window if it is in a visible frame.
1826 (pre-existing (get-buffer-window (marker-buffer msg) 0))
1827 (w (if (and from-compilation-buffer pre-existing)
1828 ;; Calling display-buffer here may end up (partly) hiding
1829 ;; the error location if the two buffers are in two
1830 ;; different frames. So don't do it if it's not necessary.
1831 pre-existing
1832 (let ((display-buffer-reuse-frames t)
1833 (pop-up-windows t))
1834 ;; Pop up a window.
1835 (display-buffer (marker-buffer msg)))))
1836 (highlight-regexp (with-current-buffer (marker-buffer msg)
1837 ;; also do this while we change buffer
1838 (compilation-set-window w msg)
1839 compilation-highlight-regexp)))
1840 ;; Ideally, the window-size should be passed to `display-buffer' (via
1841 ;; something like special-display-buffer) so it's only used when
1842 ;; creating a new window.
1843 (unless pre-existing (compilation-set-window-height w))
1845 (if from-compilation-buffer
1846 ;; If the compilation buffer window was selected,
1847 ;; keep the compilation buffer in this window;
1848 ;; display the source in another window.
1849 (let ((pop-up-windows t))
1850 (pop-to-buffer (marker-buffer mk) 'other-window))
1851 (if (window-dedicated-p (selected-window))
1852 (pop-to-buffer (marker-buffer mk))
1853 (switch-to-buffer (marker-buffer mk))))
1854 ;; If narrowing gets in the way of going to the right place, widen.
1855 (unless (eq (goto-char mk) (point))
1856 (widen)
1857 (goto-char mk))
1858 (if end-mk
1859 (push-mark end-mk t)
1860 (if mark-active (setq mark-active)))
1861 ;; If hideshow got in the way of
1862 ;; seeing the right place, open permanently.
1863 (dolist (ov (overlays-at (point)))
1864 (when (eq 'hs (overlay-get ov 'invisible))
1865 (delete-overlay ov)
1866 (goto-char mk)))
1868 (when highlight-regexp
1869 (if (timerp next-error-highlight-timer)
1870 (cancel-timer next-error-highlight-timer))
1871 (unless compilation-highlight-overlay
1872 (setq compilation-highlight-overlay
1873 (make-overlay (point-min) (point-min)))
1874 (overlay-put compilation-highlight-overlay 'face 'next-error))
1875 (with-current-buffer (marker-buffer mk)
1876 (save-excursion
1877 (if end-mk (goto-char end-mk) (end-of-line))
1878 (let ((end (point)))
1879 (if mk (goto-char mk) (beginning-of-line))
1880 (if (and (stringp highlight-regexp)
1881 (re-search-forward highlight-regexp end t))
1882 (progn
1883 (goto-char (match-beginning 0))
1884 (move-overlay compilation-highlight-overlay
1885 (match-beginning 0) (match-end 0)
1886 (current-buffer)))
1887 (move-overlay compilation-highlight-overlay
1888 (point) end (current-buffer)))
1889 (if (or (eq next-error-highlight t)
1890 (numberp next-error-highlight))
1891 ;; We want highlighting: delete overlay on next input.
1892 (add-hook 'pre-command-hook
1893 'compilation-goto-locus-delete-o)
1894 ;; We don't want highlighting: delete overlay now.
1895 (delete-overlay compilation-highlight-overlay))
1896 ;; We want highlighting for a limited time:
1897 ;; set up a timer to delete it.
1898 (when (numberp next-error-highlight)
1899 (setq next-error-highlight-timer
1900 (run-at-time next-error-highlight nil
1901 'compilation-goto-locus-delete-o)))))))
1902 (when (and (eq next-error-highlight 'fringe-arrow))
1903 ;; We want a fringe arrow (instead of highlighting).
1904 (setq next-error-overlay-arrow-position
1905 (copy-marker (line-beginning-position))))))
1907 (defun compilation-goto-locus-delete-o ()
1908 (delete-overlay compilation-highlight-overlay)
1909 ;; Get rid of timer and hook that would try to do this again.
1910 (if (timerp next-error-highlight-timer)
1911 (cancel-timer next-error-highlight-timer))
1912 (remove-hook 'pre-command-hook
1913 'compilation-goto-locus-delete-o))
1914 \f
1915 (defun compilation-find-file (marker filename directory &rest formats)
1916 "Find a buffer for file FILENAME.
1917 Search the directories in `compilation-search-path'.
1918 A nil in `compilation-search-path' means to try the
1920 If DIRECTORY is relative, it is combined with `default-directory'.
1921 If DIRECTORY is nil, that means use `default-directory'.
1922 If FILENAME is not found at all, ask the user where to find it.
1923 Pop up the buffer containing MARKER and scroll to MARKER if we ask the user."
1924 (or formats (setq formats '("%s")))
1925 (let ((dirs compilation-search-path)
1926 (spec-dir (if directory
1927 (expand-file-name directory)
1928 default-directory))
1929 buffer thisdir fmts name)
1930 (if (file-name-absolute-p filename)
1931 ;; The file name is absolute. Use its explicit directory as
1932 ;; the first in the search path, and strip it from FILENAME.
1933 (setq filename (abbreviate-file-name (expand-file-name filename))
1934 dirs (cons (file-name-directory filename) dirs)
1935 filename (file-name-nondirectory filename)))
1936 ;; Now search the path.
1937 (while (and dirs (null buffer))
1938 (setq thisdir (or (car dirs) spec-dir)
1939 fmts formats)
1940 ;; For each directory, try each format string.
1941 (while (and fmts (null buffer))
1942 (setq name (expand-file-name (format (car fmts) filename) thisdir)
1943 buffer (and (file-exists-p name)
1944 (find-file-noselect name))
1945 fmts (cdr fmts)))
1946 (setq dirs (cdr dirs)))
1947 (while (null buffer) ;Repeat until the user selects an existing file.
1948 ;; The file doesn't exist. Ask the user where to find it.
1949 (save-excursion ;This save-excursion is probably not right.
1950 (let ((pop-up-windows t))
1951 (compilation-set-window (display-buffer (marker-buffer marker))
1952 marker)
1953 (let* ((name (read-file-name
1954 (format "Find this %s in (default %s): "
1955 compilation-error filename)
1956 spec-dir filename t nil
1957 ;; The predicate below is fine when called from
1958 ;; minibuffer-complete-and-exit, but it's too
1959 ;; restrictive otherwise, since it also prevents the
1960 ;; user from completing "fo" to "foo/" when she
1961 ;; wants to enter "foo/bar".
1962 ;;
1963 ;; Try to make sure the user can only select
1964 ;; a valid answer. This predicate may be ignored,
1965 ;; tho, so we still have to double-check afterwards.
1966 ;; TODO: We should probably fix read-file-name so
1967 ;; that it never ignores this predicate, even when
1968 ;; using popup dialog boxes.
1969 ;; (lambda (name)
1970 ;; (if (file-directory-p name)
1971 ;; (setq name (expand-file-name filename name)))
1972 ;; (file-exists-p name))
1973 ))
1974 (origname name))
1975 (cond
1976 ((not (file-exists-p name))
1977 (message "Cannot find file `%s'" name)
1978 (ding) (sit-for 2))
1979 ((and (file-directory-p name)
1980 (not (file-exists-p
1981 (setq name (expand-file-name filename name)))))
1982 (message "No `%s' in directory %s" filename origname)
1983 (ding) (sit-for 2))
1984 (t
1985 (setq buffer (find-file-noselect name))))))))
1986 ;; Make intangible overlays tangible.
1987 ;; This is weird: it's not even clear which is the current buffer,
1988 ;; so the code below can't be expected to DTRT here. -- Stef
1989 (dolist (ov (overlays-in (point-min) (point-max)))
1990 (when (overlay-get ov 'intangible)
1991 (overlay-put ov 'intangible nil)))
1992 buffer))
1994 (defun compilation-get-file-structure (file &optional fmt)
1995 "Retrieve FILE's file-structure or create a new one.
1996 FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME).
1997 In the former case, FILENAME may be relative or absolute.
1999 The file-structure looks like this:
2000 (list (list FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)"
2001 (or (gethash file compilation-locs)
2002 ;; File was not previously encountered, at least not in the form passed.
2003 ;; Let's normalize it and look again.
2004 (let ((filename (car file))
2005 ;; Get the specified directory from FILE.
2006 (spec-directory (if (cdr file)
2007 (file-truename (cdr file)))))
2009 ;; Check for a comint-file-name-prefix and prepend it if appropriate.
2010 ;; (This is very useful for compilation-minor-mode in an rlogin-mode
2011 ;; buffer.)
2012 (when (and (boundp 'comint-file-name-prefix)
2013 (not (equal comint-file-name-prefix "")))
2014 (if (file-name-absolute-p filename)
2015 (setq filename
2016 (concat comint-file-name-prefix filename))
2017 (if spec-directory
2018 (setq spec-directory
2019 (file-truename
2020 (concat comint-file-name-prefix spec-directory))))))
2022 ;; If compilation-parse-errors-filename-function is
2023 ;; defined, use it to process the filename.
2024 (when compilation-parse-errors-filename-function
2025 (setq filename
2026 (funcall compilation-parse-errors-filename-function
2027 filename)))
2029 ;; Some compilers (e.g. Sun's java compiler, reportedly) produce bogus
2030 ;; file names like "./bar//foo.c" for file "bar/foo.c";
2031 ;; expand-file-name will collapse these into "/foo.c" and fail to find
2032 ;; the appropriate file. So we look for doubled slashes in the file
2033 ;; name and fix them.
2034 (setq filename (command-line-normalize-file-name filename))
2036 ;; Store it for the possibly unnormalized name
2037 (puthash file
2038 ;; Retrieve or create file-structure for normalized name
2039 ;; The gethash used to not use spec-directory, but
2040 ;; this leads to errors when files in different
2041 ;; directories have the same name:
2042 ;; http://lists.gnu.org/archive/html/emacs-devel/2007-08/msg00463.html
2043 (or (gethash (cons filename spec-directory) compilation-locs)
2044 (puthash (cons filename spec-directory)
2045 (list (list filename spec-directory) fmt)
2046 compilation-locs))
2047 compilation-locs))))
2049 (add-to-list 'debug-ignored-errors "^No more [-a-z ]+s yet$")
2051 ;;; Compatibility with the old compile.el.
2053 (defun compile-buffer-substring (n) (if n (match-string n)))
2055 (defun compilation-compat-error-properties (err)
2056 "Map old-style error ERR to new-style message."
2057 ;; Old-style structure is (MARKER (FILE DIR) LINE COL) or
2058 ;; (MARKER . MARKER).
2059 (let ((dst (cdr err)))
2060 (if (markerp dst)
2061 ;; Must start with a face, for font-lock.
2062 `(face nil
2063 message ,(list (list nil nil nil dst) 2)
2064 help-echo "mouse-2: visit the source location"
2065 keymap compilation-button-map
2066 mouse-face highlight)
2067 ;; Too difficult to do it by hand: dispatch to the normal code.
2068 (let* ((file (pop dst))
2069 (line (pop dst))
2070 (col (pop dst))
2071 (filename (pop file))
2072 (dirname (pop file))
2073 (fmt (pop file)))
2074 (compilation-internal-error-properties
2075 (cons filename dirname) line nil col nil 2 fmt)))))
2077 (defun compilation-compat-parse-errors (limit)
2078 (when compilation-parse-errors-function
2079 ;; FIXME: We should remove the rest of the compilation keywords
2080 ;; but we can't do that from here because font-lock is using
2081 ;; the value right now. --stef
2082 (save-excursion
2083 (setq compilation-error-list nil)
2084 ;; Reset compilation-parsing-end each time because font-lock
2085 ;; might force us the re-parse many times (typically because
2086 ;; some code adds some text-property to the output that we
2087 ;; already parsed). You might say "why reparse", well:
2088 ;; because font-lock has just removed the `message' property so
2089 ;; have to do it all over again.
2090 (if compilation-parsing-end
2091 (set-marker compilation-parsing-end (point))
2092 (setq compilation-parsing-end (point-marker)))
2093 (condition-case nil
2094 ;; Ignore any error: we're calling this function earlier than
2095 ;; in the old compile.el so things might not all be setup yet.
2096 (funcall compilation-parse-errors-function limit nil)
2097 (error nil))
2098 (dolist (err (if (listp compilation-error-list) compilation-error-list))
2099 (let* ((src (car err))
2100 (dst (cdr err))
2101 (loc (cond ((markerp dst) (list nil nil nil dst))
2102 ((consp dst)
2103 (list (nth 2 dst) (nth 1 dst)
2104 (cons (cdar dst) (caar dst)))))))
2105 (when loc
2106 (goto-char src)
2107 ;; (put-text-property src (line-end-position) 'font-lock-face 'font-lock-warning-face)
2108 (put-text-property src (line-end-position)
2109 'message (list loc 2)))))))
2110 (goto-char limit)
2111 nil)
2113 ;; Beware: this is not only compatiblity code. New code stil uses it. --Stef
2114 (defun compilation-forget-errors ()
2115 ;; In case we hit the same file/line specs, we want to recompute a new
2116 ;; marker for them, so flush our cache.
2117 (setq compilation-locs (make-hash-table :test 'equal :weakness 'value))
2118 (setq compilation-gcpro nil)
2119 ;; FIXME: the old code reset the directory-stack, so maybe we should
2120 ;; put a `directory change' marker of some sort, but where? -stef
2121 ;;
2122 ;; FIXME: The old code moved compilation-current-error (which was
2123 ;; virtually represented by a mix of compilation-parsing-end and
2124 ;; compilation-error-list) to point-min, but that was only meaningful for
2125 ;; the internal uses of compilation-forget-errors: all calls from external
2126 ;; packages seem to be followed by a move of compilation-parsing-end to
2127 ;; something equivalent to point-max. So we heuristically move
2128 ;; compilation-current-error to point-max (since the external package
2129 ;; won't know that it should do it). --Stef
2130 (setq compilation-current-error nil)
2131 (let* ((proc (get-buffer-process (current-buffer)))
2132 (mark (if proc (process-mark proc)))
2133 (pos (or mark (point-max))))
2134 (setq compilation-messages-start
2135 ;; In the future, ignore the text already present in the buffer.
2136 ;; Since many process filter functions insert before markers,
2137 ;; we need to put ours just before the insertion point rather
2138 ;; than at the insertion point. If that's not possible, then
2139 ;; don't use a marker. --Stef
2140 (if (> pos (point-min)) (copy-marker (1- pos)) pos)))
2141 ;; Again, since this command is used in buffers that contain several
2142 ;; compilations, to set the beginning of "this compilation", it's a good
2143 ;; place to reset compilation-auto-jump-to-next.
2144 (set (make-local-variable 'compilation-auto-jump-to-next)
2145 compilation-auto-jump-to-first-error))
2147 ;;;###autoload
2150 (provide 'compile)
2152 ;; arch-tag: 12465727-7382-4f72-b234-79855a00dd8c
2153 ;;; compile.el ends here