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