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

   1 ;;; macros.el --- non-primitive commands for keyboard macros.
   2
   3 ;; Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc.
   4
   5 ;; Maintainer: FSF
   6 ;; Keywords: abbrev
   7
   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
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  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
  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
  31 ;;; Code:
  32
  33 ;;;###autoload
  34 (defun name-last-kbd-macro (symbol)
  35   "Assign a name to the last keyboard macro defined.
  36 Argument SYMBOL is the name to define.
  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."
  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
  48 ;;;###autoload
  49 (defun insert-kbd-macro (macroname &optional keys)
  50   "Insert in buffer the definition of kbd macro NAME, as Lisp code.
  51 Optional second arg KEYS means also record the keys it is on
  52 \(this is the prefix argument, when calling interactively).
  53
  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.
  59
  60 To save a kbd macro, visit a file of Lisp code such as your `~/.emacs',
  61 use this command, and then save the file."
  62   (interactive "CInsert kbd macro (name): \nP")
  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)))))))
 105
 106 ;;;###autoload
 107 (defun kbd-macro-query (flag)
 108   "Query user during kbd macro execution.
 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.
 112   Without prefix argument, reads a character.  Your options are:
 113 Space -- execute the rest of the macro.
 114 DEL -- skip the rest of the macro; start next repetition.
 115 C-d -- skip rest of the macro and don't repeat it any more.
 116 C-r -- enter a recursive edit, then on exit ask again for a character
 117 C-l -- redisplay screen and ask again."
 118   (interactive "P")
 119   (or executing-macro
 120       defining-kbd-macro
 121       (error "Not defining or executing kbd macro"))
 122   (if flag
 123       (let (executing-macro defining-kbd-macro)
 124         (recursive-edit))
 125     (if (not executing-macro)
 126         nil
 127       (let ((loop t))
 128         (while loop
 129           (let ((char (let ((executing-macro nil)
 130                             (defining-kbd-macro nil))
 131                         (message "Proceed with macro? (Space, DEL, C-d, C-r or C-l) ")
 132                         (read-char))))
 133             (cond ((= char ? )
 134                    (setq loop nil))
 135                   ((= char ?\177)
 136                    (setq loop nil)
 137                    (setq executing-macro ""))
 138                   ((= char ?\C-d)
 139                    (setq loop nil)
 140                    (setq executing-macro t))
 141                   ((= char ?\C-l)
 142                    (recenter nil))
 143                   ((= char ?\C-r)
 144                    (let (executing-macro defining-kbd-macro)
 145                      (recursive-edit))))))))))
 146
 147 ;;;###autoload
 148 (defun apply-macro-to-region-lines (top bottom &optional macro)
 149   "For each complete line between point and mark, move to the beginning
 150 of the line, and run the last keyboard macro.
 151
 152 When called from lisp, this function takes two arguments TOP and
 153 BOTTOM, describing the current region.  TOP must be before BOTTOM.
 154 The optional third argument MACRO specifies a keyboard macro to
 155 execute.
 156
 157 This is useful for quoting or unquoting included text, adding and
 158 removing comments, or producing tables where the entries are regular.
 159
 160 For example, in Usenet articles, sections of text quoted from another
 161 author are indented, or have each line start with `>'.  To quote a
 162 section of text, define a keyboard macro which inserts `>', put point
 163 and mark at opposite ends of the quoted section, and use
 164 `\\[apply-macro-to-region-lines]' to mark the entire section.
 165
 166 Suppose you wanted to build a keyword table in C where each entry
 167 looked like this:
 168
 169     { \"foo\", foo_data, foo_function },
 170     { \"bar\", bar_data, bar_function },
 171     { \"baz\", baz_data, baz_function },
 172
 173 You could enter the names in this format:
 174
 175     foo
 176     bar
 177     baz
 178
 179 and write a macro to massage a word into a table entry:
 180
 181     \\C-x (
 182        \\M-d { \"\\C-y\", \\C-y_data, \\C-y_function },
 183     \\C-x )
 184
 185 and then select the region of un-tablified names and use
 186 `\\[apply-macro-to-region-lines]' to build the table from the names.
 187 "
 188   (interactive "r")
 189   (or macro
 190       (progn
 191         (if (null last-kbd-macro)
 192             (error "No keyboard macro has been defined."))
 193         (setq macro last-kbd-macro)))
 194   (save-excursion
 195     (let ((end-marker (progn
 196                         (goto-char bottom)
 197                         (beginning-of-line)
 198                         (point-marker)))
 199           next-line-marker)
 200       (goto-char top)
 201       (if (not (bolp))
 202           (forward-line 1))
 203       (setq next-line-marker (point-marker))
 204       (while (< next-line-marker end-marker)
 205         (goto-char next-line-marker)
 206         (save-excursion
 207           (forward-line 1)
 208           (set-marker next-line-marker (point)))
 209         (save-excursion
 210           (execute-kbd-macro (or macro last-kbd-macro))))
 211       (set-marker end-marker nil)
 212       (set-marker next-line-marker nil))))
 213
 214 ;;;###autoload
 215 (define-key ctl-x-map "q" 'kbd-macro-query)
 216
 217 ;;; macros.el ends here