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