basegfx: generalise tuples with template class Tuple2D and Tuple3D

B2DTuple2D, B2ITuple2D and B2I64Tuple share a lot in common so
we can generalise it as a template class. The same goes for the
3D variants - B3DTuple and B3ITuple.

This is the initial attempt, but doesn't yet generalise all that
is possible.

Add some tests for the tuple variants that test the behaviour of
overloaded operators and other common methods.

Change-Id: Iee5ed15d58ea88e65ee7854bd05a87ceab22023d
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/117104
Tested-by: Jenkins
Reviewed-by: Tomaž Vajngerl <quikee@gmail.com>

1 files changed, 157 insertions, 0 deletions

diff --git a/include/basegfx/tuple/Tuple2D.hxx b/include/basegfx/tuple/Tuple2D.hxx
new file mode 100644
index 000000000000..e38dd1542207
--- /dev/null
+++ b/include/basegfx/tuple/Tuple2D.hxx
@@ -0,0 +1,157 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ */
+
+#pragma once
+
+#include <sal/types.h>
+#include <basegfx/basegfxdllapi.h>
+#include <basegfx/utils/common.hxx>
+#include <basegfx/numeric/ftools.hxx>
+
+namespace basegfx
+{
+template <typename TYPE> class Tuple2D
+{
+protected:
+    union {
+        // temporary alias mnX with mfX and mnY with mfY
+        struct
+        {
+            TYPE mnX;
+            TYPE mnY;
+        };
+        struct
+        {
+            TYPE mfX;
+            TYPE mfY;
+        };
+    };
+
+public:
+    /** Create a 2D Tuple
+
+            @param nX
+            This parameter is used to initialize the X-coordinate
+            of the 2D Tuple.
+
+            @param nY
+            This parameter is used to initialize the Y-coordinate
+            of the 2D Tuple.
+    */
+    Tuple2D(TYPE x, TYPE y)
+        : mnX(x)
+        , mnY(y)
+    {
+    }
+
+    double get(Axis2D eAxis) { return eAxis == Axis2D::X ? getX() : getY(); }
+
+    void set(Axis2D eAxis, TYPE fValue)
+    {
+        if (eAxis == Axis2D::X)
+            setX(fValue);
+        else
+            setY(fValue);
+    }
+
+    /// Get X-Coordinate of 2D Tuple
+    TYPE getX() const { return mnX; }
+
+    /// Get Y-Coordinate of 2D Tuple
+    TYPE getY() const { return mnY; }
+
+    /// Set X-Coordinate of 2D Tuple
+    void setX(TYPE fX) { mnX = fX; }
+
+    /// Set Y-Coordinate of 2D Tuple
+    void setY(TYPE fY) { mnY = fY; }
+
+    // comparators with tolerance
+
+    template <typename T = TYPE,
+              typename std::enable_if<std::is_integral<T>::value, bool>::type = false>
+    bool equal(const Tuple2D<TYPE>& rTup) const
+    {
+        return mfX == rTup.mfX && mfY == rTup.mfY;
+    }
+
+    template <typename T = TYPE,
+              typename std::enable_if<std::is_floating_point<T>::value, bool>::type = false>
+    bool equal(const Tuple2D<TYPE>& rTup) const
+    {
+        return this == &rTup || (fTools::equal(mfX, rTup.mfX) && fTools::equal(mfY, rTup.mfY));
+    }
+
+    template <typename T = TYPE,
+              typename std::enable_if<std::is_integral<T>::value, bool>::type = false>
+    bool equalZero() const
+    {
+        return mnX == 0 && mnY == 0;
+    }
+
+    template <typename T = TYPE,
+              typename std::enable_if<std::is_floating_point<T>::value, bool>::type = false>
+    bool equalZero() const
+    {
+        return fTools::equalZero(mfX) && fTools::equalZero(mfY);
+    }
+
+    // operator overrides
+
+    Tuple2D& operator+=(const Tuple2D& rTup)
+    {
+        mfX += rTup.mfX;
+        mfY += rTup.mfY;
+        return *this;
+    }
+
+    Tuple2D& operator-=(const Tuple2D& rTup)
+    {
+        mfX -= rTup.mfX;
+        mfY -= rTup.mfY;
+        return *this;
+    }
+
+    Tuple2D& operator/=(const Tuple2D& rTup)
+    {
+        mfX /= rTup.mfX;
+        mfY /= rTup.mfY;
+        return *this;
+    }
+
+    Tuple2D& operator*=(const Tuple2D& rTup)
+    {
+        mfX *= rTup.mfX;
+        mfY *= rTup.mfY;
+        return *this;
+    }
+
+    Tuple2D& operator*=(TYPE t)
+    {
+        mfX *= t;
+        mfY *= t;
+        return *this;
+    }
+
+    Tuple2D& operator/=(TYPE t)
+    {
+        mfX /= t;
+        mfY /= t;
+        return *this;
+    }
+
+    bool operator==(const Tuple2D& rTup) const { return mfX == rTup.mfX && mfY == rTup.mfY; }
+
+    bool operator!=(const Tuple2D& rTup) const { return !(*this == rTup); }
+};
+
+} // end of namespace basegfx
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */