ComplexTextControllerCoreText.mm [plain text]
/*
* Copyright (C) 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "ComplexTextController.h"
#include "FontCache.h"
#include "FontCascade.h"
#include <pal/spi/cocoa/CoreTextSPI.h>
#include <wtf/SoftLinking.h>
#include <wtf/WeakPtr.h>
#if PLATFORM(IOS)
#include <CoreText/CoreText.h>
#else
#include <ApplicationServices/ApplicationServices.h>
#endif
// Note: CTFontDescriptorRefs can live forever in caches inside CoreText, so this object can too.
@interface WebCascadeList : NSArray {
@private
WeakPtr<WebCore::FontCascade> _font;
UChar32 _character;
NSUInteger _count;
Vector<RetainPtr<CTFontDescriptorRef>, 16> _fontDescriptors;
}
- (id)initWithFont:(const WebCore::FontCascade*)font character:(UChar32)character;
@end
@implementation WebCascadeList
- (id)initWithFont:(const WebCore::FontCascade*)font character:(UChar32)character
{
if (!(self = [super init]))
return nil;
_font = font->createWeakPtr();
_character = character;
// By the time a WebCascadeList is used, the FontCascade has already been asked to realize all of its
// Fonts, so this loop does not hit the FontCache.
while (!_font->fallbackRangesAt(_count).isNull())
_count++;
return self;
}
- (NSUInteger)count
{
return _font ? _count : 0;
}
- (id)objectAtIndex:(NSUInteger)index
{
if (!_font)
return nil;
CTFontDescriptorRef fontDescriptor;
if (index < _fontDescriptors.size()) {
if ((fontDescriptor = _fontDescriptors[index].get()))
return (id)fontDescriptor;
} else
_fontDescriptors.grow(index + 1);
const WebCore::Font* font = _font->fallbackRangesAt(index).fontForCharacter(_character);
if (!font)
font = &_font->fallbackRangesAt(index).fontForFirstRange();
fontDescriptor = CTFontCopyFontDescriptor(font->platformData().ctFont());
_fontDescriptors[index] = adoptCF(fontDescriptor);
return (id)fontDescriptor;
}
@end
namespace WebCore {
ComplexTextController::ComplexTextRun::ComplexTextRun(CTRunRef ctRun, const Font& font, const UChar* characters, unsigned stringLocation, unsigned stringLength, unsigned indexBegin, unsigned indexEnd)
: m_initialAdvance(CTRunGetInitialAdvance(ctRun))
, m_font(font)
, m_characters(characters)
, m_stringLength(stringLength)
, m_indexBegin(indexBegin)
, m_indexEnd(indexEnd)
, m_glyphCount(CTRunGetGlyphCount(ctRun))
, m_stringLocation(stringLocation)
, m_isLTR(!(CTRunGetStatus(ctRun) & kCTRunStatusRightToLeft))
{
const CFIndex* coreTextIndicesPtr = CTRunGetStringIndicesPtr(ctRun);
Vector<CFIndex> coreTextIndices;
if (!coreTextIndicesPtr) {
coreTextIndices.grow(m_glyphCount);
CTRunGetStringIndices(ctRun, CFRangeMake(0, 0), coreTextIndices.data());
coreTextIndicesPtr = coreTextIndices.data();
}
m_coreTextIndices.reserveInitialCapacity(m_glyphCount);
for (unsigned i = 0; i < m_glyphCount; ++i)
m_coreTextIndices.uncheckedAppend(coreTextIndicesPtr[i]);
const CGGlyph* glyphsPtr = CTRunGetGlyphsPtr(ctRun);
Vector<CGGlyph> glyphs;
if (!glyphsPtr) {
glyphs.grow(m_glyphCount);
CTRunGetGlyphs(ctRun, CFRangeMake(0, 0), glyphs.data());
glyphsPtr = glyphs.data();
}
m_glyphs.reserveInitialCapacity(m_glyphCount);
for (unsigned i = 0; i < m_glyphCount; ++i)
m_glyphs.uncheckedAppend(glyphsPtr[i]);
if (CTRunGetStatus(ctRun) & kCTRunStatusHasOrigins) {
Vector<CGSize> baseAdvances(m_glyphCount);
Vector<CGPoint> glyphOrigins(m_glyphCount);
CTRunGetBaseAdvancesAndOrigins(ctRun, CFRangeMake(0, 0), baseAdvances.data(), glyphOrigins.data());
m_baseAdvances.reserveInitialCapacity(m_glyphCount);
m_glyphOrigins.reserveInitialCapacity(m_glyphCount);
for (unsigned i = 0; i < m_glyphCount; ++i) {
m_baseAdvances.uncheckedAppend(baseAdvances[i]);
m_glyphOrigins.uncheckedAppend(glyphOrigins[i]);
}
} else {
const CGSize* baseAdvances = CTRunGetAdvancesPtr(ctRun);
Vector<CGSize> baseAdvancesVector;
if (!baseAdvances) {
baseAdvancesVector.grow(m_glyphCount);
CTRunGetAdvances(ctRun, CFRangeMake(0, 0), baseAdvancesVector.data());
baseAdvances = baseAdvancesVector.data();
}
m_baseAdvances.reserveInitialCapacity(m_glyphCount);
for (unsigned i = 0; i < m_glyphCount; ++i)
m_baseAdvances.uncheckedAppend(baseAdvances[i]);
}
}
struct ProviderInfo {
const UChar* cp;
unsigned length;
CFDictionaryRef attributes;
};
static const UniChar* provideStringAndAttributes(CFIndex stringIndex, CFIndex* charCount, CFDictionaryRef* attributes, void* refCon)
{
ProviderInfo* info = static_cast<struct ProviderInfo*>(refCon);
if (stringIndex < 0 || static_cast<unsigned>(stringIndex) >= info->length)
return 0;
*charCount = info->length - stringIndex;
*attributes = info->attributes;
return info->cp + stringIndex;
}
static inline bool safeCFEqual(CFTypeRef a, CFTypeRef b)
{
return (!a && !b) || (a && b && CFEqual(a, b));
}
void ComplexTextController::collectComplexTextRunsForCharacters(const UChar* cp, unsigned length, unsigned stringLocation, const Font* font)
{
if (!font) {
// Create a run of missing glyphs from the primary font.
m_complexTextRuns.append(ComplexTextRun::create(m_font.primaryFont(), cp, stringLocation, length, 0, length, m_run.ltr()));
return;
}
bool isSystemFallback = false;
UChar32 baseCharacter = 0;
RetainPtr<CFDictionaryRef> stringAttributes;
if (font == Font::systemFallback()) {
// FIXME: This code path does not support small caps.
isSystemFallback = true;
U16_GET(cp, 0, 0, length, baseCharacter);
font = m_font.fallbackRangesAt(0).fontForCharacter(baseCharacter);
if (!font)
font = &m_font.fallbackRangesAt(0).fontForFirstRange();
RetainPtr<WebCascadeList> cascadeList = adoptNS([[WebCascadeList alloc] initWithFont:&m_font character:baseCharacter]);
stringAttributes = adoptCF(CFDictionaryCreateMutableCopy(kCFAllocatorDefault, 0, font->getCFStringAttributes(m_font.enableKerning(), font->platformData().orientation())));
static const void* attributeKeys[] = { kCTFontCascadeListAttribute };
const void* values[] = { cascadeList.get() };
RetainPtr<CFDictionaryRef> attributes = adoptCF(CFDictionaryCreate(kCFAllocatorDefault, attributeKeys, values, sizeof(attributeKeys) / sizeof(*attributeKeys), &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks));
RetainPtr<CTFontDescriptorRef> fontDescriptor = adoptCF(CTFontDescriptorCreateWithAttributes(attributes.get()));
RetainPtr<CTFontRef> fontWithCascadeList = adoptCF(CTFontCreateCopyWithAttributes(font->platformData().ctFont(), m_font.pixelSize(), 0, fontDescriptor.get()));
CFDictionarySetValue(const_cast<CFMutableDictionaryRef>(stringAttributes.get()), kCTFontAttributeName, fontWithCascadeList.get());
} else
stringAttributes = font->getCFStringAttributes(m_font.enableKerning(), font->platformData().orientation());
RetainPtr<CTLineRef> line;
if (!m_mayUseNaturalWritingDirection || m_run.directionalOverride()) {
static const void* optionKeys[] = { kCTTypesetterOptionForcedEmbeddingLevel };
const short ltrForcedEmbeddingLevelValue = 0;
const short rtlForcedEmbeddingLevelValue = 1;
static const void* ltrOptionValues[] = { CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, <rForcedEmbeddingLevelValue) };
static const void* rtlOptionValues[] = { CFNumberCreate(kCFAllocatorDefault, kCFNumberShortType, &rtlForcedEmbeddingLevelValue) };
static CFDictionaryRef ltrTypesetterOptions = CFDictionaryCreate(kCFAllocatorDefault, optionKeys, ltrOptionValues, WTF_ARRAY_LENGTH(optionKeys), &kCFCopyStringDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
static CFDictionaryRef rtlTypesetterOptions = CFDictionaryCreate(kCFAllocatorDefault, optionKeys, rtlOptionValues, WTF_ARRAY_LENGTH(optionKeys), &kCFCopyStringDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
ProviderInfo info = { cp, length, stringAttributes.get() };
RetainPtr<CTTypesetterRef> typesetter = adoptCF(CTTypesetterCreateWithUniCharProviderAndOptions(&provideStringAndAttributes, 0, &info, m_run.ltr() ? ltrTypesetterOptions : rtlTypesetterOptions));
line = adoptCF(CTTypesetterCreateLine(typesetter.get(), CFRangeMake(0, 0)));
} else {
ProviderInfo info = { cp, length, stringAttributes.get() };
line = adoptCF(CTLineCreateWithUniCharProvider(&provideStringAndAttributes, nullptr, &info));
}
m_coreTextLines.append(line.get());
CFArrayRef runArray = CTLineGetGlyphRuns(line.get());
CFIndex runCount = CFArrayGetCount(runArray);
for (CFIndex r = 0; r < runCount; r++) {
CTRunRef ctRun = static_cast<CTRunRef>(CFArrayGetValueAtIndex(runArray, m_run.ltr() ? r : runCount - 1 - r));
ASSERT(CFGetTypeID(ctRun) == CTRunGetTypeID());
CFRange runRange = CTRunGetStringRange(ctRun);
const Font* runFont = font;
if (isSystemFallback) {
CFDictionaryRef runAttributes = CTRunGetAttributes(ctRun);
CTFontRef runCTFont = static_cast<CTFontRef>(CFDictionaryGetValue(runAttributes, kCTFontAttributeName));
ASSERT(runCTFont && CFGetTypeID(runCTFont) == CTFontGetTypeID());
RetainPtr<CFTypeRef> runFontEqualityObject = FontPlatformData::objectForEqualityCheck(runCTFont);
if (!safeCFEqual(runFontEqualityObject.get(), font->platformData().objectForEqualityCheck().get())) {
// Begin trying to see if runFont matches any of the fonts in the fallback list.
for (unsigned i = 0; !m_font.fallbackRangesAt(i).isNull(); ++i) {
runFont = m_font.fallbackRangesAt(i).fontForCharacter(baseCharacter);
if (!runFont)
continue;
if (safeCFEqual(runFont->platformData().objectForEqualityCheck().get(), runFontEqualityObject.get()))
break;
runFont = nullptr;
}
// If there is no matching font, look up by name in the font cache.
if (!runFont) {
// Rather than using runFont as an NSFont and wrapping it in a FontPlatformData, go through
// the font cache and ultimately through NSFontManager in order to get an NSFont with the right
// NSFontRenderingMode.
RetainPtr<CFStringRef> fontName = adoptCF(CTFontCopyPostScriptName(runCTFont));
if (CFEqual(fontName.get(), CFSTR("LastResort"))) {
m_complexTextRuns.append(ComplexTextRun::create(m_font.primaryFont(), cp, stringLocation, length, runRange.location, runRange.location + runRange.length, m_run.ltr()));
continue;
}
auto& fontCache = FontCache::singleton();
runFont = fontCache.fontForFamily(m_font.fontDescription(), fontName.get()).get();
// Core Text may have used a font that our font lookup path cannot find. In that case, fall back on
// using the font as returned.
if (!runFont) {
FontPlatformData runFontPlatformData(runCTFont, CTFontGetSize(runCTFont));
runFont = fontCache.fontForPlatformData(runFontPlatformData).ptr();
}
}
if (m_fallbackFonts && runFont != &m_font.primaryFont())
m_fallbackFonts->add(runFont);
}
}
if (m_fallbackFonts && runFont != &m_font.primaryFont())
m_fallbackFonts->add(font);
m_complexTextRuns.append(ComplexTextRun::create(ctRun, *runFont, cp, stringLocation, length, runRange.location, runRange.location + runRange.length));
}
}
} // namespace WebCore