source: branches/working-0711/ccl/lib/macros.lisp @ 13510

Last change on this file since 13510 was 13510, checked in by gz, 10 years ago

From trunk: bivalent vector streams (r13454 et. al.)

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