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