make-mode.el 53.2 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,94,99,2000,2001, 2002, 2003  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 11 12 13 14

;; 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
15
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
16 17 18 19 20 21 22 23
;; 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
24 25 26
;; 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
27

28 29
;;; Commentary:

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

58 59 60
;;
;; To Do:
;;
Kim F. Storm's avatar
Kim F. Storm committed
61
;; * Add missing doc strings, improve terse doc strings.
62 63 64 65 66 67 68 69 70
;; * 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).
71
;; * Make browser into a major mode.
72 73 74 75 76 77 78 79 80 81 82 83 84
;; * 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
85 86
;;; Code:

87 88
;; Sadly we need this for a macro.
(eval-when-compile
Gerd Moellmann's avatar
Gerd Moellmann committed
89 90 91
  (require 'imenu)
  (require 'dabbrev)
  (require 'add-log))
92

Eric S. Raymond's avatar
Eric S. Raymond committed
93
;;; ------------------------------------------------------------
94
;;; Configurable stuff
Eric S. Raymond's avatar
Eric S. Raymond committed
95 96
;;; ------------------------------------------------------------

Richard M. Stallman's avatar
Richard M. Stallman committed
97 98 99 100
(defgroup makefile nil
  "Makefile editing commands for Emacs."
  :group 'tools
  :prefix "makefile-")
Eric S. Raymond's avatar
Eric S. Raymond committed
101

102 103
(defface makefile-space-face
   '((((class color)) (:background  "hotpink"))
Richard M. Stallman's avatar
Richard M. Stallman committed
104
     (t (:reverse-video t)))
105 106
  "Face to use for highlighting leading spaces in Font-Lock mode."
  :group 'faces
107
  :group 'makefile)
108

Richard M. Stallman's avatar
Richard M. Stallman committed
109
(defcustom makefile-browser-buffer-name "*Macros and Targets*"
Gerd Moellmann's avatar
Gerd Moellmann committed
110
  "*Name of the macro- and target browser buffer."
Richard M. Stallman's avatar
Richard M. Stallman committed
111 112 113 114
  :type 'string
  :group 'makefile)

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
129
(defcustom makefile-electric-keys nil
Gerd Moellmann's avatar
Gerd Moellmann committed
130
  "*If non-nil, Makefile mode should install electric keybindings.
Richard M. Stallman's avatar
Richard M. Stallman committed
131 132 133
Default is nil."
  :type 'boolean
  :group 'makefile)
134

Richard M. Stallman's avatar
Richard M. Stallman committed
135
(defcustom makefile-use-curly-braces-for-macros-p nil
Gerd Moellmann's avatar
Gerd Moellmann committed
136
  "*Controls the style of generated macro references.
Richard M. Stallman's avatar
Richard M. Stallman committed
137 138 139 140
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
141

Richard M. Stallman's avatar
Richard M. Stallman committed
142
(defcustom makefile-tab-after-target-colon t
Gerd Moellmann's avatar
Gerd Moellmann committed
143
  "*If non-nil, insert a TAB after a target colon.
144
Otherwise, a space is inserted.
Richard M. Stallman's avatar
Richard M. Stallman committed
145 146 147 148 149
The default is t."
  :type 'boolean
  :group 'makefile)

(defcustom makefile-browser-leftmost-column 10
Gerd Moellmann's avatar
Gerd Moellmann committed
150
  "*Number of blanks to the left of the browser selection mark."
Richard M. Stallman's avatar
Richard M. Stallman committed
151 152 153 154
  :type 'integer
  :group 'makefile)

(defcustom makefile-browser-cursor-column 10
Gerd Moellmann's avatar
Gerd Moellmann committed
155
  "*Column the cursor goes to when it moves up or down in the Makefile browser."
Richard M. Stallman's avatar
Richard M. Stallman committed
156 157 158 159 160 161 162 163 164
  :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
165
  "*If non-nil, `makefile-backslash-region' will align backslashes."
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167 168 169
  :type 'boolean
  :group 'makefile)

(defcustom makefile-browser-selected-mark "+  "
Gerd Moellmann's avatar
Gerd Moellmann committed
170
  "*String used to mark selected entries in the Makefile browser."
Richard M. Stallman's avatar
Richard M. Stallman committed
171 172 173 174
  :type 'string
  :group 'makefile)

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

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

(defcustom makefile-pickup-everything-picks-up-filenames-p nil
Gerd Moellmann's avatar
Gerd Moellmann committed
185
  "*If non-nil, `makefile-pickup-everything' picks up filenames as targets.
186
This means it calls `makefile-pickup-filenames-as-targets'.
Richard M. Stallman's avatar
Richard M. Stallman committed
187 188 189
Otherwise filenames are omitted."
  :type 'boolean
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
190

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

Dave Love's avatar
Dave Love committed
200
(defcustom makefile-mode-hook nil
Gerd Moellmann's avatar
Gerd Moellmann committed
201
  "*Normal hook run by `makefile-mode'."
Dave Love's avatar
Dave Love committed
202 203 204
  :type 'hook
  :group 'makefile)

205
(defvar makefile-browser-hook '())
Eric S. Raymond's avatar
Eric S. Raymond committed
206 207 208

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

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

234
;; Note that the first big subexpression is used by font lock.  Note
Richard M. Stallman's avatar
Richard M. Stallman committed
235 236
;; 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
237
(defconst makefile-dependency-regex
238
  "^ *\\([^ \n\t#:=]+\\([ \t]+\\([^ \t\n#:=]+\\|\\$[({][^ \t\n#})]+[})]\\)\\)*\\)[ \t]*:\\([ \t]*$\\|\\([^=\n].*$\\)\\)"
Eric S. Raymond's avatar
Eric S. Raymond committed
239 240
  "Regex used to find dependency lines in a makefile.")

Dave Love's avatar
Dave Love committed
241
;; Note that the first subexpression is used by font lock.  Note
Richard M. Stallman's avatar
Richard M. Stallman committed
242 243
;; 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
244
(defconst makefile-macroassign-regex
245
  "^ *\\([^ \n\t][^:#= \t\n]*\\)[ \t]*[*:+]?[:?]?="
Eric S. Raymond's avatar
Eric S. Raymond committed
246 247 248
  "Regex used to find macro assignment lines in a makefile.")

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

252 253
(if (fboundp 'facemenu-unlisted-faces)
    (add-to-list 'facemenu-unlisted-faces 'makefile-space-face))
254 255
(defvar makefile-space-face 'makefile-space-face
  "Face to use for highlighting leading spaces in Font-Lock mode.")
256

257 258
(defconst makefile-font-lock-keywords
  (list
Gerd Moellmann's avatar
Gerd Moellmann committed
259

260
   ;; Do macro assignments.  These get the "variable-name" face rather
261
   ;; arbitrarily.
262
   (list makefile-macroassign-regex 1 'font-lock-variable-name-face)
Gerd Moellmann's avatar
Gerd Moellmann committed
263

264 265
   ;; 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
266

267
   ;; Variable references even in targets/strings/comments.
268
   '("[^$]\\$[({]\\([-a-zA-Z0-9_.]+\\|[@%<?^+*][FD]?\\)[}):]"
269
     1 font-lock-constant-face prepend)
Gerd Moellmann's avatar
Gerd Moellmann committed
270

271 272 273 274
   ;; Automatic variable references and single character variable references,
   ;; but not shell variables references.
   '("[^$]\\$\\([@%<?^+*_]\\|[a-zA-Z0-9]\\>\\)"
     1 font-lock-constant-face prepend)
275

Gerd Moellmann's avatar
Gerd Moellmann committed
276 277
   ;; Fontify conditionals and includes.
   ;; Note that plain `if' is an automake conditional, and not a bug.
278 279 280
   (list
    (concat "^\\(?: [ \t]*\\)?"
	    (regexp-opt '("-include" "-sinclude" "include" "sinclude" "ifeq"
281 282 283
			  "if" "ifneq" "ifdef" "ifndef" "endif" "else"
			  "define" "endef" "override"
			  "export" "unexport" "vpath") t)
284 285
	    "\\>[ \t]*\\([^: \t\n#]*\\)")
    '(1 font-lock-keyword-face) '(2 font-lock-variable-name-face))
286

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

291 292
   ;; Highlight shell comments that Make treats as commands,
   ;; since these can fool people.
293
   '("^\t+#" 0 makefile-space-face t)
294 295 296 297

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

299
(defconst makefile-font-lock-syntactic-keywords
300 301 302 303 304 305 306 307
  ;; From sh-script.el.
  ;; A `#' begins a comment in sh when it is unquoted and at the beginning
  ;; of a word.  In the shell, words are separated by metacharacters.
  ;; The list of special chars is taken from the single-unix spec of the
  ;; shell command language (under `quoting') but with `$' removed.
  '(("[^|&;<>()`\\\"' \t\n]\\(#+\\)" 1 "_")
    ;; Change the syntax of a quoted newline so that it does not end a comment.
    ("\\\\\n" 0 ".")))
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 ------------------

Gerd Moellmann's avatar
Gerd Moellmann committed
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 ()))

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

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

  (define-key makefile-mode-map [menu-bar makefile-mode prev]
Karl Heuer's avatar
Karl Heuer committed
408
    '("Move to Previous Dependency" . makefile-previous-dependency))
409
  (define-key makefile-mode-map [menu-bar makefile-mode next]
Karl Heuer's avatar
Karl Heuer committed
410
    '("Move to Next Dependency" . makefile-next-dependency)))
Eric S. Raymond's avatar
Eric S. Raymond committed
411 412 413 414 415 416 417

(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
418
  (define-key makefile-browser-map "\C-n" 'makefile-browser-next-line)
Eric S. Raymond's avatar
Eric S. Raymond committed
419 420 421 422
  (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
423
  (define-key makefile-browser-map "I"    'makefile-browser-insert-selection-and-quit)
Eric S. Raymond's avatar
Eric S. Raymond committed
424 425 426 427
  (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
428
  (define-key makefile-browser-map "\C-f" 'undefined))
Eric S. Raymond's avatar
Eric S. Raymond committed
429 430


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


Eric S. Raymond's avatar
Eric S. Raymond committed
447 448 449 450 451 452
;;; ------------------------------------------------------------
;;; Internal variables.
;;; You don't need to configure below this line.
;;; ------------------------------------------------------------

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

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

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

(defvar makefile-browser-selection-vector nil)
462 463 464
(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
465 466 467

(defvar makefile-mode-hook '())

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


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

502
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
503 504
(defun makefile-mode ()
  "Major mode for editing Makefiles.
Richard M. Stallman's avatar
Richard M. Stallman committed
505
This function ends by invoking the function(s) `makefile-mode-hook'.
Eric S. Raymond's avatar
Eric S. Raymond committed
506 507 508 509 510 511 512

\\{makefile-mode-map}

In the browser, use the following keys:

\\{makefile-browser-map}

Richard M. Stallman's avatar
Richard M. Stallman committed
513
Makefile mode can be configured by modifying the following variables:
Eric S. Raymond's avatar
Eric S. Raymond committed
514

515
`makefile-browser-buffer-name':
Eric S. Raymond's avatar
Eric S. Raymond committed
516 517
    Name of the macro- and target browser buffer.

518
`makefile-target-colon':
Eric S. Raymond's avatar
Eric S. Raymond committed
519
    The string that gets appended to all target names
Richard M. Stallman's avatar
Richard M. Stallman committed
520
    inserted by `makefile-insert-target'.
Eric S. Raymond's avatar
Eric S. Raymond committed
521 522
    \":\" or \"::\" are quite common values.

523
`makefile-macro-assign':
Eric S. Raymond's avatar
Eric S. Raymond committed
524
   The string that gets appended to all macro names
Richard M. Stallman's avatar
Richard M. Stallman committed
525
   inserted by `makefile-insert-macro'.
Eric S. Raymond's avatar
Eric S. Raymond committed
526
   The normal value should be \" = \", since this is what
Dave Love's avatar
Dave Love committed
527
   standard make expects.  However, newer makes such as dmake
Eric S. Raymond's avatar
Eric S. Raymond committed
528 529 530
   allow a larger variety of different macro assignments, so you
   might prefer to use \" += \" or \" := \" .

531
`makefile-tab-after-target-colon':
Eric S. Raymond's avatar
Eric S. Raymond committed
532 533 534
   If you want a TAB (instead of a space) to be appended after the
   target colon, then set this to a non-nil value.

535
`makefile-browser-leftmost-column':
Eric S. Raymond's avatar
Eric S. Raymond committed
536 537
   Number of blanks to the left of the browser selection mark.

538
`makefile-browser-cursor-column':
Eric S. Raymond's avatar
Eric S. Raymond committed
539 540 541
   Column in which the cursor is positioned when it moves
   up or down in the browser.

542
`makefile-browser-selected-mark':
Eric S. Raymond's avatar
Eric S. Raymond committed
543 544
   String used to mark selected entries in the browser.

545
`makefile-browser-unselected-mark':
Eric S. Raymond's avatar
Eric S. Raymond committed
546 547
   String used to mark unselected entries in the browser.

548
`makefile-browser-auto-advance-after-selection-p':
Eric S. Raymond's avatar
Eric S. Raymond committed
549 550 551 552
   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.

553
`makefile-pickup-everything-picks-up-filenames-p':
Eric S. Raymond's avatar
Eric S. Raymond committed
554
   If this variable is set to a non-nil value then
Richard M. Stallman's avatar
Richard M. Stallman committed
555
   `makefile-pickup-everything' also picks up filenames as targets
556
   (i.e. it calls `makefile-pickup-filenames-as-targets'), otherwise
Eric S. Raymond's avatar
Eric S. Raymond committed
557 558
   filenames are omitted.

559
`makefile-cleanup-continuations':
Dave Love's avatar
Dave Love committed
560
   If this variable is set to a non-nil value then Makefile mode
Eric S. Raymond's avatar
Eric S. Raymond committed
561 562 563 564
   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
565
   IMPORTANT: Please note that enabling this option causes Makefile mode
Richard M. Stallman's avatar
Richard M. Stallman committed
566
   to MODIFY A FILE WITHOUT YOUR CONFIRMATION when \"it seems necessary\".
Eric S. Raymond's avatar
Eric S. Raymond committed
567

568
`makefile-browser-hook':
Eric S. Raymond's avatar
Eric S. Raymond committed
569
   A function or list of functions to be called just before the
570
   browser is entered. This is executed in the makefile buffer.
Eric S. Raymond's avatar
Eric S. Raymond committed
571

572
`makefile-special-targets-list':
Eric S. Raymond's avatar
Eric S. Raymond committed
573
   List of special targets. You will be offered to complete
Richard M. Stallman's avatar
Richard M. Stallman committed
574 575
   on one of those in the minibuffer whenever you enter a `.'.
   at the beginning of a line in Makefile mode."
576

Eric S. Raymond's avatar
Eric S. Raymond committed
577 578
  (interactive)
  (kill-all-local-variables)
579 580
  (add-hook 'write-file-functions
	    'makefile-warn-suspicious-lines nil t)
581 582
  (add-hook 'write-file-functions
	    'makefile-warn-continuations nil t)
583 584
  (add-hook 'write-file-functions
	    'makefile-cleanup-continuations nil t)
585 586 587 588 589
  (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)
590 591

  ;; Font lock.
592
  (make-local-variable 'font-lock-defaults)
593 594 595 596
  (setq font-lock-defaults
	;; SYNTAX-BEGIN set to backward-paragraph to avoid slow-down
	;; near the end of a large buffer, due to parse-partial-sexp's
	;; trying to parse all the way till the beginning of buffer.
597 598 599 600 601
 	'(makefile-font-lock-keywords
 	  nil nil
 	  ((?$ . "."))
 	  backward-paragraph
	  (font-lock-syntactic-keywords . makefile-font-lock-syntactic-keywords)))
602 603 604 605 606 607

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

  ;; Imenu.
608 609
  (make-local-variable 'imenu-generic-expression)
  (setq imenu-generic-expression makefile-imenu-generic-expression)
610

611 612 613 614
  ;; Dabbrev.
  (make-local-variable 'dabbrev-abbrev-skip-leading-regexp)
  (setq dabbrev-abbrev-skip-leading-regexp "\\$")

Gerd Moellmann's avatar
Gerd Moellmann committed
615 616 617
  ;; Other abbrevs.
  (setq local-abbrev-table makefile-mode-abbrev-table)

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

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

630 631 632
  ;; Make sure TAB really inserts \t.
  (set (make-local-variable 'indent-line-function) 'indent-to-left-margin)

Eric S. Raymond's avatar
Eric S. Raymond committed
633 634
  ;; become the current major mode
  (setq major-mode 'makefile-mode)
635 636 637
  (setq mode-name "Makefile")

  ;; Activate keymap and syntax table.
Eric S. Raymond's avatar
Eric S. Raymond committed
638 639
  (use-local-map makefile-mode-map)
  (set-syntax-table makefile-mode-syntax-table)
640 641 642 643 644 645 646 647

  ;; 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
648 649

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

Eric S. Raymond's avatar
Eric S. Raymond committed
658
(defun makefile-previous-dependency ()
Richard M. Stallman's avatar
Richard M. Stallman committed
659
  "Move point to the beginning of the previous dependency line."
Eric S. Raymond's avatar
Eric S. Raymond committed
660 661 662 663 664 665 666
  (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)))

667

Eric S. Raymond's avatar
Eric S. Raymond committed
668

669
;;; Electric keys.  Blech.
670

671 672 673 674 675
(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
676 677
  (if (bolp)
      (makefile-insert-special-target)
678
    (self-insert-command arg)))
Eric S. Raymond's avatar
Eric S. Raymond committed
679 680

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

693 694 695 696 697
(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")
698
  (makefile-pickup-macros)
Eric S. Raymond's avatar
Eric S. Raymond committed
699 700
  (if (bolp)
      (call-interactively 'makefile-insert-macro)
701
    (self-insert-command arg)))
Eric S. Raymond's avatar
Eric S. Raymond committed
702 703 704 705

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

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

(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)
729
	(insert target-name makefile-target-colon)
Eric S. Raymond's avatar
Eric S. Raymond committed
730 731
	(makefile-forward-after-target-colon)
	(end-of-line)
732
	(setq makefile-need-target-pickup t)
Eric S. Raymond's avatar
Eric S. Raymond committed
733 734 735
	(makefile-remember-target target-name))))

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

745 746 747 748 749
(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
750 751
  (if (bolp)
      (call-interactively 'makefile-insert-target)
752 753 754
    (self-insert-command arg)))


Eric S. Raymond's avatar
Eric S. Raymond committed
755 756 757 758 759 760

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

(defun makefile-pickup-targets ()
761
  "Notice names of all target definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
762
  (interactive)
763 764 765 766 767 768 769
  (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))
770
      (while (re-search-forward makefile-dependency-regex nil t)
771 772
	(makefile-add-this-line-targets)))
    (message "Read targets OK.")))
Eric S. Raymond's avatar
Eric S. Raymond committed
773 774 775 776

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

(defun makefile-pickup-macros ()
796
  "Notice names of all macro definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
797
  (interactive)
798 799 800 801 802 803
  (if (not makefile-need-macro-pickup)
      nil
    (setq makefile-need-macro-pickup nil)
    (setq makefile-macro-table nil)
    (save-excursion
      (goto-char (point-min))
804
      (while (re-search-forward makefile-macroassign-regex nil t)
805 806 807
	(makefile-add-this-line-macro)
	(forward-line 1)))
    (message "Read macros OK.")))
Eric S. Raymond's avatar
Eric S. Raymond committed
808 809 810 811 812

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

823
(defun makefile-pickup-everything (arg)
824
  "Notice names of all macros and targets in Makefile.
825 826 827 828 829 830
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
831 832 833 834 835 836
  (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 ()
837 838 839
  "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
840 841 842 843 844
  (interactive)
  (let* ((dir (file-name-directory (buffer-file-name)))
	 (raw-filename-list (if dir
				(file-name-all-completions "" dir)
			      (file-name-all-completions "" ""))))
845
    (mapcar (lambda (name)
Eric S. Raymond's avatar
Eric S. Raymond committed
846 847 848 849 850 851 852
	       (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)))

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 945 946 947 948 949


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



950 951
;; Backslashification.  Stolen from cc-mode.el.

952 953 954 955 956
(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
957
This function does not modify the last line of the region if the region ends
958 959 960
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."
961 962
  (interactive "r\nP")
  (save-excursion