Source/WebCore: Change baselinePosition and maxAscent/maxDescent to int
[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     InlineFlowBox(RenderObject* obj)
44         : InlineBox(obj)
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 = obj->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;
73     virtual const char* boxName() const;
74 #endif
75
76     InlineFlowBox* prevLineBox() const { return m_prevLineBox; }
77     InlineFlowBox* nextLineBox() const { return m_nextLineBox; }
78     void setNextLineBox(InlineFlowBox* n) { m_nextLineBox = n; }
79     void setPreviousLineBox(InlineFlowBox* p) { m_prevLineBox = p; }
80
81     InlineBox* firstChild() const { checkConsistency(); return m_firstChild; }
82     InlineBox* lastChild() const { checkConsistency(); return m_lastChild; }
83
84     virtual bool isLeaf() const { return false; }
85     
86     InlineBox* firstLeafChild() const;
87     InlineBox* lastLeafChild() const;
88
89     typedef void (*CustomInlineBoxRangeReverse)(void* userData, Vector<InlineBox*>::iterator first, Vector<InlineBox*>::iterator last);
90     void collectLeafBoxesInLogicalOrder(Vector<InlineBox*>&, CustomInlineBoxRangeReverse customReverseImplementation = 0, void* userData = 0) const;
91
92     virtual void setConstructed()
93     {
94         InlineBox::setConstructed();
95         for (InlineBox* child = firstChild(); child; child = child->nextOnLine())
96             child->setConstructed();
97     }
98
99     void addToLine(InlineBox* child);
100     virtual void deleteLine(RenderArena*);
101     virtual void extractLine();
102     virtual void attachLine();
103     virtual void adjustPosition(float dx, float dy);
104
105     virtual void extractLineBoxFromRenderObject();
106     virtual void attachLineBoxToRenderObject();
107     virtual void removeLineBoxFromRenderObject();
108
109     virtual void clearTruncation() OVERRIDE;
110
111     IntRect roundedFrameRect() const;
112     
113     virtual void paintBoxDecorations(PaintInfo&, const LayoutPoint&);
114     virtual void paintMask(PaintInfo&, const LayoutPoint&);
115     void paintFillLayers(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
116     void paintFillLayer(const PaintInfo&, const Color&, const FillLayer*, const LayoutRect&, CompositeOperator = CompositeSourceOver);
117     void paintBoxShadow(const PaintInfo&, RenderStyle*, ShadowStyle, const LayoutRect&);
118     virtual void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom);
119     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE;
120
121     bool boxShadowCanBeAppliedToBackground(const FillLayer&) const;
122
123     virtual RenderLineBoxList* rendererLineBoxes() const;
124
125     // logicalLeft = left in a horizontal line and top in a vertical line.
126     LayoutUnit marginBorderPaddingLogicalLeft() const { return marginLogicalLeft() + borderLogicalLeft() + paddingLogicalLeft(); }
127     LayoutUnit marginBorderPaddingLogicalRight() const { return marginLogicalRight() + borderLogicalRight() + paddingLogicalRight(); }
128     LayoutUnit marginLogicalLeft() const
129     {
130         if (!includeLogicalLeftEdge())
131             return 0;
132         return isHorizontal() ? boxModelObject()->marginLeft() : boxModelObject()->marginTop();
133     }
134     LayoutUnit marginLogicalRight() const
135     {
136         if (!includeLogicalRightEdge())
137             return 0;
138         return isHorizontal() ? boxModelObject()->marginRight() : boxModelObject()->marginBottom();
139     }
140     int borderLogicalLeft() const
141     {
142         if (!includeLogicalLeftEdge())
143             return 0;
144         return isHorizontal() ? renderer()->style(isFirstLineStyle())->borderLeftWidth() : renderer()->style(isFirstLineStyle())->borderTopWidth();
145     }
146     int borderLogicalRight() const
147     {
148         if (!includeLogicalRightEdge())
149             return 0;
150         return isHorizontal() ? renderer()->style(isFirstLineStyle())->borderRightWidth() : renderer()->style(isFirstLineStyle())->borderBottomWidth();
151     }
152     int paddingLogicalLeft() const
153     {
154         if (!includeLogicalLeftEdge())
155             return 0;
156         return isHorizontal() ? boxModelObject()->paddingLeft() : boxModelObject()->paddingTop();
157     }
158     int paddingLogicalRight() const
159     {
160         if (!includeLogicalRightEdge())
161             return 0;
162         return isHorizontal() ? boxModelObject()->paddingRight() : boxModelObject()->paddingBottom();
163     }
164
165     bool includeLogicalLeftEdge() const { return m_includeLogicalLeftEdge; }
166     bool includeLogicalRightEdge() const { return m_includeLogicalRightEdge; }
167     void setEdges(bool includeLeft, bool includeRight)
168     {
169         m_includeLogicalLeftEdge = includeLeft;
170         m_includeLogicalRightEdge = includeRight;
171     }
172
173     // Helper functions used during line construction and placement.
174     void determineSpacingForFlowBoxes(bool lastLine, bool isLogicallyLastRunWrapped, RenderObject* logicallyLastRunRenderer);
175     LayoutUnit getFlowSpacingLogicalWidth();
176     float placeBoxesInInlineDirection(float logicalLeft, bool& needsWordSpacing, GlyphOverflowAndFallbackFontsMap&);
177     void computeLogicalBoxHeights(RootInlineBox*, LayoutUnit& maxPositionTop, LayoutUnit& maxPositionBottom,
178                                   int& maxAscent, int& maxDescent, bool& setMaxAscent, bool& setMaxDescent,
179                                   bool strictMode, GlyphOverflowAndFallbackFontsMap&, FontBaseline, VerticalPositionCache&);
180     void adjustMaxAscentAndDescent(int& maxAscent, int& maxDescent,
181                                    int maxPositionTop, int maxPositionBottom);
182     void placeBoxesInBlockDirection(LayoutUnit logicalTop, LayoutUnit maxHeight, int maxAscent, bool strictMode, LayoutUnit& lineTop, LayoutUnit& lineBottom, bool& setLineTop,
183                                     LayoutUnit& lineTopIncludingMargins, LayoutUnit& lineBottomIncludingMargins, bool& hasAnnotationsBefore, bool& hasAnnotationsAfter, FontBaseline);
184     void flipLinesInBlockDirection(LayoutUnit lineTop, LayoutUnit lineBottom);
185     bool requiresIdeographicBaseline(const GlyphOverflowAndFallbackFontsMap&) const;
186
187     LayoutUnit computeOverAnnotationAdjustment(LayoutUnit allowedPosition) const;
188     LayoutUnit computeUnderAnnotationAdjustment(LayoutUnit allowedPosition) const;
189
190     void computeOverflow(LayoutUnit lineTop, LayoutUnit lineBottom, GlyphOverflowAndFallbackFontsMap&);
191     
192     void removeChild(InlineBox* child);
193
194     virtual RenderObject::SelectionState selectionState();
195
196     virtual bool canAccommodateEllipsis(bool ltr, int blockEdge, int ellipsisWidth) const OVERRIDE;
197     virtual float placeEllipsisBox(bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, float &truncatedWidth, bool&) OVERRIDE;
198
199     bool hasTextChildren() const { return m_hasTextChildren; }
200     bool hasTextDescendants() const { return m_hasTextDescendants; }
201     void setHasTextChildren() { m_hasTextChildren = true; setHasTextDescendants(); }
202     void setHasTextDescendants() { m_hasTextDescendants = true; }
203     
204     void checkConsistency() const;
205     void setHasBadChildList();
206
207     // Line visual and layout overflow are in the coordinate space of the block.  This means that they aren't purely physical directions.
208     // For horizontal-tb and vertical-lr they will match physical directions, but for horizontal-bt and vertical-rl, the top/bottom and left/right
209     // 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.
210     LayoutRect layoutOverflowRect(LayoutUnit lineTop, LayoutUnit lineBottom) const
211     { 
212         return m_overflow ? m_overflow->layoutOverflowRect() : enclosingLayoutRect(frameRectIncludingLineHeight(lineTop, lineBottom));
213     }
214     LayoutUnit logicalLeftLayoutOverflow() const
215     {
216         return m_overflow ? (isHorizontal() ? m_overflow->layoutOverflowRect().x() : m_overflow->layoutOverflowRect().y()) :
217                             static_cast<LayoutUnit>(logicalLeft());
218     }
219     LayoutUnit logicalRightLayoutOverflow() const
220     {
221         return m_overflow ? (isHorizontal() ? m_overflow->layoutOverflowRect().maxX() : m_overflow->layoutOverflowRect().maxY()) :
222                             static_cast<LayoutUnit>(ceilf(logicalRight()));
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     void addBoxShadowVisualOverflow(LayoutRect& logicalVisualOverflow);
296     void addBorderOutsetVisualOverflow(LayoutRect& logicalVisualOverflow);
297     void addTextBoxVisualOverflow(InlineTextBox*, GlyphOverflowAndFallbackFontsMap&, LayoutRect& logicalVisualOverflow);
298     void addReplacedChildOverflow(const InlineBox*, LayoutRect& logicalLayoutOverflow, LayoutRect& logicalVisualOverflow);
299     void constrainToLineTopAndBottomIfNeeded(LayoutRect&) const;
300
301 protected:
302     OwnPtr<RenderOverflow> m_overflow;
303
304     virtual bool isInlineFlowBox() const { return true; }
305
306     InlineBox* m_firstChild;
307     InlineBox* m_lastChild;
308     
309     InlineFlowBox* m_prevLineBox; // The previous box that also uses our RenderObject
310     InlineFlowBox* m_nextLineBox; // The next box that also uses our RenderObject
311
312 private:
313     unsigned m_includeLogicalLeftEdge : 1;
314     unsigned m_includeLogicalRightEdge : 1;
315     unsigned m_hasTextChildren : 1;
316     unsigned m_hasTextDescendants : 1;
317     unsigned m_descendantsHaveSameLineHeightAndBaseline : 1;
318
319 protected:
320     // The following members are only used by RootInlineBox but moved here to keep the bits packed.
321
322     // Whether or not this line uses alphabetic or ideographic baselines by default.
323     unsigned m_baselineType : 1; // FontBaseline
324
325     // If the line contains any ruby runs, then this will be true.
326     unsigned m_hasAnnotationsBefore : 1;
327     unsigned m_hasAnnotationsAfter : 1;
328     unsigned m_isFirstAfterPageBreak : 1;
329
330     unsigned m_lineBreakBidiStatusEor : 5; // WTF::Unicode::Direction
331     unsigned m_lineBreakBidiStatusLastStrong : 5; // WTF::Unicode::Direction
332     unsigned m_lineBreakBidiStatusLast : 5; // WTF::Unicode::Direction
333
334     // End of RootInlineBox-specific members.
335
336 #ifndef NDEBUG
337 private:
338     unsigned m_hasBadChildList : 1;
339 #endif
340 };
341
342 inline InlineFlowBox* toInlineFlowBox(InlineBox* object)
343 {
344     ASSERT(!object || object->isInlineFlowBox());
345     return static_cast<InlineFlowBox*>(object);
346 }
347
348 inline const InlineFlowBox* toInlineFlowBox(const InlineBox* object)
349 {
350     ASSERT(!object || object->isInlineFlowBox());
351     return static_cast<const InlineFlowBox*>(object);
352 }
353
354 // This will catch anyone doing an unnecessary cast.
355 void toInlineFlowBox(const InlineFlowBox*);
356
357 #ifdef NDEBUG
358 inline void InlineFlowBox::checkConsistency() const
359 {
360 }
361 #endif
362
363 inline void InlineFlowBox::setHasBadChildList()
364 {
365 #ifndef NDEBUG
366     m_hasBadChildList = true;
367 #endif
368 }
369
370 } // namespace WebCore
371
372 #ifndef NDEBUG
373 // Outside the WebCore namespace for ease of invocation from gdb.
374 void showTree(const WebCore::InlineFlowBox*);
375 #endif
376
377 #endif // InlineFlowBox_h