[nongnu] elpa/keycast c64742ee21 01/31: Initial import

[ELPA Syncer]

branch: elpa/keycast
commit c64742ee21cdfb816d33ad0574249982e5fb10e2
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>

    Initial import
---
 .gitignore |   3 +
 Makefile   |  64 +++++++++++++++++
 README.md  |   8 +++
 keycast.el | 233 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 308 insertions(+)

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000..63f7a0f847
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+/*.elc
+/*-autoloads.el
+/.config.mk
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000000..21c52fa92d
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,64 @@
+-include .config.mk
+
+PKG = keycast
+
+ELS   = $(PKG).el
+ELCS  = $(ELS:.el=.elc)
+
+DEPS  =
+
+EMACS      ?= emacs
+EMACS_ARGS ?=
+
+LOAD_PATH  ?= $(addprefix -L ../,$(DEPS))
+LOAD_PATH  += -L .
+
+all: lisp
+
+help:
+       $(info make all          - generate byte-code and autoloads)
+       $(info make lisp         - generate byte-code and autoloads)
+       $(info make clean        - remove generated files)
+       @printf "\n"
+
+lisp: $(ELCS) loaddefs
+
+loaddefs: $(PKG)-autoloads.el
+
+%.elc: %.el
+       @printf "Compiling $<\n"
+       @$(EMACS) -Q --batch $(EMACS_ARGS) $(LOAD_PATH) -f batch-byte-compile $<
+
+CLEAN  = $(ELCS) $(PKG)-autoloads.el
+
+clean:
+       @printf "Cleaning...\n"
+       @rm -rf $(CLEAN)
+
+define LOADDEFS_TMPL
+;;; $(PKG)-autoloads.el --- automatically extracted autoloads
+;;
+;;; Code:
+(add-to-list 'load-path (directory-file-name \
+(or (file-name-directory #$$) (car load-path))))
+
+;; Local Variables:
+;; version-control: never
+;; no-byte-compile: t
+;; no-update-autoloads: t
+;; End:
+;;; $(PKG)-autoloads.el ends here
+endef
+export LOADDEFS_TMPL
+#'
+
+$(PKG)-autoloads.el: $(ELS)
+       @printf "Generating $@\n"
+       @printf "%s" "$$LOADDEFS_TMPL" > $@
+       @$(EMACS) -Q --batch --eval "(progn\
+       (setq make-backup-files nil)\
+       (setq vc-handled-backends nil)\
+       (setq default-directory (file-truename default-directory))\
+       (setq generated-autoload-file (expand-file-name \"$@\"))\
+       (setq find-file-visit-truename t)\
+       (update-directory-autoloads default-directory))"
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..2fefb9b9a9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+Show current command and its key in the mode line
+=================================================
+
+This package provides Keycast mode.  Once enabled, that mode shows
+the current command and its key or mouse binding in the mode line,
+and updates them whenever another command is invoked.
+
+![screenshot](https://emacsair.me/assets/readme/keycast.png)
diff --git a/keycast.el b/keycast.el
new file mode 100644
index 0000000000..68ba39dfc3
--- /dev/null
+++ b/keycast.el
@@ -0,0 +1,233 @@
+;;; keycast.el --- Show current command and its key in the mode line  -*- 
lexical-binding: t -*-
+
+;; Copyright (C) 2018  Jonas Bernoulli
+
+;; Author: Jonas Bernoulli <jonas@bernoul.li>
+;; Homepage: https://github.com/tarsius/keycast
+
+;; Package-Requires: ((emacs "25.3"))
+
+;; This file is not part of GNU Emacs.
+
+;; This file 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 3, or (at your option)
+;; any later version.
+
+;; This file 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.
+
+;; For a full copy of the GNU General Public License
+;; see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This package provides Keycast mode.  Once enabled, that mode shows
+;; the current command and its key or mouse binding in the mode line,
+;; and updates them whenever another command is invoked.
+
+;;; Code:
+;;; Options
+
+(defgroup keycast nil
+  "Show the current command and its key binding in the mode line."
+  :group 'applications)
+
+(defcustom keycast-insert-after 'mode-line-buffer-identification
+  "The position in `mode-line-format' where `mode-line-keycast' is inserted.
+
+Enabling `keycast-mode' inserts the element `mode-line-keycast'
+into `mode-line-format' after the element specified here."
+  :group 'keycast
+  :type '(cons (choice :tag "Insert after"
+                       (const mode-line-buffer-identification)
+                       (const moody-mode-line-buffer-identification)
+                       variable
+                       sexp)
+               (boolean :tag "Remove following elements")))
+
+(defcustom keycast-remove-tail-elements t
+  "Whether enabling `keycast-mode' removes elements to the right.
+
+When this is non-nil, then enabling `keycast-mode' not only
+inserts `mode-line-keycast' into `mode-line-format' but also
+removes all elements to the right of where that was inserted."
+  :group 'keycast
+  :type 'boolean)
+
+(defcustom keycast-window-predicate 'keycast-active-frame-bottom-right-p
+  "Whether to display the binding in the mode line of the selected window.
+
+This predicate is used while updating the mode line of a window
+to determine whether the current command and its key binding
+should be displayed in its mode line.  The function is called
+with no argument and act on `selected-window'.
+
+`moody-window-active-p'
+  Return non-nil if the temporarily selected window is the
+  active window, i.e. if it is the selected window as far
+  as the user is concerned.  Load the `moody' library to be
+  able to use this.
+
+`powerline-selected-window-active'
+  This function behaves like `moody-window-active-p', but
+  is defined in the `powerline' library.  Load that library
+  to be able to use this.
+
+`keycast-bottom-right-window-p'
+  Return non-nil if the temporarily selected window is the
+  right-most bottom window of its frame.
+
+`keycast-active-frame-bottom-right-p'
+  Return non-nil if the temporarily selected window is the
+  right-most bottom window of frame that is active as far
+  as the user is concerned.  If neither the `moody' nor
+  the `powerline' library is loaded, then behave the same
+  as `keycast-bottom-right-window-p'."
+  :group 'keycast
+  :type 'function)
+
+(defcustom keycast-separator-width 10
+  "How many spaces to insert before the key binding."
+  :group 'keycast
+  :type 'integer)
+
+(defcustom keycast-substitute-alist nil
+  "Alist used to substituted events and/or commands for display.
+
+Occationally it might be necessary to pretend you pressed another
+key than the one you actually pressed (because watchers don't
+care about your weird key bindings), or to hide certain commands
+\(such as `self-insert-command').  This option allows doing that
+and more.
+
+Each element has the form (MATCH EVENT COMMAND).  MATH is an
+event or a command.  When a command is invoked then this package
+looks for a MATCH for that.  If there is a match, then that the
+respective EVENT and COMMAND are used.  If not, then it looks
+for a MATCH for that instead.
+
+If either EVENT or COMMAND is nil, then neither the event nor
+the command is shown (regardless of the value of the other).
+Otherwise if EVENT is t then the actual event is shown, else
+it has to be a string to be shown instead.  Likewise COMMAND
+can be t to show the actual COMMAND or a symbol to be shown
+instead."
+  :group 'keycast
+  :type '(repeat
+          (list (choice :format "%{Actual event/command%}: %[Value Menu%] %v"
+                        (string  :tag "Event")
+                        (symbol  :tag "Command")
+                        (const   :tag "Lambda" t))
+                (choice :format "%{Display event%}:        %[Value Menu%] %v"
+                        (const   :tag "Omit binding" nil)
+                        (const   :tag "Use actual event" t)
+                        (string  :tag "Substitute event"))
+                (choice :format "%{Display command%}:      %[Value Menu%] %v"
+                        (const   :tag "Omit binding" nil)
+                        (const   :tag "Use actual command" t)
+                        (symbol  :tag "Substitute command")))))
+
+(defface keycast-key
+  '((t (:weight bold
+        :height 1.2
+        :background "#d5cfbf"
+        :foreground "#000000"
+       :box (:line-width -3 :style released-button))))
+  "When Keycast mode is enabled, face used for the key in the mode line."
+  :group 'keycast)
+
+(defface keycast-command '((t (:weight bold)))
+  "When Keycast mode is enabled, face used for the command in the mode line."
+  :group 'keycast)
+
+;;; Core
+
+(defvar keycast--this-command nil)
+(defvar keycast--this-command-keys nil)
+
+(defun keycast-mode-line-update ()
+  "Update mode line with current `this-command' and `this-command-keys'."
+  ;; Remember these values because the mode line update won't actually
+  ;; happen until we return to the command loop and by that time these
+  ;; values have been reset to nil.
+  (setq keycast--this-command-keys (this-command-keys))
+  (setq keycast--this-command this-command)
+  (force-mode-line-update t))
+
+(add-hook 'pre-command-hook 'keycast-mode-line-update t)
+
+(defvar keycast--removed-tail nil)
+
+;;;###autoload
+(define-minor-mode keycast-mode
+  "Show current command and its key binding in the mode line."
+  :global t
+  (if keycast-mode
+      (let ((cons (member keycast-insert-after mode-line-format)))
+        (unless cons
+          (setq keycast-mode nil)
+          (user-error "Cannot turn on %s.  %s not found in %s"
+                      'keycast-mode keycast-insert-after 'mode-line-format))
+        (cond (keycast-remove-tail-elements
+               (setq keycast--removed-tail (cdr cons))
+               (setcdr cons (list 'mode-line-keycast)))
+              (t
+               (push 'mode-line-keycast cons))))
+    (let ((cons (memq 'mode-line-keycast mode-line-format)))
+      (cond (keycast--removed-tail
+             (setcar cons (car keycast--removed-tail))
+             (setcdr cons (cdr keycast--removed-tail)))
+            (t
+             (setcar cons (cadr cons))
+             (setcdr cons (cddr cons)))))
+    (setq keycast--removed-tail nil)))
+
+(defun keycast-bottom-right-window-p ()
+  (and (window-at-side-p nil 'right)
+       (window-at-side-p nil 'bottom)))
+
+(defun keycast-active-frame-bottom-right-p ()
+  (and (keycast-bottom-right-window-p)
+       (keycast--active-frame-p)))
+
+(defun keycast--active-frame-p ()
+  (cond ((boundp 'moody--active-window)
+         (eq (window-frame) (window-frame moody--active-window)))
+        ((boundp 'powerline-selected-window)
+         (eq (window-frame) (window-frame powerline-selected-window)))
+        (t t)))
+
+(defvar mode-line-keycast
+  '(:eval
+    (and (funcall keycast-window-predicate)
+         (let* ((key (ignore-errors
+                       (key-description keycast--this-command-keys)))
+                (cmd keycast--this-command)
+                (elt (or (assoc cmd keycast-substitute-alist)
+                         (assoc key keycast-substitute-alist))))
+           (when elt
+             (pcase-let ((`(,_ ,k ,c) elt))
+               (unless (eq k t) (setq key k))
+               (unless (eq c t) (setq cmd c))))
+           (and key cmd
+                (concat
+                 (make-string keycast-separator-width ?\s)
+                 (propertize (let ((pad (max 2 (- 5 (length key)))))
+                               (concat (make-string (ceiling pad 2) ?\s) key
+                                       (make-string (floor   pad 2) ?\s)))
+                             'face 'keycast-key)
+                 (format " %s" (propertize (symbol-name cmd)
+                                           'face 'keycast-command))))))))
+
+(put 'mode-line-keycast 'risky-local-variable t)
+(make-variable-buffer-local 'mode-line-keycast)
+
+;; _
+(provide 'keycast)
+;; Local Variables:
+;; indent-tabs-mode: nil
+;; End:
+;;; keycast.el ends here