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