platform/mac/editing/input/devanagari-ligature.html is flaky on Yosemite, ligature...
[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* fontData = _font->fontDataAt(index)->fontDataForCharacter(_character);
86     fontDescriptor = CTFontCopyFontDescriptor(fontData->platformData().ctFont());
87     _fontDescriptors[index] = adoptCF(fontDescriptor);
88     return (id)fontDescriptor;
89 }
90
91 @end
92
93 namespace WebCore {
94
95 ComplexTextController::ComplexTextRun::ComplexTextRun(CTRunRef ctRun, const SimpleFontData* fontData, const UChar* characters, unsigned stringLocation, size_t stringLength, CFRange runRange)
96     : m_fontData(fontData)
97     , m_characters(characters)
98     , m_stringLocation(stringLocation)
99     , m_stringLength(stringLength)
100     , m_indexBegin(runRange.location)
101     , m_indexEnd(runRange.location + runRange.length)
102     , m_initialAdvance(CTRunGetInitialAdvance(ctRun))
103     , m_isLTR(!(CTRunGetStatus(ctRun) & kCTRunStatusRightToLeft))
104     , m_isMonotonic(true)
105 {
106     m_glyphCount = CTRunGetGlyphCount(ctRun);
107     m_coreTextIndices = CTRunGetStringIndicesPtr(ctRun);
108     if (!m_coreTextIndices) {
109         m_coreTextIndicesVector.grow(m_glyphCount);
110         CTRunGetStringIndices(ctRun, CFRangeMake(0, 0), m_coreTextIndicesVector.data());
111         m_coreTextIndices = m_coreTextIndicesVector.data();
112     }
113
114     m_glyphs = CTRunGetGlyphsPtr(ctRun);
115     if (!m_glyphs) {
116         m_glyphsVector.grow(m_glyphCount);
117         CTRunGetGlyphs(ctRun, CFRangeMake(0, 0), m_glyphsVector.data());
118         m_glyphs = m_glyphsVector.data();
119     }
120
121     m_advances = CTRunGetAdvancesPtr(ctRun);
122     if (!m_advances) {
123         m_advancesVector.grow(m_glyphCount);
124         CTRunGetAdvances(ctRun, CFRangeMake(0, 0), m_advancesVector.data());
125         m_advances = m_advancesVector.data();
126     }
127 }
128
129 // Missing glyphs run constructor. Core Text will not generate a run of missing glyphs, instead falling back on
130 // glyphs from LastResort. We want to use the primary font's missing glyph in order to match the fast text code path.
131 ComplexTextController::ComplexTextRun::ComplexTextRun(const SimpleFontData* fontData, const UChar* characters, unsigned stringLocation, size_t stringLength, bool ltr)
132     : m_fontData(fontData)
133     , m_characters(characters)
134     , m_stringLocation(stringLocation)
135     , m_stringLength(stringLength)
136     , m_indexBegin(0)
137     , m_indexEnd(stringLength)
138     , m_initialAdvance(CGSizeZero)
139     , m_isLTR(ltr)
140     , m_isMonotonic(true)
141 {
142     m_coreTextIndicesVector.reserveInitialCapacity(m_stringLength);
143     unsigned r = 0;
144     while (r < m_stringLength) {
145         m_coreTextIndicesVector.uncheckedAppend(r);
146         if (U_IS_SURROGATE(m_characters[r])) {
147             ASSERT(r + 1 < m_stringLength);
148             ASSERT(U_IS_SURROGATE_LEAD(m_characters[r]));
149             ASSERT(U_IS_TRAIL(m_characters[r + 1]));
150             r += 2;
151         } else
152             r++;
153     }
154     m_glyphCount = m_coreTextIndicesVector.size();
155     if (!ltr) {
156         for (unsigned r = 0, end = m_glyphCount - 1; r < m_glyphCount / 2; ++r, --end)
157             std::swap(m_coreTextIndicesVector[r], m_coreTextIndicesVector[end]);
158     }
159     m_coreTextIndices = m_coreTextIndicesVector.data();
160
161     // Synthesize a run of missing glyphs.
162     m_glyphsVector.fill(0, m_glyphCount);
163     m_glyphs = m_glyphsVector.data();
164     m_advancesVector.fill(CGSizeMake(m_fontData->widthForGlyph(0), 0), m_glyphCount);
165     m_advances = m_advancesVector.data();
166 }
167
168 struct ProviderInfo {
169     const UChar* cp;
170     unsigned length;
171     CFDictionaryRef attributes;
172 };
173
174 static const UniChar* provideStringAndAttributes(CFIndex stringIndex, CFIndex* charCount, CFDictionaryRef* attributes, void* refCon)
175 {
176     ProviderInfo* info = static_cast<struct ProviderInfo*>(refCon);
177     if (stringIndex < 0 || static_cast<unsigned>(stringIndex) >= info->length)
178         return 0;
179
180     *charCount = info->length - stringIndex;
181     *attributes = info->attributes;
182     return info->cp + stringIndex;
183 }
184
185 void ComplexTextController::collectComplexTextRunsForCharacters(const UChar* cp, unsigned length, unsigned stringLocation, const SimpleFontData* fontData)
186 {
187     if (!fontData) {
188         // Create a run of missing glyphs from the primary font.
189         m_complexTextRuns.append(ComplexTextRun::create(m_font.primaryFont(), cp, stringLocation, length, m_run.ltr()));
190         return;
191     }
192
193     bool isSystemFallback = false;
194
195     UChar32 baseCharacter = 0;
196     RetainPtr<CFDictionaryRef> stringAttributes;
197     if (fontData == SimpleFontData::systemFallback()) {
198         // FIXME: This code path does not support small caps.
199         isSystemFallback = true;
200
201         U16_GET(cp, 0, 0, length, baseCharacter);
202         fontData = m_font.fontDataAt(0)->fontDataForCharacter(baseCharacter);
203
204         RetainPtr<WebCascadeList> cascadeList = adoptNS([[WebCascadeList alloc] initWithFont:&m_font character:baseCharacter]);
205
206         stringAttributes = adoptCF(CFDictionaryCreateMutableCopy(kCFAllocatorDefault, 0, fontData->getCFStringAttributes(m_font.typesettingFeatures(), fontData->platformData().orientation())));
207         static const void* attributeKeys[] = { kCTFontCascadeListAttribute };
208         const void* values[] = { cascadeList.get() };
209         RetainPtr<CFDictionaryRef> attributes = adoptCF(CFDictionaryCreate(kCFAllocatorDefault, attributeKeys, values, sizeof(attributeKeys) / sizeof(*attributeKeys), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
210         RetainPtr<CTFontDescriptorRef> fontDescriptor = adoptCF(CTFontDescriptorCreateWithAttributes(attributes.get()));
211         RetainPtr<CTFontRef> fontWithCascadeList = adoptCF(CTFontCreateCopyWithAttributes(fontData->platformData().ctFont(), m_font.pixelSize(), 0, fontDescriptor.get()));
212         CFDictionarySetValue(const_cast<CFMutableDictionaryRef>(stringAttributes.get()), kCTFontAttributeName, fontWithCascadeList.get());
213     } else
214         stringAttributes = fontData->getCFStringAttributes(m_font.typesettingFeatures(), fontData->platformData().orientation());
215
216     RetainPtr<CTLineRef> line;
217
218     if (!m_mayUseNaturalWritingDirection || m_run.directionalOverride()) {
219         static const void* optionKeys[] = { kCTTypesetterOptionForcedEmbeddingLevel };
220         const short ltrForcedEmbeddingLevelValue = 0;
221         const short rtlForcedEmbeddingLevelValue = 1;
222         static const void* ltrOptionValues[] = { CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &ltrForcedEmbeddingLevelValue) };
223         static const void* rtlOptionValues[] = { CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &rtlForcedEmbeddingLevelValue) };
224         static CFDictionaryRef ltrTypesetterOptions = CFDictionaryCreate(kCFAllocatorDefault, optionKeys, ltrOptionValues, WTF_ARRAY_LENGTH(optionKeys), &kCFCopyStringDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
225         static CFDictionaryRef rtlTypesetterOptions = CFDictionaryCreate(kCFAllocatorDefault, optionKeys, rtlOptionValues, WTF_ARRAY_LENGTH(optionKeys), &kCFCopyStringDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
226
227         ProviderInfo info = { cp, length, stringAttributes.get() };
228         RetainPtr<CTTypesetterRef> typesetter = adoptCF(CTTypesetterCreateWithUniCharProviderAndOptions(&provideStringAndAttributes, 0, &info, m_run.ltr() ? ltrTypesetterOptions : rtlTypesetterOptions));
229
230         line = adoptCF(CTTypesetterCreateLine(typesetter.get(), CFRangeMake(0, 0)));
231     } else {
232         ProviderInfo info = { cp, length, stringAttributes.get() };
233
234         line = adoptCF(CTLineCreateWithUniCharProvider(&provideStringAndAttributes, nullptr, &info));
235     }
236
237     m_coreTextLines.append(line.get());
238
239     CFArrayRef runArray = CTLineGetGlyphRuns(line.get());
240
241     CFIndex runCount = CFArrayGetCount(runArray);
242
243     for (CFIndex r = 0; r < runCount; r++) {
244         CTRunRef ctRun = static_cast<CTRunRef>(CFArrayGetValueAtIndex(runArray, m_run.ltr() ? r : runCount - 1 - r));
245         ASSERT(CFGetTypeID(ctRun) == CTRunGetTypeID());
246         CFRange runRange = CTRunGetStringRange(ctRun);
247         const SimpleFontData* runFontData = fontData;
248         if (isSystemFallback) {
249             CFDictionaryRef runAttributes = CTRunGetAttributes(ctRun);
250             CTFontRef runFont = static_cast<CTFontRef>(CFDictionaryGetValue(runAttributes, kCTFontAttributeName));
251             ASSERT(CFGetTypeID(runFont) == CTFontGetTypeID());
252             RetainPtr<CFTypeRef> runFontEqualityObject = FontPlatformData::objectForEqualityCheck(runFont);
253             if (!CFEqual(runFontEqualityObject.get(), fontData->platformData().objectForEqualityCheck().get())) {
254                 // Begin trying to see if runFont matches any of the fonts in the fallback list.
255                 unsigned i = 0;
256                 for (const FontData* candidateFontData = m_font.fontDataAt(i); candidateFontData; candidateFontData = m_font.fontDataAt(++i)) {
257                     runFontData = candidateFontData->fontDataForCharacter(baseCharacter);
258                     RetainPtr<CFTypeRef> runFontEqualityObject = runFontData->platformData().objectForEqualityCheck();
259                     if (CFEqual(runFontEqualityObject.get(), runFontEqualityObject.get()))
260                         break;
261                     runFontData = 0;
262                 }
263                 // If there is no matching font, look up by name in the font cache.
264                 if (!runFontData) {
265                     // Rather than using runFont as an NSFont and wrapping it in a FontPlatformData, go through
266                     // the font cache and ultimately through NSFontManager in order to get an NSFont with the right
267                     // NSFontRenderingMode.
268                     RetainPtr<CFStringRef> fontName = adoptCF(CTFontCopyPostScriptName(runFont));
269                     if (CFEqual(fontName.get(), CFSTR("LastResort"))) {
270                         m_complexTextRuns.append(ComplexTextRun::create(m_font.primaryFont(), cp, stringLocation + runRange.location, runRange.length, m_run.ltr()));
271                         continue;
272                     }
273                     runFontData = fontCache().getCachedFontData(m_font.fontDescription(), fontName.get(), false, FontCache::DoNotRetain).get();
274 #if !PLATFORM(IOS)
275                     // Core Text may have used a font that is not known to NSFontManager. In that case, fall back on
276                     // using the font as returned, even though it may not have the best NSFontRenderingMode.
277                     if (!runFontData) {
278                         FontPlatformData runFontPlatformData((NSFont *)runFont, CTFontGetSize(runFont), m_font.fontDescription().usePrinterFont());
279                         runFontData = fontCache().getCachedFontData(&runFontPlatformData, FontCache::DoNotRetain).get();
280                     }
281 #else
282                     // FIXME: Just assert for now, until we can devise a better fix that works with iOS.
283                     ASSERT(runFontData);
284 #endif
285                 }
286                 if (m_fallbackFonts && runFontData != m_font.primaryFont())
287                     m_fallbackFonts->add(runFontData);
288             }
289         }
290         if (m_fallbackFonts && runFontData != m_font.primaryFont())
291             m_fallbackFonts->add(fontData);
292
293         m_complexTextRuns.append(ComplexTextRun::create(ctRun, runFontData, cp, stringLocation, length, runRange));
294     }
295 }
296
297 } // namespace WebCore