The FSF has a new address.
[bpt/guile.git] / libguile / tags.h
CommitLineData
0f2d19dd
JB
1/* classes: h_files */
2
22a52da1
DH
3#ifndef SCM_TAGS_H
4#define SCM_TAGS_H
8c494e99 5
5065b40d
DH
6/* Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
7 * Free Software Foundation, Inc.
8ce94504 8 *
73be1d9e
MV
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
8ce94504 13 *
73be1d9e 14 * This library is distributed in the hope that it will be useful,
0f2d19dd 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e
MV
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
8ce94504 18 *
73be1d9e
MV
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
92205699 21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
73be1d9e 22 */
1bbd0b84 23
0f2d19dd
JB
24\f
25
8ce94504 26/** This file defines the format of SCM values and cons pairs.
0f2d19dd
JB
27 ** It is here that tag bits are assigned for various purposes.
28 **/
29
353d4770
RB
30/* picks up scmconfig.h too */
31#include "libguile/__scm.h"
0f2d19dd 32
ee89863b
KR
33#if HAVE_INTTYPES_H
34# include <inttypes.h> /* for INTPTR_MAX and friends */
35#else
36# if HAVE_STDINT_H
37# include <stdint.h> /* for INTPTR_MAX and friends */
38# endif
39#endif
40
7e3b25bf
DH
41\f
42
0f2d19dd 43/* In the beginning was the Word:
7e3b25bf
DH
44 *
45 * For the representation of scheme objects and their handling, Guile provides
46 * two types: scm_t_bits and SCM.
47 *
48 * - scm_t_bits values can hold bit patterns of non-objects and objects:
49 *
50 * Non-objects -- in this case the value may not be changed into a SCM value
51 * in any way.
52 *
53 * Objects -- in this case the value may be changed into a SCM value using
54 * the SCM_PACK macro.
55 *
56 * - SCM values can hold proper scheme objects only. They can be changed into
57 * a scm_t_bits value using the SCM_UNPACK macro.
58 *
59 * When working in the domain of scm_t_bits values, programmers must keep
60 * track of any scm_t_bits value they create that is not a proper scheme
61 * object. This makes sure that in the domain of SCM values developers can
62 * rely on the fact that they are dealing with proper scheme objects only.
63 * Thus, the distinction between scm_t_bits and SCM values helps to identify
64 * those parts of the code where special care has to be taken not to create
65 * bad SCM values.
66 */
67
68/* For dealing with the bit level representation of scheme objects we define
69 * scm_t_bits:
0f2d19dd 70 */
23c96d9b
KR
71/* On Solaris 7 and 8, /usr/include/sys/int_limits.h defines
72 INTPTR_MAX and UINTPTR_MAX to empty, INTPTR_MIN is not defined.
73 To avoid uintptr_t and intptr_t in this case we require
74 UINTPTR_MAX-0 != 0 etc. */
75#if SCM_SIZEOF_INTPTR_T != 0 && defined(INTPTR_MAX) && defined(INTPTR_MIN) \
76 && INTPTR_MAX-0 != 0 && INTPTR_MIN-0 != 0 \
77 && SCM_SIZEOF_UINTPTR_T != 0 && defined(UINTPTR_MAX) && UINTPTR_MAX-0 != 0
78
f59195a1 79typedef intptr_t scm_t_signed_bits;
004c0902
MV
80#define SCM_T_SIGNED_BITS_MAX INTPTR_MAX
81#define SCM_T_SIGNED_BITS_MIN INTPTR_MIN
353d4770
RB
82typedef uintptr_t scm_t_bits;
83#define SIZEOF_SCM_T_BITS SCM_SIZEOF_UINTPTR_T
84#define SCM_T_BITS_MAX UINTPTR_MAX
23c96d9b 85
353d4770 86#else
23c96d9b
KR
87
88typedef signed long scm_t_signed_bits;
89#define SCM_T_SIGNED_BITS_MAX LONG_MAX
90#define SCM_T_SIGNED_BITS_MIN LONG_MIN
353d4770
RB
91typedef unsigned long scm_t_bits;
92#define SIZEOF_SCM_T_BITS SCM_SIZEOF_UNSIGNED_LONG
93#define SCM_T_BITS_MAX ULONG_MAX
23c96d9b 94
353d4770
RB
95#endif
96
7e3b25bf
DH
97/* But as external interface, we define SCM, which may, according to the
98 * desired level of type checking, be defined in several ways:
8d3356e7 99 */
729dbac3 100#if (SCM_DEBUG_TYPING_STRICTNESS == 2)
92c2555f
MV
101 typedef union { struct { scm_t_bits n; } n; } SCM;
102 static SCM scm_pack(scm_t_bits b) { SCM s; s.n.n = b; return s; }
076d6063 103# define SCM_UNPACK(x) ((x).n.n)
92c2555f 104# define SCM_PACK(x) (scm_pack ((scm_t_bits) (x)))
729dbac3 105#elif (SCM_DEBUG_TYPING_STRICTNESS == 1)
8d3356e7
DH
106/* This is the default, which provides an intermediate level of compile time
107 * type checking while still resulting in very efficient code.
c209c88e 108 */
729dbac3 109 typedef struct scm_unused_struct * SCM;
702551e6
HWN
110
111/*
112 The 0?: constructions makes sure that the code is never executed,
113 and that there is no performance hit. However, the alternative is
114 compiled, and does generate a warning when used with the wrong
115 pointer type.
116 */
117# define SCM_UNPACK(x) ((scm_t_bits) (0? (*(SCM*)0=(x)): x))
118
119/*
120 There is no typechecking on SCM_PACK, since all kinds of types
121 (unsigned long, void*) go in SCM_PACK
122 */
076d6063 123# define SCM_PACK(x) ((SCM) (x))
702551e6 124
c209c88e 125#else
8d3356e7
DH
126/* This should be used as a fall back solution for machines on which casting
127 * to a pointer may lead to loss of bit information, e. g. in the three least
128 * significant bits.
129 */
92c2555f 130 typedef scm_t_bits SCM;
076d6063 131# define SCM_UNPACK(x) (x)
702551e6 132# define SCM_PACK(x) ((SCM) (x))
c209c88e 133#endif
0f2d19dd 134
8d3356e7
DH
135
136/* SCM values can not be compared by using the operator ==. Use the following
137 * macro instead, which is the equivalent of the scheme predicate 'eq?'.
138 */
9c293a3d 139#define scm_is_eq(x, y) (SCM_UNPACK (x) == SCM_UNPACK (y))
8d3356e7 140
0f2d19dd 141\f
2549a709 142
7e3b25bf
DH
143/* Representation of scheme objects:
144 *
145 * Guile's type system is designed to work on systems where scm_t_bits and SCM
146 * variables consist of at least 32 bits. The objects that a SCM variable can
147 * represent belong to one of the following two major categories:
148 *
149 * - Immediates -- meaning that the SCM variable contains an entire Scheme
150 * object. That means, all the object's data (including the type tagging
151 * information that is required to identify the object's type) must fit into
152 * 32 bits.
153 *
154 * - Non-immediates -- meaning that the SCM variable holds a pointer into the
155 * heap of cells (see below). On systems where a pointer needs more than 32
156 * bits this means that scm_t_bits and SCM variables need to be large enough
157 * to hold such pointers. In contrast to immediates, the object's data of
158 * a non-immediate can consume arbitrary amounts of memory: The heap cell
159 * being pointed to consists of at least two scm_t_bits variables and thus
160 * can be used to hold pointers to malloc'ed memory of any size.
161 *
162 * The 'heap' is the memory area that is under control of Guile's garbage
163 * collector. It holds 'single-cells' or 'double-cells', which consist of
164 * either two or four scm_t_bits variables, respectively. It is guaranteed
165 * that the address of a cell on the heap is 8-byte aligned. That is, since
166 * non-immediates hold a cell address, the three least significant bits of a
167 * non-immediate can be used to store additional information. The bits are
168 * used to store information about the object's type and thus are called
169 * tc3-bits, where tc stands for type-code.
170 *
171 * For a given SCM value, the distinction whether it holds an immediate or
172 * non-immediate object is based on the tc3-bits (see above) of its scm_t_bits
173 * equivalent: If the tc3-bits equal #b000, then the SCM value holds a
174 * non-immediate, and the scm_t_bits variable's value is just the pointer to
175 * the heap cell.
176 *
177 * Summarized, the data of a scheme object that is represented by a SCM
178 * variable consists of a) the SCM variable itself, b) in case of
179 * non-immediates the data of the single-cell or double-cell the SCM object
180 * points to, c) in case of non-immediates potentially additional data outside
181 * of the heap (like for example malloc'ed data), and d) in case of
182 * non-immediates potentially additional data inside of the heap, since data
183 * stored in b) and c) may hold references to other cells.
184 *
185 *
186 * Immediates
187 *
188 * Operations on immediate objects can typically be processed faster than on
189 * non-immediates. The reason is that the object's data can be extracted
190 * directly from the SCM variable (or rather a corresponding scm_t_bits
191 * variable), instead of having to perform additional memory accesses to
192 * obtain the object's data from the heap. In order to get the best possible
193 * performance frequently used data types should be realized as immediates.
194 * This is, as has been mentioned above, only possible if the objects can be
195 * represented with 32 bits (including type tagging).
196 *
197 * In Guile, the following data types and special objects are realized as
198 * immediates: booleans, characters, small integers (see below), the empty
199 * list, the end of file object, the 'unspecified' object (which is delivered
200 * as a return value by functions for which the return value is unspecified),
201 * a 'nil' object used in the elisp-compatibility mode and certain other
202 * 'special' objects which are only used internally in Guile.
203 *
204 * Integers in Guile can be arbitrarily large. On the other hand, integers
205 * are one of the most frequently used data types. Especially integers with
206 * less than 32 bits are commonly used. Thus, internally and transparently
207 * for application code guile distinguishes between small and large integers.
208 * Whether an integer is a large or a small integer depends on the number of
209 * bits needed to represent its value. Small integers are those which can be
210 * represented as immediates. Since they don't require more than a fixed
211 * number of bits for their representation, they are also known as 'fixnums'.
212 *
213 * The tc3-combinations #b010 and #b110 are used to represent small integers,
214 * which allows to use the most significant bit of the tc3-bits to be part of
215 * the integer value being represented. This means that all integers with up
216 * to 30 bits (including one bit for the sign) can be represented as
217 * immediates. On systems where SCM and scm_t_bits variables hold more than
218 * 32 bits, the amount of bits usable for small integers will even be larger.
219 * The tc3-code #b100 is shared among booleans, characters and the other
220 * special objects listed above.
221 *
222 *
223 * Non-Immediates
224 *
225 * All object types not mentioned above in the list of immedate objects are
226 * represented as non-immediates. Whether a non-immediate scheme object is
227 * represented by a single-cell or a double-cell depends on the object's type,
228 * namely on the set of attributes that have to be stored with objects of that
229 * type. Every non-immediate type is allowed to define its own layout and
230 * interpretation of the data stored in its cell (with some restrictions, see
231 * below).
232 *
233 * One of the design goals of guile's type system is to make it possible to
234 * store a scheme pair with as little memory usage as possible. The minimum
235 * amount of memory that is required to store two scheme objects (car and cdr
236 * of a pair) is the amount of memory required by two scm_t_bits or SCM
237 * variables. Therefore pairs in guile are stored in single-cells.
238 *
239 * Another design goal for the type system is to store procedure objects
240 * created by lambda expresssions (closures) and class instances (goops
241 * objects) with as little memory usage as possible. Closures are represented
242 * by a reference to the function code and a reference to the closure's
243 * environment. Class instances are represented by a reference to the
244 * instance's class definition and a reference to the instance's data. Thus,
245 * closures as well as class instances also can be stored in single-cells.
246 *
247 * Certain other non-immediate types also store their data in single-cells.
248 * By design decision, the heap is split into areas for single-cells and
249 * double-cells, but not into areas for single-cells-holding-pairs and areas
250 * for single-cells-holding-non-pairs. Any single-cell on the heap therefore
251 * can hold pairs (consisting of two scm_t_bits variables representing two
252 * scheme objects - the car and cdr of the pair) and non-pairs (consisting of
253 * two scm_t_bits variables that hold bit patterns as defined by the layout of
254 * the corresponding object's type).
255 *
256 *
257 * Garbage collection
258 *
259 * During garbage collection, unreachable cells on the heap will be freed.
260 * That is, the garbage collector will detect cells which have no SCM variable
261 * pointing towards them. In order to properly release all memory belonging
262 * to the object to which a cell belongs, the gc needs to be able to interpret
263 * the cell contents in the correct way. That means that the gc needs to be
264 * able to determine the object type associated with a cell only from the cell
265 * itself.
266 *
267 * Consequently, if the gc detects an unreachable single-cell, those two
268 * scm_t_bits variables must provide enough information to determine whether
269 * they belong to a pair (i. e. both scm_t_bits variables represent valid
270 * scheme objects), to a closure, a class instance or if they belong to any
271 * other non-immediate. Guile's type system is designed to make it possible
272 * to determine a the type to which a cell belongs in the majority of cases
273 * from the cell's first scm_t_bits variable. (Given a SCM variable X holding
274 * a non-immediate object, the macro SCM_CELL_TYPE(X) will deliver the
275 * corresponding cell's first scm_t_bits variable.)
276 *
277 * If the cell holds a scheme pair, then we already know that the first
278 * scm_t_bits variable of the cell will hold a scheme object with one of the
279 * following tc3-codes: #b000 (non-immediate), #b010 (small integer), #b100
280 * (small integer), #b110 (non-integer immediate). All these tc3-codes have
281 * in common, that their least significant bit is #b0. This fact is used by
282 * the garbage collector to identify cells that hold pairs. The remaining
283 * tc3-codes are assigned as follows: #b001 (class instance or, more
284 * precisely, a struct, of which a class instance is a special case), #b011
285 * (closure), #b101/#b111 (all remaining non-immediate types).
286 *
287 *
288 * Summary of type codes of scheme objects (SCM variables)
289 *
290 * Here is a summary of tagging bits as they might occur in a scheme object.
291 * The notation is as follows: tc stands for type code as before, tc<n> with n
292 * being a number indicates a type code formed by the n least significant bits
293 * of the SCM variables corresponding scm_t_bits value.
294 *
295 * Note that (as has been explained above) tc1==1 can only occur in the first
296 * scm_t_bits variable of a cell belonging to a non-immediate object that is
297 * not a pair. For an explanation of the tc tags with tc1==1, see the next
298 * section with the summary of the type codes on the heap.
299 *
300 * tc1:
301 * 0: For scheme objects, tc1==0 must be fulfilled.
302 * (1: This can never be the case for a scheme object.)
303 *
304 * tc2:
305 * 00: Either a non-immediate or some non-integer immediate
306 * (01: This can never be the case for a scheme object.)
307 * 10: Small integer
308 * (11: This can never be the case for a scheme object.)
309 *
310 * tc3:
311 * 000: a non-immediate object (pair, closure, class instance etc.)
312 * (001: This can never be the case for a scheme object.)
313 * 010: an even small integer (least significant bit is 0).
314 * (011: This can never be the case for a scheme object.)
315 * 100: Non-integer immediate
316 * (101: This can never be the case for a scheme object.)
317 * 110: an odd small integer (least significant bit is 1).
318 * (111: This can never be the case for a scheme object.)
319 *
320 * The remaining bits of the non-immediate objects form the pointer to the
321 * heap cell. The remaining bits of the small integers form the integer's
322 * value and sign. Thus, the only scheme objects for which a further
323 * subdivision is of interest are the ones with tc3==100.
324 *
5065b40d
DH
325 * tc8 (for objects with tc3==100):
326 * 00000-100: special objects ('flags')
327 * 00001-100: characters
36245b66
DH
328 * 00010-100: evaluator byte codes ('isyms')
329 * 00011-100: evaluator byte codes ('ilocs')
7e3b25bf
DH
330 *
331 *
332 * Summary of type codes on the heap
333 *
334 * Here is a summary of tagging in scm_t_bits values as they might occur in
335 * the first scm_t_bits variable of a heap cell.
336 *
337 * tc1:
338 * 0: the cell belongs to a pair.
339 * 1: the cell belongs to a non-pair.
340 *
341 * tc2:
342 * 00: the cell belongs to a pair with no short integer in its car.
343 * 01: the cell belongs to a non-pair (struct or some other non-immediate).
344 * 10: the cell belongs to a pair with a short integer in its car.
345 * 11: the cell belongs to a non-pair (closure or some other non-immediate).
346 *
347 * tc3:
348 * 000: the cell belongs to a pair with a non-immediate in its car.
349 * 001: the cell belongs to a struct
350 * 010: the cell belongs to a pair with an even short integer in its car.
351 * 011: the cell belongs to a closure
352 * 100: the cell belongs to a pair with a non-integer immediate in its car.
353 * 101: the cell belongs to some other non-immediate.
354 * 110: the cell belongs to a pair with an odd short integer in its car.
355 * 111: the cell belongs to some other non-immediate.
356 *
357 * tc7 (for tc3==1x1):
358 * See below for the list of types. Note the special case of scm_tc7_vector
359 * and scm_tc7_wvect: vectors and weak vectors are treated the same in many
360 * cases. Thus, their tc7-codes are chosen to only differ in one bit. This
361 * makes it possible to check an object at the same time for being a vector
362 * or a weak vector by comparing its tc7 code with that bit masked (using
534c55a9
DH
363 * the TYP7S macro). Three more special tc7-codes are of interest:
364 * numbers, ports and smobs in fact each represent collections of types,
365 * which are subdivided using tc16-codes.
7e3b25bf
DH
366 *
367 * tc16 (for tc7==scm_tc7_smob):
368 * The largest part of the space of smob types is not subdivided in a
369 * predefined way, since smobs can be added arbitrarily by user C code.
370 * However, while Guile also defines a number of smob types throughout,
534c55a9
DH
371 * there is one smob type, namely scm_tc_free_cell, for which Guile assumes
372 * that it is declared first and thus gets a known-in-advance tc16-code.
373 * The reason of requiring a fixed tc16-code for this type is performance.
7e3b25bf 374 */
0f2d19dd 375
7e3b25bf
DH
376\f
377
378/* Checking if a SCM variable holds an immediate or a non-immediate object:
379 * This check can either be performed by checking for tc3==000 or tc3==00x,
380 * since for a SCM variable it is known that tc1==0. */
f1267706 381#define SCM_IMP(x) (6 & SCM_UNPACK (x))
76189127 382#define SCM_NIMP(x) (!SCM_IMP (x))
0f2d19dd 383
7e3b25bf
DH
384/* Checking if a SCM variable holds an immediate integer: See numbers.h for
385 * the definition of the following macros: SCM_I_FIXNUM_BIT,
e11e83f3 386 * SCM_MOST_POSITIVE_FIXNUM, SCM_I_INUMP, SCM_I_MAKINUM, SCM_I_INUM. */
0f2d19dd 387
7e3b25bf
DH
388/* Checking if a SCM variable holds a pair (for historical reasons, in Guile
389 * also known as a cons-cell): This is done by first checking that the SCM
390 * variable holds a non-immediate, and second, by checking that tc1==0 holds
6fcc7d48
MV
391 * for the SCM_CELL_TYPE of the SCM variable.
392*/
393
394#define SCM_I_CONSP(x) (!SCM_IMP (x) && ((1 & SCM_CELL_TYPE (x)) == 0))
0f2d19dd 395
0f2d19dd
JB
396\f
397
7e3b25bf 398/* Definitions for tc2: */
0f2d19dd 399
6375e040
DH
400#define scm_tc2_int 2
401
7e3b25bf
DH
402
403/* Definitions for tc3: */
404
904a077d
MV
405#define SCM_ITAG3(x) (7 & SCM_UNPACK (x))
406#define SCM_TYP3(x) (7 & SCM_CELL_TYPE (x))
7e3b25bf 407
904a077d
MV
408#define scm_tc3_cons 0
409#define scm_tc3_struct 1
6375e040 410#define scm_tc3_int_1 (scm_tc2_int + 0)
c209c88e
GB
411#define scm_tc3_closure 3
412#define scm_tc3_imm24 4
413#define scm_tc3_tc7_1 5
6375e040 414#define scm_tc3_int_2 (scm_tc2_int + 4)
c209c88e 415#define scm_tc3_tc7_2 7
0f2d19dd
JB
416
417
7e3b25bf 418/* Definitions for tc7: */
0f2d19dd 419
d1ca2c64 420#define SCM_ITAG7(x) (127 & SCM_UNPACK (x))
445f675c
DH
421#define SCM_TYP7(x) (0x7f & SCM_CELL_TYPE (x))
422#define SCM_TYP7S(x) ((0x7f & ~2) & SCM_CELL_TYPE (x))
0f2d19dd 423
28b06554 424#define scm_tc7_symbol 5
e5aca4b5 425#define scm_tc7_variable 7
0f2d19dd
JB
426
427/* couple */
428#define scm_tc7_vector 13
429#define scm_tc7_wvect 15
430
0f2d19dd 431#define scm_tc7_string 21
534c55a9 432#define scm_tc7_number 23
fddf6000 433#define scm_tc7_stringbuf 39
0f2d19dd
JB
434
435/* Many of the following should be turned
436 * into structs or smobs. We need back some
7e3b25bf
DH
437 * of these 7 bit tags! */
438
37581b11 439#define scm_tc7_pws 31
afe5177e 440
067f0922
MV
441#define scm_tc7_unused_1 29
442#define scm_tc7_unused_2 37
443#define scm_tc7_unused_3 45
444#define scm_tc7_unused_4 47
445#define scm_tc7_unused_5 53
446#define scm_tc7_unused_6 55
6cf0f51d
MV
447#define scm_tc7_unused_7 71
448#define scm_tc7_unused_8 77
449#define scm_tc7_unused_9 79
afe5177e 450
14b18ed6 451#define scm_tc7_dsubr 61
afe5177e
GH
452#define scm_tc7_cclo 63
453#define scm_tc7_rpsubr 69
0f2d19dd
JB
454#define scm_tc7_subr_0 85
455#define scm_tc7_subr_1 87
456#define scm_tc7_cxr 93
457#define scm_tc7_subr_3 95
458#define scm_tc7_subr_2 101
459#define scm_tc7_asubr 103
460#define scm_tc7_subr_1o 109
461#define scm_tc7_subr_2o 111
462#define scm_tc7_lsubr_2 117
463#define scm_tc7_lsubr 119
464
7e3b25bf 465/* There are 256 port subtypes. */
0f2d19dd
JB
466#define scm_tc7_port 125
467
6375e040
DH
468/* There are 256 smob subtypes. [**] If you change scm_tc7_smob, you must
469 * also change the places it is hard coded in this file and possibly others.
470 * Dirk:FIXME:: Any hard coded reference to scm_tc7_smob must be replaced by a
7e3b25bf 471 * symbolic reference. */
0f2d19dd
JB
472#define scm_tc7_smob 127 /* DO NOT CHANGE [**] */
473
0f2d19dd 474
7e3b25bf
DH
475/* Definitions for tc16: */
476#define SCM_TYP16(x) (0xffff & SCM_CELL_TYPE (x))
7e3b25bf
DH
477#define SCM_TYP16_PREDICATE(tag, x) (!SCM_IMP (x) && SCM_TYP16 (x) == (tag))
478
f03314f9 479
534c55a9 480/* Here is the first smob subtype. */
0f2d19dd 481
6375e040 482/* scm_tc_free_cell is the 0th smob type. We place this in free cells to tell
7e3b25bf 483 * the conservative marker not to trace it. */
8c921d5c 484#define scm_tc_free_cell (scm_tc7_smob + 0 * 256L)
0f2d19dd 485
0f2d19dd 486\f
5065b40d 487
8ce94504 488/* {Immediate Values}
0f2d19dd
JB
489 */
490
5065b40d 491enum scm_tc8_tags
0f2d19dd 492{
5065b40d
DH
493 scm_tc8_flag = scm_tc3_imm24 + 0x00, /* special objects ('flags') */
494 scm_tc8_char = scm_tc3_imm24 + 0x08, /* characters */
495 scm_tc8_isym = scm_tc3_imm24 + 0x10, /* evaluator byte codes ('isyms') */
496 scm_tc8_iloc = scm_tc3_imm24 + 0x18 /* evaluator byte codes ('ilocs') */
0f2d19dd
JB
497};
498
f1267706
MD
499#define SCM_ITAG8(X) (SCM_UNPACK (X) & 0xff)
500#define SCM_MAKE_ITAG8(X, TAG) SCM_PACK (((X) << 8) + TAG)
501#define SCM_ITAG8_DATA(X) (SCM_UNPACK (X) >> 8)
0f2d19dd 502
0f2d19dd 503\f
0f2d19dd 504
5065b40d
DH
505/* Flags (special objects). The indices of the flags must agree with the
506 * declarations in print.c: iflagnames. */
507
508#define SCM_IFLAGP(n) (SCM_ITAG8 (n) == scm_tc8_flag)
509#define SCM_MAKIFLAG(n) SCM_MAKE_ITAG8 ((n), scm_tc8_flag)
510#define SCM_IFLAGNUM(n) (SCM_ITAG8_DATA (n))
e17d318f
DH
511
512#define SCM_BOOL_F SCM_MAKIFLAG (0)
513#define SCM_BOOL_T SCM_MAKIFLAG (1)
514#define SCM_UNDEFINED SCM_MAKIFLAG (2)
515#define SCM_EOF_VAL SCM_MAKIFLAG (3)
516#define SCM_EOL SCM_MAKIFLAG (4)
517#define SCM_UNSPECIFIED SCM_MAKIFLAG (5)
518
519/* When a variable is unbound this is marked by the SCM_UNDEFINED
520 * value. The following is an unbound value which can be handled on
521 * the Scheme level, i.e., it can be stored in and retrieved from a
522 * Scheme variable. This value is only intended to mark an unbound
523 * slot in GOOPS. It is needed now, but we should probably rewrite
524 * the code which handles this value in C so that SCM_UNDEFINED can be
525 * used instead. It is not ideal to let this kind of unique and
526 * strange values loose on the Scheme level. */
527#define SCM_UNBOUND SCM_MAKIFLAG (6)
528
529/* The Elisp nil value. */
530#define SCM_ELISP_NIL SCM_MAKIFLAG (7)
531
532
68fb32d2 533#define SCM_UNBNDP(x) (scm_is_eq ((x), SCM_UNDEFINED))
e17d318f 534
5065b40d 535\f
e17d318f 536
5065b40d
DH
537/* Evaluator byte codes ('immediate symbols'). These constants are used only
538 * in eval but their values have to be allocated here. The indices of the
539 * SCM_IM_ symbols must agree with the declarations in print.c:
540 * scm_isymnames. */
0f2d19dd 541
5065b40d
DH
542#define SCM_ISYMP(n) (SCM_ITAG8 (n) == scm_tc8_isym)
543#define SCM_MAKISYM(n) SCM_MAKE_ITAG8 ((n), scm_tc8_isym)
0f2d19dd 544
5065b40d
DH
545#define SCM_IM_AND SCM_MAKISYM (0)
546#define SCM_IM_BEGIN SCM_MAKISYM (1)
547#define SCM_IM_CASE SCM_MAKISYM (2)
548#define SCM_IM_COND SCM_MAKISYM (3)
549#define SCM_IM_DO SCM_MAKISYM (4)
550#define SCM_IM_IF SCM_MAKISYM (5)
551#define SCM_IM_LAMBDA SCM_MAKISYM (6)
552#define SCM_IM_LET SCM_MAKISYM (7)
553#define SCM_IM_LETSTAR SCM_MAKISYM (8)
554#define SCM_IM_LETREC SCM_MAKISYM (9)
555#define SCM_IM_OR SCM_MAKISYM (10)
556#define SCM_IM_QUOTE SCM_MAKISYM (11)
557#define SCM_IM_SET_X SCM_MAKISYM (12)
22f2cf2d 558#define SCM_IM_DEFINE SCM_MAKISYM (13)
76189127
MD
559#define SCM_IM_APPLY SCM_MAKISYM (14)
560#define SCM_IM_CONT SCM_MAKISYM (15)
e17d318f
DH
561#define SCM_IM_DISPATCH SCM_MAKISYM (16)
562#define SCM_IM_SLOT_REF SCM_MAKISYM (17)
563#define SCM_IM_SLOT_SET_X SCM_MAKISYM (18)
564#define SCM_IM_DELAY SCM_MAKISYM (19)
565#define SCM_IM_FUTURE SCM_MAKISYM (20)
566#define SCM_IM_CALL_WITH_VALUES SCM_MAKISYM (21)
2a6f7afe
DH
567#define SCM_IM_ELSE SCM_MAKISYM (22)
568#define SCM_IM_ARROW SCM_MAKISYM (23)
5065b40d
DH
569#define SCM_IM_NIL_COND SCM_MAKISYM (24) /* Multi-language support */
570#define SCM_IM_BIND SCM_MAKISYM (25) /* Multi-language support */
c96d76b8 571
0f2d19dd
JB
572\f
573
904a077d 574/* Dispatching aids:
0f2d19dd 575
904a077d
MV
576 When switching on SCM_TYP7 of a SCM value, use these fake case
577 labels to catch types that use fewer than 7 bits for tagging. */
0f2d19dd 578
8ce94504 579/* For cons pairs with immediate values in the CAR
0f2d19dd
JB
580 */
581
6375e040
DH
582#define scm_tcs_cons_imcar \
583 scm_tc2_int + 0: case scm_tc2_int + 4: case scm_tc3_imm24 + 0:\
584 case scm_tc2_int + 8: case scm_tc2_int + 12: case scm_tc3_imm24 + 8:\
585 case scm_tc2_int + 16: case scm_tc2_int + 20: case scm_tc3_imm24 + 16:\
586 case scm_tc2_int + 24: case scm_tc2_int + 28: case scm_tc3_imm24 + 24:\
587 case scm_tc2_int + 32: case scm_tc2_int + 36: case scm_tc3_imm24 + 32:\
588 case scm_tc2_int + 40: case scm_tc2_int + 44: case scm_tc3_imm24 + 40:\
589 case scm_tc2_int + 48: case scm_tc2_int + 52: case scm_tc3_imm24 + 48:\
590 case scm_tc2_int + 56: case scm_tc2_int + 60: case scm_tc3_imm24 + 56:\
591 case scm_tc2_int + 64: case scm_tc2_int + 68: case scm_tc3_imm24 + 64:\
592 case scm_tc2_int + 72: case scm_tc2_int + 76: case scm_tc3_imm24 + 72:\
593 case scm_tc2_int + 80: case scm_tc2_int + 84: case scm_tc3_imm24 + 80:\
594 case scm_tc2_int + 88: case scm_tc2_int + 92: case scm_tc3_imm24 + 88:\
595 case scm_tc2_int + 96: case scm_tc2_int + 100: case scm_tc3_imm24 + 96:\
596 case scm_tc2_int + 104: case scm_tc2_int + 108: case scm_tc3_imm24 + 104:\
597 case scm_tc2_int + 112: case scm_tc2_int + 116: case scm_tc3_imm24 + 112:\
598 case scm_tc2_int + 120: case scm_tc2_int + 124: case scm_tc3_imm24 + 120
0f2d19dd
JB
599
600/* For cons pairs with non-immediate values in the SCM_CAR
601 */
6375e040
DH
602#define scm_tcs_cons_nimcar \
603 scm_tc3_cons + 0:\
604 case scm_tc3_cons + 8:\
605 case scm_tc3_cons + 16:\
606 case scm_tc3_cons + 24:\
607 case scm_tc3_cons + 32:\
608 case scm_tc3_cons + 40:\
609 case scm_tc3_cons + 48:\
610 case scm_tc3_cons + 56:\
611 case scm_tc3_cons + 64:\
612 case scm_tc3_cons + 72:\
613 case scm_tc3_cons + 80:\
614 case scm_tc3_cons + 88:\
615 case scm_tc3_cons + 96:\
616 case scm_tc3_cons + 104:\
617 case scm_tc3_cons + 112:\
618 case scm_tc3_cons + 120
0f2d19dd 619
904a077d 620/* For structs
0f2d19dd 621 */
6375e040
DH
622#define scm_tcs_struct \
623 scm_tc3_struct + 0:\
624 case scm_tc3_struct + 8:\
625 case scm_tc3_struct + 16:\
626 case scm_tc3_struct + 24:\
627 case scm_tc3_struct + 32:\
628 case scm_tc3_struct + 40:\
629 case scm_tc3_struct + 48:\
630 case scm_tc3_struct + 56:\
631 case scm_tc3_struct + 64:\
632 case scm_tc3_struct + 72:\
633 case scm_tc3_struct + 80:\
634 case scm_tc3_struct + 88:\
635 case scm_tc3_struct + 96:\
636 case scm_tc3_struct + 104:\
637 case scm_tc3_struct + 112:\
638 case scm_tc3_struct + 120
0f2d19dd 639
904a077d
MV
640/* For closures
641 */
6375e040
DH
642#define scm_tcs_closures \
643 scm_tc3_closure + 0:\
644 case scm_tc3_closure + 8:\
645 case scm_tc3_closure + 16:\
646 case scm_tc3_closure + 24:\
647 case scm_tc3_closure + 32:\
648 case scm_tc3_closure + 40:\
649 case scm_tc3_closure + 48:\
650 case scm_tc3_closure + 56:\
651 case scm_tc3_closure + 64:\
652 case scm_tc3_closure + 72:\
653 case scm_tc3_closure + 80:\
654 case scm_tc3_closure + 88:\
655 case scm_tc3_closure + 96:\
656 case scm_tc3_closure + 104:\
657 case scm_tc3_closure + 112:\
658 case scm_tc3_closure + 120
0f2d19dd 659
904a077d
MV
660/* For subrs
661 */
14b18ed6
DH
662#define scm_tcs_subrs \
663 scm_tc7_asubr:\
664 case scm_tc7_subr_0:\
665 case scm_tc7_subr_1:\
666 case scm_tc7_dsubr:\
667 case scm_tc7_cxr:\
668 case scm_tc7_subr_3:\
669 case scm_tc7_subr_2:\
670 case scm_tc7_rpsubr:\
671 case scm_tc7_subr_1o:\
672 case scm_tc7_subr_2o:\
673 case scm_tc7_lsubr_2:\
674 case scm_tc7_lsubr
0f2d19dd 675
f5f2dcff
DH
676\f
677
8c494e99 678#if (SCM_ENABLE_DEPRECATED == 1)
22a52da1 679
228a24ef 680#define SCM_CELLP(x) (((sizeof (scm_t_cell) - 1) & SCM_UNPACK (x)) == 0)
8c494e99 681#define SCM_NCELLP(x) (!SCM_CELLP (x))
28b06554 682
8c494e99 683#endif
f5f2dcff 684
22a52da1 685#endif /* SCM_TAGS_H */
89e00824
ML
686
687/*
688 Local Variables:
689 c-file-style: "gnu"
690 End:
691*/