libguile/srcprop.c

   1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002 Free Software Foundation
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.
  41  *
  42  * The author can be reached at djurfeldt@nada.kth.se
  43  * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
  44
  45
  46 \f
  47
  48 #include <errno.h>
  49
  50 #include "libguile/_scm.h"
  51 #include "libguile/smob.h"
  52 #include "libguile/alist.h"
  53 #include "libguile/debug.h"
  54 #include "libguile/hashtab.h"
  55 #include "libguile/hash.h"
  56 #include "libguile/ports.h"
  57 #include "libguile/root.h"
  58 #include "libguile/weaks.h"
  59
  60 #include "libguile/validate.h"
  61 #include "libguile/srcprop.h"
  62 \f
  63 /* {Source Properties}
  64  *
  65  * Properties of source list expressions.
  66  * Five of these have special meaning and optimized storage:
  67  *
  68  * filename    string   The name of the source file.
  69  * copy        list     A copy of the list expression.
  70  * line        integer  The source code line number.
  71  * column      integer  The source code column number.
  72  * breakpoint  boolean  Sets a breakpoint on this form.
  73  *
  74  * Most properties above can be set by the reader.
  75  *
  76  */
  77
  78 SCM_GLOBAL_SYMBOL (scm_sym_filename, "filename");
  79 SCM_GLOBAL_SYMBOL (scm_sym_copy, "copy");
  80 SCM_GLOBAL_SYMBOL (scm_sym_line, "line");
  81 SCM_GLOBAL_SYMBOL (scm_sym_column, "column");
  82 SCM_GLOBAL_SYMBOL (scm_sym_breakpoint, "breakpoint");
  83
  84 scm_t_bits scm_tc16_srcprops;
  85 static scm_t_srcprops_chunk *srcprops_chunklist = 0;
  86 static scm_t_srcprops *srcprops_freelist = 0;
  87
  88
  89 static SCM
  90 srcprops_mark (SCM obj)
  91 {
  92   scm_gc_mark (SRCPROPFNAME (obj));
  93   scm_gc_mark (SRCPROPCOPY (obj));
  94   return SRCPROPPLIST (obj);
  95 }
  96
  97
  98 static size_t
  99 srcprops_free (SCM obj)
 100 {
 101   *((scm_t_srcprops **) SCM_CELL_WORD_1 (obj)) = srcprops_freelist;
 102   srcprops_freelist = (scm_t_srcprops *) SCM_CELL_WORD_1 (obj);
 103   return 0; /* srcprops_chunks are not freed until leaving guile */
 104 }
 105
 106
 107 static int
 108 srcprops_print (SCM obj, SCM port, scm_print_state *pstate)
 109 {
 110   int writingp = SCM_WRITINGP (pstate);
 111   scm_puts ("#<srcprops ", port);
 112   SCM_SET_WRITINGP (pstate, 1);
 113   scm_iprin1 (scm_srcprops_to_plist (obj), port, pstate);
 114   SCM_SET_WRITINGP (pstate, writingp);
 115   scm_putc ('>', port);
 116   return 1;
 117 }
 118
 119
 120 int
 121 scm_c_source_property_breakpoint_p (SCM form)
 122 {
 123   SCM obj = scm_whash_lookup (scm_source_whash, form);
 124   return SRCPROPSP (obj) && SRCPROPBRK (obj);
 125 }
 126
 127
 128 SCM
 129 scm_make_srcprops (long line, int col, SCM filename, SCM copy, SCM plist)
 130 {
 131   register scm_t_srcprops *ptr;
 132   SCM_DEFER_INTS;
 133   if ((ptr = srcprops_freelist) != NULL)
 134     srcprops_freelist = *(scm_t_srcprops **)ptr;
 135   else
 136     {
 137       size_t i;
 138       scm_t_srcprops_chunk *mem;
 139       size_t n = sizeof (scm_t_srcprops_chunk)
 140                     + sizeof (scm_t_srcprops) * (SRCPROPS_CHUNKSIZE - 1);
 141       SCM_SYSCALL (mem = (scm_t_srcprops_chunk *) scm_malloc (n));
 142       if (mem == NULL)
 143         scm_memory_error ("srcprops");
 144       scm_mallocated += n;
 145       mem->next = srcprops_chunklist;
 146       srcprops_chunklist = mem;
 147       ptr = &mem->srcprops[0];
 148       for (i = 1; i < SRCPROPS_CHUNKSIZE - 1; ++i)
 149         *(scm_t_srcprops **)&ptr[i] = &ptr[i + 1];
 150       *(scm_t_srcprops **)&ptr[SRCPROPS_CHUNKSIZE - 1] = 0;
 151       srcprops_freelist = (scm_t_srcprops *) &ptr[1];
 152     }
 153   ptr->pos = SRCPROPMAKPOS (line, col);
 154   ptr->fname = filename;
 155   ptr->copy = copy;
 156   ptr->plist = plist;
 157   SCM_ALLOW_INTS;
 158   SCM_RETURN_NEWSMOB (scm_tc16_srcprops, ptr);
 159 }
 160
 161
 162 SCM
 163 scm_srcprops_to_plist (SCM obj)
 164 {
 165   SCM plist = SRCPROPPLIST (obj);
 166   if (!SCM_UNBNDP (SRCPROPCOPY (obj)))
 167     plist = scm_acons (scm_sym_copy, SRCPROPCOPY (obj), plist);
 168   if (!SCM_UNBNDP (SRCPROPFNAME (obj)))
 169     plist = scm_acons (scm_sym_filename, SRCPROPFNAME (obj), plist);
 170   plist = scm_acons (scm_sym_column, SCM_MAKINUM (SRCPROPCOL (obj)), plist);
 171   plist = scm_acons (scm_sym_line, SCM_MAKINUM (SRCPROPLINE (obj)), plist);
 172   plist = scm_acons (scm_sym_breakpoint, SCM_BOOL (SRCPROPBRK (obj)), plist);
 173   return plist;
 174 }
 175
 176 SCM_DEFINE (scm_source_properties, "source-properties", 1, 0, 0,
 177             (SCM obj),
 178             "Return the source property association list of @var{obj}.")
 179 #define FUNC_NAME s_scm_source_properties
 180 {
 181   SCM p;
 182   SCM_VALIDATE_NIM (1, obj);
 183   if (SCM_MEMOIZEDP (obj))
 184     obj = SCM_MEMOIZED_EXP (obj);
 185   else if (!SCM_CONSP (obj))
 186     SCM_WRONG_TYPE_ARG (1, obj);
 187   p = scm_hashq_ref (scm_source_whash, obj, SCM_BOOL_F);
 188   if (SRCPROPSP (p))
 189     return scm_srcprops_to_plist (p);
 190   return SCM_EOL;
 191 }
 192 #undef FUNC_NAME
 193
 194 /* Perhaps this procedure should look through an alist
 195    and try to make a srcprops-object...? */
 196 SCM_DEFINE (scm_set_source_properties_x, "set-source-properties!", 2, 0, 0,
 197             (SCM obj, SCM plist),
 198             "Install the association list @var{plist} as the source property\n"
 199             "list for @var{obj}.")
 200 #define FUNC_NAME s_scm_set_source_properties_x
 201 {
 202   SCM handle;
 203   SCM_VALIDATE_NIM (1, obj);
 204   if (SCM_MEMOIZEDP (obj))
 205     obj = SCM_MEMOIZED_EXP (obj);
 206   else if (!SCM_CONSP (obj))
 207     SCM_WRONG_TYPE_ARG(1, obj);
 208   handle = scm_hashq_create_handle_x (scm_source_whash, obj, plist);
 209   SCM_SETCDR (handle, plist);
 210   return plist;
 211 }
 212 #undef FUNC_NAME
 213
 214 SCM_DEFINE (scm_source_property, "source-property", 2, 0, 0,
 215             (SCM obj, SCM key),
 216             "Return the source property specified by @var{key} from\n"
 217             "@var{obj}'s source property list.")
 218 #define FUNC_NAME s_scm_source_property
 219 {
 220   SCM p;
 221   SCM_VALIDATE_NIM (1, obj);
 222   if (SCM_MEMOIZEDP (obj))
 223     obj = SCM_MEMOIZED_EXP (obj);
 224   else if (!SCM_CONSP (obj))
 225     SCM_WRONG_TYPE_ARG (1, obj);
 226   p = scm_hashq_ref (scm_source_whash, obj, SCM_EOL);
 227   if (!SRCPROPSP (p))
 228     goto plist;
 229   if      (SCM_EQ_P (scm_sym_breakpoint, key)) p = SCM_BOOL (SRCPROPBRK (p));
 230   else if (SCM_EQ_P (scm_sym_line,       key)) p = SCM_MAKINUM (SRCPROPLINE (p));
 231   else if (SCM_EQ_P (scm_sym_column,     key)) p = SCM_MAKINUM (SRCPROPCOL (p));
 232   else if (SCM_EQ_P (scm_sym_filename,   key)) p = SRCPROPFNAME (p);
 233   else if (SCM_EQ_P (scm_sym_copy,       key)) p = SRCPROPCOPY (p);
 234   else
 235     {
 236       p = SRCPROPPLIST (p);
 237     plist:
 238       p = scm_assoc (key, p);
 239       return (SCM_NIMP (p) ? SCM_CDR (p) : SCM_BOOL_F);
 240     }
 241   return SCM_UNBNDP (p) ? SCM_BOOL_F : p;
 242 }
 243 #undef FUNC_NAME
 244
 245 SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
 246             (SCM obj, SCM key, SCM datum),
 247             "Set the source property of object @var{obj}, which is specified by\n"
 248             "@var{key} to @var{datum}.  Normally, the key will be a symbol.")
 249 #define FUNC_NAME s_scm_set_source_property_x
 250 {
 251   scm_whash_handle h;
 252   SCM p;
 253   SCM_VALIDATE_NIM (1, obj);
 254   if (SCM_MEMOIZEDP (obj))
 255     obj = SCM_MEMOIZED_EXP (obj);
 256   else if (!SCM_CONSP (obj))
 257     SCM_WRONG_TYPE_ARG (1, obj);
 258   h = scm_whash_get_handle (scm_source_whash, obj);
 259   if (SCM_WHASHFOUNDP (h))
 260     p = SCM_WHASHREF (scm_source_whash, h);
 261   else
 262     {
 263       h = scm_whash_create_handle (scm_source_whash, obj);
 264       p = SCM_EOL;
 265     }
 266   if (SCM_EQ_P (scm_sym_breakpoint, key))
 267     {
 268       if (SRCPROPSP (p))
 269         {
 270           if (SCM_FALSEP (datum))
 271             CLEARSRCPROPBRK (p);
 272           else
 273             SETSRCPROPBRK (p);
 274         }
 275       else
 276         {
 277           SCM sp = scm_make_srcprops (0, 0, SCM_UNDEFINED, SCM_UNDEFINED, p);
 278           SCM_WHASHSET (scm_source_whash, h, sp);
 279           if (SCM_FALSEP (datum))
 280             CLEARSRCPROPBRK (sp);
 281           else
 282             SETSRCPROPBRK (sp);
 283         }
 284     }
 285   else if (SCM_EQ_P (scm_sym_line, key))
 286     {
 287       SCM_VALIDATE_INUM (3, datum);
 288       if (SRCPROPSP (p))
 289         SETSRCPROPLINE (p, SCM_INUM (datum));
 290       else
 291         SCM_WHASHSET (scm_source_whash, h,
 292                       scm_make_srcprops (SCM_INUM (datum), 0,
 293                                          SCM_UNDEFINED, SCM_UNDEFINED, p));
 294     }
 295   else if (SCM_EQ_P (scm_sym_column, key))
 296     {
 297       SCM_VALIDATE_INUM (3, datum);
 298       if (SRCPROPSP (p))
 299         SETSRCPROPCOL (p, SCM_INUM (datum));
 300       else
 301         SCM_WHASHSET (scm_source_whash, h,
 302                       scm_make_srcprops (0, SCM_INUM (datum),
 303                                          SCM_UNDEFINED, SCM_UNDEFINED, p));
 304     }
 305   else if (SCM_EQ_P (scm_sym_filename, key))
 306     {
 307       if (SRCPROPSP (p))
 308         SRCPROPFNAME (p) = datum;
 309       else
 310         SCM_WHASHSET (scm_source_whash, h, scm_make_srcprops (0, 0, datum, SCM_UNDEFINED, p));
 311     }
 312   else if (SCM_EQ_P (scm_sym_copy, key))
 313     {
 314       if (SRCPROPSP (p))
 315         SRCPROPCOPY (p) = datum;
 316       else
 317         SCM_WHASHSET (scm_source_whash, h, scm_make_srcprops (0, 0, SCM_UNDEFINED, datum, p));
 318     }
 319   else
 320     {
 321       if (SRCPROPSP (p))
 322         SRCPROPPLIST (p) = scm_acons (key, datum, SRCPROPPLIST (p));
 323       else
 324         SCM_WHASHSET (scm_source_whash, h, scm_acons (key, datum, p));
 325     }
 326   return SCM_UNSPECIFIED;
 327 }
 328 #undef FUNC_NAME
 329
 330
 331 void
 332 scm_init_srcprop ()
 333 {
 334   scm_tc16_srcprops = scm_make_smob_type ("srcprops", 0);
 335   scm_set_smob_mark (scm_tc16_srcprops, srcprops_mark);
 336   scm_set_smob_free (scm_tc16_srcprops, srcprops_free);
 337   scm_set_smob_print (scm_tc16_srcprops, srcprops_print);
 338
 339   scm_source_whash = scm_make_weak_key_hash_table (SCM_MAKINUM (2047));
 340   scm_c_define ("source-whash", scm_source_whash);
 341
 342 #include "libguile/srcprop.x"
 343 }
 344
 345 void
 346 scm_finish_srcprop ()
 347 {
 348   register scm_t_srcprops_chunk *ptr = srcprops_chunklist, *next;
 349   while (ptr)
 350     {
 351       next = ptr->next;
 352       free ((char *) ptr);
 353       scm_mallocated -= sizeof (scm_t_srcprops_chunk)
 354                         + sizeof (scm_t_srcprops) * (SRCPROPS_CHUNKSIZE - 1);
 355       ptr = next;
 356     }
 357 }
 358
 359 /*
 360   Local Variables:
 361   c-file-style: "gnu"
 362   End:
 363 */