src/module-parse.lisp: Improve error recovery for `initarg' class-items.

[sod] / src / module-parse.lisp

diff --git a/src/module-parse.lisp b/src/module-parse.lisp
index 6fb6be800b4a813e461446c8893dd69b41a2a75e..2d81de17037157e703cf9b8f6a6d7e421e5fca0a 100644 (file)
--- a/src/module-parse.lisp
+++ b/src/module-parse.lisp
@@ -7,7 +7,7 @@
 
 ;;;----- Licensing notice ---------------------------------------------------
 ;;;
 
 ;;;----- Licensing notice ---------------------------------------------------
 ;;;

-;;; This file is part of the Sensble Object Design, an object system for C.
+;;; This file is part of the Sensible Object Design, an object system for C.

 ;;;
 ;;; SOD is free software; you can redistribute it and/or modify
 ;;; it under the terms of the GNU General Public License as published by
 ;;;
 ;;; SOD is free software; you can redistribute it and/or modify
 ;;; it under the terms of the GNU General Public License as published by


@@ -28,51 +28,71 @@ (in-package #:sod)
 ;;;--------------------------------------------------------------------------
 ;;; Toplevel syntax.
 
 ;;;--------------------------------------------------------------------------
 ;;; Toplevel syntax.
 

-(export 'module)
-

 ;;; Type names.
 
 ;;; Type names.
 

-(define-pluggable-parser module typename (scanner)
-  ;; `typename' ID ( `,' ID )* `;'
-
+(define-pluggable-parser module typename (scanner pset)
+  ;; `typename' list[id] `;'
+  (declare (ignore pset))

   (with-parser-context (token-scanner-context :scanner scanner)
     (parse (and "typename"
   (with-parser-context (token-scanner-context :scanner scanner)
     (parse (and "typename"

-               (skip-many (:min 1)
-                 (seq ((id :id))
-                   (if (gethash id *module-type-map*)
-                       (cerror* "Type `~A' already defined" id)
-                       (add-to-module *module*
-                                      (make-instance 'type-item
-                                                     :name id))))
+               (skip-many ()
+                 (error ()
+                     (seq ((id :id))
+                       (if (or (gethash id *module-type-map*)
+                               (find-simple-c-type id))
+                           (cerror* "Type `~A' already defined" id)
+                           (add-to-module *module*
+                                          (make-instance 'type-item
+                                                         :name id))))
+                   (skip-until () #\, #\;))

                  #\,)
                  #\,)

-               #\;))))
+               (must #\;)))))

 
 ;;; Fragments.
 
 
 ;;; Fragments.
 

-(define-pluggable-parser module code (scanner)
-  ;; `code' ID `:' ID [ CONSTRAINTS ] `{' C-FRAGMENT `}'
-
+(define-pluggable-parser module code (scanner pset)
+  ;; `code' id `:' item-name [constraints] `{' c-fragment `}'
+  ;;
+  ;; constraints ::= `[' list[constraint] `]'
+  ;; constraint ::= item-name+
+  ;; item-name ::= id | `(' id+ `)'
+  (declare (ignore pset))

   (with-parser-context (token-scanner-context :scanner scanner)
   (with-parser-context (token-scanner-context :scanner scanner)

-    (parse (seq ("code"
-                (reason :id)
-                #\:
-                (name :id)
-                (constraints (? (seq (#\[
-                                      (constraints (list (:min 1)
-                                                     (list (:min 1) :id)
-                                                     #\,))
-                                      #\])
-                                  constraints)))
-                (fragment (parse-delimited-fragment scanner #\{ #\})))
-            (add-to-module *module* (make-instance 'code-fragment-item
-                                                   :fragment fragment
-                                                   :constraints constraints
-                                                   :reason reason
-                                                   :name name))))))
+    (labels ((kw ()
+              (parse (seq ((kw :id))
+                       (intern (frob-identifier kw) 'keyword))))
+            (item ()
+              (parse (or (kw)
+                         (seq (#\( (names (list (:min 1) (kw))) #\))
+                           names)))))
+      (parse (seq ("code"
+                  (reason (must (kw)))
+                  (nil (must #\:))
+                  (name (must (item)))
+                  (constraints (? (seq (#\[
+                                        (constraints
+                                         (list ()
+                                           (list (:min 1)
+                                             (error (:ignore-unconsumed t)
+                                                 (item)
+                                               (skip-until ()
+                                                 :id #\( #\, #\])))
+                                           #\,))
+                                        #\])
+                                    constraints)))
+                  (fragment (parse-delimited-fragment scanner #\{ #\})))
+              (when name
+                (add-to-module *module*
+                               (make-instance 'code-fragment-item
+                                              :fragment fragment
+                                              :constraints constraints
+                                              :reason reason
+                                              :name name))))))))

 
 ;;; External files.
 
 
 ;;; External files.
 

-(defun read-module (pathname &key (truename (truename pathname)) location)
+(export 'read-module)
+(defun read-module (pathname &key (truename nil truep) location)

   "Parse the file at PATHNAME as a module, returning it.
 
    This is the main entry point for parsing module files.  You may well know
   "Parse the file at PATHNAME as a module, returning it.
 
    This is the main entry point for parsing module files.  You may well know


@@ -83,37 +103,52 @@ (defun read-module (pathname &key (truename (truename pathname)) location)
    `file-location' object, though it might be anything other than `t' which
    can be printed in the event of circular imports."
 
    `file-location' object, though it might be anything other than `t' which
    can be printed in the event of circular imports."
 

+  (setf pathname (merge-pathnames pathname
+                                 (make-pathname :type "SOD" :case :common)))
+  (unless truep (setf truename (truename pathname)))

   (define-module (pathname :location location :truename truename)
     (with-open-file (f-stream pathname :direction :input)
       (let* ((*readtable* (copy-readtable))
   (define-module (pathname :location location :truename truename)
     (with-open-file (f-stream pathname :direction :input)
       (let* ((*readtable* (copy-readtable))

+            (*package* (find-package '#:sod-user))

             (char-scanner (make-instance 'charbuf-scanner
             (char-scanner (make-instance 'charbuf-scanner

-                                         :stream f-stream))
+                                         :stream f-stream
+                                         :filename (namestring pathname)))

             (scanner (make-instance 'sod-token-scanner
                                     :char-scanner char-scanner)))
        (with-default-error-location (scanner)
          (with-parser-context (token-scanner-context :scanner scanner)
             (scanner (make-instance 'sod-token-scanner
                                     :char-scanner char-scanner)))
        (with-default-error-location (scanner)
          (with-parser-context (token-scanner-context :scanner scanner)

-           (parse (skip-many () (plug module scanner)))))))))
-
-(define-pluggable-parser module test (scanner)
-  ;; `demo' STRING `;'
-
+           (multiple-value-bind (result winp consumedp)
+               (parse (skip-many ()
+                         (seq ((pset (parse-property-set scanner))
+                               (nil (error ()
+                                        (plug module scanner pset)
+                                      (skip-until (:keep-end nil)
+                                        #\; #\}))))
+                           (check-unused-properties pset))))
+             (declare (ignore consumedp))
+             (unless winp (syntax-error scanner result)))))))))
+
+(define-pluggable-parser module test (scanner pset)
+  ;; `demo' string `;'
+  (declare (ignore pset))

   (with-parser-context (token-scanner-context :scanner scanner)
   (with-parser-context (token-scanner-context :scanner scanner)

-    (parse (seq ("demo" (string :string) #\;)
+    (parse (seq ("demo" (string (must :string)) (nil (must #\;)))

             (format t ";; DEMO ~S~%" string)))))
 
             (format t ";; DEMO ~S~%" string)))))
 

-(define-pluggable-parser module file (scanner)
-  ;; `import' STRING `;'
-  ;; `load' STRING `;'
-
+(define-pluggable-parser module file (scanner pset)
+  ;; `import' string `;'
+  ;; `load' string `;'
+  (declare (ignore pset))

   (flet ((common (name type what thunk)
   (flet ((common (name type what thunk)

-          (find-file scanner
-                     (merge-pathnames name
-                                      (make-pathname :type type
-                                                     :case :common))
-                     what
-                     thunk)))
+          (when name
+            (find-file scanner
+                       (merge-pathnames name
+                                        (make-pathname :type type
+                                                       :case :common))
+                       what
+                       thunk))))

     (with-parser-context (token-scanner-context :scanner scanner)
     (with-parser-context (token-scanner-context :scanner scanner)

-      (parse (or (seq ("import" (name :string) #\;)
+      (parse (or (seq ("import" (name (must :string)) (nil (must #\;)))

                   (common name "SOD" "module"
                           (lambda (path true)
                             (handler-case
                   (common name "SOD" "module"
                           (lambda (path true)
                             (handler-case


@@ -126,8 +161,12 @@ (define-pluggable-parser module file (scanner)
                                               *module*))))
                               (file-error (error)
                                 (cerror* "Error reading module ~S: ~A"
                                               *module*))))
                               (file-error (error)
                                 (cerror* "Error reading module ~S: ~A"

+                                         path error))
+                              (error (error)
+                                (cerror* "Unexpected error reading ~
+                                          module ~S: ~A"

                                          path error))))))
                                          path error))))))

-                (seq ("load" (name :string) #\;)
+                (seq ("load" (name (must :string)) (nil (must #\;)))

                   (common name "LISP" "Lisp file"
                           (lambda (path true)
                             (handler-case
                   (common name "LISP" "Lisp file"
                           (lambda (path true)
                             (handler-case


@@ -136,11 +175,34 @@ (define-pluggable-parser module file (scanner)
                                 (cerror* "Error loading Lisp file ~S: ~A"
                                          path error)))))))))))
 
                                 (cerror* "Error loading Lisp file ~S: ~A"
                                          path error)))))))))))
 

+;;; Setting properties.
+
+(define-pluggable-parser module set (scanner pset)
+  ;; `set' list[property] `;'
+  (with-parser-context (token-scanner-context :scanner scanner)
+    (parse (and "set"
+               (lisp (let ((module-pset (module-pset *module*)))
+                       (when pset
+                         (pset-map (lambda (prop)
+                                     (add-property
+                                      module-pset
+                                      (p-name prop) (p-value prop)
+                                      :type (p-type prop)
+                                      :location (p-location prop))
+                                     (setf (p-seenp prop) t))
+                                   pset))
+                       (parse (skip-many (:min (if pset 0 1))
+                                (error (:ignore-unconsumed t)
+                                    (parse-property scanner module-pset)
+                                  (skip-until () #\, #\;))
+                                #\,))))
+               #\;))))
+

 ;;; Lisp escape.
 
 ;;; Lisp escape.
 

-(define-pluggable-parser module lisp (scanner)
+(define-pluggable-parser module lisp (scanner pset)

   ;; `lisp' s-expression `;'
   ;; `lisp' s-expression `;'

-
+  (declare (ignore pset))

   (with-parser-context (token-scanner-context :scanner scanner)
     (parse (seq ((sexp (if (and (eql (token-type scanner) :id)
                                (string= (token-value scanner) "lisp"))
   (with-parser-context (token-scanner-context :scanner scanner)
     (parse (seq ((sexp (if (and (eql (token-type scanner) :id)
                                (string= (token-value scanner) "lisp"))


@@ -149,17 +211,55 @@ (define-pluggable-parser module lisp (scanner)
                             (scanner-step scanner)
                             (values sexp t t))
                           (values '((:id "lisp")) nil nil)))
                             (scanner-step scanner)
                             (values sexp t t))
                           (values '((:id "lisp")) nil nil)))

-                #\;)
+                (nil (must #\;)))

             (eval sexp)))))
 
 ;;;--------------------------------------------------------------------------
 ;;; Class declarations.
 
             (eval sexp)))))
 
 ;;;--------------------------------------------------------------------------
 ;;; Class declarations.
 

-(defun parse-class-body (scaner pset name supers)
+(export 'class-item)
+
+(define-pluggable-parser class-item initfrags (scanner class pset)
+  ;; raw-class-item ::= frag-keyword `{' c-fragment `}'
+  ;; frag-keyword ::= `init' | `teardown'
+  (with-parser-context (token-scanner-context :scanner scanner)
+    (parse (seq ((make (or (seq ("init") #'make-sod-class-initfrag)
+                          (seq ("teardown") #'make-sod-class-tearfrag)))
+                (frag (parse-delimited-fragment scanner #\{ #\})))
+            (funcall make class frag pset scanner)))))
+
+(define-pluggable-parser class-item initargs (scanner class pset)
+  ;; initarg-item ::= `initarg' declspec+ list[init-declarator]
+  ;; init-declarator ::= declarator [`=' initializer]
+  (with-parser-context (token-scanner-context :scanner scanner)
+    (parse (seq ("initarg"
+                (base-type (parse-c-type scanner))
+                (nil (skip-many (:min 1)
+                       (seq ((declarator (parse-declarator scanner
+                                                           base-type))
+                             (init (? (parse-delimited-fragment
+                                       scanner #\= (list #\; #\,)
+                                       :keep-end t))))
+                         (make-sod-user-initarg class
+                                                (cdr declarator)
+                                                (car declarator)
+                                                pset init scanner))
+                       #\,))
+                (nil (must #\;)))))))
+
+(defun parse-class-body (scanner pset name supers)

   ;; class-body ::= `{' class-item* `}'
   ;; class-body ::= `{' class-item* `}'

+  ;;
+  ;; class-item ::= property-set raw-class-item

   (with-parser-context (token-scanner-context :scanner scanner)
     (make-class-type name)
   (with-parser-context (token-scanner-context :scanner scanner)
     (make-class-type name)

-    (let* ((class (make-sod-class name (mapcat #'find-sod-class supers)
+    (let* ((duff nil)
+          (class (make-sod-class name
+                                 (restart-case
+                                     (mapcar #'find-sod-class supers)
+                                   (continue ()
+                                     (setf duff t)
+                                     (list (find-sod-class "SodObject"))))

                                  pset scanner))
           (nick (sod-class-nickname class)))
 
                                  pset scanner))
           (nick (sod-class-nickname class)))
 


@@ -174,20 +274,26 @@ (defun parse-class-body (scaner pset name supers)
                 ;; names.
                 (parse-declarator
                  scanner base-type
                 ;; names.
                 (parse-declarator
                  scanner base-type

-                 :centre (parser ()
+                 :keywordp t
+                 :kernel (parser ()

                            (seq ((name-a :id)
                                  (name-b (? (seq (#\. (id :id)) id))))
                              (if name-b (cons name-a name-b)
                                  name-a)))))
 
                            (seq ((name-a :id)
                                  (name-b (? (seq (#\. (id :id)) id))))
                              (if name-b (cons name-a name-b)
                                  name-a)))))
 

-              ;; class-item ::= [property-set] raw-class-item
-              ;;
-

               (parse-message-item (sub-pset type name)
                 ;; message-item ::=
                 ;;     declspec+ declarator -!- (method-body | `;')
               (parse-message-item (sub-pset type name)
                 ;; message-item ::=
                 ;;     declspec+ declarator -!- (method-body | `;')

-                (make-sod-message class name type sub-pset scanner)
-                (parse (or #\; (parse-method-item nil type nick name))))
+                ;;
+                ;; Don't allow a method-body here if the message takes a
+                ;; varargs list, because we don't have a name for the
+                ;; `va_list' parameter.
+                (let ((message (make-sod-message class name type
+                                                 sub-pset scanner)))
+                  (if (varargs-message-p message)
+                      (parse #\;)
+                      (parse (or #\; (parse-method-item sub-pset
+                                                        type nick name))))))

 
               (parse-method-item (sub-pset type sub-nick name)
                 ;; method-item ::=
 
               (parse-method-item (sub-pset type sub-nick name)
                 ;; method-item ::=


@@ -201,32 +307,25 @@ (defun parse-class-body (scaner pset name supers)
                                           body sub-pset scanner))))
 
               (parse-initializer ()
                                           body sub-pset scanner))))
 
               (parse-initializer ()

-                ;; initializer ::= `=' c-fragment | `=' `{' c-fragment `}'
+                ;; initializer ::= `=' c-fragment

                 ;;
                 ;;

-                ;; Return (VALUE-KIND . VALUE-FORM), ready for passing to a
-                ;; `sod-initializer' constructor.
-                (parse (or (peek (seq (#\= (frag (parse-delimited-fragment
-                                                  scanner #\{ #\})))
-                                   (cons :compound frag)))
-                           (seq ((frag (parse-delimited-fragment
-                                        scanner #\= '(#\; #\,)
-                                        :keep-end t)))
-                             (cons :simple frag)))))
+                ;; Return a VALUE, ready for passing to a `sod-initializer'
+                ;; constructor.
+                (parse-delimited-fragment scanner #\= (list #\, #\;)
+                                          :keep-end t))

 
               (parse-slot-item (sub-pset base-type type name)
                 ;; slot-item ::=
                 ;;     declspec+ declarator -!- [initializer]
 
               (parse-slot-item (sub-pset base-type type name)
                 ;; slot-item ::=
                 ;;     declspec+ declarator -!- [initializer]

-                ;;             [`,' init-declarator-list] `;'
+                ;;             [`,' list[init-declarator]] `;'

                 ;;
                 ;;

-                ;; init-declarator-list ::=
-                ;;     declarator [initializer] [`,' init-declarator-list]
+                ;; init-declarator ::= declarator [initializer]

                 (parse (and (seq ((init (? (parse-initializer))))
                               (make-sod-slot class name type
                                              sub-pset scanner)
                               (when init
                                 (make-sod-instance-initializer
                 (parse (and (seq ((init (? (parse-initializer))))
                               (make-sod-slot class name type
                                              sub-pset scanner)
                               (when init
                                 (make-sod-instance-initializer

-                                 class nick name (car init) (cdr init)
-                                 nil scanner)))
+                                 class nick name init sub-pset scanner)))

                             (skip-many ()
                               (seq (#\,
                                     (ds (parse-declarator scanner
                             (skip-many ()
                               (seq (#\,
                                     (ds (parse-declarator scanner


@@ -236,25 +335,25 @@ (defun parse-class-body (scaner pset name supers)
                                                sub-pset scanner)
                                 (when init
                                   (make-sod-instance-initializer
                                                sub-pset scanner)
                                 (when init
                                   (make-sod-instance-initializer

-                                   class nick (cdr ds)
-                                   (car init) (cdr init)
-                                   nil scanner))))
+                                   class nick (cdr ds) init
+                                   sub-pset scanner))))

                             #\;)))
 
                             #\;)))
 

-              (parse-initializer-item (sub-pset constructor)
+              (parse-initializer-item (sub-pset must-init-p constructor)

                 ;; initializer-item ::=
                 ;; initializer-item ::=

-                ;;     [`class'] -!- slot-initializer-list `;'
+                ;;     [`class'] -!- list[slot-initializer] `;'

                 ;;
                 ;;

-                ;; slot-initializer ::= id `.' id initializer
-                (parse (and (skip-many ()
-                              (seq ((name-a :id) #\. (name-b :id)
-                                    (init (parse-initializer)))
-                                (funcall constructor class
-                                         name-a name-b
-                                         (car init) (cdr init)
-                                         sub-pset scanner))
-                              #\,)
-                            #\;)))
+                ;; slot-initializer ::= id `.' id [initializer]
+                (let ((parse-init (if must-init-p #'parse-initializer
+                                      (parser () (? (parse-initializer))))))
+                  (parse (and (skip-many ()
+                                (seq ((name-a :id) #\. (name-b :id)
+                                      (init (funcall parse-init)))
+                                  (funcall constructor class
+                                           name-a name-b init
+                                           sub-pset scanner))
+                                #\,)
+                              #\;))))

 
               (class-item-dispatch (sub-pset base-type type name)
                 ;; Logically part of `parse-raw-class-item', but the
 
               (class-item-dispatch (sub-pset base-type type name)
                 ;; Logically part of `parse-raw-class-item', but the


@@ -268,9 +367,8 @@ (defun parse-class-body (scaner pset name supers)
                 ;; definition; otherwise it might be a message or slot.
                 (cond ((not (typep type 'c-function-type))
                        (when (consp name)
                 ;; definition; otherwise it might be a message or slot.
                 (cond ((not (typep type 'c-function-type))
                        (when (consp name)

-                         (cerror*-with-location
-                          scanner
-                          "Method declarations must have function type.")
+                         (cerror*
+                          "Method declarations must have function type")

                          (setf name (cdr name)))
                        (parse-slot-item sub-pset base-type type name))
                       ((consp name)
                          (setf name (cdr name)))
                        (parse-slot-item sub-pset base-type type name))
                       ((consp name)


@@ -285,55 +383,49 @@ (defun parse-class-body (scaner pset name supers)
                 ;;   | method-item
                 ;;   | slot-item
                 ;;   | initializer-item
                 ;;   | method-item
                 ;;   | slot-item
                 ;;   | initializer-item

+                ;;   | initfrag-item

                 ;;
                 ;; Most of the above begin with declspecs and a declarator
                 ;; (which might be dotted).  So we parse that here and
                 ;; dispatch based on what we find.
                 ;;
                 ;; Most of the above begin with declspecs and a declarator
                 ;; (which might be dotted).  So we parse that here and
                 ;; dispatch based on what we find.

-                (parse (or (peek
+                (parse (or (plug class-item scanner class sub-pset)
+                           (peek

                             (seq ((ds (parse-c-type scanner))
                                   (dc (parse-maybe-dotted-declarator ds))
                             (seq ((ds (parse-c-type scanner))
                                   (dc (parse-maybe-dotted-declarator ds))

-                                  (result (class-item-dispatch sub-pset
-                                                               ds
-                                                               (car dc)
-                                                               (cdr dc))))
-                              result))
+                                  (nil (commit))
+                                  (nil (class-item-dispatch sub-pset
+                                                            ds
+                                                            (car dc)
+                                                            (cdr dc))))))

                            (and "class"
                            (and "class"

-                                (parse-initializer-item
-                                 sub-pset
+                                (parse-initializer-item sub-pset t

                                  #'make-sod-class-initializer))
                                  #'make-sod-class-initializer))

-                           (parse-initializer-item
-                            sub-pset
+                           (parse-initializer-item sub-pset nil

                             #'make-sod-instance-initializer)))))
 
                             #'make-sod-instance-initializer)))))
 

-       (parse (and #\{
-                   (skip-many ()
-                     (seq ((sub-pset (? (parse-property-set)))
-                           (nil (parse-raw-class-item sub-pset)))))
-                   #\}))))))
-
-(define-pluggable-parser module class (scanner)
-  ;; `class' id [`:' id-list] class-body
+       (parse (seq (#\{
+                    (nil (skip-many ()
+                           (seq ((sub-pset (parse-property-set scanner))
+                                 (nil (parse-raw-class-item sub-pset)))
+                             (check-unused-properties sub-pset))))
+                    (nil (error () #\})))
+                (unless (finalize-sod-class class)
+                  (setf duff t))
+                (unless duff
+                  (add-to-module *module* class))))))))
+
+(define-pluggable-parser module class (scanner pset)
+  ;; `class' id `:' list[id] class-body

   ;; `class' id `;'
   ;; `class' id `;'

-

   (with-parser-context (token-scanner-context :scanner scanner)
     (parse (seq ("class"
                 (name :id)
                 (nil (or (seq (#\;)
                            (make-class-type name))
   (with-parser-context (token-scanner-context :scanner scanner)
     (parse (seq ("class"
                 (name :id)
                 (nil (or (seq (#\;)
                            (make-class-type name))

-                         (seq ((supers (? (seq (#\: (ids (list () :id #\,)))
-                                            ids)))
+                         (seq ((supers (seq (#\: (ids (list () :id #\,)))
+                                         ids))

                                (nil (parse-class-body
                                      scanner
                                      pset name supers)))))))))))
 
                                (nil (parse-class-body
                                      scanner
                                      pset name supers)))))))))))
 

-
-
-
-    (parse (seq ("class"
-                (name :id)
-                (supers (? (seq (#\: (supers (list (:min 1) :id #\,)))
-                                supers)))
-                #\{
-                
-

 ;;;----- That's all, folks --------------------------------------------------
 ;;;----- That's all, folks --------------------------------------------------