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 "dce.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 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->flags  = *flags;
 104             wine_server_set_reply( req, data->Buffer, size );
 105             if (!(status = wine_server_call( req )))
 106             {
 107                 size_t reply_size = wine_server_reply_size( reply );
 108                 data->rdh.dwSize   = sizeof(data->rdh);
 109                 data->rdh.iType    = RDH_RECTANGLES;
 110                 data->rdh.nCount   = reply_size / sizeof(RECT);
 111                 data->rdh.nRgnSize = reply_size;
 112                 hrgn = ExtCreateRegion( NULL, size, data );
 113                 if (child) *child = reply->child;
 114                 *flags = reply->flags;
 115             }
 116             else size = reply->total_size;
 117         }
 118         SERVER_END_REQ;
 119         HeapFree( GetProcessHeap(), 0, data );
 120     } while (status == STATUS_BUFFER_OVERFLOW);
 121
 122     if (status) SetLastError( RtlNtStatusToDosError(status) );
 123     return hrgn;
 124 }
 125
 126
 127 /***********************************************************************
 128  *           get_update_flags
 129  *
 130  * Get only the update flags, not the update region.
 131  */
 132 static BOOL get_update_flags( HWND hwnd, HWND *child, UINT *flags )
 133 {
 134     BOOL ret;
 135
 136     SERVER_START_REQ( get_update_region )
 137     {
 138         req->window = hwnd;
 139         req->flags  = *flags | UPDATE_NOREGION;
 140         if ((ret = !wine_server_call_err( req )))
 141         {
 142             if (child) *child = reply->child;
 143             *flags = reply->flags;
 144         }
 145     }
 146     SERVER_END_REQ;
 147     return ret;
 148 }
 149
 150
 151 /***********************************************************************
 152  *           redraw_window_rects
 153  *
 154  * Redraw part of a window.
 155  */
 156 static BOOL redraw_window_rects( HWND hwnd, UINT flags, const RECT *rects, UINT count )
 157 {
 158     BOOL ret;
 159
 160     SERVER_START_REQ( redraw_window )
 161     {
 162         req->window = hwnd;
 163         req->flags  = flags;
 164         wine_server_add_data( req, rects, count * sizeof(RECT) );
 165         ret = !wine_server_call_err( req );
 166     }
 167     SERVER_END_REQ;
 168     return ret;
 169 }
 170
 171
 172 /***********************************************************************
 173  *           send_ncpaint
 174  *
 175  * Send a WM_NCPAINT message if needed, and return the resulting update region.
 176  * Helper for erase_now and BeginPaint.
 177  */
 178 static HRGN send_ncpaint( HWND hwnd, HWND *child, UINT *flags )
 179 {
 180     HRGN whole_rgn = get_update_region( hwnd, flags, child );
 181     HRGN client_rgn = 0;
 182
 183     if (child) hwnd = *child;
 184
 185     if (whole_rgn)
 186     {
 187         RECT client, update;
 188         INT type;
 189         WND *win = WIN_GetPtr( hwnd );
 190
 191         if (!win || win == WND_OTHER_PROCESS || win == WND_DESKTOP)
 192         {
 193             DeleteObject( whole_rgn );
 194             return 0;
 195         }
 196
 197         /* check if update rgn overlaps with nonclient area */
 198         type = GetRgnBox( whole_rgn, &update );
 199         client = win->rectClient;
 200         OffsetRect( &client, -win->rectWindow.left, -win->rectWindow.top );
 201
 202         if ((*flags & UPDATE_NONCLIENT) ||
 203             update.left < client.left || update.top < client.top ||
 204             update.right > client.right || update.bottom > client.bottom)
 205         {
 206             client_rgn = CreateRectRgnIndirect( &client );
 207             CombineRgn( client_rgn, client_rgn, whole_rgn, RGN_AND );
 208
 209             /* check if update rgn contains complete nonclient area */
 210             if (type == SIMPLEREGION && update.left == 0 && update.top == 0 &&
 211                 update.right == win->rectWindow.right - win->rectWindow.left &&
 212                 update.bottom == win->rectWindow.bottom - win->rectWindow.top)
 213             {
 214                 DeleteObject( whole_rgn );
 215                 whole_rgn = (HRGN)1;
 216             }
 217         }
 218         else
 219         {
 220             client_rgn = whole_rgn;
 221             whole_rgn = 0;
 222         }
 223         /* map client region to client coordinates */
 224         OffsetRgn( client_rgn, win->rectWindow.left - win->rectClient.left,
 225                    win->rectWindow.top - win->rectClient.top );
 226         WIN_ReleasePtr( win );
 227
 228         if (whole_rgn) /* NOTE: WM_NCPAINT allows wParam to be 1 */
 229         {
 230             if (*flags & UPDATE_NONCLIENT) SendMessageW( hwnd, WM_NCPAINT, (WPARAM)whole_rgn, 0 );
 231             if (whole_rgn > (HRGN)1) DeleteObject( whole_rgn );
 232         }
 233     }
 234     return client_rgn;
 235 }
 236
 237
 238 /***********************************************************************
 239  *           send_erase
 240  *
 241  * Send a WM_ERASEBKGND message if needed, and optionally return the DC for painting.
 242  * If a DC is requested, the region is selected into it.
 243  * Helper for erase_now and BeginPaint.
 244  */
 245 static BOOL send_erase( HWND hwnd, UINT flags, HRGN client_rgn,
 246                         RECT *clip_rect, HDC *hdc_ret )
 247 {
 248     BOOL need_erase = FALSE;
 249     HDC hdc;
 250
 251     if (hdc_ret || (flags & UPDATE_ERASE))
 252     {
 253         UINT dcx_flags = DCX_INTERSECTRGN | DCX_WINDOWPAINT | 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)
 267             {
 268                 if (need_erase && hwnd != GetDesktopWindow())  /* FIXME: mark it as needing erase again */
 269                     RedrawWindow( hwnd, NULL, client_rgn, RDW_INVALIDATE | RDW_ERASE | RDW_NOCHILDREN );
 270                 ReleaseDC( hwnd, hdc );
 271             }
 272         }
 273
 274         if (hdc_ret) *hdc_ret = hdc;
 275     }
 276     return need_erase;
 277 }
 278
 279
 280 /***********************************************************************
 281  *           erase_now
 282  *
 283  * Implementation of RDW_ERASENOW behavior.
 284  */
 285 static void erase_now( HWND hwnd, UINT rdw_flags )
 286 {
 287     HWND child;
 288     HRGN hrgn;
 289
 290     /* loop while we find a child to repaint */
 291     for (;;)
 292     {
 293         RECT rect;
 294         UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE;
 295
 296         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
 297         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
 298
 299         if (!(hrgn = send_ncpaint( hwnd, &child, &flags ))) break;
 300         send_erase( child, flags, hrgn, &rect, NULL );
 301         DeleteObject( hrgn );
 302
 303         if (!flags) break;  /* nothing more to do */
 304         if (rdw_flags & RDW_NOCHILDREN) break;
 305     }
 306 }
 307
 308
 309 /***********************************************************************
 310  *           update_now
 311  *
 312  * Implementation of RDW_UPDATENOW behavior.
 313  *
 314  * FIXME: Windows uses WM_SYNCPAINT to cut down the number of intertask
 315  * SendMessage() calls. This is a comment inside DefWindowProc() source
 316  * from 16-bit SDK:
 317  *
 318  *   This message avoids lots of inter-app message traffic
 319  *   by switching to the other task and continuing the
 320  *   recursion there.
 321  *
 322  * wParam         = flags
 323  * LOWORD(lParam) = hrgnClip
 324  * HIWORD(lParam) = hwndSkip  (not used; always NULL)
 325  *
 326  */
 327 static void update_now( HWND hwnd, UINT rdw_flags )
 328 {
 329     HWND prev = 0, child;
 330
 331     /* process pending expose events before painting */
 332     MsgWaitForMultipleObjects( 0, NULL, FALSE, 0, QS_PAINT );
 333
 334     /* desktop window never gets WM_PAINT, only WM_ERASEBKGND */
 335     if (hwnd == GetDesktopWindow()) erase_now( hwnd, rdw_flags | RDW_NOCHILDREN );
 336
 337     /* loop while we find a child to repaint */
 338     for (;;)
 339     {
 340         UINT flags = UPDATE_PAINT | UPDATE_INTERNALPAINT;
 341
 342         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
 343         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
 344
 345         if (!get_update_flags( hwnd, &child, &flags )) break;
 346         if (!flags) break;  /* nothing more to do */
 347
 348         if (child == prev)  /* same window again, didn't get repainted properly */
 349         {
 350             UINT erase_flags = UPDATE_NONCLIENT | UPDATE_ERASE | UPDATE_NOCHILDREN;
 351             HRGN hrgn;
 352             RECT rect;
 353
 354             TRACE( "%p not repainted properly, erasing\n", child );
 355             if ((hrgn = send_ncpaint( child, NULL, &erase_flags )))
 356             {
 357                 send_erase( child, erase_flags, hrgn, &rect, NULL );
 358                 DeleteObject( hrgn );
 359             }
 360             prev = 0;
 361         }
 362         else
 363         {
 364             prev = child;
 365             SendMessageW( child, WM_PAINT, 0, 0 );
 366         }
 367         if (rdw_flags & RDW_NOCHILDREN) break;
 368     }
 369 }
 370
 371
 372 /***********************************************************************
 373  *              BeginPaint (USER32.@)
 374  */
 375 HDC WINAPI BeginPaint( HWND hwnd, PAINTSTRUCT *lps )
 376 {
 377     HWND full_handle;
 378     HRGN hrgn;
 379     UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE | UPDATE_PAINT | UPDATE_INTERNALPAINT | UPDATE_NOCHILDREN;
 380
 381     if (!lps) return 0;
 382
 383     if (!(full_handle = WIN_IsCurrentThread( hwnd )))
 384     {
 385         if (IsWindow(hwnd))
 386             FIXME( "window %p belongs to other thread\n", hwnd );
 387         return 0;
 388     }
 389     hwnd = full_handle;
 390
 391     HideCaret( hwnd );
 392
 393     if (!(hrgn = send_ncpaint( hwnd, NULL, &flags ))) return 0;
 394
 395     lps->fErase = send_erase( hwnd, flags, hrgn, &lps->rcPaint, &lps->hdc );
 396     if (!lps->hdc) DeleteObject( hrgn );
 397
 398     TRACE("hdc = %p box = (%ld,%ld - %ld,%ld), fErase = %d\n",
 399           lps->hdc, lps->rcPaint.left, lps->rcPaint.top, lps->rcPaint.right, lps->rcPaint.bottom,
 400           lps->fErase);
 401
 402     return lps->hdc;
 403 }
 404
 405
 406 /***********************************************************************
 407  *              EndPaint (USER32.@)
 408  */
 409 BOOL WINAPI EndPaint( HWND hwnd, const PAINTSTRUCT *lps )
 410 {
 411     if (!lps) return FALSE;
 412
 413     ReleaseDC( hwnd, lps->hdc );
 414     ShowCaret( hwnd );
 415     return TRUE;
 416 }
 417
 418
 419 /***********************************************************************
 420  *              RedrawWindow (USER32.@)
 421  */
 422 BOOL WINAPI RedrawWindow( HWND hwnd, const RECT *rect, HRGN hrgn, UINT flags )
 423 {
 424     BOOL ret;
 425
 426     if (!hwnd) hwnd = GetDesktopWindow();
 427
 428     /* check if the window or its parents are visible/not minimized */
 429
 430     if (!WIN_IsWindowDrawable( hwnd, !(flags & RDW_FRAME) )) return TRUE;
 431
 432     if (TRACE_ON(win))
 433     {
 434         if (hrgn)
 435         {
 436             RECT r;
 437             GetRgnBox( hrgn, &r );
 438             TRACE( "%p region %p box %s ", hwnd, hrgn, wine_dbgstr_rect(&r) );
 439         }
 440         else if (rect)
 441             TRACE( "%p rect %s ", hwnd, wine_dbgstr_rect(rect) );
 442         else
 443             TRACE( "%p whole window ", hwnd );
 444
 445         dump_rdw_flags(flags);
 446     }
 447
 448     if (rect && !hrgn)
 449     {
 450         ret = redraw_window_rects( hwnd, flags, rect, 1 );
 451     }
 452     else if (!hrgn)
 453     {
 454         ret = redraw_window_rects( hwnd, flags, NULL, 0 );
 455     }
 456     else  /* need to build a list of the region rectangles */
 457     {
 458         DWORD size;
 459         RGNDATA *data = NULL;
 460         static const RECT empty;
 461
 462         if (!(size = GetRegionData( hrgn, 0, NULL ))) return FALSE;
 463         if (!(data = HeapAlloc( GetProcessHeap(), 0, size ))) return FALSE;
 464         GetRegionData( hrgn, size, data );
 465         if (!data->rdh.nCount)  /* empty region -> use a single all-zero rectangle */
 466             ret = redraw_window_rects( hwnd, flags, &empty, 1 );
 467         else
 468             ret = redraw_window_rects( hwnd, flags, (const RECT *)data->Buffer, data->rdh.nCount );
 469         HeapFree( GetProcessHeap(), 0, data );
 470     }
 471
 472     if (flags & RDW_UPDATENOW) update_now( hwnd, flags );
 473     else if (flags & RDW_ERASENOW) erase_now( hwnd, flags );
 474
 475     return ret;
 476 }
 477
 478
 479 /***********************************************************************
 480  *              UpdateWindow (USER32.@)
 481  */
 482 BOOL WINAPI UpdateWindow( HWND hwnd )
 483 {
 484     return RedrawWindow( hwnd, NULL, 0, RDW_UPDATENOW | RDW_ALLCHILDREN );
 485 }
 486
 487
 488 /***********************************************************************
 489  *              InvalidateRgn (USER32.@)
 490  */
 491 BOOL WINAPI InvalidateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
 492 {
 493     return RedrawWindow(hwnd, NULL, hrgn, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
 494 }
 495
 496
 497 /***********************************************************************
 498  *              InvalidateRect (USER32.@)
 499  */
 500 BOOL WINAPI InvalidateRect( HWND hwnd, const RECT *rect, BOOL erase )
 501 {
 502     return RedrawWindow( hwnd, rect, 0, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
 503 }
 504
 505
 506 /***********************************************************************
 507  *              ValidateRgn (USER32.@)
 508  */
 509 BOOL WINAPI ValidateRgn( HWND hwnd, HRGN hrgn )
 510 {
 511     return RedrawWindow( hwnd, NULL, hrgn, RDW_VALIDATE );
 512 }
 513
 514
 515 /***********************************************************************
 516  *              ValidateRect (USER32.@)
 517  */
 518 BOOL WINAPI ValidateRect( HWND hwnd, const RECT *rect )
 519 {
 520     return RedrawWindow( hwnd, rect, 0, RDW_VALIDATE );
 521 }
 522
 523
 524 /***********************************************************************
 525  *              GetUpdateRgn (USER32.@)
 526  */
 527 INT WINAPI GetUpdateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
 528 {
 529     INT retval = ERROR;
 530     UINT flags = UPDATE_NOCHILDREN;
 531     HRGN update_rgn;
 532
 533     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
 534
 535     if ((update_rgn = send_ncpaint( hwnd, NULL, &flags )))
 536     {
 537         RECT rect;
 538         send_erase( hwnd, flags, update_rgn, &rect, NULL );
 539         retval = CombineRgn( hrgn, update_rgn, 0, RGN_COPY );
 540         DeleteObject( update_rgn );
 541     }
 542     return retval;
 543 }
 544
 545
 546 /***********************************************************************
 547  *              GetUpdateRect (USER32.@)
 548  */
 549 BOOL WINAPI GetUpdateRect( HWND hwnd, LPRECT rect, BOOL erase )
 550 {
 551     HDC hdc;
 552     RECT dummy;
 553     UINT flags = UPDATE_NOCHILDREN;
 554     HRGN update_rgn;
 555
 556     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
 557
 558     if (!(update_rgn = send_ncpaint( hwnd, NULL, &flags ))) return FALSE;
 559
 560     if (rect) GetRgnBox( update_rgn, rect );
 561
 562     send_erase( hwnd, flags, update_rgn, &dummy, &hdc );
 563     if (hdc)
 564     {
 565         if (rect) DPtoLP( hdc, (LPPOINT)rect, 2 );
 566         ReleaseDC( hwnd, hdc );
 567     }
 568     else DeleteObject( update_rgn );
 569
 570     /* check if we still have an update region */
 571     flags = UPDATE_PAINT | UPDATE_NOCHILDREN;
 572     return (get_update_flags( hwnd, NULL, &flags ) && (flags & UPDATE_PAINT));
 573 }
 574
 575
 576 /***********************************************************************
 577  *              ExcludeUpdateRgn (USER32.@)
 578  */
 579 INT WINAPI ExcludeUpdateRgn( HDC hdc, HWND hwnd )
 580 {
 581     HRGN update_rgn = CreateRectRgn( 0, 0, 0, 0 );
 582     INT ret = GetUpdateRgn( hwnd, update_rgn, FALSE );
 583
 584     if (ret != ERROR)
 585     {
 586         POINT pt;
 587
 588         GetDCOrgEx( hdc, &pt );
 589         MapWindowPoints( 0, hwnd, &pt, 1 );
 590         OffsetRgn( update_rgn, -pt.x, -pt.y );
 591         ret = ExtSelectClipRgn( hdc, update_rgn, RGN_DIFF );
 592         DeleteObject( update_rgn );
 593     }
 594     return ret;
 595 }