Skip to content
Snippets Groups Projects
lisp-utilities.lisp 51.7 KiB
Newer Older
cer's avatar
cer committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
;;; -*- Mode: LISP; Syntax: Common-lisp; Package: CLIM-UTILS; Base: 10; Lowercase: Yes -*-
;; 
;; copyright (c) 1985, 1986 Franz Inc, Alameda, Ca.  All rights reserved.
;; copyright (c) 1986-1991 Franz Inc, Berkeley, Ca.  All rights reserved.
;;
;; The software, data and information contained herein are proprietary
;; to, and comprise valuable trade secrets of, Franz, Inc.  They are
;; given in confidence by Franz, Inc. pursuant to a written license
;; agreement, and may be stored and used only in accordance with the terms
;; of such license.
;;
;; Restricted Rights Legend
;; ------------------------
;; Use, duplication, and disclosure of the software, data and information
;; contained herein by any agency, department or entity of the U.S.
;; Government are subject to restrictions of Restricted Rights for
;; Commercial Software developed at private expense as specified in FAR
;; 52.227-19 or DOD FAR Suppplement 252.227-7013 (c) (1) (ii), as
;; applicable.
;;

;; $fiHeader: lisp-utilities.lisp,v 1.1 91/08/30 13:57:47 cer Exp Locker: cer $

(in-package :clim-utils)

"Copyright (c) 1990, 1991 Symbolics, Inc.  All rights reserved.
Copyright (c) 1991, Franz Inc. All rights reserved
 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))

(defmacro without-interrupts (&body body)
  #+Genera `(sys:without-interrupts ,@body)
  #-(or Genera) `(progn ,@body))

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

(deftype extended-char ()
  #+ccl-2 'character
  #-ccl-2 'string-char)

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

#-ansi-90
(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*
		(find-package "user")		;*package*
		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)
  #-ansi-90
  `(multiple-value-bind (vars vals)
       (standard-io-environment-vars-and-vals)
     (progv vars vals
       ,@body))
  #+ansi-90
  `(with-standard-io-syntax ,@body))

#-(or ansi-90 Genera)
(defmacro with-standard-io-syntax (&body body)
  `(with-standard-io-environment ,@body))


;;; 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. 
;;; --- rsl 5 February 1991.

#-(or Genera Cloe-Runtime clim-uses-lisp-streams)
(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)
  #+(and ansi-90 (not Genera)) (typecase stream
				 (synonym-stream
				   (symbol-value (synonym-stream-symbol stream)))
				 (t stream))
  #-(or Genera ansi-90) stream)

#-(or genera ansi-90) 
(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)
(defun gensymbol (&rest parts)
  (declare (dynamic-extent parts))
  (when (null parts) (setf parts '(gensymbol)))
  (make-symbol (lisp:format nil "~{~A-~}~D" parts (incf *gensymbol*))))

;;; 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)
  `(let ((*gensymbol* 0)) ,@body))

;; 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)
  `(catch (if ,condition ,tag '|tag for CATCH-IF false condition|)
     ,@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)))))))

#-(and ansi-90 (not excl) (not Symbolics))
(eval-when (compile load eval)
  (proclaim '(declaration non-dynamic-extent)))

#+(and ansi-90 (not excl) (not Symbolics))
(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))))


;;; DEFINE-GROUP: defines a "group" of definitions which are related
;;; somehow.  In Genera, this causes the function-parents to be set
;;; correctly, for example, and also if you attempt to abort out of the
;;; middle you get told that something might be left inconsistent.
#+Genera 
(defmacro define-group (name type &body body)
  `(sys:multiple-definition ,name ,type ,@body))

#+(and excl (version>= 4 1))
(defmacro define-group (name type &body body)
  `(prog1
     (progn ,@body)
     (excl::record-source-file ',name :type ',type)))

#-(or Genera (and excl (version>= 4 1)))
(defmacro define-group (name type &body body)
  (declare (ignore name type))
  `(progn ,@body))

(defmacro with-warnings-for-definition (name type &body body)
  #+Genera `(let ((compiler:default-warning-function ,name)
		  (compiler:default-warning-definition-type ',type))
	      ,@body)
  #-Genera `(let () ,@body))

(defmacro defun-inline (name lambda-list &body body)
  `(define-group ,name defun-inline
     (eval-when (compile load eval) (proclaim '(inline ,name)))
     (defun ,name ,lambda-list
       ,@body)))

#+Genera
(progn
  (setf (get 'defun-inline 'zwei:definition-function-spec-parser)
	#'(:property cl:defun zwei:definition-function-spec-parser))
  (setf (get 'defun-inline 'zwei:definition-function-spec-type) 'cl:defun)
  (setf (get 'defun-inline 'gprint::formatter) #'(:property cl:defun gprint::formatter))
  (push 'defun-inline zwei:*irrelevant-functions*)
  (push 'defun-inline zwei:*irrelevant-defining-forms*))

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

;; I suppose this could be done through "IMPORT"
#+(or 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))

#+Genera
(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))

#+Cloe-Runtime
(defun-inline evacuate-list (list)
  (if (= (the fixnum (sys::%tr-type list)) sys::tr$k-cons-s)
      (copy-list list)
      list))
)	;#+(or Genera Cloe-Runtime)

#+excl
(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))

#+(and (not :rs6000) (version>= 4 1))
(defun-inline evacuate-list (list)
  (if (comp::ll :<u (comp::ll :register :stack-pointer) list)
      (copy-list list)
    list))

#-(and (not :rs6000) (version>= 4 1))
(defun-inline evacuate-list (list) `,list)

)	;#+excl

#+ccl-2
(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)
  ;; --- Dunno if this is the right function to be calling
  ;; --- but it seems to give the right answers.
  (cond ((and (ccl::stack-area-endptr list)
              (listp list))
         (copy-list list))
        (t list)))
)	;#+ccl-2

#-(or Genera Cloe-Runtime excl ccl-2)
(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.
;; When stack-consing works for non-Genera/CLOE, make this do something.
(defmacro evacuate-list (list)
  `,list)
)	;#-(or Genera Cloe-Runtime excl)

#+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...
(defun make-stack-array (size &rest options)
  (declare (dynamic-extent options))
  (apply #'make-array size options))

#+(or Genera CLOE-Runtime)
(defmacro with-rem-keywords ((new-list list keywords-to-remove) &body body)
  `(si::with-rem-keywords (,new-list ,list ,keywords-to-remove)
     ,@body))

#+(or Genera CLOE-Runtime)
(defun rem-keywords (list keywords-to-remove)
  (si::rem-keywords list keywords-to-remove))

#-(or Genera Cloe-Runtime)
(progn 
(defmacro with-rem-keywords ((new-list list keywords-to-remove) &body body)
  `(let ((,new-list (rem-keywords ,list ,keywords-to-remove)))
     ,@body))

(defun rem-keywords (list keywords)
  (macrolet ((kernel (predicate)
	       `(let ((head nil)
		      (tail nil))
		  (do ()
		      ((null list))
		    (let ((name (pop list))
			  (value (pop list)))
		      (when (not (,predicate name))
			(setq tail (setq head (list name value)))
			(return))))
		  (do ()
		      ((null list) head)
		    (let ((name (pop list))
			  (value (pop list)))
		      (when (not (,predicate name))
			(setq tail (setf (cddr tail) (list name value)))))))))
    (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)))
	     (flet ((eq-predicate (name) (eq name keyword)))
	       (declare (dynamic-extent #'eq-predicate))
	       (kernel eq-predicate))))
	  (t
	   (flet ((member-predicate (name) (member name keywords)))
	     (declare (dynamic-extent #'member-predicate))
	     (kernel member-predicate))))))

)	;#-(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))))))

;; 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)))
	(count    (if (atom var) '#:count (second var)))
	(aref (if simple-p 'svref 'aref)))
    `(block nil
       (let* ((,fvector ,vector)
	      (,startd ,start)
	      (,endd ,(if simple-p `,end `(or ,end (length ,fvector))))
	      (,count (if ,from-end (1- ,endd) ,startd))
	      (,limit (if ,from-end (1- ,startd) ,endd)))
	 (declare (fixnum ,endd ,count ,limit)
		  ;; Turn on the afterburners...
		  (optimize (speed 3) (safety 0))
		  ,@(and simple-p `((type simple-vector ,fvector)))
		  #+genera (sys:array-register ,fvector))
	 (loop
	   (when (= ,count ,limit) (return))
	   (let ((,variable (,aref ,fvector ,count)))
	     ,@body)
	   (,(if from-end 'decf 'incf) ,count))))))

(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)))))))

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

(defmacro writing-clauses (&body body)
  (let ((clauses-var (make-symbol "CLAUSES")))
    `(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)
;; --- It looks like &rest and &key don't get along well here.  A big
;; 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
;; passed on calllist.
(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)))

(defun canonicalize-and-match-lambda-lists (canonical-order user-specified)
  (declare (values lambda-list ignores))
  (let ((new-lambda-list nil)
	(ignores nil))
    (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))
      (values (nreverse new-lambda-list)
	      (nreverse ignores)))))


;;; The DEFINE-CLASS-MIXTURE macro is designed to allow some flexibility
;;; in the way the programmer defines class hierarchies.  It works
;;; pretty much the same as the Flavors :MIXTURE option to DEFFLAVOR,
;;; except without one of the more mystifying features, namely the
;;; ability to condition the keywords' effects on the value of other
;;; keywords.  Here is an example of the kind of this this version
;;; handles:
;;; (define-class-mixture drawing-path
;;;   (:stretch-p stretching-drawing-path-mixin)
;;;   (:orientation
;;;     (nil horizontal-drawing-path-mixin)
;;;     (:diagonal "Diagonal drawing paths not yet implemented")
;;;     (:horizontal horizontal-drawing-path-mixin)
;;;     (:vertical vertical-drawing-path-mixin)))
(defmacro define-class-mixture (name &body specs)
  `(define-group ,name define-class-mixture
     ,@(define-class-mixture-compile-time name specs)))
#+Genera (scl:defprop define-class-mixture "Class Mixture" si:definition-type-name)

;;; Use this to define a class-mixture and a resource at the same time.
;;; This defines a mixture, and a resource of them which has a matcher
;;; and a constructor which will do what you want, namely give you
;;; objects which have the right properties flavors mixed in.
(defmacro define-class-mixture-and-resource (name (&key initializer initial-copies)
					 &body specs)
  (let ((matcher-function-name (make-symbol (lisp:format nil "~A-MATCHER" name)))
	(constructor-function-name (make-symbol (lisp:format nil "~A-CONSTRUCTOR" name))))
    `(define-group ,name define-class-mixture-and-resource
       (define-class-mixture ,name ,@specs)
       (defun ,matcher-function-name (object os &rest args)
	 (declare (dynamic-extent args))
	 (declare (ignore os))			;Object-storage object from resource
	 (apply #'mixture-typep object ',name args))
       (defun ,constructor-function-name (rd &rest args)
	 (declare (dynamic-extent args))
	 (declare (ignore rd))			;resource-descriptor for resource
	 (apply #'make-mixture-instance ',name args))
       (defresource ,name (&rest args)
	 :constructor ,constructor-function-name
	 :matcher ,matcher-function-name
	 :initializer ,initializer
	 :initial-copies ,initial-copies))))

;;; Create an instance of a class which has a mixture option.
(defun make-mixture-instance (mixture-name &rest args)
  (declare (dynamic-extent args))
  (apply #'make-instance
	 (apply (get mixture-name 'mixture-class-name) args)
	 args))

(defun mixture-typep (instance mixture-name &rest args)
  (declare (dynamic-extent args))
  (typep instance (apply (get mixture-name 'mixture-class-name) args)))

;;; The guts of DEFINE-CLASS-MIXTURE.  This creates a class-name
;;; function for a given mixture definition, plus all the classes you
;;; need to make it work.  The class names are heuristically chosen to
;;; be the ones the programmer would likely have chosen for the mixed
;;; flavors.  There is no attempt to fix problems this heuristic might
;;; cause, unlike Flavors.

(defun define-class-mixture-compile-time (name specs)
  (let ((keywords nil)
	(forms nil)
	(classes nil)
	(trimmed-names nil))
    (labels ((compile (form) (push form forms))
	     (define-class (class-name component-list)
	       (compile `(defclass ,class-name
				   (,@component-list ,name)
			   ())))
	     (substring (string start &optional end)
	       (setf string (string string))
	       (subseq string start (or end (length string))))
	     (trim-off-name-parts (the-class-name)
	       (let ((pair (assoc the-class-name trimmed-names)))
		 (when pair (return-from trim-off-name-parts (cdr pair))))
	       (let* ((class-name (string the-class-name))
		      (sname (string name))
		      (nl (length sname)))
		 (when (and (> (length class-name) 6)
			    (string-equal class-name "BASIC-" :end1 6))
		   (setf class-name (substring class-name 6)))
		 (when (and (> (length class-name) 6) 
			    (string-equal class-name "-MIXIN"
					  :start1 (- (length class-name) 6)))
		   (setf class-name (substring class-name 0 (- (length class-name) 6))))
		 (when (and (> (length class-name) nl)
			    (string-equal class-name sname :start1 (- (length class-name) nl)))
		   (setf class-name (substring class-name 0 (- (length class-name) nl))))
		 (push (cons the-class-name class-name) trimmed-names)
		 class-name))
	     (invent-class-name (subclasses)
	       (when (stringp (first subclasses))
		 (return-from invent-class-name `(error "Can't decode mixture ~S: ~A"
							',name ,(first subclasses))))
	       (intern
		 (with-output-to-string (out)
		   (dolist (class subclasses)
		     (princ (trim-off-name-parts class) out))
		   (princ name out))))
	     (process-specs (specs classes-so-far)
	       (when (null specs)
		 (let ((class-name (invent-class-name classes-so-far)))
		   (when (symbolp class-name)
		     (unless (member class-name classes)
		       (push class-name classes)
		       (define-class class-name classes-so-far))
		     (return-from process-specs `',class-name))
		   (return-from process-specs class-name)))
	       (let* ((first-spec (first specs))
		      (keyword (first first-spec))
		      (variable-name (intern (string keyword)))
		      (rest (rest first-spec)))
		 (pushnew variable-name keywords)
		 (assert (consp rest) ()
			 "Ill-formatted mixture specification: ~S" specs)
		 (when (and (first rest) (symbolp (first rest)))
		   (assert (null (cdr rest)) ()
			   "A component-class mixture spec must stand alone. ~S is incorrect."
			   first-spec)
		   (return-from process-specs 
		     `(if ,variable-name
			  ,(process-specs (cdr specs) (cons (first rest) classes-so-far))
			  ,(process-specs (cdr specs) classes-so-far))))
		 (assert (and rest (listp rest)) ()
			 "A specification keyword must be followed by one or more values.  ~
			  ~S is incorrect."
			 first-spec)
		 `(case ,variable-name
		    ,@(mapcar #'(lambda (subspec)
				  `((,(first subspec))
				    ,(if (second subspec)
					 (process-specs (cdr specs)
							(cons (second subspec) classes-so-far))
					 (process-specs (cdr specs) classes-so-far))))
			      rest)
		    ,@(unless (assoc 'otherwise rest)
			`((otherwise (error "~S is illegal as the ~S option to mixture ~S.~%~
					     The legal values are ~{~S~^, ~}."
					    ,variable-name ,keyword ',name
					    ',(mapcar #'first rest)))))))))
      (let ((result (process-specs specs nil)))
	(compile `(defun-property (:property ,name mixture-class-name)
				  (&key ,@keywords &allow-other-keys)
		    ,result))))
    (nreverse forms)))

#+Genera
(defmacro defun-property ((property symbol indicator) lambda-list &body body)
  (unless (eql property :property)
    (warn "Using ~S to define a function named ~S, which is not a property"
	  'defun-property (list property symbol indicator)))
  `(defun (:property ,symbol ,indicator) ,lambda-list ,@body))

#-Genera
(defmacro defun-property ((property symbol indicator) lambda-list &body body)
  (unless (eql property :property)
    (warn "Using ~S to define a function named ~S, which is not a property"
	  'defun-property (list property symbol indicator)))
  (let ((function-name (make-symbol (lisp:format nil "~A-~A-PROPERTY" symbol indicator))))
    `(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 ())
	(next-var (make-symbol "NEXT"))
	(string-var (if (symbolp string) string (make-symbol "STRING")))
	(end-var (make-symbol "END"))
	(char-var (or char-var (make-symbol "THE-CHAR"))))
    (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)))))
       (declare (fixnum ,start-index-var ,end-var ,end-index-var)
		(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)
  #+(or Genera Cloe-Runtime)
  (when (progn #+Cloe-runtime system::*file-declaration-environment*
	       #+Genera t)
    (multiple-value-bind (value flag)
	(#+Genera compiler:file-declaration #+Cloe-Runtime clos-internals::file-declaration
	 symbol indicator)
      (if flag value default)))
  #-(or Genera Cloe-Runtime)
  ;; For anything else, do it the dumb way that doesn't reset after compilation
  (let ((table (gethash indicator *compile-time-property-table*)))
    (unless table
      (setf (gethash indicator *compile-time-property-table*)
	    (setq table (make-hash-table))))
    (values (gethash symbol table default))))

(defsetf compile-time-property #+Genera compiler:file-declare
			       #-Genera set-compile-time-property)

#-Genera
(defun set-compile-time-property (symbol indicator value)
  #+Cloe-Runtime
  (when system::*file-declaration-environment*
    (setf (clos-internals::file-declaration symbol indicator) value))
  #-Cloe-Runtime
  (let ((table (gethash indicator *compile-time-property-table*)))
    (unless table
      (setf (gethash indicator *compile-time-property-table*)
	    (setq table (make-hash-table))))
    (setf (gethash symbol table) value)))

#-(or Genera (and ansi-90 (not (and excl (or :rs6000 (not (version>= 4 1)))))))
					; Allegro 4.0 doesn't comply with this.
					; but 4.1 does so lets hope
					; the logic is correct