include/Xm/XpmP.h

0001 /*
0002  * Motif
0003  *
0004  * Copyright (c) 1987-2012, The Open Group. All rights reserved.
0005  *
0006  * These libraries and programs are free software; you can
0007  * redistribute them and/or modify them under the terms of the GNU
0008  * Lesser General Public License as published by the Free Software
0009  * Foundation; either version 2 of the License, or (at your option)
0010  * any later version.
0011  *
0012  * These libraries and programs are distributed in the hope that
0013  * they will be useful, but WITHOUT ANY WARRANTY; without even the
0014  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
0015  * PURPOSE. See the GNU Lesser General Public License for more
0016  * details.
0017  *
0018  * You should have received a copy of the GNU Lesser General Public
0019  * License along with these librararies and programs; if not, write
0020  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
0021  * Floor, Boston, MA 02110-1301 USA
0022  */
0023
0024 #ifndef _XpmP_h
0025 #define _XpmP_h
0026
0027 /* Xpm external symbols are prefixed with Xme */
0028
0029 #define XpmCreatePixmapFromData XmeXpmCreatePixmapFromData
0030 #define XpmCreateDataFromPixmap XmeXpmCreateDataFromPixmap
0031 #define XpmReadFileToPixmap XmeXpmReadFileToPixmap
0032 #define XpmWriteFileFromPixmap XmeXpmWriteFileFromPixmap
0033 #define XpmCreateImageFromData XmeXpmCreateImageFromData
0034 #define XpmCreateDataFromImage XmeXpmCreateDataFromImage
0035 #define XpmReadFileToImage XmeXpmReadFileToImage
0036 #define XpmWriteFileFromImage XmeXpmWriteFileFromImage
0037 #define XpmCreateImageFromBuffer XmeXpmCreateImageFromBuffer
0038 #define XpmCreatePixmapFromBuffer XmeXpmCreatePixmapFromBuffer
0039 #define XpmCreateBufferFromImage XmeXpmCreateBufferFromImage
0040 #define XpmCreateBufferFromPixmap XmeXpmCreateBufferFromPixmap
0041 #define XpmReadFileToBuffer XmeXpmReadFileToBuffer
0042 #define XpmWriteFileFromBuffer XmeXpmWriteFileFromBuffer
0043 #define XpmReadFileToData XmeXpmReadFileToData
0044 #define XpmWriteFileFromData XmeXpmWriteFileFromData
0045 #define XpmAttributesSize XmeXpmAttributesSize
0046 #define XpmFreeAttributes XmeXpmFreeAttributes
0047 #define XpmFreeExtensions XmeXpmFreeExtensions
0048 #define XpmFreeXpmImage XmeXpmFreeXpmImage
0049 #define XpmFreeXpmInfo XmeXpmFreeXpmInfo
0050 #define XpmGetErrorString XmeXpmGetErrorString
0051 #define XpmLibraryVersion XmeXpmLibraryVersion
0052 #define XpmReadFileToXpmImage XmeXpmReadFileToXpmImage
0053 #define XpmWriteFileFromXpmImage XmeXpmWriteFileFromXpmImage
0054 #define XpmCreatePixmapFromXpmImage XmeXpmCreatePixmapFromXpmImage
0055 #define XpmCreateImageFromXpmImage XmeXpmCreateImageFromXpmImage
0056 #define XpmCreateXpmImageFromImage XmeXpmCreateXpmImageFromImage
0057 #define XpmCreateXpmImageFromPixmap XmeXpmCreateXpmImageFromPixmap
0058 #define XpmCreateDataFromXpmImage XmeXpmCreateDataFromXpmImage
0059 #define XpmCreateXpmImageFromData XmeXpmCreateXpmImageFromData
0060 #define XpmCreateXpmImageFromBuffer XmeXpmCreateXpmImageFromBuffer
0061 #define XpmCreateBufferFromXpmImage XmeXpmCreateBufferFromXpmImage
0062 #define XpmFree XmeXpmFree
0063
0064 /* The following is the original xpm.h header file */
0065
0066 /*
0067  * Copyright (C) 1989-95 GROUPE BULL
0068  *
0069  * Permission is hereby granted, free of charge, to any person obtaining a copy
0070  * of this software and associated documentation files (the "Software"), to
0071  * deal in the Software without restriction, including without limitation the
0072  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
0073  * sell copies of the Software, and to permit persons to whom the Software is
0074  * furnished to do so, subject to the following conditions:
0075  *
0076  * The above copyright notice and this permission notice shall be included in
0077  * all copies or substantial portions of the Software.
0078  *
0079  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0080  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0081  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
0082  * GROUPE BULL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
0083  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
0084  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0085  *
0086  * Except as contained in this notice, the name of GROUPE BULL shall not be
0087  * used in advertising or otherwise to promote the sale, use or other dealings
0088  * in this Software without prior written authorization from GROUPE BULL.
0089  */
0090
0091 /*****************************************************************************\
0092 * xpm.h:                                                                      *
0093 *                                                                             *
0094 *  XPM library                                                                *
0095 *  Include file                                                               *
0096 *                                                                             *
0097 *  Developed by Arnaud Le Hors                                                *
0098 \*****************************************************************************/
0099
0100 /*
0101  * The code related to FOR_MSW has been added by
0102  * HeDu (hedu@cul-ipn.uni-kiel.de) 4/94
0103  */
0104
0105 #ifndef XPM_h
0106 #define XPM_h
0107
0108 /*
0109  * first some identification numbers:
0110  * the version and revision numbers are determined with the following rule:
0111  * SO Major number = LIB minor version number.
0112  * SO Minor number = LIB sub-minor version number.
0113  * e.g: Xpm version 3.2f
0114  *      we forget the 3 which is the format number, 2 gives 2, and f gives 6.
0115  *      thus we have XpmVersion = 2 and XpmRevision = 6
0116  *      which gives  SOXPMLIBREV = 2.6
0117  *
0118  * Then the XpmIncludeVersion number is built from these numbers.
0119  */
0120 #define XpmFormat 3
0121 #define XpmVersion 4
0122 #define XpmRevision 9
0123 #define XpmIncludeVersion ((XpmFormat * 100 + XpmVersion) * 100 + XpmRevision)
0124
0125 #ifndef XPM_NUMBERS
0126
0127 #ifdef FOR_MSW
0128 # define SYSV           /* uses memcpy string.h etc. */
0129 # include <malloc.h>
0130 # include "simx.h"      /* defines some X stuff using MSW types */
0131 #define NEED_STRCASECMP     /* at least for MSVC++ */
0132 #else /* FOR_MSW */
0133 # include <X11/Xlib.h>
0134 # include <X11/Xutil.h>
0135 #endif /* FOR_MSW */
0136
0137 /* let's define Pixel if it is not done yet */
0138 #if ! defined(_XtIntrinsic_h) && ! defined(PIXEL_ALREADY_TYPEDEFED)
0139 typedef unsigned long Pixel;    /* Index into colormap */
0140 # define PIXEL_ALREADY_TYPEDEFED
0141 #endif
0142
0143 /* make sure we know whether function prototypes are needed or not */
0144 #ifndef NeedFunctionPrototypes
0145 # if defined(__STDC__) || defined(__cplusplus) || defined(c_plusplus)
0146 #  define NeedFunctionPrototypes 1
0147 # else
0148 #  define NeedFunctionPrototypes 0
0149 # endif
0150 #endif
0151
0152
0153 /* Return ErrorStatus codes:
0154  * null     if full success
0155  * positive if partial success
0156  * negative if failure
0157  */
0158
0159 #define XpmColorError    1
0160 #define XpmSuccess       0
0161 #define XpmOpenFailed   -1
0162 #define XpmFileInvalid  -2
0163 #define XpmNoMemory     -3
0164 #define XpmColorFailed  -4
0165
0166 typedef struct {
0167     char *name;         /* Symbolic color name */
0168     char *value;        /* Color value */
0169     Pixel pixel;        /* Color pixel */
0170 }      XpmColorSymbol;
0171
0172 typedef struct {
0173     char *name;         /* name of the extension */
0174     unsigned int nlines;    /* number of lines in this extension */
0175     char **lines;       /* pointer to the extension array of strings */
0176 }      XpmExtension;
0177
0178 typedef struct {
0179     char *string;       /* characters string */
0180     char *symbolic;     /* symbolic name */
0181     char *m_color;      /* monochrom default */
0182     char *g4_color;     /* 4 level grayscale default */
0183     char *g_color;      /* other level grayscale default */
0184     char *c_color;      /* color default */
0185 }      XpmColor;
0186
0187 typedef struct {
0188     unsigned int width;     /* image width */
0189     unsigned int height;    /* image height */
0190     unsigned int cpp;       /* number of characters per pixel */
0191     unsigned int ncolors;   /* number of colors */
0192     XpmColor *colorTable;   /* list of related colors */
0193     unsigned int *data;     /* image data */
0194 }      XpmImage;
0195
0196 typedef struct {
0197     unsigned long valuemask;    /* Specifies which attributes are defined */
0198     char *hints_cmt;        /* Comment of the hints section */
0199     char *colors_cmt;       /* Comment of the colors section */
0200     char *pixels_cmt;       /* Comment of the pixels section */
0201     unsigned int x_hotspot; /* Returns the x hotspot's coordinate */
0202     unsigned int y_hotspot; /* Returns the y hotspot's coordinate */
0203     unsigned int nextensions;   /* number of extensions */
0204     XpmExtension *extensions;   /* pointer to array of extensions */
0205 }      XpmInfo;
0206
0207 typedef int (*XpmAllocColorFunc)(
0208 #if NeedFunctionPrototypes
0209     Display*            /* display */,
0210     Colormap            /* colormap */,
0211     char*           /* colorname */,
0212     XColor*         /* xcolor */,
0213     void*           /* closure */
0214 #endif
0215 );
0216
0217 typedef int (*XpmFreeColorsFunc)(
0218 #if NeedFunctionPrototypes
0219     Display*            /* display */,
0220     Colormap            /* colormap */,
0221     Pixel*          /* pixels */,
0222     int             /* npixels */,
0223     void*           /* closure */
0224 #endif
0225 );
0226
0227 typedef struct {
0228     unsigned long valuemask;        /* Specifies which attributes are
0229                        defined */
0230
0231     Visual *visual;         /* Specifies the visual to use */
0232     Colormap colormap;          /* Specifies the colormap to use */
0233     unsigned int depth;         /* Specifies the depth */
0234     unsigned int width;         /* Returns the width of the created
0235                        pixmap */
0236     unsigned int height;        /* Returns the height of the created
0237                        pixmap */
0238     unsigned int x_hotspot;     /* Returns the x hotspot's
0239                        coordinate */
0240     unsigned int y_hotspot;     /* Returns the y hotspot's
0241                        coordinate */
0242     unsigned int cpp;           /* Specifies the number of char per
0243                        pixel */
0244     Pixel *pixels;          /* List of used color pixels */
0245     unsigned int npixels;       /* Number of used pixels */
0246     XpmColorSymbol *colorsymbols;   /* List of color symbols to override */
0247     unsigned int numsymbols;        /* Number of symbols */
0248     char *rgb_fname;            /* RGB text file name */
0249     unsigned int nextensions;       /* Number of extensions */
0250     XpmExtension *extensions;       /* List of extensions */
0251
0252     unsigned int ncolors;               /* Number of colors */
0253     XpmColor *colorTable;               /* List of colors */
0254 /* 3.2 backward compatibility code */
0255     char *hints_cmt;                    /* Comment of the hints section */
0256     char *colors_cmt;                   /* Comment of the colors section */
0257     char *pixels_cmt;                   /* Comment of the pixels section */
0258 /* end 3.2 bc */
0259     unsigned int mask_pixel;            /* Color table index of transparent
0260                                            color */
0261
0262     /* Color Allocation Directives */
0263     Bool exactColors;           /* Only use exact colors for visual */
0264     unsigned int closeness;     /* Allowable RGB deviation */
0265     unsigned int red_closeness;     /* Allowable red deviation */
0266     unsigned int green_closeness;   /* Allowable green deviation */
0267     unsigned int blue_closeness;    /* Allowable blue deviation */
0268     int color_key;          /* Use colors from this color set */
0269
0270     Pixel *alloc_pixels;        /* Returns the list of alloc'ed color
0271                        pixels */
0272     Bool nalloc_pixels;         /* Returns the number of alloc'ed
0273                        color pixels */
0274
0275     Bool alloc_close_colors;        /* Specify whether close colors should
0276                        be allocated using XAllocColor
0277                        or not */
0278     int bitmap_format;          /* Specify the format of 1bit depth
0279                        images: ZPixmap or XYBitmap */
0280
0281     /* Color functions */
0282     XpmAllocColorFunc alloc_color;  /* Application color allocator */
0283     XpmFreeColorsFunc free_colors;  /* Application color de-allocator */
0284     void *color_closure;        /* Application private data to pass to
0285                        alloc_color and free_colors */
0286
0287 }      XpmAttributes;
0288
0289 /* XpmAttributes value masks bits */
0290 #define XpmVisual      (1L<<0)
0291 #define XpmColormap    (1L<<1)
0292 #define XpmDepth       (1L<<2)
0293 #define XpmSize        (1L<<3)  /* width & height */
0294 #define XpmHotspot     (1L<<4)  /* x_hotspot & y_hotspot */
0295 #define XpmCharsPerPixel   (1L<<5)
0296 #define XpmColorSymbols    (1L<<6)
0297 #define XpmRgbFilename     (1L<<7)
0298 /* 3.2 backward compatibility code */
0299 #define XpmInfos       (1L<<8)
0300 #define XpmReturnInfos     XpmInfos
0301 /* end 3.2 bc */
0302 #define XpmReturnPixels    (1L<<9)
0303 #define XpmExtensions      (1L<<10)
0304 #define XpmReturnExtensions XpmExtensions
0305
0306 #define XpmExactColors     (1L<<11)
0307 #define XpmCloseness       (1L<<12)
0308 #define XpmRGBCloseness    (1L<<13)
0309 #define XpmColorKey    (1L<<14)
0310
0311 #define XpmColorTable      (1L<<15)
0312 #define XpmReturnColorTable XpmColorTable
0313
0314 #define XpmReturnAllocPixels (1L<<16)
0315 #define XpmAllocCloseColors (1L<<17)
0316 #define XpmBitmapFormat    (1L<<18)
0317
0318 #define XpmAllocColor      (1L<<19)
0319 #define XpmFreeColors      (1L<<20)
0320 #define XpmColorClosure    (1L<<21)
0321
0322
0323 /* XpmInfo value masks bits */
0324 #define XpmComments        XpmInfos
0325 #define XpmReturnComments  XpmComments
0326
0327 /* XpmAttributes mask_pixel value when there is no mask */
0328 #ifndef FOR_MSW
0329 #define XpmUndefPixel 0x80000000
0330 #else
0331 /* int is only 16 bit for MSW */
0332 #define XpmUndefPixel 0x8000
0333 #endif
0334
0335 /*
0336  * color keys for visual type, they must fit along with the number key of
0337  * each related element in xpmColorKeys[] defined in XpmI.h
0338  */
0339 #define XPM_MONO    2
0340 #define XPM_GREY4   3
0341 #define XPM_GRAY4   3
0342 #define XPM_GREY    4
0343 #define XPM_GRAY    4
0344 #define XPM_COLOR   5
0345
0346
0347 /* macros for forward declarations of functions with prototypes */
0348 #if NeedFunctionPrototypes
0349 #define FUNC(f, t, p) extern t f p
0350 #define LFUNC(f, t, p) static t f p
0351 #else
0352 #define FUNC(f, t, p) extern t f()
0353 #define LFUNC(f, t, p) static t f()
0354 #endif
0355
0356
0357 /*
0358  * functions declarations
0359  */
0360
0361 #ifdef __cplusplus
0362 extern "C" {
0363 #endif
0364
0365 /* FOR_MSW, all ..Pixmap.. are excluded, only the ..XImage.. are used */
0366
0367 #ifndef FOR_MSW
0368     FUNC(XpmCreatePixmapFromData, int, (Display *display,
0369                     Drawable d,
0370                     char **data,
0371                     Pixmap *pixmap_return,
0372                     Pixmap *shapemask_return,
0373                     XpmAttributes *attributes));
0374
0375     FUNC(XpmCreateDataFromPixmap, int, (Display *display,
0376                     char ***data_return,
0377                     Pixmap pixmap,
0378                     Pixmap shapemask,
0379                     XpmAttributes *attributes));
0380
0381     FUNC(XpmReadFileToPixmap, int, (Display *display,
0382                     Drawable d,
0383                     char *filename,
0384                     Pixmap *pixmap_return,
0385                     Pixmap *shapemask_return,
0386                     XpmAttributes *attributes));
0387
0388     FUNC(XpmWriteFileFromPixmap, int, (Display *display,
0389                        char *filename,
0390                        Pixmap pixmap,
0391                        Pixmap shapemask,
0392                        XpmAttributes *attributes));
0393 #endif  /* ndef FOR_MSW */
0394
0395     FUNC(XpmCreateImageFromData, int, (Display *display,
0396                        char **data,
0397                        XImage **image_return,
0398                        XImage **shapemask_return,
0399                        XpmAttributes *attributes));
0400
0401     FUNC(XpmCreateDataFromImage, int, (Display *display,
0402                        char ***data_return,
0403                        XImage *image,
0404                        XImage *shapeimage,
0405                        XpmAttributes *attributes));
0406
0407     FUNC(XpmReadFileToImage, int, (Display *display,
0408                    char *filename,
0409                    XImage **image_return,
0410                    XImage **shapeimage_return,
0411                    XpmAttributes *attributes));
0412
0413     FUNC(XpmWriteFileFromImage, int, (Display *display,
0414                       char *filename,
0415                       XImage *image,
0416                       XImage *shapeimage,
0417                       XpmAttributes *attributes));
0418
0419     FUNC(XpmCreateImageFromBuffer, int, (Display *display,
0420                      char *buffer,
0421                      XImage **image_return,
0422                      XImage **shapemask_return,
0423                      XpmAttributes *attributes));
0424 #ifndef FOR_MSW
0425     FUNC(XpmCreatePixmapFromBuffer, int, (Display *display,
0426                       Drawable d,
0427                       char *buffer,
0428                       Pixmap *pixmap_return,
0429                       Pixmap *shapemask_return,
0430                       XpmAttributes *attributes));
0431
0432     FUNC(XpmCreateBufferFromImage, int, (Display *display,
0433                      char **buffer_return,
0434                      XImage *image,
0435                      XImage *shapeimage,
0436                      XpmAttributes *attributes));
0437
0438     FUNC(XpmCreateBufferFromPixmap, int, (Display *display,
0439                       char **buffer_return,
0440                       Pixmap pixmap,
0441                       Pixmap shapemask,
0442                       XpmAttributes *attributes));
0443 #endif  /* ndef FOR_MSW */
0444     FUNC(XpmReadFileToBuffer, int, (char *filename, char **buffer_return));
0445     FUNC(XpmWriteFileFromBuffer, int, (char *filename, char *buffer));
0446
0447     FUNC(XpmReadFileToData, int, (char *filename, char ***data_return));
0448     FUNC(XpmWriteFileFromData, int, (char *filename, char **data));
0449
0450     FUNC(XpmAttributesSize, int, ());
0451     FUNC(XpmFreeAttributes, void, (XpmAttributes *attributes));
0452     FUNC(XpmFreeExtensions, void, (XpmExtension *extensions,
0453                    int nextensions));
0454
0455     FUNC(XpmFreeXpmImage, void, (XpmImage *image));
0456     FUNC(XpmFreeXpmInfo, void, (XpmInfo *info));
0457     FUNC(XpmGetErrorString, char *, (int errcode));
0458     FUNC(XpmLibraryVersion, int, ());
0459
0460     /* XpmImage functions */
0461     FUNC(XpmReadFileToXpmImage, int, (char *filename,
0462                       XpmImage *image,
0463                       XpmInfo *info));
0464
0465     FUNC(XpmWriteFileFromXpmImage, int, (char *filename,
0466                      XpmImage *image,
0467                      XpmInfo *info));
0468 #ifndef FOR_MSW
0469     FUNC(XpmCreatePixmapFromXpmImage, int, (Display *display,
0470                         Drawable d,
0471                         XpmImage *image,
0472                         Pixmap *pixmap_return,
0473                         Pixmap *shapemask_return,
0474                         XpmAttributes *attributes));
0475 #endif
0476     FUNC(XpmCreateImageFromXpmImage, int, (Display *display,
0477                        XpmImage *image,
0478                        XImage **image_return,
0479                        XImage **shapeimage_return,
0480                        XpmAttributes *attributes));
0481
0482     FUNC(XpmCreateXpmImageFromImage, int, (Display *display,
0483                        XImage *image,
0484                        XImage *shapeimage,
0485                        XpmImage *xpmimage,
0486                        XpmAttributes *attributes));
0487 #ifndef FOR_MSW
0488     FUNC(XpmCreateXpmImageFromPixmap, int, (Display *display,
0489                         Pixmap pixmap,
0490                         Pixmap shapemask,
0491                         XpmImage *xpmimage,
0492                         XpmAttributes *attributes));
0493 #endif
0494     FUNC(XpmCreateDataFromXpmImage, int, (char ***data_return,
0495                       XpmImage *image,
0496                       XpmInfo *info));
0497
0498     FUNC(XpmCreateXpmImageFromData, int, (char **data,
0499                       XpmImage *image,
0500                       XpmInfo *info));
0501
0502     FUNC(XpmCreateXpmImageFromBuffer, int, (char *buffer,
0503                         XpmImage *image,
0504                         XpmInfo *info));
0505
0506     FUNC(XpmCreateBufferFromXpmImage, int, (char **buffer_return,
0507                         XpmImage *image,
0508                         XpmInfo *info));
0509
0510     FUNC(XpmFree, void, (void *ptr));
0511
0512 #ifdef __cplusplus
0513 } /* for C++ V2.0 */
0514 #endif
0515
0516
0517 /* backward compatibility */
0518
0519 /* for version 3.0c */
0520 #define XpmPixmapColorError  XpmColorError
0521 #define XpmPixmapSuccess     XpmSuccess
0522 #define XpmPixmapOpenFailed  XpmOpenFailed
0523 #define XpmPixmapFileInvalid XpmFileInvalid
0524 #define XpmPixmapNoMemory    XpmNoMemory
0525 #define XpmPixmapColorFailed XpmColorFailed
0526
0527 #define XpmReadPixmapFile(dpy, d, file, pix, mask, att) \
0528     XpmReadFileToPixmap(dpy, d, file, pix, mask, att)
0529 #define XpmWritePixmapFile(dpy, file, pix, mask, att) \
0530     XpmWriteFileFromPixmap(dpy, file, pix, mask, att)
0531
0532 /* for version 3.0b */
0533 #define PixmapColorError  XpmColorError
0534 #define PixmapSuccess     XpmSuccess
0535 #define PixmapOpenFailed  XpmOpenFailed
0536 #define PixmapFileInvalid XpmFileInvalid
0537 #define PixmapNoMemory    XpmNoMemory
0538 #define PixmapColorFailed XpmColorFailed
0539
0540 #define ColorSymbol XpmColorSymbol
0541
0542 #define XReadPixmapFile(dpy, d, file, pix, mask, att) \
0543     XpmReadFileToPixmap(dpy, d, file, pix, mask, att)
0544 #define XWritePixmapFile(dpy, file, pix, mask, att) \
0545     XpmWriteFileFromPixmap(dpy, file, pix, mask, att)
0546 #define XCreatePixmapFromData(dpy, d, data, pix, mask, att) \
0547     XpmCreatePixmapFromData(dpy, d, data, pix, mask, att)
0548 #define XCreateDataFromPixmap(dpy, data, pix, mask, att) \
0549     XpmCreateDataFromPixmap(dpy, data, pix, mask, att)
0550
0551 #endif /* XPM_NUMBERS */
0552 #endif
0553
0554 #endif /* _XpmP_h */