git.notmuchmail.org Git - notmuch/blob - emacs/notmuch-lib.el

   1 ;; notmuch-lib.el --- common variables, functions and function declarations
   2 ;;
   3 ;; Copyright © Carl Worth
   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 <http://www.gnu.org/licenses/>.
  19 ;;
  20 ;; Authors: Carl Worth <cworth@cworth.org>
  21
  22 ;; This is an part of an emacs-based interface to the notmuch mail system.
  23
  24 (defvar notmuch-command "notmuch"
  25   "Command to run the notmuch binary.")
  26
  27 (defgroup notmuch nil
  28   "Notmuch mail reader for Emacs."
  29   :group 'mail)
  30
  31 (defcustom notmuch-search-oldest-first t
  32   "Show the oldest mail first when searching."
  33   :type 'boolean
  34   :group 'notmuch)
  35
  36 ;;
  37
  38 (defcustom notmuch-saved-searches nil
  39   "A list of saved searches to display."
  40   :type '(alist :key-type string :value-type string)
  41   :group 'notmuch)
  42
  43 (defvar notmuch-folders nil
  44   "Deprecated name for what is now known as `notmuch-saved-searches'.")
  45
  46 (defun notmuch-saved-searches ()
  47   "Common function for querying the notmuch-saved-searches variable.
  48
  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
  54     (if notmuch-folders
  55         notmuch-folders
  56       '(("inbox" . "tag:inbox")
  57         ("unread" . "tag:unread")))))
  58
  59 (defun notmuch-version ()
  60   "Return a string with the notmuch version number."
  61   (let ((long-string
  62          ;; Trim off the trailing newline.
  63          (substring (shell-command-to-string
  64                      (concat notmuch-command " --version"))
  65                     0 -1)))
  66     (if (string-match "^notmuch\\( version\\)? \\(.*\\)$"
  67                       long-string)
  68         (match-string 2 long-string)
  69       "unknown")))
  70
  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))
  76               0 -1))
  77
  78 (defun notmuch-database-path ()
  79   "Return the database.path value from the notmuch configuration."
  80   (notmuch-config-get "database.path"))
  81
  82 (defun notmuch-user-name ()
  83   "Return the user.name value from the notmuch configuration."
  84   (notmuch-config-get "user.name"))
  85
  86 (defun notmuch-user-primary-email ()
  87   "Return the user.primary_email value from the notmuch configuration."
  88   (notmuch-config-get "user.primary_email"))
  89
  90 (defun notmuch-kill-this-buffer ()
  91   "Kill the current buffer."
  92   (interactive)
  93   (kill-buffer (current-buffer)))
  94
  95 ;;
  96
  97 (defun notmuch-common-do-stash (text)
  98   "Common function to stash text in kill ring, and display in minibuffer."
  99   (kill-new text)
 100   (message "Stashed: %s" text))
 101
 102 ;;
 103
 104 ;; XXX: This should be a generic function in emacs somewhere, not
 105 ;; here.
 106 (defun point-invisible-p ()
 107   "Return whether the character at point is invisible.
 108
 109 Here visibility is determined by `buffer-invisibility-spec' and
 110 the invisible property of any overlays for point. It doesn't have
 111 anything to do with whether point is currently being displayed
 112 within the current window."
 113   (let ((prop (get-char-property (point) 'invisible)))
 114     (if (eq buffer-invisibility-spec t)
 115         prop
 116       (or (memq prop buffer-invisibility-spec)
 117           (assq prop buffer-invisibility-spec)))))
 118
 119 (provide 'notmuch-lib)
 120