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 (defcustom notmuch-search-oldest-first t
32 "Show the oldest mail first when searching."
38 (defcustom notmuch-saved-searches nil
39 "A list of saved searches to display."
40 :type '(alist :key-type string :value-type string)
43 (defvar notmuch-folders nil
44 "Deprecated name for what is now known as `notmuch-saved-searches'.")
46 (defun notmuch-saved-searches ()
47 "Common function for querying the notmuch-saved-searches variable.
49 We do this as a function to support the old name of the
50 variable (`notmuch-folders') as well as for the default value if
51 the user hasn't set this variable with the old or new value."
52 (if notmuch-saved-searches
53 notmuch-saved-searches
56 '(("inbox" . "tag:inbox")
57 ("unread" . "tag:unread")))))
59 (defun notmuch-version ()
60 "Return a string with the notmuch version number."
62 ;; Trim off the trailing newline.
63 (substring (shell-command-to-string
64 (concat notmuch-command " --version"))
66 (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
68 (match-string 2 long-string)
71 (defun notmuch-config-get (item)
72 "Return a value from the notmuch configuration."
73 ;; Trim off the trailing newline
74 (substring (shell-command-to-string
75 (concat notmuch-command " config get " item))
78 (defun notmuch-database-path ()
79 "Return the database.path value from the notmuch configuration."
80 (notmuch-config-get "database.path"))
82 (defun notmuch-user-name ()
83 "Return the user.name value from the notmuch configuration."
84 (notmuch-config-get "user.name"))
86 (defun notmuch-user-primary-email ()
87 "Return the user.primary_email value from the notmuch configuration."
88 (notmuch-config-get "user.primary_email"))
90 (defun notmuch-user-other-email ()
91 "Return the user.other_email value (as a list) from the notmuch configuration."
92 (split-string (notmuch-config-get "user.other_email") "\n"))
94 (defun notmuch-kill-this-buffer ()
95 "Kill the current buffer."
97 (kill-buffer (current-buffer)))
101 (defun notmuch-common-do-stash (text)
102 "Common function to stash text in kill ring, and display in minibuffer."
104 (message "Stashed: %s" text))
108 (defun notmuch-remove-if-not (predicate list)
109 "Return a copy of LIST with all items not satisfying PREDICATE removed."
112 (when (funcall predicate (car list))
113 (push (car list) out))
114 (setq list (cdr list)))
117 ; This lets us avoid compiling these replacement functions when emacs
118 ; is sufficiently new enough to supply them alone. We do the macro
119 ; treatment rather than just wrapping our defun calls in a when form
120 ; specifically so that the compiler never sees the code on new emacs,
121 ; (since the code is triggering warnings that we don't know how to get
124 ; A more clever macro here would accept a condition and a list of forms.
125 (defmacro compile-on-emacs-prior-to-23 (form)
126 "Conditionally evaluate form only on emacs < emacs-23."
127 (list 'when (< emacs-major-version 23)
130 ;; Compatibility functions for versions of emacs before emacs 23.
132 ;; Both functions here were copied from emacs 23 with the following copyright:
134 ;; Copyright (C) 1985, 1986, 1992, 1994, 1995, 1999, 2000, 2001, 2002, 2003,
135 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
137 ;; and under the GPL version 3 (or later) exactly as notmuch itself.
138 (compile-on-emacs-prior-to-23
139 (defun apply-partially (fun &rest args)
140 "Return a function that is a partial application of FUN to ARGS.
141 ARGS is a list of the first N arguments to pass to FUN.
142 The result is a new function which does the same as FUN, except that
143 the first N arguments are fixed at the values with which this function
145 (lexical-let ((fun fun) (args1 args))
146 (lambda (&rest args2) (apply fun (append args1 args2))))))
148 (compile-on-emacs-prior-to-23
149 (defun mouse-event-p (object)
150 "Return non-nil if OBJECT is a mouse click event."
151 (memq (event-basic-type object) '(mouse-1 mouse-2 mouse-3 mouse-movement))))
153 ;; This variable is used only buffer local, but it needs to be
154 ;; declared globally first to avoid compiler warnings.
155 (defvar notmuch-show-process-crypto nil)
156 (make-variable-buffer-local 'notmuch-show-process-crypto)
158 (provide 'notmuch-lib)