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