Merge changes from emacs-23 branch
[bpt/emacs.git] / src / image.c
1 /* Functions for image support on window system.
2 Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 Free Software Foundation, Inc.
5
6 This file is part of GNU Emacs.
7
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <math.h>
24 #include <ctype.h>
25
26 #ifdef HAVE_UNISTD_H
27 #include <unistd.h>
28 #endif
29
30 #ifdef HAVE_PNG
31 #if defined HAVE_LIBPNG_PNG_H
32 # include <libpng/png.h>
33 #else
34 # include <png.h>
35 #endif
36 #endif
37
38 #include <setjmp.h>
39
40 /* This makes the fields of a Display accessible, in Xlib header files. */
41
42 #define XLIB_ILLEGAL_ACCESS
43
44 #include "lisp.h"
45 #include "frame.h"
46 #include "window.h"
47 #include "dispextern.h"
48 #include "blockinput.h"
49 #include "systime.h"
50 #include <epaths.h>
51 #include "character.h"
52 #include "coding.h"
53 #include "termhooks.h"
54 #include "font.h"
55
56 #ifdef HAVE_X_WINDOWS
57 #include "xterm.h"
58 #include <sys/types.h>
59 #include <sys/stat.h>
60
61 #define COLOR_TABLE_SUPPORT 1
62
63 typedef struct x_bitmap_record Bitmap_Record;
64 #define GET_PIXEL(ximg, x, y) XGetPixel(ximg, x, y)
65 #define NO_PIXMAP None
66
67 #define RGB_PIXEL_COLOR unsigned long
68
69 #define PIX_MASK_RETAIN 0
70 #define PIX_MASK_DRAW 1
71 #endif /* HAVE_X_WINDOWS */
72
73
74 #ifdef HAVE_NTGUI
75 #include "w32term.h"
76
77 /* W32_TODO : Color tables on W32. */
78 #undef COLOR_TABLE_SUPPORT
79
80 typedef struct w32_bitmap_record Bitmap_Record;
81 #define GET_PIXEL(ximg, x, y) GetPixel(ximg, x, y)
82 #define NO_PIXMAP 0
83
84 #define RGB_PIXEL_COLOR COLORREF
85
86 #define PIX_MASK_RETAIN 0
87 #define PIX_MASK_DRAW 1
88
89 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
90 #define x_defined_color w32_defined_color
91 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
92
93 /* Functions from w32term.c that depend on XColor (so can't go in w32term.h
94 without modifying lots of files). */
95 extern void x_query_colors (struct frame *f, XColor *colors, int ncolors);
96 extern void x_query_color (struct frame *f, XColor *color);
97 #endif /* HAVE_NTGUI */
98
99 #ifdef HAVE_NS
100 #include "nsterm.h"
101 #include <sys/types.h>
102 #include <sys/stat.h>
103
104 #undef COLOR_TABLE_SUPPORT
105
106 typedef struct ns_bitmap_record Bitmap_Record;
107
108 #define GET_PIXEL(ximg, x, y) XGetPixel(ximg, x, y)
109 #define NO_PIXMAP 0
110
111 #define RGB_PIXEL_COLOR unsigned long
112 #define ZPixmap 0
113
114 #define PIX_MASK_RETAIN 0
115 #define PIX_MASK_DRAW 1
116
117 #define FRAME_X_VISUAL FRAME_NS_DISPLAY_INFO(f)->visual
118 #define x_defined_color(f, name, color_def, alloc) \
119 ns_defined_color (f, name, color_def, alloc, 0)
120 #define FRAME_X_SCREEN(f) 0
121 #define DefaultDepthOfScreen(screen) x_display_list->n_planes
122 #endif /* HAVE_NS */
123
124
125 /* Search path for bitmap files. */
126
127 Lisp_Object Vx_bitmap_file_path;
128
129 /* The symbol `postscript' identifying images of this type. */
130
131 Lisp_Object Qpostscript;
132
133 static void x_disable_image (struct frame *, struct image *);
134 static void x_edge_detection (struct frame *, struct image *, Lisp_Object,
135 Lisp_Object);
136
137 static void init_color_table (void);
138 static unsigned long lookup_rgb_color (struct frame *f, int r, int g, int b);
139 #ifdef COLOR_TABLE_SUPPORT
140 static void free_color_table (void);
141 static unsigned long *colors_in_color_table (int *n);
142 static unsigned long lookup_pixel_color (struct frame *f, unsigned long p);
143 #endif
144
145 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
146 id, which is just an int that this section returns. Bitmaps are
147 reference counted so they can be shared among frames.
148
149 Bitmap indices are guaranteed to be > 0, so a negative number can
150 be used to indicate no bitmap.
151
152 If you use x_create_bitmap_from_data, then you must keep track of
153 the bitmaps yourself. That is, creating a bitmap from the same
154 data more than once will not be caught. */
155
156 #ifdef HAVE_NS
157 XImagePtr
158 XGetImage (Display *display, Pixmap pixmap, int x, int y,
159 unsigned int width, unsigned int height,
160 unsigned long plane_mask, int format)
161 {
162 /* TODO: not sure what this function is supposed to do.. */
163 ns_retain_object (pixmap);
164 return pixmap;
165 }
166
167 /* use with imgs created by ns_image_for_XPM */
168 unsigned long
169 XGetPixel (XImagePtr ximage, int x, int y)
170 {
171 return ns_get_pixel (ximage, x, y);
172 }
173
174 /* use with imgs created by ns_image_for_XPM; alpha set to 1;
175 pixel is assumed to be in form RGB */
176 void
177 XPutPixel (XImagePtr ximage, int x, int y, unsigned long pixel)
178 {
179 ns_put_pixel (ximage, x, y, pixel);
180 }
181 #endif /* HAVE_NS */
182
183
184 /* Functions to access the contents of a bitmap, given an id. */
185
186 int
187 x_bitmap_height (FRAME_PTR f, int id)
188 {
189 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].height;
190 }
191
192 int
193 x_bitmap_width (FRAME_PTR f, int id)
194 {
195 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].width;
196 }
197
198 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
199 int
200 x_bitmap_pixmap (FRAME_PTR f, int id)
201 {
202 return (int) FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].pixmap;
203 }
204 #endif
205
206 #ifdef HAVE_X_WINDOWS
207 int
208 x_bitmap_mask (FRAME_PTR f, int id)
209 {
210 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].mask;
211 }
212 #endif
213
214 /* Allocate a new bitmap record. Returns index of new record. */
215
216 static int
217 x_allocate_bitmap_record (FRAME_PTR f)
218 {
219 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
220 int i;
221
222 if (dpyinfo->bitmaps == NULL)
223 {
224 dpyinfo->bitmaps_size = 10;
225 dpyinfo->bitmaps
226 = (Bitmap_Record *) xmalloc (dpyinfo->bitmaps_size * sizeof (Bitmap_Record));
227 dpyinfo->bitmaps_last = 1;
228 return 1;
229 }
230
231 if (dpyinfo->bitmaps_last < dpyinfo->bitmaps_size)
232 return ++dpyinfo->bitmaps_last;
233
234 for (i = 0; i < dpyinfo->bitmaps_size; ++i)
235 if (dpyinfo->bitmaps[i].refcount == 0)
236 return i + 1;
237
238 dpyinfo->bitmaps_size *= 2;
239 dpyinfo->bitmaps
240 = (Bitmap_Record *) xrealloc (dpyinfo->bitmaps,
241 dpyinfo->bitmaps_size * sizeof (Bitmap_Record));
242 return ++dpyinfo->bitmaps_last;
243 }
244
245 /* Add one reference to the reference count of the bitmap with id ID. */
246
247 void
248 x_reference_bitmap (FRAME_PTR f, int id)
249 {
250 ++FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].refcount;
251 }
252
253 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
254
255 int
256 x_create_bitmap_from_data (struct frame *f, char *bits, unsigned int width, unsigned int height)
257 {
258 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
259 int id;
260
261 #ifdef HAVE_X_WINDOWS
262 Pixmap bitmap;
263 bitmap = XCreateBitmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
264 bits, width, height);
265 if (! bitmap)
266 return -1;
267 #endif /* HAVE_X_WINDOWS */
268
269 #ifdef HAVE_NTGUI
270 Pixmap bitmap;
271 bitmap = CreateBitmap (width, height,
272 FRAME_X_DISPLAY_INFO (XFRAME (frame))->n_planes,
273 FRAME_X_DISPLAY_INFO (XFRAME (frame))->n_cbits,
274 bits);
275 if (! bitmap)
276 return -1;
277 #endif /* HAVE_NTGUI */
278
279 #ifdef HAVE_NS
280 void *bitmap = ns_image_from_XBM (bits, width, height);
281 if (!bitmap)
282 return -1;
283 #endif
284
285 id = x_allocate_bitmap_record (f);
286
287 #ifdef HAVE_NS
288 dpyinfo->bitmaps[id - 1].img = bitmap;
289 dpyinfo->bitmaps[id - 1].depth = 1;
290 #endif
291
292 dpyinfo->bitmaps[id - 1].file = NULL;
293 dpyinfo->bitmaps[id - 1].height = height;
294 dpyinfo->bitmaps[id - 1].width = width;
295 dpyinfo->bitmaps[id - 1].refcount = 1;
296
297 #ifdef HAVE_X_WINDOWS
298 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
299 dpyinfo->bitmaps[id - 1].have_mask = 0;
300 dpyinfo->bitmaps[id - 1].depth = 1;
301 #endif /* HAVE_X_WINDOWS */
302
303 #ifdef HAVE_NTGUI
304 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
305 dpyinfo->bitmaps[id - 1].hinst = NULL;
306 dpyinfo->bitmaps[id - 1].depth = 1;
307 #endif /* HAVE_NTGUI */
308
309 return id;
310 }
311
312 /* Create bitmap from file FILE for frame F. */
313
314 int
315 x_create_bitmap_from_file (struct frame *f, Lisp_Object file)
316 {
317 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
318
319 #ifdef HAVE_NTGUI
320 return -1; /* W32_TODO : bitmap support */
321 #endif /* HAVE_NTGUI */
322
323 #ifdef HAVE_NS
324 int id;
325 void *bitmap = ns_image_from_file (file);
326
327 if (!bitmap)
328 return -1;
329
330
331 id = x_allocate_bitmap_record (f);
332 dpyinfo->bitmaps[id - 1].img = bitmap;
333 dpyinfo->bitmaps[id - 1].refcount = 1;
334 dpyinfo->bitmaps[id - 1].file = (char *) xmalloc (SBYTES (file) + 1);
335 dpyinfo->bitmaps[id - 1].depth = 1;
336 dpyinfo->bitmaps[id - 1].height = ns_image_width (bitmap);
337 dpyinfo->bitmaps[id - 1].width = ns_image_height (bitmap);
338 strcpy (dpyinfo->bitmaps[id - 1].file, SDATA (file));
339 return id;
340 #endif
341
342 #ifdef HAVE_X_WINDOWS
343 unsigned int width, height;
344 Pixmap bitmap;
345 int xhot, yhot, result, id;
346 Lisp_Object found;
347 int fd;
348 char *filename;
349
350 /* Look for an existing bitmap with the same name. */
351 for (id = 0; id < dpyinfo->bitmaps_last; ++id)
352 {
353 if (dpyinfo->bitmaps[id].refcount
354 && dpyinfo->bitmaps[id].file
355 && !strcmp (dpyinfo->bitmaps[id].file, (char *) SDATA (file)))
356 {
357 ++dpyinfo->bitmaps[id].refcount;
358 return id + 1;
359 }
360 }
361
362 /* Search bitmap-file-path for the file, if appropriate. */
363 fd = openp (Vx_bitmap_file_path, file, Qnil, &found, Qnil);
364 if (fd < 0)
365 return -1;
366 emacs_close (fd);
367
368 filename = (char *) SDATA (found);
369
370 result = XReadBitmapFile (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
371 filename, &width, &height, &bitmap, &xhot, &yhot);
372 if (result != BitmapSuccess)
373 return -1;
374
375 id = x_allocate_bitmap_record (f);
376 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
377 dpyinfo->bitmaps[id - 1].have_mask = 0;
378 dpyinfo->bitmaps[id - 1].refcount = 1;
379 dpyinfo->bitmaps[id - 1].file = (char *) xmalloc (SBYTES (file) + 1);
380 dpyinfo->bitmaps[id - 1].depth = 1;
381 dpyinfo->bitmaps[id - 1].height = height;
382 dpyinfo->bitmaps[id - 1].width = width;
383 strcpy (dpyinfo->bitmaps[id - 1].file, SDATA (file));
384
385 return id;
386 #endif /* HAVE_X_WINDOWS */
387 }
388
389 /* Free bitmap B. */
390
391 static void
392 free_bitmap_record (Display_Info *dpyinfo, Bitmap_Record *bm)
393 {
394 #ifdef HAVE_X_WINDOWS
395 XFreePixmap (dpyinfo->display, bm->pixmap);
396 if (bm->have_mask)
397 XFreePixmap (dpyinfo->display, bm->mask);
398 #endif /* HAVE_X_WINDOWS */
399
400 #ifdef HAVE_NTGUI
401 DeleteObject (bm->pixmap);
402 #endif /* HAVE_NTGUI */
403
404 #ifdef HAVE_NS
405 ns_release_object (bm->img);
406 #endif
407
408 if (bm->file)
409 {
410 xfree (bm->file);
411 bm->file = NULL;
412 }
413 }
414
415 /* Remove reference to bitmap with id number ID. */
416
417 void
418 x_destroy_bitmap (FRAME_PTR f, int id)
419 {
420 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
421
422 if (id > 0)
423 {
424 Bitmap_Record *bm = &dpyinfo->bitmaps[id - 1];
425
426 if (--bm->refcount == 0)
427 {
428 BLOCK_INPUT;
429 free_bitmap_record (dpyinfo, bm);
430 UNBLOCK_INPUT;
431 }
432 }
433 }
434
435 /* Free all the bitmaps for the display specified by DPYINFO. */
436
437 void
438 x_destroy_all_bitmaps (Display_Info *dpyinfo)
439 {
440 int i;
441 Bitmap_Record *bm = dpyinfo->bitmaps;
442
443 for (i = 0; i < dpyinfo->bitmaps_last; i++, bm++)
444 if (bm->refcount > 0)
445 free_bitmap_record (dpyinfo, bm);
446
447 dpyinfo->bitmaps_last = 0;
448 }
449
450
451 #ifdef HAVE_X_WINDOWS
452
453 /* Useful functions defined in the section
454 `Image type independent image structures' below. */
455
456 static unsigned long four_corners_best (XImagePtr ximg,
457 int *corners,
458 unsigned long width,
459 unsigned long height);
460
461 static int x_create_x_image_and_pixmap (struct frame *f, int width, int height,
462 int depth, XImagePtr *ximg,
463 Pixmap *pixmap);
464
465 static void x_destroy_x_image (XImagePtr ximg);
466
467
468 /* Create a mask of a bitmap. Note is this not a perfect mask.
469 It's nicer with some borders in this context */
470
471 int
472 x_create_bitmap_mask (struct frame *f, int id)
473 {
474 Pixmap pixmap, mask;
475 XImagePtr ximg, mask_img;
476 unsigned long width, height;
477 int result;
478 unsigned long bg;
479 unsigned long x, y, xp, xm, yp, ym;
480 GC gc;
481
482 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
483
484 if (!(id > 0))
485 return -1;
486
487 pixmap = x_bitmap_pixmap (f, id);
488 width = x_bitmap_width (f, id);
489 height = x_bitmap_height (f, id);
490
491 BLOCK_INPUT;
492 ximg = XGetImage (FRAME_X_DISPLAY (f), pixmap, 0, 0, width, height,
493 ~0, ZPixmap);
494
495 if (!ximg)
496 {
497 UNBLOCK_INPUT;
498 return -1;
499 }
500
501 result = x_create_x_image_and_pixmap (f, width, height, 1, &mask_img, &mask);
502
503 UNBLOCK_INPUT;
504 if (!result)
505 {
506 XDestroyImage (ximg);
507 return -1;
508 }
509
510 bg = four_corners_best (ximg, NULL, width, height);
511
512 for (y = 0; y < ximg->height; ++y)
513 {
514 for (x = 0; x < ximg->width; ++x)
515 {
516 xp = x != ximg->width - 1 ? x + 1 : 0;
517 xm = x != 0 ? x - 1 : ximg->width - 1;
518 yp = y != ximg->height - 1 ? y + 1 : 0;
519 ym = y != 0 ? y - 1 : ximg->height - 1;
520 if (XGetPixel (ximg, x, y) == bg
521 && XGetPixel (ximg, x, yp) == bg
522 && XGetPixel (ximg, x, ym) == bg
523 && XGetPixel (ximg, xp, y) == bg
524 && XGetPixel (ximg, xp, yp) == bg
525 && XGetPixel (ximg, xp, ym) == bg
526 && XGetPixel (ximg, xm, y) == bg
527 && XGetPixel (ximg, xm, yp) == bg
528 && XGetPixel (ximg, xm, ym) == bg)
529 XPutPixel (mask_img, x, y, 0);
530 else
531 XPutPixel (mask_img, x, y, 1);
532 }
533 }
534
535 xassert (interrupt_input_blocked);
536 gc = XCreateGC (FRAME_X_DISPLAY (f), mask, 0, NULL);
537 XPutImage (FRAME_X_DISPLAY (f), mask, gc, mask_img, 0, 0, 0, 0,
538 width, height);
539 XFreeGC (FRAME_X_DISPLAY (f), gc);
540
541 dpyinfo->bitmaps[id - 1].have_mask = 1;
542 dpyinfo->bitmaps[id - 1].mask = mask;
543
544 XDestroyImage (ximg);
545 x_destroy_x_image (mask_img);
546
547 return 0;
548 }
549
550 #endif /* HAVE_X_WINDOWS */
551
552
553 /***********************************************************************
554 Image types
555 ***********************************************************************/
556
557 /* Value is the number of elements of vector VECTOR. */
558
559 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
560
561 /* List of supported image types. Use define_image_type to add new
562 types. Use lookup_image_type to find a type for a given symbol. */
563
564 static struct image_type *image_types;
565
566 /* A list of symbols, one for each supported image type. */
567
568 Lisp_Object Vimage_types;
569
570 /* Cache for delayed-loading image types. */
571
572 static Lisp_Object Vimage_type_cache;
573
574 /* The symbol `xbm' which is used as the type symbol for XBM images. */
575
576 Lisp_Object Qxbm;
577
578 /* Keywords. */
579
580 Lisp_Object QCascent, QCmargin, QCrelief, Qcount, Qextension_data;
581 Lisp_Object QCconversion, QCcolor_symbols, QCheuristic_mask;
582 Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask, QCgeometry, QCcrop, QCrotation;
583
584 /* Other symbols. */
585
586 Lisp_Object Qlaplace, Qemboss, Qedge_detection, Qheuristic;
587
588 /* Time in seconds after which images should be removed from the cache
589 if not displayed. */
590
591 Lisp_Object Vimage_cache_eviction_delay;
592
593 /* Function prototypes. */
594
595 static Lisp_Object define_image_type (struct image_type *type, int loaded);
596 static struct image_type *lookup_image_type (Lisp_Object symbol);
597 static void image_error (const char *format, Lisp_Object, Lisp_Object);
598 static void x_laplace (struct frame *, struct image *);
599 static void x_emboss (struct frame *, struct image *);
600 static int x_build_heuristic_mask (struct frame *, struct image *,
601 Lisp_Object);
602
603 #define CACHE_IMAGE_TYPE(type, status) \
604 do { Vimage_type_cache = Fcons (Fcons (type, status), Vimage_type_cache); } while (0)
605
606 #define ADD_IMAGE_TYPE(type) \
607 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
608
609 /* Define a new image type from TYPE. This adds a copy of TYPE to
610 image_types and caches the loading status of TYPE. */
611
612 static Lisp_Object
613 define_image_type (struct image_type *type, int loaded)
614 {
615 Lisp_Object success;
616
617 if (!loaded)
618 success = Qnil;
619 else
620 {
621 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
622 The initialized data segment is read-only. */
623 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
624 memcpy (p, type, sizeof *p);
625 p->next = image_types;
626 image_types = p;
627 success = Qt;
628 }
629
630 CACHE_IMAGE_TYPE (*type->type, success);
631 return success;
632 }
633
634
635 /* Look up image type SYMBOL, and return a pointer to its image_type
636 structure. Value is null if SYMBOL is not a known image type. */
637
638 static INLINE struct image_type *
639 lookup_image_type (Lisp_Object symbol)
640 {
641 struct image_type *type;
642
643 /* We must initialize the image-type if it hasn't been already. */
644 if (NILP (Finit_image_library (symbol, Vdynamic_library_alist)))
645 return 0; /* unimplemented */
646
647 for (type = image_types; type; type = type->next)
648 if (EQ (symbol, *type->type))
649 break;
650
651 return type;
652 }
653
654
655 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
656 valid image specification is a list whose car is the symbol
657 `image', and whose rest is a property list. The property list must
658 contain a value for key `:type'. That value must be the name of a
659 supported image type. The rest of the property list depends on the
660 image type. */
661
662 int
663 valid_image_p (Lisp_Object object)
664 {
665 int valid_p = 0;
666
667 if (IMAGEP (object))
668 {
669 Lisp_Object tem;
670
671 for (tem = XCDR (object); CONSP (tem); tem = XCDR (tem))
672 if (EQ (XCAR (tem), QCtype))
673 {
674 tem = XCDR (tem);
675 if (CONSP (tem) && SYMBOLP (XCAR (tem)))
676 {
677 struct image_type *type;
678 type = lookup_image_type (XCAR (tem));
679 if (type)
680 valid_p = type->valid_p (object);
681 }
682
683 break;
684 }
685 }
686
687 return valid_p;
688 }
689
690
691 /* Log error message with format string FORMAT and argument ARG.
692 Signaling an error, e.g. when an image cannot be loaded, is not a
693 good idea because this would interrupt redisplay, and the error
694 message display would lead to another redisplay. This function
695 therefore simply displays a message. */
696
697 static void
698 image_error (const char *format, Lisp_Object arg1, Lisp_Object arg2)
699 {
700 add_to_log (format, arg1, arg2);
701 }
702
703
704 \f
705 /***********************************************************************
706 Image specifications
707 ***********************************************************************/
708
709 enum image_value_type
710 {
711 IMAGE_DONT_CHECK_VALUE_TYPE,
712 IMAGE_STRING_VALUE,
713 IMAGE_STRING_OR_NIL_VALUE,
714 IMAGE_SYMBOL_VALUE,
715 IMAGE_POSITIVE_INTEGER_VALUE,
716 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR,
717 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
718 IMAGE_ASCENT_VALUE,
719 IMAGE_INTEGER_VALUE,
720 IMAGE_FUNCTION_VALUE,
721 IMAGE_NUMBER_VALUE,
722 IMAGE_BOOL_VALUE
723 };
724
725 /* Structure used when parsing image specifications. */
726
727 struct image_keyword
728 {
729 /* Name of keyword. */
730 const char *name;
731
732 /* The type of value allowed. */
733 enum image_value_type type;
734
735 /* Non-zero means key must be present. */
736 int mandatory_p;
737
738 /* Used to recognize duplicate keywords in a property list. */
739 int count;
740
741 /* The value that was found. */
742 Lisp_Object value;
743 };
744
745
746 static int parse_image_spec (Lisp_Object, struct image_keyword *,
747 int, Lisp_Object);
748 static Lisp_Object image_spec_value (Lisp_Object, Lisp_Object, int *);
749
750
751 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
752 has the format (image KEYWORD VALUE ...). One of the keyword/
753 value pairs must be `:type TYPE'. KEYWORDS is a vector of
754 image_keywords structures of size NKEYWORDS describing other
755 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
756
757 static int
758 parse_image_spec (Lisp_Object spec, struct image_keyword *keywords,
759 int nkeywords, Lisp_Object type)
760 {
761 int i;
762 Lisp_Object plist;
763
764 if (!IMAGEP (spec))
765 return 0;
766
767 plist = XCDR (spec);
768 while (CONSP (plist))
769 {
770 Lisp_Object key, value;
771
772 /* First element of a pair must be a symbol. */
773 key = XCAR (plist);
774 plist = XCDR (plist);
775 if (!SYMBOLP (key))
776 return 0;
777
778 /* There must follow a value. */
779 if (!CONSP (plist))
780 return 0;
781 value = XCAR (plist);
782 plist = XCDR (plist);
783
784 /* Find key in KEYWORDS. Error if not found. */
785 for (i = 0; i < nkeywords; ++i)
786 if (strcmp (keywords[i].name, SDATA (SYMBOL_NAME (key))) == 0)
787 break;
788
789 if (i == nkeywords)
790 continue;
791
792 /* Record that we recognized the keyword. If a keywords
793 was found more than once, it's an error. */
794 keywords[i].value = value;
795 ++keywords[i].count;
796
797 if (keywords[i].count > 1)
798 return 0;
799
800 /* Check type of value against allowed type. */
801 switch (keywords[i].type)
802 {
803 case IMAGE_STRING_VALUE:
804 if (!STRINGP (value))
805 return 0;
806 break;
807
808 case IMAGE_STRING_OR_NIL_VALUE:
809 if (!STRINGP (value) && !NILP (value))
810 return 0;
811 break;
812
813 case IMAGE_SYMBOL_VALUE:
814 if (!SYMBOLP (value))
815 return 0;
816 break;
817
818 case IMAGE_POSITIVE_INTEGER_VALUE:
819 if (!INTEGERP (value) || XINT (value) <= 0)
820 return 0;
821 break;
822
823 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR:
824 if (INTEGERP (value) && XINT (value) >= 0)
825 break;
826 if (CONSP (value)
827 && INTEGERP (XCAR (value)) && INTEGERP (XCDR (value))
828 && XINT (XCAR (value)) >= 0 && XINT (XCDR (value)) >= 0)
829 break;
830 return 0;
831
832 case IMAGE_ASCENT_VALUE:
833 if (SYMBOLP (value) && EQ (value, Qcenter))
834 break;
835 else if (INTEGERP (value)
836 && XINT (value) >= 0
837 && XINT (value) <= 100)
838 break;
839 return 0;
840
841 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
842 if (!INTEGERP (value) || XINT (value) < 0)
843 return 0;
844 break;
845
846 case IMAGE_DONT_CHECK_VALUE_TYPE:
847 break;
848
849 case IMAGE_FUNCTION_VALUE:
850 value = indirect_function (value);
851 if (SUBRP (value)
852 || COMPILEDP (value)
853 || (CONSP (value) && EQ (XCAR (value), Qlambda)))
854 break;
855 return 0;
856
857 case IMAGE_NUMBER_VALUE:
858 if (!INTEGERP (value) && !FLOATP (value))
859 return 0;
860 break;
861
862 case IMAGE_INTEGER_VALUE:
863 if (!INTEGERP (value))
864 return 0;
865 break;
866
867 case IMAGE_BOOL_VALUE:
868 if (!NILP (value) && !EQ (value, Qt))
869 return 0;
870 break;
871
872 default:
873 abort ();
874 break;
875 }
876
877 if (EQ (key, QCtype) && !EQ (type, value))
878 return 0;
879 }
880
881 /* Check that all mandatory fields are present. */
882 for (i = 0; i < nkeywords; ++i)
883 if (keywords[i].mandatory_p && keywords[i].count == 0)
884 return 0;
885
886 return NILP (plist);
887 }
888
889
890 /* Return the value of KEY in image specification SPEC. Value is nil
891 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
892 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
893
894 static Lisp_Object
895 image_spec_value (Lisp_Object spec, Lisp_Object key, int *found)
896 {
897 Lisp_Object tail;
898
899 xassert (valid_image_p (spec));
900
901 for (tail = XCDR (spec);
902 CONSP (tail) && CONSP (XCDR (tail));
903 tail = XCDR (XCDR (tail)))
904 {
905 if (EQ (XCAR (tail), key))
906 {
907 if (found)
908 *found = 1;
909 return XCAR (XCDR (tail));
910 }
911 }
912
913 if (found)
914 *found = 0;
915 return Qnil;
916 }
917
918
919 DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
920 doc: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
921 PIXELS non-nil means return the size in pixels, otherwise return the
922 size in canonical character units.
923 FRAME is the frame on which the image will be displayed. FRAME nil
924 or omitted means use the selected frame. */)
925 (Lisp_Object spec, Lisp_Object pixels, Lisp_Object frame)
926 {
927 Lisp_Object size;
928
929 size = Qnil;
930 if (valid_image_p (spec))
931 {
932 struct frame *f = check_x_frame (frame);
933 int id = lookup_image (f, spec);
934 struct image *img = IMAGE_FROM_ID (f, id);
935 int width = img->width + 2 * img->hmargin;
936 int height = img->height + 2 * img->vmargin;
937
938 if (NILP (pixels))
939 size = Fcons (make_float ((double) width / FRAME_COLUMN_WIDTH (f)),
940 make_float ((double) height / FRAME_LINE_HEIGHT (f)));
941 else
942 size = Fcons (make_number (width), make_number (height));
943 }
944 else
945 error ("Invalid image specification");
946
947 return size;
948 }
949
950
951 DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
952 doc: /* Return t if image SPEC has a mask bitmap.
953 FRAME is the frame on which the image will be displayed. FRAME nil
954 or omitted means use the selected frame. */)
955 (Lisp_Object spec, Lisp_Object frame)
956 {
957 Lisp_Object mask;
958
959 mask = Qnil;
960 if (valid_image_p (spec))
961 {
962 struct frame *f = check_x_frame (frame);
963 int id = lookup_image (f, spec);
964 struct image *img = IMAGE_FROM_ID (f, id);
965 if (img->mask)
966 mask = Qt;
967 }
968 else
969 error ("Invalid image specification");
970
971 return mask;
972 }
973
974 DEFUN ("image-metadata", Fimage_metadata, Simage_metadata, 1, 2, 0,
975 doc: /* Return metadata for image SPEC.
976 FRAME is the frame on which the image will be displayed. FRAME nil
977 or omitted means use the selected frame. */)
978 (Lisp_Object spec, Lisp_Object frame)
979 {
980 Lisp_Object ext;
981
982 ext = Qnil;
983 if (valid_image_p (spec))
984 {
985 struct frame *f = check_x_frame (frame);
986 int id = lookup_image (f, spec);
987 struct image *img = IMAGE_FROM_ID (f, id);
988 ext = img->data.lisp_val;
989 }
990
991 return ext;
992 }
993
994 \f
995 /***********************************************************************
996 Image type independent image structures
997 ***********************************************************************/
998
999 static struct image *make_image (Lisp_Object spec, unsigned hash);
1000 static void free_image (struct frame *f, struct image *img);
1001 static int check_image_size (struct frame *f, int width, int height);
1002
1003 #define MAX_IMAGE_SIZE 6.0
1004 Lisp_Object Vmax_image_size;
1005
1006 /* Allocate and return a new image structure for image specification
1007 SPEC. SPEC has a hash value of HASH. */
1008
1009 static struct image *
1010 make_image (Lisp_Object spec, unsigned int hash)
1011 {
1012 struct image *img = (struct image *) xmalloc (sizeof *img);
1013 Lisp_Object file = image_spec_value (spec, QCfile, NULL);
1014
1015 xassert (valid_image_p (spec));
1016 memset (img, 0, sizeof *img);
1017 img->dependencies = NILP (file) ? Qnil : list1 (file);
1018 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
1019 xassert (img->type != NULL);
1020 img->spec = spec;
1021 img->data.lisp_val = Qnil;
1022 img->ascent = DEFAULT_IMAGE_ASCENT;
1023 img->hash = hash;
1024 img->corners[BOT_CORNER] = -1; /* Full image */
1025 return img;
1026 }
1027
1028
1029 /* Free image IMG which was used on frame F, including its resources. */
1030
1031 static void
1032 free_image (struct frame *f, struct image *img)
1033 {
1034 if (img)
1035 {
1036 struct image_cache *c = FRAME_IMAGE_CACHE (f);
1037
1038 /* Remove IMG from the hash table of its cache. */
1039 if (img->prev)
1040 img->prev->next = img->next;
1041 else
1042 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
1043
1044 if (img->next)
1045 img->next->prev = img->prev;
1046
1047 c->images[img->id] = NULL;
1048
1049 /* Free resources, then free IMG. */
1050 img->type->free (f, img);
1051 xfree (img);
1052
1053 /* As display glyphs may still be referring to the image ID, we
1054 must garbage the frame (Bug#6426). */
1055 SET_FRAME_GARBAGED (f);
1056 }
1057 }
1058
1059 /* Return 1 if the given widths and heights are valid for display;
1060 otherwise, return 0. */
1061
1062 int
1063 check_image_size (struct frame *f, int width, int height)
1064 {
1065 int w, h;
1066
1067 if (width <= 0 || height <= 0)
1068 return 0;
1069
1070 if (INTEGERP (Vmax_image_size))
1071 w = h = XINT (Vmax_image_size);
1072 else if (FLOATP (Vmax_image_size))
1073 {
1074 if (f != NULL)
1075 {
1076 w = FRAME_PIXEL_WIDTH (f);
1077 h = FRAME_PIXEL_HEIGHT (f);
1078 }
1079 else
1080 w = h = 1024; /* Arbitrary size for unknown frame. */
1081 w = (int) (XFLOAT_DATA (Vmax_image_size) * w);
1082 h = (int) (XFLOAT_DATA (Vmax_image_size) * h);
1083 }
1084 else
1085 return 1;
1086
1087 return (width <= w && height <= h);
1088 }
1089
1090 /* Prepare image IMG for display on frame F. Must be called before
1091 drawing an image. */
1092
1093 void
1094 prepare_image_for_display (struct frame *f, struct image *img)
1095 {
1096 EMACS_TIME t;
1097
1098 /* We're about to display IMG, so set its timestamp to `now'. */
1099 EMACS_GET_TIME (t);
1100 img->timestamp = EMACS_SECS (t);
1101
1102 /* If IMG doesn't have a pixmap yet, load it now, using the image
1103 type dependent loader function. */
1104 if (img->pixmap == NO_PIXMAP && !img->load_failed_p)
1105 img->load_failed_p = img->type->load (f, img) == 0;
1106
1107 }
1108
1109
1110 /* Value is the number of pixels for the ascent of image IMG when
1111 drawn in face FACE. */
1112
1113 int
1114 image_ascent (struct image *img, struct face *face, struct glyph_slice *slice)
1115 {
1116 int height;
1117 int ascent;
1118
1119 if (slice->height == img->height)
1120 height = img->height + img->vmargin;
1121 else if (slice->y == 0)
1122 height = slice->height + img->vmargin;
1123 else
1124 height = slice->height;
1125
1126 if (img->ascent == CENTERED_IMAGE_ASCENT)
1127 {
1128 if (face->font)
1129 {
1130 #ifdef HAVE_NTGUI
1131 /* W32 specific version. Why?. ++kfs */
1132 ascent = height / 2 - (FONT_DESCENT (face->font)
1133 - FONT_BASE (face->font)) / 2;
1134 #else
1135 /* This expression is arranged so that if the image can't be
1136 exactly centered, it will be moved slightly up. This is
1137 because a typical font is `top-heavy' (due to the presence
1138 uppercase letters), so the image placement should err towards
1139 being top-heavy too. It also just generally looks better. */
1140 ascent = (height + FONT_BASE(face->font)
1141 - FONT_DESCENT(face->font) + 1) / 2;
1142 #endif /* HAVE_NTGUI */
1143 }
1144 else
1145 ascent = height / 2;
1146 }
1147 else
1148 ascent = (int) (height * img->ascent / 100.0);
1149
1150 return ascent;
1151 }
1152
1153 \f
1154 /* Image background colors. */
1155
1156 /* Find the "best" corner color of a bitmap.
1157 On W32, XIMG is assumed to a device context with the bitmap selected. */
1158
1159 static RGB_PIXEL_COLOR
1160 four_corners_best (XImagePtr_or_DC ximg, int *corners,
1161 unsigned long width, unsigned long height)
1162 {
1163 RGB_PIXEL_COLOR corner_pixels[4], best;
1164 int i, best_count;
1165
1166 if (corners && corners[BOT_CORNER] >= 0)
1167 {
1168 /* Get the colors at the corner_pixels of ximg. */
1169 corner_pixels[0] = GET_PIXEL (ximg, corners[LEFT_CORNER], corners[TOP_CORNER]);
1170 corner_pixels[1] = GET_PIXEL (ximg, corners[RIGHT_CORNER] - 1, corners[TOP_CORNER]);
1171 corner_pixels[2] = GET_PIXEL (ximg, corners[RIGHT_CORNER] - 1, corners[BOT_CORNER] - 1);
1172 corner_pixels[3] = GET_PIXEL (ximg, corners[LEFT_CORNER], corners[BOT_CORNER] - 1);
1173 }
1174 else
1175 {
1176 /* Get the colors at the corner_pixels of ximg. */
1177 corner_pixels[0] = GET_PIXEL (ximg, 0, 0);
1178 corner_pixels[1] = GET_PIXEL (ximg, width - 1, 0);
1179 corner_pixels[2] = GET_PIXEL (ximg, width - 1, height - 1);
1180 corner_pixels[3] = GET_PIXEL (ximg, 0, height - 1);
1181 }
1182 /* Choose the most frequently found color as background. */
1183 for (i = best_count = 0; i < 4; ++i)
1184 {
1185 int j, n;
1186
1187 for (j = n = 0; j < 4; ++j)
1188 if (corner_pixels[i] == corner_pixels[j])
1189 ++n;
1190
1191 if (n > best_count)
1192 best = corner_pixels[i], best_count = n;
1193 }
1194
1195 return best;
1196 }
1197
1198 /* Portability macros */
1199
1200 #ifdef HAVE_NTGUI
1201
1202 #define Destroy_Image(img_dc, prev) \
1203 do { SelectObject (img_dc, prev); DeleteDC (img_dc); } while (0)
1204
1205 #define Free_Pixmap(display, pixmap) \
1206 DeleteObject (pixmap)
1207
1208 #elif defined (HAVE_NS)
1209
1210 #define Destroy_Image(ximg, dummy) \
1211 ns_release_object (ximg)
1212
1213 #define Free_Pixmap(display, pixmap) \
1214 ns_release_object (pixmap)
1215
1216 #else
1217
1218 #define Destroy_Image(ximg, dummy) \
1219 XDestroyImage (ximg)
1220
1221 #define Free_Pixmap(display, pixmap) \
1222 XFreePixmap (display, pixmap)
1223
1224 #endif /* !HAVE_NTGUI && !HAVE_NS */
1225
1226
1227 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1228 it is guessed heuristically. If non-zero, XIMG is an existing
1229 XImage object (or device context with the image selected on W32) to
1230 use for the heuristic. */
1231
1232 RGB_PIXEL_COLOR
1233 image_background (struct image *img, struct frame *f, XImagePtr_or_DC ximg)
1234 {
1235 if (! img->background_valid)
1236 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1237 {
1238 int free_ximg = !ximg;
1239 #ifdef HAVE_NTGUI
1240 HGDIOBJ prev;
1241 #endif /* HAVE_NTGUI */
1242
1243 if (free_ximg)
1244 {
1245 #ifndef HAVE_NTGUI
1246 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
1247 0, 0, img->width, img->height, ~0, ZPixmap);
1248 #else
1249 HDC frame_dc = get_frame_dc (f);
1250 ximg = CreateCompatibleDC (frame_dc);
1251 release_frame_dc (f, frame_dc);
1252 prev = SelectObject (ximg, img->pixmap);
1253 #endif /* !HAVE_NTGUI */
1254 }
1255
1256 img->background = four_corners_best (ximg, img->corners, img->width, img->height);
1257
1258 if (free_ximg)
1259 Destroy_Image (ximg, prev);
1260
1261 img->background_valid = 1;
1262 }
1263
1264 return img->background;
1265 }
1266
1267 /* Return the `background_transparent' field of IMG. If IMG doesn't
1268 have one yet, it is guessed heuristically. If non-zero, MASK is an
1269 existing XImage object to use for the heuristic. */
1270
1271 int
1272 image_background_transparent (struct image *img, struct frame *f, XImagePtr_or_DC mask)
1273 {
1274 if (! img->background_transparent_valid)
1275 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1276 {
1277 if (img->mask)
1278 {
1279 int free_mask = !mask;
1280 #ifdef HAVE_NTGUI
1281 HGDIOBJ prev;
1282 #endif /* HAVE_NTGUI */
1283
1284 if (free_mask)
1285 {
1286 #ifndef HAVE_NTGUI
1287 mask = XGetImage (FRAME_X_DISPLAY (f), img->mask,
1288 0, 0, img->width, img->height, ~0, ZPixmap);
1289 #else
1290 HDC frame_dc = get_frame_dc (f);
1291 mask = CreateCompatibleDC (frame_dc);
1292 release_frame_dc (f, frame_dc);
1293 prev = SelectObject (mask, img->mask);
1294 #endif /* HAVE_NTGUI */
1295 }
1296
1297 img->background_transparent
1298 = (four_corners_best (mask, img->corners, img->width, img->height) == PIX_MASK_RETAIN);
1299
1300 if (free_mask)
1301 Destroy_Image (mask, prev);
1302 }
1303 else
1304 img->background_transparent = 0;
1305
1306 img->background_transparent_valid = 1;
1307 }
1308
1309 return img->background_transparent;
1310 }
1311
1312 \f
1313 /***********************************************************************
1314 Helper functions for X image types
1315 ***********************************************************************/
1316
1317 static void x_clear_image_1 (struct frame *, struct image *, int,
1318 int, int);
1319 static void x_clear_image (struct frame *f, struct image *img);
1320 static unsigned long x_alloc_image_color (struct frame *f,
1321 struct image *img,
1322 Lisp_Object color_name,
1323 unsigned long dflt);
1324
1325
1326 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
1327 free the pixmap if any. MASK_P non-zero means clear the mask
1328 pixmap if any. COLORS_P non-zero means free colors allocated for
1329 the image, if any. */
1330
1331 static void
1332 x_clear_image_1 (struct frame *f, struct image *img, int pixmap_p, int mask_p,
1333 int colors_p)
1334 {
1335 if (pixmap_p && img->pixmap)
1336 {
1337 Free_Pixmap (FRAME_X_DISPLAY (f), img->pixmap);
1338 img->pixmap = NO_PIXMAP;
1339 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1340 img->background_valid = 0;
1341 }
1342
1343 if (mask_p && img->mask)
1344 {
1345 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
1346 img->mask = NO_PIXMAP;
1347 img->background_transparent_valid = 0;
1348 }
1349
1350 if (colors_p && img->ncolors)
1351 {
1352 /* W32_TODO: color table support. */
1353 #ifdef HAVE_X_WINDOWS
1354 x_free_colors (f, img->colors, img->ncolors);
1355 #endif /* HAVE_X_WINDOWS */
1356 xfree (img->colors);
1357 img->colors = NULL;
1358 img->ncolors = 0;
1359 }
1360
1361 }
1362
1363 /* Free X resources of image IMG which is used on frame F. */
1364
1365 static void
1366 x_clear_image (struct frame *f, struct image *img)
1367 {
1368 BLOCK_INPUT;
1369 x_clear_image_1 (f, img, 1, 1, 1);
1370 UNBLOCK_INPUT;
1371 }
1372
1373
1374 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1375 cannot be allocated, use DFLT. Add a newly allocated color to
1376 IMG->colors, so that it can be freed again. Value is the pixel
1377 color. */
1378
1379 static unsigned long
1380 x_alloc_image_color (struct frame *f, struct image *img, Lisp_Object color_name,
1381 unsigned long dflt)
1382 {
1383 XColor color;
1384 unsigned long result;
1385
1386 xassert (STRINGP (color_name));
1387
1388 if (x_defined_color (f, SDATA (color_name), &color, 1))
1389 {
1390 /* This isn't called frequently so we get away with simply
1391 reallocating the color vector to the needed size, here. */
1392 ++img->ncolors;
1393 img->colors =
1394 (unsigned long *) xrealloc (img->colors,
1395 img->ncolors * sizeof *img->colors);
1396 img->colors[img->ncolors - 1] = color.pixel;
1397 result = color.pixel;
1398 }
1399 else
1400 result = dflt;
1401
1402 return result;
1403 }
1404
1405
1406 \f
1407 /***********************************************************************
1408 Image Cache
1409 ***********************************************************************/
1410
1411 static struct image *search_image_cache (struct frame *, Lisp_Object, unsigned);
1412 static void cache_image (struct frame *f, struct image *img);
1413 static void postprocess_image (struct frame *, struct image *);
1414
1415 /* Return a new, initialized image cache that is allocated from the
1416 heap. Call free_image_cache to free an image cache. */
1417
1418 struct image_cache *
1419 make_image_cache (void)
1420 {
1421 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
1422 int size;
1423
1424 memset (c, 0, sizeof *c);
1425 c->size = 50;
1426 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
1427 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
1428 c->buckets = (struct image **) xmalloc (size);
1429 memset (c->buckets, 0, size);
1430 return c;
1431 }
1432
1433
1434 /* Find an image matching SPEC in the cache, and return it. If no
1435 image is found, return NULL. */
1436 static struct image *
1437 search_image_cache (struct frame *f, Lisp_Object spec, unsigned int hash)
1438 {
1439 struct image *img;
1440 struct image_cache *c = FRAME_IMAGE_CACHE (f);
1441 int i = hash % IMAGE_CACHE_BUCKETS_SIZE;
1442
1443 if (!c) return NULL;
1444
1445 /* If the image spec does not specify a background color, the cached
1446 image must have the same background color as the current frame.
1447 The foreground color must also match, for the sake of monochrome
1448 images.
1449
1450 In fact, we could ignore the foreground color matching condition
1451 for color images, or if the image spec specifies :foreground;
1452 similarly we could ignore the background color matching condition
1453 for formats that don't use transparency (such as jpeg), or if the
1454 image spec specifies :background. However, the extra memory
1455 usage is probably negligible in practice, so we don't bother. */
1456
1457 for (img = c->buckets[i]; img; img = img->next)
1458 if (img->hash == hash
1459 && !NILP (Fequal (img->spec, spec))
1460 && img->frame_foreground == FRAME_FOREGROUND_PIXEL (f)
1461 && img->frame_background == FRAME_BACKGROUND_PIXEL (f))
1462 break;
1463 return img;
1464 }
1465
1466
1467 /* Search frame F for an image with spec SPEC, and free it. */
1468
1469 static void
1470 uncache_image (struct frame *f, Lisp_Object spec)
1471 {
1472 struct image *img = search_image_cache (f, spec, sxhash (spec, 0));
1473 if (img)
1474 free_image (f, img);
1475 }
1476
1477
1478 /* Free image cache of frame F. Be aware that X frames share images
1479 caches. */
1480
1481 void
1482 free_image_cache (struct frame *f)
1483 {
1484 struct image_cache *c = FRAME_IMAGE_CACHE (f);
1485 if (c)
1486 {
1487 int i;
1488
1489 /* Cache should not be referenced by any frame when freed. */
1490 xassert (c->refcount == 0);
1491
1492 for (i = 0; i < c->used; ++i)
1493 free_image (f, c->images[i]);
1494 xfree (c->images);
1495 xfree (c->buckets);
1496 xfree (c);
1497 FRAME_IMAGE_CACHE (f) = NULL;
1498 }
1499 }
1500
1501
1502 /* Clear image cache of frame F. FILTER=t means free all images.
1503 FILTER=nil means clear only images that haven't been
1504 displayed for some time.
1505 Else, only free the images which have FILTER in their `dependencies'.
1506 Should be called from time to time to reduce the number of loaded images.
1507 If image-cache-eviction-delay is non-nil, this frees images in the cache
1508 which weren't displayed for at least that many seconds. */
1509
1510 void
1511 clear_image_cache (struct frame *f, Lisp_Object filter)
1512 {
1513 struct image_cache *c = FRAME_IMAGE_CACHE (f);
1514
1515 if (c)
1516 {
1517 int i, nfreed = 0;
1518
1519 /* Block input so that we won't be interrupted by a SIGIO
1520 while being in an inconsistent state. */
1521 BLOCK_INPUT;
1522
1523 if (!NILP (filter))
1524 {
1525 /* Filter image cache. */
1526 for (i = 0; i < c->used; ++i)
1527 {
1528 struct image *img = c->images[i];
1529 if (img && (EQ (Qt, filter)
1530 || !NILP (Fmember (filter, img->dependencies))))
1531 {
1532 free_image (f, img);
1533 ++nfreed;
1534 }
1535 }
1536 }
1537 else if (INTEGERP (Vimage_cache_eviction_delay))
1538 {
1539 /* Free cache based on timestamp. */
1540 EMACS_TIME t;
1541 unsigned long old;
1542 int delay, nimages = 0;
1543
1544 for (i = 0; i < c->used; ++i)
1545 if (c->images[i])
1546 nimages++;
1547
1548 /* If the number of cached images has grown unusually large,
1549 decrease the cache eviction delay (Bug#6230). */
1550 delay = XFASTINT (Vimage_cache_eviction_delay);
1551 if (nimages > 40)
1552 delay = max (1, 1600 * delay / (nimages*nimages));
1553
1554 EMACS_GET_TIME (t);
1555 old = EMACS_SECS (t) - delay;
1556
1557 for (i = 0; i < c->used; ++i)
1558 {
1559 struct image *img = c->images[i];
1560 if (img && img->timestamp < old)
1561 {
1562 free_image (f, img);
1563 ++nfreed;
1564 }
1565 }
1566 }
1567
1568 /* We may be clearing the image cache because, for example,
1569 Emacs was iconified for a longer period of time. In that
1570 case, current matrices may still contain references to
1571 images freed above. So, clear these matrices. */
1572 if (nfreed)
1573 {
1574 Lisp_Object tail, frame;
1575
1576 FOR_EACH_FRAME (tail, frame)
1577 {
1578 struct frame *f = XFRAME (frame);
1579 if (FRAME_IMAGE_CACHE (f) == c)
1580 clear_current_matrices (f);
1581 }
1582
1583 ++windows_or_buffers_changed;
1584 }
1585
1586 UNBLOCK_INPUT;
1587 }
1588 }
1589
1590 void
1591 clear_image_caches (Lisp_Object filter)
1592 {
1593 /* FIXME: We want to do
1594 * struct terminal *t;
1595 * for (t = terminal_list; t; t = t->next_terminal)
1596 * clear_image_cache (t, filter); */
1597 Lisp_Object tail, frame;
1598 FOR_EACH_FRAME (tail, frame)
1599 if (FRAME_WINDOW_P (XFRAME (frame)))
1600 clear_image_cache (XFRAME (frame), filter);
1601 }
1602
1603 DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
1604 0, 1, 0,
1605 doc: /* Clear the image cache.
1606 FILTER nil or a frame means clear all images in the selected frame.
1607 FILTER t means clear the image caches of all frames.
1608 Anything else, means only clear those images which refer to FILTER,
1609 which is then usually a filename. */)
1610 (Lisp_Object filter)
1611 {
1612 if (!(EQ (filter, Qnil) || FRAMEP (filter)))
1613 clear_image_caches (filter);
1614 else
1615 clear_image_cache (check_x_frame (filter), Qt);
1616
1617 return Qnil;
1618 }
1619
1620
1621 DEFUN ("image-flush", Fimage_flush, Simage_flush,
1622 1, 2, 0,
1623 doc: /* Fush the image with specification SPEC on frame FRAME.
1624 This removes the image from the Emacs image cache. If SPEC specifies
1625 an image file, the next redisplay of this image will read from the
1626 current contents of that file.
1627
1628 FRAME nil or omitted means use the selected frame.
1629 FRAME t means refresh the image on all frames. */)
1630 (Lisp_Object spec, Lisp_Object frame)
1631 {
1632 if (!valid_image_p (spec))
1633 error ("Invalid image specification");
1634
1635 if (EQ (frame, Qt))
1636 {
1637 Lisp_Object tail;
1638 FOR_EACH_FRAME (tail, frame)
1639 {
1640 struct frame *f = XFRAME (frame);
1641 if (FRAME_WINDOW_P (f))
1642 uncache_image (f, spec);
1643 }
1644 }
1645 else
1646 uncache_image (check_x_frame (frame), spec);
1647
1648 return Qnil;
1649 }
1650
1651
1652 /* Compute masks and transform image IMG on frame F, as specified
1653 by the image's specification, */
1654
1655 static void
1656 postprocess_image (struct frame *f, struct image *img)
1657 {
1658 /* Manipulation of the image's mask. */
1659 if (img->pixmap)
1660 {
1661 Lisp_Object conversion, spec;
1662 Lisp_Object mask;
1663
1664 spec = img->spec;
1665
1666 /* `:heuristic-mask t'
1667 `:mask heuristic'
1668 means build a mask heuristically.
1669 `:heuristic-mask (R G B)'
1670 `:mask (heuristic (R G B))'
1671 means build a mask from color (R G B) in the
1672 image.
1673 `:mask nil'
1674 means remove a mask, if any. */
1675
1676 mask = image_spec_value (spec, QCheuristic_mask, NULL);
1677 if (!NILP (mask))
1678 x_build_heuristic_mask (f, img, mask);
1679 else
1680 {
1681 int found_p;
1682
1683 mask = image_spec_value (spec, QCmask, &found_p);
1684
1685 if (EQ (mask, Qheuristic))
1686 x_build_heuristic_mask (f, img, Qt);
1687 else if (CONSP (mask)
1688 && EQ (XCAR (mask), Qheuristic))
1689 {
1690 if (CONSP (XCDR (mask)))
1691 x_build_heuristic_mask (f, img, XCAR (XCDR (mask)));
1692 else
1693 x_build_heuristic_mask (f, img, XCDR (mask));
1694 }
1695 else if (NILP (mask) && found_p && img->mask)
1696 {
1697 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
1698 img->mask = NO_PIXMAP;
1699 }
1700 }
1701
1702
1703 /* Should we apply an image transformation algorithm? */
1704 conversion = image_spec_value (spec, QCconversion, NULL);
1705 if (EQ (conversion, Qdisabled))
1706 x_disable_image (f, img);
1707 else if (EQ (conversion, Qlaplace))
1708 x_laplace (f, img);
1709 else if (EQ (conversion, Qemboss))
1710 x_emboss (f, img);
1711 else if (CONSP (conversion)
1712 && EQ (XCAR (conversion), Qedge_detection))
1713 {
1714 Lisp_Object tem;
1715 tem = XCDR (conversion);
1716 if (CONSP (tem))
1717 x_edge_detection (f, img,
1718 Fplist_get (tem, QCmatrix),
1719 Fplist_get (tem, QCcolor_adjustment));
1720 }
1721 }
1722 }
1723
1724
1725 /* Return the id of image with Lisp specification SPEC on frame F.
1726 SPEC must be a valid Lisp image specification (see valid_image_p). */
1727
1728 int
1729 lookup_image (struct frame *f, Lisp_Object spec)
1730 {
1731 struct image_cache *c;
1732 struct image *img;
1733 unsigned hash;
1734 EMACS_TIME now;
1735
1736 /* F must be a window-system frame, and SPEC must be a valid image
1737 specification. */
1738 xassert (FRAME_WINDOW_P (f));
1739 xassert (valid_image_p (spec));
1740
1741 c = FRAME_IMAGE_CACHE (f);
1742
1743 /* Look up SPEC in the hash table of the image cache. */
1744 hash = sxhash (spec, 0);
1745 img = search_image_cache (f, spec, hash);
1746 if (img && img->load_failed_p)
1747 {
1748 free_image (f, img);
1749 img = NULL;
1750 }
1751
1752 /* If not found, create a new image and cache it. */
1753 if (img == NULL)
1754 {
1755 BLOCK_INPUT;
1756 img = make_image (spec, hash);
1757 cache_image (f, img);
1758 img->load_failed_p = img->type->load (f, img) == 0;
1759 img->frame_foreground = FRAME_FOREGROUND_PIXEL (f);
1760 img->frame_background = FRAME_BACKGROUND_PIXEL (f);
1761
1762 /* If we can't load the image, and we don't have a width and
1763 height, use some arbitrary width and height so that we can
1764 draw a rectangle for it. */
1765 if (img->load_failed_p)
1766 {
1767 Lisp_Object value;
1768
1769 value = image_spec_value (spec, QCwidth, NULL);
1770 img->width = (INTEGERP (value)
1771 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
1772 value = image_spec_value (spec, QCheight, NULL);
1773 img->height = (INTEGERP (value)
1774 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
1775 }
1776 else
1777 {
1778 /* Handle image type independent image attributes
1779 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1780 `:background COLOR'. */
1781 Lisp_Object ascent, margin, relief, bg;
1782
1783 ascent = image_spec_value (spec, QCascent, NULL);
1784 if (INTEGERP (ascent))
1785 img->ascent = XFASTINT (ascent);
1786 else if (EQ (ascent, Qcenter))
1787 img->ascent = CENTERED_IMAGE_ASCENT;
1788
1789 margin = image_spec_value (spec, QCmargin, NULL);
1790 if (INTEGERP (margin) && XINT (margin) >= 0)
1791 img->vmargin = img->hmargin = XFASTINT (margin);
1792 else if (CONSP (margin) && INTEGERP (XCAR (margin))
1793 && INTEGERP (XCDR (margin)))
1794 {
1795 if (XINT (XCAR (margin)) > 0)
1796 img->hmargin = XFASTINT (XCAR (margin));
1797 if (XINT (XCDR (margin)) > 0)
1798 img->vmargin = XFASTINT (XCDR (margin));
1799 }
1800
1801 relief = image_spec_value (spec, QCrelief, NULL);
1802 if (INTEGERP (relief))
1803 {
1804 img->relief = XINT (relief);
1805 img->hmargin += eabs (img->relief);
1806 img->vmargin += eabs (img->relief);
1807 }
1808
1809 if (! img->background_valid)
1810 {
1811 bg = image_spec_value (img->spec, QCbackground, NULL);
1812 if (!NILP (bg))
1813 {
1814 img->background
1815 = x_alloc_image_color (f, img, bg,
1816 FRAME_BACKGROUND_PIXEL (f));
1817 img->background_valid = 1;
1818 }
1819 }
1820
1821 /* Do image transformations and compute masks, unless we
1822 don't have the image yet. */
1823 if (!EQ (*img->type->type, Qpostscript))
1824 postprocess_image (f, img);
1825 }
1826
1827 UNBLOCK_INPUT;
1828 }
1829
1830 /* We're using IMG, so set its timestamp to `now'. */
1831 EMACS_GET_TIME (now);
1832 img->timestamp = EMACS_SECS (now);
1833
1834 /* Value is the image id. */
1835 return img->id;
1836 }
1837
1838
1839 /* Cache image IMG in the image cache of frame F. */
1840
1841 static void
1842 cache_image (struct frame *f, struct image *img)
1843 {
1844 struct image_cache *c = FRAME_IMAGE_CACHE (f);
1845 int i;
1846
1847 /* Find a free slot in c->images. */
1848 for (i = 0; i < c->used; ++i)
1849 if (c->images[i] == NULL)
1850 break;
1851
1852 /* If no free slot found, maybe enlarge c->images. */
1853 if (i == c->used && c->used == c->size)
1854 {
1855 c->size *= 2;
1856 c->images = (struct image **) xrealloc (c->images,
1857 c->size * sizeof *c->images);
1858 }
1859
1860 /* Add IMG to c->images, and assign IMG an id. */
1861 c->images[i] = img;
1862 img->id = i;
1863 if (i == c->used)
1864 ++c->used;
1865
1866 /* Add IMG to the cache's hash table. */
1867 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
1868 img->next = c->buckets[i];
1869 if (img->next)
1870 img->next->prev = img;
1871 img->prev = NULL;
1872 c->buckets[i] = img;
1873 }
1874
1875
1876 /* Call FN on every image in the image cache of frame F. Used to mark
1877 Lisp Objects in the image cache. */
1878
1879 /* Mark Lisp objects in image IMG. */
1880
1881 static void
1882 mark_image (struct image *img)
1883 {
1884 mark_object (img->spec);
1885 mark_object (img->dependencies);
1886
1887 if (!NILP (img->data.lisp_val))
1888 mark_object (img->data.lisp_val);
1889 }
1890
1891
1892 void
1893 mark_image_cache (struct image_cache *c)
1894 {
1895 if (c)
1896 {
1897 int i;
1898 for (i = 0; i < c->used; ++i)
1899 if (c->images[i])
1900 mark_image (c->images[i]);
1901 }
1902 }
1903
1904
1905 \f
1906 /***********************************************************************
1907 X / NS / W32 support code
1908 ***********************************************************************/
1909
1910 #ifdef HAVE_NTGUI
1911
1912 /* Macro for defining functions that will be loaded from image DLLs. */
1913 #define DEF_IMGLIB_FN(func,args) int (FAR CDECL *fn_##func)args
1914
1915 /* Macro for loading those image functions from the library. */
1916 #define LOAD_IMGLIB_FN(lib,func) { \
1917 fn_##func = (void *) GetProcAddress (lib, #func); \
1918 if (!fn_##func) return 0; \
1919 }
1920
1921 /* Load a DLL implementing an image type.
1922 The argument LIBRARIES is usually the variable
1923 `dynamic-library-alist', which associates a symbol, identifying
1924 an external DLL library, to a list of possible filenames.
1925 The function returns NULL if no library could be loaded for
1926 the given symbol, or if the library was previously loaded;
1927 else the handle of the DLL. */
1928 static HMODULE
1929 w32_delayed_load (Lisp_Object libraries, Lisp_Object type)
1930 {
1931 HMODULE library = NULL;
1932
1933 if (CONSP (libraries) && NILP (Fassq (type, Vimage_type_cache)))
1934 {
1935 Lisp_Object dlls = Fassq (type, libraries);
1936
1937 if (CONSP (dlls))
1938 for (dlls = XCDR (dlls); CONSP (dlls); dlls = XCDR (dlls))
1939 {
1940 CHECK_STRING_CAR (dlls);
1941 if (library = LoadLibrary (SDATA (XCAR (dlls))))
1942 break;
1943 }
1944 }
1945
1946 return library;
1947 }
1948
1949 #endif /* HAVE_NTGUI */
1950
1951 static int x_create_x_image_and_pixmap (struct frame *, int, int, int,
1952 XImagePtr *, Pixmap *);
1953 static void x_destroy_x_image (XImagePtr);
1954 static void x_put_x_image (struct frame *, XImagePtr, Pixmap, int, int);
1955
1956
1957 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1958 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1959 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1960 via xmalloc. Print error messages via image_error if an error
1961 occurs. Value is non-zero if successful.
1962
1963 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1964 should indicate the bit depth of the image. */
1965
1966 static int
1967 x_create_x_image_and_pixmap (struct frame *f, int width, int height, int depth,
1968 XImagePtr *ximg, Pixmap *pixmap)
1969 {
1970 #ifdef HAVE_X_WINDOWS
1971 Display *display = FRAME_X_DISPLAY (f);
1972 Window window = FRAME_X_WINDOW (f);
1973 Screen *screen = FRAME_X_SCREEN (f);
1974
1975 xassert (interrupt_input_blocked);
1976
1977 if (depth <= 0)
1978 depth = DefaultDepthOfScreen (screen);
1979 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
1980 depth, ZPixmap, 0, NULL, width, height,
1981 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
1982 if (*ximg == NULL)
1983 {
1984 image_error ("Unable to allocate X image", Qnil, Qnil);
1985 return 0;
1986 }
1987
1988 /* Allocate image raster. */
1989 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
1990
1991 /* Allocate a pixmap of the same size. */
1992 *pixmap = XCreatePixmap (display, window, width, height, depth);
1993 if (*pixmap == NO_PIXMAP)
1994 {
1995 x_destroy_x_image (*ximg);
1996 *ximg = NULL;
1997 image_error ("Unable to create X pixmap", Qnil, Qnil);
1998 return 0;
1999 }
2000
2001 return 1;
2002 #endif /* HAVE_X_WINDOWS */
2003
2004 #ifdef HAVE_NTGUI
2005
2006 BITMAPINFOHEADER *header;
2007 HDC hdc;
2008 int scanline_width_bits;
2009 int remainder;
2010 int palette_colors = 0;
2011
2012 if (depth == 0)
2013 depth = 24;
2014
2015 if (depth != 1 && depth != 4 && depth != 8
2016 && depth != 16 && depth != 24 && depth != 32)
2017 {
2018 image_error ("Invalid image bit depth specified", Qnil, Qnil);
2019 return 0;
2020 }
2021
2022 scanline_width_bits = width * depth;
2023 remainder = scanline_width_bits % 32;
2024
2025 if (remainder)
2026 scanline_width_bits += 32 - remainder;
2027
2028 /* Bitmaps with a depth less than 16 need a palette. */
2029 /* BITMAPINFO structure already contains the first RGBQUAD. */
2030 if (depth < 16)
2031 palette_colors = 1 << depth - 1;
2032
2033 *ximg = xmalloc (sizeof (XImage) + palette_colors * sizeof (RGBQUAD));
2034 if (*ximg == NULL)
2035 {
2036 image_error ("Unable to allocate memory for XImage", Qnil, Qnil);
2037 return 0;
2038 }
2039
2040 header = &(*ximg)->info.bmiHeader;
2041 memset (&(*ximg)->info, 0, sizeof (BITMAPINFO));
2042 header->biSize = sizeof (*header);
2043 header->biWidth = width;
2044 header->biHeight = -height; /* negative indicates a top-down bitmap. */
2045 header->biPlanes = 1;
2046 header->biBitCount = depth;
2047 header->biCompression = BI_RGB;
2048 header->biClrUsed = palette_colors;
2049
2050 /* TODO: fill in palette. */
2051 if (depth == 1)
2052 {
2053 (*ximg)->info.bmiColors[0].rgbBlue = 0;
2054 (*ximg)->info.bmiColors[0].rgbGreen = 0;
2055 (*ximg)->info.bmiColors[0].rgbRed = 0;
2056 (*ximg)->info.bmiColors[0].rgbReserved = 0;
2057 (*ximg)->info.bmiColors[1].rgbBlue = 255;
2058 (*ximg)->info.bmiColors[1].rgbGreen = 255;
2059 (*ximg)->info.bmiColors[1].rgbRed = 255;
2060 (*ximg)->info.bmiColors[1].rgbReserved = 0;
2061 }
2062
2063 hdc = get_frame_dc (f);
2064
2065 /* Create a DIBSection and raster array for the bitmap,
2066 and store its handle in *pixmap. */
2067 *pixmap = CreateDIBSection (hdc, &((*ximg)->info),
2068 (depth < 16) ? DIB_PAL_COLORS : DIB_RGB_COLORS,
2069 /* casting avoids a GCC warning */
2070 (void **)&((*ximg)->data), NULL, 0);
2071
2072 /* Realize display palette and garbage all frames. */
2073 release_frame_dc (f, hdc);
2074
2075 if (*pixmap == NULL)
2076 {
2077 DWORD err = GetLastError ();
2078 Lisp_Object errcode;
2079 /* All system errors are < 10000, so the following is safe. */
2080 XSETINT (errcode, (int) err);
2081 image_error ("Unable to create bitmap, error code %d", errcode, Qnil);
2082 x_destroy_x_image (*ximg);
2083 return 0;
2084 }
2085
2086 return 1;
2087
2088 #endif /* HAVE_NTGUI */
2089
2090 #ifdef HAVE_NS
2091 *pixmap = ns_image_for_XPM (width, height, depth);
2092 if (*pixmap == 0)
2093 {
2094 *ximg = NULL;
2095 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil, Qnil);
2096 return 0;
2097 }
2098 *ximg = *pixmap;
2099 return 1;
2100 #endif
2101 }
2102
2103
2104 /* Destroy XImage XIMG. Free XIMG->data. */
2105
2106 static void
2107 x_destroy_x_image (XImagePtr ximg)
2108 {
2109 xassert (interrupt_input_blocked);
2110 if (ximg)
2111 {
2112 #ifdef HAVE_X_WINDOWS
2113 xfree (ximg->data);
2114 ximg->data = NULL;
2115 XDestroyImage (ximg);
2116 #endif /* HAVE_X_WINDOWS */
2117 #ifdef HAVE_NTGUI
2118 /* Data will be freed by DestroyObject. */
2119 ximg->data = NULL;
2120 xfree (ximg);
2121 #endif /* HAVE_NTGUI */
2122 #ifdef HAVE_NS
2123 ns_release_object (ximg);
2124 #endif /* HAVE_NS */
2125 }
2126 }
2127
2128
2129 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2130 are width and height of both the image and pixmap. */
2131
2132 static void
2133 x_put_x_image (struct frame *f, XImagePtr ximg, Pixmap pixmap, int width, int height)
2134 {
2135 #ifdef HAVE_X_WINDOWS
2136 GC gc;
2137
2138 xassert (interrupt_input_blocked);
2139 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
2140 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
2141 XFreeGC (FRAME_X_DISPLAY (f), gc);
2142 #endif /* HAVE_X_WINDOWS */
2143
2144 #ifdef HAVE_NTGUI
2145 #if 0 /* I don't think this is necessary looking at where it is used. */
2146 HDC hdc = get_frame_dc (f);
2147 SetDIBits (hdc, pixmap, 0, height, ximg->data, &(ximg->info), DIB_RGB_COLORS);
2148 release_frame_dc (f, hdc);
2149 #endif
2150 #endif /* HAVE_NTGUI */
2151
2152 #ifdef HAVE_NS
2153 xassert (ximg == pixmap);
2154 ns_retain_object (ximg);
2155 #endif
2156 }
2157
2158 \f
2159 /***********************************************************************
2160 File Handling
2161 ***********************************************************************/
2162
2163 static unsigned char *slurp_file (char *, int *);
2164
2165
2166 /* Find image file FILE. Look in data-directory/images, then
2167 x-bitmap-file-path. Value is the encoded full name of the file
2168 found, or nil if not found. */
2169
2170 Lisp_Object
2171 x_find_image_file (Lisp_Object file)
2172 {
2173 Lisp_Object file_found, search_path;
2174 int fd;
2175
2176 /* TODO I think this should use something like image-load-path
2177 instead. Unfortunately, that can contain non-string elements. */
2178 search_path = Fcons (Fexpand_file_name (build_string ("images"),
2179 Vdata_directory),
2180 Vx_bitmap_file_path);
2181
2182 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2183 fd = openp (search_path, file, Qnil, &file_found, Qnil);
2184
2185 if (fd == -1)
2186 file_found = Qnil;
2187 else
2188 {
2189 file_found = ENCODE_FILE (file_found);
2190 close (fd);
2191 }
2192
2193 return file_found;
2194 }
2195
2196
2197 /* Read FILE into memory. Value is a pointer to a buffer allocated
2198 with xmalloc holding FILE's contents. Value is null if an error
2199 occurred. *SIZE is set to the size of the file. */
2200
2201 static unsigned char *
2202 slurp_file (char *file, int *size)
2203 {
2204 FILE *fp = NULL;
2205 unsigned char *buf = NULL;
2206 struct stat st;
2207
2208 if (stat (file, &st) == 0
2209 && (fp = fopen (file, "rb")) != NULL
2210 && (buf = (unsigned char *) xmalloc (st.st_size),
2211 fread (buf, 1, st.st_size, fp) == st.st_size))
2212 {
2213 *size = st.st_size;
2214 fclose (fp);
2215 }
2216 else
2217 {
2218 if (fp)
2219 fclose (fp);
2220 if (buf)
2221 {
2222 xfree (buf);
2223 buf = NULL;
2224 }
2225 }
2226
2227 return buf;
2228 }
2229
2230
2231 \f
2232 /***********************************************************************
2233 XBM images
2234 ***********************************************************************/
2235
2236 static int xbm_scan (unsigned char **, unsigned char *, char *, int *);
2237 static int xbm_load (struct frame *f, struct image *img);
2238 static int xbm_load_image (struct frame *f, struct image *img,
2239 unsigned char *, unsigned char *);
2240 static int xbm_image_p (Lisp_Object object);
2241 static int xbm_read_bitmap_data (struct frame *f,
2242 unsigned char *, unsigned char *,
2243 int *, int *, unsigned char **, int);
2244 static int xbm_file_p (Lisp_Object);
2245
2246
2247 /* Indices of image specification fields in xbm_format, below. */
2248
2249 enum xbm_keyword_index
2250 {
2251 XBM_TYPE,
2252 XBM_FILE,
2253 XBM_WIDTH,
2254 XBM_HEIGHT,
2255 XBM_DATA,
2256 XBM_FOREGROUND,
2257 XBM_BACKGROUND,
2258 XBM_ASCENT,
2259 XBM_MARGIN,
2260 XBM_RELIEF,
2261 XBM_ALGORITHM,
2262 XBM_HEURISTIC_MASK,
2263 XBM_MASK,
2264 XBM_LAST
2265 };
2266
2267 /* Vector of image_keyword structures describing the format
2268 of valid XBM image specifications. */
2269
2270 static const struct image_keyword xbm_format[XBM_LAST] =
2271 {
2272 {":type", IMAGE_SYMBOL_VALUE, 1},
2273 {":file", IMAGE_STRING_VALUE, 0},
2274 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
2275 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
2276 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2277 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
2278 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
2279 {":ascent", IMAGE_ASCENT_VALUE, 0},
2280 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
2281 {":relief", IMAGE_INTEGER_VALUE, 0},
2282 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2283 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
2284 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
2285 };
2286
2287 /* Structure describing the image type XBM. */
2288
2289 static struct image_type xbm_type =
2290 {
2291 &Qxbm,
2292 xbm_image_p,
2293 xbm_load,
2294 x_clear_image,
2295 NULL
2296 };
2297
2298 /* Tokens returned from xbm_scan. */
2299
2300 enum xbm_token
2301 {
2302 XBM_TK_IDENT = 256,
2303 XBM_TK_NUMBER
2304 };
2305
2306
2307 /* Return non-zero if OBJECT is a valid XBM-type image specification.
2308 A valid specification is a list starting with the symbol `image'
2309 The rest of the list is a property list which must contain an
2310 entry `:type xbm..
2311
2312 If the specification specifies a file to load, it must contain
2313 an entry `:file FILENAME' where FILENAME is a string.
2314
2315 If the specification is for a bitmap loaded from memory it must
2316 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2317 WIDTH and HEIGHT are integers > 0. DATA may be:
2318
2319 1. a string large enough to hold the bitmap data, i.e. it must
2320 have a size >= (WIDTH + 7) / 8 * HEIGHT
2321
2322 2. a bool-vector of size >= WIDTH * HEIGHT
2323
2324 3. a vector of strings or bool-vectors, one for each line of the
2325 bitmap.
2326
2327 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2328 may not be specified in this case because they are defined in the
2329 XBM file.
2330
2331 Both the file and data forms may contain the additional entries
2332 `:background COLOR' and `:foreground COLOR'. If not present,
2333 foreground and background of the frame on which the image is
2334 displayed is used. */
2335
2336 static int
2337 xbm_image_p (Lisp_Object object)
2338 {
2339 struct image_keyword kw[XBM_LAST];
2340
2341 memcpy (kw, xbm_format, sizeof kw);
2342 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
2343 return 0;
2344
2345 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
2346
2347 if (kw[XBM_FILE].count)
2348 {
2349 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
2350 return 0;
2351 }
2352 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
2353 {
2354 /* In-memory XBM file. */
2355 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
2356 return 0;
2357 }
2358 else
2359 {
2360 Lisp_Object data;
2361 int width, height;
2362
2363 /* Entries for `:width', `:height' and `:data' must be present. */
2364 if (!kw[XBM_WIDTH].count
2365 || !kw[XBM_HEIGHT].count
2366 || !kw[XBM_DATA].count)
2367 return 0;
2368
2369 data = kw[XBM_DATA].value;
2370 width = XFASTINT (kw[XBM_WIDTH].value);
2371 height = XFASTINT (kw[XBM_HEIGHT].value);
2372
2373 /* Check type of data, and width and height against contents of
2374 data. */
2375 if (VECTORP (data))
2376 {
2377 int i;
2378
2379 /* Number of elements of the vector must be >= height. */
2380 if (XVECTOR (data)->size < height)
2381 return 0;
2382
2383 /* Each string or bool-vector in data must be large enough
2384 for one line of the image. */
2385 for (i = 0; i < height; ++i)
2386 {
2387 Lisp_Object elt = XVECTOR (data)->contents[i];
2388
2389 if (STRINGP (elt))
2390 {
2391 if (SCHARS (elt)
2392 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
2393 return 0;
2394 }
2395 else if (BOOL_VECTOR_P (elt))
2396 {
2397 if (XBOOL_VECTOR (elt)->size < width)
2398 return 0;
2399 }
2400 else
2401 return 0;
2402 }
2403 }
2404 else if (STRINGP (data))
2405 {
2406 if (SCHARS (data)
2407 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
2408 return 0;
2409 }
2410 else if (BOOL_VECTOR_P (data))
2411 {
2412 if (XBOOL_VECTOR (data)->size < width * height)
2413 return 0;
2414 }
2415 else
2416 return 0;
2417 }
2418
2419 return 1;
2420 }
2421
2422
2423 /* Scan a bitmap file. FP is the stream to read from. Value is
2424 either an enumerator from enum xbm_token, or a character for a
2425 single-character token, or 0 at end of file. If scanning an
2426 identifier, store the lexeme of the identifier in SVAL. If
2427 scanning a number, store its value in *IVAL. */
2428
2429 static int
2430 xbm_scan (unsigned char **s, unsigned char *end, char *sval, int *ival)
2431 {
2432 unsigned int c;
2433
2434 loop:
2435
2436 /* Skip white space. */
2437 while (*s < end && (c = *(*s)++, isspace (c)))
2438 ;
2439
2440 if (*s >= end)
2441 c = 0;
2442 else if (isdigit (c))
2443 {
2444 int value = 0, digit;
2445
2446 if (c == '0' && *s < end)
2447 {
2448 c = *(*s)++;
2449 if (c == 'x' || c == 'X')
2450 {
2451 while (*s < end)
2452 {
2453 c = *(*s)++;
2454 if (isdigit (c))
2455 digit = c - '0';
2456 else if (c >= 'a' && c <= 'f')
2457 digit = c - 'a' + 10;
2458 else if (c >= 'A' && c <= 'F')
2459 digit = c - 'A' + 10;
2460 else
2461 break;
2462 value = 16 * value + digit;
2463 }
2464 }
2465 else if (isdigit (c))
2466 {
2467 value = c - '0';
2468 while (*s < end
2469 && (c = *(*s)++, isdigit (c)))
2470 value = 8 * value + c - '0';
2471 }
2472 }
2473 else
2474 {
2475 value = c - '0';
2476 while (*s < end
2477 && (c = *(*s)++, isdigit (c)))
2478 value = 10 * value + c - '0';
2479 }
2480
2481 if (*s < end)
2482 *s = *s - 1;
2483 *ival = value;
2484 c = XBM_TK_NUMBER;
2485 }
2486 else if (isalpha (c) || c == '_')
2487 {
2488 *sval++ = c;
2489 while (*s < end
2490 && (c = *(*s)++, (isalnum (c) || c == '_')))
2491 *sval++ = c;
2492 *sval = 0;
2493 if (*s < end)
2494 *s = *s - 1;
2495 c = XBM_TK_IDENT;
2496 }
2497 else if (c == '/' && **s == '*')
2498 {
2499 /* C-style comment. */
2500 ++*s;
2501 while (**s && (**s != '*' || *(*s + 1) != '/'))
2502 ++*s;
2503 if (**s)
2504 {
2505 *s += 2;
2506 goto loop;
2507 }
2508 }
2509
2510 return c;
2511 }
2512
2513 #ifdef HAVE_NTGUI
2514
2515 /* Create a Windows bitmap from X bitmap data. */
2516 static HBITMAP
2517 w32_create_pixmap_from_bitmap_data (int width, int height, char *data)
2518 {
2519 static unsigned char swap_nibble[16]
2520 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2521 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2522 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2523 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2524 int i, j, w1, w2;
2525 unsigned char *bits, *p;
2526 HBITMAP bmp;
2527
2528 w1 = (width + 7) / 8; /* nb of 8bits elt in X bitmap */
2529 w2 = ((width + 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2530 bits = (unsigned char *) alloca (height * w2);
2531 memset (bits, 0, height * w2);
2532 for (i = 0; i < height; i++)
2533 {
2534 p = bits + i*w2;
2535 for (j = 0; j < w1; j++)
2536 {
2537 /* Bitswap XBM bytes to match how Windows does things. */
2538 unsigned char c = *data++;
2539 *p++ = (unsigned char)((swap_nibble[c & 0xf] << 4)
2540 | (swap_nibble[(c>>4) & 0xf]));
2541 }
2542 }
2543 bmp = CreateBitmap (width, height, 1, 1, (char *) bits);
2544
2545 return bmp;
2546 }
2547
2548 static void
2549 convert_mono_to_color_image (struct frame *f, struct image *img,
2550 COLORREF foreground, COLORREF background)
2551 {
2552 HDC hdc, old_img_dc, new_img_dc;
2553 HGDIOBJ old_prev, new_prev;
2554 HBITMAP new_pixmap;
2555
2556 hdc = get_frame_dc (f);
2557 old_img_dc = CreateCompatibleDC (hdc);
2558 new_img_dc = CreateCompatibleDC (hdc);
2559 new_pixmap = CreateCompatibleBitmap (hdc, img->width, img->height);
2560 release_frame_dc (f, hdc);
2561 old_prev = SelectObject (old_img_dc, img->pixmap);
2562 new_prev = SelectObject (new_img_dc, new_pixmap);
2563 /* Windows convention for mono bitmaps is black = background,
2564 white = foreground. */
2565 SetTextColor (new_img_dc, background);
2566 SetBkColor (new_img_dc, foreground);
2567
2568 BitBlt (new_img_dc, 0, 0, img->width, img->height, old_img_dc,
2569 0, 0, SRCCOPY);
2570
2571 SelectObject (old_img_dc, old_prev);
2572 SelectObject (new_img_dc, new_prev);
2573 DeleteDC (old_img_dc);
2574 DeleteDC (new_img_dc);
2575 DeleteObject (img->pixmap);
2576 if (new_pixmap == 0)
2577 fprintf (stderr, "Failed to convert image to color.\n");
2578 else
2579 img->pixmap = new_pixmap;
2580 }
2581
2582 #define XBM_BIT_SHUFFLE(b) (~(b))
2583
2584 #else
2585
2586 #define XBM_BIT_SHUFFLE(b) (b)
2587
2588 #endif /* HAVE_NTGUI */
2589
2590
2591 static void
2592 Create_Pixmap_From_Bitmap_Data (struct frame *f, struct image *img, char *data,
2593 RGB_PIXEL_COLOR fg, RGB_PIXEL_COLOR bg,
2594 int non_default_colors)
2595 {
2596 #ifdef HAVE_NTGUI
2597 img->pixmap
2598 = w32_create_pixmap_from_bitmap_data (img->width, img->height, data);
2599
2600 /* If colors were specified, transfer the bitmap to a color one. */
2601 if (non_default_colors)
2602 convert_mono_to_color_image (f, img, fg, bg);
2603
2604 #elif defined (HAVE_NS)
2605 img->pixmap = ns_image_from_XBM (data, img->width, img->height);
2606
2607 #else
2608 img->pixmap
2609 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
2610 FRAME_X_WINDOW (f),
2611 data,
2612 img->width, img->height,
2613 fg, bg,
2614 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
2615 #endif /* !HAVE_NTGUI && !HAVE_NS */
2616 }
2617
2618
2619
2620 /* Replacement for XReadBitmapFileData which isn't available under old
2621 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2622 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2623 the image. Return in *DATA the bitmap data allocated with xmalloc.
2624 Value is non-zero if successful. DATA null means just test if
2625 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR
2626 is non-zero, inhibit the call to image_error when the image size is
2627 invalid (the bitmap remains unread). */
2628
2629 static int
2630 xbm_read_bitmap_data (struct frame *f, unsigned char *contents, unsigned char *end,
2631 int *width, int *height, unsigned char **data,
2632 int inhibit_image_error)
2633 {
2634 unsigned char *s = contents;
2635 char buffer[BUFSIZ];
2636 int padding_p = 0;
2637 int v10 = 0;
2638 int bytes_per_line, i, nbytes;
2639 unsigned char *p;
2640 int value;
2641 int LA1;
2642
2643 #define match() \
2644 LA1 = xbm_scan (&s, end, buffer, &value)
2645
2646 #define expect(TOKEN) \
2647 if (LA1 != (TOKEN)) \
2648 goto failure; \
2649 else \
2650 match ()
2651
2652 #define expect_ident(IDENT) \
2653 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2654 match (); \
2655 else \
2656 goto failure
2657
2658 *width = *height = -1;
2659 if (data)
2660 *data = NULL;
2661 LA1 = xbm_scan (&s, end, buffer, &value);
2662
2663 /* Parse defines for width, height and hot-spots. */
2664 while (LA1 == '#')
2665 {
2666 match ();
2667 expect_ident ("define");
2668 expect (XBM_TK_IDENT);
2669
2670 if (LA1 == XBM_TK_NUMBER)
2671 {
2672 char *p = strrchr (buffer, '_');
2673 p = p ? p + 1 : buffer;
2674 if (strcmp (p, "width") == 0)
2675 *width = value;
2676 else if (strcmp (p, "height") == 0)
2677 *height = value;
2678 }
2679 expect (XBM_TK_NUMBER);
2680 }
2681
2682 if (!check_image_size (f, *width, *height))
2683 {
2684 if (!inhibit_image_error)
2685 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
2686 goto failure;
2687 }
2688 else if (data == NULL)
2689 goto success;
2690
2691 /* Parse bits. Must start with `static'. */
2692 expect_ident ("static");
2693 if (LA1 == XBM_TK_IDENT)
2694 {
2695 if (strcmp (buffer, "unsigned") == 0)
2696 {
2697 match ();
2698 expect_ident ("char");
2699 }
2700 else if (strcmp (buffer, "short") == 0)
2701 {
2702 match ();
2703 v10 = 1;
2704 if (*width % 16 && *width % 16 < 9)
2705 padding_p = 1;
2706 }
2707 else if (strcmp (buffer, "char") == 0)
2708 match ();
2709 else
2710 goto failure;
2711 }
2712 else
2713 goto failure;
2714
2715 expect (XBM_TK_IDENT);
2716 expect ('[');
2717 expect (']');
2718 expect ('=');
2719 expect ('{');
2720
2721 bytes_per_line = (*width + 7) / 8 + padding_p;
2722 nbytes = bytes_per_line * *height;
2723 p = *data = (unsigned char *) xmalloc (nbytes);
2724
2725 if (v10)
2726 {
2727 for (i = 0; i < nbytes; i += 2)
2728 {
2729 int val = value;
2730 expect (XBM_TK_NUMBER);
2731
2732 *p++ = XBM_BIT_SHUFFLE (val);
2733 if (!padding_p || ((i + 2) % bytes_per_line))
2734 *p++ = XBM_BIT_SHUFFLE (value >> 8);
2735
2736 if (LA1 == ',' || LA1 == '}')
2737 match ();
2738 else
2739 goto failure;
2740 }
2741 }
2742 else
2743 {
2744 for (i = 0; i < nbytes; ++i)
2745 {
2746 int val = value;
2747 expect (XBM_TK_NUMBER);
2748
2749 *p++ = XBM_BIT_SHUFFLE (val);
2750
2751 if (LA1 == ',' || LA1 == '}')
2752 match ();
2753 else
2754 goto failure;
2755 }
2756 }
2757
2758 success:
2759 return 1;
2760
2761 failure:
2762
2763 if (data && *data)
2764 {
2765 xfree (*data);
2766 *data = NULL;
2767 }
2768 return 0;
2769
2770 #undef match
2771 #undef expect
2772 #undef expect_ident
2773 }
2774
2775
2776 /* Load XBM image IMG which will be displayed on frame F from buffer
2777 CONTENTS. END is the end of the buffer. Value is non-zero if
2778 successful. */
2779
2780 static int
2781 xbm_load_image (struct frame *f, struct image *img, unsigned char *contents,
2782 unsigned char *end)
2783 {
2784 int rc;
2785 unsigned char *data;
2786 int success_p = 0;
2787
2788 rc = xbm_read_bitmap_data (f, contents, end, &img->width, &img->height,
2789 &data, 0);
2790 if (rc)
2791 {
2792 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
2793 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
2794 int non_default_colors = 0;
2795 Lisp_Object value;
2796
2797 xassert (img->width > 0 && img->height > 0);
2798
2799 /* Get foreground and background colors, maybe allocate colors. */
2800 value = image_spec_value (img->spec, QCforeground, NULL);
2801 if (!NILP (value))
2802 {
2803 foreground = x_alloc_image_color (f, img, value, foreground);
2804 non_default_colors = 1;
2805 }
2806 value = image_spec_value (img->spec, QCbackground, NULL);
2807 if (!NILP (value))
2808 {
2809 background = x_alloc_image_color (f, img, value, background);
2810 img->background = background;
2811 img->background_valid = 1;
2812 non_default_colors = 1;
2813 }
2814
2815 Create_Pixmap_From_Bitmap_Data (f, img, data,
2816 foreground, background,
2817 non_default_colors);
2818 xfree (data);
2819
2820 if (img->pixmap == NO_PIXMAP)
2821 {
2822 x_clear_image (f, img);
2823 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
2824 }
2825 else
2826 success_p = 1;
2827 }
2828 else
2829 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
2830
2831 return success_p;
2832 }
2833
2834
2835 /* Value is non-zero if DATA looks like an in-memory XBM file. */
2836
2837 static int
2838 xbm_file_p (Lisp_Object data)
2839 {
2840 int w, h;
2841 return (STRINGP (data)
2842 && xbm_read_bitmap_data (NULL, SDATA (data),
2843 (SDATA (data) + SBYTES (data)),
2844 &w, &h, NULL, 1));
2845 }
2846
2847
2848 /* Fill image IMG which is used on frame F with pixmap data. Value is
2849 non-zero if successful. */
2850
2851 static int
2852 xbm_load (struct frame *f, struct image *img)
2853 {
2854 int success_p = 0;
2855 Lisp_Object file_name;
2856
2857 xassert (xbm_image_p (img->spec));
2858
2859 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2860 file_name = image_spec_value (img->spec, QCfile, NULL);
2861 if (STRINGP (file_name))
2862 {
2863 Lisp_Object file;
2864 unsigned char *contents;
2865 int size;
2866
2867 file = x_find_image_file (file_name);
2868 if (!STRINGP (file))
2869 {
2870 image_error ("Cannot find image file `%s'", file_name, Qnil);
2871 return 0;
2872 }
2873
2874 contents = slurp_file (SDATA (file), &size);
2875 if (contents == NULL)
2876 {
2877 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
2878 return 0;
2879 }
2880
2881 success_p = xbm_load_image (f, img, contents, contents + size);
2882 }
2883 else
2884 {
2885 struct image_keyword fmt[XBM_LAST];
2886 Lisp_Object data;
2887 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
2888 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
2889 int non_default_colors = 0;
2890 char *bits;
2891 int parsed_p;
2892 int in_memory_file_p = 0;
2893
2894 /* See if data looks like an in-memory XBM file. */
2895 data = image_spec_value (img->spec, QCdata, NULL);
2896 in_memory_file_p = xbm_file_p (data);
2897
2898 /* Parse the image specification. */
2899 memcpy (fmt, xbm_format, sizeof fmt);
2900 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
2901 xassert (parsed_p);
2902
2903 /* Get specified width, and height. */
2904 if (!in_memory_file_p)
2905 {
2906 img->width = XFASTINT (fmt[XBM_WIDTH].value);
2907 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
2908 xassert (img->width > 0 && img->height > 0);
2909 }
2910
2911 /* Get foreground and background colors, maybe allocate colors. */
2912 if (fmt[XBM_FOREGROUND].count
2913 && STRINGP (fmt[XBM_FOREGROUND].value))
2914 {
2915 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
2916 foreground);
2917 non_default_colors = 1;
2918 }
2919
2920 if (fmt[XBM_BACKGROUND].count
2921 && STRINGP (fmt[XBM_BACKGROUND].value))
2922 {
2923 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
2924 background);
2925 non_default_colors = 1;
2926 }
2927
2928 if (in_memory_file_p)
2929 success_p = xbm_load_image (f, img, SDATA (data),
2930 (SDATA (data)
2931 + SBYTES (data)));
2932 else
2933 {
2934 if (VECTORP (data))
2935 {
2936 int i;
2937 char *p;
2938 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
2939
2940 p = bits = (char *) alloca (nbytes * img->height);
2941 for (i = 0; i < img->height; ++i, p += nbytes)
2942 {
2943 Lisp_Object line = XVECTOR (data)->contents[i];
2944 if (STRINGP (line))
2945 memcpy (p, SDATA (line), nbytes);
2946 else
2947 memcpy (p, XBOOL_VECTOR (line)->data, nbytes);
2948 }
2949 }
2950 else if (STRINGP (data))
2951 bits = SDATA (data);
2952 else
2953 bits = XBOOL_VECTOR (data)->data;
2954
2955 #ifdef WINDOWSNT
2956 {
2957 char *invertedBits;
2958 int nbytes, i;
2959 /* Windows mono bitmaps are reversed compared with X. */
2960 invertedBits = bits;
2961 nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR
2962 * img->height;
2963 bits = (char *) alloca (nbytes);
2964 for (i = 0; i < nbytes; i++)
2965 bits[i] = XBM_BIT_SHUFFLE (invertedBits[i]);
2966 }
2967 #endif
2968 /* Create the pixmap. */
2969
2970 Create_Pixmap_From_Bitmap_Data (f, img, bits,
2971 foreground, background,
2972 non_default_colors);
2973 if (img->pixmap)
2974 success_p = 1;
2975 else
2976 {
2977 image_error ("Unable to create pixmap for XBM image `%s'",
2978 img->spec, Qnil);
2979 x_clear_image (f, img);
2980 }
2981 }
2982 }
2983
2984 return success_p;
2985 }
2986
2987
2988 \f
2989 /***********************************************************************
2990 XPM images
2991 ***********************************************************************/
2992
2993 #if defined (HAVE_XPM) || defined (HAVE_NS)
2994
2995 static int xpm_image_p (Lisp_Object object);
2996 static int xpm_load (struct frame *f, struct image *img);
2997 static int xpm_valid_color_symbols_p (Lisp_Object);
2998
2999 #endif /* HAVE_XPM || HAVE_NS */
3000
3001 #ifdef HAVE_XPM
3002 #ifdef HAVE_NTGUI
3003 /* Indicate to xpm.h that we don't have Xlib. */
3004 #define FOR_MSW
3005 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3006 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3007 #define XColor xpm_XColor
3008 #define XImage xpm_XImage
3009 #define Display xpm_Display
3010 #define PIXEL_ALREADY_TYPEDEFED
3011 #include "X11/xpm.h"
3012 #undef FOR_MSW
3013 #undef XColor
3014 #undef XImage
3015 #undef Display
3016 #undef PIXEL_ALREADY_TYPEDEFED
3017 #else
3018 #include "X11/xpm.h"
3019 #endif /* HAVE_NTGUI */
3020 #endif /* HAVE_XPM */
3021
3022 #if defined (HAVE_XPM) || defined (HAVE_NS)
3023 /* The symbol `xpm' identifying XPM-format images. */
3024
3025 Lisp_Object Qxpm;
3026
3027 /* Indices of image specification fields in xpm_format, below. */
3028
3029 enum xpm_keyword_index
3030 {
3031 XPM_TYPE,
3032 XPM_FILE,
3033 XPM_DATA,
3034 XPM_ASCENT,
3035 XPM_MARGIN,
3036 XPM_RELIEF,
3037 XPM_ALGORITHM,
3038 XPM_HEURISTIC_MASK,
3039 XPM_MASK,
3040 XPM_COLOR_SYMBOLS,
3041 XPM_BACKGROUND,
3042 XPM_LAST
3043 };
3044
3045 /* Vector of image_keyword structures describing the format
3046 of valid XPM image specifications. */
3047
3048 static const struct image_keyword xpm_format[XPM_LAST] =
3049 {
3050 {":type", IMAGE_SYMBOL_VALUE, 1},
3051 {":file", IMAGE_STRING_VALUE, 0},
3052 {":data", IMAGE_STRING_VALUE, 0},
3053 {":ascent", IMAGE_ASCENT_VALUE, 0},
3054 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
3055 {":relief", IMAGE_INTEGER_VALUE, 0},
3056 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3057 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3058 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3059 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
3060 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
3061 };
3062
3063 /* Structure describing the image type XPM. */
3064
3065 static struct image_type xpm_type =
3066 {
3067 &Qxpm,
3068 xpm_image_p,
3069 xpm_load,
3070 x_clear_image,
3071 NULL
3072 };
3073
3074 #ifdef HAVE_X_WINDOWS
3075
3076 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3077 functions for allocating image colors. Our own functions handle
3078 color allocation failures more gracefully than the ones on the XPM
3079 lib. */
3080
3081 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3082 #define ALLOC_XPM_COLORS
3083 #endif
3084 #endif /* HAVE_X_WINDOWS */
3085
3086 #ifdef ALLOC_XPM_COLORS
3087
3088 static void xpm_init_color_cache (struct frame *, XpmAttributes *);
3089 static void xpm_free_color_cache (void);
3090 static int xpm_lookup_color (struct frame *, char *, XColor *);
3091 static int xpm_color_bucket (char *);
3092 static struct xpm_cached_color *xpm_cache_color (struct frame *, char *,
3093 XColor *, int);
3094
3095 /* An entry in a hash table used to cache color definitions of named
3096 colors. This cache is necessary to speed up XPM image loading in
3097 case we do color allocations ourselves. Without it, we would need
3098 a call to XParseColor per pixel in the image. */
3099
3100 struct xpm_cached_color
3101 {
3102 /* Next in collision chain. */
3103 struct xpm_cached_color *next;
3104
3105 /* Color definition (RGB and pixel color). */
3106 XColor color;
3107
3108 /* Color name. */
3109 char name[1];
3110 };
3111
3112 /* The hash table used for the color cache, and its bucket vector
3113 size. */
3114
3115 #define XPM_COLOR_CACHE_BUCKETS 1001
3116 struct xpm_cached_color **xpm_color_cache;
3117
3118 /* Initialize the color cache. */
3119
3120 static void
3121 xpm_init_color_cache (struct frame *f, XpmAttributes *attrs)
3122 {
3123 size_t nbytes = XPM_COLOR_CACHE_BUCKETS * sizeof *xpm_color_cache;
3124 xpm_color_cache = (struct xpm_cached_color **) xmalloc (nbytes);
3125 memset (xpm_color_cache, 0, nbytes);
3126 init_color_table ();
3127
3128 if (attrs->valuemask & XpmColorSymbols)
3129 {
3130 int i;
3131 XColor color;
3132
3133 for (i = 0; i < attrs->numsymbols; ++i)
3134 if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
3135 attrs->colorsymbols[i].value, &color))
3136 {
3137 color.pixel = lookup_rgb_color (f, color.red, color.green,
3138 color.blue);
3139 xpm_cache_color (f, attrs->colorsymbols[i].name, &color, -1);
3140 }
3141 }
3142 }
3143
3144 /* Free the color cache. */
3145
3146 static void
3147 xpm_free_color_cache (void)
3148 {
3149 struct xpm_cached_color *p, *next;
3150 int i;
3151
3152 for (i = 0; i < XPM_COLOR_CACHE_BUCKETS; ++i)
3153 for (p = xpm_color_cache[i]; p; p = next)
3154 {
3155 next = p->next;
3156 xfree (p);
3157 }
3158
3159 xfree (xpm_color_cache);
3160 xpm_color_cache = NULL;
3161 free_color_table ();
3162 }
3163
3164 /* Return the bucket index for color named COLOR_NAME in the color
3165 cache. */
3166
3167 static int
3168 xpm_color_bucket (char *color_name)
3169 {
3170 unsigned h = 0;
3171 char *s;
3172
3173 for (s = color_name; *s; ++s)
3174 h = (h << 2) ^ *s;
3175 return h %= XPM_COLOR_CACHE_BUCKETS;
3176 }
3177
3178
3179 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3180 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3181 entry added. */
3182
3183 static struct xpm_cached_color *
3184 xpm_cache_color (struct frame *f, char *color_name, XColor *color, int bucket)
3185 {
3186 size_t nbytes;
3187 struct xpm_cached_color *p;
3188
3189 if (bucket < 0)
3190 bucket = xpm_color_bucket (color_name);
3191
3192 nbytes = sizeof *p + strlen (color_name);
3193 p = (struct xpm_cached_color *) xmalloc (nbytes);
3194 strcpy (p->name, color_name);
3195 p->color = *color;
3196 p->next = xpm_color_cache[bucket];
3197 xpm_color_cache[bucket] = p;
3198 return p;
3199 }
3200
3201 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3202 return the cached definition in *COLOR. Otherwise, make a new
3203 entry in the cache and allocate the color. Value is zero if color
3204 allocation failed. */
3205
3206 static int
3207 xpm_lookup_color (struct frame *f, char *color_name, XColor *color)
3208 {
3209 struct xpm_cached_color *p;
3210 int h = xpm_color_bucket (color_name);
3211
3212 for (p = xpm_color_cache[h]; p; p = p->next)
3213 if (strcmp (p->name, color_name) == 0)
3214 break;
3215
3216 if (p != NULL)
3217 *color = p->color;
3218 else if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
3219 color_name, color))
3220 {
3221 color->pixel = lookup_rgb_color (f, color->red, color->green,
3222 color->blue);
3223 p = xpm_cache_color (f, color_name, color, h);
3224 }
3225 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3226 with transparency, and it's useful. */
3227 else if (strcmp ("opaque", color_name) == 0)
3228 {
3229 memset (color, 0, sizeof (XColor)); /* Is this necessary/correct? */
3230 color->pixel = FRAME_FOREGROUND_PIXEL (f);
3231 p = xpm_cache_color (f, color_name, color, h);
3232 }
3233
3234 return p != NULL;
3235 }
3236
3237
3238 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3239 CLOSURE is a pointer to the frame on which we allocate the
3240 color. Return in *COLOR the allocated color. Value is non-zero
3241 if successful. */
3242
3243 static int
3244 xpm_alloc_color (Display *dpy, Colormap cmap, char *color_name, XColor *color,
3245 void *closure)
3246 {
3247 return xpm_lookup_color ((struct frame *) closure, color_name, color);
3248 }
3249
3250
3251 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3252 is a pointer to the frame on which we allocate the color. Value is
3253 non-zero if successful. */
3254
3255 static int
3256 xpm_free_colors (Display *dpy, Colormap cmap, Pixel *pixels, int npixels, void *closure)
3257 {
3258 return 1;
3259 }
3260
3261 #endif /* ALLOC_XPM_COLORS */
3262
3263
3264 #ifdef HAVE_NTGUI
3265
3266 /* XPM library details. */
3267
3268 DEF_IMGLIB_FN (XpmFreeAttributes, (XpmAttributes *));
3269 DEF_IMGLIB_FN (XpmCreateImageFromBuffer, (Display *, char *, xpm_XImage **,
3270 xpm_XImage **, XpmAttributes *));
3271 DEF_IMGLIB_FN (XpmReadFileToImage, (Display *, char *, xpm_XImage **,
3272 xpm_XImage **, XpmAttributes *));
3273 DEF_IMGLIB_FN (XImageFree, (xpm_XImage *));
3274
3275 static int
3276 init_xpm_functions (Lisp_Object libraries)
3277 {
3278 HMODULE library;
3279
3280 if (!(library = w32_delayed_load (libraries, Qxpm)))
3281 return 0;
3282
3283 LOAD_IMGLIB_FN (library, XpmFreeAttributes);
3284 LOAD_IMGLIB_FN (library, XpmCreateImageFromBuffer);
3285 LOAD_IMGLIB_FN (library, XpmReadFileToImage);
3286 LOAD_IMGLIB_FN (library, XImageFree);
3287 return 1;
3288 }
3289
3290 #endif /* HAVE_NTGUI */
3291
3292
3293 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
3294 for XPM images. Such a list must consist of conses whose car and
3295 cdr are strings. */
3296
3297 static int
3298 xpm_valid_color_symbols_p (Lisp_Object color_symbols)
3299 {
3300 while (CONSP (color_symbols))
3301 {
3302 Lisp_Object sym = XCAR (color_symbols);
3303 if (!CONSP (sym)
3304 || !STRINGP (XCAR (sym))
3305 || !STRINGP (XCDR (sym)))
3306 break;
3307 color_symbols = XCDR (color_symbols);
3308 }
3309
3310 return NILP (color_symbols);
3311 }
3312
3313
3314 /* Value is non-zero if OBJECT is a valid XPM image specification. */
3315
3316 static int
3317 xpm_image_p (Lisp_Object object)
3318 {
3319 struct image_keyword fmt[XPM_LAST];
3320 memcpy (fmt, xpm_format, sizeof fmt);
3321 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
3322 /* Either `:file' or `:data' must be present. */
3323 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
3324 /* Either no `:color-symbols' or it's a list of conses
3325 whose car and cdr are strings. */
3326 && (fmt[XPM_COLOR_SYMBOLS].count == 0
3327 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
3328 }
3329
3330 #endif /* HAVE_XPM || HAVE_NS */
3331
3332 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
3333 int
3334 x_create_bitmap_from_xpm_data (struct frame *f, char **bits)
3335 {
3336 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3337 int id, rc;
3338 XpmAttributes attrs;
3339 Pixmap bitmap, mask;
3340
3341 memset (&attrs, 0, sizeof attrs);
3342
3343 attrs.visual = FRAME_X_VISUAL (f);
3344 attrs.colormap = FRAME_X_COLORMAP (f);
3345 attrs.valuemask |= XpmVisual;
3346 attrs.valuemask |= XpmColormap;
3347
3348 rc = XpmCreatePixmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3349 bits, &bitmap, &mask, &attrs);
3350 if (rc != XpmSuccess)
3351 {
3352 XpmFreeAttributes (&attrs);
3353 return -1;
3354 }
3355
3356 id = x_allocate_bitmap_record (f);
3357 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
3358 dpyinfo->bitmaps[id - 1].have_mask = 1;
3359 dpyinfo->bitmaps[id - 1].mask = mask;
3360 dpyinfo->bitmaps[id - 1].file = NULL;
3361 dpyinfo->bitmaps[id - 1].height = attrs.height;
3362 dpyinfo->bitmaps[id - 1].width = attrs.width;
3363 dpyinfo->bitmaps[id - 1].depth = attrs.depth;
3364 dpyinfo->bitmaps[id - 1].refcount = 1;
3365
3366 XpmFreeAttributes (&attrs);
3367 return id;
3368 }
3369 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3370
3371 /* Load image IMG which will be displayed on frame F. Value is
3372 non-zero if successful. */
3373
3374 #ifdef HAVE_XPM
3375
3376 static int
3377 xpm_load (struct frame *f, struct image *img)
3378 {
3379 int rc;
3380 XpmAttributes attrs;
3381 Lisp_Object specified_file, color_symbols;
3382 #ifdef HAVE_NTGUI
3383 HDC hdc;
3384 xpm_XImage * xpm_image = NULL, * xpm_mask = NULL;
3385 #endif /* HAVE_NTGUI */
3386
3387 /* Configure the XPM lib. Use the visual of frame F. Allocate
3388 close colors. Return colors allocated. */
3389 memset (&attrs, 0, sizeof attrs);
3390
3391 #ifndef HAVE_NTGUI
3392 attrs.visual = FRAME_X_VISUAL (f);
3393 attrs.colormap = FRAME_X_COLORMAP (f);
3394 attrs.valuemask |= XpmVisual;
3395 attrs.valuemask |= XpmColormap;
3396 #endif /* HAVE_NTGUI */
3397
3398 #ifdef ALLOC_XPM_COLORS
3399 /* Allocate colors with our own functions which handle
3400 failing color allocation more gracefully. */
3401 attrs.color_closure = f;
3402 attrs.alloc_color = xpm_alloc_color;
3403 attrs.free_colors = xpm_free_colors;
3404 attrs.valuemask |= XpmAllocColor | XpmFreeColors | XpmColorClosure;
3405 #else /* not ALLOC_XPM_COLORS */
3406 /* Let the XPM lib allocate colors. */
3407 attrs.valuemask |= XpmReturnAllocPixels;
3408 #ifdef XpmAllocCloseColors
3409 attrs.alloc_close_colors = 1;
3410 attrs.valuemask |= XpmAllocCloseColors;
3411 #else /* not XpmAllocCloseColors */
3412 attrs.closeness = 600;
3413 attrs.valuemask |= XpmCloseness;
3414 #endif /* not XpmAllocCloseColors */
3415 #endif /* ALLOC_XPM_COLORS */
3416
3417 /* If image specification contains symbolic color definitions, add
3418 these to `attrs'. */
3419 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
3420 if (CONSP (color_symbols))
3421 {
3422 Lisp_Object tail;
3423 XpmColorSymbol *xpm_syms;
3424 int i, size;
3425
3426 attrs.valuemask |= XpmColorSymbols;
3427
3428 /* Count number of symbols. */
3429 attrs.numsymbols = 0;
3430 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
3431 ++attrs.numsymbols;
3432
3433 /* Allocate an XpmColorSymbol array. */
3434 size = attrs.numsymbols * sizeof *xpm_syms;
3435 xpm_syms = (XpmColorSymbol *) alloca (size);
3436 memset (xpm_syms, 0, size);
3437 attrs.colorsymbols = xpm_syms;
3438
3439 /* Fill the color symbol array. */
3440 for (tail = color_symbols, i = 0;
3441 CONSP (tail);
3442 ++i, tail = XCDR (tail))
3443 {
3444 Lisp_Object name;
3445 Lisp_Object color;
3446
3447 if (!CONSP (XCAR (tail)))
3448 {
3449 xpm_syms[i].name = "";
3450 xpm_syms[i].value = "";
3451 continue;
3452 }
3453 name = XCAR (XCAR (tail));
3454 color = XCDR (XCAR (tail));
3455 if (STRINGP (name))
3456 {
3457 xpm_syms[i].name = (char *) alloca (SCHARS (name) + 1);
3458 strcpy (xpm_syms[i].name, SDATA (name));
3459 }
3460 else
3461 xpm_syms[i].name = "";
3462 if (STRINGP (color))
3463 {
3464 xpm_syms[i].value = (char *) alloca (SCHARS (color) + 1);
3465 strcpy (xpm_syms[i].value, SDATA (color));
3466 }
3467 else
3468 xpm_syms[i].value = "";
3469 }
3470 }
3471
3472 /* Create a pixmap for the image, either from a file, or from a
3473 string buffer containing data in the same format as an XPM file. */
3474 #ifdef ALLOC_XPM_COLORS
3475 xpm_init_color_cache (f, &attrs);
3476 #endif
3477
3478 specified_file = image_spec_value (img->spec, QCfile, NULL);
3479
3480 #ifdef HAVE_NTGUI
3481 {
3482 HDC frame_dc = get_frame_dc (f);
3483 hdc = CreateCompatibleDC (frame_dc);
3484 release_frame_dc (f, frame_dc);
3485 }
3486 #endif /* HAVE_NTGUI */
3487
3488 if (STRINGP (specified_file))
3489 {
3490 Lisp_Object file = x_find_image_file (specified_file);
3491 if (!STRINGP (file))
3492 {
3493 image_error ("Cannot find image file `%s'", specified_file, Qnil);
3494 #ifdef ALLOC_XPM_COLORS
3495 xpm_free_color_cache ();
3496 #endif
3497 return 0;
3498 }
3499
3500 #ifdef HAVE_NTGUI
3501 /* XpmReadFileToPixmap is not available in the Windows port of
3502 libxpm. But XpmReadFileToImage almost does what we want. */
3503 rc = fn_XpmReadFileToImage (&hdc, SDATA (file),
3504 &xpm_image, &xpm_mask,
3505 &attrs);
3506 #else
3507 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3508 SDATA (file), &img->pixmap, &img->mask,
3509 &attrs);
3510 #endif /* HAVE_NTGUI */
3511 }
3512 else
3513 {
3514 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
3515 if (!STRINGP (buffer))
3516 {
3517 image_error ("Invalid image data `%s'", buffer, Qnil);
3518 #ifdef ALLOC_XPM_COLORS
3519 xpm_free_color_cache ();
3520 #endif
3521 return 0;
3522 }
3523 #ifdef HAVE_NTGUI
3524 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3525 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3526 rc = fn_XpmCreateImageFromBuffer (&hdc, SDATA (buffer),
3527 &xpm_image, &xpm_mask,
3528 &attrs);
3529 #else
3530 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3531 SDATA (buffer),
3532 &img->pixmap, &img->mask,
3533 &attrs);
3534 #endif /* HAVE_NTGUI */
3535 }
3536
3537 if (rc == XpmSuccess)
3538 {
3539 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3540 img->colors = colors_in_color_table (&img->ncolors);
3541 #else /* not ALLOC_XPM_COLORS */
3542 int i;
3543
3544 #ifdef HAVE_NTGUI
3545 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3546 plus some duplicate attributes. */
3547 if (xpm_image && xpm_image->bitmap)
3548 {
3549 img->pixmap = xpm_image->bitmap;
3550 /* XImageFree in libXpm frees XImage struct without destroying
3551 the bitmap, which is what we want. */
3552 fn_XImageFree (xpm_image);
3553 }
3554 if (xpm_mask && xpm_mask->bitmap)
3555 {
3556 /* The mask appears to be inverted compared with what we expect.
3557 TODO: invert our expectations. See other places where we
3558 have to invert bits because our idea of masks is backwards. */
3559 HGDIOBJ old_obj;
3560 old_obj = SelectObject (hdc, xpm_mask->bitmap);
3561
3562 PatBlt (hdc, 0, 0, xpm_mask->width, xpm_mask->height, DSTINVERT);
3563 SelectObject (hdc, old_obj);
3564
3565 img->mask = xpm_mask->bitmap;
3566 fn_XImageFree (xpm_mask);
3567 DeleteDC (hdc);
3568 }
3569
3570 DeleteDC (hdc);
3571 #endif /* HAVE_NTGUI */
3572
3573 /* Remember allocated colors. */
3574 img->ncolors = attrs.nalloc_pixels;
3575 img->colors = (unsigned long *) xmalloc (img->ncolors
3576 * sizeof *img->colors);
3577 for (i = 0; i < attrs.nalloc_pixels; ++i)
3578 {
3579 img->colors[i] = attrs.alloc_pixels[i];
3580 #ifdef DEBUG_X_COLORS
3581 register_color (img->colors[i]);
3582 #endif
3583 }
3584 #endif /* not ALLOC_XPM_COLORS */
3585
3586 img->width = attrs.width;
3587 img->height = attrs.height;
3588 xassert (img->width > 0 && img->height > 0);
3589
3590 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3591 #ifdef HAVE_NTGUI
3592 fn_XpmFreeAttributes (&attrs);
3593 #else
3594 XpmFreeAttributes (&attrs);
3595 #endif /* HAVE_NTGUI */
3596 }
3597 else
3598 {
3599 #ifdef HAVE_NTGUI
3600 DeleteDC (hdc);
3601 #endif /* HAVE_NTGUI */
3602
3603 switch (rc)
3604 {
3605 case XpmOpenFailed:
3606 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
3607 break;
3608
3609 case XpmFileInvalid:
3610 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
3611 break;
3612
3613 case XpmNoMemory:
3614 image_error ("Out of memory (%s)", img->spec, Qnil);
3615 break;
3616
3617 case XpmColorFailed:
3618 image_error ("Color allocation error (%s)", img->spec, Qnil);
3619 break;
3620
3621 default:
3622 image_error ("Unknown error (%s)", img->spec, Qnil);
3623 break;
3624 }
3625 }
3626
3627 #ifdef ALLOC_XPM_COLORS
3628 xpm_free_color_cache ();
3629 #endif
3630 return rc == XpmSuccess;
3631 }
3632
3633 #endif /* HAVE_XPM */
3634
3635 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3636
3637 /* XPM support functions for NS where libxpm is not available.
3638 Only XPM version 3 (without any extensions) is supported. */
3639
3640 static int xpm_scan (const unsigned char **, const unsigned char *,
3641 const unsigned char **, int *);
3642 static Lisp_Object xpm_make_color_table_v
3643 (void (**) (Lisp_Object, const unsigned char *, int, Lisp_Object),
3644 Lisp_Object (**) (Lisp_Object, const unsigned char *, int));
3645 static void xpm_put_color_table_v (Lisp_Object, const unsigned char *,
3646 int, Lisp_Object);
3647 static Lisp_Object xpm_get_color_table_v (Lisp_Object,
3648 const unsigned char *, int);
3649 static Lisp_Object xpm_make_color_table_h
3650 (void (**) (Lisp_Object, const unsigned char *, int, Lisp_Object),
3651 Lisp_Object (**) (Lisp_Object, const unsigned char *, int));
3652 static void xpm_put_color_table_h (Lisp_Object, const unsigned char *,
3653 int, Lisp_Object);
3654 static Lisp_Object xpm_get_color_table_h (Lisp_Object,
3655 const unsigned char *, int);
3656 static int xpm_str_to_color_key (const char *);
3657 static int xpm_load_image (struct frame *, struct image *,
3658 const unsigned char *, const unsigned char *);
3659
3660 /* Tokens returned from xpm_scan. */
3661
3662 enum xpm_token
3663 {
3664 XPM_TK_IDENT = 256,
3665 XPM_TK_STRING,
3666 XPM_TK_EOF
3667 };
3668
3669 /* Scan an XPM data and return a character (< 256) or a token defined
3670 by enum xpm_token above. *S and END are the start (inclusive) and
3671 the end (exclusive) addresses of the data, respectively. Advance
3672 *S while scanning. If token is either XPM_TK_IDENT or
3673 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3674 length of the corresponding token, respectively. */
3675
3676 static int
3677 xpm_scan (const unsigned char **s,
3678 const unsigned char *end,
3679 const unsigned char **beg,
3680 int *len)
3681 {
3682 int c;
3683
3684 while (*s < end)
3685 {
3686 /* Skip white-space. */
3687 while (*s < end && (c = *(*s)++, isspace (c)))
3688 ;
3689
3690 /* gnus-pointer.xpm uses '-' in its identifier.
3691 sb-dir-plus.xpm uses '+' in its identifier. */
3692 if (isalpha (c) || c == '_' || c == '-' || c == '+')
3693 {
3694 *beg = *s - 1;
3695 while (*s < end
3696 && (c = **s, isalnum (c) || c == '_' || c == '-' || c == '+'))
3697 ++*s;
3698 *len = *s - *beg;
3699 return XPM_TK_IDENT;
3700 }
3701 else if (c == '"')
3702 {
3703 *beg = *s;
3704 while (*s < end && **s != '"')
3705 ++*s;
3706 *len = *s - *beg;
3707 if (*s < end)
3708 ++*s;
3709 return XPM_TK_STRING;
3710 }
3711 else if (c == '/')
3712 {
3713 if (*s < end && **s == '*')
3714 {
3715 /* C-style comment. */
3716 ++*s;
3717 do
3718 {
3719 while (*s < end && *(*s)++ != '*')
3720 ;
3721 }
3722 while (*s < end && **s != '/');
3723 if (*s < end)
3724 ++*s;
3725 }
3726 else
3727 return c;
3728 }
3729 else
3730 return c;
3731 }
3732
3733 return XPM_TK_EOF;
3734 }
3735
3736 /* Functions for color table lookup in XPM data. A key is a string
3737 specifying the color of each pixel in XPM data. A value is either
3738 an integer that specifies a pixel color, Qt that specifies
3739 transparency, or Qnil for the unspecified color. If the length of
3740 the key string is one, a vector is used as a table. Otherwise, a
3741 hash table is used. */
3742
3743 static Lisp_Object
3744 xpm_make_color_table_v (void (**put_func) (Lisp_Object,
3745 const unsigned char *,
3746 int,
3747 Lisp_Object),
3748 Lisp_Object (**get_func) (Lisp_Object,
3749 const unsigned char *,
3750 int))
3751 {
3752 *put_func = xpm_put_color_table_v;
3753 *get_func = xpm_get_color_table_v;
3754 return Fmake_vector (make_number (256), Qnil);
3755 }
3756
3757 static void
3758 xpm_put_color_table_v (Lisp_Object color_table,
3759 const unsigned char *chars_start,
3760 int chars_len,
3761 Lisp_Object color)
3762 {
3763 XVECTOR (color_table)->contents[*chars_start] = color;
3764 }
3765
3766 static Lisp_Object
3767 xpm_get_color_table_v (Lisp_Object color_table,
3768 const unsigned char *chars_start,
3769 int chars_len)
3770 {
3771 return XVECTOR (color_table)->contents[*chars_start];
3772 }
3773
3774 static Lisp_Object
3775 xpm_make_color_table_h (void (**put_func) (Lisp_Object,
3776 const unsigned char *,
3777 int,
3778 Lisp_Object),
3779 Lisp_Object (**get_func) (Lisp_Object,
3780 const unsigned char *,
3781 int))
3782 {
3783 *put_func = xpm_put_color_table_h;
3784 *get_func = xpm_get_color_table_h;
3785 return make_hash_table (Qequal, make_number (DEFAULT_HASH_SIZE),
3786 make_float (DEFAULT_REHASH_SIZE),
3787 make_float (DEFAULT_REHASH_THRESHOLD),
3788 Qnil, Qnil, Qnil);
3789 }
3790
3791 static void
3792 xpm_put_color_table_h (Lisp_Object color_table,
3793 const unsigned char *chars_start,
3794 int chars_len,
3795 Lisp_Object color)
3796 {
3797 struct Lisp_Hash_Table *table = XHASH_TABLE (color_table);
3798 unsigned hash_code;
3799 Lisp_Object chars = make_unibyte_string (chars_start, chars_len);
3800
3801 hash_lookup (table, chars, &hash_code);
3802 hash_put (table, chars, color, hash_code);
3803 }
3804
3805 static Lisp_Object
3806 xpm_get_color_table_h (Lisp_Object color_table,
3807 const unsigned char *chars_start,
3808 int chars_len)
3809 {
3810 struct Lisp_Hash_Table *table = XHASH_TABLE (color_table);
3811 int i = hash_lookup (table, make_unibyte_string (chars_start, chars_len),
3812 NULL);
3813
3814 return i >= 0 ? HASH_VALUE (table, i) : Qnil;
3815 }
3816
3817 enum xpm_color_key {
3818 XPM_COLOR_KEY_S,
3819 XPM_COLOR_KEY_M,
3820 XPM_COLOR_KEY_G4,
3821 XPM_COLOR_KEY_G,
3822 XPM_COLOR_KEY_C
3823 };
3824
3825 static const char xpm_color_key_strings[][4] = {"s", "m", "g4", "g", "c"};
3826
3827 static int
3828 xpm_str_to_color_key (const char *s)
3829 {
3830 int i;
3831
3832 for (i = 0;
3833 i < sizeof xpm_color_key_strings / sizeof xpm_color_key_strings[0];
3834 i++)
3835 if (strcmp (xpm_color_key_strings[i], s) == 0)
3836 return i;
3837 return -1;
3838 }
3839
3840 static int
3841 xpm_load_image (struct frame *f,
3842 struct image *img,
3843 const unsigned char *contents,
3844 const unsigned char *end)
3845 {
3846 const unsigned char *s = contents, *beg, *str;
3847 unsigned char buffer[BUFSIZ];
3848 int width, height, x, y;
3849 int num_colors, chars_per_pixel;
3850 int len, LA1;
3851 void (*put_color_table) (Lisp_Object, const unsigned char *, int, Lisp_Object);
3852 Lisp_Object (*get_color_table) (Lisp_Object, const unsigned char *, int);
3853 Lisp_Object frame, color_symbols, color_table;
3854 int best_key, have_mask = 0;
3855 XImagePtr ximg = NULL, mask_img = NULL;
3856
3857 #define match() \
3858 LA1 = xpm_scan (&s, end, &beg, &len)
3859
3860 #define expect(TOKEN) \
3861 if (LA1 != (TOKEN)) \
3862 goto failure; \
3863 else \
3864 match ()
3865
3866 #define expect_ident(IDENT) \
3867 if (LA1 == XPM_TK_IDENT \
3868 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3869 match (); \
3870 else \
3871 goto failure
3872
3873 if (!(end - s >= 9 && memcmp (s, "/* XPM */", 9) == 0))
3874 goto failure;
3875 s += 9;
3876 match ();
3877 expect_ident ("static");
3878 expect_ident ("char");
3879 expect ('*');
3880 expect (XPM_TK_IDENT);
3881 expect ('[');
3882 expect (']');
3883 expect ('=');
3884 expect ('{');
3885 expect (XPM_TK_STRING);
3886 if (len >= BUFSIZ)
3887 goto failure;
3888 memcpy (buffer, beg, len);
3889 buffer[len] = '\0';
3890 if (sscanf (buffer, "%d %d %d %d", &width, &height,
3891 &num_colors, &chars_per_pixel) != 4
3892 || width <= 0 || height <= 0
3893 || num_colors <= 0 || chars_per_pixel <= 0)
3894 goto failure;
3895
3896 if (!check_image_size (f, width, height))
3897 {
3898 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
3899 goto failure;
3900 }
3901
3902 expect (',');
3903
3904 XSETFRAME (frame, f);
3905 if (!NILP (Fxw_display_color_p (frame)))
3906 best_key = XPM_COLOR_KEY_C;
3907 else if (!NILP (Fx_display_grayscale_p (frame)))
3908 best_key = (XFASTINT (Fx_display_planes (frame)) > 2
3909 ? XPM_COLOR_KEY_G : XPM_COLOR_KEY_G4);
3910 else
3911 best_key = XPM_COLOR_KEY_M;
3912
3913 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
3914 if (chars_per_pixel == 1)
3915 color_table = xpm_make_color_table_v (&put_color_table,
3916 &get_color_table);
3917 else
3918 color_table = xpm_make_color_table_h (&put_color_table,
3919 &get_color_table);
3920
3921 while (num_colors-- > 0)
3922 {
3923 unsigned char *color, *max_color;
3924 int key, next_key, max_key = 0;
3925 Lisp_Object symbol_color = Qnil, color_val;
3926 XColor cdef;
3927
3928 expect (XPM_TK_STRING);
3929 if (len <= chars_per_pixel || len >= BUFSIZ + chars_per_pixel)
3930 goto failure;
3931 memcpy (buffer, beg + chars_per_pixel, len - chars_per_pixel);
3932 buffer[len - chars_per_pixel] = '\0';
3933
3934 str = strtok (buffer, " \t");
3935 if (str == NULL)
3936 goto failure;
3937 key = xpm_str_to_color_key (str);
3938 if (key < 0)
3939 goto failure;
3940 do
3941 {
3942 color = strtok (NULL, " \t");
3943 if (color == NULL)
3944 goto failure;
3945
3946 while ((str = strtok (NULL, " \t")) != NULL)
3947 {
3948 next_key = xpm_str_to_color_key (str);
3949 if (next_key >= 0)
3950 break;
3951 color[strlen (color)] = ' ';
3952 }
3953
3954 if (key == XPM_COLOR_KEY_S)
3955 {
3956 if (NILP (symbol_color))
3957 symbol_color = build_string (color);
3958 }
3959 else if (max_key < key && key <= best_key)
3960 {
3961 max_key = key;
3962 max_color = color;
3963 }
3964 key = next_key;
3965 }
3966 while (str);
3967
3968 color_val = Qnil;
3969 if (!NILP (color_symbols) && !NILP (symbol_color))
3970 {
3971 Lisp_Object specified_color = Fassoc (symbol_color, color_symbols);
3972
3973 if (CONSP (specified_color) && STRINGP (XCDR (specified_color)))
3974 {
3975 if (xstrcasecmp (SDATA (XCDR (specified_color)), "None") == 0)
3976 color_val = Qt;
3977 else if (x_defined_color (f, SDATA (XCDR (specified_color)),
3978 &cdef, 0))
3979 color_val = make_number (cdef.pixel);
3980 }
3981 }
3982 if (NILP (color_val) && max_key > 0)
3983 {
3984 if (xstrcasecmp (max_color, "None") == 0)
3985 color_val = Qt;
3986 else if (x_defined_color (f, max_color, &cdef, 0))
3987 color_val = make_number (cdef.pixel);
3988 }
3989 if (!NILP (color_val))
3990 (*put_color_table) (color_table, beg, chars_per_pixel, color_val);
3991
3992 expect (',');
3993 }
3994
3995 if (!x_create_x_image_and_pixmap (f, width, height, 0,
3996 &ximg, &img->pixmap)
3997 #ifndef HAVE_NS
3998 || !x_create_x_image_and_pixmap (f, width, height, 1,
3999 &mask_img, &img->mask)
4000 #endif
4001 )
4002 {
4003 image_error ("Out of memory (%s)", img->spec, Qnil);
4004 goto error;
4005 }
4006
4007 for (y = 0; y < height; y++)
4008 {
4009 expect (XPM_TK_STRING);
4010 str = beg;
4011 if (len < width * chars_per_pixel)
4012 goto failure;
4013 for (x = 0; x < width; x++, str += chars_per_pixel)
4014 {
4015 Lisp_Object color_val =
4016 (*get_color_table) (color_table, str, chars_per_pixel);
4017
4018 XPutPixel (ximg, x, y,
4019 (INTEGERP (color_val) ? XINT (color_val)
4020 : FRAME_FOREGROUND_PIXEL (f)));
4021 #ifndef HAVE_NS
4022 XPutPixel (mask_img, x, y,
4023 (!EQ (color_val, Qt) ? PIX_MASK_DRAW
4024 : (have_mask = 1, PIX_MASK_RETAIN)));
4025 #else
4026 if (EQ (color_val, Qt))
4027 ns_set_alpha (ximg, x, y, 0);
4028 #endif
4029 }
4030 if (y + 1 < height)
4031 expect (',');
4032 }
4033
4034 img->width = width;
4035 img->height = height;
4036
4037 /* Maybe fill in the background field while we have ximg handy. */
4038 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
4039 IMAGE_BACKGROUND (img, f, ximg);
4040
4041 x_put_x_image (f, ximg, img->pixmap, width, height);
4042 x_destroy_x_image (ximg);
4043 #ifndef HAVE_NS
4044 if (have_mask)
4045 {
4046 /* Fill in the background_transparent field while we have the
4047 mask handy. */
4048 image_background_transparent (img, f, mask_img);
4049
4050 x_put_x_image (f, mask_img, img->mask, width, height);
4051 x_destroy_x_image (mask_img);
4052 }
4053 else
4054 {
4055 x_destroy_x_image (mask_img);
4056 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
4057 img->mask = NO_PIXMAP;
4058 }
4059 #endif
4060 return 1;
4061
4062 failure:
4063 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
4064 error:
4065 x_destroy_x_image (ximg);
4066 x_destroy_x_image (mask_img);
4067 x_clear_image (f, img);
4068 return 0;
4069
4070 #undef match
4071 #undef expect
4072 #undef expect_ident
4073 }
4074
4075 static int
4076 xpm_load (struct frame *f,
4077 struct image *img)
4078 {
4079 int success_p = 0;
4080 Lisp_Object file_name;
4081
4082 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4083 file_name = image_spec_value (img->spec, QCfile, NULL);
4084 if (STRINGP (file_name))
4085 {
4086 Lisp_Object file;
4087 unsigned char *contents;
4088 int size;
4089
4090 file = x_find_image_file (file_name);
4091 if (!STRINGP (file))
4092 {
4093 image_error ("Cannot find image file `%s'", file_name, Qnil);
4094 return 0;
4095 }
4096
4097 contents = slurp_file (SDATA (file), &size);
4098 if (contents == NULL)
4099 {
4100 image_error ("Error loading XPM image `%s'", img->spec, Qnil);
4101 return 0;
4102 }
4103
4104 success_p = xpm_load_image (f, img, contents, contents + size);
4105 xfree (contents);
4106 }
4107 else
4108 {
4109 Lisp_Object data;
4110
4111 data = image_spec_value (img->spec, QCdata, NULL);
4112 if (!STRINGP (data))
4113 {
4114 image_error ("Invalid image data `%s'", data, Qnil);
4115 return 0;
4116 }
4117 success_p = xpm_load_image (f, img, SDATA (data),
4118 SDATA (data) + SBYTES (data));
4119 }
4120
4121 return success_p;
4122 }
4123
4124 #endif /* HAVE_NS && !HAVE_XPM */
4125
4126
4127 \f
4128 /***********************************************************************
4129 Color table
4130 ***********************************************************************/
4131
4132 #ifdef COLOR_TABLE_SUPPORT
4133
4134 /* An entry in the color table mapping an RGB color to a pixel color. */
4135
4136 struct ct_color
4137 {
4138 int r, g, b;
4139 unsigned long pixel;
4140
4141 /* Next in color table collision list. */
4142 struct ct_color *next;
4143 };
4144
4145 /* The bucket vector size to use. Must be prime. */
4146
4147 #define CT_SIZE 101
4148
4149 /* Value is a hash of the RGB color given by R, G, and B. */
4150
4151 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4152
4153 /* The color hash table. */
4154
4155 struct ct_color **ct_table;
4156
4157 /* Number of entries in the color table. */
4158
4159 int ct_colors_allocated;
4160
4161 /* Initialize the color table. */
4162
4163 static void
4164 init_color_table (void)
4165 {
4166 int size = CT_SIZE * sizeof (*ct_table);
4167 ct_table = (struct ct_color **) xmalloc (size);
4168 memset (ct_table, 0, size);
4169 ct_colors_allocated = 0;
4170 }
4171
4172
4173 /* Free memory associated with the color table. */
4174
4175 static void
4176 free_color_table (void)
4177 {
4178 int i;
4179 struct ct_color *p, *next;
4180
4181 for (i = 0; i < CT_SIZE; ++i)
4182 for (p = ct_table[i]; p; p = next)
4183 {
4184 next = p->next;
4185 xfree (p);
4186 }
4187
4188 xfree (ct_table);
4189 ct_table = NULL;
4190 }
4191
4192
4193 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4194 entry for that color already is in the color table, return the
4195 pixel color of that entry. Otherwise, allocate a new color for R,
4196 G, B, and make an entry in the color table. */
4197
4198 static unsigned long
4199 lookup_rgb_color (struct frame *f, int r, int g, int b)
4200 {
4201 unsigned hash = CT_HASH_RGB (r, g, b);
4202 int i = hash % CT_SIZE;
4203 struct ct_color *p;
4204 Display_Info *dpyinfo;
4205
4206 /* Handle TrueColor visuals specially, which improves performance by
4207 two orders of magnitude. Freeing colors on TrueColor visuals is
4208 a nop, and pixel colors specify RGB values directly. See also
4209 the Xlib spec, chapter 3.1. */
4210 dpyinfo = FRAME_X_DISPLAY_INFO (f);
4211 if (dpyinfo->red_bits > 0)
4212 {
4213 unsigned long pr, pg, pb;
4214
4215 /* Apply gamma-correction like normal color allocation does. */
4216 if (f->gamma)
4217 {
4218 XColor color;
4219 color.red = r, color.green = g, color.blue = b;
4220 gamma_correct (f, &color);
4221 r = color.red, g = color.green, b = color.blue;
4222 }
4223
4224 /* Scale down RGB values to the visual's bits per RGB, and shift
4225 them to the right position in the pixel color. Note that the
4226 original RGB values are 16-bit values, as usual in X. */
4227 pr = (r >> (16 - dpyinfo->red_bits)) << dpyinfo->red_offset;
4228 pg = (g >> (16 - dpyinfo->green_bits)) << dpyinfo->green_offset;
4229 pb = (b >> (16 - dpyinfo->blue_bits)) << dpyinfo->blue_offset;
4230
4231 /* Assemble the pixel color. */
4232 return pr | pg | pb;
4233 }
4234
4235 for (p = ct_table[i]; p; p = p->next)
4236 if (p->r == r && p->g == g && p->b == b)
4237 break;
4238
4239 if (p == NULL)
4240 {
4241
4242 #ifdef HAVE_X_WINDOWS
4243 XColor color;
4244 Colormap cmap;
4245 int rc;
4246
4247 color.red = r;
4248 color.green = g;
4249 color.blue = b;
4250
4251 cmap = FRAME_X_COLORMAP (f);
4252 rc = x_alloc_nearest_color (f, cmap, &color);
4253 if (rc)
4254 {
4255 ++ct_colors_allocated;
4256 p = (struct ct_color *) xmalloc (sizeof *p);
4257 p->r = r;
4258 p->g = g;
4259 p->b = b;
4260 p->pixel = color.pixel;
4261 p->next = ct_table[i];
4262 ct_table[i] = p;
4263 }
4264 else
4265 return FRAME_FOREGROUND_PIXEL (f);
4266
4267 #else
4268 COLORREF color;
4269 #ifdef HAVE_NTGUI
4270 color = PALETTERGB (r, g, b);
4271 #else
4272 color = RGB_TO_ULONG (r, g, b);
4273 #endif /* HAVE_NTGUI */
4274 ++ct_colors_allocated;
4275 p = (struct ct_color *) xmalloc (sizeof *p);
4276 p->r = r;
4277 p->g = g;
4278 p->b = b;
4279 p->pixel = color;
4280 p->next = ct_table[i];
4281 ct_table[i] = p;
4282 #endif /* HAVE_X_WINDOWS */
4283
4284 }
4285
4286 return p->pixel;
4287 }
4288
4289
4290 /* Look up pixel color PIXEL which is used on frame F in the color
4291 table. If not already present, allocate it. Value is PIXEL. */
4292
4293 static unsigned long
4294 lookup_pixel_color (struct frame *f, unsigned long pixel)
4295 {
4296 int i = pixel % CT_SIZE;
4297 struct ct_color *p;
4298
4299 for (p = ct_table[i]; p; p = p->next)
4300 if (p->pixel == pixel)
4301 break;
4302
4303 if (p == NULL)
4304 {
4305 XColor color;
4306 Colormap cmap;
4307 int rc;
4308
4309 #ifdef HAVE_X_WINDOWS
4310 cmap = FRAME_X_COLORMAP (f);
4311 color.pixel = pixel;
4312 x_query_color (f, &color);
4313 rc = x_alloc_nearest_color (f, cmap, &color);
4314 #else
4315 BLOCK_INPUT;
4316 cmap = DefaultColormapOfScreen (FRAME_X_SCREEN (f));
4317 color.pixel = pixel;
4318 XQueryColor (NULL, cmap, &color);
4319 rc = x_alloc_nearest_color (f, cmap, &color);
4320 UNBLOCK_INPUT;
4321 #endif /* HAVE_X_WINDOWS */
4322
4323 if (rc)
4324 {
4325 ++ct_colors_allocated;
4326
4327 p = (struct ct_color *) xmalloc (sizeof *p);
4328 p->r = color.red;
4329 p->g = color.green;
4330 p->b = color.blue;
4331 p->pixel = pixel;
4332 p->next = ct_table[i];
4333 ct_table[i] = p;
4334 }
4335 else
4336 return FRAME_FOREGROUND_PIXEL (f);
4337 }
4338 return p->pixel;
4339 }
4340
4341
4342 /* Value is a vector of all pixel colors contained in the color table,
4343 allocated via xmalloc. Set *N to the number of colors. */
4344
4345 static unsigned long *
4346 colors_in_color_table (int *n)
4347 {
4348 int i, j;
4349 struct ct_color *p;
4350 unsigned long *colors;
4351
4352 if (ct_colors_allocated == 0)
4353 {
4354 *n = 0;
4355 colors = NULL;
4356 }
4357 else
4358 {
4359 colors = (unsigned long *) xmalloc (ct_colors_allocated
4360 * sizeof *colors);
4361 *n = ct_colors_allocated;
4362
4363 for (i = j = 0; i < CT_SIZE; ++i)
4364 for (p = ct_table[i]; p; p = p->next)
4365 colors[j++] = p->pixel;
4366 }
4367
4368 return colors;
4369 }
4370
4371 #else /* COLOR_TABLE_SUPPORT */
4372
4373 static unsigned long
4374 lookup_rgb_color (struct frame *f, int r, int g, int b)
4375 {
4376 unsigned long pixel;
4377
4378 #ifdef HAVE_NTGUI
4379 pixel = PALETTERGB (r >> 8, g >> 8, b >> 8);
4380 #endif /* HAVE_NTGUI */
4381
4382 #ifdef HAVE_NS
4383 pixel = RGB_TO_ULONG (r >> 8, g >> 8, b >> 8);
4384 #endif /* HAVE_NS */
4385 return pixel;
4386 }
4387
4388 static void
4389 init_color_table (void)
4390 {
4391 }
4392 #endif /* COLOR_TABLE_SUPPORT */
4393
4394 \f
4395 /***********************************************************************
4396 Algorithms
4397 ***********************************************************************/
4398
4399 static XColor *x_to_xcolors (struct frame *, struct image *, int);
4400 static void x_from_xcolors (struct frame *, struct image *, XColor *);
4401 static void x_detect_edges (struct frame *, struct image *, int[9], int);
4402
4403 #ifdef HAVE_NTGUI
4404 static void XPutPixel (XImagePtr , int, int, COLORREF);
4405 #endif /* HAVE_NTGUI */
4406
4407 /* Non-zero means draw a cross on images having `:conversion
4408 disabled'. */
4409
4410 int cross_disabled_images;
4411
4412 /* Edge detection matrices for different edge-detection
4413 strategies. */
4414
4415 static int emboss_matrix[9] = {
4416 /* x - 1 x x + 1 */
4417 2, -1, 0, /* y - 1 */
4418 -1, 0, 1, /* y */
4419 0, 1, -2 /* y + 1 */
4420 };
4421
4422 static int laplace_matrix[9] = {
4423 /* x - 1 x x + 1 */
4424 1, 0, 0, /* y - 1 */
4425 0, 0, 0, /* y */
4426 0, 0, -1 /* y + 1 */
4427 };
4428
4429 /* Value is the intensity of the color whose red/green/blue values
4430 are R, G, and B. */
4431
4432 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4433
4434
4435 /* On frame F, return an array of XColor structures describing image
4436 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4437 non-zero means also fill the red/green/blue members of the XColor
4438 structures. Value is a pointer to the array of XColors structures,
4439 allocated with xmalloc; it must be freed by the caller. */
4440
4441 static XColor *
4442 x_to_xcolors (struct frame *f, struct image *img, int rgb_p)
4443 {
4444 int x, y;
4445 XColor *colors, *p;
4446 XImagePtr_or_DC ximg;
4447 #ifdef HAVE_NTGUI
4448 HDC hdc;
4449 HGDIOBJ prev;
4450 #endif /* HAVE_NTGUI */
4451
4452 colors = (XColor *) xmalloc (img->width * img->height * sizeof *colors);
4453
4454 #ifndef HAVE_NTGUI
4455 /* Get the X image IMG->pixmap. */
4456 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
4457 0, 0, img->width, img->height, ~0, ZPixmap);
4458 #else
4459 /* Load the image into a memory device context. */
4460 hdc = get_frame_dc (f);
4461 ximg = CreateCompatibleDC (hdc);
4462 release_frame_dc (f, hdc);
4463 prev = SelectObject (ximg, img->pixmap);
4464 #endif /* HAVE_NTGUI */
4465
4466 /* Fill the `pixel' members of the XColor array. I wished there
4467 were an easy and portable way to circumvent XGetPixel. */
4468 p = colors;
4469 for (y = 0; y < img->height; ++y)
4470 {
4471 XColor *row = p;
4472
4473 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4474 for (x = 0; x < img->width; ++x, ++p)
4475 p->pixel = GET_PIXEL (ximg, x, y);
4476 if (rgb_p)
4477 x_query_colors (f, row, img->width);
4478
4479 #else
4480
4481 for (x = 0; x < img->width; ++x, ++p)
4482 {
4483 /* W32_TODO: palette support needed here? */
4484 p->pixel = GET_PIXEL (ximg, x, y);
4485 if (rgb_p)
4486 {
4487 p->red = RED16_FROM_ULONG (p->pixel);
4488 p->green = GREEN16_FROM_ULONG (p->pixel);
4489 p->blue = BLUE16_FROM_ULONG (p->pixel);
4490 }
4491 }
4492 #endif /* HAVE_X_WINDOWS */
4493 }
4494
4495 Destroy_Image (ximg, prev);
4496
4497 return colors;
4498 }
4499
4500 #ifdef HAVE_NTGUI
4501
4502 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4503 created with CreateDIBSection, with the pointer to the bit values
4504 stored in ximg->data. */
4505
4506 static void
4507 XPutPixel (XImagePtr ximg, int x, int y, COLORREF color)
4508 {
4509 int width = ximg->info.bmiHeader.biWidth;
4510 int height = ximg->info.bmiHeader.biHeight;
4511 unsigned char * pixel;
4512
4513 /* True color images. */
4514 if (ximg->info.bmiHeader.biBitCount == 24)
4515 {
4516 int rowbytes = width * 3;
4517 /* Ensure scanlines are aligned on 4 byte boundaries. */
4518 if (rowbytes % 4)
4519 rowbytes += 4 - (rowbytes % 4);
4520
4521 pixel = ximg->data + y * rowbytes + x * 3;
4522 /* Windows bitmaps are in BGR order. */
4523 *pixel = GetBValue (color);
4524 *(pixel + 1) = GetGValue (color);
4525 *(pixel + 2) = GetRValue (color);
4526 }
4527 /* Monochrome images. */
4528 else if (ximg->info.bmiHeader.biBitCount == 1)
4529 {
4530 int rowbytes = width / 8;
4531 /* Ensure scanlines are aligned on 4 byte boundaries. */
4532 if (rowbytes % 4)
4533 rowbytes += 4 - (rowbytes % 4);
4534 pixel = ximg->data + y * rowbytes + x / 8;
4535 /* Filter out palette info. */
4536 if (color & 0x00ffffff)
4537 *pixel = *pixel | (1 << x % 8);
4538 else
4539 *pixel = *pixel & ~(1 << x % 8);
4540 }
4541 else
4542 image_error ("XPutPixel: palette image not supported", Qnil, Qnil);
4543 }
4544
4545 #endif /* HAVE_NTGUI */
4546
4547 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4548 RGB members are set. F is the frame on which this all happens.
4549 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4550
4551 static void
4552 x_from_xcolors (struct frame *f, struct image *img, XColor *colors)
4553 {
4554 int x, y;
4555 XImagePtr oimg = NULL;
4556 Pixmap pixmap;
4557 XColor *p;
4558
4559 init_color_table ();
4560
4561 x_create_x_image_and_pixmap (f, img->width, img->height, 0,
4562 &oimg, &pixmap);
4563 p = colors;
4564 for (y = 0; y < img->height; ++y)
4565 for (x = 0; x < img->width; ++x, ++p)
4566 {
4567 unsigned long pixel;
4568 pixel = lookup_rgb_color (f, p->red, p->green, p->blue);
4569 XPutPixel (oimg, x, y, pixel);
4570 }
4571
4572 xfree (colors);
4573 x_clear_image_1 (f, img, 1, 0, 1);
4574
4575 x_put_x_image (f, oimg, pixmap, img->width, img->height);
4576 x_destroy_x_image (oimg);
4577 img->pixmap = pixmap;
4578 #ifdef COLOR_TABLE_SUPPORT
4579 img->colors = colors_in_color_table (&img->ncolors);
4580 free_color_table ();
4581 #endif /* COLOR_TABLE_SUPPORT */
4582 }
4583
4584
4585 /* On frame F, perform edge-detection on image IMG.
4586
4587 MATRIX is a nine-element array specifying the transformation
4588 matrix. See emboss_matrix for an example.
4589
4590 COLOR_ADJUST is a color adjustment added to each pixel of the
4591 outgoing image. */
4592
4593 static void
4594 x_detect_edges (struct frame *f, struct image *img, int *matrix, int color_adjust)
4595 {
4596 XColor *colors = x_to_xcolors (f, img, 1);
4597 XColor *new, *p;
4598 int x, y, i, sum;
4599
4600 for (i = sum = 0; i < 9; ++i)
4601 sum += eabs (matrix[i]);
4602
4603 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4604
4605 new = (XColor *) xmalloc (img->width * img->height * sizeof *new);
4606
4607 for (y = 0; y < img->height; ++y)
4608 {
4609 p = COLOR (new, 0, y);
4610 p->red = p->green = p->blue = 0xffff/2;
4611 p = COLOR (new, img->width - 1, y);
4612 p->red = p->green = p->blue = 0xffff/2;
4613 }
4614
4615 for (x = 1; x < img->width - 1; ++x)
4616 {
4617 p = COLOR (new, x, 0);
4618 p->red = p->green = p->blue = 0xffff/2;
4619 p = COLOR (new, x, img->height - 1);
4620 p->red = p->green = p->blue = 0xffff/2;
4621 }
4622
4623 for (y = 1; y < img->height - 1; ++y)
4624 {
4625 p = COLOR (new, 1, y);
4626
4627 for (x = 1; x < img->width - 1; ++x, ++p)
4628 {
4629 int r, g, b, y1, x1;
4630
4631 r = g = b = i = 0;
4632 for (y1 = y - 1; y1 < y + 2; ++y1)
4633 for (x1 = x - 1; x1 < x + 2; ++x1, ++i)
4634 if (matrix[i])
4635 {
4636 XColor *t = COLOR (colors, x1, y1);
4637 r += matrix[i] * t->red;
4638 g += matrix[i] * t->green;
4639 b += matrix[i] * t->blue;
4640 }
4641
4642 r = (r / sum + color_adjust) & 0xffff;
4643 g = (g / sum + color_adjust) & 0xffff;
4644 b = (b / sum + color_adjust) & 0xffff;
4645 p->red = p->green = p->blue = COLOR_INTENSITY (r, g, b);
4646 }
4647 }
4648
4649 xfree (colors);
4650 x_from_xcolors (f, img, new);
4651
4652 #undef COLOR
4653 }
4654
4655
4656 /* Perform the pre-defined `emboss' edge-detection on image IMG
4657 on frame F. */
4658
4659 static void
4660 x_emboss (struct frame *f, struct image *img)
4661 {
4662 x_detect_edges (f, img, emboss_matrix, 0xffff / 2);
4663 }
4664
4665
4666 /* Transform image IMG which is used on frame F with a Laplace
4667 edge-detection algorithm. The result is an image that can be used
4668 to draw disabled buttons, for example. */
4669
4670 static void
4671 x_laplace (struct frame *f, struct image *img)
4672 {
4673 x_detect_edges (f, img, laplace_matrix, 45000);
4674 }
4675
4676
4677 /* Perform edge-detection on image IMG on frame F, with specified
4678 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4679
4680 MATRIX must be either
4681
4682 - a list of at least 9 numbers in row-major form
4683 - a vector of at least 9 numbers
4684
4685 COLOR_ADJUST nil means use a default; otherwise it must be a
4686 number. */
4687
4688 static void
4689 x_edge_detection (struct frame *f, struct image *img, Lisp_Object matrix,
4690 Lisp_Object color_adjust)
4691 {
4692 int i = 0;
4693 int trans[9];
4694
4695 if (CONSP (matrix))
4696 {
4697 for (i = 0;
4698 i < 9 && CONSP (matrix) && NUMBERP (XCAR (matrix));
4699 ++i, matrix = XCDR (matrix))
4700 trans[i] = XFLOATINT (XCAR (matrix));
4701 }
4702 else if (VECTORP (matrix) && ASIZE (matrix) >= 9)
4703 {
4704 for (i = 0; i < 9 && NUMBERP (AREF (matrix, i)); ++i)
4705 trans[i] = XFLOATINT (AREF (matrix, i));
4706 }
4707
4708 if (NILP (color_adjust))
4709 color_adjust = make_number (0xffff / 2);
4710
4711 if (i == 9 && NUMBERP (color_adjust))
4712 x_detect_edges (f, img, trans, (int) XFLOATINT (color_adjust));
4713 }
4714
4715
4716 /* Transform image IMG on frame F so that it looks disabled. */
4717
4718 static void
4719 x_disable_image (struct frame *f, struct image *img)
4720 {
4721 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4722 #ifdef HAVE_NTGUI
4723 int n_planes = dpyinfo->n_planes * dpyinfo->n_cbits;
4724 #else
4725 int n_planes = dpyinfo->n_planes;
4726 #endif /* HAVE_NTGUI */
4727
4728 if (n_planes >= 2)
4729 {
4730 /* Color (or grayscale). Convert to gray, and equalize. Just
4731 drawing such images with a stipple can look very odd, so
4732 we're using this method instead. */
4733 XColor *colors = x_to_xcolors (f, img, 1);
4734 XColor *p, *end;
4735 const int h = 15000;
4736 const int l = 30000;
4737
4738 for (p = colors, end = colors + img->width * img->height;
4739 p < end;
4740 ++p)
4741 {
4742 int i = COLOR_INTENSITY (p->red, p->green, p->blue);
4743 int i2 = (0xffff - h - l) * i / 0xffff + l;
4744 p->red = p->green = p->blue = i2;
4745 }
4746
4747 x_from_xcolors (f, img, colors);
4748 }
4749
4750 /* Draw a cross over the disabled image, if we must or if we
4751 should. */
4752 if (n_planes < 2 || cross_disabled_images)
4753 {
4754 #ifndef HAVE_NTGUI
4755 Display *dpy = FRAME_X_DISPLAY (f);
4756 GC gc;
4757
4758 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4759
4760 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4761
4762 gc = XCreateGC (dpy, img->pixmap, 0, NULL);
4763 XSetForeground (dpy, gc, BLACK_PIX_DEFAULT (f));
4764 XDrawLine (dpy, img->pixmap, gc, 0, 0,
4765 img->width - 1, img->height - 1);
4766 XDrawLine (dpy, img->pixmap, gc, 0, img->height - 1,
4767 img->width - 1, 0);
4768 XFreeGC (dpy, gc);
4769
4770 if (img->mask)
4771 {
4772 gc = XCreateGC (dpy, img->mask, 0, NULL);
4773 XSetForeground (dpy, gc, MaskForeground (f));
4774 XDrawLine (dpy, img->mask, gc, 0, 0,
4775 img->width - 1, img->height - 1);
4776 XDrawLine (dpy, img->mask, gc, 0, img->height - 1,
4777 img->width - 1, 0);
4778 XFreeGC (dpy, gc);
4779 }
4780 #endif /* !HAVE_NS */
4781 #else
4782 HDC hdc, bmpdc;
4783 HGDIOBJ prev;
4784
4785 hdc = get_frame_dc (f);
4786 bmpdc = CreateCompatibleDC (hdc);
4787 release_frame_dc (f, hdc);
4788
4789 prev = SelectObject (bmpdc, img->pixmap);
4790
4791 SetTextColor (bmpdc, BLACK_PIX_DEFAULT (f));
4792 MoveToEx (bmpdc, 0, 0, NULL);
4793 LineTo (bmpdc, img->width - 1, img->height - 1);
4794 MoveToEx (bmpdc, 0, img->height - 1, NULL);
4795 LineTo (bmpdc, img->width - 1, 0);
4796
4797 if (img->mask)
4798 {
4799 SelectObject (bmpdc, img->mask);
4800 SetTextColor (bmpdc, WHITE_PIX_DEFAULT (f));
4801 MoveToEx (bmpdc, 0, 0, NULL);
4802 LineTo (bmpdc, img->width - 1, img->height - 1);
4803 MoveToEx (bmpdc, 0, img->height - 1, NULL);
4804 LineTo (bmpdc, img->width - 1, 0);
4805 }
4806 SelectObject (bmpdc, prev);
4807 DeleteDC (bmpdc);
4808 #endif /* HAVE_NTGUI */
4809 }
4810 }
4811
4812
4813 /* Build a mask for image IMG which is used on frame F. FILE is the
4814 name of an image file, for error messages. HOW determines how to
4815 determine the background color of IMG. If it is a list '(R G B)',
4816 with R, G, and B being integers >= 0, take that as the color of the
4817 background. Otherwise, determine the background color of IMG
4818 heuristically. Value is non-zero if successful. */
4819
4820 static int
4821 x_build_heuristic_mask (struct frame *f, struct image *img, Lisp_Object how)
4822 {
4823 XImagePtr_or_DC ximg;
4824 #ifndef HAVE_NTGUI
4825 XImagePtr mask_img;
4826 #else
4827 HDC frame_dc;
4828 HGDIOBJ prev;
4829 char *mask_img;
4830 int row_width;
4831 #endif /* HAVE_NTGUI */
4832 int x, y, rc, use_img_background;
4833 unsigned long bg = 0;
4834
4835 if (img->mask)
4836 {
4837 Free_Pixmap (FRAME_X_DISPLAY (f), img->mask);
4838 img->mask = NO_PIXMAP;
4839 img->background_transparent_valid = 0;
4840 }
4841
4842 #ifndef HAVE_NTGUI
4843 #ifndef HAVE_NS
4844 /* Create an image and pixmap serving as mask. */
4845 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
4846 &mask_img, &img->mask);
4847 if (!rc)
4848 return 0;
4849 #endif /* !HAVE_NS */
4850
4851 /* Get the X image of IMG->pixmap. */
4852 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap, 0, 0,
4853 img->width, img->height,
4854 ~0, ZPixmap);
4855 #else
4856 /* Create the bit array serving as mask. */
4857 row_width = (img->width + 7) / 8;
4858 mask_img = xmalloc (row_width * img->height);
4859 memset (mask_img, 0, row_width * img->height);
4860
4861 /* Create a memory device context for IMG->pixmap. */
4862 frame_dc = get_frame_dc (f);
4863 ximg = CreateCompatibleDC (frame_dc);
4864 release_frame_dc (f, frame_dc);
4865 prev = SelectObject (ximg, img->pixmap);
4866 #endif /* HAVE_NTGUI */
4867
4868 /* Determine the background color of ximg. If HOW is `(R G B)'
4869 take that as color. Otherwise, use the image's background color. */
4870 use_img_background = 1;
4871
4872 if (CONSP (how))
4873 {
4874 int rgb[3], i;
4875
4876 for (i = 0; i < 3 && CONSP (how) && NATNUMP (XCAR (how)); ++i)
4877 {
4878 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
4879 how = XCDR (how);
4880 }
4881
4882 if (i == 3 && NILP (how))
4883 {
4884 char color_name[30];
4885 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
4886 bg = (
4887 #ifdef HAVE_NTGUI
4888 0x00ffffff & /* Filter out palette info. */
4889 #endif /* HAVE_NTGUI */
4890 x_alloc_image_color (f, img, build_string (color_name), 0));
4891 use_img_background = 0;
4892 }
4893 }
4894
4895 if (use_img_background)
4896 bg = four_corners_best (ximg, img->corners, img->width, img->height);
4897
4898 /* Set all bits in mask_img to 1 whose color in ximg is different
4899 from the background color bg. */
4900 #ifndef HAVE_NTGUI
4901 for (y = 0; y < img->height; ++y)
4902 for (x = 0; x < img->width; ++x)
4903 #ifndef HAVE_NS
4904 XPutPixel (mask_img, x, y, (XGetPixel (ximg, x, y) != bg
4905 ? PIX_MASK_DRAW : PIX_MASK_RETAIN));
4906 #else
4907 if (XGetPixel (ximg, x, y) == bg)
4908 ns_set_alpha (ximg, x, y, 0);
4909 #endif /* HAVE_NS */
4910 #ifndef HAVE_NS
4911 /* Fill in the background_transparent field while we have the mask handy. */
4912 image_background_transparent (img, f, mask_img);
4913
4914 /* Put mask_img into img->mask. */
4915 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
4916 x_destroy_x_image (mask_img);
4917 #endif /* !HAVE_NS */
4918 #else
4919 for (y = 0; y < img->height; ++y)
4920 for (x = 0; x < img->width; ++x)
4921 {
4922 COLORREF p = GetPixel (ximg, x, y);
4923 if (p != bg)
4924 mask_img[y * row_width + x / 8] |= 1 << (x % 8);
4925 }
4926
4927 /* Create the mask image. */
4928 img->mask = w32_create_pixmap_from_bitmap_data (img->width, img->height,
4929 mask_img);
4930 /* Fill in the background_transparent field while we have the mask handy. */
4931 SelectObject (ximg, img->mask);
4932 image_background_transparent (img, f, ximg);
4933
4934 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
4935 xfree (mask_img);
4936 #endif /* HAVE_NTGUI */
4937
4938 Destroy_Image (ximg, prev);
4939
4940 return 1;
4941 }
4942
4943 \f
4944 /***********************************************************************
4945 PBM (mono, gray, color)
4946 ***********************************************************************/
4947
4948 static int pbm_image_p (Lisp_Object object);
4949 static int pbm_load (struct frame *f, struct image *img);
4950 static int pbm_scan_number (unsigned char **, unsigned char *);
4951
4952 /* The symbol `pbm' identifying images of this type. */
4953
4954 Lisp_Object Qpbm;
4955
4956 /* Indices of image specification fields in gs_format, below. */
4957
4958 enum pbm_keyword_index
4959 {
4960 PBM_TYPE,
4961 PBM_FILE,
4962 PBM_DATA,
4963 PBM_ASCENT,
4964 PBM_MARGIN,
4965 PBM_RELIEF,
4966 PBM_ALGORITHM,
4967 PBM_HEURISTIC_MASK,
4968 PBM_MASK,
4969 PBM_FOREGROUND,
4970 PBM_BACKGROUND,
4971 PBM_LAST
4972 };
4973
4974 /* Vector of image_keyword structures describing the format
4975 of valid user-defined image specifications. */
4976
4977 static const struct image_keyword pbm_format[PBM_LAST] =
4978 {
4979 {":type", IMAGE_SYMBOL_VALUE, 1},
4980 {":file", IMAGE_STRING_VALUE, 0},
4981 {":data", IMAGE_STRING_VALUE, 0},
4982 {":ascent", IMAGE_ASCENT_VALUE, 0},
4983 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
4984 {":relief", IMAGE_INTEGER_VALUE, 0},
4985 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
4986 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
4987 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
4988 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
4989 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
4990 };
4991
4992 /* Structure describing the image type `pbm'. */
4993
4994 static struct image_type pbm_type =
4995 {
4996 &Qpbm,
4997 pbm_image_p,
4998 pbm_load,
4999 x_clear_image,
5000 NULL
5001 };
5002
5003
5004 /* Return non-zero if OBJECT is a valid PBM image specification. */
5005
5006 static int
5007 pbm_image_p (Lisp_Object object)
5008 {
5009 struct image_keyword fmt[PBM_LAST];
5010
5011 memcpy (fmt, pbm_format, sizeof fmt);
5012
5013 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
5014 return 0;
5015
5016 /* Must specify either :data or :file. */
5017 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
5018 }
5019
5020
5021 /* Scan a decimal number from *S and return it. Advance *S while
5022 reading the number. END is the end of the string. Value is -1 at
5023 end of input. */
5024
5025 static int
5026 pbm_scan_number (unsigned char **s, unsigned char *end)
5027 {
5028 int c = 0, val = -1;
5029
5030 while (*s < end)
5031 {
5032 /* Skip white-space. */
5033 while (*s < end && (c = *(*s)++, isspace (c)))
5034 ;
5035
5036 if (c == '#')
5037 {
5038 /* Skip comment to end of line. */
5039 while (*s < end && (c = *(*s)++, c != '\n'))
5040 ;
5041 }
5042 else if (isdigit (c))
5043 {
5044 /* Read decimal number. */
5045 val = c - '0';
5046 while (*s < end && (c = *(*s)++, isdigit (c)))
5047 val = 10 * val + c - '0';
5048 break;
5049 }
5050 else
5051 break;
5052 }
5053
5054 return val;
5055 }
5056
5057
5058 #ifdef HAVE_NTGUI
5059 #if 0 /* Unused. ++kfs */
5060
5061 /* Read FILE into memory. Value is a pointer to a buffer allocated
5062 with xmalloc holding FILE's contents. Value is null if an error
5063 occurred. *SIZE is set to the size of the file. */
5064
5065 static char *
5066 pbm_read_file (file, size)
5067 Lisp_Object file;
5068 int *size;
5069 {
5070 FILE *fp = NULL;
5071 char *buf = NULL;
5072 struct stat st;
5073
5074 if (stat (SDATA (file), &st) == 0
5075 && (fp = fopen (SDATA (file), "rb")) != NULL
5076 && (buf = (char *) xmalloc (st.st_size),
5077 fread (buf, 1, st.st_size, fp) == st.st_size))
5078 {
5079 *size = st.st_size;
5080 fclose (fp);
5081 }
5082 else
5083 {
5084 if (fp)
5085 fclose (fp);
5086 if (buf)
5087 {
5088 xfree (buf);
5089 buf = NULL;
5090 }
5091 }
5092
5093 return buf;
5094 }
5095 #endif
5096 #endif /* HAVE_NTGUI */
5097
5098 /* Load PBM image IMG for use on frame F. */
5099
5100 static int
5101 pbm_load (struct frame *f, struct image *img)
5102 {
5103 int raw_p, x, y;
5104 int width, height, max_color_idx = 0;
5105 XImagePtr ximg;
5106 Lisp_Object file, specified_file;
5107 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
5108 unsigned char *contents = NULL;
5109 unsigned char *end, *p;
5110 int size;
5111
5112 specified_file = image_spec_value (img->spec, QCfile, NULL);
5113
5114 if (STRINGP (specified_file))
5115 {
5116 file = x_find_image_file (specified_file);
5117 if (!STRINGP (file))
5118 {
5119 image_error ("Cannot find image file `%s'", specified_file, Qnil);
5120 return 0;
5121 }
5122
5123 contents = slurp_file (SDATA (file), &size);
5124 if (contents == NULL)
5125 {
5126 image_error ("Error reading `%s'", file, Qnil);
5127 return 0;
5128 }
5129
5130 p = contents;
5131 end = contents + size;
5132 }
5133 else
5134 {
5135 Lisp_Object data;
5136 data = image_spec_value (img->spec, QCdata, NULL);
5137 if (!STRINGP (data))
5138 {
5139 image_error ("Invalid image data `%s'", data, Qnil);
5140 return 0;
5141 }
5142 p = SDATA (data);
5143 end = p + SBYTES (data);
5144 }
5145
5146 /* Check magic number. */
5147 if (end - p < 2 || *p++ != 'P')
5148 {
5149 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
5150 error:
5151 xfree (contents);
5152 return 0;
5153 }
5154
5155 switch (*p++)
5156 {
5157 case '1':
5158 raw_p = 0, type = PBM_MONO;
5159 break;
5160
5161 case '2':
5162 raw_p = 0, type = PBM_GRAY;
5163 break;
5164
5165 case '3':
5166 raw_p = 0, type = PBM_COLOR;
5167 break;
5168
5169 case '4':
5170 raw_p = 1, type = PBM_MONO;
5171 break;
5172
5173 case '5':
5174 raw_p = 1, type = PBM_GRAY;
5175 break;
5176
5177 case '6':
5178 raw_p = 1, type = PBM_COLOR;
5179 break;
5180
5181 default:
5182 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
5183 goto error;
5184 }
5185
5186 /* Read width, height, maximum color-component. Characters
5187 starting with `#' up to the end of a line are ignored. */
5188 width = pbm_scan_number (&p, end);
5189 height = pbm_scan_number (&p, end);
5190
5191 if (type != PBM_MONO)
5192 {
5193 max_color_idx = pbm_scan_number (&p, end);
5194 if (max_color_idx > 65535 || max_color_idx < 0)
5195 {
5196 image_error ("Unsupported maximum PBM color value", Qnil, Qnil);
5197 goto error;
5198 }
5199 }
5200
5201 if (!check_image_size (f, width, height))
5202 {
5203 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
5204 goto error;
5205 }
5206
5207 if (!x_create_x_image_and_pixmap (f, width, height, 0,
5208 &ximg, &img->pixmap))
5209 goto error;
5210
5211 /* Initialize the color hash table. */
5212 init_color_table ();
5213
5214 if (type == PBM_MONO)
5215 {
5216 int c = 0, g;
5217 struct image_keyword fmt[PBM_LAST];
5218 unsigned long fg = FRAME_FOREGROUND_PIXEL (f);
5219 unsigned long bg = FRAME_BACKGROUND_PIXEL (f);
5220
5221 /* Parse the image specification. */
5222 memcpy (fmt, pbm_format, sizeof fmt);
5223 parse_image_spec (img->spec, fmt, PBM_LAST, Qpbm);
5224
5225 /* Get foreground and background colors, maybe allocate colors. */
5226 if (fmt[PBM_FOREGROUND].count
5227 && STRINGP (fmt[PBM_FOREGROUND].value))
5228 fg = x_alloc_image_color (f, img, fmt[PBM_FOREGROUND].value, fg);
5229 if (fmt[PBM_BACKGROUND].count
5230 && STRINGP (fmt[PBM_BACKGROUND].value))
5231 {
5232 bg = x_alloc_image_color (f, img, fmt[PBM_BACKGROUND].value, bg);
5233 img->background = bg;
5234 img->background_valid = 1;
5235 }
5236
5237 for (y = 0; y < height; ++y)
5238 for (x = 0; x < width; ++x)
5239 {
5240 if (raw_p)
5241 {
5242 if ((x & 7) == 0)
5243 {
5244 if (p >= end)
5245 {
5246 x_destroy_x_image (ximg);
5247 x_clear_image (f, img);
5248 image_error ("Invalid image size in image `%s'",
5249 img->spec, Qnil);
5250 goto error;
5251 }
5252 c = *p++;
5253 }
5254 g = c & 0x80;
5255 c <<= 1;
5256 }
5257 else
5258 g = pbm_scan_number (&p, end);
5259
5260 XPutPixel (ximg, x, y, g ? fg : bg);
5261 }
5262 }
5263 else
5264 {
5265 int expected_size = height * width;
5266 if (max_color_idx > 255)
5267 expected_size *= 2;
5268 if (type == PBM_COLOR)
5269 expected_size *= 3;
5270
5271 if (raw_p && p + expected_size > end)
5272 {
5273 x_destroy_x_image (ximg);
5274 x_clear_image (f, img);
5275 image_error ("Invalid image size in image `%s'",
5276 img->spec, Qnil);
5277 goto error;
5278 }
5279
5280 for (y = 0; y < height; ++y)
5281 for (x = 0; x < width; ++x)
5282 {
5283 int r, g, b;
5284
5285 if (type == PBM_GRAY && raw_p)
5286 {
5287 r = g = b = *p++;
5288 if (max_color_idx > 255)
5289 r = g = b = r * 256 + *p++;
5290 }
5291 else if (type == PBM_GRAY)
5292 r = g = b = pbm_scan_number (&p, end);
5293 else if (raw_p)
5294 {
5295 r = *p++;
5296 if (max_color_idx > 255)
5297 r = r * 256 + *p++;
5298 g = *p++;
5299 if (max_color_idx > 255)
5300 g = g * 256 + *p++;
5301 b = *p++;
5302 if (max_color_idx > 255)
5303 b = b * 256 + *p++;
5304 }
5305 else
5306 {
5307 r = pbm_scan_number (&p, end);
5308 g = pbm_scan_number (&p, end);
5309 b = pbm_scan_number (&p, end);
5310 }
5311
5312 if (r < 0 || g < 0 || b < 0)
5313 {
5314 x_destroy_x_image (ximg);
5315 image_error ("Invalid pixel value in image `%s'",
5316 img->spec, Qnil);
5317 goto error;
5318 }
5319
5320 /* RGB values are now in the range 0..max_color_idx.
5321 Scale this to the range 0..0xffff supported by X. */
5322 r = (double) r * 65535 / max_color_idx;
5323 g = (double) g * 65535 / max_color_idx;
5324 b = (double) b * 65535 / max_color_idx;
5325 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
5326 }
5327 }
5328
5329 #ifdef COLOR_TABLE_SUPPORT
5330 /* Store in IMG->colors the colors allocated for the image, and
5331 free the color table. */
5332 img->colors = colors_in_color_table (&img->ncolors);
5333 free_color_table ();
5334 #endif /* COLOR_TABLE_SUPPORT */
5335
5336 img->width = width;
5337 img->height = height;
5338
5339 /* Maybe fill in the background field while we have ximg handy. */
5340
5341 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
5342 /* Casting avoids a GCC warning. */
5343 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
5344
5345 /* Put the image into a pixmap. */
5346 x_put_x_image (f, ximg, img->pixmap, width, height);
5347 x_destroy_x_image (ximg);
5348
5349 /* X and W32 versions did it here, MAC version above. ++kfs
5350 img->width = width;
5351 img->height = height; */
5352
5353 xfree (contents);
5354 return 1;
5355 }
5356
5357 \f
5358 /***********************************************************************
5359 PNG
5360 ***********************************************************************/
5361
5362 #if defined (HAVE_PNG) || defined (HAVE_NS)
5363
5364 /* Function prototypes. */
5365
5366 static int png_image_p (Lisp_Object object);
5367 static int png_load (struct frame *f, struct image *img);
5368
5369 /* The symbol `png' identifying images of this type. */
5370
5371 Lisp_Object Qpng;
5372
5373 /* Indices of image specification fields in png_format, below. */
5374
5375 enum png_keyword_index
5376 {
5377 PNG_TYPE,
5378 PNG_DATA,
5379 PNG_FILE,
5380 PNG_ASCENT,
5381 PNG_MARGIN,
5382 PNG_RELIEF,
5383 PNG_ALGORITHM,
5384 PNG_HEURISTIC_MASK,
5385 PNG_MASK,
5386 PNG_BACKGROUND,
5387 PNG_LAST
5388 };
5389
5390 /* Vector of image_keyword structures describing the format
5391 of valid user-defined image specifications. */
5392
5393 static const struct image_keyword png_format[PNG_LAST] =
5394 {
5395 {":type", IMAGE_SYMBOL_VALUE, 1},
5396 {":data", IMAGE_STRING_VALUE, 0},
5397 {":file", IMAGE_STRING_VALUE, 0},
5398 {":ascent", IMAGE_ASCENT_VALUE, 0},
5399 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
5400 {":relief", IMAGE_INTEGER_VALUE, 0},
5401 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5402 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5403 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5404 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
5405 };
5406
5407 /* Structure describing the image type `png'. */
5408
5409 static struct image_type png_type =
5410 {
5411 &Qpng,
5412 png_image_p,
5413 png_load,
5414 x_clear_image,
5415 NULL
5416 };
5417
5418 /* Return non-zero if OBJECT is a valid PNG image specification. */
5419
5420 static int
5421 png_image_p (Lisp_Object object)
5422 {
5423 struct image_keyword fmt[PNG_LAST];
5424 memcpy (fmt, png_format, sizeof fmt);
5425
5426 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
5427 return 0;
5428
5429 /* Must specify either the :data or :file keyword. */
5430 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
5431 }
5432
5433 #endif /* HAVE_PNG || HAVE_NS */
5434
5435
5436 #ifdef HAVE_PNG
5437
5438 #ifdef HAVE_NTGUI
5439 /* PNG library details. */
5440
5441 DEF_IMGLIB_FN (png_get_io_ptr, (png_structp));
5442 DEF_IMGLIB_FN (png_sig_cmp, (png_bytep, png_size_t, png_size_t));
5443 DEF_IMGLIB_FN (png_create_read_struct, (png_const_charp, png_voidp,
5444 png_error_ptr, png_error_ptr));
5445 DEF_IMGLIB_FN (png_create_info_struct, (png_structp));
5446 DEF_IMGLIB_FN (png_destroy_read_struct, (png_structpp, png_infopp, png_infopp));
5447 DEF_IMGLIB_FN (png_set_read_fn, (png_structp, png_voidp, png_rw_ptr));
5448 DEF_IMGLIB_FN (png_set_sig_bytes, (png_structp, int));
5449 DEF_IMGLIB_FN (png_read_info, (png_structp, png_infop));
5450 DEF_IMGLIB_FN (png_get_IHDR, (png_structp, png_infop,
5451 png_uint_32 *, png_uint_32 *,
5452 int *, int *, int *, int *, int *));
5453 DEF_IMGLIB_FN (png_get_valid, (png_structp, png_infop, png_uint_32));
5454 DEF_IMGLIB_FN (png_set_strip_16, (png_structp));
5455 DEF_IMGLIB_FN (png_set_expand, (png_structp));
5456 DEF_IMGLIB_FN (png_set_gray_to_rgb, (png_structp));
5457 DEF_IMGLIB_FN (png_set_background, (png_structp, png_color_16p,
5458 int, int, double));
5459 DEF_IMGLIB_FN (png_get_bKGD, (png_structp, png_infop, png_color_16p *));
5460 DEF_IMGLIB_FN (png_read_update_info, (png_structp, png_infop));
5461 DEF_IMGLIB_FN (png_get_channels, (png_structp, png_infop));
5462 DEF_IMGLIB_FN (png_get_rowbytes, (png_structp, png_infop));
5463 DEF_IMGLIB_FN (png_read_image, (png_structp, png_bytepp));
5464 DEF_IMGLIB_FN (png_read_end, (png_structp, png_infop));
5465 DEF_IMGLIB_FN (png_error, (png_structp, png_const_charp));
5466
5467 static int
5468 init_png_functions (Lisp_Object libraries)
5469 {
5470 HMODULE library;
5471
5472 /* Try loading libpng under probable names. */
5473 if (!(library = w32_delayed_load (libraries, Qpng)))
5474 return 0;
5475
5476 LOAD_IMGLIB_FN (library, png_get_io_ptr);
5477 LOAD_IMGLIB_FN (library, png_sig_cmp);
5478 LOAD_IMGLIB_FN (library, png_create_read_struct);
5479 LOAD_IMGLIB_FN (library, png_create_info_struct);
5480 LOAD_IMGLIB_FN (library, png_destroy_read_struct);
5481 LOAD_IMGLIB_FN (library, png_set_read_fn);
5482 LOAD_IMGLIB_FN (library, png_set_sig_bytes);
5483 LOAD_IMGLIB_FN (library, png_read_info);
5484 LOAD_IMGLIB_FN (library, png_get_IHDR);
5485 LOAD_IMGLIB_FN (library, png_get_valid);
5486 LOAD_IMGLIB_FN (library, png_set_strip_16);
5487 LOAD_IMGLIB_FN (library, png_set_expand);
5488 LOAD_IMGLIB_FN (library, png_set_gray_to_rgb);
5489 LOAD_IMGLIB_FN (library, png_set_background);
5490 LOAD_IMGLIB_FN (library, png_get_bKGD);
5491 LOAD_IMGLIB_FN (library, png_read_update_info);
5492 LOAD_IMGLIB_FN (library, png_get_channels);
5493 LOAD_IMGLIB_FN (library, png_get_rowbytes);
5494 LOAD_IMGLIB_FN (library, png_read_image);
5495 LOAD_IMGLIB_FN (library, png_read_end);
5496 LOAD_IMGLIB_FN (library, png_error);
5497 return 1;
5498 }
5499 #else
5500
5501 #define fn_png_get_io_ptr png_get_io_ptr
5502 #define fn_png_sig_cmp png_sig_cmp
5503 #define fn_png_create_read_struct png_create_read_struct
5504 #define fn_png_create_info_struct png_create_info_struct
5505 #define fn_png_destroy_read_struct png_destroy_read_struct
5506 #define fn_png_set_read_fn png_set_read_fn
5507 #define fn_png_set_sig_bytes png_set_sig_bytes
5508 #define fn_png_read_info png_read_info
5509 #define fn_png_get_IHDR png_get_IHDR
5510 #define fn_png_get_valid png_get_valid
5511 #define fn_png_set_strip_16 png_set_strip_16
5512 #define fn_png_set_expand png_set_expand
5513 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5514 #define fn_png_set_background png_set_background
5515 #define fn_png_get_bKGD png_get_bKGD
5516 #define fn_png_read_update_info png_read_update_info
5517 #define fn_png_get_channels png_get_channels
5518 #define fn_png_get_rowbytes png_get_rowbytes
5519 #define fn_png_read_image png_read_image
5520 #define fn_png_read_end png_read_end
5521 #define fn_png_error png_error
5522
5523 #endif /* HAVE_NTGUI */
5524
5525 /* Error and warning handlers installed when the PNG library
5526 is initialized. */
5527
5528 static void
5529 my_png_error (png_struct *png_ptr, const char *msg)
5530 {
5531 xassert (png_ptr != NULL);
5532 image_error ("PNG error: %s", build_string (msg), Qnil);
5533 longjmp (png_ptr->jmpbuf, 1);
5534 }
5535
5536
5537 static void
5538 my_png_warning (png_struct *png_ptr, const char *msg)
5539 {
5540 xassert (png_ptr != NULL);
5541 image_error ("PNG warning: %s", build_string (msg), Qnil);
5542 }
5543
5544 /* Memory source for PNG decoding. */
5545
5546 struct png_memory_storage
5547 {
5548 unsigned char *bytes; /* The data */
5549 size_t len; /* How big is it? */
5550 int index; /* Where are we? */
5551 };
5552
5553
5554 /* Function set as reader function when reading PNG image from memory.
5555 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5556 bytes from the input to DATA. */
5557
5558 static void
5559 png_read_from_memory (png_structp png_ptr, png_bytep data, png_size_t length)
5560 {
5561 struct png_memory_storage *tbr
5562 = (struct png_memory_storage *) fn_png_get_io_ptr (png_ptr);
5563
5564 if (length > tbr->len - tbr->index)
5565 fn_png_error (png_ptr, "Read error");
5566
5567 memcpy (data, tbr->bytes + tbr->index, length);
5568 tbr->index = tbr->index + length;
5569 }
5570
5571
5572 /* Function set as reader function when reading PNG image from a file.
5573 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5574 bytes from the input to DATA. */
5575
5576 static void
5577 png_read_from_file (png_structp png_ptr, png_bytep data, png_size_t length)
5578 {
5579 FILE *fp = (FILE *) fn_png_get_io_ptr (png_ptr);
5580
5581 if (fread (data, 1, length, fp) < length)
5582 fn_png_error (png_ptr, "Read error");
5583 }
5584
5585
5586 /* Load PNG image IMG for use on frame F. Value is non-zero if
5587 successful. */
5588
5589 static int
5590 png_load (struct frame *f, struct image *img)
5591 {
5592 Lisp_Object file, specified_file;
5593 Lisp_Object specified_data;
5594 int x, y, i;
5595 XImagePtr ximg, mask_img = NULL;
5596 png_struct *png_ptr = NULL;
5597 png_info *info_ptr = NULL, *end_info = NULL;
5598 FILE *volatile fp = NULL;
5599 png_byte sig[8];
5600 png_byte * volatile pixels = NULL;
5601 png_byte ** volatile rows = NULL;
5602 png_uint_32 width, height;
5603 int bit_depth, color_type, interlace_type;
5604 png_byte channels;
5605 png_uint_32 row_bytes;
5606 int transparent_p;
5607 struct png_memory_storage tbr; /* Data to be read */
5608
5609 /* Find out what file to load. */
5610 specified_file = image_spec_value (img->spec, QCfile, NULL);
5611 specified_data = image_spec_value (img->spec, QCdata, NULL);
5612
5613 if (NILP (specified_data))
5614 {
5615 file = x_find_image_file (specified_file);
5616 if (!STRINGP (file))
5617 {
5618 image_error ("Cannot find image file `%s'", specified_file, Qnil);
5619 return 0;
5620 }
5621
5622 /* Open the image file. */
5623 fp = fopen (SDATA (file), "rb");
5624 if (!fp)
5625 {
5626 image_error ("Cannot open image file `%s'", file, Qnil);
5627 return 0;
5628 }
5629
5630 /* Check PNG signature. */
5631 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
5632 || fn_png_sig_cmp (sig, 0, sizeof sig))
5633 {
5634 image_error ("Not a PNG file: `%s'", file, Qnil);
5635 fclose (fp);
5636 return 0;
5637 }
5638 }
5639 else
5640 {
5641 if (!STRINGP (specified_data))
5642 {
5643 image_error ("Invalid image data `%s'", specified_data, Qnil);
5644 return 0;
5645 }
5646
5647 /* Read from memory. */
5648 tbr.bytes = SDATA (specified_data);
5649 tbr.len = SBYTES (specified_data);
5650 tbr.index = 0;
5651
5652 /* Check PNG signature. */
5653 if (tbr.len < sizeof sig
5654 || fn_png_sig_cmp (tbr.bytes, 0, sizeof sig))
5655 {
5656 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
5657 return 0;
5658 }
5659
5660 /* Need to skip past the signature. */
5661 tbr.bytes += sizeof (sig);
5662 }
5663
5664 /* Initialize read and info structs for PNG lib. Casting return
5665 value avoids a GCC warning on W32. */
5666 png_ptr = (png_structp)fn_png_create_read_struct (PNG_LIBPNG_VER_STRING,
5667 NULL, my_png_error,
5668 my_png_warning);
5669 if (!png_ptr)
5670 {
5671 if (fp) fclose (fp);
5672 return 0;
5673 }
5674
5675 /* Casting return value avoids a GCC warning on W32. */
5676 info_ptr = (png_infop)fn_png_create_info_struct (png_ptr);
5677 if (!info_ptr)
5678 {
5679 fn_png_destroy_read_struct (&png_ptr, NULL, NULL);
5680 if (fp) fclose (fp);
5681 return 0;
5682 }
5683
5684 /* Casting return value avoids a GCC warning on W32. */
5685 end_info = (png_infop)fn_png_create_info_struct (png_ptr);
5686 if (!end_info)
5687 {
5688 fn_png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
5689 if (fp) fclose (fp);
5690 return 0;
5691 }
5692
5693 /* Set error jump-back. We come back here when the PNG library
5694 detects an error. */
5695 if (setjmp (png_ptr->jmpbuf))
5696 {
5697 error:
5698 if (png_ptr)
5699 fn_png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
5700 xfree (pixels);
5701 xfree (rows);
5702 if (fp) fclose (fp);
5703 return 0;
5704 }
5705
5706 /* Read image info. */
5707 if (!NILP (specified_data))
5708 fn_png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
5709 else
5710 fn_png_set_read_fn (png_ptr, (void *) fp, png_read_from_file);
5711
5712 fn_png_set_sig_bytes (png_ptr, sizeof sig);
5713 fn_png_read_info (png_ptr, info_ptr);
5714 fn_png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
5715 &interlace_type, NULL, NULL);
5716
5717 if (!check_image_size (f, width, height))
5718 {
5719 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
5720 goto error;
5721 }
5722 /* If image contains simply transparency data, we prefer to
5723 construct a clipping mask. */
5724 if (fn_png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
5725 transparent_p = 1;
5726 else
5727 transparent_p = 0;
5728
5729 /* This function is easier to write if we only have to handle
5730 one data format: RGB or RGBA with 8 bits per channel. Let's
5731 transform other formats into that format. */
5732
5733 /* Strip more than 8 bits per channel. */
5734 if (bit_depth == 16)
5735 fn_png_set_strip_16 (png_ptr);
5736
5737 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5738 if available. */
5739 fn_png_set_expand (png_ptr);
5740
5741 /* Convert grayscale images to RGB. */
5742 if (color_type == PNG_COLOR_TYPE_GRAY
5743 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
5744 fn_png_set_gray_to_rgb (png_ptr);
5745
5746 /* Handle alpha channel by combining the image with a background
5747 color. Do this only if a real alpha channel is supplied. For
5748 simple transparency, we prefer a clipping mask. */
5749 if (!transparent_p)
5750 {
5751 /* png_color_16 *image_bg; */
5752 Lisp_Object specified_bg
5753 = image_spec_value (img->spec, QCbackground, NULL);
5754 int shift = (bit_depth == 16) ? 0 : 8;
5755
5756 if (STRINGP (specified_bg))
5757 /* The user specified `:background', use that. */
5758 {
5759 XColor color;
5760 if (x_defined_color (f, SDATA (specified_bg), &color, 0))
5761 {
5762 png_color_16 user_bg;
5763
5764 memset (&user_bg, 0, sizeof user_bg);
5765 user_bg.red = color.red >> shift;
5766 user_bg.green = color.green >> shift;
5767 user_bg.blue = color.blue >> shift;
5768
5769 fn_png_set_background (png_ptr, &user_bg,
5770 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
5771 }
5772 }
5773 else
5774 {
5775 /* We use the current frame background, ignoring any default
5776 background color set by the image. */
5777 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
5778 XColor color;
5779 png_color_16 frame_background;
5780
5781 color.pixel = FRAME_BACKGROUND_PIXEL (f);
5782 x_query_color (f, &color);
5783
5784 memset (&frame_background, 0, sizeof frame_background);
5785 frame_background.red = color.red >> shift;
5786 frame_background.green = color.green >> shift;
5787 frame_background.blue = color.blue >> shift;
5788 #endif /* HAVE_X_WINDOWS */
5789
5790 fn_png_set_background (png_ptr, &frame_background,
5791 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
5792 }
5793 }
5794
5795 /* Update info structure. */
5796 fn_png_read_update_info (png_ptr, info_ptr);
5797
5798 /* Get number of channels. Valid values are 1 for grayscale images
5799 and images with a palette, 2 for grayscale images with transparency
5800 information (alpha channel), 3 for RGB images, and 4 for RGB
5801 images with alpha channel, i.e. RGBA. If conversions above were
5802 sufficient we should only have 3 or 4 channels here. */
5803 channels = fn_png_get_channels (png_ptr, info_ptr);
5804 xassert (channels == 3 || channels == 4);
5805
5806 /* Number of bytes needed for one row of the image. */
5807 row_bytes = fn_png_get_rowbytes (png_ptr, info_ptr);
5808
5809 /* Allocate memory for the image. */
5810 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
5811 rows = (png_byte **) xmalloc (height * sizeof *rows);
5812 for (i = 0; i < height; ++i)
5813 rows[i] = pixels + i * row_bytes;
5814
5815 /* Read the entire image. */
5816 fn_png_read_image (png_ptr, rows);
5817 fn_png_read_end (png_ptr, info_ptr);
5818 if (fp)
5819 {
5820 fclose (fp);
5821 fp = NULL;
5822 }
5823
5824 /* Create the X image and pixmap. */
5825 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
5826 &img->pixmap))
5827 goto error;
5828
5829 /* Create an image and pixmap serving as mask if the PNG image
5830 contains an alpha channel. */
5831 if (channels == 4
5832 && !transparent_p
5833 && !x_create_x_image_and_pixmap (f, width, height, 1,
5834 &mask_img, &img->mask))
5835 {
5836 x_destroy_x_image (ximg);
5837 Free_Pixmap (FRAME_X_DISPLAY (f), img->pixmap);
5838 img->pixmap = NO_PIXMAP;
5839 goto error;
5840 }
5841
5842 /* Fill the X image and mask from PNG data. */
5843 init_color_table ();
5844
5845 for (y = 0; y < height; ++y)
5846 {
5847 png_byte *p = rows[y];
5848
5849 for (x = 0; x < width; ++x)
5850 {
5851 unsigned r, g, b;
5852
5853 r = *p++ << 8;
5854 g = *p++ << 8;
5855 b = *p++ << 8;
5856 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
5857 /* An alpha channel, aka mask channel, associates variable
5858 transparency with an image. Where other image formats
5859 support binary transparency---fully transparent or fully
5860 opaque---PNG allows up to 254 levels of partial transparency.
5861 The PNG library implements partial transparency by combining
5862 the image with a specified background color.
5863
5864 I'm not sure how to handle this here nicely: because the
5865 background on which the image is displayed may change, for
5866 real alpha channel support, it would be necessary to create
5867 a new image for each possible background.
5868
5869 What I'm doing now is that a mask is created if we have
5870 boolean transparency information. Otherwise I'm using
5871 the frame's background color to combine the image with. */
5872
5873 if (channels == 4)
5874 {
5875 if (mask_img)
5876 XPutPixel (mask_img, x, y, *p > 0 ? PIX_MASK_DRAW : PIX_MASK_RETAIN);
5877 ++p;
5878 }
5879 }
5880 }
5881
5882 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
5883 /* Set IMG's background color from the PNG image, unless the user
5884 overrode it. */
5885 {
5886 png_color_16 *bg;
5887 if (fn_png_get_bKGD (png_ptr, info_ptr, &bg))
5888 {
5889 img->background = lookup_rgb_color (f, bg->red, bg->green, bg->blue);
5890 img->background_valid = 1;
5891 }
5892 }
5893
5894 #ifdef COLOR_TABLE_SUPPORT
5895 /* Remember colors allocated for this image. */
5896 img->colors = colors_in_color_table (&img->ncolors);
5897 free_color_table ();
5898 #endif /* COLOR_TABLE_SUPPORT */
5899
5900 /* Clean up. */
5901 fn_png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
5902 xfree (rows);
5903 xfree (pixels);
5904
5905 img->width = width;
5906 img->height = height;
5907
5908 /* Maybe fill in the background field while we have ximg handy.
5909 Casting avoids a GCC warning. */
5910 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
5911
5912 /* Put the image into the pixmap, then free the X image and its buffer. */
5913 x_put_x_image (f, ximg, img->pixmap, width, height);
5914 x_destroy_x_image (ximg);
5915
5916 /* Same for the mask. */
5917 if (mask_img)
5918 {
5919 /* Fill in the background_transparent field while we have the
5920 mask handy. Casting avoids a GCC warning. */
5921 image_background_transparent (img, f, (XImagePtr_or_DC)mask_img);
5922
5923 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
5924 x_destroy_x_image (mask_img);
5925 }
5926
5927 return 1;
5928 }
5929
5930 #else /* HAVE_PNG */
5931
5932 #ifdef HAVE_NS
5933 static int
5934 png_load (struct frame *f, struct image *img)
5935 {
5936 return ns_load_image(f, img,
5937 image_spec_value (img->spec, QCfile, NULL),
5938 image_spec_value (img->spec, QCdata, NULL));
5939 }
5940 #endif /* HAVE_NS */
5941
5942
5943 #endif /* !HAVE_PNG */
5944
5945
5946 \f
5947 /***********************************************************************
5948 JPEG
5949 ***********************************************************************/
5950
5951 #if defined (HAVE_JPEG) || defined (HAVE_NS)
5952
5953 static int jpeg_image_p (Lisp_Object object);
5954 static int jpeg_load (struct frame *f, struct image *img);
5955
5956 /* The symbol `jpeg' identifying images of this type. */
5957
5958 Lisp_Object Qjpeg;
5959
5960 /* Indices of image specification fields in gs_format, below. */
5961
5962 enum jpeg_keyword_index
5963 {
5964 JPEG_TYPE,
5965 JPEG_DATA,
5966 JPEG_FILE,
5967 JPEG_ASCENT,
5968 JPEG_MARGIN,
5969 JPEG_RELIEF,
5970 JPEG_ALGORITHM,
5971 JPEG_HEURISTIC_MASK,
5972 JPEG_MASK,
5973 JPEG_BACKGROUND,
5974 JPEG_LAST
5975 };
5976
5977 /* Vector of image_keyword structures describing the format
5978 of valid user-defined image specifications. */
5979
5980 static const struct image_keyword jpeg_format[JPEG_LAST] =
5981 {
5982 {":type", IMAGE_SYMBOL_VALUE, 1},
5983 {":data", IMAGE_STRING_VALUE, 0},
5984 {":file", IMAGE_STRING_VALUE, 0},
5985 {":ascent", IMAGE_ASCENT_VALUE, 0},
5986 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
5987 {":relief", IMAGE_INTEGER_VALUE, 0},
5988 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5989 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5990 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5991 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
5992 };
5993
5994 /* Structure describing the image type `jpeg'. */
5995
5996 static struct image_type jpeg_type =
5997 {
5998 &Qjpeg,
5999 jpeg_image_p,
6000 jpeg_load,
6001 x_clear_image,
6002 NULL
6003 };
6004
6005 /* Return non-zero if OBJECT is a valid JPEG image specification. */
6006
6007 static int
6008 jpeg_image_p (Lisp_Object object)
6009 {
6010 struct image_keyword fmt[JPEG_LAST];
6011
6012 memcpy (fmt, jpeg_format, sizeof fmt);
6013
6014 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
6015 return 0;
6016
6017 /* Must specify either the :data or :file keyword. */
6018 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
6019 }
6020
6021 #endif /* HAVE_JPEG || HAVE_NS */
6022
6023 #ifdef HAVE_JPEG
6024
6025 /* Work around a warning about HAVE_STDLIB_H being redefined in
6026 jconfig.h. */
6027 #ifdef HAVE_STDLIB_H
6028 #define HAVE_STDLIB_H_1
6029 #undef HAVE_STDLIB_H
6030 #endif /* HAVE_STLIB_H */
6031
6032 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6033 /* In older releases of the jpeg library, jpeglib.h will define boolean
6034 differently depending on __WIN32__, so make sure it is defined. */
6035 #define __WIN32__ 1
6036 #endif
6037
6038 #include <jpeglib.h>
6039 #include <jerror.h>
6040
6041 #ifdef HAVE_STLIB_H_1
6042 #define HAVE_STDLIB_H 1
6043 #endif
6044
6045 #ifdef HAVE_NTGUI
6046
6047 /* JPEG library details. */
6048 DEF_IMGLIB_FN (jpeg_CreateDecompress, (j_decompress_ptr, int, size_t));
6049 DEF_IMGLIB_FN (jpeg_start_decompress, (j_decompress_ptr));
6050 DEF_IMGLIB_FN (jpeg_finish_decompress, (j_decompress_ptr));
6051 DEF_IMGLIB_FN (jpeg_destroy_decompress, (j_decompress_ptr));
6052 DEF_IMGLIB_FN (jpeg_read_header, (j_decompress_ptr, boolean));
6053 DEF_IMGLIB_FN (jpeg_read_scanlines, (j_decompress_ptr, JSAMPARRAY, JDIMENSION));
6054 DEF_IMGLIB_FN (jpeg_std_error, (struct jpeg_error_mgr *));
6055 DEF_IMGLIB_FN (jpeg_resync_to_restart, (j_decompress_ptr, int));
6056
6057 static int
6058 init_jpeg_functions (Lisp_Object libraries)
6059 {
6060 HMODULE library;
6061
6062 if (!(library = w32_delayed_load (libraries, Qjpeg)))
6063 return 0;
6064
6065 LOAD_IMGLIB_FN (library, jpeg_finish_decompress);
6066 LOAD_IMGLIB_FN (library, jpeg_read_scanlines);
6067 LOAD_IMGLIB_FN (library, jpeg_start_decompress);
6068 LOAD_IMGLIB_FN (library, jpeg_read_header);
6069 LOAD_IMGLIB_FN (library, jpeg_CreateDecompress);
6070 LOAD_IMGLIB_FN (library, jpeg_destroy_decompress);
6071 LOAD_IMGLIB_FN (library, jpeg_std_error);
6072 LOAD_IMGLIB_FN (library, jpeg_resync_to_restart);
6073 return 1;
6074 }
6075
6076 /* Wrapper since we can't directly assign the function pointer
6077 to another function pointer that was declared more completely easily. */
6078 static boolean
6079 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo, int desired)
6080 {
6081 return fn_jpeg_resync_to_restart (cinfo, desired);
6082 }
6083
6084 #else
6085
6086 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress(a)
6087 #define fn_jpeg_start_decompress jpeg_start_decompress
6088 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6089 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6090 #define fn_jpeg_read_header jpeg_read_header
6091 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6092 #define fn_jpeg_std_error jpeg_std_error
6093 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6094
6095 #endif /* HAVE_NTGUI */
6096
6097 struct my_jpeg_error_mgr
6098 {
6099 struct jpeg_error_mgr pub;
6100 jmp_buf setjmp_buffer;
6101 };
6102
6103
6104 static void
6105 my_error_exit (j_common_ptr cinfo)
6106 {
6107 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
6108 longjmp (mgr->setjmp_buffer, 1);
6109 }
6110
6111
6112 /* Init source method for JPEG data source manager. Called by
6113 jpeg_read_header() before any data is actually read. See
6114 libjpeg.doc from the JPEG lib distribution. */
6115
6116 static void
6117 our_common_init_source (j_decompress_ptr cinfo)
6118 {
6119 }
6120
6121
6122 /* Method to terminate data source. Called by
6123 jpeg_finish_decompress() after all data has been processed. */
6124
6125 static void
6126 our_common_term_source (j_decompress_ptr cinfo)
6127 {
6128 }
6129
6130
6131 /* Fill input buffer method for JPEG data source manager. Called
6132 whenever more data is needed. We read the whole image in one step,
6133 so this only adds a fake end of input marker at the end. */
6134
6135 static JOCTET our_memory_buffer[2];
6136
6137 static boolean
6138 our_memory_fill_input_buffer (j_decompress_ptr cinfo)
6139 {
6140 /* Insert a fake EOI marker. */
6141 struct jpeg_source_mgr *src = cinfo->src;
6142
6143 our_memory_buffer[0] = (JOCTET) 0xFF;
6144 our_memory_buffer[1] = (JOCTET) JPEG_EOI;
6145
6146 src->next_input_byte = our_memory_buffer;
6147 src->bytes_in_buffer = 2;
6148 return 1;
6149 }
6150
6151
6152 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6153 is the JPEG data source manager. */
6154
6155 static void
6156 our_memory_skip_input_data (j_decompress_ptr cinfo, long int num_bytes)
6157 {
6158 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
6159
6160 if (src)
6161 {
6162 if (num_bytes > src->bytes_in_buffer)
6163 ERREXIT (cinfo, JERR_INPUT_EOF);
6164
6165 src->bytes_in_buffer -= num_bytes;
6166 src->next_input_byte += num_bytes;
6167 }
6168 }
6169
6170
6171 /* Set up the JPEG lib for reading an image from DATA which contains
6172 LEN bytes. CINFO is the decompression info structure created for
6173 reading the image. */
6174
6175 static void
6176 jpeg_memory_src (j_decompress_ptr cinfo, JOCTET *data, unsigned int len)
6177 {
6178 struct jpeg_source_mgr *src;
6179
6180 if (cinfo->src == NULL)
6181 {
6182 /* First time for this JPEG object? */
6183 cinfo->src = (struct jpeg_source_mgr *)
6184 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
6185 sizeof (struct jpeg_source_mgr));
6186 src = (struct jpeg_source_mgr *) cinfo->src;
6187 src->next_input_byte = data;
6188 }
6189
6190 src = (struct jpeg_source_mgr *) cinfo->src;
6191 src->init_source = our_common_init_source;
6192 src->fill_input_buffer = our_memory_fill_input_buffer;
6193 src->skip_input_data = our_memory_skip_input_data;
6194 src->resync_to_restart = jpeg_resync_to_restart_wrapper; /* Use default method. */
6195 src->term_source = our_common_term_source;
6196 src->bytes_in_buffer = len;
6197 src->next_input_byte = data;
6198 }
6199
6200
6201 struct jpeg_stdio_mgr
6202 {
6203 struct jpeg_source_mgr mgr;
6204 boolean finished;
6205 FILE *file;
6206 JOCTET *buffer;
6207 };
6208
6209
6210 /* Size of buffer to read JPEG from file.
6211 Not too big, as we want to use alloc_small. */
6212 #define JPEG_STDIO_BUFFER_SIZE 8192
6213
6214
6215 /* Fill input buffer method for JPEG data source manager. Called
6216 whenever more data is needed. The data is read from a FILE *. */
6217
6218 static boolean
6219 our_stdio_fill_input_buffer (j_decompress_ptr cinfo)
6220 {
6221 struct jpeg_stdio_mgr *src;
6222
6223 src = (struct jpeg_stdio_mgr *) cinfo->src;
6224 if (!src->finished)
6225 {
6226 size_t bytes;
6227
6228 bytes = fread (src->buffer, 1, JPEG_STDIO_BUFFER_SIZE, src->file);
6229 if (bytes > 0)
6230 src->mgr.bytes_in_buffer = bytes;
6231 else
6232 {
6233 WARNMS (cinfo, JWRN_JPEG_EOF);
6234 src->finished = 1;
6235 src->buffer[0] = (JOCTET) 0xFF;
6236 src->buffer[1] = (JOCTET) JPEG_EOI;
6237 src->mgr.bytes_in_buffer = 2;
6238 }
6239 src->mgr.next_input_byte = src->buffer;
6240 }
6241
6242 return 1;
6243 }
6244
6245
6246 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6247 is the JPEG data source manager. */
6248
6249 static void
6250 our_stdio_skip_input_data (j_decompress_ptr cinfo, long int num_bytes)
6251 {
6252 struct jpeg_stdio_mgr *src;
6253 src = (struct jpeg_stdio_mgr *) cinfo->src;
6254
6255 while (num_bytes > 0 && !src->finished)
6256 {
6257 if (num_bytes <= src->mgr.bytes_in_buffer)
6258 {
6259 src->mgr.bytes_in_buffer -= num_bytes;
6260 src->mgr.next_input_byte += num_bytes;
6261 break;
6262 }
6263 else
6264 {
6265 num_bytes -= src->mgr.bytes_in_buffer;
6266 src->mgr.bytes_in_buffer = 0;
6267 src->mgr.next_input_byte = NULL;
6268
6269 our_stdio_fill_input_buffer (cinfo);
6270 }
6271 }
6272 }
6273
6274
6275 /* Set up the JPEG lib for reading an image from a FILE *.
6276 CINFO is the decompression info structure created for
6277 reading the image. */
6278
6279 static void
6280 jpeg_file_src (j_decompress_ptr cinfo, FILE *fp)
6281 {
6282 struct jpeg_stdio_mgr *src;
6283
6284 if (cinfo->src != NULL)
6285 src = (struct jpeg_stdio_mgr *) cinfo->src;
6286 else
6287 {
6288 /* First time for this JPEG object? */
6289 cinfo->src = (struct jpeg_source_mgr *)
6290 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
6291 sizeof (struct jpeg_stdio_mgr));
6292 src = (struct jpeg_stdio_mgr *) cinfo->src;
6293 src->buffer = (JOCTET *)
6294 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
6295 JPEG_STDIO_BUFFER_SIZE);
6296 }
6297
6298 src->file = fp;
6299 src->finished = 0;
6300 src->mgr.init_source = our_common_init_source;
6301 src->mgr.fill_input_buffer = our_stdio_fill_input_buffer;
6302 src->mgr.skip_input_data = our_stdio_skip_input_data;
6303 src->mgr.resync_to_restart = jpeg_resync_to_restart_wrapper; /* Use default method. */
6304 src->mgr.term_source = our_common_term_source;
6305 src->mgr.bytes_in_buffer = 0;
6306 src->mgr.next_input_byte = NULL;
6307 }
6308
6309
6310 /* Load image IMG for use on frame F. Patterned after example.c
6311 from the JPEG lib. */
6312
6313 static int
6314 jpeg_load (struct frame *f, struct image *img)
6315 {
6316 struct jpeg_decompress_struct cinfo;
6317 struct my_jpeg_error_mgr mgr;
6318 Lisp_Object file, specified_file;
6319 Lisp_Object specified_data;
6320 FILE * volatile fp = NULL;
6321 JSAMPARRAY buffer;
6322 int row_stride, x, y;
6323 XImagePtr ximg = NULL;
6324 int rc;
6325 unsigned long *colors;
6326 int width, height;
6327
6328 /* Open the JPEG file. */
6329 specified_file = image_spec_value (img->spec, QCfile, NULL);
6330 specified_data = image_spec_value (img->spec, QCdata, NULL);
6331
6332 if (NILP (specified_data))
6333 {
6334 file = x_find_image_file (specified_file);
6335 if (!STRINGP (file))
6336 {
6337 image_error ("Cannot find image file `%s'", specified_file, Qnil);
6338 return 0;
6339 }
6340
6341 fp = fopen (SDATA (file), "rb");
6342 if (fp == NULL)
6343 {
6344 image_error ("Cannot open `%s'", file, Qnil);
6345 return 0;
6346 }
6347 }
6348 else if (!STRINGP (specified_data))
6349 {
6350 image_error ("Invalid image data `%s'", specified_data, Qnil);
6351 return 0;
6352 }
6353
6354 /* Customize libjpeg's error handling to call my_error_exit when an
6355 error is detected. This function will perform a longjmp.
6356 Casting return value avoids a GCC warning on W32. */
6357 cinfo.err = (struct jpeg_error_mgr *)fn_jpeg_std_error (&mgr.pub);
6358 mgr.pub.error_exit = my_error_exit;
6359
6360 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
6361 {
6362 if (rc == 1)
6363 {
6364 /* Called from my_error_exit. Display a JPEG error. */
6365 char buffer[JMSG_LENGTH_MAX];
6366 cinfo.err->format_message ((j_common_ptr) &cinfo, buffer);
6367 image_error ("Error reading JPEG image `%s': %s", img->spec,
6368 build_string (buffer));
6369 }
6370
6371 /* Close the input file and destroy the JPEG object. */
6372 if (fp)
6373 fclose ((FILE *) fp);
6374 fn_jpeg_destroy_decompress (&cinfo);
6375
6376 /* If we already have an XImage, free that. */
6377 x_destroy_x_image (ximg);
6378
6379 /* Free pixmap and colors. */
6380 x_clear_image (f, img);
6381 return 0;
6382 }
6383
6384 /* Create the JPEG decompression object. Let it read from fp.
6385 Read the JPEG image header. */
6386 fn_jpeg_CreateDecompress (&cinfo, JPEG_LIB_VERSION, sizeof (cinfo));
6387
6388 if (NILP (specified_data))
6389 jpeg_file_src (&cinfo, (FILE *) fp);
6390 else
6391 jpeg_memory_src (&cinfo, SDATA (specified_data),
6392 SBYTES (specified_data));
6393
6394 fn_jpeg_read_header (&cinfo, 1);
6395
6396 /* Customize decompression so that color quantization will be used.
6397 Start decompression. */
6398 cinfo.quantize_colors = 1;
6399 fn_jpeg_start_decompress (&cinfo);
6400 width = img->width = cinfo.output_width;
6401 height = img->height = cinfo.output_height;
6402
6403 if (!check_image_size (f, width, height))
6404 {
6405 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
6406 longjmp (mgr.setjmp_buffer, 2);
6407 }
6408
6409 /* Create X image and pixmap. */
6410 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
6411 longjmp (mgr.setjmp_buffer, 2);
6412
6413 /* Allocate colors. When color quantization is used,
6414 cinfo.actual_number_of_colors has been set with the number of
6415 colors generated, and cinfo.colormap is a two-dimensional array
6416 of color indices in the range 0..cinfo.actual_number_of_colors.
6417 No more than 255 colors will be generated. */
6418 {
6419 int i, ir, ig, ib;
6420
6421 if (cinfo.out_color_components > 2)
6422 ir = 0, ig = 1, ib = 2;
6423 else if (cinfo.out_color_components > 1)
6424 ir = 0, ig = 1, ib = 0;
6425 else
6426 ir = 0, ig = 0, ib = 0;
6427
6428 /* Use the color table mechanism because it handles colors that
6429 cannot be allocated nicely. Such colors will be replaced with
6430 a default color, and we don't have to care about which colors
6431 can be freed safely, and which can't. */
6432 init_color_table ();
6433 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
6434 * sizeof *colors);
6435
6436 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
6437 {
6438 /* Multiply RGB values with 255 because X expects RGB values
6439 in the range 0..0xffff. */
6440 int r = cinfo.colormap[ir][i] << 8;
6441 int g = cinfo.colormap[ig][i] << 8;
6442 int b = cinfo.colormap[ib][i] << 8;
6443 colors[i] = lookup_rgb_color (f, r, g, b);
6444 }
6445
6446 #ifdef COLOR_TABLE_SUPPORT
6447 /* Remember those colors actually allocated. */
6448 img->colors = colors_in_color_table (&img->ncolors);
6449 free_color_table ();
6450 #endif /* COLOR_TABLE_SUPPORT */
6451 }
6452
6453 /* Read pixels. */
6454 row_stride = width * cinfo.output_components;
6455 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
6456 row_stride, 1);
6457 for (y = 0; y < height; ++y)
6458 {
6459 fn_jpeg_read_scanlines (&cinfo, buffer, 1);
6460 for (x = 0; x < cinfo.output_width; ++x)
6461 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
6462 }
6463
6464 /* Clean up. */
6465 fn_jpeg_finish_decompress (&cinfo);
6466 fn_jpeg_destroy_decompress (&cinfo);
6467 if (fp)
6468 fclose ((FILE *) fp);
6469
6470 /* Maybe fill in the background field while we have ximg handy. */
6471 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
6472 /* Casting avoids a GCC warning. */
6473 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
6474
6475 /* Put the image into the pixmap. */
6476 x_put_x_image (f, ximg, img->pixmap, width, height);
6477 x_destroy_x_image (ximg);
6478 return 1;
6479 }
6480
6481 #else /* HAVE_JPEG */
6482
6483 #ifdef HAVE_NS
6484 static int
6485 jpeg_load (struct frame *f, struct image *img)
6486 {
6487 return ns_load_image (f, img,
6488 image_spec_value (img->spec, QCfile, NULL),
6489 image_spec_value (img->spec, QCdata, NULL));
6490 }
6491 #endif /* HAVE_NS */
6492
6493 #endif /* !HAVE_JPEG */
6494
6495
6496 \f
6497 /***********************************************************************
6498 TIFF
6499 ***********************************************************************/
6500
6501 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6502
6503 static int tiff_image_p (Lisp_Object object);
6504 static int tiff_load (struct frame *f, struct image *img);
6505
6506 /* The symbol `tiff' identifying images of this type. */
6507
6508 Lisp_Object Qtiff;
6509
6510 /* Indices of image specification fields in tiff_format, below. */
6511
6512 enum tiff_keyword_index
6513 {
6514 TIFF_TYPE,
6515 TIFF_DATA,
6516 TIFF_FILE,
6517 TIFF_ASCENT,
6518 TIFF_MARGIN,
6519 TIFF_RELIEF,
6520 TIFF_ALGORITHM,
6521 TIFF_HEURISTIC_MASK,
6522 TIFF_MASK,
6523 TIFF_BACKGROUND,
6524 TIFF_INDEX,
6525 TIFF_LAST
6526 };
6527
6528 /* Vector of image_keyword structures describing the format
6529 of valid user-defined image specifications. */
6530
6531 static const struct image_keyword tiff_format[TIFF_LAST] =
6532 {
6533 {":type", IMAGE_SYMBOL_VALUE, 1},
6534 {":data", IMAGE_STRING_VALUE, 0},
6535 {":file", IMAGE_STRING_VALUE, 0},
6536 {":ascent", IMAGE_ASCENT_VALUE, 0},
6537 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6538 {":relief", IMAGE_INTEGER_VALUE, 0},
6539 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6540 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6541 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6542 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
6543 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0}
6544 };
6545
6546 /* Structure describing the image type `tiff'. */
6547
6548 static struct image_type tiff_type =
6549 {
6550 &Qtiff,
6551 tiff_image_p,
6552 tiff_load,
6553 x_clear_image,
6554 NULL
6555 };
6556
6557 /* Return non-zero if OBJECT is a valid TIFF image specification. */
6558
6559 static int
6560 tiff_image_p (Lisp_Object object)
6561 {
6562 struct image_keyword fmt[TIFF_LAST];
6563 memcpy (fmt, tiff_format, sizeof fmt);
6564
6565 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
6566 return 0;
6567
6568 /* Must specify either the :data or :file keyword. */
6569 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
6570 }
6571
6572 #endif /* HAVE_TIFF || HAVE_NS */
6573
6574 #ifdef HAVE_TIFF
6575
6576 #include <tiffio.h>
6577
6578 #ifdef HAVE_NTGUI
6579
6580 /* TIFF library details. */
6581 DEF_IMGLIB_FN (TIFFSetErrorHandler, (TIFFErrorHandler));
6582 DEF_IMGLIB_FN (TIFFSetWarningHandler, (TIFFErrorHandler));
6583 DEF_IMGLIB_FN (TIFFOpen, (const char *, const char *));
6584 DEF_IMGLIB_FN (TIFFClientOpen, (const char *, const char *, thandle_t,
6585 TIFFReadWriteProc, TIFFReadWriteProc,
6586 TIFFSeekProc, TIFFCloseProc, TIFFSizeProc,
6587 TIFFMapFileProc, TIFFUnmapFileProc));
6588 DEF_IMGLIB_FN (TIFFGetField, (TIFF *, ttag_t, ...));
6589 DEF_IMGLIB_FN (TIFFReadRGBAImage, (TIFF *, uint32, uint32, uint32 *, int));
6590 DEF_IMGLIB_FN (TIFFClose, (TIFF *));
6591 DEF_IMGLIB_FN (TIFFSetDirectory, (TIFF *, tdir_t));
6592
6593 static int
6594 init_tiff_functions (Lisp_Object libraries)
6595 {
6596 HMODULE library;
6597
6598 if (!(library = w32_delayed_load (libraries, Qtiff)))
6599 return 0;
6600
6601 LOAD_IMGLIB_FN (library, TIFFSetErrorHandler);
6602 LOAD_IMGLIB_FN (library, TIFFSetWarningHandler);
6603 LOAD_IMGLIB_FN (library, TIFFOpen);
6604 LOAD_IMGLIB_FN (library, TIFFClientOpen);
6605 LOAD_IMGLIB_FN (library, TIFFGetField);
6606 LOAD_IMGLIB_FN (library, TIFFReadRGBAImage);
6607 LOAD_IMGLIB_FN (library, TIFFClose);
6608 LOAD_IMGLIB_FN (library, TIFFSetDirectory);
6609 return 1;
6610 }
6611
6612 #else
6613
6614 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6615 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6616 #define fn_TIFFOpen TIFFOpen
6617 #define fn_TIFFClientOpen TIFFClientOpen
6618 #define fn_TIFFGetField TIFFGetField
6619 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6620 #define fn_TIFFClose TIFFClose
6621 #define fn_TIFFSetDirectory TIFFSetDirectory
6622 #endif /* HAVE_NTGUI */
6623
6624
6625 /* Reading from a memory buffer for TIFF images Based on the PNG
6626 memory source, but we have to provide a lot of extra functions.
6627 Blah.
6628
6629 We really only need to implement read and seek, but I am not
6630 convinced that the TIFF library is smart enough not to destroy
6631 itself if we only hand it the function pointers we need to
6632 override. */
6633
6634 typedef struct
6635 {
6636 unsigned char *bytes;
6637 size_t len;
6638 int index;
6639 }
6640 tiff_memory_source;
6641
6642 static size_t
6643 tiff_read_from_memory (thandle_t data, tdata_t buf, tsize_t size)
6644 {
6645 tiff_memory_source *src = (tiff_memory_source *) data;
6646
6647 if (size > src->len - src->index)
6648 return (size_t) -1;
6649 memcpy (buf, src->bytes + src->index, size);
6650 src->index += size;
6651 return size;
6652 }
6653
6654 static size_t
6655 tiff_write_from_memory (thandle_t data, tdata_t buf, tsize_t size)
6656 {
6657 return (size_t) -1;
6658 }
6659
6660 static toff_t
6661 tiff_seek_in_memory (thandle_t data, toff_t off, int whence)
6662 {
6663 tiff_memory_source *src = (tiff_memory_source *) data;
6664 int idx;
6665
6666 switch (whence)
6667 {
6668 case SEEK_SET: /* Go from beginning of source. */
6669 idx = off;
6670 break;
6671
6672 case SEEK_END: /* Go from end of source. */
6673 idx = src->len + off;
6674 break;
6675
6676 case SEEK_CUR: /* Go from current position. */
6677 idx = src->index + off;
6678 break;
6679
6680 default: /* Invalid `whence'. */
6681 return -1;
6682 }
6683
6684 if (idx > src->len || idx < 0)
6685 return -1;
6686
6687 src->index = idx;
6688 return src->index;
6689 }
6690
6691 static int
6692 tiff_close_memory (thandle_t data)
6693 {
6694 /* NOOP */
6695 return 0;
6696 }
6697
6698 static int
6699 tiff_mmap_memory (thandle_t data, tdata_t *pbase, toff_t *psize)
6700 {
6701 /* It is already _IN_ memory. */
6702 return 0;
6703 }
6704
6705 static void
6706 tiff_unmap_memory (thandle_t data, tdata_t base, toff_t size)
6707 {
6708 /* We don't need to do this. */
6709 }
6710
6711 static toff_t
6712 tiff_size_of_memory (thandle_t data)
6713 {
6714 return ((tiff_memory_source *) data)->len;
6715 }
6716
6717
6718 static void
6719 tiff_error_handler (const char *title, const char *format, va_list ap)
6720 {
6721 char buf[512];
6722 int len;
6723
6724 len = sprintf (buf, "TIFF error: %s ", title);
6725 vsprintf (buf + len, format, ap);
6726 add_to_log (buf, Qnil, Qnil);
6727 }
6728
6729
6730 static void
6731 tiff_warning_handler (const char *title, const char *format, va_list ap)
6732 {
6733 char buf[512];
6734 int len;
6735
6736 len = sprintf (buf, "TIFF warning: %s ", title);
6737 vsprintf (buf + len, format, ap);
6738 add_to_log (buf, Qnil, Qnil);
6739 }
6740
6741
6742 /* Load TIFF image IMG for use on frame F. Value is non-zero if
6743 successful. */
6744
6745 static int
6746 tiff_load (struct frame *f, struct image *img)
6747 {
6748 Lisp_Object file, specified_file;
6749 Lisp_Object specified_data;
6750 TIFF *tiff;
6751 int width, height, x, y, count;
6752 uint32 *buf;
6753 int rc, rc2;
6754 XImagePtr ximg;
6755 tiff_memory_source memsrc;
6756 Lisp_Object image;
6757
6758 specified_file = image_spec_value (img->spec, QCfile, NULL);
6759 specified_data = image_spec_value (img->spec, QCdata, NULL);
6760
6761 fn_TIFFSetErrorHandler (tiff_error_handler);
6762 fn_TIFFSetWarningHandler (tiff_warning_handler);
6763
6764 if (NILP (specified_data))
6765 {
6766 /* Read from a file */
6767 file = x_find_image_file (specified_file);
6768 if (!STRINGP (file))
6769 {
6770 image_error ("Cannot find image file `%s'", specified_file, Qnil);
6771 return 0;
6772 }
6773
6774 /* Try to open the image file. Casting return value avoids a
6775 GCC warning on W32. */
6776 tiff = (TIFF *)fn_TIFFOpen (SDATA (file), "r");
6777 if (tiff == NULL)
6778 {
6779 image_error ("Cannot open `%s'", file, Qnil);
6780 return 0;
6781 }
6782 }
6783 else
6784 {
6785 if (!STRINGP (specified_data))
6786 {
6787 image_error ("Invalid image data `%s'", specified_data, Qnil);
6788 return 0;
6789 }
6790
6791 /* Memory source! */
6792 memsrc.bytes = SDATA (specified_data);
6793 memsrc.len = SBYTES (specified_data);
6794 memsrc.index = 0;
6795
6796 /* Casting arguments return value avoids a GCC warning on W32. */
6797 tiff = (TIFF *)fn_TIFFClientOpen ("memory_source", "r",
6798 (thandle_t) &memsrc,
6799 (TIFFReadWriteProc) tiff_read_from_memory,
6800 (TIFFReadWriteProc) tiff_write_from_memory,
6801 tiff_seek_in_memory,
6802 tiff_close_memory,
6803 tiff_size_of_memory,
6804 tiff_mmap_memory,
6805 tiff_unmap_memory);
6806
6807 if (!tiff)
6808 {
6809 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
6810 return 0;
6811 }
6812 }
6813
6814 image = image_spec_value (img->spec, QCindex, NULL);
6815 if (INTEGERP (image))
6816 {
6817 int ino = XFASTINT (image);
6818 if (!fn_TIFFSetDirectory (tiff, ino))
6819 {
6820 image_error ("Invalid image number `%s' in image `%s'",
6821 image, img->spec);
6822 fn_TIFFClose (tiff);
6823 return 0;
6824 }
6825 }
6826
6827 /* Get width and height of the image, and allocate a raster buffer
6828 of width x height 32-bit values. */
6829 fn_TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
6830 fn_TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
6831
6832 if (!check_image_size (f, width, height))
6833 {
6834 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
6835 fn_TIFFClose (tiff);
6836 return 0;
6837 }
6838
6839 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
6840
6841 rc = fn_TIFFReadRGBAImage (tiff, width, height, buf, 0);
6842
6843 /* Count the number of images in the file. */
6844 for (count = 1, rc2 = 1; rc2; count++)
6845 rc2 = fn_TIFFSetDirectory (tiff, count);
6846
6847 if (count > 1)
6848 img->data.lisp_val = Fcons (Qcount,
6849 Fcons (make_number (count),
6850 img->data.lisp_val));
6851
6852 fn_TIFFClose (tiff);
6853 if (!rc)
6854 {
6855 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
6856 xfree (buf);
6857 return 0;
6858 }
6859
6860 /* Create the X image and pixmap. */
6861 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
6862 {
6863 xfree (buf);
6864 return 0;
6865 }
6866
6867 /* Initialize the color table. */
6868 init_color_table ();
6869
6870 /* Process the pixel raster. Origin is in the lower-left corner. */
6871 for (y = 0; y < height; ++y)
6872 {
6873 uint32 *row = buf + y * width;
6874
6875 for (x = 0; x < width; ++x)
6876 {
6877 uint32 abgr = row[x];
6878 int r = TIFFGetR (abgr) << 8;
6879 int g = TIFFGetG (abgr) << 8;
6880 int b = TIFFGetB (abgr) << 8;
6881 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
6882 }
6883 }
6884
6885 #ifdef COLOR_TABLE_SUPPORT
6886 /* Remember the colors allocated for the image. Free the color table. */
6887 img->colors = colors_in_color_table (&img->ncolors);
6888 free_color_table ();
6889 #endif /* COLOR_TABLE_SUPPORT */
6890
6891 img->width = width;
6892 img->height = height;
6893
6894 /* Maybe fill in the background field while we have ximg handy. */
6895 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
6896 /* Casting avoids a GCC warning on W32. */
6897 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
6898
6899 /* Put the image into the pixmap, then free the X image and its buffer. */
6900 x_put_x_image (f, ximg, img->pixmap, width, height);
6901 x_destroy_x_image (ximg);
6902 xfree (buf);
6903
6904 return 1;
6905 }
6906
6907 #else /* HAVE_TIFF */
6908
6909 #ifdef HAVE_NS
6910 static int
6911 tiff_load (struct frame *f, struct image *img)
6912 {
6913 return ns_load_image (f, img,
6914 image_spec_value (img->spec, QCfile, NULL),
6915 image_spec_value (img->spec, QCdata, NULL));
6916 }
6917 #endif /* HAVE_NS */
6918
6919 #endif /* !HAVE_TIFF */
6920
6921
6922 \f
6923 /***********************************************************************
6924 GIF
6925 ***********************************************************************/
6926
6927 #if defined (HAVE_GIF) || defined (HAVE_NS)
6928
6929 static int gif_image_p (Lisp_Object object);
6930 static int gif_load (struct frame *f, struct image *img);
6931 static void gif_clear_image (struct frame *f, struct image *img);
6932
6933 /* The symbol `gif' identifying images of this type. */
6934
6935 Lisp_Object Qgif;
6936
6937 /* Indices of image specification fields in gif_format, below. */
6938
6939 enum gif_keyword_index
6940 {
6941 GIF_TYPE,
6942 GIF_DATA,
6943 GIF_FILE,
6944 GIF_ASCENT,
6945 GIF_MARGIN,
6946 GIF_RELIEF,
6947 GIF_ALGORITHM,
6948 GIF_HEURISTIC_MASK,
6949 GIF_MASK,
6950 GIF_IMAGE,
6951 GIF_BACKGROUND,
6952 GIF_LAST
6953 };
6954
6955 /* Vector of image_keyword structures describing the format
6956 of valid user-defined image specifications. */
6957
6958 static const struct image_keyword gif_format[GIF_LAST] =
6959 {
6960 {":type", IMAGE_SYMBOL_VALUE, 1},
6961 {":data", IMAGE_STRING_VALUE, 0},
6962 {":file", IMAGE_STRING_VALUE, 0},
6963 {":ascent", IMAGE_ASCENT_VALUE, 0},
6964 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6965 {":relief", IMAGE_INTEGER_VALUE, 0},
6966 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6967 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6968 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6969 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0},
6970 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
6971 };
6972
6973 /* Structure describing the image type `gif'. */
6974
6975 static struct image_type gif_type =
6976 {
6977 &Qgif,
6978 gif_image_p,
6979 gif_load,
6980 gif_clear_image,
6981 NULL
6982 };
6983
6984 /* Free X resources of GIF image IMG which is used on frame F. */
6985
6986 static void
6987 gif_clear_image (struct frame *f, struct image *img)
6988 {
6989 /* IMG->data.ptr_val may contain metadata with extension data. */
6990 img->data.lisp_val = Qnil;
6991 x_clear_image (f, img);
6992 }
6993
6994 /* Return non-zero if OBJECT is a valid GIF image specification. */
6995
6996 static int
6997 gif_image_p (Lisp_Object object)
6998 {
6999 struct image_keyword fmt[GIF_LAST];
7000 memcpy (fmt, gif_format, sizeof fmt);
7001
7002 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
7003 return 0;
7004
7005 /* Must specify either the :data or :file keyword. */
7006 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
7007 }
7008
7009 #endif /* HAVE_GIF */
7010
7011 #ifdef HAVE_GIF
7012
7013 #if defined (HAVE_NTGUI)
7014 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7015 Undefine before redefining to avoid a preprocessor warning. */
7016 #ifdef DrawText
7017 #undef DrawText
7018 #endif
7019 /* avoid conflict with QuickdrawText.h */
7020 #define DrawText gif_DrawText
7021 #include <gif_lib.h>
7022 #undef DrawText
7023
7024 #else /* HAVE_NTGUI */
7025
7026 #include <gif_lib.h>
7027
7028 #endif /* HAVE_NTGUI */
7029
7030
7031 #ifdef HAVE_NTGUI
7032
7033 /* GIF library details. */
7034 DEF_IMGLIB_FN (DGifCloseFile, (GifFileType *));
7035 DEF_IMGLIB_FN (DGifSlurp, (GifFileType *));
7036 DEF_IMGLIB_FN (DGifOpen, (void *, InputFunc));
7037 DEF_IMGLIB_FN (DGifOpenFileName, (const char *));
7038
7039 static int
7040 init_gif_functions (Lisp_Object libraries)
7041 {
7042 HMODULE library;
7043
7044 if (!(library = w32_delayed_load (libraries, Qgif)))
7045 return 0;
7046
7047 LOAD_IMGLIB_FN (library, DGifCloseFile);
7048 LOAD_IMGLIB_FN (library, DGifSlurp);
7049 LOAD_IMGLIB_FN (library, DGifOpen);
7050 LOAD_IMGLIB_FN (library, DGifOpenFileName);
7051 return 1;
7052 }
7053
7054 #else
7055
7056 #define fn_DGifCloseFile DGifCloseFile
7057 #define fn_DGifSlurp DGifSlurp
7058 #define fn_DGifOpen DGifOpen
7059 #define fn_DGifOpenFileName DGifOpenFileName
7060
7061 #endif /* HAVE_NTGUI */
7062
7063 /* Reading a GIF image from memory
7064 Based on the PNG memory stuff to a certain extent. */
7065
7066 typedef struct
7067 {
7068 unsigned char *bytes;
7069 size_t len;
7070 int index;
7071 }
7072 gif_memory_source;
7073
7074 /* Make the current memory source available to gif_read_from_memory.
7075 It's done this way because not all versions of libungif support
7076 a UserData field in the GifFileType structure. */
7077 static gif_memory_source *current_gif_memory_src;
7078
7079 static int
7080 gif_read_from_memory (GifFileType *file, GifByteType *buf, int len)
7081 {
7082 gif_memory_source *src = current_gif_memory_src;
7083
7084 if (len > src->len - src->index)
7085 return -1;
7086
7087 memcpy (buf, src->bytes + src->index, len);
7088 src->index += len;
7089 return len;
7090 }
7091
7092
7093 /* Load GIF image IMG for use on frame F. Value is non-zero if
7094 successful. */
7095
7096 static const int interlace_start[] = {0, 4, 2, 1};
7097 static const int interlace_increment[] = {8, 8, 4, 2};
7098
7099 static int
7100 gif_load (struct frame *f, struct image *img)
7101 {
7102 Lisp_Object file, specified_file;
7103 Lisp_Object specified_data;
7104 int rc, width, height, x, y, i;
7105 XImagePtr ximg;
7106 ColorMapObject *gif_color_map;
7107 unsigned long pixel_colors[256];
7108 GifFileType *gif;
7109 Lisp_Object image;
7110 int ino, image_height, image_width;
7111 gif_memory_source memsrc;
7112 unsigned char *raster;
7113
7114 specified_file = image_spec_value (img->spec, QCfile, NULL);
7115 specified_data = image_spec_value (img->spec, QCdata, NULL);
7116
7117 if (NILP (specified_data))
7118 {
7119 file = x_find_image_file (specified_file);
7120 if (!STRINGP (file))
7121 {
7122 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7123 return 0;
7124 }
7125
7126 /* Open the GIF file. Casting return value avoids a GCC warning
7127 on W32. */
7128 gif = (GifFileType *)fn_DGifOpenFileName (SDATA (file));
7129 if (gif == NULL)
7130 {
7131 image_error ("Cannot open `%s'", file, Qnil);
7132 return 0;
7133 }
7134 }
7135 else
7136 {
7137 if (!STRINGP (specified_data))
7138 {
7139 image_error ("Invalid image data `%s'", specified_data, Qnil);
7140 return 0;
7141 }
7142
7143 /* Read from memory! */
7144 current_gif_memory_src = &memsrc;
7145 memsrc.bytes = SDATA (specified_data);
7146 memsrc.len = SBYTES (specified_data);
7147 memsrc.index = 0;
7148
7149 /* Casting return value avoids a GCC warning on W32. */
7150 gif = (GifFileType *) fn_DGifOpen (&memsrc, gif_read_from_memory);
7151 if (!gif)
7152 {
7153 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
7154 return 0;
7155 }
7156 }
7157
7158 /* Before reading entire contents, check the declared image size. */
7159 if (!check_image_size (f, gif->SWidth, gif->SHeight))
7160 {
7161 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
7162 fn_DGifCloseFile (gif);
7163 return 0;
7164 }
7165
7166 /* Read entire contents. */
7167 rc = fn_DGifSlurp (gif);
7168 if (rc == GIF_ERROR)
7169 {
7170 image_error ("Error reading `%s'", img->spec, Qnil);
7171 fn_DGifCloseFile (gif);
7172 return 0;
7173 }
7174
7175 image = image_spec_value (img->spec, QCindex, NULL);
7176 ino = INTEGERP (image) ? XFASTINT (image) : 0;
7177 if (ino >= gif->ImageCount)
7178 {
7179 image_error ("Invalid image number `%s' in image `%s'",
7180 image, img->spec);
7181 fn_DGifCloseFile (gif);
7182 return 0;
7183 }
7184
7185 img->corners[TOP_CORNER] = gif->SavedImages[ino].ImageDesc.Top;
7186 img->corners[LEFT_CORNER] = gif->SavedImages[ino].ImageDesc.Left;
7187 image_height = gif->SavedImages[ino].ImageDesc.Height;
7188 img->corners[BOT_CORNER] = img->corners[TOP_CORNER] + image_height;
7189 image_width = gif->SavedImages[ino].ImageDesc.Width;
7190 img->corners[RIGHT_CORNER] = img->corners[LEFT_CORNER] + image_width;
7191
7192 width = img->width = max (gif->SWidth,
7193 max (gif->Image.Left + gif->Image.Width,
7194 img->corners[RIGHT_CORNER]));
7195 height = img->height = max (gif->SHeight,
7196 max (gif->Image.Top + gif->Image.Height,
7197 img->corners[BOT_CORNER]));
7198
7199 if (!check_image_size (f, width, height))
7200 {
7201 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
7202 fn_DGifCloseFile (gif);
7203 return 0;
7204 }
7205
7206 /* Create the X image and pixmap. */
7207 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
7208 {
7209 fn_DGifCloseFile (gif);
7210 return 0;
7211 }
7212
7213 /* Allocate colors. */
7214 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
7215 if (!gif_color_map)
7216 gif_color_map = gif->SColorMap;
7217 init_color_table ();
7218 memset (pixel_colors, 0, sizeof pixel_colors);
7219
7220 if (gif_color_map)
7221 for (i = 0; i < gif_color_map->ColorCount; ++i)
7222 {
7223 int r = gif_color_map->Colors[i].Red << 8;
7224 int g = gif_color_map->Colors[i].Green << 8;
7225 int b = gif_color_map->Colors[i].Blue << 8;
7226 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
7227 }
7228
7229 #ifdef COLOR_TABLE_SUPPORT
7230 img->colors = colors_in_color_table (&img->ncolors);
7231 free_color_table ();
7232 #endif /* COLOR_TABLE_SUPPORT */
7233
7234 /* Clear the part of the screen image that are not covered by
7235 the image from the GIF file. Full animated GIF support
7236 requires more than can be done here (see the gif89 spec,
7237 disposal methods). Let's simply assume that the part
7238 not covered by a sub-image is in the frame's background color. */
7239 for (y = 0; y < img->corners[TOP_CORNER]; ++y)
7240 for (x = 0; x < width; ++x)
7241 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7242
7243 for (y = img->corners[BOT_CORNER]; y < height; ++y)
7244 for (x = 0; x < width; ++x)
7245 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7246
7247 for (y = img->corners[TOP_CORNER]; y < img->corners[BOT_CORNER]; ++y)
7248 {
7249 for (x = 0; x < img->corners[LEFT_CORNER]; ++x)
7250 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7251 for (x = img->corners[RIGHT_CORNER]; x < width; ++x)
7252 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
7253 }
7254
7255 /* Read the GIF image into the X image. We use a local variable
7256 `raster' here because RasterBits below is a char *, and invites
7257 problems with bytes >= 0x80. */
7258 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
7259
7260 if (gif->SavedImages[ino].ImageDesc.Interlace)
7261 {
7262 int pass;
7263 int row = interlace_start[0];
7264
7265 pass = 0;
7266
7267 for (y = 0; y < image_height; y++)
7268 {
7269 if (row >= image_height)
7270 {
7271 row = interlace_start[++pass];
7272 while (row >= image_height)
7273 row = interlace_start[++pass];
7274 }
7275
7276 for (x = 0; x < image_width; x++)
7277 {
7278 int i = raster[(y * image_width) + x];
7279 XPutPixel (ximg, x + img->corners[LEFT_CORNER],
7280 row + img->corners[TOP_CORNER], pixel_colors[i]);
7281 }
7282
7283 row += interlace_increment[pass];
7284 }
7285 }
7286 else
7287 {
7288 for (y = 0; y < image_height; ++y)
7289 for (x = 0; x < image_width; ++x)
7290 {
7291 int i = raster[y * image_width + x];
7292 XPutPixel (ximg, x + img->corners[LEFT_CORNER],
7293 y + img->corners[TOP_CORNER], pixel_colors[i]);
7294 }
7295 }
7296
7297 /* Save GIF image extension data for `image-metadata'.
7298 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7299 img->data.lisp_val = Qnil;
7300 if (gif->SavedImages[ino].ExtensionBlockCount > 0)
7301 {
7302 ExtensionBlock *ext = gif->SavedImages[ino].ExtensionBlocks;
7303 for (i = 0; i < gif->SavedImages[ino].ExtensionBlockCount; i++, ext++)
7304 /* Append (... FUNCTION "BYTES") */
7305 img->data.lisp_val = Fcons (make_unibyte_string (ext->Bytes, ext->ByteCount),
7306 Fcons (make_number (ext->Function),
7307 img->data.lisp_val));
7308 img->data.lisp_val = Fcons (Qextension_data,
7309 Fcons (Fnreverse (img->data.lisp_val),
7310 Qnil));
7311 }
7312 if (gif->ImageCount > 1)
7313 img->data.lisp_val = Fcons (Qcount,
7314 Fcons (make_number (gif->ImageCount),
7315 img->data.lisp_val));
7316
7317 fn_DGifCloseFile (gif);
7318
7319 /* Maybe fill in the background field while we have ximg handy. */
7320 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
7321 /* Casting avoids a GCC warning. */
7322 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
7323
7324 /* Put the image into the pixmap, then free the X image and its buffer. */
7325 x_put_x_image (f, ximg, img->pixmap, width, height);
7326 x_destroy_x_image (ximg);
7327
7328 return 1;
7329 }
7330
7331 #else /* !HAVE_GIF */
7332
7333 #ifdef HAVE_NS
7334 static int
7335 gif_load (struct frame *f, struct image *img)
7336 {
7337 return ns_load_image (f, img,
7338 image_spec_value (img->spec, QCfile, NULL),
7339 image_spec_value (img->spec, QCdata, NULL));
7340 }
7341 #endif /* HAVE_NS */
7342
7343 #endif /* HAVE_GIF */
7344
7345
7346 /***********************************************************************
7347 imagemagick
7348 ***********************************************************************/
7349 #if defined (HAVE_IMAGEMAGICK)
7350 Lisp_Object Vimagemagick_render_type;
7351
7352 /* The symbol `imagemagick' identifying images of this type. */
7353
7354 Lisp_Object Qimagemagick;
7355 Lisp_Object Vimagemagick_render_type;
7356
7357 /* Indices of image specification fields in imagemagick_format, below. */
7358
7359 enum imagemagick_keyword_index
7360 {
7361 IMAGEMAGICK_TYPE,
7362 IMAGEMAGICK_DATA,
7363 IMAGEMAGICK_FILE,
7364 IMAGEMAGICK_ASCENT,
7365 IMAGEMAGICK_MARGIN,
7366 IMAGEMAGICK_RELIEF,
7367 IMAGEMAGICK_ALGORITHM,
7368 IMAGEMAGICK_HEURISTIC_MASK,
7369 IMAGEMAGICK_MASK,
7370 IMAGEMAGICK_BACKGROUND,
7371 IMAGEMAGICK_HEIGHT,
7372 IMAGEMAGICK_WIDTH,
7373 IMAGEMAGICK_ROTATION,
7374 IMAGEMAGICK_CROP,
7375 IMAGEMAGICK_LAST
7376 };
7377
7378 /* Vector of image_keyword structures describing the format
7379 of valid user-defined image specifications. */
7380
7381 static struct image_keyword imagemagick_format[IMAGEMAGICK_LAST] =
7382 {
7383 {":type", IMAGE_SYMBOL_VALUE, 1},
7384 {":data", IMAGE_STRING_VALUE, 0},
7385 {":file", IMAGE_STRING_VALUE, 0},
7386 {":ascent", IMAGE_ASCENT_VALUE, 0},
7387 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7388 {":relief", IMAGE_INTEGER_VALUE, 0},
7389 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7390 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7391 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7392 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
7393 {":height", IMAGE_INTEGER_VALUE, 0},
7394 {":width", IMAGE_INTEGER_VALUE, 0},
7395 {":rotation", IMAGE_NUMBER_VALUE, 0},
7396 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
7397 };
7398 /* Free X resources of imagemagick image IMG which is used on frame F. */
7399
7400 static void
7401 imagemagick_clear_image (struct frame *f,
7402 struct image *img)
7403 {
7404 x_clear_image (f, img);
7405 }
7406
7407
7408
7409 /* Return non-zero if OBJECT is a valid IMAGEMAGICK image specification. Do
7410 this by calling parse_image_spec and supplying the keywords that
7411 identify the IMAGEMAGICK format. */
7412
7413 static int
7414 imagemagick_image_p (Lisp_Object object)
7415 {
7416 struct image_keyword fmt[IMAGEMAGICK_LAST];
7417 memcpy (fmt, imagemagick_format, sizeof fmt);
7418
7419 if (!parse_image_spec (object, fmt, IMAGEMAGICK_LAST, Qimagemagick))
7420 return 0;
7421
7422 /* Must specify either the :data or :file keyword. */
7423 return fmt[IMAGEMAGICK_FILE].count + fmt[IMAGEMAGICK_DATA].count == 1;
7424 }
7425
7426 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7427 Therefore rename the function so it doesnt collide with ImageMagick. */
7428 #define DrawRectangle DrawRectangleGif
7429 #include <wand/MagickWand.h>
7430
7431 /* imagemagick_load_image is a helper function for imagemagick_load,
7432 which does the actual loading given contents and size, apart from
7433 frame and image structures, passed from imagemagick_load.
7434
7435 Uses librimagemagick to do most of the image processing.
7436
7437 non-zero when successful.
7438 */
7439
7440 static int
7441 imagemagick_load_image (/* Pointer to emacs frame structure. */
7442 struct frame *f,
7443 /* Pointer to emacs image structure. */
7444 struct image *img,
7445 /* String containing the IMAGEMAGICK data to
7446 be parsed. */
7447 unsigned char *contents,
7448 /* Size of data in bytes. */
7449 unsigned int size,
7450 /* Filename, either pass filename or
7451 contents/size. */
7452 unsigned char *filename)
7453 {
7454 unsigned long width;
7455 unsigned long height;
7456
7457 MagickBooleanType
7458 status;
7459
7460 XImagePtr ximg;
7461 Lisp_Object specified_bg;
7462 XColor background;
7463 int x;
7464 int y;
7465
7466 MagickWand *image_wand;
7467 MagickWand *ping_wand;
7468 PixelIterator *iterator;
7469 PixelWand **pixels;
7470 MagickPixelPacket pixel;
7471 Lisp_Object image;
7472 Lisp_Object value;
7473 Lisp_Object crop, geometry;
7474 long ino;
7475 int desired_width, desired_height;
7476 double rotation;
7477 int imagemagick_rendermethod;
7478 int pixelwidth;
7479 ImageInfo *image_info;
7480 ExceptionInfo *exception;
7481 Image * im_image;
7482
7483
7484 /* Handle image index for image types who can contain more than one
7485 image. Interface :index is same as for GIF. First we "ping" the
7486 image to see how many sub-images it contains. Pinging is faster
7487 than loading the image to find out things about it. */
7488 image = image_spec_value (img->spec, QCindex, NULL);
7489 ino = INTEGERP (image) ? XFASTINT (image) : 0;
7490 ping_wand = NewMagickWand ();
7491 MagickSetResolution (ping_wand, 2, 2);
7492 if (filename != NULL)
7493 {
7494 status = MagickPingImage (ping_wand, filename);
7495 }
7496 else
7497 {
7498 status = MagickPingImageBlob (ping_wand, contents, size);
7499 }
7500
7501 if (ino >= MagickGetNumberImages (ping_wand))
7502 {
7503 image_error ("Invalid image number `%s' in image `%s'",
7504 image, img->spec);
7505 DestroyMagickWand (ping_wand);
7506 return 0;
7507 }
7508
7509 if (MagickGetNumberImages(ping_wand) > 1)
7510 img->data.lisp_val =
7511 Fcons (Qcount,
7512 Fcons (make_number (MagickGetNumberImages (ping_wand)),
7513 img->data.lisp_val));
7514
7515 DestroyMagickWand (ping_wand);
7516 /* Now, after pinging, we know how many images are inside the
7517 file. If its not a bundle, just one. */
7518
7519 if (filename != NULL)
7520 {
7521 image_info = CloneImageInfo ((ImageInfo *) NULL);
7522 (void) strcpy (image_info->filename, filename);
7523 image_info->number_scenes = 1;
7524 image_info->scene = ino;
7525 exception = AcquireExceptionInfo ();
7526
7527 im_image = ReadImage (image_info, exception);
7528 CatchException (exception);
7529
7530 image_wand = NewMagickWandFromImage (im_image);
7531 }
7532 else
7533 {
7534 image_wand = NewMagickWand ();
7535 status = MagickReadImageBlob (image_wand, contents, size);
7536 }
7537 image_error ("im read failed", Qnil, Qnil);
7538 if (status == MagickFalse) goto imagemagick_error;
7539
7540 /* If width and/or height is set in the display spec assume we want
7541 to scale to those values. if either h or w is unspecified, the
7542 unspecified should be calculated from the specified to preserve
7543 aspect ratio. */
7544
7545 value = image_spec_value (img->spec, QCwidth, NULL);
7546 desired_width = (INTEGERP (value) ? XFASTINT (value) : -1);
7547 value = image_spec_value (img->spec, QCheight, NULL);
7548 desired_height = (INTEGERP (value) ? XFASTINT (value) : -1);
7549
7550 height = MagickGetImageHeight (image_wand);
7551 width = MagickGetImageWidth (image_wand);
7552
7553 if(desired_width != -1 && desired_height == -1)
7554 {
7555 /* w known, calculate h. */
7556 desired_height = (double) desired_width / width * height;
7557 }
7558 if(desired_width == -1 && desired_height != -1)
7559 {
7560 /* h known, calculate w. */
7561 desired_width = (double) desired_height / height * width;
7562 }
7563 if(desired_width != -1 && desired_height != -1)
7564 {
7565 status = MagickScaleImage (image_wand, desired_width, desired_height);
7566 if (status == MagickFalse)
7567 {
7568 image_error ("Imagemagick scale failed", Qnil, Qnil);
7569 goto imagemagick_error;
7570 }
7571 }
7572
7573
7574 /* crop behaves similar to image slicing in Emacs but is more memory
7575 efficient. */
7576 crop = image_spec_value (img->spec, QCcrop, NULL);
7577
7578 if (CONSP (crop) && INTEGERP (XCAR (crop)))
7579 {
7580 /* After some testing, it seems MagickCropImage is the fastest
7581 crop function in ImageMagick. This crop function seems to do
7582 less copying than the alternatives, but it still reads the
7583 entire image into memory before croping, which is aparently
7584 difficult to avoid when using imagemagick. */
7585
7586 int w, h, x, y;
7587 w = XFASTINT (XCAR (crop));
7588 crop = XCDR (crop);
7589 if (CONSP (crop) && INTEGERP (XCAR (crop)))
7590 {
7591 h = XFASTINT (XCAR (crop));
7592 crop = XCDR (crop);
7593 if (CONSP (crop) && INTEGERP (XCAR (crop)))
7594 {
7595 x = XFASTINT (XCAR (crop));
7596 crop = XCDR (crop);
7597 if (CONSP (crop) && INTEGERP (XCAR (crop)))
7598 {
7599 y = XFASTINT (XCAR (crop));
7600 MagickCropImage (image_wand, w, h, x, y);
7601 }
7602 }
7603 }
7604 }
7605
7606 /* Furthermore :rotation. we need background color and angle for
7607 rotation. */
7608 /*
7609 TODO background handling for rotation specified_bg =
7610 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
7611 (specified_bg). */
7612 value = image_spec_value (img->spec, QCrotation, NULL);
7613 if (FLOATP (value))
7614 {
7615 PixelWand* background = NewPixelWand ();
7616 PixelSetColor (background, "#ffffff");/*TODO remove hardcode*/
7617
7618 rotation = extract_float (value);
7619
7620 status = MagickRotateImage (image_wand, background, rotation);
7621 DestroyPixelWand (background);
7622 if (status == MagickFalse)
7623 {
7624 image_error ("Imagemagick image rotate failed", Qnil, Qnil);
7625 goto imagemagick_error;
7626 }
7627 }
7628
7629 /* Finaly we are done manipulating the image, figure out resulting
7630 width, height, and then transfer ownerwship to Emacs. */
7631 height = MagickGetImageHeight (image_wand);
7632 width = MagickGetImageWidth (image_wand);
7633 if (status == MagickFalse)
7634 {
7635 image_error ("Imagemagick image get size failed", Qnil, Qnil);
7636 goto imagemagick_error;
7637 }
7638
7639 if (! check_image_size (f, width, height))
7640 {
7641 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
7642 goto imagemagick_error;
7643 }
7644
7645 /* We can now get a valid pixel buffer from the imagemagick file, if all
7646 went ok. */
7647
7648 init_color_table ();
7649 imagemagick_rendermethod = (INTEGERP (Vimagemagick_render_type)
7650 ? XFASTINT (Vimagemagick_render_type) : 0);
7651 if (imagemagick_rendermethod == 0)
7652 {
7653 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7654 if (!x_create_x_image_and_pixmap (f, width, height, 0,
7655 &ximg, &img->pixmap))
7656 {
7657 image_error("Imagemagick X bitmap allocation failure", Qnil, Qnil);
7658 goto imagemagick_error;
7659 }
7660
7661 /* Copy imagegmagick image to x with primitive yet robust pixel
7662 pusher loop. This has been tested a lot with many different
7663 images. */
7664
7665 /* Copy pixels from the imagemagick image structure to the x image map. */
7666 iterator = NewPixelIterator (image_wand);
7667 if (iterator == (PixelIterator *) NULL)
7668 {
7669 image_error ("Imagemagick pixel iterator creation failed",
7670 Qnil, Qnil);
7671 goto imagemagick_error;
7672 }
7673
7674 for (y = 0; y < (long) MagickGetImageHeight (image_wand); y++)
7675 {
7676 pixels = PixelGetNextIteratorRow (iterator, &width);
7677 if (pixels == (PixelWand **) NULL)
7678 break;
7679 for (x = 0; x < (long) width; x++)
7680 {
7681 PixelGetMagickColor (pixels[x], &pixel);
7682 XPutPixel (ximg, x, y,
7683 lookup_rgb_color (f,
7684 pixel.red,
7685 pixel.green,
7686 pixel.blue));
7687 }
7688 }
7689 DestroyPixelIterator (iterator);
7690 }
7691
7692 if (imagemagick_rendermethod == 1)
7693 {
7694 /* Magicexportimage is normaly faster than pixelpushing. This
7695 method is also well tested. Some aspects of this method are
7696 ad-hoc and needs to be more researched. */
7697 int imagedepth = 24;/*MagickGetImageDepth(image_wand);*/
7698 char* exportdepth = imagedepth <= 8 ? "I" : "BGRP";/*"RGBP";*/
7699 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7700 if (!x_create_x_image_and_pixmap (f, width, height, imagedepth,
7701 &ximg, &img->pixmap))
7702 {
7703 image_error("Imagemagick X bitmap allocation failure", Qnil, Qnil);
7704 goto imagemagick_error;
7705 }
7706
7707
7708 /* Oddly, the below code doesnt seem to work:*/
7709 /* switch(ximg->bitmap_unit){ */
7710 /* case 8: */
7711 /* pixelwidth=CharPixel; */
7712 /* break; */
7713 /* case 16: */
7714 /* pixelwidth=ShortPixel; */
7715 /* break; */
7716 /* case 32: */
7717 /* pixelwidth=LongPixel; */
7718 /* break; */
7719 /* } */
7720 /*
7721 Here im just guessing the format of the bitmap.
7722 happens to work fine for:
7723 - bw djvu images
7724 on rgb display.
7725 seems about 3 times as fast as pixel pushing(not carefully measured)
7726 */
7727 pixelwidth = CharPixel;/*??? TODO figure out*/
7728 #ifdef HAVE_MAGICKEXPORTIMAGEPIXELS
7729 MagickExportImagePixels (image_wand,
7730 0, 0,
7731 width, height,
7732 exportdepth,
7733 pixelwidth,
7734 /*&(img->pixmap));*/
7735 ximg->data);
7736 #else
7737 image_error ("You dont have MagickExportImagePixels, upgrade ImageMagick!",
7738 Qnil, Qnil);
7739 #endif
7740 }
7741
7742
7743 #ifdef COLOR_TABLE_SUPPORT
7744 /* Remember colors allocated for this image. */
7745 img->colors = colors_in_color_table (&img->ncolors);
7746 free_color_table ();
7747 #endif /* COLOR_TABLE_SUPPORT */
7748
7749
7750 img->width = width;
7751 img->height = height;
7752
7753 /* Put the image into the pixmap, then free the X image and its
7754 buffer. */
7755 x_put_x_image (f, ximg, img->pixmap, width, height);
7756 x_destroy_x_image (ximg);
7757
7758
7759 /* Final cleanup. image_wand should be the only resource left. */
7760 DestroyMagickWand (image_wand);
7761
7762 return 1;
7763
7764 imagemagick_error:
7765 /* TODO more cleanup. */
7766 image_error ("Error parsing IMAGEMAGICK image `%s'", img->spec, Qnil);
7767 return 0;
7768 }
7769
7770
7771 /* Load IMAGEMAGICK image IMG for use on frame F. Value is non-zero if
7772 successful. this function will go into the imagemagick_type structure, and
7773 the prototype thus needs to be compatible with that structure. */
7774
7775 static int
7776 imagemagick_load (struct frame *f,
7777 struct image *img)
7778 {
7779 int success_p = 0;
7780 Lisp_Object file_name;
7781
7782 /* If IMG->spec specifies a file name, create a non-file spec from it. */
7783 file_name = image_spec_value (img->spec, QCfile, NULL);
7784 if (STRINGP (file_name))
7785 {
7786 Lisp_Object file;
7787
7788 file = x_find_image_file (file_name);
7789 if (!STRINGP (file))
7790 {
7791 image_error ("Cannot find image file `%s'", file_name, Qnil);
7792 return 0;
7793 }
7794 success_p = imagemagick_load_image (f, img, 0, 0, SDATA (file));
7795 }
7796 /* Else its not a file, its a lisp object. Load the image from a
7797 lisp object rather than a file. */
7798 else
7799 {
7800 Lisp_Object data;
7801
7802 data = image_spec_value (img->spec, QCdata, NULL);
7803 if (!STRINGP (data))
7804 {
7805 image_error ("Invalid image data `%s'", data, Qnil);
7806 return 0;
7807 }
7808 success_p = imagemagick_load_image (f, img, SDATA (data),
7809 SBYTES (data), NULL);
7810 }
7811
7812 return success_p;
7813 }
7814
7815 /* Structure describing the image type `imagemagick'. Its the same
7816 type of structure defined for all image formats, handled by Emacs
7817 image functions. See struct image_type in dispextern.h. */
7818
7819 static struct image_type imagemagick_type =
7820 {
7821 /* An identifier showing that this is an image structure for the
7822 IMAGEMAGICK format. */
7823 &Qimagemagick,
7824 /* Handle to a function that can be used to identify a IMAGEMAGICK
7825 file. */
7826 imagemagick_image_p,
7827 /* Handle to function used to load a IMAGEMAGICK file. */
7828 imagemagick_load,
7829 /* Handle to function to free resources for IMAGEMAGICK. */
7830 imagemagick_clear_image,
7831 /* An internal field to link to the next image type in a list of
7832 image types, will be filled in when registering the format. */
7833 NULL
7834 };
7835
7836
7837
7838
7839 DEFUN ("imagemagick-types", Fimagemagick_types, Simagemagick_types, 0, 0, 0,
7840 doc: /* Return image file types supported by ImageMagick.
7841 Since ImageMagick recognizes a lot of file-types that clash with Emacs,
7842 such as .c, we want to be able to alter the list at the lisp level. */)
7843 (void)
7844 {
7845 Lisp_Object typelist = Qnil;
7846 unsigned long numf;
7847 ExceptionInfo ex;
7848 char **imtypes = GetMagickList ("*", &numf, &ex);
7849 int i;
7850 Lisp_Object Qimagemagicktype;
7851 for (i = 0; i < numf; i++)
7852 {
7853 Qimagemagicktype = intern (imtypes[i]);
7854 typelist = Fcons (Qimagemagicktype, typelist);
7855 }
7856 return typelist;
7857 }
7858
7859 #endif /* defined (HAVE_IMAGEMAGICK) */
7860
7861
7862 \f
7863 /***********************************************************************
7864 SVG
7865 ***********************************************************************/
7866
7867 #if defined (HAVE_RSVG)
7868
7869 /* Function prototypes. */
7870
7871 static int svg_image_p (Lisp_Object object);
7872 static int svg_load (struct frame *f, struct image *img);
7873
7874 static int svg_load_image (struct frame *, struct image *,
7875 unsigned char *, unsigned int);
7876
7877 /* The symbol `svg' identifying images of this type. */
7878
7879 Lisp_Object Qsvg;
7880
7881 /* Indices of image specification fields in svg_format, below. */
7882
7883 enum svg_keyword_index
7884 {
7885 SVG_TYPE,
7886 SVG_DATA,
7887 SVG_FILE,
7888 SVG_ASCENT,
7889 SVG_MARGIN,
7890 SVG_RELIEF,
7891 SVG_ALGORITHM,
7892 SVG_HEURISTIC_MASK,
7893 SVG_MASK,
7894 SVG_BACKGROUND,
7895 SVG_LAST
7896 };
7897
7898 /* Vector of image_keyword structures describing the format
7899 of valid user-defined image specifications. */
7900
7901 static const struct image_keyword svg_format[SVG_LAST] =
7902 {
7903 {":type", IMAGE_SYMBOL_VALUE, 1},
7904 {":data", IMAGE_STRING_VALUE, 0},
7905 {":file", IMAGE_STRING_VALUE, 0},
7906 {":ascent", IMAGE_ASCENT_VALUE, 0},
7907 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7908 {":relief", IMAGE_INTEGER_VALUE, 0},
7909 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7910 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7911 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7912 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
7913 };
7914
7915 /* Structure describing the image type `svg'. Its the same type of
7916 structure defined for all image formats, handled by emacs image
7917 functions. See struct image_type in dispextern.h. */
7918
7919 static struct image_type svg_type =
7920 {
7921 /* An identifier showing that this is an image structure for the SVG format. */
7922 &Qsvg,
7923 /* Handle to a function that can be used to identify a SVG file. */
7924 svg_image_p,
7925 /* Handle to function used to load a SVG file. */
7926 svg_load,
7927 /* Handle to function to free sresources for SVG. */
7928 x_clear_image,
7929 /* An internal field to link to the next image type in a list of
7930 image types, will be filled in when registering the format. */
7931 NULL
7932 };
7933
7934
7935 /* Return non-zero if OBJECT is a valid SVG image specification. Do
7936 this by calling parse_image_spec and supplying the keywords that
7937 identify the SVG format. */
7938
7939 static int
7940 svg_image_p (Lisp_Object object)
7941 {
7942 struct image_keyword fmt[SVG_LAST];
7943 memcpy (fmt, svg_format, sizeof fmt);
7944
7945 if (!parse_image_spec (object, fmt, SVG_LAST, Qsvg))
7946 return 0;
7947
7948 /* Must specify either the :data or :file keyword. */
7949 return fmt[SVG_FILE].count + fmt[SVG_DATA].count == 1;
7950 }
7951
7952 #include <librsvg/rsvg.h>
7953
7954 #ifdef HAVE_NTGUI
7955
7956 /* SVG library functions. */
7957 DEF_IMGLIB_FN (rsvg_handle_new);
7958 DEF_IMGLIB_FN (rsvg_handle_get_dimensions);
7959 DEF_IMGLIB_FN (rsvg_handle_write);
7960 DEF_IMGLIB_FN (rsvg_handle_close);
7961 DEF_IMGLIB_FN (rsvg_handle_get_pixbuf);
7962 DEF_IMGLIB_FN (rsvg_handle_free);
7963
7964 DEF_IMGLIB_FN (gdk_pixbuf_get_width);
7965 DEF_IMGLIB_FN (gdk_pixbuf_get_height);
7966 DEF_IMGLIB_FN (gdk_pixbuf_get_pixels);
7967 DEF_IMGLIB_FN (gdk_pixbuf_get_rowstride);
7968 DEF_IMGLIB_FN (gdk_pixbuf_get_colorspace);
7969 DEF_IMGLIB_FN (gdk_pixbuf_get_n_channels);
7970 DEF_IMGLIB_FN (gdk_pixbuf_get_has_alpha);
7971 DEF_IMGLIB_FN (gdk_pixbuf_get_bits_per_sample);
7972
7973 DEF_IMGLIB_FN (g_type_init);
7974 DEF_IMGLIB_FN (g_object_unref);
7975 DEF_IMGLIB_FN (g_error_free);
7976
7977 Lisp_Object Qgdk_pixbuf, Qglib, Qgobject;
7978
7979 static int
7980 init_svg_functions (Lisp_Object libraries)
7981 {
7982 HMODULE library, gdklib, glib, gobject;
7983
7984 if (!(glib = w32_delayed_load (libraries, Qglib))
7985 || !(gobject = w32_delayed_load (libraries, Qgobject))
7986 || !(gdklib = w32_delayed_load (libraries, Qgdk_pixbuf))
7987 || !(library = w32_delayed_load (libraries, Qsvg)))
7988 return 0;
7989
7990 LOAD_IMGLIB_FN (library, rsvg_handle_new);
7991 LOAD_IMGLIB_FN (library, rsvg_handle_get_dimensions);
7992 LOAD_IMGLIB_FN (library, rsvg_handle_write);
7993 LOAD_IMGLIB_FN (library, rsvg_handle_close);
7994 LOAD_IMGLIB_FN (library, rsvg_handle_get_pixbuf);
7995 LOAD_IMGLIB_FN (library, rsvg_handle_free);
7996
7997 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_width);
7998 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_height);
7999 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_pixels);
8000 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_rowstride);
8001 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_colorspace);
8002 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_n_channels);
8003 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_has_alpha);
8004 LOAD_IMGLIB_FN (gdklib, gdk_pixbuf_get_bits_per_sample);
8005
8006 LOAD_IMGLIB_FN (gobject, g_type_init);
8007 LOAD_IMGLIB_FN (gobject, g_object_unref);
8008 LOAD_IMGLIB_FN (glib, g_error_free);
8009
8010 return 1;
8011 }
8012
8013 #else
8014 /* The following aliases for library functions allow dynamic loading
8015 to be used on some platforms. */
8016 #define fn_rsvg_handle_new rsvg_handle_new
8017 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8018 #define fn_rsvg_handle_write rsvg_handle_write
8019 #define fn_rsvg_handle_close rsvg_handle_close
8020 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8021 #define fn_rsvg_handle_free rsvg_handle_free
8022
8023 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8024 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8025 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8026 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8027 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8028 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8029 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8030 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8031
8032 #define fn_g_type_init g_type_init
8033 #define fn_g_object_unref g_object_unref
8034 #define fn_g_error_free g_error_free
8035 #endif /* !HAVE_NTGUI */
8036
8037 /* Load SVG image IMG for use on frame F. Value is non-zero if
8038 successful. this function will go into the svg_type structure, and
8039 the prototype thus needs to be compatible with that structure. */
8040
8041 static int
8042 svg_load (struct frame *f, struct image *img)
8043 {
8044 int success_p = 0;
8045 Lisp_Object file_name;
8046
8047 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8048 file_name = image_spec_value (img->spec, QCfile, NULL);
8049 if (STRINGP (file_name))
8050 {
8051 Lisp_Object file;
8052 unsigned char *contents;
8053 int size;
8054
8055 file = x_find_image_file (file_name);
8056 if (!STRINGP (file))
8057 {
8058 image_error ("Cannot find image file `%s'", file_name, Qnil);
8059 return 0;
8060 }
8061
8062 /* Read the entire file into memory. */
8063 contents = slurp_file (SDATA (file), &size);
8064 if (contents == NULL)
8065 {
8066 image_error ("Error loading SVG image `%s'", img->spec, Qnil);
8067 return 0;
8068 }
8069 /* If the file was slurped into memory properly, parse it. */
8070 success_p = svg_load_image (f, img, contents, size);
8071 xfree (contents);
8072 }
8073 /* Else its not a file, its a lisp object. Load the image from a
8074 lisp object rather than a file. */
8075 else
8076 {
8077 Lisp_Object data;
8078
8079 data = image_spec_value (img->spec, QCdata, NULL);
8080 if (!STRINGP (data))
8081 {
8082 image_error ("Invalid image data `%s'", data, Qnil);
8083 return 0;
8084 }
8085 success_p = svg_load_image (f, img, SDATA (data), SBYTES (data));
8086 }
8087
8088 return success_p;
8089 }
8090
8091 /* svg_load_image is a helper function for svg_load, which does the
8092 actual loading given contents and size, apart from frame and image
8093 structures, passed from svg_load.
8094
8095 Uses librsvg to do most of the image processing.
8096
8097 Returns non-zero when successful. */
8098 static int
8099 svg_load_image (struct frame *f, /* Pointer to emacs frame structure. */
8100 struct image *img, /* Pointer to emacs image structure. */
8101 unsigned char *contents, /* String containing the SVG XML data to be parsed. */
8102 unsigned int size) /* Size of data in bytes. */
8103 {
8104 RsvgHandle *rsvg_handle;
8105 RsvgDimensionData dimension_data;
8106 GError *error = NULL;
8107 GdkPixbuf *pixbuf;
8108 int width;
8109 int height;
8110 const guint8 *pixels;
8111 int rowstride;
8112 XImagePtr ximg;
8113 Lisp_Object specified_bg;
8114 XColor background;
8115 int x;
8116 int y;
8117
8118 /* g_type_init is a glib function that must be called prior to using
8119 gnome type library functions. */
8120 fn_g_type_init ();
8121 /* Make a handle to a new rsvg object. */
8122 rsvg_handle = (RsvgHandle *) fn_rsvg_handle_new ();
8123
8124 /* Parse the contents argument and fill in the rsvg_handle. */
8125 fn_rsvg_handle_write (rsvg_handle, contents, size, &error);
8126 if (error) goto rsvg_error;
8127
8128 /* The parsing is complete, rsvg_handle is ready to used, close it
8129 for further writes. */
8130 fn_rsvg_handle_close (rsvg_handle, &error);
8131 if (error) goto rsvg_error;
8132
8133 fn_rsvg_handle_get_dimensions (rsvg_handle, &dimension_data);
8134 if (! check_image_size (f, dimension_data.width, dimension_data.height))
8135 {
8136 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
8137 goto rsvg_error;
8138 }
8139
8140 /* We can now get a valid pixel buffer from the svg file, if all
8141 went ok. */
8142 pixbuf = (GdkPixbuf *) fn_rsvg_handle_get_pixbuf (rsvg_handle);
8143 if (!pixbuf) goto rsvg_error;
8144 fn_g_object_unref (rsvg_handle);
8145
8146 /* Extract some meta data from the svg handle. */
8147 width = fn_gdk_pixbuf_get_width (pixbuf);
8148 height = fn_gdk_pixbuf_get_height (pixbuf);
8149 pixels = (const guint8 *) fn_gdk_pixbuf_get_pixels (pixbuf);
8150 rowstride = fn_gdk_pixbuf_get_rowstride (pixbuf);
8151
8152 /* Validate the svg meta data. */
8153 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf) == GDK_COLORSPACE_RGB);
8154 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf) == 4);
8155 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf));
8156 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf) == 8);
8157
8158 /* Try to create a x pixmap to hold the svg pixmap. */
8159 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
8160 {
8161 fn_g_object_unref (pixbuf);
8162 return 0;
8163 }
8164
8165 init_color_table ();
8166
8167 /* Handle alpha channel by combining the image with a background
8168 color. */
8169 specified_bg = image_spec_value (img->spec, QCbackground, NULL);
8170 if (!STRINGP (specified_bg)
8171 || !x_defined_color (f, SDATA (specified_bg), &background, 0))
8172 {
8173 #ifndef HAVE_NS
8174 background.pixel = FRAME_BACKGROUND_PIXEL (f);
8175 x_query_color (f, &background);
8176 #else
8177 ns_query_color (FRAME_BACKGROUND_COLOR (f), &background, 1);
8178 #endif
8179 }
8180
8181 /* SVG pixmaps specify transparency in the last byte, so right
8182 shift 8 bits to get rid of it, since emacs doesn't support
8183 transparency. */
8184 background.red >>= 8;
8185 background.green >>= 8;
8186 background.blue >>= 8;
8187
8188 /* This loop handles opacity values, since Emacs assumes
8189 non-transparent images. Each pixel must be "flattened" by
8190 calculating the resulting color, given the transparency of the
8191 pixel, and the image background color. */
8192 for (y = 0; y < height; ++y)
8193 {
8194 for (x = 0; x < width; ++x)
8195 {
8196 unsigned red;
8197 unsigned green;
8198 unsigned blue;
8199 unsigned opacity;
8200
8201 red = *pixels++;
8202 green = *pixels++;
8203 blue = *pixels++;
8204 opacity = *pixels++;
8205
8206 red = ((red * opacity)
8207 + (background.red * ((1 << 8) - opacity)));
8208 green = ((green * opacity)
8209 + (background.green * ((1 << 8) - opacity)));
8210 blue = ((blue * opacity)
8211 + (background.blue * ((1 << 8) - opacity)));
8212
8213 XPutPixel (ximg, x, y, lookup_rgb_color (f, red, green, blue));
8214 }
8215
8216 pixels += rowstride - 4 * width;
8217 }
8218
8219 #ifdef COLOR_TABLE_SUPPORT
8220 /* Remember colors allocated for this image. */
8221 img->colors = colors_in_color_table (&img->ncolors);
8222 free_color_table ();
8223 #endif /* COLOR_TABLE_SUPPORT */
8224
8225 fn_g_object_unref (pixbuf);
8226
8227 img->width = width;
8228 img->height = height;
8229
8230 /* Maybe fill in the background field while we have ximg handy.
8231 Casting avoids a GCC warning. */
8232 IMAGE_BACKGROUND (img, f, (XImagePtr_or_DC)ximg);
8233
8234 /* Put the image into the pixmap, then free the X image and its
8235 buffer. */
8236 x_put_x_image (f, ximg, img->pixmap, width, height);
8237 x_destroy_x_image (ximg);
8238
8239 return 1;
8240
8241 rsvg_error:
8242 fn_g_object_unref (rsvg_handle);
8243 /* FIXME: Use error->message so the user knows what is the actual
8244 problem with the image. */
8245 image_error ("Error parsing SVG image `%s'", img->spec, Qnil);
8246 fn_g_error_free (error);
8247 return 0;
8248 }
8249
8250 #endif /* defined (HAVE_RSVG) */
8251
8252
8253
8254 \f
8255 /***********************************************************************
8256 Ghostscript
8257 ***********************************************************************/
8258
8259 #ifdef HAVE_X_WINDOWS
8260 #define HAVE_GHOSTSCRIPT 1
8261 #endif /* HAVE_X_WINDOWS */
8262
8263 #ifdef HAVE_GHOSTSCRIPT
8264
8265 static int gs_image_p (Lisp_Object object);
8266 static int gs_load (struct frame *f, struct image *img);
8267 static void gs_clear_image (struct frame *f, struct image *img);
8268
8269 /* Keyword symbols. */
8270
8271 Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
8272
8273 /* Indices of image specification fields in gs_format, below. */
8274
8275 enum gs_keyword_index
8276 {
8277 GS_TYPE,
8278 GS_PT_WIDTH,
8279 GS_PT_HEIGHT,
8280 GS_FILE,
8281 GS_LOADER,
8282 GS_BOUNDING_BOX,
8283 GS_ASCENT,
8284 GS_MARGIN,
8285 GS_RELIEF,
8286 GS_ALGORITHM,
8287 GS_HEURISTIC_MASK,
8288 GS_MASK,
8289 GS_BACKGROUND,
8290 GS_LAST
8291 };
8292
8293 /* Vector of image_keyword structures describing the format
8294 of valid user-defined image specifications. */
8295
8296 static const struct image_keyword gs_format[GS_LAST] =
8297 {
8298 {":type", IMAGE_SYMBOL_VALUE, 1},
8299 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
8300 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
8301 {":file", IMAGE_STRING_VALUE, 1},
8302 {":loader", IMAGE_FUNCTION_VALUE, 0},
8303 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
8304 {":ascent", IMAGE_ASCENT_VALUE, 0},
8305 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8306 {":relief", IMAGE_INTEGER_VALUE, 0},
8307 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8308 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8309 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8310 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
8311 };
8312
8313 /* Structure describing the image type `ghostscript'. */
8314
8315 static struct image_type gs_type =
8316 {
8317 &Qpostscript,
8318 gs_image_p,
8319 gs_load,
8320 gs_clear_image,
8321 NULL
8322 };
8323
8324
8325 /* Free X resources of Ghostscript image IMG which is used on frame F. */
8326
8327 static void
8328 gs_clear_image (struct frame *f, struct image *img)
8329 {
8330 /* IMG->data.ptr_val may contain a recorded colormap. */
8331 xfree (img->data.ptr_val);
8332 x_clear_image (f, img);
8333 }
8334
8335
8336 /* Return non-zero if OBJECT is a valid Ghostscript image
8337 specification. */
8338
8339 static int
8340 gs_image_p (Lisp_Object object)
8341 {
8342 struct image_keyword fmt[GS_LAST];
8343 Lisp_Object tem;
8344 int i;
8345
8346 memcpy (fmt, gs_format, sizeof fmt);
8347
8348 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
8349 return 0;
8350
8351 /* Bounding box must be a list or vector containing 4 integers. */
8352 tem = fmt[GS_BOUNDING_BOX].value;
8353 if (CONSP (tem))
8354 {
8355 for (i = 0; i < 4; ++i, tem = XCDR (tem))
8356 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
8357 return 0;
8358 if (!NILP (tem))
8359 return 0;
8360 }
8361 else if (VECTORP (tem))
8362 {
8363 if (XVECTOR (tem)->size != 4)
8364 return 0;
8365 for (i = 0; i < 4; ++i)
8366 if (!INTEGERP (XVECTOR (tem)->contents[i]))
8367 return 0;
8368 }
8369 else
8370 return 0;
8371
8372 return 1;
8373 }
8374
8375
8376 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
8377 if successful. */
8378
8379 static int
8380 gs_load (struct frame *f, struct image *img)
8381 {
8382 char buffer[100];
8383 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
8384 Lisp_Object frame;
8385 double in_width, in_height;
8386 Lisp_Object pixel_colors = Qnil;
8387
8388 /* Compute pixel size of pixmap needed from the given size in the
8389 image specification. Sizes in the specification are in pt. 1 pt
8390 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8391 info. */
8392 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
8393 in_width = INTEGERP (pt_width) ? XFASTINT (pt_width) / 72.0 : 0;
8394 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
8395 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
8396 in_height = INTEGERP (pt_height) ? XFASTINT (pt_height) / 72.0 : 0;
8397 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
8398
8399 if (!check_image_size (f, img->width, img->height))
8400 {
8401 image_error ("Invalid image size (see `max-image-size')", Qnil, Qnil);
8402 return 0;
8403 }
8404
8405 /* Create the pixmap. */
8406 xassert (img->pixmap == NO_PIXMAP);
8407
8408 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8409 BLOCK_INPUT;
8410 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8411 img->width, img->height,
8412 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
8413 UNBLOCK_INPUT;
8414
8415 if (!img->pixmap)
8416 {
8417 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
8418 return 0;
8419 }
8420
8421 /* Call the loader to fill the pixmap. It returns a process object
8422 if successful. We do not record_unwind_protect here because
8423 other places in redisplay like calling window scroll functions
8424 don't either. Let the Lisp loader use `unwind-protect' instead. */
8425 sprintf (buffer, "%lu %lu",
8426 (unsigned long) FRAME_X_WINDOW (f),
8427 (unsigned long) img->pixmap);
8428 window_and_pixmap_id = build_string (buffer);
8429
8430 sprintf (buffer, "%lu %lu",
8431 FRAME_FOREGROUND_PIXEL (f),
8432 FRAME_BACKGROUND_PIXEL (f));
8433 pixel_colors = build_string (buffer);
8434
8435 XSETFRAME (frame, f);
8436 loader = image_spec_value (img->spec, QCloader, NULL);
8437 if (NILP (loader))
8438 loader = intern ("gs-load-image");
8439
8440 img->data.lisp_val = call6 (loader, frame, img->spec,
8441 make_number (img->width),
8442 make_number (img->height),
8443 window_and_pixmap_id,
8444 pixel_colors);
8445 return PROCESSP (img->data.lisp_val);
8446 }
8447
8448
8449 /* Kill the Ghostscript process that was started to fill PIXMAP on
8450 frame F. Called from XTread_socket when receiving an event
8451 telling Emacs that Ghostscript has finished drawing. */
8452
8453 void
8454 x_kill_gs_process (Pixmap pixmap, struct frame *f)
8455 {
8456 struct image_cache *c = FRAME_IMAGE_CACHE (f);
8457 int class, i;
8458 struct image *img;
8459
8460 /* Find the image containing PIXMAP. */
8461 for (i = 0; i < c->used; ++i)
8462 if (c->images[i]->pixmap == pixmap)
8463 break;
8464
8465 /* Should someone in between have cleared the image cache, for
8466 instance, give up. */
8467 if (i == c->used)
8468 return;
8469
8470 /* Kill the GS process. We should have found PIXMAP in the image
8471 cache and its image should contain a process object. */
8472 img = c->images[i];
8473 xassert (PROCESSP (img->data.lisp_val));
8474 Fkill_process (img->data.lisp_val, Qnil);
8475 img->data.lisp_val = Qnil;
8476
8477 #if defined (HAVE_X_WINDOWS)
8478
8479 /* On displays with a mutable colormap, figure out the colors
8480 allocated for the image by looking at the pixels of an XImage for
8481 img->pixmap. */
8482 class = FRAME_X_VISUAL (f)->class;
8483 if (class != StaticColor && class != StaticGray && class != TrueColor)
8484 {
8485 XImagePtr ximg;
8486
8487 BLOCK_INPUT;
8488
8489 /* Try to get an XImage for img->pixmep. */
8490 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
8491 0, 0, img->width, img->height, ~0, ZPixmap);
8492 if (ximg)
8493 {
8494 int x, y;
8495
8496 /* Initialize the color table. */
8497 init_color_table ();
8498
8499 /* For each pixel of the image, look its color up in the
8500 color table. After having done so, the color table will
8501 contain an entry for each color used by the image. */
8502 for (y = 0; y < img->height; ++y)
8503 for (x = 0; x < img->width; ++x)
8504 {
8505 unsigned long pixel = XGetPixel (ximg, x, y);
8506 lookup_pixel_color (f, pixel);
8507 }
8508
8509 /* Record colors in the image. Free color table and XImage. */
8510 #ifdef COLOR_TABLE_SUPPORT
8511 img->colors = colors_in_color_table (&img->ncolors);
8512 free_color_table ();
8513 #endif
8514 XDestroyImage (ximg);
8515
8516 #if 0 /* This doesn't seem to be the case. If we free the colors
8517 here, we get a BadAccess later in x_clear_image when
8518 freeing the colors. */
8519 /* We have allocated colors once, but Ghostscript has also
8520 allocated colors on behalf of us. So, to get the
8521 reference counts right, free them once. */
8522 if (img->ncolors)
8523 x_free_colors (f, img->colors, img->ncolors);
8524 #endif
8525 }
8526 else
8527 image_error ("Cannot get X image of `%s'; colors will not be freed",
8528 img->spec, Qnil);
8529
8530 UNBLOCK_INPUT;
8531 }
8532 #endif /* HAVE_X_WINDOWS */
8533
8534 /* Now that we have the pixmap, compute mask and transform the
8535 image if requested. */
8536 BLOCK_INPUT;
8537 postprocess_image (f, img);
8538 UNBLOCK_INPUT;
8539 }
8540
8541 #endif /* HAVE_GHOSTSCRIPT */
8542
8543 \f
8544 /***********************************************************************
8545 Tests
8546 ***********************************************************************/
8547
8548 #if GLYPH_DEBUG
8549
8550 DEFUN ("imagep", Fimagep, Simagep, 1, 1, 0,
8551 doc: /* Value is non-nil if SPEC is a valid image specification. */)
8552 (Lisp_Object spec)
8553 {
8554 return valid_image_p (spec) ? Qt : Qnil;
8555 }
8556
8557
8558 DEFUN ("lookup-image", Flookup_image, Slookup_image, 1, 1, 0, "")
8559 (Lisp_Object spec)
8560 {
8561 int id = -1;
8562
8563 if (valid_image_p (spec))
8564 id = lookup_image (SELECTED_FRAME (), spec);
8565
8566 debug_print (spec);
8567 return make_number (id);
8568 }
8569
8570 #endif /* GLYPH_DEBUG != 0 */
8571
8572
8573 /***********************************************************************
8574 Initialization
8575 ***********************************************************************/
8576
8577 #ifdef HAVE_NTGUI
8578 /* Image types that rely on external libraries are loaded dynamically
8579 if the library is available. */
8580 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8581 define_image_type (image_type, init_lib_fn (libraries))
8582 #else
8583 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8584 define_image_type (image_type, 1)
8585 #endif /* HAVE_NTGUI */
8586
8587 DEFUN ("init-image-library", Finit_image_library, Sinit_image_library, 2, 2, 0,
8588 doc: /* Initialize image library implementing image type TYPE.
8589 Return non-nil if TYPE is a supported image type.
8590
8591 Image types pbm and xbm are prebuilt; other types are loaded here.
8592 Libraries to load are specified in alist LIBRARIES (usually, the value
8593 of `dynamic-library-alist', which see). */)
8594 (Lisp_Object type, Lisp_Object libraries)
8595 {
8596 Lisp_Object tested;
8597
8598 /* Don't try to reload the library. */
8599 tested = Fassq (type, Vimage_type_cache);
8600 if (CONSP (tested))
8601 return XCDR (tested);
8602
8603 #if defined (HAVE_XPM) || defined (HAVE_NS)
8604 if (EQ (type, Qxpm))
8605 return CHECK_LIB_AVAILABLE (&xpm_type, init_xpm_functions, libraries);
8606 #endif
8607
8608 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8609 if (EQ (type, Qjpeg))
8610 return CHECK_LIB_AVAILABLE (&jpeg_type, init_jpeg_functions, libraries);
8611 #endif
8612
8613 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8614 if (EQ (type, Qtiff))
8615 return CHECK_LIB_AVAILABLE (&tiff_type, init_tiff_functions, libraries);
8616 #endif
8617
8618 #if defined (HAVE_GIF) || defined (HAVE_NS)
8619 if (EQ (type, Qgif))
8620 return CHECK_LIB_AVAILABLE (&gif_type, init_gif_functions, libraries);
8621 #endif
8622
8623 #if defined (HAVE_PNG) || defined (HAVE_NS)
8624 if (EQ (type, Qpng))
8625 return CHECK_LIB_AVAILABLE (&png_type, init_png_functions, libraries);
8626 #endif
8627
8628 #if defined (HAVE_RSVG)
8629 if (EQ (type, Qsvg))
8630 return CHECK_LIB_AVAILABLE (&svg_type, init_svg_functions, libraries);
8631 #endif
8632
8633 #if defined (HAVE_IMAGEMAGICK)
8634 if (EQ (type, Qimagemagick))
8635 {
8636 /* MagickWandGenesis() initializes the imagemagick library. */
8637 MagickWandGenesis ();
8638 return CHECK_LIB_AVAILABLE (&imagemagick_type, init_imagemagick_functions,
8639 libraries);
8640 }
8641 #endif
8642
8643 #ifdef HAVE_GHOSTSCRIPT
8644 if (EQ (type, Qpostscript))
8645 return CHECK_LIB_AVAILABLE (&gs_type, init_gs_functions, libraries);
8646 #endif
8647
8648 /* If the type is not recognized, avoid testing it ever again. */
8649 CACHE_IMAGE_TYPE (type, Qnil);
8650 return Qnil;
8651 }
8652
8653 void
8654 syms_of_image (void)
8655 {
8656 /* Initialize this only once, since that's what we do with Vimage_types
8657 and they are supposed to be in sync. Initializing here gives correct
8658 operation on GNU/Linux of calling dump-emacs after loading some images. */
8659 image_types = NULL;
8660
8661 /* Must be defined now becase we're going to update it below, while
8662 defining the supported image types. */
8663 DEFVAR_LISP ("image-types", &Vimage_types,
8664 doc: /* List of potentially supported image types.
8665 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
8666 To check whether it is really supported, use `image-type-available-p'. */);
8667 Vimage_types = Qnil;
8668
8669 DEFVAR_LISP ("max-image-size", &Vmax_image_size,
8670 doc: /* Maximum size of images.
8671 Emacs will not load an image into memory if its pixel width or
8672 pixel height exceeds this limit.
8673
8674 If the value is an integer, it directly specifies the maximum
8675 image height and width, measured in pixels. If it is a floating
8676 point number, it specifies the maximum image height and width
8677 as a ratio to the frame height and width. If the value is
8678 non-numeric, there is no explicit limit on the size of images. */);
8679 Vmax_image_size = make_float (MAX_IMAGE_SIZE);
8680
8681 Vimage_type_cache = Qnil;
8682 staticpro (&Vimage_type_cache);
8683
8684 Qpbm = intern_c_string ("pbm");
8685 staticpro (&Qpbm);
8686 ADD_IMAGE_TYPE (Qpbm);
8687
8688 Qxbm = intern_c_string ("xbm");
8689 staticpro (&Qxbm);
8690 ADD_IMAGE_TYPE (Qxbm);
8691
8692 define_image_type (&xbm_type, 1);
8693 define_image_type (&pbm_type, 1);
8694
8695 Qcount = intern_c_string ("count");
8696 staticpro (&Qcount);
8697 Qextension_data = intern_c_string ("extension-data");
8698 staticpro (&Qextension_data);
8699
8700 QCascent = intern_c_string (":ascent");
8701 staticpro (&QCascent);
8702 QCmargin = intern_c_string (":margin");
8703 staticpro (&QCmargin);
8704 QCrelief = intern_c_string (":relief");
8705 staticpro (&QCrelief);
8706 QCconversion = intern_c_string (":conversion");
8707 staticpro (&QCconversion);
8708 QCcolor_symbols = intern_c_string (":color-symbols");
8709 staticpro (&QCcolor_symbols);
8710 QCheuristic_mask = intern_c_string (":heuristic-mask");
8711 staticpro (&QCheuristic_mask);
8712 QCindex = intern_c_string (":index");
8713 staticpro (&QCindex);
8714 QCgeometry = intern_c_string (":geometry");
8715 staticpro (&QCgeometry);
8716 QCcrop = intern_c_string (":crop");
8717 staticpro (&QCcrop);
8718 QCrotation = intern_c_string (":rotation");
8719 staticpro (&QCrotation);
8720 QCmatrix = intern_c_string (":matrix");
8721 staticpro (&QCmatrix);
8722 QCcolor_adjustment = intern_c_string (":color-adjustment");
8723 staticpro (&QCcolor_adjustment);
8724 QCmask = intern_c_string (":mask");
8725 staticpro (&QCmask);
8726
8727 Qlaplace = intern_c_string ("laplace");
8728 staticpro (&Qlaplace);
8729 Qemboss = intern_c_string ("emboss");
8730 staticpro (&Qemboss);
8731 Qedge_detection = intern_c_string ("edge-detection");
8732 staticpro (&Qedge_detection);
8733 Qheuristic = intern_c_string ("heuristic");
8734 staticpro (&Qheuristic);
8735
8736 Qpostscript = intern_c_string ("postscript");
8737 staticpro (&Qpostscript);
8738 #ifdef HAVE_GHOSTSCRIPT
8739 ADD_IMAGE_TYPE (Qpostscript);
8740 QCloader = intern_c_string (":loader");
8741 staticpro (&QCloader);
8742 QCbounding_box = intern_c_string (":bounding-box");
8743 staticpro (&QCbounding_box);
8744 QCpt_width = intern_c_string (":pt-width");
8745 staticpro (&QCpt_width);
8746 QCpt_height = intern_c_string (":pt-height");
8747 staticpro (&QCpt_height);
8748 #endif /* HAVE_GHOSTSCRIPT */
8749
8750 #if defined (HAVE_XPM) || defined (HAVE_NS)
8751 Qxpm = intern_c_string ("xpm");
8752 staticpro (&Qxpm);
8753 ADD_IMAGE_TYPE (Qxpm);
8754 #endif
8755
8756 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8757 Qjpeg = intern_c_string ("jpeg");
8758 staticpro (&Qjpeg);
8759 ADD_IMAGE_TYPE (Qjpeg);
8760 #endif
8761
8762 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8763 Qtiff = intern_c_string ("tiff");
8764 staticpro (&Qtiff);
8765 ADD_IMAGE_TYPE (Qtiff);
8766 #endif
8767
8768 #if defined (HAVE_GIF) || defined (HAVE_NS)
8769 Qgif = intern_c_string ("gif");
8770 staticpro (&Qgif);
8771 ADD_IMAGE_TYPE (Qgif);
8772 #endif
8773
8774 #if defined (HAVE_PNG) || defined (HAVE_NS)
8775 Qpng = intern_c_string ("png");
8776 staticpro (&Qpng);
8777 ADD_IMAGE_TYPE (Qpng);
8778 #endif
8779
8780 #if defined (HAVE_IMAGEMAGICK)
8781 Qimagemagick = intern_c_string ("imagemagick");
8782 staticpro (&Qimagemagick);
8783 ADD_IMAGE_TYPE (Qimagemagick);
8784 #endif
8785
8786 #if defined (HAVE_RSVG)
8787 Qsvg = intern_c_string ("svg");
8788 staticpro (&Qsvg);
8789 ADD_IMAGE_TYPE (Qsvg);
8790 #ifdef HAVE_NTGUI
8791 /* Other libraries used directly by svg code. */
8792 Qgdk_pixbuf = intern_c_string ("gdk-pixbuf");
8793 staticpro (&Qgdk_pixbuf);
8794 Qglib = intern_c_string ("glib");
8795 staticpro (&Qglib);
8796 Qgobject = intern_c_string ("gobject");
8797 staticpro (&Qgobject);
8798 #endif /* HAVE_NTGUI */
8799 #endif /* HAVE_RSVG */
8800
8801 defsubr (&Sinit_image_library);
8802 #ifdef HAVE_IMAGEMAGICK
8803 defsubr (&Simagemagick_types);
8804 #endif
8805 defsubr (&Sclear_image_cache);
8806 defsubr (&Simage_flush);
8807 defsubr (&Simage_size);
8808 defsubr (&Simage_mask_p);
8809 defsubr (&Simage_metadata);
8810
8811 #if GLYPH_DEBUG
8812 defsubr (&Simagep);
8813 defsubr (&Slookup_image);
8814 #endif
8815
8816 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images,
8817 doc: /* Non-nil means always draw a cross over disabled images.
8818 Disabled images are those having a `:conversion disabled' property.
8819 A cross is always drawn on black & white displays. */);
8820 cross_disabled_images = 0;
8821
8822 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
8823 doc: /* List of directories to search for window system bitmap files. */);
8824 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
8825
8826 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay,
8827 doc: /* Maximum time after which images are removed from the cache.
8828 When an image has not been displayed this many seconds, Emacs
8829 automatically removes it from the image cache. If the cache contains
8830 a large number of images, the actual eviction time may be shorter.
8831 The value can also be nil, meaning the cache is never cleared.
8832
8833 The function `clear-image-cache' disregards this variable. */);
8834 Vimage_cache_eviction_delay = make_number (300);
8835 #ifdef HAVE_IMAGEMAGICK
8836 DEFVAR_LISP ("imagemagick-render-type", &Vimagemagick_render_type,
8837 doc: /* Choose between ImageMagick render methods. */);
8838 #endif
8839
8840 }
8841
8842 void
8843 init_image (void)
8844 {
8845 }
8846
8847 /* arch-tag: 123c2a5e-14a8-4c53-ab95-af47d7db49b9
8848 (do not change this comment) */