Mercurial > hg > xemacs-beta
annotate src/glyphs.c @ 4522:fc7067b7f407
Backout last patch; forgot to specify file.
author | Stephen J. Turnbull <stephen@xemacs.org> |
---|---|
date | Wed, 29 Oct 2008 03:37:16 +0900 |
parents | 515b91f904c1 |
children | 8f1ee2d15784 |
rev | line source |
---|---|
428 | 1 /* Generic glyph/image implementation + display tables |
4226 | 2 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois |
428 | 3 Copyright (C) 1995 Tinker Systems |
2959 | 4 Copyright (C) 1995, 1996, 2000, 2001, 2002, 2004, 2005 Ben Wing |
428 | 5 Copyright (C) 1995 Sun Microsystems |
438 | 6 Copyright (C) 1998, 1999, 2000 Andy Piper |
4226 | 7 Copyright (C) 2007 Didier Verna |
428 | 8 |
9 This file is part of XEmacs. | |
10 | |
11 XEmacs is free software; you can redistribute it and/or modify it | |
12 under the terms of the GNU General Public License as published by the | |
13 Free Software Foundation; either version 2, or (at your option) any | |
14 later version. | |
15 | |
16 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
18 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
19 for more details. | |
20 | |
21 You should have received a copy of the GNU General Public License | |
22 along with XEmacs; see the file COPYING. If not, write to | |
23 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 Boston, MA 02111-1307, USA. */ | |
25 | |
26 /* Synched up with: Not in FSF. */ | |
27 | |
2959 | 28 /* This file mostly written by Ben Wing, with some code by Chuck Thompson. |
29 Heavily modified / rewritten by Andy Piper. | |
30 | |
31 Earliest glyph support, Jamie Zawinski for 19.8? | |
32 subwindow support added by Chuck Thompson | |
33 additional XPM support added by Chuck Thompson | |
34 initial X-Face support added by Stig | |
35 Majorly rewritten/restructured by Ben Wing, including creation of | |
36 glyph and image-instance objects, for 19.12/19.13 | |
37 GIF/JPEG/etc. support originally in this file -- see glyph-eimage.c | |
38 Pointer/icon overhaul, more restructuring by Ben Wing for 19.14 | |
39 Many changes for color work and optimizations by Jareth Hein for 21.0 | |
40 Switch of GIF/JPEG/PNG to new EImage intermediate code by Jareth Hein for 21.0 | |
41 TIFF code by Jareth Hein for 21.0 | |
42 Generalization for ms-windows by Andy Piper for 21.0 | |
43 TODO: | |
44 Convert images.el to C and stick it in here? | |
45 */ | |
428 | 46 |
47 #include <config.h> | |
48 #include "lisp.h" | |
49 | |
442 | 50 #include "blocktype.h" |
428 | 51 #include "buffer.h" |
442 | 52 #include "chartab.h" |
872 | 53 #include "device-impl.h" |
428 | 54 #include "elhash.h" |
55 #include "faces.h" | |
872 | 56 #include "frame-impl.h" |
442 | 57 #include "glyphs.h" |
800 | 58 #include "gui.h" |
428 | 59 #include "insdel.h" |
872 | 60 #include "objects-impl.h" |
428 | 61 #include "opaque.h" |
442 | 62 #include "rangetab.h" |
428 | 63 #include "redisplay.h" |
442 | 64 #include "specifier.h" |
428 | 65 #include "window.h" |
66 | |
771 | 67 #include "sysfile.h" |
68 | |
462 | 69 #if defined (HAVE_XPM) && !defined (HAVE_GTK) |
428 | 70 #include <X11/xpm.h> |
71 #endif | |
72 | |
73 Lisp_Object Qimage_conversion_error; | |
74 | |
75 Lisp_Object Qglyphp, Qcontrib_p, Qbaseline; | |
76 Lisp_Object Qbuffer_glyph_p, Qpointer_glyph_p, Qicon_glyph_p; | |
77 Lisp_Object Qnothing_image_instance_p, Qtext_image_instance_p; | |
78 Lisp_Object Qmono_pixmap_image_instance_p; | |
79 Lisp_Object Qcolor_pixmap_image_instance_p; | |
80 Lisp_Object Qpointer_image_instance_p; | |
81 Lisp_Object Qsubwindow_image_instance_p; | |
82 Lisp_Object Qwidget_image_instance_p; | |
83 Lisp_Object Qconst_glyph_variable; | |
84 Lisp_Object Qmono_pixmap, Qcolor_pixmap, Qsubwindow; | |
85 Lisp_Object Q_file, Q_data, Q_face, Q_pixel_width, Q_pixel_height; | |
86 Lisp_Object Qformatted_string; | |
87 Lisp_Object Vcurrent_display_table; | |
88 Lisp_Object Vtruncation_glyph, Vcontinuation_glyph, Voctal_escape_glyph; | |
89 Lisp_Object Vcontrol_arrow_glyph, Vinvisible_text_glyph, Vhscroll_glyph; | |
90 Lisp_Object Vxemacs_logo; | |
91 Lisp_Object Vthe_nothing_vector; | |
92 Lisp_Object Vimage_instantiator_format_list; | |
93 Lisp_Object Vimage_instance_type_list; | |
94 Lisp_Object Vglyph_type_list; | |
95 | |
96 int disable_animated_pixmaps; | |
97 | |
98 DEFINE_IMAGE_INSTANTIATOR_FORMAT (nothing); | |
99 DEFINE_IMAGE_INSTANTIATOR_FORMAT (inherit); | |
100 DEFINE_IMAGE_INSTANTIATOR_FORMAT (string); | |
101 DEFINE_IMAGE_INSTANTIATOR_FORMAT (formatted_string); | |
102 DEFINE_IMAGE_INSTANTIATOR_FORMAT (subwindow); | |
103 DEFINE_IMAGE_INSTANTIATOR_FORMAT (text); | |
442 | 104 DEFINE_IMAGE_INSTANTIATOR_FORMAT (pointer); |
428 | 105 |
106 #ifdef HAVE_WINDOW_SYSTEM | |
107 DEFINE_IMAGE_INSTANTIATOR_FORMAT (xbm); | |
108 Lisp_Object Qxbm; | |
109 | |
110 Lisp_Object Q_mask_file, Q_mask_data, Q_hotspot_x, Q_hotspot_y; | |
111 Lisp_Object Q_foreground, Q_background; | |
112 #ifndef BitmapSuccess | |
113 #define BitmapSuccess 0 | |
114 #define BitmapOpenFailed 1 | |
115 #define BitmapFileInvalid 2 | |
116 #define BitmapNoMemory 3 | |
117 #endif | |
118 #endif | |
119 | |
120 #ifdef HAVE_XFACE | |
121 DEFINE_IMAGE_INSTANTIATOR_FORMAT (xface); | |
122 Lisp_Object Qxface; | |
123 #endif | |
124 | |
125 #ifdef HAVE_XPM | |
126 DEFINE_IMAGE_INSTANTIATOR_FORMAT (xpm); | |
127 Lisp_Object Qxpm; | |
128 Lisp_Object Q_color_symbols; | |
129 #endif | |
130 | |
131 typedef struct image_instantiator_format_entry image_instantiator_format_entry; | |
132 struct image_instantiator_format_entry | |
133 { | |
134 Lisp_Object symbol; | |
135 Lisp_Object device; | |
136 struct image_instantiator_methods *meths; | |
137 }; | |
138 | |
139 typedef struct | |
140 { | |
141 Dynarr_declare (struct image_instantiator_format_entry); | |
142 } image_instantiator_format_entry_dynarr; | |
143 | |
442 | 144 /* This contains one entry per format, per device it's defined on. */ |
428 | 145 image_instantiator_format_entry_dynarr * |
146 the_image_instantiator_format_entry_dynarr; | |
147 | |
442 | 148 static Lisp_Object allocate_image_instance (Lisp_Object governing_domain, |
149 Lisp_Object parent, | |
150 Lisp_Object instantiator); | |
428 | 151 static void image_validate (Lisp_Object instantiator); |
152 static void glyph_property_was_changed (Lisp_Object glyph, | |
153 Lisp_Object property, | |
154 Lisp_Object locale); | |
442 | 155 static void set_image_instance_dirty_p (Lisp_Object instance, int dirty); |
428 | 156 static void register_ignored_expose (struct frame* f, int x, int y, int width, int height); |
442 | 157 static void cache_subwindow_instance_in_frame_maybe (Lisp_Object instance); |
158 static void update_image_instance (Lisp_Object image_instance, | |
159 Lisp_Object instantiator); | |
428 | 160 /* Unfortunately windows and X are different. In windows BeginPaint() |
161 will prevent WM_PAINT messages being generated so it is unnecessary | |
162 to register exposures as they will not occur. Under X they will | |
163 always occur. */ | |
164 int hold_ignored_expose_registration; | |
165 | |
166 EXFUN (Fimage_instance_type, 1); | |
167 EXFUN (Fglyph_type, 1); | |
442 | 168 EXFUN (Fnext_window, 4); |
428 | 169 |
170 | |
171 /**************************************************************************** | |
172 * Image Instantiators * | |
173 ****************************************************************************/ | |
174 | |
175 struct image_instantiator_methods * | |
176 decode_device_ii_format (Lisp_Object device, Lisp_Object format, | |
578 | 177 Error_Behavior errb) |
428 | 178 { |
179 int i; | |
180 | |
181 if (!SYMBOLP (format)) | |
182 { | |
183 if (ERRB_EQ (errb, ERROR_ME)) | |
184 CHECK_SYMBOL (format); | |
185 return 0; | |
186 } | |
187 | |
188 for (i = 0; i < Dynarr_length (the_image_instantiator_format_entry_dynarr); | |
189 i++) | |
190 { | |
191 if ( EQ (format, | |
192 Dynarr_at (the_image_instantiator_format_entry_dynarr, i). | |
193 symbol) ) | |
194 { | |
195 Lisp_Object d = Dynarr_at (the_image_instantiator_format_entry_dynarr, i). | |
196 device; | |
197 if ((NILP (d) && NILP (device)) | |
198 || | |
199 (!NILP (device) && | |
440 | 200 EQ (CONSOLE_TYPE (XCONSOLE |
428 | 201 (DEVICE_CONSOLE (XDEVICE (device)))), d))) |
202 return Dynarr_at (the_image_instantiator_format_entry_dynarr, i).meths; | |
203 } | |
204 } | |
205 | |
563 | 206 maybe_invalid_argument ("Invalid image-instantiator format", format, |
872 | 207 Qimage, errb); |
428 | 208 |
209 return 0; | |
210 } | |
211 | |
212 struct image_instantiator_methods * | |
578 | 213 decode_image_instantiator_format (Lisp_Object format, Error_Behavior errb) |
428 | 214 { |
215 return decode_device_ii_format (Qnil, format, errb); | |
216 } | |
217 | |
218 static int | |
219 valid_image_instantiator_format_p (Lisp_Object format, Lisp_Object locale) | |
220 { | |
221 int i; | |
222 struct image_instantiator_methods* meths = | |
223 decode_image_instantiator_format (format, ERROR_ME_NOT); | |
224 Lisp_Object contype = Qnil; | |
225 /* mess with the locale */ | |
226 if (!NILP (locale) && SYMBOLP (locale)) | |
227 contype = locale; | |
228 else | |
229 { | |
230 struct console* console = decode_console (locale); | |
231 contype = console ? CONSOLE_TYPE (console) : locale; | |
232 } | |
233 /* nothing is valid in all locales */ | |
234 if (EQ (format, Qnothing)) | |
235 return 1; | |
236 /* reject unknown formats */ | |
237 else if (NILP (contype) || !meths) | |
238 return 0; | |
239 | |
240 for (i = 0; i < Dynarr_length (meths->consoles); i++) | |
241 if (EQ (contype, Dynarr_at (meths->consoles, i).symbol)) | |
242 return 1; | |
243 return 0; | |
244 } | |
245 | |
246 DEFUN ("valid-image-instantiator-format-p", Fvalid_image_instantiator_format_p, | |
247 1, 2, 0, /* | |
248 Given an IMAGE-INSTANTIATOR-FORMAT, return non-nil if it is valid. | |
444 | 249 If LOCALE is non-nil then the format is checked in that locale. |
428 | 250 If LOCALE is nil the current console is used. |
442 | 251 |
2959 | 252 Valid formats are some subset of `nothing', `string', `formatted-string', |
253 `xpm', `xbm', `xface', `gif', `jpeg', `png', `tiff', `cursor-font', `font', | |
254 `autodetect', `subwindow', `inherit', `mswindows-resource', `bmp', | |
255 `native-layout', `layout', `label', `tab-control', `tree-view', | |
256 `progress-gauge', `scrollbar', `combo-box', `edit-field', `button', | |
257 `widget', `pointer', and `text', depending on how XEmacs was compiled. | |
428 | 258 */ |
259 (image_instantiator_format, locale)) | |
260 { | |
442 | 261 return valid_image_instantiator_format_p (image_instantiator_format, |
262 locale) ? | |
428 | 263 Qt : Qnil; |
264 } | |
265 | |
266 DEFUN ("image-instantiator-format-list", Fimage_instantiator_format_list, | |
267 0, 0, 0, /* | |
268 Return a list of valid image-instantiator formats. | |
269 */ | |
270 ()) | |
271 { | |
272 return Fcopy_sequence (Vimage_instantiator_format_list); | |
273 } | |
274 | |
275 void | |
276 add_entry_to_device_ii_format_list (Lisp_Object device, Lisp_Object symbol, | |
277 struct image_instantiator_methods *meths) | |
278 { | |
279 struct image_instantiator_format_entry entry; | |
280 | |
281 entry.symbol = symbol; | |
282 entry.device = device; | |
283 entry.meths = meths; | |
284 Dynarr_add (the_image_instantiator_format_entry_dynarr, entry); | |
442 | 285 if (NILP (memq_no_quit (symbol, Vimage_instantiator_format_list))) |
286 Vimage_instantiator_format_list = | |
287 Fcons (symbol, Vimage_instantiator_format_list); | |
428 | 288 } |
289 | |
290 void | |
291 add_entry_to_image_instantiator_format_list (Lisp_Object symbol, | |
292 struct | |
293 image_instantiator_methods *meths) | |
294 { | |
295 add_entry_to_device_ii_format_list (Qnil, symbol, meths); | |
296 } | |
297 | |
298 static Lisp_Object * | |
299 get_image_conversion_list (Lisp_Object console_type) | |
300 { | |
301 return &decode_console_type (console_type, ERROR_ME)->image_conversion_list; | |
302 } | |
303 | |
304 DEFUN ("set-console-type-image-conversion-list", Fset_console_type_image_conversion_list, | |
305 2, 2, 0, /* | |
444 | 306 Set the image-conversion-list for consoles of the given CONSOLE-TYPE. |
428 | 307 The image-conversion-list specifies how image instantiators that |
308 are strings should be interpreted. Each element of the list should be | |
309 a list of two elements (a regular expression string and a vector) or | |
310 a list of three elements (the preceding two plus an integer index into | |
311 the vector). The string is converted to the vector associated with the | |
312 first matching regular expression. If a vector index is specified, the | |
313 string itself is substituted into that position in the vector. | |
314 | |
315 Note: The conversion above is applied when the image instantiator is | |
316 added to an image specifier, not when the specifier is actually | |
317 instantiated. Therefore, changing the image-conversion-list only affects | |
318 newly-added instantiators. Existing instantiators in glyphs and image | |
319 specifiers will not be affected. | |
320 */ | |
321 (console_type, list)) | |
322 { | |
323 Lisp_Object *imlist = get_image_conversion_list (console_type); | |
324 | |
325 /* Check the list to make sure that it only has valid entries. */ | |
326 | |
2367 | 327 EXTERNAL_LIST_LOOP_2 (mapping, list) |
428 | 328 { |
329 /* Mapping form should be (STRING VECTOR) or (STRING VECTOR INTEGER) */ | |
330 if (!CONSP (mapping) || | |
331 !CONSP (XCDR (mapping)) || | |
332 (!NILP (XCDR (XCDR (mapping))) && | |
333 (!CONSP (XCDR (XCDR (mapping))) || | |
334 !NILP (XCDR (XCDR (XCDR (mapping))))))) | |
563 | 335 invalid_argument ("Invalid mapping form", mapping); |
428 | 336 else |
337 { | |
1885 | 338 Lisp_Object regexp = XCAR (mapping); |
428 | 339 Lisp_Object typevec = XCAR (XCDR (mapping)); |
340 Lisp_Object pos = Qnil; | |
341 Lisp_Object newvec; | |
342 struct gcpro gcpro1; | |
343 | |
1885 | 344 CHECK_STRING (regexp); |
428 | 345 CHECK_VECTOR (typevec); |
346 if (!NILP (XCDR (XCDR (mapping)))) | |
347 { | |
348 pos = XCAR (XCDR (XCDR (mapping))); | |
349 CHECK_INT (pos); | |
350 if (XINT (pos) < 0 || | |
351 XINT (pos) >= XVECTOR_LENGTH (typevec)) | |
352 args_out_of_range_3 | |
353 (pos, Qzero, make_int (XVECTOR_LENGTH (typevec) - 1)); | |
354 } | |
355 | |
356 newvec = Fcopy_sequence (typevec); | |
357 if (INTP (pos)) | |
1885 | 358 XVECTOR_DATA (newvec)[XINT (pos)] = regexp; |
428 | 359 GCPRO1 (newvec); |
360 image_validate (newvec); | |
361 UNGCPRO; | |
362 } | |
363 } | |
364 | |
365 *imlist = Fcopy_tree (list, Qt); | |
366 return list; | |
367 } | |
368 | |
369 DEFUN ("console-type-image-conversion-list", Fconsole_type_image_conversion_list, | |
370 1, 1, 0, /* | |
444 | 371 Return the image-conversion-list for devices of the given CONSOLE-TYPE. |
428 | 372 The image-conversion-list specifies how to interpret image string |
373 instantiators for the specified console type. See | |
374 `set-console-type-image-conversion-list' for a description of its syntax. | |
375 */ | |
376 (console_type)) | |
377 { | |
378 return Fcopy_tree (*get_image_conversion_list (console_type), Qt); | |
379 } | |
380 | |
381 /* Process a string instantiator according to the image-conversion-list for | |
382 CONSOLE_TYPE. Returns a vector. */ | |
383 | |
384 static Lisp_Object | |
385 process_image_string_instantiator (Lisp_Object data, | |
386 Lisp_Object console_type, | |
387 int dest_mask) | |
388 { | |
389 Lisp_Object tail; | |
390 | |
391 LIST_LOOP (tail, *get_image_conversion_list (console_type)) | |
392 { | |
393 Lisp_Object mapping = XCAR (tail); | |
1885 | 394 Lisp_Object regexp = XCAR (mapping); |
428 | 395 Lisp_Object typevec = XCAR (XCDR (mapping)); |
396 | |
397 /* if the result is of a type that can't be instantiated | |
398 (e.g. a string when we're dealing with a pointer glyph), | |
399 skip it. */ | |
400 if (!(dest_mask & | |
401 IIFORMAT_METH (decode_image_instantiator_format | |
450 | 402 (INSTANTIATOR_TYPE (typevec), ERROR_ME), |
428 | 403 possible_dest_types, ()))) |
404 continue; | |
1885 | 405 if (fast_string_match (regexp, 0, data, 0, -1, 0, ERROR_ME, 0) >= 0) |
428 | 406 { |
407 if (!NILP (XCDR (XCDR (mapping)))) | |
408 { | |
409 int pos = XINT (XCAR (XCDR (XCDR (mapping)))); | |
410 Lisp_Object newvec = Fcopy_sequence (typevec); | |
411 XVECTOR_DATA (newvec)[pos] = data; | |
412 return newvec; | |
413 } | |
414 else | |
415 return typevec; | |
416 } | |
417 } | |
418 | |
419 /* Oh well. */ | |
563 | 420 invalid_argument ("Unable to interpret glyph instantiator", |
428 | 421 data); |
422 | |
1204 | 423 RETURN_NOT_REACHED (Qnil); |
428 | 424 } |
425 | |
426 Lisp_Object | |
427 find_keyword_in_vector_or_given (Lisp_Object vector, Lisp_Object keyword, | |
428 Lisp_Object default_) | |
429 { | |
430 Lisp_Object *elt; | |
431 int instantiator_len; | |
432 | |
433 elt = XVECTOR_DATA (vector); | |
434 instantiator_len = XVECTOR_LENGTH (vector); | |
435 | |
436 elt++; | |
437 instantiator_len--; | |
438 | |
439 while (instantiator_len > 0) | |
440 { | |
441 if (EQ (elt[0], keyword)) | |
442 return elt[1]; | |
443 elt += 2; | |
444 instantiator_len -= 2; | |
445 } | |
446 | |
447 return default_; | |
448 } | |
449 | |
450 Lisp_Object | |
451 find_keyword_in_vector (Lisp_Object vector, Lisp_Object keyword) | |
452 { | |
453 return find_keyword_in_vector_or_given (vector, keyword, Qnil); | |
454 } | |
455 | |
442 | 456 static Lisp_Object |
2959 | 457 find_instantiator_differences (Lisp_Object new_, Lisp_Object old) |
442 | 458 { |
459 Lisp_Object alist = Qnil; | |
2959 | 460 Lisp_Object *elt = XVECTOR_DATA (new_); |
442 | 461 Lisp_Object *old_elt = XVECTOR_DATA (old); |
2959 | 462 int len = XVECTOR_LENGTH (new_); |
442 | 463 struct gcpro gcpro1; |
464 | |
465 /* If the vector length has changed then consider everything | |
466 changed. We could try and figure out what properties have | |
467 disappeared or been added, but this code is only used as an | |
468 optimization anyway so lets not bother. */ | |
469 if (len != XVECTOR_LENGTH (old)) | |
2959 | 470 return new_; |
442 | 471 |
472 GCPRO1 (alist); | |
473 | |
474 for (len -= 2; len >= 1; len -= 2) | |
475 { | |
476 /* Keyword comparisons can be done with eq, the value must be | |
4252 | 477 done with equal. |
478 #### Note that this does not optimize re-ordering. */ | |
442 | 479 if (!EQ (elt[len], old_elt[len]) |
480 || !internal_equal (elt[len+1], old_elt[len+1], 0)) | |
481 alist = Fcons (Fcons (elt[len], elt[len+1]), alist); | |
482 } | |
483 | |
484 { | |
485 Lisp_Object result = alist_to_tagged_vector (elt[0], alist); | |
486 free_alist (alist); | |
487 RETURN_UNGCPRO (result); | |
488 } | |
489 } | |
490 | |
491 DEFUN ("set-instantiator-property", Fset_instantiator_property, | |
492 3, 3, 0, /* | |
444 | 493 Destructively set the property KEYWORD of INSTANTIATOR to VALUE. |
442 | 494 If the property is not set then it is added to a copy of the |
495 instantiator and the new instantiator returned. | |
496 Use `set-glyph-image' on glyphs to register instantiator changes. */ | |
444 | 497 (instantiator, keyword, value)) |
442 | 498 { |
499 Lisp_Object *elt; | |
500 int len; | |
501 | |
502 CHECK_VECTOR (instantiator); | |
503 if (!KEYWORDP (keyword)) | |
563 | 504 invalid_argument ("instantiator property must be a keyword", keyword); |
442 | 505 |
506 elt = XVECTOR_DATA (instantiator); | |
507 len = XVECTOR_LENGTH (instantiator); | |
508 | |
509 for (len -= 2; len >= 1; len -= 2) | |
510 { | |
511 if (EQ (elt[len], keyword)) | |
512 { | |
444 | 513 elt[len+1] = value; |
442 | 514 break; |
515 } | |
516 } | |
517 | |
518 /* Didn't find it so add it. */ | |
519 if (len < 1) | |
520 { | |
521 Lisp_Object alist = Qnil, result; | |
522 struct gcpro gcpro1; | |
523 | |
524 GCPRO1 (alist); | |
525 alist = tagged_vector_to_alist (instantiator); | |
444 | 526 alist = Fcons (Fcons (keyword, value), alist); |
442 | 527 result = alist_to_tagged_vector (elt[0], alist); |
528 free_alist (alist); | |
529 RETURN_UNGCPRO (result); | |
530 } | |
531 | |
532 return instantiator; | |
533 } | |
534 | |
428 | 535 void |
536 check_valid_string (Lisp_Object data) | |
537 { | |
538 CHECK_STRING (data); | |
539 } | |
540 | |
541 void | |
542 check_valid_vector (Lisp_Object data) | |
543 { | |
544 CHECK_VECTOR (data); | |
545 } | |
546 | |
547 void | |
548 check_valid_face (Lisp_Object data) | |
549 { | |
550 Fget_face (data); | |
551 } | |
552 | |
553 void | |
554 check_valid_int (Lisp_Object data) | |
555 { | |
556 CHECK_INT (data); | |
557 } | |
558 | |
559 void | |
560 file_or_data_must_be_present (Lisp_Object instantiator) | |
561 { | |
562 if (NILP (find_keyword_in_vector (instantiator, Q_file)) && | |
563 NILP (find_keyword_in_vector (instantiator, Q_data))) | |
563 | 564 sferror ("Must supply either :file or :data", |
428 | 565 instantiator); |
566 } | |
567 | |
568 void | |
569 data_must_be_present (Lisp_Object instantiator) | |
570 { | |
571 if (NILP (find_keyword_in_vector (instantiator, Q_data))) | |
563 | 572 sferror ("Must supply :data", instantiator); |
428 | 573 } |
574 | |
575 static void | |
576 face_must_be_present (Lisp_Object instantiator) | |
577 { | |
578 if (NILP (find_keyword_in_vector (instantiator, Q_face))) | |
563 | 579 sferror ("Must supply :face", instantiator); |
428 | 580 } |
581 | |
582 /* utility function useful in retrieving data from a file. */ | |
583 | |
584 Lisp_Object | |
585 make_string_from_file (Lisp_Object file) | |
586 { | |
587 /* This function can call lisp */ | |
588 int count = specpdl_depth (); | |
589 Lisp_Object temp_buffer; | |
590 struct gcpro gcpro1; | |
591 Lisp_Object data; | |
592 | |
593 specbind (Qinhibit_quit, Qt); | |
594 record_unwind_protect (Fset_buffer, Fcurrent_buffer ()); | |
595 temp_buffer = Fget_buffer_create (build_string (" *pixmap conversion*")); | |
596 GCPRO1 (temp_buffer); | |
597 set_buffer_internal (XBUFFER (temp_buffer)); | |
598 Ferase_buffer (Qnil); | |
599 specbind (intern ("format-alist"), Qnil); | |
600 Finsert_file_contents_internal (file, Qnil, Qnil, Qnil, Qnil, Qnil, Qnil); | |
601 data = Fbuffer_substring (Qnil, Qnil, Qnil); | |
771 | 602 unbind_to (count); |
428 | 603 UNGCPRO; |
604 return data; | |
605 } | |
606 | |
607 /* The following two functions are provided to make it easier for | |
608 the normalize methods to work with keyword-value vectors. | |
609 Hash tables are kind of heavyweight for this purpose. | |
610 (If vectors were resizable, we could avoid this problem; | |
611 but they're not.) An alternative approach that might be | |
612 more efficient but require more work is to use a type of | |
613 assoc-Dynarr and provide primitives for deleting elements out | |
614 of it. (However, you'd also have to add an unwind-protect | |
615 to make sure the Dynarr got freed in case of an error in | |
616 the normalization process.) */ | |
617 | |
618 Lisp_Object | |
619 tagged_vector_to_alist (Lisp_Object vector) | |
620 { | |
621 Lisp_Object *elt = XVECTOR_DATA (vector); | |
622 int len = XVECTOR_LENGTH (vector); | |
623 Lisp_Object result = Qnil; | |
624 | |
625 assert (len & 1); | |
626 for (len -= 2; len >= 1; len -= 2) | |
627 result = Fcons (Fcons (elt[len], elt[len+1]), result); | |
628 | |
629 return result; | |
630 } | |
631 | |
632 Lisp_Object | |
633 alist_to_tagged_vector (Lisp_Object tag, Lisp_Object alist) | |
634 { | |
635 int len = 1 + 2 * XINT (Flength (alist)); | |
636 Lisp_Object *elt = alloca_array (Lisp_Object, len); | |
637 int i; | |
638 Lisp_Object rest; | |
639 | |
640 i = 0; | |
641 elt[i++] = tag; | |
642 LIST_LOOP (rest, alist) | |
643 { | |
644 Lisp_Object pair = XCAR (rest); | |
645 elt[i] = XCAR (pair); | |
646 elt[i+1] = XCDR (pair); | |
647 i += 2; | |
648 } | |
649 | |
650 return Fvector (len, elt); | |
651 } | |
652 | |
442 | 653 #ifdef ERROR_CHECK_GLYPHS |
654 static int | |
2286 | 655 check_instance_cache_mapper (Lisp_Object UNUSED (key), Lisp_Object value, |
442 | 656 void *flag_closure) |
657 { | |
658 /* This function can GC */ | |
659 /* value can be nil; we cache failures as well as successes */ | |
660 if (!NILP (value)) | |
661 { | |
662 Lisp_Object window; | |
826 | 663 window = VOID_TO_LISP (flag_closure); |
442 | 664 assert (EQ (XIMAGE_INSTANCE_DOMAIN (value), window)); |
665 } | |
666 | |
667 return 0; | |
668 } | |
669 | |
670 void | |
671 check_window_subwindow_cache (struct window* w) | |
672 { | |
793 | 673 Lisp_Object window = wrap_window (w); |
674 | |
442 | 675 |
676 assert (!NILP (w->subwindow_instance_cache)); | |
677 elisp_maphash (check_instance_cache_mapper, | |
678 w->subwindow_instance_cache, | |
679 LISP_TO_VOID (window)); | |
680 } | |
681 | |
682 void | |
683 check_image_instance_structure (Lisp_Object instance) | |
684 { | |
685 /* Weird nothing images exist at startup when the console is | |
686 deleted. */ | |
687 if (!NOTHING_IMAGE_INSTANCEP (instance)) | |
688 { | |
689 assert (DOMAIN_LIVE_P (instance)); | |
690 assert (VECTORP (XIMAGE_INSTANCE_INSTANTIATOR (instance))); | |
691 } | |
692 if (WINDOWP (XIMAGE_INSTANCE_DOMAIN (instance))) | |
693 check_window_subwindow_cache | |
694 (XWINDOW (XIMAGE_INSTANCE_DOMAIN (instance))); | |
695 } | |
696 #endif | |
697 | |
698 /* Determine what kind of domain governs the image instance. | |
699 Verify that the given domain is at least as specific, and extract | |
700 the governing domain from it. */ | |
428 | 701 static Lisp_Object |
442 | 702 get_image_instantiator_governing_domain (Lisp_Object instantiator, |
703 Lisp_Object domain) | |
704 { | |
705 int governing_domain; | |
706 | |
707 struct image_instantiator_methods *meths = | |
450 | 708 decode_image_instantiator_format (INSTANTIATOR_TYPE (instantiator), |
442 | 709 ERROR_ME); |
710 governing_domain = IIFORMAT_METH_OR_GIVEN (meths, governing_domain, (), | |
711 GOVERNING_DOMAIN_DEVICE); | |
712 | |
713 if (governing_domain == GOVERNING_DOMAIN_WINDOW | |
714 && NILP (DOMAIN_WINDOW (domain))) | |
563 | 715 invalid_argument_2 |
716 ("Domain for this instantiator must be resolvable to a window", | |
717 instantiator, domain); | |
442 | 718 else if (governing_domain == GOVERNING_DOMAIN_FRAME |
719 && NILP (DOMAIN_FRAME (domain))) | |
563 | 720 invalid_argument_2 |
442 | 721 ("Domain for this instantiator must be resolvable to a frame", |
722 instantiator, domain); | |
723 | |
724 if (governing_domain == GOVERNING_DOMAIN_WINDOW) | |
725 domain = DOMAIN_WINDOW (domain); | |
726 else if (governing_domain == GOVERNING_DOMAIN_FRAME) | |
727 domain = DOMAIN_FRAME (domain); | |
728 else if (governing_domain == GOVERNING_DOMAIN_DEVICE) | |
729 domain = DOMAIN_DEVICE (domain); | |
730 else | |
2500 | 731 ABORT (); |
442 | 732 |
733 return domain; | |
734 } | |
735 | |
736 Lisp_Object | |
428 | 737 normalize_image_instantiator (Lisp_Object instantiator, |
738 Lisp_Object contype, | |
739 Lisp_Object dest_mask) | |
740 { | |
741 if (IMAGE_INSTANCEP (instantiator)) | |
742 return instantiator; | |
743 | |
744 if (STRINGP (instantiator)) | |
745 instantiator = process_image_string_instantiator (instantiator, contype, | |
746 XINT (dest_mask)); | |
442 | 747 /* Subsequent validation will pick this up. */ |
748 if (!VECTORP (instantiator)) | |
749 return instantiator; | |
428 | 750 /* We have to always store the actual pixmap data and not the |
751 filename even though this is a potential memory pig. We have to | |
752 do this because it is quite possible that we will need to | |
753 instantiate a new instance of the pixmap and the file will no | |
754 longer exist (e.g. w3 pixmaps are almost always from temporary | |
755 files). */ | |
756 { | |
757 struct gcpro gcpro1; | |
758 struct image_instantiator_methods *meths; | |
759 | |
760 GCPRO1 (instantiator); | |
440 | 761 |
450 | 762 meths = decode_image_instantiator_format (INSTANTIATOR_TYPE (instantiator), |
428 | 763 ERROR_ME); |
764 RETURN_UNGCPRO (IIFORMAT_METH_OR_GIVEN (meths, normalize, | |
442 | 765 (instantiator, contype, dest_mask), |
428 | 766 instantiator)); |
767 } | |
768 } | |
769 | |
770 static Lisp_Object | |
442 | 771 instantiate_image_instantiator (Lisp_Object governing_domain, |
772 Lisp_Object domain, | |
428 | 773 Lisp_Object instantiator, |
774 Lisp_Object pointer_fg, Lisp_Object pointer_bg, | |
438 | 775 int dest_mask, Lisp_Object glyph) |
428 | 776 { |
442 | 777 Lisp_Object ii = allocate_image_instance (governing_domain, |
778 IMAGE_INSTANCEP (domain) ? | |
779 domain : glyph, instantiator); | |
780 Lisp_Image_Instance* p = XIMAGE_INSTANCE (ii); | |
781 struct image_instantiator_methods *meths, *device_meths; | |
428 | 782 struct gcpro gcpro1; |
783 | |
784 GCPRO1 (ii); | |
450 | 785 if (!valid_image_instantiator_format_p (INSTANTIATOR_TYPE (instantiator), |
442 | 786 DOMAIN_DEVICE (governing_domain))) |
563 | 787 invalid_argument |
428 | 788 ("Image instantiator format is invalid in this locale.", |
789 instantiator); | |
790 | |
450 | 791 meths = decode_image_instantiator_format (INSTANTIATOR_TYPE (instantiator), |
428 | 792 ERROR_ME); |
793 MAYBE_IIFORMAT_METH (meths, instantiate, (ii, instantiator, pointer_fg, | |
794 pointer_bg, dest_mask, domain)); | |
440 | 795 |
442 | 796 /* Now do device specific instantiation. */ |
797 device_meths = decode_device_ii_format (DOMAIN_DEVICE (governing_domain), | |
450 | 798 INSTANTIATOR_TYPE (instantiator), |
442 | 799 ERROR_ME_NOT); |
800 | |
801 if (!HAS_IIFORMAT_METH_P (meths, instantiate) | |
802 && (!device_meths || !HAS_IIFORMAT_METH_P (device_meths, instantiate))) | |
563 | 803 invalid_argument |
428 | 804 ("Don't know how to instantiate this image instantiator?", |
805 instantiator); | |
442 | 806 |
807 /* In general native window system methods will require sane | |
808 geometry values, thus the instance needs to have been laid-out | |
809 before they get called. */ | |
810 image_instance_layout (ii, XIMAGE_INSTANCE_WIDTH (ii), | |
811 XIMAGE_INSTANCE_HEIGHT (ii), | |
812 IMAGE_UNCHANGED_GEOMETRY, | |
813 IMAGE_UNCHANGED_GEOMETRY, domain); | |
814 | |
815 MAYBE_IIFORMAT_METH (device_meths, instantiate, (ii, instantiator, pointer_fg, | |
816 pointer_bg, dest_mask, domain)); | |
817 /* Do post instantiation. */ | |
818 MAYBE_IIFORMAT_METH (meths, post_instantiate, (ii, instantiator, domain)); | |
819 MAYBE_IIFORMAT_METH (device_meths, post_instantiate, (ii, instantiator, domain)); | |
820 | |
821 /* We're done. */ | |
822 IMAGE_INSTANCE_INITIALIZED (p) = 1; | |
823 /* Now that we're done verify that we really are laid out. */ | |
824 if (IMAGE_INSTANCE_LAYOUT_CHANGED (p)) | |
825 image_instance_layout (ii, XIMAGE_INSTANCE_WIDTH (ii), | |
826 XIMAGE_INSTANCE_HEIGHT (ii), | |
827 IMAGE_UNCHANGED_GEOMETRY, | |
828 IMAGE_UNCHANGED_GEOMETRY, domain); | |
829 | |
830 /* We *must* have a clean image at this point. */ | |
831 IMAGE_INSTANCE_TEXT_CHANGED (p) = 0; | |
832 IMAGE_INSTANCE_SIZE_CHANGED (p) = 0; | |
833 IMAGE_INSTANCE_LAYOUT_CHANGED (p) = 0; | |
834 IMAGE_INSTANCE_DIRTYP (p) = 0; | |
835 | |
836 assert ( XIMAGE_INSTANCE_HEIGHT (ii) >= 0 | |
837 && XIMAGE_INSTANCE_WIDTH (ii) >= 0 ); | |
838 | |
839 ERROR_CHECK_IMAGE_INSTANCE (ii); | |
840 | |
841 RETURN_UNGCPRO (ii); | |
428 | 842 } |
843 | |
844 | |
845 /**************************************************************************** | |
846 * Image-Instance Object * | |
847 ****************************************************************************/ | |
848 | |
849 Lisp_Object Qimage_instancep; | |
850 | |
1204 | 851 /* %%#### KKCC: Don't yet handle the equivalent of setting the device field |
852 of image instances w/dead devices to nil. */ | |
853 | |
854 static const struct memory_description text_image_instance_description_1 [] = { | |
855 { XD_LISP_OBJECT, offsetof (struct text_image_instance, string) }, | |
856 { XD_END } | |
857 }; | |
858 | |
859 static const struct sized_memory_description text_image_instance_description = { | |
860 sizeof (struct text_image_instance), text_image_instance_description_1 | |
861 }; | |
862 | |
863 static const struct memory_description pixmap_image_instance_description_1 [] = { | |
864 { XD_LISP_OBJECT, offsetof (struct pixmap_image_instance, hotspot_x) }, | |
865 { XD_LISP_OBJECT, offsetof (struct pixmap_image_instance, hotspot_x) }, | |
866 { XD_LISP_OBJECT, offsetof (struct pixmap_image_instance, filename) }, | |
867 { XD_LISP_OBJECT, offsetof (struct pixmap_image_instance, mask_filename) }, | |
868 { XD_LISP_OBJECT, offsetof (struct pixmap_image_instance, fg) }, | |
869 { XD_LISP_OBJECT, offsetof (struct pixmap_image_instance, bg) }, | |
870 { XD_LISP_OBJECT, offsetof (struct pixmap_image_instance, auxdata) }, | |
871 { XD_END } | |
872 }; | |
873 | |
874 static const struct sized_memory_description pixmap_image_instance_description = { | |
875 sizeof (struct pixmap_image_instance), pixmap_image_instance_description_1 | |
876 }; | |
877 | |
878 static const struct memory_description subwindow_image_instance_description_1 [] = { | |
879 { XD_LISP_OBJECT, offsetof (struct subwindow_image_instance, face) }, | |
880 { XD_LISP_OBJECT, offsetof (struct subwindow_image_instance, type) }, | |
881 { XD_LISP_OBJECT, offsetof (struct subwindow_image_instance, props) }, | |
882 { XD_LISP_OBJECT, offsetof (struct subwindow_image_instance, items) }, | |
883 { XD_LISP_OBJECT, offsetof (struct subwindow_image_instance, pending_items) }, | |
884 { XD_LISP_OBJECT, offsetof (struct subwindow_image_instance, children) }, | |
885 { XD_LISP_OBJECT, offsetof (struct subwindow_image_instance, width) }, | |
886 { XD_LISP_OBJECT, offsetof (struct subwindow_image_instance, height) }, | |
887 { XD_END } | |
888 }; | |
889 | |
890 static const struct sized_memory_description subwindow_image_instance_description = { | |
891 sizeof (struct subwindow_image_instance), subwindow_image_instance_description_1 | |
892 }; | |
893 | |
894 static const struct memory_description image_instance_data_description_1 [] = { | |
2367 | 895 { XD_BLOCK_ARRAY, IMAGE_TEXT, |
2551 | 896 1, { &text_image_instance_description } }, |
2367 | 897 { XD_BLOCK_ARRAY, IMAGE_MONO_PIXMAP, |
2551 | 898 1, { &pixmap_image_instance_description } }, |
2367 | 899 { XD_BLOCK_ARRAY, IMAGE_COLOR_PIXMAP, |
2551 | 900 1, { &pixmap_image_instance_description } }, |
2367 | 901 { XD_BLOCK_ARRAY, IMAGE_WIDGET, |
2551 | 902 1, { &subwindow_image_instance_description } }, |
1204 | 903 { XD_END } |
904 }; | |
905 | |
906 static const struct sized_memory_description image_instance_data_description = { | |
907 0, image_instance_data_description_1 | |
908 }; | |
909 | |
910 static const struct memory_description image_instance_description[] = { | |
911 { XD_INT, offsetof (struct Lisp_Image_Instance, type) }, | |
912 { XD_LISP_OBJECT, offsetof (Lisp_Image_Instance, domain) }, | |
913 { XD_LISP_OBJECT, offsetof (Lisp_Image_Instance, device) }, | |
914 { XD_LISP_OBJECT, offsetof (Lisp_Image_Instance, name) }, | |
915 { XD_LISP_OBJECT, offsetof (Lisp_Image_Instance, parent) }, | |
916 { XD_LISP_OBJECT, offsetof (Lisp_Image_Instance, instantiator) }, | |
4252 | 917 { XD_UNION, offsetof (struct Lisp_Image_Instance, u), |
2551 | 918 XD_INDIRECT (0, 0), { &image_instance_data_description } }, |
1204 | 919 { XD_END } |
920 }; | |
921 | |
428 | 922 static Lisp_Object |
923 mark_image_instance (Lisp_Object obj) | |
924 { | |
440 | 925 Lisp_Image_Instance *i = XIMAGE_INSTANCE (obj); |
428 | 926 |
442 | 927 /* #### I want to check the instance here, but there are way too |
928 many instances of the instance being marked while the domain is | |
929 dead. For instance you can get marked through an event when using | |
930 callback_ex.*/ | |
931 #if 0 | |
932 ERROR_CHECK_IMAGE_INSTANCE (obj); | |
933 #endif | |
934 | |
428 | 935 mark_object (i->name); |
442 | 936 mark_object (i->instantiator); |
1204 | 937 /* #### Is this legal in marking? We may get in the situation where the |
442 | 938 domain has been deleted - making the instance unusable. It seems |
939 better to remove the domain so that it can be finalized. */ | |
940 if (!DOMAIN_LIVE_P (i->domain)) | |
941 i->domain = Qnil; | |
942 else | |
943 mark_object (i->domain); | |
944 | |
438 | 945 /* We don't mark the glyph reference since that would create a |
442 | 946 circularity preventing GC. Ditto the instantiator. */ |
428 | 947 switch (IMAGE_INSTANCE_TYPE (i)) |
948 { | |
949 case IMAGE_TEXT: | |
950 mark_object (IMAGE_INSTANCE_TEXT_STRING (i)); | |
951 break; | |
952 case IMAGE_MONO_PIXMAP: | |
953 case IMAGE_COLOR_PIXMAP: | |
954 mark_object (IMAGE_INSTANCE_PIXMAP_FILENAME (i)); | |
955 mark_object (IMAGE_INSTANCE_PIXMAP_MASK_FILENAME (i)); | |
956 mark_object (IMAGE_INSTANCE_PIXMAP_HOTSPOT_X (i)); | |
957 mark_object (IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (i)); | |
958 mark_object (IMAGE_INSTANCE_PIXMAP_FG (i)); | |
959 mark_object (IMAGE_INSTANCE_PIXMAP_BG (i)); | |
960 break; | |
961 | |
962 case IMAGE_WIDGET: | |
963 mark_object (IMAGE_INSTANCE_WIDGET_TYPE (i)); | |
964 mark_object (IMAGE_INSTANCE_WIDGET_PROPS (i)); | |
442 | 965 mark_object (IMAGE_INSTANCE_SUBWINDOW_FACE (i)); |
428 | 966 mark_object (IMAGE_INSTANCE_WIDGET_ITEMS (i)); |
442 | 967 mark_object (IMAGE_INSTANCE_LAYOUT_CHILDREN (i)); |
968 mark_object (IMAGE_INSTANCE_WIDGET_PENDING_ITEMS (i)); | |
969 mark_object (IMAGE_INSTANCE_WIDGET_HEIGHT_SUBR (i)); | |
970 mark_object (IMAGE_INSTANCE_WIDGET_WIDTH_SUBR (i)); | |
428 | 971 case IMAGE_SUBWINDOW: |
972 break; | |
973 | |
974 default: | |
975 break; | |
976 } | |
977 | |
442 | 978 /* The image may have been previously finalized (yes that's weird, |
979 see Fdelete_frame() and mark_window_as_deleted()), in which case | |
980 the domain will be nil, so cope with this. */ | |
981 if (!NILP (IMAGE_INSTANCE_DEVICE (i))) | |
982 MAYBE_DEVMETH (XDEVICE (IMAGE_INSTANCE_DEVICE (i)), | |
983 mark_image_instance, (i)); | |
428 | 984 |
985 return i->device; | |
986 } | |
987 | |
988 static void | |
989 print_image_instance (Lisp_Object obj, Lisp_Object printcharfun, | |
990 int escapeflag) | |
991 { | |
440 | 992 Lisp_Image_Instance *ii = XIMAGE_INSTANCE (obj); |
428 | 993 |
994 if (print_readably) | |
563 | 995 printing_unreadable_object ("#<image-instance 0x%x>", |
4252 | 996 ii->header.uid); |
800 | 997 write_fmt_string_lisp (printcharfun, "#<image-instance (%s) ", 1, |
998 Fimage_instance_type (obj)); | |
428 | 999 if (!NILP (ii->name)) |
800 | 1000 write_fmt_string_lisp (printcharfun, "%S ", 1, ii->name); |
1001 write_fmt_string_lisp (printcharfun, "on %s ", 1, ii->domain); | |
428 | 1002 switch (IMAGE_INSTANCE_TYPE (ii)) |
1003 { | |
1004 case IMAGE_NOTHING: | |
1005 break; | |
1006 | |
1007 case IMAGE_TEXT: | |
1008 print_internal (IMAGE_INSTANCE_TEXT_STRING (ii), printcharfun, 1); | |
1009 break; | |
1010 | |
1011 case IMAGE_MONO_PIXMAP: | |
1012 case IMAGE_COLOR_PIXMAP: | |
1013 case IMAGE_POINTER: | |
1014 if (STRINGP (IMAGE_INSTANCE_PIXMAP_FILENAME (ii))) | |
1015 { | |
867 | 1016 Ibyte *s; |
428 | 1017 Lisp_Object filename = IMAGE_INSTANCE_PIXMAP_FILENAME (ii); |
771 | 1018 s = qxestrrchr (XSTRING_DATA (filename), '/'); |
428 | 1019 if (s) |
771 | 1020 print_internal (build_intstring (s + 1), printcharfun, 1); |
428 | 1021 else |
1022 print_internal (filename, printcharfun, 1); | |
1023 } | |
1024 if (IMAGE_INSTANCE_PIXMAP_DEPTH (ii) > 1) | |
800 | 1025 write_fmt_string (printcharfun, " %dx%dx%d", |
1026 IMAGE_INSTANCE_PIXMAP_WIDTH (ii), | |
1027 IMAGE_INSTANCE_PIXMAP_HEIGHT (ii), | |
1028 IMAGE_INSTANCE_PIXMAP_DEPTH (ii)); | |
428 | 1029 else |
800 | 1030 write_fmt_string (printcharfun, " %dx%d", |
1031 IMAGE_INSTANCE_PIXMAP_WIDTH (ii), | |
1032 IMAGE_INSTANCE_PIXMAP_HEIGHT (ii)); | |
428 | 1033 if (!NILP (IMAGE_INSTANCE_PIXMAP_HOTSPOT_X (ii)) || |
1034 !NILP (IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (ii))) | |
1035 { | |
826 | 1036 write_c_string (printcharfun, " @"); |
428 | 1037 if (!NILP (IMAGE_INSTANCE_PIXMAP_HOTSPOT_X (ii))) |
800 | 1038 write_fmt_string (printcharfun, "%ld", |
1039 XINT (IMAGE_INSTANCE_PIXMAP_HOTSPOT_X (ii))); | |
428 | 1040 else |
826 | 1041 write_c_string (printcharfun, "??"); |
1042 write_c_string (printcharfun, ","); | |
428 | 1043 if (!NILP (IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (ii))) |
800 | 1044 write_fmt_string (printcharfun, "%ld", |
1045 XINT (IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (ii))); | |
428 | 1046 else |
826 | 1047 write_c_string (printcharfun, "??"); |
428 | 1048 } |
1049 if (!NILP (IMAGE_INSTANCE_PIXMAP_FG (ii)) || | |
1050 !NILP (IMAGE_INSTANCE_PIXMAP_BG (ii))) | |
1051 { | |
826 | 1052 write_c_string (printcharfun, " ("); |
428 | 1053 if (!NILP (IMAGE_INSTANCE_PIXMAP_FG (ii))) |
1054 { | |
1055 print_internal | |
1056 (XCOLOR_INSTANCE | |
1057 (IMAGE_INSTANCE_PIXMAP_FG (ii))->name, printcharfun, 0); | |
1058 } | |
826 | 1059 write_c_string (printcharfun, "/"); |
428 | 1060 if (!NILP (IMAGE_INSTANCE_PIXMAP_BG (ii))) |
1061 { | |
1062 print_internal | |
1063 (XCOLOR_INSTANCE | |
1064 (IMAGE_INSTANCE_PIXMAP_BG (ii))->name, printcharfun, 0); | |
1065 } | |
826 | 1066 write_c_string (printcharfun, ")"); |
428 | 1067 } |
1068 break; | |
1069 | |
1070 case IMAGE_WIDGET: | |
442 | 1071 print_internal (IMAGE_INSTANCE_WIDGET_TYPE (ii), printcharfun, 0); |
1072 | |
1073 if (GUI_ITEMP (IMAGE_INSTANCE_WIDGET_ITEM (ii))) | |
800 | 1074 write_fmt_string_lisp (printcharfun, " %S", 1, |
1075 IMAGE_INSTANCE_WIDGET_TEXT (ii)); | |
442 | 1076 |
428 | 1077 if (!NILP (IMAGE_INSTANCE_WIDGET_FACE (ii))) |
800 | 1078 write_fmt_string_lisp (printcharfun, " face=%s", 1, |
1079 IMAGE_INSTANCE_WIDGET_FACE (ii)); | |
454 | 1080 /* fallthrough */ |
428 | 1081 |
1082 case IMAGE_SUBWINDOW: | |
800 | 1083 write_fmt_string (printcharfun, " %dx%d", IMAGE_INSTANCE_WIDTH (ii), |
1084 IMAGE_INSTANCE_HEIGHT (ii)); | |
428 | 1085 |
1086 /* This is stolen from frame.c. Subwindows are strange in that they | |
1087 are specific to a particular frame so we want to print in their | |
1088 description what that frame is. */ | |
1089 | |
826 | 1090 write_c_string (printcharfun, " on #<"); |
428 | 1091 { |
442 | 1092 struct frame* f = XFRAME (IMAGE_INSTANCE_FRAME (ii)); |
440 | 1093 |
428 | 1094 if (!FRAME_LIVE_P (f)) |
826 | 1095 write_c_string (printcharfun, "dead"); |
440 | 1096 else |
826 | 1097 write_c_string (printcharfun, |
4252 | 1098 DEVICE_TYPE_NAME (XDEVICE (FRAME_DEVICE (f)))); |
428 | 1099 } |
826 | 1100 write_c_string (printcharfun, "-frame>"); |
800 | 1101 write_fmt_string (printcharfun, " 0x%p", |
1102 IMAGE_INSTANCE_SUBWINDOW_ID (ii)); | |
440 | 1103 |
428 | 1104 break; |
1105 | |
1106 default: | |
2500 | 1107 ABORT (); |
428 | 1108 } |
1109 | |
442 | 1110 MAYBE_DEVMETH (DOMAIN_XDEVICE (ii->domain), print_image_instance, |
428 | 1111 (ii, printcharfun, escapeflag)); |
800 | 1112 write_fmt_string (printcharfun, " 0x%x>", ii->header.uid); |
428 | 1113 } |
1114 | |
1115 static void | |
1116 finalize_image_instance (void *header, int for_disksave) | |
1117 { | |
440 | 1118 Lisp_Image_Instance *i = (Lisp_Image_Instance *) header; |
428 | 1119 |
442 | 1120 /* objects like this exist at dump time, so don't bomb out. */ |
1121 if (IMAGE_INSTANCE_TYPE (i) == IMAGE_NOTHING | |
1122 || | |
1123 NILP (IMAGE_INSTANCE_DEVICE (i))) | |
428 | 1124 return; |
1125 if (for_disksave) finalose (i); | |
1126 | |
442 | 1127 /* We can't use the domain here, because it might have |
1128 disappeared. */ | |
1129 MAYBE_DEVMETH (XDEVICE (IMAGE_INSTANCE_DEVICE (i)), | |
1130 finalize_image_instance, (i)); | |
1131 | |
1132 /* Make sure we don't try this twice. */ | |
1133 IMAGE_INSTANCE_DEVICE (i) = Qnil; | |
428 | 1134 } |
1135 | |
1136 static int | |
1137 image_instance_equal (Lisp_Object obj1, Lisp_Object obj2, int depth) | |
1138 { | |
440 | 1139 Lisp_Image_Instance *i1 = XIMAGE_INSTANCE (obj1); |
1140 Lisp_Image_Instance *i2 = XIMAGE_INSTANCE (obj2); | |
442 | 1141 |
1142 ERROR_CHECK_IMAGE_INSTANCE (obj1); | |
1143 ERROR_CHECK_IMAGE_INSTANCE (obj2); | |
1144 | |
1145 if (!EQ (IMAGE_INSTANCE_DOMAIN (i1), | |
1146 IMAGE_INSTANCE_DOMAIN (i2)) | |
1147 || IMAGE_INSTANCE_TYPE (i1) != IMAGE_INSTANCE_TYPE (i2) | |
438 | 1148 || IMAGE_INSTANCE_WIDTH (i1) != IMAGE_INSTANCE_WIDTH (i2) |
442 | 1149 || IMAGE_INSTANCE_MARGIN_WIDTH (i1) != |
1150 IMAGE_INSTANCE_MARGIN_WIDTH (i2) | |
438 | 1151 || IMAGE_INSTANCE_HEIGHT (i1) != IMAGE_INSTANCE_HEIGHT (i2) |
1152 || IMAGE_INSTANCE_XOFFSET (i1) != IMAGE_INSTANCE_XOFFSET (i2) | |
1153 || IMAGE_INSTANCE_YOFFSET (i1) != IMAGE_INSTANCE_YOFFSET (i2)) | |
428 | 1154 return 0; |
1155 if (!internal_equal (IMAGE_INSTANCE_NAME (i1), IMAGE_INSTANCE_NAME (i2), | |
1156 depth + 1)) | |
1157 return 0; | |
442 | 1158 if (!internal_equal (IMAGE_INSTANCE_INSTANTIATOR (i1), |
1159 IMAGE_INSTANCE_INSTANTIATOR (i2), | |
1160 depth + 1)) | |
1161 return 0; | |
428 | 1162 |
1163 switch (IMAGE_INSTANCE_TYPE (i1)) | |
1164 { | |
1165 case IMAGE_NOTHING: | |
1166 break; | |
1167 | |
1168 case IMAGE_TEXT: | |
1169 if (!internal_equal (IMAGE_INSTANCE_TEXT_STRING (i1), | |
1170 IMAGE_INSTANCE_TEXT_STRING (i2), | |
1171 depth + 1)) | |
1172 return 0; | |
1173 break; | |
1174 | |
1175 case IMAGE_MONO_PIXMAP: | |
1176 case IMAGE_COLOR_PIXMAP: | |
1177 case IMAGE_POINTER: | |
438 | 1178 if (!(IMAGE_INSTANCE_PIXMAP_DEPTH (i1) == |
428 | 1179 IMAGE_INSTANCE_PIXMAP_DEPTH (i2) && |
1180 IMAGE_INSTANCE_PIXMAP_SLICE (i1) == | |
1181 IMAGE_INSTANCE_PIXMAP_SLICE (i2) && | |
1182 EQ (IMAGE_INSTANCE_PIXMAP_HOTSPOT_X (i1), | |
1183 IMAGE_INSTANCE_PIXMAP_HOTSPOT_X (i2)) && | |
1184 EQ (IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (i1), | |
1185 IMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (i2)) && | |
1186 internal_equal (IMAGE_INSTANCE_PIXMAP_FILENAME (i1), | |
1187 IMAGE_INSTANCE_PIXMAP_FILENAME (i2), | |
1188 depth + 1) && | |
1189 internal_equal (IMAGE_INSTANCE_PIXMAP_MASK_FILENAME (i1), | |
1190 IMAGE_INSTANCE_PIXMAP_MASK_FILENAME (i2), | |
1191 depth + 1))) | |
1192 return 0; | |
1193 break; | |
1194 | |
1195 case IMAGE_WIDGET: | |
1196 if (!(EQ (IMAGE_INSTANCE_WIDGET_TYPE (i1), | |
1197 IMAGE_INSTANCE_WIDGET_TYPE (i2)) | |
438 | 1198 && IMAGE_INSTANCE_SUBWINDOW_ID (i1) == |
1199 IMAGE_INSTANCE_SUBWINDOW_ID (i2) | |
442 | 1200 && |
1201 EQ (IMAGE_INSTANCE_WIDGET_FACE (i1), | |
1202 IMAGE_INSTANCE_WIDGET_TYPE (i2)) | |
428 | 1203 && internal_equal (IMAGE_INSTANCE_WIDGET_ITEMS (i1), |
1204 IMAGE_INSTANCE_WIDGET_ITEMS (i2), | |
1205 depth + 1) | |
442 | 1206 && internal_equal (IMAGE_INSTANCE_LAYOUT_CHILDREN (i1), |
1207 IMAGE_INSTANCE_LAYOUT_CHILDREN (i2), | |
1208 depth + 1) | |
428 | 1209 && internal_equal (IMAGE_INSTANCE_WIDGET_PROPS (i1), |
1210 IMAGE_INSTANCE_WIDGET_PROPS (i2), | |
1211 depth + 1) | |
442 | 1212 && internal_equal (IMAGE_INSTANCE_WIDGET_WIDTH_SUBR (i1), |
1213 IMAGE_INSTANCE_WIDGET_WIDTH_SUBR (i2), | |
1214 depth + 1) | |
1215 && internal_equal (IMAGE_INSTANCE_WIDGET_HEIGHT_SUBR (i1), | |
1216 IMAGE_INSTANCE_WIDGET_HEIGHT_SUBR (i2), | |
1217 depth + 1) | |
428 | 1218 )) |
1219 return 0; | |
438 | 1220 break; |
440 | 1221 |
428 | 1222 case IMAGE_SUBWINDOW: |
438 | 1223 if (!(IMAGE_INSTANCE_SUBWINDOW_ID (i1) == |
428 | 1224 IMAGE_INSTANCE_SUBWINDOW_ID (i2))) |
1225 return 0; | |
1226 break; | |
1227 | |
1228 default: | |
2500 | 1229 ABORT (); |
428 | 1230 } |
1231 | |
442 | 1232 return DEVMETH_OR_GIVEN (DOMAIN_XDEVICE (i1->domain), |
1233 image_instance_equal, (i1, i2, depth), 1); | |
1234 } | |
1235 | |
1236 /* Image instance domain manipulators. We can't error check in these | |
1237 otherwise we get into infinite recursion. */ | |
1238 Lisp_Object | |
1239 image_instance_device (Lisp_Object instance) | |
1240 { | |
1241 return XIMAGE_INSTANCE_DEVICE (instance); | |
1242 } | |
1243 | |
1244 Lisp_Object | |
1245 image_instance_frame (Lisp_Object instance) | |
1246 { | |
1247 return XIMAGE_INSTANCE_FRAME (instance); | |
1248 } | |
1249 | |
1250 Lisp_Object | |
1251 image_instance_window (Lisp_Object instance) | |
1252 { | |
1253 return DOMAIN_WINDOW (XIMAGE_INSTANCE_DOMAIN (instance)); | |
1254 } | |
1255 | |
1256 int | |
1257 image_instance_live_p (Lisp_Object instance) | |
1258 { | |
1259 return DOMAIN_LIVE_P (XIMAGE_INSTANCE_DOMAIN (instance)); | |
428 | 1260 } |
1261 | |
665 | 1262 static Hashcode |
428 | 1263 image_instance_hash (Lisp_Object obj, int depth) |
1264 { | |
440 | 1265 Lisp_Image_Instance *i = XIMAGE_INSTANCE (obj); |
665 | 1266 Hashcode hash = HASH5 (LISP_HASH (IMAGE_INSTANCE_DOMAIN (i)), |
647 | 1267 IMAGE_INSTANCE_WIDTH (i), |
1268 IMAGE_INSTANCE_MARGIN_WIDTH (i), | |
1269 IMAGE_INSTANCE_HEIGHT (i), | |
1270 internal_hash (IMAGE_INSTANCE_INSTANTIATOR (i), | |
1271 depth + 1)); | |
442 | 1272 |
1273 ERROR_CHECK_IMAGE_INSTANCE (obj); | |
428 | 1274 |
1275 switch (IMAGE_INSTANCE_TYPE (i)) | |
1276 { | |
1277 case IMAGE_NOTHING: | |
1278 break; | |
1279 | |
1280 case IMAGE_TEXT: | |
1281 hash = HASH2 (hash, internal_hash (IMAGE_INSTANCE_TEXT_STRING (i), | |
1282 depth + 1)); | |
1283 break; | |
1284 | |
1285 case IMAGE_MONO_PIXMAP: | |
1286 case IMAGE_COLOR_PIXMAP: | |
1287 case IMAGE_POINTER: | |
438 | 1288 hash = HASH4 (hash, IMAGE_INSTANCE_PIXMAP_DEPTH (i), |
428 | 1289 IMAGE_INSTANCE_PIXMAP_SLICE (i), |
1290 internal_hash (IMAGE_INSTANCE_PIXMAP_FILENAME (i), | |
1291 depth + 1)); | |
1292 break; | |
1293 | |
1294 case IMAGE_WIDGET: | |
442 | 1295 /* We need the hash to be equivalent to what should be |
4252 | 1296 displayed. */ |
442 | 1297 hash = HASH5 (hash, |
1298 LISP_HASH (IMAGE_INSTANCE_WIDGET_TYPE (i)), | |
428 | 1299 internal_hash (IMAGE_INSTANCE_WIDGET_PROPS (i), depth + 1), |
442 | 1300 internal_hash (IMAGE_INSTANCE_WIDGET_ITEMS (i), depth + 1), |
1301 internal_hash (IMAGE_INSTANCE_LAYOUT_CHILDREN (i), | |
1302 depth + 1)); | |
438 | 1303 case IMAGE_SUBWINDOW: |
442 | 1304 hash = HASH2 (hash, (EMACS_INT) IMAGE_INSTANCE_SUBWINDOW_ID (i)); |
438 | 1305 break; |
1306 | |
428 | 1307 default: |
2500 | 1308 ABORT (); |
428 | 1309 } |
1310 | |
442 | 1311 return HASH2 (hash, DEVMETH_OR_GIVEN |
1312 (XDEVICE (image_instance_device (obj)), | |
1313 image_instance_hash, (i, depth), | |
1314 0)); | |
428 | 1315 } |
1316 | |
934 | 1317 DEFINE_LRECORD_IMPLEMENTATION ("image-instance", image_instance, |
1318 0, /*dumpable-flag*/ | |
1319 mark_image_instance, print_image_instance, | |
1320 finalize_image_instance, image_instance_equal, | |
1204 | 1321 image_instance_hash, |
1322 image_instance_description, | |
934 | 1323 Lisp_Image_Instance); |
428 | 1324 |
1325 static Lisp_Object | |
442 | 1326 allocate_image_instance (Lisp_Object governing_domain, Lisp_Object parent, |
1327 Lisp_Object instantiator) | |
428 | 1328 { |
440 | 1329 Lisp_Image_Instance *lp = |
3017 | 1330 ALLOC_LCRECORD_TYPE (Lisp_Image_Instance, &lrecord_image_instance); |
428 | 1331 Lisp_Object val; |
1332 | |
442 | 1333 /* It's not possible to simply keep a record of the domain in which |
1334 the instance was instantiated. This is because caching may mean | |
1335 that the domain becomes invalid but the instance remains | |
1336 valid. However, the only truly relevant domain is the domain in | |
1337 which the instance is cached since this is the one that will be | |
1338 common to the instances. */ | |
1339 lp->domain = governing_domain; | |
1340 /* The cache domain is not quite sufficient since the domain can get | |
1341 deleted before the image instance does. We need to know the | |
1342 domain device in order to finalize the image instance | |
1343 properly. We therefore record the device also. */ | |
1344 lp->device = DOMAIN_DEVICE (governing_domain); | |
428 | 1345 lp->type = IMAGE_NOTHING; |
1346 lp->name = Qnil; | |
442 | 1347 lp->width = IMAGE_UNSPECIFIED_GEOMETRY; |
1348 lp->height = IMAGE_UNSPECIFIED_GEOMETRY; | |
1349 lp->parent = parent; | |
1350 lp->instantiator = instantiator; | |
1351 /* So that layouts get done. */ | |
1352 lp->layout_changed = 1; | |
1353 | |
793 | 1354 val = wrap_image_instance (lp); |
442 | 1355 MARK_GLYPHS_CHANGED; |
1356 | |
428 | 1357 return val; |
1358 } | |
1359 | |
1360 static enum image_instance_type | |
578 | 1361 decode_image_instance_type (Lisp_Object type, Error_Behavior errb) |
428 | 1362 { |
1363 if (ERRB_EQ (errb, ERROR_ME)) | |
1364 CHECK_SYMBOL (type); | |
1365 | |
1366 if (EQ (type, Qnothing)) return IMAGE_NOTHING; | |
1367 if (EQ (type, Qtext)) return IMAGE_TEXT; | |
1368 if (EQ (type, Qmono_pixmap)) return IMAGE_MONO_PIXMAP; | |
1369 if (EQ (type, Qcolor_pixmap)) return IMAGE_COLOR_PIXMAP; | |
1370 if (EQ (type, Qpointer)) return IMAGE_POINTER; | |
1371 if (EQ (type, Qsubwindow)) return IMAGE_SUBWINDOW; | |
1372 if (EQ (type, Qwidget)) return IMAGE_WIDGET; | |
1373 | |
563 | 1374 maybe_invalid_constant ("Invalid image-instance type", type, |
428 | 1375 Qimage, errb); |
1376 | |
1377 return IMAGE_UNKNOWN; /* not reached */ | |
1378 } | |
1379 | |
1380 static Lisp_Object | |
1381 encode_image_instance_type (enum image_instance_type type) | |
1382 { | |
1383 switch (type) | |
1384 { | |
1385 case IMAGE_NOTHING: return Qnothing; | |
1386 case IMAGE_TEXT: return Qtext; | |
1387 case IMAGE_MONO_PIXMAP: return Qmono_pixmap; | |
1388 case IMAGE_COLOR_PIXMAP: return Qcolor_pixmap; | |
1389 case IMAGE_POINTER: return Qpointer; | |
1390 case IMAGE_SUBWINDOW: return Qsubwindow; | |
1391 case IMAGE_WIDGET: return Qwidget; | |
1392 default: | |
2500 | 1393 ABORT (); |
428 | 1394 } |
1395 | |
1396 return Qnil; /* not reached */ | |
1397 } | |
1398 | |
1399 static int | |
1400 decode_image_instance_type_list (Lisp_Object list) | |
1401 { | |
1402 int mask = 0; | |
1403 | |
1404 if (NILP (list)) | |
1405 return ~0; | |
1406 | |
1407 if (!CONSP (list)) | |
1408 { | |
1409 enum image_instance_type type = | |
1410 decode_image_instance_type (list, ERROR_ME); | |
1411 return image_instance_type_to_mask (type); | |
1412 } | |
1413 | |
2367 | 1414 { |
1415 EXTERNAL_LIST_LOOP_2 (elt, list) | |
1416 { | |
1417 enum image_instance_type type = | |
1418 decode_image_instance_type (elt, ERROR_ME); | |
1419 mask |= image_instance_type_to_mask (type); | |
1420 } | |
1421 } | |
428 | 1422 |
1423 return mask; | |
1424 } | |
1425 | |
1426 static Lisp_Object | |
1427 encode_image_instance_type_list (int mask) | |
1428 { | |
1429 int count = 0; | |
1430 Lisp_Object result = Qnil; | |
1431 | |
1432 while (mask) | |
1433 { | |
1434 count++; | |
1435 if (mask & 1) | |
1436 result = Fcons (encode_image_instance_type | |
1437 ((enum image_instance_type) count), result); | |
1438 mask >>= 1; | |
1439 } | |
1440 | |
1441 return Fnreverse (result); | |
1442 } | |
1443 | |
1444 DOESNT_RETURN | |
1445 incompatible_image_types (Lisp_Object instantiator, int given_dest_mask, | |
1446 int desired_dest_mask) | |
1447 { | |
563 | 1448 signal_error_1 |
1449 (Qinvalid_argument, | |
428 | 1450 list2 |
771 | 1451 (emacs_sprintf_string_lisp |
1452 ("No compatible image-instance types given: wanted one of %s, got %s", | |
1453 Qnil, 2, encode_image_instance_type_list (desired_dest_mask), | |
428 | 1454 encode_image_instance_type_list (given_dest_mask)), |
1455 instantiator)); | |
1456 } | |
1457 | |
1458 static int | |
1459 valid_image_instance_type_p (Lisp_Object type) | |
1460 { | |
1461 return !NILP (memq_no_quit (type, Vimage_instance_type_list)); | |
1462 } | |
1463 | |
1464 DEFUN ("valid-image-instance-type-p", Fvalid_image_instance_type_p, 1, 1, 0, /* | |
1465 Given an IMAGE-INSTANCE-TYPE, return non-nil if it is valid. | |
2959 | 1466 Valid types are some subset of `nothing', `text', `mono-pixmap', |
1467 `color-pixmap', `pointer', `subwindow', and `widget', depending on how | |
1468 XEmacs was compiled. | |
428 | 1469 */ |
1470 (image_instance_type)) | |
1471 { | |
1472 return valid_image_instance_type_p (image_instance_type) ? Qt : Qnil; | |
1473 } | |
1474 | |
1475 DEFUN ("image-instance-type-list", Fimage_instance_type_list, 0, 0, 0, /* | |
1476 Return a list of valid image-instance types. | |
1477 */ | |
1478 ()) | |
1479 { | |
1480 return Fcopy_sequence (Vimage_instance_type_list); | |
1481 } | |
1482 | |
578 | 1483 Error_Behavior |
444 | 1484 decode_error_behavior_flag (Lisp_Object noerror) |
1485 { | |
1486 if (NILP (noerror)) return ERROR_ME; | |
1487 else if (EQ (noerror, Qt)) return ERROR_ME_NOT; | |
793 | 1488 else if (EQ (noerror, Qdebug)) return ERROR_ME_DEBUG_WARN; |
444 | 1489 else return ERROR_ME_WARN; |
428 | 1490 } |
1491 | |
1492 Lisp_Object | |
578 | 1493 encode_error_behavior_flag (Error_Behavior errb) |
428 | 1494 { |
1495 if (ERRB_EQ (errb, ERROR_ME)) | |
1496 return Qnil; | |
1497 else if (ERRB_EQ (errb, ERROR_ME_NOT)) | |
1498 return Qt; | |
793 | 1499 else if (ERRB_EQ (errb, ERROR_ME_DEBUG_WARN)) |
1500 return Qdebug; | |
428 | 1501 else |
1502 { | |
1503 assert (ERRB_EQ (errb, ERROR_ME_WARN)); | |
1504 return Qwarning; | |
1505 } | |
1506 } | |
1507 | |
442 | 1508 /* Recurse up the hierarchy looking for the topmost glyph. This means |
1509 that instances in layouts will inherit face properties from their | |
1510 parent. */ | |
1511 Lisp_Object image_instance_parent_glyph (Lisp_Image_Instance* ii) | |
1512 { | |
1513 if (IMAGE_INSTANCEP (IMAGE_INSTANCE_PARENT (ii))) | |
1514 { | |
1515 return image_instance_parent_glyph | |
1516 (XIMAGE_INSTANCE (IMAGE_INSTANCE_PARENT (ii))); | |
1517 } | |
1518 return IMAGE_INSTANCE_PARENT (ii); | |
1519 } | |
1520 | |
428 | 1521 static Lisp_Object |
442 | 1522 make_image_instance_1 (Lisp_Object data, Lisp_Object domain, |
428 | 1523 Lisp_Object dest_types) |
1524 { | |
1525 Lisp_Object ii; | |
1526 struct gcpro gcpro1; | |
1527 int dest_mask; | |
442 | 1528 Lisp_Object governing_domain; |
1529 | |
428 | 1530 if (IMAGE_INSTANCEP (data)) |
563 | 1531 invalid_argument ("Image instances not allowed here", data); |
428 | 1532 image_validate (data); |
442 | 1533 domain = decode_domain (domain); |
1534 /* instantiate_image_instantiator() will abort if given an | |
1535 image instance ... */ | |
428 | 1536 dest_mask = decode_image_instance_type_list (dest_types); |
442 | 1537 data = normalize_image_instantiator (data, |
1538 DEVICE_TYPE (DOMAIN_XDEVICE (domain)), | |
428 | 1539 make_int (dest_mask)); |
1540 GCPRO1 (data); | |
442 | 1541 /* After normalizing the data, it's always either an image instance (which |
1542 we filtered out above) or a vector. */ | |
450 | 1543 if (EQ (INSTANTIATOR_TYPE (data), Qinherit)) |
563 | 1544 invalid_argument ("Inheritance not allowed here", data); |
442 | 1545 governing_domain = |
1546 get_image_instantiator_governing_domain (data, domain); | |
1547 ii = instantiate_image_instantiator (governing_domain, domain, data, | |
438 | 1548 Qnil, Qnil, dest_mask, Qnil); |
428 | 1549 RETURN_UNGCPRO (ii); |
1550 } | |
1551 | |
1552 DEFUN ("make-image-instance", Fmake_image_instance, 1, 4, 0, /* | |
1553 Return a new `image-instance' object. | |
1554 | |
1555 Image-instance objects encapsulate the way a particular image (pixmap, | |
1556 etc.) is displayed on a particular device. In most circumstances, you | |
1557 do not need to directly create image instances; use a glyph instead. | |
1558 However, it may occasionally be useful to explicitly create image | |
1559 instances, if you want more control over the instantiation process. | |
1560 | |
1561 DATA is an image instantiator, which describes the image; see | |
442 | 1562 `make-image-specifier' for a description of the allowed values. |
428 | 1563 |
1564 DEST-TYPES should be a list of allowed image instance types that can | |
1565 be generated. The recognized image instance types are | |
1566 | |
2959 | 1567 `nothing' |
428 | 1568 Nothing is displayed. |
2959 | 1569 `text' |
428 | 1570 Displayed as text. The foreground and background colors and the |
1571 font of the text are specified independent of the pixmap. Typically | |
1572 these attributes will come from the face of the surrounding text, | |
1573 unless a face is specified for the glyph in which the image appears. | |
2959 | 1574 `mono-pixmap' |
428 | 1575 Displayed as a mono pixmap (a pixmap with only two colors where the |
1576 foreground and background can be specified independent of the pixmap; | |
1577 typically the pixmap assumes the foreground and background colors of | |
1578 the text around it, unless a face is specified for the glyph in which | |
1579 the image appears). | |
2959 | 1580 `color-pixmap' |
428 | 1581 Displayed as a color pixmap. |
2959 | 1582 `pointer' |
428 | 1583 Used as the mouse pointer for a window. |
2959 | 1584 `subwindow' |
428 | 1585 A child window that is treated as an image. This allows (e.g.) |
1586 another program to be responsible for drawing into the window. | |
2959 | 1587 `widget' |
428 | 1588 A child window that contains a window-system widget, e.g. a push |
442 | 1589 button, text field, or slider. |
1590 | |
1591 The DEST-TYPES list is unordered. If multiple destination types are | |
1592 possible for a given instantiator, the "most natural" type for the | |
1593 instantiator's format is chosen. (For XBM, the most natural types are | |
1594 `mono-pixmap', followed by `color-pixmap', followed by `pointer'. For | |
1595 the other normal image formats, the most natural types are | |
1596 `color-pixmap', followed by `mono-pixmap', followed by `pointer'. For | |
1597 the string and formatted-string formats, the most natural types are | |
1598 `text', followed by `mono-pixmap' (not currently implemented), | |
1599 followed by `color-pixmap' (not currently implemented). For MS | |
1600 Windows resources, the most natural type for pointer resources is | |
1601 `pointer', and for the others it's `color-pixmap'. The other formats | |
1602 can only be instantiated as one type. (If you want to control more | |
1603 specifically the order of the types into which an image is | |
1604 instantiated, just call `make-image-instance' repeatedly until it | |
1605 succeeds, passing less and less preferred destination types each | |
1606 time.) | |
1607 | |
1608 See `make-image-specifier' for a description of the different image | |
1609 instantiator formats. | |
428 | 1610 |
1611 If DEST-TYPES is omitted, all possible types are allowed. | |
1612 | |
442 | 1613 DOMAIN specifies the domain to which the image instance will be attached. |
1614 This domain is termed the \"governing domain\". The type of the governing | |
1615 domain depends on the image instantiator format. (Although, more correctly, | |
1616 it should probably depend on the image instance type.) For example, pixmap | |
1617 image instances are specific to a device, but widget image instances are | |
1618 specific to a particular XEmacs window because in order to display such a | |
1619 widget when two windows onto the same buffer want to display the widget, | |
1620 two separate underlying widgets must be created. (That's because a widget | |
1621 is actually a child window-system window, and all window-system windows have | |
1622 a unique existence on the screen.) This means that the governing domain for | |
1623 a pixmap image instance will be some device (most likely, the only existing | |
1624 device), whereas the governing domain for a widget image instance will be | |
1625 some XEmacs window. | |
1626 | |
1627 If you specify an overly general DOMAIN (e.g. a frame when a window was | |
1628 wanted), an error is signaled. If you specify an overly specific DOMAIN | |
1629 \(e.g. a window when a device was wanted), the corresponding general domain | |
1630 is fetched and used instead. For `make-image-instance', it makes no | |
1631 difference whether you specify an overly specific domain or the properly | |
1632 general domain derived from it. However, it does matter when creating an | |
1633 image instance by instantiating a specifier or glyph (e.g. with | |
1634 `glyph-image-instance'), because the more specific domain causes spec lookup | |
1635 to start there and proceed to more general domains. (It would also matter | |
1636 when creating an image instance with an instantiator format of `inherit', | |
1637 but we currently disallow this. #### We should fix this.) | |
1638 | |
1639 If omitted, DOMAIN defaults to the selected window. | |
1640 | |
444 | 1641 NOERROR controls what happens when the image cannot be generated. |
428 | 1642 If nil, an error message is generated. If t, no messages are |
1643 generated and this function returns nil. If anything else, a warning | |
440 | 1644 message is generated and this function returns nil. |
428 | 1645 */ |
444 | 1646 (data, domain, dest_types, noerror)) |
1647 { | |
578 | 1648 Error_Behavior errb = decode_error_behavior_flag (noerror); |
428 | 1649 |
1650 return call_with_suspended_errors ((lisp_fn_t) make_image_instance_1, | |
1651 Qnil, Qimage, errb, | |
442 | 1652 3, data, domain, dest_types); |
428 | 1653 } |
1654 | |
1655 DEFUN ("image-instance-p", Fimage_instance_p, 1, 1, 0, /* | |
1656 Return non-nil if OBJECT is an image instance. | |
1657 */ | |
1658 (object)) | |
1659 { | |
1660 return IMAGE_INSTANCEP (object) ? Qt : Qnil; | |
1661 } | |
1662 | |
1663 DEFUN ("image-instance-type", Fimage_instance_type, 1, 1, 0, /* | |
1664 Return the type of the given image instance. | |
2959 | 1665 The return value will be one of `nothing', `text', `mono-pixmap', |
1666 `color-pixmap', `pointer', `subwindow', or `widget'. | |
428 | 1667 */ |
1668 (image_instance)) | |
1669 { | |
1670 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1671 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1672 return encode_image_instance_type (XIMAGE_INSTANCE_TYPE (image_instance)); |
1673 } | |
1674 | |
1675 DEFUN ("image-instance-name", Fimage_instance_name, 1, 1, 0, /* | |
1676 Return the name of the given image instance. | |
1677 */ | |
1678 (image_instance)) | |
1679 { | |
1680 CHECK_IMAGE_INSTANCE (image_instance); | |
1681 return XIMAGE_INSTANCE_NAME (image_instance); | |
1682 } | |
1683 | |
872 | 1684 DEFUN ("image-instance-instantiator", Fimage_instance_instantiator, 1, 1, 0, /* |
1685 Return the instantiator that was used to create the image instance. | |
1686 */ | |
1687 (image_instance)) | |
1688 { | |
1689 CHECK_IMAGE_INSTANCE (image_instance); | |
1690 return XIMAGE_INSTANCE_INSTANTIATOR (image_instance); | |
1691 } | |
1692 | |
442 | 1693 DEFUN ("image-instance-domain", Fimage_instance_domain, 1, 1, 0, /* |
1694 Return the governing domain of the given image instance. | |
1695 The governing domain of an image instance is the domain that the image | |
1696 instance is specific to. It is NOT necessarily the domain that was | |
1697 given to the call to `specifier-instance' that resulted in the creation | |
1698 of this image instance. See `make-image-instance' for more information | |
1699 on governing domains. | |
1700 */ | |
1701 (image_instance)) | |
1702 { | |
1703 CHECK_IMAGE_INSTANCE (image_instance); | |
1704 return XIMAGE_INSTANCE_DOMAIN (image_instance); | |
1705 } | |
1706 | |
428 | 1707 DEFUN ("image-instance-string", Fimage_instance_string, 1, 1, 0, /* |
1708 Return the string of the given image instance. | |
1709 This will only be non-nil for text image instances and widgets. | |
1710 */ | |
1711 (image_instance)) | |
1712 { | |
1713 CHECK_IMAGE_INSTANCE (image_instance); | |
1714 if (XIMAGE_INSTANCE_TYPE (image_instance) == IMAGE_TEXT) | |
1715 return XIMAGE_INSTANCE_TEXT_STRING (image_instance); | |
1716 else if (XIMAGE_INSTANCE_TYPE (image_instance) == IMAGE_WIDGET) | |
1717 return XIMAGE_INSTANCE_WIDGET_TEXT (image_instance); | |
1718 else | |
1719 return Qnil; | |
1720 } | |
1721 | |
1722 DEFUN ("image-instance-property", Fimage_instance_property, 2, 2, 0, /* | |
440 | 1723 Return the given property of the given image instance. |
428 | 1724 Returns nil if the property or the property method do not exist for |
440 | 1725 the image instance in the domain. |
428 | 1726 */ |
1727 (image_instance, prop)) | |
1728 { | |
440 | 1729 Lisp_Image_Instance* ii; |
428 | 1730 Lisp_Object type, ret; |
1731 struct image_instantiator_methods* meths; | |
1732 | |
1733 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1734 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1735 CHECK_SYMBOL (prop); |
1736 ii = XIMAGE_INSTANCE (image_instance); | |
1737 | |
1738 /* ... then try device specific methods ... */ | |
1739 type = encode_image_instance_type (IMAGE_INSTANCE_TYPE (ii)); | |
442 | 1740 meths = decode_device_ii_format (image_instance_device (image_instance), |
428 | 1741 type, ERROR_ME_NOT); |
1742 if (meths && HAS_IIFORMAT_METH_P (meths, property) | |
440 | 1743 && |
428 | 1744 !UNBOUNDP (ret = IIFORMAT_METH (meths, property, (image_instance, prop)))) |
1745 { | |
1746 return ret; | |
1747 } | |
1748 /* ... then format specific methods ... */ | |
1749 meths = decode_device_ii_format (Qnil, type, ERROR_ME_NOT); | |
1750 if (meths && HAS_IIFORMAT_METH_P (meths, property) | |
1751 && | |
1752 !UNBOUNDP (ret = IIFORMAT_METH (meths, property, (image_instance, prop)))) | |
1753 { | |
1754 return ret; | |
1755 } | |
1756 /* ... then fail */ | |
1757 return Qnil; | |
1758 } | |
1759 | |
1760 DEFUN ("image-instance-file-name", Fimage_instance_file_name, 1, 1, 0, /* | |
1761 Return the file name from which IMAGE-INSTANCE was read, if known. | |
1762 */ | |
1763 (image_instance)) | |
1764 { | |
1765 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1766 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1767 |
1768 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1769 { | |
1770 case IMAGE_MONO_PIXMAP: | |
1771 case IMAGE_COLOR_PIXMAP: | |
1772 case IMAGE_POINTER: | |
1773 return XIMAGE_INSTANCE_PIXMAP_FILENAME (image_instance); | |
1774 | |
1775 default: | |
1776 return Qnil; | |
1777 } | |
1778 } | |
1779 | |
1780 DEFUN ("image-instance-mask-file-name", Fimage_instance_mask_file_name, 1, 1, 0, /* | |
1781 Return the file name from which IMAGE-INSTANCE's mask was read, if known. | |
1782 */ | |
1783 (image_instance)) | |
1784 { | |
1785 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1786 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1787 |
1788 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1789 { | |
1790 case IMAGE_MONO_PIXMAP: | |
1791 case IMAGE_COLOR_PIXMAP: | |
1792 case IMAGE_POINTER: | |
1793 return XIMAGE_INSTANCE_PIXMAP_MASK_FILENAME (image_instance); | |
1794 | |
1795 default: | |
1796 return Qnil; | |
1797 } | |
1798 } | |
1799 | |
1800 DEFUN ("image-instance-depth", Fimage_instance_depth, 1, 1, 0, /* | |
1801 Return the depth of the image instance. | |
1802 This is 0 for a bitmap, or a positive integer for a pixmap. | |
1803 */ | |
1804 (image_instance)) | |
1805 { | |
1806 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1807 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1808 |
1809 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1810 { | |
1811 case IMAGE_MONO_PIXMAP: | |
1812 case IMAGE_COLOR_PIXMAP: | |
1813 case IMAGE_POINTER: | |
1814 return make_int (XIMAGE_INSTANCE_PIXMAP_DEPTH (image_instance)); | |
1815 | |
1816 default: | |
1817 return Qnil; | |
1818 } | |
1819 } | |
1820 | |
1821 DEFUN ("image-instance-height", Fimage_instance_height, 1, 1, 0, /* | |
1822 Return the height of the image instance, in pixels. | |
1823 */ | |
1824 (image_instance)) | |
1825 { | |
1826 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1827 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1828 |
1829 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1830 { | |
1831 case IMAGE_MONO_PIXMAP: | |
1832 case IMAGE_COLOR_PIXMAP: | |
1833 case IMAGE_POINTER: | |
1834 case IMAGE_SUBWINDOW: | |
1835 case IMAGE_WIDGET: | |
438 | 1836 return make_int (XIMAGE_INSTANCE_HEIGHT (image_instance)); |
428 | 1837 |
1838 default: | |
1839 return Qnil; | |
1840 } | |
1841 } | |
1842 | |
1843 DEFUN ("image-instance-width", Fimage_instance_width, 1, 1, 0, /* | |
1844 Return the width of the image instance, in pixels. | |
1845 */ | |
1846 (image_instance)) | |
1847 { | |
1848 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1849 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1850 |
1851 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1852 { | |
1853 case IMAGE_MONO_PIXMAP: | |
1854 case IMAGE_COLOR_PIXMAP: | |
1855 case IMAGE_POINTER: | |
1856 case IMAGE_SUBWINDOW: | |
1857 case IMAGE_WIDGET: | |
438 | 1858 return make_int (XIMAGE_INSTANCE_WIDTH (image_instance)); |
428 | 1859 |
1860 default: | |
1861 return Qnil; | |
1862 } | |
1863 } | |
1864 | |
1865 DEFUN ("image-instance-hotspot-x", Fimage_instance_hotspot_x, 1, 1, 0, /* | |
1866 Return the X coordinate of the image instance's hotspot, if known. | |
1867 This is a point relative to the origin of the pixmap. When an image is | |
1868 used as a mouse pointer, the hotspot is the point on the image that sits | |
1869 over the location that the pointer points to. This is, for example, the | |
1870 tip of the arrow or the center of the crosshairs. | |
1871 This will always be nil for a non-pointer image instance. | |
1872 */ | |
1873 (image_instance)) | |
1874 { | |
1875 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1876 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1877 |
1878 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1879 { | |
1880 case IMAGE_MONO_PIXMAP: | |
1881 case IMAGE_COLOR_PIXMAP: | |
1882 case IMAGE_POINTER: | |
1883 return XIMAGE_INSTANCE_PIXMAP_HOTSPOT_X (image_instance); | |
1884 | |
1885 default: | |
1886 return Qnil; | |
1887 } | |
1888 } | |
1889 | |
1890 DEFUN ("image-instance-hotspot-y", Fimage_instance_hotspot_y, 1, 1, 0, /* | |
1891 Return the Y coordinate of the image instance's hotspot, if known. | |
1892 This is a point relative to the origin of the pixmap. When an image is | |
1893 used as a mouse pointer, the hotspot is the point on the image that sits | |
1894 over the location that the pointer points to. This is, for example, the | |
1895 tip of the arrow or the center of the crosshairs. | |
1896 This will always be nil for a non-pointer image instance. | |
1897 */ | |
1898 (image_instance)) | |
1899 { | |
1900 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1901 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1902 |
1903 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1904 { | |
1905 case IMAGE_MONO_PIXMAP: | |
1906 case IMAGE_COLOR_PIXMAP: | |
1907 case IMAGE_POINTER: | |
1908 return XIMAGE_INSTANCE_PIXMAP_HOTSPOT_Y (image_instance); | |
1909 | |
1910 default: | |
1911 return Qnil; | |
1912 } | |
1913 } | |
1914 | |
1915 DEFUN ("image-instance-foreground", Fimage_instance_foreground, 1, 1, 0, /* | |
1916 Return the foreground color of IMAGE-INSTANCE, if applicable. | |
1917 This will be a color instance or nil. (It will only be non-nil for | |
1918 colorized mono pixmaps and for pointers.) | |
1919 */ | |
1920 (image_instance)) | |
1921 { | |
1922 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1923 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1924 |
1925 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1926 { | |
1927 case IMAGE_MONO_PIXMAP: | |
1928 case IMAGE_COLOR_PIXMAP: | |
1929 case IMAGE_POINTER: | |
1930 return XIMAGE_INSTANCE_PIXMAP_FG (image_instance); | |
1931 | |
1932 case IMAGE_WIDGET: | |
1933 return FACE_FOREGROUND ( | |
1934 XIMAGE_INSTANCE_WIDGET_FACE (image_instance), | |
442 | 1935 XIMAGE_INSTANCE_FRAME |
428 | 1936 (image_instance)); |
1937 | |
1938 default: | |
1939 return Qnil; | |
1940 } | |
1941 } | |
1942 | |
1943 DEFUN ("image-instance-background", Fimage_instance_background, 1, 1, 0, /* | |
1944 Return the background color of IMAGE-INSTANCE, if applicable. | |
1945 This will be a color instance or nil. (It will only be non-nil for | |
1946 colorized mono pixmaps and for pointers.) | |
1947 */ | |
1948 (image_instance)) | |
1949 { | |
1950 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1951 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1952 |
1953 switch (XIMAGE_INSTANCE_TYPE (image_instance)) | |
1954 { | |
1955 case IMAGE_MONO_PIXMAP: | |
1956 case IMAGE_COLOR_PIXMAP: | |
1957 case IMAGE_POINTER: | |
1958 return XIMAGE_INSTANCE_PIXMAP_BG (image_instance); | |
1959 | |
1960 case IMAGE_WIDGET: | |
1961 return FACE_BACKGROUND ( | |
1962 XIMAGE_INSTANCE_WIDGET_FACE (image_instance), | |
442 | 1963 XIMAGE_INSTANCE_FRAME |
428 | 1964 (image_instance)); |
1965 | |
1966 default: | |
1967 return Qnil; | |
1968 } | |
1969 } | |
1970 | |
1971 | |
1972 DEFUN ("colorize-image-instance", Fcolorize_image_instance, 3, 3, 0, /* | |
1973 Make the image instance be displayed in the given colors. | |
1974 This function returns a new image instance that is exactly like the | |
1975 specified one except that (if possible) the foreground and background | |
1976 colors and as specified. Currently, this only does anything if the image | |
1977 instance is a mono pixmap; otherwise, the same image instance is returned. | |
1978 */ | |
1979 (image_instance, foreground, background)) | |
1980 { | |
2959 | 1981 Lisp_Object new_; |
428 | 1982 Lisp_Object device; |
1983 | |
1984 CHECK_IMAGE_INSTANCE (image_instance); | |
442 | 1985 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
428 | 1986 CHECK_COLOR_INSTANCE (foreground); |
1987 CHECK_COLOR_INSTANCE (background); | |
1988 | |
442 | 1989 device = image_instance_device (image_instance); |
428 | 1990 if (!HAS_DEVMETH_P (XDEVICE (device), colorize_image_instance)) |
1991 return image_instance; | |
1992 | |
430 | 1993 /* #### There should be a copy_image_instance(), which calls a |
1994 device-specific method to copy the window-system subobject. */ | |
2959 | 1995 new_ = allocate_image_instance (XIMAGE_INSTANCE_DOMAIN (image_instance), |
442 | 1996 Qnil, Qnil); |
3017 | 1997 COPY_LCRECORD (XIMAGE_INSTANCE (new_), XIMAGE_INSTANCE (image_instance)); |
428 | 1998 /* note that if this method returns non-zero, this method MUST |
1999 copy any window-system resources, so that when one image instance is | |
2000 freed, the other one is not hosed. */ | |
2959 | 2001 if (!DEVMETH (XDEVICE (device), colorize_image_instance, (new_, foreground, |
428 | 2002 background))) |
2003 return image_instance; | |
2959 | 2004 return new_; |
428 | 2005 } |
2006 | |
438 | 2007 |
2008 /************************************************************************/ | |
2009 /* Geometry calculations */ | |
2010 /************************************************************************/ | |
2011 | |
2012 /* Find out desired geometry of the image instance. If there is no | |
2013 special function then just return the width and / or height. */ | |
2014 void | |
440 | 2015 image_instance_query_geometry (Lisp_Object image_instance, |
442 | 2016 int* width, int* height, |
438 | 2017 enum image_instance_geometry disp, |
2018 Lisp_Object domain) | |
2019 { | |
440 | 2020 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (image_instance); |
438 | 2021 Lisp_Object type; |
2022 struct image_instantiator_methods* meths; | |
442 | 2023 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
438 | 2024 |
2025 type = encode_image_instance_type (IMAGE_INSTANCE_TYPE (ii)); | |
2026 meths = decode_device_ii_format (Qnil, type, ERROR_ME_NOT); | |
440 | 2027 |
438 | 2028 if (meths && HAS_IIFORMAT_METH_P (meths, query_geometry)) |
2029 { | |
440 | 2030 IIFORMAT_METH (meths, query_geometry, (image_instance, width, height, |
438 | 2031 disp, domain)); |
2032 } | |
2033 else | |
2034 { | |
2035 if (width) | |
2036 *width = IMAGE_INSTANCE_WIDTH (ii); | |
2037 if (height) | |
2038 *height = IMAGE_INSTANCE_HEIGHT (ii); | |
2039 } | |
2040 } | |
2041 | |
2042 /* Layout the image instance using the provided dimensions. Layout | |
2043 widgets are going to do different kinds of calculations to | |
2044 determine what size to give things so we could make the layout | |
2045 function relatively simple to take account of that. An alternative | |
2046 approach is to consider separately the two cases, one where you | |
2047 don't mind what size you have (normal widgets) and one where you | |
442 | 2048 want to specify something (layout widgets). */ |
438 | 2049 void |
440 | 2050 image_instance_layout (Lisp_Object image_instance, |
442 | 2051 int width, int height, |
2052 int xoffset, int yoffset, | |
438 | 2053 Lisp_Object domain) |
2054 { | |
440 | 2055 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (image_instance); |
438 | 2056 Lisp_Object type; |
2057 struct image_instantiator_methods* meths; | |
2058 | |
442 | 2059 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
2060 | |
2061 /* Nothing is as nothing does. */ | |
2062 if (NOTHING_IMAGE_INSTANCEP (image_instance)) | |
2063 return; | |
2064 | |
2065 /* We don't want carefully calculated offsets to be mucked up by | |
2066 random layouts. */ | |
2067 if (xoffset != IMAGE_UNCHANGED_GEOMETRY) | |
2068 XIMAGE_INSTANCE_XOFFSET (image_instance) = xoffset; | |
2069 if (yoffset != IMAGE_UNCHANGED_GEOMETRY) | |
2070 XIMAGE_INSTANCE_YOFFSET (image_instance) = yoffset; | |
2071 | |
2072 assert (XIMAGE_INSTANCE_YOFFSET (image_instance) >= 0 | |
2073 && XIMAGE_INSTANCE_XOFFSET (image_instance) >= 0); | |
2074 | |
438 | 2075 /* If geometry is unspecified then get some reasonable values for it. */ |
2076 if (width == IMAGE_UNSPECIFIED_GEOMETRY | |
2077 || | |
2078 height == IMAGE_UNSPECIFIED_GEOMETRY) | |
2079 { | |
442 | 2080 int dwidth = IMAGE_UNSPECIFIED_GEOMETRY; |
2081 int dheight = IMAGE_UNSPECIFIED_GEOMETRY; | |
438 | 2082 /* Get the desired geometry. */ |
450 | 2083 image_instance_query_geometry (image_instance, |
2084 &dwidth, &dheight, | |
2085 IMAGE_DESIRED_GEOMETRY, | |
2086 domain); | |
438 | 2087 /* Compare with allowed geometry. */ |
2088 if (width == IMAGE_UNSPECIFIED_GEOMETRY) | |
2089 width = dwidth; | |
2090 if (height == IMAGE_UNSPECIFIED_GEOMETRY) | |
2091 height = dheight; | |
2092 } | |
2093 | |
442 | 2094 /* If we don't have sane values then we cannot layout at this point and |
2095 must just return. */ | |
2096 if (width == IMAGE_UNSPECIFIED_GEOMETRY | |
2097 || | |
2098 height == IMAGE_UNSPECIFIED_GEOMETRY) | |
2099 return; | |
2100 | |
438 | 2101 /* At this point width and height should contain sane values. Thus |
2102 we set the glyph geometry and lay it out. */ | |
442 | 2103 if (IMAGE_INSTANCE_WIDTH (ii) != width |
2104 || | |
2105 IMAGE_INSTANCE_HEIGHT (ii) != height) | |
2106 { | |
2107 IMAGE_INSTANCE_SIZE_CHANGED (ii) = 1; | |
2108 } | |
2109 | |
438 | 2110 IMAGE_INSTANCE_WIDTH (ii) = width; |
2111 IMAGE_INSTANCE_HEIGHT (ii) = height; | |
440 | 2112 |
450 | 2113 type = encode_image_instance_type (IMAGE_INSTANCE_TYPE (ii)); |
2114 meths = decode_device_ii_format (Qnil, type, ERROR_ME_NOT); | |
2115 | |
2116 MAYBE_IIFORMAT_METH (meths, layout, | |
2117 (image_instance, width, height, xoffset, yoffset, | |
2118 domain)); | |
2119 /* Do not clear the dirty flag here - redisplay will do this for | |
2120 us at the end. */ | |
2121 IMAGE_INSTANCE_LAYOUT_CHANGED (ii) = 0; | |
442 | 2122 } |
2123 | |
2124 /* Update an image instance from its changed instantiator. */ | |
2125 static void | |
2126 update_image_instance (Lisp_Object image_instance, | |
2127 Lisp_Object instantiator) | |
2128 { | |
2129 struct image_instantiator_methods* meths; | |
2130 Lisp_Image_Instance *ii = XIMAGE_INSTANCE (image_instance); | |
2131 | |
2132 ERROR_CHECK_IMAGE_INSTANCE (image_instance); | |
2133 | |
2134 if (NOTHING_IMAGE_INSTANCEP (image_instance)) | |
2135 return; | |
2136 | |
2137 assert (!internal_equal (IMAGE_INSTANCE_INSTANTIATOR (ii), instantiator, 0) | |
2138 || (internal_equal (IMAGE_INSTANCE_INSTANTIATOR (ii), instantiator, 0) | |
2139 && internal_equal (IMAGE_INSTANCE_INSTANTIATOR (ii), instantiator, -10))); | |
2140 | |
2141 /* If the instantiator is identical then do nothing. We must use | |
2142 equal here because the specifier code copies the instantiator. */ | |
2143 if (!internal_equal (IMAGE_INSTANCE_INSTANTIATOR (ii), instantiator, 0)) | |
438 | 2144 { |
442 | 2145 /* Extract the changed properties so that device / format |
2146 methods only have to cope with these. We assume that | |
2147 normalization has already been done. */ | |
2148 Lisp_Object diffs = find_instantiator_differences | |
2149 (instantiator, | |
2150 IMAGE_INSTANCE_INSTANTIATOR (ii)); | |
2151 Lisp_Object type = encode_image_instance_type | |
2152 (IMAGE_INSTANCE_TYPE (ii)); | |
2153 struct gcpro gcpro1; | |
2154 GCPRO1 (diffs); | |
2155 | |
2156 /* try device specific methods first ... */ | |
2157 meths = decode_device_ii_format (image_instance_device (image_instance), | |
2158 type, ERROR_ME_NOT); | |
2159 MAYBE_IIFORMAT_METH (meths, update, (image_instance, diffs)); | |
2160 /* ... then format specific methods ... */ | |
2161 meths = decode_device_ii_format (Qnil, type, ERROR_ME_NOT); | |
2162 MAYBE_IIFORMAT_METH (meths, update, (image_instance, diffs)); | |
2163 | |
2164 /* Instance and therefore glyph has changed so mark as dirty. | |
2165 If we don't do this output optimizations will assume the | |
2166 glyph is unchanged. */ | |
2167 set_image_instance_dirty_p (image_instance, 1); | |
2168 /* Structure has changed. */ | |
2169 IMAGE_INSTANCE_LAYOUT_CHANGED (ii) = 1; | |
2170 | |
2171 UNGCPRO; | |
438 | 2172 } |
442 | 2173 /* We should now have a consistent instantiator so keep a record of |
2174 it. It is important that we don't actually update the window | |
2175 system widgets here - we must do that when redisplay tells us | |
2176 to. | |
2177 | |
2178 #### should we delay doing this until the display is up-to-date | |
2179 also? */ | |
2180 IMAGE_INSTANCE_INSTANTIATOR (ii) = instantiator; | |
440 | 2181 } |
2182 | |
2183 /* | |
2184 * Mark image instance in W as dirty if (a) W's faces have changed and | |
2185 * (b) GLYPH_OR_II instance in W is a string. | |
2186 * | |
2187 * Return non-zero if instance has been marked dirty. | |
2188 */ | |
2189 int | |
2190 invalidate_glyph_geometry_maybe (Lisp_Object glyph_or_ii, struct window* w) | |
2191 { | |
2192 if (XFRAME(WINDOW_FRAME(w))->faces_changed) | |
2193 { | |
2194 Lisp_Object image = glyph_or_ii; | |
2195 | |
2196 if (GLYPHP (glyph_or_ii)) | |
2197 { | |
793 | 2198 Lisp_Object window = wrap_window (w); |
2199 | |
2200 image = glyph_image_instance (glyph_or_ii, window, | |
2201 ERROR_ME_DEBUG_WARN, 1); | |
440 | 2202 } |
2203 | |
2204 if (TEXT_IMAGE_INSTANCEP (image)) | |
2205 { | |
442 | 2206 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (image); |
2207 IMAGE_INSTANCE_DIRTYP (ii) = 1; | |
2208 IMAGE_INSTANCE_LAYOUT_CHANGED (ii) = 1; | |
440 | 2209 if (GLYPHP (glyph_or_ii)) |
2210 XGLYPH_DIRTYP (glyph_or_ii) = 1; | |
2211 return 1; | |
2212 } | |
2213 } | |
2214 | |
2215 return 0; | |
438 | 2216 } |
2217 | |
428 | 2218 |
2219 /************************************************************************/ | |
2220 /* error helpers */ | |
2221 /************************************************************************/ | |
2222 DOESNT_RETURN | |
867 | 2223 signal_image_error (const CIbyte *reason, Lisp_Object frob) |
428 | 2224 { |
563 | 2225 signal_error (Qimage_conversion_error, reason, frob); |
428 | 2226 } |
2227 | |
2228 DOESNT_RETURN | |
867 | 2229 signal_image_error_2 (const CIbyte *reason, Lisp_Object frob0, Lisp_Object frob1) |
428 | 2230 { |
563 | 2231 signal_error_2 (Qimage_conversion_error, reason, frob0, frob1); |
2232 } | |
2233 | |
2234 DOESNT_RETURN | |
867 | 2235 signal_double_image_error (const CIbyte *string1, const CIbyte *string2, |
563 | 2236 Lisp_Object data) |
2237 { | |
2238 signal_error_1 (Qimage_conversion_error, | |
4252 | 2239 list3 (build_msg_string (string1), |
771 | 2240 build_msg_string (string2), |
563 | 2241 data)); |
2242 } | |
2243 | |
2244 DOESNT_RETURN | |
867 | 2245 signal_double_image_error_2 (const CIbyte *string1, const CIbyte *string2, |
563 | 2246 Lisp_Object data1, Lisp_Object data2) |
2247 { | |
2248 signal_error_1 (Qimage_conversion_error, | |
4252 | 2249 list4 (build_msg_string (string1), |
771 | 2250 build_msg_string (string2), |
563 | 2251 data1, data2)); |
428 | 2252 } |
2253 | |
2254 /**************************************************************************** | |
2255 * nothing * | |
2256 ****************************************************************************/ | |
2257 | |
2258 static int | |
2259 nothing_possible_dest_types (void) | |
2260 { | |
2261 return IMAGE_NOTHING_MASK; | |
2262 } | |
2263 | |
2264 static void | |
2265 nothing_instantiate (Lisp_Object image_instance, Lisp_Object instantiator, | |
2286 | 2266 Lisp_Object UNUSED (pointer_fg), |
2267 Lisp_Object UNUSED (pointer_bg), | |
2268 int dest_mask, Lisp_Object UNUSED (domain)) | |
428 | 2269 { |
440 | 2270 Lisp_Image_Instance *ii = XIMAGE_INSTANCE (image_instance); |
428 | 2271 |
2272 if (dest_mask & IMAGE_NOTHING_MASK) | |
442 | 2273 { |
2274 IMAGE_INSTANCE_TYPE (ii) = IMAGE_NOTHING; | |
2275 IMAGE_INSTANCE_HEIGHT (ii) = 0; | |
2276 IMAGE_INSTANCE_WIDTH (ii) = 0; | |
2277 } | |
428 | 2278 else |
2279 incompatible_image_types (instantiator, dest_mask, IMAGE_NOTHING_MASK); | |
2280 } | |
2281 | |
2282 | |
2283 /**************************************************************************** | |
2284 * inherit * | |
2285 ****************************************************************************/ | |
2286 | |
2287 static void | |
2288 inherit_validate (Lisp_Object instantiator) | |
2289 { | |
2290 face_must_be_present (instantiator); | |
2291 } | |
2292 | |
2293 static Lisp_Object | |
2286 | 2294 inherit_normalize (Lisp_Object inst, Lisp_Object UNUSED (console_type), |
2295 Lisp_Object UNUSED (dest_mask)) | |
428 | 2296 { |
2297 Lisp_Object face; | |
2298 | |
2299 assert (XVECTOR_LENGTH (inst) == 3); | |
2300 face = XVECTOR_DATA (inst)[2]; | |
2301 if (!FACEP (face)) | |
2302 inst = vector3 (Qinherit, Q_face, Fget_face (face)); | |
2303 return inst; | |
2304 } | |
2305 | |
2306 static int | |
2307 inherit_possible_dest_types (void) | |
2308 { | |
2309 return IMAGE_MONO_PIXMAP_MASK; | |
2310 } | |
2311 | |
2312 static void | |
2286 | 2313 inherit_instantiate (Lisp_Object UNUSED (image_instance), |
2314 Lisp_Object UNUSED (instantiator), | |
2315 Lisp_Object UNUSED (pointer_fg), | |
2316 Lisp_Object UNUSED (pointer_bg), | |
2317 int UNUSED (dest_mask), Lisp_Object UNUSED (domain)) | |
428 | 2318 { |
2319 /* handled specially in image_instantiate */ | |
2500 | 2320 ABORT (); |
428 | 2321 } |
2322 | |
2323 | |
2324 /**************************************************************************** | |
2325 * string * | |
2326 ****************************************************************************/ | |
2327 | |
2328 static void | |
2329 string_validate (Lisp_Object instantiator) | |
2330 { | |
2331 data_must_be_present (instantiator); | |
2332 } | |
2333 | |
2334 static int | |
2335 string_possible_dest_types (void) | |
2336 { | |
2337 return IMAGE_TEXT_MASK; | |
2338 } | |
2339 | |
438 | 2340 /* Called from autodetect_instantiate() */ |
428 | 2341 void |
2342 string_instantiate (Lisp_Object image_instance, Lisp_Object instantiator, | |
2286 | 2343 Lisp_Object UNUSED (pointer_fg), |
2344 Lisp_Object UNUSED (pointer_bg), | |
428 | 2345 int dest_mask, Lisp_Object domain) |
2346 { | |
434 | 2347 Lisp_Object string = find_keyword_in_vector (instantiator, Q_data); |
440 | 2348 Lisp_Image_Instance *ii = XIMAGE_INSTANCE (image_instance); |
2349 | |
1411 | 2350 assert (!NILP (string)); |
2351 | |
438 | 2352 /* Should never get here with a domain other than a window. */ |
1411 | 2353 #ifndef NDEBUG |
2354 /* Work Around for an Intel Compiler 7.0 internal error */ | |
2355 /* assert (WINDOWP (DOMAIN_WINDOW (domain))); internal error: 0_5086 */ | |
2356 { | |
2357 Lisp_Object w = DOMAIN_WINDOW (domain); | |
2358 assert (WINDOWP (w)); | |
2359 } | |
2360 #endif | |
2361 | |
428 | 2362 if (dest_mask & IMAGE_TEXT_MASK) |
2363 { | |
2364 IMAGE_INSTANCE_TYPE (ii) = IMAGE_TEXT; | |
434 | 2365 IMAGE_INSTANCE_TEXT_STRING (ii) = string; |
428 | 2366 } |
2367 else | |
2368 incompatible_image_types (instantiator, dest_mask, IMAGE_TEXT_MASK); | |
2369 } | |
2370 | |
438 | 2371 /* Sort out the size of the text that is being displayed. Calculating |
2372 it dynamically allows us to change the text and still see | |
2373 everything. Note that the following methods are for text not string | |
2374 since that is what the instantiated type is. The first method is a | |
2375 helper that is used elsewhere for calculating text geometry. */ | |
2376 void | |
2377 query_string_geometry (Lisp_Object string, Lisp_Object face, | |
442 | 2378 int* width, int* height, int* descent, Lisp_Object domain) |
438 | 2379 { |
2380 struct font_metric_info fm; | |
2381 unsigned char charsets[NUM_LEADING_BYTES]; | |
2382 struct face_cachel frame_cachel; | |
2383 struct face_cachel *cachel; | |
442 | 2384 Lisp_Object frame = DOMAIN_FRAME (domain); |
438 | 2385 |
903 | 2386 CHECK_STRING (string); |
2387 | |
438 | 2388 /* Compute height */ |
2389 if (height) | |
2390 { | |
2391 /* Compute string metric info */ | |
867 | 2392 find_charsets_in_ibyte_string (charsets, |
438 | 2393 XSTRING_DATA (string), |
2394 XSTRING_LENGTH (string)); | |
440 | 2395 |
438 | 2396 /* Fallback to the default face if none was provided. */ |
2397 if (!NILP (face)) | |
2398 { | |
2399 reset_face_cachel (&frame_cachel); | |
2400 update_face_cachel_data (&frame_cachel, frame, face); | |
2401 cachel = &frame_cachel; | |
2402 } | |
2403 else | |
2404 { | |
442 | 2405 cachel = WINDOW_FACE_CACHEL (DOMAIN_XWINDOW (domain), |
2406 DEFAULT_INDEX); | |
438 | 2407 } |
440 | 2408 |
438 | 2409 ensure_face_cachel_complete (cachel, domain, charsets); |
2410 face_cachel_charset_font_metric_info (cachel, charsets, &fm); | |
440 | 2411 |
438 | 2412 *height = fm.ascent + fm.descent; |
2413 /* #### descent only gets set if we query the height as well. */ | |
2414 if (descent) | |
2415 *descent = fm.descent; | |
2416 } | |
440 | 2417 |
438 | 2418 /* Compute width */ |
2419 if (width) | |
2420 { | |
2421 if (!NILP (face)) | |
2422 *width = redisplay_frame_text_width_string (XFRAME (frame), | |
2423 face, | |
2424 0, string, 0, -1); | |
2425 else | |
2426 *width = redisplay_frame_text_width_string (XFRAME (frame), | |
2427 Vdefault_face, | |
2428 0, string, 0, -1); | |
2429 } | |
2430 } | |
2431 | |
2432 Lisp_Object | |
2433 query_string_font (Lisp_Object string, Lisp_Object face, Lisp_Object domain) | |
2434 { | |
2435 unsigned char charsets[NUM_LEADING_BYTES]; | |
2436 struct face_cachel frame_cachel; | |
2437 struct face_cachel *cachel; | |
2438 int i; | |
442 | 2439 Lisp_Object frame = DOMAIN_FRAME (domain); |
438 | 2440 |
2441 /* Compute string font info */ | |
867 | 2442 find_charsets_in_ibyte_string (charsets, |
438 | 2443 XSTRING_DATA (string), |
2444 XSTRING_LENGTH (string)); | |
440 | 2445 |
438 | 2446 reset_face_cachel (&frame_cachel); |
2447 update_face_cachel_data (&frame_cachel, frame, face); | |
2448 cachel = &frame_cachel; | |
2449 | |
2450 ensure_face_cachel_complete (cachel, domain, charsets); | |
440 | 2451 |
438 | 2452 for (i = 0; i < NUM_LEADING_BYTES; i++) |
2453 { | |
2454 if (charsets[i]) | |
2455 { | |
440 | 2456 return FACE_CACHEL_FONT (cachel, |
826 | 2457 charset_by_leading_byte (i + |
438 | 2458 MIN_LEADING_BYTE)); |
2459 | |
440 | 2460 } |
438 | 2461 } |
2462 | |
2463 return Qnil; /* NOT REACHED */ | |
2464 } | |
2465 | |
2466 static void | |
2467 text_query_geometry (Lisp_Object image_instance, | |
442 | 2468 int* width, int* height, |
2286 | 2469 enum image_instance_geometry UNUSED (disp), |
2470 Lisp_Object domain) | |
438 | 2471 { |
440 | 2472 Lisp_Image_Instance *ii = XIMAGE_INSTANCE (image_instance); |
442 | 2473 int descent = 0; |
438 | 2474 |
2475 query_string_geometry (IMAGE_INSTANCE_TEXT_STRING (ii), | |
2476 IMAGE_INSTANCE_FACE (ii), | |
2477 width, height, &descent, domain); | |
2478 | |
2479 /* The descent gets set as a side effect of querying the | |
2480 geometry. */ | |
2481 IMAGE_INSTANCE_TEXT_DESCENT (ii) = descent; | |
2482 } | |
2483 | |
428 | 2484 /* set the properties of a string */ |
442 | 2485 static void |
2486 text_update (Lisp_Object image_instance, Lisp_Object instantiator) | |
2487 { | |
2488 Lisp_Object val = find_keyword_in_vector (instantiator, Q_data); | |
2489 | |
2490 if (!NILP (val)) | |
428 | 2491 { |
2492 CHECK_STRING (val); | |
442 | 2493 XIMAGE_INSTANCE_TEXT_STRING (image_instance) = val; |
428 | 2494 } |
2495 } | |
2496 | |
2497 | |
2498 /**************************************************************************** | |
2499 * formatted-string * | |
2500 ****************************************************************************/ | |
2501 | |
2502 static void | |
2503 formatted_string_validate (Lisp_Object instantiator) | |
2504 { | |
2505 data_must_be_present (instantiator); | |
2506 } | |
2507 | |
2508 static int | |
2509 formatted_string_possible_dest_types (void) | |
2510 { | |
2511 return IMAGE_TEXT_MASK; | |
2512 } | |
2513 | |
2514 static void | |
2515 formatted_string_instantiate (Lisp_Object image_instance, | |
2516 Lisp_Object instantiator, | |
2517 Lisp_Object pointer_fg, Lisp_Object pointer_bg, | |
2518 int dest_mask, Lisp_Object domain) | |
2519 { | |
2520 /* #### implement this */ | |
2521 warn_when_safe (Qunimplemented, Qnotice, | |
2522 "`formatted-string' not yet implemented; assuming `string'"); | |
438 | 2523 |
440 | 2524 string_instantiate (image_instance, instantiator, |
438 | 2525 pointer_fg, pointer_bg, dest_mask, domain); |
428 | 2526 } |
2527 | |
2528 | |
2529 /************************************************************************/ | |
2530 /* pixmap file functions */ | |
2531 /************************************************************************/ | |
2532 | |
4252 | 2533 /* If INSTANTIATOR refers to inline data, return Qt. |
428 | 2534 If INSTANTIATOR refers to data in a file, return the full filename |
4252 | 2535 if it exists, Qnil if there's no console method for locating the file, or |
2536 (filename) if there was an error locating the file. | |
428 | 2537 |
2538 FILE_KEYWORD and DATA_KEYWORD are symbols specifying the | |
2539 keywords used to look up the file and inline data, | |
2540 respectively, in the instantiator. Normally these would | |
2541 be Q_file and Q_data, but might be different for mask data. */ | |
2542 | |
2543 Lisp_Object | |
2544 potential_pixmap_file_instantiator (Lisp_Object instantiator, | |
2545 Lisp_Object file_keyword, | |
2546 Lisp_Object data_keyword, | |
2547 Lisp_Object console_type) | |
2548 { | |
2549 Lisp_Object file; | |
2550 Lisp_Object data; | |
2551 | |
2552 assert (VECTORP (instantiator)); | |
2553 | |
2554 data = find_keyword_in_vector (instantiator, data_keyword); | |
2555 file = find_keyword_in_vector (instantiator, file_keyword); | |
2556 | |
2557 if (!NILP (file) && NILP (data)) | |
2558 { | |
4226 | 2559 struct console_methods *meths |
4252 | 2560 = decode_console_type(console_type, ERROR_ME); |
4226 | 2561 |
2562 if (HAS_CONTYPE_METH_P (meths, locate_pixmap_file)) | |
4252 | 2563 { |
2564 Lisp_Object retval | |
2565 = CONTYPE_METH (meths, locate_pixmap_file, (file)); | |
2566 | |
2567 if (!NILP (retval)) | |
2568 return retval; | |
2569 else | |
2570 return Fcons (file, Qnil); /* should have been file */ | |
2571 } | |
2572 else /* method unavailable */ | |
2573 return Qnil; | |
428 | 2574 } |
2575 | |
4226 | 2576 return Qt; |
2577 } | |
2578 | |
428 | 2579 Lisp_Object |
2580 simple_image_type_normalize (Lisp_Object inst, Lisp_Object console_type, | |
2581 Lisp_Object image_type_tag) | |
2582 { | |
2583 /* This function can call lisp */ | |
2584 Lisp_Object file = Qnil; | |
2585 struct gcpro gcpro1, gcpro2; | |
2586 Lisp_Object alist = Qnil; | |
2587 | |
2588 GCPRO2 (file, alist); | |
2589 | |
2590 /* Now, convert any file data into inline data. At the end of this, | |
2591 `data' will contain the inline data (if any) or Qnil, and `file' | |
2592 will contain the name this data was derived from (if known) or | |
2593 Qnil. | |
2594 | |
2595 Note that if we cannot generate any regular inline data, we | |
2596 skip out. */ | |
2597 | |
2598 file = potential_pixmap_file_instantiator (inst, Q_file, Q_data, | |
2599 console_type); | |
2600 | |
4226 | 2601 if (NILP (file)) /* normalization impossible for the console type */ |
2602 RETURN_UNGCPRO (Qnil); | |
2603 | |
428 | 2604 if (CONSP (file)) /* failure locating filename */ |
563 | 2605 signal_double_image_error ("Opening pixmap file", |
2606 "no such file or directory", | |
2607 Fcar (file)); | |
428 | 2608 |
4226 | 2609 if (EQ (file, Qt)) /* no conversion necessary */ |
428 | 2610 RETURN_UNGCPRO (inst); |
2611 | |
2612 alist = tagged_vector_to_alist (inst); | |
2613 | |
2614 { | |
2615 Lisp_Object data = make_string_from_file (file); | |
2616 alist = remassq_no_quit (Q_file, alist); | |
2617 /* there can't be a :data at this point. */ | |
2618 alist = Fcons (Fcons (Q_file, file), | |
2619 Fcons (Fcons (Q_data, data), alist)); | |
2620 } | |
2621 | |
2622 { | |
2623 Lisp_Object result = alist_to_tagged_vector (image_type_tag, alist); | |
2624 free_alist (alist); | |
2625 RETURN_UNGCPRO (result); | |
2626 } | |
2627 } | |
2628 | |
2629 | |
2630 #ifdef HAVE_WINDOW_SYSTEM | |
2631 /********************************************************************** | |
2632 * XBM * | |
2633 **********************************************************************/ | |
2634 | |
2635 /* Check if DATA represents a valid inline XBM spec (i.e. a list | |
2636 of (width height bits), with checking done on the dimensions). | |
2637 If not, signal an error. */ | |
2638 | |
2639 static void | |
2640 check_valid_xbm_inline (Lisp_Object data) | |
2641 { | |
2642 Lisp_Object width, height, bits; | |
2643 | |
2644 if (!CONSP (data) || | |
2645 !CONSP (XCDR (data)) || | |
2646 !CONSP (XCDR (XCDR (data))) || | |
2647 !NILP (XCDR (XCDR (XCDR (data))))) | |
563 | 2648 sferror ("Must be list of 3 elements", data); |
428 | 2649 |
2650 width = XCAR (data); | |
2651 height = XCAR (XCDR (data)); | |
2652 bits = XCAR (XCDR (XCDR (data))); | |
2653 | |
2654 CHECK_STRING (bits); | |
2655 | |
2656 if (!NATNUMP (width)) | |
563 | 2657 invalid_argument ("Width must be a natural number", width); |
428 | 2658 |
2659 if (!NATNUMP (height)) | |
563 | 2660 invalid_argument ("Height must be a natural number", height); |
428 | 2661 |
826 | 2662 if (((XINT (width) * XINT (height)) / 8) > string_char_length (bits)) |
563 | 2663 invalid_argument ("data is too short for width and height", |
428 | 2664 vector3 (width, height, bits)); |
2665 } | |
2666 | |
2667 /* Validate method for XBM's. */ | |
2668 | |
2669 static void | |
2670 xbm_validate (Lisp_Object instantiator) | |
2671 { | |
2672 file_or_data_must_be_present (instantiator); | |
2673 } | |
2674 | |
2675 /* Given a filename that is supposed to contain XBM data, return | |
2676 the inline representation of it as (width height bits). Return | |
2677 the hotspot through XHOT and YHOT, if those pointers are not 0. | |
2678 If there is no hotspot, XHOT and YHOT will contain -1. | |
2679 | |
2680 If the function fails: | |
2681 | |
2682 -- if OK_IF_DATA_INVALID is set and the data was invalid, | |
2683 return Qt. | |
2684 -- maybe return an error, or return Qnil. | |
2685 */ | |
2686 | |
2687 #ifdef HAVE_X_WINDOWS | |
2688 #include <X11/Xlib.h> | |
2689 #else | |
2690 #define XFree(data) free(data) | |
2691 #endif | |
2692 | |
2693 Lisp_Object | |
2694 bitmap_to_lisp_data (Lisp_Object name, int *xhot, int *yhot, | |
2695 int ok_if_data_invalid) | |
2696 { | |
647 | 2697 int w, h; |
2367 | 2698 Binbyte *data; |
428 | 2699 int result; |
771 | 2700 |
2701 result = read_bitmap_data_from_file (name, &w, &h, &data, xhot, yhot); | |
428 | 2702 |
2703 if (result == BitmapSuccess) | |
2704 { | |
2705 Lisp_Object retval; | |
2706 int len = (w + 7) / 8 * h; | |
2707 | |
2708 retval = list3 (make_int (w), make_int (h), | |
771 | 2709 make_ext_string ((Extbyte *) data, len, Qbinary)); |
444 | 2710 XFree (data); |
428 | 2711 return retval; |
2712 } | |
2713 | |
2714 switch (result) | |
2715 { | |
2716 case BitmapOpenFailed: | |
2717 { | |
2718 /* should never happen */ | |
563 | 2719 signal_double_image_error ("Opening bitmap file", |
2720 "no such file or directory", | |
2721 name); | |
428 | 2722 } |
2723 case BitmapFileInvalid: | |
2724 { | |
2725 if (ok_if_data_invalid) | |
2726 return Qt; | |
563 | 2727 signal_double_image_error ("Reading bitmap file", |
2728 "invalid data in file", | |
2729 name); | |
428 | 2730 } |
2731 case BitmapNoMemory: | |
2732 { | |
563 | 2733 signal_double_image_error ("Reading bitmap file", |
2734 "out of memory", | |
2735 name); | |
428 | 2736 } |
2737 default: | |
2738 { | |
563 | 2739 signal_double_image_error_2 ("Reading bitmap file", |
2740 "unknown error code", | |
2741 make_int (result), name); | |
428 | 2742 } |
2743 } | |
2744 | |
2745 return Qnil; /* not reached */ | |
2746 } | |
2747 | |
2748 Lisp_Object | |
2749 xbm_mask_file_munging (Lisp_Object alist, Lisp_Object file, | |
2750 Lisp_Object mask_file, Lisp_Object console_type) | |
2751 { | |
2752 /* This is unclean but it's fairly standard -- a number of the | |
2753 bitmaps in /usr/include/X11/bitmaps use it -- so we support | |
2754 it. */ | |
4252 | 2755 if (EQ (mask_file, Qt) |
428 | 2756 /* don't override explicitly specified mask data. */ |
2757 && NILP (assq_no_quit (Q_mask_data, alist)) | |
4252 | 2758 && !EQ (file, Qt)) |
428 | 2759 { |
2760 mask_file = MAYBE_LISP_CONTYPE_METH | |
2761 (decode_console_type(console_type, ERROR_ME), | |
2762 locate_pixmap_file, (concat2 (file, build_string ("Mask")))); | |
2763 if (NILP (mask_file)) | |
2764 mask_file = MAYBE_LISP_CONTYPE_METH | |
2765 (decode_console_type(console_type, ERROR_ME), | |
2766 locate_pixmap_file, (concat2 (file, build_string ("msk")))); | |
2767 } | |
2768 | |
2769 if (!NILP (mask_file)) | |
2770 { | |
2771 Lisp_Object mask_data = | |
2772 bitmap_to_lisp_data (mask_file, 0, 0, 0); | |
2773 alist = remassq_no_quit (Q_mask_file, alist); | |
2774 /* there can't be a :mask-data at this point. */ | |
2775 alist = Fcons (Fcons (Q_mask_file, mask_file), | |
2776 Fcons (Fcons (Q_mask_data, mask_data), alist)); | |
2777 } | |
2778 | |
2779 return alist; | |
2780 } | |
2781 | |
2782 /* Normalize method for XBM's. */ | |
2783 | |
2784 static Lisp_Object | |
442 | 2785 xbm_normalize (Lisp_Object inst, Lisp_Object console_type, |
2286 | 2786 Lisp_Object UNUSED (dest_mask)) |
428 | 2787 { |
2788 Lisp_Object file = Qnil, mask_file = Qnil; | |
2789 struct gcpro gcpro1, gcpro2, gcpro3; | |
2790 Lisp_Object alist = Qnil; | |
2791 | |
2792 GCPRO3 (file, mask_file, alist); | |
2793 | |
2794 /* Now, convert any file data into inline data for both the regular | |
2795 data and the mask data. At the end of this, `data' will contain | |
2796 the inline data (if any) or Qnil, and `file' will contain | |
2797 the name this data was derived from (if known) or Qnil. | |
2798 Likewise for `mask_file' and `mask_data'. | |
2799 | |
2800 Note that if we cannot generate any regular inline data, we | |
2801 skip out. */ | |
2802 | |
2803 file = potential_pixmap_file_instantiator (inst, Q_file, Q_data, | |
2804 console_type); | |
2805 mask_file = potential_pixmap_file_instantiator (inst, Q_mask_file, | |
2806 Q_mask_data, console_type); | |
2807 | |
4226 | 2808 if (NILP (file)) /* normalization impossible for the console type */ |
2809 RETURN_UNGCPRO (Qnil); | |
2810 | |
428 | 2811 if (CONSP (file)) /* failure locating filename */ |
563 | 2812 signal_double_image_error ("Opening bitmap file", |
2813 "no such file or directory", | |
2814 Fcar (file)); | |
428 | 2815 |
4226 | 2816 if (EQ (file, Qt) && EQ (mask_file, Qt)) /* no conversion necessary */ |
428 | 2817 RETURN_UNGCPRO (inst); |
2818 | |
2819 alist = tagged_vector_to_alist (inst); | |
2820 | |
4226 | 2821 if (!EQ (file, Qt)) |
428 | 2822 { |
2823 int xhot, yhot; | |
2824 Lisp_Object data = bitmap_to_lisp_data (file, &xhot, &yhot, 0); | |
2825 alist = remassq_no_quit (Q_file, alist); | |
2826 /* there can't be a :data at this point. */ | |
2827 alist = Fcons (Fcons (Q_file, file), | |
2828 Fcons (Fcons (Q_data, data), alist)); | |
2829 | |
2830 if (xhot != -1 && NILP (assq_no_quit (Q_hotspot_x, alist))) | |
2831 alist = Fcons (Fcons (Q_hotspot_x, make_int (xhot)), | |
2832 alist); | |
2833 if (yhot != -1 && NILP (assq_no_quit (Q_hotspot_y, alist))) | |
2834 alist = Fcons (Fcons (Q_hotspot_y, make_int (yhot)), | |
2835 alist); | |
2836 } | |
2837 | |
2838 alist = xbm_mask_file_munging (alist, file, mask_file, console_type); | |
2839 | |
2840 { | |
2841 Lisp_Object result = alist_to_tagged_vector (Qxbm, alist); | |
2842 free_alist (alist); | |
2843 RETURN_UNGCPRO (result); | |
2844 } | |
2845 } | |
2846 | |
2847 | |
2848 static int | |
2849 xbm_possible_dest_types (void) | |
2850 { | |
2851 return | |
2852 IMAGE_MONO_PIXMAP_MASK | | |
2853 IMAGE_COLOR_PIXMAP_MASK | | |
2854 IMAGE_POINTER_MASK; | |
2855 } | |
2856 | |
2857 #endif | |
2858 | |
2859 | |
2860 #ifdef HAVE_XFACE | |
2861 /********************************************************************** | |
2862 * X-Face * | |
2863 **********************************************************************/ | |
2864 | |
2865 static void | |
2866 xface_validate (Lisp_Object instantiator) | |
2867 { | |
2868 file_or_data_must_be_present (instantiator); | |
2869 } | |
2870 | |
2871 static Lisp_Object | |
442 | 2872 xface_normalize (Lisp_Object inst, Lisp_Object console_type, |
2286 | 2873 Lisp_Object UNUSED (dest_mask)) |
428 | 2874 { |
2875 /* This function can call lisp */ | |
2876 Lisp_Object file = Qnil, mask_file = Qnil; | |
2877 struct gcpro gcpro1, gcpro2, gcpro3; | |
2878 Lisp_Object alist = Qnil; | |
2879 | |
2880 GCPRO3 (file, mask_file, alist); | |
2881 | |
2882 /* Now, convert any file data into inline data for both the regular | |
2883 data and the mask data. At the end of this, `data' will contain | |
2884 the inline data (if any) or Qnil, and `file' will contain | |
2885 the name this data was derived from (if known) or Qnil. | |
2886 Likewise for `mask_file' and `mask_data'. | |
2887 | |
2888 Note that if we cannot generate any regular inline data, we | |
2889 skip out. */ | |
2890 | |
2891 file = potential_pixmap_file_instantiator (inst, Q_file, Q_data, | |
2892 console_type); | |
2893 mask_file = potential_pixmap_file_instantiator (inst, Q_mask_file, | |
2894 Q_mask_data, console_type); | |
2895 | |
4226 | 2896 if (NILP (file)) /* normalization impossible for the console type */ |
2897 RETURN_UNGCPRO (Qnil); | |
2898 | |
428 | 2899 if (CONSP (file)) /* failure locating filename */ |
563 | 2900 signal_double_image_error ("Opening bitmap file", |
2901 "no such file or directory", | |
2902 Fcar (file)); | |
428 | 2903 |
4226 | 2904 if (EQ (file, Qt) && EQ (mask_file, Qt)) /* no conversion necessary */ |
428 | 2905 RETURN_UNGCPRO (inst); |
2906 | |
2907 alist = tagged_vector_to_alist (inst); | |
2908 | |
2909 { | |
4252 | 2910 /* #### FIXME: what if EQ (file, Qt) && !EQ (mask, Qt) ? Is that possible? |
2911 If so, we have a problem... -- dvl */ | |
428 | 2912 Lisp_Object data = make_string_from_file (file); |
2913 alist = remassq_no_quit (Q_file, alist); | |
2914 /* there can't be a :data at this point. */ | |
2915 alist = Fcons (Fcons (Q_file, file), | |
2916 Fcons (Fcons (Q_data, data), alist)); | |
2917 } | |
2918 | |
2919 alist = xbm_mask_file_munging (alist, file, mask_file, console_type); | |
2920 | |
2921 { | |
2922 Lisp_Object result = alist_to_tagged_vector (Qxface, alist); | |
2923 free_alist (alist); | |
2924 RETURN_UNGCPRO (result); | |
2925 } | |
2926 } | |
2927 | |
2928 static int | |
2929 xface_possible_dest_types (void) | |
2930 { | |
2931 return | |
2932 IMAGE_MONO_PIXMAP_MASK | | |
2933 IMAGE_COLOR_PIXMAP_MASK | | |
2934 IMAGE_POINTER_MASK; | |
2935 } | |
2936 | |
2937 #endif /* HAVE_XFACE */ | |
2938 | |
2939 | |
2940 #ifdef HAVE_XPM | |
2941 | |
2942 /********************************************************************** | |
2943 * XPM * | |
2944 **********************************************************************/ | |
2945 | |
462 | 2946 #ifdef HAVE_GTK |
2947 /* Gtk has to be gratuitously different, eh? */ | |
2948 Lisp_Object | |
2949 pixmap_to_lisp_data (Lisp_Object name, int ok_if_data_invalid) | |
2950 { | |
2951 return (make_string_from_file (name)); | |
2952 } | |
2953 #else | |
428 | 2954 Lisp_Object |
2955 pixmap_to_lisp_data (Lisp_Object name, int ok_if_data_invalid) | |
2956 { | |
2526 | 2957 Ascbyte **data; |
428 | 2958 int result; |
2526 | 2959 Extbyte *fname = 0; |
2960 Ibyte *resolved; | |
2961 | |
2962 LISP_PATHNAME_RESOLVE_LINKS (name, resolved); | |
2963 C_STRING_TO_EXTERNAL (resolved, fname, Qfile_name); | |
428 | 2964 result = XpmReadFileToData (fname, &data); |
2965 | |
2966 if (result == XpmSuccess) | |
2967 { | |
2968 Lisp_Object retval = Qnil; | |
2969 struct buffer *old_buffer = current_buffer; | |
2970 Lisp_Object temp_buffer = | |
2971 Fget_buffer_create (build_string (" *pixmap conversion*")); | |
2972 int elt; | |
2973 int height, width, ncolors; | |
2974 struct gcpro gcpro1, gcpro2, gcpro3; | |
2975 int speccount = specpdl_depth (); | |
2976 | |
2977 GCPRO3 (name, retval, temp_buffer); | |
2978 | |
2979 specbind (Qinhibit_quit, Qt); | |
2980 set_buffer_internal (XBUFFER (temp_buffer)); | |
2981 Ferase_buffer (Qnil); | |
2982 | |
2983 buffer_insert_c_string (current_buffer, "/* XPM */\r"); | |
2984 buffer_insert_c_string (current_buffer, "static char *pixmap[] = {\r"); | |
2985 | |
2986 sscanf (data[0], "%d %d %d", &height, &width, &ncolors); | |
2987 for (elt = 0; elt <= width + ncolors; elt++) | |
2988 { | |
2989 buffer_insert_c_string (current_buffer, "\""); | |
2990 buffer_insert_c_string (current_buffer, data[elt]); | |
2991 | |
2992 if (elt < width + ncolors) | |
2993 buffer_insert_c_string (current_buffer, "\",\r"); | |
2994 else | |
2995 buffer_insert_c_string (current_buffer, "\"};\r"); | |
2996 } | |
2997 | |
2998 retval = Fbuffer_substring (Qnil, Qnil, Qnil); | |
2999 XpmFree (data); | |
3000 | |
3001 set_buffer_internal (old_buffer); | |
771 | 3002 unbind_to (speccount); |
428 | 3003 |
3004 RETURN_UNGCPRO (retval); | |
3005 } | |
3006 | |
3007 switch (result) | |
3008 { | |
3009 case XpmFileInvalid: | |
3010 { | |
3011 if (ok_if_data_invalid) | |
3012 return Qt; | |
3013 signal_image_error ("invalid XPM data in file", name); | |
3014 } | |
3015 case XpmNoMemory: | |
3016 { | |
563 | 3017 signal_double_image_error ("Reading pixmap file", |
3018 "out of memory", name); | |
428 | 3019 } |
3020 case XpmOpenFailed: | |
3021 { | |
3022 /* should never happen? */ | |
563 | 3023 signal_double_image_error ("Opening pixmap file", |
3024 "no such file or directory", name); | |
428 | 3025 } |
3026 default: | |
3027 { | |
563 | 3028 signal_double_image_error_2 ("Parsing pixmap file", |
3029 "unknown error code", | |
3030 make_int (result), name); | |
428 | 3031 break; |
3032 } | |
3033 } | |
3034 | |
3035 return Qnil; /* not reached */ | |
3036 } | |
462 | 3037 #endif /* !HAVE_GTK */ |
428 | 3038 |
3039 static void | |
3040 check_valid_xpm_color_symbols (Lisp_Object data) | |
3041 { | |
3042 Lisp_Object rest; | |
3043 | |
3044 for (rest = data; !NILP (rest); rest = XCDR (rest)) | |
3045 { | |
3046 if (!CONSP (rest) || | |
3047 !CONSP (XCAR (rest)) || | |
3048 !STRINGP (XCAR (XCAR (rest))) || | |
3049 (!STRINGP (XCDR (XCAR (rest))) && | |
3050 !COLOR_SPECIFIERP (XCDR (XCAR (rest))))) | |
563 | 3051 sferror ("Invalid color symbol alist", data); |
428 | 3052 } |
3053 } | |
3054 | |
3055 static void | |
3056 xpm_validate (Lisp_Object instantiator) | |
3057 { | |
3058 file_or_data_must_be_present (instantiator); | |
3059 } | |
3060 | |
3061 Lisp_Object Vxpm_color_symbols; | |
3062 | |
3063 Lisp_Object | |
3064 evaluate_xpm_color_symbols (void) | |
3065 { | |
3066 Lisp_Object rest, results = Qnil; | |
3067 struct gcpro gcpro1, gcpro2; | |
3068 | |
3069 GCPRO2 (rest, results); | |
3070 for (rest = Vxpm_color_symbols; !NILP (rest); rest = XCDR (rest)) | |
3071 { | |
3072 Lisp_Object name, value, cons; | |
3073 | |
3074 CHECK_CONS (rest); | |
3075 cons = XCAR (rest); | |
3076 CHECK_CONS (cons); | |
3077 name = XCAR (cons); | |
3078 CHECK_STRING (name); | |
3079 value = XCDR (cons); | |
3080 CHECK_CONS (value); | |
3081 value = XCAR (value); | |
3082 value = Feval (value); | |
3083 if (NILP (value)) | |
3084 continue; | |
3085 if (!STRINGP (value) && !COLOR_SPECIFIERP (value)) | |
563 | 3086 invalid_argument |
428 | 3087 ("Result from xpm-color-symbols eval must be nil, string, or color", |
3088 value); | |
3089 results = Fcons (Fcons (name, value), results); | |
3090 } | |
3091 UNGCPRO; /* no more evaluation */ | |
3092 return results; | |
3093 } | |
3094 | |
3095 static Lisp_Object | |
442 | 3096 xpm_normalize (Lisp_Object inst, Lisp_Object console_type, |
2286 | 3097 Lisp_Object UNUSED (dest_mask)) |
428 | 3098 { |
3099 Lisp_Object file = Qnil; | |
3100 Lisp_Object color_symbols; | |
3101 struct gcpro gcpro1, gcpro2; | |
3102 Lisp_Object alist = Qnil; | |
3103 | |
3104 GCPRO2 (file, alist); | |
3105 | |
3106 /* Now, convert any file data into inline data. At the end of this, | |
3107 `data' will contain the inline data (if any) or Qnil, and | |
3108 `file' will contain the name this data was derived from (if | |
3109 known) or Qnil. | |
3110 | |
3111 Note that if we cannot generate any regular inline data, we | |
3112 skip out. */ | |
3113 | |
3114 file = potential_pixmap_file_instantiator (inst, Q_file, Q_data, | |
3115 console_type); | |
3116 | |
4226 | 3117 if (NILP (file)) /* normalization impossible for the console type */ |
3118 RETURN_UNGCPRO (Qnil); | |
3119 | |
428 | 3120 if (CONSP (file)) /* failure locating filename */ |
563 | 3121 signal_double_image_error ("Opening pixmap file", |
3122 "no such file or directory", | |
3123 Fcar (file)); | |
428 | 3124 |
3125 color_symbols = find_keyword_in_vector_or_given (inst, Q_color_symbols, | |
3126 Qunbound); | |
3127 | |
4226 | 3128 if (EQ (file, Qt) && !UNBOUNDP (color_symbols)) |
428 | 3129 /* no conversion necessary */ |
3130 RETURN_UNGCPRO (inst); | |
3131 | |
3132 alist = tagged_vector_to_alist (inst); | |
3133 | |
4226 | 3134 if (!NILP (file) && !EQ (file, Qt)) |
428 | 3135 { |
3136 Lisp_Object data = pixmap_to_lisp_data (file, 0); | |
3137 alist = remassq_no_quit (Q_file, alist); | |
3138 /* there can't be a :data at this point. */ | |
3139 alist = Fcons (Fcons (Q_file, file), | |
3140 Fcons (Fcons (Q_data, data), alist)); | |
3141 } | |
3142 | |
3143 if (UNBOUNDP (color_symbols)) | |
3144 { | |
3145 color_symbols = evaluate_xpm_color_symbols (); | |
3146 alist = Fcons (Fcons (Q_color_symbols, color_symbols), | |
3147 alist); | |
3148 } | |
3149 | |
3150 { | |
3151 Lisp_Object result = alist_to_tagged_vector (Qxpm, alist); | |
3152 free_alist (alist); | |
3153 RETURN_UNGCPRO (result); | |
3154 } | |
3155 } | |
3156 | |
3157 static int | |
3158 xpm_possible_dest_types (void) | |
3159 { | |
3160 return | |
3161 IMAGE_MONO_PIXMAP_MASK | | |
3162 IMAGE_COLOR_PIXMAP_MASK | | |
3163 IMAGE_POINTER_MASK; | |
3164 } | |
3165 | |
3166 #endif /* HAVE_XPM */ | |
3167 | |
3168 | |
3169 /**************************************************************************** | |
3170 * Image Specifier Object * | |
3171 ****************************************************************************/ | |
3172 | |
1204 | 3173 static const struct memory_description image_specifier_description[] = { |
3174 { XD_LISP_OBJECT, offsetof (struct image_specifier, attachee) }, | |
3175 { XD_LISP_OBJECT, offsetof (struct image_specifier, attachee_property) }, | |
3176 { XD_END } | |
3177 }; | |
3178 | |
3179 DEFINE_SPECIFIER_TYPE_WITH_DATA (image); | |
428 | 3180 |
3181 static void | |
3182 image_create (Lisp_Object obj) | |
3183 { | |
440 | 3184 Lisp_Specifier *image = XIMAGE_SPECIFIER (obj); |
428 | 3185 |
3186 IMAGE_SPECIFIER_ALLOWED (image) = ~0; /* all are allowed */ | |
3187 IMAGE_SPECIFIER_ATTACHEE (image) = Qnil; | |
3188 IMAGE_SPECIFIER_ATTACHEE_PROPERTY (image) = Qnil; | |
3189 } | |
3190 | |
3191 static void | |
3192 image_mark (Lisp_Object obj) | |
3193 { | |
440 | 3194 Lisp_Specifier *image = XIMAGE_SPECIFIER (obj); |
428 | 3195 |
3196 mark_object (IMAGE_SPECIFIER_ATTACHEE (image)); | |
3197 mark_object (IMAGE_SPECIFIER_ATTACHEE_PROPERTY (image)); | |
3198 } | |
3199 | |
450 | 3200 static int |
3201 instantiator_eq_equal (Lisp_Object obj1, Lisp_Object obj2) | |
3202 { | |
3203 if (EQ (obj1, obj2)) | |
3204 return 1; | |
3205 | |
3206 else if (CONSP (obj1) && CONSP (obj2)) | |
3207 { | |
3208 return instantiator_eq_equal (XCAR (obj1), XCAR (obj2)) | |
3209 && | |
3210 instantiator_eq_equal (XCDR (obj1), XCDR (obj2)); | |
3211 } | |
3212 return 0; | |
3213 } | |
3214 | |
665 | 3215 static Hashcode |
450 | 3216 instantiator_eq_hash (Lisp_Object obj) |
3217 { | |
3218 if (CONSP (obj)) | |
3219 { | |
3220 /* no point in worrying about tail recursion, since we're not | |
3221 going very deep */ | |
3222 return HASH2 (instantiator_eq_hash (XCAR (obj)), | |
3223 instantiator_eq_hash (XCDR (obj))); | |
3224 } | |
3225 return LISP_HASH (obj); | |
3226 } | |
3227 | |
3228 /* We need a special hash table for storing image instances. */ | |
3229 Lisp_Object | |
3230 make_image_instance_cache_hash_table (void) | |
3231 { | |
3232 return make_general_lisp_hash_table | |
3233 (instantiator_eq_hash, instantiator_eq_equal, | |
3234 30, -1.0, -1.0, | |
3235 HASH_TABLE_KEY_CAR_VALUE_WEAK); | |
3236 } | |
3237 | |
428 | 3238 static Lisp_Object |
3239 image_instantiate_cache_result (Lisp_Object locative) | |
3240 { | |
442 | 3241 /* locative = (instance instantiator . subtable) |
3242 | |
3243 So we are using the instantiator as the key and the instance as | |
3244 the value. Since the hashtable is key-weak this means that the | |
3245 image instance will stay around as long as the instantiator stays | |
3246 around. The instantiator is stored in the `image' slot of the | |
3247 glyph, so as long as the glyph is marked the instantiator will be | |
3248 as well and hence the cached image instance also.*/ | |
428 | 3249 Fputhash (XCAR (XCDR (locative)), XCAR (locative), XCDR (XCDR (locative))); |
853 | 3250 free_cons (XCDR (locative)); |
3251 free_cons (locative); | |
428 | 3252 return Qnil; |
3253 } | |
3254 | |
3255 /* Given a specification for an image, return an instance of | |
3256 the image which matches the given instantiator and which can be | |
3257 displayed in the given domain. */ | |
3258 | |
3259 static Lisp_Object | |
2286 | 3260 image_instantiate (Lisp_Object specifier, Lisp_Object UNUSED (matchspec), |
428 | 3261 Lisp_Object domain, Lisp_Object instantiator, |
4426
515b91f904c1
Fix specifier inheritance behavior
Didier Verna <didier@xemacs.org>
parents:
4252
diff
changeset
|
3262 Lisp_Object depth, int no_fallback) |
428 | 3263 { |
438 | 3264 Lisp_Object glyph = IMAGE_SPECIFIER_ATTACHEE (XIMAGE_SPECIFIER (specifier)); |
428 | 3265 int dest_mask = XIMAGE_SPECIFIER_ALLOWED (specifier); |
3266 int pointerp = dest_mask & image_instance_type_to_mask (IMAGE_POINTER); | |
3267 | |
3268 if (IMAGE_INSTANCEP (instantiator)) | |
3269 { | |
442 | 3270 /* make sure that the image instance's governing domain and type are |
428 | 3271 matching. */ |
442 | 3272 Lisp_Object governing_domain = XIMAGE_INSTANCE_DOMAIN (instantiator); |
3273 | |
3274 if ((DEVICEP (governing_domain) | |
3275 && EQ (governing_domain, DOMAIN_DEVICE (domain))) | |
3276 || (FRAMEP (governing_domain) | |
3277 && EQ (governing_domain, DOMAIN_FRAME (domain))) | |
3278 || (WINDOWP (governing_domain) | |
3279 && EQ (governing_domain, DOMAIN_WINDOW (domain)))) | |
428 | 3280 { |
3281 int mask = | |
3282 image_instance_type_to_mask (XIMAGE_INSTANCE_TYPE (instantiator)); | |
3283 if (mask & dest_mask) | |
3284 return instantiator; | |
3285 else | |
563 | 3286 invalid_argument ("Type of image instance not allowed here", |
428 | 3287 instantiator); |
3288 } | |
3289 else | |
563 | 3290 invalid_argument_2 ("Wrong domain for image instance", |
442 | 3291 instantiator, domain); |
428 | 3292 } |
452 | 3293 /* How ugly !! An image instanciator that uses a kludgy syntax to snarf in |
3294 face properties. There's a design flaw here. -- didier */ | |
428 | 3295 else if (VECTORP (instantiator) |
450 | 3296 && EQ (INSTANTIATOR_TYPE (instantiator), Qinherit)) |
428 | 3297 { |
3298 assert (XVECTOR_LENGTH (instantiator) == 3); | |
3299 return (FACE_PROPERTY_INSTANCE | |
3300 (Fget_face (XVECTOR_DATA (instantiator)[2]), | |
4426
515b91f904c1
Fix specifier inheritance behavior
Didier Verna <didier@xemacs.org>
parents:
4252
diff
changeset
|
3301 Qbackground_pixmap, domain, no_fallback, depth)); |
428 | 3302 } |
3303 else | |
3304 { | |
442 | 3305 Lisp_Object instance = Qnil; |
3306 Lisp_Object subtable = Qnil; | |
450 | 3307 /* #### Should this be GCPRO'd? */ |
3308 Lisp_Object hash_key = Qnil; | |
428 | 3309 Lisp_Object pointer_fg = Qnil; |
3310 Lisp_Object pointer_bg = Qnil; | |
442 | 3311 Lisp_Object governing_domain = |
3312 get_image_instantiator_governing_domain (instantiator, domain); | |
3313 struct gcpro gcpro1; | |
3314 | |
3315 GCPRO1 (instance); | |
3316 | |
3317 /* We have to put subwindow, widget and text image instances in | |
3318 a per-window cache so that we can see the same glyph in | |
3319 different windows. We use governing_domain to determine the type | |
3320 of image_instance that will be created. */ | |
428 | 3321 |
3322 if (pointerp) | |
3323 { | |
3324 pointer_fg = FACE_FOREGROUND (Vpointer_face, domain); | |
3325 pointer_bg = FACE_BACKGROUND (Vpointer_face, domain); | |
452 | 3326 hash_key = list4 (glyph, INSTANTIATOR_TYPE (instantiator), |
450 | 3327 pointer_fg, pointer_bg); |
428 | 3328 } |
450 | 3329 else |
3330 /* We cannot simply key on the glyph since fallbacks could use | |
3331 the same glyph but have a totally different instantiator | |
3332 type. Thus we key on the glyph and the type (but not any | |
3333 other parts of the instantiator. */ | |
3334 hash_key = list2 (glyph, INSTANTIATOR_TYPE (instantiator)); | |
428 | 3335 |
442 | 3336 /* First look in the device cache. */ |
3337 if (DEVICEP (governing_domain)) | |
428 | 3338 { |
442 | 3339 subtable = Fgethash (make_int (dest_mask), |
3340 XDEVICE (governing_domain)-> | |
3341 image_instance_cache, | |
3342 Qunbound); | |
3343 if (UNBOUNDP (subtable)) | |
3344 { | |
3345 /* For the image instance cache, we do comparisons with | |
3346 EQ rather than with EQUAL, as we do for color and | |
3347 font names. The reasons are: | |
3348 | |
3349 1) pixmap data can be very long, and thus the hashing | |
3350 and comparing will take awhile. | |
3351 | |
3352 2) It's not so likely that we'll run into things that | |
3353 are EQUAL but not EQ (that can happen a lot with | |
3354 faces, because their specifiers are copied around); | |
3355 but pixmaps tend not to be in faces. | |
3356 | |
3357 However, if the image-instance could be a pointer, we | |
3358 have to use EQUAL because we massaged the | |
3359 instantiator into a cons3 also containing the | |
3360 foreground and background of the pointer face. */ | |
450 | 3361 subtable = make_image_instance_cache_hash_table (); |
3362 | |
442 | 3363 Fputhash (make_int (dest_mask), subtable, |
3364 XDEVICE (governing_domain)->image_instance_cache); | |
3365 instance = Qunbound; | |
3366 } | |
3367 else | |
3368 { | |
450 | 3369 instance = Fgethash (hash_key, subtable, Qunbound); |
442 | 3370 } |
3371 } | |
3372 else if (WINDOWP (governing_domain)) | |
3373 { | |
3374 /* Subwindows have a per-window cache and have to be treated | |
3375 differently. */ | |
3376 instance = | |
450 | 3377 Fgethash (hash_key, |
442 | 3378 XWINDOW (governing_domain)->subwindow_instance_cache, |
3379 Qunbound); | |
428 | 3380 } |
3381 else | |
2500 | 3382 ABORT (); /* We're not allowed anything else currently. */ |
442 | 3383 |
3384 /* If we don't have an instance at this point then create | |
4252 | 3385 one. */ |
428 | 3386 if (UNBOUNDP (instance)) |
3387 { | |
3388 Lisp_Object locative = | |
3389 noseeum_cons (Qnil, | |
450 | 3390 noseeum_cons (hash_key, |
442 | 3391 DEVICEP (governing_domain) ? subtable |
3392 : XWINDOW (governing_domain) | |
3393 ->subwindow_instance_cache)); | |
428 | 3394 int speccount = specpdl_depth (); |
440 | 3395 |
442 | 3396 /* Make sure we cache the failures, too. Use an |
3397 unwind-protect to catch such errors. If we fail, the | |
3398 unwind-protect records nil in the hash table. If we | |
3399 succeed, we change the car of the locative to the | |
3400 resulting instance, which gets recorded instead. */ | |
428 | 3401 record_unwind_protect (image_instantiate_cache_result, |
3402 locative); | |
442 | 3403 instance = |
3404 instantiate_image_instantiator (governing_domain, | |
3405 domain, instantiator, | |
3406 pointer_fg, pointer_bg, | |
3407 dest_mask, glyph); | |
3408 | |
3409 /* We need a per-frame cache for redisplay. */ | |
3410 cache_subwindow_instance_in_frame_maybe (instance); | |
440 | 3411 |
428 | 3412 Fsetcar (locative, instance); |
442 | 3413 #ifdef ERROR_CHECK_GLYPHS |
3414 if (image_instance_type_to_mask (XIMAGE_INSTANCE_TYPE (instance)) | |
3415 & (IMAGE_SUBWINDOW_MASK | IMAGE_WIDGET_MASK)) | |
3416 assert (EQ (XIMAGE_INSTANCE_FRAME (instance), | |
3417 DOMAIN_FRAME (domain))); | |
3418 #endif | |
771 | 3419 unbind_to (speccount); |
442 | 3420 #ifdef ERROR_CHECK_GLYPHS |
428 | 3421 if (image_instance_type_to_mask (XIMAGE_INSTANCE_TYPE (instance)) |
442 | 3422 & (IMAGE_SUBWINDOW_MASK | IMAGE_WIDGET_MASK)) |
450 | 3423 assert (EQ (Fgethash (hash_key, |
442 | 3424 XWINDOW (governing_domain) |
3425 ->subwindow_instance_cache, | |
3426 Qunbound), instance)); | |
3427 #endif | |
428 | 3428 } |
442 | 3429 else if (NILP (instance)) |
563 | 3430 gui_error ("Can't instantiate image (probably cached)", instantiator); |
442 | 3431 /* We found an instance. However, because we are using the glyph |
4252 | 3432 as the hash key instead of the instantiator, the current |
3433 instantiator may not be the same as the original. Thus we | |
3434 must update the instance based on the new | |
3435 instantiator. Preserving instance identity like this is | |
3436 important to stop excessive window system widget creation and | |
3437 deletion - and hence flashing. */ | |
442 | 3438 else |
3439 { | |
3440 /* #### This function should be able to cope with *all* | |
3441 changes to the instantiator, but currently only copes | |
3442 with the most used properties. This means that it is | |
3443 possible to make changes that don't get reflected in the | |
3444 display. */ | |
3445 update_image_instance (instance, instantiator); | |
450 | 3446 free_list (hash_key); |
442 | 3447 } |
3448 | |
3449 #ifdef ERROR_CHECK_GLYPHS | |
3450 if (image_instance_type_to_mask (XIMAGE_INSTANCE_TYPE (instance)) | |
3451 & (IMAGE_SUBWINDOW_MASK | IMAGE_WIDGET_MASK)) | |
3452 assert (EQ (XIMAGE_INSTANCE_FRAME (instance), | |
3453 DOMAIN_FRAME (domain))); | |
3454 #endif | |
3455 ERROR_CHECK_IMAGE_INSTANCE (instance); | |
3456 RETURN_UNGCPRO (instance); | |
428 | 3457 } |
3458 | |
2500 | 3459 ABORT (); |
428 | 3460 return Qnil; /* not reached */ |
3461 } | |
3462 | |
3463 /* Validate an image instantiator. */ | |
3464 | |
3465 static void | |
3466 image_validate (Lisp_Object instantiator) | |
3467 { | |
3468 if (IMAGE_INSTANCEP (instantiator) || STRINGP (instantiator)) | |
3469 return; | |
3470 else if (VECTORP (instantiator)) | |
3471 { | |
3472 Lisp_Object *elt = XVECTOR_DATA (instantiator); | |
3473 int instantiator_len = XVECTOR_LENGTH (instantiator); | |
3474 struct image_instantiator_methods *meths; | |
3475 Lisp_Object already_seen = Qnil; | |
3476 struct gcpro gcpro1; | |
3477 int i; | |
3478 | |
3479 if (instantiator_len < 1) | |
563 | 3480 sferror ("Vector length must be at least 1", |
428 | 3481 instantiator); |
3482 | |
3483 meths = decode_image_instantiator_format (elt[0], ERROR_ME); | |
3484 if (!(instantiator_len & 1)) | |
563 | 3485 sferror |
428 | 3486 ("Must have alternating keyword/value pairs", instantiator); |
3487 | |
3488 GCPRO1 (already_seen); | |
3489 | |
3490 for (i = 1; i < instantiator_len; i += 2) | |
3491 { | |
3492 Lisp_Object keyword = elt[i]; | |
3493 Lisp_Object value = elt[i+1]; | |
3494 int j; | |
3495 | |
3496 CHECK_SYMBOL (keyword); | |
3497 if (!SYMBOL_IS_KEYWORD (keyword)) | |
563 | 3498 invalid_argument ("Symbol must begin with a colon", keyword); |
428 | 3499 |
3500 for (j = 0; j < Dynarr_length (meths->keywords); j++) | |
3501 if (EQ (keyword, Dynarr_at (meths->keywords, j).keyword)) | |
3502 break; | |
3503 | |
3504 if (j == Dynarr_length (meths->keywords)) | |
563 | 3505 invalid_argument ("Unrecognized keyword", keyword); |
428 | 3506 |
3507 if (!Dynarr_at (meths->keywords, j).multiple_p) | |
3508 { | |
3509 if (!NILP (memq_no_quit (keyword, already_seen))) | |
563 | 3510 sferror |
428 | 3511 ("Keyword may not appear more than once", keyword); |
3512 already_seen = Fcons (keyword, already_seen); | |
3513 } | |
3514 | |
3515 (Dynarr_at (meths->keywords, j).validate) (value); | |
3516 } | |
3517 | |
3518 UNGCPRO; | |
3519 | |
3520 MAYBE_IIFORMAT_METH (meths, validate, (instantiator)); | |
3521 } | |
3522 else | |
563 | 3523 invalid_argument ("Must be string or vector", instantiator); |
428 | 3524 } |
3525 | |
3526 static void | |
3527 image_after_change (Lisp_Object specifier, Lisp_Object locale) | |
3528 { | |
3529 Lisp_Object attachee = | |
3530 IMAGE_SPECIFIER_ATTACHEE (XIMAGE_SPECIFIER (specifier)); | |
3531 Lisp_Object property = | |
3532 IMAGE_SPECIFIER_ATTACHEE_PROPERTY (XIMAGE_SPECIFIER (specifier)); | |
3533 if (FACEP (attachee)) | |
448 | 3534 { |
3535 face_property_was_changed (attachee, property, locale); | |
3536 if (BUFFERP (locale)) | |
3537 XBUFFER (locale)->buffer_local_face_property = 1; | |
3538 } | |
428 | 3539 else if (GLYPHP (attachee)) |
3540 glyph_property_was_changed (attachee, property, locale); | |
3541 } | |
3542 | |
3543 void | |
3544 set_image_attached_to (Lisp_Object obj, Lisp_Object face_or_glyph, | |
3545 Lisp_Object property) | |
3546 { | |
440 | 3547 Lisp_Specifier *image = XIMAGE_SPECIFIER (obj); |
428 | 3548 |
3549 IMAGE_SPECIFIER_ATTACHEE (image) = face_or_glyph; | |
3550 IMAGE_SPECIFIER_ATTACHEE_PROPERTY (image) = property; | |
3551 } | |
3552 | |
3553 static Lisp_Object | |
2286 | 3554 image_going_to_add (Lisp_Object specifier, Lisp_Object UNUSED (locale), |
428 | 3555 Lisp_Object tag_set, Lisp_Object instantiator) |
3556 { | |
3557 Lisp_Object possible_console_types = Qnil; | |
3558 Lisp_Object rest; | |
3559 Lisp_Object retlist = Qnil; | |
3560 struct gcpro gcpro1, gcpro2; | |
3561 | |
3562 LIST_LOOP (rest, Vconsole_type_list) | |
3563 { | |
3564 Lisp_Object contype = XCAR (rest); | |
3565 if (!NILP (memq_no_quit (contype, tag_set))) | |
3566 possible_console_types = Fcons (contype, possible_console_types); | |
3567 } | |
3568 | |
3569 if (XINT (Flength (possible_console_types)) > 1) | |
3570 /* two conflicting console types specified */ | |
3571 return Qnil; | |
3572 | |
3573 if (NILP (possible_console_types)) | |
3574 possible_console_types = Vconsole_type_list; | |
3575 | |
3576 GCPRO2 (retlist, possible_console_types); | |
3577 | |
3578 LIST_LOOP (rest, possible_console_types) | |
3579 { | |
3580 Lisp_Object contype = XCAR (rest); | |
3581 Lisp_Object newinst = call_with_suspended_errors | |
3582 ((lisp_fn_t) normalize_image_instantiator, | |
793 | 3583 Qnil, Qimage, ERROR_ME_DEBUG_WARN, 3, instantiator, contype, |
428 | 3584 make_int (XIMAGE_SPECIFIER_ALLOWED (specifier))); |
3585 | |
3586 if (!NILP (newinst)) | |
3587 { | |
3588 Lisp_Object newtag; | |
3589 if (NILP (memq_no_quit (contype, tag_set))) | |
3590 newtag = Fcons (contype, tag_set); | |
3591 else | |
3592 newtag = tag_set; | |
3593 retlist = Fcons (Fcons (newtag, newinst), retlist); | |
3594 } | |
3595 } | |
3596 | |
3597 UNGCPRO; | |
3598 | |
3599 return retlist; | |
3600 } | |
3601 | |
434 | 3602 /* Copy an image instantiator. We can't use Fcopy_tree since widgets |
3603 may contain circular references which would send Fcopy_tree into | |
3604 infloop death. */ | |
3605 static Lisp_Object | |
3606 image_copy_vector_instantiator (Lisp_Object instantiator) | |
3607 { | |
3608 int i; | |
3609 struct image_instantiator_methods *meths; | |
3610 Lisp_Object *elt; | |
3611 int instantiator_len; | |
3612 | |
3613 CHECK_VECTOR (instantiator); | |
3614 | |
3615 instantiator = Fcopy_sequence (instantiator); | |
3616 elt = XVECTOR_DATA (instantiator); | |
3617 instantiator_len = XVECTOR_LENGTH (instantiator); | |
440 | 3618 |
434 | 3619 meths = decode_image_instantiator_format (elt[0], ERROR_ME); |
3620 | |
3621 for (i = 1; i < instantiator_len; i += 2) | |
3622 { | |
3623 int j; | |
3624 Lisp_Object keyword = elt[i]; | |
3625 Lisp_Object value = elt[i+1]; | |
3626 | |
3627 /* Find the keyword entry. */ | |
3628 for (j = 0; j < Dynarr_length (meths->keywords); j++) | |
3629 { | |
3630 if (EQ (keyword, Dynarr_at (meths->keywords, j).keyword)) | |
3631 break; | |
3632 } | |
3633 | |
3634 /* Only copy keyword values that should be copied. */ | |
3635 if (Dynarr_at (meths->keywords, j).copy_p | |
3636 && | |
3637 (CONSP (value) || VECTORP (value))) | |
3638 { | |
3639 elt [i+1] = Fcopy_tree (value, Qt); | |
3640 } | |
3641 } | |
3642 | |
3643 return instantiator; | |
3644 } | |
3645 | |
3646 static Lisp_Object | |
3647 image_copy_instantiator (Lisp_Object arg) | |
3648 { | |
3649 if (CONSP (arg)) | |
3650 { | |
3651 Lisp_Object rest; | |
3652 rest = arg = Fcopy_sequence (arg); | |
3653 while (CONSP (rest)) | |
3654 { | |
3655 Lisp_Object elt = XCAR (rest); | |
3656 if (CONSP (elt)) | |
3657 XCAR (rest) = Fcopy_tree (elt, Qt); | |
3658 else if (VECTORP (elt)) | |
3659 XCAR (rest) = image_copy_vector_instantiator (elt); | |
3660 if (VECTORP (XCDR (rest))) /* hack for (a b . [c d]) */ | |
3661 XCDR (rest) = Fcopy_tree (XCDR (rest), Qt); | |
3662 rest = XCDR (rest); | |
3663 } | |
3664 } | |
3665 else if (VECTORP (arg)) | |
3666 { | |
3667 arg = image_copy_vector_instantiator (arg); | |
3668 } | |
3669 return arg; | |
3670 } | |
3671 | |
428 | 3672 DEFUN ("image-specifier-p", Fimage_specifier_p, 1, 1, 0, /* |
3673 Return non-nil if OBJECT is an image specifier. | |
442 | 3674 See `make-image-specifier' for a description of image instantiators. |
428 | 3675 */ |
3676 (object)) | |
3677 { | |
3678 return IMAGE_SPECIFIERP (object) ? Qt : Qnil; | |
3679 } | |
3680 | |
3681 | |
3682 /**************************************************************************** | |
3683 * Glyph Object * | |
3684 ****************************************************************************/ | |
3685 | |
3686 static Lisp_Object | |
3687 mark_glyph (Lisp_Object obj) | |
3688 { | |
440 | 3689 Lisp_Glyph *glyph = XGLYPH (obj); |
428 | 3690 |
3691 mark_object (glyph->image); | |
3692 mark_object (glyph->contrib_p); | |
3693 mark_object (glyph->baseline); | |
3694 mark_object (glyph->face); | |
3695 | |
3696 return glyph->plist; | |
3697 } | |
3698 | |
3699 static void | |
2286 | 3700 print_glyph (Lisp_Object obj, Lisp_Object printcharfun, |
3701 int UNUSED (escapeflag)) | |
428 | 3702 { |
440 | 3703 Lisp_Glyph *glyph = XGLYPH (obj); |
428 | 3704 |
3705 if (print_readably) | |
563 | 3706 printing_unreadable_object ("#<glyph 0x%x>", glyph->header.uid); |
428 | 3707 |
800 | 3708 write_fmt_string_lisp (printcharfun, "#<glyph (%s", 1, Fglyph_type (obj)); |
3709 write_fmt_string_lisp (printcharfun, ") %S", 1, glyph->image); | |
3710 write_fmt_string (printcharfun, "0x%x>", glyph->header.uid); | |
428 | 3711 } |
3712 | |
3713 /* Glyphs are equal if all of their display attributes are equal. We | |
3714 don't compare names or doc-strings, because that would make equal | |
3715 be eq. | |
3716 | |
3717 This isn't concerned with "unspecified" attributes, that's what | |
3718 #'glyph-differs-from-default-p is for. */ | |
3719 static int | |
3720 glyph_equal (Lisp_Object obj1, Lisp_Object obj2, int depth) | |
3721 { | |
440 | 3722 Lisp_Glyph *g1 = XGLYPH (obj1); |
3723 Lisp_Glyph *g2 = XGLYPH (obj2); | |
428 | 3724 |
3725 depth++; | |
3726 | |
3727 return (internal_equal (g1->image, g2->image, depth) && | |
3728 internal_equal (g1->contrib_p, g2->contrib_p, depth) && | |
3729 internal_equal (g1->baseline, g2->baseline, depth) && | |
3730 internal_equal (g1->face, g2->face, depth) && | |
3731 !plists_differ (g1->plist, g2->plist, 0, 0, depth + 1)); | |
3732 } | |
3733 | |
665 | 3734 static Hashcode |
428 | 3735 glyph_hash (Lisp_Object obj, int depth) |
3736 { | |
3737 depth++; | |
3738 | |
3739 /* No need to hash all of the elements; that would take too long. | |
3740 Just hash the most common ones. */ | |
3741 return HASH2 (internal_hash (XGLYPH (obj)->image, depth), | |
3742 internal_hash (XGLYPH (obj)->face, depth)); | |
3743 } | |
3744 | |
3745 static Lisp_Object | |
3746 glyph_getprop (Lisp_Object obj, Lisp_Object prop) | |
3747 { | |
440 | 3748 Lisp_Glyph *g = XGLYPH (obj); |
428 | 3749 |
3750 if (EQ (prop, Qimage)) return g->image; | |
3751 if (EQ (prop, Qcontrib_p)) return g->contrib_p; | |
3752 if (EQ (prop, Qbaseline)) return g->baseline; | |
3753 if (EQ (prop, Qface)) return g->face; | |
3754 | |
3755 return external_plist_get (&g->plist, prop, 0, ERROR_ME); | |
3756 } | |
3757 | |
3758 static int | |
3759 glyph_putprop (Lisp_Object obj, Lisp_Object prop, Lisp_Object value) | |
3760 { | |
3761 if (EQ (prop, Qimage) || | |
3762 EQ (prop, Qcontrib_p) || | |
3763 EQ (prop, Qbaseline)) | |
3764 return 0; | |
3765 | |
3766 if (EQ (prop, Qface)) | |
3767 { | |
3768 XGLYPH (obj)->face = Fget_face (value); | |
3769 return 1; | |
3770 } | |
3771 | |
3772 external_plist_put (&XGLYPH (obj)->plist, prop, value, 0, ERROR_ME); | |
3773 return 1; | |
3774 } | |
3775 | |
3776 static int | |
3777 glyph_remprop (Lisp_Object obj, Lisp_Object prop) | |
3778 { | |
3779 if (EQ (prop, Qimage) || | |
3780 EQ (prop, Qcontrib_p) || | |
3781 EQ (prop, Qbaseline)) | |
3782 return -1; | |
3783 | |
3784 if (EQ (prop, Qface)) | |
3785 { | |
3786 XGLYPH (obj)->face = Qnil; | |
3787 return 1; | |
3788 } | |
3789 | |
3790 return external_remprop (&XGLYPH (obj)->plist, prop, 0, ERROR_ME); | |
3791 } | |
3792 | |
3793 static Lisp_Object | |
3794 glyph_plist (Lisp_Object obj) | |
3795 { | |
440 | 3796 Lisp_Glyph *glyph = XGLYPH (obj); |
428 | 3797 Lisp_Object result = glyph->plist; |
3798 | |
3799 result = cons3 (Qface, glyph->face, result); | |
3800 result = cons3 (Qbaseline, glyph->baseline, result); | |
3801 result = cons3 (Qcontrib_p, glyph->contrib_p, result); | |
3802 result = cons3 (Qimage, glyph->image, result); | |
3803 | |
3804 return result; | |
3805 } | |
3806 | |
1204 | 3807 static const struct memory_description glyph_description[] = { |
440 | 3808 { XD_LISP_OBJECT, offsetof (Lisp_Glyph, image) }, |
3809 { XD_LISP_OBJECT, offsetof (Lisp_Glyph, contrib_p) }, | |
3810 { XD_LISP_OBJECT, offsetof (Lisp_Glyph, baseline) }, | |
3811 { XD_LISP_OBJECT, offsetof (Lisp_Glyph, face) }, | |
3812 { XD_LISP_OBJECT, offsetof (Lisp_Glyph, plist) }, | |
428 | 3813 { XD_END } |
3814 }; | |
3815 | |
934 | 3816 DEFINE_LRECORD_IMPLEMENTATION_WITH_PROPS ("glyph", glyph, |
3817 1, /*dumpable-flag*/ | |
3818 mark_glyph, print_glyph, 0, | |
1204 | 3819 glyph_equal, glyph_hash, |
3820 glyph_description, | |
934 | 3821 glyph_getprop, glyph_putprop, |
3822 glyph_remprop, glyph_plist, | |
3823 Lisp_Glyph); | |
428 | 3824 |
3825 Lisp_Object | |
3826 allocate_glyph (enum glyph_type type, | |
3827 void (*after_change) (Lisp_Object glyph, Lisp_Object property, | |
3828 Lisp_Object locale)) | |
3829 { | |
3830 /* This function can GC */ | |
3831 Lisp_Object obj = Qnil; | |
3017 | 3832 Lisp_Glyph *g = ALLOC_LCRECORD_TYPE (Lisp_Glyph, &lrecord_glyph); |
428 | 3833 |
3834 g->type = type; | |
3835 g->image = Fmake_specifier (Qimage); /* This function can GC */ | |
3836 g->dirty = 0; | |
3837 switch (g->type) | |
3838 { | |
3839 case GLYPH_BUFFER: | |
3840 XIMAGE_SPECIFIER_ALLOWED (g->image) = | |
440 | 3841 IMAGE_NOTHING_MASK | IMAGE_TEXT_MASK |
3842 | IMAGE_MONO_PIXMAP_MASK | IMAGE_COLOR_PIXMAP_MASK | |
442 | 3843 | IMAGE_SUBWINDOW_MASK | IMAGE_WIDGET_MASK; |
428 | 3844 break; |
3845 case GLYPH_POINTER: | |
3846 XIMAGE_SPECIFIER_ALLOWED (g->image) = | |
3847 IMAGE_NOTHING_MASK | IMAGE_POINTER_MASK; | |
3848 break; | |
3849 case GLYPH_ICON: | |
3850 XIMAGE_SPECIFIER_ALLOWED (g->image) = | |
438 | 3851 IMAGE_NOTHING_MASK | IMAGE_MONO_PIXMAP_MASK |
3852 | IMAGE_COLOR_PIXMAP_MASK; | |
428 | 3853 break; |
3854 default: | |
2500 | 3855 ABORT (); |
428 | 3856 } |
3857 | |
3858 /* I think Fmake_specifier can GC. I think set_specifier_fallback can GC. */ | |
3859 /* We're getting enough reports of odd behavior in this area it seems */ | |
3860 /* best to GCPRO everything. */ | |
3861 { | |
3862 Lisp_Object tem1 = list1 (Fcons (Qnil, Vthe_nothing_vector)); | |
3863 Lisp_Object tem2 = list1 (Fcons (Qnil, Qt)); | |
3864 Lisp_Object tem3 = list1 (Fcons (Qnil, Qnil)); | |
3865 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4; | |
3866 | |
3867 GCPRO4 (obj, tem1, tem2, tem3); | |
3868 | |
3869 set_specifier_fallback (g->image, tem1); | |
3870 g->contrib_p = Fmake_specifier (Qboolean); | |
3871 set_specifier_fallback (g->contrib_p, tem2); | |
3872 /* #### should have a specifier for the following */ | |
3873 g->baseline = Fmake_specifier (Qgeneric); | |
3874 set_specifier_fallback (g->baseline, tem3); | |
3875 g->face = Qnil; | |
3876 g->plist = Qnil; | |
3877 g->after_change = after_change; | |
793 | 3878 obj = wrap_glyph (g); |
428 | 3879 |
3880 set_image_attached_to (g->image, obj, Qimage); | |
3881 UNGCPRO; | |
3882 } | |
3883 | |
3884 return obj; | |
3885 } | |
3886 | |
3887 static enum glyph_type | |
578 | 3888 decode_glyph_type (Lisp_Object type, Error_Behavior errb) |
428 | 3889 { |
3890 if (NILP (type)) | |
3891 return GLYPH_BUFFER; | |
3892 | |
3893 if (ERRB_EQ (errb, ERROR_ME)) | |
3894 CHECK_SYMBOL (type); | |
3895 | |
3896 if (EQ (type, Qbuffer)) return GLYPH_BUFFER; | |
3897 if (EQ (type, Qpointer)) return GLYPH_POINTER; | |
3898 if (EQ (type, Qicon)) return GLYPH_ICON; | |
3899 | |
563 | 3900 maybe_invalid_constant ("Invalid glyph type", type, Qimage, errb); |
428 | 3901 |
3902 return GLYPH_UNKNOWN; | |
3903 } | |
3904 | |
3905 static int | |
3906 valid_glyph_type_p (Lisp_Object type) | |
3907 { | |
3908 return !NILP (memq_no_quit (type, Vglyph_type_list)); | |
3909 } | |
3910 | |
3911 DEFUN ("valid-glyph-type-p", Fvalid_glyph_type_p, 1, 1, 0, /* | |
3912 Given a GLYPH-TYPE, return non-nil if it is valid. | |
3913 Valid types are `buffer', `pointer', and `icon'. | |
3914 */ | |
3915 (glyph_type)) | |
3916 { | |
3917 return valid_glyph_type_p (glyph_type) ? Qt : Qnil; | |
3918 } | |
3919 | |
3920 DEFUN ("glyph-type-list", Fglyph_type_list, 0, 0, 0, /* | |
3921 Return a list of valid glyph types. | |
3922 */ | |
3923 ()) | |
3924 { | |
3925 return Fcopy_sequence (Vglyph_type_list); | |
3926 } | |
3927 | |
3928 DEFUN ("make-glyph-internal", Fmake_glyph_internal, 0, 1, 0, /* | |
442 | 3929 Create and return a new uninitialized glyph of type TYPE. |
428 | 3930 |
3931 TYPE specifies the type of the glyph; this should be one of `buffer', | |
3932 `pointer', or `icon', and defaults to `buffer'. The type of the glyph | |
3933 specifies in which contexts the glyph can be used, and controls the | |
3934 allowable image types into which the glyph's image can be | |
3935 instantiated. | |
3936 | |
3937 `buffer' glyphs can be used as the begin-glyph or end-glyph of an | |
3938 extent, in the modeline, and in the toolbar. Their image can be | |
3939 instantiated as `nothing', `mono-pixmap', `color-pixmap', `text', | |
3940 and `subwindow'. | |
3941 | |
3942 `pointer' glyphs can be used to specify the mouse pointer. Their | |
3943 image can be instantiated as `pointer'. | |
3944 | |
3945 `icon' glyphs can be used to specify the icon used when a frame is | |
3946 iconified. Their image can be instantiated as `mono-pixmap' and | |
3947 `color-pixmap'. | |
3948 */ | |
3949 (type)) | |
3950 { | |
3951 enum glyph_type typeval = decode_glyph_type (type, ERROR_ME); | |
3952 return allocate_glyph (typeval, 0); | |
3953 } | |
3954 | |
3955 DEFUN ("glyphp", Fglyphp, 1, 1, 0, /* | |
3956 Return non-nil if OBJECT is a glyph. | |
3957 | |
442 | 3958 A glyph is an object used for pixmaps, widgets and the like. It is used |
428 | 3959 in begin-glyphs and end-glyphs attached to extents, in marginal and textual |
3960 annotations, in overlay arrows (overlay-arrow-* variables), in toolbar | |
442 | 3961 buttons, and the like. Much more detailed information can be found at |
3962 `make-glyph'. Its image is described using an image specifier -- | |
3963 see `make-image-specifier'. See also `make-image-instance' for further | |
3964 information. | |
428 | 3965 */ |
3966 (object)) | |
3967 { | |
3968 return GLYPHP (object) ? Qt : Qnil; | |
3969 } | |
3970 | |
3971 DEFUN ("glyph-type", Fglyph_type, 1, 1, 0, /* | |
3972 Return the type of the given glyph. | |
2959 | 3973 The return value will be one of `buffer', `pointer', or `icon'. |
428 | 3974 */ |
3975 (glyph)) | |
3976 { | |
3977 CHECK_GLYPH (glyph); | |
3978 switch (XGLYPH_TYPE (glyph)) | |
3979 { | |
2500 | 3980 default: ABORT (); |
428 | 3981 case GLYPH_BUFFER: return Qbuffer; |
3982 case GLYPH_POINTER: return Qpointer; | |
3983 case GLYPH_ICON: return Qicon; | |
3984 } | |
3985 } | |
3986 | |
438 | 3987 Lisp_Object |
3988 glyph_image_instance (Lisp_Object glyph, Lisp_Object domain, | |
578 | 3989 Error_Behavior errb, int no_quit) |
438 | 3990 { |
3991 Lisp_Object specifier = GLYPH_IMAGE (XGLYPH (glyph)); | |
3992 | |
2959 | 3993 /* This can never return Qunbound. All glyphs have `nothing' as |
438 | 3994 a fallback. */ |
440 | 3995 Lisp_Object image_instance = specifier_instance (specifier, Qunbound, |
438 | 3996 domain, errb, no_quit, 0, |
3997 Qzero); | |
440 | 3998 assert (!UNBOUNDP (image_instance)); |
442 | 3999 ERROR_CHECK_IMAGE_INSTANCE (image_instance); |
438 | 4000 |
4001 return image_instance; | |
4002 } | |
4003 | |
4004 static Lisp_Object | |
4005 glyph_image_instance_maybe (Lisp_Object glyph_or_image, Lisp_Object window) | |
4006 { | |
4007 Lisp_Object instance = glyph_or_image; | |
4008 | |
4009 if (GLYPHP (glyph_or_image)) | |
793 | 4010 instance = glyph_image_instance (glyph_or_image, window, |
4011 ERROR_ME_DEBUG_WARN, 1); | |
438 | 4012 |
4013 return instance; | |
4014 } | |
4015 | |
1411 | 4016 inline static int |
4017 image_instance_needs_layout (Lisp_Object instance) | |
4018 { | |
4019 Lisp_Image_Instance *ii = XIMAGE_INSTANCE (instance); | |
4020 | |
4021 if (IMAGE_INSTANCE_DIRTYP (ii) && IMAGE_INSTANCE_LAYOUT_CHANGED (ii)) | |
4022 { | |
4023 return 1; | |
4024 } | |
4025 else | |
4026 { | |
4027 Lisp_Object iif = IMAGE_INSTANCE_FRAME (ii); | |
4028 return FRAMEP (iif) && XFRAME (iif)->size_changed; | |
4029 } | |
4030 } | |
4031 | |
428 | 4032 /***************************************************************************** |
4033 glyph_width | |
4034 | |
438 | 4035 Return the width of the given GLYPH on the given WINDOW. |
4036 Calculations are done based on recursively querying the geometry of | |
4037 the associated image instances. | |
428 | 4038 ****************************************************************************/ |
4039 unsigned short | |
438 | 4040 glyph_width (Lisp_Object glyph_or_image, Lisp_Object domain) |
428 | 4041 { |
438 | 4042 Lisp_Object instance = glyph_image_instance_maybe (glyph_or_image, |
4043 domain); | |
428 | 4044 if (!IMAGE_INSTANCEP (instance)) |
4045 return 0; | |
4046 | |
1411 | 4047 if (image_instance_needs_layout (instance)) |
438 | 4048 image_instance_layout (instance, IMAGE_UNSPECIFIED_GEOMETRY, |
442 | 4049 IMAGE_UNSPECIFIED_GEOMETRY, |
4050 IMAGE_UNCHANGED_GEOMETRY, | |
4051 IMAGE_UNCHANGED_GEOMETRY, domain); | |
438 | 4052 |
4053 return XIMAGE_INSTANCE_WIDTH (instance); | |
428 | 4054 } |
4055 | |
4056 DEFUN ("glyph-width", Fglyph_width, 1, 2, 0, /* | |
4057 Return the width of GLYPH on WINDOW. | |
4058 This may not be exact as it does not take into account all of the context | |
4059 that redisplay will. | |
4060 */ | |
4061 (glyph, window)) | |
4062 { | |
793 | 4063 window = wrap_window (decode_window (window)); |
428 | 4064 CHECK_GLYPH (glyph); |
4065 | |
438 | 4066 return make_int (glyph_width (glyph, window)); |
428 | 4067 } |
4068 | |
4069 unsigned short | |
438 | 4070 glyph_ascent (Lisp_Object glyph_or_image, Lisp_Object domain) |
428 | 4071 { |
438 | 4072 Lisp_Object instance = glyph_image_instance_maybe (glyph_or_image, |
4073 domain); | |
4074 if (!IMAGE_INSTANCEP (instance)) | |
4075 return 0; | |
4076 | |
1411 | 4077 if (image_instance_needs_layout (instance)) |
438 | 4078 image_instance_layout (instance, IMAGE_UNSPECIFIED_GEOMETRY, |
442 | 4079 IMAGE_UNSPECIFIED_GEOMETRY, |
4080 IMAGE_UNCHANGED_GEOMETRY, | |
4081 IMAGE_UNCHANGED_GEOMETRY, domain); | |
438 | 4082 |
4083 if (XIMAGE_INSTANCE_TYPE (instance) == IMAGE_TEXT) | |
4084 return XIMAGE_INSTANCE_TEXT_ASCENT (instance); | |
4085 else | |
4086 return XIMAGE_INSTANCE_HEIGHT (instance); | |
428 | 4087 } |
4088 | |
4089 unsigned short | |
438 | 4090 glyph_descent (Lisp_Object glyph_or_image, Lisp_Object domain) |
428 | 4091 { |
438 | 4092 Lisp_Object instance = glyph_image_instance_maybe (glyph_or_image, |
4093 domain); | |
4094 if (!IMAGE_INSTANCEP (instance)) | |
4095 return 0; | |
4096 | |
1411 | 4097 if (image_instance_needs_layout (instance)) |
438 | 4098 image_instance_layout (instance, IMAGE_UNSPECIFIED_GEOMETRY, |
442 | 4099 IMAGE_UNSPECIFIED_GEOMETRY, |
4100 IMAGE_UNCHANGED_GEOMETRY, | |
4101 IMAGE_UNCHANGED_GEOMETRY, domain); | |
438 | 4102 |
4103 if (XIMAGE_INSTANCE_TYPE (instance) == IMAGE_TEXT) | |
4104 return XIMAGE_INSTANCE_TEXT_DESCENT (instance); | |
4105 else | |
4106 return 0; | |
428 | 4107 } |
4108 | |
4109 /* strictly a convenience function. */ | |
4110 unsigned short | |
438 | 4111 glyph_height (Lisp_Object glyph_or_image, Lisp_Object domain) |
428 | 4112 { |
438 | 4113 Lisp_Object instance = glyph_image_instance_maybe (glyph_or_image, |
4114 domain); | |
440 | 4115 |
438 | 4116 if (!IMAGE_INSTANCEP (instance)) |
4117 return 0; | |
4118 | |
1411 | 4119 if (image_instance_needs_layout (instance)) |
438 | 4120 image_instance_layout (instance, IMAGE_UNSPECIFIED_GEOMETRY, |
442 | 4121 IMAGE_UNSPECIFIED_GEOMETRY, |
4122 IMAGE_UNCHANGED_GEOMETRY, | |
4123 IMAGE_UNCHANGED_GEOMETRY, domain); | |
438 | 4124 |
4125 return XIMAGE_INSTANCE_HEIGHT (instance); | |
428 | 4126 } |
4127 | |
4128 DEFUN ("glyph-ascent", Fglyph_ascent, 1, 2, 0, /* | |
4129 Return the ascent value of GLYPH on WINDOW. | |
4130 This may not be exact as it does not take into account all of the context | |
4131 that redisplay will. | |
4132 */ | |
4133 (glyph, window)) | |
4134 { | |
793 | 4135 window = wrap_window (decode_window (window)); |
428 | 4136 CHECK_GLYPH (glyph); |
4137 | |
438 | 4138 return make_int (glyph_ascent (glyph, window)); |
428 | 4139 } |
4140 | |
4141 DEFUN ("glyph-descent", Fglyph_descent, 1, 2, 0, /* | |
4142 Return the descent value of GLYPH on WINDOW. | |
4143 This may not be exact as it does not take into account all of the context | |
4144 that redisplay will. | |
4145 */ | |
4146 (glyph, window)) | |
4147 { | |
793 | 4148 window = wrap_window (decode_window (window)); |
428 | 4149 CHECK_GLYPH (glyph); |
4150 | |
438 | 4151 return make_int (glyph_descent (glyph, window)); |
428 | 4152 } |
4153 | |
4154 /* This is redundant but I bet a lot of people expect it to exist. */ | |
4155 DEFUN ("glyph-height", Fglyph_height, 1, 2, 0, /* | |
4156 Return the height of GLYPH on WINDOW. | |
4157 This may not be exact as it does not take into account all of the context | |
4158 that redisplay will. | |
4159 */ | |
4160 (glyph, window)) | |
4161 { | |
793 | 4162 window = wrap_window (decode_window (window)); |
428 | 4163 CHECK_GLYPH (glyph); |
4164 | |
438 | 4165 return make_int (glyph_height (glyph, window)); |
428 | 4166 } |
4167 | |
4168 static void | |
4169 set_glyph_dirty_p (Lisp_Object glyph_or_image, Lisp_Object window, int dirty) | |
4170 { | |
4171 Lisp_Object instance = glyph_or_image; | |
4172 | |
4173 if (!NILP (glyph_or_image)) | |
4174 { | |
4175 if (GLYPHP (glyph_or_image)) | |
4176 { | |
4177 instance = glyph_image_instance (glyph_or_image, window, | |
793 | 4178 ERROR_ME_DEBUG_WARN, 1); |
428 | 4179 XGLYPH_DIRTYP (glyph_or_image) = dirty; |
4180 } | |
4181 | |
442 | 4182 if (!IMAGE_INSTANCEP (instance)) |
4183 return; | |
4184 | |
428 | 4185 XIMAGE_INSTANCE_DIRTYP (instance) = dirty; |
4186 } | |
4187 } | |
4188 | |
442 | 4189 static void |
4190 set_image_instance_dirty_p (Lisp_Object instance, int dirty) | |
4191 { | |
4192 if (IMAGE_INSTANCEP (instance)) | |
4193 { | |
4194 XIMAGE_INSTANCE_DIRTYP (instance) = dirty; | |
4195 /* Now cascade up the hierarchy. */ | |
4196 set_image_instance_dirty_p (XIMAGE_INSTANCE_PARENT (instance), | |
4197 dirty); | |
4198 } | |
4199 else if (GLYPHP (instance)) | |
4200 { | |
4201 XGLYPH_DIRTYP (instance) = dirty; | |
4202 } | |
4203 } | |
4204 | |
428 | 4205 /* #### do we need to cache this info to speed things up? */ |
4206 | |
4207 Lisp_Object | |
4208 glyph_baseline (Lisp_Object glyph, Lisp_Object domain) | |
4209 { | |
4210 if (!GLYPHP (glyph)) | |
4211 return Qnil; | |
4212 else | |
4213 { | |
4214 Lisp_Object retval = | |
4215 specifier_instance_no_quit (GLYPH_BASELINE (XGLYPH (glyph)), | |
793 | 4216 /* #### look into error flag */ |
4217 Qunbound, domain, ERROR_ME_DEBUG_WARN, | |
428 | 4218 0, Qzero); |
4219 if (!NILP (retval) && !INTP (retval)) | |
4220 retval = Qnil; | |
4221 else if (INTP (retval)) | |
4222 { | |
4223 if (XINT (retval) < 0) | |
4224 retval = Qzero; | |
4225 if (XINT (retval) > 100) | |
4226 retval = make_int (100); | |
4227 } | |
4228 return retval; | |
4229 } | |
4230 } | |
4231 | |
4232 Lisp_Object | |
2286 | 4233 glyph_face (Lisp_Object glyph, Lisp_Object UNUSED (domain)) |
428 | 4234 { |
4235 /* #### Domain parameter not currently used but it will be */ | |
4236 return GLYPHP (glyph) ? GLYPH_FACE (XGLYPH (glyph)) : Qnil; | |
4237 } | |
4238 | |
4239 int | |
4240 glyph_contrib_p (Lisp_Object glyph, Lisp_Object domain) | |
4241 { | |
4242 if (!GLYPHP (glyph)) | |
4243 return 0; | |
4244 else | |
4245 return !NILP (specifier_instance_no_quit | |
4246 (GLYPH_CONTRIB_P (XGLYPH (glyph)), Qunbound, domain, | |
793 | 4247 /* #### look into error flag */ |
4248 ERROR_ME_DEBUG_WARN, 0, Qzero)); | |
428 | 4249 } |
4250 | |
4251 static void | |
4252 glyph_property_was_changed (Lisp_Object glyph, Lisp_Object property, | |
4253 Lisp_Object locale) | |
4254 { | |
4255 if (XGLYPH (glyph)->after_change) | |
4256 (XGLYPH (glyph)->after_change) (glyph, property, locale); | |
4257 } | |
4258 | |
442 | 4259 void |
4260 glyph_query_geometry (Lisp_Object glyph_or_image, int* width, int* height, | |
438 | 4261 enum image_instance_geometry disp, Lisp_Object domain) |
4262 { | |
4263 Lisp_Object instance = glyph_or_image; | |
4264 | |
4265 if (GLYPHP (glyph_or_image)) | |
793 | 4266 instance = glyph_image_instance (glyph_or_image, domain, |
4267 ERROR_ME_DEBUG_WARN, 1); | |
440 | 4268 |
438 | 4269 image_instance_query_geometry (instance, width, height, disp, domain); |
4270 } | |
4271 | |
442 | 4272 void |
4273 glyph_do_layout (Lisp_Object glyph_or_image, int width, int height, | |
4274 int xoffset, int yoffset, Lisp_Object domain) | |
438 | 4275 { |
4276 Lisp_Object instance = glyph_or_image; | |
4277 | |
4278 if (GLYPHP (glyph_or_image)) | |
793 | 4279 instance = glyph_image_instance (glyph_or_image, domain, |
4280 ERROR_ME_DEBUG_WARN, 1); | |
442 | 4281 |
4282 image_instance_layout (instance, width, height, xoffset, yoffset, domain); | |
4283 } | |
438 | 4284 |
428 | 4285 |
4286 /***************************************************************************** | |
4252 | 4287 * glyph cachel functions * |
428 | 4288 *****************************************************************************/ |
4289 | |
442 | 4290 /* #### All of this is 95% copied from face cachels. Consider |
4291 consolidating. | |
4292 | |
4293 Why do we need glyph_cachels? Simply because a glyph_cachel captures | |
4294 per-window information about a particular glyph. A glyph itself is | |
4295 not created in any particular context, so if we were to rely on a | |
4296 glyph to tell us about its dirtiness we would not be able to reset | |
4297 the dirty flag after redisplaying it as it may exist in other | |
4298 contexts. When we have redisplayed we need to know which glyphs to | |
4299 reset the dirty flags on - the glyph_cachels give us a nice list we | |
4300 can iterate through doing this. */ | |
428 | 4301 void |
4302 mark_glyph_cachels (glyph_cachel_dynarr *elements) | |
4303 { | |
4304 int elt; | |
4305 | |
4306 if (!elements) | |
4307 return; | |
4308 | |
4309 for (elt = 0; elt < Dynarr_length (elements); elt++) | |
4310 { | |
4311 struct glyph_cachel *cachel = Dynarr_atp (elements, elt); | |
4312 mark_object (cachel->glyph); | |
4313 } | |
4314 } | |
4315 | |
4316 static void | |
4317 update_glyph_cachel_data (struct window *w, Lisp_Object glyph, | |
4318 struct glyph_cachel *cachel) | |
4319 { | |
4320 if (!cachel->updated || NILP (cachel->glyph) || !EQ (cachel->glyph, glyph) | |
440 | 4321 || XGLYPH_DIRTYP (cachel->glyph) |
4322 || XFRAME(WINDOW_FRAME(w))->faces_changed) | |
428 | 4323 { |
4324 Lisp_Object window, instance; | |
4325 | |
793 | 4326 window = wrap_window (w); |
428 | 4327 |
4328 cachel->glyph = glyph; | |
440 | 4329 /* Speed things up slightly by grabbing the glyph instantiation |
4330 and passing it to the size functions. */ | |
793 | 4331 instance = glyph_image_instance (glyph, window, ERROR_ME_DEBUG_WARN, 1); |
440 | 4332 |
442 | 4333 if (!IMAGE_INSTANCEP (instance)) |
4334 return; | |
4335 | |
440 | 4336 /* Mark text instance of the glyph dirty if faces have changed, |
4337 because its geometry might have changed. */ | |
4338 invalidate_glyph_geometry_maybe (instance, w); | |
4339 | |
4340 /* #### Do the following 2 lines buy us anything? --kkm */ | |
4341 XGLYPH_DIRTYP (glyph) = XIMAGE_INSTANCE_DIRTYP (instance); | |
4342 cachel->dirty = XGLYPH_DIRTYP (glyph); | |
438 | 4343 cachel->width = glyph_width (instance, window); |
4344 cachel->ascent = glyph_ascent (instance, window); | |
4345 cachel->descent = glyph_descent (instance, window); | |
428 | 4346 } |
4347 | |
4348 cachel->updated = 1; | |
4349 } | |
4350 | |
4351 static void | |
4352 add_glyph_cachel (struct window *w, Lisp_Object glyph) | |
4353 { | |
4354 struct glyph_cachel new_cachel; | |
4355 | |
4356 xzero (new_cachel); | |
4357 new_cachel.glyph = Qnil; | |
4358 | |
4359 update_glyph_cachel_data (w, glyph, &new_cachel); | |
4360 Dynarr_add (w->glyph_cachels, new_cachel); | |
4361 } | |
4362 | |
4363 glyph_index | |
4364 get_glyph_cachel_index (struct window *w, Lisp_Object glyph) | |
4365 { | |
4366 int elt; | |
4367 | |
4368 if (noninteractive) | |
4369 return 0; | |
4370 | |
4371 for (elt = 0; elt < Dynarr_length (w->glyph_cachels); elt++) | |
4372 { | |
4373 struct glyph_cachel *cachel = | |
4374 Dynarr_atp (w->glyph_cachels, elt); | |
4375 | |
4376 if (EQ (cachel->glyph, glyph) && !NILP (glyph)) | |
4377 { | |
4378 update_glyph_cachel_data (w, glyph, cachel); | |
4379 return elt; | |
4380 } | |
4381 } | |
4382 | |
4383 /* If we didn't find the glyph, add it and then return its index. */ | |
4384 add_glyph_cachel (w, glyph); | |
4385 return elt; | |
4386 } | |
4387 | |
4388 void | |
4389 reset_glyph_cachels (struct window *w) | |
4390 { | |
4391 Dynarr_reset (w->glyph_cachels); | |
4392 get_glyph_cachel_index (w, Vcontinuation_glyph); | |
4393 get_glyph_cachel_index (w, Vtruncation_glyph); | |
4394 get_glyph_cachel_index (w, Vhscroll_glyph); | |
4395 get_glyph_cachel_index (w, Vcontrol_arrow_glyph); | |
4396 get_glyph_cachel_index (w, Voctal_escape_glyph); | |
4397 get_glyph_cachel_index (w, Vinvisible_text_glyph); | |
4398 } | |
4399 | |
4400 void | |
4401 mark_glyph_cachels_as_not_updated (struct window *w) | |
4402 { | |
4403 int elt; | |
4404 | |
4405 /* We need to have a dirty flag to tell if the glyph has changed. | |
4406 We can check to see if each glyph variable is actually a | |
4407 completely different glyph, though. */ | |
4408 #define FROB(glyph_obj, gindex) \ | |
4409 update_glyph_cachel_data (w, glyph_obj, \ | |
4410 Dynarr_atp (w->glyph_cachels, gindex)) | |
4411 | |
4412 FROB (Vcontinuation_glyph, CONT_GLYPH_INDEX); | |
4413 FROB (Vtruncation_glyph, TRUN_GLYPH_INDEX); | |
4414 FROB (Vhscroll_glyph, HSCROLL_GLYPH_INDEX); | |
4415 FROB (Vcontrol_arrow_glyph, CONTROL_GLYPH_INDEX); | |
4416 FROB (Voctal_escape_glyph, OCT_ESC_GLYPH_INDEX); | |
4417 FROB (Vinvisible_text_glyph, INVIS_GLYPH_INDEX); | |
4418 #undef FROB | |
4419 | |
4420 for (elt = 0; elt < Dynarr_length (w->glyph_cachels); elt++) | |
4421 { | |
4422 Dynarr_atp (w->glyph_cachels, elt)->updated = 0; | |
4423 } | |
4424 } | |
4425 | |
4426 /* Unset the dirty bit on all the glyph cachels that have it. */ | |
440 | 4427 void |
428 | 4428 mark_glyph_cachels_as_clean (struct window* w) |
4429 { | |
4430 int elt; | |
793 | 4431 Lisp_Object window = wrap_window (w); |
4432 | |
428 | 4433 for (elt = 0; elt < Dynarr_length (w->glyph_cachels); elt++) |
4434 { | |
4435 struct glyph_cachel *cachel = Dynarr_atp (w->glyph_cachels, elt); | |
4436 cachel->dirty = 0; | |
4437 set_glyph_dirty_p (cachel->glyph, window, 0); | |
4438 } | |
4439 } | |
4440 | |
4441 #ifdef MEMORY_USAGE_STATS | |
4442 | |
4443 int | |
4444 compute_glyph_cachel_usage (glyph_cachel_dynarr *glyph_cachels, | |
4445 struct overhead_stats *ovstats) | |
4446 { | |
4447 int total = 0; | |
4448 | |
4449 if (glyph_cachels) | |
4450 total += Dynarr_memory_usage (glyph_cachels, ovstats); | |
4451 | |
4452 return total; | |
4453 } | |
4454 | |
4455 #endif /* MEMORY_USAGE_STATS */ | |
4456 | |
4457 | |
4458 | |
4459 /***************************************************************************** | |
4252 | 4460 * subwindow cachel functions * |
428 | 4461 *****************************************************************************/ |
438 | 4462 /* Subwindows are curious in that you have to physically unmap them to |
428 | 4463 not display them. It is problematic deciding what to do in |
4464 redisplay. We have two caches - a per-window instance cache that | |
4465 keeps track of subwindows on a window, these are linked to their | |
4466 instantiator in the hashtable and when the instantiator goes away | |
4467 we want the instance to go away also. However we also have a | |
4468 per-frame instance cache that we use to determine if a subwindow is | |
4469 obscuring an area that we want to clear. We need to be able to flip | |
4470 through this quickly so a hashtable is not suitable hence the | |
442 | 4471 subwindow_cachels. This is a weak list so unreference instances |
4472 will get deleted properly. */ | |
428 | 4473 |
4474 /* redisplay in general assumes that drawing something will erase | |
4475 what was there before. unfortunately this does not apply to | |
4476 subwindows that need to be specifically unmapped in order to | |
4477 disappear. we take a brute force approach - on the basis that its | |
4478 cheap - and unmap all subwindows in a display line */ | |
442 | 4479 |
4480 /* Put new instances in the frame subwindow cache. This is less costly than | |
4481 doing it every time something gets mapped, and deleted instances will be | |
4482 removed automatically. */ | |
4483 static void | |
4484 cache_subwindow_instance_in_frame_maybe (Lisp_Object instance) | |
4485 { | |
4486 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (instance); | |
4487 if (!NILP (DOMAIN_FRAME (IMAGE_INSTANCE_DOMAIN (ii)))) | |
428 | 4488 { |
442 | 4489 struct frame* f = DOMAIN_XFRAME (IMAGE_INSTANCE_DOMAIN (ii)); |
4490 XWEAK_LIST_LIST (FRAME_SUBWINDOW_CACHE (f)) | |
4491 = Fcons (instance, XWEAK_LIST_LIST (FRAME_SUBWINDOW_CACHE (f))); | |
4492 } | |
4493 } | |
4494 | |
4495 /* Unmap and finalize all subwindow instances in the frame cache. This | |
4496 is necessary because GC will not guarantee the order things get | |
4497 deleted in and moreover, frame finalization deletes the window | |
4498 system windows before deleting XEmacs windows, and hence | |
4499 subwindows. */ | |
4500 int | |
2286 | 4501 unmap_subwindow_instance_cache_mapper (Lisp_Object UNUSED (key), |
4502 Lisp_Object value, void* finalize) | |
442 | 4503 { |
4504 /* value can be nil; we cache failures as well as successes */ | |
4505 if (!NILP (value)) | |
4506 { | |
4507 struct frame* f = XFRAME (XIMAGE_INSTANCE_FRAME (value)); | |
4508 unmap_subwindow (value); | |
4509 if (finalize) | |
428 | 4510 { |
442 | 4511 /* In case GC doesn't catch up fast enough, remove from the frame |
4512 cache also. Otherwise code that checks the sanity of the instance | |
4513 will fail. */ | |
4514 XWEAK_LIST_LIST (FRAME_SUBWINDOW_CACHE (f)) | |
4515 = delq_no_quit (value, | |
4516 XWEAK_LIST_LIST (FRAME_SUBWINDOW_CACHE (f))); | |
4517 finalize_image_instance (XIMAGE_INSTANCE (value), 0); | |
428 | 4518 } |
4519 } | |
442 | 4520 return 0; |
4521 } | |
4522 | |
4523 static void | |
4524 finalize_all_subwindow_instances (struct window *w) | |
4525 { | |
4526 if (!NILP (w->next)) finalize_all_subwindow_instances (XWINDOW (w->next)); | |
4527 if (!NILP (w->vchild)) finalize_all_subwindow_instances (XWINDOW (w->vchild)); | |
4528 if (!NILP (w->hchild)) finalize_all_subwindow_instances (XWINDOW (w->hchild)); | |
4529 | |
4530 elisp_maphash (unmap_subwindow_instance_cache_mapper, | |
4531 w->subwindow_instance_cache, (void*)1); | |
428 | 4532 } |
4533 | |
4534 void | |
442 | 4535 free_frame_subwindow_instances (struct frame* f) |
4536 { | |
4537 /* Make sure all instances are finalized. We have to do this via the | |
4538 instance cache since some instances may be extant but not | |
4539 displayed (and hence not in the frame cache). */ | |
4540 finalize_all_subwindow_instances (XWINDOW (f->root_window)); | |
4541 } | |
4542 | |
4543 /* Unmap all instances in the frame cache. */ | |
4544 void | |
4545 reset_frame_subwindow_instance_cache (struct frame* f) | |
4546 { | |
4547 Lisp_Object rest; | |
4548 | |
4549 LIST_LOOP (rest, XWEAK_LIST_LIST (FRAME_SUBWINDOW_CACHE (f))) | |
4550 { | |
4551 Lisp_Object value = XCAR (rest); | |
4552 unmap_subwindow (value); | |
4553 } | |
4554 } | |
428 | 4555 |
4556 /***************************************************************************** | |
4557 * subwindow exposure ignorance * | |
4558 *****************************************************************************/ | |
4559 /* when we unmap subwindows the associated window system will generate | |
4560 expose events. This we do not want as redisplay already copes with | |
4561 the repainting necessary. Worse, we can get in an endless cycle of | |
4562 redisplay if we are not careful. Thus we keep a per-frame list of | |
4563 expose events that are going to come and ignore them as | |
4564 required. */ | |
4565 | |
3092 | 4566 #ifndef NEW_GC |
428 | 4567 struct expose_ignore_blocktype |
4568 { | |
4569 Blocktype_declare (struct expose_ignore); | |
4570 } *the_expose_ignore_blocktype; | |
3092 | 4571 #endif /* not NEW_GC */ |
428 | 4572 |
4573 int | |
647 | 4574 check_for_ignored_expose (struct frame* f, int x, int y, int width, int height) |
428 | 4575 { |
4576 struct expose_ignore *ei, *prev; | |
4577 /* the ignore list is FIFO so we should generally get a match with | |
4578 the first element in the list */ | |
4579 for (ei = f->subwindow_exposures, prev = 0; ei; ei = ei->next) | |
4580 { | |
4581 /* Checking for exact matches just isn't good enough as we | |
442 | 4582 might get exposures for partially obscured subwindows, thus |
4583 we have to check for overlaps. Being conservative, we will | |
4584 check for exposures wholly contained by the subwindow - this | |
428 | 4585 might give us what we want.*/ |
440 | 4586 if (ei->x <= x && ei->y <= y |
428 | 4587 && ei->x + ei->width >= x + width |
4588 && ei->y + ei->height >= y + height) | |
4589 { | |
4590 #ifdef DEBUG_WIDGETS | |
4591 stderr_out ("ignored %d+%d, %dx%d for exposure %d+%d, %dx%d\n", | |
4592 x, y, width, height, ei->x, ei->y, ei->width, ei->height); | |
4593 #endif | |
4594 if (!prev) | |
4595 f->subwindow_exposures = ei->next; | |
4596 else | |
4597 prev->next = ei->next; | |
440 | 4598 |
428 | 4599 if (ei == f->subwindow_exposures_tail) |
4600 f->subwindow_exposures_tail = prev; | |
4601 | |
4117 | 4602 #ifndef NEW_GC |
428 | 4603 Blocktype_free (the_expose_ignore_blocktype, ei); |
3092 | 4604 #endif /* not NEW_GC */ |
428 | 4605 return 1; |
4606 } | |
4607 prev = ei; | |
4608 } | |
4609 return 0; | |
4610 } | |
4611 | |
4612 static void | |
4613 register_ignored_expose (struct frame* f, int x, int y, int width, int height) | |
4614 { | |
4615 if (!hold_ignored_expose_registration) | |
4616 { | |
4617 struct expose_ignore *ei; | |
440 | 4618 |
3092 | 4619 #ifdef NEW_GC |
4620 ei = alloc_lrecord_type (struct expose_ignore, &lrecord_expose_ignore); | |
4621 #else /* not NEW_GC */ | |
428 | 4622 ei = Blocktype_alloc (the_expose_ignore_blocktype); |
3092 | 4623 #endif /* not NEW_GC */ |
440 | 4624 |
428 | 4625 ei->next = NULL; |
4626 ei->x = x; | |
4627 ei->y = y; | |
4628 ei->width = width; | |
4629 ei->height = height; | |
440 | 4630 |
428 | 4631 /* we have to add the exposure to the end of the list, since we |
4632 want to check the oldest events first. for speed we keep a record | |
4633 of the end so that we can add right to it. */ | |
4634 if (f->subwindow_exposures_tail) | |
4635 { | |
4636 f->subwindow_exposures_tail->next = ei; | |
4637 } | |
4638 if (!f->subwindow_exposures) | |
4639 { | |
4640 f->subwindow_exposures = ei; | |
4641 } | |
4642 f->subwindow_exposures_tail = ei; | |
4643 } | |
4644 } | |
4645 | |
4646 /**************************************************************************** | |
4647 find_matching_subwindow | |
4648 | |
4649 See if there is a subwindow that completely encloses the requested | |
4650 area. | |
4651 ****************************************************************************/ | |
647 | 4652 int |
4653 find_matching_subwindow (struct frame* f, int x, int y, int width, int height) | |
428 | 4654 { |
442 | 4655 Lisp_Object rest; |
4656 | |
4657 LIST_LOOP (rest, XWEAK_LIST_LIST (FRAME_SUBWINDOW_CACHE (f))) | |
428 | 4658 { |
442 | 4659 Lisp_Image_Instance *ii = XIMAGE_INSTANCE (XCAR (rest)); |
4660 | |
4661 if (IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP (ii) | |
4662 && | |
4663 IMAGE_INSTANCE_DISPLAY_X (ii) <= x | |
428 | 4664 && |
442 | 4665 IMAGE_INSTANCE_DISPLAY_Y (ii) <= y |
440 | 4666 && |
442 | 4667 IMAGE_INSTANCE_DISPLAY_X (ii) |
4668 + IMAGE_INSTANCE_DISPLAY_WIDTH (ii) >= x + width | |
428 | 4669 && |
442 | 4670 IMAGE_INSTANCE_DISPLAY_Y (ii) |
4671 + IMAGE_INSTANCE_DISPLAY_HEIGHT (ii) >= y + height) | |
428 | 4672 { |
4673 return 1; | |
4674 } | |
4675 } | |
4676 return 0; | |
4677 } | |
4678 | |
4679 | |
4680 /***************************************************************************** | |
4681 * subwindow functions * | |
4682 *****************************************************************************/ | |
4683 | |
442 | 4684 /* Update the displayed characteristics of a subwindow. This function |
4685 should generally only get called if the subwindow is actually | |
4686 dirty. */ | |
4687 void | |
4688 redisplay_subwindow (Lisp_Object subwindow) | |
428 | 4689 { |
440 | 4690 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (subwindow); |
442 | 4691 int count = specpdl_depth (); |
4692 | |
4693 /* The update method is allowed to call eval. Since it is quite | |
4694 common for this function to get called from somewhere in | |
4695 redisplay we need to make sure that quits are ignored. Otherwise | |
4696 Fsignal will abort. */ | |
4697 specbind (Qinhibit_quit, Qt); | |
4698 | |
4699 ERROR_CHECK_IMAGE_INSTANCE (subwindow); | |
4700 | |
4701 if (WIDGET_IMAGE_INSTANCEP (subwindow)) | |
4702 { | |
4703 if (image_instance_changed (subwindow)) | |
4704 redisplay_widget (subwindow); | |
4705 /* Reset the changed flags. */ | |
4706 IMAGE_INSTANCE_WIDGET_FACE_CHANGED (ii) = 0; | |
4707 IMAGE_INSTANCE_WIDGET_ITEMS_CHANGED (ii) = 0; | |
4708 IMAGE_INSTANCE_WIDGET_ACTION_OCCURRED (ii) = 0; | |
4709 IMAGE_INSTANCE_TEXT_CHANGED (ii) = 0; | |
4710 } | |
4711 else if (IMAGE_INSTANCE_TYPE (ii) == IMAGE_SUBWINDOW | |
4712 && | |
4713 !NILP (IMAGE_INSTANCE_FRAME (ii))) | |
4714 { | |
4715 MAYBE_DEVMETH (DOMAIN_XDEVICE (ii->domain), | |
4716 redisplay_subwindow, (ii)); | |
4717 } | |
4718 | |
4719 IMAGE_INSTANCE_SIZE_CHANGED (ii) = 0; | |
4720 /* This function is typically called by redisplay just before | |
4721 outputting the information to the screen. Thus we record a hash | |
4722 of the output to determine whether on-screen is the same as | |
4723 recorded structure. This approach has limitations in there is a | |
4724 good chance that hash values will be different for the same | |
4725 visual appearance. However, we would rather that then the other | |
4726 way round - it simply means that we will get more displays than | |
4727 we might need. We can get better hashing by making the depth | |
4728 negative - currently it will recurse down 7 levels.*/ | |
4729 IMAGE_INSTANCE_DISPLAY_HASH (ii) = internal_hash (subwindow, | |
4730 IMAGE_INSTANCE_HASH_DEPTH); | |
4731 | |
771 | 4732 unbind_to (count); |
442 | 4733 } |
4734 | |
4735 /* Determine whether an image_instance has changed structurally and | |
4736 hence needs redisplaying in some way. | |
4737 | |
4738 #### This should just look at the instantiator differences when we | |
4739 get rid of the stored items altogether. In fact we should probably | |
4740 store the new instantiator as well as the old - as we do with | |
4741 gui_items currently - and then pick-up the new on the next | |
4742 redisplay. This would obviate the need for any of this trickery | |
4743 with hashcodes. */ | |
4744 int | |
4745 image_instance_changed (Lisp_Object subwindow) | |
4746 { | |
4747 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (subwindow); | |
4748 | |
4749 if (internal_hash (subwindow, IMAGE_INSTANCE_HASH_DEPTH) != | |
4750 IMAGE_INSTANCE_DISPLAY_HASH (ii)) | |
4751 return 1; | |
4752 /* #### I think there is probably a bug here. This gets called for | |
4753 layouts - and yet the pending items are always nil for | |
4754 layouts. We are saved by layout optimization, but I'm undecided | |
4755 as to what the correct fix is. */ | |
4756 else if (WIDGET_IMAGE_INSTANCEP (subwindow) | |
853 | 4757 && (!internal_equal_trapping_problems |
4758 (Qglyph, "bad subwindow instantiator", | |
4759 /* in this case we really don't want to be | |
4760 interrupted by QUIT because we care about | |
4761 the return value; and we know that any loops | |
4762 will ultimately cause errors to be issued. | |
4763 We specify a retval of 1 in that case so that | |
4764 the glyph code doesn't try to keep reoutputting | |
4765 a bad subwindow. */ | |
4766 INHIBIT_QUIT, 0, 1, IMAGE_INSTANCE_WIDGET_ITEMS (ii), | |
4767 IMAGE_INSTANCE_WIDGET_PENDING_ITEMS (ii), 0) | |
442 | 4768 || !NILP (IMAGE_INSTANCE_LAYOUT_CHILDREN (ii)) |
4769 || IMAGE_INSTANCE_WIDGET_ACTION_OCCURRED (ii))) | |
4770 return 1; | |
4771 else | |
4772 return 0; | |
428 | 4773 } |
4774 | |
438 | 4775 /* Update all the subwindows on a frame. */ |
428 | 4776 void |
442 | 4777 update_widget_instances (Lisp_Object frame) |
4778 { | |
4779 struct frame* f; | |
4780 Lisp_Object rest; | |
4781 | |
4782 /* Its possible for the preceding callback to have deleted the | |
4783 frame, so cope with this. */ | |
4784 if (!FRAMEP (frame) || !FRAME_LIVE_P (XFRAME (frame))) | |
4785 return; | |
4786 | |
4787 CHECK_FRAME (frame); | |
4788 f = XFRAME (frame); | |
4789 | |
4790 /* If we get called we know something has changed. */ | |
4791 LIST_LOOP (rest, XWEAK_LIST_LIST (FRAME_SUBWINDOW_CACHE (f))) | |
4792 { | |
4793 Lisp_Object widget = XCAR (rest); | |
4794 | |
4795 if (XIMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP (widget) | |
4796 && | |
4797 image_instance_changed (widget)) | |
4798 { | |
4799 set_image_instance_dirty_p (widget, 1); | |
4800 MARK_FRAME_GLYPHS_CHANGED (f); | |
4801 } | |
4802 } | |
428 | 4803 } |
4804 | |
4805 /* remove a subwindow from its frame */ | |
793 | 4806 void |
4807 unmap_subwindow (Lisp_Object subwindow) | |
428 | 4808 { |
440 | 4809 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (subwindow); |
428 | 4810 struct frame* f; |
4811 | |
442 | 4812 ERROR_CHECK_IMAGE_INSTANCE (subwindow); |
4813 | |
1204 | 4814 if (!(image_instance_type_to_mask (IMAGE_INSTANCE_TYPE (ii)) |
4815 & (IMAGE_WIDGET_MASK | IMAGE_SUBWINDOW_MASK)) | |
4816 || !IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP (ii)) | |
428 | 4817 return; |
442 | 4818 |
428 | 4819 #ifdef DEBUG_WIDGETS |
442 | 4820 stderr_out ("unmapping subwindow %p\n", IMAGE_INSTANCE_SUBWINDOW_ID (ii)); |
428 | 4821 #endif |
442 | 4822 f = XFRAME (IMAGE_INSTANCE_FRAME (ii)); |
428 | 4823 |
4824 /* make sure we don't get expose events */ | |
442 | 4825 register_ignored_expose (f, IMAGE_INSTANCE_DISPLAY_X (ii), |
4826 IMAGE_INSTANCE_DISPLAY_Y (ii), | |
4827 IMAGE_INSTANCE_DISPLAY_WIDTH (ii), | |
4252 | 4828 IMAGE_INSTANCE_DISPLAY_HEIGHT (ii)); |
428 | 4829 IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP (ii) = 0; |
4830 | |
442 | 4831 MAYBE_DEVMETH (XDEVICE (IMAGE_INSTANCE_DEVICE (ii)), |
4832 unmap_subwindow, (ii)); | |
428 | 4833 } |
4834 | |
4835 /* show a subwindow in its frame */ | |
793 | 4836 void |
4837 map_subwindow (Lisp_Object subwindow, int x, int y, | |
4838 struct display_glyph_area *dga) | |
428 | 4839 { |
440 | 4840 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (subwindow); |
428 | 4841 |
442 | 4842 ERROR_CHECK_IMAGE_INSTANCE (subwindow); |
4843 | |
1204 | 4844 if (!(image_instance_type_to_mask (IMAGE_INSTANCE_TYPE (ii)) |
4845 & (IMAGE_WIDGET_MASK | IMAGE_SUBWINDOW_MASK))) | |
428 | 4846 return; |
4847 | |
4848 #ifdef DEBUG_WIDGETS | |
442 | 4849 stderr_out ("mapping subwindow %p, %dx%d@%d+%d\n", |
428 | 4850 IMAGE_INSTANCE_SUBWINDOW_ID (ii), |
4851 dga->width, dga->height, x, y); | |
4852 #endif | |
2286 | 4853 /* Error check by side effect */ |
4854 (void) XFRAME (IMAGE_INSTANCE_FRAME (ii)); | |
442 | 4855 IMAGE_INSTANCE_DISPLAY_X (ii) = x; |
4856 IMAGE_INSTANCE_DISPLAY_Y (ii) = y; | |
4857 IMAGE_INSTANCE_DISPLAY_WIDTH (ii) = dga->width; | |
4858 IMAGE_INSTANCE_DISPLAY_HEIGHT (ii) = dga->height; | |
4859 | |
4860 MAYBE_DEVMETH (DOMAIN_XDEVICE (ii->domain), | |
4861 map_subwindow, (ii, x, y, dga)); | |
428 | 4862 IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP (ii) = 1; |
4863 } | |
4864 | |
4865 static int | |
4866 subwindow_possible_dest_types (void) | |
4867 { | |
4868 return IMAGE_SUBWINDOW_MASK; | |
4869 } | |
4870 | |
442 | 4871 int |
4872 subwindow_governing_domain (void) | |
4873 { | |
4874 return GOVERNING_DOMAIN_WINDOW; | |
4875 } | |
4876 | |
428 | 4877 /* Partially instantiate a subwindow. */ |
4878 void | |
4879 subwindow_instantiate (Lisp_Object image_instance, Lisp_Object instantiator, | |
2286 | 4880 Lisp_Object UNUSED (pointer_fg), |
4881 Lisp_Object UNUSED (pointer_bg), | |
428 | 4882 int dest_mask, Lisp_Object domain) |
4883 { | |
440 | 4884 Lisp_Image_Instance *ii = XIMAGE_INSTANCE (image_instance); |
442 | 4885 Lisp_Object device = image_instance_device (image_instance); |
4886 Lisp_Object frame = DOMAIN_FRAME (domain); | |
428 | 4887 Lisp_Object width = find_keyword_in_vector (instantiator, Q_pixel_width); |
4888 Lisp_Object height = find_keyword_in_vector (instantiator, Q_pixel_height); | |
4889 | |
4890 if (NILP (frame)) | |
563 | 4891 invalid_state ("No selected frame", device); |
440 | 4892 |
428 | 4893 if (!(dest_mask & IMAGE_SUBWINDOW_MASK)) |
4894 incompatible_image_types (instantiator, dest_mask, IMAGE_SUBWINDOW_MASK); | |
4895 | |
4896 ii->data = 0; | |
4897 IMAGE_INSTANCE_SUBWINDOW_ID (ii) = 0; | |
4898 IMAGE_INSTANCE_SUBWINDOW_DISPLAYEDP (ii) = 0; | |
442 | 4899 |
4900 if (INTP (width)) | |
428 | 4901 { |
4902 int w = 1; | |
4903 if (XINT (width) > 1) | |
4904 w = XINT (width); | |
442 | 4905 IMAGE_INSTANCE_WIDTH (ii) = w; |
4906 IMAGE_INSTANCE_SUBWINDOW_H_RESIZEP (ii) = 0; | |
428 | 4907 } |
442 | 4908 |
4909 if (INTP (height)) | |
428 | 4910 { |
4911 int h = 1; | |
4912 if (XINT (height) > 1) | |
4913 h = XINT (height); | |
442 | 4914 IMAGE_INSTANCE_HEIGHT (ii) = h; |
4915 IMAGE_INSTANCE_SUBWINDOW_V_RESIZEP (ii) = 0; | |
428 | 4916 } |
4917 } | |
4918 | |
442 | 4919 /* This is just a backup in case no-one has assigned a suitable geometry. |
4920 #### It should really query the enclose window for geometry. */ | |
4921 static void | |
2286 | 4922 subwindow_query_geometry (Lisp_Object UNUSED (image_instance), |
4923 int* width, int* height, | |
4924 enum image_instance_geometry UNUSED (disp), | |
4925 Lisp_Object UNUSED (domain)) | |
442 | 4926 { |
4927 if (width) *width = 20; | |
4928 if (height) *height = 20; | |
4929 } | |
4930 | |
428 | 4931 DEFUN ("subwindowp", Fsubwindowp, 1, 1, 0, /* |
4932 Return non-nil if OBJECT is a subwindow. | |
4933 */ | |
4934 (object)) | |
4935 { | |
4936 CHECK_IMAGE_INSTANCE (object); | |
4937 return (XIMAGE_INSTANCE_TYPE (object) == IMAGE_SUBWINDOW) ? Qt : Qnil; | |
4938 } | |
4939 | |
4940 DEFUN ("image-instance-subwindow-id", Fimage_instance_subwindow_id, 1, 1, 0, /* | |
4941 Return the window id of SUBWINDOW as a number. | |
4942 */ | |
4943 (subwindow)) | |
4944 { | |
4945 CHECK_SUBWINDOW_IMAGE_INSTANCE (subwindow); | |
442 | 4946 return make_int ((EMACS_INT) XIMAGE_INSTANCE_SUBWINDOW_ID (subwindow)); |
428 | 4947 } |
4948 | |
4949 DEFUN ("resize-subwindow", Fresize_subwindow, 1, 3, 0, /* | |
4950 Resize SUBWINDOW to WIDTH x HEIGHT. | |
4951 If a value is nil that parameter is not changed. | |
4952 */ | |
4953 (subwindow, width, height)) | |
4954 { | |
4955 int neww, newh; | |
442 | 4956 Lisp_Image_Instance* ii; |
428 | 4957 |
4958 CHECK_SUBWINDOW_IMAGE_INSTANCE (subwindow); | |
442 | 4959 ii = XIMAGE_INSTANCE (subwindow); |
428 | 4960 |
4961 if (NILP (width)) | |
442 | 4962 neww = IMAGE_INSTANCE_WIDTH (ii); |
428 | 4963 else |
4964 neww = XINT (width); | |
4965 | |
4966 if (NILP (height)) | |
442 | 4967 newh = IMAGE_INSTANCE_HEIGHT (ii); |
428 | 4968 else |
4969 newh = XINT (height); | |
4970 | |
442 | 4971 /* The actual resizing gets done asynchronously by |
438 | 4972 update_subwindow. */ |
442 | 4973 IMAGE_INSTANCE_HEIGHT (ii) = newh; |
4974 IMAGE_INSTANCE_WIDTH (ii) = neww; | |
4975 IMAGE_INSTANCE_SIZE_CHANGED (ii) = 1; | |
428 | 4976 |
4977 return subwindow; | |
4978 } | |
4979 | |
4980 DEFUN ("force-subwindow-map", Fforce_subwindow_map, 1, 1, 0, /* | |
4981 Generate a Map event for SUBWINDOW. | |
4982 */ | |
4983 (subwindow)) | |
4984 { | |
4985 CHECK_SUBWINDOW_IMAGE_INSTANCE (subwindow); | |
4986 #if 0 | |
4987 map_subwindow (subwindow, 0, 0); | |
4988 #endif | |
4989 return subwindow; | |
4990 } | |
4991 | |
4992 | |
4993 /***************************************************************************** | |
4994 * display tables * | |
4995 *****************************************************************************/ | |
4996 | |
4997 /* Get the display tables for use currently on window W with face | |
4998 FACE. #### This will have to be redone. */ | |
4999 | |
5000 void | |
5001 get_display_tables (struct window *w, face_index findex, | |
5002 Lisp_Object *face_table, Lisp_Object *window_table) | |
5003 { | |
5004 Lisp_Object tem; | |
5005 tem = WINDOW_FACE_CACHEL_DISPLAY_TABLE (w, findex); | |
5006 if (UNBOUNDP (tem)) | |
5007 tem = Qnil; | |
5008 if (!LISTP (tem)) | |
5009 tem = noseeum_cons (tem, Qnil); | |
5010 *face_table = tem; | |
5011 tem = w->display_table; | |
5012 if (UNBOUNDP (tem)) | |
5013 tem = Qnil; | |
5014 if (!LISTP (tem)) | |
5015 tem = noseeum_cons (tem, Qnil); | |
5016 *window_table = tem; | |
5017 } | |
5018 | |
5019 Lisp_Object | |
867 | 5020 display_table_entry (Ichar ch, Lisp_Object face_table, |
428 | 5021 Lisp_Object window_table) |
5022 { | |
5023 Lisp_Object tail; | |
5024 | |
5025 /* Loop over FACE_TABLE, and then over WINDOW_TABLE. */ | |
5026 for (tail = face_table; 1; tail = XCDR (tail)) | |
5027 { | |
5028 Lisp_Object table; | |
5029 if (NILP (tail)) | |
5030 { | |
5031 if (!NILP (window_table)) | |
5032 { | |
5033 tail = window_table; | |
5034 window_table = Qnil; | |
5035 } | |
5036 else | |
5037 return Qnil; | |
5038 } | |
5039 table = XCAR (tail); | |
5040 | |
5041 if (VECTORP (table)) | |
5042 { | |
5043 if (ch < XVECTOR_LENGTH (table) && !NILP (XVECTOR_DATA (table)[ch])) | |
5044 return XVECTOR_DATA (table)[ch]; | |
5045 else | |
5046 continue; | |
5047 } | |
5048 else if (CHAR_TABLEP (table) | |
5049 && XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_CHAR) | |
5050 { | |
826 | 5051 return get_char_table (ch, table); |
428 | 5052 } |
5053 else if (CHAR_TABLEP (table) | |
5054 && XCHAR_TABLE_TYPE (table) == CHAR_TABLE_TYPE_GENERIC) | |
5055 { | |
826 | 5056 Lisp_Object gotit = get_char_table (ch, table); |
428 | 5057 if (!NILP (gotit)) |
5058 return gotit; | |
5059 else | |
5060 continue; | |
5061 } | |
5062 else if (RANGE_TABLEP (table)) | |
5063 { | |
5064 Lisp_Object gotit = Fget_range_table (make_char (ch), table, Qnil); | |
5065 if (!NILP (gotit)) | |
5066 return gotit; | |
5067 else | |
5068 continue; | |
5069 } | |
5070 else | |
2500 | 5071 ABORT (); |
428 | 5072 } |
5073 } | |
5074 | |
793 | 5075 /**************************************************************************** |
5076 * timeouts for animated glyphs * | |
5077 ****************************************************************************/ | |
428 | 5078 static Lisp_Object Qglyph_animated_timeout_handler; |
5079 | |
5080 DEFUN ("glyph-animated-timeout-handler", Fglyph_animated_timeout_handler, 1, 1, 0, /* | |
5081 Callback function for updating animated images. | |
5082 Don't use this. | |
5083 */ | |
5084 (arg)) | |
5085 { | |
5086 CHECK_WEAK_LIST (arg); | |
5087 | |
5088 if (!NILP (XWEAK_LIST_LIST (arg)) && !NILP (XCAR (XWEAK_LIST_LIST (arg)))) | |
5089 { | |
5090 Lisp_Object value = XCAR (XWEAK_LIST_LIST (arg)); | |
440 | 5091 |
428 | 5092 if (IMAGE_INSTANCEP (value)) |
5093 { | |
440 | 5094 Lisp_Image_Instance* ii = XIMAGE_INSTANCE (value); |
428 | 5095 |
5096 if (COLOR_PIXMAP_IMAGE_INSTANCEP (value) | |
5097 && | |
5098 IMAGE_INSTANCE_PIXMAP_MAXSLICE (ii) > 1 | |
5099 && | |
5100 !disable_animated_pixmaps) | |
5101 { | |
5102 /* Increment the index of the image slice we are currently | |
5103 viewing. */ | |
4252 | 5104 IMAGE_INSTANCE_PIXMAP_SLICE (ii) = |
428 | 5105 (IMAGE_INSTANCE_PIXMAP_SLICE (ii) + 1) |
5106 % IMAGE_INSTANCE_PIXMAP_MAXSLICE (ii); | |
5107 /* We might need to kick redisplay at this point - but we | |
5108 also might not. */ | |
440 | 5109 MARK_DEVICE_FRAMES_GLYPHS_CHANGED |
442 | 5110 (XDEVICE (image_instance_device (value))); |
5111 /* Cascade dirtiness so that we can have an animated glyph in a layout | |
5112 for instance. */ | |
5113 set_image_instance_dirty_p (value, 1); | |
428 | 5114 } |
5115 } | |
5116 } | |
5117 return Qnil; | |
5118 } | |
5119 | |
793 | 5120 Lisp_Object |
5121 add_glyph_animated_timeout (EMACS_INT tickms, Lisp_Object image) | |
428 | 5122 { |
5123 Lisp_Object ret = Qnil; | |
5124 | |
5125 if (tickms > 0 && IMAGE_INSTANCEP (image)) | |
5126 { | |
5127 double ms = ((double)tickms) / 1000.0; | |
5128 struct gcpro gcpro1; | |
5129 Lisp_Object holder = make_weak_list (WEAK_LIST_SIMPLE); | |
5130 | |
5131 GCPRO1 (holder); | |
5132 XWEAK_LIST_LIST (holder) = Fcons (image, Qnil); | |
5133 | |
5134 ret = Fadd_timeout (make_float (ms), | |
5135 Qglyph_animated_timeout_handler, | |
5136 holder, make_float (ms)); | |
5137 | |
5138 UNGCPRO; | |
5139 } | |
5140 return ret; | |
5141 } | |
5142 | |
793 | 5143 void |
5144 disable_glyph_animated_timeout (int i) | |
5145 { | |
5146 Fdisable_timeout (make_int (i)); | |
428 | 5147 } |
5148 | |
5149 | |
5150 /***************************************************************************** | |
5151 * initialization * | |
5152 *****************************************************************************/ | |
5153 | |
5154 void | |
5155 syms_of_glyphs (void) | |
5156 { | |
442 | 5157 INIT_LRECORD_IMPLEMENTATION (glyph); |
5158 INIT_LRECORD_IMPLEMENTATION (image_instance); | |
5159 | |
428 | 5160 /* image instantiators */ |
5161 | |
5162 DEFSUBR (Fimage_instantiator_format_list); | |
5163 DEFSUBR (Fvalid_image_instantiator_format_p); | |
5164 DEFSUBR (Fset_console_type_image_conversion_list); | |
5165 DEFSUBR (Fconsole_type_image_conversion_list); | |
5166 | |
442 | 5167 DEFKEYWORD (Q_file); |
5168 DEFKEYWORD (Q_data); | |
5169 DEFKEYWORD (Q_face); | |
5170 DEFKEYWORD (Q_pixel_height); | |
5171 DEFKEYWORD (Q_pixel_width); | |
428 | 5172 |
5173 #ifdef HAVE_XPM | |
442 | 5174 DEFKEYWORD (Q_color_symbols); |
428 | 5175 #endif |
5176 #ifdef HAVE_WINDOW_SYSTEM | |
442 | 5177 DEFKEYWORD (Q_mask_file); |
5178 DEFKEYWORD (Q_mask_data); | |
5179 DEFKEYWORD (Q_hotspot_x); | |
5180 DEFKEYWORD (Q_hotspot_y); | |
5181 DEFKEYWORD (Q_foreground); | |
5182 DEFKEYWORD (Q_background); | |
428 | 5183 #endif |
5184 /* image specifiers */ | |
5185 | |
5186 DEFSUBR (Fimage_specifier_p); | |
5187 /* Qimage in general.c */ | |
5188 | |
5189 /* image instances */ | |
5190 | |
563 | 5191 DEFSYMBOL_MULTIWORD_PREDICATE (Qimage_instancep); |
428 | 5192 |
442 | 5193 DEFSYMBOL (Qnothing_image_instance_p); |
5194 DEFSYMBOL (Qtext_image_instance_p); | |
5195 DEFSYMBOL (Qmono_pixmap_image_instance_p); | |
5196 DEFSYMBOL (Qcolor_pixmap_image_instance_p); | |
5197 DEFSYMBOL (Qpointer_image_instance_p); | |
5198 DEFSYMBOL (Qwidget_image_instance_p); | |
5199 DEFSYMBOL (Qsubwindow_image_instance_p); | |
428 | 5200 |
5201 DEFSUBR (Fmake_image_instance); | |
5202 DEFSUBR (Fimage_instance_p); | |
5203 DEFSUBR (Fimage_instance_type); | |
5204 DEFSUBR (Fvalid_image_instance_type_p); | |
5205 DEFSUBR (Fimage_instance_type_list); | |
5206 DEFSUBR (Fimage_instance_name); | |
442 | 5207 DEFSUBR (Fimage_instance_domain); |
872 | 5208 DEFSUBR (Fimage_instance_instantiator); |
428 | 5209 DEFSUBR (Fimage_instance_string); |
5210 DEFSUBR (Fimage_instance_file_name); | |
5211 DEFSUBR (Fimage_instance_mask_file_name); | |
5212 DEFSUBR (Fimage_instance_depth); | |
5213 DEFSUBR (Fimage_instance_height); | |
5214 DEFSUBR (Fimage_instance_width); | |
5215 DEFSUBR (Fimage_instance_hotspot_x); | |
5216 DEFSUBR (Fimage_instance_hotspot_y); | |
5217 DEFSUBR (Fimage_instance_foreground); | |
5218 DEFSUBR (Fimage_instance_background); | |
5219 DEFSUBR (Fimage_instance_property); | |
5220 DEFSUBR (Fcolorize_image_instance); | |
5221 /* subwindows */ | |
5222 DEFSUBR (Fsubwindowp); | |
5223 DEFSUBR (Fimage_instance_subwindow_id); | |
5224 DEFSUBR (Fresize_subwindow); | |
5225 DEFSUBR (Fforce_subwindow_map); | |
5226 | |
5227 /* Qnothing defined as part of the "nothing" image-instantiator | |
5228 type. */ | |
5229 /* Qtext defined in general.c */ | |
442 | 5230 DEFSYMBOL (Qmono_pixmap); |
5231 DEFSYMBOL (Qcolor_pixmap); | |
428 | 5232 /* Qpointer defined in general.c */ |
5233 | |
5234 /* glyphs */ | |
5235 | |
442 | 5236 DEFSYMBOL (Qglyphp); |
5237 DEFSYMBOL (Qcontrib_p); | |
5238 DEFSYMBOL (Qbaseline); | |
5239 | |
5240 DEFSYMBOL (Qbuffer_glyph_p); | |
5241 DEFSYMBOL (Qpointer_glyph_p); | |
5242 DEFSYMBOL (Qicon_glyph_p); | |
5243 | |
5244 DEFSYMBOL (Qconst_glyph_variable); | |
428 | 5245 |
5246 DEFSUBR (Fglyph_type); | |
5247 DEFSUBR (Fvalid_glyph_type_p); | |
5248 DEFSUBR (Fglyph_type_list); | |
5249 DEFSUBR (Fglyphp); | |
5250 DEFSUBR (Fmake_glyph_internal); | |
5251 DEFSUBR (Fglyph_width); | |
5252 DEFSUBR (Fglyph_ascent); | |
5253 DEFSUBR (Fglyph_descent); | |
5254 DEFSUBR (Fglyph_height); | |
442 | 5255 DEFSUBR (Fset_instantiator_property); |
428 | 5256 |
5257 /* Qbuffer defined in general.c. */ | |
5258 /* Qpointer defined above */ | |
5259 | |
1204 | 5260 /* Unfortunately, timeout handlers must be lisp functions. This is |
428 | 5261 for animated glyphs. */ |
442 | 5262 DEFSYMBOL (Qglyph_animated_timeout_handler); |
428 | 5263 DEFSUBR (Fglyph_animated_timeout_handler); |
5264 | |
5265 /* Errors */ | |
563 | 5266 DEFERROR_STANDARD (Qimage_conversion_error, Qconversion_error); |
428 | 5267 } |
5268 | |
5269 void | |
5270 specifier_type_create_image (void) | |
5271 { | |
5272 /* image specifiers */ | |
5273 | |
5274 INITIALIZE_SPECIFIER_TYPE_WITH_DATA (image, "image", "imagep"); | |
5275 | |
5276 SPECIFIER_HAS_METHOD (image, create); | |
5277 SPECIFIER_HAS_METHOD (image, mark); | |
5278 SPECIFIER_HAS_METHOD (image, instantiate); | |
5279 SPECIFIER_HAS_METHOD (image, validate); | |
5280 SPECIFIER_HAS_METHOD (image, after_change); | |
5281 SPECIFIER_HAS_METHOD (image, going_to_add); | |
434 | 5282 SPECIFIER_HAS_METHOD (image, copy_instantiator); |
428 | 5283 } |
5284 | |
5285 void | |
5286 reinit_specifier_type_create_image (void) | |
5287 { | |
5288 REINITIALIZE_SPECIFIER_TYPE (image); | |
5289 } | |
5290 | |
5291 | |
1204 | 5292 static const struct memory_description iike_description_1[] = { |
440 | 5293 { XD_LISP_OBJECT, offsetof (ii_keyword_entry, keyword) }, |
428 | 5294 { XD_END } |
5295 }; | |
5296 | |
1204 | 5297 static const struct sized_memory_description iike_description = { |
440 | 5298 sizeof (ii_keyword_entry), |
428 | 5299 iike_description_1 |
5300 }; | |
5301 | |
1204 | 5302 static const struct memory_description iiked_description_1[] = { |
440 | 5303 XD_DYNARR_DESC (ii_keyword_entry_dynarr, &iike_description), |
428 | 5304 { XD_END } |
5305 }; | |
5306 | |
1204 | 5307 static const struct sized_memory_description iiked_description = { |
440 | 5308 sizeof (ii_keyword_entry_dynarr), |
428 | 5309 iiked_description_1 |
5310 }; | |
5311 | |
1204 | 5312 static const struct memory_description iife_description_1[] = { |
440 | 5313 { XD_LISP_OBJECT, offsetof (image_instantiator_format_entry, symbol) }, |
5314 { XD_LISP_OBJECT, offsetof (image_instantiator_format_entry, device) }, | |
2551 | 5315 { XD_BLOCK_PTR, offsetof (image_instantiator_format_entry, meths), 1, |
5316 { &iim_description } }, | |
428 | 5317 { XD_END } |
5318 }; | |
5319 | |
1204 | 5320 static const struct sized_memory_description iife_description = { |
440 | 5321 sizeof (image_instantiator_format_entry), |
428 | 5322 iife_description_1 |
5323 }; | |
5324 | |
1204 | 5325 static const struct memory_description iifed_description_1[] = { |
440 | 5326 XD_DYNARR_DESC (image_instantiator_format_entry_dynarr, &iife_description), |
428 | 5327 { XD_END } |
5328 }; | |
5329 | |
1204 | 5330 static const struct sized_memory_description iifed_description = { |
440 | 5331 sizeof (image_instantiator_format_entry_dynarr), |
428 | 5332 iifed_description_1 |
5333 }; | |
5334 | |
1204 | 5335 static const struct memory_description iim_description_1[] = { |
440 | 5336 { XD_LISP_OBJECT, offsetof (struct image_instantiator_methods, symbol) }, |
5337 { XD_LISP_OBJECT, offsetof (struct image_instantiator_methods, device) }, | |
2551 | 5338 { XD_BLOCK_PTR, offsetof (struct image_instantiator_methods, keywords), 1, |
5339 { &iiked_description } }, | |
5340 { XD_BLOCK_PTR, offsetof (struct image_instantiator_methods, consoles), 1, | |
5341 { &cted_description } }, | |
428 | 5342 { XD_END } |
5343 }; | |
5344 | |
1204 | 5345 const struct sized_memory_description iim_description = { |
442 | 5346 sizeof (struct image_instantiator_methods), |
428 | 5347 iim_description_1 |
5348 }; | |
5349 | |
5350 void | |
5351 image_instantiator_format_create (void) | |
5352 { | |
5353 /* image instantiators */ | |
5354 | |
5355 the_image_instantiator_format_entry_dynarr = | |
5356 Dynarr_new (image_instantiator_format_entry); | |
5357 | |
5358 Vimage_instantiator_format_list = Qnil; | |
5359 staticpro (&Vimage_instantiator_format_list); | |
5360 | |
2367 | 5361 dump_add_root_block_ptr (&the_image_instantiator_format_entry_dynarr, &iifed_description); |
428 | 5362 |
5363 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (nothing, "nothing"); | |
5364 | |
5365 IIFORMAT_HAS_METHOD (nothing, possible_dest_types); | |
5366 IIFORMAT_HAS_METHOD (nothing, instantiate); | |
5367 | |
5368 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (inherit, "inherit"); | |
5369 | |
5370 IIFORMAT_HAS_METHOD (inherit, validate); | |
5371 IIFORMAT_HAS_METHOD (inherit, normalize); | |
5372 IIFORMAT_HAS_METHOD (inherit, possible_dest_types); | |
5373 IIFORMAT_HAS_METHOD (inherit, instantiate); | |
5374 | |
5375 IIFORMAT_VALID_KEYWORD (inherit, Q_face, check_valid_face); | |
5376 | |
5377 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (string, "string"); | |
5378 | |
5379 IIFORMAT_HAS_METHOD (string, validate); | |
442 | 5380 IIFORMAT_HAS_SHARED_METHOD (string, governing_domain, subwindow); |
428 | 5381 IIFORMAT_HAS_METHOD (string, possible_dest_types); |
5382 IIFORMAT_HAS_METHOD (string, instantiate); | |
5383 | |
5384 IIFORMAT_VALID_KEYWORD (string, Q_data, check_valid_string); | |
5385 /* Do this so we can set strings. */ | |
442 | 5386 /* #### Andy, what is this? This is a bogus format and should not be |
5387 visible to the user. */ | |
428 | 5388 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (text, "text"); |
442 | 5389 IIFORMAT_HAS_METHOD (text, update); |
438 | 5390 IIFORMAT_HAS_METHOD (text, query_geometry); |
428 | 5391 |
5392 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (formatted_string, "formatted-string"); | |
5393 | |
5394 IIFORMAT_HAS_METHOD (formatted_string, validate); | |
5395 IIFORMAT_HAS_METHOD (formatted_string, possible_dest_types); | |
5396 IIFORMAT_HAS_METHOD (formatted_string, instantiate); | |
5397 IIFORMAT_VALID_KEYWORD (formatted_string, Q_data, check_valid_string); | |
5398 | |
442 | 5399 /* Do this so pointers have geometry. */ |
5400 /* #### Andy, what is this? This is a bogus format and should not be | |
5401 visible to the user. */ | |
5402 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (pointer, "pointer"); | |
5403 IIFORMAT_HAS_SHARED_METHOD (pointer, query_geometry, subwindow); | |
5404 | |
428 | 5405 /* subwindows */ |
5406 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (subwindow, "subwindow"); | |
5407 IIFORMAT_HAS_METHOD (subwindow, possible_dest_types); | |
442 | 5408 IIFORMAT_HAS_METHOD (subwindow, governing_domain); |
428 | 5409 IIFORMAT_HAS_METHOD (subwindow, instantiate); |
442 | 5410 IIFORMAT_HAS_METHOD (subwindow, query_geometry); |
428 | 5411 IIFORMAT_VALID_KEYWORD (subwindow, Q_pixel_width, check_valid_int); |
5412 IIFORMAT_VALID_KEYWORD (subwindow, Q_pixel_height, check_valid_int); | |
5413 | |
5414 #ifdef HAVE_WINDOW_SYSTEM | |
5415 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (xbm, "xbm"); | |
5416 | |
5417 IIFORMAT_HAS_METHOD (xbm, validate); | |
5418 IIFORMAT_HAS_METHOD (xbm, normalize); | |
5419 IIFORMAT_HAS_METHOD (xbm, possible_dest_types); | |
5420 | |
5421 IIFORMAT_VALID_KEYWORD (xbm, Q_data, check_valid_xbm_inline); | |
5422 IIFORMAT_VALID_KEYWORD (xbm, Q_file, check_valid_string); | |
5423 IIFORMAT_VALID_KEYWORD (xbm, Q_mask_data, check_valid_xbm_inline); | |
5424 IIFORMAT_VALID_KEYWORD (xbm, Q_mask_file, check_valid_string); | |
5425 IIFORMAT_VALID_KEYWORD (xbm, Q_hotspot_x, check_valid_int); | |
5426 IIFORMAT_VALID_KEYWORD (xbm, Q_hotspot_y, check_valid_int); | |
5427 IIFORMAT_VALID_KEYWORD (xbm, Q_foreground, check_valid_string); | |
5428 IIFORMAT_VALID_KEYWORD (xbm, Q_background, check_valid_string); | |
5429 #endif /* HAVE_WINDOW_SYSTEM */ | |
5430 | |
5431 #ifdef HAVE_XFACE | |
5432 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (xface, "xface"); | |
5433 | |
5434 IIFORMAT_HAS_METHOD (xface, validate); | |
5435 IIFORMAT_HAS_METHOD (xface, normalize); | |
5436 IIFORMAT_HAS_METHOD (xface, possible_dest_types); | |
5437 | |
5438 IIFORMAT_VALID_KEYWORD (xface, Q_data, check_valid_string); | |
5439 IIFORMAT_VALID_KEYWORD (xface, Q_file, check_valid_string); | |
2959 | 5440 IIFORMAT_VALID_KEYWORD (xface, Q_mask_data, check_valid_xbm_inline); |
5441 IIFORMAT_VALID_KEYWORD (xface, Q_mask_file, check_valid_string); | |
428 | 5442 IIFORMAT_VALID_KEYWORD (xface, Q_hotspot_x, check_valid_int); |
5443 IIFORMAT_VALID_KEYWORD (xface, Q_hotspot_y, check_valid_int); | |
5444 IIFORMAT_VALID_KEYWORD (xface, Q_foreground, check_valid_string); | |
5445 IIFORMAT_VALID_KEYWORD (xface, Q_background, check_valid_string); | |
5446 #endif | |
5447 | |
5448 #ifdef HAVE_XPM | |
5449 INITIALIZE_IMAGE_INSTANTIATOR_FORMAT (xpm, "xpm"); | |
5450 | |
5451 IIFORMAT_HAS_METHOD (xpm, validate); | |
5452 IIFORMAT_HAS_METHOD (xpm, normalize); | |
5453 IIFORMAT_HAS_METHOD (xpm, possible_dest_types); | |
5454 | |
5455 IIFORMAT_VALID_KEYWORD (xpm, Q_data, check_valid_string); | |
5456 IIFORMAT_VALID_KEYWORD (xpm, Q_file, check_valid_string); | |
5457 IIFORMAT_VALID_KEYWORD (xpm, Q_color_symbols, check_valid_xpm_color_symbols); | |
5458 #endif /* HAVE_XPM */ | |
5459 } | |
5460 | |
5461 void | |
5462 reinit_vars_of_glyphs (void) | |
5463 { | |
3092 | 5464 #ifndef NEW_GC |
428 | 5465 the_expose_ignore_blocktype = |
5466 Blocktype_new (struct expose_ignore_blocktype); | |
3092 | 5467 #endif /* not NEW_GC */ |
428 | 5468 |
5469 hold_ignored_expose_registration = 0; | |
5470 } | |
5471 | |
5472 | |
5473 void | |
5474 vars_of_glyphs (void) | |
5475 { | |
5476 Vthe_nothing_vector = vector1 (Qnothing); | |
5477 staticpro (&Vthe_nothing_vector); | |
5478 | |
5479 /* image instances */ | |
5480 | |
440 | 5481 Vimage_instance_type_list = Fcons (Qnothing, |
5482 list6 (Qtext, Qmono_pixmap, Qcolor_pixmap, | |
428 | 5483 Qpointer, Qsubwindow, Qwidget)); |
5484 staticpro (&Vimage_instance_type_list); | |
5485 | |
5486 /* glyphs */ | |
5487 | |
5488 Vglyph_type_list = list3 (Qbuffer, Qpointer, Qicon); | |
5489 staticpro (&Vglyph_type_list); | |
5490 | |
5491 #ifdef HAVE_WINDOW_SYSTEM | |
5492 Fprovide (Qxbm); | |
5493 #endif | |
5494 #ifdef HAVE_XPM | |
5495 Fprovide (Qxpm); | |
5496 | |
5497 DEFVAR_LISP ("xpm-color-symbols", &Vxpm_color_symbols /* | |
5498 Definitions of logical color-names used when reading XPM files. | |
5499 Elements of this list should be of the form (COLOR-NAME FORM-TO-EVALUATE). | |
5500 The COLOR-NAME should be a string, which is the name of the color to define; | |
5501 the FORM should evaluate to a `color' specifier object, or a string to be | |
5502 passed to `make-color-instance'. If a loaded XPM file references a symbolic | |
5503 color called COLOR-NAME, it will display as the computed color instead. | |
5504 | |
5505 The default value of this variable defines the logical color names | |
5506 \"foreground\" and \"background\" to be the colors of the `default' face. | |
5507 */ ); | |
5508 Vxpm_color_symbols = Qnil; /* initialized in x-faces.el */ | |
5509 #endif /* HAVE_XPM */ | |
5510 #ifdef HAVE_XFACE | |
5511 Fprovide (Qxface); | |
5512 #endif | |
5513 | |
5514 DEFVAR_BOOL ("disable-animated-pixmaps", &disable_animated_pixmaps /* | |
5515 Whether animated pixmaps should be animated. | |
5516 Default is t. | |
5517 */); | |
5518 disable_animated_pixmaps = 0; | |
5519 } | |
5520 | |
5521 void | |
5522 specifier_vars_of_glyphs (void) | |
5523 { | |
5524 /* #### Can we GC here? The set_specifier_* calls definitely need */ | |
5525 /* protection. */ | |
5526 /* display tables */ | |
5527 | |
5528 DEFVAR_SPECIFIER ("current-display-table", &Vcurrent_display_table /* | |
5529 *The display table currently in use. | |
5530 This is a specifier; use `set-specifier' to change it. | |
442 | 5531 |
5532 Display tables are used to control how characters are displayed. Each | |
5533 time that redisplay processes a character, it is looked up in all the | |
5534 display tables that apply (obtained by calling `specifier-instance' on | |
5535 `current-display-table' and any overriding display tables specified in | |
5536 currently active faces). The first entry found that matches the | |
5537 character determines how the character is displayed. If there is no | |
5538 matching entry, the default display method is used. (Non-control | |
5539 characters are displayed as themselves and control characters are | |
5540 displayed according to the buffer-local variable `ctl-arrow'. Control | |
5541 characters are further affected by `control-arrow-glyph' and | |
5542 `octal-escape-glyph'.) | |
5543 | |
5544 Each instantiator in this specifier and the display-table specifiers | |
5545 in faces is a display table or a list of such tables. If a list, each | |
5546 table will be searched in turn for an entry matching a particular | |
5547 character. Each display table is one of | |
5548 | |
5549 -- a vector, specifying values for characters starting at 0 | |
5550 -- a char table, either of type `char' or `generic' | |
5551 -- a range table | |
5552 | |
5553 Each entry in a display table should be one of | |
5554 | |
5555 -- nil (this entry is ignored and the search continues) | |
5556 -- a character (use this character; if it happens to be the same as | |
5557 the original character, default processing happens, otherwise | |
5558 redisplay attempts to display this character directly; | |
5559 #### At some point recursive display-table lookup will be | |
5560 implemented.) | |
5561 -- a string (display each character in the string directly; | |
5562 #### At some point recursive display-table lookup will be | |
5563 implemented.) | |
5564 -- a glyph (display the glyph; | |
5565 #### At some point recursive display-table lookup will be | |
5566 implemented when a string glyph is being processed.) | |
5567 -- a cons of the form (format "STRING") where STRING is a printf-like | |
5568 spec used to process the character. #### Unfortunately no | |
5569 formatting directives other than %% are implemented. | |
5570 -- a vector (each element of the vector is processed recursively; | |
5571 in such a case, nil elements in the vector are simply ignored) | |
5572 | |
5573 #### At some point in the near future, display tables are likely to | |
5574 be expanded to include other features, such as referencing characters | |
5575 in particular fonts and allowing the character search to continue | |
5576 all the way up the chain of specifier instantiators. These features | |
5577 are necessary to properly display Unicode characters. | |
428 | 5578 */ ); |
5579 Vcurrent_display_table = Fmake_specifier (Qdisplay_table); | |
5580 set_specifier_fallback (Vcurrent_display_table, | |
5581 list1 (Fcons (Qnil, Qnil))); | |
5582 set_specifier_caching (Vcurrent_display_table, | |
438 | 5583 offsetof (struct window, display_table), |
428 | 5584 some_window_value_changed, |
444 | 5585 0, 0, 0); |
428 | 5586 } |
5587 | |
5588 void | |
5589 complex_vars_of_glyphs (void) | |
5590 { | |
5591 /* Partially initialized in glyphs-x.c, glyphs.el */ | |
5592 DEFVAR_LISP ("truncation-glyph", &Vtruncation_glyph /* | |
5593 What to display at the end of truncated lines. | |
5594 */ ); | |
5595 Vtruncation_glyph = allocate_glyph (GLYPH_BUFFER, redisplay_glyph_changed); | |
5596 | |
5597 /* Partially initialized in glyphs-x.c, glyphs.el */ | |
5598 DEFVAR_LISP ("continuation-glyph", &Vcontinuation_glyph /* | |
5599 What to display at the end of wrapped lines. | |
5600 */ ); | |
5601 Vcontinuation_glyph = allocate_glyph (GLYPH_BUFFER, redisplay_glyph_changed); | |
5602 | |
2367 | 5603 /* The octal-escape glyph, control-arrow-glyph and |
5604 invisible-text-glyph are completely initialized in glyphs.el */ | |
5605 | |
5606 DEFVAR_LISP ("octal-escape-glyph", &Voctal_escape_glyph /* | |
5607 What to prefix character codes displayed in octal with. | |
5608 */); | |
5609 Voctal_escape_glyph = allocate_glyph (GLYPH_BUFFER, redisplay_glyph_changed); | |
5610 | |
5611 DEFVAR_LISP ("control-arrow-glyph", &Vcontrol_arrow_glyph /* | |
5612 What to use as an arrow for control characters. | |
5613 */); | |
5614 Vcontrol_arrow_glyph = allocate_glyph (GLYPH_BUFFER, | |
5615 redisplay_glyph_changed); | |
5616 | |
5617 DEFVAR_LISP ("invisible-text-glyph", &Vinvisible_text_glyph /* | |
5618 What to use to indicate the presence of invisible text. | |
5619 This is the glyph that is displayed when an ellipsis is called for | |
5620 \(see `selective-display-ellipses' and `buffer-invisibility-spec'). | |
5621 Normally this is three dots ("..."). | |
5622 */); | |
5623 Vinvisible_text_glyph = allocate_glyph (GLYPH_BUFFER, | |
5624 redisplay_glyph_changed); | |
5625 | |
5626 /* Partially initialized in glyphs.el */ | |
5627 DEFVAR_LISP ("hscroll-glyph", &Vhscroll_glyph /* | |
5628 What to display at the beginning of horizontally scrolled lines. | |
5629 */); | |
5630 Vhscroll_glyph = allocate_glyph (GLYPH_BUFFER, redisplay_glyph_changed); | |
5631 | |
428 | 5632 /* Partially initialized in glyphs-x.c, glyphs.el */ |
5633 DEFVAR_LISP ("xemacs-logo", &Vxemacs_logo /* | |
5634 The glyph used to display the XEmacs logo at startup. | |
5635 */ ); | |
5636 Vxemacs_logo = allocate_glyph (GLYPH_BUFFER, 0); | |
5637 } |