make-mode.el 47.7 KB
Newer Older
1
;;; make-mode.el --- makefile editing commands for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1992, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Author: Thomas Neumann <tom@smart.bo.open.de>
6
;;	Eric S. Raymond <esr@snark.thyrsus.com>
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Adapted-By: ESR
Eric S. Raymond's avatar
Eric S. Raymond committed
8
;; Keywords: unix, tools
Eric S. Raymond's avatar
Eric S. Raymond committed
9

Richard M. Stallman's avatar
Richard M. Stallman committed
10
;; RMS:
11
;; This needs work.
Richard M. Stallman's avatar
Richard M. Stallman committed
12 13 14
;; Also, the doc strings need fixing: the first line doesn't stand alone,
;; and other usage is not high quality.  Symbol names don't have `...'.

Eric S. Raymond's avatar
Eric S. Raymond committed
15 16 17 18
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Karl Heuer's avatar
Karl Heuer committed
19
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
20 21 22 23 24 25 26 27
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
28 29 30
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
31

32 33
;;; Commentary:

34 35 36 37 38 39 40 41 42 43
;; A major mode for editing makefiles.  The mode knows about Makefile
;; syntax and defines M-n and M-p to move to next and previous productions.
;;
;; The keys $, =, : and . are electric; they try to help you fill in a
;; macro reference, macro definition, ordinary target name, or special
;; target name, respectively.  Such names are completed using a list of
;; targets and macro names parsed out of the makefile.  This list is
;; automatically updated, if necessary, whenever you invoke one of
;; these commands.  You can force it to be updated with C-c C-p.
;;
44
;; The command C-c C-f adds certain filenames in the current directory
45 46 47 48 49 50 51 52
;; as targets.  You can filter out filenames by setting the variable
;; makefile-ignored-files-in-pickup-regex.
;;
;; The command C-c C-u grinds for a bit, then pops up a report buffer
;; showing which target names are up-to-date with respect to their
;; prerequisites, which targets are out-of-date, and which have no
;; prerequisites.
;;
53
;; The command C-c C-b pops up a browser window listing all target and
54 55 56 57 58 59 60
;; macro names.  You can mark or unmark items wit C-c SPC, and insert
;; all marked items back in the Makefile with C-c TAB.
;;
;; The command C-c TAB in the makefile buffer inserts a GNU make builtin.
;; You will be prompted for the builtin's args.
;;
;; There are numerous other customization variables.
61

62 63 64
;;
;; To Do:
;;
65 66
;; * makefile-backslash-region should be given better behavior.
;; * Consider binding C-c C-c to comment-region (like cc-mode).
67 68 69 70 71 72 73 74 75
;; * Eliminate electric stuff entirely.
;; * It might be nice to highlight targets differently depending on
;;   whether they are up-to-date or not.  Not sure how this would
;;   interact with font-lock.
;; * Would be nice to edit the commands in ksh-mode and have
;;   indentation and slashification done automatically.  Hard.
;; * Consider removing browser mode.  It seems useless.
;; * ":" should notice when a new target is made and add it to the
;;   list (or at least set makefile-need-target-pickup).
76
;; * Make browser into a major mode.
77 78 79 80 81 82 83 84 85 86 87 88 89
;; * Clean up macro insertion stuff.  It is a mess.
;; * Browser entry and exit is weird.  Normalize.
;; * Browser needs to be rewritten.  Right now it is kind of a crock.
;;   Should at least:
;;    * Act more like dired/buffer menu/whatever.
;;    * Highlight as mouse traverses.
;;    * B2 inserts.
;; * Update documentation above.
;; * Update texinfo manual.
;; * Update files.el.



Eric S. Raymond's avatar
Eric S. Raymond committed
90 91 92 93
;;; Code:

(provide 'makefile)

94 95 96 97
;; Sadly we need this for a macro.
(eval-when-compile
  (require 'imenu))

Eric S. Raymond's avatar
Eric S. Raymond committed
98
;;; ------------------------------------------------------------
99
;;; Configurable stuff
Eric S. Raymond's avatar
Eric S. Raymond committed
100 101 102 103 104 105
;;; ------------------------------------------------------------

(defvar makefile-browser-buffer-name "*Macros and Targets*"
  "Name of the macro- and target browser buffer.")

(defvar makefile-target-colon ":"
106 107
  "String to append to all target names inserted by `makefile-insert-target'.
\":\" or \"::\" are common values.")
Eric S. Raymond's avatar
Eric S. Raymond committed
108 109

(defvar makefile-macro-assign " = "
110
  "String to append to all macro names inserted by `makefile-insert-macro'.
Eric S. Raymond's avatar
Eric S. Raymond committed
111 112 113 114 115
The normal value should be \" = \", since this is what
standard make expects. However, newer makes such as dmake
allow a larger variety of different macro assignments, so you
might prefer to use \" += \" or \" := \" .")

116 117 118 119
(defvar makefile-electric-keys nil
  "If non-nil, install electric keybindings.
Default is nil.")

Eric S. Raymond's avatar
Eric S. Raymond committed
120
(defvar makefile-use-curly-braces-for-macros-p nil
121
  "Controls the style of generated macro references.
122 123 124
t (actually non-nil) means macro references should use curly braces,
like `${this}'.
nil means use parentheses, like `$(this)'.")
Eric S. Raymond's avatar
Eric S. Raymond committed
125 126

(defvar makefile-tab-after-target-colon t
127 128 129
  "If non-nil, insert a TAB after a target colon.
Otherwise, a space is inserted.
The default is t.")
Eric S. Raymond's avatar
Eric S. Raymond committed
130 131 132 133 134 135 136 137

(defvar makefile-browser-leftmost-column 10
  "Number of blanks to the left of the browser selection mark.")

(defvar makefile-browser-cursor-column 10
  "Column in which the cursor is positioned when it moves
up or down in the browser.")

138 139 140
(defvar makefile-backslash-column 48
  "*Column in which `makefile-backslash-region' inserts backslashes.")

Eric S. Raymond's avatar
Eric S. Raymond committed
141 142 143 144 145 146 147
(defvar makefile-browser-selected-mark "+  "
  "String used to mark selected entries in the browser.")

(defvar makefile-browser-unselected-mark "   "
  "String used to mark unselected entries in the browser.")

(defvar makefile-browser-auto-advance-after-selection-p t
148
  "If non-nil, cursor will move after item is selected in browser.")
Eric S. Raymond's avatar
Eric S. Raymond committed
149 150

(defvar makefile-pickup-everything-picks-up-filenames-p nil
151 152 153
  "If non-nil, `makefile-pickup-everything' picks up filenames as targets.
\(i.e. it calls `makefile-find-filenames-as-targets').
Otherwise filenames are omitted.")
Eric S. Raymond's avatar
Eric S. Raymond committed
154 155

(defvar makefile-cleanup-continuations-p t
156 157 158 159
  "If non-nil, automatically clean up continuation lines when saving.
A line is cleaned up by removing all whitespace following a trailing
backslash.  This is done silently.
IMPORTANT: Please note that enabling this option causes makefile-mode
Eric S. Raymond's avatar
Eric S. Raymond committed
160 161
to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \'it seems necessary\'.")

162
(defvar makefile-browser-hook '())
Eric S. Raymond's avatar
Eric S. Raymond committed
163 164 165 166 167 168 169 170 171 172 173 174 175

;;
;; Special targets for DMake, Sun's make ...
;; 
(defvar makefile-special-targets-list
  '(("DEFAULT")      ("DONE")        ("ERROR")        ("EXPORT")
    ("FAILED")       ("GROUPEPILOG") ("GROUPPROLOG")  ("IGNORE")
    ("IMPORT")       ("INCLUDE")     ("INCLUDEDIRS")  ("INIT")
    ("KEEP_STATE")   ("MAKEFILES")   ("MAKE_VERSION") ("NO_PARALLEL")
    ("PARALLEL")     ("PHONY")       ("PRECIOUS")     ("REMOVE")
    ("SCCS_GET")     ("SILENT")      ("SOURCE")       ("SUFFIXES")
    ("WAIT")         ("c.o")         ("C.o")          ("m.o")
    ("el.elc")       ("y.c")         ("s.o"))
176 177 178
  "List of special targets.
You will be offered to complete on one of those in the minibuffer whenever
you enter a \".\" at the beginning of a line in makefile-mode.")
Eric S. Raymond's avatar
Eric S. Raymond committed
179 180

(defvar makefile-runtime-macros-list
181
  '(("@") ("&") (">") ("<") ("*") ("^") ("+") ("?") ("%") ("$"))
Eric S. Raymond's avatar
Eric S. Raymond committed
182 183 184 185 186
  "List of macros that are resolved by make at runtime.
If you insert a macro reference using makefile-insert-macro-ref, the name
of the macro is checked against this list. If it can be found its name will
not be enclosed in { } or ( ).")

187 188 189
;; Note that the first big subexpression is used by font lock.  Note
;; that if you change this regexp you must fix the imenu index
;; function defined at the end of the file.
Eric S. Raymond's avatar
Eric S. Raymond committed
190
(defconst makefile-dependency-regex
191
  "^\\([^ \n\t#:]+\\([ \t]+[^ \t\n#:]+\\)*\\)[ \t]*:\\([ \t]*$\\|\\([^=\n].*$\\)\\)" 
Eric S. Raymond's avatar
Eric S. Raymond committed
192 193
  "Regex used to find dependency lines in a makefile.")

194 195 196
;; Note that the first subexpression is used by font lock.  Note that
;; if you change this regexp you must fix the imenu index function
;; defined at the end of the file.
Eric S. Raymond's avatar
Eric S. Raymond committed
197
(defconst makefile-macroassign-regex
198
  "^\\([^ \n\t][^:#= \t\n]*\\)[ \t]*[*:+]?:?="
Eric S. Raymond's avatar
Eric S. Raymond committed
199 200 201
  "Regex used to find macro assignment lines in a makefile.")

(defconst makefile-ignored-files-in-pickup-regex
202
  "\\(^\\..*\\)\\|\\(.*~$\\)\\|\\(.*,v$\\)\\|\\(\\.[chy]\\)"
Eric S. Raymond's avatar
Eric S. Raymond committed
203 204
  "Regex for filenames that will NOT be included in the target list.")

205 206
(if (fboundp 'facemenu-unlisted-faces)
    (add-to-list 'facemenu-unlisted-faces 'makefile-space-face))
207 208
(defvar makefile-space-face 'makefile-space-face
  "Face to use for highlighting leading spaces in Font-Lock mode.")
209

210 211
(defconst makefile-font-lock-keywords
  (list
212
   ;; Do macro assignments.  These get the "variable-name" face rather
213
   ;; arbitrarily.
214 215 216
   (list makefile-macroassign-regex 1 'font-lock-variable-name-face)
   ;;
   ;; Variable references even in targets/strings/comments:
217
   '("\\$[({]\\([-a-zA-Z0-9_.]+\\)[}):]" 1 font-lock-reference-face prepend)
218 219
   ;;
   ;; Do dependencies.  These get the function name face.
220
   (list makefile-dependency-regex 1 'font-lock-function-name-face 'prepend)
221

Richard M. Stallman's avatar
Richard M. Stallman committed
222 223 224 225
   ;; Highlight lines that contain just whitespace.
   ;; They can cause trouble, especially if they start with a tab.
   '("^[ \t]+$" . makefile-space-face)

226 227
   ;; Highlight shell comments that Make treats as commands,
   ;; since these can fool people.
228
   '("^\t+#" 0 makefile-space-face t)
229 230 231 232

   ;; Highlight spaces that precede tabs.
   ;; They can make a tab fail to be effective.
   '("^\\( +\\)\t" 1 makefile-space-face)))
233

Eric S. Raymond's avatar
Eric S. Raymond committed
234 235 236
;;; ------------------------------------------------------------
;;; The following configurable variables are used in the
;;; up-to-date overview .
237
;;; The standard configuration assumes that your `make' program
Eric S. Raymond's avatar
Eric S. Raymond committed
238 239 240 241 242 243 244 245
;;; can be run in question/query mode using the `-q' option, this
;;; means that the command
;;;
;;;    make -q foo
;;;
;;; should return an exit status of zero if the target `foo' is
;;; up to date and a nonzero exit status otherwise.
;;; Many makes can do this although the docs/manpages do not mention
246 247
;;; it. Try it with your favourite one.  GNU make, System V make, and
;;; Dennis Vadura's DMake have no problems.
Eric S. Raymond's avatar
Eric S. Raymond committed
248 249
;;; Set the variable `makefile-brave-make' to the name of the
;;; make utility that does this on your system.
250
;;; To understand what this is all about see the function definition
Eric S. Raymond's avatar
Eric S. Raymond committed
251 252 253
;;; of `makefile-query-by-make-minus-q' .
;;; ------------------------------------------------------------

254
(defvar makefile-brave-make "make"
Richard M. Stallman's avatar
Richard M. Stallman committed
255
  "A make that can handle the `-q' option.")
Eric S. Raymond's avatar
Eric S. Raymond committed
256 257

(defvar makefile-query-one-target-method 'makefile-query-by-make-minus-q
Richard M. Stallman's avatar
Richard M. Stallman committed
258 259
  "Function to call to determine whether a make target is up to date.
The function must satisfy this calling convention:
Eric S. Raymond's avatar
Eric S. Raymond committed
260 261 262 263 264

* As its first argument, it must accept the name of the target to
  be checked, as a string.

* As its second argument, it may accept the name of a makefile
265
  as a string. Depending on what you're going to do you may
Eric S. Raymond's avatar
Eric S. Raymond committed
266 267 268 269 270 271 272 273 274 275 276 277
  not need this.

* It must return the integer value 0 (zero) if the given target
  should be considered up-to-date in the context of the given
  makefile, any nonzero integer value otherwise.")

(defvar makefile-up-to-date-buffer-name "*Makefile Up-to-date overview*"
  "Name of the Up-to-date overview buffer.")

;;; --- end of up-to-date-overview configuration ------------------

(defvar makefile-mode-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
278 279
  "The keymap that is used in Makefile mode.")

Eric S. Raymond's avatar
Eric S. Raymond committed
280 281 282 283
(if makefile-mode-map
    ()
  (setq makefile-mode-map (make-sparse-keymap))
  ;; set up the keymap
284 285 286 287 288 289 290
  (define-key makefile-mode-map "\C-c:" 'makefile-insert-target-ref)
  (if makefile-electric-keys
      (progn
	(define-key makefile-mode-map "$" 'makefile-insert-macro-ref)
	(define-key makefile-mode-map ":" 'makefile-electric-colon)
	(define-key makefile-mode-map "=" 'makefile-electric-equal)
	(define-key makefile-mode-map "." 'makefile-electric-dot)))
Eric S. Raymond's avatar
Eric S. Raymond committed
291 292 293 294 295
  (define-key makefile-mode-map "\C-c\C-f" 'makefile-pickup-filenames-as-targets)
  (define-key makefile-mode-map "\C-c\C-b" 'makefile-switch-to-browser)
  (define-key makefile-mode-map "\C-c\C-p" 'makefile-pickup-everything)
  (define-key makefile-mode-map "\C-c\C-u" 'makefile-create-up-to-date-overview)
  (define-key makefile-mode-map "\C-c\C-i" 'makefile-insert-gmake-function)
296
  (define-key makefile-mode-map "\C-c\C-\\" 'makefile-backslash-region)
Eric S. Raymond's avatar
Eric S. Raymond committed
297
  (define-key makefile-mode-map "\M-p"     'makefile-previous-dependency)
298 299 300 301 302 303 304 305
  (define-key makefile-mode-map "\M-n"     'makefile-next-dependency)
  (define-key makefile-mode-map "\e\t"     'makefile-complete)

  ;; Make menus.
  (define-key makefile-mode-map [menu-bar makefile-mode]
    (cons "Makefile" (make-sparse-keymap "Makefile")))

  (define-key makefile-mode-map [menu-bar makefile-mode browse]
Karl Heuer's avatar
Karl Heuer committed
306
    '("Pop up Makefile Browser" . makefile-switch-to-browser))
307
  (define-key makefile-mode-map [menu-bar makefile-mode complete]
Karl Heuer's avatar
Karl Heuer committed
308
    '("Complete Target or Macro" . makefile-complete))
309
  (define-key makefile-mode-map [menu-bar makefile-mode pickup]
Karl Heuer's avatar
Karl Heuer committed
310
    '("Find Targets and Macros" . makefile-pickup-everything))
311 312

  (define-key makefile-mode-map [menu-bar makefile-mode prev]
Karl Heuer's avatar
Karl Heuer committed
313
    '("Move to Previous Dependency" . makefile-previous-dependency))
314
  (define-key makefile-mode-map [menu-bar makefile-mode next]
Karl Heuer's avatar
Karl Heuer committed
315
    '("Move to Next Dependency" . makefile-next-dependency)))
Eric S. Raymond's avatar
Eric S. Raymond committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335

(defvar makefile-browser-map nil
  "The keymap that is used in the macro- and target browser.")
(if makefile-browser-map
    ()
  (setq makefile-browser-map (make-sparse-keymap))
  (define-key makefile-browser-map "n"    'makefile-browser-next-line)
  (define-key makefile-browser-map "\C-n" 'makefile-browser-next-line)    
  (define-key makefile-browser-map "p"    'makefile-browser-previous-line)
  (define-key makefile-browser-map "\C-p" 'makefile-browser-previous-line)
  (define-key makefile-browser-map " "    'makefile-browser-toggle)
  (define-key makefile-browser-map "i"    'makefile-browser-insert-selection)
  (define-key makefile-browser-map "I"    'makefile-browser-insert-selection-and-quit)  
  (define-key makefile-browser-map "\C-c\C-m" 'makefile-browser-insert-continuation)
  (define-key makefile-browser-map "q"    'makefile-browser-quit)
  ;; disable horizontal movement
  (define-key makefile-browser-map "\C-b" 'undefined)
  (define-key makefile-browser-map "\C-f" 'undefined))  


336
(defvar makefile-mode-syntax-table nil)
Eric S. Raymond's avatar
Eric S. Raymond committed
337 338 339 340 341 342
(if makefile-mode-syntax-table
    ()
  (setq makefile-mode-syntax-table (make-syntax-table))
  (modify-syntax-entry ?\( "()    " makefile-mode-syntax-table)
  (modify-syntax-entry ?\) ")(    " makefile-mode-syntax-table)
  (modify-syntax-entry ?\[ "(]    " makefile-mode-syntax-table)
343
  (modify-syntax-entry ?\] ")[    " makefile-mode-syntax-table)
Eric S. Raymond's avatar
Eric S. Raymond committed
344 345
  (modify-syntax-entry ?\{ "(}    " makefile-mode-syntax-table)  
  (modify-syntax-entry ?\} "){    " makefile-mode-syntax-table)
346 347
  (modify-syntax-entry ?\' "\"     " makefile-mode-syntax-table)
  (modify-syntax-entry ?\` "\"     " makefile-mode-syntax-table)
Eric S. Raymond's avatar
Eric S. Raymond committed
348 349
  (modify-syntax-entry ?#  "<     " makefile-mode-syntax-table)
  (modify-syntax-entry ?\n ">     " makefile-mode-syntax-table))
350 351


Eric S. Raymond's avatar
Eric S. Raymond committed
352 353 354 355 356 357
;;; ------------------------------------------------------------
;;; Internal variables.
;;; You don't need to configure below this line.
;;; ------------------------------------------------------------

(defvar makefile-target-table nil
358
  "Table of all target names known for this buffer.")
Eric S. Raymond's avatar
Eric S. Raymond committed
359 360

(defvar makefile-macro-table nil
361
  "Table of all macro names known for this buffer.")
Eric S. Raymond's avatar
Eric S. Raymond committed
362 363

(defvar makefile-browser-client
Richard M. Stallman's avatar
Richard M. Stallman committed
364
  "A buffer in Makefile mode that is currently using the browser.")
Eric S. Raymond's avatar
Eric S. Raymond committed
365 366

(defvar makefile-browser-selection-vector nil)
367 368 369
(defvar makefile-has-prereqs nil)
(defvar makefile-need-target-pickup t)
(defvar makefile-need-macro-pickup t)
Eric S. Raymond's avatar
Eric S. Raymond committed
370 371 372

(defvar makefile-mode-hook '())

373 374
;; Each element looks like '("GNU MAKE FUNCTION" "ARG" "ARG" ... )
;; Each "ARG" is used as a prompt for a required argument.
Eric S. Raymond's avatar
Eric S. Raymond committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
(defconst makefile-gnumake-functions-alist
  '(
    ;; Text functions
    ("subst" "From" "To" "In")
    ("patsubst" "Pattern" "Replacement" "In")
    ("strip" "Text")
    ("findstring" "Find what" "In")
    ("filter" "Pattern" "Text")
    ("filter-out" "Pattern" "Text")
    ("sort" "List")
    ;; Filename functions
    ("dir" "Names")
    ("notdir" "Names")
    ("suffix" "Names")
    ("basename" "Names")
390
    ("addprefix" "Prefix" "Names")
Eric S. Raymond's avatar
Eric S. Raymond committed
391 392 393 394 395 396 397 398 399
    ("addsuffix" "Suffix" "Names")
    ("join" "List 1" "List 2")
    ("word" "Index" "Text")
    ("words" "Text")
    ("firstword" "Text")
    ("wildcard" "Pattern")
    ;; Misc functions
    ("foreach" "Variable" "List" "Text")
    ("origin" "Variable")
400
    ("shell" "Command")))
Eric S. Raymond's avatar
Eric S. Raymond committed
401 402 403 404 405 406


;;; ------------------------------------------------------------
;;; The mode function itself.
;;; ------------------------------------------------------------

407
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
408 409
(defun makefile-mode ()
  "Major mode for editing Makefiles.
Richard M. Stallman's avatar
Richard M. Stallman committed
410
This function ends by invoking the function(s) `makefile-mode-hook'.
Eric S. Raymond's avatar
Eric S. Raymond committed
411 412 413 414 415 416 417

\\{makefile-mode-map}

In the browser, use the following keys:

\\{makefile-browser-map}

Richard M. Stallman's avatar
Richard M. Stallman committed
418
Makefile mode can be configured by modifying the following variables:
Eric S. Raymond's avatar
Eric S. Raymond committed
419 420 421 422 423 424

makefile-browser-buffer-name:
    Name of the macro- and target browser buffer.

makefile-target-colon:
    The string that gets appended to all target names
Richard M. Stallman's avatar
Richard M. Stallman committed
425
    inserted by `makefile-insert-target'.
Eric S. Raymond's avatar
Eric S. Raymond committed
426 427 428 429
    \":\" or \"::\" are quite common values.

makefile-macro-assign:
   The string that gets appended to all macro names
Richard M. Stallman's avatar
Richard M. Stallman committed
430
   inserted by `makefile-insert-macro'.
Eric S. Raymond's avatar
Eric S. Raymond committed
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
   The normal value should be \" = \", since this is what
   standard make expects. However, newer makes such as dmake
   allow a larger variety of different macro assignments, so you
   might prefer to use \" += \" or \" := \" .

makefile-tab-after-target-colon:
   If you want a TAB (instead of a space) to be appended after the
   target colon, then set this to a non-nil value.

makefile-browser-leftmost-column:
   Number of blanks to the left of the browser selection mark.

makefile-browser-cursor-column:
   Column in which the cursor is positioned when it moves
   up or down in the browser.

makefile-browser-selected-mark:
   String used to mark selected entries in the browser.

makefile-browser-unselected-mark:
   String used to mark unselected entries in the browser.

makefile-browser-auto-advance-after-selection-p:
   If this variable is set to a non-nil value the cursor
   will automagically advance to the next line after an item
   has been selected in the browser.

makefile-pickup-everything-picks-up-filenames-p:
   If this variable is set to a non-nil value then
Richard M. Stallman's avatar
Richard M. Stallman committed
460 461
   `makefile-pickup-everything' also picks up filenames as targets
   (i.e. it calls `makefile-find-filenames-as-targets'), otherwise
Eric S. Raymond's avatar
Eric S. Raymond committed
462 463 464 465 466 467 468 469 470
   filenames are omitted.

makefile-cleanup-continuations-p:
   If this variable is set to a non-nil value then makefile-mode
   will assure that no line in the file ends with a backslash
   (the continuation character) followed by any whitespace.
   This is done by silently removing the trailing whitespace, leaving
   the backslash itself intact.
   IMPORTANT: Please note that enabling this option causes makefile-mode
Richard M. Stallman's avatar
Richard M. Stallman committed
471
   to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \"it seems necessary\".
Eric S. Raymond's avatar
Eric S. Raymond committed
472 473 474

makefile-browser-hook:
   A function or list of functions to be called just before the
475
   browser is entered. This is executed in the makefile buffer.
Eric S. Raymond's avatar
Eric S. Raymond committed
476 477 478

makefile-special-targets-list:
   List of special targets. You will be offered to complete
Richard M. Stallman's avatar
Richard M. Stallman committed
479 480
   on one of those in the minibuffer whenever you enter a `.'.
   at the beginning of a line in Makefile mode."
481

Eric S. Raymond's avatar
Eric S. Raymond committed
482 483
  (interactive)
  (kill-all-local-variables)
484
  (make-local-variable 'local-write-file-hooks)
485
  (setq local-write-file-hooks
486
	'(makefile-cleanup-continuations makefile-warn-suspicious-lines))
487 488 489 490 491
  (make-local-variable 'makefile-target-table)
  (make-local-variable 'makefile-macro-table)
  (make-local-variable 'makefile-has-prereqs)
  (make-local-variable 'makefile-need-target-pickup)
  (make-local-variable 'makefile-need-macro-pickup)
492 493

  ;; Font lock.
494
  (if (fboundp 'make-face)
495
      (makefile-define-space-face))
496 497
  (make-local-variable 'font-lock-defaults)
  (setq font-lock-defaults '(makefile-font-lock-keywords))
498 499 500 501 502 503 504 505 506

  ;; Add-log.
  (make-local-variable 'add-log-current-defun-function)
  (setq add-log-current-defun-function 'makefile-add-log-defun)

  ;; Imenu.
  (make-local-variable 'imenu-create-index-function)
  (setq imenu-create-index-function 'makefile-menu-index-function)

507 508 509 510
  ;; Dabbrev.
  (make-local-variable 'dabbrev-abbrev-skip-leading-regexp)
  (setq dabbrev-abbrev-skip-leading-regexp "\\$")

511
  ;; Comment stuff.
512
  (make-local-variable 'comment-start)
Eric S. Raymond's avatar
Eric S. Raymond committed
513
  (setq comment-start "#")
514
  (make-local-variable 'comment-end)
Eric S. Raymond's avatar
Eric S. Raymond committed
515
  (setq comment-end "")
516 517 518
  (make-local-variable 'comment-start-skip)
  (setq comment-start-skip "#+[ \t]*")

Eric S. Raymond's avatar
Eric S. Raymond committed
519 520
  ;; become the current major mode
  (setq major-mode 'makefile-mode)
521 522 523
  (setq mode-name "Makefile")

  ;; Activate keymap and syntax table.
Eric S. Raymond's avatar
Eric S. Raymond committed
524 525
  (use-local-map makefile-mode-map)
  (set-syntax-table makefile-mode-syntax-table)
526 527 528 529 530 531 532 533

  ;; Real TABs are important in makefiles
  (setq indent-tabs-mode t)
  (run-hooks 'makefile-mode-hook))



;;; Motion code.
Eric S. Raymond's avatar
Eric S. Raymond committed
534 535

(defun makefile-next-dependency ()
Richard M. Stallman's avatar
Richard M. Stallman committed
536
  "Move point to the beginning of the next dependency line."
Eric S. Raymond's avatar
Eric S. Raymond committed
537 538 539 540 541 542
  (interactive)
  (let ((here (point)))
    (end-of-line)
    (if (re-search-forward makefile-dependency-regex (point-max) t)
	(progn (beginning-of-line) t)	; indicate success
      (goto-char here) nil)))
543

Eric S. Raymond's avatar
Eric S. Raymond committed
544
(defun makefile-previous-dependency ()
Richard M. Stallman's avatar
Richard M. Stallman committed
545
  "Move point to the beginning of the previous dependency line."
Eric S. Raymond's avatar
Eric S. Raymond committed
546 547 548 549 550 551 552
  (interactive)
  (let ((here (point)))
    (beginning-of-line)
    (if (re-search-backward makefile-dependency-regex (point-min) t)
	(progn (beginning-of-line) t)	; indicate success
      (goto-char here) nil)))

553

Eric S. Raymond's avatar
Eric S. Raymond committed
554

555
;;; Electric keys.  Blech.
556

557 558 559 560 561
(defun makefile-electric-dot (arg)
  "Prompt for the name of a special target to insert.
Only does electric insertion at beginning of line.
Anywhere else just self-inserts."
  (interactive "p")
Eric S. Raymond's avatar
Eric S. Raymond committed
562 563
  (if (bolp)
      (makefile-insert-special-target)
564
    (self-insert-command arg)))
Eric S. Raymond's avatar
Eric S. Raymond committed
565 566

(defun makefile-insert-special-target ()
Karl Heuer's avatar
Karl Heuer committed
567
  "Prompt for and insert a special target name.
568
Uses `makefile-special-targets' list."
Eric S. Raymond's avatar
Eric S. Raymond committed
569
  (interactive)
570
  (makefile-pickup-targets)
571 572 573
  (let ((special-target
	 (completing-read "Special target: "
			  makefile-special-targets-list nil nil nil)))
Eric S. Raymond's avatar
Eric S. Raymond committed
574 575
    (if (zerop (length special-target))
	()
576
      (insert "." special-target ":")
Eric S. Raymond's avatar
Eric S. Raymond committed
577 578
      (makefile-forward-after-target-colon))))

579 580 581 582 583
(defun makefile-electric-equal (arg)
  "Prompt for name of a macro to insert.
Only does prompting if point is at beginning of line.
Anywhere else just self-inserts."
  (interactive "p")
584
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
585 586
  (if (bolp)
      (call-interactively 'makefile-insert-macro)
587
    (self-insert-command arg)))
Eric S. Raymond's avatar
Eric S. Raymond committed
588 589 590 591

(defun makefile-insert-macro (macro-name)
  "Prepare definition of a new macro."
  (interactive "sMacro Name: ")
592
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
593 594 595
  (if (not (zerop (length macro-name)))
      (progn
	(beginning-of-line)
596
	(insert macro-name makefile-macro-assign)
597
	(setq makefile-need-macro-pickup t)
Eric S. Raymond's avatar
Eric S. Raymond committed
598 599 600
	(makefile-remember-macro macro-name))))

(defun makefile-insert-macro-ref (macro-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
601
  "Complete on a list of known macros, then insert complete ref at point."
Eric S. Raymond's avatar
Eric S. Raymond committed
602 603
  (interactive
   (list
604 605 606
    (progn
      (makefile-pickup-macros)
      (completing-read "Refer to macro: " makefile-macro-table nil nil nil))))
607
  (makefile-do-macro-insertion macro-name))
Eric S. Raymond's avatar
Eric S. Raymond committed
608 609 610 611 612 613 614

(defun makefile-insert-target (target-name)
  "Prepare definition of a new target (dependency line)."
  (interactive "sTarget: ")
  (if (not (zerop (length target-name)))
      (progn
	(beginning-of-line)
615
	(insert target-name makefile-target-colon)
Eric S. Raymond's avatar
Eric S. Raymond committed
616 617
	(makefile-forward-after-target-colon)
	(end-of-line)
618
	(setq makefile-need-target-pickup t)
Eric S. Raymond's avatar
Eric S. Raymond committed
619 620 621
	(makefile-remember-target target-name))))

(defun makefile-insert-target-ref (target-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
622
  "Complete on a list of known targets, then insert target-ref at point."
Eric S. Raymond's avatar
Eric S. Raymond committed
623 624
  (interactive
   (list
625
    (progn
626 627
     (makefile-pickup-targets)
     (completing-read "Refer to target: " makefile-target-table nil nil nil))))
Eric S. Raymond's avatar
Eric S. Raymond committed
628
   (if (not (zerop (length target-name)))
629
       (insert target-name " ")))
Eric S. Raymond's avatar
Eric S. Raymond committed
630

631 632 633 634 635
(defun makefile-electric-colon (arg)
  "Prompt for name of new target.
Prompting only happens at beginning of line.
Anywhere else just self-inserts."
  (interactive "p")
Eric S. Raymond's avatar
Eric S. Raymond committed
636 637
  (if (bolp)
      (call-interactively 'makefile-insert-target)
638 639 640
    (self-insert-command arg)))


Eric S. Raymond's avatar
Eric S. Raymond committed
641 642 643 644 645 646

;;; ------------------------------------------------------------
;;; Extracting targets and macros from an existing makefile
;;; ------------------------------------------------------------

(defun makefile-pickup-targets ()
647
  "Notice names of all target definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
648
  (interactive)
649 650 651 652 653 654 655 656 657 658
  (if (not makefile-need-target-pickup)
      nil
    (setq makefile-need-target-pickup nil)
    (setq makefile-target-table nil)
    (setq makefile-has-prereqs nil)
    (save-excursion
      (goto-char (point-min))
      (while (re-search-forward makefile-dependency-regex (point-max) t)
	(makefile-add-this-line-targets)))
    (message "Read targets OK.")))
Eric S. Raymond's avatar
Eric S. Raymond committed
659 660 661 662

(defun makefile-add-this-line-targets ()
  (save-excursion
    (beginning-of-line)
663 664
    (let ((done-with-line nil)
	  (line-number (1+ (count-lines (point-min) (point)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
665 666 667 668 669 670 671 672 673
      (while (not done-with-line)
	(skip-chars-forward " \t")
	(if (not (setq done-with-line (or (eolp)
					  (char-equal (char-after (point)) ?:))))
	    (progn
	      (let* ((start-of-target-name (point))
		     (target-name
		      (progn
			(skip-chars-forward "^ \t:#")
674 675 676 677 678 679
			(buffer-substring start-of-target-name (point))))
		     (has-prereqs
		      (not (looking-at ":[ \t]*$"))))
		(if (makefile-remember-target target-name has-prereqs)
		    (message "Picked up target \"%s\" from line %d"
			     target-name line-number)))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
680 681

(defun makefile-pickup-macros ()
682
  "Notice names of all macro definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
683
  (interactive)
684 685 686 687 688 689 690 691 692 693
  (if (not makefile-need-macro-pickup)
      nil
    (setq makefile-need-macro-pickup nil)
    (setq makefile-macro-table nil)
    (save-excursion
      (goto-char (point-min))
      (while (re-search-forward makefile-macroassign-regex (point-max) t)
	(makefile-add-this-line-macro)
	(forward-line 1)))
    (message "Read macros OK.")))
Eric S. Raymond's avatar
Eric S. Raymond committed
694 695 696 697 698 699 700

(defun makefile-add-this-line-macro ()
  (save-excursion
    (beginning-of-line)
    (skip-chars-forward " \t")
    (if (not (eolp))
	(let* ((start-of-macro-name (point))
701
	       (line-number (1+ (count-lines (point-min) (point))))
Eric S. Raymond's avatar
Eric S. Raymond committed
702 703 704 705
	       (macro-name (progn
			     (skip-chars-forward "^ \t:#=*")
			     (buffer-substring start-of-macro-name (point)))))
	  (if (makefile-remember-macro macro-name)
706 707
	      (message "Picked up macro \"%s\" from line %d"
		       macro-name line-number))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
708

709
(defun makefile-pickup-everything (arg)
710
  "Notice names of all macros and targets in Makefile.
711 712 713 714 715 716
Prefix arg means force pickups to be redone."
  (interactive "P")
  (if arg
      (progn
	(setq makefile-need-target-pickup t)
	(setq makefile-need-macro-pickup t)))
Eric S. Raymond's avatar
Eric S. Raymond committed
717 718 719 720 721 722
  (makefile-pickup-macros)
  (makefile-pickup-targets)
  (if makefile-pickup-everything-picks-up-filenames-p
      (makefile-pickup-filenames-as-targets)))

(defun makefile-pickup-filenames-as-targets ()
723 724 725
  "Scan the current directory for filenames to use as targets.
Checks each filename against `makefile-ignored-files-in-pickup-regex'
and adds all qualifying names to the list of known targets."
Eric S. Raymond's avatar
Eric S. Raymond committed
726 727 728 729 730 731 732 733 734 735 736 737 738
  (interactive)
  (let* ((dir (file-name-directory (buffer-file-name)))
	 (raw-filename-list (if dir
				(file-name-all-completions "" dir)
			      (file-name-all-completions "" ""))))
    (mapcar '(lambda (name)
	       (if (and (not (file-directory-p name))
			(not (string-match makefile-ignored-files-in-pickup-regex
					   name)))
		   (if (makefile-remember-target name)
		       (message "Picked up file \"%s\" as target" name))))
	    raw-filename-list)))

739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835


;;; Completion.

(defun makefile-complete ()
  "Perform completion on Makefile construct preceding point.
Can complete variable and target names.
The context determines which are considered."
  (interactive)
  (let* ((beg (save-excursion
		(skip-chars-backward "^$(){}:#= \t\n")
		(point)))
	 (try (buffer-substring beg (point)))
	 (do-macros nil)
	 (paren nil))

    (save-excursion
      (goto-char beg)
      (let ((pc (preceding-char)))
	(cond
	 ;; Beginning of line means anything.
	 ((bolp)
	  ())

	 ;; Preceding "$" means macros only.
	 ((= pc ?$)
	  (setq do-macros t))

	 ;; Preceding "$(" or "${" means macros only.
	 ((and (or (= pc ?{)
		   (= pc ?\())
	       (progn
		 (setq paren pc)
		 (backward-char)
		 (and (not (bolp))
		      (= (preceding-char) ?$))))
	  (setq do-macros t)))))

    ;; Try completion.
    (let* ((table (append (if do-macros
			      '()
			    makefile-target-table)
			  makefile-macro-table))
	   (completion (try-completion try table)))
      (cond
       ;; Exact match, so insert closing paren or colon.
       ((eq completion t)
	(insert (if do-macros
		    (if (eq paren ?{)
			?}
		      ?\))
		  (if (save-excursion
			(goto-char beg)
			(bolp))
		      ":"
		    " "))))

       ;; No match.
       ((null completion)
	(message "Can't find completion for \"%s\"" try)
	(ding))

       ;; Partial completion.
       ((not (string= try completion))
	;; FIXME it would be nice to supply the closing paren if an
	;; exact, unambiguous match were found.  That is not possible
	;; right now.  Ditto closing ":" for targets.
	(delete-region beg (point))

	;; DO-MACROS means doing macros only.  If not that, then check
	;; to see if this completion is a macro.  Special insertion
	;; must be done for macros.
	(if (or do-macros
		(assoc completion makefile-macro-table))
	    (let ((makefile-use-curly-braces-for-macros-p
		   (or (eq paren ?{)
		       makefile-use-curly-braces-for-macros-p)))
	      (delete-backward-char 2)
	      (makefile-do-macro-insertion completion)
	      (delete-backward-char 1))

	  ;; Just insert targets.
	  (insert completion)))

       ;; Can't complete any more, so make completion list.  FIXME
       ;; this doesn't do the right thing when the completion is
       ;; actually inserted.  I don't think there is an easy way to do
       ;; that.
       (t
	(message "Making completion list...")
	(let ((list (all-completions try table)))
	  (with-output-to-temp-buffer "*Completions*"
	    (display-completion-list list)))
	(message "Making completion list...done"))))))



836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
;; Backslashification.  Stolen from cc-mode.el.

(defun makefile-backslashify-current-line (doit)
  (end-of-line)
  (if doit
      (if (not (save-excursion
		 (forward-char -1)
		 (eq (char-after (point)) ?\\ )))
	  (progn
	    (if (>= (current-column) makefile-backslash-column)
		(insert " \\")
	      (while (<= (current-column) makefile-backslash-column)
		(insert "\t")
		(end-of-line))
	      (delete-char -1)
	      (while (< (current-column) makefile-backslash-column)
		(insert " ")
		(end-of-line))
	      (insert "\\"))))
    (if (not (bolp))
	(progn
	  (forward-char -1)
	  (if (eq (char-after (point)) ?\\ )
	      (let ((saved (save-excursion
			    (end-of-line)
			    (point))))
		(skip-chars-backward " \t")
		(delete-region (point) saved)))))))

(defun makefile-backslash-region (beg end arg)
  "Insert backslashes at end of every line in region.
Useful for defining multi-line rules.
Karl Heuer's avatar
Karl Heuer committed
868
If called with a prefix argument, trailing backslashes are removed."
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
  (interactive "r\nP")
  (save-excursion
    (let ((do-lastline-p (progn (goto-char end) (not (bolp)))))
      (save-restriction
	(narrow-to-region beg end)
	(goto-char (point-min))
	(while (not (save-excursion
		      (forward-line 1)
		      (eobp)))
	  (makefile-backslashify-current-line (null arg))
	  (forward-line 1)))
      (and do-lastline-p
	   (progn (goto-char end)
		  (makefile-backslashify-current-line (null arg)))))))



Eric S. Raymond's avatar
Eric S. Raymond committed
886
;;; ------------------------------------------------------------
887
;;; Browser mode.
Eric S. Raymond's avatar
Eric S. Raymond committed
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
;;; ------------------------------------------------------------

(defun makefile-browser-format-target-line (target selected)
  (format
   (concat (make-string makefile-browser-leftmost-column ?\ )
	   (if selected
	       makefile-browser-selected-mark
	     makefile-browser-unselected-mark)
	   "%s%s")
   target makefile-target-colon))

(defun makefile-browser-format-macro-line (macro selected)
  (format
   (concat (make-string makefile-browser-leftmost-column ?\ )
	   (if selected
	       makefile-browser-selected-mark
	     makefile-browser-unselected-mark)
	   (makefile-format-macro-ref macro))))

(defun makefile-browser-fill (targets macros)
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
  (let ((inhibit-read-only t))
    (goto-char (point-min))
    (erase-buffer)
    (mapconcat
     (function
      (lambda (item) (insert (makefile-browser-format-target-line (car item) nil) "\n")))
     targets
     "")
    (mapconcat
     (function
      (lambda (item) (insert (makefile-browser-format-macro-line (car item) nil) "\n")))
     macros
     "")
    (sort-lines nil (point-min) (point-max))
    (goto-char (1- (point-max)))
    (delete-char 1)			; remove unnecessary newline at eob
    (goto-char (point-min))
    (forward-char makefile-browser-cursor-column)))
Eric S. Raymond's avatar
Eric S. Raymond committed
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951

;;;
;;; Moving up and down in the browser
;;;

(defun makefile-browser-next-line ()
  "Move the browser selection cursor to the next line."
  (interactive)
  (if (not (makefile-last-line-p))
      (progn
	(forward-line 1)
	(forward-char makefile-browser-cursor-column))))

(defun makefile-browser-previous-line ()
  "Move the browser selection cursor to the previous line."
  (interactive)
  (if (not (makefile-first-line-p))
      (progn
	(forward-line -1)
	(forward-char makefile-browser-cursor-column))))

;;;
;;; Quitting the browser (returns to client buffer)
;;;

(defun makefile-browser-quit ()
952
  "Leave the browser and return to the makefile buffer."
Eric S. Raymond's avatar
Eric S. Raymond committed
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
  (interactive)
  (let ((my-client makefile-browser-client))
    (setq makefile-browser-client nil)	; we quitted, so NO client!
    (set-buffer-modified-p nil)
    (kill-buffer (current-buffer))
    (pop-to-buffer my-client)))

;;;
;;; Toggle state of a browser item
;;;

(defun makefile-browser-toggle ()
  "Toggle the selection state of the browser item at the cursor position."
  (interactive)
  (let ((this-line (count-lines (point-min) (point))))
    (setq this-line (max 1 this-line))
    (makefile-browser-toggle-state-for-line this-line)
    (goto-line this-line)
971 972 973 974
    (let ((inhibit-read-only t))
      (beginning-of-line)
      (if (makefile-browser-on-macro-line-p)
	  (let ((macro-name (makefile-browser-this-line-macro-name)))
975
	    (delete-region (point) (progn (end-of-line) (point)))
976 977 978 979 980
	    (insert
	     (makefile-browser-format-macro-line
		macro-name
		(makefile-browser-get-state-for-line this-line))))
	(let ((target-name (makefile-browser-this-line-target-name)))
981
	  (delete-region (point) (progn (end-of-line) (point)))
Eric S. Raymond's avatar
Eric S. Raymond committed
982
	  (insert
983 984 985
	   (makefile-browser-format-target-line
	      target-name
	      (makefile-browser-get-state-for-line this-line))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
986 987 988 989 990 991 992 993 994 995
    (beginning-of-line)
    (forward-char makefile-browser-cursor-column)
    (if makefile-browser-auto-advance-after-selection-p
	(makefile-browser-next-line))))

;;;
;;; Making insertions into the client buffer
;;;

(defun makefile-browser-insert-continuation ()
996
  "Insert a makefile continuation.
997
In the makefile buffer, go to (end-of-line), insert a \'\\\'
Eric S. Raymond's avatar
Eric S. Raymond committed
998
character, insert a new blank line, go to that line and indent by one TAB.
999 1000
This is most useful in the process of creating continued lines when copying
large dependencies from the browser to the client buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
1001
\(point) advances accordingly in the client buffer."
Eric S. Raymond's avatar
Eric S. Raymond committed
1002 1003 1004 1005 1006 1007 1008
  (interactive)
  (save-excursion
    (set-buffer makefile-browser-client)
    (end-of-line)
    (insert "\\\n\t")))

(defun makefile-browser-insert-selection ()
1009
  "Insert all selected targets and/or macros in the makefile buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
1010
Insertion takes place at point."
Eric S. Raymond's avatar
Eric S. Raymond committed
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
  (interactive)
  (save-excursion
    (goto-line 1)
    (let ((current-line 1))
      (while (not (eobp))
	(if (makefile-browser-get-state-for-line current-line)
	    (makefile-browser-send-this-line-item))
	(forward-line 1)
	(setq current-line (1+ current-line))))))

(defun makefile-browser-insert-selection-and-quit ()
  (interactive)
  (makefile-browser-insert-selection)
  (makefile-browser-quit))

(defun makefile-browser-send-this-line-item ()
  (if (makefile-browser-on-macro-line-p)
      (save-excursion
	(let ((macro-name (makefile-browser-this-line-macro-name)))
	  (set-buffer makefile-browser-client)
	  (insert (makefile-format-macro-ref macro-name) " ")))
    (save-excursion
      (let ((target-name (makefile-browser-this-line-target-name)))
	(set-buffer makefile-browser-client)
	(insert target-name " ")))))

(defun makefile-browser-start-interaction ()
  (use-local-map makefile-browser-map)
  (setq buffer-read-only t))

(defun makefile-browse (targets macros)
  (interactive)
  (if (zerop (+ (length targets) (length macros)))
      (progn
	(beep)
	(message "No macros or targets to browse! Consider running 'makefile-pickup-everything\'"))
    (let ((browser-buffer (get-buffer-create makefile-browser-buffer-name)))
	(pop-to-buffer browser-buffer)
	(make-variable-buffer-local 'makefile-browser-selection-vector)
	(makefile-browser-fill targets macros)
1051
	(shrink-window-if-larger-than-buffer)
Eric S. Raymond's avatar
Eric S. Raymond committed
1052 1053 1054 1055 1056 1057 1058 1059
	(setq makefile-browser-selection-vector
	      (make-vector (+ (length targets) (length macros)) nil))
	(makefile-browser-start-interaction))))

(defun makefile-switch-to-browser ()
  (interactive)
  (run-hooks 'makefile-browser-hook)
  (setq makefile-browser-client (current-buffer))
1060 1061
  (makefile-pickup-targets)
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
1062 1063
  (makefile-browse makefile-target-table makefile-macro-table))

1064

Eric S. Raymond's avatar
Eric S. Raymond committed
1065 1066 1067 1068 1069 1070

;;; ------------------------------------------------------------
;;; Up-to-date overview buffer
;;; ------------------------------------------------------------

(defun makefile-create-up-to-date-overview ()
1071
  "Create a buffer containing an overview of the state of all known targets.
Eric S. Raymond's avatar
Eric S. Raymond committed
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
Known targets are targets that are explicitly defined in that makefile;
in other words, all targets that appear on the left hand side of a
dependency in the makefile."
  (interactive)
  (if (y-or-n-p "Are you sure that the makefile being edited is consistent? ")
      ;;
      ;; The rest of this function operates on a temporary makefile, created by
      ;; writing the current contents of the makefile buffer.
      ;;
      (let ((saved-target-table makefile-target-table)
	    (this-buffer (current-buffer))
	    (makefile-up-to-date-buffer
	     (get-buffer-create makefile-up-to-date-buffer-name))
	    (filename (makefile-save-temporary))
	    ;;
	    ;; Forget the target table because it may contain picked-up filenames
	    ;; that are not really targets in the current makefile.
	    ;; We don't want to query these, so get a new target-table with just the
	    ;; targets that can be found in the makefile buffer.
	    ;; The 'old' target table will be restored later.
	    ;;
	    (real-targets (progn
			    (makefile-pickup-targets)
1095 1096 1097
			    makefile-target-table))
	    (prereqs makefile-has-prereqs)
	    )
Eric S. Raymond's avatar
Eric S. Raymond committed
1098 1099 1100 1101

	(set-buffer makefile-up-to-date-buffer)
	(setq buffer-read-only nil)
	(erase-buffer)
1102
	(makefile-query-targets filename real-targets prereqs)
Eric S. Raymond's avatar
Eric S. Raymond committed
1103 1104 1105 1106 1107 1108 1109 1110 1111
	(if (zerop (buffer-size))		; if it did not get us anything
	    (progn
	      (kill-buffer (current-buffer))
	      (message "No overview created!")))
	(set-buffer this-buffer)
	(setq makefile-target-table saved-target-table)
	(if (get-buffer makefile-up-to-date-buffer-name)
	    (progn
	      (pop-to-buffer (get-buffer makefile-up-to-date-buffer-name))
1112
	      (shrink-window-if-larger-than-buffer)
Eric S. Raymond's avatar
Eric S. Raymond committed
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
	      (sort-lines nil (point-min) (point-max))
	      (setq buffer-read-only t))))))

(defun makefile-save-temporary ()
  "Create a temporary file from the current makefile buffer."
  (let ((filename (makefile-generate-temporary-filename)))
    (write-region (point-min) (point-max) filename nil 0)
    filename))				; return the filename

(defun makefile-generate-temporary-filename ()
1123
  "Create a filename suitable for use in `makefile-save-temporary'.
Eric S. Raymond's avatar
Eric S. Raymond committed
1124
Be careful to allow brain-dead file systems (DOS, SYSV ...) to cope
1125
with the generated name!"
Eric S. Raymond's avatar
Eric S. Raymond committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
  (let ((my-name (user-login-name))
	(my-uid (int-to-string (user-uid))))
    (concat "mktmp"
	  (if (> (length my-name) 3)
	      (substring my-name 0 3)
	    my-name)
	  "."
	  (if (> (length my-uid) 3)
	      (substring my-uid 0 3)
	    my-uid))))

1137
(defun makefile-query-targets (filename target-table prereq-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
1138
  "Fill the up-to-date overview buffer.
1139
Checks each target in TARGET-TABLE using `makefile-query-one-target-method'
Eric S. Raymond's avatar
Eric S. Raymond committed
1140 1141
and generates the overview, one line per target name."
  (insert
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
   (mapconcat
    (function (lambda (item)
		(let* ((target-name (car item))
		       (no-prereqs (not (member target-name prereq-list)))
		       (needs-rebuild (or no-prereqs 
					  (funcall
					   makefile-query-one-target-method
					   target-name
					   filename))))
		  (format "\t%s%s"
			  target-name
			  (cond (no-prereqs "  .. has no prerequisites")
				(needs-rebuild "  .. NEEDS REBUILD")
				(t "  .. is up to date"))))
		))
    target-table "\n"))
Eric S. Raymond's avatar
Eric S. Raymond committed
1158 1159 1160 1161
  (goto-char (point-min))
  (delete-file filename))		; remove the tmpfile

(defun makefile-query-by-make-minus-q (target &optional filename)
1162 1163 1164
  (not (zerop
	(call-process makefile-brave-make nil nil nil
		      "-f" filename "-q" target))))
Eric S. Raymond's avatar
Eric S. Raymond committed
1165

1166 1167


Eric S. Raymond's avatar
Eric S. Raymond committed
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
;;; ------------------------------------------------------------
;;; Continuation cleanup
;;; ------------------------------------------------------------

(defun makefile-cleanup-continuations ()
  (if (eq major-mode 'makefile-mode)
      (if (and makefile-cleanup-continuations-p
	       (not buffer-read-only))
	  (save-excursion
	    (goto-char (point-min))
	    (while (re-search-forward "\\\\[ \t]+$" (point-max) t)
	      (replace-match "\\" t t))))))

1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193