/* SPDX-License-Identifier: MIT OR X11
 *
 * Copyright © 2024 Enrico Weigelt, metux IT consult <info@metux.net>
 */
#ifndef _XSERVER_DIX_COLORMAP_PRIV_H
#define _XSERVER_DIX_COLORMAP_PRIV_H

#include <X11/Xdefs.h>
#include <X11/Xproto.h>

#include "dix/screenint_priv.h"
#include "include/colormap.h"
#include "include/colormapst.h"
#include "include/dix.h"
#include "include/window.h"

/* Values for the flags field of a colormap. These should have 1 bit set
 * and not overlap */
#define CM_IsDefault 1
#define CM_AllAllocated 2
#define CM_BeingCreated 4

/* Shared color -- the color is used by AllocColorPlanes */
typedef struct {
    unsigned short color;
    short refcnt;
} SHAREDCOLOR;

/* SHCO -- a shared color for a PseudoColor cell. Used with AllocColorPlanes.
 * DirectColor maps always use the first value (called red) in the structure.
 * What channel they are really talking about depends on which map they
 * are in. */
typedef struct {
    SHAREDCOLOR *red, *green, *blue;
} SHCO;

/* color map entry */
typedef struct _CMEntry {
    union {
        LOCO local;
        SHCO shco;
    } co;
    short refcnt;
    Bool fShared;
} Entry, *EntryPtr;

/* COLORMAPs can be used for either Direct or Pseudo color.  PseudoColor
 * only needs one cell table, we arbitrarily pick red.  We keep track
 * of that table with freeRed, numPixelsRed, and clientPixelsRed */

typedef struct _ColormapRec {
    VisualPtr pVisual;
    short class;                /* PseudoColor or DirectColor */
    XID mid;                    /* client's name for colormap */
    ScreenPtr pScreen;          /* screen map is associated with */
    short flags;                /* 1 = CM_IsDefault
                                 * 2 = CM_AllAllocated */
    int freeRed;
    int freeGreen;
    int freeBlue;
    int *numPixelsRed;
    int *numPixelsGreen;
    int *numPixelsBlue;
    Pixel **clientPixelsRed;
    Pixel **clientPixelsGreen;
    Pixel **clientPixelsBlue;
    Entry *red;
    Entry *green;
    Entry *blue;
    PrivateRec *devPrivates;
} ColormapRec;

int dixCreateColormap(Colormap mid, ScreenPtr pScreen, VisualPtr pVisual,
                      ColormapPtr *ppcmap, int alloc, ClientPtr client);

/* should only be called via resource type's destructor */
int FreeColormap(void *pmap, XID mid);

int TellLostMap(WindowPtr pwin, void *value);

int TellGainedMap(WindowPtr pwin, void *value);

int CopyColormapAndFree(Colormap mid, ColormapPtr pSrc, int client);

_X_EXPORT /* only for internal wfb module, as long as it's still a shared object */
int AllocColor(ColormapPtr pmap, unsigned short *pred, unsigned short *pgreen,
               unsigned short *pblue, Pixel *pPix, int client );

void FakeAllocColor(ColormapPtr pmap, xColorItem *item);

void FakeFreeColor(ColormapPtr pmap, Pixel pixel);

int QueryColors(ColormapPtr pmap, int count, Pixel *ppixIn,
                xrgb *prgbList, ClientPtr client);

/* should only be called via resource type's destructor */
int FreeClientPixels(void *pcr, XID fakeid);

int AllocColorCells(ClientPtr pClient, ColormapPtr pmap, int colors, int planes,
                    Bool contig, Pixel *ppix, Pixel *masks);

int AllocColorPlanes(int client, ColormapPtr pmap, int colors, int r, int g,
                     int b, Bool contig, Pixel *pixels, Pixel *prmask,
                     Pixel *pgmask, Pixel *pbmask);

int FreeColors(ColormapPtr pmap, int client, int count, Pixel *pixels, Pixel mask);

int StoreColors(ColormapPtr pmap, int count, xColorItem * defs, ClientPtr client);

int IsMapInstalled(Colormap map, WindowPtr pWin);

/* only exported for glx, but should not be used by external drivers */
_X_EXPORT Bool ResizeVisualArray(ScreenPtr pScreen, int new_vis_count, DepthPtr depth);

#endif /* _XSERVER_DIX_COLORMAP_PRIV_H */