branch: externals/which-key
commit 5fbdf05351e77ee62e3933c7b5f46459693bd04c
Author: Justin Burkett <jus...@burkett.cc>
Commit: Justin Burkett <jus...@burkett.cc>
Disentangle third party libraries (but keep support for now)
Add `which-key-inhibit-display-hook' to allow third-party libraries to
prevent
which-key from displaying in certain circumstances. Add
`which-key-this-command-keys-function' as a customizable variable to allow
third-party libraries to teach which-key about custom symbols they insert
into
the key sequence.
Add `which-key-evil-this-operator-p', `which-key-god-mode-self-insert-p' and
`which-key--god-mode-this-command-keys' to provide support for god-mode and
evil
using the new mechanisms.
---
which-key.el | 96 ++++++++++++++++++++++++++++++++++++++++++++----------------
1 file changed, 70 insertions(+), 26 deletions(-)
diff --git a/which-key.el b/which-key.el
index e4e5aaadde..d07c9f9d62 100644
--- a/which-key.el
+++ b/which-key.el
@@ -708,6 +708,15 @@ execution of a command, as in
\(let \(\(which-key-inhibit t\)\)
...\)")
+(defcustom which-key-inhibit-display-hook nil
+ "Hook run before display of which-key popup.
+Each function in the hook is run before displaying the which-key
+popup. If any function returns a non-nil value, the popup will
+not display."
+ :group 'which-key
+ :type 'hook
+ :version "1.0")
+
(defvar which-key-keymap-history nil
"History of keymap selections.
Used in functions like `which-key-show-keymap'.")
@@ -822,6 +831,27 @@ should be formatted as an input for `kbd'."
result)))))
;;; Third-party library support
+
+(defun which-key--this-command-keys ()
+ "Version of `this-single-command-keys' corrected for key-chords."
+ (let ((this-command-keys (this-single-command-keys)))
+ (when (and (vectorp this-command-keys)
+ (> (length this-command-keys) 0)
+ (eq (aref this-command-keys 0) 'key-chord)
+ (bound-and-true-p key-chord-mode))
+ (setq this-command-keys (this-single-command-raw-keys)))
+ this-command-keys))
+
+(defcustom which-key-this-command-keys-function 'which-key--this-command-keys
+ "Function used to retrieve current key sequence.
+The purpose of allowing this variable to be customized is to
+allow which-key to support packages that insert non-standard
+'keys' into the key sequence being read by emacs."
+ :group 'which-key
+ :type 'function
+ :version "1.0")
+
+
;;;; Evil
(defvar evil-state nil)
@@ -845,6 +875,13 @@ invalid keys."
:type 'boolean
:version "1.0")
+(defun which-key-evil-this-operator-p ()
+ (and which-key-allow-evil-operators
+ (bound-and-true-p evil-this-operator)))
+
+(add-hook 'which-key-inhibit-display-hook
+ 'which-key-evil-this-operator-p)
+
;;;; God-mode
(defvar which-key--god-mode-support-enabled nil
@@ -860,6 +897,21 @@ invalid keys."
(when (bound-and-true-p which-key-mode)
(which-key--hide-popup))))
+(defun which-key--god-mode-this-command-keys ()
+ "Version of `this-single-command-keys' corrected for god-mode."
+ (let ((this-command-keys (this-single-command-keys)))
+ (when (and which-key--god-mode-support-enabled
+ (bound-and-true-p god-local-mode)
+ (eq this-command 'god-mode-self-insert))
+ (setq this-command-keys (when which-key--god-mode-key-string
+ (kbd which-key--god-mode-key-string))))
+ this-command-keys))
+
+(defun which-key-god-mode-self-insert-p ()
+ (and which-key--god-mode-support-enabled
+ (bound-and-true-p god-local-mode)
+ (eq this-command 'god-mode-self-insert)))
+
(defun which-key-enable-god-mode-support (&optional disable)
"Enable support for god-mode if non-nil.
This is experimental, so you need to explicitly opt-in for
@@ -868,10 +920,19 @@ disable support."
(interactive "P")
(setq which-key--god-mode-support-enabled (null disable))
(if disable
- (advice-remove 'god-mode-lookup-command
- #'which-key--god-mode-lookup-command-advice)
+ (progn
+ (advice-remove 'god-mode-lookup-command
+ #'which-key--god-mode-lookup-command-advice)
+ (setq which-key-this-command-keys-function
+ 'which-key--this-command-keys)
+ (remove-hook 'which-key-inhibit-display-hook
+ 'which-key-god-mode-self-insert-p))
(advice-add 'god-mode-lookup-command :around
- #'which-key--god-mode-lookup-command-advice)))
+ #'which-key--god-mode-lookup-command-advice)
+ (setq which-key-this-command-keys-function
+ 'which-key--god-mode-this-command-keys)
+ (add-hook 'which-key-inhibit-display-hook
+ 'which-key-god-mode-self-insert-p)))
;;; Mode
@@ -2471,7 +2532,8 @@ This command is always accessible (from any prefix) if
which-key-show-early-on-C-h)
(let ((current-prefix
(butlast
- (listify-key-sequence (which-key--this-command-keys)))))
+ (listify-key-sequence
+ (funcall which-key-this-command-keys-function)))))
(which-key-reload-key-sequence current-prefix)
(if which-key-idle-secondary-delay
(which-key--start-timer which-key-idle-secondary-delay t)
@@ -2692,24 +2754,9 @@ Finally, show the buffer."
"On prefix \"%s\" which-key took %.0f ms." prefix-desc
(* 1000 (float-time (time-since start-time))))))
-(defun which-key--this-command-keys ()
- "Version of `this-single-command-keys' corrected for key-chords and
god-mode."
- (let ((this-command-keys (this-single-command-keys)))
- (when (and (vectorp this-command-keys)
- (> (length this-command-keys) 0)
- (eq (aref this-command-keys 0) 'key-chord)
- (bound-and-true-p key-chord-mode))
- (setq this-command-keys (this-single-command-raw-keys)))
- (when (and which-key--god-mode-support-enabled
- (bound-and-true-p god-local-mode)
- (eq this-command 'god-mode-self-insert))
- (setq this-command-keys (when which-key--god-mode-key-string
- (kbd which-key--god-mode-key-string))))
- this-command-keys))
-
(defun which-key--update ()
"Function run by timer to possibly trigger
`which-key--create-buffer-and-show'."
- (let ((prefix-keys (which-key--this-command-keys))
+ (let ((prefix-keys (funcall which-key-this-command-keys-function))
delay-time)
(cond ((and (> (length prefix-keys) 0)
(or (keymapp (key-binding prefix-keys))
@@ -2729,11 +2776,8 @@ Finally, show the buffer."
which-key-inhibit-regexps (key-description
prefix-keys))))
;; Do not display the popup if a command is currently being
;; executed
- (or (and which-key-allow-evil-operators
- (bound-and-true-p evil-this-operator))
- (and which-key--god-mode-support-enabled
- (bound-and-true-p god-local-mode)
- (eq this-command 'god-mode-self-insert))
+ (or (run-hook-with-args-until-success
+ 'which-key-inhibit-display-hook)
(null this-command))
(let ((max-dim (which-key--popup-max-dimensions)))
(> (min (car-safe max-dim) (cdr-safe max-dim)) 0)))
@@ -2793,7 +2837,7 @@ Finally, show the buffer."
which-key--paging-functions))
(and (< 0 (length (this-single-command-keys)))
(not (equal (which-key--current-prefix)
- (which-key--this-command-keys)))))
+ (funcall
which-key-this-command-keys-function)))))
(cancel-timer which-key--paging-timer)
(if which-key-idle-secondary-delay
;; we haven't executed a command yet so the secandary
