[PATCH v2 3/5] emacs: help: split out notmuch-describe-key as a function

diff --git a/58/0b76640fb2c2cb304333cb246c1f4524a8dece b/58/0b76640fb2c2cb304333cb246c1f4524a8dece
new file mode 100644 (file)
index 0000000..1f194d5
--- /dev/null
+++ b/58/0b76640fb2c2cb304333cb246c1f4524a8dece
@@ -0,0 +1,134 @@
+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 A19CC429E2E\r
+       for <notmuch@notmuchmail.org>; Thu,  7 Nov 2013 16:27:07 -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 tXp24CWFD9zG for <notmuch@notmuchmail.org>;\r
+       Thu,  7 Nov 2013 16:27:00 -0800 (PST)\r
+Received: from mail-wi0-f172.google.com (mail-wi0-f172.google.com\r
+       [209.85.212.172]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id DE571429E26\r
+       for <notmuch@notmuchmail.org>; Thu,  7 Nov 2013 16:26:59 -0800 (PST)\r
+Received: by mail-wi0-f172.google.com with SMTP id ez12so1465506wid.17\r
+       for <notmuch@notmuchmail.org>; Thu, 07 Nov 2013 16:26:56 -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:in-reply-to:references;\r
+       bh=N4YMpZq/47KojcpG7f1UnE8UkxVX65eUWBrE04y5R88=;\r
+       b=uLzAyBnv75ZMYfhuG0aqEX06rP4I3A78/prvqQN4yBZEdNmDfF2rGavZsjyCk0a26Y\r
+       JK+qvA/32a3eH8mXJuufyzTVW6V7r7pM30DUqTxhxBpN7u10MF48vrntgBWApiScXsu5\r
+       dVC51+MXYHvn3rEYDwN7CwmrsOyvlb6tJ6MsMFOcD/wsiW6LQdPsyTszvyJO5QOnahKr\r
+       SHelJFZbSBGLJHGo4FZijp4tvUufPiFYCBf2yzYDVzoVNDfuLXXhsi5SUr0nABTOjyu+\r
+       7dEE2em2EhXiRr00/I6NIP/ny0uVEksPgzRn+Exv6RgM6i+eXzpL9+TXoWPs1S5J2YbK\r
+       +Uzw==\r
+X-Received: by 10.194.122.99 with SMTP id lr3mr9439478wjb.21.1383870106419;\r
+       Thu, 07 Nov 2013 16:21:46 -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 y11sm395566wie.7.2013.11.07.16.21.45\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Thu, 07 Nov 2013 16:21:46 -0800 (PST)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 3/5] emacs: help: split out notmuch-describe-key as a\r
+       function\r
+Date: Fri,  8 Nov 2013 00:21:34 +0000\r
+Message-Id: <1383870096-14627-4-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+In-Reply-To: <1383870096-14627-1-git-send-email-markwalters1009@gmail.com>\r
+References: <1383870096-14627-1-git-send-email-markwalters1009@gmail.com>\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: Fri, 08 Nov 2013 00:27:07 -0000\r
+\r
+The actual documentation function notmuch-describe-keymap was getting\r
+rather complicated so split out the code for a single key into its own\r
+function notmuch-describe-key.\r
+---\r
+ emacs/notmuch-lib.el |   42 +++++++++++++++++++++++++-----------------\r
+ 1 files changed, 25 insertions(+), 17 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el\r
+index 2195166..8852703 100644\r
+--- a/emacs/notmuch-lib.el\r
++++ b/emacs/notmuch-lib.el\r
+@@ -237,6 +237,30 @@ This is basically just `format-kbd-macro' but we also convert ESC to M-."\r
+       "M-"\r
+       (concat desc " "))))\r
+ \r
++\r
++(defun notmuch-describe-key (actual-key binding prefix ua-keys tail)\r
++  "Prepend cons cells describing prefix-arg ACTUAL-KEY and ACTUAL-KEY to TAIL\r
++\r
++It does not prepend if ACTUAL-KEY is already listed in TAIL."\r
++  (let ((key-string (concat prefix (format-kbd-macro actual-key))))\r
++    ;; We don't include documentation if the key-binding is\r
++    ;; over-ridden. Note, over-riding a binding automatically hides the\r
++    ;; prefixed version too.\r
++    (unless (assoc key-string tail)\r
++      (when (and ua-keys (symbolp binding)\r
++               (get binding 'notmuch-prefix-doc))\r
++      ;; Documentation for prefixed command\r
++      (let ((ua-desc (key-description ua-keys)))\r
++        (push (cons (concat ua-desc " " prefix (format-kbd-macro actual-key))\r
++                    (get binding 'notmuch-prefix-doc))\r
++              tail)))\r
++      ;; Documentation for command\r
++      (push (cons key-string\r
++                (or (and (symbolp binding) (get binding 'notmuch-doc))\r
++                    (notmuch-documentation-first-line binding)))\r
++          tail)))\r
++    tail)\r
++\r
+ (defun notmuch-describe-keymap (keymap ua-keys &optional prefix tail)\r
+   "Return a list of cons cells, each describing one binding in KEYMAP.\r
+ \r
+@@ -256,23 +280,7 @@ prefix argument.  PREFIX and TAIL are used internally."\r
+                 (notmuch-describe-keymap\r
+                  binding ua-keys (notmuch-prefix-key-description key) tail)))\r
+          (binding\r
+-          (let ((key-string (concat prefix (format-kbd-macro (vector key)))))\r
+-            ;; We don't include documentation if the key-binding is\r
+-            ;; over-ridden. Note, over-riding a binding\r
+-            ;; automatically hides the prefixed version too.\r
+-            (unless (assoc key-string tail)\r
+-              (when (and ua-keys (symbolp binding)\r
+-                         (get binding 'notmuch-prefix-doc))\r
+-                ;; Documentation for prefixed command\r
+-                (let ((ua-desc (key-description ua-keys)))\r
+-                  (push (cons (concat ua-desc " " prefix (format-kbd-macro (vector key)))\r
+-                              (get binding 'notmuch-prefix-doc))\r
+-                        tail)))\r
+-              ;; Documentation for command\r
+-              (push (cons key-string\r
+-                          (or (and (symbolp binding) (get binding 'notmuch-doc))\r
+-                              (notmuch-documentation-first-line binding)))\r
+-                    tail))))))\r
++          (setq tail (notmuch-describe-key (vector key) binding prefix ua-keys tail)))))\r
+    keymap)\r
+   tail)\r
+ \r
+-- \r
+1.7.9.1\r
+\r