[PATCH v5 6/6] emacs: show: implement lazy hidden part handling
authorMark Walters <markwalters1009@gmail.com>
Mon, 10 Jun 2013 04:57:13 +0000 (05:57 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:55:31 +0000 (09:55 -0800)
78/86ac388547baa649b4292f1a8e0b263a6aa48a [new file with mode: 0644]

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