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

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

Some changes from trunk in suport of other platforms, shouldn't affect anything here

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