[CSS Regions]Add helper class for flow threads info in RenderView
[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 <wtf/HashCountedSet.h>
32 #include <wtf/ListHashSet.h>
33 #include <wtf/text/AtomicString.h>
34
35 namespace WebCore {
36
37 class RenderNamedFlowThread;
38 class WebKitNamedFlow;
39
40 typedef ListHashSet<RenderNamedFlowThread*> RenderNamedFlowThreadList;
41 typedef HashCountedSet<RenderNamedFlowThread*> RenderNamedFlowThreadCountedSet;
42
43 class RenderNamedFlowThread : public RenderFlowThread {
44 public:
45     RenderNamedFlowThread(Node*, const AtomicString&);
46
47     AtomicString flowThreadName() const { return m_flowThreadName; }
48
49     RenderObject* nextRendererForNode(Node*) const;
50     RenderObject* previousRendererForNode(Node*) const;
51
52     void addFlowChild(RenderObject* newChild, RenderObject* beforeChild = 0);
53     void removeFlowChild(RenderObject*);
54     bool hasChildren() const { return !m_flowThreadChildList.isEmpty(); }
55 #ifndef NDEBUG
56     bool hasChild(RenderObject* child) const { return m_flowThreadChildList.contains(child); }
57 #endif
58
59     void pushDependencies(RenderNamedFlowThreadList&);
60
61     virtual void addRegionToThread(RenderRegion*) OVERRIDE;
62     virtual void removeRegionFromThread(RenderRegion*) OVERRIDE;
63
64     WebKitNamedFlow* ensureNamedFlow();
65
66 private:
67     virtual const char* renderName() const OVERRIDE;
68     virtual bool isRenderNamedFlowThread() const OVERRIDE { return true; }
69
70     bool dependsOn(RenderNamedFlowThread* otherRenderFlowThread) const;
71     void addDependencyOnFlowThread(RenderNamedFlowThread*);
72     void removeDependencyOnFlowThread(RenderNamedFlowThread*);
73     void checkInvalidRegions();
74
75 private:
76     // The name of the flow thread as specified in CSS.
77     AtomicString m_flowThreadName;
78
79     // Observer flow threads have invalid regions that depend on the state of this thread
80     // to re-validate their regions. Keeping a set of observer threads make it easy
81     // to notify them when a region was removed from this flow.
82     RenderNamedFlowThreadCountedSet m_observerThreadsSet;
83
84     // Some threads need to have a complete layout before we layout this flow.
85     // That's because they contain a RenderRegion that should display this thread. The set makes it
86     // easy to sort the order of threads layout.
87     RenderNamedFlowThreadCountedSet m_layoutBeforeThreadsSet;
88
89     // Holds the sorted children of a named flow. This is the only way we can get the ordering right.
90     typedef ListHashSet<RenderObject*> FlowThreadChildList;
91     FlowThreadChildList m_flowThreadChildList;
92
93     // The DOM Object that represents a named flow.
94     RefPtr<WebKitNamedFlow> m_namedFlow;
95 };
96
97 inline RenderNamedFlowThread* toRenderNamedFlowThread(RenderObject* object)
98 {
99     ASSERT(!object || object->isRenderNamedFlowThread());
100     return static_cast<RenderNamedFlowThread*>(object);
101 }
102
103 inline const RenderNamedFlowThread* toRenderNamedFlowThread(const RenderObject* object)
104 {
105     ASSERT(!object || object->isRenderNamedFlowThread());
106     return static_cast<const RenderNamedFlowThread*>(object);
107 }
108
109 // This will catch anyone doing an unnecessary cast.
110 void toRenderNamedFlowThread(const RenderNamedFlowThread*);
111
112 } // namespace WebCore
113
114 #endif // RenderNamedFlowThread_h
115