8930117278dcf3fb1ef08901d77b54dec4b47e83
[WebKit-https.git] / Source / WebCore / platform / graphics / mac / SimpleFontDataMac.mm
1 /*
2  * Copyright (C) 2005, 2006 Apple Computer, Inc.  All rights reserved.
3  * Copyright (C) 2006 Alexey Proskuryakov
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #import "config.h"
31 #import "SimpleFontData.h"
32
33 #import "BlockExceptions.h"
34 #import "Color.h"
35 #import "FloatRect.h"
36 #import "Font.h"
37 #import "FontCache.h"
38 #import "FontDescription.h"
39 #import "SharedBuffer.h"
40 #import "WebCoreSystemInterface.h"
41 #import <AppKit/AppKit.h>
42 #import <ApplicationServices/ApplicationServices.h>
43 #import <float.h>
44 #import <unicode/uchar.h>
45 #import <wtf/Assertions.h>
46 #import <wtf/StdLibExtras.h>
47 #import <wtf/RetainPtr.h>
48 #import <wtf/UnusedParam.h>
49
50 @interface NSFont (WebAppKitSecretAPI)
51 - (BOOL)_isFakeFixedPitch;
52 @end
53
54 using namespace std;
55
56 namespace WebCore {
57   
58 const float smallCapsFontSizeMultiplier = 0.7f;
59 static inline float scaleEmToUnits(float x, unsigned unitsPerEm) { return x / unitsPerEm; }
60
61 static bool initFontData(SimpleFontData* fontData)
62 {
63     if (!fontData->platformData().cgFont())
64         return false;
65
66
67     return true;
68 }
69
70 static NSString *webFallbackFontFamily(void)
71 {
72     DEFINE_STATIC_LOCAL(RetainPtr<NSString>, webFallbackFontFamily, ([[NSFont systemFontOfSize:16.0f] familyName]));
73     return webFallbackFontFamily.get();
74 }
75
76 #if !ERROR_DISABLED
77 #if defined(__LP64__) || (!defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD))
78 static NSString* pathFromFont(NSFont*)
79 {
80     // FMGetATSFontRefFromFont is not available. As pathFromFont is only used for debugging purposes,
81     // returning nil is acceptable.
82     return nil;
83 }
84 #else
85 static NSString* pathFromFont(NSFont *font)
86 {
87     ATSFontRef atsFont = FMGetATSFontRefFromFont(CTFontGetPlatformFont(toCTFontRef(font), 0));
88     FSRef fileRef;
89
90     OSStatus status = ATSFontGetFileReference(atsFont, &fileRef);
91     if (status != noErr)
92         return nil;
93
94     UInt8 filePathBuffer[PATH_MAX];
95     status = FSRefMakePath(&fileRef, filePathBuffer, PATH_MAX);
96     if (status == noErr)
97         return [NSString stringWithUTF8String:(const char*)filePathBuffer];
98
99     return nil;
100 }
101 #endif // __LP64__
102 #endif // !ERROR_DISABLED
103
104 void SimpleFontData::platformInit()
105 {
106 #if USE(ATSUI)
107     m_ATSUMirrors = false;
108     m_checkedShapesArabic = false;
109     m_shapesArabic = false;
110 #endif
111
112     m_syntheticBoldOffset = m_platformData.m_syntheticBold ? 1.0f : 0.f;
113
114     bool failedSetup = false;
115     if (!initFontData(this)) {
116         // Ack! Something very bad happened, like a corrupt font.
117         // Try looking for an alternate 'base' font for this renderer.
118
119         // Special case hack to use "Times New Roman" in place of "Times".
120         // "Times RO" is a common font whose family name is "Times".
121         // It overrides the normal "Times" family font.
122         // It also appears to have a corrupt regular variant.
123         NSString *fallbackFontFamily;
124         if ([[m_platformData.font() familyName] isEqual:@"Times"])
125             fallbackFontFamily = @"Times New Roman";
126         else
127             fallbackFontFamily = webFallbackFontFamily();
128         
129         // Try setting up the alternate font.
130         // This is a last ditch effort to use a substitute font when something has gone wrong.
131 #if !ERROR_DISABLED
132         RetainPtr<NSFont> initialFont = m_platformData.font();
133 #endif
134         if (m_platformData.font())
135             m_platformData.setFont([[NSFontManager sharedFontManager] convertFont:m_platformData.font() toFamily:fallbackFontFamily]);
136         else
137             m_platformData.setFont([NSFont fontWithName:fallbackFontFamily size:m_platformData.size()]);
138 #if !ERROR_DISABLED
139         NSString *filePath = pathFromFont(initialFont.get());
140         if (!filePath)
141             filePath = @"not known";
142 #endif
143         if (!initFontData(this)) {
144             if ([fallbackFontFamily isEqual:@"Times New Roman"]) {
145                 // OK, couldn't setup Times New Roman as an alternate to Times, fallback
146                 // on the system font.  If this fails we have no alternative left.
147                 m_platformData.setFont([[NSFontManager sharedFontManager] convertFont:m_platformData.font() toFamily:webFallbackFontFamily()]);
148                 if (!initFontData(this)) {
149                     // We tried, Times, Times New Roman, and the system font. No joy. We have to give up.
150                     LOG_ERROR("unable to initialize with font %@ at %@", initialFont.get(), filePath);
151                     failedSetup = true;
152                 }
153             } else {
154                 // We tried the requested font and the system font. No joy. We have to give up.
155                 LOG_ERROR("unable to initialize with font %@ at %@", initialFont.get(), filePath);
156                 failedSetup = true;
157             }
158         }
159
160         // Report the problem.
161         LOG_ERROR("Corrupt font detected, using %@ in place of %@ located at \"%@\".",
162             [m_platformData.font() familyName], [initialFont.get() familyName], filePath);
163     }
164
165     // If all else fails, try to set up using the system font.
166     // This is probably because Times and Times New Roman are both unavailable.
167     if (failedSetup) {
168         m_platformData.setFont([NSFont systemFontOfSize:[m_platformData.font() pointSize]]);
169         LOG_ERROR("failed to set up font, using system font %s", m_platformData.font());
170         initFontData(this);
171     }
172     
173     int iAscent;
174     int iDescent;
175     int iLineGap;
176     unsigned unitsPerEm;
177     iAscent = CGFontGetAscent(m_platformData.cgFont());
178     iDescent = CGFontGetDescent(m_platformData.cgFont());
179     iLineGap = CGFontGetLeading(m_platformData.cgFont());
180     unitsPerEm = CGFontGetUnitsPerEm(m_platformData.cgFont());
181
182     float pointSize = m_platformData.m_size;
183     float ascent = scaleEmToUnits(iAscent, unitsPerEm) * pointSize;
184     float descent = -scaleEmToUnits(iDescent, unitsPerEm) * pointSize;
185     float lineGap = scaleEmToUnits(iLineGap, unitsPerEm) * pointSize;
186
187     // We need to adjust Times, Helvetica, and Courier to closely match the
188     // vertical metrics of their Microsoft counterparts that are the de facto
189     // web standard. The AppKit adjustment of 20% is too big and is
190     // incorrectly added to line spacing, so we use a 15% adjustment instead
191     // and add it to the ascent.
192     NSString *familyName = [m_platformData.font() familyName];
193     if ([familyName isEqualToString:@"Times"] || [familyName isEqualToString:@"Helvetica"] || [familyName isEqualToString:@"Courier"])
194         ascent += floorf(((ascent + descent) * 0.15f) + 0.5f);
195 #if defined(BUILDING_ON_LEOPARD)
196     else if ([familyName isEqualToString:@"Geeza Pro"]) {
197         // Geeza Pro has glyphs that draw slightly above the ascent or far below the descent. Adjust
198         // those vertical metrics to better match reality, so that diacritics at the bottom of one line
199         // do not overlap diacritics at the top of the next line.
200         ascent *= 1.08f;
201         descent *= 2.f;
202     }
203 #endif
204
205     // Compute and store line spacing, before the line metrics hacks are applied.
206     m_fontMetrics.setLineSpacing(lroundf(ascent) + lroundf(descent) + lroundf(lineGap));
207
208     // Hack Hiragino line metrics to allow room for marked text underlines.
209     // <rdar://problem/5386183>
210     if (descent < 3 && lineGap >= 3 && [familyName hasPrefix:@"Hiragino"]) {
211         lineGap -= 3 - descent;
212         descent = 3;
213     }
214     
215     if (platformData().orientation() == Vertical && !isTextOrientationFallback()) {
216         // The check doesn't look neat but this is what AppKit does for vertical writing...
217         RetainPtr<CFArrayRef> tableTags(AdoptCF, CTFontCopyAvailableTables(m_platformData.ctFont(), kCTFontTableOptionExcludeSynthetic));
218         CFIndex numTables = CFArrayGetCount(tableTags.get());
219         for (CFIndex index = 0; index < numTables; ++index) {
220             CTFontTableTag tag = (CTFontTableTag)(uintptr_t)CFArrayGetValueAtIndex(tableTags.get(), index);
221             if (tag == kCTFontTableVhea || tag == kCTFontTableVORG) {
222                 m_hasVerticalGlyphs = true;
223                 break;
224             }
225         }
226     }
227
228     float xHeight;
229
230     if (platformData().orientation() == Horizontal) {
231         // Measure the actual character "x", since it's possible for it to extend below the baseline, and we need the
232         // reported x-height to only include the portion of the glyph that is above the baseline.
233         GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
234         NSGlyph xGlyph = glyphPageZero ? glyphPageZero->glyphDataForCharacter('x').glyph : 0;
235         if (xGlyph)
236             xHeight = -CGRectGetMinY(platformBoundsForGlyph(xGlyph));
237         else
238             xHeight = scaleEmToUnits(CGFontGetXHeight(m_platformData.cgFont()), unitsPerEm) * pointSize;
239     } else
240         xHeight = verticalRightOrientationFontData()->fontMetrics().xHeight();
241
242     m_fontMetrics.setUnitsPerEm(unitsPerEm);
243     m_fontMetrics.setAscent(ascent);
244     m_fontMetrics.setDescent(descent);
245     m_fontMetrics.setLineGap(lineGap);
246     m_fontMetrics.setXHeight(xHeight);
247 }
248
249 static CFDataRef copyFontTableForTag(FontPlatformData& platformData, FourCharCode tableName)
250 {
251     return CGFontCopyTableForTag(platformData.cgFont(), tableName);
252 }
253
254 void SimpleFontData::platformCharWidthInit()
255 {
256     m_avgCharWidth = 0;
257     m_maxCharWidth = 0;
258     
259     RetainPtr<CFDataRef> os2Table(AdoptCF, copyFontTableForTag(m_platformData, 'OS/2'));
260     if (os2Table && CFDataGetLength(os2Table.get()) >= 4) {
261         const UInt8* os2 = CFDataGetBytePtr(os2Table.get());
262         SInt16 os2AvgCharWidth = os2[2] * 256 + os2[3];
263         m_avgCharWidth = scaleEmToUnits(os2AvgCharWidth, m_fontMetrics.unitsPerEm()) * m_platformData.m_size;
264     }
265
266     RetainPtr<CFDataRef> headTable(AdoptCF, copyFontTableForTag(m_platformData, 'head'));
267     if (headTable && CFDataGetLength(headTable.get()) >= 42) {
268         const UInt8* head = CFDataGetBytePtr(headTable.get());
269         ushort uxMin = head[36] * 256 + head[37];
270         ushort uxMax = head[40] * 256 + head[41];
271         SInt16 xMin = static_cast<SInt16>(uxMin);
272         SInt16 xMax = static_cast<SInt16>(uxMax);
273         float diff = static_cast<float>(xMax - xMin);
274         m_maxCharWidth = scaleEmToUnits(diff, m_fontMetrics.unitsPerEm()) * m_platformData.m_size;
275     }
276
277     // Fallback to a cross-platform estimate, which will populate these values if they are non-positive.
278     initCharWidths();
279 }
280
281 void SimpleFontData::platformDestroy()
282 {
283     if (!isCustomFont() && m_derivedFontData) {
284         // These come from the cache.
285         if (m_derivedFontData->smallCaps)
286             fontCache()->releaseFontData(m_derivedFontData->smallCaps.leakPtr());
287
288         if (m_derivedFontData->emphasisMark)
289             fontCache()->releaseFontData(m_derivedFontData->emphasisMark.leakPtr());
290     }
291
292 #if USE(ATSUI)
293     HashMap<unsigned, ATSUStyle>::iterator end = m_ATSUStyleMap.end();
294     for (HashMap<unsigned, ATSUStyle>::iterator it = m_ATSUStyleMap.begin(); it != end; ++it)
295         ATSUDisposeStyle(it->second);
296 #endif
297 }
298
299 PassOwnPtr<SimpleFontData> SimpleFontData::createScaledFontData(const FontDescription& fontDescription, float scaleFactor) const
300 {
301     if (isCustomFont()) {
302         FontPlatformData scaledFontData(m_platformData);
303         scaledFontData.m_size = scaledFontData.m_size * scaleFactor;
304         return adoptPtr(new SimpleFontData(scaledFontData, true, false));
305     }
306
307     BEGIN_BLOCK_OBJC_EXCEPTIONS;
308     float size = m_platformData.size() * scaleFactor;
309     FontPlatformData scaledFontData([[NSFontManager sharedFontManager] convertFont:m_platformData.font() toSize:size], size, false, false, m_platformData.orientation());
310
311     // AppKit resets the type information (screen/printer) when you convert a font to a different size.
312     // We have to fix up the font that we're handed back.
313     scaledFontData.setFont(fontDescription.usePrinterFont() ? [scaledFontData.font() printerFont] : [scaledFontData.font() screenFont]);
314
315     if (scaledFontData.font()) {
316         NSFontManager *fontManager = [NSFontManager sharedFontManager];
317         NSFontTraitMask fontTraits = [fontManager traitsOfFont:m_platformData.font()];
318
319         if (m_platformData.m_syntheticBold)
320             fontTraits |= NSBoldFontMask;
321         if (m_platformData.m_syntheticOblique)
322             fontTraits |= NSItalicFontMask;
323
324         NSFontTraitMask scaledFontTraits = [fontManager traitsOfFont:scaledFontData.font()];
325         scaledFontData.m_syntheticBold = (fontTraits & NSBoldFontMask) && !(scaledFontTraits & NSBoldFontMask);
326         scaledFontData.m_syntheticOblique = (fontTraits & NSItalicFontMask) && !(scaledFontTraits & NSItalicFontMask);
327
328         // SimpleFontData::platformDestroy() takes care of not deleting the cached font data twice.
329         return adoptPtr(fontCache()->getCachedFontData(&scaledFontData));
330     }
331     END_BLOCK_OBJC_EXCEPTIONS;
332
333     return nullptr;
334 }
335
336 SimpleFontData* SimpleFontData::smallCapsFontData(const FontDescription& fontDescription) const
337 {
338     if (!m_derivedFontData)
339         m_derivedFontData = DerivedFontData::create(isCustomFont());
340     if (!m_derivedFontData->smallCaps)
341         m_derivedFontData->smallCaps = createScaledFontData(fontDescription, smallCapsFontSizeMultiplier);
342
343     return m_derivedFontData->smallCaps.get();
344 }
345
346 SimpleFontData* SimpleFontData::emphasisMarkFontData(const FontDescription& fontDescription) const
347 {
348     if (!m_derivedFontData)
349         m_derivedFontData = DerivedFontData::create(isCustomFont());
350     if (!m_derivedFontData->emphasisMark)
351         m_derivedFontData->emphasisMark = createScaledFontData(fontDescription, .5f);
352
353     return m_derivedFontData->emphasisMark.get();
354 }
355
356 bool SimpleFontData::containsCharacters(const UChar* characters, int length) const
357 {
358     NSString *string = [[NSString alloc] initWithCharactersNoCopy:const_cast<unichar*>(characters) length:length freeWhenDone:NO];
359     NSCharacterSet *set = [[m_platformData.font() coveredCharacterSet] invertedSet];
360     bool result = set && [string rangeOfCharacterFromSet:set].location == NSNotFound;
361     [string release];
362     return result;
363 }
364
365 void SimpleFontData::determinePitch()
366 {
367     NSFont* f = m_platformData.font();
368     // Special case Osaka-Mono.
369     // According to <rdar://problem/3999467>, we should treat Osaka-Mono as fixed pitch.
370     // Note that the AppKit does not report Osaka-Mono as fixed pitch.
371
372     // Special case MS-PGothic.
373     // According to <rdar://problem/4032938>, we should not treat MS-PGothic as fixed pitch.
374     // Note that AppKit does report MS-PGothic as fixed pitch.
375
376     // Special case MonotypeCorsiva
377     // According to <rdar://problem/5454704>, we should not treat MonotypeCorsiva as fixed pitch.
378     // Note that AppKit does report MonotypeCorsiva as fixed pitch.
379
380     NSString *name = [f fontName];
381     m_treatAsFixedPitch = ([f isFixedPitch] || [f _isFakeFixedPitch] ||
382            [name caseInsensitiveCompare:@"Osaka-Mono"] == NSOrderedSame) &&
383            [name caseInsensitiveCompare:@"MS-PGothic"] != NSOrderedSame &&
384            [name caseInsensitiveCompare:@"MonotypeCorsiva"] != NSOrderedSame;
385 }
386
387 FloatRect SimpleFontData::platformBoundsForGlyph(Glyph glyph) const
388 {
389     FloatRect boundingBox;
390     boundingBox = CTFontGetBoundingRectsForGlyphs(m_platformData.ctFont(), platformData().orientation() == Vertical ? kCTFontVerticalOrientation : kCTFontHorizontalOrientation, &glyph, 0, 1);
391     boundingBox.setY(-boundingBox.maxY());
392     if (m_syntheticBoldOffset)
393         boundingBox.setWidth(boundingBox.width() + m_syntheticBoldOffset);
394
395     return boundingBox;
396 }
397
398 float SimpleFontData::platformWidthForGlyph(Glyph glyph) const
399 {
400     CGSize advance;
401     if (platformData().orientation() == Horizontal || m_isBrokenIdeographFallback) {
402         NSFont* font = platformData().font();
403         float pointSize = platformData().m_size;
404         CGAffineTransform m = CGAffineTransformMakeScale(pointSize, pointSize);
405         if (!wkGetGlyphTransformedAdvances(platformData().cgFont(), font, &m, &glyph, &advance)) {
406             LOG_ERROR("Unable to cache glyph widths for %@ %f", [font displayName], pointSize);
407             advance.width = 0;
408         }
409     } else
410         CTFontGetAdvancesForGlyphs(m_platformData.ctFont(), kCTFontVerticalOrientation, &glyph, &advance, 1);
411
412     return advance.width + m_syntheticBoldOffset;
413 }
414
415 } // namespace WebCore