| blob | 2cea25c6441829e72613264be7b48682ca168a5c |
1 ;;; make-mode.el --- makefile editing commands for Emacs
3 ;; Copyright (C) 1992, 1994 Free Software Foundation, Inc.
5 ;; Author: Thomas Neumann <tom@smart.bo.open.de>
6 ;; Eric S. Raymond <esr@snark.thyrsus.com>
7 ;; Adapted-By: ESR
8 ;; Keywords: unix, tools
10 ;; RMS:
11 ;; This needs work.
12 ;; Also, the doc strings need fixing: the first line doesn't stand alone,
13 ;; and other usage is not high quality. Symbol names don't have `...'.
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software; you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation; either version 2, or (at your option)
20 ;; any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs; see the file COPYING. If not, write to the
29 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
30 ;; Boston, MA 02111-1307, USA.
32 ;;; Commentary:
34 ;; A major mode for editing makefiles. The mode knows about Makefile
35 ;; syntax and defines M-n and M-p to move to next and previous productions.
36 ;;
37 ;; The keys $, =, : and . are electric; they try to help you fill in a
38 ;; macro reference, macro definition, ordinary target name, or special
39 ;; target name, respectively. Such names are completed using a list of
40 ;; targets and macro names parsed out of the makefile. This list is
41 ;; automatically updated, if necessary, whenever you invoke one of
42 ;; these commands. You can force it to be updated with C-c C-p.
43 ;;
44 ;; The command C-c C-f adds certain filenames in the current directory
45 ;; as targets. You can filter out filenames by setting the variable
46 ;; makefile-ignored-files-in-pickup-regex.
47 ;;
48 ;; The command C-c C-u grinds for a bit, then pops up a report buffer
49 ;; showing which target names are up-to-date with respect to their
50 ;; prerequisites, which targets are out-of-date, and which have no
51 ;; prerequisites.
52 ;;
53 ;; The command C-c C-b pops up a browser window listing all target and
54 ;; macro names. You can mark or unmark items wit C-c SPC, and insert
55 ;; all marked items back in the Makefile with C-c TAB.
56 ;;
57 ;; The command C-c TAB in the makefile buffer inserts a GNU make builtin.
58 ;; You will be prompted for the builtin's args.
59 ;;
60 ;; There are numerous other customization variables.
62 ;;
63 ;; To Do:
64 ;;
65 ;; * Eliminate electric stuff entirely.
66 ;; * It might be nice to highlight targets differently depending on
67 ;; whether they are up-to-date or not. Not sure how this would
68 ;; interact with font-lock.
69 ;; * Would be nice to edit the commands in ksh-mode and have
70 ;; indentation and slashification done automatically. Hard.
71 ;; * Consider removing browser mode. It seems useless.
72 ;; * ":" should notice when a new target is made and add it to the
73 ;; list (or at least set makefile-need-target-pickup).
74 ;; * Make browser into a major mode.
75 ;; * Clean up macro insertion stuff. It is a mess.
76 ;; * Browser entry and exit is weird. Normalize.
77 ;; * Browser needs to be rewritten. Right now it is kind of a crock.
78 ;; Should at least:
79 ;; * Act more like dired/buffer menu/whatever.
80 ;; * Highlight as mouse traverses.
81 ;; * B2 inserts.
82 ;; * Update documentation above.
83 ;; * Update texinfo manual.
84 ;; * Update files.el.
86 \f
88 ;;; Code:
92 ;; Sadly we need this for a macro.
96 ;;; ------------------------------------------------------------
97 ;;; Configurable stuff
98 ;;; ------------------------------------------------------------
104 "String to append to all target names inserted by `makefile-insert-target'.
108 "String to append to all macro names inserted by `makefile-insert-macro'.
110 standard make expects. However, newer makes such as dmake
111 allow a larger variety of different macro assignments, so you
115 "If non-nil, install electric keybindings.
119 "Controls the style of generated macro references.
120 t (actually non-nil) means macro references should use curly braces,
121 like `${this}'.
125 "If non-nil, insert a TAB after a target colon.
126 Otherwise, a space is inserted.
133 "Column in which the cursor is positioned when it moves
152 "If non-nil, `makefile-pickup-everything' picks up filenames as targets.
153 \(i.e. it calls `makefile-find-filenames-as-targets').
157 "If non-nil, automatically clean up continuation lines when saving.
158 A line is cleaned up by removing all whitespace following a trailing
159 backslash. This is done silently.
160 IMPORTANT: Please note that enabling this option causes makefile-mode
165 ;;
166 ;; Special targets for DMake, Sun's make ...
167 ;;
177 "List of special targets.
178 You will be offered to complete on one of those in the minibuffer whenever
183 "List of macros that are resolved by make at runtime.
184 If you insert a macro reference using makefile-insert-macro-ref, the name
185 of the macro is checked against this list. If it can be found its name will
188 ;; Note that the first big subexpression is used by font lock. Note
189 ;; that if you change this regexp you must fix the imenu index
190 ;; function defined at the end of the file.
195 ;; Note that the first subexpression is used by font lock. Note that
196 ;; if you change this regexp you must fix the imenu index function
197 ;; defined at the end of the file.
213 ;; Do macro assignments. These get the "variable-name" face rather
214 ;; arbitrarily.
216 ;;
217 ;; Do dependencies. These get the function name face.
219 ;;
220 ;; Variable references even in targets/strings/comments:
223 ;; Highlight lines that contain just whitespace.
224 ;; They can cause trouble, especially if they start with a tab.
227 ;; Highlight shell comments that Make treats as commands,
228 ;; since these can fool people.
231 ;; Highlight spaces that precede tabs.
232 ;; They can make a tab fail to be effective.
235 ;;; ------------------------------------------------------------
236 ;;; The following configurable variables are used in the
237 ;;; up-to-date overview .
238 ;;; The standard configuration assumes that your `make' program
239 ;;; can be run in question/query mode using the `-q' option, this
240 ;;; means that the command
241 ;;;
242 ;;; make -q foo
243 ;;;
244 ;;; should return an exit status of zero if the target `foo' is
245 ;;; up to date and a nonzero exit status otherwise.
246 ;;; Many makes can do this although the docs/manpages do not mention
247 ;;; it. Try it with your favourite one. GNU make, System V make, and
248 ;;; Dennis Vadura's DMake have no problems.
249 ;;; Set the variable `makefile-brave-make' to the name of the
250 ;;; make utility that does this on your system.
251 ;;; To understand what this is all about see the function definition
252 ;;; of `makefile-query-by-make-minus-q' .
253 ;;; ------------------------------------------------------------
259 "Function to call to determine whether a make target is up to date.
260 The function must satisfy this calling convention:
262 * As its first argument, it must accept the name of the target to
263 be checked, as a string.
265 * As its second argument, it may accept the name of a makefile
266 as a string. Depending on what you're going to do you may
267 not need this.
269 * It must return the integer value 0 (zero) if the given target
270 should be considered up-to-date in the context of the given
276 ;;; --- end of up-to-date-overview configuration ------------------
282 ()
284 ;; set up the keymap
303 ;; Make menus.
322 ()
333 ;; disable horizontal movement
340 ()
354 ;;; ------------------------------------------------------------
355 ;;; Internal variables.
356 ;;; You don't need to configure below this line.
357 ;;; ------------------------------------------------------------
375 ;; Each element looks like '("GNU MAKE FUNCTION" "ARG" "ARG" ... )
376 ;; Each "ARG" is used as a prompt for a required argument.
378 '(
379 ;; Text functions
387 ;; Filename functions
399 ;; Misc functions
405 ;;; ------------------------------------------------------------
406 ;;; The mode function itself.
407 ;;; ------------------------------------------------------------
409 ;;;###autoload
411 "Major mode for editing Makefiles.
412 This function ends by invoking the function(s) `makefile-mode-hook'.
416 In the browser, use the following keys:
420 Makefile mode can be configured by modifying the following variables:
422 makefile-browser-buffer-name:
423 Name of the macro- and target browser buffer.
425 makefile-target-colon:
426 The string that gets appended to all target names
427 inserted by `makefile-insert-target'.
430 makefile-macro-assign:
431 The string that gets appended to all macro names
432 inserted by `makefile-insert-macro'.
434 standard make expects. However, newer makes such as dmake
435 allow a larger variety of different macro assignments, so you
438 makefile-tab-after-target-colon:
439 If you want a TAB (instead of a space) to be appended after the
440 target colon, then set this to a non-nil value.
442 makefile-browser-leftmost-column:
443 Number of blanks to the left of the browser selection mark.
445 makefile-browser-cursor-column:
446 Column in which the cursor is positioned when it moves
447 up or down in the browser.
449 makefile-browser-selected-mark:
450 String used to mark selected entries in the browser.
452 makefile-browser-unselected-mark:
453 String used to mark unselected entries in the browser.
455 makefile-browser-auto-advance-after-selection-p:
456 If this variable is set to a non-nil value the cursor
457 will automagically advance to the next line after an item
458 has been selected in the browser.
460 makefile-pickup-everything-picks-up-filenames-p:
461 If this variable is set to a non-nil value then
462 `makefile-pickup-everything' also picks up filenames as targets
463 (i.e. it calls `makefile-find-filenames-as-targets'), otherwise
464 filenames are omitted.
466 makefile-cleanup-continuations-p:
467 If this variable is set to a non-nil value then makefile-mode
468 will assure that no line in the file ends with a backslash
469 (the continuation character) followed by any whitespace.
470 This is done by silently removing the trailing whitespace, leaving
471 the backslash itself intact.
472 IMPORTANT: Please note that enabling this option causes makefile-mode
475 makefile-browser-hook:
476 A function or list of functions to be called just before the
477 browser is entered. This is executed in the makefile buffer.
479 makefile-special-targets-list:
480 List of special targets. You will be offered to complete
481 on one of those in the minibuffer whenever you enter a `.'.
482 at the beginning of a line in Makefile mode."
495 ;; Font lock.
501 ;; Add-log.
505 ;; Imenu.
509 ;; Dabbrev.
513 ;; Filling.
517 ;; Comment stuff.
525 ;; become the current major mode
529 ;; Activate keymap and syntax table.
533 ;; Real TABs are important in makefiles
537 \f
539 ;;; Motion code.
542 "Move point to the beginning of the next dependency line."
551 "Move point to the beginning of the previous dependency line."
559 \f
561 ;;; Electric keys. Blech.
564 "Prompt for the name of a special target to insert.
565 Only does electric insertion at beginning of line.
566 Anywhere else just self-inserts."
573 "Prompt for and insert a special target name.
574 Uses `makefile-special-targets' list."
579 makefile-special-targets-list nil nil nil)))
581 ()
586 "Prompt for name of a macro to insert.
587 Only does prompting if point is at beginning of line.
588 Anywhere else just self-inserts."
596 "Prepare definition of a new macro."
607 "Complete on a list of known macros, then insert complete ref at point."
616 "Prepare definition of a new target (dependency line)."
628 "Complete on a list of known targets, then insert target-ref at point."
638 "Prompt for name of new target.
639 Prompting only happens at beginning of line.
640 Anywhere else just self-inserts."
646 \f
648 ;;; ------------------------------------------------------------
649 ;;; Extracting targets and macros from an existing makefile
650 ;;; ------------------------------------------------------------
653 "Notice names of all target definitions in Makefile."
656 nil
685 target-name line-number)))))))))
688 "Notice names of all macro definitions in Makefile."
691 nil
713 macro-name line-number))))))
716 "Notice names of all macros and targets in Makefile.
717 Prefix arg means force pickups to be redone."
729 "Scan the current directory for filenames to use as targets.
730 Checks each filename against `makefile-ignored-files-in-pickup-regex'
731 and adds all qualifying names to the list of known targets."
740 name)))
743 raw-filename-list)))
745 \f
747 ;;; Completion.
750 "Perform completion on Makefile construct preceding point.
751 Can complete variable and target names.
752 The context determines which are considered."
765 ;; Beginning of line means anything.
767 ())
769 ;; Preceding "$" means macros only.
773 ;; Preceding "$(" or "${" means macros only.
783 ;; Try completion.
785 '()
786 makefile-target-table)
787 makefile-macro-table))
790 ;; Exact match, so insert closing paren or colon.
794 ?}
795 ?\))
799 ":"
802 ;; No match.
807 ;; Partial completion.
809 ;; FIXME it would be nice to supply the closing paren if an
810 ;; exact, unambiguous match were found. That is not possible
811 ;; right now. Ditto closing ":" for targets.
814 ;; DO-MACROS means doing macros only. If not that, then check
815 ;; to see if this completion is a macro. Special insertion
816 ;; must be done for macros.
821 makefile-use-curly-braces-for-macros-p)))
826 ;; Just insert targets.
829 ;; Can't complete any more, so make completion list. FIXME
830 ;; this doesn't do the right thing when the completion is
831 ;; actually inserted. I don't think there is an easy way to do
832 ;; that.
840 \f
842 ;; Backslashification. Stolen from cc-mode.el.
845 "Insert, align, or delete end-of-line backslashes on the lines in the region.
846 With no argument, inserts backslashes and aligns existing backslashes.
847 With an argument, deletes the backslashes.
849 This function does not modify the last line of the region if the region ends
850 right at the start of the following line; it does not modify blank lines
851 at the start of the region. So you can put the region around an entire macro
852 definition and conveniently use this command."
859 ;; Compute the smallest column number past the ends of all the lines.
870 ;; Adjust upward to a tab column, if that doesn't push
871 ;; past the margin.
874 tab-width)))
877 ;; Don't modify blank lines at start of region.
881 ;; Add or remove backslashes on all the lines.
883 ;; Don't backslashify the last line
884 ;; if the region ends right at the start of the next line.
896 ;; Note that "\\\\" is needed to get one backslash.
913 \f
915 ;; Filling
918 ;; Fill comments, backslashed lines, and variable definitions
919 ;; specially.
924 ;; Found a comment. Set the fill prefix and then fill.
929 t))
931 ;; Must look for backslashed-region before looking for variable
932 ;; assignment.
940 ;; A backslash region. Find beginning and end, remove
941 ;; backslashes, fill, and then reapply backslahes.
966 ;; Have a macro assign. Fill just this line, and then backslash
967 ;; resulting region.
977 ;; Always return non-nil so we don't fill anything else.
978 t)
980 \f
982 ;;; ------------------------------------------------------------
983 ;;; Browser mode.
984 ;;; ------------------------------------------------------------
990 makefile-browser-selected-mark
991 makefile-browser-unselected-mark)
993 target makefile-target-colon))
999 makefile-browser-selected-mark
1000 makefile-browser-unselected-mark)
1010 targets
1015 macros
1023 ;;;
1024 ;;; Moving up and down in the browser
1025 ;;;
1028 "Move the browser selection cursor to the next line."
1036 "Move the browser selection cursor to the previous line."
1043 ;;;
1044 ;;; Quitting the browser (returns to client buffer)
1045 ;;;
1048 "Leave the browser and return to the makefile buffer."
1056 ;;;
1057 ;;; Toggle state of a browser item
1058 ;;;
1061 "Toggle the selection state of the browser item at the cursor position."
1074 macro-name
1080 target-name
1087 ;;;
1088 ;;; Making insertions into the client buffer
1089 ;;;
1092 "Insert a makefile continuation.
1094 character, insert a new blank line, go to that line and indent by one TAB.
1095 This is most useful in the process of creating continued lines when copying
1096 large dependencies from the browser to the client buffer.
1097 \(point) advances accordingly in the client buffer."
1105 "Insert all selected targets and/or macros in the makefile buffer.
1106 Insertion takes place at point."
1160 \f
1162 ;;; ------------------------------------------------------------
1163 ;;; Up-to-date overview buffer
1164 ;;; ------------------------------------------------------------
1167 "Create a buffer containing an overview of the state of all known targets.
1168 Known targets are targets that are explicitly defined in that makefile;
1169 in other words, all targets that appear on the left hand side of a
1170 dependency in the makefile."
1173 ;;
1174 ;; The rest of this function operates on a temporary makefile, created by
1175 ;; writing the current contents of the makefile buffer.
1176 ;;
1182 ;;
1183 ;; Forget the target table because it may contain picked-up filenames
1184 ;; that are not really targets in the current makefile.
1185 ;; We don't want to query these, so get a new target-table with just the
1186 ;; targets that can be found in the makefile buffer.
1187 ;; The 'old' target table will be restored later.
1188 ;;
1191 makefile-target-table))
1193 )
1213 "Create a temporary file from the current makefile buffer."
1219 "Create a filename suitable for use in `makefile-save-temporary'.
1220 Be careful to allow brain-dead file systems (DOS, SYSV ...) to cope
1221 with the generated name!"
1227 my-name)
1228 "."
1231 my-uid))))
1234 "Fill the up-to-date overview buffer.
1235 Checks each target in TARGET-TABLE using `makefile-query-one-target-method'
1236 and generates the overview, one line per target name."
1244 makefile-query-one-target-method
1245 target-name
1246 filename))))
1248 target-name
1252 ))
1262 \f
1264 ;;; ------------------------------------------------------------
1265 ;;; Continuation cleanup
1266 ;;; ------------------------------------------------------------
1278 ;;; ------------------------------------------------------------
1279 ;;; Warn of suspicious lines
1280 ;;; ------------------------------------------------------------
1295 line-nr))))))))
1296 dont-save))
1298 \f
1300 ;;; ------------------------------------------------------------
1301 ;;; GNU make function support
1302 ;;; ------------------------------------------------------------
1305 "Insert a GNU make function call.
1306 Asks for the name of the function to use (with completion).
1307 Then prompts for all required parameters."
1310 "Function: "
1311 makefile-gnumake-functions-alist
1312 nil t nil))
1319 gm-function-name gm-function-prompts)))
1326 nil)))
1327 prompt-list
1330 \f
1332 ;;; ------------------------------------------------------------
1333 ;;; Utility functions
1334 ;;; ------------------------------------------------------------
1337 "Insert a macro reference."
1344 "Remember a given target if it is not already remembered for this buffer."
1355 "Remember a given macro if it is not already remembered for this buffer."
1362 "Move point forward after inserting the terminating colon of a target.
1363 This acts according to the value of `makefile-tab-after-target-colon'."
1369 "Determine if point is on a macro line in the browser."
1375 "Extract the target name from a line in the browser."
1382 "Extract the macro name from a line in the browser."
1391 "Format a macro reference.
1392 Uses `makefile-use-curly-braces-for-macros-p'."
1425 \f
1427 ;;; Support for other packages, like add-log and imenu.
1430 "Return name of target or variable assignment that point is in.
1431 If it isn't in one, return nil."
1435 ;; Scan back line by line, noticing when we come to a
1436 ;; variable or rule definition, and giving up when we see
1437 ;; a line that is not part of either of those.
1446 ;; Don't keep looking across a blank line or comment. Give up.
1455 ;; FIXME it might be nice to have them separated by macro vs target.
1457 ;; "Generate alist of indices for imenu."
1459 stupid
1462 makefile-macroassign-regex)))
1472 alist))))
1492 ;;; make-mode.el ends here