Fix total pattern match verification
[scheme.git] / ast.scm
1 (load "utils.scm")
2
3 (define (ast-type x)
4   (define (builtin? x)
5     (case x
6       ('+ #t)
7       ('- #t)
8       ('* #t)
9       ('! #t)
10       ('= #t)
11       ('bool->int #t)
12       ('print #t)
13       (else #f)))
14   (cond
15    ((list? x)
16     (case (car x)
17       ('if 'if)
18       ('let 'let)
19       ('lambda 'lambda)
20       ('case 'case)
21       ('closure 'closure) ; only available in codegen
22       ('static-string 'static-string) ; only available in codegen
23       ('stack 'stack) ; only available in codegen (tag that value is passed via stack)
24       (else 'app)))
25    ((builtin? x) 'builtin)
26    ((symbol? x) 'var)
27    ((integer? x) 'int-literal)
28    ((string? x) 'string-literal)))
29
30 (define (ast-traverse f x)
31   (case (ast-type x)
32     ('let `(let ,(map (lambda (x) (list (car x) (f (cadr x))))
33                       (let-bindings x))
34              ,@(map f (let-body x))))
35     ('app (map f x))
36     ('lambda `(lambda ,(lambda-args x) ,(f (lambda-body x))))
37     ('if `(if ,@(map f (cdr x))))
38     ('case `(case ,(f (case-switch x))
39               ,@(map (lambda (x)
40                        (list (car x) (f (cadr x))))
41                      (case-cases x))))
42     ('stack `(stack ,(cadr x) ,(f (caddr x))))
43     (else x)))
44
45 (define (ast-collect f x)
46   (define (inner y) (ast-collect f y))
47   (case (ast-type x)
48     ['let (append (f x)
49                   (flat-map inner (let-bindings x))
50                   (flat-map inner (let-body x)))]
51     ['app (append (f x)
52                   (flat-map inner x))]
53     ['lambda (append (f x)
54                      (inner (lambda-body x)))]
55     ['if (append (f x)
56                  (flat-map inner (cdr x)))]
57     ['case (append (f x)
58                    (inner (case-switch x))
59                    (flat-map inner (map cadr (case-cases x))))]
60     ['stack (append (f x)
61                     (inner (caddr x)))]
62     [else (f x)]))
63
64 (define (ast-find p x)
65   (define (inner y) (ast-find p y))
66   
67   (case (ast-type x)
68     ['let (or (p x)
69               (any inner (let-bindings x))
70               (any inner (let-body x)))]
71     ['app (or (p x)
72               (any inner x))]
73     ['lambda (or (p x)
74                  (inner (lambda-body x)))]
75     ['if (or (p x) (any inner (cdr x)))]
76     ['case (or (p x)
77                (any inner (map cadr (case-cases x)))
78                (inner (case-switch x)))]
79     ['stack (or (p x) (inner (caddr x)))]
80     [else (p x)]))
81
82 (define let-bindings cadr)
83 (define let-body cddr)
84
85 (define case-switch cadr)
86 (define case-cases cddr)
87
88 (define (constructor? data-layouts x)
89   (and (eqv? (ast-type x) 'var)
90        (assoc x (flat-map cdr data-layouts))))
91
92 (define (all-cases data-layouts type)
93   (let ([sums (assoc type data-layouts)])
94     (if sums
95         (flat-map (lambda (sum)
96                     (let* ([sum-name (car sum)]
97                            [products (cdr sum)]
98                            [product-cases (map (lambda (y) (all-cases data-layouts y)) products)])
99                       (if (null? product-cases)
100                           (list sum-name) ; singletons aren't enclosed in a list [(foo x) 42] vs [foo 42]
101                           (apply combinations (cons (list sum-name) product-cases)))))
102                   (cdr sums))
103         '(:binding))))
104
105                                         ; does a cover b
106 (define (case-covers? data-layouts a b)
107   (let ([a-binding? (and (eqv? (ast-type a) 'var) (not (constructor? data-layouts a)))])
108     (cond
109      [(eqv? ':binding b) a-binding?]
110      [a-binding? #t]
111                                         ; a literal/singleton
112      [(eqv? (ast-type b) 'var) (eqv? b a)]
113                                         ; two different constructors
114      [(not (eqv? (car a) (car b))) #f]
115                                         ; two same constructors
116      [else
117       (all (map (lambda (p q)
118                   (case-covers? data-layouts p q))
119                 (cdr a) (cdr b)))])))
120
121 (define (verify-cases data-layouts annotated-program)
122
123   ;; (define (check-pattern switch-type pat)
124
125   ;;   (define (impossible-match)
126   ;;     (error "Can't pattern match ~a with ~a" switch-type (ann-expr pat)))
127
128   ;;   (if (assoc switch-type data-layouts)
129   ;;    (begin
130   ;;      (let ([sums (cdr (assoc switch-type data-layouts))])
131   ;;        (unless (eqv? (ast-type (ann-expr pat)) 'var) (impossible-match))
132   ;;        (unless (assoc (car (ann-expr pat)) sums) (impossible-match))
133   ;;        (unless 
134   ;;      )
135   ;;      (begin
136   ;;     (unless (assoc switch-type allowed-match-ast-types)
137   ;;       (error #f "Can't pattern match on ~a" switch-type))
138          
139   ;;     (let ([allowed (cdr (assoc switch-type allowed-match-ast-types))])
140   ;;       (unless (assoc (ast-type (ann-expr pat)) allowed) (impossible-match)))))))
141
142   
143   (let ([expr (ann-expr annotated-program)])
144     (case (ast-type expr)
145       ['case
146           (let* ([switch-type (ann-type (case-switch expr))]
147                  [cases (map car (case-cases expr))]
148                  [case-covered?
149                   (lambda (x) (any (lambda (y) (case-covers? data-layouts y x)) cases))])
150             (unless (all (map case-covered? (all-cases data-layouts switch-type)))
151               (error #f "not all cases covered")))]
152       [else (ast-traverse (lambda (x) (verify-cases data-layouts x)) expr)])))
153
154
155                                         ; (let ([(foo a b) (foo 123 345)]) a)
156                                         ;   |
157                                         ;   v
158                                         ; (let ([a (foo~0 (foo 123 345)]
159                                         ;       [b (foo~1 (foo 123 345)]) a)
160 (define (expand-pattern-matches program)
161   (define (go x)
162     (define (let-pattern-match binding)
163       (let ([binding-name (car binding)]
164             [body (cadr binding)])
165         (if (eqv? (ast-type binding-name) 'var)
166             (list (list binding-name body))
167             
168             (let* ([sum-name (car binding-name)]
169                    [destructor (lambda (i) (dtor-name sum-name i))]
170                    [products (cdr binding-name)]
171
172                    [data-layouts (program-data-layouts program)]
173
174                    [type (data-tor-type data-layouts sum-name)]
175
176                    [sums (cdr (assoc type data-layouts))]
177                    [sum (assoc sum-name sums)]
178                    
179                    [expected-number (length (cdr sum))])
180
181                                         ; assert that we only do a let pattern match on an ADT with exactly one sum
182               (when (not (= 1 (length sums)))
183                 (error #f (format "Cannot pattern match a ~a in a let since it has ~a possible constructors"
184                                   type
185                                   (length sums))))
186
187                                         ; assert that there is the correct number of bindings
188               (when (not (= (length products)
189                             expected-number))
190                 (error #f (format "Got ~a bindings: expected ~a for ~a"
191                                (length products)
192                                expected-number
193                                binding)))
194               
195               (flat-map (lambda (y i)
196                           (let-pattern-match (list y `(,(destructor i) ,body))))
197                         products
198                         (range 0 (length products)))))))
199
200     (case (ast-type x)
201       ['let `(let ,(flat-map let-pattern-match (let-bindings x))
202                ,@(map go (let-body x)))]
203       [else (ast-traverse go x)]))
204   (program-map-exprs go program))
205
206 (define (lambda? x)
207   (and (list? x) (eq? (car x) 'lambda)))
208
209 (define (statement-type x)
210   (cond
211    [(and (list? x)
212          (eqv? (car x) 'data)) 'data]
213    [(and (list? x)
214          (eqv? (car x) 'define)) 'define]
215    [else 'expr]))
216
217
218                                         ; (A ((foo (Int Bool))
219                                         ;     (bar (Bool)))
220 (define (program-data-layouts program)
221   (map (lambda (x) (cons (car x) (cdr x))) ; convert to assoc list
222        (map cdr (filter (lambda (x) (eqv? (statement-type x) 'data))
223                         program))))
224
225 (define (program-defines program)
226   (filter (lambda (x) (eqv? (statement-type x) 'defines))
227           program))
228
229 (define (program-map-exprs f program)
230   (map (lambda (x)
231          (case (statement-type x)
232            ['expr (f x)]
233            [else x]))
234        program))
235
236 (define (program-body program)
237   ; hack to have multi-expression bodies
238   `(let ()
239      ,@(filter (lambda (x) (eqv? (statement-type x) 'expr))
240                program)))
241
242 (define (data-tor-type data-layouts tor)
243   (let* ([tors (flat-map data-tors data-layouts)]
244          [info (cadr (assoc tor tors))])
245     (car info)))
246
247                                         ; a data tor is either a constructor or destructor for an ADT
248                                         ; data-tors returns constructors and destructors for a data-layout
249                                         ; (data A (foo Int Bool)
250                                         ;         (bar Bool))
251                                         ;        |
252                                         ;        v
253                                         ; (foo   . ((A foo constructor) . (abs Int (abs Bool A))))
254                                         ; (foo~0 . ((A foo 0 Int)       . (abs A Int)))
255                                         ; (foo~1 . ((A foo 1 Bool)      . (abs A Bool)))
256                                         ; (bar   . ((A bar constructor) . (abs Bool A)))
257                                         ; (bar~0 . ((A bar 0 Bool)      . (abs A Bool)))
258                                         ;  ------+-------------------------------------
259                                         ;  tor   | info                 | type
260
261 (define (data-tors data-layout)
262   (define (constructor-type t products)
263     (fold-right (lambda (x acc) `(abs ,x ,acc)) t products))
264
265   (define (destructor ctor-name prod-type part-type index)
266     (let* ([name (dtor-name ctor-name index)]
267            [info (list prod-type ctor-name index part-type)])
268       (cons name (cons info `(abs ,prod-type ,part-type)))))
269   
270   (let ([type-name (car data-layout)]
271         [ctors (cdr data-layout)])
272     (fold-right
273      (lambda (ctor acc)       
274        (let* ([ctor-name (car ctor)]
275               [products (cdr ctor)]
276               
277               [maker (cons ctor-name (cons (list type-name ctor-name 'constructor) (constructor-type type-name products)))]
278               
279               [dtors (map (lambda (t i) (destructor ctor-name type-name t i))
280                           products
281                           (range 0 (length products)))])
282          (cons maker (append dtors acc))))
283      '()
284      ctors)))
285
286                                         ; creates a type environment for a given adt definition
287 (define (data-tors-type-env data-layout)
288   (map (lambda (x) (cons (car x) (cddr x))) (data-tors data-layout)))
289
290 (define (dtor-name ctor-name index)
291   (string->symbol
292    (string-append (symbol->string ctor-name)
293                   "~"
294                   (number->string index))))
295
296 ; for use in normalized form
297 (define lambda-arg caadr)
298 ; for use elsewhere
299 (define lambda-args cadr)
300 (define lambda-body caddr)
301
302 (define (references prog)
303   (ast-collect
304    (lambda (x)
305      (case (ast-type x)
306        ['var (list x)]
307        [else '()]))
308    prog))
309
310 (define (graph bs)
311   (define (go bs orig-bs)
312     (if (null? bs)
313         '(() . ())
314         (let* [(bind (car bs))
315
316                (vert (car bind))
317                (refs (filter ; only count a reference if its a binding
318                       (lambda (x) (assoc x orig-bs))
319                       (references (cdr bind))))
320                (edges (map (lambda (x) (cons vert x))
321                            refs))
322
323                (rest (if (null? (cdr bs))
324                          (cons '() '())
325                          (go (cdr bs) orig-bs)))
326                (total-verts (cons vert (car rest)))
327                (total-edges (append edges (cdr rest)))]
328           (cons total-verts total-edges))))
329   (go bs bs))
330
331 (define (successors graph v)
332   (define (go v E)
333     (if (null? E)
334         '()
335         (if (eqv? v (caar E))
336             (cons (cdar E) (go v (cdr E)))
337             (go v (cdr E)))))
338   (go v (cdr graph)))
339
340                                         ; takes in a graph (pair of vertices, edges)
341                                         ; returns a list of strongly connected components
342
343                                         ; ((x y w) . ((x . y) (x . w) (w . x))
344
345                                         ; =>
346                                         ; .->x->y
347                                         ; |  |
348                                         ; |  v
349                                         ; .--w
350
351                                         ; ((x w) (y))
352
353                                         ; this uses tarjan's algorithm, to get reverse
354                                         ; topological sorting for free
355 (define (sccs graph)
356   
357   (let* ([indices (make-hash-table)]
358          [lowlinks (make-hash-table)]
359          [on-stack (make-hash-table)]
360          [current 0]
361          [stack '()]
362          [result '()])
363
364     (define (index v)
365       (get-hash-table indices v #f))
366     (define (lowlink v)
367       (get-hash-table lowlinks v #f))
368
369     (letrec
370         ([strong-connect
371           (lambda (v)
372             (begin
373               (put-hash-table! indices v current)
374               (put-hash-table! lowlinks v current)
375               (set! current (+ current 1))
376               (push! stack v)
377               (put-hash-table! on-stack v #t)
378
379               (for-each
380                (lambda (w)
381                  (if (not (hashtable-contains? indices w))
382                                         ; successor w has not been visited, recurse
383                      (begin
384                        (strong-connect w)
385                        (put-hash-table! lowlinks
386                                         v
387                                         (min (lowlink v) (lowlink w))))
388                                         ; successor w has been visited
389                      (when (get-hash-table on-stack w #f)
390                        (put-hash-table! lowlinks v (min (lowlink v) (index w))))))
391                (successors graph v))
392
393               (when (= (index v) (lowlink v))
394                 (let ([scc
395                        (let new-scc ()
396                          (let ([w (pop! stack)])
397                            (put-hash-table! on-stack w #f)
398                            (if (eqv? w v)
399                                (list w)
400                                (cons w (new-scc)))))])
401                   (set! result (cons scc result))))))])
402       (for-each
403        (lambda (v)
404          (when (not (hashtable-contains? indices v)) ; v.index == -1
405            (strong-connect v)))
406        (car graph)))
407     result))