annotate lisp/macros.el @ 8065:31eb7a0e2763

(jka-compr-partial-uncompress): Handle the case where LEN reaches to or past the end of the data.
author Richard M. Stallman <rms@gnu.org>
date Sun, 26 Jun 1994 16:10:41 +0000
parents cc7cd83ccf3f
children 0e1748cc2f32
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
659
505130d1ddf8 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 427
diff changeset
1 ;;; macros.el --- non-primitive commands for keyboard macros.
505130d1ddf8 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 427
diff changeset
2
7300
cc7cd83ccf3f Update copyright.
Karl Heuer <kwzh@gnu.org>
parents: 6125
diff changeset
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994 Free Software Foundation, Inc.
845
213978acbc1e entered into RCS
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 807
diff changeset
4
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 659
diff changeset
5 ;; Maintainer: FSF
2247
2c7997f249eb Add or correct keywords
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 1470
diff changeset
6 ;; Keywords: abbrev
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
7
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
8 ;; This file is part of GNU Emacs.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
9
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 659
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
13 ;; any later version.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
14
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
18 ;; GNU General Public License for more details.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
19
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
20 ;; You should have received a copy of the GNU General Public License
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
23
2307
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2247
diff changeset
24 ;;; Commentary:
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2247
diff changeset
25
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2247
diff changeset
26 ;; Extension commands for keyboard macros. These permit you to assign
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2247
diff changeset
27 ;; a name to the last-defined keyboard macro, expand and insert the
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2247
diff changeset
28 ;; lisp corresponding to a macro, query the user from within a macro,
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2247
diff changeset
29 ;; or apply a macro to each line in the reason.
10e417efb12a Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 2247
diff changeset
30
807
4f28bd14272c *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 659
diff changeset
31 ;;; Code:
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
32
256
7e4c7ef44243 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 217
diff changeset
33 ;;;###autoload
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
34 (defun name-last-kbd-macro (symbol)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
35 "Assign a name to the last keyboard macro defined.
216
2c663336acaf *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 36
diff changeset
36 Argument SYMBOL is the name to define.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
37 The symbol's function definition becomes the keyboard macro string.
217
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
38 Such a \"function\" cannot be called from Lisp, but it is a valid editor command."
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
39 (interactive "SName for last kbd macro: ")
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
40 (or last-kbd-macro
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
41 (error "No keyboard macro defined"))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
42 (and (fboundp symbol)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
43 (not (stringp (symbol-function symbol)))
4331
c75a5c7d4f39 (name-last-kbd-macro): Handle macros that are vectors.
Richard M. Stallman <rms@gnu.org>
parents: 3591
diff changeset
44 (not (vectorp (symbol-function symbol)))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
45 (error "Function %s is already defined and not a keyboard macro."
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
46 symbol))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
47 (fset symbol last-kbd-macro))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
48
256
7e4c7ef44243 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 217
diff changeset
49 ;;;###autoload
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
50 (defun insert-kbd-macro (macroname &optional keys)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
51 "Insert in buffer the definition of kbd macro NAME, as Lisp code.
217
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
52 Optional second arg KEYS means also record the keys it is on
1469
af4fe5e670f2 (insert-kbd-macro): Replace nonprinting chars with escapes.
Richard M. Stallman <rms@gnu.org>
parents: 845
diff changeset
53 \(this is the prefix argument, when calling interactively).
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
54
217
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
55 This Lisp code will, when executed, define the kbd macro with the same
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
56 definition it has now. If you say to record the keys, the Lisp code
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
57 will also rebind those keys to the macro. Only global key bindings
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
58 are recorded since executing this Lisp code always makes global
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
59 bindings.
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
60
1469
af4fe5e670f2 (insert-kbd-macro): Replace nonprinting chars with escapes.
Richard M. Stallman <rms@gnu.org>
parents: 845
diff changeset
61 To save a kbd macro, visit a file of Lisp code such as your `~/.emacs',
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
62 use this command, and then save the file."
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
63 (interactive "CInsert kbd macro (name): \nP")
1470
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
64 (let (definition)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
65 (if (string= (symbol-name macroname) "")
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
66 (progn
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
67 (setq macroname 'last-kbd-macro definition last-kbd-macro)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
68 (insert "(setq "))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
69 (setq definition (symbol-function macroname))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
70 (insert "(fset '"))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
71 (prin1 macroname (current-buffer))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
72 (insert "\n ")
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
73 (let ((beg (point)) end)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
74 (prin1 definition (current-buffer))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
75 (setq end (point-marker))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
76 (goto-char beg)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
77 (while (< (point) end)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
78 (let ((char (following-char)))
6125
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
79 (cond ((= char 0)
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
80 (delete-region (point) (1+ (point)))
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
81 (insert "\\C-@"))
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
82 ((< char 27)
1470
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
83 (delete-region (point) (1+ (point)))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
84 (insert "\\C-" (+ 96 char)))
6125
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
85 ((< char 32)
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
86 (delete-region (point) (1+ (point)))
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
87 (insert "\\C-" (+ 64 char)))
1470
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
88 ((< char 127)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
89 (forward-char 1))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
90 ((= char 127)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
91 (delete-region (point) (1+ (point)))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
92 (insert "\\C-?"))
6125
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
93 ((= char 128)
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
94 (delete-region (point) (1+ (point)))
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
95 (insert "\\M-\\C-@"))
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
96 ((< char 155)
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
97 (delete-region (point) (1+ (point)))
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
98 (insert "\\M-\\C-" (- char 32)))
1470
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
99 ((< char 160)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
100 (delete-region (point) (1+ (point)))
6125
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
101 (insert "\\M-\\C-" (- char 64)))
1470
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
102 ((< char 255)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
103 (delete-region (point) (1+ (point)))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
104 (insert "\\M-" (- char 128)))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
105 ((= char 255)
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
106 (delete-region (point) (1+ (point)))
6125
54625de47273 (insert-kbd-macro): Handle C-@, C-[, etc. properly and their meta variants too.
Richard M. Stallman <rms@gnu.org>
parents: 5773
diff changeset
107 (insert "\\M-\\C-?"))))))
1470
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
108 (insert ")\n")
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
109 (if keys
5773
54baa5a15850 (insert-kbd-macro): Pass (keymap) as KEYMAP arg to where-is-internal.
Richard M. Stallman <rms@gnu.org>
parents: 5307
diff changeset
110 (let ((keys (where-is-internal macroname '(keymap))))
1470
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
111 (while keys
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
112 (insert "(global-set-key ")
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
113 (prin1 (car keys) (current-buffer))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
114 (insert " '")
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
115 (prin1 macroname (current-buffer))
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
116 (insert ")\n")
eb4043bd65ef (insert-kbd-macros): If arg is empty, use last macro as default.
Richard M. Stallman <rms@gnu.org>
parents: 1469
diff changeset
117 (setq keys (cdr keys)))))))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
118
256
7e4c7ef44243 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 217
diff changeset
119 ;;;###autoload
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
120 (defun kbd-macro-query (flag)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
121 "Query user during kbd macro execution.
217
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
122 With prefix argument, enters recursive edit, reading keyboard
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
123 commands even within a kbd macro. You can give different commands
8977ce293397 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 216
diff changeset
124 each time the macro executes.
2708
a9d400ee1c0e Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 2707
diff changeset
125 Without prefix argument, asks whether to continue running the macro.
a9d400ee1c0e Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 2707
diff changeset
126 Your options are: \\<query-replace-map>
a9d400ee1c0e Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 2707
diff changeset
127 \\[act] Finish this iteration normally and continue with the next.
a9d400ee1c0e Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 2707
diff changeset
128 \\[skip] Skip the rest of this iteration, and start the next.
a9d400ee1c0e Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 2707
diff changeset
129 \\[exit] Stop the macro entirely right now.
a9d400ee1c0e Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 2707
diff changeset
130 \\[recenter] Redisplay the screen, then ask again.
a9d400ee1c0e Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 2707
diff changeset
131 \\[edit] Enter recursive edit; ask again when you exit from that."
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
132 (interactive "P")
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
133 (or executing-macro
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
134 defining-kbd-macro
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
135 (error "Not defining or executing kbd macro"))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
136 (if flag
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
137 (let (executing-macro defining-kbd-macro)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
138 (recursive-edit))
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
139 (if (not executing-macro)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
140 nil
2707
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
141 (let ((loop t)
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
142 (msg (substitute-command-keys
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
143 "Proceed with macro?\\<query-replace-map>\
2753
c824ba373cc2 (kbd-macro-query): Fix prompt string.
Richard M. Stallman <rms@gnu.org>
parents: 2708
diff changeset
144 (\\[act], \\[skip], \\[exit], \\[recenter], \\[edit]) ")))
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
145 (while loop
2707
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
146 (let ((key (let ((executing-macro nil)
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
147 (defining-kbd-macro nil))
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
148 (message msg)
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
149 (read-event)))
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
150 def)
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
151 (setq key (vector key))
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
152 (setq def (lookup-key query-replace-map key))
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
153 (cond ((eq def 'act)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
154 (setq loop nil))
2707
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
155 ((eq def 'skip)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
156 (setq loop nil)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
157 (setq executing-macro ""))
2707
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
158 ((eq def 'exit)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
159 (setq loop nil)
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
160 (setq executing-macro t))
2707
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
161 ((eq def 'recenter)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
162 (recenter nil))
2707
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
163 ((eq def 'edit)
36
9697c13298e5 Initial revision
Joseph Arceneaux <jla@gnu.org>
parents:
diff changeset
164 (let (executing-macro defining-kbd-macro)
2707
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
165 (recursive-edit)))
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
166 ((eq def 'quit)
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
167 (setq quit-flag t))
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
168 (t
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
169 (or (eq def 'help)
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
170 (ding))
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
171 (with-output-to-temp-buffer "*Help*"
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
172 (princ
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
173 (substitute-command-keys
3591
507f64624555 Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents: 2753
diff changeset
174 "Specify how to proceed with keyboard macro execution.
2707
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
175 Possibilities: \\<query-replace-map>
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
176 \\[act] Finish this iteration normally and continue with the next.
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
177 \\[skip] Skip the rest of this iteration, and start the next.
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
178 \\[exit] Stop the macro entirely right now.
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
179 \\[recenter] Redisplay the screen, then ask again.
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
180 \\[edit] Enter recursive edit; ask again when you exit from that."))))
4661157d5c60 (kbd-macro-query): Use query-replace-map to define answers.
Richard M. Stallman <rms@gnu.org>
parents: 2307
diff changeset
181 )))))))
256
7e4c7ef44243 *** empty log message ***
Roland McGrath <roland@gnu.org>
parents: 217
diff changeset
182
268
2dd411fe2f72 *** empty log message ***
Brian Preble <rassilon@gnu.org>
parents: 256
diff changeset
183 ;;;###autoload
273
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
184 (defun apply-macro-to-region-lines (top bottom &optional macro)
391
4b1d23627759 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 274
diff changeset
185 "For each complete line between point and mark, move to the beginning
4b1d23627759 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 274
diff changeset
186 of the line, and run the last keyboard macro.
273
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
187
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
188 When called from lisp, this function takes two arguments TOP and
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
189 BOTTOM, describing the current region. TOP must be before BOTTOM.
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
190 The optional third argument MACRO specifies a keyboard macro to
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
191 execute.
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
192
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
193 This is useful for quoting or unquoting included text, adding and
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
194 removing comments, or producing tables where the entries are regular.
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
195
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
196 For example, in Usenet articles, sections of text quoted from another
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
197 author are indented, or have each line start with `>'. To quote a
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
198 section of text, define a keyboard macro which inserts `>', put point
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
199 and mark at opposite ends of the quoted section, and use
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
200 `\\[apply-macro-to-region-lines]' to mark the entire section.
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
201
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
202 Suppose you wanted to build a keyword table in C where each entry
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
203 looked like this:
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
204
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
205 { \"foo\", foo_data, foo_function },
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
206 { \"bar\", bar_data, bar_function },
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
207 { \"baz\", baz_data, baz_function },
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
208
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
209 You could enter the names in this format:
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
210
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
211 foo
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
212 bar
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
213 baz
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
214
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
215 and write a macro to massage a word into a table entry:
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
216
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
217 \\C-x (
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
218 \\M-d { \"\\C-y\", \\C-y_data, \\C-y_function },
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
219 \\C-x )
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
220
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
221 and then select the region of un-tablified names and use
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
222 `\\[apply-macro-to-region-lines]' to build the table from the names.
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
223 "
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
224 (interactive "r")
391
4b1d23627759 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 274
diff changeset
225 (or macro
4b1d23627759 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 274
diff changeset
226 (progn
4b1d23627759 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 274
diff changeset
227 (if (null last-kbd-macro)
4b1d23627759 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 274
diff changeset
228 (error "No keyboard macro has been defined."))
4b1d23627759 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 274
diff changeset
229 (setq macro last-kbd-macro)))
273
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
230 (save-excursion
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
231 (let ((end-marker (progn
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
232 (goto-char bottom)
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
233 (beginning-of-line)
427
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
234 (point-marker)))
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
235 next-line-marker)
273
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
236 (goto-char top)
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
237 (if (not (bolp))
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
238 (forward-line 1))
427
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
239 (setq next-line-marker (point-marker))
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
240 (while (< next-line-marker end-marker)
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
241 (goto-char next-line-marker)
274
7121f18e0114 *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 273
diff changeset
242 (save-excursion
427
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
243 (forward-line 1)
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
244 (set-marker next-line-marker (point)))
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
245 (save-excursion
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
246 (execute-kbd-macro (or macro last-kbd-macro))))
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
247 (set-marker end-marker nil)
1507978a453c *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 391
diff changeset
248 (set-marker next-line-marker nil))))
273
0740875c024a *** empty log message ***
Jim Blandy <jimb@redhat.com>
parents: 268
diff changeset
249
5307
069c54e77fd1 Don't repeat at load time any bindings that are autoloaded.
Richard M. Stallman <rms@gnu.org>
parents: 4331
diff changeset
250 ;;;###autoload (define-key ctl-x-map "q" 'kbd-macro-query)
659
505130d1ddf8 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 427
diff changeset
251
505130d1ddf8 *** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents: 427
diff changeset
252 ;;; macros.el ends here