4 * Copyright 1993 Alexandre Julliard
5 * 1996,1997 Alex Korobka
8 * Note: Visible regions of CS_OWNDC/CS_CLASSDC window DCs
9 * have to be updated dynamically.
13 * DCX_DCEEMPTY - dce is uninitialized
14 * DCX_DCEBUSY - dce is in use
15 * DCX_DCEDIRTY - ReleaseDC() should wipe instead of caching
16 * DCX_KEEPCLIPRGN - ReleaseDC() should not delete the clipping region
17 * DCX_WINDOWPAINT - BeginPaint() is in effect
26 #include "debugtools.h"
29 #include "wine/winbase16.h"
30 #include "wine/winuser16.h"
32 DEFAULT_DEBUG_CHANNEL(dc
);
35 static HDC defaultDCstate
;
37 static void DCE_DeleteClipRgn( DCE
* );
38 static INT
DCE_ReleaseDC( DCE
* );
41 /***********************************************************************
44 static void DCE_DumpCache(void)
54 DPRINTF("\t[0x%08x] hWnd 0x%04x, dcx %08x, %s %s\n",
55 (unsigned)dce
, dce
->hwndCurrent
, (unsigned)dce
->DCXflags
,
56 (dce
->DCXflags
& DCX_CACHE
) ? "Cache" : "Owned",
57 (dce
->DCXflags
& DCX_DCEBUSY
) ? "InUse" : "" );
64 /***********************************************************************
69 DCE
*DCE_AllocDCE( HWND hWnd
, DCE_TYPE type
)
75 if (!(dce
= HeapAlloc( GetProcessHeap(), 0, sizeof(DCE
) ))) return NULL
;
76 if (!(dce
->hDC
= CreateDCA( "DISPLAY", NULL
, NULL
, NULL
)))
78 HeapFree( GetProcessHeap(), 0, dce
);
81 if (!defaultDCstate
) defaultDCstate
= GetDCState16( dce
->hDC
);
83 wnd
= WIN_FindWndPtr(hWnd
);
85 /* store DCE handle in DC hook data field */
87 hookProc
= GetProcAddress16( GetModuleHandle16("USER"), (LPCSTR
)362 );
88 SetDCHook( dce
->hDC
, hookProc
, (DWORD
)dce
);
90 dce
->hwndCurrent
= hWnd
;
95 if( type
!= DCE_CACHE_DC
) /* owned or class DC */
97 dce
->DCXflags
= DCX_DCEBUSY
;
100 if( wnd
->dwStyle
& WS_CLIPCHILDREN
) dce
->DCXflags
|= DCX_CLIPCHILDREN
;
101 if( wnd
->dwStyle
& WS_CLIPSIBLINGS
) dce
->DCXflags
|= DCX_CLIPSIBLINGS
;
103 SetHookFlags16(dce
->hDC
,DCHF_INVALIDATEVISRGN
);
105 else dce
->DCXflags
= DCX_CACHE
| DCX_DCEEMPTY
;
107 WIN_ReleaseWndPtr(wnd
);
113 /***********************************************************************
116 DCE
* DCE_FreeDCE( DCE
*dce
)
120 if (!dce
) return NULL
;
126 while (*ppDCE
&& (*ppDCE
!= dce
)) ppDCE
= &(*ppDCE
)->next
;
127 if (*ppDCE
== dce
) *ppDCE
= dce
->next
;
129 SetDCHook(dce
->hDC
, NULL
, 0L);
131 DeleteDC( dce
->hDC
);
132 if( dce
->hClipRgn
&& !(dce
->DCXflags
& DCX_KEEPCLIPRGN
) )
133 DeleteObject(dce
->hClipRgn
);
134 HeapFree( GetProcessHeap(), 0, dce
);
141 /***********************************************************************
144 * Remove owned DCE and reset unreleased cache DCEs.
146 void DCE_FreeWindowDCE( WND
* pWnd
)
155 if( pDCE
->hwndCurrent
== pWnd
->hwndSelf
)
157 if( pDCE
== pWnd
->dce
) /* owned or Class DCE*/
159 if (pWnd
->clsStyle
& CS_OWNDC
) /* owned DCE*/
161 pDCE
= DCE_FreeDCE( pDCE
);
165 else if( pDCE
->DCXflags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
) ) /* Class DCE*/
167 DCE_DeleteClipRgn( pDCE
);
168 pDCE
->hwndCurrent
= 0;
173 if( pDCE
->DCXflags
& DCX_DCEBUSY
) /* shared cache DCE */
175 /* FIXME: AFAICS we are doing the right thing here so
176 * this should be a WARN. But this is best left as an ERR
177 * because the 'application error' is likely to come from
178 * another part of Wine (i.e. it's our fault after all).
179 * We should change this to WARN when Wine is more stable
182 ERR("[%04x] GetDC() without ReleaseDC()!\n",
184 DCE_ReleaseDC( pDCE
);
187 pDCE
->DCXflags
&= DCX_CACHE
;
188 pDCE
->DCXflags
|= DCX_DCEEMPTY
;
189 pDCE
->hwndCurrent
= 0;
199 /***********************************************************************
202 static void DCE_DeleteClipRgn( DCE
* dce
)
204 dce
->DCXflags
&= ~(DCX_EXCLUDERGN
| DCX_INTERSECTRGN
| DCX_WINDOWPAINT
);
206 if( dce
->DCXflags
& DCX_KEEPCLIPRGN
)
207 dce
->DCXflags
&= ~DCX_KEEPCLIPRGN
;
209 if( dce
->hClipRgn
> 1 )
210 DeleteObject( dce
->hClipRgn
);
214 /* make it dirty so that the vis rgn gets recomputed next time */
215 dce
->DCXflags
|= DCX_DCEDIRTY
;
216 SetHookFlags16( dce
->hDC
, DCHF_INVALIDATEVISRGN
);
220 /***********************************************************************
223 static INT
DCE_ReleaseDC( DCE
* dce
)
225 if ((dce
->DCXflags
& (DCX_DCEEMPTY
| DCX_DCEBUSY
)) != DCX_DCEBUSY
) return 0;
227 /* restore previous visible region */
229 if ((dce
->DCXflags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
)) &&
230 (dce
->DCXflags
& (DCX_CACHE
| DCX_WINDOWPAINT
)) )
231 DCE_DeleteClipRgn( dce
);
233 if (dce
->DCXflags
& DCX_CACHE
)
235 SetDCState16( dce
->hDC
, defaultDCstate
);
236 dce
->DCXflags
&= ~DCX_DCEBUSY
;
237 if (dce
->DCXflags
& DCX_DCEDIRTY
)
239 /* don't keep around invalidated entries
240 * because SetDCState() disables hVisRgn updates
241 * by removing dirty bit. */
243 dce
->hwndCurrent
= 0;
244 dce
->DCXflags
&= DCX_CACHE
;
245 dce
->DCXflags
|= DCX_DCEEMPTY
;
252 /***********************************************************************
255 * It is called from SetWindowPos() and EVENT_MapNotify - we have to
256 * mark as dirty all busy DCEs for windows that have pWnd->parent as
257 * an ancestor and whose client rect intersects with specified update
258 * rectangle. In addition, pWnd->parent DCEs may need to be updated if
259 * DCX_CLIPCHILDREN flag is set. */
260 BOOL
DCE_InvalidateDCE(WND
* pWnd
, const RECT
* pRectUpdate
)
262 WND
* wndScope
= WIN_LockWndPtr(pWnd
->parent
);
269 TRACE("scope hwnd = %04x, (%i,%i - %i,%i)\n",
270 wndScope
->hwndSelf
, pRectUpdate
->left
,pRectUpdate
->top
,
271 pRectUpdate
->right
,pRectUpdate
->bottom
);
275 /* walk all DCEs and fixup non-empty entries */
277 for (dce
= firstDCE
; (dce
); dce
= dce
->next
)
279 if( !(dce
->DCXflags
& DCX_DCEEMPTY
) )
281 WND
* wndCurrent
= WIN_FindWndPtr(dce
->hwndCurrent
);
286 INT xoffset
= 0, yoffset
= 0;
288 if( (wndCurrent
== wndScope
) && !(dce
->DCXflags
& DCX_CLIPCHILDREN
) )
290 /* child window positions don't bother us */
291 WIN_ReleaseWndPtr(wndCurrent
);
295 /* check if DCE window is within the z-order scope */
297 for( wnd
= WIN_LockWndPtr(wndCurrent
); wnd
; WIN_UpdateWndPtr(&wnd
,wnd
->parent
))
299 if( wnd
== wndScope
)
303 wndRect
= wndCurrent
->rectWindow
;
305 OffsetRect( &wndRect
, xoffset
- wndCurrent
->rectClient
.left
,
306 yoffset
- wndCurrent
->rectClient
.top
);
308 if (pWnd
== wndCurrent
||
309 IntersectRect( &wndRect
, &wndRect
, pRectUpdate
))
311 if( !(dce
->DCXflags
& DCX_DCEBUSY
) )
313 /* Don't bother with visible regions of unused DCEs */
315 TRACE("\tpurged %08x dce [%04x]\n",
316 (unsigned)dce
, wndCurrent
->hwndSelf
);
318 dce
->hwndCurrent
= 0;
319 dce
->DCXflags
&= DCX_CACHE
;
320 dce
->DCXflags
|= DCX_DCEEMPTY
;
324 /* Set dirty bits in the hDC and DCE structs */
326 TRACE("\tfixed up %08x dce [%04x]\n",
327 (unsigned)dce
, wndCurrent
->hwndSelf
);
329 dce
->DCXflags
|= DCX_DCEDIRTY
;
330 SetHookFlags16(dce
->hDC
, DCHF_INVALIDATEVISRGN
);
334 WIN_ReleaseWndPtr(wnd
);
337 xoffset
+= wnd
->rectClient
.left
;
338 yoffset
+= wnd
->rectClient
.top
;
341 WIN_ReleaseWndPtr(wndCurrent
);
344 WIN_ReleaseWndPtr(wndScope
);
350 /***********************************************************************
353 * Translate given region from the wnd client to the DC coordinates
354 * and add it to the clipping region.
356 INT
DCE_ExcludeRgn( HDC hDC
, WND
* wnd
, HRGN hRgn
)
361 while (dce
&& (dce
->hDC
!= hDC
)) dce
= dce
->next
;
364 MapWindowPoints( wnd
->hwndSelf
, dce
->hwndCurrent
, &pt
, 1);
365 if( dce
->DCXflags
& DCX_WINDOW
)
367 wnd
= WIN_FindWndPtr(dce
->hwndCurrent
);
368 pt
.x
+= wnd
->rectClient
.left
- wnd
->rectWindow
.left
;
369 pt
.y
+= wnd
->rectClient
.top
- wnd
->rectWindow
.top
;
370 WIN_ReleaseWndPtr(wnd
);
374 OffsetRgn(hRgn
, pt
.x
, pt
.y
);
376 return ExtSelectClipRgn( hDC
, hRgn
, RGN_DIFF
);
380 /***********************************************************************
383 HDC16 WINAPI
GetDCEx16( HWND16 hwnd
, HRGN16 hrgnClip
, DWORD flags
)
385 return (HDC16
)GetDCEx( hwnd
, hrgnClip
, flags
);
389 /***********************************************************************
392 * Unimplemented flags: DCX_LOCKWINDOWUPDATE
394 * FIXME: Full support for hrgnClip == 1 (alias for entire window).
396 HDC WINAPI
GetDCEx( HWND hwnd
, HRGN hrgnClip
, DWORD flags
)
402 BOOL bUpdateVisRgn
= TRUE
;
403 BOOL bUpdateClipOrigin
= FALSE
;
405 TRACE("hwnd %04x, hrgnClip %04x, flags %08x\n",
406 hwnd
, hrgnClip
, (unsigned)flags
);
408 if (!hwnd
) hwnd
= GetDesktopWindow();
409 if (!(wndPtr
= WIN_FindWndPtr( hwnd
))) return 0;
413 if (!wndPtr
->dce
) flags
|= DCX_CACHE
;
415 if (flags
& DCX_USESTYLE
)
417 flags
&= ~( DCX_CLIPCHILDREN
| DCX_CLIPSIBLINGS
| DCX_PARENTCLIP
);
419 if( wndPtr
->dwStyle
& WS_CLIPSIBLINGS
)
420 flags
|= DCX_CLIPSIBLINGS
;
422 if ( !(flags
& DCX_WINDOW
) )
424 if (wndPtr
->clsStyle
& CS_PARENTDC
) flags
|= DCX_PARENTCLIP
;
426 if (wndPtr
->dwStyle
& WS_CLIPCHILDREN
&&
427 !(wndPtr
->dwStyle
& WS_MINIMIZE
) ) flags
|= DCX_CLIPCHILDREN
;
429 else flags
|= DCX_CACHE
;
432 if (flags
& DCX_WINDOW
)
433 flags
= (flags
& ~DCX_CLIPCHILDREN
) | DCX_CACHE
;
435 if (!wndPtr
->parent
|| (wndPtr
->parent
->hwndSelf
== GetDesktopWindow()))
436 flags
= (flags
& ~DCX_PARENTCLIP
) | DCX_CLIPSIBLINGS
;
437 else if( flags
& DCX_PARENTCLIP
)
440 if( !(flags
& (DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
)) )
441 if( (wndPtr
->dwStyle
& WS_VISIBLE
) && (wndPtr
->parent
->dwStyle
& WS_VISIBLE
) )
443 flags
&= ~DCX_CLIPCHILDREN
;
444 if( wndPtr
->parent
->dwStyle
& WS_CLIPSIBLINGS
)
445 flags
|= DCX_CLIPSIBLINGS
;
449 /* find a suitable DCE */
451 dcxFlags
= flags
& (DCX_PARENTCLIP
| DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
452 DCX_CACHE
| DCX_WINDOW
);
454 if (flags
& DCX_CACHE
)
459 dceEmpty
= dceUnused
= NULL
;
461 /* Strategy: First, we attempt to find a non-empty but unused DCE with
462 * compatible flags. Next, we look for an empty entry. If the cache is
463 * full we have to purge one of the unused entries.
466 for (dce
= firstDCE
; (dce
); dce
= dce
->next
)
468 if ((dce
->DCXflags
& (DCX_CACHE
| DCX_DCEBUSY
)) == DCX_CACHE
)
472 if (dce
->DCXflags
& DCX_DCEEMPTY
)
475 if ((dce
->hwndCurrent
== hwnd
) &&
476 ((dce
->DCXflags
& (DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
477 DCX_CACHE
| DCX_WINDOW
| DCX_PARENTCLIP
)) == dcxFlags
))
479 TRACE("\tfound valid %08x dce [%04x], flags %08x\n",
480 (unsigned)dce
, hwnd
, (unsigned)dcxFlags
);
481 bUpdateVisRgn
= FALSE
;
482 bUpdateClipOrigin
= TRUE
;
488 if (!dce
) dce
= (dceEmpty
) ? dceEmpty
: dceUnused
;
490 /* if there's no dce empty or unused, allocate a new one */
493 dce
= DCE_AllocDCE( 0, DCE_CACHE_DC
);
499 if( dce
->hwndCurrent
== hwnd
)
501 TRACE("\tskipping hVisRgn update\n");
502 bUpdateVisRgn
= FALSE
; /* updated automatically, via DCHook() */
511 if (!(flags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
))) hrgnClip
= 0;
513 if (((flags
^ dce
->DCXflags
) & (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
)) &&
514 (dce
->hClipRgn
!= hrgnClip
))
516 /* if the extra clip region has changed, get rid of the old one */
517 DCE_DeleteClipRgn( dce
);
520 dce
->hwndCurrent
= hwnd
;
521 dce
->hClipRgn
= hrgnClip
;
522 dce
->DCXflags
= flags
& (DCX_PARENTCLIP
| DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
523 DCX_CACHE
| DCX_WINDOW
| DCX_WINDOWPAINT
|
524 DCX_KEEPCLIPRGN
| DCX_INTERSECTRGN
| DCX_EXCLUDERGN
);
525 dce
->DCXflags
|= DCX_DCEBUSY
;
526 dce
->DCXflags
&= ~DCX_DCEDIRTY
;
529 if (bUpdateVisRgn
) SetHookFlags16( hdc
, DCHF_INVALIDATEVISRGN
); /* force update */
531 if (!USER_Driver
.pGetDC( hwnd
, hdc
, hrgnClip
, flags
)) hdc
= 0;
533 TRACE("(%04x,%04x,0x%lx): returning %04x\n", hwnd
, hrgnClip
, flags
, hdc
);
535 WIN_ReleaseWndPtr(wndPtr
);
540 /***********************************************************************
543 HDC16 WINAPI
GetDC16( HWND16 hwnd
)
545 return (HDC16
)GetDC( hwnd
);
549 /***********************************************************************
556 HWND hwnd
/* [in] handle of window */
559 return GetDCEx( 0, 0, DCX_CACHE
| DCX_WINDOW
);
560 return GetDCEx( hwnd
, 0, DCX_USESTYLE
);
564 /***********************************************************************
565 * GetWindowDC (USER.67)
567 HDC16 WINAPI
GetWindowDC16( HWND16 hwnd
)
569 return GetDCEx16( hwnd
, 0, DCX_USESTYLE
| DCX_WINDOW
);
573 /***********************************************************************
574 * GetWindowDC (USER32.@)
576 HDC WINAPI
GetWindowDC( HWND hwnd
)
578 return GetDCEx( hwnd
, 0, DCX_USESTYLE
| DCX_WINDOW
);
582 /***********************************************************************
583 * ReleaseDC (USER.68)
585 INT16 WINAPI
ReleaseDC16( HWND16 hwnd
, HDC16 hdc
)
587 return (INT16
)ReleaseDC( hwnd
, hdc
);
591 /***********************************************************************
592 * ReleaseDC (USER32.@)
598 INT WINAPI
ReleaseDC(
599 HWND hwnd
/* [in] Handle of window - ignored */,
600 HDC hdc
/* [in] Handle of device context */
608 TRACE("%04x %04x\n", hwnd
, hdc
);
610 while (dce
&& (dce
->hDC
!= hdc
)) dce
= dce
->next
;
613 if ( dce
->DCXflags
& DCX_DCEBUSY
)
614 nRet
= DCE_ReleaseDC( dce
);
621 /***********************************************************************
624 * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
626 BOOL16 WINAPI
DCHook16( HDC16 hDC
, WORD code
, DWORD data
, LPARAM lParam
)
629 DCE
*dce
= (DCE
*)data
;
631 TRACE("hDC = %04x, %i\n", hDC
, code
);
634 assert(dce
->hDC
== hDC
);
636 /* Grab the windows lock before doing anything else */
641 case DCHC_INVALIDVISRGN
:
642 /* GDI code calls this when it detects that the
643 * DC is dirty (usually after SetHookFlags()). This
644 * means that we have to recompute the visible region.
646 if( dce
->DCXflags
& DCX_DCEBUSY
)
648 /* Dirty bit has been cleared by caller, set it again so that
649 * pGetDC recomputes the visible region. */
650 SetHookFlags16( dce
->hDC
, DCHF_INVALIDATEVISRGN
);
651 USER_Driver
.pGetDC( dce
->hwndCurrent
, dce
->hDC
, dce
->hClipRgn
, dce
->DCXflags
);
653 else /* non-fatal but shouldn't happen */
654 WARN("DC is not in use!\n");
659 * Windows will not let you delete a DC that is busy
660 * (between GetDC and ReleaseDC)
663 if ( dce
->DCXflags
& DCX_DCEBUSY
)
665 WARN("Application trying to delete a busy DC\n");
671 FIXME("unknown code\n");
674 WIN_UnlockWnds(); /* Release the wnd lock */
679 /**********************************************************************
680 * WindowFromDC (USER.117)
682 HWND16 WINAPI
WindowFromDC16( HDC16 hDC
)
684 return (HWND16
)WindowFromDC( hDC
);
688 /**********************************************************************
689 * WindowFromDC (USER32.@)
691 HWND WINAPI
WindowFromDC( HDC hDC
)
699 while (dce
&& (dce
->hDC
!= hDC
)) dce
= dce
->next
;
701 hwnd
= dce
? dce
->hwndCurrent
: 0;
708 /***********************************************************************
709 * LockWindowUpdate (USER.294)
711 BOOL16 WINAPI
LockWindowUpdate16( HWND16 hwnd
)
713 return LockWindowUpdate( hwnd
);
716 /***********************************************************************
717 * LockWindowUpdate (USER32.@)
719 BOOL WINAPI
LockWindowUpdate( HWND hwnd
)
721 FIXME("(%x), stub!\n",hwnd
);