racket/collects/stepper/private/annotate.ss
John Clements dd89364c2d ...
svn: r2558
2006-03-31 20:00:14 +00:00

1155 lines
66 KiB
Scheme

(module annotate mzscheme
(require (prefix kernel: (lib "kerncase.ss" "syntax"))
(lib "contract.ss")
(lib "list.ss")
(lib "etc.ss")
(lib "match.ss")
"marks.ss"
"shared.ss"
"my-macros.ss"
"xml-box.ss"
(prefix beginner-defined: "beginner-defined.ss"))
(define-syntax (where stx)
(syntax-case stx ()
[(_ body bindings)
(syntax/loc stx (letrec bindings body))]))
; CONTRACTS
; PROVIDE
(provide/contract
[annotate
(-> syntax? ; syntax to annotate
(opt->* ((or/c continuation-mark-set? false/c)
break-kind?)
(list?)
(any/c)) ; procedure for runtime break
boolean? ; track-inferred-name?
string? ; language-level-name : not a nice way to abstract.
syntax?)] ; results
#;[top-level-rewrite (-> syntax? syntax?)])
; ;; ;;;; ;
; ; ; ; ; ;
; ; ; ; ; ;;; ; ;;; ;;; ; ;;;;;; ; ; ; ; ;; ;;; ;;;; ; ;;; ; ;; ;;;
; ; ; ; ;; ; ;; ; ; ; ;; ; ; ; ; ;; ; ; ; ; ; ; ;; ; ;
; ;; ; ; ; ; ; ; ; ; ; ; ;;;; ; ; ; ; ; ; ; ; ; ; ; ;
; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;;
; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;
; ; ; ; ;; ;; ; ;; ; ; ; ; ; ; ; ;; ; ; ; ; ; ; ; ; ; ;
; ;; ;; ; ; ;;; ; ;;; ;;; ; ;; ; ;; ; ; ; ;;; ;; ; ;;; ; ; ;;;
; ; ;
; ; ;
;
; wrap-struct-form
; (define (wrap-struct-form names annotated)
; (let* ([arg-temps (build-list (length names) get-arg-var)]
; [struct-proc-names (cdr names)]
; [closure-records (map (lambda (proc-name) (make-closure-record
; proc-name
; (lambda () #f)
; (eq? proc-name (car struct-proc-names))
; #f))
; struct-proc-names)]
; [proc-arg-temp-syms (cdr arg-temp-syms)]
; [setters (map (lambda (arg-temp-sym closure-record)
; `(,closure-table-put! ,arg-temp-sym ,closure-record))
; proc-arg-temp-syms
; closure-records)]
; [full-body (append setters (list `(values ,@arg-temp-syms)))])
; `(#%let-values ((,arg-temp-syms ,annotated)) ,@full-body)))
; test exps:
; (andmap (lambda (arg-list)
; (let* ([stx (car arg-list)]
; [elaborated (cadr arg-list)]
; [eval-result (caddr arg-list)]
; [collapsed (collapse-let-values (expand stx))])
; (printf "~a~n~a~n~a~n~a~n" (syntax-object->datum collapsed)
; elaborated
; (eval collapsed)
; eval-result)
; (and (equal? (syntax-object->datum collapsed) elaborated)
; (equal? (eval collapsed) eval-result))))
; (list (list #'(let ([a 3] [b 9]) (+ a b)) '(let-values ([(a) (#%datum . 3)] [(b) (#%datum . 9)]) (#%app (#%top . +) a b)) 12)
; (list #'(let* ([a 9] [b a] [c b]) c) '(let*-values ([(a) (#%datum . 9)] [(b) a] [(c) b]) c) 9)
; (list #'(let ([a 3] [b 9]) (let ([b 14]) b)) '(let*-values ([(a) (#%datum . 3)] [(b) (#%datum . 9)] [(b) (#%datum . 14)]) b) 14)))
;
; ; ; ; ;
; ; ; ; ;
; ;;;; ;;; ; ;;; ; ;;; ; ; ;;; ; ; ;; ;;; ; ; ; ; ;; ; ;;;; ;;;
; ; ; ; ;; ; ; ; ; ; ; ; ; ; ;; ; ; ; ; ; ;; ; ; ; ;
; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;
; ; ; ; ; ; ;;;;; ; ;;;;; ; ; ;;;;; ; ; ;;;;; ; ; ; ; ; ; ; ;;;;;
; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;
; ; ; ; ;; ; ; ; ;; ; ; ; ; ; ; ; ; ; ; ; ;
; ;; ;;; ; ;;; ; ;;;; ; ;;;; ; ; ;;;; ; ; ; ; ;; ;;;;
; ;
; ;
;
; top-level-rewrite : (SYNTAX-OBJECT -> SYNTAX-OBJECT)
; top-level-rewrite performs several tasks; it labels variables with their types (let-bound, lambda-bound, or non-lexical),
; it flags if's which could come from cond's, it labels the begins in conds with 'stepper-skip annotations
; label-var-types returns a syntax object which is identical to the original except that the variable references are labeled
; with the syntax-property 'stepper-binding-type, which is set to either let-bound, lambda-bound, or non-lexical.
(define (top-level-rewrite stx)
(let loop ([stx stx]
[let-bound-bindings null]
[cond-test (lx #f)])
(if (or (syntax-property stx 'stepper-skip-completely)
(syntax-property stx 'stepper-define-struct-hint))
stx
(let* ([recur-regular
(lambda (stx)
(loop stx let-bound-bindings (lx #f)))]
[recur-with-bindings
(lambda (exp vars)
(loop exp (append vars let-bound-bindings) (lx #f)))]
[recur-in-cond
(lambda (stx new-cond-test)
(loop stx let-bound-bindings new-cond-test))]
[do-let/rec
(lambda (stx rec?)
(with-syntax ([(label ((vars rhs) ...) . bodies) stx])
(let* ([vars-list (apply append (map syntax->list (syntax->list (syntax (vars ...)))))]
[labelled-vars-list (map (lambda (var-list) (map (lambda (exp) (recur-with-bindings exp vars-list))
(syntax->list var-list)))
(syntax->list (syntax (vars ...))))]
[rhs-list (if rec?
(map (lambda (exp) (recur-with-bindings exp vars-list)) (syntax->list #'(rhs ...)))
(map recur-regular (syntax->list #'(rhs ...))))]
[new-bodies (map (lambda (exp) (recur-with-bindings exp vars-list)) (syntax->list #'bodies))]
[new-bindings (map list labelled-vars-list rhs-list)])
(datum->syntax-object stx `(,#'label ,new-bindings ,@new-bodies) stx stx))))]
; evaluated at runtime, using 3D code:
[put-into-xml-table (lambda (val)
(hash-table-put! finished-xml-box-table val #t)
val)]
[rewritten
(kernel:kernel-syntax-case stx #f
; cond :
[(if test (begin then) else-stx)
(let ([origin (syntax-property stx 'origin)]
[rebuild-if
(lambda (new-cond-test)
(let* ([new-then (recur-regular (syntax then))]
[rebuilt (syntax-property
(rebuild-stx `(if ,(recur-regular (syntax test))
,new-then
,(recur-in-cond (syntax else-stx) new-cond-test))
stx)
'stepper-hint
'comes-from-cond)])
; move the stepper-else mark to the if, if it's present:
(if (syntax-property (syntax test) 'stepper-else)
(syntax-property rebuilt 'stepper-else #t)
rebuilt)))])
(cond [(cond-test stx) ; continuing an existing 'cond'
(rebuild-if cond-test)]
[(and origin (pair? origin) (eq? (syntax-e (car origin)) 'cond)) ; starting a new 'cond'
(rebuild-if (lambda (test-stx)
(and (eq? (syntax-source stx) (syntax-source test-stx))
(eq? (syntax-position stx) (syntax-position test-stx)))))]
[else ; not from a 'cond' at all.
(rebuild-stx `(if ,@(map recur-regular (list (syntax test) (syntax (begin then)) (syntax else-stx)))) stx)]))]
[(begin body) ; else clauses of conds; ALWAYS AN ERROR CALL
(cond-test stx)
(syntax-property stx 'stepper-skip-completely #t)]
; wrapper on a local. This is necessary because teach.ss expands local into a trivial let wrapping a bunch of
; internal defines, and therefore the letrec-values on which I want to hang the 'stepper-hint doesn't yet
; exist. So we patch it up after expansion. And we discard the outer 'let' at the same time.
[(let-values () expansion-of-local)
(eq? (syntax-property stx 'stepper-hint) 'comes-from-local)
(syntax-case #`expansion-of-local (letrec-values)
[(letrec-values (bogus-clause clause ...) . bodies)
(recur-regular
(syntax-property #`(letrec-values (clause ...) . bodies) 'stepper-hint 'comes-from-local))]
[else (error 'top-level-rewrite "expected a letrec-values inside a local, given: ~e"
(syntax-object->datum #`expansion-of-local))])]
; let/letrec :
[(let-values x ...) (do-let/rec stx #f)]
[(letrec-values x ...) (do-let/rec stx #t)]
; varref :
[var
(identifier? (syntax var))
(syntax-property
(syntax var)
'stepper-binding-type
(if (eq? (identifier-binding (syntax var)) 'lexical)
(cond [(ormap (lx (bound-identifier=? _ (syntax var))) let-bound-bindings)
'let-bound]
[else
'lambda-bound])
'non-lexical))]
[else
(let ([content (syntax-e stx)])
(if (pair? content)
(rebuild-stx (syntax-pair-map content recur-regular) stx)
stx))])])
(if (eq? (syntax-property stx 'stepper-xml-hint) 'from-xml-box)
(syntax-property #`(#,put-into-xml-table #,rewritten)
'stepper-skipto
(list syntax-e cdr car))
(syntax-recertify rewritten stx (current-code-inspector) #f))))))
;
; ; ; ;
; ; ; ;; ; ;; ;;; ;;;; ;;; ;;;; ;;;
; ; ;; ; ;; ; ; ; ; ; ; ; ; ;
; ; ; ; ; ; ; ; ; ; ; ; ;
;;;;; ; ; ; ; ; ; ; ;;;; ; ;;;;;
; ; ; ; ; ; ; ; ; ; ; ; ;
; ; ; ; ; ; ; ; ; ; ; ; ;
; ; ; ; ; ; ;;; ;; ;;;;; ;; ;;;;
; oh-say-can-you-see,by-the-dawn's-early-light,what-so-proudly-we-hailed,at-the-twilight's-last-gle
; a m i n g . W h o s e b r o a d s t r i p
; pe s a n d b r i g h t s t a r s , t hrough-the-perilous-night,o'er-the-ramparts-we-watched,were-
; s o g a l l a n t l y s t r e a m i n g .
; an d t h e r o c k e t ' s r e d g l are,the-bombs-bursting-in-air,gave-proof-through-the-night,,
; t h a t o u r f l a g w a s s t i l l t h
; er e . O h s a y , d o e s t h a t s tar-spangled-banner-yet-wave,o'er-the-land-of-the-free,and-t
; h e h o m e o f t h e b r a v e ? . . . .
; .. . . . . . . . . . . . . . . . . . ............................................................
; . . . . . . . . . . . . . . . . . . . . .
; .................................................................................................
; . .
; .................................................................................................
; . .
; .................................................................................................
; . .
; .................................................................................................
; . .
; .................................................................................................
; . .
; .................................................................................................
; . .
; .................................................................................................
; . .
; .................................................................................................
;
; annotate takes
; a) a list of syntax expressions
; b) a break routine to be called at breakpoints, and
; c) a boolean indicating whether to store inferred names.
;
(define (annotate main-exp break track-inferred-names? language-level-name)
#;(define _ (fprintf (current-error-port) "input to annotate: ~v\n" (syntax-object->datum main-exp)))
(define binding-indexer
(let ([binding-index 0])
(lambda ()
(let ([temp binding-index])
(set! binding-index (+ binding-index 1))
temp))))
(define (normal-break)
(break (current-continuation-marks) 'normal-break))
(define (result-exp-break)
(break (current-continuation-marks) 'result-exp-break))
(define (result-value-break vals-list)
(break (current-continuation-marks) 'result-value-break vals-list))
(define (normal-break/values vals-list)
(break (current-continuation-marks) 'normal-break/values vals-list))
(define (exp-finished-break info-list)
(break #f 'expr-finished-break info-list))
(define (double-break)
(break (current-continuation-marks) 'double-break))
; wcm-pre-break-wrap : call wcm-wrap with a pre-break on the expr
(define (wcm-pre-break-wrap debug-info exp)
(wcm-wrap debug-info (pre-break-wrap exp)))
;; wrap a pre-break around stx
(define (pre-break-wrap stx)
#`(begin (#,result-exp-break) #,stx))
;; wrap a normal break around stx
(define (break-wrap exp)
#`(begin (#,normal-break) #,exp))
;; wrap a double-break around exp
(define (double-break-wrap exp)
#`(begin (#,double-break) #,exp))
;; abstraction used in the next two defs
(define (return-value-wrap-maker break-proc)
(lambda (exp)
#`(call-with-values
(lambda () #,exp)
(lambda args
(#,break-proc args)
(apply values args)))))
;; wrap a return-value-break around exp
(define return-value-wrap
(return-value-wrap-maker result-value-break))
;; wrap a normal-break/values around exp
(define normal-break/values-wrap
(return-value-wrap-maker normal-break/values))
(define (make-define-struct-break exp)
(lambda ()
(break #f 'expr-finished-break (list (list (lambda () exp)
#f
(lambda () (error 'make-define-struct-break
"no getter for a define-struct")))))))
(define (top-level-annotate/inner exp source-exp defined-name)
(let*-2vals ([(annotated dont-care)
(annotate/inner exp 'all #f defined-name #f)])
#`(with-continuation-mark #,debug-key
#,(make-top-level-mark source-exp)
;; inserting eta-expansion to prevent destruction of top-level mark
(call-with-values (lambda () #,annotated)
(lambda args (apply values args))))))
; annotate/inner takes
; a) an expression to annotate
; b) a list of all bindings which this expression is tail w.r.t.
; or 'all to indicate that this expression is tail w.r.t. _all_ bindings.
; d) a boolean indicating whether this expression will be the r.h.s. of a reduction
; (and therefore should be broken before)
; g) information about the binding name of the given expression. This is used
; to associate a name with a closure mark (though this may now be redundant)
; it returns (as a 2vals)
; a) an annotated s-expression
; b) a list of varrefs for the variables which occur free in the expression
;
;(syntax-object BINDING-SET bool bool (or/c #f symbol (list binding symbol)) ->
; sexp (list-of z:varref))
; ;
; ; ;
;;; ; ;; ; ;; ;;; ;;;; ;;; ;;;; ;;; ; ; ; ;; ; ;; ;;; ; ;;
; ; ;; ; ;; ; ; ; ; ; ; ; ; ; ; ; ;; ; ;; ; ; ; ;;
; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;
;;;; ; ; ; ; ; ; ; ;;;; ; ;;;;; ; ; ; ; ; ; ;;;;; ;
; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;
; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ; ;
;;;;; ; ; ; ; ;;; ;; ;;;;; ;; ;;;; ; ; ; ; ; ; ;;;; ;
;
;
(define annotate/inner
#;(syntax? binding-set? boolean? (or/c false/c syntax? (list/p syntax? syntax?)) (or/c false/c integer?)
. -> . (vector/p syntax? binding-set?))
(lambda (exp tail-bound pre-break? procedure-name-info offset-counter)
(cond [(syntax-property exp 'stepper-skipto)
(let* ([free-vars-captured #f] ; this will be set!'ed
;[dont-care (printf "expr: ~a\nskipto: ~a\n" expr (syntax-property expr 'stepper-skipto))]
; WARNING! I depend on the order of evaluation in application arguments here:
[annotated (skipto-annotate
(syntax-property exp 'stepper-skipto)
exp
(lambda (subterm)
(let*-2vals ([(stx free-vars) (annotate/inner subterm tail-bound pre-break? procedure-name-info offset-counter)])
(set! free-vars-captured free-vars)
stx)))])
(2vals (wcm-wrap
skipto-mark
annotated)
free-vars-captured))]
[(syntax-property exp 'stepper-skip-completely)
(2vals (wcm-wrap 13 exp) null)]
[else
(let*
;; recurrence procedures, used to recur on sub-expressions:
([tail-recur (lambda (exp) (annotate/inner exp tail-bound #t procedure-name-info #f))]
[non-tail-recur (lambda (exp) (annotate/inner exp null #f #f #f))]
[result-recur (lambda (exp) (annotate/inner exp null #f procedure-name-info #f))]
[set!-rhs-recur (lambda (exp name) (annotate/inner exp null #f name #f))]
[let-rhs-recur (lambda (exp binding-names dyn-index-syms)
(let* ([proc-name-info
(if (not (null? binding-names))
(list (car binding-names) (car dyn-index-syms))
#f)])
(annotate/inner exp null #f proc-name-info #f)))]
[lambda-body-recur (lambda (exp) (annotate/inner exp 'all #t #f #f))]
; let bodies have a startling number of recurrence patterns. ouch!
;; no pre-break, tail w.r.t. new bindings:
[let-body-recur/single
(lambda (exp bindings)
(annotate/inner exp (binding-set-union (list tail-bound bindings)) #f procedure-name-info #f))]
;; no pre-break, non-tail w.r.t. new bindings
[let-body-recur/first
(lambda (exp-n-index)
(apply-to-first-of-2vals
normal-break/values-wrap
(annotate/inner (car exp-n-index) null #f #f (cadr exp-n-index))))]
;; yes pre-break, non-tail w.r.t. new bindings
[let-body-recur/middle
(lambda (exp-n-index)
(apply-to-first-of-2vals
normal-break/values-wrap
(annotate/inner (car exp-n-index) null #t #f (cadr exp-n-index))))]
;; yes pre-break, tail w.r.t. new bindings:
[let-body-recur/last
(lambda (exp-n-index bindings)
(annotate/inner (car exp-n-index) (binding-set-union (list tail-bound bindings)) #t procedure-name-info (cadr exp-n-index)))]
;; different flavors of make-debug-info allow users to provide only the needed fields:
[make-debug-info-normal (lambda (free-bindings)
(make-debug-info exp tail-bound free-bindings 'none #t offset-counter))]
[make-debug-info-app (lambda (tail-bound free-bindings label)
(make-debug-info exp tail-bound free-bindings label #t offset-counter))]
[make-debug-info-let (lambda (free-bindings binding-list let-counter)
(make-debug-info exp
(binding-set-union (list tail-bound
binding-list
(list let-counter)))
(varref-set-union (list free-bindings
binding-list
(list let-counter))) ; NB using bindings as varrefs
'let-body
#t
offset-counter))]
[outer-wcm-wrap (if pre-break?
wcm-pre-break-wrap
wcm-wrap)]
[wcm-break-wrap (lambda (debug-info exp)
(outer-wcm-wrap debug-info (break-wrap exp)))]
[normal-bundle
(lambda (free-vars annotated)
(2vals (outer-wcm-wrap (make-debug-info-normal free-vars)
annotated)
free-vars))]
;; taken from SRFI 1:
[iota
(lambda (n) (build-list n (lambda (x) x)))]
[with-indices
(lambda (exps)
(map list exps (iota (length exps))))]
; @@ @@ @@
; @ @ @
; @ $@$: @@+-$: @-@$ $@:@ $@$:
; @ -@ @+@$@ @+ *$ $* *@ -@
; @ -$@$@ @ @ @ @ @ @ @ -$@$@
; @ $* @ @ @ @ @ @ @ @ $* @
; @ @- *@ @ @ @ @ +$ $* *@ @- *@
; @@@@@ -$$-@@@@@@@@@@@+@$ $@:@@ -$$-@@
;
[lambda-clause-abstraction
(lambda (clause)
(with-syntax ([(args-stx . bodies) clause])
(let*-2vals ([(annotated-body free-varrefs)
; wrap bodies in explicit begin if more than 1 user-introduced (non-skipped) bodies
; NB: CAN'T HAPPEN in beginner up through int/lambda
(if (> (length (filter (lambda (clause)
(not (syntax-property clause 'stepper-skip-completely)))
(syntax->list (syntax bodies)))) 1)
(lambda-body-recur (syntax (begin . bodies)))
(let*-2vals ([(annotated-bodies free-var-sets)
(2vals-map lambda-body-recur (syntax->list #`bodies))])
(2vals #`(begin . #,annotated-bodies) (varref-set-union free-var-sets))))]
[new-free-varrefs (varref-set-remove-bindings free-varrefs
(arglist-flatten #'args-stx))])
(2vals (datum->syntax-object #'here `(,#'args-stx ,annotated-body) #'clause) new-free-varrefs))))]
[outer-lambda-abstraction
(lambda (annotated-lambda free-varrefs)
(let*-2vals
([closure-info (make-debug-info-app 'all free-varrefs 'none)]
[closure-name (if track-inferred-names?
(cond [(syntax? procedure-name-info) procedure-name-info]
[(pair? procedure-name-info) (car procedure-name-info)]
[else #f])
#f)]
[closure-storing-proc
(opt-lambda (closure debug-info [lifted-index #f])
(closure-table-put! closure (make-closure-record
closure-name
debug-info
#f
lifted-index))
closure)]
[inferred-name-lambda
(if closure-name
(syntax-property annotated-lambda 'inferred-name (syntax-e closure-name))
annotated-lambda)]
[captured
(cond [(pair? procedure-name-info)
#`(#,closure-storing-proc #,inferred-name-lambda #,closure-info
#,(cadr procedure-name-info))]
[else
#`(#,closure-storing-proc #,inferred-name-lambda #,closure-info)])])
(normal-bundle free-varrefs captured)))]
; @@
; @ @
; @ -@@$ @@@@@
; @ $ -$ @
; @ @@@@@ @
; @ $ @
; @ +: @: :$
; @@@@@ $@@+ :@@$-
; The let transformation is complicated.
; here's a sample transformation (not including 'break's):
;(let-values ([(a b c) e1] [(d e) e2]) e3)
;
;turns into
;
;(let ([counter (<dynamic-counter-call>)])
;(let-values ([(a b c d e lifter-a-1 lifter-b-2 lifter-c-3 lifter-d-4 lifter-e-5 let-counter)
; (values *unevaluated* *unevaluated* *unevaluated* *unevaluated* *unevaluated*
; counter counter counter counter counter 0)])
; (with-continuation-mark
; key huge-value
; (begin
; (set!-values (a b c) e1)
; (set! let-counter 1)
; (set!-values (d e) e2)
; (set! let-counter 2)
; e3))))
;
; note that this elaboration looks exactly like the one for letrec, and that's
; okay, becuase expand guarantees that reordering them will not cause capture.
; this is because a bound variable answers is considered bound by a binding only when
; the pair answers true to bound-identifier=?, which is determined during (the first)
; expand.
; another irritating point: the mark and the break that must go immediately
; around the body. Irritating because they will be instantly replaced by
; the mark and the break produced by the annotated body itself. However,
; they're necessary, because the body may not contain free references to
; all of the variables defined in the let, and thus their values are not
; known otherwise.
; whoops! hold the phone. I think I can get away with a break before, and
; a mark after, so only one of each. groovy, eh?
; 2005-08: note that the set!-based approach on the let-counter is broken in the presence of
; continuations; backing up a computation using a set! will not revert the
; counter, and the stepper may think that the computation is in a different
; place. To fix this, we must go to a pure let* with nested marks at each right-hand-side.
; 2006-01: oh dear heaven. Begin expands into a let-values. This means that the
; let-values really has most of the complexity of the whole stepper, all in one
; place. Re-formulating the bodies as a begin and re-calling annotate/inner broke
; implied invariants (in particular, that annotate/inner was only called on subexprs)
; and confused the heck out of me for some time today. Bleah. I'm just going to
; do the whole expansion here. Also, I'm going to make this expansion call/cc-clean,
; because I think it'll actually be easier to state & read this way.
[let-abstraction
(lambda (stx output-identifier make-init-list)
(with-syntax ([(_ ([(var ...) val] ...) . bodies) stx])
(let*-2vals
([binding-sets (map syntax->list (syntax->list #'((var ...) ...)))]
[binding-list (apply append binding-sets)]
[vals (syntax->list #'(val ...))]
[lifted-var-sets (map (lx (map get-lifted-var _)) binding-sets)]
[lifted-vars (apply append lifted-var-sets)]
[(annotated-vals free-varref-sets-vals)
(2vals-map let-rhs-recur vals binding-sets lifted-var-sets)]
[bodies-list (with-indices (syntax->list #'bodies))]
[(annotated-body free-varrefs-body)
(if (= (length bodies-list) 1)
(let-body-recur/single (caar bodies-list) binding-list)
;; like a map, but must special-case first and last exps:
(let*-2vals
([first (car bodies-list)]
[reversed-rest (reverse (cdr bodies-list))]
[middle (reverse (cdr reversed-rest))]
[last (car reversed-rest)]
[(first* fv-first) (let-body-recur/first first)]
[(middle* fv-middle) (2vals-map let-body-recur/middle middle)]
[(last* fv-last) (let-body-recur/last last binding-list)])
(2vals (quasisyntax/loc exp
(begin #,first* #,@middle* #,last*))
(varref-set-union (cons fv-first (cons fv-last fv-middle))))))])
((2vals (quasisyntax/loc
exp
(let ([#,counter-id (#,binding-indexer)])
(#,output-identifier #,outer-initialization #,wrapped-begin)))
free-varrefs)
. where .
([free-varrefs (varref-set-remove-bindings
(varref-set-union (cons free-varrefs-body
free-varref-sets-vals))
binding-list)]
[counter-id #`lifting-counter]
[unevaluated-list (make-init-list binding-list)]
[outer-initialization
#`([(#,@lifted-vars #,@binding-list #,let-counter)
(values #,@(append (map (lambda (dc_binding) counter-id)
binding-list)
unevaluated-list
(list 0)))])]
[counter-clauses (build-list
(length binding-sets)
(lambda (num)
#`(set! #,let-counter #,(+ num 1))))]
[set!-clauses
(map (lambda (binding-set val)
#`(set!-values #,binding-set #,val))
binding-sets
annotated-vals)]
[exp-finished-clauses
(with-syntax ([(_ let-clauses . dc) stx]
[((lifted-var ...) ...) lifted-var-sets])
(with-syntax ([(exp-thunk ...) (map (lx (lambda () _))
(syntax->list #`let-clauses))])
#`(list (list exp-thunk
(list lifted-var ...)
(lambda () (list var ...))) ...)))]
; time to work from the inside out again
; without renaming, this would all be much much simpler.
[wrapped-begin (outer-wcm-wrap (make-debug-info-let free-varrefs
binding-list
let-counter)
(double-break-wrap
#`(begin #,@(apply append (zip set!-clauses counter-clauses))
(#,exp-finished-break #,exp-finished-clauses)
#,annotated-body)))])))))]
;; pulling out begin abstraction!
;;; bLECCh! I think I can do this with a MAP, rather than a fold.
#;[begin-abstraction
(lambda (bodies)
(if
(null? bodies)
(normal-bundle null exp)
((outer-begin-wrap
(foldl another-body-wrap wrapped-final remaining-reversed-bodies index-list))
. where .
([another-body-wrap
(lambda (next-body index stx-n-freevars)
(let*-2vals
([(seed-stx free-vars-so-far) stx-n-freevars]
[(annotated-next-body free-vars-next-body) (non-tail-recur next-body)]
[free-vars-union (varref-set-union (list free-vars-so-far free-vars-next-body))]
[inner-wrapped (wcm-wrap
(make-debug-info-app (binding-set-union (list tail-bound (list begin-temp)))
(varref-set-union (list free-vars-so-far (list begin-temp)))
(list 'begin index))
(break-wrap (pre-break-wrap seed-stx)))])
(2vals #`(let ([#,begin-temp #,annotated-next-body])
#,inner-wrapped)
free-vars-union)))]
[outer-begin-wrap
(lambda (stx-n-free-vars)
(let*-2vals ([(stx free-vars) stx-n-free-vars])
(2vals (wcm-wrap
(make-debug-info-app tail-bound free-vars (list 'begin (length bodies)))
stx)
free-vars)))]
[all-bodies-reversed (reverse bodies)]
[final-body (car all-bodies-reversed)]
[remaining-reversed-bodies (cdr all-bodies-reversed)]
[index-list (build-list (length remaining-reversed-bodies) (lambda (x) (+ x 1)))]
[wrapped-final (tail-recur final-body)])))
)]
; @ :@@$
; @:
; -@@ @@@@@
; @ @
; @ @
; @ @
; @ @
; @@@@@ @@@@@
; if-abstraction: (-> syntax? syntax? (or/c false/c syntax?) (values syntax? varref-set?))
[if-abstraction
(lambda (test then else)
(let*-2vals
([(annotated-test free-varrefs-test)
(non-tail-recur test)]
[test-with-break
(normal-break/values-wrap annotated-test)]
[(annotated-then free-varrefs-then)
(tail-recur then)]
[(annotated-else free-varrefs-else)
(if else
(tail-recur else)
(2vals #f null))]
[free-varrefs (varref-set-union (list free-varrefs-test
free-varrefs-then
free-varrefs-else))]
[annotated-if
(if else
(quasisyntax/loc exp (if #,test-with-break #,annotated-then #,annotated-else))
(quasisyntax/loc exp (if #,test-with-break #,annotated-then)))])
(2vals
(outer-wcm-wrap (make-debug-info-normal free-varrefs) annotated-if)
free-varrefs)))]
; :@@$
; @:
; @@@ @@@ $@$: @@-$+ @@-$+ -@@$ @@@@@
; $ $ -@ @$ : @$ : $ -$ @
; +: ++ -$@$@ @ @ @@@@@ @
; $ $ $* @ @ @ $ @
; $:+ @- *@ @ @ +: @
; :@ -$$-@@ @@@@@ @@@@@ $@@+ @@@@@
[varref-abstraction
(lambda (var)
(let*-2vals ([free-varrefs (list var)]
[varref-break-wrap
(lambda ()
(wcm-break-wrap (make-debug-info-normal free-varrefs)
(return-value-wrap var)))]
[varref-no-break-wrap
(lambda ()
(outer-wcm-wrap (make-debug-info-normal free-varrefs) var))]
[top-level-varref-break-wrap
(lambda ()
(if (memq (syntax-e var) beginner-defined:must-reduce)
(varref-break-wrap)
(varref-no-break-wrap)))])
(2vals
(case (syntax-property var 'stepper-binding-type)
((lambda-bound macro-bound) (varref-no-break-wrap))
((let-bound) (varref-break-wrap))
((non-lexical) ;; is it from this module or not?
(match (identifier-binding var)
(#f (top-level-varref-break-wrap))
[`(,path-index-or-symbol ,dc1 ,dc2 ,dc3 ,dc4)
(if (module-path-index? path-index-or-symbol)
(let-values ([(module-path dc5) (module-path-index-split path-index-or-symbol)])
(if module-path
;; not a module-local variable:
(top-level-varref-break-wrap)
;; a module-local-variable:
(varref-break-wrap)))
(top-level-varref-break-wrap))]
[else (error 'annotate "unexpected value for identifier-binding: ~v" identifier-binding)])))
free-varrefs)))]
[recertifier
(lambda (vals)
(let*-2vals ([(new-exp bindings) vals])
(2vals (stepper-recertify new-exp exp)
(map (lambda (b)
(syntax-recertify b exp (current-code-inspector) #f))
bindings))))]
)
; find the source expression and associate it with the parsed expression
; (when (and red-exprs foot-wrap?)
; (set-exp-read! exp (find-read-expr exp)))
(recertifier
(kernel:kernel-syntax-case exp #f
[(lambda . clause)
(let*-2vals ([(annotated-clause free-varrefs)
(lambda-clause-abstraction (syntax clause))]
[annotated-lambda
(with-syntax ([annotated-clause annotated-clause])
(syntax/loc exp (lambda . annotated-clause)))])
(outer-lambda-abstraction annotated-lambda free-varrefs))]
[(case-lambda . clauses)
(let*-2vals ([(annotated-cases free-varrefs-cases)
(2vals-map lambda-clause-abstraction (syntax->list (syntax clauses)))]
[annotated-case-lambda (with-syntax ([annotated-cases annotated-cases])
(syntax/loc exp (case-lambda . annotated-cases)))]
[free-varrefs (varref-set-union free-varrefs-cases)])
(outer-lambda-abstraction annotated-case-lambda free-varrefs))]
[(if test then else) (if-abstraction (syntax test) (syntax then) (syntax else))]
[(if test then) (if-abstraction (syntax test) (syntax then) #f)]
[(begin . bodies-stx)
(begin
(error 'annotate-inner "nothing expands into begin! : ~v" (syntax-object->datum exp))
#;(begin-abstraction (syntax->list #`bodies-stx)))]
[(begin0 . bodies-stx)
(let*-2vals
([bodies (syntax->list (syntax bodies-stx))]
[(annotated-first free-varrefs-first)
(result-recur (car bodies))]
[(annotated-bodies free-varref-sets)
(2vals-map non-tail-recur (cdr bodies))])
(normal-bundle (varref-set-union (cons free-varrefs-first free-varref-sets))
(quasisyntax/loc exp (begin0 #,annotated-first #,@annotated-bodies))))]
;; special case for the expansion of begin.
;; more efficient, but disabled because of difficulties in threading it through the
;; reconstruction. Easier to undo in the macro-unwind phase.
#;[(let-values () . bodies-stx)
(eq? (syntax-property exp 'stepper-hint) 'comes-from-begin)
(begin-abstraction (syntax->list #`bodies-stx))]
[(let-values . _)
(let-abstraction exp
#`let-values
(lambda (bindings)
(map (lambda (_) *unevaluated*) bindings)))]
[(letrec-values . _)
(let-abstraction exp
#`letrec-values
(lambda (bindings) (map (lambda (b) #`#,b) bindings)))]
; $
; @ @
; :@@+@ -@@$ @@@@@ @
; @$ -@ $ -$ @ @
; :@@$- @@@@@ @ @
; *@ $ @
; @ :@ +: @: :$
; $+@@: $@@+ :@@$- $
[(set! var val)
(let*-2vals
([(annotated-val val-free-varrefs)
(set!-rhs-recur (syntax val) (syntax-case (syntax var) (#%top)
[(#%top . real-var) (syntax-e (syntax real-var))]
[else (syntax var)]))]
[free-varrefs (varref-set-union (list val-free-varrefs (list #`var)))]
[annotated-set!
(return-value-wrap
(quasisyntax/loc exp (set! var #,(normal-break/values-wrap annotated-val))))])
(2vals
(outer-wcm-wrap (make-debug-info-normal free-varrefs) annotated-set!)
free-varrefs))]
; @
; $@-@@@@ @@ $@$ @@@@@ -@@$
; $- :@ @ @ $- -$ @ $ -$
; @ @ @ @ @ @ @ @@@@@
; @ @ @ @ @ @ @ $
; $- :@ @: +@ $- -$ @: :$ +:
; $@-@ :@$-@@ $@$ :@@$- $@@+
; @
; @@@
[(quote _)
(normal-bundle null exp)]
[(quote-syntax _)
(normal-bundle null exp)]
; @@@ @@@ $@+@ @@+-$:
; @ @ $+ -@ @+@$@
; $-@ @ @@@@@ @ @@@@@ @ @ @
; ++@+$ @ @ @ @
; :@@$+ $* -$ @ @ @
; -@$@* $@$- @@@@@@@
[(with-continuation-mark key mark body)
;(let*-2vals ([(annotated-key free-varrefs-key)
; (non-tail-recur (syntax key))]
; [(annotated-mark free-varrefs-mark)
; (non-tail-recur (syntax mark))]
; [(annotated-body dc_free-varrefs-body)
; (result-recur (syntax body))])
(error 'annotate/inner "this region of code is still under construction")
; [annotated #`(let-values ([key-temp #,*unevaluated*]
; [mark-temp #,*unevaluated*]
;)
]
; @@ @ @
; @ @
; $@$: @@:@$- @@:@$- @ -@@ $@+@ $@$: @@@@@ -@@ $@$ @@:@@:
; -@ @: -$ @: -$ @ @ $+ -@ -@ @ @ $- -$ @+ :@
; -$@$@ @ @ @ @ @ @ @ -$@$@ @ @ @ @ @ @
; $* @ @ @ @ @ @ @ @ $* @ @ @ @ @ @ @
; @- *@ @: -$ @: -$ @ @ $* -$ @- *@ @: :$ @ $- -$ @ @
; -$$-@@ @-@$ @-@$ @@@@@ @@@@@ $@$- -$$-@@ :@@$- @@@@@ $@$ @@@ @@@
; @ @
; @@@ @@@
; [foot-wrap?
; (wcm-wrap debug-info annotated)])
; free-bindings))]
; the app form's elaboration looks like this, where M0 etc. stand for expressions, and t0 etc
; are temp identifiers that do not occur in the program:
; (M0 ...)
;
; goes to
;
;(let ([t0 *unevaluated*]
; ...)
; (with-continuation-mark
; debug-key
; huge-value
; (set! t0 M0)
; ...
; (with-continuation-mark
; debug-key
; much-smaller-value
; (t0 ...))))
;
; 'break's are not illustrated. An optimization is possible when all expressions M0 ... are
; varrefs. In particular (where v0 ... are varrefs):
; (v0 ...)
;
; goes to
;
; (with-continuation-mark
; debug-key
; debug-value
; (v0 ...))
;
; in other words, no real elaboration occurs. Note that this doesn't work as-is for the
; stepper, because there's nowhere to hang the breakpoint; you want to see the break
; occur after all vars have been evaluated. I suppose you could do (wcm ... (begin v0 ... (v0 ...)))
; where the second set are not annotated ... but stepper runtime is not at a premium.
[(#%app . terms)
(let*-2vals
([(annotated-terms free-varrefs-terms)
(2vals-map non-tail-recur (syntax->list (syntax terms)))]
[free-varrefs (varref-set-union free-varrefs-terms)])
(2vals
(let* ([arg-temps (build-list (length annotated-terms) get-arg-var)]
[tagged-arg-temps (map (lambda (var) (syntax-property var 'stepper-binding-type 'stepper-temp))
arg-temps)]
[let-clauses #`((#,tagged-arg-temps
(values #,@(map (lambda (_) *unevaluated*) tagged-arg-temps))))]
[set!-list (map (lambda (arg-symbol annotated-sub-exp)
#`(set! #,arg-symbol #,annotated-sub-exp))
tagged-arg-temps annotated-terms)]
[new-tail-bound (binding-set-union (list tail-bound tagged-arg-temps))]
[app-debug-info (make-debug-info-app new-tail-bound tagged-arg-temps 'called)]
[app-term (quasisyntax/loc exp #,tagged-arg-temps)]
[debug-info (make-debug-info-app new-tail-bound
(varref-set-union (list free-varrefs tagged-arg-temps)) ; NB using bindings as vars
'not-yet-called)]
[let-body (outer-wcm-wrap debug-info #`(begin #,@set!-list
#,(break-wrap
(wcm-wrap
app-debug-info
#`(if (#,in-closure-table #,(car tagged-arg-temps))
#,app-term
#,(return-value-wrap app-term))))))])
#`(let-values #,let-clauses #,let-body))
;)
free-varrefs))]
; @@
; @ @
; $@:@ $@$: @@@@@ @@ @@ @@+-$:
; $* *@ -@ @ @ @ @+@$@
; @ @ -$@$@ @ @ @ @ @ @
; @ @ $* @ @ @ @ @ @ @
; $* *@ @- *@ @: :$ @: +@ @ @ @
; $@:@@ -$$-@@ :@@$- :@$-@@@@@@@@@
[(#%datum . _)
(normal-bundle null exp)]
[(#%top . var-stx)
(varref-abstraction #`var-stx)]
[var-stx
(identifier? #`var-stx)
(varref-abstraction #`var-stx)]
[else
(error 'annotate "unexpected syntax for expression: ~v" (syntax-object->datum exp))])))])))
(define (stepper-recertify new-stx old-stx)
(syntax-recertify new-stx old-stx (current-code-inspector) #f))
;; annotate/top-level : syntax-> syntax
;; expansion of teaching level language programs produces two kinds of
;; expressions: modules containing all of the code in the def'ns window, and
;; require statements that invoke those modules. In the first case, we must annotate
;; the expressions inside the top-level module, and in the second, we should just
;; leave it alone.
(define/contract annotate/top-level
(syntax? . -> . syntax?)
(lambda (exp)
(syntax-case exp (module #%plain-module-begin let-values dynamic-wind lambda)
[(module name lang
(#%plain-module-begin . bodies))
#`(module name lang (#%plain-module-begin #,@(map annotate/module-top-level (syntax->list #`bodies))))]
; the 'require' form is used for the test harness
[(require module-name) exp]
; the 'dynamic-require' form is used by the actual expander
[(let-values ([(done-already?) . rest1])
(#%app dynamic-wind
void
(lambda () . rest2)
(lambda () . rest3)))
exp]
[else (begin
(fprintf (current-error-port) "~v\n" (syntax-object->datum exp))
(error `annotate/top-level "unexpected top-level expression: ~a\n" (syntax-object->datum exp)))])))
(define/contract annotate/top-level/acl2
(syntax? . -> . syntax?)
(lambda (exp)
(>>> exp)
(syntax-case exp (begin define-values #%app)
[(begin contract-thingy
(begin body (begin)))
#`(begin contract-thingy (begin #,(annotate/module-top-level #`body) (begin)))]
#;(define-values
(lifted)
(begin
(#%app
contract/proc
provide/contract-contract-id-zp
zp
provide/contract-pos-module-source-zp
(#%app module-source-as-symbol (quote-syntax here))
(quote-syntax zp))))
#;(if (#%app null? (#%app lifted (#%datum . 3))) 'y 'x)
[else (annotate/module-top-level exp)]
#;[else (begin
(fprintf (current-error-port) "~v\n" (syntax-object->datum exp))
(error `annotate/top-level "unexpected top-level expression: ~a\n" (syntax-object->datum exp)))])))
(define/contract annotate/module-top-level
(syntax? . -> . syntax?)
(lambda (exp)
(cond [(syntax-property exp 'stepper-skip-completely) exp]
[(syntax-property exp 'stepper-define-struct-hint)
#`(begin #,exp
(#,(make-define-struct-break exp)))]
[(syntax-property exp 'stepper-skipto)
(skipto-annotate (syntax-property exp 'stepper-skipto) exp annotate/module-top-level)]
[else
(syntax-case exp (#%app call-with-values define-values define-syntaxes require require-for-syntax provide begin lambda)
[(define-values (new-var ...) e)
(let* ([name-list (syntax->list #`(new-var ...))]
[defined-name (if (and (pair? name-list) (null? (cdr name-list)))
(car name-list)
#f)])
#`(begin
(define-values (new-var ...)
#,(top-level-annotate/inner (top-level-rewrite #`e) exp defined-name))
;; this next expression should deliver the newly computed values to an exp-finished-break
(#,exp-finished-break (list (list #,(lambda () exp) #f (lambda () (list new-var ...)))))))]
[(define-syntaxes (new-vars ...) e)
exp]
[(require specs ...)
exp]
[(require-for-syntax specs ...)
exp]
[(provide specs ...)
exp]
[(begin . bodies)
#`(begin #,@(map annotate/module-top-level (syntax->list #`bodies)))]
[(#%app call-with-values (lambda () body) print-values)
#`(call-with-values
(lambda () #,(top-level-annotate/inner (top-level-rewrite #`body) exp #f))
(lambda vals
(begin
(#,exp-finished-break (list (list #,(lambda () exp) #f (lambda () vals))))
(call-with-values (lambda () vals)
print-values))))]
[any
(syntax-property exp 'stepper-test-suite-hint)
(top-level-annotate/inner (top-level-rewrite exp) exp #f)]
[else
(top-level-annotate/inner (top-level-rewrite exp) exp #f)
;; the following check can't be permitted in the presence of things like test-suite cases
;; which produce arbitrary expressions at the top level.
#;(error `annotate/module-top-level "unexpected module-top-level expression to annotate: ~a\n" (syntax-object->datum exp))])])))
; body of local
#;(printf "input: ~a\n" exp)
(let* ([annotated-exp (cond
[(string=? language-level-name "ACL2 Beginner (beta 8)")
(annotate/top-level/acl2 main-exp)]
[else
(annotate/top-level main-exp)])])
#;(printf "annotated: \n~a\n" (syntax-object->datum annotated-exp))
annotated-exp)))