libguile/srcprop.c

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