[Cocoa] System fonts do not get correct tracking
[WebKit-https.git] / Source / WebCore / platform / graphics / FontPlatformData.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2010, 2013 Apple Inc.
3  * Copyright (C) 2006 Michael Emmel mike.emmel@gmail.com
4  * Copyright (C) 2007 Holger Hans Peter Freyther
5  * Copyright (C) 2007 Pioneer Research Center USA, Inc.
6  * Copyright (C) 2010, 2011 Brent Fulgham <bfulgham@webkit.org>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 // FIXME: This is temporary until all ports switch to using this file.
26 #if PLATFORM(EFL) || PLATFORM(GTK)
27 #include "freetype/FontPlatformData.h"
28 #else
29
30 #ifndef FontPlatformData_h
31 #define FontPlatformData_h
32
33 #include "FontOrientation.h"
34 #include "FontWidthVariant.h"
35
36 #if PLATFORM(WIN)
37 #include "SharedGDIObject.h"
38 #endif
39
40 #if USE(CAIRO)
41 #include <wtf/HashFunctions.h>
42 #include <cairo.h>
43 #endif
44
45 #if PLATFORM(COCOA)
46 #if PLATFORM(IOS)
47 #import <CoreGraphics/CoreGraphics.h>
48 #endif
49 #if USE(APPKIT)
50 OBJC_CLASS NSFont;
51 #endif
52
53 typedef const struct __CTFont* CTFontRef;
54
55 #endif
56
57 #if USE(CG)
58 typedef struct CGFont* CGFontRef;
59 #endif
60
61 #include <wtf/Forward.h>
62 #include <wtf/PassRefPtr.h>
63 #include <wtf/RefCounted.h>
64 #include <wtf/RetainPtr.h>
65 #include <wtf/text/StringImpl.h>
66
67 #if PLATFORM(WIN)
68 #include <wtf/win/GDIObject.h>
69 typedef struct HFONT__* HFONT;
70 #endif
71
72
73 namespace WebCore {
74
75 class FontDescription;
76 class SharedBuffer;
77
78 class FontPlatformData {
79     WTF_MAKE_FAST_ALLOCATED;
80 public:
81     FontPlatformData(WTF::HashTableDeletedValueType);
82     FontPlatformData();
83     FontPlatformData(const FontPlatformData&);
84     FontPlatformData(const FontDescription&, const AtomicString& family);
85     FontPlatformData(float size, bool syntheticBold, bool syntheticOblique, FontOrientation = Horizontal, FontWidthVariant = RegularWidth);
86
87 #if PLATFORM(COCOA)
88     WEBCORE_EXPORT FontPlatformData(CTFontRef, float size, bool syntheticBold = false, bool syntheticOblique = false, FontOrientation = Horizontal, FontWidthVariant = RegularWidth);
89 #if USE(APPKIT)
90     // FIXME: Remove this when all NSFont usage is removed.
91     WEBCORE_EXPORT FontPlatformData(NSFont *, float size, bool syntheticBold = false, bool syntheticOblique = false, FontOrientation = Horizontal, FontWidthVariant = RegularWidth);
92 #endif
93 #endif
94
95 #if USE(CG)
96     FontPlatformData(CGFontRef, float size, bool syntheticBold, bool syntheticOblique, FontOrientation, FontWidthVariant);
97 #endif
98
99 #if PLATFORM(WIN)
100     FontPlatformData(GDIObject<HFONT>, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
101
102 #if USE(CG)
103     FontPlatformData(GDIObject<HFONT>, CGFontRef, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
104 #elif USE(CAIRO)
105     FontPlatformData(GDIObject<HFONT>, cairo_font_face_t*, float size, bool bold, bool italic);
106 #endif
107 #endif
108
109     WEBCORE_EXPORT ~FontPlatformData();
110
111 #if PLATFORM(WIN)
112     HFONT hfont() const { return m_font ? m_font->get() : 0; }
113     bool useGDI() const { return m_useGDI; }
114 #elif PLATFORM(COCOA)
115     CTFontRef font() const { return m_font; }
116     void setFont(CTFontRef);
117
118     CTFontRef ctFont() const;
119     static RetainPtr<CFTypeRef> objectForEqualityCheck(CTFontRef);
120     RetainPtr<CFTypeRef> objectForEqualityCheck() const;
121
122     bool allowsLigatures() const;
123     bool roundsGlyphAdvances() const;
124
125 #if USE(APPKIT)
126     // FIXME: Remove this when all NSFont usage is removed.
127     NSFont *nsFont() const { return (NSFont *)m_font; }
128     void setNSFont(NSFont *font) { setFont((CTFontRef)font); }
129 #endif
130 #endif
131
132 #if USE(CG)
133     CGFontRef cgFont() const { return m_cgFont.get(); }
134 #endif
135
136     bool isFixedPitch() const;
137     float size() const { return m_size; }
138     void setSize(float size) { m_size = size; }
139     bool syntheticBold() const { return m_syntheticBold; }
140     bool syntheticOblique() const { return m_syntheticOblique; }
141     bool isColorBitmapFont() const { return m_isColorBitmapFont; }
142     bool isCompositeFontReference() const { return m_isCompositeFontReference; }
143     FontOrientation orientation() const { return m_orientation; }
144     FontWidthVariant widthVariant() const { return m_widthVariant; }
145
146     void setOrientation(FontOrientation orientation) { m_orientation = orientation; }
147
148 #if USE(CAIRO)
149     cairo_scaled_font_t* scaledFont() const { return m_scaledFont; }
150 #endif
151
152     unsigned hash() const
153     {
154 #if PLATFORM(WIN) && !USE(CAIRO)
155         return m_font ? m_font->hash() : 0;
156 #elif OS(DARWIN)
157 #if USE(APPKIT)
158         ASSERT(m_font || !m_cgFont);
159         uintptr_t hashCodes[3] = { (uintptr_t)m_font, m_widthVariant, static_cast<uintptr_t>(m_orientation << 2 | m_syntheticBold << 1 | m_syntheticOblique) };
160 #else
161         ASSERT(m_font || !m_cgFont || m_isEmoji);
162         uintptr_t hashCodes[3] = { static_cast<uintptr_t>(CFHash(m_font)), m_widthVariant, static_cast<uintptr_t>(m_isEmoji << 3 | m_orientation << 2 | m_syntheticBold << 1 | m_syntheticOblique) };
163 #endif // !PLATFORM(IOS)
164         return StringHasher::hashMemory<sizeof(hashCodes)>(hashCodes);
165 #elif USE(CAIRO)
166         return PtrHash<cairo_scaled_font_t*>::hash(m_scaledFont);
167 #endif
168     }
169
170     const FontPlatformData& operator=(const FontPlatformData&);
171
172     bool operator==(const FontPlatformData& other) const
173     {
174         return platformIsEqual(other)
175             && m_size == other.m_size
176             && m_syntheticBold == other.m_syntheticBold
177             && m_syntheticOblique == other.m_syntheticOblique
178             && m_isColorBitmapFont == other.m_isColorBitmapFont
179             && m_isCompositeFontReference == other.m_isCompositeFontReference
180             && m_orientation == other.m_orientation
181             && m_widthVariant == other.m_widthVariant;
182     }
183
184     bool isHashTableDeletedValue() const
185     {
186 #if PLATFORM(WIN) && !USE(CAIRO)
187         return m_font.isHashTableDeletedValue();
188 #elif PLATFORM(COCOA)
189         return m_font == hashTableDeletedFontValue();
190 #elif USE(CAIRO)
191         return m_scaledFont == hashTableDeletedFontValue();
192 #endif
193     }
194
195 #if PLATFORM(COCOA) || PLATFORM(WIN)
196     PassRefPtr<SharedBuffer> openTypeTable(uint32_t table) const;
197 #endif
198
199 #ifndef NDEBUG
200     String description() const;
201 #endif
202
203 private:
204     bool platformIsEqual(const FontPlatformData&) const;
205     void platformDataInit(const FontPlatformData&);
206     const FontPlatformData& platformDataAssign(const FontPlatformData&);
207 #if PLATFORM(COCOA)
208     static CTFontRef hashTableDeletedFontValue() { return reinterpret_cast<CTFontRef>(-1); }
209 #endif
210 #if PLATFORM(WIN)
211     void platformDataInit(HFONT, float size, HDC, WCHAR* faceName);
212 #endif
213 #if USE(CAIRO)
214     static cairo_scaled_font_t* hashTableDeletedFontValue() { return reinterpret_cast<cairo_scaled_font_t*>(-1); }
215 #endif
216
217 public:
218     bool m_syntheticBold { false };
219     bool m_syntheticOblique { false };
220     FontOrientation m_orientation { Horizontal };
221 #if PLATFORM(IOS)
222     bool m_isEmoji { false };
223 #endif
224     float m_size { 0 };
225     FontWidthVariant m_widthVariant { RegularWidth };
226
227 private:
228 #if PLATFORM(COCOA)
229     // FIXME: Get rid of one of these. These two fonts are subtly different, and it is not obvious which one to use where.
230     CTFontRef m_font { nullptr };
231     mutable RetainPtr<CTFontRef> m_ctFont;
232 #elif PLATFORM(WIN)
233     RefPtr<SharedGDIObject<HFONT>> m_font;
234 #endif
235
236 #if USE(CG)
237     RetainPtr<CGFontRef> m_cgFont;
238 #endif
239 #if USE(CAIRO)
240     cairo_scaled_font_t* m_scaledFont { nullptr };
241 #endif
242
243     bool m_isColorBitmapFont { false };
244     bool m_isCompositeFontReference { false };
245
246 #if PLATFORM(WIN)
247     bool m_useGDI { false };
248 #endif
249 };
250
251 } // namespace WebCore
252
253 #endif // FontPlatformData_h
254
255 #endif