blob: 65e471f866e9016ec83052e73cd4fcc157c68b1b [file] [log] [blame]
/*
* Copyright (C) 2006-2018 Apple Inc. All rights reserved.
* Copyright (C) 2006 Michael Emmel mike.emmel@gmail.com
* Copyright (C) 2007 Holger Hans Peter Freyther
* Copyright (C) 2007 Pioneer Research Center USA, Inc.
* Copyright (C) 2010, 2011 Brent Fulgham <bfulgham@webkit.org>
*
* 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.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
*/
#pragma once
#include "TextFlags.h"
#include <wtf/Forward.h>
#include <wtf/RetainPtr.h>
#if PLATFORM(WIN)
#include "COMPtr.h"
#include "SharedGDIObject.h"
#endif
#if USE(CAIRO)
#include "RefPtrCairo.h"
#endif
#if USE(FREETYPE)
#include "FcUniquePtr.h"
#include "HbUniquePtr.h"
#include "RefPtrFontconfig.h"
#include <memory>
#endif
#if USE(APPKIT)
OBJC_CLASS NSFont;
#endif
#if PLATFORM(COCOA)
typedef const struct __CTFont* CTFontRef;
#endif
#if USE(CG)
#include <CoreGraphics/CoreGraphics.h>
#endif
#if PLATFORM(WIN)
#include <wtf/win/GDIObject.h>
typedef struct HFONT__* HFONT;
interface IDWriteFont;
interface IDWriteFontFace;
#endif
#if USE(DIRECT2D)
#include <dwrite_3.h>
#endif
namespace WebCore {
class FontDescription;
class SharedBuffer;
// This class is conceptually immutable. Once created, no instances should ever change (in an observable way).
class FontPlatformData {
WTF_MAKE_FAST_ALLOCATED;
public:
FontPlatformData(WTF::HashTableDeletedValueType);
FontPlatformData();
FontPlatformData(float size, bool syntheticBold, bool syntheticOblique, FontOrientation = FontOrientation::Horizontal, FontWidthVariant = FontWidthVariant::RegularWidth, TextRenderingMode = TextRenderingMode::AutoTextRendering);
#if PLATFORM(COCOA)
WEBCORE_EXPORT FontPlatformData(CTFontRef, float size, bool syntheticBold = false, bool syntheticOblique = false, FontOrientation = FontOrientation::Horizontal, FontWidthVariant = FontWidthVariant::RegularWidth, TextRenderingMode = TextRenderingMode::AutoTextRendering);
#endif
static FontPlatformData cloneWithOrientation(const FontPlatformData&, FontOrientation);
static FontPlatformData cloneWithSyntheticOblique(const FontPlatformData&, bool);
static FontPlatformData cloneWithSize(const FontPlatformData&, float);
#if USE(CG) && PLATFORM(WIN)
FontPlatformData(CGFontRef, float size, bool syntheticBold, bool syntheticOblique, FontOrientation, FontWidthVariant, TextRenderingMode);
#endif
#if PLATFORM(WIN)
FontPlatformData(GDIObject<HFONT>, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
#endif
#if PLATFORM(WIN) && USE(CG)
FontPlatformData(GDIObject<HFONT>, CGFontRef, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
#endif
#if PLATFORM(WIN) && USE(DIRECT2D)
FontPlatformData(GDIObject<HFONT>&&, IDWriteFont*, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
#endif
#if PLATFORM(WIN) && USE(CAIRO)
FontPlatformData(GDIObject<HFONT>, cairo_font_face_t*, float size, bool bold, bool italic);
#endif
#if USE(FREETYPE)
FontPlatformData(cairo_font_face_t*, FcPattern*, float size, bool fixedWidth, bool syntheticBold, bool syntheticOblique, FontOrientation);
#endif
#if PLATFORM(WIN)
HFONT hfont() const { return m_font ? m_font->get() : 0; }
bool useGDI() const { return m_useGDI; }
#endif
#if PLATFORM(COCOA)
CTFontRef font() const { return m_font.get(); }
WEBCORE_EXPORT CTFontRef registeredFont() const; // Returns nullptr iff the font is not registered, such as web fonts (otherwise returns font()).
CTFontRef ctFont() const;
static RetainPtr<CFTypeRef> objectForEqualityCheck(CTFontRef);
RetainPtr<CFTypeRef> objectForEqualityCheck() const;
bool hasCustomTracking() const { return isSystemFont(); }
#endif
#if PLATFORM(WIN) || PLATFORM(COCOA)
bool isSystemFont() const { return m_isSystemFont; }
#endif
bool hasVariations() const { return m_hasVariations; }
#if USE(CG) && PLATFORM(WIN)
CGFontRef cgFont() const { return m_cgFont.get(); }
#endif
#if USE(DIRECT2D)
IDWriteFont* dwFont() const { return m_dwFont.get(); }
IDWriteFontFace* dwFontFace() const { return m_dwFontFace.get(); }
static HRESULT createFallbackFont(const LOGFONT&, IDWriteFont**);
static HRESULT createFallbackFont(HFONT, IDWriteFont**);
#endif
bool isFixedPitch() const;
float size() const { return m_size; }
bool syntheticBold() const { return m_syntheticBold; }
bool syntheticOblique() const { return m_syntheticOblique; }
bool isColorBitmapFont() const { return m_isColorBitmapFont; }
FontOrientation orientation() const { return m_orientation; }
FontWidthVariant widthVariant() const { return m_widthVariant; }
TextRenderingMode textRenderingMode() const { return m_textRenderingMode; }
bool isForTextCombine() const { return widthVariant() != FontWidthVariant::RegularWidth; } // Keep in sync with callers of FontDescription::setWidthVariant().
#if USE(CAIRO)
cairo_scaled_font_t* scaledFont() const { return m_scaledFont.get(); }
#endif
#if USE(FREETYPE)
#if USE(HARFBUZZ) && !ENABLE(OPENTYPE_MATH)
HbUniquePtr<hb_font_t> createOpenTypeMathHarfBuzzFont() const;
#endif
bool hasCompatibleCharmap() const;
FcPattern* fcPattern() const;
bool isFixedWidth() const { return m_fixedWidth; }
#endif
unsigned hash() const;
bool operator==(const FontPlatformData& other) const
{
return platformIsEqual(other)
&& m_isHashTableDeletedValue == other.m_isHashTableDeletedValue
&& m_size == other.m_size
&& m_syntheticBold == other.m_syntheticBold
&& m_syntheticOblique == other.m_syntheticOblique
&& m_isColorBitmapFont == other.m_isColorBitmapFont
&& m_orientation == other.m_orientation
&& m_widthVariant == other.m_widthVariant
&& m_textRenderingMode == other.m_textRenderingMode;
}
bool isHashTableDeletedValue() const
{
return m_isHashTableDeletedValue;
}
bool isEmoji() const
{
#if PLATFORM(IOS_FAMILY)
return m_isEmoji;
#else
return false;
#endif
}
#if PLATFORM(COCOA) || PLATFORM(WIN) || USE(FREETYPE)
RefPtr<SharedBuffer> openTypeTable(uint32_t table) const;
#endif
#if !LOG_DISABLED
String description() const;
#endif
private:
bool platformIsEqual(const FontPlatformData&) const;
#if PLATFORM(COCOA)
CGFloat ctFontSize() const;
#endif
#if PLATFORM(WIN)
void platformDataInit(HFONT, float size, HDC, WCHAR* faceName);
#endif
#if USE(FREETYPE)
void buildScaledFont(cairo_font_face_t*);
#endif
#if PLATFORM(COCOA)
// FIXME: Get rid of one of these. These two fonts are subtly different, and it is not obvious which one to use where.
RetainPtr<CTFontRef> m_font;
mutable RetainPtr<CTFontRef> m_ctFont;
#elif PLATFORM(WIN)
RefPtr<SharedGDIObject<HFONT>> m_font;
#endif
#if USE(CG) && PLATFORM(WIN)
RetainPtr<CGFontRef> m_cgFont;
#endif
#if USE(DIRECT2D)
COMPtr<IDWriteFont> m_dwFont;
COMPtr<IDWriteFontFace> m_dwFontFace;
#endif
#if USE(CAIRO)
RefPtr<cairo_scaled_font_t> m_scaledFont;
#endif
#if USE(FREETYPE)
RefPtr<FcPattern> m_pattern;
#endif
// The values below are common to all ports
// FIXME: If they're common to all ports, they should move to Font
float m_size { 0 };
FontOrientation m_orientation { FontOrientation::Horizontal };
FontWidthVariant m_widthVariant { FontWidthVariant::RegularWidth };
TextRenderingMode m_textRenderingMode { TextRenderingMode::AutoTextRendering };
bool m_syntheticBold { false };
bool m_syntheticOblique { false };
bool m_isColorBitmapFont { false };
bool m_isHashTableDeletedValue { false };
bool m_isSystemFont { false };
bool m_hasVariations { false };
// The values above are common to all ports
#if PLATFORM(IOS_FAMILY)
bool m_isEmoji { false };
#endif
#if PLATFORM(WIN)
bool m_useGDI { false };
#endif
#if USE(FREETYPE)
bool m_fixedWidth { false };
#endif
};
#if USE(APPKIT) && defined(__OBJC__)
// NSFonts and CTFontRefs are toll-free-bridged.
inline CTFontRef toCTFont(NSFont *font)
{
return (__bridge CTFontRef)font;
}
inline NSFont *toNSFont(CTFontRef font)
{
return (__bridge NSFont *)font;
}
#endif
#if USE(CG)
class ScopedTextMatrix {
public:
ScopedTextMatrix(CGAffineTransform newMatrix, CGContextRef context)
: m_context(context)
, m_textMatrix(CGContextGetTextMatrix(context))
{
CGContextSetTextMatrix(m_context, newMatrix);
}
~ScopedTextMatrix()
{
CGContextSetTextMatrix(m_context, m_textMatrix);
}
CGAffineTransform savedMatrix() const
{
return m_textMatrix;
}
private:
CGContextRef m_context;
CGAffineTransform m_textMatrix;
};
#endif
} // namespace WebCore