[chromium] Font fallback in cr-win is wrong for string contains zero-width-space.
[WebKit-https.git] / Source / WebCore / platform / graphics / Font.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, 2010, 2011 Apple Inc. All rights reserved.
6  * Copyright (C) 2008 Holger Hans Peter Freyther
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef Font_h
26 #define Font_h
27
28 #include "FontDescription.h"
29 #include "FontFallbackList.h"
30 #include "SimpleFontData.h"
31 #include "TextDirection.h"
32 #include "TypesettingFeatures.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/MathExtras.h>
36 #include <wtf/unicode/CharacterNames.h>
37
38 #if PLATFORM(QT)
39 #include <QFont>
40 #endif
41
42 namespace WebCore {
43
44 class FloatPoint;
45 class FloatRect;
46 class FontData;
47 class FontMetrics;
48 class FontPlatformData;
49 class FontSelector;
50 class GlyphBuffer;
51 class GlyphPageTreeNode;
52 class GraphicsContext;
53 class TextRun;
54
55 struct GlyphData;
56
57 struct GlyphOverflow {
58     GlyphOverflow()
59         : left(0)
60         , right(0)
61         , top(0)
62         , bottom(0)
63         , computeBounds(false)
64     {
65     }
66
67     int left;
68     int right;
69     int top;
70     int bottom;
71     bool computeBounds;
72 };
73
74
75 class Font {
76 public:
77     Font();
78     Font(const FontDescription&, short letterSpacing, short wordSpacing);
79     // This constructor is only used if the platform wants to start with a native font.
80     Font(const FontPlatformData&, bool isPrinting, FontSmoothingMode = AutoSmoothing);
81     ~Font();
82
83     Font(const Font&);
84     Font& operator=(const Font&);
85
86     bool operator==(const Font& other) const;
87     bool operator!=(const Font& other) const { return !(*this == other); }
88
89     const FontDescription& fontDescription() const { return m_fontDescription; }
90
91     int pixelSize() const { return fontDescription().computedPixelSize(); }
92     float size() const { return fontDescription().computedSize(); }
93
94     void update(PassRefPtr<FontSelector>) const;
95
96     void drawText(GraphicsContext*, const TextRun&, const FloatPoint&, int from = 0, int to = -1) const;
97     void drawEmphasisMarks(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from = 0, int to = -1) const;
98
99     float width(const TextRun&, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
100     float width(const TextRun&, int& charsConsumed, String& glyphName) const;
101
102     int offsetForPosition(const TextRun&, float position, bool includePartialGlyphs) const;
103     FloatRect selectionRectForText(const TextRun&, const FloatPoint&, int h, int from = 0, int to = -1) const;
104
105     bool isSmallCaps() const { return m_fontDescription.smallCaps(); }
106
107     short wordSpacing() const { return m_wordSpacing; }
108     short letterSpacing() const { return m_letterSpacing; }
109     void setWordSpacing(short s) { m_wordSpacing = s; }
110     void setLetterSpacing(short s) { m_letterSpacing = s; }
111     bool isFixedPitch() const;
112     bool isPrinterFont() const { return m_fontDescription.usePrinterFont(); }
113     
114     FontRenderingMode renderingMode() const { return m_fontDescription.renderingMode(); }
115
116     TypesettingFeatures typesettingFeatures() const
117     {
118         TextRenderingMode textRenderingMode = m_fontDescription.textRenderingMode();
119         TypesettingFeatures features = textRenderingMode == OptimizeLegibility || textRenderingMode == GeometricPrecision ? Kerning | Ligatures : 0;
120
121         switch (m_fontDescription.kerning()) {
122         case FontDescription::NoneKerning:
123             features &= ~Kerning;
124             break;
125         case FontDescription::NormalKerning:
126             features |= Kerning;
127             break;
128         case FontDescription::AutoKerning:
129             break;
130         }
131
132         switch (m_fontDescription.commonLigaturesState()) {
133         case FontDescription::DisabledLigaturesState:
134             features &= ~Ligatures;
135             break;
136         case FontDescription::EnabledLigaturesState:
137             features |= Ligatures;
138             break;
139         case FontDescription::NormalLigaturesState:
140             break;
141         }
142
143         return features;
144     }
145
146     FontFamily& firstFamily() { return m_fontDescription.firstFamily(); }
147     const FontFamily& family() const { return m_fontDescription.family(); }
148
149     FontItalic italic() const { return m_fontDescription.italic(); }
150     FontWeight weight() const { return m_fontDescription.weight(); }
151     FontWidthVariant widthVariant() const { return m_fontDescription.widthVariant(); }
152
153     bool isPlatformFont() const { return m_isPlatformFont; }
154
155     // Metrics that we query the FontFallbackList for.
156     const FontMetrics& fontMetrics() const { return primaryFont()->fontMetrics(); }
157     float spaceWidth() const { return primaryFont()->spaceWidth() + m_letterSpacing; }
158     float tabWidth(const SimpleFontData& fontData) const { return 8 * fontData.spaceWidth() + letterSpacing(); }
159     int emphasisMarkAscent(const AtomicString&) const;
160     int emphasisMarkDescent(const AtomicString&) const;
161     int emphasisMarkHeight(const AtomicString&) const;
162
163     const SimpleFontData* primaryFont() const;
164     const FontData* fontDataAt(unsigned) const;
165     GlyphData glyphDataForCharacter(UChar32, bool mirror, FontDataVariant = AutoVariant) const;
166 #if PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN))
167     const SimpleFontData* fontDataForCombiningCharacterSequence(const UChar*, size_t length, FontDataVariant) const;
168 #endif
169     std::pair<GlyphData, GlyphPage*> glyphDataAndPageForCharacter(UChar32, bool mirror, FontDataVariant = AutoVariant) const;
170     bool primaryFontHasGlyphForCharacter(UChar32) const;
171
172     static bool isCJKIdeograph(UChar32);
173     static bool isCJKIdeographOrSymbol(UChar32);
174
175     static unsigned expansionOpportunityCount(const UChar*, size_t length, TextDirection, bool& isAfterExpansion);
176
177 #if PLATFORM(QT)
178     QFont font() const;
179 #endif
180
181     static void setShouldUseSmoothing(bool);
182     static bool shouldUseSmoothing();
183
184     enum CodePath { Auto, Simple, Complex, SimpleWithGlyphOverflow };
185     CodePath codePath(const TextRun&) const;
186
187 private:
188     enum ForTextEmphasisOrNot { NotForTextEmphasis, ForTextEmphasis };
189
190     // Returns the initial in-stream advance.
191     float getGlyphsAndAdvancesForSimpleText(const TextRun&, int from, int to, GlyphBuffer&, ForTextEmphasisOrNot = NotForTextEmphasis) const;
192     void drawSimpleText(GraphicsContext*, const TextRun&, const FloatPoint&, int from, int to) const;
193     void drawEmphasisMarksForSimpleText(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from, int to) const;
194     void drawGlyphs(GraphicsContext*, const SimpleFontData*, const GlyphBuffer&, int from, int to, const FloatPoint&) const;
195     void drawGlyphBuffer(GraphicsContext*, const TextRun&, const GlyphBuffer&, const FloatPoint&) const;
196     void drawEmphasisMarks(GraphicsContext*, const TextRun&, const GlyphBuffer&, const AtomicString&, const FloatPoint&) const;
197     float floatWidthForSimpleText(const TextRun&, GlyphBuffer*, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
198     int offsetForPositionForSimpleText(const TextRun&, float position, bool includePartialGlyphs) const;
199     FloatRect selectionRectForSimpleText(const TextRun&, const FloatPoint&, int h, int from, int to) const;
200
201     bool getEmphasisMarkGlyphData(const AtomicString&, GlyphData&) const;
202
203     static bool canReturnFallbackFontsForComplexText();
204     static bool canExpandAroundIdeographsInComplexText();
205
206     // Returns the initial in-stream advance.
207     float getGlyphsAndAdvancesForComplexText(const TextRun&, int from, int to, GlyphBuffer&, ForTextEmphasisOrNot = NotForTextEmphasis) const;
208     void drawComplexText(GraphicsContext*, const TextRun&, const FloatPoint&, int from, int to) const;
209     void drawEmphasisMarksForComplexText(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from, int to) const;
210     float floatWidthForComplexText(const TextRun&, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
211     int offsetForPositionForComplexText(const TextRun&, float position, bool includePartialGlyphs) const;
212     FloatRect selectionRectForComplexText(const TextRun&, const FloatPoint&, int h, int from, int to) const;
213
214     friend struct WidthIterator;
215     friend class SVGTextRunRenderingContext;
216
217 public:
218     // Useful for debugging the different font rendering code paths.
219     static void setCodePath(CodePath);
220     static CodePath codePath();
221     static CodePath s_codePath;
222
223     static const uint8_t s_roundingHackCharacterTable[256];
224     static bool isRoundingHackCharacter(UChar32 c)
225     {
226         return !(c & ~0xFF) && s_roundingHackCharacterTable[c];
227     }
228
229     FontSelector* fontSelector() const;
230     static bool treatAsSpace(UChar c) { return c == ' ' || c == '\t' || c == '\n' || c == noBreakSpace; }
231     static bool treatAsZeroWidthSpace(UChar c) { return treatAsZeroWidthSpaceInComplexScript(c) || c == 0x200c || c == 0x200d; }
232     static bool treatAsZeroWidthSpaceInComplexScript(UChar c) { return c < 0x20 || (c >= 0x7F && c < 0xA0) || c == softHyphen || c == zeroWidthSpace || (c >= 0x200e && c <= 0x200f) || (c >= 0x202a && c <= 0x202e) || c == zeroWidthNoBreakSpace || c == objectReplacementCharacter; }
233     static bool canReceiveTextEmphasis(UChar32 c);
234
235     static inline UChar normalizeSpaces(UChar character)
236     {
237         if (treatAsSpace(character))
238             return space;
239
240         if (treatAsZeroWidthSpace(character))
241             return zeroWidthSpace;
242
243         return character;
244     }
245
246     static String normalizeSpaces(const UChar*, unsigned length);
247
248     bool needsTranscoding() const { return m_needsTranscoding; }
249     FontFallbackList* fontList() const { return m_fontList.get(); }
250
251 private:
252     bool loadingCustomFonts() const
253     {
254         return m_fontList && m_fontList->loadingCustomFonts();
255     }
256
257     FontDescription m_fontDescription;
258     mutable RefPtr<FontFallbackList> m_fontList;
259     short m_letterSpacing;
260     short m_wordSpacing;
261     bool m_isPlatformFont;
262     bool m_needsTranscoding;
263 };
264
265 inline Font::~Font()
266 {
267 }
268
269 inline const SimpleFontData* Font::primaryFont() const
270 {
271     ASSERT(m_fontList);
272     return m_fontList->primarySimpleFontData(this);
273 }
274
275 inline const FontData* Font::fontDataAt(unsigned index) const
276 {
277     ASSERT(m_fontList);
278     return m_fontList->fontDataAt(this, index);
279 }
280
281 inline bool Font::isFixedPitch() const
282 {
283     ASSERT(m_fontList);
284     return m_fontList->isFixedPitch(this);
285 }
286
287 inline FontSelector* Font::fontSelector() const
288 {
289     return m_fontList ? m_fontList->fontSelector() : 0;
290 }
291
292 }
293
294 #endif