a fractional value of the css letter-spacing property is not rendered as expected
[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 "DashArray.h"
29 #include "FontDescription.h"
30 #include "FontGlyphs.h"
31 #include "SimpleFontData.h"
32 #include "TextDirection.h"
33 #include "TypesettingFeatures.h"
34 #include <wtf/HashMap.h>
35 #include <wtf/HashSet.h>
36 #include <wtf/MathExtras.h>
37 #include <wtf/unicode/CharacterNames.h>
38
39 // "X11/X.h" defines Complex to 0 and conflicts
40 // with Complex value in CodePath enum.
41 #ifdef Complex
42 #undef Complex
43 #endif
44
45 namespace WebCore {
46
47 class FloatPoint;
48 class FloatRect;
49 class FontData;
50 class FontMetrics;
51 class FontPlatformData;
52 class FontSelector;
53 class GlyphBuffer;
54 class GraphicsContext;
55 class RenderText;
56 class TextLayout;
57 class TextRun;
58
59 struct GlyphData;
60
61 struct GlyphOverflow {
62     GlyphOverflow()
63         : left(0)
64         , right(0)
65         , top(0)
66         , bottom(0)
67         , computeBounds(false)
68     {
69     }
70
71     int left;
72     int right;
73     int top;
74     int bottom;
75     bool computeBounds;
76 };
77
78
79 class Font {
80 public:
81     Font();
82     Font(const FontDescription&, float letterSpacing, float wordSpacing);
83     // This constructor is only used if the platform wants to start with a native font.
84     Font(const FontPlatformData&, bool isPrinting, FontSmoothingMode = AutoSmoothing);
85     ~Font();
86
87     Font(const Font&);
88     Font& operator=(const Font&);
89
90     bool operator==(const Font& other) const;
91     bool operator!=(const Font& other) const { return !(*this == other); }
92
93     const FontDescription& fontDescription() const { return m_fontDescription; }
94
95     int pixelSize() const { return fontDescription().computedPixelSize(); }
96     float size() const { return fontDescription().computedSize(); }
97
98     void update(PassRefPtr<FontSelector>) const;
99
100     enum CustomFontNotReadyAction { DoNotPaintIfFontNotReady, UseFallbackIfFontNotReady };
101     void drawText(GraphicsContext*, const TextRun&, const FloatPoint&, int from = 0, int to = -1, CustomFontNotReadyAction = DoNotPaintIfFontNotReady) const;
102     void drawEmphasisMarks(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from = 0, int to = -1) const;
103
104     DashArray dashesForIntersectionsWithRect(const TextRun&, const FloatPoint& textOrigin, int from, int to, const FloatRect& lineExtents) const;
105
106     float width(const TextRun&, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
107     float width(const TextRun&, int& charsConsumed, String& glyphName) const;
108
109     PassOwnPtr<TextLayout> createLayout(RenderText*, float xPos, bool collapseWhiteSpace) const;
110     static void deleteLayout(TextLayout*);
111     static float width(TextLayout&, unsigned from, unsigned len, HashSet<const SimpleFontData*>* fallbackFonts = 0);
112
113     int offsetForPosition(const TextRun&, float position, bool includePartialGlyphs) const;
114     FloatRect selectionRectForText(const TextRun&, const FloatPoint&, int h, int from = 0, int to = -1) const;
115
116     bool isSmallCaps() const { return m_fontDescription.smallCaps(); }
117
118     float wordSpacing() const { return m_wordSpacing; }
119     float letterSpacing() const { return m_letterSpacing; }
120     void setWordSpacing(float s) { m_wordSpacing = s; }
121     void setLetterSpacing(float s) { m_letterSpacing = s; }
122     bool isFixedPitch() const;
123     bool isPrinterFont() const { return m_fontDescription.usePrinterFont(); }
124     bool isSVGFont() const { return primaryFont()->isSVGFont(); }
125     
126     FontRenderingMode renderingMode() const { return m_fontDescription.renderingMode(); }
127
128     TypesettingFeatures typesettingFeatures() const { return static_cast<TypesettingFeatures>(m_typesettingFeatures); }
129
130     const AtomicString& firstFamily() const { return m_fontDescription.firstFamily(); }
131     unsigned familyCount() const { return m_fontDescription.familyCount(); }
132     const AtomicString& familyAt(unsigned i) const { return m_fontDescription.familyAt(i); }
133
134     FontItalic italic() const { return m_fontDescription.italic(); }
135     FontWeight weight() const { return m_fontDescription.weight(); }
136     FontWidthVariant widthVariant() const { return m_fontDescription.widthVariant(); }
137
138     bool isPlatformFont() const { return m_glyphs->isForPlatformFont(); }
139
140     const FontMetrics& fontMetrics() const { return primaryFont()->fontMetrics(); }
141     float spaceWidth() const { return primaryFont()->spaceWidth() + m_letterSpacing; }
142     float tabWidth(const SimpleFontData&, unsigned tabSize, float position) const;
143     float tabWidth(unsigned tabSize, float position) const { return tabWidth(*primaryFont(), tabSize, position); }
144
145     int emphasisMarkAscent(const AtomicString&) const;
146     int emphasisMarkDescent(const AtomicString&) const;
147     int emphasisMarkHeight(const AtomicString&) const;
148
149     const SimpleFontData* primaryFont() const;
150     const FontData* fontDataAt(unsigned) const;
151     GlyphData glyphDataForCharacter(UChar32 c, bool mirror, FontDataVariant variant = AutoVariant) const
152     {
153         return glyphDataAndPageForCharacter(c, mirror, variant).first;
154     }
155 #if PLATFORM(MAC)
156     const SimpleFontData* fontDataForCombiningCharacterSequence(const UChar*, size_t length, FontDataVariant) const;
157 #endif
158     std::pair<GlyphData, GlyphPage*> glyphDataAndPageForCharacter(UChar32 c, bool mirror, FontDataVariant variant) const
159     {
160         return m_glyphs->glyphDataAndPageForCharacter(m_fontDescription, c, mirror, variant);
161     }
162     bool primaryFontHasGlyphForCharacter(UChar32) const;
163
164     static bool isCJKIdeograph(UChar32);
165     static bool isCJKIdeographOrSymbol(UChar32);
166
167     static unsigned expansionOpportunityCount(const LChar*, size_t length, TextDirection, bool& isAfterExpansion);
168     static unsigned expansionOpportunityCount(const UChar*, size_t length, TextDirection, bool& isAfterExpansion);
169
170     static void setShouldUseSmoothing(bool);
171     static bool shouldUseSmoothing();
172
173     enum CodePath { Auto, Simple, Complex, SimpleWithGlyphOverflow };
174     CodePath codePath(const TextRun&) const;
175     static CodePath characterRangeCodePath(const LChar*, unsigned) { return Simple; }
176     static CodePath characterRangeCodePath(const UChar*, unsigned len);
177
178 private:
179     enum ForTextEmphasisOrNot { NotForTextEmphasis, ForTextEmphasis };
180
181     // Returns the initial in-stream advance.
182     float getGlyphsAndAdvancesForSimpleText(const TextRun&, int from, int to, GlyphBuffer&, ForTextEmphasisOrNot = NotForTextEmphasis) const;
183     void drawSimpleText(GraphicsContext*, const TextRun&, const FloatPoint&, int from, int to) const;
184     void drawEmphasisMarksForSimpleText(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from, int to) const;
185     void drawGlyphs(GraphicsContext*, const SimpleFontData*, const GlyphBuffer&, int from, int to, const FloatPoint&) const;
186     void drawGlyphBuffer(GraphicsContext*, const TextRun&, const GlyphBuffer&, const FloatPoint&) const;
187     void drawEmphasisMarks(GraphicsContext*, const TextRun&, const GlyphBuffer&, const AtomicString&, const FloatPoint&) const;
188     float floatWidthForSimpleText(const TextRun&, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
189     int offsetForPositionForSimpleText(const TextRun&, float position, bool includePartialGlyphs) const;
190     FloatRect selectionRectForSimpleText(const TextRun&, const FloatPoint&, int h, int from, int to) const;
191
192     bool getEmphasisMarkGlyphData(const AtomicString&, GlyphData&) const;
193
194     static bool canReturnFallbackFontsForComplexText();
195     static bool canExpandAroundIdeographsInComplexText();
196
197     // Returns the initial in-stream advance.
198     float getGlyphsAndAdvancesForComplexText(const TextRun&, int from, int to, GlyphBuffer&, ForTextEmphasisOrNot = NotForTextEmphasis) const;
199     void drawComplexText(GraphicsContext*, const TextRun&, const FloatPoint&, int from, int to) const;
200     void drawEmphasisMarksForComplexText(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from, int to) const;
201     float floatWidthForComplexText(const TextRun&, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
202     int offsetForPositionForComplexText(const TextRun&, float position, bool includePartialGlyphs) const;
203     FloatRect selectionRectForComplexText(const TextRun&, const FloatPoint&, int h, int from, int to) const;
204
205     friend struct WidthIterator;
206     friend class SVGTextRunRenderingContext;
207
208 public:
209 #if ENABLE(IOS_TEXT_AUTOSIZING)
210     bool equalForTextAutoSizing(const Font& other) const
211     {
212         return m_fontDescription.equalForTextAutoSizing(other.m_fontDescription)
213             && m_letterSpacing == other.m_letterSpacing
214             && m_wordSpacing == other.m_wordSpacing;
215     }
216 #endif
217
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 void setDefaultTypesettingFeatures(TypesettingFeatures);
224     static TypesettingFeatures defaultTypesettingFeatures();
225
226     static const uint8_t s_roundingHackCharacterTable[256];
227     static bool isRoundingHackCharacter(UChar32 c)
228     {
229         return !(c & ~0xFF) && s_roundingHackCharacterTable[c];
230     }
231
232     FontSelector* fontSelector() const;
233     static bool treatAsSpace(UChar c) { return c == ' ' || c == '\t' || c == '\n' || c == noBreakSpace; }
234     static bool treatAsZeroWidthSpace(UChar c) { return treatAsZeroWidthSpaceInComplexScript(c) || c == 0x200c || c == 0x200d; }
235     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; }
236     static bool canReceiveTextEmphasis(UChar32 c);
237
238     static inline UChar normalizeSpaces(UChar character)
239     {
240         if (treatAsSpace(character))
241             return space;
242
243         if (treatAsZeroWidthSpace(character))
244             return zeroWidthSpace;
245
246         return character;
247     }
248
249     static String normalizeSpaces(const LChar*, unsigned length);
250     static String normalizeSpaces(const UChar*, unsigned length);
251
252     bool useBackslashAsYenSymbol() const { return m_useBackslashAsYenSymbol; }
253     FontGlyphs* glyphs() const { return m_glyphs.get(); }
254
255 private:
256     bool loadingCustomFonts() const
257     {
258         return m_glyphs && m_glyphs->loadingCustomFonts();
259     }
260
261     TypesettingFeatures computeTypesettingFeatures() const
262     {
263         TextRenderingMode textRenderingMode = m_fontDescription.textRenderingMode();
264         TypesettingFeatures features = s_defaultTypesettingFeatures;
265
266         switch (textRenderingMode) {
267         case AutoTextRendering:
268             break;
269         case OptimizeSpeed:
270             features &= ~(Kerning | Ligatures);
271             break;
272         case GeometricPrecision:
273         case OptimizeLegibility:
274             features |= Kerning | Ligatures;
275             break;
276         }
277
278         switch (m_fontDescription.kerning()) {
279         case FontDescription::NoneKerning:
280             features &= ~Kerning;
281             break;
282         case FontDescription::NormalKerning:
283             features |= Kerning;
284             break;
285         case FontDescription::AutoKerning:
286             break;
287         }
288
289         switch (m_fontDescription.commonLigaturesState()) {
290         case FontDescription::DisabledLigaturesState:
291             features &= ~Ligatures;
292             break;
293         case FontDescription::EnabledLigaturesState:
294             features |= Ligatures;
295             break;
296         case FontDescription::NormalLigaturesState:
297             break;
298         }
299
300         return features;
301     }
302
303     static TypesettingFeatures s_defaultTypesettingFeatures;
304
305     FontDescription m_fontDescription;
306     mutable RefPtr<FontGlyphs> m_glyphs;
307     float m_letterSpacing;
308     float m_wordSpacing;
309     mutable bool m_useBackslashAsYenSymbol;
310     mutable unsigned m_typesettingFeatures : 2; // (TypesettingFeatures) Caches values computed from m_fontDescription.
311 };
312
313 void invalidateFontGlyphsCache();
314 void pruneUnreferencedEntriesFromFontGlyphsCache();
315 void clearWidthCaches();
316
317 inline Font::~Font()
318 {
319 }
320
321 inline const SimpleFontData* Font::primaryFont() const
322 {
323     ASSERT(m_glyphs);
324     return m_glyphs->primarySimpleFontData(m_fontDescription);
325 }
326
327 inline const FontData* Font::fontDataAt(unsigned index) const
328 {
329     ASSERT(m_glyphs);
330     return m_glyphs->realizeFontDataAt(m_fontDescription, index);
331 }
332
333 inline bool Font::isFixedPitch() const
334 {
335     ASSERT(m_glyphs);
336     return m_glyphs->isFixedPitch(m_fontDescription);
337 }
338
339 inline FontSelector* Font::fontSelector() const
340 {
341     return m_glyphs ? m_glyphs->fontSelector() : 0;
342 }
343
344 inline float Font::tabWidth(const SimpleFontData& fontData, unsigned tabSize, float position) const
345 {
346     if (!tabSize)
347         return letterSpacing();
348     float tabWidth = tabSize * fontData.spaceWidth() + letterSpacing();
349     return tabWidth - fmodf(position, tabWidth);
350 }
351
352 }
353
354 namespace WTF {
355
356 template <> void deleteOwnedPtr<WebCore::TextLayout>(WebCore::TextLayout*);
357
358 }
359
360 #endif