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' id ( `,' id )* `;'
35 (declare (ignore pset))
36 (with-parser-context (token-scanner-context :scanner scanner)
37 (parse (and "typename"
40 (if (gethash id *module-type-map*)
41 (cerror* "Type `~A' already defined" id)
42 (add-to-module *module*
43 (make-instance 'type-item
50 (define-pluggable-parser module code (scanner pset)
51 ;; `code' id `:' item-name [constraints] `{' c-fragment `}'
53 ;; constrains ::= `[' constraint-list `]'
54 ;; constraint ::= item-name+
55 ;; item-name ::= id | `(' id+ `)'
56 (declare (ignore pset))
57 (with-parser-context (token-scanner-context :scanner scanner)
59 (parse (seq ((kw :id))
60 (intern (frob-identifier kw) 'keyword))))
63 (seq (#\( (names (list (:min 1) (kw))) #\))
69 (constraints (? (seq (#\[
70 (constraints (list (:min 1)
76 (fragment (parse-delimited-fragment scanner #\{ #\})))
77 (add-to-module *module*
78 (make-instance 'code-fragment-item
80 :constraints constraints
87 (defun read-module (pathname &key (truename nil truep) location)
88 "Parse the file at PATHNAME as a module, returning it.
90 This is the main entry point for parsing module files. You may well know
91 the file's TRUENAME already (e.g., because `probe-file' dropped it into
92 your lap) so you can avoid repeating the search by providing it.
94 The LOCATION is the thing which wanted the module imported -- usually a
95 `file-location' object, though it might be anything other than `t' which
96 can be printed in the event of circular imports."
98 (setf pathname (merge-pathnames pathname
99 (make-pathname :type "SOD" :case :common)))
100 (unless truep (setf truename (truename pathname)))
101 (define-module (pathname :location location :truename truename)
102 (with-open-file (f-stream pathname :direction :input)
103 (let* ((*readtable* (copy-readtable))
104 (char-scanner (make-instance 'charbuf-scanner
106 (scanner (make-instance 'sod-token-scanner
107 :char-scanner char-scanner)))
108 (with-default-error-location (scanner)
109 (with-parser-context (token-scanner-context :scanner scanner)
111 (seq ((pset (parse-property-set scanner))
113 (plug module scanner pset))))
114 (check-unused-properties pset))))))))))
116 (define-pluggable-parser module test (scanner pset)
118 (declare (ignore pset))
119 (with-parser-context (token-scanner-context :scanner scanner)
120 (parse (seq ("demo" (string :string) #\;)
121 (format t ";; DEMO ~S~%" string)))))
123 (define-pluggable-parser module file (scanner pset)
124 ;; `import' string `;'
126 (declare (ignore pset))
127 (flet ((common (name type what thunk)
129 (merge-pathnames name
130 (make-pathname :type type
134 (with-parser-context (token-scanner-context :scanner scanner)
135 (parse (or (seq ("import" (name :string) #\;)
136 (common name "SOD" "module"
139 (let ((module (read-module path
142 (module-import module)
147 (cerror* "Error reading module ~S: ~A"
149 (seq ("load" (name :string) #\;)
150 (common name "LISP" "Lisp file"
153 (load true :verbose nil :print nil)
155 (cerror* "Error loading Lisp file ~S: ~A"
156 path error)))))))))))
158 ;;; Setting properties.
160 (define-pluggable-parser module set (scanner pset)
161 ;; `set' property-list `;'
162 (with-parser-context (token-scanner-context :scanner scanner)
164 (lisp (let ((module-pset (module-pset *module*)))
166 (pset-map (lambda (prop)
167 (add-property module-pset
171 :location (p-location prop))
172 (setf (p-seenp prop) t))
174 (parse (skip-many (:min 0)
175 (error (:ignore-unconsumed t)
176 (parse-property scanner module-pset)
177 (skip-until (:keep-end t) #\, #\;))
183 (define-pluggable-parser module lisp (scanner pset)
184 ;; `lisp' s-expression `;'
185 (declare (ignore pset))
186 (with-parser-context (token-scanner-context :scanner scanner)
187 (parse (seq ((sexp (if (and (eql (token-type scanner) :id)
188 (string= (token-value scanner) "lisp"))
189 (let* ((stream (make-scanner-stream scanner))
190 (sexp (read stream t)))
191 (scanner-step scanner)
193 (values '((:id "lisp")) nil nil)))
197 ;;;--------------------------------------------------------------------------
198 ;;; Class declarations.
202 (defun parse-class-body (scanner pset name supers)
203 ;; class-body ::= `{' class-item* `}'
205 ;; class-item ::= property-set raw-class-item
206 (with-parser-context (token-scanner-context :scanner scanner)
207 (make-class-type name)
208 (let* ((class (make-sod-class name (mapcar #'find-sod-class supers)
210 (nick (sod-class-nickname class)))
212 (labels ((parse-maybe-dotted-declarator (base-type)
213 ;; Parse a declarator or dotted-declarator, i.e., one whose
216 ;; maybe-dotted-identifier ::= [id `.'] id
218 ;; A plain identifier is returned as a string, as usual; a
219 ;; dotted identifier is returned as a cons cell of the two
226 (name-b (? (seq (#\. (id :id)) id))))
227 (if name-b (cons name-a name-b)
230 (parse-message-item (sub-pset type name)
232 ;; declspec+ declarator -!- (method-body | `;')
234 ;; Don't allow a method-body here if the message takes a
235 ;; varargs list, because we don't have a name for the
236 ;; `va_list' parameter.
237 (let ((message (make-sod-message class name type
239 (if (varargs-message-p message)
241 (parse (or #\; (parse-method-item sub-pset
244 (parse-method-item (sub-pset type sub-nick name)
246 ;; declspec+ dotted-declarator -!- method-body
248 ;; method-body ::= `{' c-fragment `}' | `extern' `;'
249 (parse (seq ((body (or (seq ("extern" #\;) nil)
250 (parse-delimited-fragment
252 (make-sod-method class sub-nick name type
253 body sub-pset scanner))))
255 (parse-initializer ()
256 ;; initializer ::= `=' c-fragment | `=' `{' c-fragment `}'
258 ;; Return (VALUE-KIND . VALUE-FORM), ready for passing to a
259 ;; `sod-initializer' constructor.
261 ;; This is kind of tricky because we have to juggle both
262 ;; layers of the parsing machinery. The character scanner
263 ;; will already have consumed the lookahead token (which, if
264 ;; we're going to do anything, is `=').
265 (let ((char-scanner (token-scanner-char-scanner scanner)))
267 ;; First, skip the character-scanner past any whitespace.
268 ;; We don't record this consumption, which is a bit
269 ;; naughty, but nobody will actually mind.
271 (when (or (scanner-at-eof-p char-scanner)
272 (not (whitespace-char-p
273 (scanner-current-char char-scanner))))
275 (scanner-step char-scanner))
277 ;; Now maybe read an initializer.
278 (cond ((not (eql (token-type scanner) #\=))
279 ;; It's not an `=' after all. There's no
281 (values '(#\=) nil nil))
283 ((and (not (scanner-at-eof-p char-scanner))
284 (char= (scanner-current-char char-scanner)
286 ;; There's a brace after the `=', so we should
287 ;; consume the `=' here, and read a compound
288 ;; initializer enclosed in braces.
289 (parse (seq (#\= (frag (parse-delimited-fragment
291 (cons :compound frag))))
294 ;; No brace, so read from the `=' up to, but not
295 ;; including, the trailing `,' or `;' delimiter.
296 (parse (seq ((frag (parse-delimited-fragment
297 scanner #\= '(#\; #\,)
299 (cons :simple frag)))))))
301 (parse-slot-item (sub-pset base-type type name)
303 ;; declspec+ declarator -!- [initializer]
304 ;; [`,' init-declarator-list] `;'
306 ;; init-declarator-list ::=
307 ;; declarator [initializer] [`,' init-declarator-list]
308 (parse (and (seq ((init (? (parse-initializer))))
309 (make-sod-slot class name type
312 (make-sod-instance-initializer
313 class nick name (car init) (cdr init)
317 (ds (parse-declarator scanner
319 (init (? (parse-initializer))))
320 (make-sod-slot class (cdr ds) (car ds)
323 (make-sod-instance-initializer
325 (car init) (cdr init)
329 (parse-initializer-item (sub-pset constructor)
330 ;; initializer-item ::=
331 ;; [`class'] -!- slot-initializer-list `;'
333 ;; slot-initializer ::= id `.' id initializer
334 (parse (and (skip-many ()
335 (seq ((name-a :id) #\. (name-b :id)
336 (init (parse-initializer)))
337 (funcall constructor class
339 (car init) (cdr init)
344 (class-item-dispatch (sub-pset base-type type name)
345 ;; Logically part of `parse-raw-class-item', but the
346 ;; indentation was getting crazy. We're currently at
348 ;; raw-class-item ::=
349 ;; declspec+ (declarator | dotted-declarator) -!- ...
352 ;; If the declarator is dotted then this must be a method
353 ;; definition; otherwise it might be a message or slot.
354 (cond ((not (typep type 'c-function-type))
356 (cerror*-with-location
358 "Method declarations must have function type.")
359 (setf name (cdr name)))
360 (parse-slot-item sub-pset base-type type name))
362 (parse-method-item sub-pset type
363 (car name) (cdr name)))
365 (parse-message-item sub-pset type name))))
367 (parse-raw-class-item (sub-pset)
368 ;; raw-class-item ::=
372 ;; | initializer-item
374 ;; Most of the above begin with declspecs and a declarator
375 ;; (which might be dotted). So we parse that here and
376 ;; dispatch based on what we find.
377 (parse (or (plug class-item scanner class sub-pset)
379 (seq ((ds (parse-c-type scanner))
380 (dc (parse-maybe-dotted-declarator ds))
381 (nil (class-item-dispatch sub-pset
386 (parse-initializer-item
388 #'make-sod-class-initializer))
389 (parse-initializer-item
391 #'make-sod-instance-initializer)))))
395 (seq ((sub-pset (parse-property-set scanner))
396 (nil (parse-raw-class-item sub-pset)))
397 (check-unused-properties sub-pset))))
398 (nil (error () #\})))
399 (finalize-sod-class class)
400 (add-to-module *module* class)))))))
402 (define-pluggable-parser module class (scanner pset)
403 ;; `class' id [`:' id-list] class-body
405 (with-parser-context (token-scanner-context :scanner scanner)
409 (make-class-type name))
410 (seq ((supers (? (seq (#\: (ids (list () :id #\,)))
412 (nil (parse-class-body
414 pset name supers)))))))))))
416 ;;;----- That's all, folks --------------------------------------------------