f2960673416c0fc490c30fd4fc25365895d0a375
[WebKit-https.git] / Source / WebCore / rendering / InlineBox.h
1 /*
2  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2009, 2010, 2011 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 InlineBox_h
22 #define InlineBox_h
23
24 #include "RenderBoxModelObject.h"
25 #include "TextDirection.h"
26
27 namespace WebCore {
28
29 class HitTestRequest;
30 class HitTestResult;
31 class RootInlineBox;
32
33 // InlineBox represents a rectangle that occurs on a line.  It corresponds to
34 // some RenderObject (i.e., it represents a portion of that RenderObject).
35 class InlineBox {
36     WTF_MAKE_FAST_ALLOCATED;
37 public:
38     virtual ~InlineBox();
39
40     virtual void deleteLine() = 0;
41     virtual void extractLine() = 0;
42     virtual void attachLine() = 0;
43
44     virtual bool isLineBreak() const { return renderer().isLineBreak(); }
45
46     virtual void adjustPosition(float dx, float dy);
47     void adjustLogicalPosition(float deltaLogicalLeft, float deltaLogicalTop)
48     {
49         if (isHorizontal())
50             adjustPosition(deltaLogicalLeft, deltaLogicalTop);
51         else
52             adjustPosition(deltaLogicalTop, deltaLogicalLeft);
53     }
54     void adjustLineDirectionPosition(float delta)
55     {
56         if (isHorizontal())
57             adjustPosition(delta, 0);
58         else
59             adjustPosition(0, delta);
60     }
61     void adjustBlockDirectionPosition(float delta)
62     {
63         if (isHorizontal())
64             adjustPosition(0, delta);
65         else
66             adjustPosition(delta, 0);
67     }
68
69     virtual void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom) = 0;
70     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom) = 0;
71
72 public:
73 #ifndef NDEBUG
74     void showTreeForThis() const;
75     void showLineTreeForThis() const;
76     
77     virtual void showBox(int = 0) const;
78     virtual void showLineTreeAndMark(const InlineBox* = 0, const char* = 0, const InlineBox* = 0, const char* = 0, const RenderObject* = 0, int = 0) const;
79     virtual const char* boxName() const;
80 #endif
81
82     bool behavesLikeText() const { return m_bitfields.behavesLikeText(); }
83     void setBehavesLikeText(bool behavesLikeText) { m_bitfields.setBehavesLikeText(behavesLikeText); }
84
85     virtual bool isInlineElementBox() const { return false; }
86     virtual bool isInlineFlowBox() const { return false; }
87     virtual bool isInlineTextBox() const { return false; }
88     virtual bool isRootInlineBox() const { return false; }
89     virtual bool isSVGInlineTextBox() const { return false; }
90     virtual bool isSVGInlineFlowBox() const { return false; }
91     virtual bool isSVGRootInlineBox() const { return false; }
92
93     bool hasVirtualLogicalHeight() const { return m_bitfields.hasVirtualLogicalHeight(); }
94     void setHasVirtualLogicalHeight() { m_bitfields.setHasVirtualLogicalHeight(true); }
95     virtual float virtualLogicalHeight() const
96     {
97         ASSERT_NOT_REACHED();
98         return 0;
99     }
100
101     bool isHorizontal() const { return m_bitfields.isHorizontal(); }
102     void setIsHorizontal(bool isHorizontal) { m_bitfields.setIsHorizontal(isHorizontal); }
103
104     virtual FloatRect calculateBoundaries() const
105     {
106         ASSERT_NOT_REACHED();
107         return FloatRect();
108     }
109
110     bool isConstructed() { return m_bitfields.constructed(); }
111     virtual void setConstructed() { m_bitfields.setConstructed(true); }
112
113     void setExtracted(bool extracted = true) { m_bitfields.setExtracted(extracted); }
114     
115     void setIsFirstLine(bool firstLine) { m_bitfields.setFirstLine(firstLine); }
116     bool isFirstLine() const { return m_bitfields.firstLine(); }
117
118     void removeFromParent();
119
120     InlineBox* nextOnLine() const { return m_next; }
121     InlineBox* prevOnLine() const { return m_prev; }
122     void setNextOnLine(InlineBox* next)
123     {
124         ASSERT(m_parent || !next);
125         m_next = next;
126     }
127     void setPrevOnLine(InlineBox* prev)
128     {
129         ASSERT(m_parent || !prev);
130         m_prev = prev;
131     }
132     bool nextOnLineExists() const;
133     bool previousOnLineExists() const;
134
135     virtual bool isLeaf() const { return true; }
136     
137     InlineBox* nextLeafChild() const;
138     InlineBox* prevLeafChild() const;
139
140     // Helper functions for editing and hit-testing code.
141     // FIXME: These two functions should be moved to RenderedPosition once the code to convert between
142     // Position and inline box, offset pair is moved to RenderedPosition.
143     InlineBox* nextLeafChildIgnoringLineBreak() const;
144     InlineBox* prevLeafChildIgnoringLineBreak() const;
145
146     // FIXME: Hide this once all callers are using tighter types.
147     RenderObject& renderer() const { return m_renderer; }
148
149     InlineFlowBox* parent() const
150     {
151         ASSERT_WITH_SECURITY_IMPLICATION(!m_hasBadParent);
152         return m_parent;
153     }
154     void setParent(InlineFlowBox* par) { m_parent = par; }
155
156     const RootInlineBox& root() const;
157     RootInlineBox& root();
158
159     // x() is the left side of the box in the containing block's coordinate system.
160     void setX(float x) { m_topLeft.setX(x); }
161     float x() const { return m_topLeft.x(); }
162     float left() const { return m_topLeft.x(); }
163
164     // y() is the top side of the box in the containing block's coordinate system.
165     void setY(float y) { m_topLeft.setY(y); }
166     float y() const { return m_topLeft.y(); }
167     float top() const { return m_topLeft.y(); }
168
169     const FloatPoint& topLeft() const { return m_topLeft; }
170
171     float width() const { return isHorizontal() ? logicalWidth() : logicalHeight(); }
172     float height() const { return isHorizontal() ? logicalHeight() : logicalWidth(); }
173     FloatSize size() const { return FloatSize(width(), height()); }
174     float right() const { return left() + width(); }
175     float bottom() const { return top() + height(); }
176
177     // The logicalLeft position is the left edge of the line box in a horizontal line and the top edge in a vertical line.
178     float logicalLeft() const { return isHorizontal() ? m_topLeft.x() : m_topLeft.y(); }
179     float logicalRight() const { return logicalLeft() + logicalWidth(); }
180     void setLogicalLeft(float left)
181     {
182         if (isHorizontal())
183             setX(left);
184         else
185             setY(left);
186     }
187     int pixelSnappedLogicalLeft() const { return logicalLeft(); }
188     int pixelSnappedLogicalRight() const { return ceilf(logicalRight()); }
189     int pixelSnappedLogicalTop() const { return logicalTop(); }
190     int pixelSnappedLogicalBottom() const { return ceilf(logicalBottom()); }
191
192     // The logicalTop[ position is the top edge of the line box in a horizontal line and the left edge in a vertical line.
193     float logicalTop() const { return isHorizontal() ? m_topLeft.y() : m_topLeft.x(); }
194     float logicalBottom() const { return logicalTop() + logicalHeight(); }
195     void setLogicalTop(float top)
196     {
197         if (isHorizontal())
198             setY(top);
199         else
200             setX(top);
201     }
202
203     // The logical width is our extent in the line's overall inline direction, i.e., width for horizontal text and height for vertical text.
204     void setLogicalWidth(float w) { m_logicalWidth = w; }
205     float logicalWidth() const { return m_logicalWidth; }
206
207     // The logical height is our extent in the block flow direction, i.e., height for horizontal text and width for vertical text.
208     float logicalHeight() const;
209
210     FloatRect logicalFrameRect() const { return isHorizontal() ? FloatRect(m_topLeft.x(), m_topLeft.y(), m_logicalWidth, logicalHeight()) : FloatRect(m_topLeft.y(), m_topLeft.x(), m_logicalWidth, logicalHeight()); }
211
212     virtual int baselinePosition(FontBaseline baselineType) const;
213     virtual LayoutUnit lineHeight() const;
214
215     virtual int caretMinOffset() const;
216     virtual int caretMaxOffset() const;
217
218     unsigned char bidiLevel() const { return m_bitfields.bidiEmbeddingLevel(); }
219     void setBidiLevel(unsigned char level) { m_bitfields.setBidiEmbeddingLevel(level); }
220     TextDirection direction() const { return bidiLevel() % 2 ? RTL : LTR; }
221     bool isLeftToRightDirection() const { return direction() == LTR; }
222     int caretLeftmostOffset() const { return isLeftToRightDirection() ? caretMinOffset() : caretMaxOffset(); }
223     int caretRightmostOffset() const { return isLeftToRightDirection() ? caretMaxOffset() : caretMinOffset(); }
224
225     virtual void clearTruncation() { }
226
227     bool isDirty() const { return m_bitfields.dirty(); }
228     virtual void markDirty(bool dirty = true) { m_bitfields.setDirty(dirty); }
229
230     virtual void dirtyLineBoxes();
231     
232     virtual RenderObject::SelectionState selectionState();
233
234     virtual bool canAccommodateEllipsis(bool ltr, int blockEdge, int ellipsisWidth) const;
235     // visibleLeftEdge, visibleRightEdge are in the parent's coordinate system.
236     virtual float placeEllipsisBox(bool ltr, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool&);
237
238 #if !ASSERT_WITH_SECURITY_IMPLICATION_DISABLED
239     void setHasBadParent();
240 #endif
241
242     int expansion() const { return m_bitfields.expansion(); }
243
244     bool visibleToHitTesting() const { return renderer().style().visibility() == VISIBLE && renderer().style().pointerEvents() != PE_NONE; }
245
246     const RenderStyle& lineStyle() const { return m_bitfields.firstLine() ? renderer().firstLineStyle() : renderer().style(); }
247     
248     EVerticalAlign verticalAlign() const { return lineStyle().verticalAlign(); }
249
250     // Use with caution! The type is not checked!
251     RenderBoxModelObject* boxModelObject() const
252     { 
253         if (!m_renderer.isText())
254             return &toRenderBoxModelObject(m_renderer);
255         return 0;
256     }
257
258     FloatPoint locationIncludingFlipping();
259     void flipForWritingMode(FloatRect&);
260     FloatPoint flipForWritingMode(const FloatPoint&);
261     void flipForWritingMode(LayoutRect&);
262     LayoutPoint flipForWritingMode(const LayoutPoint&);
263
264     bool knownToHaveNoOverflow() const { return m_bitfields.knownToHaveNoOverflow(); }
265     void clearKnownToHaveNoOverflow();
266
267     bool dirOverride() const { return m_bitfields.dirOverride(); }
268     void setDirOverride(bool dirOverride) { m_bitfields.setDirOverride(dirOverride); }
269
270 private:
271     InlineBox* m_next; // The next element on the same line as us.
272     InlineBox* m_prev; // The previous element on the same line as us.
273
274     InlineFlowBox* m_parent; // The box that contains us.
275
276     RenderObject& m_renderer;
277
278 public:
279     FloatPoint m_topLeft;
280     float m_logicalWidth;
281
282 #define ADD_BOOLEAN_BITFIELD(name, Name) \
283     private:\
284     unsigned m_##name : 1;\
285     public:\
286     bool name() const { return m_##name; }\
287     void set##Name(bool name) { m_##name = name; }\
288
289     class InlineBoxBitfields {
290     public:
291         explicit InlineBoxBitfields(bool firstLine = false, bool constructed = false, bool dirty = false, bool extracted = false, bool isHorizontal = true)
292             : m_firstLine(firstLine)
293             , m_constructed(constructed)
294             , m_bidiEmbeddingLevel(0)
295             , m_dirty(dirty)
296             , m_extracted(extracted)
297             , m_hasVirtualLogicalHeight(false)
298             , m_isHorizontal(isHorizontal)
299             , m_endsWithBreak(false)
300             , m_hasSelectedChildrenOrCanHaveLeadingExpansion(false)
301             , m_knownToHaveNoOverflow(true)  
302             , m_hasEllipsisBoxOrHyphen(false)
303             , m_dirOverride(false)
304             , m_behavesLikeText(false)
305             , m_determinedIfNextOnLineExists(false)
306             , m_nextOnLineExists(false)
307             , m_expansion(0)
308         {
309         }
310
311         // Some of these bits are actually for subclasses and moved here to compact the structures.
312         // for this class
313         ADD_BOOLEAN_BITFIELD(firstLine, FirstLine);
314         ADD_BOOLEAN_BITFIELD(constructed, Constructed);
315
316     private:
317         unsigned m_bidiEmbeddingLevel : 6; // The maximium bidi level is 62: http://unicode.org/reports/tr9/#Explicit_Levels_and_Directions
318
319     public:
320         unsigned char bidiEmbeddingLevel() const { return m_bidiEmbeddingLevel; }
321         void setBidiEmbeddingLevel(unsigned char bidiEmbeddingLevel) { m_bidiEmbeddingLevel = bidiEmbeddingLevel; }
322
323         ADD_BOOLEAN_BITFIELD(dirty, Dirty);
324         ADD_BOOLEAN_BITFIELD(extracted, Extracted);
325         ADD_BOOLEAN_BITFIELD(hasVirtualLogicalHeight, HasVirtualLogicalHeight);
326         ADD_BOOLEAN_BITFIELD(isHorizontal, IsHorizontal);
327         // for RootInlineBox
328         ADD_BOOLEAN_BITFIELD(endsWithBreak, EndsWithBreak); // Whether the line ends with a <br>.
329         // shared between RootInlineBox and InlineTextBox
330         ADD_BOOLEAN_BITFIELD(hasSelectedChildrenOrCanHaveLeadingExpansion, HasSelectedChildrenOrCanHaveLeadingExpansion);
331         ADD_BOOLEAN_BITFIELD(knownToHaveNoOverflow, KnownToHaveNoOverflow);
332         ADD_BOOLEAN_BITFIELD(hasEllipsisBoxOrHyphen, HasEllipsisBoxOrHyphen);
333         // for InlineTextBox
334         ADD_BOOLEAN_BITFIELD(dirOverride, DirOverride);
335         ADD_BOOLEAN_BITFIELD(behavesLikeText, BehavesLikeText); // Whether or not this object represents text with a non-zero height. Includes non-image list markers, text boxes, br.
336
337     private:
338         mutable unsigned m_determinedIfNextOnLineExists : 1;
339
340     public:
341         bool determinedIfNextOnLineExists() const { return m_determinedIfNextOnLineExists; }
342         void setDeterminedIfNextOnLineExists(bool determinedIfNextOnLineExists) const { m_determinedIfNextOnLineExists = determinedIfNextOnLineExists; }
343
344     private:
345         mutable unsigned m_nextOnLineExists : 1;
346         
347     public:
348         bool nextOnLineExists() const { return m_nextOnLineExists; }
349         void setNextOnLineExists(bool nextOnLineExists) const { m_nextOnLineExists = nextOnLineExists; }
350
351     private:
352         signed m_expansion : 12; // for justified text
353         
354     public:
355         signed expansion() const { return m_expansion; }
356         void setExpansion(signed expansion) { m_expansion = expansion; }
357     };
358 #undef ADD_BOOLEAN_BITFIELD
359
360 private:
361     InlineBoxBitfields m_bitfields;
362
363 protected:
364     explicit InlineBox(RenderObject& renderer)
365         : m_next(nullptr)
366         , m_prev(nullptr)
367         , m_parent(nullptr)
368         , m_renderer(renderer)
369         , m_logicalWidth(0)
370 #if !ASSERT_WITH_SECURITY_IMPLICATION_DISABLED
371         , m_hasBadParent(false)
372 #endif
373     {
374     }
375
376     InlineBox(RenderObject& renderer, FloatPoint topLeft, float logicalWidth, bool firstLine, bool constructed,
377               bool dirty, bool extracted, bool isHorizontal, InlineBox* next, InlineBox* prev, InlineFlowBox* parent)
378         : m_next(next)
379         , m_prev(prev)
380         , m_parent(parent)
381         , m_renderer(renderer)
382         , m_topLeft(topLeft)
383         , m_logicalWidth(logicalWidth)
384         , m_bitfields(firstLine, constructed, dirty, extracted, isHorizontal)
385 #if !ASSERT_WITH_SECURITY_IMPLICATION_DISABLED
386         , m_hasBadParent(false)
387 #endif
388     {
389     }
390
391     // For RootInlineBox
392     bool endsWithBreak() const { return m_bitfields.endsWithBreak(); }
393     void setEndsWithBreak(bool endsWithBreak) { m_bitfields.setEndsWithBreak(endsWithBreak); }
394     bool hasEllipsisBox() const { return m_bitfields.hasEllipsisBoxOrHyphen(); }
395     bool hasSelectedChildren() const { return m_bitfields.hasSelectedChildrenOrCanHaveLeadingExpansion(); }
396     void setHasSelectedChildren(bool hasSelectedChildren) { m_bitfields.setHasSelectedChildrenOrCanHaveLeadingExpansion(hasSelectedChildren); }
397     void setHasEllipsisBox(bool hasEllipsisBox) { m_bitfields.setHasEllipsisBoxOrHyphen(hasEllipsisBox); }
398
399     // For InlineTextBox
400     bool hasHyphen() const { return m_bitfields.hasEllipsisBoxOrHyphen(); }
401     void setHasHyphen(bool hasHyphen) { m_bitfields.setHasEllipsisBoxOrHyphen(hasHyphen); }    
402     bool canHaveLeadingExpansion() const { return m_bitfields.hasSelectedChildrenOrCanHaveLeadingExpansion(); }
403     void setCanHaveLeadingExpansion(bool canHaveLeadingExpansion) { m_bitfields.setHasSelectedChildrenOrCanHaveLeadingExpansion(canHaveLeadingExpansion); }
404     signed expansion() { return m_bitfields.expansion(); }
405     void setExpansion(signed expansion) { m_bitfields.setExpansion(expansion); }
406     
407     // For InlineFlowBox and InlineTextBox
408     bool extracted() const { return m_bitfields.extracted(); }
409
410 #if !ASSERT_WITH_SECURITY_IMPLICATION_DISABLED
411 private:
412     bool m_hasBadParent;
413 #endif
414 };
415
416 #define INLINE_BOX_OBJECT_TYPE_CASTS(ToValueTypeName, predicate) \
417     TYPE_CASTS_BASE(ToValueTypeName, InlineBox, object, object->predicate, object.predicate)
418
419 #if ASSERT_WITH_SECURITY_IMPLICATION_DISABLED
420 inline InlineBox::~InlineBox()
421 {
422 }
423 #endif
424
425 #if !ASSERT_WITH_SECURITY_IMPLICATION_DISABLED
426 inline void InlineBox::setHasBadParent()
427 {
428     m_hasBadParent = true;
429 }
430 #endif
431
432 } // namespace WebCore
433
434 #ifndef NDEBUG
435 // Outside the WebCore namespace for ease of invocation from gdb.
436 void showTree(const WebCore::InlineBox*);
437 void showLineTree(const WebCore::InlineBox*);
438 #endif
439
440 #endif // InlineBox_h