Date: Wed, 8 Feb 2012 00:10:16 -0500
From: Austin Clements <amdragon@MIT.EDU>
To: David Edmondson <dme@dme.org>
Subject: Re: [PATCH v7 1/8] emacs: Rework crypto switch toggle.
Message-ID: <20120208051016.GB27039@mit.edu>
References: <1327486729-18052-1-git-send-email-dme@dme.org>
	<1328520082-26659-1-git-send-email-dme@dme.org>
	<1328520082-26659-2-git-send-email-dme@dme.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1328520082-26659-2-git-send-email-dme@dme.org>
User-Agent: Mutt/1.5.21 (2010-09-15)
Cc: notmuch@notmuchmail.org
Precedence: list

Seems reasonable.  I'm definitely in favor of erasing buffers instead
of killing and recreating them.  Two questions below.

Quoth David Edmondson on Feb 06 at  9:21 am:
> Re-work the existing crypto switch toggle to be based on a persistant
> buffer-local variable.
> 
> To allow this, modify `notmuch-show-refresh-view' to erase and re-draw
> in the current buffer rather than killing the current buffer and
> creating a new one. (This will also allow more per-buffer behaviour in
> future patches.)
> 
> Add a binding ('$') to toggle crypto processing of the current buffer
> and remove the prefix argument approach that achieves a similar
> result.
> ---
>  emacs/notmuch-show.el |  126 ++++++++++++++++++++++++------------------------
>  emacs/notmuch.el      |    7 +--
>  2 files changed, 66 insertions(+), 67 deletions(-)
> 
> diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
> index 7469e2e..4b29dbd 100644
> --- a/emacs/notmuch-show.el
> +++ b/emacs/notmuch-show.el
> @@ -125,6 +125,22 @@ indentation."
>  		 (const :tag "View interactively"
>  			notmuch-show-interactively-view-part)))
>  
> +(defvar notmuch-show-thread-id nil)
> +(make-variable-buffer-local 'notmuch-show-thread-id)
> +(put 'notmuch-show-thread-id 'permanent-local t)
> +
> +(defvar notmuch-show-parent-buffer nil)
> +(make-variable-buffer-local 'notmuch-show-parent-buffer)
> +(put 'notmuch-show-parent-buffer 'permanent-local t)
> +
> +(defvar notmuch-show-query-context nil)
> +(make-variable-buffer-local 'notmuch-show-query-context)
> +(put 'notmuch-show-query-context 'permanent-local t)
> +
> +(defvar notmuch-show-process-crypto nil)
> +(make-variable-buffer-local 'notmuch-show-process-crypto)
> +(put 'notmuch-show-process-crypto 'permanent-local t)
> +

Do these need to be permanent-local given that refreshing is now done
by erasing the buffer instead of killing it?

>  (defmacro with-current-notmuch-show-message (&rest body)
>    "Evaluate body with current buffer set to the text of current message"
>    `(save-excursion
> @@ -421,14 +437,11 @@ message at DEPTH in the current thread."
>  
>  (defmacro notmuch-with-temp-part-buffer (message-id nth &rest body)
>    (declare (indent 2))
> -  (let ((process-crypto (make-symbol "process-crypto")))
> -    `(let ((,process-crypto notmuch-show-process-crypto))
> -       (with-temp-buffer
> -	 (setq notmuch-show-process-crypto ,process-crypto)
> -	 ;; Always acquires the part via `notmuch part', even if it is
> -	 ;; available in the JSON output.
> -	 (insert (notmuch-show-get-bodypart-internal ,message-id ,nth))
> -	 ,@body))))
> +  `(with-temp-buffer
> +     ;; Always acquires the part via `notmuch part', even if it is
> +     ;; available in the JSON output.
> +     (insert (notmuch-show-get-bodypart-internal ,message-id ,nth))
> +     ,@body))

Why is the piping of notmuch-show-process-crypto no longer necessary?
It's still buffer-local, and hence will be nil in the temp buffer.

>  
>  (defun notmuch-show-save-part (message-id nth &optional filename content-type)
>    (notmuch-with-temp-part-buffer message-id nth
> @@ -610,7 +623,7 @@ current buffer, if possible."
>  	       (sigstatus (car (plist-get part :sigstatus))))
>  	  (notmuch-crypto-insert-sigstatus-button sigstatus from))
>        ;; if we're not adding sigstatus, tell the user how they can get it
> -      (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")))
> +      (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts.")))
>  
>    (let ((inner-parts (plist-get part :content))
>  	(start (point)))
> @@ -636,7 +649,7 @@ current buffer, if possible."
>  		     (sigstatus (car (plist-get part :sigstatus))))
>  		(notmuch-crypto-insert-sigstatus-button sigstatus from))))
>        ;; if we're not adding encstatus, tell the user how they can get it
> -      (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")))
> +      (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts.")))
>  
>    (let ((inner-parts (plist-get part :content))
>  	(start (point)))
> @@ -763,8 +776,6 @@ current buffer, if possible."
>  
>  ;; Helper for parts which are generally not included in the default
>  ;; JSON output.
> -;; Uses the buffer-local variable notmuch-show-process-crypto to
> -;; determine if parts should be decrypted first.
>  (defun notmuch-show-get-bodypart-internal (message-id part-number)
>    (let ((args '("show" "--format=raw"))
>  	(part-arg (format "--part=%s" part-number)))
> @@ -918,6 +929,15 @@ current buffer, if possible."
>      ;; criteria.
>      (notmuch-show-message-visible msg (plist-get msg :match))))
>  
> +(defun notmuch-show-toggle-process-crypto ()
> +  "Toggle the processing of cryptographic MIME parts."
> +  (interactive)
> +  (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
> +  (message (if notmuch-show-process-crypto
> +	       "Processing cryptographic MIME parts."
> +	     "Not processing cryptographic MIME parts."))
> +  (notmuch-show-refresh-view))
> +
>  (defun notmuch-show-insert-tree (tree depth)
>    "Insert the message tree TREE at depth DEPTH in the current thread."
>    (let ((msg (car tree))
> @@ -933,15 +953,6 @@ current buffer, if possible."
>    "Insert the forest of threads FOREST."
>    (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
>  
> -(defvar notmuch-show-thread-id nil)
> -(make-variable-buffer-local 'notmuch-show-thread-id)
> -(defvar notmuch-show-parent-buffer nil)
> -(make-variable-buffer-local 'notmuch-show-parent-buffer)
> -(defvar notmuch-show-query-context nil)
> -(make-variable-buffer-local 'notmuch-show-query-context)
> -(defvar notmuch-show-buffer-name nil)
> -(make-variable-buffer-local 'notmuch-show-buffer-name)
> -
>  (defun notmuch-show-buttonise-links (start end)
>    "Buttonise URLs and mail addresses between START and END.
>  
> @@ -961,7 +972,7 @@ a corresponding notmuch search."
>  			'face goto-address-mail-face))))
>  
>  ;;;###autoload
> -(defun notmuch-show (thread-id &optional parent-buffer query-context buffer-name crypto-switch)
> +(defun notmuch-show (thread-id &optional parent-buffer query-context buffer-name)
>    "Run \"notmuch show\" with the given thread ID and display results.
>  
>  The optional PARENT-BUFFER is the notmuch-search buffer from
> @@ -976,46 +987,41 @@ non-nil.
>  The optional BUFFER-NAME provides the name of the buffer in
>  which the message thread is shown. If it is nil (which occurs
>  when the command is called interactively) the argument to the
> -function is used.
> -
> -The optional CRYPTO-SWITCH toggles the value of the
> -notmuch-crypto-process-mime customization variable for this show
> -buffer."
> +function is used."
>    (interactive "sNotmuch show: ")
> -  (let* ((process-crypto (if crypto-switch
> -			     (not notmuch-crypto-process-mime)
> -			   notmuch-crypto-process-mime)))
> -    (notmuch-show-worker thread-id parent-buffer query-context buffer-name process-crypto)))
> -
> -(defun notmuch-show-worker (thread-id parent-buffer query-context buffer-name process-crypto)
> -  (let* ((buffer-name (generate-new-buffer-name
> -		       (or buffer-name
> -			   (concat "*notmuch-" thread-id "*"))))
> -	 (buffer (get-buffer-create buffer-name))
> -	 (inhibit-read-only t))
> -    (switch-to-buffer buffer)
> +  (let ((buffer-name (generate-new-buffer-name
> +		      (or buffer-name
> +			  (concat "*notmuch-" thread-id "*")))))
> +    (switch-to-buffer (get-buffer-create buffer-name))
> +    ;; Set the default value for `notmuch-show-process-crypto' in this
> +    ;; buffer.
> +    (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
> +
> +    (setq notmuch-show-thread-id thread-id
> +	  notmuch-show-parent-buffer parent-buffer
> +	  notmuch-show-query-context query-context)
> +    (notmuch-show-worker)))
> +
> +(defun notmuch-show-worker ()
> +  (let ((inhibit-read-only t))
> +
>      (notmuch-show-mode)
>      ;; Don't track undo information for this buffer
>      (set 'buffer-undo-list t)
>  
> -    (setq notmuch-show-thread-id thread-id)
> -    (setq notmuch-show-parent-buffer parent-buffer)
> -    (setq notmuch-show-query-context query-context)
> -    (setq notmuch-show-buffer-name buffer-name)
> -    (setq notmuch-show-process-crypto process-crypto)
> -
>      (erase-buffer)
>      (goto-char (point-min))
>      (save-excursion
> -      (let* ((basic-args (list thread-id))
> -	     (args (if query-context
> -		       (append (list "\'") basic-args (list "and (" query-context ")\'"))
> +      (let* ((basic-args (list notmuch-show-thread-id))
> +	     (args (if notmuch-show-query-context
> +		       (append (list "\'") basic-args
> +			       (list "and (" notmuch-show-query-context ")\'"))
>  		     (append (list "\'") basic-args (list "\'")))))
>  	(notmuch-show-insert-forest (notmuch-query-get-threads args))
>  	;; If the query context reduced the results to nothing, run
>  	;; the basic query.
>  	(when (and (eq (buffer-size) 0)
> -		   query-context)
> +		   notmuch-show-query-context)
>  	  (notmuch-show-insert-forest
>  	   (notmuch-query-get-threads basic-args))))
>  
> @@ -1032,21 +1038,14 @@ buffer."
>  
>      (notmuch-show-mark-read)))
>  
> -(defun notmuch-show-refresh-view (&optional crypto-switch)
> -  "Refresh the current view (with crypto switch if prefix given).
> +(defun notmuch-show-refresh-view ()
> +  "Refresh the current view.
>  
> -Kills the current buffer and reruns notmuch show with the same
> -thread id.  If a prefix is given, crypto processing is toggled."
> -  (interactive "P")
> -  (let ((thread-id notmuch-show-thread-id)
> -	(parent-buffer notmuch-show-parent-buffer)
> -	(query-context notmuch-show-query-context)
> -	(buffer-name notmuch-show-buffer-name)
> -	(process-crypto (if crypto-switch
> -			    (not notmuch-show-process-crypto)
> -			  notmuch-show-process-crypto)))
> -    (notmuch-kill-this-buffer)
> -    (notmuch-show-worker thread-id parent-buffer query-context buffer-name process-crypto)))
> +Refreshes the current view, observing changes in cryptographic preferences."
> +  (interactive)
> +  (let ((inhibit-read-only t))
> +    (erase-buffer))
> +  (notmuch-show-worker))
>  
>  (defvar notmuch-show-stash-map
>    (let ((map (make-sparse-keymap)))
> @@ -1097,6 +1096,7 @@ thread id.  If a prefix is given, crypto processing is toggled."
>  	(define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
>  	(define-key map (kbd "RET") 'notmuch-show-toggle-message)
>  	(define-key map "#" 'notmuch-show-print-message)
> +	(define-key map "$" 'notmuch-show-toggle-process-crypto)
>  	map)
>        "Keymap for \"notmuch show\" buffers.")
>  (fset 'notmuch-show-mode-map notmuch-show-mode-map)
> diff --git a/emacs/notmuch.el b/emacs/notmuch.el
> index cd04ffd..ff0db99 100644
> --- a/emacs/notmuch.el
> +++ b/emacs/notmuch.el
> @@ -463,9 +463,9 @@ Complete list of currently available key bindings:
>    "Return a list of authors for the current region"
>    (notmuch-search-properties-in-region 'notmuch-search-subject beg end))
>  
> -(defun notmuch-search-show-thread (&optional crypto-switch)
> +(defun notmuch-search-show-thread ()
>    "Display the currently selected thread."
> -  (interactive "P")
> +  (interactive)
>    (let ((thread-id (notmuch-search-find-thread-id))
>  	(subject (notmuch-prettify-subject (notmuch-search-find-subject))))
>      (if (> (length thread-id) 0)
> @@ -473,8 +473,7 @@ Complete list of currently available key bindings:
>  		      (current-buffer)
>  		      notmuch-search-query-string
>  		      ;; Name the buffer based on the subject.
> -		      (concat "*" (truncate-string-to-width subject 30 nil nil t) "*")
> -		      crypto-switch)
> +		      (concat "*" (truncate-string-to-width subject 30 nil nil t) "*"))
>        (message "End of search results."))))
>  
>  (defun notmuch-search-reply-to-thread (&optional prompt-for-sender)