1 /* Generic glyph data structures + display tables
2 Copyright (C) 1994 Board of Trustees, University of Illinois.
3 Copyright (C) 1995, 1996 Ben Wing
5 This file is part of XEmacs.
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
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
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. */
22 /* Synched up with: Not in FSF. */
24 #ifndef INCLUDED_glyphs_h_
25 #define INCLUDED_glyphs_h_
27 #include "specifier.h"
30 /************************************************************************/
31 /* Image Instantiators */
32 /************************************************************************/
34 struct image_instantiator_methods;
36 /* Remember the distinction between image instantiator formats and
37 image instance types. Here's an approximate mapping:
39 image instantiator format image instance type
40 ------------------------- -------------------
44 xbm mono-pixmap, color-pixmap, pointer
45 xpm color-pixmap, mono-pixmap, pointer
46 xface mono-pixmap, color-pixmap, pointer
53 mswindows-resource pointer, color-pixmap
57 autodetect mono-pixmap, color-pixmap, pointer, text
70 /* These are methods specific to a particular format of image instantiator
71 (e.g. xpm, string, etc.). */
73 typedef struct ii_keyword_entry ii_keyword_entry;
74 struct ii_keyword_entry
77 void (*validate) (Lisp_Object data);
84 Dynarr_declare (ii_keyword_entry);
85 } ii_keyword_entry_dynarr;
87 extern const struct struct_description iim_description;
89 enum image_instance_geometry
92 IMAGE_DESIRED_GEOMETRY,
97 #define IMAGE_UNSPECIFIED_GEOMETRY -1
98 #define IMAGE_UNCHANGED_GEOMETRY -2
100 #define WIDGET_BORDER_HEIGHT 4
101 #define WIDGET_BORDER_WIDTH 4
103 enum governing_domain
105 GOVERNING_DOMAIN_WINDOW,
106 GOVERNING_DOMAIN_FRAME,
107 GOVERNING_DOMAIN_DEVICE
110 struct image_instantiator_methods
114 Lisp_Object device; /* sometimes used */
116 ii_keyword_entry_dynarr *keywords;
117 /* consoles this ii is supported on */
118 console_type_entry_dynarr *consoles;
119 /* Implementation specific methods: */
121 /* Validate method: Given an instantiator vector, signal an error if
122 it's invalid for this image-instantiator format. Note that this
123 validation only occurs after all the keyword-specific validation
124 has already been performed. This is chiefly useful for making
125 sure that certain required keywords are present. */
126 void (*validate_method) (Lisp_Object instantiator);
128 /* Normalize method: Given an instantiator, convert it to the form
129 that should be used in a glyph, for devices of type CONSOLE_TYPE.
130 Signal an error if conversion fails. */
131 Lisp_Object (*normalize_method) (Lisp_Object instantiator,
132 Lisp_Object console_type,
133 Lisp_Object dest_mask);
135 /* Governing domain method: Return an int indicating what type of
136 domain an instance in this format is governed by. */
137 int (*governing_domain_method) (void);
139 /* Possible-dest-types method: Return a mask indicating what dest types
140 are compatible with this format. */
141 int (*possible_dest_types_method) (void);
143 /* Instantiate method: Given an instantiator and a partially
144 filled-in image instance, complete the filling-in. Return
145 non-zero if the instantiation succeeds, 0 if it fails.
146 This must be present. */
147 void (*instantiate_method) (Lisp_Object image_instance,
148 Lisp_Object instantiator,
149 Lisp_Object pointer_fg,
150 Lisp_Object pointer_bg,
153 /* Post instantiate method: finish instantiation of the image
155 void (*post_instantiate_method) (Lisp_Object image_instance,
156 Lisp_Object instantiator,
158 /* Property method: Given an image instance, return device specific
160 Lisp_Object (*property_method) (Lisp_Object image_instance,
161 Lisp_Object property);
162 /* Set-property method: Given an image instance, set device specific
164 Lisp_Object (*set_property_method) (Lisp_Object image_instance,
165 Lisp_Object property,
167 /* Asynchronously update properties. */
168 void (*update_method) (Lisp_Object image_instance,
169 Lisp_Object instantiator);
170 void (*redisplay_method) (Lisp_Object image_instance);
172 /* Find out the desired geometry, as given by disp, of this image
173 instance. Actual geometry is stored in the appropriate slots in the
175 void (*query_geometry_method) (Lisp_Object image_instance,
176 int* width, int* height,
177 enum image_instance_geometry disp,
180 /* Layout the instance and its children bounded by the provided
181 dimensions. Returns success or failure. */
182 int (*layout_method) (Lisp_Object image_instance,
183 int width, int height, int xoffset, int yoffset,
187 /***** Calling an image-instantiator method *****/
189 #define HAS_IIFORMAT_METH_P(mstruc, m) (((mstruc)->m##_method) != 0)
190 #define IIFORMAT_METH(mstruc, m, args) (((mstruc)->m##_method) args)
192 /* Call a void-returning specifier method, if it exists */
193 #define MAYBE_IIFORMAT_METH(mstruc, m, args) \
195 struct image_instantiator_methods *MIM_mstruc = (mstruc); \
196 if (MIM_mstruc && HAS_IIFORMAT_METH_P (MIM_mstruc, m)) \
197 IIFORMAT_METH (MIM_mstruc, m, args); \
200 #define MAYBE_IIFORMAT_DEVMETH(device, mstruc, m, args) \
202 struct image_instantiator_methods *MID_mstruc = \
203 decode_ii_device (device, mstruc); \
205 MAYBE_IIFORMAT_METH(MID_mstruc, m, args); \
209 /* Call a specifier method, if it exists; otherwise return
210 the specified value */
212 #define IIFORMAT_METH_OR_GIVEN(mstruc, m, args, given) \
213 ((mstruc && HAS_IIFORMAT_METH_P (mstruc, m)) ? \
214 IIFORMAT_METH (mstruc, m, args) : (given))
216 /***** Defining new image-instantiator types *****/
218 #define DECLARE_IMAGE_INSTANTIATOR_FORMAT(format) \
219 extern struct image_instantiator_methods *format##_image_instantiator_methods
221 #define DEFINE_IMAGE_INSTANTIATOR_FORMAT(format) \
222 struct image_instantiator_methods *format##_image_instantiator_methods
224 #define INITIALIZE_IMAGE_INSTANTIATOR_FORMAT_NO_SYM(format, obj_name) \
226 format##_image_instantiator_methods = \
227 xnew_and_zero (struct image_instantiator_methods); \
228 format##_image_instantiator_methods->symbol = Q##format; \
229 format##_image_instantiator_methods->device = Qnil; \
230 format##_image_instantiator_methods->keywords = \
231 Dynarr_new (ii_keyword_entry); \
232 format##_image_instantiator_methods->consoles = \
233 Dynarr_new (console_type_entry); \
234 add_entry_to_image_instantiator_format_list \
235 (Q##format, format##_image_instantiator_methods); \
236 dumpstruct (&format##_image_instantiator_methods, \
240 #define INITIALIZE_IMAGE_INSTANTIATOR_FORMAT(format, obj_name) \
242 defsymbol (&Q##format, obj_name); \
243 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT_NO_SYM(format, obj_name);\
246 /* Declare that image-instantiator format FORMAT has method M; used in
247 initialization routines */
248 #define IIFORMAT_HAS_METHOD(format, m) \
249 (format##_image_instantiator_methods->m##_method = format##_##m)
251 #define IIFORMAT_HAS_SHARED_METHOD(format, m, type) \
252 (format##_image_instantiator_methods->m##_method = type##_##m)
254 /* Declare that KEYW is a valid keyword for image-instantiator format
255 FORMAT. VALIDATE_FUN if a function that returns whether the data
256 is valid. The keyword may not appear more than once. */
257 #define IIFORMAT_VALID_GENERIC_KEYWORD(format, keyw, validate_fun, copy, multi) \
259 struct ii_keyword_entry entry; \
261 entry.keyword = keyw; \
262 entry.validate = validate_fun; \
263 entry.multiple_p = multi; \
264 entry.copy_p = copy; \
265 Dynarr_add (format##_image_instantiator_methods->keywords, \
269 #define IIFORMAT_VALID_KEYWORD(format, keyw, validate_fun) \
270 IIFORMAT_VALID_GENERIC_KEYWORD(format, keyw, validate_fun, 1, 0)
272 /* Same as IIFORMAT_VALID_KEYWORD except that the keyword may
273 appear multiple times. */
274 #define IIFORMAT_VALID_MULTI_KEYWORD(format, keyw, validate_fun) \
275 IIFORMAT_VALID_GENERIC_KEYWORD(format, keyw, validate_fun, 1, 1)
277 /* Same as IIFORMAT_VALID_KEYWORD except that the argument is not
278 copied by the specifier functions. This is necessary for things
279 like callbacks etc. */
280 #define IIFORMAT_VALID_NONCOPY_KEYWORD(format, keyw, validate_fun) \
281 IIFORMAT_VALID_GENERIC_KEYWORD(format, keyw, validate_fun, 0, 0)
283 /* Declare that image-instantiator format FORMAT is supported on
285 #define IIFORMAT_VALID_CONSOLE(console, format) \
287 struct console_type_entry entry; \
289 entry.symbol = Q##console; \
290 entry.meths = console##_console_methods; \
291 Dynarr_add (format##_image_instantiator_methods->consoles, \
295 #define IIFORMAT_VALID_CONSOLE2(con1, con2, format) \
296 IIFORMAT_VALID_CONSOLE (con1, format); \
297 IIFORMAT_VALID_CONSOLE (con2, format);
299 #define DEFINE_DEVICE_IIFORMAT(type, format) \
300 DECLARE_IMAGE_INSTANTIATOR_FORMAT(format); \
301 struct image_instantiator_methods *type##_##format##_image_instantiator_methods
303 #define INITIALIZE_DEVICE_IIFORMAT(type, format) \
305 type##_##format##_image_instantiator_methods = \
306 xnew_and_zero (struct image_instantiator_methods); \
307 type##_##format##_image_instantiator_methods->symbol = Q##format; \
308 type##_##format##_image_instantiator_methods->device = Q##type; \
309 type##_##format##_image_instantiator_methods->keywords = \
310 Dynarr_new (ii_keyword_entry); \
311 add_entry_to_device_ii_format_list \
312 (Q##type, Q##format, type##_##format##_image_instantiator_methods); \
313 IIFORMAT_VALID_CONSOLE(type,format); \
314 dumpstruct (&type##_##format##_image_instantiator_methods, \
318 /* Declare that image-instantiator format FORMAT has method M; used in
319 initialization routines */
320 #define IIFORMAT_HAS_DEVMETHOD(type, format, m) \
321 (type##_##format##_image_instantiator_methods->m##_method = type##_##format##_##m)
322 #define IIFORMAT_HAS_SHARED_DEVMETHOD(type, format, m, fromformat) \
323 (type##_##format##_image_instantiator_methods->m##_method = type##_##fromformat##_##m)
325 #define IIFORMAT_INHERITS_DEVMETHOD(type, from, format, m) \
326 (type##_##format##_image_instantiator_methods->m##_method = from##_##format##_##m)
327 #define IIFORMAT_INHERITS_SHARED_DEVMETHOD(type, from, format, m, fromformat) \
328 (type##_##format##_image_instantiator_methods->m##_method = from##_##fromformat##_##m)
330 struct image_instantiator_methods *
331 decode_device_ii_format (Lisp_Object device, Lisp_Object format,
332 Error_behavior errb);
333 struct image_instantiator_methods *
334 decode_image_instantiator_format (Lisp_Object format, Error_behavior errb);
336 void add_entry_to_image_instantiator_format_list (Lisp_Object symbol,
337 struct image_instantiator_methods *meths);
338 void add_entry_to_device_ii_format_list (Lisp_Object device, Lisp_Object symbol,
339 struct image_instantiator_methods *meths);
340 Lisp_Object find_keyword_in_vector (Lisp_Object vector,
341 Lisp_Object keyword);
342 Lisp_Object find_keyword_in_vector_or_given (Lisp_Object vector,
344 Lisp_Object default_);
345 Lisp_Object simple_image_type_normalize (Lisp_Object inst,
346 Lisp_Object console_type,
347 Lisp_Object image_type_tag);
348 Lisp_Object potential_pixmap_file_instantiator (Lisp_Object instantiator,
349 Lisp_Object file_keyword,
350 Lisp_Object data_keyword,
351 Lisp_Object console_type);
352 void check_valid_string (Lisp_Object data);
353 void check_valid_int (Lisp_Object data);
354 void check_valid_face (Lisp_Object data);
355 void check_valid_vector (Lisp_Object data);
356 void check_valid_item_list (Lisp_Object items);
358 void initialize_subwindow_image_instance (Lisp_Image_Instance*);
359 void subwindow_instantiate (Lisp_Object image_instance, Lisp_Object instantiator,
360 Lisp_Object pointer_fg, Lisp_Object pointer_bg,
361 int dest_mask, Lisp_Object domain);
362 int subwindow_governing_domain (void);
363 void widget_instantiate (Lisp_Object image_instance, Lisp_Object instantiator,
364 Lisp_Object pointer_fg, Lisp_Object pointer_bg,
365 int dest_mask, Lisp_Object domain);
366 void image_instance_query_geometry (Lisp_Object image_instance,
367 int* width, int* height,
368 enum image_instance_geometry disp,
370 void image_instance_layout (Lisp_Object image_instance,
371 int width, int height, int xoffset, int yoffset,
373 int layout_layout (Lisp_Object image_instance,
374 int width, int height, int xoffset, int yoffset,
376 int invalidate_glyph_geometry_maybe (Lisp_Object glyph_or_ii, struct window* w);
378 DECLARE_DOESNT_RETURN (incompatible_image_types (Lisp_Object instantiator,
380 int desired_dest_mask));
381 DECLARE_DOESNT_RETURN (signal_image_error (const char *, Lisp_Object));
382 DECLARE_DOESNT_RETURN (signal_image_error_2 (const char *, Lisp_Object, Lisp_Object));
384 /************************************************************************/
385 /* Image Specifier Object */
386 /************************************************************************/
388 DECLARE_SPECIFIER_TYPE (image);
389 #define XIMAGE_SPECIFIER(x) XSPECIFIER_TYPE (x, image)
390 #define XSETIMAGE_SPECIFIER(x, p) XSETSPECIFIER_TYPE (x, p, image)
391 #define IMAGE_SPECIFIERP(x) SPECIFIER_TYPEP (x, image)
392 #define CHECK_IMAGE_SPECIFIER(x) CHECK_SPECIFIER_TYPE (x, image)
393 #define CONCHECK_IMAGE_SPECIFIER(x) CONCHECK_SPECIFIER_TYPE (x, image)
395 void set_image_attached_to (Lisp_Object obj, Lisp_Object face_or_glyph,
396 Lisp_Object property);
398 struct image_specifier
401 Lisp_Object attachee; /* face or glyph this is attached to, or nil */
402 Lisp_Object attachee_property;/* property of that face or glyph */
405 #define IMAGE_SPECIFIER_DATA(g) (SPECIFIER_TYPE_DATA (g, image))
406 #define IMAGE_SPECIFIER_ALLOWED(g) (IMAGE_SPECIFIER_DATA (g)->allowed)
407 #define IMAGE_SPECIFIER_ATTACHEE(g) (IMAGE_SPECIFIER_DATA (g)->attachee)
408 #define IMAGE_SPECIFIER_ATTACHEE_PROPERTY(g) \
409 (IMAGE_SPECIFIER_DATA (g)->attachee_property)
411 #define XIMAGE_SPECIFIER_ALLOWED(g) \
412 IMAGE_SPECIFIER_ALLOWED (XIMAGE_SPECIFIER (g))
414 /************************************************************************/
415 /* Image Instance Object */
416 /************************************************************************/
418 DECLARE_LRECORD (image_instance, Lisp_Image_Instance);
419 #define XIMAGE_INSTANCE(x) XRECORD (x, image_instance, Lisp_Image_Instance)
420 #define XSETIMAGE_INSTANCE(x, p) XSETRECORD (x, p, image_instance)
421 #define IMAGE_INSTANCEP(x) RECORDP (x, image_instance)
422 #define CHECK_IMAGE_INSTANCE(x) CHECK_RECORD (x, image_instance)
423 #define CONCHECK_IMAGE_INSTANCE(x) CONCHECK_RECORD (x, image_instance)
425 #ifdef ERROR_CHECK_GLYPHS
426 void check_image_instance_structure (Lisp_Object instance);
427 void check_window_subwindow_cache (struct window* w);
428 #define ERROR_CHECK_IMAGE_INSTANCE(ii) \
429 check_image_instance_structure (ii)
430 #define ERROR_CHECK_SUBWINDOW_CACHE(w) \
431 check_window_subwindow_cache (w)
433 #define ERROR_CHECK_IMAGE_INSTANCE(ii)
434 #define ERROR_CHECK_SUBWINDOW_CACHE(w)
437 enum image_instance_type
449 #define IMAGE_NOTHING_MASK (1 << 0)
450 #define IMAGE_TEXT_MASK (1 << 1)
451 #define IMAGE_MONO_PIXMAP_MASK (1 << 2)
452 #define IMAGE_COLOR_PIXMAP_MASK (1 << 3)
453 #define IMAGE_POINTER_MASK (1 << 4)
454 #define IMAGE_SUBWINDOW_MASK (1 << 5)
455 #define IMAGE_WIDGET_MASK (1 << 6)
457 /* This depends on the fact that enums are assigned consecutive
458 integers starting at 0. (Remember that IMAGE_UNKNOWN is the
459 first enum.) I'm fairly sure this behavior is ANSI-mandated,
460 so there should be no portability problems here. */
461 #define image_instance_type_to_mask(type) \
462 ((int) (1 << ((int) (type) - 1)))
464 #define IMAGE_INSTANCE_TYPE_P(ii, type) \
465 (IMAGE_INSTANCEP (ii) && XIMAGE_INSTANCE_TYPE (ii) == type)
467 #define NOTHING_IMAGE_INSTANCEP(ii) \
468 IMAGE_INSTANCE_TYPE_P (ii, IMAGE_NOTHING)
469 #define TEXT_IMAGE_INSTANCEP(ii) \
470 IMAGE_INSTANCE_TYPE_P (ii, IMAGE_TEXT)
471 #define MONO_PIXMAP_IMAGE_INSTANCEP(ii) \
472 IMAGE_INSTANCE_TYPE_P (ii, IMAGE_MONO_PIXMAP)
473 #define COLOR_PIXMAP_IMAGE_INSTANCEP(ii) \
474 IMAGE_INSTANCE_TYPE_P (ii, IMAGE_COLOR_PIXMAP)
475 #define POINTER_IMAGE_INSTANCEP(ii) \
476 IMAGE_INSTANCE_TYPE_P (ii, IMAGE_POINTER)
477 #define SUBWINDOW_IMAGE_INSTANCEP(ii) \
478 IMAGE_INSTANCE_TYPE_P (ii, IMAGE_SUBWINDOW)
479 #define WIDGET_IMAGE_INSTANCEP(ii) \
480 IMAGE_INSTANCE_TYPE_P (ii, IMAGE_WIDGET)
482 #define CHECK_NOTHING_IMAGE_INSTANCE(x) do { \
483 CHECK_IMAGE_INSTANCE (x); \
484 if (!NOTHING_IMAGE_INSTANCEP (x)) \
485 x = wrong_type_argument (Qnothing_image_instance_p, (x)); \
488 #define CHECK_TEXT_IMAGE_INSTANCE(x) do { \
489 CHECK_IMAGE_INSTANCE (x); \
490 if (!TEXT_IMAGE_INSTANCEP (x)) \
491 x = wrong_type_argument (Qtext_image_instance_p, (x)); \
494 #define CHECK_MONO_PIXMAP_IMAGE_INSTANCE(x) do { \
495 CHECK_IMAGE_INSTANCE (x); \
496 if (!MONO_PIXMAP_IMAGE_INSTANCEP (x)) \
497 x = wrong_type_argument (Qmono_pixmap_image_instance_p, (x)); \
500 #define CHECK_COLOR_PIXMAP_IMAGE_INSTANCE(x) do { \
501 CHECK_IMAGE_INSTANCE (x); \
502 if (!COLOR_PIXMAP_IMAGE_INSTANCEP (x)) \
503 x = wrong_type_argument (Qcolor_pixmap_image_instance_p, (x)); \
506 #define CHECK_POINTER_IMAGE_INSTANCE(x) do { \
507 CHECK_IMAGE_INSTANCE (x); \
508 if (!POINTER_IMAGE_INSTANCEP (x)) \
509 x = wrong_type_argument (Qpointer_image_instance_p, (x)); \
512 #define CHECK_SUBWINDOW_IMAGE_INSTANCE(x) do { \
513 CHECK_IMAGE_INSTANCE (x); \
514 if (!SUBWINDOW_IMAGE_INSTANCEP (x) \
515 && !WIDGET_IMAGE_INSTANCEP (x)) \
516 x = wrong_type_argument (Qsubwindow_image_instance_p, (x)); \
519 #define CHECK_WIDGET_IMAGE_INSTANCE(x) do { \
520 CHECK_IMAGE_INSTANCE (x); \
521 if (!WIDGET_IMAGE_INSTANCEP (x)) \
522 x = wrong_type_argument (Qwidget_image_instance_p, (x)); \
525 struct Lisp_Image_Instance
527 struct lcrecord_header header;
528 Lisp_Object domain; /* The domain in which we were cached. */
529 Lisp_Object device; /* The device of the domain. Recorded
530 since the domain may get deleted
533 /* The glyph from which we were instantiated. This is a weak
536 /* The instantiator from which we were instantiated. */
537 Lisp_Object instantiator;
538 enum image_instance_type type;
539 unsigned int x_offset, y_offset; /* for layout purposes */
540 int width, height, margin_width;
541 unsigned long display_hash; /* Hash value representing the structure
542 of the image_instance when it was
544 unsigned int dirty : 1;
545 unsigned int size_changed : 1;
546 unsigned int text_changed : 1;
547 unsigned int layout_changed : 1;
548 unsigned int optimize_output : 1; /* For outputting layouts. */
549 unsigned int initialized : 1; /* When we're fully done. */
550 unsigned int wants_initial_focus : 1;
556 unsigned int descent;
562 unsigned int slice, maxslice, timeout;
563 Lisp_Object hotspot_x, hotspot_y; /* integer or Qnil */
564 Lisp_Object filename; /* string or Qnil */
565 Lisp_Object mask_filename; /* string or Qnil */
566 Lisp_Object fg, bg; /* foreground and background colors,
567 if this is a colorized mono-pixmap
569 Lisp_Object auxdata; /* list or Qnil: any additional data
570 to be seen from lisp */
571 void* mask; /* mask that can be seen from all windowing systems */
572 } pixmap; /* used for pointers as well */
575 void* subwindow; /* specific devices can use this as necessary */
577 { /* We need these so we can do without
580 unsigned int width, height;
582 unsigned int being_displayed : 1; /* used to detect when needs
584 unsigned int v_resize : 1; /* Whether the vsize is allowed to change. */
585 unsigned int h_resize : 1; /* Whether the hsize is allowed to change. */
586 unsigned int orientation : 1; /* Vertical or horizontal. */
587 unsigned int justification : 2; /* Left, right or center. */
588 /* Face for colors and font. We specify this here because we
589 want people to be able to put :face in the instantiator
590 spec. Using glyph-face is more inconvenient, although more
594 Lisp_Object props; /* properties or border*/
595 Lisp_Object items; /* a list of displayed gui_items */
596 Lisp_Object pending_items; /* gui_items that should be displayed */
597 Lisp_Object children; /* a list of children */
598 Lisp_Object width; /* dynamic width spec. */
599 Lisp_Object height; /* dynamic height spec. */
600 /* Change flags to augment dirty. */
601 unsigned int face_changed : 1;
602 unsigned int items_changed : 1;
603 unsigned int action_occurred : 1;
607 /* console-type- and image-type-specific data */
611 /* Layout bit-fields. */
612 #define LAYOUT_HORIZONTAL 0
613 #define LAYOUT_VERTICAL 1
615 #define LAYOUT_JUSTIFY_LEFT 0
616 #define LAYOUT_JUSTIFY_RIGHT 1
617 #define LAYOUT_JUSTIFY_CENTER 2
619 #define IMAGE_INSTANCE_HASH_DEPTH 0
621 /* Accessor macros. */
622 #define IMAGE_INSTANCE_DOMAIN(i) ((i)->domain)
623 #define IMAGE_INSTANCE_DOMAIN_LIVE_P(i) (DOMAIN_LIVE_P ((i)->domain))
624 #define IMAGE_INSTANCE_DEVICE(i) ((i)->device)
625 #define IMAGE_INSTANCE_FRAME(i) (DOMAIN_FRAME ((i)->domain))
626 #define IMAGE_INSTANCE_NAME(i) ((i)->name)
627 #define IMAGE_INSTANCE_PARENT(i) ((i)->parent)
628 #define IMAGE_INSTANCE_INSTANTIATOR(i) ((i)->instantiator)
629 #define IMAGE_INSTANCE_GLYPH(i) (image_instance_parent_glyph(i))
630 #define IMAGE_INSTANCE_TYPE(i) ((i)->type)
631 #define IMAGE_INSTANCE_XOFFSET(i) ((i)->x_offset)
632 #define IMAGE_INSTANCE_YOFFSET(i) ((i)->y_offset)
633 #define IMAGE_INSTANCE_WIDTH(i) ((i)->width)
634 #define IMAGE_INSTANCE_MARGIN_WIDTH(i) ((i)->margin_width)
635 #define IMAGE_INSTANCE_HEIGHT(i) ((i)->height)
636 #define IMAGE_INSTANCE_INITIALIZED(i) ((i)->initialized)
637 #define IMAGE_INSTANCE_DISPLAY_HASH(i) ((i)->display_hash)
638 #define IMAGE_INSTANCE_PIXMAP_TYPE_P(i) \
639 ((IMAGE_INSTANCE_TYPE (i) == IMAGE_MONO_PIXMAP) \
640 || (IMAGE_INSTANCE_TYPE (i) == IMAGE_COLOR_PIXMAP))
641 #define IMAGE_INSTANCE_DIRTYP(i) ((i)->dirty)
642 #define IMAGE_INSTANCE_NEEDS_LAYOUT(i) \
643 ((IMAGE_INSTANCE_DIRTYP (i) && IMAGE_INSTANCE_LAYOUT_CHANGED (i)) \
644 || (FRAMEP (IMAGE_INSTANCE_FRAME (i)) \
645 && XFRAME (IMAGE_INSTANCE_FRAME (i))->size_changed))
646 #define IMAGE_INSTANCE_FACE(i) \
647 (GLYPHP (IMAGE_INSTANCE_GLYPH (i)) ? \
648 XGLYPH_FACE (IMAGE_INSTANCE_GLYPH (i)) : Qnil)
649 #define IMAGE_INSTANCE_WANTS_INITIAL_FOCUS(i) ((i)->wants_initial_focus)
652 #define IMAGE_INSTANCE_TEXT_CHANGED(i) ((i)->text_changed)
653 #define IMAGE_INSTANCE_SIZE_CHANGED(i) ((i)->size_changed)
654 #define IMAGE_INSTANCE_WIDGET_FACE_CHANGED(i) \
655 ((i)->u.subwindow.face_changed)
656 #define IMAGE_INSTANCE_WIDGET_ITEMS_CHANGED(i) \
657 ((i)->u.subwindow.items_changed)
658 #define IMAGE_INSTANCE_WIDGET_ACTION_OCCURRED(i) \
659 ((i)->u.subwindow.action_occurred)
660 #define IMAGE_INSTANCE_LAYOUT_CHANGED(i) ((i)->layout_changed)
661 #define IMAGE_INSTANCE_OPTIMIZE_OUTPUT(i) ((i)->optimize_output)
663 /* Text properties */
664 #define IMAGE_INSTANCE_TEXT_STRING(i) ((i)->u.text.string)
665 #define IMAGE_INSTANCE_TEXT_WIDTH(i) \
666 IMAGE_INSTANCE_WIDTH(i)
667 #define IMAGE_INSTANCE_TEXT_HEIGHT(i) \
668 IMAGE_INSTANCE_HEIGHT(i)
669 #define IMAGE_INSTANCE_TEXT_DESCENT(i) ((i)->u.text.descent)
670 #define IMAGE_INSTANCE_TEXT_ASCENT(i) \
671 (IMAGE_INSTANCE_TEXT_HEIGHT(i) - IMAGE_INSTANCE_TEXT_DESCENT(i))
673 /* Pixmap properties */
674 #define IMAGE_INSTANCE_PIXMAP_WIDTH(i) \
675 IMAGE_INSTANCE_WIDTH(i)
676 #define IMAGE_INSTANCE_PIXMAP_HEIGHT(i) \
677 IMAGE_INSTANCE_HEIGHT(i)
678 #define IMAGE_INSTANCE_PIXMAP_DEPTH(i) ((i)->u.pixmap.depth)
679 #define IMAGE_INSTANCE_PIXMAP_FILENAME(i) ((i)->u.pixmap.filename)
680 #define IMAGE_INSTANCE_PIXMAP_MASK_FILENAME(i) ((i)->u.pixmap.mask_filename)
681 #define IMAGE_INSTANCE_PIXMAP_HOTSPOT_X(i) ((i)->u.pixmap.hotspot_x)
682 #define IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y(i) ((i)->u.pixmap.hotspot_y)
683 #define IMAGE_INSTANCE_PIXMAP_FG(i) ((i)->u.pixmap.fg)
684 #define IMAGE_INSTANCE_PIXMAP_BG(i) ((i)->u.pixmap.bg)
685 #define IMAGE_INSTANCE_PIXMAP_AUXDATA(i) ((i)->u.pixmap.auxdata)
686 #define IMAGE_INSTANCE_PIXMAP_MASK(i) ((i)->u.pixmap.mask)
687 #define IMAGE_INSTANCE_PIXMAP_SLICE(i) ((i)->u.pixmap.slice)
688 #define IMAGE_INSTANCE_PIXMAP_MAXSLICE(i) ((i)->u.pixmap.maxslice)
689 #define IMAGE_INSTANCE_PIXMAP_TIMEOUT(i) ((i)->u.pixmap.timeout)
691 /* Subwindow properties */
692 #define IMAGE_INSTANCE_SUBWINDOW_ID(i) ((i)->u.subwindow.subwindow)
694 #define IMAGE_INSTANCE_DISPLAY_X(i) ((i)->u.subwindow.display_data.x)
695 #define IMAGE_INSTANCE_DISPLAY_Y(i) ((i)->u.subwindow.display_data.y)
696 #define IMAGE_INSTANCE_DISPLAY_WIDTH(i) \
697 ((i)->u.subwindow.display_data.width)
698 #define IMAGE_INSTANCE_DISPLAY_HEIGHT(i) \
699 ((i)->u.subwindow.display_data.height)
700 #define IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP(i) \
701 ((i)->u.subwindow.being_displayed)
702 #define IMAGE_INSTANCE_SUBWINDOW_V_RESIZEP(i) \
703 ((i)->u.subwindow.v_resize)
704 #define IMAGE_INSTANCE_SUBWINDOW_H_RESIZEP(i) \
705 ((i)->u.subwindow.h_resize)
706 #define IMAGE_INSTANCE_SUBWINDOW_ORIENT(i) \
707 ((i)->u.subwindow.orientation)
708 #define IMAGE_INSTANCE_SUBWINDOW_JUSTIFY(i) \
709 ((i)->u.subwindow.justification)
710 #define IMAGE_INSTANCE_SUBWINDOW_FACE(i) \
711 ((i)->u.subwindow.face)
713 /* Widget properties */
714 #define IMAGE_INSTANCE_WIDGET_WIDTH(i) \
715 IMAGE_INSTANCE_WIDTH(i)
716 #define IMAGE_INSTANCE_WIDGET_HEIGHT(i) \
717 IMAGE_INSTANCE_HEIGHT(i)
718 #define IMAGE_INSTANCE_WIDGET_WIDTH_SUBR(i) ((i)->u.subwindow.width)
719 #define IMAGE_INSTANCE_WIDGET_HEIGHT_SUBR(i) ((i)->u.subwindow.height)
720 #define IMAGE_INSTANCE_WIDGET_TYPE(i) ((i)->u.subwindow.type)
721 #define IMAGE_INSTANCE_WIDGET_PROPS(i) ((i)->u.subwindow.props)
722 #define SET_IMAGE_INSTANCE_WIDGET_FACE(i,f) \
723 ((i)->u.subwindow.face = f)
724 #define IMAGE_INSTANCE_WIDGET_FACE(i) \
725 (!NILP ((i)->u.subwindow.face) ? (i)->u.subwindow.face : \
726 !NILP (IMAGE_INSTANCE_FACE (i)) ? IMAGE_INSTANCE_FACE (i) : \
728 #define IMAGE_INSTANCE_WIDGET_ITEMS(i) ((i)->u.subwindow.items)
729 #define IMAGE_INSTANCE_WIDGET_PENDING_ITEMS(i) \
730 ((i)->u.subwindow.pending_items)
731 #define IMAGE_INSTANCE_WIDGET_ITEM(i) \
732 (CONSP (IMAGE_INSTANCE_WIDGET_ITEMS (i)) ? \
733 XCAR (IMAGE_INSTANCE_WIDGET_ITEMS (i)) : \
734 IMAGE_INSTANCE_WIDGET_ITEMS (i))
735 #define IMAGE_INSTANCE_WIDGET_TEXT(i) \
736 XGUI_ITEM (IMAGE_INSTANCE_WIDGET_ITEM (i))->name
738 /* Layout properties */
739 #define IMAGE_INSTANCE_LAYOUT_CHILDREN(i) ((i)->u.subwindow.children)
740 #define IMAGE_INSTANCE_LAYOUT_BORDER(i) ((i)->u.subwindow.props)
742 #define XIMAGE_INSTANCE_DOMAIN(i) \
743 IMAGE_INSTANCE_DOMAIN (XIMAGE_INSTANCE (i))
744 #define XIMAGE_INSTANCE_DOMAIN_LIVE_P(i) \
745 IMAGE_INSTANCE_DOMAIN_LIVE_P (XIMAGE_INSTANCE (i))
746 #define XIMAGE_INSTANCE_DEVICE(i) \
747 IMAGE_INSTANCE_DEVICE (XIMAGE_INSTANCE (i))
748 #define XIMAGE_INSTANCE_FRAME(i) \
749 IMAGE_INSTANCE_FRAME (XIMAGE_INSTANCE (i))
750 #define XIMAGE_INSTANCE_NAME(i) \
751 IMAGE_INSTANCE_NAME (XIMAGE_INSTANCE (i))
752 #define XIMAGE_INSTANCE_GLYPH(i) \
753 IMAGE_INSTANCE_GLYPH (XIMAGE_INSTANCE (i))
754 #define XIMAGE_INSTANCE_PARENT(i) \
755 IMAGE_INSTANCE_PARENT (XIMAGE_INSTANCE (i))
756 #define XIMAGE_INSTANCE_INSTANTIATOR(i) \
757 IMAGE_INSTANCE_INSTANTIATOR (XIMAGE_INSTANCE (i))
758 #define XIMAGE_INSTANCE_TYPE(i) \
759 IMAGE_INSTANCE_TYPE (XIMAGE_INSTANCE (i))
760 #define XIMAGE_INSTANCE_DISPLAY_HASH(i) \
761 IMAGE_INSTANCE_DISPLAY_HASH (XIMAGE_INSTANCE (i))
762 #define XIMAGE_INSTANCE_XOFFSET(i) \
763 IMAGE_INSTANCE_XOFFSET (XIMAGE_INSTANCE (i))
764 #define XIMAGE_INSTANCE_YOFFSET(i) \
765 IMAGE_INSTANCE_YOFFSET (XIMAGE_INSTANCE (i))
766 #define XIMAGE_INSTANCE_DIRTYP(i) \
767 IMAGE_INSTANCE_DIRTYP (XIMAGE_INSTANCE (i))
768 #define XIMAGE_INSTANCE_NEEDS_LAYOUT(i) \
769 IMAGE_INSTANCE_NEEDS_LAYOUT (XIMAGE_INSTANCE (i))
770 #define XIMAGE_INSTANCE_WIDTH(i) \
771 IMAGE_INSTANCE_WIDTH (XIMAGE_INSTANCE (i))
772 #define XIMAGE_INSTANCE_MARGIN_WIDTH(i) \
773 IMAGE_INSTANCE_MARGIN_WIDTH (XIMAGE_INSTANCE (i))
774 #define XIMAGE_INSTANCE_HEIGHT(i) \
775 IMAGE_INSTANCE_HEIGHT (XIMAGE_INSTANCE (i))
776 #define XIMAGE_INSTANCE_INITIALIZED(i) \
777 IMAGE_INSTANCE_INITIALIZED (XIMAGE_INSTANCE (i))
778 #define XIMAGE_INSTANCE_FACE(i) \
779 IMAGE_INSTANCE_FACE (XIMAGE_INSTANCE (i))
781 #define XIMAGE_INSTANCE_TEXT_STRING(i) \
782 IMAGE_INSTANCE_TEXT_STRING (XIMAGE_INSTANCE (i))
783 #define XIMAGE_INSTANCE_TEXT_WIDTH(i) \
784 IMAGE_INSTANCE_TEXT_WIDTH (XIMAGE_INSTANCE (i))
785 #define XIMAGE_INSTANCE_TEXT_HEIGHT(i) \
786 IMAGE_INSTANCE_TEXT_HEIGHT (XIMAGE_INSTANCE (i))
787 #define XIMAGE_INSTANCE_TEXT_ASCENT(i) \
788 IMAGE_INSTANCE_TEXT_ASCENT (XIMAGE_INSTANCE (i))
789 #define XIMAGE_INSTANCE_TEXT_DESCENT(i) \
790 IMAGE_INSTANCE_TEXT_DESCENT (XIMAGE_INSTANCE (i))
792 #define XIMAGE_INSTANCE_PIXMAP_WIDTH(i) \
793 IMAGE_INSTANCE_PIXMAP_WIDTH (XIMAGE_INSTANCE (i))
794 #define XIMAGE_INSTANCE_PIXMAP_HEIGHT(i) \
795 IMAGE_INSTANCE_PIXMAP_HEIGHT (XIMAGE_INSTANCE (i))
796 #define XIMAGE_INSTANCE_PIXMAP_DEPTH(i) \
797 IMAGE_INSTANCE_PIXMAP_DEPTH (XIMAGE_INSTANCE (i))
798 #define XIMAGE_INSTANCE_PIXMAP_FILENAME(i) \
799 IMAGE_INSTANCE_PIXMAP_FILENAME (XIMAGE_INSTANCE (i))
800 #define XIMAGE_INSTANCE_PIXMAP_MASK_FILENAME(i) \
801 IMAGE_INSTANCE_PIXMAP_MASK_FILENAME (XIMAGE_INSTANCE (i))
802 #define XIMAGE_INSTANCE_PIXMAP_HOTSPOT_X(i) \
803 IMAGE_INSTANCE_PIXMAP_HOTSPOT_X (XIMAGE_INSTANCE (i))
804 #define XIMAGE_INSTANCE_PIXMAP_HOTSPOT_Y(i) \
805 IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (XIMAGE_INSTANCE (i))
806 #define XIMAGE_INSTANCE_PIXMAP_FG(i) \
807 IMAGE_INSTANCE_PIXMAP_FG (XIMAGE_INSTANCE (i))
808 #define XIMAGE_INSTANCE_PIXMAP_BG(i) \
809 IMAGE_INSTANCE_PIXMAP_BG (XIMAGE_INSTANCE (i))
810 #define XIMAGE_INSTANCE_PIXMAP_MASK(i) \
811 IMAGE_INSTANCE_PIXMAP_MASK (XIMAGE_INSTANCE (i))
812 #define XIMAGE_INSTANCE_PIXMAP_SLICE(i) \
813 IMAGE_INSTANCE_PIXMAP_SLICE (XIMAGE_INSTANCE (i))
814 #define XIMAGE_INSTANCE_PIXMAP_MAXSLICE(i) \
815 IMAGE_INSTANCE_PIXMAP_MAXSLICE (XIMAGE_INSTANCE (i))
816 #define XIMAGE_INSTANCE_PIXMAP_TIMEOUT(i) \
817 IMAGE_INSTANCE_PIXMAP_TIMEOUT (XIMAGE_INSTANCE (i))
819 #define XIMAGE_INSTANCE_WIDGET_WIDTH(i) \
820 IMAGE_INSTANCE_WIDGET_WIDTH (XIMAGE_INSTANCE (i))
821 #define XIMAGE_INSTANCE_WIDGET_HEIGHT(i) \
822 IMAGE_INSTANCE_WIDGET_HEIGHT (XIMAGE_INSTANCE (i))
823 #define XIMAGE_INSTANCE_WIDGET_WIDTH_SUBR(i) \
824 IMAGE_INSTANCE_WIDGET_WIDTH_SUBR (XIMAGE_INSTANCE (i))
825 #define XIMAGE_INSTANCE_WIDGET_HEIGHT_SUBR(i) \
826 IMAGE_INSTANCE_WIDGET_HEIGHT_SUBR (XIMAGE_INSTANCE (i))
827 #define XIMAGE_INSTANCE_WIDGET_TYPE(i) \
828 IMAGE_INSTANCE_WIDGET_TYPE (XIMAGE_INSTANCE (i))
829 #define XIMAGE_INSTANCE_WIDGET_PROPS(i) \
830 IMAGE_INSTANCE_WIDGET_PROPS (XIMAGE_INSTANCE (i))
831 #define XIMAGE_INSTANCE_WIDGET_FACE(i) \
832 IMAGE_INSTANCE_WIDGET_FACE (XIMAGE_INSTANCE (i))
833 #define XSET_IMAGE_INSTANCE_WIDGET_FACE(i) \
834 SET_IMAGE_INSTANCE_WIDGET_FACE (XIMAGE_INSTANCE (i))
835 #define XIMAGE_INSTANCE_WIDGET_ITEM(i) \
836 IMAGE_INSTANCE_WIDGET_ITEM (XIMAGE_INSTANCE (i))
837 #define XIMAGE_INSTANCE_WIDGET_ITEMS(i) \
838 IMAGE_INSTANCE_WIDGET_ITEMS (XIMAGE_INSTANCE (i))
839 #define XIMAGE_INSTANCE_WIDGET_PENDING_ITEMS(i) \
840 IMAGE_INSTANCE_WIDGET_PENDING_ITEMS (XIMAGE_INSTANCE (i))
841 #define XIMAGE_INSTANCE_WIDGET_TEXT(i) \
842 IMAGE_INSTANCE_WIDGET_TEXT (XIMAGE_INSTANCE (i))
843 #define XIMAGE_INSTANCE_WIDGET_ACTION_OCCURRED(i) \
844 IMAGE_INSTANCE_WIDGET_ACTION_OCCURRED (XIMAGE_INSTANCE (i))
846 #define XIMAGE_INSTANCE_LAYOUT_CHILDREN(i) \
847 IMAGE_INSTANCE_LAYOUT_CHILDREN (XIMAGE_INSTANCE (i))
848 #define XIMAGE_INSTANCE_LAYOUT_BORDER(i) \
849 IMAGE_INSTANCE_LAYOUT_BORDER (XIMAGE_INSTANCE (i))
851 #define XIMAGE_INSTANCE_SUBWINDOW_ID(i) \
852 IMAGE_INSTANCE_SUBWINDOW_ID (XIMAGE_INSTANCE (i))
853 #define XIMAGE_INSTANCE_DISPLAY_X(i) \
854 IMAGE_INSTANCE_DISPLAY_X (XIMAGE_INSTANCE (i))
855 #define XIMAGE_INSTANCE_DISPLAY_Y(i) \
856 IMAGE_INSTANCE_DISPLAY_Y (XIMAGE_INSTANCE (i))
857 #define XIMAGE_INSTANCE_DISPLAY_WIDTH(i) \
858 IMAGE_INSTANCE_DISPLAY_WIDTH (XIMAGE_INSTANCE (i))
859 #define XIMAGE_INSTANCE_DISPLAY_HEIGHT(i) \
860 IMAGE_INSTANCE_DISPLAY_HEIGHT (XIMAGE_INSTANCE (i))
861 #define XIMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP(i) \
862 IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP (XIMAGE_INSTANCE (i))
863 #define XIMAGE_INSTANCE_SUBWINDOW_ORIENT(i) \
864 IMAGE_INSTANCE_SUBWINDOW_ORIENT (XIMAGE_INSTANCE (i))
865 #define XIMAGE_INSTANCE_SUBWINDOW_JUSTIFY(i) \
866 IMAGE_INSTANCE_SUBWINDOW_JUSTIFY (XIMAGE_INSTANCE (i))
867 #define XIMAGE_INSTANCE_SUBWINDOW_FACE(i) \
868 IMAGE_INSTANCE_SUBWINDOW_FACE (XIMAGE_INSTANCE (i))
870 #define MARK_IMAGE_INSTANCE_CHANGED(i) \
871 (IMAGE_INSTANCE_DIRTYP (i) = 1);
873 Lisp_Object image_instance_device (Lisp_Object instance);
874 Lisp_Object image_instance_frame (Lisp_Object instance);
875 Lisp_Object image_instance_window (Lisp_Object instance);
876 int image_instance_live_p (Lisp_Object instance);
879 Lisp_Object evaluate_xpm_color_symbols (void);
880 Lisp_Object pixmap_to_lisp_data (Lisp_Object name, int ok_if_data_invalid);
881 #endif /* HAVE_XPM */
882 #ifdef HAVE_WINDOW_SYSTEM
883 Lisp_Object bitmap_to_lisp_data (Lisp_Object name, int *xhot, int *yhot,
884 int ok_if_data_invalid);
885 int read_bitmap_data_from_file (const char *filename, unsigned int *width,
886 unsigned int *height, unsigned char **datap,
887 int *x_hot, int *y_hot);
888 Lisp_Object xbm_mask_file_munging (Lisp_Object alist, Lisp_Object file,
889 Lisp_Object mask_file,
890 Lisp_Object console_type);
893 /************************************************************************/
895 /************************************************************************/
907 struct lcrecord_header header;
909 enum glyph_type type;
912 Lisp_Object image; /* the actual image */
913 Lisp_Object contrib_p; /* whether to figure into line height */
914 Lisp_Object baseline; /* percent above baseline */
916 Lisp_Object face; /* if non-nil, face to use when displaying */
919 void (*after_change) (Lisp_Object glyph, Lisp_Object property,
922 unsigned int dirty : 1; /* So that we can selectively
923 redisplay changed glyphs. */
925 typedef struct Lisp_Glyph Lisp_Glyph;
927 DECLARE_LRECORD (glyph, Lisp_Glyph);
928 #define XGLYPH(x) XRECORD (x, glyph, Lisp_Glyph)
929 #define XSETGLYPH(x, p) XSETRECORD (x, p, glyph)
930 #define GLYPHP(x) RECORDP (x, glyph)
931 #define CHECK_GLYPH(x) CHECK_RECORD (x, glyph)
932 #define CONCHECK_GLYPH(x) CONCHECK_RECORD (x, glyph)
934 #define CHECK_BUFFER_GLYPH(x) do { \
936 if (XGLYPH (x)->type != GLYPH_BUFFER) \
937 x = wrong_type_argument (Qbuffer_glyph_p, (x)); \
940 #define CHECK_POINTER_GLYPH(x) do { \
942 if (XGLYPH (x)->type != GLYPH_POINTER) \
943 x = wrong_type_argument (Qpointer_glyph_p, (x)); \
946 #define CHECK_ICON_GLYPH(x) do { \
948 if (XGLYPH (x)->type != GLYPH_ICON) \
949 x = wrong_type_argument (Qicon_glyph_p, (x)); \
952 #define GLYPH_TYPE(g) ((g)->type)
953 #define GLYPH_IMAGE(g) ((g)->image)
954 #define GLYPH_CONTRIB_P(g) ((g)->contrib_p)
955 #define GLYPH_BASELINE(g) ((g)->baseline)
956 #define GLYPH_FACE(g) ((g)->face)
957 #define GLYPH_DIRTYP(g) ((g)->dirty)
959 #define XGLYPH_TYPE(g) GLYPH_TYPE (XGLYPH (g))
960 #define XGLYPH_IMAGE(g) GLYPH_IMAGE (XGLYPH (g))
961 #define XGLYPH_CONTRIB_P(g) GLYPH_CONTRIB_P (XGLYPH (g))
962 #define XGLYPH_BASELINE(g) GLYPH_BASELINE (XGLYPH (g))
963 #define XGLYPH_FACE(g) GLYPH_FACE (XGLYPH (g))
964 #define XGLYPH_DIRTYP(g) GLYPH_DIRTYP (XGLYPH (g))
966 #define MARK_GLYPH_CHANGED(g) (GLYPH_DIRTYP (g) = 1);
968 extern Lisp_Object Qxpm, Qxface, Qetched_in, Qetched_out, Qbevel_in, Qbevel_out;
969 extern Lisp_Object Q_data, Q_file, Q_color_symbols, Qconst_glyph_variable;
970 extern Lisp_Object Qxbm, Qedit_field, Qgroup, Qlabel, Qcombo_box, Qscrollbar;
971 extern Lisp_Object Qtree_view, Qtab_control, Qprogress_gauge, Q_border;
972 extern Lisp_Object Q_mask_file, Q_mask_data, Q_hotspot_x, Q_hotspot_y;
973 extern Lisp_Object Q_foreground, Q_background, Q_face, Q_descriptor, Q_group;
974 extern Lisp_Object Q_width, Q_height, Q_pixel_width, Q_pixel_height, Q_text;
975 extern Lisp_Object Q_items, Q_properties, Q_image, Qimage_conversion_error;
976 extern Lisp_Object Q_orientation, Q_margin_width;
977 extern Lisp_Object Vcontinuation_glyph, Vcontrol_arrow_glyph, Vhscroll_glyph;
978 extern Lisp_Object Vinvisible_text_glyph, Voctal_escape_glyph, Vtruncation_glyph;
979 extern Lisp_Object Vxemacs_logo;
982 unsigned short glyph_width (Lisp_Object glyph, Lisp_Object domain);
983 unsigned short glyph_ascent (Lisp_Object glyph, Lisp_Object domain);
984 unsigned short glyph_descent (Lisp_Object glyph, Lisp_Object domain);
985 unsigned short glyph_height (Lisp_Object glyph, Lisp_Object domain);
986 Lisp_Object glyph_baseline (Lisp_Object glyph, Lisp_Object domain);
987 Lisp_Object glyph_face (Lisp_Object glyph, Lisp_Object domain);
988 int glyph_contrib_p (Lisp_Object glyph, Lisp_Object domain);
989 Lisp_Object glyph_image_instance (Lisp_Object glyph,
991 Error_behavior errb, int no_quit);
992 void file_or_data_must_be_present (Lisp_Object instantiator);
993 void data_must_be_present (Lisp_Object instantiator);
994 Lisp_Object make_string_from_file (Lisp_Object file);
995 Lisp_Object tagged_vector_to_alist (Lisp_Object vector);
996 Lisp_Object alist_to_tagged_vector (Lisp_Object tag, Lisp_Object alist);
997 void string_instantiate (Lisp_Object image_instance, Lisp_Object instantiator,
998 Lisp_Object pointer_fg, Lisp_Object pointer_bg,
999 int dest_mask, Lisp_Object domain);
1000 int tab_control_order_only_changed (Lisp_Object image_instance);
1001 Lisp_Object allocate_glyph (enum glyph_type type,
1002 void (*after_change) (Lisp_Object glyph,
1003 Lisp_Object property,
1004 Lisp_Object locale));
1005 Lisp_Object normalize_image_instantiator (Lisp_Object instantiator,
1006 Lisp_Object contype,
1007 Lisp_Object dest_mask);
1008 void glyph_query_geometry (Lisp_Object glyph_or_image, int* width, int* height,
1009 enum image_instance_geometry disp,
1010 Lisp_Object domain);
1011 void glyph_do_layout (Lisp_Object glyph_or_image, int width, int height,
1012 int xoffset, int yoffset,
1013 Lisp_Object domain);
1014 void query_string_geometry ( Lisp_Object string, Lisp_Object face,
1015 int* width, int* height, int* descent,
1016 Lisp_Object domain);
1017 Lisp_Object query_string_font (Lisp_Object string,
1018 Lisp_Object face, Lisp_Object domain);
1019 Lisp_Object add_glyph_animated_timeout (EMACS_INT tickms, Lisp_Object device);
1020 void disable_glyph_animated_timeout (int i);
1022 /************************************************************************/
1024 /************************************************************************/
1026 typedef struct glyph_cachel glyph_cachel;
1031 unsigned int dirty :1; /* I'm copying faces here. I'm not
1032 sure why we need two dirty
1033 flags. Maybe because an image
1034 instance can be dirty and so we
1035 need to frob this in the same way
1036 as other image instance properties. */
1037 unsigned int updated :1;
1039 unsigned short width;
1040 unsigned short ascent;
1041 unsigned short descent;
1044 #define CONT_GLYPH_INDEX (glyph_index) 0
1045 #define TRUN_GLYPH_INDEX (glyph_index) 1
1046 #define HSCROLL_GLYPH_INDEX (glyph_index) 2
1047 #define CONTROL_GLYPH_INDEX (glyph_index) 3
1048 #define OCT_ESC_GLYPH_INDEX (glyph_index) 4
1049 #define INVIS_GLYPH_INDEX (glyph_index) 5
1051 #ifdef ERROR_CHECK_GLYPHS
1056 GLYPH_CACHEL_WIDTH (struct window *window, int ind);
1058 GLYPH_CACHEL_WIDTH (struct window *window, int ind)
1060 int wid = Dynarr_atp (window->glyph_cachels, ind)->width;
1061 assert (wid >= 0 && wid < 10000);
1065 GLYPH_CACHEL_ASCENT (struct window *window, int ind);
1067 GLYPH_CACHEL_ASCENT (struct window *window, int ind)
1069 int wid = Dynarr_atp (window->glyph_cachels, ind)->ascent;
1070 assert (wid >= 0 && wid < 10000);
1074 GLYPH_CACHEL_DESCENT (struct window *window, int ind);
1076 GLYPH_CACHEL_DESCENT (struct window *window, int ind)
1078 int wid = Dynarr_atp (window->glyph_cachels, ind)->descent;
1079 assert (wid >= 0 && wid < 10000);
1083 #else /* not ERROR_CHECK_GLYPHS */
1085 #define GLYPH_CACHEL_WIDTH(window, ind) \
1086 Dynarr_atp (window->glyph_cachels, ind)->width
1087 #define GLYPH_CACHEL_ASCENT(window, ind) \
1088 Dynarr_atp (window->glyph_cachels, ind)->ascent
1089 #define GLYPH_CACHEL_DESCENT(window, ind) \
1090 Dynarr_atp (window->glyph_cachels, ind)->descent
1092 #endif /* not ERROR_CHECK_GLYPHS */
1094 #define GLYPH_CACHEL(window, ind) \
1095 Dynarr_atp (window->glyph_cachels, ind)
1096 #define GLYPH_CACHEL_GLYPH(window, ind) \
1097 Dynarr_atp (window->glyph_cachels, ind)->glyph
1098 #define GLYPH_CACHEL_DIRTYP(window, ind) \
1099 Dynarr_atp (window->glyph_cachels, ind)->dirty
1101 void mark_glyph_cachels (glyph_cachel_dynarr *elements);
1102 void mark_glyph_cachels_as_not_updated (struct window *w);
1103 void mark_glyph_cachels_as_clean (struct window *w);
1104 void reset_glyph_cachels (struct window *w);
1105 glyph_index get_glyph_cachel_index (struct window *w, Lisp_Object glyph);
1107 #ifdef MEMORY_USAGE_STATS
1108 int compute_glyph_cachel_usage (glyph_cachel_dynarr *glyph_cachels,
1109 struct overhead_stats *ovstats);
1110 #endif /* MEMORY_USAGE_STATS */
1112 /************************************************************************/
1113 /* Display Tables */
1114 /************************************************************************/
1116 Lisp_Object display_table_entry (Emchar, Lisp_Object, Lisp_Object);
1117 void get_display_tables (struct window *, face_index,
1118 Lisp_Object *, Lisp_Object *);
1120 /****************************************************************************
1121 * Subwindow Object *
1122 ****************************************************************************/
1124 void unmap_subwindow (Lisp_Object subwindow);
1125 void map_subwindow (Lisp_Object subwindow, int x, int y,
1126 struct display_glyph_area *dga);
1127 int find_matching_subwindow (struct frame* f, int x, int y, int width, int height);
1128 void redisplay_widget (Lisp_Object widget);
1129 void update_widget_instances (Lisp_Object frame);
1130 void redisplay_subwindow (Lisp_Object subwindow);
1131 Lisp_Object image_instance_parent_glyph (struct Lisp_Image_Instance*);
1132 int image_instance_changed (Lisp_Object image);
1133 void free_frame_subwindow_instances (struct frame* f);
1134 void reset_frame_subwindow_instance_cache (struct frame* f);
1135 int unmap_subwindow_instance_cache_mapper (Lisp_Object key,
1136 Lisp_Object value, void* finalize);
1138 struct expose_ignore
1141 unsigned int width, height;
1142 struct expose_ignore *next;
1145 int check_for_ignored_expose (struct frame* f, int x, int y, int width, int height);
1146 extern int hold_ignored_expose_registration;
1148 #endif /* INCLUDED_glyphs_h_ */