chiark - git - mdw - sod/blob - src/final.lisp

   1 ;;; -*-lisp-*-
   2 ;;;
   3 ;;; Finishing touches for Sod
   4 ;;;
   5 ;;; (c) 2015 Straylight/Edgeware
   6 ;;;
   7
   8 ;;;----- Licensing notice ---------------------------------------------------
   9 ;;;
  10 ;;; This file is part of the Sensible Object Design, an object system for C.
  11 ;;;
  12 ;;; SOD is free software; you can redistribute it and/or modify
  13 ;;; it under the terms of the GNU General Public License as published by
  14 ;;; the Free Software Foundation; either version 2 of the License, or
  15 ;;; (at your option) any later version.
  16 ;;;
  17 ;;; SOD is distributed in the hope that it will be useful,
  18 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;;; GNU General Public License for more details.
  21 ;;;
  22 ;;; You should have received a copy of the GNU General Public License
  23 ;;; along with SOD; if not, write to the Free Software Foundation,
  24 ;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25
  26 (cl:in-package #:sod)
  27
  28 ;;;--------------------------------------------------------------------------
  29 ;;; Miscellaneous details.
  30
  31 (export '*sod-version*)
  32 (defparameter *sod-version* sod-sysdef:*version*
  33   "The version of the SOD translator system, as a string.")
  34
  35 ;;;--------------------------------------------------------------------------
  36 ;;; Debugging utilities.
  37
  38 (export '*debugout-pathname*)
  39 (defvar *debugout-pathname* #p"debugout.c")
  40
  41 (export 'test-module)
  42 (defun test-module (path reason)
  43   "Reset the translator's state, read a module from PATH and output it with
  44    REASON, returning the result as a string."
  45   (clear-the-decks)
  46   (setf *module-map* (make-hash-table :test #'equal))
  47   (with-open-file (out *debugout-pathname*
  48                    :direction :output
  49                    :if-exists :supersede
  50                    :if-does-not-exist :create)
  51     (output-module (read-module path) reason out)))
  52
  53 (export 'test-parser)
  54 (defmacro test-parser ((scanner &key) parser input)
  55   "Convenient macro for testing parsers at the REPL.
  56
  57    This is a macro so that the parser can use the fancy syntax.  The name
  58    SCANNER is bound to a `sod-token-scanner' reading tokens from the INPUT
  59    string.  Then the PARSER is invoked and three values are returned: a
  60    `successp' flag indicating whether the parser succeeded; the result,
  61    output or error indicator, of the parser; and a list consisting of the
  62    lookahead token type and value, and a string containing the untokenized
  63    remaining input."
  64   (once-only (input)
  65     (with-gensyms (char-scanner value winp consumedp where)
  66       `(let* ((,char-scanner (make-string-scanner ,input))
  67               (,scanner (make-instance 'sod-token-scanner
  68                                        :char-scanner ,char-scanner
  69                                        :filename "<test-input>")))
  70          (with-parser-context (token-scanner-context :scanner ,scanner)
  71            (multiple-value-bind (,value ,winp ,consumedp) (parse ,parser)
  72              (declare (ignore ,consumedp))
  73              (let ((,where (scanner-capture-place ,char-scanner)))
  74                (values ,winp ,value
  75                        (list (token-type ,scanner) (token-value ,scanner)
  76                              (subseq ,input ,where))))))))))
  77
  78 ;;;--------------------------------------------------------------------------
  79 ;;; Calisthenics.
  80
  81 (export 'exercise)
  82 (defun exercise ()
  83   "Exercise the pieces of the metaobject protocol.
  84
  85    In some Lisps, the compiler is run the first time methods are called, to
  86    do fancy just-in-time optimization things.  This is great, only the
  87    program doesn't actually run for very long and a lot of that work is
  88    wasted because we're going to have to do it again next time the program
  89    starts.  Only, if we exercise the various methods, or at least a large
  90    fraction of them, before we dump an image, then everything will be fast.
  91
  92    That's the theory anyway.  Call this function before you dump an image and
  93    see what happens."
  94
  95   (clear-the-decks)
  96   (dolist (reason '(:h :c))
  97     (with-output-to-string (bitbucket)
  98       (output-module *builtin-module* reason bitbucket)))
  99
 100   (clear-the-decks))
 101
 102 ;;;----- That's all, folks --------------------------------------------------