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

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

Finish source location and pc -> source mapping support, from working-0711 but with some modifications.

Details:

Source location are recorded in CCL:SOURCE-NOTE's, which are objects with accessors CCL:SOURCE-NOTE-FILENAME, CCL:SOURCE-NOTE-START-POS, CCL:SOURCE-NOTE-END-POS and CCL:SOURCE-NOTE-TEXT. The start and end positions are file positions (not character positions). The text will be NIL unless text recording was on at read-time. If the original file is still available, you can force missing source text to be read from the file at runtime via CCL:ENSURE-SOURCE-NOTE-TEXT.

Source-note's are associated with definitions (via record-source-file) and also stored in function objects (including anonymous and nested functions). The former can be retrieved via CCL:FIND-DEFINITION-SOURCES, the latter via CCL:FUNCTION-SOURCE-NOTE.

The recording behavior is controlled by the new variable CCL:*SAVE-SOURCE-LOCATIONS*:

If NIL, don't store source-notes in function objects, and store only the filename for definitions (the latter only if *record-source-file* is true).
If T, store source-notes, including a copy of the original source text, for function objects and definitions (the latter only if *record-source-file* is true).
If :NO-TEXT, store source-notes, but without saved text, for function objects and defintions (the latter only if *record-source-file* is true). This is the default.

PC to source mapping is controlled by the new variable CCL:*RECORD-PC-MAPPING*. If true (the default), functions store a compressed table mapping pc offsets to corresponding source locations. This can be retrieved by (CCL:FIND-SOURCE-NOTE-AT-PC function pc) which returns a source-note for the source at offset pc in the function.

Currently the only thing that makes use of any of this is the disassembler. ILISP and current version of Slime still use backward-compatible functions that deal with filenames only. The plan is to make Slime, and our IDE, use this eventually.

Known bug: most of this only works through the file compiler. Still need to make it work with loading from source (not hard, just haven't gotten to it yet).

This checkin incidentally includes bits and pieces of support for code coverage, which is still
incomplete and untested. Ignore it.

The PPC version is untested. I need to check it in so I can move to a PPC for testing.

Sizes:

18387152 Nov 16 10:00 lx86cl64.image-no-loc-no-pc
19296464 Nov 16 10:11 lx86cl64.image-loc-no-text-no-pc
20517072 Nov 16 09:58 lx86cl64.image-loc-no-text-with-pc [default]
25514192 Nov 16 09:55 lx86cl64.image-loc-with-text-with-pc

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