From 7aab46426320f7f3b543f0b16ce9eec3fc334c57 Mon Sep 17 00:00:00 2001 From: Ethan Glasser-Camp Date: Sun, 28 Oct 2012 20:08:49 +2000 Subject: [PATCH] Re: [PATCH (draft) 1/2] emacs: allow the user to toggle the visibility of multipart/alternative parts --- ec/97b6db36af9aa7a40217da9a78e959ac0e55a0 | 167 ++++++++++++++++++++++ 1 file changed, 167 insertions(+) create mode 100644 ec/97b6db36af9aa7a40217da9a78e959ac0e55a0 diff --git a/ec/97b6db36af9aa7a40217da9a78e959ac0e55a0 b/ec/97b6db36af9aa7a40217da9a78e959ac0e55a0 new file mode 100644 index 000000000..2b1201971 --- /dev/null +++ b/ec/97b6db36af9aa7a40217da9a78e959ac0e55a0 @@ -0,0 +1,167 @@ +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 695CB431FB6 + for ; Sat, 27 Oct 2012 17:08:58 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.776 +X-Spam-Level: +X-Spam-Status: No, score=-0.776 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_FROM=0.001, HS_INDEX_PARAM=0.023, 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 9EcVQPzK08vB for ; + Sat, 27 Oct 2012 17:08:54 -0700 (PDT) +Received: from mail-qc0-f181.google.com (mail-qc0-f181.google.com + [209.85.216.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id E9DA0431FAF + for ; Sat, 27 Oct 2012 17:08:53 -0700 (PDT) +Received: by mail-qc0-f181.google.com with SMTP id x40so2310975qcp.26 + for ; Sat, 27 Oct 2012 17:08:52 -0700 (PDT) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:subject:in-reply-to:references:user-agent:date:message-id + :mime-version:content-type; + bh=B8rkjqe5YyFWY0Ty/OOTXjyJoY5CcBSoeMjgnw3CMjc=; + b=HXor86Nje+zDMilqk+GJwQ+D5U6445DCh164scrG3NpDQn3MsW1hOzOtDPWui8n3mY + ZXB54Ha1WxcHlgJJI4HDLMCfwAWkux/XgCqMuCAe6Yc9/XZe+yk1MKh0A0etyUTR07Kb + JPlZN+LPpFe/Ak1kFMwu3hiKsm9LI8TRRzddU1pHwMzRGJclZNOYQtr1joT5qJUHY9fq + Ujg8BJHHkvJRoKHNqIbqU8Nm3a5/jcyW81WVK6Qs++AnR0YWn8vaHRw3zXBKyqtP3MTb + AEorxyVybRioCSFZ8mHoSenl4ESriEX2Sl3t+QmRScxCBM+bPQv6JImM0RUr6yOfz58C + e7yg== +Received: by 10.224.194.193 with SMTP id dz1mr14727965qab.0.1351382932078; + Sat, 27 Oct 2012 17:08:52 -0700 (PDT) +Received: from smtp.gmail.com (p70-80.acedsl.com. [66.114.70.80]) + by mx.google.com with ESMTPS id bc9sm3485926qab.2.2012.10.27.17.08.50 + (version=TLSv1/SSLv3 cipher=OTHER); + Sat, 27 Oct 2012 17:08:51 -0700 (PDT) +From: Ethan Glasser-Camp +To: Mark Walters , notmuch@notmuchmail.org +Subject: Re: [PATCH (draft) 1/2] emacs: allow the user to toggle the + visibility of multipart/alternative parts +In-Reply-To: <1351152563-27277-2-git-send-email-markwalters1009@gmail.com> +References: <1351152563-27277-1-git-send-email-markwalters1009@gmail.com> + <1351152563-27277-2-git-send-email-markwalters1009@gmail.com> +User-Agent: Notmuch/0.14+45~g6ea9330 (http://notmuchmail.org) Emacs/23.4.1 + (x86_64-pc-linux-gnu) +Date: Sat, 27 Oct 2012 20:08:49 -0400 +Message-ID: <87sj8zh2zy.fsf@betacantrips.com> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +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: Sun, 28 Oct 2012 00:08:58 -0000 + +Mark Walters writes: + +> This patch adds a keybinding to the buttons in the notmuch-show emacs +> buffer to allow the user to toggle the visibility of each part of a +> message in the show buffer. This is particularly useful for +> multipart/alternative parts where the parts are not really +> alternatives but contain different information. +> --- +> emacs/notmuch-show.el | 47 +++++++++++++++++++++++++++++++++++++++-------- +> 1 files changed, 39 insertions(+), 8 deletions(-) +> +> diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el +> index 0f54259..9157669 100644 +> --- a/emacs/notmuch-show.el +> +++ b/emacs/notmuch-show.el +> @@ -155,6 +155,10 @@ indentation." +> (make-variable-buffer-local 'notmuch-show-indent-content) +> (put 'notmuch-show-indent-content 'permanent-local t) +> +> +(defvar notmuch-show-message-multipart/alternative-display-parts nil) +> +(make-variable-buffer-local 'notmuch-show-message-multipart/alternative-display-parts) +> +(put 'notmuch-show-message-multipart/alternative-display-parts 'permanent-local t) +> + +> (defcustom notmuch-show-stash-mlarchive-link-alist +> '(("Gmane" . "http://mid.gmane.org/") +> ("MARC" . "http://marc.info/?i=") +> @@ -455,6 +459,7 @@ message at DEPTH in the current thread." +> (define-key map "v" 'notmuch-show-part-button-view) +> (define-key map "o" 'notmuch-show-part-button-interactively-view) +> (define-key map "|" 'notmuch-show-part-button-pipe) +> + (define-key map "t" 'notmuch-show-part-button-internally-show) +> map) +> "Submap for button commands") +> (fset 'notmuch-show-part-button-map notmuch-show-part-button-map) +> @@ -531,6 +536,16 @@ message at DEPTH in the current thread." +> (let ((handle (mm-make-handle (current-buffer) (list content-type)))) +> (mm-pipe-part handle)))) +> +> +(defun notmuch-show-internally-show-part (message-id nth &optional filename content-type) +> + "Set a part to be displayed internally" +> + (let ((current-parts (lax-plist-get notmuch-show-message-multipart/alternative-display-parts message-id))) +> + (setq notmuch-show-message-multipart/alternative-display-parts +> + (lax-plist-put notmuch-show-message-multipart/alternative-display-parts message-id +> + (if (memq nth current-parts) +> + (delq nth current-parts) +> + (cons nth current-parts))))) +> + (notmuch-show-refresh-view)) +> + +> (defun notmuch-show-multipart/*-to-list (part) +> (mapcar (lambda (inner-part) (plist-get inner-part :content-type)) +> (plist-get part :content))) +> @@ -543,12 +558,15 @@ message at DEPTH in the current thread." +> ;; This inserts all parts of the chosen type rather than just one, +> ;; but it's not clear that this is the wrong thing to do - which +> ;; should be chosen if there are more than one that match? +> + +> + ;; The variable user-parts says which parts should override the +> + ;; default so we use xor (handcoded since lisp does not have it). + +I don't follow the comment. user-parts isn't used in this +function. Neither is xor. + +> (mapc (lambda (inner-part) +> (let ((inner-type (plist-get inner-part :content-type))) +> - (if (or notmuch-show-all-multipart/alternative-parts +> - (string= chosen-type inner-type)) +> - (notmuch-show-insert-bodypart msg inner-part depth) +> - (notmuch-show-insert-part-header (plist-get inner-part :id) inner-type inner-type nil " (not shown)")))) +> + (notmuch-show-insert-bodypart msg inner-part depth +> + (not (or notmuch-show-all-multipart/alternative-parts +> + (string= +> chosen-type inner-type)))))) + +For what it's worth, I found this not-shown logic very confusing, and +have had to think about it seven or eight different times to make sure I +understood what's going on. I'm not sure why exactly this is, though I +could offer hypotheses -- the fact that it's split across two functions, +or the fiddling with mime-types. I'm satisfied that it's correct, but I +wish it could be made clearer. + +This is just armchair hypothesizing, but here are some ideas that might +make it more obvious what's going on: bringing the user-parts logic into +this function; making user-parts, instead of a "t" meaning "user has +toggled this", something like 'opened or 'closed and if user-parts for +this message is absent, falling back to this calculation; alternately, +prefilling user-parts with t when show is invoked, according to this +calculation, and then not using it any more; moving this +not-shown calculation into a separate function, something like notmuch-show-get-message-visibility. + +I guess I jumped into this series halfway, but why are we doing this +with the wipe/redraw technique instead of just using invisible overlays, +like we do more generally with notmuch-show? I think I agree that +toggling individual parts is a good UI approach, and this isn't a bad +way to implement it, but I wonder if we could do it better/easier if we +used emacs's builtin functionality. + +Thanks! + +Ethan -- 2.26.2