Commit | Line | Data |
---|---|---|
df96ab1e | 1 | ;;; repeat.el --- convenient way to repeat the previous command -*- lexical-binding: t -*- |
fd51b1bc | 2 | |
ab422c4d | 3 | ;; Copyright (C) 1998, 2001-2013 Free Software Foundation, Inc. |
fd51b1bc RS |
4 | |
5 | ;; Author: Will Mengarini <seldon@eskimo.com> | |
6 | ;; Created: Mo 02 Mar 98 | |
bd78fa1d | 7 | ;; Version: 0.51 |
0a8cbe68 | 8 | ;; Keywords: convenience, vi, repeat |
fd51b1bc RS |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
eb3fa2cf | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
fd51b1bc | 13 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
fd51b1bc | 16 | |
2be7dabc | 17 | ;; GNU Emacs is distributed in the hope that it will be useful, |
fd51b1bc RS |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
fd51b1bc RS |
24 | |
25 | ;;; Commentary: | |
26 | ||
27 | ;; Sometimes the fastest way to get something done is just to lean on a key; | |
28 | ;; moving forward through a series of words by leaning on M-f is an example. | |
e1dbe924 | 29 | ;; But 'forward-page is orthodoxly bound to C-x ], so moving forward through |
fd51b1bc RS |
30 | ;; several pages requires |
31 | ;; Loop until desired page is reached: | |
32 | ;; Hold down control key with left pinkie. | |
33 | ;; Tap <x>. | |
34 | ;; Lift left pinkie off control key. | |
35 | ;; Tap <]>. | |
36 | ;; This is a pain in the ass. | |
37 | ||
38 | ;; This package defines a command that repeats the preceding command, | |
0a8cbe68 RS |
39 | ;; whatever that was, including its arguments, whatever they were. |
40 | ;; This command is connected to the key C-x z. | |
41 | ;; To repeat the previous command once, type C-x z. | |
42 | ;; To repeat it a second time immediately after, type just z. | |
43 | ;; By typing z again and again, you can repeat the command over and over. | |
fd51b1bc RS |
44 | |
45 | ;; This works correctly inside a keyboard macro as far as recording and | |
46 | ;; playback go, but `edit-kbd-macro' gets it wrong. That shouldn't really | |
47 | ;; matter; if you need to edit something like | |
48 | ;; C-x ] ;; forward-page | |
0a8cbe68 | 49 | ;; C-x z ;; repeat |
fd51b1bc RS |
50 | ;; zz ;; self-insert-command * 2 |
51 | ;; C-x ;; Control-X-prefix | |
0a8cbe68 | 52 | ;; you can just kill the bogus final 2 lines, then duplicate the repeat line |
fd51b1bc | 53 | ;; as many times as it's really needed. Also, `edit-kbd-macro' works |
0a8cbe68 RS |
54 | ;; correctly if `repeat' is invoked through a rebinding to a single keystroke |
55 | ;; and the global variable repeat-on-final-keystroke is set to a value | |
fd51b1bc | 56 | ;; that doesn't include that keystroke. For example, the lines |
0a8cbe68 RS |
57 | ;; (global-set-key "\C-z" 'repeat) |
58 | ;; (setq repeat-on-final-keystroke "z") | |
fd51b1bc | 59 | ;; in your .emacs would allow `edit-kbd-macro' to work correctly when C-z was |
0a8cbe68 RS |
60 | ;; used in a keyboard macro to invoke `repeat', but would still allow C-x z |
61 | ;; to be used for `repeat' elsewhere. The real reason for documenting this | |
fd51b1bc RS |
62 | ;; isn't that anybody would need it for the `edit-kbd-macro' problem, but |
63 | ;; that there might be other unexpected ramifications of re-executing on | |
64 | ;; repetitions of the final keystroke, and this shows how to do workarounds. | |
65 | ||
66 | ;; If the preceding command had a prefix argument, that argument is applied | |
0a8cbe68 | 67 | ;; to the repeat command, unless the repeat command is given a new prefix |
fd51b1bc RS |
68 | ;; argument, in which case it applies that new prefix argument to the |
69 | ;; preceding command. This means a key sequence like C-u - C-x C-t can be | |
70 | ;; repeated. (It shoves the preceding line upward in the buffer.) | |
71 | ||
0a8cbe68 | 72 | ;; Here are some other key sequences with which repeat might be useful: |
fd51b1bc RS |
73 | ;; C-u - C-t [shove preceding character backward in line] |
74 | ;; C-u - M-t [shove preceding word backward in sentence] | |
75 | ;; C-x ^ enlarge-window [one line] (assuming frame has > 1 window) | |
76 | ;; C-u - C-x ^ [shrink window one line] | |
77 | ;; C-x ` next-error | |
78 | ;; C-u - C-x ` [previous error] | |
79 | ;; C-x DEL backward-kill-sentence | |
80 | ;; C-x e call-last-kbd-macro | |
81 | ;; C-x r i insert-register | |
82 | ;; C-x r t string-rectangle | |
83 | ;; C-x TAB indent-rigidly [one character] | |
84 | ;; C-u - C-x TAB [outdent rigidly one character] | |
85 | ;; C-x { shrink-window-horizontally | |
86 | ;; C-x } enlarge-window-horizontally | |
87 | ||
0a8cbe68 RS |
88 | ;; This command was first called `vi-dot', because |
89 | ;; it was inspired by the `.' command in the vi editor, | |
90 | ;; but it was renamed to make its name more meaningful. | |
fd51b1bc RS |
91 | |
92 | ;;; Code: | |
93 | ||
fd51b1bc RS |
94 | ;;;;; ************************* USER OPTIONS ************************** ;;;;; |
95 | ||
0a8cbe68 RS |
96 | (defcustom repeat-too-dangerous '(kill-this-buffer) |
97 | "Commands too dangerous to repeat with \\[repeat]." | |
9dc0cb3d RS |
98 | :group 'convenience |
99 | :type '(repeat function)) | |
fd51b1bc RS |
100 | |
101 | ;; If the last command was self-insert-command, the char to be inserted was | |
8989a920 | 102 | ;; obtained by that command from last-command-event, which has now been |
0a8cbe68 | 103 | ;; clobbered by the command sequence that invoked `repeat'. We could get it |
8989a920 | 104 | ;; from (recent-keys) & set last-command-event to that, "unclobbering" it, but |
fd51b1bc | 105 | ;; this has the disadvantage that if the user types a sequence of different |
0a8cbe68 | 106 | ;; chars then invokes repeat, only the final char will be inserted. In vi, |
fd51b1bc | 107 | ;; the dot command can reinsert the entire most-recently-inserted sequence. |
fd51b1bc | 108 | |
0a8cbe68 RS |
109 | (defvar repeat-message-function nil |
110 | "If non-nil, function used by `repeat' command to say what it's doing. | |
fd51b1bc | 111 | Message is something like \"Repeating command glorp\". |
9dc0cb3d | 112 | To disable such messages, set this variable to `ignore'. To customize |
fd51b1bc RS |
113 | display, assign a function that takes one string as an arg and displays |
114 | it however you want.") | |
115 | ||
0a8cbe68 RS |
116 | (defcustom repeat-on-final-keystroke t |
117 | "Allow `repeat' to re-execute for repeating lastchar of a key sequence. | |
118 | If this variable is t, `repeat' determines what key sequence | |
fd51b1bc RS |
119 | it was invoked by, extracts the final character of that sequence, and |
120 | re-executes as many times as that final character is hit; so for example | |
0a8cbe68 | 121 | if `repeat' is bound to C-x z, typing C-x z z z repeats the previous command |
fd51b1bc | 122 | 3 times. If this variable is a sequence of characters, then re-execution |
0a8cbe68 | 123 | only occurs if the final character by which `repeat' was invoked is a |
9dc0cb3d RS |
124 | member of that sequence. If this variable is nil, no re-execution occurs." |
125 | :group 'convenience | |
2c587104 GM |
126 | :type '(choice (const :tag "Repeat for all keys" t) |
127 | (const :tag "Don't repeat" nil) | |
128 | (sexp :tag "Repeat for specific keys"))) | |
f1180544 | 129 | |
fd51b1bc RS |
130 | ;;;;; ****************** HACKS TO THE REST OF EMACS ******************* ;;;;; |
131 | ||
132 | ;; The basic strategy is to use last-command, a variable built in to Emacs. | |
133 | ;; There are 2 issues that complicate this strategy. The first is that | |
134 | ;; last-command is given a bogus value when any kill command is executed; | |
0a8cbe68 | 135 | ;; this is done to make it easy for `yank-pop' to know that it's being invoked |
fd51b1bc | 136 | ;; after a kill command. The second is that the meaning of the command is |
0a8cbe68 | 137 | ;; often altered by the prefix arg, but although Emacs (19.34) has a |
fd51b1bc RS |
138 | ;; builtin prefix-arg specifying the arg for the next command, as well as a |
139 | ;; builtin current-prefix-arg, it has no builtin last-prefix-arg. | |
140 | ||
141 | ;; There's a builtin (this-command-keys), the return value of which could be | |
142 | ;; executed with (command-execute), but there's no (last-command-keys). | |
143 | ;; Using (last-command-keys) if it existed wouldn't be optimal, however, | |
0a8cbe68 | 144 | ;; since it would complicate checking membership in repeat-too-dangerous. |
fd51b1bc RS |
145 | |
146 | ;; It would of course be trivial to implement last-prefix-arg & | |
147 | ;; true-last-command by putting something in post-command-hook, but that | |
148 | ;; entails a performance hit; the approach taken below avoids that. | |
149 | ||
fd51b1bc RS |
150 | ;; Coping with strings of self-insert commands gets hairy when they interact |
151 | ;; with auto-filling. Most problems are eliminated by remembering what we're | |
152 | ;; self-inserting, so we only need to get it from the undo information once. | |
153 | ||
392abfd2 MR |
154 | ;; With Emacs 22.2 the variable `last-repeatable-command' stores the |
155 | ;; most recently executed command that was not bound to an input event. | |
156 | ;; `repeat' now repeats that command instead of `real-last-command' to | |
157 | ;; avoid a "... must be bound to an event with parameters" error. | |
158 | ||
0a8cbe68 | 159 | ;;;;; *************** ANALOGOUS HACKS TO `repeat' ITSELF **************** ;;;;; |
fd51b1bc RS |
160 | |
161 | ;; That mechanism of checking num-input-keys to figure out what's really | |
162 | ;; going on can be useful to other commands that need to fine-tune their | |
0a8cbe68 RS |
163 | ;; interaction with repeat. Instead of requiring them to advise repeat, we |
164 | ;; can just defvar the value they need here, & setq it in the repeat command: | |
fd51b1bc | 165 | |
0a8cbe68 RS |
166 | (defvar repeat-num-input-keys-at-repeat -1 |
167 | "# key sequences read in Emacs session when `repeat' last invoked.") | |
fd51b1bc RS |
168 | |
169 | ;; Also, we can assign a name to the test for which that variable is | |
170 | ;; intended, which thereby documents here how to use it, & makes code that | |
171 | ;; uses it self-documenting: | |
172 | ||
0a8cbe68 RS |
173 | (defsubst repeat-is-really-this-command () |
174 | "Return t if this command is happening because user invoked `repeat'. | |
fd51b1bc RS |
175 | Usually, when a command is executing, the Emacs builtin variable |
176 | `this-command' identifies the command the user invoked. Some commands modify | |
0a8cbe68 | 177 | that variable on the theory they're doing more good than harm; `repeat' does |
fd51b1bc | 178 | that, and usually does do more good than harm. However, like all do-gooders, |
0a8cbe68 | 179 | sometimes `repeat' gets surprising results from its altruism. The value of |
fd51b1bc | 180 | this function is always whether the value of `this-command' would've been |
0a8cbe68 RS |
181 | 'repeat if `repeat' hadn't modified it." |
182 | (= repeat-num-input-keys-at-repeat num-input-keys)) | |
fd51b1bc | 183 | |
0a8cbe68 | 184 | ;; An example of the use of (repeat-is-really-this-command) may still be |
fd51b1bc RS |
185 | ;; available in <http://www.eskimo.com/~seldon/dotemacs.el>; search for |
186 | ;; "defun wm-switch-buffer". | |
187 | ||
0a8cbe68 | 188 | ;;;;; ******************* THE REPEAT COMMAND ITSELF ******************* ;;;;; |
fd51b1bc | 189 | |
7d6a2ca4 DL |
190 | (defvar repeat-previous-repeated-command nil |
191 | "The previous repeated command.") | |
192 | ||
fd51b1bc | 193 | ;;;###autoload |
0a8cbe68 | 194 | (defun repeat (repeat-arg) |
fd51b1bc | 195 | "Repeat most recently executed command. |
c88b867f CY |
196 | If REPEAT-ARG is non-nil (interactively, with a prefix argument), |
197 | supply a prefix argument to that command. Otherwise, give the | |
198 | command the same prefix argument it was given before, if any. | |
fd51b1bc | 199 | |
392abfd2 MR |
200 | If this command is invoked by a multi-character key sequence, it |
201 | can then be repeated by repeating the final character of that | |
202 | sequence. This behavior can be modified by the global variable | |
203 | `repeat-on-final-keystroke'. | |
204 | ||
205 | `repeat' ignores commands bound to input events. Hence the term | |
206 | \"most recently executed command\" shall be read as \"most | |
207 | recently executed command not bound to an input event\"." | |
fd51b1bc RS |
208 | ;; The most recently executed command could be anything, so surprises could |
209 | ;; result if it were re-executed in a context where new dynamically | |
210 | ;; localized variables were shadowing global variables in a `let' clause in | |
211 | ;; here. (Remember that GNU Emacs 19 is dynamically localized.) | |
212 | ;; To avoid that, I tried the `lexical-let' of the Common Lisp extensions, | |
213 | ;; but that entails a very noticeable performance hit, so instead I use the | |
0a8cbe68 | 214 | ;; "repeat-" prefix, reserved by this package, for *local* variables that |
fd51b1bc RS |
215 | ;; might be visible to re-executed commands, including this function's arg. |
216 | (interactive "P") | |
392abfd2 MR |
217 | (when (eq last-repeatable-command 'repeat) |
218 | (setq last-repeatable-command repeat-previous-repeated-command)) | |
219 | (cond | |
220 | ((null last-repeatable-command) | |
7d6a2ca4 | 221 | (error "There is nothing to repeat")) |
392abfd2 MR |
222 | ((eq last-repeatable-command 'mode-exit) |
223 | (error "last-repeatable-command is mode-exit & can't be repeated")) | |
224 | ((memq last-repeatable-command repeat-too-dangerous) | |
225 | (error "Command %S too dangerous to repeat automatically" | |
226 | last-repeatable-command))) | |
227 | (setq this-command last-repeatable-command | |
228 | repeat-previous-repeated-command last-repeatable-command | |
229 | repeat-num-input-keys-at-repeat num-input-keys) | |
0a8cbe68 RS |
230 | (when (null repeat-arg) |
231 | (setq repeat-arg last-prefix-arg)) | |
fd51b1bc | 232 | ;; Now determine whether to loop on repeated taps of the final character |
0a8cbe68 | 233 | ;; of the key sequence that invoked repeat. The Emacs global |
8989a920 | 234 | ;; last-command-event contains the final character now, but may not still |
fd51b1bc RS |
235 | ;; contain it after the previous command is repeated, so the character |
236 | ;; needs to be saved. | |
0a8cbe68 RS |
237 | (let ((repeat-repeat-char |
238 | (if (eq repeat-on-final-keystroke t) | |
8989a920 | 239 | last-command-event |
df96ab1e | 240 | ;; Allow only specified final keystrokes. |
8989a920 | 241 | (car (memq last-command-event |
fd51b1bc | 242 | (listify-key-sequence |
0a8cbe68 | 243 | repeat-on-final-keystroke)))))) |
392abfd2 MR |
244 | (if (memq last-repeatable-command '(exit-minibuffer |
245 | minibuffer-complete-and-exit | |
246 | self-insert-and-exit)) | |
0a8cbe68 RS |
247 | (let ((repeat-command (car command-history))) |
248 | (repeat-message "Repeating %S" repeat-command) | |
249 | (eval repeat-command)) | |
250 | (if (null repeat-arg) | |
392abfd2 MR |
251 | (repeat-message "Repeating command %S" last-repeatable-command) |
252 | (setq current-prefix-arg repeat-arg) | |
253 | (repeat-message | |
254 | "Repeating command %S %S" repeat-arg last-repeatable-command)) | |
df96ab1e SM |
255 | (when (eq last-repeatable-command 'self-insert-command) |
256 | ;; We used to use a much more complex code to try and figure out | |
257 | ;; what key was used to run that self-insert-command: | |
258 | ;; (if (<= (- num-input-keys | |
259 | ;; repeat-num-input-keys-at-self-insert) | |
260 | ;; 1) | |
261 | ;; repeat-last-self-insert | |
262 | ;; (let ((range (nth 1 buffer-undo-list))) | |
263 | ;; (condition-case nil | |
264 | ;; (setq repeat-last-self-insert | |
265 | ;; (buffer-substring (car range) | |
266 | ;; (cdr range))) | |
267 | ;; (error (error "%s %s %s" ;Danger, Will Robinson! | |
268 | ;; "repeat can't intuit what you" | |
269 | ;; "inserted before auto-fill" | |
270 | ;; "clobbered it, sorry"))))) | |
271 | (setq last-command-event (char-before))) | |
272 | (let ((indirect (indirect-function last-repeatable-command))) | |
273 | (if (or (stringp indirect) | |
274 | (vectorp indirect)) | |
275 | ;; Bind last-repeatable-command so that executing the macro does | |
276 | ;; not alter it. | |
277 | (let ((last-repeatable-command last-repeatable-command)) | |
278 | (execute-kbd-macro last-repeatable-command)) | |
279 | (call-interactively last-repeatable-command)))) | |
0a8cbe68 | 280 | (when repeat-repeat-char |
8cd22a08 | 281 | (set-transient-map |
df96ab1e SM |
282 | (let ((map (make-sparse-keymap))) |
283 | (define-key map (vector repeat-repeat-char) | |
284 | (if (null repeat-message-function) 'repeat | |
285 | ;; If repeat-message-function is let-bound, preserve it for the | |
286 | ;; next "iterations of the loop". | |
287 | (let ((fun repeat-message-function)) | |
288 | (lambda () | |
289 | (interactive) | |
290 | (let ((repeat-message-function fun)) | |
291 | (setq this-command 'repeat) | |
d20d69c0 SM |
292 | ;; Beware: messing with `real-this-command' is *bad*, but we |
293 | ;; need it so `last-repeatable-command' can be recognized | |
294 | ;; later (bug#12232). | |
295 | (setq real-this-command 'repeat) | |
df96ab1e SM |
296 | (call-interactively 'repeat)))))) |
297 | map))))) | |
9dc0cb3d | 298 | |
0a8cbe68 RS |
299 | (defun repeat-message (format &rest args) |
300 | "Like `message' but displays with `repeat-message-function' if non-nil." | |
fd51b1bc | 301 | (let ((message (apply 'format format args))) |
0a8cbe68 RS |
302 | (if repeat-message-function |
303 | (funcall repeat-message-function message) | |
fd51b1bc RS |
304 | (message "%s" message)))) |
305 | ||
306 | ;; OK, there's one situation left where that doesn't work correctly: when the | |
307 | ;; most recent self-insertion provoked an auto-fill. The problem is that | |
ee7683eb | 308 | ;; unraveling the undo information after an auto-fill is too hard, since all |
fd51b1bc RS |
309 | ;; kinds of stuff can get in there as a result of comment prefixes etc. It'd |
310 | ;; be possible to advise do-auto-fill to record the most recent | |
311 | ;; self-insertion before it does its thing, but that's a performance hit on | |
312 | ;; auto-fill, which already has performance problems; so it's better to just | |
313 | ;; leave it like this. If text didn't provoke an auto-fill when the user | |
314 | ;; typed it, this'll correctly repeat its self-insertion, even if the | |
315 | ;; repetition does cause auto-fill. | |
316 | ||
317 | ;; If you wanted perfection, probably it'd be necessary to hack do-auto-fill | |
318 | ;; into 2 functions, maybe-do-auto-fill & really-do-auto-fill, because only | |
319 | ;; really-do-auto-fill should be advised. As things are, either the undo | |
320 | ;; information would need to be scanned on every do-auto-fill invocation, or | |
321 | ;; the code at the top of do-auto-fill deciding whether filling is necessary | |
322 | ;; would need to be duplicated in the advice, wasting execution time when | |
323 | ;; filling does turn out to be necessary. | |
324 | ||
325 | ;; I thought maybe this story had a moral, something about functional | |
326 | ;; decomposition; but now I'm not even sure of that, since a function | |
327 | ;; call per se is a performance hit, & even the code that would | |
328 | ;; correspond to really-do-auto-fill has performance problems that | |
329 | ;; can make it necessary to stop typing while Emacs catches up. | |
330 | ;; Maybe the real moral is that perfection is a chimera. | |
331 | ||
332 | ;; Ah, hell, it's all going to fall into a black hole someday anyway. | |
333 | ||
334 | ;;;;; ************************* EMACS CONTROL ************************* ;;;;; | |
335 | ||
0a8cbe68 | 336 | (provide 'repeat) |
fd51b1bc | 337 | |
0a8cbe68 | 338 | ;;; repeat.el ends here |