pixmap_helper.h

//          _                                     _            _                     _      //
//   _ __  (_)__  __ _ __ ___    __ _  _ __      | |__    ___ | | _ __    ___  _ __ | |__   //
//  | '_ \ | |\ \/ /| '_ ` _ \  / _` || '_ \     | '_ \  / _ \| || '_ \  / _ \| '__|| '_ \  //
//  | |_) || | >  < | | | | | || (_| || |_) |    | | | ||  __/| || |_) ||  __/| | _ | | | | //
//  | .__/ |_|/_/\_\|_| |_| |_| \__,_|| .__/_____|_| |_| \___||_|| .__/  \___||_|(_)|_| |_| //
//  |_|                               |_|  |_____|               |_|                        //
//                                                                                          //
//             pixmap and icon helpers (ultimately providing universal support)             //
//                                                                                          //

/*****************************************************************************

    X11workbench - X11 programmer's 'work bench' application and toolkit
    Copyright (c) 2010-2019 by Bob Frazier (aka 'Big Bad Bombastic Bob')

  DISCLAIMER:  The X11workbench application and toolkit software are supplied
               'as-is', with no warranties, either implied or explicit.
               Any claims to alleged functionality or features should be
               considered 'preliminary', and might not function as advertised.

  MIT-like license:

  There is no restriction as to what you can do with this software, so long
  as you include the above copyright notice and DISCLAIMER for any distributed
  work that is equal to or derived from this one, along with this paragraph
  that explains the terms of the license if the source is also being made
  available.  A "derived work" describes a work that uses a significant portion
  of the source files or algorithms that are included with this one.
  Specifically excluded from this are files that were generated by the software,
  or anything that is included with the software that is part of another package
  (such as files that were created or added during the 'configure' process).
  Specifically included is the use of part or all of any of the X11 workbench
  toolkit source or header files in your distributed application.  If you do not
  ship the source, the above copyright statement is still required to be placed
  in a reasonably prominent place, such as documentation, splash screens, and/or
  'about the application' dialog boxes.

  Use and distribution are in accordance with GPL, LGPL, and/or the above
  MIT-like license.  See COPYING and README files for more information.


  Additional information at http://sourceforge.net/projects/X11workbench

******************************************************************************/


#ifndef _PIXMAP_HELPER_H_
#define _PIXMAP_HELPER_H_

#include "window_helper.h"  // if not already included, I must include this

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus


#define ID_ICON_FIRST     101
#define ID_APPLICATION    101 /* 19x19 application icon */
#define ID_ICON_OK        102
#define ID_ICON_STOP      103
#define ID_ICON_WARN      104 /* yellow triangle, ! */
#define ID_ICON_WHAT      105
#define ID_ICON_QUESTION  105
#define ID_ICON_SPLAT     106
#define ID_ICON_ASTERISK  106
#define ID_ICON_BANG      107 /* yellow circle, ! */
#define ID_ICON_TRIANGLE  108
#define ID_ICON_WHAT_BOLD 109
#define ID_ICON_WTF       110
#define ID_ICON_DEATH     111
#define ID_ICON_FINGER    112
#define ID_ICON_SKULL     113
#define ID_ICON_THUMBUP   114
#define ID_ICON_THUMBDOWN 115
#define ID_ICON_BEAR      116
#define ID_ICON_BARNEY    117
#define ID_ICON_APP       118 /* 36x36 application icon */
#define ID_ICON_LAST      118 /* must alter this if new items added */


#define RGB255_TO_XCOLOR(R,G,B,X) { (X).red = ((unsigned int)(R) << 8) & 0xffff; \
                                    (X).green = ((unsigned int)(G) << 8) & 0xffff; \
                                    (X).blue = ((unsigned int)(B) << 8) & 0xffff; \
                                    (X).flags = DoRed | DoGreen | DoBlue; }

#define RGB_TO_XCOLOR(R,G,B,X) { (X).red = ((unsigned int)(R)) & 0xffff; \
                                 (X).green = ((unsigned int)(G)) & 0xffff; \
                                 (X).blue = ((unsigned int)(B)) & 0xffff; \
                                 (X).flags = DoRed | DoGreen | DoBlue; }


#define RGB255_FROM_XCOLOR(X,R,G,B) {register unsigned short __iR,__iG,__iB; RGB_FROM_XCOLOR(X,__iR, __iG, __iB); \
                                     if(__iR < 0xff80){ __iR += 0x80; } \
                                     if(__iG < 0xff80){ __iG += 0x80; } \
                                     if(__iB < 0xff80){ __iB += 0x80; } \
                                     __iR = __iR >> 8; __iG = __iG >> 8; __iB = __iB >> 8; \
                                     __iR &= 0xff; __iG &= 0xff; __iB &= 0xff; \
                                     (R) = __iR; (G) = __iG; (B) = __iB; }

#define RGB_FROM_XCOLOR(X,R,G,B) { (R) = (((X).flags) & DoRed) ? ((unsigned int)(X).red) & 0xffff : 0; \
                                   (G) = (((X).flags) & DoGreen) ? ((unsigned int)(X).green) & 0xffff : 0; \
                                   (B) = (((X).flags) & DoBlue) ? ((unsigned int)(X).blue) & 0xffff : 0; }


void PXM_OnExit(void);


static __inline__ XStandardColormap *PXM_StandardColormapFromColormap(Display *pDisplay, Colormap colormap)
{
extern XStandardColormap PXM_StandardColormapFromColormap_rval; // declare extern rather than static, for single mem spot

  if(!pDisplay)
  {
    pDisplay = WBGetDefaultDisplay();
  }

  WBDefaultStandardColormap(pDisplay, &PXM_StandardColormapFromColormap_rval);

  PXM_StandardColormapFromColormap_rval.colormap = colormap;

  return &PXM_StandardColormapFromColormap_rval;
}

void PXM_RGBToYUV(int iR, int iG, int iB, int *piY, int *piU, int *piV);


void PXM_RGBToHSV(int iR, int iG, int iB, int *piH, int *piS, int *piV);


void PXM_YUVToRGB(int iY, int iU, int iV, int *piR, int *piG, int *piB);


void PXM_HSVToRGB(int iH, int iS, int iV, int *piR, int *piG, int *piB);


void PXM_PixelToRGB(XStandardColormap *pMap, XColor *pColor);


void PXM_RGBToPixel(XStandardColormap *pMap, XColor *pColor);


void PXM_RegisterAppIcons(char *ppRegAppLarge[], char *ppRegAppSmall[]);


int PXM_RegisterPixmapResource(Atom aResource, char *ppResource[]);



Pixmap PXM_GetIconPixmap(int idIcon, XPM_ATTRIBUTES *pAttr, Pixmap *pMask /* = NULL*/);


Pixmap PXM_GetIconPixmapFromAtom(Atom aIcon, XPM_ATTRIBUTES *pAttr, Pixmap *pMask /* = NULL*/);



Pixmap PXM_LoadPixmap(char *ppXPM[], XPM_ATTRIBUTES *pAttr, Pixmap *pMask /* = NULL*/);



Pixmap PXM_ImageToPixmap(Display *pDisplay, Drawable dw, XImage *pImage,
                         unsigned long clrFGPixel, unsigned long clrBGPixel);



Pixmap PXM_ImageToPixmap0(Display *pDisplay, Drawable dw, XImage *pImage);



XImage *PXM_PixmapToImage(Display *pDisplay, Pixmap pxImage);


//   _                           _                       _   //
//  | |     ___ __      __      | |     ___ __   __ ___ | |  //
//  | |    / _ \\ \ /\ / /_____ | |    / _ \\ \ / // _ \| |  //
//  | |___| (_) |\ V  V /|_____|| |___|  __/ \ V /|  __/| |  //
//  |_____|\___/  \_/\_/        |_____|\___|  \_/  \___||_|  //
//                                                           //


Pixmap PXM_CreatePixmap(Display *pDisplay, Drawable dw, unsigned int width,
                        unsigned int height, unsigned int depth);

int PXM_FreePixmap(Display *pDisplay, Pixmap pxImage);


Pixmap PXM_CopyPixmap(Display *pDisplay, Drawable dw, Pixmap pxImage);





//  __  __ _  _   _____        _                     _                      //
//  \ \/ // |/ | | ____|__  __| |_  ___  _ __   ___ (_)  ___   _ __   ___   //
//   \  / | || | |  _|  \ \/ /| __|/ _ \| '_ \ / __|| | / _ \ | '_ \ / __|  //
//   /  \ | || | | |___  >  < | |_|  __/| | | |\__ \| || (_) || | | |\__ \  //
//  /_/\_\|_||_| |_____|/_/\_\ \__|\___||_| |_||___/|_| \___/ |_| |_||___/  //
//                                                                          //

#if defined(X11WORKBENCH_TOOLKIT_HAVE_XSHM_EXTENSION) || defined(__DOXYGEN__)

int WBXShmQueryExtension(Display *pDisplay);

#else // !X11WORKBENCH_TOOLKIT_HAVE_XSHM_EXTENSION

#define WBXShmQueryExtension(X) (0)

#endif // X11WORKBENCH_TOOLKIT_HAVE_XSHM_EXTENSION, __DOXYGEN__



//  __  __ ___                                  ____                                     _     //
//  \ \/ /|_ _| _ __ ___    __ _   __ _   ___  / ___|  _   _  _ __   _ __    ___   _ __ | |_   //
//   \  /  | | | '_ ` _ \  / _` | / _` | / _ \ \___ \ | | | || '_ \ | '_ \  / _ \ | '__|| __|  //
//   /  \  | | | | | | | || (_| || (_| ||  __/  ___) || |_| || |_) || |_) || (_) || |   | |_   //
//  /_/\_\|___||_| |_| |_| \__,_| \__, | \___| |____/  \__,_|| .__/ | .__/  \___/ |_|    \__|  //
//                                |___/                      |_|    |_|                        //


int WBXPutImage(Display *pDisplay, Drawable dw, WBGC gc, XImage *pImage,
                int src_x, int src_y, int dest_x, int dest_y,
                unsigned int width, unsigned int height);

XImage *WBXGetImage(Display *pDisplay, Drawable dw,
                    int x, int y, unsigned int width, unsigned int height,
                    unsigned long plane_mask, int format);

int WBXDestroyImage(XImage *pImage);


XImage * WBXCopyImage(Display *pDisplay, XImage *pImage);



//  __  __ ___                                   ____                     _      _              //
//  \ \/ /|_ _| _ __ ___    __ _   __ _   ___   / ___| _ __  __ _  _ __  | |__  (_)  ___  ___   //
//   \  /  | | | '_ ` _ \  / _` | / _` | / _ \ | |  _ | '__|/ _` || '_ \ | '_ \ | | / __|/ __|  //
//   /  \  | | | | | | | || (_| || (_| ||  __/ | |_| || |  | (_| || |_) || | | || || (__ \__ \  //
//  /_/\_\|___||_| |_| |_| \__,_| \__, | \___|  \____||_|   \__,_|| .__/ |_| |_||_| \___||___/  //
//                                |___/                           |_|                           //


Region WBXImageToRegion(const XImage *pImage);


XImage * WBXImageFromRegion(Region rgnSource, int width, int height);


int WBXDrawPoint(XImage *pImage, WBGC hGC, int x, int y);


int WBXDrawPoints(XImage *pImage, WBGC hGC,
                  XPoint *points, int npoints, int mode);


int WBXDrawLine(XImage *pImage, WBGC hGC,
                int x1, int y1, int x2, int y2);


int WBXDrawLines(XImage *pImage, WBGC hGC,
                 XPoint *points, int npoints, int mode);


int WBXDrawRectangle(XImage *pImage, WBGC hGC,
                     int x, int y, unsigned int width, unsigned int height);


int WBXFillRectangle(XImage *pImage, WBGC hGC,
                     int x, int y, unsigned int width, unsigned int height);


int WBXDrawArc(XImage *pImage, WBGC hGC,
               int x, int y, unsigned int width, unsigned int height,
               int angle1, int angle2);


int WBXFillArc(XImage *pImage, WBGC hGC,
               int x, int y, unsigned int width, unsigned int height,
               int angle1, int angle2);


int WBXFillPolygon(XImage *pImage, WBGC hGC,
                   XPoint *points, int npoints, int shape, int mode);


int WBXDrawString(XImage *pImage, WB_FONTC pFont, WBGC hGC,
                  int x, int y, const char *string, int length);






//-------------------
// HELPERS FOR XColor
//-------------------

void WBDebugDumpXColor(const char *szTitle, const XColor *pColor);

void WBDebugDumpColormap(const char *szTitle, const XStandardColormap *pMap);


//--------------------
// HELPERS FOR XImage
//--------------------


static __inline__ void *PXM_GetImageDataPtr(XImage *pImage)
{
  return pImage->data;
}

static __inline__ unsigned long PXM_GetImageDataLength(XImage *pImage)
{
  if(pImage->depth <= 1)
  {
    return (unsigned long)pImage->bytes_per_line * (unsigned long)pImage->height; // TODO:  is this right?
  }

  return (unsigned long)pImage->bytes_per_line * (unsigned long)pImage->height
         * (unsigned long)pImage->depth;
}

void WBSimpleAntiAliasPixmap(Display *pDisplay, const XStandardColormap *pMap, Pixmap pxImage,
                             unsigned long lPixel, WB_GEOM *pGeom);

void WBSimpleAntiAliasImage(const XStandardColormap *pMap, XImage *pImage, unsigned long lPixel, WB_GEOM *pGeom);



unsigned char WB_isqrt(unsigned char iVal);

unsigned char WB_icos0(unsigned char iVal);

char WB_icos(int iVal);

#define WB_isin(X) WB_icos((X) - 256) /* subtract 256, i.e. pi/2 radians, to convert a cos to a sin */




#ifdef __cplusplus
};
#endif // __cplusplus

#endif // _PIXMAP_HELPER_H_