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

Last change on this file since 8996 was 8996, checked in by gb, 12 years ago

Use SET ',VAR, not SETQ, in case the body of DEFVAR gets compiled
before anything sees the SPECIAL declamation.
(Could also wrap (LOCALLY (DECLARE SPECIAL ...) around some of the
expansion, but this seems to be the only part of the expansion that
references an unquoted variable name.)

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