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

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

Extend the mechanism used to warn about undefined and duplicate functions in a
compilation unit to do the same for types, use it for types defined by
deftype/defstruct/defclass.

Also make proclaim-type err on invalid types and warn about undefined ones.

Tighten up assorted type/ftype declaration checking. This in turn unleashed
a bunch of test suite tests requiring errors on conflicts between DECLARATION
declarations and types, so I put in checks for those as well.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 35.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 (proclaim-ftype (cons 'function (cddr spec)) (cadr spec)))
536    (t (unless (memq (%car spec) *nx-known-declarations*) ;not really right...
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 proclaim-type (type &rest vars)
543  (declare (dynamic-extent vars))
544  (dolist (var vars)
545    (if (symbolp var)
546      (let ((spec (assq var *nx-proclaimed-types*)))
547        ;; Check the type.  This will signal program-error's in case of invalid types, let it.
548        (when *type-system-initialized*
549          (handler-case (specifier-type type)
550            (parse-unknown-type (c) 
551              (warn "Undefined type ~s declaration for ~S" (parse-unknown-type-specifier c) var))))
552        (if spec
553          (rplacd spec type)
554          (push (cons var type) *nx-proclaimed-types*)))
555      (warn "Invalid type declaration for ~S" var))))
556
557(defun proclaim-ftype (ftype &rest names)
558  (declare (dynamic-extent names))
559  (unless *nx-proclaimed-ftypes*
560    (setq *nx-proclaimed-ftypes* (make-hash-table :test #'eq)))
561  (dolist (name names)
562    (setf (gethash (ensure-valid-function-name name) *nx-proclaimed-ftypes*) ftype)))
563
564
565
566(defun proclaimed-ftype (name)
567  (when *nx-proclaimed-ftypes*
568    (gethash (ensure-valid-function-name name) *nx-proclaimed-ftypes*)))
569
570
571(defun proclaim-special (&rest vars)
572  (declare (dynamic-extent vars))
573  (dolist (sym vars) (%proclaim-special sym)))
574
575
576(defun proclaim-notspecial (&rest vars)
577  (declare (dynamic-extent vars))
578  (dolist (sym vars) (%proclaim-notspecial sym)))
579
580(defun proclaim-inline (t-or-nil &rest names)
581  (declare (dynamic-extent names))
582  ;;This is just to make it more likely to detect forgetting about the
583  ;;first arg...
584  (unless (or (eq nil t-or-nil) (eq t t-or-nil)) (report-bad-arg t-or-nil '(member t nil)))
585  (dolist (name names)
586    (setq name (ensure-valid-function-name name))
587    (if (listp *nx-proclaimed-inline*)
588      (setq *nx-proclaimed-inline*
589          (alist-adjoin name
590                        (or t-or-nil (if (compiler-special-form-p name) t))
591                        *nx-proclaimed-inline*))     
592      (setf (gethash name *nx-proclaimed-inline*)
593            (or t-or-nil (if (compiler-special-form-p name) t))))))
594
595(defun proclaim-declaration (&rest syms)
596  (declare (dynamic-extent syms))
597  (dolist (sym syms)
598    (when (type-specifier-p sym)
599      (error "Cannot define declaration ~s because it is the name of a type" sym))
600    (setq *nx-known-declarations* 
601          (adjoin sym *nx-known-declarations* :test 'eq))))
602
603(defun check-declaration-redefinition (name why)
604  (when (memq name *nx-known-declarations*)
605    (cerror "Undeclare the declaration ~*~s"
606            "Cannot ~a ~s because ~:*~s has been declared as a declaration name" why name)
607    (setq *nx-known-declarations* (remove name *nx-known-declarations*))))
608
609(defun proclaim-ignore (t-or-nil &rest syms)
610  (declare (dynamic-extent syms))
611  ;;This is just to make it more likely to detect forgetting about the
612  ;;first arg...
613  (unless (or (eq nil t-or-nil) (eq t t-or-nil)) (report-bad-arg t-or-nil '(member t nil)))
614  (dolist (sym syms)
615    (setq *nx-proclaimed-ignore*
616          (alist-adjoin sym t-or-nil *nx-proclaimed-ignore*))))
617
618
619(queue-fixup
620 (when (listp *nx-proclaimed-inline*)
621  (let ((table (make-hash-table :size 100 :test #'eq)))
622    (dolist (x *nx-proclaimed-inline*)
623      (let ((name (car x)) (value (cdr x)))
624        (when (symbolp name)
625          (setf (gethash name table) value))))
626    (setq *nx-proclaimed-inline* table))))
627
628(defun proclaimed-special-p (sym)
629  (%ilogbitp $sym_vbit_special (%symbol-bits sym)))
630
631(defun proclaimed-inline-p (sym)
632  (if (listp *nx-proclaimed-inline*)
633    (%cdr (assq sym *nx-proclaimed-inline*))
634    (gethash sym *nx-proclaimed-inline*)))
635
636(defun proclaimed-notinline-p (sym)
637  (if (listp *nx-proclaimed-inline*)
638    (and (setq sym (assq sym *nx-proclaimed-inline*))
639         (null (%cdr sym)))
640    (null (gethash sym *nx-proclaimed-inline* t))))
641
642
643(defun self-evaluating-p (form)
644  (and (atom form)
645       (or (not (non-nil-symbol-p form))
646           (eq form t)
647           (keywordp form))))
648
649(defun constantp (form &optional env)
650  "True of any Lisp object that has a constant value: types that eval to
651  themselves, keywords, constants, and list whose car is QUOTE."
652   (or (self-evaluating-p form)
653       (quoted-form-p form)
654       (constant-symbol-p form)
655       (and env
656            (symbolp form)
657            (eq :constant (variable-information form env)))))
658
659
660(defun eval-constant (form)
661  (if (quoted-form-p form) (%cadr form)
662    (if (constant-symbol-p form) (symbol-value form)
663      (if (self-evaluating-p form) form
664        (report-bad-arg form '(satisfies constantp))))))
665
666(defvar *lfun-names*)
667
668
669(defvar %lambda-lists% (make-hash-table :test #'eq :weak t))
670(defparameter *save-arglist-info* t)
671
672
673(defun record-arglist (name args)
674  "Used by defmacro & defgeneric"
675  (when (or *save-arglist-info* *save-local-symbols*)
676    (setf (gethash name %lambda-lists%) args)))
677
678
679;;;Support the simple case of defsetf.
680(%fhave 'store-setf-method
681        (qlfun bootstrapping-store-setf-method (name fn &optional doc)
682          (declare (ignore doc))
683          (put name 'bootstrapping-setf-method (require-type fn 'symbol))))
684(%fhave '%setf-method
685        (qlfun bootstrapping-%setf-method (name)
686          (get name 'bootstrapping-setf-method)))
687
688
689;;; defmacro uses (setf (assq ...) ...) for &body forms.
690(defun adjoin-assq (indicator alist value)
691  (let ((cell (assq indicator alist)))
692    (if cell 
693      (setf (cdr cell) value)
694      (push (cons indicator value) alist)))
695  alist)
696
697(defmacro setf-assq (indicator place value)
698  (let ((res (gensym)))
699    `(let (,res)
700       (setf ,place (adjoin-assq ,indicator ,place (setq ,res ,value)))
701       ,res)))
702
703(defsetf assq setf-assq)
704(defsetf %typed-miscref %typed-miscset)
705
706(defun quoted-form-p (form)
707   (and (consp form)
708        (eq (%car form) 'quote)
709        (consp (%cdr form))
710        (null (%cdr (%cdr form)))))
711
712(defun lambda-expression-p (form)
713  (and (consp form)
714       (eq (%car form) 'lambda)
715       (consp (%cdr form))
716       (listp (%cadr form))))
717
718;;;;;FUNCTION BINDING Functions
719
720;;; A symbol's entrypoint contains:
721;;;  1) something tagged as $t_lfun if the symbol is
722;;;     not fbound as a macro or special form;
723;;;  2) a cons, otherwise, where the cdr is a fixnum
724;;;     whose value happens to be the same bit-pattern
725;;;     as a "jsr_subprim $sp-apply-macro" instruction.
726;;;     The car of this cons is either:
727;;;     a) a function -> macro-function;
728;;;     b) a symbol: special form not redefined as a macro.
729;;;     c) a cons whose car is a function -> macro function defined
730;;;        on a special form.
731
732
733
734
735(defun symbol-function (name)
736  "Return the definition of NAME, even if it is a macro or a special form.
737   Error if NAME doesn't have a definition."
738  (or (fboundp name) ;Our fboundp returns the binding
739      (prog1 (%err-disp $xfunbnd name))))
740
741(%fhave 'fdefinition #'symbol-function)
742
743
744(defun kernel-function-p (f)
745  (declare (ignore f))
746  nil)
747
748(defun %make-function (name fn env)
749  (compile-user-function fn name env))
750   
751;;;;;;;;; VALUE BINDING Functions
752
753(defun gensym (&optional (string-or-integer nil string-or-integer-p))
754  "Creates a new uninterned symbol whose name is a prefix string (defaults
755   to \"G\"), followed by a decimal number. Thing, when supplied, will
756   alter the prefix if it is a string, or be used for the decimal number
757   if it is a number, of this symbol. The default value of the number is
758   the current value of *gensym-counter* which is incremented each time
759   it is used."
760  (let ((prefix "G")
761        (counter nil))
762    (when string-or-integer-p
763      (etypecase string-or-integer
764        (integer (setq counter string-or-integer)) ; & emit-style-warning
765        (string (setq prefix (ensure-simple-string string-or-integer)))))
766    (unless counter
767      (setq *gensym-counter* (1+ (setq counter *gensym-counter*))))
768    (make-symbol (%str-cat prefix (%integer-to-string counter)))))
769
770(defun make-keyword (name)
771  (if (and (symbolp name) (eq (symbol-package name) *keyword-package*))
772    name
773    (values (intern (string name) *keyword-package*))))
774
775
776
777
778; destructive, removes first match only
779(defun remove-from-alist (thing alist)
780 (let ((start alist))
781  (if (eq thing (%caar alist))
782   (%cdr alist)
783   (let* ((prev start)
784          (this (%cdr prev))
785          (next (%cdr this)))
786    (while this
787     (if (eq thing (%caar this))
788      (progn
789       (%rplacd prev next)
790       (return-from remove-from-alist start))
791      (setq prev this
792            this next
793            next (%cdr next))))
794    start))))
795
796;destructive
797(defun add-to-alist (thing val alist &aux (pair (assq thing alist)))
798  (if pair
799    (progn (%rplacd pair thing) alist)
800    (cons (cons thing val) alist)))
801
802;non-destructive...
803(defun alist-adjoin (thing val alist &aux (pair (assq thing alist)))
804  (if (and pair (eq (%cdr pair) val))
805    alist
806    (cons (cons thing val) alist)))
807
808(defun %str-assoc (str alist)
809  (assoc str alist :test #'string-equal))
810
811(defstatic *pathname-escape-character*
812  #+windows-target #\'
813  #-windows-target #\\
814  "Not CL.  A Coral addition for compatibility between CL spec and the shell.")
815
816
817(defun caar (x)
818  "Return the car of the 1st sublist."
819 (car (car x)))
820
821(defun cadr (x)
822  "Return the 2nd object in a list."
823 (car (cdr x)))
824
825(defun cdar (x)
826  "Return the cdr of the 1st sublist."
827 (cdr (car x)))
828
829(defun cddr (x)
830  "Return all but the 1st two objects of a list."
831
832 (cdr (cdr x)))
833
834(defun caaar (x)
835  "Return the 1st object in the caar of a list."
836 (car (car (car x))))
837
838(defun caadr (x)
839  "Return the 1st object in the cadr of a list."
840 (car (car (cdr x))))
841
842(defun cadar (x)
843  "Return the car of the cdar of a list."
844 (car (cdr (car x))))
845
846(defun caddr (x)
847  "Return the 1st object in the cddr of a list."
848 (car (cdr (cdr x))))
849
850(defun cdaar (x)
851  "Return the cdr of the caar of a list."
852 (cdr (car (car x))))
853
854(defun cdadr (x)
855  "Return the cdr of the cadr of a list."
856 (cdr (car (cdr x))))
857
858(defun cddar (x)
859  "Return the cdr of the cdar of a list."
860 (cdr (cdr (car x))))
861
862(defun cdddr (x)
863  "Return the cdr of the cddr of a list."
864 (cdr (cdr (cdr x))))
865
866(defun cadddr (x)
867  "Return the car of the cdddr of a list."
868 (car (cdr (cdr (cdr x)))))
869
870(%fhave 'type-of #'%type-of)
871
872
873
874(defun pointerp (thing &optional errorp)
875  (if (macptrp thing)
876    t
877    (if errorp (error "~S is not a pointer" thing) nil)))
878
879
880;Add an item to a dialog items list handle.  HUH ?
881(defun %rsc-string (n)
882  (or (cdr (assq n *error-format-strings*))
883  (%str-cat "Error #" (%integer-to-string n))))
884
885(defun string-arg (arg)
886 (or (string-argp arg) (error "~S is not a string" arg)))
887
888(defun string-argp (arg)
889  (cond ((symbolp arg) (symbol-name arg))
890        ((typep arg 'character) (string arg))
891        ((stringp arg) (ensure-simple-string arg))
892        (t nil)))
893 
894(defun symbol-arg (arg)
895  (unless (symbolp arg)
896    (report-bad-arg arg 'symbol))
897  arg)
898
899(defun %cstrlen (ptr)
900  ;;(#_strlen ptr)
901  (do* ((i 0 (1+ i)))
902       ((zerop (the fixnum (%get-byte ptr i))) i)
903    (declare (fixnum i))))
904
905
906(defun %set-cstring (ptr string)
907  (%cstr-pointer string ptr)
908  string)
909
910(defsetf %get-cstring %set-cstring)
911
912;;; Deprecated, but used by UFFI.
913(defun %put-cstring (ptr str &optional (offset 0))
914  (setf (%get-cstring (%inc-ptr ptr offset)) str)
915  ;; 0 is the traditional, not-very-useful return value ...
916  0)
917
918
919
920
921
922
923;;; Returns a simple string and adjusted start and end, such that
924;;; 0<= start <= end <= (length simple-string).
925(defun get-sstring (str &optional (start 0) (end (length (require-type str 'string))))
926  (multiple-value-bind (sstr offset) (array-data-and-offset (string str))
927    (setq start (+ start offset) end (+ end offset))
928    (when (< (length sstr) end)(setq end (length sstr)))
929    (when (< end start) (setq start end))
930    (values sstr start end)))
931
932;e.g. (bad-named-arg :key key 'function)
933(defun bad-named-arg (name arg &optional (type nil type-p))
934  (if type-p
935    (%err-disp $err-bad-named-arg-2 name arg type)
936    (%err-disp $err-bad-named-arg name arg)))
937
938(defun verify-arg-count (call min &optional max)
939  "If call contains less than MIN number of args, or more than MAX
940   number of args, error. Otherwise, return call.
941   If Max is NIL, the maximum args for the fn are infinity."
942 (or (verify-call-count (car call) (%cdr call) min max) call))
943
944(defun verify-call-count (sym args min &optional max &aux argcount)
945  (if (%i< (setq argcount  (list-length args)) min)
946    (%err-disp $xtoofew (cons sym args))
947    (if (if max (%i> argcount max))
948      (%err-disp $xtoomany (cons sym args)))))
949
950(defun getf (place key &optional (default ()))
951  "Search the property list stored in Place for an indicator EQ to INDICATOR.
952  If one is found, return the corresponding value, else return DEFAULT."
953  (let ((p (pl-search place key))) (if p (%cadr p) default)))
954
955(defun remprop (symbol key)
956  "Look on property list of SYMBOL for property with specified
957  INDICATOR. If found, splice this indicator and its value out of
958  the plist, and return the tail of the original list starting with
959  INDICATOR. If not found, return () with no side effects.
960
961  NOTE: The ANSI specification requires REMPROP to return true (not false)
962  or false (the symbol NIL). Portable code should not rely on any other value."
963  (do* ((prev nil plist)
964        (plist (symbol-plist symbol) tail)
965        (tail (cddr plist) (cddr tail)))
966       ((null plist))
967    (when (eq (car plist) key)
968      (if prev
969        (rplacd (cdr prev) tail)
970        (setf (symbol-plist symbol) tail))
971      (return t))))
972
973
974
975;;; If this returns non-nil, safe to do %rplaca of %cdr to update.
976(defun pl-search (plist key)
977  (unless (plistp plist)
978    (report-bad-arg plist '(satisfies plistp)))
979  (%pl-search plist key))
980
981
982(defun rassoc (item alist &key (test #'eql test-p) test-not (key #'identity))
983  (declare (list alist))
984  "Return the cons in ALIST whose CDR is equal (by a given test or EQL) to
985   the ITEM."
986  (if (or test-p (not test-not))
987    (progn
988      (if test-not (error "Cannot specify both :TEST and :TEST-NOT."))
989      (dolist (pair alist)
990        (if (atom pair)
991          (if pair (error "Invalid alist containing ~S: ~S" pair alist))
992          (when (funcall test item (funcall key (cdr pair))) (return pair)))))
993    (progn
994      (unless test-not (error "Must specify at least one of :TEST or :TEST-NOT"))
995      (dolist (pair alist)
996        (if (atom pair)
997          (if pair (error "Invalid alist containing ~S: ~S" pair alist))
998          (unless (funcall test-not item (funcall key (cdr pair))) (return pair)))))))
999
1000(defun *%saved-method-var%* ()
1001  (declare (special %saved-method-var%))
1002  %saved-method-var%)
1003
1004(defun set-*%saved-method-var%* (new-value)
1005  (declare (special %saved-method-var%))
1006  (setq %saved-method-var% new-value))
1007
1008(defsetf *%saved-method-var%* set-*%saved-method-var%*)
1009
1010
1011
1012
1013
1014
1015(setf (symbol-function 'clear-type-cache) #'false)      ; bootstrapping
1016
1017(defun make-array-1 (dims element-type element-type-p
1018                          displaced-to
1019                          displaced-index-offset
1020                          adjustable
1021                          fill-pointer
1022                          initial-element initial-element-p
1023                          initial-contents initial-contents-p
1024                          size)
1025  (let ((subtype (element-type-subtype element-type)))
1026    (when (and element-type (null subtype))
1027      (error "Unknown element-type ~S" element-type))
1028    (when (null size)
1029      (cond ((listp dims)
1030             (setq size 1)
1031             (dolist (dim dims)
1032               (when (< dim 0)
1033                 (report-bad-arg dim '(integer 0 *)))
1034               (setq size (* size dim))))
1035            (t (setq size dims)))) ; no need to check vs. array-dimension-limit
1036    (cond
1037     (displaced-to
1038      (when (or initial-element-p initial-contents-p)
1039        (error "Cannot specify initial values for displaced arrays"))
1040      (when (and element-type-p
1041                 (neq (array-element-subtype displaced-to) subtype))
1042        (error "The ~S array ~S is not of ~S ~S"
1043               :displaced-to displaced-to :element-type element-type))
1044      (%make-displaced-array dims displaced-to
1045                             fill-pointer adjustable displaced-index-offset t))
1046     (t
1047      (when displaced-index-offset
1048        (error "Cannot specify ~S for non-displaced-array" :displaced-index-offset))
1049      (when (null subtype)
1050        (error "Cannot make an array of empty type ~S" element-type))
1051      (make-uarray-1 subtype dims adjustable fill-pointer 
1052                     initial-element initial-element-p
1053                     initial-contents initial-contents-p
1054                     nil size)))))
1055
1056(defun %make-simple-array (subtype dims)
1057  (let* ((size (if (listp dims) (apply #'* dims) dims))
1058         (vector (%alloc-misc size subtype)))
1059    (if (and (listp dims)
1060             (not (eql (length dims) 1)))
1061      (let* ((array (%make-displaced-array dims vector)))
1062        (%set-simple-array-p array)
1063        array)
1064      vector)))
1065
1066(defun make-uarray-1 (subtype dims adjustable fill-pointer
1067                              initial-element initial-element-p
1068                              initial-contents initial-contents-p
1069                              temporary 
1070                              size)
1071  (declare (ignore temporary))
1072  (when (null size)(setq size (if (listp dims)(apply #'* dims) dims)))
1073  (let ((vector (%alloc-misc size subtype)))  ; may not get here in that case
1074    (if initial-element-p
1075      (dotimes (i (uvsize vector)) (declare (fixnum i))(uvset vector i initial-element))
1076      (if initial-contents-p
1077        (if (null dims) (uvset vector 0 initial-contents)
1078            (init-uvector-contents vector 0 dims initial-contents))))
1079    (if (and (null fill-pointer)
1080             (not adjustable)
1081             dims
1082             (or (atom dims) (null (%cdr dims))))
1083      vector
1084      (let ((array (%make-displaced-array dims vector 
1085                                          fill-pointer adjustable nil)))
1086        (when (and (null fill-pointer) (not adjustable))
1087          (%set-simple-array-p array))
1088        array))))
1089
1090(defun init-uvector-contents (vect offset dims contents
1091                              &aux (len (length contents)))
1092  "Returns final offset. Assumes dims not ()."
1093  (unless (eq len (if (atom dims) dims (%car dims)))
1094    (error "~S doesn't match array dimensions of ~S ."  contents vect))
1095  (cond ((or (atom dims) (null (%cdr dims)))
1096         (if (listp contents)
1097           (let ((contents-tail contents))
1098             (dotimes (i len)
1099               (declare (fixnum i))
1100               (uvset vect offset (pop contents-tail))
1101               (setq offset (%i+ offset 1))))
1102           (dotimes (i len)
1103             (declare (fixnum i))
1104             (uvset vect offset (elt contents i))
1105             (setq offset (%i+ offset 1)))))
1106        (t (setq dims (%cdr dims))
1107           (if (listp contents)
1108             (let ((contents-tail contents))
1109               (dotimes (i len)
1110                 (declare (fixnum i))
1111                 (setq offset
1112                       (init-uvector-contents vect offset dims (pop contents-tail)))))
1113             (dotimes (i len)
1114               (declare (fixnum i))
1115               (setq offset
1116                     (init-uvector-contents vect offset dims (elt contents i)))))))
1117  offset)
1118
1119(defun %get-signed-long-long (ptr &optional (offset 0))
1120  (%%get-signed-longlong ptr offset))
1121
1122(defun %set-signed-long-long (ptr arg1
1123                                  &optional
1124                                  (arg2 (prog1 arg1 (setq arg1 0))))
1125  (%%set-signed-longlong ptr arg1 arg2))
1126                                 
1127(defun %get-unsigned-long-long (ptr &optional (offset 0))
1128  (%%get-unsigned-longlong ptr offset))
1129
1130(defun %set-unsigned-long-long (ptr arg1
1131                                  &optional
1132                                  (arg2 (prog1 arg1 (setq arg1 0))))
1133  (%%set-unsigned-longlong ptr arg1 arg2))
1134
1135(defun %composite-pointer-ref (size pointer offset)
1136  (declare (ignorable size))
1137  (%inc-ptr pointer offset))
1138
1139(defun %set-composite-pointer-ref (size pointer offset new)
1140  (#_memmove (%inc-ptr pointer offset)
1141             new
1142             size))
1143
1144
1145(defsetf %composite-pointer-ref %set-composite-pointer-ref)
1146
1147
1148(defsetf pathname-encoding-name set-pathname-encoding-name)
1149
1150;end of L1-utils.lisp
1151
Note: See TracBrowser for help on using the repository browser.