Skip to content
Snippets Groups Projects
lisp-utilities.lisp 56.9 KiB
Newer Older
cer's avatar
cer committed
;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Package: CLIM-UTILS; Base: 10; Lowercase: Yes -*-
cer's avatar
cer committed

;; $fiHeader: lisp-utilities.lisp,v 1.29 93/03/19 09:47:22 cer Exp $
cer's avatar
cer committed

(in-package :clim-utils)

cer's avatar
cer committed
"Copyright (c) 1990, 1991, 1992 Symbolics, Inc.  All rights reserved.
cer's avatar
cer committed
 Portions copyright (c) 1988, 1989, 1990 International Lisp Associates."

;;; Define useful tools that don't exist in vanilla CL.

(defvar *keyword-package* (find-package :keyword))

cer's avatar
cer committed
;;; FUNCTIONP doesn't do what we want and there isn't any other CL function
cer's avatar
cer committed
;;; that does. 
(defun funcallable-p (thing)
  (etypecase thing
    (symbol (fboundp thing))
    (function t)))

cer's avatar
cer committed
;;; ONCE-ONLY does the same thing as it does in zetalisp.  I should have just
;;; lifted it from there but I am honest.  Not only that but this one is
;;; written in Common Lisp.  I feel a lot like bootstrapping, or maybe more
;;; like rebuilding Rome.
cer's avatar
cer committed
;; Variables can have &ENVIRONMENT ENV in it
(defmacro once-only (variables &body body)
cer's avatar
cer committed
  (let ((gensym-var (gensym))
        (run-time-vars (gensym))
        (run-time-vals (gensym))
        (expand-time-val-forms ()))
cer's avatar
 
cer committed
    (multiple-value-bind (variables #+(or Genera Minima) environment-var)
cer's avatar
cer committed
	(decode-once-only-arguments variables)
      (dolist (var variables)
	(push `(if (or (constantp ,var #+(or Genera Minima) ,environment-var)
		       (symbolp ,var))
		   ,var
		   (let ((,gensym-var (gensym)))
		     (push ,gensym-var ,run-time-vars)
		     (push ,var ,run-time-vals)
		     ,gensym-var))
	      expand-time-val-forms))
      `(let* (,run-time-vars
	      ,run-time-vals
	      (wrapped-body
		(let ,(mapcar #'list variables (reverse expand-time-val-forms))
		  ,@body)))
	 `(let ,(mapcar #'list (reverse ,run-time-vars)
			       (reverse ,run-time-vals))
	    ,wrapped-body)))))

(eval-when (compile load eval)
(defun decode-once-only-arguments (variables)
  (let ((vars nil)
	(env nil)
	(vl variables))
    (loop
      (when (null vl) 
	(return-from decode-once-only-arguments
	  (values (nreverse vars) env)))
      (let ((var (pop vl)))
	(if (eq var '&environment)
	    (setq env (pop vl))
	    (push var vars))))))
)	;eval-when

cer's avatar
cer committed

(defmacro dorest ((var list &optional (by 'cdr)) &body body)
  `(do ((,var ,list (,by ,var)))
       ((null ,var) nil)
     ,@body))

cer's avatar
cer committed
;; Why is there DOLIST in CL but no DOVECTOR or DOSEQ{uence}
(defmacro dovector ((var vector &key (start 0) end from-end simple-p) &body body)
  (unless (constantp simple-p)
    (setq simple-p nil)
    (warn "SIMPLE-P should be a constant, ignoring it"))
  (when (and simple-p (null end))
    (warn "When SIMPLE-P is T, you must supply :END"))
  (let ((fvector '#:vector)
	(startd  '#:start)
	(endd    '#:end)
	(limit   '#:limit)
	(variable (if (atom var) var (first var)))
	(index    (if (atom var) '#:index (second var)))
	(aref (if simple-p 'svref 'aref)))
    `(block nil
       (let* ((,fvector ,vector)
	      (,startd ,start)
	      (,endd ,(if simple-p `,end `(or ,end (length ,fvector))))
	      (,index (if ,from-end (1- ,endd) ,startd))
	      (,limit (if ,from-end (1- ,startd) ,endd)))
	 (declare (type fixnum ,endd ,index ,limit)
		  ;; Turn on the afterburners...
		  (optimize (speed 3) (safety 0))
		  ,(if simple-p
		       `(type simple-vector ,fvector)
		       `(type vector ,fvector)))
	 (loop
	   (when (= ,index ,limit) (return))
	   (let ((,variable (,aref ,fvector ,index)))
	     ,@body)
	   (,(if from-end 'decf 'incf) ,index))))))

(defmacro doseq ((var sequence) &body body)
  (let ((fcn (gensymbol 'doseq)))
    `(flet ((,fcn (,var) ,@body))
       (etypecase ,sequence
	 (list (dolist (thing ,sequence) (,fcn thing)))
	 (vector (dovector (thing ,sequence) (,fcn thing)))))))

cer's avatar
cer committed

cer's avatar
cer committed
;;; Stuff for dealing with CLIM coordinates
cer's avatar
cer committed

cer's avatar
cer committed
(deftype coordinate () 
cer's avatar
cer committed
  #+use-float-coordinates  'single-float
  #+use-fixnum-coordinates 'fixnum
  #-(or use-float-coordinates use-fixnum-coordinates) 't)
cer's avatar
cer committed

cer's avatar
cer committed
;; Convert a number of arbitrary type into a COORDINATE
(defmacro coordinate (x &optional (round-direction 'round))
cer's avatar
cer committed
  #-use-fixnum-coordinates (declare (ignore round-direction))
cer's avatar
cer committed
  #+use-float-coordinates `(the coordinate (float ,x 0f0))
cer's avatar
cer committed
  #+use-fixnum-coordinates (ecase round-direction
			     (round
cer's avatar
cer committed
			       #+(or Allegro Lucid) `(the fixnum (round ,x))
			       #-(or Allegro Lucid) `(the fixnum (values (floor (+ ,x .5f0)))))
cer's avatar
cer committed
			     (floor
			       `(the fixnum (values (floor ,x))))
			     (ceiling
			       `(the fixnum (values (ceiling ,x)))))
  #-(or use-float-coordinates use-fixnum-coordinates) `,x)
cer's avatar
cer committed

(defconstant +largest-coordinate+
cer's avatar
cer committed
	     #+use-float-coordinates (float (expt 10 (floor (log most-positive-fixnum 10))) 0f0)
cer's avatar
cer committed
	     #+use-fixnum-coordinates most-positive-fixnum
	     #-(or use-float-coordinates use-fixnum-coordinates) most-positive-fixnum)
cer's avatar
cer committed

cer's avatar
cer committed
(defmacro integerize-single-float-coordinate (coord)
  `(the fixnum (values (floor (+ (the single-float ,coord) .5f0)))))

(defmacro integerize-double-float-coordinate (coord)
  `(the fixnum (values (floor (+ (the double-float ,coord) .5d0)))))

(defmacro integerize-float-coordinate (coord)
  `(the fixnum (values (floor (+ (the float ,coord) .5)))))

cer's avatar
cer committed
#+(or Genera Minima)
(defun-inline fix-coordinate (coord)
  (if (typep coord 'fixnum)
      coord
      (the fixnum (values (floor (+ coord .5f0))))))

#+Allegro
(defmacro fix-coordinate (coord)
  ;; ROUND is good enough in Allegro for 90% of the speed, and it's less filling.
  `(the fixnum (round ,coord)))

#-(or Genera Minima Allegro)
(defun fix-coordinate (coord)
cer's avatar
cer committed
  (etypecase coord
    (fixnum coord)
    (single-float
      (integerize-single-float-coordinate coord))
    (double-float
      (integerize-double-float-coordinate coord))
    (float
      (integerize-float-coordinate coord))
    (ratio
      (values (floor (+ coord 1/2))))
    ;; disallow bignums and other types of numbers
    ))

cer's avatar
cer committed
(defmacro fix-coordinates (&body coords)
cer's avatar
cer committed
  `(progn
cer's avatar
cer committed
     ,@(mapcar #'(lambda (x) `(setq ,x (fix-coordinate ,x)))
cer's avatar
cer committed
	       coords)))

cer's avatar
cer committed
;; Assume that the value is a fixnum and that the result is a fixnum.
(defmacro fast-abs (int)
cer's avatar
cer committed
  (let ((value '#:value))
    `(let ((,value ,int))
       (declare (fixnum ,value))
       (the fixnum (if (< ,value 0) (the fixnum (- 0 ,value)) ,value)))))

cer's avatar
cer committed

cer's avatar
cer committed
;; COORDINATE-PAIRS is a list of pairs of coordinates.
;; The coordinates must be of type COORDINATE
(defmacro translate-coordinates (x-delta y-delta &body coordinate-pairs)
  (once-only (x-delta y-delta)
    `(progn
       ,@(let ((forms nil))
	   (dorest (pts coordinate-pairs cddr)
	     (push `(setf ,(first pts)  
			  (the coordinate (+ ,(first pts)  ,x-delta))) forms)
	     (push `(setf ,(second pts)
			  (the coordinate (+ ,(second pts) ,y-delta))) forms))
	   (nreverse forms)))))

cer's avatar
cer committed
;; Warning: this macro evaluates its position arguments multiple times
cer's avatar
cer committed
(defmacro convert-to-device-coordinates (transform &body positions)
  (assert (evenp (length positions)) (positions)
cer's avatar
cer committed
	  "There must be an even number of elements in ~S" positions)
  (assert (every #'symbolp positions) (positions)
	  "Each of the positions must be a variable in ~S" positions)
cer's avatar
cer committed
  (let ((forms nil))
cer's avatar
cer committed
    (loop
      (when (null positions)
	(return `(progn ,@(nreverse forms))))
      (let* ((x (pop positions))
	     (y (pop positions)))
cer's avatar
cer committed
	(push `(progn
		 (multiple-value-setq (,x ,y) 
		   (transform-position ,transform ,x ,y))
cer's avatar
cer committed
		 (fix-coordinates ,x ,y))
cer's avatar
cer committed
	      forms)))))

cer's avatar
cer committed
;; Warning: this macro evaluates its position arguments multiple times
(defmacro convert-to-device-distances (transform &body distances)
  (assert (evenp (length distances)) (distances)
	  "There must be an even number of elements in ~S" distances)
  (assert (every #'symbolp distances) (distances)
	  "Each of the distances must be a variable in ~S" distances)
cer's avatar
cer committed
  (let ((forms nil))
cer's avatar
cer committed
    (loop
cer's avatar
cer committed
      (when (null distances)
cer's avatar
cer committed
	(return `(progn ,@(nreverse forms))))
cer's avatar
cer committed
      (let* ((x (pop distances))
	     (y (pop distances)))
	(push `(progn
		 (multiple-value-setq (,x ,y) 
		   (transform-distance ,transform ,x ,y))
		 (fix-coordinates ,x ,y))
cer's avatar
cer committed
	      forms)))))


cer's avatar
cer committed
;;; Characters that are ordinary text rather than potential input editor commands.
;;; Note that GRAPHIC-CHAR-P is true of #\Space
(defun ordinary-char-p (char)
  (and #+Allegro (zerop (char-bits char))
       (or (graphic-char-p char)
	   ;; For characters, CHAR= and EQL are the same.  Not true of EQ!
	   (eql char #\Newline)
	   (eql char #\Return)
	   (eql char #\Tab))))

(defun whitespace-char-p (char)
  (and (characterp char)
       (or (char-equal char #\Space)
	   (eql char #\Tab))))

cer's avatar
cer committed
;;; Make sure we don't get screwed by environments like Coral's that
;;; have *print-case* set to :downcase by default.
cer's avatar
cer committed
#-ANSI-90
cer's avatar
cer committed
(defvar *standard-io-environment-val-cache* nil)

cer's avatar
cer committed
#-ANSI-90
cer's avatar
cer committed
(defun standard-io-environment-vars-and-vals ()
  (unless *standard-io-environment-val-cache*
    (setq *standard-io-environment-val-cache*
	  (list 10				;*read-base*
		(copy-readtable nil)		;*readtable*
cer's avatar
cer committed
		(find-package :user)		;*package*
cer's avatar
cer committed
		t				;*print-escape*
		nil				;*print-pretty*
		nil				;*print-radix*
		10				;*print-base*
		nil				;*print-circle*
		nil				;*print-level*
		nil				;*print-length*
		:upcase				;*print-case*
		t				;*print-gensym*
		t				;*print-array*
		nil)))				;*read-suppress*
  (values
    '(*read-base* *readtable* *package* *print-escape* *print-pretty*
      *print-radix* *print-base* *print-circle* *print-level* *print-length*
      *print-case* *print-gensym* *print-array* *read-suppress*)
    *standard-io-environment-val-cache*))

(defmacro with-standard-io-environment (&body body)
cer's avatar
cer committed
  #-ANSI-90
cer's avatar
cer committed
  `(multiple-value-bind (vars vals)
       (standard-io-environment-vars-and-vals)
     (progv vars vals
       ,@body))
cer's avatar
cer committed
  #+ANSI-90
cer's avatar
cer committed
  `(with-standard-io-syntax ,@body))

cer's avatar
cer committed
#-(or ANSI-90 Genera)
cer's avatar
cer committed
(defmacro with-standard-io-syntax (&body body)
  `(with-standard-io-environment ,@body))

cer's avatar
cer committed
;; Define this so we don't have to deal with stupid warnings about
;; the iteration variable being used, or not used, or what not
(defmacro repeat (n &body body)
  (let ((i '#:i))
    `(dotimes (,i ,n)
       #-(or Minima Genera Allegro) (declare (ignore i))
       ,@body)))

cer's avatar
cer committed

;;; Have to provide CLIM-LISP:WITH-OPEN-STREAM, because it needs to use a different
;;; version of CLOSE.  We need this for printer streams, at least.

;;; This is a little more complicated than it absolutely needs to be.  The idea is
;;; that there should be as short a timing window during which the stream to be closed
;;; is open but we don't have our hands on it to pass to CLOSE.  We therefore don't
;;; want to bind the user's variable to the stream outside of the unwind-protect, but
;;; rather want to bind it inside.  The reason we need the temporary variable is
;;; because the user might declare the stream variable to be of type STREAM, which
;;; would not be true during the brief interval after the binding and before the
;;; setting of that variable.  I believe this implementation of WITH-OPEN-STREAM to
;;; have as small a timing window, and to be as semantically correct as possible. 

cer's avatar
cer committed
#+(or (not CLIM-uses-Lisp-stream-functions)	;Do this if we provide CLOSE function
      Genera					; Sigh.  CLOSE also shadowed for Genera.
      CCL-2)					; Sigh.  CLOSE also shadowed for CCL-2.
cer's avatar
cer committed
(defmacro with-open-stream ((stream-variable construction-form) &body body &environment env)
  (let ((aborted-variable (gensymbol 'aborted-p))
	(temporary-stream-variable (gensymbol 'stream)))
    (multiple-value-bind (documentation declarations actual-body)
	(extract-declarations body env)
      (declare (ignore documentation))
      `(let (,temporary-stream-variable
	     (,aborted-variable t))
       (unwind-protect
	   (multiple-value-prog1
	     (progn (setq ,temporary-stream-variable ,construction-form)
		    (let ((,stream-variable ,temporary-stream-variable))
		      ,@declarations
		      ,@actual-body))
	     (setf ,aborted-variable nil))
	 (when ,temporary-stream-variable
	   (close ,temporary-stream-variable :abort ,aborted-variable)))))))

(defun follow-synonym-stream (stream)
  #+Genera (si:follow-syn-stream stream)
cer's avatar
cer committed
  #+(and ANSI-90 (not Genera)) (typecase stream
cer's avatar
cer committed
				 (synonym-stream
				   (symbol-value (synonym-stream-symbol stream)))
				 (t stream))
cer's avatar
cer committed
  #-(or Genera ANSI-90) stream)
cer's avatar
cer committed

cer's avatar
cer committed
#-(or Genera ANSI-90) 
cer's avatar
cer committed
(eval-when (compile)
  (warn "You haven't defined ~S for this implementation.  A stub has been provided."
	'follow-synonym-stream))

(defun fintern (format-string &rest format-args)
  (declare (dynamic-extent format-args))
  (intern (let ((package *package*))
	    (with-standard-io-environment
	      (let ((*package* package))
		(apply #'lisp:format () format-string format-args))))))

(defvar *gensymbol* 0)
cer's avatar
cer committed

(eval-when (compile load eval)
cer's avatar
cer committed
(defun gensymbol (&rest parts)
  (declare (dynamic-extent parts))
  (when (null parts) (setf parts '(gensymbol)))
  (make-symbol (lisp:format nil "~{~A-~}~D" parts (incf *gensymbol*))))
cer's avatar
cer committed
)	;eval-when
cer's avatar
cer committed

;;; For macro writers; you can have your GENSYMBOLs start at 1.  Use
;;; this in the macro, not in its expansion...
(defmacro with-related-gensymbols (&body body)
cer's avatar
cer committed
  `(let ((*gensymbol* 0))
     ,@body))
cer's avatar
cer committed

;; Used in generating internal function and method names.
;; (remove-word-from-string "com-" 'com-show-file) => "SHOW-FILE"
;; Always returns a new string that can be bashed to your heart's content
(defun remove-word-from-string (word string-or-symbol &optional only-from-beginning-p)
  (let ((string (etypecase string-or-symbol
		  (string string-or-symbol)
		  (symbol (string string-or-symbol)))))
    (let ((word-position (search word string :test #'char-equal)))
      (cond ((null word-position)
	     (concatenate 'string string))
	    ((zerop word-position)
	     (subseq string (length word)))
	    (only-from-beginning-p
	     (concatenate 'string string))
	    (t
	     (concatenate 'string
			  (subseq string 0 word-position)
			  (subseq string (+ word-position (length word)))))))))

;;; Why PUSHNEW doesn't do this is beyond me.
(defmacro push-unique (item reference &rest args &key test test-not key)
  (declare (ignore test test-not))
  `(let* ((evaled-item ,item)
	  (evaled-reference ,reference)
	  (element (find ,(if key `(funcall ,key evaled-item) 'evaled-item)
			 evaled-reference ,@args)))
     (setf ,reference
	   (if element
	       (substitute evaled-item element evaled-reference)
	       (cons evaled-item evaled-reference)))))

(defmacro catch-if (condition tag &body body)
cer's avatar
 
cer committed
  `(catch (if ,condition ,tag '#:tag-for-catch-if)
cer's avatar
cer committed
     ,@body))

;#+Genera
;(defmacro letf-globally (places-and-vals &body body)
;  `(sys:letf* ,places-and-vals ,@body))
;
;#-Genera
(defmacro letf-globally (places-and-vals &body body)
  ;; I don't want to use LETF-globally, mind you, but I can't easily implement
  ;; LETF{-not-globally} without something like sys:%bind-location.
  ;; Of course, this one is really LETF*-GLOBALLY, but don't tell anyone.
  ;; A minor optimization: when you bind something to itself or don't
  ;;  say what to bind it to, it doesn't get SETF'd, since it isn't
  ;;  being changed.
  (when (null places-and-vals)
    (return-from letf-globally `(progn ,@body)))
  (let ((let-forms nil)
	(set-forms nil)
	(unwind-forms nil))
    ;; remember that we can't use SCL:LOOP
    (map nil #'(lambda (place-and-val)
		 (let* ((place (pop place-and-val))
			(val-p (not (null place-and-val)))
			(val (and val-p (pop place-and-val)))
			(temp-var (gensymbol 'letf-globally-temp)))
		   (when (and val-p (equal place val)) (setf val-p nil))   ;bind to itself?
		   (push `(,temp-var ,place) let-forms)
		   (when val-p (push place set-forms) (push val set-forms))
		   (push temp-var unwind-forms) (push place unwind-forms)))
	 places-and-vals)
    `(let ,(nreverse let-forms)
       (unwind-protect
	   (progn (setf ,@(nreverse set-forms)) ,@body)
	 (setf ,@unwind-forms)))))		;Undo backwards.


(defmacro letf-globally-if (condition places-and-vals &body body)
  #+Genera (declare (zwei:indentation 1 4 2 1))
  (when (null places-and-vals)
    (return-from letf-globally-if `(progn ,@body)))
  (let ((let-forms nil)
	(set-forms nil)
	(unwind-forms nil)
	(condition-value (gensymbol 'condition)))
    (map nil #'(lambda (place-and-val)
		 (let* ((place (pop place-and-val))
			(val-p (not (null place-and-val)))
			(val (and val-p (pop place-and-val)))
			(temp-var (gensymbol 'letf-globally-temp)))
		   (when (and val-p (equal place val)) (setf val-p nil))
		   (push `(,temp-var (and ,condition-value ,place)) let-forms)
		   (when val-p (push place set-forms) (push val set-forms))
		   (push temp-var unwind-forms) (push place unwind-forms)))
	 places-and-vals)
    `(let ((,condition-value ,condition))
       (let ,(nreverse let-forms)
	 (unwind-protect
	     (progn (when ,condition-value (setf ,@(nreverse set-forms)))
		    ,@body)
	   (when ,condition-value (setf ,@unwind-forms)))))))

cer's avatar
cer committed
#-(and ANSI-90 (not Allegro) (not Symbolics))
cer's avatar
cer committed
(eval-when (compile load eval)
  (proclaim '(declaration non-dynamic-extent)))

cer's avatar
cer committed
#+(and ANSI-90 (not Allegro) (not Symbolics))
cer's avatar
cer committed
(define-declaration non-dynamic-extent (spec env)
  (let ((vars (rest spec))
        (result nil))
    (dolist (v vars)
      (block process-var
        (multiple-value-bind (type local info)
                             (variable-information v env)
          (declare (ignore local))
          (case type
            (:lexical
             (when (cdr (assoc 'dynamic-extent info))
               (warn "The variable ~S has been declared ~S,~%it cannot be now declared ~S"
                     v 'dynamic-extent 'non-dynamic-extent)
               (return-from process-var))
             (when (cdr (assoc 'ignore info))
               (warn "The variable ~S has been declared ~S,~%it cannot be now declared ~S"
                     v 'ignore 'non-dynamic-extent)
               (return-from process-var))
             (push `(,v dynamic-extent nil) result))
            (otherwise
             (warn "~S is not a lexical variable, it cannot be declared ~S."
                   v 'non-dynamic-extent))))))
    (values :variable (nreverse result))))


(defun time-elapsed-p (delta-seconds start-time)
  (let ((internal-units (* delta-seconds internal-time-units-per-second))
	(internal-time (get-internal-real-time)))
    ;; don't worry about the clock wrapping around
    (> (- internal-time start-time) internal-units)))

(defmacro with-timeout-predicate (((predicate-fun old-predicate)
                                   (timeout-var timeout-val)) &body body)
  (let ((start-time (gensymbol "START-TIME"))
        (delta-time (gensymbol "DELTA-TIME")))
    `(let* ((,delta-time ,timeout-val) ;; Eval it only once...
            (,start-time (when  ,delta-time
                           (get-internal-time-units-per-second)))
            (,timeout-var nil))
       (flet ((,predicate-fun ()
                 (cond ((,old-predicate)
                        t)
                       ((and ,delta-time
                             (time-elapsed-p ,delta-time ,start-time))
                        (setq ,timeout-var t)
                        t)
                       (t nil))))
         ,@body))))


;;; Bindings on the stack.  A work in progress.
;;; Which Lisps support this?

cer's avatar
cer committed
;; I suppose this could be done with IMPORT
#+Genera
cer's avatar
cer committed
(progn
(defmacro with-stack-list ((var &rest elements) &body body)
cer's avatar
cer committed
  `(scl:with-stack-list (,var ,@elements) ,@body))
cer's avatar
cer committed

(defmacro with-stack-list* ((var &rest elements) &body body)
cer's avatar
cer committed
  `(scl:with-stack-list* (,var ,@elements) ,@body))
cer's avatar
cer committed

(defun-inline evacuate-list (list)
  (if (and (sys:%pointerp list)
	   (not (or (sys:%pointer-lessp list sys:%control-stack-low)
		    (sys:%pointer-lessp (progn #+3600  sys:%control-stack-limit
					       #+imach (sys:%read-internal-register
							 sys:%register-control-stack-limit))
					list))))
      (copy-list list)
      list))
cer's avatar
cer committed
)	;#+Genera

#+Cloe-Runtime
(progn
(defmacro with-stack-list ((var &rest elements) &body body)
  `(sys::with-stack-list (,var ,@elements) ,@body))

(defmacro with-stack-list* ((var &rest elements) &body body)
  `(sys::with-stack-list* (,var ,@elements) ,@body))
cer's avatar
cer committed

#+Cloe-Runtime
(defun-inline evacuate-list (list)
cer's avatar
cer committed
  (if (logtest (the fixnum (sys::gcltype list)) sys::lo$k-_astack)
cer's avatar
cer committed
      (copy-list list)
      list))
cer's avatar
cer committed
)	;#+Cloe-Runtime
cer's avatar
cer committed

cer's avatar
cer committed
#+Allegro
cer's avatar
cer committed
(progn
(defmacro with-stack-list ((var &rest elements) &body body)
  `(let ((,var (list ,@elements)))
     (declare (dynamic-extent ,var))
     ,@body))

(defmacro with-stack-list* ((var &rest elements) &body body)
  `(let ((,var (list* ,@elements)))
     (declare (dynamic-extent ,var))
     ,@body))

#-(version>= 4 2 7)
(progn
  #+(and (target-class h r t) (version>= 4 1))
  ;; Hack to allow compiling CLIM without a dcl.
  (eval-when (eval compile)
    comp::(def-qc-ll-fcn qc-ll_<u :<u
	    (with-u-computed
		(qc-boolean-compare :ltu u target cc))))

  #+(and (target-class h) (version>= 4 1))
  (defun-inline evacuate-list (list)
    ;; the HP's stack grows toward higher memory
    (if (comp::ll :<u (comp::ll :glob-c-value 'sys::c_stackmax) list)
	(copy-list list)
      list))
cer's avatar
cer committed

  #+(and (target-class r t) (version>= 4 1))
  (defun-inline evacuate-list (list)
    (if (comp::ll :<u (comp::ll :register :stack-pointer) list)
	(copy-list list)
      list))
cer's avatar
 
cer committed

  #-(and (target-class h r t) (version>= 4 1))
  (defmacro evacuate-list (list) `,list)
  )
cer's avatar
cer committed

#+(version>= 4 2 7)
(defun-inline evacuate-list (list)
    ;; the HP's stack grows toward higher memory
    (if (excl::stack-allocated-p list)
	(copy-list list)
      list))
cer's avatar
cer committed

cer's avatar
cer committed
)	;#+Allegro
cer's avatar
cer committed

cer's avatar
cer committed
#+CCL-2
cer's avatar
cer committed
(progn
(defmacro with-stack-list ((var &rest elements) &body body)
  `(let ((,var (list ,@elements)))
     (declare (dynamic-extent ,var))
     ,@body))

(defmacro with-stack-list* ((var &rest elements) &body body)
  `(let ((,var (list* ,@elements)))
     (declare (dynamic-extent ,var))
     ,@body))

(defun evacuate-list (list)
cer's avatar
cer committed
  ;;--- Dunno if this is the right function to be calling
  ;;--- but it seems to give the right answers.
cer's avatar
cer committed
  (cond ((and (ccl::stack-area-endptr list)
              (listp list))
         (copy-list list))
        (t list)))
cer's avatar
cer committed
)	;#+CCL-2
cer's avatar
cer committed

cer's avatar
cer committed
#-(or Genera Cloe-Runtime Allegro CCL-2)
cer's avatar
cer committed
(progn
(defmacro with-stack-list ((var &rest elements) &body body)
  `(let ((,var (list ,@elements)))
     ,@body))

(defmacro with-stack-list* ((var &rest elements) &body body)
  `(let ((,var (list* ,@elements)))
     ,@body))

;; Since with-stack-list does nothing, this doesn't either.
cer's avatar
cer committed
;; When stack-consing works for non-Genera/Cloe, make this do something.
cer's avatar
cer committed
(defmacro evacuate-list (list)
  `,list)
cer's avatar
cer committed
)	;#-(or Genera Cloe-Runtime Allegro)
cer's avatar
cer committed

#+Genera
(defmacro with-stack-array ((name size &rest options) &body body)
  `(sys:with-stack-array (,name ,size ,@options) ,@body))

#-Genera
(defmacro with-stack-array ((name size &rest options) &body body)
  `(let ((,name (make-stack-array ,size ,@options)))
     ,@body))

#-Genera	;in case anybody wants to implement this...
cer's avatar
cer committed
(defun-inline make-stack-array (size &rest options)
cer's avatar
cer committed
  (declare (dynamic-extent options))
  (apply #'make-array size options))

cer's avatar
cer committed
#+(or Genera Cloe-Runtime)
(defmacro with-keywords-removed ((new-list list keywords-to-remove) &body body)
cer's avatar
cer committed
  (declare (zwei:indentation 0 3 1 1))
cer's avatar
cer committed
  `(si::with-rem-keywords (,new-list ,list ,keywords-to-remove)
     ,@body))

cer's avatar
cer committed
#+(or Genera Cloe-Runtime)
(defun remove-keywords (list keywords-to-remove)
cer's avatar
cer committed
  (si::rem-keywords list keywords-to-remove))

#-(or Genera Cloe-Runtime)
(progn 
cer's avatar
cer committed
(defmacro with-keywords-removed ((new-list list keywords-to-remove) &body body)
  `(let ((,new-list (remove-keywords ,list ,keywords-to-remove)))
cer's avatar
cer committed
     ,@body))

cer's avatar
cer committed
(defun remove-keywords (list keywords)
cer's avatar
cer committed
  (macrolet ((remove-keywords-1 (name-var predicate-form)
cer's avatar
cer committed
	       `(let ((head nil)
		      (tail nil))
		  (do ()
		      ((null list))
cer's avatar
cer committed
		    (let ((,name-var (pop list))
cer's avatar
cer committed
			  (value (pop list)))
cer's avatar
cer committed
		      (unless ,predicate-form
			(setq tail (setq head (list ,name-var value)))
cer's avatar
cer committed
			(return))))
		  (do ()
		      ((null list) head)
cer's avatar
cer committed
		    (let ((,name-var (pop list))
cer's avatar
cer committed
			  (value (pop list)))
cer's avatar
cer committed
		      (unless ,predicate-form
			(setq tail (setf (cddr tail) (list ,name-var value)))))))))
cer's avatar
cer committed
    (cond ((null list) nil)
	  ((null keywords) list)
	  ;; Special case: use EQ instead of MEMBER when only one keyword is supplied.
	  ((null (cdr keywords))
	   (let ((keyword (car keywords)))
cer's avatar
cer committed
	     (remove-keywords-1 name (eq name keyword))))
cer's avatar
cer committed
	  (t
cer's avatar
cer committed
	   (remove-keywords-1 name (member name keywords))))))
cer's avatar
cer committed

)	;#-(or Genera Cloe-Runtime)


;;; Generate a list of keyword information for a given type of keyword.
;;; This is a list of lists of the form:
;;;      (name init-value keyword supplied-p-var &optional accessor-name)
;;; We also put values for the TYPE property of the keywords according
;;; to the incrementor so we can detect these keywords quickly at
;;; runtime.  The value on the property is either some fixed value, an
;;; integer which increments once per keyword, or a member of a set.  We
;;; currently use this facility for defining drawing-state keywords and
;;; transform keywords.  See the files GRAPHICS-TRANSFORM-MIXIN and
;;; DRAWING-STATE-MIXIN for how it's used.

(defmacro define-keywords (name type (incrementor start) accessor-prefix
			   &body names-and-values &aux (offset 0))
  (flet ((counter-incrementor () (incf offset))
	 (member-incrementor () (pop start))
	 (value-incrementor  () start))
    (let ((keyword-stuff (mapcar #'(lambda (n&v)
				     `(,(first n&v) ,(second n&v)
				       ,(intern (string (first n&v)) *keyword-package*)
				       ,(gensymbol (first n&v) 'p)
				       ,@(when accessor-prefix
					   `(,(fintern "~A-~A" accessor-prefix (first n&v))))))
				 names-and-values))
	  (incrementor (ecase incrementor
			 (counter #'counter-incrementor)
			 (member #'member-incrementor)
			 (value #'value-incrementor))))
      `(progn (defparameter ,name ',keyword-stuff)
	      ,@(when type
		  (mapcar #'(lambda (k)
			      `(setf (get ',(third k) ',type) ,(funcall incrementor)))
			  keyword-stuff))))))


(defmacro writing-clauses (&body body)
cer's avatar
cer committed
  (let ((clauses-var (gensymbol 'clauses)))
cer's avatar
cer committed
    `(let ((,clauses-var nil))
       (macrolet ((clause (clause)
		    `(push ,clause ,',clauses-var)))
	 ,@body)
       (nreverse ,clauses-var))))


;;; Arglist tools

;; (flatten-arglist '(foo bar &optional baz (quux)
;; 		          &rest mumble
;; 		          &key frotz (trouble) ((:izzy the-cat))))
;; (FOO BAR &OPTIONAL BAZ QUUX &REST MUMBLE &KEY FROTZ TROUBLE IZZY)
;; make-pass-on-arglist is the only caller
(defun flatten-arglist (arglist)
  (let ((new-arglist nil)
	(mode :positional))
    (dolist (arg-spec arglist)
      (cond ((listp arg-spec)
	     (case mode
	       (&optional
		 (push (first arg-spec) new-arglist))
	       (&key
		 ;; deal with "(... &key ((:keyword var) default))" syntax
		 (let ((thing (first arg-spec)))
		   (push (if (listp thing)
			     (let ((name (first thing)))
			       (if (eq (symbol-package name) *keyword-package*)
				   (intern (symbol-name name))
				   name))
			     thing)
			 new-arglist)))))
	    ((member arg-spec '(&key &rest &optional))
	     (setq mode arg-spec)
	     (push arg-spec new-arglist))
	    (t (push arg-spec new-arglist))))
    (nreverse new-arglist)))

;; (make-pass-on-arglist '(foo bar &optional baz (quux)
;; 		          &rest mumble
;; 		          &key frotz (trouble) ((:izzy the-cat))))
;; (FOO BAR BAZ QUUX MUMBLE :FROTZ FROTZ :TROUBLE TROUBLE ':IZZY THE-CAT)
cer's avatar
cer committed
;; --- It looks like &REST and &KEY don't get along well here.  A big
cer's avatar
cer committed
;; question in such a circumstane is who should be doing the defaulting?  
;; I.e., should this do the defaulting, by making the above arglist be
;; 	:FROTZ FROTZ :TROUBLE TROUBLE ':IZZY THE-CAT MUMBLE
;; for apply, or should it let the eventual caller do the defaulting by
;; punting the defaulting here and just doing
;;	MUMBLE
;; for apply?  There are also interactions with &allow-other-keys that
;; aren't done here.  If this is for pass-on, then &allow-other-keys
;; implies an &rest beforehand, otherwise it is impossible to get all
;; the keys that are being passed on.  There's also the question of
;; whether &allow-other-keys here should put :allow-other-keys in the
cer's avatar
cer committed
;; passed on call list.
cer's avatar
cer committed
(defun make-pass-on-arglist (arglist)
  (let ((new-arglist nil)
	(fa (flatten-arglist arglist))
	(mode :positional)
	(apply-p nil))
    (do ((args fa (cdr args))
	 (original-args arglist (cdr original-args)))
	((null args) nil)
      (let ((arg (first args))
	    (arg-spec (first original-args)))
	(cond ((member arg '(&key &optional &rest))
	       (setq mode arg))
	      ((eq arg '&allow-other-keys)
	       (unless (eq mode '&key)
		 (error "~&&ALLOW-OTHER-KEYS must follow &KEY")))
	      (t (case mode
		   (&key
		     (let ((arg-name arg) (arg-var arg))
		       (cond ((and (listp arg-spec)
				   (listp (first arg-spec)))
			      (setq arg-name `',(first (first arg-spec)))
			      (setq arg-var (second (first arg-spec))))
			     (t (setq arg-name (intern (symbol-name arg) *keyword-package*))))
		       (push arg-name new-arglist)
		       (push arg-var new-arglist)))
		   (&rest (setq apply-p t)
			  (push arg new-arglist))
		   (t (push arg new-arglist)))))))
    (values
      (nreverse new-arglist)
      apply-p)))

(defun ignore-arglist (arglist)
  (flet ((lambda-list-element-compare (element and-option)
	   (and (atom element)
		(string= element and-option))))
    `(progn ,@(let ((args nil))
		(dolist (arg arglist)
		  ;; These various &keys may be in some other package.
		  (cond ((member arg '(&rest &downward-rest &key &allow-other-keys &optional)
				 :test #'lambda-list-element-compare)
			 nil)
			(t (push (cond ((atom arg) arg)
				       ((atom (car arg)) (car arg))
				       (t (cadar arg)))
				 args)
			   (when (and (consp arg) (consp (cdr arg)) (consp (cddr arg)))
			     (push (third arg) args)))))
		(nreverse args))
	    nil)))

cer's avatar
cer committed
(defun canonicalize-and-match-lambda-lists (canonical-order user-specified 
					    &optional allow-user-keys)
cer's avatar
cer committed
  (declare (values lambda-list ignores))
cer's avatar
cer committed
  (check-type canonical-order list)
  (check-type user-specified list)
cer's avatar
cer committed
  (let* ((new-lambda-list nil)
	 (ignores nil)
	 (rest-pos (or (position '&rest user-specified) (length user-specified)))
	 (key-pos (or (position '&key user-specified) rest-pos))
	 (rest-and-key (nthcdr (min rest-pos key-pos) user-specified)))
    (when allow-user-keys
      (setq user-specified (subseq user-specified 0 (min rest-pos key-pos))))
cer's avatar
cer committed
    (flet ((user-var-symbol (entry)
	     ;; FOO | (FOO NIL) | ((:FOO BAR) NIL) | (FOO NIL FOO-P) | ((:FOO BAR) FOO-P) 
	     ;;--- We don't support the FOO-P syntax yet.
	     (cond ((atom entry)
		    entry)
		   ((atom (setq entry (first entry)))
		    entry)
		   (t (second entry))))
	   (user-var-name (entry)
	     ;; FOO | (FOO NIL) | ((:FOO BAR) NIL) | (FOO NIL FOO-P) | ((:FOO BAR) FOO-P) 
	     ;;--- We don't support the FOO-P syntax yet.
	     (cond ((atom entry)
		    entry)
		   ((atom (setq entry (first entry)))
		    entry)
		   (t (first entry)))))
      (declare (dynamic-extent #'user-var-symbol #'user-var-name))
      (dolist (canonical-var canonical-order)
	(let ((user-entry (first (member canonical-var user-specified
					 :test #'string-equal
					 :key #'user-var-name))))
	(cond (user-entry
	       (push (user-var-symbol user-entry) new-lambda-list)
	       (setq user-specified (remove user-entry user-specified)))
	      (t (let ((canonical-gensym (get canonical-var 'canonical-gensym)))
		   (unless canonical-gensym
		     (setq canonical-gensym (make-symbol (symbol-name canonical-var)))
		     (setf (get canonical-var 'canonical-gensym) canonical-gensym))
		   (push canonical-gensym new-lambda-list)
		   (push canonical-gensym ignores))))))
      (when (set-difference user-specified '(&key &allow-other-keys))
	(error "The arguments ~S aren't valid for this lambda list."
	       user-specified))
cer's avatar
cer committed
      (values (if allow-user-keys 
		  (append (nreverse new-lambda-list) rest-and-key)
		  (nreverse new-lambda-list))
cer's avatar
cer committed
	      (nreverse ignores)))))


#+Genera
cer's avatar
cer committed
(defmacro defun-property ((symbol indicator) lambda-list &body body)
cer's avatar
cer committed
  `(zl:::scl:defun (:property ,symbol ,indicator) ,lambda-list ,@body))
cer's avatar
cer committed

#-Genera
cer's avatar
cer committed
(defmacro defun-property ((symbol indicator) lambda-list &body body)
cer's avatar
cer committed
  (let ((function-name 
	  (make-symbol (lisp:format nil "~A-~A-~A" symbol indicator 'property))))
cer's avatar
cer committed
    `(progn (defun ,function-name ,lambda-list ,@body)
	    (eval-when (load eval) (setf (get ',symbol ',indicator) #',function-name)))))

(defmacro do-delimited-substrings (((string &key (start 0) end)
				    (start-index-var end-index-var &optional char-var))
				   substring-form
				   &body char-clauses)
  (let ((special-characters ())
cer's avatar
cer committed
	(next-var (gensymbol 'next))
	(string-var (if (symbolp string) string (gensymbol 'string)))
	(end-var (gensymbol 'end))
	(char-var (or char-var (gensymbol 'the-char))))
cer's avatar
cer committed
    (dolist (char-clause char-clauses)
      (let ((chars (first char-clause)))
	(if (atom chars)
	    (push chars special-characters)
	    (setf special-characters (nconc special-characters chars)))))
    `(,(if (eq string string-var) 'let 'let*)
	   ((,start-index-var ,start)
	   ,@(unless (eq string string-var)
	       `((,string-var ,string)))
	   (,end-var (or ,end (length ,string-var)))
	   (,end-index-var 0)
	   (,next-var nil)
	   ,@(when (cdr special-characters)
	       `((,char-var ,(car special-characters)))))
cer's avatar
cer committed
       (declare (type fixnum ,start-index-var ,end-var ,end-index-var)
cer's avatar
cer committed
		(type (or fixnum null) ,next-var)
		(character ,char-var))
       (loop
	 (setf ,next-var ,(if (null (cdr special-characters))
			      `(position ,(first special-characters) ,string-var
					 :start ,start-index-var :end ,end-var)
			      `(flet ((char-in-set-p (set char) (find char set)))
				 (declare (dynamic-extent #'char-in-set-p))
				 (position ,(coerce special-characters 'string) ,string-var
					   :start ,start-index-var :end ,end-var
					   :test #'char-in-set-p))))
	 (setf ,end-index-var (or ,next-var ,end-var))
	 ,substring-form
	 (when (null ,next-var) (return (values)))
	 ,@(when (cdr special-characters)
	     `((setf ,char-var (aref ,string-var ,next-var))))	;NOT svref
	 ,@(if (null (cdr char-clauses))
	       (cdr (first char-clauses))
	       `((case ,char-var
		   ,@char-clauses)))
	 (setf ,start-index-var (1+ ,end-index-var))))))


;;; COMPILER-LET replacement from Dave Moon.

;;; Put a compile-time property into the lexical environment
;;; This macro is to be invoked in macro expansions
(defmacro with-compile-time-local-property (&environment env (indicator value) &body body)
  (let ((database (compile-time-local-property-database env)))
    (cond ((eq (getf database indicator body) body)
	   (setf database (list* indicator value database)))
	  (t
	   (setf database (copy-list database))
	   (setf (getf database indicator) value)))
    ;; "Loosemore's Device"
    `(macrolet ((get-compile-time-local-property-1 () ',database))
       ,@body)))

;;; Retrieve a compile time property from the lexical environment
;;; This function is to be called from macro expanders
(defun get-compile-time-local-property (indicator env &optional default)
  (getf (compile-time-local-property-database env) indicator default))

(defun compile-time-local-property-database (env)
  (macroexpand-1 `(get-compile-time-local-property-1) env))

;;; This macro gets shadowed by MACROLET.  Its expansion is the database.
(defmacro get-compile-time-local-property-1 ()
  `nil)

#-(or Genera Cloe-Runtime)
(defvar *compile-time-property-table* (make-hash-table))

;;; Retrieve information from a database that only lasts through COMPILE-FILE
;;; Symbol doesn't have to be a symbol, it can be a class object
(defun compile-time-property (symbol indicator &optional default)
cer's avatar
cer committed
  #+Genera
  (multiple-value-bind (value flag)
      (compiler:file-declaration symbol indicator)
    (if flag value default))
  #+Cloe-Runtime
  (when system::*file-declaration-environment*
cer's avatar
cer committed
    (multiple-value-bind (value flag)
cer's avatar
cer committed
	(clos-internals::file-declaration symbol indicator)
cer's avatar
cer committed
      (if flag value default)))
cer's avatar
cer committed
  #+Minima-Developer
  (multiple-value-bind (value flag)
      (zl:::compiler:file-declaration symbol indicator)
    (if flag value default))
  #-(or Genera Cloe-Runtime Minima-Developer)
cer's avatar
cer committed
  ;; For anything else, do it the dumb way that doesn't reset after compilation
  (let ((table (gethash indicator *compile-time-property-table*)))