source: release/1.3/source/lib/macros.lisp @ 11747

Last change on this file since 11747 was 11747, checked in by rme, 11 years ago

Merge trunk changes through r11740.

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