make-mode.el 51 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>
Richard M. Stallman's avatar
Richard M. Stallman committed
7
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
8
;; Adapted-By: ESR
Eric S. Raymond's avatar
Eric S. Raymond committed
9
;; Keywords: unix, tools
Eric S. Raymond's avatar
Eric S. Raymond committed
10

Richard M. Stallman's avatar
Richard M. Stallman committed
11
;; RMS:
12
;; This needs work.
Richard M. Stallman's avatar
Richard M. Stallman committed
13 14 15
;; 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
16 17 18 19
;; 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
20
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
21 22 23 24 25 26 27 28
;; 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
29 30 31
;; 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
32

33 34
;;; Commentary:

35 36 37 38 39 40 41 42 43 44
;; 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.
;;
45
;; The command C-c C-f adds certain filenames in the current directory
46 47 48 49 50 51 52 53
;; 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.
;;
54
;; The command C-c C-b pops up a browser window listing all target and
55 56 57 58 59 60 61
;; 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.
62

63 64 65 66 67 68 69 70 71 72 73 74
;;
;; To Do:
;;
;; * 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).
75
;; * Make browser into a major mode.
76 77 78 79 80 81 82 83 84 85 86 87 88
;; * 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
89 90 91 92
;;; Code:

(provide 'makefile)

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

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

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

(defvar makefile-target-colon ":"
105 106
  "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
107 108

(defvar makefile-macro-assign " = "
109
  "String to append to all macro names inserted by `makefile-insert-macro'.
Eric S. Raymond's avatar
Eric S. Raymond committed
110 111 112 113 114
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 \" := \" .")

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

Eric S. Raymond's avatar
Eric S. Raymond committed
119
(defvar makefile-use-curly-braces-for-macros-p nil
120
  "Controls the style of generated macro references.
121 122 123
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
124 125

(defvar makefile-tab-after-target-colon t
126 127 128
  "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
129 130 131 132 133 134 135 136

(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.")

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

140 141 142
(defvar makefile-backslash-align t
  "If non-nil, `makefile-backslash-region' will align backslashes.")

Eric S. Raymond's avatar
Eric S. Raymond committed
143 144 145 146 147 148 149
(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
150
  "If non-nil, cursor will move after item is selected in browser.")
Eric S. Raymond's avatar
Eric S. Raymond committed
151 152

(defvar makefile-pickup-everything-picks-up-filenames-p nil
153 154 155
  "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
156 157

(defvar makefile-cleanup-continuations-p t
158 159 160 161
  "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
162 163
to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \'it seems necessary\'.")

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

;;
;; 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"))
178 179 180
  "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
181 182

(defvar makefile-runtime-macros-list
183
  '(("@") ("&") (">") ("<") ("*") ("^") ("+") ("?") ("%") ("$"))
Eric S. Raymond's avatar
Eric S. Raymond committed
184 185 186 187 188
  "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 ( ).")

189 190 191
;; 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
192
(defconst makefile-dependency-regex
193
  "^ *\\([^ \n\t#:=]+\\([ \t]+[^ \t\n#:=]+\\)*\\)[ \t]*:\\([ \t]*$\\|\\([^=\n].*$\\)\\)"
Eric S. Raymond's avatar
Eric S. Raymond committed
194 195
  "Regex used to find dependency lines in a makefile.")

196 197 198
;; 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
199
(defconst makefile-macroassign-regex
200
  "^ *\\([^ \n\t][^:#= \t\n]*\\)[ \t]*[*:+]?:?="
Eric S. Raymond's avatar
Eric S. Raymond committed
201 202 203
  "Regex used to find macro assignment lines in a makefile.")

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

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

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

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

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

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

Eric S. Raymond's avatar
Eric S. Raymond committed
236 237 238
;;; ------------------------------------------------------------
;;; The following configurable variables are used in the
;;; up-to-date overview .
239
;;; The standard configuration assumes that your `make' program
Eric S. Raymond's avatar
Eric S. Raymond committed
240 241 242 243 244 245 246 247
;;; 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
248 249
;;; 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
250 251
;;; Set the variable `makefile-brave-make' to the name of the
;;; make utility that does this on your system.
252
;;; To understand what this is all about see the function definition
Eric S. Raymond's avatar
Eric S. Raymond committed
253 254 255
;;; of `makefile-query-by-make-minus-q' .
;;; ------------------------------------------------------------

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

(defvar makefile-query-one-target-method 'makefile-query-by-make-minus-q
Richard M. Stallman's avatar
Richard M. Stallman committed
260 261
  "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
262 263 264 265 266

* 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
267
  as a string. Depending on what you're going to do you may
Eric S. Raymond's avatar
Eric S. Raymond committed
268 269 270 271 272 273 274 275 276 277 278 279
  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
280 281
  "The keymap that is used in Makefile mode.")

Eric S. Raymond's avatar
Eric S. Raymond committed
282 283 284 285
(if makefile-mode-map
    ()
  (setq makefile-mode-map (make-sparse-keymap))
  ;; set up the keymap
286 287 288 289 290 291 292
  (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
293 294
  (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)
295
  (define-key makefile-mode-map "\C-c\C-c" 'comment-region)
Eric S. Raymond's avatar
Eric S. Raymond committed
296 297 298
  (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)
299
  (define-key makefile-mode-map "\C-c\C-\\" 'makefile-backslash-region)
Eric S. Raymond's avatar
Eric S. Raymond committed
300
  (define-key makefile-mode-map "\M-p"     'makefile-previous-dependency)
301 302 303 304 305 306 307 308
  (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
309
    '("Pop up Makefile Browser" . makefile-switch-to-browser))
310
  (define-key makefile-mode-map [menu-bar makefile-mode complete]
Karl Heuer's avatar
Karl Heuer committed
311
    '("Complete Target or Macro" . makefile-complete))
312
  (define-key makefile-mode-map [menu-bar makefile-mode pickup]
Karl Heuer's avatar
Karl Heuer committed
313
    '("Find Targets and Macros" . makefile-pickup-everything))
314 315

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

(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))  


339
(defvar makefile-mode-syntax-table nil)
Eric S. Raymond's avatar
Eric S. Raymond committed
340 341 342 343 344 345
(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)
346
  (modify-syntax-entry ?\] ")[    " makefile-mode-syntax-table)
Eric S. Raymond's avatar
Eric S. Raymond committed
347 348
  (modify-syntax-entry ?\{ "(}    " makefile-mode-syntax-table)  
  (modify-syntax-entry ?\} "){    " makefile-mode-syntax-table)
349 350
  (modify-syntax-entry ?\' "\"     " makefile-mode-syntax-table)
  (modify-syntax-entry ?\` "\"     " makefile-mode-syntax-table)
Eric S. Raymond's avatar
Eric S. Raymond committed
351 352
  (modify-syntax-entry ?#  "<     " makefile-mode-syntax-table)
  (modify-syntax-entry ?\n ">     " makefile-mode-syntax-table))
353 354


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

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

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

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

(defvar makefile-browser-selection-vector nil)
370 371 372
(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
373 374 375

(defvar makefile-mode-hook '())

376 377
;; 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
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
(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")
393
    ("addprefix" "Prefix" "Names")
Eric S. Raymond's avatar
Eric S. Raymond committed
394 395 396 397 398 399 400 401 402
    ("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")
403
    ("shell" "Command")))
Eric S. Raymond's avatar
Eric S. Raymond committed
404 405 406 407 408 409


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

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

\\{makefile-mode-map}

In the browser, use the following keys:

\\{makefile-browser-map}

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

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
428
    inserted by `makefile-insert-target'.
Eric S. Raymond's avatar
Eric S. Raymond committed
429 430 431 432
    \":\" 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
433
   inserted by `makefile-insert-macro'.
Eric S. Raymond's avatar
Eric S. Raymond committed
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 460 461 462
   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
463 464
   `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
465 466 467 468 469 470 471 472 473
   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
474
   to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \"it seems necessary\".
Eric S. Raymond's avatar
Eric S. Raymond committed
475 476 477

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

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

Eric S. Raymond's avatar
Eric S. Raymond committed
485 486
  (interactive)
  (kill-all-local-variables)
487
  (make-local-variable 'local-write-file-hooks)
488
  (setq local-write-file-hooks
489
	'(makefile-cleanup-continuations makefile-warn-suspicious-lines))
490 491 492 493 494
  (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)
495 496

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

  ;; 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)

510 511 512 513
  ;; Dabbrev.
  (make-local-variable 'dabbrev-abbrev-skip-leading-regexp)
  (setq dabbrev-abbrev-skip-leading-regexp "\\$")

514 515 516 517
  ;; Filling.
  (make-local-variable 'fill-paragraph-function)
  (setq fill-paragraph-function 'makefile-fill-paragraph)

518
  ;; Comment stuff.
519
  (make-local-variable 'comment-start)
Eric S. Raymond's avatar
Eric S. Raymond committed
520
  (setq comment-start "#")
521
  (make-local-variable 'comment-end)
Eric S. Raymond's avatar
Eric S. Raymond committed
522
  (setq comment-end "")
523 524 525
  (make-local-variable 'comment-start-skip)
  (setq comment-start-skip "#+[ \t]*")

Eric S. Raymond's avatar
Eric S. Raymond committed
526 527
  ;; become the current major mode
  (setq major-mode 'makefile-mode)
528 529 530
  (setq mode-name "Makefile")

  ;; Activate keymap and syntax table.
Eric S. Raymond's avatar
Eric S. Raymond committed
531 532
  (use-local-map makefile-mode-map)
  (set-syntax-table makefile-mode-syntax-table)
533 534 535 536 537 538 539 540

  ;; 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
541 542

(defun makefile-next-dependency ()
Richard M. Stallman's avatar
Richard M. Stallman committed
543
  "Move point to the beginning of the next dependency line."
Eric S. Raymond's avatar
Eric S. Raymond committed
544 545 546 547 548 549
  (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)))
550

Eric S. Raymond's avatar
Eric S. Raymond committed
551
(defun makefile-previous-dependency ()
Richard M. Stallman's avatar
Richard M. Stallman committed
552
  "Move point to the beginning of the previous dependency line."
Eric S. Raymond's avatar
Eric S. Raymond committed
553 554 555 556 557 558 559
  (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)))

560

Eric S. Raymond's avatar
Eric S. Raymond committed
561

562
;;; Electric keys.  Blech.
563

564 565 566 567 568
(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
569 570
  (if (bolp)
      (makefile-insert-special-target)
571
    (self-insert-command arg)))
Eric S. Raymond's avatar
Eric S. Raymond committed
572 573

(defun makefile-insert-special-target ()
Karl Heuer's avatar
Karl Heuer committed
574
  "Prompt for and insert a special target name.
575
Uses `makefile-special-targets' list."
Eric S. Raymond's avatar
Eric S. Raymond committed
576
  (interactive)
577
  (makefile-pickup-targets)
578 579 580
  (let ((special-target
	 (completing-read "Special target: "
			  makefile-special-targets-list nil nil nil)))
Eric S. Raymond's avatar
Eric S. Raymond committed
581 582
    (if (zerop (length special-target))
	()
583
      (insert "." special-target ":")
Eric S. Raymond's avatar
Eric S. Raymond committed
584 585
      (makefile-forward-after-target-colon))))

586 587 588 589 590
(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")
591
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
592 593
  (if (bolp)
      (call-interactively 'makefile-insert-macro)
594
    (self-insert-command arg)))
Eric S. Raymond's avatar
Eric S. Raymond committed
595 596 597 598

(defun makefile-insert-macro (macro-name)
  "Prepare definition of a new macro."
  (interactive "sMacro Name: ")
599
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
600 601 602
  (if (not (zerop (length macro-name)))
      (progn
	(beginning-of-line)
603
	(insert macro-name makefile-macro-assign)
604
	(setq makefile-need-macro-pickup t)
Eric S. Raymond's avatar
Eric S. Raymond committed
605 606 607
	(makefile-remember-macro macro-name))))

(defun makefile-insert-macro-ref (macro-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
608
  "Complete on a list of known macros, then insert complete ref at point."
Eric S. Raymond's avatar
Eric S. Raymond committed
609 610
  (interactive
   (list
611 612 613
    (progn
      (makefile-pickup-macros)
      (completing-read "Refer to macro: " makefile-macro-table nil nil nil))))
614
  (makefile-do-macro-insertion macro-name))
Eric S. Raymond's avatar
Eric S. Raymond committed
615 616 617 618 619 620 621

(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)
622
	(insert target-name makefile-target-colon)
Eric S. Raymond's avatar
Eric S. Raymond committed
623 624
	(makefile-forward-after-target-colon)
	(end-of-line)
625
	(setq makefile-need-target-pickup t)
Eric S. Raymond's avatar
Eric S. Raymond committed
626 627 628
	(makefile-remember-target target-name))))

(defun makefile-insert-target-ref (target-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
629
  "Complete on a list of known targets, then insert target-ref at point."
Eric S. Raymond's avatar
Eric S. Raymond committed
630 631
  (interactive
   (list
632
    (progn
633 634
     (makefile-pickup-targets)
     (completing-read "Refer to target: " makefile-target-table nil nil nil))))
Eric S. Raymond's avatar
Eric S. Raymond committed
635
   (if (not (zerop (length target-name)))
636
       (insert target-name " ")))
Eric S. Raymond's avatar
Eric S. Raymond committed
637

638 639 640 641 642
(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
643 644
  (if (bolp)
      (call-interactively 'makefile-insert-target)
645 646 647
    (self-insert-command arg)))


Eric S. Raymond's avatar
Eric S. Raymond committed
648 649 650 651 652 653

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

(defun makefile-pickup-targets ()
654
  "Notice names of all target definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
655
  (interactive)
656 657 658 659 660 661 662 663 664 665
  (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
666 667 668 669

(defun makefile-add-this-line-targets ()
  (save-excursion
    (beginning-of-line)
670 671
    (let ((done-with-line nil)
	  (line-number (1+ (count-lines (point-min) (point)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
672 673 674 675 676 677 678 679 680
      (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:#")
681 682 683 684 685 686
			(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
687 688

(defun makefile-pickup-macros ()
689
  "Notice names of all macro definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
690
  (interactive)
691 692 693 694 695 696 697 698 699 700
  (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
701 702 703 704 705 706 707

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

716
(defun makefile-pickup-everything (arg)
717
  "Notice names of all macros and targets in Makefile.
718 719 720 721 722 723
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
724 725 726 727 728 729
  (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 ()
730 731 732
  "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
733 734 735 736 737 738 739 740 741 742 743 744 745
  (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)))

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 836 837 838 839 840 841 842


;;; 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"))))))



843 844
;; Backslashification.  Stolen from cc-mode.el.

845 846 847 848 849 850 851 852 853
(defun makefile-backslash-region (from to delete-flag)
  "Insert, align, or delete end-of-line backslashes on the lines in the region.
With no argument, inserts backslashes and aligns existing backslashes.
With an argument, deletes the backslashes.

This function does not modify the last line of the region if the region ends 
right at the start of the following line; it does not modify blank lines
at the start of the region.  So you can put the region around an entire macro
definition and conveniently use this command."
854 855
  (interactive "r\nP")
  (save-excursion
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 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 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
    (goto-char from)
    (let ((column makefile-backslash-column)
          (endmark (make-marker)))
      (move-marker endmark to)
      ;; Compute the smallest column number past the ends of all the lines.
      (if makefile-backslash-align
	  (progn
	    (if (not delete-flag)
		(while (< (point) to)
		  (end-of-line)
		  (if (= (preceding-char) ?\\)
		      (progn (forward-char -1)
			     (skip-chars-backward " \t")))
		  (setq column (max column (1+ (current-column))))
		  (forward-line 1)))
	    ;; Adjust upward to a tab column, if that doesn't push
	    ;; past the margin.
	    (if (> (% column tab-width) 0)
		(let ((adjusted (* (/ (+ column tab-width -1) tab-width)
				   tab-width)))
		  (if (< adjusted (window-width))
		      (setq column adjusted))))))
      ;; Don't modify blank lines at start of region.
      (goto-char from)
      (while (and (< (point) endmark) (eolp))
        (forward-line 1))
      ;; Add or remove backslashes on all the lines.
      (while (and (< (point) endmark)
                  ;; Don't backslashify the last line
                  ;; if the region ends right at the start of the next line.
                  (save-excursion
                    (forward-line 1)
                    (< (point) endmark)))
        (if (not delete-flag)
            (makefile-append-backslash column)
          (makefile-delete-backslash))
        (forward-line 1))
      (move-marker endmark nil))))

(defun makefile-append-backslash (column)
  (end-of-line)
  ;; Note that "\\\\" is needed to get one backslash.
  (if (= (preceding-char) ?\\)
      (progn (forward-char -1)
             (delete-horizontal-space)
             (indent-to column (if makefile-backslash-align nil 1)))
    (indent-to column (if makefile-backslash-align nil 1))
    (insert "\\")))

(defun makefile-delete-backslash ()
  (end-of-line)
  (or (bolp)
      (progn
 	(forward-char -1)
 	(if (looking-at "\\\\")
 	    (delete-region (1+ (point))
 			   (progn (skip-chars-backward " \t") (point)))))))



;; Filling

(defun makefile-fill-paragraph (arg)
  ;; Fill comments, backslashed lines, and variable definitions
  ;; specially.
  (save-excursion
    (beginning-of-line)
    (cond
     ((looking-at "^#+ ")
      ;; Found a comment.  Set the fill prefix and then fill.
      (let ((fill-prefix (buffer-substring-no-properties (match-beginning 0)
							 (match-end 0)))
	    (fill-paragraph-function nil))
	(fill-paragraph nil)
	t))

     ;; Must look for backslashed-region before looking for variable
     ;; assignment.
     ((save-excursion
	(end-of-line)
	(or
	 (= (preceding-char) ?\\)
	 (progn
	   (end-of-line -1)
	   (= (preceding-char) ?\\))))
      ;; A backslash region.  Find beginning and end, remove
      ;; backslashes, fill, and then reapply backslahes.
      (end-of-line)
      (let ((beginning
	     (save-excursion
	       (end-of-line 0)
	       (while (= (preceding-char) ?\\)
		 (end-of-line 0))
	       (forward-char)
	       (point)))
	    (end
	     (save-excursion
	       (while (= (preceding-char) ?\\)
		 (end-of-line 2))
	       (point))))
	(save-restriction
	  (narrow-to-region beginning end)
	  (makefile-backslash-region (point-min) (point-max) t)
	  (let ((fill-paragraph-function nil))
	    (fill-paragraph nil))
	  (makefile-backslash-region (point-min) (point-max) nil)
	  (goto-char (point-max))
	  (if (< (skip-chars-backward "\n") 0)
	      (delete-region (point) (point-max))))))

     ((looking-at makefile-macroassign-regex)
      ;; Have a macro assign.  Fill just this line, and then backslash
      ;; resulting region.
969
      (save-restriction
970 971 972 973 974 975 976 977 978 979
	(narrow-to-region (point) (save-excursion
				    (end-of-line)
				    (forward-char)
				    (point)))
	(let ((fill-paragraph-function nil))
	  (fill-paragraph nil))
	(makefile-backslash-region (point-min) (point-max) nil)))))

  ;; Always return non-nil so we don't fill anything else.
  t)
980 981 982



Eric S. Raymond's avatar
Eric S. Raymond committed
983
;;; ------------------------------------------------------------
984
;;; Browser mode.
Eric S. Raymond's avatar
Eric S. Raymond committed
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
;;; ------------------------------------------------------------

(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)
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
  (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
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

;;;
;;; 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 ()
1049
  "Leave the browser and return to the makefile buffer."
Eric S. Raymond's avatar
Eric S. Raymond committed
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
  (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)
1068 1069 1070 1071
    (let ((inhibit-read-only t))
      (beginning-of-line)
      (if (makefile-browser-on-macro-line-p)
	  (let ((macro-name (makefile-browser-this-line-macro-name)))
1072
	    (delete-region (point) (progn (end-of-line) (point)))
1073 1074 1075 1076 1077
	    (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)))
1078
	  (delete-region (point) (progn (end-of-line) (point)))
Eric S. Raymond's avatar
Eric S. Raymond committed
1079
	  (insert
1080 1081 1082
	   (makefile-browser-format-target-line
	      target-name
	      (makefile-browser-get-state-for-line this-line))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
    (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 ()
1093
  "Insert a makefile continuation.
1094
In the makefile buffer, go to (end-of-line), insert a \'\\\'
Eric S. Raymond's avatar
Eric S. Raymond committed
1095
character, insert a new blank line, go to that line and indent by one TAB.
1096 1097
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
1098
\(point) advances accordingly in the client buffer."
Eric S. Raymond's avatar
Eric S. Raymond committed
1099 1100 1101 1102 1103 1104 1105
  (interactive)
  (save-excursion
    (set-buffer makefile-browser-client)
    (end-of-line)
    (insert "\\\n\t")))

(defun makefile-browser-insert-selection ()
1106
  "Insert all selected targets and/or macros in the makefile buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
1107
Insertion takes place at point."
Eric S. Raymond's avatar
Eric S. Raymond committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
  (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)
1148
	(shrink-window-if-larger-than-buffer)
Eric S. Raymond's avatar
Eric S. Raymond committed
1149 1150 1151 1152 1153 1154 1155 1156
	(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))
1157 1158
  (makefile-pickup-targets)
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
1159 1160
  (makefile-browse makefile-target-table makefile-macro-table))

1161

Eric S. Raymond's avatar
Eric S. Raymond committed
1162 1163 1164 1165 1166 1167

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

(defun makefile-create-up-to-date-overview ()
1168
  "Create a buffer containing an overview of the state of all known targets.
Eric S. Raymond's avatar
Eric S. Raymond committed
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
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)
1192 1193 1194
			    makefile-target-table))
	    (prereqs makefile-has-prereqs)
	    )
Eric S. Raymond's avatar
Eric S. Raymond committed
1195 1196 1197 1198

	(set-buffer makefile-up-to-date-buffer)
	(setq buffer-read-only nil)
	(erase-buffer)
1199
	(makefile-query-targets filename real-targets prereqs)
Eric S. Raymond's avatar
Eric S. Raymond committed
1200 1201 1202 1203 1204 1205 1206 1207 1208
	(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))
1209
	      (shrink-window-if-larger-than-buffer)
Eric S. Raymond's avatar
Eric S. Raymond committed
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219
	      (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 ()
1220
  "Create a filename suitable for use in `makefile-save-temporary'.
Eric S. Raymond's avatar
Eric S. Raymond committed
1221
Be careful to allow brain-dead file systems (DOS, SYSV ...) to cope
1222
with the generated name!"
Eric S. Raymond's avatar
Eric S. Raymond committed
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
  (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))))

1234
(defun makefile-query-targets (filename target-table prereq-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
1235
  "Fill the up-to-date overview buffer.
1236
Checks each target in TARGET-TABLE using `makefile-query-one-target-method'
Eric S. Raymond's avatar
Eric S. Raymond committed
1237 1238
and generates the overview, one line per target name."
  (insert
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
   (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
1255 1256 1257 1258
  (goto-char (point-min))
  (delete-file filename))		; remove the tmpfile

(defun makefile-query-by-make-minus-q (target &optional filename)
1259 1260 1261
  (not (zerop
	(call-process makefile-brave-make nil nil nil
		      "-f" filename "-q" target))))
Eric S. Raymond's avatar
Eric S. Raymond committed
1262

1263 1264


Eric S. Raymond's avatar
Eric S. Raymond committed
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
;;; ------------------------------------------------------------
;;; 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))))))

1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298

;;; ------------------------------------------------------------
;;; Warn of suspicious lines
;;; ------------------------------------------------------------

(defun makefile-warn-suspicious-lines ()
  (let ((dont-save nil))
    (if (eq major-mode 'makefile-mode)
	(let ((suspicious
	       (save-excursion
		 (goto-char (point-min))
		 (re-search-forward
		  "\\(^[\t]+$\\)\\|\\(^[ ]+[\t]\\)" (point-max) t))))
	  (if suspicious
	      (let ((line-nr (count-lines (point-min) suspicious)))
		(setq dont-save
		      (not (y-or-n-p
			    (format "Suspicious line %d. Save anyway "
				    line-nr))))))))
    dont-save))
	  
1299

1300

Eric S. Raymond's avatar
Eric S. Raymond committed
1301 1302 1303 1304 1305
;;; ------------------------------------------------------------
;;; GNU make function support
;;; ------------------------------------------------------------

(defun makefile-insert-gmake-function ()
1306 1307 1308
  "Insert a GNU make function call.
Asks for the name of the function to use (with completion).
Then prompts for all required parameters."
Eric S. Raymond's avatar
Eric S. Raymond committed
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
  (interactive)
  (let* ((gm-function-name (completing-read
			     "Function: "
			     makefile-gnumake-functions-alist
			     nil t nil))
	 (gm-function-prompts
	  (cdr (assoc gm-function-name makefile-gnumake-functions-alist))))
    (if (not (zerop (length gm-function-name)))
	(insert (makefile-format-macro-ref
		 (concat gm-function-name " "
			 (makefile-prompt-for-gmake-funargs
			    gm-function-name gm-function-prompts)))
		" "))))

(defun makefile-prompt-for-gmake-funargs (function-name prompt-list)
  (mapconcat
   (function (lambda (one-prompt)
1326 1327
	       (read-string (format "[%s] %s: " function-name one-prompt)
			    nil)))
Eric S. Raymond's avatar
Eric S. Raymond committed
1328 1329
   prompt-list
   ","))
1330

1331

Eric S. Raymond's avatar
Eric S. Raymond committed
1332 1333 1334 1335 1336

;;; ------------------------------------------------------------
;;; Utility functions
;;; ------------------------------------------------------------

1337 1338 1339 1340 1341 1342 1343
(defun makefile-do-macro-insertion (macro-name)
  "Insert a macro reference."
  (if (not (zerop (length macro-name)))
      (if (assoc macro-name makefile-runtime-macros-list)
	  (insert "$" macro-name)
	(insert (makefile-format-macro-ref macro-name)))))

1344
(defun makefile-remember-target (target-name &optional has-prereqs)
Eric S. Raymond's avatar
Eric S. Raymond committed
1345 1346
  "Remember a given target if it is not already remembered for this buffer."
  (if (not (zerop (length target-name)))
1347
      (progn
Eric S. Raymond's avatar
Eric S. Raymond committed
1348 1349
      (if (not (assoc target-name makefile-target-table))
	  (setq makefile-target-table
1350 1351 1352 1353
		(cons (list target-name) makefile-target-table)))
      (if has-prereqs
	  (setq makefile-has-prereqs