38412
|
1 ;;; macros.el --- non-primitive commands for keyboard macros
|
659
|
2
|
74442
|
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1995, 2001, 2002, 2003,
|
106815
|
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
|
845
|
5
|
807
|
6 ;; Maintainer: FSF
|
2247
|
7 ;; Keywords: abbrev
|
110015
|
8 ;; Package: emacs
|
36
|
9
|
|
10 ;; This file is part of GNU Emacs.
|
|
11
|
94678
|
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
|
36
|
13 ;; it under the terms of the GNU General Public License as published by
|
94678
|
14 ;; the Free Software Foundation, either version 3 of the License, or
|
|
15 ;; (at your option) any later version.
|
36
|
16
|
|
17 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
20 ;; GNU General Public License for more details.
|
|
21
|
|
22 ;; You should have received a copy of the GNU General Public License
|
94678
|
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
36
|
24
|
2307
|
25 ;;; Commentary:
|
|
26
|
|
27 ;; Extension commands for keyboard macros. These permit you to assign
|
|
28 ;; a name to the last-defined keyboard macro, expand and insert the
|
|
29 ;; lisp corresponding to a macro, query the user from within a macro,
|
|
30 ;; or apply a macro to each line in the reason.
|
|
31
|
807
|
32 ;;; Code:
|
36
|
33
|
256
|
34 ;;;###autoload
|
36
|
35 (defun name-last-kbd-macro (symbol)
|
|
36 "Assign a name to the last keyboard macro defined.
|
216
|
37 Argument SYMBOL is the name to define.
|
36
|
38 The symbol's function definition becomes the keyboard macro string.
|
217
|
39 Such a \"function\" cannot be called from Lisp, but it is a valid editor command."
|
36
|
40 (interactive "SName for last kbd macro: ")
|
|
41 (or last-kbd-macro
|
|
42 (error "No keyboard macro defined"))
|
|
43 (and (fboundp symbol)
|
|
44 (not (stringp (symbol-function symbol)))
|
4331
|
45 (not (vectorp (symbol-function symbol)))
|
38412
|
46 (error "Function %s is already defined and not a keyboard macro"
|
36
|
47 symbol))
|
14398
|
48 (if (string-equal symbol "")
|
|
49 (error "No command name given"))
|
36
|
50 (fset symbol last-kbd-macro))
|
|
51
|
256
|
52 ;;;###autoload
|
36
|
53 (defun insert-kbd-macro (macroname &optional keys)
|
|
54 "Insert in buffer the definition of kbd macro NAME, as Lisp code.
|
217
|
55 Optional second arg KEYS means also record the keys it is on
|
1469
|
56 \(this is the prefix argument, when calling interactively).
|
36
|
57
|
217
|
58 This Lisp code will, when executed, define the kbd macro with the same
|
|
59 definition it has now. If you say to record the keys, the Lisp code
|
|
60 will also rebind those keys to the macro. Only global key bindings
|
|
61 are recorded since executing this Lisp code always makes global
|
|
62 bindings.
|
36
|
63
|
1469
|
64 To save a kbd macro, visit a file of Lisp code such as your `~/.emacs',
|
36
|
65 use this command, and then save the file."
|
58609
|
66 (interactive (list (intern (completing-read "Insert kbd macro (name): "
|
|
67 obarray
|
57969
|
68 (lambda (elt)
|
|
69 (and (fboundp elt)
|
|
70 (or (stringp (symbol-function elt))
|
58609
|
71 (vectorp (symbol-function elt))
|
|
72 (get elt 'kmacro))))
|
57969
|
73 t))
|
|
74 current-prefix-arg))
|
1470
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
75 (let (definition)
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
76 (if (string= (symbol-name macroname) "")
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
77 (progn
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
78 (setq macroname 'last-kbd-macro definition last-kbd-macro)
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
79 (insert "(setq "))
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
80 (setq definition (symbol-function macroname))
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
81 (insert "(fset '"))
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
82 (prin1 macroname (current-buffer))
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
83 (insert "\n ")
|
11170
|
84 (if (stringp definition)
|
|
85 (let ((beg (point)) end)
|
|
86 (prin1 definition (current-buffer))
|
|
87 (setq end (point-marker))
|
|
88 (goto-char beg)
|
10153
|
89 (while (< (point) end)
|
|
90 (let ((char (following-char)))
|
|
91 (cond ((= char 0)
|
|
92 (delete-region (point) (1+ (point)))
|
|
93 (insert "\\C-@"))
|
|
94 ((< char 27)
|
|
95 (delete-region (point) (1+ (point)))
|
|
96 (insert "\\C-" (+ 96 char)))
|
|
97 ((= char ?\C-\\)
|
|
98 (delete-region (point) (1+ (point)))
|
|
99 (insert "\\C-\\\\"))
|
|
100 ((< char 32)
|
|
101 (delete-region (point) (1+ (point)))
|
|
102 (insert "\\C-" (+ 64 char)))
|
|
103 ((< char 127)
|
|
104 (forward-char 1))
|
|
105 ((= char 127)
|
|
106 (delete-region (point) (1+ (point)))
|
|
107 (insert "\\C-?"))
|
|
108 ((= char 128)
|
|
109 (delete-region (point) (1+ (point)))
|
|
110 (insert "\\M-\\C-@"))
|
|
111 ((= char (aref "\M-\C-\\" 0))
|
|
112 (delete-region (point) (1+ (point)))
|
|
113 (insert "\\M-\\C-\\\\"))
|
|
114 ((< char 155)
|
|
115 (delete-region (point) (1+ (point)))
|
|
116 (insert "\\M-\\C-" (- char 32)))
|
|
117 ((< char 160)
|
|
118 (delete-region (point) (1+ (point)))
|
|
119 (insert "\\M-\\C-" (- char 64)))
|
|
120 ((= char (aref "\M-\\" 0))
|
|
121 (delete-region (point) (1+ (point)))
|
|
122 (insert "\\M-\\\\"))
|
|
123 ((< char 255)
|
|
124 (delete-region (point) (1+ (point)))
|
|
125 (insert "\\M-" (- char 128)))
|
|
126 ((= char 255)
|
|
127 (delete-region (point) (1+ (point)))
|
11170
|
128 (insert "\\M-\\C-?"))))))
|
|
129 (if (vectorp definition)
|
12923
|
130 (let ((len (length definition)) (i 0) char mods)
|
11170
|
131 (while (< i len)
|
74235
|
132 (insert (if (zerop i) ?\[ ?\s))
|
11170
|
133 (setq char (aref definition i)
|
|
134 i (1+ i))
|
95148
|
135 (if (not (numberp char))
|
|
136 (prin1 char (current-buffer))
|
|
137 (princ (prin1-char char) (current-buffer))))
|
11170
|
138 (insert ?\]))
|
|
139 (prin1 definition (current-buffer))))
|
1470
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
140 (insert ")\n")
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
141 (if keys
|
107332
|
142 (let ((keys (where-is-internal (symbol-function macroname)
|
|
143 '(keymap))))
|
1470
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
144 (while keys
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
145 (insert "(global-set-key ")
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
146 (prin1 (car keys) (current-buffer))
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
147 (insert " '")
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
148 (prin1 macroname (current-buffer))
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
149 (insert ")\n")
|
eb4043bd65ef
(insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
150 (setq keys (cdr keys)))))))
|
36
|
151
|
256
|
152 ;;;###autoload
|
36
|
153 (defun kbd-macro-query (flag)
|
|
154 "Query user during kbd macro execution.
|
217
|
155 With prefix argument, enters recursive edit, reading keyboard
|
|
156 commands even within a kbd macro. You can give different commands
|
|
157 each time the macro executes.
|
2708
|
158 Without prefix argument, asks whether to continue running the macro.
|
|
159 Your options are: \\<query-replace-map>
|
|
160 \\[act] Finish this iteration normally and continue with the next.
|
|
161 \\[skip] Skip the rest of this iteration, and start the next.
|
|
162 \\[exit] Stop the macro entirely right now.
|
|
163 \\[recenter] Redisplay the screen, then ask again.
|
|
164 \\[edit] Enter recursive edit; ask again when you exit from that."
|
36
|
165 (interactive "P")
|
15302
|
166 (or executing-kbd-macro
|
36
|
167 defining-kbd-macro
|
|
168 (error "Not defining or executing kbd macro"))
|
|
169 (if flag
|
15302
|
170 (let (executing-kbd-macro defining-kbd-macro)
|
36
|
171 (recursive-edit))
|
15302
|
172 (if (not executing-kbd-macro)
|
36
|
173 nil
|
2707
|
174 (let ((loop t)
|
|
175 (msg (substitute-command-keys
|
|
176 "Proceed with macro?\\<query-replace-map>\
|
2753
|
177 (\\[act], \\[skip], \\[exit], \\[recenter], \\[edit]) ")))
|
36
|
178 (while loop
|
15302
|
179 (let ((key (let ((executing-kbd-macro nil)
|
2707
|
180 (defining-kbd-macro nil))
|
14321
|
181 (message "%s" msg)
|
2707
|
182 (read-event)))
|
|
183 def)
|
|
184 (setq key (vector key))
|
|
185 (setq def (lookup-key query-replace-map key))
|
|
186 (cond ((eq def 'act)
|
36
|
187 (setq loop nil))
|
2707
|
188 ((eq def 'skip)
|
36
|
189 (setq loop nil)
|
15302
|
190 (setq executing-kbd-macro ""))
|
2707
|
191 ((eq def 'exit)
|
36
|
192 (setq loop nil)
|
15302
|
193 (setq executing-kbd-macro t))
|
2707
|
194 ((eq def 'recenter)
|
36
|
195 (recenter nil))
|
2707
|
196 ((eq def 'edit)
|
15302
|
197 (let (executing-kbd-macro defining-kbd-macro)
|
2707
|
198 (recursive-edit)))
|
|
199 ((eq def 'quit)
|
|
200 (setq quit-flag t))
|
|
201 (t
|
|
202 (or (eq def 'help)
|
|
203 (ding))
|
|
204 (with-output-to-temp-buffer "*Help*"
|
|
205 (princ
|
|
206 (substitute-command-keys
|
3591
|
207 "Specify how to proceed with keyboard macro execution.
|
2707
|
208 Possibilities: \\<query-replace-map>
|
|
209 \\[act] Finish this iteration normally and continue with the next.
|
|
210 \\[skip] Skip the rest of this iteration, and start the next.
|
|
211 \\[exit] Stop the macro entirely right now.
|
|
212 \\[recenter] Redisplay the screen, then ask again.
|
9851
|
213 \\[edit] Enter recursive edit; ask again when you exit from that."))
|
105994
|
214 (with-current-buffer standard-output
|
9851
|
215 (help-mode)))))))))))
|
256
|
216
|
268
|
217 ;;;###autoload
|
273
|
218 (defun apply-macro-to-region-lines (top bottom &optional macro)
|
56857
be5ab1230982
(apply-macro-to-region-lines): Make it operate on all lines that begin
Luc Teirlinck <teirllm@auburn.edu>
diff
changeset
|
219 "Apply last keyboard macro to all lines in the region.
|
be5ab1230982
(apply-macro-to-region-lines): Make it operate on all lines that begin
Luc Teirlinck <teirllm@auburn.edu>
diff
changeset
|
220 For each line that begins in the region, move to the beginning of
|
be5ab1230982
(apply-macro-to-region-lines): Make it operate on all lines that begin
Luc Teirlinck <teirllm@auburn.edu>
diff
changeset
|
221 the line, and run the last keyboard macro.
|
273
|
222
|
|
223 When called from lisp, this function takes two arguments TOP and
|
|
224 BOTTOM, describing the current region. TOP must be before BOTTOM.
|
|
225 The optional third argument MACRO specifies a keyboard macro to
|
|
226 execute.
|
|
227
|
|
228 This is useful for quoting or unquoting included text, adding and
|
|
229 removing comments, or producing tables where the entries are regular.
|
|
230
|
|
231 For example, in Usenet articles, sections of text quoted from another
|
|
232 author are indented, or have each line start with `>'. To quote a
|
|
233 section of text, define a keyboard macro which inserts `>', put point
|
|
234 and mark at opposite ends of the quoted section, and use
|
|
235 `\\[apply-macro-to-region-lines]' to mark the entire section.
|
|
236
|
|
237 Suppose you wanted to build a keyword table in C where each entry
|
|
238 looked like this:
|
|
239
|
49597
|
240 { \"foo\", foo_data, foo_function },
|
273
|
241 { \"bar\", bar_data, bar_function },
|
|
242 { \"baz\", baz_data, baz_function },
|
|
243
|
|
244 You could enter the names in this format:
|
|
245
|
|
246 foo
|
|
247 bar
|
|
248 baz
|
|
249
|
|
250 and write a macro to massage a word into a table entry:
|
|
251
|
|
252 \\C-x (
|
|
253 \\M-d { \"\\C-y\", \\C-y_data, \\C-y_function },
|
|
254 \\C-x )
|
|
255
|
|
256 and then select the region of un-tablified names and use
|
56857
be5ab1230982
(apply-macro-to-region-lines): Make it operate on all lines that begin
Luc Teirlinck <teirllm@auburn.edu>
diff
changeset
|
257 `\\[apply-macro-to-region-lines]' to build the table from the names."
|
273
|
258 (interactive "r")
|
391
|
259 (or macro
|
|
260 (progn
|
|
261 (if (null last-kbd-macro)
|
38412
|
262 (error "No keyboard macro has been defined"))
|
391
|
263 (setq macro last-kbd-macro)))
|
273
|
264 (save-excursion
|
56857
be5ab1230982
(apply-macro-to-region-lines): Make it operate on all lines that begin
Luc Teirlinck <teirllm@auburn.edu>
diff
changeset
|
265 (let ((end-marker (copy-marker bottom))
|
427
|
266 next-line-marker)
|
273
|
267 (goto-char top)
|
|
268 (if (not (bolp))
|
|
269 (forward-line 1))
|
427
|
270 (setq next-line-marker (point-marker))
|
|
271 (while (< next-line-marker end-marker)
|
|
272 (goto-char next-line-marker)
|
274
|
273 (save-excursion
|
427
|
274 (forward-line 1)
|
|
275 (set-marker next-line-marker (point)))
|
|
276 (save-excursion
|
47352
|
277 (let ((mark-active nil))
|
107082
|
278 (execute-kbd-macro macro))))
|
427
|
279 (set-marker end-marker nil)
|
|
280 (set-marker next-line-marker nil))))
|
273
|
281
|
5307
|
282 ;;;###autoload (define-key ctl-x-map "q" 'kbd-macro-query)
|
659
|
283
|
18383
|
284 (provide 'macros)
|
|
285
|
93975
|
286 ;; arch-tag: 346ed1a5-1220-4bc8-b533-961ee704361f
|
659
|
287 ;;; macros.el ends here
|