|
428
|
1 /* The "lrecord" structure (header of a compound lisp object).
|
|
|
2 Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
|
|
|
3 Copyright (C) 1996 Ben Wing.
|
|
|
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
|
|
440
|
24 #ifndef INCLUDED_lrecord_h_
|
|
|
25 #define INCLUDED_lrecord_h_
|
|
428
|
26
|
|
|
27 /* The "lrecord" type of Lisp object is used for all object types
|
|
|
28 other than a few simple ones. This allows many types to be
|
|
442
|
29 implemented but only a few bits required in a Lisp object for type
|
|
|
30 information. (The tradeoff is that each object has its type marked
|
|
|
31 in it, thereby increasing its size.) All lrecords begin with a
|
|
|
32 `struct lrecord_header', which identifies the lisp object type, by
|
|
|
33 providing an index into a table of `struct lrecord_implementation',
|
|
|
34 which describes the behavior of the lisp object. It also contains
|
|
|
35 some other data bits.
|
|
428
|
36
|
|
|
37 Lrecords are of two types: straight lrecords, and lcrecords.
|
|
|
38 Straight lrecords are used for those types of objects that have
|
|
|
39 their own allocation routines (typically allocated out of 2K chunks
|
|
|
40 of memory called `frob blocks'). These objects have a `struct
|
|
|
41 lrecord_header' at the top, containing only the bits needed to find
|
|
|
42 the lrecord_implementation for the object. There are special
|
|
|
43 routines in alloc.c to deal with each such object type.
|
|
|
44
|
|
442
|
45 Lcrecords are used for less common sorts of objects that don't do
|
|
|
46 their own allocation. Each such object is malloc()ed individually,
|
|
|
47 and the objects are chained together through a `next' pointer.
|
|
|
48 Lcrecords have a `struct lcrecord_header' at the top, which
|
|
|
49 contains a `struct lrecord_header' and a `next' pointer, and are
|
|
|
50 allocated using alloc_lcrecord().
|
|
428
|
51
|
|
|
52 Creating a new lcrecord type is fairly easy; just follow the
|
|
|
53 lead of some existing type (e.g. hash tables). Note that you
|
|
|
54 do not need to supply all the methods (see below); reasonable
|
|
|
55 defaults are provided for many of them. Alternatively, if you're
|
|
|
56 just looking for a way of encapsulating data (which possibly
|
|
|
57 could contain Lisp_Objects in it), you may well be able to use
|
|
|
58 the opaque type. */
|
|
|
59
|
|
|
60 struct lrecord_header
|
|
|
61 {
|
|
|
62 /* index into lrecord_implementations_table[] */
|
|
442
|
63 unsigned int type :8;
|
|
|
64
|
|
|
65 /* If `mark' is 0 after the GC mark phase, the object will be freed
|
|
|
66 during the GC sweep phase. There are 2 ways that `mark' can be 1:
|
|
|
67 - by being referenced from other objects during the GC mark phase
|
|
|
68 - because it is permanently on, for c_readonly objects */
|
|
|
69 unsigned int mark :1;
|
|
|
70
|
|
|
71 /* 1 if the object resides in logically read-only space, and does not
|
|
|
72 reference other non-c_readonly objects.
|
|
|
73 Invariant: if (c_readonly == 1), then (mark == 1 && lisp_readonly == 1) */
|
|
|
74 unsigned int c_readonly :1;
|
|
|
75
|
|
428
|
76 /* 1 if the object is readonly from lisp */
|
|
442
|
77 unsigned int lisp_readonly :1;
|
|
428
|
78 };
|
|
|
79
|
|
|
80 struct lrecord_implementation;
|
|
442
|
81 int lrecord_type_index (const struct lrecord_implementation *implementation);
|
|
428
|
82
|
|
430
|
83 #define set_lheader_implementation(header,imp) do { \
|
|
428
|
84 struct lrecord_header* SLI_header = (header); \
|
|
442
|
85 SLI_header->type = (imp)->lrecord_type_index; \
|
|
430
|
86 SLI_header->mark = 0; \
|
|
|
87 SLI_header->c_readonly = 0; \
|
|
|
88 SLI_header->lisp_readonly = 0; \
|
|
428
|
89 } while (0)
|
|
|
90
|
|
|
91 struct lcrecord_header
|
|
|
92 {
|
|
|
93 struct lrecord_header lheader;
|
|
|
94
|
|
442
|
95 /* The `next' field is normally used to chain all lcrecords together
|
|
428
|
96 so that the GC can find (and free) all of them.
|
|
442
|
97 `alloc_lcrecord' threads lcrecords together.
|
|
428
|
98
|
|
|
99 The `next' field may be used for other purposes as long as some
|
|
|
100 other mechanism is provided for letting the GC do its work.
|
|
|
101
|
|
|
102 For example, the event and marker object types allocate members
|
|
|
103 out of memory chunks, and are able to find all unmarked members
|
|
|
104 by sweeping through the elements of the list of chunks. */
|
|
|
105 struct lcrecord_header *next;
|
|
|
106
|
|
|
107 /* The `uid' field is just for debugging/printing convenience.
|
|
|
108 Having this slot doesn't hurt us much spacewise, since an
|
|
|
109 lcrecord already has the above slots plus malloc overhead. */
|
|
|
110 unsigned int uid :31;
|
|
|
111
|
|
|
112 /* The `free' field is a flag that indicates whether this lcrecord
|
|
|
113 is on a "free list". Free lists are used to minimize the number
|
|
|
114 of calls to malloc() when we're repeatedly allocating and freeing
|
|
|
115 a number of the same sort of lcrecord. Lcrecords on a free list
|
|
|
116 always get marked in a different fashion, so we can use this flag
|
|
|
117 as a sanity check to make sure that free lists only have freed
|
|
|
118 lcrecords and there are no freed lcrecords elsewhere. */
|
|
|
119 unsigned int free :1;
|
|
|
120 };
|
|
|
121
|
|
|
122 /* Used for lcrecords in an lcrecord-list. */
|
|
|
123 struct free_lcrecord_header
|
|
|
124 {
|
|
|
125 struct lcrecord_header lcheader;
|
|
|
126 Lisp_Object chain;
|
|
|
127 };
|
|
|
128
|
|
442
|
129 enum lrecord_type
|
|
|
130 {
|
|
|
131 /* Symbol value magic types come first to make SYMBOL_VALUE_MAGIC_P fast.
|
|
|
132 #### This should be replaced by a symbol_value_magic_p flag
|
|
|
133 in the Lisp_Symbol lrecord_header. */
|
|
|
134 lrecord_type_symbol_value_forward,
|
|
|
135 lrecord_type_symbol_value_varalias,
|
|
|
136 lrecord_type_symbol_value_lisp_magic,
|
|
|
137 lrecord_type_symbol_value_buffer_local,
|
|
|
138 lrecord_type_max_symbol_value_magic = lrecord_type_symbol_value_buffer_local,
|
|
|
139
|
|
|
140 lrecord_type_symbol,
|
|
|
141 lrecord_type_subr,
|
|
|
142 lrecord_type_cons,
|
|
|
143 lrecord_type_vector,
|
|
|
144 lrecord_type_string,
|
|
|
145 lrecord_type_lcrecord_list,
|
|
|
146 lrecord_type_compiled_function,
|
|
|
147 lrecord_type_weak_list,
|
|
|
148 lrecord_type_bit_vector,
|
|
|
149 lrecord_type_float,
|
|
|
150 lrecord_type_hash_table,
|
|
|
151 lrecord_type_lstream,
|
|
|
152 lrecord_type_process,
|
|
|
153 lrecord_type_charset,
|
|
|
154 lrecord_type_coding_system,
|
|
|
155 lrecord_type_char_table,
|
|
|
156 lrecord_type_char_table_entry,
|
|
|
157 lrecord_type_range_table,
|
|
|
158 lrecord_type_opaque,
|
|
|
159 lrecord_type_opaque_ptr,
|
|
|
160 lrecord_type_buffer,
|
|
|
161 lrecord_type_extent,
|
|
|
162 lrecord_type_extent_info,
|
|
|
163 lrecord_type_extent_auxiliary,
|
|
|
164 lrecord_type_marker,
|
|
|
165 lrecord_type_event,
|
|
|
166 lrecord_type_keymap,
|
|
|
167 lrecord_type_command_builder,
|
|
|
168 lrecord_type_timeout,
|
|
|
169 lrecord_type_specifier,
|
|
|
170 lrecord_type_console,
|
|
|
171 lrecord_type_device,
|
|
|
172 lrecord_type_frame,
|
|
|
173 lrecord_type_window,
|
|
|
174 lrecord_type_window_configuration,
|
|
|
175 lrecord_type_gui_item,
|
|
|
176 lrecord_type_popup_data,
|
|
|
177 lrecord_type_toolbar_button,
|
|
|
178 lrecord_type_color_instance,
|
|
|
179 lrecord_type_font_instance,
|
|
|
180 lrecord_type_image_instance,
|
|
|
181 lrecord_type_glyph,
|
|
|
182 lrecord_type_face,
|
|
|
183 lrecord_type_database,
|
|
|
184 lrecord_type_tooltalk_message,
|
|
|
185 lrecord_type_tooltalk_pattern,
|
|
|
186 lrecord_type_ldap,
|
|
|
187 lrecord_type_pgconn,
|
|
|
188 lrecord_type_pgresult,
|
|
|
189 lrecord_type_devmode,
|
|
|
190 lrecord_type_mswindows_dialog_id,
|
|
|
191 lrecord_type_last_built_in_type /* must be last */
|
|
|
192 };
|
|
|
193
|
|
|
194 extern unsigned int lrecord_type_count;
|
|
428
|
195
|
|
|
196 struct lrecord_implementation
|
|
|
197 {
|
|
442
|
198 const char *name;
|
|
|
199
|
|
|
200 /* `marker' is called at GC time, to make sure that all Lisp_Objects
|
|
428
|
201 pointed to by this object get properly marked. It should call
|
|
|
202 the mark_object function on all Lisp_Objects in the object. If
|
|
|
203 the return value is non-nil, it should be a Lisp_Object to be
|
|
|
204 marked (don't call the mark_object function explicitly on it,
|
|
|
205 because the GC routines will do this). Doing it this way reduces
|
|
|
206 recursion, so the object returned should preferably be the one
|
|
|
207 with the deepest level of Lisp_Object pointers. This function
|
|
|
208 can be NULL, meaning no GC marking is necessary. */
|
|
|
209 Lisp_Object (*marker) (Lisp_Object);
|
|
442
|
210
|
|
|
211 /* `printer' converts the object to a printed representation.
|
|
|
212 This can be NULL; in this case default_object_printer() will be
|
|
|
213 used instead. */
|
|
428
|
214 void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag);
|
|
442
|
215
|
|
|
216 /* `finalizer' is called at GC time when the object is about to
|
|
428
|
217 be freed, and at dump time (FOR_DISKSAVE will be non-zero in this
|
|
|
218 case). It should perform any necessary cleanup (e.g. freeing
|
|
442
|
219 malloc()ed memory). This can be NULL, meaning no special
|
|
428
|
220 finalization is necessary.
|
|
|
221
|
|
442
|
222 WARNING: remember that `finalizer' is called at dump time even
|
|
428
|
223 though the object is not being freed. */
|
|
|
224 void (*finalizer) (void *header, int for_disksave);
|
|
442
|
225
|
|
428
|
226 /* This can be NULL, meaning compare objects with EQ(). */
|
|
|
227 int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth);
|
|
442
|
228
|
|
|
229 /* `hash' generates hash values for use with hash tables that have
|
|
|
230 `equal' as their test function. This can be NULL, meaning use
|
|
|
231 the Lisp_Object itself as the hash. But, you must still satisfy
|
|
|
232 the constraint that if two objects are `equal', then they *must*
|
|
|
233 hash to the same value in order for hash tables to work properly.
|
|
|
234 This means that `hash' can be NULL only if the `equal' method is
|
|
|
235 also NULL. */
|
|
428
|
236 unsigned long (*hash) (Lisp_Object, int);
|
|
|
237
|
|
|
238 /* External data layout description */
|
|
|
239 const struct lrecord_description *description;
|
|
|
240
|
|
442
|
241 /* These functions allow any object type to have builtin property
|
|
|
242 lists that can be manipulated from the lisp level with
|
|
|
243 `get', `put', `remprop', and `object-plist'. */
|
|
428
|
244 Lisp_Object (*getprop) (Lisp_Object obj, Lisp_Object prop);
|
|
|
245 int (*putprop) (Lisp_Object obj, Lisp_Object prop, Lisp_Object val);
|
|
|
246 int (*remprop) (Lisp_Object obj, Lisp_Object prop);
|
|
|
247 Lisp_Object (*plist) (Lisp_Object obj);
|
|
|
248
|
|
442
|
249 /* Only one of `static_size' and `size_in_bytes_method' is non-0.
|
|
|
250 If both are 0, this type is not instantiable by alloc_lcrecord(). */
|
|
428
|
251 size_t static_size;
|
|
442
|
252 size_t (*size_in_bytes_method) (const void *header);
|
|
|
253
|
|
|
254 /* The (constant) index into lrecord_implementations_table */
|
|
|
255 enum lrecord_type lrecord_type_index;
|
|
|
256
|
|
428
|
257 /* A "basic" lrecord is any lrecord that's not an lcrecord, i.e.
|
|
|
258 one that does not have an lcrecord_header at the front and which
|
|
|
259 is (usually) allocated in frob blocks. We only use this flag for
|
|
|
260 some consistency checking, and that only when error-checking is
|
|
|
261 enabled. */
|
|
442
|
262 unsigned int basic_p :1;
|
|
428
|
263 };
|
|
|
264
|
|
442
|
265 /* All the built-in lisp object types are enumerated in `enum record_type'.
|
|
|
266 Additional ones may be defined by a module (none yet). We leave some
|
|
|
267 room in `lrecord_implementations_table' for such new lisp object types. */
|
|
|
268 #define MODULE_DEFINABLE_TYPE_COUNT 32
|
|
|
269
|
|
|
270 extern const struct lrecord_implementation *lrecord_implementations_table[(unsigned int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT];
|
|
428
|
271
|
|
|
272 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \
|
|
442
|
273 LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj))
|
|
|
274 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type]
|
|
428
|
275
|
|
|
276 extern int gc_in_progress;
|
|
|
277
|
|
442
|
278 #define MARKED_RECORD_P(obj) (XRECORD_LHEADER (obj)->mark)
|
|
428
|
279 #define MARKED_RECORD_HEADER_P(lheader) ((lheader)->mark)
|
|
|
280 #define MARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 1))
|
|
|
281 #define UNMARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 0))
|
|
|
282
|
|
|
283 #define C_READONLY_RECORD_HEADER_P(lheader) ((lheader)->c_readonly)
|
|
|
284 #define LISP_READONLY_RECORD_HEADER_P(lheader) ((lheader)->lisp_readonly)
|
|
442
|
285 #define SET_C_READONLY_RECORD_HEADER(lheader) do { \
|
|
|
286 struct lrecord_header *SCRRH_lheader = (lheader); \
|
|
|
287 SCRRH_lheader->c_readonly = 1; \
|
|
|
288 SCRRH_lheader->lisp_readonly = 1; \
|
|
|
289 SCRRH_lheader->mark = 1; \
|
|
|
290 } while (0)
|
|
428
|
291 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \
|
|
|
292 ((void) ((lheader)->lisp_readonly = 1))
|
|
442
|
293 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type]
|
|
428
|
294
|
|
|
295 /* External description stuff
|
|
|
296
|
|
|
297 A lrecord external description is an array of values. The first
|
|
|
298 value of each line is a type, the second the offset in the lrecord
|
|
|
299 structure. Following values are parameters, their presence, type
|
|
442
|
300 and number is type-dependent.
|
|
428
|
301
|
|
|
302 The description ends with a "XD_END" or "XD_SPECIFIER_END" record.
|
|
|
303
|
|
|
304 Some example descriptions :
|
|
440
|
305
|
|
428
|
306 static const struct lrecord_description cons_description[] = {
|
|
440
|
307 { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) },
|
|
|
308 { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) },
|
|
428
|
309 { XD_END }
|
|
|
310 };
|
|
|
311
|
|
440
|
312 Which means "two lisp objects starting at the 'car' and 'cdr' elements"
|
|
428
|
313
|
|
|
314 static const struct lrecord_description string_description[] = {
|
|
440
|
315 { XD_BYTECOUNT, offsetof (Lisp_String, size) },
|
|
|
316 { XD_OPAQUE_DATA_PTR, offsetof (Lisp_String, data), XD_INDIRECT(0, 1) },
|
|
|
317 { XD_LISP_OBJECT, offsetof (Lisp_String, plist) },
|
|
428
|
318 { XD_END }
|
|
|
319 };
|
|
|
320 "A pointer to string data at 'data', the size of the pointed array being the value
|
|
|
321 of the size variable plus 1, and one lisp object at 'plist'"
|
|
|
322
|
|
|
323 The existing types :
|
|
|
324 XD_LISP_OBJECT
|
|
440
|
325 A Lisp object. This is also the type to use for pointers to other lrecords.
|
|
428
|
326
|
|
440
|
327 XD_LISP_OBJECT_ARRAY
|
|
|
328 An array of Lisp objects or pointers to lrecords.
|
|
|
329 The third element is the count.
|
|
|
330
|
|
442
|
331 XD_LO_RESET_NIL
|
|
428
|
332 Lisp objects which will be reset to Qnil when dumping. Useful for cleaning
|
|
|
333 up caches.
|
|
|
334
|
|
|
335 XD_LO_LINK
|
|
|
336 Link in a linked list of objects of the same type.
|
|
432
|
337
|
|
428
|
338 XD_OPAQUE_PTR
|
|
|
339 Pointer to undumpable data. Must be NULL when dumping.
|
|
|
340
|
|
|
341 XD_STRUCT_PTR
|
|
|
342 Pointer to described struct. Parameters are number of structures and
|
|
|
343 struct_description.
|
|
|
344
|
|
|
345 XD_OPAQUE_DATA_PTR
|
|
|
346 Pointer to dumpable opaque data. Parameter is the size of the data.
|
|
|
347 Pointed data must be relocatable without changes.
|
|
|
348
|
|
|
349 XD_C_STRING
|
|
|
350 Pointer to a C string.
|
|
|
351
|
|
|
352 XD_DOC_STRING
|
|
|
353 Pointer to a doc string (C string if positive, opaque value if negative)
|
|
|
354
|
|
|
355 XD_INT_RESET
|
|
|
356 An integer which will be reset to a given value in the dump file.
|
|
|
357
|
|
|
358
|
|
|
359 XD_SIZE_T
|
|
|
360 size_t value. Used for counts.
|
|
|
361
|
|
|
362 XD_INT
|
|
|
363 int value. Used for counts.
|
|
|
364
|
|
|
365 XD_LONG
|
|
|
366 long value. Used for counts.
|
|
|
367
|
|
|
368 XD_BYTECOUNT
|
|
|
369 bytecount value. Used for counts.
|
|
|
370
|
|
|
371 XD_END
|
|
|
372 Special type indicating the end of the array.
|
|
|
373
|
|
|
374 XD_SPECIFIER_END
|
|
|
375 Special type indicating the end of the array for a specifier. Extra
|
|
|
376 description is going to be fetched from the specifier methods.
|
|
|
377
|
|
|
378
|
|
|
379 Special macros:
|
|
|
380 XD_INDIRECT(line, delta)
|
|
|
381 Usable where a "count" or "size" is requested. Gives the value of
|
|
|
382 the element which is at line number 'line' in the description (count
|
|
|
383 starts at zero) and adds delta to it.
|
|
|
384 */
|
|
|
385
|
|
|
386 enum lrecord_description_type {
|
|
440
|
387 XD_LISP_OBJECT_ARRAY,
|
|
428
|
388 XD_LISP_OBJECT,
|
|
|
389 XD_LO_RESET_NIL,
|
|
|
390 XD_LO_LINK,
|
|
|
391 XD_OPAQUE_PTR,
|
|
|
392 XD_STRUCT_PTR,
|
|
|
393 XD_OPAQUE_DATA_PTR,
|
|
|
394 XD_C_STRING,
|
|
|
395 XD_DOC_STRING,
|
|
|
396 XD_INT_RESET,
|
|
|
397 XD_SIZE_T,
|
|
|
398 XD_INT,
|
|
|
399 XD_LONG,
|
|
|
400 XD_BYTECOUNT,
|
|
|
401 XD_END,
|
|
|
402 XD_SPECIFIER_END
|
|
|
403 };
|
|
|
404
|
|
|
405 struct lrecord_description {
|
|
|
406 enum lrecord_description_type type;
|
|
|
407 int offset;
|
|
|
408 EMACS_INT data1;
|
|
|
409 const struct struct_description *data2;
|
|
|
410 };
|
|
|
411
|
|
|
412 struct struct_description {
|
|
|
413 size_t size;
|
|
|
414 const struct lrecord_description *description;
|
|
|
415 };
|
|
|
416
|
|
|
417 #define XD_INDIRECT(val, delta) (-1-((val)|(delta<<8)))
|
|
|
418
|
|
|
419 #define XD_IS_INDIRECT(code) (code<0)
|
|
|
420 #define XD_INDIRECT_VAL(code) ((-1-code) & 255)
|
|
|
421 #define XD_INDIRECT_DELTA(code) (((-1-code)>>8) & 255)
|
|
|
422
|
|
|
423 #define XD_DYNARR_DESC(base_type, sub_desc) \
|
|
440
|
424 { XD_STRUCT_PTR, offsetof (base_type, base), XD_INDIRECT(1, 0), sub_desc }, \
|
|
|
425 { XD_INT, offsetof (base_type, cur) }, \
|
|
|
426 { XD_INT_RESET, offsetof (base_type, max), XD_INDIRECT(1, 0) }
|
|
428
|
427
|
|
|
428 /* DEFINE_LRECORD_IMPLEMENTATION is for objects with constant size.
|
|
|
429 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION is for objects whose size varies.
|
|
|
430 */
|
|
|
431
|
|
|
432 #if defined (ERROR_CHECK_TYPECHECK)
|
|
|
433 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
|
|
|
434 #else
|
|
|
435 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
|
|
|
436 #endif
|
|
|
437
|
|
|
438 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
|
|
|
439 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
|
|
|
440
|
|
442
|
441 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
|
|
|
442 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof(structtype),0,1,structtype)
|
|
428
|
443
|
|
|
444 #define DEFINE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
|
|
|
445 DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
|
|
|
446
|
|
442
|
447 #define DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
|
|
|
448 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
|
|
428
|
449
|
|
|
450 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
|
|
|
451 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
|
|
|
452
|
|
442
|
453 #define DEFINE_BASIC_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
|
|
|
454 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,0,sizer,1,structtype)
|
|
428
|
455
|
|
442
|
456 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
|
|
|
457 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype) \
|
|
|
458
|
|
|
459 #define MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
|
|
428
|
460 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype) \
|
|
442
|
461 const struct lrecord_implementation lrecord_##c_name = \
|
|
428
|
462 { name, marker, printer, nuker, equal, hash, desc, \
|
|
442
|
463 getprop, putprop, remprop, plist, size, sizer, \
|
|
|
464 lrecord_type_##c_name, basic_p }
|
|
|
465
|
|
|
466 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
|
|
|
467 DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
|
|
|
468
|
|
|
469 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
|
|
|
470 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
|
|
|
471
|
|
|
472 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
|
|
|
473 DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
|
|
|
474
|
|
|
475 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
|
|
|
476 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype)
|
|
|
477
|
|
|
478 #define MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
|
|
|
479 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype) \
|
|
|
480 unsigned int lrecord_type_##c_name = lrecord_type_count++; \
|
|
|
481 const struct lrecord_implementation lrecord_##c_name = \
|
|
|
482 { name, marker, printer, nuker, equal, hash, desc, \
|
|
|
483 getprop, putprop, remprop, plist, size, sizer, \
|
|
|
484 (enum lrecord_type)lrecord_type_##c_name, basic_p }
|
|
|
485
|
|
|
486
|
|
|
487 extern Lisp_Object (*lrecord_markers[]) (Lisp_Object);
|
|
|
488
|
|
|
489 #define INIT_LRECORD_IMPLEMENTATION(type) do { \
|
|
|
490 lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \
|
|
|
491 lrecord_markers[lrecord_type_##type] = \
|
|
|
492 lrecord_implementations_table[lrecord_type_##type]->marker; \
|
|
|
493 } while (0)
|
|
428
|
494
|
|
|
495 #define LRECORDP(a) (XTYPE (a) == Lisp_Type_Record)
|
|
|
496 #define XRECORD_LHEADER(a) ((struct lrecord_header *) XPNTR (a))
|
|
|
497
|
|
|
498 #define RECORD_TYPEP(x, ty) \
|
|
442
|
499 (LRECORDP (x) && (((unsigned int)(XRECORD_LHEADER (x)->type)) == ((unsigned int)(ty))))
|
|
|
500
|
|
|
501 /* Steps to create a new object:
|
|
|
502
|
|
|
503 1. Declare the struct for your object in a header file somewhere.
|
|
|
504 Remember that it must begin with
|
|
|
505
|
|
|
506 struct lcrecord_header header;
|
|
|
507
|
|
|
508 2. Put a DECLARE_LRECORD() for the object below the struct definition,
|
|
|
509 along with the standard XFOO/XSETFOO junk.
|
|
|
510
|
|
|
511 3. Add this header file to inline.c.
|
|
|
512
|
|
|
513 4. Create the methods for your object. Note that technically you don't
|
|
|
514 need any, but you will almost always want at least a mark method.
|
|
|
515
|
|
|
516 5. Define your object with DEFINE_LRECORD_IMPLEMENTATION() or some
|
|
|
517 variant.
|
|
|
518
|
|
|
519 6. Include the header file in the .c file where you defined the object.
|
|
|
520
|
|
|
521 7. Put a call to INIT_LRECORD_IMPLEMENTATION() for the object in the
|
|
|
522 .c file's syms_of_foo() function.
|
|
|
523
|
|
|
524 8. Add a type enum for the object to enum lrecord_type, earlier in this
|
|
|
525 file.
|
|
|
526
|
|
|
527 An example:
|
|
428
|
528
|
|
442
|
529 ------------------------------ in toolbar.h -----------------------------
|
|
|
530
|
|
|
531 struct toolbar_button
|
|
|
532 {
|
|
|
533 struct lcrecord_header header;
|
|
|
534
|
|
|
535 Lisp_Object next;
|
|
|
536 Lisp_Object frame;
|
|
|
537
|
|
|
538 Lisp_Object up_glyph;
|
|
|
539 Lisp_Object down_glyph;
|
|
|
540 Lisp_Object disabled_glyph;
|
|
|
541
|
|
|
542 Lisp_Object cap_up_glyph;
|
|
|
543 Lisp_Object cap_down_glyph;
|
|
|
544 Lisp_Object cap_disabled_glyph;
|
|
|
545
|
|
|
546 Lisp_Object callback;
|
|
|
547 Lisp_Object enabled_p;
|
|
|
548 Lisp_Object help_string;
|
|
|
549
|
|
|
550 char enabled;
|
|
|
551 char down;
|
|
|
552 char pushright;
|
|
|
553 char blank;
|
|
|
554
|
|
|
555 int x, y;
|
|
|
556 int width, height;
|
|
|
557 int dirty;
|
|
|
558 int vertical;
|
|
|
559 int border_width;
|
|
|
560 };
|
|
428
|
561
|
|
442
|
562 DECLARE_LRECORD (toolbar_button, struct toolbar_button);
|
|
|
563 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button)
|
|
|
564 #define XSETTOOLBAR_BUTTON(x, p) XSETRECORD (x, p, toolbar_button)
|
|
|
565 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button)
|
|
|
566 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button)
|
|
|
567 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button)
|
|
|
568
|
|
|
569 ------------------------------ in toolbar.c -----------------------------
|
|
|
570
|
|
|
571 #include "toolbar.h"
|
|
|
572
|
|
|
573 ...
|
|
|
574
|
|
|
575 static Lisp_Object
|
|
|
576 mark_toolbar_button (Lisp_Object obj)
|
|
|
577 {
|
|
|
578 struct toolbar_button *data = XTOOLBAR_BUTTON (obj);
|
|
|
579 mark_object (data->next);
|
|
|
580 mark_object (data->frame);
|
|
|
581 mark_object (data->up_glyph);
|
|
|
582 mark_object (data->down_glyph);
|
|
|
583 mark_object (data->disabled_glyph);
|
|
|
584 mark_object (data->cap_up_glyph);
|
|
|
585 mark_object (data->cap_down_glyph);
|
|
|
586 mark_object (data->cap_disabled_glyph);
|
|
|
587 mark_object (data->callback);
|
|
|
588 mark_object (data->enabled_p);
|
|
|
589 return data->help_string;
|
|
|
590 }
|
|
|
591
|
|
|
592 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button,
|
|
|
593 mark_toolbar_button, 0, 0, 0, 0, 0,
|
|
|
594 struct toolbar_button);
|
|
|
595
|
|
|
596 ...
|
|
|
597
|
|
|
598 void
|
|
|
599 syms_of_toolbar (void)
|
|
|
600 {
|
|
|
601 INIT_LRECORD_IMPLEMENTATION (toolbar_button);
|
|
|
602
|
|
|
603 ...;
|
|
|
604 }
|
|
|
605
|
|
|
606 ------------------------------ in inline.c -----------------------------
|
|
|
607
|
|
|
608 #ifdef HAVE_TOOLBARS
|
|
|
609 #include "toolbar.h"
|
|
|
610 #endif
|
|
|
611
|
|
|
612 ------------------------------ in lrecord.h -----------------------------
|
|
|
613
|
|
|
614 enum lrecord_type
|
|
|
615 {
|
|
|
616 ...
|
|
|
617 lrecord_type_toolbar_button,
|
|
|
618 ...
|
|
|
619 };
|
|
|
620
|
|
|
621 */
|
|
|
622
|
|
|
623 /*
|
|
|
624
|
|
|
625 Note: Object types defined in external dynamically-loaded modules (not
|
|
|
626 part of the XEmacs main source code) should use DECLARE_EXTERNAL_LRECORD
|
|
|
627 and DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION rather than DECLARE_LRECORD
|
|
|
628 and DEFINE_LRECORD_IMPLEMENTATION.
|
|
|
629
|
|
|
630 */
|
|
|
631
|
|
428
|
632
|
|
|
633 #ifdef ERROR_CHECK_TYPECHECK
|
|
|
634
|
|
|
635 # define DECLARE_LRECORD(c_name, structtype) \
|
|
442
|
636 extern const struct lrecord_implementation lrecord_##c_name; \
|
|
|
637 INLINE_HEADER structtype * \
|
|
|
638 error_check_##c_name (Lisp_Object obj); \
|
|
|
639 INLINE_HEADER structtype * \
|
|
428
|
640 error_check_##c_name (Lisp_Object obj) \
|
|
|
641 { \
|
|
442
|
642 assert (RECORD_TYPEP (obj, lrecord_type_##c_name)); \
|
|
428
|
643 return (structtype *) XPNTR (obj); \
|
|
|
644 } \
|
|
|
645 extern Lisp_Object Q##c_name##p
|
|
|
646
|
|
442
|
647 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype) \
|
|
|
648 extern unsigned int lrecord_type_##c_name; \
|
|
|
649 DECLARE_LRECORD(c_name, structtype)
|
|
|
650
|
|
428
|
651 # define DECLARE_NONRECORD(c_name, type_enum, structtype) \
|
|
442
|
652 INLINE_HEADER structtype * \
|
|
|
653 error_check_##c_name (Lisp_Object obj); \
|
|
|
654 INLINE_HEADER structtype * \
|
|
428
|
655 error_check_##c_name (Lisp_Object obj) \
|
|
|
656 { \
|
|
|
657 assert (XTYPE (obj) == type_enum); \
|
|
|
658 return (structtype *) XPNTR (obj); \
|
|
|
659 } \
|
|
|
660 extern Lisp_Object Q##c_name##p
|
|
|
661
|
|
|
662 # define XRECORD(x, c_name, structtype) error_check_##c_name (x)
|
|
|
663 # define XNONRECORD(x, c_name, type_enum, structtype) error_check_##c_name (x)
|
|
|
664
|
|
|
665 # define XSETRECORD(var, p, c_name) do \
|
|
|
666 { \
|
|
442
|
667 XSETOBJ (var, p); \
|
|
|
668 assert (RECORD_TYPEP (var, lrecord_type_##c_name)); \
|
|
428
|
669 } while (0)
|
|
|
670
|
|
|
671 #else /* not ERROR_CHECK_TYPECHECK */
|
|
|
672
|
|
|
673 # define DECLARE_LRECORD(c_name, structtype) \
|
|
|
674 extern Lisp_Object Q##c_name##p; \
|
|
442
|
675 extern const struct lrecord_implementation lrecord_##c_name
|
|
|
676 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype) \
|
|
|
677 extern Lisp_Object Q##c_name##p; \
|
|
|
678 extern unsigned int lrecord_type_##c_name; \
|
|
|
679 extern const struct lrecord_implementation lrecord_##c_name
|
|
428
|
680 # define DECLARE_NONRECORD(c_name, type_enum, structtype) \
|
|
|
681 extern Lisp_Object Q##c_name##p
|
|
|
682 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x))
|
|
|
683 # define XNONRECORD(x, c_name, type_enum, structtype) \
|
|
|
684 ((structtype *) XPNTR (x))
|
|
442
|
685 # define XSETRECORD(var, p, c_name) XSETOBJ (var, p)
|
|
428
|
686
|
|
|
687 #endif /* not ERROR_CHECK_TYPECHECK */
|
|
|
688
|
|
442
|
689 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name)
|
|
428
|
690
|
|
|
691 /* Note: we now have two different kinds of type-checking macros.
|
|
|
692 The "old" kind has now been renamed CONCHECK_foo. The reason for
|
|
|
693 this is that the CONCHECK_foo macros signal a continuable error,
|
|
|
694 allowing the user (through debug-on-error) to substitute a different
|
|
|
695 value and return from the signal, which causes the lvalue argument
|
|
|
696 to get changed. Quite a lot of code would crash if that happened,
|
|
|
697 because it did things like
|
|
|
698
|
|
|
699 foo = XCAR (list);
|
|
|
700 CHECK_STRING (foo);
|
|
|
701
|
|
|
702 and later on did XSTRING (XCAR (list)), assuming that the type
|
|
|
703 is correct (when it might be wrong, if the user substituted a
|
|
|
704 correct value in the debugger).
|
|
|
705
|
|
|
706 To get around this, I made all the CHECK_foo macros signal a
|
|
|
707 non-continuable error. Places where a continuable error is OK
|
|
|
708 (generally only when called directly on the argument of a Lisp
|
|
|
709 primitive) should be changed to use CONCHECK().
|
|
|
710
|
|
|
711 FSF Emacs does not have this problem because RMS took the cheesy
|
|
|
712 way out and disabled returning from a signal entirely. */
|
|
|
713
|
|
|
714 #define CONCHECK_RECORD(x, c_name) do { \
|
|
442
|
715 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \
|
|
428
|
716 x = wrong_type_argument (Q##c_name##p, x); \
|
|
|
717 } while (0)
|
|
|
718 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\
|
|
|
719 if (XTYPE (x) != lisp_enum) \
|
|
|
720 x = wrong_type_argument (predicate, x); \
|
|
|
721 } while (0)
|
|
|
722 #define CHECK_RECORD(x, c_name) do { \
|
|
442
|
723 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \
|
|
428
|
724 dead_wrong_type_argument (Q##c_name##p, x); \
|
|
|
725 } while (0)
|
|
|
726 #define CHECK_NONRECORD(x, lisp_enum, predicate) do { \
|
|
|
727 if (XTYPE (x) != lisp_enum) \
|
|
|
728 dead_wrong_type_argument (predicate, x); \
|
|
|
729 } while (0)
|
|
|
730
|
|
442
|
731 void *alloc_lcrecord (size_t size, const struct lrecord_implementation *);
|
|
428
|
732
|
|
|
733 #define alloc_lcrecord_type(type, lrecord_implementation) \
|
|
|
734 ((type *) alloc_lcrecord (sizeof (type), lrecord_implementation))
|
|
|
735
|
|
|
736 /* Copy the data from one lcrecord structure into another, but don't
|
|
|
737 overwrite the header information. */
|
|
|
738
|
|
|
739 #define copy_lcrecord(dst, src) \
|
|
430
|
740 memcpy ((char *) (dst) + sizeof (struct lcrecord_header), \
|
|
|
741 (char *) (src) + sizeof (struct lcrecord_header), \
|
|
|
742 sizeof (*(dst)) - sizeof (struct lcrecord_header))
|
|
428
|
743
|
|
|
744 #define zero_lcrecord(lcr) \
|
|
430
|
745 memset ((char *) (lcr) + sizeof (struct lcrecord_header), 0, \
|
|
|
746 sizeof (*(lcr)) - sizeof (struct lcrecord_header))
|
|
428
|
747
|
|
440
|
748 #endif /* INCLUDED_lrecord_h_ */
|
