3 ;; copyright (C) 2012, 2013 David Vazquez
4 ;; Copyright (C) 2012 Raimon Grau
6 ;; JSCL is free software: you can redistribute it and/or
7 ;; modify it under the terms of the GNU General Public License as
8 ;; published by the Free Software Foundation, either version 3 of the
9 ;; License, or (at your option) any later version.
11 ;; JSCL is distributed in the hope that it will be useful, but
12 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 ;; General Public License for more details.
16 ;; You should have received a copy of the GNU General Public License
17 ;; along with JSCL. If not, see <http://www.gnu.org/licenses/>.
21 (/debug "loading compiler.lisp!")
23 ;;; Translate the Lisp code to Javascript. It will compile the special
24 ;;; forms. Some primitive functions are compiled as special forms
25 ;;; too. The respective real functions are defined in the target (see
26 ;;; the beginning of this file) as well as some primitive functions.
28 (defun interleave (list element &optional after-last-p)
32 (dolist (x (cdr list))
38 (defun code (&rest args)
39 (mapconcat (lambda (arg)
42 ((integerp arg) (integer-to-string arg))
43 ((floatp arg) (float-to-string arg))
46 (with-output-to-string (*standard-output*)
50 ;;; Wrap X with a Javascript code to convert the result from
51 ;;; Javascript generalized booleans to T or NIL.
53 `(if ,x ,(ls-compile t) ,(ls-compile nil)))
55 ;;; Concatenate the arguments and wrap them with a self-calling
56 ;;; Javascript anonymous function. It is used to make some Javascript
57 ;;; statements valid expressions and provide a private scope as well.
58 ;;; It could be defined as function, but we could do some
59 ;;; preprocessing in the future.
60 (defmacro js!selfcall (&body body)
61 ``(call (function nil (code ,,@body))))
63 ;;; Like CODE, but prefix each line with four spaces. Two versions
64 ;;; of this function are available, because the Ecmalisp version is
65 ;;; very slow and bootstraping was annoying.
67 ;;; A Form can return a multiple values object calling VALUES, like
68 ;;; values(arg1, arg2, ...). It will work in any context, as well as
69 ;;; returning an individual object. However, if the special variable
70 ;;; `*multiple-value-p*' is NIL, is granted that only the primary
71 ;;; value will be used, so we can optimize to avoid the VALUES
73 (defvar *multiple-value-p* nil)
89 (defun lookup-in-lexenv (name lexenv namespace)
90 (find name (ecase namespace
91 (variable (lexenv-variable lexenv))
92 (function (lexenv-function lexenv))
93 (block (lexenv-block lexenv))
94 (gotag (lexenv-gotag lexenv)))
97 (defun push-to-lexenv (binding lexenv namespace)
99 (variable (push binding (lexenv-variable lexenv)))
100 (function (push binding (lexenv-function lexenv)))
101 (block (push binding (lexenv-block lexenv)))
102 (gotag (push binding (lexenv-gotag lexenv)))))
104 (defun extend-lexenv (bindings lexenv namespace)
105 (let ((env (copy-lexenv lexenv)))
106 (dolist (binding (reverse bindings) env)
107 (push-to-lexenv binding env namespace))))
110 (defvar *environment* (make-lexenv))
112 (defvar *variable-counter* 0)
114 (defun gvarname (symbol)
115 (declare (ignore symbol))
116 (code "v" (incf *variable-counter*)))
118 (defun translate-variable (symbol)
119 (awhen (lookup-in-lexenv symbol *environment* 'variable)
122 (defun extend-local-env (args)
123 (let ((new (copy-lexenv *environment*)))
124 (dolist (symbol args new)
125 (let ((b (make-binding :name symbol :type 'variable :value (gvarname symbol))))
126 (push-to-lexenv b new 'variable)))))
128 ;;; Toplevel compilations
129 (defvar *toplevel-compilations* nil)
131 (defun toplevel-compilation (string)
132 (push string *toplevel-compilations*))
134 (defun get-toplevel-compilations ()
135 (reverse *toplevel-compilations*))
137 (defun %compile-defmacro (name lambda)
138 (toplevel-compilation (ls-compile `',name))
139 (let ((binding (make-binding :name name :type 'macro :value lambda)))
140 (push-to-lexenv binding *environment* 'function))
143 (defun global-binding (name type namespace)
144 (or (lookup-in-lexenv name *environment* namespace)
145 (let ((b (make-binding :name name :type type :value nil)))
146 (push-to-lexenv b *environment* namespace)
149 (defun claimp (symbol namespace claim)
150 (let ((b (lookup-in-lexenv symbol *environment* namespace)))
151 (and b (member claim (binding-declarations b)))))
153 (defun !proclaim (decl)
156 (dolist (name (cdr decl))
157 (let ((b (global-binding name 'variable 'variable)))
158 (push 'special (binding-declarations b)))))
160 (dolist (name (cdr decl))
161 (let ((b (global-binding name 'function 'function)))
162 (push 'notinline (binding-declarations b)))))
164 (dolist (name (cdr decl))
165 (let ((b (global-binding name 'variable 'variable)))
166 (push 'constant (binding-declarations b)))))))
169 (fset 'proclaim #'!proclaim)
171 (defun %define-symbol-macro (name expansion)
172 (let ((b (make-binding :name name :type 'macro :value expansion)))
173 (push-to-lexenv b *environment* 'variable)
177 (defmacro define-symbol-macro (name expansion)
178 `(%define-symbol-macro ',name ',expansion))
183 (defvar *compilations* nil)
185 (defmacro define-compilation (name args &body body)
186 ;; Creates a new primitive `name' with parameters args and
187 ;; @body. The body can access to the local environment through the
188 ;; variable *ENVIRONMENT*.
189 `(push (list ',name (lambda ,args (block ,name ,@body)))
192 (define-compilation if (condition true &optional false)
193 `(code "(" ,(ls-compile condition) " !== " ,(ls-compile nil)
194 " ? " ,(ls-compile true *multiple-value-p*)
195 " : " ,(ls-compile false *multiple-value-p*)
198 (defvar *ll-keywords* '(&optional &rest &key))
200 (defun list-until-keyword (list)
201 (if (or (null list) (member (car list) *ll-keywords*))
203 (cons (car list) (list-until-keyword (cdr list)))))
205 (defun ll-section (keyword ll)
206 (list-until-keyword (cdr (member keyword ll))))
208 (defun ll-required-arguments (ll)
209 (list-until-keyword ll))
211 (defun ll-optional-arguments-canonical (ll)
212 (mapcar #'ensure-list (ll-section '&optional ll)))
214 (defun ll-optional-arguments (ll)
215 (mapcar #'car (ll-optional-arguments-canonical ll)))
217 (defun ll-rest-argument (ll)
218 (let ((rest (ll-section '&rest ll)))
220 (error "Bad lambda-list `~S'." ll))
223 (defun ll-keyword-arguments-canonical (ll)
224 (flet ((canonicalize (keyarg)
225 ;; Build a canonical keyword argument descriptor, filling
226 ;; the optional fields. The result is a list of the form
227 ;; ((keyword-name var) init-form).
228 (let ((arg (ensure-list keyarg)))
229 (cons (if (listp (car arg))
231 (list (intern (symbol-name (car arg)) "KEYWORD") (car arg)))
233 (mapcar #'canonicalize (ll-section '&key ll))))
235 (defun ll-keyword-arguments (ll)
236 (mapcar (lambda (keyarg) (second (first keyarg)))
237 (ll-keyword-arguments-canonical ll)))
239 (defun ll-svars (lambda-list)
242 (ll-keyword-arguments-canonical lambda-list)
243 (ll-optional-arguments-canonical lambda-list))))
244 (remove nil (mapcar #'third args))))
246 (defun lambda-name/docstring-wrapper (name docstring &rest code)
247 (if (or name docstring)
249 "var func = " `(code ,@code) ";"
251 `(code "func.fname = " ,(js-escape-string name) ";"))
253 `(code "func.docstring = " ,(js-escape-string docstring) ";"))
257 (defun lambda-check-argument-count
258 (n-required-arguments n-optional-arguments rest-p)
259 ;; Note: Remember that we assume that the number of arguments of a
260 ;; call is at least 1 (the values argument).
261 (let ((min n-required-arguments)
262 (max (if rest-p 'n/a (+ n-required-arguments n-optional-arguments))))
264 ;; Special case: a positive exact number of arguments.
265 (when (and (< 0 min) (eql min max))
266 (return `(code "checkArgs(nargs, " ,min ");")))
270 `(code "checkArgsAtLeast(nargs, " ,min ");"))
272 `(code "checkArgsAtMost(nargs, " ,max ");"))))))
274 (defun compile-lambda-optional (ll)
275 (let* ((optional-arguments (ll-optional-arguments-canonical ll))
276 (n-required-arguments (length (ll-required-arguments ll)))
277 (n-optional-arguments (length optional-arguments)))
278 (when optional-arguments
279 `(code "switch(nargs){"
283 (while (< idx n-optional-arguments)
284 (let ((arg (nth idx optional-arguments)))
285 (push `(code "case " ,(+ idx n-required-arguments) ":"
286 (code ,(translate-variable (car arg))
288 ,(ls-compile (cadr arg)) ";")
290 `(code ,(translate-variable (third arg))
296 (push `(code "default: break;") cases)
297 `(code ,@(reverse cases))))
300 (defun compile-lambda-rest (ll)
301 (let ((n-required-arguments (length (ll-required-arguments ll)))
302 (n-optional-arguments (length (ll-optional-arguments ll)))
303 (rest-argument (ll-rest-argument ll)))
305 (let ((js!rest (translate-variable rest-argument)))
306 `(code "var " ,js!rest "= " ,(ls-compile nil) ";"
307 "for (var i = nargs-1; i>=" ,(+ n-required-arguments n-optional-arguments)
309 (code ,js!rest " = {car: arguments[i+2], cdr: " ,js!rest "};"))))))
311 (defun compile-lambda-parse-keywords (ll)
312 (let ((n-required-arguments
313 (length (ll-required-arguments ll)))
314 (n-optional-arguments
315 (length (ll-optional-arguments ll)))
317 (ll-keyword-arguments-canonical ll)))
320 ,@(mapcar (lambda (arg)
321 (let ((var (second (car arg))))
322 `(code "var " ,(translate-variable var) "; "
324 `(code "var " ,(translate-variable (third arg))
325 " = " ,(ls-compile nil)
329 ,(flet ((parse-keyword (keyarg)
330 ;; ((keyword-name var) init-form)
331 `(code "for (i=" ,(+ n-required-arguments n-optional-arguments)
333 "if (arguments[i+2] === " ,(ls-compile (caar keyarg)) "){"
334 ,(translate-variable (cadr (car keyarg)))
336 ,(let ((svar (third keyarg)))
338 `(code ,(translate-variable svar) " = " ,(ls-compile t) ";" )))
344 ,(translate-variable (cadr (car keyarg)))
346 ,(ls-compile (cadr keyarg))
349 (when keyword-arguments
351 ,@(mapcar #'parse-keyword keyword-arguments))))
352 ;; Check for unknown keywords
353 ,(when keyword-arguments
354 `(code "var start = " ,(+ n-required-arguments n-optional-arguments) ";"
355 "if ((nargs - start) % 2 == 1){"
356 "throw 'Odd number of keyword arguments';"
358 "for (i = start; i<nargs; i+=2){"
360 ,@(interleave (mapcar (lambda (x)
361 `(code "arguments[i+2] !== " ,(ls-compile (caar x))))
365 "throw 'Unknown keyword argument ' + xstring(arguments[i+2].name);"
368 (defun parse-lambda-list (ll)
369 (values (ll-required-arguments ll)
370 (ll-optional-arguments ll)
371 (ll-keyword-arguments ll)
372 (ll-rest-argument ll)))
374 ;;; Process BODY for declarations and/or docstrings. Return as
375 ;;; multiple values the BODY without docstrings or declarations, the
376 ;;; list of declaration forms and the docstring.
377 (defun parse-body (body &key declarations docstring)
378 (let ((value-declarations)
380 ;; Parse declarations
382 (do* ((rest body (cdr rest))
383 (form (car rest) (car rest)))
384 ((or (atom form) (not (eq (car form) 'declare)))
386 (push form value-declarations)))
390 (not (null (cdr body))))
391 (setq value-docstring (car body))
392 (setq body (cdr body)))
393 (values body value-declarations value-docstring)))
395 ;;; Compile a lambda function with lambda list LL and body BODY. If
396 ;;; NAME is given, it should be a constant string and it will become
397 ;;; the name of the function. If BLOCK is non-NIL, a named block is
398 ;;; created around the body. NOTE: No block (even anonymous) is
399 ;;; created if BLOCk is NIL.
400 (defun compile-lambda (ll body &key name block)
401 (multiple-value-bind (required-arguments
405 (parse-lambda-list ll)
406 (multiple-value-bind (body decls documentation)
407 (parse-body body :declarations t :docstring t)
408 (declare (ignore decls))
409 (let ((n-required-arguments (length required-arguments))
410 (n-optional-arguments (length optional-arguments))
411 (*environment* (extend-local-env
412 (append (ensure-list rest-argument)
417 (lambda-name/docstring-wrapper name documentation
420 ,(join (list* "values"
422 (mapcar #'translate-variable
423 (append required-arguments optional-arguments)))
426 ;; Check number of arguments
427 ,(lambda-check-argument-count n-required-arguments
429 (or rest-argument keyword-arguments))
430 ,(compile-lambda-optional ll)
431 ,(compile-lambda-rest ll)
432 ,(compile-lambda-parse-keywords ll)
433 ,(let ((*multiple-value-p* t))
435 (ls-compile-block `((block ,block ,@body)) t)
436 (ls-compile-block body t)))
440 (defun setq-pair (var val)
441 (let ((b (lookup-in-lexenv var *environment* 'variable)))
444 (eq (binding-type b) 'variable)
445 (not (member 'special (binding-declarations b)))
446 (not (member 'constant (binding-declarations b))))
447 `(code ,(binding-value b) " = " ,(ls-compile val)))
448 ((and b (eq (binding-type b) 'macro))
449 (ls-compile `(setf ,var ,val)))
451 (ls-compile `(set ',var ,val))))))
454 (define-compilation setq (&rest pairs)
457 (return-from setq (ls-compile nil)))
463 (error "Odd pairs in SETQ"))
465 (push `(code ,(setq-pair (car pairs) (cadr pairs))
466 ,(if (null (cddr pairs)) "" ", "))
468 (setq pairs (cddr pairs)))))
469 `(code "(" ,@(reverse result) ")")))
472 ;;; Compilation of literals an object dumping
474 ;;; BOOTSTRAP MAGIC: We record the macro definitions as lists during
475 ;;; the bootstrap. Once everything is compiled, we want to dump the
476 ;;; whole global environment to the output file to reproduce it in the
477 ;;; run-time. However, the environment must contain expander functions
478 ;;; rather than lists. We do not know how to dump function objects
479 ;;; itself, so we mark the list definitions with this object and the
480 ;;; compiler will be called when this object has to be dumped.
481 ;;; Backquote/unquote does a similar magic, but this use is exclusive.
483 ;;; Indeed, perhaps to compile the object other macros need to be
484 ;;; evaluated. For this reason we define a valid macro-function for
486 (defvar *magic-unquote-marker* (gensym "MAGIC-UNQUOTE"))
488 (setf (macro-function *magic-unquote-marker*)
489 (lambda (form &optional environment)
490 (declare (ignore environment))
493 (defvar *literal-table* nil)
494 (defvar *literal-counter* 0)
497 (code "l" (incf *literal-counter*)))
499 (defun dump-symbol (symbol)
501 (let ((package (symbol-package symbol)))
502 (if (eq package (find-package "KEYWORD"))
503 `(code "(new Symbol(" ,(dump-string (symbol-name symbol)) ", " ,(dump-string (package-name package)) "))")
504 `(code "(new Symbol(" ,(dump-string (symbol-name symbol)) "))")))
506 (let ((package (symbol-package symbol)))
508 `(code "(new Symbol(" ,(dump-string (symbol-name symbol)) "))")
509 (ls-compile `(intern ,(symbol-name symbol) ,(package-name package))))))
511 (defun dump-cons (cons)
512 (let ((head (butlast cons))
515 ,@(interleave (mapcar (lambda (x) (literal x t)) head) "," t)
516 ,(literal (car tail) t)
518 ,(literal (cdr tail) t)
521 (defun dump-array (array)
522 (let ((elements (vector-to-list array)))
523 `(code "[" ,(join (mapcar #'literal elements) ", ") "]")))
525 (defun dump-string (string)
526 `(code "make_lisp_string(" ,(js-escape-string string) ")"))
528 (defun literal (sexp &optional recursive)
530 ((integerp sexp) (integer-to-string sexp))
531 ((floatp sexp) (float-to-string sexp))
532 ((characterp sexp) (js-escape-string (string sexp)))
534 (or (cdr (assoc sexp *literal-table* :test #'eql))
535 (let ((dumped (typecase sexp
536 (symbol (dump-symbol sexp))
537 (string (dump-string sexp))
539 ;; BOOTSTRAP MAGIC: See the root file
540 ;; jscl.lisp and the function
541 ;; `dump-global-environment' for futher
543 (if (eq (car sexp) *magic-unquote-marker*)
544 (ls-compile (second sexp))
546 (array (dump-array sexp)))))
547 (if (and recursive (not (symbolp sexp)))
549 (let ((jsvar (genlit)))
550 (push (cons sexp jsvar) *literal-table*)
551 (toplevel-compilation `(code "var " ,jsvar " = " ,dumped))
552 (when (keywordp sexp)
553 (toplevel-compilation `(code ,jsvar ".value = " ,jsvar)))
557 (define-compilation quote (sexp)
560 (define-compilation %while (pred &rest body)
562 "while(" (ls-compile pred) " !== " (ls-compile nil) "){" *newline*
563 `(code ,(ls-compile-block body))
565 "return " (ls-compile nil) ";" *newline*))
567 (define-compilation function (x)
569 ((and (listp x) (eq (car x) 'lambda))
570 (compile-lambda (cadr x) (cddr x)))
571 ((and (listp x) (eq (car x) 'named-lambda))
572 ;; TODO: destructuring-bind now! Do error checking manually is
574 (let ((name (cadr x))
577 (compile-lambda ll body
578 :name (symbol-name name)
581 (let ((b (lookup-in-lexenv x *environment* 'function)))
584 (ls-compile `(symbol-function ',x)))))))
587 (defun make-function-binding (fname)
588 (make-binding :name fname :type 'function :value (gvarname fname)))
590 (defun compile-function-definition (list)
591 (compile-lambda (car list) (cdr list)))
593 (defun translate-function (name)
594 (let ((b (lookup-in-lexenv name *environment* 'function)))
595 (and b (binding-value b))))
597 (define-compilation flet (definitions &rest body)
598 (let* ((fnames (mapcar #'car definitions))
599 (cfuncs (mapcar (lambda (def)
600 (compile-lambda (cadr def)
605 (extend-lexenv (mapcar #'make-function-binding fnames)
609 ,@(interleave (mapcar #'translate-function fnames) ",")
611 ,(ls-compile-block body t)
612 "})(" ,@cfuncs ")")))
614 (define-compilation labels (definitions &rest body)
615 (let* ((fnames (mapcar #'car definitions))
617 (extend-lexenv (mapcar #'make-function-binding fnames)
621 `(code ,@(mapcar (lambda (func)
622 `(code "var " ,(translate-function (car func))
623 " = " ,(compile-lambda (cadr func)
624 `((block ,(car func) ,@(cddr func))))
627 (ls-compile-block body t))))
630 (defvar *compiling-file* nil)
631 (define-compilation eval-when-compile (&rest body)
634 (eval (cons 'progn body))
636 (ls-compile `(progn ,@body))))
638 (defmacro define-transformation (name args form)
639 `(define-compilation ,name ,args
642 (define-compilation progn (&rest body)
643 (if (null (cdr body))
644 (ls-compile (car body) *multiple-value-p*)
647 (append (mapcar #'ls-compile (butlast body))
648 (list (ls-compile (car (last body)) t)))
652 (define-compilation macrolet (definitions &rest body)
653 (let ((*environment* (copy-lexenv *environment*)))
654 (dolist (def definitions)
655 (destructuring-bind (name lambda-list &body body) def
656 (let ((binding (make-binding :name name :type 'macro :value
657 (let ((g!form (gensym)))
659 (destructuring-bind ,lambda-list ,g!form
661 (push-to-lexenv binding *environment* 'function))))
662 (ls-compile `(progn ,@body) *multiple-value-p*)))
665 (defun special-variable-p (x)
666 (and (claimp x 'variable 'special) t))
668 ;;; Wrap CODE to restore the symbol values of the dynamic
669 ;;; bindings. BINDINGS is a list of pairs of the form
670 ;;; (SYMBOL . PLACE), where PLACE is a Javascript variable
671 ;;; name to initialize the symbol value and where to stored
673 (defun let-binding-wrapper (bindings body)
674 (when (null bindings)
675 (return-from let-binding-wrapper body))
681 (let ((s (ls-compile `(quote ,(car b)))))
682 `(code "tmp = " ,s ".value;"
683 ,s ".value = " ,(cdr b) ";"
684 ,(cdr b) " = tmp;" )))
691 ,@(mapcar (lambda (b)
692 (let ((s (ls-compile `(quote ,(car b)))))
693 `(code ,s ".value" " = " ,(cdr b) ";" )))
697 (define-compilation let (bindings &rest body)
698 (let* ((bindings (mapcar #'ensure-list bindings))
699 (variables (mapcar #'first bindings))
700 (cvalues (mapcar #'ls-compile (mapcar #'second bindings)))
701 (*environment* (extend-local-env (remove-if #'special-variable-p variables)))
706 (if (special-variable-p x)
707 (let ((v (gvarname x)))
708 (push (cons x v) dynamic-bindings)
710 (translate-variable x)))
714 ,(let ((body (ls-compile-block body t t)))
715 `(code ,(let-binding-wrapper dynamic-bindings body)))
716 "})(" ,@(interleave cvalues ",") ")")))
719 ;;; Return the code to initialize BINDING, and push it extending the
720 ;;; current lexical environment if the variable is not special.
721 (defun let*-initialize-value (binding)
722 (let ((var (first binding))
723 (value (second binding)))
724 (if (special-variable-p var)
725 `(code ,(ls-compile `(setq ,var ,value)) ";" )
726 (let* ((v (gvarname var))
727 (b (make-binding :name var :type 'variable :value v)))
728 (prog1 `(code "var " ,v " = " ,(ls-compile value) ";" )
729 (push-to-lexenv b *environment* 'variable))))))
731 ;;; Wrap BODY to restore the symbol values of SYMBOLS after body. It
732 ;;; DOES NOT generate code to initialize the value of the symbols,
733 ;;; unlike let-binding-wrapper.
734 (defun let*-binding-wrapper (symbols body)
736 (return-from let*-binding-wrapper body))
737 (let ((store (mapcar (lambda (s) (cons s (gvarname s)))
738 (remove-if-not #'special-variable-p symbols))))
742 ,@(mapcar (lambda (b)
743 (let ((s (ls-compile `(quote ,(car b)))))
744 `(code "var " ,(cdr b) " = " ,s ".value;" )))
750 ,@(mapcar (lambda (b)
751 (let ((s (ls-compile `(quote ,(car b)))))
752 `(code ,s ".value" " = " ,(cdr b) ";" )))
756 (define-compilation let* (bindings &rest body)
757 (let ((bindings (mapcar #'ensure-list bindings))
758 (*environment* (copy-lexenv *environment*)))
760 (let ((specials (remove-if-not #'special-variable-p (mapcar #'first bindings)))
761 (body `(code ,@(mapcar #'let*-initialize-value bindings)
762 ,(ls-compile-block body t t))))
763 (let*-binding-wrapper specials body)))))
766 (define-compilation block (name &rest body)
767 ;; We use Javascript exceptions to implement non local control
768 ;; transfer. Exceptions has dynamic scoping, so we use a uniquely
769 ;; generated object to identify the block. The instance of a empty
770 ;; array is used to distinguish between nested dynamic Javascript
771 ;; exceptions. See https://github.com/davazp/jscl/issues/64 for
773 (let* ((idvar (gvarname name))
774 (b (make-binding :name name :type 'block :value idvar)))
775 (when *multiple-value-p*
776 (push 'multiple-value (binding-declarations b)))
777 (let* ((*environment* (extend-lexenv (list b) *environment* 'block))
778 (cbody (ls-compile-block body t)))
779 (if (member 'used (binding-declarations b))
782 "var " idvar " = [];"
786 " if (cf.type == 'block' && cf.id == " idvar ")"
787 (if *multiple-value-p*
788 " return values.apply(this, forcemv(cf.values));"
789 " return cf.values;")
794 (js!selfcall cbody)))))
796 (define-compilation return-from (name &optional value)
797 (let* ((b (lookup-in-lexenv name *environment* 'block))
798 (multiple-value-p (member 'multiple-value (binding-declarations b))))
800 (error "Return from unknown block `~S'." (symbol-name name)))
801 (push 'used (binding-declarations b))
802 ;; The binding value is the name of a variable, whose value is the
803 ;; unique identifier of the block as exception. We can't use the
804 ;; variable name itself, because it could not to be unique, so we
805 ;; capture it in a closure.
807 (when multiple-value-p `(code "var values = mv;" ))
810 "id: " (binding-value b) ", "
811 "values: " (ls-compile value multiple-value-p) ", "
812 "message: 'Return from unknown block " (symbol-name name) ".'"
815 (define-compilation catch (id &rest body)
817 "var id = " (ls-compile id) ";"
819 `(code ,(ls-compile-block body t))
822 " if (cf.type == 'catch' && cf.id == id)"
823 (if *multiple-value-p*
824 " return values.apply(this, forcemv(cf.values));"
825 " return pv.apply(this, forcemv(cf.values));")
831 (define-compilation throw (id value)
836 "id: " (ls-compile id) ", "
837 "values: " (ls-compile value t) ", "
838 "message: 'Throw uncatched.'"
842 (or (integerp x) (symbolp x)))
844 (defun declare-tagbody-tags (tbidx body)
845 (let* ((go-tag-counter 0)
847 (mapcar (lambda (label)
848 (let ((tagidx (integer-to-string (incf go-tag-counter))))
849 (make-binding :name label :type 'gotag :value (list tbidx tagidx))))
850 (remove-if-not #'go-tag-p body))))
851 (extend-lexenv bindings *environment* 'gotag)))
853 (define-compilation tagbody (&rest body)
854 ;; Ignore the tagbody if it does not contain any go-tag. We do this
855 ;; because 1) it is easy and 2) many built-in forms expand to a
856 ;; implicit tagbody, so we save some space.
857 (unless (some #'go-tag-p body)
858 (return-from tagbody (ls-compile `(progn ,@body nil))))
859 ;; The translation assumes the first form in BODY is a label
860 (unless (go-tag-p (car body))
861 (push (gensym "START") body))
862 ;; Tagbody compilation
863 (let ((branch (gvarname 'branch))
864 (tbidx (gvarname 'tbidx)))
865 (let ((*environment* (declare-tagbody-tags tbidx body))
867 (let ((b (lookup-in-lexenv (first body) *environment* 'gotag)))
868 (setq initag (second (binding-value b))))
870 ;; TAGBODY branch to take
871 "var " branch " = " initag ";"
872 "var " tbidx " = [];"
876 ,(let ((content nil))
877 `(code "switch(" ,branch "){"
879 ,@(dolist (form (cdr body) (reverse content))
880 (push (if (not (go-tag-p form))
881 `(code ,(ls-compile form) ";" )
882 (let ((b (lookup-in-lexenv form *environment* 'gotag)))
883 `(code "case " ,(second (binding-value b)) ":" )))
890 " if (jump.type == 'tagbody' && jump.id == " ,tbidx ")"
891 " " ,branch " = jump.label;"
896 "return " (ls-compile nil) ";" ))))
898 (define-compilation go (label)
899 (let ((b (lookup-in-lexenv label *environment* 'gotag))
901 ((symbolp label) (symbol-name label))
902 ((integerp label) (integer-to-string label)))))
904 (error "Unknown tag `~S'" label))
908 "id: " (first (binding-value b)) ", "
909 "label: " (second (binding-value b)) ", "
910 "message: 'Attempt to GO to non-existing tag " n "'"
913 (define-compilation unwind-protect (form &rest clean-up)
915 "var ret = " (ls-compile nil) ";"
917 `(code "ret = " ,(ls-compile form) ";" )
919 `(code ,(ls-compile-block clean-up))
923 (define-compilation multiple-value-call (func-form &rest forms)
925 "var func = " (ls-compile func-form) ";"
926 "var args = [" (if *multiple-value-p* "values" "pv") ", 0];"
932 ,@(mapcar (lambda (form)
933 `(code "vs = " ,(ls-compile form t) ";"
934 "if (typeof vs === 'object' && 'multiple-value' in vs)"
935 (code " args = args.concat(vs);" )
937 (code "args.push(vs);" )))
939 "args[1] = args.length-2;"
940 "return func.apply(window, args);" ) ";" ))
942 (define-compilation multiple-value-prog1 (first-form &rest forms)
944 "var args = " (ls-compile first-form *multiple-value-p*) ";"
945 (ls-compile-block forms)
948 (define-transformation backquote (form)
949 (bq-completely-process form))
954 (defvar *builtins* nil)
956 (defmacro define-raw-builtin (name args &body body)
957 ;; Creates a new primitive function `name' with parameters args and
958 ;; @body. The body can access to the local environment through the
959 ;; variable *ENVIRONMENT*.
960 `(push (list ',name (lambda ,args (block ,name ,@body)))
963 (defmacro define-builtin (name args &body body)
964 `(define-raw-builtin ,name ,args
965 (let ,(mapcar (lambda (arg) `(,arg (ls-compile ,arg))) args)
968 ;;; DECLS is a list of (JSVARNAME TYPE LISPFORM) declarations.
969 (defmacro type-check (decls &body body)
971 ,@(mapcar (lambda (decl)
972 `(let ((name ,(first decl))
973 (value ,(third decl)))
974 `(code "var " ,name " = " ,value ";" )))
976 ,@(mapcar (lambda (decl)
977 `(let ((name ,(first decl))
978 (type ,(second decl)))
979 `(code "if (typeof " ,name " != '" ,type "')"
980 (code "throw 'The value ' + "
982 " + ' is not a type "
987 `(code "return " ,,@body ";" )))
989 ;;; VARIABLE-ARITY compiles variable arity operations. ARGS stands for
990 ;;; a variable which holds a list of forms. It will compile them and
991 ;;; store the result in some Javascript variables. BODY is evaluated
992 ;;; with ARGS bound to the list of these variables to generate the
993 ;;; code which performs the transformation on these variables.
995 (defun variable-arity-call (args function)
997 (error "ARGS must be a non-empty list"))
1003 ((floatp x) (push (float-to-string x) fargs))
1004 ((numberp x) (push (integer-to-string x) fargs))
1005 (t (let ((v (code "x" (incf counter))))
1007 (push `(code "var " ,v " = " ,(ls-compile x) ";"
1008 "if (typeof " ,v " !== 'number') throw 'Not a number!';")
1011 `(code ,@(reverse prelude))
1012 (funcall function (reverse fargs)))))
1015 (defmacro variable-arity (args &body body)
1016 (unless (symbolp args)
1017 (error "`~S' is not a symbol." args))
1018 `(variable-arity-call ,args
1020 `(code "return " ,,@body ";" ))))
1022 (defun num-op-num (x op y)
1023 (type-check (("x" "number" x) ("y" "number" y))
1024 `(code "x" ,op "y")))
1026 (define-raw-builtin + (&rest numbers)
1029 (variable-arity numbers
1030 `(code ,@(interleave numbers "+")))))
1032 (define-raw-builtin - (x &rest others)
1033 (let ((args (cons x others)))
1034 (variable-arity args
1036 `(code "-" ,(car args))
1037 `(code ,@(interleave args "-"))))))
1039 (define-raw-builtin * (&rest numbers)
1042 (variable-arity numbers
1043 `(code ,@(interleave numbers "*")))))
1045 (define-raw-builtin / (x &rest others)
1046 (let ((args (cons x others)))
1047 (variable-arity args
1049 `(code "1 /" ,(car args))
1050 `(code ,@(interleave args "/"))))))
1052 (define-builtin mod (x y) (num-op-num x "%" y))
1055 (defun comparison-conjuntion (vars op)
1060 `(code ,(car vars) ,op ,(cadr vars)))
1062 `(code ,(car vars) ,op ,(cadr vars)
1064 ,(comparison-conjuntion (cdr vars) op)))))
1066 (defmacro define-builtin-comparison (op sym)
1067 `(define-raw-builtin ,op (x &rest args)
1068 (let ((args (cons x args)))
1069 (variable-arity args
1070 (js!bool (comparison-conjuntion args ,sym))))))
1072 (define-builtin-comparison > ">")
1073 (define-builtin-comparison < "<")
1074 (define-builtin-comparison >= ">=")
1075 (define-builtin-comparison <= "<=")
1076 (define-builtin-comparison = "==")
1077 (define-builtin-comparison /= "!=")
1079 (define-builtin numberp (x)
1080 (js!bool `(code "(typeof (" ,x ") == \"number\")")))
1082 (define-builtin floor (x)
1083 (type-check (("x" "number" x))
1086 (define-builtin expt (x y)
1087 (type-check (("x" "number" x)
1091 (define-builtin float-to-string (x)
1092 (type-check (("x" "number" x))
1093 "make_lisp_string(x.toString())"))
1095 (define-builtin cons (x y)
1096 `(code "({car: " ,x ", cdr: " ,y "})"))
1098 (define-builtin consp (x)
1102 "return (typeof tmp == 'object' && 'car' in tmp);" )))
1104 (define-builtin car (x)
1107 "return tmp === " (ls-compile nil)
1108 "? " (ls-compile nil)
1111 (define-builtin cdr (x)
1114 "return tmp === " (ls-compile nil) "? "
1118 (define-builtin rplaca (x new)
1119 (type-check (("x" "object" x))
1120 `(code "(x.car = " ,new ", x)")))
1122 (define-builtin rplacd (x new)
1123 (type-check (("x" "object" x))
1124 `(code "(x.cdr = " ,new ", x)")))
1126 (define-builtin symbolp (x)
1127 (js!bool `(code "(" ,x " instanceof Symbol)")))
1129 (define-builtin make-symbol (name)
1130 `(code "(new Symbol(" ,name "))"))
1132 (define-builtin symbol-name (x)
1133 `(code "(" ,x ").name"))
1135 (define-builtin set (symbol value)
1136 `(code "(" ,symbol ").value = " ,value))
1138 (define-builtin fset (symbol value)
1139 `(code "(" ,symbol ").fvalue = " ,value))
1141 (define-builtin boundp (x)
1142 (js!bool `(code "(" ,x ".value !== undefined)")))
1144 (define-builtin fboundp (x)
1145 (js!bool `(code "(" ,x ".fvalue !== undefined)")))
1147 (define-builtin symbol-value (x)
1149 "var symbol = " x ";"
1150 "var value = symbol.value;"
1151 "if (value === undefined) throw \"Variable `\" + xstring(symbol.name) + \"' is unbound.\";"
1154 (define-builtin symbol-function (x)
1156 "var symbol = " x ";"
1157 "var func = symbol.fvalue;"
1158 "if (func === undefined) throw \"Function `\" + xstring(symbol.name) + \"' is undefined.\";"
1161 (define-builtin symbol-plist (x)
1162 `(code "((" ,x ").plist || " ,(ls-compile nil) ")"))
1164 (define-builtin lambda-code (x)
1165 `(code "make_lisp_string((" ,x ").toString())"))
1167 (define-builtin eq (x y)
1168 (js!bool `(code "(" ,x " === " ,y ")")))
1170 (define-builtin char-code (x)
1171 (type-check (("x" "string" x))
1172 "char_to_codepoint(x)"))
1174 (define-builtin code-char (x)
1175 (type-check (("x" "number" x))
1176 "char_from_codepoint(x)"))
1178 (define-builtin characterp (x)
1182 "return (typeof(" x ") == \"string\") && (x.length == 1 || x.length == 2);")))
1184 (define-builtin char-upcase (x)
1185 `(code "safe_char_upcase(" ,x ")"))
1187 (define-builtin char-downcase (x)
1188 `(code "safe_char_downcase(" ,x ")"))
1190 (define-builtin stringp (x)
1194 "return typeof(x) == 'object' && 'length' in x && x.stringp == 1;")))
1196 (define-raw-builtin funcall (func &rest args)
1198 "var f = " (ls-compile func) ";"
1199 "return (typeof f === 'function'? f: f.fvalue)("
1201 ,@(interleave (list* (if *multiple-value-p* "values" "pv")
1202 (integer-to-string (length args))
1203 (mapcar #'ls-compile args))
1207 (define-raw-builtin apply (func &rest args)
1209 `(code "(" ,(ls-compile func) ")()")
1210 (let ((args (butlast args))
1211 (last (car (last args))))
1213 "var f = " (ls-compile func) ";"
1214 "var args = [" `(code
1215 ,@(interleave (list* (if *multiple-value-p* "values" "pv")
1216 (integer-to-string (length args))
1217 (mapcar #'ls-compile args))
1220 "var tail = (" (ls-compile last) ");"
1221 "while (tail != " (ls-compile nil) "){"
1222 " args.push(tail.car);"
1226 "return (typeof f === 'function'? f : f.fvalue).apply(this, args);" ))))
1228 (define-builtin js-eval (string)
1229 (if *multiple-value-p*
1231 "var v = globalEval(xstring(" string "));"
1232 "return values.apply(this, forcemv(v));" )
1233 `(code "globalEval(xstring(" ,string "))")))
1235 (define-builtin %throw (string)
1236 (js!selfcall "throw " string ";" ))
1238 (define-builtin functionp (x)
1239 (js!bool `(code "(typeof " ,x " == 'function')")))
1241 (define-builtin %write-string (x)
1242 `(code "lisp.write(" ,x ")"))
1244 (define-builtin /debug (x)
1245 `(code "console.log(xstring(" ,x "))"))
1248 ;;; Storage vectors. They are used to implement arrays and (in the
1249 ;;; future) structures.
1251 (define-builtin storage-vector-p (x)
1255 "return typeof x === 'object' && 'length' in x;")))
1257 (define-builtin make-storage-vector (n)
1263 (define-builtin storage-vector-size (x)
1264 `(code ,x ".length"))
1266 (define-builtin resize-storage-vector (vector new-size)
1267 `(code "(" ,vector ".length = " ,new-size ")"))
1269 (define-builtin storage-vector-ref (vector n)
1271 "var x = " "(" vector ")[" n "];"
1272 "if (x === undefined) throw 'Out of range';"
1275 (define-builtin storage-vector-set (vector n value)
1277 "var x = " vector ";"
1279 "if (i < 0 || i >= x.length) throw 'Out of range';"
1280 "return x[i] = " value ";" ))
1282 (define-builtin concatenate-storage-vector (sv1 sv2)
1284 "var sv1 = " sv1 ";"
1285 "var r = sv1.concat(" sv2 ");"
1286 "r.type = sv1.type;"
1287 "r.stringp = sv1.stringp;"
1290 (define-builtin get-internal-real-time ()
1291 "(new Date()).getTime()")
1293 (define-builtin values-array (array)
1294 (if *multiple-value-p*
1295 `(code "values.apply(this, " ,array ")")
1296 `(code "pv.apply(this, " ,array ")")))
1298 (define-raw-builtin values (&rest args)
1299 (if *multiple-value-p*
1300 `(code "values(" ,@(interleave (mapcar #'ls-compile args) ",") ")")
1301 `(code "pv(" ,@(interleave (mapcar #'ls-compile args) ", ") ")")))
1306 (define-builtin new () "{}")
1308 (define-raw-builtin oget* (object key &rest keys)
1310 "var tmp = (" (ls-compile object) ")[xstring(" (ls-compile key) ")];"
1312 ,@(mapcar (lambda (key)
1313 `(code "if (tmp === undefined) return " ,(ls-compile nil) ";"
1314 "tmp = tmp[xstring(" ,(ls-compile key) ")];" ))
1316 "return tmp === undefined? " (ls-compile nil) " : tmp;" ))
1318 (define-raw-builtin oset* (value object key &rest keys)
1319 (let ((keys (cons key keys)))
1321 "var obj = " (ls-compile object) ";"
1322 `(code ,@(mapcar (lambda (key)
1323 `(code "obj = obj[xstring(" ,(ls-compile key) ")];"
1324 "if (obj === undefined) throw 'Impossible to set Javascript property.';" ))
1326 "var tmp = obj[xstring(" (ls-compile (car (last keys))) ")] = " (ls-compile value) ";"
1327 "return tmp === undefined? " (ls-compile nil) " : tmp;" )))
1329 (define-raw-builtin oget (object key &rest keys)
1330 `(code "js_to_lisp(" ,(ls-compile `(oget* ,object ,key ,@keys)) ")"))
1332 (define-raw-builtin oset (value object key &rest keys)
1333 (ls-compile `(oset* (lisp-to-js ,value) ,object ,key ,@keys)))
1335 (define-builtin objectp (x)
1336 (js!bool `(code "(typeof (" ,x ") === 'object')")))
1338 (define-builtin lisp-to-js (x) `(code "lisp_to_js(" ,x ")"))
1339 (define-builtin js-to-lisp (x) `(code "js_to_lisp(" ,x ")"))
1342 (define-builtin in (key object)
1343 (js!bool `(code "(xstring(" ,key ") in (" ,object "))")))
1345 (define-builtin map-for-in (function object)
1347 "var f = " function ";"
1348 "var g = (typeof f === 'function' ? f : f.fvalue);"
1349 "var o = " object ";"
1350 "for (var key in o){"
1351 `(code "g(" ,(if *multiple-value-p* "values" "pv") ", 1, o[key]);" )
1353 " return " (ls-compile nil) ";" ))
1355 (define-compilation %js-vref (var)
1356 `(code "js_to_lisp(" ,var ")"))
1358 (define-compilation %js-vset (var val)
1359 `(code "(" ,var " = lisp_to_js(" ,(ls-compile val) "))"))
1361 (define-setf-expander %js-vref (var)
1362 (let ((new-value (gensym)))
1363 (unless (stringp var)
1364 (error "`~S' is not a string." var))
1368 `(%js-vset ,var ,new-value)
1373 (defvar *macroexpander-cache*
1374 (make-hash-table :test #'eq))
1376 (defun !macro-function (symbol)
1377 (unless (symbolp symbol)
1378 (error "`~S' is not a symbol." symbol))
1379 (let ((b (lookup-in-lexenv symbol *environment* 'function)))
1380 (if (and b (eq (binding-type b) 'macro))
1381 (let ((expander (binding-value b)))
1384 ((gethash b *macroexpander-cache*)
1385 (setq expander (gethash b *macroexpander-cache*)))
1387 (let ((compiled (eval expander)))
1388 ;; The list representation are useful while
1389 ;; bootstrapping, as we can dump the definition of the
1390 ;; macros easily, but they are slow because we have to
1391 ;; evaluate them and compile them now and again. So, let
1392 ;; us replace the list representation version of the
1393 ;; function with the compiled one.
1395 #+jscl (setf (binding-value b) compiled)
1396 #-jscl (setf (gethash b *macroexpander-cache*) compiled)
1397 (setq expander compiled))))
1401 (defun !macroexpand-1 (form)
1404 (let ((b (lookup-in-lexenv form *environment* 'variable)))
1405 (if (and b (eq (binding-type b) 'macro))
1406 (values (binding-value b) t)
1407 (values form nil))))
1408 ((and (consp form) (symbolp (car form)))
1409 (let ((macrofun (!macro-function (car form))))
1411 (values (funcall macrofun (cdr form)) t)
1412 (values form nil))))
1414 (values form nil))))
1416 (defun compile-funcall (function args)
1417 (let* ((values-funcs (if *multiple-value-p* "values" "pv"))
1418 (arglist `(code "(" ,@(interleave (list* values-funcs
1419 (integer-to-string (length args))
1420 (mapcar #'ls-compile args))
1423 (unless (or (symbolp function)
1424 (and (consp function)
1425 (member (car function) '(lambda oget))))
1426 (error "Bad function designator `~S'" function))
1428 ((translate-function function)
1429 `(code ,(translate-function function) ,arglist))
1430 ((and (symbolp function)
1431 #+jscl (eq (symbol-package function) (find-package "COMMON-LISP"))
1433 `(code ,(ls-compile `',function) ".fvalue" ,arglist))
1434 #+jscl((symbolp function)
1435 `(code ,(ls-compile `#',function) ,arglist))
1436 ((and (consp function) (eq (car function) 'lambda))
1437 `(code ,(ls-compile `#',function) ,arglist))
1438 ((and (consp function) (eq (car function) 'oget))
1439 `(code ,(ls-compile function) ,arglist))
1441 (error "Bad function descriptor")))))
1443 (defun ls-compile-block (sexps &optional return-last-p decls-allowed-p)
1444 (multiple-value-bind (sexps decls)
1445 (parse-body sexps :declarations decls-allowed-p)
1446 (declare (ignore decls))
1448 `(code ,(ls-compile-block (butlast sexps) nil decls-allowed-p)
1449 "return " ,(ls-compile (car (last sexps)) *multiple-value-p*) ";")
1451 ,@(interleave (mapcar #'ls-compile sexps) ";
1455 (defun ls-compile* (sexp &optional multiple-value-p)
1456 (multiple-value-bind (sexp expandedp) (!macroexpand-1 sexp)
1458 (return-from ls-compile* (ls-compile sexp multiple-value-p)))
1459 ;; The expression has been macroexpanded. Now compile it!
1460 (let ((*multiple-value-p* multiple-value-p))
1463 (let ((b (lookup-in-lexenv sexp *environment* 'variable)))
1465 ((and b (not (member 'special (binding-declarations b))))
1467 ((or (keywordp sexp)
1468 (and b (member 'constant (binding-declarations b))))
1469 `(code ,(ls-compile `',sexp) ".value"))
1471 (ls-compile `(symbol-value ',sexp))))))
1472 ((or (integerp sexp) (floatp sexp) (characterp sexp) (stringp sexp) (arrayp sexp))
1475 (let ((name (car sexp))
1479 ((assoc name *compilations*)
1480 (let ((comp (second (assoc name *compilations*))))
1482 ;; Built-in functions
1483 ((and (assoc name *builtins*)
1484 (not (claimp name 'function 'notinline)))
1485 (let ((comp (second (assoc name *builtins*))))
1488 (compile-funcall name args)))))
1490 (error "How should I compile `~S'?" sexp))))))
1492 (defun ls-compile (sexp &optional multiple-value-p)
1493 `(code "(" ,(ls-compile* sexp multiple-value-p) ")"))
1496 (defvar *compile-print-toplevels* nil)
1498 (defun truncate-string (string &optional (width 60))
1499 (let ((n (or (position #\newline string)
1500 (min width (length string)))))
1501 (subseq string 0 n)))
1503 (defun convert-toplevel (sexp &optional multiple-value-p)
1504 (let ((*toplevel-compilations* nil))
1506 ((and (consp sexp) (eq (car sexp) 'progn))
1508 ,@(mapcar (lambda (s) (convert-toplevel s t))
1511 (when *compile-print-toplevels*
1512 (let ((form-string (prin1-to-string sexp)))
1513 (format t "Compiling ~a..." (truncate-string form-string))))
1514 (let ((code (ls-compile sexp multiple-value-p)))
1516 ,@(interleave (get-toplevel-compilations) ";
1519 `(code ,code ";"))))))))
1521 (defun ls-compile-toplevel (sexp &optional multiple-value-p)
1522 (with-output-to-string (*standard-output*)
1523 (js (convert-toplevel sexp multiple-value-p))))