[PATCH v4 5/5] emacs: show: implement lazy hidden part handling
authorMark Walters <markwalters1009@gmail.com>
Sat, 1 Jun 2013 08:15:47 +0000 (09:15 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:55:15 +0000 (09:55 -0800)
5f/d67f39055e7501495c7e8d9cb8bcac268d84c8 [new file with mode: 0644]

diff --git a/5f/d67f39055e7501495c7e8d9cb8bcac268d84c8 b/5f/d67f39055e7501495c7e8d9cb8bcac268d84c8
new file mode 100644 (file)
index 0000000..ff0e8be
--- /dev/null
@@ -0,0 +1,176 @@
+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 E9EC342116D\r
+       for <notmuch@notmuchmail.org>; Sat,  1 Jun 2013 01:16:53 -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 NWBljEH5EoLP for <notmuch@notmuchmail.org>;\r
+       Sat,  1 Jun 2013 01:16:49 -0700 (PDT)\r
+Received: from mail-wi0-f181.google.com (mail-wi0-f181.google.com\r
+       [209.85.212.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 15AD4429E5E\r
+       for <notmuch@notmuchmail.org>; Sat,  1 Jun 2013 01:16:33 -0700 (PDT)\r
+Received: by mail-wi0-f181.google.com with SMTP id hi5so1312198wib.2\r
+       for <notmuch@notmuchmail.org>; Sat, 01 Jun 2013 01:16:32 -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=Rq5NklWAD0VVhzpV/+U8P4T4nd4wtNuNte8P76DGJH8=;\r
+       b=GhAQT/nRH70leGopmj8htAOztMB/K5pj3u51q8qTLYCKdW0CHFFnAZgvlUF+dH78EO\r
+       lKUP4m+aAsNKQzHeHfH8dZWL0LvBpcRSmKvpbhY0r7QV9Qo1oiV+ruaV2s457uKoCUcH\r
+       +ycNCXeVPAJlLXwAzKw4Sh67/MDHlOICLBxggeNRNvgo26xeP0/wF36ufnzBgakS5lE5\r
+       xLcRLCImQd8gP5E+N/6WT7fQc1+WmK/3U3brfJn3xwxuLfIOzFBp2yq+ebb1dewGtCrJ\r
+       CBYwDIRBS2nmzdk8hBnHp3TkKjk+e7Qx2sWI8nZATJvvLA4rcT/vdTDwckngs9UJKvcN\r
+       S2wA==\r
+X-Received: by 10.180.149.171 with SMTP id ub11mr6103987wib.40.1370074592887; \r
+       Sat, 01 Jun 2013 01:16:32 -0700 (PDT)\r
+Received: from localhost (94.197.247.227.threembb.co.uk. [94.197.247.227])\r
+       by mx.google.com with ESMTPSA id m3sm8618664wij.5.2013.06.01.01.16.29\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sat, 01 Jun 2013 01:16:32 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org, Austin Clements <aclements@csail.mit.edu>,\r
+       Adam Wolfe Gordon <awg+notmuch@xvx.ca>\r
+Subject: [PATCH v4 5/5] emacs: show: implement lazy hidden part handling\r
+Date: Sat,  1 Jun 2013 09:15:47 +0100\r
+Message-Id: <1370074547-24677-6-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <1370074547-24677-1-git-send-email-markwalters1009@gmail.com>\r
+References: <1370074547-24677-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: Sat, 01 Jun 2013 08:16:54 -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
+ emacs/notmuch-show.el |   52 ++++++++++++++++++++++++++++++++++++++++++-------\r
+ 1 file changed, 45 insertions(+), 7 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
+index 49f85ba..92f481b 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
+@@ -807,6 +817,28 @@ message at DEPTH in the current thread."\r
+     ;; Return true if we created an overlay.\r
+     t))\r
\r
++(defun notmuch-show-lazy-part (part-args button)\r
++  ;; Insert the lazy part after the button for the part.\r
++  (save-excursion\r
++    (goto-char (1+ (button-end button)))\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
++      ;; 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
+@@ -825,7 +857,11 @@ 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
+@@ -2009,8 +2045,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.10.4\r
+\r