xserver-multidpi/mi/misprite.c

/*
 * misprite.c
 *
 * machine independent software sprite routines
 */


/*

Copyright 1989, 1998  The Open Group

Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation.

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 THE
OPEN GROUP 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 The Open Group shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from The Open Group.
*/
/* 
 * MPX additions:
 * Copyright © 2006 Peter Hutterer
 * Author: Peter Hutterer <peter@cs.unisa.edu.au>
 *
 */

#ifdef HAVE_DIX_CONFIG_H
#include <dix-config.h>
#endif

# include   <X11/X.h>
# include   <X11/Xproto.h>
# include   "misc.h"
# include   "pixmapstr.h"
# include   "input.h"
# include   "mi.h"
# include   "cursorstr.h"
# include   <X11/fonts/font.h>
# include   "scrnintstr.h"
# include   "colormapst.h"
# include   "windowstr.h"
# include   "gcstruct.h"
# include   "mipointer.h"
# include   "mispritest.h"
# include   "dixfontstr.h"
# include   <X11/fonts/fontstruct.h>
# include   "inputstr.h" 

#ifdef RENDER
# include   "mipict.h"
#endif
# include   "damage.h"



#define SPRITE_DEBUG_ENABLE 0
#if SPRITE_DEBUG_ENABLE
#define SPRITE_DEBUG(x)	ErrorF x
#else
#define SPRITE_DEBUG(x)
#endif

/*
 * screen wrappers
 */

static int  miSpriteScreenIndex;
static unsigned long miSpriteGeneration = 0;

static Bool	    miSpriteCloseScreen(int i, ScreenPtr pScreen);
static void	    miSpriteGetImage(DrawablePtr pDrawable, int sx, int sy,
				     int w, int h, unsigned int format,
				     unsigned long planemask, char *pdstLine);
static void	    miSpriteGetSpans(DrawablePtr pDrawable, int wMax,
				     DDXPointPtr ppt, int *pwidth, int nspans,
				     char *pdstStart);
static void	    miSpriteSourceValidate(DrawablePtr pDrawable, int x, int y,
					   int width, int height);
static void	    miSpriteCopyWindow (WindowPtr pWindow,
					DDXPointRec ptOldOrg,
					RegionPtr prgnSrc);
static void	    miSpriteBlockHandler(int i, pointer blockData,
					 pointer pTimeout,
					 pointer pReadMask);
static void	    miSpriteInstallColormap(ColormapPtr pMap);
static void	    miSpriteStoreColors(ColormapPtr pMap, int ndef,
					xColorItem *pdef);

static void	    miSpriteSaveDoomedAreas(WindowPtr pWin,
					    RegionPtr pObscured, int dx,
					    int dy);
static void	    miSpriteComputeSaved(DeviceIntPtr pDev, 
                                         ScreenPtr pScreen);

#define SCREEN_PROLOGUE(pScreen, field)\
  ((pScreen)->field = \
   ((miSpriteScreenPtr) (pScreen)->devPrivates[miSpriteScreenIndex].ptr)->field)

#define SCREEN_EPILOGUE(pScreen, field)\
    ((pScreen)->field = miSprite##field)

/*
 * pointer-sprite method table
 */

static Bool miSpriteRealizeCursor(DeviceIntPtr pDev, ScreenPtr pScreen,
                                  CursorPtr pCursor); 
static Bool miSpriteUnrealizeCursor(DeviceIntPtr pDev, ScreenPtr pScreen, 
                                    CursorPtr pCursor);
static void miSpriteSetCursor(DeviceIntPtr pDev, ScreenPtr pScreen, 
                              CursorPtr pCursor, int x, int y);
static void miSpriteMoveCursor(DeviceIntPtr pDev, ScreenPtr pScreen, 
                               int x, int y);

_X_EXPORT miPointerSpriteFuncRec miSpritePointerFuncs = {
    miSpriteRealizeCursor,
    miSpriteUnrealizeCursor,
    miSpriteSetCursor,
    miSpriteMoveCursor,
};

/*
 * other misc functions
 */

static void miSpriteRemoveCursor(DeviceIntPtr pDev, 
                                 ScreenPtr pScreen); 
static void miSpriteSaveUnderCursor(DeviceIntPtr pDev,
                                 ScreenPtr pScreen);
static void miSpriteRestoreCursor(DeviceIntPtr pDev,
                                 ScreenPtr pScreen);

static void
miSpriteReportDamage (DamagePtr pDamage, RegionPtr pRegion, void *closure)
{
    ScreenPtr		    pScreen = closure;
    miSpriteScreenPtr	    pScreenPriv;
    miCursorInfoPtr         pCursorInfo;
    DeviceIntPtr            pDev;
    
    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    for (pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
            pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];

            if (pCursorInfo->isUp &&
                RECT_IN_REGION (pScreen, pRegion, &pCursorInfo->saved) 
                         != rgnOUT) 
            {
                SPRITE_DEBUG(("Damage remove\n"));
                miSpriteRemoveCursor (pDev, pScreen);
            }
        }
    }
}

/*
 * miSpriteInitialize -- called from device-dependent screen
 * initialization proc after all of the function pointers have
 * been stored in the screen structure.
 */

Bool
miSpriteInitialize (pScreen, cursorFuncs, screenFuncs)
    ScreenPtr		    pScreen;
    miSpriteCursorFuncPtr   cursorFuncs;
    miPointerScreenFuncPtr  screenFuncs;
{
    miSpriteScreenPtr	pScreenPriv;
    VisualPtr		pVisual;
    miCursorInfoPtr     pCursorInfo;
    int cursorIdx;
    
    if (!DamageSetup (pScreen))
	return FALSE;

    if (miSpriteGeneration != serverGeneration)
    {
	miSpriteScreenIndex = AllocateScreenPrivateIndex ();
	if (miSpriteScreenIndex < 0)
	    return FALSE;
	miSpriteGeneration = serverGeneration;
    }
    
    pScreenPriv = (miSpriteScreenPtr) xalloc (sizeof (miSpriteScreenRec));
    if (!pScreenPriv)
	return FALSE;
    
    pScreenPriv->pDamage = DamageCreate (miSpriteReportDamage,
					 (DamageDestroyFunc) 0,
					 DamageReportRawRegion,
					 TRUE,
					 pScreen,
					 (void *) pScreen);

    if (!miPointerInitialize (pScreen, &miSpritePointerFuncs, screenFuncs,TRUE))
    {
	xfree ((pointer) pScreenPriv);
	return FALSE;
    }
    for (pVisual = pScreen->visuals;
	 pVisual->vid != pScreen->rootVisual;
	 pVisual++)
	;
    pScreenPriv->pVisual = pVisual;
    pScreenPriv->CloseScreen = pScreen->CloseScreen;
    pScreenPriv->GetImage = pScreen->GetImage;
    pScreenPriv->GetSpans = pScreen->GetSpans;
    pScreenPriv->SourceValidate = pScreen->SourceValidate;

    pScreenPriv->CopyWindow = pScreen->CopyWindow;
    
    pScreenPriv->SaveDoomedAreas = pScreen->SaveDoomedAreas;
    
    pScreenPriv->InstallColormap = pScreen->InstallColormap;
    pScreenPriv->StoreColors = pScreen->StoreColors;
    
    pScreenPriv->BlockHandler = pScreen->BlockHandler;
    
    /* alloc and zero memory for all cursors */
    pScreenPriv->pDevCursors = 
        (miCursorInfoPtr)xalloc(MAX_DEVICES * sizeof(miCursorInfoRec));

    if (!pScreenPriv->pDevCursors)
    {
        xfree((pointer)pScreenPriv);
        return FALSE;
    }
    /* virtual core pointer's ID is 1 */
    pScreenPriv->cp = &(pScreenPriv->pDevCursors[1]);

    cursorIdx = 0;
    while (cursorIdx < MAX_DEVICES)
    {
        pCursorInfo = &(pScreenPriv->pDevCursors[cursorIdx]);
        pCursorInfo->pCursor = NULL;
        pCursorInfo->x = 0;
        pCursorInfo->y = 0;
        pCursorInfo->isUp = FALSE;
        pCursorInfo->shouldBeUp = FALSE;
        pCursorInfo->pCacheWin = NullWindow;
        pCursorInfo->isInCacheWin = FALSE;
        pCursorInfo->checkPixels = TRUE;
        pCursorInfo->pInstalledMap = NULL;
        pCursorInfo->pColormap = NULL;
        pCursorInfo->colors[SOURCE_COLOR].red = 0;
        pCursorInfo->colors[SOURCE_COLOR].green = 0;
        pCursorInfo->colors[SOURCE_COLOR].blue = 0;
        pCursorInfo->colors[MASK_COLOR].red = 0;
        pCursorInfo->colors[MASK_COLOR].green = 0;
        pCursorInfo->colors[MASK_COLOR].blue = 0;

        cursorIdx++;
    }

    pScreenPriv->funcs = cursorFuncs;
    pScreen->devPrivates[miSpriteScreenIndex].ptr = (pointer) pScreenPriv;

    pScreen->CloseScreen = miSpriteCloseScreen;
    pScreen->GetImage = miSpriteGetImage;
    pScreen->GetSpans = miSpriteGetSpans;
    pScreen->SourceValidate = miSpriteSourceValidate;

    pScreen->CopyWindow = miSpriteCopyWindow;

    pScreen->SaveDoomedAreas = miSpriteSaveDoomedAreas;

    pScreen->InstallColormap = miSpriteInstallColormap;
    pScreen->StoreColors = miSpriteStoreColors;

    pScreen->BlockHandler = miSpriteBlockHandler;

    damageRegister = 0;

    return TRUE;
}

/*
 * Screen wrappers
 */

/*
 * CloseScreen wrapper -- unwrap everything, free the private data
 * and call the wrapped function
 */

static Bool
miSpriteCloseScreen (i, pScreen)
    int i;
    ScreenPtr	pScreen;
{
    miSpriteScreenPtr   pScreenPriv;
    DeviceIntPtr        pDev;

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    pScreen->CloseScreen = pScreenPriv->CloseScreen;
    pScreen->GetImage = pScreenPriv->GetImage;
    pScreen->GetSpans = pScreenPriv->GetSpans;
    pScreen->SourceValidate = pScreenPriv->SourceValidate;
    pScreen->BlockHandler = pScreenPriv->BlockHandler;
    pScreen->InstallColormap = pScreenPriv->InstallColormap;
    pScreen->StoreColors = pScreenPriv->StoreColors;

    pScreen->SaveDoomedAreas = pScreenPriv->SaveDoomedAreas;
    for (pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
            miCursorInfoPtr pCursor;
            pCursor = &pScreenPriv->pDevCursors[pDev->id];
            miSpriteIsUpFALSE (pCursor, pScreen, pScreenPriv);
        }
    }
    DamageDestroy (pScreenPriv->pDamage);

    xfree ((pointer)(pScreenPriv->pDevCursors));
    xfree ((pointer) pScreenPriv);

    return (*pScreen->CloseScreen) (i, pScreen);
}

static void
miSpriteGetImage (pDrawable, sx, sy, w, h, format, planemask, pdstLine)
    DrawablePtr	    pDrawable;
    int		    sx, sy, w, h;
    unsigned int    format;
    unsigned long   planemask;
    char	    *pdstLine;
{
    ScreenPtr	    pScreen = pDrawable->pScreen;
    miSpriteScreenPtr    pScreenPriv;
    DeviceIntPtr    pDev = inputInfo.pointer;
    miCursorInfoPtr pCursorInfo;
    
    SCREEN_PROLOGUE (pScreen, GetImage);

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    for(pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
             pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];
             if (pDrawable->type == DRAWABLE_WINDOW &&
                     pCursorInfo->isUp &&
                     ORG_OVERLAP(&pCursorInfo->saved,pDrawable->x,pDrawable->y, 
                         sx, sy, w, h)) 
             {
                 SPRITE_DEBUG (("GetImage remove\n"));
                 miSpriteRemoveCursor (pDev, pScreen);
             }
        }
    }

    (*pScreen->GetImage) (pDrawable, sx, sy, w, h,
			  format, planemask, pdstLine);

    SCREEN_EPILOGUE (pScreen, GetImage);
}

static void
miSpriteGetSpans (pDrawable, wMax, ppt, pwidth, nspans, pdstStart)
    DrawablePtr	pDrawable;
    int		wMax;
    DDXPointPtr	ppt;
    int		*pwidth;
    int		nspans;
    char	*pdstStart;
{
    ScreenPtr		    pScreen = pDrawable->pScreen;
    miSpriteScreenPtr	    pScreenPriv;
    DeviceIntPtr            pDev = inputInfo.pointer;
    miCursorInfoPtr         pCursorInfo;
    
    SCREEN_PROLOGUE (pScreen, GetSpans);

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    for(pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
            pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];

            if (pDrawable->type == DRAWABLE_WINDOW && pCursorInfo->isUp)
            {
                DDXPointPtr    pts;
                int    	       *widths;
                int    	       nPts;
                int    	       xorg,
                               yorg;

                xorg = pDrawable->x;
                yorg = pDrawable->y;

                for (pts = ppt, widths = pwidth, nPts = nspans;
                        nPts--;
                        pts++, widths++)
                {
                    if (SPN_OVERLAP(&pCursorInfo->saved,pts->y+yorg,
                                pts->x+xorg,*widths))
                    {
                        SPRITE_DEBUG (("GetSpans remove\n"));
                        miSpriteRemoveCursor (pDev, pScreen);
                        break;
                    }
                }
            }
        }
    }

    (*pScreen->GetSpans) (pDrawable, wMax, ppt, pwidth, nspans, pdstStart);

    SCREEN_EPILOGUE (pScreen, GetSpans);
}

static void
miSpriteSourceValidate (pDrawable, x, y, width, height)
    DrawablePtr	pDrawable;
    int		x, y, width, height;
{
    ScreenPtr		    pScreen = pDrawable->pScreen;
    miSpriteScreenPtr	    pScreenPriv;
    DeviceIntPtr            pDev = inputInfo.pointer;
    miCursorInfoPtr         pCursorInfo;
    
    SCREEN_PROLOGUE (pScreen, SourceValidate);

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    for(pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
            pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];
            if (pDrawable->type == DRAWABLE_WINDOW && pCursorInfo->isUp &&
                    ORG_OVERLAP(&pCursorInfo->saved, pDrawable->x, pDrawable->y,
                        x, y, width, height))
            {
                SPRITE_DEBUG (("SourceValidate remove\n"));
                miSpriteRemoveCursor (pDev, pScreen);
            }
        }
    }

    if (pScreen->SourceValidate)
	(*pScreen->SourceValidate) (pDrawable, x, y, width, height);

    SCREEN_EPILOGUE (pScreen, SourceValidate);
}

static void
miSpriteCopyWindow (WindowPtr pWindow, DDXPointRec ptOldOrg, RegionPtr prgnSrc)
{
    ScreenPtr	pScreen = pWindow->drawable.pScreen;
    miSpriteScreenPtr	    pScreenPriv;
    DeviceIntPtr            pDev = inputInfo.pointer;
    miCursorInfoPtr         pCursorInfo;
    
    SCREEN_PROLOGUE (pScreen, CopyWindow);

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    for(pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
            pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];
            /*
             * Damage will take care of destination check
             */
            if (pCursorInfo->isUp &&
                    RECT_IN_REGION (pScreen, prgnSrc, &pCursorInfo->saved) != rgnOUT)
            {
                SPRITE_DEBUG (("CopyWindow remove\n"));
                miSpriteRemoveCursor (pDev, pScreen);
            }
        }
    }

    (*pScreen->CopyWindow) (pWindow, ptOldOrg, prgnSrc);
    SCREEN_EPILOGUE (pScreen, CopyWindow);
}

static void
miSpriteBlockHandler (i, blockData, pTimeout, pReadmask)
    int	i;
    pointer	blockData;
    pointer	pTimeout;
    pointer	pReadmask;
{
    ScreenPtr		pScreen = screenInfo.screens[i];
    miSpriteScreenPtr	pPriv;
    DeviceIntPtr            pDev = inputInfo.pointer;
    miCursorInfoPtr         pCursorInfo;

    pPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    SCREEN_PROLOGUE(pScreen, BlockHandler);
    
    (*pScreen->BlockHandler) (i, blockData, pTimeout, pReadmask);

    SCREEN_EPILOGUE(pScreen, BlockHandler);

    for(pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
            pCursorInfo = &pPriv->pDevCursors[pDev->id];
            if (!pCursorInfo->isUp && pCursorInfo->shouldBeUp)
            {
                SPRITE_DEBUG (("BlockHandler restore\n"));
                miSpriteSaveUnderCursor (pDev, pScreen);
            }
        }
    }
    for(pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
            pCursorInfo = &pPriv->pDevCursors[pDev->id];
            if (!pCursorInfo->isUp && pCursorInfo->shouldBeUp)
            {
                SPRITE_DEBUG (("BlockHandler restore\n"));
                miSpriteRestoreCursor (pDev, pScreen);
            }
        }
    }
}

static void
miSpriteInstallColormap (pMap)
    ColormapPtr	pMap;
{
    ScreenPtr		pScreen = pMap->pScreen;
    miSpriteScreenPtr	pPriv;
    DeviceIntPtr            pDev = inputInfo.pointer;
    miCursorInfoPtr         pCursorInfo;
    int                     cursorIdx;

    pPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    SCREEN_PROLOGUE(pScreen, InstallColormap);
    
    (*pScreen->InstallColormap) (pMap);

    SCREEN_EPILOGUE(pScreen, InstallColormap);

    /* InstallColormap is called before devices are initialized. We cannot
     * just run through the device list, we need to go through all possible
     * sprite structs.*/
    for (cursorIdx = 0; cursorIdx < MAX_DEVICES; cursorIdx++)
    {
        pCursorInfo = &pPriv->pDevCursors[cursorIdx];
        pCursorInfo->pInstalledMap = pMap;
        if (pCursorInfo->pColormap != pMap)
        {
            pCursorInfo->checkPixels = TRUE;
            if (pCursorInfo->isUp)
            {
                /* find matching device */
                for(pDev = inputInfo.devices; pDev; pDev = pDev->next)
                {
                    if (pDev->id == cursorIdx)
                    {
                        miSpriteRemoveCursor(pDev, pScreen);
                        break;
                    }
                }
            } 
        } 
    }
}

static void
miSpriteStoreColors (pMap, ndef, pdef)
    ColormapPtr	pMap;
    int		ndef;
    xColorItem	*pdef;
{
    ScreenPtr		pScreen = pMap->pScreen;
    miSpriteScreenPtr	pPriv;
    int			i;
    int			updated;
    VisualPtr		pVisual;
    DeviceIntPtr            pDev = inputInfo.pointer;
    miCursorInfoPtr         pCursorInfo;

    pPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    SCREEN_PROLOGUE(pScreen, StoreColors);
    
    (*pScreen->StoreColors) (pMap, ndef, pdef);

    SCREEN_EPILOGUE(pScreen, StoreColors);

#define MaskMatch(a,b,mask) (((a) & (pVisual->mask)) == ((b) & (pVisual->mask)))

#define UpdateDAC(dev, plane,dac,mask) {\
    if (MaskMatch (dev->colors[plane].pixel,pdef[i].pixel,mask)) {\
	dev->colors[plane].dac = pdef[i].dac; \
	updated = 1; \
    } \
}

#define CheckDirect(dev, plane) \
	    UpdateDAC(dev, plane,red,redMask) \
	    UpdateDAC(dev, plane,green,greenMask) \
	    UpdateDAC(dev, plane,blue,blueMask)

    for(pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if (DevHasCursor(pDev))
        {
            pCursorInfo = &pPriv->pDevCursors[pDev->id];
            if (pCursorInfo->pColormap == pMap)
            {
                updated = 0;
                pVisual = pMap->pVisual;
                if (pVisual->class == DirectColor)
                {
                    /* Direct color - match on any of the subfields */

                    for (i = 0; i < ndef; i++)
                    {
                        CheckDirect (pCursorInfo, SOURCE_COLOR)
                            CheckDirect (pCursorInfo, MASK_COLOR)
                    }
                }
                else
                {
                    /* PseudoColor/GrayScale - match on exact pixel */
                    for (i = 0; i < ndef; i++)
                    {
                        if (pdef[i].pixel ==
                                pCursorInfo->colors[SOURCE_COLOR].pixel) 
                        {
                            pCursorInfo->colors[SOURCE_COLOR] = pdef[i];
                            if (++updated == 2)
                                break;
                        }
                        if (pdef[i].pixel ==
                                pCursorInfo->colors[MASK_COLOR].pixel) 
                        {
                            pCursorInfo->colors[MASK_COLOR] = pdef[i];
                            if (++updated == 2)
                                break;
                        }
                    }
                }
                if (updated)
                {
                    pCursorInfo->checkPixels = TRUE;
                    if (pCursorInfo->isUp)
                        miSpriteRemoveCursor (pDev, pScreen);
                }
            }
        }
    }

}

static void
miSpriteFindColors (miCursorInfoPtr pDevCursor, ScreenPtr pScreen)
{
    CursorPtr		pCursor;
    xColorItem		*sourceColor, *maskColor;

    pCursor = pDevCursor->pCursor;
    sourceColor = &pDevCursor->colors[SOURCE_COLOR];
    maskColor = &pDevCursor->colors[MASK_COLOR];
    if (pDevCursor->pColormap != pDevCursor->pInstalledMap ||
	!(pCursor->foreRed == sourceColor->red &&
	  pCursor->foreGreen == sourceColor->green &&
          pCursor->foreBlue == sourceColor->blue &&
	  pCursor->backRed == maskColor->red &&
	  pCursor->backGreen == maskColor->green &&
	  pCursor->backBlue == maskColor->blue))
    {
	pDevCursor->pColormap = pDevCursor->pInstalledMap;
	sourceColor->red = pCursor->foreRed;
	sourceColor->green = pCursor->foreGreen;
	sourceColor->blue = pCursor->foreBlue;
	FakeAllocColor (pDevCursor->pColormap, sourceColor);
	maskColor->red = pCursor->backRed;
	maskColor->green = pCursor->backGreen;
	maskColor->blue = pCursor->backBlue;
	FakeAllocColor (pDevCursor->pColormap, maskColor);
	/* "free" the pixels right away, don't let this confuse you */
	FakeFreeColor(pDevCursor->pColormap, sourceColor->pixel);
	FakeFreeColor(pDevCursor->pColormap, maskColor->pixel);
    }

    pDevCursor->checkPixels = FALSE;

}

/*
 * BackingStore wrappers
 */

static void
miSpriteSaveDoomedAreas (pWin, pObscured, dx, dy)
    WindowPtr	pWin;
    RegionPtr	pObscured;
    int		dx, dy;
{
    ScreenPtr		pScreen;
    miSpriteScreenPtr   pScreenPriv;
    BoxRec		cursorBox;
    DeviceIntPtr        pDev = inputInfo.pointer;
    miCursorInfoPtr     pCursorInfo;

    pScreen = pWin->drawable.pScreen;
    
    SCREEN_PROLOGUE (pScreen, SaveDoomedAreas);

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;

    for (pDev = inputInfo.devices; pDev; pDev = pDev->next)
    {
        if(DevHasCursor(pDev))
        {
            pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];
            if (pCursorInfo->isUp)
            {
                cursorBox = pCursorInfo->saved;

                if (dx || dy)
                {
                    cursorBox.x1 += dx;
                    cursorBox.y1 += dy;
                    cursorBox.x2 += dx;
                    cursorBox.y2 += dy;
                }
                if (RECT_IN_REGION( pScreen, pObscured, &cursorBox) != rgnOUT)
                    miSpriteRemoveCursor (pDev, pScreen);
            }

        }
    }

    (*pScreen->SaveDoomedAreas) (pWin, pObscured, dx, dy);

    SCREEN_EPILOGUE (pScreen, SaveDoomedAreas);
}

/*
 * miPointer interface routines
 */

#define SPRITE_PAD  8

static Bool
miSpriteRealizeCursor (pDev, pScreen, pCursor)
    DeviceIntPtr pDev;
    ScreenPtr	pScreen;
    CursorPtr	pCursor;
{
    miSpriteScreenPtr	pScreenPriv;
    miCursorInfoPtr pCursorInfo;

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;
    pCursorInfo = pScreenPriv->cp;

    if (DevHasCursor(pDev))
        pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];

    if (pCursor == pCursorInfo->pCursor)
	pCursorInfo->checkPixels = TRUE;

    return (*pScreenPriv->funcs->RealizeCursor) (pScreen, pCursor);
}

static Bool
miSpriteUnrealizeCursor (pDev, pScreen, pCursor)
    DeviceIntPtr pDev;
    ScreenPtr	pScreen;
    CursorPtr	pCursor;
{
    miSpriteScreenPtr	pScreenPriv;

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;
    return (*pScreenPriv->funcs->UnrealizeCursor) (pScreen, pCursor);
}

static void
miSpriteSetCursor (pDev, pScreen, pCursor, x, y)
    DeviceIntPtr pDev;
    ScreenPtr	pScreen;
    CursorPtr	pCursor;
    int		x;
    int		y;
{
    miSpriteScreenPtr	pScreenPriv;

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;
    miCursorInfoPtr pPointer = pScreenPriv->cp;

    if (DevHasCursor(pDev))
        pPointer = &pScreenPriv->pDevCursors[pDev->id];

    if (!pCursor)
    {
    	pPointer->shouldBeUp = FALSE;
    	if (pPointer->isUp)
	    miSpriteRemoveCursor (pDev, pScreen);
	pPointer->pCursor = 0;
	return;
    }
    pPointer->shouldBeUp = TRUE;
    if (pPointer->x == x &&
	pPointer->y == y &&
	pPointer->pCursor == pCursor &&
	!pPointer->checkPixels)
    {
	return;
    }
    pPointer->x = x;
    pPointer->y = y;
    pPointer->pCacheWin = NullWindow;
    if (pPointer->checkPixels || pPointer->pCursor != pCursor)
    {
	pPointer->pCursor = pCursor;
	miSpriteFindColors (pPointer, pScreen);
    }
    if (pPointer->isUp) {
#if 0
        /* FIXME: Disabled for MPX, should be rewritten */
	int	sx, sy;
	/*
	 * check to see if the old saved region
	 * encloses the new sprite, in which case we use
	 * the flicker-free MoveCursor primitive.
	 */
	sx = pointer->x - (int)pCursor->bits->xhot;
	sy = pointer->y - (int)pCursor->bits->yhot;
	if (sx + (int) pCursor->bits->width >= pointer->saved.x1 &&
	    sx < pointer->saved.x2 &&
	    sy + (int) pCursor->bits->height >= pointer->saved.y1 &&
	    sy < pointer->saved.y2 &&
	    (int) pCursor->bits->width + (2 * SPRITE_PAD) ==
		pointer->saved.x2 - pointer->saved.x1 &&
	    (int) pCursor->bits->height + (2 * SPRITE_PAD) ==
		pointer->saved.y2 - pointer->saved.y1
	    )
	{
	    DamageDrawInternal (pScreen, TRUE);
	    miSpriteIsUpFALSE (pScreen, pScreenPriv);
	    if (!(sx >= pointer->saved.x1 &&
                  sx + (int)pCursor->bits->width < pointer->saved.x2
                  && sy >= pointer->saved.y1 &&
                  sy + (int)pCursor->bits->height <
                                pointer->saved.y2)) 
            {
		int oldx1, oldy1, dx, dy;

		oldx1 = pointer->saved.x1;
		oldy1 = pointer->saved.y1;
		dx = oldx1 - (sx - SPRITE_PAD);
		dy = oldy1 - (sy - SPRITE_PAD);
		pointer->saved.x1 -= dx;
		pointer->saved.y1 -= dy;
		pointer->saved.x2 -= dx;
		pointer->saved.y2 -= dy;
		(void) (*pScreenPriv->funcs->ChangeSave) (pScreen,
				pointer->saved.x1,
 				pointer->saved.y1,
                                pointer->saved.x2 -
                                pointer->saved.x1,
                                pointer->saved.y2 -
                                pointer->saved.y1,
				dx, dy);
	    }
	    (void) (*pScreenPriv->funcs->MoveCursor) (pScreen, pCursor,
				  pointer->saved.x1,
 				  pointer->saved.y1,
                                  pointer->saved.x2 -
                                  pointer->saved.x1,
                                  pointer->saved.y2 -
                                  pointer->saved.y1,
				  sx - pointer->saved.x1,
				  sy - pointer->saved.y1,
				  pointer->colors[SOURCE_COLOR].pixel,
				  pointer->colors[MASK_COLOR].pixel);
	    miSpriteIsUpTRUE (pScreen, pScreenPriv);
	    DamageDrawInternal (pScreen, FALSE);
	}
	else
#endif
	{
	    SPRITE_DEBUG (("SetCursor remove %d\n", pDev->id));
	    miSpriteRemoveCursor (pDev, pScreen);
	}
    }

    if (!pPointer->isUp && pPointer->pCursor)
    {
	SPRITE_DEBUG (("SetCursor restore %d\n", pDev->id));
        miSpriteSaveUnderCursor(pDev, pScreen);
	miSpriteRestoreCursor (pDev, pScreen);
    }

}

static void
miSpriteMoveCursor (pDev, pScreen, x, y)
    DeviceIntPtr pDev;
    ScreenPtr	pScreen;
    int		x, y;
{
    miSpriteScreenPtr	pScreenPriv;
    CursorPtr pCursor;

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;
    pCursor = pScreenPriv->cp->pCursor;

    if (DevHasCursor(pDev))
        pCursor = pScreenPriv->pDevCursors[pDev->id].pCursor;

    miSpriteSetCursor (pDev, pScreen, pCursor, x, y);
}

/*
 * undraw/draw cursor
 */

static void
miSpriteRemoveCursor (pDev, pScreen)
    DeviceIntPtr pDev;
    ScreenPtr	pScreen;
{
    miSpriteScreenPtr   pScreenPriv;
    miCursorInfoPtr     pCursorInfo;


    DamageDrawInternal (pScreen, TRUE);
    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;
    pCursorInfo = pScreenPriv->cp;

    if (DevHasCursor(pDev))
        pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];

    miSpriteIsUpFALSE (pCursorInfo, pScreen, pScreenPriv);
    pCursorInfo->pCacheWin = NullWindow;
    miSpriteDisableDamage(pScreen, pScreenPriv);
    if (!(*pScreenPriv->funcs->RestoreUnderCursor) (pDev,
                                         pScreen,
					 pCursorInfo->saved.x1,
                                         pCursorInfo->saved.y1,
                                         pCursorInfo->saved.x2 -
                                         pCursorInfo->saved.x1,
                                         pCursorInfo->saved.y2 -
                                         pCursorInfo->saved.y1))
    {
	miSpriteIsUpTRUE (pCursorInfo, pScreen, pScreenPriv);
    }
    miSpriteEnableDamage(pScreen, pScreenPriv);
    DamageDrawInternal (pScreen, FALSE);
}

/*
 * Called from the block handler, saves area under cursor
 * before waiting for something to do.
 */

static void 
miSpriteSaveUnderCursor(pDev, pScreen)
    DeviceIntPtr pDev;
    ScreenPtr	pScreen;
{
    miSpriteScreenPtr   pScreenPriv;
    int			x, y;
    CursorPtr		pCursor;
    miCursorInfoPtr     pCursorInfo;

    DamageDrawInternal (pScreen, TRUE);
    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;
    pCursorInfo = pScreenPriv->cp;

    if (DevHasCursor(pDev))
        pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];

    miSpriteComputeSaved (pDev, pScreen);
    pCursor = pCursorInfo->pCursor;

    x = pCursorInfo->x - (int)pCursor->bits->xhot;
    y = pCursorInfo->y - (int)pCursor->bits->yhot;
    miSpriteDisableDamage(pScreen, pScreenPriv);

    (*pScreenPriv->funcs->SaveUnderCursor) (pDev,
                                      pScreen,
				      pCursorInfo->saved.x1,
				      pCursorInfo->saved.y1,
                                      pCursorInfo->saved.x2 -
                                      pCursorInfo->saved.x1,
                                      pCursorInfo->saved.y2 -
                                      pCursorInfo->saved.y1);
    SPRITE_DEBUG(("SaveUnderCursor %d\n", pDev->id));
    miSpriteEnableDamage(pScreen, pScreenPriv);
    DamageDrawInternal (pScreen, FALSE);
}


/*
 * Called from the block handler, restores the cursor
 * before waiting for something to do.
 */

static void
miSpriteRestoreCursor (pDev, pScreen)
    DeviceIntPtr pDev;
    ScreenPtr	pScreen;
{
    miSpriteScreenPtr   pScreenPriv;
    int			x, y;
    CursorPtr		pCursor;
    miCursorInfoPtr     pCursorInfo;

    DamageDrawInternal (pScreen, TRUE);
    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;
    pCursorInfo = pScreenPriv->cp;

    if (DevHasCursor(pDev))
        pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];

    miSpriteComputeSaved (pDev, pScreen);
    pCursor = pCursorInfo->pCursor;

    x = pCursorInfo->x - (int)pCursor->bits->xhot;
    y = pCursorInfo->y - (int)pCursor->bits->yhot;
    miSpriteDisableDamage(pScreen, pScreenPriv);
    SPRITE_DEBUG(("RestoreCursor %d\n", pDev->id));
    if (pCursorInfo->checkPixels)
        miSpriteFindColors (pCursorInfo, pScreen);
    if ((*pScreenPriv->funcs->PutUpCursor) (pDev, pScreen, 
                pCursor, x, y,
                pCursorInfo->colors[SOURCE_COLOR].pixel,
                pCursorInfo->colors[MASK_COLOR].pixel))
    {
        miSpriteIsUpTRUE (pCursorInfo, pScreen, pScreenPriv);
    }
    miSpriteEnableDamage(pScreen, pScreenPriv);
    DamageDrawInternal (pScreen, FALSE);
}

/*
 * compute the desired area of the screen to save
 */

static void
miSpriteComputeSaved (pDev, pScreen)
    DeviceIntPtr pDev;
    ScreenPtr	pScreen;
{
    miSpriteScreenPtr   pScreenPriv;
    int		    x, y, w, h;
    int		    wpad, hpad;
    CursorPtr	    pCursor;
    miCursorInfoPtr pCursorInfo;

    pScreenPriv = (miSpriteScreenPtr) pScreen->devPrivates[miSpriteScreenIndex].ptr;
    pCursorInfo = pScreenPriv->cp;

    if (DevHasCursor(pDev))
        pCursorInfo = &pScreenPriv->pDevCursors[pDev->id];

    pCursor = pCursorInfo->pCursor;
    x = pCursorInfo->x - (int)pCursor->bits->xhot;
    y = pCursorInfo->y - (int)pCursor->bits->yhot;
    w = pCursor->bits->width;
    h = pCursor->bits->height;
    wpad = SPRITE_PAD;
    hpad = SPRITE_PAD;
    pCursorInfo->saved.x1 = x - wpad;
    pCursorInfo->saved.y1 = y - hpad;
    pCursorInfo->saved.x2 = pCursorInfo->saved.x1 + w + wpad * 2;
    pCursorInfo->saved.y2 = pCursorInfo->saved.y1 + h + hpad * 2;
}