1 ;; notmuch-lib.el --- common variables, functions and function declarations
3 ;; Copyright © Carl Worth
5 ;; This file is part of Notmuch.
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.
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.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with Notmuch. If not, see <http://www.gnu.org/licenses/>.
20 ;; Authors: Carl Worth <cworth@cworth.org>
22 ;; This is an part of an emacs-based interface to the notmuch mail system.
24 (eval-when-compile (require 'cl))
26 (defvar notmuch-command "notmuch"
27 "Command to run the notmuch binary.")
30 "Notmuch mail reader for Emacs."
33 (defgroup notmuch-hello nil
34 "Overview of saved searches, tags, etc."
37 (defgroup notmuch-search nil
38 "Searching and sorting mail."
41 (defgroup notmuch-show nil
42 "Showing messages and threads."
45 (defgroup notmuch-send nil
46 "Sending messages from Notmuch."
49 (custom-add-to-group 'notmuch-send 'message 'custom-group)
51 (defgroup notmuch-crypto nil
52 "Processing and display of cryptographic MIME parts."
55 (defgroup notmuch-hooks nil
56 "Running custom code on well-defined occasions."
59 (defgroup notmuch-external nil
60 "Running external commands from within Notmuch."
63 (defgroup notmuch-faces nil
64 "Graphical attributes for displaying text"
67 (defcustom notmuch-search-oldest-first t
68 "Show the oldest mail first when searching."
70 :group 'notmuch-search)
74 (defvar notmuch-search-history nil
75 "Variable to store notmuch searches history.")
77 (defcustom notmuch-saved-searches nil
78 "A list of saved searches to display."
79 :type '(alist :key-type string :value-type string)
80 :group 'notmuch-hello)
82 (defvar notmuch-folders nil
83 "Deprecated name for what is now known as `notmuch-saved-searches'.")
85 (defun notmuch-saved-searches ()
86 "Common function for querying the notmuch-saved-searches variable.
88 We do this as a function to support the old name of the
89 variable (`notmuch-folders') as well as for the default value if
90 the user hasn't set this variable with the old or new value."
91 (if notmuch-saved-searches
92 notmuch-saved-searches
95 '(("inbox" . "tag:inbox")
96 ("unread" . "tag:unread")))))
98 (defun notmuch-version ()
99 "Return a string with the notmuch version number."
101 ;; Trim off the trailing newline.
102 (substring (shell-command-to-string
103 (concat notmuch-command " --version"))
105 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
107 (match-string 2 long-string)
110 (defun notmuch-config-get (item)
111 "Return a value from the notmuch configuration."
112 ;; Trim off the trailing newline
113 (substring (shell-command-to-string
114 (concat notmuch-command " config get " item))
117 (defun notmuch-database-path ()
118 "Return the database.path value from the notmuch configuration."
119 (notmuch-config-get "database.path"))
121 (defun notmuch-user-name ()
122 "Return the user.name value from the notmuch configuration."
123 (notmuch-config-get "user.name"))
125 (defun notmuch-user-primary-email ()
126 "Return the user.primary_email value from the notmuch configuration."
127 (notmuch-config-get "user.primary_email"))
129 (defun notmuch-user-other-email ()
130 "Return the user.other_email value (as a list) from the notmuch configuration."
131 (split-string (notmuch-config-get "user.other_email") "\n"))
133 (defun notmuch-kill-this-buffer ()
134 "Kill the current buffer."
136 (kill-buffer (current-buffer)))
138 (defun notmuch-prettify-subject (subject)
139 ;; This function is used by `notmuch-search-process-filter' which
140 ;; requires that we not disrupt its' matching state.
143 (string-match "^[ \t]*$" subject))
149 (defun notmuch-common-do-stash (text)
150 "Common function to stash text in kill ring, and display in minibuffer."
152 (message "Stashed: %s" text))
156 (defun notmuch-remove-if-not (predicate list)
157 "Return a copy of LIST with all items not satisfying PREDICATE removed."
160 (when (funcall predicate (car list))
161 (push (car list) out))
162 (setq list (cdr list)))
165 ;; This lets us avoid compiling these replacement functions when emacs
166 ;; is sufficiently new enough to supply them alone. We do the macro
167 ;; treatment rather than just wrapping our defun calls in a when form
168 ;; specifically so that the compiler never sees the code on new emacs,
169 ;; (since the code is triggering warnings that we don't know how to get
172 ;; A more clever macro here would accept a condition and a list of forms.
173 (defmacro compile-on-emacs-prior-to-23 (form)
174 "Conditionally evaluate form only on emacs < emacs-23."
175 (list 'when (< emacs-major-version 23)
178 (defun notmuch-split-content-type (content-type)
179 "Split content/type into 'content' and 'type'"
180 (split-string content-type "/"))
182 (defun notmuch-match-content-type (t1 t2)
183 "Return t if t1 and t2 are matching content types, taking wildcards into account"
184 (let ((st1 (notmuch-split-content-type t1))
185 (st2 (notmuch-split-content-type t2)))
186 (if (or (string= (cadr st1) "*")
187 (string= (cadr st2) "*"))
188 (string= (car st1) (car st2))
191 (defvar notmuch-multipart/alternative-discouraged
195 ;; multipart/related usually contain a text/html part and some associated graphics.
199 (defun notmuch-multipart/alternative-choose (types)
200 "Return a list of preferred types from the given list of types"
201 ;; Based on `mm-preferred-alternative-precedence'.
203 (dolist (pref (reverse notmuch-multipart/alternative-discouraged))
204 (dolist (elem (copy-sequence seq))
205 (when (string-match pref elem)
206 (setq seq (nconc (delete elem seq) (list elem))))))
209 ;; Compatibility functions for versions of emacs before emacs 23.
211 ;; Both functions here were copied from emacs 23 with the following copyright:
213 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
214 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
216 ;; and under the GPL version 3 (or later) exactly as notmuch itself.
217 (compile-on-emacs-prior-to-23
218 (defun apply-partially (fun &rest args)
219 "Return a function that is a partial application of FUN to ARGS.
220 ARGS is a list of the first N arguments to pass to FUN.
221 The result is a new function which does the same as FUN, except that
222 the first N arguments are fixed at the values with which this function
224 (lexical-let ((fun fun) (args1 args))
225 (lambda (&rest args2) (apply fun (append args1 args2))))))
227 (compile-on-emacs-prior-to-23
228 (defun mouse-event-p (object)
229 "Return non-nil if OBJECT is a mouse click event."
230 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement))))
232 ;; This variable is used only buffer local, but it needs to be
233 ;; declared globally first to avoid compiler warnings.
234 (defvar notmuch-show-process-crypto nil)
235 (make-variable-buffer-local 'notmuch-show-process-crypto)
237 (provide 'notmuch-lib)