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

Last change on this file since 12131 was 12131, checked in by gb, 10 years ago

Allow any type specifier to be used as a declaration identifier.
(I'm not sure if PROCLAIM/DECLAIM/DECLARE are all consistent about
whether the check for a valid type specifier happens before or
after the declaration is passed to the TYPE handler.)

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