c730c743997a3a7811eeb4c42007dd86b3f98c69
[WebKit-https.git] / Source / WebCore / platform / graphics / FontPlatformData.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2010 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(CHROMIUM) && !OS(DARWIN)) || PLATFORM(BLACKBERRY)
27 #include "chromium/FontPlatformData.h"
28 #elif PLATFORM(QT)
29 #include "qt/FontPlatformData.h"
30 #elif PLATFORM(WIN) && OS(WINCE)
31 #include "wince/FontPlatformData.h"
32 #elif PLATFORM(WX)
33 #include "wx/FontPlatformData.h"
34 #elif (PLATFORM(EFL) || PLATFORM(GTK)) && USE(FREETYPE)
35 #include "freetype/FontPlatformData.h"
36 #elif (PLATFORM(EFL) || PLATFORM(GTK)) && USE(PANGO)
37 #include "pango/FontPlatformData.h"
38 #else
39
40 #ifndef FontPlatformData_h
41 #define FontPlatformData_h
42
43 #include "FontOrientation.h"
44 #include "FontWidthVariant.h"
45 #include "GlyphBuffer.h"
46 #include "TextOrientation.h"
47
48 #if PLATFORM(WIN)
49 #include "RefCountedGDIHandle.h"
50 #endif
51
52 #if USE(CAIRO)
53 #include <wtf/HashFunctions.h>
54 #include <cairo.h>
55 #endif
56
57 #if OS(DARWIN)
58 OBJC_CLASS NSFont;
59
60 typedef struct CGFont* CGFontRef;
61 typedef const struct __CTFont* CTFontRef;
62
63 #include <CoreFoundation/CFBase.h>
64 #include <objc/objc-auto.h>
65 #endif
66
67 #include <wtf/Forward.h>
68 #include <wtf/PassRefPtr.h>
69 #include <wtf/RefCounted.h>
70 #include <wtf/RetainPtr.h>
71 #include <wtf/text/StringImpl.h>
72
73 #if PLATFORM(CHROMIUM) && OS(DARWIN)
74 #include "CrossProcessFontLoading.h"  
75 #endif
76
77 #if PLATFORM(WIN)
78 typedef struct HFONT__* HFONT;
79 #endif
80
81 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
82 typedef struct CGFont* CGFontRef;
83 #if OS(DARWIN)
84 typedef const struct __CTFont* CTFontRef;
85 typedef UInt32 FMFont;
86 typedef FMFont ATSUFontID;
87 typedef UInt32 ATSFontRef;
88 #endif
89 #endif
90
91 namespace WebCore {
92
93 class FontDescription;
94
95 #if OS(DARWIN)
96 inline CTFontRef toCTFontRef(NSFont *nsFont) { return reinterpret_cast<CTFontRef>(nsFont); }
97 #endif
98
99 class FontPlatformData {
100 public:
101     FontPlatformData(WTF::HashTableDeletedValueType)
102         : m_syntheticBold(false)
103         , m_syntheticOblique(false)
104         , m_orientation(Horizontal)
105         , m_textOrientation(TextOrientationVerticalRight)
106         , m_size(0)
107         , m_widthVariant(RegularWidth)
108 #if PLATFORM(WIN)
109         , m_font(WTF::HashTableDeletedValue)
110 #elif OS(DARWIN)
111         , m_font(hashTableDeletedFontValue())
112 #endif
113 #if USE(CG) && PLATFORM(WIN)
114         , m_cgFont(0)
115 #elif USE(CAIRO)
116         , m_scaledFont(hashTableDeletedFontValue())
117 #endif
118         , m_isColorBitmapFont(false)
119 #if PLATFORM(WIN)
120         , m_useGDI(false)
121 #endif
122         {
123         }
124
125     FontPlatformData()
126         : m_syntheticBold(false)
127         , m_syntheticOblique(false)
128         , m_orientation(Horizontal)
129         , m_textOrientation(TextOrientationVerticalRight)
130         , m_size(0)
131         , m_widthVariant(RegularWidth)
132 #if OS(DARWIN)
133         , m_font(0)
134 #endif
135 #if USE(CG) && PLATFORM(WIN)
136         , m_cgFont(0)
137 #elif USE(CAIRO)
138         , m_scaledFont(0)
139 #endif
140         , m_isColorBitmapFont(false)
141 #if PLATFORM(WIN)
142         , m_useGDI(false)
143 #endif
144     {
145     }
146
147     FontPlatformData(const FontPlatformData&);
148     FontPlatformData(const FontDescription&, const AtomicString& family);
149     FontPlatformData(float size, bool syntheticBold, bool syntheticOblique, FontOrientation orientation = Horizontal,
150                      TextOrientation textOrientation = TextOrientationVerticalRight, FontWidthVariant widthVariant = RegularWidth)
151         : m_syntheticBold(syntheticBold)
152         , m_syntheticOblique(syntheticOblique)
153         , m_orientation(orientation)
154         , m_textOrientation(textOrientation)
155         , m_size(size)
156         , m_widthVariant(widthVariant)
157 #if OS(DARWIN)
158         , m_font(0)
159 #endif
160 #if USE(CG) && PLATFORM(WIN)
161         , m_cgFont(0)
162 #elif USE(CAIRO)
163         , m_scaledFont(0)
164 #endif
165         , m_isColorBitmapFont(false)
166 #if PLATFORM(WIN)
167         , m_useGDI(false)
168 #endif
169     {
170     }
171
172 #if OS(DARWIN)
173     FontPlatformData(NSFont*, float size, bool syntheticBold = false, bool syntheticOblique = false, FontOrientation = Horizontal,
174                      TextOrientation = TextOrientationVerticalRight, FontWidthVariant = RegularWidth);
175 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
176     FontPlatformData(CGFontRef cgFont, float size, bool syntheticBold, bool syntheticOblique, FontOrientation orientation,
177                      TextOrientation textOrientation, FontWidthVariant widthVariant)
178         : m_syntheticBold(syntheticBold)
179         , m_syntheticOblique(syntheticOblique)
180         , m_orientation(orientation)
181         , m_textOrientation(textOrientation)
182         , m_size(size)
183         , m_widthVariant(widthVariant)
184         , m_font(0)
185         , m_cgFont(cgFont)
186         , m_isColorBitmapFont(false)
187     {
188     }
189 #endif
190 #endif
191 #if PLATFORM(WIN)
192     FontPlatformData(HFONT, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
193 #if USE(CG)
194     FontPlatformData(HFONT, CGFontRef, float size, bool syntheticBold, bool syntheticOblique, bool useGDI);
195 #endif
196 #endif
197 #if USE(CAIRO)
198     FontPlatformData(cairo_font_face_t*, float size, bool bold, bool italic);
199 #endif
200
201     ~FontPlatformData();
202
203 #if PLATFORM(WIN)
204     HFONT hfont() const { return m_font ? m_font->handle() : 0; }
205     bool useGDI() const { return m_useGDI; }
206 #elif OS(DARWIN)
207     NSFont* font() const { return m_font; }
208     void setFont(NSFont*);
209 #endif
210
211 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
212 #if OS(DARWIN)
213     CGFontRef cgFont() const { return m_cgFont.get(); }
214     CTFontRef ctFont() const;
215
216     bool roundsGlyphAdvances() const;
217     bool allowsLigatures() const;
218 #else
219     CGFontRef cgFont() const { return m_cgFont.get(); }
220 #endif
221 #endif
222
223     bool isFixedPitch() const;
224     float size() const { return m_size; }
225     void setSize(float size) { m_size = size; }
226     bool syntheticBold() const { return m_syntheticBold; }
227     bool syntheticOblique() const { return m_syntheticOblique; }
228     bool isColorBitmapFont() const { return m_isColorBitmapFont; }
229     FontOrientation orientation() const { return m_orientation; }
230     TextOrientation textOrientation() const { return m_textOrientation; }
231     FontWidthVariant widthVariant() const { return m_widthVariant; }
232
233     void setOrientation(FontOrientation orientation) { m_orientation = orientation; }
234
235 #if USE(CAIRO)
236     cairo_scaled_font_t* scaledFont() const { return m_scaledFont; }
237 #endif
238
239     unsigned hash() const
240     {
241 #if PLATFORM(WIN) && !USE(CAIRO)
242         return m_font ? m_font->hash() : 0;
243 #elif OS(DARWIN)
244 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
245         ASSERT(m_font || !m_cgFont);
246 #endif
247         uintptr_t hashCodes[3] = { (uintptr_t)m_font, m_widthVariant, m_textOrientation << 3 | m_orientation << 2 | m_syntheticBold << 1 | m_syntheticOblique };
248         return StringHasher::hashMemory<sizeof(hashCodes)>(hashCodes);
249 #elif USE(CAIRO)
250         return PtrHash<cairo_scaled_font_t*>::hash(m_scaledFont);
251 #endif
252     }
253
254     const FontPlatformData& operator=(const FontPlatformData&);
255
256     bool operator==(const FontPlatformData& other) const
257     {
258         return platformIsEqual(other)
259             && m_size == other.m_size
260             && m_syntheticBold == other.m_syntheticBold
261             && m_syntheticOblique == other.m_syntheticOblique
262             && m_isColorBitmapFont == other.m_isColorBitmapFont
263             && m_orientation == other.m_orientation
264             && m_textOrientation == other.m_textOrientation
265             && m_widthVariant == other.m_widthVariant;
266     }
267
268     bool isHashTableDeletedValue() const
269     {
270 #if PLATFORM(WIN) && !USE(CAIRO)
271         return m_font.isHashTableDeletedValue();
272 #elif OS(DARWIN)
273         return m_font == hashTableDeletedFontValue();
274 #elif USE(CAIRO)
275         return m_scaledFont == hashTableDeletedFontValue();
276 #endif
277     }
278
279
280 #ifndef NDEBUG
281     String description() const;
282 #endif
283
284 private:
285     bool platformIsEqual(const FontPlatformData&) const;
286     void platformDataInit(const FontPlatformData&);
287     const FontPlatformData& platformDataAssign(const FontPlatformData&);
288 #if OS(DARWIN)
289     // Load various data about the font specified by |nsFont| with the size fontSize into the following output paramters:
290     // Note: Callers should always take into account that for the Chromium port, |outNSFont| isn't necessarily the same
291     // font as |nsFont|. This because the sandbox may block loading of the original font.
292     // * outNSFont - The font that was actually loaded, for the Chromium port this may be different than nsFont.
293     // The caller is responsible for calling CFRelease() on this parameter when done with it.
294     // * cgFont - CGFontRef representing the input font at the specified point size.
295     void loadFont(NSFont*, float fontSize, NSFont*& outNSFont, CGFontRef&);
296     static NSFont* hashTableDeletedFontValue() { return reinterpret_cast<NSFont *>(-1); }
297 #elif PLATFORM(WIN)
298     void platformDataInit(HFONT, float size, HDC, WCHAR* faceName);
299 #endif
300
301 #if USE(CAIRO)
302     static cairo_scaled_font_t* hashTableDeletedFontValue() { return reinterpret_cast<cairo_scaled_font_t*>(-1); }
303 #endif
304
305 public:
306     bool m_syntheticBold;
307     bool m_syntheticOblique;
308     FontOrientation m_orientation;
309     TextOrientation m_textOrientation;
310     float m_size;
311     FontWidthVariant m_widthVariant;
312
313 private:
314 #if OS(DARWIN)
315     NSFont* m_font;
316 #elif PLATFORM(WIN)
317     RefPtr<RefCountedGDIHandle<HFONT> > m_font;
318 #endif
319
320 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
321 #if PLATFORM(WIN)
322     RetainPtr<CGFontRef> m_cgFont;
323 #else
324     RetainPtr<CGFontRef> m_cgFont;
325     mutable RetainPtr<CTFontRef> m_CTFont;
326 #endif
327 #endif
328
329 #if USE(CAIRO)
330     cairo_scaled_font_t* m_scaledFont;
331 #endif
332
333 #if PLATFORM(CHROMIUM) && OS(DARWIN)
334     RefPtr<MemoryActivatedFont> m_inMemoryFont;
335 #endif
336
337     bool m_isColorBitmapFont;
338
339 #if PLATFORM(WIN)
340     bool m_useGDI;
341 #endif
342 };
343
344 } // namespace WebCore
345
346 #endif // FontPlatformData_h
347
348 #endif