emacs: User-defined sections in notmuch-hello

This patch makes the notmuch-hello screen fully customizable
by allowing the user to add and remove arbitrary sections. It
also provides some convenience functions for constructing sections,
e.g. showing the unread message count for each tag.

This is done by specifying a list of functions that will be run
when notmuch-hello is invoked.
This commit is contained in:
Daniel Schoepe 2012-02-17 18:48:07 +04:00 committed by David Bremner
parent 2ddf29fe3b
commit 3557acab64

View file

@ -154,6 +154,108 @@ International Bureau of Weights and Measures."
(defvar notmuch-hello-url "http://notmuchmail.org"
"The `notmuch' web site.")
(defvar notmuch-hello-search-pos nil
"Position of search widget, if any.
This should only be set by `notmuch-hello-insert-search'.")
(defvar notmuch-hello-custom-section-options
'((:filter (string :tag "Filter for each tag"))
(:filter-count (string :tag "Different filter to generate message counts"))
(:initially-hidden (const :tag "Hide this section on startup" t))
(:show-empty-searches (const :tag "Show queries with no matching messages" t))
(:hide-if-empty (const :tag "Hide this section if all queries are empty
\(and not shown by show-empty-searches)" t)))
"Various customization-options for notmuch-hello-tags/query-section.")
(define-widget 'notmuch-hello-tags-section 'lazy
"Customize-type for notmuch-hello tag-list sections."
:tag "Customized tag-list section (see docstring for details)"
:type
`(list :tag ""
(const :tag "" notmuch-hello-insert-tags-section)
(string :tag "Title for this section")
(plist
:inline t
:options
,(append notmuch-hello-custom-section-options
'((:hide-tags (repeat :tag "Tags that will be hidden"
string)))))))
(define-widget 'notmuch-hello-query-section 'lazy
"Customize-type for custom saved-search-like sections"
:tag "Customized queries section (see docstring for details)"
:type
`(list :tag ""
(const :tag "" notmuch-hello-insert-query-list)
(string :tag "Title for this section")
(repeat :tag "Queries"
(cons (string :tag "Name") (string :tag "Query")))
(plist :inline t :options ,notmuch-hello-custom-section-options)))
(defcustom notmuch-hello-sections
(list #'notmuch-hello-insert-header
#'notmuch-hello-insert-saved-searches
#'notmuch-hello-insert-search
#'notmuch-hello-insert-recent-searches
#'notmuch-hello-insert-alltags
#'notmuch-hello-insert-footer)
"Sections for notmuch-hello.
The list contains functions which are used to construct sections in
notmuch-hello buffer. When notmuch-hello buffer is constructed,
these functions are run in the order they appear in this list. Each
function produces a section simply by adding content to the current
buffer. A section should not end with an empty line, because a
newline will be inserted after each section by `notmuch-hello'.
Each function should take no arguments. If the produced section
includes `notmuch-hello-target' (i.e. cursor should be positioned
inside this section), the function should return this element's
position.
Otherwise, it should return nil.
For convenience an element can also be a list of the form (FUNC ARG1
ARG2 .. ARGN) in which case FUNC will be applied to the rest of the
list.
A \"Customized tag-list section\" item in the customize-interface
displays a list of all tags, optionally hiding some of them. It
is also possible to filter the list of messages matching each tag
by an additional filter query. Similarly, the count of messages
displayed next to the buttons can be generated by applying a
different filter to the tag query. These filters are also
supported for \"Customized queries section\" items."
:group 'notmuch
:type
'(repeat
(choice (function-item notmuch-hello-insert-header)
(function-item notmuch-hello-insert-saved-searches)
(function-item notmuch-hello-insert-search)
(function-item notmuch-hello-insert-recent-searches)
(function-item notmuch-hello-insert-alltags)
(function-item notmuch-hello-insert-footer)
(function-item notmuch-hello-insert-inbox)
notmuch-hello-tags-section
notmuch-hello-query-section
(function :tag "Custom section"))))
(defvar notmuch-hello-target nil
"Button text at position of point before rebuilding the notmuch-buffer.
This variable contains the text of the button, if any, the
point was positioned at before the notmuch-hello buffer was
rebuilt. This should never actually be global and is defined as a
defvar only for documentation purposes and to avoid a compiler
warning about it occurring as a free variable.")
(defvar notmuch-hello-hidden-sections nil
"List of sections titles whose contents are hidden")
(defvar notmuch-hello-first-run t
"True if `notmuch-hello' is run for the first time, set to nil
afterwards.")
(defun notmuch-hello-nice-number (n)
(let (result)
(while (> n 0)
@ -201,8 +303,8 @@ International Bureau of Weights and Measures."
(message "Saved '%s' as '%s'." search name)
(notmuch-hello-update)))
(defun notmuch-hello-longest-label (tag-alist)
(or (loop for elem in tag-alist
(defun notmuch-hello-longest-label (searches-alist)
(or (loop for elem in searches-alist
maximize (length (car elem)))
0))
@ -266,12 +368,70 @@ should be. Returns a cons cell `(tags-per-line width)'."
(* tags-per-line (+ 9 1))))
tags-per-line))))
(defun notmuch-hello-insert-tags (tag-alist widest target)
(let* ((tags-and-width (notmuch-hello-tags-per-line widest))
(defun notmuch-hello-filtered-query (query filter)
"Constructs a query to search all messages matching QUERY and FILTER.
If FILTER is a string, it is directly used in the returned query.
If FILTER is a function, it is called with QUERY as a parameter and
the string it returns is used as the query. If nil is returned,
the entry is hidden.
Otherwise, FILTER is ignored.
"
(cond
((functionp filter) (funcall filter query))
((stringp filter)
(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.
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.
The result is the list of elements of the form (NAME QUERY COUNT).
The values :show-empty-searches, :filter and :filter-count from
options will be handled as specified for
`notmuch-hello-insert-searches'."
(notmuch-remove-if-not
#'identity
(mapcar
(lambda (elem)
(let* ((name (car elem))
(query-and-count (if (consp (cdr elem))
;; do we have a different query for the message count?
(cons (second elem) (third elem))
(cons (cdr elem) (cdr elem))))
(message-count
(string-to-number
(notmuch-saved-search-count
(notmuch-hello-filtered-query (cdr query-and-count)
(or (plist-get options :filter-count)
(plist-get options :filter)))))))
(and (or (plist-get options :show-empty-searches) (> message-count 0))
(list name (notmuch-hello-filtered-query
(car query-and-count) (plist-get options :filter))
message-count))))
query-alist)))
(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'."
(let* ((widest (notmuch-hello-longest-label searches))
(tags-and-width (notmuch-hello-tags-per-line widest))
(tags-per-line (car tags-and-width))
(widest (cdr tags-and-width))
(count 0)
(reordered-list (notmuch-hello-reflect tag-alist tags-per-line))
(reordered-list (notmuch-hello-reflect searches tags-per-line))
;; Hack the display of the buttons used.
(widget-push-button-prefix "")
(widget-push-button-suffix "")
@ -281,13 +441,13 @@ should be. Returns a cons cell `(tags-per-line width)'."
(mapc (lambda (elem)
;; (not elem) indicates an empty slot in the matrix.
(when elem
(let* ((name (car elem))
(query (cdr elem))
(let* ((name (first elem))
(query (second elem))
(msg-count (third elem))
(formatted-name (format "%s " name)))
(widget-insert (format "%8s "
(notmuch-hello-nice-number
(string-to-number (notmuch-saved-search-count query)))))
(if (string= formatted-name target)
(notmuch-hello-nice-number msg-count)))
(if (string= formatted-name notmuch-hello-target)
(setq found-target-pos (point-marker)))
(widget-create 'push-button
:notify #'notmuch-hello-widget-search
@ -364,64 +524,17 @@ Complete list of currently available key bindings:
;;(setq buffer-read-only t)
)
(defun notmuch-hello-generate-tag-alist ()
(defun notmuch-hello-generate-tag-alist (&optional hide-tags)
"Return an alist from tags to queries to display in the all-tags section."
(notmuch-remove-if-not
#'cdr
(mapcar (lambda (tag)
(cons tag
(cond
((functionp notmuch-hello-tag-list-make-query)
(concat "tag:" tag " and ("
(funcall notmuch-hello-tag-list-make-query tag) ")"))
((stringp notmuch-hello-tag-list-make-query)
(concat "tag:" tag " and ("
notmuch-hello-tag-list-make-query ")"))
(t (concat "tag:" tag)))))
(cons tag (format "tag:%s" tag)))
(notmuch-remove-if-not
(lambda (tag)
(not (member tag notmuch-hello-hide-tags)))
(process-lines notmuch-command "search-tags")))))
;;;###autoload
(defun notmuch-hello (&optional no-display)
"Run notmuch and display saved searches, known tags, etc."
(interactive)
;; Jump through a hoop to get this value from the deprecated variable
;; name (`notmuch-folders') or from the default value.
(unless notmuch-saved-searches
(setq notmuch-saved-searches (notmuch-saved-searches)))
(if no-display
(set-buffer "*notmuch-hello*")
(switch-to-buffer "*notmuch-hello*"))
(let ((target (if (widget-at)
(widget-value (widget-at))
(condition-case nil
(progn
(widget-forward 1)
(widget-value (widget-at)))
(error nil))))
(inhibit-read-only t))
;; Delete all editable widget fields. Editable widget fields are
;; tracked in a buffer local variable `widget-field-list' (and
;; others). If we do `erase-buffer' without properly deleting the
;; widgets, some widget-related functions are confused later.
(mapc 'widget-delete widget-field-list)
(erase-buffer)
(unless (eq major-mode 'notmuch-hello-mode)
(notmuch-hello-mode))
(let ((all (overlay-lists)))
;; Delete all the overlays.
(mapc 'delete-overlay (car all))
(mapc 'delete-overlay (cdr all)))
(not (member tag hide-tags)))
(process-lines notmuch-command "search-tags"))))
(defun notmuch-hello-insert-header ()
"Insert the default notmuch-hello header."
(when notmuch-show-logo
(let ((image notmuch-hello-logo))
;; The notmuch logo uses transparency. That can display poorly
@ -454,43 +567,35 @@ Complete list of currently available key bindings:
:help-echo "Refresh"
(notmuch-hello-nice-number
(string-to-number (car (process-lines notmuch-command "count")))))
(widget-insert " messages.\n"))
(widget-insert " messages.\n")))
(let ((found-target-pos nil)
(final-target-pos nil)
(default-pos))
(let* ((saved-alist
;; Filter out empty saved searches if required.
(if notmuch-show-empty-saved-searches
notmuch-saved-searches
(loop for elem in notmuch-saved-searches
if (> (string-to-number (notmuch-saved-search-count (cdr elem))) 0)
collect elem)))
(saved-widest (notmuch-hello-longest-label saved-alist))
(alltags-alist (if notmuch-show-all-tags-list (notmuch-hello-generate-tag-alist)))
(alltags-widest (notmuch-hello-longest-label alltags-alist))
(widest (max saved-widest alltags-widest)))
(when saved-alist
;; Sort saved searches if required.
(when notmuch-saved-search-sort-function
(setq saved-alist
(funcall notmuch-saved-search-sort-function saved-alist)))
(widget-insert "\nSaved searches: ")
(defun notmuch-hello-insert-saved-searches ()
"Insert the saved-searches section."
(let ((searches (notmuch-hello-query-counts
(if notmuch-saved-search-sort-function
(funcall notmuch-saved-search-sort-function
notmuch-saved-searches)
notmuch-saved-searches)
:show-empty-searches notmuch-show-empty-saved-searches))
found-target-pos)
(when searches
(widget-insert "Saved searches: ")
(widget-create 'push-button
:notify (lambda (&rest ignore)
(customize-variable 'notmuch-saved-searches))
"edit")
(widget-insert "\n\n")
(setq final-target-pos (point-marker))
(let ((start (point)))
(setq found-target-pos (notmuch-hello-insert-tags saved-alist widest target))
(if found-target-pos
(setq final-target-pos found-target-pos))
(indent-rigidly start (point) notmuch-hello-indent)))
(setq found-target-pos
(notmuch-hello-insert-buttons searches))
(indent-rigidly start (point) notmuch-hello-indent)
found-target-pos))))
(widget-insert "\nSearch: ")
(setq default-pos (point-marker))
(defun notmuch-hello-insert-search ()
"Insert a search widget."
(widget-insert "Search: ")
(setq notmuch-hello-search-pos (point-marker))
(widget-create 'editable-field
;; Leave some space at the start and end of the
;; search boxes.
@ -505,10 +610,12 @@ Complete list of currently available key bindings:
;; spaces.
(widget-insert ".")
(put-text-property (1- (point)) (point) 'invisible t)
(widget-insert "\n")
(widget-insert "\n"))
(defun notmuch-hello-insert-recent-searches ()
"Insert recent searches."
(when notmuch-search-history
(widget-insert "\nRecent searches: ")
(widget-insert "Recent searches: ")
(widget-create 'push-button
:notify (lambda (&rest ignore)
(setq notmuch-search-history nil)
@ -546,33 +653,91 @@ Complete list of currently available key bindings:
:notmuch-saved-search-widget widget-symbol
"save"))
(widget-insert "\n"))
(indent-rigidly start (point) notmuch-hello-indent)))
(indent-rigidly start (point) notmuch-hello-indent))
nil))
(when alltags-alist
(widget-insert "\nAll tags: ")
(defun notmuch-hello-insert-searches (title query-alist &rest options)
"Insert a section with TITLE showing a list of buttons made from QUERY-ALIST.
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.
Supports the following entries in OPTIONS as a plist:
:initially-hidden - if non-nil, section will be hidden on startup
:show-empty-searches - show buttons with no matching messages
:hide-if-empty - hide if no buttons would be shown
(only makes sense without :show-empty-searches)
:filter - This can be a function that takes the search query as its argument and
returns a filter to be used in conjuction with the query for that search or nil
to hide the element. This can also be a string that is used as a combined with
each query using \"and\".
:filter-count - Separate filter to generate the count displayed each search. Accepts
the same values as :filter. If :filter and :filter-count are specified, this
will be used instead of :filter, not in conjunction with it."
(widget-insert title ": ")
(if (and notmuch-hello-first-run (plist-get options :initially-hidden))
(add-to-list 'notmuch-hello-hidden-sections title))
(let ((is-hidden (member title notmuch-hello-hidden-sections))
(start (point)))
(if is-hidden
(widget-create 'push-button
:notify (lambda (widget &rest ignore)
(setq notmuch-show-all-tags-list nil)
:notify `(lambda (widget &rest ignore)
(setq notmuch-hello-hidden-sections
(delete ,title notmuch-hello-hidden-sections))
(notmuch-hello-update))
"hide")
(widget-insert "\n\n")
(let ((start (point)))
(setq found-target-pos (notmuch-hello-insert-tags alltags-alist widest target))
(unless final-target-pos
(setq final-target-pos found-target-pos))
(indent-rigidly start (point) notmuch-hello-indent)))
"show")
(widget-create 'push-button
:notify `(lambda (widget &rest ignore)
(add-to-list 'notmuch-hello-hidden-sections
,title)
(notmuch-hello-update))
"hide"))
(widget-insert "\n")
(let (target-pos
(searches (apply 'notmuch-hello-query-counts query-alist options)))
(when (and (not is-hidden)
(or (not (plist-get options :hide-if-empty))
searches))
(widget-insert "\n")
(setq target-pos
(notmuch-hello-insert-buttons searches))
(indent-rigidly start (point) notmuch-hello-indent)
target-pos))))
(unless notmuch-show-all-tags-list
(widget-create 'push-button
:notify (lambda (widget &rest ignore)
(setq notmuch-show-all-tags-list t)
(notmuch-hello-update))
"Show all tags")))
(defun notmuch-hello-insert-tags-section (&optional title &rest options)
"Insert a section displaying all tags with message counts.
TITLE defaults to \"All tags\".
Allowed options are those accepted by `notmuch-hello-insert-searches' and the
following:
:hide-tags - List of tags that should be excluded."
(apply 'notmuch-hello-insert-searches
(or title "All tags")
(notmuch-hello-generate-tag-alist (plist-get options :hide-tags))
options))
(defun notmuch-hello-insert-inbox ()
"Show an entry for each saved search and inboxed messages for each tag"
(notmuch-hello-insert-searches "What's in your inbox"
(append
(notmuch-saved-searches)
(notmuch-hello-generate-tag-alist))
:filter "tag:inbox"))
(defun notmuch-hello-insert-alltags ()
"Insert a section displaying all tags and associated message counts"
(notmuch-hello-insert-tags-section
nil
:initially-hidden (not notmuch-show-all-tags-list)
:hide-tags notmuch-hello-hide-tags
:filter notmuch-hello-tag-list-make-query))
(defun notmuch-hello-insert-footer ()
"Insert the notmuch-hello footer."
(let ((start (point)))
(widget-insert "\n\n")
(widget-insert "Type a search query and hit RET to view matching threads.\n")
(when notmuch-search-history
(widget-insert "Hit RET to re-submit a previous search. Edit it first if you like.\n")
@ -581,9 +746,68 @@ Complete list of currently available key bindings:
(widget-insert "Edit saved searches with the `edit' button.\n"))
(widget-insert "Hit RET or click on a saved search or tag name to view matching threads.\n")
(widget-insert "`=' to refresh this screen. `s' to search messages. `q' to quit.\n")
(widget-create 'link
:notify (lambda (&rest ignore)
(customize-variable 'notmuch-hello-sections))
:button-prefix "" :button-suffix ""
"Customize")
(widget-insert " this page.")
(let ((fill-column (- (window-width) notmuch-hello-indent)))
(center-region start (point))))
(center-region start (point)))))
;;;###autoload
(defun notmuch-hello (&optional no-display)
"Run notmuch and display saved searches, known tags, etc."
(interactive)
;; Jump through a hoop to get this value from the deprecated variable
;; name (`notmuch-folders') or from the default value.
(unless notmuch-saved-searches
(setq notmuch-saved-searches (notmuch-saved-searches)))
(if no-display
(set-buffer "*notmuch-hello*")
(switch-to-buffer "*notmuch-hello*"))
(let ((notmuch-hello-target (if (widget-at)
(widget-value (widget-at))
(condition-case nil
(progn
(widget-forward 1)
(widget-value (widget-at)))
(error nil))))
(inhibit-read-only t))
;; Delete all editable widget fields. Editable widget fields are
;; tracked in a buffer local variable `widget-field-list' (and
;; others). If we do `erase-buffer' without properly deleting the
;; widgets, some widget-related functions are confused later.
(mapc 'widget-delete widget-field-list)
(erase-buffer)
(unless (eq major-mode 'notmuch-hello-mode)
(notmuch-hello-mode))
(let ((all (overlay-lists)))
;; Delete all the overlays.
(mapc 'delete-overlay (car all))
(mapc 'delete-overlay (cdr all)))
(let (final-target-pos)
(mapc
(lambda (section)
(let ((point-before (point))
(result (if (functionp section)
(funcall section)
(apply (car section) (cdr section)))))
(if (and (not final-target-pos) (integer-or-marker-p result))
(setq final-target-pos result))
;; don't insert a newline when the previous section didn't show
;; anything.
(unless (eq (point) point-before)
(widget-insert "\n"))))
notmuch-hello-sections)
(widget-setup)
(when final-target-pos
@ -592,9 +816,10 @@ Complete list of currently available key bindings:
(widget-forward 1)))
(unless (widget-at)
(goto-char default-pos))))
(run-hooks 'notmuch-hello-refresh-hook))
(when notmuch-hello-search-pos
(goto-char notmuch-hello-search-pos)))))
(run-hooks 'notmuch-hello-refresh-hook)
(setq notmuch-hello-first-run nil))
(defun notmuch-folder ()
"Deprecated function for invoking notmuch---calling `notmuch' is preferred now."