[PATCH v2 0/3] Allow functions in notmuch-*-result-format

[PATCH v2 0/3] Allow functions in notmuch-*-result-format

[David Edmondson]

As well as allowing headers to be specified in the various result
format lists, allow functions that can be used to implement per-user
logic when generating the results.

David Edmondson (3):
  emacs: Use pcase in notmuch-search-insert-field
  emacs: Allow functions in notmuch-search-result-format
  emacs: Allow functions in notmuch-{tree,unthreaded}-result-format

 emacs/notmuch-tree.el |  3 +++
 emacs/notmuch.el      | 47 +++++++++++++++++++++++++------------------
 2 files changed, 30 insertions(+), 20 deletions(-)

-- 
2.29.2

[PATCH v2 1/3] emacs: Use pcase in notmuch-search-insert-field

[David Edmondson]

Rather than lots of string-equal calls, use the pcase macro.
---
 emacs/notmuch.el | 44 +++++++++++++++++++++++---------------------
 1 file changed, 23 insertions(+), 21 deletions(-)

diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index 83bcee57..efbf5bd0 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -65,7 +65,9 @@
 
 ;;; Code:
 
-(eval-when-compile (require 'cl-lib))
+(eval-when-compile
+  (require 'cl-lib)
+  (require 'pcase))
 
 (require 'mm-view)
 (require 'message)
@@ -822,26 +824,26 @@ non-authors is found, assume that all of the authors match."
       (insert padding))))
 
 (defun notmuch-search-insert-field (field format-string result)
-  (cond
-   ((string-equal field "date")
-    (insert (propertize (format format-string (plist-get result :date_relative))
-			'face 'notmuch-search-date)))
-   ((string-equal field "count")
-    (insert (propertize (format format-string
-				(format "[%s/%s]" (plist-get result :matched)
-					(plist-get result :total)))
-			'face 'notmuch-search-count)))
-   ((string-equal field "subject")
-    (insert (propertize (format format-string
-				(notmuch-sanitize (plist-get result :subject)))
-			'face 'notmuch-search-subject)))
-   ((string-equal field "authors")
-    (notmuch-search-insert-authors
-     format-string (notmuch-sanitize (plist-get result :authors))))
-   ((string-equal field "tags")
-    (let ((tags (plist-get result :tags))
-	  (orig-tags (plist-get result :orig-tags)))
-      (insert (format format-string (notmuch-tag-format-tags tags orig-tags)))))))
+  (pcase field
+    ("date"
+     (insert (propertize (format format-string (plist-get result :date_relative))
+			 'face 'notmuch-search-date)))
+    ("count"
+     (insert (propertize (format format-string
+				 (format "[%s/%s]" (plist-get result :matched)
+					 (plist-get result :total)))
+			 'face 'notmuch-search-count)))
+    ("subject"
+     (insert (propertize (format format-string
+				 (notmuch-sanitize (plist-get result :subject)))
+			 'face 'notmuch-search-subject)))
+    ("authors"
+     (notmuch-search-insert-authors format-string
+				    (notmuch-sanitize (plist-get result :authors))))
+    ("tags"
+     (let ((tags (plist-get result :tags))
+	   (orig-tags (plist-get result :orig-tags)))
+       (insert (format format-string (notmuch-tag-format-tags tags orig-tags)))))))
 
 (defun notmuch-search-show-result (result pos)
   "Insert RESULT at POS."
-- 
2.29.2

[PATCH v2 2/3] emacs: Allow functions in notmuch-search-result-format

[David Edmondson]

If the car of an element in notmuch-search-result-format is a
function, insert the result of calling the function into the buffer.

This allows a user to generate custom fields in the output of a search
result. For example, with:

(defun -notmuch-result-flags (format-string result)
  (let ((tags-to-letters '(("flagged" . "!")
			   ("unread" . "u")
			   ("mine" . "m")
			   ("sent" . "s")
			   ("replied" . "r")))
	(tags (plist-get result :tags)))

    (format format-string
	    (mapconcat (lambda (t2l)
			 (if (member (car t2l) tags)
			     (cdr t2l)
			   " "))
		       tags-to-letters ""))))

(setq notmuch-search-result-format '((-notmuch-result-flags . "%s ")
				     ("date" . "%12s ")
				     ("count" . "%9s ")
				     ("authors" . "%-30s ")
				     ("subject" . "%s ")
				     ("tags" . "(%s)")))

The first few characters on each line of the search result are used to
show information about some significant tags associated with the
thread.
---
 emacs/notmuch.el | 45 +++++++++++++++++++++++++--------------------
 1 file changed, 25 insertions(+), 20 deletions(-)

diff --git a/emacs/notmuch.el b/emacs/notmuch.el
index efbf5bd0..92cb5202 100644
--- a/emacs/notmuch.el
+++ b/emacs/notmuch.el
@@ -824,26 +824,31 @@ non-authors is found, assume that all of the authors match."
       (insert padding))))
 
 (defun notmuch-search-insert-field (field format-string result)
-  (pcase field
-    ("date"
-     (insert (propertize (format format-string (plist-get result :date_relative))
-			 'face 'notmuch-search-date)))
-    ("count"
-     (insert (propertize (format format-string
-				 (format "[%s/%s]" (plist-get result :matched)
-					 (plist-get result :total)))
-			 'face 'notmuch-search-count)))
-    ("subject"
-     (insert (propertize (format format-string
-				 (notmuch-sanitize (plist-get result :subject)))
-			 'face 'notmuch-search-subject)))
-    ("authors"
-     (notmuch-search-insert-authors format-string
-				    (notmuch-sanitize (plist-get result :authors))))
-    ("tags"
-     (let ((tags (plist-get result :tags))
-	   (orig-tags (plist-get result :orig-tags)))
-       (insert (format format-string (notmuch-tag-format-tags tags orig-tags)))))))
+  (cond
+   ((functionp field)
+    (insert (funcall field format-string result)))
+
+   ((stringp field)
+    (pcase field
+      ("date"
+       (insert (propertize (format format-string (plist-get result :date_relative))
+			   'face 'notmuch-search-date)))
+      ("count"
+       (insert (propertize (format format-string
+				   (format "[%s/%s]" (plist-get result :matched)
+					   (plist-get result :total)))
+			   'face 'notmuch-search-count)))
+      ("subject"
+       (insert (propertize (format format-string
+				   (notmuch-sanitize (plist-get result :subject)))
+			   'face 'notmuch-search-subject)))
+      ("authors"
+       (notmuch-search-insert-authors format-string
+				      (notmuch-sanitize (plist-get result :authors))))
+      ("tags"
+       (let ((tags (plist-get result :tags))
+	     (orig-tags (plist-get result :orig-tags)))
+	 (insert (format format-string (notmuch-tag-format-tags tags orig-tags)))))))))
 
 (defun notmuch-search-show-result (result pos)
   "Insert RESULT at POS."
-- 
2.29.2

[PATCH v2 3/3] emacs: Allow functions in notmuch-{tree,unthreaded}-result-format

[David Edmondson]

If the car of an element in notmuch-tree-result-format or
notmuch-unthreaded-result-format is a function, insert the result of
calling the function into the buffer.
---
 emacs/notmuch-tree.el | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/emacs/notmuch-tree.el b/emacs/notmuch-tree.el
index f342f85a..6643bf92 100644
--- a/emacs/notmuch-tree.el
+++ b/emacs/notmuch-tree.el
@@ -849,6 +849,9 @@ unchanged ADDRESS if parsing fails."
      ((listp field)
       (format format-string (notmuch-tree-format-field-list field msg)))
 
+     ((functionp field)
+      (funcall field format-string msg))
+
      ((string-equal field "date")
       (let ((face (if match
 		      'notmuch-tree-match-date-face
-- 
2.29.2