]> git.notmuchmail.org Git - notmuch/blobdiff - emacs/notmuch-hello.el
News for changes from Austin Clements
[notmuch] / emacs / notmuch-hello.el
index 95fd850fd32c42dc43119036eb8efb819886415e..b8ec665db6782dc55668b7295b5c9e207aa757bc 100644 (file)
   :type 'boolean
   :group 'notmuch-hello)
 
-(defun notmuch-sort-saved-searches (alist)
-  "Generate an alphabetically sorted saved searches alist."
-  (sort (copy-sequence alist) (lambda (a b) (string< (car a) (car b)))))
+(defun notmuch-sort-saved-searches (saved-searches)
+  "Generate an alphabetically sorted saved searches list."
+  (sort (copy-sequence saved-searches)
+       (lambda (a b)
+         (string< (notmuch-saved-search-get a :name)
+                  (notmuch-saved-search-get b :name)))))
 
 (defcustom notmuch-saved-search-sort-function nil
   "Function used to sort the saved searches for the notmuch-hello view.
@@ -51,8 +54,10 @@ sorting (nil) displays the saved searches in the order they are
 stored in `notmuch-saved-searches'. Sort alphabetically sorts the
 saved searches in alphabetical order. Custom sort function should
 be a function or a lambda expression that takes the saved
-searches alist as a parameter, and returns a new saved searches
-alist to be used."
+searches list as a parameter, and returns a new saved searches
+list to be used. For compatibility with the various saved-search
+formats it should use notmuch-saved-search-get to access the
+fields of the search."
   :type '(choice (const :tag "No sorting" nil)
                 (const :tag "Sort alphabetically" notmuch-sort-saved-searches)
                 (function :tag "Custom sort function"
@@ -318,12 +323,12 @@ return that."
     (setq notmuch-saved-searches
          (loop for elem in notmuch-saved-searches
                if (not (equal name
-                              (car elem)))
+                              (notmuch-saved-search-get elem :name)))
                collect elem))
     ;; Add the new one.
     (customize-save-variable 'notmuch-saved-searches
                             (add-to-list 'notmuch-saved-searches
-                                         (cons name search) t))
+                                         (list :name name :query search) t))
     (message "Saved '%s' as '%s'." search name)
     (notmuch-hello-update)))
 
@@ -338,7 +343,7 @@ return that."
 
 (defun notmuch-hello-longest-label (searches-alist)
   (or (loop for elem in searches-alist
-           maximize (length (car elem)))
+           maximize (length (notmuch-saved-search-get elem :name)))
       0))
 
 (defun notmuch-hello-reflect-generate-row (ncols nrows row list)
@@ -363,7 +368,8 @@ diagonal."
 (defun notmuch-hello-widget-search (widget &rest ignore)
   (notmuch-search (widget-get widget
                              :notmuch-search-terms)
-                 notmuch-search-oldest-first))
+                 (widget-get widget
+                             :notmuch-search-oldest-first)))
 
 (defun notmuch-saved-search-count (search)
   (car (process-lines notmuch-command "count" search)))
@@ -417,25 +423,24 @@ Otherwise, FILTER is ignored.
     (concat "(" query ") and (" filter ")"))
    (t query)))
 
-(defun notmuch-hello-query-counts (query-alist &rest options)
-  "Compute list of counts of matched messages from QUERY-ALIST.
+(defun notmuch-hello-query-counts (query-list &rest options)
+  "Compute list of counts of matched messages from QUERY-LIST.
 
-QUERY-ALIST must be a list containing elements of the form (NAME . QUERY)
-or (NAME QUERY COUNT-QUERY). If the latter form is used,
-COUNT-QUERY specifies an alternate query to be used to generate
-the count for the associated query.
+QUERY-LIST must be a list of saved-searches. Ideally each of
+these is a plist but other options are available for backwards
+compatibility: see `notmuch-saved-searches' for details.
 
-The result is the list of elements of the form (NAME QUERY COUNT).
+The result is a list of plists each of which includes the
+properties :name NAME, :query QUERY and :count COUNT, together
+with any properties in the original saved-search.
 
 The values :show-empty-searches, :filter and :filter-count from
 options will be handled as specified for
 `notmuch-hello-insert-searches'."
   (with-temp-buffer
-    (dolist (elem query-alist nil)
-      (let ((count-query (if (consp (cdr elem))
-                            ;; do we have a different query for the message count?
-                            (third elem)
-                          (cdr elem))))
+    (dolist (elem query-list nil)
+      (let ((count-query (or (notmuch-saved-search-get elem :count-query)
+                            (notmuch-saved-search-get elem :query))))
        (insert
         (replace-regexp-in-string
          "\n" " "
@@ -457,26 +462,26 @@ the CLI and emacs interface."))
      #'identity
      (mapcar
       (lambda (elem)
-       (let ((name (car elem))
-             (search-query (if (consp (cdr elem))
-                                ;; do we have a different query for the message count?
-                                (second elem)
-                             (cdr elem)))
-             (message-count (prog1 (read (current-buffer))
+       (let* ((elem-plist (notmuch-hello-saved-search-to-plist elem))
+              (search-query (plist-get elem-plist :query))
+              (filtered-query (notmuch-hello-filtered-query
+                               search-query (plist-get options :filter)))
+              (message-count (prog1 (read (current-buffer))
                                (forward-line 1))))
-         (and (or (plist-get options :show-empty-searches) (> message-count 0))
-              (list name (notmuch-hello-filtered-query
-                          search-query (plist-get options :filter))
-                    message-count))))
-      query-alist))))
+         (when (and filtered-query (or (plist-get options :show-empty-searches) (> message-count 0)))
+           (setq elem-plist (plist-put elem-plist :query filtered-query))
+           (plist-put elem-plist :count message-count))))
+      query-list))))
 
 (defun notmuch-hello-insert-buttons (searches)
   "Insert buttons for SEARCHES.
 
-SEARCHES must be a list containing lists of the form (NAME QUERY COUNT), where
-QUERY is the query to start when the button for the corresponding entry is
-activated. COUNT should be the number of messages matching the query.
-Such a list can be computed with `notmuch-hello-query-counts'."
+SEARCHES must be a list of plists each of which should contain at
+least the properties :name NAME :query QUERY and :count COUNT,
+where QUERY is the query to start when the button for the
+corresponding entry is activated, and COUNT should be the number
+of messages matching the query.  Such a plist can be computed
+with `notmuch-hello-query-counts'."
   (let* ((widest (notmuch-hello-longest-label searches))
         (tags-and-width (notmuch-hello-tags-per-line widest))
         (tags-per-line (car tags-and-width))
@@ -494,14 +499,19 @@ Such a list can be computed with `notmuch-hello-query-counts'."
            (when elem
              (if (> column-indent 0)
                  (widget-insert (make-string column-indent ? )))
-             (let* ((name (first elem))
-                    (query (second elem))
-                    (msg-count (third elem)))
+             (let* ((name (plist-get elem :name))
+                    (query (plist-get elem :query))
+                    (oldest-first (case (plist-get elem :sort-order)
+                                    (newest-first nil)
+                                    (oldest-first t)
+                                    (otherwise notmuch-search-oldest-first)))
+                    (msg-count (plist-get elem :count)))
                (widget-insert (format "%8s "
                                       (notmuch-hello-nice-number msg-count)))
                (widget-create 'push-button
                               :notify #'notmuch-hello-widget-search
                               :notmuch-search-terms query
+                              :notmuch-search-oldest-first oldest-first
                               name)
                (setq column-indent
                      (1+ (max 0 (- column-width (length name)))))))
@@ -738,13 +748,15 @@ Complete list of currently available key bindings:
       (indent-rigidly start (point) notmuch-hello-indent))
     nil))
 
-(defun notmuch-hello-insert-searches (title query-alist &rest options)
-  "Insert a section with TITLE showing a list of buttons made from QUERY-ALIST.
+(defun notmuch-hello-insert-searches (title query-list &rest options)
+  "Insert a section with TITLE showing a list of buttons made from QUERY-LIST.
 
-QUERY-ALIST must be a list containing elements of the form (NAME . QUERY)
-or (NAME QUERY COUNT-QUERY). If the latter form is used,
-COUNT-QUERY specifies an alternate query to be used to generate
-the count for the associated item.
+QUERY-LIST should ideally be a plist but for backwards
+compatibility other forms are also accepted (see
+`notmuch-saved-searches' for details).  The plist should
+contain keys :name and :query; if :count-query is also present
+then it specifies an alternate query to be used to generate the
+count for the associated search.
 
 Supports the following entries in OPTIONS as a plist:
 :initially-hidden - if non-nil, section will be hidden on startup
@@ -778,7 +790,7 @@ Supports the following entries in OPTIONS as a plist:
                     "hide"))
     (widget-insert "\n")
     (when (not is-hidden)
-      (let ((searches (apply 'notmuch-hello-query-counts query-alist options)))
+      (let ((searches (apply 'notmuch-hello-query-counts query-list options)))
        (when (or (not (plist-get options :hide-if-empty))
                  searches)
          (widget-insert "\n")