/* -*- 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 <drawinglayer/attribute/fillgradientattribute.hxx>

#include <basegfx/utils/bgradient.hxx>

namespace drawinglayer::attribute

{

        class ImpFillGradientAttribute

        {

        public:

            // data definitions

            double                                  mfBorder;

            double                                  mfOffsetX;

            double                                  mfOffsetY;

            double                                  mfAngle;

            basegfx::BColorStops                    maColorStops;

            css::awt::GradientStyle                 meStyle;

            sal_uInt16                              mnSteps;

            ImpFillGradientAttribute(

                css::awt::GradientStyle eStyle,

                double fBorder,

                double fOffsetX,

                double fOffsetY,

                double fAngle,

                const basegfx::BColorStops& rColorStops,

                sal_uInt16 nSteps)

            :   mfBorder(fBorder),

                mfOffsetX(fOffsetX),

                mfOffsetY(fOffsetY),

                mfAngle(fAngle),

                maColorStops(rColorStops), // copy ColorStops

                meStyle(eStyle),

                mnSteps(nSteps)

            {

                // Correct the local ColorStops. That will guarantee that the

                // content does contain no offsets < 0.0, > 1.0 or double

                // ones, also secures sorted arrangement and checks for

                // double colors, too (see there for more information).

                // This is what the usages of this in primitives need.

                // Since FillGradientAttribute is read-only doing this

                // once here in the constructor is sufficient

                maColorStops.sortAndCorrect();

                // sortAndCorrectColorStops is rigid and can return

                // an empty result. To keep things simple, add a single

                // fallback value

                if (maColorStops.empty())

                {

                    maColorStops.addStop(0.0, basegfx::BColor());

                }

            }

            ImpFillGradientAttribute()

            :   mfBorder(0.0),

                mfOffsetX(0.0),

                mfOffsetY(0.0),

                mfAngle(0.0),

                maColorStops(),

                meStyle(css::awt::GradientStyle_LINEAR),

                mnSteps(0)

            {

                // always add a fallback color, see above

                maColorStops.addStop(0.0, basegfx::BColor());

            }

            // data read access

            css::awt::GradientStyle getStyle() const { return meStyle; }

            double getBorder() const { return mfBorder; }

            double getOffsetX() const { return mfOffsetX; }

            double getOffsetY() const { return mfOffsetY; }

            double getAngle() const { return mfAngle; }

            const basegfx::BColorStops& getColorStops() const { return maColorStops; }

            sal_uInt16 getSteps() const { return mnSteps; }

            bool operator==(const ImpFillGradientAttribute& rCandidate) const

            {

                return (getStyle() == rCandidate.getStyle()

                    && getBorder() == rCandidate.getBorder()

                    && getOffsetX() == rCandidate.getOffsetX()

                    && getOffsetY() == rCandidate.getOffsetY()

                    && getAngle() == rCandidate.getAngle()

                    && getColorStops() == rCandidate.getColorStops()

                    && getSteps() == rCandidate.getSteps());

            }

        };

        namespace

        {

            FillGradientAttribute::ImplType& theGlobalDefault()

            {

                static FillGradientAttribute::ImplType SINGLETON;

                return SINGLETON;

            }

        }

        FillGradientAttribute::FillGradientAttribute(

            css::awt::GradientStyle eStyle,

            double fBorder,

            double fOffsetX,

            double fOffsetY,

            double fAngle,

            const basegfx::BColorStops& rColorStops,

            sal_uInt16 nSteps)

        :   mpFillGradientAttribute(ImpFillGradientAttribute(

                eStyle, fBorder, fOffsetX, fOffsetY, fAngle, rColorStops, nSteps))

        {

        }

        FillGradientAttribute::FillGradientAttribute()

        :   mpFillGradientAttribute(theGlobalDefault())

        {

        }

        FillGradientAttribute::FillGradientAttribute(const FillGradientAttribute&) = default;

        FillGradientAttribute::FillGradientAttribute(FillGradientAttribute&&) = default;

        FillGradientAttribute::~FillGradientAttribute() = default;

        bool FillGradientAttribute::isDefault() const

        {

            return mpFillGradientAttribute.same_object(theGlobalDefault());

        }

        // MCGR: Check if rendering cannot be handled by old vcl stuff

        bool FillGradientAttribute::cannotBeHandledByVCL() const

        {

            // MCGR: If GradientStops are used, use decomposition since vcl is not able

            // to render multi-color gradients

            if (getColorStops().size() != 2)

            {

                return true;

            }

            // MCGR: If GradientStops do not start and stop at traditional Start/EndColor,

            // use decomposition since vcl is not able to render this

            if (!getColorStops().empty())

            {

                if (!basegfx::fTools::equalZero(getColorStops().front().getStopOffset())

                    || !basegfx::fTools::equal(getColorStops().back().getStopOffset(), 1.0))

                {

                    return true;

                }

            }

            // VCL should be able to handle all styles, but for tdf#133477 the VCL result

            // is different from processing the gradient manually by drawinglayer

            // (and the Writer unittest for it fails). Keep using the drawinglayer code

            // until somebody founds out what's wrong and fixes it.

            if (getStyle() != css::awt::GradientStyle_LINEAR

                && getStyle() != css::awt::GradientStyle_AXIAL

                && getStyle() != css::awt::GradientStyle_RADIAL)

            {

                return true;

            }

            return false;

        }

        FillGradientAttribute& FillGradientAttribute::operator=(const FillGradientAttribute&) = default;

        FillGradientAttribute& FillGradientAttribute::operator=(FillGradientAttribute&&) = default;

        bool FillGradientAttribute::operator==(const FillGradientAttribute& rCandidate) const

        {

            // tdf#87509 default attr is always != non-default attr, even with same values

            if(rCandidate.isDefault() != isDefault())

                return false;

            return rCandidate.mpFillGradientAttribute == mpFillGradientAttribute;

        }

        const basegfx::BColorStops& FillGradientAttribute::getColorStops() const

        {

            return mpFillGradientAttribute->getColorStops();

        }

        double FillGradientAttribute::getBorder() const

        {

            return mpFillGradientAttribute->getBorder();

        }

        double FillGradientAttribute::getOffsetX() const

        {

            return mpFillGradientAttribute->getOffsetX();

        }

        double FillGradientAttribute::getOffsetY() const

        {

            return mpFillGradientAttribute->getOffsetY();

        }

        double FillGradientAttribute::getAngle() const

        {

            return mpFillGradientAttribute->getAngle();

        }

        css::awt::GradientStyle FillGradientAttribute::getStyle() const

        {

            return mpFillGradientAttribute->getStyle();

        }

        sal_uInt16 FillGradientAttribute::getSteps() const

        {

            return mpFillGradientAttribute->getSteps();

        }

        bool FillGradientAttribute::sameDefinitionThanAlpha(const FillGradientAttribute& rAlpha) const

        {

            // entries that are used by all gradient styles

            if (getStyle() != rAlpha.getStyle()

                || getBorder() != rAlpha.getBorder()

                || getSteps() != rAlpha.getSteps())

            {

                return false;

            }

            // check for offsets if not ignored

            const bool bIgnoreOffset(css::awt::GradientStyle_LINEAR == getStyle() || css::awt::GradientStyle_AXIAL == getStyle());

            if (!bIgnoreOffset && (getOffsetX() != rAlpha.getOffsetX() || getOffsetY() != rAlpha.getOffsetY()))

            {

                return false;

            }

            // check for angle if not ignored

            const bool bIgnoreAngle(css::awt::GradientStyle_RADIAL == getStyle());

            if (!bIgnoreAngle && getAngle() != rAlpha.getAngle())

            {

                return false;

            }

            // check for same count & offsets in the gradients (all except 'colors')

            if (!getColorStops().sameSizeAndDistances(rAlpha.getColorStops()))

            {

                return false;

            }

            return true;

        }

} // end of namespace

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */