Apply std::unique_ptr to FooFont classes
[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 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 "OpenTypeMathData.h"
36 #include <wtf/MathExtras.h>
37
38 #if ENABLE(OPENTYPE_VERTICAL)
39 #include "OpenTypeVerticalData.h"
40 #endif
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     , m_mathData(nullptr)
57 #if ENABLE(OPENTYPE_VERTICAL)
58     , m_verticalData(0)
59 #endif
60     , m_hasVerticalGlyphs(false)
61 {
62     platformInit();
63     platformGlyphInit();
64     platformCharWidthInit();
65 #if ENABLE(OPENTYPE_VERTICAL)
66     if (platformData.orientation() == Vertical && !isTextOrientationFallback) {
67         m_verticalData = platformData.verticalData();
68         m_hasVerticalGlyphs = m_verticalData.get() && m_verticalData->hasVerticalMetrics();
69     }
70 #endif
71 }
72
73 SimpleFontData::SimpleFontData(std::unique_ptr<AdditionalFontData> fontData, float fontSize, bool syntheticBold, bool syntheticItalic)
74     : m_platformData(FontPlatformData(fontSize, syntheticBold, syntheticItalic))
75     , m_fontData(WTF::move(fontData))
76     , m_treatAsFixedPitch(false)
77     , m_isCustomFont(true)
78     , m_isLoading(false)
79     , m_isTextOrientationFallback(false)
80     , m_isBrokenIdeographFallback(false)
81     , m_mathData(nullptr)
82 #if ENABLE(OPENTYPE_VERTICAL)
83     , m_verticalData(0)
84 #endif
85     , m_hasVerticalGlyphs(false)
86 #if PLATFORM(IOS)
87     , m_shouldNotBeUsedForArabic(false)
88 #endif
89 {
90     m_fontData->initializeFontData(this, fontSize);
91 }
92
93 // Estimates of avgCharWidth and maxCharWidth for platforms that don't support accessing these values from the font.
94 void SimpleFontData::initCharWidths()
95 {
96     GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
97
98     // Treat the width of a '0' as the avgCharWidth.
99     if (m_avgCharWidth <= 0.f && glyphPageZero) {
100         static const UChar32 digitZeroChar = '0';
101         Glyph digitZeroGlyph = glyphPageZero->glyphDataForCharacter(digitZeroChar).glyph;
102         if (digitZeroGlyph)
103             m_avgCharWidth = widthForGlyph(digitZeroGlyph);
104     }
105
106     // If we can't retrieve the width of a '0', fall back to the x height.
107     if (m_avgCharWidth <= 0.f)
108         m_avgCharWidth = m_fontMetrics.xHeight();
109
110     if (m_maxCharWidth <= 0.f)
111         m_maxCharWidth = std::max(m_avgCharWidth, m_fontMetrics.floatAscent());
112 }
113
114 void SimpleFontData::platformGlyphInit()
115 {
116     GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
117     if (!glyphPageZero) {
118         m_spaceGlyph = 0;
119         m_spaceWidth = 0;
120         m_zeroGlyph = 0;
121         m_adjustedSpaceWidth = 0;
122         determinePitch();
123         m_zeroWidthSpaceGlyph = 0;
124         m_missingGlyphData.fontData = this;
125         m_missingGlyphData.glyph = 0;
126         return;
127     }
128
129     // Ask for the glyph for 0 to avoid paging in ZERO WIDTH SPACE. Control characters, including 0,
130     // are mapped to the ZERO WIDTH SPACE glyph.
131     m_zeroWidthSpaceGlyph = glyphPageZero->glyphDataForCharacter(0).glyph;
132
133     // Nasty hack to determine if we should round or ceil space widths.
134     // If the font is monospace or fake monospace we ceil to ensure that 
135     // every character and the space are the same width.  Otherwise we round.
136     m_spaceGlyph = glyphPageZero->glyphDataForCharacter(' ').glyph;
137     float width = widthForGlyph(m_spaceGlyph);
138     m_spaceWidth = width;
139     m_zeroGlyph = glyphPageZero->glyphDataForCharacter('0').glyph;
140     m_fontMetrics.setZeroWidth(widthForGlyph(m_zeroGlyph));
141     determinePitch();
142     m_adjustedSpaceWidth = m_treatAsFixedPitch ? ceilf(width) : roundf(width);
143
144     // Force the glyph for ZERO WIDTH SPACE to have zero width, unless it is shared with SPACE.
145     // Helvetica is an example of a non-zero width ZERO WIDTH SPACE glyph.
146     // See <http://bugs.webkit.org/show_bug.cgi?id=13178> and SimpleFontData::isZeroWidthSpaceGlyph()
147     if (m_zeroWidthSpaceGlyph == m_spaceGlyph)
148         m_zeroWidthSpaceGlyph = 0;
149
150     m_missingGlyphData.fontData = this;
151     m_missingGlyphData.glyph = 0;
152 }
153
154 SimpleFontData::~SimpleFontData()
155 {
156     if (!m_fontData)
157         platformDestroy();
158
159     if (isCustomFont())
160         GlyphPageTreeNode::pruneTreeCustomFontData(this);
161     else
162         GlyphPageTreeNode::pruneTreeFontData(this);
163 }
164
165 const SimpleFontData* SimpleFontData::fontDataForCharacter(UChar32) const
166 {
167     return this;
168 }
169
170 Glyph SimpleFontData::glyphForCharacter(UChar32 character) const
171 {
172     GlyphPageTreeNode* node = GlyphPageTreeNode::getRootChild(this, character / GlyphPage::size);
173     return node->page() ? node->page()->glyphAt(character % GlyphPage::size) : 0;
174 }
175
176 bool SimpleFontData::isSegmented() const
177 {
178     return false;
179 }
180
181 PassRefPtr<SimpleFontData> SimpleFontData::verticalRightOrientationFontData() const
182 {
183     if (!m_derivedFontData)
184         m_derivedFontData = std::make_unique<DerivedFontData>(isCustomFont());
185     if (!m_derivedFontData->verticalRightOrientation) {
186         FontPlatformData verticalRightPlatformData(m_platformData);
187         verticalRightPlatformData.setOrientation(Horizontal);
188         m_derivedFontData->verticalRightOrientation = create(verticalRightPlatformData, isCustomFont(), false, true);
189     }
190     return m_derivedFontData->verticalRightOrientation;
191 }
192
193 PassRefPtr<SimpleFontData> SimpleFontData::uprightOrientationFontData() const
194 {
195     if (!m_derivedFontData)
196         m_derivedFontData = std::make_unique<DerivedFontData>(isCustomFont());
197     if (!m_derivedFontData->uprightOrientation)
198         m_derivedFontData->uprightOrientation = create(m_platformData, isCustomFont(), false, true);
199     return m_derivedFontData->uprightOrientation;
200 }
201
202 PassRefPtr<SimpleFontData> SimpleFontData::smallCapsFontData(const FontDescription& fontDescription) const
203 {
204     if (!m_derivedFontData)
205         m_derivedFontData = std::make_unique<DerivedFontData>(isCustomFont());
206     if (!m_derivedFontData->smallCaps)
207         m_derivedFontData->smallCaps = createScaledFontData(fontDescription, smallCapsFontSizeMultiplier);
208
209     return m_derivedFontData->smallCaps;
210 }
211
212 PassRefPtr<SimpleFontData> SimpleFontData::emphasisMarkFontData(const FontDescription& fontDescription) const
213 {
214     if (!m_derivedFontData)
215         m_derivedFontData = std::make_unique<DerivedFontData>(isCustomFont());
216     if (!m_derivedFontData->emphasisMark)
217         m_derivedFontData->emphasisMark = createScaledFontData(fontDescription, emphasisMarkFontSizeMultiplier);
218
219     return m_derivedFontData->emphasisMark;
220 }
221
222 PassRefPtr<SimpleFontData> SimpleFontData::brokenIdeographFontData() const
223 {
224     if (!m_derivedFontData)
225         m_derivedFontData = std::make_unique<DerivedFontData>(isCustomFont());
226     if (!m_derivedFontData->brokenIdeograph) {
227         m_derivedFontData->brokenIdeograph = create(m_platformData, isCustomFont(), false);
228         m_derivedFontData->brokenIdeograph->m_isBrokenIdeographFallback = true;
229     }
230     return m_derivedFontData->brokenIdeograph;
231 }
232
233 PassRefPtr<SimpleFontData> SimpleFontData::nonSyntheticItalicFontData() const
234 {
235     if (!m_derivedFontData)
236         m_derivedFontData = std::make_unique<DerivedFontData>(isCustomFont());
237     if (!m_derivedFontData->nonSyntheticItalic) {
238         FontPlatformData nonSyntheticItalicFontPlatformData(m_platformData);
239 #if PLATFORM(COCOA)
240         nonSyntheticItalicFontPlatformData.m_syntheticOblique = false;
241 #endif
242         m_derivedFontData->nonSyntheticItalic = create(nonSyntheticItalicFontPlatformData, isCustomFont());
243     }
244     return m_derivedFontData->nonSyntheticItalic;
245 }
246
247 #ifndef NDEBUG
248 String SimpleFontData::description() const
249 {
250     if (isSVGFont())
251         return "[SVG font]";
252     if (isCustomFont())
253         return "[custom font]";
254
255     return platformData().description();
256 }
257 #endif
258
259 const OpenTypeMathData* SimpleFontData::mathData() const
260 {
261     if (m_isLoading)
262         return nullptr;
263     if (!m_mathData) {
264         m_mathData = OpenTypeMathData::create(m_platformData);
265         if (!m_mathData->hasMathData())
266             m_mathData.clear();
267     }
268     return m_mathData.get();
269 }
270
271 SimpleFontData::DerivedFontData::~DerivedFontData()
272 {
273     if (!forCustomFont)
274         return;
275
276     if (smallCaps)
277         GlyphPageTreeNode::pruneTreeCustomFontData(smallCaps.get());
278     if (emphasisMark)
279         GlyphPageTreeNode::pruneTreeCustomFontData(emphasisMark.get());
280     if (brokenIdeograph)
281         GlyphPageTreeNode::pruneTreeCustomFontData(brokenIdeograph.get());
282     if (verticalRightOrientation)
283         GlyphPageTreeNode::pruneTreeCustomFontData(verticalRightOrientation.get());
284     if (uprightOrientation)
285         GlyphPageTreeNode::pruneTreeCustomFontData(uprightOrientation.get());
286 #if PLATFORM(COCOA)
287     if (compositeFontReferences) {
288         CFDictionaryRef dictionary = CFDictionaryRef(compositeFontReferences.get());
289         CFIndex count = CFDictionaryGetCount(dictionary);
290         if (count > 0) {
291             Vector<SimpleFontData*, 2> stash(count);
292             SimpleFontData** fonts = stash.data();
293             CFDictionaryGetKeysAndValues(dictionary, 0, (const void **)fonts);
294             while (count-- > 0 && *fonts) {
295                 RefPtr<SimpleFontData> afont = adoptRef(*fonts++);
296                 GlyphPageTreeNode::pruneTreeCustomFontData(afont.get());
297             }
298         }
299     }
300 #endif
301 }
302
303 PassRefPtr<SimpleFontData> SimpleFontData::createScaledFontData(const FontDescription& fontDescription, float scaleFactor) const
304 {
305     // FIXME: Support scaled fonts that used AdditionalFontData.
306     if (m_fontData)
307         return 0;
308
309     return platformCreateScaledFontData(fontDescription, scaleFactor);
310 }
311
312 } // namespace WebCore