mscoree/tests: Added some simple tests for GetCORVersion.
[wine] / dlls / user32 / painting.c
1 /*
2  * Window painting functions
3  *
4  * Copyright 1993, 1994, 1995, 2001, 2004, 2005, 2008 Alexandre Julliard
5  * Copyright 1996, 1997, 1999 Alex Korobka
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include "config.h"
23 #include "wine/port.h"
24
25 #include <assert.h>
26 #include <stdarg.h>
27 #include <string.h>
28
29 #include "ntstatus.h"
30 #define WIN32_NO_STATUS
31 #include "windef.h"
32 #include "winbase.h"
33 #include "wingdi.h"
34 #include "winuser.h"
35 #include "wine/server.h"
36 #include "win.h"
37 #include "user_private.h"
38 #include "controls.h"
39 #include "wine/list.h"
40 #include "wine/debug.h"
41
42 WINE_DEFAULT_DEBUG_CHANNEL(win);
43
44
45 struct dce
46 {
47     struct list entry;         /* entry in global DCE list */
48     HDC         hdc;
49     HWND        hwnd;
50     HRGN        clip_rgn;
51     DWORD       flags;
52     LONG        count;         /* usage count; 0 or 1 for cache DCEs, always 1 for window DCEs,
53                                   always >= 1 for class DCEs */
54 };
55
56 static struct list dce_list = LIST_INIT(dce_list);
57
58 static BOOL CALLBACK dc_hook( HDC hDC, WORD code, DWORD_PTR data, LPARAM lParam );
59
60 static const WCHAR displayW[] = { 'D','I','S','P','L','A','Y',0 };
61
62
63 /***********************************************************************
64  *           dump_rdw_flags
65  */
66 static void dump_rdw_flags(UINT flags)
67 {
68     TRACE("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");
81
82 #define RDW_FLAGS \
83     (RDW_INVALIDATE | \
84     RDW_INTERNALPAINT | \
85     RDW_ERASE | \
86     RDW_VALIDATE | \
87     RDW_NOINTERNALPAINT | \
88     RDW_NOERASE | \
89     RDW_NOCHILDREN | \
90     RDW_ALLCHILDREN | \
91     RDW_UPDATENOW | \
92     RDW_ERASENOW | \
93     RDW_FRAME | \
94     RDW_NOFRAME)
95
96     if (flags & ~RDW_FLAGS) TRACE(" %04x", flags & ~RDW_FLAGS);
97     TRACE("\n");
98 #undef RDW_FLAGS
99 }
100
101
102 /***********************************************************************
103  *              update_visible_region
104  *
105  * Set the visible region and X11 drawable for the DC associated to
106  * a given window.
107  */
108 static void update_visible_region( struct dce *dce )
109 {
110     NTSTATUS status;
111     HRGN vis_rgn = 0;
112     HWND top_win = 0;
113     DWORD flags = dce->flags;
114     size_t size = 256;
115     RECT win_rect, top_rect;
116
117     /* don't clip siblings if using parent clip region */
118     if (flags & DCX_PARENTCLIP) flags &= ~DCX_CLIPSIBLINGS;
119
120     /* fetch the visible region from the server */
121     do
122     {
123         RGNDATA *data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) + size - 1 );
124         if (!data) return;
125
126         SERVER_START_REQ( get_visible_region )
127         {
128             req->window  = wine_server_user_handle( dce->hwnd );
129             req->flags   = flags;
130             wine_server_set_reply( req, data->Buffer, size );
131             if (!(status = wine_server_call( req )))
132             {
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 );
139
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;
149             }
150             else size = reply->total_size;
151         }
152         SERVER_END_REQ;
153         HeapFree( GetProcessHeap(), 0, data );
154     } while (status == STATUS_BUFFER_OVERFLOW);
155
156     if (status || !vis_rgn) return;
157
158     USER_Driver->pGetDC( dce->hdc, dce->hwnd, top_win, &win_rect, &top_rect, flags );
159
160     if (dce->clip_rgn) CombineRgn( vis_rgn, vis_rgn, dce->clip_rgn,
161                                    (flags & DCX_INTERSECTRGN) ? RGN_AND : RGN_DIFF );
162
163     __wine_set_visible_region( dce->hdc, vis_rgn, &win_rect );
164 }
165
166
167 /***********************************************************************
168  *              reset_dce_attrs
169  */
170 static void reset_dce_attrs( struct dce *dce )
171 {
172     RestoreDC( dce->hdc, 1 );  /* initial save level is always 1 */
173     SaveDC( dce->hdc );  /* save the state again for next time */
174 }
175
176
177 /***********************************************************************
178  *              release_dce
179  */
180 static void release_dce( struct dce *dce )
181 {
182     if (!dce->hwnd) return;  /* already released */
183
184     USER_Driver->pReleaseDC( dce->hwnd, dce->hdc );
185
186     if (dce->clip_rgn) DeleteObject( dce->clip_rgn );
187     dce->clip_rgn = 0;
188     dce->hwnd     = 0;
189     dce->flags   &= DCX_CACHE;
190 }
191
192
193 /***********************************************************************
194  *   delete_clip_rgn
195  */
196 static void delete_clip_rgn( struct dce *dce )
197 {
198     if (!dce->clip_rgn) return;  /* nothing to do */
199
200     dce->flags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN);
201     DeleteObject( dce->clip_rgn );
202     dce->clip_rgn = 0;
203
204     /* make it dirty so that the vis rgn gets recomputed next time */
205     SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
206 }
207
208
209 /***********************************************************************
210  *           alloc_dce
211  *
212  * Allocate a new DCE.
213  */
214 static struct dce *alloc_dce(void)
215 {
216     struct dce *dce;
217
218     if (!(dce = HeapAlloc( GetProcessHeap(), 0, sizeof(*dce) ))) return NULL;
219     if (!(dce->hdc = CreateDCW( displayW, NULL, NULL, NULL )))
220     {
221         HeapFree( GetProcessHeap(), 0, dce );
222         return 0;
223     }
224     SaveDC( dce->hdc );
225
226     dce->hwnd      = 0;
227     dce->clip_rgn  = 0;
228     dce->flags     = 0;
229     dce->count     = 1;
230
231     /* store DCE handle in DC hook data field */
232     SetDCHook( dce->hdc, dc_hook, (DWORD_PTR)dce );
233     SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
234     return dce;
235 }
236
237
238 /***********************************************************************
239  *              get_window_dce
240  */
241 static struct dce *get_window_dce( HWND hwnd )
242 {
243     struct dce *dce;
244     WND *win = WIN_GetPtr( hwnd );
245
246     if (!win || win == WND_OTHER_PROCESS || win == WND_DESKTOP) return NULL;
247
248     dce = win->dce;
249     if (!dce && (dce = get_class_dce( win->class )))
250     {
251         win->dce = dce;
252         dce->count++;
253     }
254     WIN_ReleasePtr( win );
255
256     if (!dce)  /* try to allocate one */
257     {
258         struct dce *dce_to_free = NULL;
259         LONG class_style = GetClassLongW( hwnd, GCL_STYLE );
260
261         if (class_style & CS_CLASSDC)
262         {
263             if (!(dce = alloc_dce())) return NULL;
264
265             win = WIN_GetPtr( hwnd );
266             if (win && win != WND_OTHER_PROCESS && win != WND_DESKTOP)
267             {
268                 if (win->dce)  /* another thread beat us to it */
269                 {
270                     dce_to_free = dce;
271                     dce = win->dce;
272                 }
273                 else if ((win->dce = set_class_dce( win->class, dce )) != dce)
274                 {
275                     dce_to_free = dce;
276                     dce = win->dce;
277                     dce->count++;
278                 }
279                 else
280                 {
281                     dce->count++;
282                     list_add_tail( &dce_list, &dce->entry );
283                 }
284                 WIN_ReleasePtr( win );
285             }
286             else dce_to_free = dce;
287         }
288         else if (class_style & CS_OWNDC)
289         {
290             if (!(dce = alloc_dce())) return NULL;
291
292             win = WIN_GetPtr( hwnd );
293             if (win && win != WND_OTHER_PROCESS && win != WND_DESKTOP)
294             {
295                 if (win->dwStyle & WS_CLIPCHILDREN) dce->flags |= DCX_CLIPCHILDREN;
296                 if (win->dwStyle & WS_CLIPSIBLINGS) dce->flags |= DCX_CLIPSIBLINGS;
297                 if (win->dce)  /* another thread beat us to it */
298                 {
299                     dce_to_free = dce;
300                     dce = win->dce;
301                 }
302                 else
303                 {
304                     win->dce = dce;
305                     dce->hwnd = hwnd;
306                     dce->count++;
307                     list_add_tail( &dce_list, &dce->entry );
308                 }
309                 WIN_ReleasePtr( win );
310             }
311             else dce_to_free = dce;
312         }
313
314         if (dce_to_free)
315         {
316             SetDCHook( dce->hdc, NULL, 0 );
317             DeleteDC( dce->hdc );
318             HeapFree( GetProcessHeap(), 0, dce );
319         }
320     }
321     return dce;
322 }
323
324
325 /***********************************************************************
326  *           free_dce
327  *
328  * Free a class or window DCE.
329  */
330 void free_dce( struct dce *dce, HWND hwnd )
331 {
332     USER_Lock();
333
334     if (dce)
335     {
336         if (!--dce->count)
337         {
338             /* turn it into a cache entry */
339             reset_dce_attrs( dce );
340             release_dce( dce );
341             dce->flags |= DCX_CACHE;
342         }
343         else if (dce->hwnd == hwnd)
344         {
345             release_dce( dce );
346         }
347     }
348
349     /* now check for cache DCEs */
350
351     if (hwnd)
352     {
353         LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
354         {
355             if (dce->hwnd != hwnd) continue;
356             if (!(dce->flags & DCX_CACHE)) continue;
357
358             if (dce->count) WARN( "GetDC() without ReleaseDC() for window %p\n", hwnd );
359             dce->count = 0;
360             release_dce( dce );
361         }
362     }
363
364     USER_Unlock();
365 }
366
367
368 /***********************************************************************
369  *           make_dc_dirty
370  *
371  * Mark the associated DC as dirty to force a refresh of the visible region
372  */
373 static void make_dc_dirty( struct dce *dce )
374 {
375     if (!dce->count)
376     {
377         /* Don't bother with visible regions of unused DCEs */
378         TRACE("\tpurged %p dce [%p]\n", dce, dce->hwnd);
379         release_dce( dce );
380     }
381     else
382     {
383         /* Set dirty bits in the hDC and DCE structs */
384         TRACE("\tfixed up %p dce [%p]\n", dce, dce->hwnd);
385         SetHookFlags( dce->hdc, DCHF_INVALIDATEVISRGN );
386     }
387 }
388
389
390 /***********************************************************************
391  *   invalidate_dce
392  *
393  * It is called from SetWindowPos() - we have to
394  * mark as dirty all busy DCEs for windows that have pWnd->parent as
395  * an ancestor and whose client rect intersects with specified update
396  * rectangle. In addition, pWnd->parent DCEs may need to be updated if
397  * DCX_CLIPCHILDREN flag is set.
398  */
399 void invalidate_dce( HWND hwnd, const RECT *rect )
400 {
401     RECT window_rect, extra_rect;
402     struct dce *dce;
403     HWND hwndScope = GetAncestor( hwnd, GA_PARENT );
404
405     if (!hwndScope) return;
406
407     GetWindowRect( hwnd, &window_rect );
408     if (rect)
409     {
410         extra_rect = *rect;
411         MapWindowPoints( hwndScope, 0, (POINT *)&extra_rect, 2 );
412     }
413
414     TRACE("%p scope hwnd = %p %s (%s)\n",
415           hwnd, hwndScope, wine_dbgstr_rect(&window_rect), wine_dbgstr_rect(rect) );
416
417     /* walk all DCEs and fixup non-empty entries */
418
419     USER_Lock();
420     LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
421     {
422         TRACE( "%p: hwnd %p dcx %08x %s %s\n", dce, dce->hwnd, dce->flags,
423                (dce->flags & DCX_CACHE) ? "Cache" : "Owned", dce->count ? "InUse" : "" );
424
425         if (!dce->hwnd) continue;
426         if ((dce->hwnd == hwndScope) && !(dce->flags & DCX_CLIPCHILDREN))
427             continue;  /* child window positions don't bother us */
428
429         /* if DCE window is a child of hwnd, it has to be invalidated */
430         if (dce->hwnd == hwnd || IsChild( hwnd, dce->hwnd ))
431         {
432             make_dc_dirty( dce );
433         }
434         else  /* otherwise check if the window rectangle intersects this DCE window */
435         {
436             if (hwndScope == GetDesktopWindow() ||
437                 hwndScope == dce->hwnd || IsChild( hwndScope, dce->hwnd ))
438             {
439                 RECT dce_rect, tmp;
440                 GetWindowRect( dce->hwnd, &dce_rect );
441                 if (IntersectRect( &tmp, &dce_rect, &window_rect ) ||
442                     (rect && IntersectRect( &tmp, &dce_rect, &extra_rect )))
443                     make_dc_dirty( dce );
444             }
445         }
446     }
447     USER_Unlock();
448 }
449
450 /***********************************************************************
451  *              release_dc
452  *
453  * Implementation of ReleaseDC.
454  */
455 static INT release_dc( HWND hwnd, HDC hdc, BOOL end_paint )
456 {
457     struct dce *dce;
458     BOOL ret = FALSE;
459
460     TRACE("%p %p\n", hwnd, hdc );
461
462     USER_Lock();
463     dce = (struct dce *)GetDCHook( hdc, NULL );
464     if (dce && dce->count)
465     {
466         if (!(dce->flags & DCX_NORESETATTRS)) reset_dce_attrs( dce );
467         if (end_paint || (dce->flags & DCX_CACHE)) delete_clip_rgn( dce );
468         if (dce->flags & DCX_CACHE) dce->count = 0;
469         ret = TRUE;
470     }
471     USER_Unlock();
472     return ret;
473 }
474
475
476 /***********************************************************************
477  *              dc_hook
478  *
479  * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
480  */
481 static BOOL CALLBACK dc_hook( HDC hDC, WORD code, DWORD_PTR data, LPARAM lParam )
482 {
483     BOOL retv = TRUE;
484     struct dce *dce = (struct dce *)data;
485
486     TRACE("hDC = %p, %u\n", hDC, code);
487
488     if (!dce) return 0;
489     assert( dce->hdc == hDC );
490
491     switch( code )
492     {
493     case DCHC_INVALIDVISRGN:
494         /* GDI code calls this when it detects that the
495          * DC is dirty (usually after SetHookFlags()). This
496          * means that we have to recompute the visible region.
497          */
498         if (dce->count) update_visible_region( dce );
499         else /* non-fatal but shouldn't happen */
500             WARN("DC is not in use!\n");
501         break;
502     case DCHC_DELETEDC:
503         /*
504          * Windows will not let you delete a DC that is busy
505          * (between GetDC and ReleaseDC)
506          */
507         USER_Lock();
508         if (dce->count > 1)
509         {
510             WARN("Application trying to delete a busy DC %p\n", dce->hdc);
511             retv = FALSE;
512         }
513         else
514         {
515             list_remove( &dce->entry );
516             if (dce->clip_rgn) DeleteObject( dce->clip_rgn );
517             HeapFree( GetProcessHeap(), 0, dce );
518         }
519         USER_Unlock();
520         break;
521     }
522     return retv;
523 }
524
525
526 /***********************************************************************
527  *           get_update_region
528  *
529  * Return update region (in screen coordinates) for a window.
530  */
531 static HRGN get_update_region( HWND hwnd, UINT *flags, HWND *child )
532 {
533     HRGN hrgn = 0;
534     NTSTATUS status;
535     RGNDATA *data;
536     size_t size = 256;
537
538     do
539     {
540         if (!(data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) + size - 1 )))
541         {
542             SetLastError( ERROR_OUTOFMEMORY );
543             return 0;
544         }
545
546         SERVER_START_REQ( get_update_region )
547         {
548             req->window     = wine_server_user_handle( hwnd );
549             req->from_child = wine_server_user_handle( child ? *child : 0 );
550             req->flags      = *flags;
551             wine_server_set_reply( req, data->Buffer, size );
552             if (!(status = wine_server_call( req )))
553             {
554                 size_t reply_size = wine_server_reply_size( reply );
555                 data->rdh.dwSize   = sizeof(data->rdh);
556                 data->rdh.iType    = RDH_RECTANGLES;
557                 data->rdh.nCount   = reply_size / sizeof(RECT);
558                 data->rdh.nRgnSize = reply_size;
559                 hrgn = ExtCreateRegion( NULL, size, data );
560                 if (child) *child = wine_server_ptr_handle( reply->child );
561                 *flags = reply->flags;
562             }
563             else size = reply->total_size;
564         }
565         SERVER_END_REQ;
566         HeapFree( GetProcessHeap(), 0, data );
567     } while (status == STATUS_BUFFER_OVERFLOW);
568
569     if (status) SetLastError( RtlNtStatusToDosError(status) );
570     return hrgn;
571 }
572
573
574 /***********************************************************************
575  *           get_update_flags
576  *
577  * Get only the update flags, not the update region.
578  */
579 static BOOL get_update_flags( HWND hwnd, HWND *child, UINT *flags )
580 {
581     BOOL ret;
582
583     SERVER_START_REQ( get_update_region )
584     {
585         req->window     = wine_server_user_handle( hwnd );
586         req->from_child = wine_server_user_handle( child ? *child : 0 );
587         req->flags      = *flags | UPDATE_NOREGION;
588         if ((ret = !wine_server_call_err( req )))
589         {
590             if (child) *child = wine_server_ptr_handle( reply->child );
591             *flags = reply->flags;
592         }
593     }
594     SERVER_END_REQ;
595     return ret;
596 }
597
598
599 /***********************************************************************
600  *           redraw_window_rects
601  *
602  * Redraw part of a window.
603  */
604 static BOOL redraw_window_rects( HWND hwnd, UINT flags, const RECT *rects, UINT count )
605 {
606     BOOL ret;
607
608     if (!(flags & (RDW_INVALIDATE|RDW_VALIDATE|RDW_INTERNALPAINT|RDW_NOINTERNALPAINT)))
609         return TRUE;  /* nothing to do */
610
611     SERVER_START_REQ( redraw_window )
612     {
613         req->window = wine_server_user_handle( hwnd );
614         req->flags  = flags;
615         wine_server_add_data( req, rects, count * sizeof(RECT) );
616         ret = !wine_server_call_err( req );
617     }
618     SERVER_END_REQ;
619     return ret;
620 }
621
622
623 /***********************************************************************
624  *           send_ncpaint
625  *
626  * Send a WM_NCPAINT message if needed, and return the resulting update region (in screen coords).
627  * Helper for erase_now and BeginPaint.
628  */
629 static HRGN send_ncpaint( HWND hwnd, HWND *child, UINT *flags )
630 {
631     HRGN whole_rgn = get_update_region( hwnd, flags, child );
632     HRGN client_rgn = 0;
633
634     if (child) hwnd = *child;
635
636     if (hwnd == GetDesktopWindow()) return whole_rgn;
637
638     if (whole_rgn)
639     {
640         RECT client, update;
641         INT type;
642
643         /* check if update rgn overlaps with nonclient area */
644         type = GetRgnBox( whole_rgn, &update );
645         GetClientRect( hwnd, &client );
646         MapWindowPoints( hwnd, 0, (POINT *)&client, 2 );
647
648         if ((*flags & UPDATE_NONCLIENT) ||
649             update.left < client.left || update.top < client.top ||
650             update.right > client.right || update.bottom > client.bottom)
651         {
652             client_rgn = CreateRectRgnIndirect( &client );
653             CombineRgn( client_rgn, client_rgn, whole_rgn, RGN_AND );
654
655             /* check if update rgn contains complete nonclient area */
656             if (type == SIMPLEREGION)
657             {
658                 RECT window;
659                 GetWindowRect( hwnd, &window );
660                 if (EqualRect( &window, &update ))
661                 {
662                     DeleteObject( whole_rgn );
663                     whole_rgn = (HRGN)1;
664                 }
665             }
666         }
667         else
668         {
669             client_rgn = whole_rgn;
670             whole_rgn = 0;
671         }
672
673         if (whole_rgn) /* NOTE: WM_NCPAINT allows wParam to be 1 */
674         {
675             if (*flags & UPDATE_NONCLIENT) SendMessageW( hwnd, WM_NCPAINT, (WPARAM)whole_rgn, 0 );
676             if (whole_rgn > (HRGN)1) DeleteObject( whole_rgn );
677         }
678     }
679     return client_rgn;
680 }
681
682
683 /***********************************************************************
684  *           send_erase
685  *
686  * Send a WM_ERASEBKGND message if needed, and optionally return the DC for painting.
687  * If a DC is requested, the region is selected into it. In all cases the region is deleted.
688  * Helper for erase_now and BeginPaint.
689  */
690 static BOOL send_erase( HWND hwnd, UINT flags, HRGN client_rgn,
691                         RECT *clip_rect, HDC *hdc_ret )
692 {
693     BOOL need_erase = (flags & UPDATE_DELAYED_ERASE) != 0;
694     HDC hdc = 0;
695     RECT dummy;
696
697     if (!clip_rect) clip_rect = &dummy;
698     if (hdc_ret || (flags & UPDATE_ERASE))
699     {
700         UINT dcx_flags = DCX_INTERSECTRGN | DCX_USESTYLE;
701         if (IsIconic(hwnd)) dcx_flags |= DCX_WINDOW;
702
703         if ((hdc = GetDCEx( hwnd, client_rgn, dcx_flags )))
704         {
705             INT type = GetClipBox( hdc, clip_rect );
706
707             if (flags & UPDATE_ERASE)
708             {
709                 /* don't erase if the clip box is empty */
710                 if (type != NULLREGION)
711                     need_erase = !SendMessageW( hwnd, WM_ERASEBKGND, (WPARAM)hdc, 0 );
712             }
713             if (!hdc_ret) release_dc( hwnd, hdc, TRUE );
714         }
715
716         if (hdc_ret) *hdc_ret = hdc;
717     }
718     if (!hdc) DeleteObject( client_rgn );
719     return need_erase;
720 }
721
722
723 /***********************************************************************
724  *           erase_now
725  *
726  * Implementation of RDW_ERASENOW behavior.
727  */
728 void erase_now( HWND hwnd, UINT rdw_flags )
729 {
730     HWND child = 0;
731     HRGN hrgn;
732     BOOL need_erase = FALSE;
733
734     /* loop while we find a child to repaint */
735     for (;;)
736     {
737         UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE;
738
739         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
740         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
741         if (need_erase) flags |= UPDATE_DELAYED_ERASE;
742
743         if (!(hrgn = send_ncpaint( hwnd, &child, &flags ))) break;
744         need_erase = send_erase( child, flags, hrgn, NULL, NULL );
745
746         if (!flags) break;  /* nothing more to do */
747         if ((rdw_flags & RDW_NOCHILDREN) && !need_erase) break;
748     }
749 }
750
751
752 /***********************************************************************
753  *           update_now
754  *
755  * Implementation of RDW_UPDATENOW behavior.
756  *
757  * FIXME: Windows uses WM_SYNCPAINT to cut down the number of intertask
758  * SendMessage() calls. This is a comment inside DefWindowProc() source
759  * from 16-bit SDK:
760  *
761  *   This message avoids lots of inter-app message traffic
762  *   by switching to the other task and continuing the
763  *   recursion there.
764  *
765  * wParam         = flags
766  * LOWORD(lParam) = hrgnClip
767  * HIWORD(lParam) = hwndSkip  (not used; always NULL)
768  *
769  */
770 static void update_now( HWND hwnd, UINT rdw_flags )
771 {
772     HWND child = 0;
773
774     /* desktop window never gets WM_PAINT, only WM_ERASEBKGND */
775     if (hwnd == GetDesktopWindow()) erase_now( hwnd, rdw_flags | RDW_NOCHILDREN );
776
777     /* loop while we find a child to repaint */
778     for (;;)
779     {
780         UINT flags = UPDATE_PAINT | UPDATE_INTERNALPAINT;
781
782         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
783         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
784
785         if (!get_update_flags( hwnd, &child, &flags )) break;
786         if (!flags) break;  /* nothing more to do */
787
788         SendMessageW( child, WM_PAINT, 0, 0 );
789         if (rdw_flags & RDW_NOCHILDREN) break;
790     }
791 }
792
793
794 /*************************************************************************
795  *             fix_caret
796  *
797  * Helper for ScrollWindowEx:
798  * If the return value is 0, no special caret handling is necessary.
799  * Otherwise the return value is the handle of the window that owns the
800  * caret. Its caret needs to be hidden during the scroll operation and
801  * moved to new_caret_pos if move_caret is TRUE.
802  */
803 static HWND fix_caret(HWND hWnd, const RECT *scroll_rect, INT dx, INT dy,
804                      UINT flags, LPBOOL move_caret, LPPOINT new_caret_pos)
805 {
806     GUITHREADINFO info;
807     RECT rect, mapped_rcCaret;
808     BOOL hide_caret = FALSE;
809
810     if (!GetGUIThreadInfo( GetCurrentThreadId(), &info )) return 0;
811     if (!info.hwndCaret) return 0;
812     
813     if (info.hwndCaret == hWnd)
814     {
815         /* Move the caret if it's (partially) in the source rectangle */
816         if (IntersectRect(&rect, scroll_rect, &info.rcCaret))
817         {
818             *move_caret = TRUE;
819             hide_caret = TRUE;
820             new_caret_pos->x = info.rcCaret.left + dx;
821             new_caret_pos->y = info.rcCaret.top + dy;
822         }
823         else
824         {
825             *move_caret = FALSE;
826             
827             /* Hide the caret if it's in the destination rectangle */
828             rect = *scroll_rect;
829             OffsetRect(&rect, dx, dy);
830             hide_caret = IntersectRect(&rect, &rect, &info.rcCaret);
831         }
832     }
833     else
834     {
835         if ((flags & SW_SCROLLCHILDREN) && IsChild(hWnd, info.hwndCaret))
836         {
837             *move_caret = FALSE;
838             
839             /* Hide the caret if it's in the source or in the destination
840                rectangle */
841             mapped_rcCaret = info.rcCaret;
842             MapWindowPoints(info.hwndCaret, hWnd, (LPPOINT)&mapped_rcCaret, 2);
843             
844             if (IntersectRect(&rect, scroll_rect, &mapped_rcCaret))
845             {
846                 hide_caret = TRUE;
847             }
848             else
849             {
850                 rect = *scroll_rect;
851                 OffsetRect(&rect, dx, dy);
852                 hide_caret = IntersectRect(&rect, &rect, &mapped_rcCaret);
853             }
854         }
855         else
856             return 0;
857     }
858
859     if (hide_caret)
860     {    
861         HideCaret(info.hwndCaret);
862         return info.hwndCaret;
863     }
864     else
865         return 0;
866 }
867
868
869 /***********************************************************************
870  *              BeginPaint (USER32.@)
871  */
872 HDC WINAPI BeginPaint( HWND hwnd, PAINTSTRUCT *lps )
873 {
874     HRGN hrgn;
875     UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE | UPDATE_PAINT | UPDATE_INTERNALPAINT | UPDATE_NOCHILDREN;
876
877     if (!lps) return 0;
878
879     HideCaret( hwnd );
880
881     if (!(hrgn = send_ncpaint( hwnd, NULL, &flags ))) return 0;
882
883     lps->fErase = send_erase( hwnd, flags, hrgn, &lps->rcPaint, &lps->hdc );
884
885     TRACE("hdc = %p box = (%s), fErase = %d\n",
886           lps->hdc, wine_dbgstr_rect(&lps->rcPaint), lps->fErase);
887
888     return lps->hdc;
889 }
890
891
892 /***********************************************************************
893  *              EndPaint (USER32.@)
894  */
895 BOOL WINAPI EndPaint( HWND hwnd, const PAINTSTRUCT *lps )
896 {
897     if (!lps) return FALSE;
898     release_dc( hwnd, lps->hdc, TRUE );
899     ShowCaret( hwnd );
900     return TRUE;
901 }
902
903
904 /***********************************************************************
905  *              GetDCEx (USER32.@)
906  */
907 HDC WINAPI GetDCEx( HWND hwnd, HRGN hrgnClip, DWORD flags )
908 {
909     const DWORD clip_flags = DCX_PARENTCLIP | DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN | DCX_WINDOW;
910     const DWORD user_flags = clip_flags | DCX_NORESETATTRS; /* flags that can be set by user */
911     struct dce *dce;
912     BOOL bUpdateVisRgn = TRUE;
913     HWND parent;
914     LONG window_style = GetWindowLongW( hwnd, GWL_STYLE );
915
916     if (!hwnd) hwnd = GetDesktopWindow();
917     else hwnd = WIN_GetFullHandle( hwnd );
918
919     TRACE("hwnd %p, hrgnClip %p, flags %08x\n", hwnd, hrgnClip, flags);
920
921     if (!IsWindow(hwnd)) return 0;
922
923     /* fixup flags */
924
925     if (flags & (DCX_WINDOW | DCX_PARENTCLIP)) flags |= DCX_CACHE;
926
927     if (flags & DCX_USESTYLE)
928     {
929         flags &= ~(DCX_CLIPCHILDREN | DCX_CLIPSIBLINGS | DCX_PARENTCLIP);
930
931         if (window_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
932
933         if (!(flags & DCX_WINDOW))
934         {
935             if (GetClassLongW( hwnd, GCL_STYLE ) & CS_PARENTDC) flags |= DCX_PARENTCLIP;
936
937             if (window_style & WS_CLIPCHILDREN && !(window_style & WS_MINIMIZE))
938                 flags |= DCX_CLIPCHILDREN;
939         }
940     }
941
942     if (flags & DCX_WINDOW) flags &= ~DCX_CLIPCHILDREN;
943
944     parent = GetAncestor( hwnd, GA_PARENT );
945     if (!parent || (parent == GetDesktopWindow()))
946         flags = (flags & ~DCX_PARENTCLIP) | DCX_CLIPSIBLINGS;
947
948     /* it seems parent clip is ignored when clipping siblings or children */
949     if (flags & (DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN)) flags &= ~DCX_PARENTCLIP;
950
951     if( flags & DCX_PARENTCLIP )
952     {
953         LONG parent_style = GetWindowLongW( parent, GWL_STYLE );
954         if( (window_style & WS_VISIBLE) && (parent_style & WS_VISIBLE) )
955         {
956             flags &= ~DCX_CLIPCHILDREN;
957             if (parent_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
958         }
959     }
960
961     /* find a suitable DCE */
962
963     if ((flags & DCX_CACHE) || !(dce = get_window_dce( hwnd )))
964     {
965         struct dce *dceEmpty = NULL, *dceUnused = NULL;
966
967         /* Strategy: First, we attempt to find a non-empty but unused DCE with
968          * compatible flags. Next, we look for an empty entry. If the cache is
969          * full we have to purge one of the unused entries.
970          */
971         USER_Lock();
972         LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
973         {
974             if ((dce->flags & DCX_CACHE) && !dce->count)
975             {
976                 dceUnused = dce;
977
978                 if (!dce->hwnd) dceEmpty = dce;
979                 else if ((dce->hwnd == hwnd) && !((dce->flags ^ flags) & clip_flags))
980                 {
981                     TRACE("\tfound valid %p dce [%p], flags %08x\n",
982                           dce, hwnd, dce->flags );
983                     bUpdateVisRgn = FALSE;
984                     break;
985                 }
986             }
987         }
988
989         if (&dce->entry == &dce_list)  /* nothing found */
990             dce = dceEmpty ? dceEmpty : dceUnused;
991
992         if (dce) dce->count = 1;
993
994         USER_Unlock();
995
996         /* if there's no dce empty or unused, allocate a new one */
997         if (!dce)
998         {
999             if (!(dce = alloc_dce())) return 0;
1000             dce->flags = DCX_CACHE;
1001             USER_Lock();
1002             list_add_head( &dce_list, &dce->entry );
1003             USER_Unlock();
1004         }
1005     }
1006     else
1007     {
1008         flags |= DCX_NORESETATTRS;
1009         if (dce->hwnd == hwnd)
1010         {
1011             TRACE("\tskipping hVisRgn update\n");
1012             bUpdateVisRgn = FALSE; /* updated automatically, via DCHook() */
1013         }
1014         else
1015         {
1016             /* we should free dce->clip_rgn here, but Windows apparently doesn't */
1017             dce->flags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN);
1018             dce->clip_rgn = 0;
1019         }
1020     }
1021
1022     if (flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN))
1023     {
1024         /* if the extra clip region has changed, get rid of the old one */
1025         if (dce->clip_rgn != hrgnClip || ((flags ^ dce->flags) & (DCX_INTERSECTRGN | DCX_EXCLUDERGN)))
1026             delete_clip_rgn( dce );
1027         dce->clip_rgn = hrgnClip;
1028         if (!dce->clip_rgn) dce->clip_rgn = CreateRectRgn( 0, 0, 0, 0 );
1029         dce->flags |= flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN);
1030         bUpdateVisRgn = TRUE;
1031     }
1032
1033     dce->hwnd = hwnd;
1034     dce->flags = (dce->flags & ~user_flags) | (flags & user_flags);
1035
1036     if (SetHookFlags( dce->hdc, DCHF_VALIDATEVISRGN )) bUpdateVisRgn = TRUE;  /* DC was dirty */
1037
1038     if (bUpdateVisRgn) update_visible_region( dce );
1039
1040     TRACE("(%p,%p,0x%x): returning %p\n", hwnd, hrgnClip, flags, dce->hdc);
1041     return dce->hdc;
1042 }
1043
1044
1045 /***********************************************************************
1046  *              GetDC (USER32.@)
1047  *
1048  * Get a device context.
1049  *
1050  * RETURNS
1051  *      Success: Handle to the device context
1052  *      Failure: NULL.
1053  */
1054 HDC WINAPI GetDC( HWND hwnd )
1055 {
1056     if (!hwnd) return GetDCEx( 0, 0, DCX_CACHE | DCX_WINDOW );
1057     return GetDCEx( hwnd, 0, DCX_USESTYLE );
1058 }
1059
1060
1061 /***********************************************************************
1062  *              GetWindowDC (USER32.@)
1063  */
1064 HDC WINAPI GetWindowDC( HWND hwnd )
1065 {
1066     return GetDCEx( hwnd, 0, DCX_USESTYLE | DCX_WINDOW );
1067 }
1068
1069
1070 /***********************************************************************
1071  *              ReleaseDC (USER32.@)
1072  *
1073  * Release a device context.
1074  *
1075  * RETURNS
1076  *      Success: Non-zero. Resources used by hdc are released.
1077  *      Failure: 0.
1078  */
1079 INT WINAPI ReleaseDC( HWND hwnd, HDC hdc )
1080 {
1081     return release_dc( hwnd, hdc, FALSE );
1082 }
1083
1084
1085 /**********************************************************************
1086  *              WindowFromDC (USER32.@)
1087  */
1088 HWND WINAPI WindowFromDC( HDC hdc )
1089 {
1090     struct dce *dce;
1091     HWND hwnd = 0;
1092
1093     USER_Lock();
1094     dce = (struct dce *)GetDCHook( hdc, NULL );
1095     if (dce) hwnd = dce->hwnd;
1096     USER_Unlock();
1097     return hwnd;
1098 }
1099
1100
1101 /***********************************************************************
1102  *              LockWindowUpdate (USER32.@)
1103  *
1104  * Enables or disables painting in the chosen window.
1105  *
1106  * PARAMS
1107  *  hwnd [I] handle to a window.
1108  *
1109  * RETURNS
1110  *  If successful, returns nonzero value. Otherwise,
1111  *  returns 0.
1112  *
1113  * NOTES
1114  *  You can lock only one window at a time.
1115  */
1116 BOOL WINAPI LockWindowUpdate( HWND hwnd )
1117 {
1118     static HWND lockedWnd;
1119
1120     FIXME("(%p), partial stub!\n",hwnd);
1121
1122     USER_Lock();
1123     if (lockedWnd)
1124     {
1125         if (!hwnd)
1126         {
1127             /* Unlock lockedWnd */
1128             /* FIXME: Do something */
1129         }
1130         else
1131         {
1132             /* Attempted to lock a second window */
1133             /* Return FALSE and do nothing */
1134             USER_Unlock();
1135             return FALSE;
1136         }
1137     }
1138     lockedWnd = hwnd;
1139     USER_Unlock();
1140     return TRUE;
1141 }
1142
1143
1144 /***********************************************************************
1145  *              RedrawWindow (USER32.@)
1146  */
1147 BOOL WINAPI RedrawWindow( HWND hwnd, const RECT *rect, HRGN hrgn, UINT flags )
1148 {
1149     static const RECT empty;
1150     BOOL ret;
1151
1152     if (!hwnd) hwnd = GetDesktopWindow();
1153
1154     if (TRACE_ON(win))
1155     {
1156         if (hrgn)
1157         {
1158             RECT r;
1159             GetRgnBox( hrgn, &r );
1160             TRACE( "%p region %p box %s ", hwnd, hrgn, wine_dbgstr_rect(&r) );
1161         }
1162         else if (rect)
1163             TRACE( "%p rect %s ", hwnd, wine_dbgstr_rect(rect) );
1164         else
1165             TRACE( "%p whole window ", hwnd );
1166
1167         dump_rdw_flags(flags);
1168     }
1169
1170     /* process pending expose events before painting */
1171     if (flags & RDW_UPDATENOW) USER_Driver->pMsgWaitForMultipleObjectsEx( 0, NULL, 0, QS_PAINT, 0 );
1172
1173     if (rect && !hrgn)
1174     {
1175         if (IsRectEmpty( rect )) rect = &empty;
1176         ret = redraw_window_rects( hwnd, flags, rect, 1 );
1177     }
1178     else if (!hrgn)
1179     {
1180         ret = redraw_window_rects( hwnd, flags, NULL, 0 );
1181     }
1182     else  /* need to build a list of the region rectangles */
1183     {
1184         DWORD size;
1185         RGNDATA *data = NULL;
1186
1187         if (!(size = GetRegionData( hrgn, 0, NULL ))) return FALSE;
1188         if (!(data = HeapAlloc( GetProcessHeap(), 0, size ))) return FALSE;
1189         GetRegionData( hrgn, size, data );
1190         if (!data->rdh.nCount)  /* empty region -> use a single all-zero rectangle */
1191             ret = redraw_window_rects( hwnd, flags, &empty, 1 );
1192         else
1193             ret = redraw_window_rects( hwnd, flags, (const RECT *)data->Buffer, data->rdh.nCount );
1194         HeapFree( GetProcessHeap(), 0, data );
1195     }
1196
1197     if (flags & RDW_UPDATENOW) update_now( hwnd, flags );
1198     else if (flags & RDW_ERASENOW) erase_now( hwnd, flags );
1199
1200     return ret;
1201 }
1202
1203
1204 /***********************************************************************
1205  *              UpdateWindow (USER32.@)
1206  */
1207 BOOL WINAPI UpdateWindow( HWND hwnd )
1208 {
1209     return RedrawWindow( hwnd, NULL, 0, RDW_UPDATENOW | RDW_ALLCHILDREN );
1210 }
1211
1212
1213 /***********************************************************************
1214  *              InvalidateRgn (USER32.@)
1215  */
1216 BOOL WINAPI InvalidateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
1217 {
1218     if (!hwnd)
1219     {
1220         SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1221         return FALSE;
1222     }
1223
1224     return RedrawWindow(hwnd, NULL, hrgn, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
1225 }
1226
1227
1228 /***********************************************************************
1229  *              InvalidateRect (USER32.@)
1230  *
1231  * MSDN: if hwnd parameter is NULL, InvalidateRect invalidates and redraws
1232  * all windows and sends WM_ERASEBKGND and WM_NCPAINT.
1233  */
1234 BOOL WINAPI InvalidateRect( HWND hwnd, const RECT *rect, BOOL erase )
1235 {
1236     UINT flags = RDW_INVALIDATE | (erase ? RDW_ERASE : 0);
1237
1238     if (!hwnd)
1239     {
1240         flags = RDW_ALLCHILDREN | RDW_INVALIDATE | RDW_FRAME | RDW_ERASE | RDW_ERASENOW;
1241         rect = NULL;
1242     }
1243
1244     return RedrawWindow( hwnd, rect, 0, flags );
1245 }
1246
1247
1248 /***********************************************************************
1249  *              ValidateRgn (USER32.@)
1250  */
1251 BOOL WINAPI ValidateRgn( HWND hwnd, HRGN hrgn )
1252 {
1253     if (!hwnd)
1254     {
1255         SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1256         return FALSE;
1257     }
1258
1259     return RedrawWindow( hwnd, NULL, hrgn, RDW_VALIDATE );
1260 }
1261
1262
1263 /***********************************************************************
1264  *              ValidateRect (USER32.@)
1265  *
1266  * MSDN: if hwnd parameter is NULL, ValidateRect invalidates and redraws
1267  * all windows and sends WM_ERASEBKGND and WM_NCPAINT.
1268  */
1269 BOOL WINAPI ValidateRect( HWND hwnd, const RECT *rect )
1270 {
1271     UINT flags = RDW_VALIDATE;
1272
1273     if (!hwnd)
1274     {
1275         flags = RDW_ALLCHILDREN | RDW_INVALIDATE | RDW_FRAME | RDW_ERASE | RDW_ERASENOW;
1276         rect = NULL;
1277     }
1278
1279     return RedrawWindow( hwnd, rect, 0, flags );
1280 }
1281
1282
1283 /***********************************************************************
1284  *              GetUpdateRgn (USER32.@)
1285  */
1286 INT WINAPI GetUpdateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
1287 {
1288     INT retval = ERROR;
1289     UINT flags = UPDATE_NOCHILDREN;
1290     HRGN update_rgn;
1291
1292     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
1293
1294     if ((update_rgn = send_ncpaint( hwnd, NULL, &flags )))
1295     {
1296         POINT offset;
1297
1298         retval = CombineRgn( hrgn, update_rgn, 0, RGN_COPY );
1299         if (send_erase( hwnd, flags, update_rgn, NULL, NULL ))
1300         {
1301             flags = UPDATE_DELAYED_ERASE;
1302             get_update_flags( hwnd, NULL, &flags );
1303         }
1304         /* map region to client coordinates */
1305         offset.x = offset.y = 0;
1306         ScreenToClient( hwnd, &offset );
1307         OffsetRgn( hrgn, offset.x, offset.y );
1308     }
1309     return retval;
1310 }
1311
1312
1313 /***********************************************************************
1314  *              GetUpdateRect (USER32.@)
1315  */
1316 BOOL WINAPI GetUpdateRect( HWND hwnd, LPRECT rect, BOOL erase )
1317 {
1318     UINT flags = UPDATE_NOCHILDREN;
1319     HRGN update_rgn;
1320     BOOL need_erase;
1321
1322     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
1323
1324     if (!(update_rgn = send_ncpaint( hwnd, NULL, &flags ))) return FALSE;
1325
1326     if (rect)
1327     {
1328         if (GetRgnBox( update_rgn, rect ) != NULLREGION)
1329         {
1330             HDC hdc = GetDCEx( hwnd, 0, DCX_USESTYLE );
1331             MapWindowPoints( 0, hwnd, (LPPOINT)rect, 2 );
1332             DPtoLP( hdc, (LPPOINT)rect, 2 );
1333             ReleaseDC( hwnd, hdc );
1334         }
1335     }
1336     need_erase = send_erase( hwnd, flags, update_rgn, NULL, NULL );
1337
1338     /* check if we still have an update region */
1339     flags = UPDATE_PAINT | UPDATE_NOCHILDREN;
1340     if (need_erase) flags |= UPDATE_DELAYED_ERASE;
1341     return (get_update_flags( hwnd, NULL, &flags ) && (flags & UPDATE_PAINT));
1342 }
1343
1344
1345 /***********************************************************************
1346  *              ExcludeUpdateRgn (USER32.@)
1347  */
1348 INT WINAPI ExcludeUpdateRgn( HDC hdc, HWND hwnd )
1349 {
1350     HRGN update_rgn = CreateRectRgn( 0, 0, 0, 0 );
1351     INT ret = GetUpdateRgn( hwnd, update_rgn, FALSE );
1352
1353     if (ret != ERROR)
1354     {
1355         POINT pt;
1356
1357         GetDCOrgEx( hdc, &pt );
1358         MapWindowPoints( 0, hwnd, &pt, 1 );
1359         OffsetRgn( update_rgn, -pt.x, -pt.y );
1360         ret = ExtSelectClipRgn( hdc, update_rgn, RGN_DIFF );
1361         DeleteObject( update_rgn );
1362     }
1363     return ret;
1364 }
1365
1366
1367 /*************************************************************************
1368  *              ScrollWindowEx (USER32.@)
1369  *
1370  * Note: contrary to what the doc says, pixels that are scrolled from the
1371  *      outside of clipRect to the inside are NOT painted.
1372  *
1373  */
1374 INT WINAPI ScrollWindowEx( HWND hwnd, INT dx, INT dy,
1375                            const RECT *rect, const RECT *clipRect,
1376                            HRGN hrgnUpdate, LPRECT rcUpdate,
1377                            UINT flags )
1378 {
1379     INT   retVal = NULLREGION;
1380     BOOL  bOwnRgn = TRUE;
1381     BOOL  bUpdate = (rcUpdate || hrgnUpdate || flags & (SW_INVALIDATE | SW_ERASE));
1382     int rdw_flags;
1383     HRGN  hrgnTemp;
1384     HRGN  hrgnWinupd = 0;
1385     HDC   hDC;
1386     RECT  rc, cliprc;
1387     HWND hwndCaret = NULL;
1388     BOOL moveCaret = FALSE;
1389     POINT newCaretPos;
1390
1391     TRACE( "%p, %d,%d hrgnUpdate=%p rcUpdate = %p %s %04x\n",
1392            hwnd, dx, dy, hrgnUpdate, rcUpdate, wine_dbgstr_rect(rect), flags );
1393     TRACE( "clipRect = %s\n", wine_dbgstr_rect(clipRect));
1394     if( flags & ~( SW_SCROLLCHILDREN | SW_INVALIDATE | SW_ERASE))
1395         FIXME("some flags (%04x) are unhandled\n", flags);
1396
1397     rdw_flags = (flags & SW_ERASE) && (flags & SW_INVALIDATE) ?
1398                                 RDW_INVALIDATE | RDW_ERASE  : RDW_INVALIDATE ;
1399
1400     if (!WIN_IsWindowDrawable( hwnd, TRUE )) return ERROR;
1401     hwnd = WIN_GetFullHandle( hwnd );
1402
1403     GetClientRect(hwnd, &rc);
1404
1405     if (clipRect) IntersectRect(&cliprc,&rc,clipRect);
1406     else cliprc = rc;
1407
1408     if (rect) IntersectRect(&rc, &rc, rect);
1409
1410     if( hrgnUpdate ) bOwnRgn = FALSE;
1411     else if( bUpdate ) hrgnUpdate = CreateRectRgn( 0, 0, 0, 0 );
1412
1413     newCaretPos.x = newCaretPos.y = 0;
1414
1415     if( !IsRectEmpty(&cliprc) && (dx || dy)) {
1416         DWORD dcxflags = DCX_CACHE;
1417         DWORD style = GetWindowLongW( hwnd, GWL_STYLE );
1418
1419         hwndCaret = fix_caret(hwnd, &rc, dx, dy, flags, &moveCaret, &newCaretPos);
1420
1421         if( style & WS_CLIPSIBLINGS) dcxflags |= DCX_CLIPSIBLINGS;
1422         if( GetClassLongW( hwnd, GCL_STYLE ) & CS_PARENTDC)
1423             dcxflags |= DCX_PARENTCLIP;
1424         if( !(flags & SW_SCROLLCHILDREN) && (style & WS_CLIPCHILDREN))
1425             dcxflags |= DCX_CLIPCHILDREN;
1426         hDC = GetDCEx( hwnd, 0, dcxflags);
1427         if (hDC)
1428         {
1429             ScrollDC( hDC, dx, dy, &rc, &cliprc, hrgnUpdate, rcUpdate );
1430
1431             ReleaseDC( hwnd, hDC );
1432
1433             if (!bUpdate)
1434                 RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags);
1435         }
1436
1437         /* If the windows has an update region, this must be
1438          * scrolled as well. Keep a copy in hrgnWinupd
1439          * to be added to hrngUpdate at the end. */
1440         hrgnTemp = CreateRectRgn( 0, 0, 0, 0 );
1441         retVal = GetUpdateRgn( hwnd, hrgnTemp, FALSE );
1442         if (retVal != NULLREGION)
1443         {
1444             HRGN hrgnClip = CreateRectRgnIndirect(&cliprc);
1445             if( !bOwnRgn) {
1446                 hrgnWinupd = CreateRectRgn( 0, 0, 0, 0);
1447                 CombineRgn( hrgnWinupd, hrgnTemp, 0, RGN_COPY);
1448             }
1449             OffsetRgn( hrgnTemp, dx, dy );
1450             CombineRgn( hrgnTemp, hrgnTemp, hrgnClip, RGN_AND );
1451             if( !bOwnRgn)
1452                 CombineRgn( hrgnWinupd, hrgnWinupd, hrgnTemp, RGN_OR );
1453             RedrawWindow( hwnd, NULL, hrgnTemp, rdw_flags);
1454
1455            /* Catch the case where the scrolling amount exceeds the size of the
1456             * original window. This generated a second update area that is the
1457             * location where the original scrolled content would end up.
1458             * This second region is not returned by the ScrollDC and sets
1459             * ScrollWindowEx apart from just a ScrollDC.
1460             *
1461             * This has been verified with testing on windows.
1462             */
1463             if (abs(dx) > abs(rc.right - rc.left) ||
1464                 abs(dy) > abs(rc.bottom - rc.top))
1465             {
1466                 SetRectRgn( hrgnTemp, rc.left + dx, rc.top + dy, rc.right+dx, rc.bottom + dy);
1467                 CombineRgn( hrgnTemp, hrgnTemp, hrgnClip, RGN_AND );
1468                 CombineRgn( hrgnUpdate, hrgnUpdate, hrgnTemp, RGN_OR );
1469
1470                 if( !bOwnRgn)
1471                     CombineRgn( hrgnWinupd, hrgnWinupd, hrgnTemp, RGN_OR );
1472             }
1473             DeleteObject( hrgnClip );
1474         }
1475         DeleteObject( hrgnTemp );
1476     } else {
1477         /* nothing was scrolled */
1478         if( !bOwnRgn)
1479             SetRectRgn( hrgnUpdate, 0, 0, 0, 0 );
1480         SetRectEmpty( rcUpdate);
1481     }
1482
1483     if( flags & SW_SCROLLCHILDREN )
1484     {
1485         HWND *list = WIN_ListChildren( hwnd );
1486         if (list)
1487         {
1488             int i;
1489             RECT r, dummy;
1490             for (i = 0; list[i]; i++)
1491             {
1492                 GetWindowRect( list[i], &r );
1493                 MapWindowPoints( 0, hwnd, (POINT *)&r, 2 );
1494                 if (!rect || IntersectRect(&dummy, &r, rect))
1495                     SetWindowPos( list[i], 0, r.left + dx, r.top  + dy, 0, 0,
1496                                   SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE |
1497                                   SWP_NOREDRAW | SWP_DEFERERASE );
1498             }
1499             HeapFree( GetProcessHeap(), 0, list );
1500         }
1501     }
1502
1503     if( flags & (SW_INVALIDATE | SW_ERASE) )
1504         RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags |
1505                       ((flags & SW_SCROLLCHILDREN) ? RDW_ALLCHILDREN : 0 ) );
1506
1507     if( hrgnWinupd) {
1508         CombineRgn( hrgnUpdate, hrgnUpdate, hrgnWinupd, RGN_OR);
1509         DeleteObject( hrgnWinupd);
1510     }
1511
1512     if( hwndCaret ) {
1513         if ( moveCaret ) SetCaretPos( newCaretPos.x, newCaretPos.y );
1514         ShowCaret(hwndCaret);
1515     }
1516
1517     if( bOwnRgn && hrgnUpdate ) DeleteObject( hrgnUpdate );
1518
1519     return retVal;
1520 }
1521
1522
1523 /*************************************************************************
1524  *              ScrollWindow (USER32.@)
1525  *
1526  */
1527 BOOL WINAPI ScrollWindow( HWND hwnd, INT dx, INT dy,
1528                           const RECT *rect, const RECT *clipRect )
1529 {
1530     return (ERROR != ScrollWindowEx( hwnd, dx, dy, rect, clipRect, 0, NULL,
1531                                      (rect ? 0 : SW_SCROLLCHILDREN) |
1532                                      SW_INVALIDATE | SW_ERASE ));
1533 }
1534
1535
1536 /*************************************************************************
1537  *              ScrollDC (USER32.@)
1538  *
1539  * dx, dy, lprcScroll and lprcClip are all in logical coordinates (msdn is
1540  * wrong) hrgnUpdate is returned in device coordinates with rcUpdate in
1541  * logical coordinates.
1542  */
1543 BOOL WINAPI ScrollDC( HDC hdc, INT dx, INT dy, const RECT *lprcScroll,
1544                       const RECT *lprcClip, HRGN hrgnUpdate, LPRECT lprcUpdate )
1545
1546 {
1547     return USER_Driver->pScrollDC( hdc, dx, dy, lprcScroll, lprcClip, hrgnUpdate, lprcUpdate );
1548 }
1549
1550 /************************************************************************
1551  *              PrintWindow (USER32.@)
1552  *
1553  */
1554 BOOL WINAPI PrintWindow(HWND hwnd, HDC hdcBlt, UINT nFlags)
1555 {
1556     UINT flags = PRF_CHILDREN | PRF_ERASEBKGND | PRF_OWNED | PRF_CLIENT;
1557     if(!(nFlags & PW_CLIENTONLY))
1558     {
1559         flags |= PRF_NONCLIENT;
1560     }
1561     SendMessageW(hwnd, WM_PRINT, (WPARAM)hdcBlt, flags);
1562     return TRUE;
1563 }