fee2f355025e534a538c27cbb30ffe0470beadd8
[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&, RenderStyle&&, Ref<WebKitNamedFlow>&&);
50     virtual ~RenderNamedFlowThread();
51
52     const AtomicString& flowThreadName() const;
53
54     const RenderRegionList& invalidRenderRegionList() const { return m_invalidRegionList; }
55
56     static RenderBlock* fragmentFromRenderBoxAsRenderBlock(RenderBox*, const IntPoint& absolutePoint, const RenderBox& flowedBox);
57
58     void pushDependencies(RenderNamedFlowThreadList&);
59
60     void addRegionToThread(RenderRegion*) override;
61     void removeRegionFromThread(RenderRegion*) override;
62
63     void regionChangedWritingMode(RenderRegion*) override;
64
65     LayoutRect decorationsClipRectForBoxInNamedFlowFragment(const RenderBox&, RenderNamedFlowFragment&) const;
66
67     RenderNamedFlowFragment* fragmentFromAbsolutePointAndBox(const IntPoint&, const RenderBox& flowedBox);
68
69     void registerNamedFlowContentElement(Element&);
70     void unregisterNamedFlowContentElement(Element&);
71     const NamedFlowContentElements& contentElements() const { return m_contentElements; }
72     bool hasContentElement(Element&) const;
73
74     bool isMarkedForDestruction() const;
75     void getRanges(Vector<RefPtr<Range>>&, const RenderNamedFlowFragment*) const;
76
77     void applyBreakAfterContent(LayoutUnit) override;
78
79     bool collectsGraphicsLayersUnderRegions() const override;
80
81     // Check if the content is flown into at least a region with region styling rules.
82     bool hasRegionsWithStyling() const { return m_hasRegionsWithStyling; }
83     void checkRegionsWithStyling();
84
85     void clearRenderObjectCustomStyle(const RenderElement&);
86
87     void removeFlowChildInfo(RenderElement&) override;
88
89     LayoutUnit flowContentBottom() const { return m_flowContentBottom; }
90     void dispatchNamedFlowEvents();
91
92     void setDispatchRegionOversetChangeEvent(bool value) { m_dispatchRegionOversetChangeEvent = value; }
93
94     bool absoluteQuadsForBox(Vector<FloatQuad>&, bool*, const RenderBox*, float, float) const override;
95
96 protected:
97     void setMarkForDestruction();
98     void resetMarkForDestruction();
99
100 private:
101     const char* renderName() const override;
102     bool isRenderNamedFlowThread() const override { return true; }
103     bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
104     void computeOverflow(LayoutUnit, bool = false) override;
105     void layout() override;
106
107     void dispatchRegionOversetChangeEventIfNeeded();
108
109     bool dependsOn(RenderNamedFlowThread* otherRenderFlowThread) const;
110     void addDependencyOnFlowThread(RenderNamedFlowThread*);
111     void removeDependencyOnFlowThread(RenderNamedFlowThread*);
112
113     void addFragmentToNamedFlowThread(RenderNamedFlowFragment*);
114
115     void checkInvalidRegions();
116
117     bool canBeDestroyed() const { return m_invalidRegionList.isEmpty() && m_regionList.isEmpty() && m_contentElements.isEmpty(); }
118     void regionOversetChangeEventTimerFired();
119     void clearContentElements();
120     void updateWritingMode();
121
122     WebKitNamedFlow& namedFlow() { return m_namedFlow; }
123     const WebKitNamedFlow& namedFlow() const { return m_namedFlow; }
124
125     // Observer flow threads have invalid regions that depend on the state of this thread
126     // to re-validate their regions. Keeping a set of observer threads make it easy
127     // to notify them when a region was removed from this flow.
128     RenderNamedFlowThreadCountedSet m_observerThreadsSet;
129
130     // Some threads need to have a complete layout before we layout this flow.
131     // That's because they contain a RenderRegion that should display this thread. The set makes it
132     // easy to sort the order of threads layout.
133     RenderNamedFlowThreadCountedSet m_layoutBeforeThreadsSet;
134
135     NamedFlowContentElements m_contentElements;
136
137     RenderRegionList m_invalidRegionList;
138
139     bool m_hasRegionsWithStyling : 1;
140     bool m_dispatchRegionOversetChangeEvent : 1;
141
142     // The DOM Object that represents a named flow.
143     Ref<WebKitNamedFlow> m_namedFlow;
144
145     Timer m_regionOversetChangeEventTimer;
146
147     LayoutUnit m_flowContentBottom;
148 };
149
150 } // namespace WebCore
151
152 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderNamedFlowThread, isRenderNamedFlowThread())
153
154 #endif // RenderNamedFlowThread_h