src/code/parse-body.lisp

   1 ;;;; functions used to parse function/macro bodies
   2 ;;;;
   3 ;;;; FIXME: In an early attempt to bootstrap SBCL, this file
   4 ;;;; was loaded before fundamental things like DEFUN and AND and OR
   5 ;;;; were defined, and it still bears scars from the attempt to
   6 ;;;; make that work. (TAGBODY, forsooth..) It should be cleaned up.
   7
   8 ;;;; This software is part of the SBCL system. See the README file for
   9 ;;;; more information.
  10 ;;;;
  11 ;;;; This software is derived from the CMU CL system, which was
  12 ;;;; written at Carnegie Mellon University and released into the
  13 ;;;; public domain. The software is in the public domain and is
  14 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  15 ;;;; files for more information.
  16
  17 (in-package "SB!INT")
  18
  19 (/show0 "entering parse-body.lisp")
  20
  21 ;;; Given a sequence of declarations (and possibly a documentation
  22 ;;; string) followed by other forms (as occurs in the bodies of DEFUN,
  23 ;;; DEFMACRO, etc.) return (VALUES FORMS DECLS DOC), where DECLS holds
  24 ;;; declarations, DOC holds a doc string (or NIL if none), and FORMS
  25 ;;; holds the other forms.
  26 ;;;
  27 ;;; If DOC-STRING-ALLOWED is NIL, then no forms will be treated as
  28 ;;; documentation strings.
  29 (defun parse-body (body &optional (doc-string-allowed t))
  30   (let ((reversed-decls nil)
  31         (forms body)
  32         (doc nil))
  33     ;; Since we don't have macros like AND, OR, and NOT yet, it's
  34     ;; hard to express these tests clearly. Giving them names
  35     ;; seems to help a little bit.
  36     (flet ((doc-string-p (x remaining-forms)
  37              (if (stringp x)
  38                (if doc-string-allowed
  39                  ;; ANSI 3.4.11 explicitly requires that a doc
  40                  ;; string be followed by another form (either an
  41                  ;; ordinary form or a declaration). Hence:
  42                  (if remaining-forms
  43                    (if doc
  44                      ;; ANSI 3.4.11 says that the consequences of
  45                      ;; duplicate doc strings are unspecified.
  46                      ;; That's probably not something the
  47                      ;; programmer intends. We raise an error so
  48                      ;; that this won't pass unnoticed.
  49                      (error "duplicate doc string ~S" x)
  50                      t)))))
  51            (declaration-p (x)
  52              (if (consp x)
  53                  (let ((name (car x)))
  54                    (if (eq name 'declaim)
  55                        ;; technically legal, but rather unlikely to
  56                        ;; be what the user intended...
  57                        (progn
  58                          (style-warn
  59                           "DECLAIM where DECLARE was probably intended")
  60                          nil)
  61                        (eq name 'declare))))))
  62       (tagbody
  63         :again
  64         (if forms
  65           (let ((form1 (first forms)))
  66             ;; Note: The (IF (IF ..) ..) stuff is because we don't
  67             ;; have the macro AND yet.:-|
  68             (if (doc-string-p form1 (rest forms))
  69               (setq doc form1)
  70               (if (declaration-p form1)
  71                 (setq reversed-decls
  72                       (cons form1 reversed-decls))
  73                 (go :done)))
  74             (setq forms (rest forms))
  75             (go :again)))
  76         :done)
  77       (values forms
  78               (nreverse reversed-decls)
  79               doc))))
  80
  81 (/show0 "leaving parse-body.lisp")