X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=emacs%2Fnotmuch-lib.el;h=e16a1b971bd5e29bb3b78ba9f3a823c0b39acb85;hp=534f217753cd1f4f474a822f5b3ae801d0ca6489;hb=0c565fa29fc29f74209d4343e2fc88f3b8008aaa;hpb=634914064bdfa4acb5b489dc03bd4ff5dcda3170 diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el index 534f2177..e16a1b97 100644 --- a/emacs/notmuch-lib.el +++ b/emacs/notmuch-lib.el @@ -23,11 +23,10 @@ (require 'mm-view) (require 'mm-decode) -(require 'json) (require 'cl) -(defvar notmuch-command "notmuch" - "Command to run the notmuch binary.") +(autoload 'notmuch-jump-search "notmuch-jump" + "Jump to a saved search by shortcut key." t) (defgroup notmuch nil "Notmuch mail reader for Emacs." @@ -67,22 +66,58 @@ "Graphical attributes for displaying text" :group 'notmuch) +(defcustom notmuch-command "notmuch" + "Name of the notmuch binary. + +This can be a relative or absolute path to the notmuch binary. +If this is a relative path, it will be searched for in all of the +directories given in `exec-path' (which is, by default, based on +$PATH)." + :type 'string + :group 'notmuch-external) + (defcustom notmuch-search-oldest-first t - "Show the oldest mail first when searching." + "Show the oldest mail first when searching. + +This variable defines the default sort order for displaying +search results. Note that any filtered searches created by +`notmuch-search-filter' retain the search order of the parent +search." :type 'boolean :group 'notmuch-search) +(defcustom notmuch-poll-script nil + "[Deprecated] Command to run to incorporate new mail into the notmuch database. + +This option has been deprecated in favor of \"notmuch new\" +hooks (see man notmuch-hooks). To change the path to the notmuch +binary, customize `notmuch-command'. + +This variable controls the action invoked by +`notmuch-poll-and-refresh-this-buffer' (bound by default to 'G') +to incorporate new mail into the notmuch database. + +If set to nil (the default), new mail is processed by invoking +\"notmuch new\". Otherwise, this should be set to a string that +gives the name of an external script that processes new mail. If +set to the empty string, no command will be run. + +The external script could do any of the following depending on +the user's needs: + +1. Invoke a program to transfer mail to the local mail store +2. Invoke \"notmuch new\" to incorporate the new mail +3. Invoke one or more \"notmuch tag\" commands to classify the mail" + :type '(choice (const :tag "notmuch new" nil) + (const :tag "Disabled" "") + (string :tag "Custom script")) + :group 'notmuch-external) + ;; (defvar notmuch-search-history nil "Variable to store notmuch searches history.") -(defcustom notmuch-saved-searches '(("inbox" . "tag:inbox") - ("unread" . "tag:unread")) - "A list of saved searches to display." - :type '(alist :key-type string :value-type string) - :group 'notmuch-hello) - (defcustom notmuch-archive-tags '("-inbox") "List of tag changes to apply to a message or a thread when it is archived. @@ -97,6 +132,19 @@ For example, if you wanted to remove an \"inbox\" tag and add an :group 'notmuch-search :group 'notmuch-show) +(defvar notmuch-common-keymap + (let ((map (make-sparse-keymap))) + (define-key map "?" 'notmuch-help) + (define-key map "q" 'notmuch-bury-or-kill-this-buffer) + (define-key map "s" 'notmuch-search) + (define-key map "z" 'notmuch-tree) + (define-key map "m" 'notmuch-mua-new-mail) + (define-key map "=" 'notmuch-refresh-this-buffer) + (define-key map "G" 'notmuch-poll-and-refresh-this-buffer) + (define-key map "j" 'notmuch-jump-search) + map) + "Keymap shared by all notmuch modes.") + ;; By default clicking on a button does not select the window ;; containing the button (as opposed to clicking on a widget which ;; does). This means that the button action is then executed in the @@ -126,8 +174,26 @@ Otherwise the output will be returned" (notmuch-check-exit-status status (cons notmuch-command args) output) output))) -(defun notmuch-version () - "Return a string with the notmuch version number." +(defvar notmuch--cli-sane-p nil + "Cache whether the CLI seems to be configured sanely.") + +(defun notmuch-cli-sane-p () + "Return t if the cli seems to be configured sanely." + (unless notmuch--cli-sane-p + (let ((status (call-process notmuch-command nil nil nil + "config" "get" "user.primary_email"))) + (setq notmuch--cli-sane-p (= status 0)))) + notmuch--cli-sane-p) + +(defun notmuch-assert-cli-sane () + (unless (notmuch-cli-sane-p) + (notmuch-logged-error + "notmuch cli seems misconfigured or unconfigured." +"Perhaps you haven't run \"notmuch setup\" yet? Try running this +on the command line, and then retry your notmuch command"))) + +(defun notmuch-cli-version () + "Return a string with the notmuch cli command version number." (let ((long-string ;; Trim off the trailing newline. (substring (notmuch-command-to-string "--version") 0 -1))) @@ -138,8 +204,13 @@ Otherwise the output will be returned" (defun notmuch-config-get (item) "Return a value from the notmuch configuration." - ;; Trim off the trailing newline - (substring (notmuch-command-to-string "config" "get" item) 0 -1)) + (let* ((val (notmuch-command-to-string "config" "get" item)) + (len (length val))) + ;; Trim off the trailing newline (if the value is empty or not + ;; configured, there will be no newline) + (if (and (> len 0) (= (aref val (- len 1)) ?\n)) + (substring val 0 -1) + val))) (defun notmuch-database-path () "Return the database.path value from the notmuch configuration." @@ -155,12 +226,192 @@ Otherwise the output will be returned" (defun notmuch-user-other-email () "Return the user.other_email value (as a list) from the notmuch configuration." - (split-string (notmuch-config-get "user.other_email") "\n")) + (split-string (notmuch-config-get "user.other_email") "\n" t)) -(defun notmuch-kill-this-buffer () - "Kill the current buffer." +(defun notmuch-poll () + "Run \"notmuch new\" or an external script to import mail. + +Invokes `notmuch-poll-script', \"notmuch new\", or does nothing +depending on the value of `notmuch-poll-script'." (interactive) - (kill-buffer (current-buffer))) + (if (stringp notmuch-poll-script) + (unless (string= notmuch-poll-script "") + (call-process notmuch-poll-script nil nil)) + (call-process notmuch-command nil nil nil "new"))) + +(defun notmuch-bury-or-kill-this-buffer () + "Undisplay the current buffer. + +Bury the current buffer, unless there is only one window showing +it, in which case it is killed." + (interactive) + (if (> (length (get-buffer-window-list nil nil t)) 1) + (bury-buffer) + (kill-buffer))) + +(defun notmuch-documentation-first-line (symbol) + "Return the first line of the documentation string for SYMBOL." + (let ((doc (documentation symbol))) + (if doc + (with-temp-buffer + (insert (documentation symbol t)) + (goto-char (point-min)) + (let ((beg (point))) + (end-of-line) + (buffer-substring beg (point)))) + ""))) + +(defun notmuch-prefix-key-description (key) + "Given a prefix key code, return a human-readable string representation. + +This is basically just `format-kbd-macro' but we also convert ESC to M-." + (let* ((key-vector (if (vectorp key) key (vector key))) + (desc (format-kbd-macro key-vector))) + (if (string= desc "ESC") + "M-" + (concat desc " ")))) + + +(defun notmuch-describe-key (actual-key binding prefix ua-keys tail) + "Prepend cons cells describing prefix-arg ACTUAL-KEY and ACTUAL-KEY to TAIL + +It does not prepend if ACTUAL-KEY is already listed in TAIL." + (let ((key-string (concat prefix (format-kbd-macro actual-key)))) + ;; We don't include documentation if the key-binding is + ;; over-ridden. Note, over-riding a binding automatically hides the + ;; prefixed version too. + (unless (assoc key-string tail) + (when (and ua-keys (symbolp binding) + (get binding 'notmuch-prefix-doc)) + ;; Documentation for prefixed command + (let ((ua-desc (key-description ua-keys))) + (push (cons (concat ua-desc " " prefix (format-kbd-macro actual-key)) + (get binding 'notmuch-prefix-doc)) + tail))) + ;; Documentation for command + (push (cons key-string + (or (and (symbolp binding) (get binding 'notmuch-doc)) + (notmuch-documentation-first-line binding))) + tail))) + tail) + +(defun notmuch-describe-remaps (remap-keymap ua-keys base-keymap prefix tail) + ;; Remappings are represented as a binding whose first "event" is + ;; 'remap. Hence, if the keymap has any remappings, it will have a + ;; binding whose "key" is 'remap, and whose "binding" is itself a + ;; keymap that maps not from keys to commands, but from old (remapped) + ;; functions to the commands to use in their stead. + (map-keymap + (lambda (command binding) + (mapc + (lambda (actual-key) + (setq tail (notmuch-describe-key actual-key binding prefix ua-keys tail))) + (where-is-internal command base-keymap))) + remap-keymap) + tail) + +(defun notmuch-describe-keymap (keymap ua-keys base-keymap &optional prefix tail) + "Return a list of cons cells, each describing one binding in KEYMAP. + +Each cons cell consists of a string giving a human-readable +description of the key, and a one-line description of the bound +function. See `notmuch-help' for an overview of how this +documentation is extracted. + +UA-KEYS should be a key sequence bound to `universal-argument'. +It will be used to describe bindings of commands that support a +prefix argument. PREFIX and TAIL are used internally." + (map-keymap + (lambda (key binding) + (cond ((mouse-event-p key) nil) + ((keymapp binding) + (setq tail + (if (eq key 'remap) + (notmuch-describe-remaps + binding ua-keys base-keymap prefix tail) + (notmuch-describe-keymap + binding ua-keys base-keymap (notmuch-prefix-key-description key) tail)))) + (binding + (setq tail (notmuch-describe-key (vector key) binding prefix ua-keys tail))))) + keymap) + tail) + +(defun notmuch-substitute-command-keys (doc) + "Like `substitute-command-keys' but with documentation, not function names." + (let ((beg 0)) + (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg) + (let ((desc + (save-match-data + (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1))) + (keymap (symbol-value (intern keymap-name))) + (ua-keys (where-is-internal 'universal-argument keymap t)) + (desc-alist (notmuch-describe-keymap keymap ua-keys keymap)) + (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist))) + (mapconcat #'identity desc-list "\n"))))) + (setq doc (replace-match desc 1 1 doc))) + (setq beg (match-end 0))) + doc)) + +(defun notmuch-help () + "Display help for the current notmuch mode. + +This is similar to `describe-function' for the current major +mode, but bindings tables are shown with documentation strings +rather than command names. By default, this uses the first line +of each command's documentation string. A command can override +this by setting the 'notmuch-doc property of its command symbol. +A command that supports a prefix argument can explicitly document +its prefixed behavior by setting the 'notmuch-prefix-doc property +of its command symbol." + (interactive) + (let* ((mode major-mode) + (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t))))) + (with-current-buffer (generate-new-buffer "*notmuch-help*") + (insert doc) + (goto-char (point-min)) + (set-buffer-modified-p nil) + (view-buffer (current-buffer) 'kill-buffer-if-not-modified)))) + +(defun notmuch-subkeymap-help () + "Show help for a subkeymap." + (interactive) + (let* ((key (this-command-keys-vector)) + (prefix (make-vector (1- (length key)) nil)) + (i 0)) + (while (< i (length prefix)) + (aset prefix i (aref key i)) + (setq i (1+ i))) + + (let* ((subkeymap (key-binding prefix)) + (ua-keys (where-is-internal 'universal-argument nil t)) + (prefix-string (notmuch-prefix-key-description prefix)) + (desc-alist (notmuch-describe-keymap subkeymap ua-keys subkeymap prefix-string)) + (desc-list (mapcar (lambda (arg) (concat (car arg) "\t" (cdr arg))) desc-alist)) + (desc (mapconcat #'identity desc-list "\n"))) + (with-help-window (help-buffer) + (with-current-buffer standard-output + (insert "\nPress 'q' to quit this window.\n\n") + (insert desc))) + (pop-to-buffer (help-buffer))))) + +(defvar notmuch-buffer-refresh-function nil + "Function to call to refresh the current buffer.") +(make-variable-buffer-local 'notmuch-buffer-refresh-function) + +(defun notmuch-refresh-this-buffer () + "Refresh the current buffer." + (interactive) + (when notmuch-buffer-refresh-function + (if (commandp notmuch-buffer-refresh-function) + ;; Pass prefix argument, etc. + (call-interactively notmuch-buffer-refresh-function) + (funcall notmuch-buffer-refresh-function)))) + +(defun notmuch-poll-and-refresh-this-buffer () + "Invoke `notmuch-poll' to import mail, then refresh the current buffer." + (interactive) + (notmuch-poll) + (notmuch-refresh-this-buffer)) (defun notmuch-prettify-subject (subject) ;; This function is used by `notmuch-search-process-filter' which @@ -171,6 +422,12 @@ Otherwise the output will be returned" "[No Subject]" subject))) +(defun notmuch-sanitize (str) + "Sanitize control character in STR. + +This includes newlines, tabs, and other funny characters." + (replace-regexp-in-string "[[:cntrl:]\x7f\u2028\u2029]+" " " str)) + (defun notmuch-escape-boolean-term (term) "Escape a boolean term for use in a query. @@ -180,7 +437,10 @@ user-friendly queries." (save-match-data (if (or (equal term "") - (string-match "[ ()]\\|^\"" term)) + ;; To be pessimistic, only pass through terms composed + ;; entirely of ASCII printing characters other than ", (, + ;; and ). + (string-match "[^!#-'*-~]" term)) ;; Requires escaping (concat "\"" (replace-regexp-in-string "\"" "\"\"" term t t) "\"") term))) @@ -189,6 +449,14 @@ user-friendly queries." "Return a query that matches the message with id ID." (concat "id:" (notmuch-escape-boolean-term id))) +(defun notmuch-hex-encode (str) + "Hex-encode STR (e.g., as used by batch tagging). + +This replaces spaces, percents, and double quotes in STR with +%NN where NN is the hexadecimal value of the character." + (replace-regexp-in-string + "[ %\"]" (lambda (match) (format "%%%02x" (aref match 0))) str)) + ;; (defun notmuch-common-do-stash (text) @@ -213,6 +481,15 @@ user-friendly queries." (setq list (cdr list))) (nreverse out))) +(defun notmuch-plist-delete (plist property) + (let* ((xplist (cons nil plist)) + (pred xplist)) + (while (cdr pred) + (when (eq (cadr pred) property) + (setcdr pred (cdddr pred))) + (setq pred (cddr pred))) + (cdr xplist))) + (defun notmuch-split-content-type (content-type) "Split content/type into 'content' and 'type'" (split-string content-type "/")) @@ -252,24 +529,67 @@ the given type." (lambda (part) (notmuch-match-content-type (plist-get part :content-type) type)) parts)) -;; Helper for parts which are generally not included in the default -;; JSON output. -(defun notmuch-get-bodypart-internal (query part-number process-crypto) - (let ((args '("show" "--format=raw")) - (part-arg (format "--part=%s" part-number))) - (setq args (append args (list part-arg))) - (if process-crypto - (setq args (append args '("--decrypt")))) - (setq args (append args (list query))) - (with-temp-buffer - (let ((coding-system-for-read 'no-conversion)) - (progn - (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args)) - (buffer-string)))))) - -(defun notmuch-get-bodypart-content (msg part nth process-crypto) - (or (plist-get part :content) - (notmuch-get-bodypart-internal (notmuch-id-to-query (plist-get msg :id)) nth process-crypto))) +(defun notmuch-get-bodypart-binary (msg part process-crypto &optional cache) + "Return the unprocessed content of PART in MSG as a unibyte string. + +This returns the \"raw\" content of the given part after content +transfer decoding, but with no further processing (see the +discussion of --format=raw in man notmuch-show). In particular, +this does no charset conversion. + +If CACHE is non-nil, the content of this part will be saved in +MSG (if it isn't already)." + (let ((data (plist-get part :binary-content))) + (when (not data) + (let ((args `("show" "--format=raw" + ,(format "--part=%d" (plist-get part :id)) + ,@(when process-crypto '("--decrypt")) + ,(notmuch-id-to-query (plist-get msg :id))))) + (with-temp-buffer + ;; Emacs internally uses a UTF-8-like multibyte string + ;; representation by default (regardless of the coding + ;; system, which only affects how it goes from outside data + ;; to this internal representation). This *almost* never + ;; matters. Annoyingly, it does matter if we use this data + ;; in an image descriptor, since Emacs will use its internal + ;; data buffer directly and this multibyte representation + ;; corrupts binary image formats. Since the caller is + ;; asking for binary data, a unibyte string is a more + ;; appropriate representation anyway. + (set-buffer-multibyte nil) + (let ((coding-system-for-read 'no-conversion)) + (apply #'call-process notmuch-command nil '(t nil) nil args) + (setq data (buffer-string))))) + (when cache + ;; Cheat. part is non-nil, and `plist-put' always modifies + ;; the list in place if it's non-nil. + (plist-put part :binary-content data))) + data)) + +(defun notmuch-get-bodypart-text (msg part process-crypto &optional cache) + "Return the text content of PART in MSG. + +This returns the content of the given part as a multibyte Lisp +string after performing content transfer decoding and any +necessary charset decoding. It is an error to use this for +non-text/* parts. + +If CACHE is non-nil, the content of this part will be saved in +MSG (if it isn't already)." + (let ((content (plist-get part :content))) + (when (not content) + ;; Use show --format=sexp to fetch decoded content + (let* ((args `("show" "--format=sexp" "--include-html" + ,(format "--part=%s" (plist-get part :id)) + ,@(when process-crypto '("--decrypt")) + ,(notmuch-id-to-query (plist-get msg :id)))) + (npart (apply #'notmuch-call-notmuch-sexp args))) + (setq content (plist-get npart :content)) + (when (not content) + (error "Internal error: No :content from %S" args))) + (when cache + (plist-put part :content content))) + content)) ;; Workaround: The call to `mm-display-part' below triggers a bug in ;; Emacs 24 if it attempts to use the shr renderer to display an HTML @@ -282,25 +602,29 @@ the given type." (if (>= emacs-major-version 24) (defadvice mm-shr (before load-gnus-arts activate) (require 'gnus-art nil t) - (ad-disable-advice 'mm-shr 'before 'load-gnus-arts))) + (ad-disable-advice 'mm-shr 'before 'load-gnus-arts) + (ad-activate 'mm-shr))) -(defun notmuch-mm-display-part-inline (msg part nth content-type process-crypto) +(defun notmuch-mm-display-part-inline (msg part content-type process-crypto) "Use the mm-decode/mm-view functions to display a part in the current buffer, if possible." (let ((display-buffer (current-buffer))) (with-temp-buffer - ;; In case there is :content, the content string is already converted - ;; into emacs internal format. `gnus-decoded' is a fake charset, - ;; which means no further decoding (to be done by mm- functions). - (let* ((charset (if (plist-member part :content) - 'gnus-decoded + ;; In case we already have :content, use it and tell mm-* that + ;; it's already been charset-decoded by using the fake + ;; `gnus-decoded' charset. Otherwise, we'll fetch the binary + ;; part content and let mm-* decode it. + (let* ((have-content (plist-member part :content)) + (charset (if have-content 'gnus-decoded (plist-get part :content-charset))) (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset))))) ;; If the user wants the part inlined, insert the content and ;; test whether we are able to inline it (which includes both ;; capability and suitability tests). (when (mm-inlined-p handle) - (insert (notmuch-get-bodypart-content msg part nth process-crypto)) + (if have-content + (insert (notmuch-get-bodypart-text msg part process-crypto)) + (insert (notmuch-get-bodypart-binary msg part process-crypto))) (when (mm-inlinable-p handle) (set-buffer display-buffer) (mm-display-part handle) @@ -323,23 +647,32 @@ single element face list." face (list face))) -(defun notmuch-combine-face-text-property (start end face &optional below object) - "Combine FACE into the 'face text property between START and END. +(defun notmuch-apply-face (object face &optional below start end) + "Combine FACE into the 'face text property of OBJECT between START and END. This function combines FACE with any existing faces between START -and END in OBJECT (which defaults to the current buffer). -Attributes specified by FACE take precedence over existing -attributes unless BELOW is non-nil. FACE must be a face name (a -symbol or string), a property list of face attributes, or a list -of these. For convenience when applied to strings, this returns -OBJECT." +and END in OBJECT. Attributes specified by FACE take precedence +over existing attributes unless BELOW is non-nil. + +OBJECT may be a string, a buffer, or nil (which means the current +buffer). If object is a string, START and END are 0-based; +otherwise they are buffer positions (integers or markers). FACE +must be a face name (a symbol or string), a property list of face +attributes, or a list of these. If START and/or END are omitted, +they default to the beginning/end of OBJECT. For convenience +when applied to strings, this returns OBJECT." ;; A face property can have three forms: a face name (a string or ;; symbol), a property list, or a list of these two forms. In the ;; list case, the faces will be combined, with the earlier faces ;; taking precedent. Here we canonicalize everything to list form ;; to make it easy to combine. - (let ((pos start) + (let ((pos (cond (start start) + ((stringp object) 0) + (t 1))) + (end (cond (end end) + ((stringp object) (length object)) + (t (1+ (buffer-size object))))) (face-list (notmuch-face-ensure-list-form face))) (while (< pos end) (let* ((cur (get-text-property pos 'face object)) @@ -352,14 +685,6 @@ OBJECT." (setq pos next)))) object) -(defun notmuch-combine-face-text-property-string (string face &optional below) - (notmuch-combine-face-text-property - 0 - (length string) - face - below - string)) - (defun notmuch-map-text-property (start end prop func &optional object) "Transform text property PROP using FUNC. @@ -462,26 +787,59 @@ You may need to restart Emacs or upgrade your notmuch package.")) ;; `notmuch-logged-error' does not return. )))) -(defun notmuch-call-notmuch-json (&rest args) - "Invoke `notmuch-command' with ARGS and return the parsed JSON output. +(defun notmuch-call-notmuch--helper (destination args) + "Helper for synchronous notmuch invocation commands. + +This wraps `call-process'. DESTINATION has the same meaning as +for `call-process'. ARGS is as described for +`notmuch-call-notmuch-process'." + + (let (stdin-string) + (while (keywordp (car args)) + (case (car args) + (:stdin-string (setq stdin-string (cadr args) + args (cddr args))) + (otherwise + (error "Unknown keyword argument: %s" (car args))))) + (if (null stdin-string) + (apply #'call-process notmuch-command nil destination nil args) + (insert stdin-string) + (apply #'call-process-region (point-min) (point-max) + notmuch-command t destination nil args)))) + +(defun notmuch-call-notmuch-process (&rest args) + "Synchronously invoke `notmuch-command' with ARGS. + +The caller may provide keyword arguments before ARGS. Currently +supported keyword arguments are: -The returned output will represent objects using property lists -and arrays as lists. If notmuch exits with a non-zero status, -this will pop up a buffer containing notmuch's output and signal -an error." + :stdin-string STRING - Write STRING to stdin + +If notmuch exits with a non-zero status, output from the process +will appear in a buffer named \"*Notmuch errors*\" and an error +will be signaled." + (with-temp-buffer + (let ((status (notmuch-call-notmuch--helper t args))) + (notmuch-check-exit-status status (cons notmuch-command args) + (buffer-string))))) + +(defun notmuch-call-notmuch-sexp (&rest args) + "Invoke `notmuch-command' with ARGS and return the parsed S-exp output. + +This is equivalent to `notmuch-call-notmuch-process', but parses +notmuch's output as an S-expression and returns the parsed value. +Like `notmuch-call-notmuch-process', if notmuch exits with a +non-zero status, this will report its output and signal an +error." (with-temp-buffer (let ((err-file (make-temp-file "nmerr"))) (unwind-protect - (let ((status (apply #'call-process - notmuch-command nil (list t err-file) nil args))) + (let ((status (notmuch-call-notmuch--helper (list t err-file) args))) (notmuch-check-exit-status status (cons notmuch-command args) (buffer-string) err-file) (goto-char (point-min)) - (let ((json-object-type 'plist) - (json-array-type 'list) - (json-false 'nil)) - (json-read))) + (read (current-buffer))) (delete-file err-file))))) (defun notmuch-start-notmuch (name buffer sentinel &rest args) @@ -559,272 +917,6 @@ status." (defvar notmuch-show-process-crypto nil) (make-variable-buffer-local 'notmuch-show-process-crypto) -;; Incremental JSON parsing - -;; These two variables are internal variables to the parsing -;; routines. They are always used buffer local but need to be declared -;; globally to avoid compiler warnings. - -(defvar notmuch-json-parser nil - "Internal incremental JSON parser object: local to the buffer being parsed.") - -(defvar notmuch-json-state nil - "State of the internal JSON parser: local to the buffer being parsed.") - -(defun notmuch-json-create-parser (buffer) - "Return a streaming JSON parser that consumes input from BUFFER. - -This parser is designed to read streaming JSON whose structure is -known to the caller. Like a typical JSON parsing interface, it -provides a function to read a complete JSON value from the input. -However, it extends this with an additional function that -requires the next value in the input to be a compound value and -descends into it, allowing its elements to be read one at a time -or further descended into. Both functions can return 'retry to -indicate that not enough input is available. - -The parser always consumes input from BUFFER's point. Hence, the -caller is allowed to delete and data before point and may -resynchronize after an error by moving point." - - (list buffer - ;; Terminator stack: a stack of characters that indicate the - ;; end of the compound values enclosing point - '() - ;; Next: One of - ;; * 'expect-value if the next token must be a value, but a - ;; value has not yet been reached - ;; * 'value if point is at the beginning of a value - ;; * 'expect-comma if the next token must be a comma - 'expect-value - ;; Allow terminator: non-nil if the next token may be a - ;; terminator - nil - ;; Partial parse position: If state is 'value, a marker for - ;; the position of the partial parser or nil if no partial - ;; parsing has happened yet - nil - ;; Partial parse state: If state is 'value, the current - ;; `parse-partial-sexp' state - nil)) - -(defmacro notmuch-json-buffer (jp) `(first ,jp)) -(defmacro notmuch-json-term-stack (jp) `(second ,jp)) -(defmacro notmuch-json-next (jp) `(third ,jp)) -(defmacro notmuch-json-allow-term (jp) `(fourth ,jp)) -(defmacro notmuch-json-partial-pos (jp) `(fifth ,jp)) -(defmacro notmuch-json-partial-state (jp) `(sixth ,jp)) - -(defvar notmuch-json-syntax-table - (let ((table (make-syntax-table))) - ;; The standard syntax table is what we need except that "." needs - ;; to have word syntax instead of punctuation syntax. - (modify-syntax-entry ?. "w" table) - table) - "Syntax table used for incremental JSON parsing.") - -(defun notmuch-json-scan-to-value (jp) - ;; Helper function that consumes separators, terminators, and - ;; whitespace from point. Returns nil if it successfully reached - ;; the beginning of a value, 'end if it consumed a terminator, or - ;; 'retry if not enough input was available to reach a value. Upon - ;; nil return, (notmuch-json-next jp) is always 'value. - - (if (eq (notmuch-json-next jp) 'value) - ;; We're already at a value - nil - ;; Drive the state toward 'expect-value - (skip-chars-forward " \t\r\n") - (or (when (eobp) 'retry) - ;; Test for the terminator for the current compound - (when (and (notmuch-json-allow-term jp) - (eq (char-after) (car (notmuch-json-term-stack jp)))) - ;; Consume it and expect a comma or terminator next - (forward-char) - (setf (notmuch-json-term-stack jp) (cdr (notmuch-json-term-stack jp)) - (notmuch-json-next jp) 'expect-comma - (notmuch-json-allow-term jp) t) - 'end) - ;; Test for a separator - (when (eq (notmuch-json-next jp) 'expect-comma) - (when (/= (char-after) ?,) - (signal 'json-readtable-error (list "expected ','"))) - ;; Consume it, switch to 'expect-value, and disallow a - ;; terminator - (forward-char) - (skip-chars-forward " \t\r\n") - (setf (notmuch-json-next jp) 'expect-value - (notmuch-json-allow-term jp) nil) - ;; We moved point, so test for eobp again and fall through - ;; to the next test if there's more input - (when (eobp) 'retry)) - ;; Next must be 'expect-value and we know this isn't - ;; whitespace, EOB, or a terminator, so point must be on a - ;; value - (progn - (assert (eq (notmuch-json-next jp) 'expect-value)) - (setf (notmuch-json-next jp) 'value) - nil)))) - -(defun notmuch-json-begin-compound (jp) - "Parse the beginning of a compound value and traverse inside it. - -Returns 'retry if there is insufficient input to parse the -beginning of the compound. If this is able to parse the -beginning of a compound, it moves point past the token that opens -the compound and returns t. Later calls to `notmuch-json-read' -will return the compound's elements. - -Entering JSON objects is currently unimplemented." - - (with-current-buffer (notmuch-json-buffer jp) - ;; Disallow terminators - (setf (notmuch-json-allow-term jp) nil) - ;; Save "next" so we can restore it if there's a syntax error - (let ((saved-next (notmuch-json-next jp))) - (or (notmuch-json-scan-to-value jp) - (if (/= (char-after) ?\[) - (progn - (setf (notmuch-json-next jp) saved-next) - (signal 'json-readtable-error (list "expected '['"))) - (forward-char) - (push ?\] (notmuch-json-term-stack jp)) - ;; Expect a value or terminator next - (setf (notmuch-json-next jp) 'expect-value - (notmuch-json-allow-term jp) t) - t))))) - -(defun notmuch-json-read (jp) - "Parse the value at point in JP's buffer. - -Returns 'retry if there is insufficient input to parse a complete -JSON value (though it may still move point over separators or -whitespace). If the parser is currently inside a compound value -and the next token ends the list or object, this moves point just -past the terminator and returns 'end. Otherwise, this moves -point to just past the end of the value and returns the value." - - (with-current-buffer (notmuch-json-buffer jp) - (or - ;; Get to a value state - (notmuch-json-scan-to-value jp) - - ;; Can we parse a complete value? - (let ((complete - (if (looking-at "[-+0-9tfn]") - ;; This is a number or a keyword, so the partial - ;; parser isn't going to help us because a truncated - ;; number or keyword looks like a complete symbol to - ;; it. Look for something that clearly ends it. - (save-excursion - (skip-chars-forward "^]},: \t\r\n") - (not (eobp))) - - ;; We're looking at a string, object, or array, which we - ;; can partial parse. If we just reached the value, set - ;; up the partial parser. - (when (null (notmuch-json-partial-state jp)) - (setf (notmuch-json-partial-pos jp) (point-marker))) - - ;; Extend the partial parse until we either reach EOB or - ;; get the whole value - (save-excursion - (let ((pstate - (with-syntax-table notmuch-json-syntax-table - (parse-partial-sexp - (notmuch-json-partial-pos jp) (point-max) 0 nil - (notmuch-json-partial-state jp))))) - ;; A complete value is available if we've reached - ;; depth 0 or less and encountered a complete - ;; subexpression. - (if (and (<= (first pstate) 0) (third pstate)) - t - ;; Not complete. Update the partial parser state - (setf (notmuch-json-partial-pos jp) (point-marker) - (notmuch-json-partial-state jp) pstate) - nil)))))) - - (if (not complete) - 'retry - ;; We have a value. Reset the partial parse state and expect - ;; a comma or terminator after the value. - (setf (notmuch-json-next jp) 'expect-comma - (notmuch-json-allow-term jp) t - (notmuch-json-partial-pos jp) nil - (notmuch-json-partial-state jp) nil) - ;; Parse the value - (let ((json-object-type 'plist) - (json-array-type 'list) - (json-false nil)) - (json-read))))))) - -(defun notmuch-json-eof (jp) - "Signal a json-error if there is more data in JP's buffer. - -Moves point to the beginning of any trailing data or to the end -of the buffer if there is only trailing whitespace." - - (with-current-buffer (notmuch-json-buffer jp) - (skip-chars-forward " \t\r\n") - (unless (eobp) - (signal 'json-error (list "Trailing garbage following JSON data"))))) - -(defun notmuch-json-parse-partial-list (result-function error-function results-buf) - "Parse a partial JSON list from current buffer. - -This function consumes a JSON list from the current buffer, -applying RESULT-FUNCTION in buffer RESULT-BUFFER to each complete -value in the list. It operates incrementally and should be -called whenever the buffer has been extended with additional -data. - -If there is a syntax error, this will attempt to resynchronize -with the input and will apply ERROR-FUNCTION in buffer -RESULT-BUFFER to any input that was skipped. - -It sets up all the needed internal variables: the caller just -needs to call it with point in the same place that the parser -left it." - (let (done) - (unless (local-variable-p 'notmuch-json-parser) - (set (make-local-variable 'notmuch-json-parser) - (notmuch-json-create-parser (current-buffer))) - (set (make-local-variable 'notmuch-json-state) 'begin)) - (while (not done) - (condition-case nil - (case notmuch-json-state - ((begin) - ;; Enter the results list - (if (eq (notmuch-json-begin-compound - notmuch-json-parser) 'retry) - (setq done t) - (setq notmuch-json-state 'result))) - ((result) - ;; Parse a result - (let ((result (notmuch-json-read notmuch-json-parser))) - (case result - ((retry) (setq done t)) - ((end) (setq notmuch-json-state 'end)) - (otherwise (with-current-buffer results-buf - (funcall result-function result)))))) - ((end) - ;; Any trailing data is unexpected - (notmuch-json-eof notmuch-json-parser) - (setq done t))) - (json-error - ;; Do our best to resynchronize and ensure forward - ;; progress - (let ((bad (buffer-substring (line-beginning-position) - (line-end-position)))) - (forward-line) - (with-current-buffer results-buf - (funcall error-function "%s" bad)))))) - ;; Clear out what we've parsed - (delete-region (point-min) (point)))) - - - - (provide 'notmuch-lib) ;; Local Variables: