Document wxFFile::GetName().

[wxWidgets.git] / src / gtk / region.cpp

diff --git a/src/gtk/region.cpp b/src/gtk/region.cpp
index 44019db1401ed7b61559e380d36351c4afba0c4c..92ec47f1e790cf18884d97512405345fee55a8d4 100644 (file)
--- a/src/gtk/region.cpp
+++ b/src/gtk/region.cpp
@@ -1,253 +1,474 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        region.cpp
+// Name:        src/gtk/region.cpp

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/98
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Modified:    VZ at 05.10.00: use AllocExclusive(), comparison fixed
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+// ============================================================================
+// declarations
+// ============================================================================

 
 

-#ifdef __GNUG__
-#pragma implementation "region.h"
-#endif
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"

 
 #include "wx/region.h"
 
 
 #include "wx/region.h"
 

-//-----------------------------------------------------------------------------
-// wxRegion
-//-----------------------------------------------------------------------------
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+#endif
+
+#include "wx/gtk/private.h"
+

 
 

-class wxRegionRefData: public wxObjectRefData
+// ----------------------------------------------------------------------------
+// wxRegionRefData: private class containing the information about the region
+// ----------------------------------------------------------------------------
+
+class wxRegionRefData : public wxGDIRefData

 {
 {

-  public:
-  
-    wxRegionRefData(void);
-    ~wxRegionRefData(void);
-  
-  public:    
+public:
+    wxRegionRefData()
+    {
+        m_region = NULL;
+    }
+
+    wxRegionRefData(const wxRegionRefData& refData)
+        : wxGDIRefData()
+    {
+        m_region = gdk_region_copy(refData.m_region);
+    }
+
+    virtual ~wxRegionRefData()
+    {
+        if (m_region)
+            gdk_region_destroy( m_region );
+    }

 
     GdkRegion  *m_region;
 };
 
 
     GdkRegion  *m_region;
 };
 

-wxRegionRefData::wxRegionRefData(void)
+// ----------------------------------------------------------------------------
+// macros
+// ----------------------------------------------------------------------------
+
+#define M_REGIONDATA ((wxRegionRefData *)m_refData)
+#define M_REGIONDATA_OF(rgn) ((wxRegionRefData *)(rgn.m_refData))
+
+IMPLEMENT_DYNAMIC_CLASS(wxRegion, wxGDIObject)
+IMPLEMENT_DYNAMIC_CLASS(wxRegionIterator,wxObject)
+
+// ----------------------------------------------------------------------------
+// wxRegion construction
+// ----------------------------------------------------------------------------
+
+#define M_REGIONDATA ((wxRegionRefData *)m_refData)
+
+void wxRegion::InitRect(wxCoord x, wxCoord y, wxCoord w, wxCoord h)

 {
 {

-  m_region = (GdkRegion *) NULL;
+    GdkRectangle rect;
+    rect.x = x;
+    rect.y = y;
+    rect.width = w;
+    rect.height = h;
+
+    m_refData = new wxRegionRefData();
+
+    M_REGIONDATA->m_region = gdk_region_rectangle( &rect );

 }
 
 }
 

-wxRegionRefData::~wxRegionRefData(void)
+wxRegion::wxRegion( GdkRegion *region )

 {
 {

-  if (m_region) gdk_region_destroy( m_region );
+    m_refData = new wxRegionRefData();
+    M_REGIONDATA->m_region = gdk_region_copy( region );

 }
 
 }
 

-//-----------------------------------------------------------------------------
+wxRegion::wxRegion( size_t n, const wxPoint *points,
+                    wxPolygonFillMode fillStyle )
+{
+    GdkPoint *gdkpoints = new GdkPoint[n];
+    for ( size_t i = 0 ; i < n ; i++ )
+    {
+        gdkpoints[i].x = points[i].x;
+        gdkpoints[i].y = points[i].y;
+    }
+
+    m_refData = new wxRegionRefData();
+
+    GdkRegion* reg = gdk_region_polygon
+                     (
+                        gdkpoints,
+                        n,
+                        fillStyle == wxWINDING_RULE ? GDK_WINDING_RULE
+                                                    : GDK_EVEN_ODD_RULE
+                     );
+
+    M_REGIONDATA->m_region = reg;
+
+    delete [] gdkpoints;
+}

 
 

-#define M_REGIONDATA ((wxRegionRefData *)m_refData)
+wxRegion::~wxRegion()
+{
+    // m_refData unrefed in ~wxObject
+}

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxRegion,wxGDIObject);
-  
-wxRegion::wxRegion( long x, long y, long w, long h )
+wxGDIRefData *wxRegion::CreateGDIRefData() const

 {
 {

-  m_refData = new wxRegionRefData();
-  GdkRegion *reg = gdk_region_new();
-  GdkRectangle rect;
-  rect.x = x;
-  rect.y = y;
-  rect.width = w;
-  rect.height = h;
-  M_REGIONDATA->m_region = gdk_region_union_with_rect( reg, &rect );
-  gdk_region_destroy( reg );
+    return new wxRegionRefData;

 }
 
 }
 

-wxRegion::wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight )
+wxGDIRefData *wxRegion::CloneGDIRefData(const wxGDIRefData *data) const

 {
 {

-  m_refData = new wxRegionRefData();
-  GdkRegion *reg = gdk_region_new();
-  GdkRectangle rect;
-  rect.x = topLeft.x;
-  rect.y = topLeft.y;
-  rect.width = bottomRight.x - rect.x;
-  rect.height = bottomRight.y - rect.y;
-  M_REGIONDATA->m_region = gdk_region_union_with_rect( reg, &rect );
-  gdk_region_destroy( reg );
+    return new wxRegionRefData(*(wxRegionRefData *)data);

 }
 
 }
 

-wxRegion::wxRegion( const wxRect& rect )
+// ----------------------------------------------------------------------------
+// wxRegion comparison
+// ----------------------------------------------------------------------------
+
+bool wxRegion::DoIsEqual(const wxRegion& region) const

 {
 {

-  m_refData = new wxRegionRefData();
-  GdkRegion *reg = gdk_region_new();
-  GdkRectangle g_rect;
-  g_rect.x = rect.x;
-  g_rect.y = rect.y;
-  g_rect.width = rect.width;
-  g_rect.height = rect.height;
-  M_REGIONDATA->m_region = gdk_region_union_with_rect( reg, &g_rect );
-  gdk_region_destroy( reg );
+    return gdk_region_equal(M_REGIONDATA->m_region,
+                            M_REGIONDATA_OF(region)->m_region);

 }
 
 }
 

-wxRegion::wxRegion(void)
+// ----------------------------------------------------------------------------
+// wxRegion operations
+// ----------------------------------------------------------------------------
+
+void wxRegion::Clear()

 {
 {

-  m_refData = new wxRegionRefData();
-  M_REGIONDATA->m_region = gdk_region_new();
+    UnRef();

 }
 
 }
 

-wxRegion::~wxRegion(void)
+bool wxRegion::DoUnionWithRect(const wxRect& r)

 {
 {

+    // workaround for a strange GTK/X11 bug: taking union with an empty
+    // rectangle results in an empty region which is definitely not what we
+    // want
+    if ( r.IsEmpty() )
+        return true;
+
+    if ( !m_refData )
+    {
+        InitRect(r.x, r.y, r.width, r.height);
+    }
+    else
+    {
+        AllocExclusive();
+
+        GdkRectangle rect;
+        rect.x = r.x;
+        rect.y = r.y;
+        rect.width = r.width;
+        rect.height = r.height;
+
+        gdk_region_union_with_rect( M_REGIONDATA->m_region, &rect );
+    }
+
+    return true;

 }
 
 }
 

-void wxRegion::Clear(void)
+bool wxRegion::DoUnionWithRegion( const wxRegion& region )

 {
 {

-  UnRef();
-  m_refData = new wxRegionRefData();
-  M_REGIONDATA->m_region = gdk_region_new();
+    wxCHECK_MSG( region.IsOk(), false, wxT("invalid region") );
+
+    if (!m_refData)
+    {
+        m_refData = new wxRegionRefData(*M_REGIONDATA_OF(region));
+    }
+    else
+    {
+        AllocExclusive();
+        gdk_region_union( M_REGIONDATA->m_region, region.GetRegion() );
+    }
+
+    return true;

 }
 
 }
 

-bool wxRegion::Union( long x, long y, long width, long height )
+bool wxRegion::DoIntersect( const wxRegion& region )

 {
 {

-  GdkRectangle rect;
-  rect.x = x;
-  rect.y = y;
-  rect.width = width;
-  rect.height = height;
-  GdkRegion *reg = gdk_region_union_with_rect( M_REGIONDATA->m_region, &rect );
-  gdk_region_destroy( M_REGIONDATA->m_region );
-  M_REGIONDATA->m_region = reg;
-  return TRUE;
+    wxCHECK_MSG( region.IsOk(), false, wxT("invalid region") );
+
+    if (!m_refData)
+    {
+        // intersecting with invalid region doesn't make sense
+        return false;
+    }
+
+    AllocExclusive();
+
+    gdk_region_intersect( M_REGIONDATA->m_region, region.GetRegion() );
+
+    return true;

 }
 
 }
 

-bool wxRegion::Union( const wxRect& rect )
+bool wxRegion::DoSubtract( const wxRegion& region )

 {
 {

-  GdkRectangle g_rect;
-  g_rect.x = rect.x;
-  g_rect.y = rect.y;
-  g_rect.width = rect.width;
-  g_rect.height = rect.height;
-  GdkRegion *reg = gdk_region_union_with_rect( M_REGIONDATA->m_region, &g_rect );
-  gdk_region_destroy( M_REGIONDATA->m_region );
-  M_REGIONDATA->m_region = reg;
-  return TRUE;
+    wxCHECK_MSG( region.IsOk(), false, wxT("invalid region") );
+
+    if (!m_refData)
+    {
+        // subtracting from an invalid region doesn't make sense
+        return false;
+    }
+
+    AllocExclusive();
+
+    gdk_region_subtract( M_REGIONDATA->m_region, region.GetRegion() );
+
+    return true;

 }
 
 }
 

-bool wxRegion::Union( const wxRegion& region )
+bool wxRegion::DoXor( const wxRegion& region )

 {
 {

-  GdkRegion *reg = gdk_regions_union( M_REGIONDATA->m_region, region.GetRegion() );
-  gdk_region_destroy( M_REGIONDATA->m_region );
-  M_REGIONDATA->m_region = reg;
-  return TRUE;
+    wxCHECK_MSG( region.IsOk(), false, wxT("invalid region") );
+
+    if (!m_refData)
+    {
+        // XOR-ing with an invalid region is the same as XOR-ing with an empty
+        // one, i.e. it is simply a copy.
+        m_refData = new wxRegionRefData(*M_REGIONDATA_OF(region));
+    }
+    else
+    {
+        AllocExclusive();
+
+        gdk_region_xor( M_REGIONDATA->m_region, region.GetRegion() );
+    }
+
+    return true;

 }
 
 }
 

-bool wxRegion::Intersect( long x, long y, long width, long height )
+bool wxRegion::DoOffset( wxCoord x, wxCoord y )

 {
 {

-  wxRegion reg( x, y, width, height );
-  Intersect( reg );
-  return TRUE;
+    wxCHECK_MSG( m_refData, false, wxS("invalid region") );
+
+    AllocExclusive();
+
+    gdk_region_offset( M_REGIONDATA->m_region, x, y );
+
+    return true;

 }
 
 }
 

-bool wxRegion::Intersect( const wxRect& rect )
+// ----------------------------------------------------------------------------
+// wxRegion tests
+// ----------------------------------------------------------------------------
+
+bool wxRegion::DoGetBox( wxCoord &x, wxCoord &y, wxCoord &w, wxCoord &h ) const

 {
 {

-  wxRegion reg( rect );
-  Intersect( reg );
-  return TRUE;
+    if ( m_refData )
+    {
+        GdkRectangle rect;
+        gdk_region_get_clipbox( M_REGIONDATA->m_region, &rect );
+        x = rect.x;
+        y = rect.y;
+        w = rect.width;
+        h = rect.height;
+
+        return true;
+    }
+    else
+    {
+        x = 0;
+        y = 0;
+        w = -1;
+        h = -1;
+
+        return false;
+    }

 }
 
 }
 

-bool wxRegion::Intersect( const wxRegion& region )
+bool wxRegion::IsEmpty() const

 {
 {

-  GdkRegion *reg = gdk_regions_intersect( M_REGIONDATA->m_region, region.GetRegion() );
-  gdk_region_destroy( M_REGIONDATA->m_region );
-  M_REGIONDATA->m_region = reg;
-  return TRUE;
+    if (!m_refData)
+        return true;
+
+    return gdk_region_empty( M_REGIONDATA->m_region );

 }
 
 }
 

-bool wxRegion::Subtract( long x, long y, long width, long height )
+wxRegionContain wxRegion::DoContainsPoint( wxCoord x, wxCoord y ) const

 {
 {

-  wxRegion reg( x, y, width, height );
-  Subtract( reg );
-  return TRUE;
+    if (!m_refData)
+        return wxOutRegion;
+
+    if (gdk_region_point_in( M_REGIONDATA->m_region, x, y ))
+        return wxInRegion;
+    else
+        return wxOutRegion;

 }
 
 }
 

-bool wxRegion::Subtract( const wxRect& rect )
+wxRegionContain wxRegion::DoContainsRect(const wxRect& r) const

 {
 {

-  wxRegion reg( rect );
-  Subtract( reg );
-  return TRUE;
+    if (!m_refData)
+        return wxOutRegion;
+
+    GdkRectangle rect;
+    rect.x = r.x;
+    rect.y = r.y;
+    rect.width = r.width;
+    rect.height = r.height;
+    GdkOverlapType res = gdk_region_rect_in( M_REGIONDATA->m_region, &rect );
+    switch (res)
+    {
+        case GDK_OVERLAP_RECTANGLE_IN:   return wxInRegion;
+        case GDK_OVERLAP_RECTANGLE_OUT:  return wxOutRegion;
+        case GDK_OVERLAP_RECTANGLE_PART: return wxPartRegion;
+    }
+    return wxOutRegion;

 }
 
 }
 

-bool wxRegion::Subtract( const wxRegion& region )
+GdkRegion *wxRegion::GetRegion() const

 {
 {

-  GdkRegion *reg = gdk_regions_subtract( M_REGIONDATA->m_region, region.GetRegion() );
-  gdk_region_destroy( M_REGIONDATA->m_region );
-  M_REGIONDATA->m_region = reg;
-  return TRUE;
+    if (!m_refData)
+        return NULL;
+
+    return M_REGIONDATA->m_region;

 }
 
 }
 

-bool wxRegion::Xor( long x, long y, long width, long height )
+// ----------------------------------------------------------------------------
+// wxRegionIterator
+// ----------------------------------------------------------------------------
+
+wxRegionIterator::wxRegionIterator()

 {
 {

-  wxRegion reg( x, y, width, height );
-  Xor( reg );
-  return TRUE;
+    Init();
+    Reset();

 }
 
 }
 

-bool wxRegion::Xor( const wxRect& rect )
+wxRegionIterator::wxRegionIterator( const wxRegion& region )

 {
 {

-  wxRegion reg( rect );
-  Xor( reg );
-  return TRUE;
+    Init();
+    Reset(region);

 }
 
 }
 

-bool wxRegion::Xor( const wxRegion& region )
+void wxRegionIterator::Init()

 {
 {

-  GdkRegion *reg = gdk_regions_xor( M_REGIONDATA->m_region, region.GetRegion() );
-  gdk_region_destroy( M_REGIONDATA->m_region );
-  M_REGIONDATA->m_region = reg;
-  return TRUE;
+    m_rects = NULL;
+    m_numRects = 0;

 }
 
 }
 

-void wxRegion::GetBox( long& x, long& y, long&w, long &h ) const
+wxRegionIterator::~wxRegionIterator()

 {
 {

-  x = 0;
-  y = 0;
-  w = -1;
-  h = -1;
+    wxDELETEA(m_rects);

 }
 
 }
 

-wxRect wxRegion::GetBox(void) const
+void wxRegionIterator::CreateRects( const wxRegion& region )

 {
 {

-  return wxRect( 0, 0, -1, -1 );
+    wxDELETEA(m_rects);
+    m_numRects = 0;
+
+    GdkRegion *gdkregion = region.GetRegion();
+    if (!gdkregion)
+        return;
+
+    GdkRectangle* gdkrects;
+    gdk_region_get_rectangles(gdkregion, &gdkrects, &m_numRects);
+
+    if (m_numRects)
+    {
+        m_rects = new wxRect[m_numRects];
+        for (int i = 0; i < m_numRects; ++i)
+        {
+            GdkRectangle &gr = gdkrects[i];
+            wxRect &wr = m_rects[i];
+            wr.x = gr.x;
+            wr.y = gr.y;
+            wr.width = gr.width;
+            wr.height = gr.height;
+        }
+    }
+    g_free( gdkrects );

 }
 
 }
 

-bool wxRegion::Empty(void) const
+void wxRegionIterator::Reset( const wxRegion& region )

 {
 {

-  return gdk_region_empty( M_REGIONDATA->m_region );
+    m_region = region;
+    CreateRects(region);
+    Reset();

 }
 
 }
 

-wxRegionContain wxRegion::Contains( long x, long y ) const
+bool wxRegionIterator::HaveRects() const

 {
 {

-  if (gdk_region_point_in( M_REGIONDATA->m_region, x, y ))
-    return wxInRegion;
-  else
-    return wxOutRegion;
+    return m_current < m_numRects;
+}
+
+wxRegionIterator& wxRegionIterator::operator ++ ()
+{
+    if (HaveRects())
+        ++m_current;
+
+    return *this;
+}
+
+wxRegionIterator wxRegionIterator::operator ++ (int)
+{
+    wxRegionIterator tmp = *this;
+
+    if (HaveRects())
+        ++m_current;
+
+    return tmp;

 }
 
 }
 

-wxRegionContain wxRegion::Contains( long x, long y, long w, long h ) const
+wxCoord wxRegionIterator::GetX() const

 {
 {

-  GdkRectangle rect;
-  rect.x = x;
-  rect.y = y;
-  rect.width = w;
-  rect.height = h;
-  GdkOverlapType res = gdk_region_rect_in( M_REGIONDATA->m_region, &rect );
-  switch (res)
-  {
-   case GDK_OVERLAP_RECTANGLE_IN:   return wxInRegion;
-   case GDK_OVERLAP_RECTANGLE_OUT:  return wxOutRegion;
-   case GDK_OVERLAP_RECTANGLE_PART: return wxPartRegion;
-  }
-  return wxOutRegion;
+    wxCHECK_MSG( HaveRects(), 0, wxT("invalid wxRegionIterator") );
+
+    return m_rects[m_current].x;
+}
+
+wxCoord wxRegionIterator::GetY() const
+{
+    wxCHECK_MSG( HaveRects(), 0, wxT("invalid wxRegionIterator") );
+
+    return m_rects[m_current].y;
+}
+
+wxCoord wxRegionIterator::GetW() const
+{
+    wxCHECK_MSG( HaveRects(), 0, wxT("invalid wxRegionIterator") );
+
+    return m_rects[m_current].width;
+}
+
+wxCoord wxRegionIterator::GetH() const
+{
+    wxCHECK_MSG( HaveRects(), 0, wxT("invalid wxRegionIterator") );
+
+    return m_rects[m_current].height;

 }
 
 }
 

-GdkRegion *wxRegion::GetRegion(void) const
+wxRect wxRegionIterator::GetRect() const

 {
 {

-  return M_REGIONDATA->m_region;
+    wxRect r;
+    if( HaveRects() )
+        r = m_rects[m_current];
+
+    return r;

 }
 
 }
 

+wxRegionIterator& wxRegionIterator::operator=(const wxRegionIterator& ri)
+{
+    if (this != &ri)
+    {
+        wxDELETEA(m_rects);
+
+        m_current = ri.m_current;
+        m_numRects = ri.m_numRects;
+        if ( m_numRects )
+        {
+            m_rects = new wxRect[m_numRects];
+            memcpy(m_rects, ri.m_rects, m_numRects * sizeof m_rects[0]);
+        }
+    }
+    return *this;
+}