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