Part 2 of removing PlatformString.h, remove PlatformString.h
[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 "WebCoreSystemInterface.h"
28 #import <AppKit/NSFont.h>
29 #import <wtf/text/WTFString.h>
30
31 #if PLATFORM(CHROMIUM) && OS(DARWIN)
32 #import "HarfBuzzNGFace.h"
33 #endif
34
35 namespace WebCore {
36
37 // These CoreText Text Spacing feature selectors are not defined in CoreText.
38 enum TextSpacingCTFeatureSelector { TextSpacingProportional, TextSpacingFullWidth, TextSpacingHalfWidth, TextSpacingThirdWidth, TextSpacingQuarterWidth };
39
40 #if PLATFORM(MAC)
41 void FontPlatformData::loadFont(NSFont* nsFont, float, NSFont*& outNSFont, CGFontRef& cgFont)
42 {
43     outNSFont = nsFont;
44     cgFont = CTFontCopyGraphicsFont(toCTFontRef(nsFont), 0);
45 }
46 #endif  // PLATFORM(MAC)
47
48 FontPlatformData::FontPlatformData(NSFont *nsFont, float size, bool isPrinterFont, bool syntheticBold, bool syntheticOblique, FontOrientation orientation,
49                                    TextOrientation textOrientation, FontWidthVariant widthVariant)
50     : m_syntheticBold(syntheticBold)
51     , m_syntheticOblique(syntheticOblique)
52     , m_orientation(orientation)
53     , m_textOrientation(textOrientation)
54     , m_size(size)
55     , m_widthVariant(widthVariant)
56     , m_font(nsFont)
57     , m_isColorBitmapFont(false)
58     , m_isCompositeFontReference(false)
59     , m_isPrinterFont(isPrinterFont)
60 {
61     ASSERT_ARG(nsFont, nsFont);
62
63     CGFontRef cgFont = 0;
64     loadFont(nsFont, size, m_font, cgFont);
65     
66 #if PLATFORM(IOS) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 1070
67     // FIXME: Chromium: The following code isn't correct for the Chromium port since the sandbox might
68     // have blocked font loading, in which case we'll only have the real loaded font file after the call to loadFont().
69     {
70         CTFontSymbolicTraits traits = CTFontGetSymbolicTraits(toCTFontRef(m_font));
71         m_isColorBitmapFont = traits & kCTFontColorGlyphsTrait;
72 #if PLATFORM(IOS) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 1080
73         m_isCompositeFontReference = traits & kCTFontCompositeTrait;
74 #endif
75     }
76 #endif
77
78     if (m_font)
79         CFRetain(m_font);
80
81     m_cgFont.adoptCF(cgFont);
82 }
83
84 FontPlatformData:: ~FontPlatformData()
85 {
86     if (m_font && m_font != reinterpret_cast<NSFont *>(-1))
87         CFRelease(m_font);
88 }
89
90 void FontPlatformData::platformDataInit(const FontPlatformData& f)
91 {
92     m_font = f.m_font && f.m_font != reinterpret_cast<NSFont *>(-1) ? const_cast<NSFont *>(static_cast<const NSFont *>(CFRetain(f.m_font))) : f.m_font;
93
94     m_cgFont = f.m_cgFont;
95     m_CTFont = f.m_CTFont;
96
97 #if PLATFORM(CHROMIUM) && OS(DARWIN)
98     m_inMemoryFont = f.m_inMemoryFont;
99     m_harfbuzzFace = f.m_harfbuzzFace;
100 #endif
101 }
102
103 const FontPlatformData& FontPlatformData::platformDataAssign(const FontPlatformData& f)
104 {
105     m_cgFont = f.m_cgFont;
106     if (m_font == f.m_font)
107         return *this;
108     if (f.m_font && f.m_font != reinterpret_cast<NSFont *>(-1))
109         CFRetain(f.m_font);
110     if (m_font && m_font != reinterpret_cast<NSFont *>(-1))
111         CFRelease(m_font);
112     m_font = f.m_font;
113     m_CTFont = f.m_CTFont;
114 #if PLATFORM(CHROMIUM) && OS(DARWIN)
115     m_inMemoryFont = f.m_inMemoryFont;
116     m_harfbuzzFace = f.m_harfbuzzFace;
117 #endif
118     return *this;
119 }
120
121 bool FontPlatformData::platformIsEqual(const FontPlatformData& other) const
122 {
123     if (m_font || other.m_font)
124         return m_font == other.m_font;
125     return m_cgFont == other.m_cgFont;
126 }
127
128 void FontPlatformData::setFont(NSFont *font)
129 {
130     ASSERT_ARG(font, font);
131     ASSERT(m_font != reinterpret_cast<NSFont *>(-1));
132
133     if (m_font == font)
134         return;
135
136     CFRetain(font);
137     if (m_font)
138         CFRelease(m_font);
139     m_font = font;
140     m_size = [font pointSize];
141     
142     CGFontRef cgFont = 0;
143     NSFont* loadedFont = 0;
144     loadFont(m_font, m_size, loadedFont, cgFont);
145     
146 #if PLATFORM(CHROMIUM) && OS(DARWIN)
147     // If loadFont replaced m_font with a fallback font, then release the
148     // previous font to counter the retain above. Then retain the new font.
149     if (loadedFont != m_font) {
150         CFRelease(m_font);
151         CFRetain(loadedFont);
152         m_font = loadedFont;
153     }
154 #endif
155     
156     m_cgFont.adoptCF(cgFont);
157 #if PLATFORM(IOS) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 1070
158     {
159         CTFontSymbolicTraits traits = CTFontGetSymbolicTraits(toCTFontRef(m_font));
160         m_isColorBitmapFont = traits & kCTFontColorGlyphsTrait;
161 #if PLATFORM(IOS) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 1080
162         m_isCompositeFontReference = traits & kCTFontCompositeTrait;
163 #endif
164     }
165 #endif
166     m_CTFont = 0;
167 }
168
169 bool FontPlatformData::roundsGlyphAdvances() const
170 {
171     return [m_font renderingMode] == NSFontAntialiasedIntegerAdvancementsRenderingMode;
172 }
173
174 bool FontPlatformData::allowsLigatures() const
175 {
176     return ![[m_font coveredCharacterSet] characterIsMember:'a'];
177 }
178
179 inline int mapFontWidthVariantToCTFeatureSelector(FontWidthVariant variant)
180 {
181     switch(variant) {
182     case RegularWidth:
183         return TextSpacingProportional;
184
185     case HalfWidth:
186         return TextSpacingHalfWidth;
187
188     case ThirdWidth:
189         return TextSpacingThirdWidth;
190
191     case QuarterWidth:
192         return TextSpacingQuarterWidth;
193     }
194
195     ASSERT_NOT_REACHED();
196     return TextSpacingProportional;
197 }
198
199 static CFDictionaryRef createFeatureSettingDictionary(int featureTypeIdentifier, int featureSelectorIdentifier)
200 {
201     RetainPtr<CFNumberRef> featureTypeIdentifierNumber(AdoptCF, CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &featureTypeIdentifier));
202     RetainPtr<CFNumberRef> featureSelectorIdentifierNumber(AdoptCF, CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &featureSelectorIdentifier));
203
204     const void* settingKeys[] = { kCTFontFeatureTypeIdentifierKey, kCTFontFeatureSelectorIdentifierKey };
205     const void* settingValues[] = { featureTypeIdentifierNumber.get(), featureSelectorIdentifierNumber.get() };
206
207     return CFDictionaryCreate(kCFAllocatorDefault, settingKeys, settingValues, WTF_ARRAY_LENGTH(settingKeys), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
208 }
209
210 static CTFontDescriptorRef cascadeToLastResortFontDescriptor()
211 {
212     static CTFontDescriptorRef descriptor;
213     if (descriptor)
214         return descriptor;
215
216     const void* keys[] = { kCTFontCascadeListAttribute };
217     const void* descriptors[] = { CTFontDescriptorCreateWithNameAndSize(CFSTR("LastResort"), 0) };
218     const void* values[] = { CFArrayCreate(kCFAllocatorDefault, descriptors, WTF_ARRAY_LENGTH(descriptors), &kCFTypeArrayCallBacks) };
219     RetainPtr<CFDictionaryRef> attributes(AdoptCF, CFDictionaryCreate(kCFAllocatorDefault, keys, values, WTF_ARRAY_LENGTH(keys), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
220
221     descriptor = CTFontDescriptorCreateWithAttributes(attributes.get());
222
223     return descriptor;
224 }
225
226 static CTFontDescriptorRef cascadeToLastResortAndDisableSwashesFontDescriptor()
227 {
228     static CTFontDescriptorRef descriptor;
229     if (descriptor)
230         return descriptor;
231
232     RetainPtr<CFDictionaryRef> lineInitialSwashesOffSetting(AdoptCF, createFeatureSettingDictionary(kSmartSwashType, kLineInitialSwashesOffSelector));
233     RetainPtr<CFDictionaryRef> lineFinalSwashesOffSetting(AdoptCF, createFeatureSettingDictionary(kSmartSwashType, kLineFinalSwashesOffSelector));
234
235     const void* settingDictionaries[] = { lineInitialSwashesOffSetting.get(), lineFinalSwashesOffSetting.get() };
236     RetainPtr<CFArrayRef> featureSettings(AdoptCF, CFArrayCreate(kCFAllocatorDefault, settingDictionaries, WTF_ARRAY_LENGTH(settingDictionaries), &kCFTypeArrayCallBacks));
237
238     const void* keys[] = { kCTFontFeatureSettingsAttribute };
239     const void* values[] = { featureSettings.get() };
240     RetainPtr<CFDictionaryRef> attributes(AdoptCF, CFDictionaryCreate(kCFAllocatorDefault, keys, values, WTF_ARRAY_LENGTH(keys), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
241
242     descriptor = CTFontDescriptorCreateCopyWithAttributes(cascadeToLastResortFontDescriptor(), attributes.get());
243
244     return descriptor;
245 }
246
247 // Adding a cascade list breaks the font on Leopard
248 static bool canSetCascadeListForCustomFont()
249 {
250 #if PLATFORM(IOS) || __MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
251     return true;
252 #else
253     return false;
254 #endif
255 }
256
257 CTFontRef FontPlatformData::ctFont() const
258 {
259     if (m_CTFont)
260         return m_CTFont.get();
261
262 #if PLATFORM(CHROMIUM)
263     if (m_inMemoryFont) {
264         m_CTFont.adoptCF(CTFontCreateWithGraphicsFont(m_inMemoryFont->cgFont(), m_size, 0, canSetCascadeListForCustomFont() ? cascadeToLastResortFontDescriptor() : 0));
265         return m_CTFont.get();
266     }
267 #endif
268
269     m_CTFont = toCTFontRef(m_font);
270     if (m_CTFont) {
271         CTFontDescriptorRef fontDescriptor;
272         RetainPtr<CFStringRef> postScriptName(AdoptCF, CTFontCopyPostScriptName(m_CTFont.get()));
273         // Hoefler Text Italic has line-initial and -final swashes enabled by default, so disable them.
274         if (CFEqual(postScriptName.get(), CFSTR("HoeflerText-Italic")) || CFEqual(postScriptName.get(), CFSTR("HoeflerText-BlackItalic")))
275             fontDescriptor = cascadeToLastResortAndDisableSwashesFontDescriptor();
276         else
277             fontDescriptor = cascadeToLastResortFontDescriptor();
278         m_CTFont.adoptCF(CTFontCreateCopyWithAttributes(m_CTFont.get(), m_size, 0, fontDescriptor));
279     } else
280         m_CTFont.adoptCF(CTFontCreateWithGraphicsFont(m_cgFont.get(), m_size, 0, canSetCascadeListForCustomFont() ? cascadeToLastResortFontDescriptor() : 0));
281
282     if (m_widthVariant != RegularWidth) {
283         int featureTypeValue = kTextSpacingType;
284         int featureSelectorValue = mapFontWidthVariantToCTFeatureSelector(m_widthVariant);
285         RetainPtr<CTFontDescriptorRef> sourceDescriptor(AdoptCF, CTFontCopyFontDescriptor(m_CTFont.get()));
286         RetainPtr<CFNumberRef> featureType(AdoptCF, CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &featureTypeValue));
287         RetainPtr<CFNumberRef> featureSelector(AdoptCF, CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &featureSelectorValue));
288         RetainPtr<CTFontDescriptorRef> newDescriptor(AdoptCF, CTFontDescriptorCreateCopyWithFeature(sourceDescriptor.get(), featureType.get(), featureSelector.get()));
289         RetainPtr<CTFontRef> newFont(AdoptCF, CTFontCreateWithFontDescriptor(newDescriptor.get(), m_size, 0));
290
291         if (newFont)
292             m_CTFont = newFont;
293     }
294
295     return m_CTFont.get();
296 }
297
298 #if PLATFORM(CHROMIUM) && OS(DARWIN)
299 static bool isAATFont(CTFontRef ctFont)
300 {
301     CFDataRef table = CTFontCopyTable(ctFont, kCTFontTableMort, 0);
302     if (table) {
303         CFRelease(table);
304         return true;
305     }
306     table = CTFontCopyTable(ctFont, kCTFontTableMorx, 0);
307     if (table) {
308         CFRelease(table);
309         return true;
310     }
311     return false;
312 }
313
314 HarfBuzzNGFace* FontPlatformData::harfbuzzFace()
315 {
316     CTFontRef font = ctFont();
317     // HarfBuzz can't handle AAT font
318     if (isAATFont(font))
319         return 0;
320
321     if (!m_harfbuzzFace) {
322         uint64_t uniqueID = reinterpret_cast<uintptr_t>(font);
323         m_harfbuzzFace = HarfBuzzNGFace::create(const_cast<FontPlatformData*>(this), uniqueID);
324     }
325     return m_harfbuzzFace.get();
326 }
327 #endif
328
329 #ifndef NDEBUG
330 String FontPlatformData::description() const
331 {
332     RetainPtr<CFStringRef> cgFontDescription(AdoptCF, CFCopyDescription(cgFont()));
333     return String(cgFontDescription.get()) + " " + String::number(m_size)
334             + (m_syntheticBold ? " synthetic bold" : "") + (m_syntheticOblique ? " synthetic oblique" : "") + (m_orientation ? " vertical orientation" : "");
335 }
336 #endif
337
338 } // namespace WebCore