]> git.donarmstrong.com Git - lilypond.git/blobdiff - guile18/libguile/srcprop.c
Import guile-1.8 as multiple upstream tarball component
[lilypond.git] / guile18 / libguile / srcprop.c
diff --git a/guile18/libguile/srcprop.c b/guile18/libguile/srcprop.c
new file mode 100644 (file)
index 0000000..d72ae84
--- /dev/null
@@ -0,0 +1,346 @@
+/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002, 2006, 2008 Free Software Foundation
+ * 
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+
+\f
+#ifdef HAVE_CONFIG_H
+# include <config.h>
+#endif
+
+#include <errno.h>
+
+#include "libguile/_scm.h"
+#include "libguile/async.h"
+#include "libguile/smob.h"
+#include "libguile/alist.h"
+#include "libguile/debug.h"
+#include "libguile/hashtab.h"
+#include "libguile/hash.h"
+#include "libguile/ports.h"
+#include "libguile/root.h"
+#include "libguile/weaks.h"
+
+#include "libguile/validate.h"
+#include "libguile/srcprop.h"
+\f
+/* {Source Properties}
+ *
+ * Properties of source list expressions.
+ * Five 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.
+ *
+ */
+
+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");
+
+
+
+/*
+ *  Source properties are stored as double cells with the
+ *  following layout:
+  
+ * car = tag
+ * cbr = pos
+ * ccr = copy
+ * cdr = plist 
+ */
+
+#define SRCPROPSP(p) (SCM_SMOB_PREDICATE (scm_tc16_srcprops, (p)))
+#define SRCPROPBRK(p) (SCM_SMOB_FLAGS (p) & SCM_SOURCE_PROPERTY_FLAG_BREAK)
+#define SRCPROPPOS(p) (SCM_CELL_WORD(p,1))
+#define SRCPROPLINE(p) (SRCPROPPOS(p) >> 12)
+#define SRCPROPCOL(p) (SRCPROPPOS(p) & 0x0fffL)
+#define SRCPROPCOPY(p) (SCM_CELL_OBJECT(p,2))
+#define SRCPROPPLIST(p) (SCM_CELL_OBJECT_3(p))
+#define SETSRCPROPBRK(p) \
+ (SCM_SET_SMOB_FLAGS ((p), \
+                      SCM_SMOB_FLAGS (p) | SCM_SOURCE_PROPERTY_FLAG_BREAK))
+#define CLEARSRCPROPBRK(p)  \
+ (SCM_SET_SMOB_FLAGS ((p), \
+                      SCM_SMOB_FLAGS (p) & ~SCM_SOURCE_PROPERTY_FLAG_BREAK))
+#define SRCPROPMAKPOS(l, c) (((l) << 12) + (c))
+#define SETSRCPROPPOS(p, l, c) (SCM_SET_CELL_WORD(p,1, SRCPROPMAKPOS (l, c)))
+#define SETSRCPROPLINE(p, l) SETSRCPROPPOS (p, l, SRCPROPCOL (p))
+#define SETSRCPROPCOL(p, c) SETSRCPROPPOS (p, SRCPROPLINE (p), c)
+
+
+
+scm_t_bits scm_tc16_srcprops;
+
+static SCM
+srcprops_mark (SCM obj)
+{
+  scm_gc_mark (SRCPROPCOPY (obj));
+  return SRCPROPPLIST (obj);
+}
+
+static int
+srcprops_print (SCM obj, SCM port, scm_print_state *pstate)
+{
+  int writingp = SCM_WRITINGP (pstate);
+  scm_puts ("#<srcprops ", port);
+  SCM_SET_WRITINGP (pstate, 1);
+  scm_iprin1 (scm_srcprops_to_plist (obj), port, pstate);
+  SCM_SET_WRITINGP (pstate, writingp);
+  scm_putc ('>', 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 plist
+ * entry.  This works because scm_set_source_property_x does not use
+ * assoc-set! for modifying the plist.
+ *
+ * This variable contains a protected cons, whose cdr is the cached
+ * plist
+ */
+static SCM scm_last_plist_filename;
+
+SCM
+scm_make_srcprops (long line, int col, SCM filename, SCM copy, SCM plist)
+{
+  if (!SCM_UNBNDP (filename))
+    {
+      SCM old_plist = plist;
+
+      /*
+       have to extract the acons, and operate on that, for
+       thread safety.
+       */
+      SCM last_acons = SCM_CDR (scm_last_plist_filename);
+      if (old_plist == SCM_EOL
+         && SCM_CDAR (last_acons) == filename)
+       {
+         plist = last_acons;
+       }
+      else
+       {
+         plist = scm_acons (scm_sym_filename, filename, plist);
+         if (old_plist == SCM_EOL)
+           SCM_SETCDR (scm_last_plist_filename, plist);
+       }
+    }
+  
+  SCM_RETURN_NEWSMOB3 (scm_tc16_srcprops,
+                      SRCPROPMAKPOS (line, col),
+                      copy,
+                      plist);
+}
+
+
+SCM
+scm_srcprops_to_plist (SCM obj)
+{
+  SCM plist = SRCPROPPLIST (obj);
+  if (!SCM_UNBNDP (SRCPROPCOPY (obj)))
+    plist = scm_acons (scm_sym_copy, SRCPROPCOPY (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;
+}
+
+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);
+  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"
+           "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);
+  SCM_SETCDR (handle, plist);
+  return plist;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_source_property, "source-property", 2, 0, 0,
+            (SCM obj, SCM key),
+           "Return the source property specified by @var{key} from\n"
+           "@var{obj}'s source property list.")
+#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 (!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_copy,       key)) p = SRCPROPCOPY (p);
+  else
+    {
+      p = SRCPROPPLIST (p);
+    plist:
+      p = scm_assoc (key, p);
+      return (SCM_NIMP (p) ? SCM_CDR (p) : SCM_BOOL_F);
+    }
+  return SCM_UNBNDP (p) ? SCM_BOOL_F : p;
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
+            (SCM obj, SCM key, SCM datum),
+           "Set the source property of object @var{obj}, which is specified by\n"
+           "@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))
+    {
+      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));
+    }
+  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_copy, key))
+    {
+      if (SRCPROPSP (p))
+       SRCPROPCOPY (p) = datum;
+      else
+       SCM_WHASHSET (scm_source_whash, h, scm_make_srcprops (0, 0, SCM_UNDEFINED, datum, p));
+    }
+  else
+    {
+      if (SRCPROPSP (p))
+       SRCPROPPLIST (p) = scm_acons (key, datum, SRCPROPPLIST (p));
+      else
+       SCM_WHASHSET (scm_source_whash, h, scm_acons (key, datum, p));
+    }
+  return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+
+
+void
+scm_init_srcprop ()
+{
+  scm_tc16_srcprops = scm_make_smob_type ("srcprops", 0);
+  scm_set_smob_mark (scm_tc16_srcprops, srcprops_mark);
+  scm_set_smob_print (scm_tc16_srcprops, srcprops_print);
+
+  scm_source_whash = scm_make_weak_key_hash_table (scm_from_int (2047));
+  scm_c_define ("source-whash", scm_source_whash);
+
+  scm_last_plist_filename
+    = scm_permanent_object (scm_cons (SCM_EOL,
+                                     scm_acons (SCM_EOL, SCM_EOL, SCM_EOL)));
+
+#include "libguile/srcprop.x"
+}
+
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/