Commit | Line | Data |
---|---|---|
bf090e02 MW |
1 | ;;; -*-lisp-*- |
2 | ;;; | |
3 | ;;; Top-level parser for module syntax | |
4 | ;;; | |
5 | ;;; (c) 2010 Straylight/Edgeware | |
6 | ;;; | |
7 | ||
8 | ;;;----- Licensing notice --------------------------------------------------- | |
9 | ;;; | |
e0808c47 | 10 | ;;; This file is part of the Sensible Object Design, an object system for C. |
bf090e02 MW |
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 | (in-package #:sod) | |
27 | ||
28 | ;;;-------------------------------------------------------------------------- | |
29 | ;;; Toplevel syntax. | |
30 | ||
bf090e02 MW |
31 | ;;; Type names. |
32 | ||
048d0b2d | 33 | (define-pluggable-parser module typename (scanner pset) |
ceed01af | 34 | ;; `typename' list[id] `;' |
048d0b2d | 35 | (declare (ignore pset)) |
bf090e02 MW |
36 | (with-parser-context (token-scanner-context :scanner scanner) |
37 | (parse (and "typename" | |
65eebc3b | 38 | (skip-many () |
c41a95b1 MW |
39 | (error () |
40 | (seq ((id :id)) | |
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 | |
46 | :name id)))) | |
47 | (skip-until () #\, #\;)) | |
bf090e02 | 48 | #\,) |
c41a95b1 | 49 | (must #\;))))) |
bf090e02 MW |
50 | |
51 | ;;; Fragments. | |
52 | ||
048d0b2d | 53 | (define-pluggable-parser module code (scanner pset) |
4fc52153 | 54 | ;; `code' id `:' item-name [constraints] `{' c-fragment `}' |
048d0b2d | 55 | ;; |
ceed01af | 56 | ;; constraints ::= `[' list[constraint] `]' |
4fc52153 MW |
57 | ;; constraint ::= item-name+ |
58 | ;; item-name ::= id | `(' id+ `)' | |
048d0b2d | 59 | (declare (ignore pset)) |
bf090e02 | 60 | (with-parser-context (token-scanner-context :scanner scanner) |
4fc52153 MW |
61 | (labels ((kw () |
62 | (parse (seq ((kw :id)) | |
63 | (intern (frob-identifier kw) 'keyword)))) | |
64 | (item () | |
65 | (parse (or (kw) | |
66 | (seq (#\( (names (list (:min 1) (kw))) #\)) | |
67 | names))))) | |
9ec578d9 | 68 | (parse (seq ("code" |
ea4843d5 MW |
69 | (reason (must (kw))) |
70 | (nil (must #\:)) | |
71 | (name (must (item))) | |
9ec578d9 | 72 | (constraints (? (seq (#\[ |
ea4843d5 MW |
73 | (constraints |
74 | (list () | |
75 | (list (:min 1) | |
76 | (error (:ignore-unconsumed t) | |
77 | (item) | |
78 | (skip-until () | |
79 | :id #\( #\, #\]))) | |
80 | #\,)) | |
9ec578d9 MW |
81 | #\]) |
82 | constraints))) | |
83 | (fragment (parse-delimited-fragment scanner #\{ #\}))) | |
ea4843d5 MW |
84 | (when name |
85 | (add-to-module *module* | |
86 | (make-instance 'code-fragment-item | |
87 | :fragment fragment | |
88 | :constraints constraints | |
89 | :reason reason | |
90 | :name name)))))))) | |
bf090e02 MW |
91 | |
92 | ;;; External files. | |
93 | ||
9ec578d9 MW |
94 | (export 'read-module) |
95 | (defun read-module (pathname &key (truename nil truep) location) | |
bf090e02 MW |
96 | "Parse the file at PATHNAME as a module, returning it. |
97 | ||
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. | |
101 | ||
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." | |
105 | ||
9ec578d9 MW |
106 | (setf pathname (merge-pathnames pathname |
107 | (make-pathname :type "SOD" :case :common))) | |
108 | (unless truep (setf truename (truename pathname))) | |
bf090e02 MW |
109 | (define-module (pathname :location location :truename truename) |
110 | (with-open-file (f-stream pathname :direction :input) | |
111 | (let* ((*readtable* (copy-readtable)) | |
65e5cd24 | 112 | (*package* (find-package '#:sod-user)) |
bf090e02 | 113 | (char-scanner (make-instance 'charbuf-scanner |
e783e65b MW |
114 | :stream f-stream |
115 | :filename (namestring pathname))) | |
bf090e02 MW |
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) | |
300a3f0a MW |
120 | (multiple-value-bind (result winp consumedp) |
121 | (parse (skip-many () | |
122 | (seq ((pset (parse-property-set scanner)) | |
123 | (nil (error () | |
a8bc7831 MW |
124 | (plug module scanner pset) |
125 | (skip-until (:keep-end nil) | |
126 | #\; #\})))) | |
300a3f0a MW |
127 | (check-unused-properties pset)))) |
128 | (declare (ignore consumedp)) | |
129 | (unless winp (syntax-error scanner result))))))))) | |
048d0b2d MW |
130 | |
131 | (define-pluggable-parser module test (scanner pset) | |
132 | ;; `demo' string `;' | |
133 | (declare (ignore pset)) | |
bf090e02 | 134 | (with-parser-context (token-scanner-context :scanner scanner) |
7605e373 | 135 | (parse (seq ("demo" (string (must :string)) (nil (must #\;))) |
bf090e02 MW |
136 | (format t ";; DEMO ~S~%" string))))) |
137 | ||
048d0b2d MW |
138 | (define-pluggable-parser module file (scanner pset) |
139 | ;; `import' string `;' | |
140 | ;; `load' string `;' | |
141 | (declare (ignore pset)) | |
bf090e02 | 142 | (flet ((common (name type what thunk) |
87fa582a MW |
143 | (when name |
144 | (find-file scanner | |
145 | (merge-pathnames name | |
146 | (make-pathname :type type | |
147 | :case :common)) | |
148 | what | |
149 | thunk)))) | |
bf090e02 | 150 | (with-parser-context (token-scanner-context :scanner scanner) |
87fa582a | 151 | (parse (or (seq ("import" (name (must :string)) (nil (must #\;))) |
bf090e02 MW |
152 | (common name "SOD" "module" |
153 | (lambda (path true) | |
154 | (handler-case | |
155 | (let ((module (read-module path | |
156 | :truename true))) | |
157 | (when module | |
158 | (module-import module) | |
159 | (pushnew module | |
160 | (module-dependencies | |
161 | *module*)))) | |
162 | (file-error (error) | |
163 | (cerror* "Error reading module ~S: ~A" | |
87fa582a MW |
164 | path error)) |
165 | (error (error) | |
166 | (cerror* "Unexpected error reading ~ | |
167 | module ~S: ~A" | |
bf090e02 | 168 | path error)))))) |
87fa582a | 169 | (seq ("load" (name (must :string)) (nil (must #\;))) |
bf090e02 MW |
170 | (common name "LISP" "Lisp file" |
171 | (lambda (path true) | |
172 | (handler-case | |
173 | (load true :verbose nil :print nil) | |
174 | (error (error) | |
175 | (cerror* "Error loading Lisp file ~S: ~A" | |
176 | path error))))))))))) | |
177 | ||
01e3faf9 MW |
178 | ;;; Setting properties. |
179 | ||
180 | (define-pluggable-parser module set (scanner pset) | |
ceed01af | 181 | ;; `set' list[property] `;' |
01e3faf9 MW |
182 | (with-parser-context (token-scanner-context :scanner scanner) |
183 | (parse (and "set" | |
184 | (lisp (let ((module-pset (module-pset *module*))) | |
185 | (when pset | |
186 | (pset-map (lambda (prop) | |
5445420e MW |
187 | (add-property |
188 | module-pset | |
189 | (p-name prop) (p-value prop) | |
190 | :type (p-type prop) | |
191 | :location (p-location prop)) | |
01e3faf9 MW |
192 | (setf (p-seenp prop) t)) |
193 | pset)) | |
99a74df1 | 194 | (parse (skip-many (:min (if pset 0 1)) |
01e3faf9 | 195 | (error (:ignore-unconsumed t) |
5445420e | 196 | (parse-property scanner module-pset) |
65eebc3b | 197 | (skip-until () #\, #\;)) |
01e3faf9 MW |
198 | #\,)))) |
199 | #\;)))) | |
200 | ||
bf090e02 MW |
201 | ;;; Lisp escape. |
202 | ||
048d0b2d | 203 | (define-pluggable-parser module lisp (scanner pset) |
bf090e02 | 204 | ;; `lisp' s-expression `;' |
048d0b2d | 205 | (declare (ignore pset)) |
bf090e02 MW |
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) | |
212 | (values sexp t t)) | |
213 | (values '((:id "lisp")) nil nil))) | |
634c11b0 | 214 | (nil (must #\;))) |
bf090e02 MW |
215 | (eval sexp))))) |
216 | ||
217 | ;;;-------------------------------------------------------------------------- | |
218 | ;;; Class declarations. | |
219 | ||
7f2917d2 MW |
220 | (export 'class-item) |
221 | ||
a42893dd MW |
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))))) | |
230 | ||
b2983f35 | 231 | (define-pluggable-parser class-item initargs (scanner class pset) |
ceed01af | 232 | ;; initarg-item ::= `initarg' declspec+ list[init-declarator] |
b2983f35 MW |
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 | |
239 | base-type)) | |
240 | (init (? (parse-delimited-fragment | |
241 | scanner #\= (list #\; #\,) | |
242 | :keep-end t)))) | |
243 | (make-sod-user-initarg class | |
244 | (cdr declarator) | |
245 | (car declarator) | |
246 | pset init scanner)) | |
247 | #\,)) | |
7dca21e9 | 248 | (nil (must #\;))))))) |
b2983f35 | 249 | |
6362119e MW |
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)))) | |
255 | ||
048d0b2d | 256 | (defun parse-class-body (scanner pset name supers) |
c91b90c3 | 257 | ;; class-body ::= `{' class-item* `}' |
048d0b2d MW |
258 | ;; |
259 | ;; class-item ::= property-set raw-class-item | |
c91b90c3 | 260 | (with-parser-context (token-scanner-context :scanner scanner) |
6362119e MW |
261 | (when name (make-class-type name)) |
262 | (let* ((duff (null name)) | |
d1c01c33 MW |
263 | (superclasses |
264 | (let ((superclasses (restart-case | |
265 | (mapcar #'find-sod-class | |
266 | (or supers (list "SodObject"))) | |
267 | (continue () | |
268 | (setf duff t) | |
269 | (list (find-sod-class "SodObject")))))) | |
0c289c54 MW |
270 | (find-duplicates (lambda (first second) |
271 | (declare (ignore second)) | |
272 | (setf duff t) | |
273 | (cerror* "Class `~A' has duplicate ~ | |
274 | direct superclass `~A'" | |
275 | name first)) | |
276 | superclasses) | |
277 | (delete-duplicates superclasses))) | |
6362119e MW |
278 | (synthetic-name (or name |
279 | (let ((var (synthetic-name))) | |
280 | (unless pset | |
281 | (setf pset (make-property-set))) | |
282 | (unless (pset-get pset "nick") | |
283 | (add-property pset "nick" var :type :id)) | |
284 | var))) | |
d1c01c33 | 285 | (class (make-sod-class synthetic-name superclasses pset scanner)) |
c91b90c3 MW |
286 | (nick (sod-class-nickname class))) |
287 | ||
8152ead4 MW |
288 | (labels ((must-id () |
289 | (parse (must :id (progn (setf duff t) (synthetic-name))))) | |
290 | ||
291 | (parse-maybe-dotted-name () | |
002d481f | 292 | ;; maybe-dotted-name ::= [id `.'] id |
c91b90c3 MW |
293 | ;; |
294 | ;; A plain identifier is returned as a string, as usual; a | |
295 | ;; dotted identifier is returned as a cons cell of the two | |
296 | ;; names. | |
8152ead4 MW |
297 | (parse (seq ((name-a (must-id)) |
298 | (name-b (? (seq (#\. (id (must-id))) id)))) | |
31114112 MW |
299 | (if name-b (cons name-a name-b) |
300 | name-a)))) | |
301 | ||
302 | (parse-maybe-dotted-declarator (base-type) | |
303 | ;; Parse a declarator or dotted-declarator, i.e., one whose | |
304 | ;; centre is maybe-dotted-name above. | |
305 | (parse-declarator scanner base-type | |
306 | :keywordp t | |
307 | :kernel #'parse-maybe-dotted-name)) | |
c91b90c3 | 308 | |
c91b90c3 MW |
309 | (parse-message-item (sub-pset type name) |
310 | ;; message-item ::= | |
311 | ;; declspec+ declarator -!- (method-body | `;') | |
2cbdee3d MW |
312 | ;; |
313 | ;; Don't allow a method-body here if the message takes a | |
314 | ;; varargs list, because we don't have a name for the | |
315 | ;; `va_list' parameter. | |
316 | (let ((message (make-sod-message class name type | |
317 | sub-pset scanner))) | |
318 | (if (varargs-message-p message) | |
319 | (parse #\;) | |
320 | (parse (or #\; (parse-method-item sub-pset | |
321 | type nick name)))))) | |
c91b90c3 MW |
322 | |
323 | (parse-method-item (sub-pset type sub-nick name) | |
324 | ;; method-item ::= | |
325 | ;; declspec+ dotted-declarator -!- method-body | |
326 | ;; | |
327 | ;; method-body ::= `{' c-fragment `}' | `extern' `;' | |
328 | (parse (seq ((body (or (seq ("extern" #\;) nil) | |
329 | (parse-delimited-fragment | |
330 | scanner #\{ #\})))) | |
add6883c MW |
331 | (restart-case |
332 | (make-sod-method class sub-nick name type | |
333 | body sub-pset scanner) | |
334 | (continue () :report "Continue"))))) | |
c91b90c3 MW |
335 | |
336 | (parse-initializer () | |
a888e3ac | 337 | ;; initializer ::= `=' c-fragment |
c91b90c3 | 338 | ;; |
a888e3ac MW |
339 | ;; Return a VALUE, ready for passing to a `sod-initializer' |
340 | ;; constructor. | |
abfdb01c | 341 | (parse-delimited-fragment scanner #\= '(#\, #\;) |
a888e3ac | 342 | :keep-end t)) |
c91b90c3 MW |
343 | |
344 | (parse-slot-item (sub-pset base-type type name) | |
345 | ;; slot-item ::= | |
346 | ;; declspec+ declarator -!- [initializer] | |
ceed01af | 347 | ;; [`,' list[init-declarator]] `;' |
c91b90c3 | 348 | ;; |
ceed01af | 349 | ;; init-declarator ::= declarator [initializer] |
05d59b98 | 350 | (flet ((make-it (name type init) |
add6883c MW |
351 | (restart-case |
352 | (progn | |
353 | (make-sod-slot class name type | |
354 | sub-pset scanner) | |
355 | (when init | |
356 | (make-sod-instance-initializer class | |
357 | nick name | |
358 | init | |
359 | sub-pset | |
360 | scanner))) | |
361 | (continue () :report "Continue")))) | |
8152ead4 MW |
362 | (parse (and (error () |
363 | (seq ((init (? (parse-initializer)))) | |
364 | (make-it name type init)) | |
365 | (skip-until () #\, #\;)) | |
05d59b98 | 366 | (skip-many () |
8152ead4 MW |
367 | (error (:ignore-unconsumed t) |
368 | (seq (#\, | |
369 | (ds (parse-declarator scanner | |
370 | base-type)) | |
371 | (init (? (parse-initializer)))) | |
372 | (make-it (cdr ds) (car ds) init)) | |
373 | (skip-until () #\, #\;))) | |
374 | (must #\;))))) | |
c91b90c3 | 375 | |
b2983f35 | 376 | (parse-initializer-item (sub-pset must-init-p constructor) |
c91b90c3 | 377 | ;; initializer-item ::= |
ceed01af | 378 | ;; [`class'] -!- list[slot-initializer] `;' |
c91b90c3 | 379 | ;; |
b2983f35 | 380 | ;; slot-initializer ::= id `.' id [initializer] |
5445420e | 381 | (let ((parse-init (if must-init-p #'parse-initializer |
b2983f35 MW |
382 | (parser () (? (parse-initializer)))))) |
383 | (parse (and (skip-many () | |
8152ead4 MW |
384 | (error (:ignore-unconsumed t) |
385 | (seq ((name-a :id) #\. | |
386 | (name-b (must-id)) | |
387 | (init (funcall parse-init))) | |
388 | (restart-case | |
389 | (funcall constructor class | |
390 | name-a name-b init | |
391 | sub-pset scanner) | |
392 | (continue () :report "Continue"))) | |
393 | (skip-until () #\, #\;)) | |
b2983f35 | 394 | #\,) |
8152ead4 | 395 | (must #\;))))) |
c91b90c3 MW |
396 | |
397 | (class-item-dispatch (sub-pset base-type type name) | |
398 | ;; Logically part of `parse-raw-class-item', but the | |
399 | ;; indentation was getting crazy. We're currently at | |
400 | ;; | |
401 | ;; raw-class-item ::= | |
402 | ;; declspec+ (declarator | dotted-declarator) -!- ... | |
403 | ;; | other-items | |
404 | ;; | |
405 | ;; If the declarator is dotted then this must be a method | |
406 | ;; definition; otherwise it might be a message or slot. | |
407 | (cond ((not (typep type 'c-function-type)) | |
408 | (when (consp name) | |
65eebc3b | 409 | (cerror* |
a1985b3c | 410 | "Method declarations must have function type") |
c91b90c3 MW |
411 | (setf name (cdr name))) |
412 | (parse-slot-item sub-pset base-type type name)) | |
413 | ((consp name) | |
414 | (parse-method-item sub-pset type | |
415 | (car name) (cdr name))) | |
416 | (t | |
417 | (parse-message-item sub-pset type name)))) | |
418 | ||
419 | (parse-raw-class-item (sub-pset) | |
420 | ;; raw-class-item ::= | |
421 | ;; message-item | |
422 | ;; | method-item | |
423 | ;; | slot-item | |
424 | ;; | initializer-item | |
a42893dd | 425 | ;; | initfrag-item |
c91b90c3 MW |
426 | ;; |
427 | ;; Most of the above begin with declspecs and a declarator | |
428 | ;; (which might be dotted). So we parse that here and | |
429 | ;; dispatch based on what we find. | |
048d0b2d | 430 | (parse (or (plug class-item scanner class sub-pset) |
db2abd9d | 431 | (peek |
c91b90c3 MW |
432 | (seq ((ds (parse-c-type scanner)) |
433 | (dc (parse-maybe-dotted-declarator ds)) | |
65b1d9d7 | 434 | (nil (commit)) |
048d0b2d MW |
435 | (nil (class-item-dispatch sub-pset |
436 | ds | |
437 | (car dc) | |
db2abd9d | 438 | (cdr dc)))))) |
c91b90c3 | 439 | (and "class" |
5445420e | 440 | (parse-initializer-item sub-pset t |
c91b90c3 | 441 | #'make-sod-class-initializer)) |
5445420e | 442 | (parse-initializer-item sub-pset nil |
c91b90c3 MW |
443 | #'make-sod-instance-initializer))))) |
444 | ||
8152ead4 | 445 | (parse (seq ((nil (must #\{)) |
048d0b2d MW |
446 | (nil (skip-many () |
447 | (seq ((sub-pset (parse-property-set scanner)) | |
9ec578d9 | 448 | (nil (parse-raw-class-item sub-pset))) |
048d0b2d | 449 | (check-unused-properties sub-pset)))) |
8152ead4 | 450 | (nil (must #\}))) |
e45a106d MW |
451 | (unless (finalize-sod-class class) |
452 | (setf duff t)) | |
70b33a78 MW |
453 | (unless duff |
454 | (add-to-module *module* class)))))))) | |
048d0b2d MW |
455 | |
456 | (define-pluggable-parser module class (scanner pset) | |
ceed01af | 457 | ;; `class' id `:' list[id] class-body |
c91b90c3 | 458 | ;; `class' id `;' |
bf090e02 | 459 | (with-parser-context (token-scanner-context :scanner scanner) |
c91b90c3 | 460 | (parse (seq ("class" |
6362119e | 461 | (name (must :id)) |
c91b90c3 | 462 | (nil (or (seq (#\;) |
6362119e MW |
463 | (when name (make-class-type name))) |
464 | (seq ((supers (must (seq (#\: | |
465 | (ids (list () :id #\,))) | |
466 | ids))) | |
c91b90c3 MW |
467 | (nil (parse-class-body |
468 | scanner | |
469 | pset name supers))))))))))) | |
470 | ||
bf090e02 | 471 | ;;;----- That's all, folks -------------------------------------------------- |