1 /* Functions for image support on window system.
2 Copyright (C) 1989, 1992-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
26 #if defined HAVE_LIBPNG_PNG_H
27 # include <libpng/png.h>
35 /* This makes the fields of a Display accessible, in Xlib header files. */
37 #define XLIB_ILLEGAL_ACCESS
42 #include "dispextern.h"
43 #include "blockinput.h"
46 #include "character.h"
48 #include "termhooks.h"
53 #include <sys/types.h>
56 #define COLOR_TABLE_SUPPORT 1
58 typedef struct x_bitmap_record Bitmap_Record
;
59 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
60 #define NO_PIXMAP None
62 #define RGB_PIXEL_COLOR unsigned long
64 #define PIX_MASK_RETAIN 0
65 #define PIX_MASK_DRAW 1
66 #endif /* HAVE_X_WINDOWS */
73 /* W32_TODO : Color tables on W32. */
74 #undef COLOR_TABLE_SUPPORT
76 typedef struct w32_bitmap_record Bitmap_Record
;
77 #define GET_PIXEL(ximg, x, y) GetPixel (ximg, x, y)
80 #define RGB_PIXEL_COLOR COLORREF
82 #define PIX_MASK_RETAIN 0
83 #define PIX_MASK_DRAW 1
85 #define FRAME_X_VISUAL(f) FRAME_X_DISPLAY_INFO (f)->visual
86 #define x_defined_color w32_defined_color
87 #define DefaultDepthOfScreen(screen) (one_w32_display_info.n_cbits)
89 /* Functions from w32term.c that depend on XColor (so can't go in w32term.h
90 without modifying lots of files). */
91 extern void x_query_colors (struct frame
*f
, XColor
*colors
, int ncolors
);
92 extern void x_query_color (struct frame
*f
, XColor
*color
);
94 /* Version of libpng that we were compiled with, or -1 if no PNG
95 support was compiled in. This is tested by w32-win.el to correctly
96 set up the alist used to search for PNG libraries. */
97 Lisp_Object Qlibpng_version
;
98 #endif /* HAVE_NTGUI */
102 #include <sys/types.h>
103 #include <sys/stat.h>
105 #undef COLOR_TABLE_SUPPORT
107 typedef struct ns_bitmap_record Bitmap_Record
;
109 #define GET_PIXEL(ximg, x, y) XGetPixel (ximg, x, y)
112 #define RGB_PIXEL_COLOR unsigned long
115 #define PIX_MASK_RETAIN 0
116 #define PIX_MASK_DRAW 1
118 #define FRAME_X_VISUAL FRAME_NS_DISPLAY_INFO (f)->visual
119 #define x_defined_color(f, name, color_def, alloc) \
120 ns_defined_color (f, name, color_def, alloc, 0)
121 #define FRAME_X_SCREEN(f) 0
122 #define DefaultDepthOfScreen(screen) x_display_list->n_planes
126 /* The symbol `postscript' identifying images of this type. */
128 static Lisp_Object Qpostscript
;
130 static void x_disable_image (struct frame
*, struct image
*);
131 static void x_edge_detection (struct frame
*, struct image
*, Lisp_Object
,
134 static void init_color_table (void);
135 static unsigned long lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
);
136 #ifdef COLOR_TABLE_SUPPORT
137 static void free_color_table (void);
138 static unsigned long *colors_in_color_table (int *n
);
140 static Lisp_Object
Finit_image_library (Lisp_Object
, Lisp_Object
);
142 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
143 id, which is just an int that this section returns. Bitmaps are
144 reference counted so they can be shared among frames.
146 Bitmap indices are guaranteed to be > 0, so a negative number can
147 be used to indicate no bitmap.
149 If you use x_create_bitmap_from_data, then you must keep track of
150 the bitmaps yourself. That is, creating a bitmap from the same
151 data more than once will not be caught. */
155 XGetImage (Display
*display
, Pixmap pixmap
, int x
, int y
,
156 unsigned int width
, unsigned int height
,
157 unsigned long plane_mask
, int format
)
159 /* TODO: not sure what this function is supposed to do.. */
160 ns_retain_object (pixmap
);
164 /* use with imgs created by ns_image_for_XPM */
166 XGetPixel (XImagePtr ximage
, int x
, int y
)
168 return ns_get_pixel (ximage
, x
, y
);
171 /* use with imgs created by ns_image_for_XPM; alpha set to 1;
172 pixel is assumed to be in form RGB */
174 XPutPixel (XImagePtr ximage
, int x
, int y
, unsigned long pixel
)
176 ns_put_pixel (ximage
, x
, y
, pixel
);
181 /* Functions to access the contents of a bitmap, given an id. */
184 x_bitmap_height (FRAME_PTR f
, ptrdiff_t id
)
186 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
190 x_bitmap_width (FRAME_PTR f
, ptrdiff_t id
)
192 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].width
;
195 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
197 x_bitmap_pixmap (FRAME_PTR f
, ptrdiff_t id
)
199 /* HAVE_NTGUI needs the explicit cast here. */
200 return (int) FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].pixmap
;
204 #ifdef HAVE_X_WINDOWS
206 x_bitmap_mask (FRAME_PTR f
, ptrdiff_t id
)
208 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].mask
;
212 /* Allocate a new bitmap record. Returns index of new record. */
215 x_allocate_bitmap_record (FRAME_PTR f
)
217 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
220 if (dpyinfo
->bitmaps_last
< dpyinfo
->bitmaps_size
)
221 return ++dpyinfo
->bitmaps_last
;
223 for (i
= 0; i
< dpyinfo
->bitmaps_size
; ++i
)
224 if (dpyinfo
->bitmaps
[i
].refcount
== 0)
228 xpalloc (dpyinfo
->bitmaps
, &dpyinfo
->bitmaps_size
,
229 10, -1, sizeof *dpyinfo
->bitmaps
);
230 return ++dpyinfo
->bitmaps_last
;
233 /* Add one reference to the reference count of the bitmap with id ID. */
236 x_reference_bitmap (FRAME_PTR f
, ptrdiff_t id
)
238 ++FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].refcount
;
241 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
244 x_create_bitmap_from_data (struct frame
*f
, char *bits
, unsigned int width
, unsigned int height
)
246 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
249 #ifdef HAVE_X_WINDOWS
251 bitmap
= XCreateBitmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
252 bits
, width
, height
);
255 #endif /* HAVE_X_WINDOWS */
259 bitmap
= CreateBitmap (width
, height
,
260 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_planes
,
261 FRAME_X_DISPLAY_INFO (XFRAME (frame
))->n_cbits
,
265 #endif /* HAVE_NTGUI */
268 void *bitmap
= ns_image_from_XBM (bits
, width
, height
);
273 id
= x_allocate_bitmap_record (f
);
276 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
277 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
280 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
281 dpyinfo
->bitmaps
[id
- 1].height
= height
;
282 dpyinfo
->bitmaps
[id
- 1].width
= width
;
283 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
285 #ifdef HAVE_X_WINDOWS
286 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
287 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
288 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
289 #endif /* HAVE_X_WINDOWS */
292 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
293 dpyinfo
->bitmaps
[id
- 1].hinst
= NULL
;
294 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
295 #endif /* HAVE_NTGUI */
300 /* Create bitmap from file FILE for frame F. */
303 x_create_bitmap_from_file (struct frame
*f
, Lisp_Object file
)
305 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
308 return -1; /* W32_TODO : bitmap support */
309 #endif /* HAVE_NTGUI */
313 void *bitmap
= ns_image_from_file (file
);
319 id
= x_allocate_bitmap_record (f
);
320 dpyinfo
->bitmaps
[id
- 1].img
= bitmap
;
321 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
322 dpyinfo
->bitmaps
[id
- 1].file
= (char *) xmalloc (SBYTES (file
) + 1);
323 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
324 dpyinfo
->bitmaps
[id
- 1].height
= ns_image_width (bitmap
);
325 dpyinfo
->bitmaps
[id
- 1].width
= ns_image_height (bitmap
);
326 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SDATA (file
));
330 #ifdef HAVE_X_WINDOWS
331 unsigned int width
, height
;
333 int xhot
, yhot
, result
;
339 /* Look for an existing bitmap with the same name. */
340 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
342 if (dpyinfo
->bitmaps
[id
].refcount
343 && dpyinfo
->bitmaps
[id
].file
344 && !strcmp (dpyinfo
->bitmaps
[id
].file
, SSDATA (file
)))
346 ++dpyinfo
->bitmaps
[id
].refcount
;
351 /* Search bitmap-file-path for the file, if appropriate. */
352 fd
= openp (Vx_bitmap_file_path
, file
, Qnil
, &found
, Qnil
);
357 filename
= SSDATA (found
);
359 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
360 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
361 if (result
!= BitmapSuccess
)
364 id
= x_allocate_bitmap_record (f
);
365 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
366 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
367 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
368 dpyinfo
->bitmaps
[id
- 1].file
= (char *) xmalloc (SBYTES (file
) + 1);
369 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
370 dpyinfo
->bitmaps
[id
- 1].height
= height
;
371 dpyinfo
->bitmaps
[id
- 1].width
= width
;
372 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SSDATA (file
));
375 #endif /* HAVE_X_WINDOWS */
381 free_bitmap_record (Display_Info
*dpyinfo
, Bitmap_Record
*bm
)
383 #ifdef HAVE_X_WINDOWS
384 XFreePixmap (dpyinfo
->display
, bm
->pixmap
);
386 XFreePixmap (dpyinfo
->display
, bm
->mask
);
387 #endif /* HAVE_X_WINDOWS */
390 DeleteObject (bm
->pixmap
);
391 #endif /* HAVE_NTGUI */
394 ns_release_object (bm
->img
);
404 /* Remove reference to bitmap with id number ID. */
407 x_destroy_bitmap (FRAME_PTR f
, ptrdiff_t id
)
409 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
413 Bitmap_Record
*bm
= &dpyinfo
->bitmaps
[id
- 1];
415 if (--bm
->refcount
== 0)
418 free_bitmap_record (dpyinfo
, bm
);
424 /* Free all the bitmaps for the display specified by DPYINFO. */
427 x_destroy_all_bitmaps (Display_Info
*dpyinfo
)
430 Bitmap_Record
*bm
= dpyinfo
->bitmaps
;
432 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++, bm
++)
433 if (bm
->refcount
> 0)
434 free_bitmap_record (dpyinfo
, bm
);
436 dpyinfo
->bitmaps_last
= 0;
440 #ifdef HAVE_X_WINDOWS
442 /* Useful functions defined in the section
443 `Image type independent image structures' below. */
445 static unsigned long four_corners_best (XImagePtr ximg
,
448 unsigned long height
);
450 static int x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
,
451 int depth
, XImagePtr
*ximg
,
454 static void x_destroy_x_image (XImagePtr ximg
);
457 /* Create a mask of a bitmap. Note is this not a perfect mask.
458 It's nicer with some borders in this context */
461 x_create_bitmap_mask (struct frame
*f
, ptrdiff_t id
)
464 XImagePtr ximg
, mask_img
;
465 unsigned long width
, height
;
468 unsigned long x
, y
, xp
, xm
, yp
, ym
;
471 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
476 pixmap
= x_bitmap_pixmap (f
, id
);
477 width
= x_bitmap_width (f
, id
);
478 height
= x_bitmap_height (f
, id
);
481 ximg
= XGetImage (FRAME_X_DISPLAY (f
), pixmap
, 0, 0, width
, height
,
490 result
= x_create_x_image_and_pixmap (f
, width
, height
, 1, &mask_img
, &mask
);
495 XDestroyImage (ximg
);
499 bg
= four_corners_best (ximg
, NULL
, width
, height
);
501 for (y
= 0; y
< ximg
->height
; ++y
)
503 for (x
= 0; x
< ximg
->width
; ++x
)
505 xp
= x
!= ximg
->width
- 1 ? x
+ 1 : 0;
506 xm
= x
!= 0 ? x
- 1 : ximg
->width
- 1;
507 yp
= y
!= ximg
->height
- 1 ? y
+ 1 : 0;
508 ym
= y
!= 0 ? y
- 1 : ximg
->height
- 1;
509 if (XGetPixel (ximg
, x
, y
) == bg
510 && XGetPixel (ximg
, x
, yp
) == bg
511 && XGetPixel (ximg
, x
, ym
) == bg
512 && XGetPixel (ximg
, xp
, y
) == bg
513 && XGetPixel (ximg
, xp
, yp
) == bg
514 && XGetPixel (ximg
, xp
, ym
) == bg
515 && XGetPixel (ximg
, xm
, y
) == bg
516 && XGetPixel (ximg
, xm
, yp
) == bg
517 && XGetPixel (ximg
, xm
, ym
) == bg
)
518 XPutPixel (mask_img
, x
, y
, 0);
520 XPutPixel (mask_img
, x
, y
, 1);
524 xassert (interrupt_input_blocked
);
525 gc
= XCreateGC (FRAME_X_DISPLAY (f
), mask
, 0, NULL
);
526 XPutImage (FRAME_X_DISPLAY (f
), mask
, gc
, mask_img
, 0, 0, 0, 0,
528 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
530 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
531 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
533 XDestroyImage (ximg
);
534 x_destroy_x_image (mask_img
);
539 #endif /* HAVE_X_WINDOWS */
542 /***********************************************************************
544 ***********************************************************************/
546 /* List of supported image types. Use define_image_type to add new
547 types. Use lookup_image_type to find a type for a given symbol. */
549 static struct image_type
*image_types
;
551 /* The symbol `xbm' which is used as the type symbol for XBM images. */
553 static Lisp_Object Qxbm
;
557 Lisp_Object QCascent
, QCmargin
, QCrelief
;
558 Lisp_Object QCconversion
;
559 static Lisp_Object QCheuristic_mask
;
560 static Lisp_Object QCcolor_symbols
;
561 static Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
, QCgeometry
;
562 static Lisp_Object QCcrop
, QCrotation
;
566 static Lisp_Object Qcount
, Qextension_data
, Qdelay
;
567 static Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
569 /* Function prototypes. */
571 static Lisp_Object
define_image_type (struct image_type
*type
, int loaded
);
572 static struct image_type
*lookup_image_type (Lisp_Object symbol
);
573 static void image_error (const char *format
, Lisp_Object
, Lisp_Object
);
574 static void x_laplace (struct frame
*, struct image
*);
575 static void x_emboss (struct frame
*, struct image
*);
576 static int x_build_heuristic_mask (struct frame
*, struct image
*,
579 #define CACHE_IMAGE_TYPE(type, status) \
580 do { Vlibrary_cache = Fcons (Fcons (type, status), Vlibrary_cache); } while (0)
582 #define CACHE_IMAGE_TYPE(type, status)
585 #define ADD_IMAGE_TYPE(type) \
586 do { Vimage_types = Fcons (type, Vimage_types); } while (0)
588 /* Define a new image type from TYPE. This adds a copy of TYPE to
589 image_types and caches the loading status of TYPE. */
592 define_image_type (struct image_type
*type
, int loaded
)
600 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
601 The initialized data segment is read-only. */
602 struct image_type
*p
= (struct image_type
*) xmalloc (sizeof *p
);
603 memcpy (p
, type
, sizeof *p
);
604 p
->next
= image_types
;
609 CACHE_IMAGE_TYPE (*type
->type
, success
);
614 /* Look up image type SYMBOL, and return a pointer to its image_type
615 structure. Value is null if SYMBOL is not a known image type. */
617 static inline struct image_type
*
618 lookup_image_type (Lisp_Object symbol
)
620 struct image_type
*type
;
622 /* We must initialize the image-type if it hasn't been already. */
623 if (NILP (Finit_image_library (symbol
, Vdynamic_library_alist
)))
624 return 0; /* unimplemented */
626 for (type
= image_types
; type
; type
= type
->next
)
627 if (EQ (symbol
, *type
->type
))
634 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
635 valid image specification is a list whose car is the symbol
636 `image', and whose rest is a property list. The property list must
637 contain a value for key `:type'. That value must be the name of a
638 supported image type. The rest of the property list depends on the
642 valid_image_p (Lisp_Object object
)
650 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
651 if (EQ (XCAR (tem
), QCtype
))
654 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
656 struct image_type
*type
;
657 type
= lookup_image_type (XCAR (tem
));
659 valid_p
= type
->valid_p (object
);
670 /* Log error message with format string FORMAT and argument ARG.
671 Signaling an error, e.g. when an image cannot be loaded, is not a
672 good idea because this would interrupt redisplay, and the error
673 message display would lead to another redisplay. This function
674 therefore simply displays a message. */
677 image_error (const char *format
, Lisp_Object arg1
, Lisp_Object arg2
)
679 add_to_log (format
, arg1
, arg2
);
684 /***********************************************************************
686 ***********************************************************************/
688 enum image_value_type
690 IMAGE_DONT_CHECK_VALUE_TYPE
,
692 IMAGE_STRING_OR_NIL_VALUE
,
694 IMAGE_POSITIVE_INTEGER_VALUE
,
695 IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
,
696 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
699 IMAGE_FUNCTION_VALUE
,
704 /* Structure used when parsing image specifications. */
708 /* Name of keyword. */
711 /* The type of value allowed. */
712 enum image_value_type type
;
714 /* Non-zero means key must be present. */
717 /* Used to recognize duplicate keywords in a property list. */
720 /* The value that was found. */
725 static int parse_image_spec (Lisp_Object
, struct image_keyword
*,
727 static Lisp_Object
image_spec_value (Lisp_Object
, Lisp_Object
, int *);
730 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
731 has the format (image KEYWORD VALUE ...). One of the keyword/
732 value pairs must be `:type TYPE'. KEYWORDS is a vector of
733 image_keywords structures of size NKEYWORDS describing other
734 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
737 parse_image_spec (Lisp_Object spec
, struct image_keyword
*keywords
,
738 int nkeywords
, Lisp_Object type
)
747 while (CONSP (plist
))
749 Lisp_Object key
, value
;
751 /* First element of a pair must be a symbol. */
753 plist
= XCDR (plist
);
757 /* There must follow a value. */
760 value
= XCAR (plist
);
761 plist
= XCDR (plist
);
763 /* Find key in KEYWORDS. Error if not found. */
764 for (i
= 0; i
< nkeywords
; ++i
)
765 if (strcmp (keywords
[i
].name
, SSDATA (SYMBOL_NAME (key
))) == 0)
771 /* Record that we recognized the keyword. If a keywords
772 was found more than once, it's an error. */
773 keywords
[i
].value
= value
;
774 if (keywords
[i
].count
> 1)
778 /* Check type of value against allowed type. */
779 switch (keywords
[i
].type
)
781 case IMAGE_STRING_VALUE
:
782 if (!STRINGP (value
))
786 case IMAGE_STRING_OR_NIL_VALUE
:
787 if (!STRINGP (value
) && !NILP (value
))
791 case IMAGE_SYMBOL_VALUE
:
792 if (!SYMBOLP (value
))
796 case IMAGE_POSITIVE_INTEGER_VALUE
:
797 if (! RANGED_INTEGERP (1, value
, INT_MAX
))
801 case IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
:
802 if (RANGED_INTEGERP (0, value
, INT_MAX
))
805 && RANGED_INTEGERP (0, XCAR (value
), INT_MAX
)
806 && RANGED_INTEGERP (0, XCDR (value
), INT_MAX
))
810 case IMAGE_ASCENT_VALUE
:
811 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
813 else if (RANGED_INTEGERP (0, value
, 100))
817 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
818 /* Unlike the other integer-related cases, this one does not
819 verify that VALUE fits in 'int'. This is because callers
821 if (!INTEGERP (value
) || XINT (value
) < 0)
825 case IMAGE_DONT_CHECK_VALUE_TYPE
:
828 case IMAGE_FUNCTION_VALUE
:
829 value
= indirect_function (value
);
830 if (!NILP (Ffunctionp (value
)))
834 case IMAGE_NUMBER_VALUE
:
835 if (!INTEGERP (value
) && !FLOATP (value
))
839 case IMAGE_INTEGER_VALUE
:
840 if (! TYPE_RANGED_INTEGERP (int, value
))
844 case IMAGE_BOOL_VALUE
:
845 if (!NILP (value
) && !EQ (value
, Qt
))
854 if (EQ (key
, QCtype
) && !EQ (type
, value
))
858 /* Check that all mandatory fields are present. */
859 for (i
= 0; i
< nkeywords
; ++i
)
860 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
867 /* Return the value of KEY in image specification SPEC. Value is nil
868 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
869 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
872 image_spec_value (Lisp_Object spec
, Lisp_Object key
, int *found
)
876 xassert (valid_image_p (spec
));
878 for (tail
= XCDR (spec
);
879 CONSP (tail
) && CONSP (XCDR (tail
));
880 tail
= XCDR (XCDR (tail
)))
882 if (EQ (XCAR (tail
), key
))
886 return XCAR (XCDR (tail
));
896 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
897 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
898 PIXELS non-nil means return the size in pixels, otherwise return the
899 size in canonical character units.
900 FRAME is the frame on which the image will be displayed. FRAME nil
901 or omitted means use the selected frame. */)
902 (Lisp_Object spec
, Lisp_Object pixels
, Lisp_Object frame
)
907 if (valid_image_p (spec
))
909 struct frame
*f
= check_x_frame (frame
);
910 ptrdiff_t id
= lookup_image (f
, spec
);
911 struct image
*img
= IMAGE_FROM_ID (f
, id
);
912 int width
= img
->width
+ 2 * img
->hmargin
;
913 int height
= img
->height
+ 2 * img
->vmargin
;
916 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
917 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
919 size
= Fcons (make_number (width
), make_number (height
));
922 error ("Invalid image specification");
928 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
929 doc
: /* Return t if image SPEC has a mask bitmap.
930 FRAME is the frame on which the image will be displayed. FRAME nil
931 or omitted means use the selected frame. */)
932 (Lisp_Object spec
, Lisp_Object frame
)
937 if (valid_image_p (spec
))
939 struct frame
*f
= check_x_frame (frame
);
940 ptrdiff_t id
= lookup_image (f
, spec
);
941 struct image
*img
= IMAGE_FROM_ID (f
, id
);
946 error ("Invalid image specification");
951 DEFUN ("image-metadata", Fimage_metadata
, Simage_metadata
, 1, 2, 0,
952 doc
: /* Return metadata for image SPEC.
953 FRAME is the frame on which the image will be displayed. FRAME nil
954 or omitted means use the selected frame. */)
955 (Lisp_Object spec
, Lisp_Object frame
)
960 if (valid_image_p (spec
))
962 struct frame
*f
= check_x_frame (frame
);
963 ptrdiff_t id
= lookup_image (f
, spec
);
964 struct image
*img
= IMAGE_FROM_ID (f
, id
);
965 ext
= img
->lisp_data
;
972 /***********************************************************************
973 Image type independent image structures
974 ***********************************************************************/
976 static void free_image (struct frame
*f
, struct image
*img
);
978 #define MAX_IMAGE_SIZE 10.0
979 /* Allocate and return a new image structure for image specification
980 SPEC. SPEC has a hash value of HASH. */
982 static struct image
*
983 make_image (Lisp_Object spec
, EMACS_UINT hash
)
985 struct image
*img
= (struct image
*) xmalloc (sizeof *img
);
986 Lisp_Object file
= image_spec_value (spec
, QCfile
, NULL
);
988 xassert (valid_image_p (spec
));
989 memset (img
, 0, sizeof *img
);
990 img
->dependencies
= NILP (file
) ? Qnil
: list1 (file
);
991 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
992 xassert (img
->type
!= NULL
);
994 img
->lisp_data
= Qnil
;
995 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
997 img
->corners
[BOT_CORNER
] = -1; /* Full image */
1002 /* Free image IMG which was used on frame F, including its resources. */
1005 free_image (struct frame
*f
, struct image
*img
)
1009 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1011 /* Remove IMG from the hash table of its cache. */
1013 img
->prev
->next
= img
->next
;
1015 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
1018 img
->next
->prev
= img
->prev
;
1020 c
->images
[img
->id
] = NULL
;
1022 /* Free resources, then free IMG. */
1023 img
->type
->free (f
, img
);
1028 /* Return 1 if the given widths and heights are valid for display;
1029 otherwise, return 0. */
1032 check_image_size (struct frame
*f
, int width
, int height
)
1036 if (width
<= 0 || height
<= 0)
1039 if (INTEGERP (Vmax_image_size
))
1040 return (width
<= XINT (Vmax_image_size
)
1041 && height
<= XINT (Vmax_image_size
));
1042 else if (FLOATP (Vmax_image_size
))
1046 w
= FRAME_PIXEL_WIDTH (f
);
1047 h
= FRAME_PIXEL_HEIGHT (f
);
1050 w
= h
= 1024; /* Arbitrary size for unknown frame. */
1051 return (width
<= XFLOAT_DATA (Vmax_image_size
) * w
1052 && height
<= XFLOAT_DATA (Vmax_image_size
) * h
);
1058 /* Prepare image IMG for display on frame F. Must be called before
1059 drawing an image. */
1062 prepare_image_for_display (struct frame
*f
, struct image
*img
)
1066 /* We're about to display IMG, so set its timestamp to `now'. */
1068 img
->timestamp
= EMACS_SECS (t
);
1070 /* If IMG doesn't have a pixmap yet, load it now, using the image
1071 type dependent loader function. */
1072 if (img
->pixmap
== NO_PIXMAP
&& !img
->load_failed_p
)
1073 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
1078 /* Value is the number of pixels for the ascent of image IMG when
1079 drawn in face FACE. */
1082 image_ascent (struct image
*img
, struct face
*face
, struct glyph_slice
*slice
)
1087 if (slice
->height
== img
->height
)
1088 height
= img
->height
+ img
->vmargin
;
1089 else if (slice
->y
== 0)
1090 height
= slice
->height
+ img
->vmargin
;
1092 height
= slice
->height
;
1094 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
1099 /* W32 specific version. Why?. ++kfs */
1100 ascent
= height
/ 2 - (FONT_DESCENT (face
->font
)
1101 - FONT_BASE (face
->font
)) / 2;
1103 /* This expression is arranged so that if the image can't be
1104 exactly centered, it will be moved slightly up. This is
1105 because a typical font is `top-heavy' (due to the presence
1106 uppercase letters), so the image placement should err towards
1107 being top-heavy too. It also just generally looks better. */
1108 ascent
= (height
+ FONT_BASE (face
->font
)
1109 - FONT_DESCENT (face
->font
) + 1) / 2;
1110 #endif /* HAVE_NTGUI */
1113 ascent
= height
/ 2;
1116 ascent
= height
* (img
->ascent
/ 100.0);
1122 /* Image background colors. */
1124 /* Find the "best" corner color of a bitmap.
1125 On W32, XIMG is assumed to a device context with the bitmap selected. */
1127 static RGB_PIXEL_COLOR
1128 four_corners_best (XImagePtr_or_DC ximg
, int *corners
,
1129 unsigned long width
, unsigned long height
)
1131 RGB_PIXEL_COLOR corner_pixels
[4], best
IF_LINT (= 0);
1134 if (corners
&& corners
[BOT_CORNER
] >= 0)
1136 /* Get the colors at the corner_pixels of ximg. */
1137 corner_pixels
[0] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[TOP_CORNER
]);
1138 corner_pixels
[1] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[TOP_CORNER
]);
1139 corner_pixels
[2] = GET_PIXEL (ximg
, corners
[RIGHT_CORNER
] - 1, corners
[BOT_CORNER
] - 1);
1140 corner_pixels
[3] = GET_PIXEL (ximg
, corners
[LEFT_CORNER
], corners
[BOT_CORNER
] - 1);
1144 /* Get the colors at the corner_pixels of ximg. */
1145 corner_pixels
[0] = GET_PIXEL (ximg
, 0, 0);
1146 corner_pixels
[1] = GET_PIXEL (ximg
, width
- 1, 0);
1147 corner_pixels
[2] = GET_PIXEL (ximg
, width
- 1, height
- 1);
1148 corner_pixels
[3] = GET_PIXEL (ximg
, 0, height
- 1);
1150 /* Choose the most frequently found color as background. */
1151 for (i
= best_count
= 0; i
< 4; ++i
)
1155 for (j
= n
= 0; j
< 4; ++j
)
1156 if (corner_pixels
[i
] == corner_pixels
[j
])
1160 best
= corner_pixels
[i
], best_count
= n
;
1166 /* Portability macros */
1170 #define Destroy_Image(img_dc, prev) \
1171 do { SelectObject (img_dc, prev); DeleteDC (img_dc); } while (0)
1173 #define Free_Pixmap(display, pixmap) \
1174 DeleteObject (pixmap)
1176 #elif defined (HAVE_NS)
1178 #define Destroy_Image(ximg, dummy) \
1179 ns_release_object (ximg)
1181 #define Free_Pixmap(display, pixmap) \
1182 ns_release_object (pixmap)
1186 #define Destroy_Image(ximg, dummy) \
1187 XDestroyImage (ximg)
1189 #define Free_Pixmap(display, pixmap) \
1190 XFreePixmap (display, pixmap)
1192 #endif /* !HAVE_NTGUI && !HAVE_NS */
1195 /* Return the `background' field of IMG. If IMG doesn't have one yet,
1196 it is guessed heuristically. If non-zero, XIMG is an existing
1197 XImage object (or device context with the image selected on W32) to
1198 use for the heuristic. */
1201 image_background (struct image
*img
, struct frame
*f
, XImagePtr_or_DC ximg
)
1203 if (! img
->background_valid
)
1204 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1206 int free_ximg
= !ximg
;
1209 #endif /* HAVE_NTGUI */
1214 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
1215 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
1217 HDC frame_dc
= get_frame_dc (f
);
1218 ximg
= CreateCompatibleDC (frame_dc
);
1219 release_frame_dc (f
, frame_dc
);
1220 prev
= SelectObject (ximg
, img
->pixmap
);
1221 #endif /* !HAVE_NTGUI */
1224 img
->background
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
1227 Destroy_Image (ximg
, prev
);
1229 img
->background_valid
= 1;
1232 return img
->background
;
1235 /* Return the `background_transparent' field of IMG. If IMG doesn't
1236 have one yet, it is guessed heuristically. If non-zero, MASK is an
1237 existing XImage object to use for the heuristic. */
1240 image_background_transparent (struct image
*img
, struct frame
*f
, XImagePtr_or_DC mask
)
1242 if (! img
->background_transparent_valid
)
1243 /* IMG doesn't have a background yet, try to guess a reasonable value. */
1247 int free_mask
= !mask
;
1250 #endif /* HAVE_NTGUI */
1255 mask
= XGetImage (FRAME_X_DISPLAY (f
), img
->mask
,
1256 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
1258 HDC frame_dc
= get_frame_dc (f
);
1259 mask
= CreateCompatibleDC (frame_dc
);
1260 release_frame_dc (f
, frame_dc
);
1261 prev
= SelectObject (mask
, img
->mask
);
1262 #endif /* HAVE_NTGUI */
1265 img
->background_transparent
1266 = (four_corners_best (mask
, img
->corners
, img
->width
, img
->height
) == PIX_MASK_RETAIN
);
1269 Destroy_Image (mask
, prev
);
1272 img
->background_transparent
= 0;
1274 img
->background_transparent_valid
= 1;
1277 return img
->background_transparent
;
1281 /***********************************************************************
1282 Helper functions for X image types
1283 ***********************************************************************/
1285 static void x_clear_image_1 (struct frame
*, struct image
*, int,
1287 static void x_clear_image (struct frame
*f
, struct image
*img
);
1288 static unsigned long x_alloc_image_color (struct frame
*f
,
1290 Lisp_Object color_name
,
1291 unsigned long dflt
);
1294 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
1295 free the pixmap if any. MASK_P non-zero means clear the mask
1296 pixmap if any. COLORS_P non-zero means free colors allocated for
1297 the image, if any. */
1300 x_clear_image_1 (struct frame
*f
, struct image
*img
, int pixmap_p
, int mask_p
,
1303 if (pixmap_p
&& img
->pixmap
)
1305 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
1306 img
->pixmap
= NO_PIXMAP
;
1307 /* NOTE (HAVE_NS): background color is NOT an indexed color! */
1308 img
->background_valid
= 0;
1311 if (mask_p
&& img
->mask
)
1313 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1314 img
->mask
= NO_PIXMAP
;
1315 img
->background_transparent_valid
= 0;
1318 if (colors_p
&& img
->ncolors
)
1320 /* W32_TODO: color table support. */
1321 #ifdef HAVE_X_WINDOWS
1322 x_free_colors (f
, img
->colors
, img
->ncolors
);
1323 #endif /* HAVE_X_WINDOWS */
1324 xfree (img
->colors
);
1331 /* Free X resources of image IMG which is used on frame F. */
1334 x_clear_image (struct frame
*f
, struct image
*img
)
1337 x_clear_image_1 (f
, img
, 1, 1, 1);
1342 /* Allocate color COLOR_NAME for image IMG on frame F. If color
1343 cannot be allocated, use DFLT. Add a newly allocated color to
1344 IMG->colors, so that it can be freed again. Value is the pixel
1347 static unsigned long
1348 x_alloc_image_color (struct frame
*f
, struct image
*img
, Lisp_Object color_name
,
1352 unsigned long result
;
1354 xassert (STRINGP (color_name
));
1356 if (x_defined_color (f
, SSDATA (color_name
), &color
, 1)
1357 && img
->ncolors
< min (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *img
->colors
,
1360 /* This isn't called frequently so we get away with simply
1361 reallocating the color vector to the needed size, here. */
1362 ptrdiff_t ncolors
= img
->ncolors
+ 1;
1364 (unsigned long *) xrealloc (img
->colors
,
1365 ncolors
* sizeof *img
->colors
);
1366 img
->colors
[ncolors
- 1] = color
.pixel
;
1367 img
->ncolors
= ncolors
;
1368 result
= color
.pixel
;
1378 /***********************************************************************
1380 ***********************************************************************/
1382 static void cache_image (struct frame
*f
, struct image
*img
);
1383 static void postprocess_image (struct frame
*, struct image
*);
1385 /* Return a new, initialized image cache that is allocated from the
1386 heap. Call free_image_cache to free an image cache. */
1388 struct image_cache
*
1389 make_image_cache (void)
1391 struct image_cache
*c
= (struct image_cache
*) xmalloc (sizeof *c
);
1394 memset (c
, 0, sizeof *c
);
1396 c
->images
= (struct image
**) xmalloc (size
* sizeof *c
->images
);
1398 size
= IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
;
1399 c
->buckets
= (struct image
**) xmalloc (size
);
1400 memset (c
->buckets
, 0, size
);
1405 /* Find an image matching SPEC in the cache, and return it. If no
1406 image is found, return NULL. */
1407 static struct image
*
1408 search_image_cache (struct frame
*f
, Lisp_Object spec
, EMACS_UINT hash
)
1411 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1412 int i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1414 if (!c
) return NULL
;
1416 /* If the image spec does not specify a background color, the cached
1417 image must have the same background color as the current frame.
1418 The foreground color must also match, for the sake of monochrome
1421 In fact, we could ignore the foreground color matching condition
1422 for color images, or if the image spec specifies :foreground;
1423 similarly we could ignore the background color matching condition
1424 for formats that don't use transparency (such as jpeg), or if the
1425 image spec specifies :background. However, the extra memory
1426 usage is probably negligible in practice, so we don't bother. */
1428 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
1429 if (img
->hash
== hash
1430 && !NILP (Fequal (img
->spec
, spec
))
1431 && img
->frame_foreground
== FRAME_FOREGROUND_PIXEL (f
)
1432 && img
->frame_background
== FRAME_BACKGROUND_PIXEL (f
))
1438 /* Search frame F for an image with spec SPEC, and free it. */
1441 uncache_image (struct frame
*f
, Lisp_Object spec
)
1443 struct image
*img
= search_image_cache (f
, spec
, sxhash (spec
, 0));
1446 free_image (f
, img
);
1447 /* As display glyphs may still be referring to the image ID, we
1448 must garbage the frame (Bug#6426). */
1449 SET_FRAME_GARBAGED (f
);
1454 /* Free image cache of frame F. Be aware that X frames share images
1458 free_image_cache (struct frame
*f
)
1460 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1465 /* Cache should not be referenced by any frame when freed. */
1466 xassert (c
->refcount
== 0);
1468 for (i
= 0; i
< c
->used
; ++i
)
1469 free_image (f
, c
->images
[i
]);
1473 FRAME_IMAGE_CACHE (f
) = NULL
;
1478 /* Clear image cache of frame F. FILTER=t means free all images.
1479 FILTER=nil means clear only images that haven't been
1480 displayed for some time.
1481 Else, only free the images which have FILTER in their `dependencies'.
1482 Should be called from time to time to reduce the number of loaded images.
1483 If image-cache-eviction-delay is non-nil, this frees images in the cache
1484 which weren't displayed for at least that many seconds. */
1487 clear_image_cache (struct frame
*f
, Lisp_Object filter
)
1489 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1493 ptrdiff_t i
, nfreed
= 0;
1495 /* Block input so that we won't be interrupted by a SIGIO
1496 while being in an inconsistent state. */
1501 /* Filter image cache. */
1502 for (i
= 0; i
< c
->used
; ++i
)
1504 struct image
*img
= c
->images
[i
];
1505 if (img
&& (EQ (Qt
, filter
)
1506 || !NILP (Fmember (filter
, img
->dependencies
))))
1508 free_image (f
, img
);
1513 else if (INTEGERP (Vimage_cache_eviction_delay
))
1515 /* Free cache based on timestamp. */
1518 ptrdiff_t nimages
= 0;
1520 for (i
= 0; i
< c
->used
; ++i
)
1524 /* If the number of cached images has grown unusually large,
1525 decrease the cache eviction delay (Bug#6230). */
1526 delay
= XINT (Vimage_cache_eviction_delay
);
1528 delay
= 1600 * delay
/ nimages
/ nimages
;
1529 delay
= max (delay
, 1);
1532 old
= EMACS_SECS (t
) - delay
;
1534 for (i
= 0; i
< c
->used
; ++i
)
1536 struct image
*img
= c
->images
[i
];
1537 if (img
&& img
->timestamp
< old
)
1539 free_image (f
, img
);
1545 /* We may be clearing the image cache because, for example,
1546 Emacs was iconified for a longer period of time. In that
1547 case, current matrices may still contain references to
1548 images freed above. So, clear these matrices. */
1551 Lisp_Object tail
, frame
;
1553 FOR_EACH_FRAME (tail
, frame
)
1555 struct frame
*fr
= XFRAME (frame
);
1556 if (FRAME_IMAGE_CACHE (fr
) == c
)
1557 clear_current_matrices (fr
);
1560 ++windows_or_buffers_changed
;
1568 clear_image_caches (Lisp_Object filter
)
1570 /* FIXME: We want to do
1571 * struct terminal *t;
1572 * for (t = terminal_list; t; t = t->next_terminal)
1573 * clear_image_cache (t, filter); */
1574 Lisp_Object tail
, frame
;
1575 FOR_EACH_FRAME (tail
, frame
)
1576 if (FRAME_WINDOW_P (XFRAME (frame
)))
1577 clear_image_cache (XFRAME (frame
), filter
);
1580 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
1582 doc
: /* Clear the image cache.
1583 FILTER nil or a frame means clear all images in the selected frame.
1584 FILTER t means clear the image caches of all frames.
1585 Anything else, means only clear those images which refer to FILTER,
1586 which is then usually a filename. */)
1587 (Lisp_Object filter
)
1589 if (!(EQ (filter
, Qnil
) || FRAMEP (filter
)))
1590 clear_image_caches (filter
);
1592 clear_image_cache (check_x_frame (filter
), Qt
);
1598 DEFUN ("image-flush", Fimage_flush
, Simage_flush
,
1600 doc
: /* Fush the image with specification SPEC on frame FRAME.
1601 This removes the image from the Emacs image cache. If SPEC specifies
1602 an image file, the next redisplay of this image will read from the
1603 current contents of that file.
1605 FRAME nil or omitted means use the selected frame.
1606 FRAME t means refresh the image on all frames. */)
1607 (Lisp_Object spec
, Lisp_Object frame
)
1609 if (!valid_image_p (spec
))
1610 error ("Invalid image specification");
1615 FOR_EACH_FRAME (tail
, frame
)
1617 struct frame
*f
= XFRAME (frame
);
1618 if (FRAME_WINDOW_P (f
))
1619 uncache_image (f
, spec
);
1623 uncache_image (check_x_frame (frame
), spec
);
1629 /* Compute masks and transform image IMG on frame F, as specified
1630 by the image's specification, */
1633 postprocess_image (struct frame
*f
, struct image
*img
)
1635 /* Manipulation of the image's mask. */
1638 Lisp_Object conversion
, spec
;
1643 /* `:heuristic-mask t'
1645 means build a mask heuristically.
1646 `:heuristic-mask (R G B)'
1647 `:mask (heuristic (R G B))'
1648 means build a mask from color (R G B) in the
1651 means remove a mask, if any. */
1653 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
1655 x_build_heuristic_mask (f
, img
, mask
);
1660 mask
= image_spec_value (spec
, QCmask
, &found_p
);
1662 if (EQ (mask
, Qheuristic
))
1663 x_build_heuristic_mask (f
, img
, Qt
);
1664 else if (CONSP (mask
)
1665 && EQ (XCAR (mask
), Qheuristic
))
1667 if (CONSP (XCDR (mask
)))
1668 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
1670 x_build_heuristic_mask (f
, img
, XCDR (mask
));
1672 else if (NILP (mask
) && found_p
&& img
->mask
)
1674 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
1675 img
->mask
= NO_PIXMAP
;
1680 /* Should we apply an image transformation algorithm? */
1681 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
1682 if (EQ (conversion
, Qdisabled
))
1683 x_disable_image (f
, img
);
1684 else if (EQ (conversion
, Qlaplace
))
1686 else if (EQ (conversion
, Qemboss
))
1688 else if (CONSP (conversion
)
1689 && EQ (XCAR (conversion
), Qedge_detection
))
1692 tem
= XCDR (conversion
);
1694 x_edge_detection (f
, img
,
1695 Fplist_get (tem
, QCmatrix
),
1696 Fplist_get (tem
, QCcolor_adjustment
));
1702 /* Return the id of image with Lisp specification SPEC on frame F.
1703 SPEC must be a valid Lisp image specification (see valid_image_p). */
1706 lookup_image (struct frame
*f
, Lisp_Object spec
)
1712 /* F must be a window-system frame, and SPEC must be a valid image
1714 xassert (FRAME_WINDOW_P (f
));
1715 xassert (valid_image_p (spec
));
1717 /* Look up SPEC in the hash table of the image cache. */
1718 hash
= sxhash (spec
, 0);
1719 img
= search_image_cache (f
, spec
, hash
);
1720 if (img
&& img
->load_failed_p
)
1722 free_image (f
, img
);
1726 /* If not found, create a new image and cache it. */
1730 img
= make_image (spec
, hash
);
1731 cache_image (f
, img
);
1732 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
1733 img
->frame_foreground
= FRAME_FOREGROUND_PIXEL (f
);
1734 img
->frame_background
= FRAME_BACKGROUND_PIXEL (f
);
1736 /* If we can't load the image, and we don't have a width and
1737 height, use some arbitrary width and height so that we can
1738 draw a rectangle for it. */
1739 if (img
->load_failed_p
)
1743 value
= image_spec_value (spec
, QCwidth
, NULL
);
1744 img
->width
= (INTEGERP (value
)
1745 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
1746 value
= image_spec_value (spec
, QCheight
, NULL
);
1747 img
->height
= (INTEGERP (value
)
1748 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
1752 /* Handle image type independent image attributes
1753 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
1754 `:background COLOR'. */
1755 Lisp_Object ascent
, margin
, relief
, bg
;
1758 ascent
= image_spec_value (spec
, QCascent
, NULL
);
1759 if (INTEGERP (ascent
))
1760 img
->ascent
= XFASTINT (ascent
);
1761 else if (EQ (ascent
, Qcenter
))
1762 img
->ascent
= CENTERED_IMAGE_ASCENT
;
1764 margin
= image_spec_value (spec
, QCmargin
, NULL
);
1765 if (INTEGERP (margin
))
1766 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
1767 else if (CONSP (margin
))
1769 img
->hmargin
= XFASTINT (XCAR (margin
));
1770 img
->vmargin
= XFASTINT (XCDR (margin
));
1773 relief
= image_spec_value (spec
, QCrelief
, NULL
);
1774 relief_bound
= INT_MAX
- max (img
->hmargin
, img
->vmargin
);
1775 if (RANGED_INTEGERP (- relief_bound
, relief
, relief_bound
))
1777 img
->relief
= XINT (relief
);
1778 img
->hmargin
+= eabs (img
->relief
);
1779 img
->vmargin
+= eabs (img
->relief
);
1782 if (! img
->background_valid
)
1784 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
1788 = x_alloc_image_color (f
, img
, bg
,
1789 FRAME_BACKGROUND_PIXEL (f
));
1790 img
->background_valid
= 1;
1794 /* Do image transformations and compute masks, unless we
1795 don't have the image yet. */
1796 if (!EQ (*img
->type
->type
, Qpostscript
))
1797 postprocess_image (f
, img
);
1803 /* We're using IMG, so set its timestamp to `now'. */
1804 EMACS_GET_TIME (now
);
1805 img
->timestamp
= EMACS_SECS (now
);
1807 /* Value is the image id. */
1812 /* Cache image IMG in the image cache of frame F. */
1815 cache_image (struct frame
*f
, struct image
*img
)
1817 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
1820 /* Find a free slot in c->images. */
1821 for (i
= 0; i
< c
->used
; ++i
)
1822 if (c
->images
[i
] == NULL
)
1825 /* If no free slot found, maybe enlarge c->images. */
1826 if (i
== c
->used
&& c
->used
== c
->size
)
1827 c
->images
= xpalloc (c
->images
, &c
->size
, 1, -1, sizeof *c
->images
);
1829 /* Add IMG to c->images, and assign IMG an id. */
1835 /* Add IMG to the cache's hash table. */
1836 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
1837 img
->next
= c
->buckets
[i
];
1839 img
->next
->prev
= img
;
1841 c
->buckets
[i
] = img
;
1845 /* Call FN on every image in the image cache of frame F. Used to mark
1846 Lisp Objects in the image cache. */
1848 /* Mark Lisp objects in image IMG. */
1851 mark_image (struct image
*img
)
1853 mark_object (img
->spec
);
1854 mark_object (img
->dependencies
);
1856 if (!NILP (img
->lisp_data
))
1857 mark_object (img
->lisp_data
);
1862 mark_image_cache (struct image_cache
*c
)
1867 for (i
= 0; i
< c
->used
; ++i
)
1869 mark_image (c
->images
[i
]);
1875 /***********************************************************************
1876 X / NS / W32 support code
1877 ***********************************************************************/
1881 /* Macro for defining functions that will be loaded from image DLLs. */
1882 #define DEF_IMGLIB_FN(rettype,func,args) static rettype (FAR CDECL *fn_##func)args
1884 /* Macro for loading those image functions from the library. */
1885 #define LOAD_IMGLIB_FN(lib,func) { \
1886 fn_##func = (void *) GetProcAddress (lib, #func); \
1887 if (!fn_##func) return 0; \
1890 #endif /* HAVE_NTGUI */
1892 static int x_create_x_image_and_pixmap (struct frame
*, int, int, int,
1893 XImagePtr
*, Pixmap
*);
1894 static void x_destroy_x_image (XImagePtr
);
1895 static void x_put_x_image (struct frame
*, XImagePtr
, Pixmap
, int, int);
1897 /* Return nonzero if XIMG's size WIDTH x HEIGHT doesn't break the
1899 WIDTH and HEIGHT must both be positive.
1900 If XIMG is null, assume it is a bitmap. */
1902 x_check_image_size (XImagePtr ximg
, int width
, int height
)
1904 #ifdef HAVE_X_WINDOWS
1905 /* Respect Xlib's limits: it cannot deal with images that have more
1906 than INT_MAX (and/or UINT_MAX) bytes. And respect Emacs's limits
1907 of PTRDIFF_MAX (and/or SIZE_MAX) bytes for any object. */
1910 XLIB_BYTES_MAX
= min (INT_MAX
, UINT_MAX
),
1911 X_IMAGE_BYTES_MAX
= min (XLIB_BYTES_MAX
, min (PTRDIFF_MAX
, SIZE_MAX
))
1914 int bitmap_pad
, depth
, bytes_per_line
;
1917 bitmap_pad
= ximg
->bitmap_pad
;
1918 depth
= ximg
->depth
;
1919 bytes_per_line
= ximg
->bytes_per_line
;
1925 bytes_per_line
= (width
>> 3) + ((width
& 7) != 0);
1927 return (width
<= (INT_MAX
- (bitmap_pad
- 1)) / depth
1928 && height
<= X_IMAGE_BYTES_MAX
/ bytes_per_line
);
1930 /* FIXME: Implement this check for the HAVE_NS and HAVE_NTGUI cases.
1931 For now, assume that every image size is allowed on these systems. */
1936 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
1937 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
1938 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
1939 via xmalloc. Print error messages via image_error if an error
1940 occurs. Value is non-zero if successful.
1942 On W32, a DEPTH of zero signifies a 24 bit image, otherwise DEPTH
1943 should indicate the bit depth of the image. */
1946 x_create_x_image_and_pixmap (struct frame
*f
, int width
, int height
, int depth
,
1947 XImagePtr
*ximg
, Pixmap
*pixmap
)
1949 #ifdef HAVE_X_WINDOWS
1950 Display
*display
= FRAME_X_DISPLAY (f
);
1951 Window window
= FRAME_X_WINDOW (f
);
1952 Screen
*screen
= FRAME_X_SCREEN (f
);
1954 xassert (interrupt_input_blocked
);
1957 depth
= DefaultDepthOfScreen (screen
);
1958 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
1959 depth
, ZPixmap
, 0, NULL
, width
, height
,
1960 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
1963 image_error ("Unable to allocate X image", Qnil
, Qnil
);
1967 if (! x_check_image_size (*ximg
, width
, height
))
1969 x_destroy_x_image (*ximg
);
1971 image_error ("Image too large (%dx%d)",
1972 make_number (width
), make_number (height
));
1976 /* Allocate image raster. */
1977 (*ximg
)->data
= (char *) xmalloc ((*ximg
)->bytes_per_line
* height
);
1979 /* Allocate a pixmap of the same size. */
1980 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
1981 if (*pixmap
== NO_PIXMAP
)
1983 x_destroy_x_image (*ximg
);
1985 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
1990 #endif /* HAVE_X_WINDOWS */
1994 BITMAPINFOHEADER
*header
;
1996 int scanline_width_bits
;
1998 int palette_colors
= 0;
2003 if (depth
!= 1 && depth
!= 4 && depth
!= 8
2004 && depth
!= 16 && depth
!= 24 && depth
!= 32)
2006 image_error ("Invalid image bit depth specified", Qnil
, Qnil
);
2010 scanline_width_bits
= width
* depth
;
2011 remainder
= scanline_width_bits
% 32;
2014 scanline_width_bits
+= 32 - remainder
;
2016 /* Bitmaps with a depth less than 16 need a palette. */
2017 /* BITMAPINFO structure already contains the first RGBQUAD. */
2019 palette_colors
= 1 << (depth
- 1);
2021 *ximg
= xmalloc (sizeof (XImage
) + palette_colors
* sizeof (RGBQUAD
));
2023 header
= &(*ximg
)->info
.bmiHeader
;
2024 memset (&(*ximg
)->info
, 0, sizeof (BITMAPINFO
));
2025 header
->biSize
= sizeof (*header
);
2026 header
->biWidth
= width
;
2027 header
->biHeight
= -height
; /* negative indicates a top-down bitmap. */
2028 header
->biPlanes
= 1;
2029 header
->biBitCount
= depth
;
2030 header
->biCompression
= BI_RGB
;
2031 header
->biClrUsed
= palette_colors
;
2033 /* TODO: fill in palette. */
2036 (*ximg
)->info
.bmiColors
[0].rgbBlue
= 0;
2037 (*ximg
)->info
.bmiColors
[0].rgbGreen
= 0;
2038 (*ximg
)->info
.bmiColors
[0].rgbRed
= 0;
2039 (*ximg
)->info
.bmiColors
[0].rgbReserved
= 0;
2040 (*ximg
)->info
.bmiColors
[1].rgbBlue
= 255;
2041 (*ximg
)->info
.bmiColors
[1].rgbGreen
= 255;
2042 (*ximg
)->info
.bmiColors
[1].rgbRed
= 255;
2043 (*ximg
)->info
.bmiColors
[1].rgbReserved
= 0;
2046 hdc
= get_frame_dc (f
);
2048 /* Create a DIBSection and raster array for the bitmap,
2049 and store its handle in *pixmap. */
2050 *pixmap
= CreateDIBSection (hdc
, &((*ximg
)->info
),
2051 (depth
< 16) ? DIB_PAL_COLORS
: DIB_RGB_COLORS
,
2052 /* casting avoids a GCC warning */
2053 (void **)&((*ximg
)->data
), NULL
, 0);
2055 /* Realize display palette and garbage all frames. */
2056 release_frame_dc (f
, hdc
);
2058 if (*pixmap
== NULL
)
2060 DWORD err
= GetLastError ();
2061 Lisp_Object errcode
;
2062 /* All system errors are < 10000, so the following is safe. */
2063 XSETINT (errcode
, err
);
2064 image_error ("Unable to create bitmap, error code %d", errcode
, Qnil
);
2065 x_destroy_x_image (*ximg
);
2071 #endif /* HAVE_NTGUI */
2074 *pixmap
= ns_image_for_XPM (width
, height
, depth
);
2078 image_error ("Unable to allocate NSImage for XPM pixmap", Qnil
, Qnil
);
2087 /* Destroy XImage XIMG. Free XIMG->data. */
2090 x_destroy_x_image (XImagePtr ximg
)
2092 xassert (interrupt_input_blocked
);
2095 #ifdef HAVE_X_WINDOWS
2098 XDestroyImage (ximg
);
2099 #endif /* HAVE_X_WINDOWS */
2101 /* Data will be freed by DestroyObject. */
2104 #endif /* HAVE_NTGUI */
2106 ns_release_object (ximg
);
2107 #endif /* HAVE_NS */
2112 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
2113 are width and height of both the image and pixmap. */
2116 x_put_x_image (struct frame
*f
, XImagePtr ximg
, Pixmap pixmap
, int width
, int height
)
2118 #ifdef HAVE_X_WINDOWS
2121 xassert (interrupt_input_blocked
);
2122 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
2123 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
2124 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
2125 #endif /* HAVE_X_WINDOWS */
2128 #if 0 /* I don't think this is necessary looking at where it is used. */
2129 HDC hdc
= get_frame_dc (f
);
2130 SetDIBits (hdc
, pixmap
, 0, height
, ximg
->data
, &(ximg
->info
), DIB_RGB_COLORS
);
2131 release_frame_dc (f
, hdc
);
2133 #endif /* HAVE_NTGUI */
2136 xassert (ximg
== pixmap
);
2137 ns_retain_object (ximg
);
2142 /***********************************************************************
2144 ***********************************************************************/
2146 /* Find image file FILE. Look in data-directory/images, then
2147 x-bitmap-file-path. Value is the encoded full name of the file
2148 found, or nil if not found. */
2151 x_find_image_file (Lisp_Object file
)
2153 Lisp_Object file_found
, search_path
;
2156 /* TODO I think this should use something like image-load-path
2157 instead. Unfortunately, that can contain non-string elements. */
2158 search_path
= Fcons (Fexpand_file_name (build_string ("images"),
2160 Vx_bitmap_file_path
);
2162 /* Try to find FILE in data-directory/images, then x-bitmap-file-path. */
2163 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
);
2169 file_found
= ENCODE_FILE (file_found
);
2177 /* Read FILE into memory. Value is a pointer to a buffer allocated
2178 with xmalloc holding FILE's contents. Value is null if an error
2179 occurred. *SIZE is set to the size of the file. */
2181 static unsigned char *
2182 slurp_file (char *file
, ptrdiff_t *size
)
2185 unsigned char *buf
= NULL
;
2188 if (stat (file
, &st
) == 0
2189 && (fp
= fopen (file
, "rb")) != NULL
2190 && 0 <= st
.st_size
&& st
.st_size
<= min (PTRDIFF_MAX
, SIZE_MAX
)
2191 && (buf
= (unsigned char *) xmalloc (st
.st_size
),
2192 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
2213 /***********************************************************************
2215 ***********************************************************************/
2217 static int xbm_scan (unsigned char **, unsigned char *, char *, int *);
2218 static int xbm_load (struct frame
*f
, struct image
*img
);
2219 static int xbm_load_image (struct frame
*f
, struct image
*img
,
2220 unsigned char *, unsigned char *);
2221 static int xbm_image_p (Lisp_Object object
);
2222 static int xbm_read_bitmap_data (struct frame
*f
,
2223 unsigned char *, unsigned char *,
2224 int *, int *, char **, int);
2225 static int xbm_file_p (Lisp_Object
);
2228 /* Indices of image specification fields in xbm_format, below. */
2230 enum xbm_keyword_index
2248 /* Vector of image_keyword structures describing the format
2249 of valid XBM image specifications. */
2251 static const struct image_keyword xbm_format
[XBM_LAST
] =
2253 {":type", IMAGE_SYMBOL_VALUE
, 1},
2254 {":file", IMAGE_STRING_VALUE
, 0},
2255 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2256 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
2257 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2258 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
2259 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
2260 {":ascent", IMAGE_ASCENT_VALUE
, 0},
2261 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
2262 {":relief", IMAGE_INTEGER_VALUE
, 0},
2263 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2264 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
2265 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
2268 /* Structure describing the image type XBM. */
2270 static struct image_type xbm_type
=
2279 /* Tokens returned from xbm_scan. */
2288 /* Return non-zero if OBJECT is a valid XBM-type image specification.
2289 A valid specification is a list starting with the symbol `image'
2290 The rest of the list is a property list which must contain an
2293 If the specification specifies a file to load, it must contain
2294 an entry `:file FILENAME' where FILENAME is a string.
2296 If the specification is for a bitmap loaded from memory it must
2297 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
2298 WIDTH and HEIGHT are integers > 0. DATA may be:
2300 1. a string large enough to hold the bitmap data, i.e. it must
2301 have a size >= (WIDTH + 7) / 8 * HEIGHT
2303 2. a bool-vector of size >= WIDTH * HEIGHT
2305 3. a vector of strings or bool-vectors, one for each line of the
2308 4. a string containing an in-memory XBM file. WIDTH and HEIGHT
2309 may not be specified in this case because they are defined in the
2312 Both the file and data forms may contain the additional entries
2313 `:background COLOR' and `:foreground COLOR'. If not present,
2314 foreground and background of the frame on which the image is
2315 displayed is used. */
2318 xbm_image_p (Lisp_Object object
)
2320 struct image_keyword kw
[XBM_LAST
];
2322 memcpy (kw
, xbm_format
, sizeof kw
);
2323 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
2326 xassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
2328 if (kw
[XBM_FILE
].count
)
2330 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
2333 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
2335 /* In-memory XBM file. */
2336 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
2344 /* Entries for `:width', `:height' and `:data' must be present. */
2345 if (!kw
[XBM_WIDTH
].count
2346 || !kw
[XBM_HEIGHT
].count
2347 || !kw
[XBM_DATA
].count
)
2350 data
= kw
[XBM_DATA
].value
;
2351 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
2352 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
2354 /* Check type of data, and width and height against contents of
2360 /* Number of elements of the vector must be >= height. */
2361 if (ASIZE (data
) < height
)
2364 /* Each string or bool-vector in data must be large enough
2365 for one line of the image. */
2366 for (i
= 0; i
< height
; ++i
)
2368 Lisp_Object elt
= XVECTOR (data
)->contents
[i
];
2373 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
2376 else if (BOOL_VECTOR_P (elt
))
2378 if (XBOOL_VECTOR (elt
)->size
< width
)
2385 else if (STRINGP (data
))
2388 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
2391 else if (BOOL_VECTOR_P (data
))
2393 if (XBOOL_VECTOR (data
)->size
/ height
< width
)
2404 /* Scan a bitmap file. FP is the stream to read from. Value is
2405 either an enumerator from enum xbm_token, or a character for a
2406 single-character token, or 0 at end of file. If scanning an
2407 identifier, store the lexeme of the identifier in SVAL. If
2408 scanning a number, store its value in *IVAL. */
2411 xbm_scan (unsigned char **s
, unsigned char *end
, char *sval
, int *ival
)
2417 /* Skip white space. */
2418 while (*s
< end
&& (c
= *(*s
)++, isspace (c
)))
2423 else if (isdigit (c
))
2425 int value
= 0, digit
;
2427 if (c
== '0' && *s
< end
)
2430 if (c
== 'x' || c
== 'X')
2437 else if (c
>= 'a' && c
<= 'f')
2438 digit
= c
- 'a' + 10;
2439 else if (c
>= 'A' && c
<= 'F')
2440 digit
= c
- 'A' + 10;
2443 value
= 16 * value
+ digit
;
2446 else if (isdigit (c
))
2450 && (c
= *(*s
)++, isdigit (c
)))
2451 value
= 8 * value
+ c
- '0';
2458 && (c
= *(*s
)++, isdigit (c
)))
2459 value
= 10 * value
+ c
- '0';
2467 else if (isalpha (c
) || c
== '_')
2471 && (c
= *(*s
)++, (isalnum (c
) || c
== '_')))
2478 else if (c
== '/' && **s
== '*')
2480 /* C-style comment. */
2482 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
2496 /* Create a Windows bitmap from X bitmap data. */
2498 w32_create_pixmap_from_bitmap_data (int width
, int height
, char *data
)
2500 static unsigned char swap_nibble
[16]
2501 = { 0x0, 0x8, 0x4, 0xc, /* 0000 1000 0100 1100 */
2502 0x2, 0xa, 0x6, 0xe, /* 0010 1010 0110 1110 */
2503 0x1, 0x9, 0x5, 0xd, /* 0001 1001 0101 1101 */
2504 0x3, 0xb, 0x7, 0xf }; /* 0011 1011 0111 1111 */
2506 unsigned char *bits
, *p
;
2509 w1
= (width
+ 7) / 8; /* nb of 8bits elt in X bitmap */
2510 w2
= ((width
+ 15) / 16) * 2; /* nb of 16bits elt in W32 bitmap */
2511 bits
= (unsigned char *) alloca (height
* w2
);
2512 memset (bits
, 0, height
* w2
);
2513 for (i
= 0; i
< height
; i
++)
2516 for (j
= 0; j
< w1
; j
++)
2518 /* Bitswap XBM bytes to match how Windows does things. */
2519 unsigned char c
= *data
++;
2520 *p
++ = (unsigned char)((swap_nibble
[c
& 0xf] << 4)
2521 | (swap_nibble
[(c
>>4) & 0xf]));
2524 bmp
= CreateBitmap (width
, height
, 1, 1, (char *) bits
);
2530 convert_mono_to_color_image (struct frame
*f
, struct image
*img
,
2531 COLORREF foreground
, COLORREF background
)
2533 HDC hdc
, old_img_dc
, new_img_dc
;
2534 HGDIOBJ old_prev
, new_prev
;
2537 hdc
= get_frame_dc (f
);
2538 old_img_dc
= CreateCompatibleDC (hdc
);
2539 new_img_dc
= CreateCompatibleDC (hdc
);
2540 new_pixmap
= CreateCompatibleBitmap (hdc
, img
->width
, img
->height
);
2541 release_frame_dc (f
, hdc
);
2542 old_prev
= SelectObject (old_img_dc
, img
->pixmap
);
2543 new_prev
= SelectObject (new_img_dc
, new_pixmap
);
2544 /* Windows convention for mono bitmaps is black = background,
2545 white = foreground. */
2546 SetTextColor (new_img_dc
, background
);
2547 SetBkColor (new_img_dc
, foreground
);
2549 BitBlt (new_img_dc
, 0, 0, img
->width
, img
->height
, old_img_dc
,
2552 SelectObject (old_img_dc
, old_prev
);
2553 SelectObject (new_img_dc
, new_prev
);
2554 DeleteDC (old_img_dc
);
2555 DeleteDC (new_img_dc
);
2556 DeleteObject (img
->pixmap
);
2557 if (new_pixmap
== 0)
2558 fprintf (stderr
, "Failed to convert image to color.\n");
2560 img
->pixmap
= new_pixmap
;
2563 #define XBM_BIT_SHUFFLE(b) (~(b))
2567 #define XBM_BIT_SHUFFLE(b) (b)
2569 #endif /* HAVE_NTGUI */
2573 Create_Pixmap_From_Bitmap_Data (struct frame
*f
, struct image
*img
, char *data
,
2574 RGB_PIXEL_COLOR fg
, RGB_PIXEL_COLOR bg
,
2575 int non_default_colors
)
2579 = w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
, data
);
2581 /* If colors were specified, transfer the bitmap to a color one. */
2582 if (non_default_colors
)
2583 convert_mono_to_color_image (f
, img
, fg
, bg
);
2585 #elif defined (HAVE_NS)
2586 img
->pixmap
= ns_image_from_XBM (data
, img
->width
, img
->height
);
2590 (x_check_image_size (0, img
->width
, img
->height
)
2591 ? XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
2594 img
->width
, img
->height
,
2596 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)))
2598 #endif /* !HAVE_NTGUI && !HAVE_NS */
2603 /* Replacement for XReadBitmapFileData which isn't available under old
2604 X versions. CONTENTS is a pointer to a buffer to parse; END is the
2605 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
2606 the image. Return in *DATA the bitmap data allocated with xmalloc.
2607 Value is non-zero if successful. DATA null means just test if
2608 CONTENTS looks like an in-memory XBM file. If INHIBIT_IMAGE_ERROR
2609 is non-zero, inhibit the call to image_error when the image size is
2610 invalid (the bitmap remains unread). */
2613 xbm_read_bitmap_data (struct frame
*f
, unsigned char *contents
, unsigned char *end
,
2614 int *width
, int *height
, char **data
,
2615 int inhibit_image_error
)
2617 unsigned char *s
= contents
;
2618 char buffer
[BUFSIZ
];
2621 int bytes_per_line
, i
, nbytes
;
2627 LA1 = xbm_scan (&s, end, buffer, &value)
2629 #define expect(TOKEN) \
2630 if (LA1 != (TOKEN)) \
2635 #define expect_ident(IDENT) \
2636 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
2641 *width
= *height
= -1;
2644 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
2646 /* Parse defines for width, height and hot-spots. */
2650 expect_ident ("define");
2651 expect (XBM_TK_IDENT
);
2653 if (LA1
== XBM_TK_NUMBER
)
2655 char *q
= strrchr (buffer
, '_');
2656 q
= q
? q
+ 1 : buffer
;
2657 if (strcmp (q
, "width") == 0)
2659 else if (strcmp (q
, "height") == 0)
2662 expect (XBM_TK_NUMBER
);
2665 if (!check_image_size (f
, *width
, *height
))
2667 if (!inhibit_image_error
)
2668 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
2671 else if (data
== NULL
)
2674 /* Parse bits. Must start with `static'. */
2675 expect_ident ("static");
2676 if (LA1
== XBM_TK_IDENT
)
2678 if (strcmp (buffer
, "unsigned") == 0)
2681 expect_ident ("char");
2683 else if (strcmp (buffer
, "short") == 0)
2687 if (*width
% 16 && *width
% 16 < 9)
2690 else if (strcmp (buffer
, "char") == 0)
2698 expect (XBM_TK_IDENT
);
2704 if (! x_check_image_size (0, *width
, *height
))
2706 if (!inhibit_image_error
)
2707 image_error ("Image too large (%dx%d)",
2708 make_number (*width
), make_number (*height
));
2711 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
2712 nbytes
= bytes_per_line
* *height
;
2713 p
= *data
= (char *) xmalloc (nbytes
);
2717 for (i
= 0; i
< nbytes
; i
+= 2)
2720 expect (XBM_TK_NUMBER
);
2722 *p
++ = XBM_BIT_SHUFFLE (val
);
2723 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
2724 *p
++ = XBM_BIT_SHUFFLE (value
>> 8);
2726 if (LA1
== ',' || LA1
== '}')
2734 for (i
= 0; i
< nbytes
; ++i
)
2737 expect (XBM_TK_NUMBER
);
2739 *p
++ = XBM_BIT_SHUFFLE (val
);
2741 if (LA1
== ',' || LA1
== '}')
2766 /* Load XBM image IMG which will be displayed on frame F from buffer
2767 CONTENTS. END is the end of the buffer. Value is non-zero if
2771 xbm_load_image (struct frame
*f
, struct image
*img
, unsigned char *contents
,
2778 rc
= xbm_read_bitmap_data (f
, contents
, end
, &img
->width
, &img
->height
,
2782 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2783 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2784 int non_default_colors
= 0;
2787 xassert (img
->width
> 0 && img
->height
> 0);
2789 /* Get foreground and background colors, maybe allocate colors. */
2790 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
2793 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
2794 non_default_colors
= 1;
2796 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
2799 background
= x_alloc_image_color (f
, img
, value
, background
);
2800 img
->background
= background
;
2801 img
->background_valid
= 1;
2802 non_default_colors
= 1;
2805 Create_Pixmap_From_Bitmap_Data (f
, img
, data
,
2806 foreground
, background
,
2807 non_default_colors
);
2810 if (img
->pixmap
== NO_PIXMAP
)
2812 x_clear_image (f
, img
);
2813 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
2819 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2825 /* Value is non-zero if DATA looks like an in-memory XBM file. */
2828 xbm_file_p (Lisp_Object data
)
2831 return (STRINGP (data
)
2832 && xbm_read_bitmap_data (NULL
, SDATA (data
),
2833 (SDATA (data
) + SBYTES (data
)),
2838 /* Fill image IMG which is used on frame F with pixmap data. Value is
2839 non-zero if successful. */
2842 xbm_load (struct frame
*f
, struct image
*img
)
2845 Lisp_Object file_name
;
2847 xassert (xbm_image_p (img
->spec
));
2849 /* If IMG->spec specifies a file name, create a non-file spec from it. */
2850 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
2851 if (STRINGP (file_name
))
2854 unsigned char *contents
;
2857 file
= x_find_image_file (file_name
);
2858 if (!STRINGP (file
))
2860 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
2864 contents
= slurp_file (SSDATA (file
), &size
);
2865 if (contents
== NULL
)
2867 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
2871 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
2876 struct image_keyword fmt
[XBM_LAST
];
2878 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
2879 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
2880 int non_default_colors
= 0;
2883 int in_memory_file_p
= 0;
2885 /* See if data looks like an in-memory XBM file. */
2886 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
2887 in_memory_file_p
= xbm_file_p (data
);
2889 /* Parse the image specification. */
2890 memcpy (fmt
, xbm_format
, sizeof fmt
);
2891 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
2895 /* Get specified width, and height. */
2896 if (!in_memory_file_p
)
2898 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
2899 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
2900 xassert (img
->width
> 0 && img
->height
> 0);
2901 if (!check_image_size (f
, img
->width
, img
->height
))
2903 image_error ("Invalid image size (see `max-image-size')",
2909 /* Get foreground and background colors, maybe allocate colors. */
2910 if (fmt
[XBM_FOREGROUND
].count
2911 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
2913 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
2915 non_default_colors
= 1;
2918 if (fmt
[XBM_BACKGROUND
].count
2919 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
2921 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
2923 non_default_colors
= 1;
2926 if (in_memory_file_p
)
2927 success_p
= xbm_load_image (f
, img
, SDATA (data
),
2936 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
2938 p
= bits
= (char *) alloca (nbytes
* img
->height
);
2939 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
2941 Lisp_Object line
= XVECTOR (data
)->contents
[i
];
2943 memcpy (p
, SDATA (line
), nbytes
);
2945 memcpy (p
, XBOOL_VECTOR (line
)->data
, nbytes
);
2948 else if (STRINGP (data
))
2949 bits
= SSDATA (data
);
2951 bits
= (char *) XBOOL_VECTOR (data
)->data
;
2957 /* Windows mono bitmaps are reversed compared with X. */
2958 invertedBits
= bits
;
2959 nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
2961 bits
= (char *) alloca (nbytes
);
2962 for (i
= 0; i
< nbytes
; i
++)
2963 bits
[i
] = XBM_BIT_SHUFFLE (invertedBits
[i
]);
2966 /* Create the pixmap. */
2968 if (x_check_image_size (0, img
->width
, img
->height
))
2969 Create_Pixmap_From_Bitmap_Data (f
, img
, bits
,
2970 foreground
, background
,
2971 non_default_colors
);
2973 img
->pixmap
= NO_PIXMAP
;
2979 image_error ("Unable to create pixmap for XBM image `%s'",
2981 x_clear_image (f
, img
);
2991 /***********************************************************************
2993 ***********************************************************************/
2995 #if defined (HAVE_XPM) || defined (HAVE_NS)
2997 static int xpm_image_p (Lisp_Object object
);
2998 static int xpm_load (struct frame
*f
, struct image
*img
);
2999 static int xpm_valid_color_symbols_p (Lisp_Object
);
3001 #endif /* HAVE_XPM || HAVE_NS */
3005 /* Indicate to xpm.h that we don't have Xlib. */
3007 /* simx.h in xpm defines XColor and XImage differently than Emacs. */
3008 /* It also defines Display the same way as Emacs, but gcc 3.3 still barfs. */
3009 #define XColor xpm_XColor
3010 #define XImage xpm_XImage
3011 #define Display xpm_Display
3012 #define PIXEL_ALREADY_TYPEDEFED
3013 #include "X11/xpm.h"
3018 #undef PIXEL_ALREADY_TYPEDEFED
3020 #include "X11/xpm.h"
3021 #endif /* HAVE_NTGUI */
3022 #endif /* HAVE_XPM */
3024 #if defined (HAVE_XPM) || defined (HAVE_NS)
3025 /* The symbol `xpm' identifying XPM-format images. */
3027 static Lisp_Object Qxpm
;
3029 /* Indices of image specification fields in xpm_format, below. */
3031 enum xpm_keyword_index
3047 /* Vector of image_keyword structures describing the format
3048 of valid XPM image specifications. */
3050 static const struct image_keyword xpm_format
[XPM_LAST
] =
3052 {":type", IMAGE_SYMBOL_VALUE
, 1},
3053 {":file", IMAGE_STRING_VALUE
, 0},
3054 {":data", IMAGE_STRING_VALUE
, 0},
3055 {":ascent", IMAGE_ASCENT_VALUE
, 0},
3056 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
3057 {":relief", IMAGE_INTEGER_VALUE
, 0},
3058 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3059 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3060 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3061 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
3062 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
3065 /* Structure describing the image type XPM. */
3067 static struct image_type xpm_type
=
3076 #ifdef HAVE_X_WINDOWS
3078 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
3079 functions for allocating image colors. Our own functions handle
3080 color allocation failures more gracefully than the ones on the XPM
3083 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
3084 #define ALLOC_XPM_COLORS
3086 #endif /* HAVE_X_WINDOWS */
3088 #ifdef ALLOC_XPM_COLORS
3090 static void xpm_init_color_cache (struct frame
*, XpmAttributes
*);
3091 static void xpm_free_color_cache (void);
3092 static int xpm_lookup_color (struct frame
*, char *, XColor
*);
3093 static int xpm_color_bucket (char *);
3094 static struct xpm_cached_color
*xpm_cache_color (struct frame
*, char *,
3097 /* An entry in a hash table used to cache color definitions of named
3098 colors. This cache is necessary to speed up XPM image loading in
3099 case we do color allocations ourselves. Without it, we would need
3100 a call to XParseColor per pixel in the image. */
3102 struct xpm_cached_color
3104 /* Next in collision chain. */
3105 struct xpm_cached_color
*next
;
3107 /* Color definition (RGB and pixel color). */
3114 /* The hash table used for the color cache, and its bucket vector
3117 #define XPM_COLOR_CACHE_BUCKETS 1001
3118 static struct xpm_cached_color
**xpm_color_cache
;
3120 /* Initialize the color cache. */
3123 xpm_init_color_cache (struct frame
*f
, XpmAttributes
*attrs
)
3125 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
3126 xpm_color_cache
= (struct xpm_cached_color
**) xmalloc (nbytes
);
3127 memset (xpm_color_cache
, 0, nbytes
);
3128 init_color_table ();
3130 if (attrs
->valuemask
& XpmColorSymbols
)
3135 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
3136 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3137 attrs
->colorsymbols
[i
].value
, &color
))
3139 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
3141 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
3146 /* Free the color cache. */
3149 xpm_free_color_cache (void)
3151 struct xpm_cached_color
*p
, *next
;
3154 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
3155 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
3161 xfree (xpm_color_cache
);
3162 xpm_color_cache
= NULL
;
3163 free_color_table ();
3166 /* Return the bucket index for color named COLOR_NAME in the color
3170 xpm_color_bucket (char *color_name
)
3172 EMACS_UINT hash
= hash_string (color_name
, strlen (color_name
));
3173 return hash
% XPM_COLOR_CACHE_BUCKETS
;
3177 /* On frame F, cache values COLOR for color with name COLOR_NAME.
3178 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
3181 static struct xpm_cached_color
*
3182 xpm_cache_color (struct frame
*f
, char *color_name
, XColor
*color
, int bucket
)
3185 struct xpm_cached_color
*p
;
3188 bucket
= xpm_color_bucket (color_name
);
3190 nbytes
= offsetof (struct xpm_cached_color
, name
) + strlen (color_name
) + 1;
3191 p
= (struct xpm_cached_color
*) xmalloc (nbytes
);
3192 strcpy (p
->name
, color_name
);
3194 p
->next
= xpm_color_cache
[bucket
];
3195 xpm_color_cache
[bucket
] = p
;
3199 /* Look up color COLOR_NAME for frame F in the color cache. If found,
3200 return the cached definition in *COLOR. Otherwise, make a new
3201 entry in the cache and allocate the color. Value is zero if color
3202 allocation failed. */
3205 xpm_lookup_color (struct frame
*f
, char *color_name
, XColor
*color
)
3207 struct xpm_cached_color
*p
;
3208 int h
= xpm_color_bucket (color_name
);
3210 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
3211 if (strcmp (p
->name
, color_name
) == 0)
3216 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
3219 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
3221 p
= xpm_cache_color (f
, color_name
, color
, h
);
3223 /* You get `opaque' at least from ImageMagick converting pbm to xpm
3224 with transparency, and it's useful. */
3225 else if (strcmp ("opaque", color_name
) == 0)
3227 memset (color
, 0, sizeof (XColor
)); /* Is this necessary/correct? */
3228 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
3229 p
= xpm_cache_color (f
, color_name
, color
, h
);
3236 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
3237 CLOSURE is a pointer to the frame on which we allocate the
3238 color. Return in *COLOR the allocated color. Value is non-zero
3242 xpm_alloc_color (Display
*dpy
, Colormap cmap
, char *color_name
, XColor
*color
,
3245 return xpm_lookup_color ((struct frame
*) closure
, color_name
, color
);
3249 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
3250 is a pointer to the frame on which we allocate the color. Value is
3251 non-zero if successful. */
3254 xpm_free_colors (Display
*dpy
, Colormap cmap
, Pixel
*pixels
, int npixels
, void *closure
)
3259 #endif /* ALLOC_XPM_COLORS */
3264 /* XPM library details. */
3266 DEF_IMGLIB_FN (void, XpmFreeAttributes
, (XpmAttributes
*));
3267 DEF_IMGLIB_FN (int, XpmCreateImageFromBuffer
, (Display
*, char *, xpm_XImage
**,
3268 xpm_XImage
**, XpmAttributes
*));
3269 DEF_IMGLIB_FN (int, XpmReadFileToImage
, (Display
*, char *, xpm_XImage
**,
3270 xpm_XImage
**, XpmAttributes
*));
3271 DEF_IMGLIB_FN (void, XImageFree
, (xpm_XImage
*));
3274 init_xpm_functions (Lisp_Object libraries
)
3278 if (!(library
= w32_delayed_load (libraries
, Qxpm
)))
3281 LOAD_IMGLIB_FN (library
, XpmFreeAttributes
);
3282 LOAD_IMGLIB_FN (library
, XpmCreateImageFromBuffer
);
3283 LOAD_IMGLIB_FN (library
, XpmReadFileToImage
);
3284 LOAD_IMGLIB_FN (library
, XImageFree
);
3288 #endif /* HAVE_NTGUI */
3291 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
3292 for XPM images. Such a list must consist of conses whose car and
3296 xpm_valid_color_symbols_p (Lisp_Object color_symbols
)
3298 while (CONSP (color_symbols
))
3300 Lisp_Object sym
= XCAR (color_symbols
);
3302 || !STRINGP (XCAR (sym
))
3303 || !STRINGP (XCDR (sym
)))
3305 color_symbols
= XCDR (color_symbols
);
3308 return NILP (color_symbols
);
3312 /* Value is non-zero if OBJECT is a valid XPM image specification. */
3315 xpm_image_p (Lisp_Object object
)
3317 struct image_keyword fmt
[XPM_LAST
];
3318 memcpy (fmt
, xpm_format
, sizeof fmt
);
3319 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
3320 /* Either `:file' or `:data' must be present. */
3321 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
3322 /* Either no `:color-symbols' or it's a list of conses
3323 whose car and cdr are strings. */
3324 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
3325 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
3328 #endif /* HAVE_XPM || HAVE_NS */
3330 #if defined HAVE_XPM && defined HAVE_X_WINDOWS && !defined USE_GTK
3332 x_create_bitmap_from_xpm_data (struct frame
*f
, const char **bits
)
3334 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
3337 XpmAttributes attrs
;
3338 Pixmap bitmap
, mask
;
3340 memset (&attrs
, 0, sizeof attrs
);
3342 attrs
.visual
= FRAME_X_VISUAL (f
);
3343 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3344 attrs
.valuemask
|= XpmVisual
;
3345 attrs
.valuemask
|= XpmColormap
;
3347 rc
= XpmCreatePixmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3348 (char **) bits
, &bitmap
, &mask
, &attrs
);
3349 if (rc
!= XpmSuccess
)
3351 XpmFreeAttributes (&attrs
);
3355 id
= x_allocate_bitmap_record (f
);
3356 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
3357 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
3358 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
3359 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
3360 dpyinfo
->bitmaps
[id
- 1].height
= attrs
.height
;
3361 dpyinfo
->bitmaps
[id
- 1].width
= attrs
.width
;
3362 dpyinfo
->bitmaps
[id
- 1].depth
= attrs
.depth
;
3363 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
3365 XpmFreeAttributes (&attrs
);
3368 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
3370 /* Load image IMG which will be displayed on frame F. Value is
3371 non-zero if successful. */
3376 xpm_load (struct frame
*f
, struct image
*img
)
3379 XpmAttributes attrs
;
3380 Lisp_Object specified_file
, color_symbols
;
3383 xpm_XImage
* xpm_image
= NULL
, * xpm_mask
= NULL
;
3384 #endif /* HAVE_NTGUI */
3386 /* Configure the XPM lib. Use the visual of frame F. Allocate
3387 close colors. Return colors allocated. */
3388 memset (&attrs
, 0, sizeof attrs
);
3391 attrs
.visual
= FRAME_X_VISUAL (f
);
3392 attrs
.colormap
= FRAME_X_COLORMAP (f
);
3393 attrs
.valuemask
|= XpmVisual
;
3394 attrs
.valuemask
|= XpmColormap
;
3395 #endif /* HAVE_NTGUI */
3397 #ifdef ALLOC_XPM_COLORS
3398 /* Allocate colors with our own functions which handle
3399 failing color allocation more gracefully. */
3400 attrs
.color_closure
= f
;
3401 attrs
.alloc_color
= xpm_alloc_color
;
3402 attrs
.free_colors
= xpm_free_colors
;
3403 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
3404 #else /* not ALLOC_XPM_COLORS */
3405 /* Let the XPM lib allocate colors. */
3406 attrs
.valuemask
|= XpmReturnAllocPixels
;
3407 #ifdef XpmAllocCloseColors
3408 attrs
.alloc_close_colors
= 1;
3409 attrs
.valuemask
|= XpmAllocCloseColors
;
3410 #else /* not XpmAllocCloseColors */
3411 attrs
.closeness
= 600;
3412 attrs
.valuemask
|= XpmCloseness
;
3413 #endif /* not XpmAllocCloseColors */
3414 #endif /* ALLOC_XPM_COLORS */
3416 /* If image specification contains symbolic color definitions, add
3417 these to `attrs'. */
3418 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3419 if (CONSP (color_symbols
))
3422 XpmColorSymbol
*xpm_syms
;
3425 attrs
.valuemask
|= XpmColorSymbols
;
3427 /* Count number of symbols. */
3428 attrs
.numsymbols
= 0;
3429 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
3432 /* Allocate an XpmColorSymbol array. */
3433 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
3434 xpm_syms
= (XpmColorSymbol
*) alloca (size
);
3435 memset (xpm_syms
, 0, size
);
3436 attrs
.colorsymbols
= xpm_syms
;
3438 /* Fill the color symbol array. */
3439 for (tail
= color_symbols
, i
= 0;
3441 ++i
, tail
= XCDR (tail
))
3445 char *empty_string
= (char *) "";
3447 if (!CONSP (XCAR (tail
)))
3449 xpm_syms
[i
].name
= empty_string
;
3450 xpm_syms
[i
].value
= empty_string
;
3453 name
= XCAR (XCAR (tail
));
3454 color
= XCDR (XCAR (tail
));
3457 xpm_syms
[i
].name
= (char *) alloca (SCHARS (name
) + 1);
3458 strcpy (xpm_syms
[i
].name
, SSDATA (name
));
3461 xpm_syms
[i
].name
= empty_string
;
3462 if (STRINGP (color
))
3464 xpm_syms
[i
].value
= (char *) alloca (SCHARS (color
) + 1);
3465 strcpy (xpm_syms
[i
].value
, SSDATA (color
));
3468 xpm_syms
[i
].value
= empty_string
;
3472 /* Create a pixmap for the image, either from a file, or from a
3473 string buffer containing data in the same format as an XPM file. */
3474 #ifdef ALLOC_XPM_COLORS
3475 xpm_init_color_cache (f
, &attrs
);
3478 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
3482 HDC frame_dc
= get_frame_dc (f
);
3483 hdc
= CreateCompatibleDC (frame_dc
);
3484 release_frame_dc (f
, frame_dc
);
3486 #endif /* HAVE_NTGUI */
3488 if (STRINGP (specified_file
))
3490 Lisp_Object file
= x_find_image_file (specified_file
);
3491 if (!STRINGP (file
))
3493 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
3494 #ifdef ALLOC_XPM_COLORS
3495 xpm_free_color_cache ();
3501 /* XpmReadFileToPixmap is not available in the Windows port of
3502 libxpm. But XpmReadFileToImage almost does what we want. */
3503 rc
= fn_XpmReadFileToImage (&hdc
, SDATA (file
),
3504 &xpm_image
, &xpm_mask
,
3507 rc
= XpmReadFileToPixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3508 SSDATA (file
), &img
->pixmap
, &img
->mask
,
3510 #endif /* HAVE_NTGUI */
3514 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
3515 if (!STRINGP (buffer
))
3517 image_error ("Invalid image data `%s'", buffer
, Qnil
);
3518 #ifdef ALLOC_XPM_COLORS
3519 xpm_free_color_cache ();
3524 /* XpmCreatePixmapFromBuffer is not available in the Windows port
3525 of libxpm. But XpmCreateImageFromBuffer almost does what we want. */
3526 rc
= fn_XpmCreateImageFromBuffer (&hdc
, SDATA (buffer
),
3527 &xpm_image
, &xpm_mask
,
3530 rc
= XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3532 &img
->pixmap
, &img
->mask
,
3534 #endif /* HAVE_NTGUI */
3537 if (rc
== XpmSuccess
)
3539 #if defined (COLOR_TABLE_SUPPORT) && defined (ALLOC_XPM_COLORS)
3540 img
->colors
= colors_in_color_table (&img
->ncolors
);
3541 #else /* not ALLOC_XPM_COLORS */
3545 /* W32 XPM uses XImage to wrap what W32 Emacs calls a Pixmap,
3546 plus some duplicate attributes. */
3547 if (xpm_image
&& xpm_image
->bitmap
)
3549 img
->pixmap
= xpm_image
->bitmap
;
3550 /* XImageFree in libXpm frees XImage struct without destroying
3551 the bitmap, which is what we want. */
3552 fn_XImageFree (xpm_image
);
3554 if (xpm_mask
&& xpm_mask
->bitmap
)
3556 /* The mask appears to be inverted compared with what we expect.
3557 TODO: invert our expectations. See other places where we
3558 have to invert bits because our idea of masks is backwards. */
3560 old_obj
= SelectObject (hdc
, xpm_mask
->bitmap
);
3562 PatBlt (hdc
, 0, 0, xpm_mask
->width
, xpm_mask
->height
, DSTINVERT
);
3563 SelectObject (hdc
, old_obj
);
3565 img
->mask
= xpm_mask
->bitmap
;
3566 fn_XImageFree (xpm_mask
);
3571 #endif /* HAVE_NTGUI */
3573 /* Remember allocated colors. */
3574 img
->colors
= xnmalloc (attrs
.nalloc_pixels
, sizeof *img
->colors
);
3575 img
->ncolors
= attrs
.nalloc_pixels
;
3576 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
3578 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
3579 #ifdef DEBUG_X_COLORS
3580 register_color (img
->colors
[i
]);
3583 #endif /* not ALLOC_XPM_COLORS */
3585 img
->width
= attrs
.width
;
3586 img
->height
= attrs
.height
;
3587 xassert (img
->width
> 0 && img
->height
> 0);
3589 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
3591 fn_XpmFreeAttributes (&attrs
);
3593 XpmFreeAttributes (&attrs
);
3594 #endif /* HAVE_NTGUI */
3600 #endif /* HAVE_NTGUI */
3605 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
3608 case XpmFileInvalid
:
3609 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
3613 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
3616 case XpmColorFailed
:
3617 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
3621 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
3626 #ifdef ALLOC_XPM_COLORS
3627 xpm_free_color_cache ();
3629 return rc
== XpmSuccess
;
3632 #endif /* HAVE_XPM */
3634 #if defined (HAVE_NS) && !defined (HAVE_XPM)
3636 /* XPM support functions for NS where libxpm is not available.
3637 Only XPM version 3 (without any extensions) is supported. */
3639 static void xpm_put_color_table_v (Lisp_Object
, const unsigned char *,
3641 static Lisp_Object
xpm_get_color_table_v (Lisp_Object
,
3642 const unsigned char *, int);
3643 static void xpm_put_color_table_h (Lisp_Object
, const unsigned char *,
3645 static Lisp_Object
xpm_get_color_table_h (Lisp_Object
,
3646 const unsigned char *, int);
3648 /* Tokens returned from xpm_scan. */
3657 /* Scan an XPM data and return a character (< 256) or a token defined
3658 by enum xpm_token above. *S and END are the start (inclusive) and
3659 the end (exclusive) addresses of the data, respectively. Advance
3660 *S while scanning. If token is either XPM_TK_IDENT or
3661 XPM_TK_STRING, *BEG and *LEN are set to the start address and the
3662 length of the corresponding token, respectively. */
3665 xpm_scan (const unsigned char **s
,
3666 const unsigned char *end
,
3667 const unsigned char **beg
,
3674 /* Skip white-space. */
3675 while (*s
< end
&& (c
= *(*s
)++, isspace (c
)))
3678 /* gnus-pointer.xpm uses '-' in its identifier.
3679 sb-dir-plus.xpm uses '+' in its identifier. */
3680 if (isalpha (c
) || c
== '_' || c
== '-' || c
== '+')
3684 && (c
= **s
, isalnum (c
) || c
== '_' || c
== '-' || c
== '+'))
3687 return XPM_TK_IDENT
;
3692 while (*s
< end
&& **s
!= '"')
3697 return XPM_TK_STRING
;
3701 if (*s
< end
&& **s
== '*')
3703 /* C-style comment. */
3707 while (*s
< end
&& *(*s
)++ != '*')
3710 while (*s
< end
&& **s
!= '/');
3724 /* Functions for color table lookup in XPM data. A key is a string
3725 specifying the color of each pixel in XPM data. A value is either
3726 an integer that specifies a pixel color, Qt that specifies
3727 transparency, or Qnil for the unspecified color. If the length of
3728 the key string is one, a vector is used as a table. Otherwise, a
3729 hash table is used. */
3732 xpm_make_color_table_v (void (**put_func
) (Lisp_Object
,
3733 const unsigned char *,
3736 Lisp_Object (**get_func
) (Lisp_Object
,
3737 const unsigned char *,
3740 *put_func
= xpm_put_color_table_v
;
3741 *get_func
= xpm_get_color_table_v
;
3742 return Fmake_vector (make_number (256), Qnil
);
3746 xpm_put_color_table_v (Lisp_Object color_table
,
3747 const unsigned char *chars_start
,
3751 XVECTOR (color_table
)->contents
[*chars_start
] = color
;
3755 xpm_get_color_table_v (Lisp_Object color_table
,
3756 const unsigned char *chars_start
,
3759 return XVECTOR (color_table
)->contents
[*chars_start
];
3763 xpm_make_color_table_h (void (**put_func
) (Lisp_Object
,
3764 const unsigned char *,
3767 Lisp_Object (**get_func
) (Lisp_Object
,
3768 const unsigned char *,
3771 *put_func
= xpm_put_color_table_h
;
3772 *get_func
= xpm_get_color_table_h
;
3773 return make_hash_table (Qequal
, make_number (DEFAULT_HASH_SIZE
),
3774 make_float (DEFAULT_REHASH_SIZE
),
3775 make_float (DEFAULT_REHASH_THRESHOLD
),
3780 xpm_put_color_table_h (Lisp_Object color_table
,
3781 const unsigned char *chars_start
,
3785 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3786 EMACS_UINT hash_code
;
3787 Lisp_Object chars
= make_unibyte_string (chars_start
, chars_len
);
3789 hash_lookup (table
, chars
, &hash_code
);
3790 hash_put (table
, chars
, color
, hash_code
);
3794 xpm_get_color_table_h (Lisp_Object color_table
,
3795 const unsigned char *chars_start
,
3798 struct Lisp_Hash_Table
*table
= XHASH_TABLE (color_table
);
3800 hash_lookup (table
, make_unibyte_string (chars_start
, chars_len
), NULL
);
3802 return i
>= 0 ? HASH_VALUE (table
, i
) : Qnil
;
3805 enum xpm_color_key
{
3813 static const char xpm_color_key_strings
[][4] = {"s", "m", "g4", "g", "c"};
3816 xpm_str_to_color_key (const char *s
)
3821 i
< sizeof xpm_color_key_strings
/ sizeof xpm_color_key_strings
[0];
3823 if (strcmp (xpm_color_key_strings
[i
], s
) == 0)
3829 xpm_load_image (struct frame
*f
,
3831 const unsigned char *contents
,
3832 const unsigned char *end
)
3834 const unsigned char *s
= contents
, *beg
, *str
;
3835 unsigned char buffer
[BUFSIZ
];
3836 int width
, height
, x
, y
;
3837 int num_colors
, chars_per_pixel
;
3840 void (*put_color_table
) (Lisp_Object
, const unsigned char *, int, Lisp_Object
);
3841 Lisp_Object (*get_color_table
) (Lisp_Object
, const unsigned char *, int);
3842 Lisp_Object frame
, color_symbols
, color_table
;
3843 int best_key
, have_mask
= 0;
3844 XImagePtr ximg
= NULL
, mask_img
= NULL
;
3847 LA1 = xpm_scan (&s, end, &beg, &len)
3849 #define expect(TOKEN) \
3850 if (LA1 != (TOKEN)) \
3855 #define expect_ident(IDENT) \
3856 if (LA1 == XPM_TK_IDENT \
3857 && strlen ((IDENT)) == len && memcmp ((IDENT), beg, len) == 0) \
3862 if (!(end
- s
>= 9 && memcmp (s
, "/* XPM */", 9) == 0))
3866 expect_ident ("static");
3867 expect_ident ("char");
3869 expect (XPM_TK_IDENT
);
3874 expect (XPM_TK_STRING
);
3877 memcpy (buffer
, beg
, len
);
3879 if (sscanf (buffer
, "%d %d %d %d", &width
, &height
,
3880 &num_colors
, &chars_per_pixel
) != 4
3881 || width
<= 0 || height
<= 0
3882 || num_colors
<= 0 || chars_per_pixel
<= 0)
3885 if (!check_image_size (f
, width
, height
))
3887 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
3891 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
3892 &ximg
, &img
->pixmap
)
3894 || !x_create_x_image_and_pixmap (f
, width
, height
, 1,
3895 &mask_img
, &img
->mask
)
3899 image_error ("Image too large", Qnil
, Qnil
);
3905 XSETFRAME (frame
, f
);
3906 if (!NILP (Fxw_display_color_p (frame
)))
3907 best_key
= XPM_COLOR_KEY_C
;
3908 else if (!NILP (Fx_display_grayscale_p (frame
)))
3909 best_key
= (XFASTINT (Fx_display_planes (frame
)) > 2
3910 ? XPM_COLOR_KEY_G
: XPM_COLOR_KEY_G4
);
3912 best_key
= XPM_COLOR_KEY_M
;
3914 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
3915 if (chars_per_pixel
== 1)
3916 color_table
= xpm_make_color_table_v (&put_color_table
,
3919 color_table
= xpm_make_color_table_h (&put_color_table
,
3922 while (num_colors
-- > 0)
3924 char *color
, *max_color
;
3925 int key
, next_key
, max_key
= 0;
3926 Lisp_Object symbol_color
= Qnil
, color_val
;
3929 expect (XPM_TK_STRING
);
3930 if (len
<= chars_per_pixel
|| len
>= BUFSIZ
+ chars_per_pixel
)
3932 memcpy (buffer
, beg
+ chars_per_pixel
, len
- chars_per_pixel
);
3933 buffer
[len
- chars_per_pixel
] = '\0';
3935 str
= strtok (buffer
, " \t");
3938 key
= xpm_str_to_color_key (str
);
3943 color
= strtok (NULL
, " \t");
3947 while ((str
= strtok (NULL
, " \t")) != NULL
)
3949 next_key
= xpm_str_to_color_key (str
);
3952 color
[strlen (color
)] = ' ';
3955 if (key
== XPM_COLOR_KEY_S
)
3957 if (NILP (symbol_color
))
3958 symbol_color
= build_string (color
);
3960 else if (max_key
< key
&& key
<= best_key
)
3970 if (!NILP (color_symbols
) && !NILP (symbol_color
))
3972 Lisp_Object specified_color
= Fassoc (symbol_color
, color_symbols
);
3974 if (CONSP (specified_color
) && STRINGP (XCDR (specified_color
)))
3976 if (xstrcasecmp (SSDATA (XCDR (specified_color
)), "None") == 0)
3978 else if (x_defined_color (f
, SDATA (XCDR (specified_color
)),
3980 color_val
= make_number (cdef
.pixel
);
3983 if (NILP (color_val
) && max_key
> 0)
3985 if (xstrcasecmp (max_color
, "None") == 0)
3987 else if (x_defined_color (f
, max_color
, &cdef
, 0))
3988 color_val
= make_number (cdef
.pixel
);
3990 if (!NILP (color_val
))
3991 (*put_color_table
) (color_table
, beg
, chars_per_pixel
, color_val
);
3996 for (y
= 0; y
< height
; y
++)
3998 expect (XPM_TK_STRING
);
4000 if (len
< width
* chars_per_pixel
)
4002 for (x
= 0; x
< width
; x
++, str
+= chars_per_pixel
)
4004 Lisp_Object color_val
=
4005 (*get_color_table
) (color_table
, str
, chars_per_pixel
);
4007 XPutPixel (ximg
, x
, y
,
4008 (INTEGERP (color_val
) ? XINT (color_val
)
4009 : FRAME_FOREGROUND_PIXEL (f
)));
4011 XPutPixel (mask_img
, x
, y
,
4012 (!EQ (color_val
, Qt
) ? PIX_MASK_DRAW
4013 : (have_mask
= 1, PIX_MASK_RETAIN
)));
4015 if (EQ (color_val
, Qt
))
4016 ns_set_alpha (ximg
, x
, y
, 0);
4024 img
->height
= height
;
4026 /* Maybe fill in the background field while we have ximg handy. */
4027 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
4028 IMAGE_BACKGROUND (img
, f
, ximg
);
4030 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
4031 x_destroy_x_image (ximg
);
4035 /* Fill in the background_transparent field while we have the
4037 image_background_transparent (img
, f
, mask_img
);
4039 x_put_x_image (f
, mask_img
, img
->mask
, width
, height
);
4040 x_destroy_x_image (mask_img
);
4044 x_destroy_x_image (mask_img
);
4045 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
4046 img
->mask
= NO_PIXMAP
;
4052 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
4054 x_destroy_x_image (ximg
);
4055 x_destroy_x_image (mask_img
);
4056 x_clear_image (f
, img
);
4065 xpm_load (struct frame
*f
,
4069 Lisp_Object file_name
;
4071 /* If IMG->spec specifies a file name, create a non-file spec from it. */
4072 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
4073 if (STRINGP (file_name
))
4076 unsigned char *contents
;
4079 file
= x_find_image_file (file_name
);
4080 if (!STRINGP (file
))
4082 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
4086 contents
= slurp_file (SDATA (file
), &size
);
4087 if (contents
== NULL
)
4089 image_error ("Error loading XPM image `%s'", img
->spec
, Qnil
);
4093 success_p
= xpm_load_image (f
, img
, contents
, contents
+ size
);
4100 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
4101 if (!STRINGP (data
))
4103 image_error ("Invalid image data `%s'", data
, Qnil
);
4106 success_p
= xpm_load_image (f
, img
, SDATA (data
),
4107 SDATA (data
) + SBYTES (data
));
4113 #endif /* HAVE_NS && !HAVE_XPM */
4117 /***********************************************************************
4119 ***********************************************************************/
4121 #ifdef COLOR_TABLE_SUPPORT
4123 /* An entry in the color table mapping an RGB color to a pixel color. */
4128 unsigned long pixel
;
4130 /* Next in color table collision list. */
4131 struct ct_color
*next
;
4134 /* The bucket vector size to use. Must be prime. */
4138 /* Value is a hash of the RGB color given by R, G, and B. */
4140 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
4142 /* The color hash table. */
4144 static struct ct_color
**ct_table
;
4146 /* Number of entries in the color table. */
4148 static int ct_colors_allocated
;
4151 ct_colors_allocated_max
=
4153 min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof (unsigned long))
4156 /* Initialize the color table. */
4159 init_color_table (void)
4161 int size
= CT_SIZE
* sizeof (*ct_table
);
4162 ct_table
= (struct ct_color
**) xmalloc (size
);
4163 memset (ct_table
, 0, size
);
4164 ct_colors_allocated
= 0;
4168 /* Free memory associated with the color table. */
4171 free_color_table (void)
4174 struct ct_color
*p
, *next
;
4176 for (i
= 0; i
< CT_SIZE
; ++i
)
4177 for (p
= ct_table
[i
]; p
; p
= next
)
4188 /* Value is a pixel color for RGB color R, G, B on frame F. If an
4189 entry for that color already is in the color table, return the
4190 pixel color of that entry. Otherwise, allocate a new color for R,
4191 G, B, and make an entry in the color table. */
4193 static unsigned long
4194 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4196 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
4197 int i
= hash
% CT_SIZE
;
4199 Display_Info
*dpyinfo
;
4201 /* Handle TrueColor visuals specially, which improves performance by
4202 two orders of magnitude. Freeing colors on TrueColor visuals is
4203 a nop, and pixel colors specify RGB values directly. See also
4204 the Xlib spec, chapter 3.1. */
4205 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4206 if (dpyinfo
->red_bits
> 0)
4208 unsigned long pr
, pg
, pb
;
4210 /* Apply gamma-correction like normal color allocation does. */
4214 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
4215 gamma_correct (f
, &color
);
4216 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
4219 /* Scale down RGB values to the visual's bits per RGB, and shift
4220 them to the right position in the pixel color. Note that the
4221 original RGB values are 16-bit values, as usual in X. */
4222 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
4223 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
4224 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
4226 /* Assemble the pixel color. */
4227 return pr
| pg
| pb
;
4230 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4231 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
4237 #ifdef HAVE_X_WINDOWS
4245 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4246 return FRAME_FOREGROUND_PIXEL (f
);
4248 #ifdef HAVE_X_WINDOWS
4253 cmap
= FRAME_X_COLORMAP (f
);
4254 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4257 ++ct_colors_allocated
;
4258 p
= (struct ct_color
*) xmalloc (sizeof *p
);
4262 p
->pixel
= color
.pixel
;
4263 p
->next
= ct_table
[i
];
4267 return FRAME_FOREGROUND_PIXEL (f
);
4271 color
= PALETTERGB (r
, g
, b
);
4273 color
= RGB_TO_ULONG (r
, g
, b
);
4274 #endif /* HAVE_NTGUI */
4275 ++ct_colors_allocated
;
4276 p
= (struct ct_color
*) xmalloc (sizeof *p
);
4281 p
->next
= ct_table
[i
];
4283 #endif /* HAVE_X_WINDOWS */
4291 /* Look up pixel color PIXEL which is used on frame F in the color
4292 table. If not already present, allocate it. Value is PIXEL. */
4294 static unsigned long
4295 lookup_pixel_color (struct frame
*f
, unsigned long pixel
)
4297 int i
= pixel
% CT_SIZE
;
4300 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4301 if (p
->pixel
== pixel
)
4310 if (ct_colors_allocated_max
<= ct_colors_allocated
)
4311 return FRAME_FOREGROUND_PIXEL (f
);
4313 #ifdef HAVE_X_WINDOWS
4314 cmap
= FRAME_X_COLORMAP (f
);
4315 color
.pixel
= pixel
;
4316 x_query_color (f
, &color
);
4317 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4320 cmap
= DefaultColormapOfScreen (FRAME_X_SCREEN (f
));
4321 color
.pixel
= pixel
;
4322 XQueryColor (NULL
, cmap
, &color
);
4323 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
4325 #endif /* HAVE_X_WINDOWS */
4329 ++ct_colors_allocated
;
4331 p
= (struct ct_color
*) xmalloc (sizeof *p
);
4336 p
->next
= ct_table
[i
];
4340 return FRAME_FOREGROUND_PIXEL (f
);
4346 /* Value is a vector of all pixel colors contained in the color table,
4347 allocated via xmalloc. Set *N to the number of colors. */
4349 static unsigned long *
4350 colors_in_color_table (int *n
)
4354 unsigned long *colors
;
4356 if (ct_colors_allocated
== 0)
4363 colors
= (unsigned long *) xmalloc (ct_colors_allocated
4365 *n
= ct_colors_allocated
;
4367 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
4368 for (p
= ct_table
[i
]; p
; p
= p
->next
)
4369 colors
[j
++] = p
->pixel
;
4375 #else /* COLOR_TABLE_SUPPORT */
4377 static unsigned long
4378 lookup_rgb_color (struct frame
*f
, int r
, int g
, int b
)
4380 unsigned long pixel
;
4383 pixel
= PALETTERGB (r
>> 8, g
>> 8, b
>> 8);
4384 #endif /* HAVE_NTGUI */
4387 pixel
= RGB_TO_ULONG (r
>> 8, g
>> 8, b
>> 8);
4388 #endif /* HAVE_NS */
4393 init_color_table (void)
4396 #endif /* COLOR_TABLE_SUPPORT */
4399 /***********************************************************************
4401 ***********************************************************************/
4403 static XColor
*x_to_xcolors (struct frame
*, struct image
*, int);
4404 static void x_from_xcolors (struct frame
*, struct image
*, XColor
*);
4405 static void x_detect_edges (struct frame
*, struct image
*, int[9], int);
4408 static void XPutPixel (XImagePtr
, int, int, COLORREF
);
4409 #endif /* HAVE_NTGUI */
4411 /* Edge detection matrices for different edge-detection
4414 static int emboss_matrix
[9] = {
4416 2, -1, 0, /* y - 1 */
4418 0, 1, -2 /* y + 1 */
4421 static int laplace_matrix
[9] = {
4423 1, 0, 0, /* y - 1 */
4425 0, 0, -1 /* y + 1 */
4428 /* Value is the intensity of the color whose red/green/blue values
4431 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
4434 /* On frame F, return an array of XColor structures describing image
4435 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
4436 non-zero means also fill the red/green/blue members of the XColor
4437 structures. Value is a pointer to the array of XColors structures,
4438 allocated with xmalloc; it must be freed by the caller. */
4441 x_to_xcolors (struct frame
*f
, struct image
*img
, int rgb_p
)
4445 XImagePtr_or_DC ximg
;
4449 #endif /* HAVE_NTGUI */
4451 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *colors
/ img
->width
< img
->height
)
4452 memory_full (SIZE_MAX
);
4453 colors
= (XColor
*) xmalloc (sizeof *colors
* img
->width
* img
->height
);
4456 /* Get the X image IMG->pixmap. */
4457 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
4458 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
4460 /* Load the image into a memory device context. */
4461 hdc
= get_frame_dc (f
);
4462 ximg
= CreateCompatibleDC (hdc
);
4463 release_frame_dc (f
, hdc
);
4464 prev
= SelectObject (ximg
, img
->pixmap
);
4465 #endif /* HAVE_NTGUI */
4467 /* Fill the `pixel' members of the XColor array. I wished there
4468 were an easy and portable way to circumvent XGetPixel. */
4470 for (y
= 0; y
< img
->height
; ++y
)
4474 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
4475 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4476 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4478 x_query_colors (f
, row
, img
->width
);
4482 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4484 /* W32_TODO: palette support needed here? */
4485 p
->pixel
= GET_PIXEL (ximg
, x
, y
);
4488 p
->red
= RED16_FROM_ULONG (p
->pixel
);
4489 p
->green
= GREEN16_FROM_ULONG (p
->pixel
);
4490 p
->blue
= BLUE16_FROM_ULONG (p
->pixel
);
4493 #endif /* HAVE_X_WINDOWS */
4496 Destroy_Image (ximg
, prev
);
4503 /* Put a pixel of COLOR at position X, Y in XIMG. XIMG must have been
4504 created with CreateDIBSection, with the pointer to the bit values
4505 stored in ximg->data. */
4508 XPutPixel (XImagePtr ximg
, int x
, int y
, COLORREF color
)
4510 int width
= ximg
->info
.bmiHeader
.biWidth
;
4511 unsigned char * pixel
;
4513 /* True color images. */
4514 if (ximg
->info
.bmiHeader
.biBitCount
== 24)
4516 int rowbytes
= width
* 3;
4517 /* Ensure scanlines are aligned on 4 byte boundaries. */
4519 rowbytes
+= 4 - (rowbytes
% 4);
4521 pixel
= ximg
->data
+ y
* rowbytes
+ x
* 3;
4522 /* Windows bitmaps are in BGR order. */
4523 *pixel
= GetBValue (color
);
4524 *(pixel
+ 1) = GetGValue (color
);
4525 *(pixel
+ 2) = GetRValue (color
);
4527 /* Monochrome images. */
4528 else if (ximg
->info
.bmiHeader
.biBitCount
== 1)
4530 int rowbytes
= width
/ 8;
4531 /* Ensure scanlines are aligned on 4 byte boundaries. */
4533 rowbytes
+= 4 - (rowbytes
% 4);
4534 pixel
= ximg
->data
+ y
* rowbytes
+ x
/ 8;
4535 /* Filter out palette info. */
4536 if (color
& 0x00ffffff)
4537 *pixel
= *pixel
| (1 << x
% 8);
4539 *pixel
= *pixel
& ~(1 << x
% 8);
4542 image_error ("XPutPixel: palette image not supported", Qnil
, Qnil
);
4545 #endif /* HAVE_NTGUI */
4547 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
4548 RGB members are set. F is the frame on which this all happens.
4549 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
4552 x_from_xcolors (struct frame
*f
, struct image
*img
, XColor
*colors
)
4555 XImagePtr oimg
= NULL
;
4559 init_color_table ();
4561 x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 0,
4564 for (y
= 0; y
< img
->height
; ++y
)
4565 for (x
= 0; x
< img
->width
; ++x
, ++p
)
4567 unsigned long pixel
;
4568 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
4569 XPutPixel (oimg
, x
, y
, pixel
);
4573 x_clear_image_1 (f
, img
, 1, 0, 1);
4575 x_put_x_image (f
, oimg
, pixmap
, img
->width
, img
->height
);
4576 x_destroy_x_image (oimg
);
4577 img
->pixmap
= pixmap
;
4578 #ifdef COLOR_TABLE_SUPPORT
4579 img
->colors
= colors_in_color_table (&img
->ncolors
);
4580 free_color_table ();
4581 #endif /* COLOR_TABLE_SUPPORT */
4585 /* On frame F, perform edge-detection on image IMG.
4587 MATRIX is a nine-element array specifying the transformation
4588 matrix. See emboss_matrix for an example.
4590 COLOR_ADJUST is a color adjustment added to each pixel of the
4594 x_detect_edges (struct frame
*f
, struct image
*img
, int *matrix
, int color_adjust
)
4596 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4600 for (i
= sum
= 0; i
< 9; ++i
)
4601 sum
+= eabs (matrix
[i
]);
4603 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
4605 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *new / img
->width
< img
->height
)
4606 memory_full (SIZE_MAX
);
4607 new = (XColor
*) xmalloc (sizeof *new * img
->width
* img
->height
);
4609 for (y
= 0; y
< img
->height
; ++y
)
4611 p
= COLOR (new, 0, y
);
4612 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4613 p
= COLOR (new, img
->width
- 1, y
);
4614 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4617 for (x
= 1; x
< img
->width
- 1; ++x
)
4619 p
= COLOR (new, x
, 0);
4620 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4621 p
= COLOR (new, x
, img
->height
- 1);
4622 p
->red
= p
->green
= p
->blue
= 0xffff/2;
4625 for (y
= 1; y
< img
->height
- 1; ++y
)
4627 p
= COLOR (new, 1, y
);
4629 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
4631 int r
, g
, b
, yy
, xx
;
4634 for (yy
= y
- 1; yy
< y
+ 2; ++yy
)
4635 for (xx
= x
- 1; xx
< x
+ 2; ++xx
, ++i
)
4638 XColor
*t
= COLOR (colors
, xx
, yy
);
4639 r
+= matrix
[i
] * t
->red
;
4640 g
+= matrix
[i
] * t
->green
;
4641 b
+= matrix
[i
] * t
->blue
;
4644 r
= (r
/ sum
+ color_adjust
) & 0xffff;
4645 g
= (g
/ sum
+ color_adjust
) & 0xffff;
4646 b
= (b
/ sum
+ color_adjust
) & 0xffff;
4647 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
4652 x_from_xcolors (f
, img
, new);
4658 /* Perform the pre-defined `emboss' edge-detection on image IMG
4662 x_emboss (struct frame
*f
, struct image
*img
)
4664 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
4668 /* Transform image IMG which is used on frame F with a Laplace
4669 edge-detection algorithm. The result is an image that can be used
4670 to draw disabled buttons, for example. */
4673 x_laplace (struct frame
*f
, struct image
*img
)
4675 x_detect_edges (f
, img
, laplace_matrix
, 45000);
4679 /* Perform edge-detection on image IMG on frame F, with specified
4680 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
4682 MATRIX must be either
4684 - a list of at least 9 numbers in row-major form
4685 - a vector of at least 9 numbers
4687 COLOR_ADJUST nil means use a default; otherwise it must be a
4691 x_edge_detection (struct frame
*f
, struct image
*img
, Lisp_Object matrix
,
4692 Lisp_Object color_adjust
)
4700 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
4701 ++i
, matrix
= XCDR (matrix
))
4702 trans
[i
] = XFLOATINT (XCAR (matrix
));
4704 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
4706 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
4707 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
4710 if (NILP (color_adjust
))
4711 color_adjust
= make_number (0xffff / 2);
4713 if (i
== 9 && NUMBERP (color_adjust
))
4714 x_detect_edges (f
, img
, trans
, XFLOATINT (color_adjust
));
4718 /* Transform image IMG on frame F so that it looks disabled. */
4721 x_disable_image (struct frame
*f
, struct image
*img
)
4723 Display_Info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
4725 int n_planes
= dpyinfo
->n_planes
* dpyinfo
->n_cbits
;
4727 int n_planes
= dpyinfo
->n_planes
;
4728 #endif /* HAVE_NTGUI */
4732 /* Color (or grayscale). Convert to gray, and equalize. Just
4733 drawing such images with a stipple can look very odd, so
4734 we're using this method instead. */
4735 XColor
*colors
= x_to_xcolors (f
, img
, 1);
4737 const int h
= 15000;
4738 const int l
= 30000;
4740 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
4744 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
4745 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
4746 p
->red
= p
->green
= p
->blue
= i2
;
4749 x_from_xcolors (f
, img
, colors
);
4752 /* Draw a cross over the disabled image, if we must or if we
4754 if (n_planes
< 2 || cross_disabled_images
)
4757 Display
*dpy
= FRAME_X_DISPLAY (f
);
4760 #ifndef HAVE_NS /* TODO: NS support, however this not needed for toolbars */
4762 #define MaskForeground(f) WHITE_PIX_DEFAULT (f)
4764 gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
4765 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
4766 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
4767 img
->width
- 1, img
->height
- 1);
4768 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
4774 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
4775 XSetForeground (dpy
, gc
, MaskForeground (f
));
4776 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
4777 img
->width
- 1, img
->height
- 1);
4778 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
4782 #endif /* !HAVE_NS */
4787 hdc
= get_frame_dc (f
);
4788 bmpdc
= CreateCompatibleDC (hdc
);
4789 release_frame_dc (f
, hdc
);
4791 prev
= SelectObject (bmpdc
, img
->pixmap
);
4793 SetTextColor (bmpdc
, BLACK_PIX_DEFAULT (f
));
4794 MoveToEx (bmpdc
, 0, 0, NULL
);
4795 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4796 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4797 LineTo (bmpdc
, img
->width
- 1, 0);
4801 SelectObject (bmpdc
, img
->mask
);
4802 SetTextColor (bmpdc
, WHITE_PIX_DEFAULT (f
));
4803 MoveToEx (bmpdc
, 0, 0, NULL
);
4804 LineTo (bmpdc
, img
->width
- 1, img
->height
- 1);
4805 MoveToEx (bmpdc
, 0, img
->height
- 1, NULL
);
4806 LineTo (bmpdc
, img
->width
- 1, 0);
4808 SelectObject (bmpdc
, prev
);
4810 #endif /* HAVE_NTGUI */
4815 /* Build a mask for image IMG which is used on frame F. FILE is the
4816 name of an image file, for error messages. HOW determines how to
4817 determine the background color of IMG. If it is a list '(R G B)',
4818 with R, G, and B being integers >= 0, take that as the color of the
4819 background. Otherwise, determine the background color of IMG
4820 heuristically. Value is non-zero if successful. */
4823 x_build_heuristic_mask (struct frame
*f
, struct image
*img
, Lisp_Object how
)
4825 XImagePtr_or_DC ximg
;
4833 #endif /* HAVE_NTGUI */
4834 int x
, y
, rc
, use_img_background
;
4835 unsigned long bg
= 0;
4839 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->mask
);
4840 img
->mask
= NO_PIXMAP
;
4841 img
->background_transparent_valid
= 0;
4846 /* Create an image and pixmap serving as mask. */
4847 rc
= x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 1,
4848 &mask_img
, &img
->mask
);
4851 #endif /* !HAVE_NS */
4853 /* Get the X image of IMG->pixmap. */
4854 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
, 0, 0,
4855 img
->width
, img
->height
,
4858 /* Create the bit array serving as mask. */
4859 row_width
= (img
->width
+ 7) / 8;
4860 mask_img
= xmalloc (row_width
* img
->height
);
4861 memset (mask_img
, 0, row_width
* img
->height
);
4863 /* Create a memory device context for IMG->pixmap. */
4864 frame_dc
= get_frame_dc (f
);
4865 ximg
= CreateCompatibleDC (frame_dc
);
4866 release_frame_dc (f
, frame_dc
);
4867 prev
= SelectObject (ximg
, img
->pixmap
);
4868 #endif /* HAVE_NTGUI */
4870 /* Determine the background color of ximg. If HOW is `(R G B)'
4871 take that as color. Otherwise, use the image's background color. */
4872 use_img_background
= 1;
4878 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
4880 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
4884 if (i
== 3 && NILP (how
))
4886 char color_name
[30];
4887 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
4890 0x00ffffff & /* Filter out palette info. */
4891 #endif /* HAVE_NTGUI */
4892 x_alloc_image_color (f
, img
, build_string (color_name
), 0));
4893 use_img_background
= 0;
4897 if (use_img_background
)
4898 bg
= four_corners_best (ximg
, img
->corners
, img
->width
, img
->height
);
4900 /* Set all bits in mask_img to 1 whose color in ximg is different
4901 from the background color bg. */
4903 for (y
= 0; y
< img
->height
; ++y
)
4904 for (x
= 0; x
< img
->width
; ++x
)
4906 XPutPixel (mask_img
, x
, y
, (XGetPixel (ximg
, x
, y
) != bg
4907 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
));
4909 if (XGetPixel (ximg
, x
, y
) == bg
)
4910 ns_set_alpha (ximg
, x
, y
, 0);
4911 #endif /* HAVE_NS */
4913 /* Fill in the background_transparent field while we have the mask handy. */
4914 image_background_transparent (img
, f
, mask_img
);
4916 /* Put mask_img into img->mask. */
4917 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
4918 x_destroy_x_image (mask_img
);
4919 #endif /* !HAVE_NS */
4921 for (y
= 0; y
< img
->height
; ++y
)
4922 for (x
= 0; x
< img
->width
; ++x
)
4924 COLORREF p
= GetPixel (ximg
, x
, y
);
4926 mask_img
[y
* row_width
+ x
/ 8] |= 1 << (x
% 8);
4929 /* Create the mask image. */
4930 img
->mask
= w32_create_pixmap_from_bitmap_data (img
->width
, img
->height
,
4932 /* Fill in the background_transparent field while we have the mask handy. */
4933 SelectObject (ximg
, img
->mask
);
4934 image_background_transparent (img
, f
, ximg
);
4936 /* Was: x_destroy_x_image ((XImagePtr )mask_img); which seems bogus ++kfs */
4938 #endif /* HAVE_NTGUI */
4940 Destroy_Image (ximg
, prev
);
4946 /***********************************************************************
4947 PBM (mono, gray, color)
4948 ***********************************************************************/
4950 static int pbm_image_p (Lisp_Object object
);
4951 static int pbm_load (struct frame
*f
, struct image
*img
);
4952 static int pbm_scan_number (unsigned char **, unsigned char *);
4954 /* The symbol `pbm' identifying images of this type. */
4956 static Lisp_Object Qpbm
;
4958 /* Indices of image specification fields in gs_format, below. */
4960 enum pbm_keyword_index
4976 /* Vector of image_keyword structures describing the format
4977 of valid user-defined image specifications. */
4979 static const struct image_keyword pbm_format
[PBM_LAST
] =
4981 {":type", IMAGE_SYMBOL_VALUE
, 1},
4982 {":file", IMAGE_STRING_VALUE
, 0},
4983 {":data", IMAGE_STRING_VALUE
, 0},
4984 {":ascent", IMAGE_ASCENT_VALUE
, 0},
4985 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
4986 {":relief", IMAGE_INTEGER_VALUE
, 0},
4987 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4988 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4989 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
4990 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
4991 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
4994 /* Structure describing the image type `pbm'. */
4996 static struct image_type pbm_type
=
5006 /* Return non-zero if OBJECT is a valid PBM image specification. */
5009 pbm_image_p (Lisp_Object object
)
5011 struct image_keyword fmt
[PBM_LAST
];
5013 memcpy (fmt
, pbm_format
, sizeof fmt
);
5015 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
5018 /* Must specify either :data or :file. */
5019 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
5023 /* Scan a decimal number from *S and return it. Advance *S while
5024 reading the number. END is the end of the string. Value is -1 at
5028 pbm_scan_number (unsigned char **s
, unsigned char *end
)
5030 int c
= 0, val
= -1;
5034 /* Skip white-space. */
5035 while (*s
< end
&& (c
= *(*s
)++, isspace (c
)))
5040 /* Skip comment to end of line. */
5041 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n'))
5044 else if (isdigit (c
))
5046 /* Read decimal number. */
5048 while (*s
< end
&& (c
= *(*s
)++, isdigit (c
)))
5049 val
= 10 * val
+ c
- '0';
5061 #if 0 /* Unused. ++kfs */
5063 /* Read FILE into memory. Value is a pointer to a buffer allocated
5064 with xmalloc holding FILE's contents. Value is null if an error
5065 occurred. *SIZE is set to the size of the file. */
5068 pbm_read_file (Lisp_Object file
, int *size
)
5074 if (stat (SDATA (file
), &st
) == 0
5075 && (fp
= fopen (SDATA (file
), "rb")) != NULL
5076 && 0 <= st
.st_size
&& st
.st_size
<= min (PTRDIFF_MAX
, SIZE_MAX
)
5077 && (buf
= (char *) xmalloc (st
.st_size
),
5078 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
5097 #endif /* HAVE_NTGUI */
5099 /* Load PBM image IMG for use on frame F. */
5102 pbm_load (struct frame
*f
, struct image
*img
)
5105 int width
, height
, max_color_idx
= 0;
5107 Lisp_Object file
, specified_file
;
5108 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
5109 unsigned char *contents
= NULL
;
5110 unsigned char *end
, *p
;
5113 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5115 if (STRINGP (specified_file
))
5117 file
= x_find_image_file (specified_file
);
5118 if (!STRINGP (file
))
5120 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5124 contents
= slurp_file (SSDATA (file
), &size
);
5125 if (contents
== NULL
)
5127 image_error ("Error reading `%s'", file
, Qnil
);
5132 end
= contents
+ size
;
5137 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5138 if (!STRINGP (data
))
5140 image_error ("Invalid image data `%s'", data
, Qnil
);
5144 end
= p
+ SBYTES (data
);
5147 /* Check magic number. */
5148 if (end
- p
< 2 || *p
++ != 'P')
5150 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5159 raw_p
= 0, type
= PBM_MONO
;
5163 raw_p
= 0, type
= PBM_GRAY
;
5167 raw_p
= 0, type
= PBM_COLOR
;
5171 raw_p
= 1, type
= PBM_MONO
;
5175 raw_p
= 1, type
= PBM_GRAY
;
5179 raw_p
= 1, type
= PBM_COLOR
;
5183 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
5187 /* Read width, height, maximum color-component. Characters
5188 starting with `#' up to the end of a line are ignored. */
5189 width
= pbm_scan_number (&p
, end
);
5190 height
= pbm_scan_number (&p
, end
);
5192 if (type
!= PBM_MONO
)
5194 max_color_idx
= pbm_scan_number (&p
, end
);
5195 if (max_color_idx
> 65535 || max_color_idx
< 0)
5197 image_error ("Unsupported maximum PBM color value", Qnil
, Qnil
);
5202 if (!check_image_size (f
, width
, height
))
5204 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5208 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
5209 &ximg
, &img
->pixmap
))
5212 /* Initialize the color hash table. */
5213 init_color_table ();
5215 if (type
== PBM_MONO
)
5218 struct image_keyword fmt
[PBM_LAST
];
5219 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
5220 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
5222 /* Parse the image specification. */
5223 memcpy (fmt
, pbm_format
, sizeof fmt
);
5224 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
5226 /* Get foreground and background colors, maybe allocate colors. */
5227 if (fmt
[PBM_FOREGROUND
].count
5228 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
5229 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
5230 if (fmt
[PBM_BACKGROUND
].count
5231 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
5233 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
5234 img
->background
= bg
;
5235 img
->background_valid
= 1;
5238 for (y
= 0; y
< height
; ++y
)
5239 for (x
= 0; x
< width
; ++x
)
5247 x_destroy_x_image (ximg
);
5248 x_clear_image (f
, img
);
5249 image_error ("Invalid image size in image `%s'",
5259 g
= pbm_scan_number (&p
, end
);
5261 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
5266 int expected_size
= height
* width
;
5267 if (max_color_idx
> 255)
5269 if (type
== PBM_COLOR
)
5272 if (raw_p
&& p
+ expected_size
> end
)
5274 x_destroy_x_image (ximg
);
5275 x_clear_image (f
, img
);
5276 image_error ("Invalid image size in image `%s'",
5281 for (y
= 0; y
< height
; ++y
)
5282 for (x
= 0; x
< width
; ++x
)
5286 if (type
== PBM_GRAY
&& raw_p
)
5289 if (max_color_idx
> 255)
5290 r
= g
= b
= r
* 256 + *p
++;
5292 else if (type
== PBM_GRAY
)
5293 r
= g
= b
= pbm_scan_number (&p
, end
);
5297 if (max_color_idx
> 255)
5300 if (max_color_idx
> 255)
5303 if (max_color_idx
> 255)
5308 r
= pbm_scan_number (&p
, end
);
5309 g
= pbm_scan_number (&p
, end
);
5310 b
= pbm_scan_number (&p
, end
);
5313 if (r
< 0 || g
< 0 || b
< 0)
5315 x_destroy_x_image (ximg
);
5316 image_error ("Invalid pixel value in image `%s'",
5321 /* RGB values are now in the range 0..max_color_idx.
5322 Scale this to the range 0..0xffff supported by X. */
5323 r
= (double) r
* 65535 / max_color_idx
;
5324 g
= (double) g
* 65535 / max_color_idx
;
5325 b
= (double) b
* 65535 / max_color_idx
;
5326 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5330 #ifdef COLOR_TABLE_SUPPORT
5331 /* Store in IMG->colors the colors allocated for the image, and
5332 free the color table. */
5333 img
->colors
= colors_in_color_table (&img
->ncolors
);
5334 free_color_table ();
5335 #endif /* COLOR_TABLE_SUPPORT */
5338 img
->height
= height
;
5340 /* Maybe fill in the background field while we have ximg handy. */
5342 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5343 /* Casting avoids a GCC warning. */
5344 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5346 /* Put the image into a pixmap. */
5347 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
5348 x_destroy_x_image (ximg
);
5350 /* X and W32 versions did it here, MAC version above. ++kfs
5352 img->height = height; */
5359 /***********************************************************************
5361 ***********************************************************************/
5363 #if defined (HAVE_PNG) || defined (HAVE_NS)
5365 /* Function prototypes. */
5367 static int png_image_p (Lisp_Object object
);
5368 static int png_load (struct frame
*f
, struct image
*img
);
5370 /* The symbol `png' identifying images of this type. */
5372 static Lisp_Object Qpng
;
5374 /* Indices of image specification fields in png_format, below. */
5376 enum png_keyword_index
5391 /* Vector of image_keyword structures describing the format
5392 of valid user-defined image specifications. */
5394 static const struct image_keyword png_format
[PNG_LAST
] =
5396 {":type", IMAGE_SYMBOL_VALUE
, 1},
5397 {":data", IMAGE_STRING_VALUE
, 0},
5398 {":file", IMAGE_STRING_VALUE
, 0},
5399 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5400 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
5401 {":relief", IMAGE_INTEGER_VALUE
, 0},
5402 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5403 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5404 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5405 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
5408 /* Structure describing the image type `png'. */
5410 static struct image_type png_type
=
5419 /* Return non-zero if OBJECT is a valid PNG image specification. */
5422 png_image_p (Lisp_Object object
)
5424 struct image_keyword fmt
[PNG_LAST
];
5425 memcpy (fmt
, png_format
, sizeof fmt
);
5427 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
5430 /* Must specify either the :data or :file keyword. */
5431 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
5434 #endif /* HAVE_PNG || HAVE_NS */
5440 /* PNG library details. */
5442 DEF_IMGLIB_FN (png_voidp
, png_get_io_ptr
, (png_structp
));
5443 DEF_IMGLIB_FN (int, png_sig_cmp
, (png_bytep
, png_size_t
, png_size_t
));
5444 DEF_IMGLIB_FN (png_structp
, png_create_read_struct
, (png_const_charp
, png_voidp
,
5445 png_error_ptr
, png_error_ptr
));
5446 DEF_IMGLIB_FN (png_infop
, png_create_info_struct
, (png_structp
));
5447 DEF_IMGLIB_FN (void, png_destroy_read_struct
, (png_structpp
, png_infopp
, png_infopp
));
5448 DEF_IMGLIB_FN (void, png_set_read_fn
, (png_structp
, png_voidp
, png_rw_ptr
));
5449 DEF_IMGLIB_FN (void, png_set_sig_bytes
, (png_structp
, int));
5450 DEF_IMGLIB_FN (void, png_read_info
, (png_structp
, png_infop
));
5451 DEF_IMGLIB_FN (png_uint_32
, png_get_IHDR
, (png_structp
, png_infop
,
5452 png_uint_32
*, png_uint_32
*,
5453 int *, int *, int *, int *, int *));
5454 DEF_IMGLIB_FN (png_uint_32
, png_get_valid
, (png_structp
, png_infop
, png_uint_32
));
5455 DEF_IMGLIB_FN (void, png_set_strip_16
, (png_structp
));
5456 DEF_IMGLIB_FN (void, png_set_expand
, (png_structp
));
5457 DEF_IMGLIB_FN (void, png_set_gray_to_rgb
, (png_structp
));
5458 DEF_IMGLIB_FN (void, png_set_background
, (png_structp
, png_color_16p
,
5460 DEF_IMGLIB_FN (png_uint_32
, png_get_bKGD
, (png_structp
, png_infop
, png_color_16p
*));
5461 DEF_IMGLIB_FN (void, png_read_update_info
, (png_structp
, png_infop
));
5462 DEF_IMGLIB_FN (png_byte
, png_get_channels
, (png_structp
, png_infop
));
5463 DEF_IMGLIB_FN (png_size_t
, png_get_rowbytes
, (png_structp
, png_infop
));
5464 DEF_IMGLIB_FN (void, png_read_image
, (png_structp
, png_bytepp
));
5465 DEF_IMGLIB_FN (void, png_read_end
, (png_structp
, png_infop
));
5466 DEF_IMGLIB_FN (void, png_error
, (png_structp
, png_const_charp
));
5468 #if (PNG_LIBPNG_VER >= 10500)
5469 DEF_IMGLIB_FN (void, png_longjmp
, (png_structp
, int));
5470 DEF_IMGLIB_FN (jmp_buf *, png_set_longjmp_fn
, (png_structp
, png_longjmp_ptr
, size_t));
5471 #endif /* libpng version >= 1.5 */
5474 init_png_functions (Lisp_Object libraries
)
5478 if (!(library
= w32_delayed_load (libraries
, Qpng
)))
5481 LOAD_IMGLIB_FN (library
, png_get_io_ptr
);
5482 LOAD_IMGLIB_FN (library
, png_sig_cmp
);
5483 LOAD_IMGLIB_FN (library
, png_create_read_struct
);
5484 LOAD_IMGLIB_FN (library
, png_create_info_struct
);
5485 LOAD_IMGLIB_FN (library
, png_destroy_read_struct
);
5486 LOAD_IMGLIB_FN (library
, png_set_read_fn
);
5487 LOAD_IMGLIB_FN (library
, png_set_sig_bytes
);
5488 LOAD_IMGLIB_FN (library
, png_read_info
);
5489 LOAD_IMGLIB_FN (library
, png_get_IHDR
);
5490 LOAD_IMGLIB_FN (library
, png_get_valid
);
5491 LOAD_IMGLIB_FN (library
, png_set_strip_16
);
5492 LOAD_IMGLIB_FN (library
, png_set_expand
);
5493 LOAD_IMGLIB_FN (library
, png_set_gray_to_rgb
);
5494 LOAD_IMGLIB_FN (library
, png_set_background
);
5495 LOAD_IMGLIB_FN (library
, png_get_bKGD
);
5496 LOAD_IMGLIB_FN (library
, png_read_update_info
);
5497 LOAD_IMGLIB_FN (library
, png_get_channels
);
5498 LOAD_IMGLIB_FN (library
, png_get_rowbytes
);
5499 LOAD_IMGLIB_FN (library
, png_read_image
);
5500 LOAD_IMGLIB_FN (library
, png_read_end
);
5501 LOAD_IMGLIB_FN (library
, png_error
);
5503 #if (PNG_LIBPNG_VER >= 10500)
5504 LOAD_IMGLIB_FN (library
, png_longjmp
);
5505 LOAD_IMGLIB_FN (library
, png_set_longjmp_fn
);
5506 #endif /* libpng version >= 1.5 */
5512 #define fn_png_get_io_ptr png_get_io_ptr
5513 #define fn_png_sig_cmp png_sig_cmp
5514 #define fn_png_create_read_struct png_create_read_struct
5515 #define fn_png_create_info_struct png_create_info_struct
5516 #define fn_png_destroy_read_struct png_destroy_read_struct
5517 #define fn_png_set_read_fn png_set_read_fn
5518 #define fn_png_set_sig_bytes png_set_sig_bytes
5519 #define fn_png_read_info png_read_info
5520 #define fn_png_get_IHDR png_get_IHDR
5521 #define fn_png_get_valid png_get_valid
5522 #define fn_png_set_strip_16 png_set_strip_16
5523 #define fn_png_set_expand png_set_expand
5524 #define fn_png_set_gray_to_rgb png_set_gray_to_rgb
5525 #define fn_png_set_background png_set_background
5526 #define fn_png_get_bKGD png_get_bKGD
5527 #define fn_png_read_update_info png_read_update_info
5528 #define fn_png_get_channels png_get_channels
5529 #define fn_png_get_rowbytes png_get_rowbytes
5530 #define fn_png_read_image png_read_image
5531 #define fn_png_read_end png_read_end
5532 #define fn_png_error png_error
5534 #if (PNG_LIBPNG_VER >= 10500)
5535 #define fn_png_longjmp png_longjmp
5536 #define fn_png_set_longjmp_fn png_set_longjmp_fn
5537 #endif /* libpng version >= 1.5 */
5539 #endif /* HAVE_NTGUI */
5542 #if (PNG_LIBPNG_VER < 10500)
5543 #define PNG_LONGJMP(ptr) (longjmp ((ptr)->jmpbuf, 1))
5544 #define PNG_JMPBUF(ptr) ((ptr)->jmpbuf)
5546 /* In libpng version 1.5, the jmpbuf member is hidden. (Bug#7908) */
5547 #define PNG_LONGJMP(ptr) (fn_png_longjmp ((ptr), 1))
5548 #define PNG_JMPBUF(ptr) \
5549 (*fn_png_set_longjmp_fn ((ptr), longjmp, sizeof (jmp_buf)))
5552 /* Error and warning handlers installed when the PNG library
5555 static void my_png_error (png_struct
*, const char *) NO_RETURN
;
5557 my_png_error (png_struct
*png_ptr
, const char *msg
)
5559 xassert (png_ptr
!= NULL
);
5560 /* Avoid compiler warning about deprecated direct access to
5561 png_ptr's fields in libpng versions 1.4.x. */
5562 image_error ("PNG error: %s", build_string (msg
), Qnil
);
5563 PNG_LONGJMP (png_ptr
);
5568 my_png_warning (png_struct
*png_ptr
, const char *msg
)
5570 xassert (png_ptr
!= NULL
);
5571 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
5574 /* Memory source for PNG decoding. */
5576 struct png_memory_storage
5578 unsigned char *bytes
; /* The data */
5579 ptrdiff_t len
; /* How big is it? */
5580 ptrdiff_t index
; /* Where are we? */
5584 /* Function set as reader function when reading PNG image from memory.
5585 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5586 bytes from the input to DATA. */
5589 png_read_from_memory (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5591 struct png_memory_storage
*tbr
5592 = (struct png_memory_storage
*) fn_png_get_io_ptr (png_ptr
);
5594 if (length
> tbr
->len
- tbr
->index
)
5595 fn_png_error (png_ptr
, "Read error");
5597 memcpy (data
, tbr
->bytes
+ tbr
->index
, length
);
5598 tbr
->index
= tbr
->index
+ length
;
5602 /* Function set as reader function when reading PNG image from a file.
5603 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
5604 bytes from the input to DATA. */
5607 png_read_from_file (png_structp png_ptr
, png_bytep data
, png_size_t length
)
5609 FILE *fp
= (FILE *) fn_png_get_io_ptr (png_ptr
);
5611 if (fread (data
, 1, length
, fp
) < length
)
5612 fn_png_error (png_ptr
, "Read error");
5616 /* Load PNG image IMG for use on frame F. Value is non-zero if
5620 png_load (struct frame
*f
, struct image
*img
)
5622 Lisp_Object file
, specified_file
;
5623 Lisp_Object specified_data
;
5626 XImagePtr ximg
, mask_img
= NULL
;
5627 png_struct
*png_ptr
= NULL
;
5628 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
5629 FILE *volatile fp
= NULL
;
5631 png_byte
* volatile pixels
= NULL
;
5632 png_byte
** volatile rows
= NULL
;
5633 png_uint_32 width
, height
;
5634 int bit_depth
, color_type
, interlace_type
;
5636 png_uint_32 row_bytes
;
5638 struct png_memory_storage tbr
; /* Data to be read */
5640 /* Find out what file to load. */
5641 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
5642 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
5644 if (NILP (specified_data
))
5646 file
= x_find_image_file (specified_file
);
5647 if (!STRINGP (file
))
5649 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
5653 /* Open the image file. */
5654 fp
= fopen (SSDATA (file
), "rb");
5657 image_error ("Cannot open image file `%s'", file
, Qnil
);
5661 /* Check PNG signature. */
5662 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
5663 || fn_png_sig_cmp (sig
, 0, sizeof sig
))
5665 image_error ("Not a PNG file: `%s'", file
, Qnil
);
5672 if (!STRINGP (specified_data
))
5674 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
5678 /* Read from memory. */
5679 tbr
.bytes
= SDATA (specified_data
);
5680 tbr
.len
= SBYTES (specified_data
);
5683 /* Check PNG signature. */
5684 if (tbr
.len
< sizeof sig
5685 || fn_png_sig_cmp (tbr
.bytes
, 0, sizeof sig
))
5687 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
5691 /* Need to skip past the signature. */
5692 tbr
.bytes
+= sizeof (sig
);
5695 /* Initialize read and info structs for PNG lib. */
5696 png_ptr
= fn_png_create_read_struct (PNG_LIBPNG_VER_STRING
,
5701 if (fp
) fclose (fp
);
5705 info_ptr
= fn_png_create_info_struct (png_ptr
);
5708 fn_png_destroy_read_struct (&png_ptr
, NULL
, NULL
);
5709 if (fp
) fclose (fp
);
5713 end_info
= fn_png_create_info_struct (png_ptr
);
5716 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, NULL
);
5717 if (fp
) fclose (fp
);
5721 /* Set error jump-back. We come back here when the PNG library
5722 detects an error. */
5723 if (setjmp (PNG_JMPBUF (png_ptr
)))
5727 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, &end_info
);
5730 if (fp
) fclose (fp
);
5734 /* Read image info. */
5735 if (!NILP (specified_data
))
5736 fn_png_set_read_fn (png_ptr
, (void *) &tbr
, png_read_from_memory
);
5738 fn_png_set_read_fn (png_ptr
, (void *) fp
, png_read_from_file
);
5740 fn_png_set_sig_bytes (png_ptr
, sizeof sig
);
5741 fn_png_read_info (png_ptr
, info_ptr
);
5742 fn_png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
5743 &interlace_type
, NULL
, NULL
);
5745 if (! (width
<= INT_MAX
&& height
<= INT_MAX
5746 && check_image_size (f
, width
, height
)))
5748 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
5752 /* Create the X image and pixmap now, so that the work below can be
5753 omitted if the image is too large for X. */
5754 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
,
5758 /* If image contains simply transparency data, we prefer to
5759 construct a clipping mask. */
5760 if (fn_png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
5765 /* This function is easier to write if we only have to handle
5766 one data format: RGB or RGBA with 8 bits per channel. Let's
5767 transform other formats into that format. */
5769 /* Strip more than 8 bits per channel. */
5770 if (bit_depth
== 16)
5771 fn_png_set_strip_16 (png_ptr
);
5773 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
5775 fn_png_set_expand (png_ptr
);
5777 /* Convert grayscale images to RGB. */
5778 if (color_type
== PNG_COLOR_TYPE_GRAY
5779 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
5780 fn_png_set_gray_to_rgb (png_ptr
);
5782 /* Handle alpha channel by combining the image with a background
5783 color. Do this only if a real alpha channel is supplied. For
5784 simple transparency, we prefer a clipping mask. */
5787 /* png_color_16 *image_bg; */
5788 Lisp_Object specified_bg
5789 = image_spec_value (img
->spec
, QCbackground
, NULL
);
5790 int shift
= (bit_depth
== 16) ? 0 : 8;
5792 if (STRINGP (specified_bg
))
5793 /* The user specified `:background', use that. */
5796 if (x_defined_color (f
, SSDATA (specified_bg
), &color
, 0))
5798 png_color_16 user_bg
;
5800 memset (&user_bg
, 0, sizeof user_bg
);
5801 user_bg
.red
= color
.red
>> shift
;
5802 user_bg
.green
= color
.green
>> shift
;
5803 user_bg
.blue
= color
.blue
>> shift
;
5805 fn_png_set_background (png_ptr
, &user_bg
,
5806 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5811 /* We use the current frame background, ignoring any default
5812 background color set by the image. */
5813 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI)
5815 png_color_16 frame_background
;
5817 color
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
5818 x_query_color (f
, &color
);
5820 memset (&frame_background
, 0, sizeof frame_background
);
5821 frame_background
.red
= color
.red
>> shift
;
5822 frame_background
.green
= color
.green
>> shift
;
5823 frame_background
.blue
= color
.blue
>> shift
;
5824 #endif /* HAVE_X_WINDOWS */
5826 fn_png_set_background (png_ptr
, &frame_background
,
5827 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
5831 /* Update info structure. */
5832 fn_png_read_update_info (png_ptr
, info_ptr
);
5834 /* Get number of channels. Valid values are 1 for grayscale images
5835 and images with a palette, 2 for grayscale images with transparency
5836 information (alpha channel), 3 for RGB images, and 4 for RGB
5837 images with alpha channel, i.e. RGBA. If conversions above were
5838 sufficient we should only have 3 or 4 channels here. */
5839 channels
= fn_png_get_channels (png_ptr
, info_ptr
);
5840 xassert (channels
== 3 || channels
== 4);
5842 /* Number of bytes needed for one row of the image. */
5843 row_bytes
= fn_png_get_rowbytes (png_ptr
, info_ptr
);
5845 /* Allocate memory for the image. */
5846 if (min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *rows
< height
5847 || min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *pixels
/ height
< row_bytes
)
5848 memory_full (SIZE_MAX
);
5849 pixels
= (png_byte
*) xmalloc (sizeof *pixels
* row_bytes
* height
);
5850 rows
= (png_byte
**) xmalloc (height
* sizeof *rows
);
5851 for (i
= 0; i
< height
; ++i
)
5852 rows
[i
] = pixels
+ i
* row_bytes
;
5854 /* Read the entire image. */
5855 fn_png_read_image (png_ptr
, rows
);
5856 fn_png_read_end (png_ptr
, info_ptr
);
5863 /* Create an image and pixmap serving as mask if the PNG image
5864 contains an alpha channel. */
5867 && !x_create_x_image_and_pixmap (f
, width
, height
, 1,
5868 &mask_img
, &img
->mask
))
5870 x_destroy_x_image (ximg
);
5871 Free_Pixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
5872 img
->pixmap
= NO_PIXMAP
;
5876 /* Fill the X image and mask from PNG data. */
5877 init_color_table ();
5879 for (y
= 0; y
< height
; ++y
)
5881 png_byte
*p
= rows
[y
];
5883 for (x
= 0; x
< width
; ++x
)
5890 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
5891 /* An alpha channel, aka mask channel, associates variable
5892 transparency with an image. Where other image formats
5893 support binary transparency---fully transparent or fully
5894 opaque---PNG allows up to 254 levels of partial transparency.
5895 The PNG library implements partial transparency by combining
5896 the image with a specified background color.
5898 I'm not sure how to handle this here nicely: because the
5899 background on which the image is displayed may change, for
5900 real alpha channel support, it would be necessary to create
5901 a new image for each possible background.
5903 What I'm doing now is that a mask is created if we have
5904 boolean transparency information. Otherwise I'm using
5905 the frame's background color to combine the image with. */
5910 XPutPixel (mask_img
, x
, y
, *p
> 0 ? PIX_MASK_DRAW
: PIX_MASK_RETAIN
);
5916 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
5917 /* Set IMG's background color from the PNG image, unless the user
5921 if (fn_png_get_bKGD (png_ptr
, info_ptr
, &bg
))
5923 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
5924 img
->background_valid
= 1;
5928 #ifdef COLOR_TABLE_SUPPORT
5929 /* Remember colors allocated for this image. */
5930 img
->colors
= colors_in_color_table (&img
->ncolors
);
5931 free_color_table ();
5932 #endif /* COLOR_TABLE_SUPPORT */
5935 fn_png_destroy_read_struct (&png_ptr
, &info_ptr
, &end_info
);
5940 img
->height
= height
;
5942 /* Maybe fill in the background field while we have ximg handy.
5943 Casting avoids a GCC warning. */
5944 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
5946 /* Put the image into the pixmap, then free the X image and its buffer. */
5947 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
5948 x_destroy_x_image (ximg
);
5950 /* Same for the mask. */
5953 /* Fill in the background_transparent field while we have the
5954 mask handy. Casting avoids a GCC warning. */
5955 image_background_transparent (img
, f
, (XImagePtr_or_DC
)mask_img
);
5957 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
5958 x_destroy_x_image (mask_img
);
5964 #else /* HAVE_PNG */
5968 png_load (struct frame
*f
, struct image
*img
)
5970 return ns_load_image (f
, img
,
5971 image_spec_value (img
->spec
, QCfile
, NULL
),
5972 image_spec_value (img
->spec
, QCdata
, NULL
));
5974 #endif /* HAVE_NS */
5977 #endif /* !HAVE_PNG */
5981 /***********************************************************************
5983 ***********************************************************************/
5985 #if defined (HAVE_JPEG) || defined (HAVE_NS)
5987 static int jpeg_image_p (Lisp_Object object
);
5988 static int jpeg_load (struct frame
*f
, struct image
*img
);
5990 /* The symbol `jpeg' identifying images of this type. */
5992 static Lisp_Object Qjpeg
;
5994 /* Indices of image specification fields in gs_format, below. */
5996 enum jpeg_keyword_index
6005 JPEG_HEURISTIC_MASK
,
6011 /* Vector of image_keyword structures describing the format
6012 of valid user-defined image specifications. */
6014 static const struct image_keyword jpeg_format
[JPEG_LAST
] =
6016 {":type", IMAGE_SYMBOL_VALUE
, 1},
6017 {":data", IMAGE_STRING_VALUE
, 0},
6018 {":file", IMAGE_STRING_VALUE
, 0},
6019 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6020 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6021 {":relief", IMAGE_INTEGER_VALUE
, 0},
6022 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6023 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6024 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6025 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6028 /* Structure describing the image type `jpeg'. */
6030 static struct image_type jpeg_type
=
6039 /* Return non-zero if OBJECT is a valid JPEG image specification. */
6042 jpeg_image_p (Lisp_Object object
)
6044 struct image_keyword fmt
[JPEG_LAST
];
6046 memcpy (fmt
, jpeg_format
, sizeof fmt
);
6048 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
6051 /* Must specify either the :data or :file keyword. */
6052 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
6055 #endif /* HAVE_JPEG || HAVE_NS */
6059 /* Work around a warning about HAVE_STDLIB_H being redefined in
6061 #ifdef HAVE_STDLIB_H
6062 #undef HAVE_STDLIB_H
6063 #endif /* HAVE_STLIB_H */
6065 #if defined (HAVE_NTGUI) && !defined (__WIN32__)
6066 /* In older releases of the jpeg library, jpeglib.h will define boolean
6067 differently depending on __WIN32__, so make sure it is defined. */
6071 #include <jpeglib.h>
6074 #ifdef HAVE_STLIB_H_1
6075 #define HAVE_STDLIB_H 1
6080 /* JPEG library details. */
6081 DEF_IMGLIB_FN (void, jpeg_CreateDecompress
, (j_decompress_ptr
, int, size_t));
6082 DEF_IMGLIB_FN (boolean
, jpeg_start_decompress
, (j_decompress_ptr
));
6083 DEF_IMGLIB_FN (boolean
, jpeg_finish_decompress
, (j_decompress_ptr
));
6084 DEF_IMGLIB_FN (void, jpeg_destroy_decompress
, (j_decompress_ptr
));
6085 DEF_IMGLIB_FN (int, jpeg_read_header
, (j_decompress_ptr
, boolean
));
6086 DEF_IMGLIB_FN (JDIMENSION
, jpeg_read_scanlines
, (j_decompress_ptr
, JSAMPARRAY
, JDIMENSION
));
6087 DEF_IMGLIB_FN (struct jpeg_error_mgr
*, jpeg_std_error
, (struct jpeg_error_mgr
*));
6088 DEF_IMGLIB_FN (boolean
, jpeg_resync_to_restart
, (j_decompress_ptr
, int));
6091 init_jpeg_functions (Lisp_Object libraries
)
6095 if (!(library
= w32_delayed_load (libraries
, Qjpeg
)))
6098 LOAD_IMGLIB_FN (library
, jpeg_finish_decompress
);
6099 LOAD_IMGLIB_FN (library
, jpeg_read_scanlines
);
6100 LOAD_IMGLIB_FN (library
, jpeg_start_decompress
);
6101 LOAD_IMGLIB_FN (library
, jpeg_read_header
);
6102 LOAD_IMGLIB_FN (library
, jpeg_CreateDecompress
);
6103 LOAD_IMGLIB_FN (library
, jpeg_destroy_decompress
);
6104 LOAD_IMGLIB_FN (library
, jpeg_std_error
);
6105 LOAD_IMGLIB_FN (library
, jpeg_resync_to_restart
);
6109 /* Wrapper since we can't directly assign the function pointer
6110 to another function pointer that was declared more completely easily. */
6112 jpeg_resync_to_restart_wrapper (j_decompress_ptr cinfo
, int desired
)
6114 return fn_jpeg_resync_to_restart (cinfo
, desired
);
6119 #define fn_jpeg_CreateDecompress(a,b,c) jpeg_create_decompress (a)
6120 #define fn_jpeg_start_decompress jpeg_start_decompress
6121 #define fn_jpeg_finish_decompress jpeg_finish_decompress
6122 #define fn_jpeg_destroy_decompress jpeg_destroy_decompress
6123 #define fn_jpeg_read_header jpeg_read_header
6124 #define fn_jpeg_read_scanlines jpeg_read_scanlines
6125 #define fn_jpeg_std_error jpeg_std_error
6126 #define jpeg_resync_to_restart_wrapper jpeg_resync_to_restart
6128 #endif /* HAVE_NTGUI */
6130 struct my_jpeg_error_mgr
6132 struct jpeg_error_mgr pub
;
6133 jmp_buf setjmp_buffer
;
6137 static void my_error_exit (j_common_ptr
) NO_RETURN
;
6139 my_error_exit (j_common_ptr cinfo
)
6141 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
6142 longjmp (mgr
->setjmp_buffer
, 1);
6146 /* Init source method for JPEG data source manager. Called by
6147 jpeg_read_header() before any data is actually read. See
6148 libjpeg.doc from the JPEG lib distribution. */
6151 our_common_init_source (j_decompress_ptr cinfo
)
6156 /* Method to terminate data source. Called by
6157 jpeg_finish_decompress() after all data has been processed. */
6160 our_common_term_source (j_decompress_ptr cinfo
)
6165 /* Fill input buffer method for JPEG data source manager. Called
6166 whenever more data is needed. We read the whole image in one step,
6167 so this only adds a fake end of input marker at the end. */
6169 static JOCTET our_memory_buffer
[2];
6172 our_memory_fill_input_buffer (j_decompress_ptr cinfo
)
6174 /* Insert a fake EOI marker. */
6175 struct jpeg_source_mgr
*src
= cinfo
->src
;
6177 our_memory_buffer
[0] = (JOCTET
) 0xFF;
6178 our_memory_buffer
[1] = (JOCTET
) JPEG_EOI
;
6180 src
->next_input_byte
= our_memory_buffer
;
6181 src
->bytes_in_buffer
= 2;
6186 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6187 is the JPEG data source manager. */
6190 our_memory_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6192 struct jpeg_source_mgr
*src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6196 if (num_bytes
> src
->bytes_in_buffer
)
6197 ERREXIT (cinfo
, JERR_INPUT_EOF
);
6199 src
->bytes_in_buffer
-= num_bytes
;
6200 src
->next_input_byte
+= num_bytes
;
6205 /* Set up the JPEG lib for reading an image from DATA which contains
6206 LEN bytes. CINFO is the decompression info structure created for
6207 reading the image. */
6210 jpeg_memory_src (j_decompress_ptr cinfo
, JOCTET
*data
, unsigned int len
)
6212 struct jpeg_source_mgr
*src
;
6214 if (cinfo
->src
== NULL
)
6216 /* First time for this JPEG object? */
6217 cinfo
->src
= (struct jpeg_source_mgr
*)
6218 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6219 sizeof (struct jpeg_source_mgr
));
6220 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6221 src
->next_input_byte
= data
;
6224 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
6225 src
->init_source
= our_common_init_source
;
6226 src
->fill_input_buffer
= our_memory_fill_input_buffer
;
6227 src
->skip_input_data
= our_memory_skip_input_data
;
6228 src
->resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6229 src
->term_source
= our_common_term_source
;
6230 src
->bytes_in_buffer
= len
;
6231 src
->next_input_byte
= data
;
6235 struct jpeg_stdio_mgr
6237 struct jpeg_source_mgr mgr
;
6244 /* Size of buffer to read JPEG from file.
6245 Not too big, as we want to use alloc_small. */
6246 #define JPEG_STDIO_BUFFER_SIZE 8192
6249 /* Fill input buffer method for JPEG data source manager. Called
6250 whenever more data is needed. The data is read from a FILE *. */
6253 our_stdio_fill_input_buffer (j_decompress_ptr cinfo
)
6255 struct jpeg_stdio_mgr
*src
;
6257 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6262 bytes
= fread (src
->buffer
, 1, JPEG_STDIO_BUFFER_SIZE
, src
->file
);
6264 src
->mgr
.bytes_in_buffer
= bytes
;
6267 WARNMS (cinfo
, JWRN_JPEG_EOF
);
6269 src
->buffer
[0] = (JOCTET
) 0xFF;
6270 src
->buffer
[1] = (JOCTET
) JPEG_EOI
;
6271 src
->mgr
.bytes_in_buffer
= 2;
6273 src
->mgr
.next_input_byte
= src
->buffer
;
6280 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
6281 is the JPEG data source manager. */
6284 our_stdio_skip_input_data (j_decompress_ptr cinfo
, long int num_bytes
)
6286 struct jpeg_stdio_mgr
*src
;
6287 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6289 while (num_bytes
> 0 && !src
->finished
)
6291 if (num_bytes
<= src
->mgr
.bytes_in_buffer
)
6293 src
->mgr
.bytes_in_buffer
-= num_bytes
;
6294 src
->mgr
.next_input_byte
+= num_bytes
;
6299 num_bytes
-= src
->mgr
.bytes_in_buffer
;
6300 src
->mgr
.bytes_in_buffer
= 0;
6301 src
->mgr
.next_input_byte
= NULL
;
6303 our_stdio_fill_input_buffer (cinfo
);
6309 /* Set up the JPEG lib for reading an image from a FILE *.
6310 CINFO is the decompression info structure created for
6311 reading the image. */
6314 jpeg_file_src (j_decompress_ptr cinfo
, FILE *fp
)
6316 struct jpeg_stdio_mgr
*src
;
6318 if (cinfo
->src
!= NULL
)
6319 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6322 /* First time for this JPEG object? */
6323 cinfo
->src
= (struct jpeg_source_mgr
*)
6324 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6325 sizeof (struct jpeg_stdio_mgr
));
6326 src
= (struct jpeg_stdio_mgr
*) cinfo
->src
;
6327 src
->buffer
= (JOCTET
*)
6328 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
6329 JPEG_STDIO_BUFFER_SIZE
);
6334 src
->mgr
.init_source
= our_common_init_source
;
6335 src
->mgr
.fill_input_buffer
= our_stdio_fill_input_buffer
;
6336 src
->mgr
.skip_input_data
= our_stdio_skip_input_data
;
6337 src
->mgr
.resync_to_restart
= jpeg_resync_to_restart_wrapper
; /* Use default method. */
6338 src
->mgr
.term_source
= our_common_term_source
;
6339 src
->mgr
.bytes_in_buffer
= 0;
6340 src
->mgr
.next_input_byte
= NULL
;
6344 /* Load image IMG for use on frame F. Patterned after example.c
6345 from the JPEG lib. */
6348 jpeg_load (struct frame
*f
, struct image
*img
)
6350 struct jpeg_decompress_struct cinfo
;
6351 struct my_jpeg_error_mgr mgr
;
6352 Lisp_Object file
, specified_file
;
6353 Lisp_Object specified_data
;
6354 FILE * volatile fp
= NULL
;
6356 int row_stride
, x
, y
;
6357 XImagePtr ximg
= NULL
;
6359 unsigned long *colors
;
6362 /* Open the JPEG file. */
6363 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6364 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6366 if (NILP (specified_data
))
6368 file
= x_find_image_file (specified_file
);
6369 if (!STRINGP (file
))
6371 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6375 fp
= fopen (SSDATA (file
), "rb");
6378 image_error ("Cannot open `%s'", file
, Qnil
);
6382 else if (!STRINGP (specified_data
))
6384 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6388 /* Customize libjpeg's error handling to call my_error_exit when an
6389 error is detected. This function will perform a longjmp. */
6390 cinfo
.err
= fn_jpeg_std_error (&mgr
.pub
);
6391 mgr
.pub
.error_exit
= my_error_exit
;
6393 if ((rc
= setjmp (mgr
.setjmp_buffer
)) != 0)
6397 /* Called from my_error_exit. Display a JPEG error. */
6398 char buf
[JMSG_LENGTH_MAX
];
6399 cinfo
.err
->format_message ((j_common_ptr
) &cinfo
, buf
);
6400 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
6401 build_string (buf
));
6404 /* Close the input file and destroy the JPEG object. */
6406 fclose ((FILE *) fp
);
6407 fn_jpeg_destroy_decompress (&cinfo
);
6409 /* If we already have an XImage, free that. */
6410 x_destroy_x_image (ximg
);
6412 /* Free pixmap and colors. */
6413 x_clear_image (f
, img
);
6417 /* Create the JPEG decompression object. Let it read from fp.
6418 Read the JPEG image header. */
6419 fn_jpeg_CreateDecompress (&cinfo
, JPEG_LIB_VERSION
, sizeof (cinfo
));
6421 if (NILP (specified_data
))
6422 jpeg_file_src (&cinfo
, (FILE *) fp
);
6424 jpeg_memory_src (&cinfo
, SDATA (specified_data
),
6425 SBYTES (specified_data
));
6427 fn_jpeg_read_header (&cinfo
, 1);
6429 /* Customize decompression so that color quantization will be used.
6430 Start decompression. */
6431 cinfo
.quantize_colors
= 1;
6432 fn_jpeg_start_decompress (&cinfo
);
6433 width
= img
->width
= cinfo
.output_width
;
6434 height
= img
->height
= cinfo
.output_height
;
6436 if (!check_image_size (f
, width
, height
))
6438 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6439 longjmp (mgr
.setjmp_buffer
, 2);
6442 /* Create X image and pixmap. */
6443 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
6444 longjmp (mgr
.setjmp_buffer
, 2);
6446 /* Allocate colors. When color quantization is used,
6447 cinfo.actual_number_of_colors has been set with the number of
6448 colors generated, and cinfo.colormap is a two-dimensional array
6449 of color indices in the range 0..cinfo.actual_number_of_colors.
6450 No more than 255 colors will be generated. */
6454 if (cinfo
.out_color_components
> 2)
6455 ir
= 0, ig
= 1, ib
= 2;
6456 else if (cinfo
.out_color_components
> 1)
6457 ir
= 0, ig
= 1, ib
= 0;
6459 ir
= 0, ig
= 0, ib
= 0;
6461 /* Use the color table mechanism because it handles colors that
6462 cannot be allocated nicely. Such colors will be replaced with
6463 a default color, and we don't have to care about which colors
6464 can be freed safely, and which can't. */
6465 init_color_table ();
6466 colors
= (unsigned long *) alloca (cinfo
.actual_number_of_colors
6469 for (i
= 0; i
< cinfo
.actual_number_of_colors
; ++i
)
6471 /* Multiply RGB values with 255 because X expects RGB values
6472 in the range 0..0xffff. */
6473 int r
= cinfo
.colormap
[ir
][i
] << 8;
6474 int g
= cinfo
.colormap
[ig
][i
] << 8;
6475 int b
= cinfo
.colormap
[ib
][i
] << 8;
6476 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
6479 #ifdef COLOR_TABLE_SUPPORT
6480 /* Remember those colors actually allocated. */
6481 img
->colors
= colors_in_color_table (&img
->ncolors
);
6482 free_color_table ();
6483 #endif /* COLOR_TABLE_SUPPORT */
6487 row_stride
= width
* cinfo
.output_components
;
6488 buffer
= cinfo
.mem
->alloc_sarray ((j_common_ptr
) &cinfo
, JPOOL_IMAGE
,
6490 for (y
= 0; y
< height
; ++y
)
6492 fn_jpeg_read_scanlines (&cinfo
, buffer
, 1);
6493 for (x
= 0; x
< cinfo
.output_width
; ++x
)
6494 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
6498 fn_jpeg_finish_decompress (&cinfo
);
6499 fn_jpeg_destroy_decompress (&cinfo
);
6501 fclose ((FILE *) fp
);
6503 /* Maybe fill in the background field while we have ximg handy. */
6504 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6505 /* Casting avoids a GCC warning. */
6506 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6508 /* Put the image into the pixmap. */
6509 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
6510 x_destroy_x_image (ximg
);
6514 #else /* HAVE_JPEG */
6518 jpeg_load (struct frame
*f
, struct image
*img
)
6520 return ns_load_image (f
, img
,
6521 image_spec_value (img
->spec
, QCfile
, NULL
),
6522 image_spec_value (img
->spec
, QCdata
, NULL
));
6524 #endif /* HAVE_NS */
6526 #endif /* !HAVE_JPEG */
6530 /***********************************************************************
6532 ***********************************************************************/
6534 #if defined (HAVE_TIFF) || defined (HAVE_NS)
6536 static int tiff_image_p (Lisp_Object object
);
6537 static int tiff_load (struct frame
*f
, struct image
*img
);
6539 /* The symbol `tiff' identifying images of this type. */
6541 static Lisp_Object Qtiff
;
6543 /* Indices of image specification fields in tiff_format, below. */
6545 enum tiff_keyword_index
6554 TIFF_HEURISTIC_MASK
,
6561 /* Vector of image_keyword structures describing the format
6562 of valid user-defined image specifications. */
6564 static const struct image_keyword tiff_format
[TIFF_LAST
] =
6566 {":type", IMAGE_SYMBOL_VALUE
, 1},
6567 {":data", IMAGE_STRING_VALUE
, 0},
6568 {":file", IMAGE_STRING_VALUE
, 0},
6569 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6570 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
6571 {":relief", IMAGE_INTEGER_VALUE
, 0},
6572 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6573 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6574 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6575 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
6576 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0}
6579 /* Structure describing the image type `tiff'. */
6581 static struct image_type tiff_type
=
6590 /* Return non-zero if OBJECT is a valid TIFF image specification. */
6593 tiff_image_p (Lisp_Object object
)
6595 struct image_keyword fmt
[TIFF_LAST
];
6596 memcpy (fmt
, tiff_format
, sizeof fmt
);
6598 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
6601 /* Must specify either the :data or :file keyword. */
6602 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
6605 #endif /* HAVE_TIFF || HAVE_NS */
6613 /* TIFF library details. */
6614 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetErrorHandler
, (TIFFErrorHandler
));
6615 DEF_IMGLIB_FN (TIFFErrorHandler
, TIFFSetWarningHandler
, (TIFFErrorHandler
));
6616 DEF_IMGLIB_FN (TIFF
*, TIFFOpen
, (const char *, const char *));
6617 DEF_IMGLIB_FN (TIFF
*, TIFFClientOpen
, (const char *, const char *, thandle_t
,
6618 TIFFReadWriteProc
, TIFFReadWriteProc
,
6619 TIFFSeekProc
, TIFFCloseProc
, TIFFSizeProc
,
6620 TIFFMapFileProc
, TIFFUnmapFileProc
));
6621 DEF_IMGLIB_FN (int, TIFFGetField
, (TIFF
*, ttag_t
, ...));
6622 DEF_IMGLIB_FN (int, TIFFReadRGBAImage
, (TIFF
*, uint32
, uint32
, uint32
*, int));
6623 DEF_IMGLIB_FN (void, TIFFClose
, (TIFF
*));
6624 DEF_IMGLIB_FN (int, TIFFSetDirectory
, (TIFF
*, tdir_t
));
6627 init_tiff_functions (Lisp_Object libraries
)
6631 if (!(library
= w32_delayed_load (libraries
, Qtiff
)))
6634 LOAD_IMGLIB_FN (library
, TIFFSetErrorHandler
);
6635 LOAD_IMGLIB_FN (library
, TIFFSetWarningHandler
);
6636 LOAD_IMGLIB_FN (library
, TIFFOpen
);
6637 LOAD_IMGLIB_FN (library
, TIFFClientOpen
);
6638 LOAD_IMGLIB_FN (library
, TIFFGetField
);
6639 LOAD_IMGLIB_FN (library
, TIFFReadRGBAImage
);
6640 LOAD_IMGLIB_FN (library
, TIFFClose
);
6641 LOAD_IMGLIB_FN (library
, TIFFSetDirectory
);
6647 #define fn_TIFFSetErrorHandler TIFFSetErrorHandler
6648 #define fn_TIFFSetWarningHandler TIFFSetWarningHandler
6649 #define fn_TIFFOpen TIFFOpen
6650 #define fn_TIFFClientOpen TIFFClientOpen
6651 #define fn_TIFFGetField TIFFGetField
6652 #define fn_TIFFReadRGBAImage TIFFReadRGBAImage
6653 #define fn_TIFFClose TIFFClose
6654 #define fn_TIFFSetDirectory TIFFSetDirectory
6655 #endif /* HAVE_NTGUI */
6658 /* Reading from a memory buffer for TIFF images Based on the PNG
6659 memory source, but we have to provide a lot of extra functions.
6662 We really only need to implement read and seek, but I am not
6663 convinced that the TIFF library is smart enough not to destroy
6664 itself if we only hand it the function pointers we need to
6669 unsigned char *bytes
;
6676 tiff_read_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6678 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6680 size
= min (size
, src
->len
- src
->index
);
6681 memcpy (buf
, src
->bytes
+ src
->index
, size
);
6687 tiff_write_from_memory (thandle_t data
, tdata_t buf
, tsize_t size
)
6693 tiff_seek_in_memory (thandle_t data
, toff_t off
, int whence
)
6695 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
6700 case SEEK_SET
: /* Go from beginning of source. */
6704 case SEEK_END
: /* Go from end of source. */
6705 idx
= src
->len
+ off
;
6708 case SEEK_CUR
: /* Go from current position. */
6709 idx
= src
->index
+ off
;
6712 default: /* Invalid `whence'. */
6716 if (idx
> src
->len
|| idx
< 0)
6724 tiff_close_memory (thandle_t data
)
6731 tiff_mmap_memory (thandle_t data
, tdata_t
*pbase
, toff_t
*psize
)
6733 /* It is already _IN_ memory. */
6738 tiff_unmap_memory (thandle_t data
, tdata_t base
, toff_t size
)
6740 /* We don't need to do this. */
6744 tiff_size_of_memory (thandle_t data
)
6746 return ((tiff_memory_source
*) data
)->len
;
6749 /* GCC 3.x on x86 Windows targets has a bug that triggers an internal
6750 compiler error compiling tiff_handler, see Bugzilla bug #17406
6751 (http://gcc.gnu.org/bugzilla/show_bug.cgi?id=17406). Declaring
6752 this function as external works around that problem. */
6753 #if defined (__MINGW32__) && __GNUC__ == 3
6754 # define MINGW_STATIC
6756 # define MINGW_STATIC static
6760 tiff_handler (const char *, const char *, const char *, va_list)
6761 ATTRIBUTE_FORMAT_PRINTF (3, 0);
6763 tiff_handler (const char *log_format
, const char *title
,
6764 const char *format
, va_list ap
)
6766 /* doprnt is not suitable here, as TIFF handlers are called from
6767 libtiff and are passed arbitrary printf directives. Instead, use
6768 vsnprintf, taking care to be portable to nonstandard environments
6769 where vsnprintf returns -1 on buffer overflow. Since it's just a
6770 log entry, it's OK to truncate it. */
6772 int len
= vsnprintf (buf
, sizeof buf
, format
, ap
);
6773 add_to_log (log_format
, build_string (title
),
6774 make_string (buf
, max (0, min (len
, sizeof buf
- 1))));
6778 static void tiff_error_handler (const char *, const char *, va_list)
6779 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6781 tiff_error_handler (const char *title
, const char *format
, va_list ap
)
6783 tiff_handler ("TIFF error: %s %s", title
, format
, ap
);
6787 static void tiff_warning_handler (const char *, const char *, va_list)
6788 ATTRIBUTE_FORMAT_PRINTF (2, 0);
6790 tiff_warning_handler (const char *title
, const char *format
, va_list ap
)
6792 tiff_handler ("TIFF warning: %s %s", title
, format
, ap
);
6796 /* Load TIFF image IMG for use on frame F. Value is non-zero if
6800 tiff_load (struct frame
*f
, struct image
*img
)
6802 Lisp_Object file
, specified_file
;
6803 Lisp_Object specified_data
;
6805 int width
, height
, x
, y
, count
;
6809 tiff_memory_source memsrc
;
6812 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6813 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6815 fn_TIFFSetErrorHandler ((TIFFErrorHandler
) tiff_error_handler
);
6816 fn_TIFFSetWarningHandler ((TIFFErrorHandler
) tiff_warning_handler
);
6818 if (NILP (specified_data
))
6820 /* Read from a file */
6821 file
= x_find_image_file (specified_file
);
6822 if (!STRINGP (file
))
6824 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6828 /* Try to open the image file. */
6829 tiff
= fn_TIFFOpen (SSDATA (file
), "r");
6832 image_error ("Cannot open `%s'", file
, Qnil
);
6838 if (!STRINGP (specified_data
))
6840 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
6844 /* Memory source! */
6845 memsrc
.bytes
= SDATA (specified_data
);
6846 memsrc
.len
= SBYTES (specified_data
);
6849 tiff
= fn_TIFFClientOpen ("memory_source", "r", (thandle_t
)&memsrc
,
6850 tiff_read_from_memory
,
6851 tiff_write_from_memory
,
6852 tiff_seek_in_memory
,
6854 tiff_size_of_memory
,
6860 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
6865 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
6866 if (INTEGERP (image
))
6868 EMACS_INT ino
= XFASTINT (image
);
6869 if (! (TYPE_MINIMUM (tdir_t
) <= ino
&& ino
<= TYPE_MAXIMUM (tdir_t
)
6870 && fn_TIFFSetDirectory (tiff
, ino
)))
6872 image_error ("Invalid image number `%s' in image `%s'",
6874 fn_TIFFClose (tiff
);
6879 /* Get width and height of the image, and allocate a raster buffer
6880 of width x height 32-bit values. */
6881 fn_TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
6882 fn_TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
6884 if (!check_image_size (f
, width
, height
))
6886 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
6887 fn_TIFFClose (tiff
);
6891 /* Create the X image and pixmap. */
6892 if (! (height
<= min (PTRDIFF_MAX
, SIZE_MAX
) / sizeof *buf
/ width
6893 && x_create_x_image_and_pixmap (f
, width
, height
, 0,
6894 &ximg
, &img
->pixmap
)))
6896 fn_TIFFClose (tiff
);
6900 buf
= (uint32
*) xmalloc (sizeof *buf
* width
* height
);
6902 rc
= fn_TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
6904 /* Count the number of images in the file. */
6905 for (count
= 1; fn_TIFFSetDirectory (tiff
, count
); count
++)
6909 img
->lisp_data
= Fcons (Qcount
,
6910 Fcons (make_number (count
),
6913 fn_TIFFClose (tiff
);
6916 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
6921 /* Initialize the color table. */
6922 init_color_table ();
6924 /* Process the pixel raster. Origin is in the lower-left corner. */
6925 for (y
= 0; y
< height
; ++y
)
6927 uint32
*row
= buf
+ y
* width
;
6929 for (x
= 0; x
< width
; ++x
)
6931 uint32 abgr
= row
[x
];
6932 int r
= TIFFGetR (abgr
) << 8;
6933 int g
= TIFFGetG (abgr
) << 8;
6934 int b
= TIFFGetB (abgr
) << 8;
6935 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
6939 #ifdef COLOR_TABLE_SUPPORT
6940 /* Remember the colors allocated for the image. Free the color table. */
6941 img
->colors
= colors_in_color_table (&img
->ncolors
);
6942 free_color_table ();
6943 #endif /* COLOR_TABLE_SUPPORT */
6946 img
->height
= height
;
6948 /* Maybe fill in the background field while we have ximg handy. */
6949 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
6950 /* Casting avoids a GCC warning on W32. */
6951 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
6953 /* Put the image into the pixmap, then free the X image and its buffer. */
6954 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
6955 x_destroy_x_image (ximg
);
6961 #else /* HAVE_TIFF */
6965 tiff_load (struct frame
*f
, struct image
*img
)
6967 return ns_load_image (f
, img
,
6968 image_spec_value (img
->spec
, QCfile
, NULL
),
6969 image_spec_value (img
->spec
, QCdata
, NULL
));
6971 #endif /* HAVE_NS */
6973 #endif /* !HAVE_TIFF */
6977 /***********************************************************************
6979 ***********************************************************************/
6981 #if defined (HAVE_GIF) || defined (HAVE_NS)
6983 static int gif_image_p (Lisp_Object object
);
6984 static int gif_load (struct frame
*f
, struct image
*img
);
6985 static void gif_clear_image (struct frame
*f
, struct image
*img
);
6987 /* The symbol `gif' identifying images of this type. */
6989 static Lisp_Object Qgif
;
6991 /* Indices of image specification fields in gif_format, below. */
6993 enum gif_keyword_index
7009 /* Vector of image_keyword structures describing the format
7010 of valid user-defined image specifications. */
7012 static const struct image_keyword gif_format
[GIF_LAST
] =
7014 {":type", IMAGE_SYMBOL_VALUE
, 1},
7015 {":data", IMAGE_STRING_VALUE
, 0},
7016 {":file", IMAGE_STRING_VALUE
, 0},
7017 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7018 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7019 {":relief", IMAGE_INTEGER_VALUE
, 0},
7020 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7021 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7022 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7023 {":index", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
7024 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7027 /* Structure describing the image type `gif'. */
7029 static struct image_type gif_type
=
7038 /* Free X resources of GIF image IMG which is used on frame F. */
7041 gif_clear_image (struct frame
*f
, struct image
*img
)
7043 img
->lisp_data
= Qnil
;
7044 x_clear_image (f
, img
);
7047 /* Return non-zero if OBJECT is a valid GIF image specification. */
7050 gif_image_p (Lisp_Object object
)
7052 struct image_keyword fmt
[GIF_LAST
];
7053 memcpy (fmt
, gif_format
, sizeof fmt
);
7055 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
7058 /* Must specify either the :data or :file keyword. */
7059 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
7062 #endif /* HAVE_GIF */
7066 #if defined (HAVE_NTGUI)
7067 /* winuser.h might define DrawText to DrawTextA or DrawTextW.
7068 Undefine before redefining to avoid a preprocessor warning. */
7072 /* avoid conflict with QuickdrawText.h */
7073 #define DrawText gif_DrawText
7074 #include <gif_lib.h>
7077 #else /* HAVE_NTGUI */
7079 #include <gif_lib.h>
7081 #endif /* HAVE_NTGUI */
7086 /* GIF library details. */
7087 DEF_IMGLIB_FN (int, DGifCloseFile
, (GifFileType
*));
7088 DEF_IMGLIB_FN (int, DGifSlurp
, (GifFileType
*));
7089 DEF_IMGLIB_FN (GifFileType
*, DGifOpen
, (void *, InputFunc
));
7090 DEF_IMGLIB_FN (GifFileType
*, DGifOpenFileName
, (const char *));
7093 init_gif_functions (Lisp_Object libraries
)
7097 if (!(library
= w32_delayed_load (libraries
, Qgif
)))
7100 LOAD_IMGLIB_FN (library
, DGifCloseFile
);
7101 LOAD_IMGLIB_FN (library
, DGifSlurp
);
7102 LOAD_IMGLIB_FN (library
, DGifOpen
);
7103 LOAD_IMGLIB_FN (library
, DGifOpenFileName
);
7109 #define fn_DGifCloseFile DGifCloseFile
7110 #define fn_DGifSlurp DGifSlurp
7111 #define fn_DGifOpen DGifOpen
7112 #define fn_DGifOpenFileName DGifOpenFileName
7114 #endif /* HAVE_NTGUI */
7116 /* Reading a GIF image from memory
7117 Based on the PNG memory stuff to a certain extent. */
7121 unsigned char *bytes
;
7127 /* Make the current memory source available to gif_read_from_memory.
7128 It's done this way because not all versions of libungif support
7129 a UserData field in the GifFileType structure. */
7130 static gif_memory_source
*current_gif_memory_src
;
7133 gif_read_from_memory (GifFileType
*file
, GifByteType
*buf
, int len
)
7135 gif_memory_source
*src
= current_gif_memory_src
;
7137 if (len
> src
->len
- src
->index
)
7140 memcpy (buf
, src
->bytes
+ src
->index
, len
);
7146 /* Load GIF image IMG for use on frame F. Value is non-zero if
7149 static const int interlace_start
[] = {0, 4, 2, 1};
7150 static const int interlace_increment
[] = {8, 8, 4, 2};
7152 #define GIF_LOCAL_DESCRIPTOR_EXTENSION 249
7155 gif_load (struct frame
*f
, struct image
*img
)
7158 int rc
, width
, height
, x
, y
, i
, j
;
7160 ColorMapObject
*gif_color_map
;
7161 unsigned long pixel_colors
[256];
7163 gif_memory_source memsrc
;
7164 Lisp_Object specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
7165 Lisp_Object specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7166 Lisp_Object specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7167 unsigned long bgcolor
= 0;
7170 if (NILP (specified_data
))
7172 file
= x_find_image_file (specified_file
);
7173 if (!STRINGP (file
))
7175 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7179 /* Open the GIF file. */
7180 gif
= fn_DGifOpenFileName (SSDATA (file
));
7183 image_error ("Cannot open `%s'", file
, Qnil
);
7189 if (!STRINGP (specified_data
))
7191 image_error ("Invalid image data `%s'", specified_data
, Qnil
);
7195 /* Read from memory! */
7196 current_gif_memory_src
= &memsrc
;
7197 memsrc
.bytes
= SDATA (specified_data
);
7198 memsrc
.len
= SBYTES (specified_data
);
7201 gif
= fn_DGifOpen (&memsrc
, gif_read_from_memory
);
7204 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
7209 /* Before reading entire contents, check the declared image size. */
7210 if (!check_image_size (f
, gif
->SWidth
, gif
->SHeight
))
7212 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7213 fn_DGifCloseFile (gif
);
7217 /* Read entire contents. */
7218 rc
= fn_DGifSlurp (gif
);
7219 if (rc
== GIF_ERROR
|| gif
->ImageCount
<= 0)
7221 image_error ("Error reading `%s'", img
->spec
, Qnil
);
7222 fn_DGifCloseFile (gif
);
7226 /* Which sub-image are we to display? */
7228 Lisp_Object image_number
= image_spec_value (img
->spec
, QCindex
, NULL
);
7229 idx
= INTEGERP (image_number
) ? XFASTINT (image_number
) : 0;
7230 if (idx
< 0 || idx
>= gif
->ImageCount
)
7232 image_error ("Invalid image number `%s' in image `%s'",
7233 image_number
, img
->spec
);
7234 fn_DGifCloseFile (gif
);
7239 width
= img
->width
= gif
->SWidth
;
7240 height
= img
->height
= gif
->SHeight
;
7242 img
->corners
[TOP_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Top
;
7243 img
->corners
[LEFT_CORNER
] = gif
->SavedImages
[0].ImageDesc
.Left
;
7244 img
->corners
[BOT_CORNER
]
7245 = img
->corners
[TOP_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Height
;
7246 img
->corners
[RIGHT_CORNER
]
7247 = img
->corners
[LEFT_CORNER
] + gif
->SavedImages
[0].ImageDesc
.Width
;
7249 if (!check_image_size (f
, width
, height
))
7251 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7252 fn_DGifCloseFile (gif
);
7256 /* Create the X image and pixmap. */
7257 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
7259 fn_DGifCloseFile (gif
);
7263 /* Clear the part of the screen image not covered by the image.
7264 Full animated GIF support requires more here (see the gif89 spec,
7265 disposal methods). Let's simply assume that the part not covered
7266 by a sub-image is in the frame's background color. */
7267 for (y
= 0; y
< img
->corners
[TOP_CORNER
]; ++y
)
7268 for (x
= 0; x
< width
; ++x
)
7269 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7271 for (y
= img
->corners
[BOT_CORNER
]; y
< height
; ++y
)
7272 for (x
= 0; x
< width
; ++x
)
7273 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7275 for (y
= img
->corners
[TOP_CORNER
]; y
< img
->corners
[BOT_CORNER
]; ++y
)
7277 for (x
= 0; x
< img
->corners
[LEFT_CORNER
]; ++x
)
7278 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7279 for (x
= img
->corners
[RIGHT_CORNER
]; x
< width
; ++x
)
7280 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
7283 /* Read the GIF image into the X image. */
7285 /* FIXME: With the current implementation, loading an animated gif
7286 is quadratic in the number of animation frames, since each frame
7287 is a separate struct image. We must provide a way for a single
7288 gif_load call to construct and save all animation frames. */
7290 init_color_table ();
7291 if (STRINGP (specified_bg
))
7292 bgcolor
= x_alloc_image_color (f
, img
, specified_bg
,
7293 FRAME_BACKGROUND_PIXEL (f
));
7294 for (j
= 0; j
<= idx
; ++j
)
7296 /* We use a local variable `raster' here because RasterBits is a
7297 char *, which invites problems with bytes >= 0x80. */
7298 struct SavedImage
*subimage
= gif
->SavedImages
+ j
;
7299 unsigned char *raster
= (unsigned char *) subimage
->RasterBits
;
7300 int transparency_color_index
= -1;
7302 int subimg_width
= subimage
->ImageDesc
.Width
;
7303 int subimg_height
= subimage
->ImageDesc
.Height
;
7304 int subimg_top
= subimage
->ImageDesc
.Top
;
7305 int subimg_left
= subimage
->ImageDesc
.Left
;
7307 /* Find the Graphic Control Extension block for this sub-image.
7308 Extract the disposal method and transparency color. */
7309 for (i
= 0; i
< subimage
->ExtensionBlockCount
; i
++)
7311 ExtensionBlock
*extblock
= subimage
->ExtensionBlocks
+ i
;
7313 if ((extblock
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
)
7314 && extblock
->ByteCount
== 4
7315 && extblock
->Bytes
[0] & 1)
7317 /* From gif89a spec: 1 = "keep in place", 2 = "restore
7318 to background". Treat any other value like 2. */
7319 disposal
= (extblock
->Bytes
[0] >> 2) & 7;
7320 transparency_color_index
= (unsigned char) extblock
->Bytes
[3];
7325 /* We can't "keep in place" the first subimage. */
7329 /* For disposal == 0, the spec says "No disposal specified. The
7330 decoder is not required to take any action." In practice, it
7331 seems we need to treat this like "keep in place", see e.g.
7332 http://upload.wikimedia.org/wikipedia/commons/3/37/Clock.gif */
7336 /* Allocate subimage colors. */
7337 memset (pixel_colors
, 0, sizeof pixel_colors
);
7338 gif_color_map
= subimage
->ImageDesc
.ColorMap
;
7340 gif_color_map
= gif
->SColorMap
;
7343 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
7345 if (transparency_color_index
== i
)
7346 pixel_colors
[i
] = STRINGP (specified_bg
)
7347 ? bgcolor
: FRAME_BACKGROUND_PIXEL (f
);
7350 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
7351 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
7352 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
7353 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
7357 /* Apply the pixel values. */
7358 if (gif
->SavedImages
[j
].ImageDesc
.Interlace
)
7362 for (y
= 0, row
= interlace_start
[0], pass
= 0;
7364 y
++, row
+= interlace_increment
[pass
])
7366 if (row
>= subimg_height
)
7368 row
= interlace_start
[++pass
];
7369 while (row
>= subimg_height
)
7370 row
= interlace_start
[++pass
];
7373 for (x
= 0; x
< subimg_width
; x
++)
7375 int c
= raster
[y
* subimg_width
+ x
];
7376 if (transparency_color_index
!= c
|| disposal
!= 1)
7377 XPutPixel (ximg
, x
+ subimg_left
, row
+ subimg_top
,
7384 for (y
= 0; y
< subimg_height
; ++y
)
7385 for (x
= 0; x
< subimg_width
; ++x
)
7387 int c
= raster
[y
* subimg_width
+ x
];
7388 if (transparency_color_index
!= c
|| disposal
!= 1)
7389 XPutPixel (ximg
, x
+ subimg_left
, y
+ subimg_top
,
7395 #ifdef COLOR_TABLE_SUPPORT
7396 img
->colors
= colors_in_color_table (&img
->ncolors
);
7397 free_color_table ();
7398 #endif /* COLOR_TABLE_SUPPORT */
7400 /* Save GIF image extension data for `image-metadata'.
7401 Format is (count IMAGES extension-data (FUNCTION "BYTES" ...)). */
7402 img
->lisp_data
= Qnil
;
7403 if (gif
->SavedImages
[idx
].ExtensionBlockCount
> 0)
7406 ExtensionBlock
*ext
= gif
->SavedImages
[idx
].ExtensionBlocks
;
7407 for (i
= 0; i
< gif
->SavedImages
[idx
].ExtensionBlockCount
; i
++, ext
++)
7408 /* Append (... FUNCTION "BYTES") */
7411 = Fcons (make_number (ext
->Function
),
7412 Fcons (make_unibyte_string (ext
->Bytes
, ext
->ByteCount
),
7414 if (ext
->Function
== GIF_LOCAL_DESCRIPTOR_EXTENSION
7415 && ext
->ByteCount
== 4)
7417 delay
= ext
->Bytes
[2] << CHAR_BIT
;
7418 delay
|= ext
->Bytes
[1];
7421 img
->lisp_data
= Fcons (Qextension_data
,
7422 Fcons (img
->lisp_data
, Qnil
));
7426 Fcons (make_float (delay
/ 100.0),
7430 if (gif
->ImageCount
> 1)
7431 img
->lisp_data
= Fcons (Qcount
,
7432 Fcons (make_number (gif
->ImageCount
),
7435 fn_DGifCloseFile (gif
);
7437 /* Maybe fill in the background field while we have ximg handy. */
7438 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7439 /* Casting avoids a GCC warning. */
7440 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
7442 /* Put the image into the pixmap, then free the X image and its buffer. */
7443 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7444 x_destroy_x_image (ximg
);
7449 #else /* !HAVE_GIF */
7453 gif_load (struct frame
*f
, struct image
*img
)
7455 return ns_load_image (f
, img
,
7456 image_spec_value (img
->spec
, QCfile
, NULL
),
7457 image_spec_value (img
->spec
, QCdata
, NULL
));
7459 #endif /* HAVE_NS */
7461 #endif /* HAVE_GIF */
7464 /***********************************************************************
7466 ***********************************************************************/
7467 #if defined (HAVE_IMAGEMAGICK)
7469 static Lisp_Object Qimagemagick
;
7471 static int imagemagick_image_p (Lisp_Object
);
7472 static int imagemagick_load (struct frame
*, struct image
*);
7473 static void imagemagick_clear_image (struct frame
*, struct image
*);
7475 /* Indices of image specification fields in imagemagick_format. */
7477 enum imagemagick_keyword_index
7485 IMAGEMAGICK_ALGORITHM
,
7486 IMAGEMAGICK_HEURISTIC_MASK
,
7488 IMAGEMAGICK_BACKGROUND
,
7491 IMAGEMAGICK_ROTATION
,
7496 /* Vector of image_keyword structures describing the format
7497 of valid user-defined image specifications. */
7499 static struct image_keyword imagemagick_format
[IMAGEMAGICK_LAST
] =
7501 {":type", IMAGE_SYMBOL_VALUE
, 1},
7502 {":data", IMAGE_STRING_VALUE
, 0},
7503 {":file", IMAGE_STRING_VALUE
, 0},
7504 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7505 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
7506 {":relief", IMAGE_INTEGER_VALUE
, 0},
7507 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7508 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7509 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7510 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
7511 {":height", IMAGE_INTEGER_VALUE
, 0},
7512 {":width", IMAGE_INTEGER_VALUE
, 0},
7513 {":rotation", IMAGE_NUMBER_VALUE
, 0},
7514 {":crop", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
7517 /* Structure describing the image type for any image handled via
7520 static struct image_type imagemagick_type
=
7523 imagemagick_image_p
,
7525 imagemagick_clear_image
,
7529 /* Free X resources of imagemagick image IMG which is used on frame F. */
7532 imagemagick_clear_image (struct frame
*f
,
7535 x_clear_image (f
, img
);
7538 /* Return non-zero if OBJECT is a valid IMAGEMAGICK image specification. Do
7539 this by calling parse_image_spec and supplying the keywords that
7540 identify the IMAGEMAGICK format. */
7543 imagemagick_image_p (Lisp_Object object
)
7545 struct image_keyword fmt
[IMAGEMAGICK_LAST
];
7546 memcpy (fmt
, imagemagick_format
, sizeof fmt
);
7548 if (!parse_image_spec (object
, fmt
, IMAGEMAGICK_LAST
, Qimagemagick
))
7551 /* Must specify either the :data or :file keyword. */
7552 return fmt
[IMAGEMAGICK_FILE
].count
+ fmt
[IMAGEMAGICK_DATA
].count
== 1;
7555 /* The GIF library also defines DrawRectangle, but its never used in Emacs.
7556 Therefore rename the function so it doesn't collide with ImageMagick. */
7557 #define DrawRectangle DrawRectangleGif
7558 #include <wand/MagickWand.h>
7560 /* ImageMagick 6.5.3 through 6.6.5 hid PixelGetMagickColor for some reason.
7561 Emacs seems to work fine with the hidden version, so unhide it. */
7562 #include <magick/version.h>
7563 #if 0x653 <= MagickLibVersion && MagickLibVersion <= 0x665
7564 extern WandExport
void PixelGetMagickColor (const PixelWand
*,
7565 MagickPixelPacket
*);
7568 /* Log ImageMagick error message.
7569 Useful when a ImageMagick function returns the status `MagickFalse'. */
7572 imagemagick_error (MagickWand
*wand
)
7575 ExceptionType severity
;
7577 description
= MagickGetException (wand
, &severity
);
7578 image_error ("ImageMagick error: %s",
7579 make_string (description
, strlen (description
)),
7581 description
= (char *) MagickRelinquishMemory (description
);
7584 /* Helper function for imagemagick_load, which does the actual loading
7585 given contents and size, apart from frame and image structures,
7586 passed from imagemagick_load. Uses librimagemagick to do most of
7587 the image processing.
7589 F is a pointer to the Emacs frame; IMG to the image structure to
7590 prepare; CONTENTS is the string containing the IMAGEMAGICK data to
7591 be parsed; SIZE is the number of bytes of data; and FILENAME is
7592 either the file name or the image data.
7594 Return non-zero if successful. */
7597 imagemagick_load_image (struct frame
*f
, struct image
*img
,
7598 unsigned char *contents
, unsigned int size
,
7604 MagickBooleanType status
;
7610 MagickWand
*image_wand
;
7611 MagickWand
*ping_wand
;
7612 PixelIterator
*iterator
;
7614 MagickPixelPacket pixel
;
7619 int desired_width
, desired_height
;
7622 ImageInfo
*image_info
;
7623 ExceptionInfo
*exception
;
7627 /* Handle image index for image types who can contain more than one image.
7628 Interface :index is same as for GIF. First we "ping" the image to see how
7629 many sub-images it contains. Pinging is faster than loading the image to
7630 find out things about it. */
7632 /* Initialize the imagemagick environment. */
7633 MagickWandGenesis ();
7634 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
7635 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
7636 ping_wand
= NewMagickWand ();
7637 /* MagickSetResolution (ping_wand, 2, 2); (Bug#10112) */
7639 if (filename
!= NULL
)
7641 status
= MagickPingImage (ping_wand
, filename
);
7645 status
= MagickPingImageBlob (ping_wand
, contents
, size
);
7648 if (status
== MagickFalse
)
7650 imagemagick_error (ping_wand
);
7651 DestroyMagickWand (ping_wand
);
7655 if (! (0 <= ino
&& ino
< MagickGetNumberImages (ping_wand
)))
7657 image_error ("Invalid image number `%s' in image `%s'",
7659 DestroyMagickWand (ping_wand
);
7663 if (MagickGetNumberImages (ping_wand
) > 1)
7666 Fcons (make_number (MagickGetNumberImages (ping_wand
)),
7669 DestroyMagickWand (ping_wand
);
7671 /* Now we know how many images are inside the file. If it's not a
7672 bundle, the number is one. */
7674 if (filename
!= NULL
)
7676 image_info
= CloneImageInfo ((ImageInfo
*) NULL
);
7677 (void) strcpy (image_info
->filename
, filename
);
7678 image_info
->number_scenes
= 1;
7679 image_info
->scene
= ino
;
7680 exception
= AcquireExceptionInfo ();
7682 im_image
= ReadImage (image_info
, exception
);
7683 DestroyExceptionInfo (exception
);
7685 if (im_image
== NULL
)
7686 goto imagemagick_no_wand
;
7687 image_wand
= NewMagickWandFromImage (im_image
);
7688 DestroyImage (im_image
);
7692 image_wand
= NewMagickWand ();
7693 if (MagickReadImageBlob (image_wand
, contents
, size
) == MagickFalse
)
7695 imagemagick_error (image_wand
);
7696 goto imagemagick_error
;
7700 /* If width and/or height is set in the display spec assume we want
7701 to scale to those values. If either h or w is unspecified, the
7702 unspecified should be calculated from the specified to preserve
7705 value
= image_spec_value (img
->spec
, QCwidth
, NULL
);
7706 desired_width
= (INTEGERP (value
) ? XFASTINT (value
) : -1);
7707 value
= image_spec_value (img
->spec
, QCheight
, NULL
);
7708 desired_height
= (INTEGERP (value
) ? XFASTINT (value
) : -1);
7710 height
= MagickGetImageHeight (image_wand
);
7711 width
= MagickGetImageWidth (image_wand
);
7713 if (desired_width
!= -1 && desired_height
== -1)
7714 /* w known, calculate h. */
7715 desired_height
= (double) desired_width
/ width
* height
;
7716 if (desired_width
== -1 && desired_height
!= -1)
7717 /* h known, calculate w. */
7718 desired_width
= (double) desired_height
/ height
* width
;
7719 if (desired_width
!= -1 && desired_height
!= -1)
7721 status
= MagickScaleImage (image_wand
, desired_width
, desired_height
);
7722 if (status
== MagickFalse
)
7724 image_error ("Imagemagick scale failed", Qnil
, Qnil
);
7725 imagemagick_error (image_wand
);
7726 goto imagemagick_error
;
7730 /* crop behaves similar to image slicing in Emacs but is more memory
7732 crop
= image_spec_value (img
->spec
, QCcrop
, NULL
);
7734 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7736 /* After some testing, it seems MagickCropImage is the fastest crop
7737 function in ImageMagick. This crop function seems to do less copying
7738 than the alternatives, but it still reads the entire image into memory
7739 before cropping, which is apparently difficult to avoid when using
7741 size_t crop_width
= XINT (XCAR (crop
));
7743 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (size_t, XCAR (crop
)))
7745 size_t crop_height
= XINT (XCAR (crop
));
7747 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7749 ssize_t crop_x
= XINT (XCAR (crop
));
7751 if (CONSP (crop
) && TYPE_RANGED_INTEGERP (ssize_t
, XCAR (crop
)))
7753 ssize_t crop_y
= XINT (XCAR (crop
));
7754 MagickCropImage (image_wand
, crop_width
, crop_height
,
7761 /* Furthermore :rotation. we need background color and angle for
7764 TODO background handling for rotation specified_bg =
7765 image_spec_value (img->spec, QCbackground, NULL); if (!STRINGP
7767 value
= image_spec_value (img
->spec
, QCrotation
, NULL
);
7770 PixelWand
* background
= NewPixelWand ();
7771 PixelSetColor (background
, "#ffffff");/*TODO remove hardcode*/
7773 rotation
= extract_float (value
);
7775 status
= MagickRotateImage (image_wand
, background
, rotation
);
7776 DestroyPixelWand (background
);
7777 if (status
== MagickFalse
)
7779 image_error ("Imagemagick image rotate failed", Qnil
, Qnil
);
7780 imagemagick_error (image_wand
);
7781 goto imagemagick_error
;
7785 /* Finally we are done manipulating the image. Figure out the
7786 resulting width/height and transfer ownership to Emacs. */
7787 height
= MagickGetImageHeight (image_wand
);
7788 width
= MagickGetImageWidth (image_wand
);
7790 if (! (width
<= INT_MAX
&& height
<= INT_MAX
7791 && check_image_size (f
, width
, height
)))
7793 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
7794 goto imagemagick_error
;
7797 /* We can now get a valid pixel buffer from the imagemagick file, if all
7800 init_color_table ();
7802 if (imagemagick_render_type
== 0)
7804 size_t image_height
;
7806 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7807 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
7808 &ximg
, &img
->pixmap
))
7810 #ifdef COLOR_TABLE_SUPPORT
7811 free_color_table ();
7813 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
7814 goto imagemagick_error
;
7817 /* Copy imagemagick image to x with primitive yet robust pixel
7818 pusher loop. This has been tested a lot with many different
7821 /* Copy pixels from the imagemagick image structure to the x image map. */
7822 iterator
= NewPixelIterator (image_wand
);
7823 if (iterator
== (PixelIterator
*) NULL
)
7825 #ifdef COLOR_TABLE_SUPPORT
7826 free_color_table ();
7828 x_destroy_x_image (ximg
);
7829 image_error ("Imagemagick pixel iterator creation failed",
7831 goto imagemagick_error
;
7834 image_height
= MagickGetImageHeight (image_wand
);
7835 for (y
= 0; y
< image_height
; y
++)
7837 pixels
= PixelGetNextIteratorRow (iterator
, &width
);
7838 if (pixels
== (PixelWand
**) NULL
)
7840 for (x
= 0; x
< (long) width
; x
++)
7842 PixelGetMagickColor (pixels
[x
], &pixel
);
7843 XPutPixel (ximg
, x
, y
,
7844 lookup_rgb_color (f
,
7850 DestroyPixelIterator (iterator
);
7852 else /* imagemagick_render_type != 0 */
7854 /* Magicexportimage is normally faster than pixelpushing. This
7855 method is also well tested. Some aspects of this method are
7856 ad-hoc and needs to be more researched. */
7857 int imagedepth
= 24;/*MagickGetImageDepth(image_wand);*/
7858 const char *exportdepth
= imagedepth
<= 8 ? "I" : "BGRP";/*"RGBP";*/
7859 /* Try to create a x pixmap to hold the imagemagick pixmap. */
7860 if (!x_create_x_image_and_pixmap (f
, width
, height
, imagedepth
,
7861 &ximg
, &img
->pixmap
))
7863 #ifdef COLOR_TABLE_SUPPORT
7864 free_color_table ();
7866 image_error ("Imagemagick X bitmap allocation failure", Qnil
, Qnil
);
7867 goto imagemagick_error
;
7871 /* Oddly, the below code doesn't seem to work:*/
7872 /* switch(ximg->bitmap_unit){ */
7874 /* pixelwidth=CharPixel; */
7877 /* pixelwidth=ShortPixel; */
7880 /* pixelwidth=LongPixel; */
7884 Here im just guessing the format of the bitmap.
7885 happens to work fine for:
7888 seems about 3 times as fast as pixel pushing(not carefully measured)
7890 pixelwidth
= CharPixel
;/*??? TODO figure out*/
7891 #ifdef HAVE_MAGICKEXPORTIMAGEPIXELS
7892 MagickExportImagePixels (image_wand
,
7897 /*&(img->pixmap));*/
7900 image_error ("You don't have MagickExportImagePixels, upgrade ImageMagick!",
7906 #ifdef COLOR_TABLE_SUPPORT
7907 /* Remember colors allocated for this image. */
7908 img
->colors
= colors_in_color_table (&img
->ncolors
);
7909 free_color_table ();
7910 #endif /* COLOR_TABLE_SUPPORT */
7914 img
->height
= height
;
7916 /* Put the image into the pixmap, then free the X image and its
7918 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7919 x_destroy_x_image (ximg
);
7922 /* Final cleanup. image_wand should be the only resource left. */
7923 DestroyMagickWand (image_wand
);
7924 /* `MagickWandTerminus' terminates the imagemagick environment. */
7925 MagickWandTerminus ();
7930 DestroyMagickWand (image_wand
);
7931 imagemagick_no_wand
:
7932 MagickWandTerminus ();
7933 /* TODO more cleanup. */
7934 image_error ("Error parsing IMAGEMAGICK image `%s'", img
->spec
, Qnil
);
7939 /* Load IMAGEMAGICK image IMG for use on frame F. Value is non-zero if
7940 successful. this function will go into the imagemagick_type structure, and
7941 the prototype thus needs to be compatible with that structure. */
7944 imagemagick_load (struct frame
*f
, struct image
*img
)
7947 Lisp_Object file_name
;
7949 /* If IMG->spec specifies a file name, create a non-file spec from it. */
7950 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
7951 if (STRINGP (file_name
))
7955 file
= x_find_image_file (file_name
);
7956 if (!STRINGP (file
))
7958 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
7961 success_p
= imagemagick_load_image (f
, img
, 0, 0, SSDATA (file
));
7963 /* Else its not a file, its a lisp object. Load the image from a
7964 lisp object rather than a file. */
7969 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7970 if (!STRINGP (data
))
7972 image_error ("Invalid image data `%s'", data
, Qnil
);
7975 success_p
= imagemagick_load_image (f
, img
, SDATA (data
),
7976 SBYTES (data
), NULL
);
7982 DEFUN ("imagemagick-types", Fimagemagick_types
, Simagemagick_types
, 0, 0, 0,
7983 doc
: /* Return a list of image types supported by ImageMagick.
7984 Each entry in this list is a symbol named after an ImageMagick format
7985 tag. See the ImageMagick manual for a list of ImageMagick formats and
7986 their descriptions (http://www.imagemagick.org/script/formats.php).
7987 You can also try the shell command: `identify -list format'.
7989 Note that ImageMagick recognizes many file-types that Emacs does not
7990 recognize as images, such as C. See `imagemagick-types-inhibit'. */)
7993 Lisp_Object typelist
= Qnil
;
7996 char **imtypes
= GetMagickList ("*", &numf
, &ex
);
7998 Lisp_Object Qimagemagicktype
;
7999 for (i
= 0; i
< numf
; i
++)
8001 Qimagemagicktype
= intern (imtypes
[i
]);
8002 typelist
= Fcons (Qimagemagicktype
, typelist
);
8004 return Fnreverse (typelist
);
8007 #endif /* defined (HAVE_IMAGEMAGICK) */
8011 /***********************************************************************
8013 ***********************************************************************/
8015 #if defined (HAVE_RSVG)
8017 /* Function prototypes. */
8019 static int svg_image_p (Lisp_Object object
);
8020 static int svg_load (struct frame
*f
, struct image
*img
);
8022 static int svg_load_image (struct frame
*, struct image
*,
8023 unsigned char *, ptrdiff_t);
8025 /* The symbol `svg' identifying images of this type. */
8027 static Lisp_Object Qsvg
;
8029 /* Indices of image specification fields in svg_format, below. */
8031 enum svg_keyword_index
8046 /* Vector of image_keyword structures describing the format
8047 of valid user-defined image specifications. */
8049 static const struct image_keyword svg_format
[SVG_LAST
] =
8051 {":type", IMAGE_SYMBOL_VALUE
, 1},
8052 {":data", IMAGE_STRING_VALUE
, 0},
8053 {":file", IMAGE_STRING_VALUE
, 0},
8054 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8055 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8056 {":relief", IMAGE_INTEGER_VALUE
, 0},
8057 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8058 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8059 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8060 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8063 /* Structure describing the image type `svg'. Its the same type of
8064 structure defined for all image formats, handled by emacs image
8065 functions. See struct image_type in dispextern.h. */
8067 static struct image_type svg_type
=
8069 /* An identifier showing that this is an image structure for the SVG format. */
8071 /* Handle to a function that can be used to identify a SVG file. */
8073 /* Handle to function used to load a SVG file. */
8075 /* Handle to function to free sresources for SVG. */
8077 /* An internal field to link to the next image type in a list of
8078 image types, will be filled in when registering the format. */
8083 /* Return non-zero if OBJECT is a valid SVG image specification. Do
8084 this by calling parse_image_spec and supplying the keywords that
8085 identify the SVG format. */
8088 svg_image_p (Lisp_Object object
)
8090 struct image_keyword fmt
[SVG_LAST
];
8091 memcpy (fmt
, svg_format
, sizeof fmt
);
8093 if (!parse_image_spec (object
, fmt
, SVG_LAST
, Qsvg
))
8096 /* Must specify either the :data or :file keyword. */
8097 return fmt
[SVG_FILE
].count
+ fmt
[SVG_DATA
].count
== 1;
8100 #include <librsvg/rsvg.h>
8104 /* SVG library functions. */
8105 DEF_IMGLIB_FN (RsvgHandle
*, rsvg_handle_new
);
8106 DEF_IMGLIB_FN (void, rsvg_handle_get_dimensions
);
8107 DEF_IMGLIB_FN (gboolean
, rsvg_handle_write
);
8108 DEF_IMGLIB_FN (gboolean
, rsvg_handle_close
);
8109 DEF_IMGLIB_FN (GdkPixbuf
*, rsvg_handle_get_pixbuf
);
8111 DEF_IMGLIB_FN (int, gdk_pixbuf_get_width
);
8112 DEF_IMGLIB_FN (int, gdk_pixbuf_get_height
);
8113 DEF_IMGLIB_FN (guchar
*, gdk_pixbuf_get_pixels
);
8114 DEF_IMGLIB_FN (int, gdk_pixbuf_get_rowstride
);
8115 DEF_IMGLIB_FN (GdkColorspace
, gdk_pixbuf_get_colorspace
);
8116 DEF_IMGLIB_FN (int, gdk_pixbuf_get_n_channels
);
8117 DEF_IMGLIB_FN (gboolean
, gdk_pixbuf_get_has_alpha
);
8118 DEF_IMGLIB_FN (int, gdk_pixbuf_get_bits_per_sample
);
8120 DEF_IMGLIB_FN (void, g_type_init
);
8121 DEF_IMGLIB_FN (void, g_object_unref
);
8122 DEF_IMGLIB_FN (void, g_error_free
);
8124 Lisp_Object Qgdk_pixbuf
, Qglib
, Qgobject
;
8127 init_svg_functions (Lisp_Object libraries
)
8129 HMODULE library
, gdklib
, glib
, gobject
;
8131 if (!(glib
= w32_delayed_load (libraries
, Qglib
))
8132 || !(gobject
= w32_delayed_load (libraries
, Qgobject
))
8133 || !(gdklib
= w32_delayed_load (libraries
, Qgdk_pixbuf
))
8134 || !(library
= w32_delayed_load (libraries
, Qsvg
)))
8137 LOAD_IMGLIB_FN (library
, rsvg_handle_new
);
8138 LOAD_IMGLIB_FN (library
, rsvg_handle_get_dimensions
);
8139 LOAD_IMGLIB_FN (library
, rsvg_handle_write
);
8140 LOAD_IMGLIB_FN (library
, rsvg_handle_close
);
8141 LOAD_IMGLIB_FN (library
, rsvg_handle_get_pixbuf
);
8143 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_width
);
8144 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_height
);
8145 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_pixels
);
8146 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_rowstride
);
8147 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_colorspace
);
8148 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_n_channels
);
8149 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_has_alpha
);
8150 LOAD_IMGLIB_FN (gdklib
, gdk_pixbuf_get_bits_per_sample
);
8152 LOAD_IMGLIB_FN (gobject
, g_type_init
);
8153 LOAD_IMGLIB_FN (gobject
, g_object_unref
);
8154 LOAD_IMGLIB_FN (glib
, g_error_free
);
8160 /* The following aliases for library functions allow dynamic loading
8161 to be used on some platforms. */
8162 #define fn_rsvg_handle_new rsvg_handle_new
8163 #define fn_rsvg_handle_get_dimensions rsvg_handle_get_dimensions
8164 #define fn_rsvg_handle_write rsvg_handle_write
8165 #define fn_rsvg_handle_close rsvg_handle_close
8166 #define fn_rsvg_handle_get_pixbuf rsvg_handle_get_pixbuf
8168 #define fn_gdk_pixbuf_get_width gdk_pixbuf_get_width
8169 #define fn_gdk_pixbuf_get_height gdk_pixbuf_get_height
8170 #define fn_gdk_pixbuf_get_pixels gdk_pixbuf_get_pixels
8171 #define fn_gdk_pixbuf_get_rowstride gdk_pixbuf_get_rowstride
8172 #define fn_gdk_pixbuf_get_colorspace gdk_pixbuf_get_colorspace
8173 #define fn_gdk_pixbuf_get_n_channels gdk_pixbuf_get_n_channels
8174 #define fn_gdk_pixbuf_get_has_alpha gdk_pixbuf_get_has_alpha
8175 #define fn_gdk_pixbuf_get_bits_per_sample gdk_pixbuf_get_bits_per_sample
8177 #define fn_g_type_init g_type_init
8178 #define fn_g_object_unref g_object_unref
8179 #define fn_g_error_free g_error_free
8180 #endif /* !HAVE_NTGUI */
8182 /* Load SVG image IMG for use on frame F. Value is non-zero if
8183 successful. this function will go into the svg_type structure, and
8184 the prototype thus needs to be compatible with that structure. */
8187 svg_load (struct frame
*f
, struct image
*img
)
8190 Lisp_Object file_name
;
8192 /* If IMG->spec specifies a file name, create a non-file spec from it. */
8193 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
8194 if (STRINGP (file_name
))
8197 unsigned char *contents
;
8200 file
= x_find_image_file (file_name
);
8201 if (!STRINGP (file
))
8203 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
8207 /* Read the entire file into memory. */
8208 contents
= slurp_file (SSDATA (file
), &size
);
8209 if (contents
== NULL
)
8211 image_error ("Error loading SVG image `%s'", img
->spec
, Qnil
);
8214 /* If the file was slurped into memory properly, parse it. */
8215 success_p
= svg_load_image (f
, img
, contents
, size
);
8218 /* Else its not a file, its a lisp object. Load the image from a
8219 lisp object rather than a file. */
8224 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8225 if (!STRINGP (data
))
8227 image_error ("Invalid image data `%s'", data
, Qnil
);
8230 success_p
= svg_load_image (f
, img
, SDATA (data
), SBYTES (data
));
8236 /* svg_load_image is a helper function for svg_load, which does the
8237 actual loading given contents and size, apart from frame and image
8238 structures, passed from svg_load.
8240 Uses librsvg to do most of the image processing.
8242 Returns non-zero when successful. */
8244 svg_load_image (struct frame
*f
, /* Pointer to emacs frame structure. */
8245 struct image
*img
, /* Pointer to emacs image structure. */
8246 unsigned char *contents
, /* String containing the SVG XML data to be parsed. */
8247 ptrdiff_t size
) /* Size of data in bytes. */
8249 RsvgHandle
*rsvg_handle
;
8250 RsvgDimensionData dimension_data
;
8255 const guint8
*pixels
;
8258 Lisp_Object specified_bg
;
8263 /* g_type_init is a glib function that must be called prior to using
8264 gnome type library functions. */
8266 /* Make a handle to a new rsvg object. */
8267 rsvg_handle
= fn_rsvg_handle_new ();
8269 /* Parse the contents argument and fill in the rsvg_handle. */
8270 fn_rsvg_handle_write (rsvg_handle
, contents
, size
, &err
);
8271 if (err
) goto rsvg_error
;
8273 /* The parsing is complete, rsvg_handle is ready to used, close it
8274 for further writes. */
8275 fn_rsvg_handle_close (rsvg_handle
, &err
);
8276 if (err
) goto rsvg_error
;
8278 fn_rsvg_handle_get_dimensions (rsvg_handle
, &dimension_data
);
8279 if (! check_image_size (f
, dimension_data
.width
, dimension_data
.height
))
8281 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8285 /* We can now get a valid pixel buffer from the svg file, if all
8287 pixbuf
= fn_rsvg_handle_get_pixbuf (rsvg_handle
);
8288 if (!pixbuf
) goto rsvg_error
;
8289 fn_g_object_unref (rsvg_handle
);
8291 /* Extract some meta data from the svg handle. */
8292 width
= fn_gdk_pixbuf_get_width (pixbuf
);
8293 height
= fn_gdk_pixbuf_get_height (pixbuf
);
8294 pixels
= fn_gdk_pixbuf_get_pixels (pixbuf
);
8295 rowstride
= fn_gdk_pixbuf_get_rowstride (pixbuf
);
8297 /* Validate the svg meta data. */
8298 eassert (fn_gdk_pixbuf_get_colorspace (pixbuf
) == GDK_COLORSPACE_RGB
);
8299 eassert (fn_gdk_pixbuf_get_n_channels (pixbuf
) == 4);
8300 eassert (fn_gdk_pixbuf_get_has_alpha (pixbuf
));
8301 eassert (fn_gdk_pixbuf_get_bits_per_sample (pixbuf
) == 8);
8303 /* Try to create a x pixmap to hold the svg pixmap. */
8304 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
8306 fn_g_object_unref (pixbuf
);
8310 init_color_table ();
8312 /* Handle alpha channel by combining the image with a background
8314 specified_bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
8315 if (!STRINGP (specified_bg
)
8316 || !x_defined_color (f
, SSDATA (specified_bg
), &background
, 0))
8319 background
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
8320 x_query_color (f
, &background
);
8322 ns_query_color (FRAME_BACKGROUND_COLOR (f
), &background
, 1);
8326 /* SVG pixmaps specify transparency in the last byte, so right
8327 shift 8 bits to get rid of it, since emacs doesn't support
8329 background
.red
>>= 8;
8330 background
.green
>>= 8;
8331 background
.blue
>>= 8;
8333 /* This loop handles opacity values, since Emacs assumes
8334 non-transparent images. Each pixel must be "flattened" by
8335 calculating the resulting color, given the transparency of the
8336 pixel, and the image background color. */
8337 for (y
= 0; y
< height
; ++y
)
8339 for (x
= 0; x
< width
; ++x
)
8349 opacity
= *pixels
++;
8351 red
= ((red
* opacity
)
8352 + (background
.red
* ((1 << 8) - opacity
)));
8353 green
= ((green
* opacity
)
8354 + (background
.green
* ((1 << 8) - opacity
)));
8355 blue
= ((blue
* opacity
)
8356 + (background
.blue
* ((1 << 8) - opacity
)));
8358 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, red
, green
, blue
));
8361 pixels
+= rowstride
- 4 * width
;
8364 #ifdef COLOR_TABLE_SUPPORT
8365 /* Remember colors allocated for this image. */
8366 img
->colors
= colors_in_color_table (&img
->ncolors
);
8367 free_color_table ();
8368 #endif /* COLOR_TABLE_SUPPORT */
8370 fn_g_object_unref (pixbuf
);
8373 img
->height
= height
;
8375 /* Maybe fill in the background field while we have ximg handy.
8376 Casting avoids a GCC warning. */
8377 IMAGE_BACKGROUND (img
, f
, (XImagePtr_or_DC
)ximg
);
8379 /* Put the image into the pixmap, then free the X image and its
8381 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
8382 x_destroy_x_image (ximg
);
8387 fn_g_object_unref (rsvg_handle
);
8388 /* FIXME: Use error->message so the user knows what is the actual
8389 problem with the image. */
8390 image_error ("Error parsing SVG image `%s'", img
->spec
, Qnil
);
8391 fn_g_error_free (err
);
8395 #endif /* defined (HAVE_RSVG) */
8400 /***********************************************************************
8402 ***********************************************************************/
8404 #ifdef HAVE_X_WINDOWS
8405 #define HAVE_GHOSTSCRIPT 1
8406 #endif /* HAVE_X_WINDOWS */
8408 #ifdef HAVE_GHOSTSCRIPT
8410 static int gs_image_p (Lisp_Object object
);
8411 static int gs_load (struct frame
*f
, struct image
*img
);
8412 static void gs_clear_image (struct frame
*f
, struct image
*img
);
8414 /* Keyword symbols. */
8416 static Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
8418 /* Indices of image specification fields in gs_format, below. */
8420 enum gs_keyword_index
8438 /* Vector of image_keyword structures describing the format
8439 of valid user-defined image specifications. */
8441 static const struct image_keyword gs_format
[GS_LAST
] =
8443 {":type", IMAGE_SYMBOL_VALUE
, 1},
8444 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8445 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
8446 {":file", IMAGE_STRING_VALUE
, 1},
8447 {":loader", IMAGE_FUNCTION_VALUE
, 0},
8448 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
8449 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8450 {":margin", IMAGE_NON_NEGATIVE_INTEGER_VALUE_OR_PAIR
, 0},
8451 {":relief", IMAGE_INTEGER_VALUE
, 0},
8452 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8453 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8454 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8455 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8458 /* Structure describing the image type `ghostscript'. */
8460 static struct image_type gs_type
=
8470 /* Free X resources of Ghostscript image IMG which is used on frame F. */
8473 gs_clear_image (struct frame
*f
, struct image
*img
)
8475 x_clear_image (f
, img
);
8479 /* Return non-zero if OBJECT is a valid Ghostscript image
8483 gs_image_p (Lisp_Object object
)
8485 struct image_keyword fmt
[GS_LAST
];
8489 memcpy (fmt
, gs_format
, sizeof fmt
);
8491 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
8494 /* Bounding box must be a list or vector containing 4 integers. */
8495 tem
= fmt
[GS_BOUNDING_BOX
].value
;
8498 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
8499 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
8504 else if (VECTORP (tem
))
8506 if (ASIZE (tem
) != 4)
8508 for (i
= 0; i
< 4; ++i
)
8509 if (!INTEGERP (XVECTOR (tem
)->contents
[i
]))
8519 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
8523 gs_load (struct frame
*f
, struct image
*img
)
8525 uprintmax_t printnum1
, printnum2
;
8526 char buffer
[sizeof " " + INT_STRLEN_BOUND (printmax_t
)];
8527 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
8529 double in_width
, in_height
;
8530 Lisp_Object pixel_colors
= Qnil
;
8532 /* Compute pixel size of pixmap needed from the given size in the
8533 image specification. Sizes in the specification are in pt. 1 pt
8534 = 1/72 in, xdpi and ydpi are stored in the frame's X display
8536 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
8537 in_width
= INTEGERP (pt_width
) ? XFASTINT (pt_width
) / 72.0 : 0;
8538 in_width
*= FRAME_X_DISPLAY_INFO (f
)->resx
;
8539 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
8540 in_height
= INTEGERP (pt_height
) ? XFASTINT (pt_height
) / 72.0 : 0;
8541 in_height
*= FRAME_X_DISPLAY_INFO (f
)->resy
;
8543 if (! (in_width
<= INT_MAX
&& in_height
<= INT_MAX
8544 && check_image_size (f
, in_width
, in_height
)))
8546 image_error ("Invalid image size (see `max-image-size')", Qnil
, Qnil
);
8549 img
->width
= in_width
;
8550 img
->height
= in_height
;
8552 /* Create the pixmap. */
8553 xassert (img
->pixmap
== NO_PIXMAP
);
8555 if (x_check_image_size (0, img
->width
, img
->height
))
8557 /* Only W32 version did BLOCK_INPUT here. ++kfs */
8559 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
8560 img
->width
, img
->height
,
8561 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
8567 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
8571 /* Call the loader to fill the pixmap. It returns a process object
8572 if successful. We do not record_unwind_protect here because
8573 other places in redisplay like calling window scroll functions
8574 don't either. Let the Lisp loader use `unwind-protect' instead. */
8575 printnum1
= FRAME_X_WINDOW (f
);
8576 printnum2
= img
->pixmap
;
8577 sprintf (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8578 window_and_pixmap_id
= build_string (buffer
);
8580 printnum1
= FRAME_FOREGROUND_PIXEL (f
);
8581 printnum2
= FRAME_BACKGROUND_PIXEL (f
);
8582 sprintf (buffer
, "%"pMu
" %"pMu
, printnum1
, printnum2
);
8583 pixel_colors
= build_string (buffer
);
8585 XSETFRAME (frame
, f
);
8586 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
8588 loader
= intern ("gs-load-image");
8590 img
->lisp_data
= call6 (loader
, frame
, img
->spec
,
8591 make_number (img
->width
),
8592 make_number (img
->height
),
8593 window_and_pixmap_id
,
8595 return PROCESSP (img
->lisp_data
);
8599 /* Kill the Ghostscript process that was started to fill PIXMAP on
8600 frame F. Called from XTread_socket when receiving an event
8601 telling Emacs that Ghostscript has finished drawing. */
8604 x_kill_gs_process (Pixmap pixmap
, struct frame
*f
)
8606 struct image_cache
*c
= FRAME_IMAGE_CACHE (f
);
8611 /* Find the image containing PIXMAP. */
8612 for (i
= 0; i
< c
->used
; ++i
)
8613 if (c
->images
[i
]->pixmap
== pixmap
)
8616 /* Should someone in between have cleared the image cache, for
8617 instance, give up. */
8621 /* Kill the GS process. We should have found PIXMAP in the image
8622 cache and its image should contain a process object. */
8624 xassert (PROCESSP (img
->lisp_data
));
8625 Fkill_process (img
->lisp_data
, Qnil
);
8626 img
->lisp_data
= Qnil
;
8628 #if defined (HAVE_X_WINDOWS)
8630 /* On displays with a mutable colormap, figure out the colors
8631 allocated for the image by looking at the pixels of an XImage for
8633 class = FRAME_X_VISUAL (f
)->class;
8634 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
8640 /* Try to get an XImage for img->pixmep. */
8641 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
8642 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
8647 /* Initialize the color table. */
8648 init_color_table ();
8650 /* For each pixel of the image, look its color up in the
8651 color table. After having done so, the color table will
8652 contain an entry for each color used by the image. */
8653 for (y
= 0; y
< img
->height
; ++y
)
8654 for (x
= 0; x
< img
->width
; ++x
)
8656 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
8657 lookup_pixel_color (f
, pixel
);
8660 /* Record colors in the image. Free color table and XImage. */
8661 #ifdef COLOR_TABLE_SUPPORT
8662 img
->colors
= colors_in_color_table (&img
->ncolors
);
8663 free_color_table ();
8665 XDestroyImage (ximg
);
8667 #if 0 /* This doesn't seem to be the case. If we free the colors
8668 here, we get a BadAccess later in x_clear_image when
8669 freeing the colors. */
8670 /* We have allocated colors once, but Ghostscript has also
8671 allocated colors on behalf of us. So, to get the
8672 reference counts right, free them once. */
8674 x_free_colors (f
, img
->colors
, img
->ncolors
);
8678 image_error ("Cannot get X image of `%s'; colors will not be freed",
8683 #endif /* HAVE_X_WINDOWS */
8685 /* Now that we have the pixmap, compute mask and transform the
8686 image if requested. */
8688 postprocess_image (f
, img
);
8692 #endif /* HAVE_GHOSTSCRIPT */
8695 /***********************************************************************
8697 ***********************************************************************/
8701 DEFUN ("imagep", Fimagep
, Simagep
, 1, 1, 0,
8702 doc
: /* Value is non-nil if SPEC is a valid image specification. */)
8705 return valid_image_p (spec
) ? Qt
: Qnil
;
8709 DEFUN ("lookup-image", Flookup_image
, Slookup_image
, 1, 1, 0, "")
8714 if (valid_image_p (spec
))
8715 id
= lookup_image (SELECTED_FRAME (), spec
);
8718 return make_number (id
);
8721 #endif /* GLYPH_DEBUG != 0 */
8724 /***********************************************************************
8726 ***********************************************************************/
8729 /* Image types that rely on external libraries are loaded dynamically
8730 if the library is available. */
8731 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8732 define_image_type (image_type, init_lib_fn (libraries))
8734 #define CHECK_LIB_AVAILABLE(image_type, init_lib_fn, libraries) \
8735 define_image_type (image_type, 1)
8736 #endif /* HAVE_NTGUI */
8738 DEFUN ("init-image-library", Finit_image_library
, Sinit_image_library
, 2, 2, 0,
8739 doc
: /* Initialize image library implementing image type TYPE.
8740 Return non-nil if TYPE is a supported image type.
8742 Image types pbm and xbm are prebuilt; other types are loaded here.
8743 Libraries to load are specified in alist LIBRARIES (usually, the value
8744 of `dynamic-library-alist', which see). */)
8745 (Lisp_Object type
, Lisp_Object libraries
)
8748 /* Don't try to reload the library. */
8749 Lisp_Object tested
= Fassq (type
, Vlibrary_cache
);
8751 return XCDR (tested
);
8754 /* Types pbm and xbm are built-in and always available. */
8755 if (EQ (type
, Qpbm
) || EQ (type
, Qxbm
))
8758 #if defined (HAVE_XPM) || defined (HAVE_NS)
8759 if (EQ (type
, Qxpm
))
8760 return CHECK_LIB_AVAILABLE (&xpm_type
, init_xpm_functions
, libraries
);
8763 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8764 if (EQ (type
, Qjpeg
))
8765 return CHECK_LIB_AVAILABLE (&jpeg_type
, init_jpeg_functions
, libraries
);
8768 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8769 if (EQ (type
, Qtiff
))
8770 return CHECK_LIB_AVAILABLE (&tiff_type
, init_tiff_functions
, libraries
);
8773 #if defined (HAVE_GIF) || defined (HAVE_NS)
8774 if (EQ (type
, Qgif
))
8775 return CHECK_LIB_AVAILABLE (&gif_type
, init_gif_functions
, libraries
);
8778 #if defined (HAVE_PNG) || defined (HAVE_NS)
8779 if (EQ (type
, Qpng
))
8780 return CHECK_LIB_AVAILABLE (&png_type
, init_png_functions
, libraries
);
8783 #if defined (HAVE_RSVG)
8784 if (EQ (type
, Qsvg
))
8785 return CHECK_LIB_AVAILABLE (&svg_type
, init_svg_functions
, libraries
);
8788 #if defined (HAVE_IMAGEMAGICK)
8789 if (EQ (type
, Qimagemagick
))
8790 return CHECK_LIB_AVAILABLE (&imagemagick_type
, init_imagemagick_functions
,
8794 #ifdef HAVE_GHOSTSCRIPT
8795 if (EQ (type
, Qpostscript
))
8796 return CHECK_LIB_AVAILABLE (&gs_type
, init_gs_functions
, libraries
);
8799 /* If the type is not recognized, avoid testing it ever again. */
8800 CACHE_IMAGE_TYPE (type
, Qnil
);
8805 syms_of_image (void)
8807 /* Initialize this only once, since that's what we do with Vimage_types
8808 and they are supposed to be in sync. Initializing here gives correct
8809 operation on GNU/Linux of calling dump-emacs after loading some images. */
8812 /* Must be defined now because we're going to update it below, while
8813 defining the supported image types. */
8814 DEFVAR_LISP ("image-types", Vimage_types
,
8815 doc
: /* List of potentially supported image types.
8816 Each element of the list is a symbol for an image type, like 'jpeg or 'png.
8817 To check whether it is really supported, use `image-type-available-p'. */);
8818 Vimage_types
= Qnil
;
8820 DEFVAR_LISP ("max-image-size", Vmax_image_size
,
8821 doc
: /* Maximum size of images.
8822 Emacs will not load an image into memory if its pixel width or
8823 pixel height exceeds this limit.
8825 If the value is an integer, it directly specifies the maximum
8826 image height and width, measured in pixels. If it is a floating
8827 point number, it specifies the maximum image height and width
8828 as a ratio to the frame height and width. If the value is
8829 non-numeric, there is no explicit limit on the size of images. */);
8830 Vmax_image_size
= make_float (MAX_IMAGE_SIZE
);
8832 DEFSYM (Qpbm
, "pbm");
8833 ADD_IMAGE_TYPE (Qpbm
);
8835 DEFSYM (Qxbm
, "xbm");
8836 ADD_IMAGE_TYPE (Qxbm
);
8838 define_image_type (&xbm_type
, 1);
8839 define_image_type (&pbm_type
, 1);
8841 DEFSYM (Qcount
, "count");
8842 DEFSYM (Qextension_data
, "extension-data");
8843 DEFSYM (Qdelay
, "delay");
8845 DEFSYM (QCascent
, ":ascent");
8846 DEFSYM (QCmargin
, ":margin");
8847 DEFSYM (QCrelief
, ":relief");
8848 DEFSYM (QCconversion
, ":conversion");
8849 DEFSYM (QCcolor_symbols
, ":color-symbols");
8850 DEFSYM (QCheuristic_mask
, ":heuristic-mask");
8851 DEFSYM (QCindex
, ":index");
8852 DEFSYM (QCgeometry
, ":geometry");
8853 DEFSYM (QCcrop
, ":crop");
8854 DEFSYM (QCrotation
, ":rotation");
8855 DEFSYM (QCmatrix
, ":matrix");
8856 DEFSYM (QCcolor_adjustment
, ":color-adjustment");
8857 DEFSYM (QCmask
, ":mask");
8859 DEFSYM (Qlaplace
, "laplace");
8860 DEFSYM (Qemboss
, "emboss");
8861 DEFSYM (Qedge_detection
, "edge-detection");
8862 DEFSYM (Qheuristic
, "heuristic");
8864 DEFSYM (Qpostscript
, "postscript");
8865 #ifdef HAVE_GHOSTSCRIPT
8866 ADD_IMAGE_TYPE (Qpostscript
);
8867 DEFSYM (QCloader
, ":loader");
8868 DEFSYM (QCbounding_box
, ":bounding-box");
8869 DEFSYM (QCpt_width
, ":pt-width");
8870 DEFSYM (QCpt_height
, ":pt-height");
8871 #endif /* HAVE_GHOSTSCRIPT */
8874 DEFSYM (Qlibpng_version
, "libpng-version");
8875 Fset (Qlibpng_version
,
8877 make_number (PNG_LIBPNG_VER
)
8884 #if defined (HAVE_XPM) || defined (HAVE_NS)
8885 DEFSYM (Qxpm
, "xpm");
8886 ADD_IMAGE_TYPE (Qxpm
);
8889 #if defined (HAVE_JPEG) || defined (HAVE_NS)
8890 DEFSYM (Qjpeg
, "jpeg");
8891 ADD_IMAGE_TYPE (Qjpeg
);
8894 #if defined (HAVE_TIFF) || defined (HAVE_NS)
8895 DEFSYM (Qtiff
, "tiff");
8896 ADD_IMAGE_TYPE (Qtiff
);
8899 #if defined (HAVE_GIF) || defined (HAVE_NS)
8900 DEFSYM (Qgif
, "gif");
8901 ADD_IMAGE_TYPE (Qgif
);
8904 #if defined (HAVE_PNG) || defined (HAVE_NS)
8905 DEFSYM (Qpng
, "png");
8906 ADD_IMAGE_TYPE (Qpng
);
8909 #if defined (HAVE_IMAGEMAGICK)
8910 DEFSYM (Qimagemagick
, "imagemagick");
8911 ADD_IMAGE_TYPE (Qimagemagick
);
8914 #if defined (HAVE_RSVG)
8915 DEFSYM (Qsvg
, "svg");
8916 ADD_IMAGE_TYPE (Qsvg
);
8918 /* Other libraries used directly by svg code. */
8919 DEFSYM (Qgdk_pixbuf
, "gdk-pixbuf");
8920 DEFSYM (Qglib
, "glib");
8921 DEFSYM (Qgobject
, "gobject");
8922 #endif /* HAVE_NTGUI */
8923 #endif /* HAVE_RSVG */
8925 defsubr (&Sinit_image_library
);
8926 #ifdef HAVE_IMAGEMAGICK
8927 defsubr (&Simagemagick_types
);
8929 defsubr (&Sclear_image_cache
);
8930 defsubr (&Simage_flush
);
8931 defsubr (&Simage_size
);
8932 defsubr (&Simage_mask_p
);
8933 defsubr (&Simage_metadata
);
8937 defsubr (&Slookup_image
);
8940 DEFVAR_BOOL ("cross-disabled-images", cross_disabled_images
,
8941 doc
: /* Non-nil means always draw a cross over disabled images.
8942 Disabled images are those having a `:conversion disabled' property.
8943 A cross is always drawn on black & white displays. */);
8944 cross_disabled_images
= 0;
8946 DEFVAR_LISP ("x-bitmap-file-path", Vx_bitmap_file_path
,
8947 doc
: /* List of directories to search for window system bitmap files. */);
8948 Vx_bitmap_file_path
= decode_env_path ((char *) 0, PATH_BITMAPS
);
8950 DEFVAR_LISP ("image-cache-eviction-delay", Vimage_cache_eviction_delay
,
8951 doc
: /* Maximum time after which images are removed from the cache.
8952 When an image has not been displayed this many seconds, Emacs
8953 automatically removes it from the image cache. If the cache contains
8954 a large number of images, the actual eviction time may be shorter.
8955 The value can also be nil, meaning the cache is never cleared.
8957 The function `clear-image-cache' disregards this variable. */);
8958 Vimage_cache_eviction_delay
= make_number (300);
8959 #ifdef HAVE_IMAGEMAGICK
8960 DEFVAR_INT ("imagemagick-render-type", imagemagick_render_type
,
8961 doc
: /* Integer indicating which ImageMagick rendering method to use.
8963 0 -- the default method (pixel pushing)
8964 1 -- a newer method ("MagickExportImagePixels") that may perform
8965 better (speed etc) in some cases, but has not been as thoroughly
8966 tested with Emacs as the default method. This method requires
8967 ImageMagick version 6.4.6 (approximately) or later.
8969 /* MagickExportImagePixels is in 6.4.6-9, but not 6.4.4-10. */
8970 imagemagick_render_type
= 0;