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 (defvar notmuch-command "notmuch"
25 "Command to run the notmuch binary.")
28 "Notmuch mail reader for Emacs."
31 (defgroup notmuch-hello nil
32 "Overview of saved searches, tags, etc."
35 (defgroup notmuch-search nil
36 "Searching and sorting mail."
39 (defgroup notmuch-show nil
40 "Showing messages and threads."
43 (defgroup notmuch-send nil
44 "Sending messages from Notmuch."
48 (defgroup notmuch-crypto nil
49 "Processing and display of cryptographic MIME parts."
52 (defgroup notmuch-hooks nil
53 "Running custom code on well-defined occasions."
56 (defgroup notmuch-external nil
57 "Running external commands from within Notmuch."
60 (defgroup notmuch-faces nil
61 "Graphical attributes for displaying text"
64 (defcustom notmuch-search-oldest-first t
65 "Show the oldest mail first when searching."
67 :group 'notmuch-search)
71 (defcustom notmuch-saved-searches nil
72 "A list of saved searches to display."
73 :type '(alist :key-type string :value-type string)
74 :group 'notmuch-hello)
76 (defvar notmuch-folders nil
77 "Deprecated name for what is now known as `notmuch-saved-searches'.")
79 (defun notmuch-saved-searches ()
80 "Common function for querying the notmuch-saved-searches variable.
82 We do this as a function to support the old name of the
83 variable (`notmuch-folders') as well as for the default value if
84 the user hasn't set this variable with the old or new value."
85 (if notmuch-saved-searches
86 notmuch-saved-searches
89 '(("inbox" . "tag:inbox")
90 ("unread" . "tag:unread")))))
92 (defun notmuch-version ()
93 "Return a string with the notmuch version number."
95 ;; Trim off the trailing newline.
96 (substring (shell-command-to-string
97 (concat notmuch-command " --version"))
99 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
101 (match-string 2 long-string)
104 (defun notmuch-config-get (item)
105 "Return a value from the notmuch configuration."
106 ;; Trim off the trailing newline
107 (substring (shell-command-to-string
108 (concat notmuch-command " config get " item))
111 (defun notmuch-database-path ()
112 "Return the database.path value from the notmuch configuration."
113 (notmuch-config-get "database.path"))
115 (defun notmuch-user-name ()
116 "Return the user.name value from the notmuch configuration."
117 (notmuch-config-get "user.name"))
119 (defun notmuch-user-primary-email ()
120 "Return the user.primary_email value from the notmuch configuration."
121 (notmuch-config-get "user.primary_email"))
123 (defun notmuch-user-other-email ()
124 "Return the user.other_email value (as a list) from the notmuch configuration."
125 (split-string (notmuch-config-get "user.other_email") "\n"))
127 (defun notmuch-kill-this-buffer ()
128 "Kill the current buffer."
130 (kill-buffer (current-buffer)))
134 (defun notmuch-common-do-stash (text)
135 "Common function to stash text in kill ring, and display in minibuffer."
137 (message "Stashed: %s" text))
141 (defun notmuch-remove-if-not (predicate list)
142 "Return a copy of LIST with all items not satisfying PREDICATE removed."
145 (when (funcall predicate (car list))
146 (push (car list) out))
147 (setq list (cdr list)))
150 ; This lets us avoid compiling these replacement functions when emacs
151 ; is sufficiently new enough to supply them alone. We do the macro
152 ; treatment rather than just wrapping our defun calls in a when form
153 ; specifically so that the compiler never sees the code on new emacs,
154 ; (since the code is triggering warnings that we don't know how to get
157 ; A more clever macro here would accept a condition and a list of forms.
158 (defmacro compile-on-emacs-prior-to-23 (form)
159 "Conditionally evaluate form only on emacs < emacs-23."
160 (list 'when (< emacs-major-version 23)
163 ;; Compatibility functions for versions of emacs before emacs 23.
165 ;; Both functions here were copied from emacs 23 with the following copyright:
167 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
168 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
170 ;; and under the GPL version 3 (or later) exactly as notmuch itself.
171 (compile-on-emacs-prior-to-23
172 (defun apply-partially (fun &rest args)
173 "Return a function that is a partial application of FUN to ARGS.
174 ARGS is a list of the first N arguments to pass to FUN.
175 The result is a new function which does the same as FUN, except that
176 the first N arguments are fixed at the values with which this function
178 (lexical-let ((fun fun) (args1 args))
179 (lambda (&rest args2) (apply fun (append args1 args2))))))
181 (compile-on-emacs-prior-to-23
182 (defun mouse-event-p (object)
183 "Return non-nil if OBJECT is a mouse click event."
184 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement))))
186 ;; This variable is used only buffer local, but it needs to be
187 ;; declared globally first to avoid compiler warnings.
188 (defvar notmuch-show-process-crypto nil)
189 (make-variable-buffer-local 'notmuch-show-process-crypto)
191 (provide 'notmuch-lib)