src/lrecord.h

   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
  24 #ifndef INCLUDED_lrecord_h_
  25 #define INCLUDED_lrecord_h_
  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
  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.
  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
  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().
  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[] */
  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
  76   /* 1 if the object is readonly from lisp */
  77   unsigned int lisp_readonly :1;
  78
  79 #ifdef UTF2000
  80   /* The `older field is a flag that indicates whether this lcrecord
  81      is on a "older storage". */
  82   unsigned int older :1;
  83 #endif
  84 };
  85
  86 struct lrecord_implementation;
  87 int lrecord_type_index (const struct lrecord_implementation *implementation);
  88
  89 #ifdef UTF2000
  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;                        \
  97 } while (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;                                \
 105 } while (0)
 106 #else
 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;                        \
 113 } while (0)
 114 #endif
 115
 116 struct lcrecord_header
 117 {
 118   struct lrecord_header lheader;
 119
 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.
 123
 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.
 126
 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;
 131
 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;
 136
 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;
 145 };
 146
 147 /* Used for lcrecords in an lcrecord-list. */
 148 struct free_lcrecord_header
 149 {
 150   struct lcrecord_header lcheader;
 151   Lisp_Object chain;
 152 };
 153
 154 enum lrecord_type
 155 {
 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,
 164
 165   lrecord_type_symbol,
 166   lrecord_type_subr,
 167   lrecord_type_cons,
 168   lrecord_type_vector,
 169   lrecord_type_string,
 170   lrecord_type_lcrecord_list,
 171   lrecord_type_compiled_function,
 172   lrecord_type_weak_list,
 173   lrecord_type_bit_vector,
 174   lrecord_type_float,
 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,
 187   lrecord_type_opaque,
 188   lrecord_type_opaque_ptr,
 189   lrecord_type_buffer,
 190   lrecord_type_extent,
 191   lrecord_type_extent_info,
 192   lrecord_type_extent_auxiliary,
 193   lrecord_type_marker,
 194   lrecord_type_event,
 195   lrecord_type_keymap,
 196   lrecord_type_command_builder,
 197   lrecord_type_timeout,
 198   lrecord_type_specifier,
 199   lrecord_type_console,
 200   lrecord_type_device,
 201   lrecord_type_frame,
 202   lrecord_type_window,
 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,
 210   lrecord_type_glyph,
 211   lrecord_type_face,
 212   lrecord_type_database,
 213   lrecord_type_tooltalk_message,
 214   lrecord_type_tooltalk_pattern,
 215   lrecord_type_ldap,
 216   lrecord_type_pgconn,
 217   lrecord_type_pgresult,
 218   lrecord_type_devmode,
 219   lrecord_type_count /* must be last */
 220 };
 221
 222 struct lrecord_implementation
 223 {
 224   const char *name;
 225
 226   /* `marker' is called at GC time, to make sure that all Lisp_Objects
 227      pointed to by this object get properly marked.  It should call
 228      the mark_object function on all Lisp_Objects in the object.  If
 229      the return value is non-nil, it should be a Lisp_Object to be
 230      marked (don't call the mark_object function explicitly on it,
 231      because the GC routines will do this).  Doing it this way reduces
 232      recursion, so the object returned should preferably be the one
 233      with the deepest level of Lisp_Object pointers.  This function
 234      can be NULL, meaning no GC marking is necessary. */
 235   Lisp_Object (*marker) (Lisp_Object);
 236
 237   /* `printer' converts the object to a printed representation.
 238      This can be NULL; in this case default_object_printer() will be
 239      used instead. */
 240   void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag);
 241
 242   /* `finalizer' is called at GC time when the object is about to
 243      be freed, and at dump time (FOR_DISKSAVE will be non-zero in this
 244      case).  It should perform any necessary cleanup (e.g. freeing
 245      malloc()ed memory).  This can be NULL, meaning no special
 246      finalization is necessary.
 247
 248      WARNING: remember that `finalizer' is called at dump time even
 249      though the object is not being freed. */
 250   void (*finalizer) (void *header, int for_disksave);
 251
 252   /* This can be NULL, meaning compare objects with EQ(). */
 253   int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth);
 254
 255   /* `hash' generates hash values for use with hash tables that have
 256      `equal' as their test function.  This can be NULL, meaning use
 257      the Lisp_Object itself as the hash.  But, you must still satisfy
 258      the constraint that if two objects are `equal', then they *must*
 259      hash to the same value in order for hash tables to work properly.
 260      This means that `hash' can be NULL only if the `equal' method is
 261      also NULL. */
 262   unsigned long (*hash) (Lisp_Object, int);
 263
 264   /* External data layout description */
 265   const struct lrecord_description *description;
 266
 267   /* These functions allow any object type to have builtin property
 268      lists that can be manipulated from the lisp level with
 269      `get', `put', `remprop', and `object-plist'. */
 270   Lisp_Object (*getprop) (Lisp_Object obj, Lisp_Object prop);
 271   int (*putprop) (Lisp_Object obj, Lisp_Object prop, Lisp_Object val);
 272   int (*remprop) (Lisp_Object obj, Lisp_Object prop);
 273   Lisp_Object (*plist) (Lisp_Object obj);
 274
 275   /* Only one of `static_size' and `size_in_bytes_method' is non-0.
 276      If both are 0, this type is not instantiable by alloc_lcrecord(). */
 277   size_t static_size;
 278   size_t (*size_in_bytes_method) (const void *header);
 279
 280   /* The (constant) index into lrecord_implementations_table */
 281   enum lrecord_type lrecord_type_index;
 282
 283   /* A "basic" lrecord is any lrecord that's not an lcrecord, i.e.
 284      one that does not have an lcrecord_header at the front and which
 285      is (usually) allocated in frob blocks.  We only use this flag for
 286      some consistency checking, and that only when error-checking is
 287      enabled. */
 288   unsigned int basic_p :1;
 289 };
 290
 291 extern const struct lrecord_implementation *lrecord_implementations_table[];
 292
 293 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \
 294    LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj))
 295 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type]
 296
 297 extern int gc_in_progress;
 298
 299 #define MARKED_RECORD_P(obj) (XRECORD_LHEADER (obj)->mark)
 300 #define MARKED_RECORD_HEADER_P(lheader) ((lheader)->mark)
 301 #define MARK_RECORD_HEADER(lheader)   ((void) ((lheader)->mark = 1))
 302 #define UNMARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 0))
 303
 304 #define OLDER_RECORD_P(obj) (XRECORD_LHEADER (obj)->older)
 305 #define OLDER_RECORD_HEADER_P(lheader) ((lheader)->older)
 306
 307
 308 #define C_READONLY_RECORD_HEADER_P(lheader)  ((lheader)->c_readonly)
 309 #define LISP_READONLY_RECORD_HEADER_P(lheader)  ((lheader)->lisp_readonly)
 310 #define SET_C_READONLY_RECORD_HEADER(lheader) do {      \
 311   struct lrecord_header *SCRRH_lheader = (lheader);     \
 312   SCRRH_lheader->c_readonly = 1;                        \
 313   SCRRH_lheader->lisp_readonly = 1;                     \
 314   SCRRH_lheader->mark = 1;                              \
 315 } while (0)
 316 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \
 317   ((void) ((lheader)->lisp_readonly = 1))
 318 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type]
 319
 320 /* External description stuff
 321
 322    A lrecord external description  is an array  of values.  The  first
 323    value of each line is a type, the second  the offset in the lrecord
 324    structure.  Following values  are parameters, their  presence, type
 325    and number is type-dependant.
 326
 327    The description ends with a "XD_END" or "XD_SPECIFIER_END" record.
 328
 329    Some example descriptions :
 330
 331    static const struct lrecord_description cons_description[] = {
 332      { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) },
 333      { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) },
 334      { XD_END }
 335    };
 336
 337    Which means "two lisp objects starting at the 'car' and 'cdr' elements"
 338
 339   static const struct lrecord_description string_description[] = {
 340     { XD_BYTECOUNT,       offsetof (Lisp_String, size) },
 341     { XD_OPAQUE_DATA_PTR, offsetof (Lisp_String, data), XD_INDIRECT(0, 1) },
 342     { XD_LISP_OBJECT,     offsetof (Lisp_String, plist) },
 343     { XD_END }
 344   };
 345   "A pointer to string data at 'data', the size of the pointed array being the value
 346    of the size variable plus 1, and one lisp object at 'plist'"
 347
 348   The existing types :
 349     XD_LISP_OBJECT
 350   A Lisp object.  This is also the type to use for pointers to other lrecords.
 351
 352     XD_LISP_OBJECT_ARRAY
 353   An array of Lisp objects or pointers to lrecords.
 354   The third element is the count.
 355
 356     XD_LO_RESET_NIL
 357   Lisp objects which will be reset to Qnil when dumping.  Useful for cleaning
 358   up caches.
 359
 360     XD_LO_LINK
 361   Link in a linked list of objects of the same type.
 362
 363     XD_OPAQUE_PTR
 364   Pointer to undumpable data.  Must be NULL when dumping.
 365
 366     XD_STRUCT_PTR
 367   Pointer to described struct.  Parameters are number of structures and
 368   struct_description.
 369
 370     XD_OPAQUE_DATA_PTR
 371   Pointer to dumpable opaque data.  Parameter is the size of the data.
 372   Pointed data must be relocatable without changes.
 373
 374     XD_C_STRING
 375   Pointer to a C string.
 376
 377     XD_DOC_STRING
 378   Pointer to a doc string (C string if positive, opaque value if negative)
 379
 380     XD_INT_RESET
 381   An integer which will be reset to a given value in the dump file.
 382
 383
 384     XD_SIZE_T
 385   size_t value.  Used for counts.
 386
 387     XD_INT
 388   int value.  Used for counts.
 389
 390     XD_LONG
 391   long value.  Used for counts.
 392
 393     XD_BYTECOUNT
 394   bytecount value.  Used for counts.
 395
 396     XD_END
 397   Special type indicating the end of the array.
 398
 399     XD_SPECIFIER_END
 400   Special type indicating the end of the array for a specifier.  Extra
 401   description is going to be fetched from the specifier methods.
 402
 403
 404   Special macros:
 405     XD_INDIRECT(line, delta)
 406   Usable where  a "count" or "size"  is requested.  Gives the value of
 407   the element which is at line number 'line' in the description (count
 408   starts at zero) and adds delta to it.
 409 */
 410
 411 enum lrecord_description_type {
 412   XD_LISP_OBJECT_ARRAY,
 413   XD_LISP_OBJECT,
 414   XD_LO_RESET_NIL,
 415   XD_LO_LINK,
 416   XD_OPAQUE_PTR,
 417   XD_STRUCT_PTR,
 418   XD_OPAQUE_DATA_PTR,
 419   XD_C_STRING,
 420   XD_DOC_STRING,
 421   XD_INT_RESET,
 422   XD_SIZE_T,
 423   XD_INT,
 424   XD_LONG,
 425   XD_BYTECOUNT,
 426   XD_END,
 427   XD_SPECIFIER_END
 428 };
 429
 430 struct lrecord_description {
 431   enum lrecord_description_type type;
 432   int offset;
 433   EMACS_INT data1;
 434   const struct struct_description *data2;
 435 };
 436
 437 struct struct_description {
 438   size_t size;
 439   const struct lrecord_description *description;
 440 };
 441
 442 #define XD_INDIRECT(val, delta) (-1-((val)|(delta<<8)))
 443
 444 #define XD_IS_INDIRECT(code) (code<0)
 445 #define XD_INDIRECT_VAL(code) ((-1-code) & 255)
 446 #define XD_INDIRECT_DELTA(code) (((-1-code)>>8) & 255)
 447
 448 #define XD_DYNARR_DESC(base_type, sub_desc) \
 449   { XD_STRUCT_PTR, offsetof (base_type, base), XD_INDIRECT(1, 0), sub_desc }, \
 450   { XD_INT,        offsetof (base_type, cur) }, \
 451   { XD_INT_RESET,  offsetof (base_type, max), XD_INDIRECT(1, 0) }
 452
 453 /* DEFINE_LRECORD_IMPLEMENTATION is for objects with constant size.
 454    DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION is for objects whose size varies.
 455  */
 456
 457 #if defined (ERROR_CHECK_TYPECHECK)
 458 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
 459 #else
 460 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
 461 #endif
 462
 463 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
 464 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
 465
 466 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
 467 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof(structtype),0,1,structtype)
 468
 469 #define DEFINE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
 470 DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
 471
 472 #define DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
 473 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
 474
 475 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
 476 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
 477
 478 #define DEFINE_BASIC_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
 479 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,0,sizer,1,structtype)
 480
 481 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
 482 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype) \
 483
 484 #define MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
 485 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)                       \
 486 const struct lrecord_implementation lrecord_##c_name =                  \
 487   { name, marker, printer, nuker, equal, hash, desc,                    \
 488     getprop, putprop, remprop, plist, size, sizer,                      \
 489     lrecord_type_##c_name, basic_p }
 490
 491 extern Lisp_Object (*lrecord_markers[]) (Lisp_Object);
 492
 493 #define INIT_LRECORD_IMPLEMENTATION(type) do {                          \
 494   lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \
 495   lrecord_markers[lrecord_type_##type] =                                \
 496     lrecord_implementations_table[lrecord_type_##type]->marker;         \
 497 } while (0)
 498
 499 #define LRECORDP(a) (XTYPE (a) == Lisp_Type_Record)
 500 #define XRECORD_LHEADER(a) ((struct lrecord_header *) XPNTR (a))
 501
 502 #define RECORD_TYPEP(x, ty) \
 503   (LRECORDP (x) && XRECORD_LHEADER (x)->type == (ty))
 504
 505 /* NOTE: the DECLARE_LRECORD() must come before the associated
 506    DEFINE_LRECORD_*() or you will get compile errors.
 507
 508    Furthermore, you always need to put the DECLARE_LRECORD() in a header
 509    file, and make sure the header file is included in inline.c, even
 510    if the type is private to a particular file.  Otherwise, you will
 511    get undefined references for the error_check_foo() inline function
 512    under GCC. */
 513
 514 #ifdef ERROR_CHECK_TYPECHECK
 515
 516 # define DECLARE_LRECORD(c_name, structtype)                    \
 517 extern const struct lrecord_implementation lrecord_##c_name;    \
 518 INLINE_HEADER structtype *                                      \
 519 error_check_##c_name (Lisp_Object obj);                         \
 520 INLINE_HEADER structtype *                                      \
 521 error_check_##c_name (Lisp_Object obj)                          \
 522 {                                                               \
 523   assert (RECORD_TYPEP (obj, lrecord_type_##c_name));           \
 524   return (structtype *) XPNTR (obj);                            \
 525 }                                                               \
 526 extern Lisp_Object Q##c_name##p
 527
 528 # define DECLARE_NONRECORD(c_name, type_enum, structtype)       \
 529 INLINE_HEADER structtype *                                      \
 530 error_check_##c_name (Lisp_Object obj);                         \
 531 INLINE_HEADER structtype *                                      \
 532 error_check_##c_name (Lisp_Object obj)                          \
 533 {                                                               \
 534   assert (XTYPE (obj) == type_enum);                            \
 535   return (structtype *) XPNTR (obj);                            \
 536 }                                                               \
 537 extern Lisp_Object Q##c_name##p
 538
 539 # define XRECORD(x, c_name, structtype) error_check_##c_name (x)
 540 # define XNONRECORD(x, c_name, type_enum, structtype) error_check_##c_name (x)
 541
 542 # define XSETRECORD(var, p, c_name) do                          \
 543 {                                                               \
 544   XSETOBJ (var, Lisp_Type_Record, p);                           \
 545   assert (RECORD_TYPEP (var, lrecord_type_##c_name));           \
 546 } while (0)
 547
 548 #else /* not ERROR_CHECK_TYPECHECK */
 549
 550 # define DECLARE_LRECORD(c_name, structtype)                    \
 551 extern Lisp_Object Q##c_name##p;                                \
 552 extern const struct lrecord_implementation lrecord_##c_name
 553 # define DECLARE_NONRECORD(c_name, type_enum, structtype)       \
 554 extern Lisp_Object Q##c_name##p
 555 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x))
 556 # define XNONRECORD(x, c_name, type_enum, structtype)           \
 557   ((structtype *) XPNTR (x))
 558 # define XSETRECORD(var, p, c_name) XSETOBJ (var, Lisp_Type_Record, p)
 559
 560 #endif /* not ERROR_CHECK_TYPECHECK */
 561
 562 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name)
 563
 564 /* Note: we now have two different kinds of type-checking macros.
 565    The "old" kind has now been renamed CONCHECK_foo.  The reason for
 566    this is that the CONCHECK_foo macros signal a continuable error,
 567    allowing the user (through debug-on-error) to substitute a different
 568    value and return from the signal, which causes the lvalue argument
 569    to get changed.  Quite a lot of code would crash if that happened,
 570    because it did things like
 571
 572    foo = XCAR (list);
 573    CHECK_STRING (foo);
 574
 575    and later on did XSTRING (XCAR (list)), assuming that the type
 576    is correct (when it might be wrong, if the user substituted a
 577    correct value in the debugger).
 578
 579    To get around this, I made all the CHECK_foo macros signal a
 580    non-continuable error.  Places where a continuable error is OK
 581    (generally only when called directly on the argument of a Lisp
 582    primitive) should be changed to use CONCHECK().
 583
 584    FSF Emacs does not have this problem because RMS took the cheesy
 585    way out and disabled returning from a signal entirely. */
 586
 587 #define CONCHECK_RECORD(x, c_name) do {                 \
 588  if (!RECORD_TYPEP (x, lrecord_type_##c_name))          \
 589    x = wrong_type_argument (Q##c_name##p, x);           \
 590 }  while (0)
 591 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\
 592  if (XTYPE (x) != lisp_enum)                            \
 593    x = wrong_type_argument (predicate, x);              \
 594  } while (0)
 595 #define CHECK_RECORD(x, c_name) do {                    \
 596  if (!RECORD_TYPEP (x, lrecord_type_##c_name))          \
 597    dead_wrong_type_argument (Q##c_name##p, x);          \
 598  } while (0)
 599 #define CHECK_NONRECORD(x, lisp_enum, predicate) do {   \
 600  if (XTYPE (x) != lisp_enum)                            \
 601    dead_wrong_type_argument (predicate, x);             \
 602  } while (0)
 603
 604 void *alloc_lcrecord (size_t size, const struct lrecord_implementation *);
 605
 606 #define alloc_lcrecord_type(type, lrecord_implementation) \
 607   ((type *) alloc_lcrecord (sizeof (type), lrecord_implementation))
 608
 609 #ifdef UTF2000
 610 void *
 611 alloc_older_lcrecord (size_t size, const struct lrecord_implementation *);
 612
 613 #define alloc_older_lcrecord_type(type, lrecord_implementation) \
 614   ((type *) alloc_older_lcrecord (sizeof (type), lrecord_implementation))
 615 #endif
 616
 617 /* Copy the data from one lcrecord structure into another, but don't
 618    overwrite the header information. */
 619
 620 #define copy_lcrecord(dst, src)                                 \
 621   memcpy ((char *) (dst) + sizeof (struct lcrecord_header),     \
 622           (char *) (src) + sizeof (struct lcrecord_header),     \
 623           sizeof (*(dst)) - sizeof (struct lcrecord_header))
 624
 625 #define zero_lcrecord(lcr)                                      \
 626    memset ((char *) (lcr) + sizeof (struct lcrecord_header), 0, \
 627            sizeof (*(lcr)) - sizeof (struct lcrecord_header))
 628
 629 #endif /* INCLUDED_lrecord_h_ */