source: trunk/source/level-1/l1-utils.lisp @ 13568

Last change on this file since 13568 was 13568, checked in by gb, 9 years ago

Set #+windows-target *PATHNAME-ESCAPE-CHARACTER* to #\> instead of
#\', since according to
<http://msdn.microsoft.com/en-us/library/aa368590(VS.85).aspx>,
#\> is not a legal filename constituent and #\' is. (Of course, that page
also claims that #
is a forward slash and that #\/ is a backslash,
so go figure.)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 37.2 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2009 Clozure Associates
4;;;   Copyright (C) 1994-2001 Digitool, Inc
5;;;   This file is part of Clozure CL. 
6;;;
7;;;   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
8;;;   License , known as the LLGPL and distributed with Clozure CL as the
9;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
10;;;   which is distributed with Clozure CL as the file "LGPL".  Where these
11;;;   conflict, the preamble takes precedence. 
12;;;
13;;;   Clozure CL is referenced in the preamble as the "LIBRARY."
14;;;
15;;;   The LLGPL is also available online at
16;;;   http://opensource.franz.com/preamble.html
17
18; L1-utils.lisp
19
20(in-package "CCL")
21
22;The following forms (up thru defn of %DEFUN) must come before any DEFUN's.
23;Any (non-kernel) functions must be defined before they're used!
24;In fact, ALL functions must be defined before they're used!  How about that ?
25
26
27
28(setq %lisp-system-fixups% nil)
29
30
31;;; Kludge for record-source-file bootstrapping
32
33(%fhave 'full-pathname (qlfun bootstrapping-full-pathname (name) name))
34
35
36; real one is  in setf.lisp
37(%fhave '%setf-method (qlfun bootstripping-setf-fsname (spec)
38                                   spec nil))
39
40(fset 'physical-pathname-p (lambda (file)(declare (ignore file)) nil)) ; redefined later
41
42(setq *record-source-file* t)
43
44(fset 'level-1-record-source-file
45      (qlfun level-1-record-source-file (name def-type &optional (source (or *loading-toplevel-location*
46                                                                             *loading-file-source-file*)))
47        ;; Level-0 puts stuff on plist of name.  Once we're in level-1, names can
48        ;; be more complicated than just a symbol, so just collect all calls until
49        ;; the real record-source-file is loaded.
50        (when *record-source-file*
51          (unless (listp *record-source-file*)
52            (setq *record-source-file* nil))
53          (push (list name def-type source) *record-source-file*))))
54
55(fset 'record-source-file #'level-1-record-source-file)
56
57(defun inherit-from-p (ob parent)
58  (memq (if (symbolp parent) (find-class parent nil) parent)
59        (%inited-class-cpl (class-of ob))))
60
61;;; returns new plist with value spliced in or key, value consed on.
62(defun setprop (plist key value &aux loc)
63  (if (setq loc (pl-search plist key))
64    (progn (%rplaca (%cdr loc) value) plist)
65    (cons key (cons value plist))))
66
67(defun getf-test (place indicator test &optional default)
68  (loop
69    (when (null place)
70      (return default))
71    (when (funcall test indicator (car place))
72      (return (cadr place)))
73    (setq place (cddr place))))
74
75(defun setprop-test (plist indicator test value)
76  (let ((tail plist))
77    (loop
78      (when (null tail)
79        (return (cons indicator (cons value plist))))
80      (when (funcall test indicator (car tail))
81        (setf (cadr tail) value)
82        (return plist))
83      (setq tail (cddr tail)))))
84
85(defun plistp (p &aux len)
86  (and (listp p)
87       (setq len (list-length p))
88       (not (%ilogbitp 0 len))))  ; (evenp p)
89
90(defun %imax (i1 i2)
91 (if (%i> i1 i2) i1 i2))
92
93(defun %imin (i1 i2)
94  (if (%i< i1 i2) i1 i2))
95
96
97
98
99;|#
100
101
102(eval-when (:compile-toplevel :execute)
103  (require "NUMBER-MACROS"))
104
105
106
107
108(defun loading-file-source-file ()
109  *loading-file-source-file*)
110
111(setq *save-local-symbols* t)
112
113(%fhave 'require-type (nfunction bootstrapping-require-type
114                                 (lambda (thing type)
115                                   (declare (ignore type))
116                                   thing)))
117(%fhave '%require-type 
118        (nfunction bootstrapping-%require-type
119                   (lambda (thing predicate)
120                     (declare (ignore predicate))
121                     thing)))
122
123(setf (type-predicate 'macptr) 'macptrp)
124
125
126
127
128
129
130(defun %pop-required-arg-ptr (ptr)
131  (if (atom (destructure-state.current ptr))
132    (signal-program-error "Required arguments in ~s don't match lambda list ~s."
133           (destructure-state.whole ptr) (destructure-state.lambda ptr))
134    (pop (destructure-state.current ptr))))
135
136(defun %default-optional-value (ptr &optional default)
137  (let* ((tail (destructure-state.current ptr)))
138    (if tail
139      (if (atom tail)
140        (signal-program-error "Optional arguments in ~s don't match lambda list ~s."
141               (destructure-state.whole ptr) (destructure-state.lambda ptr))
142        (pop (destructure-state.current ptr)))
143      default)))
144
145(defun %check-extra-arguments (ptr)
146  (when (destructure-state.current ptr)
147    (signal-program-error "Extra arguments in ~s don't match lambda list ~s."
148                          (destructure-state.whole ptr) (destructure-state.lambda ptr))))
149
150(defun %keyword-present-p (keys keyword)
151  (let* ((not-there (cons nil nil)))
152    (declare (dynamic-extent not-there))
153    (not (eq (getf keys keyword not-there) not-there))))
154
155(defun check-keywords (keys actual allow-others)
156  (let* ((len (ignore-errors (list-length actual))))
157    (if (null len)
158      (signal-simple-program-error "Circular or dotted keyword list: ~s" actual)
159      (if (oddp len)
160        (signal-simple-program-error "Odd length keyword list: ~s" actual))))
161  (setq allow-others (or allow-others (getf actual :allow-other-keys)))
162  (do* ((a actual (cddr a))
163        (k (car a) (car a)))
164       ((null a))
165    (unless (typep k 'symbol)
166      (signal-simple-program-error
167       "Invalid keyword argument ~s in ~s.  ~&Valid keyword arguments are ~s." k actual keys))
168    (unless (or allow-others
169                (eq k :allow-other-keys)
170                (member k keys))
171      (signal-simple-program-error "Unknown keyword argument ~s in ~s.  ~&Valid keyword arguments are ~s." k actual keys))))
172
173(%fhave 'set-macro-function #'%macro-have)   ; redefined in sysutils.
174
175;;; Define special forms.
176(dolist (sym '(block catch compiler-let eval-when
177               flet function go if labels let let* macrolet
178               multiple-value-call multiple-value-prog1
179               progn progv quote return-from setq tagbody
180               the throw unwind-protect locally load-time-value
181               symbol-macrolet
182               ;; These are implementation-specific special forms :
183               nfunction
184               ppc-lap-function fbind
185               with-c-frame with-variable-c-frame))
186  (%macro-have sym sym))
187
188
189(defun %macro (named-fn &optional doc &aux arglist)
190  ;; "doc" is either a string or a list of the form :
191  ;; (doc-string-or-nil . (body-pos-or-nil . arglist-or-nil))
192  (if (listp doc)
193    (setq arglist (cddr doc)
194          doc (car doc)))
195  (let* ((name (function-name named-fn)))
196    (record-source-file name 'function)
197    (set-macro-function name named-fn)
198    (when (and doc *save-doc-strings*)
199      (set-documentation name 'function doc))
200    (when arglist
201      (record-arglist name arglist))
202    (when *fasload-print* (format t "~&~S~%" name))
203    name))
204
205
206(defun %defvar (var &optional doc)
207  "Returns boundp"
208  (%proclaim-special var)
209  (record-source-file var 'variable)
210  (when (and doc *save-doc-strings*)
211    (set-documentation var 'variable doc))
212  (cond ((not (boundp var))
213         (when *fasload-print* (format t "~&~S~%" var))
214         nil)
215        (t t)))
216
217(defun %defparameter (var value &optional doc)
218  (%proclaim-special var)
219  (record-source-file var 'variable)
220  (when (and doc *save-doc-strings*)
221    (set-documentation var 'variable doc))
222  (when *fasload-print* (format t "~&~S~%" var))
223  (set var value)
224  var)
225
226
227(defun %defglobal (var value &optional doc)
228  (%symbol-bits var (logior (ash 1 $sym_vbit_global) (the fixnum (%symbol-bits var))))
229  (%defparameter var value doc))
230
231;Needed early for member etc.
232(defun identity (x)
233  "This function simply returns what was passed to it."
234  x)
235
236(defun coerce-to-function (arg)
237  (if (functionp arg)
238    arg
239    (if (symbolp arg)
240      (%function arg)
241      (report-bad-arg arg 'function))))
242
243;;; takes arguments in arg_x, arg_y, arg_z, returns "multiple values"
244;;; Test(-not) arguments are NOT validated beyond what is done
245;;; here.
246;;; if both :test and :test-not supplied, signal error.
247;;; if test provided as #'eq or 'eq, return first value 'eq.
248;;; if test defaulted, provided as 'eql, or provided as #'eql, return
249;;; first value 'eql.
250;;; if test-not provided as 'eql or provided as #'eql, return second
251;;; value 'eql.
252;;; if key provided as either 'identity or #'identity, return third value nil.
253(defun %key-conflict (test-fn test-not-fn key)
254  (let* ((eqfn #'eq)
255         (eqlfn #'eql)
256         (idfn #'identity))
257    (if (or (eq key 'identity) (eq key idfn))
258      (setq key nil))
259    (if test-fn
260      (if test-not-fn
261        (%err-disp $xkeyconflict ':test test-fn ':test-not test-not-fn)
262        (if (eq test-fn eqfn)
263          (values 'eq nil key)
264          (if (eq test-fn eqlfn)
265            (values 'eql nil key)
266            (values test-fn nil key))))
267      (if test-not-fn
268        (if (eq test-not-fn eqfn)
269          (values nil 'eq key)
270          (if (eq test-not-fn eqlfn)
271            (values nil 'eql key)
272            (values nil test-not-fn key)))
273        (values 'eql nil key)))))
274
275
276
277
278;;; Assoc.
279
280;;; (asseql item list) <=> (assoc item list :test #'eql :key #'identity)
281
282
283
284;;; (assoc-test item list test-fn)
285;;;   <=>
286;;;     (assoc item list :test test-fn :key #'identity)
287;;; test-fn may not be FUNCTIONP, so we coerce it here.
288(defun assoc-test (item list test-fn)
289  (dolist (pair list)
290    (if pair
291      (if (funcall test-fn item (car pair))
292        (return pair)))))
293
294
295
296; (assoc-test-not item list test-not-fn)
297;   <=>
298;     (assoc item list :test-not test-not-fn :key #'identity)
299; test-not-fn may not be FUNCTIONP, so we coerce it here.
300(defun assoc-test-not (item list test-not-fn)
301  (dolist (pair list)
302    (if pair
303      (if (not (funcall test-not-fn item (car pair)))
304        (return pair)))))
305
306(defun assoc (item list &key test test-not key)
307  "Return the cons in ALIST whose car is equal (by a given test or EQL) to
308   the ITEM."
309  (multiple-value-bind (test test-not key) (%key-conflict test test-not key)
310    (if (null key)
311      (if (eq test 'eq)
312        (assq item list)
313        (if (eq test 'eql)
314          (asseql item list)
315          (if test
316            (assoc-test item list test)
317            (assoc-test-not item list test-not))))
318      (if test
319        (dolist (pair list)
320          (if pair
321            (if (funcall test item (funcall key (car pair)))
322              (return pair))))
323        (dolist (pair list)
324          (if pair
325            (unless (funcall test-not item (funcall key (car pair)))
326              (return pair))))))))
327
328
329;;;; Member.
330
331;;; (member-test-not item list test-not-fn)
332;;;   <=>
333;;;     (member item list :test-not test-not-fn :key #'identity)
334(defun member-test-not (item list test-not-fn)
335  (do* ((l list (cdr l)))
336       ((endp l))
337    (unless (funcall test-not-fn item (%car l)) (return l))))
338
339(defun member (item list &key test test-not key)
340  "Return the tail of LIST beginning with first element satisfying EQLity,
341   :TEST, or :TEST-NOT with the given ITEM."
342  (multiple-value-bind (test test-not key) (%key-conflict test test-not key)
343    (if (null key)
344      (if (eq test 'eq)
345        (memq item list)
346        (if (eq test 'eql)
347          (memeql item list)
348          (if test
349            (member-test item list test)
350            (member-test-not item list test-not))))
351      (if test
352        (do* ((l list (cdr l)))
353             ((endp l))
354          (if (funcall test item (funcall key (car l)))
355              (return l)))
356        (do* ((l list (cdr l)))
357             ((null l))
358          (unless (funcall test-not item (funcall key (car l)))
359              (return l)))))))
360
361
362(defun adjoin (item list &key test test-not key)
363  "Add ITEM to LIST unless it is already a member"
364  (if (and (not test)(not test-not)(not key))
365    (if (not (memeql item list))(cons item list) list)
366    (multiple-value-bind (test test-not key) (%key-conflict test test-not key)
367      (if
368        (if (null key)
369          (if (eq test 'eq)
370            (memq item list)
371            (if (eq test 'eql)
372              (memeql item list)
373              (if test
374                (member-test item list test)
375                (member-test-not item list test-not))))
376          (if test
377            (member (funcall key item) list :test test :key key)
378            (member (funcall key item) list :test-not test-not :key key)))
379        list
380        (cons item list)))))
381
382(defun adjoin-eq (elt list)
383  (if (memq elt list)
384    list
385    (cons elt list)))
386
387(defun adjoin-eql (elt list)
388  (if (memeql elt list)
389    list
390    (cons elt list)))
391
392(defun union-eq (list1 list2)
393  (let ((res list2))
394    (dolist (elt list1)
395      (unless (memq elt res)
396        (push elt res)))
397    res))
398
399(defun union-eql (list1 list2)
400  (let ((res list2))
401    (dolist (elt list1)
402      (unless (memeql elt res)
403        (push elt res)))
404    res))
405
406;;; Fix this someday.  Fix EQUALP, while you're at it ...
407(defun similar-as-constants-p (x y)
408  (or (eq x y)                          ; Redefinition of constants to themselves.
409      (if (and (stringp x) (stringp y)) ;The most obvious case where equalp & s-a-c-p need to differ...
410        (string= x y)
411        (equalp x y))))
412
413(defun undefine-constant (var)
414  (%set-sym-global-value var (%unbound-marker-8)))
415
416(defparameter *cerror-on-constant-redefinition* t)
417
418(defun define-constant (var value)
419  (block nil
420    (if (constant-symbol-p var)
421      (let* ((old-value (%sym-global-value var)))
422        (unless (eq old-value (%unbound-marker-8))
423          (if (or (eql old-value value)
424                  (and (not *strict-checking*) (similar-as-constants-p old-value value)))
425            (return)
426            ;; This should really be a cell error, allow options other than
427            ;; redefining (such as don't redefine and continue)...
428            (when *cerror-on-constant-redefinition*
429              (cerror "Redefine ~S to have new value ~*~s"
430                      "Constant ~S is already defined with a different value (~s)"
431                      var old-value value))))))
432    (%symbol-bits var 
433                  (%ilogior (%ilsl $sym_bit_special 1) (%ilsl $sym_bit_const 1)
434                            (%symbol-bits var)))
435    (%set-sym-global-value var value))
436  var)
437
438(defun %defconstant (var value &optional doc)
439  (%proclaim-special var)
440  (record-source-file var 'constant)
441  (define-constant var value)
442  (when (and doc *save-doc-strings*)
443    (set-documentation var 'variable doc))
444  (when *fasload-print* (format t "~&~S~%" var))
445  var)
446
447(defparameter *nx1-compiler-special-forms* ())
448(defparameter *nx-proclaimed-types* ())
449(defparameter *nx-proclaimed-ftypes* nil)
450
451(defun compiler-special-form-p (sym)
452  (or (eq sym 'quote)
453      (if (memq sym *nx1-compiler-special-forms*) t)))
454
455
456
457(defparameter *nx-known-declarations* ())
458(defparameter *nx-proclaimed-inline* ())
459(defparameter *nx-proclaimed-ignore* ())
460(defparameter *nx-globally-inline* ())
461
462
463
464(defconstant *cl-types* '(
465array
466atom
467base-char
468bignum
469bit
470bit-vector 
471character
472#|
473lisp:common
474|#
475compiled-function 
476complex 
477cons                   
478double-float
479extended-char
480fixnum
481float
482function
483hash-table
484integer
485keyword
486list 
487long-float
488nil 
489null
490number 
491package
492pathname 
493random-state 
494ratio
495rational
496readtable
497real
498sequence 
499short-float
500signed-byte 
501simple-array
502simple-bit-vector
503simple-string 
504simple-base-string
505simple-vector 
506single-float
507standard-char
508stream 
509string
510#|
511lisp:string-char
512|#
513symbol
514t
515unsigned-byte 
516vector
517))
518
519;; Redefined in sysutils.
520(%fhave 'specifier-type-if-known
521        (qlfun bootstrapping-type-specifier-p (name &optional env &key &allow-other-keys)
522          (declare (ignore env))
523          (memq name *cl-types*)))
524
525
526
527(defun proclaim (spec)
528  (case (car spec)
529    (special (apply #'proclaim-special (%cdr spec)))
530    (notspecial (apply #'proclaim-notspecial (%cdr spec)))
531    (optimize (%proclaim-optimize (%cdr spec)))
532    (inline (apply #'proclaim-inline t (%cdr spec)))
533    (notinline (apply #'proclaim-inline nil (%cdr spec)))
534    (declaration (apply #'proclaim-declaration (%cdr spec)))
535    (ignore (apply #'proclaim-ignore t (%cdr spec)))
536    (unignore (apply #'proclaim-ignore nil (%cdr spec)))
537    (type (apply #'proclaim-type (%cdr spec)))
538    (ftype (apply #'proclaim-ftype (%cdr spec)))
539    (function (apply #'proclaim-type spec))
540    (t (unless (memq (%car spec) *nx-known-declarations*)
541         ;; Any type name is now (ANSI CL) a valid declaration.
542         (if (specifier-type-if-known (%car spec))
543           (apply #'proclaim-type spec)
544           (signal-program-error "Unknown declaration specifier ~s in ~S" (%car spec) spec))))))
545
546(defun bad-proclaim-spec (spec)
547  (signal-program-error "Invalid declaration specifier ~s" spec))
548
549(defun proclaim-type (type &rest vars)
550  (declare (dynamic-extent vars))
551  ;; Called too early to use (every #'symbolp vars)
552  (unless (loop for v in vars always (symbolp v)) (bad-proclaim-spec `(,type ,@vars)))
553  (when *type-system-initialized*
554    ;; Check the type.  This will signal program-error's in case of invalid types, let it.
555    ;; Do not signal anything about unknown types though -- it should be ok to have forward
556    ;; references here, before anybody needs the info.
557    (specifier-type type))
558  (dolist (var vars)
559    (let ((spec (assq var *nx-proclaimed-types*)))
560      (if spec
561        (rplacd spec type)
562        (push (cons var type) *nx-proclaimed-types*)))))
563
564(defun proclaim-ftype (ftype &rest names)
565  (declare (dynamic-extent names))
566  (unless (every (lambda (v) (or (symbolp v) (setf-function-name-p v))) names)
567    (bad-proclaim-spec `(ftype ,ftype ,@names)))
568  (unless *nx-proclaimed-ftypes*
569    (setq *nx-proclaimed-ftypes* (make-hash-table :test #'eq)))
570  ;; Check the type.  This will signal program-error's in case of invalid types, let it.
571  ;; Do not signal anything about unknown types though -- it should be ok to have forward
572  ;; references here, before anybody needs the info.
573  (let* ((ctype (specifier-type ftype)))
574    ;; If know enough to complain now, do so.
575    (when (types-disjoint-p ctype (specifier-type 'function))
576      (bad-proclaim-spec `(ftype ,ftype ,@names))))
577  (dolist (name names)
578    (setf (gethash (maybe-setf-function-name name) *nx-proclaimed-ftypes*) ftype)))
579
580
581
582(defun proclaimed-ftype (name)
583  (when *nx-proclaimed-ftypes*
584    (gethash (ensure-valid-function-name name) *nx-proclaimed-ftypes*)))
585
586
587(defun proclaim-special (&rest vars)
588  (declare (dynamic-extent vars))
589  (unless (every #'symbolp vars) (bad-proclaim-spec `(special ,@vars)))
590  (dolist (sym vars) (%proclaim-special sym)))
591
592
593(defun proclaim-notspecial (&rest vars)
594  (declare (dynamic-extent vars))
595  (unless (every #'symbolp vars) (bad-proclaim-spec `(special ,@vars)))
596  (dolist (sym vars) (%proclaim-notspecial sym)))
597
598(defun proclaim-inline (t-or-nil &rest names)
599  (declare (dynamic-extent names))
600  ;;This is just to make it more likely to detect forgetting about the
601  ;;first arg...
602  (unless (or (eq nil t-or-nil) (eq t t-or-nil)) (report-bad-arg t-or-nil '(member t nil)))
603  (unless (loop for v in names always (or (symbolp v) (setf-function-name-p v)))
604    (bad-proclaim-spec `(,(if t-or-nil 'inline 'notinline) ,@names)))
605  (dolist (name names)
606    (setq name (maybe-setf-function-name name))
607    (if (listp *nx-proclaimed-inline*)
608      (setq *nx-proclaimed-inline*
609          (alist-adjoin name
610                        (or t-or-nil (if (compiler-special-form-p name) t))
611                        *nx-proclaimed-inline*))
612      (setf (gethash name *nx-proclaimed-inline*)
613            (or t-or-nil (if (compiler-special-form-p name) t))))))
614
615(defun proclaim-declaration (&rest syms)
616  (declare (dynamic-extent syms))
617  (unless (every #'symbolp syms) (bad-proclaim-spec `(declaration ,@syms)))
618  (dolist (sym syms)
619    (when (type-specifier-p sym)
620      (error "Cannot define declaration ~s because it is the name of a type" sym))
621    (setq *nx-known-declarations* 
622          (adjoin sym *nx-known-declarations* :test 'eq))))
623
624(defun check-declaration-redefinition (name why)
625  (when (memq name *nx-known-declarations*)
626    (cerror "Undeclare the declaration ~*~s"
627            "Cannot ~a ~s because ~:*~s has been declared as a declaration name" why name)
628    (setq *nx-known-declarations* (remove name *nx-known-declarations*))))
629
630(defun proclaim-ignore (t-or-nil &rest syms)
631  (declare (dynamic-extent syms))
632  ;;This is just to make it more likely to detect forgetting about the
633  ;;first arg...
634  (unless (or (eq nil t-or-nil) (eq t t-or-nil)) (report-bad-arg t-or-nil '(member t nil)))
635  (unless (every #'symbolp syms) (bad-proclaim-spec `(,(if t-or-nil 'ignore 'unignore) ,@syms)))
636  (dolist (sym syms)
637    (setq *nx-proclaimed-ignore*
638          (alist-adjoin sym t-or-nil *nx-proclaimed-ignore*))))
639
640
641(queue-fixup
642 (when (listp *nx-proclaimed-inline*)
643  (let ((table (make-hash-table :size 100 :test #'eq)))
644    (dolist (x *nx-proclaimed-inline*)
645      (let ((name (car x)) (value (cdr x)))
646        (when (symbolp name)
647          (setf (gethash name table) value))))
648    (setq *nx-proclaimed-inline* table))))
649
650(defun proclaimed-special-p (sym)
651  (%ilogbitp $sym_vbit_special (%symbol-bits sym)))
652
653(defun proclaimed-inline-p (sym)
654  (if (listp *nx-proclaimed-inline*)
655    (%cdr (assq sym *nx-proclaimed-inline*))
656    (gethash sym *nx-proclaimed-inline*)))
657
658(defun proclaimed-notinline-p (sym)
659  (if (listp *nx-proclaimed-inline*)
660    (and (setq sym (assq sym *nx-proclaimed-inline*))
661         (null (%cdr sym)))
662    (null (gethash sym *nx-proclaimed-inline* t))))
663
664
665(defun self-evaluating-p (form)
666  (and (atom form)
667       (or (not (non-nil-symbol-p form))
668           (eq form t)
669           (keywordp form))))
670
671(defun constantp (form &optional env)
672  "True of any Lisp object that has a constant value: types that eval to
673  themselves, keywords, constants, and list whose car is QUOTE."
674   (or (self-evaluating-p form)
675       (quoted-form-p form)
676       (constant-symbol-p form)
677       (and env
678            (symbolp form)
679            (eq :constant (variable-information form env)))))
680
681
682(defun eval-constant (form)
683  (if (quoted-form-p form) (%cadr form)
684    (if (constant-symbol-p form) (symbol-value form)
685      (if (self-evaluating-p form) form
686        (report-bad-arg form '(satisfies constantp))))))
687
688(defvar *lfun-names*)
689
690
691(defvar %lambda-lists% (make-hash-table :test #'eq :weak t))
692(defparameter *save-arglist-info* t)
693
694
695(defun record-arglist (name args)
696  "Used by defmacro & defgeneric"
697  (when (or *save-arglist-info* *save-local-symbols*)
698    (setf (gethash name %lambda-lists%) args)))
699
700
701;;;Support the simple case of defsetf.
702(%fhave 'store-setf-method
703        (qlfun bootstrapping-store-setf-method (name fn &optional doc)
704          (declare (ignore doc))
705          (put name 'bootstrapping-setf-method (require-type fn 'symbol))))
706(%fhave '%setf-method
707        (qlfun bootstrapping-%setf-method (name)
708          (get name 'bootstrapping-setf-method)))
709
710
711;;; defmacro uses (setf (assq ...) ...) for &body forms.
712(defun adjoin-assq (indicator alist value)
713  (let ((cell (assq indicator alist)))
714    (if cell 
715      (setf (cdr cell) value)
716      (push (cons indicator value) alist)))
717  alist)
718
719(defmacro setf-assq (indicator place value)
720  (let ((res (gensym)))
721    `(let (,res)
722       (setf ,place (adjoin-assq ,indicator ,place (setq ,res ,value)))
723       ,res)))
724
725(defsetf assq setf-assq)
726(defsetf %typed-miscref %typed-miscset)
727
728(defun quoted-form-p (form)
729   (and (consp form)
730        (eq (%car form) 'quote)
731        (consp (%cdr form))
732        (null (%cdr (%cdr form)))))
733
734(defun lambda-expression-p (form)
735  (and (consp form)
736       (eq (%car form) 'lambda)
737       (consp (%cdr form))
738       (listp (%cadr form))))
739
740;;;;;FUNCTION BINDING Functions
741
742;;; A symbol's entrypoint contains:
743;;;  1) something tagged as $t_lfun if the symbol is
744;;;     not fbound as a macro or special form;
745;;;  2) a cons, otherwise, where the cdr is a fixnum
746;;;     whose value happens to be the same bit-pattern
747;;;     as a "jsr_subprim $sp-apply-macro" instruction.
748;;;     The car of this cons is either:
749;;;     a) a function -> macro-function;
750;;;     b) a symbol: special form not redefined as a macro.
751;;;     c) a cons whose car is a function -> macro function defined
752;;;        on a special form.
753
754
755
756
757(defun symbol-function (name)
758  "Return the definition of NAME, even if it is a macro or a special form.
759   Error if NAME doesn't have a definition."
760  (or (fboundp name) ;Our fboundp returns the binding
761      (prog1 (%err-disp $xfunbnd name))))
762
763(%fhave 'fdefinition #'symbol-function)
764
765
766(defun kernel-function-p (f)
767  (declare (ignore f))
768  nil)
769
770(defun %make-function (name fn env)
771  (compile-user-function fn name env))
772   
773;;;;;;;;; VALUE BINDING Functions
774
775(defun gensym (&optional (string-or-integer nil string-or-integer-p))
776  "Creates a new uninterned symbol whose name is a prefix string (defaults
777   to \"G\"), followed by a decimal number. Thing, when supplied, will
778   alter the prefix if it is a string, or be used for the decimal number
779   if it is a number, of this symbol. The default value of the number is
780   the current value of *gensym-counter* which is incremented each time
781   it is used."
782  (let ((prefix "G")
783        (counter nil))
784    (when string-or-integer-p
785      (etypecase string-or-integer
786        (integer (setq counter string-or-integer)) ; & emit-style-warning
787        (string (setq prefix (ensure-simple-string string-or-integer)))))
788    (unless counter
789      (setq *gensym-counter* (1+ (setq counter *gensym-counter*))))
790    (make-symbol (%str-cat prefix (%integer-to-string counter)))))
791
792(defun make-keyword (name)
793  (if (and (symbolp name) (eq (symbol-package name) *keyword-package*))
794    name
795    (values (intern (string name) *keyword-package*))))
796
797
798
799
800; destructive, removes first match only
801(defun remove-from-alist (thing alist)
802 (let ((start alist))
803  (if (eq thing (%caar alist))
804   (%cdr alist)
805   (let* ((prev start)
806          (this (%cdr prev))
807          (next (%cdr this)))
808    (while this
809     (if (eq thing (%caar this))
810      (progn
811       (%rplacd prev next)
812       (return-from remove-from-alist start))
813      (setq prev this
814            this next
815            next (%cdr next))))
816    start))))
817
818;destructive
819(defun add-to-alist (thing val alist &aux (pair (assq thing alist)))
820  (if pair
821    (progn (%rplacd pair thing) alist)
822    (cons (cons thing val) alist)))
823
824;non-destructive...
825(defun alist-adjoin (thing val alist &aux (pair (assq thing alist)))
826  (if (and pair (eq (%cdr pair) val))
827    alist
828    (cons (cons thing val) alist)))
829
830(defun %str-assoc (str alist)
831  (assoc str alist :test #'string-equal))
832
833(defstatic *pathname-escape-character*
834  #+windows-target #\>
835  #-windows-target #\\
836  "Not CL.  A Coral addition for compatibility between CL spec and the shell.")
837
838
839(defun caar (x)
840  "Return the car of the 1st sublist."
841 (car (car x)))
842
843(defun cadr (x)
844  "Return the 2nd object in a list."
845 (car (cdr x)))
846
847(defun cdar (x)
848  "Return the cdr of the 1st sublist."
849 (cdr (car x)))
850
851(defun cddr (x)
852  "Return all but the 1st two objects of a list."
853
854 (cdr (cdr x)))
855
856(defun caaar (x)
857  "Return the 1st object in the caar of a list."
858 (car (car (car x))))
859
860(defun caadr (x)
861  "Return the 1st object in the cadr of a list."
862 (car (car (cdr x))))
863
864(defun cadar (x)
865  "Return the car of the cdar of a list."
866 (car (cdr (car x))))
867
868(defun caddr (x)
869  "Return the 1st object in the cddr of a list."
870 (car (cdr (cdr x))))
871
872(defun cdaar (x)
873  "Return the cdr of the caar of a list."
874 (cdr (car (car x))))
875
876(defun cdadr (x)
877  "Return the cdr of the cadr of a list."
878 (cdr (car (cdr x))))
879
880(defun cddar (x)
881  "Return the cdr of the cdar of a list."
882 (cdr (cdr (car x))))
883
884(defun cdddr (x)
885  "Return the cdr of the cddr of a list."
886 (cdr (cdr (cdr x))))
887
888(defun cadddr (x)
889  "Return the car of the cdddr of a list."
890 (car (cdr (cdr (cdr x)))))
891
892(%fhave 'type-of #'%type-of)
893
894
895
896(defun pointerp (thing &optional errorp)
897  (if (macptrp thing)
898    t
899    (if errorp (error "~S is not a pointer" thing) nil)))
900
901
902;Add an item to a dialog items list handle.  HUH ?
903(defun %rsc-string (n)
904  (or (cdr (assq n *error-format-strings*))
905  (%str-cat "Error #" (%integer-to-string n))))
906
907(defun string-arg (arg)
908 (or (string-argp arg) (error "~S is not a string" arg)))
909
910(defun string-argp (arg)
911  (cond ((symbolp arg) (symbol-name arg))
912        ((typep arg 'character) (string arg))
913        ((stringp arg) (ensure-simple-string arg))
914        (t nil)))
915 
916(defun symbol-arg (arg)
917  (unless (symbolp arg)
918    (report-bad-arg arg 'symbol))
919  arg)
920
921(defun %cstrlen (ptr)
922  ;;(#_strlen ptr)
923  (do* ((i 0 (1+ i)))
924       ((zerop (the fixnum (%get-byte ptr i))) i)
925    (declare (fixnum i))))
926
927
928(defun %set-cstring (ptr string)
929  (%cstr-pointer string ptr)
930  string)
931
932(defsetf %get-cstring %set-cstring)
933
934;;; Deprecated, but used by UFFI.
935(defun %put-cstring (ptr str &optional (offset 0))
936  (setf (%get-cstring (%inc-ptr ptr offset)) str)
937  ;; 0 is the traditional, not-very-useful return value ...
938  0)
939
940
941
942
943
944
945;;; Returns a simple string and adjusted start and end, such that
946;;; 0<= start <= end <= (length simple-string).
947(defun get-sstring (str &optional (start 0) (end (length (require-type str 'string))))
948  (multiple-value-bind (sstr offset) (array-data-and-offset (string str))
949    (setq start (+ start offset) end (+ end offset))
950    (when (< (length sstr) end)(setq end (length sstr)))
951    (when (< end start) (setq start end))
952    (values sstr start end)))
953
954;e.g. (bad-named-arg :key key 'function)
955(defun bad-named-arg (name arg &optional (type nil type-p))
956  (if type-p
957    (%err-disp $err-bad-named-arg-2 name arg type)
958    (%err-disp $err-bad-named-arg name arg)))
959
960(defun verify-arg-count (call min &optional max)
961  "If call contains less than MIN number of args, or more than MAX
962   number of args, error. Otherwise, return call.
963   If Max is NIL, the maximum args for the fn are infinity."
964 (or (verify-call-count (car call) (%cdr call) min max) call))
965
966(defun verify-call-count (sym args min &optional max &aux argcount)
967  (if (%i< (setq argcount  (list-length args)) min)
968    (%err-disp $xtoofew (cons sym args))
969    (if (if max (%i> argcount max))
970      (%err-disp $xtoomany (cons sym args)))))
971
972(defun getf (place key &optional (default ()))
973  "Search the property list stored in Place for an indicator EQ to INDICATOR.
974  If one is found, return the corresponding value, else return DEFAULT."
975  (let ((p (pl-search place key))) (if p (%cadr p) default)))
976
977(defun remprop (symbol key)
978  "Look on property list of SYMBOL for property with specified
979  INDICATOR. If found, splice this indicator and its value out of
980  the plist, and return the tail of the original list starting with
981  INDICATOR. If not found, return () with no side effects.
982
983  NOTE: The ANSI specification requires REMPROP to return true (not false)
984  or false (the symbol NIL). Portable code should not rely on any other value."
985  (do* ((prev nil plist)
986        (plist (symbol-plist symbol) tail)
987        (tail (cddr plist) (cddr tail)))
988       ((null plist))
989    (when (eq (car plist) key)
990      (if prev
991        (rplacd (cdr prev) tail)
992        (setf (symbol-plist symbol) tail))
993      (return t))))
994
995
996
997;;; If this returns non-nil, safe to do %rplaca of %cdr to update.
998(defun pl-search (plist key)
999  (unless (plistp plist)
1000    (report-bad-arg plist '(satisfies plistp)))
1001  (%pl-search plist key))
1002
1003
1004(defun rassoc (item alist &key (test #'eql test-p) test-not (key #'identity))
1005  (declare (list alist))
1006  "Return the cons in ALIST whose CDR is equal (by a given test or EQL) to
1007   the ITEM."
1008  (if (or test-p (not test-not))
1009    (progn
1010      (if test-not (error "Cannot specify both :TEST and :TEST-NOT."))
1011      (dolist (pair alist)
1012        (if (atom pair)
1013          (if pair (error "Invalid alist containing ~S: ~S" pair alist))
1014          (when (funcall test item (funcall key (cdr pair))) (return pair)))))
1015    (progn
1016      (unless test-not (error "Must specify at least one of :TEST or :TEST-NOT"))
1017      (dolist (pair alist)
1018        (if (atom pair)
1019          (if pair (error "Invalid alist containing ~S: ~S" pair alist))
1020          (unless (funcall test-not item (funcall key (cdr pair))) (return pair)))))))
1021
1022(defun *%saved-method-var%* ()
1023  (declare (special %saved-method-var%))
1024  %saved-method-var%)
1025
1026(defun set-*%saved-method-var%* (new-value)
1027  (declare (special %saved-method-var%))
1028  (setq %saved-method-var% new-value))
1029
1030(defsetf *%saved-method-var%* set-*%saved-method-var%*)
1031
1032
1033
1034
1035
1036
1037(setf (symbol-function 'clear-type-cache) #'false)      ; bootstrapping
1038
1039(defun make-array-1 (dims element-type element-type-p
1040                          displaced-to
1041                          displaced-index-offset
1042                          adjustable
1043                          fill-pointer
1044                          initial-element initial-element-p
1045                          initial-contents initial-contents-p
1046                          size)
1047  (let ((subtype (element-type-subtype element-type)))
1048    (when (and element-type (null subtype))
1049      (error "Unknown element-type ~S" element-type))
1050    (when (null size)
1051      (cond ((listp dims)
1052             (setq size 1)
1053             (dolist (dim dims)
1054               (when (< dim 0)
1055                 (report-bad-arg dim '(integer 0 *)))
1056               (setq size (* size dim))))
1057            (t (setq size dims)))) ; no need to check vs. array-dimension-limit
1058    (cond
1059     (displaced-to
1060      (when (or initial-element-p initial-contents-p)
1061        (error "Cannot specify initial values for displaced arrays"))
1062      (when (and element-type-p
1063                 (neq (array-element-subtype displaced-to) subtype))
1064        (error "The ~S array ~S is not of ~S ~S"
1065               :displaced-to displaced-to :element-type element-type))
1066      (%make-displaced-array dims displaced-to
1067                             fill-pointer adjustable displaced-index-offset t))
1068     (t
1069      (when displaced-index-offset
1070        (error "Cannot specify ~S for non-displaced-array" :displaced-index-offset))
1071      (when (null subtype)
1072        (error "Cannot make an array of empty type ~S" element-type))
1073      (make-uarray-1 subtype dims adjustable fill-pointer 
1074                     initial-element initial-element-p
1075                     initial-contents initial-contents-p
1076                     nil size)))))
1077
1078(defun %make-simple-array (subtype dims)
1079  (let* ((size (if (listp dims) (apply #'* dims) dims))
1080         (vector (%alloc-misc size subtype)))
1081    (if (and (listp dims)
1082             (not (eql (length dims) 1)))
1083      (let* ((array (%make-displaced-array dims vector)))
1084        (%set-simple-array-p array)
1085        array)
1086      vector)))
1087
1088(defun make-uarray-1 (subtype dims adjustable fill-pointer
1089                              initial-element initial-element-p
1090                              initial-contents initial-contents-p
1091                              temporary 
1092                              size)
1093  (declare (ignore temporary))
1094  (when (null size)(setq size (if (listp dims)(apply #'* dims) dims)))
1095  (let ((vector (%alloc-misc size subtype)))  ; may not get here in that case
1096    (if initial-element-p
1097      (cond ((and (eql subtype target::subtag-simple-base-string)
1098                  (eql initial-element #\Null)))
1099            ((and (eql subtype target::subtag-double-float-vector)
1100                  (eql initial-element 0.0d0)))
1101            ((and (eql subtype target::subtag-single-float-vector)
1102                  (eql initial-element 0.0s0)))
1103            (t (or (eql initial-element 0)
1104                   (%init-misc initial-element vector))))
1105      (if initial-contents-p
1106        (if (null dims) (uvset vector 0 initial-contents)
1107            (init-uvector-contents vector 0 dims initial-contents))))
1108    (if (and (null fill-pointer)
1109             (not adjustable)
1110             dims
1111             (or (atom dims) (null (%cdr dims))))
1112      vector
1113      (let ((array (%make-displaced-array dims vector 
1114                                          fill-pointer adjustable nil)))
1115        (when (and (null fill-pointer) (not adjustable))
1116          (%set-simple-array-p array))
1117        array))))
1118
1119(defun init-uvector-contents (vect offset dims contents
1120                              &aux (len (length contents)))
1121  "Returns final offset. Assumes dims not ()."
1122  (unless (eq len (if (atom dims) dims (%car dims)))
1123    (error "~S doesn't match array dimensions of ~S ."  contents vect))
1124  (cond ((or (atom dims) (null (%cdr dims)))
1125         (if (listp contents)
1126           (let ((contents-tail contents))
1127             (dotimes (i len)
1128               (declare (fixnum i))
1129               (uvset vect offset (pop contents-tail))
1130               (setq offset (%i+ offset 1))))
1131           (dotimes (i len)
1132             (declare (fixnum i))
1133             (uvset vect offset (elt contents i))
1134             (setq offset (%i+ offset 1)))))
1135        (t (setq dims (%cdr dims))
1136           (if (listp contents)
1137             (let ((contents-tail contents))
1138               (dotimes (i len)
1139                 (declare (fixnum i))
1140                 (setq offset
1141                       (init-uvector-contents vect offset dims (pop contents-tail)))))
1142             (dotimes (i len)
1143               (declare (fixnum i))
1144               (setq offset
1145                     (init-uvector-contents vect offset dims (elt contents i)))))))
1146  offset)
1147
1148(defun %get-signed-long-long (ptr &optional (offset 0))
1149  (%%get-signed-longlong ptr offset))
1150
1151(defun %set-signed-long-long (ptr arg1
1152                                  &optional
1153                                  (arg2 (prog1 arg1 (setq arg1 0))))
1154  (%%set-signed-longlong ptr arg1 arg2))
1155                                 
1156(defun %get-unsigned-long-long (ptr &optional (offset 0))
1157  (%%get-unsigned-longlong ptr offset))
1158
1159(defun %set-unsigned-long-long (ptr arg1
1160                                  &optional
1161                                  (arg2 (prog1 arg1 (setq arg1 0))))
1162  (%%set-unsigned-longlong ptr arg1 arg2))
1163
1164(defun %composite-pointer-ref (size pointer offset)
1165  (declare (ignorable size))
1166  (%inc-ptr pointer offset))
1167
1168(defun %set-composite-pointer-ref (size pointer offset new)
1169  (#_memmove (%inc-ptr pointer offset)
1170             new
1171             size))
1172
1173
1174(defsetf %composite-pointer-ref %set-composite-pointer-ref)
1175
1176
1177(defsetf pathname-encoding-name set-pathname-encoding-name)
1178
1179;end of L1-utils.lisp
1180
Note: See TracBrowser for help on using the repository browser.