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

Last change on this file since 13093 was 13093, checked in by gz, 11 years ago

r13080 from trunk (dolist that obeys e.g. inline decls in result clause)

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