src/lrecord.h

   1 /* The "lrecord" structure (header of a compound lisp object).
   2    Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
   3    Copyright (C) 1996 Ben Wing.
   4
   5 This file is part of XEmacs.
   6
   7 XEmacs is free software; you can redistribute it and/or modify it
   8 under the terms of the GNU General Public License as published by the
   9 Free Software Foundation; either version 2, or (at your option) any
  10 later version.
  11
  12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with XEmacs; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22 /* Synched up with: Not in FSF. */
  23
  24 #ifndef INCLUDED_lrecord_h_
  25 #define INCLUDED_lrecord_h_
  26
  27 /* The "lrecord" type of Lisp object is used for all object types
  28    other than a few simple ones.  This allows many types to be
  29    implemented but only a few bits required in a Lisp object for type
  30    information. (The tradeoff is that each object has its type marked
  31    in it, thereby increasing its size.) All lrecords begin with a
  32    `struct lrecord_header', which identifies the lisp object type, by
  33    providing an index into a table of `struct lrecord_implementation',
  34    which describes the behavior of the lisp object.  It also contains
  35    some other data bits.
  36
  37    Lrecords are of two types: straight lrecords, and lcrecords.
  38    Straight lrecords are used for those types of objects that have
  39    their own allocation routines (typically allocated out of 2K chunks
  40    of memory called `frob blocks').  These objects have a `struct
  41    lrecord_header' at the top, containing only the bits needed to find
  42    the lrecord_implementation for the object.  There are special
  43    routines in alloc.c to deal with each such object type.
  44
  45    Lcrecords are used for less common sorts of objects that don't do
  46    their own allocation.  Each such object is malloc()ed individually,
  47    and the objects are chained together through a `next' pointer.
  48    Lcrecords have a `struct lcrecord_header' at the top, which
  49    contains a `struct lrecord_header' and a `next' pointer, and are
  50    allocated using alloc_lcrecord().
  51
  52    Creating a new lcrecord type is fairly easy; just follow the
  53    lead of some existing type (e.g. hash tables).  Note that you
  54    do not need to supply all the methods (see below); reasonable
  55    defaults are provided for many of them.  Alternatively, if you're
  56    just looking for a way of encapsulating data (which possibly
  57    could contain Lisp_Objects in it), you may well be able to use
  58    the opaque type. */
  59
  60 struct lrecord_header
  61 {
  62   /* index into lrecord_implementations_table[] */
  63   unsigned int type :8;
  64
  65   /* If `mark' is 0 after the GC mark phase, the object will be freed
  66      during the GC sweep phase.  There are 2 ways that `mark' can be 1:
  67      - by being referenced from other objects during the GC mark phase
  68      - because it is permanently on, for c_readonly objects */
  69   unsigned int mark :1;
  70
  71   /* 1 if the object resides in logically read-only space, and does not
  72      reference other non-c_readonly objects.
  73      Invariant: if (c_readonly == 1), then (mark == 1 && lisp_readonly == 1) */
  74   unsigned int c_readonly :1;
  75
  76   /* 1 if the object is readonly from lisp */
  77   unsigned int lisp_readonly :1;
  78
  79 #ifdef UTF2000
  80   /* The `older field is a flag that indicates whether this lcrecord
  81      is on a "older storage". */
  82   unsigned int older :1;
  83 #endif
  84 };
  85
  86 struct lrecord_implementation;
  87 int lrecord_type_index (const struct lrecord_implementation *implementation);
  88
  89 #ifdef UTF2000
  90 #define set_lheader_implementation(header,imp) do {     \
  91   struct lrecord_header* SLI_header = (header);         \
  92   SLI_header->type = (imp)->lrecord_type_index;         \
  93   SLI_header->mark = 0;                                 \
  94   SLI_header->older = 0;                                \
  95   SLI_header->c_readonly = 0;                           \
  96   SLI_header->lisp_readonly = 0;                        \
  97 } while (0)
  98 #define set_lheader_older_implementation(header,imp) do {       \
  99   struct lrecord_header* SLI_header = (header);                 \
 100   SLI_header->type = (imp)->lrecord_type_index;                 \
 101   SLI_header->mark = 0;                                         \
 102   SLI_header->older = 1;                                        \
 103   SLI_header->c_readonly = 0;                                   \
 104   SLI_header->lisp_readonly = 0;                                \
 105 } while (0)
 106 #else
 107 #define set_lheader_implementation(header,imp) do {     \
 108   struct lrecord_header* SLI_header = (header);         \
 109   SLI_header->type = (imp)->lrecord_type_index;         \
 110   SLI_header->mark = 0;                                 \
 111   SLI_header->c_readonly = 0;                           \
 112   SLI_header->lisp_readonly = 0;                        \
 113 } while (0)
 114 #endif
 115
 116 struct lcrecord_header
 117 {
 118   struct lrecord_header lheader;
 119
 120   /* The `next' field is normally used to chain all lcrecords together
 121      so that the GC can find (and free) all of them.
 122      `alloc_lcrecord' threads lcrecords together.
 123
 124      The `next' field may be used for other purposes as long as some
 125      other mechanism is provided for letting the GC do its work.
 126
 127      For example, the event and marker object types allocate members
 128      out of memory chunks, and are able to find all unmarked members
 129      by sweeping through the elements of the list of chunks.  */
 130   struct lcrecord_header *next;
 131
 132   /* The `uid' field is just for debugging/printing convenience.
 133      Having this slot doesn't hurt us much spacewise, since an
 134      lcrecord already has the above slots plus malloc overhead. */
 135   unsigned int uid :31;
 136
 137   /* The `free' field is a flag that indicates whether this lcrecord
 138      is on a "free list".  Free lists are used to minimize the number
 139      of calls to malloc() when we're repeatedly allocating and freeing
 140      a number of the same sort of lcrecord.  Lcrecords on a free list
 141      always get marked in a different fashion, so we can use this flag
 142      as a sanity check to make sure that free lists only have freed
 143      lcrecords and there are no freed lcrecords elsewhere. */
 144   unsigned int free :1;
 145 };
 146
 147 /* Used for lcrecords in an lcrecord-list. */
 148 struct free_lcrecord_header
 149 {
 150   struct lcrecord_header lcheader;
 151   Lisp_Object chain;
 152 };
 153
 154 enum lrecord_type
 155 {
 156   /* Symbol value magic types come first to make SYMBOL_VALUE_MAGIC_P fast.
 157      #### This should be replaced by a symbol_value_magic_p flag
 158      in the Lisp_Symbol lrecord_header. */
 159   lrecord_type_symbol_value_forward,
 160   lrecord_type_symbol_value_varalias,
 161   lrecord_type_symbol_value_lisp_magic,
 162   lrecord_type_symbol_value_buffer_local,
 163   lrecord_type_max_symbol_value_magic = lrecord_type_symbol_value_buffer_local,
 164
 165   lrecord_type_symbol,
 166   lrecord_type_subr,
 167   lrecord_type_cons,
 168   lrecord_type_vector,
 169   lrecord_type_string,
 170   lrecord_type_lcrecord_list,
 171   lrecord_type_compiled_function,
 172   lrecord_type_weak_list,
 173   lrecord_type_bit_vector,
 174   lrecord_type_float,
 175   lrecord_type_hash_table,
 176   lrecord_type_lstream,
 177   lrecord_type_process,
 178   lrecord_type_charset,
 179   lrecord_type_coding_system,
 180   lrecord_type_char_table,
 181   lrecord_type_char_table_entry,
 182   lrecord_type_char_id_table,
 183   lrecord_type_byte_table,
 184   lrecord_type_uint16_byte_table,
 185   lrecord_type_uint8_byte_table,
 186   lrecord_type_range_table,
 187   lrecord_type_opaque,
 188   lrecord_type_opaque_ptr,
 189   lrecord_type_buffer,
 190   lrecord_type_extent,
 191   lrecord_type_extent_info,
 192   lrecord_type_extent_auxiliary,
 193   lrecord_type_marker,
 194   lrecord_type_event,
 195   lrecord_type_keymap,
 196   lrecord_type_command_builder,
 197   lrecord_type_timeout,
 198   lrecord_type_specifier,
 199   lrecord_type_console,
 200   lrecord_type_device,
 201   lrecord_type_frame,
 202   lrecord_type_window,
 203   lrecord_type_window_configuration,
 204   lrecord_type_gui_item,
 205   lrecord_type_popup_data,
 206   lrecord_type_toolbar_button,
 207   lrecord_type_color_instance,
 208   lrecord_type_font_instance,
 209   lrecord_type_image_instance,
 210   lrecord_type_glyph,
 211   lrecord_type_face,
 212   lrecord_type_database,
 213   lrecord_type_tooltalk_message,
 214   lrecord_type_tooltalk_pattern,
 215   lrecord_type_ldap,
 216   lrecord_type_pgconn,
 217   lrecord_type_pgresult,
 218   lrecord_type_devmode,
 219   lrecord_type_mswindows_dialog_id,
 220   lrecord_type_case_table,
 221   lrecord_type_last_built_in_type /* must be last */
 222 };
 223
 224 extern unsigned int lrecord_type_count;
 225
 226 struct lrecord_implementation
 227 {
 228   const char *name;
 229
 230   /* `marker' is called at GC time, to make sure that all Lisp_Objects
 231      pointed to by this object get properly marked.  It should call
 232      the mark_object function on all Lisp_Objects in the object.  If
 233      the return value is non-nil, it should be a Lisp_Object to be
 234      marked (don't call the mark_object function explicitly on it,
 235      because the GC routines will do this).  Doing it this way reduces
 236      recursion, so the object returned should preferably be the one
 237      with the deepest level of Lisp_Object pointers.  This function
 238      can be NULL, meaning no GC marking is necessary. */
 239   Lisp_Object (*marker) (Lisp_Object);
 240
 241   /* `printer' converts the object to a printed representation.
 242      This can be NULL; in this case default_object_printer() will be
 243      used instead. */
 244   void (*printer) (Lisp_Object, Lisp_Object printcharfun, int escapeflag);
 245
 246   /* `finalizer' is called at GC time when the object is about to
 247      be freed, and at dump time (FOR_DISKSAVE will be non-zero in this
 248      case).  It should perform any necessary cleanup (e.g. freeing
 249      malloc()ed memory).  This can be NULL, meaning no special
 250      finalization is necessary.
 251
 252      WARNING: remember that `finalizer' is called at dump time even
 253      though the object is not being freed. */
 254   void (*finalizer) (void *header, int for_disksave);
 255
 256   /* This can be NULL, meaning compare objects with EQ(). */
 257   int (*equal) (Lisp_Object obj1, Lisp_Object obj2, int depth);
 258
 259   /* `hash' generates hash values for use with hash tables that have
 260      `equal' as their test function.  This can be NULL, meaning use
 261      the Lisp_Object itself as the hash.  But, you must still satisfy
 262      the constraint that if two objects are `equal', then they *must*
 263      hash to the same value in order for hash tables to work properly.
 264      This means that `hash' can be NULL only if the `equal' method is
 265      also NULL. */
 266   unsigned long (*hash) (Lisp_Object, int);
 267
 268   /* External data layout description */
 269   const struct lrecord_description *description;
 270
 271   /* These functions allow any object type to have builtin property
 272      lists that can be manipulated from the lisp level with
 273      `get', `put', `remprop', and `object-plist'. */
 274   Lisp_Object (*getprop) (Lisp_Object obj, Lisp_Object prop);
 275   int (*putprop) (Lisp_Object obj, Lisp_Object prop, Lisp_Object val);
 276   int (*remprop) (Lisp_Object obj, Lisp_Object prop);
 277   Lisp_Object (*plist) (Lisp_Object obj);
 278
 279   /* Only one of `static_size' and `size_in_bytes_method' is non-0.
 280      If both are 0, this type is not instantiable by alloc_lcrecord(). */
 281   size_t static_size;
 282   size_t (*size_in_bytes_method) (const void *header);
 283
 284   /* The (constant) index into lrecord_implementations_table */
 285   enum lrecord_type lrecord_type_index;
 286
 287   /* A "basic" lrecord is any lrecord that's not an lcrecord, i.e.
 288      one that does not have an lcrecord_header at the front and which
 289      is (usually) allocated in frob blocks.  We only use this flag for
 290      some consistency checking, and that only when error-checking is
 291      enabled. */
 292   unsigned int basic_p :1;
 293 };
 294
 295 /* All the built-in lisp object types are enumerated in `enum record_type'.
 296    Additional ones may be defined by a module (none yet).  We leave some
 297    room in `lrecord_implementations_table' for such new lisp object types. */
 298 #define MODULE_DEFINABLE_TYPE_COUNT 32
 299
 300 extern const struct lrecord_implementation *lrecord_implementations_table[(unsigned int)lrecord_type_last_built_in_type + MODULE_DEFINABLE_TYPE_COUNT];
 301
 302 #define XRECORD_LHEADER_IMPLEMENTATION(obj) \
 303    LHEADER_IMPLEMENTATION (XRECORD_LHEADER (obj))
 304 #define LHEADER_IMPLEMENTATION(lh) lrecord_implementations_table[(lh)->type]
 305
 306 extern int gc_in_progress;
 307
 308 #define MARKED_RECORD_P(obj) (XRECORD_LHEADER (obj)->mark)
 309 #define MARKED_RECORD_HEADER_P(lheader) ((lheader)->mark)
 310 #define MARK_RECORD_HEADER(lheader)   ((void) ((lheader)->mark = 1))
 311 #define UNMARK_RECORD_HEADER(lheader) ((void) ((lheader)->mark = 0))
 312
 313 #define OLDER_RECORD_P(obj) (XRECORD_LHEADER (obj)->older)
 314 #define OLDER_RECORD_HEADER_P(lheader) ((lheader)->older)
 315
 316
 317 #define C_READONLY_RECORD_HEADER_P(lheader)  ((lheader)->c_readonly)
 318 #define LISP_READONLY_RECORD_HEADER_P(lheader)  ((lheader)->lisp_readonly)
 319 #define SET_C_READONLY_RECORD_HEADER(lheader) do {      \
 320   struct lrecord_header *SCRRH_lheader = (lheader);     \
 321   SCRRH_lheader->c_readonly = 1;                        \
 322   SCRRH_lheader->lisp_readonly = 1;                     \
 323   SCRRH_lheader->mark = 1;                              \
 324 } while (0)
 325 #define SET_LISP_READONLY_RECORD_HEADER(lheader) \
 326   ((void) ((lheader)->lisp_readonly = 1))
 327 #define RECORD_MARKER(lheader) lrecord_markers[(lheader)->type]
 328
 329 /* External description stuff
 330
 331    A lrecord external description  is an array  of values.  The  first
 332    value of each line is a type, the second  the offset in the lrecord
 333    structure.  Following values  are parameters, their  presence, type
 334    and number is type-dependent.
 335
 336    The description ends with a "XD_END" or "XD_SPECIFIER_END" record.
 337
 338    Some example descriptions :
 339
 340    static const struct lrecord_description cons_description[] = {
 341      { XD_LISP_OBJECT, offsetof (Lisp_Cons, car) },
 342      { XD_LISP_OBJECT, offsetof (Lisp_Cons, cdr) },
 343      { XD_END }
 344    };
 345
 346    Which means "two lisp objects starting at the 'car' and 'cdr' elements"
 347
 348   static const struct lrecord_description string_description[] = {
 349     { XD_BYTECOUNT,       offsetof (Lisp_String, size) },
 350     { XD_OPAQUE_DATA_PTR, offsetof (Lisp_String, data), XD_INDIRECT(0, 1) },
 351     { XD_LISP_OBJECT,     offsetof (Lisp_String, plist) },
 352     { XD_END }
 353   };
 354   "A pointer to string data at 'data', the size of the pointed array being the value
 355    of the size variable plus 1, and one lisp object at 'plist'"
 356
 357   The existing types :
 358     XD_LISP_OBJECT
 359   A Lisp object.  This is also the type to use for pointers to other lrecords.
 360
 361     XD_LISP_OBJECT_ARRAY
 362   An array of Lisp objects or pointers to lrecords.
 363   The third element is the count.
 364
 365     XD_LO_LINK
 366   Link in a linked list of objects of the same type.
 367
 368     XD_OPAQUE_PTR
 369   Pointer to undumpable data.  Must be NULL when dumping.
 370
 371     XD_STRUCT_PTR
 372   Pointer to described struct.  Parameters are number of structures and
 373   struct_description.
 374
 375     XD_OPAQUE_DATA_PTR
 376   Pointer to dumpable opaque data.  Parameter is the size of the data.
 377   Pointed data must be relocatable without changes.
 378
 379     XD_C_STRING
 380   Pointer to a C string.
 381
 382     XD_DOC_STRING
 383   Pointer to a doc string (C string if positive, opaque value if negative)
 384
 385     XD_INT_RESET
 386   An integer which will be reset to a given value in the dump file.
 387
 388
 389     XD_SIZE_T
 390   size_t value.  Used for counts.
 391
 392     XD_INT
 393   int value.  Used for counts.
 394
 395     XD_LONG
 396   long value.  Used for counts.
 397
 398     XD_BYTECOUNT
 399   bytecount value.  Used for counts.
 400
 401     XD_END
 402   Special type indicating the end of the array.
 403
 404     XD_SPECIFIER_END
 405   Special type indicating the end of the array for a specifier.  Extra
 406   description is going to be fetched from the specifier methods.
 407
 408
 409   Special macros:
 410     XD_INDIRECT(line, delta)
 411   Usable where  a "count" or "size"  is requested.  Gives the value of
 412   the element which is at line number 'line' in the description (count
 413   starts at zero) and adds delta to it.
 414 */
 415
 416 enum lrecord_description_type {
 417   XD_LISP_OBJECT_ARRAY,
 418   XD_LISP_OBJECT,
 419   XD_LO_LINK,
 420   XD_OPAQUE_PTR,
 421   XD_STRUCT_PTR,
 422   XD_OPAQUE_DATA_PTR,
 423   XD_C_STRING,
 424   XD_DOC_STRING,
 425   XD_INT_RESET,
 426   XD_SIZE_T,
 427   XD_INT,
 428   XD_LONG,
 429   XD_BYTECOUNT,
 430   XD_END,
 431   XD_SPECIFIER_END
 432 };
 433
 434 struct lrecord_description {
 435   enum lrecord_description_type type;
 436   int offset;
 437   EMACS_INT data1;
 438   const struct struct_description *data2;
 439 };
 440
 441 struct struct_description {
 442   size_t size;
 443   const struct lrecord_description *description;
 444 };
 445
 446 #define XD_INDIRECT(val, delta) (-1-((val)|(delta<<8)))
 447
 448 #define XD_IS_INDIRECT(code) (code<0)
 449 #define XD_INDIRECT_VAL(code) ((-1-code) & 255)
 450 #define XD_INDIRECT_DELTA(code) (((-1-code)>>8) & 255)
 451
 452 #define XD_DYNARR_DESC(base_type, sub_desc) \
 453   { XD_STRUCT_PTR, offsetof (base_type, base), XD_INDIRECT(1, 0), sub_desc }, \
 454   { XD_INT,        offsetof (base_type, cur) }, \
 455   { XD_INT_RESET,  offsetof (base_type, max), XD_INDIRECT(1, 0) }
 456
 457 /* DEFINE_LRECORD_IMPLEMENTATION is for objects with constant size.
 458    DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION is for objects whose size varies.
 459  */
 460
 461 #if defined (ERROR_CHECK_TYPECHECK)
 462 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
 463 #else
 464 # define DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)
 465 #endif
 466
 467 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
 468 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
 469
 470 #define DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
 471 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof(structtype),0,1,structtype)
 472
 473 #define DEFINE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
 474 DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
 475
 476 #define DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
 477 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
 478
 479 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
 480 DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
 481
 482 #define DEFINE_BASIC_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
 483 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,0,sizer,1,structtype)
 484
 485 #define DEFINE_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
 486 MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype) \
 487
 488 #define MAKE_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
 489 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)                       \
 490 const struct lrecord_implementation lrecord_##c_name =                  \
 491   { name, marker, printer, nuker, equal, hash, desc,                    \
 492     getprop, putprop, remprop, plist, size, sizer,                      \
 493     lrecord_type_##c_name, basic_p }
 494
 495 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,structtype) \
 496 DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,structtype)
 497
 498 #define DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,structtype) \
 499 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizeof (structtype),0,0,structtype)
 500
 501 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,sizer,structtype) \
 502 DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,0,0,0,0,sizer,structtype)
 503
 504 #define DEFINE_EXTERNAL_LRECORD_SEQUENCE_IMPLEMENTATION_WITH_PROPS(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,sizer,structtype) \
 505 MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,0,sizer,0,structtype)
 506
 507 #define MAKE_EXTERNAL_LRECORD_IMPLEMENTATION(name,c_name,marker,printer,nuker,equal,hash,desc,getprop,putprop,remprop,plist,size,sizer,basic_p,structtype) \
 508 DECLARE_ERROR_CHECK_TYPECHECK(c_name, structtype)                       \
 509 unsigned int lrecord_type_##c_name;                                     \
 510 struct lrecord_implementation lrecord_##c_name =                        \
 511   { name, marker, printer, nuker, equal, hash, desc,                    \
 512     getprop, putprop, remprop, plist, size, sizer,                      \
 513     lrecord_type_last_built_in_type, basic_p }
 514
 515
 516 extern Lisp_Object (*lrecord_markers[]) (Lisp_Object);
 517
 518 #define INIT_LRECORD_IMPLEMENTATION(type) do {                          \
 519   lrecord_implementations_table[lrecord_type_##type] = &lrecord_##type; \
 520   lrecord_markers[lrecord_type_##type] =                                \
 521     lrecord_implementations_table[lrecord_type_##type]->marker;         \
 522 } while (0)
 523
 524 #define INIT_EXTERNAL_LRECORD_IMPLEMENTATION(type) do {                 \
 525   lrecord_type_##type = lrecord_type_count++;                           \
 526   lrecord_##type.lrecord_type_index = lrecord_type_##type;              \
 527   INIT_LRECORD_IMPLEMENTATION(type);                                    \
 528 } while (0)
 529
 530 #define LRECORDP(a) (XTYPE (a) == Lisp_Type_Record)
 531 #define XRECORD_LHEADER(a) ((struct lrecord_header *) XPNTR (a))
 532
 533 #define RECORD_TYPEP(x, ty) \
 534   (LRECORDP (x) && (((unsigned int)(XRECORD_LHEADER (x)->type)) == ((unsigned int)(ty))))
 535
 536 /* Steps to create a new object:
 537
 538    1. Declare the struct for your object in a header file somewhere.
 539    Remember that it must begin with
 540
 541    struct lcrecord_header header;
 542
 543    2. Put a DECLARE_LRECORD() for the object below the struct definition,
 544    along with the standard XFOO/XSETFOO junk.
 545
 546    3. Add this header file to inline.c.
 547
 548    4. Create the methods for your object.  Note that technically you don't
 549    need any, but you will almost always want at least a mark method.
 550
 551    5. Define your object with DEFINE_LRECORD_IMPLEMENTATION() or some
 552    variant.
 553
 554    6. Include the header file in the .c file where you defined the object.
 555
 556    7. Put a call to INIT_LRECORD_IMPLEMENTATION() for the object in the
 557    .c file's syms_of_foo() function.
 558
 559    8. Add a type enum for the object to enum lrecord_type, earlier in this
 560    file.
 561
 562 An example:
 563
 564 ------------------------------ in toolbar.h -----------------------------
 565
 566 struct toolbar_button
 567 {
 568   struct lcrecord_header header;
 569
 570   Lisp_Object next;
 571   Lisp_Object frame;
 572
 573   Lisp_Object up_glyph;
 574   Lisp_Object down_glyph;
 575   Lisp_Object disabled_glyph;
 576
 577   Lisp_Object cap_up_glyph;
 578   Lisp_Object cap_down_glyph;
 579   Lisp_Object cap_disabled_glyph;
 580
 581   Lisp_Object callback;
 582   Lisp_Object enabled_p;
 583   Lisp_Object help_string;
 584
 585   char enabled;
 586   char down;
 587   char pushright;
 588   char blank;
 589
 590   int x, y;
 591   int width, height;
 592   int dirty;
 593   int vertical;
 594   int border_width;
 595 };
 596
 597 DECLARE_LRECORD (toolbar_button, struct toolbar_button);
 598 #define XTOOLBAR_BUTTON(x) XRECORD (x, toolbar_button, struct toolbar_button)
 599 #define XSETTOOLBAR_BUTTON(x, p) XSETRECORD (x, p, toolbar_button)
 600 #define TOOLBAR_BUTTONP(x) RECORDP (x, toolbar_button)
 601 #define CHECK_TOOLBAR_BUTTON(x) CHECK_RECORD (x, toolbar_button)
 602 #define CONCHECK_TOOLBAR_BUTTON(x) CONCHECK_RECORD (x, toolbar_button)
 603
 604 ------------------------------ in toolbar.c -----------------------------
 605
 606 #include "toolbar.h"
 607
 608 ...
 609
 610 static Lisp_Object
 611 mark_toolbar_button (Lisp_Object obj)
 612 {
 613   struct toolbar_button *data = XTOOLBAR_BUTTON (obj);
 614   mark_object (data->next);
 615   mark_object (data->frame);
 616   mark_object (data->up_glyph);
 617   mark_object (data->down_glyph);
 618   mark_object (data->disabled_glyph);
 619   mark_object (data->cap_up_glyph);
 620   mark_object (data->cap_down_glyph);
 621   mark_object (data->cap_disabled_glyph);
 622   mark_object (data->callback);
 623   mark_object (data->enabled_p);
 624   return data->help_string;
 625 }
 626
 627 DEFINE_LRECORD_IMPLEMENTATION ("toolbar-button", toolbar_button,
 628                                mark_toolbar_button, 0, 0, 0, 0, 0,
 629                                struct toolbar_button);
 630
 631 ...
 632
 633 void
 634 syms_of_toolbar (void)
 635 {
 636   INIT_LRECORD_IMPLEMENTATION (toolbar_button);
 637
 638   ...;
 639 }
 640
 641 ------------------------------ in inline.c -----------------------------
 642
 643 #ifdef HAVE_TOOLBARS
 644 #include "toolbar.h"
 645 #endif
 646
 647 ------------------------------ in lrecord.h -----------------------------
 648
 649 enum lrecord_type
 650 {
 651   ...
 652   lrecord_type_toolbar_button,
 653   ...
 654 };
 655
 656 */
 657
 658 /*
 659
 660 Note: Object types defined in external dynamically-loaded modules (not
 661 part of the XEmacs main source code) should use DECLARE_EXTERNAL_LRECORD
 662 and DEFINE_EXTERNAL_LRECORD_IMPLEMENTATION rather than DECLARE_LRECORD
 663 and DEFINE_LRECORD_IMPLEMENTATION.
 664
 665 */
 666
 667
 668 #ifdef ERROR_CHECK_TYPECHECK
 669
 670 # define DECLARE_LRECORD(c_name, structtype)                    \
 671 extern const struct lrecord_implementation lrecord_##c_name;    \
 672 INLINE_HEADER structtype *                                      \
 673 error_check_##c_name (Lisp_Object obj);                         \
 674 INLINE_HEADER structtype *                                      \
 675 error_check_##c_name (Lisp_Object obj)                          \
 676 {                                                               \
 677   assert (RECORD_TYPEP (obj, lrecord_type_##c_name));           \
 678   return (structtype *) XPNTR (obj);                            \
 679 }                                                               \
 680 extern Lisp_Object Q##c_name##p
 681
 682 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype)           \
 683 extern unsigned int lrecord_type_##c_name;                      \
 684 extern struct lrecord_implementation lrecord_##c_name;          \
 685 INLINE_HEADER structtype *                                      \
 686 error_check_##c_name (Lisp_Object obj);                         \
 687 INLINE_HEADER structtype *                                      \
 688 error_check_##c_name (Lisp_Object obj)                          \
 689 {                                                               \
 690   assert (RECORD_TYPEP (obj, lrecord_type_##c_name));           \
 691   return (structtype *) XPNTR (obj);                            \
 692 }                                                               \
 693 extern Lisp_Object Q##c_name##p
 694
 695 # define DECLARE_NONRECORD(c_name, type_enum, structtype)       \
 696 INLINE_HEADER structtype *                                      \
 697 error_check_##c_name (Lisp_Object obj);                         \
 698 INLINE_HEADER structtype *                                      \
 699 error_check_##c_name (Lisp_Object obj)                          \
 700 {                                                               \
 701   assert (XTYPE (obj) == type_enum);                            \
 702   return (structtype *) XPNTR (obj);                            \
 703 }                                                               \
 704 extern Lisp_Object Q##c_name##p
 705
 706 # define XRECORD(x, c_name, structtype) error_check_##c_name (x)
 707 # define XNONRECORD(x, c_name, type_enum, structtype) error_check_##c_name (x)
 708
 709 # define XSETRECORD(var, p, c_name) do                          \
 710 {                                                               \
 711   XSETOBJ (var, p);                                             \
 712   assert (RECORD_TYPEP (var, lrecord_type_##c_name));           \
 713 } while (0)
 714
 715 #else /* not ERROR_CHECK_TYPECHECK */
 716
 717 # define DECLARE_LRECORD(c_name, structtype)                    \
 718 extern Lisp_Object Q##c_name##p;                                \
 719 extern const struct lrecord_implementation lrecord_##c_name
 720 # define DECLARE_EXTERNAL_LRECORD(c_name, structtype)           \
 721 extern Lisp_Object Q##c_name##p;                                \
 722 extern unsigned int lrecord_type_##c_name;                      \
 723 extern struct lrecord_implementation lrecord_##c_name
 724 # define DECLARE_NONRECORD(c_name, type_enum, structtype)       \
 725 extern Lisp_Object Q##c_name##p
 726 # define XRECORD(x, c_name, structtype) ((structtype *) XPNTR (x))
 727 # define XNONRECORD(x, c_name, type_enum, structtype)           \
 728   ((structtype *) XPNTR (x))
 729 # define XSETRECORD(var, p, c_name) XSETOBJ (var, p)
 730
 731 #endif /* not ERROR_CHECK_TYPECHECK */
 732
 733 #define RECORDP(x, c_name) RECORD_TYPEP (x, lrecord_type_##c_name)
 734
 735 /* Note: we now have two different kinds of type-checking macros.
 736    The "old" kind has now been renamed CONCHECK_foo.  The reason for
 737    this is that the CONCHECK_foo macros signal a continuable error,
 738    allowing the user (through debug-on-error) to substitute a different
 739    value and return from the signal, which causes the lvalue argument
 740    to get changed.  Quite a lot of code would crash if that happened,
 741    because it did things like
 742
 743    foo = XCAR (list);
 744    CHECK_STRING (foo);
 745
 746    and later on did XSTRING (XCAR (list)), assuming that the type
 747    is correct (when it might be wrong, if the user substituted a
 748    correct value in the debugger).
 749
 750    To get around this, I made all the CHECK_foo macros signal a
 751    non-continuable error.  Places where a continuable error is OK
 752    (generally only when called directly on the argument of a Lisp
 753    primitive) should be changed to use CONCHECK().
 754
 755    FSF Emacs does not have this problem because RMS took the cheesy
 756    way out and disabled returning from a signal entirely. */
 757
 758 #define CONCHECK_RECORD(x, c_name) do {                 \
 759  if (!RECORD_TYPEP (x, lrecord_type_##c_name))          \
 760    x = wrong_type_argument (Q##c_name##p, x);           \
 761 }  while (0)
 762 #define CONCHECK_NONRECORD(x, lisp_enum, predicate) do {\
 763  if (XTYPE (x) != lisp_enum)                            \
 764    x = wrong_type_argument (predicate, x);              \
 765  } while (0)
 766 #define CHECK_RECORD(x, c_name) do {                    \
 767  if (!RECORD_TYPEP (x, lrecord_type_##c_name))          \
 768    dead_wrong_type_argument (Q##c_name##p, x);          \
 769  } while (0)
 770 #define CHECK_NONRECORD(x, lisp_enum, predicate) do {   \
 771  if (XTYPE (x) != lisp_enum)                            \
 772    dead_wrong_type_argument (predicate, x);             \
 773  } while (0)
 774
 775 void *alloc_lcrecord (size_t size, const struct lrecord_implementation *);
 776
 777 #define alloc_lcrecord_type(type, lrecord_implementation) \
 778   ((type *) alloc_lcrecord (sizeof (type), lrecord_implementation))
 779
 780 #ifdef UTF2000
 781 void *
 782 alloc_older_lcrecord (size_t size, const struct lrecord_implementation *);
 783
 784 #define alloc_older_lcrecord_type(type, lrecord_implementation) \
 785   ((type *) alloc_older_lcrecord (sizeof (type), lrecord_implementation))
 786 #endif
 787
 788 /* Copy the data from one lcrecord structure into another, but don't
 789    overwrite the header information. */
 790
 791 #define copy_lcrecord(dst, src)                                 \
 792   memcpy ((char *) (dst) + sizeof (struct lcrecord_header),     \
 793           (char *) (src) + sizeof (struct lcrecord_header),     \
 794           sizeof (*(dst)) - sizeof (struct lcrecord_header))
 795
 796 #define zero_lcrecord(lcr)                                      \
 797    memset ((char *) (lcr) + sizeof (struct lcrecord_header), 0, \
 798            sizeof (*(lcr)) - sizeof (struct lcrecord_header))
 799
 800 #endif /* INCLUDED_lrecord_h_ */