emacs docstrings: consistent indentation, newlines, periods
[notmuch] / emacs / notmuch-query.el
1 ;;; notmuch-query.el --- provide an emacs api to query notmuch
2 ;;
3 ;; Copyright © David Bremner
4 ;;
5 ;; This file is part of Notmuch.
6 ;;
7 ;; Notmuch is free software: you can redistribute it and/or modify it
8 ;; under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
11 ;;
12 ;; Notmuch is distributed in the hope that it will be useful, but
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 ;; General Public License for more details.
16 ;;
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with Notmuch.  If not, see <https://www.gnu.org/licenses/>.
19 ;;
20 ;; Authors: David Bremner <david@tethera.net>
21
22 ;;; Code:
23
24 (require 'notmuch-lib)
25
26 (defun notmuch-query-get-threads (search-terms)
27   "Return a list of threads of messages matching SEARCH-TERMS.
28
29 A thread is a forest or list of trees. A tree is a two element
30 list where the first element is a message, and the second element
31 is a possibly empty forest of replies."
32   (let ((args '("show" "--format=sexp" "--format-version=4")))
33     (if notmuch-show-process-crypto
34         (setq args (append args '("--decrypt=true"))))
35     (setq args (append args search-terms))
36     (apply #'notmuch-call-notmuch-sexp args)))
37
38 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
39 ;; Mapping functions across collections of messages.
40
41 (defun notmuch-query-map-aux  (mapper function seq)
42   "Private function to do the actual mapping and flattening."
43   (apply 'append
44          (mapcar
45            (lambda (tree)
46              (funcall mapper function tree))
47            seq)))
48
49 (defun notmuch-query-map-threads (fn threads)
50   "Apply FN to every thread in THREADS. Flatten results to a list.
51
52 See the function notmuch-query-get-threads for more information."
53   (notmuch-query-map-aux 'notmuch-query-map-forest fn threads))
54
55 (defun notmuch-query-map-forest (fn forest)
56   "Apply function to every message in a forest. Flatten results to a list.
57
58 See the function notmuch-query-get-threads for more information.
59 "
60   (notmuch-query-map-aux 'notmuch-query-map-tree fn forest))
61
62 (defun notmuch-query-map-tree (fn tree)
63   "Apply function FN to every message in TREE. Flatten results to a list.
64
65 See the function notmuch-query-get-threads for more information."
66   (cons (funcall fn (car tree)) (notmuch-query-map-forest fn (cadr tree))))
67
68 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
69 ;; Predefined queries
70
71 (defun notmuch-query-get-message-ids (&rest search-terms)
72   "Return a list of message-ids of messages that match SEARCH-TERMS."
73   (notmuch-query-map-threads
74    (lambda (msg) (plist-get msg :id))
75    (notmuch-query-get-threads search-terms)))
76
77 (provide 'notmuch-query)
78
79 ;;; notmuch-query.el ends here