Unify SVG's animation and target tracking systems.
[WebKit-https.git] / Source / WebCore / svg / SVGDocumentExtensions.h
1 /*
2  * Copyright (C) 2006 Apple Inc. All rights reserved.
3  * Copyright (C) 2006, 2008 Nikolas Zimmermann <zimmermann@kde.org>
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef SVGDocumentExtensions_h
22 #define SVGDocumentExtensions_h
23
24 #if ENABLE(SVG)
25 #include <wtf/Forward.h>
26 #include <wtf/HashMap.h>
27 #include <wtf/HashSet.h>
28 #include <wtf/PassOwnPtr.h>
29 #include <wtf/text/AtomicStringHash.h>
30 #include <wtf/text/StringImpl.h>
31
32 namespace WebCore {
33
34 class Document;
35 class RenderSVGResourceContainer;
36 class SVGElement;
37 #if ENABLE(SVG_FONTS)
38 class SVGFontFaceElement;
39 #endif
40 class SVGResourcesCache;
41 class SVGSMILElement;
42 class SVGSVGElement;
43
44 class SVGDocumentExtensions {
45     WTF_MAKE_NONCOPYABLE(SVGDocumentExtensions); WTF_MAKE_FAST_ALLOCATED;
46 public:
47     typedef HashSet<SVGElement*> SVGPendingElements;
48     SVGDocumentExtensions(Document*);
49     ~SVGDocumentExtensions();
50     
51     void addTimeContainer(SVGSVGElement*);
52     void removeTimeContainer(SVGSVGElement*);
53
54     void addResource(const AtomicString& id, RenderSVGResourceContainer*);
55     void removeResource(const AtomicString& id);
56     RenderSVGResourceContainer* resourceById(const AtomicString& id) const;
57
58     void startAnimations();
59     void pauseAnimations();
60     void unpauseAnimations();
61     void dispatchSVGLoadEventToOutermostSVGElements();
62
63     void reportWarning(const String&);
64     void reportError(const String&);
65
66     SVGResourcesCache* resourcesCache() const { return m_resourcesCache.get(); }
67
68     HashSet<SVGElement*>* setOfElementsReferencingTarget(SVGElement* referencedElement) const;
69     void addElementReferencingTarget(SVGElement* referencingElement, SVGElement* referencedElement);
70     void removeAllTargetReferencesForElement(SVGElement* referencingElement);
71     void removeAllElementReferencesForTarget(SVGElement* referencedElement);
72
73 #if ENABLE(SVG_FONTS)
74     const HashSet<SVGFontFaceElement*>& svgFontFaceElements() const { return m_svgFontFaceElements; }
75     void registerSVGFontFaceElement(SVGFontFaceElement*);
76     void unregisterSVGFontFaceElement(SVGFontFaceElement*);
77 #endif
78
79 private:
80     Document* m_document; // weak reference
81     HashSet<SVGSVGElement*> m_timeContainers; // For SVG 1.2 support this will need to be made more general.
82 #if ENABLE(SVG_FONTS)
83     HashSet<SVGFontFaceElement*> m_svgFontFaceElements;
84 #endif
85     HashMap<AtomicString, RenderSVGResourceContainer*> m_resources;
86     HashMap<AtomicString, SVGPendingElements*> m_pendingResources; // Resources that are pending.
87     HashMap<AtomicString, SVGPendingElements*> m_pendingResourcesForRemoval; // Resources that are pending and scheduled for removal.
88     HashMap<SVGElement*, OwnPtr<HashSet<SVGElement*> > > m_elementDependencies;
89     OwnPtr<SVGResourcesCache> m_resourcesCache;
90
91 public:
92     // This HashMap contains a list of pending resources. Pending resources, are such
93     // which are referenced by any object in the SVG document, but do NOT exist yet.
94     // For instance, dynamically built gradients / patterns / clippers...
95     void addPendingResource(const AtomicString& id, SVGElement*);
96     bool hasPendingResource(const AtomicString& id) const;
97     bool isElementPendingResources(SVGElement*) const;
98     bool isElementPendingResource(SVGElement*, const AtomicString& id) const;
99     void removeElementFromPendingResources(SVGElement*);
100     PassOwnPtr<SVGPendingElements> removePendingResource(const AtomicString& id);
101
102     // The following two functions are used for scheduling a pending resource to be removed.
103     void markPendingResourcesForRemoval(const AtomicString&);
104     SVGElement* removeElementFromPendingResourcesForRemoval(const AtomicString&);
105
106 private:
107     PassOwnPtr<SVGPendingElements> removePendingResourceForRemoval(const AtomicString&);
108 };
109
110 }
111
112 #endif
113 #endif