mdw-base.lisp: Fix `inline' proclamation for `ref'.

[lisp] / mdw-base.lisp

diff --git a/mdw-base.lisp b/mdw-base.lisp
index cde1d7a..0290ea9 100644 (file)
--- a/mdw-base.lisp
+++ b/mdw-base.lisp
@@ -13,12 +13,12 @@
 ;;; it under the terms of the GNU General Public License as published by
 ;;; the Free Software Foundation; either version 2 of the License, or
 ;;; (at your option) any later version.
 ;;; it under the terms of the GNU General Public License as published by
 ;;; the Free Software Foundation; either version 2 of the License, or
 ;;; (at your option) any later version.

-;;; 
+;;;

 ;;; This program is distributed in the hope that it will be useful,
 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;;; GNU General Public License for more details.
 ;;; This program is distributed in the hope that it will be useful,
 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;;; GNU General Public License for more details.

-;;; 
+;;;

 ;;; You should have received a copy of the GNU General Public License
 ;;; along with this program; if not, write to the Free Software Foundation,
 ;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 ;;; You should have received a copy of the GNU General Public License
 ;;; along with this program; if not, write to the Free Software Foundation,
 ;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


@@ -28,33 +28,52 @@
 
 (defpackage #:mdw.base
   (:use #:common-lisp)
 
 (defpackage #:mdw.base
   (:use #:common-lisp)

-  (:export #:compile-time-defun
+  (:export #:unsigned-fixnum
+          #:compile-time-defun

           #:show
           #:show

-          #:stringify #:listify #:fix-pair #:pairify #:parse-body
+          #:stringify #:functionify #:mappend
+          #:listify #:fix-pair #:pairify
+          #:parse-body #:with-parsed-body

           #:whitespace-char-p
           #:slot-uninitialized
           #:whitespace-char-p
           #:slot-uninitialized

-          #:nlet #:while #:case2 #:ecase2
+          #:nlet #:while #:until #:case2 #:ecase2 #:setf-default

           #:with-gensyms #:let*/gensyms #:with-places
           #:locp #:locf #:ref #:with-locatives
           #:update-place #:update-place-after
           #:with-gensyms #:let*/gensyms #:with-places
           #:locp #:locf #:ref #:with-locatives
           #:update-place #:update-place-after

-          #:incf-after #:decf-after))
+          #:incf-after #:decf-after
+          #:fixnump)
+  #+cmu (:import-from #:extensions #:fixnump))
+

 (in-package #:mdw.base)
 
 ;;;--------------------------------------------------------------------------
 (in-package #:mdw.base)
 
 ;;;--------------------------------------------------------------------------

+;;; Useful types.
+
+(deftype unsigned-fixnum ()
+  "Unsigned fixnums; useful as array indices and suchlike."
+  `(mod ,most-positive-fixnum))
+
+;;;--------------------------------------------------------------------------

 ;;; Some simple macros to get things going.
 
 (defmacro compile-time-defun (name args &body body)
   "Define a function which can be used by macros during the compilation
    process."
 ;;; Some simple macros to get things going.
 
 (defmacro compile-time-defun (name args &body body)
   "Define a function which can be used by macros during the compilation
    process."

-  `(eval-when (:compile-toplevel :load-toplevel)
+  `(eval-when (:compile-toplevel :load-toplevel :execute)

      (defun ,name ,args ,@body)))
 
 (defmacro show (x)
      (defun ,name ,args ,@body)))
 
 (defmacro show (x)

-  "Debugging tool: print the expression X and its value."
+  "Debugging tool: print the expression X and its values."

   (let ((tmp (gensym)))
   (let ((tmp (gensym)))

-    `(let ((,tmp ,x))
-       (format t "~&~S: ~S~%" ',x ,tmp)
-       ,tmp)))
+    `(let ((,tmp (multiple-value-list ,x)))
+       (fresh-line)
+       (pprint-logical-block (*standard-output* nil :per-line-prefix ";; ")
+        (format t
+                "~S = ~@_~:I~:[#<no values>~;~:*~{~S~^ ~_~}~]"
+                ',x
+                ,tmp))
+       (terpri)
+       (values-list ,tmp))))

 
 (defun stringify (str)
   "Return a string representation of STR.  Strings are returned unchanged;
 
 (defun stringify (str)
   "Return a string representation of STR.  Strings are returned unchanged;


@@ -63,8 +82,20 @@
   (typecase str
     (string str)
     (symbol (symbol-name str))
   (typecase str
     (string str)
     (symbol (symbol-name str))

-    (t (with-output-to-string (s)
-        (princ str s)))))
+    (t (princ-to-string str))))
+
+(defun functionify (func)
+  "Convert the function-designator FUNC to a function."
+  (declare (type (or function symbol) func))
+  (etypecase func
+    (function func)
+    (symbol (symbol-function func))))
+
+(defun mappend (function list &rest more-lists)
+  "Apply FUNCTION to corresponding elements of LIST and MORE-LISTS, yielding
+   a list.  Return the concatenation of all the resulting lists.  Like
+   mapcan, but nondestructive."
+  (apply #'append (apply #'mapcar function list more-lists)))

 
 (compile-time-defun listify (x)
   "If X is a (possibly empty) list, return X; otherwise return (list X)."
 
 (compile-time-defun listify (x)
   "If X is a (possibly empty) list, return X; otherwise return (list X)."


@@ -96,33 +127,67 @@
 (defun whitespace-char-p (ch)
   "Return whether CH is a whitespace character or not."
   (case ch
 (defun whitespace-char-p (ch)
   "Return whether CH is a whitespace character or not."
   (case ch

-    ((#\space #\tab #\newline #\return #\vt #\formfeed) t)
+    (#.(loop for i below char-code-limit
+            for ch = (code-char i)
+            unless (with-input-from-string (in (string ch))
+                     (peek-char t in nil))
+            collect ch)
+       t)

     (t nil)))
 
     (t nil)))
 

+(defmacro defconstant* (name value &key doc test)
+  "Define a constant, like `defconstant'.  The TEST is an equality test used
+   to decide whether to override the current definition, if any."
+  (let ((temp (gensym)))
+    `(eval-when (:compile-toplevel :load-toplevel :execute)
+       (let ((,temp ,value))
+        (unless (and (boundp ',name)
+                     (funcall ,(or test ''eql) (symbol-value ',name) ,temp))
+          (defconstant ,name ,value ,@(and doc (list doc))))
+        ',name))))
+

 (declaim (ftype (function nil ()) slot-unitialized))
 (defun slot-uninitialized ()
   "A function which signals an error.  Can be used as an initializer form in
    structure definitions without doom ensuing."
   (error "No initializer for slot."))
 
 (declaim (ftype (function nil ()) slot-unitialized))
 (defun slot-uninitialized ()
   "A function which signals an error.  Can be used as an initializer form in
    structure definitions without doom ensuing."
   (error "No initializer for slot."))
 

-(compile-time-defun parse-body (body)
+(compile-time-defun parse-body (body &key (allow-docstring-p t))

   "Given a BODY (a list of forms), parses it into three sections: a
    docstring, a list of declarations (forms beginning with the symbol
    `declare') and the body forms.  The result is returned as three lists
    (even the docstring), suitable for interpolation into a backquoted list
   "Given a BODY (a list of forms), parses it into three sections: a
    docstring, a list of declarations (forms beginning with the symbol
    `declare') and the body forms.  The result is returned as three lists
    (even the docstring), suitable for interpolation into a backquoted list

-   using `@,'."
-  (multiple-value-bind
-      (doc body)
-      (if (and (consp body)
-              (stringp (car body)))
-         (values (list (car body)) (cdr body))
-         (values nil body))
-    (loop for forms on body
-         for form = (car forms)
-         while (and (consp form)
-                    (eq (car form) 'declare))
-         collect form into decls
-         finally (return (values doc decls forms)))))
+   using `@,'.  If ALLOW-DOCSTRING-P is nil, docstrings aren't allowed at
+   all."
+  (let ((doc nil) (decls nil))
+    (do ((forms body (cdr forms))) (nil)
+      (let ((form (and forms (car forms))))
+       (cond ((and allow-docstring-p (not doc) (stringp form) (cdr forms))
+              (setf doc form))
+             ((and (consp form)
+                   (eq (car form) 'declare))
+              (setf decls (append decls (cdr form))))
+             (t (return (values (and doc (list doc))
+                                (and decls (list (cons 'declare decls)))
+                                forms))))))))
+
+(defmacro with-parsed-body
+    ((bodyvar declvar &optional (docvar (gensym) docp)) form &body body)
+  "Parse FORM into a body, declarations and (maybe) a docstring; bind BODYVAR
+   to the body, DECLVAR to the declarations, and DOCVAR to (a list
+   containing) the docstring, and evaluate BODY."
+  `(multiple-value-bind
+       (,docvar ,declvar ,bodyvar)
+       (parse-body ,form :allow-docstring-p ,docp)
+     ,@(if docp nil `((declare (ignore ,docvar))))
+     ,@body))
+
+#-cmu
+(progn
+  (declaim (inline fixnump))
+  (defun fixnump (object)
+    "Answer non-nil if OBJECT is a fixnum, or nil if it isn't."
+    (typep object 'fixnum)))

 
 ;;;--------------------------------------------------------------------------
 ;;; Generating symbols.
 
 ;;;--------------------------------------------------------------------------
 ;;; Generating symbols.


@@ -130,7 +195,7 @@
 (defmacro with-gensyms (syms &body body)
   "Everyone's favourite macro helper."
   `(let (,@(mapcar (lambda (sym) `(,sym (gensym ,(symbol-name sym))))
 (defmacro with-gensyms (syms &body body)
   "Everyone's favourite macro helper."
   `(let (,@(mapcar (lambda (sym) `(,sym (gensym ,(symbol-name sym))))

-                   (listify syms)))
+                  (listify syms)))

      ,@body))
 
 (defmacro let*/gensyms (binds &body body)
      ,@body))
 
 (defmacro let*/gensyms (binds &body body)


@@ -139,16 +204,16 @@
    each VAR is bound to a gensym, and in the final expansion, each of those
    gensyms will be bound to the corresponding VALUE."
   (labels ((more (binds)
    each VAR is bound to a gensym, and in the final expansion, each of those
    gensyms will be bound to the corresponding VALUE."
   (labels ((more (binds)

-             (let ((tmp (gensym "TMP")) (bind (car binds)))
-               `((let ((,tmp ,(cadr bind))
-                       (,(car bind) (gensym ,(symbol-name (car bind)))))
-                   `(let ((,,(car bind) ,,tmp))
-                      ,,@(if (cdr binds)
-                             (more (cdr binds))
-                             body)))))))
+            (let ((tmp (gensym "TMP")) (bind (car binds)))
+              `((let ((,tmp ,(cadr bind))
+                      (,(car bind) (gensym ,(symbol-name (car bind)))))
+                  `(let ((,,(car bind) ,,tmp))
+                     ,,@(if (cdr binds)
+                            (more (cdr binds))
+                            body)))))))

     (if (null binds)
     (if (null binds)

-        `(progn ,@body)
-        (car (more (mapcar #'pairify (listify binds)))))))
+       `(progn ,@body)
+       (car (more (mapcar #'pairify (listify binds)))))))

 
 ;;;--------------------------------------------------------------------------
 ;;; Some simple yet useful control structures.
 
 ;;;--------------------------------------------------------------------------
 ;;; Some simple yet useful control structures.


@@ -162,14 +227,16 @@
            collect val into vals
            finally (return (values vars vals)))
     `(labels ((,name ,vars
            collect val into vals
            finally (return (values vars vals)))
     `(labels ((,name ,vars

-               ,@body))
+               ,@body))

        (,name ,@vals))))
 
 (defmacro while (cond &body body)
   "If COND is false, evaluate to nil; otherwise evaluate BODY and try again."
        (,name ,@vals))))
 
 (defmacro while (cond &body body)
   "If COND is false, evaluate to nil; otherwise evaluate BODY and try again."

-  `(loop
-     (unless ,cond (return))
-     ,@body))
+  `(loop (unless ,cond (return)) (progn ,@body)))
+
+(defmacro until (cond &body body)
+  "If COND is true, evaluate to nil; otherwise evaluate BODY and try again."
+  `(loop (when ,cond (return)) (progn ,@body)))

 
 (compile-time-defun do-case2-like (kind vform clauses)
   "Helper function for `case2' and `ecase2'."
 
 (compile-time-defun do-case2-like (kind vform clauses)
   "Helper function for `case2' and `ecase2'."


@@ -179,29 +246,59 @@
        (,kind ,scrutinee
         ,@(mapcar (lambda (clause)
                     (destructuring-bind
        (,kind ,scrutinee
         ,@(mapcar (lambda (clause)
                     (destructuring-bind

-                        (cases (&optional var) &rest forms)
+                        (cases (&optional varx vary) &rest forms)

                         clause
                       `(,cases
                         clause
                       `(,cases

-                        ,@(if var
-                              (list `(let ((,var ,argument)) ,@forms))
+                        ,@(if varx
+                              (list `(let ((,(or vary varx) ,argument)
+                                           ,@(and vary
+                                                  `((,varx ,scrutinee))))
+                                       ,@forms))

                               forms))))
                   clauses)))))
 
 (defmacro case2 (vform &body clauses)
   "VFORM is a form which evaluates to two values, SCRUTINEE and ARGUMENT.
                               forms))))
                   clauses)))))
 
 (defmacro case2 (vform &body clauses)
   "VFORM is a form which evaluates to two values, SCRUTINEE and ARGUMENT.

-   The CLAUSES have the form (CASES ([VAR]) FORMS...), where a standard
-   `case' clause has the form (CASES FORMS...).  The `case2' form evaluates
-   the VFORM, and compares the SCRUTINEE to the various CASES, in order, just
-   like `case'.  If there is a match, then the corresponding FORMs are
-   evaluated with VAR (if specified) bound to the value of ARGUMENT."
+   The CLAUSES have the form (CASES ([[SCRUVAR] ARGVAR]) FORMS...), where a
+   standard `case' clause has the form (CASES FORMS...).  The `case2' form
+   evaluates the VFORM, and compares the SCRUTINEE to the various CASES, in
+   order, just like `case'.  If there is a match, then the corresponding
+   FORMs are evaluated with ARGVAR bound to the ARGUMENT and SCRUVAR bound to
+   the SCRUTINEE (where specified).  Note the bizarre defaulting behaviour:
+   ARGVAR is less optional than SCRUVAR."

   (do-case2-like 'case vform clauses))
 
 (defmacro ecase2 (vform &body clauses)
   "Like `case2', but signals an error if no clause matches the SCRUTINEE."
   (do-case2-like 'ecase vform clauses))
 
   (do-case2-like 'case vform clauses))
 
 (defmacro ecase2 (vform &body clauses)
   "Like `case2', but signals an error if no clause matches the SCRUTINEE."
   (do-case2-like 'ecase vform clauses))
 

+(defmacro setf-default (&rest specs &environment env)
+  "Like setf, but only sets places which are currently nil.
+
+   The arguments are an alternating list of PLACEs and DEFAULTs.  If a PLACE
+   is nil, the DEFAULT is evaluated and stored in the PLACE; otherwise the
+   default is /not/ stored.  The result is the (new) value of the last
+   PLACE."
+  (labels ((doit (specs)
+            (cond ((null specs) nil)
+                  ((null (cdr specs))
+                   (error "Odd number of arguments for SETF-DEFAULT."))
+                  (t
+                   (let ((place (car specs))
+                         (default (cadr specs))
+                         (rest (cddr specs)))
+                     (multiple-value-bind
+                         (vars vals store-vals writer reader)
+                         (get-setf-expansion place env)
+                       `(let* ,(mapcar #'list vars vals)
+                          (or ,reader
+                              (multiple-value-bind ,store-vals ,default
+                                ,writer))
+                          ,@(and rest (list (doit rest))))))))))
+    (doit specs)))
+

 ;;;--------------------------------------------------------------------------
 ;;;--------------------------------------------------------------------------

-;;; with-places
+;;; Capturing places as symbols.

 
 (defmacro %place-ref (getform setform newtmp)
   "Grim helper macro for with-places."
 
 (defmacro %place-ref (getform setform newtmp)
   "Grim helper macro for with-places."


@@ -212,53 +309,78 @@
   "Grim helper macro for with-places."
   (values nil nil newtmp setform getform))
 
   "Grim helper macro for with-places."
   (values nil nil newtmp setform getform))
 

-(defmacro with-places ((&key environment) places &body body)
-  "A hairy helper, for writing setf-like macros.  PLACES is a list of binding
-   pairs (VAR PLACE), where PLACE defaults to VAR.  The result is that BODY
-   is evaluated in a context where each VAR is bound to a gensym, and in the
-   final expansion, each of those gensyms will be bound to a symbol-macro
-   capable of reading or setting the value of the corresponding PLACE."
-  (if (null places)
-      `(progn ,@body)
-      (let*/gensyms (environment)
-        (labels
-            ((more (places)
-               (let ((place (car places)))
-                 (with-gensyms (tmp valtmps valforms
-                                    newtmps setform getform)
-                   `((let ((,tmp ,(cadr place))
-                           (,(car place)
-                            (gensym ,(symbol-name (car place)))))
-                       (multiple-value-bind
-                           (,valtmps ,valforms
-                            ,newtmps ,setform ,getform)
-                           (get-setf-expansion ,tmp
-                                               ,environment)
-                         (list 'let*
-                               (mapcar #'list ,valtmps ,valforms)
-                               `(symbol-macrolet ((,,(car place)
-                                                   (%place-ref ,,getform
-                                                               ,,setform
-                                                               ,,newtmps)))
-                                  ,,@(if (cdr places)
-                                         (more (cdr places))
-                                         body))))))))))
-          (car (more (mapcar #'pairify (listify places))))))))
+(defmacro with-places (clauses &body body &environment env)
+  "Define symbols which refer to `setf'-able places.
+
+   The syntax is similar to `let'.  The CLAUSES are a list of (NAME PLACE)
+   pairs.  Each NAME is defined as a symbol-macro referring to the
+   corresponding PLACE: a mention of the NAME within the BODY forms extracts
+   the current value(s) of the PLACE, while a `setf' (or `setq', because
+   symbol macros are strange like that) of a NAME updates the value(s) in the
+   PLACE.  The returned values are those of the BODY, evaluated as an
+   implicit `progn'."
+
+  (let ((temp-binds nil)
+       (macro-binds nil))
+    (dolist (clause clauses)
+      (destructuring-bind (name place) clause
+       (multiple-value-bind (valtmps valforms newtmps setform getform)
+           (get-setf-expansion place env)
+         (setf temp-binds
+               (nconc (nreverse (mapcar #'list valtmps valforms))
+                      temp-binds))
+         (push `(,name (%place-ref ,getform ,setform ,newtmps))
+               macro-binds))))
+    `(let (,@(nreverse temp-binds))
+       (symbol-macrolet (,@(nreverse macro-binds))
+        ,@body))))
+
+(defmacro with-places/gensyms (clauses &body body)
+  "A kind of a cross between `with-places' and `let*/gensyms'.
+
+   This is a hairy helper for writing `setf'-like macros.  The CLAUSES are a
+   list of (NAME [PLACE]) pairs, where the PLACE defaults to NAME, and a
+   bare NAME may be written in place of the singleton list (NAME).  The
+   PLACEs are evaluated.
+
+   The BODY forms are evaluated as an implicit `progn', with each NAME bound
+   to a gensym, to produce a Lisp form, called the `kernel'.  The result of
+   the `with-places/gensyms' macro is then itself a Lisp form, called the
+   `result'.
+
+   The effect of evaluating the `result' form is to evaluate the `kernel'
+   form with each of the gensyms stands for the value(s) stored in the
+   corresponding PLACE; a `setf' (or `setq') of one of the gensyms updates
+   the value(s) in the corresponding PLACE.  The values returned by the
+   `result' form are the values returned by the `kernel'."
+
+  (let* ((clauses (mapcar #'pairify clauses))
+        (names (mapcar #'car clauses))
+        (places (mapcar #'cadr clauses))
+        (gensyms (mapcar (lambda (name) (gensym (symbol-name name)))
+                         names)))
+    ``(with-places (,,@(mapcar (lambda (gensym place)
+                                ``(,',gensym ,,place))
+                              gensyms places))
+       ,(let (,@(mapcar (lambda (name gensym)
+                          `(,name ',gensym))
+                        names gensyms))
+          ,@body))))

 
 ;;;--------------------------------------------------------------------------
 ;;; Update-in-place macros built using with-places.
 
 
 ;;;--------------------------------------------------------------------------
 ;;; Update-in-place macros built using with-places.
 

-(defmacro update-place (op place arg &environment env)
-  "Update PLACE with the value of OP PLACE ARG, returning the new value."
-  (with-places (:environment env) (place)
-    `(setf ,place (,op ,place ,arg))))
+(defmacro update-place (op place &rest args)
+  "Update PLACE with (OP PLACE . ARGS), returning the new value."
+  (with-places/gensyms (place)
+    `(setf ,place (,op ,place ,@args))))

 
 

-(defmacro update-place-after (op place arg &environment env)
-  "Update PLACE with the value of OP PLACE ARG, returning the old value."
-  (with-places (:environment env) (place)
+(defmacro update-place-after (op place &rest args)
+  "Update PLACE with (OP PLACE . ARGS), returning the old value."
+  (with-places/gensyms (place)

     (with-gensyms (x)
       `(let ((,x ,place))
     (with-gensyms (x)
       `(let ((,x ,place))

-        (setf ,place (,op ,x ,arg))
+        (setf ,place (,op ,x ,@args))

         ,x))))
 
 (defmacro incf-after (place &optional (by 1))
         ,x))))
 
 (defmacro incf-after (place &optional (by 1))


@@ -288,9 +410,9 @@
       (get-setf-expansion place env)
     `(let* (,@(mapcar #'list valtmps valforms))
        (make-loc (lambda () ,getform)
       (get-setf-expansion place env)
     `(let* (,@(mapcar #'list valtmps valforms))
        (make-loc (lambda () ,getform)

-                 (lambda (,@newtmps) ,setform)))))
+                (lambda (,@newtmps) ,setform)))))

 
 

-(declaim (inline loc (setf loc)))
+(declaim (inline ref (setf ref)))

 
 (defun ref (loc)
   "Fetch the value referred to by a locative."
 
 (defun ref (loc)
   "Fetch the value referred to by a locative."