make-mode.el 52.8 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  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 92
;; Sadly we need this for a macro.
(eval-when-compile
Gerd Moellmann's avatar
Gerd Moellmann committed
93 94 95
  (require 'imenu)
  (require 'dabbrev)
  (require 'add-log))
96

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

209
(defvar makefile-browser-hook '())
Eric S. Raymond's avatar
Eric S. Raymond committed
210 211 212

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

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

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

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

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

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

261 262
(defconst makefile-font-lock-keywords
  (list
Gerd Moellmann's avatar
Gerd Moellmann committed
263

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

268 269
   ;; 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
270

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

274 275
   ;; Automatic variable references and single character variable references...
   '("\\$\\([@%<?^+*_]\\|[a-zA-Z0-9]\\>\\)" 1 font-lock-reference-face prepend)
276
   '("\\$[({]\\([@%<?^+*][FD]?\\)[}):]" 1 font-lock-reference-face prepend)
Gerd Moellmann's avatar
Gerd Moellmann committed
277

278 279 280
   ;; ...but not shell variables references.
   '("\\$\\$\\(\\sw+\\)" 1 'default t)

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

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

296 297
   ;; Highlight shell comments that Make treats as commands,
   ;; since these can fool people.
298
   '("^\t+#" 0 makefile-space-face t)
299 300 301 302

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

304 305 306 307
(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
308
  "Imenu generic expression for Makefile mode.  See `imenu-generic-expression'.")
309

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

Richard M. Stallman's avatar
Richard M. Stallman committed
330
(defcustom makefile-brave-make "make"
Gerd Moellmann's avatar
Gerd Moellmann committed
331
  "*How to invoke make, for `makefile-query-targets'.
Richard M. Stallman's avatar
Richard M. Stallman committed
332 333 334
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
335

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

* 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
344
  as a string.  Depending on what you're going to do you may
Eric S. Raymond's avatar
Eric S. Raymond committed
345 346 347 348
  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
349 350 351 352 353
  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
354
  "*Name of the Up-to-date overview buffer."
Richard M. Stallman's avatar
Richard M. Stallman committed
355 356
  :type 'string
  :group 'makefile)
Eric S. Raymond's avatar
Eric S. Raymond committed
357 358 359

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

Gerd Moellmann's avatar
Gerd Moellmann committed
360 361 362 363 364 365
(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
366
(defvar makefile-mode-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
367 368
  "The keymap that is used in Makefile mode.")

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

  (define-key makefile-mode-map [menu-bar makefile-mode prev]
Karl Heuer's avatar
Karl Heuer committed
403
    '("Move to Previous Dependency" . makefile-previous-dependency))
404
  (define-key makefile-mode-map [menu-bar makefile-mode next]
Karl Heuer's avatar
Karl Heuer committed
405
    '("Move to Next Dependency" . makefile-next-dependency)))
Eric S. Raymond's avatar
Eric S. Raymond committed
406 407 408 409 410 411 412

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


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


Eric S. Raymond's avatar
Eric S. Raymond committed
442 443 444 445 446 447
;;; ------------------------------------------------------------
;;; Internal variables.
;;; You don't need to configure below this line.
;;; ------------------------------------------------------------

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

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

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

(defvar makefile-browser-selection-vector nil)
457 458 459
(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
460 461 462

(defvar makefile-mode-hook '())

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


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

497
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
498 499
(defun makefile-mode ()
  "Major mode for editing Makefiles.
Richard M. Stallman's avatar
Richard M. Stallman committed
500
This function ends by invoking the function(s) `makefile-mode-hook'.
Eric S. Raymond's avatar
Eric S. Raymond committed
501 502 503 504 505 506 507

\\{makefile-mode-map}

In the browser, use the following keys:

\\{makefile-browser-map}

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

510
`makefile-browser-buffer-name':
Eric S. Raymond's avatar
Eric S. Raymond committed
511 512
    Name of the macro- and target browser buffer.

513
`makefile-target-colon':
Eric S. Raymond's avatar
Eric S. Raymond committed
514
    The string that gets appended to all target names
Richard M. Stallman's avatar
Richard M. Stallman committed
515
    inserted by `makefile-insert-target'.
Eric S. Raymond's avatar
Eric S. Raymond committed
516 517
    \":\" or \"::\" are quite common values.

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

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

530
`makefile-browser-leftmost-column':
Eric S. Raymond's avatar
Eric S. Raymond committed
531 532
   Number of blanks to the left of the browser selection mark.

533
`makefile-browser-cursor-column':
Eric S. Raymond's avatar
Eric S. Raymond committed
534 535 536
   Column in which the cursor is positioned when it moves
   up or down in the browser.

537
`makefile-browser-selected-mark':
Eric S. Raymond's avatar
Eric S. Raymond committed
538 539
   String used to mark selected entries in the browser.

540
`makefile-browser-unselected-mark':
Eric S. Raymond's avatar
Eric S. Raymond committed
541 542
   String used to mark unselected entries in the browser.

543
`makefile-browser-auto-advance-after-selection-p':
Eric S. Raymond's avatar
Eric S. Raymond committed
544 545 546 547
   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.

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

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

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

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

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

  ;; Font lock.
587
  (make-local-variable 'font-lock-defaults)
588 589 590 591
  (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.
592
        '(makefile-font-lock-keywords nil nil ((?$ . ".")) backward-paragraph))
593 594 595 596 597 598

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

  ;; Imenu.
599 600
  (make-local-variable 'imenu-generic-expression)
  (setq imenu-generic-expression makefile-imenu-generic-expression)
601

602 603 604 605
  ;; Dabbrev.
  (make-local-variable 'dabbrev-abbrev-skip-leading-regexp)
  (setq dabbrev-abbrev-skip-leading-regexp "\\$")

Gerd Moellmann's avatar
Gerd Moellmann committed
606 607 608
  ;; Other abbrevs.
  (setq local-abbrev-table makefile-mode-abbrev-table)

609 610 611 612
  ;; Filling.
  (make-local-variable 'fill-paragraph-function)
  (setq fill-paragraph-function 'makefile-fill-paragraph)

613
  ;; Comment stuff.
614
  (make-local-variable 'comment-start)
Eric S. Raymond's avatar
Eric S. Raymond committed
615
  (setq comment-start "#")
616
  (make-local-variable 'comment-end)
Eric S. Raymond's avatar
Eric S. Raymond committed
617
  (setq comment-end "")
618 619 620
  (make-local-variable 'comment-start-skip)
  (setq comment-start-skip "#+[ \t]*")

621 622 623
  ;; 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
624 625
  ;; become the current major mode
  (setq major-mode 'makefile-mode)
626 627 628
  (setq mode-name "Makefile")

  ;; Activate keymap and syntax table.
Eric S. Raymond's avatar
Eric S. Raymond committed
629 630
  (use-local-map makefile-mode-map)
  (set-syntax-table makefile-mode-syntax-table)
631 632 633 634 635 636 637 638

  ;; 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
639 640

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

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

658

Eric S. Raymond's avatar
Eric S. Raymond committed
659

660
;;; Electric keys.  Blech.
661

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

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

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

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

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

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

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

736 737 738 739 740
(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
741 742
  (if (bolp)
      (call-interactively 'makefile-insert-target)
743 744 745
    (self-insert-command arg)))


Eric S. Raymond's avatar
Eric S. Raymond committed
746 747 748 749 750 751

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

(defun makefile-pickup-targets ()
752
  "Notice names of all target definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
753
  (interactive)
754 755 756 757 758 759 760
  (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))
761
      (while (re-search-forward makefile-dependency-regex nil t)
762 763
	(makefile-add-this-line-targets)))
    (message "Read targets OK.")))
Eric S. Raymond's avatar
Eric S. Raymond committed
764 765 766 767

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

(defun makefile-pickup-macros ()
787
  "Notice names of all macro definitions in Makefile."
Eric S. Raymond's avatar
Eric S. Raymond committed
788
  (interactive)
789 790 791 792 793 794
  (if (not makefile-need-macro-pickup)
      nil
    (setq makefile-need-macro-pickup nil)
    (setq makefile-macro-table nil)
    (save-excursion
      (goto-char (point-min))
795
      (while (re-search-forward makefile-macroassign-regex nil t)
796 797 798
	(makefile-add-this-line-macro)
	(forward-line 1)))
    (message "Read macros OK.")))
Eric S. Raymond's avatar
Eric S. Raymond committed
799 800 801 802 803

(defun makefile-add-this-line-macro ()
  (save-excursion
    (beginning-of-line)
    (skip-chars-forward " \t")
804 805 806 807 808 809 810 811 812
    (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
813

814
(defun makefile-pickup-everything (arg)
815
  "Notice names of all macros and targets in Makefile.
816 817 818 819 820 821
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
822 823 824 825 826 827
  (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 ()
828 829 830
  "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
831 832 833 834 835
  (interactive)
  (let* ((dir (file-name-directory (buffer-file-name)))
	 (raw-filename-list (if dir
				(file-name-all-completions "" dir)
			      (file-name-all-completions "" ""))))
836
    (mapcar (lambda (name)
Eric S. Raymond's avatar
Eric S. Raymond committed
837 838 839 840 841 842 843
	       (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)))

844 845 846 847 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


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



941 942
;; Backslashification.  Stolen from cc-mode.el.

943 944 945 946 947
(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
948
This function does not modify the last line of the region if the region ends
949 950 951
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."
952 953
  (interactive "r\nP")
  (save-excursion
954 955 956 957 958 959 960 961 962 963 964 965 966