766e3705aea5442414ba3641e7d8ef213d0ab488
[WebKit-https.git] / Source / WebCore / rendering / RootInlineBox.h
1 /*
2  * Copyright (C) 2003, 2006, 2007, 2008 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 RootInlineBox_h
22 #define RootInlineBox_h
23
24 #include "BidiContext.h"
25 #include "InlineFlowBox.h"
26
27 namespace WebCore {
28
29 class EllipsisBox;
30 class HitTestResult;
31 class RenderRegion;
32
33 struct BidiStatus;
34 struct GapRects;
35
36 class RootInlineBox : public InlineFlowBox {
37 public:
38     explicit RootInlineBox(RenderBlock*);
39
40     virtual void destroy(RenderArena*);
41
42     virtual bool isRootInlineBox() const { return true; }
43
44     void detachEllipsisBox(RenderArena*);
45
46     RootInlineBox* nextRootBox() const { return static_cast<RootInlineBox*>(m_nextLineBox); }
47     RootInlineBox* prevRootBox() const { return static_cast<RootInlineBox*>(m_prevLineBox); }
48
49     virtual void adjustPosition(float dx, float dy);
50
51     LayoutUnit lineTop() const { return m_lineTop; }
52     LayoutUnit lineBottom() const { return m_lineBottom; }
53
54     LayoutUnit lineTopWithLeading() const { return m_lineTopWithLeading; }
55     LayoutUnit lineBottomWithLeading() const { return m_lineBottomWithLeading; }
56     
57     LayoutUnit paginationStrut() const { return m_fragmentationData ? m_fragmentationData->m_paginationStrut : LayoutUnit(0); }
58     void setPaginationStrut(LayoutUnit strut) { ensureLineFragmentationData()->m_paginationStrut = strut; }
59
60     bool isFirstAfterPageBreak() const { return m_fragmentationData ? m_fragmentationData->m_isFirstAfterPageBreak : false; }
61     void setIsFirstAfterPageBreak(bool isFirstAfterPageBreak) { ensureLineFragmentationData()->m_isFirstAfterPageBreak = isFirstAfterPageBreak; }
62
63     LayoutUnit paginatedLineWidth() const { return m_fragmentationData ? m_fragmentationData->m_paginatedLineWidth : LayoutUnit(0); }
64     void setPaginatedLineWidth(LayoutUnit width) { ensureLineFragmentationData()->m_paginatedLineWidth = width; }
65
66     RenderRegion* containingRegion() const;
67     void setContainingRegion(RenderRegion*);
68
69     LayoutUnit selectionTop() const;
70     LayoutUnit selectionBottom() const;
71     LayoutUnit selectionHeight() const { return max<LayoutUnit>(0, selectionBottom() - selectionTop()); }
72
73     LayoutUnit selectionTopAdjustedForPrecedingBlock() const;
74     LayoutUnit selectionHeightAdjustedForPrecedingBlock() const { return max<LayoutUnit>(0, selectionBottom() - selectionTopAdjustedForPrecedingBlock()); }
75
76     int blockDirectionPointInLine() const;
77
78     LayoutUnit alignBoxesInBlockDirection(LayoutUnit heightOfBlock, GlyphOverflowAndFallbackFontsMap&, VerticalPositionCache&);
79     void setLineTopBottomPositions(LayoutUnit top, LayoutUnit bottom, LayoutUnit topWithLeading, LayoutUnit bottomWithLeading)
80     { 
81         m_lineTop = top; 
82         m_lineBottom = bottom;
83         m_lineTopWithLeading = topWithLeading;
84         m_lineBottomWithLeading = bottomWithLeading;
85     }
86
87     virtual RenderLineBoxList* rendererLineBoxes() const;
88
89     RenderObject* lineBreakObj() const { return m_lineBreakObj; }
90     BidiStatus lineBreakBidiStatus() const;
91     void setLineBreakInfo(RenderObject*, unsigned breakPos, const BidiStatus&);
92
93     unsigned lineBreakPos() const { return m_lineBreakPos; }
94     void setLineBreakPos(unsigned p) { m_lineBreakPos = p; }
95
96     using InlineBox::endsWithBreak;
97     using InlineBox::setEndsWithBreak;
98
99     void childRemoved(InlineBox* box);
100
101     bool lineCanAccommodateEllipsis(bool ltr, int blockEdge, int lineBoxEdge, int ellipsisWidth);
102     // Return the truncatedWidth, the width of the truncated text + ellipsis.
103     float placeEllipsis(const AtomicString& ellipsisStr, bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, InlineBox* markupBox = 0);
104     // Return the position of the EllipsisBox or -1.
105     virtual float placeEllipsisBox(bool ltr, float blockLeftEdge, float blockRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) OVERRIDE;
106
107     using InlineBox::hasEllipsisBox;
108     EllipsisBox* ellipsisBox() const;
109
110     void paintEllipsisBox(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom) const;
111
112     virtual void clearTruncation() OVERRIDE;
113
114     bool isHyphenated() const;
115
116     virtual int baselinePosition(FontBaseline baselineType) const;
117     virtual LayoutUnit lineHeight() const;
118
119 #if PLATFORM(MAC)
120     void addHighlightOverflow();
121     void paintCustomHighlight(PaintInfo&, const LayoutPoint&, const AtomicString& highlightType);
122 #endif
123
124     virtual void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom);
125     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE;
126
127     using InlineBox::hasSelectedChildren;
128     using InlineBox::setHasSelectedChildren;
129
130     virtual RenderObject::SelectionState selectionState();
131     InlineBox* firstSelectedBox();
132     InlineBox* lastSelectedBox();
133
134     GapRects lineSelectionGap(RenderBlock* rootBlock, const LayoutPoint& rootBlockPhysicalPosition, const LayoutSize& offsetFromRootBlock, LayoutUnit selTop, LayoutUnit selHeight, const PaintInfo*);
135
136     RenderBlock* block() const;
137
138     InlineBox* closestLeafChildForPoint(const IntPoint&, bool onlyEditableLeaves);
139     InlineBox* closestLeafChildForLogicalLeftPosition(int, bool onlyEditableLeaves = false);
140
141     void appendFloat(RenderBox* floatingBox)
142     {
143         ASSERT(!isDirty());
144         if (m_floats)
145             m_floats->append(floatingBox);
146         else
147             m_floats= adoptPtr(new Vector<RenderBox*>(1, floatingBox));
148     }
149
150     Vector<RenderBox*>* floatsPtr() { ASSERT(!isDirty()); return m_floats.get(); }
151
152     virtual void extractLineBoxFromRenderObject();
153     virtual void attachLineBoxToRenderObject();
154     virtual void removeLineBoxFromRenderObject();
155     
156     FontBaseline baselineType() const { return static_cast<FontBaseline>(m_baselineType); }
157
158     bool hasAnnotationsBefore() const { return m_hasAnnotationsBefore; }
159     bool hasAnnotationsAfter() const { return m_hasAnnotationsAfter; }
160
161     LayoutRect paddedLayoutOverflowRect(LayoutUnit endPadding) const;
162
163     void ascentAndDescentForBox(InlineBox*, GlyphOverflowAndFallbackFontsMap&, int& ascent, int& descent, bool& affectsAscent, bool& affectsDescent) const;
164     LayoutUnit verticalPositionForBox(InlineBox*, VerticalPositionCache&);
165     bool includeLeadingForBox(InlineBox*) const;
166     bool includeFontForBox(InlineBox*) const;
167     bool includeGlyphsForBox(InlineBox*) const;
168     bool includeMarginForBox(InlineBox*) const;
169     bool fitsToGlyphs() const;
170     bool includesRootLineBoxFontOrLeading() const;
171     
172     LayoutUnit logicalTopVisualOverflow() const
173     {
174         return InlineFlowBox::logicalTopVisualOverflow(lineTop());
175     }
176     LayoutUnit logicalBottomVisualOverflow() const
177     {
178         return InlineFlowBox::logicalBottomVisualOverflow(lineBottom());
179     }
180     LayoutUnit logicalTopLayoutOverflow() const
181     {
182         return InlineFlowBox::logicalTopLayoutOverflow(lineTop());
183     }
184     LayoutUnit logicalBottomLayoutOverflow() const
185     {
186         return InlineFlowBox::logicalBottomLayoutOverflow(lineBottom());
187     }
188
189 #if ENABLE(CSS3_TEXT)
190     // Used to calculate the underline offset for TextUnderlinePositionUnder.
191     float maxLogicalTop() const { return m_maxLogicalTop; }
192 #endif // CSS3_TEXT
193
194     Node* getLogicalStartBoxWithNode(InlineBox*&) const;
195     Node* getLogicalEndBoxWithNode(InlineBox*&) const;
196
197 #ifndef NDEBUG
198     virtual const char* boxName() const;
199 #endif
200 private:
201     LayoutUnit lineSnapAdjustment(LayoutUnit delta = 0) const;
202
203     LayoutUnit beforeAnnotationsAdjustment() const;
204
205     struct LineFragmentationData;
206     LineFragmentationData* ensureLineFragmentationData()
207     {
208         if (!m_fragmentationData)
209             m_fragmentationData = adoptPtr(new LineFragmentationData());
210
211         return m_fragmentationData.get();
212     }
213
214     // This folds into the padding at the end of InlineFlowBox on 64-bit.
215     unsigned m_lineBreakPos;
216
217     // Where this line ended.  The exact object and the position within that object are stored so that
218     // we can create an InlineIterator beginning just after the end of this line.
219     RenderObject* m_lineBreakObj;
220     RefPtr<BidiContext> m_lineBreakContext;
221
222     LayoutUnit m_lineTop;
223     LayoutUnit m_lineBottom;
224
225     LayoutUnit m_lineTopWithLeading;
226     LayoutUnit m_lineBottomWithLeading;
227
228 #if ENABLE(CSS3_TEXT)
229     // Maximum logicalTop among all children of an InlineFlowBox. Used to
230     // calculate the offset for TextUnderlinePositionUnder.
231     float m_maxLogicalTop;
232 #endif // CSS3_TEXT
233
234     struct LineFragmentationData {
235         WTF_MAKE_NONCOPYABLE(LineFragmentationData); WTF_MAKE_FAST_ALLOCATED;
236     public:
237         LineFragmentationData()
238             : m_containingRegion(0)
239             , m_paginationStrut(0)
240             , m_paginatedLineWidth(0)
241             , m_isFirstAfterPageBreak(false)
242         {
243
244         }
245
246         // It should not be assumed the |containingRegion| is always valid.
247         // It can also be 0 if the flow has no region chain.
248         RenderRegion* m_containingRegion;
249         LayoutUnit m_paginationStrut;
250         LayoutUnit m_paginatedLineWidth;
251         bool m_isFirstAfterPageBreak;
252     };
253
254     OwnPtr<LineFragmentationData> m_fragmentationData;
255
256     // Floats hanging off the line are pushed into this vector during layout. It is only
257     // good for as long as the line has not been marked dirty.
258     OwnPtr<Vector<RenderBox*> > m_floats;
259 };
260
261 } // namespace WebCore
262
263 #endif // RootInlineBox_h