65194f0120a5f9d9a9b54fa4dcaea3f9c2512c0f
[WebKit-https.git] / Source / WebCore / platform / graphics / SimpleFontData.cpp
1 /*
2  * Copyright (C) 2005, 2008, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2006 Alexey Proskuryakov
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #include "config.h"
31 #include "SimpleFontData.h"
32
33 #include "Font.h"
34 #include "FontCache.h"
35 #include "OpenTypeVerticalData.h"
36
37 #include <wtf/MathExtras.h>
38 #include <wtf/UnusedParam.h>
39
40 using namespace std;
41
42 namespace WebCore {
43
44 const float smallCapsFontSizeMultiplier = 0.7f;
45 const float emphasisMarkFontSizeMultiplier = 0.5f;
46
47 SimpleFontData::SimpleFontData(const FontPlatformData& platformData, bool isCustomFont, bool isLoading, bool isTextOrientationFallback)
48     : m_maxCharWidth(-1)
49     , m_avgCharWidth(-1)
50     , m_platformData(platformData)
51     , m_treatAsFixedPitch(false)
52     , m_isCustomFont(isCustomFont)
53     , m_isLoading(isLoading)
54     , m_isTextOrientationFallback(isTextOrientationFallback)
55     , m_isBrokenIdeographFallback(false)
56 #if ENABLE(OPENTYPE_VERTICAL)
57     , m_verticalData(0)
58 #endif
59     , m_hasVerticalGlyphs(false)
60 {
61     platformInit();
62     platformGlyphInit();
63     platformCharWidthInit();
64 #if ENABLE(OPENTYPE_VERTICAL)
65     if (platformData.orientation() == Vertical && !isTextOrientationFallback) {
66         m_verticalData = platformData.verticalData();
67         m_hasVerticalGlyphs = m_verticalData.get() && m_verticalData->hasVerticalMetrics();
68     }
69 #endif
70 }
71
72 SimpleFontData::SimpleFontData(PassOwnPtr<AdditionalFontData> fontData, float fontSize, bool syntheticBold, bool syntheticItalic)
73     : m_platformData(FontPlatformData(fontSize, syntheticBold, syntheticItalic))
74     , m_fontData(fontData)
75     , m_treatAsFixedPitch(false)
76     , m_isCustomFont(true)
77     , m_isLoading(false)
78     , m_isTextOrientationFallback(false)
79     , m_isBrokenIdeographFallback(false)
80 #if ENABLE(OPENTYPE_VERTICAL)
81     , m_verticalData(0)
82 #endif
83     , m_hasVerticalGlyphs(false)
84 {
85     m_fontData->initializeFontData(this, fontSize);
86 }
87
88 // Estimates of avgCharWidth and maxCharWidth for platforms that don't support accessing these values from the font.
89 void SimpleFontData::initCharWidths()
90 {
91     GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
92
93     // Treat the width of a '0' as the avgCharWidth.
94     if (m_avgCharWidth <= 0.f && glyphPageZero) {
95         static const UChar32 digitZeroChar = '0';
96         Glyph digitZeroGlyph = glyphPageZero->glyphDataForCharacter(digitZeroChar).glyph;
97         if (digitZeroGlyph)
98             m_avgCharWidth = widthForGlyph(digitZeroGlyph);
99     }
100
101     // If we can't retrieve the width of a '0', fall back to the x height.
102     if (m_avgCharWidth <= 0.f)
103         m_avgCharWidth = m_fontMetrics.xHeight();
104
105     if (m_maxCharWidth <= 0.f)
106         m_maxCharWidth = max(m_avgCharWidth, m_fontMetrics.floatAscent());
107 }
108
109 void SimpleFontData::platformGlyphInit()
110 {
111     GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
112     if (!glyphPageZero) {
113         LOG_ERROR("Failed to get glyph page zero.");
114         m_spaceGlyph = 0;
115         m_spaceWidth = 0;
116         m_adjustedSpaceWidth = 0;
117         determinePitch();
118         m_zeroWidthSpaceGlyph = 0;
119         m_missingGlyphData.fontData = this;
120         m_missingGlyphData.glyph = 0;
121         return;
122     }
123
124     m_zeroWidthSpaceGlyph = glyphPageZero->glyphDataForCharacter(0).glyph;
125
126     // Nasty hack to determine if we should round or ceil space widths.
127     // If the font is monospace or fake monospace we ceil to ensure that 
128     // every character and the space are the same width.  Otherwise we round.
129     m_spaceGlyph = glyphPageZero->glyphDataForCharacter(' ').glyph;
130     float width = widthForGlyph(m_spaceGlyph);
131     m_spaceWidth = width;
132     determinePitch();
133     m_adjustedSpaceWidth = m_treatAsFixedPitch ? ceilf(width) : roundf(width);
134
135     // Force the glyph for ZERO WIDTH SPACE to have zero width, unless it is shared with SPACE.
136     // Helvetica is an example of a non-zero width ZERO WIDTH SPACE glyph.
137     // See <http://bugs.webkit.org/show_bug.cgi?id=13178>
138     // Ask for the glyph for 0 to avoid paging in ZERO WIDTH SPACE. Control characters, including 0,
139     // are mapped to the ZERO WIDTH SPACE glyph.
140     if (m_zeroWidthSpaceGlyph == m_spaceGlyph) {
141         m_zeroWidthSpaceGlyph = 0;
142         LOG_ERROR("Font maps SPACE and ZERO WIDTH SPACE to the same glyph. Glyph width will not be overridden.");
143     }
144
145     m_missingGlyphData.fontData = this;
146     m_missingGlyphData.glyph = 0;
147 }
148
149 SimpleFontData::~SimpleFontData()
150 {
151 #if ENABLE(SVG_FONTS)
152     if (!m_fontData)
153 #endif
154         platformDestroy();
155
156     if (isCustomFont())
157         GlyphPageTreeNode::pruneTreeCustomFontData(this);
158     else
159         GlyphPageTreeNode::pruneTreeFontData(this);
160 }
161
162 const SimpleFontData* SimpleFontData::fontDataForCharacter(UChar32) const
163 {
164     return this;
165 }
166
167 Glyph SimpleFontData::glyphForCharacter(UChar32 character) const
168 {
169     GlyphPageTreeNode* node = GlyphPageTreeNode::getRootChild(this, character / GlyphPage::size);
170     return node->page() ? node->page()->glyphAt(character % GlyphPage::size) : 0;
171 }
172
173 bool SimpleFontData::isSegmented() const
174 {
175     return false;
176 }
177
178 PassRefPtr<SimpleFontData> SimpleFontData::verticalRightOrientationFontData() const
179 {
180     if (!m_derivedFontData)
181         m_derivedFontData = DerivedFontData::create(isCustomFont());
182     if (!m_derivedFontData->verticalRightOrientation) {
183         FontPlatformData verticalRightPlatformData(m_platformData);
184         verticalRightPlatformData.setOrientation(Horizontal);
185         m_derivedFontData->verticalRightOrientation = create(verticalRightPlatformData, isCustomFont(), false, true);
186     }
187     return m_derivedFontData->verticalRightOrientation;
188 }
189
190 PassRefPtr<SimpleFontData> SimpleFontData::uprightOrientationFontData() const
191 {
192     if (!m_derivedFontData)
193         m_derivedFontData = DerivedFontData::create(isCustomFont());
194     if (!m_derivedFontData->uprightOrientation)
195         m_derivedFontData->uprightOrientation = create(m_platformData, isCustomFont(), false, true);
196     return m_derivedFontData->uprightOrientation;
197 }
198
199 PassRefPtr<SimpleFontData> SimpleFontData::smallCapsFontData(const FontDescription& fontDescription) const
200 {
201     if (!m_derivedFontData)
202         m_derivedFontData = DerivedFontData::create(isCustomFont());
203     if (!m_derivedFontData->smallCaps)
204         m_derivedFontData->smallCaps = createScaledFontData(fontDescription, smallCapsFontSizeMultiplier);
205
206     return m_derivedFontData->smallCaps;
207 }
208
209 PassRefPtr<SimpleFontData> SimpleFontData::emphasisMarkFontData(const FontDescription& fontDescription) const
210 {
211     if (!m_derivedFontData)
212         m_derivedFontData = DerivedFontData::create(isCustomFont());
213     if (!m_derivedFontData->emphasisMark)
214         m_derivedFontData->emphasisMark = createScaledFontData(fontDescription, emphasisMarkFontSizeMultiplier);
215
216     return m_derivedFontData->emphasisMark;
217 }
218
219 PassRefPtr<SimpleFontData> SimpleFontData::brokenIdeographFontData() const
220 {
221     if (!m_derivedFontData)
222         m_derivedFontData = DerivedFontData::create(isCustomFont());
223     if (!m_derivedFontData->brokenIdeograph) {
224         m_derivedFontData->brokenIdeograph = create(m_platformData, isCustomFont(), false);
225         m_derivedFontData->brokenIdeograph->m_isBrokenIdeographFallback = true;
226     }
227     return m_derivedFontData->brokenIdeograph;
228 }
229
230 #ifndef NDEBUG
231 String SimpleFontData::description() const
232 {
233     if (isSVGFont())
234         return "[SVG font]";
235     if (isCustomFont())
236         return "[custom font]";
237
238     return platformData().description();
239 }
240 #endif
241
242 PassOwnPtr<SimpleFontData::DerivedFontData> SimpleFontData::DerivedFontData::create(bool forCustomFont)
243 {
244     return adoptPtr(new DerivedFontData(forCustomFont));
245 }
246
247 SimpleFontData::DerivedFontData::~DerivedFontData()
248 {
249     if (!forCustomFont)
250         return;
251
252     if (smallCaps)
253         GlyphPageTreeNode::pruneTreeCustomFontData(smallCaps.get());
254     if (emphasisMark)
255         GlyphPageTreeNode::pruneTreeCustomFontData(emphasisMark.get());
256     if (brokenIdeograph)
257         GlyphPageTreeNode::pruneTreeCustomFontData(brokenIdeograph.get());
258     if (verticalRightOrientation)
259         GlyphPageTreeNode::pruneTreeCustomFontData(verticalRightOrientation.get());
260     if (uprightOrientation)
261         GlyphPageTreeNode::pruneTreeCustomFontData(uprightOrientation.get());
262 #if PLATFORM(MAC)
263     if (compositeFontReferences) {
264         CFDictionaryRef dictionary = CFDictionaryRef(compositeFontReferences.get());
265         CFIndex count = CFDictionaryGetCount(dictionary);
266         if (count > 0) {
267             Vector<SimpleFontData*, 2> stash(count);
268             SimpleFontData** fonts = stash.data();
269             CFDictionaryGetKeysAndValues(dictionary, 0, (const void **)fonts);
270             while (count-- > 0 && *fonts) {
271                 OwnPtr<SimpleFontData> afont = adoptPtr(*fonts++);
272                 GlyphPageTreeNode::pruneTreeCustomFontData(afont.get());
273             }
274         }
275     }
276 #endif
277 }
278
279 } // namespace WebCore