1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001 Free Software Foundation
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)
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.
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
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
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.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
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.
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.
42 * The author can be reached at djurfeldt@nada.kth.se
43 * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
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"
60 #include "libguile/validate.h"
61 #include "libguile/srcprop.h"
63 /* {Source Properties}
65 * Properties of source list expressions.
66 * Five of these have special meaning and optimized storage:
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.
74 * Most properties above can be set by the reader.
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");
84 scm_t_bits scm_tc16_srcprops
;
85 static scm_t_srcprops_chunk
*srcprops_chunklist
= 0;
86 static scm_t_srcprops
*srcprops_freelist
= 0;
90 srcprops_mark (SCM obj
)
92 scm_gc_mark (SRCPROPFNAME (obj
));
93 scm_gc_mark (SRCPROPCOPY (obj
));
94 return SRCPROPPLIST (obj
);
99 srcprops_free (SCM obj
)
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 */
108 srcprops_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
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
);
121 scm_make_srcprops (long line
, int col
, SCM filename
, SCM copy
, SCM plist
)
123 register scm_t_srcprops
*ptr
;
125 if ((ptr
= srcprops_freelist
) != NULL
)
126 srcprops_freelist
= *(scm_t_srcprops
**)ptr
;
130 scm_t_srcprops_chunk
*mem
;
131 size_t n
= sizeof (scm_t_srcprops_chunk
)
132 + sizeof (scm_t_srcprops
) * (SRCPROPS_CHUNKSIZE
- 1);
133 SCM_SYSCALL (mem
= (scm_t_srcprops_chunk
*) malloc (n
));
135 scm_memory_error ("srcprops");
137 mem
->next
= srcprops_chunklist
;
138 srcprops_chunklist
= mem
;
139 ptr
= &mem
->srcprops
[0];
140 for (i
= 1; i
< SRCPROPS_CHUNKSIZE
- 1; ++i
)
141 *(scm_t_srcprops
**)&ptr
[i
] = &ptr
[i
+ 1];
142 *(scm_t_srcprops
**)&ptr
[SRCPROPS_CHUNKSIZE
- 1] = 0;
143 srcprops_freelist
= (scm_t_srcprops
*) &ptr
[1];
145 ptr
->pos
= SRCPROPMAKPOS (line
, col
);
146 ptr
->fname
= filename
;
150 SCM_RETURN_NEWSMOB (scm_tc16_srcprops
, ptr
);
155 scm_srcprops_to_plist (SCM obj
)
157 SCM plist
= SRCPROPPLIST (obj
);
158 if (!SCM_UNBNDP (SRCPROPCOPY (obj
)))
159 plist
= scm_acons (scm_sym_copy
, SRCPROPCOPY (obj
), plist
);
160 if (!SCM_UNBNDP (SRCPROPFNAME (obj
)))
161 plist
= scm_acons (scm_sym_filename
, SRCPROPFNAME (obj
), plist
);
162 plist
= scm_acons (scm_sym_column
, SCM_MAKINUM (SRCPROPCOL (obj
)), plist
);
163 plist
= scm_acons (scm_sym_line
, SCM_MAKINUM (SRCPROPLINE (obj
)), plist
);
164 plist
= scm_acons (scm_sym_breakpoint
, SRCPROPBRK (obj
), plist
);
168 SCM_DEFINE (scm_source_properties
, "source-properties", 1, 0, 0,
170 "Return the source property association list of @var{obj}.")
171 #define FUNC_NAME s_scm_source_properties
174 SCM_VALIDATE_NIM (1,obj
);
175 if (SCM_MEMOIZEDP (obj
))
176 obj
= SCM_MEMOIZED_EXP (obj
);
178 else if (SCM_NCONSP (obj
))
179 SCM_WRONG_TYPE_ARG (1, obj
);
181 p
= scm_hashq_ref (scm_source_whash
, obj
, SCM_BOOL_F
);
183 return scm_srcprops_to_plist (p
);
188 /* Perhaps this procedure should look through an alist
189 and try to make a srcprops-object...? */
190 SCM_DEFINE (scm_set_source_properties_x
, "set-source-properties!", 2, 0, 0,
191 (SCM obj
, SCM plist
),
192 "Install the association list @var{plist} as the source property\n"
193 "list for @var{obj}.")
194 #define FUNC_NAME s_scm_set_source_properties_x
197 SCM_VALIDATE_NIM (1,obj
);
198 if (SCM_MEMOIZEDP (obj
))
199 obj
= SCM_MEMOIZED_EXP (obj
);
201 else if (SCM_NCONSP (obj
))
202 SCM_WRONG_TYPE_ARG(1, obj
);
204 handle
= scm_hashq_create_handle_x (scm_source_whash
, obj
, plist
);
205 SCM_SETCDR (handle
, plist
);
210 SCM_DEFINE (scm_source_property
, "source-property", 2, 0, 0,
212 "Return the source property specified by @var{key} from\n"
213 "@var{obj}'s source property list.")
214 #define FUNC_NAME s_scm_source_property
217 SCM_VALIDATE_NIM (1,obj
);
218 if (SCM_MEMOIZEDP (obj
))
219 obj
= SCM_MEMOIZED_EXP (obj
);
221 else if (SCM_NCONSP (obj
))
222 SCM_WRONG_TYPE_ARG (1, obj
);
224 p
= scm_hashq_ref (scm_source_whash
, obj
, SCM_EOL
);
227 if (SCM_EQ_P (scm_sym_breakpoint
, key
)) p
= SRCPROPBRK (p
);
228 else if (SCM_EQ_P (scm_sym_line
, key
)) p
= SCM_MAKINUM (SRCPROPLINE (p
));
229 else if (SCM_EQ_P (scm_sym_column
, key
)) p
= SCM_MAKINUM (SRCPROPCOL (p
));
230 else if (SCM_EQ_P (scm_sym_filename
, key
)) p
= SRCPROPFNAME (p
);
231 else if (SCM_EQ_P (scm_sym_copy
, key
)) p
= SRCPROPCOPY (p
);
234 p
= SRCPROPPLIST (p
);
236 p
= scm_assoc (key
, p
);
237 return (SCM_NIMP (p
) ? SCM_CDR (p
) : SCM_BOOL_F
);
239 return SCM_UNBNDP (p
) ? SCM_BOOL_F
: p
;
243 SCM_DEFINE (scm_set_source_property_x
, "set-source-property!", 3, 0, 0,
244 (SCM obj
, SCM key
, SCM datum
),
245 "Set the source property of object @var{obj}, which is specified by\n"
246 "@var{key} to @var{datum}. Normally, the key will be a symbol.")
247 #define FUNC_NAME s_scm_set_source_property_x
251 SCM_VALIDATE_NIM (1,obj
);
252 if (SCM_MEMOIZEDP (obj
))
253 obj
= SCM_MEMOIZED_EXP (obj
);
255 else if (SCM_NCONSP (obj
))
256 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
);
263 h
= scm_whash_create_handle (scm_source_whash
, obj
);
266 if (SCM_EQ_P (scm_sym_breakpoint
, key
))
270 if (SCM_FALSEP (datum
))
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
);
285 else if (SCM_EQ_P (scm_sym_line
, key
))
287 SCM_VALIDATE_INUM (3,datum
);
289 SETSRCPROPLINE (p
, SCM_INUM (datum
));
291 SCM_WHASHSET (scm_source_whash
, h
,
292 scm_make_srcprops (SCM_INUM (datum
), 0,
293 SCM_UNDEFINED
, SCM_UNDEFINED
, p
));
295 else if (SCM_EQ_P (scm_sym_column
, key
))
297 SCM_VALIDATE_INUM (3,datum
);
299 SETSRCPROPCOL (p
, SCM_INUM (datum
));
301 SCM_WHASHSET (scm_source_whash
, h
,
302 scm_make_srcprops (0, SCM_INUM (datum
),
303 SCM_UNDEFINED
, SCM_UNDEFINED
, p
));
305 else if (SCM_EQ_P (scm_sym_filename
, key
))
308 SRCPROPFNAME (p
) = datum
;
310 SCM_WHASHSET (scm_source_whash
, h
, scm_make_srcprops (0, 0, datum
, SCM_UNDEFINED
, p
));
312 else if (SCM_EQ_P (scm_sym_copy
, key
))
315 SRCPROPCOPY (p
) = datum
;
317 SCM_WHASHSET (scm_source_whash
, h
, scm_make_srcprops (0, 0, SCM_UNDEFINED
, datum
, p
));
320 SCM_WHASHSET (scm_source_whash
, h
, scm_acons (key
, datum
, p
));
321 return SCM_UNSPECIFIED
;
329 scm_tc16_srcprops
= scm_make_smob_type ("srcprops", 0);
330 scm_set_smob_mark (scm_tc16_srcprops
, srcprops_mark
);
331 scm_set_smob_free (scm_tc16_srcprops
, srcprops_free
);
332 scm_set_smob_print (scm_tc16_srcprops
, srcprops_print
);
334 scm_source_whash
= scm_make_weak_key_hash_table (SCM_MAKINUM (2047));
335 scm_c_define ("source-whash", scm_source_whash
);
337 #ifndef SCM_MAGIC_SNARFER
338 #include "libguile/srcprop.x"
343 scm_finish_srcprop ()
345 register scm_t_srcprops_chunk
*ptr
= srcprops_chunklist
, *next
;
350 scm_mallocated
-= sizeof (scm_t_srcprops_chunk
)
351 + sizeof (scm_t_srcprops
) * (SRCPROPS_CHUNKSIZE
- 1);