Merge branch 'master' into boehm-demers-weiser-gc
[bpt/guile.git] / libguile / objects.c
index 568e25a..f686c3a 100644 (file)
@@ -1,46 +1,21 @@
-/*     Copyright (C) 1995, 1996, 1999, 2000 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1999,2000,2001, 2003, 2004, 2006, 2008 Free Software Foundation, Inc.
  * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 of
+ * the License, or (at your option) any later version.
  *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
+ * This library is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
 
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 
 \f
 
  * libguile.  See the comments in objects.h.
  */
 
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
 #include "libguile/_scm.h"
 
 #include "libguile/struct.h"
 #include "libguile/ports.h"
 #include "libguile/strings.h"
 #include "libguile/vectors.h"
+#include "libguile/programs.h"
+#include "libguile/vm.h"
 
 #include "libguile/validate.h"
 #include "libguile/objects.h"
+#include "libguile/goops.h"
+
 \f
 
 SCM scm_metaclass_standard;
 SCM scm_metaclass_operator;
 
-/* These variables are filled in by the object system when loaded. */
-SCM scm_class_boolean, scm_class_char, scm_class_pair;
-SCM scm_class_procedure, scm_class_string, scm_class_symbol;
-SCM scm_class_procedure_with_setter, scm_class_primitive_generic;
-SCM scm_class_vector, scm_class_null;
-SCM scm_class_integer, scm_class_real, scm_class_complex;
-SCM scm_class_unknown;
-
-SCM *scm_port_class = 0;
-SCM *scm_smob_class = 0;
-
-SCM scm_no_applicable_method;
-
-SCM (*scm_make_extended_class) (char *type_name);
-void (*scm_make_port_classes) (int ptobnum, char *type_name);
-void (*scm_change_object_class) (SCM, SCM, SCM);
-
-/* This function is used for efficient type dispatch.  */
-SCM
-scm_class_of (SCM x)
-{
-  switch (SCM_ITAG3 (x))
-    {
-    case scm_tc3_int_1:
-    case scm_tc3_int_2:
-      return scm_class_integer;
-
-    case scm_tc3_imm24:
-      if (SCM_CHARP (x))
-       return scm_class_char;
-      else
-       {
-         switch (SCM_ISYMNUM (x))
-           {
-           case SCM_ISYMNUM (SCM_BOOL_F):
-           case SCM_ISYMNUM (SCM_BOOL_T):
-             return scm_class_boolean;
-           case SCM_ISYMNUM (SCM_EOL):
-             return scm_class_null;
-           default:
-             return scm_class_unknown;
-           }
-       }
-
-    case scm_tc3_cons:
-      switch (SCM_TYP7 (x))
-       {
-       case scm_tcs_cons_nimcar:
-         return scm_class_pair;
-       case scm_tcs_closures:
-         return scm_class_procedure;
-       case scm_tcs_symbols:
-         return scm_class_symbol;
-       case scm_tc7_vector:
-       case scm_tc7_wvect:
-#ifdef HAVE_ARRAYS
-       case scm_tc7_bvect:
-       case scm_tc7_byvect:
-       case scm_tc7_svect:
-       case scm_tc7_ivect:
-       case scm_tc7_uvect:
-       case scm_tc7_fvect:
-       case scm_tc7_dvect:
-       case scm_tc7_cvect:
-#endif
-         return scm_class_vector;
-       case scm_tc7_string:
-       case scm_tc7_substring:
-         return scm_class_string;
-       case scm_tc7_asubr:
-       case scm_tc7_subr_0:
-       case scm_tc7_subr_1:
-       case scm_tc7_cxr:
-       case scm_tc7_subr_3:
-       case scm_tc7_subr_2:
-       case scm_tc7_rpsubr:
-       case scm_tc7_subr_1o:
-       case scm_tc7_subr_2o:
-       case scm_tc7_lsubr_2:
-       case scm_tc7_lsubr:
-         if (SCM_SUBR_GENERIC (x) && *SCM_SUBR_GENERIC (x))
-           return scm_class_primitive_generic;
-         else
-           return scm_class_procedure;
-       case scm_tc7_cclo:
-         return scm_class_procedure;
-       case scm_tc7_pws:
-         return scm_class_procedure_with_setter;
-
-       case scm_tc7_smob:
-         {
-           long type = SCM_TYP16 (x);
-           if (type != scm_tc16_port_with_ps)
-             return scm_smob_class[SCM_TC2SMOBNUM (type)];
-           x = SCM_PORT_WITH_PS_PORT (x);
-           /* fall through to ports */
-         }
-       case scm_tc7_port:
-         return scm_port_class[(SCM_WRTNG & SCM_CELL_WORD_0 (x)
-                                ? (SCM_RDNG & SCM_CELL_WORD_0 (x)
-                                   ? SCM_INOUT_PCLASS_INDEX | SCM_PTOBNUM (x)
-                                   : SCM_OUT_PCLASS_INDEX | SCM_PTOBNUM (x))
-                                : SCM_IN_PCLASS_INDEX | SCM_PTOBNUM (x))];
-       case scm_tcs_cons_gloc:
-         /* must be a struct */
-         if (SCM_OBJ_CLASS_FLAGS (x) & SCM_CLASSF_GOOPS_VALID)
-           return SCM_CLASS_OF (x);
-         else if (SCM_OBJ_CLASS_FLAGS (x) & SCM_CLASSF_GOOPS)
-           {
-             /* Goops object */
-             if (! SCM_FALSEP (SCM_OBJ_CLASS_REDEF (x)))
-               scm_change_object_class (x,
-                                        SCM_CLASS_OF (x),         /* old */
-                                        SCM_OBJ_CLASS_REDEF (x)); /* new */
-             return SCM_CLASS_OF (x);
-           }
-         else
-           {
-             /* ordinary struct */
-             SCM handle = scm_struct_create_handle (SCM_STRUCT_VTABLE (x));
-             if (SCM_NFALSEP (SCM_STRUCT_TABLE_CLASS (SCM_CDR (handle))))
-               return SCM_STRUCT_TABLE_CLASS (SCM_CDR (handle));
-             else
-               {
-                 SCM name = SCM_STRUCT_TABLE_NAME (SCM_CDR (handle));
-                 SCM class = scm_make_extended_class (SCM_NFALSEP (name)
-                                                      ? SCM_ROCHARS (name)
-                                                      : 0);
-                 SCM_SET_STRUCT_TABLE_CLASS (SCM_CDR (handle), class);
-                 return class;
-               }
-           }
-       default:
-         if (SCM_CONSP (x))
-           return scm_class_pair;
-         else
-           return scm_class_unknown;
-       }
-
-    case scm_tc3_cons_gloc:
-    case scm_tc3_tc7_1:
-    case scm_tc3_tc7_2:
-    case scm_tc3_closure:
-      /* Never reached */
-      break;
-    }
-  return scm_class_unknown;
-}
-
-/* (SCM_IM_DISPATCH ARGS N-SPECIALIZED
+/* The cache argument for scm_mcache_lookup_cmethod has one of two possible
+ * formats:
+ *
+ * Format #1:
+ * (SCM_IM_DISPATCH ARGS N-SPECIALIZED
  *   #((TYPE1 ... ENV FORMALS FORM ...) ...)
  *   GF)
  *
+ * Format #2:
  * (SCM_IM_HASH_DISPATCH ARGS N-SPECIALIZED HASHSET MASK
  *   #((TYPE1 ... ENV FORMALS FORM ...) ...)
  *   GF)
@@ -252,35 +91,36 @@ scm_class_of (SCM x)
 SCM
 scm_mcache_lookup_cmethod (SCM cache, SCM args)
 {
-  int i, n, end, mask;
+  unsigned long i, mask, n, end;
   SCM ls, methods, z = SCM_CDDR (cache);
-  n = SCM_INUM (SCM_CAR (z)); /* maximum number of specializers */
+  n = scm_to_ulong (SCM_CAR (z)); /* maximum number of specializers */
   methods = SCM_CADR (z);
 
-  if (SCM_NIMP (methods))
+  if (scm_is_simple_vector (methods))
     {
-      /* Prepare for linear search */
+      /* cache format #1: prepare for linear search */
       mask = -1;
       i = 0;
-      end = SCM_LENGTH (methods);
+      end = SCM_SIMPLE_VECTOR_LENGTH (methods);
     }
   else
     {
-      /* Compute a hash value */
-      int hashset = SCM_INUM (methods);
-      int j = n;
-      mask = SCM_INUM (SCM_CAR (z = SCM_CDDR (z)));
+      /* cache format #2: compute a hash value */
+      unsigned long hashset = scm_to_ulong (methods);
+      long j = n;
+      z = SCM_CDDR (z);
+      mask = scm_to_ulong (SCM_CAR (z));
       methods = SCM_CADR (z);
       i = 0;
       ls = args;
-      if (SCM_NIMP (ls))
+      if (!scm_is_null (ls))
        do
          {
            i += SCM_STRUCT_DATA (scm_class_of (SCM_CAR (ls)))
                 [scm_si_hashsets + hashset];
            ls = SCM_CDR (ls);
          }
-       while (--j && SCM_NIMP (ls));
+       while (j-- && !scm_is_null (ls));
       i &= mask;
       end = i;
     }
@@ -288,23 +128,23 @@ scm_mcache_lookup_cmethod (SCM cache, SCM args)
   /* Search for match  */
   do
     {
-      int j = n;
-      z = SCM_VELTS (methods)[i];
+      long j = n;
+      z = SCM_SIMPLE_VECTOR_REF (methods, i);
       ls = args; /* list of arguments */
-      if (SCM_NIMP (ls))
+      if (!scm_is_null (ls))
        do
          {
            /* More arguments than specifiers => CLASS != ENV */
-           if (! SCM_EQ_P (scm_class_of (SCM_CAR (ls)), SCM_CAR (z)))
+           if (! scm_is_eq (scm_class_of (SCM_CAR (ls)), SCM_CAR (z)))
              goto next_method;
            ls = SCM_CDR (ls);
            z = SCM_CDR (z);
          }
-       while (--j && SCM_NIMP (ls));
-      /* Fewer arguments than specifiers => CAR != ENV */
-      if (!(SCM_IMP (SCM_CAR (z)) || SCM_CONSP (SCM_CAR (z))))
-       goto next_method;
-      return z;
+       while (j-- && !scm_is_null (ls));
+      /* Fewer arguments than specifiers => CAR != CLASS or `no-method' */
+      if (!scm_is_pair (z)
+          || (!SCM_CLASSP (SCM_CAR (z)) && !scm_is_symbol (SCM_CAR (z))))
+       return z;
     next_method:
       i = (i + 1) & mask;
     } while (i != end);
@@ -315,7 +155,7 @@ SCM
 scm_mcache_compute_cmethod (SCM cache, SCM args)
 {
   SCM cmethod = scm_mcache_lookup_cmethod (cache, args);
-  if (SCM_IMP (cmethod))
+  if (scm_is_false (cmethod))
     /* No match - memoize */
     return scm_memoize_method (cache, args);
   return cmethod;
@@ -325,10 +165,15 @@ SCM
 scm_apply_generic (SCM gf, SCM args)
 {
   SCM cmethod = scm_mcache_compute_cmethod (SCM_ENTITY_PROCEDURE (gf), args);
-  return scm_eval_body (SCM_CDR (SCM_CMETHOD_CODE (cmethod)),
-                       SCM_EXTEND_ENV (SCM_CAR (SCM_CMETHOD_CODE (cmethod)),
-                                       args,
-                                       SCM_CMETHOD_ENV (cmethod)));
+  if (SCM_PROGRAM_P (cmethod))
+    return scm_vm_apply (scm_the_vm (), cmethod, args);
+  else if (scm_is_pair (cmethod))
+    return scm_eval_body (SCM_CDR (SCM_CMETHOD_CODE (cmethod)),
+                          SCM_EXTEND_ENV (SCM_CAR (SCM_CMETHOD_CODE (cmethod)),
+                                          args,
+                                          SCM_CMETHOD_ENV (cmethod)));
+  else
+    return scm_apply (cmethod, args, SCM_EOL);
 }
 
 SCM
@@ -340,44 +185,71 @@ scm_call_generic_0 (SCM gf)
 SCM
 scm_call_generic_1 (SCM gf, SCM a1)
 {
-  return scm_apply_generic (gf, SCM_LIST1 (a1));
+  return scm_apply_generic (gf, scm_list_1 (a1));
 }
 
 SCM
 scm_call_generic_2 (SCM gf, SCM a1, SCM a2)
 {
-  return scm_apply_generic (gf, SCM_LIST2 (a1, a2));
+  return scm_apply_generic (gf, scm_list_2 (a1, a2));
 }
 
 SCM
 scm_call_generic_3 (SCM gf, SCM a1, SCM a2, SCM a3)
 {
-  return scm_apply_generic (gf, SCM_LIST3 (a1, a2, a3));
+  return scm_apply_generic (gf, scm_list_3 (a1, a2, a3));
 }
 
 SCM_DEFINE (scm_entity_p, "entity?", 1, 0, 0, 
             (SCM obj),
-"")
+           "Return @code{#t} if @var{obj} is an entity.")
 #define FUNC_NAME s_scm_entity_p
 {
-  return SCM_BOOL(SCM_STRUCTP (obj) && SCM_I_ENTITYP (obj));
+  return scm_from_bool(SCM_STRUCTP (obj) && SCM_I_ENTITYP (obj));
 }
 #undef FUNC_NAME
 
 SCM_DEFINE (scm_operator_p, "operator?", 1, 0, 0, 
             (SCM obj),
-"")
+           "Return @code{#t} if @var{obj} is an operator.")
 #define FUNC_NAME s_scm_operator_p
 {
-  return SCM_BOOL(SCM_STRUCTP (obj)
+  return scm_from_bool(SCM_STRUCTP (obj)
                   && SCM_I_OPERATORP (obj)
                   && !SCM_I_ENTITYP (obj));
 }
 #undef FUNC_NAME
 
+/* XXX - What code requires the object procedure to be only of certain
+         types? */
+
+SCM_DEFINE (scm_valid_object_procedure_p, "valid-object-procedure?", 1, 0, 0,
+           (SCM proc),
+           "Return @code{#t} iff @var{proc} is a procedure that can be used "
+           "with @code{set-object-procedure}.  It is always valid to use "
+            "a closure constructed by @code{lambda}.")
+#define FUNC_NAME s_scm_valid_object_procedure_p
+{
+  if (SCM_IMP (proc))
+    return SCM_BOOL_F;
+  switch (SCM_TYP7 (proc))
+    {
+    default:
+      return SCM_BOOL_F;
+    case scm_tcs_closures:
+    case scm_tc7_subr_1:
+    case scm_tc7_subr_2:
+    case scm_tc7_subr_3:
+    case scm_tc7_lsubr_2:
+      return SCM_BOOL_T;
+    }
+}
+#undef FUNC_NAME
+
 SCM_DEFINE (scm_set_object_procedure_x, "set-object-procedure!", 2, 0, 0, 
             (SCM obj, SCM proc),
-"")
+           "Set the object procedure of @var{obj} to @var{proc}.\n"
+           "@var{obj} must be either an entity or an operator.")
 #define FUNC_NAME s_scm_set_object_procedure_x
 {
   SCM_ASSERT (SCM_STRUCTP (obj)
@@ -388,7 +260,7 @@ SCM_DEFINE (scm_set_object_procedure_x, "set-object-procedure!", 2, 0, 0,
              obj,
              SCM_ARG1,
               FUNC_NAME);
-  SCM_VALIDATE_PROC (2,proc);
+  SCM_ASSERT (scm_valid_object_procedure_p (proc), proc, SCM_ARG2, FUNC_NAME);
   if (SCM_I_ENTITYP (obj))
     SCM_SET_ENTITY_PROCEDURE (obj, proc);
   else
@@ -400,7 +272,8 @@ SCM_DEFINE (scm_set_object_procedure_x, "set-object-procedure!", 2, 0, 0,
 #ifdef GUILE_DEBUG
 SCM_DEFINE (scm_object_procedure, "object-procedure", 1, 0, 0, 
             (SCM obj),
-"")
+           "Return the object procedure of @var{obj}. @var{obj} must be\n"
+           "an entity or an operator.")
 #define FUNC_NAME s_scm_object_procedure
 {
   SCM_ASSERT (SCM_STRUCTP (obj)
@@ -428,20 +301,21 @@ scm_i_make_class_object (SCM meta,
   SCM layout = scm_make_struct_layout (layout_string);
   c = scm_make_struct (meta,
                       SCM_INUM0,
-                      SCM_LIST4 (layout, SCM_BOOL_F, SCM_EOL, SCM_EOL));
+                      scm_list_4 (layout, SCM_BOOL_F, SCM_EOL, SCM_EOL));
   SCM_SET_CLASS_FLAGS (c, flags);
   return c;
 }
 
 SCM_DEFINE (scm_make_class_object, "make-class-object", 2, 0, 0, 
             (SCM metaclass, SCM layout),
-"")
+           "Create a new class object of class @var{metaclass}, with the\n"
+           "slot layout specified by @var{layout}.")
 #define FUNC_NAME s_scm_make_class_object
 {
   unsigned long flags = 0;
-  SCM_VALIDATE_STRUCT (1,metaclass);
-  SCM_VALIDATE_STRING (2,layout);
-  if (SCM_EQ_P (metaclass, scm_metaclass_operator))
+  SCM_VALIDATE_STRUCT (1, metaclass);
+  SCM_VALIDATE_STRING (2, layout);
+  if (scm_is_eq (metaclass, scm_metaclass_operator))
     flags = SCM_CLASSF_OPERATOR;
   return scm_i_make_class_object (metaclass, layout, flags);
 }
@@ -449,17 +323,17 @@ SCM_DEFINE (scm_make_class_object, "make-class-object", 2, 0, 0,
 
 SCM_DEFINE (scm_make_subclass_object, "make-subclass-object", 2, 0, 0, 
             (SCM class, SCM layout),
-"")
+           "Create a subclass object of @var{class}, with the slot layout\n"
+           "specified by @var{layout}.")
 #define FUNC_NAME s_scm_make_subclass_object
 {
   SCM pl;
-  SCM_VALIDATE_STRUCT (1,class);
-  SCM_VALIDATE_STRING (2,layout);
+  SCM_VALIDATE_STRUCT (1, class);
+  SCM_VALIDATE_STRING (2, layout);
   pl = SCM_PACK (SCM_STRUCT_DATA (class) [scm_vtable_index_layout]);
-  /* Convert symbol->string */
-  pl = scm_makfromstr (SCM_CHARS (pl), (scm_sizet) SCM_LENGTH (pl), 0);
+  pl = scm_symbol_to_string (pl);
   return scm_i_make_class_object (SCM_STRUCT_VTABLE (class),
-                                 scm_string_append (SCM_LIST2 (pl, layout)),
+                                 scm_string_append (scm_list_2 (pl, layout)),
                                  SCM_CLASS_FLAGS (class));
 }
 #undef FUNC_NAME
@@ -467,28 +341,25 @@ SCM_DEFINE (scm_make_subclass_object, "make-subclass-object", 2, 0, 0,
 void
 scm_init_objects ()
 {
-  SCM ms = scm_makfrom0str (SCM_METACLASS_STANDARD_LAYOUT);
-  SCM ml = scm_make_struct_layout (ms);
-  SCM mt = scm_make_vtable_vtable (ml, SCM_INUM0,
-                                  SCM_LIST3 (SCM_BOOL_F, SCM_EOL, SCM_EOL));
+  SCM ms = scm_from_locale_string (SCM_METACLASS_STANDARD_LAYOUT);
+  SCM mt = scm_make_vtable_vtable (ms, SCM_INUM0,
+                                  scm_list_3 (SCM_BOOL_F, SCM_EOL, SCM_EOL));
   
-  SCM os = scm_makfrom0str (SCM_METACLASS_OPERATOR_LAYOUT);
-  SCM ol = scm_make_struct_layout (os);
-  SCM ot = scm_make_vtable_vtable (ol, SCM_INUM0,
-                                  SCM_LIST3 (SCM_BOOL_F, SCM_EOL, SCM_EOL));
+  SCM os = scm_from_locale_string (SCM_METACLASS_OPERATOR_LAYOUT);
+  SCM ot = scm_make_vtable_vtable (os, SCM_INUM0,
+                                  scm_list_3 (SCM_BOOL_F, SCM_EOL, SCM_EOL));
   
-  SCM es = scm_makfrom0str (SCM_ENTITY_LAYOUT);
+  SCM es = scm_from_locale_string (SCM_ENTITY_LAYOUT);
   SCM el = scm_make_struct_layout (es);
   SCM et = scm_make_struct (mt, SCM_INUM0,
-                           SCM_LIST4 (el, SCM_BOOL_F, SCM_EOL, SCM_EOL));
+                           scm_list_4 (el, SCM_BOOL_F, SCM_EOL, SCM_EOL));
 
-  scm_sysintern ("<class>", mt);
+  scm_c_define ("<class>", mt);
   scm_metaclass_standard = mt;
-  scm_sysintern ("<operator-class>", ot);
+  scm_c_define ("<operator-class>", ot);
   scm_metaclass_operator = ot;
   SCM_SET_CLASS_FLAGS (et, SCM_CLASSF_OPERATOR | SCM_CLASSF_ENTITY);
-  SCM_SET_CLASS_DESTRUCTOR (et, scm_struct_free_entity);
-  scm_sysintern ("<entity>", et);
+  scm_c_define ("<entity>", et);
 
 #include "libguile/objects.x"
 }