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