f78c41ab1bef71713fe8e922762c35ab7bae3266
[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 "WebCoreSystemInterface.h"
29 #import <pal/spi/cocoa/CoreTextSPI.h>
30 #import <wtf/text/WTFString.h>
31
32 #if PLATFORM(IOS)
33 #import <CoreText/CoreText.h>
34 #import <pal/spi/cg/CoreGraphicsSPI.h>
35 #endif
36
37 namespace WebCore {
38
39 // These CoreText Text Spacing feature selectors are not defined in CoreText.
40 enum TextSpacingCTFeatureSelector { TextSpacingProportional, TextSpacingFullWidth, TextSpacingHalfWidth, TextSpacingThirdWidth, TextSpacingQuarterWidth };
41
42 FontPlatformData::FontPlatformData(CTFontRef font, float size, bool syntheticBold, bool syntheticOblique, FontOrientation orientation, FontWidthVariant widthVariant, TextRenderingMode textRenderingMode)
43 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED < 101200
44     : FontPlatformData(adoptCF(CTFontCopyGraphicsFont(font, NULL)).get(), size, syntheticBold, syntheticOblique, orientation, widthVariant, textRenderingMode)
45 #else
46     : FontPlatformData(size, syntheticBold, syntheticOblique, orientation, widthVariant, textRenderingMode)
47 #endif
48 {
49     ASSERT_ARG(font, font);
50     m_font = font;
51     m_isColorBitmapFont = CTFontGetSymbolicTraits(font) & kCTFontTraitColorGlyphs;
52     m_isSystemFont = CTFontDescriptorIsSystemUIFont(adoptCF(CTFontCopyFontDescriptor(m_font.get())).get());
53     auto variations = adoptCF(static_cast<CFDictionaryRef>(CTFontCopyAttribute(font, kCTFontVariationAttribute)));
54     m_hasVariations = variations && CFDictionaryGetCount(variations.get());
55
56 #if PLATFORM(IOS)
57     m_isEmoji = CTFontIsAppleColorEmoji(m_font.get());
58 #endif
59 }
60
61 unsigned FontPlatformData::hash() const
62 {
63     uintptr_t flags = static_cast<uintptr_t>(m_widthVariant << 6 | m_isHashTableDeletedValue << 5 | m_textRenderingMode << 3 | m_orientation << 2 | m_syntheticBold << 1 | m_syntheticOblique);
64 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED < 101200
65     uintptr_t fontHash = reinterpret_cast<uintptr_t>(m_font.get());
66 #else
67     uintptr_t fontHash = reinterpret_cast<uintptr_t>(CFHash(m_font.get()));
68 #endif
69     uintptr_t hashCodes[] = { fontHash, flags };
70     return StringHasher::hashMemory<sizeof(hashCodes)>(hashCodes);
71 }
72
73 bool FontPlatformData::platformIsEqual(const FontPlatformData& other) const
74 {
75     if (!m_font || !other.m_font)
76         return m_font == other.m_font;
77 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED < 101200
78     return m_font == other.m_font;
79 #else
80     return CFEqual(m_font.get(), other.m_font.get());
81 #endif
82 }
83
84 CTFontRef FontPlatformData::registeredFont() const
85 {
86     CTFontRef platformFont = font();
87     ASSERT(platformFont);
88     if (platformFont && adoptCF(CTFontCopyAttribute(platformFont, kCTFontURLAttribute)))
89         return platformFont;
90     return nullptr;
91 }
92
93 inline int mapFontWidthVariantToCTFeatureSelector(FontWidthVariant variant)
94 {
95     switch(variant) {
96     case RegularWidth:
97         return TextSpacingProportional;
98
99     case HalfWidth:
100         return TextSpacingHalfWidth;
101
102     case ThirdWidth:
103         return TextSpacingThirdWidth;
104
105     case QuarterWidth:
106         return TextSpacingQuarterWidth;
107     }
108
109     ASSERT_NOT_REACHED();
110     return TextSpacingProportional;
111 }
112
113 static CFDictionaryRef cascadeToLastResortAttributesDictionary()
114 {
115     static CFDictionaryRef attributes = nullptr;
116     if (attributes)
117         return attributes;
118
119     RetainPtr<CTFontDescriptorRef> lastResort = adoptCF(CTFontDescriptorCreateWithNameAndSize(CFSTR("LastResort"), 0));
120
121     CFTypeRef descriptors[] = { lastResort.get() };
122     RetainPtr<CFArrayRef> array = adoptCF(CFArrayCreate(kCFAllocatorDefault, descriptors, WTF_ARRAY_LENGTH(descriptors), &kCFTypeArrayCallBacks));
123
124     CFTypeRef keys[] = { kCTFontCascadeListAttribute };
125     CFTypeRef values[] = { array.get() };
126     attributes = CFDictionaryCreate(kCFAllocatorDefault, keys, values, WTF_ARRAY_LENGTH(keys), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
127
128     return attributes;
129 }
130
131 static RetainPtr<CTFontDescriptorRef> cascadeToLastResortAndVariationsFontDescriptor(CTFontRef originalFont)
132 {
133 // FIXME: Remove this when <rdar://problem/28449441> is fixed.
134 #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)))
135
136     CFDictionaryRef attributes = cascadeToLastResortAttributesDictionary();
137 #if WORKAROUND_CORETEXT_VARIATIONS_WITH_FALLBACK_LIST_BUG
138     auto variations = adoptCF(static_cast<CFDictionaryRef>(CTFontCopyAttribute(originalFont, kCTFontVariationAttribute)));
139     if (!variations || !CFDictionaryGetCount(variations.get()) || CTFontDescriptorIsSystemUIFont(adoptCF(CTFontCopyFontDescriptor(originalFont)).get()))
140 #endif
141     {
142         UNUSED_PARAM(originalFont);
143
144         static CTFontDescriptorRef descriptor = nullptr;
145         if (descriptor)
146             return descriptor;
147
148         descriptor = CTFontDescriptorCreateWithAttributes(attributes);
149         return descriptor;
150     }
151 #if WORKAROUND_CORETEXT_VARIATIONS_WITH_FALLBACK_LIST_BUG
152     auto mutableAttributes = adoptCF(CFDictionaryCreateMutableCopy(kCFAllocatorDefault, 2, attributes));
153     CFDictionaryAddValue(mutableAttributes.get(), kCTFontVariationAttribute, variations.get());
154     return adoptCF(CTFontDescriptorCreateWithAttributes(mutableAttributes.get()));
155 #endif
156 #undef WORKAROUND_CORETEXT_VARIATIONS_WITH_FALLBACK_LIST_BUG
157 }
158
159 CTFontRef FontPlatformData::ctFont() const
160 {
161     if (m_ctFont)
162         return m_ctFont.get();
163
164     ASSERT(m_font);
165 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED < 101200
166     ASSERT(m_cgFont);
167 #endif
168     m_ctFont = adoptCF(CTFontCreateCopyWithAttributes(m_font.get(), m_size, 0, cascadeToLastResortAndVariationsFontDescriptor(m_font.get()).get()));
169
170     if (m_widthVariant != RegularWidth) {
171         int featureTypeValue = kTextSpacingType;
172         int featureSelectorValue = mapFontWidthVariantToCTFeatureSelector(m_widthVariant);
173         RetainPtr<CTFontDescriptorRef> sourceDescriptor = adoptCF(CTFontCopyFontDescriptor(m_ctFont.get()));
174         RetainPtr<CFNumberRef> featureType = adoptCF(CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &featureTypeValue));
175         RetainPtr<CFNumberRef> featureSelector = adoptCF(CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &featureSelectorValue));
176         RetainPtr<CTFontDescriptorRef> newDescriptor = adoptCF(CTFontDescriptorCreateCopyWithFeature(sourceDescriptor.get(), featureType.get(), featureSelector.get()));
177         RetainPtr<CTFontRef> newFont = adoptCF(CTFontCreateWithFontDescriptor(newDescriptor.get(), m_size, 0));
178
179         if (newFont)
180             m_ctFont = newFont;
181     }
182
183     return m_ctFont.get();
184 }
185
186 RetainPtr<CFTypeRef> FontPlatformData::objectForEqualityCheck(CTFontRef ctFont)
187 {
188     auto fontDescriptor = adoptCF(CTFontCopyFontDescriptor(ctFont));
189     // FIXME: https://bugs.webkit.org/show_bug.cgi?id=138683 This is a shallow pointer compare for web fonts
190     // because the URL contains the address of the font. This means we might erroneously get false negatives.
191     RetainPtr<CFURLRef> url = adoptCF(static_cast<CFURLRef>(CTFontDescriptorCopyAttribute(fontDescriptor.get(), kCTFontReferenceURLAttribute)));
192     ASSERT(!url || CFGetTypeID(url.get()) == CFURLGetTypeID());
193     return url;
194 }
195
196 RetainPtr<CFTypeRef> FontPlatformData::objectForEqualityCheck() const
197 {
198     return objectForEqualityCheck(ctFont());
199 }
200
201 RefPtr<SharedBuffer> FontPlatformData::openTypeTable(uint32_t table) const
202 {
203     if (RetainPtr<CFDataRef> data = adoptCF(CTFontCopyTable(font(), table, kCTFontTableOptionNoOptions)))
204         return SharedBuffer::create(data.get());
205     
206     return nullptr;
207 }
208
209 #ifndef NDEBUG
210 String FontPlatformData::description() const
211 {
212     auto fontDescription = adoptCF(CFCopyDescription(font()));
213     return String(fontDescription.get()) + " " + String::number(m_size)
214             + (m_syntheticBold ? " synthetic bold" : "") + (m_syntheticOblique ? " synthetic oblique" : "") + (m_orientation ? " vertical orientation" : "");
215 }
216 #endif
217
218 } // namespace WebCore