dlls/gdi32/clipping.c

   1 /*
   2  * DC clipping functions
   3  *
   4  * Copyright 1993 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include <stdarg.h>
  22 #include <stdlib.h>
  23 #include "windef.h"
  24 #include "winbase.h"
  25 #include "wingdi.h"
  26 #include "wownt32.h"
  27 #include "wine/winuser16.h"
  28 #include "gdi_private.h"
  29 #include "wine/debug.h"
  30
  31 WINE_DEFAULT_DEBUG_CHANNEL(clipping);
  32
  33
  34 /***********************************************************************
  35  *           get_clip_region
  36  *
  37  * Return the total clip region (if any).
  38  */
  39 static inline HRGN get_clip_region( DC * dc )
  40 {
  41     if (dc->hMetaClipRgn) return dc->hMetaClipRgn;
  42     if (dc->hMetaRgn) return dc->hMetaRgn;
  43     return dc->hClipRgn;
  44 }
  45
  46
  47 /***********************************************************************
  48  *           CLIPPING_UpdateGCRegion
  49  *
  50  * Update the GC clip region when the ClipRgn or VisRgn have changed.
  51  */
  52 void CLIPPING_UpdateGCRegion( DC * dc )
  53 {
  54     HRGN clip_rgn;
  55
  56     if (!dc->hVisRgn)
  57     {
  58         ERR("hVisRgn is zero. Please report this.\n" );
  59         exit(1);
  60     }
  61
  62     if (dc->flags & DC_DIRTY) ERR( "DC is dirty. Please report this.\n" );
  63
  64     /* update the intersection of meta and clip regions */
  65     if (dc->hMetaRgn && dc->hClipRgn)
  66     {
  67         if (!dc->hMetaClipRgn) dc->hMetaClipRgn = CreateRectRgn( 0, 0, 0, 0 );
  68         CombineRgn( dc->hMetaClipRgn, dc->hClipRgn, dc->hMetaRgn, RGN_AND );
  69         clip_rgn = dc->hMetaClipRgn;
  70     }
  71     else  /* only one is set, no need for an intersection */
  72     {
  73         if (dc->hMetaClipRgn) DeleteObject( dc->hMetaClipRgn );
  74         dc->hMetaClipRgn = 0;
  75         clip_rgn = dc->hMetaRgn ? dc->hMetaRgn : dc->hClipRgn;
  76     }
  77
  78     if (dc->funcs->pSetDeviceClipping)
  79         dc->funcs->pSetDeviceClipping( dc->physDev, dc->hVisRgn, clip_rgn );
  80 }
  81
  82 /***********************************************************************
  83  *           create_default_clip_region
  84  *
  85  * Create a default clipping region when none already exists.
  86  */
  87 static inline void create_default_clip_region( DC * dc )
  88 {
  89     dc->hClipRgn = CreateRectRgn(0, 0,
  90         GetDeviceCaps( dc->hSelf, HORZRES ),
  91         GetDeviceCaps( dc->hSelf, VERTRES ));
  92 }
  93
  94
  95 /***********************************************************************
  96  *           SelectClipRgn    (GDI32.@)
  97  */
  98 INT WINAPI SelectClipRgn( HDC hdc, HRGN hrgn )
  99 {
 100     return ExtSelectClipRgn( hdc, hrgn, RGN_COPY );
 101 }
 102
 103
 104 /******************************************************************************
 105  *              ExtSelectClipRgn        [GDI32.@]
 106  */
 107 INT WINAPI ExtSelectClipRgn( HDC hdc, HRGN hrgn, INT fnMode )
 108 {
 109     INT retval;
 110     RECT rect;
 111     DC * dc = DC_GetDCUpdate( hdc );
 112     if (!dc) return ERROR;
 113
 114     TRACE("%p %p %d\n", hdc, hrgn, fnMode );
 115
 116     if (dc->funcs->pExtSelectClipRgn)
 117     {
 118         retval = dc->funcs->pExtSelectClipRgn( dc->physDev, hrgn, fnMode );
 119         GDI_ReleaseObj( hdc );
 120         return retval;
 121     }
 122
 123     if (!hrgn)
 124     {
 125         if (fnMode == RGN_COPY)
 126         {
 127             if (dc->hClipRgn) DeleteObject( dc->hClipRgn );
 128             dc->hClipRgn = 0;
 129         }
 130         else
 131         {
 132             FIXME("Unimplemented: hrgn NULL in mode: %d\n", fnMode);
 133             GDI_ReleaseObj( hdc );
 134             return ERROR;
 135         }
 136     }
 137     else
 138     {
 139         if (!dc->hClipRgn)
 140             create_default_clip_region( dc );
 141
 142         if(fnMode == RGN_COPY)
 143             CombineRgn( dc->hClipRgn, hrgn, 0, fnMode );
 144         else
 145             CombineRgn( dc->hClipRgn, dc->hClipRgn, hrgn, fnMode);
 146     }
 147
 148     CLIPPING_UpdateGCRegion( dc );
 149     GDI_ReleaseObj( hdc );
 150
 151     return GetClipBox(hdc, &rect);
 152 }
 153
 154 /***********************************************************************
 155  *           SelectVisRgn   (GDI.105)
 156  */
 157 INT16 WINAPI SelectVisRgn16( HDC16 hdc16, HRGN16 hrgn )
 158 {
 159     int retval;
 160     HDC hdc = HDC_32( hdc16 );
 161     DC * dc;
 162
 163     if (!hrgn) return ERROR;
 164     if (!(dc = DC_GetDCPtr( hdc ))) return ERROR;
 165
 166     TRACE("%p %04x\n", hdc, hrgn );
 167
 168     dc->flags &= ~DC_DIRTY;
 169
 170     retval = CombineRgn( dc->hVisRgn, HRGN_32(hrgn), 0, RGN_COPY );
 171     CLIPPING_UpdateGCRegion( dc );
 172     GDI_ReleaseObj( hdc );
 173     return retval;
 174 }
 175
 176
 177 /***********************************************************************
 178  *           OffsetClipRgn    (GDI32.@)
 179  */
 180 INT WINAPI OffsetClipRgn( HDC hdc, INT x, INT y )
 181 {
 182     INT ret = SIMPLEREGION;
 183     DC *dc = DC_GetDCUpdate( hdc );
 184     if (!dc) return ERROR;
 185
 186     TRACE("%p %d,%d\n", hdc, x, y );
 187
 188     if(dc->funcs->pOffsetClipRgn)
 189     {
 190         ret = dc->funcs->pOffsetClipRgn( dc->physDev, x, y );
 191         /* FIXME: ret is just a success flag, we should return a proper value */
 192     }
 193     else if (dc->hClipRgn) {
 194         ret = OffsetRgn( dc->hClipRgn, MulDiv( x, dc->vportExtX, dc->wndExtX ),
 195                          MulDiv( y, dc->vportExtY, dc->wndExtY ) );
 196         CLIPPING_UpdateGCRegion( dc );
 197     }
 198     GDI_ReleaseObj( hdc );
 199     return ret;
 200 }
 201
 202
 203 /***********************************************************************
 204  *           OffsetVisRgn    (GDI.102)
 205  */
 206 INT16 WINAPI OffsetVisRgn16( HDC16 hdc16, INT16 x, INT16 y )
 207 {
 208     INT16 retval;
 209     HDC hdc = HDC_32( hdc16 );
 210     DC * dc = DC_GetDCUpdate( hdc );
 211     if (!dc) return ERROR;
 212     TRACE("%p %d,%d\n", hdc, x, y );
 213     retval = OffsetRgn( dc->hVisRgn, x, y );
 214     CLIPPING_UpdateGCRegion( dc );
 215     GDI_ReleaseObj( hdc );
 216     return retval;
 217 }
 218
 219
 220 /***********************************************************************
 221  *           ExcludeClipRect    (GDI32.@)
 222  */
 223 INT WINAPI ExcludeClipRect( HDC hdc, INT left, INT top,
 224                                 INT right, INT bottom )
 225 {
 226     HRGN newRgn;
 227     INT ret;
 228     DC *dc = DC_GetDCUpdate( hdc );
 229     if (!dc) return ERROR;
 230
 231     TRACE("%p %dx%d,%dx%d\n", hdc, left, top, right, bottom );
 232
 233     if(dc->funcs->pExcludeClipRect)
 234     {
 235         ret = dc->funcs->pExcludeClipRect( dc->physDev, left, top, right, bottom );
 236         /* FIXME: ret is just a success flag, we should return a proper value */
 237     }
 238     else
 239     {
 240         POINT pt[2];
 241
 242         pt[0].x = left;
 243         pt[0].y = top;
 244         pt[1].x = right;
 245         pt[1].y = bottom;
 246         LPtoDP( hdc, pt, 2 );
 247         if (!(newRgn = CreateRectRgn( pt[0].x, pt[0].y, pt[1].x, pt[1].y ))) ret = ERROR;
 248         else
 249         {
 250             if (!dc->hClipRgn)
 251                 create_default_clip_region( dc );
 252             ret = CombineRgn( dc->hClipRgn, dc->hClipRgn, newRgn, RGN_DIFF );
 253             DeleteObject( newRgn );
 254         }
 255         if (ret != ERROR) CLIPPING_UpdateGCRegion( dc );
 256     }
 257     GDI_ReleaseObj( hdc );
 258     return ret;
 259 }
 260
 261
 262 /***********************************************************************
 263  *           IntersectClipRect    (GDI32.@)
 264  */
 265 INT WINAPI IntersectClipRect( HDC hdc, INT left, INT top, INT right, INT bottom )
 266 {
 267     INT ret;
 268     DC *dc = DC_GetDCUpdate( hdc );
 269     if (!dc) return ERROR;
 270
 271     TRACE("%p %d,%d - %d,%d\n", hdc, left, top, right, bottom );
 272
 273     if(dc->funcs->pIntersectClipRect)
 274     {
 275         ret = dc->funcs->pIntersectClipRect( dc->physDev, left, top, right, bottom );
 276         /* FIXME: ret is just a success flag, we should return a proper value */
 277     }
 278     else
 279     {
 280         POINT pt[2];
 281
 282         pt[0].x = left;
 283         pt[0].y = top;
 284         pt[1].x = right;
 285         pt[1].y = bottom;
 286
 287         LPtoDP( hdc, pt, 2 );
 288
 289         if (!dc->hClipRgn)
 290         {
 291             dc->hClipRgn = CreateRectRgn( pt[0].x, pt[0].y, pt[1].x, pt[1].y );
 292             ret = SIMPLEREGION;
 293         }
 294         else
 295         {
 296             HRGN newRgn;
 297
 298             if (!(newRgn = CreateRectRgn( pt[0].x, pt[0].y, pt[1].x, pt[1].y ))) ret = ERROR;
 299             else
 300             {
 301                 ret = CombineRgn( dc->hClipRgn, dc->hClipRgn, newRgn, RGN_AND );
 302                 DeleteObject( newRgn );
 303             }
 304         }
 305         if (ret != ERROR) CLIPPING_UpdateGCRegion( dc );
 306     }
 307     GDI_ReleaseObj( hdc );
 308     return ret;
 309 }
 310
 311
 312 /***********************************************************************
 313  *           ExcludeVisRect   (GDI.73)
 314  */
 315 INT16 WINAPI ExcludeVisRect16( HDC16 hdc16, INT16 left, INT16 top, INT16 right, INT16 bottom )
 316 {
 317     HRGN tempRgn;
 318     INT16 ret;
 319     POINT pt[2];
 320     HDC hdc = HDC_32( hdc16 );
 321     DC * dc = DC_GetDCUpdate( hdc );
 322     if (!dc) return ERROR;
 323
 324     pt[0].x = left;
 325     pt[0].y = top;
 326     pt[1].x = right;
 327     pt[1].y = bottom;
 328
 329     LPtoDP( hdc, pt, 2 );
 330
 331     TRACE("%p %d,%d - %d,%d\n", hdc, pt[0].x, pt[0].y, pt[1].x, pt[1].y);
 332
 333     if (!(tempRgn = CreateRectRgn( pt[0].x, pt[0].y, pt[1].x, pt[1].y ))) ret = ERROR;
 334     else
 335     {
 336         ret = CombineRgn( dc->hVisRgn, dc->hVisRgn, tempRgn, RGN_DIFF );
 337         DeleteObject( tempRgn );
 338     }
 339     if (ret != ERROR) CLIPPING_UpdateGCRegion( dc );
 340     GDI_ReleaseObj( hdc );
 341     return ret;
 342 }
 343
 344
 345 /***********************************************************************
 346  *           IntersectVisRect   (GDI.98)
 347  */
 348 INT16 WINAPI IntersectVisRect16( HDC16 hdc16, INT16 left, INT16 top, INT16 right, INT16 bottom )
 349 {
 350     HRGN tempRgn;
 351     INT16 ret;
 352     POINT pt[2];
 353     HDC hdc = HDC_32( hdc16 );
 354     DC * dc = DC_GetDCUpdate( hdc );
 355     if (!dc) return ERROR;
 356
 357     pt[0].x = left;
 358     pt[0].y = top;
 359     pt[1].x = right;
 360     pt[1].y = bottom;
 361
 362     LPtoDP( hdc, pt, 2 );
 363
 364     TRACE("%p %d,%d - %d,%d\n", hdc, pt[0].x, pt[0].y, pt[1].x, pt[1].y);
 365
 366
 367     if (!(tempRgn = CreateRectRgn( pt[0].x, pt[0].y, pt[1].x, pt[1].y ))) ret = ERROR;
 368     else
 369     {
 370         ret = CombineRgn( dc->hVisRgn, dc->hVisRgn, tempRgn, RGN_AND );
 371         DeleteObject( tempRgn );
 372     }
 373     if (ret != ERROR) CLIPPING_UpdateGCRegion( dc );
 374     GDI_ReleaseObj( hdc );
 375     return ret;
 376 }
 377
 378
 379 /***********************************************************************
 380  *           PtVisible    (GDI32.@)
 381  */
 382 BOOL WINAPI PtVisible( HDC hdc, INT x, INT y )
 383 {
 384     POINT pt;
 385     BOOL ret;
 386     HRGN clip;
 387     DC *dc = DC_GetDCUpdate( hdc );
 388
 389     TRACE("%p %d,%d\n", hdc, x, y );
 390     if (!dc) return FALSE;
 391
 392     pt.x = x;
 393     pt.y = y;
 394     LPtoDP( hdc, &pt, 1 );
 395     ret = PtInRegion( dc->hVisRgn, pt.x, pt.y );
 396     if (ret && (clip = get_clip_region(dc))) ret = PtInRegion( clip, pt.x, pt.y );
 397     GDI_ReleaseObj( hdc );
 398     return ret;
 399 }
 400
 401
 402 /***********************************************************************
 403  *           RectVisible    (GDI32.@)
 404  */
 405 BOOL WINAPI RectVisible( HDC hdc, const RECT* rect )
 406 {
 407     RECT tmpRect;
 408     BOOL ret;
 409     HRGN clip;
 410     DC *dc = DC_GetDCUpdate( hdc );
 411     if (!dc) return FALSE;
 412     TRACE("%p %d,%dx%d,%d\n", hdc, rect->left, rect->top, rect->right, rect->bottom );
 413
 414     tmpRect = *rect;
 415     LPtoDP( hdc, (POINT *)&tmpRect, 2 );
 416
 417     if ((clip = get_clip_region(dc)))
 418     {
 419         HRGN hrgn = CreateRectRgn( 0, 0, 0, 0 );
 420         CombineRgn( hrgn, dc->hVisRgn, clip, RGN_AND );
 421         ret = RectInRegion( hrgn, &tmpRect );
 422         DeleteObject( hrgn );
 423     }
 424     else ret = RectInRegion( dc->hVisRgn, &tmpRect );
 425     GDI_ReleaseObj( hdc );
 426     return ret;
 427 }
 428
 429
 430 /***********************************************************************
 431  *           GetClipBox    (GDI32.@)
 432  */
 433 INT WINAPI GetClipBox( HDC hdc, LPRECT rect )
 434 {
 435     INT ret;
 436     HRGN clip;
 437     DC *dc = DC_GetDCUpdate( hdc );
 438     if (!dc) return ERROR;
 439     if ((clip = get_clip_region(dc)))
 440     {
 441         HRGN hrgn = CreateRectRgn( 0, 0, 0, 0 );
 442         CombineRgn( hrgn, dc->hVisRgn, clip, RGN_AND );
 443         ret = GetRgnBox( hrgn, rect );
 444         DeleteObject( hrgn );
 445     }
 446     else ret = GetRgnBox( dc->hVisRgn, rect );
 447     DPtoLP( hdc, (LPPOINT)rect, 2 );
 448     GDI_ReleaseObj( hdc );
 449     return ret;
 450 }
 451
 452
 453 /***********************************************************************
 454  *           GetClipRgn  (GDI32.@)
 455  */
 456 INT WINAPI GetClipRgn( HDC hdc, HRGN hRgn )
 457 {
 458     INT ret = -1;
 459     DC * dc;
 460     if (hRgn && (dc = DC_GetDCPtr( hdc )))
 461     {
 462       if( dc->hClipRgn )
 463       {
 464           if( CombineRgn(hRgn, dc->hClipRgn, 0, RGN_COPY) != ERROR ) ret = 1;
 465       }
 466       else ret = 0;
 467       GDI_ReleaseObj( hdc );
 468     }
 469     return ret;
 470 }
 471
 472
 473 /***********************************************************************
 474  *           GetMetaRgn    (GDI32.@)
 475  */
 476 INT WINAPI GetMetaRgn( HDC hdc, HRGN hRgn )
 477 {
 478     INT ret = 0;
 479     DC * dc = DC_GetDCPtr( hdc );
 480
 481     if (dc)
 482     {
 483         if (dc->hMetaRgn && CombineRgn( hRgn, dc->hMetaRgn, 0, RGN_COPY ) != ERROR)
 484             ret = 1;
 485         GDI_ReleaseObj( hdc );
 486     }
 487     return ret;
 488 }
 489
 490
 491 /***********************************************************************
 492  *           SaveVisRgn   (GDI.129)
 493  */
 494 HRGN16 WINAPI SaveVisRgn16( HDC16 hdc16 )
 495 {
 496     struct saved_visrgn *saved;
 497     HDC hdc = HDC_32( hdc16 );
 498     DC *dc = DC_GetDCUpdate( hdc );
 499
 500     if (!dc) return 0;
 501     TRACE("%p\n", hdc );
 502
 503     if (!(saved = HeapAlloc( GetProcessHeap(), 0, sizeof(*saved) ))) goto error;
 504     if (!(saved->hrgn = CreateRectRgn( 0, 0, 0, 0 ))) goto error;
 505     CombineRgn( saved->hrgn, dc->hVisRgn, 0, RGN_COPY );
 506     saved->next = dc->saved_visrgn;
 507     dc->saved_visrgn = saved;
 508     GDI_ReleaseObj( hdc );
 509     return HRGN_16(saved->hrgn);
 510
 511 error:
 512     GDI_ReleaseObj( hdc );
 513     HeapFree( GetProcessHeap(), 0, saved );
 514     return 0;
 515 }
 516
 517
 518 /***********************************************************************
 519  *           RestoreVisRgn   (GDI.130)
 520  */
 521 INT16 WINAPI RestoreVisRgn16( HDC16 hdc16 )
 522 {
 523     struct saved_visrgn *saved;
 524     HDC hdc = HDC_32( hdc16 );
 525     DC *dc = DC_GetDCPtr( hdc );
 526     INT16 ret = ERROR;
 527
 528     if (!dc) return ERROR;
 529
 530     TRACE("%p\n", hdc );
 531
 532     if (!(saved = dc->saved_visrgn)) goto done;
 533
 534     ret = CombineRgn( dc->hVisRgn, saved->hrgn, 0, RGN_COPY );
 535     dc->saved_visrgn = saved->next;
 536     DeleteObject( saved->hrgn );
 537     HeapFree( GetProcessHeap(), 0, saved );
 538     dc->flags &= ~DC_DIRTY;
 539     CLIPPING_UpdateGCRegion( dc );
 540  done:
 541     GDI_ReleaseObj( hdc );
 542     return ret;
 543 }
 544
 545
 546 /***********************************************************************
 547  * GetRandomRgn [GDI32.@]
 548  *
 549  * NOTES
 550  *     This function is documented in MSDN online for the case of
 551  *     iCode == SYSRGN (4).
 552  *
 553  *     For iCode == 1 it should return the clip region
 554  *                  2 "    "       "   the meta region
 555  *                  3 "    "       "   the intersection of the clip with
 556  *                                     the meta region (== 'Rao' region).
 557  *
 558  *     See http://www.codeproject.com/gdi/cliprgnguide.asp
 559  */
 560 INT WINAPI GetRandomRgn(HDC hDC, HRGN hRgn, INT iCode)
 561 {
 562     HRGN rgn;
 563     DC *dc = DC_GetDCPtr( hDC );
 564
 565     if (!dc) return -1;
 566
 567     switch (iCode)
 568     {
 569     case 1:
 570         rgn = dc->hClipRgn;
 571         break;
 572     case 2:
 573         rgn = dc->hMetaRgn;
 574         break;
 575     case 3:
 576         rgn = dc->hMetaClipRgn;
 577         if(!rgn) rgn = dc->hClipRgn;
 578         if(!rgn) rgn = dc->hMetaRgn;
 579         break;
 580     case SYSRGN: /* == 4 */
 581         rgn = dc->hVisRgn;
 582         break;
 583     default:
 584         WARN("Unknown code %d\n", iCode);
 585         GDI_ReleaseObj( hDC );
 586         return -1;
 587     }
 588     if (rgn) CombineRgn( hRgn, rgn, 0, RGN_COPY );
 589     GDI_ReleaseObj( hDC );
 590
 591     /* On Windows NT/2000, the SYSRGN returned is in screen coordinates */
 592     if (iCode == SYSRGN && !(GetVersion() & 0x80000000))
 593     {
 594         POINT org;
 595         GetDCOrgEx( hDC, &org );
 596         OffsetRgn( hRgn, org.x, org.y );
 597     }
 598     return (rgn != 0);
 599 }
 600
 601
 602 /***********************************************************************
 603  *           SetMetaRgn    (GDI32.@)
 604  */
 605 INT WINAPI SetMetaRgn( HDC hdc )
 606 {
 607     INT ret;
 608     RECT dummy;
 609     DC *dc = DC_GetDCPtr( hdc );
 610
 611     if (!dc) return ERROR;
 612
 613     if (dc->hMetaClipRgn)
 614     {
 615         /* the intersection becomes the new meta region */
 616         DeleteObject( dc->hMetaRgn );
 617         DeleteObject( dc->hClipRgn );
 618         dc->hMetaRgn = dc->hMetaClipRgn;
 619         dc->hClipRgn = 0;
 620         dc->hMetaClipRgn = 0;
 621     }
 622     else if (dc->hClipRgn)
 623     {
 624         dc->hMetaRgn = dc->hClipRgn;
 625         dc->hClipRgn = 0;
 626     }
 627     /* else nothing to do */
 628
 629     /* Note: no need to call CLIPPING_UpdateGCRegion, the overall clip region hasn't changed */
 630
 631     ret = GetRgnBox( dc->hMetaRgn, &dummy );
 632     GDI_ReleaseObj( hdc );
 633     return ret;
 634 }