(ice-9 optargs) based on the new lambda* work
[bpt/guile.git] / libguile / procprop.c
dissimilarity index 94%
index 8b9ef9b..c066eca 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, 675 Mass Ave, Cambridge, MA 02139, 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 "alist.h"
-#include "eval.h"
-
-#include "procprop.h"
-\f
-
-static SCM
-scm_stand_in_scm_proc(proc)
-     SCM proc;
-{
-  SCM answer;
-  answer = scm_assoc (proc, scm_stand_in_procs);
-  if (answer == SCM_BOOL_F)
-    {
-      answer = scm_closure (scm_listify (SCM_EOL, SCM_BOOL_F, SCM_UNDEFINED),
-                           SCM_EOL);
-      scm_stand_in_procs = scm_cons (scm_cons (proc, answer),
-                                    scm_stand_in_procs);
-    }
-  else
-    answer = SCM_CDR (answer);
-  return answer;
-}
-
-SCM_PROC(s_procedure_properties, "procedure-properties", 1, 0, 0, scm_procedure_properties);
-
-SCM
-scm_procedure_properties (proc)
-     SCM proc;
-{
-  SCM_ASSERT (scm_procedure_p (proc), proc, SCM_ARG1, s_procedure_properties);
-  if (!(SCM_NIMP (proc) && SCM_CLOSUREP (proc)))
-    proc = scm_stand_in_scm_proc(proc);
-  return SCM_PROCPROPS (proc);
-}
-
-SCM_PROC(s_set_procedure_properties_x, "set-procedure-properties!", 2, 0, 0, scm_set_procedure_properties_x);
-
-SCM
-scm_set_procedure_properties_x (proc, new_val)
-     SCM proc;
-     SCM new_val;
-{
-  if (!(SCM_NIMP (proc) && SCM_CLOSUREP (proc)))
-    proc = scm_stand_in_scm_proc(proc);
-  SCM_ASSERT (SCM_NIMP (proc) && SCM_CLOSUREP (proc), proc, SCM_ARG1, s_set_procedure_properties_x);
-  SCM_PROCPROPS (proc) = new_val;
-  return SCM_UNSPECIFIED;
-}
-
-SCM_PROC(s_procedure_property, "procedure-property", 2, 0, 0, scm_procedure_property);
-
-SCM
-scm_procedure_property (p, k)
-     SCM p;
-     SCM k;
-{
-  SCM assoc;
-  if (!(SCM_NIMP (p) && SCM_CLOSUREP (p)))
-    p = scm_stand_in_scm_proc(p);
-  SCM_ASSERT (scm_procedure_p (p), p, SCM_ARG1, s_procedure_property);
-  assoc = scm_sloppy_assq (k, SCM_PROCPROPS (p));
-  return (SCM_NIMP (assoc) ? SCM_CDR (assoc) : SCM_BOOL_F);
-}
-
-SCM_PROC(s_set_procedure_property_x, "set-procedure-property!", 3, 0, 0, scm_set_procedure_property_x);
-
-SCM
-scm_set_procedure_property_x (p, k, v)
-     SCM p;
-     SCM k;
-     SCM v;
-{
-  SCM assoc;
-  if (!(SCM_NIMP (p) && SCM_CLOSUREP (p)))
-    p = scm_stand_in_scm_proc(p);
-  SCM_ASSERT (SCM_NIMP (p) && SCM_CLOSUREP (p), p, SCM_ARG1, s_set_procedure_property_x);
-  assoc = scm_sloppy_assq (k, SCM_PROCPROPS (p));
-  if (SCM_NIMP (assoc))
-    SCM_SETCDR (assoc, v);
-  else
-    SCM_PROCPROPS (p) = scm_acons (k, v, SCM_PROCPROPS (p));
-  return SCM_UNSPECIFIED;
-}
-
-\f
-
-
-void
-scm_init_procprop ()
-{
-#include "procprop.x"
-}
-
+/* Copyright (C) 1995,1996,1998,2000,2001,2003,2004, 2006, 2008, 2009 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 3 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
+
+
+\f
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
+#include "libguile/_scm.h"
+
+#include "libguile/alist.h"
+#include "libguile/eval.h"
+#include "libguile/procs.h"
+#include "libguile/gsubr.h"
+#include "libguile/objects.h"
+#include "libguile/smob.h"
+#include "libguile/root.h"
+#include "libguile/vectors.h"
+#include "libguile/hashtab.h"
+#include "libguile/programs.h"
+
+#include "libguile/validate.h"
+#include "libguile/procprop.h"
+\f
+
+SCM_GLOBAL_SYMBOL (scm_sym_system_procedure, "system-procedure");
+SCM_GLOBAL_SYMBOL (scm_sym_arity, "arity");
+
+static SCM non_closure_props;
+static scm_i_pthread_mutex_t non_closure_props_lock = SCM_I_PTHREAD_MUTEX_INITIALIZER;
+
+SCM
+scm_i_procedure_arity (SCM proc)
+{
+  int a = 0, o = 0, r = 0;
+  if (SCM_IMP (proc))
+    return SCM_BOOL_F;
+ loop:
+  switch (SCM_TYP7 (proc))
+    {
+    case scm_tc7_subr_1o:
+      o = 1;
+    case scm_tc7_subr_0:
+      break;
+    case scm_tc7_subr_2o:
+      o = 1;
+    case scm_tc7_subr_1:
+    case scm_tc7_dsubr:
+    case scm_tc7_cxr:
+      a += 1;
+      break;
+    case scm_tc7_subr_2:
+      a += 2;
+      break;
+    case scm_tc7_subr_3:
+      a += 3;
+      break;
+    case scm_tc7_asubr:
+    case scm_tc7_rpsubr:
+    case scm_tc7_lsubr:
+      r = 1;
+      break;
+    case scm_tc7_program:
+      if (scm_i_program_arity (proc, &a, &o, &r))
+        break;
+      else
+        return SCM_BOOL_F;
+    case scm_tc7_lsubr_2:
+      a += 2;
+      r = 1;
+      break;
+    case scm_tc7_smob:
+      if (SCM_SMOB_APPLICABLE_P (proc))
+       {
+         int type = SCM_SMOB_DESCRIPTOR (proc).gsubr_type;
+         a += SCM_GSUBR_REQ (type);
+         o = SCM_GSUBR_OPT (type);
+         r = SCM_GSUBR_REST (type);
+         break;
+       }
+      else
+       {
+         return SCM_BOOL_F;
+       }
+    case scm_tc7_gsubr:
+      {
+       unsigned int type = SCM_GSUBR_TYPE (proc);
+       a = SCM_GSUBR_REQ (type);
+       o = SCM_GSUBR_OPT (type);
+       r = SCM_GSUBR_REST (type);
+       break;
+      }
+    case scm_tc7_pws:
+      proc = SCM_PROCEDURE (proc);
+      goto loop;
+    case scm_tcs_closures:
+      proc = SCM_CLOSURE_FORMALS (proc);
+      if (scm_is_null (proc))
+       break;
+      while (scm_is_pair (proc))
+       {
+         ++a;
+         proc = SCM_CDR (proc);
+       }
+      if (!scm_is_null (proc))
+       r = 1;
+      break;
+    case scm_tcs_struct:
+      if (SCM_OBJ_CLASS_FLAGS (proc) & SCM_CLASSF_PURE_GENERIC)
+       {
+         r = 1;
+         break;
+       }
+      else if (!SCM_I_OPERATORP (proc))
+       return SCM_BOOL_F;
+      proc = (SCM_I_ENTITYP (proc)
+             ? SCM_ENTITY_PROCEDURE (proc)
+             : SCM_OPERATOR_PROCEDURE (proc));
+      a -= 1;
+      goto loop;
+    default:
+      return SCM_BOOL_F;
+    }
+  return scm_list_3 (scm_from_int (a), scm_from_int (o), scm_from_bool(r));
+}
+
+/* FIXME: instead of the weak hash, perhaps for some kinds of procedures, use
+   other means; for example subrs have their own property slot, which is unused
+   at present. */
+
+SCM_DEFINE (scm_procedure_properties, "procedure-properties", 1, 0, 0, 
+           (SCM proc),
+           "Return @var{obj}'s property list.")
+#define FUNC_NAME s_scm_procedure_properties
+{
+  SCM props;
+  
+  SCM_VALIDATE_PROC (1, proc);
+  if (SCM_CLOSUREP (proc))
+    props = SCM_PROCPROPS (proc);
+  else
+    {
+      scm_i_pthread_mutex_lock (&non_closure_props_lock);
+      props = scm_hashq_ref (non_closure_props, proc, SCM_EOL);
+      scm_i_pthread_mutex_unlock (&non_closure_props_lock);
+    }
+  return scm_acons (scm_sym_arity, scm_i_procedure_arity (proc), props);
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_set_procedure_properties_x, "set-procedure-properties!", 2, 0, 0,
+           (SCM proc, SCM alist),
+           "Set @var{proc}'s property list to @var{alist}.")
+#define FUNC_NAME s_scm_set_procedure_properties_x
+{
+  SCM_VALIDATE_PROC (1, proc);
+
+  if (SCM_CLOSUREP (proc))
+    SCM_SETPROCPROPS (proc, alist);
+  else
+    {
+      scm_i_pthread_mutex_lock (&non_closure_props_lock);
+      scm_hashq_set_x (non_closure_props, proc, alist);
+      scm_i_pthread_mutex_unlock (&non_closure_props_lock);
+    }
+  return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_procedure_property, "procedure-property", 2, 0, 0,
+           (SCM proc, SCM key),
+           "Return the property of @var{proc} with name @var{key}.")
+#define FUNC_NAME s_scm_procedure_property
+{
+  SCM_VALIDATE_PROC (1, proc);
+
+  if (scm_is_eq (key, scm_sym_arity))
+    /* avoid a cons in this case */
+    return scm_i_procedure_arity (proc);
+  else
+    {
+      SCM props;
+      if (SCM_CLOSUREP (proc))
+        props = SCM_PROCPROPS (proc);
+      else
+        {
+          scm_i_pthread_mutex_lock (&non_closure_props_lock);
+          props = scm_hashq_ref (non_closure_props, proc, SCM_EOL);
+          scm_i_pthread_mutex_unlock (&non_closure_props_lock);
+        }
+      return scm_assq_ref (props, key);
+    }
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_set_procedure_property_x, "set-procedure-property!", 3, 0, 0,
+           (SCM proc, SCM key, SCM val),
+           "In @var{proc}'s property list, set the property named @var{key} to\n"
+           "@var{val}.")
+#define FUNC_NAME s_scm_set_procedure_property_x
+{
+  SCM_VALIDATE_PROC (1, proc);
+
+  if (scm_is_eq (key, scm_sym_arity))
+    SCM_MISC_ERROR ("arity is a read-only property", SCM_EOL);
+
+  if (SCM_CLOSUREP (proc))
+    SCM_SETPROCPROPS (proc,
+                      scm_assq_set_x (SCM_PROCPROPS (proc), key, val));
+  else
+    {
+      scm_i_pthread_mutex_lock (&non_closure_props_lock);
+      scm_hashq_set_x (non_closure_props, proc,
+                       scm_assq_set_x (scm_hashq_ref (non_closure_props, proc,
+                                                      SCM_EOL),
+                                       key, val));
+      scm_i_pthread_mutex_unlock (&non_closure_props_lock);
+    }
+
+  return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+
+\f
+
+
+void
+scm_init_procprop ()
+{
+  non_closure_props = scm_make_doubly_weak_hash_table (SCM_UNDEFINED);
+#include "libguile/procprop.x"
+}
+
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/