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)
 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)  /* 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 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 void update_now( HWND hwnd, UINT rdw_flags )
 328 {
 329     HWND child;
 330
 331     /* loop while we find a child to repaint */
 332     for (;;)
 333     {
 334         UINT flags = UPDATE_PAINT | UPDATE_INTERNALPAINT;
 335
 336         if (rdw_flags & RDW_NOCHILDREN) flags |= UPDATE_NOCHILDREN;
 337         else if (rdw_flags & RDW_ALLCHILDREN) flags |= UPDATE_ALLCHILDREN;
 338
 339         if (!get_update_flags( hwnd, &child, &flags )) break;
 340         if (!flags) break;  /* nothing more to do */
 341
 342         SendMessageW( child, WM_PAINT, 0, 0 );
 343
 344         if (rdw_flags & RDW_NOCHILDREN) break;
 345     }
 346 }
 347
 348
 349 /***********************************************************************
 350  *              BeginPaint (USER32.@)
 351  */
 352 HDC WINAPI BeginPaint( HWND hwnd, PAINTSTRUCT *lps )
 353 {
 354     HWND full_handle;
 355     HRGN hrgn;
 356     UINT flags = UPDATE_NONCLIENT | UPDATE_ERASE | UPDATE_PAINT | UPDATE_INTERNALPAINT | UPDATE_NOCHILDREN;
 357
 358     if (!lps) return 0;
 359
 360     if (!(full_handle = WIN_IsCurrentThread( hwnd )))
 361     {
 362         if (IsWindow(hwnd))
 363             FIXME( "window %p belongs to other thread\n", hwnd );
 364         return 0;
 365     }
 366     hwnd = full_handle;
 367
 368     HideCaret( hwnd );
 369
 370     if (!(hrgn = send_ncpaint( hwnd, NULL, &flags ))) return 0;
 371
 372     lps->fErase = send_erase( hwnd, flags, hrgn, &lps->rcPaint, &lps->hdc );
 373     if (!lps->hdc) DeleteObject( hrgn );
 374
 375     TRACE("hdc = %p box = (%ld,%ld - %ld,%ld), fErase = %d\n",
 376           lps->hdc, lps->rcPaint.left, lps->rcPaint.top, lps->rcPaint.right, lps->rcPaint.bottom,
 377           lps->fErase);
 378
 379     return lps->hdc;
 380 }
 381
 382
 383 /***********************************************************************
 384  *              EndPaint (USER32.@)
 385  */
 386 BOOL WINAPI EndPaint( HWND hwnd, const PAINTSTRUCT *lps )
 387 {
 388     if (!lps) return FALSE;
 389
 390     ReleaseDC( hwnd, lps->hdc );
 391     ShowCaret( hwnd );
 392     return TRUE;
 393 }
 394
 395
 396 /***********************************************************************
 397  *              RedrawWindow (USER32.@)
 398  */
 399 BOOL WINAPI RedrawWindow( HWND hwnd, const RECT *rect, HRGN hrgn, UINT flags )
 400 {
 401     BOOL ret;
 402
 403     if (!hwnd) hwnd = GetDesktopWindow();
 404
 405     /* check if the window or its parents are visible/not minimized */
 406
 407     if (!WIN_IsWindowDrawable( hwnd, !(flags & RDW_FRAME) )) return TRUE;
 408
 409     /* process pending events and messages before painting */
 410     if (flags & RDW_UPDATENOW)
 411         MsgWaitForMultipleObjects( 0, NULL, FALSE, 0, QS_ALLINPUT );
 412
 413     if (TRACE_ON(win))
 414     {
 415         if (hrgn)
 416         {
 417             RECT r;
 418             GetRgnBox( hrgn, &r );
 419             TRACE( "%p region %p box %s ", hwnd, hrgn, wine_dbgstr_rect(&r) );
 420         }
 421         else if (rect)
 422             TRACE( "%p rect %s ", hwnd, wine_dbgstr_rect(rect) );
 423         else
 424             TRACE( "%p whole window ", hwnd );
 425
 426         dump_rdw_flags(flags);
 427     }
 428
 429     if (rect && !hrgn)
 430     {
 431         ret = redraw_window_rects( hwnd, flags, rect, 1 );
 432     }
 433     else if (!hrgn)
 434     {
 435         ret = redraw_window_rects( hwnd, flags, NULL, 0 );
 436     }
 437     else  /* need to build a list of the region rectangles */
 438     {
 439         DWORD size;
 440         RGNDATA *data = NULL;
 441
 442         if (!(size = GetRegionData( hrgn, 0, NULL ))) return FALSE;
 443         if (!(data = HeapAlloc( GetProcessHeap(), 0, size ))) return FALSE;
 444         GetRegionData( hrgn, size, data );
 445         ret = redraw_window_rects( hwnd, flags, (RECT *)data->Buffer, data->rdh.nCount );
 446         HeapFree( GetProcessHeap(), 0, data );
 447     }
 448
 449     if (flags & RDW_UPDATENOW) update_now( hwnd, flags );
 450     else if (flags & RDW_ERASENOW) erase_now( hwnd, flags );
 451
 452     return ret;
 453 }
 454
 455
 456 /***********************************************************************
 457  *              UpdateWindow (USER32.@)
 458  */
 459 BOOL WINAPI UpdateWindow( HWND hwnd )
 460 {
 461     return RedrawWindow( hwnd, NULL, 0, RDW_UPDATENOW | RDW_ALLCHILDREN );
 462 }
 463
 464
 465 /***********************************************************************
 466  *              InvalidateRgn (USER32.@)
 467  */
 468 BOOL WINAPI InvalidateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
 469 {
 470     return RedrawWindow(hwnd, NULL, hrgn, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
 471 }
 472
 473
 474 /***********************************************************************
 475  *              InvalidateRect (USER32.@)
 476  */
 477 BOOL WINAPI InvalidateRect( HWND hwnd, const RECT *rect, BOOL erase )
 478 {
 479     return RedrawWindow( hwnd, rect, 0, RDW_INVALIDATE | (erase ? RDW_ERASE : 0) );
 480 }
 481
 482
 483 /***********************************************************************
 484  *              ValidateRgn (USER32.@)
 485  */
 486 BOOL WINAPI ValidateRgn( HWND hwnd, HRGN hrgn )
 487 {
 488     return RedrawWindow( hwnd, NULL, hrgn, RDW_VALIDATE | RDW_NOCHILDREN );
 489 }
 490
 491
 492 /***********************************************************************
 493  *              ValidateRect (USER32.@)
 494  */
 495 BOOL WINAPI ValidateRect( HWND hwnd, const RECT *rect )
 496 {
 497     return RedrawWindow( hwnd, rect, 0, RDW_VALIDATE | RDW_NOCHILDREN );
 498 }
 499
 500
 501 /***********************************************************************
 502  *              GetUpdateRgn (USER32.@)
 503  */
 504 INT WINAPI GetUpdateRgn( HWND hwnd, HRGN hrgn, BOOL erase )
 505 {
 506     INT retval = ERROR;
 507     UINT flags = UPDATE_NOCHILDREN;
 508     HRGN update_rgn;
 509
 510     if (erase) flags |= UPDATE_NONCLIENT | UPDATE_ERASE;
 511
 512     if ((update_rgn = send_ncpaint( hwnd, NULL, &flags )))
 513     {
 514         RECT rect;
 515         send_erase( hwnd, flags, update_rgn, &rect, NULL );
 516         retval = CombineRgn( hrgn, update_rgn, 0, RGN_COPY );
 517         DeleteObject( update_rgn );
 518     }
 519     return retval;
 520 }
 521
 522
 523 /***********************************************************************
 524  *              GetUpdateRect (USER32.@)
 525  */
 526 BOOL WINAPI GetUpdateRect( HWND hwnd, LPRECT rect, BOOL erase )
 527 {
 528     HDC hdc;
 529     RECT dummy;
 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 ))) return FALSE;
 536
 537     if (rect) GetRgnBox( update_rgn, rect );
 538
 539     send_erase( hwnd, flags, update_rgn, &dummy, &hdc );
 540     if (hdc)
 541     {
 542         if (rect) DPtoLP( hdc, (LPPOINT)rect, 2 );
 543         ReleaseDC( hwnd, hdc );
 544     }
 545     else DeleteObject( update_rgn );
 546
 547     /* check if we still have an update region */
 548     flags = UPDATE_PAINT | UPDATE_NOCHILDREN;
 549     return (get_update_flags( hwnd, NULL, &flags ) && (flags & UPDATE_PAINT));
 550 }
 551
 552
 553 /***********************************************************************
 554  *              ExcludeUpdateRgn (USER32.@)
 555  */
 556 INT WINAPI ExcludeUpdateRgn( HDC hdc, HWND hwnd )
 557 {
 558     HRGN update_rgn = CreateRectRgn( 0, 0, 0, 0 );
 559     INT ret = GetUpdateRgn( hwnd, update_rgn, FALSE );
 560
 561     if (ret != ERROR)
 562     {
 563         /* do ugly coordinate translations in dce.c */
 564
 565         ret = DCE_ExcludeRgn( hdc, hwnd, update_rgn );
 566         DeleteObject( update_rgn );
 567     }
 568     return ret;
 569 }