contrib: pick: add docstring for notmuch-pick-worker

[notmuch] / contrib / notmuch-pick / notmuch-pick.el

diff --git a/contrib/notmuch-pick/notmuch-pick.el b/contrib/notmuch-pick/notmuch-pick.el
index d016014430d94071c9b08d626550532546ce4c6c..5dcc9426b5aa61df1e4c4d7331f504c21034376b 100644 (file)
--- a/contrib/notmuch-pick/notmuch-pick.el
+++ b/contrib/notmuch-pick/notmuch-pick.el
@@ -161,10 +161,6 @@
   "A buffer local copy of argument open-target to the function notmuch-pick")
 (make-variable-buffer-local 'notmuch-pick-open-target)
 
   "A buffer local copy of argument open-target to the function notmuch-pick")
 (make-variable-buffer-local 'notmuch-pick-open-target)
 

-(defvar notmuch-pick-buffer-name nil
-  "A buffer local copy of argument buffer-name to the function notmuch-pick")
-(make-variable-buffer-local 'notmuch-pick-buffer-name)
-

 (defvar notmuch-pick-message-window nil
   "The window of the message pane.
 
 (defvar notmuch-pick-message-window nil
   "The window of the message pane.
 


@@ -250,6 +246,8 @@ FUNC."
     (define-key map "p" 'notmuch-pick-prev-matching-message)
     (define-key map "N" 'notmuch-pick-next-message)
     (define-key map "P" 'notmuch-pick-prev-message)
     (define-key map "p" 'notmuch-pick-prev-matching-message)
     (define-key map "N" 'notmuch-pick-next-message)
     (define-key map "P" 'notmuch-pick-prev-message)

+    (define-key map (kbd "M-p") 'notmuch-pick-prev-thread)
+    (define-key map (kbd "M-n") 'notmuch-pick-next-thread)

     (define-key map "-" 'notmuch-pick-remove-tag)
     (define-key map "+" 'notmuch-pick-add-tag)
     (define-key map "*" 'notmuch-pick-tag-thread)
     (define-key map "-" 'notmuch-pick-remove-tag)
     (define-key map "+" 'notmuch-pick-add-tag)
     (define-key map "*" 'notmuch-pick-tag-thread)


@@ -588,19 +586,28 @@ message will be \"unarchived\", i.e. the tag changes in
   (let ((inhibit-read-only t)
        (basic-query notmuch-pick-basic-query)
        (query-context notmuch-pick-query-context)
   (let ((inhibit-read-only t)
        (basic-query notmuch-pick-basic-query)
        (query-context notmuch-pick-query-context)

-       (target (notmuch-pick-get-message-id))
-       (buffer-name notmuch-pick-buffer-name))
+       (target (notmuch-pick-get-message-id)))

     (erase-buffer)
     (notmuch-pick-worker basic-query
                         query-context
     (erase-buffer)
     (notmuch-pick-worker basic-query
                         query-context

-                        target
-                        (get-buffer buffer-name))))
+                        target)))

 
 (defun notmuch-pick-thread-top ()
   (when (notmuch-pick-get-message-properties)
     (while (not (or (notmuch-pick-get-prop :first) (eobp)))
       (forward-line -1))))
 
 
 (defun notmuch-pick-thread-top ()
   (when (notmuch-pick-get-message-properties)
     (while (not (or (notmuch-pick-get-prop :first) (eobp)))
       (forward-line -1))))
 

+(defun notmuch-pick-prev-thread ()
+  (interactive)
+  (forward-line -1)
+  (notmuch-pick-thread-top))
+
+(defun notmuch-pick-next-thread ()
+  (interactive)
+  (forward-line 1)
+  (while (not (or (notmuch-pick-get-prop :first) (eobp)))
+    (forward-line 1)))
+

 (defun notmuch-pick-thread-mapcar (function)
   "Iterate through all messages in the current thread
  and call FUNCTION for side effects."
 (defun notmuch-pick-thread-mapcar (function)
   "Iterate through all messages in the current thread
  and call FUNCTION for side effects."


@@ -846,12 +853,15 @@ Complete list of currently available key bindings:
        (notmuch-sexp-parse-partial-list 'notmuch-pick-insert-forest-thread
                                         results-buf)))))
 
        (notmuch-sexp-parse-partial-list 'notmuch-pick-insert-forest-thread
                                         results-buf)))))
 

-(defun notmuch-pick-worker (basic-query &optional query-context target buffer open-target)
+(defun notmuch-pick-worker (basic-query &optional query-context target open-target)
+  "Insert the actual pick search in the current buffer.
+
+This is is a helper function for notmuch-pick. The arguments are
+the same as for the function notmuch-pick."

   (interactive)
   (notmuch-pick-mode)
   (setq notmuch-pick-basic-query basic-query)
   (setq notmuch-pick-query-context query-context)
   (interactive)
   (notmuch-pick-mode)
   (setq notmuch-pick-basic-query basic-query)
   (setq notmuch-pick-query-context query-context)

-  (setq notmuch-pick-buffer-name (buffer-name buffer))

   (setq notmuch-pick-target-msg target)
   (setq notmuch-pick-open-target open-target)
 
   (setq notmuch-pick-target-msg target)
   (setq notmuch-pick-open-target open-target)
 


@@ -864,7 +874,7 @@ Complete list of currently available key bindings:
     (if (equal (car (process-lines notmuch-command "count" search-args)) "0")
        (setq search-args basic-query))
     (let ((proc (notmuch-start-notmuch
     (if (equal (car (process-lines notmuch-command "count" search-args)) "0")
        (setq search-args basic-query))
     (let ((proc (notmuch-start-notmuch

-                "notmuch-pick" buffer #'notmuch-pick-process-sentinel
+                "notmuch-pick" (current-buffer) #'notmuch-pick-process-sentinel

                 "show" "--body=false" "--format=sexp"
                 message-arg search-args))
          ;; Use a scratch buffer to accumulate partial output.
                 "show" "--body=false" "--format=sexp"
                 message-arg search-args))
          ;; Use a scratch buffer to accumulate partial output.


@@ -897,13 +907,13 @@ The arguments are:
                                        (concat "*notmuch-pick-" query "*")))))
        (inhibit-read-only t))
 
                                        (concat "*notmuch-pick-" query "*")))))
        (inhibit-read-only t))
 

-    (switch-to-buffer buffer)
-    ;; Don't track undo information for this buffer
-    (set 'buffer-undo-list t)
+    (switch-to-buffer buffer))
+  ;; Don't track undo information for this buffer
+  (set 'buffer-undo-list t)

 
 

-    (notmuch-pick-worker query query-context target buffer open-target)
+  (notmuch-pick-worker query query-context target open-target)

 
 

-    (setq truncate-lines t)))
+  (setq truncate-lines t))

 
 
 ;; Set up key bindings from the rest of notmuch.
 
 
 ;; Set up key bindings from the rest of notmuch.