Silence notes about being specialised EQ templates on x86oids
[sbcl.git] / src / code / defboot.lisp
1 ;;;; bootstrapping fundamental machinery (e.g. DEFUN, DEFCONSTANT,
2 ;;;; DEFVAR) from special forms and primitive functions
3 ;;;;
4 ;;;; KLUDGE: The bootstrapping aspect of this is now obsolete. It was
5 ;;;; originally intended that this file file would be loaded into a
6 ;;;; Lisp image which had Common Lisp primitives defined, and DEFMACRO
7 ;;;; defined, and little else. Since then that approach has been
8 ;;;; dropped and this file has been modified somewhat to make it work
9 ;;;; more cleanly when used to predefine macros at
10 ;;;; build-the-cross-compiler time.
11
12 ;;;; This software is part of the SBCL system. See the README file for
13 ;;;; more information.
14 ;;;;
15 ;;;; This software is derived from the CMU CL system, which was
16 ;;;; written at Carnegie Mellon University and released into the
17 ;;;; public domain. The software is in the public domain and is
18 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
19 ;;;; files for more information.
20
21 (in-package "SB!IMPL")
22
23 \f
24 ;;;; IN-PACKAGE
25
26 (defmacro-mundanely in-package (string-designator)
27   (let ((string (string string-designator)))
28     `(eval-when (:compile-toplevel :load-toplevel :execute)
29        (setq *package* (find-undeleted-package-or-lose ,string)))))
30 \f
31 ;;;; MULTIPLE-VALUE-FOO
32
33 (defun list-of-symbols-p (x)
34   (and (listp x)
35        (every #'symbolp x)))
36
37 (defmacro-mundanely multiple-value-bind (vars value-form &body body)
38   (if (list-of-symbols-p vars)
39     ;; It's unclear why it would be important to special-case the LENGTH=1 case
40     ;; at this level, but the CMU CL code did it, so.. -- WHN 19990411
41     (if (= (length vars) 1)
42       `(let ((,(car vars) ,value-form))
43          ,@body)
44       (let ((ignore (sb!xc:gensym)))
45         `(multiple-value-call #'(lambda (&optional ,@(mapcar #'list vars)
46                                          &rest ,ignore)
47                                   (declare (ignore ,ignore))
48                                   ,@body)
49                               ,value-form)))
50     (error "Vars is not a list of symbols: ~S" vars)))
51
52 (defmacro-mundanely multiple-value-setq (vars value-form)
53   (unless (list-of-symbols-p vars)
54     (error "Vars is not a list of symbols: ~S" vars))
55   ;; MULTIPLE-VALUE-SETQ is required to always return just the primary
56   ;; value of the value-from, even if there are no vars. (SETF VALUES)
57   ;; in turn is required to return as many values as there are
58   ;; value-places, hence this:
59   (if vars
60       `(values (setf (values ,@vars) ,value-form))
61       `(values ,value-form)))
62
63 (defmacro-mundanely multiple-value-list (value-form)
64   `(multiple-value-call #'list ,value-form))
65 \f
66 ;;;; various conditional constructs
67
68 ;;; COND defined in terms of IF
69 (defmacro-mundanely cond (&rest clauses)
70   (if (endp clauses)
71       nil
72       (let ((clause (first clauses))
73             (more (rest clauses)))
74         (if (atom clause)
75             (error "COND clause is not a list: ~S" clause)
76             (let ((test (first clause))
77                   (forms (rest clause)))
78               (if (endp forms)
79                   (let ((n-result (gensym)))
80                     `(let ((,n-result ,test))
81                        (if ,n-result
82                            ,n-result
83                            (cond ,@more))))
84                   (if (eq t test)
85                       ;; THE to perserve non-toplevelness for FOO in
86                       ;;   (COND (T (FOO)))
87                       `(the t (progn ,@forms))
88                       `(if ,test
89                            (progn ,@forms)
90                            ,(when more `(cond ,@more))))))))))
91
92 (defmacro-mundanely when (test &body forms)
93   #!+sb-doc
94   "If the first argument is true, the rest of the forms are
95 evaluated as a PROGN."
96   `(if ,test (progn ,@forms) nil))
97
98 (defmacro-mundanely unless (test &body forms)
99   #!+sb-doc
100   "If the first argument is not true, the rest of the forms are
101 evaluated as a PROGN."
102   `(if ,test nil (progn ,@forms)))
103
104 (defmacro-mundanely and (&rest forms)
105   (cond ((endp forms) t)
106         ((endp (rest forms))
107          ;; Preserve non-toplevelness of the form!
108          `(the t ,(first forms)))
109         (t
110          `(if ,(first forms)
111               (and ,@(rest forms))
112               nil))))
113
114 (defmacro-mundanely or (&rest forms)
115   (cond ((endp forms) nil)
116         ((endp (rest forms))
117          ;; Preserve non-toplevelness of the form!
118          `(the t ,(first forms)))
119         (t
120          (let ((n-result (gensym)))
121            `(let ((,n-result ,(first forms)))
122               (if ,n-result
123                   ,n-result
124                   (or ,@(rest forms))))))))
125 \f
126 ;;;; various sequencing constructs
127
128 (flet ((prog-expansion-from-let (varlist body-decls let)
129          (multiple-value-bind (body decls)
130              (parse-body body-decls :doc-string-allowed nil)
131            `(block nil
132               (,let ,varlist
133                 ,@decls
134                 (tagbody ,@body))))))
135   (defmacro-mundanely prog (varlist &body body-decls)
136     (prog-expansion-from-let varlist body-decls 'let))
137   (defmacro-mundanely prog* (varlist &body body-decls)
138     (prog-expansion-from-let varlist body-decls 'let*)))
139
140 (defmacro-mundanely prog1 (result &body body)
141   (let ((n-result (gensym)))
142     `(let ((,n-result ,result))
143        ,@body
144        ,n-result)))
145
146 (defmacro-mundanely prog2 (form1 result &body body)
147   `(prog1 (progn ,form1 ,result) ,@body))
148 \f
149 ;;;; DEFUN
150
151 ;;; Should we save the inline expansion of the function named NAME?
152 (defun inline-fun-name-p (name)
153   (or
154    ;; the normal reason for saving the inline expansion
155    (let ((inlinep (info :function :inlinep name)))
156      (member inlinep '(:inline :maybe-inline)))
157    ;; another reason for saving the inline expansion: If the
158    ;; ANSI-recommended idiom
159    ;;   (DECLAIM (INLINE FOO))
160    ;;   (DEFUN FOO ..)
161    ;;   (DECLAIM (NOTINLINE FOO))
162    ;; has been used, and then we later do another
163    ;;   (DEFUN FOO ..)
164    ;; without a preceding
165    ;;   (DECLAIM (INLINE FOO))
166    ;; what should we do with the old inline expansion when we see the
167    ;; new DEFUN? Overwriting it with the new definition seems like
168    ;; the only unsurprising choice.
169    (info :function :inline-expansion-designator name)))
170
171 (defmacro-mundanely defun (&environment env name args &body body)
172   "Define a function at top level."
173   #+sb-xc-host
174   (unless (symbol-package (fun-name-block-name name))
175     (warn "DEFUN of uninterned function name ~S (tricky for GENESIS)" name))
176   (multiple-value-bind (forms decls doc) (parse-body body)
177     (let* (;; stuff shared between LAMBDA and INLINE-LAMBDA and NAMED-LAMBDA
178            (lambda-guts `(,args
179                           ,@decls
180                           (block ,(fun-name-block-name name)
181                             ,@forms)))
182            (lambda `(lambda ,@lambda-guts))
183            #-sb-xc-host
184            (named-lambda `(named-lambda ,name ,@lambda-guts))
185            (inline-lambda
186             (when (inline-fun-name-p name)
187               ;; we want to attempt to inline, so complain if we can't
188               (or (sb!c:maybe-inline-syntactic-closure lambda env)
189                   (progn
190                     (#+sb-xc-host warn
191                      #-sb-xc-host sb!c:maybe-compiler-notify
192                      "lexical environment too hairy, can't inline DEFUN ~S"
193                      name)
194                     nil)))))
195       `(progn
196          ;; In cross-compilation of toplevel DEFUNs, we arrange for
197          ;; the LAMBDA to be statically linked by GENESIS.
198          ;;
199          ;; It may seem strangely inconsistent not to use NAMED-LAMBDA
200          ;; here instead of LAMBDA. The reason is historical:
201          ;; COLD-FSET was written before NAMED-LAMBDA, and has special
202          ;; logic of its own to notify the compiler about NAME.
203          #+sb-xc-host
204          (cold-fset ,name ,lambda)
205
206          (eval-when (:compile-toplevel)
207            (sb!c:%compiler-defun ',name ',inline-lambda t))
208          (eval-when (:load-toplevel :execute)
209            (%defun ',name
210                    ;; In normal compilation (not for cold load) this is
211                    ;; where the compiled LAMBDA first appears. In
212                    ;; cross-compilation, we manipulate the
213                    ;; previously-statically-linked LAMBDA here.
214                    #-sb-xc-host ,named-lambda
215                    #+sb-xc-host (fdefinition ',name)
216                    ,doc
217                    ',inline-lambda
218                    (sb!c:source-location)))))))
219
220 #-sb-xc-host
221 (defun %defun (name def doc inline-lambda source-location)
222   (declare (type function def))
223   (declare (type (or null simple-string) doc))
224   (aver (legal-fun-name-p name)) ; should've been checked by DEFMACRO DEFUN
225   (sb!c:%compiler-defun name inline-lambda nil)
226   (when (fboundp name)
227     (/show0 "redefining NAME in %DEFUN")
228     (warn 'sb!kernel::redefinition-with-defun
229           :name name
230           :new-function def
231           :new-location source-location))
232   (setf (sb!xc:fdefinition name) def)
233   ;; %COMPILER-DEFUN doesn't do this except at compile-time, when it
234   ;; also checks package locks. By doing this here we let (SETF
235   ;; FDEFINITION) do the load-time package lock checking before
236   ;; we frob any existing inline expansions.
237   (sb!c::%set-inline-expansion name nil inline-lambda)
238
239   (sb!c::note-name-defined name :function)
240
241   (when doc
242     (setf (%fun-doc def) doc))
243
244   name)
245 \f
246 ;;;; DEFVAR and DEFPARAMETER
247
248 (defmacro-mundanely defvar (var &optional (val nil valp) (doc nil docp))
249   #!+sb-doc
250   "Define a special variable at top level. Declare the variable
251   SPECIAL and, optionally, initialize it. If the variable already has a
252   value, the old value is not clobbered. The third argument is an optional
253   documentation string for the variable."
254   `(progn
255      (eval-when (:compile-toplevel)
256        (%compiler-defvar ',var))
257      (eval-when (:load-toplevel :execute)
258        (%defvar ',var (unless (boundp ',var) ,val)
259                 ',valp ,doc ',docp
260                 (sb!c:source-location)))))
261
262 (defmacro-mundanely defparameter (var val &optional (doc nil docp))
263   #!+sb-doc
264   "Define a parameter that is not normally changed by the program,
265   but that may be changed without causing an error. Declare the
266   variable special and sets its value to VAL, overwriting any
267   previous value. The third argument is an optional documentation
268   string for the parameter."
269   `(progn
270      (eval-when (:compile-toplevel)
271        (%compiler-defvar ',var))
272      (eval-when (:load-toplevel :execute)
273        (%defparameter ',var ,val ,doc ',docp (sb!c:source-location)))))
274
275 (defun %compiler-defvar (var)
276   (sb!xc:proclaim `(special ,var)))
277
278 #-sb-xc-host
279 (defun %defvar (var val valp doc docp source-location)
280   (%compiler-defvar var)
281   (when valp
282     (unless (boundp var)
283       (set var val)))
284   (when docp
285     (setf (fdocumentation var 'variable) doc))
286   (sb!c:with-source-location (source-location)
287     (setf (info :source-location :variable var) source-location))
288   var)
289
290 #-sb-xc-host
291 (defun %defparameter (var val doc docp source-location)
292   (%compiler-defvar var)
293   (set var val)
294   (when docp
295     (setf (fdocumentation var 'variable) doc))
296   (sb!c:with-source-location (source-location)
297     (setf (info :source-location :variable var) source-location))
298   var)
299 \f
300 ;;;; iteration constructs
301
302 ;;; (These macros are defined in terms of a function FROB-DO-BODY which
303 ;;; is also used by SB!INT:DO-ANONYMOUS. Since these macros should not
304 ;;; be loaded on the cross-compilation host, but SB!INT:DO-ANONYMOUS
305 ;;; and FROB-DO-BODY should be, these macros can't conveniently be in
306 ;;; the same file as FROB-DO-BODY.)
307 (defmacro-mundanely do (varlist endlist &body body)
308   #!+sb-doc
309   "DO ({(Var [Init] [Step])}*) (Test Exit-Form*) Declaration* Form*
310   Iteration construct. Each Var is initialized in parallel to the value of the
311   specified Init form. On subsequent iterations, the Vars are assigned the
312   value of the Step form (if any) in parallel. The Test is evaluated before
313   each evaluation of the body Forms. When the Test is true, the Exit-Forms
314   are evaluated as a PROGN, with the result being the value of the DO. A block
315   named NIL is established around the entire expansion, allowing RETURN to be
316   used as an alternate exit mechanism."
317   (frob-do-body varlist endlist body 'let 'psetq 'do nil))
318 (defmacro-mundanely do* (varlist endlist &body body)
319   #!+sb-doc
320   "DO* ({(Var [Init] [Step])}*) (Test Exit-Form*) Declaration* Form*
321   Iteration construct. Each Var is initialized sequentially (like LET*) to the
322   value of the specified Init form. On subsequent iterations, the Vars are
323   sequentially assigned the value of the Step form (if any). The Test is
324   evaluated before each evaluation of the body Forms. When the Test is true,
325   the Exit-Forms are evaluated as a PROGN, with the result being the value
326   of the DO. A block named NIL is established around the entire expansion,
327   allowing RETURN to be used as an laternate exit mechanism."
328   (frob-do-body varlist endlist body 'let* 'setq 'do* nil))
329
330 ;;; DOTIMES and DOLIST could be defined more concisely using
331 ;;; destructuring macro lambda lists or DESTRUCTURING-BIND, but then
332 ;;; it'd be tricky to use them before those things were defined.
333 ;;; They're used enough times before destructuring mechanisms are
334 ;;; defined that it looks as though it's worth just implementing them
335 ;;; ASAP, at the cost of being unable to use the standard
336 ;;; destructuring mechanisms.
337 (defmacro-mundanely dotimes ((var count &optional (result nil)) &body body)
338   (cond ((integerp count)
339         `(do ((,var 0 (1+ ,var)))
340              ((>= ,var ,count) ,result)
341            (declare (type unsigned-byte ,var))
342            ,@body))
343         (t
344          (let ((c (gensym "COUNT")))
345            `(do ((,var 0 (1+ ,var))
346                  (,c ,count))
347                 ((>= ,var ,c) ,result)
348               (declare (type unsigned-byte ,var)
349                        (type integer ,c))
350               ,@body)))))
351
352 (defmacro-mundanely dolist ((var list &optional (result nil)) &body body &environment env)
353   ;; We repeatedly bind the var instead of setting it so that we never
354   ;; have to give the var an arbitrary value such as NIL (which might
355   ;; conflict with a declaration). If there is a result form, we
356   ;; introduce a gratuitous binding of the variable to NIL without the
357   ;; declarations, then evaluate the result form in that
358   ;; environment. We spuriously reference the gratuitous variable,
359   ;; since we don't want to use IGNORABLE on what might be a special
360   ;; var.
361   (multiple-value-bind (forms decls) (parse-body body :doc-string-allowed nil)
362     (let* ((n-list (gensym "N-LIST"))
363            (start (gensym "START")))
364       (multiple-value-bind (clist members clist-ok)
365           (cond ((sb!xc:constantp list env)
366                  (let ((value (constant-form-value list env)))
367                    (multiple-value-bind (all dot) (list-members value :max-length 20)
368                      (when (eql dot t)
369                        ;; Full warning is too much: the user may terminate the loop
370                        ;; early enough. Contents are still right, though.
371                        (style-warn "Dotted list ~S in DOLIST." value))
372                      (if (eql dot :maybe)
373                          (values value nil nil)
374                          (values value all t)))))
375                 ((and (consp list) (eq 'list (car list))
376                       (every (lambda (arg) (sb!xc:constantp arg env)) (cdr list)))
377                  (let ((values (mapcar (lambda (arg) (constant-form-value arg env)) (cdr list))))
378                    (values values values t)))
379                 (t
380                  (values nil nil nil)))
381         `(block nil
382            (let ((,n-list ,(if clist-ok (list 'quote clist) list)))
383              (tagbody
384                 ,start
385                 (unless (endp ,n-list)
386                   (let ((,var ,(if clist-ok
387                                    `(truly-the (member ,@members) (car ,n-list))
388                                    `(car ,n-list))))
389                     ,@decls
390                     (setq ,n-list (cdr ,n-list))
391                     (tagbody ,@forms))
392                   (go ,start))))
393            ,(if result
394                 `(let ((,var nil))
395                    ;; Filter out TYPE declarations (VAR gets bound to NIL,
396                    ;; and might have a conflicting type declaration) and
397                    ;; IGNORE (VAR might be ignored in the loop body, but
398                    ;; it's used in the result form).
399                    ,@(filter-dolist-declarations decls)
400                    ,var
401                    ,result)
402                 nil))))))
403 \f
404 ;;;; conditions, handlers, restarts
405
406 ;;; KLUDGE: we PROCLAIM these special here so that we can use restart
407 ;;; macros in the compiler before the DEFVARs are compiled.
408 (sb!xc:proclaim
409  '(special *handler-clusters* *restart-clusters* *condition-restarts*))
410
411 (defmacro-mundanely with-condition-restarts
412     (condition-form restarts-form &body body)
413   #!+sb-doc
414   "Evaluates the BODY in a dynamic environment where the restarts in the list
415    RESTARTS-FORM are associated with the condition returned by CONDITION-FORM.
416    This allows FIND-RESTART, etc., to recognize restarts that are not related
417    to the error currently being debugged. See also RESTART-CASE."
418   (let ((n-cond (gensym)))
419     `(let ((*condition-restarts*
420             (cons (let ((,n-cond ,condition-form))
421                     (cons ,n-cond
422                           (append ,restarts-form
423                                   (cdr (assoc ,n-cond *condition-restarts*)))))
424                   *condition-restarts*)))
425        ,@body)))
426
427 (defmacro-mundanely restart-bind (bindings &body forms)
428   #!+sb-doc
429   "Executes forms in a dynamic context where the given restart bindings are
430    in effect. Users probably want to use RESTART-CASE. When clauses contain
431    the same restart name, FIND-RESTART will find the first such clause."
432   `(let ((*restart-clusters*
433           (cons (list
434                  ,@(mapcar (lambda (binding)
435                              (unless (or (car binding)
436                                          (member :report-function
437                                                  binding
438                                                  :test #'eq))
439                                (warn "Unnamed restart does not have a ~
440                                       report function: ~S"
441                                      binding))
442                              `(make-restart :name ',(car binding)
443                                             :function ,(cadr binding)
444                                             ,@(cddr binding)))
445                            bindings))
446                 *restart-clusters*)))
447      ,@forms))
448
449 ;;; Wrap the RESTART-CASE expression in a WITH-CONDITION-RESTARTS if
450 ;;; appropriate. Gross, but it's what the book seems to say...
451 (defun munge-restart-case-expression (expression env)
452   (let ((exp (%macroexpand expression env)))
453     (if (consp exp)
454         (let* ((name (car exp))
455                (args (if (eq name 'cerror) (cddr exp) (cdr exp))))
456           (if (member name '(signal error cerror warn))
457               (once-only ((n-cond `(coerce-to-condition
458                                     ,(first args)
459                                     (list ,@(rest args))
460                                     ',(case name
461                                         (warn 'simple-warning)
462                                         (signal 'simple-condition)
463                                         (t 'simple-error))
464                                     ',name)))
465                 `(with-condition-restarts
466                      ,n-cond
467                      (car *restart-clusters*)
468                    ,(if (eq name 'cerror)
469                         `(cerror ,(second exp) ,n-cond)
470                         `(,name ,n-cond))))
471               expression))
472         expression)))
473
474 ;;; FIXME: I did a fair amount of rearrangement of this code in order to
475 ;;; get WITH-KEYWORD-PAIRS to work cleanly. This code should be tested..
476 (defmacro-mundanely restart-case (expression &body clauses &environment env)
477   #!+sb-doc
478   "(RESTART-CASE form
479    {(case-name arg-list {keyword value}* body)}*)
480    The form is evaluated in a dynamic context where the clauses have special
481    meanings as points to which control may be transferred (see INVOKE-RESTART).
482    When clauses contain the same case-name, FIND-RESTART will find the first
483    such clause. If Expression is a call to SIGNAL, ERROR, CERROR or WARN (or
484    macroexpands into such) then the signalled condition will be associated with
485    the new restarts."
486   (flet ((transform-keywords (&key report interactive test)
487            (let ((result '()))
488              (when report
489                (setq result (list* (if (stringp report)
490                                        `#'(lambda (stream)
491                                             (write-string ,report stream))
492                                        `#',report)
493                                    :report-function
494                                    result)))
495              (when interactive
496                (setq result (list* `#',interactive
497                                    :interactive-function
498                                    result)))
499              (when test
500                (setq result (list* `#',test :test-function result)))
501              (nreverse result)))
502          (parse-keyword-pairs (list keys)
503            (do ((l list (cddr l))
504                 (k '() (list* (cadr l) (car l) k)))
505                ((or (null l) (not (member (car l) keys)))
506                 (values (nreverse k) l)))))
507     (let ((block-tag (sb!xc:gensym "BLOCK"))
508           (temp-var (gensym))
509           (data
510            (macrolet (;; KLUDGE: This started as an old DEFMACRO
511                       ;; WITH-KEYWORD-PAIRS general utility, which was used
512                       ;; only in this one place in the code. It was translated
513                       ;; literally into this MACROLET in order to avoid some
514                       ;; cross-compilation bootstrap problems. It would almost
515                       ;; certainly be clearer, and it would certainly be more
516                       ;; concise, to do a more idiomatic translation, merging
517                       ;; this with the TRANSFORM-KEYWORDS logic above.
518                       ;;   -- WHN 19990925
519                       (with-keyword-pairs ((names expression) &body forms)
520                         (let ((temp (member '&rest names)))
521                           (unless (= (length temp) 2)
522                             (error "&REST keyword is ~:[missing~;misplaced~]."
523                                    temp))
524                           (let* ((key-vars (ldiff names temp))
525                                  (keywords (mapcar #'keywordicate key-vars))
526                                  (key-var (gensym))
527                                  (rest-var (cadr temp)))
528                             `(multiple-value-bind (,key-var ,rest-var)
529                                  (parse-keyword-pairs ,expression ',keywords)
530                                (let ,(mapcar (lambda (var keyword)
531                                                `(,var (getf ,key-var
532                                                             ,keyword)))
533                                              key-vars keywords)
534                                  ,@forms))))))
535              (mapcar (lambda (clause)
536                        (unless (listp (second clause))
537                          (error "Malformed ~S clause, no lambda-list:~%  ~S"
538                                 'restart-case clause))
539                        (with-keyword-pairs ((report interactive test
540                                                     &rest forms)
541                                             (cddr clause))
542                          (list (car clause) ;name=0
543                                (sb!xc:gensym "TAG") ;tag=1
544                                (transform-keywords :report report ;keywords=2
545                                                    :interactive interactive
546                                                    :test test)
547                                (cadr clause) ;bvl=3
548                                forms))) ;body=4
549                    clauses))))
550       `(block ,block-tag
551          (let ((,temp-var nil))
552            (declare (ignorable ,temp-var))
553            (tagbody
554             (restart-bind
555                 ,(mapcar (lambda (datum)
556                            (let ((name (nth 0 datum))
557                                  (tag  (nth 1 datum))
558                                  (keys (nth 2 datum)))
559                              `(,name #'(lambda (&rest temp)
560                                          (setq ,temp-var temp)
561                                          (go ,tag))
562                                      ,@keys)))
563                          data)
564               (return-from ,block-tag
565                            ,(munge-restart-case-expression expression env)))
566             ,@(mapcan (lambda (datum)
567                         (let ((tag  (nth 1 datum))
568                               (bvl  (nth 3 datum))
569                               (body (nth 4 datum)))
570                           (list tag
571                                 `(return-from ,block-tag
572                                    (apply (lambda ,bvl ,@body)
573                                           ,temp-var)))))
574                       data)))))))
575
576 (defmacro-mundanely with-simple-restart ((restart-name format-string
577                                                        &rest format-arguments)
578                                          &body forms)
579   #!+sb-doc
580   "(WITH-SIMPLE-RESTART (restart-name format-string format-arguments)
581    body)
582    If restart-name is not invoked, then all values returned by forms are
583    returned. If control is transferred to this restart, it immediately
584    returns the values NIL and T."
585   `(restart-case
586        ;; If there's just one body form, then don't use PROGN. This allows
587        ;; RESTART-CASE to "see" calls to ERROR, etc.
588        ,(if (= (length forms) 1) (car forms) `(progn ,@forms))
589      (,restart-name ()
590         :report (lambda (stream)
591                   (format stream ,format-string ,@format-arguments))
592       (values nil t))))
593
594 (defmacro-mundanely %handler-bind (bindings form)
595   (let ((member-if (member-if (lambda (x)
596                                 (not (proper-list-of-length-p x 2)))
597                               bindings)))
598     (when member-if
599       (error "ill-formed handler binding: ~S" (first member-if))))
600   (let* ((local-funs nil)
601          (mapped-bindings (mapcar (lambda (binding)
602                                     (destructuring-bind (type handler) binding
603                                       (let ((lambda-form handler))
604                                         (if (and (consp handler)
605                                                  (or (eq 'lambda (car handler))
606                                                      (and (eq 'function (car handler))
607                                                           (consp (cdr handler))
608                                                           (let ((x (second handler)))
609                                                             (and (consp x)
610                                                                  (eq 'lambda (car x))
611                                                                  (setf lambda-form x))))))
612                                             (let ((name (sb!xc:gensym "LAMBDA")))
613                                               (push `(,name ,@(cdr lambda-form)) local-funs)
614                                               (list type `(function ,name)))
615                                             binding))))
616                                   bindings)))
617     `(dx-flet (,@(reverse local-funs))
618        (let ((*handler-clusters*
619               (cons (list ,@(mapcar (lambda (x) `(cons ',(car x) ,(cadr x)))
620                                     mapped-bindings))
621                     *handler-clusters*)))
622          #!+stack-allocatable-fixed-objects
623          (declare (truly-dynamic-extent *handler-clusters*))
624          (progn ,form)))))
625
626 (defmacro-mundanely handler-bind (bindings &body forms)
627   #!+sb-doc
628   "(HANDLER-BIND ( {(type handler)}* )  body)
629
630 Executes body in a dynamic context where the given handler bindings are in
631 effect. Each handler must take the condition being signalled as an argument.
632 The bindings are searched first to last in the event of a signalled
633 condition."
634   `(%handler-bind ,bindings
635                   #!-x86 (progn ,@forms)
636                   ;; Need to catch FP errors here!
637                   #!+x86 (multiple-value-prog1 (progn ,@forms) (float-wait))))
638
639 (defmacro-mundanely handler-case (form &rest cases)
640   "(HANDLER-CASE form { (type ([var]) body) }* )
641
642 Execute FORM in a context with handlers established for the condition types. A
643 peculiar property allows type to be :NO-ERROR. If such a clause occurs, and
644 form returns normally, all its values are passed to this clause as if by
645 MULTIPLE-VALUE-CALL. The :NO-ERROR clause accepts more than one var
646 specification."
647   (let ((no-error-clause (assoc ':no-error cases)))
648     (if no-error-clause
649         (let ((normal-return (make-symbol "normal-return"))
650               (error-return  (make-symbol "error-return")))
651           `(block ,error-return
652              (multiple-value-call (lambda ,@(cdr no-error-clause))
653                (block ,normal-return
654                  (return-from ,error-return
655                    (handler-case (return-from ,normal-return ,form)
656                      ,@(remove no-error-clause cases)))))))
657         (let* ((local-funs nil)
658                (annotated-cases
659                 (mapcar (lambda (case)
660                           (with-unique-names (tag fun)
661                             (destructuring-bind (type ll &body body) case
662                               (push `(,fun ,ll ,@body) local-funs)
663                               (list tag type ll fun))))
664                         cases)))
665           (with-unique-names (block cell form-fun)
666             `(dx-flet ((,form-fun ()
667                          #!-x86 ,form
668                          ;; Need to catch FP errors here!
669                          #!+x86 (multiple-value-prog1 ,form (float-wait)))
670                        ,@(reverse local-funs))
671                (declare (optimize (sb!c::check-tag-existence 0)))
672                (block ,block
673                  ;; KLUDGE: We use a dx CONS cell instead of just assigning to
674                  ;; the variable directly, so that we can stack allocate
675                  ;; robustly: dx value cells don't work quite right, and it is
676                  ;; possible to construct user code that should loop
677                  ;; indefinitely, but instead eats up some stack each time
678                  ;; around.
679                  (dx-let ((,cell (cons :condition nil)))
680                    (declare (ignorable ,cell))
681                    (tagbody
682                       (%handler-bind
683                        ,(mapcar (lambda (annotated-case)
684                                   (destructuring-bind (tag type ll fun-name) annotated-case
685                                     (declare (ignore fun-name))
686                                     (list type
687                                           `(lambda (temp)
688                                              ,(if ll
689                                                   `(setf (cdr ,cell) temp)
690                                                   '(declare (ignore temp)))
691                                              (go ,tag)))))
692                                 annotated-cases)
693                        (return-from ,block (,form-fun)))
694                       ,@(mapcan
695                          (lambda (annotated-case)
696                            (destructuring-bind (tag type ll fun-name) annotated-case
697                              (declare (ignore type))
698                              (list tag
699                                    `(return-from ,block
700                                       ,(if ll
701                                            `(,fun-name (cdr ,cell))
702                                            `(,fun-name))))))
703                          annotated-cases))))))))))
704 \f
705 ;;;; miscellaneous
706
707 (defmacro-mundanely return (&optional (value nil))
708   `(return-from nil ,value))
709
710 (defmacro-mundanely psetq (&rest pairs)
711   #!+sb-doc
712   "PSETQ {var value}*
713    Set the variables to the values, like SETQ, except that assignments
714    happen in parallel, i.e. no assignments take place until all the
715    forms have been evaluated."
716   ;; Given the possibility of symbol-macros, we delegate to PSETF
717   ;; which knows how to deal with them, after checking that syntax is
718   ;; compatible with PSETQ.
719   (do ((pair pairs (cddr pair)))
720       ((endp pair) `(psetf ,@pairs))
721     (unless (symbolp (car pair))
722       (error 'simple-program-error
723              :format-control "variable ~S in PSETQ is not a SYMBOL"
724              :format-arguments (list (car pair))))))
725
726 (defmacro-mundanely lambda (&whole whole args &body body)
727   (declare (ignore args body))
728   `#',whole)
729
730 (defmacro-mundanely named-lambda (&whole whole name args &body body)
731   (declare (ignore name args body))
732   `#',whole)
733
734 (defmacro-mundanely lambda-with-lexenv (&whole whole
735                                         declarations macros symbol-macros
736                                         &body body)
737   (declare (ignore declarations macros symbol-macros body))
738   `#',whole)
739
740 ;;; this eliminates a whole bundle of unknown function STYLE-WARNINGs
741 ;;; when cross-compiling.  It's not critical for behaviour, but is
742 ;;; aesthetically pleasing, except inasmuch as there's this list of
743 ;;; magic functions here.  -- CSR, 2003-04-01
744 #+sb-xc-host
745 (sb!xc:proclaim '(ftype (function * *)
746                         ;; functions appearing in fundamental defining
747                         ;; macro expansions:
748                         %compiler-deftype
749                         %compiler-defvar
750                         %defun
751                         %defsetf
752                         %defparameter
753                         %defvar
754                         sb!c:%compiler-defun
755                         sb!c::%define-symbol-macro
756                         sb!c::%defconstant
757                         sb!c::%define-compiler-macro
758                         sb!c::%defmacro
759                         sb!kernel::%compiler-defstruct
760                         sb!kernel::%compiler-define-condition
761                         sb!kernel::%defstruct
762                         sb!kernel::%define-condition
763                         ;; miscellaneous functions commonly appearing
764                         ;; as a result of macro expansions or compiler
765                         ;; transformations:
766                         sb!int:find-undeleted-package-or-lose ; IN-PACKAGE
767                         sb!kernel::arg-count-error ; PARSE-DEFMACRO
768                         ))