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

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

1 files changed, 360 insertions, 0 deletions

diff --git a/xmloff/source/style/GradientStyle.cxx b/xmloff/source/style/GradientStyle.cxx
new file mode 100644
index 0000000000..67b749f79f
--- /dev/null
+++ b/xmloff/source/style/GradientStyle.cxx
@@ -0,0 +1,360 @@
+/* -*- 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 .
+ */
+
+#include <xmloff/GradientStyle.hxx>
+
+#include <com/sun/star/awt/Gradient2.hpp>
+
+#include <comphelper/documentconstants.hxx>
+#include <rtl/ustrbuf.hxx>
+#include <rtl/ustring.hxx>
+#include <sal/log.hxx>
+#include <sax/tools/converter.hxx>
+#include <xmloff/namespacemap.hxx>
+#include <xmloff/xmlement.hxx>
+#include <xmloff/xmlexp.hxx>
+#include <xmloff/xmlimp.hxx>
+#include <xmloff/xmlnamespace.hxx>
+#include <xmloff/xmltkmap.hxx>
+#include <xmloff/xmltoken.hxx>
+#include <xmloff/xmluconv.hxx>
+#include <basegfx/utils/bgradient.hxx>
+#include <docmodel/uno/UnoGradientTools.hxx>
+
+using namespace ::com::sun::star;
+using namespace ::xmloff::token;
+
+SvXMLEnumMapEntry<awt::GradientStyle> const pXML_GradientStyle_Enum[] =
+{
+    { XML_LINEAR,                       awt::GradientStyle_LINEAR },
+    { XML_GRADIENTSTYLE_AXIAL,          awt::GradientStyle_AXIAL },
+    { XML_GRADIENTSTYLE_RADIAL,         awt::GradientStyle_RADIAL },
+    { XML_GRADIENTSTYLE_ELLIPSOID,      awt::GradientStyle_ELLIPTICAL },
+    { XML_GRADIENTSTYLE_SQUARE,         awt::GradientStyle_SQUARE },
+    { XML_GRADIENTSTYLE_RECTANGULAR,    awt::GradientStyle_RECT },
+    { XML_TOKEN_INVALID, awt::GradientStyle(0) }
+};
+
+// Import
+XMLGradientStyleImport::XMLGradientStyleImport(
+    SvXMLImport& rImp )
+    : m_rImport(rImp)
+{
+}
+
+void XMLGradientStyleImport::importXML(
+    const uno::Reference< xml::sax::XFastAttributeList >& xAttrList,
+    uno::Any& rValue,
+    OUString& rStrName )
+{
+    OUString aDisplayName;
+
+    awt::Gradient2 aGradient;
+    aGradient.Style = css::awt::GradientStyle_LINEAR;
+    aGradient.StartColor = 0;
+    aGradient.EndColor = 0;
+    aGradient.Angle = 0;
+    aGradient.Border = 0;
+    aGradient.XOffset = 0;
+    aGradient.YOffset = 0;
+    aGradient.StartIntensity = 100;
+    aGradient.EndIntensity = 100;
+    aGradient.StepCount = 0;
+
+    for (auto &aIter : sax_fastparser::castToFastAttributeList( xAttrList ))
+    {
+        sal_Int32 nTmpValue(0);
+
+        switch( aIter.getToken() )
+        {
+        case XML_ELEMENT(DRAW, XML_NAME):
+            rStrName = aIter.toString();
+            break;
+        case XML_ELEMENT(DRAW, XML_DISPLAY_NAME):
+            aDisplayName = aIter.toString();
+            break;
+        case XML_ELEMENT(DRAW, XML_STYLE):
+            SvXMLUnitConverter::convertEnum( aGradient.Style, aIter.toView(), pXML_GradientStyle_Enum );
+            break;
+        case XML_ELEMENT(DRAW, XML_CX):
+            ::sax::Converter::convertPercent( nTmpValue, aIter.toView() );
+            aGradient.XOffset = static_cast< sal_Int16 >( nTmpValue );
+            break;
+        case XML_ELEMENT(DRAW, XML_CY):
+            ::sax::Converter::convertPercent( nTmpValue, aIter.toView() );
+            aGradient.YOffset = static_cast< sal_Int16 >( nTmpValue );
+            break;
+        case XML_ELEMENT(DRAW, XML_START_COLOR):
+            ::sax::Converter::convertColor(aGradient.StartColor, aIter.toView());
+            break;
+        case XML_ELEMENT(DRAW, XML_END_COLOR):
+            ::sax::Converter::convertColor(aGradient.EndColor, aIter.toView());
+            break;
+        case XML_ELEMENT(DRAW, XML_START_INTENSITY):
+            ::sax::Converter::convertPercent( nTmpValue, aIter.toView() );
+            aGradient.StartIntensity = static_cast< sal_Int16 >( nTmpValue );
+            break;
+        case XML_ELEMENT(DRAW, XML_END_INTENSITY):
+            ::sax::Converter::convertPercent( nTmpValue, aIter.toView() );
+            aGradient.EndIntensity = static_cast< sal_Int16 >( nTmpValue );
+            break;
+        case XML_ELEMENT(DRAW, XML_GRADIENT_ANGLE):
+            {
+                auto const cmp12(m_rImport.GetODFVersion().compareTo(ODFVER_012_TEXT));
+                bool const bSuccess =
+                    ::sax::Converter::convertAngle(aGradient.Angle, aIter.toView(),
+                        // tdf#89475 try to detect borked OOo angles
+                        (cmp12 < 0) || (cmp12 == 0
+                            && (m_rImport.isGeneratorVersionOlderThan(SvXMLImport::AOO_4x, SvXMLImport::LO_7x)
+                                // also for AOO 4.x, assume there won't ever be a 4.2
+                                || m_rImport.getGeneratorVersion() == SvXMLImport::AOO_4x)));
+                SAL_INFO_IF(!bSuccess, "xmloff.style", "failed to import draw:angle");
+            }
+            break;
+        case XML_ELEMENT(DRAW, XML_BORDER):
+            ::sax::Converter::convertPercent( nTmpValue, aIter.toView() );
+            aGradient.Border = static_cast< sal_Int16 >( nTmpValue );
+            break;
+
+        default:
+            XMLOFF_WARN_UNKNOWN("xmloff.style", aIter);
+        }
+    }
+
+    rValue <<= aGradient;
+
+    if( !aDisplayName.isEmpty() )
+    {
+        m_rImport.AddStyleDisplayName( XmlStyleFamily::SD_GRADIENT_ID, rStrName,
+                                     aDisplayName );
+        rStrName = aDisplayName;
+    }
+}
+
+XMLGradientStopContext::XMLGradientStopContext(
+    SvXMLImport& rImport, sal_Int32 nElement,
+    const uno::Reference< xml::sax::XFastAttributeList >& xAttrList,
+    std::vector<awt::ColorStop>& rColorStopVec)
+:   SvXMLImportContext(rImport)
+{
+    if(nElement != XML_ELEMENT(LO_EXT, xmloff::token::XML_GRADIENT_STOP))
+        return;
+
+    double fOffset = -1.0;
+    OUString sColorType;
+    OUString sColorValue;
+    // First collect all attributes
+    for (auto &aIter : sax_fastparser::castToFastAttributeList(xAttrList))
+    {
+        switch(aIter.getToken())
+        {
+        case XML_ELEMENT(SVG, xmloff::token::XML_OFFSET): // needed??
+        case XML_ELEMENT(SVG_COMPAT, xmloff::token::XML_OFFSET):
+            if (!::sax::Converter::convertDouble(fOffset, aIter.toView()))
+                return;
+            break;
+        case XML_ELEMENT(LO_EXT, xmloff::token::XML_COLOR_VALUE):
+            sColorValue = aIter.toString();
+            if (sColorValue.isEmpty())
+                return;
+            break;
+        case XML_ELEMENT(LO_EXT, xmloff::token::XML_COLOR_TYPE):
+            sColorType = aIter.toString();
+            if (sColorType.isEmpty())
+                return;
+            break;
+        default:
+            XMLOFF_WARN_UNKNOWN("xmloff.style", aIter);
+        }
+    }
+
+    // As of LO 7.6.0 only "rgb" is implemented.
+    if (sColorType != u"rgb")
+        return;
+
+    // Type "rgb" requires kind color-value="#rrggbb".
+    ::Color aColor;
+    if (!::sax::Converter::convertColor(aColor, sColorValue))
+        return;
+
+    // All attribute values OK. Generate ColorStop.
+    css::rendering::RGBColor aRGBColor;
+    aRGBColor.Red = aColor.GetRed() / 255.0;
+    aRGBColor.Green = aColor.GetGreen() / 255.0;
+    aRGBColor.Blue = aColor.GetBlue() / 255.0;
+
+    awt::ColorStop aColorStop;
+    aColorStop.StopOffset = fOffset;
+    aColorStop.StopColor = aRGBColor;
+    rColorStopVec.push_back(aColorStop);
+}
+
+XMLGradientStopContext::~XMLGradientStopContext()
+{
+}
+
+// Export
+
+XMLGradientStyleExport::XMLGradientStyleExport(
+    SvXMLExport& rExp )
+    : m_rExport(rExp)
+{
+}
+
+void XMLGradientStyleExport::exportXML(
+    const OUString& rStrName,
+    const uno::Any& rValue )
+{
+    if( rStrName.isEmpty() )
+        return;
+
+    if (!rValue.has<css::awt::Gradient2>() && !rValue.has<css::awt::Gradient>())
+        return;
+
+    basegfx::BGradient aGradient = model::gradient::getFromAny(rValue);
+
+    // Export of axial gradient to OOXML produces a symmetrical linear multi-color gradient. Import
+    // does not regenerate it as 'axial' because that is not needed for MCGR. For export to ODF we
+    // try to regenerate 'axial' for to get a better compatibility with LO versions before MCGR.
+    aGradient.tryToConvertToAxial();
+
+    // MCGR: For better compatibility with LO versions before MCGR, try
+    // to re-create a 'border' value based on the existing gradient stops.
+    // With MCGR we do not need 'border' anymore in quite some cases since
+    // no Start/EndColor at 0.0 resp. 1.0 is explicitly needed. Since we
+    // (unfortunately need to) internally continue to support border
+    // anyways it does no harm to fallback to use the border value - if
+    // there is an equivalent representation as this helper checks for.
+    // For exports that do not support 'border' this will be adapted as
+    // needed (see tryToApplyBorder()).
+    aGradient.tryToRecreateBorder(nullptr);
+
+    OUString aStrValue;
+    OUStringBuffer aOut;
+
+    // Style
+    if( !SvXMLUnitConverter::convertEnum( aOut, aGradient.GetGradientStyle(), pXML_GradientStyle_Enum ) )
+        return;
+
+    // Name
+    bool bEncoded = false;
+    m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_NAME,
+                          m_rExport.EncodeStyleName( rStrName,
+                                                    &bEncoded ) );
+    if( bEncoded )
+        m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_DISPLAY_NAME,
+                                rStrName );
+
+    aStrValue = aOut.makeStringAndClear();
+    m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_STYLE, aStrValue );
+
+    // Center x/y
+    if( aGradient.GetGradientStyle() != awt::GradientStyle_LINEAR &&
+        aGradient.GetGradientStyle() != awt::GradientStyle_AXIAL   )
+    {
+        ::sax::Converter::convertPercent(aOut, aGradient.GetXOffset());
+        aStrValue = aOut.makeStringAndClear();
+        m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_CX, aStrValue );
+        ::sax::Converter::convertPercent(aOut, aGradient.GetYOffset());
+        aStrValue = aOut.makeStringAndClear();
+        m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_CY, aStrValue );
+    }
+
+    // prep Start/EndColor, default black
+    basegfx::BColor aStartColor;
+    basegfx::BColor aEndColor;
+
+    if (!aGradient.GetColorStops().empty())
+    {
+        aStartColor = aGradient.GetColorStops().front().getStopColor();
+        aEndColor = aGradient.GetColorStops().back().getStopColor();
+    }
+
+    // Color start
+    ::sax::Converter::convertColor(aOut, Color(aStartColor));
+    aStrValue = aOut.makeStringAndClear();
+    m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_START_COLOR, aStrValue );
+
+    // Color end
+    ::sax::Converter::convertColor(aOut, Color(aEndColor));
+    aStrValue = aOut.makeStringAndClear();
+    m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_END_COLOR, aStrValue );
+
+    // Intensity start
+    ::sax::Converter::convertPercent(aOut, aGradient.GetStartIntens());
+    aStrValue = aOut.makeStringAndClear();
+    m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_START_INTENSITY, aStrValue );
+
+    // Intensity end
+    ::sax::Converter::convertPercent(aOut, aGradient.GetEndIntens());
+    aStrValue = aOut.makeStringAndClear();
+    m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_END_INTENSITY, aStrValue );
+
+    // Angle
+    if( aGradient.GetGradientStyle() != awt::GradientStyle_RADIAL )
+    {
+        ::sax::Converter::convertAngle(aOut, static_cast<sal_Int16>(aGradient.GetAngle()), m_rExport.getSaneDefaultVersion());
+        aStrValue = aOut.makeStringAndClear();
+        m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_GRADIENT_ANGLE, aStrValue );
+    }
+
+    // Border
+    ::sax::Converter::convertPercent( aOut, aGradient.GetBorder() );
+    aStrValue = aOut.makeStringAndClear();
+    m_rExport.AddAttribute( XML_NAMESPACE_DRAW, XML_BORDER, aStrValue );
+
+    // ctor writes start tag. End-tag is written by destructor at block end.
+    SvXMLElementExport aElem( m_rExport, XML_NAMESPACE_DRAW, XML_GRADIENT,
+                          true, false );
+
+    // Write child elements <loext:gradient-stop>
+    // Do not export in standard ODF 1.3 or older.
+    if ((m_rExport.getSaneDefaultVersion() & SvtSaveOptions::ODFSVER_EXTENDED) == 0)
+        return;
+
+    if (aGradient.GetColorStops().empty())
+        return;
+
+    double fPreviousOffset = 0.0;
+    for (const auto& aCandidate : aGradient.GetColorStops())
+    {
+        // Attribute svg:offset. Make sure offsets are increasing.
+        double fOffset = std::clamp<double>(aCandidate.getStopOffset(), 0.0, 1.0);
+        if (fOffset < fPreviousOffset)
+            fOffset = fPreviousOffset;
+        m_rExport.AddAttribute(XML_NAMESPACE_SVG, XML_OFFSET, OUString::number(fOffset));
+        fPreviousOffset = fOffset;
+
+        // As of LO 7.6.0 only color-type="rgb" is implemented.
+        m_rExport.AddAttribute(XML_NAMESPACE_LO_EXT, XML_COLOR_TYPE, u"rgb"_ustr);
+
+        // Attribute loext:color-value, data type color, that is #rrggbb.
+        const basegfx::BColor aDecimalColor(aCandidate.getStopColor());
+        ::Color aToolsColor(std::clamp<sal_uInt8>(std::round(aDecimalColor.getRed() * 255.0), 0, 255),
+                            std::clamp<sal_uInt8>(std::round(aDecimalColor.getGreen() * 255.0), 0, 255),
+                            std::clamp<sal_uInt8>(std::round(aDecimalColor.getBlue() * 255.0), 0, 255));
+        m_rExport.AddAttribute(XML_NAMESPACE_LO_EXT, XML_COLOR_VALUE,
+                             rtl::OUStringChar('#') + aToolsColor.AsRGBHexString());
+
+        // write gradient stop element
+        SvXMLElementExport aStopElement(m_rExport, XML_NAMESPACE_LO_EXT, XML_GRADIENT_STOP, true, true);
+    }
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */