c3934913027d56e4849bbdb88b4ea8b179a9cd13
[WebKit-https.git] / WebCore / platform / graphics / FontCache.cpp
1 /*
2  * Copyright (C) 2006, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Nicholas Shanks <webkit@nickshanks.com>
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 Computer, 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 #include "config.h"
31 #include "FontCache.h"
32
33 #include "Font.h"
34 #include "FontFallbackList.h"
35 #include "FontPlatformData.h"
36 #include "FontSelector.h"
37 #include "StringHash.h"
38 #include <wtf/HashMap.h>
39 #include <wtf/ListHashSet.h>
40 #include <wtf/StdLibExtras.h>
41
42 using namespace WTF;
43
44 namespace WebCore {
45
46 FontCache* fontCache()
47 {
48     DEFINE_STATIC_LOCAL(FontCache, globalFontCache, ());
49     return &globalFontCache;
50 }
51
52 FontCache::FontCache()
53 {
54 }
55
56 struct FontPlatformDataCacheKey {
57     FontPlatformDataCacheKey(const AtomicString& family = AtomicString(), unsigned size = 0, unsigned weight = 0, bool italic = false,
58                              bool isPrinterFont = false, FontRenderingMode renderingMode = NormalRenderingMode)
59         : m_family(family)
60         , m_size(size)
61         , m_weight(weight)
62         , m_italic(italic)
63         , m_printerFont(isPrinterFont)
64         , m_renderingMode(renderingMode)
65     {
66     }
67
68     FontPlatformDataCacheKey(HashTableDeletedValueType) : m_size(hashTableDeletedSize()) { }
69     bool isHashTableDeletedValue() const { return m_size == hashTableDeletedSize(); }
70
71     bool operator==(const FontPlatformDataCacheKey& other) const
72     {
73         return equalIgnoringCase(m_family, other.m_family) && m_size == other.m_size && 
74                m_weight == other.m_weight && m_italic == other.m_italic && m_printerFont == other.m_printerFont &&
75                m_renderingMode == other.m_renderingMode;
76     }
77
78     AtomicString m_family;
79     unsigned m_size;
80     unsigned m_weight;
81     bool m_italic;
82     bool m_printerFont;
83     FontRenderingMode m_renderingMode;
84
85 private:
86     static unsigned hashTableDeletedSize() { return 0xFFFFFFFFU; }
87 };
88
89 inline unsigned computeHash(const FontPlatformDataCacheKey& fontKey)
90 {
91     unsigned hashCodes[4] = {
92         CaseFoldingHash::hash(fontKey.m_family),
93         fontKey.m_size,
94         fontKey.m_weight,
95         static_cast<unsigned>(fontKey.m_italic) << 2 | static_cast<unsigned>(fontKey.m_printerFont) << 1 | static_cast<unsigned>(fontKey.m_renderingMode)
96     };
97     return StringImpl::computeHash(reinterpret_cast<UChar*>(hashCodes), sizeof(hashCodes) / sizeof(UChar));
98 }
99
100 struct FontPlatformDataCacheKeyHash {
101     static unsigned hash(const FontPlatformDataCacheKey& font)
102     {
103         return computeHash(font);
104     }
105          
106     static bool equal(const FontPlatformDataCacheKey& a, const FontPlatformDataCacheKey& b)
107     {
108         return a == b;
109     }
110
111     static const bool safeToCompareToEmptyOrDeleted = true;
112 };
113
114 struct FontPlatformDataCacheKeyTraits : WTF::GenericHashTraits<FontPlatformDataCacheKey> {
115     static const bool emptyValueIsZero = true;
116     static const FontPlatformDataCacheKey& emptyValue()
117     {
118         DEFINE_STATIC_LOCAL(FontPlatformDataCacheKey, key, (nullAtom));
119         return key;
120     }
121     static void constructDeletedValue(FontPlatformDataCacheKey& slot)
122     {
123         new (&slot) FontPlatformDataCacheKey(HashTableDeletedValue);
124     }
125     static bool isDeletedValue(const FontPlatformDataCacheKey& value)
126     {
127         return value.isHashTableDeletedValue();
128     }
129 };
130
131 typedef HashMap<FontPlatformDataCacheKey, FontPlatformData*, FontPlatformDataCacheKeyHash, FontPlatformDataCacheKeyTraits> FontPlatformDataCache;
132
133 static FontPlatformDataCache* gFontPlatformDataCache = 0;
134
135 static const AtomicString& alternateFamilyName(const AtomicString& familyName)
136 {
137     // Alias Courier <-> Courier New
138     DEFINE_STATIC_LOCAL(AtomicString, courier, ("Courier"));
139     DEFINE_STATIC_LOCAL(AtomicString, courierNew, ("Courier New"));
140     if (equalIgnoringCase(familyName, courier))
141         return courierNew;
142 #if !PLATFORM(WIN_OS)
143     // On Windows, Courier New (truetype font) is always present and
144     // Courier is a bitmap font. So, we don't want to map Courier New to
145     // Courier.
146     if (equalIgnoringCase(familyName, courierNew))
147         return courier;
148 #endif
149
150     // Alias Times and Times New Roman.
151     DEFINE_STATIC_LOCAL(AtomicString, times, ("Times"));
152     DEFINE_STATIC_LOCAL(AtomicString, timesNewRoman, ("Times New Roman"));
153     if (equalIgnoringCase(familyName, times))
154         return timesNewRoman;
155     if (equalIgnoringCase(familyName, timesNewRoman))
156         return times;
157     
158     // Alias Arial and Helvetica
159     DEFINE_STATIC_LOCAL(AtomicString, arial, ("Arial"));
160     DEFINE_STATIC_LOCAL(AtomicString, helvetica, ("Helvetica"));
161     if (equalIgnoringCase(familyName, arial))
162         return helvetica;
163     if (equalIgnoringCase(familyName, helvetica))
164         return arial;
165
166 #if PLATFORM(WIN_OS)
167     // On Windows, bitmap fonts are blocked altogether so that we have to 
168     // alias MS Sans Serif (bitmap font) -> Microsoft Sans Serif (truetype font)
169     static AtomicString msSans("MS Sans Serif");
170     DEFINE_STATIC_LOCAL(AtomicString, msSans, ("MS Sans Serif"));
171     DEFINE_STATIC_LOCAL(AtomicString, microsoftSans, ("Microsoft Sans Serif"));
172     if (equalIgnoringCase(familyName, msSans))
173         return microsoftSans;
174
175     // Alias MS Serif (bitmap) -> Times New Roman (truetype font). There's no 
176     // 'Microsoft Sans Serif-equivalent' for Serif. 
177     static AtomicString msSerif("MS Serif");
178     if (equalIgnoringCase(familyName, msSerif))
179         return timesNewRoman;
180 #endif
181
182     return emptyAtom;
183 }
184
185 FontPlatformData* FontCache::getCachedFontPlatformData(const FontDescription& fontDescription, 
186                                                        const AtomicString& familyName,
187                                                        bool checkingAlternateName)
188 {
189     if (!gFontPlatformDataCache) {
190         gFontPlatformDataCache = new FontPlatformDataCache;
191         platformInit();
192     }
193
194     FontPlatformDataCacheKey key(familyName, fontDescription.computedPixelSize(), fontDescription.weight(), fontDescription.italic(),
195                                  fontDescription.usePrinterFont(), fontDescription.renderingMode());
196     FontPlatformData* result = 0;
197     bool foundResult;
198     FontPlatformDataCache::iterator it = gFontPlatformDataCache->find(key);
199     if (it == gFontPlatformDataCache->end()) {
200         result = createFontPlatformData(fontDescription, familyName);
201         gFontPlatformDataCache->set(key, result);
202         foundResult = result;
203     } else {
204         result = it->second;
205         foundResult = true;
206     }
207
208     if (!foundResult && !checkingAlternateName) {
209         // We were unable to find a font.  We have a small set of fonts that we alias to other names, 
210         // e.g., Arial/Helvetica, Courier/Courier New, etc.  Try looking up the font under the aliased name.
211         const AtomicString& alternateName = alternateFamilyName(familyName);
212         if (!alternateName.isEmpty())
213             result = getCachedFontPlatformData(fontDescription, alternateName, true);
214         if (result)
215             gFontPlatformDataCache->set(key, new FontPlatformData(*result)); // Cache the result under the old name.
216     }
217
218     return result;
219 }
220
221 struct FontDataCacheKeyHash {
222     static unsigned hash(const FontPlatformData& platformData)
223     {
224         return platformData.hash();
225     }
226          
227     static bool equal(const FontPlatformData& a, const FontPlatformData& b)
228     {
229         return a == b;
230     }
231
232     static const bool safeToCompareToEmptyOrDeleted = true;
233 };
234
235 struct FontDataCacheKeyTraits : WTF::GenericHashTraits<FontPlatformData> {
236     static const bool emptyValueIsZero = true;
237     static const bool needsDestruction = true;
238     static const FontPlatformData& emptyValue()
239     {
240         DEFINE_STATIC_LOCAL(FontPlatformData, key, ());
241         return key;
242     }
243     static void constructDeletedValue(FontPlatformData& slot)
244     {
245         new (&slot) FontPlatformData(HashTableDeletedValue);
246     }
247     static bool isDeletedValue(const FontPlatformData& value)
248     {
249         return value.isHashTableDeletedValue();
250     }
251 };
252
253 typedef HashMap<FontPlatformData, pair<SimpleFontData*, unsigned>, FontDataCacheKeyHash, FontDataCacheKeyTraits> FontDataCache;
254
255 static FontDataCache* gFontDataCache = 0;
256
257 const int cMaxInactiveFontData = 120;  // Pretty Low Threshold
258 const float cTargetInactiveFontData = 100;
259 static ListHashSet<const SimpleFontData*>* gInactiveFontData = 0;
260
261 SimpleFontData* FontCache::getCachedFontData(const FontPlatformData* platformData)
262 {
263     if (!platformData)
264         return 0;
265
266     if (!gFontDataCache) {
267         gFontDataCache = new FontDataCache;
268         gInactiveFontData = new ListHashSet<const SimpleFontData*>;
269     }
270     
271     FontDataCache::iterator result = gFontDataCache->find(*platformData);
272     if (result == gFontDataCache->end()) {
273         pair<SimpleFontData*, unsigned> newValue(new SimpleFontData(*platformData), 1);
274         gFontDataCache->set(*platformData, newValue);
275         return newValue.first;
276     }
277     if (!result.get()->second.second++) {
278         ASSERT(gInactiveFontData->contains(result.get()->second.first));
279         gInactiveFontData->remove(result.get()->second.first);
280     }
281
282     return result.get()->second.first;
283 }
284
285 void FontCache::releaseFontData(const SimpleFontData* fontData)
286 {
287     ASSERT(gFontDataCache);
288     ASSERT(!fontData->isCustomFont());
289
290     FontDataCache::iterator it = gFontDataCache->find(fontData->platformData());
291     ASSERT(it != gFontDataCache->end());
292
293     if (!--it->second.second) {
294         gInactiveFontData->add(fontData);
295         if (gInactiveFontData->size() > cMaxInactiveFontData)
296             purgeInactiveFontData(gInactiveFontData->size() - cTargetInactiveFontData);
297     }
298 }
299
300 void FontCache::purgeInactiveFontData(int count)
301 {
302     if (!gInactiveFontData)
303         return;
304
305     static bool isPurging;  // Guard against reentry when e.g. a deleted FontData releases its small caps FontData.
306     if (isPurging)
307         return;
308
309     isPurging = true;
310
311     ListHashSet<const SimpleFontData*>::iterator end = gInactiveFontData->end();
312     ListHashSet<const SimpleFontData*>::iterator it = gInactiveFontData->begin();
313     for (int i = 0; i < count && it != end; ++it, ++i) {
314         const SimpleFontData* fontData = *it.get();
315         gFontDataCache->remove(fontData->platformData());
316         delete fontData;
317     }
318
319     if (it == end) {
320         // Removed everything
321         gInactiveFontData->clear();
322     } else {
323         for (int i = 0; i < count; ++i)
324             gInactiveFontData->remove(gInactiveFontData->begin());
325     }
326
327     Vector<FontPlatformDataCacheKey> keysToRemove;
328     keysToRemove.reserveInitialCapacity(gFontPlatformDataCache->size());
329     FontPlatformDataCache::iterator platformDataEnd = gFontPlatformDataCache->end();
330     for (FontPlatformDataCache::iterator platformData = gFontPlatformDataCache->begin(); platformData != platformDataEnd; ++platformData) {
331         if (platformData->second && !gFontDataCache->contains(*platformData->second))
332             keysToRemove.append(platformData->first);
333     }
334
335     size_t keysToRemoveCount = keysToRemove.size();
336     for (size_t i = 0; i < keysToRemoveCount; ++i)
337         delete gFontPlatformDataCache->take(keysToRemove[i]);
338
339     isPurging = false;
340 }
341
342 size_t FontCache::fontDataCount()
343 {
344     if (gFontDataCache)
345         return gFontDataCache->size();
346     return 0;
347 }
348
349 size_t FontCache::inactiveFontDataCount()
350 {
351     if (gInactiveFontData)
352         return gInactiveFontData->size();
353     return 0;
354 }
355
356 const FontData* FontCache::getFontData(const Font& font, int& familyIndex, FontSelector* fontSelector)
357 {
358     FontPlatformData* result = 0;
359
360     int startIndex = familyIndex;
361     const FontFamily* startFamily = &font.fontDescription().family();
362     for (int i = 0; startFamily && i < startIndex; i++)
363         startFamily = startFamily->next();
364     const FontFamily* currFamily = startFamily;
365     while (currFamily && !result) {
366         familyIndex++;
367         if (currFamily->family().length()) {
368             if (fontSelector) {
369                 FontData* data = fontSelector->getFontData(font.fontDescription(), currFamily->family());
370                 if (data)
371                     return data;
372             }
373             result = getCachedFontPlatformData(font.fontDescription(), currFamily->family());
374         }
375         currFamily = currFamily->next();
376     }
377
378     if (!currFamily)
379         familyIndex = cAllFamiliesScanned;
380
381     if (!result)
382         // We didn't find a font. Try to find a similar font using our own specific knowledge about our platform.
383         // For example on OS X, we know to map any families containing the words Arabic, Pashto, or Urdu to the
384         // Geeza Pro font.
385         result = getSimilarFontPlatformData(font);
386
387     if (!result && startIndex == 0) {
388         // If it's the primary font that we couldn't find, we try the following. In all other cases, we will
389         // just use per-character system fallback.
390
391         if (fontSelector) {
392             // Try the user's preferred standard font.
393             if (FontData* data = fontSelector->getFontData(font.fontDescription(), "-webkit-standard"))
394                 return data;
395         }
396
397         // Still no result.  Hand back our last resort fallback font.
398         result = getLastResortFallbackFont(font.fontDescription());
399     }
400
401     // Now that we have a result, we need to go from FontPlatformData -> FontData.
402     return getCachedFontData(result);
403 }
404
405 static HashSet<FontSelector*>* gClients;
406
407 void FontCache::addClient(FontSelector* client)
408 {
409     if (!gClients)
410         gClients = new HashSet<FontSelector*>;
411
412     ASSERT(!gClients->contains(client));
413     gClients->add(client);
414 }
415
416 void FontCache::removeClient(FontSelector* client)
417 {
418     ASSERT(gClients);
419     ASSERT(gClients->contains(client));
420
421     gClients->remove(client);
422 }
423
424 static unsigned gGeneration = 0;
425
426 unsigned FontCache::generation()
427 {
428     return gGeneration;
429 }
430
431 void FontCache::invalidate()
432 {
433     if (!gClients) {
434         ASSERT(!gFontPlatformDataCache);
435         return;
436     }
437
438     if (gFontPlatformDataCache) {
439         deleteAllValues(*gFontPlatformDataCache);
440         delete gFontPlatformDataCache;
441         gFontPlatformDataCache = new FontPlatformDataCache;
442     }
443
444     gGeneration++;
445
446     Vector<RefPtr<FontSelector> > clients;
447     size_t numClients = gClients->size();
448     clients.reserveInitialCapacity(numClients);
449     HashSet<FontSelector*>::iterator end = gClients->end();
450     for (HashSet<FontSelector*>::iterator it = gClients->begin(); it != end; ++it)
451         clients.append(*it);
452
453     ASSERT(numClients == clients.size());
454     for (size_t i = 0; i < numClients; ++i)
455         clients[i]->fontCacheInvalidated();
456
457     purgeInactiveFontData();
458 }
459
460 } // namespace WebCore