Clean up makeFontCascadeCacheKey()
[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 <limits.h>
36 #include <wtf/Forward.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefPtr.h>
39 #include <wtf/Vector.h>
40 #include <wtf/text/WTFString.h>
41
42 #if PLATFORM(IOS)
43 #include <CoreText/CTFont.h>
44 #endif
45
46 #if OS(WINDOWS)
47 #include <windows.h>
48 #include <objidl.h>
49 #include <mlang.h>
50 #endif
51
52 namespace WebCore {
53
54 class FontCascade;
55 class FontPlatformData;
56 class FontSelector;
57 class OpenTypeVerticalData;
58 class Font;
59
60 #if PLATFORM(WIN)
61 #if USE(IMLANG_FONT_LINK2)
62 typedef IMLangFontLink2 IMLangFontLinkType;
63 #else
64 typedef IMLangFontLink IMLangFontLinkType;
65 #endif
66 #endif
67
68 // This key contains the FontDescription fields other than family that matter when fetching FontDatas (platform fonts).
69 struct FontDescriptionKey {
70     explicit FontDescriptionKey(unsigned size = 0)
71         : size(size)
72         , weight(0)
73         , flags(0)
74     { }
75     FontDescriptionKey(const FontDescription& description)
76         : size(description.computedPixelSize())
77         , weight(description.weight())
78         , flags(makeFlagKey(description))
79     { }
80     static unsigned makeFlagKey(const FontDescription& description)
81     {
82         static_assert(USCRIPT_CODE_LIMIT < 0x1000, "Script code must fit in an unsigned along with the other flags");
83         return static_cast<unsigned>(description.script()) << 9
84             | static_cast<unsigned>(description.smallCaps()) << 8
85             | static_cast<unsigned>(description.fontSynthesis()) << 6
86             | static_cast<unsigned>(description.widthVariant()) << 4
87             | static_cast<unsigned>(description.nonCJKGlyphOrientation()) << 3
88             | static_cast<unsigned>(description.orientation()) << 2
89             | static_cast<unsigned>(description.italic()) << 1
90             | static_cast<unsigned>(description.renderingMode());
91     }
92     bool operator==(const FontDescriptionKey& other) const
93     {
94         return size == other.size && weight == other.weight && flags == other.flags;
95     }
96     bool operator!=(const FontDescriptionKey& other) const
97     {
98         return !(*this == other);
99     }
100     inline unsigned computeHash() const
101     {
102         return StringHasher::hashMemory<sizeof(FontDescriptionKey)>(this);
103     }
104     unsigned size;
105     unsigned weight;
106     unsigned flags;
107 };
108
109 class FontCache {
110     friend class WTF::NeverDestroyed<FontCache>;
111
112     WTF_MAKE_NONCOPYABLE(FontCache); WTF_MAKE_FAST_ALLOCATED;
113 public:
114     WEBCORE_EXPORT static FontCache& singleton();
115
116     // These methods are implemented by the platform.
117     RefPtr<Font> systemFallbackForCharacters(const FontDescription&, const Font* originalFontData, bool isPlatformFont, const UChar* characters, unsigned length);
118     Vector<String> systemFontFamilies();
119     void platformInit();
120
121 #if PLATFORM(IOS)
122     static float weightOfCTFont(CTFontRef);
123 #endif
124 #if PLATFORM(MAC)
125     WEBCORE_EXPORT static void setFontWhitelist(const Vector<String>&);
126 #endif
127 #if PLATFORM(WIN)
128     IMLangFontLinkType* getFontLinkInterface();
129     static void comInitialize();
130     static void comUninitialize();
131     static IMultiLanguage* getMultiLanguageInterface();
132 #endif
133
134     void getTraitsInFamily(const AtomicString&, Vector<unsigned>&);
135
136     WEBCORE_EXPORT RefPtr<Font> fontForFamily(const FontDescription&, const AtomicString&, bool checkingAlternateName = false);
137     WEBCORE_EXPORT Ref<Font> lastResortFallbackFont(const FontDescription&);
138     WEBCORE_EXPORT Ref<Font> fontForPlatformData(const FontPlatformData&);
139     RefPtr<Font> similarFont(const FontDescription&);
140
141     void addClient(FontSelector*);
142     void removeClient(FontSelector*);
143
144     unsigned short generation();
145     WEBCORE_EXPORT void invalidate();
146
147     WEBCORE_EXPORT size_t fontCount();
148     WEBCORE_EXPORT size_t inactiveFontCount();
149     WEBCORE_EXPORT void purgeInactiveFontData(unsigned count = UINT_MAX);
150
151 #if PLATFORM(WIN)
152     RefPtr<Font> fontFromDescriptionAndLogFont(const FontDescription&, const LOGFONT&, AtomicString& outFontFamilyName);
153 #endif
154
155 #if ENABLE(OPENTYPE_VERTICAL)
156     typedef AtomicString FontFileKey;
157     PassRefPtr<OpenTypeVerticalData> getVerticalData(const FontFileKey&, const FontPlatformData&);
158 #endif
159
160 private:
161     FontCache();
162     ~FontCache() = delete;
163
164     void purgeTimerFired();
165
166     WEBCORE_EXPORT void purgeInactiveFontDataIfNeeded();
167
168     // FIXME: This method should eventually be removed.
169     FontPlatformData* getCachedFontPlatformData(const FontDescription&, const AtomicString& family, bool checkingAlternateName = false);
170
171     // These methods are implemented by each platform.
172 #if PLATFORM(IOS)
173     FontPlatformData* getCustomFallbackFont(const UInt32, const FontDescription&);
174     PassRefPtr<Font> getSystemFontFallbackForCharacters(const FontDescription&, const Font*, const UChar* characters, unsigned length);
175 #endif
176     std::unique_ptr<FontPlatformData> createFontPlatformData(const FontDescription&, const AtomicString& family);
177
178     Timer m_purgeTimer;
179
180 #if PLATFORM(COCOA)
181     friend class ComplexTextController;
182 #endif
183     friend class Font;
184 };
185
186 }
187
188 #endif