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