Changed license terms to the plain LGPL thru-out.
[bpt/guile.git] / libguile / smob.c
dissimilarity index 85%
index a498c48..6b3001e 100644 (file)
-/*     Copyright (C) 1995,1996 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 exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * 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.  */
-\f
-
-#include <stdio.h>
-#include "_scm.h"
-
-#include "smob.h"
-
-#ifdef HAVE_MALLOC_H
-#include <malloc.h>
-#endif
-
-\f
-
-/* scm_smobs scm_numsmob
- * implement a dynamicly resized array of smob records.
- * Indexes into this table are used when generating type
- * tags for smobjects (if you know a tag you can get an index and conversely).
- */
-scm_sizet scm_numsmob;
-scm_smobfuns *scm_smobs;
-
-
-long 
-scm_newsmob (smob)
-     scm_smobfuns *smob;
-{
-  char *tmp;
-  if (255 <= scm_numsmob)
-    goto smoberr;
-  SCM_DEFER_INTS;
-  SCM_SYSCALL (tmp = (char *) realloc ((char *) scm_smobs, (1 + scm_numsmob) * sizeof (scm_smobfuns)));
-  if (tmp)
-    {
-      scm_smobs = (scm_smobfuns *) tmp;
-      scm_smobs[scm_numsmob].mark = smob->mark;
-      scm_smobs[scm_numsmob].free = smob->free;
-      scm_smobs[scm_numsmob].print = smob->print;
-      scm_smobs[scm_numsmob].equalp = smob->equalp;
-      scm_numsmob++;
-    }
-  SCM_ALLOW_INTS;
-  if (!tmp)
-  smoberr:scm_wta (SCM_MAKINUM ((long) scm_numsmob), (char *) SCM_NALLOC, "newsmob");
-  return scm_tc7_smob + (scm_numsmob - 1) * 256;
-}
-
-/* {Initialization for i/o types, float, bignum, the type of free cells}
- */
-
-static scm_smobfuns freecell =
-{
-  0,
-  scm_free0,
-  0,
-  0
-};
-
-static scm_smobfuns flob =
-{
-  0,
-  /*flofree*/ 0,
-  scm_floprint,
-  scm_floequal
-};
-
-static scm_smobfuns bigob =
-{
-  0,
-  /*bigfree*/ 0,
-  scm_bigprint,
-  scm_bigequal
-};
-
-
-
-
-void
-scm_smob_prehistory ()
-{
-  scm_numsmob = 0;
-  scm_smobs = (scm_smobfuns *) malloc (7 * sizeof (scm_smobfuns));
-
-  /* WARNING: These scm_newsmob calls must be done in this order */
-  scm_newsmob (&freecell);
-  scm_newsmob (&flob);
-  scm_newsmob (&bigob);
-  scm_newsmob (&bigob);                /* n.b.: two smobs, one smobfuns */
-}
-
+/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2003 Free Software Foundation, Inc.
+ * 
+ * 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 2.1 of the License, or (at your option) any later version.
+ *
+ * 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.
+ *
+ * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+
+\f
+#if HAVE_CONFIG_H
+#  include <config.h>
+#endif
+
+#include <stdio.h>
+#include <errno.h>
+
+#include "libguile/_scm.h"
+
+#include "libguile/objects.h"
+#include "libguile/ports.h"
+
+#ifdef HAVE_MALLOC_H
+#include <malloc.h>
+#endif
+
+#include "libguile/smob.h"
+
+\f
+
+/* scm_smobs scm_numsmob
+ * implement a fixed sized array of smob records.
+ * Indexes into this table are used when generating type
+ * tags for smobjects (if you know a tag you can get an index and conversely).
+ */
+
+#define MAX_SMOB_COUNT 256
+long scm_numsmob;
+scm_smob_descriptor scm_smobs[MAX_SMOB_COUNT];
+
+/* {Mark}
+ */
+
+/* This function is vestigial.  It used to be the mark function's
+   responsibility to set the mark bit on the smob or port, but now the
+   generic marking routine in gc.c takes care of that, and a zero
+   pointer for a mark function means "don't bother".  So you never
+   need scm_mark0.
+
+   However, we leave it here because it's harmless to call it, and
+   people out there have smob code that uses it, and there's no reason
+   to make their links fail.  */
+
+SCM 
+scm_mark0 (SCM ptr SCM_UNUSED)
+{
+  return SCM_BOOL_F;
+}
+
+SCM 
+/* Dirk::FIXME: The name markcdr is misleading, since the term cdr should only
+   be used for real pairs. */
+scm_markcdr (SCM ptr)
+{
+  return SCM_CELL_OBJECT_1 (ptr);
+}
+
+/* {Free}
+ */
+
+size_t 
+scm_free0 (SCM ptr SCM_UNUSED)
+{
+  return 0;
+}
+
+size_t
+scm_smob_free (SCM obj)
+{
+  long n = SCM_SMOBNUM (obj);
+  if (scm_smobs[n].size > 0)
+    scm_gc_free ((void *) SCM_CELL_WORD_1 (obj), 
+                scm_smobs[n].size, SCM_SMOBNAME (n));
+  return 0;
+}
+
+/* {Print}
+ */
+
+int
+scm_smob_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
+{
+  long n = SCM_SMOBNUM (exp);
+  scm_puts ("#<", port);
+  scm_puts (SCM_SMOBNAME (n) ? SCM_SMOBNAME (n) : "smob", port);
+  scm_putc (' ', port);
+  if (scm_smobs[n].size)
+    scm_intprint (SCM_CELL_WORD_1 (exp), 16, port);
+  else
+    scm_intprint (SCM_UNPACK (exp), 16, port);
+  scm_putc ('>', port);
+  return 1;
+}
+
+/* {Apply}
+ */
+
+#define SCM_SMOB_APPLY0(SMOB) \
+  SCM_SMOB_DESCRIPTOR (SMOB).apply (SMOB)
+#define SCM_SMOB_APPLY1(SMOB, A1) \
+  SCM_SMOB_DESCRIPTOR (SMOB).apply (SMOB, A1)
+#define SCM_SMOB_APPLY2(SMOB, A1, A2) \
+  SCM_SMOB_DESCRIPTOR (SMOB).apply (SMOB, A1, A2)
+#define SCM_SMOB_APPLY3(SMOB, A1, A2, A3) \
+  SCM_SMOB_DESCRIPTOR (SMOB).apply (SMOB, A1, A2, A3)
+
+static SCM
+scm_smob_apply_0_010 (SCM smob)
+{
+  return SCM_SMOB_APPLY1 (smob, SCM_UNDEFINED);
+}
+
+static SCM
+scm_smob_apply_0_020 (SCM smob)
+{
+  return SCM_SMOB_APPLY2 (smob, SCM_UNDEFINED, SCM_UNDEFINED);
+}
+
+static SCM
+scm_smob_apply_0_030 (SCM smob)
+{
+  return SCM_SMOB_APPLY3 (smob, SCM_UNDEFINED, SCM_UNDEFINED, SCM_UNDEFINED);
+}
+
+static SCM
+scm_smob_apply_0_001 (SCM smob)
+{
+  return SCM_SMOB_APPLY1 (smob, SCM_EOL);
+}
+
+static SCM
+scm_smob_apply_0_011 (SCM smob)
+{
+  return SCM_SMOB_APPLY2 (smob, SCM_UNDEFINED, SCM_EOL);
+}
+
+static SCM
+scm_smob_apply_0_021 (SCM smob)
+{
+  return SCM_SMOB_APPLY3 (smob, SCM_UNDEFINED, SCM_UNDEFINED, SCM_EOL);
+}
+
+static SCM
+scm_smob_apply_0_error (SCM smob)
+{
+  scm_wrong_num_args (smob);
+}
+
+static SCM
+scm_smob_apply_1_020 (SCM smob, SCM a1)
+{
+  return SCM_SMOB_APPLY2 (smob, a1, SCM_UNDEFINED);
+}
+
+static SCM
+scm_smob_apply_1_030 (SCM smob, SCM a1)
+{
+  return SCM_SMOB_APPLY3 (smob, a1, SCM_UNDEFINED, SCM_UNDEFINED);
+}
+
+static SCM
+scm_smob_apply_1_001 (SCM smob, SCM a1)
+{
+  return SCM_SMOB_APPLY1 (smob, scm_list_1 (a1));
+}
+
+static SCM
+scm_smob_apply_1_011 (SCM smob, SCM a1)
+{
+  return SCM_SMOB_APPLY2 (smob, a1, SCM_EOL);
+}
+
+static SCM
+scm_smob_apply_1_021 (SCM smob, SCM a1)
+{
+  return SCM_SMOB_APPLY3 (smob, a1, SCM_UNDEFINED, SCM_EOL);
+}
+
+static SCM
+scm_smob_apply_1_error (SCM smob, SCM a1 SCM_UNUSED)
+{
+  scm_wrong_num_args (smob);
+}
+
+static SCM
+scm_smob_apply_2_030 (SCM smob, SCM a1, SCM a2)
+{
+  return SCM_SMOB_APPLY3 (smob, a1, a2, SCM_UNDEFINED);
+}
+
+static SCM
+scm_smob_apply_2_001 (SCM smob, SCM a1, SCM a2)
+{
+  return SCM_SMOB_APPLY1 (smob, scm_list_2 (a1, a2));
+}
+
+static SCM
+scm_smob_apply_2_011 (SCM smob, SCM a1, SCM a2)
+{
+  return SCM_SMOB_APPLY2 (smob, a1, scm_list_1 (a2));
+}
+
+static SCM
+scm_smob_apply_2_021 (SCM smob, SCM a1, SCM a2)
+{
+  return SCM_SMOB_APPLY3 (smob, a1, a2, SCM_EOL);
+}
+
+static SCM
+scm_smob_apply_2_error (SCM smob, SCM a1 SCM_UNUSED, SCM a2 SCM_UNUSED)
+{
+  scm_wrong_num_args (smob);
+}
+
+static SCM
+scm_smob_apply_3_030 (SCM smob, SCM a1, SCM a2, SCM rst)
+{
+  if (!SCM_NULLP (SCM_CDR (rst)))
+    scm_wrong_num_args (smob);
+  return SCM_SMOB_APPLY3 (smob, a1, a2, SCM_CAR (rst));
+}
+
+static SCM
+scm_smob_apply_3_001 (SCM smob, SCM a1, SCM a2, SCM rst)
+{
+  return SCM_SMOB_APPLY1 (smob, scm_cons2 (a1, a2, rst));
+}
+
+static SCM
+scm_smob_apply_3_011 (SCM smob, SCM a1, SCM a2, SCM rst)
+{
+  return SCM_SMOB_APPLY2 (smob, a1, scm_cons (a2, rst));
+}
+
+static SCM
+scm_smob_apply_3_021 (SCM smob, SCM a1, SCM a2, SCM rst)
+{
+  return SCM_SMOB_APPLY3 (smob, a1, a2, rst);
+}
+
+static SCM
+scm_smob_apply_3_error (SCM smob,
+                       SCM a1 SCM_UNUSED,
+                       SCM a2 SCM_UNUSED,
+                       SCM rst SCM_UNUSED)
+{
+  scm_wrong_num_args (smob);
+}
+
+\f
+
+scm_t_bits 
+scm_make_smob_type (char *name, size_t size)
+#define FUNC_NAME "scm_make_smob_type"
+{
+  long new_smob;
+
+  SCM_ENTER_A_SECTION;  /* scm_numsmob */
+  new_smob = scm_numsmob;
+  if (scm_numsmob != MAX_SMOB_COUNT)
+    ++scm_numsmob;
+  SCM_EXIT_A_SECTION;
+
+  if (new_smob == MAX_SMOB_COUNT)
+    scm_misc_error (FUNC_NAME, "maximum number of smobs exceeded", SCM_EOL);
+
+  scm_smobs[new_smob].name = name;
+  if (size != 0)
+    {
+      scm_smobs[new_smob].size = size;
+      scm_smobs[new_smob].free = scm_smob_free;
+    }
+
+  /* Make a class object if Goops is present. */
+  if (scm_smob_class)
+    scm_smob_class[new_smob] = scm_make_extended_class (name, 0);
+
+  return scm_tc7_smob + new_smob * 256;
+}
+#undef FUNC_NAME
+
+
+void
+scm_set_smob_mark (scm_t_bits tc, SCM (*mark) (SCM))
+{
+  scm_smobs[SCM_TC2SMOBNUM (tc)].mark = mark;
+}
+
+void
+scm_set_smob_free (scm_t_bits tc, size_t (*free) (SCM))
+{
+  scm_smobs[SCM_TC2SMOBNUM (tc)].free = free;
+}
+
+void
+scm_set_smob_print (scm_t_bits tc, int (*print) (SCM, SCM, scm_print_state*))
+{
+  scm_smobs[SCM_TC2SMOBNUM (tc)].print = print;
+}
+
+void
+scm_set_smob_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM))
+{
+  scm_smobs[SCM_TC2SMOBNUM (tc)].equalp = equalp;
+}
+
+void
+scm_set_smob_apply (scm_t_bits tc, SCM (*apply) (),
+                   unsigned int req, unsigned int opt, unsigned int rst)
+{
+  SCM (*apply_0) (SCM);
+  SCM (*apply_1) (SCM, SCM);
+  SCM (*apply_2) (SCM, SCM, SCM);
+  SCM (*apply_3) (SCM, SCM, SCM, SCM);
+  int type = SCM_GSUBR_MAKTYPE (req, opt, rst);
+
+  if (rst > 1 || req + opt + rst > 3)
+    {
+      puts ("Unsupported smob application type");
+      abort ();
+    }
+
+  switch (type)
+    {
+    case SCM_GSUBR_MAKTYPE (0, 0, 0):
+      apply_0 = apply; break;
+    case SCM_GSUBR_MAKTYPE (0, 1, 0):
+      apply_0 = scm_smob_apply_0_010; break;
+    case SCM_GSUBR_MAKTYPE (0, 2, 0):
+      apply_0 = scm_smob_apply_0_020; break;
+    case SCM_GSUBR_MAKTYPE (0, 3, 0):
+      apply_0 = scm_smob_apply_0_030; break;
+    case SCM_GSUBR_MAKTYPE (0, 0, 1):
+      apply_0 = scm_smob_apply_0_001; break;
+    case SCM_GSUBR_MAKTYPE (0, 1, 1):
+      apply_0 = scm_smob_apply_0_011; break;
+    case SCM_GSUBR_MAKTYPE (0, 2, 1):
+      apply_0 = scm_smob_apply_0_021; break;
+    default:
+      apply_0 = scm_smob_apply_0_error; break;
+    }
+
+  switch (type)
+    {
+    case SCM_GSUBR_MAKTYPE (1, 0, 0):
+    case SCM_GSUBR_MAKTYPE (0, 1, 0):
+      apply_1 = apply; break;
+    case SCM_GSUBR_MAKTYPE (1, 1, 0):
+    case SCM_GSUBR_MAKTYPE (0, 2, 0):
+      apply_1 = scm_smob_apply_1_020; break;
+    case SCM_GSUBR_MAKTYPE (1, 2, 0):
+    case SCM_GSUBR_MAKTYPE (0, 3, 0):
+      apply_1 = scm_smob_apply_1_030; break;
+    case SCM_GSUBR_MAKTYPE (0, 0, 1):
+      apply_1 = scm_smob_apply_1_001; break;
+    case SCM_GSUBR_MAKTYPE (1, 0, 1):
+    case SCM_GSUBR_MAKTYPE (0, 1, 1):
+      apply_1 = scm_smob_apply_1_011; break;
+    case SCM_GSUBR_MAKTYPE (1, 1, 1):
+    case SCM_GSUBR_MAKTYPE (0, 2, 1):
+      apply_1 = scm_smob_apply_1_021; break;
+    default:
+      apply_1 = scm_smob_apply_1_error; break;
+    }
+
+  switch (type)
+    {
+    case SCM_GSUBR_MAKTYPE (2, 0, 0):
+    case SCM_GSUBR_MAKTYPE (1, 1, 0):
+    case SCM_GSUBR_MAKTYPE (0, 2, 0):
+      apply_2 = apply; break;
+    case SCM_GSUBR_MAKTYPE (2, 1, 0):
+    case SCM_GSUBR_MAKTYPE (1, 2, 0):
+    case SCM_GSUBR_MAKTYPE (0, 3, 0):
+      apply_2 = scm_smob_apply_2_030; break;
+    case SCM_GSUBR_MAKTYPE (0, 0, 1):
+      apply_2 = scm_smob_apply_2_001; break;
+    case SCM_GSUBR_MAKTYPE (1, 0, 1):
+    case SCM_GSUBR_MAKTYPE (0, 1, 1):
+      apply_2 = scm_smob_apply_2_011; break;
+    case SCM_GSUBR_MAKTYPE (2, 0, 1):
+    case SCM_GSUBR_MAKTYPE (1, 1, 1):
+    case SCM_GSUBR_MAKTYPE (0, 2, 1):
+      apply_2 = scm_smob_apply_2_021; break;
+    default:
+      apply_2 = scm_smob_apply_2_error; break;
+    }
+
+  switch (type)
+    {
+    case SCM_GSUBR_MAKTYPE (3, 0, 0):
+    case SCM_GSUBR_MAKTYPE (2, 1, 0):
+    case SCM_GSUBR_MAKTYPE (1, 2, 0):
+    case SCM_GSUBR_MAKTYPE (0, 3, 0):
+      apply_3 = scm_smob_apply_3_030; break;
+    case SCM_GSUBR_MAKTYPE (0, 0, 1):
+      apply_3 = scm_smob_apply_3_001; break;
+    case SCM_GSUBR_MAKTYPE (1, 0, 1):
+    case SCM_GSUBR_MAKTYPE (0, 1, 1):
+      apply_3 = scm_smob_apply_3_011; break;
+    case SCM_GSUBR_MAKTYPE (2, 0, 1):
+    case SCM_GSUBR_MAKTYPE (1, 1, 1):
+    case SCM_GSUBR_MAKTYPE (0, 2, 1):
+      apply_3 = scm_smob_apply_3_021; break;
+    default:
+      apply_3 = scm_smob_apply_3_error; break;
+    }
+
+  scm_smobs[SCM_TC2SMOBNUM (tc)].apply   = apply;
+  scm_smobs[SCM_TC2SMOBNUM (tc)].apply_0 = apply_0;
+  scm_smobs[SCM_TC2SMOBNUM (tc)].apply_1 = apply_1;
+  scm_smobs[SCM_TC2SMOBNUM (tc)].apply_2 = apply_2;
+  scm_smobs[SCM_TC2SMOBNUM (tc)].apply_3 = apply_3;
+  scm_smobs[SCM_TC2SMOBNUM (tc)].gsubr_type = type;
+  
+  if (scm_smob_class)
+    scm_i_inherit_applicable (scm_smob_class[SCM_TC2SMOBNUM (tc)]);
+}
+
+SCM
+scm_make_smob (scm_t_bits tc)
+{
+  long n = SCM_TC2SMOBNUM (tc);
+  size_t size = scm_smobs[n].size;
+  scm_t_bits data = (size > 0
+                    ? (scm_t_bits) scm_gc_malloc (size, SCM_SMOBNAME (n))
+                    : 0);
+  return scm_cell (tc, data);
+}
+
+\f
+/* {Initialization for i/o types, float, bignum, the type of free cells}
+ */
+
+static int
+free_print (SCM exp, SCM port, scm_print_state *pstate SCM_UNUSED)
+{
+  char buf[100];
+  sprintf (buf, "#<freed cell %p; GC missed a reference>",
+          (void *) SCM_UNPACK (exp));
+  scm_puts (buf, port);
+  
+#if (SCM_DEBUG_CELL_ACCESSES == 1)
+  if (scm_debug_cell_accesses_p)
+    abort();
+#endif
+  
+
+  return 1;
+}
+
+void
+scm_smob_prehistory ()
+{
+  long i;
+  scm_t_bits tc;
+
+  scm_numsmob = 0;
+  for (i = 0; i < MAX_SMOB_COUNT; ++i)
+    {
+      scm_smobs[i].name       = 0;
+      scm_smobs[i].size       = 0;
+      scm_smobs[i].mark       = 0;
+      scm_smobs[i].free       = 0;
+      scm_smobs[i].print      = scm_smob_print;
+      scm_smobs[i].equalp     = 0;
+      scm_smobs[i].apply      = 0;
+      scm_smobs[i].apply_0    = 0;
+      scm_smobs[i].apply_1    = 0;
+      scm_smobs[i].apply_2    = 0;
+      scm_smobs[i].apply_3    = 0;
+      scm_smobs[i].gsubr_type = 0;
+    }
+
+  /* WARNING: These scm_make_smob_type calls must be done in this order */
+  tc = scm_make_smob_type ("free", 0);
+  scm_set_smob_print (tc, free_print);
+
+  tc = scm_make_smob_type ("big", 0);  /* freed in gc */
+  scm_set_smob_print (tc, scm_bigprint);
+  scm_set_smob_equalp (tc, scm_bigequal);
+
+  tc = scm_make_smob_type ("real", 0); /* freed in gc */
+  scm_set_smob_print (tc, scm_print_real);
+  scm_set_smob_equalp (tc, scm_real_equalp);
+
+  tc = scm_make_smob_type ("complex", 0);  /* freed in gc */
+  scm_set_smob_print (tc, scm_print_complex);
+  scm_set_smob_equalp (tc, scm_complex_equalp);
+}
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/