/*
    Copyright (C) 2004, 2005, 2006 Nikolas Zimmermann <zimmermann@kde.org>
                  2004, 2005, 2006, 2007 Rob Buis <buis@kde.org>

    This file is part of the KDE project

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef SVGSVGElement_h
#define SVGSVGElement_h

#if ENABLE(SVG)

#include "FloatRect.h"

#include "IntSize.h"
#include "SVGExternalResourcesRequired.h"
#include "SVGFitToViewBox.h"
#include "SVGLangSpace.h"
#include "SVGStyledLocatableElement.h"
#include "SVGTests.h"
#include "SVGZoomAndPan.h"

namespace WebCore
{
class SVGAngle;
class SVGLength;
class SVGTransform;
class SVGViewSpec;
/*class SVGViewElement;
class SMILTimeContainer;*/
class SVGSVGElement : public SVGStyledLocatableElement,
    public SVGTests,
    public SVGLangSpace,
    public SVGExternalResourcesRequired,
    public SVGFitToViewBox,
    public SVGZoomAndPan
{
public:
    SVGSVGElement(const QualifiedName &, Document *);
    virtual ~SVGSVGElement();

    bool isSVG() const Q_DECL_OVERRIDE
    {
        return true;
    }

    bool isValid() const Q_DECL_OVERRIDE
    {
        return SVGTests::isValid();
    }

    // 'SVGSVGElement' functions
    DOMString contentScriptType() const;
    void setContentScriptType(const DOMString &type);

    DOMString contentStyleType() const;
    void setContentStyleType(const DOMString &type);

    FloatRect viewport() const;

    IntSize containerSize() const;
    bool hasSetContainerSize() const;
    int relativeWidthValue() const;
    int relativeHeightValue() const;

    float pixelUnitToMillimeterX() const;
    float pixelUnitToMillimeterY() const;
    float screenPixelToMillimeterX() const;
    float screenPixelToMillimeterY() const;

    bool useCurrentView() const;
    void setUseCurrentView(bool currentView);

    SVGViewSpec *currentView() const;

    float currentScale() const;
    void setCurrentScale(float scale);

    FloatPoint currentTranslate() const;
    void setCurrentTranslate(const FloatPoint &);

    /*SMILTimeContainer* timeContainer() const { return m_timeContainer.get(); }*/

    void pauseAnimations();
    void unpauseAnimations();
    bool animationsPaused() const;

    float getCurrentTime() const;
    void setCurrentTime(float seconds);

    unsigned long suspendRedraw(unsigned long max_wait_milliseconds);
    void unsuspendRedraw(unsigned long suspend_handle_id, ExceptionCode &);
    void unsuspendRedrawAll();
    void forceRedraw();

    DOM::NodeListImpl *getIntersectionList(const FloatRect &, SVGElement *referenceElement);
    DOM::NodeListImpl *getEnclosureList(const FloatRect &, SVGElement *referenceElement);
    bool checkIntersection(SVGElement *, const FloatRect &);
    bool checkEnclosure(SVGElement *, const FloatRect &);
    void deselectAll();

    static float createSVGNumber();
    static SVGLength createSVGLength();
    static SVGAngle *createSVGAngle();
    static FloatPoint createSVGPoint();
    static AffineTransform createSVGMatrix();
    static FloatRect createSVGRect();
    static SVGTransform createSVGTransform();
    static SVGTransform createSVGTransformFromMatrix(const AffineTransform &);

    void parseMappedAttribute(MappedAttribute *) Q_DECL_OVERRIDE;

    // 'virtual SVGLocatable' functions
    AffineTransform getCTM() const Q_DECL_OVERRIDE;
    AffineTransform getScreenCTM() const Q_DECL_OVERRIDE;

    bool rendererIsNeeded(RenderStyle *style) Q_DECL_OVERRIDE
    {
        return StyledElement::rendererIsNeeded(style);
    }
    RenderObject *createRenderer(RenderArena *, RenderStyle *) Q_DECL_OVERRIDE;

    void insertedIntoDocument() Q_DECL_OVERRIDE;
    void removedFromDocument() Q_DECL_OVERRIDE;

    void svgAttributeChanged(const QualifiedName &) Q_DECL_OVERRIDE;

    AffineTransform viewBoxToViewTransform(float viewWidth, float viewHeight) const Q_DECL_OVERRIDE;

    //void inheritViewAttributes(SVGViewElement*);

    // KHTML ElementImpl pure virtual method
    quint32 id() const Q_DECL_OVERRIDE;
protected:
    const SVGElement *contextElement() const Q_DECL_OVERRIDE
    {
        return this;
    }

    friend class RenderSVGRoot;
    /*friend class RenderSVGViewportContainer;*/

    bool hasRelativeValues() const Q_DECL_OVERRIDE;

    bool isOutermostSVG() const;

private:
    void addSVGWindowEventListener(const AtomicString &eventType, const Attribute *attr);

    ANIMATED_PROPERTY_FORWARD_DECLARATIONS(SVGExternalResourcesRequired, bool, ExternalResourcesRequired, externalResourcesRequired)
    ANIMATED_PROPERTY_FORWARD_DECLARATIONS(SVGFitToViewBox, FloatRect, ViewBox, viewBox)
    ANIMATED_PROPERTY_FORWARD_DECLARATIONS(SVGFitToViewBox, SVGPreserveAspectRatio *, PreserveAspectRatio, preserveAspectRatio)

    ANIMATED_PROPERTY_DECLARATIONS(SVGSVGElement, SVGLength, SVGLength, X, x)
    ANIMATED_PROPERTY_DECLARATIONS(SVGSVGElement, SVGLength, SVGLength, Y, y)
    ANIMATED_PROPERTY_DECLARATIONS(SVGSVGElement, SVGLength, SVGLength, Width, width)
    ANIMATED_PROPERTY_DECLARATIONS(SVGSVGElement, SVGLength, SVGLength, Height, height)

    virtual void willSaveToCache();
    virtual void willRestoreFromCache();

    bool m_useCurrentView;
    /*RefPtr<SMILTimeContainer> m_timeContainer;*/
    FloatPoint m_translation;
    mutable OwnPtr<SVGViewSpec> m_viewSpec;
};

} // namespace WebCore

#endif // ENABLE(SVG)
#endif

