From: Austin Clements Date: Mon, 14 Jul 2014 16:02:14 +0000 (+2000) Subject: [PATCH 1/2] emacs: Introduce notmuch-jump: shortcut keys to saved searches X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=e6cbeaea6b10803376085d3cf7c8c3146dc1bfe7;p=notmuch-archives.git [PATCH 1/2] emacs: Introduce notmuch-jump: shortcut keys to saved searches --- diff --git a/11/79c7f5f8ab7509426c7281bbea50a0fe63533b b/11/79c7f5f8ab7509426c7281bbea50a0fe63533b new file mode 100644 index 000000000..6a7653e17 --- /dev/null +++ b/11/79c7f5f8ab7509426c7281bbea50a0fe63533b @@ -0,0 +1,351 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 6A2DB431FC3 + for ; Mon, 14 Jul 2014 09:02:54 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id QVGJoB7cFr0a for ; + Mon, 14 Jul 2014 09:02:48 -0700 (PDT) +Received: from dmz-mailsec-scanner-8.mit.edu (dmz-mailsec-scanner-8.mit.edu + [18.7.68.37]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 51E02431FC4 + for ; Mon, 14 Jul 2014 09:02:40 -0700 (PDT) +X-AuditID: 12074425-f79766d000006da8-6c-53c3ff1c60c5 +Received: from mailhub-auth-3.mit.edu ( [18.9.21.43]) + (using TLS with cipher AES256-SHA (256/256 bits)) + (Client did not present a certificate) + by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP + id 2E.AA.28072.C1FF3C35; Mon, 14 Jul 2014 12:02:36 -0400 (EDT) +Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) + by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s6EG2TVJ032035; + Mon, 14 Jul 2014 12:02:30 -0400 +Received: from drake.dyndns.org + (static-155-212-141-65.mas.onecommunications.net [155.212.141.65]) + (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s6EG2Mli026030 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Mon, 14 Jul 2014 12:02:27 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1X6ihq-0006rB-Ej; Mon, 14 Jul 2014 12:02:22 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH 1/2] emacs: Introduce notmuch-jump: shortcut keys to saved + searches +Date: Mon, 14 Jul 2014 12:02:14 -0400 +Message-Id: <1405353735-26244-2-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 2.0.0 +In-Reply-To: <1405353735-26244-1-git-send-email-amdragon@mit.edu> +References: <1405353735-26244-1-git-send-email-amdragon@mit.edu> +MIME-Version: 1.0 +Content-Type: text/plain; charset=UTF-8 +Content-Transfer-Encoding: 8bit +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFlrIKsWRmVeSWpSXmKPExsUixCmqrSvz/3Cwwe7HFhY3WrsZLfbd2cJk + sXouj8X1mzOZHVg8dj3/y+Sxc9Zddo9nq24xe2w59J45gCWKyyYlNSezLLVI3y6BK+P40cks + BUuDKh6u2MDSwLjXsYuRg0NCwERiyp38LkZOIFNM4sK99WwgtpDAbCaJVTNUuxi5gOyNjBKr + zs9hhHBuMEnc2fGRCcKZyyhx8fFadpAWNgENiW37lzOC2CIC0hI7785mBbGZBbIkNrw8yAxi + CwsES/w4cQxsBYuAqsSZKedZQGxeAQeJ/m8TGCHOkJNouPEJrIZTwFHizYtjrBAnOUhsWvOZ + CaJeUOLkzCcsIB8wC6hLrJ8nBLFKXqJ562zmCYxCs5BUzUKomoWkagEj8ypG2ZTcKt3cxMyc + 4tRk3eLkxLy81CJdC73czBK91JTSTYyg0Gd3Ud3BOOGQ0iFGAQ5GJR5eiXeHg4VYE8uKK3MP + MUpyMCmJ8gr9AgrxJeWnVGYkFmfEF5XmpBYfYpTgYFYS4T36ASjHm5JYWZValA+TkuZgURLn + fWttFSwkkJ5YkpqdmlqQWgSTleHgUJLg3fwXqFGwKDU9tSItM6cEIc3EwQkynAdo+BWQGt7i + gsTc4sx0iPwpRl2OruvH2piEWPLy81KlxHmb/gAVCYAUZZTmwc2BpaxXjOJAbwnzXgMZxQNM + d3CTXgEtYQJaUl4DtqQkESEl1cDIKDNNuWpHmsikGdXK59cwTNqdeYCruyLsqJTlli/Gk7fM + P/DjD9uF7hC3qcEXk7pzGV13Xrf69U+u2JlzjdnXFdpzNC8s2X6SO27xAg+Xb+vfuSe3W2Vy + nj5/9FBSt7dumJ7TOgaH0J1KEU1dRVbMj1ylbs3Jkk35bZEz+V/CquYFijcdGHiUWIozEg21 + mIuKEwGM26esNAMAAA== +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Mon, 14 Jul 2014 16:02:54 -0000 + +This introduces notmuch-jump, which is like a user-friendly, +user-configurable global prefix map for saved searches. This provides +a non-modal and much faster way to access saved searches than +notmuch-hello. + +A user configures shortcut keys in notmuch-saved-searches, which are +immediately accessible from anywhere in Notmuch under the "j" key (for +"jump"). When the user hits "j", the minibuffer immediately shows a +helpful table of bindings reminiscent of a completions buffer. + +This code is a combination of work from myself (originally, +"notmuch-go"), David Edmondson, and modifications from Mark Walters. +--- + emacs/Makefile.local | 3 +- + emacs/notmuch-hello.el | 2 + + emacs/notmuch-jump.el | 189 +++++++++++++++++++++++++++++++++++++++++++++++++ + emacs/notmuch-lib.el | 3 + + 4 files changed, 196 insertions(+), 1 deletion(-) + create mode 100644 emacs/notmuch-jump.el + +diff --git a/emacs/Makefile.local b/emacs/Makefile.local +index c0d6b19..1109cfa 100644 +--- a/emacs/Makefile.local ++++ b/emacs/Makefile.local +@@ -18,7 +18,8 @@ emacs_sources := \ + $(dir)/notmuch-tag.el \ + $(dir)/coolj.el \ + $(dir)/notmuch-print.el \ +- $(dir)/notmuch-version.el ++ $(dir)/notmuch-version.el \ ++ $(dir)/notmuch-jump.el \ + + $(dir)/notmuch-version.el: $(dir)/Makefile.local version.stamp + $(dir)/notmuch-version.el: $(srcdir)/$(dir)/notmuch-version.el.tmpl +diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el +index 3de5238..061b27d 100644 +--- a/emacs/notmuch-hello.el ++++ b/emacs/notmuch-hello.el +@@ -85,6 +85,7 @@ (define-widget 'notmuch-saved-search-plist 'list + (group :format "%v" :inline t (const :format " Query: " :query) (string :format "%v"))) + (checklist :inline t + :format "%v" ++ (group :format "%v" :inline t (const :format "Shortcut key: " :key) (key-sequence :format "%v")) + (group :format "%v" :inline t (const :format "Count-Query: " :count-query) (string :format "%v")) + (group :format "%v" :inline t (const :format "" :sort-order) + (choice :tag " Sort Order" +@@ -101,6 +102,7 @@ (defcustom notmuch-saved-searches '((:name "inbox" :query "tag:inbox") + + :name Name of the search (required). + :query Search to run (required). ++ :key Optional shortcut key for `notmuch-jump-search'. + :count-query Optional extra query to generate the count + shown. If not present then the :query property + is used. +diff --git a/emacs/notmuch-jump.el b/emacs/notmuch-jump.el +new file mode 100644 +index 0000000..cb1ae10 +--- /dev/null ++++ b/emacs/notmuch-jump.el +@@ -0,0 +1,189 @@ ++;; notmuch-jump.el --- User-friendly shortcut keys ++;; ++;; Copyright © Austin Clements ++;; ++;; This file is part of Notmuch. ++;; ++;; Notmuch 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 of the License, or ++;; (at your option) any later version. ++;; ++;; Notmuch 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. ++;; ++;; You should have received a copy of the GNU General Public License ++;; along with Notmuch. If not, see . ++;; ++;; Authors: Austin Clements ++;; David Edmondson ++ ++(eval-when-compile (require 'cl)) ++ ++(require 'notmuch-hello) ++ ++;;;###autoload ++(defun notmuch-jump-search () ++ "Jump to a saved search by shortcut key. ++ ++This prompts for and performs a saved search using the shortcut ++keys configured in the :key property of `notmuch-saved-searches'. ++Typically these shortcuts are a single key long, so this is a ++fast way to jump to a saved search from anywhere in Notmuch." ++ (interactive) ++ ++ ;; Build the action map ++ (let (action-map) ++ (dolist (saved-search notmuch-saved-searches) ++ (let* ((saved-search (notmuch-hello-saved-search-to-plist saved-search)) ++ (key (plist-get saved-search :key))) ++ (when key ++ (let ((name (plist-get saved-search :name)) ++ (query (plist-get saved-search :query)) ++ (oldest-first ++ (case (plist-get saved-search :sort-order) ++ (newest-first nil) ++ (oldest-first t) ++ (otherwise (default-value notmuch-search-oldest-first))))) ++ (push (list key name ++ `(lambda () (notmuch-search ',query ',oldest-first))) ++ action-map))))) ++ (setq action-map (nreverse action-map)) ++ ++ (if action-map ++ (notmuch-jump action-map "Search ") ++ (error "No shortcut keys for saved searches. Please customize notmuch-saved-searches.")))) ++ ++(defvar notmuch-jump--action nil) ++ ++(defun notmuch-jump (action-map prompt) ++ "Interactively prompt for one of the keys in ACTION-MAP. ++ ++Displays a pop-up temporary buffer with a summary of all bindings ++in ACTION-MAP, reads a key from the minibuffer, and performs the ++corresponding action. The prompt can be canceled with C-g. ++PROMPT must be a string to use for the prompt if this command was ++not invoked directly by a key binding (e.g., it was invoked ++through M-x). PROMPT should include a space at the end. ++ ++ACTION-MAP must be a list of triples of the form ++ (KEY LABEL ACTION) ++where KEY is a key binding, LABEL is a string label to display in ++the buffer, and ACTION is a nullary function to call. LABEL may ++be null, in which case the action will still be bound, but will ++not appear in the pop-up buffer. ++" ++ ++ (let* ((items (notmuch-jump--format-actions action-map)) ++ ;; Format the table of bindings and the full prompt ++ (table ++ (with-temp-buffer ++ (notmuch-jump--insert-items (window-body-width) items) ++ (buffer-string))) ++ (prompt-text ++ (if (eq this-original-command this-command) ++ ;; Make it look like we're just part of any regular ++ ;; submap prompt (like C-x, C-c, etc.) ++ (concat (format-kbd-macro (this-command-keys)) "-") ++ ;; We were invoked through something like M-x ++ prompt)) ++ (full-prompt ++ (concat table "\n\n" ++ (propertize prompt-text 'face 'minibuffer-prompt))) ++ ;; By default, the minibuffer applies the minibuffer face to ++ ;; the entire prompt. However, we want to clearly ++ ;; distinguish bindings (which we put in the prompt face ++ ;; ourselves) from their labels, so disable the minibuffer's ++ ;; own re-face-ing. ++ (minibuffer-prompt-properties ++ (notmuch-jump--plist-delete ++ (copy-sequence minibuffer-prompt-properties) ++ 'face)) ++ ;; Build the keymap with our bindings ++ (minibuffer-map (notmuch-jump--make-keymap action-map)) ++ ;; The bindings save the the action in notmuch-jump--action ++ (notmuch-jump--action nil)) ++ ;; Read the action ++ (read-from-minibuffer full-prompt nil minibuffer-map) ++ ++ ;; If we got an action, do it ++ (when notmuch-jump--action ++ (funcall notmuch-jump--action)))) ++ ++(defun notmuch-jump--format-actions (action-map) ++ "Format the actions in ACTION-MAP. ++ ++Returns a list of strings, one for each item with a label in ++ACTION-MAP. These strings can be inserted into a tabular ++buffer." ++ ++ ;; Compute the maximum key description width ++ (let ((key-width 1)) ++ (dolist (action action-map) ++ (setq key-width ++ (max key-width ++ (string-width (format-kbd-macro (first action)))))) ++ ;; Format each action ++ (mapcar (lambda (action) ++ (let ((key (format-kbd-macro (first action))) ++ (desc (second action))) ++ (concat ++ (propertize key 'face 'minibuffer-prompt) ++ (make-string (- key-width (length key)) ? ) ++ " " desc))) ++ action-map))) ++ ++(defun notmuch-jump--insert-items (width items) ++ "Make a table of ITEMS up to WIDTH wide in the current buffer." ++ (let* ((nitems (length items)) ++ (col-width (+ 3 (apply #'max (mapcar #'string-width items)))) ++ (ncols (if (> (* col-width nitems) width) ++ (max 1 (/ width col-width)) ++ ;; Items fit on one line. Space them out ++ (setq col-width (/ width nitems)) ++ (length items)))) ++ (while items ++ (dotimes (col ncols) ++ (when items ++ (let ((item (pop items))) ++ (insert item) ++ (when (and items (< col (- ncols 1))) ++ (insert (make-string (- col-width (string-width item)) ? )))))) ++ (when items ++ (insert "\n"))))) ++ ++(defvar notmuch-jump-minibuffer-map ++ (let ((map (make-sparse-keymap))) ++ (set-keymap-parent map minibuffer-local-map) ++ ;; Make this like a special-mode keymap, with no self-insert-command ++ (suppress-keymap map) ++ map) ++ "Base keymap for notmuch-jump's minibuffer keymap.") ++ ++(defun notmuch-jump--make-keymap (action-map) ++ "Translate ACTION-MAP into a minibuffer keymap." ++ (let ((map (make-sparse-keymap))) ++ (set-keymap-parent map notmuch-jump-minibuffer-map) ++ (dolist (action action-map) ++ (define-key map (first action) ++ `(lambda () (interactive) ++ (setq notmuch-jump--action ',(third action)) ++ (exit-minibuffer)))) ++ map)) ++ ++(defun notmuch-jump--plist-delete (plist property) ++ (let* ((xplist (cons nil plist)) ++ (pred xplist)) ++ (while (cdr pred) ++ (when (eq (cadr pred) property) ++ (setcdr pred (cdddr pred))) ++ (setq pred (cddr pred))) ++ (cdr xplist))) ++ ++(unless (fboundp 'window-body-width) ++ ;; Compatibility for Emacs pre-24 ++ (defun window-body-width (&optional window) ++ (let ((edges (window-inside-edges window))) ++ (- (caddr edges) (car edges))))) +diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el +index 2941da3..135422d 100644 +--- a/emacs/notmuch-lib.el ++++ b/emacs/notmuch-lib.el +@@ -130,9 +130,12 @@ (defvar notmuch-common-keymap + (define-key map "m" 'notmuch-mua-new-mail) + (define-key map "=" 'notmuch-refresh-this-buffer) + (define-key map "G" 'notmuch-poll-and-refresh-this-buffer) ++ (define-key map "j" 'notmuch-jump-search) + map) + "Keymap shared by all notmuch modes.") + ++(autoload 'notmuch-jump-search "notmuch-jump" "Jump to a saved search by shortcut key." t) ++ + ;; By default clicking on a button does not select the window + ;; containing the button (as opposed to clicking on a widget which + ;; does). This means that the button action is then executed in the +-- +2.0.0 +