jscl.lisp

   1 ;;; jscl.lisp ---
   2
   3 ;; Copyright (C) 2012, 2013 David Vazquez
   4 ;; Copyright (C) 2012 Raimon Grau
   5
   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.
  10 ;;
  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.
  15 ;;
  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/>.
  18
  19 (defpackage :jscl
  20   (:use :cl)
  21   (:export #:bootstrap #:run-tests-in-host))
  22
  23 (in-package :jscl)
  24
  25 ;;; List of all the source files that need to be compiled, and whether they
  26 ;;; are to be compiled just by the host, by the target JSCL, or by both.
  27 ;;; All files have a `.lisp' extension, and
  28 ;;; are relative to src/
  29 ;;; Subdirectories are indicated by the presence of a list rather than a
  30 ;;; keyword in the second element of the list. For example, this list:
  31 ;;;  (("foo"    :target)
  32 ;;;   ("bar"
  33 ;;;     ("baz"  :host)
  34 ;;;     ("quux" :both)))
  35 ;;; Means that src/foo.lisp and src/bar/quux.lisp need to be compiled in the
  36 ;;; target, and that src/bar/baz.lisp and src/bar/quux.lisp need to be
  37 ;;; compiled in the host
  38 (defvar *source*
  39   '(("boot"          :target)
  40     ("compat"        :host)
  41     ("utils"         :both)
  42     ("numbers"       :target)
  43     ("char"          :target)
  44     ("list"          :target)
  45     ("array"         :target)
  46     ("string"        :target)
  47     ("sequence"      :target)
  48     ("stream"        :target)
  49     ("print"         :target)
  50     ("package"       :target)
  51     ("misc"          :target)
  52     ("documentation" :target)
  53     ("ffi"           :both)
  54     ("read"          :both)
  55     ("defstruct"     :both)
  56     ("lambda-list"   :both)
  57     ("backquote"     :both)
  58     ("compiler"
  59      ("codegen"      :both)
  60      ("compiler"     :both))
  61     ("toplevel"      :target)))
  62
  63 (defun get-files (file-list type dir)
  64   "Traverse FILE-LIST and retrieve a list of the files within which match
  65    either TYPE or :BOTH, processing subdirectories."
  66   (let ((file (car file-list)))
  67     (cond
  68       ((null file-list)
  69        ())
  70       ((listp (cadr file))
  71        (append
  72          (get-files (cdr file)      type (append dir (list (car file))))
  73          (get-files (cdr file-list) type dir)))
  74       ((member (cadr file) (list type :both))
  75        (cons (source-pathname (car file) :directory dir :type "lisp")
  76              (get-files (cdr file-list) type dir)))
  77       (t
  78        (get-files (cdr file-list) type dir)))))
  79
  80 (defmacro do-source (name type &body body)
  81   "Iterate over all the source files that need to be compiled in the host or
  82    the target, depending on the TYPE argument."
  83   (unless (member type '(:host :target))
  84     (error "TYPE must be one of :HOST or :TARGET, not ~S" type))
  85   `(dolist (,name (get-files *source* ,type '(:relative "src")))
  86      ,@body))
  87
  88 (defun source-pathname
  89     (filename &key (directory '(:relative "src")) (type nil) (defaults filename))
  90   (if type
  91       (make-pathname :type type :directory directory :defaults defaults)
  92       (make-pathname            :directory directory :defaults defaults)))
  93
  94 ;;; Compile jscl into the host
  95 (with-compilation-unit ()
  96   (do-source input :host
  97     (multiple-value-bind (fasl warn fail) (compile-file input)
  98       (declare (ignore fasl warn))
  99       (when fail
 100         (error "Compilation of ~A failed." input)))))
 101
 102 ;;; Load jscl into the host
 103 (do-source input :host
 104   (load input))
 105
 106 (defun read-whole-file (filename)
 107   (with-open-file (in filename)
 108     (let ((seq (make-array (file-length in) :element-type 'character)))
 109       (read-sequence seq in)
 110       seq)))
 111
 112 (defun !compile-file (filename out &key print)
 113   (let ((*compiling-file* t)
 114         (*compile-print-toplevels* print))
 115     (let* ((source (read-whole-file filename))
 116            (in (make-string-stream source)))
 117       (format t "Compiling ~a...~%" (enough-namestring filename))
 118       (loop
 119          with eof-mark = (gensym)
 120          for x = (ls-read in nil eof-mark)
 121          until (eq x eof-mark)
 122          do (let ((compilation (compile-toplevel x)))
 123               (when (plusp (length compilation))
 124                 (write-string compilation out)))))))
 125
 126 (defun dump-global-environment (stream)
 127   (flet ((late-compile (form)
 128            (let ((*standard-output* stream))
 129              (write-string (compile-toplevel form)))))
 130     ;; We assume that environments have a friendly list representation
 131     ;; for the compiler and it can be dumped.
 132     (dolist (b (lexenv-function *environment*))
 133       (when (eq (binding-type b) 'macro)
 134         (setf (binding-value b) `(,*magic-unquote-marker* ,(binding-value b)))))
 135     (late-compile `(setq *environment* ',*environment*))
 136     ;; Set some counter variable properly, so user compiled code will
 137     ;; not collide with the compiler itself.
 138     (late-compile
 139      `(progn
 140         (progn ,@(mapcar (lambda (s) `(%intern-symbol (%js-vref ,(string (cdr s)))))
 141                          (remove-if-not #'symbolp *literal-table* :key #'car)))
 142         (setq *literal-table* ',*literal-table*)
 143         (setq *variable-counter* ,*variable-counter*)
 144         (setq *gensym-counter* ,*gensym-counter*)))
 145     (late-compile `(setq *literal-counter* ,*literal-counter*))))
 146
 147
 148 (defun bootstrap ()
 149   (let ((*features* (cons :jscl *features*))
 150         (*package* (find-package "JSCL")))
 151     (setq *environment* (make-lexenv))
 152     (setq *literal-table* nil)
 153     (setq *variable-counter* 0
 154           *gensym-counter* 0
 155           *literal-counter* 0)
 156     (with-open-file (out "jscl.js" :direction :output :if-exists :supersede)
 157       (write-string (read-whole-file (source-pathname "prelude.js")) out)
 158       (do-source input :target
 159         (!compile-file input out))
 160       (dump-global-environment out))
 161     ;; Tests
 162     (with-open-file (out "tests.js" :direction :output :if-exists :supersede)
 163       (dolist (input (append (directory "tests.lisp")
 164                              (directory "tests/*.lisp")
 165                              (directory "tests-report.lisp")))
 166         (!compile-file input out)))))
 167
 168
 169 ;;; Run the tests in the host Lisp implementation. It is a quick way
 170 ;;; to improve the level of trust of the tests.
 171 (defun run-tests-in-host ()
 172   (let ((*package* (find-package "JSCL")))
 173     (load "tests.lisp")
 174     (let ((*use-html-output-p* nil))
 175       (declare (special *use-html-output-p*))
 176       (dolist (input (directory "tests/*.lisp"))
 177         (load input)))
 178     (load "tests-report.lisp")))