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