7a481d2e72333e6da645689e2443b6f7a6534942
[WebKit.git] / Source / WebCore / platform / graphics / FontCascade.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 FontCascade_h
26 #define FontCascade_h
27
28 #include "DashArray.h"
29 #include "Font.h"
30 #include "FontCascadeFonts.h"
31 #include "FontDescription.h"
32 #include "Path.h"
33 #include "TextDirection.h"
34 #include "TypesettingFeatures.h"
35 #include <wtf/HashMap.h>
36 #include <wtf/HashSet.h>
37 #include <wtf/WeakPtr.h>
38 #include <wtf/unicode/CharacterNames.h>
39
40 // "X11/X.h" defines Complex to 0 and conflicts
41 // with Complex value in CodePath enum.
42 #ifdef Complex
43 #undef Complex
44 #endif
45
46 namespace WebCore {
47
48 class FloatPoint;
49 class FloatRect;
50 class FontData;
51 class FontMetrics;
52 class FontPlatformData;
53 class FontSelector;
54 class GlyphBuffer;
55 class GraphicsContext;
56 class LayoutRect;
57 class RenderText;
58 class TextLayout;
59 class TextRun;
60
61 struct GlyphData;
62
63 struct GlyphOverflow {
64     GlyphOverflow()
65         : left(0)
66         , right(0)
67         , top(0)
68         , bottom(0)
69         , computeBounds(false)
70     {
71     }
72
73     inline bool isEmpty()
74     {
75         return !left && !right && !top && !bottom;
76     }
77
78     inline void extendTo(const GlyphOverflow& other)
79     {
80         left = std::max(left, other.left);
81         right = std::max(right, other.right);
82         top = std::max(top, other.top);
83         bottom = std::max(bottom, other.bottom);
84     }
85
86     bool operator!=(const GlyphOverflow& other)
87     {
88         return left != other.left || right != other.right || top != other.top || bottom != other.bottom;
89     }
90
91     int left;
92     int right;
93     int top;
94     int bottom;
95     bool computeBounds;
96 };
97
98 class GlyphToPathTranslator {
99 public:
100     enum class GlyphUnderlineType {SkipDescenders, SkipGlyph, DrawOverGlyph};
101     virtual bool containsMorePaths() = 0;
102     virtual Path path() = 0;
103     virtual std::pair<float, float> extents() = 0;
104     virtual GlyphUnderlineType underlineType() = 0;
105     virtual void advance() = 0;
106     virtual ~GlyphToPathTranslator() { }
107 };
108 GlyphToPathTranslator::GlyphUnderlineType computeUnderlineType(const TextRun&, const GlyphBuffer&, int index);
109
110 class FontCascade {
111 public:
112     WEBCORE_EXPORT FontCascade();
113     WEBCORE_EXPORT FontCascade(const FontDescription&, float letterSpacing, float wordSpacing);
114     // This constructor is only used if the platform wants to start with a native font.
115     WEBCORE_EXPORT FontCascade(const FontPlatformData&, FontSmoothingMode = AutoSmoothing);
116
117     // FIXME: We should make this constructor platform-independent.
118 #if PLATFORM(IOS)
119     FontCascade(const FontPlatformData&, PassRefPtr<FontSelector>);
120 #endif
121     ~FontCascade();
122
123     FontCascade(const FontCascade&);
124     WEBCORE_EXPORT FontCascade& operator=(const FontCascade&);
125
126     WEBCORE_EXPORT bool operator==(const FontCascade& other) const;
127     bool operator!=(const FontCascade& other) const { return !(*this == other); }
128
129     const FontDescription& fontDescription() const { return m_fontDescription; }
130
131     int pixelSize() const { return fontDescription().computedPixelSize(); }
132     float size() const { return fontDescription().computedSize(); }
133
134     void update(PassRefPtr<FontSelector>) const;
135
136     enum CustomFontNotReadyAction { DoNotPaintIfFontNotReady, UseFallbackIfFontNotReady };
137     WEBCORE_EXPORT float drawText(GraphicsContext*, const TextRun&, const FloatPoint&, int from = 0, int to = -1, CustomFontNotReadyAction = DoNotPaintIfFontNotReady) const;
138     void drawGlyphs(GraphicsContext*, const Font*, const GlyphBuffer&, int from, int numGlyphs, const FloatPoint&) const;
139     void drawEmphasisMarks(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from = 0, int to = -1) const;
140
141     DashArray dashesForIntersectionsWithRect(const TextRun&, const FloatPoint& textOrigin, const FloatRect& lineExtents) const;
142
143     WEBCORE_EXPORT float width(const TextRun&, HashSet<const Font*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
144     float width(const TextRun&, int& charsConsumed, String& glyphName) const;
145
146     PassOwnPtr<TextLayout> createLayout(RenderText*, float xPos, bool collapseWhiteSpace) const;
147     static void deleteLayout(TextLayout*);
148     static float width(TextLayout&, unsigned from, unsigned len, HashSet<const Font*>* fallbackFonts = 0);
149
150     int offsetForPosition(const TextRun&, float position, bool includePartialGlyphs) const;
151     void adjustSelectionRectForText(const TextRun&, LayoutRect& selectionRect, int from = 0, int to = -1) const;
152
153     bool isSmallCaps() const { return m_fontDescription.smallCaps(); }
154
155     float wordSpacing() const { return m_wordSpacing; }
156     float letterSpacing() const { return m_letterSpacing; }
157     void setWordSpacing(float s) { m_wordSpacing = s; }
158     void setLetterSpacing(float s) { m_letterSpacing = s; }
159     bool isFixedPitch() const;
160     
161     FontRenderingMode renderingMode() const { return m_fontDescription.renderingMode(); }
162
163     TypesettingFeatures typesettingFeatures() const { return static_cast<TypesettingFeatures>(m_typesettingFeatures); }
164
165     const AtomicString& firstFamily() const { return m_fontDescription.firstFamily(); }
166     unsigned familyCount() const { return m_fontDescription.familyCount(); }
167     const AtomicString& familyAt(unsigned i) const { return m_fontDescription.familyAt(i); }
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_fonts->isForPlatformFont(); }
174
175     const FontMetrics& fontMetrics() const { return primaryFont().fontMetrics(); }
176     float spaceWidth() const { return primaryFont().spaceWidth() + m_letterSpacing; }
177     float tabWidth(const Font&, unsigned tabSize, float position) const;
178     float tabWidth(unsigned tabSize, float position) const { return tabWidth(primaryFont(), tabSize, position); }
179     bool hasValidAverageCharWidth() const;
180     bool fastAverageCharWidthIfAvailable(float &width) const; // returns true on success
181
182     int emphasisMarkAscent(const AtomicString&) const;
183     int emphasisMarkDescent(const AtomicString&) const;
184     int emphasisMarkHeight(const AtomicString&) const;
185
186     const Font& primaryFont() const;
187     const FontRanges& fallbackRangesAt(unsigned) const;
188     GlyphData glyphDataForCharacter(UChar32, bool mirror, FontVariant = AutoVariant) const;
189     
190 #if PLATFORM(COCOA)
191     const Font* fontForCombiningCharacterSequence(const UChar*, size_t length, FontVariant) const;
192 #endif
193
194     static bool isCJKIdeograph(UChar32);
195     static bool isCJKIdeographOrSymbol(UChar32);
196
197     // BEWARE: If isAfterExpansion is true after this function call, then the returned value includes a trailing opportunity
198     // which may or may not actually be present. RenderBlockFlow::computeInlineDirectionPositionsForSegment() compensates
199     // for this by decrementing the returned value if isAfterExpansion is true at the end of a line.
200     static unsigned expansionOpportunityCount(const StringView&, TextDirection, bool& isAfterExpansion);
201
202     WEBCORE_EXPORT static void setShouldUseSmoothing(bool);
203     WEBCORE_EXPORT static bool shouldUseSmoothing();
204
205     enum CodePath { Auto, Simple, Complex, SimpleWithGlyphOverflow };
206     CodePath codePath(const TextRun&) const;
207     static CodePath characterRangeCodePath(const LChar*, unsigned) { return Simple; }
208     static CodePath characterRangeCodePath(const UChar*, unsigned len);
209
210     bool primaryFontIsSystemFont() const;
211
212     WeakPtr<FontCascade> createWeakPtr() const { return m_weakPtrFactory.createWeakPtr(); }
213
214 private:
215     enum ForTextEmphasisOrNot { NotForTextEmphasis, ForTextEmphasis };
216
217     // Returns the initial in-stream advance.
218     float getGlyphsAndAdvancesForSimpleText(const TextRun&, int from, int to, GlyphBuffer&, ForTextEmphasisOrNot = NotForTextEmphasis) const;
219     float drawSimpleText(GraphicsContext*, const TextRun&, const FloatPoint&, int from, int to) const;
220     void drawEmphasisMarksForSimpleText(GraphicsContext*, const TextRun&, const AtomicString& mark, const FloatPoint&, int from, int to) const;
221     void drawGlyphBuffer(GraphicsContext*, const TextRun&, const GlyphBuffer&, FloatPoint&) const;
222     void drawEmphasisMarks(GraphicsContext*, const TextRun&, const GlyphBuffer&, const AtomicString&, const FloatPoint&) const;
223     float floatWidthForSimpleText(const TextRun&, HashSet<const Font*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
224     int offsetForPositionForSimpleText(const TextRun&, float position, bool includePartialGlyphs) const;
225     void adjustSelectionRectForSimpleText(const TextRun&, LayoutRect& selectionRect, 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     float 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 Font*>* fallbackFonts = 0, GlyphOverflow* = 0) const;
237     int offsetForPositionForComplexText(const TextRun&, float position, bool includePartialGlyphs) const;
238     void adjustSelectionRectForComplexText(const TextRun&, LayoutRect& selectionRect, int from, int to) const;
239
240     static unsigned expansionOpportunityCountInternal(const LChar*, size_t length, TextDirection, bool& isAfterExpansion);
241     static unsigned expansionOpportunityCountInternal(const UChar*, size_t length, TextDirection, bool& isAfterExpansion);
242
243     friend struct WidthIterator;
244     friend class SVGTextRunRenderingContext;
245
246 public:
247 #if ENABLE(IOS_TEXT_AUTOSIZING)
248     bool equalForTextAutoSizing(const FontCascade& other) const
249     {
250         return m_fontDescription.equalForTextAutoSizing(other.m_fontDescription)
251             && m_letterSpacing == other.m_letterSpacing
252             && m_wordSpacing == other.m_wordSpacing;
253     }
254 #endif
255
256     // Useful for debugging the different font rendering code paths.
257     WEBCORE_EXPORT static void setCodePath(CodePath);
258     static CodePath codePath();
259     static CodePath s_codePath;
260
261     WEBCORE_EXPORT static void setDefaultTypesettingFeatures(TypesettingFeatures);
262     static TypesettingFeatures defaultTypesettingFeatures();
263
264     static const uint8_t s_roundingHackCharacterTable[256];
265     static bool isRoundingHackCharacter(UChar32 c)
266     {
267         return !(c & ~0xFF) && s_roundingHackCharacterTable[c];
268     }
269
270     FontSelector* fontSelector() const;
271     static bool treatAsSpace(UChar c) { return c == ' ' || c == '\t' || c == '\n' || c == noBreakSpace; }
272     static bool treatAsZeroWidthSpace(UChar c) { return treatAsZeroWidthSpaceInComplexScript(c) || c == 0x200c || c == 0x200d; }
273     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; }
274     static bool canReceiveTextEmphasis(UChar32);
275
276     static inline UChar normalizeSpaces(UChar character)
277     {
278         if (treatAsSpace(character))
279             return space;
280
281         if (treatAsZeroWidthSpace(character))
282             return zeroWidthSpace;
283
284         return character;
285     }
286
287     static String normalizeSpaces(const LChar*, unsigned length);
288     static String normalizeSpaces(const UChar*, unsigned length);
289
290     bool useBackslashAsYenSymbol() const { return m_useBackslashAsYenSymbol; }
291     FontCascadeFonts* fonts() const { return m_fonts.get(); }
292
293 private:
294     bool isLoadingCustomFonts() const;
295
296     TypesettingFeatures computeTypesettingFeatures() const
297     {
298         TextRenderingMode textRenderingMode = m_fontDescription.textRenderingMode();
299         TypesettingFeatures features = s_defaultTypesettingFeatures;
300
301         switch (textRenderingMode) {
302         case AutoTextRendering:
303             break;
304         case OptimizeSpeed:
305             features &= ~(Kerning | Ligatures);
306             break;
307         case GeometricPrecision:
308         case OptimizeLegibility:
309             features |= Kerning | Ligatures;
310             break;
311         }
312
313         switch (m_fontDescription.kerning()) {
314         case FontDescription::NoneKerning:
315             features &= ~Kerning;
316             break;
317         case FontDescription::NormalKerning:
318             features |= Kerning;
319             break;
320         case FontDescription::AutoKerning:
321             break;
322         }
323
324         switch (m_fontDescription.commonLigaturesState()) {
325         case FontDescription::DisabledLigaturesState:
326             features &= ~Ligatures;
327             break;
328         case FontDescription::EnabledLigaturesState:
329             features |= Ligatures;
330             break;
331         case FontDescription::NormalLigaturesState:
332             break;
333         }
334
335         return features;
336     }
337
338     static TypesettingFeatures s_defaultTypesettingFeatures;
339
340     FontDescription m_fontDescription;
341     mutable RefPtr<FontCascadeFonts> m_fonts;
342     WeakPtrFactory<FontCascade> m_weakPtrFactory;
343     float m_letterSpacing;
344     float m_wordSpacing;
345     mutable bool m_useBackslashAsYenSymbol;
346     mutable unsigned m_typesettingFeatures : 2; // (TypesettingFeatures) Caches values computed from m_fontDescription.
347 };
348
349 void invalidateFontCascadeCache();
350 void pruneUnreferencedEntriesFromFontCascadeCache();
351 void pruneSystemFallbackFonts();
352 void clearWidthCaches();
353
354 inline FontCascade::~FontCascade()
355 {
356 }
357
358 inline const Font& FontCascade::primaryFont() const
359 {
360     ASSERT(m_fonts);
361     return m_fonts->primaryFont(m_fontDescription);
362 }
363
364 inline const FontRanges& FontCascade::fallbackRangesAt(unsigned index) const
365 {
366     ASSERT(m_fonts);
367     return m_fonts->realizeFallbackRangesAt(m_fontDescription, index);
368 }
369
370 inline bool FontCascade::isFixedPitch() const
371 {
372     ASSERT(m_fonts);
373     return m_fonts->isFixedPitch(m_fontDescription);
374 }
375
376 inline FontSelector* FontCascade::fontSelector() const
377 {
378     return m_fonts ? m_fonts->fontSelector() : 0;
379 }
380
381 inline float FontCascade::tabWidth(const Font& font, unsigned tabSize, float position) const
382 {
383     if (!tabSize)
384         return letterSpacing();
385     float tabWidth = tabSize * font.spaceWidth() + letterSpacing();
386     float tabDeltaWidth = tabWidth - fmodf(position, tabWidth);
387     return (tabDeltaWidth < font.spaceWidth() / 2) ? tabWidth : tabDeltaWidth;
388 }
389
390 }
391
392 namespace WTF {
393
394 template <> void deleteOwnedPtr<WebCore::TextLayout>(WebCore::TextLayout*);
395
396 }
397
398 #endif