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

Last change on this file since 10487 was 10487, checked in by gb, 11 years ago

Remove the macro ERRCHK, which (a) is unused (b) expands to a call to
an undefined function (c) should not be used for mcl-in-ccl.

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