Added, update information about AppDefault.
[wine/wine64.git] / windows / dce.c
blob4f27e65dc445aef98fe909421be13fa34c26d644
1 /*
2 * USER DCE functions
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.
11 * Internal DCX flags:
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
20 #include <assert.h>
21 #include "dce.h"
22 #include "win.h"
23 #include "gdi.h"
24 #include "region.h"
25 #include "user.h"
26 #include "debugtools.h"
27 #include "windef.h"
28 #include "wingdi.h"
29 #include "wine/winbase16.h"
30 #include "wine/winuser16.h"
32 DEFAULT_DEBUG_CHANNEL(dc);
34 static DCE *firstDCE;
35 static HDC defaultDCstate;
37 static void DCE_DeleteClipRgn( DCE* );
38 static INT DCE_ReleaseDC( DCE* );
41 /***********************************************************************
42 * DCE_DumpCache
44 static void DCE_DumpCache(void)
46 DCE *dce;
48 USER_Lock();
49 dce = firstDCE;
51 DPRINTF("DCE:\n");
52 while( dce )
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" : "" );
58 dce = dce->next;
61 USER_Unlock();
64 /***********************************************************************
65 * DCE_AllocDCE
67 * Allocate a new DCE.
69 DCE *DCE_AllocDCE( HWND hWnd, DCE_TYPE type )
71 DCE * dce;
73 if (!(dce = HeapAlloc( GetProcessHeap(), 0, sizeof(DCE) ))) return NULL;
74 if (!(dce->hDC = CreateDCA( "DISPLAY", NULL, NULL, NULL )))
76 HeapFree( GetProcessHeap(), 0, dce );
77 return 0;
79 if (!defaultDCstate) defaultDCstate = GetDCState16( dce->hDC );
81 /* store DCE handle in DC hook data field */
83 SetDCHook( dce->hDC, DCHook16, (DWORD)dce );
85 dce->hwndCurrent = WIN_GetFullHandle( hWnd );
86 dce->hClipRgn = 0;
88 if( type != DCE_CACHE_DC ) /* owned or class DC */
90 dce->DCXflags = DCX_DCEBUSY;
91 if( hWnd )
93 LONG style = GetWindowLongW( hWnd, GWL_STYLE );
94 if (style & WS_CLIPCHILDREN) dce->DCXflags |= DCX_CLIPCHILDREN;
95 if (style & WS_CLIPSIBLINGS) dce->DCXflags |= DCX_CLIPSIBLINGS;
97 SetHookFlags16(dce->hDC,DCHF_INVALIDATEVISRGN);
99 else dce->DCXflags = DCX_CACHE | DCX_DCEEMPTY;
101 USER_Lock();
102 dce->next = firstDCE;
103 firstDCE = dce;
104 USER_Unlock();
105 return dce;
109 /***********************************************************************
110 * DCE_FreeDCE
112 DCE* DCE_FreeDCE( DCE *dce )
114 DCE **ppDCE, *ret;
116 if (!dce) return NULL;
118 USER_Lock();
120 ppDCE = &firstDCE;
122 while (*ppDCE && (*ppDCE != dce)) ppDCE = &(*ppDCE)->next;
123 if (*ppDCE == dce) *ppDCE = dce->next;
124 ret = *ppDCE;
125 USER_Unlock();
127 SetDCHook(dce->hDC, NULL, 0L);
129 DeleteDC( dce->hDC );
130 if( dce->hClipRgn && !(dce->DCXflags & DCX_KEEPCLIPRGN) )
131 DeleteObject(dce->hClipRgn);
132 HeapFree( GetProcessHeap(), 0, dce );
134 return ret;
137 /***********************************************************************
138 * DCE_FreeWindowDCE
140 * Remove owned DCE and reset unreleased cache DCEs.
142 void DCE_FreeWindowDCE( HWND hwnd )
144 DCE *pDCE;
145 WND *pWnd = WIN_GetPtr( hwnd );
147 pDCE = firstDCE;
148 while( pDCE )
150 if( pDCE->hwndCurrent == hwnd )
152 if( pDCE == pWnd->dce ) /* owned or Class DCE*/
154 if (pWnd->clsStyle & CS_OWNDC) /* owned DCE*/
156 pDCE = DCE_FreeDCE( pDCE );
157 pWnd->dce = NULL;
158 continue;
160 else if( pDCE->DCXflags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN) ) /* Class DCE*/
162 DCE_DeleteClipRgn( pDCE );
163 pDCE->hwndCurrent = 0;
166 else
168 if( pDCE->DCXflags & DCX_DCEBUSY ) /* shared cache DCE */
170 /* FIXME: AFAICS we are doing the right thing here so
171 * this should be a WARN. But this is best left as an ERR
172 * because the 'application error' is likely to come from
173 * another part of Wine (i.e. it's our fault after all).
174 * We should change this to WARN when Wine is more stable
175 * (for 1.0?).
177 ERR("[%08x] GetDC() without ReleaseDC()!\n",hwnd);
178 DCE_ReleaseDC( pDCE );
181 pDCE->DCXflags &= DCX_CACHE;
182 pDCE->DCXflags |= DCX_DCEEMPTY;
183 pDCE->hwndCurrent = 0;
186 pDCE = pDCE->next;
188 WIN_ReleasePtr( pWnd );
192 /***********************************************************************
193 * DCE_DeleteClipRgn
195 static void DCE_DeleteClipRgn( DCE* dce )
197 dce->DCXflags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN | DCX_WINDOWPAINT);
199 if( dce->DCXflags & DCX_KEEPCLIPRGN )
200 dce->DCXflags &= ~DCX_KEEPCLIPRGN;
201 else
202 if( dce->hClipRgn > 1 )
203 DeleteObject( dce->hClipRgn );
205 dce->hClipRgn = 0;
207 /* make it dirty so that the vis rgn gets recomputed next time */
208 dce->DCXflags |= DCX_DCEDIRTY;
209 SetHookFlags16( dce->hDC, DCHF_INVALIDATEVISRGN );
213 /***********************************************************************
214 * DCE_ReleaseDC
216 static INT DCE_ReleaseDC( DCE* dce )
218 if ((dce->DCXflags & (DCX_DCEEMPTY | DCX_DCEBUSY)) != DCX_DCEBUSY) return 0;
220 /* restore previous visible region */
222 if ((dce->DCXflags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN)) &&
223 (dce->DCXflags & (DCX_CACHE | DCX_WINDOWPAINT)) )
224 DCE_DeleteClipRgn( dce );
226 if (dce->DCXflags & DCX_CACHE)
228 SetDCState16( dce->hDC, defaultDCstate );
229 dce->DCXflags &= ~DCX_DCEBUSY;
230 if (dce->DCXflags & DCX_DCEDIRTY)
232 /* don't keep around invalidated entries
233 * because SetDCState() disables hVisRgn updates
234 * by removing dirty bit. */
236 dce->hwndCurrent = 0;
237 dce->DCXflags &= DCX_CACHE;
238 dce->DCXflags |= DCX_DCEEMPTY;
241 return 1;
245 /***********************************************************************
246 * DCE_InvalidateDCE
248 * It is called from SetWindowPos() and EVENT_MapNotify - we have to
249 * mark as dirty all busy DCEs for windows that have pWnd->parent as
250 * an ancestor and whose client rect intersects with specified update
251 * rectangle. In addition, pWnd->parent DCEs may need to be updated if
252 * DCX_CLIPCHILDREN flag is set. */
253 BOOL DCE_InvalidateDCE(HWND hwnd, const RECT* pRectUpdate)
255 HWND hwndScope = GetAncestor( hwnd, GA_PARENT );
256 BOOL bRet = FALSE;
258 if( hwndScope )
260 DCE *dce;
262 TRACE("scope hwnd = %04x, (%i,%i - %i,%i)\n",
263 hwndScope, pRectUpdate->left,pRectUpdate->top,
264 pRectUpdate->right,pRectUpdate->bottom);
265 if(TRACE_ON(dc))
266 DCE_DumpCache();
268 /* walk all DCEs and fixup non-empty entries */
270 for (dce = firstDCE; (dce); dce = dce->next)
272 if (dce->DCXflags & DCX_DCEEMPTY) continue;
273 if ((dce->hwndCurrent == hwndScope) && !(dce->DCXflags & DCX_CLIPCHILDREN))
274 continue; /* child window positions don't bother us */
276 /* check if DCE window is within the z-order scope */
278 if (hwndScope == dce->hwndCurrent || IsChild( hwndScope, dce->hwndCurrent ))
280 if (hwnd != dce->hwndCurrent)
282 /* check if the window rectangle intersects this DCE window */
283 RECT rect;
284 GetWindowRect( dce->hwndCurrent, &rect );
285 MapWindowPoints( 0, hwndScope, (POINT *)&rect, 2 );
286 if (!IntersectRect( &rect, &rect, pRectUpdate )) continue;
289 if( !(dce->DCXflags & DCX_DCEBUSY) )
291 /* Don't bother with visible regions of unused DCEs */
293 TRACE("\tpurged %p dce [%04x]\n", dce, dce->hwndCurrent);
294 dce->hwndCurrent = 0;
295 dce->DCXflags &= DCX_CACHE;
296 dce->DCXflags |= DCX_DCEEMPTY;
298 else
300 /* Set dirty bits in the hDC and DCE structs */
302 TRACE("\tfixed up %p dce [%04x]\n", dce, dce->hwndCurrent);
303 dce->DCXflags |= DCX_DCEDIRTY;
304 SetHookFlags16(dce->hDC, DCHF_INVALIDATEVISRGN);
305 bRet = TRUE;
308 } /* dce list */
310 return bRet;
314 /***********************************************************************
315 * DCE_ExcludeRgn
317 * Translate given region from the wnd client to the DC coordinates
318 * and add it to the clipping region.
320 INT DCE_ExcludeRgn( HDC hDC, HWND hwnd, HRGN hRgn )
322 POINT pt = {0, 0};
323 DCE *dce = firstDCE;
325 while (dce && (dce->hDC != hDC)) dce = dce->next;
326 if (!dce) return ERROR;
328 MapWindowPoints( hwnd, dce->hwndCurrent, &pt, 1);
329 if( dce->DCXflags & DCX_WINDOW )
331 WND *wnd = WIN_FindWndPtr(dce->hwndCurrent);
332 pt.x += wnd->rectClient.left - wnd->rectWindow.left;
333 pt.y += wnd->rectClient.top - wnd->rectWindow.top;
334 WIN_ReleaseWndPtr(wnd);
336 OffsetRgn(hRgn, pt.x, pt.y);
338 return ExtSelectClipRgn( hDC, hRgn, RGN_DIFF );
342 /***********************************************************************
343 * GetDCEx (USER32.@)
345 * Unimplemented flags: DCX_LOCKWINDOWUPDATE
347 * FIXME: Full support for hrgnClip == 1 (alias for entire window).
349 HDC WINAPI GetDCEx( HWND hwnd, HRGN hrgnClip, DWORD flags )
351 HDC hdc = 0;
352 DCE * dce;
353 WND * wndPtr;
354 DWORD dcxFlags = 0;
355 BOOL bUpdateVisRgn = TRUE;
356 BOOL bUpdateClipOrigin = FALSE;
357 HWND parent, full;
359 TRACE("hwnd %04x, hrgnClip %04x, flags %08x\n",
360 hwnd, hrgnClip, (unsigned)flags);
362 if (!hwnd) hwnd = GetDesktopWindow();
363 if (!(full = WIN_IsCurrentProcess( hwnd )))
365 FIXME( "not supported yet on other process window %x\n", hwnd );
366 return 0;
368 hwnd = full;
369 if (!(wndPtr = WIN_GetPtr( hwnd ))) return 0;
371 /* fixup flags */
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)
418 DCE* dceEmpty;
419 DCE* dceUnused;
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 )
432 dceUnused = dce;
434 if (dce->DCXflags & DCX_DCEEMPTY)
435 dceEmpty = dce;
436 else
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;
445 break;
450 if (!dce) dce = (dceEmpty) ? dceEmpty : dceUnused;
452 /* if there's no dce empty or unused, allocate a new one */
453 if (!dce)
455 dce = DCE_AllocDCE( 0, DCE_CACHE_DC );
458 else
460 dce = wndPtr->dce;
461 if (dce && dce->hwndCurrent == hwnd)
463 TRACE("\tskipping hVisRgn update\n");
464 bUpdateVisRgn = FALSE; /* updated automatically, via DCHook() */
467 if (!dce)
469 hdc = 0;
470 goto END;
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;
489 hdc = dce->hDC;
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);
496 END:
497 WIN_ReleasePtr(wndPtr);
498 return hdc;
502 /***********************************************************************
503 * GetDC (USER32.@)
504 * RETURNS
505 * :Handle to DC
506 * NULL: Failure
508 HDC WINAPI GetDC(
509 HWND hwnd /* [in] handle of window */
511 if (!hwnd)
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.@)
529 * RETURNS
530 * 1: Success
531 * 0: Failure
533 INT WINAPI ReleaseDC(
534 HWND hwnd /* [in] Handle of window - ignored */,
535 HDC hdc /* [in] Handle of device context */
537 DCE * dce;
538 INT nRet = 0;
540 USER_Lock();
541 dce = firstDCE;
543 TRACE("%04x %04x\n", hwnd, hdc );
545 while (dce && (dce->hDC != hdc)) dce = dce->next;
547 if ( dce )
548 if ( dce->DCXflags & DCX_DCEBUSY )
549 nRet = DCE_ReleaseDC( dce );
551 USER_Unlock();
553 return nRet;
556 /***********************************************************************
557 * DCHook (USER.362)
559 * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
561 BOOL16 WINAPI DCHook16( HDC16 hDC, WORD code, DWORD data, LPARAM lParam )
563 BOOL retv = TRUE;
564 DCE *dce = (DCE *)data;
566 TRACE("hDC = %04x, %i\n", hDC, code);
568 if (!dce) return 0;
569 assert(dce->hDC == hDC);
571 /* Grab the windows lock before doing anything else */
572 USER_Lock();
574 switch( code )
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");
590 break;
592 case DCHC_DELETEDC:
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");
601 retv = FALSE;
603 else DCE_FreeDCE( dce );
604 break;
606 default:
607 FIXME("unknown code\n");
610 USER_Unlock(); /* Release the wnd lock */
611 return retv;
615 /**********************************************************************
616 * WindowFromDC (USER32.@)
618 HWND WINAPI WindowFromDC( HDC hDC )
620 DCE *dce;
621 HWND hwnd;
623 USER_Lock();
624 dce = firstDCE;
626 while (dce && (dce->hDC != hDC)) dce = dce->next;
628 hwnd = dce ? dce->hwndCurrent : 0;
629 USER_Unlock();
631 return hwnd;
635 /***********************************************************************
636 * LockWindowUpdate (USER32.@)
638 BOOL WINAPI LockWindowUpdate( HWND hwnd )
640 FIXME("(%x), stub!\n",hwnd);
641 return TRUE;