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 ER |
5 | ;; Maintainer: FSF |
6 | ||
a2535589 JA |
7 | ;; This file is part of GNU Emacs. |
8 | ||
9 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
10 | ;; it under the terms of the GNU General Public License as published by | |
e5167999 | 11 | ;; the Free Software Foundation; either version 2, or (at your option) |
a2535589 JA |
12 | ;; any later version. |
13 | ||
14 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | ;; GNU General Public License for more details. | |
18 | ||
19 | ;; You should have received a copy of the GNU General Public License | |
20 | ;; along with GNU Emacs; see the file COPYING. If not, write to | |
21 | ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
22 | ||
e5167999 | 23 | ;;; Code: |
a2535589 | 24 | |
7229064d | 25 | ;;;###autoload |
a2535589 JA |
26 | (defun name-last-kbd-macro (symbol) |
27 | "Assign a name to the last keyboard macro defined. | |
ac5b56bc | 28 | Argument SYMBOL is the name to define. |
a2535589 | 29 | The symbol's function definition becomes the keyboard macro string. |
540671f3 | 30 | Such a \"function\" cannot be called from Lisp, but it is a valid editor command." |
a2535589 JA |
31 | (interactive "SName for last kbd macro: ") |
32 | (or last-kbd-macro | |
33 | (error "No keyboard macro defined")) | |
34 | (and (fboundp symbol) | |
35 | (not (stringp (symbol-function symbol))) | |
36 | (error "Function %s is already defined and not a keyboard macro." | |
37 | symbol)) | |
38 | (fset symbol last-kbd-macro)) | |
39 | ||
7229064d | 40 | ;;;###autoload |
a2535589 JA |
41 | (defun insert-kbd-macro (macroname &optional keys) |
42 | "Insert in buffer the definition of kbd macro NAME, as Lisp code. | |
540671f3 | 43 | Optional second arg KEYS means also record the keys it is on |
b4b3b736 | 44 | \(this is the prefix argument, when calling interactively). |
a2535589 | 45 | |
540671f3 RS |
46 | This Lisp code will, when executed, define the kbd macro with the same |
47 | definition it has now. If you say to record the keys, the Lisp code | |
48 | will also rebind those keys to the macro. Only global key bindings | |
49 | are recorded since executing this Lisp code always makes global | |
50 | bindings. | |
a2535589 | 51 | |
b4b3b736 | 52 | To save a kbd macro, visit a file of Lisp code such as your `~/.emacs', |
a2535589 JA |
53 | use this command, and then save the file." |
54 | (interactive "CInsert kbd macro (name): \nP") | |
45ca32a6 RS |
55 | (let (definition) |
56 | (if (string= (symbol-name macroname) "") | |
57 | (progn | |
58 | (setq macroname 'last-kbd-macro definition last-kbd-macro) | |
59 | (insert "(setq ")) | |
60 | (setq definition (symbol-function macroname)) | |
61 | (insert "(fset '")) | |
62 | (prin1 macroname (current-buffer)) | |
63 | (insert "\n ") | |
64 | (let ((beg (point)) end) | |
65 | (prin1 definition (current-buffer)) | |
66 | (setq end (point-marker)) | |
67 | (goto-char beg) | |
68 | (while (< (point) end) | |
69 | (let ((char (following-char))) | |
70 | (cond ((< char 32) | |
71 | (delete-region (point) (1+ (point))) | |
72 | (insert "\\C-" (+ 96 char))) | |
73 | ((< char 127) | |
74 | (forward-char 1)) | |
75 | ((= char 127) | |
76 | (delete-region (point) (1+ (point))) | |
77 | (insert "\\C-?")) | |
78 | ((< char 160) | |
79 | (delete-region (point) (1+ (point))) | |
80 | (insert "\\M-C-" (- char 32))) | |
81 | ((< char 255) | |
82 | (delete-region (point) (1+ (point))) | |
83 | (insert "\\M-" (- char 128))) | |
84 | ((= char 255) | |
85 | (delete-region (point) (1+ (point))) | |
86 | (insert "\\M-C-?")))))) | |
87 | (insert ")\n") | |
88 | (if keys | |
89 | (let ((keys (where-is-internal macroname nil))) | |
90 | (while keys | |
91 | (insert "(global-set-key ") | |
92 | (prin1 (car keys) (current-buffer)) | |
93 | (insert " '") | |
94 | (prin1 macroname (current-buffer)) | |
95 | (insert ")\n") | |
96 | (setq keys (cdr keys))))))) | |
a2535589 | 97 | |
7229064d | 98 | ;;;###autoload |
a2535589 JA |
99 | (defun kbd-macro-query (flag) |
100 | "Query user during kbd macro execution. | |
540671f3 RS |
101 | With prefix argument, enters recursive edit, reading keyboard |
102 | commands even within a kbd macro. You can give different commands | |
103 | each time the macro executes. | |
104 | Without prefix argument, reads a character. Your options are: | |
105 | Space -- execute the rest of the macro. | |
106 | DEL -- skip the rest of the macro; start next repetition. | |
107 | C-d -- skip rest of the macro and don't repeat it any more. | |
108 | C-r -- enter a recursive edit, then on exit ask again for a character | |
109 | C-l -- redisplay screen and ask again." | |
a2535589 JA |
110 | (interactive "P") |
111 | (or executing-macro | |
112 | defining-kbd-macro | |
113 | (error "Not defining or executing kbd macro")) | |
114 | (if flag | |
115 | (let (executing-macro defining-kbd-macro) | |
116 | (recursive-edit)) | |
117 | (if (not executing-macro) | |
118 | nil | |
119 | (let ((loop t)) | |
120 | (while loop | |
121 | (let ((char (let ((executing-macro nil) | |
122 | (defining-kbd-macro nil)) | |
123 | (message "Proceed with macro? (Space, DEL, C-d, C-r or C-l) ") | |
124 | (read-char)))) | |
125 | (cond ((= char ? ) | |
126 | (setq loop nil)) | |
127 | ((= char ?\177) | |
128 | (setq loop nil) | |
129 | (setq executing-macro "")) | |
130 | ((= char ?\C-d) | |
131 | (setq loop nil) | |
132 | (setq executing-macro t)) | |
133 | ((= char ?\C-l) | |
134 | (recenter nil)) | |
135 | ((= char ?\C-r) | |
136 | (let (executing-macro defining-kbd-macro) | |
137 | (recursive-edit)))))))))) | |
7229064d | 138 | |
63c86e17 JB |
139 | ;;;###autoload |
140 | (defun apply-macro-to-region-lines (top bottom &optional macro) | |
bcc78bc0 JB |
141 | "For each complete line between point and mark, move to the beginning |
142 | of the line, and run the last keyboard macro. | |
63c86e17 JB |
143 | |
144 | When called from lisp, this function takes two arguments TOP and | |
145 | BOTTOM, describing the current region. TOP must be before BOTTOM. | |
146 | The optional third argument MACRO specifies a keyboard macro to | |
147 | execute. | |
148 | ||
149 | This is useful for quoting or unquoting included text, adding and | |
150 | removing comments, or producing tables where the entries are regular. | |
151 | ||
152 | For example, in Usenet articles, sections of text quoted from another | |
153 | author are indented, or have each line start with `>'. To quote a | |
154 | section of text, define a keyboard macro which inserts `>', put point | |
155 | and mark at opposite ends of the quoted section, and use | |
156 | `\\[apply-macro-to-region-lines]' to mark the entire section. | |
157 | ||
158 | Suppose you wanted to build a keyword table in C where each entry | |
159 | looked like this: | |
160 | ||
161 | { \"foo\", foo_data, foo_function }, | |
162 | { \"bar\", bar_data, bar_function }, | |
163 | { \"baz\", baz_data, baz_function }, | |
164 | ||
165 | You could enter the names in this format: | |
166 | ||
167 | foo | |
168 | bar | |
169 | baz | |
170 | ||
171 | and write a macro to massage a word into a table entry: | |
172 | ||
173 | \\C-x ( | |
174 | \\M-d { \"\\C-y\", \\C-y_data, \\C-y_function }, | |
175 | \\C-x ) | |
176 | ||
177 | and then select the region of un-tablified names and use | |
178 | `\\[apply-macro-to-region-lines]' to build the table from the names. | |
179 | " | |
180 | (interactive "r") | |
bcc78bc0 JB |
181 | (or macro |
182 | (progn | |
183 | (if (null last-kbd-macro) | |
184 | (error "No keyboard macro has been defined.")) | |
185 | (setq macro last-kbd-macro))) | |
63c86e17 JB |
186 | (save-excursion |
187 | (let ((end-marker (progn | |
188 | (goto-char bottom) | |
189 | (beginning-of-line) | |
5277487d JB |
190 | (point-marker))) |
191 | next-line-marker) | |
63c86e17 JB |
192 | (goto-char top) |
193 | (if (not (bolp)) | |
194 | (forward-line 1)) | |
5277487d JB |
195 | (setq next-line-marker (point-marker)) |
196 | (while (< next-line-marker end-marker) | |
197 | (goto-char next-line-marker) | |
3d64136f | 198 | (save-excursion |
5277487d JB |
199 | (forward-line 1) |
200 | (set-marker next-line-marker (point))) | |
201 | (save-excursion | |
202 | (execute-kbd-macro (or macro last-kbd-macro)))) | |
203 | (set-marker end-marker nil) | |
204 | (set-marker next-line-marker nil)))) | |
63c86e17 | 205 | |
73fa8346 BP |
206 | ;;;###autoload |
207 | (define-key ctl-x-map "q" 'kbd-macro-query) | |
6594deb0 ER |
208 | |
209 | ;;; macros.el ends here |