4 * Copyright 1993 Alexandre Julliard
5 * 1996,1997 Alex Korobka
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * Note: Visible regions of CS_OWNDC/CS_CLASSDC window DCs
23 * have to be updated dynamically.
27 * DCX_DCEEMPTY - dce is uninitialized
28 * DCX_DCEBUSY - dce is in use
29 * DCX_DCEDIRTY - ReleaseDC() should wipe instead of caching
30 * DCX_KEEPCLIPRGN - ReleaseDC() should not delete the clipping region
31 * DCX_WINDOWPAINT - BeginPaint() is in effect
38 #include "wine/debug.h"
42 #include "wine/winbase16.h"
43 #include "wine/winuser16.h"
45 WINE_DEFAULT_DEBUG_CHANNEL(dc
);
48 static HDC16 defaultDCstate
;
50 static void DCE_DeleteClipRgn( DCE
* );
51 static INT
DCE_ReleaseDC( DCE
* );
54 /***********************************************************************
57 static void DCE_DumpCache(void)
67 DPRINTF("\t[0x%08x] hWnd %p, dcx %08x, %s %s\n",
68 (unsigned)dce
, dce
->hwndCurrent
, (unsigned)dce
->DCXflags
,
69 (dce
->DCXflags
& DCX_CACHE
) ? "Cache" : "Owned",
70 (dce
->DCXflags
& DCX_DCEBUSY
) ? "InUse" : "" );
77 /***********************************************************************
82 DCE
*DCE_AllocDCE( HWND hWnd
, DCE_TYPE type
)
86 if (!(dce
= HeapAlloc( GetProcessHeap(), 0, sizeof(DCE
) ))) return NULL
;
87 if (!(dce
->hDC
= CreateDCA( "DISPLAY", NULL
, NULL
, NULL
)))
89 HeapFree( GetProcessHeap(), 0, dce
);
92 if (!defaultDCstate
) defaultDCstate
= GetDCState16( HDC_16(dce
->hDC
) );
94 /* store DCE handle in DC hook data field */
96 SetDCHook( dce
->hDC
, DCHook16
, (DWORD
)dce
);
98 dce
->hwndCurrent
= WIN_GetFullHandle( hWnd
);
101 if( type
!= DCE_CACHE_DC
) /* owned or class DC */
103 dce
->DCXflags
= DCX_DCEBUSY
;
106 LONG style
= GetWindowLongW( hWnd
, GWL_STYLE
);
107 if (style
& WS_CLIPCHILDREN
) dce
->DCXflags
|= DCX_CLIPCHILDREN
;
108 if (style
& WS_CLIPSIBLINGS
) dce
->DCXflags
|= DCX_CLIPSIBLINGS
;
110 SetHookFlags16( HDC_16(dce
->hDC
), DCHF_INVALIDATEVISRGN
);
112 else dce
->DCXflags
= DCX_CACHE
| DCX_DCEEMPTY
;
115 dce
->next
= firstDCE
;
122 /***********************************************************************
125 DCE
* DCE_FreeDCE( DCE
*dce
)
129 if (!dce
) return NULL
;
135 while (*ppDCE
&& (*ppDCE
!= dce
)) ppDCE
= &(*ppDCE
)->next
;
136 if (*ppDCE
== dce
) *ppDCE
= dce
->next
;
140 SetDCHook(dce
->hDC
, NULL
, 0L);
142 DeleteDC( dce
->hDC
);
143 if( dce
->hClipRgn
&& !(dce
->DCXflags
& DCX_KEEPCLIPRGN
) )
144 DeleteObject(dce
->hClipRgn
);
145 HeapFree( GetProcessHeap(), 0, dce
);
150 /***********************************************************************
153 * Remove owned DCE and reset unreleased cache DCEs.
155 void DCE_FreeWindowDCE( HWND hwnd
)
158 WND
*pWnd
= WIN_GetPtr( hwnd
);
163 if( pDCE
->hwndCurrent
== hwnd
)
165 if( pDCE
== pWnd
->dce
) /* owned or Class DCE*/
167 if (pWnd
->clsStyle
& CS_OWNDC
) /* owned DCE*/
169 pDCE
= DCE_FreeDCE( pDCE
);
173 else if( pDCE
->DCXflags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
) ) /* Class DCE*/
175 if (USER_Driver
.pReleaseDC
)
176 USER_Driver
.pReleaseDC( pDCE
->hwndCurrent
, pDCE
->hDC
);
177 DCE_DeleteClipRgn( pDCE
);
178 pDCE
->hwndCurrent
= 0;
183 if( pDCE
->DCXflags
& DCX_DCEBUSY
) /* shared cache DCE */
185 /* FIXME: AFAICS we are doing the right thing here so
186 * this should be a WARN. But this is best left as an ERR
187 * because the 'application error' is likely to come from
188 * another part of Wine (i.e. it's our fault after all).
189 * We should change this to WARN when Wine is more stable
192 ERR("[%p] GetDC() without ReleaseDC()!\n",hwnd
);
193 DCE_ReleaseDC( pDCE
);
196 if (pDCE
->hwndCurrent
&& USER_Driver
.pReleaseDC
)
197 USER_Driver
.pReleaseDC( pDCE
->hwndCurrent
, pDCE
->hDC
);
198 pDCE
->DCXflags
&= DCX_CACHE
;
199 pDCE
->DCXflags
|= DCX_DCEEMPTY
;
200 pDCE
->hwndCurrent
= 0;
205 WIN_ReleasePtr( pWnd
);
209 /***********************************************************************
212 static void DCE_DeleteClipRgn( DCE
* dce
)
214 dce
->DCXflags
&= ~(DCX_EXCLUDERGN
| DCX_INTERSECTRGN
| DCX_WINDOWPAINT
);
216 if( dce
->DCXflags
& DCX_KEEPCLIPRGN
)
217 dce
->DCXflags
&= ~DCX_KEEPCLIPRGN
;
219 if( dce
->hClipRgn
> (HRGN
)1 )
220 DeleteObject( dce
->hClipRgn
);
224 /* make it dirty so that the vis rgn gets recomputed next time */
225 dce
->DCXflags
|= DCX_DCEDIRTY
;
226 SetHookFlags16( HDC_16(dce
->hDC
), DCHF_INVALIDATEVISRGN
);
230 /***********************************************************************
233 static INT
DCE_ReleaseDC( DCE
* dce
)
235 if ((dce
->DCXflags
& (DCX_DCEEMPTY
| DCX_DCEBUSY
)) != DCX_DCEBUSY
) return 0;
237 /* restore previous visible region */
239 if ((dce
->DCXflags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
)) &&
240 (dce
->DCXflags
& (DCX_CACHE
| DCX_WINDOWPAINT
)) )
241 DCE_DeleteClipRgn( dce
);
243 if (dce
->DCXflags
& DCX_CACHE
)
245 /* make the DC clean so that SetDCState doesn't try to update the vis rgn */
246 SetHookFlags16( HDC_16(dce
->hDC
), DCHF_VALIDATEVISRGN
);
247 SetDCState16( HDC_16(dce
->hDC
), defaultDCstate
);
248 dce
->DCXflags
&= ~DCX_DCEBUSY
;
249 if (dce
->DCXflags
& DCX_DCEDIRTY
)
251 /* don't keep around invalidated entries
252 * because SetDCState() disables hVisRgn updates
253 * by removing dirty bit. */
254 if (dce
->hwndCurrent
&& USER_Driver
.pReleaseDC
)
255 USER_Driver
.pReleaseDC( dce
->hwndCurrent
, dce
->hDC
);
256 dce
->hwndCurrent
= 0;
257 dce
->DCXflags
&= DCX_CACHE
;
258 dce
->DCXflags
|= DCX_DCEEMPTY
;
265 /***********************************************************************
268 * It is called from SetWindowPos() and EVENT_MapNotify - we have to
269 * mark as dirty all busy DCEs for windows that have pWnd->parent as
270 * an ancestor and whose client rect intersects with specified update
271 * rectangle. In addition, pWnd->parent DCEs may need to be updated if
272 * DCX_CLIPCHILDREN flag is set. */
273 BOOL
DCE_InvalidateDCE(HWND hwnd
, const RECT
* pRectUpdate
)
275 HWND hwndScope
= GetAncestor( hwnd
, GA_PARENT
);
282 TRACE("scope hwnd = %p, (%ld,%ld - %ld,%ld)\n",
283 hwndScope
, pRectUpdate
->left
,pRectUpdate
->top
,
284 pRectUpdate
->right
,pRectUpdate
->bottom
);
288 /* walk all DCEs and fixup non-empty entries */
290 for (dce
= firstDCE
; (dce
); dce
= dce
->next
)
292 if (dce
->DCXflags
& DCX_DCEEMPTY
) continue;
293 if ((dce
->hwndCurrent
== hwndScope
) && !(dce
->DCXflags
& DCX_CLIPCHILDREN
))
294 continue; /* child window positions don't bother us */
296 /* check if DCE window is within the z-order scope */
298 if (hwndScope
== dce
->hwndCurrent
|| IsChild( hwndScope
, dce
->hwndCurrent
))
300 if (hwnd
!= dce
->hwndCurrent
)
302 /* check if the window rectangle intersects this DCE window */
304 GetWindowRect( dce
->hwndCurrent
, &rect
);
305 MapWindowPoints( 0, hwndScope
, (POINT
*)&rect
, 2 );
306 if (!IntersectRect( &rect
, &rect
, pRectUpdate
)) continue;
309 if( !(dce
->DCXflags
& DCX_DCEBUSY
) )
311 /* Don't bother with visible regions of unused DCEs */
313 TRACE("\tpurged %p dce [%p]\n", dce
, dce
->hwndCurrent
);
314 if (dce
->hwndCurrent
&& USER_Driver
.pReleaseDC
)
315 USER_Driver
.pReleaseDC( dce
->hwndCurrent
, dce
->hDC
);
316 dce
->hwndCurrent
= 0;
317 dce
->DCXflags
&= DCX_CACHE
;
318 dce
->DCXflags
|= DCX_DCEEMPTY
;
322 /* Set dirty bits in the hDC and DCE structs */
324 TRACE("\tfixed up %p dce [%p]\n", dce
, dce
->hwndCurrent
);
325 dce
->DCXflags
|= DCX_DCEDIRTY
;
326 SetHookFlags16( HDC_16(dce
->hDC
), DCHF_INVALIDATEVISRGN
);
336 /***********************************************************************
339 * Translate given region from the wnd client to the DC coordinates
340 * and add it to the clipping region.
342 INT
DCE_ExcludeRgn( HDC hDC
, HWND hwnd
, HRGN hRgn
)
347 while (dce
&& (dce
->hDC
!= hDC
)) dce
= dce
->next
;
348 if (!dce
) return ERROR
;
350 MapWindowPoints( hwnd
, dce
->hwndCurrent
, &pt
, 1);
351 if( dce
->DCXflags
& DCX_WINDOW
)
353 WND
*wnd
= WIN_FindWndPtr(dce
->hwndCurrent
);
354 pt
.x
+= wnd
->rectClient
.left
- wnd
->rectWindow
.left
;
355 pt
.y
+= wnd
->rectClient
.top
- wnd
->rectWindow
.top
;
356 WIN_ReleaseWndPtr(wnd
);
358 OffsetRgn(hRgn
, pt
.x
, pt
.y
);
360 return ExtSelectClipRgn( hDC
, hRgn
, RGN_DIFF
);
364 /***********************************************************************
367 * Unimplemented flags: DCX_LOCKWINDOWUPDATE
369 * FIXME: Full support for hrgnClip == 1 (alias for entire window).
371 HDC WINAPI
GetDCEx( HWND hwnd
, HRGN hrgnClip
, DWORD flags
)
377 BOOL bUpdateVisRgn
= TRUE
;
378 BOOL bUpdateClipOrigin
= FALSE
;
381 TRACE("hwnd %p, hrgnClip %p, flags %08lx\n", hwnd
, hrgnClip
, flags
);
383 if (flags
& (DCX_LOCKWINDOWUPDATE
)) {
384 FIXME("not yet supported - see source\n");
385 /* See the comment in LockWindowUpdate for more explanation. This flag is not implemented
386 * by that patch, but we need LockWindowUpdate implemented correctly before this can be done.
390 if (!hwnd
) hwnd
= GetDesktopWindow();
391 if (!(full
= WIN_IsCurrentProcess( hwnd
)))
393 FIXME( "not supported yet on other process window %p\n", hwnd
);
397 if (!(wndPtr
= WIN_GetPtr( hwnd
))) return 0;
401 if (flags
& (DCX_WINDOW
| DCX_PARENTCLIP
)) flags
|= DCX_CACHE
;
403 if (flags
& DCX_USESTYLE
)
405 flags
&= ~( DCX_CLIPCHILDREN
| DCX_CLIPSIBLINGS
| DCX_PARENTCLIP
);
407 if( wndPtr
->dwStyle
& WS_CLIPSIBLINGS
)
408 flags
|= DCX_CLIPSIBLINGS
;
410 if ( !(flags
& DCX_WINDOW
) )
412 if (wndPtr
->clsStyle
& CS_PARENTDC
) flags
|= DCX_PARENTCLIP
;
414 if (wndPtr
->dwStyle
& WS_CLIPCHILDREN
&&
415 !(wndPtr
->dwStyle
& WS_MINIMIZE
) ) flags
|= DCX_CLIPCHILDREN
;
416 if (!wndPtr
->dce
) flags
|= DCX_CACHE
;
420 if (flags
& DCX_WINDOW
) flags
&= ~DCX_CLIPCHILDREN
;
422 parent
= GetAncestor( hwnd
, GA_PARENT
);
423 if (!parent
|| (parent
== GetDesktopWindow()))
424 flags
= (flags
& ~DCX_PARENTCLIP
) | DCX_CLIPSIBLINGS
;
426 /* it seems parent clip is ignored when clipping siblings or children */
427 if (flags
& (DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
)) flags
&= ~DCX_PARENTCLIP
;
429 if( flags
& DCX_PARENTCLIP
)
431 LONG parent_style
= GetWindowLongW( parent
, GWL_STYLE
);
432 if( (wndPtr
->dwStyle
& WS_VISIBLE
) && (parent_style
& WS_VISIBLE
) )
434 flags
&= ~DCX_CLIPCHILDREN
;
435 if (parent_style
& WS_CLIPSIBLINGS
) flags
|= DCX_CLIPSIBLINGS
;
439 /* find a suitable DCE */
441 dcxFlags
= flags
& (DCX_PARENTCLIP
| DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
442 DCX_CACHE
| DCX_WINDOW
);
444 if (flags
& DCX_CACHE
)
449 dceEmpty
= dceUnused
= NULL
;
451 /* Strategy: First, we attempt to find a non-empty but unused DCE with
452 * compatible flags. Next, we look for an empty entry. If the cache is
453 * full we have to purge one of the unused entries.
456 for (dce
= firstDCE
; (dce
); dce
= dce
->next
)
458 if ((dce
->DCXflags
& (DCX_CACHE
| DCX_DCEBUSY
)) == DCX_CACHE
)
462 if (dce
->DCXflags
& DCX_DCEEMPTY
)
465 if ((dce
->hwndCurrent
== hwnd
) &&
466 ((dce
->DCXflags
& (DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
467 DCX_CACHE
| DCX_WINDOW
| DCX_PARENTCLIP
)) == dcxFlags
))
469 TRACE("\tfound valid %p dce [%p], flags %08lx\n",
470 dce
, hwnd
, dcxFlags
);
471 bUpdateVisRgn
= FALSE
;
472 bUpdateClipOrigin
= TRUE
;
478 if (!dce
) dce
= (dceEmpty
) ? dceEmpty
: dceUnused
;
480 /* if there's no dce empty or unused, allocate a new one */
483 dce
= DCE_AllocDCE( 0, DCE_CACHE_DC
);
489 if (dce
&& dce
->hwndCurrent
== hwnd
)
491 TRACE("\tskipping hVisRgn update\n");
492 bUpdateVisRgn
= FALSE
; /* updated automatically, via DCHook() */
501 if (!(flags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
))) hrgnClip
= 0;
503 if (((flags
^ dce
->DCXflags
) & (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
)) &&
504 (dce
->hClipRgn
!= hrgnClip
))
506 /* if the extra clip region has changed, get rid of the old one */
507 DCE_DeleteClipRgn( dce
);
510 dce
->hwndCurrent
= hwnd
;
511 dce
->hClipRgn
= hrgnClip
;
512 dce
->DCXflags
= flags
& (DCX_PARENTCLIP
| DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
513 DCX_CACHE
| DCX_WINDOW
| DCX_WINDOWPAINT
|
514 DCX_KEEPCLIPRGN
| DCX_INTERSECTRGN
| DCX_EXCLUDERGN
);
515 dce
->DCXflags
|= DCX_DCEBUSY
;
516 dce
->DCXflags
&= ~DCX_DCEDIRTY
;
519 if (bUpdateVisRgn
) SetHookFlags16( HDC_16(hdc
), DCHF_INVALIDATEVISRGN
); /* force update */
521 if (!USER_Driver
.pGetDC( hwnd
, hdc
, hrgnClip
, flags
)) hdc
= 0;
523 TRACE("(%p,%p,0x%lx): returning %p\n", hwnd
, hrgnClip
, flags
, hdc
);
525 WIN_ReleasePtr(wndPtr
);
530 /***********************************************************************
533 * Get a device context.
536 * Success: Handle to the device context
540 HWND hwnd
/* [in] handle of window - may be NULL */
543 return GetDCEx( 0, 0, DCX_CACHE
| DCX_WINDOW
);
544 return GetDCEx( hwnd
, 0, DCX_USESTYLE
);
548 /***********************************************************************
549 * GetWindowDC (USER32.@)
551 HDC WINAPI
GetWindowDC( HWND hwnd
)
553 return GetDCEx( hwnd
, 0, DCX_USESTYLE
| DCX_WINDOW
);
557 /***********************************************************************
558 * ReleaseDC (USER32.@)
560 * Release a device context.
563 * Success: Non-zero. Resources used by hdc are released.
566 INT WINAPI
ReleaseDC(
567 HWND hwnd
, /* [in] Handle of window - ignored */
568 HDC hdc
/* [in] Handle of device context */
576 TRACE("%p %p\n", hwnd
, hdc
);
578 while (dce
&& (dce
->hDC
!= hdc
)) dce
= dce
->next
;
581 if ( dce
->DCXflags
& DCX_DCEBUSY
)
582 nRet
= DCE_ReleaseDC( dce
);
589 /***********************************************************************
592 * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
594 BOOL16 WINAPI
DCHook16( HDC16 hDC
, WORD code
, DWORD data
, LPARAM lParam
)
597 DCE
*dce
= (DCE
*)data
;
599 TRACE("hDC = %04x, %i\n", hDC
, code
);
602 assert( HDC_16(dce
->hDC
) == hDC
);
604 /* Grab the windows lock before doing anything else */
609 case DCHC_INVALIDVISRGN
:
610 /* GDI code calls this when it detects that the
611 * DC is dirty (usually after SetHookFlags()). This
612 * means that we have to recompute the visible region.
614 if( dce
->DCXflags
& DCX_DCEBUSY
)
616 /* Dirty bit has been cleared by caller, set it again so that
617 * pGetDC recomputes the visible region. */
618 SetHookFlags16( hDC
, DCHF_INVALIDATEVISRGN
);
619 USER_Driver
.pGetDC( dce
->hwndCurrent
, dce
->hDC
, dce
->hClipRgn
, dce
->DCXflags
);
621 else /* non-fatal but shouldn't happen */
622 WARN("DC is not in use!\n");
627 * Windows will not let you delete a DC that is busy
628 * (between GetDC and ReleaseDC)
631 if ( dce
->DCXflags
& DCX_DCEBUSY
)
633 WARN("Application trying to delete a busy DC\n");
636 else DCE_FreeDCE( dce
);
640 FIXME("unknown code\n");
643 USER_Unlock(); /* Release the wnd lock */
648 /**********************************************************************
649 * WindowFromDC (USER32.@)
651 HWND WINAPI
WindowFromDC( HDC hDC
)
659 while (dce
&& (dce
->hDC
!= hDC
)) dce
= dce
->next
;
661 hwnd
= dce
? dce
->hwndCurrent
: 0;
668 /***********************************************************************
669 * LockWindowUpdate (USER32.@)
671 BOOL WINAPI
LockWindowUpdate( HWND hwnd
)
673 static HWND lockedWnd
;
675 /* This function is fully implemented by the following patch:
677 * http://www.winehq.org/hypermail/wine-patches/2004/01/0142.html
679 * but in order to work properly, it needs the ability to invalidate
680 * DCEs in other processes when the lock window is changed, which
681 * isn't possible yet.
685 FIXME("(%p), partial stub!\n",hwnd
);
692 /* Unlock lockedWnd */
693 /* FIXME: Do something */
697 /* Attempted to lock a second window */
698 /* Return FALSE and do nothing */