0.8.20.1: fun-name fun, debugger debugged
[sbcl.git] / src / code / target-misc.lisp
index 5ea1f53..fb151f1 100644 (file)
 ;;;; files for more information.
 
 (in-package "SB!IMPL")
+\f
+;;;; function names and documentation
+
+;;;; the ANSI interface to function names (and to other stuff too)
+(defun function-lambda-expression (fun)
+  "Return (VALUES DEFINING-LAMBDA-EXPRESSION CLOSURE-P NAME), where
+  DEFINING-LAMBDA-EXPRESSION is NIL if unknown, or a suitable argument
+  to COMPILE otherwise, CLOSURE-P is non-NIL if the function's definition
+  might have been enclosed in some non-null lexical environment, and
+  NAME is some name (for debugging only) or NIL if there is no name."
+    (declare (type function fun))
+    (let* ((fun (%simple-fun-self fun))
+          (name (%fun-name fun))
+          (code (sb!di::fun-code-header fun))
+          (info (sb!kernel:%code-debug-info code)))
+      (if info
+        (let ((source (first (sb!c::compiled-debug-info-source info))))
+          (cond ((and (eq (sb!c::debug-source-from source) :lisp)
+                      (eq (sb!c::debug-source-info source) fun))
+                 (values (svref (sb!c::debug-source-name source) 0)
+                         nil
+                        name))
+                ((legal-fun-name-p name)
+                 (let ((exp (fun-name-inline-expansion name)))
+                   (values exp (not exp) name)))
+                (t
+                 (values nil t name))))
+        (values nil t name))))
+
+(defun closurep (object)
+  (= sb!vm:closure-header-widetag (widetag-of object)))
+
+(defun %fun-fun (function)
+  (declare (function function))
+  (case (widetag-of function)
+    (#.sb!vm:simple-fun-header-widetag 
+     function)
+    (#.sb!vm:closure-header-widetag 
+     (%closure-fun function))
+    (#.sb!vm:funcallable-instance-header-widetag
+     (funcallable-instance-fun function))))
+
+(defun %closure-values (object)
+  (declare (function object))
+  (coerce (loop for index from 0 below (1- (get-closure-length object))
+                collect (%closure-index-ref object index))
+          'simple-vector))
+
+(defun %fun-lambda-list (object)
+  (%simple-fun-arglist (%fun-fun object)))
 
-;;; cobbled from stuff in describe.lisp.
-(defun function-doc (x)
-  (let ((name
-        (case (get-type x)
-          (#.sb!vm:closure-header-type
-           (%function-name (%closure-function x)))
-          ((#.sb!vm:function-header-type #.sb!vm:closure-function-header-type)
-           (%function-name x))
-          (#.sb!vm:funcallable-instance-header-type
-           (%function-name
-            (funcallable-instance-function x))))))
+;;; a SETFable function to return the associated debug name for FUN
+;;; (i.e., the third value returned from CL:FUNCTION-LAMBDA-EXPRESSION),
+;;; or NIL if there's none
+(defun %fun-name (function)
+  (%simple-fun-name (%fun-fun function)))
+
+(defun %fun-type (function)
+  (%simple-fun-type (%fun-fun function)))
+
+(defun (setf %fun-name) (new-name fun)
+  (aver nil) ; since this is unsafe 'til bug 137 is fixed
+  (let ((widetag (widetag-of fun)))
+    (case widetag
+      (#.sb!vm:simple-fun-header-widetag
+       ;; KLUDGE: The pun that %SIMPLE-FUN-NAME is used for closure
+       ;; functions is left over from CMU CL (modulo various renaming
+       ;; that's gone on since the fork).
+       (setf (%simple-fun-name fun) new-name))
+      (#.sb!vm:closure-header-widetag
+       ;; FIXME: It'd be nice to be able to set %FUN-NAME here on
+       ;; per-closure basis. Instead, we are still using the CMU CL
+       ;; approach of closures being named after their closure
+       ;; function, which doesn't work right e.g. for structure
+       ;; accessors, and might not be quite right for DEFUN
+       ;; in a non-null lexical environment either.
+       ;; When/if weak hash tables become supported
+       ;; again, it'll become easy to fix this, but for now there
+       ;; seems to be no easy way (short of the ugly way of adding a
+       ;; slot to every single closure header), so we don't. 
+       ;;
+       ;; Meanwhile, users might encounter this problem by doing DEFUN
+       ;; in a non-null lexical environment, so we try to give a
+       ;; reasonably meaningful user-level "error" message (but only
+       ;; as a warning because this is optional debugging
+       ;; functionality anyway, not some hard ANSI requirement).
+       (warn "can't set name for closure, leaving name unchanged"))
+      (t
+       ;; The other function subtype names are also un-settable
+       ;; but this problem seems less likely to be tickled by
+       ;; user-level code, so we can give a implementor-level
+       ;; "error" (warning) message.
+       (warn "can't set function name ((~S function)=~S), leaving it unchanged"
+            'widetag-of widetag))))
+  new-name)
+
+(defun %fun-doc (x)
+  ;; FIXME: This business of going through %FUN-NAME and then globaldb
+  ;; is the way CMU CL did it, but it doesn't really seem right.
+  ;; When/if weak hash tables become supported again, using a weak
+  ;; hash table to maintain the object/documentation association would
+  ;; probably be better.
+  (let ((name (%fun-name x)))
     (when (and name (typep name '(or symbol cons)))
       (values (info :function :documentation name)))))
+\f
+;;; various environment inquiries
 
 (defvar *features* '#.sb-cold:*shebang-features*
   #!+sb-doc
   "a list of symbols that describe features provided by the
    implementation")
-\f
-;;; various environment inquiries
 
 (defun machine-instance ()
   #!+sb-doc
   "Return a string giving the name of the local machine."
   (sb!unix:unix-gethostname))
 
+(defvar *machine-version*)
+
+(defun machine-version ()
+  #!+sb-doc
+  "Return a string describing the version of the computer hardware we
+are running on, or NIL if we can't find any useful information."
+  (unless (boundp '*machine-version*)
+    (setf *machine-version* (get-machine-version)))
+  *machine-version*)
+  
 ;;; FIXME: Don't forget to set these in a sample site-init file.
 ;;; FIXME: Perhaps the functions could be SETFable instead of having the
 ;;; interface be through special variables? As far as I can tell
   #!+sb-doc "the value of LONG-SITE-NAME")
 (defun short-site-name ()
   #!+sb-doc
-  "Returns a string with the abbreviated site name, or NIL if not known."
+  "Return a string with the abbreviated site name, or NIL if not known."
   *short-site-name*)
 (defun long-site-name ()
   #!+sb-doc
-  "Returns a string with the long form of the site name, or NIL if not known."
+  "Return a string with the long form of the site name, or NIL if not known."
   *long-site-name*)
 \f
+;;;; ED
+(defvar *ed-functions* nil
+  "See function documentation for ED.")
+
+(defun ed (&optional x)
+  "Starts the editor (on a file or a function if named).  Functions
+from the list *ED-FUNCTIONS* are called in order with X as an argument
+until one of them returns non-NIL; these functions are responsible for
+signalling a FILE-ERROR to indicate failure to perform an operation on
+the file system."
+  (dolist (fun *ed-functions*
+          (error 'extension-failure
+                 :format-control "Don't know how to ~S ~A"
+                 :format-arguments (list 'ed x)
+                 :references (list '(:sbcl :variable *ed-functions*))))
+    (when (funcall fun x)
+      (return t))))
+\f
 ;;;; dribble stuff
 
 ;;; Each time we start dribbling to a new stream, we put it in
 
 (defun %byte-blt (src src-start dst dst-start dst-end)
   (%byte-blt src src-start dst dst-start dst-end))
+
+;;;; some *LOAD-FOO* variables
+
+(defvar *load-print* nil
+  #!+sb-doc
+  "the default for the :PRINT argument to LOAD")
+
+(defvar *load-verbose* nil
+  ;; Note that CMU CL's default for this was T, and ANSI says it's
+  ;; implementation-dependent. We choose NIL on the theory that it's
+  ;; a nicer default behavior for Unix programs.
+  #!+sb-doc
+  "the default for the :VERBOSE argument to LOAD")