git.oblomov.eu Git - wine/blob - 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 *extra_rect )
 400 {
 401     RECT window_rect;
 402     struct dce *dce;
 403     HWND hwndScope = GetAncestor( hwnd, GA_PARENT );
 404
 405     if (!hwndScope) return;
 406
 407     GetWindowRect( hwnd, &window_rect );
 408
 409     TRACE("%p scope hwnd = %p %s (%s)\n",
 410           hwnd, hwndScope, wine_dbgstr_rect(&window_rect), wine_dbgstr_rect(extra_rect) );
 411
 412     /* walk all DCEs and fixup non-empty entries */
 413
 414     USER_Lock();
 415     LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
 416     {
 417         TRACE( "%p: hwnd %p dcx %08x %s %s\n", dce, dce->hwnd, dce->flags,
 418                (dce->flags & DCX_CACHE) ? "Cache" : "Owned", dce->count ? "InUse" : "" );
 419
 420         if (!dce->hwnd) continue;
 421         if ((dce->hwnd == hwndScope) && !(dce->flags & DCX_CLIPCHILDREN))
 422             continue;  /* child window positions don't bother us */
 423
 424         /* if DCE window is a child of hwnd, it has to be invalidated */
 425         if (dce->hwnd == hwnd || IsChild( hwnd, dce->hwnd ))
 426         {
 427             make_dc_dirty( dce );
 428             continue;
 429         }
 430
 431         /* otherwise check if the window rectangle intersects this DCE window */
 432         if (hwndScope == dce->hwnd || IsChild( hwndScope, dce->hwnd ))
 433         {
 434             RECT dce_rect, tmp;
 435             GetWindowRect( dce->hwnd, &dce_rect );
 436             if (IntersectRect( &tmp, &dce_rect, &window_rect ) ||
 437                 (extra_rect && IntersectRect( &tmp, &dce_rect, extra_rect )))
 438                 make_dc_dirty( dce );
 439         }
 440     }
 441     USER_Unlock();
 442 }
 443
 444 /***********************************************************************
 445  *              release_dc
 446  *
 447  * Implementation of ReleaseDC.
 448  */
 449 static INT release_dc( HWND hwnd, HDC hdc, BOOL end_paint )
 450 {
 451     struct dce *dce;
 452     BOOL ret = FALSE;
 453
 454     TRACE("%p %p\n", hwnd, hdc );
 455
 456     USER_Lock();
 457     dce = (struct dce *)GetDCHook( hdc, NULL );
 458     if (dce && dce->count)
 459     {
 460         if (!(dce->flags & DCX_NORESETATTRS)) reset_dce_attrs( dce );
 461         if (end_paint || (dce->flags & DCX_CACHE)) delete_clip_rgn( dce );
 462         if (dce->flags & DCX_CACHE) dce->count = 0;
 463         ret = TRUE;
 464     }
 465     USER_Unlock();
 466     return ret;
 467 }
 468
 469
 470 /***********************************************************************
 471  *              dc_hook
 472  *
 473  * See "Undoc. Windows" for hints (DC, SetDCHook, SetHookFlags)..
 474  */
 475 static BOOL CALLBACK dc_hook( HDC hDC, WORD code, DWORD_PTR data, LPARAM lParam )
 476 {
 477     BOOL retv = TRUE;
 478     struct dce *dce = (struct dce *)data;
 479
 480     TRACE("hDC = %p, %u\n", hDC, code);
 481
 482     if (!dce) return 0;
 483     assert( dce->hdc == hDC );
 484
 485     switch( code )
 486     {
 487     case DCHC_INVALIDVISRGN:
 488         /* GDI code calls this when it detects that the
 489          * DC is dirty (usually after SetHookFlags()). This
 490          * means that we have to recompute the visible region.
 491          */
 492         if (dce->count) update_visible_region( dce );
 493         else /* non-fatal but shouldn't happen */
 494             WARN("DC is not in use!\n");
 495         break;
 496     case DCHC_DELETEDC:
 497         /*
 498          * Windows will not let you delete a DC that is busy
 499          * (between GetDC and ReleaseDC)
 500          */
 501         USER_Lock();
 502         if (dce->count > 1)
 503         {
 504             WARN("Application trying to delete a busy DC %p\n", dce->hdc);
 505             retv = FALSE;
 506         }
 507         else
 508         {
 509             list_remove( &dce->entry );
 510             if (dce->clip_rgn) DeleteObject( dce->clip_rgn );
 511             HeapFree( GetProcessHeap(), 0, dce );
 512         }
 513         USER_Unlock();
 514         break;
 515     }
 516     return retv;
 517 }
 518
 519
 520 /***********************************************************************
 521  *           get_update_region
 522  *
 523  * Return update region (in screen coordinates) for a window.
 524  */
 525 static HRGN get_update_region( HWND hwnd, UINT *flags, HWND *child )
 526 {
 527     HRGN hrgn = 0;
 528     NTSTATUS status;
 529     RGNDATA *data;
 530     size_t size = 256;
 531
 532     do
 533     {
 534         if (!(data = HeapAlloc( GetProcessHeap(), 0, sizeof(*data) + size - 1 )))
 535         {
 536             SetLastError( ERROR_OUTOFMEMORY );
 537             return 0;
 538         }
 539
 540         SERVER_START_REQ( get_update_region )
 541         {
 542             req->window     = wine_server_user_handle( hwnd );
 543             req->from_child = wine_server_user_handle( child ? *child : 0 );
 544             req->flags      = *flags;
 545             wine_server_set_reply( req, data->Buffer, size );
 546             if (!(status = wine_server_call( req )))
 547             {
 548                 size_t reply_size = wine_server_reply_size( reply );
 549                 data->rdh.dwSize   = sizeof(data->rdh);
 550                 data->rdh.iType    = RDH_RECTANGLES;
 551                 data->rdh.nCount   = reply_size / sizeof(RECT);
 552                 data->rdh.nRgnSize = reply_size;
 553                 hrgn = ExtCreateRegion( NULL, size, data );
 554                 if (child) *child = wine_server_ptr_handle( reply->child );
 555                 *flags = reply->flags;
 556             }
 557             else size = reply->total_size;
 558         }
 559         SERVER_END_REQ;
 560         HeapFree( GetProcessHeap(), 0, data );
 561     } while (status == STATUS_BUFFER_OVERFLOW);
 562
 563     if (status) SetLastError( RtlNtStatusToDosError(status) );
 564     return hrgn;
 565 }
 566
 567
 568 /***********************************************************************
 569  *           get_update_flags
 570  *
 571  * Get only the update flags, not the update region.
 572  */
 573 static BOOL get_update_flags( HWND hwnd, HWND *child, UINT *flags )
 574 {
 575     BOOL ret;
 576
 577     SERVER_START_REQ( get_update_region )
 578     {
 579         req->window     = wine_server_user_handle( hwnd );
 580         req->from_child = wine_server_user_handle( child ? *child : 0 );
 581         req->flags      = *flags | UPDATE_NOREGION;
 582         if ((ret = !wine_server_call_err( req )))
 583         {
 584             if (child) *child = wine_server_ptr_handle( reply->child );
 585             *flags = reply->flags;
 586         }
 587     }
 588     SERVER_END_REQ;
 589     return ret;
 590 }
 591
 592
 593 /***********************************************************************
 594  *           redraw_window_rects
 595  *
 596  * Redraw part of a window.
 597  */
 598 static BOOL redraw_window_rects( HWND hwnd, UINT flags, const RECT *rects, UINT count )
 599 {
 600     BOOL ret;
 601
 602     if (!(flags & (RDW_INVALIDATE|RDW_VALIDATE|RDW_INTERNALPAINT|RDW_NOINTERNALPAINT)))
 603         return TRUE;  /* nothing to do */
 604
 605     SERVER_START_REQ( redraw_window )
 606     {
 607         req->window = wine_server_user_handle( hwnd );
 608         req->flags  = flags;
 609         wine_server_add_data( req, rects, count * sizeof(RECT) );
 610         ret = !wine_server_call_err( req );
 611     }
 612     SERVER_END_REQ;
 613     return ret;
 614 }
 615
 616
 617 /***********************************************************************
 618  *           send_ncpaint
 619  *
 620  * Send a WM_NCPAINT message if needed, and return the resulting update region (in screen coords).
 621  * Helper for erase_now and BeginPaint.
 622  */
 623 static HRGN send_ncpaint( HWND hwnd, HWND *child, UINT *flags )
 624 {
 625     HRGN whole_rgn = get_update_region( hwnd, flags, child );
 626     HRGN client_rgn = 0;
 627
 628     if (child) hwnd = *child;
 629
 630     if (hwnd == GetDesktopWindow()) return whole_rgn;
 631
 632     if (whole_rgn)
 633     {
 634         RECT client, update;
 635         INT type;
 636
 637         /* check if update rgn overlaps with nonclient area */
 638         type = GetRgnBox( whole_rgn, &update );
 639         WIN_GetRectangles( hwnd, COORDS_SCREEN, 0, &client );
 640
 641         if ((*flags & UPDATE_NONCLIENT) ||
 642             update.left < client.left || update.top < client.top ||
 643             update.right > client.right || update.bottom > client.bottom)
 644         {
 645             client_rgn = CreateRectRgnIndirect( &client );
 646             CombineRgn( client_rgn, client_rgn, whole_rgn, RGN_AND );
 647
 648             /* check if update rgn contains complete nonclient area */
 649             if (type == SIMPLEREGION)
 650             {
 651                 RECT window;
 652                 GetWindowRect( hwnd, &window );
 653                 if (EqualRect( &window, &update ))
 654                 {
 655                     DeleteObject( whole_rgn );
 656                     whole_rgn = (HRGN)1;
 657                 }
 658             }
 659         }
 660         else
 661         {
 662             client_rgn = whole_rgn;
 663             whole_rgn = 0;
 664         }
 665
 666         if (whole_rgn) /* NOTE: WM_NCPAINT allows wParam to be 1 */
 667         {
 668             if (*flags & UPDATE_NONCLIENT) SendMessageW( hwnd, WM_NCPAINT, (WPARAM)whole_rgn, 0 );
 669             if (whole_rgn > (HRGN)1) DeleteObject( whole_rgn );
 670         }
 671     }
 672     return client_rgn;
 673 }
 674
 675
 676 /***********************************************************************
 677  *           send_erase
 678  *
 679  * Send a WM_ERASEBKGND message if needed, and optionally return the DC for painting.
 680  * If a DC is requested, the region is selected into it. In all cases the region is deleted.
 681  * Helper for erase_now and BeginPaint.
 682  */
 683 static BOOL send_erase( HWND hwnd, UINT flags, HRGN client_rgn,
 684                         RECT *clip_rect, HDC *hdc_ret )
 685 {
 686     BOOL need_erase = (flags & UPDATE_DELAYED_ERASE) != 0;
 687     HDC hdc = 0;
 688     RECT dummy;
 689
 690     if (!clip_rect) clip_rect = &dummy;
 691     if (hdc_ret || (flags & UPDATE_ERASE))
 692     {
 693         UINT dcx_flags = DCX_INTERSECTRGN | DCX_USESTYLE;
 694         if (IsIconic(hwnd)) dcx_flags |= DCX_WINDOW;
 695
 696         if ((hdc = GetDCEx( hwnd, client_rgn, dcx_flags )))
 697         {
 698             INT type = GetClipBox( hdc, clip_rect );
 699
 700             if (flags & UPDATE_ERASE)
 701             {
 702                 /* don't erase if the clip box is empty */
 703                 if (type != NULLREGION)
 704                     need_erase = !SendMessageW( hwnd, WM_ERASEBKGND, (WPARAM)hdc, 0 );
 705             }
 706             if (!hdc_ret) release_dc( hwnd, hdc, TRUE );
 707         }
 708
 709         if (hdc_ret) *hdc_ret = hdc;
 710     }
 711     if (!hdc) DeleteObject( client_rgn );
 712     return need_erase;
 713 }
 714
 715
 716 /***********************************************************************
 717  *           erase_now
 718  *
 719  * Implementation of RDW_ERASENOW behavior.
 720  */
 721 void erase_now( HWND hwnd, UINT rdw_flags )
 722 {
 723     HWND child = 0;
 724     HRGN hrgn;
 725     BOOL need_erase = FALSE;
 726
 727     /* loop while we find a child to repaint */
 728     for (;;)
 729     {
 730         UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE;
 731
 732         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
 733         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
 734         if (need_erase) flags |= UPDATE_DELAYED_ERASE;
 735
 736         if (!(hrgn = send_ncpaint( hwnd, &child, &flags ))) break;
 737         need_erase = send_erase( child, flags, hrgn, NULL, NULL );
 738
 739         if (!flags) break;  /* nothing more to do */
 740         if ((rdw_flags & RDW_NOCHILDREN) && !need_erase) break;
 741     }
 742 }
 743
 744
 745 /***********************************************************************
 746  *           update_now
 747  *
 748  * Implementation of RDW_UPDATENOW behavior.
 749  *
 750  * FIXME: Windows uses WM_SYNCPAINT to cut down the number of intertask
 751  * SendMessage() calls. This is a comment inside DefWindowProc() source
 752  * from 16-bit SDK:
 753  *
 754  *   This message avoids lots of inter-app message traffic
 755  *   by switching to the other task and continuing the
 756  *   recursion there.
 757  *
 758  * wParam         = flags
 759  * LOWORD(lParam) = hrgnClip
 760  * HIWORD(lParam) = hwndSkip  (not used; always NULL)
 761  *
 762  */
 763 static void update_now( HWND hwnd, UINT rdw_flags )
 764 {
 765     HWND child = 0;
 766
 767     /* desktop window never gets WM_PAINT, only WM_ERASEBKGND */
 768     if (hwnd == GetDesktopWindow()) erase_now( hwnd, rdw_flags | RDW_NOCHILDREN );
 769
 770     /* loop while we find a child to repaint */
 771     for (;;)
 772     {
 773         UINT flags = UPDATE_PAINT | UPDATE_INTERNALPAINT;
 774
 775         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
 776         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
 777
 778         if (!get_update_flags( hwnd, &child, &flags )) break;
 779         if (!flags) break;  /* nothing more to do */
 780
 781         SendMessageW( child, WM_PAINT, 0, 0 );
 782         if (rdw_flags & RDW_NOCHILDREN) break;
 783     }
 784 }
 785
 786
 787 /*************************************************************************
 788  *             fix_caret
 789  *
 790  * Helper for ScrollWindowEx:
 791  * If the return value is 0, no special caret handling is necessary.
 792  * Otherwise the return value is the handle of the window that owns the
 793  * caret. Its caret needs to be hidden during the scroll operation and
 794  * moved to new_caret_pos if move_caret is TRUE.
 795  */
 796 static HWND fix_caret(HWND hWnd, const RECT *scroll_rect, INT dx, INT dy,
 797                      UINT flags, LPBOOL move_caret, LPPOINT new_caret_pos)
 798 {
 799     GUITHREADINFO info;
 800     RECT rect, mapped_rcCaret;
 801     BOOL hide_caret = FALSE;
 802
 803     info.cbSize = sizeof(info);
 804     if (!GetGUIThreadInfo( GetCurrentThreadId(), &info )) return 0;
 805     if (!info.hwndCaret) return 0;
 806
 807     if (info.hwndCaret == hWnd)
 808     {
 809         /* Move the caret if it's (partially) in the source rectangle */
 810         if (IntersectRect(&rect, scroll_rect, &info.rcCaret))
 811         {
 812             *move_caret = TRUE;
 813             hide_caret = TRUE;
 814             new_caret_pos->x = info.rcCaret.left + dx;
 815             new_caret_pos->y = info.rcCaret.top + dy;
 816         }
 817         else
 818         {
 819             *move_caret = FALSE;
 820
 821             /* Hide the caret if it's in the destination rectangle */
 822             rect = *scroll_rect;
 823             OffsetRect(&rect, dx, dy);
 824             hide_caret = IntersectRect(&rect, &rect, &info.rcCaret);
 825         }
 826     }
 827     else
 828     {
 829         if ((flags & SW_SCROLLCHILDREN) && IsChild(hWnd, info.hwndCaret))
 830         {
 831             *move_caret = FALSE;
 832
 833             /* Hide the caret if it's in the source or in the destination
 834                rectangle */
 835             mapped_rcCaret = info.rcCaret;
 836             MapWindowPoints(info.hwndCaret, hWnd, (LPPOINT)&mapped_rcCaret, 2);
 837
 838             if (IntersectRect(&rect, scroll_rect, &mapped_rcCaret))
 839             {
 840                 hide_caret = TRUE;
 841             }
 842             else
 843             {
 844                 rect = *scroll_rect;
 845                 OffsetRect(&rect, dx, dy);
 846                 hide_caret = IntersectRect(&rect, &rect, &mapped_rcCaret);
 847             }
 848         }
 849         else
 850             return 0;
 851     }
 852
 853     if (hide_caret)
 854     {
 855         HideCaret(info.hwndCaret);
 856         return info.hwndCaret;
 857     }
 858     else
 859         return 0;
 860 }
 861
 862
 863 /***********************************************************************
 864  *              BeginPaint (USER32.@)
 865  */
 866 HDC WINAPI BeginPaint( HWND hwnd, PAINTSTRUCT *lps )
 867 {
 868     HRGN hrgn;
 869     UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE | UPDATE_PAINT | UPDATE_INTERNALPAINT | UPDATE_NOCHILDREN;
 870
 871     if (!lps) return 0;
 872
 873     HideCaret( hwnd );
 874
 875     if (!(hrgn = send_ncpaint( hwnd, NULL, &flags ))) return 0;
 876
 877     lps->fErase = send_erase( hwnd, flags, hrgn, &lps->rcPaint, &lps->hdc );
 878
 879     TRACE("hdc = %p box = (%s), fErase = %d\n",
 880           lps->hdc, wine_dbgstr_rect(&lps->rcPaint), lps->fErase);
 881
 882     return lps->hdc;
 883 }
 884
 885
 886 /***********************************************************************
 887  *              EndPaint (USER32.@)
 888  */
 889 BOOL WINAPI EndPaint( HWND hwnd, const PAINTSTRUCT *lps )
 890 {
 891     if (!lps) return FALSE;
 892     release_dc( hwnd, lps->hdc, TRUE );
 893     ShowCaret( hwnd );
 894     return TRUE;
 895 }
 896
 897
 898 /***********************************************************************
 899  *              GetDCEx (USER32.@)
 900  */
 901 HDC WINAPI GetDCEx( HWND hwnd, HRGN hrgnClip, DWORD flags )
 902 {
 903     const DWORD clip_flags = DCX_PARENTCLIP | DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN | DCX_WINDOW;
 904     const DWORD user_flags = clip_flags | DCX_NORESETATTRS; /* flags that can be set by user */
 905     struct dce *dce;
 906     BOOL bUpdateVisRgn = TRUE;
 907     HWND parent;
 908     LONG window_style = GetWindowLongW( hwnd, GWL_STYLE );
 909
 910     if (!hwnd) hwnd = GetDesktopWindow();
 911     else hwnd = WIN_GetFullHandle( hwnd );
 912
 913     TRACE("hwnd %p, hrgnClip %p, flags %08x\n", hwnd, hrgnClip, flags);
 914
 915     if (!IsWindow(hwnd)) return 0;
 916
 917     /* fixup flags */
 918
 919     if (flags & (DCX_WINDOW | DCX_PARENTCLIP)) flags |= DCX_CACHE;
 920
 921     if (flags & DCX_USESTYLE)
 922     {
 923         flags &= ~(DCX_CLIPCHILDREN | DCX_CLIPSIBLINGS | DCX_PARENTCLIP);
 924
 925         if (window_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
 926
 927         if (!(flags & DCX_WINDOW))
 928         {
 929             if (GetClassLongW( hwnd, GCL_STYLE ) & CS_PARENTDC) flags |= DCX_PARENTCLIP;
 930
 931             if (window_style & WS_CLIPCHILDREN && !(window_style & WS_MINIMIZE))
 932                 flags |= DCX_CLIPCHILDREN;
 933         }
 934     }
 935
 936     if (flags & DCX_WINDOW) flags &= ~DCX_CLIPCHILDREN;
 937
 938     parent = GetAncestor( hwnd, GA_PARENT );
 939     if (!parent || (parent == GetDesktopWindow()))
 940         flags = (flags & ~DCX_PARENTCLIP) | DCX_CLIPSIBLINGS;
 941
 942     /* it seems parent clip is ignored when clipping siblings or children */
 943     if (flags & (DCX_CLIPSIBLINGS | DCX_CLIPCHILDREN)) flags &= ~DCX_PARENTCLIP;
 944
 945     if( flags & DCX_PARENTCLIP )
 946     {
 947         LONG parent_style = GetWindowLongW( parent, GWL_STYLE );
 948         if( (window_style & WS_VISIBLE) && (parent_style & WS_VISIBLE) )
 949         {
 950             flags &= ~DCX_CLIPCHILDREN;
 951             if (parent_style & WS_CLIPSIBLINGS) flags |= DCX_CLIPSIBLINGS;
 952         }
 953     }
 954
 955     /* find a suitable DCE */
 956
 957     if ((flags & DCX_CACHE) || !(dce = get_window_dce( hwnd )))
 958     {
 959         struct dce *dceEmpty = NULL, *dceUnused = NULL;
 960
 961         /* Strategy: First, we attempt to find a non-empty but unused DCE with
 962          * compatible flags. Next, we look for an empty entry. If the cache is
 963          * full we have to purge one of the unused entries.
 964          */
 965         USER_Lock();
 966         LIST_FOR_EACH_ENTRY( dce, &dce_list, struct dce, entry )
 967         {
 968             if ((dce->flags & DCX_CACHE) && !dce->count)
 969             {
 970                 dceUnused = dce;
 971
 972                 if (!dce->hwnd) dceEmpty = dce;
 973                 else if ((dce->hwnd == hwnd) && !((dce->flags ^ flags) & clip_flags))
 974                 {
 975                     TRACE("\tfound valid %p dce [%p], flags %08x\n",
 976                           dce, hwnd, dce->flags );
 977                     bUpdateVisRgn = FALSE;
 978                     break;
 979                 }
 980             }
 981         }
 982
 983         if (&dce->entry == &dce_list)  /* nothing found */
 984             dce = dceEmpty ? dceEmpty : dceUnused;
 985
 986         if (dce) dce->count = 1;
 987
 988         USER_Unlock();
 989
 990         /* if there's no dce empty or unused, allocate a new one */
 991         if (!dce)
 992         {
 993             if (!(dce = alloc_dce())) return 0;
 994             dce->flags = DCX_CACHE;
 995             USER_Lock();
 996             list_add_head( &dce_list, &dce->entry );
 997             USER_Unlock();
 998         }
 999     }
1000     else
1001     {
1002         flags |= DCX_NORESETATTRS;
1003         if (dce->hwnd == hwnd)
1004         {
1005             TRACE("\tskipping hVisRgn update\n");
1006             bUpdateVisRgn = FALSE; /* updated automatically, via DCHook() */
1007         }
1008         else
1009         {
1010             /* we should free dce->clip_rgn here, but Windows apparently doesn't */
1011             dce->flags &= ~(DCX_EXCLUDERGN | DCX_INTERSECTRGN);
1012             dce->clip_rgn = 0;
1013         }
1014     }
1015
1016     if (flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN))
1017     {
1018         /* if the extra clip region has changed, get rid of the old one */
1019         if (dce->clip_rgn != hrgnClip || ((flags ^ dce->flags) & (DCX_INTERSECTRGN | DCX_EXCLUDERGN)))
1020             delete_clip_rgn( dce );
1021         dce->clip_rgn = hrgnClip;
1022         if (!dce->clip_rgn) dce->clip_rgn = CreateRectRgn( 0, 0, 0, 0 );
1023         dce->flags |= flags & (DCX_INTERSECTRGN | DCX_EXCLUDERGN);
1024         bUpdateVisRgn = TRUE;
1025     }
1026
1027     if (GetWindowLongW( hwnd, GWL_EXSTYLE ) & WS_EX_LAYOUTRTL) SetLayout( dce->hdc, LAYOUT_RTL );
1028
1029     dce->hwnd = hwnd;
1030     dce->flags = (dce->flags & ~user_flags) | (flags & user_flags);
1031
1032     if (SetHookFlags( dce->hdc, DCHF_VALIDATEVISRGN )) bUpdateVisRgn = TRUE;  /* DC was dirty */
1033
1034     if (bUpdateVisRgn) update_visible_region( dce );
1035
1036     TRACE("(%p,%p,0x%x): returning %p\n", hwnd, hrgnClip, flags, dce->hdc);
1037     return dce->hdc;
1038 }
1039
1040
1041 /***********************************************************************
1042  *              GetDC (USER32.@)
1043  *
1044  * Get a device context.
1045  *
1046  * RETURNS
1047  *      Success: Handle to the device context
1048  *      Failure: NULL.
1049  */
1050 HDC WINAPI GetDC( HWND hwnd )
1051 {
1052     if (!hwnd) return GetDCEx( 0, 0, DCX_CACHE | DCX_WINDOW );
1053     return GetDCEx( hwnd, 0, DCX_USESTYLE );
1054 }
1055
1056
1057 /***********************************************************************
1058  *              GetWindowDC (USER32.@)
1059  */
1060 HDC WINAPI GetWindowDC( HWND hwnd )
1061 {
1062     return GetDCEx( hwnd, 0, DCX_USESTYLE | DCX_WINDOW );
1063 }
1064
1065
1066 /***********************************************************************
1067  *              ReleaseDC (USER32.@)
1068  *
1069  * Release a device context.
1070  *
1071  * RETURNS
1072  *      Success: Non-zero. Resources used by hdc are released.
1073  *      Failure: 0.
1074  */
1075 INT WINAPI ReleaseDC( HWND hwnd, HDC hdc )
1076 {
1077     return release_dc( hwnd, hdc, FALSE );
1078 }
1079
1080
1081 /**********************************************************************
1082  *              WindowFromDC (USER32.@)
1083  */
1084 HWND WINAPI WindowFromDC( HDC hdc )
1085 {
1086     struct dce *dce;
1087     HWND hwnd = 0;
1088
1089     USER_Lock();
1090     dce = (struct dce *)GetDCHook( hdc, NULL );
1091     if (dce) hwnd = dce->hwnd;
1092     USER_Unlock();
1093     return hwnd;
1094 }
1095
1096
1097 /***********************************************************************
1098  *              LockWindowUpdate (USER32.@)
1099  *
1100  * Enables or disables painting in the chosen window.
1101  *
1102  * PARAMS
1103  *  hwnd [I] handle to a window.
1104  *
1105  * RETURNS
1106  *  If successful, returns nonzero value. Otherwise,
1107  *  returns 0.
1108  *
1109  * NOTES
1110  *  You can lock only one window at a time.
1111  */
1112 BOOL WINAPI LockWindowUpdate( HWND hwnd )
1113 {
1114     static HWND lockedWnd;
1115
1116     FIXME("(%p), partial stub!\n",hwnd);
1117
1118     USER_Lock();
1119     if (lockedWnd)
1120     {
1121         if (!hwnd)
1122         {
1123             /* Unlock lockedWnd */
1124             /* FIXME: Do something */
1125         }
1126         else
1127         {
1128             /* Attempted to lock a second window */
1129             /* Return FALSE and do nothing */
1130             USER_Unlock();
1131             return FALSE;
1132         }
1133     }
1134     lockedWnd = hwnd;
1135     USER_Unlock();
1136     return TRUE;
1137 }
1138
1139
1140 /***********************************************************************
1141  *              RedrawWindow (USER32.@)
1142  */
1143 BOOL WINAPI RedrawWindow( HWND hwnd, const RECT *rect, HRGN hrgn, UINT flags )
1144 {
1145     static const RECT empty;
1146     BOOL ret;
1147
1148     if (!hwnd) hwnd = GetDesktopWindow();
1149
1150     if (TRACE_ON(win))
1151     {
1152         if (hrgn)
1153         {
1154             RECT r;
1155             GetRgnBox( hrgn, &r );
1156             TRACE( "%p region %p box %s ", hwnd, hrgn, wine_dbgstr_rect(&r) );
1157         }
1158         else if (rect)
1159             TRACE( "%p rect %s ", hwnd, wine_dbgstr_rect(rect) );
1160         else
1161             TRACE( "%p whole window ", hwnd );
1162
1163         dump_rdw_flags(flags);
1164     }
1165
1166     /* process pending expose events before painting */
1167     if (flags & RDW_UPDATENOW) USER_Driver->pMsgWaitForMultipleObjectsEx( 0, NULL, 0, QS_PAINT, 0 );
1168
1169     if (rect && !hrgn)
1170     {
1171         if (IsRectEmpty( rect )) rect = &empty;
1172         ret = redraw_window_rects( hwnd, flags, rect, 1 );
1173     }
1174     else if (!hrgn)
1175     {
1176         ret = redraw_window_rects( hwnd, flags, NULL, 0 );
1177     }
1178     else  /* need to build a list of the region rectangles */
1179     {
1180         DWORD size;
1181         RGNDATA *data = NULL;
1182
1183         if (!(size = GetRegionData( hrgn, 0, NULL ))) return FALSE;
1184         if (!(data = HeapAlloc( GetProcessHeap(), 0, size ))) return FALSE;
1185         GetRegionData( hrgn, size, data );
1186         if (!data->rdh.nCount)  /* empty region -> use a single all-zero rectangle */
1187             ret = redraw_window_rects( hwnd, flags, &empty, 1 );
1188         else
1189             ret = redraw_window_rects( hwnd, flags, (const RECT *)data->Buffer, data->rdh.nCount );
1190         HeapFree( GetProcessHeap(), 0, data );
1191     }
1192
1193     if (flags & RDW_UPDATENOW) update_now( hwnd, flags );
1194     else if (flags & RDW_ERASENOW) erase_now( hwnd, flags );
1195
1196     return ret;
1197 }
1198
1199
1200 /***********************************************************************
1201  *              UpdateWindow (USER32.@)
1202  */
1203 BOOL WINAPI UpdateWindow( HWND hwnd )
1204 {
1205     if (!hwnd)
1206     {
1207         SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1208         return FALSE;
1209     }
1210
1211     return RedrawWindow( hwnd, NULL, 0, RDW_UPDATENOW | RDW_ALLCHILDREN );
1212 }
1213
1214
1215 /***********************************************************************
1216  *              InvalidateRgn (USER32.@)
1217  */
1218 BOOL WINAPI InvalidateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
1219 {
1220     if (!hwnd)
1221     {
1222         SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1223         return FALSE;
1224     }
1225
1226     return RedrawWindow(hwnd, NULL, hrgn, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
1227 }
1228
1229
1230 /***********************************************************************
1231  *              InvalidateRect (USER32.@)
1232  *
1233  * MSDN: if hwnd parameter is NULL, InvalidateRect invalidates and redraws
1234  * all windows and sends WM_ERASEBKGND and WM_NCPAINT.
1235  */
1236 BOOL WINAPI InvalidateRect( HWND hwnd, const RECT *rect, BOOL erase )
1237 {
1238     UINT flags = RDW_INVALIDATE | (erase ? RDW_ERASE : 0);
1239
1240     if (!hwnd)
1241     {
1242         flags = RDW_ALLCHILDREN | RDW_INVALIDATE | RDW_FRAME | RDW_ERASE | RDW_ERASENOW;
1243         rect = NULL;
1244     }
1245
1246     return RedrawWindow( hwnd, rect, 0, flags );
1247 }
1248
1249
1250 /***********************************************************************
1251  *              ValidateRgn (USER32.@)
1252  */
1253 BOOL WINAPI ValidateRgn( HWND hwnd, HRGN hrgn )
1254 {
1255     if (!hwnd)
1256     {
1257         SetLastError( ERROR_INVALID_WINDOW_HANDLE );
1258         return FALSE;
1259     }
1260
1261     return RedrawWindow( hwnd, NULL, hrgn, RDW_VALIDATE );
1262 }
1263
1264
1265 /***********************************************************************
1266  *              ValidateRect (USER32.@)
1267  *
1268  * MSDN: if hwnd parameter is NULL, ValidateRect invalidates and redraws
1269  * all windows and sends WM_ERASEBKGND and WM_NCPAINT.
1270  */
1271 BOOL WINAPI ValidateRect( HWND hwnd, const RECT *rect )
1272 {
1273     UINT flags = RDW_VALIDATE;
1274
1275     if (!hwnd)
1276     {
1277         flags = RDW_ALLCHILDREN | RDW_INVALIDATE | RDW_FRAME | RDW_ERASE | RDW_ERASENOW;
1278         rect = NULL;
1279     }
1280
1281     return RedrawWindow( hwnd, rect, 0, flags );
1282 }
1283
1284
1285 /***********************************************************************
1286  *              GetUpdateRgn (USER32.@)
1287  */
1288 INT WINAPI GetUpdateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
1289 {
1290     INT retval = ERROR;
1291     UINT flags = UPDATE_NOCHILDREN;
1292     HRGN update_rgn;
1293
1294     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
1295
1296     if ((update_rgn = send_ncpaint( hwnd, NULL, &flags )))
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         map_window_region( 0, hwnd, hrgn );
1306     }
1307     return retval;
1308 }
1309
1310
1311 /***********************************************************************
1312  *              GetUpdateRect (USER32.@)
1313  */
1314 BOOL WINAPI GetUpdateRect( HWND hwnd, LPRECT rect, BOOL erase )
1315 {
1316     UINT flags = UPDATE_NOCHILDREN;
1317     HRGN update_rgn;
1318     BOOL need_erase;
1319
1320     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
1321
1322     if (!(update_rgn = send_ncpaint( hwnd, NULL, &flags ))) return FALSE;
1323
1324     if (rect)
1325     {
1326         if (GetRgnBox( update_rgn, rect ) != NULLREGION)
1327         {
1328             HDC hdc = GetDCEx( hwnd, 0, DCX_USESTYLE );
1329             DWORD layout = SetLayout( hdc, 0 );  /* MapWindowPoints mirrors already */
1330             MapWindowPoints( 0, hwnd, (LPPOINT)rect, 2 );
1331             DPtoLP( hdc, (LPPOINT)rect, 2 );
1332             SetLayout( hdc, layout );
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                 WIN_GetRectangles( list[i], COORDS_PARENT, &r, NULL );
1493                 if (!rect || IntersectRect(&dummy, &r, rect))
1494                     SetWindowPos( list[i], 0, r.left + dx, r.top  + dy, 0, 0,
1495                                   SWP_NOZORDER | SWP_NOSIZE | SWP_NOACTIVATE |
1496                                   SWP_NOREDRAW | SWP_DEFERERASE );
1497             }
1498             HeapFree( GetProcessHeap(), 0, list );
1499         }
1500     }
1501
1502     if( flags & (SW_INVALIDATE | SW_ERASE) )
1503         RedrawWindow( hwnd, NULL, hrgnUpdate, rdw_flags |
1504                       ((flags & SW_SCROLLCHILDREN) ? RDW_ALLCHILDREN : 0 ) );
1505
1506     if( hrgnWinupd) {
1507         CombineRgn( hrgnUpdate, hrgnUpdate, hrgnWinupd, RGN_OR);
1508         DeleteObject( hrgnWinupd);
1509     }
1510
1511     if( hwndCaret ) {
1512         if ( moveCaret ) SetCaretPos( newCaretPos.x, newCaretPos.y );
1513         ShowCaret(hwndCaret);
1514     }
1515
1516     if( bOwnRgn && hrgnUpdate ) DeleteObject( hrgnUpdate );
1517
1518     return retVal;
1519 }
1520
1521
1522 /*************************************************************************
1523  *              ScrollWindow (USER32.@)
1524  *
1525  */
1526 BOOL WINAPI ScrollWindow( HWND hwnd, INT dx, INT dy,
1527                           const RECT *rect, const RECT *clipRect )
1528 {
1529     return (ERROR != ScrollWindowEx( hwnd, dx, dy, rect, clipRect, 0, NULL,
1530                                      (rect ? 0 : SW_SCROLLCHILDREN) |
1531                                      SW_INVALIDATE | SW_ERASE ));
1532 }
1533
1534
1535 /*************************************************************************
1536  *              ScrollDC (USER32.@)
1537  *
1538  * dx, dy, lprcScroll and lprcClip are all in logical coordinates (msdn is
1539  * wrong) hrgnUpdate is returned in device coordinates with rcUpdate in
1540  * logical coordinates.
1541  */
1542 BOOL WINAPI ScrollDC( HDC hdc, INT dx, INT dy, const RECT *lprcScroll,
1543                       const RECT *lprcClip, HRGN hrgnUpdate, LPRECT lprcUpdate )
1544
1545 {
1546     return USER_Driver->pScrollDC( hdc, dx, dy, lprcScroll, lprcClip, hrgnUpdate, lprcUpdate );
1547 }
1548
1549 /************************************************************************
1550  *              PrintWindow (USER32.@)
1551  *
1552  */
1553 BOOL WINAPI PrintWindow(HWND hwnd, HDC hdcBlt, UINT nFlags)
1554 {
1555     UINT flags = PRF_CHILDREN | PRF_ERASEBKGND | PRF_OWNED | PRF_CLIENT;
1556     if(!(nFlags & PW_CLIENTONLY))
1557     {
1558         flags |= PRF_NONCLIENT;
1559     }
1560     SendMessageW(hwnd, WM_PRINT, (WPARAM)hdcBlt, flags);
1561     return TRUE;
1562 }