Updated copyrights
[bpt/guile.git] / libguile / srcprop.h
1 /* classes: h_files */
2
3 #ifndef SRCPROPH
4 #define SRCPROPH
5 /* Copyright (C) 1995,1996, 2000 Free Software Foundation
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2, or (at your option)
10 * any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this software; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307 USA
21 *
22 * As a special exception, the Free Software Foundation gives permission
23 * for additional uses of the text contained in its release of GUILE.
24 *
25 * The exception is that, if you link the GUILE library with other files
26 * to produce an executable, this does not by itself cause the
27 * resulting executable to be covered by the GNU General Public License.
28 * Your use of that executable is in no way restricted on account of
29 * linking the GUILE library code into it.
30 *
31 * This exception does not however invalidate any other reasons why
32 * the executable file might be covered by the GNU General Public License.
33 *
34 * This exception applies only to the code released by the
35 * Free Software Foundation under the name GUILE. If you copy
36 * code from other Free Software Foundation releases into a copy of
37 * GUILE, as the General Public License permits, the exception does
38 * not apply to the code that you add in this way. To avoid misleading
39 * anyone as to the status of such modified files, you must delete
40 * this exception notice from them.
41 *
42 * If you write modifications of your own for GUILE, it is your choice
43 * whether to permit this exception to apply to your modifications.
44 * If you do not wish that, delete this exception notice.
45 *
46 * The author can be reached at djurfeldt@nada.kth.se
47 * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
48
49 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
50 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
51 \f
52
53 #include "libguile/__scm.h"
54
55 \f
56
57 /* {The old whash table interface}
58 * *fixme* This is a temporary solution until weak hash table access
59 * has been optimized for speed (which is quite necessary, if they are
60 * used for recording of source code positions...)
61 */
62
63 #define scm_whash_handle SCM
64
65 #define scm_whash_get_handle(whash, key) scm_hash_fn_get_handle (whash, key, scm_ihashq, scm_sloppy_assq, 0)
66 #define SCM_WHASHFOUNDP(h) (!SCM_FALSEP (h))
67 #define SCM_WHASHREF(whash, handle) SCM_CDR (handle)
68 #define SCM_WHASHSET(whash, handle, obj) SCM_SETCDR (handle, obj)
69 #define scm_whash_create_handle(whash, key) scm_hash_fn_create_handle_x (whash, key, SCM_UNSPECIFIED, scm_ihashq, scm_sloppy_assq, 0)
70 #define scm_whash_lookup(whash, obj) scm_hash_fn_ref (whash, obj, SCM_BOOL_F, scm_ihashq, scm_sloppy_assq, 0)
71 #define scm_whash_insert(whash, key, obj) \
72 do { \
73 register SCM w = (whash); \
74 SCM_WHASHSET (w, scm_whash_create_handle (w, key), obj); \
75 } while (0)
76
77
78 /* {Source properties}
79 */
80
81 extern long scm_tc16_srcprops;
82
83 typedef struct scm_srcprops
84 {
85 unsigned long pos;
86 SCM fname;
87 SCM copy;
88 SCM plist;
89 } scm_srcprops;
90
91 #define SRCPROPS_CHUNKSIZE 2047 /* Number of srcprops per chunk */
92 typedef struct scm_srcprops_chunk
93 {
94 struct scm_srcprops_chunk *next;
95 scm_srcprops srcprops[1];
96 } scm_srcprops_chunk;
97
98 #define SRCPROPSP(p) (SCM_NIMP(p) && (SCM_TYP16 (p) == scm_tc16_srcprops))
99 #define SRCPROPBRK(p) (SCM_BOOL (SCM_CELL_WORD_0 (p) & (1L << 16)))
100 #define SRCPROPPOS(p) ((scm_srcprops *) SCM_CELL_WORD_1 (p))->pos
101 #define SRCPROPLINE(p) (SRCPROPPOS(p) >> 12)
102 #define SRCPROPCOL(p) (SRCPROPPOS(p) & 0x0fffL)
103 #define SRCPROPFNAME(p) ((scm_srcprops *) SCM_CELL_WORD_1 (p))->fname
104 #define SRCPROPCOPY(p) ((scm_srcprops *) SCM_CELL_WORD_1 (p))->copy
105 #define SRCPROPPLIST(p) ((scm_srcprops *) SCM_CELL_WORD_1 (p))->plist
106 #define SETSRCPROPBRK(p) (SCM_SETOR_CAR (p, (1L << 16)))
107 #define CLEARSRCPROPBRK(p) SCM_SETAND_CAR (p, ~(1L << 16))
108 #define SRCPROPMAKPOS(l,c) (((l) << 12) + (c))
109 #define SETSRCPROPPOS(p,l,c) (SRCPROPPOS (p) = SRCPROPMAKPOS (l, c))
110 #define SETSRCPROPLINE(p,l) SETSRCPROPPOS (p, l, SRCPROPCOL (p))
111 #define SETSRCPROPCOL(p,c) SETSRCPROPPOS (p, SRCPROPLINE (p), c)
112
113 #define SRCBRKP(x) (SCM_NIMP (t.arg1 = scm_whash_lookup (scm_source_whash, (x)))\
114 && SRCPROPSP (t.arg1)\
115 && (SCM_CELL_WORD_0 (t.arg1) & (1L << 16)))
116
117 #define PROCTRACEP(x) SCM_NFALSEP (scm_procedure_property (x, scm_sym_trace))
118
119 extern SCM scm_sym_filename;
120 extern SCM scm_sym_copy;
121 extern SCM scm_sym_line;
122 extern SCM scm_sym_column;
123 extern SCM scm_sym_breakpoint;
124
125 \f
126
127
128 extern SCM scm_srcprops_to_plist (SCM obj);
129 extern SCM scm_make_srcprops (int line, int col, SCM fname, SCM copy, SCM plist);
130 extern SCM scm_source_property (SCM obj, SCM key);
131 extern SCM scm_set_source_property_x (SCM obj, SCM key, SCM datum);
132 extern SCM scm_source_properties (SCM obj);
133 extern SCM scm_set_source_properties_x (SCM obj, SCM props);
134 extern void scm_finish_srcprop (void);
135 extern void scm_init_srcprop (void);
136
137 #endif /* SRCPROPH */
138
139 /*
140 Local Variables:
141 c-file-style: "gnu"
142 End:
143 */