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

   1 ;;; notmuch-parser.el --- streaming S-expression parser
   2 ;;
   3 ;; Copyright © Austin Clements
   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 <https://www.gnu.org/licenses/>.
  19 ;;
  20 ;; Authors: Austin Clements <aclements@csail.mit.edu>
  21
  22 ;;; Code:
  23
  24 (eval-when-compile (require 'cl-lib))
  25
  26 (defun notmuch-sexp-create-parser ()
  27   "Return a new streaming S-expression parser.
  28
  29 This parser is designed to incrementally read an S-expression
  30 whose structure is known to the caller.  Like a typical
  31 S-expression parsing interface, it provides a function to read a
  32 complete S-expression from the input.  However, it extends this
  33 with an additional function that requires the next value in the
  34 input to be a list and descends into it, allowing its elements to
  35 be read one at a time or further descended into.  Both functions
  36 can return 'retry to indicate that not enough input is available.
  37
  38 The parser always consumes input from point in the current
  39 buffer.  Hence, the caller is allowed to delete any data before
  40 point and may resynchronize after an error by moving point."
  41   (vector 'notmuch-sexp-parser
  42           ;; List depth
  43           0
  44           ;; Partial parse position marker
  45           nil
  46           ;; Partial parse state
  47           nil))
  48
  49 (defmacro notmuch-sexp--depth (sp)         `(aref ,sp 1))
  50 (defmacro notmuch-sexp--partial-pos (sp)   `(aref ,sp 2))
  51 (defmacro notmuch-sexp--partial-state (sp) `(aref ,sp 3))
  52
  53 (defun notmuch-sexp-read (sp)
  54   "Consume and return the value at point in the current buffer.
  55
  56 Returns 'retry if there is insufficient input to parse a complete
  57 value (though it may still move point over whitespace).  If the
  58 parser is currently inside a list and the next token ends the
  59 list, this moves point just past the terminator and returns 'end.
  60 Otherwise, this moves point to just past the end of the value and
  61 returns the value."
  62   (skip-chars-forward " \n\r\t")
  63   (cond ((eobp) 'retry)
  64         ((= (char-after) ?\))
  65          ;; We've reached the end of a list
  66          (if (= (notmuch-sexp--depth sp) 0)
  67              ;; .. but we weren't in a list.  Let read signal the
  68              ;; error to be consistent with all other code paths.
  69              (read (current-buffer))
  70            ;; Go up a level and return an end token
  71            (cl-decf (notmuch-sexp--depth sp))
  72            (forward-char)
  73            'end))
  74         ((= (char-after) ?\()
  75          ;; We're at the beginning of a list.  If we haven't started
  76          ;; a partial parse yet, attempt to read the list in its
  77          ;; entirety.  If this fails, or we've started a partial
  78          ;; parse, extend the partial parse to figure out when we
  79          ;; have a complete list.
  80          (catch 'return
  81            (when (null (notmuch-sexp--partial-state sp))
  82              (let ((start (point)))
  83                (condition-case nil
  84                    (throw 'return (read (current-buffer)))
  85                  (end-of-file (goto-char start)))))
  86            ;; Extend the partial parse
  87            (let (is-complete)
  88              (save-excursion
  89                (let* ((new-state (parse-partial-sexp
  90                                   (or (notmuch-sexp--partial-pos sp) (point))
  91                                   (point-max) 0 nil
  92                                   (notmuch-sexp--partial-state sp)))
  93                       ;; A complete value is available if we've
  94                       ;; reached depth 0.
  95                       (depth (car new-state)))
  96                  (cl-assert (>= depth 0))
  97                  (if (= depth 0)
  98                      ;; Reset partial parse state
  99                      (setf (notmuch-sexp--partial-state sp) nil
 100                            (notmuch-sexp--partial-pos sp) nil
 101                            is-complete t)
 102                    ;; Update partial parse state
 103                    (setf (notmuch-sexp--partial-state sp) new-state
 104                          (notmuch-sexp--partial-pos sp) (point-marker)))))
 105              (if is-complete
 106                  (read (current-buffer))
 107                'retry))))
 108         (t
 109          ;; Attempt to read a non-compound value
 110          (let ((start (point)))
 111            (condition-case nil
 112                (let ((val (read (current-buffer))))
 113                  ;; We got what looks like a complete read, but if
 114                  ;; we reached the end of the buffer in the process,
 115                  ;; we may not actually have all of the input we
 116                  ;; need (unless it's a string, which is delimited).
 117                  (if (or (stringp val) (not (eobp)))
 118                      val
 119                    ;; We can't be sure the input was complete
 120                    (goto-char start)
 121                    'retry))
 122              (end-of-file
 123               (goto-char start)
 124               'retry))))))
 125
 126 (defun notmuch-sexp-begin-list (sp)
 127   "Parse the beginning of a list value and enter the list.
 128
 129 Returns 'retry if there is insufficient input to parse the
 130 beginning of the list.  If this is able to parse the beginning of
 131 a list, it moves point past the token that opens the list and
 132 returns t.  Later calls to `notmuch-sexp-read' will return the
 133 elements inside the list.  If the input in buffer is not the
 134 beginning of a list, throw invalid-read-syntax."
 135   (skip-chars-forward " \n\r\t")
 136   (cond ((eobp) 'retry)
 137         ((= (char-after) ?\()
 138          (forward-char)
 139          (cl-incf (notmuch-sexp--depth sp))
 140          t)
 141         (t
 142          ;; Skip over the bad character like `read' does
 143          (forward-char)
 144          (signal 'invalid-read-syntax (list (string (char-before)))))))
 145
 146 (defun notmuch-sexp-eof (sp)
 147   "Signal an error if there is more data in SP's buffer.
 148
 149 Moves point to the beginning of any trailing data or to the end
 150 of the buffer if there is only trailing whitespace."
 151   (skip-chars-forward " \n\r\t")
 152   (unless (eobp)
 153     (error "Trailing garbage following expression")))
 154
 155 (defvar notmuch-sexp--parser nil
 156   "The buffer-local notmuch-sexp-parser instance.
 157
 158 Used by `notmuch-sexp-parse-partial-list'.")
 159
 160 (defvar notmuch-sexp--state nil
 161   "The buffer-local `notmuch-sexp-parse-partial-list' state.")
 162
 163 (defun notmuch-sexp-parse-partial-list (result-function result-buffer)
 164   "Incrementally parse an S-expression list from the current buffer.
 165
 166 This function consumes an S-expression list from the current
 167 buffer, applying RESULT-FUNCTION in RESULT-BUFFER to each
 168 complete value in the list.  It operates incrementally and should
 169 be called whenever the input buffer has been extended with
 170 additional data.  The caller just needs to ensure it does not
 171 move point in the input buffer."
 172   ;; Set up the initial state
 173   (unless (local-variable-p 'notmuch-sexp--parser)
 174     (set (make-local-variable 'notmuch-sexp--parser)
 175          (notmuch-sexp-create-parser))
 176     (set (make-local-variable 'notmuch-sexp--state) 'begin))
 177   (let (done)
 178     (while (not done)
 179       (cl-case notmuch-sexp--state
 180         (begin
 181          ;; Enter the list
 182          (if (eq (notmuch-sexp-begin-list notmuch-sexp--parser) 'retry)
 183              (setq done t)
 184            (setq notmuch-sexp--state 'result)))
 185         (result
 186          ;; Parse a result
 187          (let ((result (notmuch-sexp-read notmuch-sexp--parser)))
 188            (cl-case result
 189              (retry (setq done t))
 190              (end   (setq notmuch-sexp--state 'end))
 191              (t     (with-current-buffer result-buffer
 192                       (funcall result-function result))))))
 193         (end
 194          ;; Any trailing data is unexpected
 195          (notmuch-sexp-eof notmuch-sexp--parser)
 196          (setq done t)))))
 197   ;; Clear out what we've parsed
 198   (delete-region (point-min) (point)))
 199
 200 (provide 'notmuch-parser)
 201
 202 ;;; notmuch-parser.el ends here