Unreviewed, rolling out r140023.
[WebKit-https.git] / Source / WebCore / rendering / RenderNamedFlowThread.h
1 /*
2  * Copyright (C) 2012 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26
27 #ifndef RenderNamedFlowThread_h
28 #define RenderNamedFlowThread_h
29
30 #include "RenderFlowThread.h"
31 #include "Timer.h"
32 #include <wtf/HashCountedSet.h>
33 #include <wtf/ListHashSet.h>
34 #include <wtf/text/AtomicString.h>
35
36 namespace WebCore {
37
38 class Node;
39 class RenderNamedFlowThread;
40 class WebKitNamedFlow;
41
42 typedef ListHashSet<RenderNamedFlowThread*> RenderNamedFlowThreadList;
43 typedef HashCountedSet<RenderNamedFlowThread*> RenderNamedFlowThreadCountedSet;
44 typedef ListHashSet<Node*> NamedFlowContentNodes;
45
46 class RenderNamedFlowThread : public RenderFlowThread {
47 public:
48     RenderNamedFlowThread(ContainerNode*, PassRefPtr<WebKitNamedFlow>);
49     virtual ~RenderNamedFlowThread();
50
51     const AtomicString& flowThreadName() const;
52
53     const RenderRegionList& invalidRenderRegionList() const { return m_invalidRegionList; }
54
55     RenderObject* nextRendererForNode(Node*) const;
56     RenderObject* previousRendererForNode(Node*) const;
57
58     void addFlowChild(RenderObject* newChild);
59     void removeFlowChild(RenderObject*);
60     bool hasChildren() const { return !m_flowThreadChildList.isEmpty(); }
61 #ifndef NDEBUG
62     bool hasChild(RenderObject* child) const { return m_flowThreadChildList.contains(child); }
63 #endif
64
65     void pushDependencies(RenderNamedFlowThreadList&);
66
67     virtual void addRegionToThread(RenderRegion*) OVERRIDE;
68     virtual void removeRegionFromThread(RenderRegion*) OVERRIDE;
69
70     void registerNamedFlowContentNode(Node*);
71     void unregisterNamedFlowContentNode(Node*);
72     const NamedFlowContentNodes& contentNodes() const { return m_contentNodes; }
73     bool hasContentNode(Node* contentNode) const { ASSERT(contentNode); return m_contentNodes.contains(contentNode); }
74     bool isMarkedForDestruction() const;
75     void getRanges(Vector<RefPtr<Range> >&, const RenderRegion*) const;
76
77 protected:
78     void setMarkForDestruction();
79     void resetMarkForDestruction();
80
81 private:
82     virtual const char* renderName() const OVERRIDE;
83     virtual bool isRenderNamedFlowThread() const OVERRIDE { return true; }
84
85     virtual void dispatchRegionLayoutUpdateEvent() OVERRIDE;
86
87     bool dependsOn(RenderNamedFlowThread* otherRenderFlowThread) const;
88     void addDependencyOnFlowThread(RenderNamedFlowThread*);
89     void removeDependencyOnFlowThread(RenderNamedFlowThread*);
90     void checkInvalidRegions();
91     bool canBeDestroyed() const { return m_invalidRegionList.isEmpty() && m_regionList.isEmpty() && m_contentNodes.isEmpty(); }
92     void regionLayoutUpdateEventTimerFired(Timer<RenderNamedFlowThread>*);
93     void clearContentNodes();
94
95 private:
96     // Observer flow threads have invalid regions that depend on the state of this thread
97     // to re-validate their regions. Keeping a set of observer threads make it easy
98     // to notify them when a region was removed from this flow.
99     RenderNamedFlowThreadCountedSet m_observerThreadsSet;
100
101     // Some threads need to have a complete layout before we layout this flow.
102     // That's because they contain a RenderRegion that should display this thread. The set makes it
103     // easy to sort the order of threads layout.
104     RenderNamedFlowThreadCountedSet m_layoutBeforeThreadsSet;
105
106     // Holds the sorted children of a named flow. This is the only way we can get the ordering right.
107     typedef ListHashSet<RenderObject*> FlowThreadChildList;
108     FlowThreadChildList m_flowThreadChildList;
109
110     NamedFlowContentNodes m_contentNodes;
111
112     RenderRegionList m_invalidRegionList;
113
114     // The DOM Object that represents a named flow.
115     RefPtr<WebKitNamedFlow> m_namedFlow;
116
117     Timer<RenderNamedFlowThread> m_regionLayoutUpdateEventTimer;
118 };
119
120 inline RenderNamedFlowThread* toRenderNamedFlowThread(RenderObject* object)
121 {
122     ASSERT(!object || object->isRenderNamedFlowThread());
123     return static_cast<RenderNamedFlowThread*>(object);
124 }
125
126 inline const RenderNamedFlowThread* toRenderNamedFlowThread(const RenderObject* object)
127 {
128     ASSERT(!object || object->isRenderNamedFlowThread());
129     return static_cast<const RenderNamedFlowThread*>(object);
130 }
131
132 // This will catch anyone doing an unnecessary cast.
133 void toRenderNamedFlowThread(const RenderNamedFlowThread*);
134
135 } // namespace WebCore
136
137 #endif // RenderNamedFlowThread_h
138