Refactor logical left/right offset for line methods
[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 // FIXME this should be removed once RenderBlockFlow::nextFloatLogicalBottomBelow doesn't need it anymore. (Bug 123931)
37 enum ShapeOutsideFloatOffsetMode { ShapeOutsideFloatShapeOffset, ShapeOutsideFloatMarginBoxOffset };
38
39 class FloatingObject {
40     WTF_MAKE_NONCOPYABLE(FloatingObject); WTF_MAKE_FAST_ALLOCATED;
41 public:
42     // Note that Type uses bits so you can use FloatLeftRight as a mask to query for both left and right.
43     enum Type { FloatLeft = 1, FloatRight = 2, FloatLeftRight = 3 };
44
45     static std::unique_ptr<FloatingObject> create(RenderBox&);
46     std::unique_ptr<FloatingObject> copyToNewContainer(LayoutSize, bool shouldPaint = false, bool isDescendant = false) const;
47     std::unique_ptr<FloatingObject> unsafeClone() const;
48
49     explicit FloatingObject(RenderBox&);
50     FloatingObject(RenderBox&, Type, const LayoutRect&, bool shouldPaint, bool isDescendant);
51
52     Type type() const { return static_cast<Type>(m_type); }
53     RenderBox& renderer() const { return m_renderer; }
54
55     bool isPlaced() const { return m_isPlaced; }
56     void setIsPlaced(bool placed = true) { m_isPlaced = placed; }
57
58     LayoutUnit x() const { ASSERT(isPlaced()); return m_frameRect.x(); }
59     LayoutUnit maxX() const { ASSERT(isPlaced()); return m_frameRect.maxX(); }
60     LayoutUnit y() const { ASSERT(isPlaced()); return m_frameRect.y(); }
61     LayoutUnit maxY() const { ASSERT(isPlaced()); return m_frameRect.maxY(); }
62     LayoutUnit width() const { return m_frameRect.width(); }
63     LayoutUnit height() const { return m_frameRect.height(); }
64
65     void setX(LayoutUnit x) { ASSERT(!isInPlacedTree()); m_frameRect.setX(x); }
66     void setY(LayoutUnit y) { ASSERT(!isInPlacedTree()); m_frameRect.setY(y); }
67     void setWidth(LayoutUnit width) { ASSERT(!isInPlacedTree()); m_frameRect.setWidth(width); }
68     void setHeight(LayoutUnit height) { ASSERT(!isInPlacedTree()); m_frameRect.setHeight(height); }
69
70     const LayoutRect& frameRect() const { ASSERT(isPlaced()); return m_frameRect; }
71     void setFrameRect(const LayoutRect& frameRect) { ASSERT(!isInPlacedTree()); m_frameRect = frameRect; }
72
73     int paginationStrut() const { return m_paginationStrut; }
74     void setPaginationStrut(int strut) { m_paginationStrut = strut; }
75
76 #ifndef NDEBUG
77     bool isInPlacedTree() const { return m_isInPlacedTree; }
78     void setIsInPlacedTree(bool value) { m_isInPlacedTree = value; }
79 #endif
80
81     bool shouldPaint() const { return m_shouldPaint; }
82     void setShouldPaint(bool shouldPaint) { m_shouldPaint = shouldPaint; }
83     bool isDescendant() const { return m_isDescendant; }
84     void setIsDescendant(bool isDescendant) { m_isDescendant = isDescendant; }
85
86     // FIXME: Callers of these methods are dangerous and should be whitelisted explicitly or removed.
87     RootInlineBox* originatingLine() const { return m_originatingLine; }
88     void setOriginatingLine(RootInlineBox* line) { m_originatingLine = line; }
89
90 private:
91     RenderBox& m_renderer;
92     RootInlineBox* m_originatingLine;
93     LayoutRect m_frameRect;
94     int m_paginationStrut; // FIXME: This should be a LayoutUnit, since it's a vertical offset.
95
96     unsigned m_type : 2; // Type (left or right aligned)
97     unsigned m_shouldPaint : 1;
98     unsigned m_isDescendant : 1;
99     unsigned m_isPlaced : 1;
100 #ifndef NDEBUG
101     unsigned m_isInPlacedTree : 1;
102 #endif
103 };
104
105 struct FloatingObjectHashFunctions {
106     static unsigned hash(const std::unique_ptr<FloatingObject>& key) { return PtrHash<RenderBox*>::hash(&key->renderer()); }
107     static bool equal(const std::unique_ptr<FloatingObject>& a, const std::unique_ptr<FloatingObject>& b) { return &a->renderer() == &b->renderer(); }
108     static const bool safeToCompareToEmptyOrDeleted = true;
109 };
110 struct FloatingObjectHashTranslator {
111     static unsigned hash(const RenderBox& key) { return PtrHash<const RenderBox*>::hash(&key); }
112     static unsigned hash(const FloatingObject& key) { return PtrHash<RenderBox*>::hash(&key.renderer()); }
113     static bool equal(const std::unique_ptr<FloatingObject>& a, const RenderBox& b) { return &a->renderer() == &b; }
114     static bool equal(const std::unique_ptr<FloatingObject>& a, const FloatingObject& b) { return &a->renderer() == &b.renderer(); }
115 };
116
117 typedef ListHashSet<std::unique_ptr<FloatingObject>, 4, FloatingObjectHashFunctions> FloatingObjectSet;
118
119 typedef PODInterval<int, FloatingObject*> FloatingObjectInterval;
120 typedef PODIntervalTree<int, FloatingObject*> FloatingObjectTree;
121 typedef PODFreeListArena<PODRedBlackTree<FloatingObjectInterval>::Node> IntervalArena;
122
123 // FIXME: This is really the same thing as FloatingObjectSet.
124 // Change clients to use that set directly, and replace the moveAllToFloatInfoMap function with a takeSet function.
125 typedef HashMap<RenderBox*, std::unique_ptr<FloatingObject>> RendererToFloatInfoMap;
126
127 class FloatingObjects {
128     WTF_MAKE_NONCOPYABLE(FloatingObjects); WTF_MAKE_FAST_ALLOCATED;
129 public:
130     FloatingObjects(const RenderBlockFlow*, bool horizontalWritingMode);
131     ~FloatingObjects();
132
133     void clear();
134     void moveAllToFloatInfoMap(RendererToFloatInfoMap&);
135     FloatingObject* add(std::unique_ptr<FloatingObject>);
136     void remove(FloatingObject*);
137     void addPlacedObject(FloatingObject*);
138     void removePlacedObject(FloatingObject*);
139     void setHorizontalWritingMode(bool b = true) { m_horizontalWritingMode = b; }
140
141     bool hasLeftObjects() const { return m_leftObjectsCount > 0; }
142     bool hasRightObjects() const { return m_rightObjectsCount > 0; }
143     const FloatingObjectSet& set() const { return m_set; }
144     void clearLineBoxTreePointers();
145
146     LayoutUnit logicalLeftOffset(LayoutUnit fixedOffset, LayoutUnit logicalTop, LayoutUnit logicalHeight);
147     LayoutUnit logicalRightOffset(LayoutUnit fixedOffset, LayoutUnit logicalTop, LayoutUnit logicalHeight);
148
149     LayoutUnit logicalLeftOffsetForPositioningFloat(LayoutUnit fixedOffset, LayoutUnit logicalTop, LayoutUnit* heightRemaining);
150     LayoutUnit logicalRightOffsetForPositioningFloat(LayoutUnit fixedOffset, LayoutUnit logicalTop, LayoutUnit* heightRemaining);
151
152 private:
153     void computePlacedFloatsTree();
154     const FloatingObjectTree& placedFloatsTree();
155     void increaseObjectsCount(FloatingObject::Type);
156     void decreaseObjectsCount(FloatingObject::Type);
157     FloatingObjectInterval intervalForFloatingObject(FloatingObject*);
158
159     FloatingObjectSet m_set;
160     FloatingObjectTree m_placedFloatsTree;
161     unsigned m_leftObjectsCount;
162     unsigned m_rightObjectsCount;
163     bool m_horizontalWritingMode;
164     const RenderBlockFlow* m_renderer;
165 };
166
167 #ifndef NDEBUG
168 // These structures are used by PODIntervalTree for debugging purposes.
169 template <> struct ValueToString<int> {
170     static String string(const int value);
171 };
172 template<> struct ValueToString<FloatingObject*> {
173     static String string(const FloatingObject*);
174 };
175 #endif
176
177 } // namespace WebCore
178
179 #endif // FloatingObjects_h