a1c9d930be1e799dcdfc44f4aad384f4245efc5a
[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" // so textRenderer() can be inline
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 // Helper functions shared by InlineTextBox / SVGRootInlineBox
45 void updateGraphicsContext(GraphicsContext*, const Color& fillColor, const Color& strokeColor, float strokeThickness, ColorSpace);
46 Color correctedTextColor(Color textColor, Color backgroundColor);
47
48 class InlineTextBox : public InlineBox {
49 public:
50     InlineTextBox(RenderObject* obj)
51         : InlineBox(obj)
52         , m_prevTextBox(0)
53         , m_nextTextBox(0)
54         , m_start(0)
55         , m_len(0)
56         , m_truncation(cNoTruncation)
57     {
58     }
59
60     virtual void destroy(RenderArena*) 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() { 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 FINAL;
89     virtual LayoutUnit lineHeight() const FINAL;
90
91     bool getEmphasisMarkPosition(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();
107     LayoutUnit selectionBottom();
108     LayoutUnit selectionHeight();
109
110     TextRun constructTextRun(RenderStyle*, const Font&, BufferForAppendingHyphen* = 0) const;
111     TextRun constructTextRun(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);
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 public:
125     RenderText* textRenderer() const;
126
127 private:
128     virtual void deleteLine(RenderArena*) FINAL;
129     virtual void extractLine() FINAL;
130     virtual void attachLine() FINAL;
131
132 public:
133     virtual RenderObject::SelectionState selectionState() FINAL;
134
135 private:
136     virtual void clearTruncation() FINAL { m_truncation = cNoTruncation; }
137     virtual float placeEllipsisBox(bool flowIsLTR, float visibleLeftEdge, float visibleRightEdge, float ellipsisWidth, float &truncatedWidth, bool& foundBox) OVERRIDE FINAL;
138
139 public:
140     virtual bool isLineBreak() const FINAL;
141
142     void setExpansion(int newExpansion)
143     {
144         m_logicalWidth -= expansion();
145         InlineBox::setExpansion(newExpansion);
146         m_logicalWidth += newExpansion;
147     }
148
149 private:
150     virtual bool isInlineTextBox() const FINAL { return true; }
151
152 public:
153     virtual int caretMinOffset() const FINAL;
154     virtual int caretMaxOffset() const FINAL;
155
156 private:
157     float textPos() const; // returns the x position relative to the left start of the text line.
158
159 public:
160     virtual int offsetForPosition(float x, bool includePartialGlyphs = true) const;
161     virtual float positionForOffset(int offset) const;
162
163     bool containsCaretOffset(int offset) const; // false for offset after line break
164
165     // Needs to be public, so the static paintTextWithShadows() function can use it.
166     static FloatSize applyShadowToGraphicsContext(GraphicsContext*, const ShadowData*, const FloatRect& textRect, bool stroked, bool opaque, bool horizontal);
167
168 private:
169     InlineTextBox* m_prevTextBox; // The previous box that also uses our RenderObject
170     InlineTextBox* m_nextTextBox; // The next box that also uses our RenderObject
171
172     int m_start;
173     unsigned short m_len;
174
175     unsigned short m_truncation; // Where to truncate when text overflow is applied.  We use special constants to
176                       // denote no truncation (the whole run paints) and full truncation (nothing paints at all).
177
178 protected:
179     void paintCompositionBackground(GraphicsContext*, const FloatPoint& boxOrigin, RenderStyle*, const Font&, int startPos, int endPos);
180     void paintDocumentMarkers(GraphicsContext*, const FloatPoint& boxOrigin, RenderStyle*, const Font&, bool background);
181     void paintCompositionUnderline(GraphicsContext*, const FloatPoint& boxOrigin, const CompositionUnderline&);
182 #if PLATFORM(MAC)
183     void paintCustomHighlight(const LayoutPoint&, const AtomicString& type);
184 #endif
185
186 private:
187     void paintDecoration(GraphicsContext*, const FloatPoint& boxOrigin, TextDecoration, TextDecorationStyle, const ShadowData*);
188     void paintSelection(GraphicsContext*, const FloatPoint& boxOrigin, RenderStyle*, const Font&, Color textColor);
189     void paintDocumentMarker(GraphicsContext*, const FloatPoint& boxOrigin, DocumentMarker*, RenderStyle*, const Font&, bool grammar);
190     void paintTextMatchMarker(GraphicsContext*, const FloatPoint& boxOrigin, DocumentMarker*, RenderStyle*, const Font&);
191     void computeRectForReplacementMarker(DocumentMarker*, RenderStyle*, const Font&);
192
193     TextRun::ExpansionBehavior expansionBehavior() const
194     {
195         return (canHaveLeadingExpansion() ? TextRun::AllowLeadingExpansion : TextRun::ForbidLeadingExpansion)
196             | (expansion() && nextLeafChild() ? TextRun::AllowTrailingExpansion : TextRun::ForbidTrailingExpansion);
197     }
198 };
199
200 inline InlineTextBox* toInlineTextBox(InlineBox* inlineBox)
201 {
202     ASSERT_WITH_SECURITY_IMPLICATION(!inlineBox || inlineBox->isInlineTextBox());
203     return static_cast<InlineTextBox*>(inlineBox);
204 }
205
206 inline const InlineTextBox* toInlineTextBox(const InlineBox* inlineBox)
207 {
208     ASSERT_WITH_SECURITY_IMPLICATION(!inlineBox || inlineBox->isInlineTextBox());
209     return static_cast<const InlineTextBox*>(inlineBox);
210 }
211
212 // This will catch anyone doing an unnecessary cast.
213 void toInlineTextBox(const InlineTextBox*);
214
215 inline RenderText* InlineTextBox::textRenderer() const
216 {
217     return toRenderText(renderer());
218 }
219
220 void alignSelectionRectToDevicePixels(FloatRect&);
221
222 } // namespace WebCore
223
224 #endif // InlineTextBox_h