610475269d8db8f5da7f55f118c73fd3626d329c
[WebKit-https.git] / Source / WebCore / svg / SVGFontData.cpp
1 /*
2  * Copyright (C) 2008 Nikolas Zimmermann <zimmermann@kde.org>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #include "config.h"
21
22 #if ENABLE(SVG_FONTS)
23 #include "SVGFontData.h"
24
25 #include "GlyphPage.h"
26 #include "RenderElement.h"
27 #include "SVGAltGlyphElement.h"
28 #include "SVGFontElement.h"
29 #include "SVGFontFaceElement.h"
30 #include "SVGGlyph.h"
31 #include "SVGGlyphElement.h"
32 #include "SVGNames.h"
33 #include "SVGTextRunRenderingContext.h"
34 #include "TextRun.h"
35 #include "WidthIterator.h"
36 #include "XMLNames.h"
37 #include <wtf/text/StringBuilder.h>
38 #include <wtf/unicode/CharacterNames.h>
39
40 using namespace WTF;
41 using namespace Unicode;
42
43 namespace WebCore {
44
45 static String createStringWithMirroredCharacters(StringView);
46 static void computeNormalizedSpaces(const TextRun&, bool mirror, String& normalizedSpacesStringCache);
47
48 SVGFontData::SVGFontData(SVGFontFaceElement* fontFaceElement)
49     : m_svgFontFaceElement(fontFaceElement)
50     , m_horizontalOriginX(fontFaceElement->horizontalOriginX())
51     , m_horizontalOriginY(fontFaceElement->horizontalOriginY())
52     , m_horizontalAdvanceX(fontFaceElement->horizontalAdvanceX())
53     , m_verticalOriginX(fontFaceElement->verticalOriginX())
54     , m_verticalOriginY(fontFaceElement->verticalOriginY())
55     , m_verticalAdvanceY(fontFaceElement->verticalAdvanceY())
56 {
57     ASSERT_ARG(fontFaceElement, fontFaceElement);
58 }
59
60 void SVGFontData::initializeFont(Font* font, float fontSize)
61 {
62     ASSERT(font);
63
64     SVGFontFaceElement* svgFontFaceElement = this->svgFontFaceElement();
65     ASSERT(svgFontFaceElement);
66
67     font->setZeroWidthSpaceGlyph(0);
68     font->determinePitch();
69
70     unsigned unitsPerEm = svgFontFaceElement->unitsPerEm();
71     float scale = scaleEmToUnits(fontSize, unitsPerEm);
72     float xHeight = svgFontFaceElement->xHeight() * scale;
73     float ascent = svgFontFaceElement->ascent() * scale;
74     float descent = svgFontFaceElement->descent() * scale;
75     float lineGap = 0.1f * fontSize;
76
77     const GlyphPage* glyphPageZero = font->glyphPage(0);
78
79     if (!xHeight && glyphPageZero) {
80         // Fallback if x_heightAttr is not specified for the font element.
81         Glyph letterXGlyph = glyphPageZero->glyphDataForCharacter('x').glyph;
82         xHeight = letterXGlyph ? font->widthForGlyph(letterXGlyph) : 2 * ascent / 3;
83     }
84
85     FontMetrics& fontMetrics = font->fontMetrics();
86     fontMetrics.setUnitsPerEm(unitsPerEm);
87     fontMetrics.setAscent(ascent);
88     fontMetrics.setDescent(descent);
89     fontMetrics.setLineGap(lineGap);
90     fontMetrics.setLineSpacing(roundf(ascent) + roundf(descent) + roundf(lineGap));
91     fontMetrics.setXHeight(xHeight);
92
93     if (!glyphPageZero) {
94         font->setSpaceGlyph(0);
95         font->setSpaceWidths(0);
96         font->setAvgCharWidth(0);
97         font->setMaxCharWidth(ascent);
98         return;
99     }
100
101     // Calculate space width.
102     Glyph spaceGlyph = glyphPageZero->glyphDataForCharacter(' ').glyph;
103     font->setSpaceGlyph(spaceGlyph);
104     font->setSpaceWidths(font->widthForGlyph(spaceGlyph));
105
106     // Estimate average character width.
107     Glyph numeralZeroGlyph = glyphPageZero->glyphDataForCharacter('0').glyph;
108     font->setAvgCharWidth(numeralZeroGlyph ? font->widthForGlyph(numeralZeroGlyph) : font->spaceWidth());
109
110     // Estimate maximum character width.
111     Glyph letterWGlyph = glyphPageZero->glyphDataForCharacter('W').glyph;
112     font->setMaxCharWidth(letterWGlyph ? font->widthForGlyph(letterWGlyph) : ascent);
113 }
114
115 float SVGFontData::widthForSVGGlyph(Glyph glyph, float fontSize) const
116 {
117     SVGFontFaceElement* svgFontFaceElement = this->svgFontFaceElement();
118     ASSERT(svgFontFaceElement);
119
120     SVGFontElement* associatedFontElement = svgFontFaceElement->associatedFontElement();
121     ASSERT(associatedFontElement);
122
123     SVGGlyph svgGlyph = associatedFontElement->svgGlyphForGlyph(glyph);
124     SVGGlyphElement::inheritUnspecifiedAttributes(svgGlyph, this);
125     return svgGlyph.horizontalAdvanceX * scaleEmToUnits(fontSize, svgFontFaceElement->unitsPerEm());
126 }
127
128 bool SVGFontData::applySVGGlyphSelection(WidthIterator& iterator, GlyphData& glyphData, bool mirror, int currentCharacter, unsigned& advanceLength, String& normalizedSpacesStringCache) const
129 {
130     const TextRun& run = iterator.run();
131     Vector<SVGGlyph::ArabicForm>& arabicForms = iterator.arabicForms();
132     ASSERT(run.charactersLength() >= static_cast<unsigned>(currentCharacter));
133
134     SVGFontFaceElement* svgFontFaceElement = this->svgFontFaceElement();
135     ASSERT(svgFontFaceElement);
136
137     SVGFontElement* associatedFontElement = svgFontFaceElement->associatedFontElement();
138     ASSERT(associatedFontElement);
139
140     RenderObject* renderObject = nullptr;
141     if (TextRun::RenderingContext* renderingContext = run.renderingContext())
142         renderObject = &static_cast<SVGTextRunRenderingContext*>(renderingContext)->renderer();
143
144     String language;
145     bool isVerticalText = false;
146     Vector<String> altGlyphNames;
147
148     if (renderObject) {
149         RenderElement& parentRenderer = is<RenderElement>(*renderObject) ? downcast<RenderElement>(*renderObject) : *renderObject->parent();
150
151         isVerticalText = parentRenderer.style().svgStyle().isVerticalWritingMode();
152         if (Element* parentRendererElement = parentRenderer.element()) {
153             language = parentRendererElement->getAttribute(XMLNames::langAttr);
154
155             if (is<SVGAltGlyphElement>(*parentRendererElement)) {
156                 SVGAltGlyphElement& altGlyph = downcast<SVGAltGlyphElement>(*parentRendererElement);
157                 if (!altGlyph.hasValidGlyphElements(altGlyphNames))
158                     altGlyphNames.clear();
159             }
160         }
161     }
162
163     Vector<SVGGlyph> glyphs;
164     if (!altGlyphNames.isEmpty()) {
165         for (auto& name : altGlyphNames)
166             associatedFontElement->collectGlyphsForGlyphName(name, glyphs);
167
168         // Assign the unicodeStringLength now that its known.
169         for (auto& glyph : glyphs)
170             glyph.unicodeStringLength = run.length();
171
172         // Do not check alt glyphs for compatibility. Just return the first one.
173         // Later code will fail if we do not do this and the glyph is incompatible.
174         if (!glyphs.isEmpty()) {
175             SVGGlyph& svgGlyph = glyphs[0];
176             iterator.setLastGlyphName(svgGlyph.glyphName);
177             glyphData.glyph = svgGlyph.tableEntry;
178             advanceLength = svgGlyph.unicodeStringLength;
179             return true;
180         }
181     } else {
182         // Associate text with arabic forms, if needed.
183         computeNormalizedSpaces(run, mirror, normalizedSpacesStringCache);
184         auto remainingTextInRun = normalizedSpacesStringCache.substring(currentCharacter);
185
186         if (!currentCharacter && arabicForms.isEmpty())
187             arabicForms = charactersWithArabicForm(remainingTextInRun, mirror);
188
189         associatedFontElement->collectGlyphsForString(remainingTextInRun, glyphs);
190     }
191
192     for (auto& glyph : glyphs) {
193         if (glyph.isPartOfLigature)
194             continue;
195         if (!isCompatibleGlyph(glyph, isVerticalText, language, arabicForms, currentCharacter, currentCharacter + glyph.unicodeStringLength))
196             continue;
197         iterator.setLastGlyphName(glyph.glyphName);
198         glyphData.glyph = glyph.tableEntry;
199         advanceLength = glyph.unicodeStringLength;
200         return true;
201     }
202
203     iterator.setLastGlyphName(String());
204     return false;
205 }
206
207 bool SVGFontData::fillSVGGlyphPage(GlyphPage* pageToFill, unsigned offset, unsigned length, UChar* buffer, unsigned bufferLength, const Font* font) const
208 {
209     ASSERT(font->isCustomFont());
210     ASSERT(font->isSVGFont());
211
212     SVGFontFaceElement* fontFaceElement = this->svgFontFaceElement();
213     ASSERT(fontFaceElement);
214
215     SVGFontElement* fontElement = fontFaceElement->associatedFontElement();
216     ASSERT(fontElement);
217
218     if (bufferLength == length)
219         return fillBMPGlyphs(fontElement, pageToFill, offset, length, buffer, font);
220
221     ASSERT(bufferLength == 2 * length);
222     return fillNonBMPGlyphs(fontElement, pageToFill, offset, length, buffer, font);
223 }
224
225 bool SVGFontData::fillBMPGlyphs(SVGFontElement* fontElement, GlyphPage* pageToFill, unsigned offset, unsigned length, UChar* buffer, const Font* font) const
226 {
227     bool haveGlyphs = false;
228     Vector<SVGGlyph> glyphs;
229     for (unsigned i = 0; i < length; ++i) {
230         String lookupString(buffer + i, 1);
231         fontElement->collectGlyphsForString(lookupString, glyphs);
232         if (glyphs.isEmpty()) {
233             pageToFill->setGlyphDataForIndex(offset + i, 0, 0);
234             continue;
235         }
236
237         // Associate entry in glyph page with first valid SVGGlyph.
238         // If there are multiple valid ones, just take the first one. WidthIterator will take
239         // care of matching to the correct glyph, if multiple ones are available, as that's
240         // only possible within the context of a string (eg. arabic form matching).
241         haveGlyphs = true;
242         pageToFill->setGlyphDataForIndex(offset + i, glyphs.first().tableEntry, font);
243         glyphs.clear();
244     }
245
246     return haveGlyphs;
247 }
248
249 bool SVGFontData::fillNonBMPGlyphs(SVGFontElement* fontElement, GlyphPage* pageToFill, unsigned offset, unsigned length, UChar* buffer, const Font* font) const
250 {
251     bool haveGlyphs = false;
252     Vector<SVGGlyph> glyphs;
253     for (unsigned i = 0; i < length; ++i) {
254         // Each character here consists of a surrogate pair
255         String lookupString(buffer + i * 2, 2);
256         fontElement->collectGlyphsForString(lookupString, glyphs);
257         if (glyphs.isEmpty()) {
258             pageToFill->setGlyphDataForIndex(offset + i, 0, 0);
259             continue;
260         }
261
262         // Associate entry in glyph page with first valid SVGGlyph.
263         // If there are multiple valid ones, just take the first one. WidthIterator will take
264         // care of matching to the correct glyph, if multiple ones are available, as that's
265         // only possible within the context of a string (eg. arabic form matching).
266         haveGlyphs = true;
267         pageToFill->setGlyphDataForIndex(offset + i, glyphs.first().tableEntry, font);
268         glyphs.clear();
269     }
270
271     return haveGlyphs;
272 }
273
274 void computeNormalizedSpaces(const TextRun& run, bool mirror, String& normalizedSpacesStringCache)
275 {
276     if (normalizedSpacesStringCache.length() == static_cast<unsigned>(run.charactersLength()))
277         return;
278     if (run.is8Bit())
279         normalizedSpacesStringCache = FontCascade::normalizeSpaces(run.characters8(), run.charactersLength());
280     else
281         normalizedSpacesStringCache = FontCascade::normalizeSpaces(run.characters16(), run.charactersLength());
282     if (mirror)
283         normalizedSpacesStringCache = createStringWithMirroredCharacters(normalizedSpacesStringCache);
284 }
285
286 String createStringWithMirroredCharacters(StringView string)
287 {
288     unsigned length = string.length();
289     StringBuilder mirroredCharacters;
290     mirroredCharacters.reserveCapacity(length);
291     for (unsigned i = 0; i < length; ) {
292         UChar32 character;
293         U16_NEXT(string, i, length, character);
294         mirroredCharacters.append(u_charMirror(character));
295     }
296     return mirroredCharacters.toString();
297 }
298
299 } // namespace WebCore
300
301 #endif