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

Last change on this file since 14228 was 14228, checked in by gb, 9 years ago

Revert r14227 and add a comment.

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