1f574ae567e940e1901df55f44e748ce08a0e687
[WebKit-https.git] / Source / WebCore / rendering / FloatingObjects.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2007 David Smith (catfish.man@gmail.com)
5  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
6  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #ifndef FloatingObjects_h
25 #define FloatingObjects_h
26
27 #include "PODIntervalTree.h"
28 #include "RootInlineBox.h"
29 #include <wtf/ListHashSet.h>
30
31 namespace WebCore {
32
33 class RenderBlockFlow;
34 class RenderBox;
35
36 class FloatingObject {
37     WTF_MAKE_NONCOPYABLE(FloatingObject); WTF_MAKE_FAST_ALLOCATED;
38 public:
39     // Note that Type uses bits so you can use FloatLeftRight as a mask to query for both left and right.
40     enum Type { FloatLeft = 1, FloatRight = 2, FloatLeftRight = 3 };
41
42     static std::unique_ptr<FloatingObject> create(RenderBox&);
43     std::unique_ptr<FloatingObject> copyToNewContainer(LayoutSize, bool shouldPaint = false, bool isDescendant = false) const;
44     std::unique_ptr<FloatingObject> unsafeClone() const;
45
46     explicit FloatingObject(RenderBox&);
47     FloatingObject(RenderBox&, Type, const LayoutRect&, bool shouldPaint, bool isDescendant);
48
49     Type type() const { return static_cast<Type>(m_type); }
50     RenderBox& renderer() const { return m_renderer; }
51
52     bool isPlaced() const { return m_isPlaced; }
53     void setIsPlaced(bool placed = true) { m_isPlaced = placed; }
54
55     LayoutUnit x() const { ASSERT(isPlaced()); return m_frameRect.x(); }
56     LayoutUnit maxX() const { ASSERT(isPlaced()); return m_frameRect.maxX(); }
57     LayoutUnit y() const { ASSERT(isPlaced()); return m_frameRect.y(); }
58     LayoutUnit maxY() const { ASSERT(isPlaced()); return m_frameRect.maxY(); }
59     LayoutUnit width() const { return m_frameRect.width(); }
60     LayoutUnit height() const { return m_frameRect.height(); }
61
62     void setX(LayoutUnit x) { ASSERT(!isInPlacedTree()); m_frameRect.setX(x); }
63     void setY(LayoutUnit y) { ASSERT(!isInPlacedTree()); m_frameRect.setY(y); }
64     void setWidth(LayoutUnit width) { ASSERT(!isInPlacedTree()); m_frameRect.setWidth(width); }
65     void setHeight(LayoutUnit height) { ASSERT(!isInPlacedTree()); m_frameRect.setHeight(height); }
66
67     const LayoutRect& frameRect() const { ASSERT(isPlaced()); return m_frameRect; }
68     void setFrameRect(const LayoutRect& frameRect) { ASSERT(!isInPlacedTree()); m_frameRect = frameRect; }
69
70     LayoutUnit paginationStrut() const { return m_paginationStrut; }
71     void setPaginationStrut(LayoutUnit strut) { m_paginationStrut = strut; }
72
73 #ifndef NDEBUG
74     bool isInPlacedTree() const { return m_isInPlacedTree; }
75     void setIsInPlacedTree(bool value) { m_isInPlacedTree = value; }
76 #endif
77
78     bool shouldPaint() const { return m_shouldPaint; }
79     void setShouldPaint(bool shouldPaint) { m_shouldPaint = shouldPaint; }
80     bool isDescendant() const { return m_isDescendant; }
81     void setIsDescendant(bool isDescendant) { m_isDescendant = isDescendant; }
82
83     // FIXME: Callers of these methods are dangerous and should be whitelisted explicitly or removed.
84     RootInlineBox* originatingLine() const { return m_originatingLine; }
85     void setOriginatingLine(RootInlineBox* line) { m_originatingLine = line; }
86
87 private:
88     RenderBox& m_renderer;
89     RootInlineBox* m_originatingLine;
90     LayoutRect m_frameRect;
91     LayoutUnit m_paginationStrut;
92
93     unsigned m_type : 2; // Type (left or right aligned)
94     unsigned m_shouldPaint : 1;
95     unsigned m_isDescendant : 1;
96     unsigned m_isPlaced : 1;
97 #ifndef NDEBUG
98     unsigned m_isInPlacedTree : 1;
99 #endif
100 };
101
102 struct FloatingObjectHashFunctions {
103     static unsigned hash(const std::unique_ptr<FloatingObject>& key) { return PtrHash<RenderBox*>::hash(&key->renderer()); }
104     static bool equal(const std::unique_ptr<FloatingObject>& a, const std::unique_ptr<FloatingObject>& b) { return &a->renderer() == &b->renderer(); }
105     static const bool safeToCompareToEmptyOrDeleted = true;
106 };
107 struct FloatingObjectHashTranslator {
108     static unsigned hash(const RenderBox& key) { return PtrHash<const RenderBox*>::hash(&key); }
109     static unsigned hash(const FloatingObject& key) { return PtrHash<RenderBox*>::hash(&key.renderer()); }
110     static bool equal(const std::unique_ptr<FloatingObject>& a, const RenderBox& b) { return &a->renderer() == &b; }
111     static bool equal(const std::unique_ptr<FloatingObject>& a, const FloatingObject& b) { return &a->renderer() == &b.renderer(); }
112 };
113
114 typedef ListHashSet<std::unique_ptr<FloatingObject>, FloatingObjectHashFunctions> FloatingObjectSet;
115
116 typedef PODInterval<LayoutUnit, FloatingObject*> FloatingObjectInterval;
117 typedef PODIntervalTree<LayoutUnit, FloatingObject*> FloatingObjectTree;
118
119 // FIXME: This is really the same thing as FloatingObjectSet.
120 // Change clients to use that set directly, and replace the moveAllToFloatInfoMap function with a takeSet function.
121 typedef HashMap<RenderBox*, std::unique_ptr<FloatingObject>> RendererToFloatInfoMap;
122
123 class FloatingObjects {
124     WTF_MAKE_NONCOPYABLE(FloatingObjects); WTF_MAKE_FAST_ALLOCATED;
125 public:
126     explicit FloatingObjects(const RenderBlockFlow&);
127     ~FloatingObjects();
128
129     void clear();
130     void moveAllToFloatInfoMap(RendererToFloatInfoMap&);
131     FloatingObject* add(std::unique_ptr<FloatingObject>);
132     void remove(FloatingObject*);
133     void addPlacedObject(FloatingObject*);
134     void removePlacedObject(FloatingObject*);
135     void setHorizontalWritingMode(bool b = true) { m_horizontalWritingMode = b; }
136
137     bool hasLeftObjects() const { return m_leftObjectsCount > 0; }
138     bool hasRightObjects() const { return m_rightObjectsCount > 0; }
139     const FloatingObjectSet& set() const { return m_set; }
140     void clearLineBoxTreePointers();
141
142     LayoutUnit logicalLeftOffset(LayoutUnit fixedOffset, LayoutUnit logicalTop, LayoutUnit logicalHeight);
143     LayoutUnit logicalRightOffset(LayoutUnit fixedOffset, LayoutUnit logicalTop, LayoutUnit logicalHeight);
144
145     LayoutUnit logicalLeftOffsetForPositioningFloat(LayoutUnit fixedOffset, LayoutUnit logicalTop, LayoutUnit* heightRemaining);
146     LayoutUnit logicalRightOffsetForPositioningFloat(LayoutUnit fixedOffset, LayoutUnit logicalTop, LayoutUnit* heightRemaining);
147
148     LayoutUnit findNextFloatLogicalBottomBelow(LayoutUnit logicalHeight);
149     LayoutUnit findNextFloatLogicalBottomBelowForBlock(LayoutUnit logicalHeight);
150
151 private:
152     void computePlacedFloatsTree();
153     const FloatingObjectTree* placedFloatsTree();
154     void increaseObjectsCount(FloatingObject::Type);
155     void decreaseObjectsCount(FloatingObject::Type);
156     FloatingObjectInterval intervalForFloatingObject(FloatingObject*);
157
158     FloatingObjectSet m_set;
159     std::unique_ptr<FloatingObjectTree> m_placedFloatsTree;
160     unsigned m_leftObjectsCount;
161     unsigned m_rightObjectsCount;
162     bool m_horizontalWritingMode;
163     const RenderBlockFlow& m_renderer;
164 };
165
166 #ifndef NDEBUG
167 // This helper is used by PODIntervalTree for debugging purposes.
168 template<> struct ValueToString<FloatingObject*> {
169     static String string(const FloatingObject* floatingObject)
170     {
171         return String::format("%p (%ix%i %ix%i)", floatingObject, floatingObject->frameRect().x().toInt(), floatingObject->frameRect().y().toInt(), floatingObject->frameRect().maxX().toInt(), floatingObject->frameRect().maxY().toInt());
172     }
173 };
174 #endif
175
176 } // namespace WebCore
177
178 #endif // FloatingObjects_h