git.chise.org Git - chise/xemacs-chise.git-/blob - src/lrecord.h

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