notmuch.el: notmuch-search: avoid wiping out buffer-local variables

notmuch.el: notmuch-search: avoid wiping out buffer-local variables

[Sean Whitton]

Hello,

I have some code to cycle through a list of searches.  The remaining
searches are stored in a buffer-local variable, working something like
this (simplified):

    (defun spw/next-unread-group ()
           (interactive)
           (notmuch-search (car spw/more-unread-groups)
           (set (make-local-variable 'spw/more-unread-groups)
                (cdr spw/more-unread-groups))))

However, my spw/more-unread-groups variable gets wiped out by
notmuch-refresh-this-buffer, because the latter calls
notmuch-search-mode, and major modes wipe out buffer-local variables.

So far as I can tell that call doesn't actually have any effect when the
mode is already notmuch-search-mode, so may I propose this patch to
support my use case:

diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index dd18f2e1..dcbc1eb2 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -987,7 +987,8 @@ the configured default sort order."
     (if no-display
 	(set-buffer buffer)
       (switch-to-buffer buffer))
-    (notmuch-search-mode)
+    (unless (eq major-mode 'notmuch-search-mode)
+      (notmuch-search-mode))
     ;; Don't track undo information for this buffer
     (set 'buffer-undo-list t)
     (set 'notmuch-search-query-string query)

-- 
Sean Whitton

Re: notmuch.el: notmuch-search: avoid wiping out buffer-local variables

[David Edmondson]

On Tuesday, 2020-07-21 at 16:03:27 -07, Sean Whitton wrote:

> Hello,
>
> I have some code to cycle through a list of searches.  The remaining
> searches are stored in a buffer-local variable, working something like
> this (simplified):
>
>     (defun spw/next-unread-group ()
>            (interactive)
>            (notmuch-search (car spw/more-unread-groups)
>            (set (make-local-variable 'spw/more-unread-groups)
>                 (cdr spw/more-unread-groups))))
>
> However, my spw/more-unread-groups variable gets wiped out by
> notmuch-refresh-this-buffer, because the latter calls
> notmuch-search-mode, and major modes wipe out buffer-local variables.
>
> So far as I can tell that call doesn't actually have any effect when the
> mode is already notmuch-search-mode, so may I propose this patch to
> support my use case:

Seems reasonable. Could you add a comment in the code explaining that
it's to avoid clobbering third-party buffer local variables?

> diff --git a/emacs/notmuch.el b/emacs/notmuch.el
> index dd18f2e1..dcbc1eb2 100644
> --- a/emacs/notmuch.el
> +++ b/emacs/notmuch.el
> @@ -987,7 +987,8 @@ the configured default sort order."
>      (if no-display
>  	(set-buffer buffer)
>        (switch-to-buffer buffer))
> -    (notmuch-search-mode)
> +    (unless (eq major-mode 'notmuch-search-mode)
> +      (notmuch-search-mode))
>      ;; Don't track undo information for this buffer
>      (set 'buffer-undo-list t)
>      (set 'notmuch-search-query-string query)
>
> -- 
> Sean Whitton
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org

dme.
-- 
What did you learn today? I learnt nothing.

[PATCH] emacs: notmuch-search: avoid wiping out buffer-local variables

[Sean Whitton]

---
 emacs/notmuch.el | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index dd18f2e1..c97997fe 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -987,7 +987,11 @@ the configured default sort order."
     (if no-display
 	(set-buffer buffer)
       (switch-to-buffer buffer))
-    (notmuch-search-mode)
+    ;; avoid wiping out third party buffer-local variables in the case
+    ;; where we're just refreshing or changing the sort order of an
+    ;; existing search results buffer
+    (unless (eq major-mode 'notmuch-search-mode)
+      (notmuch-search-mode))
     ;; Don't track undo information for this buffer
     (set 'buffer-undo-list t)
     (set 'notmuch-search-query-string query)
-- 
2.27.0

Re: [PATCH] emacs: notmuch-search: avoid wiping out buffer-local variables

[David Edmondson]

On Wednesday, 2020-07-22 at 08:11:32 -07, Sean Whitton wrote:
>

Reviewed-by: David Edmondson <dme@dme.org>

> ---
>  emacs/notmuch.el | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/emacs/notmuch.el b/emacs/notmuch.el
> index dd18f2e1..c97997fe 100644
> --- a/emacs/notmuch.el
> +++ b/emacs/notmuch.el
> @@ -987,7 +987,11 @@ the configured default sort order."
>      (if no-display
>  	(set-buffer buffer)
>        (switch-to-buffer buffer))
> -    (notmuch-search-mode)
> +    ;; avoid wiping out third party buffer-local variables in the case
> +    ;; where we're just refreshing or changing the sort order of an
> +    ;; existing search results buffer
> +    (unless (eq major-mode 'notmuch-search-mode)
> +      (notmuch-search-mode))
>      ;; Don't track undo information for this buffer
>      (set 'buffer-undo-list t)
>      (set 'notmuch-search-query-string query)
> -- 
> 2.27.0
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org

dme.
-- 
Hello? Is anybody home? Well, you don't know me, but I know you.

Re: [PATCH] emacs: notmuch-search: avoid wiping out buffer-local variables

[David Bremner]

Sean Whitton <spwhitton@spwhitton.name> writes:

> ---
>  emacs/notmuch.el | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)

applied to master

d