2 * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
3 * (C) 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include "CSSFontSelector.h"
30 #include "CachedFont.h"
31 #include "CSSFontFace.h"
32 #include "CSSFontFaceRule.h"
33 #include "CSSFontFaceSource.h"
34 #include "CSSFontFaceSrcValue.h"
35 #include "CSSMutableStyleDeclaration.h"
36 #include "CSSPrimitiveValue.h"
37 #include "CSSPropertyNames.h"
38 #include "CSSSegmentedFontFace.h"
39 #include "CSSUnicodeRangeValue.h"
40 #include "CSSValueKeywords.h"
41 #include "CSSValueList.h"
42 #include "CachedResourceLoader.h"
44 #include "FontCache.h"
45 #include "FontFamilyValue.h"
47 #include "RenderObject.h"
49 #include "SimpleFontData.h"
50 #include <wtf/text/AtomicString.h>
53 #include "SVGFontFaceElement.h"
59 CSSFontSelector::CSSFontSelector(Document* document)
60 : m_document(document)
62 // FIXME: An old comment used to say there was no need to hold a reference to m_document
63 // because "we are guaranteed to be destroyed before the document". But there does not
64 // seem to be any such guarantee.
67 fontCache()->addClient(this);
70 CSSFontSelector::~CSSFontSelector()
72 fontCache()->removeClient(this);
73 deleteAllValues(m_fontFaces);
74 deleteAllValues(m_locallyInstalledFontFaces);
75 deleteAllValues(m_fonts);
78 bool CSSFontSelector::isEmpty() const
80 return m_fonts.isEmpty();
83 CachedResourceLoader* CSSFontSelector::cachedResourceLoader() const
85 return m_document ? m_document->cachedResourceLoader() : 0;
88 void CSSFontSelector::addFontFaceRule(const CSSFontFaceRule* fontFaceRule)
90 // Obtain the font-family property and the src property. Both must be defined.
91 const CSSMutableStyleDeclaration* style = fontFaceRule->style();
92 RefPtr<CSSValue> fontFamily = style->getPropertyCSSValue(CSSPropertyFontFamily);
93 RefPtr<CSSValue> src = style->getPropertyCSSValue(CSSPropertySrc);
94 RefPtr<CSSValue> unicodeRange = style->getPropertyCSSValue(CSSPropertyUnicodeRange);
95 if (!fontFamily || !src || !fontFamily->isValueList() || !src->isValueList() || (unicodeRange && !unicodeRange->isValueList()))
98 CSSValueList* familyList = static_cast<CSSValueList*>(fontFamily.get());
99 if (!familyList->length())
102 CSSValueList* srcList = static_cast<CSSValueList*>(src.get());
103 if (!srcList->length())
106 CSSValueList* rangeList = static_cast<CSSValueList*>(unicodeRange.get());
108 unsigned traitsMask = 0;
110 if (RefPtr<CSSValue> fontStyle = style->getPropertyCSSValue(CSSPropertyFontStyle)) {
111 if (fontStyle->isPrimitiveValue()) {
112 RefPtr<CSSValueList> list = CSSValueList::createCommaSeparated();
113 list->append(fontStyle);
115 } else if (!fontStyle->isValueList())
118 CSSValueList* styleList = static_cast<CSSValueList*>(fontStyle.get());
119 unsigned numStyles = styleList->length();
123 for (unsigned i = 0; i < numStyles; ++i) {
124 switch (static_cast<CSSPrimitiveValue*>(styleList->itemWithoutBoundsCheck(i))->getIdent()) {
126 traitsMask |= FontStyleMask;
129 traitsMask |= FontStyleNormalMask;
132 case CSSValueOblique:
133 traitsMask |= FontStyleItalicMask;
140 traitsMask |= FontStyleMask;
142 if (RefPtr<CSSValue> fontWeight = style->getPropertyCSSValue(CSSPropertyFontWeight)) {
143 if (fontWeight->isPrimitiveValue()) {
144 RefPtr<CSSValueList> list = CSSValueList::createCommaSeparated();
145 list->append(fontWeight);
147 } else if (!fontWeight->isValueList())
150 CSSValueList* weightList = static_cast<CSSValueList*>(fontWeight.get());
151 unsigned numWeights = weightList->length();
155 for (unsigned i = 0; i < numWeights; ++i) {
156 switch (static_cast<CSSPrimitiveValue*>(weightList->itemWithoutBoundsCheck(i))->getIdent()) {
158 traitsMask |= FontWeightMask;
163 traitsMask |= FontWeight700Mask;
167 traitsMask |= FontWeight400Mask;
170 traitsMask |= FontWeight900Mask;
173 traitsMask |= FontWeight800Mask;
176 traitsMask |= FontWeight600Mask;
179 traitsMask |= FontWeight500Mask;
182 traitsMask |= FontWeight300Mask;
184 case CSSValueLighter:
186 traitsMask |= FontWeight200Mask;
189 traitsMask |= FontWeight100Mask;
196 traitsMask |= FontWeightMask;
198 if (RefPtr<CSSValue> fontVariant = style->getPropertyCSSValue(CSSPropertyFontVariant)) {
199 if (fontVariant->isPrimitiveValue()) {
200 RefPtr<CSSValueList> list = CSSValueList::createCommaSeparated();
201 list->append(fontVariant);
203 } else if (!fontVariant->isValueList())
206 CSSValueList* variantList = static_cast<CSSValueList*>(fontVariant.get());
207 unsigned numVariants = variantList->length();
211 for (unsigned i = 0; i < numVariants; ++i) {
212 switch (static_cast<CSSPrimitiveValue*>(variantList->itemWithoutBoundsCheck(i))->getIdent()) {
214 traitsMask |= FontVariantMask;
217 traitsMask |= FontVariantNormalMask;
219 case CSSValueSmallCaps:
220 traitsMask |= FontVariantSmallCapsMask;
227 traitsMask |= FontVariantMask;
229 // Each item in the src property's list is a single CSSFontFaceSource. Put them all into a CSSFontFace.
230 RefPtr<CSSFontFace> fontFace;
232 int srcLength = srcList->length();
234 bool foundSVGFont = false;
236 for (int i = 0; i < srcLength; i++) {
237 // An item in the list either specifies a string (local font name) or a URL (remote font to download).
238 CSSFontFaceSrcValue* item = static_cast<CSSFontFaceSrcValue*>(srcList->itemWithoutBoundsCheck(i));
239 CSSFontFaceSource* source = 0;
241 #if ENABLE(SVG_FONTS)
242 foundSVGFont = item->isSVGFontFaceSrc() || item->svgFontFaceElement();
244 if (!item->isLocal()) {
245 Settings* settings = m_document ? m_document->frame() ? m_document->frame()->settings() : 0 : 0;
246 bool allowDownloading = foundSVGFont || (settings && settings->downloadableBinaryFontsEnabled());
247 if (allowDownloading && item->isSupportedFormat() && m_document) {
248 CachedFont* cachedFont = m_document->cachedResourceLoader()->requestFont(item->resource());
250 source = new CSSFontFaceSource(item->resource(), cachedFont);
251 #if ENABLE(SVG_FONTS)
253 source->setHasExternalSVGFont(true);
258 source = new CSSFontFaceSource(item->resource());
262 fontFace = CSSFontFace::create(static_cast<FontTraitsMask>(traitsMask));
265 #if ENABLE(SVG_FONTS)
266 source->setSVGFontFaceElement(item->svgFontFaceElement());
268 fontFace->addSource(source);
274 if (fontFace && !fontFace->isValid())
278 unsigned numRanges = rangeList->length();
279 for (unsigned i = 0; i < numRanges; i++) {
280 CSSUnicodeRangeValue* range = static_cast<CSSUnicodeRangeValue*>(rangeList->itemWithoutBoundsCheck(i));
281 fontFace->addRange(range->from(), range->to());
285 // Hash under every single family name.
286 int familyLength = familyList->length();
287 for (int i = 0; i < familyLength; i++) {
288 CSSPrimitiveValue* item = static_cast<CSSPrimitiveValue*>(familyList->itemWithoutBoundsCheck(i));
290 if (item->primitiveType() == CSSPrimitiveValue::CSS_STRING)
291 familyName = static_cast<FontFamilyValue*>(item)->familyName();
292 else if (item->primitiveType() == CSSPrimitiveValue::CSS_IDENT) {
293 // We need to use the raw text for all the generic family types, since @font-face is a way of actually
294 // defining what font to use for those types.
296 switch (item->getIdent()) {
298 familyName = "-webkit-serif";
300 case CSSValueSansSerif:
301 familyName = "-webkit-sans-serif";
303 case CSSValueCursive:
304 familyName = "-webkit-cursive";
306 case CSSValueFantasy:
307 familyName = "-webkit-fantasy";
309 case CSSValueMonospace:
310 familyName = "-webkit-monospace";
317 if (familyName.isEmpty())
320 Vector<RefPtr<CSSFontFace> >* familyFontFaces = m_fontFaces.get(familyName);
321 if (!familyFontFaces) {
322 familyFontFaces = new Vector<RefPtr<CSSFontFace> >;
323 m_fontFaces.set(familyName, familyFontFaces);
325 ASSERT(!m_locallyInstalledFontFaces.contains(familyName));
326 Vector<RefPtr<CSSFontFace> >* familyLocallyInstalledFaces;
328 Vector<unsigned> locallyInstalledFontsTraitsMasks;
329 fontCache()->getTraitsInFamily(familyName, locallyInstalledFontsTraitsMasks);
330 unsigned numLocallyInstalledFaces = locallyInstalledFontsTraitsMasks.size();
331 if (numLocallyInstalledFaces) {
332 familyLocallyInstalledFaces = new Vector<RefPtr<CSSFontFace> >;
333 m_locallyInstalledFontFaces.set(familyName, familyLocallyInstalledFaces);
335 for (unsigned i = 0; i < numLocallyInstalledFaces; ++i) {
336 RefPtr<CSSFontFace> locallyInstalledFontFace = CSSFontFace::create(static_cast<FontTraitsMask>(locallyInstalledFontsTraitsMasks[i]), true);
337 locallyInstalledFontFace->addSource(new CSSFontFaceSource(familyName));
338 ASSERT(locallyInstalledFontFace->isValid());
339 familyLocallyInstalledFaces->append(locallyInstalledFontFace);
344 familyFontFaces->append(fontFace);
348 void CSSFontSelector::registerForInvalidationCallbacks(FontSelectorClient* client)
350 m_clients.add(client);
353 void CSSFontSelector::unregisterForInvalidationCallbacks(FontSelectorClient* client)
355 m_clients.remove(client);
358 void CSSFontSelector::dispatchInvalidationCallbacks()
360 Vector<FontSelectorClient*> clients;
361 copyToVector(m_clients, clients);
362 for (size_t i = 0; i < clients.size(); ++i)
363 clients[i]->fontsNeedUpdate(this);
365 // FIXME: Make Document a FontSelectorClient so that it can simply register for invalidation callbacks.
366 if (!m_document || m_document->inPageCache() || !m_document->renderer())
368 m_document->scheduleForcedStyleRecalc();
371 void CSSFontSelector::fontLoaded()
373 dispatchInvalidationCallbacks();
376 void CSSFontSelector::fontCacheInvalidated()
378 dispatchInvalidationCallbacks();
381 static FontData* fontDataForGenericFamily(Document* document, const FontDescription& fontDescription, const AtomicString& familyName)
383 if (!document || !document->frame())
386 const Settings* settings = document->frame()->settings();
390 AtomicString genericFamily;
391 if (familyName == "-webkit-serif")
392 genericFamily = settings->serifFontFamily();
393 else if (familyName == "-webkit-sans-serif")
394 genericFamily = settings->sansSerifFontFamily();
395 else if (familyName == "-webkit-cursive")
396 genericFamily = settings->cursiveFontFamily();
397 else if (familyName == "-webkit-fantasy")
398 genericFamily = settings->fantasyFontFamily();
399 else if (familyName == "-webkit-monospace")
400 genericFamily = settings->fixedFontFamily();
401 else if (familyName == "-webkit-standard")
402 genericFamily = settings->standardFontFamily();
404 if (!genericFamily.isEmpty())
405 return fontCache()->getCachedFontData(fontDescription, genericFamily);
410 static FontTraitsMask desiredTraitsMaskForComparison;
412 static inline bool compareFontFaces(CSSFontFace* first, CSSFontFace* second)
414 FontTraitsMask firstTraitsMask = first->traitsMask();
415 FontTraitsMask secondTraitsMask = second->traitsMask();
417 bool firstHasDesiredVariant = firstTraitsMask & desiredTraitsMaskForComparison & FontVariantMask;
418 bool secondHasDesiredVariant = secondTraitsMask & desiredTraitsMaskForComparison & FontVariantMask;
420 if (firstHasDesiredVariant != secondHasDesiredVariant)
421 return firstHasDesiredVariant;
423 if ((desiredTraitsMaskForComparison & FontVariantSmallCapsMask) && !first->isLocalFallback() && !second->isLocalFallback()) {
424 // Prefer a font that has indicated that it can only support small-caps to a font that claims to support
425 // all variants. The specialized font is more likely to be true small-caps and not require synthesis.
426 bool firstRequiresSmallCaps = (firstTraitsMask & FontVariantSmallCapsMask) && !(firstTraitsMask & FontVariantNormalMask);
427 bool secondRequiresSmallCaps = (secondTraitsMask & FontVariantSmallCapsMask) && !(secondTraitsMask & FontVariantNormalMask);
428 if (firstRequiresSmallCaps != secondRequiresSmallCaps)
429 return firstRequiresSmallCaps;
432 bool firstHasDesiredStyle = firstTraitsMask & desiredTraitsMaskForComparison & FontStyleMask;
433 bool secondHasDesiredStyle = secondTraitsMask & desiredTraitsMaskForComparison & FontStyleMask;
435 if (firstHasDesiredStyle != secondHasDesiredStyle)
436 return firstHasDesiredStyle;
438 if ((desiredTraitsMaskForComparison & FontStyleItalicMask) && !first->isLocalFallback() && !second->isLocalFallback()) {
439 // Prefer a font that has indicated that it can only support italics to a font that claims to support
440 // all styles. The specialized font is more likely to be the one the author wants used.
441 bool firstRequiresItalics = (firstTraitsMask & FontStyleItalicMask) && !(firstTraitsMask & FontStyleNormalMask);
442 bool secondRequiresItalics = (secondTraitsMask & FontStyleItalicMask) && !(secondTraitsMask & FontStyleNormalMask);
443 if (firstRequiresItalics != secondRequiresItalics)
444 return firstRequiresItalics;
447 if (secondTraitsMask & desiredTraitsMaskForComparison & FontWeightMask)
449 if (firstTraitsMask & desiredTraitsMaskForComparison & FontWeightMask)
452 // http://www.w3.org/TR/2002/WD-css3-webfonts-20020802/#q46 says: "If there are fewer then 9 weights in the family, the default algorithm
453 // for filling the "holes" is as follows. If '500' is unassigned, it will be assigned the same font as '400'. If any of the values '600',
454 // '700', '800', or '900' remains unassigned, they are assigned to the same face as the next darker assigned keyword, if any, or the next
455 // lighter one otherwise. If any of '300', '200', or '100' remains unassigned, it is assigned to the next lighter assigned keyword, if any,
456 // or the next darker otherwise."
457 // For '400', we made up our own rule (which then '500' follows).
459 static const unsigned fallbackRuleSets = 9;
460 static const unsigned rulesPerSet = 8;
461 static const FontTraitsMask weightFallbackRuleSets[fallbackRuleSets][rulesPerSet] = {
462 { FontWeight200Mask, FontWeight300Mask, FontWeight400Mask, FontWeight500Mask, FontWeight600Mask, FontWeight700Mask, FontWeight800Mask, FontWeight900Mask },
463 { FontWeight100Mask, FontWeight300Mask, FontWeight400Mask, FontWeight500Mask, FontWeight600Mask, FontWeight700Mask, FontWeight800Mask, FontWeight900Mask },
464 { FontWeight200Mask, FontWeight100Mask, FontWeight400Mask, FontWeight500Mask, FontWeight600Mask, FontWeight700Mask, FontWeight800Mask, FontWeight900Mask },
465 { FontWeight500Mask, FontWeight300Mask, FontWeight600Mask, FontWeight200Mask, FontWeight700Mask, FontWeight100Mask, FontWeight800Mask, FontWeight900Mask },
466 { FontWeight400Mask, FontWeight300Mask, FontWeight600Mask, FontWeight200Mask, FontWeight700Mask, FontWeight100Mask, FontWeight800Mask, FontWeight900Mask },
467 { FontWeight700Mask, FontWeight800Mask, FontWeight900Mask, FontWeight500Mask, FontWeight400Mask, FontWeight300Mask, FontWeight200Mask, FontWeight100Mask },
468 { FontWeight800Mask, FontWeight900Mask, FontWeight600Mask, FontWeight500Mask, FontWeight400Mask, FontWeight300Mask, FontWeight200Mask, FontWeight100Mask },
469 { FontWeight900Mask, FontWeight700Mask, FontWeight600Mask, FontWeight500Mask, FontWeight400Mask, FontWeight300Mask, FontWeight200Mask, FontWeight100Mask },
470 { FontWeight800Mask, FontWeight700Mask, FontWeight600Mask, FontWeight500Mask, FontWeight400Mask, FontWeight300Mask, FontWeight200Mask, FontWeight100Mask }
473 unsigned ruleSetIndex = 0;
474 unsigned w = FontWeight100Bit;
475 while (!(desiredTraitsMaskForComparison & (1 << w))) {
480 ASSERT(ruleSetIndex < fallbackRuleSets);
481 const FontTraitsMask* weightFallbackRule = weightFallbackRuleSets[ruleSetIndex];
482 for (unsigned i = 0; i < rulesPerSet; ++i) {
483 if (secondTraitsMask & weightFallbackRule[i])
485 if (firstTraitsMask & weightFallbackRule[i])
492 FontData* CSSFontSelector::getFontData(const FontDescription& fontDescription, const AtomicString& familyName)
494 if (m_fontFaces.isEmpty()) {
495 if (familyName.startsWith("-webkit-"))
496 return fontDataForGenericFamily(m_document, fontDescription, familyName);
500 String family = familyName.string();
502 Vector<RefPtr<CSSFontFace> >* familyFontFaces = m_fontFaces.get(family);
503 // If no face was found, then return 0 and let the OS come up with its best match for the name.
504 if (!familyFontFaces || familyFontFaces->isEmpty()) {
505 // If we were handed a generic family, but there was no match, go ahead and return the correct font based off our
507 return fontDataForGenericFamily(m_document, fontDescription, familyName);
510 HashMap<unsigned, RefPtr<CSSSegmentedFontFace> >* segmentedFontFaceCache = m_fonts.get(family);
511 if (!segmentedFontFaceCache) {
512 segmentedFontFaceCache = new HashMap<unsigned, RefPtr<CSSSegmentedFontFace> >;
513 m_fonts.set(family, segmentedFontFaceCache);
516 FontTraitsMask traitsMask = fontDescription.traitsMask();
518 RefPtr<CSSSegmentedFontFace> face = segmentedFontFaceCache->get(traitsMask);
521 face = CSSSegmentedFontFace::create(this);
522 segmentedFontFaceCache->set(traitsMask, face);
523 // Collect all matching faces and sort them in order of preference.
524 Vector<CSSFontFace*, 32> candidateFontFaces;
525 for (int i = familyFontFaces->size() - 1; i >= 0; --i) {
526 CSSFontFace* candidate = familyFontFaces->at(i).get();
527 unsigned candidateTraitsMask = candidate->traitsMask();
528 if ((traitsMask & FontStyleNormalMask) && !(candidateTraitsMask & FontStyleNormalMask))
530 if ((traitsMask & FontVariantNormalMask) && !(candidateTraitsMask & FontVariantNormalMask))
532 #if ENABLE(SVG_FONTS)
533 // For SVG Fonts that specify that they only support the "normal" variant, we will assume they are incapable
534 // of small-caps synthesis and just ignore the font face as a candidate.
535 if (candidate->hasSVGFontFaceSource() && (traitsMask & FontVariantSmallCapsMask) && !(candidateTraitsMask & FontVariantSmallCapsMask))
538 candidateFontFaces.append(candidate);
541 if (Vector<RefPtr<CSSFontFace> >* familyLocallyInstalledFontFaces = m_locallyInstalledFontFaces.get(family)) {
542 unsigned numLocallyInstalledFontFaces = familyLocallyInstalledFontFaces->size();
543 for (unsigned i = 0; i < numLocallyInstalledFontFaces; ++i) {
544 CSSFontFace* candidate = familyLocallyInstalledFontFaces->at(i).get();
545 unsigned candidateTraitsMask = candidate->traitsMask();
546 if ((traitsMask & FontStyleNormalMask) && !(candidateTraitsMask & FontStyleNormalMask))
548 if ((traitsMask & FontVariantNormalMask) && !(candidateTraitsMask & FontVariantNormalMask))
550 candidateFontFaces.append(candidate);
554 desiredTraitsMaskForComparison = traitsMask;
555 std::stable_sort(candidateFontFaces.begin(), candidateFontFaces.end(), compareFontFaces);
556 unsigned numCandidates = candidateFontFaces.size();
557 for (unsigned i = 0; i < numCandidates; ++i)
558 face->appendFontFace(candidateFontFaces[i]);
561 // We have a face. Ask it for a font data. If it cannot produce one, it will fail, and the OS will take over.
562 return face->getFontData(fontDescription);