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

Gerd Moellmann's avatar
Gerd Moellmann committed
3
;; Copyright (C) 1992, 1994, 1999, 2000 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
;;; Code:

91
(provide 'make-mode)
Eric S. Raymond's avatar
Eric S. Raymond committed
92

93 94
;; Sadly we need this for a macro.
(eval-when-compile
Gerd Moellmann's avatar
Gerd Moellmann committed
95 96 97
  (require 'imenu)
  (require 'dabbrev)
  (require 'add-log))
98

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

Richard M. Stallman's avatar
Richard M. Stallman committed
103 104 105 106
(defgroup makefile nil
  "Makefile editing commands for Emacs."
  :group 'tools
  :prefix "makefile-")
Eric S. Raymond's avatar
Eric S. Raymond committed
107

108 109
(defface makefile-space-face
   '((((class color)) (:background  "hotpink"))
Richard M. Stallman's avatar
Richard M. Stallman committed
110
     (t (:reverse-video t)))
111 112 113 114
  "Face to use for highlighting leading spaces in Font-Lock mode."
  :group 'faces
  :group 'makemode)

Richard M. Stallman's avatar
Richard M. Stallman committed
115
(defcustom makefile-browser-buffer-name "*Macros and Targets*"
Gerd Moellmann's avatar
Gerd Moellmann committed
116
  "*Name of the macro- and target browser buffer."
Richard M. Stallman's avatar
Richard M. Stallman committed
117 118 119 120
  :type 'string
  :group 'makefile)

(defcustom makefile-target-colon ":"
Gerd Moellmann's avatar
Gerd Moellmann committed
121
  "*String to append to all target names inserted by `makefile-insert-target'.
Richard M. Stallman's avatar
Richard M. Stallman committed
122 123 124
\":\" or \"::\" are common values."
  :type 'string
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
125

Richard M. Stallman's avatar
Richard M. Stallman committed
126
(defcustom makefile-macro-assign " = "
Gerd Moellmann's avatar
Gerd Moellmann committed
127
  "*String to append to all macro names inserted by `makefile-insert-macro'.
Eric S. Raymond's avatar
Eric S. Raymond committed
128
The normal value should be \" = \", since this is what
Dave Love's avatar
Dave Love committed
129
standard make expects.  However, newer makes such as dmake
Eric S. Raymond's avatar
Eric S. Raymond committed
130
allow a larger variety of different macro assignments, so you
Richard M. Stallman's avatar
Richard M. Stallman committed
131 132 133
might prefer to use \" += \" or \" := \" ."
  :type 'string
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
134

Richard M. Stallman's avatar
Richard M. Stallman committed
135
(defcustom makefile-electric-keys nil
Gerd Moellmann's avatar
Gerd Moellmann committed
136
  "*If non-nil, Makefile mode should install electric keybindings.
Richard M. Stallman's avatar
Richard M. Stallman committed
137 138 139
Default is nil."
  :type 'boolean
  :group 'makefile)
140

Richard M. Stallman's avatar
Richard M. Stallman committed
141
(defcustom makefile-use-curly-braces-for-macros-p nil
Gerd Moellmann's avatar
Gerd Moellmann committed
142
  "*Controls the style of generated macro references.
Richard M. Stallman's avatar
Richard M. Stallman committed
143 144 145 146
Non-nil means macro references should use curly braces, like `${this}'.
nil means use parentheses, like `$(this)'."
  :type 'boolean
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
147

Richard M. Stallman's avatar
Richard M. Stallman committed
148
(defcustom makefile-tab-after-target-colon t
Gerd Moellmann's avatar
Gerd Moellmann committed
149
  "*If non-nil, insert a TAB after a target colon.
150
Otherwise, a space is inserted.
Richard M. Stallman's avatar
Richard M. Stallman committed
151 152 153 154 155
The default is t."
  :type 'boolean
  :group 'makefile)

(defcustom makefile-browser-leftmost-column 10
Gerd Moellmann's avatar
Gerd Moellmann committed
156
  "*Number of blanks to the left of the browser selection mark."
Richard M. Stallman's avatar
Richard M. Stallman committed
157 158 159 160
  :type 'integer
  :group 'makefile)

(defcustom makefile-browser-cursor-column 10
Gerd Moellmann's avatar
Gerd Moellmann committed
161
  "*Column the cursor goes to when it moves up or down in the Makefile browser."
Richard M. Stallman's avatar
Richard M. Stallman committed
162 163 164 165 166 167 168 169 170
  :type 'integer
  :group 'makefile)

(defcustom makefile-backslash-column 48
  "*Column in which `makefile-backslash-region' inserts backslashes."
  :type 'integer
  :group 'makefile)

(defcustom makefile-backslash-align t
Gerd Moellmann's avatar
Gerd Moellmann committed
171
  "*If non-nil, `makefile-backslash-region' will align backslashes."
Richard M. Stallman's avatar
Richard M. Stallman committed
172 173 174 175
  :type 'boolean
  :group 'makefile)

(defcustom makefile-browser-selected-mark "+  "
Gerd Moellmann's avatar
Gerd Moellmann committed
176
  "*String used to mark selected entries in the Makefile browser."
Richard M. Stallman's avatar
Richard M. Stallman committed
177 178 179 180
  :type 'string
  :group 'makefile)

(defcustom makefile-browser-unselected-mark "   "
Gerd Moellmann's avatar
Gerd Moellmann committed
181
  "*String used to mark unselected entries in the Makefile browser."
Richard M. Stallman's avatar
Richard M. Stallman committed
182 183 184 185
  :type 'string
  :group 'makefile)

(defcustom makefile-browser-auto-advance-after-selection-p t
Gerd Moellmann's avatar
Gerd Moellmann committed
186
  "*If non-nil, cursor will move after item is selected in Makefile browser."
Richard M. Stallman's avatar
Richard M. Stallman committed
187 188 189 190
  :type 'boolean
  :group 'makefile)

(defcustom makefile-pickup-everything-picks-up-filenames-p nil
Gerd Moellmann's avatar
Gerd Moellmann committed
191
  "*If non-nil, `makefile-pickup-everything' picks up filenames as targets.
192
This means it calls `makefile-pickup-filenames-as-targets'.
Richard M. Stallman's avatar
Richard M. Stallman committed
193 194 195
Otherwise filenames are omitted."
  :type 'boolean
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
196

Richard M. Stallman's avatar
Richard M. Stallman committed
197
(defcustom makefile-cleanup-continuations-p t
Gerd Moellmann's avatar
Gerd Moellmann committed
198
  "*If non-nil, automatically clean up continuation lines when saving.
199 200
A line is cleaned up by removing all whitespace following a trailing
backslash.  This is done silently.
Dave Love's avatar
Dave Love committed
201
IMPORTANT: Please note that enabling this option causes Makefile mode
Richard M. Stallman's avatar
Richard M. Stallman committed
202 203 204
to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \"it seems necessary\"."
  :type 'boolean
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
205

Dave Love's avatar
Dave Love committed
206
(defcustom makefile-mode-hook nil
Gerd Moellmann's avatar
Gerd Moellmann committed
207
  "*Normal hook run by `makefile-mode'."
Dave Love's avatar
Dave Love committed
208 209 210
  :type 'hook
  :group 'makefile)

211
(defvar makefile-browser-hook '())
Eric S. Raymond's avatar
Eric S. Raymond committed
212 213 214 215

;;
;; Special targets for DMake, Sun's make ...
;; 
Richard M. Stallman's avatar
Richard M. Stallman committed
216
(defcustom makefile-special-targets-list
Eric S. Raymond's avatar
Eric S. Raymond committed
217 218 219 220 221 222 223 224
  '(("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"))
Gerd Moellmann's avatar
Gerd Moellmann committed
225
  "*List of special targets.
226
You will be offered to complete on one of those in the minibuffer whenever
Gerd Moellmann's avatar
Gerd Moellmann committed
227
you enter a \".\" at the beginning of a line in `makefile-mode'."
Richard M. Stallman's avatar
Richard M. Stallman committed
228 229
  :type '(repeat (list string))
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
230

Richard M. Stallman's avatar
Richard M. Stallman committed
231
(defcustom makefile-runtime-macros-list
232
  '(("@") ("&") (">") ("<") ("*") ("^") ("+") ("?") ("%") ("$"))
Gerd Moellmann's avatar
Gerd Moellmann committed
233
  "*List of macros that are resolved by make at runtime.
Dave Love's avatar
Dave Love committed
234 235
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
Richard M. Stallman's avatar
Richard M. Stallman committed
236 237 238
not be enclosed in { } or ( )."
  :type '(repeat (list string))
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
239

240
;; Note that the first big subexpression is used by font lock.  Note
Richard M. Stallman's avatar
Richard M. Stallman committed
241 242
;; that if you change this regexp you might have to fix the imenu
;; index in makefile-imenu-generic-expression.
Eric S. Raymond's avatar
Eric S. Raymond committed
243
(defconst makefile-dependency-regex
244
  "^ *\\([^ \n\t#:=]+\\([ \t]+\\([^ \t\n#:=]+\\|\\$[({][^ \t\n#})]+[})]\\)\\)*\\)[ \t]*:\\([ \t]*$\\|\\([^=\n].*$\\)\\)"
Eric S. Raymond's avatar
Eric S. Raymond committed
245 246
  "Regex used to find dependency lines in a makefile.")

Dave Love's avatar
Dave Love committed
247
;; Note that the first subexpression is used by font lock.  Note
Richard M. Stallman's avatar
Richard M. Stallman committed
248 249
;; that if you change this regexp you might have to fix the imenu
;; index in makefile-imenu-generic-expression.
Eric S. Raymond's avatar
Eric S. Raymond committed
250
(defconst makefile-macroassign-regex
251
  "^ *\\([^ \n\t][^:#= \t\n]*\\)[ \t]*[*:+]?:?="
Eric S. Raymond's avatar
Eric S. Raymond committed
252 253 254
  "Regex used to find macro assignment lines in a makefile.")

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

258 259
(if (fboundp 'facemenu-unlisted-faces)
    (add-to-list 'facemenu-unlisted-faces 'makefile-space-face))
260 261
(defvar makefile-space-face 'makefile-space-face
  "Face to use for highlighting leading spaces in Font-Lock mode.")
262

263 264
(defconst makefile-font-lock-keywords
  (list
Gerd Moellmann's avatar
Gerd Moellmann committed
265

266
   ;; Do macro assignments.  These get the "variable-name" face rather
267
   ;; arbitrarily.
268
   (list makefile-macroassign-regex 1 'font-lock-variable-name-face)
Gerd Moellmann's avatar
Gerd Moellmann committed
269

270 271
   ;; Do dependencies.  These get the function name face.
   (list makefile-dependency-regex 1 'font-lock-function-name-face)
Gerd Moellmann's avatar
Gerd Moellmann committed
272

273
   ;; Variable references even in targets/strings/comments:
274
   '("\\$[({]\\([-a-zA-Z0-9_.]+\\)[}):]" 1 font-lock-constant-face prepend)
Gerd Moellmann's avatar
Gerd Moellmann committed
275

276 277
   ;; Automatic variable references.
   '("\\$\\([@%<?^+*]\\)" 1 font-lock-reference-face prepend)
Gerd Moellmann's avatar
Gerd Moellmann committed
278 279 280 281 282 283 284 285 286 287

   ;; Fontify conditionals and includes.
   ;; Note that plain `if' is an automake conditional, and not a bug.
   '("^[ \t]*\\(-?include\\|if\\(n?eq\\|n?def\\)?\\)[ \t]+\\([^: \t\n#]+\\)"
     (1 font-lock-warning-face) (3 font-lock-variable-name-face))

   ;; Fontify endif and else.
   '("^[ \t]*\\(else\\|endif\\)[ \t]*\\(#.*$\\)?"
     (1 font-lock-warning-face))

288 289 290 291 292 293 294 295 296
   ;; Fontify conditionals and includes.
   ;; Note that plain `if' is an automake conditional, and not a bug.
   '("^[ \t]*\\(-?include\\|if\\(n?eq\\|n?def\\)?\\)[ \t]+\\([^: \t\n#]+\\)"
     (1 font-lock-reference-face) (3 font-lock-variable-name-face))

   ;; Fontify endif and else.
   '("^[ \t]*\\(else\\|endif\\)[ \t]*\\(#.*$\\)?"
     (1 font-lock-reference-face))

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

301 302
   ;; Highlight shell comments that Make treats as commands,
   ;; since these can fool people.
303
   '("^\t+#" 0 makefile-space-face t)
304 305 306 307

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

309 310 311 312
(defvar makefile-imenu-generic-expression
  (list
   (list "Dependencies" makefile-dependency-regex  1)
   (list "Macro Assignment" makefile-macroassign-regex 1))
Dave Love's avatar
Dave Love committed
313
  "Imenu generic expression for Makefile mode.  See `imenu-generic-expression'.")
314

Eric S. Raymond's avatar
Eric S. Raymond committed
315 316 317
;;; ------------------------------------------------------------
;;; The following configurable variables are used in the
;;; up-to-date overview .
318
;;; The standard configuration assumes that your `make' program
Eric S. Raymond's avatar
Eric S. Raymond committed
319 320 321 322 323 324 325 326
;;; 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
327 328
;;; 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
329 330
;;; Set the variable `makefile-brave-make' to the name of the
;;; make utility that does this on your system.
331
;;; To understand what this is all about see the function definition
Eric S. Raymond's avatar
Eric S. Raymond committed
332 333 334
;;; of `makefile-query-by-make-minus-q' .
;;; ------------------------------------------------------------

Richard M. Stallman's avatar
Richard M. Stallman committed
335
(defcustom makefile-brave-make "make"
Gerd Moellmann's avatar
Gerd Moellmann committed
336
  "*How to invoke make, for `makefile-query-targets'.
Richard M. Stallman's avatar
Richard M. Stallman committed
337 338 339
This should identify a `make' command that can handle the `-q' option."
  :type 'string
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
340

Richard M. Stallman's avatar
Richard M. Stallman committed
341
(defcustom makefile-query-one-target-method 'makefile-query-by-make-minus-q
Gerd Moellmann's avatar
Gerd Moellmann committed
342
  "*Function to call to determine whether a make target is up to date.
Richard M. Stallman's avatar
Richard M. Stallman committed
343
The function must satisfy this calling convention:
Eric S. Raymond's avatar
Eric S. Raymond committed
344 345 346 347 348

* 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
Dave Love's avatar
Dave Love committed
349
  as a string.  Depending on what you're going to do you may
Eric S. Raymond's avatar
Eric S. Raymond committed
350 351 352 353
  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
Richard M. Stallman's avatar
Richard M. Stallman committed
354 355 356 357 358
  makefile, any nonzero integer value otherwise."
  :type 'function
  :group 'makefile)

(defcustom makefile-up-to-date-buffer-name "*Makefile Up-to-date overview*"
Gerd Moellmann's avatar
Gerd Moellmann committed
359
  "*Name of the Up-to-date overview buffer."
Richard M. Stallman's avatar
Richard M. Stallman committed
360 361
  :type 'string
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
362 363 364

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

365 366 367 368 369 370
(defvar makefile-mode-abbrev-table nil
  "Abbrev table in use in Makefile buffers.")
(if makefile-mode-abbrev-table
    ()
  (define-abbrev-table 'makefile-mode-abbrev-table ()))

Gerd Moellmann's avatar
Gerd Moellmann committed
371 372 373 374 375 376
(defvar makefile-mode-abbrev-table nil
  "Abbrev table in use in Makefile buffers.")
(if makefile-mode-abbrev-table
    ()
  (define-abbrev-table 'makefile-mode-abbrev-table ()))

Eric S. Raymond's avatar
Eric S. Raymond committed
377
(defvar makefile-mode-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
378 379
  "The keymap that is used in Makefile mode.")

Eric S. Raymond's avatar
Eric S. Raymond committed
380 381 382 383
(if makefile-mode-map
    ()
  (setq makefile-mode-map (make-sparse-keymap))
  ;; set up the keymap
384 385 386 387 388 389 390
  (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
391 392
  (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)
393
  (define-key makefile-mode-map "\C-c\C-c" 'comment-region)
Eric S. Raymond's avatar
Eric S. Raymond committed
394 395 396
  (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)
397
  (define-key makefile-mode-map "\C-c\C-\\" 'makefile-backslash-region)
Eric S. Raymond's avatar
Eric S. Raymond committed
398
  (define-key makefile-mode-map "\M-p"     'makefile-previous-dependency)
399 400 401 402 403 404 405 406
  (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
407
    '("Pop up Makefile Browser" . makefile-switch-to-browser))
408
  (define-key makefile-mode-map [menu-bar makefile-mode complete]
Karl Heuer's avatar
Karl Heuer committed
409
    '("Complete Target or Macro" . makefile-complete))
410
  (define-key makefile-mode-map [menu-bar makefile-mode pickup]
Karl Heuer's avatar
Karl Heuer committed
411
    '("Find Targets and Macros" . makefile-pickup-everything))
412 413

  (define-key makefile-mode-map [menu-bar makefile-mode prev]
Karl Heuer's avatar
Karl Heuer committed
414
    '("Move to Previous Dependency" . makefile-previous-dependency))
415
  (define-key makefile-mode-map [menu-bar makefile-mode next]
Karl Heuer's avatar
Karl Heuer committed
416
    '("Move to Next Dependency" . makefile-next-dependency)))
Eric S. Raymond's avatar
Eric S. Raymond committed
417 418 419 420 421 422 423

(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)
Dave Love's avatar
Dave Love committed
424
  (define-key makefile-browser-map "\C-n" 'makefile-browser-next-line)
Eric S. Raymond's avatar
Eric S. Raymond committed
425 426 427 428
  (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)
Dave Love's avatar
Dave Love committed
429
  (define-key makefile-browser-map "I"    'makefile-browser-insert-selection-and-quit)
Eric S. Raymond's avatar
Eric S. Raymond committed
430 431 432 433
  (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)
Dave Love's avatar
Dave Love committed
434
  (define-key makefile-browser-map "\C-f" 'undefined))
Eric S. Raymond's avatar
Eric S. Raymond committed
435 436


437
(defvar makefile-mode-syntax-table nil)
Eric S. Raymond's avatar
Eric S. Raymond committed
438 439 440 441 442 443
(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)
444
  (modify-syntax-entry ?\] ")[    " makefile-mode-syntax-table)
Dave Love's avatar
Dave Love committed
445
  (modify-syntax-entry ?\{ "(}    " makefile-mode-syntax-table)
Eric S. Raymond's avatar
Eric S. Raymond committed
446
  (modify-syntax-entry ?\} "){    " makefile-mode-syntax-table)
447 448
  (modify-syntax-entry ?\' "\"     " makefile-mode-syntax-table)
  (modify-syntax-entry ?\` "\"     " makefile-mode-syntax-table)
Eric S. Raymond's avatar
Eric S. Raymond committed
449 450
  (modify-syntax-entry ?#  "<     " makefile-mode-syntax-table)
  (modify-syntax-entry ?\n ">     " makefile-mode-syntax-table))
451 452


Eric S. Raymond's avatar
Eric S. Raymond committed
453 454 455 456 457 458
;;; ------------------------------------------------------------
;;; Internal variables.
;;; You don't need to configure below this line.
;;; ------------------------------------------------------------

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

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

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

(defvar makefile-browser-selection-vector nil)
468 469 470
(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
471 472 473

(defvar makefile-mode-hook '())

474 475
;; 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
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
(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")
491
    ("addprefix" "Prefix" "Names")
Eric S. Raymond's avatar
Eric S. Raymond committed
492 493 494 495 496 497 498 499 500
    ("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")
501
    ("shell" "Command")))
Eric S. Raymond's avatar
Eric S. Raymond committed
502 503 504 505 506 507


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

508
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
509 510
(defun makefile-mode ()
  "Major mode for editing Makefiles.
Richard M. Stallman's avatar
Richard M. Stallman committed
511
This function ends by invoking the function(s) `makefile-mode-hook'.
Eric S. Raymond's avatar
Eric S. Raymond committed
512 513 514 515 516 517 518

\\{makefile-mode-map}

In the browser, use the following keys:

\\{makefile-browser-map}

Richard M. Stallman's avatar
Richard M. Stallman committed
519
Makefile mode can be configured by modifying the following variables:
Eric S. Raymond's avatar
Eric S. Raymond committed
520 521 522 523 524 525

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
526
    inserted by `makefile-insert-target'.
Eric S. Raymond's avatar
Eric S. Raymond committed
527 528 529 530
    \":\" 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
531
   inserted by `makefile-insert-macro'.
Eric S. Raymond's avatar
Eric S. Raymond committed
532
   The normal value should be \" = \", since this is what
Dave Love's avatar
Dave Love committed
533
   standard make expects.  However, newer makes such as dmake
Eric S. Raymond's avatar
Eric S. Raymond committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
   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
561
   `makefile-pickup-everything' also picks up filenames as targets
562
   (i.e. it calls `makefile-pickup-filenames-as-targets'), otherwise
Eric S. Raymond's avatar
Eric S. Raymond committed
563 564 565
   filenames are omitted.

makefile-cleanup-continuations-p:
Dave Love's avatar
Dave Love committed
566
   If this variable is set to a non-nil value then Makefile mode
Eric S. Raymond's avatar
Eric S. Raymond committed
567 568 569 570
   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.
Dave Love's avatar
Dave Love committed
571
   IMPORTANT: Please note that enabling this option causes Makefile mode
Richard M. Stallman's avatar
Richard M. Stallman committed
572
   to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \"it seems necessary\".
Eric S. Raymond's avatar
Eric S. Raymond committed
573 574 575

makefile-browser-hook:
   A function or list of functions to be called just before the
576
   browser is entered. This is executed in the makefile buffer.
Eric S. Raymond's avatar
Eric S. Raymond committed
577 578 579

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

Eric S. Raymond's avatar
Eric S. Raymond committed
583 584
  (interactive)
  (kill-all-local-variables)
585
  (make-local-variable 'local-write-file-hooks)
586
  (setq local-write-file-hooks
587
	'(makefile-cleanup-continuations makefile-warn-suspicious-lines))
588 589 590 591 592
  (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)
593 594

  ;; Font lock.
595 596
  (make-local-variable 'font-lock-defaults)
  (setq font-lock-defaults '(makefile-font-lock-keywords))
597 598 599 600 601 602

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

  ;; Imenu.
603 604
  (make-local-variable 'imenu-generic-expression)
  (setq imenu-generic-expression makefile-imenu-generic-expression)
605

606 607 608 609
  ;; Dabbrev.
  (make-local-variable 'dabbrev-abbrev-skip-leading-regexp)
  (setq dabbrev-abbrev-skip-leading-regexp "\\$")

Gerd Moellmann's avatar
Gerd Moellmann committed
610 611 612
  ;; Other abbrevs.
  (setq local-abbrev-table makefile-mode-abbrev-table)

613 614 615
  ;; Other abbrevs.
  (setq local-abbrev-table makefile-mode-abbrev-table)

616 617 618 619
  ;; Filling.
  (make-local-variable 'fill-paragraph-function)
  (setq fill-paragraph-function 'makefile-fill-paragraph)

620
  ;; Comment stuff.
621
  (make-local-variable 'comment-start)
Eric S. Raymond's avatar
Eric S. Raymond committed
622
  (setq comment-start "#")
623
  (make-local-variable 'comment-end)
Eric S. Raymond's avatar
Eric S. Raymond committed
624
  (setq comment-end "")
625 626 627
  (make-local-variable 'comment-start-skip)
  (setq comment-start-skip "#+[ \t]*")

Eric S. Raymond's avatar
Eric S. Raymond committed
628 629
  ;; become the current major mode
  (setq major-mode 'makefile-mode)
630 631 632
  (setq mode-name "Makefile")

  ;; Activate keymap and syntax table.
Eric S. Raymond's avatar
Eric S. Raymond committed
633 634
  (use-local-map makefile-mode-map)
  (set-syntax-table makefile-mode-syntax-table)
635 636 637 638 639 640 641 642

  ;; 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
643 644

(defun makefile-next-dependency ()
Richard M. Stallman's avatar
Richard M. Stallman committed
645
  "Move point to the beginning of the next dependency line."
Eric S. Raymond's avatar
Eric S. Raymond committed
646 647 648 649 650 651
  (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)))
652

Eric S. Raymond's avatar
Eric S. Raymond committed
653
(defun makefile-previous-dependency ()
Richard M. Stallman's avatar
Richard M. Stallman committed
654
  "Move point to the beginning of the previous dependency line."
Eric S. Raymond's avatar
Eric S. Raymond committed
655 656 657 658 659 660 661
  (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)))

662

Eric S. Raymond's avatar
Eric S. Raymond committed
663

664
;;; Electric keys.  Blech.
665

666 667 668 669 670
(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
671 672
  (if (bolp)
      (makefile-insert-special-target)
673
    (self-insert-command arg)))
Eric S. Raymond's avatar
Eric S. Raymond committed
674 675

(defun makefile-insert-special-target ()
Karl Heuer's avatar
Karl Heuer committed
676
  "Prompt for and insert a special target name.
677
Uses `makefile-special-targets' list."
Eric S. Raymond's avatar
Eric S. Raymond committed
678
  (interactive)
679
  (makefile-pickup-targets)
680 681 682
  (let ((special-target
	 (completing-read "Special target: "
			  makefile-special-targets-list nil nil nil)))
Eric S. Raymond's avatar
Eric S. Raymond committed
683 684
    (if (zerop (length special-target))
	()
685
      (insert "." special-target ":")
Eric S. Raymond's avatar
Eric S. Raymond committed
686 687
      (makefile-forward-after-target-colon))))

688 689 690 691 692
(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")
693
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
694 695
  (if (bolp)
      (call-interactively 'makefile-insert-macro)
696
    (self-insert-command arg)))
Eric S. Raymond's avatar
Eric S. Raymond committed
697 698 699 700

(defun makefile-insert-macro (macro-name)
  "Prepare definition of a new macro."
  (interactive "sMacro Name: ")
701
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
702 703 704
  (if (not (zerop (length macro-name)))
      (progn
	(beginning-of-line)
705
	(insert macro-name makefile-macro-assign)
706
	(setq makefile-need-macro-pickup t)
Eric S. Raymond's avatar
Eric S. Raymond committed
707 708 709
	(makefile-remember-macro macro-name))))

(defun makefile-insert-macro-ref (macro-name)
Richard M. Stallman's avatar
Richard M. Stallman committed
710
  "Complete on a list of known macros, then insert complete ref at point."
Eric S. Raymond's avatar
Eric S. Raymond committed
711 712
  (interactive
   (list
713 714 715
    (progn
      (makefile-pickup-macros)
      (completing-read "Refer to macro: " makefile-macro-table nil nil nil))))
716
  (makefile-do-macro-insertion macro-name))
Eric S. Raymond's avatar
Eric S. Raymond committed
717 718 719 720 721 722 723

(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)
724
	(insert target-name makefile-target-colon)
Eric S. Raymond's avatar
Eric S. Raymond committed
725 726
	(makefile-forward-after-target-colon)
	(end-of-line)
727
	(setq makefile-need-target-pickup t)
Eric S. Raymond's avatar
Eric S. Raymond committed
728 729 730
	(makefile-remember-target target-name))))

(defun makefile-insert-target-ref (target-name)
Dave Love's avatar
Dave Love committed
731
  "Complete on a list of known targets, then insert TARGET-NAME at point."
Eric S. Raymond's avatar
Eric S. Raymond committed
732 733
  (interactive
   (list
734
    (progn
735 736
     (makefile-pickup-targets)
     (completing-read "Refer to target: " makefile-target-table nil nil nil))))
Eric S. Raymond's avatar
Eric S. Raymond committed
737
   (if (not (zerop (length target-name)))
738
       (insert target-name " ")))
Eric S. Raymond's avatar
Eric S. Raymond committed
739

740 741 742 743 744
(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
745 746
  (if (bolp)
      (call-interactively 'makefile-insert-target)
747 748 749
    (self-insert-command arg)))


Eric S. Raymond's avatar
Eric S. Raymond committed
750 751 752 753 754 755

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

(defun makefile-pickup-targets ()
756
  "Notice names of all target definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
757
  (interactive)
758 759 760 761 762 763 764 765 766 767
  (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
768 769 770 771

(defun makefile-add-this-line-targets ()
  (save-excursion
    (beginning-of-line)
772 773
    (let ((done-with-line nil)
	  (line-number (1+ (count-lines (point-min) (point)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
774 775 776 777 778 779 780 781 782
      (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:#")
783 784 785 786 787 788
			(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
789 790

(defun makefile-pickup-macros ()
791
  "Notice names of all macro definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
792
  (interactive)
793 794 795 796 797 798 799 800 801 802
  (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
803 804 805 806 807 808 809

(defun makefile-add-this-line-macro ()
  (save-excursion
    (beginning-of-line)
    (skip-chars-forward " \t")
    (if (not (eolp))
	(let* ((start-of-macro-name (point))
810
	       (line-number (1+ (count-lines (point-min) (point))))
Eric S. Raymond's avatar
Eric S. Raymond committed
811 812 813 814
	       (macro-name (progn
			     (skip-chars-forward "^ \t:#=*")
			     (buffer-substring start-of-macro-name (point)))))
	  (if (makefile-remember-macro macro-name)
815 816
	      (message "Picked up macro \"%s\" from line %d"
		       macro-name line-number))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
817

818
(defun makefile-pickup-everything (arg)
819
  "Notice names of all macros and targets in Makefile.
820 821 822 823 824 825
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
826 827 828 829 830 831
  (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 ()
832 833 834
  "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
835 836 837 838 839 840 841 842 843 844 845 846 847
  (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)))

848 849 850 851 852 853 854 855 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


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



945 946
;; Backslashification.  Stolen from cc-mode.el.

947 948 949 950 951
(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.

Dave Love's avatar
Dave Love committed
952
This function does not modify the last line of the region if the region ends
953 954 955
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."
956 957
  (interactive "r\nP")
  (save-excursion
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
    (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.
1071
      (save-restriction
1072 1073 1074 1075