From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id A19CC429E2E for ; Thu, 7 Nov 2013 16:27:07 -0800 (PST) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: 0.201 X-Spam-Level: X-Spam-Status: No, score=0.201 tagged_above=-999 required=5 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001, 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 tXp24CWFD9zG for ; Thu, 7 Nov 2013 16:27:00 -0800 (PST) Received: from mail-wi0-f172.google.com (mail-wi0-f172.google.com [209.85.212.172]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id DE571429E26 for ; Thu, 7 Nov 2013 16:26:59 -0800 (PST) Received: by mail-wi0-f172.google.com with SMTP id ez12so1465506wid.17 for ; Thu, 07 Nov 2013 16:26:56 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=N4YMpZq/47KojcpG7f1UnE8UkxVX65eUWBrE04y5R88=; b=uLzAyBnv75ZMYfhuG0aqEX06rP4I3A78/prvqQN4yBZEdNmDfF2rGavZsjyCk0a26Y JK+qvA/32a3eH8mXJuufyzTVW6V7r7pM30DUqTxhxBpN7u10MF48vrntgBWApiScXsu5 dVC51+MXYHvn3rEYDwN7CwmrsOyvlb6tJ6MsMFOcD/wsiW6LQdPsyTszvyJO5QOnahKr SHelJFZbSBGLJHGo4FZijp4tvUufPiFYCBf2yzYDVzoVNDfuLXXhsi5SUr0nABTOjyu+ 7dEE2em2EhXiRr00/I6NIP/ny0uVEksPgzRn+Exv6RgM6i+eXzpL9+TXoWPs1S5J2YbK +Uzw== X-Received: by 10.194.122.99 with SMTP id lr3mr9439478wjb.21.1383870106419; Thu, 07 Nov 2013 16:21:46 -0800 (PST) Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31]) by mx.google.com with ESMTPSA id y11sm395566wie.7.2013.11.07.16.21.45 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Thu, 07 Nov 2013 16:21:46 -0800 (PST) From: Mark Walters To: notmuch@notmuchmail.org Subject: [PATCH v2 3/5] emacs: help: split out notmuch-describe-key as a function Date: Fri, 8 Nov 2013 00:21:34 +0000 Message-Id: <1383870096-14627-4-git-send-email-markwalters1009@gmail.com> X-Mailer: git-send-email 1.7.9.1 In-Reply-To: <1383870096-14627-1-git-send-email-markwalters1009@gmail.com> References: <1383870096-14627-1-git-send-email-markwalters1009@gmail.com> 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: Fri, 08 Nov 2013 00:27:07 -0000 The actual documentation function notmuch-describe-keymap was getting rather complicated so split out the code for a single key into its own function notmuch-describe-key. --- emacs/notmuch-lib.el | 42 +++++++++++++++++++++++++----------------- 1 files changed, 25 insertions(+), 17 deletions(-) diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el index 2195166..8852703 100644 --- a/emacs/notmuch-lib.el +++ b/emacs/notmuch-lib.el @@ -237,6 +237,30 @@ This is basically just `format-kbd-macro' but we also convert ESC to M-." "M-" (concat desc " ")))) + +(defun notmuch-describe-key (actual-key binding prefix ua-keys tail) + "Prepend cons cells describing prefix-arg ACTUAL-KEY and ACTUAL-KEY to TAIL + +It does not prepend if ACTUAL-KEY is already listed in TAIL." + (let ((key-string (concat prefix (format-kbd-macro actual-key)))) + ;; We don't include documentation if the key-binding is + ;; over-ridden. Note, over-riding a binding automatically hides the + ;; prefixed version too. + (unless (assoc key-string tail) + (when (and ua-keys (symbolp binding) + (get binding 'notmuch-prefix-doc)) + ;; Documentation for prefixed command + (let ((ua-desc (key-description ua-keys))) + (push (cons (concat ua-desc " " prefix (format-kbd-macro actual-key)) + (get binding 'notmuch-prefix-doc)) + tail))) + ;; Documentation for command + (push (cons key-string + (or (and (symbolp binding) (get binding 'notmuch-doc)) + (notmuch-documentation-first-line binding))) + tail))) + tail) + (defun notmuch-describe-keymap (keymap ua-keys &optional prefix tail) "Return a list of cons cells, each describing one binding in KEYMAP. @@ -256,23 +280,7 @@ prefix argument. PREFIX and TAIL are used internally." (notmuch-describe-keymap binding ua-keys (notmuch-prefix-key-description key) tail))) (binding - (let ((key-string (concat prefix (format-kbd-macro (vector key))))) - ;; We don't include documentation if the key-binding is - ;; over-ridden. Note, over-riding a binding - ;; automatically hides the prefixed version too. - (unless (assoc key-string tail) - (when (and ua-keys (symbolp binding) - (get binding 'notmuch-prefix-doc)) - ;; Documentation for prefixed command - (let ((ua-desc (key-description ua-keys))) - (push (cons (concat ua-desc " " prefix (format-kbd-macro (vector key))) - (get binding 'notmuch-prefix-doc)) - tail))) - ;; Documentation for command - (push (cons key-string - (or (and (symbolp binding) (get binding 'notmuch-doc)) - (notmuch-documentation-first-line binding))) - tail)))))) + (setq tail (notmuch-describe-key (vector key) binding prefix ua-keys tail))))) keymap) tail) -- 1.7.9.1