CTTE: RenderNamedFlowThread always has a WebKitNamedFlow.
[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<Element*> NamedFlowContentElements;
45
46 class RenderNamedFlowThread final : public RenderFlowThread {
47 public:
48     RenderNamedFlowThread(Document&, PassRef<RenderStyle>, PassRef<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     virtual void regionChangedWritingMode(RenderRegion*) override;
71
72     bool overset() const { return m_overset; }
73     void computeOversetStateForRegions(LayoutUnit oldClientAfterEdge);
74
75     void registerNamedFlowContentElement(Element&);
76     void unregisterNamedFlowContentElement(Element&);
77     const NamedFlowContentElements& contentElements() const { return m_contentElements; }
78     bool hasContentElement(Element&) const;
79
80     bool isMarkedForDestruction() const;
81     void getRanges(Vector<RefPtr<Range>>&, const RenderRegion*) const;
82
83     virtual bool collectsGraphicsLayersUnderRegions() const override;
84
85     // Check if the content is flown into at least a region with region styling rules.
86     bool hasRegionsWithStyling() const { return m_hasRegionsWithStyling; }
87     void checkRegionsWithStyling();
88
89     void clearRenderObjectCustomStyle(const RenderObject*);
90
91     virtual void removeFlowChildInfo(RenderObject*) override final;
92
93 protected:
94     void setMarkForDestruction();
95     void resetMarkForDestruction();
96
97 private:
98     virtual const char* renderName() const override;
99     virtual bool isRenderNamedFlowThread() const override { return true; }
100     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
101
102     virtual void dispatchRegionLayoutUpdateEvent() override;
103     virtual void dispatchRegionOversetChangeEvent() override;
104
105     bool dependsOn(RenderNamedFlowThread* otherRenderFlowThread) const;
106     void addDependencyOnFlowThread(RenderNamedFlowThread*);
107     void removeDependencyOnFlowThread(RenderNamedFlowThread*);
108
109     void addRegionToNamedFlowThread(RenderRegion*);
110
111     void checkInvalidRegions();
112
113     bool canBeDestroyed() const { return m_invalidRegionList.isEmpty() && m_regionList.isEmpty() && m_contentElements.isEmpty(); }
114     void regionLayoutUpdateEventTimerFired(Timer<RenderNamedFlowThread>&);
115     void regionOversetChangeEventTimerFired(Timer<RenderNamedFlowThread>&);
116     void clearContentElements();
117     void updateWritingMode();
118
119     WebKitNamedFlow& namedFlow() { return m_namedFlow.get(); }
120     const WebKitNamedFlow& namedFlow() const { return m_namedFlow.get(); }
121
122     // Observer flow threads have invalid regions that depend on the state of this thread
123     // to re-validate their regions. Keeping a set of observer threads make it easy
124     // to notify them when a region was removed from this flow.
125     RenderNamedFlowThreadCountedSet m_observerThreadsSet;
126
127     // Some threads need to have a complete layout before we layout this flow.
128     // That's because they contain a RenderRegion that should display this thread. The set makes it
129     // easy to sort the order of threads layout.
130     RenderNamedFlowThreadCountedSet m_layoutBeforeThreadsSet;
131
132     // Holds the sorted children of a named flow. This is the only way we can get the ordering right.
133     typedef ListHashSet<RenderObject*> FlowThreadChildList;
134     OwnPtr<FlowThreadChildList> m_flowThreadChildList;
135
136     NamedFlowContentElements m_contentElements;
137
138     RenderRegionList m_invalidRegionList;
139
140     bool m_overset : 1;
141     bool m_hasRegionsWithStyling : 1;
142
143     // The DOM Object that represents a named flow.
144     Ref<WebKitNamedFlow> m_namedFlow;
145
146     Timer<RenderNamedFlowThread> m_regionLayoutUpdateEventTimer;
147     Timer<RenderNamedFlowThread> m_regionOversetChangeEventTimer;
148 };
149
150 RENDER_OBJECT_TYPE_CASTS(RenderNamedFlowThread, isRenderNamedFlowThread())
151
152 } // namespace WebCore
153
154 #endif // RenderNamedFlowThread_h