Fix typos in docstrings and function names.
[sbcl.git] / src / compiler / early-c.lisp
index f3c7319..b772aa4 100644 (file)
 (in-package "SB!C")
 
 ;;; ANSI limits on compilation
-(def!constant sb!xc:call-arguments-limit most-positive-fixnum
+(def!constant sb!xc:call-arguments-limit sb!xc:most-positive-fixnum
   #!+sb-doc
   "The exclusive upper bound on the number of arguments which may be passed
   to a function, including &REST args.")
-(def!constant sb!xc:lambda-parameters-limit most-positive-fixnum
+(def!constant sb!xc:lambda-parameters-limit sb!xc:most-positive-fixnum
   #!+sb-doc
-  "The exclusive upper bound on the number of parameters which may be specifed
+  "The exclusive upper bound on the number of parameters which may be specified
   in a given lambda list. This is actually the limit on required and &OPTIONAL
   parameters. With &KEY and &AUX you can get more.")
-(def!constant sb!xc:multiple-values-limit most-positive-fixnum
+(def!constant sb!xc:multiple-values-limit sb!xc:most-positive-fixnum
   #!+sb-doc
   "The exclusive upper bound on the number of multiple VALUES that you can
   return.")
-
-(defconstant-eqx sb!xc:lambda-list-keywords
-  '(&allow-other-keys
-    &aux
-    &body
-    &environment
-    &key
-    &more
-    &optional
-    &rest
-    &whole)
-  #'equal
-  #!+sb-doc
-  "symbols which are magical in a lambda list")
 \f
 ;;;; cross-compiler-only versions of CL special variables, so that we
 ;;;; don't have weird interactions with the host compiler
 (defvar *constants*)
 (declaim (type hash-table *constants*))
 
+;;; *ALLOW-INSTRUMENTING* controls whether we should allow the
+;;; insertion of instrumenting code (like a (CATCH ...)) around code
+;;; to allow the debugger RETURN and STEP commands to function (we
+;;; disallow it for internal stuff).
+(defvar *allow-instrumenting*)
+
 ;;; miscellaneous forward declarations
 (defvar *code-segment*)
 #!+sb-dyncount (defvar *collect-dynamic-statistics*)
 (defvar *compiler-style-warning-count*)
 (defvar *compiler-note-count*)
 (defvar *compiler-trace-output*)
-(defvar *constraint-number*)
+(defvar *constraint-universe*)
 (defvar *count-vop-usages*)
 (defvar *current-path*)
 (defvar *current-component*)
 (defvar *delayed-ir1-transforms*)
+(defvar *eval-tlf-index*)
+(defvar *handled-conditions*)
+(defvar *disabled-package-locks*)
 (defvar *policy*)
 (defvar *dynamic-counts-tn*)
 (defvar *elsewhere*)
 (defvar *fixup-notes*)
 (defvar *in-pack*)
 (defvar *info-environment*)
+#!+inline-constants
+(progn
+  (defvar *constant-segment*)
+  (defvar *constant-table*)
+  (defvar *constant-vector*))
 (defvar *lexenv*)
 (defvar *source-info*)
+(defvar *source-plist*)
+(defvar *source-namestring*)
 (defvar *trace-table*)
 (defvar *undefined-warnings*)
 (defvar *warnings-p*)
+(defvar *lambda-conversions*)
+
+(defvar *stack-allocate-dynamic-extent* t
+  "If true (the default), the compiler respects DYNAMIC-EXTENT declarations
+and stack allocates otherwise inaccessible parts of the object whenever
+possible. Potentially long (over one page in size) vectors are, however, not
+stack allocated except in zero SAFETY code, as such a vector could overflow
+the stack without triggering overflow protection.")
+
+(!begin-collecting-cold-init-forms)
+;;; This lock is seized in the compiler, and related areas -- like the
+;;; classoid/layout/class system.
+(defglobal **world-lock** nil)
+(!cold-init-forms
+ (setf **world-lock** (sb!thread:make-mutex :name "World Lock")))
+(!defun-from-collected-cold-init-forms !world-lock-cold-init)
+
+(defmacro with-world-lock (() &body body)
+  `(sb!thread:with-recursive-lock (**world-lock**)
+     ,@body))
+
+(declaim (type fixnum *compiler-sset-counter*))
+(defvar *compiler-sset-counter* 0)
 
 ;;; unique ID for the next object created (to let us track object
 ;;; identity even across GC, useful for understanding weird compiler
   (defvar *object-id-counter* 0)
   (defun new-object-id ()
     (prog1
-       *object-id-counter*
+        *object-id-counter*
       (incf *object-id-counter*))))
 \f
 ;;;; miscellaneous utilities
 ;;; benefit of the compiler, but it's sometimes called from stuff like
 ;;; type-defining code which isn't logically part of the compiler.
 (declaim (ftype (function ((or symbol cons) keyword) (values))
-               note-name-defined))
+                note-name-defined))
 (defun note-name-defined (name kind)
   ;; We do this BOUNDP check because this function can be called when
   ;; not in a compilation unit (as when loading top level forms).
   (when (boundp '*undefined-warnings*)
     (setq *undefined-warnings*
-         (delete-if (lambda (x)
-                      (and (equal (undefined-warning-name x) name)
-                           (eq (undefined-warning-kind x) kind)))
-                    *undefined-warnings*)))
+          (delete-if (lambda (x)
+                       (and (equal (undefined-warning-name x) name)
+                            (eq (undefined-warning-kind x) kind)))
+                     *undefined-warnings*)))
   (values))
 
 ;;; to be called when a variable is lexically bound
     ;; and then we happen to compile bar.lisp before foo.lisp.
   (when (looks-like-name-of-special-var-p symbol)
     ;; FIXME: should be COMPILER-STYLE-WARNING?
-    (style-warn "using the lexical binding of the symbol ~S, not the~@
-dynamic binding, even though the symbol name follows the usual naming~@
-convention (names like *FOO*) for special variables" symbol))
+    (style-warn 'sb!kernel:asterisks-around-lexical-variable-name
+                :format-control
+                "using the lexical binding of the symbol ~
+                 ~/sb-impl::print-symbol-with-prefix/, not the~@
+                 dynamic binding"
+                :format-arguments (list symbol)))
   (values))
 
-;;; shorthand for creating debug names from source names or other
-;;; stems, e.g.
-;;;   (DEBUG-NAMIFY "FLET ~S" SOURCE-NAME)
-;;;   (DEBUG-NAMIFY "top level form ~S" FORM)
-;;;
-;;; FIXME: This function seems to have a lot in common with
-;;; STRINGIFY-FORM, and perhaps there's some way to merge the two
-;;; functions.
-(declaim (ftype (sfunction (string &rest t) string) debug-namify))
-(defun debug-namify (format-string &rest format-arguments)
-  (with-standard-io-syntax
-   (let ((*print-readably* nil)
-         (*package* *cl-package*)
-         (*print-length* 3)
-         (*print-level* 2))
-     (apply #'format nil format-string format-arguments))))
+(def!struct (debug-name-marker (:make-load-form-fun dump-debug-name-marker)
+                               (:print-function print-debug-name-marker)))
+
+(defvar *debug-name-level* 4)
+(defvar *debug-name-length* 12)
+(defvar *debug-name-punt*)
+(defvar *debug-name-sharp*)
+(defvar *debug-name-ellipsis*)
+
+(eval-when (#-sb-xc :compile-toplevel :load-toplevel :execute)
+  (defun dump-debug-name-marker (marker &optional env)
+    (declare (ignore env))
+    (cond ((eq marker *debug-name-sharp*)
+           `(if (boundp '*debug-name-sharp*)
+                *debug-name-sharp*
+                (make-debug-name-marker)))
+          ((eq marker *debug-name-ellipsis*)
+           `(if (boundp '*debug-name-ellipsis*)
+                *debug-name-ellipsis*
+                (make-debug-name-marker)))
+          (t
+           (warn "Dumping unknown debug-name marker.")
+           '(make-debug-name-marker)))))
+
+(defun print-debug-name-marker (marker stream level)
+  (declare (ignore level))
+  (cond ((eq marker *debug-name-sharp*)
+         (write-char #\# stream))
+        ((eq marker *debug-name-ellipsis*)
+         (write-string "..." stream))
+        (t
+         (write-string "???" stream))))
+
+(setf *debug-name-sharp* (make-debug-name-marker)
+      *debug-name-ellipsis* (make-debug-name-marker))
+
+(defun debug-name (type thing &optional context)
+  (let ((*debug-name-punt* nil))
+    (labels ((walk (x)
+               (typecase x
+                 (cons
+                  (if (plusp *debug-name-level*)
+                      (let ((*debug-name-level* (1- *debug-name-level*)))
+                        (do ((tail (cdr x) (cdr tail))
+                             (name (cons (walk (car x)) nil)
+                                   (cons (walk (car tail)) name))
+                             (n (1- *debug-name-length*) (1- n)))
+                            ((or (not (consp tail))
+                                 (not (plusp n))
+                                 *debug-name-punt*)
+                             (cond (*debug-name-punt*
+                                    (setf *debug-name-punt* nil)
+                                    (nreverse name))
+                                   ((atom tail)
+                                    (nconc (nreverse name) (walk tail)))
+                                   (t
+                                    (setf *debug-name-punt* t)
+                                    (nconc (nreverse name) (list *debug-name-ellipsis*)))))))
+                      *debug-name-sharp*))
+                 ((or symbol number string)
+                  x)
+                 (t
+                  (type-of x)))))
+      (let ((name (list* type (walk thing) (when context (name-context)))))
+        (when (legal-fun-name-p name)
+          (bug "~S is a legal function name, and cannot be used as a ~
+                debug name." name))
+        name))))