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