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 )
74 if (!(dce = HeapAlloc( GetProcessHeap(), 0, sizeof(DCE) ))) return NULL;
75 if (!(dce->hDC = CreateDCA( "DISPLAY", NULL, NULL, NULL )))
77 HeapFree( GetProcessHeap(), 0, dce );
80 if (!defaultDCstate) defaultDCstate = GetDCState16( dce->hDC );
82 /* store DCE handle in DC hook data field */
84 hookProc = GetProcAddress16( GetModuleHandle16("USER"), (LPCSTR)362 );
85 SetDCHook( dce->hDC, hookProc, (DWORD)dce );
87 dce->hwndCurrent = WIN_GetFullHandle( hWnd );
90 if( type != DCE_CACHE_DC ) /* owned or class DC */
92 dce->DCXflags = DCX_DCEBUSY;
95 LONG style = GetWindowLongW( hWnd, GWL_STYLE );
96 if (style & WS_CLIPCHILDREN) dce->DCXflags |= DCX_CLIPCHILDREN;
97 if (style & WS_CLIPSIBLINGS) dce->DCXflags |= DCX_CLIPSIBLINGS;
99 SetHookFlags16(dce->hDC,DCHF_INVALIDATEVISRGN);
101 else dce->DCXflags = DCX_CACHE | DCX_DCEEMPTY;
104 dce->next = firstDCE;
111 /***********************************************************************
114 DCE* DCE_FreeDCE( DCE *dce )
118 if (!dce) return NULL;
124 while (*ppDCE && (*ppDCE != dce)) ppDCE = &(*ppDCE)->next;
125 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 );
139 /***********************************************************************
142 * Remove owned DCE and reset unreleased cache DCEs.
144 void DCE_FreeWindowDCE( HWND hwnd )
147 WND *pWnd = WIN_FindWndPtr( hwnd );
150 hwnd = pWnd->hwndSelf; /* make it a full handle */
154 if( pDCE->hwndCurrent == hwnd )
156 if( pDCE == pWnd->dce ) /* owned or Class DCE*/
158 if (pWnd->clsStyle & CS_OWNDC) /* owned DCE*/
160 pDCE = DCE_FreeDCE( pDCE );
164 else if( pDCE->DCXflags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN) ) /* Class DCE*/
166 DCE_DeleteClipRgn( pDCE );
167 pDCE->hwndCurrent = 0;
172 if( pDCE->DCXflags & DCX_DCEBUSY ) /* shared cache DCE */
174 /* FIXME: AFAICS we are doing the right thing here so
175 * this should be a WARN. But this is best left as an ERR
176 * because the 'application error' is likely to come from
177 * another part of Wine (i.e. it's our fault after all).
178 * We should change this to WARN when Wine is more stable
181 ERR("[%08x] GetDC() without ReleaseDC()!\n",hwnd);
182 DCE_ReleaseDC( pDCE );
185 pDCE->DCXflags &= DCX_CACHE;
186 pDCE->DCXflags |= DCX_DCEEMPTY;
187 pDCE->hwndCurrent = 0;
193 WIN_ReleaseWndPtr( pWnd );
197 /***********************************************************************
200 static void DCE_DeleteClipRgn( DCE* dce )
202 dce->DCXflags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN | DCX_WINDOWPAINT);
204 if( dce->DCXflags & DCX_KEEPCLIPRGN )
205 dce->DCXflags &= ~DCX_KEEPCLIPRGN;
207 if( dce->hClipRgn > 1 )
208 DeleteObject( dce->hClipRgn );
212 /* make it dirty so that the vis rgn gets recomputed next time */
213 dce->DCXflags |= DCX_DCEDIRTY;
214 SetHookFlags16( dce->hDC, DCHF_INVALIDATEVISRGN );
218 /***********************************************************************
221 static INT DCE_ReleaseDC( DCE* dce )
223 if ((dce->DCXflags & (DCX_DCEEMPTY | DCX_DCEBUSY)) != DCX_DCEBUSY) return 0;
225 /* restore previous visible region */
227 if ((dce->DCXflags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN)) &&
228 (dce->DCXflags & (DCX_CACHE | DCX_WINDOWPAINT)) )
229 DCE_DeleteClipRgn( dce );
231 if (dce->DCXflags & DCX_CACHE)
233 SetDCState16( dce->hDC, defaultDCstate );
234 dce->DCXflags &= ~DCX_DCEBUSY;
235 if (dce->DCXflags & DCX_DCEDIRTY)
237 /* don't keep around invalidated entries
238 * because SetDCState() disables hVisRgn updates
239 * by removing dirty bit. */
241 dce->hwndCurrent = 0;
242 dce->DCXflags &= DCX_CACHE;
243 dce->DCXflags |= DCX_DCEEMPTY;
250 /***********************************************************************
253 * It is called from SetWindowPos() and EVENT_MapNotify - we have to
254 * mark as dirty all busy DCEs for windows that have pWnd->parent as
255 * an ancestor and whose client rect intersects with specified update
256 * rectangle. In addition, pWnd->parent DCEs may need to be updated if
257 * DCX_CLIPCHILDREN flag is set. */
258 BOOL DCE_InvalidateDCE(HWND hwnd, const RECT* pRectUpdate)
260 HWND hwndScope = GetAncestor( hwnd, GA_PARENT );
267 TRACE("scope hwnd = %04x, (%i,%i - %i,%i)\n",
268 hwndScope, pRectUpdate->left,pRectUpdate->top,
269 pRectUpdate->right,pRectUpdate->bottom);
273 /* walk all DCEs and fixup non-empty entries */
275 for (dce = firstDCE; (dce); dce = dce->next)
277 if (dce->DCXflags & DCX_DCEEMPTY) continue;
278 if ((dce->hwndCurrent == hwndScope) && !(dce->DCXflags & DCX_CLIPCHILDREN))
279 continue; /* child window positions don't bother us */
281 /* check if DCE window is within the z-order scope */
283 if (hwndScope == dce->hwndCurrent || IsChild( hwndScope, dce->hwndCurrent ))
285 if (hwnd != dce->hwndCurrent)
287 /* check if the window rectangle intersects this DCE window */
289 GetWindowRect( dce->hwndCurrent, &rect );
290 MapWindowPoints( 0, hwndScope, (POINT *)&rect, 2 );
291 if (!IntersectRect( &rect, &rect, pRectUpdate )) continue;
294 if( !(dce->DCXflags & DCX_DCEBUSY) )
296 /* Don't bother with visible regions of unused DCEs */
298 TRACE("\tpurged %p dce [%04x]\n", dce, dce->hwndCurrent);
299 dce->hwndCurrent = 0;
300 dce->DCXflags &= DCX_CACHE;
301 dce->DCXflags |= DCX_DCEEMPTY;
305 /* Set dirty bits in the hDC and DCE structs */
307 TRACE("\tfixed up %p dce [%04x]\n", dce, dce->hwndCurrent);
308 dce->DCXflags |= DCX_DCEDIRTY;
309 SetHookFlags16(dce->hDC, DCHF_INVALIDATEVISRGN);
319 /***********************************************************************
322 * Translate given region from the wnd client to the DC coordinates
323 * and add it to the clipping region.
325 INT DCE_ExcludeRgn( HDC hDC, HWND hwnd, HRGN hRgn )
330 while (dce && (dce->hDC != hDC)) dce = dce->next;
331 if (!dce) return ERROR;
333 MapWindowPoints( hwnd, dce->hwndCurrent, &pt, 1);
334 if( dce->DCXflags & DCX_WINDOW )
336 WND *wnd = WIN_FindWndPtr(dce->hwndCurrent);
337 pt.x += wnd->rectClient.left - wnd->rectWindow.left;
338 pt.y += wnd->rectClient.top - wnd->rectWindow.top;
339 WIN_ReleaseWndPtr(wnd);
341 OffsetRgn(hRgn, pt.x, pt.y);
343 return ExtSelectClipRgn( hDC, hRgn, RGN_DIFF );
347 /***********************************************************************
350 * Unimplemented flags: DCX_LOCKWINDOWUPDATE
352 * FIXME: Full support for hrgnClip == 1 (alias for entire window).
354 HDC WINAPI GetDCEx( HWND hwnd, HRGN hrgnClip, DWORD flags )
360 BOOL bUpdateVisRgn = TRUE;
361 BOOL bUpdateClipOrigin = FALSE;
364 TRACE("hwnd %04x, hrgnClip %04x, flags %08x\n",
365 hwnd, hrgnClip, (unsigned)flags);
367 if (!hwnd) hwnd = GetDesktopWindow();
368 if (!(wndPtr = WIN_FindWndPtr( hwnd ))) return 0;
369 hwnd = wndPtr->hwndSelf; /* make it a full handle */
373 if (flags & (DCX_WINDOW | DCX_PARENTCLIP)) flags |= DCX_CACHE;
375 if (flags & DCX_USESTYLE)
377 flags &= ~( DCX_CLIPCHILDREN | DCX_CLIPSIBLINGS | DCX_PARENTCLIP);
379 if( wndPtr->dwStyle & WS_CLIPSIBLINGS )
380 flags |= DCX_CLIPSIBLINGS;
382 if ( !(flags & DCX_WINDOW) )
384 if (wndPtr->clsStyle & CS_PARENTDC) flags |= DCX_PARENTCLIP;
386 if (wndPtr->dwStyle & WS_CLIPCHILDREN &&
387 !(wndPtr->dwStyle & WS_MINIMIZE) ) flags |= DCX_CLIPCHILDREN;
388 if (!wndPtr->dce) flags |= DCX_CACHE;
392 if (flags & DCX_WINDOW) flags &= ~DCX_CLIPCHILDREN;
394 parent = GetAncestor( hwnd, GA_PARENT );
395 if (!parent || (parent == GetDesktopWindow()))
396 flags = (flags & ~DCX_PARENTCLIP) | DCX_CLIPSIBLINGS;
398 /* it seems parent clip is ignored when clipping siblings or children */
399 if (flags & (DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN)) flags &= ~DCX_PARENTCLIP;
401 if( flags & DCX_PARENTCLIP )
403 LONG parent_style = GetWindowLongW( parent, GWL_STYLE );
404 if( (wndPtr->dwStyle & WS_VISIBLE) && (parent_style & WS_VISIBLE) )
406 flags &= ~DCX_CLIPCHILDREN;
407 if (parent_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
411 /* find a suitable DCE */
413 dcxFlags = flags & (DCX_PARENTCLIP | DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN |
414 DCX_CACHE | DCX_WINDOW);
416 if (flags & DCX_CACHE)
421 dceEmpty = dceUnused = NULL;
423 /* Strategy: First, we attempt to find a non-empty but unused DCE with
424 * compatible flags. Next, we look for an empty entry. If the cache is
425 * full we have to purge one of the unused entries.
428 for (dce = firstDCE; (dce); dce = dce->next)
430 if ((dce->DCXflags & (DCX_CACHE | DCX_DCEBUSY)) == DCX_CACHE )
434 if (dce->DCXflags & DCX_DCEEMPTY)
437 if ((dce->hwndCurrent == hwnd) &&
438 ((dce->DCXflags & (DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN |
439 DCX_CACHE | DCX_WINDOW | DCX_PARENTCLIP)) == dcxFlags))
441 TRACE("\tfound valid %08x dce [%04x], flags %08x\n",
442 (unsigned)dce, hwnd, (unsigned)dcxFlags );
443 bUpdateVisRgn = FALSE;
444 bUpdateClipOrigin = TRUE;
450 if (!dce) dce = (dceEmpty) ? dceEmpty : dceUnused;
452 /* if there's no dce empty or unused, allocate a new one */
455 dce = DCE_AllocDCE( 0, DCE_CACHE_DC );
461 if (dce && dce->hwndCurrent == hwnd)
463 TRACE("\tskipping hVisRgn update\n");
464 bUpdateVisRgn = FALSE; /* updated automatically, via DCHook() */
473 if (!(flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN))) hrgnClip = 0;
475 if (((flags ^ dce->DCXflags) & (DCX_INTERSECTRGN | DCX_EXCLUDERGN)) &&
476 (dce->hClipRgn != hrgnClip))
478 /* if the extra clip region has changed, get rid of the old one */
479 DCE_DeleteClipRgn( dce );
482 dce->hwndCurrent = hwnd;
483 dce->hClipRgn = hrgnClip;
484 dce->DCXflags = flags & (DCX_PARENTCLIP | DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN |
485 DCX_CACHE | DCX_WINDOW | DCX_WINDOWPAINT |
486 DCX_KEEPCLIPRGN | DCX_INTERSECTRGN | DCX_EXCLUDERGN);
487 dce->DCXflags |= DCX_DCEBUSY;
488 dce->DCXflags &= ~DCX_DCEDIRTY;
491 if (bUpdateVisRgn) SetHookFlags16( hdc, DCHF_INVALIDATEVISRGN ); /* force update */
493 if (!USER_Driver.pGetDC( hwnd, hdc, hrgnClip, flags )) hdc = 0;
495 TRACE("(%04x,%04x,0x%lx): returning %04x\n", hwnd, hrgnClip, flags, hdc);
497 WIN_ReleaseWndPtr(wndPtr);
502 /***********************************************************************
509 HWND hwnd /* [in] handle of window */
512 return GetDCEx( 0, 0, DCX_CACHE | DCX_WINDOW );
513 return GetDCEx( hwnd, 0, DCX_USESTYLE );
517 /***********************************************************************
518 * GetWindowDC (USER32.@)
520 HDC WINAPI GetWindowDC( HWND hwnd )
522 return GetDCEx( hwnd, 0, DCX_USESTYLE | DCX_WINDOW );
526 /***********************************************************************
527 * ReleaseDC (USER32.@)
533 INT WINAPI ReleaseDC(
534 HWND hwnd /* [in] Handle of window - ignored */,
535 HDC hdc /* [in] Handle of device context */
543 TRACE("%04x %04x\n", hwnd, hdc );
545 while (dce && (dce->hDC != hdc)) dce = dce->next;
548 if ( dce->DCXflags & DCX_DCEBUSY )
549 nRet = DCE_ReleaseDC( dce );
556 /***********************************************************************
559 * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
561 BOOL16 WINAPI DCHook16( HDC16 hDC, WORD code, DWORD data, LPARAM lParam )
564 DCE *dce = (DCE *)data;
566 TRACE("hDC = %04x, %i\n", hDC, code);
569 assert(dce->hDC == hDC);
571 /* Grab the windows lock before doing anything else */
576 case DCHC_INVALIDVISRGN:
577 /* GDI code calls this when it detects that the
578 * DC is dirty (usually after SetHookFlags()). This
579 * means that we have to recompute the visible region.
581 if( dce->DCXflags & DCX_DCEBUSY )
583 /* Dirty bit has been cleared by caller, set it again so that
584 * pGetDC recomputes the visible region. */
585 SetHookFlags16( dce->hDC, DCHF_INVALIDATEVISRGN );
586 USER_Driver.pGetDC( dce->hwndCurrent, dce->hDC, dce->hClipRgn, dce->DCXflags );
588 else /* non-fatal but shouldn't happen */
589 WARN("DC is not in use!\n");
594 * Windows will not let you delete a DC that is busy
595 * (between GetDC and ReleaseDC)
598 if ( dce->DCXflags & DCX_DCEBUSY )
600 WARN("Application trying to delete a busy DC\n");
603 else DCE_FreeDCE( dce );
607 FIXME("unknown code\n");
610 USER_Unlock(); /* Release the wnd lock */
615 /**********************************************************************
616 * WindowFromDC (USER32.@)
618 HWND WINAPI WindowFromDC( HDC hDC )
626 while (dce && (dce->hDC != hDC)) dce = dce->next;
628 hwnd = dce ? dce->hwndCurrent : 0;
635 /***********************************************************************
636 * LockWindowUpdate (USER32.@)
638 BOOL WINAPI LockWindowUpdate( HWND hwnd )
640 FIXME("(%x), stub!\n",hwnd);