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