Emacs Repeat-FU

Motivation

At the time of writing, existing packages to repeat actions in emacs tend to only support repeating a single command.

An exception to this is the repeat from evil-mode which implements it's own logic for repeat, however this isn't usable outside of evil mode.

Repeat-FU allows for repeat to combine multiple edits into a single repeating action. The exact behavior for this is configurable so it can be configured to work differently depending on the users needs. This is especially well suited to modal editing, where you may wish to repeat a change or insertion elsewhere.

Usage

To use Repeat-FU you must:

• Enable repeat-fu-mode.
• Bind repeat-fu-execute to a key.

After this, calling repeat-fu-execute will repeat the last edit, the exact behavior depends on the repeat-fu-preset which allows different behavior to be used based on your preferences.

---

This example shows how Repeat-FU can be used with the default emacs configuration.

(use-package repeat-fu
  :commands (repeat-fu-mode repeat-fu-execute)
  :load-path "/path/to/repeat-fu")

(global-set-key (kbd "C-.") 'repeat-fu-execute)

;; Enable bray for "typical" editing operation.
(add-hook
 'after-change-major-mode-hook
 (lambda ()
   (when (and (not (minibufferp)) (not (derived-mode-p 'special-mode)))
     (repeat-fu-mode))))

This example shows how Repeat-FU can be used with meow.

(use-package repeat-fu
  :commands (repeat-fu-mode repeat-fu-execute)
  :load-path "/path/to/repeat-fu"

  :config
  (setq repeat-fu-preset 'meow)

  :hook
  ((meow-mode)
   .
   (lambda ()
     (when (and (not (minibufferp)) (not (derived-mode-p 'special-mode)))
       (repeat-fu-mode)
       (define-key meow-normal-state-keymap (kbd "C-'") 'repeat-fu-execute)
       (define-key meow-insert-state-keymap (kbd "C-'") 'repeat-fu-execute)))))

Customizing Commands

Command can be customized using repeat-fu-declare, this example ensures a custom save command is never repeated.

(repeat-fu-declare 'my-save-command :skip t :skip-change t)

See the doc-string below for details.

Custom Variables

repeat-fu-preset: multi

The named preset to use (as a symbol). This loads a bundled preset with the repeat-fu-preset- prefix. If you wish to define your own repeat logic, set: repeat-fu-backend P-list directly.

By convention, the following rules are followed for bundled presets.

• Any selection that uses the mouse cursor causes selection actions to be ignored as they can’t be repeated reliably.
• Undo/redo commands wont be handled as a new edit to be repeated. This means it’s possible to undo the repeat-fu-execute and repeat the action at a different location instead of repeating the undo.

repeat-fu-global-mode: t

When true, repeat-fu shares its command buffer between buffers.

repeat-fu-buffer-size: 512

Maximum number of steps to store. When nil, all commands are stored, the repeat-fu-backend is responsible for ensuring buffer doesn’t expand indefinitely.

Commands

(repeat-fu-execute ARG)

Execute stored commands. The prefix argument ARG serves as a repeat count.

(repeat-fu-copy-to-last-kbd-macro)

Copy the current repeat-fu command buffer to the last-kbd-macro variable. Then it can be called with call-last-kbd-macro, named with name-last-kbd-macro, or even saved for later use with name-last-kbd-macro

Functions

(repeat-fu-declare SYMBOLS &rest PLIST)

Support for controlling how repeat-fu handles commands.

SYMBOLS may be a symbol or list of symbols, matching command names.

The PLIST must only contain the following keys.

:skip

When non-nil, the command is ignored by repeat-fu entirely.

By default, save-buffer uses this so repeating an action never saves.

:skip-active

When non-nil, the command won't include the active-region when one of these functions was used to create it.

By default, mouse-set-region uses this so repeating an action doesn't attempt to replay the mouse-drag used for selection.

:skip-change

When non-nil, commands that change the buffer will be skipped when detecting commands to be repeated.

This is used for undo (and related undo commands), so it's possible to undo repeat-fu-execute and repeat the action elsewhere without the undo action being repeated.

This is different from :skip since undo actions can be repeated when part of multiple edits in insert mode - for presets that support this.

The values should be t, other values such as function calls to make these checks conditional may be supported in the future.

Bundled Presets

These bundled presets can be used by setting repeat-fu-preset.

'bray

Preset for Bray(experimental) modal editing.

This has matching functionality to the Meow preset.

'meow

Preset for Meow modal editing.

A preset written for meow which repeats the last edit along with selection actions preceding the edit.

Changes made in insert mode are considered a single edit. When entering insert mode changes the buffer (typically `meow-change') the events that constructed the selection are included.

This means the following is a single, repeatable action:

• Mark 3 words (`meow-next-word', `meow-expand-3').
• Change them (`meow-change', "replacement text").
• Leave insert mode (`meow-insert-exit').

The cursor can be moved elsewhere and `repeat-fu-execute' will replace 3 words at the new location.

'multi

Preset for Emacs to repeat multiple consecutive commands.

Repeats the last changing edits along with any preceding prefix arguments. Multiple calls to the same command are grouped so you can for example, repeat text insertion elsewhere.

Events creating a selection (active-region) leading up to the edit will also be repeated unless repeat runs with an active-region in which case they will be skipped.

'single

Preset for Emacs (single) repeat.

This is a very simple form of repeating. - Find the last change. - Include any prefix commands.