annotate src/lisp-union.h @ 450:98528da0b7fc r21-2-40

Import from CVS: tag r21-2-40
author cvs
date Mon, 13 Aug 2007 11:39:20 +0200
parents abe6d1db359e
children af57a77cbc92
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 /* Fundamental definitions for XEmacs Lisp interpreter -- union objects.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 Copyright (C) 1985, 1986, 1987, 1992, 1993, 1994
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 Free Software Foundation, Inc.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 This file is part of XEmacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 XEmacs is free software; you can redistribute it and/or modify it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10 later version.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 for more details.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 along with XEmacs; see the file COPYING. If not, write to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 Boston, MA 02111-1307, USA. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22 /* Divergent from FSF. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 /* Definition of Lisp_Object type as a union.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 The declaration order of the objects within the struct members
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 of the union is dependent on ENDIAN-ness.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 See lisp-disunion.h for more details. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 typedef
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 union Lisp_Object
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 /* if non-valbits are at lower addresses */
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
33 #ifdef WORDS_BIGENDIAN
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 struct
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 EMACS_UINT val : VALBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 enum_field (Lisp_Type) type : GCTYPEBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 } gu;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 struct
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 signed EMACS_INT val : INT_VALBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43 unsigned int bits : INT_GCBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 } s;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 struct
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 EMACS_UINT val : INT_VALBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 unsigned int bits : INT_GCBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 } u;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 #else /* non-valbits are at higher addresses */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 struct
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 enum_field (Lisp_Type) type : GCTYPEBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 EMACS_UINT val : VALBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 } gu;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 struct
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 unsigned int bits : INT_GCBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 signed EMACS_INT val : INT_VALBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 } s;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 struct
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 unsigned int bits : INT_GCBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 EMACS_UINT val : INT_VALBITS;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 } u;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 #endif /* non-valbits are at higher addresses */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 EMACS_UINT ui;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 signed EMACS_INT i;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 /* This was formerly declared 'void *v' etc. but that causes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 GCC to accept any (yes, any) pointer as the argument of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 a function declared to accept a Lisp_Object. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 struct nosuchstruct *v;
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
79 const struct nosuchstruct *cv;
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 }
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 Lisp_Object;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 #define XCHARVAL(x) ((x).gu.val)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 # define XSETINT(var, value) do { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 EMACS_INT xset_value = (value); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 Lisp_Object *xset_var = &(var); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 xset_var->s.bits = 1; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 xset_var->s.val = xset_value; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91 # define XSETCHAR(var, value) do { \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 Emchar xset_value = (value); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 Lisp_Object *xset_var = &(var); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 xset_var->gu.type = Lisp_Type_Char; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 xset_var->gu.val = xset_value; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96 } while (0)
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
97 # define XSETOBJ(var, value) do { \
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 EMACS_UINT xset_value = (EMACS_UINT) (value); \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99 (var).ui = xset_value; \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 } while (0)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 # define XPNTRVAL(x) ((x).ui)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
103 INLINE_HEADER Lisp_Object make_int (EMACS_INT val);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
104 INLINE_HEADER Lisp_Object
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 make_int (EMACS_INT val)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 Lisp_Object obj;
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
108 XSETINT (obj, val);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 return obj;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 }
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
112 INLINE_HEADER Lisp_Object make_char (Emchar val);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
113 INLINE_HEADER Lisp_Object
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 make_char (Emchar val)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 {
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 Lisp_Object obj;
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
117 XSETCHAR (obj, val);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
118 return obj;
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
119 }
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
120
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
121 INLINE_HEADER Lisp_Object wrap_object (void *ptr);
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
122 INLINE_HEADER Lisp_Object
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
123 wrap_object (void *ptr)
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
124 {
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
125 Lisp_Object obj;
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
126 XSETOBJ (obj, ptr);
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127 return obj;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 }
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 extern Lisp_Object Qnull_pointer, Qzero;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 #define XREALINT(x) ((x).s.val)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133 #define XUINT(x) ((x).u.val)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134 #define XTYPE(x) ((x).gu.type)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135 #define EQ(x,y) ((x).v == (y).v)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 #define INTP(x) ((x).s.bits)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 #define INT_PLUS(x,y) make_int (XINT (x) + XINT (y))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 #define INT_MINUS(x,y) make_int (XINT (x) - XINT (y))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 #define INT_PLUS1(x) make_int (XINT (x) + 1)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 #define INT_MINUS1(x) make_int (XINT (x) - 1)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 /* Convert between a (void *) and a Lisp_Object, as when the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 Lisp_Object is passed to a toolkit callback function */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 #define VOID_TO_LISP(larg,varg) \
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 ((void) ((larg).v = (struct nosuchstruct *) (varg)))
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147 #define CVOID_TO_LISP(larg,varg) \
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
148 ((void) ((larg).cv = (const struct nosuchstruct *) (varg)))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149 #define LISP_TO_VOID(larg) ((void *) ((larg).v))
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 428
diff changeset
150 #define LISP_TO_CVOID(larg) ((const void *) ((larg).cv))
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152 /* Convert a Lisp_Object into something that can't be used as an
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 lvalue. Useful for type-checking. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154 #if (__GNUC__ > 1)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 #define NON_LVALUE(larg) ({ (larg); })
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156 #else
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 /* Well, you can't really do it without using a function call, and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 there's no real point in that; no-union-type is the rule, and that
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159 will catch errors. */
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 #define NON_LVALUE(larg) (larg)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161 #endif