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_zeroGlyph = 0;
 117         m_adjustedSpaceWidth = 0;
 118         determinePitch();
 119         m_zeroWidthSpaceGlyph = 0;
 120         m_missingGlyphData.fontData = this;
 121         m_missingGlyphData.glyph = 0;
 122         return;
 123     }
 124
 125     m_zeroWidthSpaceGlyph = glyphPageZero->glyphDataForCharacter(0).glyph;
 126
 127     // Nasty hack to determine if we should round or ceil space widths.
 128     // If the font is monospace or fake monospace we ceil to ensure that
 129     // every character and the space are the same width.  Otherwise we round.
 130     m_spaceGlyph = glyphPageZero->glyphDataForCharacter(' ').glyph;
 131     float width = widthForGlyph(m_spaceGlyph);
 132     m_spaceWidth = width;
 133     m_zeroGlyph = glyphPageZero->glyphDataForCharacter('0').glyph;
 134     m_fontMetrics.setZeroWidth(widthForGlyph(m_zeroGlyph));
 135     determinePitch();
 136     m_adjustedSpaceWidth = m_treatAsFixedPitch ? ceilf(width) : roundf(width);
 137
 138     // Force the glyph for ZERO WIDTH SPACE to have zero width, unless it is shared with SPACE.
 139     // Helvetica is an example of a non-zero width ZERO WIDTH SPACE glyph.
 140     // See <http://bugs.webkit.org/show_bug.cgi?id=13178>
 141     // Ask for the glyph for 0 to avoid paging in ZERO WIDTH SPACE. Control characters, including 0,
 142     // are mapped to the ZERO WIDTH SPACE glyph.
 143     if (m_zeroWidthSpaceGlyph == m_spaceGlyph) {
 144         m_zeroWidthSpaceGlyph = 0;
 145         LOG_ERROR("Font maps SPACE and ZERO WIDTH SPACE to the same glyph. Glyph width will not be overridden.");
 146     }
 147
 148     m_missingGlyphData.fontData = this;
 149     m_missingGlyphData.glyph = 0;
 150 }
 151
 152 SimpleFontData::~SimpleFontData()
 153 {
 154 #if ENABLE(SVG_FONTS)
 155     if (!m_fontData)
 156 #endif
 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 = DerivedFontData::create(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 = DerivedFontData::create(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 = DerivedFontData::create(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 = DerivedFontData::create(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 = DerivedFontData::create(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 #ifndef NDEBUG
 234 String SimpleFontData::description() const
 235 {
 236     if (isSVGFont())
 237         return "[SVG font]";
 238     if (isCustomFont())
 239         return "[custom font]";
 240
 241     return platformData().description();
 242 }
 243 #endif
 244
 245 PassOwnPtr<SimpleFontData::DerivedFontData> SimpleFontData::DerivedFontData::create(bool forCustomFont)
 246 {
 247     return adoptPtr(new DerivedFontData(forCustomFont));
 248 }
 249
 250 SimpleFontData::DerivedFontData::~DerivedFontData()
 251 {
 252     if (!forCustomFont)
 253         return;
 254
 255     if (smallCaps)
 256         GlyphPageTreeNode::pruneTreeCustomFontData(smallCaps.get());
 257     if (emphasisMark)
 258         GlyphPageTreeNode::pruneTreeCustomFontData(emphasisMark.get());
 259     if (brokenIdeograph)
 260         GlyphPageTreeNode::pruneTreeCustomFontData(brokenIdeograph.get());
 261     if (verticalRightOrientation)
 262         GlyphPageTreeNode::pruneTreeCustomFontData(verticalRightOrientation.get());
 263     if (uprightOrientation)
 264         GlyphPageTreeNode::pruneTreeCustomFontData(uprightOrientation.get());
 265 #if PLATFORM(MAC)
 266     if (compositeFontReferences) {
 267         CFDictionaryRef dictionary = CFDictionaryRef(compositeFontReferences.get());
 268         CFIndex count = CFDictionaryGetCount(dictionary);
 269         if (count > 0) {
 270             Vector<SimpleFontData*, 2> stash(count);
 271             SimpleFontData** fonts = stash.data();
 272             CFDictionaryGetKeysAndValues(dictionary, 0, (const void **)fonts);
 273             while (count-- > 0 && *fonts) {
 274                 OwnPtr<SimpleFontData> afont = adoptPtr(*fonts++);
 275                 GlyphPageTreeNode::pruneTreeCustomFontData(afont.get());
 276             }
 277         }
 278     }
 279 #endif
 280 }
 281
 282 } // namespace WebCore