2008-03-26 Mark Rowe <mrowe@apple.com>
[WebKit-https.git] / 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 <ApplicationServices/ApplicationServices.h>
42 #import <float.h>
43 #import <unicode/uchar.h>
44 #import <wtf/Assertions.h>
45 #import <wtf/RetainPtr.h>
46
47 @interface NSFont (WebAppKitSecretAPI)
48 - (BOOL)_isFakeFixedPitch;
49 @end
50
51 namespace WebCore {
52   
53 const float smallCapsFontSizeMultiplier = 0.7f;
54 const float contextDPI = 72.0f;
55 static inline float scaleEmToUnits(float x, unsigned unitsPerEm) { return x * (contextDPI / (contextDPI * unitsPerEm)); }
56
57 bool initFontData(SimpleFontData* fontData)
58 {
59     if (!fontData->m_font.cgFont())
60         return false;
61
62     ATSUStyle fontStyle;
63     if (ATSUCreateStyle(&fontStyle) != noErr)
64         return false;
65
66     ATSUFontID fontId = fontData->m_font.m_atsuFontID;
67     if (!fontId) {
68         ATSUDisposeStyle(fontStyle);
69         return false;
70     }
71
72     ATSUAttributeTag tag = kATSUFontTag;
73     ByteCount size = sizeof(ATSUFontID);
74     ATSUFontID *valueArray[1] = {&fontId};
75     OSStatus status = ATSUSetAttributes(fontStyle, 1, &tag, &size, (void* const*)valueArray);
76     if (status != noErr) {
77         ATSUDisposeStyle(fontStyle);
78         return false;
79     }
80
81     if (wkGetATSStyleGroup(fontStyle, &fontData->m_styleGroup) != noErr) {
82         ATSUDisposeStyle(fontStyle);
83         return false;
84     }
85
86     ATSUDisposeStyle(fontStyle);
87
88     return true;
89 }
90
91 static NSString *webFallbackFontFamily(void)
92 {
93     static RetainPtr<NSString> webFallbackFontFamily = nil;
94     if (!webFallbackFontFamily)
95         webFallbackFontFamily = [[NSFont systemFontOfSize:16.0f] familyName];
96     return webFallbackFontFamily.get();
97 }
98
99 #if !ERROR_DISABLED
100 #ifdef __LP64__
101 static NSString* pathFromFont(NSFont*)
102 {
103     // FMGetATSFontRefFromFont is not available in 64-bit. As pathFromFont is only used for debugging
104     // purposes, returning nil is acceptable.
105     return nil;
106 }
107 #else
108 static NSString* pathFromFont(NSFont *font)
109 {
110 #ifndef BUILDING_ON_TIGER
111     ATSFontRef atsFont = FMGetATSFontRefFromFont(CTFontGetPlatformFont(toCTFontRef(font), 0));
112 #else
113     ATSFontRef atsFont = FMGetATSFontRefFromFont(wkGetNSFontATSUFontId(font));
114 #endif
115     FSRef fileRef;
116
117 #ifndef BUILDING_ON_TIGER
118     OSStatus status = ATSFontGetFileReference(atsFont, &fileRef);
119     if (status != noErr)
120         return nil;
121 #else
122     FSSpec oFile;
123     OSStatus status = ATSFontGetFileSpecification(atsFont, &oFile);
124     if (status != noErr)
125         return nil;
126
127     status = FSpMakeFSRef(&oFile, &fileRef);
128     if (status != noErr)
129         return nil;
130 #endif
131
132     UInt8 filePathBuffer[PATH_MAX];
133     status = FSRefMakePath(&fileRef, filePathBuffer, PATH_MAX);
134     if (status == noErr)
135         return [NSString stringWithUTF8String:(const char*)filePathBuffer];
136
137     return nil;
138 }
139 #endif // __LP64__
140 #endif // !ERROR_DISABLED
141
142 void SimpleFontData::platformInit()
143 {
144     m_styleGroup = 0;
145     m_ATSUStyleInitialized = false;
146     m_ATSUMirrors = false;
147     m_checkedShapesArabic = false;
148     m_shapesArabic = false;
149
150     m_syntheticBoldOffset = m_font.m_syntheticBold ? 1.0f : 0.f;
151     m_allowFontSmoothing = true;
152
153     bool failedSetup = false;
154     if (!initFontData(this)) {
155         // Ack! Something very bad happened, like a corrupt font.
156         // Try looking for an alternate 'base' font for this renderer.
157
158         // Special case hack to use "Times New Roman" in place of "Times".
159         // "Times RO" is a common font whose family name is "Times".
160         // It overrides the normal "Times" family font.
161         // It also appears to have a corrupt regular variant.
162         NSString *fallbackFontFamily;
163         if ([[m_font.font() familyName] isEqual:@"Times"])
164             fallbackFontFamily = @"Times New Roman";
165         else
166             fallbackFontFamily = webFallbackFontFamily();
167         
168         // Try setting up the alternate font.
169         // This is a last ditch effort to use a substitute font when something has gone wrong.
170 #if !ERROR_DISABLED
171         RetainPtr<NSFont> initialFont = m_font.font();
172 #endif
173         m_font.setFont([[NSFontManager sharedFontManager] convertFont:m_font.font() toFamily:fallbackFontFamily]);
174 #if !ERROR_DISABLED
175         NSString *filePath = pathFromFont(initialFont.get());
176         if (!filePath)
177             filePath = @"not known";
178 #endif
179         if (!initFontData(this)) {
180             if ([fallbackFontFamily isEqual:@"Times New Roman"]) {
181                 // OK, couldn't setup Times New Roman as an alternate to Times, fallback
182                 // on the system font.  If this fails we have no alternative left.
183                 m_font.setFont([[NSFontManager sharedFontManager] convertFont:m_font.font() toFamily:webFallbackFontFamily()]);
184                 if (!initFontData(this)) {
185                     // We tried, Times, Times New Roman, and the system font. No joy. We have to give up.
186                     LOG_ERROR("unable to initialize with font %@ at %@", initialFont.get(), filePath);
187                     failedSetup = true;
188                 }
189             } else {
190                 // We tried the requested font and the system font. No joy. We have to give up.
191                 LOG_ERROR("unable to initialize with font %@ at %@", initialFont.get(), filePath);
192                 failedSetup = true;
193             }
194         }
195
196         // Report the problem.
197         LOG_ERROR("Corrupt font detected, using %@ in place of %@ located at \"%@\".",
198             [m_font.font() familyName], [initialFont.get() familyName], filePath);
199     }
200
201     // If all else fails, try to set up using the system font.
202     // This is probably because Times and Times New Roman are both unavailable.
203     if (failedSetup) {
204         m_font.setFont([NSFont systemFontOfSize:[m_font.font() pointSize]]);
205         LOG_ERROR("failed to set up font, using system font %s", m_font.font());
206         initFontData(this);
207     }
208     
209     int iAscent;
210     int iDescent;
211     int iLineGap;
212 #ifdef BUILDING_ON_TIGER
213     wkGetFontMetrics(m_font.cgFont(), &iAscent, &iDescent, &iLineGap, &m_unitsPerEm);
214 #else
215     iAscent = CGFontGetAscent(m_font.cgFont());
216     iDescent = CGFontGetDescent(m_font.cgFont());
217     iLineGap = CGFontGetLeading(m_font.cgFont());
218     m_unitsPerEm = CGFontGetUnitsPerEm(m_font.cgFont());
219 #endif
220
221     float pointSize = m_font.m_size;
222     float fAscent = scaleEmToUnits(iAscent, m_unitsPerEm) * pointSize;
223     float fDescent = -scaleEmToUnits(iDescent, m_unitsPerEm) * pointSize;
224     float fLineGap = scaleEmToUnits(iLineGap, m_unitsPerEm) * pointSize;
225
226     // We need to adjust Times, Helvetica, and Courier to closely match the
227     // vertical metrics of their Microsoft counterparts that are the de facto
228     // web standard. The AppKit adjustment of 20% is too big and is
229     // incorrectly added to line spacing, so we use a 15% adjustment instead
230     // and add it to the ascent.
231     NSString *familyName = [m_font.font() familyName];
232     if ([familyName isEqualToString:@"Times"] || [familyName isEqualToString:@"Helvetica"] || [familyName isEqualToString:@"Courier"])
233         fAscent += floorf(((fAscent + fDescent) * 0.15f) + 0.5f);
234
235     m_ascent = lroundf(fAscent);
236     m_descent = lroundf(fDescent);
237     m_lineGap = lroundf(fLineGap);
238     m_lineSpacing = m_ascent + m_descent + m_lineGap;
239     
240     // Hack Hiragino line metrics to allow room for marked text underlines.
241     // <rdar://problem/5386183>
242     if (m_descent < 3 && m_lineGap >= 3 && [familyName hasPrefix:@"Hiragino"]) {
243         m_lineGap -= 3 - m_descent;
244         m_descent = 3;
245     }
246     
247     // Measure the actual character "x", because AppKit synthesizes X height rather than getting it from the font.
248     // Unfortunately, NSFont will round this for us so we don't quite get the right value.
249     GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
250     NSGlyph xGlyph = glyphPageZero ? glyphPageZero->glyphDataForCharacter('x').glyph : 0;
251     if (xGlyph) {
252         NSRect xBox = [m_font.font() boundingRectForGlyph:xGlyph];
253         // Use the maximum of either width or height because "x" is nearly square
254         // and web pages that foolishly use this metric for width will be laid out
255         // poorly if we return an accurate height. Classic case is Times 13 point,
256         // which has an "x" that is 7x6 pixels.
257         m_xHeight = MAX(NSMaxX(xBox), NSMaxY(xBox));
258     } else
259         m_xHeight = [m_font.font() xHeight];
260
261     // Workaround for strange CG antialiasing of the Ahem font. Limit to the Web font version.
262     if (isCustomFont()) {
263 #ifdef BUILDING_ON_TIGER
264         RetainPtr<CFStringRef> fullName(AdoptCF, wkCopyFullFontName(m_font.cgFont()));
265 #else
266         RetainPtr<CFStringRef> fullName(AdoptCF, CGFontCopyFullName(m_font.cgFont()));
267 #endif
268         String nameStr(fullName.get());
269         m_allowFontSmoothing = (nameStr != "Ahem");
270     }
271 }
272
273 void SimpleFontData::platformDestroy()
274 {
275     if (m_styleGroup)
276         wkReleaseStyleGroup(m_styleGroup);
277
278     if (m_ATSUStyleInitialized)
279         ATSUDisposeStyle(m_ATSUStyle);
280 }
281
282 SimpleFontData* SimpleFontData::smallCapsFontData(const FontDescription& fontDescription) const
283 {
284     if (!m_smallCapsFontData) {
285         if (isCustomFont()) {
286             FontPlatformData smallCapsFontData(m_font);
287             smallCapsFontData.m_size = smallCapsFontData.m_size * smallCapsFontSizeMultiplier;
288             m_smallCapsFontData = new SimpleFontData(smallCapsFontData, true, false);
289         } else {
290             BEGIN_BLOCK_OBJC_EXCEPTIONS;
291             float size = [m_font.font() pointSize] * smallCapsFontSizeMultiplier;
292             FontPlatformData smallCapsFont([[NSFontManager sharedFontManager] convertFont:m_font.font() toSize:size]);
293             
294             // AppKit resets the type information (screen/printer) when you convert a font to a different size.
295             // We have to fix up the font that we're handed back.
296             smallCapsFont.setFont(fontDescription.usePrinterFont() ? [smallCapsFont.font() printerFont] : [smallCapsFont.font() screenFont]);
297
298             if (smallCapsFont.font()) {
299                 NSFontManager *fontManager = [NSFontManager sharedFontManager];
300                 NSFontTraitMask fontTraits = [fontManager traitsOfFont:m_font.font()];
301
302                 if (m_font.m_syntheticBold)
303                     fontTraits |= NSBoldFontMask;
304                 if (m_font.m_syntheticOblique)
305                     fontTraits |= NSItalicFontMask;
306
307                 NSFontTraitMask smallCapsFontTraits = [fontManager traitsOfFont:smallCapsFont.font()];
308                 smallCapsFont.m_syntheticBold = (fontTraits & NSBoldFontMask) && !(smallCapsFontTraits & NSBoldFontMask);
309                 smallCapsFont.m_syntheticOblique = (fontTraits & NSItalicFontMask) && !(smallCapsFontTraits & NSItalicFontMask);
310
311                 m_smallCapsFontData = FontCache::getCachedFontData(&smallCapsFont);
312             }
313             END_BLOCK_OBJC_EXCEPTIONS;
314         }
315     }
316     return m_smallCapsFontData;
317 }
318
319 bool SimpleFontData::containsCharacters(const UChar* characters, int length) const
320 {
321     NSString *string = [[NSString alloc] initWithCharactersNoCopy:(UniChar*)characters length:length freeWhenDone:NO];
322     NSCharacterSet *set = [[m_font.font() coveredCharacterSet] invertedSet];
323     bool result = set && [string rangeOfCharacterFromSet:set].location == NSNotFound;
324     [string release];
325     return result;
326 }
327
328 void SimpleFontData::determinePitch()
329 {
330     NSFont* f = m_font.font();
331     // Special case Osaka-Mono.
332     // According to <rdar://problem/3999467>, we should treat Osaka-Mono as fixed pitch.
333     // Note that the AppKit does not report Osaka-Mono as fixed pitch.
334
335     // Special case MS-PGothic.
336     // According to <rdar://problem/4032938>, we should not treat MS-PGothic as fixed pitch.
337     // Note that AppKit does report MS-PGothic as fixed pitch.
338
339     // Special case MonotypeCorsiva
340     // According to <rdar://problem/5454704>, we should not treat MonotypeCorsiva as fixed pitch.
341     // Note that AppKit does report MonotypeCorsiva as fixed pitch.
342
343     NSString *name = [f fontName];
344     m_treatAsFixedPitch = ([f isFixedPitch] || [f _isFakeFixedPitch] ||
345            [name caseInsensitiveCompare:@"Osaka-Mono"] == NSOrderedSame) &&
346            [name caseInsensitiveCompare:@"MS-PGothic"] != NSOrderedSame &&
347            [name caseInsensitiveCompare:@"MonotypeCorsiva"] != NSOrderedSame;
348 }
349
350 float SimpleFontData::platformWidthForGlyph(Glyph glyph) const
351 {
352     NSFont* font = m_font.font();
353     float pointSize = m_font.m_size;
354     CGAffineTransform m = CGAffineTransformMakeScale(pointSize, pointSize);
355     CGSize advance;
356     if (!wkGetGlyphTransformedAdvances(m_font.cgFont(), font, &m, &glyph, &advance)) {
357         LOG_ERROR("Unable to cache glyph widths for %@ %f", [font displayName], pointSize);
358         advance.width = 0;
359     }
360     return advance.width + m_syntheticBoldOffset;
361 }
362
363 void SimpleFontData::checkShapesArabic() const
364 {
365     ASSERT(!m_checkedShapesArabic);
366
367     m_checkedShapesArabic = true;
368     
369     ATSUFontID fontID = m_font.m_atsuFontID;
370     if (!fontID) {
371         LOG_ERROR("unable to get ATSUFontID for %@", m_font.font());
372         return;
373     }
374
375     // This function is called only on fonts that contain Arabic glyphs. Our
376     // heuristic is that if such a font has a glyph metamorphosis table, then
377     // it includes shaping information for Arabic.
378     FourCharCode tables[] = { 'morx', 'mort' };
379     for (unsigned i = 0; i < sizeof(tables) / sizeof(tables[0]); ++i) {
380         ByteCount tableSize;
381         OSStatus status = ATSFontGetTable(fontID, tables[i], 0, 0, 0, &tableSize);
382         if (status == noErr) {
383             m_shapesArabic = true;
384             return;
385         }
386
387         if (status != kATSInvalidFontTableAccess)
388             LOG_ERROR("ATSFontGetTable failed (%d)", status);
389     }
390 }
391
392 }