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