Not reviewed. Build fix for Qt/Gtk & Wx.
[WebKit-https.git] / WebCore / css / CSSFontSelector.cpp
1 /*
2  * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
3  *           (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
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  * 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.
13  *
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. 
25  */
26
27 #include "config.h"
28
29 #include "CSSFontSelector.h"
30 #include "AtomicString.h"
31 #include "CString.h"
32 #include "CSSFontFace.h"
33 #include "CSSFontFaceRule.h"
34 #include "CSSFontFaceSource.h"
35 #include "CSSFontFaceSrcValue.h"
36 #include "CSSMutableStyleDeclaration.h"
37 #include "CSSPrimitiveValue.h"
38 #include "CSSPropertyNames.h"
39 #include "CSSSegmentedFontFace.h"
40 #include "CSSUnicodeRangeValue.h"
41 #include "CSSValueKeywords.h"
42 #include "CSSValueList.h"
43 #include "DocLoader.h"
44 #include "Document.h"
45 #include "FontCache.h"
46 #include "FontFamilyValue.h"
47 #include "Frame.h"
48 #include "NodeList.h"
49 #include "RenderObject.h"
50 #include "Settings.h"
51 #include "SimpleFontData.h"
52
53 #if ENABLE(SVG)
54 #include "SVGFontFaceElement.h"
55 #include "SVGNames.h"
56 #endif
57
58 namespace WebCore {
59
60 CSSFontSelector::CSSFontSelector(Document* document)
61 : m_document(document)
62 {
63     ASSERT(m_document);
64 }
65
66 CSSFontSelector::~CSSFontSelector()
67 {}
68
69 bool CSSFontSelector::isEmpty() const
70 {
71     return m_fonts.isEmpty();
72 }
73
74 DocLoader* CSSFontSelector::docLoader() const
75 {
76     return m_document->docLoader();
77 }
78
79 static String hashForFont(const String& familyName, bool bold, bool italic)
80 {
81     String familyHash(familyName);
82     if (bold)
83         familyHash += "-webkit-bold";
84     if (italic)
85         familyHash += "-webkit-italic";
86     return AtomicString(familyHash);
87 }
88
89 void CSSFontSelector::addFontFaceRule(const CSSFontFaceRule* fontFaceRule)
90 {
91     // Obtain the font-family property and the src property.  Both must be defined.
92     const CSSMutableStyleDeclaration* style = fontFaceRule->style();
93     RefPtr<CSSValue> fontFamily = style->getPropertyCSSValue(CSS_PROP_FONT_FAMILY);
94     RefPtr<CSSValue> src = style->getPropertyCSSValue(CSS_PROP_SRC);
95     RefPtr<CSSValue> unicodeRange = style->getPropertyCSSValue(CSS_PROP_UNICODE_RANGE);
96     if (!fontFamily || !src || !fontFamily->isValueList() || !src->isValueList() || unicodeRange && !unicodeRange->isValueList())
97         return;
98
99     CSSValueList* familyList = static_cast<CSSValueList*>(fontFamily.get());
100     if (!familyList->length())
101         return;
102         
103     CSSValueList* srcList = static_cast<CSSValueList*>(src.get());
104     if (!srcList->length())
105         return;
106
107     CSSValueList* rangeList = static_cast<CSSValueList*>(unicodeRange.get());
108
109     // Create a FontDescription for this font and set up bold/italic info properly.
110     FontDescription fontDescription;
111
112     if (RefPtr<CSSValue> fontStyle = style->getPropertyCSSValue(CSS_PROP_FONT_STYLE))
113         fontDescription.setItalic(static_cast<CSSPrimitiveValue*>(fontStyle.get())->getIdent() != CSS_VAL_NORMAL);
114
115     if (RefPtr<CSSValue> fontWeight = style->getPropertyCSSValue(CSS_PROP_FONT_WEIGHT)) {
116         // FIXME: Need to support weights for real, since we're effectively limiting the number of supported weights to two.
117         // This behavior could also result in the "last kinda bold variant" described winning even if it isn't the best match for bold.
118         switch (static_cast<CSSPrimitiveValue*>(fontWeight.get())->getIdent()) {
119             case CSS_VAL_BOLD:
120             case CSS_VAL_BOLDER:
121             case CSS_VAL_600:
122             case CSS_VAL_700:
123             case CSS_VAL_800:
124             case CSS_VAL_900:
125                 fontDescription.setWeight(cBoldWeight);
126             default:
127                 break;
128         }
129     }
130
131     if (RefPtr<CSSValue> fontVariant = style->getPropertyCSSValue(CSS_PROP_FONT_VARIANT))
132         fontDescription.setSmallCaps(static_cast<CSSPrimitiveValue*>(fontVariant.get())->getIdent() == CSS_VAL_SMALL_CAPS);
133
134     // Each item in the src property's list is a single CSSFontFaceSource. Put them all into a CSSFontFace.
135     CSSFontFace* fontFace = 0;
136
137     int i;
138     int srcLength = srcList->length();
139
140     bool foundLocal = false;
141
142 #if ENABLE(SVG_FONTS)
143     bool foundInDocumentSVGFont = false;
144 #endif
145
146     for (i = 0; i < srcLength; i++) {
147         // An item in the list either specifies a string (local font name) or a URL (remote font to download).
148         CSSFontFaceSrcValue* item = static_cast<CSSFontFaceSrcValue*>(srcList->item(i));
149         CSSFontFaceSource* source = 0;
150
151         if (!item->isLocal()) {
152             if (item->isSupportedFormat()) {
153                 CachedFont* cachedFont = m_document->docLoader()->requestFont(item->resource());
154                 if (cachedFont)
155                     source = new CSSFontFaceSource(item->resource(), cachedFont);
156             }
157         } else {
158             String family = item->resource();
159
160 #if ENABLE(SVG_FONTS)
161             foundInDocumentSVGFont = item->svgFontFaceElement() != 0;
162 #endif
163
164             // Test the validity of the local font now.  We don't want to include this font if it does not exist
165             // on the system.  If it *does* exist on the system, then we don't need to look any further.
166             if (FontCache::fontExists(fontDescription, family)
167 #if ENABLE(SVG_FONTS)    
168                 || foundInDocumentSVGFont
169 #endif
170                ) {
171                 source = new CSSFontFaceSource(family);
172 #if ENABLE(SVG_FONTS)
173                 source->setSVGFontFaceElement(item->svgFontFaceElement());
174 #endif
175                 foundLocal = true;
176             }
177         }
178
179         if (!fontFace)
180             fontFace = new CSSFontFace();
181
182         if (source)
183             fontFace->addSource(source);
184
185         // We can just break if we see a local font that is valid.
186         if (foundLocal)
187             break;
188     }
189
190     ASSERT(fontFace);
191
192     if (fontFace && !fontFace->isValid()) {
193         delete fontFace;
194         return;
195     }
196
197     // Hash under every single family name.
198     int familyLength = familyList->length();
199     for (i = 0; i < familyLength; i++) {
200         CSSPrimitiveValue* item = static_cast<CSSPrimitiveValue*>(familyList->item(i));
201         String familyName;
202         if (item->primitiveType() == CSSPrimitiveValue::CSS_STRING)
203             familyName = static_cast<FontFamilyValue*>(item)->fontName();
204         else if (item->primitiveType() == CSSPrimitiveValue::CSS_IDENT) {
205             // We need to use the raw text for all the generic family types, since @font-face is a way of actually
206             // defining what font to use for those types.
207             String familyName;
208             switch (item->getIdent()) {
209                 case CSS_VAL_SERIF:
210                     familyName = "-webkit-serif";
211                     break;
212                 case CSS_VAL_SANS_SERIF:
213                     familyName = "-webkit-sans-serif";
214                     break;
215                 case CSS_VAL_CURSIVE:
216                     familyName = "-webkit-cursive";
217                     break;
218                 case CSS_VAL_FANTASY:
219                     familyName = "-webkit-fantasy";
220                     break;
221                 case CSS_VAL_MONOSPACE:
222                     familyName = "-webkit-monospace";
223                     break;
224                 default:
225                     break;
226             }
227         }
228
229         if (familyName.isEmpty())
230             continue;
231
232 #if ENABLE(SVG_FONTS)
233         // SVG allows several <font> elements with the same font-family, differing only
234         // in ie. font-variant. Be sure to pick up the right one - in getFontData below.
235         if (foundInDocumentSVGFont && fontDescription.smallCaps())
236             familyName += "-webkit-svg-small-caps";
237 #endif
238         String hash = hashForFont(familyName.lower(), fontDescription.bold(), fontDescription.italic());
239         CSSSegmentedFontFace* segmentedFontFace = m_fonts.get(hash).get();
240         if (!segmentedFontFace) {
241             segmentedFontFace = new CSSSegmentedFontFace(this);
242             m_fonts.set(hash, segmentedFontFace);
243         }
244         if (rangeList) {
245             // A local font matching the font description should come first, so that it gets used for
246             // any character not overlaid by explicit @font-face rules for the family.
247             if (!segmentedFontFace->numRanges() && FontCache::fontExists(fontDescription, familyName)) {
248                 CSSFontFace* implicitFontFace = new CSSFontFace();
249                 implicitFontFace->addSource(new CSSFontFaceSource(familyName));
250                 ASSERT(implicitFontFace->isValid());
251                 segmentedFontFace->overlayRange(0, 0x7FFFFFFF, implicitFontFace);
252             }
253
254             unsigned numRanges = rangeList->length();
255             for (unsigned i = 0; i < numRanges; i++) {
256                 CSSUnicodeRangeValue* range = static_cast<CSSUnicodeRangeValue*>(rangeList->item(i));
257                 segmentedFontFace->overlayRange(range->from(), range->to(), fontFace);
258             }
259         } else
260             segmentedFontFace->overlayRange(0, 0x7FFFFFFF, fontFace);
261     }
262 }
263
264 void CSSFontSelector::fontLoaded(CSSSegmentedFontFace*)
265 {
266     if (m_document->inPageCache())
267         return;
268     m_document->recalcStyle(Document::Force);
269     m_document->renderer()->setNeedsLayoutAndPrefWidthsRecalc();
270 }
271
272 FontData* CSSFontSelector::getFontData(const FontDescription& fontDescription, const AtomicString& familyName)
273 {
274     if (m_fonts.isEmpty() && !familyName.startsWith("-webkit-"))
275         return 0;
276     
277     bool bold = fontDescription.bold();
278     bool italic = fontDescription.italic();
279     
280     bool syntheticBold = false;
281     bool syntheticItalic = false;
282
283     String family = familyName.domString().lower();
284
285 #if ENABLE(SVG_FONTS)
286     RefPtr<CSSSegmentedFontFace> face;
287
288     if (fontDescription.smallCaps()) {
289         String testFamily = family + "-webkit-svg-small-caps";
290         face = m_fonts.get(hashForFont(testFamily, bold, italic));
291     } else
292         face = m_fonts.get(hashForFont(family, bold, italic));
293 #else
294     RefPtr<CSSSegmentedFontFace> face = m_fonts.get(hashForFont(family, bold, italic));
295 #endif
296
297     // If we don't find a face, and if bold/italic are set, we should try other variants.
298     // Bold/italic should try bold first, then italic, then normal (on the assumption that we are better at synthesizing italic than we are
299     // at synthesizing bold).
300     if (!face) {
301         if (bold && italic) {
302             syntheticItalic = true;
303             face = m_fonts.get(hashForFont(family, bold, false));
304             if (!face) {
305                 syntheticBold = true;
306                 face = m_fonts.get(hashForFont(family, false, italic));
307             }
308         }
309         
310         // Bold should try normal.
311         // Italic should try normal.
312         if (!face && (bold || italic)) {
313             syntheticBold = bold;
314             syntheticItalic = italic;
315             face = m_fonts.get(hashForFont(family, false, false));
316         }
317     }
318
319 #if ENABLE(SVG_FONTS)
320     // If no face was found, and if we're a SVG Font we may have hit following case:
321     // <font-face> specified font-weight and/or font-style to be ie. bold and italic.
322     // And the font-family requested is non-bold & non-italic. For SVG Fonts we still
323     // have to return the defined font, and not fallback to the system default.
324     if (!face && !bold)
325         face = m_fonts.get(hashForFont(family, true, italic));
326
327     if (!face && !italic)
328         face = m_fonts.get(hashForFont(family, bold, true));
329
330     if (!face && !bold && !italic)
331         face = m_fonts.get(hashForFont(family, true, true));
332 #endif
333
334     // If no face was found, then return 0 and let the OS come up with its best match for the name.
335     if (!face) {
336         // If we were handed a generic family, but there was no match, go ahead and return the correct font based off our
337         // settings.
338         const Settings* settings = m_document->frame()->settings();
339         AtomicString genericFamily;
340         if (familyName == "-webkit-serif")
341             genericFamily = settings->serifFontFamily();
342         else if (familyName == "-webkit-sans-serif")
343             genericFamily = settings->sansSerifFontFamily();
344         else if (familyName == "-webkit-cursive")
345             genericFamily = settings->cursiveFontFamily();
346         else if (familyName == "-webkit-fantasy")
347             genericFamily = settings->fantasyFontFamily();
348         else if (familyName == "-webkit-monospace")
349             genericFamily = settings->fixedFontFamily();
350         else if (familyName == "-webkit-standard")
351             genericFamily = settings->standardFontFamily();
352         
353         if (!genericFamily.isEmpty())
354             return FontCache::getCachedFontData(FontCache::getCachedFontPlatformData(fontDescription, genericFamily));
355         return 0;
356     }
357
358     // We have a face.  Ask it for a font data.  If it cannot produce one, it will fail, and the OS will take over.
359     return face->getFontData(fontDescription, syntheticBold, syntheticItalic);
360 }
361
362 }