Rename InlineBox::remove() to removeFromParent
[WebKit-https.git] / Source / WebCore / rendering / InlineTextBox.h
1 /*
2  * (C) 1999 Lars Knoll (knoll@kde.org)
3  * (C) 2000 Dirk Mueller (mueller@kde.org)
4  * Copyright (C) 2004, 2005, 2006, 2009, 2010, 2011 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef InlineTextBox_h
24 #define InlineTextBox_h
25
26 #include "InlineBox.h"
27 #include "RenderText.h"
28 #include "TextRun.h"
29 #include <wtf/text/StringBuilder.h>
30
31 namespace WebCore {
32
33 struct CompositionUnderline;
34 class DocumentMarker;
35
36 const unsigned short cNoTruncation = USHRT_MAX;
37 const unsigned short cFullTruncation = USHRT_MAX - 1;
38
39 class BufferForAppendingHyphen : public StringBuilder {
40 public:
41     BufferForAppendingHyphen() { reserveCapacity(256); }
42 };
43
44 class InlineTextBox : public InlineBox {
45 public:
46     explicit InlineTextBox(RenderText& renderer)
47         : InlineBox(renderer)
48         , m_prevTextBox(0)
49         , m_nextTextBox(0)
50         , m_start(0)
51         , m_len(0)
52         , m_truncation(cNoTruncation)
53     {
54         setBehavesLikeText(true);
55     }
56
57     RenderText& renderer() const { return toRenderText(InlineBox::renderer()); }
58     const RenderStyle& lineStyle() const { return isFirstLine() ? *renderer().firstLineStyle() : *renderer().style(); }
59
60     virtual void destroy(RenderArena&) OVERRIDE FINAL;
61
62     InlineTextBox* prevTextBox() const { return m_prevTextBox; }
63     InlineTextBox* nextTextBox() const { return m_nextTextBox; }
64     void setNextTextBox(InlineTextBox* n) { m_nextTextBox = n; }
65     void setPreviousTextBox(InlineTextBox* p) { m_prevTextBox = p; }
66
67     // FIXME: These accessors should ASSERT(!isDirty()). See https://bugs.webkit.org/show_bug.cgi?id=97264
68     unsigned start() const { return m_start; }
69     unsigned end() const { return m_len ? m_start + m_len - 1 : m_start; }
70     unsigned len() const { return m_len; }
71
72     void setStart(unsigned start) { m_start = start; }
73     void setLen(unsigned len) { m_len = len; }
74
75     void offsetRun(int d) { ASSERT(!isDirty()); m_start += d; }
76
77     unsigned short truncation() const { return m_truncation; }
78
79     virtual void markDirty(bool dirty = true) OVERRIDE FINAL;
80
81     using InlineBox::hasHyphen;
82     using InlineBox::setHasHyphen;
83     using InlineBox::canHaveLeadingExpansion;
84     using InlineBox::setCanHaveLeadingExpansion;
85
86     static inline bool compareByStart(const InlineTextBox* first, const InlineTextBox* second) { return first->start() < second->start(); }
87
88     virtual int baselinePosition(FontBaseline) const OVERRIDE FINAL;
89     virtual LayoutUnit lineHeight() const OVERRIDE FINAL;
90
91     bool getEmphasisMarkPosition(const RenderStyle&, TextEmphasisPosition&) const;
92
93     LayoutRect logicalOverflowRect() const;
94     void setLogicalOverflowRect(const LayoutRect&);
95     LayoutUnit logicalTopVisualOverflow() const { return logicalOverflowRect().y(); }
96     LayoutUnit logicalBottomVisualOverflow() const { return logicalOverflowRect().maxY(); }
97     LayoutUnit logicalLeftVisualOverflow() const { return logicalOverflowRect().x(); }
98     LayoutUnit logicalRightVisualOverflow() const { return logicalOverflowRect().maxX(); }
99
100 #ifndef NDEBUG
101     virtual void showBox(int = 0) const;
102     virtual const char* boxName() const;
103 #endif
104
105 private:
106     LayoutUnit selectionTop() const;
107     LayoutUnit selectionBottom() const;
108     LayoutUnit selectionHeight() const;
109
110     TextRun constructTextRun(const RenderStyle&, const Font&, BufferForAppendingHyphen* = 0) const;
111     TextRun constructTextRun(const RenderStyle&, const Font&, String, int maximumLength, BufferForAppendingHyphen* = 0) const;
112
113 public:
114     virtual FloatRect calculateBoundaries() const { return FloatRect(x(), y(), width(), height()); }
115
116     virtual LayoutRect localSelectionRect(int startPos, int endPos) const;
117     bool isSelected(int startPos, int endPos) const;
118     void selectionStartEnd(int& sPos, int& ePos);
119
120 protected:
121     virtual void paint(PaintInfo&, const LayoutPoint&, LayoutUnit lineTop, LayoutUnit lineBottom);
122     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, LayoutUnit lineTop, LayoutUnit lineBottom) OVERRIDE;
123
124 private:
125     virtual void deleteLine(RenderArena&) OVERRIDE FINAL;
126     virtual void extractLine() OVERRIDE FINAL;
127     virtual void attachLine() OVERRIDE FINAL;
128
129 public:
130     virtual RenderObject::SelectionState selectionState() OVERRIDE FINAL;
131
132 private:
133     virtual void clearTruncation() OVERRIDE FINAL { m_truncation = cNoTruncation; }
134     virtual float placeEllipsisBox(bool flowIsLTR, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) OVERRIDE FINAL;
135
136 public:
137     virtual bool isLineBreak() const OVERRIDE FINAL;
138
139     void setExpansion(int newExpansion)
140     {
141         m_logicalWidth -= expansion();
142         InlineBox::setExpansion(newExpansion);
143         m_logicalWidth += newExpansion;
144     }
145
146 private:
147     virtual bool isInlineTextBox() const OVERRIDE FINAL { return true; }
148
149 public:
150     virtual int caretMinOffset() const OVERRIDE FINAL;
151     virtual int caretMaxOffset() const OVERRIDE FINAL;
152
153 private:
154     float textPos() const; // returns the x position relative to the left start of the text line.
155
156 public:
157     virtual int offsetForPosition(float x, bool includePartialGlyphs = true) const;
158     virtual float positionForOffset(int offset) const;
159
160     bool containsCaretOffset(int offset) const; // false for offset after line break
161
162     // Needs to be public, so the static paintTextWithShadows() function can use it.
163     static FloatSize applyShadowToGraphicsContext(GraphicsContext*, const ShadowData*, const FloatRect& textRect, bool stroked, bool opaque, bool horizontal);
164
165 protected:
166     void paintCompositionBackground(GraphicsContext*, const FloatPoint& boxOrigin, const RenderStyle&, const Font&, int startPos, int endPos);
167     void paintDocumentMarkers(GraphicsContext*, const FloatPoint& boxOrigin, const RenderStyle&, const Font&, bool background);
168     void paintCompositionUnderline(GraphicsContext*, const FloatPoint& boxOrigin, const CompositionUnderline&);
169 #if PLATFORM(MAC)
170     void paintCustomHighlight(const LayoutPoint&, const AtomicString& type);
171 #endif
172
173 private:
174     void paintDecoration(GraphicsContext*, const FloatPoint& boxOrigin, TextDecoration, TextDecorationStyle, const ShadowData*);
175     void paintSelection(GraphicsContext*, const FloatPoint& boxOrigin, const RenderStyle&, const Font&, Color textColor);
176     void paintDocumentMarker(GraphicsContext*, const FloatPoint& boxOrigin, DocumentMarker*, const RenderStyle&, const Font&, bool grammar);
177     void paintTextMatchMarker(GraphicsContext*, const FloatPoint& boxOrigin, DocumentMarker*, const RenderStyle&, const Font&);
178     void computeRectForReplacementMarker(DocumentMarker*, const RenderStyle&, const Font&);
179
180     TextRun::ExpansionBehavior expansionBehavior() const
181     {
182         return (canHaveLeadingExpansion() ? TextRun::AllowLeadingExpansion : TextRun::ForbidLeadingExpansion)
183             | (expansion() && nextLeafChild() ? TextRun::AllowTrailingExpansion : TextRun::ForbidTrailingExpansion);
184     }
185
186     void behavesLikeText() const WTF_DELETED_FUNCTION;
187
188     InlineTextBox* m_prevTextBox; // The previous box that also uses our RenderObject
189     InlineTextBox* m_nextTextBox; // The next box that also uses our RenderObject
190
191     int m_start;
192     unsigned short m_len;
193
194     // Where to truncate when text overflow is applied. We use special constants to
195     // denote no truncation (the whole run paints) and full truncation (nothing paints at all).
196     unsigned short m_truncation;
197 };
198
199 inline InlineTextBox* toInlineTextBox(InlineBox* inlineBox)
200 {
201     ASSERT_WITH_SECURITY_IMPLICATION(!inlineBox || inlineBox->isInlineTextBox());
202     return static_cast<InlineTextBox*>(inlineBox);
203 }
204
205 inline const InlineTextBox* toInlineTextBox(const InlineBox* inlineBox)
206 {
207     ASSERT_WITH_SECURITY_IMPLICATION(!inlineBox || inlineBox->isInlineTextBox());
208     return static_cast<const InlineTextBox*>(inlineBox);
209 }
210
211 // This will catch anyone doing an unnecessary cast.
212 void toInlineTextBox(const InlineTextBox*);
213
214 void alignSelectionRectToDevicePixels(FloatRect&);
215
216 } // namespace WebCore
217
218 #endif // InlineTextBox_h