3 ;;; Top-level parser for module syntax
5 ;;; (c) 2010 Straylight/Edgeware
8 ;;;----- Licensing notice ---------------------------------------------------
10 ;;; This file is part of the Sensible Object Design, an object system for C.
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.
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.
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.
28 ;;;--------------------------------------------------------------------------
33 (define-pluggable-parser module typename (scanner pset)
34 ;; `typename' list[id] `;'
35 (declare (ignore pset))
36 (with-parser-context (token-scanner-context :scanner scanner)
37 (parse (and "typename"
41 (if (or (gethash id *module-type-map*)
42 (find-simple-c-type id))
43 (cerror* "Type `~A' already defined" id)
44 (add-to-module *module*
45 (make-instance 'type-item
47 (skip-until () #\, #\;))
53 (define-pluggable-parser module code (scanner pset)
54 ;; `code' id `:' item-name [constraints] `{' c-fragment `}'
56 ;; constraints ::= `[' list[constraint] `]'
57 ;; constraint ::= item-name+
58 ;; item-name ::= id | `(' id+ `)'
59 (declare (ignore pset))
60 (with-parser-context (token-scanner-context :scanner scanner)
62 (parse (seq ((kw :id))
63 (intern (frob-identifier kw) 'keyword))))
66 (seq (#\( (names (list (:min 1) (kw))) #\))
72 (constraints (? (seq (#\[
76 (error (:ignore-unconsumed t)
83 (fragment (parse-delimited-fragment scanner #\{ #\})))
85 (add-to-module *module*
86 (make-instance 'code-fragment-item
88 :constraints constraints
95 (defun read-module (pathname &key (truename nil truep) location)
96 "Parse the file at PATHNAME as a module, returning it.
98 This is the main entry point for parsing module files. You may well know
99 the file's TRUENAME already (e.g., because `probe-file' dropped it into
100 your lap) so you can avoid repeating the search by providing it.
102 The LOCATION is the thing which wanted the module imported -- usually a
103 `file-location' object, though it might be anything other than `t' which
104 can be printed in the event of circular imports."
106 (setf pathname (merge-pathnames pathname
107 (make-pathname :type "SOD" :case :common)))
108 (unless truep (setf truename (truename pathname)))
109 (define-module (pathname :location location :truename truename)
110 (with-open-file (f-stream pathname :direction :input)
111 (let* ((*readtable* (copy-readtable))
112 (*package* (find-package '#:sod-user))
113 (char-scanner (make-instance 'charbuf-scanner
115 :filename (namestring pathname)))
116 (scanner (make-instance 'sod-token-scanner
117 :char-scanner char-scanner)))
118 (with-default-error-location (scanner)
119 (with-parser-context (token-scanner-context :scanner scanner)
120 (multiple-value-bind (result winp consumedp)
122 (seq ((pset (parse-property-set scanner))
124 (plug module scanner pset)
125 (skip-until (:keep-end nil)
127 (check-unused-properties pset))))
128 (declare (ignore consumedp))
129 (unless winp (syntax-error scanner result)))))))))
131 (define-pluggable-parser module test (scanner pset)
133 (declare (ignore pset))
134 (with-parser-context (token-scanner-context :scanner scanner)
135 (parse (seq ("demo" (string (must :string)) (nil (must #\;)))
136 (format t ";; DEMO ~S~%" string)))))
138 (define-pluggable-parser module file (scanner pset)
139 ;; `import' string `;'
141 (declare (ignore pset))
142 (flet ((common (name type what thunk)
145 (merge-pathnames name
146 (make-pathname :type type
150 (with-parser-context (token-scanner-context :scanner scanner)
151 (parse (or (seq ("import" (name (must :string)) (nil (must #\;)))
152 (common name "SOD" "module"
155 (let ((module (read-module path
158 (module-import module)
163 (cerror* "Error reading module ~S: ~A"
166 (cerror* "Unexpected error reading ~
169 (seq ("load" (name (must :string)) (nil (must #\;)))
170 (common name "LISP" "Lisp file"
173 (load true :verbose nil :print nil)
175 (cerror* "Error loading Lisp file ~S: ~A"
176 path error)))))))))))
178 ;;; Setting properties.
180 (define-pluggable-parser module set (scanner pset)
181 ;; `set' list[property] `;'
182 (with-parser-context (token-scanner-context :scanner scanner)
184 (lisp (let ((module-pset (module-pset *module*)))
186 (pset-map (lambda (prop)
189 (p-name prop) (p-value prop)
191 :location (p-location prop))
192 (setf (p-seenp prop) t))
194 (parse (skip-many (:min (if pset 0 1))
195 (error (:ignore-unconsumed t)
196 (parse-property scanner module-pset)
197 (skip-until () #\, #\;))
203 (define-pluggable-parser module lisp (scanner pset)
204 ;; `lisp' s-expression `;'
205 (declare (ignore pset))
206 (with-parser-context (token-scanner-context :scanner scanner)
207 (parse (seq ((sexp (if (and (eql (token-type scanner) :id)
208 (string= (token-value scanner) "lisp"))
209 (let* ((stream (make-scanner-stream scanner))
210 (sexp (read stream t)))
211 (scanner-step scanner)
213 (values '((:id "lisp")) nil nil)))
217 ;;;--------------------------------------------------------------------------
218 ;;; Class declarations.
222 (define-pluggable-parser class-item initfrags (scanner class pset)
223 ;; raw-class-item ::= frag-keyword `{' c-fragment `}'
224 ;; frag-keyword ::= `init' | `teardown'
225 (with-parser-context (token-scanner-context :scanner scanner)
226 (parse (seq ((make (or (seq ("init") #'make-sod-class-initfrag)
227 (seq ("teardown") #'make-sod-class-tearfrag)))
228 (frag (parse-delimited-fragment scanner #\{ #\})))
229 (funcall make class frag pset scanner)))))
231 (define-pluggable-parser class-item initargs (scanner class pset)
232 ;; initarg-item ::= `initarg' declspec+ list[init-declarator]
233 ;; init-declarator ::= declarator [`=' initializer]
234 (with-parser-context (token-scanner-context :scanner scanner)
235 (parse (seq ("initarg"
236 (base-type (parse-c-type scanner))
237 (nil (skip-many (:min 1)
238 (seq ((declarator (parse-declarator scanner
240 (init (? (parse-delimited-fragment
241 scanner #\= (list #\; #\,)
243 (make-sod-user-initarg class
248 (nil (must #\;)))))))
250 (defun synthetic-name ()
251 "Return an obviously bogus synthetic not-identifier."
252 (let ((ix *temporary-index*))
253 (incf *temporary-index*)
254 (make-instance 'temporary-variable :tag (format nil "%%#~A" ix))))
256 (defun parse-class-body (scanner pset name supers)
257 ;; class-body ::= `{' class-item* `}'
259 ;; class-item ::= property-set raw-class-item
260 (with-parser-context (token-scanner-context :scanner scanner)
261 (when name (make-class-type name))
262 (let* ((duff (null name))
263 (synthetic-name (or name
264 (let ((var (synthetic-name)))
266 (setf pset (make-property-set)))
267 (unless (pset-get pset "nick")
268 (add-property pset "nick" var :type :id))
270 (class (make-sod-class synthetic-name
272 (mapcar #'find-sod-class
273 (or supers (list "SodObject")))
276 (list (find-sod-class "SodObject"))))
278 (nick (sod-class-nickname class)))
281 (parse (must :id (progn (setf duff t) (synthetic-name)))))
283 (parse-maybe-dotted-name ()
284 ;; maybe-dotted-name ::= [id `.'] id
286 ;; A plain identifier is returned as a string, as usual; a
287 ;; dotted identifier is returned as a cons cell of the two
289 (parse (seq ((name-a (must-id))
290 (name-b (? (seq (#\. (id (must-id))) id))))
291 (if name-b (cons name-a name-b)
294 (parse-maybe-dotted-declarator (base-type)
295 ;; Parse a declarator or dotted-declarator, i.e., one whose
296 ;; centre is maybe-dotted-name above.
297 (parse-declarator scanner base-type
299 :kernel #'parse-maybe-dotted-name))
301 (parse-message-item (sub-pset type name)
303 ;; declspec+ declarator -!- (method-body | `;')
305 ;; Don't allow a method-body here if the message takes a
306 ;; varargs list, because we don't have a name for the
307 ;; `va_list' parameter.
308 (let ((message (make-sod-message class name type
310 (if (varargs-message-p message)
312 (parse (or #\; (parse-method-item sub-pset
315 (parse-method-item (sub-pset type sub-nick name)
317 ;; declspec+ dotted-declarator -!- method-body
319 ;; method-body ::= `{' c-fragment `}' | `extern' `;'
320 (parse (seq ((body (or (seq ("extern" #\;) nil)
321 (parse-delimited-fragment
324 (make-sod-method class sub-nick name type
325 body sub-pset scanner)
326 (continue () :report "Continue")))))
328 (parse-initializer ()
329 ;; initializer ::= `=' c-fragment
331 ;; Return a VALUE, ready for passing to a `sod-initializer'
333 (parse-delimited-fragment scanner #\= '(#\, #\;)
336 (parse-slot-item (sub-pset base-type type name)
338 ;; declspec+ declarator -!- [initializer]
339 ;; [`,' list[init-declarator]] `;'
341 ;; init-declarator ::= declarator [initializer]
342 (flet ((make-it (name type init)
345 (make-sod-slot class name type
348 (make-sod-instance-initializer class
353 (continue () :report "Continue"))))
354 (parse (and (error ()
355 (seq ((init (? (parse-initializer))))
356 (make-it name type init))
357 (skip-until () #\, #\;))
359 (error (:ignore-unconsumed t)
361 (ds (parse-declarator scanner
363 (init (? (parse-initializer))))
364 (make-it (cdr ds) (car ds) init))
365 (skip-until () #\, #\;)))
368 (parse-initializer-item (sub-pset must-init-p constructor)
369 ;; initializer-item ::=
370 ;; [`class'] -!- list[slot-initializer] `;'
372 ;; slot-initializer ::= id `.' id [initializer]
373 (let ((parse-init (if must-init-p #'parse-initializer
374 (parser () (? (parse-initializer))))))
375 (parse (and (skip-many ()
376 (error (:ignore-unconsumed t)
377 (seq ((name-a :id) #\.
379 (init (funcall parse-init)))
381 (funcall constructor class
384 (continue () :report "Continue")))
385 (skip-until () #\, #\;))
389 (class-item-dispatch (sub-pset base-type type name)
390 ;; Logically part of `parse-raw-class-item', but the
391 ;; indentation was getting crazy. We're currently at
393 ;; raw-class-item ::=
394 ;; declspec+ (declarator | dotted-declarator) -!- ...
397 ;; If the declarator is dotted then this must be a method
398 ;; definition; otherwise it might be a message or slot.
399 (cond ((not (typep type 'c-function-type))
402 "Method declarations must have function type")
403 (setf name (cdr name)))
404 (parse-slot-item sub-pset base-type type name))
406 (parse-method-item sub-pset type
407 (car name) (cdr name)))
409 (parse-message-item sub-pset type name))))
411 (parse-raw-class-item (sub-pset)
412 ;; raw-class-item ::=
416 ;; | initializer-item
419 ;; Most of the above begin with declspecs and a declarator
420 ;; (which might be dotted). So we parse that here and
421 ;; dispatch based on what we find.
422 (parse (or (plug class-item scanner class sub-pset)
424 (seq ((ds (parse-c-type scanner))
425 (dc (parse-maybe-dotted-declarator ds))
427 (nil (class-item-dispatch sub-pset
432 (parse-initializer-item sub-pset t
433 #'make-sod-class-initializer))
434 (parse-initializer-item sub-pset nil
435 #'make-sod-instance-initializer)))))
437 (parse (seq ((nil (must #\{))
439 (seq ((sub-pset (parse-property-set scanner))
440 (nil (parse-raw-class-item sub-pset)))
441 (check-unused-properties sub-pset))))
443 (unless (finalize-sod-class class)
446 (add-to-module *module* class))))))))
448 (define-pluggable-parser module class (scanner pset)
449 ;; `class' id `:' list[id] class-body
451 (with-parser-context (token-scanner-context :scanner scanner)
455 (when name (make-class-type name)))
456 (seq ((supers (must (seq (#\:
457 (ids (list () :id #\,)))
459 (nil (parse-class-body
461 pset name supers)))))))))))
463 ;;;----- That's all, folks --------------------------------------------------