[WebGL2] Teach WebGLRenderingContextBase about new texture internal formats
[WebKit-https.git] / Source / WebCore / platform / graphics / FontCascadeFonts.cpp
1 /*
2  * Copyright (C) 2006, 2013-2015 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "FontCascadeFonts.h"
31
32 #include "FontCache.h"
33 #include "FontCascade.h"
34 #include "GlyphPage.h"
35
36 namespace WebCore {
37
38 class MixedFontGlyphPage {
39     WTF_MAKE_FAST_ALLOCATED;
40 public:
41     MixedFontGlyphPage(const GlyphPage* initialPage)
42     {
43         if (initialPage) {
44             for (unsigned i = 0; i < GlyphPage::size; ++i)
45                 setGlyphDataForIndex(i, initialPage->glyphDataForIndex(i));
46         }
47     }
48
49     GlyphData glyphDataForCharacter(UChar32 c) const
50     {
51         unsigned index = GlyphPage::indexForCodePoint(c);
52         ASSERT_WITH_SECURITY_IMPLICATION(index < GlyphPage::size);
53         return { m_glyphs[index], m_fonts[index] };
54     }
55
56     void setGlyphDataForCharacter(UChar32 c, GlyphData glyphData)
57     {
58         setGlyphDataForIndex(GlyphPage::indexForCodePoint(c), glyphData);
59     }
60
61 private:
62     void setGlyphDataForIndex(unsigned index, const GlyphData& glyphData)
63     {
64         ASSERT_WITH_SECURITY_IMPLICATION(index < GlyphPage::size);
65         m_glyphs[index] = glyphData.glyph;
66         m_fonts[index] = glyphData.font;
67     }
68
69     Glyph m_glyphs[GlyphPage::size] { };
70     const Font* m_fonts[GlyphPage::size] { };
71 };
72
73 GlyphData FontCascadeFonts::GlyphPageCacheEntry::glyphDataForCharacter(UChar32 character)
74 {
75     ASSERT(!(m_singleFont && m_mixedFont));
76     if (m_singleFont)
77         return m_singleFont->glyphDataForCharacter(character);
78     if (m_mixedFont)
79         return m_mixedFont->glyphDataForCharacter(character);
80     return 0;
81 }
82
83 void FontCascadeFonts::GlyphPageCacheEntry::setGlyphDataForCharacter(UChar32 character, GlyphData glyphData)
84 {
85     ASSERT(!glyphDataForCharacter(character).glyph);
86     if (!m_mixedFont) {
87         m_mixedFont = std::make_unique<MixedFontGlyphPage>(m_singleFont.get());
88         m_singleFont = nullptr;
89     }
90     m_mixedFont->setGlyphDataForCharacter(character, glyphData);
91 }
92
93 void FontCascadeFonts::GlyphPageCacheEntry::setSingleFontPage(RefPtr<GlyphPage>&& page)
94 {
95     ASSERT(isNull());
96     m_singleFont = page;
97 }
98
99 FontCascadeFonts::FontCascadeFonts(RefPtr<FontSelector>&& fontSelector)
100     : m_cachedPrimaryFont(nullptr)
101     , m_fontSelector(fontSelector)
102     , m_fontSelectorVersion(m_fontSelector ? m_fontSelector->version() : 0)
103     , m_generation(FontCache::singleton().generation())
104 {
105 }
106
107 FontCascadeFonts::FontCascadeFonts(const FontPlatformData& platformData)
108     : m_cachedPrimaryFont(nullptr)
109     , m_fontSelectorVersion(0)
110     , m_generation(FontCache::singleton().generation())
111     , m_isForPlatformFont(true)
112 {
113     m_realizedFallbackRanges.append(FontRanges(FontCache::singleton().fontForPlatformData(platformData)));
114 }
115
116 FontCascadeFonts::~FontCascadeFonts()
117 {
118 }
119
120 void FontCascadeFonts::determinePitch(const FontCascadeDescription& description)
121 {
122     auto& primaryRanges = realizeFallbackRangesAt(description, 0);
123     unsigned numRanges = primaryRanges.size();
124     if (numRanges == 1)
125         m_pitch = primaryRanges.fontForFirstRange().pitch();
126     else
127         m_pitch = VariablePitch;
128 }
129
130 bool FontCascadeFonts::isLoadingCustomFonts() const
131 {
132     for (auto& fontRanges : m_realizedFallbackRanges) {
133         if (fontRanges.isLoading())
134             return true;
135     }
136     return false;
137 }
138
139 static FontRanges realizeNextFallback(const FontCascadeDescription& description, unsigned& index, FontSelector* fontSelector)
140 {
141     ASSERT(index < description.familyCount());
142
143     auto& fontCache = FontCache::singleton();
144     while (index < description.familyCount()) {
145         const AtomicString& family = description.familyAt(index++);
146         if (family.isEmpty())
147             continue;
148         if (fontSelector) {
149             auto ranges = fontSelector->fontRangesForFamily(description, family);
150             if (!ranges.isNull())
151                 return ranges;
152         }
153         if (auto font = fontCache.fontForFamily(description, family))
154             return FontRanges(WTFMove(font));
155     }
156     // We didn't find a font. Try to find a similar font using our own specific knowledge about our platform.
157     // For example on OS X, we know to map any families containing the words Arabic, Pashto, or Urdu to the
158     // Geeza Pro font.
159     for (auto& family : description.families()) {
160         if (auto font = fontCache.similarFont(description, family))
161             return FontRanges(WTFMove(font));
162     }
163     return { };
164 }
165
166 const FontRanges& FontCascadeFonts::realizeFallbackRangesAt(const FontCascadeDescription& description, unsigned index)
167 {
168     if (index < m_realizedFallbackRanges.size())
169         return m_realizedFallbackRanges[index];
170
171     ASSERT(index == m_realizedFallbackRanges.size());
172     ASSERT(FontCache::singleton().generation() == m_generation);
173
174     m_realizedFallbackRanges.append(FontRanges());
175     auto& fontRanges = m_realizedFallbackRanges.last();
176
177     if (!index) {
178         fontRanges = realizeNextFallback(description, m_lastRealizedFallbackIndex, m_fontSelector.get());
179         if (fontRanges.isNull() && m_fontSelector)
180             fontRanges = m_fontSelector->fontRangesForFamily(description, standardFamily);
181         if (fontRanges.isNull())
182             fontRanges = FontRanges(FontCache::singleton().lastResortFallbackFont(description));
183         return fontRanges;
184     }
185
186     if (m_lastRealizedFallbackIndex < description.familyCount())
187         fontRanges = realizeNextFallback(description, m_lastRealizedFallbackIndex, m_fontSelector.get());
188
189     if (fontRanges.isNull() && m_fontSelector) {
190         ASSERT(m_lastRealizedFallbackIndex >= description.familyCount());
191
192         unsigned fontSelectorFallbackIndex = m_lastRealizedFallbackIndex - description.familyCount();
193         if (fontSelectorFallbackIndex == m_fontSelector->fallbackFontCount())
194             return fontRanges;
195         ++m_lastRealizedFallbackIndex;
196         fontRanges = FontRanges(m_fontSelector->fallbackFontAt(description, fontSelectorFallbackIndex));
197     }
198
199     return fontRanges;
200 }
201
202 static inline bool isInRange(UChar32 character, UChar32 lowerBound, UChar32 upperBound)
203 {
204     return character >= lowerBound && character <= upperBound;
205 }
206
207 static bool shouldIgnoreRotation(UChar32 character)
208 {
209     if (character == 0x000A7 || character == 0x000A9 || character == 0x000AE)
210         return true;
211
212     if (character == 0x000B6 || character == 0x000BC || character == 0x000BD || character == 0x000BE)
213         return true;
214
215     if (isInRange(character, 0x002E5, 0x002EB))
216         return true;
217     
218     if (isInRange(character, 0x01100, 0x011FF) || isInRange(character, 0x01401, 0x0167F) || isInRange(character, 0x01800, 0x018FF))
219         return true;
220
221     if (character == 0x02016 || character == 0x02020 || character == 0x02021 || character == 0x2030 || character == 0x02031)
222         return true;
223
224     if (isInRange(character, 0x0203B, 0x0203D) || character == 0x02042 || character == 0x02044 || character == 0x02047
225         || character == 0x02048 || character == 0x02049 || character == 0x2051)
226         return true;
227
228     if (isInRange(character, 0x02065, 0x02069) || isInRange(character, 0x020DD, 0x020E0)
229         || isInRange(character, 0x020E2, 0x020E4) || isInRange(character, 0x02100, 0x02117)
230         || isInRange(character, 0x02119, 0x02131) || isInRange(character, 0x02133, 0x0213F))
231         return true;
232
233     if (isInRange(character, 0x02145, 0x0214A) || character == 0x0214C || character == 0x0214D
234         || isInRange(character, 0x0214F, 0x0218F))
235         return true;
236
237     if (isInRange(character, 0x02300, 0x02307) || isInRange(character, 0x0230C, 0x0231F)
238         || isInRange(character, 0x02322, 0x0232B) || isInRange(character, 0x0237D, 0x0239A)
239         || isInRange(character, 0x023B4, 0x023B6) || isInRange(character, 0x023BA, 0x023CF)
240         || isInRange(character, 0x023D1, 0x023DB) || isInRange(character, 0x023E2, 0x024FF))
241         return true;
242
243     if (isInRange(character, 0x025A0, 0x02619) || isInRange(character, 0x02620, 0x02767)
244         || isInRange(character, 0x02776, 0x02793) || isInRange(character, 0x02B12, 0x02B2F)
245         || isInRange(character, 0x02B4D, 0x02BFF) || isInRange(character, 0x02E80, 0x03007))
246         return true;
247
248     if (character == 0x03012 || character == 0x03013 || isInRange(character, 0x03020, 0x0302F)
249         || isInRange(character, 0x03031, 0x0309F) || isInRange(character, 0x030A1, 0x030FB)
250         || isInRange(character, 0x030FD, 0x0A4CF))
251         return true;
252
253     if (isInRange(character, 0x0A840, 0x0A87F) || isInRange(character, 0x0A960, 0x0A97F)
254         || isInRange(character, 0x0AC00, 0x0D7FF) || isInRange(character, 0x0E000, 0x0FAFF))
255         return true;
256
257     if (isInRange(character, 0x0FE10, 0x0FE1F) || isInRange(character, 0x0FE30, 0x0FE48)
258         || isInRange(character, 0x0FE50, 0x0FE57) || isInRange(character, 0x0FE5F, 0x0FE62)
259         || isInRange(character, 0x0FE67, 0x0FE6F))
260         return true;
261
262     if (isInRange(character, 0x0FF01, 0x0FF07) || isInRange(character, 0x0FF0A, 0x0FF0C)
263         || isInRange(character, 0x0FF0E, 0x0FF19) || character == 0x0FF1B || isInRange(character, 0x0FF1F, 0x0FF3A))
264         return true;
265
266     if (character == 0x0FF3C || character == 0x0FF3E)
267         return true;
268
269     if (isInRange(character, 0x0FF40, 0x0FF5A) || isInRange(character, 0x0FFE0, 0x0FFE2)
270         || isInRange(character, 0x0FFE4, 0x0FFE7) || isInRange(character, 0x0FFF0, 0x0FFF8)
271         || character == 0x0FFFD)
272         return true;
273
274     if (isInRange(character, 0x13000, 0x1342F) || isInRange(character, 0x1B000, 0x1B0FF)
275         || isInRange(character, 0x1D000, 0x1D1FF) || isInRange(character, 0x1D300, 0x1D37F)
276         || isInRange(character, 0x1F000, 0x1F64F) || isInRange(character, 0x1F680, 0x1F77F))
277         return true;
278     
279     if (isInRange(character, 0x20000, 0x2FFFD) || isInRange(character, 0x30000, 0x3FFFD))
280         return true;
281
282     return false;
283 }
284
285 #if PLATFORM(COCOA) || USE(CAIRO)
286 static GlyphData glyphDataForCJKCharacterWithoutSyntheticItalic(UChar32 character, GlyphData& data)
287 {
288     GlyphData nonItalicData = data.font->nonSyntheticItalicFont().glyphDataForCharacter(character);
289     if (nonItalicData.font)
290         return nonItalicData;
291     return data;
292 }
293 #endif
294     
295 static GlyphData glyphDataForNonCJKCharacterWithGlyphOrientation(UChar32 character, NonCJKGlyphOrientation orientation, const GlyphData& data)
296 {
297     if (orientation == NonCJKGlyphOrientation::Upright || shouldIgnoreRotation(character)) {
298         GlyphData uprightData = data.font->uprightOrientationFont().glyphDataForCharacter(character);
299         // If the glyphs are the same, then we know we can just use the horizontal glyph rotated vertically to be upright.
300         if (data.glyph == uprightData.glyph)
301             return data;
302         // The glyphs are distinct, meaning that the font has a vertical-right glyph baked into it. We can't use that
303         // glyph, so we fall back to the upright data and use the horizontal glyph.
304         if (uprightData.font)
305             return uprightData;
306     } else if (orientation == NonCJKGlyphOrientation::Mixed) {
307         GlyphData verticalRightData = data.font->verticalRightOrientationFont().glyphDataForCharacter(character);
308         // If the glyphs are distinct, we will make the assumption that the font has a vertical-right glyph baked
309         // into it.
310         if (data.glyph != verticalRightData.glyph)
311             return data;
312         // The glyphs are identical, meaning that we should just use the horizontal glyph.
313         if (verticalRightData.font)
314             return verticalRightData;
315     }
316     return data;
317 }
318
319 GlyphData FontCascadeFonts::glyphDataForSystemFallback(UChar32 c, const FontCascadeDescription& description, FontVariant variant)
320 {
321     // System fallback is character-dependent.
322     auto& primaryRanges = realizeFallbackRangesAt(description, 0);
323     auto* originalFont = primaryRanges.fontForCharacter(c);
324     if (!originalFont)
325         originalFont = &primaryRanges.fontForFirstRange();
326
327     auto systemFallbackFont = originalFont->systemFallbackFontForCharacter(c, description, m_isForPlatformFont);
328     if (!systemFallbackFont)
329         return GlyphData();
330
331     if (systemFallbackFont->platformData().orientation() == Vertical && !systemFallbackFont->hasVerticalGlyphs() && FontCascade::isCJKIdeographOrSymbol(c))
332         variant = BrokenIdeographVariant;
333
334     GlyphData fallbackGlyphData;
335     if (variant == NormalVariant)
336         fallbackGlyphData = systemFallbackFont->glyphDataForCharacter(c);
337     else
338         fallbackGlyphData = systemFallbackFont->variantFont(description, variant)->glyphDataForCharacter(c);
339
340     if (fallbackGlyphData.font && fallbackGlyphData.font->platformData().orientation() == Vertical && !fallbackGlyphData.font->isTextOrientationFallback()) {
341         if (variant == NormalVariant && !FontCascade::isCJKIdeographOrSymbol(c))
342             fallbackGlyphData = glyphDataForNonCJKCharacterWithGlyphOrientation(c, description.nonCJKGlyphOrientation(), fallbackGlyphData);
343 #if PLATFORM(COCOA) || USE(CAIRO)
344         if (fallbackGlyphData.font->platformData().syntheticOblique() && FontCascade::isCJKIdeographOrSymbol(c))
345             fallbackGlyphData = glyphDataForCJKCharacterWithoutSyntheticItalic(c, fallbackGlyphData);
346 #endif
347     }
348
349     // Keep the system fallback fonts we use alive.
350     if (fallbackGlyphData.glyph)
351         m_systemFallbackFontSet.add(WTFMove(systemFallbackFont));
352
353     return fallbackGlyphData;
354 }
355
356 GlyphData FontCascadeFonts::glyphDataForVariant(UChar32 c, const FontCascadeDescription& description, FontVariant variant, unsigned fallbackIndex)
357 {
358     while (true) {
359         auto& fontRanges = realizeFallbackRangesAt(description, fallbackIndex++);
360         if (fontRanges.isNull())
361             break;
362         GlyphData data = fontRanges.glyphDataForCharacter(c);
363         if (!data.font)
364             continue;
365         // The variantFont function should not normally return 0.
366         // But if it does, we will just render the capital letter big.
367         if (const Font* variantFont = data.font->variantFont(description, variant))
368             return variantFont->glyphDataForCharacter(c);
369         return data;
370     }
371
372     return glyphDataForSystemFallback(c, description, variant);
373 }
374
375 GlyphData FontCascadeFonts::glyphDataForNormalVariant(UChar32 c, const FontCascadeDescription& description)
376 {
377     for (unsigned fallbackIndex = 0; ; ++fallbackIndex) {
378         auto& fontRanges = realizeFallbackRangesAt(description, fallbackIndex);
379         if (fontRanges.isNull())
380             break;
381         GlyphData data = fontRanges.glyphDataForCharacter(c);
382         if (!data.font)
383             continue;
384         if (data.font->platformData().orientation() == Vertical && !data.font->isTextOrientationFallback()) {
385             if (!FontCascade::isCJKIdeographOrSymbol(c))
386                 return glyphDataForNonCJKCharacterWithGlyphOrientation(c, description.nonCJKGlyphOrientation(), data);
387
388             if (!data.font->hasVerticalGlyphs()) {
389                 // Use the broken ideograph font data. The broken ideograph font will use the horizontal width of glyphs
390                 // to make sure you get a square (even for broken glyphs like symbols used for punctuation).
391                 return glyphDataForVariant(c, description, BrokenIdeographVariant, fallbackIndex);
392             }
393 #if PLATFORM(COCOA) || USE(CAIRO)
394             if (data.font->platformData().syntheticOblique())
395                 return glyphDataForCJKCharacterWithoutSyntheticItalic(c, data);
396 #endif
397         }
398         return data;
399     }
400
401     return glyphDataForSystemFallback(c, description, NormalVariant);
402 }
403
404 static RefPtr<GlyphPage> glyphPageFromFontRanges(unsigned pageNumber, const FontRanges& fontRanges)
405 {
406     const Font* font = nullptr;
407     UChar32 pageRangeFrom = pageNumber * GlyphPage::size;
408     UChar32 pageRangeTo = pageRangeFrom + GlyphPage::size - 1;
409     for (unsigned i = 0; i < fontRanges.size(); ++i) {
410         auto& range = fontRanges.rangeAt(i);
411         if (range.to()) {
412             if (range.from() <= pageRangeFrom && pageRangeTo <= range.to())
413                 font = range.font();
414             break;
415         }
416     }
417     if (!font || font->platformData().orientation() == Vertical)
418         return nullptr;
419
420     return const_cast<GlyphPage*>(font->glyphPage(pageNumber));
421 }
422
423 GlyphData FontCascadeFonts::glyphDataForCharacter(UChar32 c, const FontCascadeDescription& description, FontVariant variant)
424 {
425     ASSERT(isMainThread());
426     ASSERT(variant != AutoVariant);
427
428     if (variant != NormalVariant)
429         return glyphDataForVariant(c, description, variant, 0);
430
431     const unsigned pageNumber = GlyphPage::pageNumberForCodePoint(c);
432
433     auto& cacheEntry = pageNumber ? m_cachedPages.add(pageNumber, GlyphPageCacheEntry()).iterator->value : m_cachedPageZero;
434
435     // Initialize cache with a full page of glyph mappings from a single font.
436     if (cacheEntry.isNull())
437         cacheEntry.setSingleFontPage(glyphPageFromFontRanges(pageNumber, realizeFallbackRangesAt(description, 0)));
438
439     GlyphData glyphData = cacheEntry.glyphDataForCharacter(c);
440     if (!glyphData.glyph) {
441         // No glyph, resolve per-character.
442         glyphData = glyphDataForNormalVariant(c, description);
443         // Cache the results.
444         cacheEntry.setGlyphDataForCharacter(c, glyphData);
445     }
446
447     return glyphData;
448 }
449
450 void FontCascadeFonts::pruneSystemFallbacks()
451 {
452     if (m_systemFallbackFontSet.isEmpty())
453         return;
454     // Mutable glyph pages may reference fallback fonts.
455     if (m_cachedPageZero.isMixedFont())
456         m_cachedPageZero = { };
457     m_cachedPages.removeIf([](auto& keyAndValue) {
458         return keyAndValue.value.isMixedFont();
459     });
460     m_systemFallbackFontSet.clear();
461 }
462
463 }