Cleaned up the Font class in preparation for optimizing kerning and ligatures
[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 <QRawFont>
40 QT_BEGIN_NAMESPACE
41 class QTextLayout;
42 QT_END_NAMESPACE
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&, short letterSpacing, short 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     void drawText(GraphicsContext*, const TextRun&, const FloatPoint&, int from = 0, int to = -1) 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 m_typesettingFeatures; }
125
126     FontFamily& firstFamily() { return m_fontDescription.firstFamily(); }
127     const FontFamily& family() const { return m_fontDescription.family(); }
128
129     FontItalic italic() const { return m_fontDescription.italic(); }
130     FontWeight weight() const { return m_fontDescription.weight(); }
131     FontWidthVariant widthVariant() const { return m_fontDescription.widthVariant(); }
132
133     bool isPlatformFont() const { return m_isPlatformFont; }
134
135     // Metrics that we query the FontFallbackList for.
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     inline GlyphData glyphDataForCharacter(UChar32 c, bool mirror, FontDataVariant variant = AutoVariant) const
148     {
149         return glyphDataAndPageForCharacter(c, mirror, variant).first;
150     }
151 #if PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN))
152     const SimpleFontData* fontDataForCombiningCharacterSequence(const UChar*, size_t length, FontDataVariant) const;
153 #endif
154     std::pair<GlyphData, GlyphPage*> glyphDataAndPageForCharacter(UChar32, bool mirror, FontDataVariant = AutoVariant) const;
155     bool primaryFontHasGlyphForCharacter(UChar32) const;
156
157     static bool isCJKIdeograph(UChar32);
158     static bool isCJKIdeographOrSymbol(UChar32);
159
160     static unsigned expansionOpportunityCount(const LChar*, size_t length, TextDirection, bool& isAfterExpansion);
161     static unsigned expansionOpportunityCount(const UChar*, size_t length, TextDirection, bool& isAfterExpansion);
162
163 #if PLATFORM(QT)
164     QRawFont rawFont() const;
165     QFont syntheticFont() const;
166 #endif
167
168     static void setShouldUseSmoothing(bool);
169     static bool shouldUseSmoothing();
170
171     enum CodePath { Auto, Simple, Complex, SimpleWithGlyphOverflow };
172     CodePath codePath(const TextRun&) const;
173     static CodePath characterRangeCodePath(const LChar*, unsigned) { return Simple; }
174     static CodePath characterRangeCodePath(const UChar*, unsigned len);
175     
176 private:
177     enum ForTextEmphasisOrNot { NotForTextEmphasis, ForTextEmphasis };
178
179     // Returns the initial in-stream advance.
180     float getGlyphsAndAdvancesForSimpleText(const TextRun&, int from, int to, GlyphBuffer&, ForTextEmphasisOrNot = NotForTextEmphasis) const;
181     void drawSimpleText(GraphicsContext*, const TextRun&, const FloatPoint&, int from, int to) const;
182     void drawEmphasisMarksForSimpleText(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from, int to) const;
183     void drawGlyphs(GraphicsContext*, const SimpleFontData*, const GlyphBuffer&, int from, int to, const FloatPoint&) const;
184     void drawGlyphBuffer(GraphicsContext*, const TextRun&, const GlyphBuffer&, const FloatPoint&) const;
185     void drawEmphasisMarks(GraphicsContext*, const TextRun&, const GlyphBuffer&, const AtomicString&, const FloatPoint&) const;
186     float floatWidthForSimpleText(const TextRun&, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
187     int offsetForPositionForSimpleText(const TextRun&, float position, bool includePartialGlyphs) const;
188     FloatRect selectionRectForSimpleText(const TextRun&, const FloatPoint&, int h, int from, int to) const;
189
190     bool getEmphasisMarkGlyphData(const AtomicString&, GlyphData&) const;
191
192     static bool canReturnFallbackFontsForComplexText();
193     static bool canExpandAroundIdeographsInComplexText();
194
195     // Returns the initial in-stream advance.
196     float getGlyphsAndAdvancesForComplexText(const TextRun&, int from, int to, GlyphBuffer&, ForTextEmphasisOrNot = NotForTextEmphasis) const;
197     void drawComplexText(GraphicsContext*, const TextRun&, const FloatPoint&, int from, int to) const;
198     void drawEmphasisMarksForComplexText(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from, int to) const;
199     float floatWidthForComplexText(const TextRun&, HashSet<const SimpleFontData*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
200     int offsetForPositionForComplexText(const TextRun&, float position, bool includePartialGlyphs) const;
201     FloatRect selectionRectForComplexText(const TextRun&, const FloatPoint&, int h, int from, int to) const;
202
203     friend struct WidthIterator;
204     friend class SVGTextRunRenderingContext;
205
206 public:
207     // Useful for debugging the different font rendering code paths.
208     static void setCodePath(CodePath);
209     static CodePath codePath();
210     static CodePath s_codePath;
211
212     static void setDefaultTypesettingFeatures(TypesettingFeatures);
213     static TypesettingFeatures defaultTypesettingFeatures();
214
215     static const uint8_t s_roundingHackCharacterTable[256];
216     static bool isRoundingHackCharacter(UChar32 c)
217     {
218         return !(c & ~0xFF) && s_roundingHackCharacterTable[c];
219     }
220
221     FontSelector* fontSelector() const;
222     static bool treatAsSpace(UChar c) { return c == ' ' || c == '\t' || c == '\n' || c == noBreakSpace; }
223     static bool treatAsZeroWidthSpace(UChar c) { return treatAsZeroWidthSpaceInComplexScript(c) || c == 0x200c || c == 0x200d; }
224     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; }
225     static bool canReceiveTextEmphasis(UChar32 c);
226
227     static inline UChar normalizeSpaces(UChar character)
228     {
229         if (treatAsSpace(character))
230             return space;
231
232         if (treatAsZeroWidthSpace(character))
233             return zeroWidthSpace;
234
235         return character;
236     }
237
238     static String normalizeSpaces(const LChar*, unsigned length);
239     static String normalizeSpaces(const UChar*, unsigned length);
240
241     bool needsTranscoding() const { return m_needsTranscoding; }
242     FontFallbackList* fontList() const { return m_fontFallbackList.get(); }
243
244 private:
245     bool loadingCustomFonts() const
246     {
247         return m_fontFallbackList && m_fontFallbackList->loadingCustomFonts();
248     }
249
250     TypesettingFeatures computeTypesettingFeatures() const
251     {
252         TextRenderingMode textRenderingMode = m_fontDescription.textRenderingMode();
253         TypesettingFeatures features = s_defaultTypesettingFeatures;
254
255         switch (textRenderingMode) {
256         case AutoTextRendering:
257             break;
258         case OptimizeSpeed:
259             features &= ~(Kerning | Ligatures);
260             break;
261         case GeometricPrecision:
262         case OptimizeLegibility:
263             features |= Kerning | Ligatures;
264             break;
265         }
266
267         switch (m_fontDescription.kerning()) {
268         case FontDescription::NoneKerning:
269             features &= ~Kerning;
270             break;
271         case FontDescription::NormalKerning:
272             features |= Kerning;
273             break;
274         case FontDescription::AutoKerning:
275             break;
276         }
277
278         switch (m_fontDescription.commonLigaturesState()) {
279         case FontDescription::DisabledLigaturesState:
280             features &= ~Ligatures;
281             break;
282         case FontDescription::EnabledLigaturesState:
283             features |= Ligatures;
284             break;
285         case FontDescription::NormalLigaturesState:
286             break;
287         }
288
289         return features;
290     }
291
292 #if PLATFORM(QT)
293     void initFormatForTextLayout(QTextLayout*) const;
294 #endif
295
296     static TypesettingFeatures s_defaultTypesettingFeatures;
297
298     FontDescription m_fontDescription;
299     mutable RefPtr<FontFallbackList> m_fontFallbackList;
300     short m_letterSpacing;
301     short m_wordSpacing;
302     bool m_isPlatformFont;
303     bool m_needsTranscoding;
304     mutable TypesettingFeatures m_typesettingFeatures; // Caches values computed from m_fontDescription.
305 };
306
307 inline Font::~Font()
308 {
309 }
310
311 inline const SimpleFontData* Font::primaryFont() const
312 {
313     ASSERT(m_fontFallbackList);
314     return m_fontFallbackList->primarySimpleFontData(this);
315 }
316
317 inline const FontData* Font::fontDataAt(unsigned index) const
318 {
319     ASSERT(m_fontFallbackList);
320     return m_fontFallbackList->fontDataAt(this, index);
321 }
322
323 inline bool Font::isFixedPitch() const
324 {
325     ASSERT(m_fontFallbackList);
326     return m_fontFallbackList->isFixedPitch(this);
327 }
328
329 inline FontSelector* Font::fontSelector() const
330 {
331     return m_fontFallbackList ? m_fontFallbackList->fontSelector() : 0;
332 }
333
334 inline float Font::tabWidth(const SimpleFontData& fontData, unsigned tabSize, float position) const
335 {
336     if (!tabSize)
337         return letterSpacing();
338     float tabWidth = tabSize * fontData.spaceWidth() + letterSpacing();
339     return tabWidth - fmodf(position, tabWidth);
340 }
341
342 }
343
344 namespace WTF {
345
346 template <> void deleteOwnedPtr<WebCore::TextLayout>(WebCore::TextLayout*);
347
348 }
349
350 #endif