Laying out a TextRun using an SVG font is O(n^2)
[WebKit-https.git] / Source / WebCore / platform / graphics / TextRun.h
1 /*
2  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
3  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2003, 2006, 2007, 2011 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef TextRun_h
25 #define TextRun_h
26
27 #include "TextDirection.h"
28 #include <wtf/RefCounted.h>
29 #include <wtf/text/StringView.h>
30
31 namespace WebCore {
32
33 class FloatPoint;
34 class FloatRect;
35 class Font;
36 class GraphicsContext;
37 class GlyphBuffer;
38 class GlyphToPathTranslator;
39 class SimpleFontData;
40
41 struct GlyphData;
42 struct WidthIterator;
43
44 class TextRun {
45     WTF_MAKE_FAST_ALLOCATED;
46 public:
47     enum ExpansionBehaviorFlags {
48         ForbidTrailingExpansion = 0 << 0,
49         AllowTrailingExpansion = 1 << 0,
50         ForbidLeadingExpansion = 0 << 1,
51         AllowLeadingExpansion = 1 << 1,
52     };
53
54     typedef unsigned ExpansionBehavior;
55
56     enum RoundingHackFlags {
57         NoRounding = 0,
58         RunRounding = 1 << 0,
59         WordRounding = 1 << 1,
60     };
61
62     typedef unsigned RoundingHacks;
63
64     TextRun(const LChar* c, unsigned len, float xpos = 0, float expansion = 0, ExpansionBehavior expansionBehavior = AllowTrailingExpansion | ForbidLeadingExpansion, TextDirection direction = LTR, bool directionalOverride = false, bool characterScanForCodePath = true, RoundingHacks roundingHacks = RunRounding | WordRounding)
65         : m_charactersLength(len)
66         , m_len(len)
67         , m_tabSize(0)
68         , m_xpos(xpos)
69         , m_horizontalGlyphStretch(1)
70         , m_expansion(expansion)
71         , m_expansionBehavior(expansionBehavior)
72         , m_is8Bit(true)
73         , m_allowTabs(false)
74         , m_direction(direction)
75         , m_directionalOverride(directionalOverride)
76         , m_characterScanForCodePath(characterScanForCodePath)
77         , m_applyRunRounding((roundingHacks & RunRounding) && s_allowsRoundingHacks)
78         , m_applyWordRounding((roundingHacks & WordRounding) && s_allowsRoundingHacks)
79         , m_disableSpacing(false)
80     {
81         m_data.characters8 = c;
82     }
83
84     TextRun(const UChar* c, unsigned len, float xpos = 0, float expansion = 0, ExpansionBehavior expansionBehavior = AllowTrailingExpansion | ForbidLeadingExpansion, TextDirection direction = LTR, bool directionalOverride = false, bool characterScanForCodePath = true, RoundingHacks roundingHacks = RunRounding | WordRounding)
85         : m_charactersLength(len)
86         , m_len(len)
87         , m_tabSize(0)
88         , m_xpos(xpos)
89         , m_horizontalGlyphStretch(1)
90         , m_expansion(expansion)
91         , m_expansionBehavior(expansionBehavior)
92         , m_is8Bit(false)
93         , m_allowTabs(false)
94         , m_direction(direction)
95         , m_directionalOverride(directionalOverride)
96         , m_characterScanForCodePath(characterScanForCodePath)
97         , m_applyRunRounding((roundingHacks & RunRounding) && s_allowsRoundingHacks)
98         , m_applyWordRounding((roundingHacks & WordRounding) && s_allowsRoundingHacks)
99         , m_disableSpacing(false)
100     {
101         m_data.characters16 = c;
102     }
103     
104     explicit TextRun(const String& s, float xpos = 0, float expansion = 0, ExpansionBehavior expansionBehavior = AllowTrailingExpansion | ForbidLeadingExpansion, TextDirection direction = LTR, bool directionalOverride = false, bool characterScanForCodePath = true, RoundingHacks roundingHacks = RunRounding | WordRounding)
105         : m_charactersLength(s.length())
106         , m_len(s.length())
107         , m_tabSize(0)
108         , m_xpos(xpos)
109         , m_horizontalGlyphStretch(1)
110         , m_expansion(expansion)
111         , m_expansionBehavior(expansionBehavior)
112         , m_allowTabs(false)
113         , m_direction(direction)
114         , m_directionalOverride(directionalOverride)
115         , m_characterScanForCodePath(characterScanForCodePath)
116         , m_applyRunRounding((roundingHacks & RunRounding) && s_allowsRoundingHacks)
117         , m_applyWordRounding((roundingHacks & WordRounding) && s_allowsRoundingHacks)
118         , m_disableSpacing(false)
119     {
120         if (!m_charactersLength || s.is8Bit()) {
121             m_data.characters8 = s.characters8();
122             m_is8Bit = true;
123         } else {
124             m_data.characters16 = s.characters16();
125             m_is8Bit = false;
126         }
127     }
128
129     explicit TextRun(StringView s, float xpos = 0, float expansion = 0, ExpansionBehavior expansionBehavior = AllowTrailingExpansion | ForbidLeadingExpansion, TextDirection direction = LTR, bool directionalOverride = false, bool characterScanForCodePath = true, RoundingHacks roundingHacks = RunRounding | WordRounding)
130         : m_charactersLength(s.length())
131         , m_len(s.length())
132         , m_tabSize(0)
133         , m_xpos(xpos)
134         , m_horizontalGlyphStretch(1)
135         , m_expansion(expansion)
136         , m_expansionBehavior(expansionBehavior)
137         , m_is8Bit(s.is8Bit())
138         , m_allowTabs(false)
139         , m_direction(direction)
140         , m_directionalOverride(directionalOverride)
141         , m_characterScanForCodePath(characterScanForCodePath)
142         , m_applyRunRounding((roundingHacks & RunRounding) && s_allowsRoundingHacks)
143         , m_applyWordRounding((roundingHacks & WordRounding) && s_allowsRoundingHacks)
144         , m_disableSpacing(false)
145     {
146         if (s.is8Bit())
147             m_data.characters8 = s.characters8();
148         else
149             m_data.characters16 = s.characters16();
150     }
151
152     TextRun subRun(unsigned startOffset, unsigned length) const
153     {
154         ASSERT_WITH_SECURITY_IMPLICATION(startOffset < m_len);
155
156         TextRun result = *this;
157
158         if (is8Bit()) {
159             result.setText(data8(startOffset), length);
160             return result;
161         }
162         result.setText(data16(startOffset), length);
163         return result;
164     }
165
166     UChar operator[](unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_len); return is8Bit() ? m_data.characters8[i] :m_data.characters16[i]; }
167     const LChar* data8(unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_len); ASSERT(is8Bit()); return &m_data.characters8[i]; }
168     const UChar* data16(unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_len); ASSERT(!is8Bit()); return &m_data.characters16[i]; }
169
170     const LChar* characters8() const { ASSERT(is8Bit()); return m_data.characters8; }
171     const UChar* characters16() const { ASSERT(!is8Bit()); return m_data.characters16; }
172     
173     bool is8Bit() const { return m_is8Bit; }
174     int length() const { return m_len; }
175     int charactersLength() const { return m_charactersLength; }
176     String string() const
177     {
178         if (is8Bit())
179             return String(m_data.characters8, m_len);
180         return String(m_data.characters16, m_len);
181     }
182
183     void setText(const LChar* c, unsigned len) { m_data.characters8 = c; m_len = len; m_is8Bit = true;}
184     void setText(const UChar* c, unsigned len) { m_data.characters16 = c; m_len = len; m_is8Bit = false;}
185     void setText(StringView);
186     void setCharactersLength(unsigned charactersLength) { m_charactersLength = charactersLength; }
187
188     float horizontalGlyphStretch() const { return m_horizontalGlyphStretch; }
189     void setHorizontalGlyphStretch(float scale) { m_horizontalGlyphStretch = scale; }
190
191     bool allowTabs() const { return m_allowTabs; }
192     unsigned tabSize() const { return m_tabSize; }
193     void setTabSize(bool, unsigned);
194
195     float xPos() const { return m_xpos; }
196     void setXPos(float xPos) { m_xpos = xPos; }
197     float expansion() const { return m_expansion; }
198     bool allowsLeadingExpansion() const { return m_expansionBehavior & AllowLeadingExpansion; }
199     bool allowsTrailingExpansion() const { return m_expansionBehavior & AllowTrailingExpansion; }
200     TextDirection direction() const { return static_cast<TextDirection>(m_direction); }
201     bool rtl() const { return m_direction == RTL; }
202     bool ltr() const { return m_direction == LTR; }
203     bool directionalOverride() const { return m_directionalOverride; }
204     bool characterScanForCodePath() const { return m_characterScanForCodePath; }
205     bool applyRunRounding() const { return m_applyRunRounding; }
206     bool applyWordRounding() const { return m_applyWordRounding; }
207     bool spacingDisabled() const { return m_disableSpacing; }
208
209     void disableSpacing() { m_disableSpacing = true; }
210     void disableRoundingHacks() { m_applyRunRounding = m_applyWordRounding = false; }
211     void setDirection(TextDirection direction) { m_direction = direction; }
212     void setDirectionalOverride(bool override) { m_directionalOverride = override; }
213     void setCharacterScanForCodePath(bool scan) { m_characterScanForCodePath = scan; }
214
215     class RenderingContext : public RefCounted<RenderingContext> {
216     public:
217         virtual ~RenderingContext() { }
218
219 #if ENABLE(SVG_FONTS)
220         virtual GlyphData glyphDataForCharacter(const Font&, WidthIterator&, UChar32 character, bool mirror, int currentCharacter, unsigned& advanceLength, String& normalizedSpacesStringCache) = 0;
221         virtual void drawSVGGlyphs(GraphicsContext*, const SimpleFontData*, const GlyphBuffer&, int from, int to, const FloatPoint&) const = 0;
222         virtual float floatWidthUsingSVGFont(const Font&, const TextRun&, int& charsConsumed, String& glyphName) const = 0;
223         virtual bool applySVGKerning(const SimpleFontData*, WidthIterator&, GlyphBuffer*, int from) const = 0;
224         virtual std::unique_ptr<GlyphToPathTranslator> createGlyphToPathTranslator(const SimpleFontData&, const TextRun*, const GlyphBuffer&, int from, int numGlyphs, const FloatPoint&) const = 0;
225 #endif
226     };
227
228     RenderingContext* renderingContext() const { return m_renderingContext.get(); }
229     void setRenderingContext(PassRefPtr<RenderingContext> context) { m_renderingContext = context; }
230
231     WEBCORE_EXPORT static void setAllowsRoundingHacks(bool);
232     WEBCORE_EXPORT static bool allowsRoundingHacks();
233
234 private:
235     static bool s_allowsRoundingHacks;
236
237     union {
238         const LChar* characters8;
239         const UChar* characters16;
240     } m_data;
241
242     RefPtr<RenderingContext> m_renderingContext;
243
244     unsigned m_charactersLength; // Marks the end of the characters buffer. Default equals to m_len.
245     unsigned m_len;
246
247     unsigned m_tabSize;
248
249     // m_xpos is the x position relative to the left start of the text line, not relative to the left
250     // start of the containing block. In the case of right alignment or center alignment, left start of
251     // the text line is not the same as left start of the containing block.
252     float m_xpos;  
253     float m_horizontalGlyphStretch;
254
255     float m_expansion;
256     ExpansionBehavior m_expansionBehavior : 2;
257     unsigned m_is8Bit : 1;
258     unsigned m_allowTabs : 1;
259     unsigned m_direction : 1;
260     unsigned m_directionalOverride : 1; // Was this direction set by an override character.
261     unsigned m_characterScanForCodePath : 1;
262     unsigned m_applyRunRounding : 1;
263     unsigned m_applyWordRounding : 1;
264     unsigned m_disableSpacing : 1;
265 };
266
267 inline void TextRun::setTabSize(bool allow, unsigned size)
268 {
269     m_allowTabs = allow;
270     m_tabSize = size;
271 }
272
273 inline void TextRun::setText(StringView string)
274 {
275     m_len = string.length();
276     m_is8Bit = string.is8Bit();
277     if (string.is8Bit())
278         m_data.characters8 = string.characters8();
279     else
280         m_data.characters16 = string.characters16();
281 }
282
283 }
284
285 #endif