third_party/WebKit/Source/platform/fonts/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 "platform/fonts/FontCache.h"
  32
  33 #include "platform/FontFamilyNames.h"
  34
  35 #include "platform/RuntimeEnabledFeatures.h"
  36 #include "platform/fonts/AlternateFontFamily.h"
  37 #include "platform/fonts/FontCacheClient.h"
  38 #include "platform/fonts/FontCacheKey.h"
  39 #include "platform/fonts/FontDataCache.h"
  40 #include "platform/fonts/FontDescription.h"
  41 #include "platform/fonts/FontPlatformData.h"
  42 #include "platform/fonts/FontSmoothingMode.h"
  43 #include "platform/fonts/SimpleFontData.h"
  44 #include "platform/fonts/TextRenderingMode.h"
  45 #include "platform/fonts/opentype/OpenTypeVerticalData.h"
  46 #include "wtf/HashMap.h"
  47 #include "wtf/ListHashSet.h"
  48 #include "wtf/StdLibExtras.h"
  49 #include "wtf/Vector.h"
  50 #include "wtf/text/AtomicStringHash.h"
  51 #include "wtf/text/StringHash.h"
  52
  53 using namespace WTF;
  54
  55 namespace blink {
  56
  57 #if !OS(WIN)
  58 FontCache::FontCache()
  59     : m_purgePreventCount(0)
  60 {
  61 }
  62 #endif // !OS(WIN)
  63
  64 typedef HashMap<FontCacheKey, OwnPtr<FontPlatformData>, FontCacheKeyHash, FontCacheKeyTraits> FontPlatformDataCache;
  65
  66 static FontPlatformDataCache* gFontPlatformDataCache = 0;
  67
  68 #if OS(WIN)
  69 bool FontCache::s_useDirectWrite = false;
  70 IDWriteFactory* FontCache::s_directWriteFactory = 0;
  71 bool FontCache::s_useSubpixelPositioning = false;
  72 float FontCache::s_deviceScaleFactor = 1.0;
  73 #endif // OS(WIN)
  74
  75 FontCache* FontCache::fontCache()
  76 {
  77     DEFINE_STATIC_LOCAL(FontCache, globalFontCache, ());
  78     return &globalFontCache;
  79 }
  80
  81 FontPlatformData* FontCache::getFontPlatformData(const FontDescription& fontDescription,
  82     const FontFaceCreationParams& creationParams, bool checkingAlternateName)
  83 {
  84     if (!gFontPlatformDataCache) {
  85         gFontPlatformDataCache = new FontPlatformDataCache;
  86         platformInit();
  87     }
  88
  89     FontCacheKey key = fontDescription.cacheKey(creationParams);
  90     FontPlatformData* result = 0;
  91     bool foundResult;
  92     FontPlatformDataCache::iterator it = gFontPlatformDataCache->find(key);
  93     if (it == gFontPlatformDataCache->end()) {
  94         result = createFontPlatformData(fontDescription, creationParams, fontDescription.effectiveFontSize());
  95         gFontPlatformDataCache->set(key, adoptPtr(result));
  96         foundResult = result;
  97     } else {
  98         result = it->value.get();
  99         foundResult = true;
 100     }
 101
 102     if (!foundResult && !checkingAlternateName && creationParams.creationType() == CreateFontByFamily) {
 103         // We were unable to find a font. We have a small set of fonts that we alias to other names,
 104         // e.g., Arial/Helvetica, Courier/Courier New, etc. Try looking up the font under the aliased name.
 105         const AtomicString& alternateName = alternateFamilyName(creationParams.family());
 106         if (!alternateName.isEmpty()) {
 107             FontFaceCreationParams createByAlternateFamily(alternateName);
 108             result = getFontPlatformData(fontDescription, createByAlternateFamily, true);
 109         }
 110         if (result)
 111             gFontPlatformDataCache->set(key, adoptPtr(new FontPlatformData(*result))); // Cache the result under the old name.
 112     }
 113
 114     return result;
 115 }
 116
 117 typedef HashMap<FontCache::FontFileKey, RefPtr<OpenTypeVerticalData>, IntHash<FontCache::FontFileKey>, UnsignedWithZeroKeyHashTraits<FontCache::FontFileKey>> FontVerticalDataCache;
 118
 119 FontVerticalDataCache& fontVerticalDataCacheInstance()
 120 {
 121     DEFINE_STATIC_LOCAL(FontVerticalDataCache, fontVerticalDataCache, ());
 122     return fontVerticalDataCache;
 123 }
 124
 125 PassRefPtr<OpenTypeVerticalData> FontCache::getVerticalData(const FontFileKey& key, const FontPlatformData& platformData)
 126 {
 127     FontVerticalDataCache& fontVerticalDataCache = fontVerticalDataCacheInstance();
 128     FontVerticalDataCache::iterator result = fontVerticalDataCache.find(key);
 129     if (result != fontVerticalDataCache.end())
 130         return result.get()->value;
 131
 132     RefPtr<OpenTypeVerticalData> verticalData = OpenTypeVerticalData::create(platformData);
 133     if (!verticalData->isOpenType())
 134         verticalData.clear();
 135     fontVerticalDataCache.set(key, verticalData);
 136     return verticalData;
 137 }
 138
 139 static FontDataCache* gFontDataCache = 0;
 140
 141 PassRefPtr<SimpleFontData> FontCache::getFontData(const FontDescription& fontDescription, const AtomicString& family, bool checkingAlternateName, ShouldRetain shouldRetain)
 142 {
 143     if (FontPlatformData* platformData = getFontPlatformData(fontDescription, FontFaceCreationParams(adjustFamilyNameToAvoidUnsupportedFonts(family)), checkingAlternateName))
 144         return fontDataFromFontPlatformData(platformData, shouldRetain);
 145
 146     return nullptr;
 147 }
 148
 149 PassRefPtr<SimpleFontData> FontCache::fontDataFromFontPlatformData(const FontPlatformData* platformData, ShouldRetain shouldRetain)
 150 {
 151     if (!gFontDataCache)
 152         gFontDataCache = new FontDataCache;
 153
 154 #if ENABLE(ASSERT)
 155     if (shouldRetain == DoNotRetain)
 156         ASSERT(m_purgePreventCount);
 157 #endif
 158
 159     return gFontDataCache->get(platformData, shouldRetain);
 160 }
 161
 162 bool FontCache::isPlatformFontAvailable(const FontDescription& fontDescription, const AtomicString& family)
 163 {
 164     bool checkingAlternateName = true;
 165     return getFontPlatformData(fontDescription, FontFaceCreationParams(adjustFamilyNameToAvoidUnsupportedFonts(family)), checkingAlternateName);
 166 }
 167
 168 SimpleFontData* FontCache::getNonRetainedLastResortFallbackFont(const FontDescription& fontDescription)
 169 {
 170     return getLastResortFallbackFont(fontDescription, DoNotRetain).leakRef();
 171 }
 172
 173 void FontCache::releaseFontData(const SimpleFontData* fontData)
 174 {
 175     ASSERT(gFontDataCache);
 176
 177     gFontDataCache->release(fontData);
 178 }
 179
 180 static inline void purgePlatformFontDataCache()
 181 {
 182     if (!gFontPlatformDataCache)
 183         return;
 184
 185     Vector<FontCacheKey> keysToRemove;
 186     keysToRemove.reserveInitialCapacity(gFontPlatformDataCache->size());
 187     FontPlatformDataCache::iterator platformDataEnd = gFontPlatformDataCache->end();
 188     for (FontPlatformDataCache::iterator platformData = gFontPlatformDataCache->begin(); platformData != platformDataEnd; ++platformData) {
 189         if (platformData->value && !gFontDataCache->contains(platformData->value.get()))
 190             keysToRemove.append(platformData->key);
 191     }
 192     gFontPlatformDataCache->removeAll(keysToRemove);
 193 }
 194
 195 static inline void purgeFontVerticalDataCache()
 196 {
 197     FontVerticalDataCache& fontVerticalDataCache = fontVerticalDataCacheInstance();
 198     if (!fontVerticalDataCache.isEmpty()) {
 199         // Mark & sweep unused verticalData
 200         FontVerticalDataCache::iterator verticalDataEnd = fontVerticalDataCache.end();
 201         for (FontVerticalDataCache::iterator verticalData = fontVerticalDataCache.begin(); verticalData != verticalDataEnd; ++verticalData) {
 202             if (verticalData->value)
 203                 verticalData->value->setInFontCache(false);
 204         }
 205
 206         gFontDataCache->markAllVerticalData();
 207
 208         Vector<FontCache::FontFileKey> keysToRemove;
 209         keysToRemove.reserveInitialCapacity(fontVerticalDataCache.size());
 210         for (FontVerticalDataCache::iterator verticalData = fontVerticalDataCache.begin(); verticalData != verticalDataEnd; ++verticalData) {
 211             if (!verticalData->value || !verticalData->value->inFontCache())
 212                 keysToRemove.append(verticalData->key);
 213         }
 214         fontVerticalDataCache.removeAll(keysToRemove);
 215     }
 216 }
 217
 218 void FontCache::purge(PurgeSeverity PurgeSeverity)
 219 {
 220     // We should never be forcing the purge while the FontCachePurgePreventer is in scope.
 221     ASSERT(!m_purgePreventCount || PurgeSeverity == PurgeIfNeeded);
 222     if (m_purgePreventCount)
 223         return;
 224
 225     if (!gFontDataCache || !gFontDataCache->purge(PurgeSeverity))
 226         return;
 227
 228     purgePlatformFontDataCache();
 229     purgeFontVerticalDataCache();
 230 }
 231
 232 static bool invalidateFontCache = false;
 233
 234 WillBeHeapHashSet<RawPtrWillBeWeakMember<FontCacheClient>>& fontCacheClients()
 235 {
 236     DEFINE_STATIC_LOCAL(OwnPtrWillBePersistent<WillBeHeapHashSet<RawPtrWillBeWeakMember<FontCacheClient>>>, clients, (adoptPtrWillBeNoop(new WillBeHeapHashSet<RawPtrWillBeWeakMember<FontCacheClient>>())));
 237     invalidateFontCache = true;
 238     return *clients;
 239 }
 240
 241 void FontCache::addClient(FontCacheClient* client)
 242 {
 243     ASSERT(!fontCacheClients().contains(client));
 244     fontCacheClients().add(client);
 245 }
 246
 247 #if !ENABLE(OILPAN)
 248 void FontCache::removeClient(FontCacheClient* client)
 249 {
 250     ASSERT(fontCacheClients().contains(client));
 251     fontCacheClients().remove(client);
 252 }
 253 #endif
 254
 255 static unsigned short gGeneration = 0;
 256
 257 unsigned short FontCache::generation()
 258 {
 259     return gGeneration;
 260 }
 261
 262 void FontCache::invalidate()
 263 {
 264     if (!invalidateFontCache) {
 265         ASSERT(!gFontPlatformDataCache);
 266         return;
 267     }
 268
 269     if (gFontPlatformDataCache) {
 270         delete gFontPlatformDataCache;
 271         gFontPlatformDataCache = new FontPlatformDataCache;
 272     }
 273
 274     gGeneration++;
 275
 276     WillBeHeapVector<RefPtrWillBeMember<FontCacheClient>> clients;
 277     size_t numClients = fontCacheClients().size();
 278     clients.reserveInitialCapacity(numClients);
 279     WillBeHeapHashSet<RawPtrWillBeWeakMember<FontCacheClient>>::iterator end = fontCacheClients().end();
 280     for (WillBeHeapHashSet<RawPtrWillBeWeakMember<FontCacheClient>>::iterator it = fontCacheClients().begin(); it != end; ++it)
 281         clients.append(*it);
 282
 283     ASSERT(numClients == clients.size());
 284     for (size_t i = 0; i < numClients; ++i)
 285         clients[i]->fontCacheInvalidated();
 286
 287     purge(ForcePurge);
 288 }
 289
 290 } // namespace blink