316acd8fbfacf4a602fdf2215a2ce11945e6b78e
[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 typedef UInt32 FMFont;
55 typedef FMFont ATSUFontID;
56 typedef UInt32 ATSFontRef;
57
58 #endif
59
60 #if USE(CG)
61 typedef struct CGFont* CGFontRef;
62 #endif
63
64 #include <wtf/Forward.h>
65 #include <wtf/PassRefPtr.h>
66 #include <wtf/RefCounted.h>
67 #include <wtf/RetainPtr.h>
68 #include <wtf/text/StringImpl.h>
69
70 #if PLATFORM(WIN)
71 #include <wtf/win/GDIObject.h>
72 typedef struct HFONT__* HFONT;
73 #endif
74
75
76 namespace WebCore {
77
78 class FontDescription;
79 class SharedBuffer;
80
81 class FontPlatformData {
82     WTF_MAKE_FAST_ALLOCATED;
83 public:
84     FontPlatformData(WTF::HashTableDeletedValueType);
85     FontPlatformData();
86     FontPlatformData(const FontPlatformData&);
87     FontPlatformData(const FontDescription&, const AtomicString& family);
88     FontPlatformData(float size, bool syntheticBold, bool syntheticOblique, FontOrientation = Horizontal, FontWidthVariant = RegularWidth);
89
90 #if PLATFORM(COCOA)
91     WEBCORE_EXPORT FontPlatformData(CTFontRef, float size, bool isPrinterFont = false, bool syntheticBold = false, bool syntheticOblique = false, FontOrientation = Horizontal, FontWidthVariant = RegularWidth);
92 #if USE(APPKIT)
93     // FIXME: Remove this when all NSFont usage is removed.
94     WEBCORE_EXPORT FontPlatformData(NSFont *, float size, bool isPrinterFont = false, bool syntheticBold = false, bool syntheticOblique = false, FontOrientation = Horizontal, FontWidthVariant = RegularWidth);
95 #endif
96 #endif
97
98 #if USE(CG)
99     FontPlatformData(CGFontRef, float size, bool syntheticBold, bool syntheticOblique, FontOrientation, FontWidthVariant);
100 #endif
101
102 #if PLATFORM(WIN)
103     FontPlatformData(GDIObject<HFONT>, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
104
105 #if USE(CG)
106     FontPlatformData(GDIObject<HFONT>, CGFontRef, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
107 #elif USE(CAIRO)
108     FontPlatformData(GDIObject<HFONT>, cairo_font_face_t*, float size, bool bold, bool italic);
109 #endif
110 #endif
111
112     WEBCORE_EXPORT ~FontPlatformData();
113
114 #if PLATFORM(WIN)
115     HFONT hfont() const { return m_font ? m_font->get() : 0; }
116     bool useGDI() const { return m_useGDI; }
117 #elif PLATFORM(COCOA)
118     // 
119     CTFontRef font() const { return m_font; }
120     void setFont(CTFontRef);
121
122     CTFontRef ctFont() const;
123
124     bool allowsLigatures() const;
125     bool roundsGlyphAdvances() const;
126
127 #if USE(APPKIT)
128     // FIXME: Remove this when all NSFont usage is removed.
129     NSFont *nsFont() const { return (NSFont *)m_font; }
130     void setNSFont(NSFont *font) { setFont((CTFontRef)font); }
131 #endif
132 #endif
133
134 #if USE(CG)
135     CGFontRef cgFont() const { return m_cgFont.get(); }
136 #endif
137
138 #if PLATFORM(COCOA)
139 #endif
140
141     bool isFixedPitch() const;
142     float size() const { return m_size; }
143     void setSize(float size) { m_size = size; }
144     bool syntheticBold() const { return m_syntheticBold; }
145     bool syntheticOblique() const { return m_syntheticOblique; }
146     bool isColorBitmapFont() const { return m_isColorBitmapFont; }
147     bool isCompositeFontReference() const { return m_isCompositeFontReference; }
148 #if PLATFORM(COCOA)
149     bool isPrinterFont() const { return m_isPrinterFont; }
150 #endif
151     FontOrientation orientation() const { return m_orientation; }
152     FontWidthVariant widthVariant() const { return m_widthVariant; }
153
154     void setOrientation(FontOrientation orientation) { m_orientation = orientation; }
155
156 #if USE(CAIRO)
157     cairo_scaled_font_t* scaledFont() const { return m_scaledFont; }
158 #endif
159
160     unsigned hash() const
161     {
162 #if PLATFORM(WIN) && !USE(CAIRO)
163         return m_font ? m_font->hash() : 0;
164 #elif OS(DARWIN)
165 #if USE(APPKIT)
166         ASSERT(m_font || !m_cgFont);
167         uintptr_t hashCodes[3] = { (uintptr_t)m_font, m_widthVariant, static_cast<uintptr_t>(m_isPrinterFont << 3 | m_orientation << 2 | m_syntheticBold << 1 | m_syntheticOblique) };
168 #else
169         ASSERT(m_font || !m_cgFont || m_isEmoji);
170         uintptr_t hashCodes[3] = { static_cast<uintptr_t>(CFHash(m_font)), m_widthVariant, static_cast<uintptr_t>(m_isEmoji << 4 | m_isPrinterFont << 3 | m_orientation << 2 | m_syntheticBold << 1 | m_syntheticOblique) };
171 #endif // !PLATFORM(IOS)
172         return StringHasher::hashMemory<sizeof(hashCodes)>(hashCodes);
173 #elif USE(CAIRO)
174         return PtrHash<cairo_scaled_font_t*>::hash(m_scaledFont);
175 #endif
176     }
177
178     const FontPlatformData& operator=(const FontPlatformData&);
179
180     bool operator==(const FontPlatformData& other) const
181     {
182         return platformIsEqual(other)
183             && m_size == other.m_size
184             && m_syntheticBold == other.m_syntheticBold
185             && m_syntheticOblique == other.m_syntheticOblique
186             && m_isColorBitmapFont == other.m_isColorBitmapFont
187             && m_isCompositeFontReference == other.m_isCompositeFontReference
188 #if PLATFORM(COCOA)
189             && m_isPrinterFont == other.m_isPrinterFont
190 #endif
191             && m_orientation == other.m_orientation
192             && m_widthVariant == other.m_widthVariant;
193     }
194
195     bool isHashTableDeletedValue() const
196     {
197 #if PLATFORM(WIN) && !USE(CAIRO)
198         return m_font.isHashTableDeletedValue();
199 #elif PLATFORM(COCOA)
200         return m_font == hashTableDeletedFontValue();
201 #elif USE(CAIRO)
202         return m_scaledFont == hashTableDeletedFontValue();
203 #endif
204     }
205
206 #if PLATFORM(COCOA) || PLATFORM(WIN)
207     PassRefPtr<SharedBuffer> openTypeTable(uint32_t table) const;
208 #endif
209
210 #ifndef NDEBUG
211     String description() const;
212 #endif
213
214 private:
215     bool platformIsEqual(const FontPlatformData&) const;
216     void platformDataInit(const FontPlatformData&);
217     const FontPlatformData& platformDataAssign(const FontPlatformData&);
218 #if PLATFORM(COCOA)
219     static CTFontRef hashTableDeletedFontValue() { return reinterpret_cast<CTFontRef>(-1); }
220 #endif
221 #if PLATFORM(WIN)
222     void platformDataInit(HFONT, float size, HDC, WCHAR* faceName);
223 #endif
224 #if USE(CAIRO)
225     static cairo_scaled_font_t* hashTableDeletedFontValue() { return reinterpret_cast<cairo_scaled_font_t*>(-1); }
226 #endif
227
228 public:
229     bool m_syntheticBold { false };
230     bool m_syntheticOblique { false };
231     FontOrientation m_orientation { Horizontal };
232 #if PLATFORM(IOS)
233     bool m_isEmoji { false };
234 #endif
235     float m_size { 0 };
236     FontWidthVariant m_widthVariant { RegularWidth };
237
238 private:
239 #if PLATFORM(COCOA)
240     CTFontRef m_font { nullptr };
241     mutable RetainPtr<CTFontRef> m_ctFont;
242 #elif PLATFORM(WIN)
243     RefPtr<SharedGDIObject<HFONT>> m_font;
244 #endif
245
246 #if USE(CG)
247     RetainPtr<CGFontRef> m_cgFont;
248 #endif
249 #if USE(CAIRO)
250     cairo_scaled_font_t* m_scaledFont { nullptr };
251 #endif
252
253     bool m_isColorBitmapFont { false };
254     bool m_isCompositeFontReference { false };
255 #if PLATFORM(COCOA)
256     bool m_isPrinterFont { false };
257 #endif
258
259 #if PLATFORM(WIN)
260     bool m_useGDI { false };
261 #endif
262 };
263
264 } // namespace WebCore
265
266 #endif // FontPlatformData_h
267
268 #endif