src/msw/region.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:      msw/region.cpp
   3 // Purpose:   Region handling for wxWindows/X11
   4 // Author:    Markus Holzem
   5 // Modified by:
   6 // Created:   Fri Oct 24 10:46:34 MET 1997
   7 // RCS-ID:    $Id$
   8 // Copyright: (c) 1997 Julian Smart and Markus Holzem
   9 // Licence:   wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifdef __GNUG__
  13 #pragma implementation "region.h"
  14 #endif
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #ifdef __BORLANDC__
  20 #pragma hdrstop
  21 #endif
  22
  23 #include "wx/msw/region.h"
  24 #include "wx/gdicmn.h"
  25
  26 #include "wx/window.h"
  27 #include "wx/msw/private.h"
  28
  29     IMPLEMENT_DYNAMIC_CLASS(wxRegion, wxGDIObject)
  30     IMPLEMENT_DYNAMIC_CLASS(wxRegionIterator, wxObject)
  31
  32 //-----------------------------------------------------------------------------
  33 // wxRegionRefData implementation
  34 //-----------------------------------------------------------------------------
  35
  36 class WXDLLEXPORT wxRegionRefData : public wxGDIRefData
  37 {
  38 public:
  39     wxRegionRefData()
  40     {
  41         m_region = 0;
  42     }
  43
  44     wxRegionRefData(const wxRegionRefData& data)
  45     {
  46 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
  47         DWORD noBytes = ::GetRegionData(data.m_region, 0, NULL);
  48         RGNDATA *rgnData = (RGNDATA*) new char[noBytes];
  49         ::GetRegionData(data.m_region, noBytes, rgnData);
  50         m_region = ::ExtCreateRegion(NULL, noBytes, rgnData);
  51         delete[] (char*) rgnData;
  52 #else
  53         RECT rect;
  54         ::GetRgnBox(data.m_region, &rect);
  55         m_region = ::CreateRectRgnIndirect(&rect);
  56 #endif
  57     }
  58
  59     ~wxRegionRefData()
  60     {
  61         ::DeleteObject(m_region);
  62         m_region = 0;
  63     }
  64
  65     HRGN m_region;
  66 };
  67
  68 #define M_REGION (((wxRegionRefData*)m_refData)->m_region)
  69
  70 //-----------------------------------------------------------------------------
  71 // wxRegion
  72 //-----------------------------------------------------------------------------
  73
  74 /*
  75  * Create an empty region.
  76  */
  77 wxRegion::wxRegion()
  78 {
  79     m_refData = (wxRegionRefData *)NULL;
  80 }
  81
  82 wxRegion::wxRegion(WXHRGN hRegion)
  83 {
  84     m_refData = new wxRegionRefData;
  85     M_REGION = (HRGN) hRegion;
  86 }
  87
  88 wxRegion::wxRegion(wxCoord x, wxCoord y, wxCoord w, wxCoord h)
  89 {
  90     m_refData = new wxRegionRefData;
  91     M_REGION = ::CreateRectRgn(x, y, x + w, y + h);
  92 }
  93
  94 wxRegion::wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight)
  95 {
  96     m_refData = new wxRegionRefData;
  97     M_REGION = ::CreateRectRgn(topLeft.x, topLeft.y, bottomRight.x, bottomRight.y);
  98 }
  99
 100 wxRegion::wxRegion(const wxRect& rect)
 101 {
 102     m_refData = new wxRegionRefData;
 103     M_REGION = ::CreateRectRgn(rect.x, rect.y, rect.x + rect.width, rect.y + rect.height);
 104 }
 105
 106 /*
 107  * Destroy the region.
 108  */
 109 wxRegion::~wxRegion()
 110 {
 111     // m_refData unrefed in ~wxObject
 112 }
 113
 114 //-----------------------------------------------------------------------------
 115 // Modify region
 116 //-----------------------------------------------------------------------------
 117
 118 // Clear current region
 119 void wxRegion::Clear()
 120 {
 121     UnRef();
 122 }
 123
 124 // Combine rectangle (x, y, w, h) with this.
 125 bool wxRegion::Combine(wxCoord x, wxCoord y, wxCoord width, wxCoord height, wxRegionOp op)
 126 {
 127     // Don't change shared data
 128     if (!m_refData) {
 129         m_refData = new wxRegionRefData();
 130     } else if (m_refData->GetRefCount() > 1) {
 131         wxRegionRefData* ref = (wxRegionRefData*)m_refData;
 132         UnRef();
 133         m_refData = new wxRegionRefData(*ref);
 134     }
 135     // If ref count is 1, that means it's 'ours' anyway so no action.
 136
 137     HRGN rectRegion = ::CreateRectRgn(x, y, x + width, y + height);
 138
 139     int mode = 0;
 140     switch (op)
 141     {
 142         case wxRGN_AND: mode = RGN_AND; break ;
 143         case wxRGN_OR: mode = RGN_OR; break ;
 144         case wxRGN_XOR: mode = RGN_XOR; break ;
 145         case wxRGN_DIFF: mode = RGN_DIFF; break ;
 146         case wxRGN_COPY:
 147         default:
 148             mode = RGN_COPY; break ;
 149     }
 150
 151     bool success = (ERROR != ::CombineRgn(M_REGION, M_REGION, rectRegion, mode));
 152
 153     ::DeleteObject(rectRegion);
 154
 155     return success;
 156 }
 157
 158 // Union /e region with this.
 159 bool wxRegion::Combine(const wxRegion& region, wxRegionOp op)
 160 {
 161     if (region.Empty())
 162         return FALSE;
 163
 164     // Don't change shared data
 165     if (!m_refData) {
 166         m_refData = new wxRegionRefData();
 167     } else    if (m_refData->GetRefCount() > 1) {
 168         wxRegionRefData* ref = (wxRegionRefData*)m_refData;
 169         UnRef();
 170         m_refData = new wxRegionRefData(*ref);
 171     }
 172
 173     int mode = 0;
 174     switch (op)
 175     {
 176         case wxRGN_AND: mode = RGN_AND; break ;
 177         case wxRGN_OR: mode = RGN_OR; break ;
 178         case wxRGN_XOR: mode = RGN_XOR; break ;
 179         case wxRGN_DIFF: mode = RGN_DIFF; break ;
 180         case wxRGN_COPY:
 181         default:
 182             mode = RGN_COPY; break ;
 183     }
 184
 185     return (ERROR != ::CombineRgn(M_REGION, M_REGION, ((wxRegionRefData*)region.m_refData)->m_region, mode));
 186 }
 187
 188 bool wxRegion::Combine(const wxRect& rect, wxRegionOp op)
 189 {
 190     return Combine(rect.GetLeft(), rect.GetTop(), rect.GetWidth(), rect.GetHeight(), op);
 191 }
 192
 193 //-----------------------------------------------------------------------------
 194 // Information on region
 195 //-----------------------------------------------------------------------------
 196
 197 // Outer bounds of region
 198 void wxRegion::GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const
 199 {
 200     if (m_refData) {
 201         RECT rect;
 202         ::GetRgnBox(M_REGION, & rect);
 203         x = rect.left;
 204         y = rect.top;
 205         w = rect.right - rect.left;
 206         h = rect.bottom - rect.top;
 207     } else {
 208         x = y = w = h = 0;
 209     }
 210 }
 211
 212 wxRect wxRegion::GetBox() const
 213 {
 214     wxCoord x, y, w, h;
 215     GetBox(x, y, w, h);
 216     return wxRect(x, y, w, h);
 217 }
 218
 219 // Is region empty?
 220 bool wxRegion::Empty() const
 221 {
 222     if (M_REGION == 0)
 223         return TRUE;
 224     wxCoord x, y, w, h;
 225     GetBox(x, y, w, h);
 226
 227     return ((w == 0) && (h == 0));
 228 }
 229
 230 //-----------------------------------------------------------------------------
 231 // Tests
 232 //-----------------------------------------------------------------------------
 233
 234 // Does the region contain the point (x,y)?
 235 wxRegionContain wxRegion::Contains(wxCoord x, wxCoord y) const
 236 {
 237     if (!m_refData)
 238         return wxOutRegion;
 239
 240     if (::PtInRegion(M_REGION, (int) x, (int) y))
 241         return wxInRegion;
 242     else
 243         return wxOutRegion;
 244 }
 245
 246 // Does the region contain the point pt?
 247 wxRegionContain wxRegion::Contains(const wxPoint& pt) const
 248 {
 249     if (!m_refData)
 250         return wxOutRegion;
 251
 252     if (::PtInRegion(M_REGION, (int) pt.x, (int) pt.y))
 253         return wxInRegion;
 254     else
 255         return wxOutRegion;
 256 }
 257
 258 // Does the region contain the rectangle (x, y, w, h)?
 259 wxRegionContain wxRegion::Contains(wxCoord x, wxCoord y, wxCoord w, wxCoord h) const
 260 {
 261     if (!m_refData)
 262         return wxOutRegion;
 263
 264     RECT rect;
 265     rect.left = x;
 266     rect.top = y;
 267     rect.right = x + w;
 268     rect.bottom = y + h;
 269
 270     if (::RectInRegion(M_REGION, & rect))
 271         return wxInRegion;
 272     else
 273         return wxOutRegion;
 274 }
 275
 276 // Does the region contain the rectangle rect
 277 wxRegionContain wxRegion::Contains(const wxRect& rect) const
 278 {
 279     if (!m_refData)
 280         return wxOutRegion;
 281
 282     wxCoord x, y, w, h;
 283     x = rect.x;
 284     y = rect.y;
 285     w = rect.GetWidth();
 286     h = rect.GetHeight();
 287     return Contains(x, y, w, h);
 288 }
 289
 290 // Get internal region handle
 291 WXHRGN wxRegion::GetHRGN() const
 292 {
 293     if (!m_refData)
 294         return (WXHRGN) 0;
 295     return (WXHRGN) M_REGION;
 296 }
 297
 298 ///////////////////////////////////////////////////////////////////////////////
 299 //                                                                             //
 300 //                               wxRegionIterator                                 //
 301 //                                                                             //
 302 ///////////////////////////////////////////////////////////////////////////////
 303
 304 /*
 305  * Initialize empty iterator
 306  */
 307 wxRegionIterator::wxRegionIterator() : m_current(0), m_numRects(0), m_rects(NULL)
 308 {
 309 }
 310
 311 wxRegionIterator::~wxRegionIterator()
 312 {
 313     if (m_rects)
 314         delete[] m_rects;
 315 }
 316
 317 /*
 318  * Initialize iterator for region
 319  */
 320 wxRegionIterator::wxRegionIterator(const wxRegion& region)
 321 {
 322     m_rects = NULL;
 323
 324     Reset(region);
 325 }
 326
 327 /*
 328  * Reset iterator for a new /e region.
 329  */
 330 void wxRegionIterator::Reset(const wxRegion& region)
 331 {
 332     m_current = 0;
 333     m_region = region;
 334
 335     if (m_rects)
 336         delete[] m_rects;
 337
 338     m_rects = NULL;
 339
 340     if (m_region.Empty())
 341         m_numRects = 0;
 342     else
 343     {
 344 #if defined(__WIN32__)
 345         DWORD noBytes = ::GetRegionData(((wxRegionRefData*)region.m_refData)->m_region, 0, NULL);
 346         RGNDATA *rgnData = (RGNDATA*) new char[noBytes];
 347         ::GetRegionData(((wxRegionRefData*)region.m_refData)->m_region, noBytes, rgnData);
 348
 349         RGNDATAHEADER* header = (RGNDATAHEADER*) rgnData;
 350
 351         m_rects = new wxRect[header->nCount];
 352
 353         RECT* rect = (RECT*) ((char*)rgnData + sizeof(RGNDATAHEADER)) ;
 354         size_t i;
 355         for (i = 0; i < header->nCount; i++)
 356         {
 357             m_rects[i] = wxRect(rect->left, rect->top,
 358                                  rect->right - rect->left, rect->bottom - rect->top);
 359             rect ++; // Advances pointer by sizeof(RECT)
 360         }
 361
 362         m_numRects = header->nCount;
 363
 364         delete[] (char*) rgnData;
 365 #else
 366         RECT rect;
 367         ::GetRgnBox(((wxRegionRefData*)region.m_refData)->m_region, &rect);
 368         m_rects = new wxRect[1];
 369         m_rects[0].x = rect.left;
 370         m_rects[0].y = rect.top;
 371         m_rects[0].width = rect.right - rect.left;
 372         m_rects[0].height = rect.bottom - rect.top;
 373
 374         m_numRects = 1;
 375 #endif
 376     }
 377 }
 378
 379 /*
 380  * Increment iterator. The rectangle returned is the one after the
 381  * incrementation.
 382  */
 383 void wxRegionIterator::operator ++ ()
 384 {
 385     if (m_current < m_numRects)
 386         ++m_current;
 387 }
 388
 389 /*
 390  * Increment iterator. The rectangle returned is the one before the
 391  * incrementation.
 392  */
 393 void wxRegionIterator::operator ++ (int)
 394 {
 395     if (m_current < m_numRects)
 396         ++m_current;
 397 }
 398
 399 wxCoord wxRegionIterator::GetX() const
 400 {
 401     if (m_current < m_numRects)
 402         return m_rects[m_current].x;
 403     return 0;
 404 }
 405
 406 wxCoord wxRegionIterator::GetY() const
 407 {
 408     if (m_current < m_numRects)
 409         return m_rects[m_current].y;
 410     return 0;
 411 }
 412
 413 wxCoord wxRegionIterator::GetW() const
 414 {
 415     if (m_current < m_numRects)
 416         return m_rects[m_current].width ;
 417     return 0;
 418 }
 419
 420 wxCoord wxRegionIterator::GetH() const
 421 {
 422     if (m_current < m_numRects)
 423         return m_rects[m_current].height;
 424     return 0;
 425 }
 426