1 ;;; macros.el --- non-primitive commands for keyboard macros.
3 ;; Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;; Extension commands for keyboard macros. These permit you to assign
27 ;; a name to the last-defined keyboard macro, expand and insert the
28 ;; lisp corresponding to a macro, query the user from within a macro,
29 ;; or apply a macro to each line in the reason.
34 (defun name-last-kbd-macro (symbol)
35 "Assign a name to the last keyboard macro defined.
36 Argument SYMBOL is the name to define.
37 The symbol's function definition becomes the keyboard macro string.
38 Such a \"function\" cannot be called from Lisp, but it is a valid editor command."
39 (interactive "SName for last kbd macro: ")
41 (error "No keyboard macro defined"))
43 (not (stringp (symbol-function symbol
)))
44 (error "Function %s is already defined and not a keyboard macro."
46 (fset symbol last-kbd-macro
))
49 (defun insert-kbd-macro (macroname &optional keys
)
50 "Insert in buffer the definition of kbd macro NAME, as Lisp code.
51 Optional second arg KEYS means also record the keys it is on
52 \(this is the prefix argument, when calling interactively).
54 This Lisp code will, when executed, define the kbd macro with the same
55 definition it has now. If you say to record the keys, the Lisp code
56 will also rebind those keys to the macro. Only global key bindings
57 are recorded since executing this Lisp code always makes global
60 To save a kbd macro, visit a file of Lisp code such as your `~/.emacs',
61 use this command, and then save the file."
62 (interactive "CInsert kbd macro (name): \nP")
64 (if (string= (symbol-name macroname
) "")
66 (setq macroname
'last-kbd-macro definition last-kbd-macro
)
68 (setq definition
(symbol-function macroname
))
70 (prin1 macroname
(current-buffer))
72 (let ((beg (point)) end
)
73 (prin1 definition
(current-buffer))
74 (setq end
(point-marker))
76 (while (< (point) end
)
77 (let ((char (following-char)))
79 (delete-region (point) (1+ (point)))
80 (insert "\\C-" (+ 96 char
)))
84 (delete-region (point) (1+ (point)))
87 (delete-region (point) (1+ (point)))
88 (insert "\\M-C-" (- char
32)))
90 (delete-region (point) (1+ (point)))
91 (insert "\\M-" (- char
128)))
93 (delete-region (point) (1+ (point)))
94 (insert "\\M-C-?"))))))
97 (let ((keys (where-is-internal macroname nil
)))
99 (insert "(global-set-key ")
100 (prin1 (car keys
) (current-buffer))
102 (prin1 macroname
(current-buffer))
104 (setq keys
(cdr keys
)))))))
107 (defun kbd-macro-query (flag)
108 "Query user during kbd macro execution.
109 With prefix argument, enters recursive edit, reading keyboard
110 commands even within a kbd macro. You can give different commands
111 each time the macro executes.
112 Without prefix argument, reads a character. Your options are:
113 Space -- execute the rest of the macro.
114 DEL -- skip the rest of the macro; start next repetition.
115 C-d -- skip rest of the macro and don't repeat it any more.
116 C-r -- enter a recursive edit, then on exit ask again for a character
117 C-l -- redisplay screen and ask again."
121 (error "Not defining or executing kbd macro"))
123 (let (executing-macro defining-kbd-macro
)
125 (if (not executing-macro
)
129 (let ((char (let ((executing-macro nil
)
130 (defining-kbd-macro nil
))
131 (message "Proceed with macro? (Space, DEL, C-d, C-r or C-l) ")
137 (setq executing-macro
""))
140 (setq executing-macro t
))
144 (let (executing-macro defining-kbd-macro
)
145 (recursive-edit))))))))))
148 (defun apply-macro-to-region-lines (top bottom
&optional macro
)
149 "For each complete line between point and mark, move to the beginning
150 of the line, and run the last keyboard macro.
152 When called from lisp, this function takes two arguments TOP and
153 BOTTOM, describing the current region. TOP must be before BOTTOM.
154 The optional third argument MACRO specifies a keyboard macro to
157 This is useful for quoting or unquoting included text, adding and
158 removing comments, or producing tables where the entries are regular.
160 For example, in Usenet articles, sections of text quoted from another
161 author are indented, or have each line start with `>'. To quote a
162 section of text, define a keyboard macro which inserts `>', put point
163 and mark at opposite ends of the quoted section, and use
164 `\\[apply-macro-to-region-lines]' to mark the entire section.
166 Suppose you wanted to build a keyword table in C where each entry
169 { \"foo\", foo_data, foo_function },
170 { \"bar\", bar_data, bar_function },
171 { \"baz\", baz_data, baz_function },
173 You could enter the names in this format:
179 and write a macro to massage a word into a table entry:
182 \\M-d { \"\\C-y\", \\C-y_data, \\C-y_function },
185 and then select the region of un-tablified names and use
186 `\\[apply-macro-to-region-lines]' to build the table from the names.
191 (if (null last-kbd-macro
)
192 (error "No keyboard macro has been defined."))
193 (setq macro last-kbd-macro
)))
195 (let ((end-marker (progn
203 (setq next-line-marker
(point-marker))
204 (while (< next-line-marker end-marker
)
205 (goto-char next-line-marker
)
208 (set-marker next-line-marker
(point)))
210 (execute-kbd-macro (or macro last-kbd-macro
))))
211 (set-marker end-marker nil
)
212 (set-marker next-line-marker nil
))))
215 (define-key ctl-x-map
"q" 'kbd-macro-query
)
217 ;;; macros.el ends here