reactos/win32ss/gdi/eng/engwindow.c

/*
 * COPYRIGHT:         See COPYING in the top level directory
 * PROJECT:           ReactOS kernel
 * PURPOSE:           GDI WNDOBJ Functions
 * FILE:              subsystems/win32/win32k/eng/engwindow.c
 * PROGRAMER:         Gregor Anich
 */

#include <win32k.h>

#define NDEBUG
#include <debug.h>

INT gcountPWO = 0;

/*
 * Calls the WNDOBJCHANGEPROC of the given WNDOBJ
 */
VOID
FASTCALL
IntEngWndCallChangeProc(
    IN WNDOBJ *pwo,
    IN FLONG   flChanged)
{
    WNDGDI *WndObjInt = ObjToGDI(pwo, WND);

    if (WndObjInt->ChangeProc == NULL)
    {
        return;
    }

    /* check flags of the WNDOBJ */
    flChanged &= WndObjInt->Flags;
    if (flChanged == 0)
    {
        return;
    }

    /* Call the WNDOBJCHANGEPROC */
    if (flChanged == WOC_CHANGED)
    {
        pwo = NULL;
    }

    DPRINT("Calling WNDOBJCHANGEPROC (0x%p), Changed = 0x%x\n",
           WndObjInt->ChangeProc, flChanged);
    WndObjInt->ChangeProc(pwo, flChanged);
}

/*
 * Fills the CLIPOBJ and client rect of the WNDOBJ with the data from the given WND
 */
BOOLEAN
FASTCALL
IntEngWndUpdateClipObj(
    WNDGDI *WndObjInt,
    PWND Window)
{
    HRGN hVisRgn;
    PROSRGNDATA visRgn;
    CLIPOBJ *ClipObj = NULL;
    CLIPOBJ *OldClipObj;

    DPRINT("IntEngWndUpdateClipObj\n");

    hVisRgn = VIS_ComputeVisibleRegion(Window, TRUE, TRUE, TRUE);
    if (hVisRgn != NULL)
    {
        NtGdiOffsetRgn(hVisRgn, Window->rcClient.left, Window->rcClient.top);
        visRgn = RGNOBJAPI_Lock(hVisRgn, NULL);
        if (visRgn != NULL)
        {
            if (visRgn->rdh.nCount > 0)
            {
                ClipObj = IntEngCreateClipRegion(visRgn->rdh.nCount, visRgn->Buffer,
                                                 &visRgn->rdh.rcBound);
                DPRINT("Created visible region with %lu rects\n", visRgn->rdh.nCount);
                DPRINT("  BoundingRect: %d, %d  %d, %d\n",
                       visRgn->rdh.rcBound.left, visRgn->rdh.rcBound.top,
                       visRgn->rdh.rcBound.right, visRgn->rdh.rcBound.bottom);
                {
                    ULONG i;
                    for (i = 0; i < visRgn->rdh.nCount; i++)
                    {
                        DPRINT("  Rect #%lu: %ld,%ld  %ld,%ld\n", i+1,
                               visRgn->Buffer[i].left, visRgn->Buffer[i].top,
                               visRgn->Buffer[i].right, visRgn->Buffer[i].bottom);
                    }
                }
            }
            RGNOBJAPI_Unlock(visRgn);
        }
        else
        {
            DPRINT1("Warning: Couldn't lock visible region of window DC\n");
        }
        GreDeleteObject(hVisRgn);
    }
    else
    {
        DPRINT1("Warning: VIS_ComputeVisibleRegion failed!\n");
    }

    if (ClipObj == NULL)
    {
        /* Fall back to client rect */
        ClipObj = IntEngCreateClipRegion(1, &Window->rcClient,
                                         &Window->rcClient);
    }

    if (ClipObj == NULL)
    {
        DPRINT1("Warning: IntEngCreateClipRegion() failed!\n");
        return FALSE;
    }

    RtlCopyMemory(&WndObjInt->WndObj.coClient, ClipObj, sizeof (CLIPOBJ));
    RtlCopyMemory(&WndObjInt->WndObj.rclClient, &Window->rcClient, sizeof (RECT));
    OldClipObj = InterlockedExchangePointer((PVOID*)&WndObjInt->ClientClipObj, ClipObj);
    if (OldClipObj != NULL)
        IntEngDeleteClipRegion(OldClipObj);

    return TRUE;
}

/*
 * Updates all WNDOBJs of the given WND and calls the change-procs.
 */
VOID
FASTCALL
IntEngWindowChanged(
    _In_    PWND  Window,
    _In_    FLONG flChanged)
{
    PPROPERTY pprop;
    WNDGDI *Current;
    HWND hWnd;

    ASSERT_IRQL_LESS_OR_EQUAL(PASSIVE_LEVEL);

    hWnd = Window->head.h;
    pprop = IntGetProp(Window, AtomWndObj);
    if (!pprop)
    {
        return;
    }
    Current = (WNDGDI *)pprop->Data;
    if ( gcountPWO &&
            Current &&
            Current->Hwnd == hWnd &&
            Current->WndObj.pvConsumer != NULL )
    {
        /* Update the WNDOBJ */
        switch (flChanged)
        {
        case WOC_RGN_CLIENT:
            /* Update the clipobj and client rect of the WNDOBJ */
            IntEngWndUpdateClipObj(Current, Window);
            break;

        case WOC_DELETE:
            /* FIXME: Should the WNDOBJs be deleted by win32k or by the driver? */
            break;
        }

        /* Call the change proc */
        IntEngWndCallChangeProc(&Current->WndObj, flChanged);

        /* HACK: Send WOC_CHANGED after WOC_RGN_CLIENT */
        if (flChanged == WOC_RGN_CLIENT)
        {
            IntEngWndCallChangeProc(&Current->WndObj, WOC_CHANGED);
        }
    }
}

/*
 * @implemented
 */
WNDOBJ*
APIENTRY
EngCreateWnd(
    SURFOBJ          *pso,
    HWND              hWnd,
    WNDOBJCHANGEPROC  pfn,
    FLONG             fl,
    int               iPixelFormat)
{
    WNDGDI *WndObjInt = NULL;
    WNDOBJ *WndObjUser = NULL;
    PWND Window;
    BOOL calledFromUser;
    DECLARE_RETURN(WNDOBJ*);

    DPRINT1("EngCreateWnd: pso = 0x%p, hwnd = 0x%p, pfn = 0x%p, fl = 0x%lx, pixfmt = %d\n",
            pso, hWnd, pfn, fl, iPixelFormat);

    calledFromUser = UserIsEntered();
    if (!calledFromUser) {
        UserEnterShared();
    }

    /* Get window object */
    Window = UserGetWindowObject(hWnd);
    if (Window == NULL)
    {
        RETURN( NULL);
    }

    /* Create WNDOBJ */
    WndObjInt = EngAllocMem(0, sizeof (WNDGDI), GDITAG_WNDOBJ);
    if (WndObjInt == NULL)
    {
        DPRINT1("Failed to allocate memory for a WND structure!\n");
        RETURN( NULL);
    }

    /* Fill the clipobj */
    WndObjInt->ClientClipObj = NULL;
    if (!IntEngWndUpdateClipObj(WndObjInt, Window))
    {
        EngFreeMem(WndObjInt);
        RETURN( NULL);
    }

    /* Fill user object */
    WndObjUser = GDIToObj(WndObjInt, WND);
    WndObjUser->psoOwner = pso;
    WndObjUser->pvConsumer = NULL;

    /* Fill internal object */
    WndObjInt->Hwnd = hWnd;
    WndObjInt->ChangeProc = pfn;
    WndObjInt->Flags = fl;
    WndObjInt->PixelFormat = iPixelFormat;

    /* associate object with window */
    IntSetProp(Window, AtomWndObj, WndObjInt);
    ++gcountPWO;

    DPRINT("EngCreateWnd: SUCCESS!\n");

    RETURN( WndObjUser);

CLEANUP:

    if (!calledFromUser) {
        UserLeave();
    }

    END_CLEANUP;
}


/*
 * @implemented
 */
VOID
APIENTRY
EngDeleteWnd(
    IN WNDOBJ *pwo)
{
    WNDGDI *WndObjInt = ObjToGDI(pwo, WND);
    PWND Window;
    BOOL calledFromUser;

    DPRINT("EngDeleteWnd: pwo = 0x%p\n", pwo);

    calledFromUser = UserIsEntered();
    if (!calledFromUser) {
        UserEnterExclusive();
    }

    /* Get window object */
    Window = UserGetWindowObject(WndObjInt->Hwnd);
    if (Window == NULL)
    {
        DPRINT1("Warning: Couldnt get window object for WndObjInt->Hwnd!!!\n");
    }
    else
    {
        /* Remove object from window */
        IntRemoveProp(Window, AtomWndObj);
        --gcountPWO;
    }

    if (!calledFromUser) {
        UserLeave();
    }

    /* Free resources */
    IntEngDeleteClipRegion(WndObjInt->ClientClipObj);
    EngFreeMem(WndObjInt);
}


/*
 * @implemented
 */
BOOL
APIENTRY
WNDOBJ_bEnum(
    IN WNDOBJ  *pwo,
    IN ULONG  cj,
    OUT ULONG  *pul)
{
    WNDGDI *WndObjInt = ObjToGDI(pwo, WND);
    BOOL Ret;

    DPRINT("WNDOBJ_bEnum: pwo = 0x%p, cj = %lu, pul = 0x%p\n", pwo, cj, pul);
    Ret = CLIPOBJ_bEnum(WndObjInt->ClientClipObj, cj, pul);

    DPRINT("WNDOBJ_bEnum: Returning %s\n", Ret ? "True" : "False");
    return Ret;
}


/*
 * @implemented
 */
ULONG
APIENTRY
WNDOBJ_cEnumStart(
    IN WNDOBJ  *pwo,
    IN ULONG  iType,
    IN ULONG  iDirection,
    IN ULONG  cLimit)
{
    WNDGDI *WndObjInt = ObjToGDI(pwo, WND);
    ULONG Ret;

    DPRINT("WNDOBJ_cEnumStart: pwo = 0x%p, iType = %lu, iDirection = %lu, cLimit = %lu\n",
           pwo, iType, iDirection, cLimit);

    /* FIXME: Should we enumerate all rectangles or not? */
    Ret = CLIPOBJ_cEnumStart(WndObjInt->ClientClipObj, FALSE, iType, iDirection, cLimit);

    DPRINT("WNDOBJ_cEnumStart: Returning 0x%lx\n", Ret);
    return Ret;
}


/*
 * @implemented
 */
VOID
APIENTRY
WNDOBJ_vSetConsumer(
    IN WNDOBJ  *pwo,
    IN PVOID  pvConsumer)
{
    BOOL Hack;

    DPRINT("WNDOBJ_vSetConsumer: pwo = 0x%p, pvConsumer = 0x%p\n", pwo, pvConsumer);

    Hack = (pwo->pvConsumer == NULL);
    pwo->pvConsumer = pvConsumer;

    /* HACKHACKHACK
     *
     * MSDN says that the WNDOBJCHANGEPROC will be called with the most recent state
     * when a WNDOBJ is created - we do it here because most drivers will need pvConsumer
     * in the callback to identify the WNDOBJ I think.
     *
     *  - blight
     */
    if (Hack)
    {
        IntEngWndCallChangeProc(pwo, WOC_RGN_CLIENT);
        IntEngWndCallChangeProc(pwo, WOC_CHANGED);
        IntEngWndCallChangeProc(pwo, WOC_DRAWN);
    }
}

/* EOF */