1 ;;; notmuch-jump.el --- User-friendly shortcut keys
3 ;; Copyright © Austin Clements
5 ;; This file is part of Notmuch.
7 ;; Notmuch is free software: you can redistribute it and/or modify it
8 ;; under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; Notmuch is distributed in the hope that it will be useful, but
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 ;; General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with Notmuch. If not, see <https://www.gnu.org/licenses/>.
20 ;; Authors: Austin Clements <aclements@csail.mit.edu>
21 ;; David Edmondson <dme@dme.org>
29 (require 'notmuch-lib)
30 (require 'notmuch-hello)
33 (unless (fboundp 'window-body-width)
34 ;; Compatibility for Emacs pre-24
35 (defalias 'window-body-width 'window-width)))
38 (defun notmuch-jump-search ()
39 "Jump to a saved search by shortcut key.
41 This prompts for and performs a saved search using the shortcut
42 keys configured in the :key property of `notmuch-saved-searches'.
43 Typically these shortcuts are a single key long, so this is a
44 fast way to jump to a saved search from anywhere in Notmuch."
46 ;; Build the action map
48 (dolist (saved-search notmuch-saved-searches)
49 (let* ((saved-search (notmuch-hello-saved-search-to-plist saved-search))
50 (key (plist-get saved-search :key)))
52 (let ((name (plist-get saved-search :name))
53 (query (plist-get saved-search :query))
55 (cl-case (plist-get saved-search :sort-order)
58 (otherwise (default-value 'notmuch-search-oldest-first)))))
61 ((eq (plist-get saved-search :search-type) 'tree)
62 `(lambda () (notmuch-tree ',query)))
63 ((eq (plist-get saved-search :search-type) 'unthreaded)
64 `(lambda () (notmuch-unthreaded ',query)))
66 `(lambda () (notmuch-search ',query ',oldest-first)))))
68 (setq action-map (nreverse action-map))
70 (notmuch-jump action-map "Search: ")
71 (error "To use notmuch-jump, \
72 please customize shortcut keys in notmuch-saved-searches."))))
74 (defvar notmuch-jump--action nil)
77 (defun notmuch-jump (action-map prompt)
78 "Interactively prompt for one of the keys in ACTION-MAP.
80 Displays a summary of all bindings in ACTION-MAP in the
81 minibuffer, reads a key from the minibuffer, and performs the
82 corresponding action. The prompt can be canceled with C-g or
83 RET. PROMPT must be a string to use for the prompt. PROMPT
84 should include a space at the end.
86 ACTION-MAP must be a list of triples of the form
88 where KEY is a key binding, LABEL is a string label to display in
89 the buffer, and ACTION is a nullary function to call. LABEL may
90 be null, in which case the action will still be bound, but will
91 not appear in the pop-up buffer."
92 (let* ((items (notmuch-jump--format-actions action-map))
93 ;; Format the table of bindings and the full prompt
96 (notmuch-jump--insert-items (window-body-width) items)
100 (propertize prompt 'face 'minibuffer-prompt)))
101 ;; By default, the minibuffer applies the minibuffer face to
102 ;; the entire prompt. However, we want to clearly
103 ;; distinguish bindings (which we put in the prompt face
104 ;; ourselves) from their labels, so disable the minibuffer's
106 (minibuffer-prompt-properties
107 (notmuch-plist-delete
108 (copy-sequence minibuffer-prompt-properties)
110 ;; Build the keymap with our bindings
111 (minibuffer-map (notmuch-jump--make-keymap action-map prompt))
112 ;; The bindings save the the action in notmuch-jump--action
113 (notmuch-jump--action nil))
115 (read-from-minibuffer full-prompt nil minibuffer-map)
116 ;; If we got an action, do it
117 (when notmuch-jump--action
118 (funcall notmuch-jump--action))))
120 (defun notmuch-jump--format-actions (action-map)
121 "Format the actions in ACTION-MAP.
123 Returns a list of strings, one for each item with a label in
124 ACTION-MAP. These strings can be inserted into a tabular
126 ;; Compute the maximum key description width
128 (pcase-dolist (`(,key ,desc) action-map)
131 (string-width (format-kbd-macro key)))))
132 ;; Format each action
133 (mapcar (pcase-lambda (`(,key ,desc))
134 (setq key (format-kbd-macro key))
135 (concat (propertize key 'face 'minibuffer-prompt)
136 (make-string (- key-width (length key)) ? )
140 (defun notmuch-jump--insert-items (width items)
141 "Make a table of ITEMS up to WIDTH wide in the current buffer."
142 (let* ((nitems (length items))
143 (col-width (+ 3 (apply #'max (mapcar #'string-width items))))
144 (ncols (if (> (* col-width nitems) width)
145 (max 1 (/ width col-width))
146 ;; Items fit on one line. Space them out
147 (setq col-width (/ width nitems))
152 (let ((item (pop items)))
154 (when (and items (< col (- ncols 1)))
155 (insert (make-string (- col-width (string-width item)) ? ))))))
159 (defvar notmuch-jump-minibuffer-map
160 (let ((map (make-sparse-keymap)))
161 (set-keymap-parent map minibuffer-local-map)
162 ;; Make this like a special-mode keymap, with no self-insert-command
163 (suppress-keymap map)
164 (define-key map (kbd "DEL") 'exit-minibuffer)
166 "Base keymap for notmuch-jump's minibuffer keymap.")
168 (defun notmuch-jump--make-keymap (action-map prompt)
169 "Translate ACTION-MAP into a minibuffer keymap."
170 (let ((map (make-sparse-keymap)))
171 (set-keymap-parent map notmuch-jump-minibuffer-map)
172 (pcase-dolist (`(,key ,name ,fn) action-map)
173 (when (= (length key) 1)
175 `(lambda () (interactive)
176 (setq notmuch-jump--action ',fn)
177 (exit-minibuffer)))))
178 ;; By doing this in two passes (and checking if we already have a
179 ;; binding) we avoid problems if the user specifies a binding which
180 ;; is a prefix of another binding.
181 (pcase-dolist (`(,key ,name ,fn) action-map)
182 (when (> (length key) 1)
183 (let* ((key (elt key 0))
184 (keystr (string key))
185 (new-prompt (concat prompt (format-kbd-macro keystr) " "))
187 (unless (lookup-key map keystr)
188 (pcase-dolist (`(,k ,n ,f) action-map)
189 (when (= key (elt k 0))
190 (push (list (substring k 1) n f) action-submap)))
191 ;; We deal with backspace specially
192 (push (list (kbd "DEL")
194 (apply-partially #'notmuch-jump action-map prompt))
196 (setq action-submap (nreverse action-submap))
197 (define-key map keystr
198 `(lambda () (interactive)
199 (setq notmuch-jump--action
200 ',(apply-partially #'notmuch-jump
203 (exit-minibuffer)))))))
208 (provide 'notmuch-jump)
210 ;;; notmuch-jump.el ends here