Commit | Line | Data |
---|---|---|
6594deb0 ER |
1 | ;;; macros.el --- non-primitive commands for keyboard macros. |
2 | ||
f8c25f1b | 3 | ;; Copyright (C) 1985, 86, 87, 92, 94, 95 Free Software Foundation, Inc. |
a2535589 | 4 | |
9750e079 | 5 | ;; Maintainer: FSF |
e9571d2a | 6 | ;; Keywords: abbrev |
9750e079 | 7 | |
a2535589 JA |
8 | ;; This file is part of GNU Emacs. |
9 | ||
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 | |
e5167999 | 12 | ;; the Free Software Foundation; either version 2, or (at your option) |
a2535589 JA |
13 | ;; any later version. |
14 | ||
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. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
a2535589 | 24 | |
e41b2db1 ER |
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 | ||
e5167999 | 32 | ;;; Code: |
a2535589 | 33 | |
7229064d | 34 | ;;;###autoload |
a2535589 JA |
35 | (defun name-last-kbd-macro (symbol) |
36 | "Assign a name to the last keyboard macro defined. | |
ac5b56bc | 37 | Argument SYMBOL is the name to define. |
a2535589 | 38 | The symbol's function definition becomes the keyboard macro string. |
540671f3 | 39 | Such a \"function\" cannot be called from Lisp, but it is a valid editor command." |
a2535589 JA |
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))) | |
4dc7458e | 45 | (not (vectorp (symbol-function symbol))) |
a2535589 JA |
46 | (error "Function %s is already defined and not a keyboard macro." |
47 | symbol)) | |
a3fc4dee RS |
48 | (if (string-equal symbol "") |
49 | (error "No command name given")) | |
a2535589 JA |
50 | (fset symbol last-kbd-macro)) |
51 | ||
7229064d | 52 | ;;;###autoload |
a2535589 JA |
53 | (defun insert-kbd-macro (macroname &optional keys) |
54 | "Insert in buffer the definition of kbd macro NAME, as Lisp code. | |
540671f3 | 55 | Optional second arg KEYS means also record the keys it is on |
b4b3b736 | 56 | \(this is the prefix argument, when calling interactively). |
a2535589 | 57 | |
540671f3 RS |
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. | |
a2535589 | 63 | |
b4b3b736 | 64 | To save a kbd macro, visit a file of Lisp code such as your `~/.emacs', |
a2535589 JA |
65 | use this command, and then save the file." |
66 | (interactive "CInsert kbd macro (name): \nP") | |
45ca32a6 RS |
67 | (let (definition) |
68 | (if (string= (symbol-name macroname) "") | |
69 | (progn | |
70 | (setq macroname 'last-kbd-macro definition last-kbd-macro) | |
71 | (insert "(setq ")) | |
72 | (setq definition (symbol-function macroname)) | |
73 | (insert "(fset '")) | |
74 | (prin1 macroname (current-buffer)) | |
75 | (insert "\n ") | |
157d78ec KH |
76 | (if (stringp definition) |
77 | (let ((beg (point)) end) | |
78 | (prin1 definition (current-buffer)) | |
79 | (setq end (point-marker)) | |
80 | (goto-char beg) | |
f0653de7 RS |
81 | (while (< (point) end) |
82 | (let ((char (following-char))) | |
83 | (cond ((= char 0) | |
84 | (delete-region (point) (1+ (point))) | |
85 | (insert "\\C-@")) | |
86 | ((< char 27) | |
87 | (delete-region (point) (1+ (point))) | |
88 | (insert "\\C-" (+ 96 char))) | |
89 | ((= char ?\C-\\) | |
90 | (delete-region (point) (1+ (point))) | |
91 | (insert "\\C-\\\\")) | |
92 | ((< char 32) | |
93 | (delete-region (point) (1+ (point))) | |
94 | (insert "\\C-" (+ 64 char))) | |
95 | ((< char 127) | |
96 | (forward-char 1)) | |
97 | ((= char 127) | |
98 | (delete-region (point) (1+ (point))) | |
99 | (insert "\\C-?")) | |
100 | ((= char 128) | |
101 | (delete-region (point) (1+ (point))) | |
102 | (insert "\\M-\\C-@")) | |
103 | ((= char (aref "\M-\C-\\" 0)) | |
104 | (delete-region (point) (1+ (point))) | |
105 | (insert "\\M-\\C-\\\\")) | |
106 | ((< char 155) | |
107 | (delete-region (point) (1+ (point))) | |
108 | (insert "\\M-\\C-" (- char 32))) | |
109 | ((< char 160) | |
110 | (delete-region (point) (1+ (point))) | |
111 | (insert "\\M-\\C-" (- char 64))) | |
112 | ((= char (aref "\M-\\" 0)) | |
113 | (delete-region (point) (1+ (point))) | |
114 | (insert "\\M-\\\\")) | |
115 | ((< char 255) | |
116 | (delete-region (point) (1+ (point))) | |
117 | (insert "\\M-" (- char 128))) | |
118 | ((= char 255) | |
119 | (delete-region (point) (1+ (point))) | |
157d78ec KH |
120 | (insert "\\M-\\C-?")))))) |
121 | (if (vectorp definition) | |
07d1e73a | 122 | (let ((len (length definition)) (i 0) char mods) |
157d78ec KH |
123 | (while (< i len) |
124 | (insert (if (zerop i) ?\[ ?\ )) | |
125 | (setq char (aref definition i) | |
126 | i (1+ i)) | |
07d1e73a | 127 | (cond ((not (numberp char)) |
157d78ec | 128 | (prin1 char (current-buffer))) |
07d1e73a RS |
129 | (t |
130 | (insert "?") | |
131 | (setq mods (event-modifiers char) | |
132 | char (event-basic-type char)) | |
133 | (while mods | |
134 | (cond ((eq (car mods) 'control) | |
135 | (insert "\\C-")) | |
136 | ((eq (car mods) 'meta) | |
137 | (insert "\\M-")) | |
138 | ((eq (car mods) 'hyper) | |
139 | (insert "\\H-")) | |
140 | ((eq (car mods) 'super) | |
141 | (insert "\\s-")) | |
142 | ((eq (car mods) 'alt) | |
143 | (insert "\\A-")) | |
144 | ((and (eq (car mods) 'shift) | |
145 | (>= char ?a) | |
146 | (<= char ?z)) | |
147 | (setq char (upcase char))) | |
148 | ((eq (car mods) 'shift) | |
149 | (insert "\\S-"))) | |
150 | (setq mods (cdr mods))) | |
151 | (cond ((= char ?\\) | |
152 | (insert "\\\\")) | |
153 | ((= char 127) | |
154 | (insert "\\C-?")) | |
155 | ((< char 127) | |
156 | (insert char)) | |
157 | (t (insert "\\" (format "%o" char))))))) | |
157d78ec KH |
158 | (insert ?\])) |
159 | (prin1 definition (current-buffer)))) | |
45ca32a6 RS |
160 | (insert ")\n") |
161 | (if keys | |
16f63554 | 162 | (let ((keys (where-is-internal macroname '(keymap)))) |
45ca32a6 RS |
163 | (while keys |
164 | (insert "(global-set-key ") | |
165 | (prin1 (car keys) (current-buffer)) | |
166 | (insert " '") | |
167 | (prin1 macroname (current-buffer)) | |
168 | (insert ")\n") | |
169 | (setq keys (cdr keys))))))) | |
a2535589 | 170 | |
7229064d | 171 | ;;;###autoload |
a2535589 JA |
172 | (defun kbd-macro-query (flag) |
173 | "Query user during kbd macro execution. | |
540671f3 RS |
174 | With prefix argument, enters recursive edit, reading keyboard |
175 | commands even within a kbd macro. You can give different commands | |
176 | each time the macro executes. | |
ba790870 RS |
177 | Without prefix argument, asks whether to continue running the macro. |
178 | Your options are: \\<query-replace-map> | |
179 | \\[act] Finish this iteration normally and continue with the next. | |
180 | \\[skip] Skip the rest of this iteration, and start the next. | |
181 | \\[exit] Stop the macro entirely right now. | |
182 | \\[recenter] Redisplay the screen, then ask again. | |
183 | \\[edit] Enter recursive edit; ask again when you exit from that." | |
a2535589 JA |
184 | (interactive "P") |
185 | (or executing-macro | |
186 | defining-kbd-macro | |
187 | (error "Not defining or executing kbd macro")) | |
188 | (if flag | |
189 | (let (executing-macro defining-kbd-macro) | |
190 | (recursive-edit)) | |
191 | (if (not executing-macro) | |
192 | nil | |
af400c00 RS |
193 | (let ((loop t) |
194 | (msg (substitute-command-keys | |
195 | "Proceed with macro?\\<query-replace-map>\ | |
8693344e | 196 | (\\[act], \\[skip], \\[exit], \\[recenter], \\[edit]) "))) |
a2535589 | 197 | (while loop |
af400c00 RS |
198 | (let ((key (let ((executing-macro nil) |
199 | (defining-kbd-macro nil)) | |
8700ec61 | 200 | (message "%s" msg) |
af400c00 RS |
201 | (read-event))) |
202 | def) | |
203 | (setq key (vector key)) | |
204 | (setq def (lookup-key query-replace-map key)) | |
205 | (cond ((eq def 'act) | |
a2535589 | 206 | (setq loop nil)) |
af400c00 | 207 | ((eq def 'skip) |
a2535589 JA |
208 | (setq loop nil) |
209 | (setq executing-macro "")) | |
af400c00 | 210 | ((eq def 'exit) |
a2535589 JA |
211 | (setq loop nil) |
212 | (setq executing-macro t)) | |
af400c00 | 213 | ((eq def 'recenter) |
a2535589 | 214 | (recenter nil)) |
af400c00 | 215 | ((eq def 'edit) |
a2535589 | 216 | (let (executing-macro defining-kbd-macro) |
af400c00 RS |
217 | (recursive-edit))) |
218 | ((eq def 'quit) | |
219 | (setq quit-flag t)) | |
220 | (t | |
221 | (or (eq def 'help) | |
222 | (ding)) | |
223 | (with-output-to-temp-buffer "*Help*" | |
224 | (princ | |
225 | (substitute-command-keys | |
eb8c3be9 | 226 | "Specify how to proceed with keyboard macro execution. |
af400c00 RS |
227 | Possibilities: \\<query-replace-map> |
228 | \\[act] Finish this iteration normally and continue with the next. | |
229 | \\[skip] Skip the rest of this iteration, and start the next. | |
230 | \\[exit] Stop the macro entirely right now. | |
231 | \\[recenter] Redisplay the screen, then ask again. | |
6ec1c571 KH |
232 | \\[edit] Enter recursive edit; ask again when you exit from that.")) |
233 | (save-excursion | |
234 | (set-buffer standard-output) | |
235 | (help-mode))))))))))) | |
7229064d | 236 | |
63c86e17 JB |
237 | ;;;###autoload |
238 | (defun apply-macro-to-region-lines (top bottom &optional macro) | |
bcc78bc0 JB |
239 | "For each complete line between point and mark, move to the beginning |
240 | of the line, and run the last keyboard macro. | |
63c86e17 JB |
241 | |
242 | When called from lisp, this function takes two arguments TOP and | |
243 | BOTTOM, describing the current region. TOP must be before BOTTOM. | |
244 | The optional third argument MACRO specifies a keyboard macro to | |
245 | execute. | |
246 | ||
247 | This is useful for quoting or unquoting included text, adding and | |
248 | removing comments, or producing tables where the entries are regular. | |
249 | ||
250 | For example, in Usenet articles, sections of text quoted from another | |
251 | author are indented, or have each line start with `>'. To quote a | |
252 | section of text, define a keyboard macro which inserts `>', put point | |
253 | and mark at opposite ends of the quoted section, and use | |
254 | `\\[apply-macro-to-region-lines]' to mark the entire section. | |
255 | ||
256 | Suppose you wanted to build a keyword table in C where each entry | |
257 | looked like this: | |
258 | ||
259 | { \"foo\", foo_data, foo_function }, | |
260 | { \"bar\", bar_data, bar_function }, | |
261 | { \"baz\", baz_data, baz_function }, | |
262 | ||
263 | You could enter the names in this format: | |
264 | ||
265 | foo | |
266 | bar | |
267 | baz | |
268 | ||
269 | and write a macro to massage a word into a table entry: | |
270 | ||
271 | \\C-x ( | |
272 | \\M-d { \"\\C-y\", \\C-y_data, \\C-y_function }, | |
273 | \\C-x ) | |
274 | ||
275 | and then select the region of un-tablified names and use | |
276 | `\\[apply-macro-to-region-lines]' to build the table from the names. | |
277 | " | |
278 | (interactive "r") | |
bcc78bc0 JB |
279 | (or macro |
280 | (progn | |
281 | (if (null last-kbd-macro) | |
282 | (error "No keyboard macro has been defined.")) | |
283 | (setq macro last-kbd-macro))) | |
63c86e17 JB |
284 | (save-excursion |
285 | (let ((end-marker (progn | |
286 | (goto-char bottom) | |
287 | (beginning-of-line) | |
5277487d JB |
288 | (point-marker))) |
289 | next-line-marker) | |
63c86e17 JB |
290 | (goto-char top) |
291 | (if (not (bolp)) | |
292 | (forward-line 1)) | |
5277487d JB |
293 | (setq next-line-marker (point-marker)) |
294 | (while (< next-line-marker end-marker) | |
295 | (goto-char next-line-marker) | |
3d64136f | 296 | (save-excursion |
5277487d JB |
297 | (forward-line 1) |
298 | (set-marker next-line-marker (point))) | |
299 | (save-excursion | |
300 | (execute-kbd-macro (or macro last-kbd-macro)))) | |
301 | (set-marker end-marker nil) | |
302 | (set-marker next-line-marker nil)))) | |
63c86e17 | 303 | |
5f5d794a | 304 | ;;;###autoload (define-key ctl-x-map "q" 'kbd-macro-query) |
6594deb0 ER |
305 | |
306 | ;;; macros.el ends here |