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