[wxWidgets.git] / src / xpm / xpm.h

/*
 * Copyright (C) 1989-95 GROUPE BULL
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * GROUPE BULL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * Except as contained in this notice, the name of GROUPE BULL shall not be
 * used in advertising or otherwise to promote the sale, use or other dealings
 * in this Software without prior written authorization from GROUPE BULL.
 */

/*****************************************************************************\
* xpm.h:                                                                      *
*                                                                             *
*  XPM library                                                                *
*  Include file                                                               *
*                                                                             *
*  Developed by Arnaud Le Hors                                                *
\*****************************************************************************/

/*
 * The code related to FOR_MSW has been added by
 * HeDu (hedu@cul-ipn.uni-kiel.de) 4/94
 */

/*
 * The code related to AMIGA has been added by
 * Lorens Younes (d93-hyo@nada.kth.se) 4/96
 */

#ifndef XPM_h
#define XPM_h

#if (defined(_WINDOWS) || defined(__WXMSW__) || defined(WIN32)) && !defined(FOR_MSW)
#define FOR_MSW
#endif
/* Piggyback on MSW for now */
#if (defined(__OS2__) || defined(__WXPM__) || defined(OS232)) && !defined(FOR_MSW)
#define FOR_MSW
#endif

/*
 * first some identification numbers:
 * the version and revision numbers are determined with the following rule:
 * SO Major number = LIB minor version number.
 * SO Minor number = LIB sub-minor version number.
 * e.g: Xpm version 3.2f
 *      we forget the 3 which is the format number, 2 gives 2, and f gives 6.
 *      thus we have XpmVersion = 2 and XpmRevision = 6
 *      which gives  SOXPMLIBREV = 2.6
 *
 * Then the XpmIncludeVersion number is built from these numbers.
 */
#define XpmFormat 3
#define XpmVersion 4
#define XpmRevision 11
#define XpmIncludeVersion ((XpmFormat * 100 + XpmVersion) * 100 + XpmRevision)

#ifndef XPM_NUMBERS

#ifdef FOR_MSW
# define SYSV			/* uses memcpy string.h etc. */
# include <malloc.h>
# include "simx.h"		/* defines some X stuff using MSW types */
#define NEED_STRCASECMP		/* at least for MSVC++ */
#else /* FOR_MSW */
# ifdef AMIGA
#  include "amigax.h"
# else /* not AMIGA */
#  include <X11/Xlib.h>
#  include <X11/Xutil.h>
# endif /* not AMIGA */
#endif /* FOR_MSW */

/* let's define Pixel if it is not done yet */
#if ! defined(_XtIntrinsic_h) && ! defined(PIXEL_ALREADY_TYPEDEFED)
typedef unsigned long Pixel;	/* Index into colormap */
# define PIXEL_ALREADY_TYPEDEFED
#endif

/* make sure we know whether function prototypes are needed or not */
#ifndef NeedFunctionPrototypes
# if defined(__STDC__) || defined(__cplusplus) || defined(c_plusplus)
#  define NeedFunctionPrototypes 1
# else
#  define NeedFunctionPrototypes 0
# endif
#endif


/* Return ErrorStatus codes:
 * null     if full success
 * positive if partial success
 * negative if failure
 */

#define XpmColorError    1
#define XpmSuccess       0
#define XpmOpenFailed   -1
#define XpmFileInvalid  -2
#define XpmNoMemory     -3
#define XpmColorFailed  -4

typedef struct {
    char *name;			/* Symbolic color name */
    char *value;		/* Color value */
    Pixel pixel;		/* Color pixel */
}      XpmColorSymbol;

typedef struct {
    char *name;			/* name of the extension */
    unsigned int nlines;	/* number of lines in this extension */
    char **lines;		/* pointer to the extension array of strings */
}      XpmExtension;

typedef struct {
    char *string;		/* characters string */
    char *symbolic;		/* symbolic name */
    char *m_color;		/* monochrom default */
    char *g4_color;		/* 4 level grayscale default */
    char *g_color;		/* other level grayscale default */
    char *c_color;		/* color default */
}      XpmColor;

typedef struct {
    unsigned int width;		/* image width */
    unsigned int height;	/* image height */
    unsigned int cpp;		/* number of characters per pixel */
    unsigned int ncolors;	/* number of colors */
    XpmColor *colorTable;	/* list of related colors */
    unsigned int *data;		/* image data */
}      XpmImage;

typedef struct {
    unsigned long valuemask;	/* Specifies which attributes are defined */
    char *hints_cmt;		/* Comment of the hints section */
    char *colors_cmt;		/* Comment of the colors section */
    char *pixels_cmt;		/* Comment of the pixels section */
    unsigned int x_hotspot;	/* Returns the x hotspot's coordinate */
    unsigned int y_hotspot;	/* Returns the y hotspot's coordinate */
    unsigned int nextensions;	/* number of extensions */
    XpmExtension *extensions;	/* pointer to array of extensions */
}      XpmInfo;

typedef int (*XpmAllocColorFunc)(
#if NeedFunctionPrototypes
    Display*			/* display */,
    Colormap			/* colormap */,
    char*			/* colorname */,
    XColor*			/* xcolor */,
    void*			/* closure */
#endif
);

typedef int (*XpmFreeColorsFunc)(
#if NeedFunctionPrototypes
    Display*			/* display */,
    Colormap			/* colormap */,
    Pixel*			/* pixels */,
    int				/* npixels */,
    void*			/* closure */
#endif
);

typedef struct {
    unsigned long valuemask;		/* Specifies which attributes are
					   defined */

    Visual *visual;			/* Specifies the visual to use */
    Colormap colormap;			/* Specifies the colormap to use */
    unsigned int depth;			/* Specifies the depth */
    unsigned int width;			/* Returns the width of the created
					   pixmap */
    unsigned int height;		/* Returns the height of the created
					   pixmap */
    unsigned int x_hotspot;		/* Returns the x hotspot's
					   coordinate */
    unsigned int y_hotspot;		/* Returns the y hotspot's
					   coordinate */
    unsigned int cpp;			/* Specifies the number of char per
					   pixel */
    Pixel *pixels;			/* List of used color pixels */
    unsigned int npixels;		/* Number of used pixels */
    XpmColorSymbol *colorsymbols;	/* List of color symbols to override */
    unsigned int numsymbols;		/* Number of symbols */
    char *rgb_fname;			/* RGB text file name */
    unsigned int nextensions;		/* Number of extensions */
    XpmExtension *extensions;		/* List of extensions */

    unsigned int ncolors;               /* Number of colors */
    XpmColor *colorTable;               /* List of colors */
/* 3.2 backward compatibility code */
    char *hints_cmt;                    /* Comment of the hints section */
    char *colors_cmt;                   /* Comment of the colors section */
    char *pixels_cmt;                   /* Comment of the pixels section */
/* end 3.2 bc */
    unsigned int mask_pixel;            /* Color table index of transparent
                                           color */

    /* Color Allocation Directives */
    Bool exactColors;			/* Only use exact colors for visual */
    unsigned int closeness;		/* Allowable RGB deviation */
    unsigned int red_closeness;		/* Allowable red deviation */
    unsigned int green_closeness;	/* Allowable green deviation */
    unsigned int blue_closeness;	/* Allowable blue deviation */
    int color_key;			/* Use colors from this color set */

    Pixel *alloc_pixels;		/* Returns the list of alloc'ed color
					   pixels */
    int nalloc_pixels;			/* Returns the number of alloc'ed
					   color pixels */

    Bool alloc_close_colors;    	/* Specify whether close colors should
					   be allocated using XAllocColor
					   or not */
    int bitmap_format;			/* Specify the format of 1bit depth
					   images: ZPixmap or XYBitmap */

    /* Color functions */
    XpmAllocColorFunc alloc_color;	/* Application color allocator */
    XpmFreeColorsFunc free_colors;	/* Application color de-allocator */
    void *color_closure;		/* Application private data to pass to
					   alloc_color and free_colors */

}      XpmAttributes;

/* XpmAttributes value masks bits */
#define XpmVisual	   (1L<<0)
#define XpmColormap	   (1L<<1)
#define XpmDepth	   (1L<<2)
#define XpmSize		   (1L<<3)	/* width & height */
#define XpmHotspot	   (1L<<4)	/* x_hotspot & y_hotspot */
#define XpmCharsPerPixel   (1L<<5)
#define XpmColorSymbols	   (1L<<6)
#define XpmRgbFilename	   (1L<<7)
/* 3.2 backward compatibility code */
#define XpmInfos	   (1L<<8)
#define XpmReturnInfos	   XpmInfos
/* end 3.2 bc */
#define XpmReturnPixels	   (1L<<9)
#define XpmExtensions      (1L<<10)
#define XpmReturnExtensions XpmExtensions

#define XpmExactColors     (1L<<11)
#define XpmCloseness	   (1L<<12)
#define XpmRGBCloseness	   (1L<<13)
#define XpmColorKey	   (1L<<14)

#define XpmColorTable      (1L<<15)
#define XpmReturnColorTable XpmColorTable

#define XpmReturnAllocPixels (1L<<16)
#define XpmAllocCloseColors (1L<<17)
#define XpmBitmapFormat    (1L<<18)

#define XpmAllocColor      (1L<<19)
#define XpmFreeColors      (1L<<20)
#define XpmColorClosure    (1L<<21)


/* XpmInfo value masks bits */
#define XpmComments        XpmInfos
#define XpmReturnComments  XpmComments

/* XpmAttributes mask_pixel value when there is no mask */
#ifndef FOR_MSW
#define XpmUndefPixel 0x80000000
#else
/* int is only 16 bit for MSW */
#define XpmUndefPixel 0x8000
#endif

/*
 * color keys for visual type, they must fit along with the number key of
 * each related element in xpmColorKeys[] defined in XpmI.h
 */
#define XPM_MONO	2
#define XPM_GREY4	3
#define XPM_GRAY4	3
#define XPM_GREY 	4
#define XPM_GRAY 	4
#define XPM_COLOR	5


/* macros for forward declarations of functions with prototypes */
#if NeedFunctionPrototypes
#define FUNC(f, t, p) extern t f p
#define LFUNC(f, t, p) static t f p
#else
#define FUNC(f, t, p) extern t f()
#define LFUNC(f, t, p) static t f()
#endif


/*
 * functions declarations
 */

#ifdef __cplusplus
extern "C" {
#endif

/* FOR_MSW, all ..Pixmap.. are excluded, only the ..XImage.. are used */
/* Same for Amiga! */

#if !defined(FOR_MSW) && !defined(AMIGA)
    FUNC(XpmCreatePixmapFromData, int, (Display *display,
					Drawable d,
					char **data,
					Pixmap *pixmap_return,
					Pixmap *shapemask_return,
					XpmAttributes *attributes));

    FUNC(XpmCreateDataFromPixmap, int, (Display *display,
					char ***data_return,
					Pixmap pixmap,
					Pixmap shapemask,
					XpmAttributes *attributes));

    FUNC(XpmReadFileToPixmap, int, (Display *display,
				    Drawable d,
				    char *filename,
				    Pixmap *pixmap_return,
				    Pixmap *shapemask_return,
				    XpmAttributes *attributes));

    FUNC(XpmWriteFileFromPixmap, int, (Display *display,
				       char *filename,
				       Pixmap pixmap,
				       Pixmap shapemask,
				       XpmAttributes *attributes));
#endif

    FUNC(XpmCreateImageFromData, int, (Display *display,
				       char **data,
				       XImage **image_return,
				       XImage **shapemask_return,
				       XpmAttributes *attributes));

    FUNC(XpmCreateDataFromImage, int, (Display *display,
				       char ***data_return,
				       XImage *image,
				       XImage *shapeimage,
				       XpmAttributes *attributes));

    FUNC(XpmReadFileToImage, int, (Display *display,
				   char *filename,
				   XImage **image_return,
				   XImage **shapeimage_return,
				   XpmAttributes *attributes));

    FUNC(XpmWriteFileFromImage, int, (Display *display,
				      char *filename,
				      XImage *image,
				      XImage *shapeimage,
				      XpmAttributes *attributes));

    FUNC(XpmCreateImageFromBuffer, int, (Display *display,
					 char *buffer,
					 XImage **image_return,
					 XImage **shapemask_return,
					 XpmAttributes *attributes));
#if !defined(FOR_MSW) && !defined(AMIGA)
    FUNC(XpmCreatePixmapFromBuffer, int, (Display *display,
					  Drawable d,
					  char *buffer,
					  Pixmap *pixmap_return,
					  Pixmap *shapemask_return,
					  XpmAttributes *attributes));

    FUNC(XpmCreateBufferFromImage, int, (Display *display,
					 char **buffer_return,
					 XImage *image,
					 XImage *shapeimage,
					 XpmAttributes *attributes));

    FUNC(XpmCreateBufferFromPixmap, int, (Display *display,
					  char **buffer_return,
					  Pixmap pixmap,
					  Pixmap shapemask,
					  XpmAttributes *attributes));
#endif
    FUNC(XpmReadFileToBuffer, int, (char *filename, char **buffer_return));
    FUNC(XpmWriteFileFromBuffer, int, (char *filename, char *buffer));

    FUNC(XpmReadFileToData, int, (char *filename, char ***data_return));
    FUNC(XpmWriteFileFromData, int, (char *filename, char **data));

    FUNC(XpmAttributesSize, int, ());
    FUNC(XpmFreeAttributes, void, (XpmAttributes *attributes));
    FUNC(XpmFreeExtensions, void, (XpmExtension *extensions,
				   int nextensions));

    FUNC(XpmFreeXpmImage, void, (XpmImage *image));
    FUNC(XpmFreeXpmInfo, void, (XpmInfo *info));
    FUNC(XpmGetErrorString, char *, (int errcode));
    FUNC(XpmLibraryVersion, int, ());

    /* XpmImage functions */
    FUNC(XpmReadFileToXpmImage, int, (char *filename,
				      XpmImage *image,
				      XpmInfo *info));

    FUNC(XpmWriteFileFromXpmImage, int, (char *filename,
					 XpmImage *image,
					 XpmInfo *info));
#if !defined(FOR_MSW) && !defined(AMIGA)
    FUNC(XpmCreatePixmapFromXpmImage, int, (Display *display,
					    Drawable d,
					    XpmImage *image,
					    Pixmap *pixmap_return,
					    Pixmap *shapemask_return,
					    XpmAttributes *attributes));
#endif
    FUNC(XpmCreateImageFromXpmImage, int, (Display *display,
					   XpmImage *image,
					   XImage **image_return,
					   XImage **shapeimage_return,
					   XpmAttributes *attributes));

    FUNC(XpmCreateXpmImageFromImage, int, (Display *display,
					   XImage *image,
					   XImage *shapeimage,
					   XpmImage *xpmimage,
					   XpmAttributes *attributes));
#if !defined(FOR_MSW) && !defined(AMIGA)
    FUNC(XpmCreateXpmImageFromPixmap, int, (Display *display,
					    Pixmap pixmap,
					    Pixmap shapemask,
					    XpmImage *xpmimage,
					    XpmAttributes *attributes));
#endif
    FUNC(XpmCreateDataFromXpmImage, int, (char ***data_return,
					  XpmImage *image,
					  XpmInfo *info));

    FUNC(XpmCreateXpmImageFromData, int, (char **data,
					  XpmImage *image,
					  XpmInfo *info));

    FUNC(XpmCreateXpmImageFromBuffer, int, (char *buffer,
					    XpmImage *image,
					    XpmInfo *info));

    FUNC(XpmCreateBufferFromXpmImage, int, (char **buffer_return,
					    XpmImage *image,
					    XpmInfo *info));

    FUNC(XpmGetParseError, int, (char *filename,
				 int *linenum_return,
				 int *charnum_return));

    FUNC(XpmFree, void, (void *ptr));

#ifdef __cplusplus
} /* for C++ V2.0 */
#endif


/* backward compatibility */

/* for version 3.0c */
#define XpmPixmapColorError  XpmColorError
#define XpmPixmapSuccess     XpmSuccess
#define XpmPixmapOpenFailed  XpmOpenFailed
#define XpmPixmapFileInvalid XpmFileInvalid
#define XpmPixmapNoMemory    XpmNoMemory
#define XpmPixmapColorFailed XpmColorFailed

#define XpmReadPixmapFile(dpy, d, file, pix, mask, att) \
    XpmReadFileToPixmap(dpy, d, file, pix, mask, att)
#define XpmWritePixmapFile(dpy, file, pix, mask, att) \
    XpmWriteFileFromPixmap(dpy, file, pix, mask, att)

/* for version 3.0b */
#define PixmapColorError  XpmColorError
#define PixmapSuccess     XpmSuccess
#define PixmapOpenFailed  XpmOpenFailed
#define PixmapFileInvalid XpmFileInvalid
#define PixmapNoMemory    XpmNoMemory
#define PixmapColorFailed XpmColorFailed

#define ColorSymbol XpmColorSymbol

#define XReadPixmapFile(dpy, d, file, pix, mask, att) \
    XpmReadFileToPixmap(dpy, d, file, pix, mask, att)
#define XWritePixmapFile(dpy, file, pix, mask, att) \
    XpmWriteFileFromPixmap(dpy, file, pix, mask, att)
#define XCreatePixmapFromData(dpy, d, data, pix, mask, att) \
    XpmCreatePixmapFromData(dpy, d, data, pix, mask, att)
#define XCreateDataFromPixmap(dpy, data, pix, mask, att) \
    XpmCreateDataFromPixmap(dpy, data, pix, mask, att)

#endif /* XPM_NUMBERS */
#endif
Commit	Line	Data
cfbe03c9	1	/*
e6ed776f	2	* Copyright (C) 1989-95 GROUPE BULL
cfbe03c9 JS	3	*
	4	* Permission is hereby granted, free of charge, to any person obtaining a copy
	5	* of this software and associated documentation files (the "Software"), to
	6	* deal in the Software without restriction, including without limitation the
	7	* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
	8	* sell copies of the Software, and to permit persons to whom the Software is
	9	* furnished to do so, subject to the following conditions:
	10	*
	11	* The above copyright notice and this permission notice shall be included in
	12	* all copies or substantial portions of the Software.
	13	*
	14	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	15	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	17	* GROUPE BULL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
	18	* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	19	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
	20	*
	21	* Except as contained in this notice, the name of GROUPE BULL shall not be
	22	* used in advertising or otherwise to promote the sale, use or other dealings
	23	* in this Software without prior written authorization from GROUPE BULL.
	24	*/
	25
	26	/*****************************************************************************\
	27	* xpm.h: *
	28	* *
	29	* XPM library *
	30	* Include file *
	31	* *
	32	* Developed by Arnaud Le Hors *
	33	\*****************************************************************************/
	34
	35	/*
	36	* The code related to FOR_MSW has been added by
	37	* HeDu (hedu@cul-ipn.uni-kiel.de) 4/94
	38	*/
	39
e6ed776f GRG	40	/*
	41	* The code related to AMIGA has been added by
	42	* Lorens Younes (d93-hyo@nada.kth.se) 4/96
	43	*/
	44
cfbe03c9 JS	45	#ifndef XPM_h
	46	#define XPM_h
	47
0a240683	48	#if (defined(_WINDOWS) \|\| defined(__WXMSW__) \|\| defined(WIN32)) && !defined(FOR_MSW)
cfbe03c9 JS	49	#define FOR_MSW
cfbe03c9 JS	50	#endif
16a12a3d DW	51	/* Piggyback on MSW for now */
	52	#if (defined(__OS2__) \|\| defined(__WXPM__) \|\| defined(OS232)) && !defined(FOR_MSW)
	53	#define FOR_MSW
	54	#endif
cfbe03c9 JS	55
	56	/*
	57	* first some identification numbers:
e6ed776f	58	* the version and revision numbers are determined with the following rule:
cfbe03c9 JS	59	* SO Major number = LIB minor version number.
	60	* SO Minor number = LIB sub-minor version number.
	61	* e.g: Xpm version 3.2f
	62	* we forget the 3 which is the format number, 2 gives 2, and f gives 6.
	63	* thus we have XpmVersion = 2 and XpmRevision = 6
	64	* which gives SOXPMLIBREV = 2.6
	65	*
e6ed776f	66	* Then the XpmIncludeVersion number is built from these numbers.
cfbe03c9 JS	67	*/
	68	#define XpmFormat 3
	69	#define XpmVersion 4
e6ed776f GRG	70	#define XpmRevision 11
e6ed776f GRG	71	#define XpmIncludeVersion ((XpmFormat * 100 + XpmVersion) * 100 + XpmRevision)
cfbe03c9 JS	72
	73	#ifndef XPM_NUMBERS
	74
cfbe03c9	75	#ifdef FOR_MSW
e6ed776f GRG	76	# define SYSV /* uses memcpy string.h etc. */
	77	# include <malloc.h>
	78	# include "simx.h" /* defines some X stuff using MSW types */
cfbe03c9	79	#define NEED_STRCASECMP /* at least for MSVC++ */
cfbe03c9	80	#else /* FOR_MSW */
e6ed776f GRG	81	# ifdef AMIGA
	82	# include "amigax.h"
	83	# else /* not AMIGA */
	84	# include <X11/Xlib.h>
	85	# include <X11/Xutil.h>
	86	# endif /* not AMIGA */
cfbe03c9	87	#endif /* FOR_MSW */
cfbe03c9 JS	88
	89	/* let's define Pixel if it is not done yet */
	90	#if ! defined(_XtIntrinsic_h) && ! defined(PIXEL_ALREADY_TYPEDEFED)
	91	typedef unsigned long Pixel; /* Index into colormap */
e6ed776f	92	# define PIXEL_ALREADY_TYPEDEFED
cfbe03c9 JS	93	#endif
cfbe03c9 JS	94
e6ed776f GRG	95	/* make sure we know whether function prototypes are needed or not */
	96	#ifndef NeedFunctionPrototypes
	97	# if defined(__STDC__) \|\| defined(__cplusplus) \|\| defined(c_plusplus)
	98	# define NeedFunctionPrototypes 1
	99	# else
	100	# define NeedFunctionPrototypes 0
	101	# endif
	102	#endif
	103
	104
cfbe03c9 JS	105	/* Return ErrorStatus codes:
	106	* null if full success
	107	* positive if partial success
	108	* negative if failure
	109	*/
	110
	111	#define XpmColorError 1
	112	#define XpmSuccess 0
	113	#define XpmOpenFailed -1
	114	#define XpmFileInvalid -2
	115	#define XpmNoMemory -3
	116	#define XpmColorFailed -4
	117
cfbe03c9 JS	118	typedef struct {
	119	char name; / Symbolic color name */
	120	char value; / Color value */
	121	Pixel pixel; /* Color pixel */
	122	} XpmColorSymbol;
	123
	124	typedef struct {
	125	char name; / name of the extension */
	126	unsigned int nlines; /* number of lines in this extension */
	127	char *lines; / pointer to the extension array of strings */
	128	} XpmExtension;
	129
	130	typedef struct {
	131	char string; / characters string */
	132	char symbolic; / symbolic name */
	133	char m_color; / monochrom default */
	134	char g4_color; / 4 level grayscale default */
	135	char g_color; / other level grayscale default */
	136	char c_color; / color default */
	137	} XpmColor;
	138
	139	typedef struct {
	140	unsigned int width; /* image width */
	141	unsigned int height; /* image height */
	142	unsigned int cpp; /* number of characters per pixel */
	143	unsigned int ncolors; /* number of colors */
	144	XpmColor colorTable; / list of related colors */
	145	unsigned int data; / image data */
	146	} XpmImage;
	147
	148	typedef struct {
	149	unsigned long valuemask; /* Specifies which attributes are defined */
	150	char hints_cmt; / Comment of the hints section */
	151	char colors_cmt; / Comment of the colors section */
	152	char pixels_cmt; / Comment of the pixels section */
	153	unsigned int x_hotspot; /* Returns the x hotspot's coordinate */
	154	unsigned int y_hotspot; /* Returns the y hotspot's coordinate */
	155	unsigned int nextensions; /* number of extensions */
	156	XpmExtension extensions; / pointer to array of extensions */
	157	} XpmInfo;
	158
e6ed776f GRG	159	typedef int (*XpmAllocColorFunc)(
	160	#if NeedFunctionPrototypes
	161	Display* /* display */,
	162	Colormap /* colormap */,
	163	char* /* colorname */,
	164	XColor* /* xcolor */,
	165	void* /* closure */
	166	#endif
	167	);
	168
	169	typedef int (*XpmFreeColorsFunc)(
	170	#if NeedFunctionPrototypes
	171	Display* /* display */,
	172	Colormap /* colormap */,
	173	Pixel* /* pixels */,
	174	int /* npixels */,
	175	void* /* closure */
	176	#endif
	177	);
	178
cfbe03c9 JS	179	typedef struct {
cfbe03c9 JS	180	unsigned long valuemask; /* Specifies which attributes are
e6ed776f	181	defined */
cfbe03c9 JS	182
	183	Visual visual; / Specifies the visual to use */
	184	Colormap colormap; /* Specifies the colormap to use */
	185	unsigned int depth; /* Specifies the depth */
	186	unsigned int width; /* Returns the width of the created
e6ed776f	187	pixmap */
cfbe03c9	188	unsigned int height; /* Returns the height of the created
e6ed776f	189	pixmap */
cfbe03c9	190	unsigned int x_hotspot; /* Returns the x hotspot's
e6ed776f	191	coordinate */
cfbe03c9	192	unsigned int y_hotspot; /* Returns the y hotspot's
e6ed776f	193	coordinate */
cfbe03c9	194	unsigned int cpp; /* Specifies the number of char per
e6ed776f	195	pixel */
cfbe03c9	196	Pixel pixels; / List of used color pixels */
e6ed776f GRG	197	unsigned int npixels; /* Number of used pixels */
e6ed776f GRG	198	XpmColorSymbol colorsymbols; / List of color symbols to override */
cfbe03c9 JS	199	unsigned int numsymbols; /* Number of symbols */
cfbe03c9 JS	200	char rgb_fname; / RGB text file name */
e6ed776f GRG	201	unsigned int nextensions; /* Number of extensions */
e6ed776f GRG	202	XpmExtension extensions; / List of extensions */
cfbe03c9 JS	203
cfbe03c9 JS	204	unsigned int ncolors; /* Number of colors */
e6ed776f	205	XpmColor colorTable; / List of colors */
cfbe03c9 JS	206	/* 3.2 backward compatibility code */
	207	char hints_cmt; / Comment of the hints section */
	208	char colors_cmt; / Comment of the colors section */
	209	char pixels_cmt; / Comment of the pixels section */
	210	/* end 3.2 bc */
e6ed776f GRG	211	unsigned int mask_pixel; /* Color table index of transparent
e6ed776f GRG	212	color */
cfbe03c9 JS	213
cfbe03c9 JS	214	/* Color Allocation Directives */
e6ed776f	215	Bool exactColors; /* Only use exact colors for visual */
cfbe03c9 JS	216	unsigned int closeness; /* Allowable RGB deviation */
	217	unsigned int red_closeness; /* Allowable red deviation */
	218	unsigned int green_closeness; /* Allowable green deviation */
	219	unsigned int blue_closeness; /* Allowable blue deviation */
	220	int color_key; /* Use colors from this color set */
	221
e6ed776f GRG	222	Pixel alloc_pixels; / Returns the list of alloc'ed color
	223	pixels */
	224	int nalloc_pixels; /* Returns the number of alloc'ed
	225	color pixels */
	226
	227	Bool alloc_close_colors; /* Specify whether close colors should
	228	be allocated using XAllocColor
	229	or not */
	230	int bitmap_format; /* Specify the format of 1bit depth
	231	images: ZPixmap or XYBitmap */
	232
	233	/* Color functions */
	234	XpmAllocColorFunc alloc_color; /* Application color allocator */
	235	XpmFreeColorsFunc free_colors; /* Application color de-allocator */
	236	void color_closure; / Application private data to pass to
	237	alloc_color and free_colors */
	238
cfbe03c9 JS	239	} XpmAttributes;
	240
	241	/* XpmAttributes value masks bits */
	242	#define XpmVisual (1L<<0)
	243	#define XpmColormap (1L<<1)
	244	#define XpmDepth (1L<<2)
	245	#define XpmSize (1L<<3) /* width & height */
	246	#define XpmHotspot (1L<<4) /* x_hotspot & y_hotspot */
	247	#define XpmCharsPerPixel (1L<<5)
	248	#define XpmColorSymbols (1L<<6)
	249	#define XpmRgbFilename (1L<<7)
	250	/* 3.2 backward compatibility code */
	251	#define XpmInfos (1L<<8)
	252	#define XpmReturnInfos XpmInfos
	253	/* end 3.2 bc */
	254	#define XpmReturnPixels (1L<<9)
	255	#define XpmExtensions (1L<<10)
	256	#define XpmReturnExtensions XpmExtensions
	257
	258	#define XpmExactColors (1L<<11)
	259	#define XpmCloseness (1L<<12)
	260	#define XpmRGBCloseness (1L<<13)
	261	#define XpmColorKey (1L<<14)
	262
	263	#define XpmColorTable (1L<<15)
	264	#define XpmReturnColorTable XpmColorTable
	265
e6ed776f GRG	266	#define XpmReturnAllocPixels (1L<<16)
	267	#define XpmAllocCloseColors (1L<<17)
	268	#define XpmBitmapFormat (1L<<18)
	269
	270	#define XpmAllocColor (1L<<19)
	271	#define XpmFreeColors (1L<<20)
	272	#define XpmColorClosure (1L<<21)
	273
	274
cfbe03c9 JS	275	/* XpmInfo value masks bits */
	276	#define XpmComments XpmInfos
	277	#define XpmReturnComments XpmComments
	278
	279	/* XpmAttributes mask_pixel value when there is no mask */
	280	#ifndef FOR_MSW
	281	#define XpmUndefPixel 0x80000000
	282	#else
	283	/* int is only 16 bit for MSW */
	284	#define XpmUndefPixel 0x8000
	285	#endif
	286
	287	/*
	288	* color keys for visual type, they must fit along with the number key of
e6ed776f	289	* each related element in xpmColorKeys[] defined in XpmI.h
cfbe03c9 JS	290	*/
	291	#define XPM_MONO 2
	292	#define XPM_GREY4 3
	293	#define XPM_GRAY4 3
	294	#define XPM_GREY 4
	295	#define XPM_GRAY 4
	296	#define XPM_COLOR 5
	297
	298
e6ed776f GRG	299	/* macros for forward declarations of functions with prototypes */
e6ed776f GRG	300	#if NeedFunctionPrototypes
cfbe03c9 JS	301	#define FUNC(f, t, p) extern t f p
cfbe03c9 JS	302	#define LFUNC(f, t, p) static t f p
e6ed776f	303	#else
cfbe03c9 JS	304	#define FUNC(f, t, p) extern t f()
cfbe03c9 JS	305	#define LFUNC(f, t, p) static t f()
e6ed776f	306	#endif
cfbe03c9 JS	307
	308
	309	/*
	310	* functions declarations
	311	*/
	312
	313	#ifdef __cplusplus
	314	extern "C" {
	315	#endif
	316
cfbe03c9	317	/* FOR_MSW, all ..Pixmap.. are excluded, only the ..XImage.. are used */
e6ed776f	318	/* Same for Amiga! */
cfbe03c9	319
e6ed776f	320	#if !defined(FOR_MSW) && !defined(AMIGA)
cfbe03c9 JS	321	FUNC(XpmCreatePixmapFromData, int, (Display *display,
	322	Drawable d,
	323	char **data,
	324	Pixmap *pixmap_return,
	325	Pixmap *shapemask_return,
	326	XpmAttributes *attributes));
	327
	328	FUNC(XpmCreateDataFromPixmap, int, (Display *display,
	329	char ***data_return,
	330	Pixmap pixmap,
	331	Pixmap shapemask,
	332	XpmAttributes *attributes));
	333
	334	FUNC(XpmReadFileToPixmap, int, (Display *display,
	335	Drawable d,
	336	char *filename,
	337	Pixmap *pixmap_return,
	338	Pixmap *shapemask_return,
	339	XpmAttributes *attributes));
	340
	341	FUNC(XpmWriteFileFromPixmap, int, (Display *display,
	342	char *filename,
	343	Pixmap pixmap,
	344	Pixmap shapemask,
	345	XpmAttributes *attributes));
e6ed776f	346	#endif
cfbe03c9 JS	347
	348	FUNC(XpmCreateImageFromData, int, (Display *display,
	349	char **data,
	350	XImage **image_return,
	351	XImage **shapemask_return,
	352	XpmAttributes *attributes));
	353
	354	FUNC(XpmCreateDataFromImage, int, (Display *display,
	355	char ***data_return,
	356	XImage *image,
	357	XImage *shapeimage,
	358	XpmAttributes *attributes));
	359
	360	FUNC(XpmReadFileToImage, int, (Display *display,
	361	char *filename,
	362	XImage **image_return,
	363	XImage **shapeimage_return,
	364	XpmAttributes *attributes));
	365
	366	FUNC(XpmWriteFileFromImage, int, (Display *display,
	367	char *filename,
	368	XImage *image,
	369	XImage *shapeimage,
	370	XpmAttributes *attributes));
	371
	372	FUNC(XpmCreateImageFromBuffer, int, (Display *display,
	373	char *buffer,
	374	XImage **image_return,
	375	XImage **shapemask_return,
	376	XpmAttributes *attributes));
e6ed776f	377	#if !defined(FOR_MSW) && !defined(AMIGA)
cfbe03c9 JS	378	FUNC(XpmCreatePixmapFromBuffer, int, (Display *display,
	379	Drawable d,
	380	char *buffer,
	381	Pixmap *pixmap_return,
	382	Pixmap *shapemask_return,
	383	XpmAttributes *attributes));
	384
	385	FUNC(XpmCreateBufferFromImage, int, (Display *display,
	386	char **buffer_return,
	387	XImage *image,
	388	XImage *shapeimage,
	389	XpmAttributes *attributes));
	390
	391	FUNC(XpmCreateBufferFromPixmap, int, (Display *display,
	392	char **buffer_return,
	393	Pixmap pixmap,
	394	Pixmap shapemask,
	395	XpmAttributes *attributes));
e6ed776f	396	#endif
cfbe03c9 JS	397	FUNC(XpmReadFileToBuffer, int, (char filename, char *buffer_return));
	398	FUNC(XpmWriteFileFromBuffer, int, (char filename, char buffer));
	399
	400	FUNC(XpmReadFileToData, int, (char filename, char **data_return));
	401	FUNC(XpmWriteFileFromData, int, (char filename, char *data));
	402
	403	FUNC(XpmAttributesSize, int, ());
	404	FUNC(XpmFreeAttributes, void, (XpmAttributes *attributes));
	405	FUNC(XpmFreeExtensions, void, (XpmExtension *extensions,
	406	int nextensions));
	407
	408	FUNC(XpmFreeXpmImage, void, (XpmImage *image));
	409	FUNC(XpmFreeXpmInfo, void, (XpmInfo *info));
	410	FUNC(XpmGetErrorString, char *, (int errcode));
	411	FUNC(XpmLibraryVersion, int, ());
	412
	413	/* XpmImage functions */
	414	FUNC(XpmReadFileToXpmImage, int, (char *filename,
	415	XpmImage *image,
	416	XpmInfo *info));
	417
	418	FUNC(XpmWriteFileFromXpmImage, int, (char *filename,
	419	XpmImage *image,
	420	XpmInfo *info));
e6ed776f	421	#if !defined(FOR_MSW) && !defined(AMIGA)
cfbe03c9 JS	422	FUNC(XpmCreatePixmapFromXpmImage, int, (Display *display,
	423	Drawable d,
	424	XpmImage *image,
	425	Pixmap *pixmap_return,
	426	Pixmap *shapemask_return,
	427	XpmAttributes *attributes));
	428	#endif
	429	FUNC(XpmCreateImageFromXpmImage, int, (Display *display,
	430	XpmImage *image,
	431	XImage **image_return,
	432	XImage **shapeimage_return,
	433	XpmAttributes *attributes));
	434
	435	FUNC(XpmCreateXpmImageFromImage, int, (Display *display,
	436	XImage *image,
	437	XImage *shapeimage,
	438	XpmImage *xpmimage,
	439	XpmAttributes *attributes));
e6ed776f	440	#if !defined(FOR_MSW) && !defined(AMIGA)
cfbe03c9 JS	441	FUNC(XpmCreateXpmImageFromPixmap, int, (Display *display,
	442	Pixmap pixmap,
	443	Pixmap shapemask,
	444	XpmImage *xpmimage,
	445	XpmAttributes *attributes));
	446	#endif
	447	FUNC(XpmCreateDataFromXpmImage, int, (char ***data_return,
	448	XpmImage *image,
	449	XpmInfo *info));
	450
	451	FUNC(XpmCreateXpmImageFromData, int, (char **data,
	452	XpmImage *image,
	453	XpmInfo *info));
	454
	455	FUNC(XpmCreateXpmImageFromBuffer, int, (char *buffer,
	456	XpmImage *image,
	457	XpmInfo *info));
	458
	459	FUNC(XpmCreateBufferFromXpmImage, int, (char **buffer_return,
	460	XpmImage *image,
	461	XpmInfo *info));
	462
e6ed776f GRG	463	FUNC(XpmGetParseError, int, (char *filename,
	464	int *linenum_return,
	465	int *charnum_return));
	466
	467	FUNC(XpmFree, void, (void *ptr));
	468
cfbe03c9 JS	469	#ifdef __cplusplus
	470	} /* for C++ V2.0 */
	471	#endif
	472
	473
	474	/* backward compatibility */
	475
	476	/* for version 3.0c */
	477	#define XpmPixmapColorError XpmColorError
	478	#define XpmPixmapSuccess XpmSuccess
	479	#define XpmPixmapOpenFailed XpmOpenFailed
	480	#define XpmPixmapFileInvalid XpmFileInvalid
	481	#define XpmPixmapNoMemory XpmNoMemory
	482	#define XpmPixmapColorFailed XpmColorFailed
	483
	484	#define XpmReadPixmapFile(dpy, d, file, pix, mask, att) \
	485	XpmReadFileToPixmap(dpy, d, file, pix, mask, att)
	486	#define XpmWritePixmapFile(dpy, file, pix, mask, att) \
	487	XpmWriteFileFromPixmap(dpy, file, pix, mask, att)
	488
	489	/* for version 3.0b */
	490	#define PixmapColorError XpmColorError
	491	#define PixmapSuccess XpmSuccess
	492	#define PixmapOpenFailed XpmOpenFailed
	493	#define PixmapFileInvalid XpmFileInvalid
	494	#define PixmapNoMemory XpmNoMemory
	495	#define PixmapColorFailed XpmColorFailed
	496
	497	#define ColorSymbol XpmColorSymbol
	498
	499	#define XReadPixmapFile(dpy, d, file, pix, mask, att) \
	500	XpmReadFileToPixmap(dpy, d, file, pix, mask, att)
	501	#define XWritePixmapFile(dpy, file, pix, mask, att) \
	502	XpmWriteFileFromPixmap(dpy, file, pix, mask, att)
	503	#define XCreatePixmapFromData(dpy, d, data, pix, mask, att) \
	504	XpmCreatePixmapFromData(dpy, d, data, pix, mask, att)
	505	#define XCreateDataFromPixmap(dpy, data, pix, mask, att) \
	506	XpmCreateDataFromPixmap(dpy, data, pix, mask, att)
	507
	508	#endif /* XPM_NUMBERS */
	509	#endif