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_free, /* only used for "free" lrecords */
 193   lrecord_type_undefined, /* only used for debugging */
 194   lrecord_type_last_built_in_type /* must be last */
 195 };
 196
 197 extern unsigned int lrecord_type_count;
 198
 199 struct lrecord_implementation
 200 {
 201   const char *name;
 202
 203   /* `marker' is called at GC time, to make sure that all Lisp_Objects
 204      pointed to by this object get properly marked.  It should call
 205      the mark_object function on all Lisp_Objects in the object.  If
 206      the return value is non-nil, it should be a Lisp_Object to be
 207      marked (don't call the mark_object function explicitly on it,
 208      because the GC routines will do this).  Doing it this way reduces
 209      recursion, so the object returned should preferably be the one
 210      with the deepest level of Lisp_Object pointers.  This function
 211      can be NULL, meaning no GC marking is necessary. */
 212   Lisp_Object (*marker) (Lisp_Object);
 213
 214   /* `printer' converts the object to a printed representation.
 215      This can be NULL; in this case default_object_printer() will be
 216      used instead. */
 217   void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag);
 218
 219   /* `finalizer' is called at GC time when the object is about to
 220      be freed, and at dump time (FOR_DISKSAVE will be non-zero in this
 221      case).  It should perform any necessary cleanup (e.g. freeing
 222      malloc()ed memory).  This can be NULL, meaning no special
 223      finalization is necessary.
 224
 225      WARNING: remember that `finalizer' is called at dump time even
 226      though the object is not being freed. */
 227   void (*finalizer) (void *header, int for_disksave);
 228
 229   /* This can be NULL, meaning compare objects with EQ(). */
 230   int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth);
 231
 232   /* `hash' generates hash values for use with hash tables that have
 233      `equal' as their test function.  This can be NULL, meaning use
 234      the Lisp_Object itself as the hash.  But, you must still satisfy
 235      the constraint that if two objects are `equal', then they *must*
 236      hash to the same value in order for hash tables to work properly.
 237      This means that `hash' can be NULL only if the `equal' method is
 238      also NULL. */
 239   unsigned long (*hash) (Lisp_Object, int);
 240
 241   /* External data layout description */
 242   const struct lrecord_description *description;
 243
 244   /* These functions allow any object type to have builtin property
 245      lists that can be manipulated from the lisp level with
 246      `get', `put', `remprop', and `object-plist'. */
 247   Lisp_Object (*getprop) (Lisp_Object obj, Lisp_Object prop);
 248   int (*putprop) (Lisp_Object obj, Lisp_Object prop, Lisp_Object val);
 249   int (*remprop) (Lisp_Object obj, Lisp_Object prop);
 250   Lisp_Object (*plist) (Lisp_Object obj);
 251
 252   /* Only one of `static_size' and `size_in_bytes_method' is non-0.
 253      If both are 0, this type is not instantiable by alloc_lcrecord(). */
 254   size_t static_size;
 255   size_t (*size_in_bytes_method) (const void *header);
 256
 257   /* The (constant) index into lrecord_implementations_table */
 258   enum lrecord_type lrecord_type_index;
 259
 260   /* A "basic" lrecord is any lrecord that's not an lcrecord, i.e.
 261      one that does not have an lcrecord_header at the front and which
 262      is (usually) allocated in frob blocks.  We only use this flag for
 263      some consistency checking, and that only when error-checking is
 264      enabled. */
 265   unsigned int basic_p :1;
 266 };
 267
 268 /* All the built-in lisp object types are enumerated in `enum record_type'.
 269    Additional ones may be defined by a module (none yet).  We leave some
 270    room in `lrecord_implementations_table' for such new lisp object types. */
 271 #define MODULE_DEFINABLE_TYPE_COUNT 32
 272
 273 extern const struct lrecord_implementation *lrecord_implementations_table[(unsigned int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT];
 274
 275 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \
 276    LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj))
 277 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type]
 278
 279 extern int gc_in_progress;
 280
 281 #define MARKED_RECORD_P(obj) (XRECORD_LHEADER (obj)->mark)
 282 #define MARKED_RECORD_HEADER_P(lheader) ((lheader)->mark)
 283 #define MARK_RECORD_HEADER(lheader)   ((void) ((lheader)->mark = 1))
 284 #define UNMARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 0))
 285
 286 #define C_READONLY_RECORD_HEADER_P(lheader)  ((lheader)->c_readonly)
 287 #define LISP_READONLY_RECORD_HEADER_P(lheader)  ((lheader)->lisp_readonly)
 288 #define SET_C_READONLY_RECORD_HEADER(lheader) do {      \
 289   struct lrecord_header *SCRRH_lheader = (lheader);     \
 290   SCRRH_lheader->c_readonly = 1;                        \
 291   SCRRH_lheader->lisp_readonly = 1;                     \
 292   SCRRH_lheader->mark = 1;                              \
 293 } while (0)
 294 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \
 295   ((void) ((lheader)->lisp_readonly = 1))
 296 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type]
 297
 298 /* External description stuff
 299
 300    A lrecord external description  is an array  of values.  The  first
 301    value of each line is a type, the second  the offset in the lrecord
 302    structure.  Following values  are parameters, their  presence, type
 303    and number is type-dependent.
 304
 305    The description ends with a "XD_END" or "XD_SPECIFIER_END" record.
 306
 307    Some example descriptions :
 308
 309    static const struct lrecord_description cons_description[] = {
 310      { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) },
 311      { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) },
 312      { XD_END }
 313    };
 314
 315    Which means "two lisp objects starting at the 'car' and 'cdr' elements"
 316
 317   static const struct lrecord_description string_description[] = {
 318     { XD_BYTECOUNT,       offsetof (Lisp_String, size) },
 319     { XD_OPAQUE_DATA_PTR, offsetof (Lisp_String, data), XD_INDIRECT(0, 1) },
 320     { XD_LISP_OBJECT,     offsetof (Lisp_String, plist) },
 321     { XD_END }
 322   };
 323   "A pointer to string data at 'data', the size of the pointed array being the value
 324    of the size variable plus 1, and one lisp object at 'plist'"
 325
 326   The existing types :
 327     XD_LISP_OBJECT
 328   A Lisp object.  This is also the type to use for pointers to other lrecords.
 329
 330     XD_LISP_OBJECT_ARRAY
 331   An array of Lisp objects or pointers to lrecords.
 332   The third element is the count.
 333
 334     XD_LO_LINK
 335   Link in a linked list of objects of the same type.
 336
 337     XD_OPAQUE_PTR
 338   Pointer to undumpable data.  Must be NULL when dumping.
 339
 340     XD_STRUCT_PTR
 341   Pointer to described struct.  Parameters are number of structures and
 342   struct_description.
 343
 344     XD_OPAQUE_DATA_PTR
 345   Pointer to dumpable opaque data.  Parameter is the size of the data.
 346   Pointed data must be relocatable without changes.
 347
 348     XD_C_STRING
 349   Pointer to a C string.
 350
 351     XD_DOC_STRING
 352   Pointer to a doc string (C string if positive, opaque value if negative)
 353
 354     XD_INT_RESET
 355   An integer which will be reset to a given value in the dump file.
 356
 357
 358     XD_SIZE_T
 359   size_t value.  Used for counts.
 360
 361     XD_INT
 362   int value.  Used for counts.
 363
 364     XD_LONG
 365   long value.  Used for counts.
 366
 367     XD_BYTECOUNT
 368   bytecount value.  Used for counts.
 369
 370     XD_END
 371   Special type indicating the end of the array.
 372
 373     XD_SPECIFIER_END
 374   Special type indicating the end of the array for a specifier.  Extra
 375   description is going to be fetched from the specifier methods.
 376
 377
 378   Special macros:
 379     XD_INDIRECT(line, delta)
 380   Usable where  a "count" or "size"  is requested.  Gives the value of
 381   the element which is at line number 'line' in the description (count
 382   starts at zero) and adds delta to it.
 383 */
 384
 385 enum lrecord_description_type {
 386   XD_LISP_OBJECT_ARRAY,
 387   XD_LISP_OBJECT,
 388   XD_LO_LINK,
 389   XD_OPAQUE_PTR,
 390   XD_STRUCT_PTR,
 391   XD_OPAQUE_DATA_PTR,
 392   XD_C_STRING,
 393   XD_DOC_STRING,
 394   XD_INT_RESET,
 395   XD_SIZE_T,
 396   XD_INT,
 397   XD_LONG,
 398   XD_BYTECOUNT,
 399   XD_END,
 400   XD_SPECIFIER_END
 401 };
 402
 403 struct lrecord_description {
 404   enum lrecord_description_type type;
 405   int offset;
 406   EMACS_INT data1;
 407   const struct struct_description *data2;
 408 };
 409
 410 struct struct_description {
 411   size_t size;
 412   const struct lrecord_description *description;
 413 };
 414
 415 #define XD_INDIRECT(val, delta) (-1-((val)|(delta<<8)))
 416
 417 #define XD_IS_INDIRECT(code) (code<0)
 418 #define XD_INDIRECT_VAL(code) ((-1-code) & 255)
 419 #define XD_INDIRECT_DELTA(code) (((-1-code)>>8) & 255)
 420
 421 #define XD_DYNARR_DESC(base_type, sub_desc) \
 422   { XD_STRUCT_PTR, offsetof (base_type, base), XD_INDIRECT(1, 0), sub_desc }, \
 423   { XD_INT,        offsetof (base_type, cur) }, \
 424   { XD_INT_RESET,  offsetof (base_type, max), XD_INDIRECT(1, 0) }
 425
 426 /* DEFINE_LRECORD_IMPLEMENTATION is for objects with constant size.
 427    DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION is for objects whose size varies.
 428  */
 429
 430 #if defined (ERROR_CHECK_TYPECHECK)
 431 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
 432 #else
 433 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
 434 #endif
 435
 436 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
 437 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
 438
 439 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
 440 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof(structtype),0,1,structtype)
 441
 442 #define DEFINE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
 443 DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
 444
 445 #define DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
 446 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
 447
 448 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
 449 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
 450
 451 #define DEFINE_BASIC_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
 452 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,0,sizer,1,structtype)
 453
 454 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
 455 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype) \
 456
 457 #define MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
 458 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)                       \
 459 const struct lrecord_implementation lrecord_##c_name =                  \
 460   { name, marker, printer, nuker, equal, hash, desc,                    \
 461     getprop, putprop, remprop, plist, size, sizer,                      \
 462     lrecord_type_##c_name, basic_p }
 463
 464 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
 465 DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
 466
 467 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
 468 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
 469
 470 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
 471 DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
 472
 473 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
 474 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype)
 475
 476 #define MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
 477 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)                       \
 478 unsigned int lrecord_type_##c_name;                                     \
 479 struct lrecord_implementation lrecord_##c_name =                        \
 480   { name, marker, printer, nuker, equal, hash, desc,                    \
 481     getprop, putprop, remprop, plist, size, sizer,                      \
 482     lrecord_type_last_built_in_type, basic_p }
 483
 484
 485 extern Lisp_Object (*lrecord_markers[]) (Lisp_Object);
 486
 487 #define INIT_LRECORD_IMPLEMENTATION(type) do {                          \
 488   lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \
 489   lrecord_markers[lrecord_type_##type] =                                \
 490     lrecord_implementations_table[lrecord_type_##type]->marker;         \
 491 } while (0)
 492
 493 #define INIT_EXTERNAL_LRECORD_IMPLEMENTATION(type) do {                 \
 494   lrecord_type_##type = lrecord_type_count++;                           \
 495   lrecord_##type.lrecord_type_index = lrecord_type_##type;              \
 496   INIT_LRECORD_IMPLEMENTATION(type);                                    \
 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) && (((unsigned int)(XRECORD_LHEADER (x)->type)) == ((unsigned int)(ty))))
 504
 505 /* Steps to create a new object:
 506
 507    1. Declare the struct for your object in a header file somewhere.
 508    Remember that it must begin with
 509
 510    struct lcrecord_header header;
 511
 512    2. Put a DECLARE_LRECORD() for the object below the struct definition,
 513    along with the standard XFOO/XSETFOO junk.
 514
 515    3. Add this header file to inline.c.
 516
 517    4. Create the methods for your object.  Note that technically you don't
 518    need any, but you will almost always want at least a mark method.
 519
 520    5. Define your object with DEFINE_LRECORD_IMPLEMENTATION() or some
 521    variant.
 522
 523    6. Include the header file in the .c file where you defined the object.
 524
 525    7. Put a call to INIT_LRECORD_IMPLEMENTATION() for the object in the
 526    .c file's syms_of_foo() function.
 527
 528    8. Add a type enum for the object to enum lrecord_type, earlier in this
 529    file.
 530
 531 An example:
 532
 533 ------------------------------ in toolbar.h -----------------------------
 534
 535 struct toolbar_button
 536 {
 537   struct lcrecord_header header;
 538
 539   Lisp_Object next;
 540   Lisp_Object frame;
 541
 542   Lisp_Object up_glyph;
 543   Lisp_Object down_glyph;
 544   Lisp_Object disabled_glyph;
 545
 546   Lisp_Object cap_up_glyph;
 547   Lisp_Object cap_down_glyph;
 548   Lisp_Object cap_disabled_glyph;
 549
 550   Lisp_Object callback;
 551   Lisp_Object enabled_p;
 552   Lisp_Object help_string;
 553
 554   char enabled;
 555   char down;
 556   char pushright;
 557   char blank;
 558
 559   int x, y;
 560   int width, height;
 561   int dirty;
 562   int vertical;
 563   int border_width;
 564 };
 565
 566 DECLARE_LRECORD (toolbar_button, struct toolbar_button);
 567 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button)
 568 #define XSETTOOLBAR_BUTTON(x, p) XSETRECORD (x, p, toolbar_button)
 569 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button)
 570 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button)
 571 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button)
 572
 573 ------------------------------ in toolbar.c -----------------------------
 574
 575 #include "toolbar.h"
 576
 577 ...
 578
 579 static Lisp_Object
 580 mark_toolbar_button (Lisp_Object obj)
 581 {
 582   struct toolbar_button *data = XTOOLBAR_BUTTON (obj);
 583   mark_object (data->next);
 584   mark_object (data->frame);
 585   mark_object (data->up_glyph);
 586   mark_object (data->down_glyph);
 587   mark_object (data->disabled_glyph);
 588   mark_object (data->cap_up_glyph);
 589   mark_object (data->cap_down_glyph);
 590   mark_object (data->cap_disabled_glyph);
 591   mark_object (data->callback);
 592   mark_object (data->enabled_p);
 593   return data->help_string;
 594 }
 595
 596 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button,
 597                                mark_toolbar_button, 0, 0, 0, 0, 0,
 598                                struct toolbar_button);
 599
 600 ...
 601
 602 void
 603 syms_of_toolbar (void)
 604 {
 605   INIT_LRECORD_IMPLEMENTATION (toolbar_button);
 606
 607   ...;
 608 }
 609
 610 ------------------------------ in inline.c -----------------------------
 611
 612 #ifdef HAVE_TOOLBARS
 613 #include "toolbar.h"
 614 #endif
 615
 616 ------------------------------ in lrecord.h -----------------------------
 617
 618 enum lrecord_type
 619 {
 620   ...
 621   lrecord_type_toolbar_button,
 622   ...
 623 };
 624
 625 */
 626
 627 /*
 628
 629 Note: Object types defined in external dynamically-loaded modules (not
 630 part of the XEmacs main source code) should use DECLARE_EXTERNAL_LRECORD
 631 and DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION rather than DECLARE_LRECORD
 632 and DEFINE_LRECORD_IMPLEMENTATION.
 633
 634 */
 635
 636
 637 #ifdef ERROR_CHECK_TYPECHECK
 638
 639 # define DECLARE_LRECORD(c_name, structtype)                    \
 640 extern const struct lrecord_implementation lrecord_##c_name;    \
 641 INLINE_HEADER structtype *                                      \
 642 error_check_##c_name (Lisp_Object obj);                         \
 643 INLINE_HEADER structtype *                                      \
 644 error_check_##c_name (Lisp_Object obj)                          \
 645 {                                                               \
 646   assert (RECORD_TYPEP (obj, lrecord_type_##c_name));           \
 647   return (structtype *) XPNTR (obj);                            \
 648 }                                                               \
 649 extern Lisp_Object Q##c_name##p
 650
 651 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype)           \
 652 extern unsigned int lrecord_type_##c_name;                      \
 653 extern struct lrecord_implementation lrecord_##c_name;          \
 654 INLINE_HEADER structtype *                                      \
 655 error_check_##c_name (Lisp_Object obj);                         \
 656 INLINE_HEADER structtype *                                      \
 657 error_check_##c_name (Lisp_Object obj)                          \
 658 {                                                               \
 659   assert (RECORD_TYPEP (obj, lrecord_type_##c_name));           \
 660   return (structtype *) XPNTR (obj);                            \
 661 }                                                               \
 662 extern Lisp_Object Q##c_name##p
 663
 664 # define DECLARE_NONRECORD(c_name, type_enum, structtype)       \
 665 INLINE_HEADER structtype *                                      \
 666 error_check_##c_name (Lisp_Object obj);                         \
 667 INLINE_HEADER structtype *                                      \
 668 error_check_##c_name (Lisp_Object obj)                          \
 669 {                                                               \
 670   assert (XTYPE (obj) == type_enum);                            \
 671   return (structtype *) XPNTR (obj);                            \
 672 }                                                               \
 673 extern Lisp_Object Q##c_name##p
 674
 675 # define XRECORD(x, c_name, structtype) error_check_##c_name (x)
 676 # define XNONRECORD(x, c_name, type_enum, structtype) error_check_##c_name (x)
 677
 678 # define XSETRECORD(var, p, c_name) do                          \
 679 {                                                               \
 680   XSETOBJ (var, p);                                             \
 681   assert (RECORD_TYPEP (var, lrecord_type_##c_name));           \
 682 } while (0)
 683
 684 #else /* not ERROR_CHECK_TYPECHECK */
 685
 686 # define DECLARE_LRECORD(c_name, structtype)                    \
 687 extern Lisp_Object Q##c_name##p;                                \
 688 extern const struct lrecord_implementation lrecord_##c_name
 689 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype)           \
 690 extern Lisp_Object Q##c_name##p;                                \
 691 extern unsigned int lrecord_type_##c_name;                      \
 692 extern struct lrecord_implementation lrecord_##c_name
 693 # define DECLARE_NONRECORD(c_name, type_enum, structtype)       \
 694 extern Lisp_Object Q##c_name##p
 695 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x))
 696 # define XNONRECORD(x, c_name, type_enum, structtype)           \
 697   ((structtype *) XPNTR (x))
 698 # define XSETRECORD(var, p, c_name) XSETOBJ (var, p)
 699
 700 #endif /* not ERROR_CHECK_TYPECHECK */
 701
 702 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name)
 703
 704 /* Note: we now have two different kinds of type-checking macros.
 705    The "old" kind has now been renamed CONCHECK_foo.  The reason for
 706    this is that the CONCHECK_foo macros signal a continuable error,
 707    allowing the user (through debug-on-error) to substitute a different
 708    value and return from the signal, which causes the lvalue argument
 709    to get changed.  Quite a lot of code would crash if that happened,
 710    because it did things like
 711
 712    foo = XCAR (list);
 713    CHECK_STRING (foo);
 714
 715    and later on did XSTRING (XCAR (list)), assuming that the type
 716    is correct (when it might be wrong, if the user substituted a
 717    correct value in the debugger).
 718
 719    To get around this, I made all the CHECK_foo macros signal a
 720    non-continuable error.  Places where a continuable error is OK
 721    (generally only when called directly on the argument of a Lisp
 722    primitive) should be changed to use CONCHECK().
 723
 724    FSF Emacs does not have this problem because RMS took the cheesy
 725    way out and disabled returning from a signal entirely. */
 726
 727 #define CONCHECK_RECORD(x, c_name) do {                 \
 728  if (!RECORD_TYPEP (x, lrecord_type_##c_name))          \
 729    x = wrong_type_argument (Q##c_name##p, x);           \
 730 }  while (0)
 731 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\
 732  if (XTYPE (x) != lisp_enum)                            \
 733    x = wrong_type_argument (predicate, x);              \
 734  } while (0)
 735 #define CHECK_RECORD(x, c_name) do {                    \
 736  if (!RECORD_TYPEP (x, lrecord_type_##c_name))          \
 737    dead_wrong_type_argument (Q##c_name##p, x);          \
 738  } while (0)
 739 #define CHECK_NONRECORD(x, lisp_enum, predicate) do {   \
 740  if (XTYPE (x) != lisp_enum)                            \
 741    dead_wrong_type_argument (predicate, x);             \
 742  } while (0)
 743
 744 void *alloc_lcrecord (size_t size, const struct lrecord_implementation *);
 745
 746 #define alloc_lcrecord_type(type, lrecord_implementation) \
 747   ((type *) alloc_lcrecord (sizeof (type), lrecord_implementation))
 748
 749 /* Copy the data from one lcrecord structure into another, but don't
 750    overwrite the header information. */
 751
 752 #define copy_lcrecord(dst, src)                                 \
 753   memcpy ((char *) (dst) + sizeof (struct lcrecord_header),     \
 754           (char *) (src) + sizeof (struct lcrecord_header),     \
 755           sizeof (*(dst)) - sizeof (struct lcrecord_header))
 756
 757 #define zero_lcrecord(lcr)                                      \
 758    memset ((char *) (lcr) + sizeof (struct lcrecord_header), 0, \
 759            sizeof (*(lcr)) - sizeof (struct lcrecord_header))
 760
 761 #endif /* INCLUDED_lrecord_h_ */