2015-09-09 Geoffrey Garen <ggaren@apple.com>
[WebKit-https.git] / Source / WebCore / platform / graphics / WidthIterator.h
1 /*
2  * Copyright (C) 2003, 2006, 2008, 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Holger Hans Peter Freyther
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #ifndef WidthIterator_h
23 #define WidthIterator_h
24
25 #include "FontCascade.h"
26 #include "SVGGlyph.h"
27 #include "TextRun.h"
28 #include <wtf/HashSet.h>
29 #include <wtf/Vector.h>
30
31 namespace WebCore {
32
33 class FontCascade;
34 class GlyphBuffer;
35 class Font;
36 class TextRun;
37 struct GlyphData;
38
39 struct WidthIterator {
40     WTF_MAKE_FAST_ALLOCATED;
41 public:
42     WidthIterator(const FontCascade*, const TextRun&, HashSet<const Font*>* fallbackFonts = 0, bool accountForGlyphBounds = false, bool forTextEmphasis = false);
43
44     unsigned advance(int to, GlyphBuffer*);
45     bool advanceOneCharacter(float& width, GlyphBuffer&);
46
47     float maxGlyphBoundingBoxY() const { ASSERT(m_accountForGlyphBounds); return m_maxGlyphBoundingBoxY; }
48     float minGlyphBoundingBoxY() const { ASSERT(m_accountForGlyphBounds); return m_minGlyphBoundingBoxY; }
49     float firstGlyphOverflow() const { ASSERT(m_accountForGlyphBounds); return m_firstGlyphOverflow; }
50     float lastGlyphOverflow() const { ASSERT(m_accountForGlyphBounds); return m_lastGlyphOverflow; }
51
52     const TextRun& run() const { return m_run; }
53     float runWidthSoFar() const { return m_runWidthSoFar; }
54
55 #if ENABLE(SVG_FONTS)
56     String lastGlyphName() const { return m_lastGlyphName; }
57     void setLastGlyphName(const String& name) { m_lastGlyphName = name; }
58     Vector<SVGGlyph::ArabicForm>& arabicForms() { return m_arabicForms; }
59 #endif
60
61     static bool supportsTypesettingFeatures(const FontCascade& font)
62     {
63 #if PLATFORM(COCOA)
64         return !(font.typesettingFeatures() & ~(Kerning | Ligatures));
65 #else
66         return !font.typesettingFeatures();
67 #endif
68     }
69
70     const FontCascade* m_font;
71
72     const TextRun& m_run;
73
74     unsigned m_currentCharacter;
75     float m_runWidthSoFar;
76     float m_expansion;
77     float m_expansionPerOpportunity;
78     bool m_isAfterExpansion;
79     float m_finalRoundingWidth;
80
81 #if ENABLE(SVG_FONTS)
82     String m_lastGlyphName;
83     Vector<SVGGlyph::ArabicForm> m_arabicForms;
84 #endif
85
86 private:
87     GlyphData glyphDataForCharacter(UChar32, bool mirror, int currentCharacter, unsigned& advanceLength, String& normalizedSpacesStringCache);
88     template <typename TextIterator>
89     inline unsigned advanceInternal(TextIterator&, GlyphBuffer*);
90
91     enum class TransformsType { None, Forced, NotForced };
92     TransformsType shouldApplyFontTransforms(const GlyphBuffer*, int lastGlyphCount, UChar32 previousCharacter) const;
93
94     TypesettingFeatures m_typesettingFeatures;
95     HashSet<const Font*>* m_fallbackFonts;
96     bool m_accountForGlyphBounds;
97     float m_maxGlyphBoundingBoxY;
98     float m_minGlyphBoundingBoxY;
99     float m_firstGlyphOverflow;
100     float m_lastGlyphOverflow;
101     bool m_forTextEmphasis;
102 };
103
104 }
105
106 #endif