Generate more SVG type checks and conversions.
[WebKit-https.git] / Source / WebCore / svg / SVGFontElement.cpp
1 /*
2  * Copyright (C) 2007 Eric Seidel <eric@webkit.org>
3  * Copyright (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
4  * Copyright (C) Research In Motion Limited 2010. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #include "config.h"
23
24 #if ENABLE(SVG_FONTS)
25 #include "SVGFontElement.h"
26
27 #include "Document.h"
28 #include "ElementIterator.h"
29 #include "Font.h"
30 #include "GlyphPageTreeNode.h"
31 #include "SVGGlyphElement.h"
32 #include "SVGHKernElement.h"
33 #include "SVGMissingGlyphElement.h"
34 #include "SVGNames.h"
35 #include "SVGVKernElement.h"
36 #include <wtf/ASCIICType.h>
37
38 namespace WebCore {
39
40 // Animated property definitions
41 DEFINE_ANIMATED_BOOLEAN(SVGFontElement, SVGNames::externalResourcesRequiredAttr, ExternalResourcesRequired, externalResourcesRequired)
42
43 BEGIN_REGISTER_ANIMATED_PROPERTIES(SVGFontElement)
44     REGISTER_LOCAL_ANIMATED_PROPERTY(externalResourcesRequired)
45     REGISTER_PARENT_ANIMATED_PROPERTIES(SVGElement)
46 END_REGISTER_ANIMATED_PROPERTIES
47
48 inline SVGFontElement::SVGFontElement(const QualifiedName& tagName, Document* document)
49     : SVGElement(tagName, document) 
50     , m_missingGlyph(0)
51     , m_isGlyphCacheValid(false)
52 {
53     ASSERT(hasTagName(SVGNames::fontTag));
54     registerAnimatedPropertiesForSVGFontElement();
55 }
56
57 PassRefPtr<SVGFontElement> SVGFontElement::create(const QualifiedName& tagName, Document* document)
58 {
59     return adoptRef(new SVGFontElement(tagName, document));
60 }
61
62 void SVGFontElement::invalidateGlyphCache()
63 {
64     if (m_isGlyphCacheValid) {
65         m_glyphMap.clear();
66         m_horizontalKerningPairs.clear();
67         m_verticalKerningPairs.clear();
68     }
69     m_isGlyphCacheValid = false;
70 }
71
72 SVGMissingGlyphElement* SVGFontElement::firstMissingGlyphElement() const
73 {
74     for (Node* child = firstChild(); child; child = child->nextSibling()) {
75         if (child->hasTagName(SVGNames::missing_glyphTag))
76             return toSVGMissingGlyphElement(child);
77     }
78
79     return 0;
80 }
81
82 void SVGFontElement::registerLigaturesInGlyphCache(Vector<String>& ligatures)
83 {
84     ASSERT(!ligatures.isEmpty());
85
86     // Register each character of a ligature in the map, if not present.
87     // Eg. If only a "fi" ligature is present, but not "f" and "i", the
88     // GlyphPage will not contain any entries for "f" and "i", so the
89     // SVGFont is not used to render the text "fi1234". Register an
90     // empty SVGGlyph with the character, so the SVG Font will be used
91     // to render the text. If someone tries to render "f2" the SVG Font
92     // will not be able to find a glyph for "f", but handles the fallback
93     // character substitution properly through glyphDataForCharacter().
94     Vector<SVGGlyph> glyphs;
95     size_t ligaturesSize = ligatures.size();
96     for (size_t i = 0; i < ligaturesSize; ++i) {
97         const String& unicode = ligatures[i];
98
99         unsigned unicodeLength = unicode.length();
100         ASSERT(unicodeLength > 1);
101
102         const UChar* characters = unicode.characters();
103         for (unsigned i = 0; i < unicodeLength; ++i) {
104             String lookupString(characters + i, 1);
105             m_glyphMap.collectGlyphsForString(lookupString, glyphs);
106             if (!glyphs.isEmpty()) {
107                 glyphs.clear();
108                 continue;
109             }
110                 
111             // This glyph is never meant to be used for rendering, only as identifier as a part of a ligature.
112             SVGGlyph newGlyphPart;
113             newGlyphPart.isPartOfLigature = true;
114             m_glyphMap.addGlyph(String(), lookupString, newGlyphPart);
115         }
116     }
117 }
118
119 void SVGFontElement::ensureGlyphCache()
120 {
121     if (m_isGlyphCacheValid)
122         return;
123
124     SVGMissingGlyphElement* firstMissingGlyphElement = 0;
125     Vector<String> ligatures;
126     for (auto child = childrenOfType<SVGElement>(this).begin(), end = childrenOfType<SVGElement>(this).end(); child != end; ++child) {
127         SVGElement* element = &*child;
128         if (isSVGGlyphElement(element)) {
129             SVGGlyphElement* glyph = toSVGGlyphElement(element);
130             AtomicString unicode = glyph->fastGetAttribute(SVGNames::unicodeAttr);
131             AtomicString glyphId = glyph->getIdAttribute();
132             if (glyphId.isEmpty() && unicode.isEmpty())
133                 continue;
134
135             m_glyphMap.addGlyph(glyphId, unicode, glyph->buildGlyphIdentifier());
136
137             // Register ligatures, if needed, don't mix up with surrogate pairs though!
138             if (unicode.length() > 1 && !U16_IS_SURROGATE(unicode[0]))
139                 ligatures.append(unicode.string());
140         } else if (isSVGHKernElement(element)) {
141             SVGHKernElement* hkern = toSVGHKernElement(element);
142             hkern->buildHorizontalKerningPair(m_horizontalKerningPairs);
143         } else if (isSVGVKernElement(element)) {
144             SVGVKernElement* vkern = toSVGVKernElement(element);
145             vkern->buildVerticalKerningPair(m_verticalKerningPairs);
146         } else if (isSVGMissingGlyphElement(element) && !firstMissingGlyphElement)
147             firstMissingGlyphElement = toSVGMissingGlyphElement(element);
148     }
149
150     // Register each character of each ligature, if needed.
151     if (!ligatures.isEmpty())
152         registerLigaturesInGlyphCache(ligatures);
153
154     // Register missing-glyph element, if present.
155     if (firstMissingGlyphElement) {
156         SVGGlyph svgGlyph = SVGGlyphElement::buildGenericGlyphIdentifier(firstMissingGlyphElement);
157         m_glyphMap.appendToGlyphTable(svgGlyph);
158         m_missingGlyph = svgGlyph.tableEntry;
159         ASSERT(m_missingGlyph > 0);
160     }
161
162     m_isGlyphCacheValid = true;
163 }
164
165 static bool stringMatchesUnicodeRange(const String& unicodeString, const UnicodeRanges& ranges, const HashSet<String>& unicodeValues)
166 {
167     if (unicodeString.isEmpty())
168         return false;
169
170     if (!ranges.isEmpty()) {
171         UChar firstChar = unicodeString[0];
172         const UnicodeRanges::const_iterator end = ranges.end();
173         for (UnicodeRanges::const_iterator it = ranges.begin(); it != end; ++it) {
174             if (firstChar >= it->first && firstChar <= it->second)
175                 return true;
176         }
177     }
178
179     if (!unicodeValues.isEmpty())
180         return unicodeValues.contains(unicodeString);
181     
182     return false;
183 }
184
185 static bool stringMatchesGlyphName(const String& glyphName, const HashSet<String>& glyphValues)
186 {
187     if (glyphName.isEmpty())
188         return false;
189
190     if (!glyphValues.isEmpty())
191         return glyphValues.contains(glyphName);
192     
193     return false;
194 }
195
196 static bool matches(const String& u1, const String& g1, const String& u2, const String& g2, const SVGKerningPair& kerningPair)
197 {
198     if (!stringMatchesUnicodeRange(u1, kerningPair.unicodeRange1, kerningPair.unicodeName1)
199         && !stringMatchesGlyphName(g1, kerningPair.glyphName1))
200         return false;
201
202     if (!stringMatchesUnicodeRange(u2, kerningPair.unicodeRange2, kerningPair.unicodeName2)
203         && !stringMatchesGlyphName(g2, kerningPair.glyphName2))
204         return false;
205
206     return true;
207 }
208
209 static float kerningForPairOfStringsAndGlyphs(const KerningPairVector& kerningPairs, const String& u1, const String& g1, const String& u2, const String& g2)
210 {
211     KerningPairVector::const_iterator it = kerningPairs.end() - 1;
212     const KerningPairVector::const_iterator begin = kerningPairs.begin() - 1;
213     for (; it != begin; --it) {
214         if (matches(u1, g1, u2, g2, *it))
215             return it->kerning;
216     }
217
218     return 0;
219 }
220     
221 float SVGFontElement::horizontalKerningForPairOfStringsAndGlyphs(const String& u1, const String& g1, const String& u2, const String& g2) const
222 {
223     if (m_horizontalKerningPairs.isEmpty())
224         return 0;
225
226     return kerningForPairOfStringsAndGlyphs(m_horizontalKerningPairs, u1, g1, u2, g2);
227 }
228
229 float SVGFontElement::verticalKerningForPairOfStringsAndGlyphs(const String& u1, const String& g1, const String& u2, const String& g2) const
230 {
231     if (m_verticalKerningPairs.isEmpty())
232         return 0;
233
234     return kerningForPairOfStringsAndGlyphs(m_verticalKerningPairs, u1, g1, u2, g2);
235 }
236
237 void SVGFontElement::collectGlyphsForString(const String& string, Vector<SVGGlyph>& glyphs)
238 {
239     ensureGlyphCache();
240     m_glyphMap.collectGlyphsForString(string, glyphs);
241 }
242
243 void SVGFontElement::collectGlyphsForGlyphName(const String& glyphName, Vector<SVGGlyph>& glyphs)
244 {
245     ensureGlyphCache();
246     // FIXME: We only support glyphName -> single glyph mapping so far.
247     glyphs.append(m_glyphMap.glyphIdentifierForGlyphName(glyphName));
248 }
249
250 SVGGlyph SVGFontElement::svgGlyphForGlyph(Glyph glyph)
251 {
252     ensureGlyphCache();
253     return m_glyphMap.svgGlyphForGlyph(glyph);
254 }
255     
256 Glyph SVGFontElement::missingGlyph()
257 {
258     ensureGlyphCache();
259     return m_missingGlyph;
260 }
261
262 }
263
264 #endif // ENABLE(SVG_FONTS)