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

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

Fix bad format (or warn etc.) calls found by the format string scanner

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