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