source: trunk/ccl/lib/macros.lisp @ 882

Last change on this file since 882 was 882, checked in by gb, 16 years ago

DEFCLASS macro: handle :DOCUMENTATION as a single option, if provided.
Don't default superclasses (from Tim Moore.). Pass class name, not class,
in :METACLASS option.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 111.2 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;;; Macros (and functions/constants used at macroexpand-time) ONLY.
18
19(in-package :ccl)
20
21(eval-when (eval compile)
22  (require "LEVEL-2")
23  (require "BACKQUOTE")
24  (require "DEFSTRUCT-MACROS"))
25
26;; Constants
27
28(defmacro defconstant (sym val &optional (doc () doc-p) &environment env)
29  (setq sym (require-type sym 'symbol)
30        doc (if doc-p (require-type doc 'string)))
31  `(progn
32     (eval-when (:compile-toplevel)
33       (define-compile-time-constant ',sym ',val ,env))
34     (eval-when (:load-toplevel :execute)
35       (%defconstant ',sym ,val ,@(if doc-p (list doc))))))
36
37;; Lists
38
39(defmacro %car (x)
40  `(car (the cons ,x)))
41
42(defmacro %cdr (x)
43  `(cdr (the cons ,x)))
44
45(defmacro %caar (x)
46 `(%car (%car ,x)))
47
48(defmacro %cadr (x)
49 `(%car (%cdr ,x)))
50
51(defmacro %cdar (x)
52 `(%cdr (%car ,x)))
53
54(defmacro %cddr (x)
55 `(%cdr (%cdr ,x)))
56
57(defmacro %caaar (x)
58 `(%car (%car (%car ,x))))
59
60(defmacro %caadr (x)
61 `(%car (%car (%cdr ,x))))
62
63(defmacro %cadar (x)
64 `(%car (%cdr (%car ,x))))
65
66(defmacro %caddr (x)
67 `(%car (%cdr (%cdr ,x))))
68
69(defmacro %cdaar (x)
70 `(%cdr (%car (%car ,x))))
71
72(defmacro %cdadr (x)
73 `(%cdr (%car (%cdr ,x))))
74
75(defmacro %cddar (x)
76 `(%cdr (%cdr (%car ,x))))
77
78(defmacro %cdddr (x)
79 `(%cdr (%cdr (%cdr ,x))))
80
81(defmacro %rplaca (x y)
82  `(rplaca (the cons ,x) ,y))
83
84(defmacro %rplacd (x y)
85  `(rplacd (the cons ,x) ,y))
86
87; These are open-coded by the compiler to isolate platform
88; dependencies.
89
90(defmacro %unbound-marker-8 ()
91  `(%unbound-marker))
92
93(defmacro %slot-missing-marker ()
94  `(%illegal-marker))
95
96
97
98
99(defmacro %null-ptr () '(%int-to-ptr 0))
100
101;;;Assorted useful macro definitions
102
103(defmacro def-accessors (ref &rest names)
104  (define-accessors ref names))
105
106(defmacro def-accessor-macros (ref &rest names)
107  (define-accessors ref names t))
108
109(defun define-accessors (ref names &optional no-constants
110                             &aux (arg (gensym)) (index 0) progn types)
111  (when (listp ref)
112    (setq types ref
113          ref (pop names)))
114  (dolist (name names)
115    (when name
116      (unless (listp name) (setq name (list name)))
117      (dolist (sym name)
118        (when sym
119          (push `(defmacro ,sym (,arg) (list ',ref ,arg ,index)) progn)
120          (unless no-constants
121            (push `(defconstant ,sym ,index) progn)))))
122    (setq index (1+ index)))
123 `(progn
124    ,.(nreverse progn)
125    ,@(if types `((add-accessor-types ',types ',names)))
126    ,index))
127
128(defmacro specialv (var)
129  `(locally (declare (special ,var)) ,var))
130
131
132(defmacro prog1 (valform &rest otherforms)
133 (let ((val (gensym)))
134 `(let ((,val ,valform))
135   ,@otherforms
136   ,val)))
137
138(defmacro prog2 (first second &rest others)
139 `(progn ,first (prog1 ,second ,@others)))
140
141(defmacro prog (inits &body body &environment env)
142  (multiple-value-bind (forms decls) (parse-body body env nil)
143    `(block nil
144       (let ,inits
145         ,@decls
146         (tagbody ,@forms)))))
147
148(defmacro prog* (inits &body body &environment env)
149  (multiple-value-bind (forms decls) (parse-body body env nil)
150    `(block nil
151       (let* ,inits
152         ,@decls
153         (tagbody ,@forms)))))
154
155
156(defmacro %stack-block ((&rest specs) &body forms &aux vars lets)
157  (dolist (spec specs)
158    (destructuring-bind (var ptr &key clear) spec
159      (push var vars)
160      (push `(,var (%new-ptr ,ptr ,clear)) lets)))
161  `(let* ,(nreverse lets)
162     (declare (dynamic-extent ,@vars))
163     (declare (type macptr ,@vars))
164     (declare (unsettable ,@vars))
165     ,@forms))
166
167(defmacro %vstack-block (spec &body forms)
168  `(%stack-block (,spec) ,@forms))
169
170(defmacro dolist ((varsym list &optional ret) &body body &environment env)
171  (if (not (symbolp varsym)) (signal-program-error $XNotSym varsym))
172  (let* ((toplab (gensym))
173         (tstlab (gensym))
174         (lstsym (gensym)))
175    (multiple-value-bind (forms decls) (parse-body body env nil)
176     `(block nil
177       (let* ((,lstsym ,list) ,varsym)
178        ,@decls
179          (tagbody
180            (go ,tstlab)
181            ,toplab
182            (setq ,lstsym (cdr (the list ,lstsym)))
183            ,@forms
184            ,tstlab
185            (setq ,varsym (car ,lstsym))
186            (if ,lstsym (go ,toplab)))
187          ,@(if ret `((progn  ,ret))))))))
188
189
190(defmacro dovector ((varsym vector &optional ret) &body body &environment env)
191  (if (not (symbolp varsym))(signal-program-error $XNotSym varsym))
192  (let* ((toplab (gensym))
193         (tstlab (gensym))
194         (lengthsym (gensym))
195         (indexsym (gensym))
196         (vecsym (gensym)))
197    (multiple-value-bind (forms decls) (parse-body body env nil)
198     `(let* ((,vecsym ,vector)
199             (,lengthsym (length ,vecsym))
200             (,indexsym 0)
201             ,varsym)
202        ,@decls
203        ,@(let ((type (nx-form-type vector env)))
204            (unless (eq type t)
205              `((declare (type ,type ,vecsym)))))
206        (block nil
207          (tagbody
208            (go ,tstlab)
209            ,toplab
210            (setq ,varsym (locally (declare (optimize (speed 3) (safety 0)))
211                            (aref ,vecsym ,indexsym))
212                  ,indexsym (%i+ ,indexsym 1))
213            ,@forms
214            ,tstlab
215            (if (%i< ,indexsym ,lengthsym) (go ,toplab)))
216          ,@(if ret `((progn (setq ,varsym nil) ,ret))))))))
217
218(defmacro report-bad-arg (&rest args)
219  `(values (%badarg ,@args)))
220
221(defmacro %cons-restart (name action report interactive test)
222 `(gvector :istruct 'restart ,name ,action ,report ,interactive ,test))
223
224(defmacro restart-bind (clauses &body body)
225  (let* ((restarts (mapcar #'(lambda (clause) 
226                               (list (make-symbol (symbol-name (require-type (car clause) 'symbol)))
227                                     `(%cons-restart nil nil nil nil nil)))
228                           clauses))
229         (bindings (mapcar #'(lambda (clause name)
230                              `(make-restart ,(car name) ',(car clause)
231                                             ,@(cdr clause)))
232                           clauses restarts))
233        (cluster (gensym)))
234    `(let* (,@restarts)
235       (declare (dynamic-extent ,@(mapcar #'car restarts)))
236       (let* ((,cluster (list ,@bindings))
237              (%restarts% (cons ,cluster %restarts%)))
238         (declare (dynamic-extent ,cluster %restarts%))
239         (progn
240           ,@body)))))
241
242(defmacro handler-bind (clauses &body body)
243  (let* ((fns)
244         (decls)         
245         (bindings (mapcan #'(lambda (clause)
246                               (destructuring-bind (condition handler) clause
247                                 (if (and (consp handler)(eq (car handler) 'function)
248                                          (consp (cadr handler))(eq (car (cadr handler)) 'lambda))
249                                   (let ((fn (gensym)))
250                                     (push `(,fn ,handler) fns)
251                                     (push `(declare (dynamic-extent ,fn)) decls)
252                                     `(',condition ,fn))
253                                   (list `',condition
254                                         `,handler))))
255                           clauses))
256        (cluster (gensym)))   
257    `(let* (,@fns
258            (,cluster (list ,@bindings))
259            (%handlers% (cons ,cluster %handlers%)))
260       (declare (dynamic-extent ,cluster %handlers%))
261       ,@decls
262       (progn
263         ,@body))))
264
265(defmacro restart-case (&environment env form &rest clauses)
266  (let ((cluster nil))
267    (when clauses (setq cluster (gensym) form (restart-case-form form env cluster)))
268    (flet ((restart-case-1 (name arglist &rest forms)
269             (let (interactive report test)
270               (loop
271                 (case (car forms)
272                   (:interactive (setq interactive (cadr forms)))
273                   (:report (setq report (cadr forms)))
274                   (:test (setq test (cadr forms)))
275                   (t (return nil)))
276                 (setq forms (cddr forms)))
277               (when (and report (not (stringp report)))
278                 (setq report `#',report))
279               (when interactive
280                 (setq interactive `#',interactive))
281               (when test
282                 (setq test `#',test))
283               (values (require-type name 'symbol) arglist report interactive test forms))))
284      (cond ((null clauses) form)
285            ((and (null (cdr clauses)) (null (cadr (car clauses))))
286             (let ((block (gensym)) 
287                   (restart-name (gensym)))
288               (multiple-value-bind (name arglist report interactive test body)
289                                    (apply #'restart-case-1 (car clauses))
290                 (declare (ignore arglist))
291                 `(block ,block
292                    (let* ((,restart-name (%cons-restart ',name () ,report ,interactive ,test))
293                           (,cluster (list ,restart-name))
294                           (%restarts% (cons ,cluster %restarts%)))
295                      (declare (dynamic-extent ,restart-name ,cluster %restarts%))
296                      (catch ,cluster (return-from ,block ,form)))
297                    ,@body))))
298            (t
299             (let ((block (gensym)) (val (gensym))
300                   (index -1) restarts restart-names restart-name cases)
301               (while clauses
302                 (setq index (1+ index))
303                 (multiple-value-bind (name arglist report interactive test body)
304                                      (apply #'restart-case-1 (pop clauses))
305                   (push (setq restart-name (make-symbol (symbol-name name))) restart-names)
306                   (push (list restart-name `(%cons-restart ',name ,index ,report ,interactive ,test))
307                         restarts)
308                   (when (null clauses) (setq index t))
309                   (push `(,index (apply #'(lambda ,arglist ,@body) ,val))
310                         cases)))
311               `(block ,block
312                  (let ((,val (let* (,@restarts
313                                     (,cluster (list ,@(reverse restart-names)))
314                                     (%restarts% (cons ,cluster %restarts%)))
315                                (declare (dynamic-extent ,@restart-names ,cluster %restarts%))
316                                (catch ,cluster (return-from ,block ,form)))))
317                    (case (pop ,val)
318                      ,@(nreverse cases))))))))))
319
320
321; Anything this hairy should die a slow and painful death.
322; Unless, of course, I grossly misunderstand...
323(defun restart-case-form (form env clustername)
324  (let ((expansion (macroexpand form env))
325        (head nil))
326    (if (and (listp expansion)          ; already an ugly hack, made uglier by %error case ...
327             (memq (setq head (pop expansion)) '(signal error cerror warn %error)))
328      (let ((condform nil)
329            (signalform nil)
330            (cname (gensym)))
331        (case head
332          (cerror
333           (destructuring-bind 
334             (continue cond &rest args) expansion
335             (setq condform `(condition-arg ,cond (list ,@args) 'simple-error)
336                   signalform `(cerror ,continue ,cname))))
337          ((signal error warn)
338           (destructuring-bind
339             (cond &rest args) expansion
340             (setq condform `(condition-arg ,cond (list ,@args) ,(if (eq head 'warning)
341                                                                   ''simple-warning
342                                                                   (if (eq head 'error)
343                                                                     ''simple-error
344                                                                     ''simple-condition)))
345                   signalform `(,head ,cname))))
346          (t ;%error
347           (destructuring-bind (cond args fp) expansion
348             (setq condform `(condition-arg ,cond ,args 'simple-error)
349                   signalform `(%error ,cname nil ,fp)))))
350        `(let ((,cname ,condform))
351           (with-condition-restarts ,cname ,clustername
352             ,signalform)))
353      form)))
354     
355
356(defmacro handler-case (form &rest clauses &aux last)
357  (flet ((handler-case (type var &rest body)
358           (when (eq type :no-error)
359             (signal-program-error "The :no-error clause must be last."))
360           (values type var body)))
361    (cond ((null clauses) form)
362          ((eq (car (setq last (car (last clauses)))) :no-error)
363           (let ((error (gensym))
364                 (block (gensym))
365                 (var   (cadr last)))
366             (if var
367               `(block ,error
368                  (multiple-value-call #'(lambda ,@(cdr last))
369                                       (block ,block
370                                         (return-from ,error
371                                           (handler-case (return-from ,block ,form)
372                                             ,@(butlast clauses))))))
373               `(block ,error
374                  (block ,block
375                    (return-from ,error
376                      (handler-case (return-from ,block ,form)
377                        ,@(butlast clauses))))
378                  (locally ,@(cddr last))))))
379          ((null (cdr clauses))
380           (let ((block   (gensym))
381                 (cluster (gensym)))
382             (multiple-value-bind (type var body)
383                                  (apply #'handler-case (car clauses))
384               (if var
385                 `(block ,block
386                    ((lambda ,var ,@body)
387                      (let* ((,cluster (list ',type))
388                            (%handlers% (cons ,cluster %handlers%)))
389                       (declare (dynamic-extent ,cluster %handlers%))
390                       (catch ,cluster (return-from ,block ,form)))))
391                 `(block ,block
392                    (let* ((,cluster (list ',type))
393                           (%handlers% (cons ,cluster %handlers%)))
394                      (declare (dynamic-extent ,cluster %handlers%))
395                      (catch ,cluster (return-from ,block ,form)))
396                    (locally ,@body))))))
397          (t (let ((block (gensym)) (cluster (gensym)) (val (gensym))
398                   (index -1) handlers cases)
399               (while clauses
400                 (setq index (1+ index))
401                 (multiple-value-bind (type var body)
402                                      (apply #'handler-case (pop clauses))                   
403                   (push `',type handlers)
404                   (push index handlers)
405                   (when (null clauses) (setq index t))
406                   (push (if var
407                           `(,index ((lambda ,var ,@body) ,val))
408                           `(,index (locally ,@body))) cases)))
409               `(block ,block
410                  (let ((,val (let* ((,cluster (list ,@(nreverse handlers)))
411                                     (%handlers% (cons ,cluster %handlers%)))
412                                (declare (dynamic-extent ,cluster %handlers%))
413                                (catch ,cluster (return-from ,block ,form)))))
414                    (case (pop ,val)
415                      ,@(nreverse cases)))))))))
416
417(defmacro with-simple-restart ((restart-name format-string &rest format-args)
418                               &body body
419                               &aux (cluster (gensym)) (temp (make-symbol (symbol-name restart-name))))
420  (unless (and (stringp format-string)
421               (null format-args)
422               (not (%str-member #\~ (ensure-simple-string format-string))))
423    (let ((stream (gensym)))
424      (setq format-string `#'(lambda (,stream) (format ,stream ,format-string ,@format-args)))))
425  `(let* ((,temp (%cons-restart ',restart-name
426                                'simple-restart
427                                ,format-string
428                                nil
429                                nil))
430          (,cluster (list ,temp))
431          (%restarts% (cons ,cluster %restarts%)))
432     (declare (dynamic-extent ,temp ,cluster %restarts%))
433     (catch ,cluster ,@body)))
434
435;Like with-simple-restart but takes a pre-consed restart.  Not CL.
436(defmacro with-restart (restart &body body &aux (cluster (gensym)))
437  `(let* ((,cluster (list ,restart))
438          (%restarts% (cons ,cluster %restarts%)))
439     (declare (dynamic-extent ,cluster %restarts%))
440     (catch ,cluster ,@body)))
441
442(defmacro ignore-errors (&rest forms)
443  `(handler-case (progn ,@forms)
444     (error (condition) (values nil condition))))
445
446(defmacro def-kernel-restart (&environment env errno name arglist &body body)
447  (multiple-value-bind (body decls)
448                       (parse-body body env)
449    `(let* ((fn (nfunction ,name (lambda ,arglist ,@decls (block ,name ,@body))))
450            (pair (assq ,errno ccl::*kernel-restarts*)))
451       (if pair
452         (rplacd pair fn)
453         (push (cons ,errno fn) ccl::*kernel-restarts*))
454       fn)))
455
456
457;;; Setf.
458
459;  If you change anything here, be sure to make the corresponding change
460;  in get-setf-method.
461(defmacro setf (&rest args &environment env)
462  "Takes pairs of arguments like SETQ.  The first is a place and the second
463  is the value that is supposed to go into that place.  Returns the last
464  value.  The place argument may be any of the access forms for which SETF
465  knows a corresponding setting form."
466  (let ((temp (length args))
467        (accessor nil))
468    (cond ((eq temp 2)
469           (let* ((form (car args)) 
470                  (value (cadr args)))
471             ;This must match get-setf-method .
472             (if (atom form)
473               (progn
474                 (unless (symbolp form)(signal-program-error $XNotSym form))
475                 `(setq ,form ,value))
476               (multiple-value-bind (ftype local-p)
477                                    (function-information (setq accessor (car form)) ENV)
478                 (if local-p
479                   (if (eq ftype :function)
480                     ;Local function, so don't use global setf definitions.
481                     (default-setf form value env)
482                     `(setf ,(macroexpand-1 form env) ,value))
483                   (cond
484                    ((setq temp (%setf-method accessor))
485                     (if (symbolp temp)
486                       `(,temp ,@(cdar args) ,value)
487                       (multiple-value-bind (dummies vals storevars setter #|getter|#)
488                                            (funcall temp form env)
489                         (do* ((d dummies (cdr d))
490                               (v vals (cdr v))
491                               (let-list nil))
492                              ((null d)
493                               (setq let-list (nreverse let-list))
494                               `(let* ,let-list
495                                  (declare (ignorable ,@dummies))
496                                  (multiple-value-bind ,storevars ,value
497                                    #|,getter|#
498                                    ,setter)))
499                           (push (list (car d) (car v)) let-list)))))
500                    ((and (type-and-refinfo-p (setq temp (or (environment-structref-info accessor env)
501                                                             (and #-bccl (boundp '%structure-refs%)
502                                                                  (gethash accessor %structure-refs%)))))
503                          (not (refinfo-r/o (if (consp temp) (%cdr temp) temp))))
504                     (if (consp temp)
505                       ;; strip off type, but add in a require-type
506                       (let ((type (%car temp)))
507                         `(the ,type (setf ,(defstruct-ref-transform (%cdr temp) (%cdar args))
508                                           (require-type ,value ',type))))
509                       `(setf ,(defstruct-ref-transform temp (%cdar args))
510                              ,value)))
511                    (t
512                     (multiple-value-bind (res win)
513                                          (macroexpand-1 form env)
514                       (if win
515                         `(setf ,res ,value)
516                         (default-setf form value env))))))))))
517          ((oddp temp)
518           (error "Odd number of args to SETF : ~s." args))
519          (t (do* ((a args (cddr a)) (l nil))
520                  ((null a) `(progn ,@(nreverse l)))
521               (push `(setf ,(car a) ,(cadr a)) l))))))
522
523
524(defun default-setf (setter value &optional env)
525  (let* ((reader (car setter))
526         (args (cdr setter))
527         (gensyms (mapcar #'(lambda (sym) (declare (ignore sym)) (gensym)) args))
528         types declares)
529    (flet ((form-type (form)
530             (nx-form-type form env)))
531      (declare (dynamic-extent #'form-type))
532      (setq types (mapcar #'form-type args)))
533    (dolist (sym gensyms)
534      (let ((sym-type (pop types)))
535        (unless (eq sym-type t)
536          (push `(type ,sym-type ,sym) declares))))
537    `(let ,(mapcar #'list gensyms args)
538       ,@(and declares (list `(declare ,@(nreverse declares))))
539       (funcall #'(setf ,reader) ,value ,@gensyms))))
540
541;; Establishing these setf-inverses is something that should
542;; happen at compile-time
543(defsetf elt set-elt)
544(defsetf car set-car)
545(defsetf first set-car)
546(defsetf cdr set-cdr)
547(defsetf rest set-cdr)
548(defsetf uvref uvset)
549(defsetf aref aset)
550(defsetf svref svset)
551(defsetf %svref %svset)
552(defsetf char set-char)
553(defsetf schar set-schar)
554(defsetf %scharcode %set-scharcode)
555(defsetf symbol-value set)
556(defsetf symbol-plist set-symbol-plist)
557(defsetf fill-pointer set-fill-pointer)
558
559; This sux; it calls the compiler twice (once to shove the macro in the
560; environment, once to dump it into the file.)
561(defmacro defmacro  (name arglist &body body &environment env)
562  (unless (symbolp name)(signal-program-error $XNotSym name))
563  (unless (listp arglist) (signal-program-error "~S is not a list." arglist))
564  (multiple-value-bind (lambda-form doc)
565                       (parse-macro-1 name arglist body env)
566    (let* ((normalized (normalize-lambda-list arglist t t))
567           (body-pos (position '&body normalized))
568           (argstring (let ((temp nil))
569                        (dolist (arg normalized)
570                          (if (eq arg '&aux)
571                            (return)
572                            (push arg temp)))
573                        (format nil "~:a" (nreverse temp)))))
574      (if (and body-pos (memq '&optional normalized)) (decf body-pos))
575      `(progn
576         (eval-when (:compile-toplevel)
577           (define-compile-time-macro ',name ',lambda-form ',env))
578         (eval-when (:load-toplevel :execute)
579           (%macro 
580            (nfunction ,name ,lambda-form)
581            '(,doc ,body-pos . ,argstring))
582           ',name)))))
583
584(defmacro define-symbol-macro (name expansion &environment env)
585  (unless (symbolp name)(signal-program-error $XNotSym name))
586  `(progn
587    (eval-when (:compile-toplevel)
588      (define-compile-time-symbol-macro ',name ',expansion ',env))
589    (eval-when (:load-toplevel :execute)
590      (%define-symbol-macro ',name ',expansion))))
591
592;; ---- allow inlining setf functions
593(defmacro defun (spec args &body body &environment env &aux global-name inline-spec)
594  (validate-function-name spec)
595  (setq args (require-type args 'list))
596  (setq body (require-type body 'list))
597  (multiple-value-bind (forms decls doc) (parse-body body env t)
598    (cond ((symbolp spec)
599           (setq global-name spec)
600           (setq inline-spec spec)
601           (setq body `(block ,spec ,@forms)))
602          ((and (consp spec) (eq 'setf (%car spec)))
603           (setq inline-spec spec)
604           (setq body `(block ,(cadr spec) ,@forms)))
605          (t (setq body `(progn ,@forms))))
606    (let* ((lambda-expression `(lambda ,args 
607                                ,@(if global-name
608                                    `((declare (global-function-name ,global-name))))
609                                ,@decls ,body))
610           (info (if (and inline-spec
611                          (or (null env)
612                              (definition-environment env t))
613                          (nx-declared-inline-p inline-spec env)
614                          (not (and (symbolp inline-spec)
615                                    (gethash inline-spec *NX1-ALPHATIZERS*))))
616                   (cons doc lambda-expression)
617                   doc)))
618      `(progn
619         (eval-when (:compile-toplevel)
620           (note-function-info ',spec ',lambda-expression ,env))
621         (%defun (nfunction ,spec ,lambda-expression) ',info)
622         ',spec))))
623
624(defmacro %defvar-init (var initform doc)
625  `(unless (%defvar ',var ,doc)
626     (setq ,var ,initform)))
627
628(defmacro defvar (&environment env var &optional (value () value-p) doc)
629  (if (and doc (not (stringp doc))) (report-bad-arg doc 'string))
630  (if (and (compile-file-environment-p env) (not *fasl-save-doc-strings*))
631    (setq doc nil))
632 `(progn
633    (eval-when (:compile-toplevel)
634      (note-variable-info ',var ,value-p ,env))
635    ,(if value-p
636       `(%defvar-init ,var ,value ,doc)
637       `(%defvar ',var))
638    ',var))
639         
640(defmacro def-standard-initial-binding (name &optional (form name) &environment env)
641  `(progn
642    (eval-when (:compile-toplevel)
643      (note-variable-info ',name t ,env))   
644    (define-standard-initial-binding ',name #'(lambda () ,form))
645    ',name))
646
647(defmacro defparameter (&environment env var value &optional doc)
648  (if (and doc (not (stringp doc))) (signal-program-error "~S is not a string." doc))
649  (if (and (compile-file-environment-p env) (not *fasl-save-doc-strings*))
650    (setq doc nil))
651  `(progn
652     (eval-when (:compile-toplevel)
653       (note-variable-info ',var t ,env))
654     (%defparameter ',var ,value ,doc)))
655
656(defmacro defglobal (&environment env var value &optional doc)
657  (if (and doc (not (stringp doc))) (signal-program-error "~S is not a string." doc))
658  (if (and (compile-file-environment-p env) (not *fasl-save-doc-strings*))
659    (setq doc nil))
660  `(progn
661     (eval-when (:compile-toplevel)
662       (note-variable-info ',var :global ,env))
663     (%defglobal ',var ,value ,doc)))
664
665
666(defmacro defloadvar (&environment env var value &optional doc)
667  `(progn
668     (defvar ,var ,@(if doc `(nil ,doc)))
669     (def-ccl-pointers ,var ()
670       (setq ,var ,value))
671     ',var))
672
673
674(defmacro qlfun (name args &body body)
675  `(nfunction ,name (lambda ,args ,@body)))
676
677(defmacro lfun-bits-known-function (f)
678  (let* ((temp (gensym)))
679    `(let* ((,temp ,f))
680      (%svref ,temp (the fixnum (1- (the fixnum (uvsize ,temp))))))))
681
682; %Pascal-Functions% Entry
683; Used by "l1;ppc-callback-support" & "lib;dumplisp"
684(def-accessor-macros %svref
685  pfe.routine-descriptor
686  pfe.proc-info
687  pfe.lisp-function
688  pfe.sym
689  pfe.without-interrupts)
690
691(defmacro cond (&rest args &aux clause)
692  (when args
693     (setq clause (car args))
694     (if (cdr clause)         
695         `(if ,(car clause) (progn ,@(cdr clause)) (cond ,@(cdr args)))
696       (if (cdr args) `(or ,(car clause) (cond ,@(cdr args)))
697                      `(values ,(car clause))))))
698
699(defmacro and (&rest args)
700  (if (null args) t
701    (if (null (cdr args)) (car args)
702      `(if ,(car args) (and ,@(cdr args))))))
703
704(defmacro or (&rest args)
705  (if args
706    (if (cdr args)
707      (do* ((temp (gensym))
708            (handle (list nil))
709            (forms `(let ((,temp ,(pop args)))
710                      (if ,temp ,temp ,@handle))))
711           ((null (cdr args))
712            (%rplaca handle (%car args))
713            forms)
714        (%rplaca handle `(if (setq ,temp ,(%car args)) 
715                           ,temp 
716                           ,@(setq handle (list nil))))
717        (setq args (%cdr args)))
718      (%car args))))
719
720(defmacro case (key &body forms) 
721   (let ((key-var (gensym)))
722     `(let ((,key-var ,key))
723        (declare (ignorable ,key-var))
724        (cond ,@(case-aux forms key-var nil nil)))))
725
726(defmacro ccase (keyplace &body forms)
727  (let* ((key-var (gensym))
728         (tag (gensym)))
729    `(prog (,key-var)
730       ,tag
731       (setq ,key-var ,keyplace)
732       (return (cond ,@(case-aux forms key-var tag keyplace))))))
733
734(defmacro ecase (key &body forms)
735  (let* ((key-var (gensym)))
736    `(let ((,key-var ,key))
737       (declare (ignorable ,key-var))
738       (cond ,@(case-aux forms key-var 'ecase nil)))))
739       
740(defun case-aux (clauses key-var e-c-p placename &optional (used-keys (list (list '%case-core))))
741  (if clauses
742    (let* ((key-list (caar clauses))
743           (stype (if e-c-p (if (eq e-c-p 'ecase) e-c-p 'ccase) 'case))
744           (test (cond ((and (not e-c-p)
745                             (or (eq key-list 't)
746                                 (eq key-list 'otherwise)))
747                        t)
748                       (key-list
749                        (cons 'or
750                              (case-key-testers key-var used-keys key-list stype)))))
751           (consequent-list (or (%cdar clauses) '(nil))))
752      (if (eq test t)
753        (progn
754          (when (%cdr clauses) (warn "~s or ~s clause in the middle of a ~s statement.  Subsequent clauses ignored."
755                                     't 'otherwise 'case))
756          (cons (cons t consequent-list) nil))
757        (cons (cons test consequent-list)
758              (case-aux (%cdr clauses) key-var e-c-p placename used-keys))))
759    (when e-c-p
760      (setq used-keys `(member ,@(mapcar #'car (cdr used-keys))))
761      (if (eq e-c-p 'ecase)
762        `((t (values (%err-disp #.$XWRONGTYPE ,key-var ',used-keys))))
763        `((t (setf ,placename (ensure-value-of-type ,key-var ',used-keys ',placename))
764           (go ,e-c-p)))))))
765
766
767;;; We don't want to descend list structure more than once (like this has
768;;; been doing for the last 18 years or so.)
769(defun case-key-testers (symbol used-keys atom-or-list statement-type &optional recursive)
770  (if (or recursive (atom atom-or-list))
771    (progn
772      (if (assoc atom-or-list used-keys)
773        (warn "Duplicate keyform ~s in ~s statement." atom-or-list statement-type)
774        (nconc used-keys (list (cons atom-or-list t))))
775      `((,(if (typep atom-or-list '(and number (not fixnum)))
776              'eql
777              'eq)
778         ,symbol ',atom-or-list)))
779    (nconc (case-key-testers symbol used-keys (car atom-or-list) statement-type t)
780           (when (cdr atom-or-list)
781             (case-key-testers symbol used-keys (%cdr atom-or-list) statement-type nil)))))
782
783
784; generate the COND body of a {C,E}TYPECASE form
785(defun typecase-aux (key-var clauses &optional e-c-p keyform)
786  (let* ((construct (if e-c-p (if (eq e-c-p 'etypecase) e-c-p 'ctypecase) 'typecase))
787         (types ())
788         (t-clause ())
789         (body ()))
790    (flet ((bad-clause (c) 
791             (error "Invalid clause ~S in ~S form." c construct)))
792      (dolist (clause clauses)
793        (if (atom clause)
794          (bad-clause clause)
795          (destructuring-bind (typespec &body consequents) clause
796            (when (eq construct 'typecase)
797              (if (eq typespec 'otherwise)
798                (setq typespec t))
799              (if (eq typespec t)
800                (if t-clause
801                  (bad-clause clause)   ; seen one already
802                  (setq t-clause `( t nil ,@consequents)))))
803            (unless (and (eq construct 'typecase)
804                         (eq typespec t))
805              (when
806                  (dolist (already types t)
807                    (when (subtypep typespec already)
808                      (warn "Clause ~S ignored in ~S form - shadowed by ~S ." clause construct (assq already clauses))
809                      (return)))
810                (push typespec types)
811                (unless (eq typespec t)
812                  (setq typespec `(typep ,key-var ',typespec)))
813                (push `(,typespec nil ,@consequents) body))))))
814      (when e-c-p
815        (setq types `(or ,@(nreverse types)))
816        (if (eq construct 'etypecase)
817          (push `(t (values (%err-disp #.$XWRONGTYPE ,key-var ',types))) body)
818          (push `(t (setf ,keyform (ensure-value-of-type ,key-var ',types ',keyform))
819                  (go ,e-c-p)) body))))
820    (when t-clause
821      (push t-clause body))
822    `(cond ,@(nreverse body))))
823
824(defmacro typecase (keyform &body clauses)
825  (let ((key-var (gensym)))
826    `(let ((,key-var ,keyform))
827       (declare (ignorable ,key-var))
828       ,(typecase-aux key-var clauses))))
829
830(defmacro etypecase (keyform &body clauses)
831  (let ((key-var (gensym)))
832    `(let ((,key-var ,keyform))
833       (declare (ignorable ,key-var))
834       ,(typecase-aux key-var clauses 'etypecase))))
835
836(defmacro ctypecase (keyform &body clauses)
837  (let ((key-var (gensym))
838        (tag (gensym)))
839    `(prog (,key-var)
840       ,tag
841       (setq ,key-var ,keyform)
842       (return ,(typecase-aux key-var clauses tag keyform)))))
843
844(defmacro destructuring-bind (lambda-list expression &body body)
845  (multiple-value-bind (bindings decls)
846      (%destructure-lambda-list  lambda-list expression nil nil)
847    `(let* ,(nreverse bindings)
848      ,@(when decls `((declare ,@decls)))
849      ,@body)))
850
851(defmacro make-destructure-state (tail whole lambda)
852  `(gvector :istruct 'destructure-state ,tail ,whole ,lambda))
853
854
855; This is supposedly ANSI CL.
856(defmacro lambda (&whole lambda-expression (&rest paramlist) &body body)
857  (unless (lambda-expression-p lambda-expression)
858    (warn "Invalid lambda expression: ~s" lambda-expression))
859  `(function (lambda ,paramlist ,@body)))
860
861
862(defmacro when (test &body body)
863 `(if ,test
864   (progn ,@body)))
865
866(defmacro unless (test &body body)
867 `(if (not ,test)
868   (progn ,@body)))
869
870(defmacro return (&optional (form nil form-p))
871  `(return-from nil ,@(if form-p `(,form))))
872
873; since they use tagbody, while & until BOTH return NIL
874(defmacro while (test &body body)
875  (let ((testlab (gensym))
876        (toplab (gensym)))
877    `(tagbody
878       (go ,testlab)
879      ,toplab
880      (progn ,@body)
881      ,testlab
882      (when ,test (go ,toplab)))))
883
884(defmacro until (test &body body)
885  (let ((testlab (gensym))
886        (toplab (gensym)))
887    `(tagbody
888       (go ,testlab)
889      ,toplab
890      (progn ,@body)
891      ,testlab
892      (if (not ,test)
893        (go ,toplab)))))
894
895(defmacro psetq (&whole call &body pairs &environment env)
896  (when pairs
897   (if (evenp (length pairs))
898     (do* ((l pairs (%cddr l))
899           (sym (%car l) (%car l)))
900          ((null l) (%pset pairs))
901       (unless (symbolp sym) (report-bad-arg sym 'symbol))
902       (when (nth-value 1 (macroexpand-1 sym env))
903         (return `(psetf ,@pairs))))
904     (error "Uneven number of args in the call ~S" call))))
905
906; generates body for psetq.
907; "pairs" is a proper list whose length is not odd.
908(defun %pset (pairs)
909 (when pairs
910   (let (vars vals gensyms let-list var val sets)
911      (loop
912        (setq var (pop pairs)
913              val (pop pairs))
914        (if (null pairs) (return))
915        (push var vars)
916        (push val vals)
917        (push (gensym) gensyms))
918      (dolist (g gensyms)
919        (push g sets)
920        (push (pop vars) sets)
921        (push (list g (pop vals)) let-list))
922      (push val sets)
923      (push var sets)
924      `(progn
925         (let ,let-list
926           (setq ,@sets))
927         nil))))
928
929
930(eval-when (:compile-toplevel :load-toplevel :execute)
931(defun do-loop (binder setter env var-init-steps end-test result body)
932  (let ((toptag (gensym))
933        (testtag (gensym)))
934    (multiple-value-bind (forms decls) (parse-body body env nil)
935      `(block nil
936         (,binder ,(do-let-vars var-init-steps)
937                  ,@decls
938                  (tagbody ; crocks-r-us.
939                    (go ,testtag)
940                    ,toptag
941                    (tagbody
942                      ,@forms)
943                    (,setter ,@(do-step-vars var-init-steps))
944                    ,testtag
945                    (unless ,end-test
946                      (go ,toptag)))
947                  ,@result)))))
948)
949
950(defmacro do (&environment env var-init-steps (&optional end-test &rest result) &body body)
951  (do-loop 'let 'psetq env var-init-steps end-test result body))
952
953(defmacro do* (&environment env var-init-steps (&optional end-test &rest result) &body body)
954  (do-loop 'let* 'setq env var-init-steps end-test result body))
955
956
957(defun do-let-vars (var-init-steps)
958  (if var-init-steps
959      (cons (list (do-let-vars-var (car var-init-steps))
960                  (do-let-vars-init (car var-init-steps)))
961             (do-let-vars (cdr var-init-steps)))))
962
963(defun do-let-vars-var (var-init-step)
964  (if (consp var-init-step)
965       (car var-init-step)
966       var-init-step))
967
968(defun do-let-vars-init (var-init-step)
969   (if (consp var-init-step)
970        (cadr var-init-step)
971        nil))
972
973(defun do-step-vars (var-init-steps)
974    (if var-init-steps
975        (if (do-step-vars-step? (car var-init-steps))
976             (append (list (do-let-vars-var (car var-init-steps))
977                           (do-step-vars-step (car var-init-steps)))
978                     (do-step-vars (cdr var-init-steps)))
979             (do-step-vars (cdr var-init-steps)))))
980
981(defun do-step-vars-step? (var-init-step)
982  (if (consp var-init-step)
983       (cddr var-init-step)))
984
985(defun do-step-vars-step (var-init-step)
986  (if (consp var-init-step)
987       (caddr var-init-step)))
988
989
990(defmacro dotimes ((i n &optional result) &body body &environment env)
991  (multiple-value-bind (forms decls)
992                       (parse-body body env)
993    (if (not (symbolp i))(signal-program-error $Xnotsym i))
994    (let* ((toptag (gensym))
995           (limit (gensym)))
996      `(block nil
997        (let ((,limit ,n) (,i 0))
998         ,@decls
999         (declare (unsettable ,i))
1000           (if (int>0-p ,limit)
1001             (tagbody
1002               ,toptag
1003               ,@forms
1004               (locally
1005                (declare (settable ,i))
1006                (setq ,i (1+ ,i)))
1007               (unless (eql ,i ,limit) (go ,toptag))))
1008           ,result)))))
1009 
1010(defun do-syms-result (var resultform)
1011  (unless (eq var resultform)
1012    (if (and (consp resultform) (not (quoted-form-p resultform)))
1013      `(progn (setq ,var nil) ,resultform)
1014      resultform)))
1015
1016(defun expand-package-iteration-macro (iteration-function var pkg-spec resultform body env)
1017  (multiple-value-bind (body decls) (parse-body body env nil)
1018    (let* ((ftemp (gensym))
1019           (vtemp (gensym))
1020           (result (do-syms-result var resultform)))
1021      `(block nil
1022        (let* ((,var nil))
1023          ,@decls
1024           (flet ((,ftemp (,vtemp) (declare (debugging-function-name nil)) (setq ,var ,vtemp) (tagbody ,@body)))
1025             (declare (dynamic-extent #',ftemp))
1026             (,iteration-function ,pkg-spec #',ftemp))
1027           ,@(when result `(,result)))))))
1028
1029(defmacro do-symbols ((var &optional pkg result) &body body &environment env)
1030  (expand-package-iteration-macro 'iterate-over-accessable-symbols var pkg result body env))
1031
1032(defmacro do-present-symbols ((var &optional pkg result) &body body &environment env)
1033  (expand-package-iteration-macro 'iterate-over-present-symbols var pkg result body env))
1034
1035(defmacro do-external-symbols ((var &optional pkg result) &body body &environment env)
1036  (expand-package-iteration-macro 'iterate-over-external-symbols var pkg result body env))
1037
1038(defmacro do-all-symbols ((var &optional resultform) 
1039                          &body body &environment env)
1040  (multiple-value-bind (body decls) (parse-body body env nil)
1041    (let* ((ftemp (gensym))
1042           (vtemp (gensym))
1043           (result (do-syms-result var resultform)))
1044      `(block nil
1045        (let* ((,var nil))
1046         ,@decls
1047           (flet ((,ftemp (,vtemp) (declare (debugging-function-name nil)) (setq ,var ,vtemp) (tagbody ,@body)))
1048             (declare (dynamic-extent #',ftemp))
1049             (iterate-over-all-symbols #',ftemp))
1050           ,@(when result `(,result)))))))
1051
1052(defmacro multiple-value-list (form)
1053  `(multiple-value-call #'list ,form))
1054
1055(defmacro multiple-value-bind (varlist values-form &body body &environment env)
1056  (multiple-value-bind (body decls)
1057                       (parse-body body env)
1058    (let ((ignore (make-symbol "IGNORE")))
1059      `(multiple-value-call #'(lambda (&optional ,@varlist &rest ,ignore)
1060                                (declare (ignore ,ignore))
1061                                ,@decls
1062                                ,@body)
1063                            ,values-form))))
1064
1065(defmacro multiple-value-setq (vars val)
1066  (if vars
1067    `(values (setf (values ,@(mapcar #'(lambda (s) (require-type s 'symbol)) vars))  ,val))
1068    `(prog1 ,val)))
1069
1070(defmacro nth-value (n form)
1071  `(car (nthcdr ,n (multiple-value-list ,form))))
1072
1073
1074(defmacro %i> (x y)
1075  `(> (the fixnum ,x) (the fixnum ,y)))
1076
1077(defmacro %i< (x y)
1078  `(< (the fixnum ,x) (the fixnum ,y)))
1079
1080(defmacro %i<= (x y)
1081 `(not (%i> ,x ,y)))
1082
1083(defmacro %i>= (x y)
1084 `(not (%i< ,x ,y)))
1085
1086(defmacro bitset (bit number)
1087  `(logior (ash 1 ,bit) ,number))
1088
1089(defmacro bitclr (bit number)
1090  `(logand (lognot (ash 1 ,bit)) ,number))
1091
1092(defmacro bitopf ((op bit place) &environment env)
1093  (multiple-value-bind (vars vals stores store-form access-form)
1094                       (get-setf-method place env)
1095    (let* ((constant-bit-p (constantp bit))
1096           (bitvar (if constant-bit-p bit (gensym))))
1097      `(let ,(unless constant-bit-p `((,bitvar ,bit)))          ; compiler isn't smart enough
1098         (let* ,(mapcar #'list `(,@vars ,@stores) `(,@vals (,op ,bitvar ,access-form)))
1099           ,store-form)))))
1100
1101(defmacro bitsetf (bit place)
1102  `(bitopf (bitset ,bit ,place)))
1103
1104(defmacro bitclrf (bit place)
1105  `(bitopf (bitclr ,bit ,place)))
1106
1107(defmacro %svref (v i)
1108  (let* ((vtemp (make-symbol "VECTOR"))
1109           (itemp (make-symbol "INDEX")))
1110      `(let* ((,vtemp ,v)
1111              (,itemp ,i))
1112         (locally (declare (optimize (speed 3) (safety 0)))
1113           (svref ,vtemp ,itemp)))))
1114
1115(defmacro %svset (v i new)
1116  (let* ((vtemp (make-symbol "VECTOR"))
1117           (itemp (make-symbol "INDEX")))
1118      `(let* ((,vtemp ,v)
1119              (,itemp ,i))
1120         (locally (declare (optimize (speed 3) (safety 0)))
1121           (setf (svref ,vtemp ,itemp) ,new)))))
1122
1123
1124(defmacro %schar (v i)
1125  (let* ((vtemp (make-symbol "STRING"))
1126         (itemp (make-symbol "INDEX")))
1127    `(let* ((,vtemp ,v)
1128            (,itemp ,i))
1129       (locally (declare (optimize (speed 3) (safety 0)))
1130         (schar ,vtemp ,itemp)))))
1131
1132(defmacro %set-schar (v i new)
1133  (let* ((vtemp (make-symbol "STRING"))
1134           (itemp (make-symbol "INDEX")))
1135      `(let* ((,vtemp ,v)
1136              (,itemp ,i))
1137         (locally (declare (optimize (speed 3) (safety 0)))
1138           (setf (schar ,vtemp ,itemp) ,new)))))
1139
1140
1141
1142(defmacro %char-code (c) `(char-code (the character ,c)))
1143(defmacro %code-char (i) `(code-char (the (unsigned-byte 16) ,i)))
1144
1145(defmacro %izerop (x) `(eq ,x 0))
1146(defmacro %iminusp (x) `(< (the fixnum ,x) 0))
1147(defmacro %i+ (&rest (&optional (n0 0) &rest others))
1148  (if others
1149    `(the fixnum (+ (the fixnum ,n0) (%i+ ,@others)))
1150    `(the fixnum ,n0)))
1151(defmacro %i- (x y &rest others) 
1152  (if (not others)
1153    `(the fixnum (- (the fixnum ,x) (the fixnum ,y)))
1154    `(the fixnum (- (the fixnum ,x) (the fixnum (%i+ ,y ,@others))))))
1155
1156
1157(defmacro %i* (x y) `(the fixnum (* (the fixnum ,x) (the fixnum ,y))))
1158
1159(defmacro %ilogbitp (b i)
1160  `(logbitp (the (integer 0 29) ,b) (the fixnum ,i)))
1161
1162;;; Seq-Dispatch does an efficient type-dispatch on the given Sequence.
1163
1164(defmacro seq-dispatch (sequence list-form array-form)
1165  `(if (sequence-type ,sequence)
1166       ,list-form
1167       ,array-form))
1168
1169
1170(defsetf %get-byte %set-byte)
1171(defsetf %get-unsigned-byte %set-byte)
1172(defsetf %get-signed-byte %set-byte)
1173(defsetf %get-word %set-word)
1174(defsetf %get-signed-word %set-word)
1175(defsetf %get-unsigned-word %set-word)
1176(defsetf %get-long %set-long)
1177(defsetf %get-signed-long %set-long)
1178(defsetf %get-unsigned-long %set-long)
1179(defsetf %get-full-long %set-long)
1180(defsetf %get-point %set-long)
1181(defsetf %get-string %set-string)
1182(defsetf %get-ptr %set-ptr)
1183(defsetf %get-double-float %set-double-float)
1184(defsetf %get-single-float %set-single-float)
1185(defsetf %get-bit %set-bit)
1186(defsetf %get-unsigned-long-long %set-unsigned-long-long)
1187(defsetf %%get-unsigned-longlong %%set-unsigned-longlong)
1188(defsetf %get-signed-long-long %set-signed-long-long)
1189(defsetf %%get-signed-longlong %%set-signed-longlong)
1190(defsetf %get-bitfield %set-bitfield)
1191
1192(defmacro %ilognot (int) `(%i- -1 ,int))
1193
1194(defmacro %ilogior2 (x y) 
1195  `(logior (the fixnum ,x) (the fixnum ,y)))
1196
1197(defmacro %ilogior (body &body args)
1198   (while args
1199     (setq body (list '%ilogior2 body (pop args))))
1200   body)
1201
1202(defmacro %ilogand2 (x y)
1203  `(logand (the fixnum ,x) (the fixnum ,y)))
1204
1205(defmacro %ilogand (body &body args)
1206   (while args
1207     (setq body (list '%ilogand2 body (pop args))))
1208   body)
1209
1210(defmacro %ilogxor2 (x y)
1211  `(logxor (the fixnum ,x) (the fixnum ,y)))
1212
1213(defmacro %ilogxor (body &body args)
1214   (while args
1215     (setq body (list '%ilogxor2 body (pop args))))
1216   body)
1217
1218(defmacro with-macptrs (varlist &rest body &aux decls inits)
1219  (dolist (var varlist)
1220    (if (consp var)
1221      (progn
1222        (push (car var) decls)
1223        (push (list (%car var)
1224                    (if (%cdr var)
1225                      `(%setf-macptr (%null-ptr) ,@(%cdr var))
1226                      '(%null-ptr))) inits))
1227      (progn
1228        (push var decls)
1229        (push (list var '(%null-ptr)) inits))))
1230  `(let* ,(nreverse inits)
1231     (declare (dynamic-extent ,@decls))
1232     (declare (type macptr ,@decls))
1233     ,@body))
1234
1235(defmacro with-loading-file (filename &rest body)
1236   `(let ((*loading-files* (cons ,filename (locally (declare (special *loading-files*))
1237                                                    *loading-files*))))
1238      (declare (special *loading-files*))
1239      ,@body))
1240
1241(defmacro with-input-from-string ((var string &key index start end) &body forms &environment env)
1242  (multiple-value-bind (forms decls) (parse-body forms env nil)
1243    `(let ((,var
1244            ,(cond ((null end)
1245                    `(make-string-input-stream ,string ,(or start 0)))
1246                   ((symbolp end)
1247                    `(if ,end
1248                      (make-string-input-stream ,string ,(or start 0) ,end)
1249                      (make-string-input-stream ,string ,(or start 0))))
1250                   (t
1251                    `(make-string-input-stream ,string ,(or start 0) ,end)))))
1252      ,@decls
1253      (unwind-protect
1254           (progn ,@forms)
1255        (close ,var)
1256        ,@(if index `((setf ,index (string-input-stream-index ,var))))))))
1257
1258(defmacro with-output-to-string ((var &optional string &key (element-type 'base-char element-type-p))
1259                                 &body body 
1260                                 &environment env)
1261  (multiple-value-bind (forms decls) (parse-body body env nil)
1262    `(let ((,var ,(if string
1263                    `(%make-string-output-stream ,string)
1264                    `(make-string-output-stream :element-type ,(if element-type-p element-type `'base-char)))))
1265       ,@decls
1266       (unwind-protect
1267         (progn
1268           ,@forms
1269           ,@(if string () `((get-output-stream-string ,var))))
1270         (close ,var)))))
1271
1272(defmacro with-output-to-truncating-string-stream ((var len) &body body
1273                                                   &environment env)
1274  (multiple-value-bind (forms decls) (parse-body body env nil)
1275    `(let* ((,var (make-truncating-string-stream ,len)))
1276      ,@decls
1277      (unwind-protect
1278           (progn
1279             ,@forms
1280             (values (get-output-stream-string ,var)
1281                     (slot-value ,var 'truncated)))
1282        (close ,var)))))
1283
1284(defmacro with-open-file ((var . args) &body body &aux (stream (gensym))(done (gensym)))
1285  `(let (,stream ,done)
1286     (unwind-protect
1287       (multiple-value-prog1
1288         (let ((,var (setq ,stream (open ,@args))))
1289           ,@body)
1290         (setq ,done t))
1291       (when ,stream (close ,stream :abort (null ,done))))))
1292
1293(defmacro with-compilation-unit ((&key override) &body body)
1294  `(let* ((*outstanding-deferred-warnings* (%defer-warnings ,override)))
1295     (multiple-value-prog1 (progn ,@body) (report-deferred-warnings))))
1296
1297; Yow! Another Done Fun.
1298(defmacro with-standard-io-syntax (&body body &environment env)
1299  (multiple-value-bind (decls body) (parse-body body env)
1300    `(let ((*package* (find-package "CL-USER"))
1301           (*print-array* t)
1302           (*print-base* 10.)
1303           (*print-case* :upcase)
1304           (*print-circle* nil)
1305           (*print-escape* t)
1306           (*print-gensym* t)
1307           (*print-length* nil)
1308           (*print-level* nil)
1309           (*print-lines* nil) ; This doesn't exist as of 5/15/90 - does now
1310           (*print-miser-width* nil)
1311           (*print-pprint-dispatch* nil)
1312           (*print-pretty* nil)
1313           (*print-radix* nil)
1314           (*print-readably* t)
1315           (*print-right-margin* nil)
1316           (*read-base* 10.)
1317           (*read-default-float-format* 'single-float)
1318           (*read-eval* t) ; Also MIA as of 5/15/90
1319           (*read-suppress* nil)
1320           (*readtable* %initial-readtable%))
1321       ,@decls
1322       ,@body)))
1323           
1324(defmacro print-unreadable-object (&environment env (object stream &key type identity) &body forms)
1325  (multiple-value-bind (body decls) (parse-body forms env)
1326    (if body
1327      (let ((thunk (gensym)))
1328        `(let ((,thunk #'(lambda () ,@decls ,@body)))
1329           (declare (dynamic-extent ,thunk))
1330          (%print-unreadable-object ,object ,stream ,type ,identity ,thunk)))
1331      `(%print-unreadable-object ,object ,stream ,type ,identity nil))))
1332;; Pointers and Handles
1333
1334;;Add function to lisp system pointer functions, and run it if it's not already
1335;; there.
1336(defmacro def-ccl-pointers (name arglist &body body &aux (old (gensym)))
1337  `(flet ((,name ,arglist ,@body))
1338     (let ((,old (member ',name *lisp-system-pointer-functions* :key #'function-name)))
1339       (if ,old
1340         (rplaca ,old #',name)
1341         (progn
1342           (push #',name *lisp-system-pointer-functions*)
1343           (,name))))))
1344
1345(defmacro def-load-pointers (name arglist &body body &aux (old (gensym)))
1346  `(flet ((,name ,arglist ,@body))
1347     (let ((,old (member ',name *lisp-user-pointer-functions* :key #'function-name)))
1348       (if ,old
1349         (rplaca ,old #',name)
1350         (progn
1351           (push #',name *lisp-user-pointer-functions*)
1352           (,name))))))
1353
1354;Queue up some code to run after ccl all loaded up, or, if ccl is already
1355;loaded up, just run it right now.
1356(defmacro queue-fixup (&rest body &aux (fn (gensym)))
1357  `(let ((,fn #'(lambda () ,@body)))
1358     (if (eq %lisp-system-fixups% T)
1359       (funcall ,fn)
1360       (push (cons ,fn *loading-file-source-file*) %lisp-system-fixups%))))
1361
1362(defmacro %incf-ptr (p &optional (by 1))
1363  (if (symbolp p)  ;once-only
1364    `(%setf-macptr (the macptr ,p) (%inc-ptr ,p ,by))
1365    (let ((var (gensym)))
1366      `(let ((,var ,p)) (%setf-macptr (the macptr ,var) (%inc-ptr ,var ,by))))))
1367
1368(defmacro with-string-from-cstring ((s ptr) &body body)
1369  (let* ((len (gensym))
1370         (p (gensym)))
1371    `(let* ((,p ,ptr)
1372            (,len (%cstrlen ,p))
1373            (,s (make-string ,len)))
1374      (declare (fixnum ,len))
1375      (%copy-ptr-to-ivector ,p 0 ,s 0 ,len)
1376      (locally
1377          ,@body))))
1378
1379
1380(defmacro with-cstr ((sym str &optional start end) &rest body &environment env)
1381  (multiple-value-bind (body decls) (parse-body body env nil)
1382    (if (and (base-string-p str) (null start) (null end))
1383      (let ((strlen (%i+ (length str) 1)))
1384        `(%stack-block ((,sym ,strlen))
1385           ,@decls
1386           (%cstr-pointer ,str ,sym)
1387           ,@body))
1388      (let ((strname (gensym))
1389            (start-name (gensym))
1390            (end-name (gensym)))
1391        `(let ((,strname ,str)
1392               ,@(if (or start end)
1393                   `((,start-name ,(or start 0))
1394                     (,end-name ,(or end `(length ,strname))))))
1395           (%vstack-block (,sym
1396                           (the fixnum
1397                             (1+
1398                              (the fixnum
1399                                ,(if (or start end)
1400                                     `(byte-length
1401                                       ,strname ,start-name ,end-name)
1402                                     `(length ,strname))))))
1403             ,@decls
1404             ,(if (or start end)
1405                `(%cstr-segment-pointer ,strname ,sym ,start-name ,end-name)
1406                `(%cstr-pointer ,strname ,sym))
1407             ,@body))))))
1408
1409
1410
1411
1412
1413(defmacro with-pointers (speclist &body body)
1414   (with-specs-aux 'with-pointer speclist body))
1415
1416
1417
1418(defmacro with-cstrs (speclist &body body)
1419   (with-specs-aux 'with-cstr speclist body))
1420
1421
1422
1423
1424
1425(defun with-specs-aux (name spec-list body)
1426  (setq body (cons 'progn body))
1427  (dolist (spec (reverse spec-list))
1428     (setq body (list name spec body)))
1429  body)
1430
1431
1432(defmacro type-predicate (type)
1433  `(get-type-predicate ,type))
1434
1435(defsetf type-predicate set-type-predicate)
1436
1437(defmacro defmethod (name &rest args &environment env)
1438  (multiple-value-bind (function-form specializers-form qualifiers lambda-list documentation specializers)
1439                       (parse-defmethod name args env)
1440   
1441    `(progn
1442       (eval-when (:compile-toplevel)
1443         (note-function-info ',name nil ,env))
1444       (compiler-let ((*nx-method-warning-name* 
1445                       (list ',name
1446                             ,@(mapcar #'(lambda (x) `',x) qualifiers)
1447                             ',specializers)))
1448         (ensure-method ',name ,specializers-form
1449                        :function ,function-form
1450                        :qualifiers ',qualifiers
1451                        :lambda-list ',lambda-list
1452                        ,@(if documentation `(:documentation ,documentation)))))))
1453
1454
1455(defun seperate-defmethod-decls (decls)
1456  (let (outer inner)
1457    (dolist (decl decls)
1458      (if (neq (car decl) 'declare)
1459        (push decl outer)
1460        (let (outer-list inner-list)
1461          (dolist (d (cdr decl))
1462            (if (and (listp d) (eq (car d) 'dynamic-extent))
1463              (let (in out)
1464                (dolist (fspec (cdr d))
1465                  (if (and (listp fspec)
1466                           (eq (car fspec) 'function)
1467                           (listp (cdr fspec))
1468                           (null (cddr fspec))
1469                           (memq (cadr fspec) '(call-next-method next-method-p)))
1470                    (push fspec in)
1471                    (push fspec out)))
1472                (when out
1473                  (push `(dynamic-extent ,@(nreverse out)) outer-list))
1474                (when in
1475                  (push `(dynamic-extent ,@(nreverse in)) inner-list)))
1476              (push d outer-list)))
1477          (when outer-list
1478            (push `(declare ,@(nreverse outer-list)) outer))
1479          (when inner-list
1480            (push `(declare ,@(nreverse inner-list)) inner)))))
1481    (values (nreverse outer) (nreverse inner))))
1482                   
1483
1484(defun parse-defmethod (name args env)
1485  (validate-function-name name)
1486  (let (qualifiers lambda-list parameters specializers specializers-form refs types temp)
1487    (until (listp (car args))
1488      (push (pop args) qualifiers))
1489    (setq lambda-list (pop args))
1490    (while (and lambda-list (not (memq (car lambda-list) lambda-list-keywords)))
1491      (let ((p (pop lambda-list)))
1492        (cond ((consp p)
1493               (unless (and (consp (%cdr p)) (null (%cddr p)))
1494                 (signal-program-error "Illegal arg ~S" p))
1495               (push (%car p) parameters)
1496               (push (%car p) refs)
1497               (setq p (%cadr p))
1498               (cond ((and (consp p) (eq (%car p) 'eql)
1499                           (consp (%cdr p)) (null (%cddr p)))
1500                      (push `(list 'eql ,(%cadr p)) specializers-form)
1501                      (push p specializers))
1502                     ((or (setq temp (non-nil-symbol-p p))
1503                          (specializer-p p))
1504                      (push `',p specializers-form)
1505                      (push p specializers)
1506                      (unless (or (eq p t) (not temp))
1507                        ;Should be `(guaranteed-type ...).
1508                        (push `(type ,p ,(%car parameters)) types)))
1509                     (t (signal-program-error "Illegal arg ~S" p))))
1510              (t
1511               (push p parameters)
1512               (push t specializers-form)
1513               (push t specializers)))))
1514    (setq lambda-list (nreconc parameters lambda-list))
1515    (multiple-value-bind (body decls doc) (parse-body args env t)
1516      (multiple-value-bind (outer-decls inner-decls) 
1517                           (seperate-defmethod-decls decls)
1518        (let* ((methvar (make-symbol "NEXT-METHOD-CONTEXT"))
1519               (cnm-args (gensym))
1520               (lambda-form `(lambda ,(list* '&method methvar lambda-list)
1521                               (declare ;,@types
1522                                (ignorable ,@refs))
1523                               ,@outer-decls
1524                               (block ,(if (consp name) (cadr name) name)
1525                                 (flet ((call-next-method (&rest ,cnm-args)
1526                                          (declare (dynamic-extent ,cnm-args))
1527                                          (if ,cnm-args
1528                                            (apply #'%call-next-method-with-args ,methvar ,cnm-args)
1529                                            (%call-next-method ,methvar)))
1530                                        (next-method-p () (%next-method-p ,methvar)))
1531                                   (declare (inline call-next-method next-method-p))
1532                                   ,@inner-decls
1533                                   ,@body)))))
1534          (values
1535           (if name `(nfunction ,name ,lambda-form) `(function ,lambda-form))
1536           `(list ,@(nreverse specializers-form))
1537           (nreverse qualifiers)
1538           lambda-list
1539           doc
1540           (nreverse specializers)))))))
1541
1542(defmacro anonymous-method (name &rest args &environment env)
1543  (multiple-value-bind (function-form specializers-form qualifiers method-class documentation)
1544                       (parse-defmethod name args env)
1545   
1546    `(%anonymous-method
1547      ,function-form
1548      ,specializers-form
1549      ',qualifiers
1550      ,@(if (or method-class documentation) `(',method-class))
1551      ,@(if documentation `(,documentation)))))
1552
1553
1554
1555(defmacro defclass (class-name superclasses slots &rest class-options &environment env)
1556  (flet ((duplicate-options (where) (signal-program-error "Duplicate options in ~S" where))
1557         (illegal-option (option) (signal-program-error "Illegal option ~s" option))
1558         (make-initfunction (form)
1559           (cond ((or (eq form 't)
1560                      (equal form ''t))
1561                  '(function true))
1562                 ((or (eq form 'nil)
1563                      (equal form ''nil))
1564                  '(function false))
1565                 (t
1566                  `(function (lambda () ,form))))))
1567    (setq class-name (require-type class-name '(and symbol (not null))))
1568    (setq superclasses (mapcar #'(lambda (s) (require-type s 'symbol)) superclasses))
1569    (let* ((options-seen ())
1570           (signatures ())
1571           (slot-names))
1572      (flet ((canonicalize-defclass-option (option)
1573               (let* ((option-name (car option)))
1574                 (if (member option-name options-seen :test #'eq)
1575                   (duplicate-options class-options)
1576                   (push option-name options-seen))
1577                 (case option-name
1578                   (:default-initargs
1579                       (let ((canonical ()))
1580                         (let (key val (tail (cdr option)))
1581                           (loop (when (null tail) (return nil))
1582                               (setq key (pop tail)
1583                                     val (pop tail))
1584                             (push ``(,',key ,',val  ,,(make-initfunction val)) canonical))
1585                           `(':direct-default-initargs (list ,@(nreverse canonical))))))
1586                   (:metaclass
1587                    (unless (and (cadr option)
1588                                 (typep (cadr option) 'symbol))
1589                      (illegal-option option))
1590                    `(:metaclass  ',(cadr option)))
1591                   (:documentation
1592                    `(:documentation ',(cadr option)))
1593                   (t
1594                    (list `',option-name `',(cdr option))))))
1595             (canonicalize-slot-spec (slot)
1596               (if (null slot) (signal-program-error "Illegal slot NIL"))
1597               (if (not (listp slot)) (setq slot (list slot)))
1598               (let* ((slot-name (require-type (car slot) 'symbol))
1599                      (initargs nil)
1600                      (other-options ())
1601                      (initform nil)
1602                      (initform-p nil)
1603                      (initfunction nil)
1604                      (type nil)
1605                      (type-p nil)
1606                      (allocation nil)
1607                      (allocation-p nil)
1608                      (documentation nil)
1609                      (documentation-p nil)
1610                      (readers nil)
1611                      (writers nil))
1612                 (when (memq slot-name slot-names)
1613                   (SIGNAL-PROGRAM-error "Duplicate slot name ~S" slot-name))
1614                 (push slot-name slot-names)
1615                 (do ((options (cdr slot) (cddr options))
1616                      name)
1617                     ((null options))
1618                   (when (null (cdr options)) (signal-program-error "Illegal slot spec ~S" slot))
1619                   (case (car options)
1620                     (:reader
1621                      (setq name (cadr options))
1622                      (push name signatures)
1623                      (push name readers))
1624                     (:writer                     
1625                      (setq name (cadr options))
1626                      (push name signatures)
1627                      (push name writers))
1628                     (:accessor
1629                      (setq name (cadr options))
1630                      (push name signatures)
1631                      (push name readers)
1632                      (push `(setf ,name) signatures)
1633                      (push `(setf ,name) writers))
1634                     (:initarg
1635                      (push (require-type (cadr options) 'symbol) initargs))
1636                     (:type
1637                      (if type-p
1638                        (duplicate-options slot)
1639                        (setq type-p t))
1640                      ;(when (null (cadr options)) (signal-program-error "Illegal options ~S" options))
1641                      (setq type (cadr options)))
1642                     (:initform
1643                      (if initform-p
1644                        (duplicate-options slot)
1645                        (setq initform-p t))
1646                      (let ((option (cadr options)))
1647                        (setq initform `',option
1648                              initfunction
1649                              (if (constantp option)
1650                                `(constantly ,option)
1651                                `#'(lambda () ,option)))))
1652                     (:allocation
1653                      (if allocation-p
1654                        (duplicate-options slot)
1655                        (setq allocation-p t))
1656                      (setq allocation (cadr options)))
1657                     (:documentation
1658                      (if documentation-p
1659                        (duplicate-options slot)
1660                        (setq documentation-p t))
1661                      (setq documentation (cadr options)))
1662                     (t
1663                      (let* ((pair (or (assq (car options) other-options)
1664                                       (car (push (list (car options)) other-options)))))
1665                        (push (cadr options) (cdr pair))))))
1666                 `(list :name ',slot-name
1667                   ,@(when allocation `(:allocation ',allocation))
1668                   ,@(when initform-p `(:initform ,initform
1669                                        :initfunction ,initfunction))
1670                   ,@(when initargs `(:initargs ',initargs))
1671                   ,@(when readers `(:readers ',readers))
1672                   ,@(when writers `(:writers ',writers))
1673                   ,@(when type-p `(:type ',type))
1674                   ,@(when documentation-p `(:documentation ,documentation))
1675                   ,@(mapcan #'(lambda (opt)
1676                                 `(',(car opt) ',(cdr opt))) other-options)))))
1677        (let* ((direct-superclasses superclasses)
1678               (direct-slot-specs (mapcar #'canonicalize-slot-spec slots))
1679               (other-options (apply #'append (mapcar #'canonicalize-defclass-option class-options ))))
1680          `(progn
1681            (eval-when (:compile-toplevel)
1682              (%compile-time-defclass ',class-name ,env)
1683              (progn
1684                ,@(mapcar #'(lambda (s) `(note-function-info ',s nil ,env))
1685                          signatures)))
1686              (ensure-class-for-defclass ',class-name
1687                            :direct-superclasses ',direct-superclasses
1688                            :direct-slots ,`(list ,@direct-slot-specs)
1689                            ,@other-options)))))))
1690
1691(defmacro define-method-combination (name &rest rest &environment env)
1692  (setq name (require-type name 'symbol))
1693  (cond ((or (null rest) (and (car rest) (symbolp (car rest))))
1694         `(short-form-define-method-combination ',name ',rest))
1695        ((listp (car rest))
1696         (destructuring-bind (lambda-list method-group-specifiers . forms) rest
1697           (long-form-define-method-combination 
1698            name lambda-list method-group-specifiers forms env)))
1699        (t (%badarg (car rest) '(or (and null symbol) list)))))
1700
1701(defmacro defgeneric (function-name lambda-list &rest options-and-methods &environment env)
1702  (fboundp function-name)             ; type-check
1703  (multiple-value-bind (method-combination generic-function-class options methods)
1704                       (parse-defgeneric function-name t lambda-list options-and-methods)
1705    (let ((gf (gensym)))
1706      `(progn
1707         (eval-when (:compile-toplevel)
1708           (note-function-info ',function-name nil ,env))
1709         (let ((,gf (%defgeneric
1710                     ',function-name ',lambda-list ',method-combination ',generic-function-class 
1711                     ',(apply #'append options))))
1712           (%set-defgeneric-methods ,gf ,@methods)
1713           ,gf)))))
1714
1715
1716
1717(defun parse-defgeneric (function-name global-p lambda-list options-and-methods)
1718  (check-generic-function-lambda-list lambda-list)
1719  (let ((method-combination '(standard))
1720        (generic-function-class 'standard-generic-function)
1721        options declarations methods option-keywords method-class)
1722    (flet ((bad-option (o)
1723             (signal-program-error "Bad option: ~s to ~s." o 'defgeneric)))
1724      (dolist (o options-and-methods)
1725        (let ((keyword (car o))
1726              (defmethod (if global-p 'defmethod 'anonymous-method)))
1727          (if (eq keyword :method)
1728            (push `(,defmethod ,function-name ,@(%cdr o)) methods)
1729            (cond ((and (not (eq keyword 'declare))
1730                        (memq keyword (prog1 option-keywords (push keyword option-keywords))))             
1731                   (signal-program-error "Duplicate option: ~s to ~s" keyword 'defgeneric))
1732                  ((eq keyword :method-combination)
1733                   (unless (symbolp (cadr o))
1734                     (bad-option o))
1735                   (setq method-combination (cdr o)))
1736                  ((eq keyword :generic-function-class)
1737                   (unless (and (cdr o) (symbolp (cadr o)) (null (%cddr o)))
1738                     (bad-option o))
1739                   (setq generic-function-class (%cadr o)))
1740                  ((eq keyword 'declare)
1741                   (push (cadr o) declarations))
1742                  ((eq keyword :argument-precedence-order)
1743                   (dolist (arg (cdr o))
1744                     (unless (and (symbolp arg) (memq arg lambda-list))
1745                       (bad-option o)))
1746                   (push (list keyword (cdr o)) options))
1747                  ((eq keyword :method-class)
1748                   (push o options)
1749                   (when (or (cddr o) (not (symbolp (setq method-class (%cadr o)))))
1750                     (bad-option o)))
1751                  ((eq keyword :documentation)
1752                   (push o options)
1753                   (when (or (cddr o) (not (stringp (%cadr o))))
1754                     (bad-option o)))
1755                  (t (bad-option o)))))))
1756    (when method-class
1757      (dolist (m methods)
1758        (push `(:method-class ,method-class) (cddr m))))
1759    (when declarations
1760      (setq options `((:declarations ,declarations) ,@options)))
1761    (values method-combination generic-function-class options methods)))
1762
1763                 
1764(defmacro def-aux-init-functions (class &rest functions)
1765  `(set-aux-init-functions ',class (list ,@functions)))
1766
1767
1768
1769
1770
1771
1772; A powerful way of defining REPORT-CONDITION...
1773; Do they really expect that each condition type has a unique method on PRINT-OBJECT
1774; which tests *print-escape* ?  Scary if so ...
1775
1776(defmacro define-condition (name (&rest supers) &optional ((&rest slots)) &body options)
1777  ; If we could tell what environment we're being expanded in, we'd
1778  ; probably want to check to ensure that all supers name conditions
1779  ; in that environment.
1780  (let ((classopts nil)
1781        (duplicate nil)
1782        (docp nil)
1783        (default-initargs-p nil)
1784        (reporter nil))
1785    (dolist (option options)
1786      (unless (and (consp option)
1787                   (consp (%cdr option)))
1788        (error "Invalid option ~s ." option))
1789      (ecase (%car option)
1790        (:default-initargs 
1791            (unless (plistp (cdr option)) 
1792              (signal-program-error "~S is not a plist." (%cdr option))) 
1793            (if default-initargs-p 
1794              (setq duplicate t) 
1795              (push (setq default-initargs-p option) classopts))) 
1796        (:documentation 
1797         (unless (null (%cddr option)) 
1798           (error "Invalid option ~s ." option)) 
1799         (if docp
1800           (setq duplicate t)
1801           (push (setq docp option) classopts)))
1802        (:report 
1803         (unless (null (%cddr option)) 
1804           (error "Invalid option ~s ." option)) 
1805         (if reporter
1806           (setq duplicate t)
1807           (progn
1808             (if (or (lambda-expression-p (setq reporter (%cadr option)))
1809                     (symbolp reporter))
1810               (setq reporter `(function ,reporter))
1811               (if (stringp reporter)
1812                 (setq reporter `(function (lambda (c s) (declare (ignore c)) (write-string ,reporter s))))
1813                 (error "~a expression is not a string, symbol, or lambda expression ." (%car option))))
1814             (setq reporter `((defmethod report-condition ((c ,name) s)
1815                                (funcall ,reporter c s))))))))
1816      (if duplicate (error "Duplicate option ~s ." option)))
1817    `(progn
1818       (defclass ,name ,(or supers '(condition)) ,slots ,@classopts)
1819       ,@reporter
1820       ',name)))
1821
1822(defmacro with-condition-restarts (&environment env condition restarts &body body)
1823  (multiple-value-bind (body decls)
1824                       (parse-body body env)
1825    (let ((cond (gensym))
1826          (r (gensym)))
1827          `(let* ((*condition-restarts* *condition-restarts*))
1828             ,@decls
1829             (let ((,cond ,condition))
1830               (dolist (,r ,restarts) (push (cons ,r ,cond) *condition-restarts*))
1831               ,@body)))))
1832 
1833(defmacro setf-find-class (name arg1 &optional (arg2 () 2-p) (arg3 () 3-p))
1834  (cond (3-p ;might want to pass env (arg2) to find-class someday?
1835         `(set-find-class ,name (progn ,arg1 ,arg2 ,arg3)))
1836        (2-p
1837         `(set-find-class ,name (progn ,arg1 ,arg2)))
1838        (t `(set-find-class ,name ,arg1))))
1839
1840(defsetf find-class setf-find-class)
1841
1842(defmacro restoring-interrupt-level (var &body body)
1843  `(unwind-protect
1844    (progn ,@body)
1845    (restore-interrupt-level ,var)
1846    (%interrupt-poll)))
1847
1848(defmacro without-interrupts (&body body)
1849  (let* ((level (gensym)))
1850    `(let* ((,level (disable-lisp-interrupts)))
1851      (restoring-interrupt-level ,level ,@body))))
1852
1853
1854;; undoes the effect of one enclosing without-interrupts during execution of body.
1855(defmacro ignoring-without-interrupts (&body body)
1856  (let* ((level (gensym)))
1857    `(let ((,level (interrupt-level)))
1858       (unwind-protect
1859            (progn
1860              (setf (interrupt-level) 0)
1861              ,@body)
1862         (setf (interrupt-level) ,level)))))
1863
1864(defmacro error-ignoring-without-interrupts (format-string &rest format-args)
1865  `(ignoring-without-interrupts
1866    (error ,format-string ,@format-args)))
1867
1868
1869;init-list-default: if there is no init pair for <keyword>,
1870;    add a <keyword> <value> pair to init-list
1871(defmacro init-list-default (the-init-list &rest args)
1872  (let ((result)
1873       (init-list-sym (gensym)))
1874   (do ((args args (cddr args)))
1875       ((not args))
1876     (setq result 
1877           (cons `(if (eq '%novalue (getf ,init-list-sym ,(car args) 
1878                                          '%novalue))
1879                    (setq ,init-list-sym (cons ,(car args) 
1880                                               (cons ,(cadr args) 
1881                                                     ,init-list-sym))))
1882                 result)))                                                                               
1883   `(let ((,init-list-sym ,the-init-list))
1884      (progn ,@result)
1885      ,init-list-sym)
1886   ))
1887
1888; This can only be partially backward-compatible: even if only
1889; the "name" arg is supplied, the old function would create the
1890; package if it didn't exist.
1891; Should see how well this works & maybe flush the whole idea.
1892
1893(defmacro in-package (&whole call name &rest gratuitous-backward-compatibility)
1894  (let ((form nil))
1895    (cond (gratuitous-backward-compatibility
1896           (cerror "Macroexpand into a call to the old IN-PACKAGE function."
1897                   "Macro call ~S contains extra arguments." call )
1898           (setq form `(ccl::old-in-package ,name ,@gratuitous-backward-compatibility)))
1899        (t
1900         (when (quoted-form-p name)
1901           (warn "Unquoting argument ~S to ~S." name 'in-package )
1902           (setq name (cadr name)))   
1903         (setq form `(set-package ,(string name)))))
1904         `(eval-when (:execute :load-toplevel :compile-toplevel)
1905            ,form)))
1906
1907(defmacro defpackage (name &rest options)
1908  (let* ((size nil)
1909         (all-names-size 0)
1910         (intern-export-size 0)
1911         (shadow-etc-size 0)
1912         (documentation nil)
1913         (all-names-hash (let ((all-options-alist nil))
1914                           (dolist (option options)
1915                             (let ((option-name (car option)))
1916                               (when (memq option-name
1917                                           '(:nicknames :shadow :shadowing-import-from
1918                                             :use :import-from :intern :export))
1919                                 (let ((option-size (length (cdr option)))
1920                                       (cell (assq option-name all-options-alist)))
1921                                   (declare (fixnum option-size))
1922                                   (if cell
1923                                     (incf (cdr cell) option-size)
1924                                     (push (cons option-name option-size) all-options-alist))
1925                                   (when (memq option-name '(:shadow :shadowing-import-from :import-from :intern))
1926                                     (incf shadow-etc-size option-size))
1927                                   (when (memq option-name '(:export :intern))
1928                                     (incf intern-export-size option-size))))))
1929                           (dolist (cell all-options-alist)
1930                             (let ((option-size (cdr cell)))
1931                               (when (> option-size all-names-size)
1932                                 (setq all-names-size option-size))))
1933                           (when (> all-names-size 0)
1934                             (make-hash-table :test 'equal :size all-names-size))))
1935         (intern-export-hash (when (> intern-export-size 0)
1936                               (make-hash-table :test 'equal :size intern-export-size)))
1937         (shadow-etc-hash (when (> shadow-etc-size 0)
1938                            (make-hash-table :test 'equal :size shadow-etc-size)))
1939         (external-size nil)
1940         (nicknames nil)
1941         (shadow nil)
1942         (shadowing-import-from-specs nil)
1943         (use :default)
1944         (import-from-specs nil)
1945         (intern nil)
1946         (export nil))
1947    (declare (fixnum all-names-size intern-export-size shadow-etc-size))
1948    (labels ((string-or-name (s) (string s))
1949             (duplicate-option (o)
1950               (signal-program-error "Duplicate ~S option in ~S ." o options))
1951             (duplicate-name (name option-name)
1952               (signal-program-error "Name ~s, used in ~s option, is already used in a conflicting option ." name option-name))
1953             (all-names (option-name tail already)
1954               (when (eq already :default) (setq already nil))
1955               (when all-names-hash
1956                 (clrhash all-names-hash))
1957               (dolist (name already)
1958                 (setf (gethash (string-or-name name) all-names-hash) t))
1959               (dolist (name tail already)
1960                 (setq name (string-or-name name))
1961                 (unless (gethash name all-names-hash)          ; Ok to repeat name in same option.
1962                   (when (memq option-name '(:shadow :shadowing-import-from :import-from :intern))
1963                     (if (gethash name shadow-etc-hash)
1964                       (duplicate-name name option-name))
1965                     (setf (gethash name shadow-etc-hash) t))
1966                   (when (memq option-name '(:export :intern))
1967                     (if (gethash name intern-export-hash)
1968                       (duplicate-name name option-name))
1969                     (setf (gethash name intern-export-hash) t))
1970                   (setf (gethash name all-names-hash) t)
1971                   (push name already)))))
1972      (dolist (option options)
1973        (let ((args (cdr option)))
1974          (ecase (%car option)
1975                 (:size 
1976                  (if size 
1977                    (duplicate-option :size) 
1978                    (setq size (car args))))             
1979                 (:external-size 
1980                  (if external-size 
1981                    (duplicate-option :external-size) 
1982                    (setq external-size (car args))))
1983                 (:nicknames (setq nicknames (all-names nil args nicknames)))
1984                 (:shadow (setq shadow (all-names :shadow args shadow)))
1985                 (:shadowing-import-from
1986                  (destructuring-bind (from &rest shadowing-imports) args
1987                    (push (cons (string-or-name from)
1988                                (all-names :shadowing-import-from shadowing-imports nil))
1989                          shadowing-import-from-specs)))
1990                 (:use (setq use (all-names nil args use)))
1991                 (:import-from
1992                  (destructuring-bind (from &rest imports) args
1993                    (push (cons (string-or-name from)
1994                                (all-names :import-from imports nil))
1995                          import-from-specs)))
1996                 (:intern (setq intern (all-names :intern args intern)))
1997                 (:export (setq export (all-names :export args export)))
1998                 (:documentation
1999                  (if documentation
2000                    (duplicate-option :documentation)
2001                    (setq documentation (cadr option)))))))
2002      `(eval-when (:execute :compile-toplevel :load-toplevel)
2003         (%define-package ',(string-or-name name)
2004          ',size 
2005          ',external-size 
2006          ',nicknames
2007          ',shadow
2008          ',shadowing-import-from-specs
2009          ',use
2010          ',import-from-specs
2011          ',intern
2012          ',export
2013          ',documentation)))))
2014
2015
2016(defmacro %cons-pkg-iter (pkgs types)
2017  `(vector ,pkgs ,types #'%start-with-package-iterator
2018           nil nil nil nil))
2019
2020(defmacro with-package-iterator ((mname package-list first-type &rest other-types)
2021                                 &body body)
2022  (setq mname (require-type mname 'symbol))
2023  (let ((state (make-symbol "WITH-PACKAGE-ITERATOR_STATE"))
2024        (types 0))
2025    (declare (fixnum types))
2026    (dolist (type (push first-type other-types))
2027      (case type
2028        (:external (setq types (bitset $pkg-iter-external types)))
2029        (:internal (setq types (bitset $pkg-iter-internal types)))
2030        (:inherited (setq types (bitset $pkg-iter-inherited types)))
2031        (t (%badarg type '(member :internal :external :inherited)))))
2032    `(let ((,state (%cons-pkg-iter ,package-list ',types)))
2033       (declare (dynamic-extent ,state))
2034       (macrolet ((,mname () `(funcall (%svref ,',state #.pkg-iter.state) ,',state)))
2035         ,@body))))
2036
2037; Does NOT evaluate the constructor, but DOES evaluate the destructor & initializer
2038(defmacro defresource (name &key constructor destructor initializer)
2039  `(defparameter ,name (make-resource #'(lambda () ,constructor)
2040                                      ,@(when destructor
2041                                          `(:destructor ,destructor))
2042                                      ,@(when initializer
2043                                          `(:initializer ,initializer)))))
2044
2045(defmacro using-resource ((var resource) &body body)
2046  (let ((resource-var (gensym)))
2047  `(let ((,resource-var ,resource)
2048         ,var)
2049     (unwind-protect
2050       (progn
2051         (setq ,var (allocate-resource ,resource-var))
2052         ,@body)
2053       (when ,var
2054         (free-resource ,resource-var ,var))))))
2055
2056(defmacro with-lock-grabbed ((lock &optional
2057                                   (whostate "Lock"))
2058                             &body body)
2059  (declare (ignore whostate))
2060  `(with-recursive-lock (,lock) ,@body))
2061
2062(defmacro with-lock-grabbed-maybe ((lock &optional
2063                                         (whostate "Lock"))
2064                                   &body body)
2065  (declare (ignore whostate))
2066  `(with-recursive-lock-maybe (,lock) ,@body))
2067
2068(defmacro with-standard-abort-handling (abort-message &body body)
2069  (let ((stream (gensym)))
2070    `(restart-case
2071       (catch :abort
2072         (catch-cancel
2073           ,@body))
2074       (abort () ,@(when abort-message
2075                     `(:report (lambda (,stream)
2076                                 (write-string ,abort-message ,stream)))))
2077       (abort-break ()))))
2078       
2079
2080
2081
2082(defmacro %lexpr-count (l)
2083  `(%lisp-word-ref ,l 0))
2084
2085(defmacro %lexpr-ref (lexpr count i)
2086  `(%lisp-word-ref ,lexpr (%i- ,count ,i)))
2087
2088; args will be list if old style clos
2089(defmacro apply-with-method-context (magic function args)
2090  (let ((m (gensym))
2091        (f (gensym))
2092        (as (gensym)))
2093      `((lambda (,m ,f ,as)
2094          (if (listp ,as)
2095            (%apply-with-method-context ,m ,f ,as)
2096            (%apply-lexpr-with-method-context ,m ,f ,as))) ,magic ,function ,args)))
2097
2098(defmacro defcallback (name arglist &body body &environment env)
2099  (define-callback name arglist body env))
2100
2101(defmacro %get-single-float-from-double-ptr (ptr offset)
2102  `(%double-float->short-float (%get-double-float ,ptr ,offset)))
2103
2104(defun define-callback (name args body env)
2105  (let* ((stack-word (gensym))
2106         (stack-ptr (gensym))
2107         (arg-names ())
2108         (arg-types ())
2109         (return-type :void)
2110         (args args)
2111         (woi nil)
2112         (monitor nil)
2113         (dynamic-extent-names ())
2114         (error-return nil))
2115    (loop
2116      (when (null args) (return))
2117      (when (null (cdr args))
2118        (setq return-type (car args))
2119        (return))
2120      (if (eq (car args) :without-interrupts)
2121        (setq woi (cadr args) args (cddr args))
2122        (if (eq (car args) :monitor-exception-ports)
2123          (setq monitor (cadr args) args (cddr args))
2124          (if (eq (car args) :error-return)
2125            (setq error-return
2126                  #+poweropen-target (cadr args)
2127                  #-poweropen-target (warn "~s not yet implemented on this platform"
2128                                           :error-return)
2129                  args (cddr args))
2130            (progn
2131              (push (foreign-type-to-representation-type (pop args)) arg-types)
2132              (push (pop args) arg-names))))))
2133    (setq arg-names (nreverse arg-names)
2134          arg-types (nreverse arg-types))
2135    (setq return-type (foreign-type-to-representation-type return-type))
2136    (when (eq return-type :void)
2137      (setq return-type nil))
2138    (let* ((offset #+poweropen-target 0 #+eabi-target 96)
2139           #+eabi-target (gpr 0)
2140           #+eabi-target (fpr 32)
2141           (need-stack-pointer (or arg-names return-type error-return))
2142           (lets
2143             (mapcar
2144              #+poweropen-target
2145              #'(lambda (name type)
2146                  (let* ((delta 4)
2147                         (bias 0))
2148                    (prog1
2149                        (list name
2150                              `(,
2151                                (if (typep type 'unsigned-byte)
2152                                  (progn (setq delta (* 4 type)) '%inc-ptr)
2153                                  (ecase type
2154                                    (:single-float '%get-single-float)
2155                                    (:double-float (setq delta 8)'%get-double-float)
2156                                    (:signed-doubleword (setq delta 8) '%%get-signed-longlong)
2157                                    (:signed-fullword '%get-signed-long)
2158                                    (:signed-halfword (setq bias 2) '%get-signed-word)
2159                                    (:signed-byte (setq bias 3) '%get-signed-byte)
2160                                    (:unsigned-doubleword (setq delta 8) '%%get-unsigned-longlong)
2161                                    (:unsigned-fullword '%get-unsigned-long)
2162                                    (:unsigned-halfword (setq bias 2) '%get-unsigned-word)
2163                                    (:unsigned-byte (setq bias 3) '%get-unsigned-byte)
2164                                    (:address '%get-ptr)))
2165                                ,stack-ptr
2166                                (+ ,offset ,bias)))
2167                      (when (or (eq type :address)
2168                                (typep type 'unsigned-byte))
2169                        (push name dynamic-extent-names))
2170                      (incf offset delta))))
2171              #+eabi-target
2172              #'(lambda (name type)
2173                  (let* ((nextgpr gpr)
2174                         (nextfpr fpr)
2175                         (nextoffset offset)
2176                         (target gpr)
2177                         (bias 0))
2178                    (prog1
2179                        (list name
2180                              `(,
2181                                (case type
2182                                  (:single-float
2183                                   (incf nextfpr 8)
2184                                   (if (< fpr 96)
2185                                     (setq target fpr)
2186                                     (setq target (+ offset (logand offset 4))
2187                                           nextoffset (+ target 8)))
2188                                   '%get-single-float-from-double-ptr)
2189                                  (:double-float
2190                                   (incf nextfpr 8)
2191                                   (if (< fpr 96)
2192                                     (setq target fpr)
2193                                     (setq target (+ offset (logand offset 4))
2194                                           nextoffset (+ target 8)))
2195                                   '%get-double-float)
2196                                  (:signed-doubleword
2197                                   (if (< gpr 56)
2198                                     (setq target (+ gpr (logand gpr 4))
2199                                           nextgpr (+ 8 target))
2200                                     (setq target (+ offset (logand offset 4))
2201                                           nextoffset (+ 8 offset)))
2202                                   '%%get-signed-longlong)
2203                                  (:unsigned-doubleword
2204                                   (if (< gpr 56)
2205                                     (setq target (+ gpr (logand gpr 4))
2206                                           nextgpr (+ 8 target))
2207                                     (setq target (+ offset (logand offset 4))
2208                                           nextoffset (+ 8 offset)))
2209                                   '%%get-unsigned-longlong)
2210                                  (t
2211                                   (incf nextgpr 4)
2212                                   (if (< gpr 64)
2213                                     (setq target gpr)
2214                                     (setq target offset nextoffset (+ offset 4)))
2215                                   (ecase type
2216                                     (:signed-fullword '%get-signed-long)
2217                                     (:signed-halfword (setq bias 2) '%get-signed-word)
2218                                     (:signed-byte (setq bias 3) '%get-signed-byte)
2219                                     (:unsigned-fullword '%get-unsigned-long)
2220                                     (:unsigned-halfword (setq bias 2) '%get-unsigned-word)
2221                                     (:unsigned-byte (setq bias 3) '%get-unsigned-byte)
2222                                     (:address '%get-ptr))))
2223                                ,stack-ptr
2224                                (+ ,target ,bias)))
2225                      (when (eq type :address)
2226                        (push name dynamic-extent-names))
2227                      (setq gpr nextgpr fpr nextfpr offset nextoffset))))
2228              arg-names arg-types)))
2229      (multiple-value-bind (body decls doc) (parse-body body env t)
2230        `(progn
2231           (declaim (special ,name))
2232           (define-callback-function
2233             (nfunction ,name
2234                        (lambda (,stack-word)
2235                          (declare (ignorable ,stack-word))
2236                          (block ,name
2237                            (with-macptrs (,@(and need-stack-pointer (list `(,stack-ptr))))
2238                              ,(when need-stack-pointer
2239                                 `(%setf-macptr-to-object ,stack-ptr ,stack-word))
2240                              ,(defcallback-body stack-ptr lets dynamic-extent-names
2241                                                 decls body return-type error-return
2242                                                 #+poweropen-target
2243                                                 (- ppc32::c-frame.savelr ppc32::c-frame.param0)
2244                                                 #-poweropen-target 0)))))
2245             ,doc
2246             ,woi
2247             ,monitor))))))
2248
2249(defun defcallback-body (stack-ptr lets dynamic-extent-names decls body return-type error-return error-delta)
2250  (let* ((result (gensym))
2251         (condition-name (if (atom error-return) 'error (car error-return)))
2252         (error-return-function (if (atom error-return) error-return (cadr error-return)))
2253         (body
2254          `(let ,lets
2255            (declare (dynamic-extent ,@dynamic-extent-names))
2256            ,@decls
2257            (let ((,result (progn ,@body)))
2258              (declare (ignorable ,result))
2259              , (when return-type
2260                  `(setf (,
2261                          (case return-type
2262                            (:address '%get-ptr)
2263                            (:signed-doubleword '%%get-signed-longlong)
2264                            (:unsigned-doubleword '%%get-unsigned-longlong)
2265                            (:double-float '%get-double-float)
2266                            (:single-float '%get-single-float)
2267                            (t '%get-long)) ,stack-ptr) ,result))))))
2268    (if error-return
2269      (let* ((cond (gensym)))
2270        `(handler-case ,body
2271          (,condition-name (,cond) (,error-return-function ,cond ,stack-ptr (%inc-ptr ,stack-ptr ,error-delta)))))
2272      body)))
2273 
2274
2275(defmacro errchk (form)
2276  (let* ((res (gensym)))
2277    `(let* ((,res ,form))
2278       (if (eql 0 ,res)
2279         0
2280         (signal-posix-error ,res)))))
2281
2282(defmacro define-toplevel-command (group-name name arglist &body body &environment env)
2283  (let* ((key (make-keyword name)))
2284    (multiple-value-bind (body decls doc) (parse-body body env)
2285      `(%define-toplevel-command ',group-name ,key ',name 
2286        (nfunction ,name (lambda ,arglist
2287                           ,@decls
2288                           (block ,name
2289                             ,@body)))
2290        ,doc
2291        ',(mapcar #'symbol-name arglist)))))
2292
2293(defmacro with-toplevel-commands (group-name &body body)
2294  `(let* ((*active-toplevel-commands* *active-toplevel-commands*))
2295    (progn
2296      (%use-toplevel-commands ',group-name)
2297      ,@body)))
2298
2299(defmacro assert (test-form &optional (places ()) string &rest args)
2300  "ASSERT Test-Form [(Place*) [String Arg*]]
2301  If the Test-Form is not true, then signal a correctable error.  If Places
2302  are specified, then new values are prompted for when the error is proceeded.
2303  String and Args are the format string and args to the error call."
2304  (let* ((TOP (gensym))
2305         (setf-places-p (not (null places))))
2306    `(tagbody
2307       ,TOP
2308       (unless ,test-form
2309         (%assertion-failure ,setf-places-p ',test-form ,string ,@args)
2310         ,@(if places
2311             `((write-line "Type expressions to set places to, or nothing to leave them alone."
2312                           *query-io*)
2313               ,@(mapcar #'(lambda (place &aux (new-val (gensym))
2314                                          (set-p (gensym)))
2315                             `(multiple-value-bind
2316                                (,new-val ,set-p)
2317                                (assertion-value-prompt ',place)
2318                                (when ,set-p (setf ,place (values-list ,new-val)))))
2319                         places)))
2320         (go ,TOP)))))
2321
2322
2323(defmacro check-type (place typespec &optional string)
2324  "CHECK-TYPE Place Typespec [String]
2325  Signal a correctable error if Place does not hold an object of the type
2326  specified by Typespec."
2327  `(progn
2328     (setf ,place 
2329           (ensure-value-of-type 
2330            ,place 
2331            ',typespec 
2332            ',place 
2333            ,(if string string (list 'quote typespec))))
2334     nil))
2335
2336(defmacro with-hash-table-iterator ((mname hash-table) &body body &environment env)
2337  (let ((state (gensym)))
2338    (multiple-value-bind (body decls) (parse-body body env)
2339      `(let ((,state (vector nil nil ,hash-table nil nil)))
2340        (declare (dynamic-extent ,state))
2341        (unwind-protect
2342             (macrolet ((,mname () `(do-hash-table-iteration ,',state)))
2343               (start-hash-table-iterator ,state)
2344               (locally ,@decls ,@body))
2345          (finish-hash-table-iterator ,state))))))
2346
2347(eval-when (compile load eval)
2348(defmacro pprint-logical-block ((stream-symbol list
2349                                 &key (prefix nil) (per-line-prefix nil)
2350                                      (suffix ""))
2351                                &body body)
2352  (cond ((eq stream-symbol nil) (setq stream-symbol '*standard-output*))
2353        ((eq stream-symbol T) (setq stream-symbol '*terminal-io*)))
2354  (when (not (symbolp stream-symbol))
2355    (warn "STREAM-SYMBOL arg ~S to PPRINT-LOGICAL-BLOCK is not a bindable symbol"
2356          stream-symbol)
2357    (setq stream-symbol '*standard-output*))
2358  (when (and prefix per-line-prefix)
2359    (warn "prefix ~S and per-line-prefix ~S cannot both be specified ~
2360           in PPRINT-LOGICAL-BLOCK")
2361    (setq per-line-prefix nil))
2362  `(maybe-initiate-xp-printing
2363     #'(lambda (,stream-symbol)
2364         (let ((+l ,list)
2365               (+p ,(or prefix per-line-prefix ""))
2366               (+s ,suffix))
2367           (pprint-logical-block+
2368             (,stream-symbol +l +p +s ,(not (null per-line-prefix)) T nil)
2369             ,@ body nil)))
2370     (decode-stream-arg ,stream-symbol)))
2371
2372
2373;Assumes var and args must be variables.  Other arguments must be literals or variables.
2374
2375(defmacro pprint-logical-block+ ((var args prefix suffix per-line? circle-check? atsign?)
2376                                 &body body)
2377  (when (and circle-check? atsign?)
2378    (setq circle-check? 'not-first-p))
2379  `(let ((*current-level* (1+ *current-level*))
2380         (*current-length* -1)
2381         ;(*parents* *parents*)
2382         ,@(if (and circle-check? atsign?) `((not-first-p (plusp *current-length*)))))
2383     (unless (check-block-abbreviation ,var ,args ,circle-check?)
2384       (start-block ,var ,prefix ,per-line? ,suffix)
2385       (when
2386         (catch 'line-limit-abbreviation-exit
2387           (block logical-block
2388             (macrolet ((pprint-pop () `(pprint-pop+ ,',args ,',var))
2389                        (pprint-exit-if-list-exhausted ()
2390                          `(if (null ,',args) (return-from logical-block nil))))
2391               ,@ body))
2392           (end-block ,var ,suffix)
2393           nil)
2394         (end-block ,var ,suffix)
2395         (throw 'line-limit-abbreviation-exit T)))))
2396) ; eval-when
2397
2398(defmacro %old-class-local-shared-slotds (class &optional default)
2399  (if default                           ; so setf works
2400    `(%class-get ,class '%old-class-local-shared-slotds ,default)
2401    `(%class-get ,class '%old-class-local-shared-slotds)))
2402
2403(defmacro with-slot-values (slot-entries instance-form &body body)
2404; Simplified form of with-slots.  Expands into a let instead of a symbol-macrolet
2405; Thus, you can access the slot values, but you can't setq them.
2406  (let ((instance (gensym)) var slot-name bindings)
2407    (dolist (slot-entry slot-entries)
2408      (cond ((symbolp slot-entry)
2409             (setq var slot-entry slot-name slot-entry))
2410            ((and (listp slot-entry) (cdr slot-entry) (null (cddr slot-entry))
2411                  (symbolp (car slot-entry)) (symbolp (cadr slot-entry)))
2412             (setq var (car slot-entry) slot-name (cadr slot-entry)))
2413            (t (error "Malformed slot-entry: ~a to with-slot-values.~@
2414                       Should be a symbol or a list of two symbols."
2415                      slot-entry)))
2416      (push `(,var (slot-value ,instance ',slot-name)) bindings))
2417    `(let ((,instance ,instance-form))
2418       (let ,(nreverse bindings)
2419         ,@body))))
2420
2421(defmacro with-slots (slot-entries instance-form &body body)
2422  (let ((instance (gensym)) var slot-name bindings)
2423    (dolist (slot-entry slot-entries)
2424      (cond ((symbolp slot-entry)
2425             (setq var slot-entry slot-name slot-entry))
2426            ((and (listp slot-entry) (cdr slot-entry) (null (cddr slot-entry))
2427                  (symbolp (car slot-entry)) (symbolp (cadr slot-entry)))
2428             (setq var (car slot-entry) slot-name (cadr slot-entry)))
2429            (t (error "Malformed slot-entry: ~a to with-slots.~@
2430                       Should be a symbol or a list of two symbols."
2431                      slot-entry)))
2432      (push `(,var (slot-value ,instance ',slot-name)) bindings))
2433    `(let ((,instance ,instance-form))
2434       ,@(unless bindings (list `(declare (ignore ,instance))))
2435       (symbol-macrolet ,(nreverse bindings)
2436         ,@body))))
2437
2438(defmacro with-accessors (slot-entries instance-form &body body)
2439  (let ((instance (gensym)) var reader bindings)
2440    (dolist (slot-entry slot-entries)
2441      (cond ((and (listp slot-entry) (cdr slot-entry) (null (cddr slot-entry))
2442                  (symbolp (car slot-entry)) (symbolp (cadr slot-entry)))
2443             (setq var (car slot-entry) reader (cadr slot-entry)))
2444            (t (error "Malformed slot-entry: ~a to with-accessors.~@
2445                       Should be a list of two symbols."
2446                      slot-entry)))
2447      (push `(,var (,reader ,instance)) bindings))
2448    `(let ((,instance ,instance-form))
2449       ,@(unless bindings (list `(declare (ignore ,instance))))
2450       (symbol-macrolet ,(nreverse bindings)
2451         ,@body))))
2452
2453; I wanted to call this ":method"
2454(defmacro reference-method (gf &rest qualifiers-and-specializers)
2455  (let ((qualifiers (butlast qualifiers-and-specializers))
2456        (specializers (car (last qualifiers-and-specializers))))
2457    (if (null specializers) (report-bad-arg qualifiers-and-specializers '(not null)))
2458    `(find-method #',gf ',qualifiers (mapcar #'find-specializer ',specializers))))
2459
2460(defmacro time (form)
2461  `(report-time ',form #'(lambda () (progn ,form))))
2462
2463(defmacro with-error-reentry-detection (&body body)
2464  (let ((thunk (gensym)))
2465    `(let ((,thunk #'(lambda () ,@body)))
2466       (declare (dynamic-extent ,thunk))
2467       (funcall-with-error-reentry-detection ,thunk))))
2468
2469(defmacro scan-for-instr (mask opcode fn pc-index &optional (tries *trap-lookup-tries*))
2470  `(%scan-for-instr ,mask ,opcode ,fn ,pc-index ,tries))
2471
2472(defmacro codevec-header-p (word)
2473  `(eql ppc32::subtag-code-vector
2474    (logand ,word ppc32::subtag-mask)))
2475
2476(defmacro match-instr (instr mask bits-to-match)
2477  `(eql (logand ,instr ,mask) ,bits-to-match))
2478
2479(defmacro with-xp-stack-frames ((xp trap-function &optional stack-frame) &body body)
2480  (let ((thunk (gensym))
2481        (sf (or stack-frame (gensym))))
2482    `(let ((,thunk #'(lambda (&optional ,sf)
2483                       ,@(unless stack-frame `((declare (ignore ,sf))))
2484                       ,@body)))
2485       (declare (dynamic-extent ,thunk))
2486       (funcall-with-xp-stack-frames ,xp ,trap-function ,thunk))))
2487
2488(defmacro signal-eof-error (stream)
2489  `(error 'end-of-file :stream ,stream))
2490
2491(defmacro check-eof (valform stream eof-error-p eof-value)
2492  (let* ((val (gensym)))
2493    `(let ((,val ,valform))
2494      (if (eq ,val :eof)
2495        (if ,eof-error-p
2496          (signal-eof-error ,stream)
2497          ,eof-value)
2498        ,val))))
2499
2500(defmacro designated-input-stream (input-stream)
2501  `(if ,input-stream
2502    (if (eq t ,input-stream)
2503      *terminal-io*
2504      ,input-stream)
2505    *standard-input*))
2506
2507(defmacro pref (pointer accessor)
2508  (destructuring-bind (type-name &rest accessors) (decompose-record-accessor accessor)
2509    (%foreign-access-form pointer (%foreign-type-or-record type-name) 0 accessors)))
2510
2511(defmacro rref (pointer accessor &key (storage :pointer storage-p))
2512  (when storage-p
2513    (warn "Use of :storage option ignored: ~a" storage))
2514  `(pref ,pointer ,accessor))
2515
2516(defmacro rlet (spec &body body)
2517  `(%stack-block ,(rlet-sizes spec)
2518     ,@(rlet-inits spec)
2519     ,@body))
2520
2521(defmacro rletZ (spec &body body)
2522  `(%stack-block ,(rlet-sizes spec t)
2523     ,@(rlet-inits spec)
2524     ,@body))
2525
2526(defun rlet-sizes (inits &optional clear-p &aux result)
2527  (dolist (item inits (nreverse result))
2528    (push `(,(car item)
2529            ,(%foreign-type-or-record-size (cadr item) :bytes)
2530            ,@(if clear-p '(:clear t)))
2531          result)))
2532
2533(defun rlet-inits (inits &aux result)
2534  (dolist (item inits result)
2535    (let* ((name (car item))
2536           (record-name (cadr item))
2537           (inits (cddr item))
2538           (ftype (%foreign-type-or-record record-name)))
2539      (if (typep ftype 'foreign-record-type)
2540        (setq result (nconc result (%foreign-record-field-forms name ftype record-name inits)))
2541        (progn
2542          ;(setq result (nconc result `((%assert-macptr-ftype ,name ,ftype))))
2543          (when inits
2544            (if (and ftype (null (cdr inits)))
2545              (setq result
2546                    (nconc result
2547                           `((setf ,(%foreign-access-form name ftype 0 nil)
2548                              ,(car inits)))))
2549              (error "Unexpected or malformed initialization forms: ~s in field type: ~s"
2550                     inits record-name))))))))
2551
2552(defun %foreign-record-field-forms (ptr record-type record-name inits)
2553  (unless (evenp (length inits))
2554    (error "Unexpected or malformed initialization forms: ~s in field type: ~s"
2555                     inits record-name))
2556  (let* ((result ()))
2557    (do* ()
2558         ((null inits)
2559          `((progn
2560              ;(%assert-macptr-ftype ,ptr ,record-type)
2561              ,@(nreverse result))))
2562      (let* ((accessor (decompose-record-accessor (pop inits)))
2563             (valform (pop inits)))
2564        (push `(setf ,(%foreign-access-form ptr record-type 0  accessor) ,valform)
2565              result)))))
2566 
2567(defmacro get-field-offset (accessor)
2568  (destructuring-bind (type-name field-name) (decompose-record-accessor accessor)
2569    (let* ((record-type (require-type (%foreign-type-or-record type-name) 'foreign-record-type))
2570           (field (%find-foreign-record-type-field record-type field-name))
2571           (bit-offset (foreign-record-field-offset field)))
2572      `(values ,(floor bit-offset 8) ,(foreign-record-field-type field) ,bit-offset))))
2573
2574(defmacro record-length (recname)
2575  (%foreign-type-or-record-size recname :bytes))
2576
2577(defmacro make-record (record-name &rest initforms)
2578  (let* ((ftype (%foreign-type-or-record record-name))
2579         (bits (ensure-foreign-type-bits ftype))
2580         (bytes (if bits
2581                  (ceiling bits 8)
2582                  (error "Unknown size for foreign type ~S."
2583                         (unparse-foreign-type ftype))))
2584         (p (gensym))
2585         (bzero (read-from-string "#_bzero")))   
2586    `(let* ((,p (malloc ,bytes)))
2587      (,bzero ,p ,bytes)
2588      ,@(%foreign-record-field-forms p ftype record-name initforms)
2589      ,p)))
2590
2591(defmacro with-terminal-input (&body body)
2592  (let* ((got-it (gensym)))
2593    `(let* ((,got-it (%request-terminal-input)))
2594      (unwind-protect
2595           (progn ,@body)
2596        (%restore-terminal-input ,got-it)))))
2597
2598
2599
2600
2601
2602(defmacro %with-recursive-lock-ptr ((lockptr) &body body)
2603  `(unwind-protect
2604    (progn
2605      (%lock-recursive-lock ,lockptr)
2606      ,@body)
2607    (%unlock-recursive-lock ,lockptr)))
2608
2609(defmacro %with-recursive-lock-ptr-maybe ((lockptr) &body body)
2610  `(when (%try-recursive-lock ,lockptr)
2611    (unwind-protect
2612         (progn ,@body)
2613      (%unlock-recursive-lock ,lockptr))))
2614
2615(defmacro with-recursive-lock ((lock) &body body)
2616  (let* ((p (gensym)))
2617    `(let* ((,p (recursive-lock-ptr ,lock)))
2618      (%with-recursive-lock-ptr (,p) ,@body))))
2619
2620(defmacro with-recursive-lock-maybe ((lock) &body body)
2621  (let* ((p (gensym)))
2622    `(let* ((,p (recursive-lock-ptr ,lock)))
2623      (%with-recursive-lock-ptr-maybe (,p) ,@body))))
2624
2625(defmacro with-read-lock ((lock) &body body)
2626  (let* ((p (gensym)))
2627    `(let* ((,p ,lock))
2628      (unwind-protect
2629           (progn
2630             (read-lock-rwlock ,p)
2631             ,@body)
2632        (unlock-rwlock ,p)))))
2633
2634
2635(defmacro with-write-lock ((lock) &body body)
2636  (let* ((p (gensym)))
2637    `(let* ((,p ,lock))
2638      (unwind-protect
2639           (progn
2640             (write-lock-rwlock ,p)
2641             ,@body)
2642        (unlock-rwlock ,p)))))
2643
2644
2645
2646(defmacro without-gcing (&body body)
2647  `(unwind-protect
2648    (progn
2649      (%lock-gc-lock)
2650      ,@body)
2651    (%unlock-gc-lock)))
2652
2653(defmacro with-other-threads-suspended (&body body)
2654  `(unwind-protect
2655    (progn
2656      (%suspend-other-threads)
2657      ,@body)
2658    (%resume-other-threads)))
2659
2660(defmacro with-package-read-lock ((p) &body body)
2661  `(with-read-lock ((pkg.lock ,p)) ,@body))
2662
2663(defmacro with-package-write-lock ((p) &body body)
2664  `(with-write-lock ((pkg.lock ,p)) ,@body))
2665
2666(defmacro with-package-lock ((p) &body body)
2667  `(with-package-write-lock (,p) ,@body))
2668
2669;;; Lock %all-packages-lock%, for shared read access to %all-packages%
2670
2671(defmacro with-package-list-read-lock (&body body)
2672  `(with-read-lock (%all-packages-lock%) ,@body))
2673
2674;;; Lock %all-packages-lock%, to allow modification to %all-packages%
2675(defmacro with-package-list-write-lock (&body body)
2676  `(with-write-lock (%all-packages-lock%) ,@body))
2677
2678(defmacro atomic-incf-decf (place delta &environment env)
2679  (setq place (macroexpand place env))
2680  (if (consp place)
2681    (let* ((sym (car place))
2682           (struct-transform (or (environment-structref-info sym env)
2683                                 (gethash sym %structure-refs%))))
2684      (if struct-transform
2685        (setq place (defstruct-ref-transform struct-transform (cdr place))
2686              sym (car place)))
2687      (ecase sym
2688        (the `(the ,(cadr place) (atomic-incf-decf ,(caddr place) ,delta)))
2689        (car `(%atomic-incf-car ,(cadr place) ,delta))
2690        (cdr `(%atomic-incf-cdr ,(cadr place) ,delta))
2691        ((svref %svref) `(%atomic-incf-gvector ,@(cdr place) ,delta))))
2692    (if (and (symbolp place) (eq :special (variable-information place env)))
2693      (let* ((base (gensym))
2694             (offset (gensym)))
2695        `(multiple-value-bind (,base ,offset)
2696          (%symbol-binding-address ',place)
2697          (%atomic-incf-node ,delta ,base ,offset)))
2698      (error "~S is not a special variable"  place))))
2699   
2700(defmacro atomic-incf (place)
2701  `(atomic-incf-decf ,place 1))
2702
2703(defmacro atomic-decf (place)
2704  `(atomic-incf-decf ,place -1))
2705
2706; Some of these macros were stolen from CMUCL.  Sort of ...
2707
2708(defmacro iterate (name binds &body body)
2709  "Iterate Name ({(Var Initial-Value)}*) Declaration* Form*
2710  This is syntactic sugar for Labels.  It creates a local function Name with
2711  the specified Vars as its arguments and the Declarations and Forms as its
2712  body.  This function is then called with the Initial-Values, and the result
2713  of the call is return from the macro."
2714  (dolist (x binds)
2715    (unless (and (listp x)
2716                 (= (length x) 2))
2717      (error "Malformed iterate variable spec: ~S." x)))
2718
2719  `(labels ((,name ,(mapcar #'first binds) ,@body))
2720     (,name ,@(mapcar #'second binds))))
2721
2722;;;; The Collect macro:
2723
2724;;; Collect-Normal-Expander  --  Internal
2725;;;
2726;;;    This function does the real work of macroexpansion for normal collection
2727;;; macros.  N-Value is the name of the variable which holds the current
2728;;; value.  Fun is the function which does collection.  Forms is the list of
2729;;; forms whose values we are supposed to collect.
2730;;;
2731(eval-when (:compile-toplevel :load-toplevel :execute)
2732
2733
2734(defun collect-normal-expander (n-value fun forms)
2735  `(progn
2736     ,@(mapcar #'(lambda (form) `(setq ,n-value (,fun ,form ,n-value))) forms)
2737     ,n-value))
2738
2739
2740)
2741
2742(defmacro once-only (specs &body body)
2743  "Once-Only ({(Var Value-Expression)}*) Form*
2744  Create a Let* which evaluates each Value-Expression, binding a temporary
2745  variable to the result, and wrapping the Let* around the result of the
2746  evaluation of Body.  Within the body, each Var is bound to the corresponding
2747  temporary variable."
2748  (iterate frob
2749           ((specs specs)
2750            (body body))
2751    (if (null specs)
2752      `(progn ,@body)
2753      (let ((spec (first specs)))
2754        (when (/= (length spec) 2)
2755          (error "Malformed Once-Only binding spec: ~S." spec))
2756        (let ((name (first spec))
2757              (exp-temp (gensym)))
2758          `(let ((,exp-temp ,(second spec))
2759                 (,name (gensym)))
2760             `(let ((,,name ,,exp-temp))
2761                ,,(frob (rest specs) body))))))))
2762
2763(eval-when (:compile-toplevel :load-toplevel :execute)
2764(defun form-symbol (first &rest others)
2765  (intern (apply #'concatenate 'simple-base-string (string first) (mapcar #'string others))))
2766)
2767
2768
2769;;; Collect-List-Expander  --  Internal
2770;;;
2771;;;    This function deals with the list collection case.  N-Tail is the pointer
2772;;; to the current tail of the list, which is NIL if the list is empty.
2773;;;
2774(defun collect-list-expander (n-value n-tail forms)
2775  (let ((n-res (gensym)))
2776    `(progn
2777       ,@(mapcar #'(lambda (form)
2778                     `(let ((,n-res (cons ,form nil)))
2779                        (cond (,n-tail
2780                               (setf (cdr ,n-tail) ,n-res)
2781                               (setq ,n-tail ,n-res))
2782                              (t
2783                               (setq ,n-tail ,n-res  ,n-value ,n-res)))))
2784                 forms)
2785       ,n-value)))
2786
2787;;;
2788;;;    The ultimate collection macro...
2789;;;
2790
2791(defmacro collect (collections &body body)
2792  "Collect ({(Name [Initial-Value] [Function])}*) {Form}*
2793  Collect some values somehow.  Each of the collections specifies a bunch of
2794  things which collected during the evaluation of the body of the form.  The
2795  name of the collection is used to define a local macro, a la MACROLET.
2796  Within the body, this macro will evaluate each of its arguments and collect
2797  the result, returning the current value after the collection is done.  The
2798  body is evaluated as a PROGN; to get the final values when you are done, just
2799  call the collection macro with no arguments.
2800
2801  Initial-Value is the value that the collection starts out with, which
2802  defaults to NIL.  Function is the function which does the collection.  It is
2803  a function which will accept two arguments: the value to be collected and the
2804  current collection.  The result of the function is made the new value for the
2805  collection.  As a totally magical special-case, the Function may be Collect,
2806  which tells us to build a list in forward order; this is the default.  If an
2807  Initial-Value is supplied for Collect, the stuff will be rplacd'd onto the
2808  end.  Note that Function may be anything that can appear in the functional
2809  position, including macros and lambdas."
2810 
2811 
2812  (let ((macros ())
2813        (binds ()))
2814    (dolist (spec collections)
2815      (unless (<= 1 (length spec) 3)
2816        (error "Malformed collection specifier: ~S." spec))
2817      (let ((n-value (gensym))
2818            (name (first spec))
2819            (default (second spec))
2820            (kind (or (third spec) 'collect)))
2821       
2822        (push `(,n-value ,default) binds)
2823        (if (eq kind 'collect)
2824          (let ((n-tail (gensym)))
2825            (if default
2826              (push `(,n-tail (last ,n-value)) binds)
2827              (push n-tail binds))
2828            (push `(,name (&rest args)
2829                          (collect-list-expander ',n-value ',n-tail args))
2830                  macros))
2831          (push `(,name (&rest args)
2832                        (collect-normal-expander ',n-value ',kind args))
2833                macros))))
2834    `(macrolet ,macros (let* ,(nreverse binds) ,@body))))
2835
2836
2837;;; DEFENUM -- Internal Interface.
2838;;;
2839(defmacro defenum ((&key (prefix "") (suffix "") (start 0) (step 1))
2840                   &rest identifiers)
2841  (let ((results nil)
2842        (index 0)
2843        (start (eval start))
2844        (step (eval step)))
2845    (dolist (id identifiers)
2846      (multiple-value-bind
2847        (root docs)
2848        (if (consp id)
2849          (values (car id) (cdr id))
2850          (values id nil))
2851        (push `(defconstant ,(intern (concatenate 'simple-base-string
2852                                                  (string prefix)
2853                                                  (string root)
2854                                                  (string suffix)))
2855                 ,(+ start (* step index))
2856                 ,@docs)
2857              results))
2858      (incf index))
2859    `(eval-when (:compile-toplevel :load-toplevel :execute)
2860       ,@(nreverse results))))
2861
2862
2863;;; This does something like special binding, but the "bindings" established
2864;;; aren't thread-specific.
2865
2866(defmacro let-globally ((&rest vars) &body body &environment env)
2867  (multiple-value-bind (body decls) (parse-body body env)
2868    (let* ((initforms nil)
2869           (psetform nil)
2870           (specvars nil)
2871           (restoreform nil))
2872      (flet ((pair-name-value (p)
2873               (if (atom p)
2874                 (values (require-global-symbol p env) nil)
2875                 (if (and (consp (%cdr p)) (null (%cddr p)))
2876                   (values (require-global-symbol (%car p) env) (%cadr p))
2877                   (error "Invalid variable initialization form : ~s")))))
2878        (declare (inline pair-name-value))
2879        (dolist (v vars)
2880          (let* ((oldval (gensym))
2881                 (newval (gensym)))
2882            (multiple-value-bind (var valueform) (pair-name-value v)
2883              (push var specvars)
2884              (push var restoreform)
2885              (push oldval restoreform)
2886              (push `(,oldval (uvref ',var #.ppc32::symbol.vcell-cell)) initforms)
2887              (push `(,newval ,valueform) initforms)
2888              (push var psetform)
2889              (push newval psetform))))
2890        `(let ,(nreverse initforms)
2891           ,@decls
2892           (locally (declare (special ,@(nreverse specvars)))
2893             (unwind-protect
2894               (progn (psetq ,@(nreverse psetform)) ,@body)
2895               (psetq ,@(nreverse restoreform)))))))))
2896;;; From CLX.
2897
2898;;; The good news is that this uses an interlocked load/store sequence
2899;;; and is fairly efficient.
2900;;; The bad news is that it only handles a few types of "place" forms.
2901;;; The good news is that CLX only uses a few types of "place" forms.
2902
2903(defmacro conditional-store (place old-value new-value &environment env)
2904  (setq place (macroexpand place env))
2905  (if (atom place)
2906    ;; CLX uses special variables' value cells as place forms.
2907    (if (and (symbolp place)
2908             (eq :special (ccl::variable-information place env)))
2909      (let* ((base (gensym))
2910             (offset (gensym)))
2911        `(multiple-value-bind (,base ,offset)
2912          (ccl::%symbol-binding-address ',place)
2913          (ccl::%store-node-conditional ,offset ,base ,old-value ,new-value)))
2914      (error "~s is not a special variable ." place))
2915    (let* ((sym (car place))
2916           (struct-transform (or (ccl::environment-structref-info sym env)
2917                                 (gethash sym ccl::%structure-refs%))))
2918      (if struct-transform
2919        (setq place (ccl::defstruct-ref-transform struct-transform (cdr place))
2920              sym (car place)))
2921      (if (member  sym '(svref ccl::%svref ccl::struct-ref))
2922        (let* ((v (gensym)))
2923          `(let* ((,v ,(cadr place)))
2924            (ccl::store-gvector-conditional ,(caddr place)
2925             ,v ,old-value ,new-value)))
2926        (error "Don't know how to do conditional store to ~s" place)))))
2927
2928(defmacro step (form)
2929  form)
Note: See TracBrowser for help on using the repository browser.