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