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