Use is<>() / downcast<>() for all remaining RenderObject subclasses
[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 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 "SelectionSubtreeRoot.h"
32 #include "Timer.h"
33 #include <wtf/HashCountedSet.h>
34 #include <wtf/ListHashSet.h>
35 #include <wtf/text/AtomicString.h>
36
37 namespace WebCore {
38
39 class Node;
40 class RenderNamedFlowThread;
41 class WebKitNamedFlow;
42
43 typedef ListHashSet<RenderNamedFlowThread*> RenderNamedFlowThreadList;
44 typedef HashCountedSet<RenderNamedFlowThread*> RenderNamedFlowThreadCountedSet;
45 typedef ListHashSet<Element*> NamedFlowContentElements;
46
47 class RenderNamedFlowThread final : public RenderFlowThread, public SelectionSubtreeRoot {
48 public:
49     RenderNamedFlowThread(Document&, PassRef<RenderStyle>, PassRef<WebKitNamedFlow>);
50     virtual ~RenderNamedFlowThread();
51
52     const AtomicString& flowThreadName() const;
53
54     const RenderRegionList& invalidRenderRegionList() const { return m_invalidRegionList; }
55
56     RenderElement* nextRendererForElement(Element&) const;
57
58     void addFlowChild(RenderElement&);
59     void removeFlowChild(RenderElement&);
60     bool hasChildren() const { return !m_flowThreadChildList.isEmpty(); }
61 #ifndef NDEBUG
62     bool hasChild(RenderElement& child) const { return m_flowThreadChildList.contains(&child); }
63 #endif
64
65     static RenderBlock* fragmentFromRenderBoxAsRenderBlock(RenderBox*, const IntPoint& absolutePoint, const RenderBox& flowedBox);
66
67     void pushDependencies(RenderNamedFlowThreadList&);
68
69     virtual void addRegionToThread(RenderRegion*) override;
70     virtual void removeRegionFromThread(RenderRegion*) override;
71
72     virtual void regionChangedWritingMode(RenderRegion*) override;
73
74     LayoutRect decorationsClipRectForBoxInNamedFlowFragment(const RenderBox&, RenderNamedFlowFragment&) const;
75
76     RenderNamedFlowFragment* fragmentFromAbsolutePointAndBox(const IntPoint&, const RenderBox& flowedBox);
77
78     void registerNamedFlowContentElement(Element&);
79     void unregisterNamedFlowContentElement(Element&);
80     const NamedFlowContentElements& contentElements() const { return m_contentElements; }
81     bool hasContentElement(Element&) const;
82
83     bool isMarkedForDestruction() const;
84     void getRanges(Vector<RefPtr<Range>>&, const RenderNamedFlowFragment*) const;
85
86     virtual void applyBreakAfterContent(LayoutUnit) override final;
87
88     virtual bool collectsGraphicsLayersUnderRegions() const override;
89
90     // Check if the content is flown into at least a region with region styling rules.
91     bool hasRegionsWithStyling() const { return m_hasRegionsWithStyling; }
92     void checkRegionsWithStyling();
93
94     void clearRenderObjectCustomStyle(const RenderObject*);
95
96     virtual void removeFlowChildInfo(RenderObject*) override final;
97
98     LayoutUnit flowContentBottom() const { return m_flowContentBottom; }
99     void dispatchNamedFlowEvents();
100
101     void setDispatchRegionOversetChangeEvent(bool value) { m_dispatchRegionOversetChangeEvent = value; }
102
103     virtual bool absoluteQuadsForBox(Vector<FloatQuad>&, bool*, const RenderBox*, float, float) const override;
104
105 protected:
106     void setMarkForDestruction();
107     void resetMarkForDestruction();
108
109 private:
110     virtual const char* renderName() const override;
111     virtual bool isRenderNamedFlowThread() const override { return true; }
112     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
113     virtual void computeOverflow(LayoutUnit, bool = false) override;
114     virtual void layout() override final;
115
116     void dispatchRegionOversetChangeEventIfNeeded();
117
118     bool dependsOn(RenderNamedFlowThread* otherRenderFlowThread) const;
119     void addDependencyOnFlowThread(RenderNamedFlowThread*);
120     void removeDependencyOnFlowThread(RenderNamedFlowThread*);
121
122     void addFragmentToNamedFlowThread(RenderNamedFlowFragment*);
123
124     void checkInvalidRegions();
125
126     bool canBeDestroyed() const { return m_invalidRegionList.isEmpty() && m_regionList.isEmpty() && m_contentElements.isEmpty(); }
127     void regionOversetChangeEventTimerFired(Timer<RenderNamedFlowThread>&);
128     void clearContentElements();
129     void updateWritingMode();
130
131     WebKitNamedFlow& namedFlow() { return m_namedFlow.get(); }
132     const WebKitNamedFlow& namedFlow() const { return m_namedFlow.get(); }
133
134     // Observer flow threads have invalid regions that depend on the state of this thread
135     // to re-validate their regions. Keeping a set of observer threads make it easy
136     // to notify them when a region was removed from this flow.
137     RenderNamedFlowThreadCountedSet m_observerThreadsSet;
138
139     // Some threads need to have a complete layout before we layout this flow.
140     // That's because they contain a RenderRegion that should display this thread. The set makes it
141     // easy to sort the order of threads layout.
142     RenderNamedFlowThreadCountedSet m_layoutBeforeThreadsSet;
143
144     // Holds the sorted children of a named flow. This is the only way we can get the ordering right.
145     ListHashSet<RenderElement*> m_flowThreadChildList;
146
147     NamedFlowContentElements m_contentElements;
148
149     RenderRegionList m_invalidRegionList;
150
151     bool m_hasRegionsWithStyling : 1;
152     bool m_dispatchRegionOversetChangeEvent : 1;
153
154     // The DOM Object that represents a named flow.
155     Ref<WebKitNamedFlow> m_namedFlow;
156
157     Timer<RenderNamedFlowThread> m_regionOversetChangeEventTimer;
158
159     LayoutUnit m_flowContentBottom;
160 };
161
162 } // namespace WebCore
163
164 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderNamedFlowThread, isRenderNamedFlowThread())
165
166 #endif // RenderNamedFlowThread_h