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

Last change on this file since 5453 was 5453, checked in by gb, 13 years ago

(temporary) mechanism to avoid constant-redefinition CERRORs.

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