https://bugs.webkit.org/show_bug.cgi?id=48540, support the text-orientation CSS property.
[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 #ifdef BUILDING_ON_TIGER
67     ATSUStyle fontStyle;
68     if (ATSUCreateStyle(&fontStyle) != noErr)
69         return false;
70
71     ATSUFontID fontId = fontData->platformData().m_atsuFontID;
72     if (!fontId) {
73         ATSUDisposeStyle(fontStyle);
74         return false;
75     }
76
77     ATSUAttributeTag tag = kATSUFontTag;
78     ByteCount size = sizeof(ATSUFontID);
79     ATSUFontID *valueArray[1] = {&fontId};
80     OSStatus status = ATSUSetAttributes(fontStyle, 1, &tag, &size, (void* const*)valueArray);
81     if (status != noErr) {
82         ATSUDisposeStyle(fontStyle);
83         return false;
84     }
85
86     if (wkGetATSStyleGroup(fontStyle, &fontData->m_styleGroup) != noErr) {
87         ATSUDisposeStyle(fontStyle);
88         return false;
89     }
90
91     ATSUDisposeStyle(fontStyle);
92 #endif
93
94     return true;
95 }
96
97 static NSString *webFallbackFontFamily(void)
98 {
99     DEFINE_STATIC_LOCAL(RetainPtr<NSString>, webFallbackFontFamily, ([[NSFont systemFontOfSize:16.0f] familyName]));
100     return webFallbackFontFamily.get();
101 }
102
103 #if !ERROR_DISABLED
104 #if defined(__LP64__) || (!defined(BUILDING_ON_TIGER) && !defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD))
105 static NSString* pathFromFont(NSFont*)
106 {
107     // FMGetATSFontRefFromFont is not available. As pathFromFont is only used for debugging purposes,
108     // returning nil is acceptable.
109     return nil;
110 }
111 #else
112 static NSString* pathFromFont(NSFont *font)
113 {
114 #ifndef BUILDING_ON_TIGER
115     ATSFontRef atsFont = FMGetATSFontRefFromFont(CTFontGetPlatformFont(toCTFontRef(font), 0));
116 #else
117     ATSFontRef atsFont = FMGetATSFontRefFromFont(wkGetNSFontATSUFontId(font));
118 #endif
119     FSRef fileRef;
120
121 #ifndef BUILDING_ON_TIGER
122     OSStatus status = ATSFontGetFileReference(atsFont, &fileRef);
123     if (status != noErr)
124         return nil;
125 #else
126     FSSpec oFile;
127     OSStatus status = ATSFontGetFileSpecification(atsFont, &oFile);
128     if (status != noErr)
129         return nil;
130
131     status = FSpMakeFSRef(&oFile, &fileRef);
132     if (status != noErr)
133         return nil;
134 #endif
135
136     UInt8 filePathBuffer[PATH_MAX];
137     status = FSRefMakePath(&fileRef, filePathBuffer, PATH_MAX);
138     if (status == noErr)
139         return [NSString stringWithUTF8String:(const char*)filePathBuffer];
140
141     return nil;
142 }
143 #endif // __LP64__
144 #endif // !ERROR_DISABLED
145
146 void SimpleFontData::platformInit()
147 {
148 #ifdef BUILDING_ON_TIGER
149     m_styleGroup = 0;
150 #endif
151 #if USE(ATSUI)
152     m_ATSUMirrors = false;
153     m_checkedShapesArabic = false;
154     m_shapesArabic = false;
155 #endif
156
157     m_syntheticBoldOffset = m_platformData.m_syntheticBold ? 1.0f : 0.f;
158
159     bool failedSetup = false;
160     if (!initFontData(this)) {
161         // Ack! Something very bad happened, like a corrupt font.
162         // Try looking for an alternate 'base' font for this renderer.
163
164         // Special case hack to use "Times New Roman" in place of "Times".
165         // "Times RO" is a common font whose family name is "Times".
166         // It overrides the normal "Times" family font.
167         // It also appears to have a corrupt regular variant.
168         NSString *fallbackFontFamily;
169         if ([[m_platformData.font() familyName] isEqual:@"Times"])
170             fallbackFontFamily = @"Times New Roman";
171         else
172             fallbackFontFamily = webFallbackFontFamily();
173         
174         // Try setting up the alternate font.
175         // This is a last ditch effort to use a substitute font when something has gone wrong.
176 #if !ERROR_DISABLED
177         RetainPtr<NSFont> initialFont = m_platformData.font();
178 #endif
179         if (m_platformData.font())
180             m_platformData.setFont([[NSFontManager sharedFontManager] convertFont:m_platformData.font() toFamily:fallbackFontFamily]);
181         else
182             m_platformData.setFont([NSFont fontWithName:fallbackFontFamily size:m_platformData.size()]);
183 #if !ERROR_DISABLED
184         NSString *filePath = pathFromFont(initialFont.get());
185         if (!filePath)
186             filePath = @"not known";
187 #endif
188         if (!initFontData(this)) {
189             if ([fallbackFontFamily isEqual:@"Times New Roman"]) {
190                 // OK, couldn't setup Times New Roman as an alternate to Times, fallback
191                 // on the system font.  If this fails we have no alternative left.
192                 m_platformData.setFont([[NSFontManager sharedFontManager] convertFont:m_platformData.font() toFamily:webFallbackFontFamily()]);
193                 if (!initFontData(this)) {
194                     // We tried, Times, Times New Roman, and the system font. No joy. We have to give up.
195                     LOG_ERROR("unable to initialize with font %@ at %@", initialFont.get(), filePath);
196                     failedSetup = true;
197                 }
198             } else {
199                 // We tried the requested font and the system font. No joy. We have to give up.
200                 LOG_ERROR("unable to initialize with font %@ at %@", initialFont.get(), filePath);
201                 failedSetup = true;
202             }
203         }
204
205         // Report the problem.
206         LOG_ERROR("Corrupt font detected, using %@ in place of %@ located at \"%@\".",
207             [m_platformData.font() familyName], [initialFont.get() familyName], filePath);
208     }
209
210     // If all else fails, try to set up using the system font.
211     // This is probably because Times and Times New Roman are both unavailable.
212     if (failedSetup) {
213         m_platformData.setFont([NSFont systemFontOfSize:[m_platformData.font() pointSize]]);
214         LOG_ERROR("failed to set up font, using system font %s", m_platformData.font());
215         initFontData(this);
216     }
217     
218     int iAscent;
219     int iDescent;
220     int iLineGap;
221     unsigned unitsPerEm;
222 #ifdef BUILDING_ON_TIGER
223     wkGetFontMetrics(m_platformData.cgFont(), &iAscent, &iDescent, &iLineGap, &unitsPerEm);
224 #else
225     iAscent = CGFontGetAscent(m_platformData.cgFont());
226     iDescent = CGFontGetDescent(m_platformData.cgFont());
227     iLineGap = CGFontGetLeading(m_platformData.cgFont());
228     unitsPerEm = CGFontGetUnitsPerEm(m_platformData.cgFont());
229 #endif
230
231     float pointSize = m_platformData.m_size;
232     float ascent = scaleEmToUnits(iAscent, unitsPerEm) * pointSize;
233     float descent = -scaleEmToUnits(iDescent, unitsPerEm) * pointSize;
234     float lineGap = scaleEmToUnits(iLineGap, unitsPerEm) * pointSize;
235
236     // We need to adjust Times, Helvetica, and Courier to closely match the
237     // vertical metrics of their Microsoft counterparts that are the de facto
238     // web standard. The AppKit adjustment of 20% is too big and is
239     // incorrectly added to line spacing, so we use a 15% adjustment instead
240     // and add it to the ascent.
241     NSString *familyName = [m_platformData.font() familyName];
242     if ([familyName isEqualToString:@"Times"] || [familyName isEqualToString:@"Helvetica"] || [familyName isEqualToString:@"Courier"])
243         ascent += floorf(((ascent + descent) * 0.15f) + 0.5f);
244     else if ([familyName isEqualToString:@"Geeza Pro"]) {
245         // Geeza Pro has glyphs that draw slightly above the ascent or far below the descent. Adjust
246         // those vertical metrics to better match reality, so that diacritics at the bottom of one line
247         // do not overlap diacritics at the top of the next line.
248         ascent *= 1.08f;
249         descent *= 2.f;
250     }
251
252     // Compute and store line spacing, before the line metrics hacks are applied.
253     m_fontMetrics.setLineSpacing(lroundf(ascent) + lroundf(descent) + lroundf(lineGap));
254
255     // Hack Hiragino line metrics to allow room for marked text underlines.
256     // <rdar://problem/5386183>
257     if (descent < 3 && lineGap >= 3 && [familyName hasPrefix:@"Hiragino"]) {
258         lineGap -= 3 - descent;
259         descent = 3;
260     }
261     
262     if (platformData().orientation() == Vertical && !isTextOrientationFallback()) {
263         // The check doesn't look neat but this is what AppKit does for vertical writing...
264         RetainPtr<CFArrayRef> tableTags(AdoptCF, CTFontCopyAvailableTables(m_platformData.ctFont(), kCTFontTableOptionExcludeSynthetic));
265         CFIndex numTables = CFArrayGetCount(tableTags.get());
266         for (CFIndex index = 0; index < numTables; ++index) {
267             CTFontTableTag tag = (CTFontTableTag)(uintptr_t)CFArrayGetValueAtIndex(tableTags.get(), index);
268             if (tag == kCTFontTableVhea || tag == kCTFontTableVORG) {
269                 m_hasVerticalGlyphs = true;
270                 break;
271             }
272         }
273     }
274
275     float xHeight;
276
277     // Measure the actual character "x", because AppKit synthesizes X height rather than getting it from the font.
278     // Unfortunately, NSFont will round this for us so we don't quite get the right value.
279     GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
280     NSGlyph xGlyph = glyphPageZero ? glyphPageZero->glyphDataForCharacter('x').glyph : 0;
281     if (xGlyph) {
282         CGRect xBox = platformBoundsForGlyph(xGlyph);
283         // Use the maximum of either width or height because "x" is nearly square
284         // and web pages that foolishly use this metric for width will be laid out
285         // poorly if we return an accurate height. Classic case is Times 13 point,
286         // which has an "x" that is 7x6 pixels.
287         xHeight = static_cast<float>(max(CGRectGetMaxX(xBox), -CGRectGetMinY(xBox)));
288     } else {
289 #ifndef BUILDING_ON_TIGER
290         xHeight = static_cast<float>(CGFontGetXHeight(m_platformData.cgFont())) / unitsPerEm;
291 #else
292         xHeight = m_platformData.font() ? [m_platformData.font() xHeight] : 0;
293 #endif
294         // CGFontGetXHeight() returns a wrong value for "Apple Symbols" font (a float close to 0, but not strictly 0).
295         // The following code makes a guess for xHeight in that case.
296         // The int cast is a workaround for the "almost" zero value returned by CGFontGetXHeight().
297         if (!static_cast<int>(xHeight) && ascent)
298             xHeight = 2 * ascent / 3;
299     }
300
301     m_fontMetrics.setUnitsPerEm(unitsPerEm);
302     m_fontMetrics.setAscent(ascent);
303     m_fontMetrics.setDescent(descent);
304     m_fontMetrics.setLineGap(lineGap);
305     m_fontMetrics.setXHeight(xHeight);
306 }
307
308 static CFDataRef copyFontTableForTag(FontPlatformData& platformData, FourCharCode tableName)
309 {
310 #ifdef BUILDING_ON_TIGER
311     ATSFontRef atsFont = FMGetATSFontRefFromFont(platformData.m_atsuFontID);
312
313     ByteCount tableSize;
314     if (ATSFontGetTable(atsFont, tableName, 0, 0, NULL, &tableSize) != noErr)
315         return 0;
316     
317     CFMutableDataRef data = CFDataCreateMutable(kCFAllocatorDefault, tableSize);
318     if (!data)
319         return 0;
320     
321     CFDataIncreaseLength(data, tableSize);
322     if (ATSFontGetTable(atsFont, tableName, 0, tableSize, CFDataGetMutableBytePtr(data), &tableSize) != noErr) {
323         CFRelease(data);
324         return 0;
325     }
326     
327     return data;
328 #else
329     return CGFontCopyTableForTag(platformData.cgFont(), tableName);
330 #endif
331 }
332
333 void SimpleFontData::platformCharWidthInit()
334 {
335     m_avgCharWidth = 0;
336     m_maxCharWidth = 0;
337     
338     RetainPtr<CFDataRef> os2Table(AdoptCF, copyFontTableForTag(m_platformData, 'OS/2'));
339     if (os2Table && CFDataGetLength(os2Table.get()) >= 4) {
340         const UInt8* os2 = CFDataGetBytePtr(os2Table.get());
341         SInt16 os2AvgCharWidth = os2[2] * 256 + os2[3];
342         m_avgCharWidth = scaleEmToUnits(os2AvgCharWidth, m_fontMetrics.unitsPerEm()) * m_platformData.m_size;
343     }
344
345     RetainPtr<CFDataRef> headTable(AdoptCF, copyFontTableForTag(m_platformData, 'head'));
346     if (headTable && CFDataGetLength(headTable.get()) >= 42) {
347         const UInt8* head = CFDataGetBytePtr(headTable.get());
348         ushort uxMin = head[36] * 256 + head[37];
349         ushort uxMax = head[40] * 256 + head[41];
350         SInt16 xMin = static_cast<SInt16>(uxMin);
351         SInt16 xMax = static_cast<SInt16>(uxMax);
352         float diff = static_cast<float>(xMax - xMin);
353         m_maxCharWidth = scaleEmToUnits(diff, m_fontMetrics.unitsPerEm()) * m_platformData.m_size;
354     }
355
356     // Fallback to a cross-platform estimate, which will populate these values if they are non-positive.
357     initCharWidths();
358 }
359
360 void SimpleFontData::platformDestroy()
361 {
362     if (!isCustomFont() && m_derivedFontData) {
363         // These come from the cache.
364         if (m_derivedFontData->smallCaps)
365             fontCache()->releaseFontData(m_derivedFontData->smallCaps.leakPtr());
366
367         if (m_derivedFontData->emphasisMark)
368             fontCache()->releaseFontData(m_derivedFontData->emphasisMark.leakPtr());
369     }
370
371 #ifdef BUILDING_ON_TIGER
372     if (m_styleGroup)
373         wkReleaseStyleGroup(m_styleGroup);
374 #endif
375 #if USE(ATSUI)
376     HashMap<unsigned, ATSUStyle>::iterator end = m_ATSUStyleMap.end();
377     for (HashMap<unsigned, ATSUStyle>::iterator it = m_ATSUStyleMap.begin(); it != end; ++it)
378         ATSUDisposeStyle(it->second);
379 #endif
380 }
381
382 SimpleFontData* SimpleFontData::scaledFontData(const FontDescription& fontDescription, float scaleFactor) const
383 {
384     if (isCustomFont()) {
385         FontPlatformData scaledFontData(m_platformData);
386         scaledFontData.m_size = scaledFontData.m_size * scaleFactor;
387         return new SimpleFontData(scaledFontData, true, false);
388     }
389
390     BEGIN_BLOCK_OBJC_EXCEPTIONS;
391     float size = m_platformData.size() * scaleFactor;
392     FontPlatformData scaledFontData([[NSFontManager sharedFontManager] convertFont:m_platformData.font() toSize:size], size, false, false, m_platformData.orientation());
393
394     // AppKit resets the type information (screen/printer) when you convert a font to a different size.
395     // We have to fix up the font that we're handed back.
396     scaledFontData.setFont(fontDescription.usePrinterFont() ? [scaledFontData.font() printerFont] : [scaledFontData.font() screenFont]);
397
398     if (scaledFontData.font()) {
399         NSFontManager *fontManager = [NSFontManager sharedFontManager];
400         NSFontTraitMask fontTraits = [fontManager traitsOfFont:m_platformData.font()];
401
402         if (m_platformData.m_syntheticBold)
403             fontTraits |= NSBoldFontMask;
404         if (m_platformData.m_syntheticOblique)
405             fontTraits |= NSItalicFontMask;
406
407         NSFontTraitMask scaledFontTraits = [fontManager traitsOfFont:scaledFontData.font()];
408         scaledFontData.m_syntheticBold = (fontTraits & NSBoldFontMask) && !(scaledFontTraits & NSBoldFontMask);
409         scaledFontData.m_syntheticOblique = (fontTraits & NSItalicFontMask) && !(scaledFontTraits & NSItalicFontMask);
410
411         return fontCache()->getCachedFontData(&scaledFontData);
412     }
413     END_BLOCK_OBJC_EXCEPTIONS;
414
415     return 0;
416 }
417
418 SimpleFontData* SimpleFontData::smallCapsFontData(const FontDescription& fontDescription) const
419 {
420     if (!m_derivedFontData)
421         m_derivedFontData = DerivedFontData::create(isCustomFont());
422     if (!m_derivedFontData->smallCaps)
423         m_derivedFontData->smallCaps = scaledFontData(fontDescription, smallCapsFontSizeMultiplier);
424
425     return m_derivedFontData->smallCaps.get();
426 }
427
428 SimpleFontData* SimpleFontData::emphasisMarkFontData(const FontDescription& fontDescription) const
429 {
430     if (!m_derivedFontData)
431         m_derivedFontData = DerivedFontData::create(isCustomFont());
432     if (!m_derivedFontData->emphasisMark)
433         m_derivedFontData->emphasisMark = scaledFontData(fontDescription, .5f);
434
435     return m_derivedFontData->emphasisMark.get();
436 }
437
438 bool SimpleFontData::containsCharacters(const UChar* characters, int length) const
439 {
440     NSString *string = [[NSString alloc] initWithCharactersNoCopy:const_cast<unichar*>(characters) length:length freeWhenDone:NO];
441     NSCharacterSet *set = [[m_platformData.font() coveredCharacterSet] invertedSet];
442     bool result = set && [string rangeOfCharacterFromSet:set].location == NSNotFound;
443     [string release];
444     return result;
445 }
446
447 void SimpleFontData::determinePitch()
448 {
449     NSFont* f = m_platformData.font();
450     // Special case Osaka-Mono.
451     // According to <rdar://problem/3999467>, we should treat Osaka-Mono as fixed pitch.
452     // Note that the AppKit does not report Osaka-Mono as fixed pitch.
453
454     // Special case MS-PGothic.
455     // According to <rdar://problem/4032938>, we should not treat MS-PGothic as fixed pitch.
456     // Note that AppKit does report MS-PGothic as fixed pitch.
457
458     // Special case MonotypeCorsiva
459     // According to <rdar://problem/5454704>, we should not treat MonotypeCorsiva as fixed pitch.
460     // Note that AppKit does report MonotypeCorsiva as fixed pitch.
461
462     NSString *name = [f fontName];
463     m_treatAsFixedPitch = ([f isFixedPitch] || [f _isFakeFixedPitch] ||
464            [name caseInsensitiveCompare:@"Osaka-Mono"] == NSOrderedSame) &&
465            [name caseInsensitiveCompare:@"MS-PGothic"] != NSOrderedSame &&
466            [name caseInsensitiveCompare:@"MonotypeCorsiva"] != NSOrderedSame;
467 }
468
469 FloatRect SimpleFontData::platformBoundsForGlyph(Glyph glyph) const
470 {
471     FloatRect boundingBox;
472 #ifndef BUILDING_ON_TIGER
473     boundingBox = CTFontGetBoundingRectsForGlyphs(m_platformData.ctFont(), platformData().orientation() == Vertical ? kCTFontVerticalOrientation : kCTFontHorizontalOrientation, &glyph, 0, 1);
474     boundingBox.setY(-boundingBox.maxY());
475 #else
476     // FIXME: Custom fonts don't have NSFonts, so this function doesn't compute correct bounds for these on Tiger.
477     if (!m_platformData.font())
478         return boundingBox;
479     boundingBox = [m_platformData.font() boundingRectForGlyph:glyph];
480     boundingBox.setY(-boundingBox.maxY());
481 #endif
482     if (m_syntheticBoldOffset)
483         boundingBox.setWidth(boundingBox.width() + m_syntheticBoldOffset);
484
485     return boundingBox;
486 }
487
488 float SimpleFontData::platformWidthForGlyph(Glyph glyph) const
489 {
490     CGSize advance;
491     if (platformData().orientation() == Horizontal || m_isBrokenIdeographFallback) {
492         NSFont* font = platformData().font();
493         float pointSize = platformData().m_size;
494         CGAffineTransform m = CGAffineTransformMakeScale(pointSize, pointSize);
495         if (!wkGetGlyphTransformedAdvances(platformData().cgFont(), font, &m, &glyph, &advance)) {
496             LOG_ERROR("Unable to cache glyph widths for %@ %f", [font displayName], pointSize);
497             advance.width = 0;
498         }
499     } else
500         CTFontGetAdvancesForGlyphs(m_platformData.ctFont(), kCTFontVerticalOrientation, &glyph, &advance, 1);
501
502     return advance.width + m_syntheticBoldOffset;
503 }
504
505 } // namespace WebCore