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.
5 This file is part of XEmacs.
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
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
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. */
22 /* Synched up with: Not in FSF. */
24 #ifndef INCLUDED_lrecord_h_
25 #define INCLUDED_lrecord_h_
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
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
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.
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().
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
62 /* index into lrecord_implementations_table[] */
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 */
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;
76 /* 1 if the object is readonly from lisp */
77 unsigned int lisp_readonly :1;
80 /* The `older field is a flag that indicates whether this lcrecord
81 is on a "older storage". */
82 unsigned int older :1;
86 struct lrecord_implementation;
87 int lrecord_type_index (const struct lrecord_implementation *implementation);
90 #define set_lheader_implementation(header,imp) do { \
91 struct lrecord_header* SLI_header = (header); \
92 SLI_header->type = (imp)->lrecord_type_index; \
93 SLI_header->mark = 0; \
94 SLI_header->older = 0; \
95 SLI_header->c_readonly = 0; \
96 SLI_header->lisp_readonly = 0; \
98 #define set_lheader_older_implementation(header,imp) do { \
99 struct lrecord_header* SLI_header = (header); \
100 SLI_header->type = (imp)->lrecord_type_index; \
101 SLI_header->mark = 0; \
102 SLI_header->older = 1; \
103 SLI_header->c_readonly = 0; \
104 SLI_header->lisp_readonly = 0; \
107 #define set_lheader_implementation(header,imp) do { \
108 struct lrecord_header* SLI_header = (header); \
109 SLI_header->type = (imp)->lrecord_type_index; \
110 SLI_header->mark = 0; \
111 SLI_header->c_readonly = 0; \
112 SLI_header->lisp_readonly = 0; \
116 struct lcrecord_header
118 struct lrecord_header lheader;
120 /* The `next' field is normally used to chain all lcrecords together
121 so that the GC can find (and free) all of them.
122 `alloc_lcrecord' threads lcrecords together.
124 The `next' field may be used for other purposes as long as some
125 other mechanism is provided for letting the GC do its work.
127 For example, the event and marker object types allocate members
128 out of memory chunks, and are able to find all unmarked members
129 by sweeping through the elements of the list of chunks. */
130 struct lcrecord_header *next;
132 /* The `uid' field is just for debugging/printing convenience.
133 Having this slot doesn't hurt us much spacewise, since an
134 lcrecord already has the above slots plus malloc overhead. */
135 unsigned int uid :31;
137 /* The `free' field is a flag that indicates whether this lcrecord
138 is on a "free list". Free lists are used to minimize the number
139 of calls to malloc() when we're repeatedly allocating and freeing
140 a number of the same sort of lcrecord. Lcrecords on a free list
141 always get marked in a different fashion, so we can use this flag
142 as a sanity check to make sure that free lists only have freed
143 lcrecords and there are no freed lcrecords elsewhere. */
144 unsigned int free :1;
147 /* Used for lcrecords in an lcrecord-list. */
148 struct free_lcrecord_header
150 struct lcrecord_header lcheader;
156 /* Symbol value magic types come first to make SYMBOL_VALUE_MAGIC_P fast.
157 #### This should be replaced by a symbol_value_magic_p flag
158 in the Lisp_Symbol lrecord_header. */
159 lrecord_type_symbol_value_forward,
160 lrecord_type_symbol_value_varalias,
161 lrecord_type_symbol_value_lisp_magic,
162 lrecord_type_symbol_value_buffer_local,
163 lrecord_type_max_symbol_value_magic = lrecord_type_symbol_value_buffer_local,
170 lrecord_type_lcrecord_list,
171 lrecord_type_compiled_function,
172 lrecord_type_weak_list,
173 lrecord_type_bit_vector,
175 lrecord_type_hash_table,
176 lrecord_type_lstream,
177 lrecord_type_process,
178 lrecord_type_charset,
179 lrecord_type_coding_system,
180 lrecord_type_char_table,
181 lrecord_type_char_table_entry,
182 lrecord_type_char_id_table,
183 lrecord_type_byte_table,
184 lrecord_type_uint16_byte_table,
185 lrecord_type_uint8_byte_table,
186 lrecord_type_range_table,
188 lrecord_type_opaque_ptr,
191 lrecord_type_extent_info,
192 lrecord_type_extent_auxiliary,
196 lrecord_type_command_builder,
197 lrecord_type_timeout,
198 lrecord_type_specifier,
199 lrecord_type_console,
203 lrecord_type_window_configuration,
204 lrecord_type_gui_item,
205 lrecord_type_popup_data,
206 lrecord_type_toolbar_button,
207 lrecord_type_color_instance,
208 lrecord_type_font_instance,
209 lrecord_type_image_instance,
212 lrecord_type_database,
213 lrecord_type_tooltalk_message,
214 lrecord_type_tooltalk_pattern,
217 lrecord_type_pgresult,
218 lrecord_type_devmode,
219 lrecord_type_mswindows_dialog_id,
220 lrecord_type_last_built_in_type /* must be last */
223 extern unsigned int lrecord_type_count;
225 struct lrecord_implementation
229 /* `marker' is called at GC time, to make sure that all Lisp_Objects
230 pointed to by this object get properly marked. It should call
231 the mark_object function on all Lisp_Objects in the object. If
232 the return value is non-nil, it should be a Lisp_Object to be
233 marked (don't call the mark_object function explicitly on it,
234 because the GC routines will do this). Doing it this way reduces
235 recursion, so the object returned should preferably be the one
236 with the deepest level of Lisp_Object pointers. This function
237 can be NULL, meaning no GC marking is necessary. */
238 Lisp_Object (*marker) (Lisp_Object);
240 /* `printer' converts the object to a printed representation.
241 This can be NULL; in this case default_object_printer() will be
243 void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag);
245 /* `finalizer' is called at GC time when the object is about to
246 be freed, and at dump time (FOR_DISKSAVE will be non-zero in this
247 case). It should perform any necessary cleanup (e.g. freeing
248 malloc()ed memory). This can be NULL, meaning no special
249 finalization is necessary.
251 WARNING: remember that `finalizer' is called at dump time even
252 though the object is not being freed. */
253 void (*finalizer) (void *header, int for_disksave);
255 /* This can be NULL, meaning compare objects with EQ(). */
256 int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth);
258 /* `hash' generates hash values for use with hash tables that have
259 `equal' as their test function. This can be NULL, meaning use
260 the Lisp_Object itself as the hash. But, you must still satisfy
261 the constraint that if two objects are `equal', then they *must*
262 hash to the same value in order for hash tables to work properly.
263 This means that `hash' can be NULL only if the `equal' method is
265 unsigned long (*hash) (Lisp_Object, int);
267 /* External data layout description */
268 const struct lrecord_description *description;
270 /* These functions allow any object type to have builtin property
271 lists that can be manipulated from the lisp level with
272 `get', `put', `remprop', and `object-plist'. */
273 Lisp_Object (*getprop) (Lisp_Object obj, Lisp_Object prop);
274 int (*putprop) (Lisp_Object obj, Lisp_Object prop, Lisp_Object val);
275 int (*remprop) (Lisp_Object obj, Lisp_Object prop);
276 Lisp_Object (*plist) (Lisp_Object obj);
278 /* Only one of `static_size' and `size_in_bytes_method' is non-0.
279 If both are 0, this type is not instantiable by alloc_lcrecord(). */
281 size_t (*size_in_bytes_method) (const void *header);
283 /* The (constant) index into lrecord_implementations_table */
284 enum lrecord_type lrecord_type_index;
286 /* A "basic" lrecord is any lrecord that's not an lcrecord, i.e.
287 one that does not have an lcrecord_header at the front and which
288 is (usually) allocated in frob blocks. We only use this flag for
289 some consistency checking, and that only when error-checking is
291 unsigned int basic_p :1;
294 /* All the built-in lisp object types are enumerated in `enum record_type'.
295 Additional ones may be defined by a module (none yet). We leave some
296 room in `lrecord_implementations_table' for such new lisp object types. */
297 #define MODULE_DEFINABLE_TYPE_COUNT 32
299 extern const struct lrecord_implementation *lrecord_implementations_table[(unsigned int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT];
301 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \
302 LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj))
303 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type]
305 extern int gc_in_progress;
307 #define MARKED_RECORD_P(obj) (XRECORD_LHEADER (obj)->mark)
308 #define MARKED_RECORD_HEADER_P(lheader) ((lheader)->mark)
309 #define MARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 1))
310 #define UNMARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 0))
312 #define OLDER_RECORD_P(obj) (XRECORD_LHEADER (obj)->older)
313 #define OLDER_RECORD_HEADER_P(lheader) ((lheader)->older)
316 #define C_READONLY_RECORD_HEADER_P(lheader) ((lheader)->c_readonly)
317 #define LISP_READONLY_RECORD_HEADER_P(lheader) ((lheader)->lisp_readonly)
318 #define SET_C_READONLY_RECORD_HEADER(lheader) do { \
319 struct lrecord_header *SCRRH_lheader = (lheader); \
320 SCRRH_lheader->c_readonly = 1; \
321 SCRRH_lheader->lisp_readonly = 1; \
322 SCRRH_lheader->mark = 1; \
324 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \
325 ((void) ((lheader)->lisp_readonly = 1))
326 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type]
328 /* External description stuff
330 A lrecord external description is an array of values. The first
331 value of each line is a type, the second the offset in the lrecord
332 structure. Following values are parameters, their presence, type
333 and number is type-dependent.
335 The description ends with a "XD_END" or "XD_SPECIFIER_END" record.
337 Some example descriptions :
339 static const struct lrecord_description cons_description[] = {
340 { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) },
341 { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) },
345 Which means "two lisp objects starting at the 'car' and 'cdr' elements"
347 static const struct lrecord_description string_description[] = {
348 { XD_BYTECOUNT, offsetof (Lisp_String, size) },
349 { XD_OPAQUE_DATA_PTR, offsetof (Lisp_String, data), XD_INDIRECT(0, 1) },
350 { XD_LISP_OBJECT, offsetof (Lisp_String, plist) },
353 "A pointer to string data at 'data', the size of the pointed array being the value
354 of the size variable plus 1, and one lisp object at 'plist'"
358 A Lisp object. This is also the type to use for pointers to other lrecords.
361 An array of Lisp objects or pointers to lrecords.
362 The third element is the count.
365 Lisp objects which will be reset to Qnil when dumping. Useful for cleaning
369 Link in a linked list of objects of the same type.
372 Pointer to undumpable data. Must be NULL when dumping.
375 Pointer to described struct. Parameters are number of structures and
379 Pointer to dumpable opaque data. Parameter is the size of the data.
380 Pointed data must be relocatable without changes.
383 Pointer to a C string.
386 Pointer to a doc string (C string if positive, opaque value if negative)
389 An integer which will be reset to a given value in the dump file.
393 size_t value. Used for counts.
396 int value. Used for counts.
399 long value. Used for counts.
402 bytecount value. Used for counts.
405 Special type indicating the end of the array.
408 Special type indicating the end of the array for a specifier. Extra
409 description is going to be fetched from the specifier methods.
413 XD_INDIRECT(line, delta)
414 Usable where a "count" or "size" is requested. Gives the value of
415 the element which is at line number 'line' in the description (count
416 starts at zero) and adds delta to it.
419 enum lrecord_description_type {
420 XD_LISP_OBJECT_ARRAY,
438 struct lrecord_description {
439 enum lrecord_description_type type;
442 const struct struct_description *data2;
445 struct struct_description {
447 const struct lrecord_description *description;
450 #define XD_INDIRECT(val, delta) (-1-((val)|(delta<<8)))
452 #define XD_IS_INDIRECT(code) (code<0)
453 #define XD_INDIRECT_VAL(code) ((-1-code) & 255)
454 #define XD_INDIRECT_DELTA(code) (((-1-code)>>8) & 255)
456 #define XD_DYNARR_DESC(base_type, sub_desc) \
457 { XD_STRUCT_PTR, offsetof (base_type, base), XD_INDIRECT(1, 0), sub_desc }, \
458 { XD_INT, offsetof (base_type, cur) }, \
459 { XD_INT_RESET, offsetof (base_type, max), XD_INDIRECT(1, 0) }
461 /* DEFINE_LRECORD_IMPLEMENTATION is for objects with constant size.
462 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION is for objects whose size varies.
465 #if defined (ERROR_CHECK_TYPECHECK)
466 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
468 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
471 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
472 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
474 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
475 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof(structtype),0,1,structtype)
477 #define DEFINE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
478 DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
480 #define DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
481 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
483 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
484 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
486 #define DEFINE_BASIC_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
487 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,0,sizer,1,structtype)
489 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
490 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype) \
492 #define MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
493 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype) \
494 const struct lrecord_implementation lrecord_##c_name = \
495 { name, marker, printer, nuker, equal, hash, desc, \
496 getprop, putprop, remprop, plist, size, sizer, \
497 lrecord_type_##c_name, basic_p }
499 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
500 DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
502 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
503 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
505 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
506 DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
508 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
509 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype)
511 #define MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
512 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype) \
513 unsigned int lrecord_type_##c_name = lrecord_type_count++; \
514 const struct lrecord_implementation lrecord_##c_name = \
515 { name, marker, printer, nuker, equal, hash, desc, \
516 getprop, putprop, remprop, plist, size, sizer, \
517 (enum lrecord_type)lrecord_type_##c_name, basic_p }
520 extern Lisp_Object (*lrecord_markers[]) (Lisp_Object);
522 #define INIT_LRECORD_IMPLEMENTATION(type) do { \
523 lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \
524 lrecord_markers[lrecord_type_##type] = \
525 lrecord_implementations_table[lrecord_type_##type]->marker; \
528 #define LRECORDP(a) (XTYPE (a) == Lisp_Type_Record)
529 #define XRECORD_LHEADER(a) ((struct lrecord_header *) XPNTR (a))
531 #define RECORD_TYPEP(x, ty) \
532 (LRECORDP (x) && (((unsigned int)(XRECORD_LHEADER (x)->type)) == ((unsigned int)(ty))))
534 /* Steps to create a new object:
536 1. Declare the struct for your object in a header file somewhere.
537 Remember that it must begin with
539 struct lcrecord_header header;
541 2. Put a DECLARE_LRECORD() for the object below the struct definition,
542 along with the standard XFOO/XSETFOO junk.
544 3. Add this header file to inline.c.
546 4. Create the methods for your object. Note that technically you don't
547 need any, but you will almost always want at least a mark method.
549 5. Define your object with DEFINE_LRECORD_IMPLEMENTATION() or some
552 6. Include the header file in the .c file where you defined the object.
554 7. Put a call to INIT_LRECORD_IMPLEMENTATION() for the object in the
555 .c file's syms_of_foo() function.
557 8. Add a type enum for the object to enum lrecord_type, earlier in this
562 ------------------------------ in toolbar.h -----------------------------
564 struct toolbar_button
566 struct lcrecord_header header;
571 Lisp_Object up_glyph;
572 Lisp_Object down_glyph;
573 Lisp_Object disabled_glyph;
575 Lisp_Object cap_up_glyph;
576 Lisp_Object cap_down_glyph;
577 Lisp_Object cap_disabled_glyph;
579 Lisp_Object callback;
580 Lisp_Object enabled_p;
581 Lisp_Object help_string;
595 DECLARE_LRECORD (toolbar_button, struct toolbar_button);
596 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button)
597 #define XSETTOOLBAR_BUTTON(x, p) XSETRECORD (x, p, toolbar_button)
598 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button)
599 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button)
600 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button)
602 ------------------------------ in toolbar.c -----------------------------
609 mark_toolbar_button (Lisp_Object obj)
611 struct toolbar_button *data = XTOOLBAR_BUTTON (obj);
612 mark_object (data->next);
613 mark_object (data->frame);
614 mark_object (data->up_glyph);
615 mark_object (data->down_glyph);
616 mark_object (data->disabled_glyph);
617 mark_object (data->cap_up_glyph);
618 mark_object (data->cap_down_glyph);
619 mark_object (data->cap_disabled_glyph);
620 mark_object (data->callback);
621 mark_object (data->enabled_p);
622 return data->help_string;
625 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button,
626 mark_toolbar_button, 0, 0, 0, 0, 0,
627 struct toolbar_button);
632 syms_of_toolbar (void)
634 INIT_LRECORD_IMPLEMENTATION (toolbar_button);
639 ------------------------------ in inline.c -----------------------------
645 ------------------------------ in lrecord.h -----------------------------
650 lrecord_type_toolbar_button,
658 Note: Object types defined in external dynamically-loaded modules (not
659 part of the XEmacs main source code) should use DECLARE_EXTERNAL_LRECORD
660 and DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION rather than DECLARE_LRECORD
661 and DEFINE_LRECORD_IMPLEMENTATION.
666 #ifdef ERROR_CHECK_TYPECHECK
668 # define DECLARE_LRECORD(c_name, structtype) \
669 extern const struct lrecord_implementation lrecord_##c_name; \
670 INLINE_HEADER structtype * \
671 error_check_##c_name (Lisp_Object obj); \
672 INLINE_HEADER structtype * \
673 error_check_##c_name (Lisp_Object obj) \
675 assert (RECORD_TYPEP (obj, lrecord_type_##c_name)); \
676 return (structtype *) XPNTR (obj); \
678 extern Lisp_Object Q##c_name##p
680 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype) \
681 extern unsigned int lrecord_type_##c_name; \
682 DECLARE_LRECORD(c_name, structtype)
684 # define DECLARE_NONRECORD(c_name, type_enum, structtype) \
685 INLINE_HEADER structtype * \
686 error_check_##c_name (Lisp_Object obj); \
687 INLINE_HEADER structtype * \
688 error_check_##c_name (Lisp_Object obj) \
690 assert (XTYPE (obj) == type_enum); \
691 return (structtype *) XPNTR (obj); \
693 extern Lisp_Object Q##c_name##p
695 # define XRECORD(x, c_name, structtype) error_check_##c_name (x)
696 # define XNONRECORD(x, c_name, type_enum, structtype) error_check_##c_name (x)
698 # define XSETRECORD(var, p, c_name) do \
701 assert (RECORD_TYPEP (var, lrecord_type_##c_name)); \
704 #else /* not ERROR_CHECK_TYPECHECK */
706 # define DECLARE_LRECORD(c_name, structtype) \
707 extern Lisp_Object Q##c_name##p; \
708 extern const struct lrecord_implementation lrecord_##c_name
709 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype) \
710 extern Lisp_Object Q##c_name##p; \
711 extern unsigned int lrecord_type_##c_name; \
712 extern const struct lrecord_implementation lrecord_##c_name
713 # define DECLARE_NONRECORD(c_name, type_enum, structtype) \
714 extern Lisp_Object Q##c_name##p
715 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x))
716 # define XNONRECORD(x, c_name, type_enum, structtype) \
717 ((structtype *) XPNTR (x))
718 # define XSETRECORD(var, p, c_name) XSETOBJ (var, p)
720 #endif /* not ERROR_CHECK_TYPECHECK */
722 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name)
724 /* Note: we now have two different kinds of type-checking macros.
725 The "old" kind has now been renamed CONCHECK_foo. The reason for
726 this is that the CONCHECK_foo macros signal a continuable error,
727 allowing the user (through debug-on-error) to substitute a different
728 value and return from the signal, which causes the lvalue argument
729 to get changed. Quite a lot of code would crash if that happened,
730 because it did things like
735 and later on did XSTRING (XCAR (list)), assuming that the type
736 is correct (when it might be wrong, if the user substituted a
737 correct value in the debugger).
739 To get around this, I made all the CHECK_foo macros signal a
740 non-continuable error. Places where a continuable error is OK
741 (generally only when called directly on the argument of a Lisp
742 primitive) should be changed to use CONCHECK().
744 FSF Emacs does not have this problem because RMS took the cheesy
745 way out and disabled returning from a signal entirely. */
747 #define CONCHECK_RECORD(x, c_name) do { \
748 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \
749 x = wrong_type_argument (Q##c_name##p, x); \
751 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\
752 if (XTYPE (x) != lisp_enum) \
753 x = wrong_type_argument (predicate, x); \
755 #define CHECK_RECORD(x, c_name) do { \
756 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \
757 dead_wrong_type_argument (Q##c_name##p, x); \
759 #define CHECK_NONRECORD(x, lisp_enum, predicate) do { \
760 if (XTYPE (x) != lisp_enum) \
761 dead_wrong_type_argument (predicate, x); \
764 void *alloc_lcrecord (size_t size, const struct lrecord_implementation *);
766 #define alloc_lcrecord_type(type, lrecord_implementation) \
767 ((type *) alloc_lcrecord (sizeof (type), lrecord_implementation))
771 alloc_older_lcrecord (size_t size, const struct lrecord_implementation *);
773 #define alloc_older_lcrecord_type(type, lrecord_implementation) \
774 ((type *) alloc_older_lcrecord (sizeof (type), lrecord_implementation))
777 /* Copy the data from one lcrecord structure into another, but don't
778 overwrite the header information. */
780 #define copy_lcrecord(dst, src) \
781 memcpy ((char *) (dst) + sizeof (struct lcrecord_header), \
782 (char *) (src) + sizeof (struct lcrecord_header), \
783 sizeof (*(dst)) - sizeof (struct lcrecord_header))
785 #define zero_lcrecord(lcr) \
786 memset ((char *) (lcr) + sizeof (struct lcrecord_header), 0, \
787 sizeof (*(lcr)) - sizeof (struct lcrecord_header))
789 #endif /* INCLUDED_lrecord_h_ */