8e4274dd0cb3c3d58051b7e7cbeb09b77cfa9269
[WebKit.git] / Source / WebCore / svg / SVGFontElement.h
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 #ifndef SVGFontElement_h
23 #define SVGFontElement_h
24
25 #if ENABLE(SVG_FONTS)
26 #include "SVGAnimatedBoolean.h"
27 #include "SVGElement.h"
28 #include "SVGExternalResourcesRequired.h"
29 #include "SVGGlyphMap.h"
30 #include "SVGParserUtilities.h"
31
32 namespace WebCore {
33
34 // Describe an SVG <hkern>/<vkern> element already matched on the first symbol.
35 struct SVGKerning {
36     float kerning;
37     UnicodeRanges unicodeRange2;
38     HashSet<String> unicodeName2;
39     HashSet<String> glyphName2;
40
41     SVGKerning()
42         : kerning(0)
43     { }
44 };
45
46 // Describe an SVG <hkern>/<vkern> element
47 struct SVGKerningPair : public SVGKerning {
48     UnicodeRanges unicodeRange1;
49     HashSet<String> unicodeName1;
50     HashSet<String> glyphName1;
51 };
52
53 typedef Vector<SVGKerning> SVGKerningVector;
54
55 struct SVGKerningMap {
56     HashMap<String, std::unique_ptr<SVGKerningVector>> unicodeMap;
57     HashMap<String, std::unique_ptr<SVGKerningVector>> glyphMap;
58     Vector<SVGKerningPair> kerningUnicodeRangeMap;
59
60     bool isEmpty() const { return unicodeMap.isEmpty() && glyphMap.isEmpty() && kerningUnicodeRangeMap.isEmpty(); }
61     void clear();
62     void insert(const SVGKerningPair&);
63 };
64
65 class SVGMissingGlyphElement;
66
67 class SVGFontElement final : public SVGElement
68                            , public SVGExternalResourcesRequired {
69 public:
70     static PassRefPtr<SVGFontElement> create(const QualifiedName&, Document&);
71
72     void invalidateGlyphCache();
73     void collectGlyphsForString(const String&, Vector<SVGGlyph>&);
74     void collectGlyphsForGlyphName(const String&, Vector<SVGGlyph>&);
75
76     float horizontalKerningForPairOfStringsAndGlyphs(const String& u1, const String& g1, const String& u2, const String& g2) const;
77     float verticalKerningForPairOfStringsAndGlyphs(const String& u1, const String& g1, const String& u2, const String& g2) const;
78
79     // Used by SimpleFontData/WidthIterator.
80     SVGGlyph svgGlyphForGlyph(Glyph);
81     Glyph missingGlyph();
82
83     const SVGMissingGlyphElement* firstMissingGlyphElement() const;
84     bool horizontalKerningMapIsEmpty() const { return m_horizontalKerningMap.isEmpty(); }
85
86 private:
87     SVGFontElement(const QualifiedName&, Document&);
88
89     virtual bool rendererIsNeeded(const RenderStyle&) override { return false; }
90
91     void ensureGlyphCache();
92     void registerLigaturesInGlyphCache(Vector<String>&);
93
94     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGFontElement)
95         DECLARE_ANIMATED_BOOLEAN(ExternalResourcesRequired, externalResourcesRequired)
96     END_DECLARE_ANIMATED_PROPERTIES
97
98     SVGKerningMap m_horizontalKerningMap;
99     SVGKerningMap m_verticalKerningMap;
100     SVGGlyphMap m_glyphMap;
101     Glyph m_missingGlyph;
102     bool m_isGlyphCacheValid;
103 };
104
105 NODE_TYPE_CASTS(SVGFontElement)
106
107 } // namespace WebCore
108
109 #endif // ENABLE(SVG_FONTS)
110 #endif