[CSS Regions] The regionLayoutUpdate event should be dispatched on the NamedFlow...
[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<Node*> NamedFlowContentNodes;
45
46 class RenderNamedFlowThread : public RenderFlowThread {
47 public:
48     RenderNamedFlowThread(Node*, PassRefPtr<WebKitNamedFlow>);
49     virtual ~RenderNamedFlowThread();
50
51     const AtomicString& flowThreadName() const;
52
53     RenderObject* nextRendererForNode(Node*) const;
54     RenderObject* previousRendererForNode(Node*) const;
55
56     void addFlowChild(RenderObject* newChild, RenderObject* beforeChild = 0);
57     void removeFlowChild(RenderObject*);
58     bool hasChildren() const { return !m_flowThreadChildList.isEmpty(); }
59 #ifndef NDEBUG
60     bool hasChild(RenderObject* child) const { return m_flowThreadChildList.contains(child); }
61 #endif
62
63     void pushDependencies(RenderNamedFlowThreadList&);
64
65     virtual void addRegionToThread(RenderRegion*) OVERRIDE;
66     virtual void removeRegionFromThread(RenderRegion*) OVERRIDE;
67
68     void registerNamedFlowContentNode(Node*);
69     void unregisterNamedFlowContentNode(Node*);
70     const NamedFlowContentNodes& contentNodes() const { return m_contentNodes; }
71     bool hasContentNode(Node* contentNode) const { ASSERT(contentNode); return m_contentNodes.contains(contentNode); }
72
73 protected:
74     virtual void willBeDestroyed() OVERRIDE;
75
76 private:
77     virtual const char* renderName() const OVERRIDE;
78     virtual bool isRenderNamedFlowThread() const OVERRIDE { return true; }
79
80     virtual void dispatchRegionLayoutUpdateEvent() OVERRIDE;
81
82     bool dependsOn(RenderNamedFlowThread* otherRenderFlowThread) const;
83     void addDependencyOnFlowThread(RenderNamedFlowThread*);
84     void removeDependencyOnFlowThread(RenderNamedFlowThread*);
85     void checkInvalidRegions();
86     bool canBeDestroyed() const { return m_regionList.isEmpty() && m_contentNodes.isEmpty(); }
87     void regionLayoutUpdateEventTimerFired(Timer<RenderNamedFlowThread>*);
88
89 private:
90     // Observer flow threads have invalid regions that depend on the state of this thread
91     // to re-validate their regions. Keeping a set of observer threads make it easy
92     // to notify them when a region was removed from this flow.
93     RenderNamedFlowThreadCountedSet m_observerThreadsSet;
94
95     // Some threads need to have a complete layout before we layout this flow.
96     // That's because they contain a RenderRegion that should display this thread. The set makes it
97     // easy to sort the order of threads layout.
98     RenderNamedFlowThreadCountedSet m_layoutBeforeThreadsSet;
99
100     // Holds the sorted children of a named flow. This is the only way we can get the ordering right.
101     typedef ListHashSet<RenderObject*> FlowThreadChildList;
102     FlowThreadChildList m_flowThreadChildList;
103
104     NamedFlowContentNodes m_contentNodes;
105
106     // The DOM Object that represents a named flow.
107     RefPtr<WebKitNamedFlow> m_namedFlow;
108
109     Timer<RenderNamedFlowThread> m_regionLayoutUpdateEventTimer;
110 };
111
112 inline RenderNamedFlowThread* toRenderNamedFlowThread(RenderObject* object)
113 {
114     ASSERT(!object || object->isRenderNamedFlowThread());
115     return static_cast<RenderNamedFlowThread*>(object);
116 }
117
118 inline const RenderNamedFlowThread* toRenderNamedFlowThread(const RenderObject* object)
119 {
120     ASSERT(!object || object->isRenderNamedFlowThread());
121     return static_cast<const RenderNamedFlowThread*>(object);
122 }
123
124 // This will catch anyone doing an unnecessary cast.
125 void toRenderNamedFlowThread(const RenderNamedFlowThread*);
126
127 } // namespace WebCore
128
129 #endif // RenderNamedFlowThread_h
130