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>
25 (eval-when-compile (require 'cl))
27 (require 'notmuch-lib)
28 (require 'notmuch-hello)
31 (unless (fboundp 'window-body-width)
32 ;; Compatibility for Emacs pre-24
33 (defalias 'window-body-width 'window-width)))
36 (defun notmuch-jump-search ()
37 "Jump to a saved search by shortcut key.
39 This prompts for and performs a saved search using the shortcut
40 keys configured in the :key property of `notmuch-saved-searches'.
41 Typically these shortcuts are a single key long, so this is a
42 fast way to jump to a saved search from anywhere in Notmuch."
45 ;; Build the action map
47 (dolist (saved-search notmuch-saved-searches)
48 (let* ((saved-search (notmuch-hello-saved-search-to-plist saved-search))
49 (key (plist-get saved-search :key)))
51 (let ((name (plist-get saved-search :name))
52 (query (plist-get saved-search :query))
54 (case (plist-get saved-search :sort-order)
57 (otherwise (default-value 'notmuch-search-oldest-first)))))
59 (if (eq (plist-get saved-search :search-type) 'tree)
60 `(lambda () (notmuch-tree ',query))
61 `(lambda () (notmuch-search ',query ',oldest-first))))
63 (setq action-map (nreverse action-map))
66 (notmuch-jump action-map "Search: ")
67 (error "To use notmuch-jump, please customize shortcut keys in notmuch-saved-searches."))))
69 (defvar notmuch-jump--action nil)
71 (defun notmuch-jump (action-map prompt)
72 "Interactively prompt for one of the keys in ACTION-MAP.
74 Displays a summary of all bindings in ACTION-MAP in the
75 minibuffer, reads a key from the minibuffer, and performs the
76 corresponding action. The prompt can be canceled with C-g or
77 RET. PROMPT must be a string to use for the prompt. PROMPT
78 should include a space at the end.
80 ACTION-MAP must be a list of triples of the form
82 where KEY is a key binding, LABEL is a string label to display in
83 the buffer, and ACTION is a nullary function to call. LABEL may
84 be null, in which case the action will still be bound, but will
85 not appear in the pop-up buffer.
88 (let* ((items (notmuch-jump--format-actions action-map))
89 ;; Format the table of bindings and the full prompt
92 (notmuch-jump--insert-items (window-body-width) items)
96 (propertize prompt 'face 'minibuffer-prompt)))
97 ;; By default, the minibuffer applies the minibuffer face to
98 ;; the entire prompt. However, we want to clearly
99 ;; distinguish bindings (which we put in the prompt face
100 ;; ourselves) from their labels, so disable the minibuffer's
102 (minibuffer-prompt-properties
103 (notmuch-plist-delete
104 (copy-sequence minibuffer-prompt-properties)
106 ;; Build the keymap with our bindings
107 (minibuffer-map (notmuch-jump--make-keymap action-map prompt))
108 ;; The bindings save the the action in notmuch-jump--action
109 (notmuch-jump--action nil))
111 (read-from-minibuffer full-prompt nil minibuffer-map)
113 ;; If we got an action, do it
114 (when notmuch-jump--action
115 (funcall notmuch-jump--action))))
117 (defun notmuch-jump--format-actions (action-map)
118 "Format the actions in ACTION-MAP.
120 Returns a list of strings, one for each item with a label in
121 ACTION-MAP. These strings can be inserted into a tabular
124 ;; Compute the maximum key description width
126 (dolist (entry action-map)
129 (string-width (format-kbd-macro (first entry))))))
130 ;; Format each action
131 (mapcar (lambda (entry)
132 (let ((key (format-kbd-macro (first entry)))
133 (desc (second entry)))
135 (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 (dolist (action action-map)
173 (if (= (length (first action)) 1)
174 (define-key map (first action)
175 `(lambda () (interactive)
176 (setq notmuch-jump--action ',(third action))
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 (dolist (action action-map)
182 (if (> (length (first action)) 1)
183 (let* ((key (elt (first action) 0))
184 (keystr (string key))
185 (new-prompt (concat prompt (format-kbd-macro keystr) " "))
187 (unless (lookup-key map keystr)
188 (dolist (act action-map)
189 (when (= key (elt (first act) 0))
190 (push (list (substring (first act) 1)
194 ;; We deal with backspace specially
195 (push (list (kbd "DEL")
197 (apply-partially #'notmuch-jump action-map prompt))
199 (setq action-submap (nreverse action-submap))
200 (define-key map keystr
201 `(lambda () (interactive)
202 (setq notmuch-jump--action
203 ',(apply-partially #'notmuch-jump action-submap new-prompt))
204 (exit-minibuffer)))))))
209 (provide 'notmuch-jump)
211 ;;; notmuch-jump.el ends here