From bc5e942bf3972629a0800d1653e20e177d8fa859 Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Thu, 24 May 2007 01:47:29 +0000
Subject: [PATCH] added wxRect::operator+() and *() (union and intersection);
 also made other operators friends instead of members (patch 1589175)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@46191 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/changes.txt         |   1 +
 docs/latex/wx/point.tex  |  18 ++--
 docs/latex/wx/rect.tex   |  22 ++++-
 docs/latex/wx/size.tex   |  14 +--
 include/wx/gdicmn.h      | 192 ++++++++++++++++++++++++++++++---------
 src/common/gdicmn.cpp    |  49 ++++++----
 tests/geometry/point.cpp |   4 +
 tests/geometry/rect.cpp  |   8 ++
 tests/geometry/size.cpp  |   2 +
 9 files changed, 236 insertions(+), 74 deletions(-)

diff --git a/docs/changes.txt b/docs/changes.txt
index 44c7cb03d1..ad4a96e641 100644
--- a/docs/changes.txt
+++ b/docs/changes.txt
@@ -115,6 +115,7 @@ All (GUI):
 - Add support for <data> tags to wxrc
 - Support wxAPPLY and wxCLOSE in CreateStdDialogButtonSizer() (Marcin Wojdyr)
 - Show standard options in wxCmdLineParser usage message (Francesco Montorsi)
+- Added wxRect::operator+ (union) and * (intersection) (bdonner)
 
 wxGTK:
 
diff --git a/docs/latex/wx/point.tex b/docs/latex/wx/point.tex
index a1393199a5..d8f5cb193e 100644
--- a/docs/latex/wx/point.tex
+++ b/docs/latex/wx/point.tex
@@ -56,13 +56,13 @@ y member.
 Assignment operator.
 
 
-\func{bool}{operator $==$}{\param{const wxPoint\& }{pt}}
+\func{bool}{operator $==$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
 
-\func{bool}{operator $!=$}{\param{const wxPoint\& }{pt}}
+\func{bool}{operator $!=$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
 
-\func{wxPoint}{operator $+$}{\param{const wxPoint\& }{pt}}
+\func{wxPoint}{operator $+$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
 
-\func{wxPoint}{operator $-$}{\param{const wxPoint\& }{pt}}
+\func{wxPoint}{operator $-$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
 
 \func{wxPoint\&}{operator $+=$}{\param{const wxPoint\& }{pt}}
 
@@ -71,14 +71,18 @@ Assignment operator.
 Operators for comparison, sum and subtraction between \helpref{wxPoint}{wxpoint} objects.
 
 
-\func{wxPoint}{operator $+$}{\param{const wxSize\& }{sz}}
+\func{wxPoint}{operator $+$}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}
 
-\func{wxPoint}{operator $-$}{\param{const wxSize\& }{sz}}
+\func{wxPoint}{operator $-$}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}
+
+\func{wxPoint}{operator $+$}{\param{const wxSize\& }{sz}, \param{const wxPoint\& }{pt}}
+
+\func{wxPoint}{operator $-$}{\param{const wxSize\& }{sz}, \param{const wxPoint\& }{pt}}
 
 \func{wxPoint\&}{operator $+=$}{\param{const wxSize\& }{sz}}
 
 \func{wxPoint\&}{operator $-=$}{\param{const wxSize\& }{sz}}
- 
+
 Operators for sum and subtraction between a \helpref{wxPoint}{wxpoint} object and a
 \helpref{wxSize}{wxsize} object.
 
diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex
index a6c97fd2cc..4885f61c97 100644
--- a/docs/latex/wx/rect.tex
+++ b/docs/latex/wx/rect.tex
@@ -354,14 +354,32 @@ Assignment operator.
 
 \membersection{wxRect::operator $==$}\label{wxrectequal}
 
-\func{bool}{operator $==$}{\param{const wxRect\& }{rect}}
+\func{bool}{operator $==$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}}
 
 Equality operator.
 
 
 \membersection{wxRect::operator $!=$}\label{wxrectnotequal}
 
-\func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}
+\func{bool}{operator $!=$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}}
 
 Inequality operator.
 
+
+\func{wxRect}{operator $+$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}}
+
+\func{wxRect\&}{operator $+=$}{\param{const wxRect\& }{r}}
+
+Like \helpref{Union}{wxrectunion} but don't treat empty rectangles specially.
+
+\wxheading{See also}
+
+\helpref{wxRect::Union}{wxrectunion}
+
+
+\func{wxRect}{operator $*$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}}
+
+\func{wxRect\&}{operator $*=$}{\param{const wxRect\& }{r}}
+
+Returns the intersection of two rectangles (which may be empty).
+
diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex
index 0877512c16..69d051bba5 100644
--- a/docs/latex/wx/size.tex
+++ b/docs/latex/wx/size.tex
@@ -198,13 +198,13 @@ Sets the width.
 Assignment operator.
 
 
-\constfunc{bool}{operator $==$}{\param{const wxSize\& }{sz}}
+\func{bool}{operator $==$}{\param{const wxSize\& }{s1}, \param{const wxSize\& }{s2}}
 
-\constfunc{bool}{operator $!=$}{\param{const wxSize\& }{sz}}
+\func{bool}{operator $!=$}{\param{const wxSize\& }{s1}, \param{const wxSize\& }{s2}}
 
-\func{wxSize}{operator $+$}{\param{const wxSize\& }{sz}}
+\func{wxSize}{operator $+$}{\param{const wxSize\& }{s1}, \param{const wxSize\& }{s2}}
 
-\func{wxSize}{operator $-$}{\param{const wxSize\& }{sz}}
+\func{wxSize}{operator $-$}{\param{const wxSize\& }{s1}, \param{const wxSize\& }{s2}}
 
 \func{wxSize\&}{operator $+=$}{\param{const wxSize\& }{sz}}
 
@@ -213,9 +213,11 @@ Assignment operator.
 Operators for comparison, sum and subtraction between \helpref{wxSize}{wxsize} objects.
 
 
-\func{wxSize}{operator $/$}{\param{int }{factor}}
+\func{wxSize}{operator $/$}{\param{const wxSize\& }{sz}, \param{int }{factor}}
 
-\func{wxSize}{operator $*$}{\param{int }{factor}}
+\func{wxSize}{operator $*$}{\param{const wxSize\& }{sz}, \param{int }{factor}}
+
+\func{wxSize}{operator $*$}{\param{int }{factor}, \param{const wxSize\& }{sz}}
 
 \func{wxSize\&}{operator $/=$}{\param{int }{factor}}
 
diff --git a/include/wx/gdicmn.h b/include/wx/gdicmn.h
index acd374d4c3..b39ba86cc9 100644
--- a/include/wx/gdicmn.h
+++ b/include/wx/gdicmn.h
@@ -38,6 +38,7 @@ class WXDLLIMPEXP_CORE wxPen;
 class WXDLLIMPEXP_CORE wxRegion;
 class WXDLLIMPEXP_BASE wxString;
 class WXDLLIMPEXP_CORE wxIconBundle;
+class WXDLLIMPEXP_CORE wxPoint;
 
 // ---------------------------------------------------------------------------
 // constants
@@ -217,18 +218,10 @@ public:
 
     // no copy ctor or assignment operator - the defaults are ok
 
-    bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
-    bool operator!=(const wxSize& sz) const { return x != sz.x || y != sz.y; }
-
-    wxSize operator+(const wxSize& sz) const { return wxSize(x + sz.x, y + sz.y); }
-    wxSize operator-(const wxSize& sz) const { return wxSize(x - sz.x, y - sz.y); }
-    wxSize operator/(int i) const { return wxSize(x / i, y / i); }
-    wxSize operator*(int i) const { return wxSize(x * i, y * i); }
-
     wxSize& operator+=(const wxSize& sz) { x += sz.x; y += sz.y; return *this; }
     wxSize& operator-=(const wxSize& sz) { x -= sz.x; y -= sz.y; return *this; }
-    wxSize& operator/=(const int i) { x /= i; y /= i; return *this; }
-    wxSize& operator*=(const int i) { x *= i; y *= i; return *this; }
+    wxSize& operator/=(int i) { x /= i; y /= i; return *this; }
+    wxSize& operator*=(int i) { x *= i; y *= i; return *this; }
 
     void IncTo(const wxSize& sz)
         { if ( sz.x > x ) x = sz.x; if ( sz.y > y ) y = sz.y; }
@@ -272,6 +265,50 @@ public:
     int GetY() const { return y; }
 };
 
+
+inline bool operator==(const wxSize& s1, const wxSize& s2)
+{
+    return s1.x == s2.x && s1.y == s2.y;
+}
+
+inline bool operator!=(const wxSize& s1, const wxSize& s2)
+{
+    return s1.x != s2.x || s1.y != s2.y;
+}
+
+
+inline wxSize operator+(const wxSize& s1, const wxSize& s2)
+{
+    return wxSize(s1.x + s2.x, s1.y + s2.y);
+}
+
+
+inline wxSize operator-(const wxSize& s1, const wxSize& s2)
+{
+    return wxSize(s1.x - s2.x, s1.y - s2.y);
+}
+
+
+inline wxSize operator/(const wxSize& s, int i)
+{
+    return wxSize(s.x / i, s.y / i);
+}
+
+
+inline wxSize operator*(const wxSize& s, int i)
+{
+    return wxSize(s.x * i, s.y * i);
+}
+
+
+inline wxSize operator*(int i, const wxSize& s)
+{
+    return wxSize(s.x * i, s.y * i);
+}
+
+
+
+
 // ---------------------------------------------------------------------------
 // Point classes: with real or integer coordinates
 // ---------------------------------------------------------------------------
@@ -284,18 +321,37 @@ public:
 
     wxRealPoint() : x(0.0), y(0.0) { }
     wxRealPoint(double xx, double yy) : x(xx), y(yy) { }
+};
 
-    wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
-    wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }
 
-    bool operator==(const wxRealPoint& pt) const
-    {
-        return wxIsSameDouble(x, pt.x) && wxIsSameDouble(y, pt.y);
-    }
-    bool operator!=(const wxRealPoint& pt) const { return !(*this == pt); }
-};
+inline bool operator==(const wxRealPoint& p1, const wxRealPoint& p2)
+{
+    return wxIsSameDouble(p1.x, p2.x) && wxIsSameDouble(p1.y, p2.y);
+}
+
+
+inline bool operator!=(const wxRealPoint& p1, const wxRealPoint& p2)
+{
+    return !(p1 == p2);
+}
+
+
+inline wxRealPoint operator+(const wxRealPoint& p1, const wxRealPoint& p2)
+{
+    return wxRealPoint(p1.x + p2.x, p1.y + p2.y);
+}
+
+
+inline wxRealPoint operator-(const wxRealPoint& p1, const wxRealPoint& p2)
+{
+    return wxRealPoint(p1.x - p2.x, p1.y - p2.y);
+}
 
 
+// ----------------------------------------------------------------------------
+// wxPoint: 2D point with integer coordinates
+// ----------------------------------------------------------------------------
+
 class WXDLLEXPORT wxPoint
 {
 public:
@@ -306,25 +362,63 @@ public:
 
     // no copy ctor or assignment operator - the defaults are ok
 
-    // comparison
-    bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
-    bool operator!=(const wxPoint& p) const { return !(*this == p); }
-
-    // arithmetic operations (component wise)
-    wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
-    wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }
-
+    //assignment operators
     wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
     wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
 
     wxPoint& operator+=(const wxSize& s) { x += s.GetWidth(); y += s.GetHeight(); return *this; }
     wxPoint& operator-=(const wxSize& s) { x -= s.GetWidth(); y -= s.GetHeight(); return *this; }
+};
 
-    wxPoint operator+(const wxSize& s) const { return wxPoint(x + s.GetWidth(), y + s.GetHeight()); }
-    wxPoint operator-(const wxSize& s) const { return wxPoint(x - s.GetWidth(), y - s.GetHeight()); }
 
-    wxPoint operator-() const { return wxPoint(-x, -y); }
-};
+// comparison
+inline bool operator==(const wxPoint& p1, const wxPoint& p2)
+{
+    return p1.x == p2.x && p1.y == p2.y;
+}
+
+inline bool operator!=(const wxPoint& p1, const wxPoint& p2)
+{
+    return !(p1 == p2);
+}
+
+
+// arithmetic operations (component wise)
+inline wxPoint operator+(const wxPoint& p1, const wxPoint& p2)
+{
+    return wxPoint(p1.x + p2.x, p1.y + p2.y);
+}
+
+inline wxPoint operator-(const wxPoint& p1, const wxPoint& p2)
+{
+    return wxPoint(p1.x - p2.x, p1.y - p2.y);
+}
+
+inline wxPoint operator+(const wxPoint& p, const wxSize& s)
+{
+    return wxPoint(p.x + s.x, p.y + s.y);
+}
+
+inline wxPoint operator-(const wxPoint& p, const wxSize& s)
+{
+    return wxPoint(p.x - s.x, p.y - s.y);
+}
+
+inline wxPoint operator+(const wxSize& s, const wxPoint& p)
+{
+    return wxPoint(p.x + s.x, p.y + s.y);
+}
+
+inline wxPoint operator-(const wxSize& s, const wxPoint& p)
+{
+    return wxPoint(s.x - p.x, s.y - p.y);
+}
+
+inline wxPoint operator-(const wxPoint& p)
+{
+    return wxPoint(-p.x, -p.y);
+}
+
 
 // ---------------------------------------------------------------------------
 // wxRect
@@ -439,10 +533,6 @@ public:
         return r;
     }
 
-    // compare rectangles
-    bool operator==(const wxRect& rect) const;
-    bool operator!=(const wxRect& rect) const { return !(*this == rect); }
-
     // return true if the point is (not strcitly) inside the rect
     bool Contains(int x, int y) const;
     bool Contains(const wxPoint& pt) const { return Contains(pt.x, pt.y); }
@@ -459,15 +549,11 @@ public:
     // return true if the rectangles have a non empty intersection
     bool Intersects(const wxRect& rect) const;
 
+    // like Union() but don't ignore empty rectangles
+    wxRect& operator+=(const wxRect& rect);
 
-    // these are like Union() but don't ignore empty rectangles
-    wxRect operator+(const wxRect& rect) const;
-    wxRect& operator+=(const wxRect& rect)
-    {
-        *this = *this + rect;
-        return *this;
-    }
-
+    // intersections of two rectrangles not testing for empty rectangles
+    wxRect& operator*=(const wxRect& rect);
 
     // centre this rectangle in the given (usually, but not necessarily,
     // larger) one
@@ -487,6 +573,28 @@ public:
     int x, y, width, height;
 };
 
+
+// compare rectangles
+inline bool operator==(const wxRect& r1, const wxRect& r2)
+{
+    return (r1.x == r2.x) && (r1.y == r2.y) &&
+           (r1.width == r2.width) && (r1.height == r2.height);
+}
+
+inline bool operator!=(const wxRect& r1, const wxRect& r2)
+{
+    return !(r1 == r2);
+}
+
+// like Union() but don't treat empty rectangles specially
+WXDLLIMPEXP_CORE wxRect operator+(const wxRect& r1, const wxRect& r2);
+
+// intersections of two rectangles
+WXDLLIMPEXP_CORE wxRect operator*(const wxRect& r1, const wxRect& r2);
+
+
+
+
 #if WXWIN_COMPATIBILITY_2_6
 inline bool wxRect::Inside(int cx, int cy) const { return Contains(cx, cy); }
 inline bool wxRect::Inside(const wxPoint& pt) const { return Contains(pt); }
diff --git a/src/common/gdicmn.cpp b/src/common/gdicmn.cpp
index 0214f8cad3..7b6e3db37c 100644
--- a/src/common/gdicmn.cpp
+++ b/src/common/gdicmn.cpp
@@ -110,23 +110,6 @@ wxRect::wxRect(const wxPoint& point1, const wxPoint& point2)
     height++;
 }
 
-bool wxRect::operator==(const wxRect& rect) const
-{
-    return ((x == rect.x) &&
-            (y == rect.y) &&
-            (width == rect.width) &&
-            (height == rect.height));
-}
-
-wxRect wxRect::operator+(const wxRect& rect) const
-{
-    int x1 = wxMin(this->x, rect.x);
-    int y1 = wxMin(this->y, rect.y);
-    int y2 = wxMax(y+height, rect.height+rect.y);
-    int x2 = wxMax(x+width, rect.width+rect.x);
-    return wxRect(x1, y1, x2-x1, y2-y1);
-}
-
 wxRect& wxRect::Union(const wxRect& rect)
 {
     // ignore empty rectangles: union with an empty rectangle shouldn't extend
@@ -232,6 +215,38 @@ bool wxRect::Intersects(const wxRect& rect) const
     return r.width != 0;
 }
 
+wxRect& wxRect::operator+=(const wxRect& rect)
+{
+    *this = *this + rect;
+    return *this;
+}
+
+
+wxRect& wxRect::operator*=(const wxRect& rect)
+{
+    *this = *this * rect;
+    return *this;
+}
+
+
+wxRect operator+(const wxRect& r1, const wxRect& r2)
+{
+    int x1 = wxMin(r1.x, r2.x);
+    int y1 = wxMin(r1.y, r2.y);
+    int y2 = wxMax(r1.y+r1.height, r2.height+r2.y);
+    int x2 = wxMax(r1.x+r1.width, r2.width+r2.x);
+    return wxRect(x1, y1, x2-x1, y2-y1);
+}
+
+wxRect operator*(const wxRect& r1, const wxRect& r2)
+{
+    int x1 = wxMax(r1.x, r2.x);
+    int y1 = wxMax(r1.y, r2.y);
+    int y2 = wxMin(r1.y+r1.height, r2.height+r2.y);
+    int x2 = wxMin(r1.x+r1.width, r2.width+r2.x);
+    return wxRect(x1, y1, x2-x1, y2-y1);
+}
+
 // ============================================================================
 // wxColourDatabase
 // ============================================================================
diff --git a/tests/geometry/point.cpp b/tests/geometry/point.cpp
index ecdf7c9d06..f04dcdab75 100644
--- a/tests/geometry/point.cpp
+++ b/tests/geometry/point.cpp
@@ -87,6 +87,10 @@ void PointTestCase::Operators()
     p6 = p2; p6 = p2 - s;
     CPPUNIT_ASSERT( p3 == p5 );
     CPPUNIT_ASSERT( p4 == p6 );
+    p5 = p2; p5 = s + p2;
+    p6 = p2; p6 = s - p2;
+    CPPUNIT_ASSERT( p3 == p5 );
+    CPPUNIT_ASSERT( p4 == -p6 );
     p5 = p2; p5 += s;
     p6 = p2; p6 -= s;
     CPPUNIT_ASSERT( p3 == p5 );
diff --git a/tests/geometry/rect.cpp b/tests/geometry/rect.cpp
index cb196373ce..e22c41e61b 100644
--- a/tests/geometry/rect.cpp
+++ b/tests/geometry/rect.cpp
@@ -129,6 +129,14 @@ void RectTestCase::Operators()
             ( data.GetSecond() + data.GetFirst() ) == data.GetResult()
         );
     }
+
+    // test operator*() which returns the intersection of two rectangles
+    wxRect r1 = wxRect(0, 2, 3, 4);
+    wxRect r2 = wxRect(1, 2, 7, 8);
+    r1 *= r2;
+    CPPUNIT_ASSERT(wxRect(1, 2, 2, 4) == r1);
+
+    CPPUNIT_ASSERT( (r1 * wxRect()).IsEmpty() );
 }
 
 void RectTestCase::Union()
diff --git a/tests/geometry/size.cpp b/tests/geometry/size.cpp
index abc3591786..36925e0b21 100644
--- a/tests/geometry/size.cpp
+++ b/tests/geometry/size.cpp
@@ -58,6 +58,8 @@ void SizeTestCase::Operators()
     CPPUNIT_ASSERT( s3.GetWidth()==2 && s3.GetHeight()==2 );
     s3 = s1 * 2;
     CPPUNIT_ASSERT( s3.GetWidth()==2 && s3.GetHeight()==4 );
+    s3 = 2 * s1;
+    CPPUNIT_ASSERT( s3.GetWidth()==2 && s3.GetHeight()==4 );
     s3 = s3 / 2;
     CPPUNIT_ASSERT( s3.GetWidth()==1 && s3.GetHeight()==2 );
 
-- 
2.50.0

