1 ;;;; bootstrapping fundamental machinery (e.g. DEFUN, DEFCONSTANT,
2 ;;;; DEFVAR) from special forms and primitive functions
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.
12 ;;;; This software is part of the SBCL system. See the README file for
13 ;;;; more information.
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.
21 (in-package "SB!IMPL")
25 (defmacro-mundanely in-package (package-designator)
26 `(eval-when (:compile-toplevel :load-toplevel :execute)
27 (setq *package* (find-undeleted-package-or-lose ',package-designator))))
29 ;;;; MULTIPLE-VALUE-FOO
31 (defun list-of-symbols-p (x)
35 (defmacro-mundanely multiple-value-bind (vars value-form &body body)
36 (if (list-of-symbols-p vars)
37 ;; It's unclear why it would be important to special-case the LENGTH=1 case
38 ;; at this level, but the CMU CL code did it, so.. -- WHN 19990411
39 (if (= (length vars) 1)
40 `(let ((,(car vars) ,value-form))
42 (let ((ignore (gensym)))
43 `(multiple-value-call #'(lambda (&optional ,@vars &rest ,ignore)
44 (declare (ignore ,ignore))
47 (error "Vars is not a list of symbols: ~S" vars)))
49 (defmacro-mundanely multiple-value-setq (vars value-form)
51 ;; The ANSI spec says that the primary value of VALUE-FORM must be
52 ;; returned. The general-case-handling code below doesn't do this
53 ;; correctly in the special case when there are no vars bound, so we
54 ;; handle this special case separately here.
56 `(multiple-value-bind (,g) ,value-form
58 ((list-of-symbols-p vars)
59 (let ((temps (make-gensym-list (length vars))))
60 `(multiple-value-bind ,temps ,value-form
61 ,@(mapcar #'(lambda (var temp)
65 (t (error "Vars is not a list of symbols: ~S" vars))))
67 (defmacro-mundanely multiple-value-list (value-form)
68 `(multiple-value-call #'list ,value-form))
70 ;;;; various conditional constructs
72 ;;; COND defined in terms of IF
73 (defmacro-mundanely cond (&rest clauses)
76 (let ((clause (first clauses)))
78 (error "Cond clause is not a list: ~S" clause)
79 (let ((test (first clause))
80 (forms (rest clause)))
82 (let ((n-result (gensym)))
83 `(let ((,n-result ,test))
86 (cond ,@(rest clauses)))))
89 (cond ,@(rest clauses)))))))))
91 ;;; other things defined in terms of COND
92 (defmacro-mundanely when (test &body forms)
94 "If the first argument is true, the rest of the forms are
95 evaluated as a PROGN."
96 `(cond (,test nil ,@forms)))
97 (defmacro-mundanely unless (test &body forms)
99 "If the first argument is not true, the rest of the forms are
100 evaluated as a PROGN."
101 `(cond ((not ,test) nil ,@forms)))
102 (defmacro-mundanely and (&rest forms)
103 (cond ((endp forms) t)
104 ((endp (rest forms)) (first forms))
109 (defmacro-mundanely or (&rest forms)
110 (cond ((endp forms) nil)
111 ((endp (rest forms)) (first forms))
113 (let ((n-result (gensym)))
114 `(let ((,n-result ,(first forms)))
117 (or ,@(rest forms))))))))
119 ;;;; various sequencing constructs
121 (defmacro-mundanely prog (varlist &body body-decls)
122 (multiple-value-bind (body decls) (parse-body body-decls nil)
128 (defmacro-mundanely prog* (varlist &body body-decls)
129 (multiple-value-bind (body decls) (parse-body body-decls nil)
135 (defmacro-mundanely prog1 (result &body body)
136 (let ((n-result (gensym)))
137 `(let ((,n-result ,result))
141 (defmacro-mundanely prog2 (form1 result &body body)
142 `(prog1 (progn ,form1 ,result) ,@body))
146 ;;; Should we save the inline expansion of the function named NAME?
147 (defun inline-fun-name-p (name)
149 ;; the normal reason for saving the inline expansion
150 (info :function :inlinep name)
151 ;; another reason for saving the inline expansion: If the
152 ;; ANSI-recommended idiom
153 ;; (DECLAIM (INLINE FOO))
155 ;; (DECLAIM (NOTINLINE FOO))
156 ;; has been used, and then we later do another
158 ;; without a preceding
159 ;; (DECLAIM (INLINE FOO))
160 ;; what should we do with the old inline expansion when we see the
161 ;; new DEFUN? Overwriting it with the new definition seems like
162 ;; the only unsurprising choice.
163 (info :function :inline-expansion-designator name)))
165 ;;; Now that we have the definition of MULTIPLE-VALUE-BIND, we can
166 ;;; make a reasonably readable definition of DEFUN.
167 (defmacro-mundanely defun (&environment env name args &body body)
168 "Define a function at top level."
170 (unless (symbol-package (fun-name-block-name name))
171 (warn "DEFUN of uninterned symbol ~S (tricky for GENESIS)" name))
172 (multiple-value-bind (forms decls doc) (parse-body body)
173 (let* (;; stuff shared between LAMBDA and INLINE-LAMBDA
176 (block ,(fun-name-block-name name)
178 (lambda `(lambda ,@lambda-guts))
180 (cond (;; Does the user not even want to inline?
181 (not (inline-fun-name-p name))
183 (;; Does inlining look too hairy to handle?
184 (not (sb!c:lambda-independent-of-lexenv-p lambda env))
185 (sb!c:maybe-compiler-note
186 "lexical environment too hairy, can't inline DEFUN ~S"
190 ;; FIXME: The only reason that we return
191 ;; LAMBDA-WITH-LEXENV instead of returning bare
192 ;; LAMBDA is to avoid modifying downstream code
193 ;; which expects LAMBDA-WITH-LEXENV. But the code
194 ;; here is the only code which feeds into the
195 ;; downstream code, and the generality of the
196 ;; interface is no longer used, so it'd make sense
197 ;; to simplify the interface instead of using the
198 ;; old general LAMBDA-WITH-LEXENV interface in this
200 `(sb!c:lambda-with-lexenv
201 nil nil nil ; i.e. no DECLS, no MACROS, no SYMMACS
205 ;; In cross-compilation of toplevel DEFUNs, we arrange
206 ;; for the LAMBDA to be statically linked by GENESIS.
208 (cold-fset ,name ,lambda)
210 (eval-when (:compile-toplevel :load-toplevel :execute)
211 (sb!c:%compiler-defun ',name ',inline-lambda))
214 ;; In normal compilation (not for cold load) this is
215 ;; where the compiled LAMBDA first appears. In
216 ;; cross-compilation, we manipulate the
217 ;; previously-statically-linked LAMBDA here.
219 #+sb-xc-host (fdefinition ',name)
222 (defun %defun (name def doc)
223 (declare (type function def))
224 (declare (type (or null simple-string doc)))
225 (aver (legal-fun-name-p name))
227 (/show0 "redefining NAME in %DEFUN")
228 (style-warn "redefining ~S in DEFUN" name))
229 (setf (sb!xc:fdefinition name) def)
231 ;; FIXME: I want to do this here (and fix bug 137), but until the
232 ;; breathtaking CMU CL function name architecture is converted into
233 ;; something sane, (1) doing so doesn't really fix the bug, and
234 ;; (2) doing probably isn't even really safe.
235 #+nil (setf (%fun-name def) name)
238 ;; FIXME: This should use shared SETF-name-parsing logic.
239 (if (and (consp name) (eq (first name) 'setf))
240 (setf (fdocumentation (second name) 'setf) doc)
241 (setf (fdocumentation (the symbol name) 'function) doc)))
244 ;;;; DEFVAR and DEFPARAMETER
246 (defmacro-mundanely defvar (var &optional (val nil valp) (doc nil docp))
248 "Define a global variable at top level. Declare the variable
249 SPECIAL and, optionally, initialize it. If the variable already has a
250 value, the old value is not clobbered. The third argument is an optional
251 documentation string for the variable."
253 (declaim (special ,var))
255 `((unless (boundp ',var)
258 `((funcall #'(setf fdocumentation) ',doc ',var 'variable)))
261 (defmacro-mundanely defparameter (var val &optional (doc nil docp))
263 "Define a parameter that is not normally changed by the program,
264 but that may be changed without causing an error. Declare the
265 variable special and sets its value to VAL, overwriting any
266 previous value. The third argument is an optional documentation
267 string for the parameter."
269 (declaim (special ,var))
272 ;; FIXME: The various FUNCALL #'(SETF FDOCUMENTATION) and
273 ;; other FUNCALL #'(SETF FOO) forms in the code should
274 ;; unbogobootstrapized back to ordinary SETF forms.
275 `((funcall #'(setf fdocumentation) ',doc ',var 'variable)))
278 ;;;; iteration constructs
280 ;;; (These macros are defined in terms of a function DO-DO-BODY which
281 ;;; is also used by SB!INT:DO-ANONYMOUS. Since these macros should not
282 ;;; be loaded on the cross-compilation host, but SB!INT:DO-ANONYMOUS
283 ;;; and DO-DO-BODY should be, these macros can't conveniently be in
284 ;;; the same file as DO-DO-BODY.)
285 (defmacro-mundanely do (varlist endlist &body body)
287 "DO ({(Var [Init] [Step])}*) (Test Exit-Form*) Declaration* Form*
288 Iteration construct. Each Var is initialized in parallel to the value of the
289 specified Init form. On subsequent iterations, the Vars are assigned the
290 value of the Step form (if any) in parallel. The Test is evaluated before
291 each evaluation of the body Forms. When the Test is true, the Exit-Forms
292 are evaluated as a PROGN, with the result being the value of the DO. A block
293 named NIL is established around the entire expansion, allowing RETURN to be
294 used as an alternate exit mechanism."
295 (do-do-body varlist endlist body 'let 'psetq 'do nil))
296 (defmacro-mundanely do* (varlist endlist &body body)
298 "DO* ({(Var [Init] [Step])}*) (Test Exit-Form*) Declaration* Form*
299 Iteration construct. Each Var is initialized sequentially (like LET*) to the
300 value of the specified Init form. On subsequent iterations, the Vars are
301 sequentially assigned the value of the Step form (if any). The Test is
302 evaluated before each evaluation of the body Forms. When the Test is true,
303 the Exit-Forms are evaluated as a PROGN, with the result being the value
304 of the DO. A block named NIL is established around the entire expansion,
305 allowing RETURN to be used as an laternate exit mechanism."
306 (do-do-body varlist endlist body 'let* 'setq 'do* nil))
308 ;;; DOTIMES and DOLIST could be defined more concisely using
309 ;;; destructuring macro lambda lists or DESTRUCTURING-BIND, but then
310 ;;; it'd be tricky to use them before those things were defined.
311 ;;; They're used enough times before destructuring mechanisms are
312 ;;; defined that it looks as though it's worth just implementing them
313 ;;; ASAP, at the cost of being unable to use the standard
314 ;;; destructuring mechanisms.
315 (defmacro-mundanely dotimes (var-count-result &body body)
316 (multiple-value-bind ; to roll our own destructuring
318 (apply (lambda (var count &optional (result nil))
319 (values var count result))
321 (cond ((numberp count)
322 `(do ((,var 0 (1+ ,var)))
323 ((>= ,var ,count) ,result)
324 (declare (type unsigned-byte ,var))
326 (t (let ((v1 (gensym)))
327 `(do ((,var 0 (1+ ,var)) (,v1 ,count))
328 ((>= ,var ,v1) ,result)
329 (declare (type unsigned-byte ,var))
331 (defmacro-mundanely dolist (var-list-result &body body)
332 (multiple-value-bind ; to roll our own destructuring
334 (apply (lambda (var list &optional (result nil))
335 (values var list result))
337 ;; We repeatedly bind the var instead of setting it so that we
338 ;; never have to give the var an arbitrary value such as NIL
339 ;; (which might conflict with a declaration). If there is a result
340 ;; form, we introduce a gratuitous binding of the variable to NIL
341 ;; without the declarations, then evaluate the result form in that
342 ;; environment. We spuriously reference the gratuitous variable,
343 ;; since since we don't want to use IGNORABLE on what might be a
345 (let ((n-list (gensym)))
346 `(do ((,n-list ,list (cdr ,n-list)))
353 (let ((,var (car ,n-list)))
358 (defmacro-mundanely return (&optional (value nil))
359 `(return-from nil ,value))
361 (defmacro-mundanely psetq (&rest pairs)
364 Set the variables to the values, like SETQ, except that assignments
365 happen in parallel, i.e. no assignments take place until all the
366 forms have been evaluated."
367 ;; (This macro is used in the definition of DO, so we can't use DO in the
368 ;; definition of this macro without getting into confusing bootstrap issues.)
373 (when (atom (cdr pairs))
374 (return `(let ,(nreverse lets)
375 (setq ,@(nreverse setqs))
377 (let ((gen (gensym)))
378 (setq lets (cons `(,gen ,(cadr pairs)) lets)
379 setqs (list* gen (car pairs) setqs)
383 (defmacro-mundanely lambda (&whole whole args &body body)
384 (declare (ignore args body))