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