code.delx.au - gnu-emacs/blob - lisp/macros.el

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