#pragma once
#include "FontDescription.h"
#include "FontPlatformData.h"
#include "Timer.h"
#include <array>
#include <limits.h>
#include <wtf/Forward.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 FontDescriptionKey {
FontDescriptionKey() = default;
FontDescriptionKey(const FontDescription& description)
: m_size(description.computedPixelSize())
, m_fontSelectionRequest(description.fontSelectionRequest())
, m_flags(makeFlagsKey(description))
, m_featureSettings(description.featureSettings())
#if ENABLE(VARIATION_FONTS)
, m_variationSettings(description.variationSettings())
#endif
{ }
explicit FontDescriptionKey(WTF::HashTableDeletedValueType)
: m_size(cHashTableDeletedSize)
{ }
bool operator==(const FontDescriptionKey& other) const
{
return m_size == other.m_size
&& m_fontSelectionRequest == other.m_fontSelectionRequest
&& m_flags == other.m_flags
#if ENABLE(VARIATION_FONTS)
&& m_variationSettings == other.m_variationSettings
#endif
&& m_featureSettings == other.m_featureSettings;
}
bool operator!=(const FontDescriptionKey& other) const
{
return !(*this == other);
}
bool isHashTableDeletedValue() const { return m_size == cHashTableDeletedSize; }
inline unsigned computeHash() const
{
IntegerHasher hasher;
hasher.add(m_size);
hasher.add(m_fontSelectionRequest.weight);
hasher.add(m_fontSelectionRequest.width);
hasher.add(m_fontSelectionRequest.slope);
for (unsigned flagItem : m_flags)
hasher.add(flagItem);
hasher.add(m_featureSettings.hash());
#if ENABLE(VARIATION_FONTS)
hasher.add(m_variationSettings.hash());
#endif
return hasher.hash();
}
private:
static std::array<unsigned, 2> makeFlagsKey(const FontDescription& description)
{
unsigned first = static_cast<unsigned>(description.script()) << 13
| static_cast<unsigned>(description.fontStyleAxis() == FontStyleAxis::slnt) << 12
| static_cast<unsigned>(description.opticalSizing()) << 11
| static_cast<unsigned>(description.textRenderingMode()) << 9
| 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.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 };
FontSelectionRequest m_fontSelectionRequest;
std::array<unsigned, 2> m_flags {{ 0, 0 }};
FontFeatureSettings m_featureSettings;
#if ENABLE(VARIATION_FONTS)
FontVariationSettings m_variationSettings;
#endif
};
struct FontDescriptionKeyHash {
static unsigned hash(const FontDescriptionKey& key)
{
return key.computeHash();
}
static bool equal(const FontDescriptionKey& a, const FontDescriptionKey& 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(COCOA)
WEBCORE_EXPORT static void setFontWhitelist(const Vector<String>&);
#endif
#if PLATFORM(WIN)
IMLangFontLinkType* getFontLinkInterface();
static void comInitialize();
static void comUninitialize();
static IMultiLanguage* getMultiLanguageInterface();
#endif
Vector<FontSelectionCapabilities> getFontSelectionCapabilitiesInFamily(const AtomicString&);
WEBCORE_EXPORT RefPtr<Font> fontForFamily(const FontDescription&, const AtomicString&, const FontFeatureSettings* fontFaceFeatures = nullptr, const FontVariantSettings* fontFaceVariantSettings = nullptr, FontSelectionSpecifiedCapabilities fontFaceCapabilities = { }, bool checkingAlternateName = false);
WEBCORE_EXPORT Ref<Font> lastResortFallbackFont(const FontDescription&);
WEBCORE_EXPORT Ref<Font> fontForPlatformData(const FontPlatformData&);
RefPtr<Font> similarFont(const FontDescription&, const AtomicString& family);
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)
RefPtr<OpenTypeVerticalData> verticalData(const FontPlatformData&);
#endif
std::unique_ptr<FontPlatformData> createFontPlatformDataForTesting(const FontDescription&, const AtomicString& family);
bool shouldMockBoldSystemFontForAccessibility() const { return m_shouldMockBoldSystemFontForAccessibility; }
void setShouldMockBoldSystemFontForAccessibility(bool shouldMockBoldSystemFontForAccessibility) { m_shouldMockBoldSystemFontForAccessibility = shouldMockBoldSystemFontForAccessibility; }
private:
FontCache();
~FontCache() = delete;
WEBCORE_EXPORT void purgeInactiveFontDataIfNeeded();
FontPlatformData* getCachedFontPlatformData(const FontDescription&, const AtomicString& family, const FontFeatureSettings* fontFaceFeatures = nullptr, const FontVariantSettings* fontFaceVariantSettings = nullptr, FontSelectionSpecifiedCapabilities fontFaceCapabilities = { }, bool checkingAlternateName = false);
#if PLATFORM(COCOA)
FontPlatformData* getCustomFallbackFont(const UInt32, const FontDescription&);
#endif
WEBCORE_EXPORT std::unique_ptr<FontPlatformData> createFontPlatformData(const FontDescription&, const AtomicString& family, const FontFeatureSettings* fontFaceFeatures, const FontVariantSettings* fontFaceVariantSettings, FontSelectionSpecifiedCapabilities fontFaceCapabilities);
static const AtomicString& alternateFamilyName(const AtomicString&);
static const AtomicString& platformAlternateFamilyName(const AtomicString&);
Timer m_purgeTimer;
bool m_shouldMockBoldSystemFontForAccessibility { false };
#if PLATFORM(COCOA)
friend class ComplexTextController;
#endif
friend class Font;
};
inline std::unique_ptr<FontPlatformData> FontCache::createFontPlatformDataForTesting(const FontDescription& fontDescription, const AtomicString& family)
{
return createFontPlatformData(fontDescription, family, nullptr, nullptr, { });
}
#if PLATFORM(COCOA)
struct SynthesisPair {
SynthesisPair(bool needsSyntheticBold, bool needsSyntheticOblique)
: needsSyntheticBold(needsSyntheticBold)
, needsSyntheticOblique(needsSyntheticOblique)
{
}
std::pair<bool, bool> boldObliquePair() const
{
return std::make_pair(needsSyntheticBold, needsSyntheticOblique);
}
bool needsSyntheticBold;
bool needsSyntheticOblique;
};
RetainPtr<CTFontRef> preparePlatformFont(CTFontRef, const FontDescription&, const FontFeatureSettings* fontFaceFeatures, const FontVariantSettings* fontFaceVariantSettings, FontSelectionSpecifiedCapabilities fontFaceCapabilities, float size, bool applyWeightWidthSlopeVariations = true);
SynthesisPair computeNecessarySynthesis(CTFontRef, const FontDescription&, bool isPlatformFont = false);
RetainPtr<CTFontRef> platformFontWithFamilySpecialCase(const AtomicString& family, FontSelectionRequest, float size);
RetainPtr<CTFontRef> platformFontWithFamily(const AtomicString& family, FontSelectionRequest, TextRenderingMode, float size);
bool requiresCustomFallbackFont(UChar32 character);
FontSelectionCapabilities capabilitiesForFontDescriptor(CTFontDescriptorRef);
#else
inline void FontCache::platformPurgeInactiveFontData()
{
}
#endif
}