Avoid race condition when iterating over pending resources
[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 class SVGResourcesCache;
38 class SVGSMILElement;
39 class SVGSVGElement;
40 class SVGStyledElement;
41
42 class SVGDocumentExtensions {
43     WTF_MAKE_NONCOPYABLE(SVGDocumentExtensions); WTF_MAKE_FAST_ALLOCATED;
44 public:
45     typedef HashSet<SVGStyledElement*> SVGPendingElements;
46     SVGDocumentExtensions(Document*);
47     ~SVGDocumentExtensions();
48     
49     void addTimeContainer(SVGSVGElement*);
50     void removeTimeContainer(SVGSVGElement*);
51
52     void addResource(const AtomicString& id, RenderSVGResourceContainer*);
53     void removeResource(const AtomicString& id);
54     RenderSVGResourceContainer* resourceById(const AtomicString& id) const;
55
56     void startAnimations();
57     void pauseAnimations();
58     void unpauseAnimations();
59     void dispatchSVGLoadEventToOutermostSVGElements();
60     
61     void addAnimationElementToTarget(SVGSMILElement*, SVGElement*);
62     void removeAnimationElementFromTarget(SVGSMILElement*, SVGElement*);
63     void removeAllAnimationElementsFromTarget(SVGElement*);
64
65     void reportWarning(const String&);
66     void reportError(const String&);
67
68     SVGResourcesCache* resourcesCache() const { return m_resourcesCache.get(); }
69
70     HashSet<SVGElement*>* setOfElementsReferencingTarget(SVGElement* referencedElement) const;
71     void addElementReferencingTarget(SVGElement* referencingElement, SVGElement* referencedElement);
72     void removeAllTargetReferencesForElement(SVGElement* referencingElement);
73     void removeAllElementReferencesForTarget(SVGElement* referencedElement);
74
75 private:
76     Document* m_document; // weak reference
77     HashSet<SVGSVGElement*> m_timeContainers; // For SVG 1.2 support this will need to be made more general.
78     HashMap<SVGElement*, HashSet<SVGSMILElement*>* > m_animatedElements;
79     HashMap<AtomicString, RenderSVGResourceContainer*> m_resources;
80     HashMap<AtomicString, SVGPendingElements*> m_pendingResources; // Resources that are pending.
81     HashMap<AtomicString, SVGPendingElements*> m_pendingResourcesForRemoval; // Resources that are pending and scheduled for removal.
82     HashMap<SVGElement*, OwnPtr<HashSet<SVGElement*> > > m_elementDependencies;
83     OwnPtr<SVGResourcesCache> m_resourcesCache;
84
85 public:
86     // This HashMap contains a list of pending resources. Pending resources, are such
87     // which are referenced by any object in the SVG document, but do NOT exist yet.
88     // For instance, dynamically build gradients / patterns / clippers...
89     void addPendingResource(const AtomicString& id, SVGStyledElement*);
90     bool hasPendingResource(const AtomicString& id) const;
91     bool isElementPendingResources(SVGStyledElement*) const;
92     bool isElementPendingResource(SVGStyledElement*, const AtomicString& id) const;
93     void removeElementFromPendingResources(SVGStyledElement*);
94     PassOwnPtr<SVGPendingElements> removePendingResource(const AtomicString& id);
95
96     // The following two functions are used for scheduling a pending resource to be removed.
97     void markPendingResourcesForRemoval(const AtomicString&);
98     SVGStyledElement* removeElementFromPendingResourcesForRemoval(const AtomicString&);
99
100 private:
101     PassOwnPtr<SVGPendingElements> removePendingResourceForRemoval(const AtomicString&);
102 };
103
104 }
105
106 #endif
107 #endif