macros.el 9.84 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; macros.el --- non-primitive commands for keyboard macros.

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1985, 1986, 1987, 1992, 1994 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: abbrev
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Joseph Arceneaux's avatar
Joseph Arceneaux committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
13 14 15 16 17 18 19 20 21 22 23
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

24 25 26 27 28 29 30
;;; Commentary:

;; Extension commands for keyboard macros.  These permit you to assign
;; a name to the last-defined keyboard macro, expand and insert the
;; lisp corresponding to a macro, query the user from within a macro,
;; or apply a macro to each line in the reason.

Eric S. Raymond's avatar
Eric S. Raymond committed
31
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
32

Roland McGrath's avatar
Roland McGrath committed
33
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
34 35
(defun name-last-kbd-macro (symbol)
  "Assign a name to the last keyboard macro defined.
36
Argument SYMBOL is the name to define.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
37
The symbol's function definition becomes the keyboard macro string.
38
Such a \"function\" cannot be called from Lisp, but it is a valid editor command."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
39 40 41 42 43
  (interactive "SName for last kbd macro: ")
  (or last-kbd-macro
      (error "No keyboard macro defined"))
  (and (fboundp symbol)
       (not (stringp (symbol-function symbol)))
44
       (not (vectorp (symbol-function symbol)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
45 46 47 48
       (error "Function %s is already defined and not a keyboard macro."
	      symbol))
  (fset symbol last-kbd-macro))

Roland McGrath's avatar
Roland McGrath committed
49
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
50 51
(defun insert-kbd-macro (macroname &optional keys)
  "Insert in buffer the definition of kbd macro NAME, as Lisp code.
52
Optional second arg KEYS means also record the keys it is on
53
\(this is the prefix argument, when calling interactively).
Joseph Arceneaux's avatar
Joseph Arceneaux committed
54

55 56 57 58 59
This Lisp code will, when executed, define the kbd macro with the same
definition it has now.  If you say to record the keys, the Lisp code
will also rebind those keys to the macro.  Only global key bindings
are recorded since executing this Lisp code always makes global
bindings.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
60

61
To save a kbd macro, visit a file of Lisp code such as your `~/.emacs',
Joseph Arceneaux's avatar
Joseph Arceneaux committed
62 63
use this command, and then save the file."
  (interactive "CInsert kbd macro (name): \nP")
64 65 66 67 68 69 70 71 72
  (let (definition)
    (if (string= (symbol-name macroname) "")
	(progn
	  (setq macroname 'last-kbd-macro definition last-kbd-macro)
	  (insert "(setq "))
      (setq definition (symbol-function macroname))
      (insert "(fset '"))
    (prin1 macroname (current-buffer))
    (insert "\n   ")
73 74 75 76 77
    (if (stringp definition)
	(let ((beg (point)) end)
	  (prin1 definition (current-buffer))
	  (setq end (point-marker))
	  (goto-char beg)
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
	  (while (< (point) end)
	    (let ((char (following-char)))
	      (cond ((= char 0)
		     (delete-region (point) (1+ (point)))
		     (insert "\\C-@"))
		    ((< char 27)
		     (delete-region (point) (1+ (point)))
		     (insert "\\C-" (+ 96 char)))
		    ((= char ?\C-\\)
		     (delete-region (point) (1+ (point)))
		     (insert "\\C-\\\\"))
		    ((< char 32)
		     (delete-region (point) (1+ (point)))
		     (insert "\\C-" (+ 64 char)))
		    ((< char 127)
		     (forward-char 1))
		    ((= char 127)
		     (delete-region (point) (1+ (point)))
		     (insert "\\C-?"))
		    ((= char 128)
		     (delete-region (point) (1+ (point)))
		     (insert "\\M-\\C-@"))
		    ((= char (aref "\M-\C-\\" 0))
		     (delete-region (point) (1+ (point)))
		     (insert "\\M-\\C-\\\\"))
		    ((< char 155)
		     (delete-region (point) (1+ (point)))
		     (insert "\\M-\\C-" (- char 32)))
		    ((< char 160)
		     (delete-region (point) (1+ (point)))
		     (insert "\\M-\\C-" (- char 64)))
		    ((= char (aref "\M-\\" 0))
		     (delete-region (point) (1+ (point)))
		     (insert "\\M-\\\\"))
		    ((< char 255)
		     (delete-region (point) (1+ (point)))
		     (insert "\\M-" (- char 128)))
		    ((= char 255)
		     (delete-region (point) (1+ (point)))
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
		     (insert "\\M-\\C-?"))))))
      (if (vectorp definition)
	  (let ((len (length definition)) (i 0) char)
	    (while (< i len)
	      (insert (if (zerop i) ?\[ ?\ ))
	      (setq char (aref definition i)
		    i (1+ i))
	      (cond ((not (and (wholenump char) (< char 256)))
		     (prin1 char (current-buffer)))
		    ((= char 0)
		     (insert "?\\C-@"))
		    ((< char 27)
		     (insert "?\\C-" (+ 96 char)))
		    ((= char ?\C-\\)
		     (insert "?\\C-\\\\"))
		    ((< char 32)
		     (insert "?\\C-" (+ 64 char)))
		    ((< char 127)
		     (insert ?? char))
		    ((= char 127)
		     (insert "?\\C-?"))
		    ((= char 128)
		     (insert "?\\M-\\C-@"))
		    ((= char (aref "\M-\C-\\" 0))
		     (insert "?\\M-\\C-\\\\"))
		    ((< char 155)
		     (insert "?\\M-\\C-" (- char 32)))
		    ((< char 160)
		     (insert "?\\M-\\C-" (- char 64)))
		    ((= char (aref "\M-\\" 0))
		     (insert "?\\M-\\\\"))
		    ((< char 255)
		     (insert "?\\M-" (- char 128)))
		    ((= char 255)
		     (insert "?\\M-\\C-?"))))
	    (insert ?\]))
	(prin1 definition (current-buffer))))
154 155
    (insert ")\n")
    (if keys
156
	(let ((keys (where-is-internal macroname '(keymap))))
157 158 159 160 161 162 163
	  (while keys
	    (insert "(global-set-key ")
	    (prin1 (car keys) (current-buffer))
	    (insert " '")
	    (prin1 macroname (current-buffer))
	    (insert ")\n")
	    (setq keys (cdr keys)))))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
164

Roland McGrath's avatar
Roland McGrath committed
165
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
166 167
(defun kbd-macro-query (flag)
  "Query user during kbd macro execution.
168 169 170
  With prefix argument, enters recursive edit, reading keyboard
commands even within a kbd macro.  You can give different commands
each time the macro executes.
Richard M. Stallman's avatar
Richard M. Stallman committed
171 172 173 174 175 176 177
  Without prefix argument, asks whether to continue running the macro.
Your options are: \\<query-replace-map>
\\[act]	Finish this iteration normally and continue with the next.
\\[skip]	Skip the rest of this iteration, and start the next.
\\[exit]	Stop the macro entirely right now.
\\[recenter]	Redisplay the screen, then ask again.
\\[edit]	Enter recursive edit; ask again when you exit from that."
Joseph Arceneaux's avatar
Joseph Arceneaux committed
178 179 180 181 182 183 184 185 186
  (interactive "P")
  (or executing-macro
      defining-kbd-macro
      (error "Not defining or executing kbd macro"))
  (if flag
      (let (executing-macro defining-kbd-macro)
	(recursive-edit))
    (if (not executing-macro)
	nil
187 188 189
      (let ((loop t)
	    (msg (substitute-command-keys
		  "Proceed with macro?\\<query-replace-map>\
190
 (\\[act], \\[skip], \\[exit], \\[recenter], \\[edit]) ")))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
191
	(while loop
192 193 194 195 196 197 198 199
	  (let ((key (let ((executing-macro nil)
			   (defining-kbd-macro nil))
		       (message msg)
		       (read-event)))
		def)
	    (setq key (vector key))
	    (setq def (lookup-key query-replace-map key))
	    (cond ((eq def 'act)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
200
		   (setq loop nil))
201
		  ((eq def 'skip)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
202 203
		   (setq loop nil)
		   (setq executing-macro ""))
204
		  ((eq def 'exit)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
205 206
		   (setq loop nil)
		   (setq executing-macro t))
207
		  ((eq def 'recenter)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
208
		   (recenter nil))
209
		  ((eq def 'edit)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
210
		   (let (executing-macro defining-kbd-macro)
211 212 213 214 215 216 217 218 219
		     (recursive-edit)))
		  ((eq def 'quit)
		   (setq quit-flag t))
		  (t
		   (or (eq def 'help)
		       (ding))
		   (with-output-to-temp-buffer "*Help*"
		     (princ
		      (substitute-command-keys
220
		       "Specify how to proceed with keyboard macro execution.
221 222 223 224 225
Possibilities: \\<query-replace-map>
\\[act]	Finish this iteration normally and continue with the next.
\\[skip]	Skip the rest of this iteration, and start the next.
\\[exit]	Stop the macro entirely right now.
\\[recenter]	Redisplay the screen, then ask again.
226 227 228 229
\\[edit]	Enter recursive edit; ask again when you exit from that."))
		     (save-excursion
		       (set-buffer standard-output)
		       (help-mode)))))))))))
Roland McGrath's avatar
Roland McGrath committed
230

Jim Blandy's avatar
Jim Blandy committed
231 232
;;;###autoload
(defun apply-macro-to-region-lines (top bottom &optional macro)
Jim Blandy's avatar
Jim Blandy committed
233 234
  "For each complete line between point and mark, move to the beginning
of the line, and run the last keyboard macro.
Jim Blandy's avatar
Jim Blandy committed
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272

When called from lisp, this function takes two arguments TOP and
BOTTOM, describing the current region.  TOP must be before BOTTOM.
The optional third argument MACRO specifies a keyboard macro to
execute.

This is useful for quoting or unquoting included text, adding and
removing comments, or producing tables where the entries are regular.

For example, in Usenet articles, sections of text quoted from another
author are indented, or have each line start with `>'.  To quote a
section of text, define a keyboard macro which inserts `>', put point
and mark at opposite ends of the quoted section, and use
`\\[apply-macro-to-region-lines]' to mark the entire section.

Suppose you wanted to build a keyword table in C where each entry
looked like this:

    { \"foo\", foo_data, foo_function }, 
    { \"bar\", bar_data, bar_function },
    { \"baz\", baz_data, baz_function },

You could enter the names in this format:

    foo
    bar
    baz

and write a macro to massage a word into a table entry:

    \\C-x (
       \\M-d { \"\\C-y\", \\C-y_data, \\C-y_function },
    \\C-x )

and then select the region of un-tablified names and use
`\\[apply-macro-to-region-lines]' to build the table from the names.
"
  (interactive "r")
Jim Blandy's avatar
Jim Blandy committed
273 274 275 276 277
  (or macro
      (progn
	(if (null last-kbd-macro)
	    (error "No keyboard macro has been defined."))
	(setq macro last-kbd-macro)))
Jim Blandy's avatar
Jim Blandy committed
278 279 280 281
  (save-excursion
    (let ((end-marker (progn
			(goto-char bottom)
			(beginning-of-line)
Jim Blandy's avatar
Jim Blandy committed
282 283
			(point-marker)))
	  next-line-marker)
Jim Blandy's avatar
Jim Blandy committed
284 285 286
      (goto-char top)
      (if (not (bolp))
	  (forward-line 1))
Jim Blandy's avatar
Jim Blandy committed
287 288 289
      (setq next-line-marker (point-marker))
      (while (< next-line-marker end-marker)
	(goto-char next-line-marker)
Jim Blandy's avatar
Jim Blandy committed
290
	(save-excursion
Jim Blandy's avatar
Jim Blandy committed
291 292 293 294 295 296
	  (forward-line 1)
	  (set-marker next-line-marker (point)))
	(save-excursion
	  (execute-kbd-macro (or macro last-kbd-macro))))
      (set-marker end-marker nil)
      (set-marker next-line-marker nil))))
Jim Blandy's avatar
Jim Blandy committed
297

298
;;;###autoload (define-key ctl-x-map "q" 'kbd-macro-query)
Eric S. Raymond's avatar
Eric S. Raymond committed
299 300

;;; macros.el ends here