git.chise.org Git - chise/xemacs-chise.git.1/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
  80 struct lrecord_implementation;
  81 int lrecord_type_index (const struct lrecord_implementation *implementation);
  82
  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;                        \
  89 } while (0)
  90
  91 struct lcrecord_header
  92 {
  93   struct lrecord_header lheader;
  94
  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.
  98
  99      The `next' field may be used for other purposes as long as some
 100      other mechanism is provided for letting the GC do its work.
 101
 102      For example, the event and marker object types allocate members
 103      out of memory chunks, and are able to find all unmarked members
 104      by sweeping through the elements of the list of chunks.  */
 105   struct lcrecord_header *next;
 106
 107   /* The `uid' field is just for debugging/printing convenience.
 108      Having this slot doesn't hurt us much spacewise, since an
 109      lcrecord already has the above slots plus malloc overhead. */
 110   unsigned int uid :31;
 111
 112   /* The `free' field is a flag that indicates whether this lcrecord
 113      is on a "free list".  Free lists are used to minimize the number
 114      of calls to malloc() when we're repeatedly allocating and freeing
 115      a number of the same sort of lcrecord.  Lcrecords on a free list
 116      always get marked in a different fashion, so we can use this flag
 117      as a sanity check to make sure that free lists only have freed
 118      lcrecords and there are no freed lcrecords elsewhere. */
 119   unsigned int free :1;
 120 };
 121
 122 /* Used for lcrecords in an lcrecord-list. */
 123 struct free_lcrecord_header
 124 {
 125   struct lcrecord_header lcheader;
 126   Lisp_Object chain;
 127 };
 128
 129 enum lrecord_type
 130 {
 131   /* Symbol value magic types come first to make SYMBOL_VALUE_MAGIC_P fast.
 132      #### This should be replaced by a symbol_value_magic_p flag
 133      in the Lisp_Symbol lrecord_header. */
 134   lrecord_type_symbol_value_forward,
 135   lrecord_type_symbol_value_varalias,
 136   lrecord_type_symbol_value_lisp_magic,
 137   lrecord_type_symbol_value_buffer_local,
 138   lrecord_type_max_symbol_value_magic = lrecord_type_symbol_value_buffer_local,
 139
 140   lrecord_type_symbol,
 141   lrecord_type_subr,
 142   lrecord_type_cons,
 143   lrecord_type_vector,
 144   lrecord_type_string,
 145   lrecord_type_lcrecord_list,
 146   lrecord_type_compiled_function,
 147   lrecord_type_weak_list,
 148   lrecord_type_bit_vector,
 149   lrecord_type_float,
 150   lrecord_type_hash_table,
 151   lrecord_type_lstream,
 152   lrecord_type_process,
 153   lrecord_type_charset,
 154   lrecord_type_coding_system,
 155   lrecord_type_char_table,
 156   lrecord_type_char_table_entry,
 157   lrecord_type_range_table,
 158   lrecord_type_opaque,
 159   lrecord_type_opaque_ptr,
 160   lrecord_type_buffer,
 161   lrecord_type_extent,
 162   lrecord_type_extent_info,
 163   lrecord_type_extent_auxiliary,
 164   lrecord_type_marker,
 165   lrecord_type_event,
 166   lrecord_type_keymap,
 167   lrecord_type_command_builder,
 168   lrecord_type_timeout,
 169   lrecord_type_specifier,
 170   lrecord_type_console,
 171   lrecord_type_device,
 172   lrecord_type_frame,
 173   lrecord_type_window,
 174   lrecord_type_window_configuration,
 175   lrecord_type_gui_item,
 176   lrecord_type_popup_data,
 177   lrecord_type_toolbar_button,
 178   lrecord_type_color_instance,
 179   lrecord_type_font_instance,
 180   lrecord_type_image_instance,
 181   lrecord_type_glyph,
 182   lrecord_type_face,
 183   lrecord_type_database,
 184   lrecord_type_tooltalk_message,
 185   lrecord_type_tooltalk_pattern,
 186   lrecord_type_ldap,
 187   lrecord_type_pgconn,
 188   lrecord_type_pgresult,
 189   lrecord_type_devmode,
 190   lrecord_type_mswindows_dialog_id,
 191   lrecord_type_case_table,
 192   lrecord_type_emacs_ffi,
 193   lrecord_type_emacs_gtk_object,
 194   lrecord_type_emacs_gtk_boxed,
 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 */
 198 };
 199
 200 extern unsigned int lrecord_type_count;
 201
 202 struct lrecord_implementation
 203 {
 204   const char *name;
 205
 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);
 216
 217   /* `printer' converts the object to a printed representation.
 218      This can be NULL; in this case default_object_printer() will be
 219      used instead. */
 220   void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag);
 221
 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.
 227
 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);
 231
 232   /* This can be NULL, meaning compare objects with EQ(). */
 233   int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth);
 234
 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
 241      also NULL. */
 242   unsigned long (*hash) (Lisp_Object, int);
 243
 244   /* External data layout description */
 245   const struct lrecord_description *description;
 246
 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);
 254
 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(). */
 257   size_t static_size;
 258   size_t (*size_in_bytes_method) (const void *header);
 259
 260   /* The (constant) index into lrecord_implementations_table */
 261   enum lrecord_type lrecord_type_index;
 262
 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
 267      enabled. */
 268   unsigned int basic_p :1;
 269 };
 270
 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
 275
 276 extern const struct lrecord_implementation *lrecord_implementations_table[(unsigned int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT];
 277
 278 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \
 279    LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj))
 280 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type]
 281
 282 extern int gc_in_progress;
 283
 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))
 288
 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;                              \
 296 } while (0)
 297 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \
 298   ((void) ((lheader)->lisp_readonly = 1))
 299 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type]
 300
 301 /* External description stuff
 302
 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.
 307
 308    The description ends with a "XD_END" or "XD_SPECIFIER_END" record.
 309
 310    Some example descriptions :
 311
 312    static const struct lrecord_description cons_description[] = {
 313      { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) },
 314      { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) },
 315      { XD_END }
 316    };
 317
 318    Which means "two lisp objects starting at the 'car' and 'cdr' elements"
 319
 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) },
 324     { XD_END }
 325   };
 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'"
 328
 329   The existing types :
 330     XD_LISP_OBJECT
 331   A Lisp object.  This is also the type to use for pointers to other lrecords.
 332
 333     XD_LISP_OBJECT_ARRAY
 334   An array of Lisp objects or pointers to lrecords.
 335   The third element is the count.
 336
 337     XD_LO_LINK
 338   Link in a linked list of objects of the same type.
 339
 340     XD_OPAQUE_PTR
 341   Pointer to undumpable data.  Must be NULL when dumping.
 342
 343     XD_STRUCT_PTR
 344   Pointer to described struct.  Parameters are number of structures and
 345   struct_description.
 346
 347     XD_OPAQUE_DATA_PTR
 348   Pointer to dumpable opaque data.  Parameter is the size of the data.
 349   Pointed data must be relocatable without changes.
 350
 351     XD_C_STRING
 352   Pointer to a C string.
 353
 354     XD_DOC_STRING
 355   Pointer to a doc string (C string if positive, opaque value if negative)
 356
 357     XD_INT_RESET
 358   An integer which will be reset to a given value in the dump file.
 359
 360
 361     XD_SIZE_T
 362   size_t value.  Used for counts.
 363
 364     XD_INT
 365   int value.  Used for counts.
 366
 367     XD_LONG
 368   long value.  Used for counts.
 369
 370     XD_BYTECOUNT
 371   bytecount value.  Used for counts.
 372
 373     XD_END
 374   Special type indicating the end of the array.
 375
 376     XD_SPECIFIER_END
 377   Special type indicating the end of the array for a specifier.  Extra
 378   description is going to be fetched from the specifier methods.
 379
 380
 381   Special macros:
 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.
 386 */
 387
 388 enum lrecord_description_type {
 389   XD_LISP_OBJECT_ARRAY,
 390   XD_LISP_OBJECT,
 391   XD_LO_LINK,
 392   XD_OPAQUE_PTR,
 393   XD_STRUCT_PTR,
 394   XD_OPAQUE_DATA_PTR,
 395   XD_C_STRING,
 396   XD_DOC_STRING,
 397   XD_INT_RESET,
 398   XD_SIZE_T,
 399   XD_INT,
 400   XD_LONG,
 401   XD_BYTECOUNT,
 402   XD_END,
 403   XD_SPECIFIER_END
 404 };
 405
 406 struct lrecord_description {
 407   enum lrecord_description_type type;
 408   int offset;
 409   EMACS_INT data1;
 410   const struct struct_description *data2;
 411 };
 412
 413 struct struct_description {
 414   size_t size;
 415   const struct lrecord_description *description;
 416 };
 417
 418 #define XD_INDIRECT(val, delta) (-1-((val)|(delta<<8)))
 419
 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)
 423
 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) }
 428
 429 /* DEFINE_LRECORD_IMPLEMENTATION is for objects with constant size.
 430    DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION is for objects whose size varies.
 431  */
 432
 433 #if defined (ERROR_CHECK_TYPECHECK)
 434 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
 435 #else
 436 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
 437 #endif
 438
 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)
 441
 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)
 444
 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)
 447
 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)
 450
 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)
 453
 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)
 456
 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) \
 459
 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 }
 466
 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)
 469
 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)
 472
 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)
 475
 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)
 478
 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 }
 486
 487
 488 extern Lisp_Object (*lrecord_markers[]) (Lisp_Object);
 489
 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;         \
 494 } while (0)
 495
 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);                                    \
 500 } while (0)
 501
 502 #define LRECORDP(a) (XTYPE (a) == Lisp_Type_Record)
 503 #define XRECORD_LHEADER(a) ((struct lrecord_header *) XPNTR (a))
 504
 505 #define RECORD_TYPEP(x, ty) \
 506   (LRECORDP (x) && (((unsigned int)(XRECORD_LHEADER (x)->type)) == ((unsigned int)(ty))))
 507
 508 /* Steps to create a new object:
 509
 510    1. Declare the struct for your object in a header file somewhere.
 511    Remember that it must begin with
 512
 513    struct lcrecord_header header;
 514
 515    2. Put a DECLARE_LRECORD() for the object below the struct definition,
 516    along with the standard XFOO/XSETFOO junk.
 517
 518    3. Add this header file to inline.c.
 519
 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.
 522
 523    5. Define your object with DEFINE_LRECORD_IMPLEMENTATION() or some
 524    variant.
 525
 526    6. Include the header file in the .c file where you defined the object.
 527
 528    7. Put a call to INIT_LRECORD_IMPLEMENTATION() for the object in the
 529    .c file's syms_of_foo() function.
 530
 531    8. Add a type enum for the object to enum lrecord_type, earlier in this
 532    file.
 533
 534 An example:
 535
 536 ------------------------------ in toolbar.h -----------------------------
 537
 538 struct toolbar_button
 539 {
 540   struct lcrecord_header header;
 541
 542   Lisp_Object next;
 543   Lisp_Object frame;
 544
 545   Lisp_Object up_glyph;
 546   Lisp_Object down_glyph;
 547   Lisp_Object disabled_glyph;
 548
 549   Lisp_Object cap_up_glyph;
 550   Lisp_Object cap_down_glyph;
 551   Lisp_Object cap_disabled_glyph;
 552
 553   Lisp_Object callback;
 554   Lisp_Object enabled_p;
 555   Lisp_Object help_string;
 556
 557   char enabled;
 558   char down;
 559   char pushright;
 560   char blank;
 561
 562   int x, y;
 563   int width, height;
 564   int dirty;
 565   int vertical;
 566   int border_width;
 567 };
 568
 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)
 575
 576 ------------------------------ in toolbar.c -----------------------------
 577
 578 #include "toolbar.h"
 579
 580 ...
 581
 582 static Lisp_Object
 583 mark_toolbar_button (Lisp_Object obj)
 584 {
 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;
 597 }
 598
 599 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button,
 600                                mark_toolbar_button, 0, 0, 0, 0, 0,
 601                                struct toolbar_button);
 602
 603 ...
 604
 605 void
 606 syms_of_toolbar (void)
 607 {
 608   INIT_LRECORD_IMPLEMENTATION (toolbar_button);
 609
 610   ...;
 611 }
 612
 613 ------------------------------ in inline.c -----------------------------
 614
 615 #ifdef HAVE_TOOLBARS
 616 #include "toolbar.h"
 617 #endif
 618
 619 ------------------------------ in lrecord.h -----------------------------
 620
 621 enum lrecord_type
 622 {
 623   ...
 624   lrecord_type_toolbar_button,
 625   ...
 626 };
 627
 628 */
 629
 630 /*
 631
 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.
 636
 637 */
 638
 639
 640 #ifdef ERROR_CHECK_TYPECHECK
 641
 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)                          \
 648 {                                                               \
 649   assert (RECORD_TYPEP (obj, lrecord_type_##c_name));           \
 650   return (structtype *) XPNTR (obj);                            \
 651 }                                                               \
 652 extern Lisp_Object Q##c_name##p
 653
 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)                          \
 661 {                                                               \
 662   assert (RECORD_TYPEP (obj, lrecord_type_##c_name));           \
 663   return (structtype *) XPNTR (obj);                            \
 664 }                                                               \
 665 extern Lisp_Object Q##c_name##p
 666
 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)                          \
 672 {                                                               \
 673   assert (XTYPE (obj) == type_enum);                            \
 674   return (structtype *) XPNTR (obj);                            \
 675 }                                                               \
 676 extern Lisp_Object Q##c_name##p
 677
 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)
 680
 681 # define XSETRECORD(var, p, c_name) do                          \
 682 {                                                               \
 683   XSETOBJ (var, p);                                             \
 684   assert (RECORD_TYPEP (var, lrecord_type_##c_name));           \
 685 } while (0)
 686
 687 #else /* not ERROR_CHECK_TYPECHECK */
 688
 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)
 702
 703 #endif /* not ERROR_CHECK_TYPECHECK */
 704
 705 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name)
 706
 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
 714
 715    foo = XCAR (list);
 716    CHECK_STRING (foo);
 717
 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).
 721
 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().
 726
 727    FSF Emacs does not have this problem because RMS took the cheesy
 728    way out and disabled returning from a signal entirely. */
 729
 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);           \
 733 }  while (0)
 734 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\
 735  if (XTYPE (x) != lisp_enum)                            \
 736    x = wrong_type_argument (predicate, x);              \
 737  } while (0)
 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);          \
 741  } while (0)
 742 #define CHECK_NONRECORD(x, lisp_enum, predicate) do {   \
 743  if (XTYPE (x) != lisp_enum)                            \
 744    dead_wrong_type_argument (predicate, x);             \
 745  } while (0)
 746
 747 void *alloc_lcrecord (size_t size, const struct lrecord_implementation *);
 748
 749 #define alloc_lcrecord_type(type, lrecord_implementation) \
 750   ((type *) alloc_lcrecord (sizeof (type), lrecord_implementation))
 751
 752 /* Copy the data from one lcrecord structure into another, but don't
 753    overwrite the header information. */
 754
 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))
 759
 760 #define zero_lcrecord(lcr)                                      \
 761    memset ((char *) (lcr) + sizeof (struct lcrecord_header), 0, \
 762            sizeof (*(lcr)) - sizeof (struct lcrecord_header))
 763
 764 #endif /* INCLUDED_lrecord_h_ */