Move ExpansionBehaviorFlags and TextDirection to their own file
[WebKit.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 "TextFlags.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 FontCascade;
36 class GraphicsContext;
37 class GlyphBuffer;
38 class GlyphToPathTranslator;
39 class Font;
40
41 struct GlyphData;
42 struct WidthIterator;
43
44 class TextRun {
45     WTF_MAKE_FAST_ALLOCATED;
46 public:
47     enum RoundingHackFlags {
48         NoRounding = 0,
49         RunRounding = 1 << 0,
50         WordRounding = 1 << 1,
51     };
52
53     typedef unsigned RoundingHacks;
54
55     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)
56         : m_text(c, len)
57         , m_charactersLength(len)
58         , m_tabSize(0)
59         , m_xpos(xpos)
60         , m_horizontalGlyphStretch(1)
61         , m_expansion(expansion)
62         , m_expansionBehavior(expansionBehavior)
63         , m_allowTabs(false)
64         , m_direction(direction)
65         , m_directionalOverride(directionalOverride)
66         , m_characterScanForCodePath(characterScanForCodePath)
67         , m_applyRunRounding((roundingHacks & RunRounding) && s_allowsRoundingHacks)
68         , m_applyWordRounding((roundingHacks & WordRounding) && s_allowsRoundingHacks)
69         , m_disableSpacing(false)
70     {
71     }
72
73     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)
74         : m_text(c, len)
75         , m_charactersLength(len)
76         , m_tabSize(0)
77         , m_xpos(xpos)
78         , m_horizontalGlyphStretch(1)
79         , m_expansion(expansion)
80         , m_expansionBehavior(expansionBehavior)
81         , m_allowTabs(false)
82         , m_direction(direction)
83         , m_directionalOverride(directionalOverride)
84         , m_characterScanForCodePath(characterScanForCodePath)
85         , m_applyRunRounding((roundingHacks & RunRounding) && s_allowsRoundingHacks)
86         , m_applyWordRounding((roundingHacks & WordRounding) && s_allowsRoundingHacks)
87         , m_disableSpacing(false)
88     {
89     }
90     
91     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)
92         : m_text(StringView(s))
93         , m_charactersLength(s.length())
94         , m_tabSize(0)
95         , m_xpos(xpos)
96         , m_horizontalGlyphStretch(1)
97         , m_expansion(expansion)
98         , m_expansionBehavior(expansionBehavior)
99         , m_allowTabs(false)
100         , m_direction(direction)
101         , m_directionalOverride(directionalOverride)
102         , m_characterScanForCodePath(characterScanForCodePath)
103         , m_applyRunRounding((roundingHacks & RunRounding) && s_allowsRoundingHacks)
104         , m_applyWordRounding((roundingHacks & WordRounding) && s_allowsRoundingHacks)
105         , m_disableSpacing(false)
106     {
107     }
108
109     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)
110         : m_text(s)
111         , m_charactersLength(s.length())
112         , m_tabSize(0)
113         , m_xpos(xpos)
114         , m_horizontalGlyphStretch(1)
115         , m_expansion(expansion)
116         , m_expansionBehavior(expansionBehavior)
117         , m_allowTabs(false)
118         , m_direction(direction)
119         , m_directionalOverride(directionalOverride)
120         , m_characterScanForCodePath(characterScanForCodePath)
121         , m_applyRunRounding((roundingHacks & RunRounding) && s_allowsRoundingHacks)
122         , m_applyWordRounding((roundingHacks & WordRounding) && s_allowsRoundingHacks)
123         , m_disableSpacing(false)
124     {
125     }
126
127     TextRun subRun(unsigned startOffset, unsigned length) const
128     {
129         ASSERT_WITH_SECURITY_IMPLICATION(startOffset < m_text.length());
130
131         TextRun result = *this;
132
133         if (is8Bit()) {
134             result.setText(data8(startOffset), length);
135             return result;
136         }
137         result.setText(data16(startOffset), length);
138         return result;
139     }
140
141     UChar operator[](unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_text.length()); return m_text[i]; }
142     const LChar* data8(unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_text.length()); ASSERT(is8Bit()); return &m_text.characters8()[i]; }
143     const UChar* data16(unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_text.length()); ASSERT(!is8Bit()); return &m_text.characters16()[i]; }
144
145     const LChar* characters8() const { ASSERT(is8Bit()); return m_text.characters8(); }
146     const UChar* characters16() const { ASSERT(!is8Bit()); return m_text.characters16(); }
147
148     bool is8Bit() const { return m_text.is8Bit(); }
149     unsigned length() const { return m_text.length(); }
150     unsigned charactersLength() const { return m_charactersLength; }
151     String string() const { return m_text.toString(); }
152
153     void setText(const LChar* c, unsigned len) { m_text = StringView(c, len); }
154     void setText(const UChar* c, unsigned len) { m_text = StringView(c, len); }
155     void setText(StringView stringView) { m_text = stringView; }
156     void setCharactersLength(unsigned charactersLength) { m_charactersLength = charactersLength; }
157
158     float horizontalGlyphStretch() const { return m_horizontalGlyphStretch; }
159     void setHorizontalGlyphStretch(float scale) { m_horizontalGlyphStretch = scale; }
160
161     bool allowTabs() const { return m_allowTabs; }
162     unsigned tabSize() const { return m_tabSize; }
163     void setTabSize(bool, unsigned);
164
165     float xPos() const { return m_xpos; }
166     void setXPos(float xPos) { m_xpos = xPos; }
167     float expansion() const { return m_expansion; }
168     bool allowsLeadingExpansion() const { return m_expansionBehavior & AllowLeadingExpansion; }
169     bool allowsTrailingExpansion() const { return m_expansionBehavior & AllowTrailingExpansion; }
170     TextDirection direction() const { return static_cast<TextDirection>(m_direction); }
171     bool rtl() const { return m_direction == RTL; }
172     bool ltr() const { return m_direction == LTR; }
173     bool directionalOverride() const { return m_directionalOverride; }
174     bool characterScanForCodePath() const { return m_characterScanForCodePath; }
175     bool applyRunRounding() const { return m_applyRunRounding; }
176     bool applyWordRounding() const { return m_applyWordRounding; }
177     bool spacingDisabled() const { return m_disableSpacing; }
178
179     void disableSpacing() { m_disableSpacing = true; }
180     void disableRoundingHacks() { m_applyRunRounding = m_applyWordRounding = false; }
181     void setDirection(TextDirection direction) { m_direction = direction; }
182     void setDirectionalOverride(bool override) { m_directionalOverride = override; }
183     void setCharacterScanForCodePath(bool scan) { m_characterScanForCodePath = scan; }
184     StringView text() const { return m_text; }
185
186     class RenderingContext : public RefCounted<RenderingContext> {
187     public:
188         virtual ~RenderingContext() { }
189
190 #if ENABLE(SVG_FONTS)
191         virtual GlyphData glyphDataForCharacter(const FontCascade&, WidthIterator&, UChar32 character, bool mirror, int currentCharacter, unsigned& advanceLength, String& normalizedSpacesStringCache) = 0;
192         virtual void drawSVGGlyphs(GraphicsContext*, const Font*, const GlyphBuffer&, int from, int to, const FloatPoint&) const = 0;
193         virtual float floatWidthUsingSVGFont(const FontCascade&, const TextRun&, int& charsConsumed, String& glyphName) const = 0;
194         virtual bool applySVGKerning(const Font*, WidthIterator&, GlyphBuffer*, int from) const = 0;
195         virtual std::unique_ptr<GlyphToPathTranslator> createGlyphToPathTranslator(const Font&, const TextRun*, const GlyphBuffer&, int from, int numGlyphs, const FloatPoint&) const = 0;
196 #endif
197     };
198
199     RenderingContext* renderingContext() const { return m_renderingContext.get(); }
200     void setRenderingContext(PassRefPtr<RenderingContext> context) { m_renderingContext = context; }
201
202     WEBCORE_EXPORT static void setAllowsRoundingHacks(bool);
203     WEBCORE_EXPORT static bool allowsRoundingHacks();
204
205 private:
206     WEBCORE_EXPORT static bool s_allowsRoundingHacks;
207     
208     RefPtr<RenderingContext> m_renderingContext;
209
210     StringView m_text;
211     unsigned m_charactersLength; // Marks the end of the characters buffer. Default equals to length of m_text.
212
213     unsigned m_tabSize;
214
215     // m_xpos is the x position relative to the left start of the text line, not relative to the left
216     // start of the containing block. In the case of right alignment or center alignment, left start of
217     // the text line is not the same as left start of the containing block.
218     float m_xpos;  
219     float m_horizontalGlyphStretch;
220
221     float m_expansion;
222     ExpansionBehavior m_expansionBehavior : 2;
223     unsigned m_allowTabs : 1;
224     unsigned m_direction : 1;
225     unsigned m_directionalOverride : 1; // Was this direction set by an override character.
226     unsigned m_characterScanForCodePath : 1;
227     unsigned m_applyRunRounding : 1;
228     unsigned m_applyWordRounding : 1;
229     unsigned m_disableSpacing : 1;
230 };
231
232 inline void TextRun::setTabSize(bool allow, unsigned size)
233 {
234     m_allowTabs = allow;
235     m_tabSize = size;
236 }
237
238 }
239
240 #endif