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)
144 (merge-pathnames name
145 (make-pathname :type type
149 (with-parser-context (token-scanner-context :scanner scanner)
150 (parse (or (seq ("import" (name :string) #\;)
151 (common name "SOD" "module"
154 (let ((module (read-module path
157 (module-import module)
162 (cerror* "Error reading module ~S: ~A"
164 (seq ("load" (name :string) #\;)
165 (common name "LISP" "Lisp file"
168 (load true :verbose nil :print nil)
170 (cerror* "Error loading Lisp file ~S: ~A"
171 path error)))))))))))
173 ;;; Setting properties.
175 (define-pluggable-parser module set (scanner pset)
176 ;; `set' list[property] `;'
177 (with-parser-context (token-scanner-context :scanner scanner)
179 (lisp (let ((module-pset (module-pset *module*)))
181 (pset-map (lambda (prop)
184 (p-name prop) (p-value prop)
186 :location (p-location prop))
187 (setf (p-seenp prop) t))
189 (parse (skip-many (:min (if pset 0 1))
190 (error (:ignore-unconsumed t)
191 (parse-property scanner module-pset)
192 (skip-until () #\, #\;))
198 (define-pluggable-parser module lisp (scanner pset)
199 ;; `lisp' s-expression `;'
200 (declare (ignore pset))
201 (with-parser-context (token-scanner-context :scanner scanner)
202 (parse (seq ((sexp (if (and (eql (token-type scanner) :id)
203 (string= (token-value scanner) "lisp"))
204 (let* ((stream (make-scanner-stream scanner))
205 (sexp (read stream t)))
206 (scanner-step scanner)
208 (values '((:id "lisp")) nil nil)))
212 ;;;--------------------------------------------------------------------------
213 ;;; Class declarations.
217 (define-pluggable-parser class-item initfrags (scanner class pset)
218 ;; raw-class-item ::= frag-keyword `{' c-fragment `}'
219 ;; frag-keyword ::= `init' | `teardown'
220 (with-parser-context (token-scanner-context :scanner scanner)
221 (parse (seq ((make (or (seq ("init") #'make-sod-class-initfrag)
222 (seq ("teardown") #'make-sod-class-tearfrag)))
223 (frag (parse-delimited-fragment scanner #\{ #\})))
224 (funcall make class frag pset scanner)))))
226 (define-pluggable-parser class-item initargs (scanner class pset)
227 ;; initarg-item ::= `initarg' declspec+ list[init-declarator]
228 ;; init-declarator ::= declarator [`=' initializer]
229 (with-parser-context (token-scanner-context :scanner scanner)
230 (parse (seq ("initarg"
231 (base-type (parse-c-type scanner))
232 (nil (skip-many (:min 1)
233 (seq ((declarator (parse-declarator scanner
235 (init (? (parse-delimited-fragment
236 scanner #\= (list #\; #\,)
238 (make-sod-user-initarg class
245 (defun parse-class-body (scanner pset name supers)
246 ;; class-body ::= `{' class-item* `}'
248 ;; class-item ::= property-set raw-class-item
249 (with-parser-context (token-scanner-context :scanner scanner)
250 (make-class-type name)
252 (class (make-sod-class name
254 (mapcar #'find-sod-class supers)
257 (list (find-sod-class "SodObject"))))
259 (nick (sod-class-nickname class)))
261 (labels ((parse-maybe-dotted-declarator (base-type)
262 ;; Parse a declarator or dotted-declarator, i.e., one whose
265 ;; maybe-dotted-identifier ::= [id `.'] id
267 ;; A plain identifier is returned as a string, as usual; a
268 ;; dotted identifier is returned as a cons cell of the two
275 (name-b (? (seq (#\. (id :id)) id))))
276 (if name-b (cons name-a name-b)
279 (parse-message-item (sub-pset type name)
281 ;; declspec+ declarator -!- (method-body | `;')
283 ;; Don't allow a method-body here if the message takes a
284 ;; varargs list, because we don't have a name for the
285 ;; `va_list' parameter.
286 (let ((message (make-sod-message class name type
288 (if (varargs-message-p message)
290 (parse (or #\; (parse-method-item sub-pset
293 (parse-method-item (sub-pset type sub-nick name)
295 ;; declspec+ dotted-declarator -!- method-body
297 ;; method-body ::= `{' c-fragment `}' | `extern' `;'
298 (parse (seq ((body (or (seq ("extern" #\;) nil)
299 (parse-delimited-fragment
301 (make-sod-method class sub-nick name type
302 body sub-pset scanner))))
304 (parse-initializer ()
305 ;; initializer ::= `=' c-fragment
307 ;; Return a VALUE, ready for passing to a `sod-initializer'
309 (parse-delimited-fragment scanner #\= (list #\, #\;)
312 (parse-slot-item (sub-pset base-type type name)
314 ;; declspec+ declarator -!- [initializer]
315 ;; [`,' list[init-declarator]] `;'
317 ;; init-declarator ::= declarator [initializer]
318 (parse (and (seq ((init (? (parse-initializer))))
319 (make-sod-slot class name type
322 (make-sod-instance-initializer
323 class nick name init sub-pset scanner)))
326 (ds (parse-declarator scanner
328 (init (? (parse-initializer))))
329 (make-sod-slot class (cdr ds) (car ds)
332 (make-sod-instance-initializer
333 class nick (cdr ds) init
337 (parse-initializer-item (sub-pset must-init-p constructor)
338 ;; initializer-item ::=
339 ;; [`class'] -!- list[slot-initializer] `;'
341 ;; slot-initializer ::= id `.' id [initializer]
342 (let ((parse-init (if must-init-p #'parse-initializer
343 (parser () (? (parse-initializer))))))
344 (parse (and (skip-many ()
345 (seq ((name-a :id) #\. (name-b :id)
346 (init (funcall parse-init)))
347 (funcall constructor class
353 (class-item-dispatch (sub-pset base-type type name)
354 ;; Logically part of `parse-raw-class-item', but the
355 ;; indentation was getting crazy. We're currently at
357 ;; raw-class-item ::=
358 ;; declspec+ (declarator | dotted-declarator) -!- ...
361 ;; If the declarator is dotted then this must be a method
362 ;; definition; otherwise it might be a message or slot.
363 (cond ((not (typep type 'c-function-type))
366 "Method declarations must have function type")
367 (setf name (cdr name)))
368 (parse-slot-item sub-pset base-type type name))
370 (parse-method-item sub-pset type
371 (car name) (cdr name)))
373 (parse-message-item sub-pset type name))))
375 (parse-raw-class-item (sub-pset)
376 ;; raw-class-item ::=
380 ;; | initializer-item
383 ;; Most of the above begin with declspecs and a declarator
384 ;; (which might be dotted). So we parse that here and
385 ;; dispatch based on what we find.
386 (parse (or (plug class-item scanner class sub-pset)
388 (seq ((ds (parse-c-type scanner))
389 (dc (parse-maybe-dotted-declarator ds))
391 (nil (class-item-dispatch sub-pset
396 (parse-initializer-item sub-pset t
397 #'make-sod-class-initializer))
398 (parse-initializer-item sub-pset nil
399 #'make-sod-instance-initializer)))))
403 (seq ((sub-pset (parse-property-set scanner))
404 (nil (parse-raw-class-item sub-pset)))
405 (check-unused-properties sub-pset))))
406 (nil (error () #\})))
407 (unless (finalize-sod-class class)
410 (add-to-module *module* class))))))))
412 (define-pluggable-parser module class (scanner pset)
413 ;; `class' id `:' list[id] class-body
415 (with-parser-context (token-scanner-context :scanner scanner)
419 (make-class-type name))
420 (seq ((supers (seq (#\: (ids (list () :id #\,)))
422 (nil (parse-class-body
424 pset name supers)))))))))))
426 ;;;----- That's all, folks --------------------------------------------------