Commit | Line | Data |
---|---|---|
6594deb0 ER |
1 | ;;; macros.el --- non-primitive commands for keyboard macros. |
2 | ||
45ca32a6 | 3 | ;; Copyright (C) 1985, 1986, 1987, 1992 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 | |
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. | |
23 | ||
e41b2db1 ER |
24 | ;;; Commentary: |
25 | ||
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. | |
30 | ||
e5167999 | 31 | ;;; Code: |
a2535589 | 32 | |
7229064d | 33 | ;;;###autoload |
a2535589 JA |
34 | (defun name-last-kbd-macro (symbol) |
35 | "Assign a name to the last keyboard macro defined. | |
ac5b56bc | 36 | Argument SYMBOL is the name to define. |
a2535589 | 37 | The symbol's function definition becomes the keyboard macro string. |
540671f3 | 38 | Such a \"function\" cannot be called from Lisp, but it is a valid editor command." |
a2535589 JA |
39 | (interactive "SName for last kbd macro: ") |
40 | (or last-kbd-macro | |
41 | (error "No keyboard macro defined")) | |
42 | (and (fboundp symbol) | |
43 | (not (stringp (symbol-function symbol))) | |
44 | (error "Function %s is already defined and not a keyboard macro." | |
45 | symbol)) | |
46 | (fset symbol last-kbd-macro)) | |
47 | ||
7229064d | 48 | ;;;###autoload |
a2535589 JA |
49 | (defun insert-kbd-macro (macroname &optional keys) |
50 | "Insert in buffer the definition of kbd macro NAME, as Lisp code. | |
540671f3 | 51 | Optional second arg KEYS means also record the keys it is on |
b4b3b736 | 52 | \(this is the prefix argument, when calling interactively). |
a2535589 | 53 | |
540671f3 RS |
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 | |
58 | bindings. | |
a2535589 | 59 | |
b4b3b736 | 60 | To save a kbd macro, visit a file of Lisp code such as your `~/.emacs', |
a2535589 JA |
61 | use this command, and then save the file." |
62 | (interactive "CInsert kbd macro (name): \nP") | |
45ca32a6 RS |
63 | (let (definition) |
64 | (if (string= (symbol-name macroname) "") | |
65 | (progn | |
66 | (setq macroname 'last-kbd-macro definition last-kbd-macro) | |
67 | (insert "(setq ")) | |
68 | (setq definition (symbol-function macroname)) | |
69 | (insert "(fset '")) | |
70 | (prin1 macroname (current-buffer)) | |
71 | (insert "\n ") | |
72 | (let ((beg (point)) end) | |
73 | (prin1 definition (current-buffer)) | |
74 | (setq end (point-marker)) | |
75 | (goto-char beg) | |
76 | (while (< (point) end) | |
77 | (let ((char (following-char))) | |
78 | (cond ((< char 32) | |
79 | (delete-region (point) (1+ (point))) | |
80 | (insert "\\C-" (+ 96 char))) | |
81 | ((< char 127) | |
82 | (forward-char 1)) | |
83 | ((= char 127) | |
84 | (delete-region (point) (1+ (point))) | |
85 | (insert "\\C-?")) | |
86 | ((< char 160) | |
87 | (delete-region (point) (1+ (point))) | |
88 | (insert "\\M-C-" (- char 32))) | |
89 | ((< char 255) | |
90 | (delete-region (point) (1+ (point))) | |
91 | (insert "\\M-" (- char 128))) | |
92 | ((= char 255) | |
93 | (delete-region (point) (1+ (point))) | |
94 | (insert "\\M-C-?")))))) | |
95 | (insert ")\n") | |
96 | (if keys | |
97 | (let ((keys (where-is-internal macroname nil))) | |
98 | (while keys | |
99 | (insert "(global-set-key ") | |
100 | (prin1 (car keys) (current-buffer)) | |
101 | (insert " '") | |
102 | (prin1 macroname (current-buffer)) | |
103 | (insert ")\n") | |
104 | (setq keys (cdr keys))))))) | |
a2535589 | 105 | |
7229064d | 106 | ;;;###autoload |
a2535589 JA |
107 | (defun kbd-macro-query (flag) |
108 | "Query user during kbd macro execution. | |
540671f3 RS |
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. | |
ba790870 RS |
112 | Without prefix argument, asks whether to continue running the macro. |
113 | Your options are: \\<query-replace-map> | |
114 | \\[act] Finish this iteration normally and continue with the next. | |
115 | \\[skip] Skip the rest of this iteration, and start the next. | |
116 | \\[exit] Stop the macro entirely right now. | |
117 | \\[recenter] Redisplay the screen, then ask again. | |
118 | \\[edit] Enter recursive edit; ask again when you exit from that." | |
a2535589 JA |
119 | (interactive "P") |
120 | (or executing-macro | |
121 | defining-kbd-macro | |
122 | (error "Not defining or executing kbd macro")) | |
123 | (if flag | |
124 | (let (executing-macro defining-kbd-macro) | |
125 | (recursive-edit)) | |
126 | (if (not executing-macro) | |
127 | nil | |
af400c00 RS |
128 | (let ((loop t) |
129 | (msg (substitute-command-keys | |
130 | "Proceed with macro?\\<query-replace-map>\ | |
8693344e | 131 | (\\[act], \\[skip], \\[exit], \\[recenter], \\[edit]) "))) |
a2535589 | 132 | (while loop |
af400c00 RS |
133 | (let ((key (let ((executing-macro nil) |
134 | (defining-kbd-macro nil)) | |
135 | (message msg) | |
136 | (read-event))) | |
137 | def) | |
138 | (setq key (vector key)) | |
139 | (setq def (lookup-key query-replace-map key)) | |
140 | (cond ((eq def 'act) | |
a2535589 | 141 | (setq loop nil)) |
af400c00 | 142 | ((eq def 'skip) |
a2535589 JA |
143 | (setq loop nil) |
144 | (setq executing-macro "")) | |
af400c00 | 145 | ((eq def 'exit) |
a2535589 JA |
146 | (setq loop nil) |
147 | (setq executing-macro t)) | |
af400c00 | 148 | ((eq def 'recenter) |
a2535589 | 149 | (recenter nil)) |
af400c00 | 150 | ((eq def 'edit) |
a2535589 | 151 | (let (executing-macro defining-kbd-macro) |
af400c00 RS |
152 | (recursive-edit))) |
153 | ((eq def 'quit) | |
154 | (setq quit-flag t)) | |
155 | (t | |
156 | (or (eq def 'help) | |
157 | (ding)) | |
158 | (with-output-to-temp-buffer "*Help*" | |
159 | (princ | |
160 | (substitute-command-keys | |
eb8c3be9 | 161 | "Specify how to proceed with keyboard macro execution. |
af400c00 RS |
162 | Possibilities: \\<query-replace-map> |
163 | \\[act] Finish this iteration normally and continue with the next. | |
164 | \\[skip] Skip the rest of this iteration, and start the next. | |
165 | \\[exit] Stop the macro entirely right now. | |
166 | \\[recenter] Redisplay the screen, then ask again. | |
167 | \\[edit] Enter recursive edit; ask again when you exit from that.")))) | |
168 | ))))))) | |
7229064d | 169 | |
63c86e17 JB |
170 | ;;;###autoload |
171 | (defun apply-macro-to-region-lines (top bottom &optional macro) | |
bcc78bc0 JB |
172 | "For each complete line between point and mark, move to the beginning |
173 | of the line, and run the last keyboard macro. | |
63c86e17 JB |
174 | |
175 | When called from lisp, this function takes two arguments TOP and | |
176 | BOTTOM, describing the current region. TOP must be before BOTTOM. | |
177 | The optional third argument MACRO specifies a keyboard macro to | |
178 | execute. | |
179 | ||
180 | This is useful for quoting or unquoting included text, adding and | |
181 | removing comments, or producing tables where the entries are regular. | |
182 | ||
183 | For example, in Usenet articles, sections of text quoted from another | |
184 | author are indented, or have each line start with `>'. To quote a | |
185 | section of text, define a keyboard macro which inserts `>', put point | |
186 | and mark at opposite ends of the quoted section, and use | |
187 | `\\[apply-macro-to-region-lines]' to mark the entire section. | |
188 | ||
189 | Suppose you wanted to build a keyword table in C where each entry | |
190 | looked like this: | |
191 | ||
192 | { \"foo\", foo_data, foo_function }, | |
193 | { \"bar\", bar_data, bar_function }, | |
194 | { \"baz\", baz_data, baz_function }, | |
195 | ||
196 | You could enter the names in this format: | |
197 | ||
198 | foo | |
199 | bar | |
200 | baz | |
201 | ||
202 | and write a macro to massage a word into a table entry: | |
203 | ||
204 | \\C-x ( | |
205 | \\M-d { \"\\C-y\", \\C-y_data, \\C-y_function }, | |
206 | \\C-x ) | |
207 | ||
208 | and then select the region of un-tablified names and use | |
209 | `\\[apply-macro-to-region-lines]' to build the table from the names. | |
210 | " | |
211 | (interactive "r") | |
bcc78bc0 JB |
212 | (or macro |
213 | (progn | |
214 | (if (null last-kbd-macro) | |
215 | (error "No keyboard macro has been defined.")) | |
216 | (setq macro last-kbd-macro))) | |
63c86e17 JB |
217 | (save-excursion |
218 | (let ((end-marker (progn | |
219 | (goto-char bottom) | |
220 | (beginning-of-line) | |
5277487d JB |
221 | (point-marker))) |
222 | next-line-marker) | |
63c86e17 JB |
223 | (goto-char top) |
224 | (if (not (bolp)) | |
225 | (forward-line 1)) | |
5277487d JB |
226 | (setq next-line-marker (point-marker)) |
227 | (while (< next-line-marker end-marker) | |
228 | (goto-char next-line-marker) | |
3d64136f | 229 | (save-excursion |
5277487d JB |
230 | (forward-line 1) |
231 | (set-marker next-line-marker (point))) | |
232 | (save-excursion | |
233 | (execute-kbd-macro (or macro last-kbd-macro)))) | |
234 | (set-marker end-marker nil) | |
235 | (set-marker next-line-marker nil)))) | |
63c86e17 | 236 | |
73fa8346 BP |
237 | ;;;###autoload |
238 | (define-key ctl-x-map "q" 'kbd-macro-query) | |
6594deb0 ER |
239 | |
240 | ;;; macros.el ends here |