[CSS Regions] Scrolling regions with the mouse wheel only works properly if hovering...
[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     LayoutRect decorationsClipRectForBoxInNamedFlowFragment(const RenderBox&, RenderNamedFlowFragment&) const;
72
73     RenderNamedFlowFragment* fragmentFromAbsolutePointAndBox(const IntPoint&, const RenderBox& flowedBox);
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 RenderNamedFlowFragment*) 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     LayoutUnit flowContentBottom() const { return m_flowContentBottom; }
94     void dispatchNamedFlowEvents();
95
96     void setDispatchRegionLayoutUpdateEvent(bool value) { m_dispatchRegionLayoutUpdateEvent = value; }
97     void setDispatchRegionOversetChangeEvent(bool value) { m_dispatchRegionOversetChangeEvent = value; }
98
99 protected:
100     void setMarkForDestruction();
101     void resetMarkForDestruction();
102
103 private:
104     virtual const char* renderName() const override;
105     virtual bool isRenderNamedFlowThread() const override { return true; }
106     virtual bool isChildAllowed(const RenderObject&, const RenderStyle&) const override;
107     virtual void computeOverflow(LayoutUnit, bool = false) override;
108     virtual void layout() override final;
109
110     void dispatchRegionLayoutUpdateEventIfNeeded();
111     void dispatchRegionOversetChangeEventIfNeeded();
112
113     bool dependsOn(RenderNamedFlowThread* otherRenderFlowThread) const;
114     void addDependencyOnFlowThread(RenderNamedFlowThread*);
115     void removeDependencyOnFlowThread(RenderNamedFlowThread*);
116
117     void addFragmentToNamedFlowThread(RenderNamedFlowFragment*);
118
119     void checkInvalidRegions();
120
121     bool canBeDestroyed() const { return m_invalidRegionList.isEmpty() && m_regionList.isEmpty() && m_contentElements.isEmpty(); }
122     void regionLayoutUpdateEventTimerFired(Timer<RenderNamedFlowThread>&);
123     void regionOversetChangeEventTimerFired(Timer<RenderNamedFlowThread>&);
124     void clearContentElements();
125     void updateWritingMode();
126
127     WebKitNamedFlow& namedFlow() { return m_namedFlow.get(); }
128     const WebKitNamedFlow& namedFlow() const { return m_namedFlow.get(); }
129
130     // Observer flow threads have invalid regions that depend on the state of this thread
131     // to re-validate their regions. Keeping a set of observer threads make it easy
132     // to notify them when a region was removed from this flow.
133     RenderNamedFlowThreadCountedSet m_observerThreadsSet;
134
135     // Some threads need to have a complete layout before we layout this flow.
136     // That's because they contain a RenderRegion that should display this thread. The set makes it
137     // easy to sort the order of threads layout.
138     RenderNamedFlowThreadCountedSet m_layoutBeforeThreadsSet;
139
140     // Holds the sorted children of a named flow. This is the only way we can get the ordering right.
141     ListHashSet<RenderElement*> m_flowThreadChildList;
142
143     NamedFlowContentElements m_contentElements;
144
145     RenderRegionList m_invalidRegionList;
146
147     bool m_hasRegionsWithStyling : 1;
148     bool m_dispatchRegionLayoutUpdateEvent : 1;
149     bool m_dispatchRegionOversetChangeEvent : 1;
150
151     // The DOM Object that represents a named flow.
152     Ref<WebKitNamedFlow> m_namedFlow;
153
154     Timer<RenderNamedFlowThread> m_regionLayoutUpdateEventTimer;
155     Timer<RenderNamedFlowThread> m_regionOversetChangeEventTimer;
156
157     LayoutUnit m_flowContentBottom;
158 };
159
160 RENDER_OBJECT_TYPE_CASTS(RenderNamedFlowThread, isRenderNamedFlowThread())
161
162 } // namespace WebCore
163
164 #endif // RenderNamedFlowThread_h