diff options
Diffstat (limited to 'elpa/key-chord-20201222.2030/key-chord.el')
| -rw-r--r-- | elpa/key-chord-20201222.2030/key-chord.el | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/elpa/key-chord-20201222.2030/key-chord.el b/elpa/key-chord-20201222.2030/key-chord.el new file mode 100644 index 0000000..fc4716d --- /dev/null +++ b/elpa/key-chord-20201222.2030/key-chord.el @@ -0,0 +1,218 @@ +;;; key-chord.el --- map pairs of simultaneously pressed keys to commands -*- lexical-binding: t; -*- + +;; Copyright (C) 2003, 2005, 2008, 2012 David Andersson + +;; Author: David Andersson <l.david.andersson(at)sverige.nu> +;; Package-Requires: ((emacs "24")) +;; Package-Version: 20201222.2030 +;; Package-Commit: 7f7fd7c5bd2b996fa054779357e1566f7989e07d +;; Keywords: keyboard chord input + +;; This program is free software; you can redistribute it and/or +;; modify it under the terms of the GNU General Public License as +;; published by the Free Software Foundation; either version 2 of +;; the License, or (at your option) any later version. + +;; This program is distributed in the hope that it will be +;; useful, but WITHOUT ANY WARRANTY; without even the implied +;; warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +;; PURPOSE. See the GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public +;; License along with this program; if not, write to the Free +;; Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, +;; MA 02111-1307 USA + +;;; Commentary: + +;; This package implements support for mapping a pair of simultaneously +;; pressed keys to a command and for mapping the same key being pressed +;; twice in quick succession to a command. Such bindings are called +;; "key chords". + +;;; Code: + +(defgroup key-chord nil + "Map pairs of simultaneously pressed keys to commands." + :group 'bindings) + +(defcustom key-chord-two-keys-delay 0.1 + "Max time delay between two key press to be considered a key chord." + :type 'float) + +(defcustom key-chord-one-key-delay 0.2 + "Max time delay between two press of the same key to be considered a key chord. +This should normally be a little longer than `key-chord-two-keys-delay'." + :type 'float) + +(defcustom key-chord-in-macros t + "If nil, don't expand key chords when executing keyboard macros. + +If non-nil, expand chord sequenses in macros, but only if a +similar chord was entered during the last interactive macro +recording. (This carries a bit of guesswork. We can't know for +sure when executing whether two keys were typed quickly or slowly +when recorded.)" + :type 'boolean) + +;; Internal vars +(defvar key-chord-mode nil) + +;; Shortcut for key-chord-input-method: no need to test a key again if it +;; didn't matched a chord the last time. Improves feedback during autorepeat. +(defvar key-chord-last-unmatched nil) + +;; Macro heuristics: Keep track of which chords was used when the last macro +;; was defined. Or rather, only the first-char of the chords. Only expand +;; matching chords during macro execution. +(defvar key-chord-in-last-kbd-macro nil) +(defvar key-chord-defining-kbd-macro nil) + +;;;###autoload +(define-minor-mode key-chord-mode + "Map pairs of simultaneously pressed keys to commands. + +See functions `key-chord-define-global', `key-chord-define-local', +and `key-chord-define' and variables `key-chord-two-keys-delay' +and `key-chord-one-key-delay'." + :global t + (setq input-method-function + (and key-chord-mode + 'key-chord-input-method))) + +;;;###autoload +(defun key-chord-define-global (keys command) + "Define a key-chord of the two keys in KEYS starting a COMMAND. + +KEYS can be a string or a vector of two elements. Currently only +elements that corresponds to ascii codes in the range 32 to 126 +can be used. + +COMMAND can be an interactive function, a string, or nil. +If COMMAND is nil, the key-chord is removed. + +Note that KEYS defined locally in the current buffer will have +precedence." + (interactive "sSet key chord globally (2 keys): \nCSet chord \"%s\" to command: ") + (key-chord-define (current-global-map) keys command)) + +;;;###autoload +(defun key-chord-define-local (keys command) + "Locally define a key-chord of the two keys in KEYS starting a COMMAND. + +KEYS can be a string or a vector of two elements. Currently only +elements that corresponds to ascii codes in the range 32 to 126 +can be used. + +COMMAND can be an interactive function, a string, or nil. +If COMMAND is nil, the key-chord is removed. + +The binding goes in the current buffer's local map, which in most +cases is shared with all other buffers in the same major mode." + (interactive "sSet key chord locally (2 keys): \nCSet chord \"%s\" to command: ") + (key-chord-define (current-local-map) keys command)) + +(defun key-chord-unset-global (keys) + "Remove global key-chord of the two keys in KEYS." + (interactive "sUnset key chord globally (2 keys): ") + (key-chord-define (current-global-map) keys nil)) + +(defun key-chord-unset-local (keys) + "Remove local key-chord of the two keys in KEYS." + (interactive "sUnset key chord locally (2 keys): ") + (key-chord-define (current-local-map) keys nil)) + +;;;###autoload +(defun key-chord-define (keymap keys command) + "Define in KEYMAP, a key-chord of the two keys in KEYS starting a COMMAND. + +KEYS can be a string or a vector of two elements. Currently only +elements that corresponds to ascii codes in the range 32 to 126 +can be used. + +COMMAND can be an interactive function, a string, or nil. +If COMMAND is nil, the key-chord is removed." + (if (/= 2 (length keys)) + (error "Key-chord keys must have two elements")) + ;; Exotic chars in a string are >255 but define-key wants 128..255 + ;; for those. + (let ((key1 (logand 255 (aref keys 0))) + (key2 (logand 255 (aref keys 1)))) + (if (eq key1 key2) + (define-key keymap (vector 'key-chord key1 key2) command) + (define-key keymap (vector 'key-chord key1 key2) command) + (define-key keymap (vector 'key-chord key2 key1) command)))) + +(defun key-chord-lookup-key1 (keymap key) + "Like lookup-key but no third arg and no numeric return value." + (let ((res (lookup-key keymap key))) + (and (not (numberp res)) + res))) + +(defun key-chord-lookup-key (key) + "Lookup KEY in all current key maps." + (let ((maps (current-minor-mode-maps)) + res) + (while (and maps (not res)) + (setq res (key-chord-lookup-key1 (car maps) key)) + (setq maps (cdr maps))) + (or res + (and (current-local-map) + (key-chord-lookup-key1 (current-local-map) key)) + (key-chord-lookup-key1 (current-global-map) key)))) + +(defun key-chord-describe () + "List key chord bindings in a help buffer. + +Two key chords will be listed twice and there will be Prefix +Commands. Please ignore that." + (interactive) + (describe-bindings [key-chord])) + +(defun key-chord-input-method (first-char) + "Input method controlled by key bindings with the prefix `key-chord'." + (cond + ((and (not (eq first-char key-chord-last-unmatched)) + (key-chord-lookup-key (vector 'key-chord first-char))) + (let ((delay (if (key-chord-lookup-key + (vector 'key-chord first-char first-char)) + key-chord-one-key-delay + key-chord-two-keys-delay))) + (cond ((if executing-kbd-macro + (not (memq first-char key-chord-in-last-kbd-macro)) + (when (bound-and-true-p eldoc-mode) + (eldoc-pre-command-refresh-echo-area)) + (sit-for delay 'no-redisplay)) + (setq key-chord-last-unmatched nil) + (list first-char)) + (t ; input-pending-p + (let* ((input-method-function nil) + (next-char (read-event)) + (res (vector 'key-chord first-char next-char))) + (cond ((key-chord-lookup-key res) + (setq key-chord-defining-kbd-macro + (cons first-char key-chord-defining-kbd-macro)) + (list 'key-chord first-char next-char)) + (t ;put back next-char and return first-char + (setq unread-command-events + (cons next-char unread-command-events)) + (when (eq first-char next-char) + (setq key-chord-last-unmatched first-char)) + (list first-char)))))))) + (t ; no key-chord keymap + (setq key-chord-last-unmatched first-char) + (list first-char)))) + +(defun key-chord--start-kbd-macro (_append &optional _no-exec) + (setq key-chord-defining-kbd-macro nil)) +(advice-add 'start-kbd-macro :after #'key-chord--start-kbd-macro) + +(defun key-chord--end-kbd-macro (&optional _repeat _loopfunc) + (setq key-chord-in-last-kbd-macro key-chord-defining-kbd-macro)) +(advice-add 'end-kbd-macro :after #'key-chord--end-kbd-macro) + +(provide 'key-chord) +;; Local Variables: +;; indent-tabs-mode: nil +;; End: +;;; key-chord.el ends here |