|
428
|
1 /* Opaque Lisp objects.
|
|
|
2 Copyright (C) 1993, 1994, 1995 Sun Microsystems, Inc.
|
|
800
|
3 Copyright (C) 1995, 1996, 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: Not in FSF. */
|
|
|
23
|
|
|
24 /* Written by Ben Wing, October 1993. */
|
|
|
25
|
|
|
26 /* "Opaque" is used internally to hold keep track of allocated memory
|
|
|
27 so it gets GC'd properly, and to store arbitrary data in places
|
|
|
28 where a Lisp_Object is required and which may get GC'd. (e.g. as
|
|
|
29 the argument to record_unwind_protect()). Once created in C,
|
|
|
30 opaque objects cannot be resized.
|
|
|
31
|
|
|
32 OPAQUE OBJECTS SHOULD NEVER ESCAPE TO THE LISP LEVEL. Some code
|
|
|
33 depends on this. As such, opaque objects are a generalization
|
|
|
34 of the Qunbound marker.
|
|
|
35 */
|
|
|
36
|
|
|
37 #include <config.h>
|
|
|
38 #include "lisp.h"
|
|
|
39 #include "opaque.h"
|
|
|
40
|
|
2720
|
41 #ifndef MC_ALLOC
|
|
428
|
42 Lisp_Object Vopaque_ptr_free_list;
|
|
2720
|
43 #endif /* not MC_ALLOC */
|
|
428
|
44
|
|
|
45 /* Should never, ever be called. (except by an external debugger) */
|
|
|
46 static void
|
|
2286
|
47 print_opaque (Lisp_Object obj, Lisp_Object printcharfun,
|
|
|
48 int UNUSED (escapeflag))
|
|
428
|
49 {
|
|
442
|
50 const Lisp_Opaque *p = XOPAQUE (obj);
|
|
428
|
51
|
|
800
|
52 write_fmt_string
|
|
|
53 (printcharfun,
|
|
|
54 "#<INTERNAL OBJECT (XEmacs bug?) (opaque, size=%lu) 0x%lx>",
|
|
|
55 (long)(p->size), (unsigned long) p);
|
|
428
|
56 }
|
|
|
57
|
|
665
|
58 inline static Bytecount
|
|
|
59 aligned_sizeof_opaque (Bytecount opaque_size)
|
|
456
|
60 {
|
|
826
|
61 return MAX_ALIGN_SIZE (offsetof (Lisp_Opaque, data) + opaque_size);
|
|
456
|
62 }
|
|
|
63
|
|
665
|
64 static Bytecount
|
|
442
|
65 sizeof_opaque (const void *header)
|
|
428
|
66 {
|
|
456
|
67 return aligned_sizeof_opaque (((const Lisp_Opaque *) header)->size);
|
|
428
|
68 }
|
|
|
69
|
|
|
70 /* Return an opaque object of size SIZE.
|
|
|
71 If DATA is OPAQUE_CLEAR, the object's data is memset to '\0' bytes.
|
|
|
72 If DATA is OPAQUE_UNINIT, the object's data is uninitialized.
|
|
|
73 Else the object's data is initialized by copying from DATA. */
|
|
|
74 Lisp_Object
|
|
665
|
75 make_opaque (const void *data, Bytecount size)
|
|
428
|
76 {
|
|
|
77 Lisp_Opaque *p = (Lisp_Opaque *)
|
|
2720
|
78 #ifdef MC_ALLOC
|
|
|
79 alloc_lrecord (aligned_sizeof_opaque (size), &lrecord_opaque);
|
|
|
80 #else /* not MC_ALLOC */
|
|
1204
|
81 basic_alloc_lcrecord (aligned_sizeof_opaque (size), &lrecord_opaque);
|
|
2720
|
82 #endif /* not MC_ALLOC */
|
|
428
|
83 p->size = size;
|
|
|
84
|
|
|
85 if (data == OPAQUE_CLEAR)
|
|
|
86 memset (p->data, '\0', size);
|
|
|
87 else if (data == OPAQUE_UNINIT)
|
|
|
88 DO_NOTHING;
|
|
|
89 else
|
|
|
90 memcpy (p->data, data, size);
|
|
|
91
|
|
|
92 {
|
|
793
|
93 return wrap_opaque (p);
|
|
428
|
94 }
|
|
|
95 }
|
|
|
96
|
|
|
97 /* This will not work correctly for opaques with subobjects! */
|
|
|
98
|
|
|
99 static int
|
|
2286
|
100 equal_opaque (Lisp_Object obj1, Lisp_Object obj2, int UNUSED (depth))
|
|
428
|
101 {
|
|
665
|
102 Bytecount size;
|
|
428
|
103 return ((size = XOPAQUE_SIZE (obj1)) == XOPAQUE_SIZE (obj2) &&
|
|
|
104 !memcmp (XOPAQUE_DATA (obj1), XOPAQUE_DATA (obj2), size));
|
|
|
105 }
|
|
|
106
|
|
|
107 /* This will not work correctly for opaques with subobjects! */
|
|
|
108
|
|
2515
|
109 static Hashcode
|
|
2286
|
110 hash_opaque (Lisp_Object obj, int UNUSED (depth))
|
|
428
|
111 {
|
|
|
112 if (XOPAQUE_SIZE (obj) == sizeof (unsigned long))
|
|
2515
|
113 return *((Hashcode *) XOPAQUE_DATA (obj));
|
|
428
|
114 else
|
|
|
115 return memory_hash (XOPAQUE_DATA (obj), XOPAQUE_SIZE (obj));
|
|
|
116 }
|
|
|
117
|
|
1204
|
118 static const struct memory_description opaque_description[] = {
|
|
428
|
119 { XD_END }
|
|
|
120 };
|
|
|
121
|
|
934
|
122 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION ("opaque", opaque,
|
|
|
123 1, /*dumpable-flag*/
|
|
|
124 0, print_opaque, 0,
|
|
|
125 equal_opaque, hash_opaque,
|
|
|
126 opaque_description,
|
|
|
127 sizeof_opaque, Lisp_Opaque);
|
|
428
|
128
|
|
|
129 /* stuff to handle opaque pointers */
|
|
|
130
|
|
|
131 /* Should never, ever be called. (except by an external debugger) */
|
|
|
132 static void
|
|
2286
|
133 print_opaque_ptr (Lisp_Object obj, Lisp_Object printcharfun,
|
|
|
134 int UNUSED (escapeflag))
|
|
428
|
135 {
|
|
442
|
136 const Lisp_Opaque_Ptr *p = XOPAQUE_PTR (obj);
|
|
428
|
137
|
|
800
|
138 write_fmt_string
|
|
|
139 (printcharfun,
|
|
|
140 "#<INTERNAL OBJECT (XEmacs bug?) (opaque-ptr, adr=0x%lx) 0x%lx>",
|
|
|
141 (long)(p->ptr), (unsigned long) p);
|
|
428
|
142 }
|
|
|
143
|
|
|
144 static int
|
|
2286
|
145 equal_opaque_ptr (Lisp_Object obj1, Lisp_Object obj2, int UNUSED (depth))
|
|
428
|
146 {
|
|
|
147 return (XOPAQUE_PTR (obj1)->ptr == XOPAQUE_PTR (obj2)->ptr);
|
|
|
148 }
|
|
|
149
|
|
2515
|
150 static Hashcode
|
|
2286
|
151 hash_opaque_ptr (Lisp_Object obj, int UNUSED (depth))
|
|
428
|
152 {
|
|
2515
|
153 return (Hashcode) XOPAQUE_PTR (obj)->ptr;
|
|
428
|
154 }
|
|
|
155
|
|
1575
|
156 static const struct memory_description opaque_ptr_description[] = {
|
|
|
157 { XD_END }
|
|
|
158 };
|
|
|
159
|
|
934
|
160 DEFINE_LRECORD_IMPLEMENTATION ("opaque-ptr", opaque_ptr,
|
|
|
161 0, /*dumpable-flag*/
|
|
|
162 0, print_opaque_ptr, 0,
|
|
1204
|
163 equal_opaque_ptr, hash_opaque_ptr,
|
|
1575
|
164 opaque_ptr_description, Lisp_Opaque_Ptr);
|
|
428
|
165
|
|
|
166 Lisp_Object
|
|
|
167 make_opaque_ptr (void *val)
|
|
|
168 {
|
|
2720
|
169 #ifdef MC_ALLOC
|
|
|
170 Lisp_Object res =
|
|
|
171 wrap_pointer_1 (alloc_lrecord_type (Lisp_Opaque_Ptr,
|
|
|
172 &lrecord_opaque_ptr));
|
|
|
173 #else /* not MC_ALLOC */
|
|
1204
|
174 Lisp_Object res = alloc_managed_lcrecord (Vopaque_ptr_free_list);
|
|
2720
|
175 #endif /* not MC_ALLOC */
|
|
428
|
176 set_opaque_ptr (res, val);
|
|
|
177 return res;
|
|
|
178 }
|
|
|
179
|
|
|
180 /* Be very very careful with this. Same admonitions as with
|
|
|
181 free_cons() apply. */
|
|
|
182
|
|
|
183 void
|
|
|
184 free_opaque_ptr (Lisp_Object ptr)
|
|
|
185 {
|
|
2720
|
186 #ifdef MC_ALLOC
|
|
|
187 free_lrecord (ptr);
|
|
|
188 #else /* not MC_ALLOC */
|
|
428
|
189 free_managed_lcrecord (Vopaque_ptr_free_list, ptr);
|
|
2720
|
190 #endif /* not MC_ALLOC */
|
|
428
|
191 }
|
|
|
192
|
|
2720
|
193 #ifndef MC_ALLOC
|
|
428
|
194 void
|
|
1204
|
195 reinit_opaque_early (void)
|
|
428
|
196 {
|
|
647
|
197 Vopaque_ptr_free_list = make_lcrecord_list (sizeof (Lisp_Opaque_Ptr),
|
|
|
198 &lrecord_opaque_ptr);
|
|
428
|
199 staticpro_nodump (&Vopaque_ptr_free_list);
|
|
|
200 }
|
|
2720
|
201 #endif /* not MC_ALLOC */
|
|
428
|
202
|
|
|
203 void
|
|
|
204 init_opaque_once_early (void)
|
|
|
205 {
|
|
442
|
206 INIT_LRECORD_IMPLEMENTATION (opaque);
|
|
|
207 INIT_LRECORD_IMPLEMENTATION (opaque_ptr);
|
|
|
208
|
|
2720
|
209 #ifndef MC_ALLOC
|
|
1204
|
210 reinit_opaque_early ();
|
|
2720
|
211 #endif /* not MC_ALLOC */
|
|
428
|
212 }
|
