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