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