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/gdi_driver.h"
40 #include "wine/list.h"
41 #include "wine/debug.h"
43 WINE_DEFAULT_DEBUG_CHANNEL(win);
48 struct list entry; /* entry in global DCE list */
53 LONG count; /* usage count; 0 or 1 for cache DCEs, always 1 for window DCEs,
54 always >= 1 for class DCEs */
57 static struct list dce_list = LIST_INIT(dce_list);
59 static BOOL CALLBACK dc_hook( HDC hDC, WORD code, DWORD_PTR data, LPARAM lParam );
61 static const WCHAR displayW[] = { 'D','I','S','P','L','A','Y',0 };
64 /***********************************************************************
67 static void dump_rdw_flags(UINT flags)
70 if (flags & RDW_INVALIDATE) TRACE(" RDW_INVALIDATE");
71 if (flags & RDW_INTERNALPAINT) TRACE(" RDW_INTERNALPAINT");
72 if (flags & RDW_ERASE) TRACE(" RDW_ERASE");
73 if (flags & RDW_VALIDATE) TRACE(" RDW_VALIDATE");
74 if (flags & RDW_NOINTERNALPAINT) TRACE(" RDW_NOINTERNALPAINT");
75 if (flags & RDW_NOERASE) TRACE(" RDW_NOERASE");
76 if (flags & RDW_NOCHILDREN) TRACE(" RDW_NOCHILDREN");
77 if (flags & RDW_ALLCHILDREN) TRACE(" RDW_ALLCHILDREN");
78 if (flags & RDW_UPDATENOW) TRACE(" RDW_UPDATENOW");
79 if (flags & RDW_ERASENOW) TRACE(" RDW_ERASENOW");
80 if (flags & RDW_FRAME) TRACE(" RDW_FRAME");
81 if (flags & RDW_NOFRAME) TRACE(" RDW_NOFRAME");
88 RDW_NOINTERNALPAINT | \
97 if (flags & ~RDW_FLAGS) TRACE(" %04x", flags & ~RDW_FLAGS);
103 /***********************************************************************
104 * update_visible_region
106 * Set the visible region and X11 drawable for the DC associated to
109 static void update_visible_region( struct dce *dce )
111 struct window_surface *surface = NULL;
115 DWORD flags = dce->flags;
117 RECT win_rect, top_rect;
120 /* don't clip siblings if using parent clip region */
121 if (flags & DCX_PARENTCLIP) flags &= ~DCX_CLIPSIBLINGS;
123 /* fetch the visible region from the server */
126 RGNDATA *data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) + size - 1 );
129 SERVER_START_REQ( get_visible_region )
131 req->window = wine_server_user_handle( dce->hwnd );
133 wine_server_set_reply( req, data->Buffer, size );
134 if (!(status = wine_server_call( req )))
136 size_t reply_size = wine_server_reply_size( reply );
137 data->rdh.dwSize = sizeof(data->rdh);
138 data->rdh.iType = RDH_RECTANGLES;
139 data->rdh.nCount = reply_size / sizeof(RECT);
140 data->rdh.nRgnSize = reply_size;
141 vis_rgn = ExtCreateRegion( NULL, size, data );
143 top_win = wine_server_ptr_handle( reply->top_win );
144 win_rect.left = reply->win_rect.left;
145 win_rect.top = reply->win_rect.top;
146 win_rect.right = reply->win_rect.right;
147 win_rect.bottom = reply->win_rect.bottom;
148 top_rect.left = reply->top_rect.left;
149 top_rect.top = reply->top_rect.top;
150 top_rect.right = reply->top_rect.right;
151 top_rect.bottom = reply->top_rect.bottom;
153 else size = reply->total_size;
156 HeapFree( GetProcessHeap(), 0, data );
157 } while (status == STATUS_BUFFER_OVERFLOW);
159 if (status || !vis_rgn) return;
161 USER_Driver->pGetDC( dce->hdc, dce->hwnd, top_win, &win_rect, &top_rect, flags );
163 if (dce->clip_rgn) CombineRgn( vis_rgn, vis_rgn, dce->clip_rgn,
164 (flags & DCX_INTERSECTRGN) ? RGN_AND : RGN_DIFF );
166 if ((win = WIN_GetPtr( top_win )) && win != WND_DESKTOP && win != WND_OTHER_PROCESS)
168 surface = win->surface;
169 if (surface) window_surface_add_ref( surface );
170 WIN_ReleasePtr( win );
173 if (!surface) top_rect = get_virtual_screen_rect();
174 __wine_set_visible_region( dce->hdc, vis_rgn, &win_rect, &top_rect, surface );
175 if (surface) window_surface_release( surface );
179 /***********************************************************************
182 static void reset_dce_attrs( struct dce *dce )
184 RestoreDC( dce->hdc, 1 ); /* initial save level is always 1 */
185 SaveDC( dce->hdc ); /* save the state again for next time */
189 /***********************************************************************
192 static void release_dce( struct dce *dce )
196 if (!dce->hwnd) return; /* already released */
198 vis_rect = get_virtual_screen_rect();
199 __wine_set_visible_region( dce->hdc, 0, &vis_rect, &vis_rect, NULL );
200 USER_Driver->pReleaseDC( dce->hwnd, dce->hdc );
202 if (dce->clip_rgn) DeleteObject( dce->clip_rgn );
205 dce->flags &= DCX_CACHE;
209 /***********************************************************************
212 static void delete_clip_rgn( struct dce *dce )
214 if (!dce->clip_rgn) return; /* nothing to do */
216 dce->flags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN);
217 DeleteObject( dce->clip_rgn );
220 /* make it dirty so that the vis rgn gets recomputed next time */
221 SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
225 /***********************************************************************
228 * Allocate a new DCE.
230 static struct dce *alloc_dce(void)
234 if (!(dce = HeapAlloc( GetProcessHeap(), 0, sizeof(*dce) ))) return NULL;
235 if (!(dce->hdc = CreateDCW( displayW, NULL, NULL, NULL )))
237 HeapFree( GetProcessHeap(), 0, dce );
247 /* store DCE handle in DC hook data field */
248 SetDCHook( dce->hdc, dc_hook, (DWORD_PTR)dce );
249 SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
254 /***********************************************************************
257 static struct dce *get_window_dce( HWND hwnd )
260 WND *win = WIN_GetPtr( hwnd );
262 if (!win || win == WND_OTHER_PROCESS || win == WND_DESKTOP) return NULL;
265 if (!dce && (dce = get_class_dce( win->class )))
270 WIN_ReleasePtr( win );
272 if (!dce) /* try to allocate one */
274 struct dce *dce_to_free = NULL;
275 LONG class_style = GetClassLongW( hwnd, GCL_STYLE );
277 if (class_style & CS_CLASSDC)
279 if (!(dce = alloc_dce())) return NULL;
281 win = WIN_GetPtr( hwnd );
282 if (win && win != WND_OTHER_PROCESS && win != WND_DESKTOP)
284 if (win->dce) /* another thread beat us to it */
289 else if ((win->dce = set_class_dce( win->class, dce )) != dce)
298 list_add_tail( &dce_list, &dce->entry );
300 WIN_ReleasePtr( win );
302 else dce_to_free = dce;
304 else if (class_style & CS_OWNDC)
306 if (!(dce = alloc_dce())) return NULL;
308 win = WIN_GetPtr( hwnd );
309 if (win && win != WND_OTHER_PROCESS && win != WND_DESKTOP)
311 if (win->dwStyle & WS_CLIPCHILDREN) dce->flags |= DCX_CLIPCHILDREN;
312 if (win->dwStyle & WS_CLIPSIBLINGS) dce->flags |= DCX_CLIPSIBLINGS;
313 if (win->dce) /* another thread beat us to it */
323 list_add_tail( &dce_list, &dce->entry );
325 WIN_ReleasePtr( win );
327 else dce_to_free = dce;
332 SetDCHook( dce_to_free->hdc, NULL, 0 );
333 DeleteDC( dce_to_free->hdc );
334 HeapFree( GetProcessHeap(), 0, dce_to_free );
335 if (dce_to_free == dce)
343 /***********************************************************************
346 * Free a class or window DCE.
348 void free_dce( struct dce *dce, HWND hwnd )
356 /* turn it into a cache entry */
357 reset_dce_attrs( dce );
359 dce->flags |= DCX_CACHE;
361 else if (dce->hwnd == hwnd)
367 /* now check for cache DCEs */
371 LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
373 if (dce->hwnd != hwnd) continue;
374 if (!(dce->flags & DCX_CACHE)) continue;
376 if (dce->count) WARN( "GetDC() without ReleaseDC() for window %p\n", hwnd );
386 /***********************************************************************
389 * Mark the associated DC as dirty to force a refresh of the visible region
391 static void make_dc_dirty( struct dce *dce )
395 /* Don't bother with visible regions of unused DCEs */
396 TRACE("\tpurged %p dce [%p]\n", dce, dce->hwnd);
401 /* Set dirty bits in the hDC and DCE structs */
402 TRACE("\tfixed up %p dce [%p]\n", dce, dce->hwnd);
403 SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
408 /***********************************************************************
411 * It is called from SetWindowPos() - we have to
412 * mark as dirty all busy DCEs for windows that have pWnd->parent as
413 * an ancestor and whose client rect intersects with specified update
414 * rectangle. In addition, pWnd->parent DCEs may need to be updated if
415 * DCX_CLIPCHILDREN flag is set.
417 void invalidate_dce( WND *win, const RECT *extra_rect )
422 if (!win->parent) return;
424 GetWindowRect( win->obj.handle, &window_rect );
426 TRACE("%p parent %p %s (%s)\n",
427 win->obj.handle, win->parent, wine_dbgstr_rect(&window_rect), wine_dbgstr_rect(extra_rect) );
429 /* walk all DCEs and fixup non-empty entries */
431 LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
433 TRACE( "%p: hwnd %p dcx %08x %s %s\n", dce, dce->hwnd, dce->flags,
434 (dce->flags & DCX_CACHE) ? "Cache" : "Owned", dce->count ? "InUse" : "" );
436 if (!dce->hwnd) continue;
437 if ((dce->hwnd == win->parent) && !(dce->flags & DCX_CLIPCHILDREN))
438 continue; /* child window positions don't bother us */
440 /* if DCE window is a child of hwnd, it has to be invalidated */
441 if (dce->hwnd == win->obj.handle || IsChild( win->obj.handle, dce->hwnd ))
443 make_dc_dirty( dce );
447 /* otherwise check if the window rectangle intersects this DCE window */
448 if (win->parent == dce->hwnd || IsChild( win->parent, dce->hwnd ))
451 GetWindowRect( dce->hwnd, &dce_rect );
452 if (IntersectRect( &tmp, &dce_rect, &window_rect ) ||
453 (extra_rect && IntersectRect( &tmp, &dce_rect, extra_rect )))
454 make_dc_dirty( dce );
459 /***********************************************************************
462 * Implementation of ReleaseDC.
464 static INT release_dc( HWND hwnd, HDC hdc, BOOL end_paint )
469 TRACE("%p %p\n", hwnd, hdc );
472 dce = (struct dce *)GetDCHook( hdc, NULL );
473 if (dce && dce->count)
475 if (!(dce->flags & DCX_NORESETATTRS)) reset_dce_attrs( dce );
476 if (end_paint || (dce->flags & DCX_CACHE)) delete_clip_rgn( dce );
477 if (dce->flags & DCX_CACHE) dce->count = 0;
485 /***********************************************************************
488 * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
490 static BOOL CALLBACK dc_hook( HDC hDC, WORD code, DWORD_PTR data, LPARAM lParam )
493 struct dce *dce = (struct dce *)data;
495 TRACE("hDC = %p, %u\n", hDC, code);
498 assert( dce->hdc == hDC );
502 case DCHC_INVALIDVISRGN:
503 /* GDI code calls this when it detects that the
504 * DC is dirty (usually after SetHookFlags()). This
505 * means that we have to recompute the visible region.
507 if (dce->count) update_visible_region( dce );
508 else /* non-fatal but shouldn't happen */
509 WARN("DC is not in use!\n");
513 * Windows will not let you delete a DC that is busy
514 * (between GetDC and ReleaseDC)
519 WARN("Application trying to delete a busy DC %p\n", dce->hdc);
524 list_remove( &dce->entry );
525 if (dce->clip_rgn) DeleteObject( dce->clip_rgn );
526 HeapFree( GetProcessHeap(), 0, dce );
535 /***********************************************************************
538 * Return update region (in screen coordinates) for a window.
540 static HRGN get_update_region( HWND hwnd, UINT *flags, HWND *child )
549 if (!(data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) + size - 1 )))
551 SetLastError( ERROR_OUTOFMEMORY );
555 SERVER_START_REQ( get_update_region )
557 req->window = wine_server_user_handle( hwnd );
558 req->from_child = wine_server_user_handle( child ? *child : 0 );
560 wine_server_set_reply( req, data->Buffer, size );
561 if (!(status = wine_server_call( req )))
563 size_t reply_size = wine_server_reply_size( reply );
564 data->rdh.dwSize = sizeof(data->rdh);
565 data->rdh.iType = RDH_RECTANGLES;
566 data->rdh.nCount = reply_size / sizeof(RECT);
567 data->rdh.nRgnSize = reply_size;
568 hrgn = ExtCreateRegion( NULL, size, data );
569 if (child) *child = wine_server_ptr_handle( reply->child );
570 *flags = reply->flags;
572 else size = reply->total_size;
575 HeapFree( GetProcessHeap(), 0, data );
576 } while (status == STATUS_BUFFER_OVERFLOW);
578 if (status) SetLastError( RtlNtStatusToDosError(status) );
583 /***********************************************************************
586 * Get only the update flags, not the update region.
588 static BOOL get_update_flags( HWND hwnd, HWND *child, UINT *flags )
592 SERVER_START_REQ( get_update_region )
594 req->window = wine_server_user_handle( hwnd );
595 req->from_child = wine_server_user_handle( child ? *child : 0 );
596 req->flags = *flags | UPDATE_NOREGION;
597 if ((ret = !wine_server_call_err( req )))
599 if (child) *child = wine_server_ptr_handle( reply->child );
600 *flags = reply->flags;
608 /***********************************************************************
609 * redraw_window_rects
611 * Redraw part of a window.
613 static BOOL redraw_window_rects( HWND hwnd, UINT flags, const RECT *rects, UINT count )
617 if (!(flags & (RDW_INVALIDATE|RDW_VALIDATE|RDW_INTERNALPAINT|RDW_NOINTERNALPAINT)))
618 return TRUE; /* nothing to do */
620 SERVER_START_REQ( redraw_window )
622 req->window = wine_server_user_handle( hwnd );
624 wine_server_add_data( req, rects, count * sizeof(RECT) );
625 ret = !wine_server_call_err( req );
632 /***********************************************************************
635 * Send a WM_NCPAINT message if needed, and return the resulting update region (in screen coords).
636 * Helper for erase_now and BeginPaint.
638 static HRGN send_ncpaint( HWND hwnd, HWND *child, UINT *flags )
640 HRGN whole_rgn = get_update_region( hwnd, flags, child );
643 if (child) hwnd = *child;
645 if (hwnd == GetDesktopWindow()) return whole_rgn;
652 /* check if update rgn overlaps with nonclient area */
653 type = GetRgnBox( whole_rgn, &update );
654 WIN_GetRectangles( hwnd, COORDS_SCREEN, 0, &client );
656 if ((*flags & UPDATE_NONCLIENT) ||
657 update.left < client.left || update.top < client.top ||
658 update.right > client.right || update.bottom > client.bottom)
660 client_rgn = CreateRectRgnIndirect( &client );
661 CombineRgn( client_rgn, client_rgn, whole_rgn, RGN_AND );
663 /* check if update rgn contains complete nonclient area */
664 if (type == SIMPLEREGION)
667 GetWindowRect( hwnd, &window );
668 if (EqualRect( &window, &update ))
670 DeleteObject( whole_rgn );
677 client_rgn = whole_rgn;
681 if (whole_rgn) /* NOTE: WM_NCPAINT allows wParam to be 1 */
683 if (*flags & UPDATE_NONCLIENT) SendMessageW( hwnd, WM_NCPAINT, (WPARAM)whole_rgn, 0 );
684 if (whole_rgn > (HRGN)1) DeleteObject( whole_rgn );
691 /***********************************************************************
694 * Send a WM_ERASEBKGND message if needed, and optionally return the DC for painting.
695 * If a DC is requested, the region is selected into it. In all cases the region is deleted.
696 * Helper for erase_now and BeginPaint.
698 static BOOL send_erase( HWND hwnd, UINT flags, HRGN client_rgn,
699 RECT *clip_rect, HDC *hdc_ret )
701 BOOL need_erase = (flags & UPDATE_DELAYED_ERASE) != 0;
705 if (!clip_rect) clip_rect = &dummy;
706 if (hdc_ret || (flags & UPDATE_ERASE))
708 UINT dcx_flags = DCX_INTERSECTRGN | DCX_USESTYLE;
709 if (IsIconic(hwnd)) dcx_flags |= DCX_WINDOW;
711 if ((hdc = GetDCEx( hwnd, client_rgn, dcx_flags )))
713 INT type = GetClipBox( hdc, clip_rect );
715 if (flags & UPDATE_ERASE)
717 /* don't erase if the clip box is empty */
718 if (type != NULLREGION)
719 need_erase = !SendMessageW( hwnd, WM_ERASEBKGND, (WPARAM)hdc, 0 );
721 if (!hdc_ret) release_dc( hwnd, hdc, TRUE );
724 if (hdc_ret) *hdc_ret = hdc;
726 if (!hdc) DeleteObject( client_rgn );
731 /***********************************************************************
734 * Implementation of RDW_ERASENOW behavior.
736 void erase_now( HWND hwnd, UINT rdw_flags )
740 BOOL need_erase = FALSE;
742 /* loop while we find a child to repaint */
745 UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE;
747 if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
748 else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
749 if (need_erase) flags |= UPDATE_DELAYED_ERASE;
751 if (!(hrgn = send_ncpaint( hwnd, &child, &flags ))) break;
752 need_erase = send_erase( child, flags, hrgn, NULL, NULL );
754 if (!flags) break; /* nothing more to do */
755 if ((rdw_flags & RDW_NOCHILDREN) && !need_erase) break;
760 /***********************************************************************
763 * Move the window bits when a window is resized or its surface recreated.
765 void move_window_bits( HWND hwnd, struct window_surface *old_surface,
766 struct window_surface *new_surface,
767 const RECT *visible_rect, const RECT *old_visible_rect,
768 const RECT *client_rect, const RECT *valid_rects )
770 RECT dst = valid_rects[0];
771 RECT src = valid_rects[1];
773 if (new_surface != old_surface ||
774 src.left - old_visible_rect->left != dst.left - visible_rect->left ||
775 src.top - old_visible_rect->top != dst.top - visible_rect->top)
777 char buffer[FIELD_OFFSET( BITMAPINFO, bmiColors[256] )];
778 BITMAPINFO *info = (BITMAPINFO *)buffer;
780 UINT flags = UPDATE_NOCHILDREN;
781 HRGN rgn = get_update_region( hwnd, &flags, NULL );
782 HDC hdc = GetDCEx( hwnd, rgn, DCX_CACHE | DCX_EXCLUDERGN );
784 OffsetRect( &dst, -client_rect->left, -client_rect->top );
785 TRACE( "copying %s -> %s\n", wine_dbgstr_rect(&src), wine_dbgstr_rect(&dst) );
786 bits = old_surface->funcs->get_info( old_surface, info );
787 old_surface->funcs->lock( old_surface );
788 SetDIBitsToDevice( hdc, dst.left, dst.top, dst.right - dst.left, dst.bottom - dst.top,
789 src.left - old_visible_rect->left - old_surface->rect.left,
790 old_surface->rect.bottom - (src.bottom - old_visible_rect->top),
791 0, old_surface->rect.bottom - old_surface->rect.top,
792 bits, info, DIB_RGB_COLORS );
793 old_surface->funcs->unlock( old_surface );
794 ReleaseDC( hwnd, hdc );
800 /***********************************************************************
803 * Implementation of RDW_UPDATENOW behavior.
805 static void update_now( HWND hwnd, UINT rdw_flags )
809 /* desktop window never gets WM_PAINT, only WM_ERASEBKGND */
810 if (hwnd == GetDesktopWindow()) erase_now( hwnd, rdw_flags | RDW_NOCHILDREN );
812 /* loop while we find a child to repaint */
815 UINT flags = UPDATE_PAINT | UPDATE_INTERNALPAINT;
817 if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
818 else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
820 if (!get_update_flags( hwnd, &child, &flags )) break;
821 if (!flags) break; /* nothing more to do */
823 SendMessageW( child, WM_PAINT, 0, 0 );
824 if (rdw_flags & RDW_NOCHILDREN) break;
829 /*************************************************************************
832 * Helper for ScrollWindowEx:
833 * If the return value is 0, no special caret handling is necessary.
834 * Otherwise the return value is the handle of the window that owns the
835 * caret. Its caret needs to be hidden during the scroll operation and
836 * moved to new_caret_pos if move_caret is TRUE.
838 static HWND fix_caret(HWND hWnd, const RECT *scroll_rect, INT dx, INT dy,
839 UINT flags, LPBOOL move_caret, LPPOINT new_caret_pos)
842 RECT rect, mapped_rcCaret;
843 BOOL hide_caret = FALSE;
845 info.cbSize = sizeof(info);
846 if (!GetGUIThreadInfo( GetCurrentThreadId(), &info )) return 0;
847 if (!info.hwndCaret) return 0;
849 if (info.hwndCaret == hWnd)
851 /* Move the caret if it's (partially) in the source rectangle */
852 if (IntersectRect(&rect, scroll_rect, &info.rcCaret))
856 new_caret_pos->x = info.rcCaret.left + dx;
857 new_caret_pos->y = info.rcCaret.top + dy;
863 /* Hide the caret if it's in the destination rectangle */
865 OffsetRect(&rect, dx, dy);
866 hide_caret = IntersectRect(&rect, &rect, &info.rcCaret);
871 if ((flags & SW_SCROLLCHILDREN) && IsChild(hWnd, info.hwndCaret))
875 /* Hide the caret if it's in the source or in the destination
877 mapped_rcCaret = info.rcCaret;
878 MapWindowPoints(info.hwndCaret, hWnd, (LPPOINT)&mapped_rcCaret, 2);
880 if (IntersectRect(&rect, scroll_rect, &mapped_rcCaret))
887 OffsetRect(&rect, dx, dy);
888 hide_caret = IntersectRect(&rect, &rect, &mapped_rcCaret);
897 HideCaret(info.hwndCaret);
898 return info.hwndCaret;
905 /***********************************************************************
906 * BeginPaint (USER32.@)
908 HDC WINAPI BeginPaint( HWND hwnd, PAINTSTRUCT *lps )
911 UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE | UPDATE_PAINT | UPDATE_INTERNALPAINT | UPDATE_NOCHILDREN;
917 if (!(hrgn = send_ncpaint( hwnd, NULL, &flags ))) return 0;
919 lps->fErase = send_erase( hwnd, flags, hrgn, &lps->rcPaint, &lps->hdc );
921 TRACE("hdc = %p box = (%s), fErase = %d\n",
922 lps->hdc, wine_dbgstr_rect(&lps->rcPaint), lps->fErase);
928 /***********************************************************************
929 * EndPaint (USER32.@)
931 BOOL WINAPI EndPaint( HWND hwnd, const PAINTSTRUCT *lps )
933 if (!lps) return FALSE;
934 release_dc( hwnd, lps->hdc, TRUE );
936 flush_window_surfaces( FALSE );
941 /***********************************************************************
944 HDC WINAPI GetDCEx( HWND hwnd, HRGN hrgnClip, DWORD flags )
946 const DWORD clip_flags = DCX_PARENTCLIP | DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN | DCX_WINDOW;
947 const DWORD user_flags = clip_flags | DCX_NORESETATTRS; /* flags that can be set by user */
949 BOOL bUpdateVisRgn = TRUE;
951 LONG window_style = GetWindowLongW( hwnd, GWL_STYLE );
953 if (!hwnd) hwnd = GetDesktopWindow();
954 else hwnd = WIN_GetFullHandle( hwnd );
956 TRACE("hwnd %p, hrgnClip %p, flags %08x\n", hwnd, hrgnClip, flags);
958 if (!IsWindow(hwnd)) return 0;
962 if (flags & (DCX_WINDOW | DCX_PARENTCLIP)) flags |= DCX_CACHE;
964 if (flags & DCX_USESTYLE)
966 flags &= ~(DCX_CLIPCHILDREN | DCX_CLIPSIBLINGS | DCX_PARENTCLIP);
968 if (window_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
970 if (!(flags & DCX_WINDOW))
972 if (GetClassLongW( hwnd, GCL_STYLE ) & CS_PARENTDC) flags |= DCX_PARENTCLIP;
974 if (window_style & WS_CLIPCHILDREN && !(window_style & WS_MINIMIZE))
975 flags |= DCX_CLIPCHILDREN;
979 if (flags & DCX_WINDOW) flags &= ~DCX_CLIPCHILDREN;
981 parent = GetAncestor( hwnd, GA_PARENT );
982 if (!parent || (parent == GetDesktopWindow()))
983 flags = (flags & ~DCX_PARENTCLIP) | DCX_CLIPSIBLINGS;
985 /* it seems parent clip is ignored when clipping siblings or children */
986 if (flags & (DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN)) flags &= ~DCX_PARENTCLIP;
988 if( flags & DCX_PARENTCLIP )
990 LONG parent_style = GetWindowLongW( parent, GWL_STYLE );
991 if( (window_style & WS_VISIBLE) && (parent_style & WS_VISIBLE) )
993 flags &= ~DCX_CLIPCHILDREN;
994 if (parent_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
998 /* find a suitable DCE */
1000 if ((flags & DCX_CACHE) || !(dce = get_window_dce( hwnd )))
1002 struct dce *dceEmpty = NULL, *dceUnused = NULL;
1004 /* Strategy: First, we attempt to find a non-empty but unused DCE with
1005 * compatible flags. Next, we look for an empty entry. If the cache is
1006 * full we have to purge one of the unused entries.
1009 LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
1011 if ((dce->flags & DCX_CACHE) && !dce->count)
1015 if (!dce->hwnd) dceEmpty = dce;
1016 else if ((dce->hwnd == hwnd) && !((dce->flags ^ flags) & clip_flags))
1018 TRACE("\tfound valid %p dce [%p], flags %08x\n",
1019 dce, hwnd, dce->flags );
1020 bUpdateVisRgn = FALSE;
1026 if (&dce->entry == &dce_list) /* nothing found */
1027 dce = dceEmpty ? dceEmpty : dceUnused;
1029 if (dce) dce->count = 1;
1033 /* if there's no dce empty or unused, allocate a new one */
1036 if (!(dce = alloc_dce())) return 0;
1037 dce->flags = DCX_CACHE;
1039 list_add_head( &dce_list, &dce->entry );
1045 flags |= DCX_NORESETATTRS;
1046 if (dce->hwnd == hwnd)
1048 TRACE("\tskipping hVisRgn update\n");
1049 bUpdateVisRgn = FALSE; /* updated automatically, via DCHook() */
1053 /* we should free dce->clip_rgn here, but Windows apparently doesn't */
1054 dce->flags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN);
1059 if (flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN))
1061 /* if the extra clip region has changed, get rid of the old one */
1062 if (dce->clip_rgn != hrgnClip || ((flags ^ dce->flags) & (DCX_INTERSECTRGN | DCX_EXCLUDERGN)))
1063 delete_clip_rgn( dce );
1064 dce->clip_rgn = hrgnClip;
1065 if (!dce->clip_rgn) dce->clip_rgn = CreateRectRgn( 0, 0, 0, 0 );
1066 dce->flags |= flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN);
1067 bUpdateVisRgn = TRUE;
1070 if (GetWindowLongW( hwnd, GWL_EXSTYLE ) & WS_EX_LAYOUTRTL) SetLayout( dce->hdc, LAYOUT_RTL );
1073 dce->flags = (dce->flags & ~user_flags) | (flags & user_flags);
1075 if (SetHookFlags( dce->hdc, DCHF_VALIDATEVISRGN )) bUpdateVisRgn = TRUE; /* DC was dirty */
1077 if (bUpdateVisRgn) update_visible_region( dce );
1079 TRACE("(%p,%p,0x%x): returning %p\n", hwnd, hrgnClip, flags, dce->hdc);
1084 /***********************************************************************
1087 * Get a device context.
1090 * Success: Handle to the device context
1093 HDC WINAPI GetDC( HWND hwnd )
1095 if (!hwnd) return GetDCEx( 0, 0, DCX_CACHE | DCX_WINDOW );
1096 return GetDCEx( hwnd, 0, DCX_USESTYLE );
1100 /***********************************************************************
1101 * GetWindowDC (USER32.@)
1103 HDC WINAPI GetWindowDC( HWND hwnd )
1105 return GetDCEx( hwnd, 0, DCX_USESTYLE | DCX_WINDOW );
1109 /***********************************************************************
1110 * ReleaseDC (USER32.@)
1112 * Release a device context.
1115 * Success: Non-zero. Resources used by hdc are released.
1118 INT WINAPI ReleaseDC( HWND hwnd, HDC hdc )
1120 return release_dc( hwnd, hdc, FALSE );
1124 /**********************************************************************
1125 * WindowFromDC (USER32.@)
1127 HWND WINAPI WindowFromDC( HDC hdc )
1133 dce = (struct dce *)GetDCHook( hdc, NULL );
1134 if (dce) hwnd = dce->hwnd;
1140 /***********************************************************************
1141 * LockWindowUpdate (USER32.@)
1143 * Enables or disables painting in the chosen window.
1146 * hwnd [I] handle to a window.
1149 * If successful, returns nonzero value. Otherwise,
1153 * You can lock only one window at a time.
1155 BOOL WINAPI LockWindowUpdate( HWND hwnd )
1157 static HWND lockedWnd;
1159 FIXME("(%p), partial stub!\n",hwnd);
1166 /* Unlock lockedWnd */
1167 /* FIXME: Do something */
1171 /* Attempted to lock a second window */
1172 /* Return FALSE and do nothing */
1183 /***********************************************************************
1184 * RedrawWindow (USER32.@)
1186 BOOL WINAPI RedrawWindow( HWND hwnd, const RECT *rect, HRGN hrgn, UINT flags )
1188 static const RECT empty;
1191 if (!hwnd) hwnd = GetDesktopWindow();
1198 GetRgnBox( hrgn, &r );
1199 TRACE( "%p region %p box %s ", hwnd, hrgn, wine_dbgstr_rect(&r) );
1202 TRACE( "%p rect %s ", hwnd, wine_dbgstr_rect(rect) );
1204 TRACE( "%p whole window ", hwnd );
1206 dump_rdw_flags(flags);
1209 /* process pending expose events before painting */
1210 if (flags & RDW_UPDATENOW) USER_Driver->pMsgWaitForMultipleObjectsEx( 0, NULL, 0, QS_PAINT, 0 );
1214 if (IsRectEmpty( rect )) rect = ∅
1215 ret = redraw_window_rects( hwnd, flags, rect, 1 );
1219 ret = redraw_window_rects( hwnd, flags, NULL, 0 );
1221 else /* need to build a list of the region rectangles */
1224 RGNDATA *data = NULL;
1226 if (!(size = GetRegionData( hrgn, 0, NULL ))) return FALSE;
1227 if (!(data = HeapAlloc( GetProcessHeap(), 0, size ))) return FALSE;
1228 GetRegionData( hrgn, size, data );
1229 if (!data->rdh.nCount) /* empty region -> use a single all-zero rectangle */
1230 ret = redraw_window_rects( hwnd, flags, &empty, 1 );
1232 ret = redraw_window_rects( hwnd, flags, (const RECT *)data->Buffer, data->rdh.nCount );
1233 HeapFree( GetProcessHeap(), 0, data );
1236 if (flags & RDW_UPDATENOW) update_now( hwnd, flags );
1237 else if (flags & RDW_ERASENOW) erase_now( hwnd, flags );
1243 /***********************************************************************
1244 * UpdateWindow (USER32.@)
1246 BOOL WINAPI UpdateWindow( HWND hwnd )
1250 SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1254 return RedrawWindow( hwnd, NULL, 0, RDW_UPDATENOW | RDW_ALLCHILDREN );
1258 /***********************************************************************
1259 * InvalidateRgn (USER32.@)
1261 BOOL WINAPI InvalidateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
1265 SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1269 return RedrawWindow(hwnd, NULL, hrgn, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
1273 /***********************************************************************
1274 * InvalidateRect (USER32.@)
1276 * MSDN: if hwnd parameter is NULL, InvalidateRect invalidates and redraws
1277 * all windows and sends WM_ERASEBKGND and WM_NCPAINT.
1279 BOOL WINAPI InvalidateRect( HWND hwnd, const RECT *rect, BOOL erase )
1281 UINT flags = RDW_INVALIDATE | (erase ? RDW_ERASE : 0);
1285 flags = RDW_ALLCHILDREN | RDW_INVALIDATE | RDW_FRAME | RDW_ERASE | RDW_ERASENOW;
1289 return RedrawWindow( hwnd, rect, 0, flags );
1293 /***********************************************************************
1294 * ValidateRgn (USER32.@)
1296 BOOL WINAPI ValidateRgn( HWND hwnd, HRGN hrgn )
1300 SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1304 return RedrawWindow( hwnd, NULL, hrgn, RDW_VALIDATE );
1308 /***********************************************************************
1309 * ValidateRect (USER32.@)
1311 * MSDN: if hwnd parameter is NULL, ValidateRect invalidates and redraws
1312 * all windows and sends WM_ERASEBKGND and WM_NCPAINT.
1314 BOOL WINAPI ValidateRect( HWND hwnd, const RECT *rect )
1316 UINT flags = RDW_VALIDATE;
1320 flags = RDW_ALLCHILDREN | RDW_INVALIDATE | RDW_FRAME | RDW_ERASE | RDW_ERASENOW;
1324 return RedrawWindow( hwnd, rect, 0, flags );
1328 /***********************************************************************
1329 * GetUpdateRgn (USER32.@)
1331 INT WINAPI GetUpdateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
1334 UINT flags = UPDATE_NOCHILDREN;
1337 if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
1339 if ((update_rgn = send_ncpaint( hwnd, NULL, &flags )))
1341 retval = CombineRgn( hrgn, update_rgn, 0, RGN_COPY );
1342 if (send_erase( hwnd, flags, update_rgn, NULL, NULL ))
1344 flags = UPDATE_DELAYED_ERASE;
1345 get_update_flags( hwnd, NULL, &flags );
1347 /* map region to client coordinates */
1348 map_window_region( 0, hwnd, hrgn );
1354 /***********************************************************************
1355 * GetUpdateRect (USER32.@)
1357 BOOL WINAPI GetUpdateRect( HWND hwnd, LPRECT rect, BOOL erase )
1359 UINT flags = UPDATE_NOCHILDREN;
1363 if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
1365 if (!(update_rgn = send_ncpaint( hwnd, NULL, &flags ))) return FALSE;
1369 if (GetRgnBox( update_rgn, rect ) != NULLREGION)
1371 HDC hdc = GetDCEx( hwnd, 0, DCX_USESTYLE );
1372 DWORD layout = SetLayout( hdc, 0 ); /* MapWindowPoints mirrors already */
1373 MapWindowPoints( 0, hwnd, (LPPOINT)rect, 2 );
1374 DPtoLP( hdc, (LPPOINT)rect, 2 );
1375 SetLayout( hdc, layout );
1376 ReleaseDC( hwnd, hdc );
1379 need_erase = send_erase( hwnd, flags, update_rgn, NULL, NULL );
1381 /* check if we still have an update region */
1382 flags = UPDATE_PAINT | UPDATE_NOCHILDREN;
1383 if (need_erase) flags |= UPDATE_DELAYED_ERASE;
1384 return (get_update_flags( hwnd, NULL, &flags ) && (flags & UPDATE_PAINT));
1388 /***********************************************************************
1389 * ExcludeUpdateRgn (USER32.@)
1391 INT WINAPI ExcludeUpdateRgn( HDC hdc, HWND hwnd )
1393 HRGN update_rgn = CreateRectRgn( 0, 0, 0, 0 );
1394 INT ret = GetUpdateRgn( hwnd, update_rgn, FALSE );
1400 GetDCOrgEx( hdc, &pt );
1401 MapWindowPoints( 0, hwnd, &pt, 1 );
1402 OffsetRgn( update_rgn, -pt.x, -pt.y );
1403 ret = ExtSelectClipRgn( hdc, update_rgn, RGN_DIFF );
1404 DeleteObject( update_rgn );
1410 static INT scroll_window( HWND hwnd, INT dx, INT dy, const RECT *rect, const RECT *clipRect,
1411 HRGN hrgnUpdate, LPRECT rcUpdate, UINT flags, BOOL is_ex )
1413 INT retVal = NULLREGION;
1414 BOOL bOwnRgn = TRUE;
1415 BOOL bUpdate = (rcUpdate || hrgnUpdate || flags & (SW_INVALIDATE | SW_ERASE));
1418 HRGN hrgnWinupd = 0;
1421 HWND hwndCaret = NULL;
1422 BOOL moveCaret = FALSE;
1425 TRACE( "%p, %d,%d hrgnUpdate=%p rcUpdate = %p %s %04x\n",
1426 hwnd, dx, dy, hrgnUpdate, rcUpdate, wine_dbgstr_rect(rect), flags );
1427 TRACE( "clipRect = %s\n", wine_dbgstr_rect(clipRect));
1428 if( flags & ~( SW_SCROLLCHILDREN | SW_INVALIDATE | SW_ERASE))
1429 FIXME("some flags (%04x) are unhandled\n", flags);
1431 rdw_flags = (flags & SW_ERASE) && (flags & SW_INVALIDATE) ?
1432 RDW_INVALIDATE | RDW_ERASE : RDW_INVALIDATE ;
1434 if (!WIN_IsWindowDrawable( hwnd, TRUE )) return ERROR;
1435 hwnd = WIN_GetFullHandle( hwnd );
1437 GetClientRect(hwnd, &rc);
1439 if (clipRect) IntersectRect(&cliprc,&rc,clipRect);
1442 if (rect) IntersectRect(&rc, &rc, rect);
1444 if( hrgnUpdate ) bOwnRgn = FALSE;
1445 else if( bUpdate ) hrgnUpdate = CreateRectRgn( 0, 0, 0, 0 );
1447 newCaretPos.x = newCaretPos.y = 0;
1449 if( !IsRectEmpty(&cliprc) && (dx || dy)) {
1451 DWORD style = GetWindowLongW( hwnd, GWL_STYLE );
1453 hwndCaret = fix_caret(hwnd, &rc, dx, dy, flags, &moveCaret, &newCaretPos);
1455 if (is_ex) dcxflags |= DCX_CACHE;
1456 if( style & WS_CLIPSIBLINGS) dcxflags |= DCX_CLIPSIBLINGS;
1457 if( GetClassLongW( hwnd, GCL_STYLE ) & CS_PARENTDC)
1458 dcxflags |= DCX_PARENTCLIP;
1459 if( !(flags & SW_SCROLLCHILDREN) && (style & WS_CLIPCHILDREN))
1460 dcxflags |= DCX_CLIPCHILDREN;
1461 hDC = GetDCEx( hwnd, 0, dcxflags);
1464 ScrollDC( hDC, dx, dy, &rc, &cliprc, hrgnUpdate, rcUpdate );
1466 ReleaseDC( hwnd, hDC );
1469 RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags);
1472 /* If the windows has an update region, this must be
1473 * scrolled as well. Keep a copy in hrgnWinupd
1474 * to be added to hrngUpdate at the end. */
1475 hrgnTemp = CreateRectRgn( 0, 0, 0, 0 );
1476 retVal = GetUpdateRgn( hwnd, hrgnTemp, FALSE );
1477 if (retVal != NULLREGION)
1479 HRGN hrgnClip = CreateRectRgnIndirect(&cliprc);
1481 hrgnWinupd = CreateRectRgn( 0, 0, 0, 0);
1482 CombineRgn( hrgnWinupd, hrgnTemp, 0, RGN_COPY);
1484 OffsetRgn( hrgnTemp, dx, dy );
1485 CombineRgn( hrgnTemp, hrgnTemp, hrgnClip, RGN_AND );
1487 CombineRgn( hrgnWinupd, hrgnWinupd, hrgnTemp, RGN_OR );
1488 RedrawWindow( hwnd, NULL, hrgnTemp, rdw_flags);
1490 /* Catch the case where the scrolling amount exceeds the size of the
1491 * original window. This generated a second update area that is the
1492 * location where the original scrolled content would end up.
1493 * This second region is not returned by the ScrollDC and sets
1494 * ScrollWindowEx apart from just a ScrollDC.
1496 * This has been verified with testing on windows.
1498 if (abs(dx) > abs(rc.right - rc.left) ||
1499 abs(dy) > abs(rc.bottom - rc.top))
1501 SetRectRgn( hrgnTemp, rc.left + dx, rc.top + dy, rc.right+dx, rc.bottom + dy);
1502 CombineRgn( hrgnTemp, hrgnTemp, hrgnClip, RGN_AND );
1503 CombineRgn( hrgnUpdate, hrgnUpdate, hrgnTemp, RGN_OR );
1506 CombineRgn( hrgnWinupd, hrgnWinupd, hrgnTemp, RGN_OR );
1508 DeleteObject( hrgnClip );
1510 DeleteObject( hrgnTemp );
1512 /* nothing was scrolled */
1514 SetRectRgn( hrgnUpdate, 0, 0, 0, 0 );
1515 SetRectEmpty( rcUpdate);
1518 if( flags & SW_SCROLLCHILDREN )
1520 HWND *list = WIN_ListChildren( hwnd );
1525 for (i = 0; list[i]; i++)
1527 WIN_GetRectangles( list[i], COORDS_PARENT, &r, NULL );
1528 if (!rect || IntersectRect(&dummy, &r, rect))
1529 SetWindowPos( list[i], 0, r.left + dx, r.top + dy, 0, 0,
1530 SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE |
1531 SWP_NOREDRAW | SWP_DEFERERASE );
1533 HeapFree( GetProcessHeap(), 0, list );
1537 if( flags & (SW_INVALIDATE | SW_ERASE) )
1538 RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags |
1539 ((flags & SW_SCROLLCHILDREN) ? RDW_ALLCHILDREN : 0 ) );
1542 CombineRgn( hrgnUpdate, hrgnUpdate, hrgnWinupd, RGN_OR);
1543 DeleteObject( hrgnWinupd);
1547 if ( moveCaret ) SetCaretPos( newCaretPos.x, newCaretPos.y );
1548 ShowCaret(hwndCaret);
1551 if( bOwnRgn && hrgnUpdate ) DeleteObject( hrgnUpdate );
1557 /*************************************************************************
1558 * ScrollWindowEx (USER32.@)
1560 * Note: contrary to what the doc says, pixels that are scrolled from the
1561 * outside of clipRect to the inside are NOT painted.
1564 INT WINAPI ScrollWindowEx( HWND hwnd, INT dx, INT dy,
1565 const RECT *rect, const RECT *clipRect,
1566 HRGN hrgnUpdate, LPRECT rcUpdate,
1569 return scroll_window( hwnd, dx, dy, rect, clipRect, hrgnUpdate, rcUpdate, flags, TRUE );
1572 /*************************************************************************
1573 * ScrollWindow (USER32.@)
1576 BOOL WINAPI ScrollWindow( HWND hwnd, INT dx, INT dy,
1577 const RECT *rect, const RECT *clipRect )
1579 return scroll_window( hwnd, dx, dy, rect, clipRect, 0, NULL,
1580 SW_INVALIDATE | SW_ERASE | (rect ? 0 : SW_SCROLLCHILDREN), FALSE ) != ERROR;
1584 /*************************************************************************
1585 * ScrollDC (USER32.@)
1587 * dx, dy, lprcScroll and lprcClip are all in logical coordinates (msdn is
1588 * wrong) hrgnUpdate is returned in device coordinates with rcUpdate in
1589 * logical coordinates.
1591 BOOL WINAPI ScrollDC( HDC hdc, INT dx, INT dy, const RECT *lprcScroll,
1592 const RECT *lprcClip, HRGN hrgnUpdate, LPRECT lprcUpdate )
1595 return USER_Driver->pScrollDC( hdc, dx, dy, lprcScroll, lprcClip, hrgnUpdate, lprcUpdate );
1598 /************************************************************************
1599 * PrintWindow (USER32.@)
1602 BOOL WINAPI PrintWindow(HWND hwnd, HDC hdcBlt, UINT nFlags)
1604 UINT flags = PRF_CHILDREN | PRF_ERASEBKGND | PRF_OWNED | PRF_CLIENT;
1605 if(!(nFlags & PW_CLIENTONLY))
1607 flags |= PRF_NONCLIENT;
1609 SendMessageW(hwnd, WM_PRINT, (WPARAM)hdcBlt, flags);