From: Mark Walters Date: Mon, 10 Jun 2013 04:57:13 +0000 (+0100) Subject: [PATCH v5 6/6] emacs: show: implement lazy hidden part handling X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=72302a41775c79c1411a30a4c059e756ef581c12;p=notmuch-archives.git [PATCH v5 6/6] emacs: show: implement lazy hidden part handling --- diff --git a/78/86ac388547baa649b4292f1a8e0b263a6aa48a b/78/86ac388547baa649b4292f1a8e0b263a6aa48a new file mode 100644 index 000000000..4af07e5f7 --- /dev/null +++ b/78/86ac388547baa649b4292f1a8e0b263a6aa48a @@ -0,0 +1,206 @@ +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 81505431FBC + for ; Sun, 9 Jun 2013 21:58:04 -0700 (PDT) +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 Vk3Quor7TBWY for ; + Sun, 9 Jun 2013 21:57:57 -0700 (PDT) +Received: from mail-ea0-f169.google.com (mail-ea0-f169.google.com + [209.85.215.169]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 172B5431E84 + for ; Sun, 9 Jun 2013 21:57:30 -0700 (PDT) +Received: by mail-ea0-f169.google.com with SMTP id h15so5104184eak.14 + for ; Sun, 09 Jun 2013 21:57:29 -0700 (PDT) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; + bh=Vkj5kgqItb6KyysLAhAUQ6l9GHKmEoOAP+CHKlMTx2Y=; + b=B1tX3nCb2a65t5z3pDzg+rF/bb/6WCFzVDJxbkuiefXLRuDx/wSSUu0Uv+Ig+9w1AB + m9zYukz3OB6FlNwlBgMyZ5CQAMcWjgh0iR3yNOwbX2Cc9dEUeCalyjq3jXal9uBAkptt + jRHgVhoa6T1tdRTvuAiNQbEOhiT4rLiVbm91NVCJIjc4PXv3ec2lEY1h4OWZ7Rcei+yD + Vb39rldZ3C6L8BBQnRGXmImMesz23E/EzccJoKxEM1AsBKMtJaFJxGWtesfDlYxgHnhj + v1rc+0bdXa49LunGvGIbvnhvaE5OCTJG2DgKmjzlzTpuOagllqbgQbsZeAkVcdEzWcvO + X9yA== +X-Received: by 10.15.54.4 with SMTP id s4mr9137295eew.49.1370840249862; + Sun, 09 Jun 2013 21:57:29 -0700 (PDT) +Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31]) + by mx.google.com with ESMTPSA id 3sm20258104een.7.2013.06.09.21.57.28 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Sun, 09 Jun 2013 21:57:29 -0700 (PDT) +From: Mark Walters +To: notmuch@notmuchmail.org, + Austin Clements +Subject: [PATCH v5 6/6] emacs: show: implement lazy hidden part handling +Date: Mon, 10 Jun 2013 05:57:13 +0100 +Message-Id: <1370840233-23258-7-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 1.7.9.1 +In-Reply-To: <1370840233-23258-1-git-send-email-markwalters1009@gmail.com> +References: <1370840233-23258-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: Mon, 10 Jun 2013 04:58:05 -0000 + +This adds the actual code to do the lazy insertion of hidden parts. + +We use a memory inefficient but simple method: when we come to insert +the part if it is hidden we just store all of the arguments to the +part insertion function as a button property. This means when we want +to show the part we can just resume where we left off. + +One thing is that we can't tell if a lazy part will produce text until +we try to render it so when unhiding a part we check to see if it +rendered; if not we invoke the default part handler (e.g. an external +viewer). + +Also, we would like to insert the lazy part at the start of the line +after the part button. But if this line has some text properties +(e.g. the colours for a following message header) then the lazy part +gets these properties. Thus we start at the end of the part button +line, insert a newline, insert the lazy part, and then delete the +extra newline at the end of the part. +--- + emacs/notmuch-show.el | 69 ++++++++++++++++++++++++++++++++++++++++++------ + 1 files changed, 60 insertions(+), 9 deletions(-) + +diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el +index 6ec70c9..d030ea3 100644 +--- a/emacs/notmuch-show.el ++++ b/emacs/notmuch-show.el +@@ -488,12 +488,14 @@ message at DEPTH in the current thread." + ;; return button + button)) + +-;; This is taken from notmuch-wash: maybe it should be unified? + (defun notmuch-show-toggle-part-invisibility (&optional button) + (interactive) + (let* ((button (or button (button-at (point)))) +- (overlay (button-get button 'overlay))) +- (when overlay ++ (overlay (button-get button 'overlay)) ++ (lazy-part (button-get button :notmuch-lazy-part))) ++ ;; We have a part to toggle if there is an overlay or if there is a lazy part. ++ ;; If neither is present we cannot toggle the part so we just return nil. ++ (when (or overlay lazy-part) + (let* ((show (button-get button :notmuch-part-hidden)) + (new-start (button-start button)) + (button-label (button-get button :base-label)) +@@ -509,7 +511,15 @@ message at DEPTH in the current thread." + (move-overlay button new-start (point)) + (delete-region (point) old-end)) + (goto-char (min old-point (1- (button-end button)))) +- (overlay-put overlay 'invisible (not show)))))) ++ ;; Return nil if there is a lazy-part, it is empty, and we are ++ ;; trying to show it. In all other cases return t. ++ (if lazy-part ++ (when show ++ (button-put button :notmuch-lazy-part nil) ++ (notmuch-show-lazy-part lazy-part button)) ++ ;; else there must be an overlay. ++ (overlay-put overlay 'invisible (not show)) ++ t))))) + + ;; MIME part renderers + +@@ -828,6 +838,39 @@ message at DEPTH in the current thread." + (pushnew :notmuch-part v) + v)))) + ++(defun notmuch-show-lazy-part (part-args button) ++ ;; Insert the lazy part after the button for the part. We would just ++ ;; move to the start of the new line following the button and insert ++ ;; the part but that point might have text properties (eg colours ++ ;; from a message header etc) so instead we start from the last ++ ;; character of the button by adding a newline and finish by ++ ;; removing the extra newline from the end of the part. ++ (save-excursion ++ (goto-char (button-end button)) ++ (insert "\n") ++ (let* ((inhibit-read-only t) ++ ;; We need to use markers for the start and end of the part ++ ;; because the part insertion functions do not guarantee ++ ;; to leave point at the end of the part. ++ (part-beg (copy-marker (point) nil)) ++ (part-end (copy-marker (point) t)) ++ ;; We have to save the depth as we can't find the depth ++ ;; when narrowed. ++ (depth (notmuch-show-get-depth))) ++ (save-restriction ++ (narrow-to-region part-beg part-end) ++ (delete-region part-beg part-end) ++ (apply #'notmuch-show-insert-bodypart-internal part-args) ++ (indent-rigidly part-beg part-end depth)) ++ (goto-char part-end) ++ (delete-char 1) ++ (notmuch-show-record-part-information (second part-args) ++ (button-start button) ++ part-end) ++ ;; Create the overlay. If the lazy-part turned out to be empty/not ++ ;; showable this returns nil. ++ (notmuch-show-create-part-overlays button part-beg part-end)))) ++ + (defun notmuch-show-insert-bodypart (msg part depth &optional hide) + "Insert the body part PART at depth DEPTH in the current thread. + +@@ -846,15 +889,21 @@ If HIDE is non-nil then initially hide this part." + (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename)))) + (content-beg (point))) + +- (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button) ++ (if (not hide) ++ (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button) ++ (button-put button :notmuch-lazy-part ++ (list msg part mime-type nth depth button))) ++ + ;; Some of the body part handlers leave point somewhere up in the + ;; part, so we make sure that we're down at the end. + (goto-char (point-max)) + ;; Ensure that the part ends with a carriage return. + (unless (bolp) + (insert "\n")) +- (notmuch-show-create-part-overlays button content-beg (point)) +- (when hide ++ ;; We do not create the overlay for hidden (lazy) parts until ++ ;; they are inserted. ++ (if (not hide) ++ (notmuch-show-create-part-overlays button content-beg (point)) + (save-excursion + (notmuch-show-toggle-part-invisibility button))) + (notmuch-show-record-part-information part beg (point)))) +@@ -2019,8 +2068,10 @@ is destroyed when FN returns." + (defun notmuch-show-part-button-default (&optional button) + (interactive) + (let ((button (or button (button-at (point))))) +- (if (button-get button 'overlay) +- (notmuch-show-toggle-part-invisibility button) ++ ;; Try to toggle the part, if that fails then call the default ++ ;; action. The toggle fails if the part has no emacs renderable ++ ;; content. ++ (unless (notmuch-show-toggle-part-invisibility button) + (call-interactively notmuch-show-part-button-default-action)))) + + (defun notmuch-show-save-part () +-- +1.7.9.1 +