git.chise.org Git - chise/xemacs-chise.git.1/blob - src/glyphs.h

   1 /* Generic glyph data structures + display tables
   2    Copyright (C) 1994 Board of Trustees, University of Illinois.
   3    Copyright (C) 1995, 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_glyphs_h_
  25 #define INCLUDED_glyphs_h_
  26
  27 #include "specifier.h"
  28 #include "gui.h"
  29
  30 /************************************************************************/
  31 /*                      Image Instantiators                             */
  32 /************************************************************************/
  33
  34 struct image_instantiator_methods;
  35
  36 /* Remember the distinction between image instantiator formats and
  37    image instance types.  Here's an approximate mapping:
  38
  39   image instantiator format     image instance type
  40   -------------------------     -------------------
  41   nothing                       nothing
  42   string                        text
  43   formatted-string              text
  44   xbm                           mono-pixmap, color-pixmap, pointer
  45   xpm                           color-pixmap, mono-pixmap, pointer
  46   xface                         mono-pixmap, color-pixmap, pointer
  47   gif                           color-pixmap
  48   jpeg                          color-pixmap
  49   png                           color-pixmap
  50   tiff                          color-pixmap
  51   bmp                           color-pixmap
  52   cursor-font                   pointer
  53   mswindows-resource            pointer
  54   font                          pointer
  55   subwindow                     subwindow
  56   inherit                       mono-pixmap
  57   autodetect                    mono-pixmap, color-pixmap, pointer, text
  58   button                        widget
  59   edit-field                    widget
  60   combo -box                    widget
  61   progress-gauge                widget
  62   tab-control                   widget
  63   tree-view                     widget
  64   scrollbar                     widget
  65   static                        widget
  66 */
  67
  68 /* These are methods specific to a particular format of image instantiator
  69    (e.g. xpm, string, etc.). */
  70
  71 typedef struct ii_keyword_entry ii_keyword_entry;
  72 struct ii_keyword_entry
  73 {
  74   Lisp_Object keyword;
  75   void (*validate) (Lisp_Object data);
  76   int multiple_p;
  77   int copy_p;
  78 };
  79
  80 typedef struct
  81 {
  82   Dynarr_declare (ii_keyword_entry);
  83 } ii_keyword_entry_dynarr;
  84
  85 extern const struct struct_description iim_description;
  86
  87 enum image_instance_geometry
  88 {
  89   IMAGE_GEOMETRY,
  90   IMAGE_DESIRED_GEOMETRY,
  91   IMAGE_MIN_GEOMETRY,
  92   IMAGE_MAX_GEOMETRY,
  93   IMAGE_UNSPECIFIED_GEOMETRY = ~0
  94 };
  95
  96 #define WIDGET_BORDER_HEIGHT 4
  97 #define WIDGET_BORDER_WIDTH 4
  98
  99 struct image_instantiator_methods
 100 {
 101   Lisp_Object symbol;
 102
 103   Lisp_Object device;           /* sometimes used */
 104
 105   ii_keyword_entry_dynarr *keywords;
 106   /* consoles this ii is supported on */
 107   console_type_entry_dynarr *consoles;
 108   /* Implementation specific methods: */
 109
 110   /* Validate method: Given an instantiator vector, signal an error if
 111      it's invalid for this image-instantiator format.  Note that this
 112      validation only occurs after all the keyword-specific validation
 113      has already been performed.  This is chiefly useful for making
 114      sure that certain required keywords are present. */
 115   void (*validate_method) (Lisp_Object instantiator);
 116
 117   /* Normalize method: Given an instantiator, convert it to the form
 118      that should be used in a glyph, for devices of type CONSOLE_TYPE.
 119      Signal an error if conversion fails. */
 120   Lisp_Object (*normalize_method) (Lisp_Object instantiator,
 121                                    Lisp_Object console_type);
 122
 123   /* Possible-dest-types method: Return a mask indicating what dest types
 124      are compatible with this format. */
 125   int (*possible_dest_types_method) (void);
 126
 127   /* Instantiate method: Given an instantiator and a partially
 128      filled-in image instance, complete the filling-in.  Return
 129      non-zero if the instantiation succeeds, 0 if it fails.
 130      This must be present. */
 131   void (*instantiate_method) (Lisp_Object image_instance,
 132                               Lisp_Object instantiator,
 133                               Lisp_Object pointer_fg,
 134                               Lisp_Object pointer_bg,
 135                               int dest_mask,
 136                               Lisp_Object domain);
 137   /* Property method: Given an image instance, return device specific
 138      properties. */
 139   Lisp_Object (*property_method) (Lisp_Object image_instance,
 140                                   Lisp_Object property);
 141   /* Set-property method: Given an image instance, set device specific
 142      properties. */
 143   Lisp_Object (*set_property_method) (Lisp_Object image_instance,
 144                                       Lisp_Object property,
 145                                       Lisp_Object val);
 146   /* Asynchronously update properties. */
 147   void (*update_method) (Lisp_Object image_instance);
 148
 149   /* Find out the desired geometry, as given by disp, of this image
 150    instance. Actual geometry is stored in the appropriate slots in the
 151    image instance. */
 152   void (*query_geometry_method) (Lisp_Object image_instance,
 153                                  unsigned int* width, unsigned int* height,
 154                                  enum image_instance_geometry disp,
 155                                  Lisp_Object domain);
 156
 157   /* Layout the instance and its children bounded by the provided
 158      dimensions. */
 159   void (*layout_method) (Lisp_Object image_instance,
 160                                   unsigned int width, unsigned int height,
 161                                   Lisp_Object domain);
 162 };
 163
 164 /***** Calling an image-instantiator method *****/
 165
 166 #define HAS_IIFORMAT_METH_P(mstruc, m) (((mstruc)->m##_method) != 0)
 167 #define IIFORMAT_METH(mstruc, m, args) (((mstruc)->m##_method) args)
 168
 169 /* Call a void-returning specifier method, if it exists */
 170 #define MAYBE_IIFORMAT_METH(mstruc, m, args)                    \
 171 do {                                                            \
 172   struct image_instantiator_methods *MIM_mstruc = (mstruc);     \
 173   if (MIM_mstruc && HAS_IIFORMAT_METH_P (MIM_mstruc, m))        \
 174     IIFORMAT_METH (MIM_mstruc, m, args);                        \
 175 } while (0)
 176
 177 #define MAYBE_IIFORMAT_DEVMETH(device, mstruc, m, args) \
 178 do {                                                    \
 179   struct image_instantiator_methods *MID_mstruc =       \
 180     decode_ii_device (device, mstruc);                  \
 181   if (MID_mstruc)                                       \
 182     MAYBE_IIFORMAT_METH(MID_mstruc, m, args);           \
 183 } while (0)
 184
 185
 186 /* Call a specifier method, if it exists; otherwise return
 187    the specified value */
 188
 189 #define IIFORMAT_METH_OR_GIVEN(mstruc, m, args, given)  \
 190   (HAS_IIFORMAT_METH_P (mstruc, m) ?                    \
 191    IIFORMAT_METH (mstruc, m, args) : (given))
 192
 193 /***** Defining new image-instantiator types *****/
 194
 195 #define DECLARE_IMAGE_INSTANTIATOR_FORMAT(format)               \
 196 extern struct image_instantiator_methods *format##_image_instantiator_methods
 197
 198 #define DEFINE_IMAGE_INSTANTIATOR_FORMAT(format)                \
 199 struct image_instantiator_methods *format##_image_instantiator_methods
 200
 201 #define INITIALIZE_IMAGE_INSTANTIATOR_FORMAT_NO_SYM(format, obj_name)   \
 202 do {                                                            \
 203   format##_image_instantiator_methods =                         \
 204     xnew_and_zero (struct image_instantiator_methods);          \
 205   format##_image_instantiator_methods->symbol = Q##format;      \
 206   format##_image_instantiator_methods->device = Qnil;           \
 207   format##_image_instantiator_methods->keywords =               \
 208     Dynarr_new (ii_keyword_entry);                              \
 209   format##_image_instantiator_methods->consoles =               \
 210     Dynarr_new (console_type_entry);                            \
 211   add_entry_to_image_instantiator_format_list                   \
 212     (Q##format, format##_image_instantiator_methods);           \
 213   dumpstruct (&format##_image_instantiator_methods,             \
 214               &iim_description);                                \
 215 } while (0)
 216
 217 #define INITIALIZE_IMAGE_INSTANTIATOR_FORMAT(format, obj_name)  \
 218 do {                                                            \
 219   defsymbol (&Q##format, obj_name);                             \
 220   INITIALIZE_IMAGE_INSTANTIATOR_FORMAT_NO_SYM(format, obj_name);\
 221 } while (0)
 222
 223 /* Declare that image-instantiator format FORMAT has method M; used in
 224    initialization routines */
 225 #define IIFORMAT_HAS_METHOD(format, m) \
 226   (format##_image_instantiator_methods->m##_method = format##_##m)
 227
 228 #define IIFORMAT_HAS_SHARED_METHOD(format, m, type) \
 229   (format##_image_instantiator_methods->m##_method = type##_##m)
 230
 231 /* Declare that KEYW is a valid keyword for image-instantiator format
 232    FORMAT.  VALIDATE_FUN if a function that returns whether the data
 233    is valid.  The keyword may not appear more than once. */
 234 #define IIFORMAT_VALID_GENERIC_KEYWORD(format, keyw, validate_fun, copy, multi) \
 235   do {                                                          \
 236     struct ii_keyword_entry entry;                              \
 237                                                                 \
 238     entry.keyword = keyw;                                       \
 239     entry.validate = validate_fun;                              \
 240     entry.multiple_p = multi;                                   \
 241     entry.copy_p = copy;                                        \
 242     Dynarr_add (format##_image_instantiator_methods->keywords,  \
 243                 entry);                                         \
 244   } while (0)
 245
 246 #define IIFORMAT_VALID_KEYWORD(format, keyw, validate_fun)      \
 247 IIFORMAT_VALID_GENERIC_KEYWORD(format, keyw, validate_fun, 1, 0)
 248
 249 /* Same as IIFORMAT_VALID_KEYWORD except that the keyword may
 250    appear multiple times. */
 251 #define IIFORMAT_VALID_MULTI_KEYWORD(format, keyw, validate_fun)        \
 252 IIFORMAT_VALID_GENERIC_KEYWORD(format, keyw, validate_fun, 1, 1)
 253
 254 /* Same as IIFORMAT_VALID_KEYWORD execpt that the argument is not
 255    copied by the specifier functions. This is necessary for things
 256    like callbacks etc. */
 257 #define IIFORMAT_VALID_NONCOPY_KEYWORD(format, keyw, validate_fun)      \
 258 IIFORMAT_VALID_GENERIC_KEYWORD(format, keyw, validate_fun, 0, 0)
 259
 260 /* Declare that image-instantiator format FORMAT is supported on
 261    CONSOLE type. */
 262 #define IIFORMAT_VALID_CONSOLE(console, format)                 \
 263   do {                                                          \
 264     struct console_type_entry entry;                            \
 265                                                                 \
 266     entry.symbol = Q##console;                                  \
 267     entry.meths = console##_console_methods;                    \
 268     Dynarr_add (format##_image_instantiator_methods->consoles,  \
 269                 entry);                                         \
 270   } while (0)
 271
 272 #define IIFORMAT_VALID_CONSOLE2(con1, con2, format)             \
 273   IIFORMAT_VALID_CONSOLE (con1, format);                        \
 274   IIFORMAT_VALID_CONSOLE (con2, format);
 275
 276 #define DEFINE_DEVICE_IIFORMAT(type, format)    \
 277 DECLARE_IMAGE_INSTANTIATOR_FORMAT(format);      \
 278 struct image_instantiator_methods *type##_##format##_image_instantiator_methods
 279
 280 #define INITIALIZE_DEVICE_IIFORMAT(type, format)                        \
 281 do {                                                                    \
 282   type##_##format##_image_instantiator_methods =                        \
 283     xnew_and_zero (struct image_instantiator_methods);                  \
 284   type##_##format##_image_instantiator_methods->symbol = Q##format;     \
 285   type##_##format##_image_instantiator_methods->device = Q##type;       \
 286   type##_##format##_image_instantiator_methods->keywords =              \
 287     Dynarr_new (ii_keyword_entry);                                      \
 288   add_entry_to_device_ii_format_list                                    \
 289     (Q##type, Q##format, type##_##format##_image_instantiator_methods); \
 290   IIFORMAT_VALID_CONSOLE(type,format);                                  \
 291   dumpstruct (&type##_##format##_image_instantiator_methods,            \
 292               &iim_description);                                        \
 293 } while (0)
 294
 295 /* Declare that image-instantiator format FORMAT has method M; used in
 296    initialization routines */
 297 #define IIFORMAT_HAS_DEVMETHOD(type, format, m) \
 298   (type##_##format##_image_instantiator_methods->m##_method = type##_##format##_##m)
 299 #define IIFORMAT_HAS_SHARED_DEVMETHOD(type, format, m, fromformat) \
 300   (type##_##format##_image_instantiator_methods->m##_method = type##_##fromformat##_##m)
 301
 302 #define IIFORMAT_INHERITS_DEVMETHOD(type, from, format, m) \
 303   (type##_##format##_image_instantiator_methods->m##_method = from##_##format##_##m)
 304 #define IIFORMAT_INHERITS_SHARED_DEVMETHOD(type, from, format, m, fromformat) \
 305   (type##_##format##_image_instantiator_methods->m##_method = from##_##fromformat##_##m)
 306
 307 struct image_instantiator_methods *
 308 decode_device_ii_format (Lisp_Object device, Lisp_Object format,
 309                          Error_behavior errb);
 310 struct image_instantiator_methods *
 311 decode_image_instantiator_format (Lisp_Object format, Error_behavior errb);
 312
 313 void add_entry_to_image_instantiator_format_list (Lisp_Object symbol,
 314                         struct image_instantiator_methods *meths);
 315 void add_entry_to_device_ii_format_list (Lisp_Object device, Lisp_Object symbol,
 316                         struct image_instantiator_methods *meths);
 317 Lisp_Object find_keyword_in_vector (Lisp_Object vector,
 318                                     Lisp_Object keyword);
 319 Lisp_Object find_keyword_in_vector_or_given (Lisp_Object vector,
 320                                              Lisp_Object keyword,
 321                                              Lisp_Object default_);
 322 Lisp_Object simple_image_type_normalize (Lisp_Object inst,
 323                                          Lisp_Object console_type,
 324                                          Lisp_Object image_type_tag);
 325 Lisp_Object potential_pixmap_file_instantiator (Lisp_Object instantiator,
 326                                                 Lisp_Object file_keyword,
 327                                                 Lisp_Object data_keyword,
 328                                                 Lisp_Object console_type);
 329 void check_valid_string (Lisp_Object data);
 330 void check_valid_int (Lisp_Object data);
 331 void check_valid_face (Lisp_Object data);
 332 void check_valid_vector (Lisp_Object data);
 333 void check_valid_item_list_1 (Lisp_Object items);
 334
 335 void initialize_subwindow_image_instance (Lisp_Image_Instance*);
 336 void subwindow_instantiate (Lisp_Object image_instance, Lisp_Object instantiator,
 337                             Lisp_Object pointer_fg, Lisp_Object pointer_bg,
 338                             int dest_mask, Lisp_Object domain);
 339 void widget_instantiate (Lisp_Object image_instance, Lisp_Object instantiator,
 340                          Lisp_Object pointer_fg, Lisp_Object pointer_bg,
 341                          int dest_mask, Lisp_Object domain);
 342 void image_instance_query_geometry (Lisp_Object image_instance,
 343                                     unsigned int* width, unsigned int* height,
 344                                     enum image_instance_geometry disp,
 345                                     Lisp_Object domain);
 346 void image_instance_layout (Lisp_Object image_instance,
 347                             unsigned int width, unsigned int height,
 348                             Lisp_Object domain);
 349 int invalidate_glyph_geometry_maybe (Lisp_Object glyph_or_ii, struct window* w);
 350
 351 DECLARE_DOESNT_RETURN (incompatible_image_types (Lisp_Object instantiator,
 352                                                  int given_dest_mask,
 353                                                  int desired_dest_mask));
 354 DECLARE_DOESNT_RETURN (signal_image_error (const char *, Lisp_Object));
 355 DECLARE_DOESNT_RETURN (signal_image_error_2 (const char *, Lisp_Object, Lisp_Object));
 356
 357 /************************************************************************/
 358 /*                      Image Specifier Object                          */
 359 /************************************************************************/
 360
 361 DECLARE_SPECIFIER_TYPE (image);
 362 #define XIMAGE_SPECIFIER(x) XSPECIFIER_TYPE (x, image)
 363 #define XSETIMAGE_SPECIFIER(x, p) XSETSPECIFIER_TYPE (x, p, image)
 364 #define IMAGE_SPECIFIERP(x) SPECIFIER_TYPEP (x, image)
 365 #define CHECK_IMAGE_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, image)
 366 #define CONCHECK_IMAGE_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, image)
 367
 368 void set_image_attached_to (Lisp_Object obj, Lisp_Object face_or_glyph,
 369                             Lisp_Object property);
 370
 371 struct image_specifier
 372 {
 373   int allowed;
 374   Lisp_Object attachee;         /* face or glyph this is attached to, or nil */
 375   Lisp_Object attachee_property;/* property of that face or glyph */
 376 };
 377
 378 #define IMAGE_SPECIFIER_DATA(g) (SPECIFIER_TYPE_DATA (g, image))
 379 #define IMAGE_SPECIFIER_ALLOWED(g) (IMAGE_SPECIFIER_DATA (g)->allowed)
 380 #define IMAGE_SPECIFIER_ATTACHEE(g) (IMAGE_SPECIFIER_DATA (g)->attachee)
 381 #define IMAGE_SPECIFIER_ATTACHEE_PROPERTY(g) \
 382   (IMAGE_SPECIFIER_DATA (g)->attachee_property)
 383
 384 #define XIMAGE_SPECIFIER_ALLOWED(g) \
 385   IMAGE_SPECIFIER_ALLOWED (XIMAGE_SPECIFIER (g))
 386
 387 /************************************************************************/
 388 /*                      Image Instance Object                           */
 389 /************************************************************************/
 390
 391 DECLARE_LRECORD (image_instance, Lisp_Image_Instance);
 392 #define XIMAGE_INSTANCE(x) XRECORD (x, image_instance, Lisp_Image_Instance)
 393 #define XSETIMAGE_INSTANCE(x, p) XSETRECORD (x, p, image_instance)
 394 #define IMAGE_INSTANCEP(x) RECORDP (x, image_instance)
 395 #define CHECK_IMAGE_INSTANCE(x) CHECK_RECORD (x, image_instance)
 396 #define CONCHECK_IMAGE_INSTANCE(x) CONCHECK_RECORD (x, image_instance)
 397
 398 enum image_instance_type
 399 {
 400   IMAGE_UNKNOWN,
 401   IMAGE_NOTHING,
 402   IMAGE_TEXT,
 403   IMAGE_MONO_PIXMAP,
 404   IMAGE_COLOR_PIXMAP,
 405   IMAGE_POINTER,
 406   IMAGE_SUBWINDOW,
 407   IMAGE_WIDGET,
 408   IMAGE_LAYOUT
 409 };
 410
 411 #define IMAGE_NOTHING_MASK (1 << 0)
 412 #define IMAGE_TEXT_MASK (1 << 1)
 413 #define IMAGE_MONO_PIXMAP_MASK (1 << 2)
 414 #define IMAGE_COLOR_PIXMAP_MASK (1 << 3)
 415 #define IMAGE_POINTER_MASK (1 << 4)
 416 #define IMAGE_SUBWINDOW_MASK (1 << 5)
 417 #define IMAGE_WIDGET_MASK (1 << 6)
 418 #define IMAGE_LAYOUT_MASK (1 << 7)
 419
 420 #define IMAGE_INSTANCE_TYPE_P(ii, type) \
 421 (IMAGE_INSTANCEP (ii) && XIMAGE_INSTANCE_TYPE (ii) == type)
 422
 423 #define NOTHING_IMAGE_INSTANCEP(ii) \
 424      IMAGE_INSTANCE_TYPE_P (ii, IMAGE_NOTHING)
 425 #define TEXT_IMAGE_INSTANCEP(ii) \
 426      IMAGE_INSTANCE_TYPE_P (ii, IMAGE_TEXT)
 427 #define MONO_PIXMAP_IMAGE_INSTANCEP(ii) \
 428      IMAGE_INSTANCE_TYPE_P (ii, IMAGE_MONO_PIXMAP)
 429 #define COLOR_PIXMAP_IMAGE_INSTANCEP(ii) \
 430      IMAGE_INSTANCE_TYPE_P (ii, IMAGE_COLOR_PIXMAP)
 431 #define POINTER_IMAGE_INSTANCEP(ii) \
 432      IMAGE_INSTANCE_TYPE_P (ii, IMAGE_POINTER)
 433 #define SUBWINDOW_IMAGE_INSTANCEP(ii) \
 434      IMAGE_INSTANCE_TYPE_P (ii, IMAGE_SUBWINDOW)
 435 #define WIDGET_IMAGE_INSTANCEP(ii) \
 436      IMAGE_INSTANCE_TYPE_P (ii, IMAGE_WIDGET)
 437 #define LAYOUT_IMAGE_INSTANCEP(ii) \
 438      IMAGE_INSTANCE_TYPE_P (ii, IMAGE_LAYOUT)
 439
 440 #define CHECK_NOTHING_IMAGE_INSTANCE(x) do {                    \
 441   CHECK_IMAGE_INSTANCE (x);                                     \
 442   if (!NOTHING_IMAGE_INSTANCEP (x))                             \
 443     x = wrong_type_argument (Qnothing_image_instance_p, (x));   \
 444 } while (0)
 445
 446 #define CHECK_TEXT_IMAGE_INSTANCE(x) do {                       \
 447   CHECK_IMAGE_INSTANCE (x);                                     \
 448   if (!TEXT_IMAGE_INSTANCEP (x))                                \
 449     x = wrong_type_argument (Qtext_image_instance_p, (x));      \
 450 } while (0)
 451
 452 #define CHECK_MONO_PIXMAP_IMAGE_INSTANCE(x) do {                        \
 453   CHECK_IMAGE_INSTANCE (x);                                             \
 454   if (!MONO_PIXMAP_IMAGE_INSTANCEP (x))                                 \
 455     x = wrong_type_argument (Qmono_pixmap_image_instance_p, (x));       \
 456 } while (0)
 457
 458 #define CHECK_COLOR_PIXMAP_IMAGE_INSTANCE(x) do {                       \
 459   CHECK_IMAGE_INSTANCE (x);                                             \
 460   if (!COLOR_PIXMAP_IMAGE_INSTANCEP (x))                                \
 461     x = wrong_type_argument (Qcolor_pixmap_image_instance_p, (x));      \
 462 } while (0)
 463
 464 #define CHECK_POINTER_IMAGE_INSTANCE(x) do {                    \
 465   CHECK_IMAGE_INSTANCE (x);                                     \
 466   if (!POINTER_IMAGE_INSTANCEP (x))                             \
 467     x = wrong_type_argument (Qpointer_image_instance_p, (x));   \
 468 } while (0)
 469
 470 #define CHECK_SUBWINDOW_IMAGE_INSTANCE(x) do {                  \
 471   CHECK_IMAGE_INSTANCE (x);                                     \
 472   if (!SUBWINDOW_IMAGE_INSTANCEP (x)                            \
 473       && !WIDGET_IMAGE_INSTANCEP (x))                           \
 474     x = wrong_type_argument (Qsubwindow_image_instance_p, (x)); \
 475 } while (0)
 476
 477 #define CHECK_WIDGET_IMAGE_INSTANCE(x) do {                     \
 478   CHECK_IMAGE_INSTANCE (x);                                     \
 479   if (!WIDGET_IMAGE_INSTANCEP (x))                              \
 480     x = wrong_type_argument (Qwidget_image_instance_p, (x));    \
 481 } while (0)
 482
 483 #define CHECK_LAYOUT_IMAGE_INSTANCE(x) do {                     \
 484   CHECK_IMAGE_INSTANCE (x);                                     \
 485   if (!LAYOUT_IMAGE_INSTANCEP (x))                              \
 486     x = wrong_type_argument (Qlayout_image_instance_p, (x));    \
 487 } while (0)
 488
 489 struct Lisp_Image_Instance
 490 {
 491   struct lcrecord_header header;
 492   Lisp_Object device;
 493   Lisp_Object name;
 494   /* The glyph from which we were instantiated. This is a weak
 495      reference. */
 496   Lisp_Object parent;
 497   enum image_instance_type type;
 498   unsigned int x_offset, y_offset;      /* for layout purposes */
 499   unsigned int width, height;
 500   unsigned long display_hash; /* Hash value representing the structure
 501                                  of the image_instance when it was
 502                                  last displayed. */
 503   unsigned int dirty : 1;
 504   unsigned int size_changed : 1;
 505   unsigned int text_changed : 1;
 506   unsigned int layout_changed : 1;
 507   unsigned int optimize_output : 1; /* For outputting layouts. */
 508
 509   union
 510   {
 511     struct
 512     {
 513       unsigned int descent;
 514       Lisp_Object string;
 515     } text;
 516     struct
 517     {
 518       unsigned int depth;
 519       unsigned int slice, maxslice, timeout;
 520       Lisp_Object hotspot_x, hotspot_y; /* integer or Qnil */
 521       Lisp_Object filename;      /* string or Qnil */
 522       Lisp_Object mask_filename; /* string or Qnil */
 523       Lisp_Object fg, bg; /* foreground and background colors,
 524                              if this is a colorized mono-pixmap
 525                              or a pointer */
 526       Lisp_Object auxdata;    /* list or Qnil: any additional data
 527                                  to be seen from lisp */
 528       void* mask;               /* mask that can be seen from all windowing systems */
 529     } pixmap; /* used for pointers as well */
 530     struct
 531     {
 532       Lisp_Object frame;
 533       void* subwindow;          /* specific devices can use this as necessary */
 534       unsigned int being_displayed : 1; /* used to detect when needs to be unmapped */
 535       unsigned int v_resize : 1;        /* Whether the vsize is allowed to change. */
 536       unsigned int h_resize : 1;        /* Whether the hsize is allowed to change. */
 537       unsigned int orientation : 1; /* Vertical or horizontal. */
 538       unsigned int justification : 2; /* Left, right or center. */
 539       /* Face for colors and font. We specify this here becuase we
 540          want people to be able to put :face in the instantiator
 541          spec. Using gyph-face is more inconvenient, although more
 542          general. */
 543       Lisp_Object face;
 544       Lisp_Object type;
 545       Lisp_Object props;        /* properties or border*/
 546       Lisp_Object items;        /* a list of gui_items or children */
 547       Lisp_Object pending_items; /* gui_items that should be displayed */
 548       Lisp_Object width;        /* dynamic width spec. */
 549       Lisp_Object height;       /* dynamic height spec. */
 550       /* Change flags to augment dirty. */
 551       unsigned int face_changed : 1;
 552       unsigned int items_changed : 1;
 553       unsigned int percent_changed : 1;
 554     } subwindow;
 555   } u;
 556
 557   /* console-type- and image-type-specific data */
 558   void *data;
 559 };
 560
 561 /* Layout bit-fields. */
 562 #define LAYOUT_HORIZONTAL       0
 563 #define LAYOUT_VERTICAL 1
 564
 565 #define LAYOUT_JUSTIFY_LEFT 0
 566 #define LAYOUT_JUSTIFY_RIGHT 1
 567 #define LAYOUT_JUSTIFY_CENTER 2
 568
 569 #define IMAGE_INSTANCE_HASH_DEPTH -2
 570
 571 /* Accessor macros. */
 572 #define IMAGE_INSTANCE_DEVICE(i) ((i)->device)
 573 #define IMAGE_INSTANCE_NAME(i) ((i)->name)
 574 #define IMAGE_INSTANCE_PARENT(i) ((i)->parent)
 575 #define IMAGE_INSTANCE_GLYPH(i) (image_instance_parent_glyph(i))
 576 #define IMAGE_INSTANCE_TYPE(i) ((i)->type)
 577 #define IMAGE_INSTANCE_XOFFSET(i) ((i)->x_offset)
 578 #define IMAGE_INSTANCE_YOFFSET(i) ((i)->y_offset)
 579 #define IMAGE_INSTANCE_WIDTH(i) ((i)->width)
 580 #define IMAGE_INSTANCE_HEIGHT(i) ((i)->height)
 581 #define IMAGE_INSTANCE_DISPLAY_HASH(i) ((i)->display_hash)
 582 #define IMAGE_INSTANCE_PIXMAP_TYPE_P(i)                 \
 583  ((IMAGE_INSTANCE_TYPE (i) == IMAGE_MONO_PIXMAP)        \
 584   || (IMAGE_INSTANCE_TYPE (i) == IMAGE_COLOR_PIXMAP))
 585 #define IMAGE_INSTANCE_DIRTYP(i) ((i)->dirty)
 586 #define IMAGE_INSTANCE_NEEDS_LAYOUT(i) \
 587   (IMAGE_INSTANCE_DIRTYP (i) && IMAGE_INSTANCE_LAYOUT_CHANGED (i))
 588 #define IMAGE_INSTANCE_FACE(i) \
 589   (GLYPHP (IMAGE_INSTANCE_GLYPH (i)) ? \
 590    XGLYPH_FACE (IMAGE_INSTANCE_GLYPH (i)) : Qnil)
 591
 592 /* Changed flags */
 593 #define IMAGE_INSTANCE_TEXT_CHANGED(i) ((i)->text_changed)
 594 #define IMAGE_INSTANCE_SIZE_CHANGED(i) ((i)->size_changed)
 595 #define IMAGE_INSTANCE_WIDGET_FACE_CHANGED(i) \
 596   ((i)->u.subwindow.face_changed)
 597 #define IMAGE_INSTANCE_WIDGET_ITEMS_CHANGED(i) \
 598   ((i)->u.subwindow.items_changed)
 599 #define IMAGE_INSTANCE_WIDGET_PERCENT_CHANGED(i) \
 600   ((i)->u.subwindow.percent_changed)
 601 #define IMAGE_INSTANCE_LAYOUT_CHANGED(i) ((i)->layout_changed)
 602 #define IMAGE_INSTANCE_OPTIMIZE_OUTPUT(i) ((i)->optimize_output)
 603
 604 /* Text properties */
 605 #define IMAGE_INSTANCE_TEXT_STRING(i) ((i)->u.text.string)
 606 #define IMAGE_INSTANCE_TEXT_WIDTH(i) \
 607   IMAGE_INSTANCE_WIDTH(i)
 608 #define IMAGE_INSTANCE_TEXT_HEIGHT(i) \
 609   IMAGE_INSTANCE_HEIGHT(i)
 610 #define IMAGE_INSTANCE_TEXT_DESCENT(i) ((i)->u.text.descent)
 611 #define IMAGE_INSTANCE_TEXT_ASCENT(i) \
 612   (IMAGE_INSTANCE_TEXT_HEIGHT(i) - IMAGE_INSTANCE_TEXT_DESCENT(i))
 613
 614 /* Pixmap properties */
 615 #define IMAGE_INSTANCE_PIXMAP_WIDTH(i) \
 616   IMAGE_INSTANCE_WIDTH(i)
 617 #define IMAGE_INSTANCE_PIXMAP_HEIGHT(i) \
 618   IMAGE_INSTANCE_HEIGHT(i)
 619 #define IMAGE_INSTANCE_PIXMAP_DEPTH(i) ((i)->u.pixmap.depth)
 620 #define IMAGE_INSTANCE_PIXMAP_FILENAME(i) ((i)->u.pixmap.filename)
 621 #define IMAGE_INSTANCE_PIXMAP_MASK_FILENAME(i) ((i)->u.pixmap.mask_filename)
 622 #define IMAGE_INSTANCE_PIXMAP_HOTSPOT_X(i) ((i)->u.pixmap.hotspot_x)
 623 #define IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y(i) ((i)->u.pixmap.hotspot_y)
 624 #define IMAGE_INSTANCE_PIXMAP_FG(i) ((i)->u.pixmap.fg)
 625 #define IMAGE_INSTANCE_PIXMAP_BG(i) ((i)->u.pixmap.bg)
 626 #define IMAGE_INSTANCE_PIXMAP_AUXDATA(i) ((i)->u.pixmap.auxdata)
 627 #define IMAGE_INSTANCE_PIXMAP_MASK(i) ((i)->u.pixmap.mask)
 628 #define IMAGE_INSTANCE_PIXMAP_SLICE(i) ((i)->u.pixmap.slice)
 629 #define IMAGE_INSTANCE_PIXMAP_MAXSLICE(i) ((i)->u.pixmap.maxslice)
 630 #define IMAGE_INSTANCE_PIXMAP_TIMEOUT(i) ((i)->u.pixmap.timeout)
 631
 632 /* Subwindow properties */
 633 #define IMAGE_INSTANCE_SUBWINDOW_WIDTH(i) \
 634  IMAGE_INSTANCE_WIDTH(i)
 635 #define IMAGE_INSTANCE_SUBWINDOW_HEIGHT(i) \
 636   IMAGE_INSTANCE_HEIGHT(i)
 637 #define IMAGE_INSTANCE_SUBWINDOW_ID(i) ((i)->u.subwindow.subwindow)
 638 #define IMAGE_INSTANCE_SUBWINDOW_FRAME(i) ((i)->u.subwindow.frame)
 639 #define IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP(i) \
 640 ((i)->u.subwindow.being_displayed)
 641 #define IMAGE_INSTANCE_SUBWINDOW_V_RESIZEP(i) \
 642 ((i)->u.subwindow.v_resize)
 643 #define IMAGE_INSTANCE_SUBWINDOW_H_RESIZEP(i) \
 644 ((i)->u.subwindow.h_resize)
 645 #define IMAGE_INSTANCE_SUBWINDOW_ORIENT(i) \
 646 ((i)->u.subwindow.orientation)
 647 #define IMAGE_INSTANCE_SUBWINDOW_JUSTIFY(i) \
 648 ((i)->u.subwindow.justification)
 649
 650 /* Widget properties */
 651 #define IMAGE_INSTANCE_WIDGET_WIDTH(i) \
 652   IMAGE_INSTANCE_WIDTH(i)
 653 #define IMAGE_INSTANCE_WIDGET_HEIGHT(i) \
 654   IMAGE_INSTANCE_HEIGHT(i)
 655 #define IMAGE_INSTANCE_WIDGET_WIDTH_SUBR(i) ((i)->u.subwindow.width)
 656 #define IMAGE_INSTANCE_WIDGET_HEIGHT_SUBR(i) ((i)->u.subwindow.height)
 657 #define IMAGE_INSTANCE_WIDGET_TYPE(i) ((i)->u.subwindow.type)
 658 #define IMAGE_INSTANCE_WIDGET_PROPS(i) ((i)->u.subwindow.props)
 659 #define SET_IMAGE_INSTANCE_WIDGET_FACE(i,f) \
 660  ((i)->u.subwindow.face = f)
 661 #define IMAGE_INSTANCE_WIDGET_FACE(i)                           \
 662   (!NILP ((i)->u.subwindow.face) ? (i)->u.subwindow.face :      \
 663   !NILP (IMAGE_INSTANCE_FACE (i)) ? IMAGE_INSTANCE_FACE (i) :   \
 664   Vwidget_face)
 665 #define IMAGE_INSTANCE_WIDGET_ITEMS(i) ((i)->u.subwindow.items)
 666 #define IMAGE_INSTANCE_WIDGET_PENDING_ITEMS(i) \
 667   ((i)->u.subwindow.pending_items)
 668 #define IMAGE_INSTANCE_WIDGET_ITEM(i)           \
 669 (CONSP (IMAGE_INSTANCE_WIDGET_ITEMS (i)) ?      \
 670 XCAR (IMAGE_INSTANCE_WIDGET_ITEMS (i)) :        \
 671   IMAGE_INSTANCE_WIDGET_ITEMS (i))
 672 #define IMAGE_INSTANCE_WIDGET_TEXT(i) XGUI_ITEM (IMAGE_INSTANCE_WIDGET_ITEM (i))->name
 673
 674 /* Layout properties */
 675 #define IMAGE_INSTANCE_LAYOUT_CHILDREN(i) ((i)->u.subwindow.items)
 676 #define IMAGE_INSTANCE_LAYOUT_BORDER(i) ((i)->u.subwindow.props)
 677
 678 #define XIMAGE_INSTANCE_DEVICE(i) \
 679   IMAGE_INSTANCE_DEVICE (XIMAGE_INSTANCE (i))
 680 #define XIMAGE_INSTANCE_NAME(i) \
 681   IMAGE_INSTANCE_NAME (XIMAGE_INSTANCE (i))
 682 #define XIMAGE_INSTANCE_GLYPH(i) \
 683   IMAGE_INSTANCE_GLYPH (XIMAGE_INSTANCE (i))
 684 #define XIMAGE_INSTANCE_PARENT(i) \
 685   IMAGE_INSTANCE_PARENT (XIMAGE_INSTANCE (i))
 686 #define XIMAGE_INSTANCE_TYPE(i) \
 687   IMAGE_INSTANCE_TYPE (XIMAGE_INSTANCE (i))
 688 #define XIMAGE_INSTANCE_DISPLAY_HASH(i) \
 689   IMAGE_INSTANCE_DISPLAY_HASH (XIMAGE_INSTANCE (i))
 690 #define XIMAGE_INSTANCE_XOFFSET(i) \
 691   IMAGE_INSTANCE_XOFFSET (XIMAGE_INSTANCE (i))
 692 #define XIMAGE_INSTANCE_YOFFSET(i) \
 693   IMAGE_INSTANCE_YOFFSET (XIMAGE_INSTANCE (i))
 694 #define XIMAGE_INSTANCE_DIRTYP(i) \
 695   IMAGE_INSTANCE_DIRTYP (XIMAGE_INSTANCE (i))
 696 #define XIMAGE_INSTANCE_NEEDS_LAYOUT(i) \
 697   IMAGE_INSTANCE_NEEDS_LAYOUT (XIMAGE_INSTANCE (i))
 698 #define XIMAGE_INSTANCE_WIDTH(i) \
 699   IMAGE_INSTANCE_WIDTH (XIMAGE_INSTANCE (i))
 700 #define XIMAGE_INSTANCE_HEIGHT(i) \
 701   IMAGE_INSTANCE_HEIGHT (XIMAGE_INSTANCE (i))
 702 #define XIMAGE_INSTANCE_FACE(i) \
 703   IMAGE_INSTANCE_FACE (XIMAGE_INSTANCE (i))
 704
 705 #define XIMAGE_INSTANCE_TEXT_STRING(i) \
 706   IMAGE_INSTANCE_TEXT_STRING (XIMAGE_INSTANCE (i))
 707 #define XIMAGE_INSTANCE_TEXT_WIDTH(i) \
 708   IMAGE_INSTANCE_TEXT_WIDTH (XIMAGE_INSTANCE (i))
 709 #define XIMAGE_INSTANCE_TEXT_HEIGHT(i) \
 710   IMAGE_INSTANCE_TEXT_HEIGHT (XIMAGE_INSTANCE (i))
 711 #define XIMAGE_INSTANCE_TEXT_ASCENT(i) \
 712   IMAGE_INSTANCE_TEXT_ASCENT (XIMAGE_INSTANCE (i))
 713 #define XIMAGE_INSTANCE_TEXT_DESCENT(i) \
 714   IMAGE_INSTANCE_TEXT_DESCENT (XIMAGE_INSTANCE (i))
 715
 716 #define XIMAGE_INSTANCE_PIXMAP_WIDTH(i) \
 717   IMAGE_INSTANCE_PIXMAP_WIDTH (XIMAGE_INSTANCE (i))
 718 #define XIMAGE_INSTANCE_PIXMAP_HEIGHT(i) \
 719   IMAGE_INSTANCE_PIXMAP_HEIGHT (XIMAGE_INSTANCE (i))
 720 #define XIMAGE_INSTANCE_PIXMAP_DEPTH(i) \
 721   IMAGE_INSTANCE_PIXMAP_DEPTH (XIMAGE_INSTANCE (i))
 722 #define XIMAGE_INSTANCE_PIXMAP_FILENAME(i) \
 723   IMAGE_INSTANCE_PIXMAP_FILENAME (XIMAGE_INSTANCE (i))
 724 #define XIMAGE_INSTANCE_PIXMAP_MASK_FILENAME(i) \
 725   IMAGE_INSTANCE_PIXMAP_MASK_FILENAME (XIMAGE_INSTANCE (i))
 726 #define XIMAGE_INSTANCE_PIXMAP_HOTSPOT_X(i) \
 727   IMAGE_INSTANCE_PIXMAP_HOTSPOT_X (XIMAGE_INSTANCE (i))
 728 #define XIMAGE_INSTANCE_PIXMAP_HOTSPOT_Y(i) \
 729   IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (XIMAGE_INSTANCE (i))
 730 #define XIMAGE_INSTANCE_PIXMAP_FG(i) \
 731   IMAGE_INSTANCE_PIXMAP_FG (XIMAGE_INSTANCE (i))
 732 #define XIMAGE_INSTANCE_PIXMAP_BG(i) \
 733   IMAGE_INSTANCE_PIXMAP_BG (XIMAGE_INSTANCE (i))
 734 #define XIMAGE_INSTANCE_PIXMAP_MASK(i) \
 735   IMAGE_INSTANCE_PIXMAP_MASK (XIMAGE_INSTANCE (i))
 736 #define XIMAGE_INSTANCE_PIXMAP_SLICE(i) \
 737   IMAGE_INSTANCE_PIXMAP_SLICE (XIMAGE_INSTANCE (i))
 738 #define XIMAGE_INSTANCE_PIXMAP_MAXSLICE(i) \
 739   IMAGE_INSTANCE_PIXMAP_MAXSLICE (XIMAGE_INSTANCE (i))
 740 #define XIMAGE_INSTANCE_PIXMAP_TIMEOUT(i) \
 741   IMAGE_INSTANCE_PIXMAP_TIMEOUT (XIMAGE_INSTANCE (i))
 742
 743 #define XIMAGE_INSTANCE_WIDGET_WIDTH(i) \
 744   IMAGE_INSTANCE_WIDGET_WIDTH (XIMAGE_INSTANCE (i))
 745 #define XIMAGE_INSTANCE_WIDGET_HEIGHT(i) \
 746   IMAGE_INSTANCE_WIDGET_HEIGHT (XIMAGE_INSTANCE (i))
 747 #define XIMAGE_INSTANCE_WIDGET_WIDTH_SUBR(i) \
 748   IMAGE_INSTANCE_WIDGET_WIDTH_SUBR (XIMAGE_INSTANCE (i))
 749 #define XIMAGE_INSTANCE_WIDGET_HEIGHT_SUBR(i) \
 750   IMAGE_INSTANCE_WIDGET_HEIGHT_SUBR (XIMAGE_INSTANCE (i))
 751 #define XIMAGE_INSTANCE_WIDGET_TYPE(i) \
 752   IMAGE_INSTANCE_WIDGET_TYPE (XIMAGE_INSTANCE (i))
 753 #define XIMAGE_INSTANCE_WIDGET_PROPS(i) \
 754   IMAGE_INSTANCE_WIDGET_PROPS (XIMAGE_INSTANCE (i))
 755 #define XIMAGE_INSTANCE_WIDGET_FACE(i) \
 756   IMAGE_INSTANCE_WIDGET_FACE (XIMAGE_INSTANCE (i))
 757 #define XSET_IMAGE_INSTANCE_WIDGET_FACE(i) \
 758   SET_IMAGE_INSTANCE_WIDGET_FACE (XIMAGE_INSTANCE (i))
 759 #define XIMAGE_INSTANCE_WIDGET_ITEM(i) \
 760   IMAGE_INSTANCE_WIDGET_ITEM (XIMAGE_INSTANCE (i))
 761 #define XIMAGE_INSTANCE_WIDGET_ITEMS(i) \
 762   IMAGE_INSTANCE_WIDGET_ITEMS (XIMAGE_INSTANCE (i))
 763 #define XIMAGE_INSTANCE_WIDGET_PENDING_ITEMS(i) \
 764   IMAGE_INSTANCE_WIDGET_PENDING_ITEMS (XIMAGE_INSTANCE (i))
 765 #define XIMAGE_INSTANCE_WIDGET_TEXT(i) \
 766   IMAGE_INSTANCE_WIDGET_TEXT (XIMAGE_INSTANCE (i))
 767
 768 #define XIMAGE_INSTANCE_LAYOUT_CHILDREN(i) \
 769   IMAGE_INSTANCE_LAYOUT_CHILDREN (XIMAGE_INSTANCE (i))
 770 #define XIMAGE_INSTANCE_LAYOUT_BORDER(i) \
 771   IMAGE_INSTANCE_LAYOUT_BORDER (XIMAGE_INSTANCE (i))
 772
 773 #define XIMAGE_INSTANCE_SUBWINDOW_WIDTH(i) \
 774   IMAGE_INSTANCE_SUBWINDOW_WIDTH (XIMAGE_INSTANCE (i))
 775 #define XIMAGE_INSTANCE_SUBWINDOW_HEIGHT(i) \
 776   IMAGE_INSTANCE_SUBWINDOW_HEIGHT (XIMAGE_INSTANCE (i))
 777 #define XIMAGE_INSTANCE_SUBWINDOW_ID(i) \
 778   IMAGE_INSTANCE_SUBWINDOW_ID (XIMAGE_INSTANCE (i))
 779 #define XIMAGE_INSTANCE_SUBWINDOW_FRAME(i) \
 780   IMAGE_INSTANCE_SUBWINDOW_FRAME (XIMAGE_INSTANCE (i))
 781 #define XIMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP(i) \
 782   IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP (XIMAGE_INSTANCE (i))
 783 #define XIMAGE_INSTANCE_SUBWINDOW_ORIENT(i) \
 784   IMAGE_INSTANCE_SUBWINDOW_ORIENT (XIMAGE_INSTANCE (i))
 785 #define XIMAGE_INSTANCE_SUBWINDOW_JUSTIFY(i) \
 786   IMAGE_INSTANCE_SUBWINDOW_JUSTIFY (XIMAGE_INSTANCE (i))
 787
 788 #define MARK_IMAGE_INSTANCE_CHANGED(i) \
 789   (IMAGE_INSTANCE_DIRTYP (i) = 1);
 790
 791 #ifdef HAVE_XPM
 792 Lisp_Object evaluate_xpm_color_symbols (void);
 793 Lisp_Object pixmap_to_lisp_data (Lisp_Object name, int ok_if_data_invalid);
 794 #endif /* HAVE_XPM */
 795 #ifdef HAVE_WINDOW_SYSTEM
 796 Lisp_Object bitmap_to_lisp_data (Lisp_Object name, int *xhot, int *yhot,
 797                                  int ok_if_data_invalid);
 798 int read_bitmap_data_from_file (const char *filename, unsigned int *width,
 799                                 unsigned int *height, unsigned char **datap,
 800                                 int *x_hot, int *y_hot);
 801 Lisp_Object xbm_mask_file_munging (Lisp_Object alist, Lisp_Object file,
 802                                    Lisp_Object mask_file,
 803                                    Lisp_Object console_type);
 804 #endif
 805
 806 /************************************************************************/
 807 /*                              Glyph Object                            */
 808 /************************************************************************/
 809
 810 enum glyph_type
 811 {
 812   GLYPH_UNKNOWN,
 813   GLYPH_BUFFER,
 814   GLYPH_POINTER,
 815   GLYPH_ICON
 816 };
 817
 818 struct Lisp_Glyph
 819 {
 820   struct lcrecord_header header;
 821
 822   enum glyph_type type;
 823
 824   /* specifiers: */
 825   Lisp_Object image;            /* the actual image */
 826   Lisp_Object contrib_p;        /* whether to figure into line height */
 827   Lisp_Object baseline;         /* percent above baseline */
 828
 829   Lisp_Object face;             /* if non-nil, face to use when displaying */
 830
 831   Lisp_Object plist;
 832   void (*after_change) (Lisp_Object glyph, Lisp_Object property,
 833                         Lisp_Object locale);
 834
 835   unsigned int dirty : 1;       /* So that we can selectively
 836                                    redisplay changed glyphs. */
 837 };
 838 typedef struct Lisp_Glyph Lisp_Glyph;
 839
 840 DECLARE_LRECORD (glyph, Lisp_Glyph);
 841 #define XGLYPH(x) XRECORD (x, glyph, Lisp_Glyph)
 842 #define XSETGLYPH(x, p) XSETRECORD (x, p, glyph)
 843 #define GLYPHP(x) RECORDP (x, glyph)
 844 #define CHECK_GLYPH(x) CHECK_RECORD (x, glyph)
 845 #define CONCHECK_GLYPH(x) CONCHECK_RECORD (x, glyph)
 846
 847 #define CHECK_BUFFER_GLYPH(x) do {                      \
 848   CHECK_GLYPH (x);                                      \
 849   if (XGLYPH (x)->type != GLYPH_BUFFER)                 \
 850     x = wrong_type_argument (Qbuffer_glyph_p, (x));     \
 851 } while (0)
 852
 853 #define CHECK_POINTER_GLYPH(x) do {                     \
 854   CHECK_GLYPH (x);                                      \
 855   if (XGLYPH (x)->type != GLYPH_POINTER)                \
 856     x = wrong_type_argument (Qpointer_glyph_p, (x));    \
 857 } while (0)
 858
 859 #define CHECK_ICON_GLYPH(x) do {                        \
 860   CHECK_GLYPH (x);                                      \
 861   if (XGLYPH (x)->type != GLYPH_ICON)                   \
 862     x = wrong_type_argument (Qicon_glyph_p, (x));       \
 863 } while (0)
 864
 865 #define GLYPH_TYPE(g) ((g)->type)
 866 #define GLYPH_IMAGE(g) ((g)->image)
 867 #define GLYPH_CONTRIB_P(g) ((g)->contrib_p)
 868 #define GLYPH_BASELINE(g) ((g)->baseline)
 869 #define GLYPH_FACE(g) ((g)->face)
 870 #define GLYPH_DIRTYP(g) ((g)->dirty)
 871
 872 #define XGLYPH_TYPE(g) GLYPH_TYPE (XGLYPH (g))
 873 #define XGLYPH_IMAGE(g) GLYPH_IMAGE (XGLYPH (g))
 874 #define XGLYPH_CONTRIB_P(g) GLYPH_CONTRIB_P (XGLYPH (g))
 875 #define XGLYPH_BASELINE(g) GLYPH_BASELINE (XGLYPH (g))
 876 #define XGLYPH_FACE(g) GLYPH_FACE (XGLYPH (g))
 877 #define XGLYPH_DIRTYP(g) GLYPH_DIRTYP (XGLYPH (g))
 878
 879 #define MARK_GLYPH_CHANGED(g) (GLYPH_DIRTYP (g) = 1);
 880
 881 extern Lisp_Object Qxpm, Qxface, Qetched_in, Qetched_out, Qbevel_in, Qbevel_out;
 882 extern Lisp_Object Q_data, Q_file, Q_color_symbols, Qconst_glyph_variable;
 883 extern Lisp_Object Qxbm, Qedit_field, Qgroup, Qlabel, Qcombo_box, Qscrollbar;
 884 extern Lisp_Object Qtree_view, Qtab_control, Qprogress_gauge, Q_border;
 885 extern Lisp_Object Q_mask_file, Q_mask_data, Q_hotspot_x, Q_hotspot_y;
 886 extern Lisp_Object Q_foreground, Q_background, Q_face, Q_descriptor, Q_group;
 887 extern Lisp_Object Q_width, Q_height, Q_pixel_width, Q_pixel_height, Q_text;
 888 extern Lisp_Object Q_items, Q_properties, Q_image, Q_percent, Qimage_conversion_error;
 889 extern Lisp_Object Q_orientation, Qupdate_widget_instances;
 890 extern Lisp_Object Vcontinuation_glyph, Vcontrol_arrow_glyph, Vhscroll_glyph;
 891 extern Lisp_Object Vinvisible_text_glyph, Voctal_escape_glyph, Vtruncation_glyph;
 892 extern Lisp_Object Vxemacs_logo;
 893
 894 unsigned short glyph_width (Lisp_Object glyph, Lisp_Object domain);
 895 unsigned short glyph_ascent (Lisp_Object glyph, Lisp_Object domain);
 896 unsigned short glyph_descent (Lisp_Object glyph, Lisp_Object domain);
 897 unsigned short glyph_height (Lisp_Object glyph, Lisp_Object domain);
 898 Lisp_Object glyph_baseline (Lisp_Object glyph, Lisp_Object domain);
 899 Lisp_Object glyph_face (Lisp_Object glyph, Lisp_Object domain);
 900 int glyph_contrib_p (Lisp_Object glyph, Lisp_Object domain);
 901 Lisp_Object glyph_image_instance (Lisp_Object glyph,
 902                                   Lisp_Object domain,
 903                                   Error_behavior errb, int no_quit);
 904 void file_or_data_must_be_present (Lisp_Object instantiator);
 905 void data_must_be_present (Lisp_Object instantiator);
 906 Lisp_Object make_string_from_file (Lisp_Object file);
 907 Lisp_Object tagged_vector_to_alist (Lisp_Object vector);
 908 Lisp_Object alist_to_tagged_vector (Lisp_Object tag, Lisp_Object alist);
 909 void string_instantiate (Lisp_Object image_instance, Lisp_Object instantiator,
 910                          Lisp_Object pointer_fg, Lisp_Object pointer_bg,
 911                          int dest_mask, Lisp_Object domain);
 912 Lisp_Object allocate_glyph (enum glyph_type type,
 913                             void (*after_change) (Lisp_Object glyph,
 914                                                   Lisp_Object property,
 915                                                   Lisp_Object locale));
 916 void query_string_geometry ( Lisp_Object string, Lisp_Object face,
 917                              unsigned int* width, unsigned int* height,
 918                              unsigned int* descent, Lisp_Object domain);
 919 Lisp_Object query_string_font (Lisp_Object string,
 920                                Lisp_Object face, Lisp_Object domain);
 921 Lisp_Object add_glyph_animated_timeout (EMACS_INT tickms, Lisp_Object device);
 922 void disable_glyph_animated_timeout (int i);
 923
 924 /************************************************************************/
 925 /*                              Glyph Cachels                           */
 926 /************************************************************************/
 927
 928 typedef struct glyph_cachel glyph_cachel;
 929 struct glyph_cachel
 930 {
 931   Lisp_Object glyph;
 932
 933   unsigned int dirty :1;        /* I'm copying faces here. I'm not
 934                                    sure why we need two dirty
 935                                    flags. Maybe because an image
 936                                    instance can be dirty and so we
 937                                    need to frob this in the same way
 938                                    as other image instance properties.  */
 939   unsigned int updated :1;
 940
 941   unsigned short width;
 942   unsigned short ascent;
 943   unsigned short descent;
 944 };
 945
 946 #define CONT_GLYPH_INDEX        (glyph_index) 0
 947 #define TRUN_GLYPH_INDEX        (glyph_index) 1
 948 #define HSCROLL_GLYPH_INDEX     (glyph_index) 2
 949 #define CONTROL_GLYPH_INDEX     (glyph_index) 3
 950 #define OCT_ESC_GLYPH_INDEX     (glyph_index) 4
 951 #define INVIS_GLYPH_INDEX       (glyph_index) 5
 952
 953 #define GLYPH_CACHEL(window, index)                     \
 954   Dynarr_atp (window->glyph_cachels, index)
 955 #define GLYPH_CACHEL_GLYPH(window, index)               \
 956   Dynarr_atp (window->glyph_cachels, index)->glyph
 957 #define GLYPH_CACHEL_WIDTH(window, index)               \
 958   Dynarr_atp (window->glyph_cachels, index)->width
 959 #define GLYPH_CACHEL_ASCENT(window, index)              \
 960   Dynarr_atp (window->glyph_cachels, index)->ascent
 961 #define GLYPH_CACHEL_DESCENT(window, index)             \
 962   Dynarr_atp (window->glyph_cachels, index)->descent
 963 #define GLYPH_CACHEL_DIRTYP(window, index)              \
 964   Dynarr_atp (window->glyph_cachels, index)->dirty
 965
 966 void mark_glyph_cachels (glyph_cachel_dynarr *elements);
 967 void mark_glyph_cachels_as_not_updated (struct window *w);
 968 void mark_glyph_cachels_as_clean (struct window *w);
 969 void reset_glyph_cachels (struct window *w);
 970 glyph_index get_glyph_cachel_index (struct window *w, Lisp_Object glyph);
 971
 972 #ifdef MEMORY_USAGE_STATS
 973 int compute_glyph_cachel_usage (glyph_cachel_dynarr *glyph_cachels,
 974                                 struct overhead_stats *ovstats);
 975 #endif /* MEMORY_USAGE_STATS */
 976
 977 /************************************************************************/
 978 /*                              Display Tables                          */
 979 /************************************************************************/
 980
 981 Lisp_Object display_table_entry (Emchar, Lisp_Object, Lisp_Object);
 982 void get_display_tables (struct window *, face_index,
 983                          Lisp_Object *, Lisp_Object *);
 984
 985 /****************************************************************************
 986  *                            Subwindow Object                              *
 987  ****************************************************************************/
 988
 989 /* redisplay needs a per-frame cache of subwindows being displayed so
 990  * that we known when to unmap them */
 991 typedef struct subwindow_cachel subwindow_cachel;
 992 struct subwindow_cachel
 993 {
 994   Lisp_Object subwindow;
 995   unsigned int x, y;
 996   unsigned int width, height;
 997   unsigned int being_displayed : 1;
 998   unsigned int updated : 1;
 999 };
1000
1001 typedef struct
1002 {
1003   Dynarr_declare (subwindow_cachel);
1004 } subwindow_cachel_dynarr;
1005
1006 void mark_subwindow_cachels (subwindow_cachel_dynarr *elements);
1007 void mark_subwindow_cachels_as_not_updated (struct frame *f);
1008 void reset_subwindow_cachels (struct frame *f);
1009 void unmap_subwindow (Lisp_Object subwindow);
1010 void map_subwindow (Lisp_Object subwindow, int x, int y,
1011                     struct display_glyph_area *dga);
1012 int find_matching_subwindow (struct frame* f, int x, int y, int width, int height);
1013 void update_widget (Lisp_Object widget);
1014 void update_subwindow (Lisp_Object subwindow);
1015 Lisp_Object image_instance_parent_glyph (struct Lisp_Image_Instance*);
1016
1017 struct expose_ignore
1018 {
1019   unsigned int  x, y;
1020   unsigned int  width, height;
1021   struct expose_ignore *next;
1022 };
1023
1024 int check_for_ignored_expose (struct frame* f, int x, int y, int width, int height);
1025 extern int hold_ignored_expose_registration;
1026
1027 #endif /* INCLUDED_glyphs_h_ */