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

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

Missing comma in lfunloop, while in there also tweak it to skip lfun bits and (for ppc) the code vector

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