code.delx.au - gnu-emacs/blob - lisp/progmodes/compile.el

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