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