Take RGB mask into account when doing color keying.
[wine] / dlls / user / painting.c
1 /*
2  * Window painting functions
3  *
4  * Copyright 1993, 1994, 1995, 2001, 2004 Alexandre Julliard
5  * Copyright 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  */
21
22 #include "config.h"
23 #include "wine/port.h"
24
25 #include <stdarg.h>
26 #include <string.h>
27
28 #include "windef.h"
29 #include "winbase.h"
30 #include "wingdi.h"
31 #include "ntstatus.h"
32 #include "winuser.h"
33 #include "wine/server.h"
34 #include "win.h"
35 #include "user_private.h"
36 #include "wine/debug.h"
37
38 WINE_DEFAULT_DEBUG_CHANNEL(win);
39
40
41 /***********************************************************************
42  *           dump_rdw_flags
43  */
44 static void dump_rdw_flags(UINT flags)
45 {
46     TRACE("flags:");
47     if (flags & RDW_INVALIDATE) TRACE(" RDW_INVALIDATE");
48     if (flags & RDW_INTERNALPAINT) TRACE(" RDW_INTERNALPAINT");
49     if (flags & RDW_ERASE) TRACE(" RDW_ERASE");
50     if (flags & RDW_VALIDATE) TRACE(" RDW_VALIDATE");
51     if (flags & RDW_NOINTERNALPAINT) TRACE(" RDW_NOINTERNALPAINT");
52     if (flags & RDW_NOERASE) TRACE(" RDW_NOERASE");
53     if (flags & RDW_NOCHILDREN) TRACE(" RDW_NOCHILDREN");
54     if (flags & RDW_ALLCHILDREN) TRACE(" RDW_ALLCHILDREN");
55     if (flags & RDW_UPDATENOW) TRACE(" RDW_UPDATENOW");
56     if (flags & RDW_ERASENOW) TRACE(" RDW_ERASENOW");
57     if (flags & RDW_FRAME) TRACE(" RDW_FRAME");
58     if (flags & RDW_NOFRAME) TRACE(" RDW_NOFRAME");
59
60 #define RDW_FLAGS \
61     (RDW_INVALIDATE | \
62     RDW_INTERNALPAINT | \
63     RDW_ERASE | \
64     RDW_VALIDATE | \
65     RDW_NOINTERNALPAINT | \
66     RDW_NOERASE | \
67     RDW_NOCHILDREN | \
68     RDW_ALLCHILDREN | \
69     RDW_UPDATENOW | \
70     RDW_ERASENOW | \
71     RDW_FRAME | \
72     RDW_NOFRAME)
73
74     if (flags & ~RDW_FLAGS) TRACE(" %04x", flags & ~RDW_FLAGS);
75     TRACE("\n");
76 #undef RDW_FLAGS
77 }
78
79
80 /***********************************************************************
81  *           get_update_region
82  *
83  * Return update region (in screen coordinates) for a window.
84  */
85 static HRGN get_update_region( HWND hwnd, UINT *flags, HWND *child )
86 {
87     HRGN hrgn = 0;
88     NTSTATUS status;
89     RGNDATA *data;
90     size_t size = 256;
91
92     do
93     {
94         if (!(data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) + size - 1 )))
95         {
96             SetLastError( ERROR_OUTOFMEMORY );
97             return 0;
98         }
99
100         SERVER_START_REQ( get_update_region )
101         {
102             req->window     = hwnd;
103             req->from_child = child ? *child : 0;
104             req->flags      = *flags;
105             wine_server_set_reply( req, data->Buffer, size );
106             if (!(status = wine_server_call( req )))
107             {
108                 size_t reply_size = wine_server_reply_size( reply );
109                 data->rdh.dwSize   = sizeof(data->rdh);
110                 data->rdh.iType    = RDH_RECTANGLES;
111                 data->rdh.nCount   = reply_size / sizeof(RECT);
112                 data->rdh.nRgnSize = reply_size;
113                 hrgn = ExtCreateRegion( NULL, size, data );
114                 if (child) *child = reply->child;
115                 *flags = reply->flags;
116             }
117             else size = reply->total_size;
118         }
119         SERVER_END_REQ;
120         HeapFree( GetProcessHeap(), 0, data );
121     } while (status == STATUS_BUFFER_OVERFLOW);
122
123     if (status) SetLastError( RtlNtStatusToDosError(status) );
124     return hrgn;
125 }
126
127
128 /***********************************************************************
129  *           get_update_flags
130  *
131  * Get only the update flags, not the update region.
132  */
133 static BOOL get_update_flags( HWND hwnd, HWND *child, UINT *flags )
134 {
135     BOOL ret;
136
137     SERVER_START_REQ( get_update_region )
138     {
139         req->window     = hwnd;
140         req->from_child = child ? *child : 0;
141         req->flags      = *flags | UPDATE_NOREGION;
142         if ((ret = !wine_server_call_err( req )))
143         {
144             if (child) *child = reply->child;
145             *flags = reply->flags;
146         }
147     }
148     SERVER_END_REQ;
149     return ret;
150 }
151
152
153 /***********************************************************************
154  *           redraw_window_rects
155  *
156  * Redraw part of a window.
157  */
158 static BOOL redraw_window_rects( HWND hwnd, UINT flags, const RECT *rects, UINT count )
159 {
160     BOOL ret;
161
162     SERVER_START_REQ( redraw_window )
163     {
164         req->window = hwnd;
165         req->flags  = flags;
166         wine_server_add_data( req, rects, count * sizeof(RECT) );
167         ret = !wine_server_call_err( req );
168     }
169     SERVER_END_REQ;
170     return ret;
171 }
172
173
174 /***********************************************************************
175  *           send_ncpaint
176  *
177  * Send a WM_NCPAINT message if needed, and return the resulting update region (in screen coords).
178  * Helper for erase_now and BeginPaint.
179  */
180 static HRGN send_ncpaint( HWND hwnd, HWND *child, UINT *flags )
181 {
182     HRGN whole_rgn = get_update_region( hwnd, flags, child );
183     HRGN client_rgn = 0;
184
185     if (child) hwnd = *child;
186
187     if (whole_rgn)
188     {
189         RECT client, update;
190         INT type;
191
192         /* check if update rgn overlaps with nonclient area */
193         type = GetRgnBox( whole_rgn, &update );
194         GetClientRect( hwnd, &client );
195         MapWindowPoints( hwnd, 0, (POINT *)&client, 2 );
196
197         if ((*flags & UPDATE_NONCLIENT) ||
198             update.left < client.left || update.top < client.top ||
199             update.right > client.right || update.bottom > client.bottom)
200         {
201             client_rgn = CreateRectRgnIndirect( &client );
202             CombineRgn( client_rgn, client_rgn, whole_rgn, RGN_AND );
203
204             /* check if update rgn contains complete nonclient area */
205             if (type == SIMPLEREGION)
206             {
207                 RECT window;
208                 GetWindowRect( hwnd, &window );
209                 if (EqualRect( &window, &update ))
210                 {
211                     DeleteObject( whole_rgn );
212                     whole_rgn = (HRGN)1;
213                 }
214             }
215         }
216         else
217         {
218             client_rgn = whole_rgn;
219             whole_rgn = 0;
220         }
221
222         if (whole_rgn) /* NOTE: WM_NCPAINT allows wParam to be 1 */
223         {
224             if (*flags & UPDATE_NONCLIENT) SendMessageW( hwnd, WM_NCPAINT, (WPARAM)whole_rgn, 0 );
225             if (whole_rgn > (HRGN)1) DeleteObject( whole_rgn );
226         }
227     }
228     return client_rgn;
229 }
230
231
232 /***********************************************************************
233  *           send_erase
234  *
235  * Send a WM_ERASEBKGND message if needed, and optionally return the DC for painting.
236  * If a DC is requested, the region is selected into it. In all cases the region is deleted.
237  * Helper for erase_now and BeginPaint.
238  */
239 static BOOL send_erase( HWND hwnd, UINT flags, HRGN client_rgn,
240                         RECT *clip_rect, HDC *hdc_ret )
241 {
242     BOOL need_erase = FALSE;
243     HDC hdc = 0;
244     RECT dummy;
245
246     if (!clip_rect) clip_rect = &dummy;
247     if (hdc_ret || (flags & UPDATE_ERASE))
248     {
249         UINT dcx_flags = DCX_INTERSECTRGN | DCX_USESTYLE;
250         if (IsIconic(hwnd)) dcx_flags |= DCX_WINDOW;
251
252         if ((hdc = GetDCEx( hwnd, client_rgn, dcx_flags )))
253         {
254             INT type = GetClipBox( hdc, clip_rect );
255
256             if (flags & UPDATE_ERASE)
257             {
258                 /* don't erase if the clip box is empty */
259                 if (type != NULLREGION)
260                     need_erase = !SendMessageW( hwnd, WM_ERASEBKGND, (WPARAM)hdc, 0 );
261             }
262             if (!hdc_ret)
263             {
264                 if (need_erase && hwnd != GetDesktopWindow())  /* FIXME: mark it as needing erase again */
265                     RedrawWindow( hwnd, clip_rect, 0, RDW_INVALIDATE | RDW_ERASE | RDW_NOCHILDREN );
266                 USER_Driver->pReleaseDC( hwnd, hdc, TRUE );
267             }
268         }
269
270         if (hdc_ret) *hdc_ret = hdc;
271     }
272     if (!hdc) DeleteObject( client_rgn );
273     return need_erase;
274 }
275
276
277 /***********************************************************************
278  *           erase_now
279  *
280  * Implementation of RDW_ERASENOW behavior.
281  */
282 static void erase_now( HWND hwnd, UINT rdw_flags )
283 {
284     HWND child = 0;
285     HRGN hrgn;
286
287     /* loop while we find a child to repaint */
288     for (;;)
289     {
290         UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE;
291
292         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
293         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
294
295         if (!(hrgn = send_ncpaint( hwnd, &child, &flags ))) break;
296         send_erase( child, flags, hrgn, NULL, NULL );
297
298         if (!flags) break;  /* nothing more to do */
299         if (rdw_flags & RDW_NOCHILDREN) break;
300     }
301 }
302
303
304 /***********************************************************************
305  *           update_now
306  *
307  * Implementation of RDW_UPDATENOW behavior.
308  *
309  * FIXME: Windows uses WM_SYNCPAINT to cut down the number of intertask
310  * SendMessage() calls. This is a comment inside DefWindowProc() source
311  * from 16-bit SDK:
312  *
313  *   This message avoids lots of inter-app message traffic
314  *   by switching to the other task and continuing the
315  *   recursion there.
316  *
317  * wParam         = flags
318  * LOWORD(lParam) = hrgnClip
319  * HIWORD(lParam) = hwndSkip  (not used; always NULL)
320  *
321  */
322 static void update_now( HWND hwnd, UINT rdw_flags )
323 {
324     HWND child = 0;
325
326     /* desktop window never gets WM_PAINT, only WM_ERASEBKGND */
327     if (hwnd == GetDesktopWindow()) erase_now( hwnd, rdw_flags | RDW_NOCHILDREN );
328
329     /* loop while we find a child to repaint */
330     for (;;)
331     {
332         UINT flags = UPDATE_PAINT | UPDATE_INTERNALPAINT;
333
334         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
335         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
336
337         if (!get_update_flags( hwnd, &child, &flags )) break;
338         if (!flags) break;  /* nothing more to do */
339
340         SendMessageW( child, WM_PAINT, 0, 0 );
341         if (rdw_flags & RDW_NOCHILDREN) break;
342     }
343 }
344
345
346 /*************************************************************************
347  *             fix_caret
348  *
349  * Helper for ScrollWindowEx.
350  */
351 static HWND fix_caret(HWND hWnd, LPRECT lprc, UINT flags)
352 {
353     GUITHREADINFO info;
354
355     if (!GetGUIThreadInfo( GetCurrentThreadId(), &info )) return 0;
356     if (!info.hwndCaret) return 0;
357     if (info.hwndCaret == hWnd ||
358         ((flags & SW_SCROLLCHILDREN) && IsChild(hWnd, info.hwndCaret)))
359     {
360         POINT pt;
361         pt.x = info.rcCaret.left;
362         pt.y = info.rcCaret.top;
363         MapWindowPoints( info.hwndCaret, hWnd, (LPPOINT)&info.rcCaret, 2 );
364         if( IntersectRect(lprc, lprc, &info.rcCaret) )
365         {
366             HideCaret(0);
367             lprc->left = pt.x;
368             lprc->top = pt.y;
369             return info.hwndCaret;
370         }
371     }
372     return 0;
373 }
374
375
376 /***********************************************************************
377  *              BeginPaint (USER32.@)
378  */
379 HDC WINAPI BeginPaint( HWND hwnd, PAINTSTRUCT *lps )
380 {
381     HWND full_handle;
382     HRGN hrgn;
383     UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE | UPDATE_PAINT | UPDATE_INTERNALPAINT | UPDATE_NOCHILDREN;
384
385     if (!lps) return 0;
386
387     if (!(full_handle = WIN_IsCurrentThread( hwnd )))
388     {
389         if (IsWindow(hwnd))
390             FIXME( "window %p belongs to other thread\n", hwnd );
391         return 0;
392     }
393     hwnd = full_handle;
394
395     HideCaret( hwnd );
396
397     if (!(hrgn = send_ncpaint( hwnd, NULL, &flags ))) return 0;
398
399     lps->fErase = send_erase( hwnd, flags, hrgn, &lps->rcPaint, &lps->hdc );
400
401     TRACE("hdc = %p box = (%ld,%ld - %ld,%ld), fErase = %d\n",
402           lps->hdc, lps->rcPaint.left, lps->rcPaint.top, lps->rcPaint.right, lps->rcPaint.bottom,
403           lps->fErase);
404
405     return lps->hdc;
406 }
407
408
409 /***********************************************************************
410  *              EndPaint (USER32.@)
411  */
412 BOOL WINAPI EndPaint( HWND hwnd, const PAINTSTRUCT *lps )
413 {
414     if (!lps) return FALSE;
415     USER_Driver->pReleaseDC( hwnd, lps->hdc, TRUE );
416     ShowCaret( hwnd );
417     return TRUE;
418 }
419
420
421 /***********************************************************************
422  *              GetDCEx (USER32.@)
423  */
424 HDC WINAPI GetDCEx( HWND hwnd, HRGN hrgnClip, DWORD flags )
425 {
426     if (!hwnd) hwnd = GetDesktopWindow();
427     else hwnd = WIN_GetFullHandle( hwnd );
428
429     return USER_Driver->pGetDCEx( hwnd, hrgnClip, flags );
430 }
431
432
433 /***********************************************************************
434  *              GetDC (USER32.@)
435  *
436  * Get a device context.
437  *
438  * RETURNS
439  *      Success: Handle to the device context
440  *      Failure: NULL.
441  */
442 HDC WINAPI GetDC( HWND hwnd )
443 {
444     if (!hwnd) return GetDCEx( 0, 0, DCX_CACHE | DCX_WINDOW );
445     return GetDCEx( hwnd, 0, DCX_USESTYLE );
446 }
447
448
449 /***********************************************************************
450  *              GetWindowDC (USER32.@)
451  */
452 HDC WINAPI GetWindowDC( HWND hwnd )
453 {
454     return GetDCEx( hwnd, 0, DCX_USESTYLE | DCX_WINDOW );
455 }
456
457
458 /***********************************************************************
459  *              ReleaseDC (USER32.@)
460  *
461  * Release a device context.
462  *
463  * RETURNS
464  *      Success: Non-zero. Resources used by hdc are released.
465  *      Failure: 0.
466  */
467 INT WINAPI ReleaseDC( HWND hwnd, HDC hdc )
468 {
469     return USER_Driver->pReleaseDC( hwnd, hdc, FALSE );
470 }
471
472
473 /**********************************************************************
474  *              WindowFromDC (USER32.@)
475  */
476 HWND WINAPI WindowFromDC( HDC hDC )
477 {
478     return USER_Driver->pWindowFromDC( hDC );
479 }
480
481
482 /***********************************************************************
483  *              LockWindowUpdate (USER32.@)
484  */
485 BOOL WINAPI LockWindowUpdate( HWND hwnd )
486 {
487     static HWND lockedWnd;
488
489     /* This function is fully implemented by the following patch:
490      *
491      * http://www.winehq.org/hypermail/wine-patches/2004/01/0142.html
492      *
493      * but in order to work properly, it needs the ability to invalidate
494      * DCEs in other processes when the lock window is changed, which
495      * isn't possible yet.
496      * -mike
497      */
498
499     FIXME("(%p), partial stub!\n",hwnd);
500
501     USER_Lock();
502     if (lockedWnd)
503     {
504         if (!hwnd)
505         {
506             /* Unlock lockedWnd */
507             /* FIXME: Do something */
508         }
509         else
510         {
511             /* Attempted to lock a second window */
512             /* Return FALSE and do nothing */
513             USER_Unlock();
514             return FALSE;
515         }
516     }
517     lockedWnd = hwnd;
518     USER_Unlock();
519     return TRUE;
520 }
521
522
523 /***********************************************************************
524  *              RedrawWindow (USER32.@)
525  */
526 BOOL WINAPI RedrawWindow( HWND hwnd, const RECT *rect, HRGN hrgn, UINT flags )
527 {
528     BOOL ret;
529
530     if (!hwnd) hwnd = GetDesktopWindow();
531
532     if (TRACE_ON(win))
533     {
534         if (hrgn)
535         {
536             RECT r;
537             GetRgnBox( hrgn, &r );
538             TRACE( "%p region %p box %s ", hwnd, hrgn, wine_dbgstr_rect(&r) );
539         }
540         else if (rect)
541             TRACE( "%p rect %s ", hwnd, wine_dbgstr_rect(rect) );
542         else
543             TRACE( "%p whole window ", hwnd );
544
545         dump_rdw_flags(flags);
546     }
547
548     /* process pending expose events before painting */
549     if (flags & RDW_UPDATENOW) USER_Driver->pMsgWaitForMultipleObjectsEx( 0, NULL, 0, QS_PAINT, 0 );
550
551     if (rect && !hrgn)
552     {
553         ret = redraw_window_rects( hwnd, flags, rect, 1 );
554     }
555     else if (!hrgn)
556     {
557         ret = redraw_window_rects( hwnd, flags, NULL, 0 );
558     }
559     else  /* need to build a list of the region rectangles */
560     {
561         DWORD size;
562         RGNDATA *data = NULL;
563         static const RECT empty;
564
565         if (!(size = GetRegionData( hrgn, 0, NULL ))) return FALSE;
566         if (!(data = HeapAlloc( GetProcessHeap(), 0, size ))) return FALSE;
567         GetRegionData( hrgn, size, data );
568         if (!data->rdh.nCount)  /* empty region -> use a single all-zero rectangle */
569             ret = redraw_window_rects( hwnd, flags, &empty, 1 );
570         else
571             ret = redraw_window_rects( hwnd, flags, (const RECT *)data->Buffer, data->rdh.nCount );
572         HeapFree( GetProcessHeap(), 0, data );
573     }
574
575     if (flags & RDW_UPDATENOW) update_now( hwnd, flags );
576     else if (flags & RDW_ERASENOW) erase_now( hwnd, flags );
577
578     return ret;
579 }
580
581
582 /***********************************************************************
583  *              UpdateWindow (USER32.@)
584  */
585 BOOL WINAPI UpdateWindow( HWND hwnd )
586 {
587     return RedrawWindow( hwnd, NULL, 0, RDW_UPDATENOW | RDW_ALLCHILDREN );
588 }
589
590
591 /***********************************************************************
592  *              InvalidateRgn (USER32.@)
593  */
594 BOOL WINAPI InvalidateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
595 {
596     return RedrawWindow(hwnd, NULL, hrgn, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
597 }
598
599
600 /***********************************************************************
601  *              InvalidateRect (USER32.@)
602  */
603 BOOL WINAPI InvalidateRect( HWND hwnd, const RECT *rect, BOOL erase )
604 {
605     return RedrawWindow( hwnd, rect, 0, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
606 }
607
608
609 /***********************************************************************
610  *              ValidateRgn (USER32.@)
611  */
612 BOOL WINAPI ValidateRgn( HWND hwnd, HRGN hrgn )
613 {
614     return RedrawWindow( hwnd, NULL, hrgn, RDW_VALIDATE );
615 }
616
617
618 /***********************************************************************
619  *              ValidateRect (USER32.@)
620  */
621 BOOL WINAPI ValidateRect( HWND hwnd, const RECT *rect )
622 {
623     return RedrawWindow( hwnd, rect, 0, RDW_VALIDATE );
624 }
625
626
627 /***********************************************************************
628  *              GetUpdateRgn (USER32.@)
629  */
630 INT WINAPI GetUpdateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
631 {
632     INT retval = ERROR;
633     UINT flags = UPDATE_NOCHILDREN;
634     HRGN update_rgn;
635
636     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
637
638     if ((update_rgn = send_ncpaint( hwnd, NULL, &flags )))
639     {
640         POINT offset;
641
642         retval = CombineRgn( hrgn, update_rgn, 0, RGN_COPY );
643         send_erase( hwnd, flags, update_rgn, NULL, NULL );
644         /* map region to client coordinates */
645         offset.x = offset.y = 0;
646         ScreenToClient( hwnd, &offset );
647         OffsetRgn( hrgn, offset.x, offset.y );
648     }
649     return retval;
650 }
651
652
653 /***********************************************************************
654  *              GetUpdateRect (USER32.@)
655  */
656 BOOL WINAPI GetUpdateRect( HWND hwnd, LPRECT rect, BOOL erase )
657 {
658     UINT flags = UPDATE_NOCHILDREN;
659     HRGN update_rgn;
660
661     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
662
663     if (!(update_rgn = send_ncpaint( hwnd, NULL, &flags ))) return FALSE;
664
665     if (rect)
666     {
667         if (GetRgnBox( update_rgn, rect ) != NULLREGION)
668         {
669             HDC hdc = GetDCEx( hwnd, 0, DCX_USESTYLE );
670             MapWindowPoints( 0, hwnd, (LPPOINT)rect, 2 );
671             DPtoLP( hdc, (LPPOINT)rect, 2 );
672             ReleaseDC( hwnd, hdc );
673         }
674     }
675     send_erase( hwnd, flags, update_rgn, NULL, NULL );
676
677     /* check if we still have an update region */
678     flags = UPDATE_PAINT | UPDATE_NOCHILDREN;
679     return (get_update_flags( hwnd, NULL, &flags ) && (flags & UPDATE_PAINT));
680 }
681
682
683 /***********************************************************************
684  *              ExcludeUpdateRgn (USER32.@)
685  */
686 INT WINAPI ExcludeUpdateRgn( HDC hdc, HWND hwnd )
687 {
688     HRGN update_rgn = CreateRectRgn( 0, 0, 0, 0 );
689     INT ret = GetUpdateRgn( hwnd, update_rgn, FALSE );
690
691     if (ret != ERROR)
692     {
693         POINT pt;
694
695         GetDCOrgEx( hdc, &pt );
696         MapWindowPoints( 0, hwnd, &pt, 1 );
697         OffsetRgn( update_rgn, -pt.x, -pt.y );
698         ret = ExtSelectClipRgn( hdc, update_rgn, RGN_DIFF );
699         DeleteObject( update_rgn );
700     }
701     return ret;
702 }
703
704
705 /*************************************************************************
706  *              ScrollWindowEx (USER32.@)
707  *
708  * Note: contrary to what the doc says, pixels that are scrolled from the
709  *      outside of clipRect to the inside are NOT painted.
710  *
711  */
712 INT WINAPI ScrollWindowEx( HWND hwnd, INT dx, INT dy,
713                            const RECT *rect, const RECT *clipRect,
714                            HRGN hrgnUpdate, LPRECT rcUpdate,
715                            UINT flags )
716 {
717     INT   retVal = NULLREGION;
718     BOOL  bOwnRgn = TRUE;
719     BOOL  bUpdate = (rcUpdate || hrgnUpdate || flags & (SW_INVALIDATE | SW_ERASE));
720     int rdw_flags;
721     HRGN  hrgnTemp;
722     HRGN  hrgnWinupd = 0;
723     HDC   hDC;
724     RECT  rc, cliprc;
725     RECT caretrc;
726     HWND hwndCaret = NULL;
727
728     TRACE( "%p, %d,%d hrgnUpdate=%p rcUpdate = %p %s %04x\n",
729            hwnd, dx, dy, hrgnUpdate, rcUpdate, wine_dbgstr_rect(rect), flags );
730     TRACE( "clipRect = %s\n", wine_dbgstr_rect(clipRect));
731     if( flags & ~( SW_SCROLLCHILDREN | SW_INVALIDATE | SW_ERASE))
732         FIXME("some flags (%04x) are unhandled\n", flags);
733
734     rdw_flags = (flags & SW_ERASE) && (flags & SW_INVALIDATE) ?
735                                 RDW_INVALIDATE | RDW_ERASE  : RDW_INVALIDATE ;
736
737     if (!WIN_IsWindowDrawable( hwnd, TRUE )) return ERROR;
738     hwnd = WIN_GetFullHandle( hwnd );
739
740     GetClientRect(hwnd, &rc);
741     if (rect) IntersectRect(&rc, &rc, rect);
742
743     if (clipRect) IntersectRect(&cliprc,&rc,clipRect);
744     else cliprc = rc;
745
746     if( hrgnUpdate ) bOwnRgn = FALSE;
747     else if( bUpdate ) hrgnUpdate = CreateRectRgn( 0, 0, 0, 0 );
748
749     if( !IsRectEmpty(&cliprc) && (dx || dy)) {
750         DWORD dcxflags = DCX_CACHE;
751         DWORD style = GetWindowLongW( hwnd, GWL_STYLE );
752         caretrc = rc;
753         hwndCaret = fix_caret(hwnd, &caretrc, flags);
754
755         if( style & WS_CLIPSIBLINGS) dcxflags |= DCX_CLIPSIBLINGS;
756         if( GetClassLongW( hwnd, GCL_STYLE ) & CS_PARENTDC)
757             dcxflags |= DCX_PARENTCLIP;
758         if( !(flags & SW_SCROLLCHILDREN) && (style & WS_CLIPCHILDREN))
759             dcxflags |= DCX_CLIPCHILDREN;
760         hDC = GetDCEx( hwnd, 0, dcxflags);
761         if (hDC)
762         {
763             ScrollDC( hDC, dx, dy, &rc, &cliprc, hrgnUpdate, rcUpdate );
764
765             ReleaseDC( hwnd, hDC );
766
767             if (!bUpdate)
768                 RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags);
769         }
770
771         /* If the windows has an update region, this must be
772          * scrolled as well. Keep a copy in hrgnWinupd
773          * to be added to hrngUpdate at the end. */
774         hrgnTemp = CreateRectRgn( 0, 0, 0, 0 );
775         retVal = GetUpdateRgn( hwnd, hrgnTemp, FALSE );
776         if (retVal != NULLREGION)
777         {
778             HRGN hrgnClip = CreateRectRgnIndirect(&cliprc);
779             if( !bOwnRgn) {
780                 hrgnWinupd = CreateRectRgn( 0, 0, 0, 0);
781                 CombineRgn( hrgnWinupd, hrgnTemp, 0, RGN_COPY);
782             }
783             OffsetRgn( hrgnTemp, dx, dy );
784             CombineRgn( hrgnTemp, hrgnTemp, hrgnClip, RGN_AND );
785             if( !bOwnRgn)
786                 CombineRgn( hrgnWinupd, hrgnWinupd, hrgnTemp, RGN_OR );
787             RedrawWindow( hwnd, NULL, hrgnTemp, rdw_flags);
788             DeleteObject( hrgnClip );
789         }
790         DeleteObject( hrgnTemp );
791     } else {
792         /* nothing was scrolled */
793         if( !bOwnRgn)
794             SetRectRgn( hrgnUpdate, 0, 0, 0, 0 );
795         SetRectEmpty( rcUpdate);
796     }
797
798     if( flags & SW_SCROLLCHILDREN )
799     {
800         HWND *list = WIN_ListChildren( hwnd );
801         if (list)
802         {
803             int i;
804             RECT r, dummy;
805             for (i = 0; list[i]; i++)
806             {
807                 GetWindowRect( list[i], &r );
808                 MapWindowPoints( 0, hwnd, (POINT *)&r, 2 );
809                 if (!rect || IntersectRect(&dummy, &r, rect))
810                     SetWindowPos( list[i], 0, r.left + dx, r.top  + dy, 0, 0,
811                                   SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE |
812                                   SWP_NOREDRAW | SWP_DEFERERASE );
813             }
814             HeapFree( GetProcessHeap(), 0, list );
815         }
816     }
817
818     if( flags & (SW_INVALIDATE | SW_ERASE) )
819         RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags |
820                       ((flags & SW_SCROLLCHILDREN) ? RDW_ALLCHILDREN : 0 ) );
821
822     if( hrgnWinupd) {
823         CombineRgn( hrgnUpdate, hrgnUpdate, hrgnWinupd, RGN_OR);
824         DeleteObject( hrgnWinupd);
825     }
826
827     if( hwndCaret ) {
828         SetCaretPos( caretrc.left + dx, caretrc.top + dy );
829         ShowCaret(hwndCaret);
830     }
831
832     if( bOwnRgn && hrgnUpdate ) DeleteObject( hrgnUpdate );
833
834     return retVal;
835 }
836
837
838 /*************************************************************************
839  *              ScrollWindow (USER32.@)
840  *
841  */
842 BOOL WINAPI ScrollWindow( HWND hwnd, INT dx, INT dy,
843                           const RECT *rect, const RECT *clipRect )
844 {
845     return (ERROR != ScrollWindowEx( hwnd, dx, dy, rect, clipRect, 0, NULL,
846                                      (rect ? 0 : SW_SCROLLCHILDREN) |
847                                      SW_INVALIDATE | SW_ERASE ));
848 }
849
850
851 /*************************************************************************
852  *              ScrollDC (USER32.@)
853  *
854  * dx, dy, lprcScroll and lprcClip are all in logical coordinates (msdn is
855  * wrong) hrgnUpdate is returned in device coordinates with rcUpdate in
856  * logical coordinates.
857  */
858 BOOL WINAPI ScrollDC( HDC hdc, INT dx, INT dy, const RECT *lprcScroll,
859                       const RECT *lprcClip, HRGN hrgnUpdate, LPRECT lprcUpdate )
860
861 {
862     return USER_Driver->pScrollDC( hdc, dx, dy, lprcScroll, lprcClip, hrgnUpdate, lprcUpdate );
863 }