0.pre7.129:
[sbcl.git] / src / code / kernel.lisp
index 42fe943..08b69bb 100644 (file)
 
 (in-package "SB!KERNEL")
 
+;;; Return the 24 bits of data in the header of object X, which must
+;;; be an other-pointer object.
 (defun get-header-data (x)
-  #!+sb-doc
-  "Return the 24 bits of data in the header of object X, which must be an
-  other-pointer object."
   (get-header-data x))
 
+;;; Set the 24 bits of data in the header of object X (which must be
+;;; an other-pointer object) to VAL.
 (defun set-header-data (x val)
-  #!+sb-doc
-  "Sets the 24 bits of data in the header of object X (which must be an
-  other-pointer object) to VAL."
   (set-header-data x val))
 
+;;; the length of the closure X, i.e. one more than the
+;;; number of variables closed over
 (defun get-closure-length (x)
-  #!+sb-doc
-  "Returns the length of the closure X. This is one more than the number
-  of variables closed over."
   (get-closure-length x))
 
-(defun get-lowtag (x)
-  #!+sb-doc
-  "Returns the three-bit lowtag for the object X."
-  (get-lowtag x))
+(defun lowtag-of (x)
+  (lowtag-of x))
 
-(defun get-type (x)
-  #!+sb-doc
-  "Returns the 8-bit header type for the object X."
-  (get-type x))
+(defun widetag-of (x)
+  (widetag-of x))
 
+;;; Return a System-Area-Pointer pointing to the data for the vector
+;;; X, which must be simple.
+;;;
+;;; FIXME: So it should be SIMPLE-VECTOR-SAP, right? (or UNHAIRY-VECTOR-SAP,
+;;; if the meaning is (SIMPLE-ARRAY * 1) instead of SIMPLE-VECTOR)
+;;; (or maybe SIMPLE-VECTOR-DATA-SAP or UNHAIRY-VECTOR-DATA-SAP?)
 (defun vector-sap (x)
-  #!+sb-doc
-  "Return a System-Area-Pointer pointing to the data for the vector X, which
-  must be simple."
   (declare (type (simple-unboxed-array (*)) x))
   (vector-sap x))
 
+;;; Return a System-Area-Pointer pointing to the end of the binding stack.
 (defun sb!c::binding-stack-pointer-sap ()
-  #!+sb-doc
-  "Return a System-Area-Pointer pointing to the end of the binding stack."
   (sb!c::binding-stack-pointer-sap))
 
+;;; Return a System-Area-Pointer pointing to the next free word of the
+;;; current dynamic space.
 (defun sb!c::dynamic-space-free-pointer ()
-  #!+sb-doc
-  "Returns a System-Area-Pointer pointing to the next free work of the current
-  dynamic space."
   (sb!c::dynamic-space-free-pointer))
 
+;;; Return a System-Area-Pointer pointing to the end of the control stack.
 (defun sb!c::control-stack-pointer-sap ()
-  #!+sb-doc
-  "Return a System-Area-Pointer pointing to the end of the control stack."
   (sb!c::control-stack-pointer-sap))
 
-(defun function-subtype (function)
-  #!+sb-doc
-  "Return the header typecode for FUNCTION. Can be set with SETF."
-  (function-subtype function))
+;;; Return the header typecode for FUNCTION. Can be set with SETF.
+(defun fun-subtype (function)
+  (fun-subtype function))
+(defun (setf fun-subtype) (type function)
+  (setf (fun-subtype function) type))
 
-(defun (setf function-subtype) (type function)
-  (setf (function-subtype function) type))
+;;; Extract the arglist from the function header FUNC.
+(defun %simple-fun-arglist (func)
+  (%simple-fun-arglist func))
 
-(defun %function-arglist (func)
-  #!+sb-doc
-  "Extracts the arglist from the function header FUNC."
-  (%function-arglist func))
+;;; Extract the name from the function header FUNC.
+(defun %simple-fun-name (func)
+  (%simple-fun-name func))
 
-(defun %function-name (func)
-  #!+sb-doc
-  "Extracts the name from the function header FUNC."
-  (%function-name func))
+;;; Extract the type from the function header FUNC.
+(defun %simple-fun-type (func)
+  (%simple-fun-type func))
 
-(defun %function-type (func)
-  #!+sb-doc
-  "Extracts the type from the function header FUNC."
-  (%function-type func))
+(defun %simple-fun-next (simple-fun)
+  (%simple-fun-next simple-fun))
 
-(defun %closure-function (closure)
-  #!+sb-doc
-  "Extracts the function from CLOSURE."
-  (%closure-function closure))
+(defun %simple-fun-self (simple-fun)
+  (%simple-fun-self simple-fun))
 
+;;; Extract the function from CLOSURE.
+(defun %closure-fun (closure)
+  (%closure-fun closure))
+
+;;; Return the length of VECTOR. There is no reason to use this in
+;;; ordinary code, 'cause length (the vector foo)) is the same.
 (defun sb!c::vector-length (vector)
-  #!+sb-doc
-  "Return the length of VECTOR. There is no reason to use this, 'cause
-  (length (the vector foo)) is the same."
   (sb!c::vector-length vector))
 
+;;; Extract the INDEXth slot from CLOSURE.
 (defun %closure-index-ref (closure index)
-  #!+sb-doc
-  "Extract the INDEXth slot from CLOSURE."
   (%closure-index-ref closure index))
 
+;;; Allocate a unboxed, simple vector with type code TYPE, length LENGTH, and
+;;; WORDS words long. Note: it is your responsibility to ensure that the
+;;; relation between LENGTH and WORDS is correct.
 (defun allocate-vector (type length words)
-  #!+sb-doc
-  "Allocate a unboxed, simple vector with type code TYPE, length LENGTH, and
-  WORDS words long. Note: it is your responsibility to ensure that the
-  relation between LENGTH and WORDS is correct."
   (allocate-vector type length words))
 
+;;; Allocate an array header with type code TYPE and rank RANK.
 (defun make-array-header (type rank)
-  #!+sb-doc
-  "Allocate an array header with type code TYPE and rank RANK."
   (make-array-header type rank))
 
+;;; Return a SAP pointing to the instructions part of CODE-OBJ.
 (defun code-instructions (code-obj)
-  #!+sb-doc
-  "Return a SAP pointing to the instructions part of CODE-OBJ."
   (code-instructions code-obj))
 
+;;; Extract the INDEXth element from the header of CODE-OBJ. Can be
+;;; set with SETF.
 (defun code-header-ref (code-obj index)
-  #!+sb-doc
-  "Extract the INDEXth element from the header of CODE-OBJ. Can be set with
-  setf."
   (code-header-ref code-obj index))
 
 (defun code-header-set (code-obj index new)
   (sb!kernel:%raw-bits object offset))
 
 (defun %set-raw-bits (object offset value)
-  (declare (type index offset) (type (unsigned-byte #.sb!vm:word-bits) value))
+  (declare (type index offset))
+  (declare (type (unsigned-byte #.sb!vm:n-word-bits) value))
   (setf (sb!kernel:%raw-bits object offset) value))
 
 (defun make-single-float (x) (make-single-float x))