[PATCH] emacs: add '?' to some prefix keymaps to describe its bindings
authorMark Walters <markwalters1009@gmail.com>
Thu, 14 Nov 2013 09:49:46 +0000 (09:49 +0000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:58:18 +0000 (09:58 -0800)
46/4b15b25293c29e96a1f0b4d3c0a45485d5c7c3 [new file with mode: 0644]

diff --git a/46/4b15b25293c29e96a1f0b4d3c0a45485d5c7c3 b/46/4b15b25293c29e96a1f0b4d3c0a45485d5c7c3
new file mode 100644 (file)
index 0000000..0e45dd1
--- /dev/null
@@ -0,0 +1,160 @@
+Return-Path: <markwalters1009@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 1F02D431FC4\r
+       for <notmuch@notmuchmail.org>; Thu, 14 Nov 2013 02:21:30 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.201\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
+       RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id 2H0qBRyZEEts for <notmuch@notmuchmail.org>;\r
+       Thu, 14 Nov 2013 02:21:20 -0800 (PST)\r
+Received: from mail-wg0-f46.google.com (mail-wg0-f46.google.com\r
+ [74.125.82.46])       (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
+ certificate requested)        by olra.theworths.org (Postfix) with ESMTPS id\r
+ 666E5431FAE   for <notmuch@notmuchmail.org>; Thu, 14 Nov 2013 02:21:20 -0800\r
+ (PST)\r
+Received: by mail-wg0-f46.google.com with SMTP id x12so1641073wgg.13\r
+       for <notmuch@notmuchmail.org>; Thu, 14 Nov 2013 02:21:17 -0800 (PST)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id;\r
+       bh=nD2Uy2sOysb4jb+5AfLYvM+VkWx7i4BpQGc02u76mLM=;\r
+       b=gNaNF550oEsdErRiv66FY0w4fhldxGYYIv0/hEIVkrdrOJhbGS6XZP/eZDRgLPGnj3\r
+       UWCDlT/6EHjfDOKCEnPdyXXncfM0eH0O0QiyVrglWESCT7w9BT/40oCVmXuGniSuFY8d\r
+       Jt45mkkOM/Wi0dZ7zeSYGE0jfd0S9+7F1Ai8hkT+cSAMglqQFUSRl0tzk8WN4vxWYpZX\r
+       ILTDyBBmObW9aSBWs33b94XlGHaVLKEQtz5XB8UluaFcFbPQFKpFFo5CifCpi7EKsSDb\r
+       GiBlGw0xlvvWb5tN4agoPtOppiEYqd+NA125MGDD5rQldGLvRSAihOg0TBTY3Wezx3kc\r
+       iTaw==\r
+X-Received: by 10.180.39.140 with SMTP id p12mr1483981wik.12.1384422590582;\r
+       Thu, 14 Nov 2013 01:49:50 -0800 (PST)\r
+Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31])\r
+       by mx.google.com with ESMTPSA id hv5sm63991736wib.2.2013.11.14.01.49.49\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Thu, 14 Nov 2013 01:49:50 -0800 (PST)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] emacs: add '?' to some prefix keymaps to describe its\r
+ bindings\r
+Date: Thu, 14 Nov 2013 09:49:46 +0000\r
+Message-Id: <1384422586-21806-1-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Thu, 14 Nov 2013 10:21:30 -0000\r
+\r
+Added function notmuch-subkeymap-help to describe keybindings of a\r
+subkeymap (eg after . or c in notmuch-search and notmuch-show).\r
+---\r
+This a reimplementation of Tomi's patch at\r
+id:1377346540-7094-1-git-send-email-tomi.ollila@iki.fi but the help\r
+screen shows docstrings rather than function names.\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r
+\r
+\r
+\r
+\r
+ emacs/notmuch-lib.el  |   25 ++++++++++++++++++++++++-\r
+ emacs/notmuch-show.el |    2 ++\r
+ emacs/notmuch.el      |    1 +\r
+ 3 files changed, 27 insertions(+), 1 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el\r
+index 49fe644..2be409b 100644\r
+--- a/emacs/notmuch-lib.el\r
++++ b/emacs/notmuch-lib.el\r
+@@ -231,7 +231,8 @@ depending on the value of `notmuch-poll-script'."\r
+   "Given a prefix key code, return a human-readable string representation.\r
\r
+ This is basically just `format-kbd-macro' but we also convert ESC to M-."\r
+-  (let ((desc (format-kbd-macro (vector key))))\r
++  (let* ((key-vector (if (vectorp key) key (vector key)))\r
++       (desc (format-kbd-macro key-vector)))\r
+     (if (string= desc "ESC")\r
+       "M-"\r
+       (concat desc " "))))\r
+@@ -337,6 +338,28 @@ of its command symbol."\r
+       (set-buffer-modified-p nil)\r
+       (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))\r
\r
++(defun notmuch-subkeymap-help ()\r
++  "Show help for a subkeymap."\r
++  (interactive)\r
++  (let* ((key (this-command-keys-vector))\r
++      (prefix (make-vector (1- (length key)) nil))\r
++      (i 0))\r
++    (while (< i (length prefix))\r
++      (aset prefix i (aref key i))\r
++      (setq i (1+ i)))\r
++\r
++    (let* ((subkeymap (key-binding prefix))\r
++         (ua-keys (where-is-internal 'universal-argument nil t))\r
++         (prefix-string (notmuch-prefix-key-description prefix))\r
++         (desc-alist (notmuch-describe-keymap subkeymap ua-keys subkeymap prefix-string))\r
++         (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist))\r
++         (desc (mapconcat #'identity desc-list "\n")))\r
++      (with-help-window (help-buffer)\r
++      (with-current-buffer standard-output\r
++        (insert "\nPress 'q' to quit this window.\n\n")\r
++        (insert desc)))\r
++      (pop-to-buffer (help-buffer)))))\r
++\r
+ (defvar notmuch-buffer-refresh-function nil\r
+   "Function to call to refresh the current buffer.")\r
+ (make-variable-buffer-local 'notmuch-buffer-refresh-function)\r
+diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
+index f00273a..45dca8b 100644\r
+--- a/emacs/notmuch-show.el\r
++++ b/emacs/notmuch-show.el\r
+@@ -1232,6 +1232,7 @@ reset based on the original query."\r
+     (define-key map "t" 'notmuch-show-stash-to)\r
+     (define-key map "l" 'notmuch-show-stash-mlarchive-link)\r
+     (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)\r
++    (define-key map "?" 'notmuch-subkeymap-help)\r
+     map)\r
+   "Submap for stash commands")\r
+ (fset 'notmuch-show-stash-map notmuch-show-stash-map)\r
+@@ -1242,6 +1243,7 @@ reset based on the original query."\r
+     (define-key map "v" 'notmuch-show-view-part)\r
+     (define-key map "o" 'notmuch-show-interactively-view-part)\r
+     (define-key map "|" 'notmuch-show-pipe-part)\r
++    (define-key map "?" 'notmuch-subkeymap-help)\r
+     map)\r
+   "Submap for part commands")\r
+ (fset 'notmuch-show-part-map notmuch-show-part-map)\r
+diff --git a/emacs/notmuch.el b/emacs/notmuch.el\r
+index c9bc2f2..0471750 100644\r
+--- a/emacs/notmuch.el\r
++++ b/emacs/notmuch.el\r
+@@ -165,6 +165,7 @@ To enter a line break in customize, press \\[quoted-insert] C-j."\r
+ (defvar notmuch-search-stash-map\r
+   (let ((map (make-sparse-keymap)))\r
+     (define-key map "i" 'notmuch-search-stash-thread-id)\r
++    (define-key map "?" 'notmuch-subkeymap-help)\r
+     map)\r
+   "Submap for stash commands")\r
+ (fset 'notmuch-search-stash-map notmuch-search-stash-map)\r
+-- \r
+1.7.9.1\r
+\r