gdb/scm-tags.h

   1 /* This is a minimally edited version of Guile's tags.h. */
   2 /* classes: h_files */
   3
   4 #ifndef TAGSH
   5 #define TAGSH
   6 /*      Copyright (C) 1995, 1999, 2008, 2009, 2010
   7 Free Software Foundation, Inc.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  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 \f
  46
  47 /** This file defines the format of SCM values and cons pairs.
  48  ** It is here that tag bits are assigned for various purposes.
  49  **/
  50 \f
  51
  52 /* Three Bit Tags
  53
  54  * 000 -- a non-immediate value.  Points into the pair heap.
  55  *
  56  * 001 -- a gloc (i.e., a resolved global variable in a CAR in a code graph)
  57  *        or the CAR of an object handle (i.e., the tagged pointer to the
  58  *        vtable part of a user-defined object).
  59  *
  60  *        If X has this tag, the value at CDAR(X - 1) distinguishes
  61  *        glocs from object handles.  The distinction only needs
  62  *        to be made in a few places.  Only a few parts of the code know
  63  *        about glocs.  In most cases, when a value in the CAR of a pair
  64  *        has the tag 001, it means that the pair is an object handle.
  65  *
  66  * 010 -- the tag for immediate, exact integers.
  67  *
  68  * 011 -- in the CAR of a pair, this tag indicates that the pair is a closure.
  69  *        The remaining bits of the CAR are a pointer into the pair heap
  70  *        to the code graph for the closure.
  71  *
  72  * 1xy -- an extension tag which means that there is a five or six bit
  73  *        tag to the left of the low three bits.  See the nice diagrams
  74  *        in ../doc/code.doc if you want to know what the bits mean.
  75  */
  76 \f
  77
  78
  79
  80
  81 #define scm_tc3_cons            0
  82 #define scm_tc3_cons_gloc       1
  83 #define scm_tc3_closure         3
  84
  85 #define scm_tc7_ssymbol         5
  86 #define scm_tc7_msymbol         7
  87 #define scm_tc7_string          13
  88 #define scm_tc7_bvect           15
  89 #define scm_tc7_vector          21
  90 #define scm_tc7_lvector         23
  91 #define scm_tc7_ivect           29
  92 #define scm_tc7_uvect           31
  93 /* spare 37 39 */
  94 #define scm_tc7_fvect           45
  95 #define scm_tc7_dvect           47
  96 #define scm_tc7_cvect           53
  97 #define scm_tc7_port            55
  98 #define scm_tc7_contin          61
  99 #define scm_tc7_cclo            63
 100 /* spare 69 71 77 79 */
 101 #define scm_tc7_subr_0          85
 102 #define scm_tc7_subr_1          87
 103 #define scm_tc7_cxr             93
 104 #define scm_tc7_subr_3          95
 105 #define scm_tc7_subr_2          101
 106 #define scm_tc7_asubr           103
 107 #define scm_tc7_subr_1o         109
 108 #define scm_tc7_subr_2o         111
 109 #define scm_tc7_lsubr_2         117
 110 #define scm_tc7_lsubr           119
 111 #define scm_tc7_rpsubr          125
 112
 113 #define scm_tc7_smob            127
 114 #define scm_tc_free_cell        127
 115
 116 #define scm_tc16_flo            0x017f
 117 #define scm_tc_flo              0x017fL
 118
 119 #define SCM_REAL_PART           (1L<<16)
 120 #define SCM_IMAG_PART           (2L<<16)
 121 #define scm_tc_dblr             (scm_tc16_flo|REAL_PART)
 122 #define scm_tc_dblc             (scm_tc16_flo|REAL_PART|IMAG_PART)
 123
 124 #define scm_tc16_bigpos         0x027f
 125 #define scm_tc16_bigneg         0x037f
 126
 127 #define scm_tc16_fport          (scm_tc7_port + 0*256L)
 128 #define scm_tc16_pipe           (scm_tc7_port + 1*256L)
 129 #define scm_tc16_strport        (scm_tc7_port + 2*256L)
 130 #define scm_tc16_sfport         (scm_tc7_port + 3*256L)
 131
 132
 133
 134 /* For cons pairs with immediate values in the CAR */
 135 #define scm_tcs_cons_imcar 2:case 4:case 6:case 10:\
 136  case 12:case 14:case 18:case 20:\
 137  case 22:case 26:case 28:case 30:\
 138  case 34:case 36:case 38:case 42:\
 139  case 44:case 46:case 50:case 52:\
 140  case 54:case 58:case 60:case 62:\
 141  case 66:case 68:case 70:case 74:\
 142  case 76:case 78:case 82:case 84:\
 143  case 86:case 90:case 92:case 94:\
 144  case 98:case 100:case 102:case 106:\
 145  case 108:case 110:case 114:case 116:\
 146  case 118:case 122:case 124:case 126
 147
 148 /* For cons pairs with non-immediate values in the CAR */
 149 #define scm_tcs_cons_nimcar 0:case 8:case 16:case 24:\
 150  case 32:case 40:case 48:case 56:\
 151  case 64:case 72:case 80:case 88:\
 152  case 96:case 104:case 112:case 120
 153
 154 /* A CONS_GLOC occurs in code.  It's CAR is a pointer to the
 155  * CDR of a variable.  The low order bits of the CAR are 001.
 156  * The CDR of the gloc is the code continuation.
 157  */
 158 #define scm_tcs_cons_gloc 1:case 9:case 17:case 25:\
 159  case 33:case 41:case 49:case 57:\
 160  case 65:case 73:case 81:case 89:\
 161  case 97:case 105:case 113:case 121
 162
 163 #define scm_tcs_closures   3:case 11:case 19:case 27:\
 164  case 35:case 43:case 51:case 59:\
 165  case 67:case 75:case 83:case 91:\
 166  case 99:case 107:case 115:case 123
 167
 168 #define scm_tcs_subrs scm_tc7_asubr:case scm_tc7_subr_0:case scm_tc7_subr_1:case scm_tc7_cxr:\
 169  case scm_tc7_subr_3:case scm_tc7_subr_2:case scm_tc7_rpsubr:case scm_tc7_subr_1o:\
 170  case scm_tc7_subr_2o:case scm_tc7_lsubr_2:case scm_tc7_lsubr
 171
 172 #define scm_tcs_symbols scm_tc7_ssymbol:case scm_tc7_msymbol
 173
 174 #define scm_tcs_bignums tc16_bigpos:case tc16_bigneg
 175 \f
 176
 177
 178 /* References to objects are of type SCM.  Values may be non-immediate
 179  * (pointers) or immediate (encoded, immutable, scalar values that fit
 180  * in an SCM variable).
 181  */
 182
 183 typedef long SCM;
 184
 185 /* Cray machines have pointers that are incremented once for each word,
 186  * rather than each byte, the 3 most significant bits encode the byte
 187  * within the word.  The following macros deal with this by storing the
 188  * native Cray pointers like the ones that looks like scm expects.  This
 189  * is done for any pointers that might appear in the car of a scm_cell, pointers
 190  * to scm_vector elts, functions, &c are not munged.
 191  */
 192 #ifdef _UNICOS
 193 #define SCM2PTR(x) ((int)(x) >> 3)
 194 #define PTR2SCM(x) (((SCM)(x)) << 3)
 195 #define SCM_POINTERS_MUNGED
 196 #else
 197 #define SCM2PTR(x) (x)
 198 #define PTR2SCM(x) ((SCM)(x))
 199 #endif /* def _UNICOS */
 200 \f
 201
 202
 203 /* Immediate? Predicates
 204  */
 205 #define SCM_IMP(x)      (6 & (int)(x))
 206 #define SCM_NIMP(x)     (!SCM_IMP(x))
 207 \f
 208
 209
 210 enum scm_tags
 211   {
 212     scm_tc8_char = 0xf4
 213   };
 214
 215 #define SCM_ITAG8(X)            ((int)(X) & 0xff)
 216 #define SCM_MAKE_ITAG8(X, TAG)  (((X)<<8) + TAG)
 217 #define SCM_ITAG8_DATA(X)       ((X)>>8)
 218 \f
 219
 220
 221 /* Local Environment Structure
 222  */
 223 #define SCM_ILOCP(n)            ((0xff & (int)(n))==0xfc)
 224 #define SCM_ILOC00              (0x000000fcL)
 225 #define SCM_IDINC               (0x00100000L)
 226 #define SCM_ICDR                (0x00080000L)
 227 #define SCM_IFRINC              (0x00000100L)
 228 #define SCM_IDSTMSK             (-SCM_IDINC)
 229 #define SCM_IFRAME(n)           ((int)((SCM_ICDR-SCM_IFRINC)>>8) & ((int)(n)>>8))
 230 #define SCM_IDIST(n)            (((unsigned long)(n))>>20)
 231 #define SCM_ICDRP(n)            (SCM_ICDR & (n))
 232 \f
 233
 234 /* Immediate Symbols, Special Symbols, Flags (various constants).
 235  */
 236
 237 /* ISYMP tests for ISPCSYM and ISYM */
 238 #define SCM_ISYMP(n)            ((0x187 & (int)(n))==4)
 239
 240 /* IFLAGP tests for ISPCSYM, ISYM and IFLAG */
 241 #define SCM_IFLAGP(n)           ((0x87 & (int)(n))==4)
 242 #define SCM_ISYMNUM(n)          ((int)((n)>>9))
 243 #define SCM_ISYMCHARS(n)        (scm_isymnames[SCM_ISYMNUM(n)])
 244 #define SCM_MAKSPCSYM(n)        (((n)<<9)+((n)<<3)+4L)
 245 #define SCM_MAKISYM(n)          (((n)<<9)+0x74L)
 246 #define SCM_MAKIFLAG(n)         (((n)<<9)+0x174L)
 247
 248 /* This table must agree with the declarations
 249  * in repl.c: {Names of immediate symbols}.
 250  *
 251  * These are used only in eval but their values
 252  * have to be allocated here.
 253  *
 254  */
 255
 256 #define SCM_IM_AND              SCM_MAKSPCSYM(0)
 257 #define SCM_IM_BEGIN            SCM_MAKSPCSYM(1)
 258 #define SCM_IM_CASE             SCM_MAKSPCSYM(2)
 259 #define SCM_IM_COND             SCM_MAKSPCSYM(3)
 260 #define SCM_IM_DO               SCM_MAKSPCSYM(4)
 261 #define SCM_IM_IF               SCM_MAKSPCSYM(5)
 262 #define SCM_IM_LAMBDA           SCM_MAKSPCSYM(6)
 263 #define SCM_IM_LET              SCM_MAKSPCSYM(7)
 264 #define SCM_IM_LETSTAR          SCM_MAKSPCSYM(8)
 265 #define SCM_IM_LETREC           SCM_MAKSPCSYM(9)
 266 #define SCM_IM_OR               SCM_MAKSPCSYM(10)
 267 #define SCM_IM_QUOTE            SCM_MAKSPCSYM(11)
 268 #define SCM_IM_SET              SCM_MAKSPCSYM(12)
 269 #define SCM_IM_DEFINE           SCM_MAKSPCSYM(13)
 270 #define SCM_IM_APPLY            SCM_MAKISYM(14)
 271 #define SCM_IM_CONT             SCM_MAKISYM(15)
 272 #define SCM_NUM_ISYMS 16
 273
 274 /* Important immediates
 275  */
 276
 277 #define SCM_BOOL_F              SCM_MAKIFLAG(SCM_NUM_ISYMS+0)
 278 #define SCM_BOOL_T              SCM_MAKIFLAG(SCM_NUM_ISYMS+1)
 279 #define SCM_UNDEFINED           SCM_MAKIFLAG(SCM_NUM_ISYMS+2)
 280 #define SCM_EOF_VAL             SCM_MAKIFLAG(SCM_NUM_ISYMS+3)
 281
 282 #ifdef SICP
 283 #define SCM_EOL                 SCM_BOOL_F
 284 #else
 285 #define SCM_EOL                 SCM_MAKIFLAG(SCM_NUM_ISYMS+4)
 286 #endif
 287
 288 #define SCM_UNSPECIFIED         SCM_MAKIFLAG(SCM_NUM_ISYMS+5)
 289 \f
 290
 291
 292 /* Heap Pairs and the Empty List Predicates
 293  */
 294 #define SCM_NULLP(x)    (SCM_EOL == (x))
 295 #define SCM_NNULLP(x)   (SCM_EOL != (x))
 296 #define SCM_CELLP(x)    (!SCM_NCELLP(x))
 297 #define SCM_NCELLP(x)   ((sizeof(scm_cell)-1) & (int)(x))
 298 \f
 299
 300
 301 #define SCM_UNBNDP(x)   (SCM_UNDEFINED==(x))
 302 \f
 303
 304
 305 /* Testing and Changing GC Marks in Various Standard Positions
 306  */
 307 #define SCM_GCMARKP(x)          (1 & (int)SCM_CDR(x))
 308 #define SCM_GC8MARKP(x)         (0x80 & (int)SCM_CAR(x))
 309 #define SCM_SETGCMARK(x)        (SCM_CDR(x) |= 1)
 310 #define SCM_CLRGCMARK(x)        (SCM_CDR(x) &= ~1L)
 311 #define SCM_SETGC8MARK(x)       (SCM_CAR(x) |= 0x80)
 312 #define SCM_CLRGC8MARK(x)       (SCM_CAR(x) &= ~0x80L)
 313 \f
 314
 315 /* Extracting Tag Bits, With or Without GC Safety and Optional Bits
 316  */
 317 #define SCM_TYP3(x)             (7 & (int)SCM_CAR(x))
 318 #define SCM_TYP7(x)             (0x7f & (int)SCM_CAR(x))
 319 #define SCM_TYP7S(x)            (0x7d & (int)SCM_CAR(x))
 320 #define SCM_TYP16(x)            (0xffff & (int)SCM_CAR(x))
 321 #define SCM_TYP16S(x)           (0xfeff & (int)SCM_CAR(x))
 322 #define SCM_GCTYP16(x)          (0xff7f & (int)SCM_CAR(x))
 323 \f
 324
 325 /* Two slightly extensible types: smobs and ptobs.
 326
 327  */
 328 #define SCM_SMOBNUM(x) (0x0ff & (CAR(x)>>8));
 329 #define SCM_PTOBNUM(x) (0x0ff & (CAR(x)>>8));
 330 \f
 331
 332
 333
 334 #define SCM_DIRP(x) (SCM_NIMP(x) && (TYP16(x)==(scm_tc16_dir)))
 335 #define SCM_OPDIRP(x) (SCM_NIMP(x) && (CAR(x)==(scm_tc16_dir | OPN)))
 336 \f
 337
 338
 339 /* Lvectors
 340  */
 341 #define SCM_LVECTORP(x) (TYP7(x)==tc7_lvector)
 342 \f
 343
 344 #if 0
 345 \f
 346 /* Sockets
 347  */
 348 #define tc_socket (tc7_port | OPN)
 349 #define SCM_SOCKP(x) (((0x7f | OPN | RDNG | WRTNG) & CAR(x))==(tc_socket))
 350 #define SCM_SOCKTYP(x) (CAR(x)>>24)
 351 \f
 352
 353
 354 extern int scm_tc16_key_vector;
 355 #define SCM_KEYVECP(X)   (scm_tc16_key_vector == TYP16 (X))
 356 #define SCM_KEYVECLEN(OBJ) (((unsigned long)CAR (obj)) >> 16)
 357 \f
 358
 359 #define SCM_MALLOCDATA(obj) ((char *)CDR(obj))
 360 #define SCM_MALLOCLEN(obj) (((unsigned long)CAR (obj)) >> 16)
 361 #define SCM_WORDDATA(obj)  (CDR (obj))
 362
 363
 364 #define SCM_BYTECODEP(X) ((TYP7 (X) == tc7_cclo) && (CCLO_SUBR (X) == rb_proc))
 365 #define SCM_BYTECODE_CONSTANTS(X) (VELTS(X)[1])
 366 #define SCM_BYTECODE_CODE(X) (VELTS(X)[2])
 367 #define SCM_BYTECODE_NAME(X) (VELTS(X)[3])
 368 #define SCM_BYTECODE_BCODE(X) (VELTS(X)[4])
 369 #define SCM_BYTECODE_ELTS 5
 370 \f
 371
 372 #define SCM_FREEP(x) (CAR(x)==tc_free_cell)
 373 #define SCM_NFREEP(x) (!FREEP(x))
 374 \f
 375 #endif /* 0 */
 376 \f
 377
 378 #endif /* TAGSH */