Merge remote-tracking branch 'origin/stable-2.0'
[bpt/guile.git] / libguile / srcprop.c
index 8b9348e..dbebf77 100644 (file)
@@ -1,22 +1,27 @@
-/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002, 2006 Free Software Foundation
+/* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2006,
+ *   2008, 2009, 2010, 2011, 2012 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.
+ * 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
+ * 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
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
  */
 
 
 \f
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
 
 #include <errno.h>
 
 #include "libguile/hash.h"
 #include "libguile/ports.h"
 #include "libguile/root.h"
-#include "libguile/weaks.h"
 #include "libguile/gc.h"
 
 #include "libguile/validate.h"
 #include "libguile/srcprop.h"
+#include "libguile/private-options.h"
+
 \f
 /* {Source Properties}
  *
  * Properties of source list expressions.
- * Five of these have special meaning and optimized storage:
+ * Four of these have special meaning:
  *
  * filename    string   The name of the source file.
  * copy        list     A copy of the list expression.
  * line               integer  The source code line number.
  * column      integer The source code column number.
- * breakpoint  boolean Sets a breakpoint on this form.
  *
  * Most properties above can be set by the reader.
  *
@@ -54,99 +59,183 @@ SCM_GLOBAL_SYMBOL (scm_sym_filename, "filename");
 SCM_GLOBAL_SYMBOL (scm_sym_copy, "copy");
 SCM_GLOBAL_SYMBOL (scm_sym_line, "line");
 SCM_GLOBAL_SYMBOL (scm_sym_column, "column");
-SCM_GLOBAL_SYMBOL (scm_sym_breakpoint, "breakpoint");
+
+static SCM scm_source_whash;
+
+
+/*
+ *  Source properties are stored as double cells with the
+ *  following layout:
+  
+ * car = tag
+ * cbr = pos
+ * ccr = copy
+ * cdr = alist
+ */
+
+#define SRCPROPSP(p) (SCM_SMOB_PREDICATE (scm_tc16_srcprops, (p)))
+#define SRCPROPPOS(p) (SCM_SMOB_DATA(p))
+#define SRCPROPLINE(p) (SRCPROPPOS(p) >> 12)
+#define SRCPROPCOL(p) (SRCPROPPOS(p) & 0x0fffL)
+#define SRCPROPCOPY(p) (SCM_SMOB_OBJECT_2(p))
+#define SRCPROPALIST(p) (SCM_SMOB_OBJECT_3(p))
+#define SRCPROPMAKPOS(l, c) (((l) << 12) + (c))
+#define SETSRCPROPPOS(p, l, c) (SCM_SET_SMOB_DATA_1 (p, SRCPROPMAKPOS (l, c)))
+#define SETSRCPROPLINE(p, l) SETSRCPROPPOS (p, l, SRCPROPCOL (p))
+#define SETSRCPROPCOL(p, c) SETSRCPROPPOS (p, SRCPROPLINE (p), c)
+#define SETSRCPROPCOPY(p, c) (SCM_SET_SMOB_OBJECT_2 (p, c))
+#define SETSRCPROPALIST(p, l) (SCM_SET_SMOB_OBJECT_3 (p, l))
+
+
+static SCM scm_srcprops_to_alist (SCM obj);
+
 
 scm_t_bits scm_tc16_srcprops;
 
 
+static int
+supports_source_props (SCM obj)
+{
+  return SCM_NIMP (obj) && !scm_is_symbol (obj) && !scm_is_keyword (obj);
+}
+
+
 static int
 srcprops_print (SCM obj, SCM port, scm_print_state *pstate)
 {
   int writingp = SCM_WRITINGP (pstate);
-  scm_puts ("#<srcprops ", port);
+  scm_puts_unlocked ("#<srcprops ", port);
   SCM_SET_WRITINGP (pstate, 1);
-  scm_iprin1 (scm_srcprops_to_plist (obj), port, pstate);
+  scm_iprin1 (scm_srcprops_to_alist (obj), port, pstate);
   SCM_SET_WRITINGP (pstate, writingp);
-  scm_putc ('>', port);
+  scm_putc_unlocked ('>', port);
   return 1;
 }
 
 
-int
-scm_c_source_property_breakpoint_p (SCM form)
-{
-  SCM obj = scm_whash_lookup (scm_source_whash, form);
-  return SRCPROPSP (obj) && SRCPROPBRK (obj);
-}
-
+/*
+ * We remember the last file name settings, so we can share that alist
+ * entry.  This works because scm_set_source_property_x does not use
+ * assoc-set! for modifying the alist.
+ *
+ * This variable contains a protected cons, whose cdr is the cached
+ * alist
+ */
+static SCM scm_last_alist_filename;
 
 SCM
-scm_make_srcprops (long line, int col, SCM filename, SCM copy, SCM plist)
+scm_make_srcprops (long line, int col, SCM filename, SCM copy, SCM alist)
 {
-  register scm_t_srcprops *ptr;
-
-  ptr = scm_gc_malloc (sizeof (*ptr), "srcprop");
-
-  ptr->pos = SRCPROPMAKPOS (line, col);
-  ptr->fname = filename;
-  ptr->copy = copy;
-  ptr->plist = plist;
+  if (!SCM_UNBNDP (filename))
+    {
+      SCM old_alist = alist;
 
-  SCM_RETURN_NEWSMOB (scm_tc16_srcprops, ptr);
+      /*
+       have to extract the acons, and operate on that, for
+       thread safety.
+       */
+      SCM last_acons = SCM_CDR (scm_last_alist_filename);
+      if (scm_is_null (old_alist)
+         && scm_is_eq (SCM_CDAR (last_acons), filename))
+       {
+         alist = last_acons;
+       }
+      else
+       {
+         alist = scm_acons (scm_sym_filename, filename, alist);
+         if (scm_is_null (old_alist))
+           SCM_SETCDR (scm_last_alist_filename, alist);
+       }
+    }
+  
+  SCM_RETURN_NEWSMOB3 (scm_tc16_srcprops,
+                      SRCPROPMAKPOS (line, col),
+                      SCM_UNPACK (copy),
+                      SCM_UNPACK (alist));
 }
 
 
-SCM
-scm_srcprops_to_plist (SCM obj)
+static SCM
+scm_srcprops_to_alist (SCM obj)
 {
-  SCM plist = SRCPROPPLIST (obj);
+  SCM alist = SRCPROPALIST (obj);
   if (!SCM_UNBNDP (SRCPROPCOPY (obj)))
-    plist = scm_acons (scm_sym_copy, SRCPROPCOPY (obj), plist);
-  if (!SCM_UNBNDP (SRCPROPFNAME (obj)))
-    plist = scm_acons (scm_sym_filename, SRCPROPFNAME (obj), plist);
-  plist = scm_acons (scm_sym_column, scm_from_int (SRCPROPCOL (obj)), plist);
-  plist = scm_acons (scm_sym_line, scm_from_int (SRCPROPLINE (obj)), plist);
-  plist = scm_acons (scm_sym_breakpoint, scm_from_bool (SRCPROPBRK (obj)), plist);
-  return plist;
+    alist = scm_acons (scm_sym_copy, SRCPROPCOPY (obj), alist);
+  alist = scm_acons (scm_sym_column, scm_from_int (SRCPROPCOL (obj)), alist);
+  alist = scm_acons (scm_sym_line, scm_from_int (SRCPROPLINE (obj)), alist);
+  return alist;
 }
 
+SCM_DEFINE (scm_supports_source_properties_p, "supports-source-properties?", 1, 0, 0,
+            (SCM obj),
+            "Return #t if @var{obj} supports adding source properties,\n"
+            "otherwise return #f.")
+#define FUNC_NAME s_scm_supports_source_properties_p
+{
+  return scm_from_bool (supports_source_props (obj));
+}
+#undef FUNC_NAME
+
 SCM_DEFINE (scm_source_properties, "source-properties", 1, 0, 0, 
             (SCM obj),
            "Return the source property association list of @var{obj}.")
 #define FUNC_NAME s_scm_source_properties
 {
-  SCM p;
-  SCM_VALIDATE_NIM (1, obj);
-  if (SCM_MEMOIZEDP (obj))
-    obj = SCM_MEMOIZED_EXP (obj);
-  else if (!scm_is_pair (obj))
-    SCM_WRONG_TYPE_ARG (1, obj);
-  p = scm_hashq_ref (scm_source_whash, obj, SCM_EOL);
-  if (SRCPROPSP (p))
-    return scm_srcprops_to_plist (p);
+  if (SCM_IMP (obj))
+    return SCM_EOL;
   else
-    /* list from set-source-properties!, or SCM_EOL for not found */
-    return p;
+    {
+      SCM p = scm_weak_table_refq (scm_source_whash, obj, SCM_EOL); 
+
+      if (SRCPROPSP (p))
+        return scm_srcprops_to_alist (p);
+      else
+        /* list from set-source-properties!, or SCM_EOL for not found */
+        return p;
+    }
 }
 #undef FUNC_NAME
 
 /* Perhaps this procedure should look through an alist
    and try to make a srcprops-object...? */
 SCM_DEFINE (scm_set_source_properties_x, "set-source-properties!", 2, 0, 0,
-            (SCM obj, SCM plist),
-           "Install the association list @var{plist} as the source property\n"
+            (SCM obj, SCM alist),
+           "Install the association list @var{alist} as the source property\n"
            "list for @var{obj}.")
 #define FUNC_NAME s_scm_set_source_properties_x
 {
-  SCM handle;
   SCM_VALIDATE_NIM (1, obj);
-  if (SCM_MEMOIZEDP (obj))
-    obj = SCM_MEMOIZED_EXP (obj);
-  else if (!scm_is_pair (obj))
-    SCM_WRONG_TYPE_ARG(1, obj);
-  handle = scm_hashq_create_handle_x (scm_source_whash, obj, plist);
 
-  return plist;
+  scm_weak_table_putq_x (scm_source_whash, obj, alist);
+
+  return alist;
+}
+#undef FUNC_NAME
+
+int
+scm_i_has_source_properties (SCM obj)
+#define FUNC_NAME "%set-source-properties"
+{
+  if (SCM_IMP (obj))
+    return 0;
+  else
+    return scm_is_true (scm_weak_table_refq (scm_source_whash, obj, SCM_BOOL_F));
+}
+#undef FUNC_NAME
+  
+
+void
+scm_i_set_source_properties_x (SCM obj, long line, int col, SCM fname)
+#define FUNC_NAME "%set-source-properties"
+{
+  SCM_VALIDATE_NIM (1, obj);
+
+  scm_weak_table_putq_x (scm_source_whash, obj,
+                         scm_make_srcprops (line, col, fname,
+                                            SCM_COPY_SOURCE_P
+                                            ? scm_copy_tree (obj)
+                                            : SCM_UNDEFINED,
+                                            SCM_EOL));
 }
 #undef FUNC_NAME
 
@@ -157,27 +246,27 @@ SCM_DEFINE (scm_source_property, "source-property", 2, 0, 0,
 #define FUNC_NAME s_scm_source_property
 {
   SCM p;
-  SCM_VALIDATE_NIM (1, obj);
-  if (SCM_MEMOIZEDP (obj))
-    obj = SCM_MEMOIZED_EXP (obj);
-  else if (!scm_is_pair (obj))
-    SCM_WRONG_TYPE_ARG (1, obj);
-  p = scm_hashq_ref (scm_source_whash, obj, SCM_EOL);
+
+  if (SCM_IMP (obj))
+    return SCM_BOOL_F;
+
+  p = scm_weak_table_refq (scm_source_whash, obj, SCM_EOL);
+
   if (!SRCPROPSP (p))
-    goto plist;
-  if      (scm_is_eq (scm_sym_breakpoint, key)) p = scm_from_bool (SRCPROPBRK (p));
-  else if (scm_is_eq (scm_sym_line,       key)) p = scm_from_int (SRCPROPLINE (p));
-  else if (scm_is_eq (scm_sym_column,     key)) p = scm_from_int (SRCPROPCOL (p));
-  else if (scm_is_eq (scm_sym_filename,   key)) p = SRCPROPFNAME (p);
-  else if (scm_is_eq (scm_sym_copy,       key)) p = SRCPROPCOPY (p);
+    goto alist;
+  if (scm_is_eq (scm_sym_line, key))
+    return scm_from_int (SRCPROPLINE (p));
+  else if (scm_is_eq (scm_sym_column, key))
+    return scm_from_int (SRCPROPCOL (p));
+  else if (scm_is_eq (scm_sym_copy, key))
+    return SRCPROPCOPY (p);
   else
     {
-      p = SRCPROPPLIST (p);
-    plist:
+      p = SRCPROPALIST (p);
+    alist:
       p = scm_assoc (key, p);
-      return (SCM_NIMP (p) ? SCM_CDR (p) : SCM_BOOL_F);
+      return (scm_is_pair (p) ? SCM_CDR (p) : SCM_BOOL_F);
     }
-  return SCM_UNBNDP (p) ? SCM_BOOL_F : p;
 }
 #undef FUNC_NAME
 
@@ -187,101 +276,86 @@ SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
            "@var{key} to @var{datum}.  Normally, the key will be a symbol.")
 #define FUNC_NAME s_scm_set_source_property_x
 {
-  scm_whash_handle h;
   SCM p;
   SCM_VALIDATE_NIM (1, obj);
-  if (SCM_MEMOIZEDP (obj))
-    obj = SCM_MEMOIZED_EXP (obj);
-  else if (!scm_is_pair (obj))
-    SCM_WRONG_TYPE_ARG (1, obj);
-  h = scm_whash_get_handle (scm_source_whash, obj);
-  if (SCM_WHASHFOUNDP (h))
-    p = SCM_WHASHREF (scm_source_whash, h);
-  else
-    {
-      h = scm_whash_create_handle (scm_source_whash, obj);
-      p = SCM_EOL;
-    }
-  if (scm_is_eq (scm_sym_breakpoint, key))
-    {
-      if (SRCPROPSP (p))
-       {
-         if (scm_is_false (datum))
-           CLEARSRCPROPBRK (p);
-         else
-           SETSRCPROPBRK (p);
-       }
-      else
-       {
-         SCM sp = scm_make_srcprops (0, 0, SCM_UNDEFINED, SCM_UNDEFINED, p);
-         SCM_WHASHSET (scm_source_whash, h, sp);
-         if (scm_is_false (datum))
-           CLEARSRCPROPBRK (sp);
-         else
-           SETSRCPROPBRK (sp);
-       }
-    }
-  else if (scm_is_eq (scm_sym_line, key))
+
+  scm_i_pthread_mutex_lock (&scm_i_misc_mutex);
+  p = scm_weak_table_refq (scm_source_whash, obj, SCM_EOL);
+
+  if (scm_is_eq (scm_sym_line, key))
     {
       if (SRCPROPSP (p))
        SETSRCPROPLINE (p, scm_to_int (datum));
       else
-       SCM_WHASHSET (scm_source_whash, h,
-                     scm_make_srcprops (scm_to_int (datum), 0,
-                                        SCM_UNDEFINED, SCM_UNDEFINED, p));
+       scm_weak_table_putq_x (scm_source_whash, obj,
+                               scm_make_srcprops (scm_to_int (datum), 0,
+                                                  SCM_UNDEFINED, SCM_UNDEFINED, p));
     }
   else if (scm_is_eq (scm_sym_column, key))
     {
       if (SRCPROPSP (p))
        SETSRCPROPCOL (p, scm_to_int (datum));
       else
-       SCM_WHASHSET (scm_source_whash, h,
-                     scm_make_srcprops (0, scm_to_int (datum),
-                                        SCM_UNDEFINED, SCM_UNDEFINED, p));
-    }
-  else if (scm_is_eq (scm_sym_filename, key))
-    {
-      if (SRCPROPSP (p))
-       SRCPROPFNAME (p) = datum;
-      else
-       SCM_WHASHSET (scm_source_whash, h, scm_make_srcprops (0, 0, datum, SCM_UNDEFINED, p));
+       scm_weak_table_putq_x (scm_source_whash, obj,
+                               scm_make_srcprops (0, scm_to_int (datum),
+                                                  SCM_UNDEFINED, SCM_UNDEFINED, p));
     }
   else if (scm_is_eq (scm_sym_copy, key))
     {
       if (SRCPROPSP (p))
-       SRCPROPCOPY (p) = datum;
+       SETSRCPROPCOPY (p, datum);
       else
-       SCM_WHASHSET (scm_source_whash, h, scm_make_srcprops (0, 0, SCM_UNDEFINED, datum, p));
+       scm_weak_table_putq_x (scm_source_whash, obj,
+                               scm_make_srcprops (0, 0, SCM_UNDEFINED, datum, p));
     }
   else
     {
       if (SRCPROPSP (p))
-       SRCPROPPLIST (p) = scm_acons (key, datum, SRCPROPPLIST (p));
+       SETSRCPROPALIST (p, scm_acons (key, datum, SRCPROPALIST (p)));
       else
-       SCM_WHASHSET (scm_source_whash, h, scm_acons (key, datum, p));
+       scm_weak_table_putq_x (scm_source_whash, obj,
+                               scm_acons (key, datum, p));
     }
+  scm_i_pthread_mutex_unlock (&scm_i_misc_mutex);
+
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
 
 
+SCM_DEFINE (scm_cons_source, "cons-source", 3, 0, 0, 
+            (SCM xorig, SCM x, SCM y),
+           "Create and return a new pair whose car and cdr are @var{x} and @var{y}.\n"
+           "Any source properties associated with @var{xorig} are also associated\n"
+           "with the new pair.")
+#define FUNC_NAME s_scm_cons_source
+{
+  SCM p, z;
+  z = scm_cons (x, y);
+  /* Copy source properties possibly associated with xorig. */
+  p = scm_weak_table_refq (scm_source_whash, xorig, SCM_BOOL_F);
+  if (scm_is_true (p))
+    scm_weak_table_putq_x (scm_source_whash, z, p);
+  return z;
+}
+#undef FUNC_NAME
+
+
 void
 scm_init_srcprop ()
 {
   scm_tc16_srcprops = scm_make_smob_type ("srcprops", 0);
   scm_set_smob_print (scm_tc16_srcprops, srcprops_print);
 
-  scm_source_whash = scm_make_weak_key_hash_table (scm_from_int (2047));
+  scm_source_whash = scm_c_make_weak_table (0, SCM_WEAK_TABLE_KIND_KEY);
   scm_c_define ("source-whash", scm_source_whash);
 
+  scm_last_alist_filename = scm_cons (SCM_EOL,
+                                     scm_acons (SCM_EOL, SCM_EOL, SCM_EOL));
+
 #include "libguile/srcprop.x"
 }
 
-void
-scm_finish_srcprop ()
-{
-  /* Nothing to do.  */
-}
 
 /*
   Local Variables: