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 struct lrecord_implementation;
81 int lrecord_type_index (const struct lrecord_implementation *implementation);
83 #define set_lheader_implementation(header,imp) do { \
84 struct lrecord_header* SLI_header = (header); \
85 SLI_header->type = (imp)->lrecord_type_index; \
86 SLI_header->mark = 0; \
87 SLI_header->c_readonly = 0; \
88 SLI_header->lisp_readonly = 0; \
91 struct lcrecord_header
93 struct lrecord_header lheader;
95 /* The `next' field is normally used to chain all lcrecords together
96 so that the GC can find (and free) all of them.
97 `alloc_lcrecord' threads lcrecords together.
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.
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;
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;
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;
122 /* Used for lcrecords in an lcrecord-list. */
123 struct free_lcrecord_header
125 struct lcrecord_header lcheader;
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,
145 lrecord_type_lcrecord_list,
146 lrecord_type_compiled_function,
147 lrecord_type_weak_list,
148 lrecord_type_bit_vector,
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_byte_table,
158 lrecord_type_uint16_byte_table,
159 lrecord_type_uint8_byte_table,
160 lrecord_type_range_table,
162 lrecord_type_opaque_ptr,
165 lrecord_type_extent_info,
166 lrecord_type_extent_auxiliary,
170 lrecord_type_command_builder,
171 lrecord_type_timeout,
172 lrecord_type_specifier,
173 lrecord_type_console,
177 lrecord_type_window_configuration,
178 lrecord_type_gui_item,
179 lrecord_type_popup_data,
180 lrecord_type_toolbar_button,
181 lrecord_type_color_instance,
182 lrecord_type_font_instance,
183 lrecord_type_image_instance,
186 lrecord_type_database,
187 lrecord_type_tooltalk_message,
188 lrecord_type_tooltalk_pattern,
191 lrecord_type_pgresult,
192 lrecord_type_devmode,
193 lrecord_type_mswindows_dialog_id,
194 lrecord_type_case_table,
195 lrecord_type_free, /* only used for "free" lrecords */
196 lrecord_type_undefined, /* only used for debugging */
197 lrecord_type_last_built_in_type /* must be last */
200 extern unsigned int lrecord_type_count;
202 struct lrecord_implementation
206 /* `marker' is called at GC time, to make sure that all Lisp_Objects
207 pointed to by this object get properly marked. It should call
208 the mark_object function on all Lisp_Objects in the object. If
209 the return value is non-nil, it should be a Lisp_Object to be
210 marked (don't call the mark_object function explicitly on it,
211 because the GC routines will do this). Doing it this way reduces
212 recursion, so the object returned should preferably be the one
213 with the deepest level of Lisp_Object pointers. This function
214 can be NULL, meaning no GC marking is necessary. */
215 Lisp_Object (*marker) (Lisp_Object);
217 /* `printer' converts the object to a printed representation.
218 This can be NULL; in this case default_object_printer() will be
220 void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag);
222 /* `finalizer' is called at GC time when the object is about to
223 be freed, and at dump time (FOR_DISKSAVE will be non-zero in this
224 case). It should perform any necessary cleanup (e.g. freeing
225 malloc()ed memory). This can be NULL, meaning no special
226 finalization is necessary.
228 WARNING: remember that `finalizer' is called at dump time even
229 though the object is not being freed. */
230 void (*finalizer) (void *header, int for_disksave);
232 /* This can be NULL, meaning compare objects with EQ(). */
233 int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth);
235 /* `hash' generates hash values for use with hash tables that have
236 `equal' as their test function. This can be NULL, meaning use
237 the Lisp_Object itself as the hash. But, you must still satisfy
238 the constraint that if two objects are `equal', then they *must*
239 hash to the same value in order for hash tables to work properly.
240 This means that `hash' can be NULL only if the `equal' method is
242 unsigned long (*hash) (Lisp_Object, int);
244 /* External data layout description */
245 const struct lrecord_description *description;
247 /* These functions allow any object type to have builtin property
248 lists that can be manipulated from the lisp level with
249 `get', `put', `remprop', and `object-plist'. */
250 Lisp_Object (*getprop) (Lisp_Object obj, Lisp_Object prop);
251 int (*putprop) (Lisp_Object obj, Lisp_Object prop, Lisp_Object val);
252 int (*remprop) (Lisp_Object obj, Lisp_Object prop);
253 Lisp_Object (*plist) (Lisp_Object obj);
255 /* Only one of `static_size' and `size_in_bytes_method' is non-0.
256 If both are 0, this type is not instantiable by alloc_lcrecord(). */
258 size_t (*size_in_bytes_method) (const void *header);
260 /* The (constant) index into lrecord_implementations_table */
261 enum lrecord_type lrecord_type_index;
263 /* A "basic" lrecord is any lrecord that's not an lcrecord, i.e.
264 one that does not have an lcrecord_header at the front and which
265 is (usually) allocated in frob blocks. We only use this flag for
266 some consistency checking, and that only when error-checking is
268 unsigned int basic_p :1;
271 /* All the built-in lisp object types are enumerated in `enum record_type'.
272 Additional ones may be defined by a module (none yet). We leave some
273 room in `lrecord_implementations_table' for such new lisp object types. */
274 #define MODULE_DEFINABLE_TYPE_COUNT 32
276 extern const struct lrecord_implementation *lrecord_implementations_table[(unsigned int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT];
278 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \
279 LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj))
280 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type]
282 extern int gc_in_progress;
284 #define MARKED_RECORD_P(obj) (XRECORD_LHEADER (obj)->mark)
285 #define MARKED_RECORD_HEADER_P(lheader) ((lheader)->mark)
286 #define MARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 1))
287 #define UNMARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 0))
289 #define C_READONLY_RECORD_HEADER_P(lheader) ((lheader)->c_readonly)
290 #define LISP_READONLY_RECORD_HEADER_P(lheader) ((lheader)->lisp_readonly)
291 #define SET_C_READONLY_RECORD_HEADER(lheader) do { \
292 struct lrecord_header *SCRRH_lheader = (lheader); \
293 SCRRH_lheader->c_readonly = 1; \
294 SCRRH_lheader->lisp_readonly = 1; \
295 SCRRH_lheader->mark = 1; \
297 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \
298 ((void) ((lheader)->lisp_readonly = 1))
299 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type]
301 /* External description stuff
303 A lrecord external description is an array of values. The first
304 value of each line is a type, the second the offset in the lrecord
305 structure. Following values are parameters, their presence, type
306 and number is type-dependent.
308 The description ends with a "XD_END" or "XD_SPECIFIER_END" record.
310 Some example descriptions :
312 static const struct lrecord_description cons_description[] = {
313 { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) },
314 { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) },
318 Which means "two lisp objects starting at the 'car' and 'cdr' elements"
320 static const struct lrecord_description string_description[] = {
321 { XD_BYTECOUNT, offsetof (Lisp_String, size) },
322 { XD_OPAQUE_DATA_PTR, offsetof (Lisp_String, data), XD_INDIRECT(0, 1) },
323 { XD_LISP_OBJECT, offsetof (Lisp_String, plist) },
326 "A pointer to string data at 'data', the size of the pointed array being the value
327 of the size variable plus 1, and one lisp object at 'plist'"
331 A Lisp object. This is also the type to use for pointers to other lrecords.
334 An array of Lisp objects or pointers to lrecords.
335 The third element is the count.
338 Link in a linked list of objects of the same type.
341 Pointer to undumpable data. Must be NULL when dumping.
344 Pointer to described struct. Parameters are number of structures and
348 Pointer to dumpable opaque data. Parameter is the size of the data.
349 Pointed data must be relocatable without changes.
352 Pointer to a C string.
355 Pointer to a doc string (C string if positive, opaque value if negative)
358 An integer which will be reset to a given value in the dump file.
362 size_t value. Used for counts.
365 int value. Used for counts.
368 long value. Used for counts.
371 bytecount value. Used for counts.
374 Special type indicating the end of the array.
377 Special type indicating the end of the array for a specifier. Extra
378 description is going to be fetched from the specifier methods.
382 XD_INDIRECT(line, delta)
383 Usable where a "count" or "size" is requested. Gives the value of
384 the element which is at line number 'line' in the description (count
385 starts at zero) and adds delta to it.
388 enum lrecord_description_type {
389 XD_LISP_OBJECT_ARRAY,
406 struct lrecord_description {
407 enum lrecord_description_type type;
410 const struct struct_description *data2;
413 struct struct_description {
415 const struct lrecord_description *description;
418 #define XD_INDIRECT(val, delta) (-1-((val)|(delta<<8)))
420 #define XD_IS_INDIRECT(code) (code<0)
421 #define XD_INDIRECT_VAL(code) ((-1-code) & 255)
422 #define XD_INDIRECT_DELTA(code) (((-1-code)>>8) & 255)
424 #define XD_DYNARR_DESC(base_type, sub_desc) \
425 { XD_STRUCT_PTR, offsetof (base_type, base), XD_INDIRECT(1, 0), sub_desc }, \
426 { XD_INT, offsetof (base_type, cur) }, \
427 { XD_INT_RESET, offsetof (base_type, max), XD_INDIRECT(1, 0) }
429 /* DEFINE_LRECORD_IMPLEMENTATION is for objects with constant size.
430 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION is for objects whose size varies.
433 #if defined (ERROR_CHECK_TYPECHECK)
434 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
436 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
439 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
440 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
442 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
443 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof(structtype),0,1,structtype)
445 #define DEFINE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
446 DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
448 #define DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
449 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
451 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
452 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
454 #define DEFINE_BASIC_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
455 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,0,sizer,1,structtype)
457 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
458 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype) \
460 #define MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
461 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype) \
462 const struct lrecord_implementation lrecord_##c_name = \
463 { name, marker, printer, nuker, equal, hash, desc, \
464 getprop, putprop, remprop, plist, size, sizer, \
465 lrecord_type_##c_name, basic_p }
467 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
468 DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
470 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
471 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
473 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
474 DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
476 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
477 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype)
479 #define MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
480 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype) \
481 unsigned int lrecord_type_##c_name; \
482 struct lrecord_implementation lrecord_##c_name = \
483 { name, marker, printer, nuker, equal, hash, desc, \
484 getprop, putprop, remprop, plist, size, sizer, \
485 lrecord_type_last_built_in_type, basic_p }
488 extern Lisp_Object (*lrecord_markers[]) (Lisp_Object);
490 #define INIT_LRECORD_IMPLEMENTATION(type) do { \
491 lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \
492 lrecord_markers[lrecord_type_##type] = \
493 lrecord_implementations_table[lrecord_type_##type]->marker; \
496 #define INIT_EXTERNAL_LRECORD_IMPLEMENTATION(type) do { \
497 lrecord_type_##type = lrecord_type_count++; \
498 lrecord_##type.lrecord_type_index = lrecord_type_##type; \
499 INIT_LRECORD_IMPLEMENTATION(type); \
502 #define LRECORDP(a) (XTYPE (a) == Lisp_Type_Record)
503 #define XRECORD_LHEADER(a) ((struct lrecord_header *) XPNTR (a))
505 #define RECORD_TYPEP(x, ty) \
506 (LRECORDP (x) && (((unsigned int)(XRECORD_LHEADER (x)->type)) == ((unsigned int)(ty))))
508 /* Steps to create a new object:
510 1. Declare the struct for your object in a header file somewhere.
511 Remember that it must begin with
513 struct lcrecord_header header;
515 2. Put a DECLARE_LRECORD() for the object below the struct definition,
516 along with the standard XFOO/XSETFOO junk.
518 3. Add this header file to inline.c.
520 4. Create the methods for your object. Note that technically you don't
521 need any, but you will almost always want at least a mark method.
523 5. Define your object with DEFINE_LRECORD_IMPLEMENTATION() or some
526 6. Include the header file in the .c file where you defined the object.
528 7. Put a call to INIT_LRECORD_IMPLEMENTATION() for the object in the
529 .c file's syms_of_foo() function.
531 8. Add a type enum for the object to enum lrecord_type, earlier in this
536 ------------------------------ in toolbar.h -----------------------------
538 struct toolbar_button
540 struct lcrecord_header header;
545 Lisp_Object up_glyph;
546 Lisp_Object down_glyph;
547 Lisp_Object disabled_glyph;
549 Lisp_Object cap_up_glyph;
550 Lisp_Object cap_down_glyph;
551 Lisp_Object cap_disabled_glyph;
553 Lisp_Object callback;
554 Lisp_Object enabled_p;
555 Lisp_Object help_string;
569 DECLARE_LRECORD (toolbar_button, struct toolbar_button);
570 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button)
571 #define XSETTOOLBAR_BUTTON(x, p) XSETRECORD (x, p, toolbar_button)
572 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button)
573 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button)
574 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button)
576 ------------------------------ in toolbar.c -----------------------------
583 mark_toolbar_button (Lisp_Object obj)
585 struct toolbar_button *data = XTOOLBAR_BUTTON (obj);
586 mark_object (data->next);
587 mark_object (data->frame);
588 mark_object (data->up_glyph);
589 mark_object (data->down_glyph);
590 mark_object (data->disabled_glyph);
591 mark_object (data->cap_up_glyph);
592 mark_object (data->cap_down_glyph);
593 mark_object (data->cap_disabled_glyph);
594 mark_object (data->callback);
595 mark_object (data->enabled_p);
596 return data->help_string;
599 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button,
600 mark_toolbar_button, 0, 0, 0, 0, 0,
601 struct toolbar_button);
606 syms_of_toolbar (void)
608 INIT_LRECORD_IMPLEMENTATION (toolbar_button);
613 ------------------------------ in inline.c -----------------------------
619 ------------------------------ in lrecord.h -----------------------------
624 lrecord_type_toolbar_button,
632 Note: Object types defined in external dynamically-loaded modules (not
633 part of the XEmacs main source code) should use DECLARE_EXTERNAL_LRECORD
634 and DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION rather than DECLARE_LRECORD
635 and DEFINE_LRECORD_IMPLEMENTATION.
640 #ifdef ERROR_CHECK_TYPECHECK
642 # define DECLARE_LRECORD(c_name, structtype) \
643 extern const struct lrecord_implementation lrecord_##c_name; \
644 INLINE_HEADER structtype * \
645 error_check_##c_name (Lisp_Object obj); \
646 INLINE_HEADER structtype * \
647 error_check_##c_name (Lisp_Object obj) \
649 assert (RECORD_TYPEP (obj, lrecord_type_##c_name)); \
650 return (structtype *) XPNTR (obj); \
652 extern Lisp_Object Q##c_name##p
654 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype) \
655 extern unsigned int lrecord_type_##c_name; \
656 extern struct lrecord_implementation lrecord_##c_name; \
657 INLINE_HEADER structtype * \
658 error_check_##c_name (Lisp_Object obj); \
659 INLINE_HEADER structtype * \
660 error_check_##c_name (Lisp_Object obj) \
662 assert (RECORD_TYPEP (obj, lrecord_type_##c_name)); \
663 return (structtype *) XPNTR (obj); \
665 extern Lisp_Object Q##c_name##p
667 # define DECLARE_NONRECORD(c_name, type_enum, structtype) \
668 INLINE_HEADER structtype * \
669 error_check_##c_name (Lisp_Object obj); \
670 INLINE_HEADER structtype * \
671 error_check_##c_name (Lisp_Object obj) \
673 assert (XTYPE (obj) == type_enum); \
674 return (structtype *) XPNTR (obj); \
676 extern Lisp_Object Q##c_name##p
678 # define XRECORD(x, c_name, structtype) error_check_##c_name (x)
679 # define XNONRECORD(x, c_name, type_enum, structtype) error_check_##c_name (x)
681 # define XSETRECORD(var, p, c_name) do \
684 assert (RECORD_TYPEP (var, lrecord_type_##c_name)); \
687 #else /* not ERROR_CHECK_TYPECHECK */
689 # define DECLARE_LRECORD(c_name, structtype) \
690 extern Lisp_Object Q##c_name##p; \
691 extern const struct lrecord_implementation lrecord_##c_name
692 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype) \
693 extern Lisp_Object Q##c_name##p; \
694 extern unsigned int lrecord_type_##c_name; \
695 extern struct lrecord_implementation lrecord_##c_name
696 # define DECLARE_NONRECORD(c_name, type_enum, structtype) \
697 extern Lisp_Object Q##c_name##p
698 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x))
699 # define XNONRECORD(x, c_name, type_enum, structtype) \
700 ((structtype *) XPNTR (x))
701 # define XSETRECORD(var, p, c_name) XSETOBJ (var, p)
703 #endif /* not ERROR_CHECK_TYPECHECK */
705 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name)
707 /* Note: we now have two different kinds of type-checking macros.
708 The "old" kind has now been renamed CONCHECK_foo. The reason for
709 this is that the CONCHECK_foo macros signal a continuable error,
710 allowing the user (through debug-on-error) to substitute a different
711 value and return from the signal, which causes the lvalue argument
712 to get changed. Quite a lot of code would crash if that happened,
713 because it did things like
718 and later on did XSTRING (XCAR (list)), assuming that the type
719 is correct (when it might be wrong, if the user substituted a
720 correct value in the debugger).
722 To get around this, I made all the CHECK_foo macros signal a
723 non-continuable error. Places where a continuable error is OK
724 (generally only when called directly on the argument of a Lisp
725 primitive) should be changed to use CONCHECK().
727 FSF Emacs does not have this problem because RMS took the cheesy
728 way out and disabled returning from a signal entirely. */
730 #define CONCHECK_RECORD(x, c_name) do { \
731 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \
732 x = wrong_type_argument (Q##c_name##p, x); \
734 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\
735 if (XTYPE (x) != lisp_enum) \
736 x = wrong_type_argument (predicate, x); \
738 #define CHECK_RECORD(x, c_name) do { \
739 if (!RECORD_TYPEP (x, lrecord_type_##c_name)) \
740 dead_wrong_type_argument (Q##c_name##p, x); \
742 #define CHECK_NONRECORD(x, lisp_enum, predicate) do { \
743 if (XTYPE (x) != lisp_enum) \
744 dead_wrong_type_argument (predicate, x); \
747 void *alloc_lcrecord (size_t size, const struct lrecord_implementation *);
749 #define alloc_lcrecord_type(type, lrecord_implementation) \
750 ((type *) alloc_lcrecord (sizeof (type), lrecord_implementation))
752 /* Copy the data from one lcrecord structure into another, but don't
753 overwrite the header information. */
755 #define copy_lcrecord(dst, src) \
756 memcpy ((char *) (dst) + sizeof (struct lcrecord_header), \
757 (char *) (src) + sizeof (struct lcrecord_header), \
758 sizeof (*(dst)) - sizeof (struct lcrecord_header))
760 #define zero_lcrecord(lcr) \
761 memset ((char *) (lcr) + sizeof (struct lcrecord_header), 0, \
762 sizeof (*(lcr)) - sizeof (struct lcrecord_header))
764 #endif /* INCLUDED_lrecord_h_ */