source: branches/qres/ccl/lib/macros.lisp @ 14259

Last change on this file since 14259 was 14259, checked in by gz, 9 years ago

r14258 from trunk (defstruct changes)

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