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 (defun notmuch-jump-search ()
34 "Jump to a saved search by shortcut key.
36 This prompts for and performs a saved search using the shortcut
37 keys configured in the :key property of `notmuch-saved-searches'.
38 Typically these shortcuts are a single key long, so this is a
39 fast way to jump to a saved search from anywhere in Notmuch."
41 ;; Build the action map
43 (dolist (saved-search notmuch-saved-searches)
44 (let* ((saved-search (notmuch-hello-saved-search-to-plist saved-search))
45 (key (plist-get saved-search :key)))
47 (let ((name (plist-get saved-search :name))
48 (query (plist-get saved-search :query))
50 (cl-case (plist-get saved-search :sort-order)
53 (otherwise (default-value 'notmuch-search-oldest-first)))))
56 ((eq (plist-get saved-search :search-type) 'tree)
57 `(lambda () (notmuch-tree ',query)))
58 ((eq (plist-get saved-search :search-type) 'unthreaded)
59 `(lambda () (notmuch-unthreaded ',query)))
61 `(lambda () (notmuch-search ',query ',oldest-first)))))
63 (setq action-map (nreverse action-map))
65 (notmuch-jump action-map "Search: ")
66 (error "To use notmuch-jump, \
67 please customize shortcut keys in notmuch-saved-searches."))))
69 (defvar notmuch-jump--action nil)
72 (defun notmuch-jump (action-map prompt)
73 "Interactively prompt for one of the keys in ACTION-MAP.
75 Displays a summary of all bindings in ACTION-MAP in the
76 minibuffer, reads a key from the minibuffer, and performs the
77 corresponding action. The prompt can be canceled with C-g or
78 RET. PROMPT must be a string to use for the prompt. PROMPT
79 should include a space at the end.
81 ACTION-MAP must be a list of triples of the form
83 where KEY is a key binding, LABEL is a string label to display in
84 the buffer, and ACTION is a nullary function to call. LABEL may
85 be null, in which case the action will still be bound, but will
86 not appear in the pop-up buffer."
87 (let* ((items (notmuch-jump--format-actions action-map))
88 ;; Format the table of bindings and the full prompt
91 (notmuch-jump--insert-items (window-body-width) items)
95 (propertize prompt 'face 'minibuffer-prompt)))
96 ;; By default, the minibuffer applies the minibuffer face to
97 ;; the entire prompt. However, we want to clearly
98 ;; distinguish bindings (which we put in the prompt face
99 ;; ourselves) from their labels, so disable the minibuffer's
101 (minibuffer-prompt-properties
102 (notmuch-plist-delete
103 (copy-sequence minibuffer-prompt-properties)
105 ;; Build the keymap with our bindings
106 (minibuffer-map (notmuch-jump--make-keymap action-map prompt))
107 ;; The bindings save the the action in notmuch-jump--action
108 (notmuch-jump--action nil))
110 (read-from-minibuffer full-prompt nil minibuffer-map)
111 ;; If we got an action, do it
112 (when notmuch-jump--action
113 (funcall notmuch-jump--action))))
115 (defun notmuch-jump--format-actions (action-map)
116 "Format the actions in ACTION-MAP.
118 Returns a list of strings, one for each item with a label in
119 ACTION-MAP. These strings can be inserted into a tabular
121 ;; Compute the maximum key description width
123 (pcase-dolist (`(,key ,desc) action-map)
126 (string-width (format-kbd-macro key)))))
127 ;; Format each action
128 (mapcar (pcase-lambda (`(,key ,desc))
129 (setq key (format-kbd-macro key))
130 (concat (propertize key 'face 'minibuffer-prompt)
131 (make-string (- key-width (length key)) ? )
135 (defun notmuch-jump--insert-items (width items)
136 "Make a table of ITEMS up to WIDTH wide in the current buffer."
137 (let* ((nitems (length items))
138 (col-width (+ 3 (apply #'max (mapcar #'string-width items))))
139 (ncols (if (> (* col-width nitems) width)
140 (max 1 (/ width col-width))
141 ;; Items fit on one line. Space them out
142 (setq col-width (/ width nitems))
147 (let ((item (pop items)))
149 (when (and items (< col (- ncols 1)))
150 (insert (make-string (- col-width (string-width item)) ? ))))))
154 (defvar notmuch-jump-minibuffer-map
155 (let ((map (make-sparse-keymap)))
156 (set-keymap-parent map minibuffer-local-map)
157 ;; Make this like a special-mode keymap, with no self-insert-command
158 (suppress-keymap map)
159 (define-key map (kbd "DEL") 'exit-minibuffer)
161 "Base keymap for notmuch-jump's minibuffer keymap.")
163 (defun notmuch-jump--make-keymap (action-map prompt)
164 "Translate ACTION-MAP into a minibuffer keymap."
165 (let ((map (make-sparse-keymap)))
166 (set-keymap-parent map notmuch-jump-minibuffer-map)
167 (pcase-dolist (`(,key ,name ,fn) action-map)
168 (when (= (length key) 1)
170 `(lambda () (interactive)
171 (setq notmuch-jump--action ',fn)
172 (exit-minibuffer)))))
173 ;; By doing this in two passes (and checking if we already have a
174 ;; binding) we avoid problems if the user specifies a binding which
175 ;; is a prefix of another binding.
176 (pcase-dolist (`(,key ,name ,fn) action-map)
177 (when (> (length key) 1)
178 (let* ((key (elt key 0))
179 (keystr (string key))
180 (new-prompt (concat prompt (format-kbd-macro keystr) " "))
182 (unless (lookup-key map keystr)
183 (pcase-dolist (`(,k ,n ,f) action-map)
184 (when (= key (elt k 0))
185 (push (list (substring k 1) n f) action-submap)))
186 ;; We deal with backspace specially
187 (push (list (kbd "DEL")
189 (apply-partially #'notmuch-jump action-map prompt))
191 (setq action-submap (nreverse action-submap))
192 (define-key map keystr
193 `(lambda () (interactive)
194 (setq notmuch-jump--action
195 ',(apply-partially #'notmuch-jump
198 (exit-minibuffer)))))))
203 (provide 'notmuch-jump)
205 ;;; notmuch-jump.el ends here