[PATCH] emacs: simplify point placement in notmuch-hello refresh
authorJani Nikula <jani@nikula.org>
Sat, 29 Sep 2012 22:44:24 +0000 (01:44 +0300)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:49:39 +0000 (09:49 -0800)
a0/f723101ef9a3c1abd36578843a1ebb511064b6 [new file with mode: 0644]

diff --git a/a0/f723101ef9a3c1abd36578843a1ebb511064b6 b/a0/f723101ef9a3c1abd36578843a1ebb511064b6
new file mode 100644 (file)
index 0000000..c9d18e9
--- /dev/null
@@ -0,0 +1,231 @@
+Return-Path: <jani@nikula.org>\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 12D38431FBF\r
+       for <notmuch@notmuchmail.org>; Sat, 29 Sep 2012 15:44:33 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[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 yNF91DCDK6yv for <notmuch@notmuchmail.org>;\r
+       Sat, 29 Sep 2012 15:44:31 -0700 (PDT)\r
+Received: from mail-la0-f53.google.com (mail-la0-f53.google.com\r
+       [209.85.215.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id DFD1E431FBC\r
+       for <notmuch@notmuchmail.org>; Sat, 29 Sep 2012 15:44:30 -0700 (PDT)\r
+Received: by lahl5 with SMTP id l5so1764378lah.26\r
+       for <notmuch@notmuchmail.org>; Sat, 29 Sep 2012 15:44:27 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=google.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:x-gm-message-state;\r
+       bh=F/r4f7Sko/+5gg0Qbrd2wDMOVTWf1s9WA7cDqQbN6Jk=;\r
+       b=ZqV0pOZsB5Hb5rHGLFnrElo1czx1aKuntWXa1pNDgOB6mxMtaAjKKRwoah/nek5aEb\r
+       JxVDJvXyLoG3/bdwmFrjMXKTAXQWPGLB8tTpMvq5aolD2CYwJoJAJHr4rVx/1CIFe9kv\r
+       lUKRN3xK2Qai6YOouVXC4FHqsVm6XV6iFDEhaxvIazsVuUZy5RHE6VOijCtj+HwpU9vZ\r
+       1vdDvz4LvsCOugM8jzSC+6vXsEclNjX6sBaVaMjyORlOVVin4zm3zmlEwKyjW7z/7z36\r
+       ZOTBMzUbFtGbKYbZMPv7B9HIQz2wXdCSo1ZdOWtyxy2wsPeS7Ti+XJHuynHYGyhN9I1R\r
+       l68g==\r
+Received: by 10.152.104.44 with SMTP id gb12mr8685384lab.29.1348958667882;\r
+       Sat, 29 Sep 2012 15:44:27 -0700 (PDT)\r
+Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi.\r
+       [80.223.81.27])\r
+       by mx.google.com with ESMTPS id i3sm3400208lbg.10.2012.09.29.15.44.26\r
+       (version=SSLv3 cipher=OTHER); Sat, 29 Sep 2012 15:44:27 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] emacs: simplify point placement in notmuch-hello refresh\r
+Date: Sun, 30 Sep 2012 01:44:24 +0300\r
+Message-Id: <1348958664-1767-1-git-send-email-jani@nikula.org>\r
+X-Mailer: git-send-email 1.7.9.5\r
+X-Gm-Message-State:\r
+ ALoCoQkuff16wuETSKd1EsxI5UhEhqmspvDEE0U124DMyDW8ZJlpcM+QXNesXEBOTcbXhGS+l8dM\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, 29 Sep 2012 22:44:33 -0000\r
+\r
+notmuch-hello (called also through notmuch-hello-update, bound to '='\r
+by default) tries to find the widget under or following point before\r
+refresh, and put the point back to the widget afterwards. The code has\r
+grown quite complicated, and has at least the following issues:\r
+\r
+1) All the individual section functions have to include code to\r
+   support point placement. If there is no such support, point is\r
+   dropped to the search box. Only saved searches and all tags\r
+   sections support point placement.\r
+\r
+2) Point placement is based on widget-value. If there are two widgets\r
+   with the same widget-value (for example a saved search with the\r
+   same name as a tag) the point is moved to the earlier one, even if\r
+   point was on the later one.\r
+\r
+3) When first entering notmuch-hello notmuch-hello-target is nil, and\r
+   point is dropped to the search box.\r
+\r
+Moving the point to the search box is annoying because the user is\r
+required to move the point before being able to enter key bindings.\r
+\r
+Simplify the code by removing all point placement based on widgets, as\r
+it does not work properly, and trying to fix that would unnecessarily\r
+complicate the code.\r
+\r
+Point is simply saved before refresh, and put back to where it\r
+was. Sometimes, if notmuch-show-empty-saved-searches is nil, and the\r
+refresh adds or removes saved searches from the list, this has the\r
+appearance of moving the point relative to the nearest widgets. This\r
+is a much smaller and less frequent problem than the ones listed\r
+above.\r
+\r
+---\r
+\r
+I've sent this before months ago, and received comments starting at\r
+id:"87aa2aohjs.fsf@gmail.com". I find the current behaviour annoying,\r
+and I prefer this simple fix over complicating the existing\r
+mess. Nobody has stood up to do anything better anyway. Perhaps we\r
+could take a step forward with this while waiting for Someone(tm) to\r
+come up with the perfect point placement?\r
+---\r
+ emacs/notmuch-hello.el |   70 ++++++++++++------------------------------------\r
+ 1 file changed, 17 insertions(+), 53 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el\r
+index 684bedc..04d90cf 100644\r
+--- a/emacs/notmuch-hello.el\r
++++ b/emacs/notmuch-hello.el\r
+@@ -154,11 +154,6 @@ International Bureau of Weights and Measures."\r
+ (defvar notmuch-hello-url "http://notmuchmail.org"\r
+   "The `notmuch' web site.")\r
\r
+-(defvar notmuch-hello-search-pos nil\r
+-  "Position of search widget, if any.\r
+-\r
+-This should only be set by `notmuch-hello-insert-search'.")\r
+-\r
+ (defvar notmuch-hello-custom-section-options\r
+   '((:filter (string :tag "Filter for each tag"))\r
+     (:filter-count (string :tag "Different filter to generate message counts"))\r
+@@ -209,11 +204,8 @@ function produces a section simply by adding content to the current\r
+ buffer.  A section should not end with an empty line, because a\r
+ newline will be inserted after each section by `notmuch-hello'.\r
\r
+-Each function should take no arguments.  If the produced section\r
+-includes `notmuch-hello-target' (i.e. cursor should be positioned\r
+-inside this section), the function should return this element's\r
+-position.\r
+-Otherwise, it should return nil.\r
++Each function should take no arguments. The return value is\r
++ignored.\r
\r
+ For convenience an element can also be a list of the form (FUNC ARG1\r
+ ARG2 .. ARGN) in which case FUNC will be applied to the rest of the\r
+@@ -240,15 +232,6 @@ supported for \"Customized queries section\" items."\r
+           notmuch-hello-query-section\r
+           (function :tag "Custom section"))))\r
\r
+-(defvar notmuch-hello-target nil\r
+-  "Button text at position of point before rebuilding the notmuch-buffer.\r
+-\r
+-This variable contains the text of the button, if any, the\r
+-point was positioned at before the notmuch-hello buffer was\r
+-rebuilt. This should never actually be global and is defined as a\r
+-defvar only for documentation purposes and to avoid a compiler\r
+-warning about it occurring as a free variable.")\r
+-\r
+ (defvar notmuch-hello-hidden-sections nil\r
+   "List of sections titles whose contents are hidden")\r
\r
+@@ -449,8 +432,6 @@ Such a list can be computed with `notmuch-hello-query-counts'."\r
+                    (msg-count (third elem)))\r
+               (widget-insert (format "%8s "\r
+                                      (notmuch-hello-nice-number msg-count)))\r
+-              (if (string= name notmuch-hello-target)\r
+-                  (setq found-target-pos (point-marker)))\r
+               (widget-create 'push-button\r
+                              :notify #'notmuch-hello-widget-search\r
+                              :notmuch-search-terms query\r
+@@ -589,7 +570,6 @@ Complete list of currently available key bindings:\r
+ (defun notmuch-hello-insert-search ()\r
+   "Insert a search widget."\r
+   (widget-insert "Search: ")\r
+-  (setq notmuch-hello-search-pos (point-marker))\r
+   (widget-create 'editable-field\r
+                ;; Leave some space at the start and end of the\r
+                ;; search boxes.\r
+@@ -763,13 +743,7 @@ following:\r
+       (set-buffer "*notmuch-hello*")\r
+     (switch-to-buffer "*notmuch-hello*"))\r
\r
+-  (let ((notmuch-hello-target (if (widget-at)\r
+-                                (widget-value (widget-at))\r
+-                              (condition-case nil\r
+-                                  (progn\r
+-                                    (widget-forward 1)\r
+-                                    (widget-value (widget-at)))\r
+-                                (error nil))))\r
++  (let ((final-target-pos (point))\r
+       (inhibit-read-only t))\r
\r
+     ;; Delete all editable widget fields.  Editable widget fields are\r
+@@ -788,30 +762,20 @@ following:\r
+       (mapc 'delete-overlay (car all))\r
+       (mapc 'delete-overlay (cdr all)))\r
\r
+-    (let (final-target-pos)\r
+-      (mapc\r
+-       (lambda (section)\r
+-       (let ((point-before (point))\r
+-             (result (if (functionp section)\r
+-                         (funcall section)\r
+-                       (apply (car section) (cdr section)))))\r
+-         (if (and (not final-target-pos) (integer-or-marker-p result))\r
+-             (setq final-target-pos result))\r
+-         ;; don't insert a newline when the previous section didn't show\r
+-         ;; anything.\r
+-         (unless (eq (point) point-before)\r
+-           (widget-insert "\n"))))\r
+-       notmuch-hello-sections)\r
+-      (widget-setup)\r
+-\r
+-      (when final-target-pos\r
+-      (goto-char final-target-pos)\r
+-      (unless (widget-at)\r
+-        (widget-forward 1)))\r
+-\r
+-      (unless (widget-at)\r
+-      (when notmuch-hello-search-pos\r
+-        (goto-char notmuch-hello-search-pos)))))\r
++    (mapc\r
++     (lambda (section)\r
++       (let ((point-before (point)))\r
++       (if (functionp section)\r
++           (funcall section)\r
++         (apply (car section) (cdr section)))\r
++       ;; don't insert a newline when the previous section didn't\r
++       ;; show anything.\r
++       (unless (eq (point) point-before)\r
++         (widget-insert "\n"))))\r
++     notmuch-hello-sections)\r
++    (widget-setup)\r
++\r
++    (goto-char final-target-pos))\r
+   (run-hooks 'notmuch-hello-refresh-hook)\r
+   (setq notmuch-hello-first-run nil))\r
\r
+-- \r
+1.7.9.5\r
+\r