Global FontPlatformData cache should use OwnPtr.
[WebKit-https.git] / Source / 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 "OpenTypeVerticalData.h"
38 #include "WebKitFontFamilyNames.h"
39 #include <wtf/HashMap.h>
40 #include <wtf/ListHashSet.h>
41 #include <wtf/StdLibExtras.h>
42 #include <wtf/text/AtomicStringHash.h>
43 #include <wtf/text/StringHash.h>
44
45 using namespace WTF;
46
47 namespace WebCore {
48
49 FontCache* fontCache()
50 {
51     DEFINE_STATIC_LOCAL(FontCache, globalFontCache, ());
52     return &globalFontCache;
53 }
54
55 FontCache::FontCache()
56     : m_purgePreventCount(0)
57 {
58 }
59
60 struct FontPlatformDataCacheKey {
61     WTF_MAKE_FAST_ALLOCATED;
62 public:
63     FontPlatformDataCacheKey(const AtomicString& family = AtomicString(), unsigned size = 0, unsigned weight = 0, bool italic = false,
64                              bool isPrinterFont = false, FontRenderingMode renderingMode = NormalRenderingMode, FontOrientation orientation = Horizontal,
65                              FontWidthVariant widthVariant = RegularWidth)
66         : m_size(size)
67         , m_weight(weight)
68         , m_family(family)
69         , m_italic(italic)
70         , m_printerFont(isPrinterFont)
71         , m_renderingMode(renderingMode)
72         , m_orientation(orientation)
73         , m_widthVariant(widthVariant)
74     {
75     }
76
77     FontPlatformDataCacheKey(HashTableDeletedValueType) : m_size(hashTableDeletedSize()) { }
78     bool isHashTableDeletedValue() const { return m_size == hashTableDeletedSize(); }
79
80     bool operator==(const FontPlatformDataCacheKey& other) const
81     {
82         return equalIgnoringCase(m_family, other.m_family) && m_size == other.m_size && 
83                m_weight == other.m_weight && m_italic == other.m_italic && m_printerFont == other.m_printerFont &&
84                m_renderingMode == other.m_renderingMode && m_orientation == other.m_orientation && m_widthVariant == other.m_widthVariant;
85     }
86
87     unsigned m_size;
88     unsigned m_weight;
89     AtomicString m_family;
90     bool m_italic;
91     bool m_printerFont;
92     FontRenderingMode m_renderingMode;
93     FontOrientation m_orientation;
94     FontWidthVariant m_widthVariant;
95
96 private:
97     static unsigned hashTableDeletedSize() { return 0xFFFFFFFFU; }
98 };
99
100 inline unsigned computeHash(const FontPlatformDataCacheKey& fontKey)
101 {
102     unsigned hashCodes[5] = {
103         CaseFoldingHash::hash(fontKey.m_family),
104         fontKey.m_size,
105         fontKey.m_weight,
106         fontKey.m_widthVariant,
107         static_cast<unsigned>(fontKey.m_orientation) << 3 | static_cast<unsigned>(fontKey.m_italic) << 2 | static_cast<unsigned>(fontKey.m_printerFont) << 1 | static_cast<unsigned>(fontKey.m_renderingMode)
108     };
109     return StringHasher::hashMemory<sizeof(hashCodes)>(hashCodes);
110 }
111
112 struct FontPlatformDataCacheKeyHash {
113     static unsigned hash(const FontPlatformDataCacheKey& font)
114     {
115         return computeHash(font);
116     }
117          
118     static bool equal(const FontPlatformDataCacheKey& a, const FontPlatformDataCacheKey& b)
119     {
120         return a == b;
121     }
122
123     static const bool safeToCompareToEmptyOrDeleted = true;
124 };
125
126 struct FontPlatformDataCacheKeyTraits : WTF::SimpleClassHashTraits<FontPlatformDataCacheKey> { };
127
128 typedef HashMap<FontPlatformDataCacheKey, OwnPtr<FontPlatformData>, FontPlatformDataCacheKeyHash, FontPlatformDataCacheKeyTraits> FontPlatformDataCache;
129
130 static FontPlatformDataCache* gFontPlatformDataCache = 0;
131
132 static const AtomicString& alternateFamilyName(const AtomicString& familyName)
133 {
134     // Alias Courier <-> Courier New
135     DEFINE_STATIC_LOCAL(AtomicString, courier, ("Courier", AtomicString::ConstructFromLiteral));
136     DEFINE_STATIC_LOCAL(AtomicString, courierNew, ("Courier New", AtomicString::ConstructFromLiteral));
137     if (equalIgnoringCase(familyName, courier))
138         return courierNew;
139 #if !OS(WINDOWS)
140     // On Windows, Courier New (truetype font) is always present and
141     // Courier is a bitmap font. So, we don't want to map Courier New to
142     // Courier.
143     if (equalIgnoringCase(familyName, courierNew))
144         return courier;
145 #endif
146
147     // Alias Times and Times New Roman.
148     DEFINE_STATIC_LOCAL(AtomicString, times, ("Times", AtomicString::ConstructFromLiteral));
149     DEFINE_STATIC_LOCAL(AtomicString, timesNewRoman, ("Times New Roman", AtomicString::ConstructFromLiteral));
150     if (equalIgnoringCase(familyName, times))
151         return timesNewRoman;
152     if (equalIgnoringCase(familyName, timesNewRoman))
153         return times;
154     
155     // Alias Arial and Helvetica
156     DEFINE_STATIC_LOCAL(AtomicString, arial, ("Arial", AtomicString::ConstructFromLiteral));
157     DEFINE_STATIC_LOCAL(AtomicString, helvetica, ("Helvetica", AtomicString::ConstructFromLiteral));
158     if (equalIgnoringCase(familyName, arial))
159         return helvetica;
160     if (equalIgnoringCase(familyName, helvetica))
161         return arial;
162
163 #if OS(WINDOWS)
164     // On Windows, bitmap fonts are blocked altogether so that we have to 
165     // alias MS Sans Serif (bitmap font) -> Microsoft Sans Serif (truetype font)
166     DEFINE_STATIC_LOCAL(AtomicString, msSans, ("MS Sans Serif", AtomicString::ConstructFromLiteral));
167     DEFINE_STATIC_LOCAL(AtomicString, microsoftSans, ("Microsoft Sans Serif", AtomicString::ConstructFromLiteral));
168     if (equalIgnoringCase(familyName, msSans))
169         return microsoftSans;
170
171     // Alias MS Serif (bitmap) -> Times New Roman (truetype font). There's no 
172     // 'Microsoft Sans Serif-equivalent' for Serif.
173     DEFINE_STATIC_LOCAL(AtomicString, msSerif, ("MS Serif", AtomicString::ConstructFromLiteral));
174     if (equalIgnoringCase(familyName, msSerif))
175         return timesNewRoman;
176 #endif
177
178     return emptyAtom;
179 }
180
181 FontPlatformData* FontCache::getCachedFontPlatformData(const FontDescription& fontDescription,
182                                                        const AtomicString& passedFamilyName,
183                                                        bool checkingAlternateName)
184 {
185 #if OS(WINDOWS) && ENABLE(OPENTYPE_VERTICAL)
186     // Leading "@" in the font name enables Windows vertical flow flag for the font.
187     // Because we do vertical flow by ourselves, we don't want to use the Windows feature.
188     // IE disregards "@" regardless of the orientatoin, so we follow the behavior.
189     const AtomicString& familyName = (passedFamilyName.isEmpty() || passedFamilyName[0] != '@') ?
190         passedFamilyName : AtomicString(passedFamilyName.impl()->substring(1));
191 #else
192     const AtomicString& familyName = passedFamilyName;
193 #endif
194
195     if (!gFontPlatformDataCache) {
196         gFontPlatformDataCache = new FontPlatformDataCache;
197         platformInit();
198     }
199
200     FontPlatformDataCacheKey key(familyName, fontDescription.computedPixelSize(), fontDescription.weight(), fontDescription.italic(),
201                                  fontDescription.usePrinterFont(), fontDescription.renderingMode(), fontDescription.orientation(),
202                                  fontDescription.widthVariant());
203
204     FontPlatformDataCache::AddResult result = gFontPlatformDataCache->add(key, nullptr);
205     if (result.isNewEntry) {
206         result.iterator->value = createFontPlatformData(fontDescription, familyName);
207
208         if (!result.iterator->value && !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                 FontPlatformData* fontPlatformDataForAlternateName = getCachedFontPlatformData(fontDescription, alternateName, true);
214                 if (fontPlatformDataForAlternateName)
215                     result.iterator->value = adoptPtr(new FontPlatformData(*fontPlatformDataForAlternateName));
216             }
217         }
218     }
219
220     return result.iterator->value.get();
221 }
222
223 #if ENABLE(OPENTYPE_VERTICAL)
224 typedef HashMap<FontCache::FontFileKey, RefPtr<OpenTypeVerticalData>, WTF::IntHash<FontCache::FontFileKey>, WTF::UnsignedWithZeroKeyHashTraits<FontCache::FontFileKey> > FontVerticalDataCache;
225
226 FontVerticalDataCache& fontVerticalDataCacheInstance()
227 {
228     DEFINE_STATIC_LOCAL(FontVerticalDataCache, fontVerticalDataCache, ());
229     return fontVerticalDataCache;
230 }
231
232 PassRefPtr<OpenTypeVerticalData> FontCache::getVerticalData(const FontFileKey& key, const FontPlatformData& platformData)
233 {
234     FontVerticalDataCache& fontVerticalDataCache = fontVerticalDataCacheInstance();
235     FontVerticalDataCache::iterator result = fontVerticalDataCache.find(key);
236     if (result != fontVerticalDataCache.end())
237         return result.get()->value;
238
239     RefPtr<OpenTypeVerticalData> verticalData = OpenTypeVerticalData::create(platformData);
240     if (!verticalData->isOpenType())
241         verticalData.clear();
242     fontVerticalDataCache.set(key, verticalData);
243     return verticalData;
244 }
245 #endif
246
247 struct FontDataCacheKeyHash {
248     static unsigned hash(const FontPlatformData& platformData)
249     {
250         return platformData.hash();
251     }
252          
253     static bool equal(const FontPlatformData& a, const FontPlatformData& b)
254     {
255         return a == b;
256     }
257
258     static const bool safeToCompareToEmptyOrDeleted = true;
259 };
260
261 struct FontDataCacheKeyTraits : WTF::GenericHashTraits<FontPlatformData> {
262     static const bool emptyValueIsZero = true;
263     static const bool needsDestruction = true;
264     static const FontPlatformData& emptyValue()
265     {
266         DEFINE_STATIC_LOCAL(FontPlatformData, key, (0.f, false, false));
267         return key;
268     }
269     static void constructDeletedValue(FontPlatformData& slot)
270     {
271         new (NotNull, &slot) FontPlatformData(HashTableDeletedValue);
272     }
273     static bool isDeletedValue(const FontPlatformData& value)
274     {
275         return value.isHashTableDeletedValue();
276     }
277 };
278
279 typedef HashMap<FontPlatformData, pair<RefPtr<SimpleFontData>, unsigned>, FontDataCacheKeyHash, FontDataCacheKeyTraits> FontDataCache;
280
281 static FontDataCache* gFontDataCache = 0;
282
283 #if PLATFORM(CHROMIUM) && !OS(ANDROID)
284 const int cMaxInactiveFontData = 250;
285 const int cTargetInactiveFontData = 200;
286 #else
287 const int cMaxInactiveFontData = 225;
288 const int cTargetInactiveFontData = 200;
289 #endif
290 static ListHashSet<RefPtr<SimpleFontData> >* gInactiveFontData = 0;
291
292 PassRefPtr<SimpleFontData> FontCache::getCachedFontData(const FontDescription& fontDescription, const AtomicString& family, bool checkingAlternateName, ShouldRetain shouldRetain)
293 {
294     FontPlatformData* platformData = getCachedFontPlatformData(fontDescription, family, checkingAlternateName);
295     if (!platformData)
296         return 0;
297
298     return getCachedFontData(platformData, shouldRetain);
299 }
300
301 PassRefPtr<SimpleFontData> FontCache::getCachedFontData(const FontPlatformData* platformData, ShouldRetain shouldRetain)
302 {
303     if (!platformData)
304         return 0;
305
306 #if !ASSERT_DISABLED
307     if (shouldRetain == DoNotRetain)
308         ASSERT(m_purgePreventCount);
309 #endif
310
311     if (!gFontDataCache) {
312         gFontDataCache = new FontDataCache;
313         gInactiveFontData = new ListHashSet<RefPtr<SimpleFontData> >;
314     }
315
316     FontDataCache::iterator result = gFontDataCache->find(*platformData);
317     if (result == gFontDataCache->end()) {
318         pair<RefPtr<SimpleFontData>, unsigned> newValue(SimpleFontData::create(*platformData), shouldRetain == Retain ? 1 : 0);
319         gFontDataCache->set(*platformData, newValue);
320         if (shouldRetain == DoNotRetain)
321             gInactiveFontData->add(newValue.first);
322         return newValue.first.release();
323     }
324
325     if (!result.get()->value.second) {
326         ASSERT(gInactiveFontData->contains(result.get()->value.first));
327         gInactiveFontData->remove(result.get()->value.first);
328     }
329
330     if (shouldRetain == Retain)
331         result.get()->value.second++;
332     else if (!result.get()->value.second) {
333         // If shouldRetain is DoNotRetain and count is 0, we want to remove the fontData from 
334         // gInactiveFontData (above) and re-add here to update LRU position.
335         gInactiveFontData->add(result.get()->value.first);
336     }
337
338     return result.get()->value.first;
339 }
340
341 SimpleFontData* FontCache::getNonRetainedLastResortFallbackFont(const FontDescription& fontDescription)
342 {
343     return getLastResortFallbackFont(fontDescription, DoNotRetain).leakRef();
344 }
345
346 void FontCache::releaseFontData(const SimpleFontData* fontData)
347 {
348     ASSERT(gFontDataCache);
349     ASSERT(!fontData->isCustomFont());
350
351     FontDataCache::iterator it = gFontDataCache->find(fontData->platformData());
352     ASSERT(it != gFontDataCache->end());
353     if (it == gFontDataCache->end())
354         return;
355
356     ASSERT(it->value.second);
357     if (!--it->value.second)
358         gInactiveFontData->add(it->value.first);
359 }
360
361 void FontCache::purgeInactiveFontDataIfNeeded()
362 {
363     if (gInactiveFontData && !m_purgePreventCount && gInactiveFontData->size() > cMaxInactiveFontData)
364         purgeInactiveFontData(gInactiveFontData->size() - cTargetInactiveFontData);
365 }
366
367 void FontCache::purgeInactiveFontData(int count)
368 {
369     if (!gInactiveFontData || m_purgePreventCount)
370         return;
371
372     static bool isPurging;  // Guard against reentry when e.g. a deleted FontData releases its small caps FontData.
373     if (isPurging)
374         return;
375
376     isPurging = true;
377
378     Vector<RefPtr<SimpleFontData>, 20> fontDataToDelete;
379     ListHashSet<RefPtr<SimpleFontData> >::iterator end = gInactiveFontData->end();
380     ListHashSet<RefPtr<SimpleFontData> >::iterator it = gInactiveFontData->begin();
381     for (int i = 0; i < count && it != end; ++it, ++i) {
382         RefPtr<SimpleFontData>& fontData = *it.get();
383         gFontDataCache->remove(fontData->platformData());
384         // We should not delete SimpleFontData here because deletion can modify gInactiveFontData. See http://trac.webkit.org/changeset/44011
385         fontDataToDelete.append(fontData);
386     }
387
388     if (it == end) {
389         // Removed everything
390         gInactiveFontData->clear();
391     } else {
392         for (int i = 0; i < count; ++i)
393             gInactiveFontData->remove(gInactiveFontData->begin());
394     }
395
396     fontDataToDelete.clear();
397
398     if (gFontPlatformDataCache) {
399         Vector<FontPlatformDataCacheKey> keysToRemove;
400         keysToRemove.reserveInitialCapacity(gFontPlatformDataCache->size());
401         FontPlatformDataCache::iterator platformDataEnd = gFontPlatformDataCache->end();
402         for (FontPlatformDataCache::iterator platformData = gFontPlatformDataCache->begin(); platformData != platformDataEnd; ++platformData) {
403             if (platformData->value && !gFontDataCache->contains(*platformData->value))
404                 keysToRemove.append(platformData->key);
405         }
406         
407         size_t keysToRemoveCount = keysToRemove.size();
408         for (size_t i = 0; i < keysToRemoveCount; ++i)
409             gFontPlatformDataCache->remove(keysToRemove[i]);
410     }
411
412 #if ENABLE(OPENTYPE_VERTICAL)
413     FontVerticalDataCache& fontVerticalDataCache = fontVerticalDataCacheInstance();
414     if (!fontVerticalDataCache.isEmpty()) {
415         // Mark & sweep unused verticalData
416         FontVerticalDataCache::iterator verticalDataEnd = fontVerticalDataCache.end();
417         for (FontVerticalDataCache::iterator verticalData = fontVerticalDataCache.begin(); verticalData != verticalDataEnd; ++verticalData) {
418             if (verticalData->value)
419                 verticalData->value->m_inFontCache = false;
420         }
421         FontDataCache::iterator fontDataEnd = gFontDataCache->end();
422         for (FontDataCache::iterator fontData = gFontDataCache->begin(); fontData != fontDataEnd; ++fontData) {
423             OpenTypeVerticalData* verticalData = const_cast<OpenTypeVerticalData*>(fontData->value.first->verticalData());
424             if (verticalData)
425                 verticalData->m_inFontCache = true;
426         }
427         Vector<FontFileKey> keysToRemove;
428         keysToRemove.reserveInitialCapacity(fontVerticalDataCache.size());
429         for (FontVerticalDataCache::iterator verticalData = fontVerticalDataCache.begin(); verticalData != verticalDataEnd; ++verticalData) {
430             if (!verticalData->value || !verticalData->value->m_inFontCache)
431                 keysToRemove.append(verticalData->key);
432         }
433         for (size_t i = 0, count = keysToRemove.size(); i < count; ++i)
434             fontVerticalDataCache.take(keysToRemove[i]);
435     }
436 #endif
437
438     isPurging = false;
439 }
440
441 size_t FontCache::fontDataCount()
442 {
443     if (gFontDataCache)
444         return gFontDataCache->size();
445     return 0;
446 }
447
448 size_t FontCache::inactiveFontDataCount()
449 {
450     if (gInactiveFontData)
451         return gInactiveFontData->size();
452     return 0;
453 }
454
455 PassRefPtr<FontData> FontCache::getFontData(const Font& font, int& familyIndex, FontSelector* fontSelector)
456 {
457     RefPtr<FontData> result;
458
459     int startIndex = familyIndex;
460     const FontFamily* startFamily = &font.fontDescription().family();
461     for (int i = 0; startFamily && i < startIndex; i++)
462         startFamily = startFamily->next();
463     const FontFamily* currFamily = startFamily;
464     while (currFamily && !result) {
465         familyIndex++;
466         if (currFamily->family().length()) {
467             if (fontSelector)
468                 result = fontSelector->getFontData(font.fontDescription(), currFamily->family());
469
470             if (!result)
471                 result = getCachedFontData(font.fontDescription(), currFamily->family());
472         }
473         currFamily = currFamily->next();
474     }
475
476     if (!currFamily)
477         familyIndex = cAllFamiliesScanned;
478
479     if (!result)
480         // We didn't find a font. Try to find a similar font using our own specific knowledge about our platform.
481         // For example on OS X, we know to map any families containing the words Arabic, Pashto, or Urdu to the
482         // Geeza Pro font.
483         result = getSimilarFontPlatformData(font);
484
485     if (!result && startIndex == 0) {
486         // If it's the primary font that we couldn't find, we try the following. In all other cases, we will
487         // just use per-character system fallback.
488
489         if (fontSelector) {
490             // Try the user's preferred standard font.
491             if (RefPtr<FontData> data = fontSelector->getFontData(font.fontDescription(), standardFamily))
492                 return data.release();
493         }
494
495         // Still no result.  Hand back our last resort fallback font.
496         result = getLastResortFallbackFont(font.fontDescription());
497     }
498     return result.release();
499 }
500
501 static HashSet<FontSelector*>* gClients;
502
503 void FontCache::addClient(FontSelector* client)
504 {
505     if (!gClients)
506         gClients = new HashSet<FontSelector*>;
507
508     ASSERT(!gClients->contains(client));
509     gClients->add(client);
510 }
511
512 void FontCache::removeClient(FontSelector* client)
513 {
514     ASSERT(gClients);
515     ASSERT(gClients->contains(client));
516
517     gClients->remove(client);
518 }
519
520 static unsigned short gGeneration = 0;
521
522 unsigned short FontCache::generation()
523 {
524     return gGeneration;
525 }
526
527 void FontCache::invalidate()
528 {
529     if (!gClients) {
530         ASSERT(!gFontPlatformDataCache);
531         return;
532     }
533
534     if (gFontPlatformDataCache)
535         gFontPlatformDataCache->clear();
536
537     gGeneration++;
538
539     Vector<RefPtr<FontSelector> > clients;
540     size_t numClients = gClients->size();
541     clients.reserveInitialCapacity(numClients);
542     HashSet<FontSelector*>::iterator end = gClients->end();
543     for (HashSet<FontSelector*>::iterator it = gClients->begin(); it != end; ++it)
544         clients.append(*it);
545
546     ASSERT(numClients == clients.size());
547     for (size_t i = 0; i < numClients; ++i)
548         clients[i]->fontCacheInvalidated();
549
550     purgeInactiveFontData();
551 }
552
553 } // namespace WebCore