#ifndef FontCache_h
#define FontCache_h
#include "FontDescription.h"
#include "Timer.h"
#include <array>
#include <limits.h>
#include <wtf/Forward.h>
#include <wtf/PassRefPtr.h>
#include <wtf/RefPtr.h>
#include <wtf/Vector.h>
#include <wtf/text/AtomicStringHash.h>
#include <wtf/text/WTFString.h>
#if PLATFORM(COCOA)
#include <CoreText/CTFont.h>
#endif
#if OS(WINDOWS)
#include <windows.h>
#include <objidl.h>
#include <mlang.h>
#endif
namespace WebCore {
class FontCascade;
class FontPlatformData;
class FontSelector;
class OpenTypeVerticalData;
class Font;
#if PLATFORM(WIN)
#if USE(IMLANG_FONT_LINK2)
typedef IMLangFontLink2 IMLangFontLinkType;
#else
typedef IMLangFontLink IMLangFontLinkType;
#endif
#endif
struct FontDescriptionFontDataCacheKey {
FontDescriptionFontDataCacheKey() = default;
FontDescriptionFontDataCacheKey(const FontDescription& description)
: m_size(description.computedPixelSize())
, m_weight(description.weight())
, m_flags(makeFlagsKey(description))
, m_featureSettings(description.featureSettings())
{ }
explicit FontDescriptionFontDataCacheKey(WTF::HashTableDeletedValueType)
: m_size(cHashTableDeletedSize)
{ }
bool operator==(const FontDescriptionFontDataCacheKey& other) const
{
return m_size == other.m_size && m_weight == other.m_weight && m_flags == other.m_flags
&& m_featureSettings == other.m_featureSettings;
}
bool operator!=(const FontDescriptionFontDataCacheKey& other) const
{
return !(*this == other);
}
bool isHashTableDeletedValue() const { return m_size == cHashTableDeletedSize; }
inline unsigned computeHash() const
{
unsigned hashValues[] = { m_size, m_weight, m_flags[0], m_flags[1], m_featureSettings.hash() };
return StringHasher::hashMemory(hashValues, sizeof(hashValues));
}
private:
static std::array<unsigned, 2> makeFlagsKey(const FontDescription& description)
{
static_assert(USCRIPT_CODE_LIMIT < 0x1000, "Script code must fit in an unsigned along with the other flags");
unsigned first = static_cast<unsigned>(description.script()) << 8
| static_cast<unsigned>(description.fontSynthesis()) << 6
| static_cast<unsigned>(description.widthVariant()) << 4
| static_cast<unsigned>(description.nonCJKGlyphOrientation()) << 3
| static_cast<unsigned>(description.orientation()) << 2
| static_cast<unsigned>(description.italic()) << 1
| static_cast<unsigned>(description.renderingMode());
unsigned second = static_cast<unsigned>(description.variantEastAsianRuby()) << 27
| static_cast<unsigned>(description.variantEastAsianWidth()) << 25
| static_cast<unsigned>(description.variantEastAsianVariant()) << 22
| static_cast<unsigned>(description.variantAlternates()) << 21
| static_cast<unsigned>(description.variantNumericSlashedZero()) << 20
| static_cast<unsigned>(description.variantNumericOrdinal()) << 19
| static_cast<unsigned>(description.variantNumericFraction()) << 17
| static_cast<unsigned>(description.variantNumericSpacing()) << 15
| static_cast<unsigned>(description.variantNumericFigure()) << 13
| static_cast<unsigned>(description.variantCaps()) << 10
| static_cast<unsigned>(description.variantPosition()) << 8
| static_cast<unsigned>(description.variantContextualAlternates()) << 6
| static_cast<unsigned>(description.variantHistoricalLigatures()) << 4
| static_cast<unsigned>(description.variantDiscretionaryLigatures()) << 2
| static_cast<unsigned>(description.variantCommonLigatures());
return {{ first, second }};
}
static const unsigned cHashTableDeletedSize = 0xFFFFFFFFU;
unsigned m_size { 0 };
unsigned m_weight { 0 };
std::array<unsigned, 2> m_flags {{ 0, 0 }};
FontFeatureSettings m_featureSettings;
};
struct FontDescriptionKeyHash {
static unsigned hash(const FontDescriptionFontDataCacheKey& key)
{
return key.computeHash();
}
static bool equal(const FontDescriptionFontDataCacheKey& a, const FontDescriptionFontDataCacheKey& b)
{
return a == b;
}
static const bool safeToCompareToEmptyOrDeleted = true;
};
class FontCache {
friend class WTF::NeverDestroyed<FontCache>;
WTF_MAKE_NONCOPYABLE(FontCache); WTF_MAKE_FAST_ALLOCATED;
public:
WEBCORE_EXPORT static FontCache& singleton();
RefPtr<Font> systemFallbackForCharacters(const FontDescription&, const Font* originalFontData, bool isPlatformFont, const UChar* characters, unsigned length);
Vector<String> systemFontFamilies();
void platformInit();
#if PLATFORM(IOS)
static float weightOfCTFont(CTFontRef);
#endif
#if PLATFORM(MAC)
WEBCORE_EXPORT static void setFontWhitelist(const Vector<String>&);
#endif
#if PLATFORM(WIN)
IMLangFontLinkType* getFontLinkInterface();
static void comInitialize();
static void comUninitialize();
static IMultiLanguage* getMultiLanguageInterface();
#endif
void getTraitsInFamily(const AtomicString&, Vector<unsigned>&);
WEBCORE_EXPORT RefPtr<Font> fontForFamily(const FontDescription&, const AtomicString&, bool checkingAlternateName = false);
WEBCORE_EXPORT Ref<Font> lastResortFallbackFont(const FontDescription&);
WEBCORE_EXPORT Ref<Font> fontForPlatformData(const FontPlatformData&);
RefPtr<Font> similarFont(const FontDescription&);
void addClient(FontSelector*);
void removeClient(FontSelector*);
unsigned short generation();
WEBCORE_EXPORT void invalidate();
WEBCORE_EXPORT size_t fontCount();
WEBCORE_EXPORT size_t inactiveFontCount();
WEBCORE_EXPORT void purgeInactiveFontData(unsigned count = UINT_MAX);
void platformPurgeInactiveFontData();
#if PLATFORM(WIN)
RefPtr<Font> fontFromDescriptionAndLogFont(const FontDescription&, const LOGFONT&, AtomicString& outFontFamilyName);
#endif
#if ENABLE(OPENTYPE_VERTICAL)
typedef AtomicString FontFileKey;
PassRefPtr<OpenTypeVerticalData> getVerticalData(const FontFileKey&, const FontPlatformData&);
#endif
private:
FontCache();
~FontCache() = delete;
void purgeTimerFired();
WEBCORE_EXPORT void purgeInactiveFontDataIfNeeded();
FontPlatformData* getCachedFontPlatformData(const FontDescription&, const AtomicString& family, bool checkingAlternateName = false);
#if PLATFORM(IOS)
FontPlatformData* getCustomFallbackFont(const UInt32, const FontDescription&);
PassRefPtr<Font> getSystemFontFallbackForCharacters(const FontDescription&, const Font*, const UChar* characters, unsigned length);
#endif
std::unique_ptr<FontPlatformData> createFontPlatformData(const FontDescription&, const AtomicString& family);
Timer m_purgeTimer;
#if PLATFORM(COCOA)
friend class ComplexTextController;
#endif
friend class Font;
};
#if PLATFORM(COCOA)
RetainPtr<CTFontRef> applyFontFeatureSettings(CTFontRef, const FontFeatureSettings* fontFaceFeatures, const FontVariantSettings* fontFaceVariantSettings, const FontFeatureSettings& features, const FontVariantSettings&);
#endif
#if !PLATFORM(MAC)
inline void FontCache::platformPurgeInactiveFontData()
{
}
#endif
}
#endif