Define key bindings in a state.
(meow-define-keys
;; state
'normal
;; bind to a command
'("a" . meow-append)
;; bind to a keymap
(cons "h" help-map)
;; bind to a keybinding
'("x" . "C-x C-x"))Similar to meow-define-keys. Define key in NORMAL state.
Similar to meow-define-keys. Define key in leader keymap.
The keymap used is the one listed in meow-keymap-alist.
By default, it is mode-specific-map.
Similar to meow-define-keys. Define key in MOTION state.
Meow will remap overwritten commands to a keybinding with HYPER modifier.
For example, if you define j as C-N , the original command on j will be bound to H-j.
A helper function that puts an indicator at the beginning of mode-line. If you want customize mode-line by hand, see `meow-indicator`.
Example usage:
(meow-setup-indicator)Return an indicator string that you can use in your `mode-line-format`.
Example usage:
(setq-default mode-line-format '((:eval (meow-indicator)) ...))Register a thing which can be used for meow-beginning/end/inner/bounds-of-thing. To bind it to a key, check variable meow-char-thing-table.
Check function’s documentation for usage examples.
Define a custom state.
Example usage:
(setq meow-paren-keymap (make-keymap))
(meow-define-state paren
"meow state for interacting with smartparens"
:lighter " [P]"
:keymap meow-paren-keymap)
;; meow-define-state creates the variable
(setq meow-cursor-type-paren 'hollow)
(meow-define-keys 'paren
'("<escape>" . meow-normal-mode)
'("l" . sp-forward-sexp)
'("h" . sp-backward-sexp)
'("j" . sp-down-sexp)
'("k" . sp-up-sexp)
'("n" . sp-forward-slurp-sexp)
'("b" . sp-forward-barf-sexp)
'("v" . sp-backward-barf-sexp)
'("c" . sp-backward-slurp-sexp)
'("u" . meow-undo))This function generates several new objects named based on the NAME parameter passed in. See the function’s docstring for a list of them.
Similarly to define-minor-mode, your last parameter to meow-define-state may be
a single lisp form that is run every time the internal minor mode is entered
and exited.
If you already have a minor mode that you just need to register with meow, then
see the documentation for the internal function meow-register-state.
Default:
((conf-mode . normal)
(fundamental-mode . normal)
(help-mode . motion)
(prog-mode . normal)
(text-mode . normal))A list of rules: each of which specifies the initial Meow state for a major mode.
Value should be a list, each item is (major-mode . init-state).
The init-state can be any state, including custom ones.
By default, Meow uses motion for special modes (in which none of
the alphabet keys trigger a `self-insert` command), and normal for
other modes. The default value aims to be general, minimal and sensible.
Default: (markdown-mode org-mode)
A list of major modes where expand feature should be disabled.
The expand feature use overlay for display,
and it may not work well with texts with inconsistent sizes.
Default:
((word . 30)
(line . 30)
(block . 30)
(find . 30)
(till . 30))The maximum numbers for expand hints of each type.
Default: 1.0
The delay before the position hint disappears.
Default:
((meow-change . meow-change-char)
(meow-kill . meow-C-k)
(meow-cancel-selection . keyboard-quit)
(meow-pop-selection . meow-pop-grab)
(meow-beacon-change . meow-beacon-change-char))Fallback behaviours for selection-only commands when there’s no selection.
Default: t
Whether to log keypad messages in minibuffer.
Default: '((?c . ?c) (?h . ?h) (?x . ?x))
Alist of keys to begin keypad translation. For instance, given the default value, pressing “c” in keypad mode will look up it’s value in the alist, and add “C-c” to the keypad.
Default: t
Whether to self-insert a key when it is undefined in the keypad. If
set to t, then pressing and undefined key in the keypad that is
bound to self insert will insert that character. If nil, then ignore
the key.
Default:
((?r . round)
(?s . square)
(?c . curly)
(?g . string)
(?e . symbol)
(?w . window)
(?b . buffer)
(?p . paragraph)
(?l . line)
(?d . defun)
(?. . sentence))Mapping from char to thing.
Used by meow-beginning-of-thing, meow-end-of-thing, meow-inner-of-thing and meow-bounds-of-thing.
Default:
((normal . "NORMAL")
(motion . "MOTION")
(keypad . "KEYPAD")
(insert . "INSERT")
(beacon . "BEACON"))A association list of state symbols to strings describing the state.
Default:
((normal . meow-normal-indicator)
(motion . meow-motion-indicator)
(keypad . meow-keypad-indicator)
(insert . meow-insert-indicator)
(beacon . meow-beacon-indicator))An association list of meow state symbols to indicator face symbols.
Default: t
Whether to display the help prompt for meow-inner/bounds/begin/end-of-thing.
Default: 0.5
The delay in seconds before popup keybinding descriptions appear.
Default: (meow-query-replace meow-query-replace-regexp)
A list of commands that meow will auto fill with grabbed content.
Default: nil
Function to use in meow-goto-line.
Nil means find the command by key binding.
Default: 1
Minimal length when collecting symbols for meow-visit.
Default: t
Whether let meow-visit display symbol regexps in a sanitized format.
Default: nil
Whether to use system clipboard.
Default: t
Whether to use KEYPAD when the result of executing kbd string is a keymap.
Default: ?m
The prefix represent M- in KEYPAD state.
Default: ?g
The prefix represent C-M- in KEYPAD state.
Default: 32 (SPC character)
The prefix represent no modifier in KEYPAD state.
Default: select
The type of selection activated by meow-expand-* commands.
Default: “H-”
The prefix string used when remapping an occupied key in MOTION state.
For examples:
"C-x C-v" will remap the occupied j to C-x C-v j. "C-M-" will remap the occupied j to C-M-j.
Association list of symbols of meow states to their corresponding mode functions.
Association list of predicates to functions.
This list is used to update the cursor type and face. The first value whose
predicate evaluates to true will have its corresponding key run. This key
should use meow--set-cursor-type and meow--set-cursor-color to update the cursor.
You may customize this list for more complex modifications to the cursor. For instance, to change the face of the insert cursor to a hollow cursor only in org-mode, use
(defun meow--update-cursor-custom ()
(progn
(meow--set-cursor-type 'hollow)
(meow--set-cursor-color 'meow-insert-cursor)))
(add-to-list 'meow-update-cursor-functions-alist
'((lambda () (and (meow-insert-mode-p)
(eq major-mode 'org-mode)))
. meow--update-cursor-custom))Note that the both the car and cdr must be functions.
However, for simple changes to the insert cursor it would be sufficient to
change the variable meow-cursor-type-insert.
Association list of symbols to their corresponding keymaps. Used
to generate meow-*-define-key helpers.
The things used by meow for marking/movement by words and symbols, respectively.
The values are ‘things’ as understood by thingatpt - symbols that will be
passed to forward-thing and bounds-of-thing-at-point, which see.
This means that they must, at minimum, have a function as the value of their
forward-op symbol property (or the function should be defined as
forward-SYMBOLNAME). This function should accept a single argument, a number
n, and should move over the next n things, in either the forward or backward
direction depending on the sign of n. Examples of such functions include
forward-word, forward-symbol and forward-sexp, which thingatpt uses for
the word, symbol and sexp things, respectively.
By customizing these variables, you can make Meow use your own definitions for
word and symbol. For example, here is how you can get word behavior closer
to Vim’s -
(defun forward-vimlike-word (&optional arg)
"Alternate `forward-word'. Essentially the same idea as Vim's 'e'."
(interactive "^p")
(setq arg (or arg 1))
(cl-destructuring-bind (sign move-func char-func)
(if (>= arg 0)
'(1 skip-syntax-forward char-after)
'(-1 skip-syntax-backward char-before))
(with-syntax-table (standard-syntax-table)
(let ((distance sign))
(while (and distance (> (abs distance) 0) (> (* arg sign) 0))
(setq distance
(when-let ((next-char (funcall char-func))
(next-syntax (char-syntax next-char)))
(cond ((eq next-syntax ?w)
(funcall move-func "w"))
((eq next-syntax ?\ )
(prog1
(funcall move-func " ")
(forward-vimlike-word sign)))
(t
(funcall move-func "^w ")))))
(setq arg (- arg sign)))
(and distance (> (abs distance) 0))))))
(put 'vimlike-word 'forward-op #'forward-vimlike-word)
(setq meow-word-thing 'vimlike-word)Meow also provides meow-kill-word and meow-backward-kill-word, versions of
kill-word and backward-kill-word that respect meow-word-thing.