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

Last change on this file since 14227 was 14227, checked in by rme, 9 years ago

%code-char: codes aren't (mod 256) any more.

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