blob: f736b52867fcd744493a643c250d152edcd8f4c6 [file] [log] [blame]
/*
* Copyright (C) 2000 Lars Knoll (knoll@kde.org)
* (C) 2000 Antti Koivisto (koivisto@kde.org)
* (C) 2000 Dirk Mueller (mueller@kde.org)
* Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
* Copyright (C) 2007 Nicholas Shanks <webkit@nickshanks.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIother.m_ If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USm_
*
*/
#ifndef FontDescription_h
#define FontDescription_h
#include "platform/FontFamilyNames.h"
#include "platform/fonts/FixedPitchFontType.h"
#include "platform/fonts/FontCacheKey.h"
#include "platform/fonts/FontFamily.h"
#include "platform/fonts/FontFeatureSettings.h"
#include "platform/fonts/FontOrientation.h"
#include "platform/fonts/FontSmoothingMode.h"
#include "platform/fonts/FontTraits.h"
#include "platform/fonts/FontWidthVariant.h"
#include "platform/fonts/TextRenderingMode.h"
#include "platform/fonts/TypesettingFeatures.h"
#include "platform/text/NonCJKGlyphOrientation.h"
#include "wtf/MathExtras.h"
#include "wtf/RefPtr.h"
#include <unicode/uscript.h>
namespace blink {
class PLATFORM_EXPORT FontDescription {
public:
enum GenericFamilyType { NoFamily, StandardFamily, SerifFamily, SansSerifFamily,
MonospaceFamily, CursiveFamily, FantasyFamily, PictographFamily };
enum Kerning { AutoKerning, NormalKerning, NoneKerning };
enum LigaturesState { NormalLigaturesState, DisabledLigaturesState, EnabledLigaturesState };
FontDescription()
: m_locale("en")
, m_specifiedSize(0)
, m_computedSize(0)
, m_letterSpacing(0)
, m_wordSpacing(0)
, m_orientation(Horizontal)
, m_nonCJKGlyphOrientation(NonCJKGlyphOrientationVerticalRight)
, m_widthVariant(RegularWidth)
, m_style(FontStyleNormal)
, m_variant(FontVariantNormal)
, m_isAbsoluteSize(false)
, m_weight(FontWeightNormal)
, m_stretch(FontStretchNormal)
, m_genericFamily(NoFamily)
, m_kerning(AutoKerning)
, m_commonLigaturesState(NormalLigaturesState)
, m_discretionaryLigaturesState(NormalLigaturesState)
, m_historicalLigaturesState(NormalLigaturesState)
, m_contextualLigaturesState(NormalLigaturesState)
, m_keywordSize(0)
, m_fontSmoothing(AutoSmoothing)
, m_textRendering(AutoTextRendering)
, m_script(USCRIPT_COMMON)
, m_syntheticBold(false)
, m_syntheticItalic(false)
, m_subpixelTextPosition(s_useSubpixelTextPositioning)
, m_typesettingFeatures(s_defaultTypesettingFeatures)
{
}
bool operator==(const FontDescription&) const;
bool operator!=(const FontDescription& other) const { return !(*this == other); }
struct VariantLigatures {
VariantLigatures()
: common(NormalLigaturesState)
, discretionary(NormalLigaturesState)
, historical(NormalLigaturesState)
, contextual(NormalLigaturesState)
{
}
unsigned common : 2;
unsigned discretionary : 2;
unsigned historical : 2;
unsigned contextual : 2;
};
struct Size {
Size(unsigned keyword, float value, bool isAbsolute)
: keyword(keyword)
, isAbsolute(isAbsolute)
, value(value)
{
}
unsigned keyword : 4; // FontDescription::keywordSize
unsigned isAbsolute : 1; // FontDescription::isAbsoluteSize
float value;
};
struct FamilyDescription {
FamilyDescription(GenericFamilyType genericFamily) : genericFamily(genericFamily) { }
FamilyDescription(GenericFamilyType genericFamily, const FontFamily& family)
: genericFamily(genericFamily)
, family(family)
{
}
GenericFamilyType genericFamily;
FontFamily family;
};
const FontFamily& family() const { return m_familyList; }
FamilyDescription familyDescription() const { return FamilyDescription(genericFamily(), family()); }
FontFamily& firstFamily() { return m_familyList; }
Size size() const { return Size(m_keywordSize, m_specifiedSize, m_isAbsoluteSize); }
float specifiedSize() const { return m_specifiedSize; }
float computedSize() const { return m_computedSize; }
FontStyle style() const { return static_cast<FontStyle>(m_style); }
int computedPixelSize() const { return int(m_computedSize + 0.5f); }
FontVariant variant() const { return static_cast<FontVariant>(m_variant); }
bool isAbsoluteSize() const { return m_isAbsoluteSize; }
FontWeight weight() const { return static_cast<FontWeight>(m_weight); }
FontStretch stretch() const { return static_cast<FontStretch>(m_stretch); }
static FontWeight lighterWeight(FontWeight);
static FontWeight bolderWeight(FontWeight);
static Size largerSize(const Size&);
static Size smallerSize(const Size&);
GenericFamilyType genericFamily() const { return static_cast<GenericFamilyType>(m_genericFamily); }
// only use fixed default size when there is only one font family, and that family is "monospace"
FixedPitchFontType fixedPitchFontType() const
{
if (genericFamily() == MonospaceFamily && !family().next() && family().family() == FontFamilyNames::webkit_monospace)
return FixedPitchFont;
return NonFixedPitchFont;
}
Kerning kerning() const { return static_cast<Kerning>(m_kerning); }
VariantLigatures variantLigatures() const;
LigaturesState commonLigaturesState() const { return static_cast<LigaturesState>(m_commonLigaturesState); }
LigaturesState discretionaryLigaturesState() const { return static_cast<LigaturesState>(m_discretionaryLigaturesState); }
LigaturesState historicalLigaturesState() const { return static_cast<LigaturesState>(m_historicalLigaturesState); }
LigaturesState contextualLigaturesState() const { return static_cast<LigaturesState>(m_contextualLigaturesState); }
unsigned keywordSize() const { return m_keywordSize; }
FontSmoothingMode fontSmoothing() const { return static_cast<FontSmoothingMode>(m_fontSmoothing); }
TextRenderingMode textRendering() const { return static_cast<TextRenderingMode>(m_textRendering); }
UScriptCode script() const { return static_cast<UScriptCode>(m_script); }
const String& locale() const { return m_locale; }
bool isSyntheticBold() const { return m_syntheticBold; }
bool isSyntheticItalic() const { return m_syntheticItalic; }
bool useSubpixelPositioning() const { return m_subpixelTextPosition; }
FontTraits traits() const;
float wordSpacing() const { return m_wordSpacing; }
float letterSpacing() const { return m_letterSpacing; }
FontOrientation orientation() const { return static_cast<FontOrientation>(m_orientation); }
NonCJKGlyphOrientation nonCJKGlyphOrientation() const { return static_cast<NonCJKGlyphOrientation>(m_nonCJKGlyphOrientation); }
FontWidthVariant widthVariant() const { return static_cast<FontWidthVariant>(m_widthVariant); }
FontFeatureSettings* featureSettings() const { return m_featureSettings.get(); }
float effectiveFontSize() const; // Returns either the computedSize or the computedPixelSize
FontCacheKey cacheKey(const FontFaceCreationParams&, FontTraits desiredTraits = FontTraits(0)) const;
void setFamily(const FontFamily& family) { m_familyList = family; }
void setComputedSize(float s) { m_computedSize = clampTo<float>(s); }
void setSpecifiedSize(float s) { m_specifiedSize = clampTo<float>(s); }
void setStyle(FontStyle i) { m_style = i; }
void setVariant(FontVariant c) { m_variant = c; }
void setVariantLigatures(const VariantLigatures&);
void setIsAbsoluteSize(bool s) { m_isAbsoluteSize = s; }
void setWeight(FontWeight w) { m_weight = w; }
void setStretch(FontStretch s) { m_stretch = s; }
void setGenericFamily(GenericFamilyType genericFamily) { m_genericFamily = genericFamily; }
void setKerning(Kerning kerning) { m_kerning = kerning; updateTypesettingFeatures(); }
void setKeywordSize(unsigned s) { m_keywordSize = s; }
void setFontSmoothing(FontSmoothingMode smoothing) { m_fontSmoothing = smoothing; }
void setTextRendering(TextRenderingMode rendering) { m_textRendering = rendering; updateTypesettingFeatures(); }
void setOrientation(FontOrientation orientation) { m_orientation = orientation; }
void setNonCJKGlyphOrientation(NonCJKGlyphOrientation orientation) { m_nonCJKGlyphOrientation = orientation; }
void setWidthVariant(FontWidthVariant widthVariant) { m_widthVariant = widthVariant; }
void setScript(UScriptCode s) { m_script = s; }
void setLocale(const String& locale) { m_locale = locale; }
void setSyntheticBold(bool syntheticBold) { m_syntheticBold = syntheticBold; }
void setSyntheticItalic(bool syntheticItalic) { m_syntheticItalic = syntheticItalic; }
void setFeatureSettings(PassRefPtr<FontFeatureSettings> settings) { m_featureSettings = settings; }
void setTraits(FontTraits);
void setWordSpacing(float s) { m_wordSpacing = s; }
void setLetterSpacing(float s) { m_letterSpacing = s; }
TypesettingFeatures typesettingFeatures() const { return static_cast<TypesettingFeatures>(m_typesettingFeatures); }
static void setSubpixelPositioning(bool b) { s_useSubpixelTextPositioning = b; }
static bool subpixelPositioning() { return s_useSubpixelTextPositioning; }
static void setDefaultTypesettingFeatures(TypesettingFeatures);
static TypesettingFeatures defaultTypesettingFeatures();
private:
FontFamily m_familyList; // The list of font families to be used.
RefPtr<FontFeatureSettings> m_featureSettings;
String m_locale;
void updateTypesettingFeatures() const;
float m_specifiedSize; // Specified CSS value. Independent of rendering issues such as integer
// rounding, minimum font sizes, and zooming.
float m_computedSize; // Computed size adjusted for the minimum font size and the zoom factor.
float m_letterSpacing;
float m_wordSpacing;
unsigned m_orientation : 1; // FontOrientation - Whether the font is rendering on a horizontal line or a vertical line.
unsigned m_nonCJKGlyphOrientation : 1; // NonCJKGlyphOrientation - Only used by vertical text. Determines the default orientation for non-ideograph glyphs.
unsigned m_widthVariant : 2; // FontWidthVariant
unsigned m_style : 1; // FontStyle
unsigned m_variant : 1; // FontVariant
unsigned m_isAbsoluteSize : 1; // Whether or not CSS specified an explicit size
// (logical sizes like "medium" don't count).
unsigned m_weight : 4; // FontWeight
unsigned m_stretch : 4; // FontStretch
unsigned m_genericFamily : 3; // GenericFamilyType
unsigned m_kerning : 2; // Kerning
unsigned m_commonLigaturesState : 2;
unsigned m_discretionaryLigaturesState : 2;
unsigned m_historicalLigaturesState : 2;
unsigned m_contextualLigaturesState : 2;
unsigned m_keywordSize : 4; // We cache whether or not a font is currently represented by a CSS keyword (e.g., medium). If so,
// then we can accurately translate across different generic families to adjust for different preference settings
// (e.g., 13px monospace vs. 16px everything else). Sizes are 1-8 (like the HTML size values for <font>).
unsigned m_fontSmoothing : 2; // FontSmoothingMode
unsigned m_textRendering : 2; // TextRenderingMode
unsigned m_script : 7; // Used to help choose an appropriate font for generic font families.
unsigned m_syntheticBold : 1;
unsigned m_syntheticItalic : 1;
unsigned m_subpixelTextPosition : 1;
mutable unsigned m_typesettingFeatures : 2; // TypesettingFeatures
static TypesettingFeatures s_defaultTypesettingFeatures;
static bool s_useSubpixelTextPositioning;
};
inline bool FontDescription::operator==(const FontDescription& other) const
{
return m_familyList == other.m_familyList
&& m_specifiedSize == other.m_specifiedSize
&& m_computedSize == other.m_computedSize
&& m_letterSpacing == other.m_letterSpacing
&& m_wordSpacing == other.m_wordSpacing
&& m_style == other.m_style
&& m_variant == other.m_variant
&& m_isAbsoluteSize == other.m_isAbsoluteSize
&& m_weight == other.m_weight
&& m_stretch == other.m_stretch
&& m_genericFamily == other.m_genericFamily
&& m_kerning == other.m_kerning
&& m_commonLigaturesState == other.m_commonLigaturesState
&& m_discretionaryLigaturesState == other.m_discretionaryLigaturesState
&& m_historicalLigaturesState == other.m_historicalLigaturesState
&& m_contextualLigaturesState == other.m_contextualLigaturesState
&& m_keywordSize == other.m_keywordSize
&& m_fontSmoothing == other.m_fontSmoothing
&& m_textRendering == other.m_textRendering
&& m_orientation == other.m_orientation
&& m_nonCJKGlyphOrientation == other.m_nonCJKGlyphOrientation
&& m_widthVariant == other.m_widthVariant
&& m_script == other.m_script
&& m_syntheticBold == other.m_syntheticBold
&& m_syntheticItalic == other.m_syntheticItalic
&& m_featureSettings == other.m_featureSettings
&& m_subpixelTextPosition == other.m_subpixelTextPosition;
}
} // namespace blink
#endif