3 ;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
5 ;; This program is free software; you can redistribute it and/or modify
6 ;; it under the terms of the GNU General Public License as published by
7 ;; the Free Software Foundation; either version 3, or (at your option)
10 ;; This program is distributed in the hope that it will be useful,
11 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
12 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 ;; GNU General Public License for more details.
15 ;; You should have received a copy of the GNU General Public License
16 ;; along with this program; see the file COPYING. If not, write to
17 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 ;; Boston, MA 02111-1307, USA.
22 (define-module (language elisp compile-tree-il)
23 #:use-module (language elisp bindings)
24 #:use-module (language elisp runtime)
25 #:use-module (language tree-il)
26 #:use-module (system base pmatch)
27 #:use-module (system base compile)
28 #:use-module (srfi srfi-1)
29 #:use-module (srfi srfi-8)
30 #:use-module (srfi srfi-11)
31 #:use-module (srfi srfi-26)
32 #:export (compile-tree-il
34 compile-eval-when-compile
44 compile-guile-primitive
51 compile-%set-lexical-binding-mode))
53 ;;; Certain common parameters (like the bindings data structure or
54 ;;; compiler options) are not always passed around but accessed using
55 ;;; fluids to simulate dynamic binding (hey, this is about elisp).
57 ;;; The bindings data structure to keep track of symbol binding related
60 (define bindings-data (make-fluid))
62 (define lexical-binding (make-fluid))
64 ;;; Find the source properties of some parsed expression if there are
65 ;;; any associated with it.
69 (let ((props (source-properties x)))
70 (and (not (null? props))
73 ;;; Values to use for Elisp's nil and t.
75 (define (nil-value loc)
76 (make-const loc (@ (language elisp runtime) nil-value)))
79 (make-const loc (@ (language elisp runtime) t-value)))
81 ;;; Modules that contain the value and function slot bindings.
83 (define runtime '(language elisp runtime))
85 (define value-slot (@ (language elisp runtime) value-slot-module))
87 (define function-slot (@ (language elisp runtime) function-slot-module))
89 ;;; The backquoting works the same as quasiquotes in Scheme, but the
90 ;;; forms are named differently; to make easy adaptions, we define these
91 ;;; predicates checking for a symbol being the car of an
92 ;;; unquote/unquote-splicing/backquote form.
94 (define (unquote? sym)
95 (and (symbol? sym) (eq? sym '#{,}#)))
97 (define (unquote-splicing? sym)
98 (and (symbol? sym) (eq? sym '#{,@}#)))
100 ;;; Build a call to a primitive procedure nicely.
102 (define (call-primitive loc sym . args)
103 (make-application loc (make-primitive-ref loc sym) args))
105 ;;; Error reporting routine for syntax/compilation problems or build
106 ;;; code for a runtime-error output.
108 (define (report-error loc . args)
111 (define (access-variable loc symbol handle-lexical handle-dynamic)
113 ((get-lexical-binding (fluid-ref bindings-data) symbol)
118 (define (reference-variable loc symbol)
123 (make-lexical-ref loc lexical lexical))
127 (make-module-ref loc value-slot symbol #t)))))
129 (define (global? module symbol)
130 (module-variable module symbol))
132 (define (ensure-globals! loc names body)
133 (if (and (every (cut global? (resolve-module value-slot) <>) names)
134 (every symbol-interned? names))
140 (ensure-fluid! value-slot name)
141 (make-application loc
142 (make-module-ref loc runtime 'ensure-fluid! #t)
143 (list (make-const loc value-slot)
144 (make-const loc name))))
148 (define (set-variable! loc symbol value)
153 (make-lexical-set loc lexical lexical value))
160 (make-module-ref loc value-slot symbol #t)
163 (define (access-function loc symbol handle-lexical handle-global)
165 ((get-function-binding (fluid-ref bindings-data) symbol)
170 (define (reference-function loc symbol)
174 (lambda (gensym) (make-lexical-ref loc symbol gensym))
175 (lambda () (make-module-ref loc function-slot symbol #t))))
177 (define (set-function! loc symbol value)
181 (lambda (gensym) (make-lexical-set loc symbol gensym value))
185 (make-module-ref loc runtime 'set-symbol-function! #t)
186 (list (make-const loc symbol) value)))))
188 (define (bind-lexically? sym module decls)
189 (or (eq? module function-slot)
190 (let ((decl (assq-ref decls sym)))
191 (and (equal? module value-slot)
195 (fluid-ref lexical-binding)
196 (not (global? (resolve-module module) sym))))))))
198 (define (parse-let-binding loc binding)
201 (guard (symbol? var))
204 (guard (symbol? var))
207 (guard (symbol? var))
210 (report-error loc "malformed variable binding" binding))))
212 (define (parse-flet-binding loc binding)
214 ((,var ,args . ,body)
215 (guard (symbol? var))
216 (cons var `(function (lambda ,args ,@body))))
218 (report-error loc "malformed function binding" binding))))
220 (define (parse-declaration expr)
223 (map (cut cons <> 'lexical) vars))
227 (define (parse-body-1 body lambda?)
228 (let loop ((lst body)
233 (((declare . ,x) . ,tail)
234 (loop tail (append-reverse x decls) intspec doc))
235 (((interactive . ,x) . ,tail)
236 (guard lambda? (not intspec))
237 (loop tail decls x doc))
239 (guard lambda? (string? x) (not doc) (not (null? tail)))
240 (loop tail decls intspec x))
242 (values (append-map parse-declaration decls)
247 (define (parse-lambda-body body)
248 (parse-body-1 body #t))
250 (define (parse-body body)
251 (receive (decls intspec doc body) (parse-body-1 body #f)
252 (values decls body)))
254 ;;; Partition the argument list of a lambda expression into required,
255 ;;; optional and rest arguments.
257 (define (parse-lambda-list lst)
258 (define (%match lst null optional rest symbol)
261 ((&optional . ,tail) (optional tail))
262 ((&rest . ,tail) (rest tail))
263 ((,arg . ,tail) (guard (symbol? arg)) (symbol arg tail))
265 (define (return rreq ropt rest)
266 (values #t (reverse rreq) (reverse ropt) rest))
268 (values #f #f #f #f))
269 (define (parse-req lst rreq)
271 (lambda () (return rreq '() #f))
272 (lambda (tail) (parse-opt tail rreq '()))
273 (lambda (tail) (parse-rest tail rreq '()))
274 (lambda (arg tail) (parse-req tail (cons arg rreq)))))
275 (define (parse-opt lst rreq ropt)
277 (lambda () (return rreq ropt #f))
278 (lambda (tail) (fail))
279 (lambda (tail) (parse-rest tail rreq ropt))
280 (lambda (arg tail) (parse-opt tail rreq (cons arg ropt)))))
281 (define (parse-rest lst rreq ropt)
284 (lambda (tail) (fail))
285 (lambda (tail) (fail))
286 (lambda (arg tail) (parse-post-rest tail rreq ropt arg))))
287 (define (parse-post-rest lst rreq ropt rest)
289 (lambda () (return rreq ropt rest))
292 (lambda (arg tail) (fail))))
295 (define (make-simple-lambda loc meta req opt init rest vars body)
298 (make-lambda-case #f req opt rest #f init vars body #f)))
300 (define (compile-lambda loc meta args body)
301 (receive (valid? req-ids opt-ids rest-id)
302 (parse-lambda-list args)
304 (let* ((all-ids (append req-ids
306 (or (and=> rest-id list) '())))
307 (all-vars (map (lambda (ignore) (gensym)) all-ids)))
308 (let*-values (((decls intspec doc forms)
309 (parse-lambda-body body))
312 (compose (cut bind-lexically? <> value-slot decls)
314 (map list all-ids all-vars)))
315 ((lexical-ids lexical-vars) (unzip2 lexical))
316 ((dynamic-ids dynamic-vars) (unzip2 dynamic)))
317 (with-dynamic-bindings
318 (fluid-ref bindings-data)
321 (with-lexical-bindings
322 (fluid-ref bindings-data)
329 (let* ((tree-il (compile-expr `(progn ,@forms)))
335 (map (cut make-module-ref loc value-slot <> #t)
337 (map (cut make-lexical-ref loc <> <>)
341 (make-simple-lambda loc
345 (map (const (nil-value loc))
350 (report-error "invalid function" `(lambda ,args ,@body)))))
352 ;;; Handle the common part of defconst and defvar, that is, checking for
353 ;;; a correct doc string and arguments as well as maybe in the future
354 ;;; handling the docstring somehow.
356 (define (handle-var-def loc sym doc)
358 ((not (symbol? sym)) (report-error loc "expected symbol, got" sym))
359 ((> (length doc) 1) (report-error loc "too many arguments to defvar"))
360 ((and (not (null? doc)) (not (string? (car doc))))
361 (report-error loc "expected string as third argument of defvar, got"
363 ;; TODO: Handle doc string if present.
366 ;;; Handle macro and special operator bindings.
368 (define (find-operator name type)
371 (module-defined? (resolve-interface function-slot) name)
372 (let ((op (module-ref (resolve-module function-slot) name)))
373 (if (and (pair? op) (eq? (car op) type))
377 ;;; See if a (backquoted) expression contains any unquotes.
379 (define (contains-unquotes? expr)
381 (if (or (unquote? (car expr)) (unquote-splicing? (car expr)))
383 (or (contains-unquotes? (car expr))
384 (contains-unquotes? (cdr expr))))
387 ;;; Process a backquoted expression by building up the needed
388 ;;; cons/append calls. For splicing, it is assumed that the expression
389 ;;; spliced in evaluates to a list. The emacs manual does not really
390 ;;; state either it has to or what to do if it does not, but Scheme
391 ;;; explicitly forbids it and this seems reasonable also for elisp.
393 (define (unquote-cell? expr)
394 (and (list? expr) (= (length expr) 2) (unquote? (car expr))))
396 (define (unquote-splicing-cell? expr)
397 (and (list? expr) (= (length expr) 2) (unquote-splicing? (car expr))))
399 (define (process-backquote loc expr)
400 (if (contains-unquotes? expr)
402 (if (or (unquote-cell? expr) (unquote-splicing-cell? expr))
403 (compile-expr (cadr expr))
404 (let* ((head (car expr))
405 (processed-tail (process-backquote loc (cdr expr)))
406 (head-is-list-2 (and (list? head)
407 (= (length head) 2)))
408 (head-unquote (and head-is-list-2
409 (unquote? (car head))))
410 (head-unquote-splicing (and head-is-list-2
413 (if head-unquote-splicing
416 (compile-expr (cadr head))
418 (call-primitive loc 'cons
420 (compile-expr (cadr head))
421 (process-backquote loc head))
424 "non-pair expression contains unquotes"
426 (make-const loc expr)))
428 ;;; Special operators
430 (defspecial progn (loc args)
433 (list (nil-value loc))
434 (map compile-expr args))))
436 (defspecial eval-when-compile (loc args)
437 (make-const loc (compile `(progn ,@args) #:from 'elisp #:to 'value)))
439 (defspecial if (loc args)
441 ((,cond ,then . ,else)
444 (call-primitive loc 'not
445 (call-primitive loc 'nil? (compile-expr cond)))
447 (compile-expr `(progn ,@else))))))
449 (defspecial defconst (loc args)
451 ((,sym ,value . ,doc)
452 (if (handle-var-def loc sym doc)
454 (list (set-variable! loc sym (compile-expr value))
455 (make-const loc sym)))))))
457 (defspecial defvar (loc args)
459 ((,sym) (make-const loc sym))
460 ((,sym ,value . ,doc)
461 (if (handle-var-def loc sym doc)
474 (make-const loc value-slot))
475 (make-const loc sym))
478 (make-module-ref loc value-slot sym #t))
481 (set-variable! loc sym (compile-expr value)))
482 (make-const loc sym)))))))
484 (defspecial setq (loc args)
485 (define (car* x) (if (null? x) '() (car x)))
486 (define (cdr* x) (if (null? x) '() (cdr x)))
487 (define (cadr* x) (car* (cdr* x)))
488 (define (cddr* x) (cdr* (cdr* x)))
491 (let loop ((args args) (last (nil-value loc)))
494 (let ((sym (car args))
495 (val (compile-expr (cadr* args))))
496 (if (not (symbol? sym))
497 (report-error loc "expected symbol in setq")
499 (set-variable! loc sym val)
501 (reference-variable loc sym)))))))))
503 (defspecial let (loc args)
506 (let ((bindings (map (cut parse-let-binding loc <>) varlist)))
507 (receive (decls forms) (parse-body body)
508 (receive (lexical dynamic)
510 (compose (cut bind-lexically? <> value-slot decls)
513 (let ((make-values (lambda (for)
514 (map (lambda (el) (compile-expr (cdr el)))
516 (make-body (lambda () (compile-expr `(progn ,@forms)))))
522 (map (compose (cut make-module-ref
529 (map (compose compile-expr cdr)
532 (let* ((lexical-syms (map (lambda (el) (gensym)) lexical))
533 (dynamic-syms (map (lambda (el) (gensym)) dynamic))
534 (all-syms (append lexical-syms dynamic-syms))
535 (vals (append (make-values lexical)
536 (make-values dynamic))))
541 (with-lexical-bindings
542 (fluid-ref bindings-data)
565 (make-body))))))))))))))))
567 (defspecial let* (loc args)
570 (let ((bindings (map (cut parse-let-binding loc <>) varlist)))
571 (receive (decls forms) (parse-body body)
572 (let iterate ((tail bindings))
574 (compile-expr `(progn ,@forms))
575 (let ((sym (caar tail))
576 (value (compile-expr (cdar tail))))
577 (if (bind-lexically? sym value-slot decls)
578 (let ((target (gensym)))
583 (with-lexical-bindings
584 (fluid-ref bindings-data)
587 (lambda () (iterate (cdr tail))))))
592 (list (make-module-ref loc value-slot sym #t))
594 (iterate (cdr tail)))))))))))))
596 (defspecial flet (loc args)
599 (let ((names+vals (map (cut parse-flet-binding loc <>) bindings)))
600 (receive (decls forms) (parse-body body)
601 (let ((names (map car names+vals))
602 (vals (map cdr names+vals))
603 (gensyms (map (lambda (x) (gensym)) names+vals)))
604 (with-function-bindings
605 (fluid-ref bindings-data)
612 (map compile-expr vals)
613 (compile-expr `(progn ,@forms)))))))))))
615 (defspecial labels (loc args)
618 (let ((names+vals (map (cut parse-flet-binding loc <>) bindings)))
619 (receive (decls forms) (parse-body body)
620 (let ((names (map car names+vals))
621 (vals (map cdr names+vals))
622 (gensyms (map (lambda (x) (gensym)) names+vals)))
623 (with-function-bindings
624 (fluid-ref bindings-data)
632 (map compile-expr vals)
633 (compile-expr `(progn ,@forms)))))))))))
635 ;;; guile-ref allows building TreeIL's module references from within
636 ;;; elisp as a way to access data within the Guile universe. The module
637 ;;; and symbol referenced are static values, just like (@ module symbol)
640 (defspecial guile-ref (loc args)
642 ((,module ,sym) (guard (and (list? module) (symbol? sym)))
643 (make-module-ref loc module sym #t))))
645 ;;; guile-primitive allows to create primitive references, which are
646 ;;; still a little faster.
648 (defspecial guile-primitive (loc args)
651 (make-primitive-ref loc sym))))
653 (defspecial function (loc args)
655 (((lambda ,args . ,body))
656 (compile-lambda loc '() args body))
657 ((,sym) (guard (symbol? sym))
658 (reference-function loc sym))))
660 (defspecial defmacro (loc args)
662 ((,name ,args . ,body)
663 (if (not (symbol? name))
664 (report-error loc "expected symbol as macro name" name)
674 (make-module-ref loc '(guile) 'cons #t)
675 (list (make-const loc 'macro)
680 (make-const loc name)))))
681 (compile tree-il #:from 'tree-il #:to 'value)
684 (defspecial defun (loc args)
686 ((,name ,args . ,body)
687 (if (not (symbol? name))
688 (report-error loc "expected symbol as function name" name)
690 (list (set-function! loc
696 (make-const loc name)))))))
698 (defspecial #{`}# (loc args)
701 (process-backquote loc val))))
703 (defspecial quote (loc args)
706 (make-const loc val))))
708 (defspecial %funcall (loc args)
710 ((,function . ,arguments)
711 (make-application loc
712 (compile-expr function)
713 (map compile-expr arguments)))))
715 (defspecial %set-lexical-binding-mode (loc args)
718 (fluid-set! lexical-binding val)
721 ;;; Compile a compound expression to Tree-IL.
723 (define (compile-pair loc expr)
724 (let ((operator (car expr))
725 (arguments (cdr expr)))
727 ((find-operator operator 'special-operator)
728 => (lambda (special-operator-function)
729 (special-operator-function loc arguments)))
730 ((find-operator operator 'macro)
731 => (lambda (macro-function)
732 (compile-expr (apply macro-function arguments))))
734 (compile-expr `(%funcall (function ,operator) ,@arguments))))))
736 ;;; Compile a symbol expression. This is a variable reference or maybe
737 ;;; some special value like nil.
739 (define (compile-symbol loc sym)
741 ((nil) (nil-value loc))
743 (else (reference-variable loc sym))))
745 ;;; Compile a single expression to TreeIL.
747 (define (compile-expr expr)
748 (let ((loc (location expr)))
751 (compile-symbol loc expr))
753 (compile-pair loc expr))
754 (else (make-const loc expr)))))
756 ;;; Process the compiler options.
757 ;;; FIXME: Why is '(()) passed as options by the REPL?
759 (define (valid-symbol-list-arg? value)
761 (and (list? value) (and-map symbol? value))))
763 (define (process-options! opt)
764 (if (and (not (null? opt))
765 (not (equal? opt '(()))))
766 (if (null? (cdr opt))
767 (report-error #f "Invalid compiler options" opt)
768 (let ((key (car opt))
771 ((#:warnings) ; ignore
773 (else (report-error #f
774 "Invalid compiler option"
777 (define (compile-tree-il expr env opts)
779 (with-fluids ((bindings-data (make-bindings)))
780 (process-options! opts)