tags.h 27 KB

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