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