|
428
|
1 /* Fundamental definitions for XEmacs Lisp interpreter -- non-union objects.
|
|
|
2 Copyright (C) 1985, 1986, 1987, 1992, 1993 Free Software Foundation, Inc.
|
|
826
|
3 Copyright (C) 2001, 2002 Ben Wing.
|
|
428
|
4
|
|
|
5 This file is part of XEmacs.
|
|
|
6
|
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
8 under the terms of the GNU General Public License as published by the
|
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
|
10 later version.
|
|
|
11
|
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
15 for more details.
|
|
|
16
|
|
|
17 You should have received a copy of the GNU General Public License
|
|
|
18 along with XEmacs; 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 /* Synched up with: FSF 19.30. Split out from lisp.h. */
|
|
|
23 /* This file has diverged greatly from FSF Emacs. Syncing is no
|
|
|
24 longer desirable or possible */
|
|
|
25
|
|
|
26 /*
|
|
|
27 Format of a non-union-type Lisp Object
|
|
|
28
|
|
|
29 3 2 1 0
|
|
|
30 bit 10987654321098765432109876543210
|
|
|
31 --------------------------------
|
|
|
32 VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVTT
|
|
|
33
|
|
|
34 Integers are treated specially, and look like this:
|
|
|
35
|
|
|
36 3 2 1 0
|
|
|
37 bit 10987654321098765432109876543210
|
|
|
38 --------------------------------
|
|
|
39 VVVVVVVVVVVVVVVVVVVVVVVVVVVVVVVT
|
|
|
40
|
|
|
41 For integral Lisp types, i.e. integers and characters, the value
|
|
458
|
42 bits are the Lisp object. Some people call such Lisp_Objects "immediate".
|
|
428
|
43
|
|
458
|
44 The object is obtained by masking off the type bits.
|
|
462
|
45 Bit 1 is used as a value bit by splitting the Lisp integer type
|
|
458
|
46 into two subtypes, Lisp_Type_Int_Even and Lisp_Type_Int_Odd.
|
|
|
47 By this trickery we get 31 bits for integers instead of 30.
|
|
428
|
48
|
|
|
49 For non-integral types, the value bits of a Lisp_Object contain
|
|
|
50 a pointer to a structure containing the object. The pointer is
|
|
|
51 obtained by masking off the type and mark bits.
|
|
|
52
|
|
462
|
53 All pointer-based types are coalesced under a single type called
|
|
458
|
54 Lisp_Type_Record. The type bits for this type are required by the
|
|
|
55 implementation to be 00, just like the least significant bits of
|
|
|
56 word-aligned struct pointers on 32-bit hardware. This requires that
|
|
|
57 all structs implementing Lisp_Objects have an alignment of at least 4
|
|
|
58 bytes. Because of this, Lisp_Object pointers don't have to be masked
|
|
|
59 and are full-sized.
|
|
428
|
60
|
|
458
|
61 There are no mark bits in the Lisp_Object itself (there used to be).
|
|
|
62
|
|
|
63 Integers and characters don't need to be marked. All other types are
|
|
|
64 lrecord-based, which means they get marked by setting the mark bit in
|
|
|
65 the struct lrecord_header.
|
|
428
|
66
|
|
|
67 Here is a brief description of the following macros:
|
|
|
68
|
|
|
69 XTYPE The type bits of a Lisp_Object
|
|
|
70 XPNTRVAL The value bits of a Lisp_Object storing a pointer
|
|
867
|
71 XCHARVAL The value bits of a Lisp_Object storing a Ichar
|
|
428
|
72 XREALINT The value bits of a Lisp_Object storing an integer, signed
|
|
|
73 XUINT The value bits of a Lisp_Object storing an integer, unsigned
|
|
458
|
74 INTP Non-zero if this Lisp_Object is an integer
|
|
428
|
75 Qzero Lisp Integer 0
|
|
458
|
76 EQ Non-zero if two Lisp_Objects are identical, not merely equal. */
|
|
428
|
77
|
|
|
78
|
|
|
79 typedef EMACS_INT Lisp_Object;
|
|
|
80
|
|
|
81 #define Lisp_Type_Int_Bit (Lisp_Type_Int_Even & Lisp_Type_Int_Odd)
|
|
|
82 #define VALMASK (((1UL << VALBITS) - 1UL) << GCTYPEBITS)
|
|
|
83 #define XTYPE(x) ((enum Lisp_Type) (((EMACS_UINT)(x)) & ~VALMASK))
|
|
|
84 #define XPNTRVAL(x) (x) /* This depends on Lisp_Type_Record == 0 */
|
|
|
85 #define XCHARVAL(x) ((x) >> GCBITS)
|
|
|
86 #define XREALINT(x) ((x) >> INT_GCBITS)
|
|
|
87 #define XUINT(x) ((EMACS_UINT)(x) >> INT_GCBITS)
|
|
826
|
88
|
|
|
89 #define wrap_pointer_1(ptr) ((Lisp_Object) (ptr))
|
|
|
90
|
|
|
91 DECLARE_INLINE_HEADER (
|
|
|
92 Lisp_Object
|
|
|
93 make_int_verify (EMACS_INT val)
|
|
|
94 )
|
|
|
95 {
|
|
|
96 Lisp_Object obj = (Lisp_Object) ((val << INT_GCBITS) | Lisp_Type_Int_Bit);
|
|
|
97 type_checking_assert (XREALINT (obj) == val);
|
|
|
98 return obj;
|
|
|
99 }
|
|
|
100
|
|
|
101 #define make_int(x) ((Lisp_Object) (((x) << INT_GCBITS) | Lisp_Type_Int_Bit))
|
|
|
102
|
|
831
|
103 #define make_char_1(x) ((Lisp_Object) (((x) << GCBITS) | Lisp_Type_Char))
|
|
826
|
104
|
|
428
|
105 #define INTP(x) ((EMACS_UINT)(x) & Lisp_Type_Int_Bit)
|
|
|
106 #define INT_PLUS(x,y) ((x)+(y)-Lisp_Type_Int_Bit)
|
|
|
107 #define INT_MINUS(x,y) ((x)-(y)+Lisp_Type_Int_Bit)
|
|
|
108 #define INT_PLUS1(x) INT_PLUS (x, make_int (1))
|
|
|
109 #define INT_MINUS1(x) INT_MINUS (x, make_int (1))
|
|
|
110
|
|
|
111 #define Qzero make_int (0)
|
|
|
112 #define Qnull_pointer ((Lisp_Object) 0)
|
|
|
113 #define EQ(x,y) ((x) == (y))
|
|
|
114
|
|
853
|
115 /* WARNING!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
116
|
|
|
117 You can only VOID_TO_LISP something that had previously been
|
|
|
118 LISP_TO_VOID'd. You cannot go the other way, i.e. create a bogus
|
|
|
119 Lisp_Object. If you want to stuff a void * into a Lisp_Object, use
|
|
|
120 make_opaque_ptr(). */
|
|
|
121
|
|
428
|
122 /* Convert between a (void *) and a Lisp_Object, as when the
|
|
|
123 Lisp_Object is passed to a toolkit callback function */
|
|
826
|
124 #define VOID_TO_LISP(varg) ((Lisp_Object) (varg))
|
|
428
|
125 #define LISP_TO_VOID(larg) ((void *) (larg))
|
|
|
126
|
|
|
127 /* Convert a Lisp_Object into something that can't be used as an
|
|
|
128 lvalue. Useful for type-checking. */
|
|
|
129 #define NON_LVALUE(larg) ((larg) + 0)
|
