Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 167 insertions, 0 deletions

diff --git a/include/vcl/region.hxx b/include/vcl/region.hxx
new file mode 100644
index 000000000..8d5004c18
--- /dev/null
+++ b/include/vcl/region.hxx
@@ -0,0 +1,167 @@
+/* -*- 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/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef INCLUDED_VCL_REGION_HXX
+#define INCLUDED_VCL_REGION_HXX
+
+#include <tools/gen.hxx>
+#include <tools/poly.hxx>
+#include <vcl/dllapi.h>
+#include <basegfx/polygon/b2dpolypolygon.hxx>
+#include <memory>
+#include <optional>
+
+class RegionBand;
+
+namespace vcl { class Window; }
+class OutputDevice;
+class Bitmap;
+
+typedef std::vector< tools::Rectangle > RectangleVector;
+
+namespace vcl {
+
+class SAL_WARN_UNUSED VCL_DLLPUBLIC Region
+{
+private:
+    friend class ::OutputDevice;
+    friend class ::vcl::Window;
+    friend class ::Bitmap;
+
+    // possible contents
+    std::optional< basegfx::B2DPolyPolygon >
+                                mpB2DPolyPolygon;
+    std::optional< tools::PolyPolygon >
+                                mpPolyPolygon;
+    std::shared_ptr< RegionBand >
+                                mpRegionBand;
+
+    bool                        mbIsNull : 1;
+
+    // helpers
+    SAL_DLLPRIVATE void ImplCreatePolyPolyRegion( const tools::PolyPolygon& rPolyPoly );
+    SAL_DLLPRIVATE void ImplCreatePolyPolyRegion( const basegfx::B2DPolyPolygon& rPolyPoly );
+
+    SAL_DLLPRIVATE tools::PolyPolygon ImplCreatePolyPolygonFromRegionBand() const;
+    SAL_DLLPRIVATE basegfx::B2DPolyPolygon ImplCreateB2DPolyPolygonFromRegionBand() const;
+
+public:
+
+    explicit Region(bool bIsNull = false); // default creates empty region, with true a null region is created
+    explicit Region(const tools::Rectangle& rRect);
+    explicit Region(const tools::Polygon& rPolygon);
+    explicit Region(const tools::PolyPolygon& rPolyPoly);
+    explicit Region(const basegfx::B2DPolyPolygon&);
+    Region(const vcl::Region& rRegion);
+    Region(vcl::Region&& rRegion) noexcept;
+    ~Region();
+
+    // direct access to contents
+    const std::optional<basegfx::B2DPolyPolygon>& getB2DPolyPolygon() const { return mpB2DPolyPolygon; }
+    const std::optional<tools::PolyPolygon>& getPolyPolygon() const { return mpPolyPolygon; }
+    const RegionBand* getRegionBand() const { return mpRegionBand.get(); }
+
+    // access with converters, the asked data will be created from the most
+    // valuable data, buffered and returned
+    tools::PolyPolygon GetAsPolyPolygon() const;
+    basegfx::B2DPolyPolygon GetAsB2DPolyPolygon() const;
+    const RegionBand* GetAsRegionBand() const;
+
+    // manipulators
+    void Move( tools::Long nHorzMove, tools::Long nVertMove );
+    void Scale( double fScaleX, double fScaleY );
+    void Union( const tools::Rectangle& rRegion );
+    void Intersect( const tools::Rectangle& rRegion );
+    void Exclude( const tools::Rectangle& rRegion );
+    void XOr( const tools::Rectangle& rRegion );
+    void Union( const vcl::Region& rRegion );
+    void Intersect( const vcl::Region& rRegion );
+    void Exclude( const vcl::Region& rRegion );
+    bool XOr( const vcl::Region& rRegion );
+
+    bool IsEmpty() const;
+    bool IsNull() const { return mbIsNull;}
+
+    void SetEmpty();
+    void SetNull();
+
+    bool IsRectangle() const;
+
+    tools::Rectangle GetBoundRect() const;
+    bool HasPolyPolygonOrB2DPolyPolygon() const { return (getB2DPolyPolygon() || getPolyPolygon()); }
+    void GetRegionRectangles(RectangleVector& rTarget) const;
+
+    bool Contains( const Point& rPoint ) const;
+    bool Overlaps( const tools::Rectangle& rRect ) const;
+
+    vcl::Region& operator=( const vcl::Region& rRegion );
+    vcl::Region& operator=( vcl::Region&& rRegion ) noexcept;
+    vcl::Region& operator=( const tools::Rectangle& rRect );
+
+    bool operator==( const vcl::Region& rRegion ) const;
+    bool operator!=( const vcl::Region& rRegion ) const { return !(Region::operator==( rRegion )); }
+
+    friend VCL_DLLPUBLIC SvStream& ReadRegion( SvStream& rIStm, vcl::Region& rRegion );
+    friend VCL_DLLPUBLIC SvStream& WriteRegion( SvStream& rOStm, const vcl::Region& rRegion );
+
+    /* workaround: faster conversion for PolyPolygons
+     * if half of the Polygons contained in rPolyPoly are actually
+     * rectangles, then the returned vcl::Region will be constructed by
+     * XOr'ing the contained Polygons together; in the case of
+     * only Rectangles this can be up to eight times faster than
+     * Region( const tools::PolyPolygon& ).
+     * Caution: this is only useful if the vcl::Region is known to be
+     * changed to rectangles; e.g. if being set as clip region
+     */
+    static vcl::Region GetRegionFromPolyPolygon( const tools::PolyPolygon& rPolyPoly );
+};
+
+template< typename charT, typename traits >
+inline std::basic_ostream<charT, traits> & operator <<(
+    std::basic_ostream<charT, traits> & stream, const Region& rRegion)
+{
+    if (rRegion.IsEmpty())
+        return stream << "EMPTY";
+    if (rRegion.getB2DPolyPolygon())
+        return stream << "B2DPolyPolygon("
+                      << *rRegion.getB2DPolyPolygon()
+                      << ")";
+    if (rRegion.getPolyPolygon())
+        return stream << "PolyPolygon("
+                      << *rRegion.getPolyPolygon()
+                      << ")";
+    if (rRegion.getRegionBand())
+    {   // inlined because RegionBand is private to vcl
+        stream << "RegionBand(";
+        RectangleVector rects;
+        rRegion.GetRegionRectangles(rects);
+        if (rects.empty())
+            stream << "EMPTY";
+        for (size_t i = 0; i < rects.size(); ++i)
+            stream << "[" << i << "] " << rects[i];
+        stream << ")";
+    }
+    return stream;
+}
+
+} /* namespace vcl */
+
+#endif // INCLUDED_VCL_REGION_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */