27121e90cbcda1dc8d46842a43eb21a1cccecb14
[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 "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     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)
56         : m_text(s)
57         , m_charactersLength(s.length())
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     explicit TextRun(const String& s)
74         : TextRun(StringView(s))
75     {
76     }
77
78     TextRun(const LChar* c, unsigned len)
79         : TextRun(StringView(c, len))
80     {
81     }
82
83     TextRun(const UChar* c, unsigned len)
84         : TextRun(StringView(c, len))
85     {
86     }
87
88     TextRun subRun(unsigned startOffset, unsigned length) const
89     {
90         ASSERT_WITH_SECURITY_IMPLICATION(startOffset < m_text.length());
91
92         TextRun result = *this;
93
94         if (is8Bit()) {
95             result.setText(data8(startOffset), length);
96             return result;
97         }
98         result.setText(data16(startOffset), length);
99         return result;
100     }
101
102     UChar operator[](unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_text.length()); return m_text[i]; }
103     const LChar* data8(unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_text.length()); ASSERT(is8Bit()); return &m_text.characters8()[i]; }
104     const UChar* data16(unsigned i) const { ASSERT_WITH_SECURITY_IMPLICATION(i < m_text.length()); ASSERT(!is8Bit()); return &m_text.characters16()[i]; }
105
106     const LChar* characters8() const { ASSERT(is8Bit()); return m_text.characters8(); }
107     const UChar* characters16() const { ASSERT(!is8Bit()); return m_text.characters16(); }
108
109     bool is8Bit() const { return m_text.is8Bit(); }
110     unsigned length() const { return m_text.length(); }
111     unsigned charactersLength() const { return m_charactersLength; }
112     String string() const { return m_text.toString(); }
113
114     void setText(const LChar* c, unsigned len) { m_text = StringView(c, len); }
115     void setText(const UChar* c, unsigned len) { m_text = StringView(c, len); }
116     void setText(StringView stringView) { m_text = stringView; }
117     void setCharactersLength(unsigned charactersLength) { m_charactersLength = charactersLength; }
118
119     float horizontalGlyphStretch() const { return m_horizontalGlyphStretch; }
120     void setHorizontalGlyphStretch(float scale) { m_horizontalGlyphStretch = scale; }
121
122     bool allowTabs() const { return m_allowTabs; }
123     unsigned tabSize() const { return m_tabSize; }
124     void setTabSize(bool, unsigned);
125
126     float xPos() const { return m_xpos; }
127     void setXPos(float xPos) { m_xpos = xPos; }
128     float expansion() const { return m_expansion; }
129     ExpansionBehavior expansionBehavior() const { return m_expansionBehavior; }
130     TextDirection direction() const { return static_cast<TextDirection>(m_direction); }
131     bool rtl() const { return m_direction == RTL; }
132     bool ltr() const { return m_direction == LTR; }
133     bool directionalOverride() const { return m_directionalOverride; }
134     bool characterScanForCodePath() const { return m_characterScanForCodePath; }
135     bool applyRunRounding() const { return m_applyRunRounding; }
136     bool applyWordRounding() const { return m_applyWordRounding; }
137     bool spacingDisabled() const { return m_disableSpacing; }
138
139     void disableSpacing() { m_disableSpacing = true; }
140     void disableRoundingHacks() { m_applyRunRounding = m_applyWordRounding = false; }
141     void setDirection(TextDirection direction) { m_direction = direction; }
142     void setDirectionalOverride(bool override) { m_directionalOverride = override; }
143     void setCharacterScanForCodePath(bool scan) { m_characterScanForCodePath = scan; }
144     StringView text() const { return m_text; }
145
146     class RenderingContext : public RefCounted<RenderingContext> {
147     public:
148         virtual ~RenderingContext() { }
149
150 #if ENABLE(SVG_FONTS)
151         virtual GlyphData glyphDataForCharacter(const FontCascade&, WidthIterator&, UChar32 character, bool mirror, int currentCharacter, unsigned& advanceLength, String& normalizedSpacesStringCache) = 0;
152         virtual void drawSVGGlyphs(GraphicsContext*, const Font*, const GlyphBuffer&, int from, int to, const FloatPoint&) const = 0;
153         virtual float floatWidthUsingSVGFont(const FontCascade&, const TextRun&, int& charsConsumed, String& glyphName) const = 0;
154         virtual bool applySVGKerning(const Font*, WidthIterator&, GlyphBuffer*, int from) const = 0;
155         virtual std::unique_ptr<GlyphToPathTranslator> createGlyphToPathTranslator(const Font&, const TextRun*, const GlyphBuffer&, int from, int numGlyphs, const FloatPoint&) const = 0;
156 #endif
157     };
158
159     RenderingContext* renderingContext() const { return m_renderingContext.get(); }
160     void setRenderingContext(PassRefPtr<RenderingContext> context) { m_renderingContext = context; }
161
162     WEBCORE_EXPORT static void setAllowsRoundingHacks(bool);
163     WEBCORE_EXPORT static bool allowsRoundingHacks();
164
165 private:
166     WEBCORE_EXPORT static bool s_allowsRoundingHacks;
167     
168     RefPtr<RenderingContext> m_renderingContext;
169
170     StringView m_text;
171     unsigned m_charactersLength; // Marks the end of the characters buffer. Default equals to length of m_text.
172
173     unsigned m_tabSize;
174
175     // m_xpos is the x position relative to the left start of the text line, not relative to the left
176     // start of the containing block. In the case of right alignment or center alignment, left start of
177     // the text line is not the same as left start of the containing block. This variable is only used
178     // to calculate the width of \t
179     float m_xpos;  
180     float m_horizontalGlyphStretch;
181
182     float m_expansion;
183     unsigned m_expansionBehavior : 4;
184     unsigned m_allowTabs : 1;
185     unsigned m_direction : 1;
186     unsigned m_directionalOverride : 1; // Was this direction set by an override character.
187     unsigned m_characterScanForCodePath : 1;
188     unsigned m_applyRunRounding : 1;
189     unsigned m_applyWordRounding : 1;
190     unsigned m_disableSpacing : 1;
191 };
192
193 inline void TextRun::setTabSize(bool allow, unsigned size)
194 {
195     m_allowTabs = allow;
196     m_tabSize = size;
197 }
198
199 }
200
201 #endif