Remove spaces between template angle brackets
[WebKit-https.git] / Source / WebCore / rendering / InlineFlowBox.h
1 /*
2  * Copyright (C) 2003, 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef InlineFlowBox_h
22 #define InlineFlowBox_h
23
24 #include "InlineBox.h"
25 #include "RenderOverflow.h"
26 #include "ShadowData.h"
27
28 namespace WebCore {
29
30 class HitTestRequest;
31 class HitTestResult;
32 class InlineTextBox;
33 class RenderLineBoxList;
34 class SimpleFontData;
35 class VerticalPositionCache;
36
37 struct GlyphOverflow;
38
39 typedef HashMap<const InlineTextBox*, pair<Vector<const SimpleFontData*>, GlyphOverflow>> GlyphOverflowAndFallbackFontsMap;
40
41 class InlineFlowBox : public InlineBox {
42 public:
43     explicit InlineFlowBox(RenderBoxModelObject& renderer)
44         : InlineBox(renderer)
45         , m_firstChild(0)
46         , m_lastChild(0)
47         , m_prevLineBox(0)
48         , m_nextLineBox(0)
49         , m_includeLogicalLeftEdge(false)
50         , m_includeLogicalRightEdge(false)
51         , m_descendantsHaveSameLineHeightAndBaseline(true)
52         , m_baselineType(AlphabeticBaseline)
53         , m_hasAnnotationsBefore(false)
54         , m_hasAnnotationsAfter(false)
55 #ifndef NDEBUG
56         , m_hasBadChildList(false)
57 #endif
58     {
59         // Internet Explorer and Firefox always create a marker for list items, even when the list-style-type is none.  We do not make a marker
60         // in the list-style-type: none case, since it is wasteful to do so.  However, in order to match other browsers we have to pretend like
61         // an invisible marker exists.  The side effect of having an invisible marker is that the quirks mode behavior of shrinking lines with no
62         // text children must not apply.  This change also means that gaps will exist between image bullet list items.  Even when the list bullet
63         // is an image, the line is still considered to be immune from the quirk.
64         m_hasTextChildren = renderer.style()->display() == LIST_ITEM;
65         m_hasTextDescendants = m_hasTextChildren;
66     }
67
68 #ifndef NDEBUG
69     virtual ~InlineFlowBox();
70     
71     virtual void showLineTreeAndMark(const InlineBox* = 0, const char* = 0, const InlineBox* = 0, const char* = 0, const RenderObject* = 0, int = 0) const OVERRIDE;
72     virtual const char* boxName() const OVERRIDE;
73 #endif
74
75     RenderBoxModelObject& renderer() const { return toRenderBoxModelObject(InlineBox::renderer()); }
76     const RenderStyle& lineStyle() const { return isFirstLine() ? *renderer().firstLineStyle() : *renderer().style(); }
77
78     InlineFlowBox* prevLineBox() const { return m_prevLineBox; }
79     InlineFlowBox* nextLineBox() const { return m_nextLineBox; }
80     void setNextLineBox(InlineFlowBox* n) { m_nextLineBox = n; }
81     void setPreviousLineBox(InlineFlowBox* p) { m_prevLineBox = p; }
82
83     InlineBox* firstChild() const { checkConsistency(); return m_firstChild; }
84     InlineBox* lastChild() const { checkConsistency(); return m_lastChild; }
85
86     virtual bool isLeaf() const OVERRIDE FINAL { return false; }
87     
88     InlineBox* firstLeafChild() const;
89     InlineBox* lastLeafChild() const;
90
91     typedef void (*CustomInlineBoxRangeReverse)(void* userData, Vector<InlineBox*>::iterator first, Vector<InlineBox*>::iterator last);
92     void collectLeafBoxesInLogicalOrder(Vector<InlineBox*>&, CustomInlineBoxRangeReverse customReverseImplementation = 0, void* userData = 0) const;
93
94     virtual void setConstructed() OVERRIDE FINAL
95     {
96         InlineBox::setConstructed();
97         for (InlineBox* child = firstChild(); child; child = child->nextOnLine())
98             child->setConstructed();
99     }
100
101     void addToLine(InlineBox* child);
102     virtual void deleteLine(RenderArena&) OVERRIDE FINAL;
103     virtual void extractLine() OVERRIDE FINAL;
104     virtual void attachLine() OVERRIDE FINAL;
105     virtual void adjustPosition(float dx, float dy) OVERRIDE;
106
107     virtual void extractLineBoxFromRenderObject();
108     virtual void attachLineBoxToRenderObject();
109     virtual void removeLineBoxFromRenderObject();
110
111     virtual void clearTruncation() OVERRIDE;
112
113     IntRect roundedFrameRect() const;
114     
115     void paintBoxDecorations(PaintInfo&, const LayoutPoint&);
116     void paintMask(PaintInfo&, const LayoutPoint&);
117     void paintFillLayers(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
118     void paintFillLayer(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
119     void paintBoxShadow(const PaintInfo&, const RenderStyle&, ShadowStyle, const LayoutRect&);
120     virtual void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE;
121     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE;
122
123     bool boxShadowCanBeAppliedToBackground(const FillLayer&) const;
124
125     virtual RenderLineBoxList& rendererLineBoxes() const;
126
127     // logicalLeft = left in a horizontal line and top in a vertical line.
128     LayoutUnit marginBorderPaddingLogicalLeft() const { return marginLogicalLeft() + borderLogicalLeft() + paddingLogicalLeft(); }
129     LayoutUnit marginBorderPaddingLogicalRight() const { return marginLogicalRight() + borderLogicalRight() + paddingLogicalRight(); }
130     LayoutUnit marginLogicalLeft() const
131     {
132         if (!includeLogicalLeftEdge())
133             return 0;
134         return isHorizontal() ? boxModelObject()->marginLeft() : boxModelObject()->marginTop();
135     }
136     LayoutUnit marginLogicalRight() const
137     {
138         if (!includeLogicalRightEdge())
139             return 0;
140         return isHorizontal() ? boxModelObject()->marginRight() : boxModelObject()->marginBottom();
141     }
142     int borderLogicalLeft() const
143     {
144         if (!includeLogicalLeftEdge())
145             return 0;
146         return isHorizontal() ? lineStyle().borderLeftWidth() : lineStyle().borderTopWidth();
147     }
148     int borderLogicalRight() const
149     {
150         if (!includeLogicalRightEdge())
151             return 0;
152         return isHorizontal() ? lineStyle().borderRightWidth() : lineStyle().borderBottomWidth();
153     }
154     int paddingLogicalLeft() const
155     {
156         if (!includeLogicalLeftEdge())
157             return 0;
158         return isHorizontal() ? boxModelObject()->paddingLeft() : boxModelObject()->paddingTop();
159     }
160     int paddingLogicalRight() const
161     {
162         if (!includeLogicalRightEdge())
163             return 0;
164         return isHorizontal() ? boxModelObject()->paddingRight() : boxModelObject()->paddingBottom();
165     }
166
167     bool includeLogicalLeftEdge() const { return m_includeLogicalLeftEdge; }
168     bool includeLogicalRightEdge() const { return m_includeLogicalRightEdge; }
169     void setEdges(bool includeLeft, bool includeRight)
170     {
171         m_includeLogicalLeftEdge = includeLeft;
172         m_includeLogicalRightEdge = includeRight;
173     }
174
175     // Helper functions used during line construction and placement.
176     void determineSpacingForFlowBoxes(bool lastLine, bool isLogicallyLastRunWrapped, RenderObject* logicallyLastRunRenderer);
177     LayoutUnit getFlowSpacingLogicalWidth();
178     float placeBoxesInInlineDirection(float logicalLeft, bool& needsWordSpacing, GlyphOverflowAndFallbackFontsMap&);
179     float placeBoxRangeInInlineDirection(InlineBox* firstChild, InlineBox* lastChild, float& logicalLeft, float& minLogicalLeft, float& maxLogicalRight, bool& needsWordSpacing, GlyphOverflowAndFallbackFontsMap&);
180     void beginPlacingBoxRangesInInlineDirection(float logicalLeft) { setLogicalLeft(logicalLeft); }
181     void endPlacingBoxRangesInInlineDirection(float logicalLeft, float logicalRight, float minLogicalLeft, float maxLogicalRight)
182     {
183         setLogicalWidth(logicalRight - logicalLeft);
184         if (knownToHaveNoOverflow() && (minLogicalLeft < logicalLeft || maxLogicalRight > logicalRight))
185             clearKnownToHaveNoOverflow();
186     }
187
188     void computeLogicalBoxHeights(RootInlineBox*, LayoutUnit& maxPositionTop, LayoutUnit& maxPositionBottom,
189                                   int& maxAscent, int& maxDescent, bool& setMaxAscent, bool& setMaxDescent,
190                                   bool strictMode, GlyphOverflowAndFallbackFontsMap&, FontBaseline, VerticalPositionCache&);
191     void adjustMaxAscentAndDescent(int& maxAscent, int& maxDescent,
192                                    int maxPositionTop, int maxPositionBottom);
193     void placeBoxesInBlockDirection(LayoutUnit logicalTop, LayoutUnit maxHeight, int maxAscent, bool strictMode, LayoutUnit& lineTop, LayoutUnit& lineBottom, bool& setLineTop,
194                                     LayoutUnit& lineTopIncludingMargins, LayoutUnit& lineBottomIncludingMargins, bool& hasAnnotationsBefore, bool& hasAnnotationsAfter, FontBaseline);
195     void flipLinesInBlockDirection(LayoutUnit lineTop, LayoutUnit lineBottom);
196     bool requiresIdeographicBaseline(const GlyphOverflowAndFallbackFontsMap&) const;
197
198     LayoutUnit computeOverAnnotationAdjustment(LayoutUnit allowedPosition) const;
199     LayoutUnit computeUnderAnnotationAdjustment(LayoutUnit allowedPosition) const;
200
201     void computeOverflow(LayoutUnit lineTop, LayoutUnit lineBottom, GlyphOverflowAndFallbackFontsMap&);
202     
203     void removeChild(InlineBox* child);
204
205     virtual RenderObject::SelectionState selectionState() OVERRIDE;
206
207     virtual bool canAccommodateEllipsis(bool ltr, int blockEdge, int ellipsisWidth) const OVERRIDE FINAL;
208     virtual float placeEllipsisBox(bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, float &truncatedWidth, bool&) OVERRIDE;
209
210     bool hasTextChildren() const { return m_hasTextChildren; }
211     bool hasTextDescendants() const { return m_hasTextDescendants; }
212     void setHasTextChildren() { m_hasTextChildren = true; setHasTextDescendants(); }
213     void setHasTextDescendants() { m_hasTextDescendants = true; }
214     
215     void checkConsistency() const;
216     void setHasBadChildList();
217
218     // Line visual and layout overflow are in the coordinate space of the block.  This means that they aren't purely physical directions.
219     // For horizontal-tb and vertical-lr they will match physical directions, but for horizontal-bt and vertical-rl, the top/bottom and left/right
220     // respectively are flipped when compared to their physical counterparts.  For example minX is on the left in vertical-lr, but it is on the right in vertical-rl.
221     LayoutRect layoutOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
222     { 
223         return m_overflow ? m_overflow->layoutOverflowRect() : enclosingLayoutRect(frameRectIncludingLineHeight(lineTop, lineBottom));
224     }
225     LayoutUnit logicalTopLayoutOverflow(LayoutUnit lineTop) const
226     {
227         if (m_overflow)
228             return isHorizontal() ? m_overflow->layoutOverflowRect().y() : m_overflow->layoutOverflowRect().x();
229         return lineTop;
230     }
231     LayoutUnit logicalBottomLayoutOverflow(LayoutUnit lineBottom) const
232     {
233         if (m_overflow)
234             return isHorizontal() ? m_overflow->layoutOverflowRect().maxY() : m_overflow->layoutOverflowRect().maxX();
235         return lineBottom;
236     }
237     LayoutRect logicalLayoutOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
238     {
239         LayoutRect result = layoutOverflowRect(lineTop, lineBottom);
240         if (!renderer().isHorizontalWritingMode())
241             result = result.transposedRect();
242         return result;
243     }
244
245     LayoutRect visualOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
246     { 
247         return m_overflow ? m_overflow->visualOverflowRect() : enclosingLayoutRect(frameRectIncludingLineHeight(lineTop, lineBottom));
248     }
249     LayoutUnit logicalLeftVisualOverflow() const { return m_overflow ? (isHorizontal() ? m_overflow->visualOverflowRect().x() : m_overflow->visualOverflowRect().y()) : static_cast<LayoutUnit>(logicalLeft()); }
250     LayoutUnit logicalRightVisualOverflow() const { return m_overflow ? (isHorizontal() ? m_overflow->visualOverflowRect().maxX() : m_overflow->visualOverflowRect().maxY()) : static_cast<LayoutUnit>(ceilf(logicalRight())); }
251     LayoutUnit logicalTopVisualOverflow(LayoutUnit lineTop) const
252     {
253         if (m_overflow)
254             return isHorizontal() ? m_overflow->visualOverflowRect().y() : m_overflow->visualOverflowRect().x();
255         return lineTop;
256     }
257     LayoutUnit logicalBottomVisualOverflow(LayoutUnit lineBottom) const
258     {
259         if (m_overflow)
260             return isHorizontal() ? m_overflow->visualOverflowRect().maxY() : m_overflow->visualOverflowRect().maxX();
261         return lineBottom;
262     }
263     LayoutRect logicalVisualOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
264     {
265         LayoutRect result = visualOverflowRect(lineTop, lineBottom);
266         if (!renderer().isHorizontalWritingMode())
267             result = result.transposedRect();
268         return result;
269     }
270
271     void setOverflowFromLogicalRects(const LayoutRect& logicalLayoutOverflow, const LayoutRect& logicalVisualOverflow, LayoutUnit lineTop, LayoutUnit lineBottom);
272     void setLayoutOverflow(const LayoutRect&, LayoutUnit lineTop, LayoutUnit lineBottom);
273     void setVisualOverflow(const LayoutRect&, LayoutUnit lineTop, LayoutUnit lineBottom);
274
275     FloatRect frameRectIncludingLineHeight(LayoutUnit lineTop, LayoutUnit lineBottom) const
276     {
277         if (isHorizontal())
278             return FloatRect(m_topLeft.x(), lineTop, width(), lineBottom - lineTop);
279         return FloatRect(lineTop, m_topLeft.y(), lineBottom - lineTop, height());
280     }
281     
282     FloatRect logicalFrameRectIncludingLineHeight(LayoutUnit lineTop, LayoutUnit lineBottom) const
283     {
284         return FloatRect(logicalLeft(), lineTop, logicalWidth(), lineBottom - lineTop);
285     }
286     
287     bool descendantsHaveSameLineHeightAndBaseline() const { return m_descendantsHaveSameLineHeightAndBaseline; }
288     void clearDescendantsHaveSameLineHeightAndBaseline()
289     { 
290         m_descendantsHaveSameLineHeightAndBaseline = false;
291         if (parent() && parent()->descendantsHaveSameLineHeightAndBaseline())
292             parent()->clearDescendantsHaveSameLineHeightAndBaseline();
293     }
294
295 private:
296     void addBoxShadowVisualOverflow(LayoutRect& logicalVisualOverflow);
297     void addBorderOutsetVisualOverflow(LayoutRect& logicalVisualOverflow);
298     void addTextBoxVisualOverflow(InlineTextBox*, GlyphOverflowAndFallbackFontsMap&, LayoutRect& logicalVisualOverflow);
299     void addReplacedChildOverflow(const InlineBox*, LayoutRect& logicalLayoutOverflow, LayoutRect& logicalVisualOverflow);
300     void constrainToLineTopAndBottomIfNeeded(LayoutRect&) const;
301
302 protected:
303     OwnPtr<RenderOverflow> m_overflow;
304
305     virtual bool isInlineFlowBox() const OVERRIDE FINAL { return true; }
306
307     InlineBox* m_firstChild;
308     InlineBox* m_lastChild;
309     
310     InlineFlowBox* m_prevLineBox; // The previous box that also uses our RenderObject
311     InlineFlowBox* m_nextLineBox; // The next box that also uses our RenderObject
312
313 #if ENABLE(CSS3_TEXT)
314     // Maximum logicalTop among all children of an InlineFlowBox. Used to
315     // calculate the offset for TextUnderlinePositionUnder.
316     void computeMaxLogicalTop(float& maxLogicalTop) const;
317 #endif // CSS3_TEXT
318 private:
319     unsigned m_includeLogicalLeftEdge : 1;
320     unsigned m_includeLogicalRightEdge : 1;
321     unsigned m_hasTextChildren : 1;
322     unsigned m_hasTextDescendants : 1;
323     unsigned m_descendantsHaveSameLineHeightAndBaseline : 1;
324
325 protected:
326     // The following members are only used by RootInlineBox but moved here to keep the bits packed.
327
328     // Whether or not this line uses alphabetic or ideographic baselines by default.
329     unsigned m_baselineType : 1; // FontBaseline
330
331     // If the line contains any ruby runs, then this will be true.
332     unsigned m_hasAnnotationsBefore : 1;
333     unsigned m_hasAnnotationsAfter : 1;
334
335     unsigned m_lineBreakBidiStatusEor : 5; // UCharDirection
336     unsigned m_lineBreakBidiStatusLastStrong : 5; // UCharDirection
337     unsigned m_lineBreakBidiStatusLast : 5; // UCharDirection
338
339     // End of RootInlineBox-specific members.
340
341 #ifndef NDEBUG
342 private:
343     unsigned m_hasBadChildList : 1;
344 #endif
345 };
346
347 inline InlineFlowBox* toInlineFlowBox(InlineBox* object)
348 {
349     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isInlineFlowBox());
350     return static_cast<InlineFlowBox*>(object);
351 }
352
353 inline const InlineFlowBox* toInlineFlowBox(const InlineBox* object)
354 {
355     ASSERT_WITH_SECURITY_IMPLICATION(!object || object->isInlineFlowBox());
356     return static_cast<const InlineFlowBox*>(object);
357 }
358
359 // This will catch anyone doing an unnecessary cast.
360 void toInlineFlowBox(const InlineFlowBox*);
361
362 #ifdef NDEBUG
363 inline void InlineFlowBox::checkConsistency() const
364 {
365 }
366 #endif
367
368 inline void InlineFlowBox::setHasBadChildList()
369 {
370 #ifndef NDEBUG
371     m_hasBadChildList = true;
372 #endif
373 }
374
375 } // namespace WebCore
376
377 #ifndef NDEBUG
378 // Outside the WebCore namespace for ease of invocation from gdb.
379 void showTree(const WebCore::InlineFlowBox*);
380 #endif
381
382 #endif // InlineFlowBox_h