Unreviewed, roll out r187615 as it seems to have caused a ~1% PLT regression.
[WebKit-https.git] / Source / WebCore / platform / graphics / FontCache.h
1 /*
2  * Copyright (C) 2006, 2008 Apple Inc.  All rights reserved.
3  * Copyright (C) 2007-2008 Torch Mobile, Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef FontCache_h
31 #define FontCache_h
32
33 #include "FontDescription.h"
34 #include "Timer.h"
35 #include <array>
36 #include <limits.h>
37 #include <wtf/Forward.h>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/Vector.h>
41 #include <wtf/text/AtomicStringHash.h>
42 #include <wtf/text/WTFString.h>
43
44 #if PLATFORM(COCOA)
45 #include <CoreText/CTFont.h>
46 #endif
47
48 #if OS(WINDOWS)
49 #include <windows.h>
50 #include <objidl.h>
51 #include <mlang.h>
52 #endif
53
54 namespace WebCore {
55
56 class FontCascade;
57 class FontPlatformData;
58 class FontSelector;
59 class OpenTypeVerticalData;
60 class Font;
61
62 #if PLATFORM(WIN)
63 #if USE(IMLANG_FONT_LINK2)
64 typedef IMLangFontLink2 IMLangFontLinkType;
65 #else
66 typedef IMLangFontLink IMLangFontLinkType;
67 #endif
68 #endif
69
70 // This key contains the FontDescription fields other than family that matter when fetching FontDatas (platform fonts).
71 struct FontDescriptionKey {
72     FontDescriptionKey() = default;
73
74     FontDescriptionKey(const FontDescription& description)
75         : m_size(description.computedPixelSize())
76         , m_weight(description.weight())
77         , m_flags(makeFlagsKey(description))
78         , m_locale(description.locale())
79         , m_featureSettings(description.featureSettings())
80     { }
81
82     explicit FontDescriptionKey(WTF::HashTableDeletedValueType)
83         : m_size(cHashTableDeletedSize)
84     { }
85
86     bool operator==(const FontDescriptionKey& other) const
87     {
88         return m_size == other.m_size && m_weight == other.m_weight && m_flags == other.m_flags && m_locale == other.m_locale
89             && m_featureSettings == other.m_featureSettings;
90     }
91
92     bool operator!=(const FontDescriptionKey& other) const
93     {
94         return !(*this == other);
95     }
96
97     bool isHashTableDeletedValue() const { return m_size == cHashTableDeletedSize; }
98
99     inline unsigned computeHash() const
100     {
101         IntegerHasher hasher;
102         hasher.add(m_size);
103         hasher.add(m_weight);
104         for (unsigned flagItem : m_flags)
105             hasher.add(flagItem);
106         hasher.add(m_locale.isNull() ? 0 : m_locale.impl()->existingHash());
107         hasher.add(m_featureSettings.hash());
108         return hasher.hash();
109     }
110
111 private:
112     static std::array<unsigned, 2> makeFlagsKey(const FontDescription& description)
113     {
114         static_assert(USCRIPT_CODE_LIMIT < 0x1000, "Script code must fit in an unsigned along with the other flags");
115         unsigned first = static_cast<unsigned>(description.textRenderingMode()) << 6
116             | static_cast<unsigned>(description.widthVariant()) << 4
117             | static_cast<unsigned>(description.nonCJKGlyphOrientation()) << 3
118             | static_cast<unsigned>(description.orientation()) << 2
119             | static_cast<unsigned>(description.italic()) << 1
120             | static_cast<unsigned>(description.renderingMode());
121         unsigned second = static_cast<unsigned>(description.variantEastAsianRuby()) << 27
122             | static_cast<unsigned>(description.variantEastAsianWidth()) << 25
123             | static_cast<unsigned>(description.variantEastAsianVariant()) << 22
124             | static_cast<unsigned>(description.variantAlternates()) << 21
125             | static_cast<unsigned>(description.variantNumericSlashedZero()) << 20
126             | static_cast<unsigned>(description.variantNumericOrdinal()) << 19
127             | static_cast<unsigned>(description.variantNumericFraction()) << 17
128             | static_cast<unsigned>(description.variantNumericSpacing()) << 15
129             | static_cast<unsigned>(description.variantNumericFigure()) << 13
130             | static_cast<unsigned>(description.variantCaps()) << 10
131             | static_cast<unsigned>(description.variantPosition()) << 8
132             | static_cast<unsigned>(description.variantContextualAlternates()) << 6
133             | static_cast<unsigned>(description.variantHistoricalLigatures()) << 4
134             | static_cast<unsigned>(description.variantDiscretionaryLigatures()) << 2
135             | static_cast<unsigned>(description.variantCommonLigatures());
136         return {{ first, second }};
137     }
138
139     static const unsigned cHashTableDeletedSize = 0xFFFFFFFFU;
140
141     unsigned m_size { 0 };
142     unsigned m_weight { 0 };
143     std::array<unsigned, 2> m_flags {{ 0, 0 }};
144     AtomicString m_locale;
145     FontFeatureSettings m_featureSettings;
146 };
147
148 struct FontDescriptionKeyHash {
149     static unsigned hash(const FontDescriptionKey& key)
150     {
151         return key.computeHash();
152     }
153
154     static bool equal(const FontDescriptionKey& a, const FontDescriptionKey& b)
155     {
156         return a == b;
157     }
158
159     static const bool safeToCompareToEmptyOrDeleted = true;
160 };
161
162 class FontCache {
163     friend class WTF::NeverDestroyed<FontCache>;
164
165     WTF_MAKE_NONCOPYABLE(FontCache); WTF_MAKE_FAST_ALLOCATED;
166 public:
167     WEBCORE_EXPORT static FontCache& singleton();
168
169     // These methods are implemented by the platform.
170     RefPtr<Font> systemFallbackForCharacters(const FontDescription&, const Font* originalFontData, bool isPlatformFont, const UChar* characters, unsigned length);
171     Vector<String> systemFontFamilies();
172     void platformInit();
173
174 #if PLATFORM(IOS)
175     static float weightOfCTFont(CTFontRef);
176 #endif
177 #if PLATFORM(COCOA)
178     WEBCORE_EXPORT static void setFontWhitelist(const Vector<String>&);
179 #endif
180 #if PLATFORM(WIN)
181     IMLangFontLinkType* getFontLinkInterface();
182     static void comInitialize();
183     static void comUninitialize();
184     static IMultiLanguage* getMultiLanguageInterface();
185 #endif
186
187     // This function exists so CSSFontSelector can have a unified notion of preinstalled fonts and @font-face.
188     // It comes into play when you create an @font-face which shares a family name as a preinstalled font.
189     Vector<FontTraitsMask> getTraitsInFamily(const AtomicString&);
190
191     WEBCORE_EXPORT RefPtr<Font> fontForFamily(const FontDescription&, const AtomicString&, bool checkingAlternateName = false);
192     WEBCORE_EXPORT Ref<Font> lastResortFallbackFont(const FontDescription&);
193     WEBCORE_EXPORT Ref<Font> fontForPlatformData(const FontPlatformData&);
194     RefPtr<Font> similarFont(const FontDescription&, const AtomicString& family);
195
196     void addClient(FontSelector*);
197     void removeClient(FontSelector*);
198
199     unsigned short generation();
200     WEBCORE_EXPORT void invalidate();
201
202     WEBCORE_EXPORT size_t fontCount();
203     WEBCORE_EXPORT size_t inactiveFontCount();
204     WEBCORE_EXPORT void purgeInactiveFontData(unsigned count = UINT_MAX);
205     void platformPurgeInactiveFontData();
206
207 #if PLATFORM(WIN)
208     RefPtr<Font> fontFromDescriptionAndLogFont(const FontDescription&, const LOGFONT&, AtomicString& outFontFamilyName);
209 #endif
210
211 #if ENABLE(OPENTYPE_VERTICAL)
212     typedef AtomicString FontFileKey;
213     PassRefPtr<OpenTypeVerticalData> getVerticalData(const FontFileKey&, const FontPlatformData&);
214 #endif
215
216 private:
217     FontCache();
218     ~FontCache() = delete;
219
220     WEBCORE_EXPORT void purgeInactiveFontDataIfNeeded();
221
222     // FIXME: This method should eventually be removed.
223     FontPlatformData* getCachedFontPlatformData(const FontDescription&, const AtomicString& family, bool checkingAlternateName = false);
224
225     // These methods are implemented by each platform.
226 #if PLATFORM(COCOA)
227     FontPlatformData* getCustomFallbackFont(const UInt32, const FontDescription&);
228 #endif
229     std::unique_ptr<FontPlatformData> createFontPlatformData(const FontDescription&, const AtomicString& family);
230
231     Timer m_purgeTimer;
232
233 #if PLATFORM(COCOA)
234     friend class ComplexTextController;
235 #endif
236     friend class Font;
237 };
238
239 #if PLATFORM(COCOA)
240
241 struct SynthesisPair {
242     SynthesisPair(bool needsSyntheticBold, bool needsSyntheticOblique)
243         : needsSyntheticBold(needsSyntheticBold)
244         , needsSyntheticOblique(needsSyntheticOblique)
245     {
246     }
247
248     std::pair<bool, bool> boldObliquePair() const
249     {
250         return std::make_pair(needsSyntheticBold, needsSyntheticOblique);
251     }
252
253     bool needsSyntheticBold;
254     bool needsSyntheticOblique;
255 };
256
257 RetainPtr<CTFontRef> preparePlatformFont(CTFontRef, TextRenderingMode, const FontFeatureSettings&, const FontVariantSettings&);
258 FontWeight fontWeightFromCoreText(CGFloat weight);
259 uint16_t toCoreTextFontWeight(FontWeight);
260 bool isFontWeightBold(FontWeight);
261 void platformInvalidateFontCache();
262 SynthesisPair computeNecessarySynthesis(CTFontRef, const FontDescription&, bool isPlatformFont = false);
263 RetainPtr<CTFontRef> platformFontWithFamilySpecialCase(const AtomicString& family, FontWeight, CTFontSymbolicTraits, float size);
264 RetainPtr<CTFontRef> platformFontWithFamily(const AtomicString& family, CTFontSymbolicTraits, FontWeight, TextRenderingMode, float size);
265 RetainPtr<CTFontRef> platformLookupFallbackFont(CTFontRef, FontWeight, const AtomicString& locale, const UChar* characters, unsigned length);
266 bool requiresCustomFallbackFont(UChar32 character);
267
268 #else
269
270 inline void FontCache::platformPurgeInactiveFontData()
271 {
272 }
273
274 #endif
275
276 }
277
278 #endif