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

Last change on this file since 11836 was 11836, checked in by gz, 12 years ago

Typecheck new bindings in nx1-env-body, if nx-declarations-typecheck is true. Remove the typechecking from nx1-typed-var-initform since no longer needed. Remove some bogus declarations found by compiling the system with typechecking declarations.

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