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