Remove pre-Sierra-OS-specific code in WebCore
[WebKit-https.git] / Source / WebCore / platform / graphics / cocoa / FontPlatformDataCocoa.mm
1 /*
2  * This file is part of the internal font implementation.
3  *
4  * Copyright (C) 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
5  * Copyright (c) 2010 Google Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #import "config.h"
25 #import "FontPlatformData.h"
26
27 #import "SharedBuffer.h"
28 #import <pal/spi/cocoa/CoreTextSPI.h>
29 #import <wtf/text/WTFString.h>
30
31 #if PLATFORM(IOS)
32 #import <CoreText/CoreText.h>
33 #import <pal/spi/cg/CoreGraphicsSPI.h>
34 #endif
35
36 namespace WebCore {
37
38 // These CoreText Text Spacing feature selectors are not defined in CoreText.
39 enum TextSpacingCTFeatureSelector { TextSpacingProportional, TextSpacingFullWidth, TextSpacingHalfWidth, TextSpacingThirdWidth, TextSpacingQuarterWidth };
40
41 FontPlatformData::FontPlatformData(CTFontRef font, float size, bool syntheticBold, bool syntheticOblique, FontOrientation orientation, FontWidthVariant widthVariant, TextRenderingMode textRenderingMode)
42     : FontPlatformData(size, syntheticBold, syntheticOblique, orientation, widthVariant, textRenderingMode)
43 {
44     ASSERT_ARG(font, font);
45     m_font = font;
46     m_isColorBitmapFont = CTFontGetSymbolicTraits(font) & kCTFontTraitColorGlyphs;
47     m_isSystemFont = CTFontDescriptorIsSystemUIFont(adoptCF(CTFontCopyFontDescriptor(m_font.get())).get());
48     auto variations = adoptCF(static_cast<CFDictionaryRef>(CTFontCopyAttribute(font, kCTFontVariationAttribute)));
49     m_hasVariations = variations && CFDictionaryGetCount(variations.get());
50
51 #if PLATFORM(IOS)
52     m_isEmoji = CTFontIsAppleColorEmoji(m_font.get());
53 #endif
54 }
55
56 unsigned FontPlatformData::hash() const
57 {
58     uintptr_t flags = static_cast<uintptr_t>(m_widthVariant << 6 | m_isHashTableDeletedValue << 5 | m_textRenderingMode << 3 | m_orientation << 2 | m_syntheticBold << 1 | m_syntheticOblique);
59     uintptr_t fontHash = reinterpret_cast<uintptr_t>(CFHash(m_font.get()));
60     uintptr_t hashCodes[] = { fontHash, flags };
61     return StringHasher::hashMemory<sizeof(hashCodes)>(hashCodes);
62 }
63
64 bool FontPlatformData::platformIsEqual(const FontPlatformData& other) const
65 {
66     if (!m_font || !other.m_font)
67         return m_font == other.m_font;
68     return CFEqual(m_font.get(), other.m_font.get());
69 }
70
71 CTFontRef FontPlatformData::registeredFont() const
72 {
73     CTFontRef platformFont = font();
74     ASSERT(platformFont);
75     if (platformFont && adoptCF(CTFontCopyAttribute(platformFont, kCTFontURLAttribute)))
76         return platformFont;
77     return nullptr;
78 }
79
80 inline int mapFontWidthVariantToCTFeatureSelector(FontWidthVariant variant)
81 {
82     switch(variant) {
83     case RegularWidth:
84         return TextSpacingProportional;
85
86     case HalfWidth:
87         return TextSpacingHalfWidth;
88
89     case ThirdWidth:
90         return TextSpacingThirdWidth;
91
92     case QuarterWidth:
93         return TextSpacingQuarterWidth;
94     }
95
96     ASSERT_NOT_REACHED();
97     return TextSpacingProportional;
98 }
99
100 static CFDictionaryRef cascadeToLastResortAttributesDictionary()
101 {
102     static CFDictionaryRef attributes = nullptr;
103     if (attributes)
104         return attributes;
105
106     RetainPtr<CTFontDescriptorRef> lastResort = adoptCF(CTFontDescriptorCreateWithNameAndSize(CFSTR("LastResort"), 0));
107
108     CFTypeRef descriptors[] = { lastResort.get() };
109     RetainPtr<CFArrayRef> array = adoptCF(CFArrayCreate(kCFAllocatorDefault, descriptors, WTF_ARRAY_LENGTH(descriptors), &kCFTypeArrayCallBacks));
110
111     CFTypeRef keys[] = { kCTFontCascadeListAttribute };
112     CFTypeRef values[] = { array.get() };
113     attributes = CFDictionaryCreate(kCFAllocatorDefault, keys, values, WTF_ARRAY_LENGTH(keys), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
114
115     return attributes;
116 }
117
118 static RetainPtr<CTFontDescriptorRef> cascadeToLastResortAndVariationsFontDescriptor(CTFontRef originalFont)
119 {
120 // FIXME: Remove this when <rdar://problem/28449441> is fixed.
121 #define WORKAROUND_CORETEXT_VARIATIONS_WITH_FALLBACK_LIST_BUG (ENABLE(VARIATION_FONTS) && ((PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED < 101300) || (PLATFORM(IOS) && __IPHONE_OS_VERSION_MIN_REQUIRED < 110000)))
122
123     CFDictionaryRef attributes = cascadeToLastResortAttributesDictionary();
124 #if WORKAROUND_CORETEXT_VARIATIONS_WITH_FALLBACK_LIST_BUG
125     auto variations = adoptCF(static_cast<CFDictionaryRef>(CTFontCopyAttribute(originalFont, kCTFontVariationAttribute)));
126     if (!variations || !CFDictionaryGetCount(variations.get()) || CTFontDescriptorIsSystemUIFont(adoptCF(CTFontCopyFontDescriptor(originalFont)).get()))
127 #endif
128     {
129         UNUSED_PARAM(originalFont);
130
131         static CTFontDescriptorRef descriptor = nullptr;
132         if (descriptor)
133             return descriptor;
134
135         descriptor = CTFontDescriptorCreateWithAttributes(attributes);
136         return descriptor;
137     }
138 #if WORKAROUND_CORETEXT_VARIATIONS_WITH_FALLBACK_LIST_BUG
139     auto mutableAttributes = adoptCF(CFDictionaryCreateMutableCopy(kCFAllocatorDefault, 2, attributes));
140     CFDictionaryAddValue(mutableAttributes.get(), kCTFontVariationAttribute, variations.get());
141     return adoptCF(CTFontDescriptorCreateWithAttributes(mutableAttributes.get()));
142 #endif
143 #undef WORKAROUND_CORETEXT_VARIATIONS_WITH_FALLBACK_LIST_BUG
144 }
145
146 CTFontRef FontPlatformData::ctFont() const
147 {
148     if (m_ctFont)
149         return m_ctFont.get();
150
151     ASSERT(m_font);
152     m_ctFont = adoptCF(CTFontCreateCopyWithAttributes(m_font.get(), m_size, 0, cascadeToLastResortAndVariationsFontDescriptor(m_font.get()).get()));
153
154     if (m_widthVariant != RegularWidth) {
155         int featureTypeValue = kTextSpacingType;
156         int featureSelectorValue = mapFontWidthVariantToCTFeatureSelector(m_widthVariant);
157         RetainPtr<CTFontDescriptorRef> sourceDescriptor = adoptCF(CTFontCopyFontDescriptor(m_ctFont.get()));
158         RetainPtr<CFNumberRef> featureType = adoptCF(CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &featureTypeValue));
159         RetainPtr<CFNumberRef> featureSelector = adoptCF(CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &featureSelectorValue));
160         RetainPtr<CTFontDescriptorRef> newDescriptor = adoptCF(CTFontDescriptorCreateCopyWithFeature(sourceDescriptor.get(), featureType.get(), featureSelector.get()));
161         RetainPtr<CTFontRef> newFont = adoptCF(CTFontCreateWithFontDescriptor(newDescriptor.get(), m_size, 0));
162
163         if (newFont)
164             m_ctFont = newFont;
165     }
166
167     return m_ctFont.get();
168 }
169
170 RetainPtr<CFTypeRef> FontPlatformData::objectForEqualityCheck(CTFontRef ctFont)
171 {
172     auto fontDescriptor = adoptCF(CTFontCopyFontDescriptor(ctFont));
173     // FIXME: https://bugs.webkit.org/show_bug.cgi?id=138683 This is a shallow pointer compare for web fonts
174     // because the URL contains the address of the font. This means we might erroneously get false negatives.
175     RetainPtr<CFURLRef> url = adoptCF(static_cast<CFURLRef>(CTFontDescriptorCopyAttribute(fontDescriptor.get(), kCTFontReferenceURLAttribute)));
176     ASSERT(!url || CFGetTypeID(url.get()) == CFURLGetTypeID());
177     return url;
178 }
179
180 RetainPtr<CFTypeRef> FontPlatformData::objectForEqualityCheck() const
181 {
182     return objectForEqualityCheck(ctFont());
183 }
184
185 RefPtr<SharedBuffer> FontPlatformData::openTypeTable(uint32_t table) const
186 {
187     if (RetainPtr<CFDataRef> data = adoptCF(CTFontCopyTable(font(), table, kCTFontTableOptionNoOptions)))
188         return SharedBuffer::create(data.get());
189     
190     return nullptr;
191 }
192
193 #ifndef NDEBUG
194 String FontPlatformData::description() const
195 {
196     auto fontDescription = adoptCF(CFCopyDescription(font()));
197     return String(fontDescription.get()) + " " + String::number(m_size)
198             + (m_syntheticBold ? " synthetic bold" : "") + (m_syntheticOblique ? " synthetic oblique" : "") + (m_orientation ? " vertical orientation" : "");
199 }
200 #endif
201
202 } // namespace WebCore