source: branches/working-0711/ccl/level-1/l1-utils.lisp @ 12154

Last change on this file since 12154 was 12154, checked in by gz, 11 years ago

allow compound type specifiers as declarations identifiers. consistently do not allow unknown types as declaration identifers (i.e. report them as a bad declaration rather than unknown type)

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