0681a67c46cf9a3f48abc395d1a1e8ac0a086cef
[WebKit-https.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 "SVGNames.h"
31 #include "SVGParserUtilities.h"
32
33 namespace WebCore {
34
35 // Describe an SVG <hkern>/<vkern> element
36 struct SVGKerningPair {
37     float kerning;
38     UnicodeRanges unicodeRange1;
39     UnicodeRanges unicodeRange2;
40     HashSet<String> unicodeName1;
41     HashSet<String> unicodeName2;
42     HashSet<String> glyphName1;
43     HashSet<String> glyphName2;
44     
45     SVGKerningPair()
46         : kerning(0)
47     {
48     }
49 };
50
51 typedef Vector<SVGKerningPair> KerningPairVector;
52
53 class SVGMissingGlyphElement;    
54
55 class SVGFontElement FINAL : public SVGElement
56                            , public SVGExternalResourcesRequired {
57 public:
58     static PassRefPtr<SVGFontElement> create(const QualifiedName&, Document*);
59
60     void invalidateGlyphCache();
61     void collectGlyphsForString(const String&, Vector<SVGGlyph>&);
62     void collectGlyphsForGlyphName(const String&, Vector<SVGGlyph>&);
63
64     float horizontalKerningForPairOfStringsAndGlyphs(const String& u1, const String& g1, const String& u2, const String& g2) const;
65     float verticalKerningForPairOfStringsAndGlyphs(const String& u1, const String& g1, const String& u2, const String& g2) const;
66
67     // Used by SimpleFontData/WidthIterator.
68     SVGGlyph svgGlyphForGlyph(Glyph);
69     Glyph missingGlyph();
70
71     SVGMissingGlyphElement* firstMissingGlyphElement() const;
72
73 private:
74     SVGFontElement(const QualifiedName&, Document*);
75
76     virtual bool rendererIsNeeded(const RenderStyle&) { return false; }  
77
78     void ensureGlyphCache();
79     void registerLigaturesInGlyphCache(Vector<String>&);
80
81     BEGIN_DECLARE_ANIMATED_PROPERTIES(SVGFontElement)
82         DECLARE_ANIMATED_BOOLEAN(ExternalResourcesRequired, externalResourcesRequired)
83     END_DECLARE_ANIMATED_PROPERTIES
84
85     KerningPairVector m_horizontalKerningPairs;
86     KerningPairVector m_verticalKerningPairs;
87     SVGGlyphMap m_glyphMap;
88     Glyph m_missingGlyph;
89     bool m_isGlyphCacheValid;
90 };
91
92 inline SVGFontElement* toSVGFontElement(Node* node)
93 {
94     ASSERT_WITH_SECURITY_IMPLICATION(!node || isSVGFontElement(node));
95     return static_cast<SVGFontElement*>(node);
96 }
97
98 } // namespace WebCore
99
100 #endif // ENABLE(SVG_FONTS)
101 #endif