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