Source/WebCore/svg/SVGElement.h

/*
 * Copyright (C) 2004, 2005, 2006, 2008 Nikolas Zimmermann <zimmermann@kde.org>
 * Copyright (C) 2004, 2005, 2006 Rob Buis <buis@kde.org>
 * Copyright (C) 2009 Apple Inc. All rights reserved.
 *
 * 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 SVGElement_h
#define SVGElement_h

#if ENABLE(SVG)
#include "SVGLocatable.h"
#include "StyledElement.h"
#include <wtf/HashMap.h>

namespace WebCore {

enum AnimatedAttributeType {
    AnimatedAngle,
    AnimatedBoolean,
    AnimatedColor,
    AnimatedEnumeration,
    AnimatedInteger,
    AnimatedLength,
    AnimatedLengthList,
    AnimatedNumber,
    AnimatedNumberList,
    AnimatedNumberOptionalNumber,
    AnimatedPath,
    AnimatedPoints,
    AnimatedPreserveAspectRatio,
    AnimatedRect,
    AnimatedString,
    AnimatedTransformList,
    AnimatedUnknown
};

typedef HashMap<QualifiedName, AnimatedAttributeType> AttributeToPropertyTypeMap;

class CSSCursorImageValue;
class Document;
class SVGCursorElement;
class SVGDocumentExtensions;
class SVGElementInstance;
class SVGElementRareData;
class SVGSVGElement;
class AffineTransform;

class SVGElement : public StyledElement {
public:
    static PassRefPtr<SVGElement> create(const QualifiedName&, Document*);
    virtual ~SVGElement();

    String xmlbase() const;
    void setXmlbase(const String&, ExceptionCode&);

    SVGSVGElement* ownerSVGElement() const;
    SVGElement* viewportElement() const;

    SVGDocumentExtensions* accessDocumentSVGExtensions() const;

    virtual bool isStyled() const { return false; }
    virtual bool isStyledTransformable() const { return false; }
    virtual bool isStyledLocatable() const { return false; }
    virtual bool isSVG() const { return false; }
    virtual bool isFilterEffect() const { return false; }
    virtual bool isGradientStop() const { return false; }
    virtual bool isTextContent() const { return false; }

    // For SVGTests
    virtual bool isValid() const { return true; }

    virtual void svgAttributeChanged(const QualifiedName&) { }
    virtual void synchronizeProperty(const QualifiedName&) { }

    virtual AttributeToPropertyTypeMap& attributeToPropertyTypeMap();
    AnimatedAttributeType animatedPropertyTypeForAttribute(const QualifiedName&);

    virtual void fillAttributeToPropertyTypeMap() { }

    void sendSVGLoadEventIfPossible(bool sendParentLoadEvents = false);

    virtual AffineTransform* supplementalTransform() { return 0; }

    void invalidateSVGAttributes() { clearAreSVGAttributesValid(); }

    const HashSet<SVGElementInstance*>& instancesForElement() const;

    bool boundingBox(FloatRect&, SVGLocatable::StyleUpdateStrategy = SVGLocatable::AllowStyleUpdate) const;

    void setCursorElement(SVGCursorElement*);
    void cursorElementRemoved();
    void setCursorImageValue(CSSCursorImageValue*);
    void cursorImageValueRemoved();

    virtual void updateAnimatedSVGAttribute(const QualifiedName&) const;

protected:
    SVGElement(const QualifiedName&, Document*);

    virtual void parseMappedAttribute(Attribute*);

    virtual void finishParsingChildren();
    virtual void insertedIntoDocument();
    virtual void attributeChanged(Attribute*, bool preserveDecls = false);
    virtual bool childShouldCreateRenderer(Node*) const;
    
    virtual void removedFromDocument();

    SVGElementRareData* rareSVGData() const;
    SVGElementRareData* ensureRareSVGData();

private:
    friend class SVGElementInstance;

    virtual bool rendererIsNeeded(RenderStyle*) { return false; }

    virtual bool isSupported(StringImpl* feature, StringImpl* version) const;

    virtual bool needsPendingResourceHandling() const { return true; }
    virtual void buildPendingResource() { }

    void mapInstanceToElement(SVGElementInstance*);
    void removeInstanceMapping(SVGElementInstance*);

    virtual bool haveLoadedRequiredResources();
};

}

#endif
#endif