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