[PATCH] emacs: tree: support fold/unfold thread
massonju.eseo at gmail.com
Thu Mar 21 07:26:44 PDT 2019
This patch allow the user to fold/unfold a thread in the current tree
buffer by pressing "t" key.
By default a string is displayed at the beginning of the overlay to
indicate that this thread is folded.
Pressing again "t" on a folded thread will unfold it.
This feature works accross all the queries which are in Tree View.
Signed-off-by: Julien Masson <massonju.eseo at gmail.com>
I started to write this feature only for myself and some people around
me were interested so I thought it might be interesting to share with
you as well :)
Please tell me if you want to change some default value:
-> "t" key bind to notmuch-tree-toggle-folding-thread
I personnaly bind <TAB> to notmuch-tree-toggle-folding-thread
emacs/notmuch-tree.el | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 73 insertions(+)
diff --git a/emacs/notmuch-tree.el b/emacs/notmuch-tree.el
index c00315e..7227692 100644
@@ -71,6 +71,11 @@ Note the author string should not contain
:type '(alist :key-type (string) :value-type (string))
+(defcustom notmuch-tree-overlay-string " [...]"
+ "String displayed at the beginning of the overlay"
+ :type 'string
+ :group 'notmuch-tree)
;; Faces for messages that match the query.
'((t :inherit default))
@@ -159,6 +164,13 @@ Note the author string should not contain
+;; Faces for overlays
+ '((t :inherit 'font-lock-keyword-face))
+ "Default face used to display `notmuch-tree-overlay-string'"
+ :group 'notmuch-tree
+ :group 'notmuch-faces)
"The subject of the most recent result shown during the async display")
@@ -196,6 +208,9 @@ if the user has loaded a different buffer in that window.")
(put 'notmuch-tree-message-buffer 'permanent-local t)
+(defvar notmuch-tree-overlays nil
+ "List of overlays used to fold/unfold thread")
(defun notmuch-tree-to-message-pane (func)
"Execute FUNC in message pane.
@@ -294,6 +309,7 @@ FUNC."
(define-key map " " 'notmuch-tree-scroll-or-next)
(define-key map (kbd "DEL") 'notmuch-tree-scroll-message-window-back)
(define-key map "e" 'notmuch-tree-resume-message)
+ (define-key map "t" 'notmuch-tree-toggle-folding-thread)
(fset 'notmuch-tree-mode-map notmuch-tree-mode-map)
@@ -415,6 +431,60 @@ NOT change the database."
(message "No message to resume!"))))
+(defun notmuch-tree-find-overlay (buffer start end)
+ "Return the first overlay found in `notmuch-tree-overlays'.
+The overlay found is located between START and END position in BUFFER."
+ (seq-find (lambda (ov)
+ (and (eq (overlay-buffer ov) buffer)
+ (<= (overlay-start ov) start)
+ (>= (overlay-end ov) end)))
+(defun notmuch-tree-clean-up-overlays ()
+ "Remove overlays not referenced to any buffer"
+ (setq notmuch-tree-overlays (seq-filter #'overlay-buffer notmuch-tree-overlays)))
+(defun notmuch-tree-remove-overlay (overlay)
+ "Delete OVERLAY and remove it from `notmuch-tree-overlays' list"
+ (setq notmuch-tree-overlays (remove overlay notmuch-tree-overlays))
+ (delete-overlay overlay))
+(defun notmuch-tree-add-overlay (start end)
+ "Add an overlay from START to END in the current buffer.
+If non nil, `notmuch-tree-overlay-string' is added at the end of the line.
+The overlay created is added to `notmuch-tree-overlays' list"
+ (let ((overlay (make-overlay start end)))
+ (add-to-list 'notmuch-tree-overlays overlay)
+ (overlay-put overlay 'invisible t)
+ (when notmuch-tree-overlay-string
+ (overlay-put overlay 'before-string
+ (propertize notmuch-tree-overlay-string
+ 'face 'notmuch-tree-overlay-fold-face)))))
+(defun notmuch-tree-thread-range ()
+ "Return list of Start and End position of the current thread"
+ (let (start end)
+ (while (not (or (notmuch-tree-get-prop :first) (eobp)))
+ (forward-line -1))
+ (setq start (line-end-position))
+ (setq end (- (point) 1))
+ (list start end))))
+(defun notmuch-tree-toggle-folding-thread ()
+ "Fold / Unfold the current thread"
+ (cl-multiple-value-bind (start end)
+ (unless (= start end)
+ (let ((overlay (notmuch-tree-find-overlay (current-buffer) start end)))
+ (if overlay
+ (notmuch-tree-remove-overlay overlay)
+ (notmuch-tree-add-overlay start end))))))
;; The next two functions close the message window before calling
;; notmuch-search or notmuch-tree but they do so after the user has
;; entered the query (in case the user was basing the query on
@@ -966,6 +1036,9 @@ The arguments are:
;; Don't track undo information for this buffer
(set 'buffer-undo-list t)
+ ;; clean-up overlays in case where some overlays reference to no buffer
(notmuch-tree-worker query query-context target open-target)
(setq truncate-lines t))
More information about the notmuch