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