libguile/srcprop.c

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