libguile/srcprop.c

   1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002, 2006, 2008 Free Software Foundation
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library 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 GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  16  */
  17
  18
  19 \f
  20 #ifdef HAVE_CONFIG_H
  21 # include <config.h>
  22 #endif
  23
  24 #include <errno.h>
  25
  26 #include "libguile/_scm.h"
  27 #include "libguile/async.h"
  28 #include "libguile/smob.h"
  29 #include "libguile/alist.h"
  30 #include "libguile/debug.h"
  31 #include "libguile/hashtab.h"
  32 #include "libguile/hash.h"
  33 #include "libguile/ports.h"
  34 #include "libguile/root.h"
  35 #include "libguile/weaks.h"
  36
  37 #include "libguile/validate.h"
  38 #include "libguile/srcprop.h"
  39 \f
  40 /* {Source Properties}
  41  *
  42  * Properties of source list expressions.
  43  * Five of these have special meaning:
  44  *
  45  * filename    string   The name of the source file.
  46  * copy        list     A copy of the list expression.
  47  * line        integer  The source code line number.
  48  * column      integer  The source code column number.
  49  * breakpoint  boolean  Sets a breakpoint on this form.
  50  *
  51  * Most properties above can be set by the reader.
  52  *
  53  */
  54
  55 SCM_GLOBAL_SYMBOL (scm_sym_filename, "filename");
  56 SCM_GLOBAL_SYMBOL (scm_sym_copy, "copy");
  57 SCM_GLOBAL_SYMBOL (scm_sym_line, "line");
  58 SCM_GLOBAL_SYMBOL (scm_sym_column, "column");
  59 SCM_GLOBAL_SYMBOL (scm_sym_breakpoint, "breakpoint");
  60
  61
  62
  63 /*
  64  *  Source properties are stored as double cells with the
  65  *  following layout:
  66
  67  * car = tag
  68  * cbr = pos
  69  * ccr = copy
  70  * cdr = plist
  71  */
  72
  73 #define SRCPROPSP(p) (SCM_SMOB_PREDICATE (scm_tc16_srcprops, (p)))
  74 #define SRCPROPBRK(p) (SCM_SMOB_FLAGS (p) & SCM_SOURCE_PROPERTY_FLAG_BREAK)
  75 #define SRCPROPPOS(p) (SCM_CELL_WORD(p,1))
  76 #define SRCPROPLINE(p) (SRCPROPPOS(p) >> 12)
  77 #define SRCPROPCOL(p) (SRCPROPPOS(p) & 0x0fffL)
  78 #define SRCPROPCOPY(p) (SCM_CELL_OBJECT(p,2))
  79 #define SRCPROPPLIST(p) (SCM_CELL_OBJECT_3(p))
  80 #define SETSRCPROPBRK(p) \
  81  (SCM_SET_SMOB_FLAGS ((p), \
  82                       SCM_SMOB_FLAGS (p) | SCM_SOURCE_PROPERTY_FLAG_BREAK))
  83 #define CLEARSRCPROPBRK(p)  \
  84  (SCM_SET_SMOB_FLAGS ((p), \
  85                       SCM_SMOB_FLAGS (p) & ~SCM_SOURCE_PROPERTY_FLAG_BREAK))
  86 #define SRCPROPMAKPOS(l, c) (((l) << 12) + (c))
  87 #define SETSRCPROPPOS(p, l, c) (SCM_SET_CELL_WORD(p,1, SRCPROPMAKPOS (l, c)))
  88 #define SETSRCPROPLINE(p, l) SETSRCPROPPOS (p, l, SRCPROPCOL (p))
  89 #define SETSRCPROPCOL(p, c) SETSRCPROPPOS (p, SRCPROPLINE (p), c)
  90 #define SETSRCPROPCOPY(p, c) (SCM_SET_CELL_WORD(p, 2, c))
  91 #define SETSRCPROPPLIST(p, l) (SCM_SET_CELL_WORD(p, 3, l))
  92
  93
  94
  95 scm_t_bits scm_tc16_srcprops;
  96
  97 static SCM
  98 srcprops_mark (SCM obj)
  99 {
 100   scm_gc_mark (SRCPROPCOPY (obj));
 101   return SRCPROPPLIST (obj);
 102 }
 103
 104 static int
 105 srcprops_print (SCM obj, SCM port, scm_print_state *pstate)
 106 {
 107   int writingp = SCM_WRITINGP (pstate);
 108   scm_puts ("#<srcprops ", port);
 109   SCM_SET_WRITINGP (pstate, 1);
 110   scm_iprin1 (scm_srcprops_to_plist (obj), port, pstate);
 111   SCM_SET_WRITINGP (pstate, writingp);
 112   scm_putc ('>', port);
 113   return 1;
 114 }
 115
 116
 117 int
 118 scm_c_source_property_breakpoint_p (SCM form)
 119 {
 120   SCM obj = scm_whash_lookup (scm_source_whash, form);
 121   return SRCPROPSP (obj) && SRCPROPBRK (obj);
 122 }
 123
 124
 125 /*
 126  * We remember the last file name settings, so we can share that plist
 127  * entry.  This works because scm_set_source_property_x does not use
 128  * assoc-set! for modifying the plist.
 129  *
 130  * This variable contains a protected cons, whose cdr is the cached
 131  * plist
 132  */
 133 static SCM scm_last_plist_filename;
 134
 135 SCM
 136 scm_make_srcprops (long line, int col, SCM filename, SCM copy, SCM plist)
 137 {
 138   if (!SCM_UNBNDP (filename))
 139     {
 140       SCM old_plist = plist;
 141
 142       /*
 143         have to extract the acons, and operate on that, for
 144         thread safety.
 145        */
 146       SCM last_acons = SCM_CDR (scm_last_plist_filename);
 147       if (old_plist == SCM_EOL
 148           && SCM_CDAR (last_acons) == filename)
 149         {
 150           plist = last_acons;
 151         }
 152       else
 153         {
 154           plist = scm_acons (scm_sym_filename, filename, plist);
 155           if (old_plist == SCM_EOL)
 156             SCM_SETCDR (scm_last_plist_filename, plist);
 157         }
 158     }
 159
 160   SCM_RETURN_NEWSMOB3 (scm_tc16_srcprops,
 161                        SRCPROPMAKPOS (line, col),
 162                        copy,
 163                        plist);
 164 }
 165
 166
 167 SCM
 168 scm_srcprops_to_plist (SCM obj)
 169 {
 170   SCM plist = SRCPROPPLIST (obj);
 171   if (!SCM_UNBNDP (SRCPROPCOPY (obj)))
 172     plist = scm_acons (scm_sym_copy, SRCPROPCOPY (obj), plist);
 173   plist = scm_acons (scm_sym_column, scm_from_int (SRCPROPCOL (obj)), plist);
 174   plist = scm_acons (scm_sym_line, scm_from_int (SRCPROPLINE (obj)), plist);
 175   plist = scm_acons (scm_sym_breakpoint, scm_from_bool (SRCPROPBRK (obj)), plist);
 176   return plist;
 177 }
 178
 179 SCM_DEFINE (scm_source_properties, "source-properties", 1, 0, 0,
 180             (SCM obj),
 181             "Return the source property association list of @var{obj}.")
 182 #define FUNC_NAME s_scm_source_properties
 183 {
 184   SCM p;
 185   SCM_VALIDATE_NIM (1, obj);
 186   if (SCM_MEMOIZEDP (obj))
 187     obj = SCM_MEMOIZED_EXP (obj);
 188   else if (!scm_is_pair (obj))
 189     SCM_WRONG_TYPE_ARG (1, obj);
 190   p = scm_hashq_ref (scm_source_whash, obj, SCM_EOL);
 191   if (SRCPROPSP (p))
 192     return scm_srcprops_to_plist (p);
 193   else
 194     /* list from set-source-properties!, or SCM_EOL for not found */
 195     return p;
 196 }
 197 #undef FUNC_NAME
 198
 199 /* Perhaps this procedure should look through an alist
 200    and try to make a srcprops-object...? */
 201 SCM_DEFINE (scm_set_source_properties_x, "set-source-properties!", 2, 0, 0,
 202             (SCM obj, SCM plist),
 203             "Install the association list @var{plist} as the source property\n"
 204             "list for @var{obj}.")
 205 #define FUNC_NAME s_scm_set_source_properties_x
 206 {
 207   SCM handle;
 208   SCM_VALIDATE_NIM (1, obj);
 209   if (SCM_MEMOIZEDP (obj))
 210     obj = SCM_MEMOIZED_EXP (obj);
 211   else if (!scm_is_pair (obj))
 212     SCM_WRONG_TYPE_ARG(1, obj);
 213   handle = scm_hashq_create_handle_x (scm_source_whash, obj, plist);
 214   SCM_SETCDR (handle, plist);
 215   return plist;
 216 }
 217 #undef FUNC_NAME
 218
 219 SCM_DEFINE (scm_source_property, "source-property", 2, 0, 0,
 220             (SCM obj, SCM key),
 221             "Return the source property specified by @var{key} from\n"
 222             "@var{obj}'s source property list.")
 223 #define FUNC_NAME s_scm_source_property
 224 {
 225   SCM p;
 226   SCM_VALIDATE_NIM (1, obj);
 227   if (SCM_MEMOIZEDP (obj))
 228     obj = SCM_MEMOIZED_EXP (obj);
 229   else if (!scm_is_pair (obj))
 230     SCM_WRONG_TYPE_ARG (1, obj);
 231   p = scm_hashq_ref (scm_source_whash, obj, SCM_EOL);
 232   if (!SRCPROPSP (p))
 233     goto plist;
 234   if      (scm_is_eq (scm_sym_breakpoint, key)) p = scm_from_bool (SRCPROPBRK (p));
 235   else if (scm_is_eq (scm_sym_line,       key)) p = scm_from_int (SRCPROPLINE (p));
 236   else if (scm_is_eq (scm_sym_column,     key)) p = scm_from_int (SRCPROPCOL (p));
 237   else if (scm_is_eq (scm_sym_copy,       key)) p = SRCPROPCOPY (p);
 238   else
 239     {
 240       p = SRCPROPPLIST (p);
 241     plist:
 242       p = scm_assoc (key, p);
 243       return (SCM_NIMP (p) ? SCM_CDR (p) : SCM_BOOL_F);
 244     }
 245   return SCM_UNBNDP (p) ? SCM_BOOL_F : p;
 246 }
 247 #undef FUNC_NAME
 248
 249 SCM_DEFINE (scm_set_source_property_x, "set-source-property!", 3, 0, 0,
 250             (SCM obj, SCM key, SCM datum),
 251             "Set the source property of object @var{obj}, which is specified by\n"
 252             "@var{key} to @var{datum}.  Normally, the key will be a symbol.")
 253 #define FUNC_NAME s_scm_set_source_property_x
 254 {
 255   scm_whash_handle h;
 256   SCM p;
 257   SCM_VALIDATE_NIM (1, obj);
 258   if (SCM_MEMOIZEDP (obj))
 259     obj = SCM_MEMOIZED_EXP (obj);
 260   else if (!scm_is_pair (obj))
 261     SCM_WRONG_TYPE_ARG (1, obj);
 262   h = scm_whash_get_handle (scm_source_whash, obj);
 263   if (SCM_WHASHFOUNDP (h))
 264     p = SCM_WHASHREF (scm_source_whash, h);
 265   else
 266     {
 267       h = scm_whash_create_handle (scm_source_whash, obj);
 268       p = SCM_EOL;
 269     }
 270   if (scm_is_eq (scm_sym_breakpoint, key))
 271     {
 272       if (SRCPROPSP (p))
 273         {
 274           if (scm_is_false (datum))
 275             CLEARSRCPROPBRK (p);
 276           else
 277             SETSRCPROPBRK (p);
 278         }
 279       else
 280         {
 281           SCM sp = scm_make_srcprops (0, 0, SCM_UNDEFINED, SCM_UNDEFINED, p);
 282           SCM_WHASHSET (scm_source_whash, h, sp);
 283           if (scm_is_false (datum))
 284             CLEARSRCPROPBRK (sp);
 285           else
 286             SETSRCPROPBRK (sp);
 287         }
 288     }
 289   else if (scm_is_eq (scm_sym_line, key))
 290     {
 291       if (SRCPROPSP (p))
 292         SETSRCPROPLINE (p, scm_to_int (datum));
 293       else
 294         SCM_WHASHSET (scm_source_whash, h,
 295                       scm_make_srcprops (scm_to_int (datum), 0,
 296                                          SCM_UNDEFINED, SCM_UNDEFINED, p));
 297     }
 298   else if (scm_is_eq (scm_sym_column, key))
 299     {
 300       if (SRCPROPSP (p))
 301         SETSRCPROPCOL (p, scm_to_int (datum));
 302       else
 303         SCM_WHASHSET (scm_source_whash, h,
 304                       scm_make_srcprops (0, scm_to_int (datum),
 305                                          SCM_UNDEFINED, SCM_UNDEFINED, p));
 306     }
 307   else if (scm_is_eq (scm_sym_copy, key))
 308     {
 309       if (SRCPROPSP (p))
 310         SETSRCPROPCOPY (p, datum);
 311       else
 312         SCM_WHASHSET (scm_source_whash, h, scm_make_srcprops (0, 0, SCM_UNDEFINED, datum, p));
 313     }
 314   else
 315     {
 316       if (SRCPROPSP (p))
 317         SETSRCPROPPLIST (p, scm_acons (key, datum, SRCPROPPLIST (p)));
 318       else
 319         SCM_WHASHSET (scm_source_whash, h, scm_acons (key, datum, p));
 320     }
 321   return SCM_UNSPECIFIED;
 322 }
 323 #undef FUNC_NAME
 324
 325
 326 void
 327 scm_init_srcprop ()
 328 {
 329   scm_tc16_srcprops = scm_make_smob_type ("srcprops", 0);
 330   scm_set_smob_mark (scm_tc16_srcprops, srcprops_mark);
 331   scm_set_smob_print (scm_tc16_srcprops, srcprops_print);
 332
 333   scm_source_whash = scm_make_weak_key_hash_table (scm_from_int (2047));
 334   scm_c_define ("source-whash", scm_source_whash);
 335
 336   scm_last_plist_filename
 337     = scm_permanent_object (scm_cons (SCM_EOL,
 338                                       scm_acons (SCM_EOL, SCM_EOL, SCM_EOL)));
 339
 340 #include "libguile/srcprop.x"
 341 }
 342
 343
 344 /*
 345   Local Variables:
 346   c-file-style: "gnu"
 347   End:
 348 */