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
40 #include "wine/debug.h"
43 #include "wine/winbase16.h"
44 #include "wine/winuser16.h"
46 WINE_DEFAULT_DEBUG_CHANNEL(dc
);
49 static HDC defaultDCstate
;
51 static void DCE_DeleteClipRgn( DCE
* );
52 static INT
DCE_ReleaseDC( DCE
* );
55 /***********************************************************************
58 static void DCE_DumpCache(void)
68 DPRINTF("\t[0x%08x] hWnd 0x%04x, dcx %08x, %s %s\n",
69 (unsigned)dce
, dce
->hwndCurrent
, (unsigned)dce
->DCXflags
,
70 (dce
->DCXflags
& DCX_CACHE
) ? "Cache" : "Owned",
71 (dce
->DCXflags
& DCX_DCEBUSY
) ? "InUse" : "" );
78 /***********************************************************************
83 DCE
*DCE_AllocDCE( HWND hWnd
, DCE_TYPE type
)
87 if (!(dce
= HeapAlloc( GetProcessHeap(), 0, sizeof(DCE
) ))) return NULL
;
88 if (!(dce
->hDC
= CreateDCA( "DISPLAY", NULL
, NULL
, NULL
)))
90 HeapFree( GetProcessHeap(), 0, dce
);
93 if (!defaultDCstate
) defaultDCstate
= GetDCState16( dce
->hDC
);
95 /* store DCE handle in DC hook data field */
97 SetDCHook( dce
->hDC
, DCHook16
, (DWORD
)dce
);
99 dce
->hwndCurrent
= WIN_GetFullHandle( hWnd
);
102 if( type
!= DCE_CACHE_DC
) /* owned or class DC */
104 dce
->DCXflags
= DCX_DCEBUSY
;
107 LONG style
= GetWindowLongW( hWnd
, GWL_STYLE
);
108 if (style
& WS_CLIPCHILDREN
) dce
->DCXflags
|= DCX_CLIPCHILDREN
;
109 if (style
& WS_CLIPSIBLINGS
) dce
->DCXflags
|= DCX_CLIPSIBLINGS
;
111 SetHookFlags16(dce
->hDC
,DCHF_INVALIDATEVISRGN
);
113 else dce
->DCXflags
= DCX_CACHE
| DCX_DCEEMPTY
;
116 dce
->next
= firstDCE
;
123 /***********************************************************************
126 DCE
* DCE_FreeDCE( DCE
*dce
)
130 if (!dce
) return NULL
;
136 while (*ppDCE
&& (*ppDCE
!= dce
)) ppDCE
= &(*ppDCE
)->next
;
137 if (*ppDCE
== dce
) *ppDCE
= dce
->next
;
141 SetDCHook(dce
->hDC
, NULL
, 0L);
143 DeleteDC( dce
->hDC
);
144 if( dce
->hClipRgn
&& !(dce
->DCXflags
& DCX_KEEPCLIPRGN
) )
145 DeleteObject(dce
->hClipRgn
);
146 HeapFree( GetProcessHeap(), 0, dce
);
151 /***********************************************************************
154 * Remove owned DCE and reset unreleased cache DCEs.
156 void DCE_FreeWindowDCE( HWND hwnd
)
159 WND
*pWnd
= WIN_GetPtr( hwnd
);
164 if( pDCE
->hwndCurrent
== hwnd
)
166 if( pDCE
== pWnd
->dce
) /* owned or Class DCE*/
168 if (pWnd
->clsStyle
& CS_OWNDC
) /* owned DCE*/
170 pDCE
= DCE_FreeDCE( pDCE
);
174 else if( pDCE
->DCXflags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
) ) /* Class DCE*/
176 DCE_DeleteClipRgn( pDCE
);
177 pDCE
->hwndCurrent
= 0;
182 if( pDCE
->DCXflags
& DCX_DCEBUSY
) /* shared cache DCE */
184 /* FIXME: AFAICS we are doing the right thing here so
185 * this should be a WARN. But this is best left as an ERR
186 * because the 'application error' is likely to come from
187 * another part of Wine (i.e. it's our fault after all).
188 * We should change this to WARN when Wine is more stable
191 ERR("[%08x] GetDC() without ReleaseDC()!\n",hwnd
);
192 DCE_ReleaseDC( pDCE
);
195 pDCE
->DCXflags
&= DCX_CACHE
;
196 pDCE
->DCXflags
|= DCX_DCEEMPTY
;
197 pDCE
->hwndCurrent
= 0;
202 WIN_ReleasePtr( pWnd
);
206 /***********************************************************************
209 static void DCE_DeleteClipRgn( DCE
* dce
)
211 dce
->DCXflags
&= ~(DCX_EXCLUDERGN
| DCX_INTERSECTRGN
| DCX_WINDOWPAINT
);
213 if( dce
->DCXflags
& DCX_KEEPCLIPRGN
)
214 dce
->DCXflags
&= ~DCX_KEEPCLIPRGN
;
216 if( dce
->hClipRgn
> 1 )
217 DeleteObject( dce
->hClipRgn
);
221 /* make it dirty so that the vis rgn gets recomputed next time */
222 dce
->DCXflags
|= DCX_DCEDIRTY
;
223 SetHookFlags16( dce
->hDC
, DCHF_INVALIDATEVISRGN
);
227 /***********************************************************************
230 static INT
DCE_ReleaseDC( DCE
* dce
)
232 if ((dce
->DCXflags
& (DCX_DCEEMPTY
| DCX_DCEBUSY
)) != DCX_DCEBUSY
) return 0;
234 /* restore previous visible region */
236 if ((dce
->DCXflags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
)) &&
237 (dce
->DCXflags
& (DCX_CACHE
| DCX_WINDOWPAINT
)) )
238 DCE_DeleteClipRgn( dce
);
240 if (dce
->DCXflags
& DCX_CACHE
)
242 SetDCState16( dce
->hDC
, defaultDCstate
);
243 dce
->DCXflags
&= ~DCX_DCEBUSY
;
244 if (dce
->DCXflags
& DCX_DCEDIRTY
)
246 /* don't keep around invalidated entries
247 * because SetDCState() disables hVisRgn updates
248 * by removing dirty bit. */
250 dce
->hwndCurrent
= 0;
251 dce
->DCXflags
&= DCX_CACHE
;
252 dce
->DCXflags
|= DCX_DCEEMPTY
;
259 /***********************************************************************
262 * It is called from SetWindowPos() and EVENT_MapNotify - we have to
263 * mark as dirty all busy DCEs for windows that have pWnd->parent as
264 * an ancestor and whose client rect intersects with specified update
265 * rectangle. In addition, pWnd->parent DCEs may need to be updated if
266 * DCX_CLIPCHILDREN flag is set. */
267 BOOL
DCE_InvalidateDCE(HWND hwnd
, const RECT
* pRectUpdate
)
269 HWND hwndScope
= GetAncestor( hwnd
, GA_PARENT
);
276 TRACE("scope hwnd = %04x, (%i,%i - %i,%i)\n",
277 hwndScope
, pRectUpdate
->left
,pRectUpdate
->top
,
278 pRectUpdate
->right
,pRectUpdate
->bottom
);
282 /* walk all DCEs and fixup non-empty entries */
284 for (dce
= firstDCE
; (dce
); dce
= dce
->next
)
286 if (dce
->DCXflags
& DCX_DCEEMPTY
) continue;
287 if ((dce
->hwndCurrent
== hwndScope
) && !(dce
->DCXflags
& DCX_CLIPCHILDREN
))
288 continue; /* child window positions don't bother us */
290 /* check if DCE window is within the z-order scope */
292 if (hwndScope
== dce
->hwndCurrent
|| IsChild( hwndScope
, dce
->hwndCurrent
))
294 if (hwnd
!= dce
->hwndCurrent
)
296 /* check if the window rectangle intersects this DCE window */
298 GetWindowRect( dce
->hwndCurrent
, &rect
);
299 MapWindowPoints( 0, hwndScope
, (POINT
*)&rect
, 2 );
300 if (!IntersectRect( &rect
, &rect
, pRectUpdate
)) continue;
303 if( !(dce
->DCXflags
& DCX_DCEBUSY
) )
305 /* Don't bother with visible regions of unused DCEs */
307 TRACE("\tpurged %p dce [%04x]\n", dce
, dce
->hwndCurrent
);
308 dce
->hwndCurrent
= 0;
309 dce
->DCXflags
&= DCX_CACHE
;
310 dce
->DCXflags
|= DCX_DCEEMPTY
;
314 /* Set dirty bits in the hDC and DCE structs */
316 TRACE("\tfixed up %p dce [%04x]\n", dce
, dce
->hwndCurrent
);
317 dce
->DCXflags
|= DCX_DCEDIRTY
;
318 SetHookFlags16(dce
->hDC
, DCHF_INVALIDATEVISRGN
);
328 /***********************************************************************
331 * Translate given region from the wnd client to the DC coordinates
332 * and add it to the clipping region.
334 INT
DCE_ExcludeRgn( HDC hDC
, HWND hwnd
, HRGN hRgn
)
339 while (dce
&& (dce
->hDC
!= hDC
)) dce
= dce
->next
;
340 if (!dce
) return ERROR
;
342 MapWindowPoints( hwnd
, dce
->hwndCurrent
, &pt
, 1);
343 if( dce
->DCXflags
& DCX_WINDOW
)
345 WND
*wnd
= WIN_FindWndPtr(dce
->hwndCurrent
);
346 pt
.x
+= wnd
->rectClient
.left
- wnd
->rectWindow
.left
;
347 pt
.y
+= wnd
->rectClient
.top
- wnd
->rectWindow
.top
;
348 WIN_ReleaseWndPtr(wnd
);
350 OffsetRgn(hRgn
, pt
.x
, pt
.y
);
352 return ExtSelectClipRgn( hDC
, hRgn
, RGN_DIFF
);
356 /***********************************************************************
359 * Unimplemented flags: DCX_LOCKWINDOWUPDATE
361 * FIXME: Full support for hrgnClip == 1 (alias for entire window).
363 HDC WINAPI
GetDCEx( HWND hwnd
, HRGN hrgnClip
, DWORD flags
)
369 BOOL bUpdateVisRgn
= TRUE
;
370 BOOL bUpdateClipOrigin
= FALSE
;
373 TRACE("hwnd %04x, hrgnClip %04x, flags %08x\n",
374 hwnd
, hrgnClip
, (unsigned)flags
);
376 if (!hwnd
) hwnd
= GetDesktopWindow();
377 if (!(full
= WIN_IsCurrentProcess( hwnd
)))
379 FIXME( "not supported yet on other process window %x\n", hwnd
);
383 if (!(wndPtr
= WIN_GetPtr( hwnd
))) return 0;
387 if (flags
& (DCX_WINDOW
| DCX_PARENTCLIP
)) flags
|= DCX_CACHE
;
389 if (flags
& DCX_USESTYLE
)
391 flags
&= ~( DCX_CLIPCHILDREN
| DCX_CLIPSIBLINGS
| DCX_PARENTCLIP
);
393 if( wndPtr
->dwStyle
& WS_CLIPSIBLINGS
)
394 flags
|= DCX_CLIPSIBLINGS
;
396 if ( !(flags
& DCX_WINDOW
) )
398 if (wndPtr
->clsStyle
& CS_PARENTDC
) flags
|= DCX_PARENTCLIP
;
400 if (wndPtr
->dwStyle
& WS_CLIPCHILDREN
&&
401 !(wndPtr
->dwStyle
& WS_MINIMIZE
) ) flags
|= DCX_CLIPCHILDREN
;
402 if (!wndPtr
->dce
) flags
|= DCX_CACHE
;
406 if (flags
& DCX_WINDOW
) flags
&= ~DCX_CLIPCHILDREN
;
408 parent
= GetAncestor( hwnd
, GA_PARENT
);
409 if (!parent
|| (parent
== GetDesktopWindow()))
410 flags
= (flags
& ~DCX_PARENTCLIP
) | DCX_CLIPSIBLINGS
;
412 /* it seems parent clip is ignored when clipping siblings or children */
413 if (flags
& (DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
)) flags
&= ~DCX_PARENTCLIP
;
415 if( flags
& DCX_PARENTCLIP
)
417 LONG parent_style
= GetWindowLongW( parent
, GWL_STYLE
);
418 if( (wndPtr
->dwStyle
& WS_VISIBLE
) && (parent_style
& WS_VISIBLE
) )
420 flags
&= ~DCX_CLIPCHILDREN
;
421 if (parent_style
& WS_CLIPSIBLINGS
) flags
|= DCX_CLIPSIBLINGS
;
425 /* find a suitable DCE */
427 dcxFlags
= flags
& (DCX_PARENTCLIP
| DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
428 DCX_CACHE
| DCX_WINDOW
);
430 if (flags
& DCX_CACHE
)
435 dceEmpty
= dceUnused
= NULL
;
437 /* Strategy: First, we attempt to find a non-empty but unused DCE with
438 * compatible flags. Next, we look for an empty entry. If the cache is
439 * full we have to purge one of the unused entries.
442 for (dce
= firstDCE
; (dce
); dce
= dce
->next
)
444 if ((dce
->DCXflags
& (DCX_CACHE
| DCX_DCEBUSY
)) == DCX_CACHE
)
448 if (dce
->DCXflags
& DCX_DCEEMPTY
)
451 if ((dce
->hwndCurrent
== hwnd
) &&
452 ((dce
->DCXflags
& (DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
453 DCX_CACHE
| DCX_WINDOW
| DCX_PARENTCLIP
)) == dcxFlags
))
455 TRACE("\tfound valid %08x dce [%04x], flags %08x\n",
456 (unsigned)dce
, hwnd
, (unsigned)dcxFlags
);
457 bUpdateVisRgn
= FALSE
;
458 bUpdateClipOrigin
= TRUE
;
464 if (!dce
) dce
= (dceEmpty
) ? dceEmpty
: dceUnused
;
466 /* if there's no dce empty or unused, allocate a new one */
469 dce
= DCE_AllocDCE( 0, DCE_CACHE_DC
);
475 if (dce
&& dce
->hwndCurrent
== hwnd
)
477 TRACE("\tskipping hVisRgn update\n");
478 bUpdateVisRgn
= FALSE
; /* updated automatically, via DCHook() */
487 if (!(flags
& (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
))) hrgnClip
= 0;
489 if (((flags
^ dce
->DCXflags
) & (DCX_INTERSECTRGN
| DCX_EXCLUDERGN
)) &&
490 (dce
->hClipRgn
!= hrgnClip
))
492 /* if the extra clip region has changed, get rid of the old one */
493 DCE_DeleteClipRgn( dce
);
496 dce
->hwndCurrent
= hwnd
;
497 dce
->hClipRgn
= hrgnClip
;
498 dce
->DCXflags
= flags
& (DCX_PARENTCLIP
| DCX_CLIPSIBLINGS
| DCX_CLIPCHILDREN
|
499 DCX_CACHE
| DCX_WINDOW
| DCX_WINDOWPAINT
|
500 DCX_KEEPCLIPRGN
| DCX_INTERSECTRGN
| DCX_EXCLUDERGN
);
501 dce
->DCXflags
|= DCX_DCEBUSY
;
502 dce
->DCXflags
&= ~DCX_DCEDIRTY
;
505 if (bUpdateVisRgn
) SetHookFlags16( hdc
, DCHF_INVALIDATEVISRGN
); /* force update */
507 if (!USER_Driver
.pGetDC( hwnd
, hdc
, hrgnClip
, flags
)) hdc
= 0;
509 TRACE("(%04x,%04x,0x%lx): returning %04x\n", hwnd
, hrgnClip
, flags
, hdc
);
511 WIN_ReleasePtr(wndPtr
);
516 /***********************************************************************
523 HWND hwnd
/* [in] handle of window */
526 return GetDCEx( 0, 0, DCX_CACHE
| DCX_WINDOW
);
527 return GetDCEx( hwnd
, 0, DCX_USESTYLE
);
531 /***********************************************************************
532 * GetWindowDC (USER32.@)
534 HDC WINAPI
GetWindowDC( HWND hwnd
)
536 return GetDCEx( hwnd
, 0, DCX_USESTYLE
| DCX_WINDOW
);
540 /***********************************************************************
541 * ReleaseDC (USER32.@)
547 INT WINAPI
ReleaseDC(
548 HWND hwnd
/* [in] Handle of window - ignored */,
549 HDC hdc
/* [in] Handle of device context */
557 TRACE("%04x %04x\n", hwnd
, hdc
);
559 while (dce
&& (dce
->hDC
!= hdc
)) dce
= dce
->next
;
562 if ( dce
->DCXflags
& DCX_DCEBUSY
)
563 nRet
= DCE_ReleaseDC( dce
);
570 /***********************************************************************
573 * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
575 BOOL16 WINAPI
DCHook16( HDC16 hDC
, WORD code
, DWORD data
, LPARAM lParam
)
578 DCE
*dce
= (DCE
*)data
;
580 TRACE("hDC = %04x, %i\n", hDC
, code
);
583 assert(dce
->hDC
== hDC
);
585 /* Grab the windows lock before doing anything else */
590 case DCHC_INVALIDVISRGN
:
591 /* GDI code calls this when it detects that the
592 * DC is dirty (usually after SetHookFlags()). This
593 * means that we have to recompute the visible region.
595 if( dce
->DCXflags
& DCX_DCEBUSY
)
597 /* Dirty bit has been cleared by caller, set it again so that
598 * pGetDC recomputes the visible region. */
599 SetHookFlags16( dce
->hDC
, DCHF_INVALIDATEVISRGN
);
600 USER_Driver
.pGetDC( dce
->hwndCurrent
, dce
->hDC
, dce
->hClipRgn
, dce
->DCXflags
);
602 else /* non-fatal but shouldn't happen */
603 WARN("DC is not in use!\n");
608 * Windows will not let you delete a DC that is busy
609 * (between GetDC and ReleaseDC)
612 if ( dce
->DCXflags
& DCX_DCEBUSY
)
614 WARN("Application trying to delete a busy DC\n");
617 else DCE_FreeDCE( dce
);
621 FIXME("unknown code\n");
624 USER_Unlock(); /* Release the wnd lock */
629 /**********************************************************************
630 * WindowFromDC (USER32.@)
632 HWND WINAPI
WindowFromDC( HDC hDC
)
640 while (dce
&& (dce
->hDC
!= hDC
)) dce
= dce
->next
;
642 hwnd
= dce
? dce
->hwndCurrent
: 0;
649 /***********************************************************************
650 * LockWindowUpdate (USER32.@)
652 BOOL WINAPI
LockWindowUpdate( HWND hwnd
)
654 FIXME("(%x), stub!\n",hwnd
);