a29323a29e462c69bf99afcbbf0597405595f2e2
[WebKit-https.git] / Source / WebCore / platform / graphics / mac / ComplexTextControllerCoreText.mm
1 /*
2  * Copyright (C) 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23  */
24
25 #include "config.h"
26
27 #include "ComplexTextController.h"
28
29 #include "CoreTextSPI.h"
30 #include "Font.h"
31 #include "FontCache.h"
32 #include "TextRun.h"
33 #include "WebCoreSystemInterface.h"
34
35 #if PLATFORM(IOS)
36 #include <CoreText/CoreText.h>
37 #else
38 #include <ApplicationServices/ApplicationServices.h>
39 #endif
40
41 @interface WebCascadeList : NSArray {
42     @private
43     const WebCore::Font* _font;
44     UChar32 _character;
45     NSUInteger _count;
46     Vector<RetainPtr<CTFontDescriptorRef>, 16> _fontDescriptors;
47 }
48
49 - (id)initWithFont:(const WebCore::Font*)font character:(UChar32)character;
50
51 @end
52
53 @implementation WebCascadeList
54
55 - (id)initWithFont:(const WebCore::Font*)font character:(UChar32)character
56 {
57     if (!(self = [super init]))
58         return nil;
59
60     _font = font;
61     _character = character;
62
63     // By the time a WebCascadeList is used, the Font has already been asked to realize all of its
64     // FontData, so this loop does not hit the FontCache.
65     while (_font->fontDataAt(_count))
66         _count++;
67
68     return self;
69 }
70
71 - (NSUInteger)count
72 {
73     return _count;
74 }
75
76 - (id)objectAtIndex:(NSUInteger)index
77 {
78     CTFontDescriptorRef fontDescriptor;
79     if (index < _fontDescriptors.size()) {
80         if ((fontDescriptor = _fontDescriptors[index].get()))
81             return (id)fontDescriptor;
82     } else
83         _fontDescriptors.grow(index + 1);
84
85     const WebCore::SimpleFontData* simpleFontData = _font->fontDataAt(index)->simpleFontDataForCharacter(_character);
86     if (!simpleFontData)
87         simpleFontData = &_font->fontDataAt(index)->simpleFontDataForFirstRange();
88     fontDescriptor = CTFontCopyFontDescriptor(simpleFontData->platformData().ctFont());
89     _fontDescriptors[index] = adoptCF(fontDescriptor);
90     return (id)fontDescriptor;
91 }
92
93 @end
94
95 namespace WebCore {
96
97 ComplexTextController::ComplexTextRun::ComplexTextRun(CTRunRef ctRun, const SimpleFontData* fontData, const UChar* characters, unsigned stringLocation, size_t stringLength, CFRange runRange)
98     : m_fontData(fontData)
99     , m_characters(characters)
100     , m_stringLocation(stringLocation)
101     , m_stringLength(stringLength)
102     , m_indexBegin(runRange.location)
103     , m_indexEnd(runRange.location + runRange.length)
104     , m_initialAdvance(CTRunGetInitialAdvance(ctRun))
105     , m_isLTR(!(CTRunGetStatus(ctRun) & kCTRunStatusRightToLeft))
106     , m_isMonotonic(true)
107 {
108     m_glyphCount = CTRunGetGlyphCount(ctRun);
109     m_coreTextIndices = CTRunGetStringIndicesPtr(ctRun);
110     if (!m_coreTextIndices) {
111         m_coreTextIndicesVector.grow(m_glyphCount);
112         CTRunGetStringIndices(ctRun, CFRangeMake(0, 0), m_coreTextIndicesVector.data());
113         m_coreTextIndices = m_coreTextIndicesVector.data();
114     }
115
116     m_glyphs = CTRunGetGlyphsPtr(ctRun);
117     if (!m_glyphs) {
118         m_glyphsVector.grow(m_glyphCount);
119         CTRunGetGlyphs(ctRun, CFRangeMake(0, 0), m_glyphsVector.data());
120         m_glyphs = m_glyphsVector.data();
121     }
122
123     m_advances = CTRunGetAdvancesPtr(ctRun);
124     if (!m_advances) {
125         m_advancesVector.grow(m_glyphCount);
126         CTRunGetAdvances(ctRun, CFRangeMake(0, 0), m_advancesVector.data());
127         m_advances = m_advancesVector.data();
128     }
129 }
130
131 // Missing glyphs run constructor. Core Text will not generate a run of missing glyphs, instead falling back on
132 // glyphs from LastResort. We want to use the primary font's missing glyph in order to match the fast text code path.
133 ComplexTextController::ComplexTextRun::ComplexTextRun(const SimpleFontData* fontData, const UChar* characters, unsigned stringLocation, size_t stringLength, bool ltr)
134     : m_fontData(fontData)
135     , m_characters(characters)
136     , m_stringLocation(stringLocation)
137     , m_stringLength(stringLength)
138     , m_indexBegin(0)
139     , m_indexEnd(stringLength)
140     , m_initialAdvance(CGSizeZero)
141     , m_isLTR(ltr)
142     , m_isMonotonic(true)
143 {
144     m_coreTextIndicesVector.reserveInitialCapacity(m_stringLength);
145     unsigned r = 0;
146     while (r < m_stringLength) {
147         m_coreTextIndicesVector.uncheckedAppend(r);
148         if (U_IS_SURROGATE(m_characters[r])) {
149             ASSERT(r + 1 < m_stringLength);
150             ASSERT(U_IS_SURROGATE_LEAD(m_characters[r]));
151             ASSERT(U_IS_TRAIL(m_characters[r + 1]));
152             r += 2;
153         } else
154             r++;
155     }
156     m_glyphCount = m_coreTextIndicesVector.size();
157     if (!ltr) {
158         for (unsigned r = 0, end = m_glyphCount - 1; r < m_glyphCount / 2; ++r, --end)
159             std::swap(m_coreTextIndicesVector[r], m_coreTextIndicesVector[end]);
160     }
161     m_coreTextIndices = m_coreTextIndicesVector.data();
162
163     // Synthesize a run of missing glyphs.
164     m_glyphsVector.fill(0, m_glyphCount);
165     m_glyphs = m_glyphsVector.data();
166     m_advancesVector.fill(CGSizeMake(m_fontData->widthForGlyph(0), 0), m_glyphCount);
167     m_advances = m_advancesVector.data();
168 }
169
170 struct ProviderInfo {
171     const UChar* cp;
172     unsigned length;
173     CFDictionaryRef attributes;
174 };
175
176 static const UniChar* provideStringAndAttributes(CFIndex stringIndex, CFIndex* charCount, CFDictionaryRef* attributes, void* refCon)
177 {
178     ProviderInfo* info = static_cast<struct ProviderInfo*>(refCon);
179     if (stringIndex < 0 || static_cast<unsigned>(stringIndex) >= info->length)
180         return 0;
181
182     *charCount = info->length - stringIndex;
183     *attributes = info->attributes;
184     return info->cp + stringIndex;
185 }
186
187 void ComplexTextController::collectComplexTextRunsForCharacters(const UChar* cp, unsigned length, unsigned stringLocation, const SimpleFontData* fontData)
188 {
189     if (!fontData) {
190         // Create a run of missing glyphs from the primary font.
191         m_complexTextRuns.append(ComplexTextRun::create(m_font.primaryFont(), cp, stringLocation, length, m_run.ltr()));
192         return;
193     }
194
195     bool isSystemFallback = false;
196
197     UChar32 baseCharacter = 0;
198     RetainPtr<CFDictionaryRef> stringAttributes;
199     if (fontData == SimpleFontData::systemFallback()) {
200         // FIXME: This code path does not support small caps.
201         isSystemFallback = true;
202
203         U16_GET(cp, 0, 0, length, baseCharacter);
204         fontData = m_font.fontDataAt(0)->simpleFontDataForCharacter(baseCharacter);
205         if (!fontData)
206             fontData = &m_font.fontDataAt(0)->simpleFontDataForFirstRange();
207
208         RetainPtr<WebCascadeList> cascadeList = adoptNS([[WebCascadeList alloc] initWithFont:&m_font character:baseCharacter]);
209
210         stringAttributes = adoptCF(CFDictionaryCreateMutableCopy(kCFAllocatorDefault, 0, fontData->getCFStringAttributes(m_font.typesettingFeatures(), fontData->platformData().orientation())));
211         static const void* attributeKeys[] = { kCTFontCascadeListAttribute };
212         const void* values[] = { cascadeList.get() };
213         RetainPtr<CFDictionaryRef> attributes = adoptCF(CFDictionaryCreate(kCFAllocatorDefault, attributeKeys, values, sizeof(attributeKeys) / sizeof(*attributeKeys), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
214         RetainPtr<CTFontDescriptorRef> fontDescriptor = adoptCF(CTFontDescriptorCreateWithAttributes(attributes.get()));
215         RetainPtr<CTFontRef> fontWithCascadeList = adoptCF(CTFontCreateCopyWithAttributes(fontData->platformData().ctFont(), m_font.pixelSize(), 0, fontDescriptor.get()));
216         CFDictionarySetValue(const_cast<CFMutableDictionaryRef>(stringAttributes.get()), kCTFontAttributeName, fontWithCascadeList.get());
217     } else
218         stringAttributes = fontData->getCFStringAttributes(m_font.typesettingFeatures(), fontData->platformData().orientation());
219
220     RetainPtr<CTLineRef> line;
221
222     if (!m_mayUseNaturalWritingDirection || m_run.directionalOverride()) {
223         static const void* optionKeys[] = { kCTTypesetterOptionForcedEmbeddingLevel };
224         const short ltrForcedEmbeddingLevelValue = 0;
225         const short rtlForcedEmbeddingLevelValue = 1;
226         static const void* ltrOptionValues[] = { CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &ltrForcedEmbeddingLevelValue) };
227         static const void* rtlOptionValues[] = { CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &rtlForcedEmbeddingLevelValue) };
228         static CFDictionaryRef ltrTypesetterOptions = CFDictionaryCreate(kCFAllocatorDefault, optionKeys, ltrOptionValues, WTF_ARRAY_LENGTH(optionKeys), &kCFCopyStringDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
229         static CFDictionaryRef rtlTypesetterOptions = CFDictionaryCreate(kCFAllocatorDefault, optionKeys, rtlOptionValues, WTF_ARRAY_LENGTH(optionKeys), &kCFCopyStringDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
230
231         ProviderInfo info = { cp, length, stringAttributes.get() };
232         RetainPtr<CTTypesetterRef> typesetter = adoptCF(CTTypesetterCreateWithUniCharProviderAndOptions(&provideStringAndAttributes, 0, &info, m_run.ltr() ? ltrTypesetterOptions : rtlTypesetterOptions));
233
234         line = adoptCF(CTTypesetterCreateLine(typesetter.get(), CFRangeMake(0, 0)));
235     } else {
236         ProviderInfo info = { cp, length, stringAttributes.get() };
237
238         line = adoptCF(CTLineCreateWithUniCharProvider(&provideStringAndAttributes, nullptr, &info));
239     }
240
241     m_coreTextLines.append(line.get());
242
243     CFArrayRef runArray = CTLineGetGlyphRuns(line.get());
244
245     CFIndex runCount = CFArrayGetCount(runArray);
246
247     for (CFIndex r = 0; r < runCount; r++) {
248         CTRunRef ctRun = static_cast<CTRunRef>(CFArrayGetValueAtIndex(runArray, m_run.ltr() ? r : runCount - 1 - r));
249         ASSERT(CFGetTypeID(ctRun) == CTRunGetTypeID());
250         CFRange runRange = CTRunGetStringRange(ctRun);
251         const SimpleFontData* runFontData = fontData;
252         if (isSystemFallback) {
253             CFDictionaryRef runAttributes = CTRunGetAttributes(ctRun);
254             CTFontRef runFont = static_cast<CTFontRef>(CFDictionaryGetValue(runAttributes, kCTFontAttributeName));
255             ASSERT(CFGetTypeID(runFont) == CTFontGetTypeID());
256             RetainPtr<CFTypeRef> runFontEqualityObject = FontPlatformData::objectForEqualityCheck(runFont);
257             if (!CFEqual(runFontEqualityObject.get(), fontData->platformData().objectForEqualityCheck().get())) {
258                 // Begin trying to see if runFont matches any of the fonts in the fallback list.
259                 unsigned i = 0;
260                 for (const FontData* candidateFontData = m_font.fontDataAt(i); candidateFontData; candidateFontData = m_font.fontDataAt(++i)) {
261                     runFontData = candidateFontData->simpleFontDataForCharacter(baseCharacter);
262                     if (!runFontData)
263                         continue;
264                     RetainPtr<CFTypeRef> runFontEqualityObject = runFontData->platformData().objectForEqualityCheck();
265                     if (CFEqual(runFontEqualityObject.get(), runFontEqualityObject.get()))
266                         break;
267                     runFontData = 0;
268                 }
269                 // If there is no matching font, look up by name in the font cache.
270                 if (!runFontData) {
271                     // Rather than using runFont as an NSFont and wrapping it in a FontPlatformData, go through
272                     // the font cache and ultimately through NSFontManager in order to get an NSFont with the right
273                     // NSFontRenderingMode.
274                     RetainPtr<CFStringRef> fontName = adoptCF(CTFontCopyPostScriptName(runFont));
275                     if (CFEqual(fontName.get(), CFSTR("LastResort"))) {
276                         m_complexTextRuns.append(ComplexTextRun::create(m_font.primaryFont(), cp, stringLocation + runRange.location, runRange.length, m_run.ltr()));
277                         continue;
278                     }
279                     runFontData = fontCache().getCachedFontData(m_font.fontDescription(), fontName.get(), false, FontCache::DoNotRetain).get();
280 #if !PLATFORM(IOS)
281                     // Core Text may have used a font that is not known to NSFontManager. In that case, fall back on
282                     // using the font as returned, even though it may not have the best NSFontRenderingMode.
283                     if (!runFontData) {
284                         FontPlatformData runFontPlatformData((NSFont *)runFont, CTFontGetSize(runFont), m_font.fontDescription().usePrinterFont());
285                         runFontData = fontCache().getCachedFontData(&runFontPlatformData, FontCache::DoNotRetain).get();
286                     }
287 #else
288                     // FIXME: Just assert for now, until we can devise a better fix that works with iOS.
289                     ASSERT(runFontData);
290 #endif
291                 }
292                 if (m_fallbackFonts && runFontData != m_font.primaryFont())
293                     m_fallbackFonts->add(runFontData);
294             }
295         }
296         if (m_fallbackFonts && runFontData != m_font.primaryFont())
297             m_fallbackFonts->add(fontData);
298
299         m_complexTextRuns.append(ComplexTextRun::create(ctRun, runFontData, cp, stringLocation, length, runRange));
300     }
301 }
302
303 } // namespace WebCore