2011-06-08 James Robinson <jamesr@chromium.org>
[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 "GlyphPageTreeNode.h"
38 #include <wtf/HashMap.h>
39 #include <wtf/ListHashSet.h>
40 #include <wtf/StdLibExtras.h>
41 #include <wtf/text/StringHash.h>
42
43 using namespace WTF;
44
45 namespace WebCore {
46
47 FontCache* fontCache()
48 {
49     DEFINE_STATIC_LOCAL(FontCache, globalFontCache, ());
50     return &globalFontCache;
51 }
52
53 FontCache::FontCache()
54     : m_purgePreventCount(0)
55 {
56 }
57
58 struct FontPlatformDataCacheKey {
59     WTF_MAKE_FAST_ALLOCATED;
60 public:
61     FontPlatformDataCacheKey(const AtomicString& family = AtomicString(), unsigned size = 0, unsigned weight = 0, bool italic = false,
62                              bool isPrinterFont = false, FontRenderingMode renderingMode = NormalRenderingMode, FontOrientation orientation = Horizontal,
63                              TextOrientation textOrientation = TextOrientationVerticalRight, FontWidthVariant widthVariant = RegularWidth)
64         : m_size(size)
65         , m_weight(weight)
66         , m_family(family)
67         , m_italic(italic)
68         , m_printerFont(isPrinterFont)
69         , m_renderingMode(renderingMode)
70         , m_orientation(orientation)
71         , m_textOrientation(textOrientation)
72         , m_widthVariant(widthVariant)
73     {
74     }
75
76     FontPlatformDataCacheKey(HashTableDeletedValueType) : m_size(hashTableDeletedSize()) { }
77     bool isHashTableDeletedValue() const { return m_size == hashTableDeletedSize(); }
78
79     bool operator==(const FontPlatformDataCacheKey& other) const
80     {
81         return equalIgnoringCase(m_family, other.m_family) && m_size == other.m_size && 
82                m_weight == other.m_weight && m_italic == other.m_italic && m_printerFont == other.m_printerFont &&
83                m_renderingMode == other.m_renderingMode && m_orientation == other.m_orientation && m_textOrientation == other.m_textOrientation && m_widthVariant == other.m_widthVariant;
84     }
85
86     unsigned m_size;
87     unsigned m_weight;
88     AtomicString m_family;
89     bool m_italic;
90     bool m_printerFont;
91     FontRenderingMode m_renderingMode;
92     FontOrientation m_orientation;
93     TextOrientation m_textOrientation;
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_textOrientation) << 4 | 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, 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"));
136     DEFINE_STATIC_LOCAL(AtomicString, courierNew, ("Courier New"));
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"));
149     DEFINE_STATIC_LOCAL(AtomicString, timesNewRoman, ("Times New Roman"));
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"));
157     DEFINE_STATIC_LOCAL(AtomicString, helvetica, ("Helvetica"));
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"));
167     DEFINE_STATIC_LOCAL(AtomicString, microsoftSans, ("Microsoft Sans Serif"));
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     static AtomicString msSerif("MS Serif");
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& familyName,
183                                                        bool checkingAlternateName)
184 {
185     if (!gFontPlatformDataCache) {
186         gFontPlatformDataCache = new FontPlatformDataCache;
187         platformInit();
188     }
189
190     FontPlatformDataCacheKey key(familyName, fontDescription.computedPixelSize(), fontDescription.weight(), fontDescription.italic(),
191                                  fontDescription.usePrinterFont(), fontDescription.renderingMode(), fontDescription.orientation(),
192                                  fontDescription.textOrientation(), fontDescription.widthVariant());
193     FontPlatformData* result = 0;
194     bool foundResult;
195     FontPlatformDataCache::iterator it = gFontPlatformDataCache->find(key);
196     if (it == gFontPlatformDataCache->end()) {
197         result = createFontPlatformData(fontDescription, familyName);
198         gFontPlatformDataCache->set(key, result);
199         foundResult = result;
200     } else {
201         result = it->second;
202         foundResult = true;
203     }
204
205     if (!foundResult && !checkingAlternateName) {
206         // We were unable to find a font.  We have a small set of fonts that we alias to other names, 
207         // e.g., Arial/Helvetica, Courier/Courier New, etc.  Try looking up the font under the aliased name.
208         const AtomicString& alternateName = alternateFamilyName(familyName);
209         if (!alternateName.isEmpty())
210             result = getCachedFontPlatformData(fontDescription, alternateName, true);
211         if (result)
212             gFontPlatformDataCache->set(key, new FontPlatformData(*result)); // Cache the result under the old name.
213     }
214
215     return result;
216 }
217
218 struct FontDataCacheKeyHash {
219     static unsigned hash(const FontPlatformData& platformData)
220     {
221         return platformData.hash();
222     }
223          
224     static bool equal(const FontPlatformData& a, const FontPlatformData& b)
225     {
226         return a == b;
227     }
228
229     static const bool safeToCompareToEmptyOrDeleted = true;
230 };
231
232 struct FontDataCacheKeyTraits : WTF::GenericHashTraits<FontPlatformData> {
233     static const bool emptyValueIsZero = true;
234     static const bool needsDestruction = true;
235     static const FontPlatformData& emptyValue()
236     {
237         DEFINE_STATIC_LOCAL(FontPlatformData, key, (0.f, false, false));
238         return key;
239     }
240     static void constructDeletedValue(FontPlatformData& slot)
241     {
242         new (&slot) FontPlatformData(HashTableDeletedValue);
243     }
244     static bool isDeletedValue(const FontPlatformData& value)
245     {
246         return value.isHashTableDeletedValue();
247     }
248 };
249
250 typedef HashMap<FontPlatformData, pair<SimpleFontData*, unsigned>, FontDataCacheKeyHash, FontDataCacheKeyTraits> FontDataCache;
251
252 static FontDataCache* gFontDataCache = 0;
253
254 const int cMaxInactiveFontData = 120; // Pretty Low Threshold
255 const int cTargetInactiveFontData = 100;
256 static ListHashSet<const SimpleFontData*>* gInactiveFontData = 0;
257
258 SimpleFontData* FontCache::getCachedFontData(const FontDescription& fontDescription, const AtomicString& family, bool checkingAlternateName, ShouldRetain shouldRetain)
259 {
260     FontPlatformData* platformData = getCachedFontPlatformData(fontDescription, family, checkingAlternateName);
261     if (!platformData)
262         return 0;
263
264     return getCachedFontData(platformData, shouldRetain);
265 }
266
267 SimpleFontData* FontCache::getCachedFontData(const FontPlatformData* platformData, ShouldRetain shouldRetain)
268 {
269     if (!platformData)
270         return 0;
271
272 #if !ASSERT_DISABLED
273     if (shouldRetain == DoNotRetain)
274         ASSERT(m_purgePreventCount);
275 #endif
276
277     if (!gFontDataCache) {
278         gFontDataCache = new FontDataCache;
279         gInactiveFontData = new ListHashSet<const SimpleFontData*>;
280     }
281
282     FontDataCache::iterator result = gFontDataCache->find(*platformData);
283     if (result == gFontDataCache->end()) {
284         pair<SimpleFontData*, unsigned> newValue(new SimpleFontData(*platformData), shouldRetain == Retain ? 1 : 0);
285         gFontDataCache->set(*platformData, newValue);
286         if (shouldRetain == DoNotRetain)
287             gInactiveFontData->add(newValue.first);
288         return newValue.first;
289     }
290
291     if (!result.get()->second.second) {
292         ASSERT(gInactiveFontData->contains(result.get()->second.first));
293         gInactiveFontData->remove(result.get()->second.first);
294     }
295
296     if (shouldRetain == Retain)
297         result.get()->second.second++;
298     else if (!result.get()->second.second) {
299         // If shouldRetain is DoNotRetain and count is 0, we want to remove the fontData from 
300         // gInactiveFontData (above) and re-add here to update LRU position.
301         gInactiveFontData->add(result.get()->second.first);
302     }
303
304     return result.get()->second.first;
305 }
306
307 void FontCache::releaseFontData(const SimpleFontData* fontData)
308 {
309     ASSERT(gFontDataCache);
310     ASSERT(!fontData->isCustomFont());
311
312     FontDataCache::iterator it = gFontDataCache->find(fontData->platformData());
313     ASSERT(it != gFontDataCache->end());
314
315     ASSERT(it->second.second);
316     if (!--it->second.second)
317         gInactiveFontData->add(fontData);
318 }
319
320 void FontCache::purgeInactiveFontDataIfNeeded()
321 {
322     if (gInactiveFontData && !m_purgePreventCount && gInactiveFontData->size() > cMaxInactiveFontData)
323         purgeInactiveFontData(gInactiveFontData->size() - cTargetInactiveFontData);
324 }
325
326 void FontCache::purgeInactiveFontData(int count)
327 {
328     if (!gInactiveFontData || m_purgePreventCount)
329         return;
330
331     static bool isPurging;  // Guard against reentry when e.g. a deleted FontData releases its small caps FontData.
332     if (isPurging)
333         return;
334
335     isPurging = true;
336
337     Vector<const SimpleFontData*, 20> fontDataToDelete;
338     ListHashSet<const SimpleFontData*>::iterator end = gInactiveFontData->end();
339     ListHashSet<const SimpleFontData*>::iterator it = gInactiveFontData->begin();
340     for (int i = 0; i < count && it != end; ++it, ++i) {
341         const SimpleFontData* fontData = *it.get();
342         gFontDataCache->remove(fontData->platformData());
343         fontDataToDelete.append(fontData);
344     }
345
346     if (it == end) {
347         // Removed everything
348         gInactiveFontData->clear();
349     } else {
350         for (int i = 0; i < count; ++i)
351             gInactiveFontData->remove(gInactiveFontData->begin());
352     }
353
354     size_t fontDataToDeleteCount = fontDataToDelete.size();
355     for (size_t i = 0; i < fontDataToDeleteCount; ++i)
356         delete fontDataToDelete[i];
357
358     if (gFontPlatformDataCache) {
359         Vector<FontPlatformDataCacheKey> keysToRemove;
360         keysToRemove.reserveInitialCapacity(gFontPlatformDataCache->size());
361         FontPlatformDataCache::iterator platformDataEnd = gFontPlatformDataCache->end();
362         for (FontPlatformDataCache::iterator platformData = gFontPlatformDataCache->begin(); platformData != platformDataEnd; ++platformData) {
363             if (platformData->second && !gFontDataCache->contains(*platformData->second))
364                 keysToRemove.append(platformData->first);
365         }
366         
367         size_t keysToRemoveCount = keysToRemove.size();
368         for (size_t i = 0; i < keysToRemoveCount; ++i)
369             delete gFontPlatformDataCache->take(keysToRemove[i]);
370     }
371
372     isPurging = false;
373 }
374
375 size_t FontCache::fontDataCount()
376 {
377     if (gFontDataCache)
378         return gFontDataCache->size();
379     return 0;
380 }
381
382 size_t FontCache::inactiveFontDataCount()
383 {
384     if (gInactiveFontData)
385         return gInactiveFontData->size();
386     return 0;
387 }
388
389 const FontData* FontCache::getFontData(const Font& font, int& familyIndex, FontSelector* fontSelector)
390 {
391     SimpleFontData* result = 0;
392
393     int startIndex = familyIndex;
394     const FontFamily* startFamily = &font.fontDescription().family();
395     for (int i = 0; startFamily && i < startIndex; i++)
396         startFamily = startFamily->next();
397     const FontFamily* currFamily = startFamily;
398     while (currFamily && !result) {
399         familyIndex++;
400         if (currFamily->family().length()) {
401             if (fontSelector) {
402                 FontData* data = fontSelector->getFontData(font.fontDescription(), currFamily->family());
403                 if (data)
404                     return data;
405             }
406             result = getCachedFontData(font.fontDescription(), currFamily->family());
407         }
408         currFamily = currFamily->next();
409     }
410
411     if (!currFamily)
412         familyIndex = cAllFamiliesScanned;
413
414     if (!result)
415         // We didn't find a font. Try to find a similar font using our own specific knowledge about our platform.
416         // For example on OS X, we know to map any families containing the words Arabic, Pashto, or Urdu to the
417         // Geeza Pro font.
418         result = getSimilarFontPlatformData(font);
419
420     if (!result && startIndex == 0) {
421         // If it's the primary font that we couldn't find, we try the following. In all other cases, we will
422         // just use per-character system fallback.
423
424         if (fontSelector) {
425             // Try the user's preferred standard font.
426             if (FontData* data = fontSelector->getFontData(font.fontDescription(), "-webkit-standard"))
427                 return data;
428         }
429
430         // Still no result.  Hand back our last resort fallback font.
431         result = getLastResortFallbackFont(font.fontDescription());
432     }
433     return result;
434 }
435
436 static HashSet<FontSelector*>* gClients;
437
438 void FontCache::addClient(FontSelector* client)
439 {
440     if (!gClients)
441         gClients = new HashSet<FontSelector*>;
442
443     ASSERT(!gClients->contains(client));
444     gClients->add(client);
445 }
446
447 void FontCache::removeClient(FontSelector* client)
448 {
449     ASSERT(gClients);
450     ASSERT(gClients->contains(client));
451
452     gClients->remove(client);
453 }
454
455 static unsigned gGeneration = 0;
456
457 unsigned FontCache::generation()
458 {
459     return gGeneration;
460 }
461
462 void FontCache::invalidate()
463 {
464     if (!gClients) {
465         ASSERT(!gFontPlatformDataCache);
466         return;
467     }
468
469     if (gFontPlatformDataCache) {
470         deleteAllValues(*gFontPlatformDataCache);
471         delete gFontPlatformDataCache;
472         gFontPlatformDataCache = new FontPlatformDataCache;
473     }
474
475     gGeneration++;
476
477     Vector<RefPtr<FontSelector> > clients;
478     size_t numClients = gClients->size();
479     clients.reserveInitialCapacity(numClients);
480     HashSet<FontSelector*>::iterator end = gClients->end();
481     for (HashSet<FontSelector*>::iterator it = gClients->begin(); it != end; ++it)
482         clients.append(*it);
483
484     ASSERT(numClients == clients.size());
485     for (size_t i = 0; i < numClients; ++i)
486         clients[i]->fontCacheInvalidated();
487
488     purgeInactiveFontData();
489 }
490
491 } // namespace WebCore