chiark - git - mdw - sod/blob - src/lexer-proto.lisp

   1 ;;; -*-lisp-*-
   2 ;;;
   3 ;;; Protocol for lexical analysis
   4 ;;;
   5 ;;; (c) 2009 Straylight/Edgeware
   6 ;;;
   7
   8 ;;;----- Licensing notice ---------------------------------------------------
   9 ;;;
  10 ;;; This file is part of the Sensible Object Design, an object system for C.
  11 ;;;
  12 ;;; SOD is free software; you can redistribute it and/or modify
  13 ;;; it under the terms of the GNU General Public License as published by
  14 ;;; the Free Software Foundation; either version 2 of the License, or
  15 ;;; (at your option) any later version.
  16 ;;;
  17 ;;; SOD is distributed in the hope that it will be useful,
  18 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;;; GNU General Public License for more details.
  21 ;;;
  22 ;;; You should have received a copy of the GNU General Public License
  23 ;;; along with SOD; if not, write to the Free Software Foundation,
  24 ;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25
  26 (cl:in-package #:sod)
  27
  28 ;;;--------------------------------------------------------------------------
  29 ;;; Class definition.
  30
  31 (export 'sod-token-scanner)
  32 (defclass sod-token-scanner (token-scanner)
  33   ((char-scanner :initarg :char-scanner :reader token-scanner-char-scanner))
  34   (:documentation
  35    "A token scanner for SOD input files.
  36
  37    Not a lot here, apart from a character scanner to read from and the
  38    standard token scanner infrastructure."))
  39
  40 ;;;--------------------------------------------------------------------------
  41 ;;; Indicators and error messages.
  42
  43 (defvar *indicator-map* (make-hash-table)
  44   "Hash table mapping indicator objects to human-readable descriptions.")
  45
  46 (export 'define-indicator)
  47 (defun define-indicator (indicator description)
  48   "Associate an INDICATOR with its textual DESCRIPTION.
  49
  50    Updates the the `*indicator-map*'."
  51   (setf (gethash indicator *indicator-map*) description)
  52   indicator)
  53
  54 (export 'syntax-error)
  55 (defun syntax-error (scanner expected &key (continuep t) location)
  56   "Signal a (maybe) continuable syntax error."
  57   (labels ((show-token (type value)
  58              (if (characterp type)
  59                  (format nil "~/sod::show-char/" type)
  60                  (case type
  61                    (:id (format nil "<identifier~@[ `~A'~]>" value))
  62                    (:int "<integer-literal>")
  63                    (:string "<string-literal>")
  64                    (:char "<character-literal>")
  65                    (:eof "<end-of-file>")
  66                    (:ellipsis "`...'")
  67                    (t (format nil "<? ~S~@[ ~S~]>" type value)))))
  68            (show-expected (thing)
  69              (acond ((gethash thing *indicator-map*) it)
  70                     ((atom thing) (show-token thing nil))
  71                     ((eq (car thing) :id)
  72                      (format nil "`~A'" (cadr thing)))
  73                     (t (format nil "<? ~S>" thing)))))
  74     (funcall (if continuep #'cerror*-with-location #'error-with-location)
  75              (or location scanner)
  76              "Syntax error: ~
  77               expected ~{~#[<bug>~;~A~;~A or ~A~:;~A, ~]~} ~
  78               but found ~A"
  79              (mapcar #'show-expected expected)
  80              (show-token (token-type scanner) (token-value scanner)))))
  81
  82 (export 'lexer-error)
  83 (defun lexer-error (char-scanner expected &key location)
  84   "Signal a continuable lexical error."
  85   (cerror*-with-location (or location char-scanner)
  86                          "Lexical error: ~
  87                           ~:[unexpected~;~
  88                              expected ~:*~{~#[~;~A~;~A or ~A~:;~A, ~]~} ~
  89                              but found~] ~
  90                           ~/sod::show-char/"
  91            (mapcar (lambda (exp)
  92                      (typecase exp
  93                        (character (format nil "~/sod::show-char/" exp))
  94                        (string (format nil "`~A'" exp))
  95                        ((cons (eql :digit) *) (format nil "<radix-~A digit>"
  96                                                       (cadr exp)))
  97                        ((eql :eof) "<end-of-file>")
  98                        ((eql :any) "<character>")
  99                        (t (format nil "<? ~S>" exp))))
 100                    expected)
 101            (and (not (scanner-at-eof-p char-scanner))
 102                 (scanner-current-char char-scanner))))
 103
 104 (export 'skip-until)
 105 (defparse skip-until (:context (context token-scanner-context)
 106                       (&key (keep-end nil keep-end-p))
 107                       &rest token-types)
 108   "Discard tokens until we find one listed in TOKEN-TYPES.
 109
 110    If KEEP-END is true then retain the found token for later; otherwise
 111    discard it.  KEEP-END defaults to true if multiple TOKEN-TYPES are given;
 112    otherwise false.  If end-of-file is encountered then the indicator list is
 113    simply the list of TOKEN-TYPES; otherwise the result is `nil'."
 114   `(skip-until ,(parser-scanner context)
 115                (list ,@token-types)
 116                :keep-end ,(if keep-end-p keep-end
 117                               (> (length token-types) 1))))
 118
 119 (export 'error)
 120 (defparse error (:context (context token-scanner-context)
 121                  (&key ignore-unconsumed force-progress)
 122                  sub &optional (recover t))
 123   "Try to parse SUB; if it fails then report an error, and parse RECOVER.
 124
 125    This is the main way to recover from errors and continue parsing.  Even
 126    then, it's not especially brilliant.
 127
 128    If the SUB parser succeeds then just propagate its result: it's like we
 129    were never here.  Otherwise, try to recover in a sensible way so we can
 130    continue parsing.  The details of this recovery are subject to change, but
 131    the final action is generally to invoke the RECOVER parser and return its
 132    result.
 133
 134    If IGNORE-UNCONSUMED evaluates non-nil, then just propagate a failure of
 135    SUB if it didn't consume input.  (This makes it suitable for use where the
 136    parser containing `error' might be optional.)"
 137   `(parse-error-recover ,(parser-scanner context)
 138                         (parser () ,sub)
 139                         (parser () ,recover)
 140                         :ignore-unconsumed ,ignore-unconsumed
 141                         :force-progress ,force-progress))
 142
 143 ;;;--------------------------------------------------------------------------
 144 ;;; Lexical analysis utilities.
 145
 146 (export 'scan-comment)
 147 (defun scan-comment (char-scanner)
 148   "Scan a comment (either `/* ... */' or `// ...') from CHAR-SCANNER.
 149
 150    The result isn't interesting."
 151   (with-parser-context (character-scanner-context :scanner char-scanner)
 152     (parse (or (and "/*"
 153                     (and (skip-many ()
 154                            (and (skip-many () (not #\*))
 155                                 (label "*/" (skip-many (:min 1) #\*)))
 156                            (not #\/))
 157                          #\/))
 158                (and "//"
 159                     (skip-many () (not #\newline))
 160                     (? #\newline))))))
 161
 162 ;;;----- That's all, folks --------------------------------------------------