2 * Window painting functions
4 * Copyright 1993, 1994, 1995, 2001, 2004, 2005, 2008 Alexandre Julliard
5 * Copyright 1996, 1997, 1999 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #include "wine/port.h"
30 #define WIN32_NO_STATUS
35 #include "wine/server.h"
37 #include "user_private.h"
39 #include "wine/list.h"
40 #include "wine/debug.h"
42 WINE_DEFAULT_DEBUG_CHANNEL(win);
47 struct list entry; /* entry in global DCE list */
52 LONG count; /* usage count; 0 or 1 for cache DCEs, always 1 for window DCEs,
53 always >= 1 for class DCEs */
56 static struct list dce_list = LIST_INIT(dce_list);
58 static BOOL CALLBACK dc_hook( HDC hDC, WORD code, DWORD_PTR data, LPARAM lParam );
60 static const WCHAR displayW[] = { 'D','I','S','P','L','A','Y',0 };
63 /***********************************************************************
66 static void dump_rdw_flags(UINT flags)
69 if (flags & RDW_INVALIDATE) TRACE(" RDW_INVALIDATE");
70 if (flags & RDW_INTERNALPAINT) TRACE(" RDW_INTERNALPAINT");
71 if (flags & RDW_ERASE) TRACE(" RDW_ERASE");
72 if (flags & RDW_VALIDATE) TRACE(" RDW_VALIDATE");
73 if (flags & RDW_NOINTERNALPAINT) TRACE(" RDW_NOINTERNALPAINT");
74 if (flags & RDW_NOERASE) TRACE(" RDW_NOERASE");
75 if (flags & RDW_NOCHILDREN) TRACE(" RDW_NOCHILDREN");
76 if (flags & RDW_ALLCHILDREN) TRACE(" RDW_ALLCHILDREN");
77 if (flags & RDW_UPDATENOW) TRACE(" RDW_UPDATENOW");
78 if (flags & RDW_ERASENOW) TRACE(" RDW_ERASENOW");
79 if (flags & RDW_FRAME) TRACE(" RDW_FRAME");
80 if (flags & RDW_NOFRAME) TRACE(" RDW_NOFRAME");
87 RDW_NOINTERNALPAINT | \
96 if (flags & ~RDW_FLAGS) TRACE(" %04x", flags & ~RDW_FLAGS);
102 /***********************************************************************
103 * update_visible_region
105 * Set the visible region and X11 drawable for the DC associated to
108 static void update_visible_region( struct dce *dce )
113 DWORD flags = dce->flags;
115 RECT win_rect, top_rect;
117 /* don't clip siblings if using parent clip region */
118 if (flags & DCX_PARENTCLIP) flags &= ~DCX_CLIPSIBLINGS;
120 /* fetch the visible region from the server */
123 RGNDATA *data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) + size - 1 );
126 SERVER_START_REQ( get_visible_region )
128 req->window = wine_server_user_handle( dce->hwnd );
130 wine_server_set_reply( req, data->Buffer, size );
131 if (!(status = wine_server_call( req )))
133 size_t reply_size = wine_server_reply_size( reply );
134 data->rdh.dwSize = sizeof(data->rdh);
135 data->rdh.iType = RDH_RECTANGLES;
136 data->rdh.nCount = reply_size / sizeof(RECT);
137 data->rdh.nRgnSize = reply_size;
138 vis_rgn = ExtCreateRegion( NULL, size, data );
140 top_win = wine_server_ptr_handle( reply->top_win );
141 win_rect.left = reply->win_rect.left;
142 win_rect.top = reply->win_rect.top;
143 win_rect.right = reply->win_rect.right;
144 win_rect.bottom = reply->win_rect.bottom;
145 top_rect.left = reply->top_rect.left;
146 top_rect.top = reply->top_rect.top;
147 top_rect.right = reply->top_rect.right;
148 top_rect.bottom = reply->top_rect.bottom;
150 else size = reply->total_size;
153 HeapFree( GetProcessHeap(), 0, data );
154 } while (status == STATUS_BUFFER_OVERFLOW);
156 if (status || !vis_rgn) return;
158 USER_Driver->pGetDC( dce->hdc, dce->hwnd, top_win, &win_rect, &top_rect, flags );
160 if (dce->clip_rgn) CombineRgn( vis_rgn, vis_rgn, dce->clip_rgn,
161 (flags & DCX_INTERSECTRGN) ? RGN_AND : RGN_DIFF );
163 /* map region to DC coordinates */
164 OffsetRgn( vis_rgn, -win_rect.left, -win_rect.top );
165 SelectVisRgn( dce->hdc, vis_rgn );
166 DeleteObject( vis_rgn );
170 /***********************************************************************
173 static void release_dce( struct dce *dce )
175 if (!dce->hwnd) return; /* already released */
177 USER_Driver->pReleaseDC( dce->hwnd, dce->hdc );
179 if (dce->clip_rgn) DeleteObject( dce->clip_rgn );
182 dce->flags &= DCX_CACHE;
186 /***********************************************************************
189 static void delete_clip_rgn( struct dce *dce )
191 if (!dce->clip_rgn) return; /* nothing to do */
193 dce->flags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN);
194 DeleteObject( dce->clip_rgn );
197 /* make it dirty so that the vis rgn gets recomputed next time */
198 SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
202 /***********************************************************************
205 * Allocate a new DCE.
207 static struct dce *alloc_dce(void)
211 if (!(dce = HeapAlloc( GetProcessHeap(), 0, sizeof(*dce) ))) return NULL;
212 if (!(dce->hdc = CreateDCW( displayW, NULL, NULL, NULL )))
214 HeapFree( GetProcessHeap(), 0, dce );
224 /* store DCE handle in DC hook data field */
225 SetDCHook( dce->hdc, dc_hook, (DWORD_PTR)dce );
226 SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
231 /***********************************************************************
234 static struct dce *get_window_dce( HWND hwnd )
237 WND *win = WIN_GetPtr( hwnd );
239 if (!win || win == WND_OTHER_PROCESS || win == WND_DESKTOP) return NULL;
242 if (!dce && (dce = get_class_dce( win->class )))
247 WIN_ReleasePtr( win );
249 if (!dce) /* try to allocate one */
251 struct dce *dce_to_free = NULL;
252 LONG class_style = GetClassLongW( hwnd, GCL_STYLE );
254 if (class_style & CS_CLASSDC)
256 if (!(dce = alloc_dce())) return NULL;
258 win = WIN_GetPtr( hwnd );
259 if (win && win != WND_OTHER_PROCESS && win != WND_DESKTOP)
261 if (win->dce) /* another thread beat us to it */
266 else if ((win->dce = set_class_dce( win->class, dce )) != dce)
275 list_add_tail( &dce_list, &dce->entry );
277 WIN_ReleasePtr( win );
279 else dce_to_free = dce;
281 else if (class_style & CS_OWNDC)
283 if (!(dce = alloc_dce())) return NULL;
285 win = WIN_GetPtr( hwnd );
286 if (win && win != WND_OTHER_PROCESS && win != WND_DESKTOP)
288 if (win->dwStyle & WS_CLIPCHILDREN) dce->flags |= DCX_CLIPCHILDREN;
289 if (win->dwStyle & WS_CLIPSIBLINGS) dce->flags |= DCX_CLIPSIBLINGS;
290 if (win->dce) /* another thread beat us to it */
299 list_add_tail( &dce_list, &dce->entry );
301 WIN_ReleasePtr( win );
303 else dce_to_free = dce;
308 SetDCHook( dce->hdc, NULL, 0 );
309 DeleteDC( dce->hdc );
310 HeapFree( GetProcessHeap(), 0, dce );
317 /***********************************************************************
320 * Free a class or window DCE.
322 void free_dce( struct dce *dce, HWND hwnd )
330 /* turn it into a cache entry */
332 dce->flags |= DCX_CACHE;
334 else if (dce->hwnd == hwnd)
340 /* now check for cache DCEs */
344 LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
346 if (dce->hwnd != hwnd) continue;
347 if (!(dce->flags & DCX_CACHE)) continue;
349 if (dce->count) WARN( "GetDC() without ReleaseDC() for window %p\n", hwnd );
359 /***********************************************************************
362 * Mark the associated DC as dirty to force a refresh of the visible region
364 static void make_dc_dirty( struct dce *dce )
368 /* Don't bother with visible regions of unused DCEs */
369 TRACE("\tpurged %p dce [%p]\n", dce, dce->hwnd);
374 /* Set dirty bits in the hDC and DCE structs */
375 TRACE("\tfixed up %p dce [%p]\n", dce, dce->hwnd);
376 SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
381 /***********************************************************************
384 * It is called from SetWindowPos() - we have to
385 * mark as dirty all busy DCEs for windows that have pWnd->parent as
386 * an ancestor and whose client rect intersects with specified update
387 * rectangle. In addition, pWnd->parent DCEs may need to be updated if
388 * DCX_CLIPCHILDREN flag is set.
390 void invalidate_dce( HWND hwnd, const RECT *rect )
392 RECT window_rect, extra_rect;
394 HWND hwndScope = GetAncestor( hwnd, GA_PARENT );
396 if (!hwndScope) return;
398 GetWindowRect( hwnd, &window_rect );
402 MapWindowPoints( hwndScope, 0, (POINT *)&extra_rect, 2 );
405 TRACE("%p scope hwnd = %p %s (%s)\n",
406 hwnd, hwndScope, wine_dbgstr_rect(&window_rect), wine_dbgstr_rect(rect) );
408 /* walk all DCEs and fixup non-empty entries */
411 LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
413 TRACE( "%p: hwnd %p dcx %08x %s %s\n", dce, dce->hwnd, dce->flags,
414 (dce->flags & DCX_CACHE) ? "Cache" : "Owned", dce->count ? "InUse" : "" );
416 if (!dce->hwnd) continue;
417 if ((dce->hwnd == hwndScope) && !(dce->flags & DCX_CLIPCHILDREN))
418 continue; /* child window positions don't bother us */
420 /* if DCE window is a child of hwnd, it has to be invalidated */
421 if (dce->hwnd == hwnd || IsChild( hwnd, dce->hwnd ))
423 make_dc_dirty( dce );
425 else /* otherwise check if the window rectangle intersects this DCE window */
427 if (hwndScope == GetDesktopWindow() ||
428 hwndScope == dce->hwnd || IsChild( hwndScope, dce->hwnd ))
431 GetWindowRect( dce->hwnd, &dce_rect );
432 if (IntersectRect( &tmp, &dce_rect, &window_rect ) ||
433 (rect && IntersectRect( &tmp, &dce_rect, &extra_rect )))
434 make_dc_dirty( dce );
441 /***********************************************************************
444 * Implementation of ReleaseDC.
446 static INT release_dc( HWND hwnd, HDC hdc, BOOL end_paint )
451 TRACE("%p %p\n", hwnd, hdc );
454 dce = (struct dce *)GetDCHook( hdc, NULL );
455 if (dce && dce->count)
457 if (end_paint || (dce->flags & DCX_CACHE)) delete_clip_rgn( dce );
458 if (dce->flags & DCX_CACHE) dce->count = 0;
466 /***********************************************************************
469 * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
471 static BOOL CALLBACK dc_hook( HDC hDC, WORD code, DWORD_PTR data, LPARAM lParam )
474 struct dce *dce = (struct dce *)data;
476 TRACE("hDC = %p, %u\n", hDC, code);
479 assert( dce->hdc == hDC );
483 case DCHC_INVALIDVISRGN:
484 /* GDI code calls this when it detects that the
485 * DC is dirty (usually after SetHookFlags()). This
486 * means that we have to recompute the visible region.
488 if (dce->count) update_visible_region( dce );
489 else /* non-fatal but shouldn't happen */
490 WARN("DC is not in use!\n");
494 * Windows will not let you delete a DC that is busy
495 * (between GetDC and ReleaseDC)
500 WARN("Application trying to delete a busy DC %p\n", dce->hdc);
505 list_remove( &dce->entry );
506 if (dce->clip_rgn) DeleteObject( dce->clip_rgn );
507 HeapFree( GetProcessHeap(), 0, dce );
516 /***********************************************************************
519 * Return update region (in screen coordinates) for a window.
521 static HRGN get_update_region( HWND hwnd, UINT *flags, HWND *child )
530 if (!(data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) + size - 1 )))
532 SetLastError( ERROR_OUTOFMEMORY );
536 SERVER_START_REQ( get_update_region )
538 req->window = wine_server_user_handle( hwnd );
539 req->from_child = wine_server_user_handle( child ? *child : 0 );
541 wine_server_set_reply( req, data->Buffer, size );
542 if (!(status = wine_server_call( req )))
544 size_t reply_size = wine_server_reply_size( reply );
545 data->rdh.dwSize = sizeof(data->rdh);
546 data->rdh.iType = RDH_RECTANGLES;
547 data->rdh.nCount = reply_size / sizeof(RECT);
548 data->rdh.nRgnSize = reply_size;
549 hrgn = ExtCreateRegion( NULL, size, data );
550 if (child) *child = wine_server_ptr_handle( reply->child );
551 *flags = reply->flags;
553 else size = reply->total_size;
556 HeapFree( GetProcessHeap(), 0, data );
557 } while (status == STATUS_BUFFER_OVERFLOW);
559 if (status) SetLastError( RtlNtStatusToDosError(status) );
564 /***********************************************************************
567 * Get only the update flags, not the update region.
569 static BOOL get_update_flags( HWND hwnd, HWND *child, UINT *flags )
573 SERVER_START_REQ( get_update_region )
575 req->window = wine_server_user_handle( hwnd );
576 req->from_child = wine_server_user_handle( child ? *child : 0 );
577 req->flags = *flags | UPDATE_NOREGION;
578 if ((ret = !wine_server_call_err( req )))
580 if (child) *child = wine_server_ptr_handle( reply->child );
581 *flags = reply->flags;
589 /***********************************************************************
590 * redraw_window_rects
592 * Redraw part of a window.
594 static BOOL redraw_window_rects( HWND hwnd, UINT flags, const RECT *rects, UINT count )
598 if (!(flags & (RDW_INVALIDATE|RDW_VALIDATE|RDW_INTERNALPAINT|RDW_NOINTERNALPAINT)))
599 return TRUE; /* nothing to do */
601 SERVER_START_REQ( redraw_window )
603 req->window = wine_server_user_handle( hwnd );
605 wine_server_add_data( req, rects, count * sizeof(RECT) );
606 ret = !wine_server_call_err( req );
613 /***********************************************************************
616 * Send a WM_NCPAINT message if needed, and return the resulting update region (in screen coords).
617 * Helper for erase_now and BeginPaint.
619 static HRGN send_ncpaint( HWND hwnd, HWND *child, UINT *flags )
621 HRGN whole_rgn = get_update_region( hwnd, flags, child );
624 if (child) hwnd = *child;
626 if (hwnd == GetDesktopWindow()) return whole_rgn;
633 /* check if update rgn overlaps with nonclient area */
634 type = GetRgnBox( whole_rgn, &update );
635 GetClientRect( hwnd, &client );
636 MapWindowPoints( hwnd, 0, (POINT *)&client, 2 );
638 if ((*flags & UPDATE_NONCLIENT) ||
639 update.left < client.left || update.top < client.top ||
640 update.right > client.right || update.bottom > client.bottom)
642 client_rgn = CreateRectRgnIndirect( &client );
643 CombineRgn( client_rgn, client_rgn, whole_rgn, RGN_AND );
645 /* check if update rgn contains complete nonclient area */
646 if (type == SIMPLEREGION)
649 GetWindowRect( hwnd, &window );
650 if (EqualRect( &window, &update ))
652 DeleteObject( whole_rgn );
659 client_rgn = whole_rgn;
663 if (whole_rgn) /* NOTE: WM_NCPAINT allows wParam to be 1 */
665 if (*flags & UPDATE_NONCLIENT) SendMessageW( hwnd, WM_NCPAINT, (WPARAM)whole_rgn, 0 );
666 if (whole_rgn > (HRGN)1) DeleteObject( whole_rgn );
673 /***********************************************************************
676 * Send a WM_ERASEBKGND message if needed, and optionally return the DC for painting.
677 * If a DC is requested, the region is selected into it. In all cases the region is deleted.
678 * Helper for erase_now and BeginPaint.
680 static BOOL send_erase( HWND hwnd, UINT flags, HRGN client_rgn,
681 RECT *clip_rect, HDC *hdc_ret )
683 BOOL need_erase = (flags & UPDATE_DELAYED_ERASE) != 0;
687 if (!clip_rect) clip_rect = &dummy;
688 if (hdc_ret || (flags & UPDATE_ERASE))
690 UINT dcx_flags = DCX_INTERSECTRGN | DCX_USESTYLE;
691 if (IsIconic(hwnd)) dcx_flags |= DCX_WINDOW;
693 if ((hdc = GetDCEx( hwnd, client_rgn, dcx_flags )))
695 INT type = GetClipBox( hdc, clip_rect );
697 if (flags & UPDATE_ERASE)
699 /* don't erase if the clip box is empty */
700 if (type != NULLREGION)
701 need_erase = !SendMessageW( hwnd, WM_ERASEBKGND, (WPARAM)hdc, 0 );
703 if (!hdc_ret) release_dc( hwnd, hdc, TRUE );
706 if (hdc_ret) *hdc_ret = hdc;
708 if (!hdc) DeleteObject( client_rgn );
713 /***********************************************************************
716 * Implementation of RDW_ERASENOW behavior.
718 void erase_now( HWND hwnd, UINT rdw_flags )
722 BOOL need_erase = FALSE;
724 /* loop while we find a child to repaint */
727 UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE;
729 if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
730 else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
731 if (need_erase) flags |= UPDATE_DELAYED_ERASE;
733 if (!(hrgn = send_ncpaint( hwnd, &child, &flags ))) break;
734 need_erase = send_erase( child, flags, hrgn, NULL, NULL );
736 if (!flags) break; /* nothing more to do */
737 if ((rdw_flags & RDW_NOCHILDREN) && !need_erase) break;
742 /***********************************************************************
745 * Implementation of RDW_UPDATENOW behavior.
747 * FIXME: Windows uses WM_SYNCPAINT to cut down the number of intertask
748 * SendMessage() calls. This is a comment inside DefWindowProc() source
751 * This message avoids lots of inter-app message traffic
752 * by switching to the other task and continuing the
756 * LOWORD(lParam) = hrgnClip
757 * HIWORD(lParam) = hwndSkip (not used; always NULL)
760 static void update_now( HWND hwnd, UINT rdw_flags )
764 /* desktop window never gets WM_PAINT, only WM_ERASEBKGND */
765 if (hwnd == GetDesktopWindow()) erase_now( hwnd, rdw_flags | RDW_NOCHILDREN );
767 /* loop while we find a child to repaint */
770 UINT flags = UPDATE_PAINT | UPDATE_INTERNALPAINT;
772 if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
773 else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
775 if (!get_update_flags( hwnd, &child, &flags )) break;
776 if (!flags) break; /* nothing more to do */
778 SendMessageW( child, WM_PAINT, 0, 0 );
779 if (rdw_flags & RDW_NOCHILDREN) break;
784 /*************************************************************************
787 * Helper for ScrollWindowEx:
788 * If the return value is 0, no special caret handling is necessary.
789 * Otherwise the return value is the handle of the window that owns the
790 * caret. Its caret needs to be hidden during the scroll operation and
791 * moved to new_caret_pos if move_caret is TRUE.
793 static HWND fix_caret(HWND hWnd, const RECT *scroll_rect, INT dx, INT dy,
794 UINT flags, LPBOOL move_caret, LPPOINT new_caret_pos)
797 RECT rect, mapped_rcCaret;
798 BOOL hide_caret = FALSE;
800 if (!GetGUIThreadInfo( GetCurrentThreadId(), &info )) return 0;
801 if (!info.hwndCaret) return 0;
803 if (info.hwndCaret == hWnd)
805 /* Move the caret if it's (partially) in the source rectangle */
806 if (IntersectRect(&rect, scroll_rect, &info.rcCaret))
810 new_caret_pos->x = info.rcCaret.left + dx;
811 new_caret_pos->y = info.rcCaret.top + dy;
817 /* Hide the caret if it's in the destination rectangle */
819 OffsetRect(&rect, dx, dy);
820 hide_caret = IntersectRect(&rect, &rect, &info.rcCaret);
825 if ((flags & SW_SCROLLCHILDREN) && IsChild(hWnd, info.hwndCaret))
829 /* Hide the caret if it's in the source or in the destination
831 mapped_rcCaret = info.rcCaret;
832 MapWindowPoints(info.hwndCaret, hWnd, (LPPOINT)&mapped_rcCaret, 2);
834 if (IntersectRect(&rect, scroll_rect, &mapped_rcCaret))
841 OffsetRect(&rect, dx, dy);
842 hide_caret = IntersectRect(&rect, &rect, &mapped_rcCaret);
851 HideCaret(info.hwndCaret);
852 return info.hwndCaret;
859 /***********************************************************************
860 * BeginPaint (USER32.@)
862 HDC WINAPI BeginPaint( HWND hwnd, PAINTSTRUCT *lps )
865 UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE | UPDATE_PAINT | UPDATE_INTERNALPAINT | UPDATE_NOCHILDREN;
871 if (!(hrgn = send_ncpaint( hwnd, NULL, &flags ))) return 0;
873 lps->fErase = send_erase( hwnd, flags, hrgn, &lps->rcPaint, &lps->hdc );
875 TRACE("hdc = %p box = (%s), fErase = %d\n",
876 lps->hdc, wine_dbgstr_rect(&lps->rcPaint), lps->fErase);
882 /***********************************************************************
883 * EndPaint (USER32.@)
885 BOOL WINAPI EndPaint( HWND hwnd, const PAINTSTRUCT *lps )
887 if (!lps) return FALSE;
888 release_dc( hwnd, lps->hdc, TRUE );
894 /***********************************************************************
897 HDC WINAPI GetDCEx( HWND hwnd, HRGN hrgnClip, DWORD flags )
899 static const DWORD clip_flags = DCX_PARENTCLIP | DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN | DCX_WINDOW;
901 BOOL bUpdateVisRgn = TRUE;
903 LONG window_style = GetWindowLongW( hwnd, GWL_STYLE );
905 if (!hwnd) hwnd = GetDesktopWindow();
906 else hwnd = WIN_GetFullHandle( hwnd );
908 TRACE("hwnd %p, hrgnClip %p, flags %08x\n", hwnd, hrgnClip, flags);
912 if (flags & (DCX_WINDOW | DCX_PARENTCLIP)) flags |= DCX_CACHE;
914 if (flags & DCX_USESTYLE)
916 flags &= ~(DCX_CLIPCHILDREN | DCX_CLIPSIBLINGS | DCX_PARENTCLIP);
918 if (window_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
920 if (!(flags & DCX_WINDOW))
922 if (GetClassLongW( hwnd, GCL_STYLE ) & CS_PARENTDC) flags |= DCX_PARENTCLIP;
924 if (window_style & WS_CLIPCHILDREN && !(window_style & WS_MINIMIZE))
925 flags |= DCX_CLIPCHILDREN;
929 if (flags & DCX_WINDOW) flags &= ~DCX_CLIPCHILDREN;
931 parent = GetAncestor( hwnd, GA_PARENT );
932 if (!parent || (parent == GetDesktopWindow()))
933 flags = (flags & ~DCX_PARENTCLIP) | DCX_CLIPSIBLINGS;
935 /* it seems parent clip is ignored when clipping siblings or children */
936 if (flags & (DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN)) flags &= ~DCX_PARENTCLIP;
938 if( flags & DCX_PARENTCLIP )
940 LONG parent_style = GetWindowLongW( parent, GWL_STYLE );
941 if( (window_style & WS_VISIBLE) && (parent_style & WS_VISIBLE) )
943 flags &= ~DCX_CLIPCHILDREN;
944 if (parent_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
948 /* find a suitable DCE */
950 if ((flags & DCX_CACHE) || !(dce = get_window_dce( hwnd )))
952 struct dce *dceEmpty = NULL, *dceUnused = NULL;
954 /* Strategy: First, we attempt to find a non-empty but unused DCE with
955 * compatible flags. Next, we look for an empty entry. If the cache is
956 * full we have to purge one of the unused entries.
959 LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
961 if ((dce->flags & DCX_CACHE) && !dce->count)
965 if (!dce->hwnd) dceEmpty = dce;
966 else if ((dce->hwnd == hwnd) && !((dce->flags ^ flags) & clip_flags))
968 TRACE("\tfound valid %p dce [%p], flags %08x\n",
969 dce, hwnd, dce->flags );
970 bUpdateVisRgn = FALSE;
976 if (&dce->entry == &dce_list) /* nothing found */
977 dce = dceEmpty ? dceEmpty : dceUnused;
979 if (dce) dce->count = 1;
983 /* if there's no dce empty or unused, allocate a new one */
986 if (!(dce = alloc_dce())) return 0;
987 dce->flags = DCX_CACHE;
989 list_add_head( &dce_list, &dce->entry );
995 flags |= DCX_NORESETATTRS;
996 if (dce->hwnd == hwnd)
998 TRACE("\tskipping hVisRgn update\n");
999 bUpdateVisRgn = FALSE; /* updated automatically, via DCHook() */
1003 /* we should free dce->clip_rgn here, but Windows apparently doesn't */
1004 dce->flags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN);
1009 if (flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN))
1011 /* if the extra clip region has changed, get rid of the old one */
1012 if (dce->clip_rgn != hrgnClip || ((flags ^ dce->flags) & (DCX_INTERSECTRGN | DCX_EXCLUDERGN)))
1013 delete_clip_rgn( dce );
1014 dce->clip_rgn = hrgnClip;
1015 if (!dce->clip_rgn) dce->clip_rgn = CreateRectRgn( 0, 0, 0, 0 );
1016 dce->flags |= flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN);
1017 bUpdateVisRgn = TRUE;
1021 dce->flags = (dce->flags & ~clip_flags) | (flags & clip_flags);
1023 if (SetHookFlags( dce->hdc, DCHF_VALIDATEVISRGN )) bUpdateVisRgn = TRUE; /* DC was dirty */
1025 if (bUpdateVisRgn) update_visible_region( dce );
1027 if (!(flags & DCX_NORESETATTRS))
1029 RestoreDC( dce->hdc, 1 ); /* initial save level is always 1 */
1030 SaveDC( dce->hdc ); /* save the state again for next time */
1033 TRACE("(%p,%p,0x%x): returning %p\n", hwnd, hrgnClip, flags, dce->hdc);
1038 /***********************************************************************
1041 * Get a device context.
1044 * Success: Handle to the device context
1047 HDC WINAPI GetDC( HWND hwnd )
1049 if (!hwnd) return GetDCEx( 0, 0, DCX_CACHE | DCX_WINDOW );
1050 return GetDCEx( hwnd, 0, DCX_USESTYLE );
1054 /***********************************************************************
1055 * GetWindowDC (USER32.@)
1057 HDC WINAPI GetWindowDC( HWND hwnd )
1059 return GetDCEx( hwnd, 0, DCX_USESTYLE | DCX_WINDOW );
1063 /***********************************************************************
1064 * ReleaseDC (USER32.@)
1066 * Release a device context.
1069 * Success: Non-zero. Resources used by hdc are released.
1072 INT WINAPI ReleaseDC( HWND hwnd, HDC hdc )
1074 return release_dc( hwnd, hdc, FALSE );
1078 /**********************************************************************
1079 * WindowFromDC (USER32.@)
1081 HWND WINAPI WindowFromDC( HDC hdc )
1087 dce = (struct dce *)GetDCHook( hdc, NULL );
1088 if (dce) hwnd = dce->hwnd;
1094 /***********************************************************************
1095 * LockWindowUpdate (USER32.@)
1097 * Enables or disables painting in the chosen window.
1100 * hwnd [I] handle to a window.
1103 * If successful, returns nonzero value. Otherwise,
1107 * You can lock only one window at a time.
1109 BOOL WINAPI LockWindowUpdate( HWND hwnd )
1111 static HWND lockedWnd;
1113 /* This function is fully implemented by the following patch:
1115 * http://www.winehq.org/hypermail/wine-patches/2004/01/0142.html
1117 * but in order to work properly, it needs the ability to invalidate
1118 * DCEs in other processes when the lock window is changed, which
1119 * isn't possible yet.
1123 FIXME("(%p), partial stub!\n",hwnd);
1130 /* Unlock lockedWnd */
1131 /* FIXME: Do something */
1135 /* Attempted to lock a second window */
1136 /* Return FALSE and do nothing */
1147 /***********************************************************************
1148 * RedrawWindow (USER32.@)
1150 BOOL WINAPI RedrawWindow( HWND hwnd, const RECT *rect, HRGN hrgn, UINT flags )
1152 static const RECT empty;
1155 if (!hwnd) hwnd = GetDesktopWindow();
1162 GetRgnBox( hrgn, &r );
1163 TRACE( "%p region %p box %s ", hwnd, hrgn, wine_dbgstr_rect(&r) );
1166 TRACE( "%p rect %s ", hwnd, wine_dbgstr_rect(rect) );
1168 TRACE( "%p whole window ", hwnd );
1170 dump_rdw_flags(flags);
1173 /* process pending expose events before painting */
1174 if (flags & RDW_UPDATENOW) USER_Driver->pMsgWaitForMultipleObjectsEx( 0, NULL, 0, QS_PAINT, 0 );
1178 if (IsRectEmpty( rect )) rect = ∅
1179 ret = redraw_window_rects( hwnd, flags, rect, 1 );
1183 ret = redraw_window_rects( hwnd, flags, NULL, 0 );
1185 else /* need to build a list of the region rectangles */
1188 RGNDATA *data = NULL;
1190 if (!(size = GetRegionData( hrgn, 0, NULL ))) return FALSE;
1191 if (!(data = HeapAlloc( GetProcessHeap(), 0, size ))) return FALSE;
1192 GetRegionData( hrgn, size, data );
1193 if (!data->rdh.nCount) /* empty region -> use a single all-zero rectangle */
1194 ret = redraw_window_rects( hwnd, flags, &empty, 1 );
1196 ret = redraw_window_rects( hwnd, flags, (const RECT *)data->Buffer, data->rdh.nCount );
1197 HeapFree( GetProcessHeap(), 0, data );
1200 if (flags & RDW_UPDATENOW) update_now( hwnd, flags );
1201 else if (flags & RDW_ERASENOW) erase_now( hwnd, flags );
1207 /***********************************************************************
1208 * UpdateWindow (USER32.@)
1210 BOOL WINAPI UpdateWindow( HWND hwnd )
1212 return RedrawWindow( hwnd, NULL, 0, RDW_UPDATENOW | RDW_ALLCHILDREN );
1216 /***********************************************************************
1217 * InvalidateRgn (USER32.@)
1219 BOOL WINAPI InvalidateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
1223 SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1227 return RedrawWindow(hwnd, NULL, hrgn, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
1231 /***********************************************************************
1232 * InvalidateRect (USER32.@)
1234 * MSDN: if hwnd parameter is NULL, InvalidateRect invalidates and redraws
1235 * all windows and sends WM_ERASEBKGND and WM_NCPAINT.
1237 BOOL WINAPI InvalidateRect( HWND hwnd, const RECT *rect, BOOL erase )
1239 UINT flags = RDW_INVALIDATE | (erase ? RDW_ERASE : 0);
1243 flags = RDW_ALLCHILDREN | RDW_INVALIDATE | RDW_FRAME | RDW_ERASE | RDW_ERASENOW;
1247 return RedrawWindow( hwnd, rect, 0, flags );
1251 /***********************************************************************
1252 * ValidateRgn (USER32.@)
1254 BOOL WINAPI ValidateRgn( HWND hwnd, HRGN hrgn )
1258 SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1262 return RedrawWindow( hwnd, NULL, hrgn, RDW_VALIDATE );
1266 /***********************************************************************
1267 * ValidateRect (USER32.@)
1269 * MSDN: if hwnd parameter is NULL, ValidateRect invalidates and redraws
1270 * all windows and sends WM_ERASEBKGND and WM_NCPAINT.
1272 BOOL WINAPI ValidateRect( HWND hwnd, const RECT *rect )
1274 UINT flags = RDW_VALIDATE;
1278 flags = RDW_ALLCHILDREN | RDW_INVALIDATE | RDW_FRAME | RDW_ERASE | RDW_ERASENOW;
1282 return RedrawWindow( hwnd, rect, 0, flags );
1286 /***********************************************************************
1287 * GetUpdateRgn (USER32.@)
1289 INT WINAPI GetUpdateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
1292 UINT flags = UPDATE_NOCHILDREN;
1295 if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
1297 if ((update_rgn = send_ncpaint( hwnd, NULL, &flags )))
1301 retval = CombineRgn( hrgn, update_rgn, 0, RGN_COPY );
1302 if (send_erase( hwnd, flags, update_rgn, NULL, NULL ))
1304 flags = UPDATE_DELAYED_ERASE;
1305 get_update_flags( hwnd, NULL, &flags );
1307 /* map region to client coordinates */
1308 offset.x = offset.y = 0;
1309 ScreenToClient( hwnd, &offset );
1310 OffsetRgn( hrgn, offset.x, offset.y );
1316 /***********************************************************************
1317 * GetUpdateRect (USER32.@)
1319 BOOL WINAPI GetUpdateRect( HWND hwnd, LPRECT rect, BOOL erase )
1321 UINT flags = UPDATE_NOCHILDREN;
1325 if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
1327 if (!(update_rgn = send_ncpaint( hwnd, NULL, &flags ))) return FALSE;
1331 if (GetRgnBox( update_rgn, rect ) != NULLREGION)
1333 HDC hdc = GetDCEx( hwnd, 0, DCX_USESTYLE );
1334 MapWindowPoints( 0, hwnd, (LPPOINT)rect, 2 );
1335 DPtoLP( hdc, (LPPOINT)rect, 2 );
1336 ReleaseDC( hwnd, hdc );
1339 need_erase = send_erase( hwnd, flags, update_rgn, NULL, NULL );
1341 /* check if we still have an update region */
1342 flags = UPDATE_PAINT | UPDATE_NOCHILDREN;
1343 if (need_erase) flags |= UPDATE_DELAYED_ERASE;
1344 return (get_update_flags( hwnd, NULL, &flags ) && (flags & UPDATE_PAINT));
1348 /***********************************************************************
1349 * ExcludeUpdateRgn (USER32.@)
1351 INT WINAPI ExcludeUpdateRgn( HDC hdc, HWND hwnd )
1353 HRGN update_rgn = CreateRectRgn( 0, 0, 0, 0 );
1354 INT ret = GetUpdateRgn( hwnd, update_rgn, FALSE );
1360 GetDCOrgEx( hdc, &pt );
1361 MapWindowPoints( 0, hwnd, &pt, 1 );
1362 OffsetRgn( update_rgn, -pt.x, -pt.y );
1363 ret = ExtSelectClipRgn( hdc, update_rgn, RGN_DIFF );
1364 DeleteObject( update_rgn );
1370 /*************************************************************************
1371 * ScrollWindowEx (USER32.@)
1373 * Note: contrary to what the doc says, pixels that are scrolled from the
1374 * outside of clipRect to the inside are NOT painted.
1377 INT WINAPI ScrollWindowEx( HWND hwnd, INT dx, INT dy,
1378 const RECT *rect, const RECT *clipRect,
1379 HRGN hrgnUpdate, LPRECT rcUpdate,
1382 INT retVal = NULLREGION;
1383 BOOL bOwnRgn = TRUE;
1384 BOOL bUpdate = (rcUpdate || hrgnUpdate || flags & (SW_INVALIDATE | SW_ERASE));
1387 HRGN hrgnWinupd = 0;
1390 HWND hwndCaret = NULL;
1391 BOOL moveCaret = FALSE;
1394 TRACE( "%p, %d,%d hrgnUpdate=%p rcUpdate = %p %s %04x\n",
1395 hwnd, dx, dy, hrgnUpdate, rcUpdate, wine_dbgstr_rect(rect), flags );
1396 TRACE( "clipRect = %s\n", wine_dbgstr_rect(clipRect));
1397 if( flags & ~( SW_SCROLLCHILDREN | SW_INVALIDATE | SW_ERASE))
1398 FIXME("some flags (%04x) are unhandled\n", flags);
1400 rdw_flags = (flags & SW_ERASE) && (flags & SW_INVALIDATE) ?
1401 RDW_INVALIDATE | RDW_ERASE : RDW_INVALIDATE ;
1403 if (!WIN_IsWindowDrawable( hwnd, TRUE )) return ERROR;
1404 hwnd = WIN_GetFullHandle( hwnd );
1406 GetClientRect(hwnd, &rc);
1407 if (rect) IntersectRect(&rc, &rc, rect);
1409 if (clipRect) IntersectRect(&cliprc,&rc,clipRect);
1412 if( hrgnUpdate ) bOwnRgn = FALSE;
1413 else if( bUpdate ) hrgnUpdate = CreateRectRgn( 0, 0, 0, 0 );
1415 newCaretPos.x = newCaretPos.y = 0;
1417 if( !IsRectEmpty(&cliprc) && (dx || dy)) {
1418 DWORD dcxflags = DCX_CACHE;
1419 DWORD style = GetWindowLongW( hwnd, GWL_STYLE );
1421 hwndCaret = fix_caret(hwnd, &rc, dx, dy, flags, &moveCaret, &newCaretPos);
1423 if( style & WS_CLIPSIBLINGS) dcxflags |= DCX_CLIPSIBLINGS;
1424 if( GetClassLongW( hwnd, GCL_STYLE ) & CS_PARENTDC)
1425 dcxflags |= DCX_PARENTCLIP;
1426 if( !(flags & SW_SCROLLCHILDREN) && (style & WS_CLIPCHILDREN))
1427 dcxflags |= DCX_CLIPCHILDREN;
1428 hDC = GetDCEx( hwnd, 0, dcxflags);
1431 ScrollDC( hDC, dx, dy, &rc, &cliprc, hrgnUpdate, rcUpdate );
1433 ReleaseDC( hwnd, hDC );
1436 RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags);
1439 /* If the windows has an update region, this must be
1440 * scrolled as well. Keep a copy in hrgnWinupd
1441 * to be added to hrngUpdate at the end. */
1442 hrgnTemp = CreateRectRgn( 0, 0, 0, 0 );
1443 retVal = GetUpdateRgn( hwnd, hrgnTemp, FALSE );
1444 if (retVal != NULLREGION)
1446 HRGN hrgnClip = CreateRectRgnIndirect(&cliprc);
1448 hrgnWinupd = CreateRectRgn( 0, 0, 0, 0);
1449 CombineRgn( hrgnWinupd, hrgnTemp, 0, RGN_COPY);
1451 OffsetRgn( hrgnTemp, dx, dy );
1452 CombineRgn( hrgnTemp, hrgnTemp, hrgnClip, RGN_AND );
1454 CombineRgn( hrgnWinupd, hrgnWinupd, hrgnTemp, RGN_OR );
1455 RedrawWindow( hwnd, NULL, hrgnTemp, rdw_flags);
1457 /* Catch the case where the scrolling amount exceeds the size of the
1458 * original window. This generated a second update area that is the
1459 * location where the original scrolled content would end up.
1460 * This second region is not returned by the ScrollDC and sets
1461 * ScrollWindowEx apart from just a ScrollDC.
1463 * This has been verified with testing on windows.
1465 if (abs(dx) > abs(rc.right - rc.left) ||
1466 abs(dy) > abs(rc.bottom - rc.top))
1468 SetRectRgn( hrgnTemp, rc.left + dx, rc.top + dy, rc.right+dx, rc.bottom + dy);
1469 CombineRgn( hrgnTemp, hrgnTemp, hrgnClip, RGN_AND );
1470 CombineRgn( hrgnUpdate, hrgnUpdate, hrgnTemp, RGN_OR );
1473 CombineRgn( hrgnWinupd, hrgnWinupd, hrgnTemp, RGN_OR );
1475 DeleteObject( hrgnClip );
1477 DeleteObject( hrgnTemp );
1479 /* nothing was scrolled */
1481 SetRectRgn( hrgnUpdate, 0, 0, 0, 0 );
1482 SetRectEmpty( rcUpdate);
1485 if( flags & SW_SCROLLCHILDREN )
1487 HWND *list = WIN_ListChildren( hwnd );
1492 for (i = 0; list[i]; i++)
1494 GetWindowRect( list[i], &r );
1495 MapWindowPoints( 0, hwnd, (POINT *)&r, 2 );
1496 if (!rect || IntersectRect(&dummy, &r, rect))
1497 SetWindowPos( list[i], 0, r.left + dx, r.top + dy, 0, 0,
1498 SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE |
1499 SWP_NOREDRAW | SWP_DEFERERASE );
1501 HeapFree( GetProcessHeap(), 0, list );
1505 if( flags & (SW_INVALIDATE | SW_ERASE) )
1506 RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags |
1507 ((flags & SW_SCROLLCHILDREN) ? RDW_ALLCHILDREN : 0 ) );
1510 CombineRgn( hrgnUpdate, hrgnUpdate, hrgnWinupd, RGN_OR);
1511 DeleteObject( hrgnWinupd);
1515 if ( moveCaret ) SetCaretPos( newCaretPos.x, newCaretPos.y );
1516 ShowCaret(hwndCaret);
1519 if( bOwnRgn && hrgnUpdate ) DeleteObject( hrgnUpdate );
1525 /*************************************************************************
1526 * ScrollWindow (USER32.@)
1529 BOOL WINAPI ScrollWindow( HWND hwnd, INT dx, INT dy,
1530 const RECT *rect, const RECT *clipRect )
1532 return (ERROR != ScrollWindowEx( hwnd, dx, dy, rect, clipRect, 0, NULL,
1533 (rect ? 0 : SW_SCROLLCHILDREN) |
1534 SW_INVALIDATE | SW_ERASE ));
1538 /*************************************************************************
1539 * ScrollDC (USER32.@)
1541 * dx, dy, lprcScroll and lprcClip are all in logical coordinates (msdn is
1542 * wrong) hrgnUpdate is returned in device coordinates with rcUpdate in
1543 * logical coordinates.
1545 BOOL WINAPI ScrollDC( HDC hdc, INT dx, INT dy, const RECT *lprcScroll,
1546 const RECT *lprcClip, HRGN hrgnUpdate, LPRECT lprcUpdate )
1549 return USER_Driver->pScrollDC( hdc, dx, dy, lprcScroll, lprcClip, hrgnUpdate, lprcUpdate );