source: trunk/source/lib/macros.lisp @ 14850

Last change on this file since 14850 was 14850, checked in by gb, 8 years ago

If [E|C]TYPECASE warns about a shadowed clause, it has to be a
STYLE-WARNING.

Fixes ticket:872 in the trunk.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 157.1 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2009 Clozure Associates
4;;;   Copyright (C) 1994-2001 Digitool, Inc
5;;;   This file is part of Clozure CL. 
6;;;
7;;;   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
8;;;   License , known as the LLGPL and distributed with Clozure CL as the
9;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
10;;;   which is distributed with Clozure CL as the file "LGPL".  Where these
11;;;   conflict, the preamble takes precedence. 
12;;;
13;;;   Clozure CL is referenced in the preamble as the "LIBRARY."
14;;;
15;;;   The LLGPL is also available online at
16;;;   http://opensource.franz.com/preamble.html
17
18;;; Macros (and functions/constants used at macroexpand-time) ONLY.
19
20(in-package "CCL")
21
22(eval-when (eval compile)
23  (require "LEVEL-2")
24  (require "BACKQUOTE")
25  (require "DEFSTRUCT-MACROS"))
26
27;; Constants
28
29(defmacro defconstant (sym val &optional (doc () doc-p) &environment env)
30  "Define a global constant, saying that the value is constant and may be
31  compiled into code. If the variable already has a value, and this is not
32  EQL to the new value, the code is not portable (undefined behavior). The
33  third argument is an optional documentation string for the variable."
34  (setq sym (require-type sym 'symbol)
35        doc (if doc-p (require-type doc 'string)))
36  `(progn
37     (eval-when (:compile-toplevel)
38       (define-compile-time-constant ',sym ',val ,env))
39     (eval-when (:load-toplevel :execute)
40       (%defconstant ',sym ,val ,@(if doc-p (list doc))))))
41
42;; Lists
43
44(defmacro %car (x)
45  `(car (the list ,x)))
46
47(defmacro set-%car (x y)
48  `(setf (car (the cons ,x)) ,y))
49
50(defmacro %cdr (x)
51  `(cdr (the list ,x)))
52
53(defmacro set-%cdr (x y)
54  `(setf (cdr (the cons ,x)) ,y))
55
56(defmacro %caar (x)
57 `(%car (%car ,x)))
58
59(defmacro %cadr (x)
60 `(%car (%cdr ,x)))
61
62(defmacro %cdar (x)
63 `(%cdr (%car ,x)))
64
65(defmacro %cddr (x)
66 `(%cdr (%cdr ,x)))
67
68(defmacro %caaar (x)
69 `(%car (%car (%car ,x))))
70
71(defmacro %caadr (x)
72 `(%car (%car (%cdr ,x))))
73
74(defmacro %cadar (x)
75 `(%car (%cdr (%car ,x))))
76
77(defmacro %caddr (x)
78 `(%car (%cdr (%cdr ,x))))
79
80(defmacro %cdaar (x)
81 `(%cdr (%car (%car ,x))))
82
83(defmacro %cdadr (x)
84 `(%cdr (%car (%cdr ,x))))
85
86(defmacro %cddar (x)
87 `(%cdr (%cdr (%car ,x))))
88
89(defmacro %cdddr (x)
90 `(%cdr (%cdr (%cdr ,x))))
91
92(defmacro %rplaca (x y)
93  `(rplaca (the cons ,x) ,y))
94
95(defmacro %rplacd (x y)
96  `(rplacd (the cons ,x) ,y))
97
98; These are open-coded by the compiler to isolate platform
99; dependencies.
100
101(defmacro %unbound-marker-8 ()
102  `(%unbound-marker))
103
104(defmacro %slot-missing-marker ()
105  `(%illegal-marker))
106
107
108
109
110(defmacro %null-ptr () '(%int-to-ptr 0))
111
112;;;Assorted useful macro definitions
113
114(defmacro def-accessors (ref &rest names)
115  (define-accessors ref names))
116
117(defmacro def-accessor-macros (ref &rest names)
118  (define-accessors ref names t))
119
120(defun define-accessors (ref names &optional no-constants
121                             &aux (arg (gensym)) (index 0) progn types)
122  (when (listp ref)
123    (setq types ref
124          ref (pop names)))
125  (dolist (name names)
126    (when name
127      (unless (listp name) (setq name (list name)))
128      (dolist (sym name)
129        (when sym
130          (push `(defmacro ,sym (,arg) (list ',ref ,arg ,index)) progn)
131          (unless no-constants
132            (push `(defconstant ,sym ,index) progn)))))
133    (setq index (1+ index)))
134 `(progn
135    ,.(nreverse progn)
136    ,@(if types `((add-accessor-types ',types ',names)))
137    ,index))
138
139(defmacro specialv (var)
140  `(locally (declare (special ,var)) ,var))
141
142
143(defmacro prog1 (valform &rest otherforms)
144 (let ((val (gensym)))
145 `(let ((,val ,valform))
146   ,@otherforms
147   ,val)))
148
149(defmacro prog2 (first second &rest others)
150 `(progn ,first (prog1 ,second ,@others)))
151
152(defmacro prog (inits &body body &environment env)
153  (multiple-value-bind (forms decls) (parse-body body env nil)
154    `(block nil
155       (let ,inits
156         ,@decls
157         (tagbody ,@forms)))))
158
159(defmacro prog* (inits &body body &environment env)
160  (multiple-value-bind (forms decls) (parse-body body env nil)
161    `(block nil
162       (let* ,inits
163         ,@decls
164         (tagbody ,@forms)))))
165
166
167(defmacro %stack-block ((&rest specs) &body forms &aux vars lets)
168  (dolist (spec specs)
169    (destructuring-bind (var ptr &key clear) spec
170      (push var vars)
171      (push `(,var (%new-ptr ,ptr ,clear)) lets)))
172  `(let* ,(nreverse lets)
173     (declare (dynamic-extent ,@vars))
174     (declare (type macptr ,@vars))
175     (declare (unsettable ,@vars))
176     ,@forms))
177
178(defmacro %vstack-block (spec &body forms)
179  `(%stack-block (,spec) ,@forms))
180
181(eval-when (:compile-toplevel :load-toplevel :execute)
182(defun extract-bound-decls-for-dolist-var (var decls env)
183  (if (null decls)
184    (values nil nil)
185      (collect ((var-decls)
186                (other-decls))
187        (dolist (declform decls
188                 (let* ((vdecls (var-decls))
189                        (others (other-decls)))
190                   (values (if vdecls `((declare ,@vdecls)))
191                           (if others `((declare ,@others))))))
192          ;; (assert (eq (car declform) 'declare))
193          (dolist (decl (cdr declform))
194            (if (atom decl)
195              (other-decls decl)
196              (let* ((spec (car decl)))
197                (if (specifier-type-if-known spec env)
198                  (setq spec 'type
199                        decl `(type ,@decl)))
200                (case spec
201                  (type
202                   (destructuring-bind (typespec &rest vars) (cdr decl)
203                     (cond ((member var vars :test #'eq)
204                            (setq vars (delete var vars))
205                            (var-decls `(type ,typespec ,var))
206                            (when vars
207                              (other-decls `(type ,typespec ,@vars))))
208                           (t (other-decls decl)))))
209                   ((special ingore ignorable ccl::ignore-if-unused)
210                    (let* ((vars (cdr decl)))
211                      (cond ((member var vars :test #'eq)
212                             (setq vars (delete var vars))
213                             (var-decls `(,spec ,var))
214                             (when vars
215                               (other-decls `(,spec ,@vars))))
216                            (t (other-decls decl)))))
217                   (t (other-decls decl))))))))))
218)
219
220
221
222(defmacro dolist ((varsym list &optional ret) &body body &environment env)
223  (if (not (symbolp varsym)) (signal-program-error $XNotSym varsym))
224    (multiple-value-bind (forms decls) (parse-body body env nil)
225      (multiple-value-bind (var-decls other-decls)
226          (extract-bound-decls-for-dolist-var varsym decls env)
227        (let* ((lstsym (gensym)))
228        `(do* ((,lstsym ,list (cdr (the list ,lstsym))))
229              ((null ,lstsym)
230               ,@(if ret `((let* ((,varsym ()))
231                             (declare (ignorable ,varsym))
232                             ,ret))))
233          ,@other-decls
234          (let* ((,varsym (car ,lstsym)))
235            ,@var-decls
236            (tagbody ,@forms)))))))
237
238(defmacro dovector ((varsym vector &optional ret) &body body &environment env)
239  (if (not (symbolp varsym))(signal-program-error $XNotSym varsym))
240  (let* ((toplab (gensym))
241         (tstlab (gensym))
242         (lengthsym (gensym))
243         (indexsym (gensym))
244         (vecsym (gensym)))
245    (multiple-value-bind (forms decls) (parse-body body env nil)
246     `(let* ((,vecsym ,vector)
247             (,lengthsym (length ,vecsym))
248             (,indexsym 0)
249             ,varsym)
250        ,@decls
251        ,@(let ((type (nx-form-type vector env)))
252            (unless (eq type t)
253              `((declare (type ,type ,vecsym)))))
254        (block nil
255          (tagbody
256            (go ,tstlab)
257            ,toplab
258            (setq ,varsym (locally (declare (optimize (speed 3) (safety 0)))
259                            (aref ,vecsym ,indexsym))
260                  ,indexsym (%i+ ,indexsym 1))
261            ,@forms
262            ,tstlab
263            (if (%i< ,indexsym ,lengthsym) (go ,toplab)))
264          ,@(if ret `((progn (setq ,varsym nil) ,ret))))))))
265
266(defmacro report-bad-arg (&whole w thing typespec &environment env)
267  (when (quoted-form-p typespec)
268    (unless (ignore-errors (specifier-type-if-known (cadr typespec) env))
269      (warn "Unknown type specifier ~s in ~s." (cadr typespec) w)))
270  `(values (%badarg ,thing ,typespec)))
271
272(defmacro %cons-restart (name action report interactive test)
273 `(%istruct 'restart ,name ,action ,report ,interactive ,test))
274
275(defmacro restart-bind (clauses &body body)
276  "Executes forms in a dynamic context where the given restart bindings are
277   in effect. Users probably want to use RESTART-CASE. When clauses contain
278   the same restart name, FIND-RESTART will find the first such clause."
279  (let* ((restarts (mapcar #'(lambda (clause) 
280                               (list (make-symbol (symbol-name (require-type (car clause) 'symbol)))
281                                     `(%cons-restart nil nil nil nil nil)))
282                           clauses))
283         (bindings (mapcar #'(lambda (clause name)
284                              `(make-restart ,(car name) ',(car clause)
285                                             ,@(cdr clause)))
286                           clauses restarts))
287        (cluster (gensym)))
288    `(let* (,@restarts)
289       (declare (dynamic-extent ,@(mapcar #'car restarts)))
290       (let* ((,cluster (list ,@bindings))
291              (%restarts% (cons ,cluster %restarts%)))
292         (declare (dynamic-extent ,cluster %restarts%))
293         (progn
294           ,@body)))))
295
296(defmacro handler-bind (clauses &body body)
297  "(HANDLER-BIND ( {(type handler)}* )  body)
298   Executes body in a dynamic context where the given handler bindings are
299   in effect. Each handler must take the condition being signalled as an
300   argument. The bindings are searched first to last in the event of a
301   signalled condition."
302  (let* ((fns)
303         (decls)         
304         (bindings (mapcan #'(lambda (clause)
305                               (destructuring-bind (condition handler) clause
306                                 (if (and (consp handler)(eq (car handler) 'function)
307                                          (consp (cadr handler))(eq (car (cadr handler)) 'lambda))
308                                   (let ((fn (gensym)))
309                                     (push `(,fn ,handler) fns)
310                                     (push `(declare (dynamic-extent ,fn)) decls)
311                                     `(',condition ,fn))
312                                   (list `',condition
313                                         `,handler))))
314                           clauses))
315        (cluster (gensym)))   
316    (if (null bindings)
317      `(progn ,@body)
318      `(let* (,@fns
319              (,cluster (list ,@bindings))
320              (%handlers% (cons ,cluster %handlers%)))
321         (declare (dynamic-extent ,cluster %handlers%))
322         ,@decls
323         ,@body))))
324
325(defmacro restart-case (&environment env form &rest clauses)
326  "(RESTART-CASE form
327   {(case-name arg-list {keyword value}* body)}*)
328   The form is evaluated in a dynamic context where the clauses have special
329   meanings as points to which control may be transferred (see INVOKE-RESTART).
330   When clauses contain the same case-name, FIND-RESTART will find the first
331   such clause. If Expression is a call to SIGNAL, ERROR, CERROR or WARN (or
332   macroexpands into such) then the signalled condition will be associated with
333   the new restarts."
334  (let ((cluster nil))
335    (when clauses (setq cluster (gensym) form (restart-case-form form env cluster)))
336    (flet ((restart-case-1 (name arglist &rest forms)
337             (let (interactive report test)
338               (loop
339                 (case (car forms)
340                   (:interactive (setq interactive (cadr forms)))
341                   (:report (setq report (cadr forms)))
342                   (:test (setq test (cadr forms)))
343                   (t (return nil)))
344                 (setq forms (cddr forms)))
345               (when (and report (not (stringp report)))
346                 (setq report `#',report))
347               (when interactive
348                 (setq interactive `#',interactive))
349               (when test
350                 (setq test `#',test))
351               (values (require-type name 'symbol) arglist report interactive test forms))))
352      (cond ((null clauses) form)
353            ((and (null (cdr clauses)) (null (cadr (car clauses))))
354             (let ((block (gensym)) 
355                   (restart-name (gensym)))
356               (multiple-value-bind (name arglist report interactive test body)
357                                    (apply #'restart-case-1 (car clauses))
358                 (declare (ignore arglist))
359                 `(block ,block
360                    (let* ((,restart-name (%cons-restart ',name () ,report ,interactive ,test))
361                           (,cluster (list ,restart-name)))
362                      (declare (dynamic-extent ,restart-name ,cluster))
363                      (catch ,cluster
364                        (let ((%restarts% (cons ,cluster %restarts%)))
365                          (declare (dynamic-extent %restarts%))
366                          (return-from ,block ,form))))
367                    ,@body))))
368            (t
369             (let ((block (gensym)) (val (gensym))
370                   (index -1) restarts restart-names restart-name cases)
371               (while clauses
372                 (setq index (1+ index))
373                 (multiple-value-bind (name arglist report interactive test body)
374                                      (apply #'restart-case-1 (pop clauses))
375                   (push (setq restart-name (make-symbol (symbol-name name))) restart-names)
376                   (push (list restart-name `(%cons-restart ',name ,index ,report ,interactive ,test))
377                         restarts)
378                   (when (null clauses) (setq index t))
379                   (push `(,index (apply #'(lambda ,arglist ,@body) ,val))
380                         cases)))
381               `(block ,block
382                  (let ((,val (let* (,@restarts
383                                     (,cluster (list ,@(reverse restart-names))))
384                                (declare (dynamic-extent ,@restart-names ,cluster))
385                                (catch ,cluster
386                                  (let ((%restarts% (cons ,cluster %restarts%)))
387                                    (declare (dynamic-extent %restarts%))
388                                    (return-from ,block ,form))))))
389                    (case (pop ,val)
390                      ,@(nreverse cases))))))))))
391
392
393; Anything this hairy should die a slow and painful death.
394; Unless, of course, I grossly misunderstand...
395(defun restart-case-form (form env clustername)
396  (let ((expansion (macroexpand form env))
397        (head nil))
398    (if (and (listp expansion)          ; already an ugly hack, made uglier by %error case ...
399             (memq (setq head (pop expansion)) '(signal error cerror warn %error)))
400      (let ((condform nil)
401            (signalform nil)
402            (cname (gensym)))
403        (case head
404          (cerror
405           (destructuring-bind 
406             (continue cond &rest args) expansion
407             (setq condform `(condition-arg ,cond (list ,@args) 'simple-error)
408                   signalform `(cerror ,continue ,cname))))
409          ((signal error warn)
410           (destructuring-bind
411             (cond &rest args) expansion
412             (setq condform `(condition-arg ,cond (list ,@args) ,(if (eq head 'warning)
413                                                                   ''simple-warning
414                                                                   (if (eq head 'error)
415                                                                     ''simple-error
416                                                                     ''simple-condition)))
417                   signalform `(,head ,cname))))
418          (t ;%error
419           (destructuring-bind (cond args fp) expansion
420             (setq condform `(condition-arg ,cond ,args 'simple-error)
421                   signalform `(%error ,cname nil ,fp)))))
422        `(let ((,cname ,condform))
423           (with-condition-restarts ,cname ,clustername
424             ,signalform)))
425      form)))
426     
427
428(defmacro handler-case (form &rest clauses)
429  "(HANDLER-CASE form
430   { (type ([var]) body) }* )
431   Execute FORM in a context with handlers established for the condition
432   types. A peculiar property allows type to be :NO-ERROR. If such a clause
433   occurs, and form returns normally, all its values are passed to this clause
434   as if by MULTIPLE-VALUE-CALL.  The :NO-ERROR clause accepts more than one
435   var specification."
436  (let* ((no-error-clause (assoc :no-error clauses)))
437    (if no-error-clause
438      (let* ((normal-return (gensym))
439             (error-return (gensym)))
440        `(block ,error-return
441          (multiple-value-call #'(lambda ,@(cdr no-error-clause))
442            (block ,normal-return
443              (return-from ,error-return
444                (handler-case (return-from ,normal-return ,form)
445                  ,@(remove no-error-clause clauses)))))))
446      (flet ((handler-case (type var &rest body)
447               (when (eq type :no-error)
448                 (signal-program-error "Duplicate :no-error clause. "))
449           (values type var body)))
450        (cond ((null clauses) form)
451          ((null (cdr clauses))
452           (let ((block   (gensym))
453                 (cluster (gensym)))
454             (multiple-value-bind (type var body)
455                                  (apply #'handler-case (car clauses))
456               (if var
457                 `(block ,block
458                    ((lambda ,var ,@body)
459                      (let* ((,cluster (list ',type)))
460                        (declare (dynamic-extent ,cluster))
461                        (catch ,cluster
462                          (let ((%handlers% (cons ,cluster %handlers%)))
463                            (declare (dynamic-extent %handlers%))
464                            (return-from ,block ,form))))))
465                 `(block ,block
466                    (let* ((,cluster (list ',type)))
467                      (declare (dynamic-extent ,cluster))
468                      (catch ,cluster
469                        (let ((%handlers% (cons ,cluster %handlers%)))
470                          (declare (dynamic-extent %handlers%))
471                          (return-from ,block ,form)))
472                      (locally ,@body)))))))
473          (t (let ((block (gensym)) (cluster (gensym)) (val (gensym))
474                   (index -1) handlers cases)
475               (while clauses
476                 (setq index (1+ index))
477                 (multiple-value-bind (type var body)
478                                      (apply #'handler-case (pop clauses))                   
479                   (push `',type handlers)
480                   (push index handlers)
481                   (when (null clauses) (setq index t))
482                   (push (if var
483                           `(,index ((lambda ,var ,@body) ,val))
484                           `(,index (locally ,@body))) cases)))
485               `(block ,block
486                  (let ((,val (let* ((,cluster (list ,@(nreverse handlers))))
487                                (declare (dynamic-extent ,cluster))
488                                (catch ,cluster
489                                  (let ((%handlers% (cons ,cluster %handlers%)))
490                                    (declare (dynamic-extent %handlers%))
491                                    (return-from ,block ,form))))))
492                    (case (pop ,val)
493                      ,@(nreverse cases)))))))))))
494
495(defmacro with-simple-restart ((restart-name format-string &rest format-args)
496                               &body body
497                               &aux (cluster (gensym)) (temp (make-symbol (symbol-name restart-name))))
498  "(WITH-SIMPLE-RESTART (restart-name format-string format-arguments)
499   body)
500   If restart-name is not invoked, then all values returned by forms are
501   returned. If control is transferred to this restart, it immediately
502   returns the values NIL and T."
503  (unless (and (stringp format-string)
504               (null format-args)
505               (not (%str-member #\~ (ensure-simple-string format-string))))
506    (let ((stream (gensym)))
507      (setq format-string `#'(lambda (,stream) (format ,stream ,format-string ,@format-args)))))
508  `(let* ((,temp (%cons-restart ',restart-name
509                                'simple-restart
510                                ,format-string
511                                nil
512                                nil))
513          (,cluster (list ,temp)))
514     (declare (dynamic-extent ,temp ,cluster))
515     (catch ,cluster
516       (let ((%restarts% (cons ,cluster %restarts%)))
517         (declare (dynamic-extent %restarts%))
518         ,@body))))
519
520;Like with-simple-restart but takes a pre-consed restart.  Not CL.
521(defmacro with-restart (restart &body body &aux (cluster (gensym)))
522  `(let* ((,cluster (list ,restart)))
523     (declare (dynamic-extent ,cluster))
524     (catch ,cluster
525       (let ((%restarts% (cons ,cluster %restarts%)))
526         (declare (dynamic-extent %restarts%))
527         ,@body))))
528
529(defmacro ignore-errors (&rest forms)
530  "Execute FORMS handling ERROR conditions, returning the result of the last
531  form, or (VALUES NIL the-ERROR-that-was-caught) if an ERROR was handled."
532  `(handler-case (progn ,@forms)
533     (error (condition) (values nil condition))))
534
535(defmacro def-kernel-restart (&environment env errno name arglist &body body)
536  (multiple-value-bind (body decls)
537                       (parse-body body env)
538    `(let* ((fn (nfunction ,name (lambda ,arglist ,@decls (block ,name ,@body))))
539            (pair (assq ,errno ccl::*kernel-restarts*)))
540       (if pair
541         (rplacd pair fn)
542         (push (cons ,errno fn) ccl::*kernel-restarts*))
543       fn)))
544
545
546;;; Setf.
547
548;  If you change anything here, be sure to make the corresponding change
549;  in get-setf-method.
550(defmacro setf (&rest args &environment env)
551  "Takes pairs of arguments like SETQ. The first is a place and the second
552  is the value that is supposed to go into that place. Returns the last
553  value. The place argument may be any of the access forms for which SETF
554  knows a corresponding setting form."
555  (let ((temp (length args))
556        (accessor nil))
557    (cond ((eq temp 2)
558           (let* ((form (car args)) 
559                  (value (cadr args)))
560             ;This must match get-setf-method .
561             (cond ((atom form)
562                    (progn
563                      (unless (symbolp form)(signal-program-error $XNotSym form))
564                      `(setq ,form ,value)))
565                   ((eq (car form) 'the)
566                    (unless (eql (length form) 3)
567                      (error "Bad THE place form in (SETF ~S ~S)" form value))
568                    (destructuring-bind (type place) (cdr form)
569                      `(setf ,place (the ,type ,value))))
570                   (t
571                    (multiple-value-bind (ftype local-p)
572                        (function-information (setq accessor (car form)) ENV)
573                      (if local-p
574                        (if (eq ftype :function)
575                                        ;Local function, so don't use global setf definitions.
576                          (default-setf form value env)
577                          `(setf ,(macroexpand-1 form env) ,value))
578                        (cond
579                          ((setq temp (%setf-method accessor))
580                           (if (symbolp temp)
581                             `(,temp ,@(cdar args) ,value)
582                             (multiple-value-bind (dummies vals storevars setter #|getter|#)
583                                 (funcall temp form env)
584                               (do* ((d dummies (cdr d))
585                                     (v vals (cdr v))
586                                     (let-list nil))
587                                    ((null d)
588                                     (setq let-list (nreverse let-list))
589                                     `(let* ,let-list
590                                       (declare (ignorable ,@dummies))
591                                       (multiple-value-bind ,storevars ,value
592                                         #|,getter|#
593                                         ,setter)))
594                                 (push (list (car d) (car v)) let-list)))))
595                          ((and (setq temp (structref-info accessor env))
596                                (accessor-structref-info-p temp)
597                                (not (refinfo-r/o (structref-info-refinfo temp))))
598                           (let ((form (defstruct-ref-transform temp (%cdar args) env t))
599                                 (type (defstruct-type-for-typecheck (structref-info-type temp) env)))
600                             (if (eq type t)
601                               `(setf ,form ,value)
602                               ;; strip off type, but add in a typecheck
603                               `(the ,type (setf ,form (typecheck ,value ,type))))))
604                          (t
605                           (multiple-value-bind (res win)
606                               (macroexpand-1 form env)
607                             (if win
608                               `(setf ,res ,value)
609                               (default-setf form value env)))))))))))
610          ((oddp temp)
611           (signal-program-error "Odd number of args to SETF : ~s." args))
612          (t (do* ((a args (cddr a)) (l nil))
613                  ((null a) `(progn ,@(nreverse l)))
614               (push `(setf ,(car a) ,(cadr a)) l))))))
615
616
617(defun default-setf (setter value &optional env)
618  (let* ((reader (car setter))
619         (args (cdr setter))
620         (gensyms (mapcar #'(lambda (sym) (declare (ignore sym)) (gensym)) args))
621         types declares)
622    (flet ((form-type (form)
623             (nx-form-type form env)))
624      (declare (dynamic-extent #'form-type))
625      (setq types (mapcar #'form-type args)))
626    (dolist (sym gensyms)
627      (let ((sym-type (pop types)))
628        (unless (eq sym-type t)
629          (push `(type ,sym-type ,sym) declares))))
630    `(let ,(mapcar #'list gensyms args)
631       ,@(and declares (list `(declare ,@(nreverse declares))))
632       (funcall #'(setf ,reader) ,value ,@gensyms))))
633
634;; Establishing these setf-inverses is something that should
635;; happen at compile-time
636(defsetf elt set-elt)
637(defsetf car set-car)
638(defsetf %car set-%car)
639(defsetf first set-car)
640(defsetf cdr set-cdr)
641(defsetf %cdr set-%cdr)
642(defsetf rest set-cdr)
643(defsetf uvref uvset)
644(defsetf aref aset)
645(defsetf svref svset)
646(defsetf %svref %svset)
647(defsetf char set-char)
648(defsetf schar set-schar)
649(defsetf %scharcode %set-scharcode)
650(defsetf symbol-value set)
651(defsetf symbol-plist set-symbol-plist)
652(defsetf fill-pointer set-fill-pointer)
653
654; This sux; it calls the compiler twice (once to shove the macro in the
655; environment, once to dump it into the file.)
656(defmacro defmacro  (name arglist &body body &environment env)
657  (unless (symbolp name)(signal-program-error $XNotSym name))
658  (unless (listp arglist) (signal-program-error "~S is not a list." arglist))
659  (multiple-value-bind (lambda-form doc)
660                       (parse-macro-1 name arglist body env)
661    (let* ((normalized (normalize-lambda-list arglist t t))
662           (body-pos (position '&body normalized))
663           (argstring (let ((temp nil))
664                        (dolist (arg normalized)
665                          (if (eq arg '&aux)
666                            (return)
667                            (push arg temp)))
668                        (format nil "~:a" (nreverse temp)))))
669      (if (and body-pos (memq '&optional normalized)) (decf body-pos))
670      `(progn
671         (eval-when (:compile-toplevel)
672           (define-compile-time-macro ',name ',lambda-form ',env))
673         (eval-when (:load-toplevel :execute)
674           (%macro 
675            (nfunction ,name ,lambda-form)
676            '(,doc ,body-pos . ,argstring))
677           ',name)))))
678
679(defmacro define-symbol-macro (name expansion &environment env)
680  (unless (symbolp name)(signal-program-error $XNotSym name))
681  `(progn
682    (eval-when (:compile-toplevel)
683      (define-compile-time-symbol-macro ',name ',expansion ',env))
684    (eval-when (:load-toplevel :execute)
685      (%define-symbol-macro ',name ',expansion))))
686
687;; ---- allow inlining setf functions
688(defmacro defun (spec args &body body &environment env &aux global-name inline-spec)
689  "Define a function at top level."
690  (validate-function-name spec)
691  (setq args (require-type args 'list))
692  (setq body (require-type body 'list))
693  (multiple-value-bind (forms decls doc) (parse-body body env t)
694    (cond ((symbolp spec)
695           (setq global-name spec)
696           (setq inline-spec spec)
697           (setq body `(block ,spec ,@forms)))
698          ((setf-function-name-p spec)
699           (setq inline-spec spec)
700           (setq body `(block ,(cadr spec) ,@forms)))
701          (t (setq body `(progn ,@forms))))
702    (let* ((lambda-expression `(lambda ,args 
703                                ,@(if global-name
704                                    `((declare (global-function-name ,global-name))))
705                                ,@decls ,body))
706           (info (if (and inline-spec
707                          (or (null env)
708                              (definition-environment env t))
709                          (nx-declared-inline-p inline-spec env)
710                          (not (and (symbolp inline-spec)
711                                    (gethash inline-spec *NX1-ALPHATIZERS*))))
712                   (cons doc lambda-expression)
713                   doc)))
714      `(progn
715         (%defun (nfunction ,spec ,lambda-expression) ',info)
716         ',spec))))
717
718(defmacro %defvar-init (var initform doc)
719  `(unless (%defvar ',var ,doc)
720    (set ',var ,initform)))
721
722(defmacro defvar (&environment env var &optional (value () value-p) doc)
723  "Define a global variable at top level. Declare the variable
724  SPECIAL and, optionally, initialize it. If the variable already has a
725  value, the old value is not clobbered. The third argument is an optional
726  documentation string for the variable."
727  (if (and doc (not (stringp doc))) (report-bad-arg doc 'string))
728  (if (and (compile-file-environment-p env) (not *fasl-save-doc-strings*))
729    (setq doc nil))
730 `(progn
731    (eval-when (:compile-toplevel)
732      (note-variable-info ',var ,value-p ,env))
733    ,(if value-p
734       `(%defvar-init ,var ,value ,doc)
735       `(%defvar ',var))
736    ',var))
737         
738(defmacro def-standard-initial-binding (name &optional (form name) (doc nil doc-p) &environment env)
739  `(progn
740    (eval-when (:compile-toplevel)
741      (note-variable-info ',name t ,env))   
742    (define-standard-initial-binding ',name #'(lambda () ,form))
743    ,@(when doc-p
744           `((set-documentation ',name 'variable ,doc)))
745    ',name))
746
747(defmacro defparameter (&environment env var value &optional doc)
748  "Define a parameter that is not normally changed by the program,
749  but that may be changed without causing an error. Declare the
750  variable special and sets its value to VAL, overwriting any
751  previous value. The third argument is an optional documentation
752  string for the parameter."
753  (if (and doc (not (stringp doc))) (signal-program-error "~S is not a string." doc))
754  (if (and (compile-file-environment-p env) (not *fasl-save-doc-strings*))
755    (setq doc nil))
756  `(progn
757     (eval-when (:compile-toplevel)
758       (note-variable-info ',var t ,env))
759     (%defparameter ',var ,value ,doc)))
760
761
762(defmacro defstatic (&environment env var value &optional doc)
763  "Syntax is like DEFPARAMETER.  Proclaims the symbol to be special,
764but also asserts that it will never be given a per-thread dynamic
765binding.  The value of the variable can be changed (via SETQ, etc.),
766but since all threads access the same static binding of the variable,
767such changes should be made with care."
768  (if (and doc (not (stringp doc))) (signal-program-error "~S is not a string." doc))
769  (if (and (compile-file-environment-p env) (not *fasl-save-doc-strings*))
770    (setq doc nil))
771  `(progn
772     (eval-when (:compile-toplevel)
773       (note-variable-info ',var :global ,env))
774     (%defglobal ',var ,value ,doc)))
775
776(defmacro defstaticvar (&environment env var value &optional doc)
777  "Syntax is like DEFVAR.  Proclaims the symbol to be special,
778but also asserts that it will never be given a per-thread dynamic
779binding.  The value of the variable can be changed (via SETQ, etc.),
780but since all threads access the same static binding of the variable,
781such changes should be made with care.  Like DEFVAR, the initial value
782form is not evaluated if the variable is already BOUNDP."
783  (if (and doc (not (stringp doc))) (signal-program-error "~S is not a string." doc))
784  (if (and (compile-file-environment-p env) (not *fasl-save-doc-strings*))
785    (setq doc nil))
786  `(progn
787     (eval-when (:compile-toplevel)
788       (note-variable-info ',var :global ,env))
789      (%symbol-bits ',var (logior (ash 1 $sym_vbit_global) (the fixnum (%symbol-bits ',var))))
790     (%defvar-init ,var ,value ,doc)))
791
792
793(defmacro defglobal (&rest args)
794  "Synonym for DEFSTATIC."
795  `(defstatic ,@args))
796
797
798(defmacro defloadvar (var value &optional doc)
799  `(progn
800     (defstaticvar ,var ,nil ,@(if doc `(,doc)))
801     (def-ccl-pointers ,var ()
802       (setq ,var ,value))
803     ',var))
804
805
806
807
808(defmacro qlfun (name args &body body)
809  `(nfunction ,name (lambda ,args ,@body)))
810
811(defmacro lfun-bits-known-function (f)
812  (let* ((temp (gensym)))
813    `(let* ((,temp (function-to-function-vector ,f)))
814      (%svref ,temp (the fixnum (1- (the fixnum (uvsize ,temp))))))))
815
816(defmacro lfunloop (for var in function &body loop-body)
817  "Loop over immediates in function"
818  (assert (and (or (equal (symbol-name for) "FOR") (equal (symbol-name for) "AS"))
819               (equal (symbol-name in) "IN")))
820  (let ((fn (gensym))
821        (lfv (gensym))
822        (i (gensym)))
823    `(loop with ,fn = ,function
824           with ,lfv = (function-to-function-vector ,fn)
825           for ,i from #+ppc-target 1 #+x86-target (%function-code-words ,fn) #+arm-target 2  below (%i- (uvsize  ,lfv) 1)
826           as ,var = (%svref ,lfv ,i)
827           ,@loop-body)))
828
829(defmacro cond (&rest args &aux clause)
830  (when args
831     (setq clause (car args))
832     (if (cdr clause)         
833         `(if ,(car clause) (progn ,@(cdr clause)) (cond ,@(cdr args)))
834       (if (cdr args) `(or ,(car clause) (cond ,@(cdr args)))
835                      `(values ,(car clause))))))
836
837(defmacro and (&rest args)
838  "And Form*
839AND evaluates each form in sequence, from left to right.  If any form
840returns NIL, AND returns NIL; otherwise, AND returns the values(s) returned
841by the last form.  If there are no forms, AND returns T."
842  (if (null args) t
843    (if (null (cdr args)) (car args)
844      `(if ,(car args) (and ,@(cdr args))))))
845
846(defmacro or (&rest args)
847  "Or Form*
848OR evaluates each Form, in sequence, from left to right.
849If any Form but the last returns a non-NIL value, OR returns that
850single value (without evaluating any subsequent Forms.)  If OR evaluates
851the last Form, it returns all values returned by that Form.  If there
852are no Forms, OR returns NIL."
853  (if args
854    (if (cdr args)
855      (do* ((temp (gensym))
856            (handle (list nil))
857            (forms `(let ((,temp ,(pop args)))
858                     (if ,temp ,temp ,@handle))))
859           ((null (cdr args))
860            (%rplaca handle (%car args))
861            forms)
862        (%rplaca handle `(if (setq ,temp ,(%car args)) 
863                          ,temp 
864                          ,@(setq handle (list nil))))
865        (setq args (%cdr args)))
866      (%car args))))
867
868(defmacro case (key &body forms)
869  "CASE Keyform {({(Key*) | Key} Form*)}*
870  Evaluates the Forms in the first clause with a Key EQL to the value of
871  Keyform. If a singleton key is T then the clause is a default clause."
872   (let ((key-var (gensym)))
873     `(let ((,key-var ,key))
874        (declare (ignorable ,key-var))
875        (cond ,@(case-aux forms key-var nil nil)))))
876
877(defmacro ccase (keyplace &body forms)
878  "CCASE Keyform {({(Key*) | Key} Form*)}*
879  Evaluates the Forms in the first clause with a Key EQL to the value of
880  Keyform. If none of the keys matches then a correctable error is
881  signalled."
882  (let* ((key-var (gensym))
883         (tag (gensym)))
884    `(prog (,key-var)
885       ,tag
886       (setq ,key-var ,keyplace)
887       (return (cond ,@(case-aux forms key-var tag keyplace))))))
888
889(defmacro ecase (key &body forms)
890  "ECASE Keyform {({(Key*) | Key} Form*)}*
891  Evaluates the Forms in the first clause with a Key EQL to the value of
892  Keyform. If none of the keys matches then an error is signalled."
893  (let* ((key-var (gensym)))
894    `(let ((,key-var ,key))
895       (declare (ignorable ,key-var))
896       (cond ,@(case-aux forms key-var 'ecase nil)))))
897       
898(defun case-aux (clauses key-var e-c-p placename &optional (used-keys (list (list '%case-core))))
899  (if clauses
900    (let* ((key-list (caar clauses))
901           (stype (if e-c-p (if (eq e-c-p 'ecase) e-c-p 'ccase) 'case))
902           (test (cond ((and (not e-c-p)
903                             (or (eq key-list 't)
904                                 (eq key-list 'otherwise)))
905                        t)
906                       (key-list
907                        (cons 'or
908                              (case-key-testers key-var used-keys key-list stype)))))
909           (consequent-list (or (%cdar clauses) '(nil))))
910      (if (eq test t)
911        (progn
912          (when (%cdr clauses) (warn "~s or ~s clause in the middle of a ~s statement.  Subsequent clauses ignored."
913                                     't 'otherwise 'case))
914          (cons (cons t consequent-list) nil))
915        (cons (cons test consequent-list)
916              (case-aux (%cdr clauses) key-var e-c-p placename used-keys))))
917    (when e-c-p
918      (setq used-keys `(member ,@(mapcar #'car (cdr used-keys))))
919      (if (eq e-c-p 'ecase)
920        `((t (values (%err-disp #.$XWRONGTYPE ,key-var ',used-keys))))
921        `((t (setf ,placename (ensure-value-of-type ,key-var ',used-keys ',placename))
922           (go ,e-c-p)))))))
923
924
925;;; We don't want to descend list structure more than once (like this has
926;;; been doing for the last 18 years or so.)
927(defun case-key-testers (symbol used-keys atom-or-list statement-type &optional recursive)
928  (if (or recursive (atom atom-or-list))
929    (progn
930      (if (assoc atom-or-list used-keys)
931        (warn "Duplicate keyform ~s in ~s statement." atom-or-list statement-type)
932        (setq used-keys (nconc used-keys (list (cons atom-or-list t)))))
933      `((,(if (typep atom-or-list '(and number (not fixnum)))
934              'eql
935              'eq)
936         ,symbol ',atom-or-list)))
937    (nconc (case-key-testers symbol used-keys (car atom-or-list) statement-type t)
938           (when (cdr atom-or-list)
939             (case-key-testers symbol used-keys (%cdr atom-or-list) statement-type nil)))))
940
941
942; generate the COND body of a {C,E}TYPECASE form
943(defun typecase-aux (key-var clauses &optional e-c-p keyform)
944  (let* ((construct (if e-c-p (if (eq e-c-p 'etypecase) e-c-p 'ctypecase) 'typecase))
945         (types ())
946         (body ())
947         otherwise-seen-p)
948    (flet ((bad-clause (c) 
949             (signal-program-error "Invalid clause ~S in ~S form." c construct)))
950      (dolist (clause clauses)
951        (if (atom clause)
952            (bad-clause clause))
953        (if otherwise-seen-p
954            (signal-program-error "OTHERWISE must be final clause in ~S form." construct))
955        (destructuring-bind (typespec &body consequents) clause
956          (when (eq construct 'typecase)
957            (if (eq typespec 'otherwise)
958                (progn (setq typespec t)
959                       (setq otherwise-seen-p t))))
960          (unless
961              (dolist (already types nil)
962                (when (subtypep typespec already)
963                  (warn 'shadowed-typecase-clause
964                        :construct construct
965                        :clause clause
966                        :by (assq already clauses))
967                  (return t)))
968            (push typespec types)
969            (setq typespec `(typep ,key-var ',typespec))
970            (push `(,typespec nil ,@consequents) body))))
971      (when e-c-p
972        (setq types `(or ,@(nreverse types)))
973        (if (eq construct 'etypecase)
974            (push `(t (values (%err-disp #.$XWRONGTYPE ,key-var ',types))) body)
975            (push `(t (setf ,keyform (ensure-value-of-type  ,key-var ',types ',keyform))
976                      (go ,e-c-p)) body))))
977    `(cond ,@(nreverse body))))
978
979(defmacro typecase (keyform &body clauses)
980  "TYPECASE Keyform {(Type Form*)}*
981  Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
982  is true."
983  (let ((key-var (gensym)))
984    `(let ((,key-var ,keyform))
985       (declare (ignorable ,key-var))
986       ,(typecase-aux key-var clauses))))
987
988(defmacro etypecase (keyform &body clauses)
989  "ETYPECASE Keyform {(Type Form*)}*
990  Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
991  is true. If no form is satisfied then an error is signalled."
992  (let ((key-var (gensym)))
993    `(let ((,key-var ,keyform))
994       (declare (ignorable ,key-var))
995       ,(typecase-aux key-var clauses 'etypecase))))
996
997(defmacro ctypecase (keyplace &body clauses)
998  "CTYPECASE Key {(Type Form*)}*
999  Evaluates the Forms in the first clause for which TYPEP of Keyform and Type
1000  is true. If no form is satisfied then a correctable error is signalled."
1001  (let ((key-var (gensym))
1002        (tag (gensym)))
1003    `(prog (,key-var)
1004       ,tag
1005       (setq ,key-var ,keyplace)
1006       (return ,(typecase-aux key-var clauses tag keyplace)))))
1007
1008(defmacro destructuring-bind (lambda-list expression &body body)
1009  "Bind the variables in LAMBDA-LIST to the contents of ARG-LIST."
1010  (multiple-value-bind (bindings decls)
1011      (%destructure-lambda-list  lambda-list expression nil nil)
1012    `(let* ,(nreverse bindings)
1013      ,@(when decls `((declare ,@decls)))
1014      ,@body)))
1015
1016(defmacro make-destructure-state (tail whole lambda)
1017  `(%istruct 'destructure-state ,tail ,whole ,lambda))
1018
1019
1020; This is supposedly ANSI CL.
1021(defmacro lambda (&whole lambda-expression (&rest paramlist) &body body)
1022  (declare (ignore paramlist body))
1023  (unless (lambda-expression-p lambda-expression)
1024    (warn "Invalid lambda expression: ~s" lambda-expression))
1025  `(function ,lambda-expression))
1026
1027; This isn't
1028(defmacro nlambda (name (&rest arglist) &body body)
1029  `(nfunction ,name (lambda ,arglist ,@body)))
1030
1031(defmacro when (test &body body)
1032  "If the first argument is true, the rest of the forms are
1033  evaluated as a PROGN."
1034 `(if ,test
1035   (progn ,@body)))
1036
1037(defmacro unless (test &body body)
1038  "If the first argument is not true, the rest of the forms are
1039  evaluated as a PROGN."
1040 `(if (not ,test)
1041   (progn ,@body)))
1042
1043(defmacro return (&optional (form nil form-p))
1044  `(return-from nil ,@(if form-p `(,form))))
1045
1046; since they use tagbody, while & until BOTH return NIL
1047(defmacro while (test &body body)
1048  (let ((testlab (gensym))
1049        (toplab (gensym)))
1050    `(tagbody
1051       (go ,testlab)
1052      ,toplab
1053      (progn ,@body)
1054      ,testlab
1055      (when ,test (go ,toplab)))))
1056
1057(defmacro until (test &body body)
1058  (let ((testlab (gensym))
1059        (toplab (gensym)))
1060    `(tagbody
1061       (go ,testlab)
1062      ,toplab
1063      (progn ,@body)
1064      ,testlab
1065      (if (not ,test)
1066        (go ,toplab)))))
1067
1068(defmacro psetq (&whole call &body pairs &environment env)
1069  "PSETQ {var value}*
1070   Set the variables to the values, like SETQ, except that assignments
1071   happen in parallel, i.e. no assignments take place until all the
1072   forms have been evaluated."
1073  (when pairs
1074   (if (evenp (length pairs))
1075     (do* ((l pairs (%cddr l))
1076           (sym (%car l) (%car l)))
1077          ((null l) (%pset pairs))
1078       (unless (symbolp sym) (report-bad-arg sym 'symbol))
1079       (when (nth-value 1 (macroexpand-1 sym env))
1080         (return `(psetf ,@pairs))))
1081     (signal-program-error "Uneven number of args in the call ~S" call))))
1082
1083; generates body for psetq.
1084; "pairs" is a proper list whose length is not odd.
1085(defun %pset (pairs)
1086 (when pairs
1087   (let (vars vals gensyms let-list var val sets)
1088      (loop
1089        (setq var (pop pairs)
1090              val (pop pairs))
1091        (if (null pairs) (return))
1092        (push var vars)
1093        (push val vals)
1094        (push (gensym) gensyms))
1095      (dolist (g gensyms)
1096        (push g sets)
1097        (push (pop vars) sets)
1098        (push (list g (pop vals)) let-list))
1099      (push val sets)
1100      (push var sets)
1101      `(progn
1102         (let ,let-list
1103           (setq ,@sets))
1104         nil))))
1105
1106
1107(eval-when (:compile-toplevel :load-toplevel :execute)
1108(defun do-loop (binder setter env var-init-steps end-test result body)
1109  (let ((toptag (gensym))
1110        (testtag (gensym)))
1111    (multiple-value-bind (forms decls) (parse-body body env nil)
1112      `(block nil
1113         (,binder ,(do-let-vars var-init-steps)
1114                  ,@decls
1115                  (tagbody ; crocks-r-us.
1116                    (go ,testtag)
1117                    ,toptag
1118                    (tagbody
1119                      ,@forms)
1120                    (,setter ,@(do-step-vars var-init-steps))
1121                    ,testtag
1122                    (unless ,end-test
1123                      (go ,toptag)))
1124                  ,@result)))))
1125)
1126
1127(defmacro do (&environment env var-init-steps (&optional end-test &rest result) &body body)
1128  "DO ({(Var [Init] [Step])}*) (Test Exit-Form*) Declaration* Form*
1129  Iteration construct. Each Var is initialized in parallel to the value of the
1130  specified Init form. On subsequent iterations, the Vars are assigned the
1131  value of the Step form (if any) in parallel. The Test is evaluated before
1132  each evaluation of the body Forms. When the Test is true, the Exit-Forms
1133  are evaluated as a PROGN, with the result being the value of the DO. A block
1134  named NIL is established around the entire expansion, allowing RETURN to be
1135  used as an alternate exit mechanism."
1136  (do-loop 'let 'psetq env var-init-steps end-test result body))
1137
1138(defmacro do* (&environment env var-init-steps (&optional end-test &rest result) &body body)
1139  "DO* ({(Var [Init] [Step])}*) (Test Exit-Form*) Declaration* Form*
1140  Iteration construct. Each Var is initialized sequentially (like LET*) to the
1141  value of the specified Init form. On subsequent iterations, the Vars are
1142  sequentially assigned the value of the Step form (if any). The Test is
1143  evaluated before each evaluation of the body Forms. When the Test is true,
1144  the Exit-Forms are evaluated as a PROGN, with the result being the value
1145  of the DO. A block named NIL is established around the entire expansion,
1146  allowing RETURN to be used as an laternate exit mechanism."
1147  (do-loop 'let* 'setq env var-init-steps end-test result body))
1148
1149
1150(defun do-let-vars (var-init-steps)
1151  (if var-init-steps
1152      (cons (list (do-let-vars-var (car var-init-steps))
1153                  (do-let-vars-init (car var-init-steps)))
1154             (do-let-vars (cdr var-init-steps)))))
1155
1156(defun do-let-vars-var (var-init-step)
1157  (if (consp var-init-step)
1158       (car var-init-step)
1159       var-init-step))
1160
1161(defun do-let-vars-init (var-init-step)
1162   (if (consp var-init-step)
1163        (cadr var-init-step)
1164        nil))
1165
1166(defun do-step-vars (var-init-steps)
1167    (if var-init-steps
1168        (if (do-step-vars-step? (car var-init-steps))
1169             (append (list (do-let-vars-var (car var-init-steps))
1170                           (do-step-vars-step (car var-init-steps)))
1171                     (do-step-vars (cdr var-init-steps)))
1172             (do-step-vars (cdr var-init-steps)))))
1173
1174(defun do-step-vars-step? (var-init-step)
1175  (if (consp var-init-step)
1176       (cddr var-init-step)))
1177
1178(defun do-step-vars-step (var-init-step)
1179  (if (consp var-init-step)
1180       (caddr var-init-step)))
1181
1182
1183(defmacro dotimes ((i n &optional result) &body body &environment env)
1184  (multiple-value-bind (forms decls)
1185                       (parse-body body env)
1186    (if (not (symbolp i))(signal-program-error $Xnotsym i))
1187    (let* ((toptag (gensym))
1188           (limit (gensym)))
1189      `(block nil
1190        (let ((,limit ,n) (,i 0))
1191         ,@decls
1192         (declare (unsettable ,i))
1193           (if (int>0-p ,limit)
1194             (tagbody
1195               ,toptag
1196               ,@forms
1197               (locally
1198                (declare (settable ,i))
1199                (setq ,i (1+ ,i)))
1200               (unless (eql ,i ,limit) (go ,toptag))))
1201           ,result)))))
1202 
1203(defun do-syms-result (var resultform)
1204  (unless (eq var resultform)
1205    (if (and (consp resultform) (not (quoted-form-p resultform)))
1206      `(progn (setq ,var nil) ,resultform)
1207      resultform)))
1208
1209(defun expand-package-iteration-macro (iteration-function var pkg-spec resultform body env)
1210  (multiple-value-bind (body decls) (parse-body body env nil)
1211    (let* ((ftemp (gensym))
1212           (vtemp (gensym))
1213           (ptemp (gensym))
1214           (result (do-syms-result var resultform)))
1215      `(block nil
1216        (let* ((,var nil)
1217               (,ptemp ,pkg-spec))
1218          ,@decls
1219           (flet ((,ftemp (,vtemp) (declare (debugging-function-name nil)) (setq ,var ,vtemp) (tagbody ,@body)))
1220             (declare (dynamic-extent #',ftemp))
1221             (,iteration-function ,ptemp #',ftemp))
1222           ,@(when result `(,result)))))))
1223
1224(defmacro do-symbols ((var &optional pkg result) &body body &environment env)
1225  "DO-SYMBOLS (VAR [PACKAGE [RESULT-FORM]]) {DECLARATION}* {TAG | FORM}*
1226   Executes the FORMs at least once for each symbol accessible in the given
1227   PACKAGE with VAR bound to the current symbol."
1228  (expand-package-iteration-macro 'iterate-over-accessable-symbols var pkg result body env))
1229
1230(defmacro do-present-symbols ((var &optional pkg result) &body body &environment env)
1231  (expand-package-iteration-macro 'iterate-over-present-symbols var pkg result body env))
1232
1233(defmacro do-external-symbols ((var &optional pkg result) &body body &environment env)
1234  "DO-EXTERNAL-SYMBOLS (VAR [PACKAGE [RESULT-FORM]]) {DECL}* {TAG | FORM}*
1235   Executes the FORMs once for each external symbol in the given PACKAGE with
1236   VAR bound to the current symbol."
1237  (expand-package-iteration-macro 'iterate-over-external-symbols var pkg result body env))
1238
1239(defmacro do-all-symbols ((var &optional resultform)
1240                          &body body &environment env)
1241  "DO-ALL-SYMBOLS (VAR [RESULT-FORM]) {DECLARATION}* {TAG | FORM}*
1242   Executes the FORMs once for each symbol in every package with VAR bound
1243   to the current symbol."
1244  (multiple-value-bind (body decls) (parse-body body env nil)
1245    (let* ((ftemp (gensym))
1246           (vtemp (gensym))
1247           (result (do-syms-result var resultform)))
1248      `(block nil
1249        (let* ((,var nil))
1250         ,@decls
1251           (flet ((,ftemp (,vtemp) (declare (debugging-function-name nil)) (setq ,var ,vtemp) (tagbody ,@body)))
1252             (declare (dynamic-extent #',ftemp))
1253             (iterate-over-all-symbols #',ftemp))
1254           ,@(when result `(,result)))))))
1255
1256(defmacro multiple-value-list (form)
1257  `(multiple-value-call #'list ,form))
1258
1259
1260
1261
1262(defmacro %i> (x y)
1263  `(> (the fixnum ,x) (the fixnum ,y)))
1264
1265(defmacro %i< (x y)
1266  `(< (the fixnum ,x) (the fixnum ,y)))
1267
1268(defmacro %i<= (x y)
1269 `(not (%i> ,x ,y)))
1270
1271(defmacro %i>= (x y)
1272 `(not (%i< ,x ,y)))
1273
1274(defmacro bitset (bit number)
1275  `(logior (ash 1 ,bit) ,number))
1276
1277(defmacro bitclr (bit number)
1278  `(logand (lognot (ash 1 ,bit)) ,number))
1279
1280(defmacro bitopf ((op bit place) &environment env)
1281  (multiple-value-bind (vars vals stores store-form access-form)
1282                       (get-setf-method place env)
1283    (let* ((constant-bit-p (constantp bit))
1284           (bitvar (if constant-bit-p bit (gensym))))
1285      `(let ,(unless constant-bit-p `((,bitvar ,bit)))          ; compiler isn't smart enough
1286         (let* ,(mapcar #'list `(,@vars ,@stores) `(,@vals (,op ,bitvar ,access-form)))
1287           ,store-form)))))
1288
1289(defmacro bitsetf (bit place)
1290  `(bitopf (bitset ,bit ,place)))
1291
1292(defmacro bitclrf (bit place)
1293  `(bitopf (bitclr ,bit ,place)))
1294
1295(defmacro %svref (v i)
1296  (let* ((vtemp (make-symbol "VECTOR"))
1297           (itemp (make-symbol "INDEX")))
1298      `(let* ((,vtemp ,v)
1299              (,itemp ,i))
1300         (locally (declare (optimize (speed 3) (safety 0)))
1301           (svref ,vtemp ,itemp)))))
1302
1303(defmacro %svset (v i new)
1304  (let* ((vtemp (make-symbol "VECTOR"))
1305         (itemp (make-symbol "INDEX"))
1306         (ntemp (make-symbol "NEW")))
1307    `(let* ((,vtemp ,v)
1308            (,itemp ,i)
1309            (,ntemp ,new))
1310      (locally (declare (optimize (speed 3) (safety 0)))
1311        (setf (svref ,vtemp ,itemp) ,ntemp)))))
1312
1313
1314(defmacro %schar (v i)
1315  (let* ((vtemp (make-symbol "STRING"))
1316         (itemp (make-symbol "INDEX")))
1317    `(let* ((,vtemp ,v)
1318            (,itemp ,i))
1319       (locally (declare (optimize (speed 3) (safety 0)))
1320         (schar ,vtemp ,itemp)))))
1321
1322(defmacro %set-schar (v i new)
1323  (let* ((vtemp (make-symbol "STRING"))
1324         (itemp (make-symbol "INDEX"))
1325         (ntemp (make-symbol "NEW")))
1326      `(let* ((,vtemp ,v)
1327              (,itemp ,i)
1328              (,ntemp ,new))
1329         (locally (declare (optimize (speed 3) (safety 0)))
1330           (setf (schar ,vtemp ,itemp) ,ntemp)))))
1331
1332
1333(defmacro %char-code (c) `(char-code (the character ,c)))
1334;;; %CODE-CHAR is used internally.  It can sometimes exploit the
1335;;; assertion that the character code is an (UNSIGNED-BYTE 8) to
1336;;; generate better compiled code (partly because all such character
1337;;; codes denote characters.)
1338;;; Confusingly, it's not just the inverse of %CHAR-CODE.  It's
1339;;; almost always going to be open-coded, so this macro definition
1340;;; is mostly just a kind of documentation.
1341(defmacro %code-char (i) `(code-char (the (mod 256) ,i)))
1342
1343(defmacro %izerop (x) `(eq ,x 0))
1344(defmacro %iminusp (x) `(< (the fixnum ,x) 0))
1345(defmacro %i+ (&rest (&optional (n0 0) &rest others))
1346  (if others
1347    `(the fixnum (+ (the fixnum ,n0) (%i+ ,@others)))
1348    `(the fixnum ,n0)))
1349(defmacro %i- (x y &rest others) 
1350  (if (not others)
1351    `(the fixnum (- (the fixnum ,x) (the fixnum ,y)))
1352    `(the fixnum (- (the fixnum ,x) (the fixnum (%i+ ,y ,@others))))))
1353
1354
1355(defmacro %i* (x y) `(the fixnum (* (the fixnum ,x) (the fixnum ,y))))
1356
1357(defmacro %ilogbitp (b i)
1358  (target-word-size-case
1359   (32
1360    `(logbitp (the (integer 0 29) ,b) (the fixnum ,i)))
1361   (64
1362    `(logbitp (the (integer 0 60) ,b) (the fixnum ,i)))))
1363
1364;;; Seq-Dispatch does an efficient type-dispatch on the given Sequence.
1365
1366(defmacro seq-dispatch (sequence list-form array-form)
1367  `(if (sequence-type ,sequence)
1368       ,list-form
1369       ,array-form))
1370
1371
1372(defsetf %get-byte %set-byte)
1373(defsetf %get-unsigned-byte %set-unsigned-byte)
1374(defsetf %get-signed-byte %set-byte)
1375(defsetf %get-word %set-word)
1376(defsetf %get-signed-word %set-word)
1377(defsetf %get-unsigned-word %set-unsigned-word)
1378(defsetf %get-long %set-long)
1379(defsetf %get-signed-long %set-long)
1380(defsetf %get-unsigned-long %set-unsigned-long)
1381(defsetf %get-full-long %set-long)
1382(defsetf %get-point %set-long)
1383(defsetf %get-ptr %set-ptr)
1384(defsetf %get-double-float %set-double-float)
1385(defsetf %get-single-float %set-single-float)
1386(defsetf %get-bit %set-bit)
1387(defsetf %get-unsigned-long-long %set-unsigned-long-long)
1388(defsetf %%get-unsigned-longlong %%set-unsigned-longlong)
1389(defsetf %get-signed-long-long %set-signed-long-long)
1390(defsetf %%get-signed-longlong %%set-signed-longlong)
1391(defsetf %get-bitfield %set-bitfield)
1392
1393(defmacro %ilognot (int) `(%i- -1 ,int))
1394
1395(defmacro %ilogior2 (x y) 
1396  `(logior (the fixnum ,x) (the fixnum ,y)))
1397
1398(defmacro %ilogior (body &rest args)
1399   (while args
1400     (setq body (list '%ilogior2 body (pop args))))
1401   body)
1402
1403(defmacro %ilogand2 (x y)
1404  `(logand (the fixnum ,x) (the fixnum ,y)))
1405
1406(defmacro %ilogand (body &body args)
1407   (while args
1408     (setq body (list '%ilogand2 body (pop args))))
1409   body)
1410
1411(defmacro %ilogxor2 (x y)
1412  `(logxor (the fixnum ,x) (the fixnum ,y)))
1413
1414(defmacro %ilogxor (body &body args)
1415   (while args
1416     (setq body (list '%ilogxor2 body (pop args))))
1417   body)
1418
1419(defmacro with-macptrs (varlist &rest body &environment env)
1420  (multiple-value-bind (body other-decls) (parse-body body env)
1421    (collect ((temp-bindings)
1422              (temp-decls)
1423              (bindings)
1424              (our-decls)
1425              (inits))
1426      (dolist (var varlist)
1427        (let* ((temp (gensym)))
1428          (temp-decls temp)
1429        (if (consp var)
1430          (progn
1431            (our-decls (car var))
1432            (temp-bindings `(,temp (%null-ptr)))
1433            (bindings `(,(car var) ,temp))
1434            (if (cdr var)
1435              (inits `(%setf-macptr ,temp ,@(cdr var)))))
1436          (progn
1437            (our-decls var)
1438            (temp-bindings  `(,temp  (%null-ptr)))
1439            (bindings `(,var ,temp))))))
1440  `(let* ,(temp-bindings)
1441    (declare (dynamic-extent ,@(temp-decls)))
1442    (declare (type macptr ,@(temp-decls)))
1443    ,@(inits)
1444    (let* ,(bindings)
1445      (declare (type macptr ,@(our-decls)))
1446      ,@other-decls
1447      ,@body)))))
1448
1449
1450(defmacro with-loading-file (filename &rest body)
1451   `(let ((*loading-files* (cons ,filename (locally (declare (special *loading-files*))
1452                                                    *loading-files*))))
1453      (declare (special *loading-files*))
1454      ,@body))
1455
1456(defmacro with-input-from-string ((var string &key index start end) &body forms &environment env)
1457  "Create an input string stream, provide an opportunity to perform
1458operations on the stream (returning zero or more values), and then close
1459the string stream.
1460
1461STRING is evaluated first, and VAR is bound to a character input string
1462stream that supplies characters from the subsequence of the resulting
1463string bounded by start and end. BODY is executed as an implicit progn."
1464  (multiple-value-bind (forms decls) (parse-body forms env nil)
1465    `(let ((,var
1466            ,(cond ((null end)
1467                    `(make-string-input-stream ,string ,(or start 0)))
1468                   ((symbolp end)
1469                    `(if ,end
1470                      (make-string-input-stream ,string ,(or start 0) ,end)
1471                      (make-string-input-stream ,string ,(or start 0))))
1472                   (t
1473                    `(make-string-input-stream ,string ,(or start 0) ,end)))))
1474      ,@decls
1475      (unwind-protect
1476           (multiple-value-prog1
1477               (progn ,@forms)
1478             ,@(if index `((setf ,index (string-input-stream-index ,var)))))
1479        (close ,var)))))
1480
1481(defmacro with-input-from-vector ((var vector &key index (start 0) end external-format) &body forms &environment env)
1482  (multiple-value-bind (forms decls) (parse-body forms env nil)
1483    `(let ((,var (%make-vector-input-stream ,vector ,start ,end ,external-format)))
1484      ,@decls
1485      (unwind-protect
1486           (multiple-value-prog1
1487               (progn ,@forms)
1488             ,@(if index `((setf ,index (vector-input-stream-index ,var)))))
1489        (close ,var)))))
1490
1491(defmacro with-output-to-string ((var &optional string &key (element-type 'base-char element-type-p))
1492                                 &body body 
1493                                 &environment env)
1494  "Create a character output stream, perform a series of operations that
1495may send results to this stream, and then close the stream.  BODY is
1496executed as an implicit progn with VAR bound to an output string stream.
1497All output to that string stream is saved in a string."
1498  (let* ((string-p (not (null string))))
1499    (multiple-value-bind (forms decls) (parse-body body env nil)
1500      `(let* ((,var ,@(if string-p
1501                          `(,@(if element-type-p
1502                                   `((progn
1503                                       ,element-type
1504                                       (%make-string-output-stream ,string)))
1505                                   `((%make-string-output-stream ,string))))
1506                          `(,@(if element-type-p
1507                                   `((make-string-output-stream :element-type ,element-type))
1508                                   `((make-string-output-stream)))))))
1509        ,@decls
1510        (unwind-protect
1511             (progn
1512               ,@forms
1513               ,@(if string-p () `((get-output-stream-string ,var))))
1514          (close ,var))))))
1515
1516(defmacro with-output-to-vector ((var &optional vector &key external-format)
1517                                 &body body 
1518                                 &environment env)
1519  (let* ((vector-p (not (null vector))))
1520    (multiple-value-bind (forms decls) (parse-body body env nil)
1521      `(let* ((,var ,@(if vector-p
1522                          `((%make-vector-output-stream ,vector ,external-format))
1523                          `((make-vector-output-stream :external-format ,external-format)))))
1524         ,@decls
1525         (unwind-protect
1526              (progn
1527                ,@forms
1528                ,@(if vector-p () `((get-output-stream-vector ,var))))
1529           (close ,var))))))
1530
1531(defmacro with-output-to-truncating-string-stream ((var len) &body body
1532                                                   &environment env)
1533  (multiple-value-bind (forms decls) (parse-body body env nil)
1534    `(let* ((,var (make-truncating-string-stream ,len)))
1535      ,@decls
1536      (unwind-protect
1537           (progn
1538             ,@forms
1539             (values (get-output-stream-string ,var)
1540                     (slot-value ,var 'truncated)))
1541        (close ,var)))))
1542
1543(defmacro with-open-file ((var filename . args) &body body &aux (stream (gensym))(done (gensym)))
1544  "Use open to create a file stream to file named by filename. Filename is
1545the name of the file to be opened. Options are used as keyword arguments
1546to open."
1547  `(let (,stream ,done)
1548     (unwind-protect
1549       (multiple-value-prog1
1550         (let ((,var (setq ,stream (open ,filename ,@args))))
1551           ,@body)
1552         (setq ,done t))
1553       (when ,stream (close ,stream :abort (null ,done))))))
1554
1555(defmacro with-compilation-unit ((&key override) &body body)
1556  "WITH-COMPILATION-UNIT ({Key Value}*) Form*
1557  This form affects compilations that take place within its dynamic extent. It
1558  is intended to be wrapped around the compilation of all files in the same
1559  system. These keywords are defined:
1560    :OVERRIDE Boolean-Form
1561        One of the effects of this form is to delay undefined warnings
1562        until the end of the form, instead of giving them at the end of each
1563        compilation. If OVERRIDE is NIL (the default), then the outermost
1564        WITH-COMPILATION-UNIT form grabs the undefined warnings. Specifying
1565        OVERRIDE true causes that form to grab any enclosed warnings, even if
1566        it is enclosed by another WITH-COMPILATION-UNIT."
1567  `(flet ((with-compilation-unit-body ()
1568            ,@body))
1569     (declare (dynamic-extent #'with-compilation-unit-body))
1570     (call-with-compilation-unit #'with-compilation-unit-body :override ,override)))
1571
1572; Yow! Another Done Fun.
1573(defmacro with-standard-io-syntax (&body body &environment env)
1574  "Bind the reader and printer control variables to values that enable READ
1575   to reliably read the results of PRINT. These values are:
1576       *PACKAGE*                        the COMMON-LISP-USER package
1577       *PRINT-ARRAY*                    T
1578       *PRINT-BASE*                     10
1579       *PRINT-CASE*                     :UPCASE
1580       *PRINT-CIRCLE*                   NIL
1581       *PRINT-ESCAPE*                   T
1582       *PRINT-GENSYM*                   T
1583       *PRINT-LENGTH*                   NIL
1584       *PRINT-LEVEL*                    NIL
1585       *PRINT-LINES*                    NIL
1586       *PRINT-MISER-WIDTH*              NIL
1587       *PRINT-PRETTY*                   NIL
1588       *PRINT-RADIX*                    NIL
1589       *PRINT-READABLY*                 T
1590       *PRINT-RIGHT-MARGIN*             NIL
1591       *READ-BASE*                      10
1592       *READ-DEFAULT-FLOAT-FORMAT*      SINGLE-FLOAT
1593       *READ-EVAL*                      T
1594       *READ-SUPPRESS*                  NIL
1595       *READTABLE*                      the standard readtable"
1596  (multiple-value-bind (decls body) (parse-body body env)
1597    `(let ((*package* (pkg-arg "COMMON-LISP-USER"))
1598           (*print-array* t)
1599           (*print-base* 10.)
1600           (*print-case* :upcase)
1601           (*print-circle* nil)
1602           (*print-escape* t)
1603           (*print-gensym* t)
1604           (*print-length* nil)
1605           (*print-level* nil)
1606           (*print-lines* nil) ; This doesn't exist as of 5/15/90 - does now
1607           (*print-miser-width* nil)
1608           (*print-pprint-dispatch* nil)
1609           (*print-pretty* nil)
1610           (*print-radix* nil)
1611           (*print-readably* t)
1612           (*print-right-margin* nil)
1613           (*read-base* 10.)
1614           (*read-default-float-format* 'single-float)
1615           (*read-eval* t) ; Also MIA as of 5/15/90
1616           (*read-suppress* nil)
1617           (*readtable* %standard-readtable%)
1618           ; ccl extensions (see l1-io.lisp)
1619           (*print-abbreviate-quote* t)
1620           (*print-structure* t)
1621           (*print-simple-vector* nil)
1622           (*print-simple-bit-vector* nil)
1623           (*print-string-length* nil))
1624       ,@decls
1625       ,@body)))
1626
1627(defmacro with-self-bound-io-control-vars (&body body)
1628  `(let (
1629         (*print-array* *print-array*)
1630         (*print-base* *print-base*)
1631         (*print-case* *print-case*)
1632         (*print-circle* *print-circle*)
1633         (*print-escape* *print-escape*)
1634         (*print-gensym* *print-gensym*)
1635         (*print-length* *print-length*)
1636         (*print-level* *print-level*)
1637         (*print-lines* *print-lines*)
1638         (*print-miser-width* *print-miser-width*)
1639         (*print-pprint-dispatch* *print-pprint-dispatch*)
1640         (*print-pretty* *print-pretty*)
1641         (*print-radix* *print-radix*)
1642         (*print-readably* *print-readably*)
1643         (*print-right-margin* *print-right-margin*)
1644         (*read-base* *read-base*)
1645         (*read-default-float-format* *read-default-float-format*)
1646         (*read-eval* *read-eval*)
1647         (*read-suppress* *read-suppress*)
1648         (*readtable* *readtable*))
1649     ,@body))
1650
1651(defmacro print-unreadable-object (&environment env (object stream &key type identity) &body forms)
1652  "Output OBJECT to STREAM with \"#<\" prefix, \">\" suffix, optionally
1653  with object-type prefix and object-identity suffix, and executing the
1654  code in BODY to provide possible further output."
1655  (multiple-value-bind (body decls) (parse-body forms env)
1656    (if body
1657      (let ((thunk (gensym)))
1658        `(let ((,thunk #'(lambda () ,@decls ,@body)))
1659           (declare (dynamic-extent ,thunk))
1660          (%print-unreadable-object ,object ,stream ,type ,identity ,thunk)))
1661      `(%print-unreadable-object ,object ,stream ,type ,identity nil))))
1662;; Pointers and Handles
1663
1664;;Add function to lisp system pointer functions, and run it if it's not already
1665;; there.
1666(defmacro def-ccl-pointers (name arglist &body body &aux (old (gensym)))
1667  `(flet ((,name ,arglist ,@body))
1668     (let ((,old (member ',name *lisp-system-pointer-functions* :key #'function-name)))
1669       (if ,old
1670         (rplaca ,old #',name)
1671         (progn
1672           (push #',name *lisp-system-pointer-functions*)
1673           (,name))))))
1674
1675(defmacro def-load-pointers (name arglist &body body &aux (old (gensym)))
1676  `(flet ((,name ,arglist ,@body))
1677     (let ((,old (member ',name *lisp-user-pointer-functions* :key #'function-name)))
1678       (if ,old
1679         (rplaca ,old #',name)
1680         (progn
1681           (push #',name *lisp-user-pointer-functions*)
1682           (,name))))))
1683
1684;Queue up some code to run after ccl all loaded up, or, if ccl is already
1685;loaded up, just run it right now.
1686(defmacro queue-fixup (&rest body &aux (fn (gensym)))
1687  `(let ((,fn #'(lambda () ,@body)))
1688     (if (eq %lisp-system-fixups% T)
1689       (funcall ,fn)
1690       (push (cons ,fn (or *loading-toplevel-location* *loading-file-source-file*)) %lisp-system-fixups%))))
1691
1692(defmacro %incf-ptr (p &optional (by 1))
1693  (if (symbolp p)  ;once-only
1694    `(%setf-macptr (the macptr ,p) (%inc-ptr ,p ,by))
1695    (let ((var (gensym)))
1696      `(let ((,var ,p)) (%setf-macptr (the macptr ,var) (%inc-ptr ,var ,by))))))
1697
1698(defmacro with-string-from-cstring ((s ptr) &body body)
1699  (let* ((len (gensym))
1700         (p (gensym)))
1701    `(let* ((,p ,ptr)
1702            (,len (%cstrlen ,p))
1703            (,s (make-string ,len)))
1704      (declare (fixnum ,len))
1705      (%copy-ptr-to-ivector ,p 0 ,s 0 ,len)
1706      (locally
1707          ,@body))))
1708
1709
1710(defmacro with-cstr ((sym str &optional start end) &rest body &environment env)
1711  (multiple-value-bind (body decls) (parse-body body env nil)
1712    (if (and (base-string-p str) (null start) (null end))
1713      (let ((strlen (%i+ (length str) 1)))
1714        `(%stack-block ((,sym ,strlen))
1715           ,@decls
1716           (%cstr-pointer ,str ,sym)
1717           ,@body))
1718      (let ((strname (gensym))
1719            (start-name (gensym))
1720            (end-name (gensym)))
1721        `(let ((,strname ,str)
1722               ,@(if (or start end)
1723                   `((,start-name ,(or start 0))
1724                     (,end-name ,(or end `(length ,strname))))))
1725           (%vstack-block (,sym
1726                           (the fixnum
1727                             (1+
1728                              (the fixnum
1729                                ,(if (or start end)
1730                                     `(byte-length
1731                                       ,strname ,start-name ,end-name)
1732                                     `(length ,strname))))))
1733             ,@decls
1734             ,(if (or start end)
1735                `(%cstr-segment-pointer ,strname ,sym ,start-name ,end-name)
1736                `(%cstr-pointer ,strname ,sym))
1737             ,@body))))))
1738
1739(defmacro with-utf-8-cstr ((sym str) &body body)
1740  (let* ((data (gensym))
1741         (offset (gensym))
1742         (string (gensym))
1743         (len (gensym))
1744         (noctets (gensym))
1745         (end (gensym)))
1746    `(let* ((,string ,str)
1747            (,len (length ,string)))
1748      (multiple-value-bind (,data ,offset) (array-data-and-offset ,string)
1749        (let* ((,end (+ ,offset ,len))
1750               (,noctets (utf-8-octets-in-string ,data ,offset ,end)))
1751          (%stack-block ((,sym (1+ ,noctets)))
1752            (utf-8-memory-encode ,data ,sym 0 ,offset ,end)
1753            (setf (%get-unsigned-byte ,sym ,noctets) 0)
1754            ,@body))))))
1755
1756
1757
1758(defmacro with-native-utf-16-cstr ((sym str) &body body)
1759  (let* ((data (gensym))
1760         (offset (gensym))
1761         (string (gensym))
1762         (len (gensym))
1763         (noctets (gensym))
1764         (end (gensym)))
1765    `(let* ((,string ,str)
1766            (,len (length ,string)))
1767      (multiple-value-bind (,data ,offset) (array-data-and-offset ,string)
1768        (let* ((,end (+ ,offset ,len))
1769               (,noctets (utf-16-octets-in-string ,data ,offset ,end)))
1770          (%stack-block ((,sym (1+ ,noctets)))
1771            (native-utf-16-memory-encode ,data ,sym 0 ,offset ,end)
1772            (setf (%get-unsigned-word ,sym ,noctets) 0)
1773            ,@body))))))
1774
1775(defmacro with-pointers (speclist &body body)
1776   (with-specs-aux 'with-pointer speclist body))
1777
1778
1779
1780(defmacro with-cstrs (speclist &body body)
1781   (with-specs-aux 'with-cstr speclist body))
1782
1783(defmacro with-utf-8-cstrs (speclist &body body)
1784   (with-specs-aux 'with-utf-8-cstr speclist body))
1785
1786(defmacro with-native-utf-16-cstrs (speclist &body body)
1787  (with-specs-aux 'with-native-utf-16-cstr speclist body))
1788
1789(defmacro with-encoded-cstr ((encoding-name (sym string &optional start end))
1790                             &rest body &environment env)
1791  (let* ((encoding (gensym))
1792         (str (gensym)))
1793      (multiple-value-bind (body decls) (parse-body body env nil)
1794        `(let* ((,str ,string)
1795                (,encoding (get-character-encoding ,encoding-name)))
1796          (%stack-block ((,sym (cstring-encoded-length-in-bytes ,encoding ,str ,start ,end) :clear t))
1797            ,@decls
1798            (encode-string-to-memory ,encoding ,sym 0 ,str ,start ,end)
1799            ,@body)))))
1800
1801(defmacro with-encoded-cstrs (encoding-name bindings &body body)
1802  (with-specs-aux 'with-encoded-cstr (mapcar #'(lambda (b)
1803                                                 `(,encoding-name ,b))
1804                                             bindings) body))
1805
1806(defmacro with-filename-cstrs (&rest rest)
1807  (case (target-os-name)
1808    (:darwin `(with-utf-8-cstrs ,@rest))
1809    (:windows `(with-native-utf-16-cstrs ,@rest))
1810    (t `(with-encoded-cstrs (pathname-encoding-name) ,@rest))))
1811
1812
1813(defun with-specs-aux (name spec-list original-body)
1814  (multiple-value-bind (body decls) (parse-body original-body nil)
1815    (when decls (signal-program-error "declarations not allowed in ~s" original-body))
1816    (setq body (cons 'progn body))
1817    (dolist (spec (reverse spec-list))
1818      (setq body (list name spec body)))
1819    body))
1820
1821
1822(defmacro type-predicate (type)
1823  `(get-type-predicate ,type))
1824
1825(defsetf type-predicate set-type-predicate)
1826
1827(defun adjust-defmethod-lambda-list (ll)
1828  ;; If the lambda list contains &key, ensure that it also contains
1829  ;; &allow-other-keys
1830  (if (or (not (memq '&key ll))
1831          (memq '&allow-other-keys ll))
1832    ll
1833    (if (memq '&aux ll)
1834      (let* ((ll (copy-list ll))
1835             (aux (memq '&aux ll)))
1836        (setf (car aux) '&allow-other-keys
1837              (cdr aux) (cons '&aux (cdr aux)))
1838        ll)
1839      (append ll '(&allow-other-keys)))))
1840
1841(defmacro defmethod (name &rest args &environment env)
1842  (let* ((method (gensym)))
1843    (multiple-value-bind (function-form specializers-form qualifiers lambda-list documentation specializers)
1844        (parse-defmethod name args env)
1845      `(progn
1846        (eval-when (:compile-toplevel)
1847          (record-function-info ',(maybe-setf-function-name name)
1848                                ',(multiple-value-bind (bits keyvect) (encode-lambda-list lambda-list t)
1849                                                       (unless bits;; verify failed
1850                                                         (signal-program-error "Invalid lambda list ~s"
1851                                                                               (find-if #'listp args)))
1852                                                       (%cons-def-info 'defmethod bits keyvect nil specializers qualifiers))
1853                                ,env))
1854        (compiler-let ((*nx-method-warning-name* '(,name ,@qualifiers ,specializers)))
1855          (let* ((,method (ensure-method ',name ,specializers-form
1856                                         :function ,function-form
1857                                         :qualifiers ',qualifiers
1858                                         :lambda-list ',lambda-list
1859                                         ,@(if documentation `(:documentation ,documentation)))))
1860            (record-source-file ,method 'method)
1861            ,method))))))
1862
1863
1864(defun seperate-defmethod-decls (decls)
1865  (let (outer inner)
1866    (dolist (decl decls)
1867      (if (neq (car decl) 'declare)
1868        (push decl outer)
1869        (let (outer-list inner-list)
1870          (dolist (d (cdr decl))
1871            (if (and (listp d) (eq (car d) 'dynamic-extent))
1872              (let (in out)
1873                (dolist (fspec (cdr d))
1874                  (if (and (listp fspec)
1875                           (eq (car fspec) 'function)
1876                           (listp (cdr fspec))
1877                           (null (cddr fspec))
1878                           (memq (cadr fspec) '(call-next-method next-method-p)))
1879                    (push fspec in)
1880                    (push fspec out)))
1881                (when out
1882                  (push `(dynamic-extent ,@(nreverse out)) outer-list))
1883                (when in
1884                  (push `(dynamic-extent ,@(nreverse in)) inner-list)))
1885              (push d outer-list)))
1886          (when outer-list
1887            (push `(declare ,@(nreverse outer-list)) outer))
1888          (when inner-list
1889            (push `(declare ,@(nreverse inner-list)) inner)))))
1890    (values (nreverse outer) (nreverse inner))))
1891                   
1892
1893(defvar *warn-about-unreferenced-required-args-in-methods* t)
1894
1895(defun parse-defmethod (name args env)
1896  (validate-function-name name)
1897  (let (qualifiers lambda-list parameters specializers specializers-form refs types temp)
1898    (until (listp (car args))
1899      (push (pop args) qualifiers))
1900    (setq lambda-list (pop args))
1901    (while (and lambda-list (not (memq (car lambda-list) lambda-list-keywords)))
1902      (let ((p (pop lambda-list)))
1903        (cond ((consp p)
1904               (unless (and (consp (%cdr p)) (null (%cddr p)))
1905                 (signal-program-error "Illegal arg ~S" p))
1906               (push (%car p) parameters)
1907               (push (%car p) refs)
1908               (setq p (%cadr p))
1909               (cond ((and (consp p) (eq (%car p) 'eql)
1910                           (consp (%cdr p)) (null (%cddr p)))
1911                      (push `(list 'eql ,(%cadr p)) specializers-form)
1912                      (push p specializers))
1913                     ((or (setq temp (non-nil-symbol-p p))
1914                          (specializer-p p))
1915                      (push `',p specializers-form)
1916                      (push p specializers)
1917                      (unless (or (eq p t) (not temp))
1918                        ;Should be `(guaranteed-type ...).
1919                        (push `(type ,p ,(%car parameters)) types)))
1920                     (t (signal-program-error "Illegal arg ~S" p))))
1921              (t
1922               (push p parameters)
1923               (unless *warn-about-unreferenced-required-args-in-methods*
1924                 (push p refs))
1925               (push t specializers-form)
1926               (push t specializers)))))
1927    (setq lambda-list (nreconc parameters lambda-list))
1928    (multiple-value-bind (body decls doc) (parse-body args env t)
1929      (multiple-value-bind (outer-decls inner-decls) 
1930                           (seperate-defmethod-decls decls)
1931        (let* ((methvar (make-symbol "NEXT-METHOD-CONTEXT"))
1932               (cnm-args (gensym))
1933               (lambda-form `(lambda ,(list* '&method methvar lambda-list)
1934                               (declare ;,@types
1935                                (ignorable ,@refs))
1936                               ,@outer-decls
1937                               (block ,(if (consp name) (cadr name) name)
1938                                 (flet ((call-next-method (&rest ,cnm-args)
1939                                          (declare (dynamic-extent ,cnm-args))
1940                                          (if ,cnm-args
1941                                            (apply #'%call-next-method-with-args ,methvar ,cnm-args)
1942                                            (%call-next-method ,methvar)))
1943                                        (next-method-p () (%next-method-p ,methvar)))
1944                                   (declare (inline call-next-method next-method-p))
1945                                   (declare (ftype (function (&rest t)) ,name))
1946                                   ,@inner-decls
1947                                   ,@body)))))
1948          (values
1949           (if name `(nfunction ,name ,lambda-form) `(function ,lambda-form))
1950           `(list ,@(nreverse specializers-form))
1951           (nreverse qualifiers)
1952           lambda-list
1953           doc
1954           (nreverse specializers)))))))
1955
1956(defmacro anonymous-method (name &rest args &environment env)
1957  (multiple-value-bind (function-form specializers-form qualifiers method-class documentation)
1958                       (parse-defmethod name args env)
1959   
1960    `(%anonymous-method
1961      ,function-form
1962      ,specializers-form
1963      ',qualifiers
1964      ,@(if (or method-class documentation) `(',method-class))
1965      ,@(if documentation `(,documentation)))))
1966
1967
1968
1969(defmacro defclass (class-name superclasses slots &rest class-options &environment env)
1970  (flet ((duplicate-options (where) (signal-program-error "Duplicate options in ~S" where))
1971         (illegal-option (option) (signal-program-error "Illegal option ~s" option))
1972         (make-initfunction (form)
1973           (cond ((or (eq form 't)
1974                      (equal form ''t))
1975                  '(function true))
1976                 ((or (eq form 'nil)
1977                      (equal form ''nil))
1978                  '(function false))
1979                 (t
1980                  `(function (lambda () ,form))))))
1981    (setq class-name (require-type class-name '(and symbol (not null))))
1982    (setq superclasses (mapcar #'(lambda (s) (require-type s 'symbol)) superclasses))
1983    (let* ((options-seen ())
1984           (signatures ())
1985           (slot-names ())
1986           (slot-initargs ()))
1987      (flet ((canonicalize-defclass-option (option)
1988               (let* ((option-name (car option)))
1989                 (if (member option-name options-seen :test #'eq)
1990                   (duplicate-options class-options)
1991                   (push option-name options-seen))
1992                 (case option-name
1993                   (:default-initargs
1994                       (let ((canonical ())
1995                             (initargs-seen ()))
1996                         (let (key val (tail (cdr option)))
1997                           (loop (when (null tail) (return nil))
1998                              (setq key (pop tail)
1999                                    val (pop tail))
2000                              (when (memq key initargs-seen)
2001                                (SIGNAL-PROGRAM-error "Duplicate initialization argument name ~S in :DEFAULT-INITARGS of DEFCLASS ~S" key class-name))
2002                              (push key initargs-seen)
2003                              (push ``(,',key ,',val  ,,(make-initfunction val)) canonical))
2004                           `(':direct-default-initargs (list ,@(nreverse canonical))))))
2005                   (:metaclass
2006                    (unless (and (cadr option)
2007                                 (typep (cadr option) 'symbol))
2008                      (illegal-option option))
2009                    `(:metaclass  ',(cadr option)))
2010                   (:documentation
2011                    `(:documentation ',(cadr option)))
2012                   (t
2013                     (list `',option-name `',(cdr option))))))
2014             (canonicalize-slot-spec (slot)
2015               (if (null slot) (signal-program-error "Illegal slot NIL"))
2016               (if (not (listp slot)) (setq slot (list slot)))
2017               (let* ((slot-name (require-type (car slot) 'symbol))
2018                      (initargs nil)
2019                      (other-options ())
2020                      (initform nil)
2021                      (initform-p nil)
2022                      (initfunction nil)
2023                      (type nil)
2024                      (type-p nil)
2025                      (allocation nil)
2026                      (allocation-p nil)
2027                      (documentation nil)
2028                      (documentation-p nil)
2029                      (readers nil)
2030                      (writers nil)
2031                      (reader-info (%cons-def-info 'defmethod (dpb 1 $lfbits-numreq 0) nil nil (list class-name)))
2032                      (writer-info (%cons-def-info 'defmethod (dpb 2 $lfbits-numreq 0) nil nil (list t class-name))))
2033                 (when (memq slot-name slot-names)
2034                   (signal-program-error "Multiple slots named ~S in DEFCLASS ~S" slot-name class-name))
2035                 (push slot-name slot-names)
2036                 (do ((options (cdr slot) (cddr options))
2037                      name)
2038                     ((null options))
2039                   (when (null (cdr options)) (signal-program-error "Illegal slot spec ~S" slot))
2040                   (case (car options)
2041                     (:reader
2042                      (setq name (cadr options))
2043                      (unless (memq name readers)
2044                        (push (cons name reader-info) signatures)
2045                        (push name readers)))
2046                     (:writer                     
2047                      (setq name (cadr options))
2048                      (unless (member name writers :test 'equal)
2049                        (push (cons name writer-info) signatures)
2050                        (push name writers)))
2051                     (:accessor
2052                      (setq name (cadr options))
2053                      (unless (memq name readers)
2054                        (push (cons name reader-info) signatures)
2055                        (push name readers))
2056                      (let ((setf-name `(setf ,name)))
2057                        (unless (member setf-name writers :test 'equal)
2058                          (push (cons (setf-function-name name) writer-info) signatures)
2059                          (push setf-name writers))))
2060                     (:initarg
2061                      (let* ((initarg (require-type (cadr options) 'symbol))
2062                             (other (position initarg slot-initargs :test #'memq)))
2063                        (when other
2064                          (warn "Initarg ~s occurs in both ~s and ~s slots"
2065                                initarg (nth (1+ other) slot-names) slot-name))
2066                        (push initarg initargs)))
2067                     (:type
2068                      (if type-p
2069                        (duplicate-options slot)
2070                        (setq type-p t))
2071                      (setq type (cadr options))
2072                      ;; complain about illegal typespecs and continue
2073                      (handler-case (specifier-type type env)
2074                        (program-error ()
2075                          (warn "Invalid type ~s in ~s slot definition ~s" type class-name slot))))
2076                     (:initform
2077                      (if initform-p
2078                        (duplicate-options slot)
2079                        (setq initform-p t))
2080                      (let ((option (cadr options)))
2081                        (setq initform `',option
2082                              initfunction
2083                              (if (constantp option)
2084                                `(constantly ,option)
2085                                `#'(lambda () ,option)))))
2086                     (:allocation
2087                      (if allocation-p
2088                        (duplicate-options slot)
2089                        (setq allocation-p t))
2090                      (setq allocation (cadr options)))
2091                     (:documentation
2092                      (if documentation-p
2093                        (duplicate-options slot)
2094                        (setq documentation-p t))
2095                      (setq documentation (cadr options)))
2096                     (t
2097                      (let* ((pair (or (assq (car options) other-options)
2098                                       (car (push (list (car options)) other-options)))))
2099                        (push (cadr options) (cdr pair))))))
2100                 (push initargs slot-initargs)
2101                 `(list :name ',slot-name
2102                   ,@(when allocation `(:allocation ',allocation))
2103                   ,@(when initform-p `(:initform ,initform
2104                                        :initfunction ,initfunction))
2105                   ,@(when initargs `(:initargs ',initargs))
2106                   ,@(when readers `(:readers ',readers))
2107                   ,@(when writers `(:writers ',writers))
2108                   ,@(when type-p `(:type ',type))
2109                   ,@(when documentation-p `(:documentation ,documentation))
2110                   ,@(mapcan #'(lambda (opt)
2111                                 `(',(car opt) ',(if (null (cddr opt))
2112                                                     (cadr opt)
2113                                                     (cdr opt)))) other-options)))))
2114        (let* ((direct-superclasses superclasses)
2115               (direct-slot-specs (mapcar #'canonicalize-slot-spec slots))
2116               (other-options (apply #'append (mapcar #'canonicalize-defclass-option class-options )))
2117               (keyvect (class-keyvect class-name other-options)))
2118          (when (vectorp keyvect)
2119            (let ((illegal (loop for arg in other-options by #'cddr
2120                              as key = (if (quoted-form-p arg) (%cadr arg) arg)
2121                              unless (or (eq key :metaclass) (find key keyvect)) collect key)))
2122              (when illegal
2123                (signal-program-error "Class option~p~{ ~s~} is not one of ~s"
2124                                      (length illegal) illegal (coerce keyvect 'list)))))
2125          `(progn
2126             (when (memq ',class-name *nx-known-declarations*)
2127               (check-declaration-redefinition ',class-name 'defclass))
2128            (eval-when (:compile-toplevel)
2129              (%compile-time-defclass ',class-name ,env)
2130              (progn
2131                ,@(mapcar #'(lambda (sig) `(record-function-info ',(car sig) ',(cdr sig) ,env))
2132                          signatures)))
2133              (ensure-class-for-defclass ',class-name
2134                            :direct-superclasses ',direct-superclasses
2135                            :direct-slots ,`(list ,@direct-slot-specs)
2136                            ,@other-options)))))))
2137
2138(defmacro define-method-combination (name &rest rest &environment env)
2139  (setq name (require-type name 'symbol))
2140  (cond ((or (null rest) (and (car rest) (symbolp (car rest))))
2141         `(short-form-define-method-combination ',name ',rest))
2142        ((listp (car rest))
2143         (destructuring-bind (lambda-list method-group-specifiers . forms) rest
2144           (long-form-define-method-combination 
2145            name lambda-list method-group-specifiers forms env)))
2146        (t (%badarg (car rest) '(or (and null symbol) list)))))
2147
2148(defmacro defgeneric (function-name lambda-list &rest options-and-methods &environment env)
2149  (fboundp function-name)             ; type-check
2150  (multiple-value-bind (method-combination generic-function-class options methods)
2151      (parse-defgeneric function-name t lambda-list options-and-methods)
2152    (let ((gf (gensym)))
2153      `(progn
2154         (eval-when (:compile-toplevel)
2155           (record-function-info ',(maybe-setf-function-name function-name)
2156                                 ',(multiple-value-bind (bits keyvect) (encode-lambda-list lambda-list t)
2157                                     (%cons-def-info 'defgeneric bits keyvect))
2158                                 ,env))
2159         (let ((,gf (%defgeneric
2160                     ',function-name ',lambda-list ',method-combination ',generic-function-class 
2161                     ',(apply #'append options))))
2162           (%set-defgeneric-methods ,gf ,@methods)
2163           ,gf)))))
2164
2165
2166
2167(defun parse-defgeneric (function-name global-p lambda-list options-and-methods)
2168  (check-generic-function-lambda-list lambda-list)
2169  (let ((method-combination '(standard))
2170        (generic-function-class 'standard-generic-function)
2171        options declarations methods option-keywords method-class)
2172    (flet ((bad-option (o)
2173             (signal-program-error "Bad option: ~s to ~s." o 'defgeneric)))
2174      (dolist (o options-and-methods)
2175        (let ((keyword (car o))
2176              (defmethod (if global-p 'defmethod 'anonymous-method)))
2177          (if (eq keyword :method)
2178            (let ((defn `(,defmethod ,function-name ,@(%cdr o))))
2179              (note-source-transformation o defn)
2180              (push defn methods))
2181            (cond ((and (not (eq keyword 'declare))
2182                        (memq keyword (prog1 option-keywords (push keyword option-keywords))))             
2183                   (signal-program-error "Duplicate option: ~s to ~s" keyword 'defgeneric))
2184                  ((eq keyword :method-combination)
2185                   (unless (symbolp (cadr o))
2186                     (bad-option o))
2187                   (setq method-combination (cdr o)))
2188                  ((eq keyword :generic-function-class)
2189                   (unless (and (cdr o) (symbolp (cadr o)) (null (%cddr o)))
2190                     (bad-option o))
2191                   (setq generic-function-class (%cadr o)))
2192                  ((eq keyword 'declare)
2193                   (push (cadr o) declarations))
2194                  ((eq keyword :argument-precedence-order)
2195                   (dolist (arg (cdr o))
2196                     (unless (and (symbolp arg) (memq arg lambda-list))
2197                       (bad-option o)))
2198                   (push (list keyword (cdr o)) options))
2199                  ((eq keyword :method-class)
2200                   (push o options)
2201                   (when (or (cddr o) (not (symbolp (setq method-class (%cadr o)))))
2202                     (bad-option o)))
2203                  ((eq keyword :documentation)
2204                   (push o options)
2205                   (when (or (cddr o) (not (stringp (%cadr o))))
2206                     (bad-option o)))
2207                  (t (bad-option o)))))))
2208    (when method-class
2209      (dolist (m methods)
2210        (push `(:method-class ,method-class) (cddr m))))
2211    (when declarations
2212      (setq options `((:declarations ,declarations) ,@options)))
2213    (values method-combination generic-function-class options methods)))
2214
2215                 
2216(defmacro def-aux-init-functions (class &rest functions)
2217  `(set-aux-init-functions ',class (list ,@functions)))
2218
2219
2220
2221
2222
2223
2224;;; A powerful way of defining REPORT-CONDITION...
2225;;; Do they really expect that each condition type has a unique method on PRINT-OBJECT
2226;;; which tests *print-escape* ?  Scary if so ...
2227
2228(defmacro define-condition (name (&rest supers) (&rest slots) &body options)
2229  "DEFINE-CONDITION Name (Parent-Type*) (Slot-Spec*) Option*
2230   Define NAME as a condition type. This new type inherits slots and its
2231   report function from the specified PARENT-TYPEs. A slot spec is a list of:
2232     (slot-name :reader <rname> :initarg <iname> {Option Value}*
2233
2234   The DEFINE-CLASS slot options :ALLOCATION, :INITFORM, [slot] :DOCUMENTATION
2235   and :TYPE and the overall options :DEFAULT-INITARGS and
2236   [type] :DOCUMENTATION are also allowed.
2237
2238   The :REPORT option is peculiar to DEFINE-CONDITION. Its argument is either
2239   a string or a two-argument lambda or function name. If a function, the
2240   function is called with the condition and stream to report the condition.
2241   If a string, the string is printed.
2242
2243   Condition types are classes, but (as allowed by ANSI and not as described in
2244   CLtL2) are neither STANDARD-OBJECTs nor STRUCTURE-OBJECTs. WITH-SLOTS and
2245   SLOT-VALUE may not be used on condition objects."
2246  ; If we could tell what environment we're being expanded in, we'd
2247  ; probably want to check to ensure that all supers name conditions
2248  ; in that environment.
2249  (let ((classopts nil)
2250        (duplicate nil)
2251        (docp nil)
2252        (default-initargs-p nil)
2253        (reporter nil))
2254    (dolist (option options)
2255      (unless (and (consp option)
2256                   (consp (%cdr option)))
2257        (signal-program-error "Invalid option ~s ." option))
2258      (ecase (%car option)
2259        (:default-initargs 
2260            (unless (plistp (cdr option)) 
2261              (signal-program-error "~S is not a plist." (%cdr option))) 
2262            (if default-initargs-p 
2263              (setq duplicate t) 
2264              (push (setq default-initargs-p option) classopts))) 
2265        (:documentation 
2266         (unless (null (%cddr option)) 
2267           (signal-program-error "Invalid option ~s ." option)) 
2268         (if docp
2269           (setq duplicate t)
2270           (push (setq docp option) classopts)))
2271        (:report 
2272         (unless (null (%cddr option)) 
2273           (signal-program-error "Invalid option ~s ." option)) 
2274         (if reporter
2275           (setq duplicate t)
2276           (progn
2277             (if (or (lambda-expression-p (setq reporter (%cadr option)))
2278                     (symbolp reporter))
2279               (setq reporter `(function ,reporter))
2280               (if (stringp reporter)
2281                 (setq reporter `(function (lambda (c s) (declare (ignore c)) (write-string ,reporter s))))
2282                 (signal-program-error "~a expression is not a string, symbol, or lambda expression ." (%car option))))
2283             (setq reporter `((defmethod report-condition ((c ,name) s)
2284                                (funcall ,reporter c s))))))))
2285      (if duplicate (signal-program-error "Duplicate option ~s ." option)))
2286    `(progn
2287       (defclass ,name ,(or supers '(condition)) ,slots ,@classopts)
2288       ,@reporter
2289       ',name)))
2290
2291(defmacro with-condition-restarts (&environment env condition restarts &body body)
2292  "Evaluates the BODY in a dynamic environment where the restarts in the list
2293   RESTARTS-FORM are associated with the condition returned by CONDITION-FORM.
2294   This allows FIND-RESTART, etc., to recognize restarts that are not related
2295   to the error currently being debugged. See also RESTART-CASE."
2296  (multiple-value-bind (body decls)
2297                       (parse-body body env)
2298    (let ((cond (gensym))
2299          (r (gensym)))
2300          `(let* ((*condition-restarts* *condition-restarts*))
2301             ,@decls
2302             (let ((,cond ,condition))
2303               (dolist (,r ,restarts) (push (cons ,r ,cond) *condition-restarts*))
2304               ,@body)))))
2305 
2306(defmacro setf-find-class (name arg1 &optional (arg2 () 2-p) (arg3 () 3-p))
2307  (cond (3-p ;might want to pass env (arg2) to find-class someday?
2308         `(set-find-class ,name (progn ,arg1 ,arg2 ,arg3)))
2309        (2-p
2310         `(set-find-class ,name (progn ,arg1 ,arg2)))
2311        (t `(set-find-class ,name ,arg1))))
2312
2313(defsetf find-class setf-find-class)
2314
2315(defmacro restoring-interrupt-level (var &body body)
2316  `(unwind-protect
2317    (progn ,@body)
2318    (restore-interrupt-level ,var)
2319    (%interrupt-poll)))
2320
2321(defmacro without-interrupts (&body body)
2322  "Evaluate its body in an environment in which process-interrupt
2323requests are deferred."
2324  `(let* ((*interrupt-level* -1))
2325    ,@body))
2326
2327(defmacro with-interrupts-enabled (&body body)
2328  "Evaluate its body in an environment in which process-interrupt
2329has immediate effect."
2330  `(let* ((*interrupt-level* 0))
2331    ,@body))
2332
2333;;; undoes the effect of one enclosing without-interrupts during execution of body.
2334(defmacro ignoring-without-interrupts (&body body)
2335  `(let* ((*interrupt-level* 0))
2336    ,@body))
2337
2338
2339
2340(defmacro error-ignoring-without-interrupts (format-string &rest format-args)
2341  `(ignoring-without-interrupts
2342    (error ,format-string ,@format-args)))
2343
2344
2345;init-list-default: if there is no init pair for <keyword>,
2346;    add a <keyword> <value> pair to init-list
2347(defmacro init-list-default (the-init-list &rest args)
2348  (let ((result)
2349       (init-list-sym (gensym)))
2350   (do ((args args (cddr args)))
2351       ((not args))
2352     (setq result 
2353           (cons `(if (eq '%novalue (getf ,init-list-sym ,(car args) 
2354                                          '%novalue))
2355                    (setq ,init-list-sym (cons ,(car args) 
2356                                               (cons ,(cadr args) 
2357                                                     ,init-list-sym))))
2358                 result)))                                                                               
2359   `(let ((,init-list-sym ,the-init-list))
2360      (progn ,@result)
2361      ,init-list-sym)
2362   ))
2363
2364; This can only be partially backward-compatible: even if only
2365; the "name" arg is supplied, the old function would create the
2366; package if it didn't exist.
2367; Should see how well this works & maybe flush the whole idea.
2368
2369(defmacro in-package (name)
2370  (let ((form nil))
2371    (when (quoted-form-p name)
2372      (warn "Unquoting argument ~S to ~S." name 'in-package )
2373      (setq name (cadr name)))   
2374    (setq form `(set-package ,(string name)))
2375    `(eval-when (:execute :load-toplevel :compile-toplevel)
2376      ,form)))
2377
2378(defmacro defpackage (name &rest options)
2379  "Defines a new package called PACKAGE. Each of OPTIONS should be one of the
2380   following:
2381    (NICKNAMES {package-name}*)
2382
2383    (SIZE <integer>)
2384    (SHADOW {symbol-name}*)
2385    (SHADOWING-IMPORT-FROM <package-name> {symbol-name}*)
2386    (USE {package-name}*)
2387    (IMPORT-FROM <package-name> {symbol-name}*)
2388    (INTERN {symbol-name}*)
2389    (EXPORT {symbol-name}*)
2390    (IMPLEMENT {package-name}*)
2391    (LOCK boolean)
2392    (DOCUMENTATION doc-string)
2393   All options except SIZE, LOCK, and :DOCUMENTATION can be used multiple
2394   times."
2395  (let* ((size nil)
2396         (all-names-size 0)
2397         (intern-export-size 0)
2398         (shadow-etc-size 0)
2399         (documentation nil)
2400         (all-names-hash (let ((all-options-alist nil))
2401                           (dolist (option options)
2402                             (let ((option-name (car option)))
2403                               (when (memq option-name
2404                                           '(:nicknames :shadow :shadowing-import-from
2405                                             :use :import-from :intern :export))
2406                                 (let ((option-size (length (cdr option)))
2407                                       (cell (assq option-name all-options-alist)))
2408                                   (declare (fixnum option-size))
2409                                   (if cell
2410                                     (incf (cdr cell) option-size)
2411                                     (push (cons option-name option-size) all-options-alist))
2412                                   (when (memq option-name '(:shadow :shadowing-import-from :import-from :intern))
2413                                     (incf shadow-etc-size option-size))
2414                                   (when (memq option-name '(:export :intern))
2415                                     (incf intern-export-size option-size))))))
2416                           (dolist (cell all-options-alist)
2417                             (let ((option-size (cdr cell)))
2418                               (when (> option-size all-names-size)
2419                                 (setq all-names-size option-size))))
2420                           (when (> all-names-size 0)
2421                             (make-hash-table :test 'equal :size all-names-size))))
2422         (intern-export-hash (when (> intern-export-size 0)
2423                               (make-hash-table :test 'equal :size intern-export-size)))
2424         (shadow-etc-hash (when (> shadow-etc-size 0)
2425                            (make-hash-table :test 'equal :size shadow-etc-size)))
2426         (external-size nil)
2427         (nicknames nil)
2428         (shadow nil)
2429         (shadowing-import-from-specs nil)
2430         (use :default)
2431         (import-from-specs nil)
2432         (intern nil)
2433         (export nil))
2434    (declare (fixnum all-names-size intern-export-size shadow-etc-size))
2435    (labels ((string-or-name (s) (string s))
2436             (duplicate-option (o)
2437               (signal-program-error "Duplicate ~S option in ~S ." o options))
2438             (duplicate-name (name option-name)
2439               (signal-program-error "Name ~s, used in ~s option, is already used in a conflicting option ." name option-name))
2440             (all-names (option-name tail already)
2441               (when (eq already :default) (setq already nil))
2442               (when all-names-hash
2443                 (clrhash all-names-hash))
2444               (dolist (name already)
2445                 (setf (gethash (string-or-name name) all-names-hash) t))
2446               (dolist (name tail already)
2447                 (setq name (string-or-name name))
2448                 (unless (gethash name all-names-hash)          ; Ok to repeat name in same option.
2449                   (when (memq option-name '(:shadow :shadowing-import-from :import-from :intern))
2450                     (if (gethash name shadow-etc-hash)
2451                       (duplicate-name name option-name))
2452                     (setf (gethash name shadow-etc-hash) t))
2453                   (when (memq option-name '(:export :intern))
2454                     (if (gethash name intern-export-hash)
2455                       (duplicate-name name option-name))
2456                     (setf (gethash name intern-export-hash) t))
2457                   (setf (gethash name all-names-hash) t)
2458                   (push name already)))))
2459      (dolist (option options)
2460        (let ((args (cdr option)))
2461          (ecase (%car option)
2462                 (:size 
2463                  (if size 
2464                    (duplicate-option :size) 
2465                    (setq size (car args))))             
2466                 (:external-size 
2467                  (if external-size 
2468                    (duplicate-option :external-size) 
2469                    (setq external-size (car args))))
2470                 (:nicknames (setq nicknames (all-names nil args nicknames)))
2471                 (:shadow (setq shadow (all-names :shadow args shadow)))
2472                 (:shadowing-import-from
2473                  (destructuring-bind (from &rest shadowing-imports) args
2474                    (push (cons (string-or-name from)
2475                                (all-names :shadowing-import-from shadowing-imports nil))
2476                          shadowing-import-from-specs)))
2477                 (:use (setq use (all-names nil args use)))
2478                 (:import-from
2479                  (destructuring-bind (from &rest imports) args
2480                    (push (cons (string-or-name from)
2481                                (all-names :import-from imports nil))
2482                          import-from-specs)))
2483                 (:intern (setq intern (all-names :intern args intern)))
2484                 (:export (setq export (all-names :export args export)))
2485                 (:documentation
2486                  (if documentation
2487                    (duplicate-option :documentation)
2488                    (setq documentation (cadr option)))))))
2489      `(eval-when (:execute :compile-toplevel :load-toplevel)
2490         (%define-package ',(string-or-name name)
2491          ',size 
2492          ',external-size 
2493          ',nicknames
2494          ',shadow
2495          ',shadowing-import-from-specs
2496          ',use
2497          ',import-from-specs
2498          ',intern
2499          ',export
2500          ',documentation)))))
2501
2502
2503
2504(defmacro with-package-iterator ((mname package-list first-type &rest other-types)
2505                                 &body body)
2506  "Within the lexical scope of the body forms, MNAME is defined via macrolet
2507   such that successive invocations of (MNAME) will return the symbols,
2508   one by one, from the packages in PACKAGE-LIST. SYMBOL-TYPES may be
2509   any of :INHERITED :EXTERNAL :INTERNAL."
2510  (setq mname (require-type mname 'symbol))
2511  (let ((state (make-symbol "WITH-PACKAGE-ITERATOR_STATE")))
2512    (dolist (type (push first-type other-types))
2513      (ecase type
2514        ((:external :internal :inherited))))
2515    `(let ((,state (%setup-pkg-iter-state ,package-list ',other-types)))
2516       (macrolet ((,mname () `(%pkg-iter-next ,',state)))
2517         ,@body))))
2518
2519; Does NOT evaluate the constructor, but DOES evaluate the destructor & initializer
2520(defmacro defresource (name &key constructor destructor initializer)
2521  `(defparameter ,name (make-resource #'(lambda () ,constructor)
2522                                      ,@(when destructor
2523                                          `(:destructor ,destructor))
2524                                      ,@(when initializer
2525                                          `(:initializer ,initializer)))))
2526
2527(defmacro using-resource ((var resource) &body body)
2528  (let ((resource-var (gensym)))
2529  `(let ((,resource-var ,resource)
2530         ,var)
2531     (unwind-protect
2532       (progn
2533         (setq ,var (allocate-resource ,resource-var))
2534         ,@body)
2535       (when ,var
2536         (free-resource ,resource-var ,var))))))
2537
2538;;; Bind per-thread specials which help with lock accounting.
2539(defmacro with-lock-context (&body body)
2540  `(progn ,@body))
2541
2542(defmacro with-lock-grabbed ((lock &optional
2543                                   (whostate "Lock"))
2544                             &body body)
2545  "Wait until a given lock can be obtained, then evaluate its body with
2546the lock held."
2547  (declare (ignore whostate))
2548    (let* ((locked (gensym))
2549           (l (gensym)))
2550      `  (with-lock-context
2551           (let ((,locked (make-lock-acquisition))
2552             (,l ,lock))
2553        (declare (dynamic-extent ,locked))
2554        (unwind-protect
2555             (progn
2556               (%lock-recursive-lock-object ,l ,locked )
2557               ,@body)
2558          (when (lock-acquisition.status ,locked) (%unlock-recursive-lock-object ,l)))))))
2559
2560(defmacro with-lock-grabbed-maybe ((lock &optional
2561                                         (whostate "Lock"))
2562                                   &body body)
2563  (declare (ignore whostate))
2564  (let* ((l (gensym)))
2565    `(with-lock-context
2566      (let* ((,l ,lock))
2567        (when (%try-recursive-lock-object ,l)
2568          (unwind-protect
2569               (progn ,@body)
2570            (%unlock-recursive-lock-object ,l)))))))
2571
2572(defmacro with-standard-abort-handling (abort-message &body body)
2573  (let ((stream (gensym)))
2574    `(restart-case
2575       (catch :abort
2576         (catch-cancel
2577           ,@body))
2578       (abort () ,@(when abort-message
2579                     `(:report (lambda (,stream)
2580                                 (write-string ,abort-message ,stream)))))
2581       (abort-break ()))))
2582       
2583
2584
2585
2586(defmacro %lexpr-count (l)
2587  `(%lisp-word-ref ,l 0))
2588
2589(defmacro %lexpr-ref (lexpr count i)
2590  `(%lisp-word-ref ,lexpr (%i- ,count ,i)))
2591
2592;;; args will be list if old style clos
2593(defmacro apply-with-method-context (magic function args)
2594  (let ((m (gensym))
2595        (f (gensym))
2596        (as (gensym)))
2597      `((lambda (,m ,f ,as)
2598          (if (listp ,as)
2599            (%apply-with-method-context ,m ,f ,as)
2600            (%apply-lexpr-with-method-context ,m ,f ,as))) ,magic ,function ,args)))
2601
2602(defmacro defcallback (name arglist &body body &environment env)
2603  "Proclaim name to be a special variable; sets its value to a MACPTR which,
2604when called by foreign code, calls a lisp function which expects foreign
2605arguments of the specified types and which returns a foreign value of the
2606specified result type. Any argument variables which correspond to foreign
2607arguments of type :ADDRESS are bound to stack-allocated MACPTRs.
2608
2609If name is already a callback function pointer, its value is not changed;
2610instead, it's arranged that an updated version of the lisp callback function
2611will be called. This feature allows for callback functions to be redefined
2612incrementally, just like Lisp functions are.
2613
2614defcallback returns the callback pointer, e.g., the value of name."
2615  (define-callback name arglist body env))
2616
2617(declare-arch-specific-macro %get-single-float-from-double-ptr)
2618
2619(declare-arch-specific-macro lfun-vector)
2620(declare-arch-specific-macro lfun-vector-lfun)
2621
2622(declare-arch-specific-macro symptr->symvector)
2623(declare-arch-specific-macro symvector->symptr)
2624
2625(declare-arch-specific-macro function-to-function-vector)
2626(declare-arch-specific-macro function-vector-to-function)
2627
2628(declare-arch-specific-macro with-ffcall-results)
2629
2630(defvar *trace-print-functions* nil)
2631(defun %trace-print-arg (stream arg val type)
2632  (format stream " ")
2633  (let ((fn (assoc type *trace-print-functions*)))
2634    (if fn
2635      (funcall (cdr fn) stream arg val)
2636      (progn
2637      (when arg
2638        (format stream "~A = " arg))
2639      (if (and type (not (eq type :void)))
2640          (format stream "[:~A] ~A~%" type val)
2641        (format stream ":VOID~%"))))))
2642
2643(defun def-trace-print-function (type fn)
2644  (push (cons type fn) *trace-print-functions*))
2645
2646(defun define-callback (name args body env)
2647  (let* ((stack-word (gensym))
2648         (stack-ptr (gensym))
2649         (fp-args-ptr (gensym))
2650         (result-type-spec :void)
2651         (args args)
2652         (discard-stack-args nil)       ;only meaningful on win32
2653         (discard-hidden-arg nil)       ;only meaningful on x8632
2654         (info nil)
2655         (woi nil)
2656         (need-struct-arg)
2657         (struct-return-arg-name)
2658         (error-return nil))
2659    (collect ((arg-names)
2660              (arg-specs))
2661      (let* ((spec (car (last args)))
2662             (rtype (ignore-errors (parse-foreign-type spec))))
2663        (setq need-struct-arg (typep rtype 'foreign-record-type))
2664        (when need-struct-arg
2665          (setq discard-hidden-arg
2666                (funcall (ftd-ff-call-struct-return-by-implicit-arg-function
2667                          *target-ftd*) rtype)))
2668        (if rtype
2669          (setq result-type-spec spec args (butlast args))))
2670      (loop
2671        (when (null args) (return))
2672        (if (eq (car args) :without-interrupts)
2673          (setq woi (cadr args) args (cddr args))
2674          (if (eq (car args) :discard-stack-args)
2675            (setq discard-stack-args (eq (backend-target-os *target-backend*) :win32) args (cdr args))
2676            (if (eq (car args) :error-return)
2677              (setq error-return
2678                    (cadr args)                 
2679                    args (cddr args))
2680              (if need-struct-arg
2681                (setq struct-return-arg-name (pop args) need-struct-arg nil)
2682                (progn
2683                  (arg-specs (pop args))
2684                  (arg-names (pop args))))))))
2685      (multiple-value-bind (rlets lets dynamic-extent-names inits foreign-return-type fp-args-form error-return-offset num-arg-bytes)
2686          (funcall (ftd-callback-bindings-function *target-ftd*)
2687                   stack-ptr fp-args-ptr (arg-names) (arg-specs) result-type-spec struct-return-arg-name)
2688        ;; x8632 hair
2689        (when discard-hidden-arg
2690          (if discard-stack-args
2691            ;; We already have to discard some number of args, so just
2692            ;; discard the extra hidden arg while we're at it.
2693            (incf num-arg-bytes 4)
2694            ;; Otherwise, indicate that we'll need to discard the
2695            ;; hidden arg.
2696            (setq info (ash 1 23))))
2697        (when discard-stack-args
2698          (setq info 0)
2699          ;; put number of words to discard in high-order byte
2700          (setf (ldb (byte 8 24) info)
2701                (ash num-arg-bytes (- target::word-shift))))
2702        (multiple-value-bind (body decls doc) (parse-body body env t)
2703          `(progn
2704            (declaim (special ,name))
2705            (define-callback-function
2706                (nfunction ,name
2707                 (lambda (,stack-word)
2708                   (declare (ignorable ,stack-word))
2709                   (block ,name
2710                     (with-macptrs ((,stack-ptr))
2711                       (%setf-macptr-to-object ,stack-ptr ,stack-word)
2712                       (with-macptrs (,@(when fp-args-form
2713                                              `((,fp-args-ptr ,fp-args-form))))
2714                         ,(defcallback-body stack-ptr
2715                                            fp-args-ptr
2716                                            lets
2717                                            rlets
2718                                            inits
2719                                            `(declare (dynamic-extent ,@dynamic-extent-names))
2720                                            decls
2721                                            body
2722                                            foreign-return-type
2723                                            struct-return-arg-name
2724                                            error-return
2725                                            error-return-offset
2726                                            ))))))
2727                ,doc
2728              ,woi
2729              ,info)))))))
2730
2731
2732(defun defcallback-body (&rest args)
2733  (declare (dynamic-extent args))
2734  (destructuring-bind (stack-ptr fp-args-ptr lets rlets inits dynamic-extent-decls other-decls body return-type struct-return-arg error-return error-delta) args
2735    (declare (ignorable dynamic-extent-decls))
2736    (let* ((condition-name (if (atom error-return) 'error (car error-return)))
2737           (error-return-function (if (atom error-return) error-return (cadr error-return)))
2738           (result (if struct-return-arg (gensym)))
2739           (body
2740            `(rlet ,rlets
2741              (let ,lets
2742                ,dynamic-extent-decls
2743                ,@other-decls
2744                ,@inits
2745                ,(if result
2746                     `(let* ((,result ,@body))
2747                       (declare (dynamic-extent ,result)
2748                                (ignorable ,result))
2749                       ,(funcall (ftd-callback-return-value-function *target-ftd*)
2750                              stack-ptr
2751                              fp-args-ptr
2752                              result
2753                              return-type
2754                              struct-return-arg))
2755                     (if (eq return-type *void-foreign-type*)
2756                       `(progn ,@body)
2757                       (funcall (ftd-callback-return-value-function *target-ftd*)
2758                                stack-ptr
2759                                fp-args-ptr
2760                                `(progn ,@body)
2761                                return-type
2762                                struct-return-arg)))
2763                nil))))
2764      (if error-return
2765        (let* ((cond (gensym))
2766               (block (gensym))
2767               (handler (gensym)))
2768          `(block ,block
2769            (let* ((,handler (lambda (,cond)
2770                               (,error-return-function ,cond ,stack-ptr (%inc-ptr ,stack-ptr ,error-delta))
2771                               (return-from ,block
2772                                 nil))))
2773              (declare (dynamic-extent ,handler))
2774              (handler-bind ((,condition-name ,handler))
2775                (values ,body)))))
2776        body))))
2777
2778
2779(defmacro define-toplevel-command (group-name name arglist &body body &environment env)
2780  (let* ((key (make-keyword name)))
2781    (multiple-value-bind (body decls doc) (parse-body body env)
2782      `(%define-toplevel-command ',group-name ,key ',name 
2783        (nfunction ,name (lambda ,arglist
2784                           ,@decls
2785                           (block ,name
2786                             ,@body)))
2787        ,doc
2788        ',(mapcar #'symbol-name arglist)))))
2789
2790(defmacro with-toplevel-commands (group-name &body body)
2791  `(let* ((*active-toplevel-commands* *active-toplevel-commands*))
2792    (progn
2793      (%use-toplevel-commands ',group-name)
2794      ,@body)))
2795
2796(defmacro assert (test-form &optional (places ()) string &rest args)
2797  "ASSERT Test-Form [(Place*) [String Arg*]]
2798  If the Test-Form is not true, then signal a correctable error.  If Places
2799  are specified, then new values are prompted for when the error is proceeded.
2800  String and Args are the format string and args to the error call."
2801  (let* ((TOP (gensym))
2802         (setf-places-p (not (null places))))
2803    `(without-compiling-code-coverage
2804      (tagbody
2805       ,TOP
2806       (unless ,test-form
2807         (%assertion-failure ,setf-places-p ',test-form ,string ,@args)
2808         ,@(if places
2809             `((write-line "Type expressions to set places to, or nothing to leave them alone."
2810                           *query-io*)
2811               ,@(mapcar #'(lambda (place &aux (new-val (gensym))
2812                                          (set-p (gensym)))
2813                             `(multiple-value-bind
2814                                (,new-val ,set-p)
2815                                (assertion-value-prompt ',place)
2816                                (when ,set-p (setf ,place (values-list ,new-val)))))
2817                         places)))
2818         (go ,TOP))))))
2819
2820
2821(defmacro check-type (place typespec &optional string)
2822  "CHECK-TYPE Place Typespec [String]
2823  Signal a restartable error of type TYPE-ERROR if the value of PLACE is
2824  not of the specified type. If an error is signalled and the restart is
2825  used to return, this can only return if the STORE-VALUE restart is
2826  invoked. In that case it will store into PLACE and start over."
2827  (let* ((val (gensym)))
2828    `(without-compiling-code-coverage
2829      (do* ((,val ,place ,place))
2830          ((typep ,val ',typespec))
2831       (setf ,place (%check-type ,val ',typespec ',place ,string))))))
2832
2833(defmacro typecheck (object typespec &environment env)
2834  (cond ((eq typespec 't)
2835         object)
2836        ((nx-inhibit-safety-checking env)
2837         `(the ,typespec ,object))
2838        (t
2839        `(require-type ,object ',(nx1-typespec-for-typep typespec env
2840                                                          :whine nil)))))
2841
2842(defmacro structure-typecheck (struct typespec &environment env)
2843  (if (nx-strict-structure-typechecking env)
2844    `(require-type ,struct ',(nx1-typespec-for-typep typespec env
2845                                                          :whine nil))
2846    `(the ,typespec ,struct)))
2847     
2848
2849(defmacro with-hash-table-iterator ((mname hash-table) &body body)
2850  "WITH-HASH-TABLE-ITERATOR ((function hash-table) &body body)
2851   provides a method of manually looping over the elements of a hash-table.
2852   FUNCTION is bound to a generator-macro that, within the scope of the
2853   invocation, returns one or three values. The first value tells whether
2854   any objects remain in the hash table. When the first value is non-NIL,
2855   the second and third values are the key and the value of the next object."
2856  (let* ((hash (gensym))
2857         (keys (gensym))
2858         (values (gensym))
2859         (count (gensym))
2860         (state (gensym)))
2861    `(let* ((,hash ,hash-table)
2862            (,count (hash-table-count ,hash))
2863            (,keys (make-array ,count))
2864            (,values (make-array ,count))
2865            (,state (vector ,hash 0 ,keys ,values (enumerate-hash-keys-and-values ,hash ,keys ,values))))
2866      (declare (dynamic-extent ,keys ,state)
2867               (fixnum ,count))
2868      (macrolet ((,mname () `(next-hash-table-iteration-1 ,',state)))
2869        ,@body))))
2870
2871
2872(eval-when (compile load eval)
2873(defmacro pprint-logical-block ((stream-symbol list
2874                                 &key (prefix "" prefixp)
2875                                      (per-line-prefix "" per-line-prefix-p)
2876                                      (suffix "" suffixp))
2877                                &body body)
2878  (cond ((eq stream-symbol nil) (setq stream-symbol '*standard-output*))
2879        ((eq stream-symbol T) (setq stream-symbol '*terminal-io*)))
2880  (when (not (symbolp stream-symbol))
2881    (warn "STREAM-SYMBOL arg ~S to PPRINT-LOGICAL-BLOCK is not a bindable symbol"
2882          stream-symbol)
2883    (setq stream-symbol '*standard-output*))
2884  (when (and prefixp per-line-prefix-p)
2885    (warn "prefix ~S and per-line-prefix ~S cannot both be specified ~
2886           in PPRINT-LOGICAL-BLOCK" prefix per-line-prefix)
2887    (setq per-line-prefix nil))
2888  `(let ((*logical-block-p* t))
2889     (maybe-initiate-xp-printing
2890      #'(lambda (,stream-symbol)
2891          (let ((+l ,list)
2892                (+p (or (and ,prefixp
2893                             (require-type ,prefix 'string))
2894                        (and ,per-line-prefix-p
2895                             (require-type ,per-line-prefix 'string))))
2896                (+s (require-type ,suffix 'string)))
2897            (pprint-logical-block+
2898                (,stream-symbol +l +p +s ,per-line-prefix-p T nil)
2899              ,@ body nil)))
2900      (decode-stream-arg ,stream-symbol))))
2901
2902
2903;Assumes var and args must be variables.  Other arguments must be literals or variables.
2904
2905(defmacro pprint-logical-block+ ((var args prefix suffix per-line? circle-check? atsign?)
2906                                 &body body)
2907  "Group some output into a logical block. STREAM-SYMBOL should be either a
2908   stream, T (for *TERMINAL-IO*), or NIL (for *STANDARD-OUTPUT*). The printer
2909   control variable *PRINT-LEVEL* is automatically handled."
2910  (when (and circle-check? atsign?)
2911    (setq circle-check? 'not-first-p))
2912  `(let ((*current-level* (1+ *current-level*))
2913         (*current-length* -1)
2914         ;(*parents* *parents*)
2915         ,@(if (and circle-check? atsign?) `((not-first-p (plusp *current-length*)))))
2916     (unless (check-block-abbreviation ,var ,args ,circle-check?)
2917       (start-block ,var ,prefix ,per-line? ,suffix)
2918       (when
2919         (catch 'line-limit-abbreviation-exit
2920           (block logical-block
2921             (macrolet ((pprint-pop () `(pprint-pop+ ,',args ,',var))
2922                        (pprint-exit-if-list-exhausted ()
2923                          `(if (null ,',args) (return-from logical-block nil))))
2924               ,@ body))
2925           (end-block ,var ,suffix)
2926           nil)
2927         (end-block ,var ,suffix)
2928         (throw 'line-limit-abbreviation-exit T)))))
2929) ; eval-when
2930
2931(defmacro %old-class-local-shared-slotds (class &optional default)
2932  (if default                           ; so setf works
2933    `(%class-get ,class '%old-class-local-shared-slotds ,default)
2934    `(%class-get ,class '%old-class-local-shared-slotds)))
2935
2936(defmacro with-slot-values (slot-entries instance-form &body body)
2937; Simplified form of with-slots.  Expands into a let instead of a symbol-macrolet
2938; Thus, you can access the slot values, but you can't setq them.
2939  (let ((instance (gensym)) var slot-name bindings)
2940    (dolist (slot-entry slot-entries)
2941      (cond ((symbolp slot-entry)
2942             (setq var slot-entry slot-name slot-entry))
2943            ((and (listp slot-entry) (cdr slot-entry) (null (cddr slot-entry))
2944                  (symbolp (car slot-entry)) (symbolp (cadr slot-entry)))
2945             (setq var (car slot-entry) slot-name (cadr slot-entry)))
2946            (t (signal-program-error "Malformed slot-entry: ~a to with-slot-values.~@
2947                                      Should be a symbol or a list of two symbols."
2948                                     slot-entry)))
2949      (push `(,var (slot-value ,instance ',slot-name)) bindings))
2950    `(let ((,instance ,instance-form))
2951       (let ,(nreverse bindings)
2952         ,@body))))
2953
2954(defmacro with-slots (slot-entries instance-form &body body)
2955  "Establish a lexical environment for referring to the slots in the
2956instance named by the given slot-names as though they were variables.
2957Within such a context the value of the slot can be specified by using
2958its slot name, as if it were a lexically bound variable. Both setf and
2959setq can be used to set the value of the slot."
2960  (let ((instance (gensym)) var slot-name bindings)
2961    (dolist (slot-entry slot-entries)
2962      (cond ((symbolp slot-entry)
2963             (setq var slot-entry slot-name slot-entry))
2964            ((and (listp slot-entry) (cdr slot-entry) (null (cddr slot-entry))
2965                  (symbolp (car slot-entry)) (symbolp (cadr slot-entry)))
2966             (setq var (car slot-entry) slot-name (cadr slot-entry)))
2967            (t (signal-program-error "Malformed slot-entry: ~a to with-slots.~@
2968                                      Should be a symbol or a list of two symbols."
2969                                     slot-entry)))
2970      (push `(,var (slot-value ,instance ',slot-name)) bindings))
2971    `(let ((,instance ,instance-form))
2972       ,@(if bindings 
2973             (list `(declare (ignorable ,instance)))
2974             (list `(declare (ignore ,instance))))
2975       (symbol-macrolet ,(nreverse bindings)
2976         ,@body))))
2977
2978(defmacro with-accessors (slot-entries instance-form &body body)
2979  "Create a lexical environment in which the slots specified by slot-entry
2980are lexically available through their accessors as if they were variables.
2981The appropriate accessors are invoked to access the slots specified by
2982slot-entry. Both setf and setq can be used to set the value of the slot."
2983  (let ((instance (gensym)) var reader bindings)
2984    (dolist (slot-entry slot-entries)
2985      (cond ((and (listp slot-entry) (cdr slot-entry) (null (cddr slot-entry))
2986                  (symbolp (car slot-entry)) (symbolp (cadr slot-entry)))
2987             (setq var (car slot-entry) reader (cadr slot-entry)))
2988            (t (signal-program-error "Malformed slot-entry: ~a to with-accessors.~@
2989                                     Should be a list of two symbols."
2990                                     slot-entry)))
2991      (push `(,var (,reader ,instance)) bindings))
2992    `(let ((,instance ,instance-form))
2993       ,@(if bindings 
2994             (list `(declare (ignorable ,instance)))
2995             (list `(declare (ignore ,instance))))
2996       (symbol-macrolet ,(nreverse bindings)
2997         ,@body))))
2998
2999; I wanted to call this ":method"
3000(defmacro reference-method (gf &rest qualifiers-and-specializers)
3001  (let ((qualifiers (butlast qualifiers-and-specializers))
3002        (specializers (car (last qualifiers-and-specializers))))
3003    (if (null specializers) (report-bad-arg qualifiers-and-specializers '(not null)))
3004    `(find-method #',gf ',qualifiers (mapcar #'find-specializer ',specializers))))
3005
3006(defmacro time (form)
3007  "Execute FORM and print timing information on *TRACE-OUTPUT*."
3008  `(report-time ',form #'(lambda () (progn ,form))))
3009
3010(defmacro with-error-reentry-detection (&body body)
3011  (let ((thunk (gensym)))
3012    `(let ((,thunk #'(lambda () ,@body)))
3013       (declare (dynamic-extent ,thunk))
3014       (funcall-with-error-reentry-detection ,thunk))))
3015
3016(defmacro without-duplicate-definition-warnings (&body body)
3017  `(compiler-let ((*compiler-warn-on-duplicate-definitions* nil))
3018     ,@body))
3019
3020
3021#+ppc-target
3022(defmacro scan-for-instr (mask opcode fn pc-index &optional (tries *trap-lookup-tries*))
3023  `(%scan-for-instr ,mask ,opcode ,fn ,pc-index ,tries))
3024
3025
3026(declare-arch-specific-macro codevec-header-p)
3027
3028#+ppc-target
3029(defmacro match-instr (instr mask bits-to-match)
3030  `(eql (logand ,instr ,mask) ,bits-to-match))
3031
3032(defmacro with-xp-stack-frames ((xp trap-function &optional stack-frame) &body body)
3033  (let ((thunk (gensym))
3034        (sf (or stack-frame (gensym))))
3035    `(let ((,thunk #'(lambda (&optional ,sf)
3036                       ,@(unless stack-frame `((declare (ignore ,sf))))
3037                       ,@body)))
3038       (declare (dynamic-extent ,thunk))
3039       (funcall-with-xp-stack-frames ,xp ,trap-function ,thunk))))
3040
3041(defmacro signal-eof-error (stream)
3042  `(error 'end-of-file :stream ,stream))
3043
3044(defmacro check-eof (valform stream eof-error-p eof-value)
3045  (let* ((val (gensym)))
3046    `(let ((,val ,valform))
3047      (if (eq ,val :eof)
3048        (if ,eof-error-p
3049          (signal-eof-error ,stream)
3050          ,eof-value)
3051        ,val))))
3052
3053(defmacro designated-input-stream (input-stream)
3054  `(if ,input-stream
3055    (if (eq t ,input-stream)
3056      *terminal-io*
3057      ,input-stream)
3058    *standard-input*))
3059
3060(defmacro pref (pointer accessor)
3061  "Reference an instance of a foreign type (or a component of a foreign
3062type) accessible via ptr.
3063
3064Expand into code which references the indicated scalar type or component,
3065or returns a pointer to a composite type."
3066  (let* ((*target-ftd* (backend-target-foreign-type-data *target-backend*)))
3067    (destructuring-bind (type-name &rest accessors) (decompose-record-accessor accessor)
3068      (%foreign-access-form pointer (%foreign-type-or-record type-name) 0 accessors))))
3069
3070(defmacro paref (pointer type-name index)
3071  (let* ((*target-ftd* (backend-target-foreign-type-data *target-backend*)))
3072    (%foreign-array-access-form  pointer (%foreign-type-or-record type-name) index)))
3073
3074;;; Shorter versions for paref of :double, :float arrays
3075(defmacro dparef (pointer index)
3076  `(paref ,pointer :double ,index))
3077
3078(defmacro sparef (pointer index)
3079  `(paref ,pointer :float ,index))
3080
3081(defmacro rref (pointer accessor &key (storage :pointer storage-p))
3082  (when storage-p
3083    (warn "Use of :storage option ignored: ~a" storage))
3084  `(pref ,pointer ,accessor))
3085
3086(defmacro rlet (spec &body body)
3087  "Execute body in an environment in which each var is bound to a MACPTR
3088encapsulating the address of a stack-allocated foreign memory block,
3089allocated and initialized from typespec and initforms as per make-record.
3090Return whatever value(s) body returns."
3091  (let* ((*target-ftd* (backend-target-foreign-type-data *target-backend*)))
3092    `(%stack-block ,(rlet-sizes spec)
3093      ,@(rlet-inits spec)
3094      ,@body)))
3095
3096(defmacro rletz (spec &body body)
3097  "Execute body in an environment in which each var is bound to a MACPTR
3098encapuslating the address of a stack-allocated foreign memory block,
3099allocated and initialized from typespec and initforms as per make-record.
3100Return whatever value(s) body returns.
3101
3102Unlike rlet, record fields that aren't explicitly initialized are set
3103to binary 0."
3104  (let* ((*target-ftd* (backend-target-foreign-type-data *target-backend*)))
3105    `(%stack-block ,(rlet-sizes spec t)
3106      ,@(rlet-inits spec)
3107      ,@body)))
3108
3109(defun rlet-sizes (inits &optional clear-p &aux result)
3110  (dolist (item inits (nreverse result))
3111    (push `(,(car item)
3112            ,(%foreign-type-or-record-size (cadr item) :bytes)
3113            ,@(if clear-p '(:clear t)))
3114          result)))
3115
3116(defun rlet-inits (inits &aux result)
3117  (dolist (item inits result)
3118    (let* ((name (car item))
3119           (record-name (cadr item))
3120           (inits (cddr item))
3121           (ftype (%foreign-type-or-record record-name))
3122           (ordinal (foreign-type-ordinal ftype))
3123           (ordinal-form (if (< ordinal max-canonical-foreign-type-ordinal)
3124                           ordinal
3125                           `(foreign-type-ordinal (load-time-value (%foreign-type-or-record ',record-name))))))
3126      (when (eq *host-backend* *target-backend*)
3127        (setq result (nconc result `((setf (uvref ,name target::macptr.type-cell) ,ordinal-form)))))
3128      (if (typep ftype 'foreign-record-type)
3129        (setq result
3130              (nconc result (%foreign-record-field-forms name ftype record-name inits)))
3131        (progn
3132          (when inits
3133            (if (and ftype (null (cdr inits)))
3134              (setq result
3135                    (nconc result
3136                           `((setf ,(%foreign-access-form name ftype 0 nil)
3137                              ,(car inits)))))
3138              (signal-program-error "Unexpected or malformed initialization forms: ~s in field type: ~s"
3139                                    inits record-name))))))))
3140
3141(defun %foreign-record-field-forms (ptr record-type record-name inits)
3142  (unless (evenp (length inits))
3143    (signal-program-error "Unexpected or malformed initialization forms: ~s in field type: ~s"
3144                          inits record-name))
3145  (let* ((result ()))
3146    (do* ()
3147         ((null inits)
3148          `((progn
3149              ;(%assert-macptr-ftype ,ptr ,record-type)
3150              ,@(nreverse result))))
3151      (let* ((accessor (decompose-record-accessor (pop inits)))
3152             (valform (pop inits)))
3153        (push `(setf ,(%foreign-access-form ptr record-type 0  accessor) ,valform)
3154              result)))))
3155 
3156(defmacro get-field-offset (accessor)
3157  (destructuring-bind (type-name field-name) (decompose-record-accessor accessor)
3158    (let* ((record-type (require-type (%foreign-type-or-record type-name) 'foreign-record-type))
3159           (field (%find-foreign-record-type-field record-type field-name))
3160           (bit-offset (foreign-record-field-offset field)))
3161      `(values ,(floor bit-offset 8) ,(foreign-record-field-type field) ,bit-offset))))
3162
3163(defmacro record-length (recname)
3164  (%foreign-type-or-record-size recname :bytes))
3165
3166(defun make-record-form (record-name allocator &rest initforms)
3167  (let* ((ftype (%foreign-type-or-record record-name))
3168         (ordinal (foreign-type-ordinal ftype))
3169         (ordinal-form (if (< ordinal max-canonical-foreign-type-ordinal)
3170                         ordinal
3171                         `(foreign-type-ordinal (load-time-value (%foreign-type-or-record ',record-name)))))
3172         (bits (ensure-foreign-type-bits ftype))
3173         (bytes (if bits
3174                  (ceiling bits 8)
3175                  (signal-program-error "Unknown size for foreign type ~S."
3176                                        (unparse-foreign-type ftype))))
3177         (p (gensym))
3178         (memset (read-from-string "#_memset")))   
3179    `(let* ((,p (,allocator ,bytes)))
3180      ,@(when (eq *host-backend* *target-backend*)
3181              `((%set-macptr-type ,p ,ordinal-form)))
3182      (,memset ,p 0 ,bytes)
3183      ,@(%foreign-record-field-forms p ftype record-name initforms)
3184      ,p)))
3185 
3186(defmacro make-record (record-name &rest initforms)
3187  "Expand into code which allocates and initalizes an instance of the type
3188denoted by typespec, on the foreign heap. The record is allocated using the
3189C function malloc, and the user of make-record must explicitly call the C
3190function free to deallocate the record, when it is no longer needed."
3191  (apply 'make-record-form record-name 'malloc initforms))
3192
3193(defmacro make-gcable-record (record-name &rest initforms)
3194  "Like MAKE-RECORD, only advises the GC that the foreign memory can
3195   be deallocated if the returned pointer becomes garbage."
3196  (apply 'make-record-form record-name '%new-gcable-ptr initforms))
3197
3198(defmacro copy-record (type source dest)
3199  (let* ((size (* (%foreign-type-or-record-size type :words) #+64-bit-target 1 #+32-bit-target 2))
3200         (src (gensym "SRC"))
3201         (dst (gensym "DST"))
3202         (accessor #+64-bit-target '%get-unsigned-long #+32-bit-target '%get-unsigned-word)
3203         (i (gensym "I"))
3204         (j (gensym "J")))
3205    `(with-macptrs ((,src ,source)
3206                    (,dst ,dest))
3207      (do* ((,i 0 (+ ,i #+64-bit-target 4 #+32-bit-target 2))
3208            (,j 0 (+ ,j 1)))
3209           ((= ,j ,size))
3210        (declare (fixnum ,i))
3211        (setf (,accessor ,dst ,i) (,accessor ,src ,i))))))
3212
3213(defmacro assert-pointer-type (pointer type)
3214  "Assert that the pointer points to an instance of the specified foreign type.
3215Return the pointer."
3216  (let* ((ptr (gensym)))
3217    `(let* ((,ptr ,pointer))
3218      (%set-macptr-type ,ptr (foreign-type-ordinal (load-time-value (parse-foreign-type ',type))))
3219      ,ptr)))
3220
3221(defun with-constrained-values (type specs body env)
3222  (multiple-value-bind (body decls) (parse-body body env)
3223    (collect ((inits))
3224      (dolist (spec specs)
3225        (when (cdr spec)
3226          (inits `(setq ,(car spec) ,(cadr spec)))))       
3227  (let* ((vector (gensym))
3228         (idx -1))
3229    `(let* ((,vector (make-array ,(length specs) :element-type ',type)))
3230      (declare (dynamic-extent ,vector))
3231      (symbol-macrolet ,(mapcar (lambda (spec) `(,(car spec) (aref ,vector ,(incf idx)))) specs)
3232        ,@decls
3233        ,@(inits)
3234        ,@body)))))) 
3235
3236(defmacro with-constrained-double-floats (specs &body body &environment env)
3237  (with-constrained-values 'double-float specs body env))
3238
3239
3240(defmacro with-constrained-single-floats (specs &body body &environment env)
3241  (with-constrained-values 'single-float specs body env))
3242
3243(defmacro with-terminal-input (&body body)
3244  "Execute body in an environment with exclusive read access to the terminal."
3245  (let* ((got-it (gensym)))
3246    `(let* ((,got-it (%request-terminal-input)))
3247      (unwind-protect
3248           (progn ,@body)
3249        (%restore-terminal-input ,got-it)))))
3250
3251
3252(defmacro with-process-whostate ((whostate) &body body)
3253  `(let* ((*whostate* ,whostate))
3254    ,@body))
3255
3256
3257(defmacro with-read-lock ((lock) &body body)
3258  "Wait until a given lock is available for read-only access, then evaluate
3259its body with the lock held."
3260  (let* ((locked (gensym))
3261         (p (gensym)))
3262    `(with-lock-context
3263       (let* ((,locked (make-lock-acquisition))
3264              (,p ,lock))
3265         (declare (dynamic-extent ,locked))
3266         (unwind-protect
3267              (progn
3268                (read-lock-rwlock ,p ,locked)
3269                ,@body)
3270           (when (lock-acquisition.status ,locked) (unlock-rwlock ,p)))))))
3271
3272(defmacro with-write-lock ((lock) &body body)
3273  "Wait until the given lock is available for write access, then execute
3274its body with the lock held."
3275  (let* ((locked (gensym))
3276         (p (gensym)))
3277    `(with-lock-context
3278       (let* ((,locked (make-lock-acquisition))
3279              (,p ,lock))
3280         (declare (dynamic-extent ,locked))
3281         (unwind-protect
3282              (progn
3283                (write-lock-rwlock ,p ,locked)
3284                ,@body)
3285           (when (lock-acquisition.status ,locked) (unlock-rwlock ,p)))))))
3286
3287(defmacro without-gcing (&body body)
3288  `(unwind-protect
3289    (progn
3290      (%lock-gc-lock)
3291      ,@body)
3292    (%unlock-gc-lock)))
3293
3294(defmacro with-deferred-gc (&body body)
3295  "Execute BODY without responding to the signal used to suspend
3296threads for GC.  BODY must be very careful not to do anything which
3297could cause an exception (note that attempting to allocate lisp memory
3298may cause an exception.)"
3299  `(let* ((*interrupt-level* -2))
3300    ,@body))
3301
3302(defmacro allowing-deferred-gc (&body body)
3303  "Within the extent of a surrounding WITH-DEFERRED-GC, allow GC."
3304  `(let* ((*interrupt-level* -1))
3305    (%check-deferred-gc)
3306    ,@body))
3307
3308(defmacro defer-gc ()
3309  `(setq *interrupt-level* -2))
3310
3311
3312(defmacro with-pointer-to-ivector ((ptr ivector) &body body)
3313  "Executes BODY with PTR bound to a pointer to the first byte of data
3314in IVECTOR.  The GC is disabled during execution of BODY; PTR has
3315has dynamic-extent (and the address it references may become invalid
3316after the BODY exits.)  IVECTOR should be a (SIMPLE-ARRAY (*)) whose
3317element-type is numeric."
3318  (let* ((v (gensym)))
3319    `(let* ((,v ,ivector))
3320       (unless (typep ,v 'ivector) (report-bad-arg ,v 'ivector))
3321       (without-gcing
3322         (with-macptrs ((,ptr))
3323           (%vect-data-to-macptr ,v ,ptr)
3324           ,@body)))))
3325     
3326
3327
3328(defmacro with-other-threads-suspended (&body body)
3329  `(unwind-protect
3330    (progn
3331      (%suspend-other-threads)
3332      ,@body)
3333    (%resume-other-threads)))
3334
3335(defmacro with-package-read-lock ((p) &body body)
3336  `(with-read-lock ((pkg.lock ,p)) ,@body))
3337
3338(defmacro with-package-write-lock ((p) &body body)
3339  `(with-write-lock ((pkg.lock ,p)) ,@body))
3340
3341(defmacro with-package-lock ((p) &body body)
3342  `(with-package-write-lock (,p) ,@body))
3343
3344;;; Lock %all-packages-lock%, for shared read access to %all-packages%
3345
3346(defmacro with-package-list-read-lock (&body body)
3347  `(with-read-lock (%all-packages-lock%) ,@body))
3348
3349;;; Lock %all-packages-lock%, to allow modification to %all-packages%
3350(defmacro with-package-list-write-lock (&body body)
3351  `(with-write-lock (%all-packages-lock%) ,@body))
3352
3353(defmacro atomic-incf-decf (place delta &environment env)
3354  (setq place (macroexpand place env))
3355  (if (consp place)
3356    (let* ((sym (car place))
3357           (struct-transform (structref-info sym env)))
3358      (if struct-transform
3359        (setq place (defstruct-ref-transform struct-transform (cdr place) env)
3360              sym (car place)))
3361      (ecase sym
3362        (the `(the ,(cadr place) (atomic-incf-decf ,(caddr place) ,delta)))
3363         ;; Needed so can handle %svref (which macroexpands into a LET*)
3364         ((let let*) (multiple-value-bind (body decls) (parse-body (cddr place) env t)
3365                       (unless (eql (length body) 1)
3366                         (error "~S is not a valid atomic-incf/decf place" place))
3367                       `(,sym ,(cadr place) ,@decls (atomic-incf-decf ,@body ,delta))))
3368         ;; Ditto
3369         (locally (multiple-value-bind (body decls) (parse-body (cdr place) env t)
3370                    (unless (eql (length body) 1)
3371                      (error "~S is not a valid atomic-incf/decf place" place))
3372                    `(,sym ,@decls (atomic-incf-decf ,@body ,delta))))
3373        (car `(%atomic-incf-car ,(cadr place) ,delta))
3374        (cdr `(%atomic-incf-cdr ,(cadr place) ,delta))
3375        (svref `(%atomic-incf-gvector ,@(cdr place) ,delta))))
3376    (if (and (symbolp place) (eq :special (variable-information place env)))
3377      (let* ((base (gensym))
3378             (offset (gensym)))
3379        `(multiple-value-bind (,base ,offset)
3380          (%symbol-binding-address ',place)
3381          (%atomic-incf-node ,delta ,base ,offset)))
3382      (signal-program-error "~S is not a special variable"  place))))
3383   
3384(defmacro atomic-incf (place)
3385  `(atomic-incf-decf ,place 1))
3386
3387(defmacro atomic-decf (place)
3388  `(atomic-incf-decf ,place -1))
3389
3390; Some of these macros were stolen from CMUCL.  Sort of ...
3391
3392(defmacro iterate (name binds &body body)
3393  "Iterate Name ({(Var Initial-Value)}*) Declaration* Form*
3394  This is syntactic sugar for Labels.  It creates a local function Name with
3395  the specified Vars as its arguments and the Declarations and Forms as its
3396  body.  This function is then called with the Initial-Values, and the result
3397  of the call is return from the macro."
3398  (dolist (x binds)
3399    (unless (and (listp x)
3400                 (= (length x) 2))
3401      (signal-program-error "Malformed iterate variable spec: ~S." x)))
3402
3403  `(labels ((,name ,(mapcar #'first binds) ,@body))
3404     (,name ,@(mapcar #'second binds))))
3405
3406;;;; The Collect macro:
3407
3408;;; Collect-Normal-Expander  --  Internal
3409;;;
3410;;;    This function does the real work of macroexpansion for normal collection
3411;;; macros.  N-Value is the name of the variable which holds the current
3412;;; value.  Fun is the function which does collection.  Forms is the list of
3413;;; forms whose values we are supposed to collect.
3414;;;
3415(eval-when (:compile-toplevel :load-toplevel :execute)
3416
3417
3418(defun collect-normal-expander (n-value fun forms)
3419  `(progn
3420     ,@(mapcar #'(lambda (form) `(setq ,n-value (,fun ,form ,n-value))) forms)
3421     ,n-value))
3422
3423
3424)
3425
3426(defmacro once-only (specs &body body)
3427  "Once-Only ({(Var Value-Expression)}*) Form*
3428  Create a Let* which evaluates each Value-Expression, binding a temporary
3429  variable to the result, and wrapping the Let* around the result of the
3430  evaluation of Body.  Within the body, each Var is bound to the corresponding
3431  temporary variable."
3432  (iterate frob
3433           ((specs specs)
3434            (body body))
3435    (if (null specs)
3436      `(progn ,@body)
3437      (let ((spec (first specs)))
3438        (when (/= (length spec) 2)
3439          (signal-program-error "Malformed ~s binding spec: ~S." 'once-only spec))
3440        (let ((name (first spec))
3441              (exp-temp (gensym)))
3442          `(let ((,exp-temp ,(second spec))
3443                 (,name (gensym)))
3444             `(let ((,,name ,,exp-temp))
3445                ,,(frob (rest specs) body))))))))
3446
3447(eval-when (:compile-toplevel :load-toplevel :execute)
3448(defun form-symbol (first &rest others)
3449  (intern (apply #'concatenate 'simple-base-string (string first) (mapcar #'string others))))
3450)
3451
3452
3453;;; Collect-List-Expander  --  Internal
3454;;;
3455;;;    This function deals with the list collection case.  N-Tail is the pointer
3456;;; to the current tail of the list, which is NIL if the list is empty.
3457;;;
3458(defun collect-list-expander (n-value n-tail forms)
3459  (let ((n-res (gensym)))
3460    `(progn
3461       ,@(mapcar #'(lambda (form)
3462                     `(let ((,n-res (cons ,form nil)))
3463                        (cond (,n-tail
3464                               (setf (cdr ,n-tail) ,n-res)
3465                               (setq ,n-tail ,n-res))
3466                              (t
3467                               (setq ,n-tail ,n-res  ,n-value ,n-res)))))
3468                 forms)
3469       ,n-value)))
3470
3471;;;
3472;;;    The ultimate collection macro...
3473;;;
3474
3475(defmacro collect (collections &body body)
3476  "Collect ({(Name [Initial-Value] [Function])}*) {Form}*
3477  Collect some values somehow.  Each of the collections specifies a bunch of
3478  things which collected during the evaluation of the body of the form.  The
3479  name of the collection is used to define a local macro, a la MACROLET.
3480  Within the body, this macro will evaluate each of its arguments and collect
3481  the result, returning the current value after the collection is done.  The
3482  body is evaluated as a PROGN; to get the final values when you are done, just
3483  call the collection macro with no arguments.
3484
3485  Initial-Value is the value that the collection starts out with, which
3486  defaults to NIL.  Function is the function which does the collection.  It is
3487  a function which will accept two arguments: the value to be collected and the
3488  current collection.  The result of the function is made the new value for the
3489  collection.  As a totally magical special-case, the Function may be Collect,
3490  which tells us to build a list in forward order; this is the default.  If an
3491  Initial-Value is supplied for Collect, the stuff will be rplacd'd onto the
3492  end.  Note that Function may be anything that can appear in the functional
3493  position, including macros and lambdas."
3494 
3495 
3496  (let ((macros ())
3497        (binds ()))
3498    (dolist (spec collections)
3499      (unless (<= 1 (length spec) 3)
3500        (signal-program-error "Malformed collection specifier: ~S." spec))
3501      (let ((n-value (gensym))
3502            (name (first spec))
3503            (default (second spec))
3504            (kind (or (third spec) 'collect)))
3505       
3506        (push `(,n-value ,default) binds)
3507        (if (eq kind 'collect)
3508          (let ((n-tail (gensym)))
3509            (if default
3510              (push `(,n-tail (last ,n-value)) binds)
3511              (push n-tail binds))
3512            (push `(,name (&rest args)
3513                          (collect-list-expander ',n-value ',n-tail args))
3514                  macros))
3515          (push `(,name (&rest args)
3516                        (collect-normal-expander ',n-value ',kind args))
3517                macros))))
3518    `(macrolet ,macros (let* ,(nreverse binds) (declare (ignorable ,@binds)) ,@body))))
3519
3520
3521;;; DEFENUM -- Internal Interface.
3522;;;
3523(defmacro defenum ((&key (prefix "") (suffix "") (start 0) (step 1))
3524                   &rest identifiers)
3525  (let ((results nil)
3526        (index 0)
3527        (start (eval start))
3528        (step (eval step)))
3529    (dolist (id identifiers)
3530      (multiple-value-bind
3531        (root docs)
3532        (if (consp id)
3533          (values (car id) (cdr id))
3534          (values id nil))
3535        (push `(defconstant ,(intern (concatenate 'simple-base-string
3536                                                  (string prefix)
3537                                                  (string root)
3538                                                  (string suffix)))
3539                 ,(+ start (* step index))
3540                 ,@docs)
3541              results))
3542      (incf index))
3543    `(eval-when (:compile-toplevel :load-toplevel :execute)
3544       ,@(nreverse results))))
3545
3546
3547;;; This does something like special binding, but the "bindings" established
3548;;; aren't thread-specific.
3549
3550(defmacro let-globally ((&rest vars) &body body &environment env)
3551  (multiple-value-bind (body decls) (parse-body body env)
3552    (let* ((initforms nil)
3553           (psetform nil)
3554           (specvars nil)
3555           (restoreform nil))
3556      (flet ((pair-name-value (p)
3557               (if (atom p)
3558                 (values (require-global-symbol p env) nil)
3559                 (if (and (consp (%cdr p)) (null (%cddr p)))
3560                   (values (require-global-symbol (%car p) env) (%cadr p))
3561                   (signal-program-error "Invalid variable initialization form : ~s")))))
3562        (declare (inline pair-name-value))
3563        (dolist (v vars)
3564          (let* ((oldval (gensym))
3565                 (newval (gensym)))
3566            (multiple-value-bind (var valueform) (pair-name-value v)
3567              (push var specvars)
3568              (push var restoreform)
3569              (push oldval restoreform)
3570              (push `(,oldval (uvref (symptr->symvector ',var) #.target::symbol.vcell-cell)) initforms)
3571              (push `(,newval ,valueform) initforms)
3572              (push var psetform)
3573              (push newval psetform))))
3574        `(let ,(nreverse initforms)
3575           ,@decls
3576           (locally (declare (special ,@(nreverse specvars)))
3577             (unwind-protect
3578               (progn (psetq ,@(nreverse psetform)) ,@body)
3579               (psetq ,@(nreverse restoreform)))))))))
3580;;; From CLX.
3581
3582;;; The good news is that this uses an interlocked load/store sequence
3583;;; and is fairly efficient.
3584;;; The bad news is that it only handles a few types of "place" forms.
3585;;; The good news is that CLX only uses a few types of "place" forms.
3586
3587(defmacro conditional-store (place old-value new-value &environment env)
3588  (setq place (macroexpand place env))
3589  (if (atom place)
3590    ;; CLX uses special variables' value cells as place forms.
3591    (if (and (symbolp place)
3592             (eq :special (ccl::variable-information place env)))
3593      (let* ((base (gensym))
3594             (offset (gensym)))
3595        `(multiple-value-bind (,base ,offset)
3596          (ccl::%symbol-binding-address ',place)
3597          (ccl::%store-node-conditional ,offset ,base ,old-value ,new-value)))
3598      (signal-program-error "~s is not a special variable ." place))
3599    (let* ((sym (car place))
3600           (struct-transform (structref-info sym env)))
3601      (if struct-transform
3602        (setq place (defstruct-ref-transform struct-transform (cdr place) env)
3603              sym (car place)))
3604      (if (member  sym '(svref ccl::%svref ccl::struct-ref))
3605        (let* ((v (gensym)))
3606          `(let* ((,v ,(cadr place)))
3607            (ccl::store-gvector-conditional ,(caddr place)
3608             ,v ,old-value ,new-value)))
3609        (signal-program-error "Don't know how to do conditional store to ~s" place)))))
3610
3611(defmacro step (form)
3612  "The form is evaluated with single stepping enabled. Function calls
3613outside the lexical scope of the form can be stepped into only if the
3614functions in question have been compiled with sufficient DEBUG policy
3615to be at least partially steppable."
3616  form)
3617
3618(defmacro target-arch-case (&rest clauses)
3619  `(case (backend-target-arch-name *target-backend*)
3620    ,@clauses))
3621
3622(defmacro target-os-case (&rest clauses)
3623  `(ecase (backend-target-os *target-backend*)
3624    ,@clauses))
3625
3626(defmacro target-word-size-case (&rest clauses)
3627  `(ecase (arch::target-nbits-in-word (backend-target-arch *target-backend*))
3628    ,@clauses))
3629
3630(defmacro %get-natural (&body body)
3631  "A free copy of the next OpenMCL release to anyone who remembers Flakey Foont"
3632  (target-word-size-case
3633   (32 `(%get-unsigned-long ,@body))
3634   (64 `(%%get-unsigned-longlong ,@body))))
3635
3636(defmacro %get-signed-natural (&body body)
3637  "And that's my final offer."
3638  (target-word-size-case
3639   (32 `(%get-signed-long ,@body))
3640   (64 `(%%get-signed-longlong ,@body))))
3641
3642(declare-arch-specific-macro %target-kernel-global)
3643
3644;;; This behaves like a function, but looks up the kernel global
3645;;; at compile time if possible. Probably should be done as a function
3646;;; and a compiler macro, but we can't define compiler macros yet,
3647;;; and I don't want to add it to "ccl:compiler;optimizers.lisp"
3648(declare-arch-specific-macro %get-kernel-global)
3649
3650(declare-arch-specific-macro %get-kernel-global-ptr)
3651
3652(declare-arch-specific-macro area-code)
3653
3654(declare-arch-specific-macro nth-immediate)
3655
3656(declare-arch-specific-macro set-nth-immediate)
3657
3658(defsetf nth-immediate set-nth-immediate)
3659
3660(defmacro do-consing-areas ((area) &body body)
3661  (let ((code (gensym)))
3662  `(do-gc-areas (,area)
3663     (let ((,code (%fixnum-ref ,area  (area-code))))
3664       (when (or (eql ,code area-readonly)
3665                 (eql ,code area-watched)
3666                 (eql ,code area-managed-static)
3667                 (eql ,code area-static)
3668                 (eql ,code area-dynamic))
3669         ,@body)))))
3670
3671(declare-arch-specific-macro area-succ)
3672
3673
3674(defmacro do-gc-areas ((area) &body body)
3675  (let ((initial-area (gensym)))
3676    `(let* ((,initial-area (%get-kernel-global 'all-areas))
3677            (,area ,initial-area))
3678       (declare (fixnum ,initial-area ,area))
3679       (loop
3680         (setq ,area (%fixnum-ref ,area (area-succ)))
3681         (when (eql ,area ,initial-area)
3682           (return))
3683         ,@body))))
3684
3685(defmacro with-ioblock-input-lock-grabbed ((ioblock) &body body)
3686  (let* ((i (gensym)))
3687    `(let* ((,i ,ioblock))
3688      (with-lock-grabbed ((ioblock-inbuf-lock ,i))
3689        (cond ((ioblock-device ,i)
3690               ,@body)
3691              (t (stream-is-closed (ioblock-stream ,i))))))))
3692
3693(defmacro with-ioblock-output-lock-grabbed ((ioblock) &body body)
3694  (let* ((i (gensym)))
3695    `(let* ((,i ,ioblock))
3696      (with-lock-grabbed ((ioblock-outbuf-lock ,i))
3697        (cond ((ioblock-device ,i)
3698               ,@body)
3699              (t (stream-is-closed (ioblock-stream ,i))))))))
3700 
3701
3702(defmacro with-stream-ioblock-input ((ioblock stream &key
3703                                             speedy)
3704                                  &body body)
3705  `(let ((,ioblock (stream-ioblock ,stream t)))
3706     ,@(when speedy `((declare (optimize (speed 3) (safety 0)))))
3707     (with-ioblock-input-locked (,ioblock) ,@body)))
3708
3709(defmacro with-stream-ioblock-output ((ioblock stream &key
3710                                             speedy)
3711                                  &body body)
3712  `(let ((,ioblock (stream-ioblock ,stream t)))
3713     ,@(when speedy `((declare (optimize (speed 3) (safety 0)))))
3714     (with-ioblock-output-locked (,ioblock) ,@body)))
3715
3716(defmacro with-stream-ioblock-output-maybe ((ioblock stream &key
3717                                                     speedy)
3718                                            &body body)
3719  `(let ((,ioblock (stream-ioblock ,stream t)))
3720    ,@(when speedy `((declare (optimize (speed 3) (safety 0)))))
3721    (with-ioblock-output-locked-maybe (,ioblock) ,@body)))
3722
3723(defmacro with-ioblock-input-locked ((ioblock) &body body)
3724  (let* ((lock (gensym)))
3725    `(let* ((,lock (locally (declare (optimize (speed 3) (safety 0)))
3726                                  (ioblock-inbuf-lock ,ioblock))))
3727      (if ,lock
3728        (with-lock-grabbed (,lock)
3729          (cond ((ioblock-device ,ioblock)
3730                 ,@body)
3731                (t (stream-is-closed (ioblock-stream ,ioblock)))))
3732        (progn
3733          (check-ioblock-owner ,ioblock)
3734          ,@body)))))
3735
3736(defmacro with-ioblock-output-locked ((ioblock) &body body)
3737  (let* ((lock (gensym)))
3738    `(let* ((,lock (locally (declare (optimize (speed 3) (safety 0)))
3739                                  (ioblock-outbuf-lock ,ioblock))))
3740      (if ,lock
3741        (with-lock-grabbed (,lock)
3742          (cond ((ioblock-device ,ioblock)
3743                 ,@body)
3744                (t (stream-is-closed (ioblock-stream ,ioblock)))))
3745        (progn
3746          (check-ioblock-owner ,ioblock)
3747          ,@body)))))
3748
3749
3750
3751(defmacro with-ioblock-output-locked-maybe ((ioblock) &body body)
3752  (let* ((lock (gensym)))
3753    `(let* ((,lock (locally (declare (optimize (speed 3) (safety 0)))
3754                     (ioblock-outbuf-lock ,ioblock))))
3755      (if ,lock
3756        (with-lock-grabbed (,lock)
3757          (cond ((ioblock-device ,ioblock)
3758                 ,@body)
3759                (t (stream-is-closed (ioblock-stream ,ioblock)))))
3760        (progn
3761          (check-ioblock-owner ,ioblock)
3762          ,@body)))))
3763
3764;;; Use this when it's possible that the fd might be in
3765;;; a non-blocking state.  Body must return a negative of
3766;;; the os error number on failure.
3767;;; The use of READ-FROM-STRING below is certainly ugly, but macros
3768;;; that expand into reader-macros don't generally trigger the reader-macro's
3769;;; side-effects.  (Besides, the reader-macro might return a different
3770;;; value when the macro function is expanded than it did when the macro
3771;;; function was defined; this can happen during cross-compilation.)
3772(defmacro with-eagain (fd direction &body body)
3773  (let* ((res (gensym))
3774         (eagain (symbol-value (read-from-string "#$EAGAIN"))))
3775   `(loop
3776      (let ((,res (progn ,@body)))
3777        (if (eql ,res (- ,eagain))
3778          (progn
3779            (setq ,res
3780                  (,(ecase direction
3781                           (:input 'process-input-would-block)
3782                           (:output 'process-output-would-block))
3783                    ,fd))
3784            (unless (eq ,res t) (return ,res)))
3785          (return ,res))))))
3786
3787(defmacro ignoring-eintr (&body body)
3788  (let* ((res (gensym))
3789         (eintr (symbol-value (read-from-string "#$EINTR"))))
3790    `(loop
3791       (let* ((,res (progn ,@body)))
3792         (unless (eql ,res (- ,eintr))
3793           (return ,res))))))
3794
3795(defmacro ff-call-ignoring-eintr (&body body)
3796  (let* ((res (gensym))
3797         (eintr (symbol-value (read-from-string "#$EINTR"))))
3798    `(loop
3799       (let* ((,res (progn ,@body)))
3800         (declare (fixnum ,res))
3801         (when (< ,res 0)
3802           (setq ,res (%get-errno)))
3803         (unless (eql ,res (- ,eintr))
3804           (return ,res))))))
3805
3806(defmacro basic-stream-ioblock (s)
3807  `(or (basic-stream.state ,s)
3808    (stream-is-closed ,s)))
3809
3810(defsetf interrupt-level set-interrupt-level)
3811
3812(defmacro %swap-u16 (val)
3813  (let* ((arg (gensym)))
3814    `(let* ((,arg ,val))
3815      (declare (type (unsigned-byte 16) ,arg))
3816      (logand #xffff (the fixnum (logior (the fixnum (ash ,arg -8))
3817                                         (the fixnum (ash ,arg 8))))))))
3818
3819(defmacro %swap-u32 (val)
3820  (let* ((arg (gensym)))
3821    `(let ((,arg ,val))
3822      (declare (type (unsigned-byte 32) ,arg))
3823      (the (unsigned-byte 32) (logior (the (unsigned-byte 32)
3824                                        (ash (logand #xff ,arg) 24))
3825                                      (the (unsigned-byte 24)
3826                                        (logior
3827                                         (the (unsigned-byte 24) (ash (logand #xff00 ,arg) 8))
3828                                         (the (unsigned-byte 16)
3829                                           (logior
3830                                            (the (unsigned-byte 16) (ash (logand #xff0000 ,arg) -8))
3831                                            (the (unsigned-byte 8) (ash ,arg -24)))))))))))
3832   
3833
3834(defmacro multiple-value-bind (varlist values-form &body body &environment env)
3835  (multiple-value-bind (body decls)
3836                       (parse-body body env)
3837    (let ((ignore (make-symbol "IGNORE")))
3838      `(multiple-value-call #'(lambda (&optional ,@varlist &rest ,ignore)
3839                                (declare (ignore ,ignore))
3840                                ,@decls
3841                                ,@body)
3842                            ,values-form))))
3843
3844(defmacro multiple-value-setq (vars val)
3845  (if vars
3846    `(values (setf (values ,@(mapcar #'(lambda (s) (require-type s 'symbol)) vars))  ,val))
3847    `(prog1 ,val)))
3848
3849(defmacro nth-value (n form)
3850  "Evaluate FORM and return the Nth value (zero based). This involves no
3851  consing when N is a trivial constant integer."
3852  `(car (nthcdr ,n (multiple-value-list ,form))))
3853
3854
3855
3856(defmacro with-input-timeout (((stream-var &optional (stream-form stream-var)) timeout) &body body)
3857  "Execute body with STREAM-VAR bound to STREAM-FORM and with that stream's
3858stream-input-timeout set to TIMEOUT."
3859  (let* ((old-input-timeout (gensym))
3860         (stream (gensym)))
3861    `(let* ((,stream ,stream-form)
3862            (,stream-var ,stream)
3863            (,old-input-timeout (stream-input-timeout ,stream)))
3864      (unwind-protect
3865           (progn
3866             (setf (stream-input-timeout ,stream) ,timeout)
3867             ,@body)
3868        (setf (stream-input-timeout ,stream) ,old-input-timeout)))))
3869
3870(defmacro with-output-timeout (((stream-var &optional (stream-form stream-var)) timeout) &body body)
3871  "Execute body with STREAM-VAR bound to STREAM-FORM and with that stream's
3872stream-output-timeout set to TIMEOUT."
3873  (let* ((old-output-timeout (gensym))
3874         (stream (gensym)))
3875    `(let* ((,stream ,stream-form)
3876            (,stream-var ,stream)
3877            (,old-output-timeout (stream-output-timeout ,stream)))
3878      (unwind-protect
3879           (progn
3880             (setf (stream-output-timeout ,stream) ,timeout)
3881             ,@body)
3882        (setf (stream-output-timeout ,stream) ,old-output-timeout)))))
3883
3884;;; FORM returns a signed integer.  If it's non-negative, return that
3885;;; value, otherwise, return the (negative) errnor value returned by
3886;;; %GET-ERRNO
3887(defmacro int-errno-call (form)
3888  (let* ((value (gensym)))
3889    `(let* ((,value ,form))
3890      (if (< ,value 0)
3891        (%get-errno)
3892        ,value))))
3893
3894(defmacro int-errno-ffcall (entry &rest args)
3895  `(int-errno-call (ff-call ,entry ,@args)))
3896
3897(defmacro with-initial-bindings (bindings &body body)
3898  (let* ((syms (gensym))
3899         (values (gensym)))
3900    `(multiple-value-bind (,syms ,values)
3901        (initial-bindings ,bindings)
3902      (progv ,syms ,values ,@body))))
3903
3904(defmacro with-standard-initial-bindings (&body body)
3905  `(with-initial-bindings (standard-initial-bindings) ,@body))
3906
Note: See TracBrowser for help on using the repository browser.