(SCM_GC8MARKP, SCM_SETGC8MARK, SCM_CLRGC8MARK):
[bpt/guile.git] / libguile / srcprop.c
index 6dd200b..87407f2 100644 (file)
@@ -1,65 +1,37 @@
-/*     Copyright (C) 1995, 1996, 1997, 1998, 1999 Free Software Foundation
+/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002 Free Software Foundation
  * 
- * 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 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 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.
+ * 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.
  *
- * The author can be reached at djurfeldt@nada.kth.se
- * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
+ * 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
+ */
 
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 
 \f
 
-#include <stdio.h>
-#include "_scm.h"
-#include "smob.h"
-#include "alist.h"
-#include "debug.h"
-#include "hashtab.h"
-#include "hash.h"
-#include "ports.h"
-#include "root.h"
-#include "weaks.h"
+#include <errno.h>
 
-#include "validate.h"
-#include "srcprop.h"
+#include "libguile/_scm.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}
  *
  *
  */
 
-SCM scm_sym_filename;
-SCM scm_sym_copy;
-SCM scm_sym_line;
-SCM scm_sym_column;
-SCM scm_sym_breakpoint;
+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");
 
-long scm_tc16_srcprops;
-static scm_srcprops_chunk *srcprops_chunklist = 0;
-static scm_srcprops *srcprops_freelist = 0;
+scm_t_bits scm_tc16_srcprops;
+static scm_t_srcprops_chunk *srcprops_chunklist = 0;
+static scm_t_srcprops *srcprops_freelist = 0;
 
 
 static SCM
-marksrcprops (SCM obj)
+srcprops_mark (SCM obj)
 {
   scm_gc_mark (SRCPROPFNAME (obj));
   scm_gc_mark (SRCPROPCOPY (obj));
@@ -96,17 +68,17 @@ marksrcprops (SCM obj)
 }
 
 
-static scm_sizet
-freesrcprops (SCM obj)
+static size_t
+srcprops_free (SCM obj)
 {
-  *((scm_srcprops **) SCM_CELL_WORD_1 (obj)) = srcprops_freelist;
-  srcprops_freelist = (scm_srcprops *) SCM_CELL_WORD_1 (obj);
+  *((scm_t_srcprops **) SCM_CELL_WORD_1 (obj)) = srcprops_freelist;
+  srcprops_freelist = (scm_t_srcprops *) SCM_CELL_WORD_1 (obj);
   return 0; /* srcprops_chunks are not freed until leaving guile */
 }
 
 
 static int
-prinsrcprops (SCM obj,SCM port,scm_print_state *pstate)
+srcprops_print (SCM obj, SCM port, scm_print_state *pstate)
 {
   int writingp = SCM_WRITINGP (pstate);
   scm_puts ("#<srcprops ", port);
@@ -118,34 +90,44 @@ prinsrcprops (SCM obj,SCM port,scm_print_state *pstate)
 }
 
 
+int
+scm_c_source_property_breakpoint_p (SCM form)
+{
+  SCM obj = scm_whash_lookup (scm_source_whash, form);
+  return SRCPROPSP (obj) && SRCPROPBRK (obj);
+}
+
+
 SCM
-scm_make_srcprops (int line, int col, SCM filename, SCM copy, SCM plist)
+scm_make_srcprops (long line, int col, SCM filename, SCM copy, SCM plist)
 {
-  register scm_srcprops *ptr;
+  register scm_t_srcprops *ptr;
   SCM_DEFER_INTS;
   if ((ptr = srcprops_freelist) != NULL)
-    srcprops_freelist = *(scm_srcprops **)ptr;
+    srcprops_freelist = *(scm_t_srcprops **)ptr;
   else
     {
-      int i;
-      scm_srcprops_chunk *mem;
-      scm_sizet n = sizeof (scm_srcprops_chunk)
-                   + sizeof (scm_srcprops) * (SRCPROPS_CHUNKSIZE - 1);
-      SCM_SYSCALL (mem = (scm_srcprops_chunk *) malloc (n));
-      SCM_ASSERT (mem, SCM_UNDEFINED, SCM_NALLOC, "srcprops");
+      size_t i;
+      scm_t_srcprops_chunk *mem;
+      size_t n = sizeof (scm_t_srcprops_chunk)
+                   + sizeof (scm_t_srcprops) * (SRCPROPS_CHUNKSIZE - 1);
+      SCM_SYSCALL (mem = (scm_t_srcprops_chunk *) scm_malloc (n));
+      if (mem == NULL)
+       scm_memory_error ("srcprops");
       scm_mallocated += n;
       mem->next = srcprops_chunklist;
       srcprops_chunklist = mem;
       ptr = &mem->srcprops[0];
       for (i = 1; i < SRCPROPS_CHUNKSIZE - 1; ++i)
-       *(scm_srcprops **)&ptr[i] = &ptr[i + 1];
-      *(scm_srcprops **)&ptr[SRCPROPS_CHUNKSIZE - 1] = 0;
-      srcprops_freelist = (scm_srcprops *) &ptr[1];
+       *(scm_t_srcprops **)&ptr[i] = &ptr[i + 1];
+      *(scm_t_srcprops **)&ptr[SRCPROPS_CHUNKSIZE - 1] = 0;
+      srcprops_freelist = (scm_t_srcprops *) &ptr[1];
     }
   ptr->pos = SRCPROPMAKPOS (line, col);
   ptr->fname = filename;
   ptr->copy = copy;
   ptr->plist = plist;
+  SCM_ALLOW_INTS;
   SCM_RETURN_NEWSMOB (scm_tc16_srcprops, ptr);
 }
 
@@ -160,25 +142,23 @@ scm_srcprops_to_plist (SCM obj)
     plist = scm_acons (scm_sym_filename, SRCPROPFNAME (obj), plist);
   plist = scm_acons (scm_sym_column, SCM_MAKINUM (SRCPROPCOL (obj)), plist);
   plist = scm_acons (scm_sym_line, SCM_MAKINUM (SRCPROPLINE (obj)), plist);
-  plist = scm_acons (scm_sym_breakpoint, SRCPROPBRK (obj), plist);
+  plist = scm_acons (scm_sym_breakpoint, SCM_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);
+  SCM_VALIDATE_NIM (1, obj);
   if (SCM_MEMOIZEDP (obj))
     obj = SCM_MEMOIZED_EXP (obj);
-#ifndef SCM_RECKLESS
-  else if (SCM_NCONSP (obj))
+  else if (!SCM_CONSP (obj))
     SCM_WRONG_TYPE_ARG (1, obj);
-#endif
-  p = scm_hashq_ref (scm_source_whash, obj, (SCM) NULL);
-  if (p != (SCM) NULL && SRCPROPSP (p))
+  p = scm_hashq_ref (scm_source_whash, obj, SCM_BOOL_F);
+  if (SRCPROPSP (p))
     return scm_srcprops_to_plist (p);
   return SCM_EOL;
 }
@@ -188,17 +168,16 @@ SCM_DEFINE (scm_source_properties, "source-properties", 1, 0, 0,
    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);
+  SCM_VALIDATE_NIM (1, obj);
   if (SCM_MEMOIZEDP (obj))
     obj = SCM_MEMOIZED_EXP (obj);
-#ifndef SCM_RECKLESS
-  else if (SCM_NCONSP (obj))
+  else if (!SCM_CONSP (obj))
     SCM_WRONG_TYPE_ARG(1, obj);
-#endif
   handle = scm_hashq_create_handle_x (scm_source_whash, obj, plist);
   SCM_SETCDR (handle, plist);
   return plist;
@@ -207,21 +186,20 @@ SCM_DEFINE (scm_set_source_properties_x, "set-source-properties!", 2, 0, 0,
 
 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);
+  SCM_VALIDATE_NIM (1, obj);
   if (SCM_MEMOIZEDP (obj))
     obj = SCM_MEMOIZED_EXP (obj);
-#ifndef SCM_RECKLESS
-  else if (SCM_NECONSP (obj))
+  else if (!SCM_CONSP (obj))
     SCM_WRONG_TYPE_ARG (1, obj);
-#endif
   p = scm_hashq_ref (scm_source_whash, obj, SCM_EOL);
-  if (SCM_IMP (p) || !SRCPROPSP (p))
+  if (!SRCPROPSP (p))
     goto plist;
-  if      (SCM_EQ_P (scm_sym_breakpoint, key)) p = SRCPROPBRK (p);
+  if      (SCM_EQ_P (scm_sym_breakpoint, key)) p = SCM_BOOL (SRCPROPBRK (p));
   else if (SCM_EQ_P (scm_sym_line,       key)) p = SCM_MAKINUM (SRCPROPLINE (p));
   else if (SCM_EQ_P (scm_sym_column,     key)) p = SCM_MAKINUM (SRCPROPCOL (p));
   else if (SCM_EQ_P (scm_sym_filename,   key)) p = SRCPROPFNAME (p);
@@ -239,18 +217,17 @@ SCM_DEFINE (scm_source_property, "source-property", 2, 0, 0,
 
 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);
+  SCM_VALIDATE_NIM (1, obj);
   if (SCM_MEMOIZEDP (obj))
     obj = SCM_MEMOIZED_EXP (obj);
-#ifndef SCM_RECKLESS
-  else if (SCM_NCONSP (obj))
+  else if (!SCM_CONSP (obj))
     SCM_WRONG_TYPE_ARG (1, obj);
-#endif
   h = scm_whash_get_handle (scm_source_whash, obj);
   if (SCM_WHASHFOUNDP (h))
     p = SCM_WHASHREF (scm_source_whash, h);
@@ -261,28 +238,26 @@ SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
     }
   if (SCM_EQ_P (scm_sym_breakpoint, key))
     {
-      if (SCM_FALSEP (datum))
-       CLEARSRCPROPBRK (SRCPROPSP (p)
-                        ? p
-                        : SCM_WHASHSET (scm_source_whash, h,
-                                        scm_make_srcprops (0,
-                                                           0,
-                                                           SCM_UNDEFINED,
-                                                           SCM_UNDEFINED,
-                                                           p)));
+      if (SRCPROPSP (p))
+       {
+         if (SCM_FALSEP (datum))
+           CLEARSRCPROPBRK (p);
+         else
+           SETSRCPROPBRK (p);
+       }
       else
-       SETSRCPROPBRK (SRCPROPSP (p)
-                      ? p
-                      : SCM_WHASHSET (scm_source_whash, h,
-                                      scm_make_srcprops (0,
-                                                         0,
-                                                         SCM_UNDEFINED,
-                                                         SCM_UNDEFINED,
-                                                         p)));
+       {
+         SCM sp = scm_make_srcprops (0, 0, SCM_UNDEFINED, SCM_UNDEFINED, p);
+         SCM_WHASHSET (scm_source_whash, h, sp);
+         if (SCM_FALSEP (datum))
+           CLEARSRCPROPBRK (sp);
+         else
+           SETSRCPROPBRK (sp);
+       }
     }
   else if (SCM_EQ_P (scm_sym_line, key))
     {
-      SCM_VALIDATE_INUM (3,datum);
+      SCM_VALIDATE_INUM (3, datum);
       if (SRCPROPSP (p))
        SETSRCPROPLINE (p, SCM_INUM (datum));
       else
@@ -292,7 +267,7 @@ SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
     }
   else if (SCM_EQ_P (scm_sym_column, key))
     {
-      SCM_VALIDATE_INUM (3,datum);
+      SCM_VALIDATE_INUM (3, datum);
       if (SRCPROPSP (p))
        SETSRCPROPCOL (p, SCM_INUM (datum));
       else
@@ -307,7 +282,7 @@ SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
       else
        SCM_WHASHSET (scm_source_whash, h, scm_make_srcprops (0, 0, datum, SCM_UNDEFINED, p));
     }
-  else if (SCM_EQ_P (scm_sym_filename, key))
+  else if (SCM_EQ_P (scm_sym_copy, key))
     {
       if (SRCPROPSP (p))
        SRCPROPCOPY (p) = datum;
@@ -315,7 +290,12 @@ SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
        SCM_WHASHSET (scm_source_whash, h, scm_make_srcprops (0, 0, SCM_UNDEFINED, datum, p));
     }
   else
-    SCM_WHASHSET (scm_source_whash, h, scm_acons (key, datum, p));
+    {
+      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
@@ -324,30 +304,27 @@ SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
 void
 scm_init_srcprop ()
 {
-  scm_tc16_srcprops = scm_make_smob_type_mfpe ("srcprops", 0,
-                                         marksrcprops, freesrcprops, prinsrcprops, NULL);
-  scm_source_whash = scm_make_weak_key_hash_table (SCM_MAKINUM (2047));
+  scm_tc16_srcprops = scm_make_smob_type ("srcprops", 0);
+  scm_set_smob_mark (scm_tc16_srcprops, srcprops_mark);
+  scm_set_smob_free (scm_tc16_srcprops, srcprops_free);
+  scm_set_smob_print (scm_tc16_srcprops, srcprops_print);
 
-  scm_sym_filename = SCM_CAR (scm_sysintern ("filename", SCM_UNDEFINED));
-  scm_sym_copy = SCM_CAR (scm_sysintern ("copy", SCM_UNDEFINED));
-  scm_sym_line = SCM_CAR (scm_sysintern ("line", SCM_UNDEFINED));
-  scm_sym_column = SCM_CAR (scm_sysintern ("column", SCM_UNDEFINED));
-  scm_sym_breakpoint = SCM_CAR (scm_sysintern ("breakpoint", SCM_UNDEFINED));
+  scm_source_whash = scm_make_weak_key_hash_table (SCM_MAKINUM (2047));
+  scm_c_define ("source-whash", scm_source_whash);
 
-  scm_sysintern ("source-whash", scm_source_whash);
-#include "srcprop.x"
+#include "libguile/srcprop.x"
 }
 
 void
 scm_finish_srcprop ()
 {
-  register scm_srcprops_chunk *ptr = srcprops_chunklist, *next;
+  register scm_t_srcprops_chunk *ptr = srcprops_chunklist, *next;
   while (ptr)
     {
       next = ptr->next;
       free ((char *) ptr);
-      scm_mallocated -= sizeof (scm_srcprops_chunk)
-                       + sizeof (scm_srcprops) * (SRCPROPS_CHUNKSIZE - 1);
+      scm_mallocated -= sizeof (scm_t_srcprops_chunk)
+                       + sizeof (scm_t_srcprops) * (SRCPROPS_CHUNKSIZE - 1);
       ptr = next;
     }
 }