Kill InlineFlowBox::rendererLineBoxes().
[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         , m_isFirstAfterPageBreak(false)
56 #ifndef NDEBUG
57         , m_hasBadChildList(false)
58 #endif
59     {
60         // 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
61         // 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
62         // an invisible marker exists.  The side effect of having an invisible marker is that the quirks mode behavior of shrinking lines with no
63         // text children must not apply.  This change also means that gaps will exist between image bullet list items.  Even when the list bullet
64         // is an image, the line is still considered to be immune from the quirk.
65         m_hasTextChildren = renderer.style().display() == LIST_ITEM;
66         m_hasTextDescendants = m_hasTextChildren;
67     }
68
69 #ifndef NDEBUG
70     virtual ~InlineFlowBox();
71     
72     virtual void showLineTreeAndMark(const InlineBox* = 0, const char* = 0, const InlineBox* = 0, const char* = 0, const RenderObject* = 0, int = 0) const OVERRIDE;
73     virtual const char* boxName() const OVERRIDE;
74 #endif
75
76     RenderBoxModelObject& renderer() const { return toRenderBoxModelObject(InlineBox::renderer()); }
77     const RenderStyle& lineStyle() const { return isFirstLine() ? renderer().firstLineStyle() : renderer().style(); }
78
79     InlineFlowBox* prevLineBox() const { return m_prevLineBox; }
80     InlineFlowBox* nextLineBox() const { return m_nextLineBox; }
81     void setNextLineBox(InlineFlowBox* n) { m_nextLineBox = n; }
82     void setPreviousLineBox(InlineFlowBox* p) { m_prevLineBox = p; }
83
84     InlineBox* firstChild() const { checkConsistency(); return m_firstChild; }
85     InlineBox* lastChild() const { checkConsistency(); return m_lastChild; }
86
87     virtual bool isLeaf() const OVERRIDE FINAL { return false; }
88     
89     InlineBox* firstLeafChild() const;
90     InlineBox* lastLeafChild() const;
91
92     typedef void (*CustomInlineBoxRangeReverse)(void* userData, Vector<InlineBox*>::iterator first, Vector<InlineBox*>::iterator last);
93     void collectLeafBoxesInLogicalOrder(Vector<InlineBox*>&, CustomInlineBoxRangeReverse customReverseImplementation = 0, void* userData = 0) const;
94
95     virtual void setConstructed() OVERRIDE FINAL
96     {
97         InlineBox::setConstructed();
98         for (InlineBox* child = firstChild(); child; child = child->nextOnLine())
99             child->setConstructed();
100     }
101
102     void addToLine(InlineBox* child);
103     virtual void deleteLine() OVERRIDE FINAL;
104     virtual void extractLine() OVERRIDE FINAL;
105     virtual void attachLine() OVERRIDE FINAL;
106     virtual void adjustPosition(float dx, float dy) OVERRIDE;
107
108     virtual void extractLineBoxFromRenderObject();
109     virtual void attachLineBoxToRenderObject();
110     virtual void removeLineBoxFromRenderObject();
111
112     virtual void clearTruncation() OVERRIDE;
113
114     IntRect roundedFrameRect() const;
115     
116     void paintBoxDecorations(PaintInfo&, const LayoutPoint&);
117     void paintMask(PaintInfo&, const LayoutPoint&);
118     void paintFillLayers(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
119     void paintFillLayer(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
120     void paintBoxShadow(const PaintInfo&, const RenderStyle&, ShadowStyle, const LayoutRect&);
121     virtual void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE;
122     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE;
123
124     bool boxShadowCanBeAppliedToBackground(const FillLayer&) const;
125
126     // logicalLeft = left in a horizontal line and top in a vertical line.
127     LayoutUnit marginBorderPaddingLogicalLeft() const { return marginLogicalLeft() + borderLogicalLeft() + paddingLogicalLeft(); }
128     LayoutUnit marginBorderPaddingLogicalRight() const { return marginLogicalRight() + borderLogicalRight() + paddingLogicalRight(); }
129     LayoutUnit marginLogicalLeft() const
130     {
131         if (!includeLogicalLeftEdge())
132             return 0;
133         return isHorizontal() ? renderer().marginLeft() : renderer().marginTop();
134     }
135     LayoutUnit marginLogicalRight() const
136     {
137         if (!includeLogicalRightEdge())
138             return 0;
139         return isHorizontal() ? renderer().marginRight() : renderer().marginBottom();
140     }
141     int borderLogicalLeft() const
142     {
143         if (!includeLogicalLeftEdge())
144             return 0;
145         return isHorizontal() ? lineStyle().borderLeftWidth() : lineStyle().borderTopWidth();
146     }
147     int borderLogicalRight() const
148     {
149         if (!includeLogicalRightEdge())
150             return 0;
151         return isHorizontal() ? lineStyle().borderRightWidth() : lineStyle().borderBottomWidth();
152     }
153     int paddingLogicalLeft() const
154     {
155         if (!includeLogicalLeftEdge())
156             return 0;
157         return isHorizontal() ? renderer().paddingLeft() : renderer().paddingTop();
158     }
159     int paddingLogicalRight() const
160     {
161         if (!includeLogicalRightEdge())
162             return 0;
163         return isHorizontal() ? renderer().paddingRight() : renderer().paddingBottom();
164     }
165
166     bool includeLogicalLeftEdge() const { return m_includeLogicalLeftEdge; }
167     bool includeLogicalRightEdge() const { return m_includeLogicalRightEdge; }
168     void setEdges(bool includeLeft, bool includeRight)
169     {
170         m_includeLogicalLeftEdge = includeLeft;
171         m_includeLogicalRightEdge = includeRight;
172     }
173
174     // Helper functions used during line construction and placement.
175     void determineSpacingForFlowBoxes(bool lastLine, bool isLogicallyLastRunWrapped, RenderObject* logicallyLastRunRenderer);
176     LayoutUnit getFlowSpacingLogicalWidth();
177     float placeBoxesInInlineDirection(float logicalLeft, bool& needsWordSpacing, GlyphOverflowAndFallbackFontsMap&);
178     float placeBoxRangeInInlineDirection(InlineBox* firstChild, InlineBox* lastChild, float& logicalLeft, float& minLogicalLeft, float& maxLogicalRight, bool& needsWordSpacing, GlyphOverflowAndFallbackFontsMap&);
179     void beginPlacingBoxRangesInInlineDirection(float logicalLeft) { setLogicalLeft(logicalLeft); }
180     void endPlacingBoxRangesInInlineDirection(float logicalLeft, float logicalRight, float minLogicalLeft, float maxLogicalRight)
181     {
182         setLogicalWidth(logicalRight - logicalLeft);
183         if (knownToHaveNoOverflow() && (minLogicalLeft < logicalLeft || maxLogicalRight > logicalRight))
184             clearKnownToHaveNoOverflow();
185     }
186
187     void computeLogicalBoxHeights(RootInlineBox*, LayoutUnit& maxPositionTop, LayoutUnit& maxPositionBottom,
188                                   int& maxAscent, int& maxDescent, bool& setMaxAscent, bool& setMaxDescent,
189                                   bool strictMode, GlyphOverflowAndFallbackFontsMap&, FontBaseline, VerticalPositionCache&);
190     void adjustMaxAscentAndDescent(int& maxAscent, int& maxDescent,
191                                    int maxPositionTop, int maxPositionBottom);
192     void placeBoxesInBlockDirection(LayoutUnit logicalTop, LayoutUnit maxHeight, int maxAscent, bool strictMode, LayoutUnit& lineTop, LayoutUnit& lineBottom, bool& setLineTop,
193                                     LayoutUnit& lineTopIncludingMargins, LayoutUnit& lineBottomIncludingMargins, bool& hasAnnotationsBefore, bool& hasAnnotationsAfter, FontBaseline);
194     void flipLinesInBlockDirection(LayoutUnit lineTop, LayoutUnit lineBottom);
195     bool requiresIdeographicBaseline(const GlyphOverflowAndFallbackFontsMap&) const;
196
197     LayoutUnit computeOverAnnotationAdjustment(LayoutUnit allowedPosition) const;
198     LayoutUnit computeUnderAnnotationAdjustment(LayoutUnit allowedPosition) const;
199
200     void computeOverflow(LayoutUnit lineTop, LayoutUnit lineBottom, GlyphOverflowAndFallbackFontsMap&);
201     
202     void removeChild(InlineBox* child);
203
204     virtual RenderObject::SelectionState selectionState() OVERRIDE;
205
206     virtual bool canAccommodateEllipsis(bool ltr, int blockEdge, int ellipsisWidth) const OVERRIDE FINAL;
207     virtual float placeEllipsisBox(bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, float &truncatedWidth, bool&) OVERRIDE;
208
209     bool hasTextChildren() const { return m_hasTextChildren; }
210     bool hasTextDescendants() const { return m_hasTextDescendants; }
211     void setHasTextChildren() { m_hasTextChildren = true; setHasTextDescendants(); }
212     void setHasTextDescendants() { m_hasTextDescendants = true; }
213     
214     void checkConsistency() const;
215     void setHasBadChildList();
216
217     // Line visual and layout overflow are in the coordinate space of the block.  This means that they aren't purely physical directions.
218     // For horizontal-tb and vertical-lr they will match physical directions, but for horizontal-bt and vertical-rl, the top/bottom and left/right
219     // 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.
220     LayoutRect layoutOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
221     { 
222         return m_overflow ? m_overflow->layoutOverflowRect() : enclosingLayoutRect(frameRectIncludingLineHeight(lineTop, lineBottom));
223     }
224     LayoutUnit logicalTopLayoutOverflow(LayoutUnit lineTop) const
225     {
226         if (m_overflow)
227             return isHorizontal() ? m_overflow->layoutOverflowRect().y() : m_overflow->layoutOverflowRect().x();
228         return lineTop;
229     }
230     LayoutUnit logicalBottomLayoutOverflow(LayoutUnit lineBottom) const
231     {
232         if (m_overflow)
233             return isHorizontal() ? m_overflow->layoutOverflowRect().maxY() : m_overflow->layoutOverflowRect().maxX();
234         return lineBottom;
235     }
236     LayoutRect logicalLayoutOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
237     {
238         LayoutRect result = layoutOverflowRect(lineTop, lineBottom);
239         if (!renderer().isHorizontalWritingMode())
240             result = result.transposedRect();
241         return result;
242     }
243
244     LayoutRect visualOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
245     { 
246         return m_overflow ? m_overflow->visualOverflowRect() : enclosingLayoutRect(frameRectIncludingLineHeight(lineTop, lineBottom));
247     }
248     LayoutUnit logicalLeftVisualOverflow() const { return m_overflow ? (isHorizontal() ? m_overflow->visualOverflowRect().x() : m_overflow->visualOverflowRect().y()) : static_cast<LayoutUnit>(logicalLeft()); }
249     LayoutUnit logicalRightVisualOverflow() const { return m_overflow ? (isHorizontal() ? m_overflow->visualOverflowRect().maxX() : m_overflow->visualOverflowRect().maxY()) : static_cast<LayoutUnit>(ceilf(logicalRight())); }
250     LayoutUnit logicalTopVisualOverflow(LayoutUnit lineTop) const
251     {
252         if (m_overflow)
253             return isHorizontal() ? m_overflow->visualOverflowRect().y() : m_overflow->visualOverflowRect().x();
254         return lineTop;
255     }
256     LayoutUnit logicalBottomVisualOverflow(LayoutUnit lineBottom) const
257     {
258         if (m_overflow)
259             return isHorizontal() ? m_overflow->visualOverflowRect().maxY() : m_overflow->visualOverflowRect().maxX();
260         return lineBottom;
261     }
262     LayoutRect logicalVisualOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
263     {
264         LayoutRect result = visualOverflowRect(lineTop, lineBottom);
265         if (!renderer().isHorizontalWritingMode())
266             result = result.transposedRect();
267         return result;
268     }
269
270     void setOverflowFromLogicalRects(const LayoutRect& logicalLayoutOverflow, const LayoutRect& logicalVisualOverflow, LayoutUnit lineTop, LayoutUnit lineBottom);
271     void setLayoutOverflow(const LayoutRect&, LayoutUnit lineTop, LayoutUnit lineBottom);
272     void setVisualOverflow(const LayoutRect&, LayoutUnit lineTop, LayoutUnit lineBottom);
273
274     FloatRect frameRectIncludingLineHeight(LayoutUnit lineTop, LayoutUnit lineBottom) const
275     {
276         if (isHorizontal())
277             return FloatRect(m_topLeft.x(), lineTop, width(), lineBottom - lineTop);
278         return FloatRect(lineTop, m_topLeft.y(), lineBottom - lineTop, height());
279     }
280     
281     FloatRect logicalFrameRectIncludingLineHeight(LayoutUnit lineTop, LayoutUnit lineBottom) const
282     {
283         return FloatRect(logicalLeft(), lineTop, logicalWidth(), lineBottom - lineTop);
284     }
285     
286     bool descendantsHaveSameLineHeightAndBaseline() const { return m_descendantsHaveSameLineHeightAndBaseline; }
287     void clearDescendantsHaveSameLineHeightAndBaseline()
288     { 
289         m_descendantsHaveSameLineHeightAndBaseline = false;
290         if (parent() && parent()->descendantsHaveSameLineHeightAndBaseline())
291             parent()->clearDescendantsHaveSameLineHeightAndBaseline();
292     }
293
294 private:
295     virtual bool isInlineFlowBox() const OVERRIDE FINAL { return true; }
296     void boxModelObject() const WTF_DELETED_FUNCTION;
297
298     void addBoxShadowVisualOverflow(LayoutRect& logicalVisualOverflow);
299     void addBorderOutsetVisualOverflow(LayoutRect& logicalVisualOverflow);
300     void addTextBoxVisualOverflow(InlineTextBox*, GlyphOverflowAndFallbackFontsMap&, LayoutRect& logicalVisualOverflow);
301     void addReplacedChildOverflow(const InlineBox*, LayoutRect& logicalLayoutOverflow, LayoutRect& logicalVisualOverflow);
302     void constrainToLineTopAndBottomIfNeeded(LayoutRect&) const;
303
304 protected:
305     OwnPtr<RenderOverflow> m_overflow;
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_DECORATION)
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
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     unsigned m_isFirstAfterPageBreak : 1;
340
341     // End of RootInlineBox-specific members.
342
343 #ifndef NDEBUG
344 private:
345     unsigned m_hasBadChildList : 1;
346 #endif
347 };
348
349 INLINE_BOX_OBJECT_TYPE_CASTS(InlineFlowBox, isInlineFlowBox())
350
351 #ifdef NDEBUG
352 inline void InlineFlowBox::checkConsistency() const
353 {
354 }
355 #endif
356
357 inline void InlineFlowBox::setHasBadChildList()
358 {
359 #ifndef NDEBUG
360     m_hasBadChildList = true;
361 #endif
362 }
363
364 } // namespace WebCore
365
366 #ifndef NDEBUG
367 // Outside the WebCore namespace for ease of invocation from gdb.
368 void showTree(const WebCore::InlineFlowBox*);
369 #endif
370
371 #endif // InlineFlowBox_h