new repository

1 files changed, 132 insertions, 0 deletions

diff --git a/modules/keybindings.el b/modules/keybindings.el
new file mode 100644
index 00000000..bf23ebc4
--- /dev/null
+++ b/modules/keybindings.el
@@ -0,0 +1,132 @@
+;;; keybindings --- General Keyboard Shortcuts -*- lexical-binding: t; -*-
+;; author: Craig Jennings <c@cjennings.net>
+
+;;; Commentary:
+
+;; TLDR: "C-c ?" Should bring up a helpful menu from wherever you are.
+
+;; I've created a general menu that contains commonly used applications and
+;; utilities.
+
+;; There are also helpful menus that describe common functionality from within
+;; another package, e.g., ledger. You access these with the same "C-c ? keyboard
+;; shortcut"
+
+;; Also, commonly used files should be easy to jump to. The "jump-to" keymap
+;; refers to files defined in user-constants.el.
+
+;; "Hostile Keybindings" are those that are close to keybindings I use commonly
+;; so they're easy to  hit by accident, but they have painful results. I'd
+;; rather avoid the pain by unsetting they keybindings and view an error '<key>
+;; is undefined' message. Finally, I'm providing messages to train me to use
+;; faster keybindings and provide feedback when evaluating buffers.
+
+;;; Code:
+
+
+;; ----------------------------------- Hydra -----------------------------------
+;; provides ability to create menus
+
+(use-package hydra
+  :demand t) ;; used in init, so load it now
+
+;; --------------------------------- Main Hydra --------------------------------
+;; convenience menu for commonly used apps
+
+(defhydra hydra-general (:color blue :hint nil)
+  "
+
+                                         Main Menu
+
+      ^Applications^            ^Communication^        ^Utilities^            ^Entertainment
+      ^^^^^^^^--------------------------------------------------------------------------------
+	  _f_: Feed Reader          _m_: Mu4e Email        _p_: Open Project      _r_: Play Radio
+	  _b_: Ebook Manager        _t_: Telegram          _c_: Calculator        _g_: Games Menu
+	  _F_: File Manager         _i_: IRC               _W_: World Clock
+	  _l_: Ledger Accounting    ^^                     _z_: Diff Directories
+	  _d_: Flashcard Drill      ^^                     ^^
+	  ^^                        ^^                     ^^                     _q_: quit
+\n\n
+"
+  ("q" nil)
+  ;; Applications
+  ("f" elfeed-dashboard)
+  ("b" calibredb)
+  ("F" (dirvish user-home-dir))
+  ("l" (find-file ledger-file))
+  ("d" cj/drill-start)
+
+  ;; Communication
+  ("m" mu4e)
+  ("t" telega)
+  ("i" cj/erc-start-or-switch)
+
+  ;; Utilities
+  ("p" projectile-switch-project)
+  ("c" calc)
+  ("W" world-clock)
+  ("z" ztree-diff)
+
+  ;; Entertainment
+  ("r" eradio-play)
+  ("g" hydra-games/body))
+
+(global-set-key (kbd "C-c ?") 'hydra-general/body)
+
+;; ------------------------------ Jump To Commands -----------------------------
+;; quick access for commonly used files
+
+(defvar jump-to-keymap nil "Jump-to commonly used files/directories/commands.")
+(setq jump-to-keymap (make-sparse-keymap))
+(global-set-key (kbd "C-c j") jump-to-keymap)
+(define-key jump-to-keymap (kbd "E") #'(lambda () (interactive) (find-file emacs-early-init-file)))
+(define-key jump-to-keymap (kbd "I") #'(lambda () (interactive) (find-file emacs-init-file)))
+(define-key jump-to-keymap (kbd "i") #'(lambda () (interactive) (find-file inbox-file)))
+(define-key jump-to-keymap (kbd "A") #'(lambda () (interactive) (find-file article-archive)))
+(define-key jump-to-keymap (kbd "a") #'(lambda () (interactive) (find-file article-file)))
+(define-key jump-to-keymap (kbd "c") #'(lambda () (interactive) (find-file contacts-file)))
+(define-key jump-to-keymap (kbd "s") #'(lambda () (interactive) (find-file schedule-file)))
+(define-key jump-to-keymap (kbd "m") #'(lambda () (interactive) (find-file macros-file)))
+(define-key jump-to-keymap (kbd "$") #'(lambda () (interactive) (find-file ledger-file)))
+
+;; ---------------------------- General Keybindings ----------------------------
+
+;; Avoid hostile bindings
+(global-unset-key (kbd "C-x C-f"))   ;; find-file-read-only
+(global-unset-key (kbd "C-z"))       ;; suspend-frame is accidentally hit often
+(global-unset-key (kbd "M-o"))       ;; facemenu-mode
+
+;; Add commonly-used general keybindings
+(global-set-key (kbd "C-x C-f") 'find-file)
+(global-set-key (kbd "C-c u")   'capitalize-region)
+(global-set-key (kbd "C-c f")   'link-hint-open-link-at-point)
+(global-set-key (kbd "M-*")     'calculator)
+
+;; Normally bound to ESC ESC ESC, hit ESC once to get out of unpleasant situations.
+(global-set-key (kbd "<escape>")  'keyboard-escape-quit)
+
+;; remap C-x \ to sort-lines (from remap activate-transient-input-method)
+(global-unset-key (kbd "C-x \\"))
+(global-set-key (kbd "C-x \\") 'sort-lines)
+
+;; training myself to use C-/ for undo (bound internally) as it's faster.
+(if (display-graphic-p)
+	(progn
+	  (global-unset-key (kbd "C-x u"))
+	  (define-key global-map (kbd "C-x u")
+				  #'(lambda () (interactive)
+					  (message (concat "Seriously, " user-name
+									   "? Use 'C-/'. It's faster."))))))
+
+;; evaluating a buffer should give confirmation or error.
+(defun cj/eval-buffer-with-confirmation-or-error-message ()
+  "Evaluate the buffer and display a message."
+  (interactive)
+  (let ((result (eval-buffer)))
+    (if (not (eq result 'error))
+        (message "Buffer evaluated.")
+      (message "error occurred during evaluation: %s" result))))
+(global-set-key (kbd "C-c b")   'cj/eval-buffer-with-confirmation-or-error-message)
+
+(provide 'keybindings)
+;;; keybindings.el ends here