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
  36 #if ENABLE(SVG_FONTS)
  37 #include "SVGFontData.h"
  38 #include "SVGFontElement.h"
  39 #include "SVGFontFaceElement.h"
  40 #include "SVGGlyphElement.h"
  41 #endif
  42
  43 #include <wtf/MathExtras.h>
  44 #include <wtf/UnusedParam.h>
  45
  46 using namespace std;
  47
  48 namespace WebCore {
  49
  50 SimpleFontData::SimpleFontData(const FontPlatformData& platformData, bool isCustomFont, bool isLoading)
  51     : m_maxCharWidth(-1)
  52     , m_avgCharWidth(-1)
  53     , m_orientation(platformData.orientation())
  54     , m_platformData(platformData)
  55     , m_treatAsFixedPitch(false)
  56     , m_isCustomFont(isCustomFont)
  57     , m_isLoading(isLoading)
  58     , m_isBrokenIdeographFont(false)
  59 {
  60     platformInit();
  61     platformGlyphInit();
  62     platformCharWidthInit();
  63 }
  64
  65 #if ENABLE(SVG_FONTS)
  66 SimpleFontData::SimpleFontData(PassOwnPtr<SVGFontData> svgFontData, int size, bool syntheticBold, bool syntheticItalic)
  67     : m_orientation(Horizontal)
  68     , m_platformData(FontPlatformData(size, syntheticBold, syntheticItalic))
  69     , m_treatAsFixedPitch(false)
  70     , m_svgFontData(svgFontData)
  71     , m_isCustomFont(true)
  72     , m_isLoading(false)
  73     , m_isBrokenIdeographFont(false)
  74 {
  75     SVGFontFaceElement* svgFontFaceElement = m_svgFontData->svgFontFaceElement();
  76     unsigned unitsPerEm = svgFontFaceElement->unitsPerEm();
  77
  78     float scale = size;
  79     if (unitsPerEm)
  80         scale /= unitsPerEm;
  81
  82     float xHeight = svgFontFaceElement->xHeight() * scale;
  83     float ascent = svgFontFaceElement->ascent() * scale;
  84     float descent = svgFontFaceElement->descent() * scale;
  85     float lineGap = 0.1f * size;
  86
  87     SVGFontElement* associatedFontElement = svgFontFaceElement->associatedFontElement();
  88     if (!xHeight) {
  89         // Fallback if x_heightAttr is not specified for the font element.
  90         Vector<SVGGlyphIdentifier> letterXGlyphs;
  91         associatedFontElement->getGlyphIdentifiersForString(String("x", 1), letterXGlyphs);
  92         xHeight = letterXGlyphs.isEmpty() ? 2 * ascent / 3 : letterXGlyphs.first().horizontalAdvanceX * scale;
  93     }
  94
  95     m_fontMetrics.setUnitsPerEm(unitsPerEm);
  96     m_fontMetrics.setAscent(ascent);
  97     m_fontMetrics.setDescent(descent);
  98     m_fontMetrics.setLineGap(lineGap);
  99     m_fontMetrics.setLineSpacing(roundf(ascent) + roundf(descent) + roundf(lineGap));
 100     m_fontMetrics.setXHeight(xHeight);
 101
 102     Vector<SVGGlyphIdentifier> spaceGlyphs;
 103     associatedFontElement->getGlyphIdentifiersForString(String(" ", 1), spaceGlyphs);
 104     m_spaceWidth = spaceGlyphs.isEmpty() ? xHeight : spaceGlyphs.first().horizontalAdvanceX * scale;
 105
 106     Vector<SVGGlyphIdentifier> numeralZeroGlyphs;
 107     associatedFontElement->getGlyphIdentifiersForString(String("0", 1), numeralZeroGlyphs);
 108     m_avgCharWidth = numeralZeroGlyphs.isEmpty() ? m_spaceWidth : numeralZeroGlyphs.first().horizontalAdvanceX * scale;
 109
 110     Vector<SVGGlyphIdentifier> letterWGlyphs;
 111     associatedFontElement->getGlyphIdentifiersForString(String("W", 1), letterWGlyphs);
 112     m_maxCharWidth = letterWGlyphs.isEmpty() ? ascent : letterWGlyphs.first().horizontalAdvanceX * scale;
 113
 114     // FIXME: is there a way we can get the space glyph from the SVGGlyphIdentifier above?
 115     m_spaceGlyph = 0;
 116     m_zeroWidthSpaceGlyph = 0;
 117     determinePitch();
 118     m_missingGlyphData.fontData = this;
 119     m_missingGlyphData.glyph = 0;
 120 }
 121 #endif
 122
 123 #if !PLATFORM(QT)
 124 // Estimates of avgCharWidth and maxCharWidth for platforms that don't support accessing these values from the font.
 125 void SimpleFontData::initCharWidths()
 126 {
 127     GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
 128
 129     // Treat the width of a '0' as the avgCharWidth.
 130     if (m_avgCharWidth <= 0.f && glyphPageZero) {
 131         static const UChar32 digitZeroChar = '0';
 132         Glyph digitZeroGlyph = glyphPageZero->glyphDataForCharacter(digitZeroChar).glyph;
 133         if (digitZeroGlyph)
 134             m_avgCharWidth = widthForGlyph(digitZeroGlyph);
 135     }
 136
 137     // If we can't retrieve the width of a '0', fall back to the x height.
 138     if (m_avgCharWidth <= 0.f)
 139         m_avgCharWidth = m_fontMetrics.xHeight();
 140
 141     if (m_maxCharWidth <= 0.f)
 142         m_maxCharWidth = max(m_avgCharWidth, m_fontMetrics.floatAscent());
 143 }
 144
 145 void SimpleFontData::platformGlyphInit()
 146 {
 147     GlyphPage* glyphPageZero = GlyphPageTreeNode::getRootChild(this, 0)->page();
 148     if (!glyphPageZero) {
 149         LOG_ERROR("Failed to get glyph page zero.");
 150         m_spaceGlyph = 0;
 151         m_spaceWidth = 0;
 152         determinePitch();
 153         m_zeroWidthSpaceGlyph = 0;
 154         m_missingGlyphData.fontData = this;
 155         m_missingGlyphData.glyph = 0;
 156         return;
 157     }
 158
 159     m_zeroWidthSpaceGlyph = glyphPageZero->glyphDataForCharacter(0).glyph;
 160
 161     // Nasty hack to determine if we should round or ceil space widths.
 162     // If the font is monospace or fake monospace we ceil to ensure that
 163     // every character and the space are the same width.  Otherwise we round.
 164     m_spaceGlyph = glyphPageZero->glyphDataForCharacter(' ').glyph;
 165     float width = widthForGlyph(m_spaceGlyph);
 166     m_spaceWidth = width;
 167     determinePitch();
 168
 169     // Force the glyph for ZERO WIDTH SPACE to have zero width, unless it is shared with SPACE.
 170     // Helvetica is an example of a non-zero width ZERO WIDTH SPACE glyph.
 171     // See <http://bugs.webkit.org/show_bug.cgi?id=13178>
 172     // Ask for the glyph for 0 to avoid paging in ZERO WIDTH SPACE. Control characters, including 0,
 173     // are mapped to the ZERO WIDTH SPACE glyph.
 174     if (m_zeroWidthSpaceGlyph == m_spaceGlyph) {
 175         m_zeroWidthSpaceGlyph = 0;
 176         LOG_ERROR("Font maps SPACE and ZERO WIDTH SPACE to the same glyph. Glyph width will not be overridden.");
 177     }
 178
 179     m_missingGlyphData.fontData = this;
 180     m_missingGlyphData.glyph = 0;
 181 }
 182 #endif
 183
 184 SimpleFontData::~SimpleFontData()
 185 {
 186 #if ENABLE(SVG_FONTS)
 187     if (!m_svgFontData || !m_svgFontData->svgFontFaceElement())
 188 #endif
 189         platformDestroy();
 190
 191     if (!isCustomFont())
 192         GlyphPageTreeNode::pruneTreeFontData(this);
 193 }
 194
 195 const SimpleFontData* SimpleFontData::fontDataForCharacter(UChar32) const
 196 {
 197     return this;
 198 }
 199
 200 bool SimpleFontData::isSegmented() const
 201 {
 202     return false;
 203 }
 204
 205 SimpleFontData* SimpleFontData::brokenIdeographFontData() const
 206 {
 207     if (!m_derivedFontData)
 208         m_derivedFontData = DerivedFontData::create(isCustomFont());
 209     if (!m_derivedFontData->brokenIdeograph) {
 210         m_derivedFontData->brokenIdeograph = new SimpleFontData(m_platformData, isCustomFont(), false);
 211         m_derivedFontData->brokenIdeograph->m_orientation = Vertical;
 212         m_derivedFontData->brokenIdeograph->m_isBrokenIdeographFont = true;
 213     }
 214     return m_derivedFontData->brokenIdeograph.get();
 215 }
 216
 217 #ifndef NDEBUG
 218 String SimpleFontData::description() const
 219 {
 220     if (isSVGFont())
 221         return "[SVG font]";
 222     if (isCustomFont())
 223         return "[custom font]";
 224
 225     return platformData().description();
 226 }
 227 #endif
 228
 229 PassOwnPtr<SimpleFontData::DerivedFontData> SimpleFontData::DerivedFontData::create(bool forCustomFont)
 230 {
 231     return adoptPtr(new DerivedFontData(forCustomFont));
 232 }
 233
 234 SimpleFontData::DerivedFontData::~DerivedFontData()
 235 {
 236     if (!forCustomFont)
 237         return;
 238
 239     if (smallCaps)
 240         GlyphPageTreeNode::pruneTreeCustomFontData(smallCaps.get());
 241     if (emphasisMark)
 242         GlyphPageTreeNode::pruneTreeCustomFontData(emphasisMark.get());
 243     if (brokenIdeograph)
 244         GlyphPageTreeNode::pruneTreeCustomFontData(brokenIdeograph.get());
 245 }
 246
 247 } // namespace WebCore