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

Last change on this file since 12069 was 12069, checked in by gz, 10 years ago

merge r12050

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