ca38029487bebbb7e19030585090f027113725b4
[WebKit-https.git] / Source / WebCore / platform / graphics / cocoa / FontPlatformData.h
1 /*
2  * This file is part of the internal font implementation.
3  * It should not be included by source files outside of it.
4  *
5  * Copyright (C) 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef FontPlatformData_h
25 #define FontPlatformData_h
26
27 #include "FontOrientation.h"
28 #include "FontWidthVariant.h"
29 #include <wtf/text/StringImpl.h>
30
31 #ifdef __OBJC__
32 @class NSFont;
33 #else
34 class NSFont;
35 #endif
36
37 typedef struct CGFont* CGFontRef;
38 #ifndef BUILDING_ON_TIGER
39 typedef const struct __CTFont* CTFontRef;
40 #endif
41
42 #include <CoreFoundation/CFBase.h>
43 #include <objc/objc-auto.h>
44 #include <wtf/Forward.h>
45 #include <wtf/RetainPtr.h>
46
47 #if PLATFORM(CHROMIUM) && OS(DARWIN)
48 #include "CrossProcessFontLoading.h"  
49 #endif
50
51
52 typedef UInt32 ATSUFontID;
53 typedef UInt32 ATSFontRef;
54
55 namespace WebCore {
56
57 #ifndef BUILDING_ON_TIGER
58 inline CTFontRef toCTFontRef(NSFont *nsFont) { return reinterpret_cast<CTFontRef>(nsFont); }
59 #endif
60
61 class FontPlatformData {
62   public:
63     FontPlatformData(float size, bool syntheticBold, bool syntheticOblique, FontOrientation orientation = Horizontal, FontWidthVariant widthVariant = RegularWidth)
64         : m_syntheticBold(syntheticBold)
65         , m_syntheticOblique(syntheticOblique)
66         , m_orientation(orientation)
67         , m_size(size)
68         , m_widthVariant(widthVariant)
69         , m_font(0)
70 #ifdef BUILDING_ON_TIGER
71         , m_cgFont(0)
72 #endif
73         , m_isColorBitmapFont(false)
74     {
75     }
76
77     FontPlatformData(NSFont*, float size, bool syntheticBold = false, bool syntheticOblique = false, FontOrientation = Horizontal, FontWidthVariant = RegularWidth);
78     
79     FontPlatformData(CGFontRef cgFont, float size, bool syntheticBold, bool syntheticOblique, FontOrientation orientation, FontWidthVariant widthVariant)
80         : m_syntheticBold(syntheticBold)
81         , m_syntheticOblique(syntheticOblique)
82         , m_orientation(orientation)
83         , m_size(size)
84         , m_widthVariant(widthVariant)
85         , m_font(0)
86         , m_cgFont(cgFont)
87         , m_isColorBitmapFont(false)
88     {
89     }
90
91     FontPlatformData(const FontPlatformData&);
92     
93     ~FontPlatformData();
94
95     FontPlatformData(WTF::HashTableDeletedValueType) : m_font(hashTableDeletedFontValue()) { }
96     bool isHashTableDeletedValue() const { return m_font == hashTableDeletedFontValue(); }
97
98     float size() const { return m_size; }
99     bool syntheticBold() const { return m_syntheticBold; }
100     bool syntheticOblique() const { return m_syntheticOblique; }
101     FontOrientation orientation() const { return m_orientation; }
102     FontWidthVariant widthVariant() const { return m_widthVariant; }
103
104     bool m_syntheticBold;
105     bool m_syntheticOblique;
106     FontOrientation m_orientation;
107
108     float m_size;
109     
110     FontWidthVariant m_widthVariant;
111
112     unsigned hash() const
113     {
114         ASSERT(m_font != 0 || m_cgFont == 0);
115         uintptr_t hashCodes[3] = { (uintptr_t)m_font, m_widthVariant, m_orientation << 2 | m_syntheticBold << 1 | m_syntheticOblique };
116         return WTF::StringHasher::createBlobHash<sizeof(hashCodes)>(hashCodes);
117     }
118
119     const FontPlatformData& operator=(const FontPlatformData& f);
120
121     bool operator==(const FontPlatformData& other) const
122     { 
123         return m_font == other.m_font && m_syntheticBold == other.m_syntheticBold && m_syntheticOblique == other.m_syntheticOblique && 
124                m_cgFont == other.m_cgFont && m_size == other.m_size && m_orientation == other.m_orientation && m_widthVariant == other.m_widthVariant;
125     }
126
127     NSFont *font() const { return m_font; }
128     void setFont(NSFont *font);
129
130     CTFontRef ctFont() const;
131
132     bool roundsGlyphAdvances() const;
133     bool allowsLigatures() const;
134     bool isColorBitmapFont() const { return m_isColorBitmapFont; }
135
136 #ifndef BUILDING_ON_TIGER
137     CGFontRef cgFont() const { return m_cgFont.get(); }
138 #else
139     CGFontRef cgFont() const { return m_cgFont; }
140 #endif
141
142 #ifndef NDEBUG
143     String description() const;
144 #endif
145
146 private:
147     static NSFont *hashTableDeletedFontValue() { return reinterpret_cast<NSFont *>(-1); }
148     
149     // Load various data about the font specified by |nsFont| with the size fontSize into the following output paramters:
150     // Note: Callers should always take into account that for the Chromium port, |outNSFont| isn't necessarily the same
151     // font as |nsFont|.  This because the sandbox may block loading of the original font.
152     // * outNSFont - The font that was actually loaded, for the Chromium port this may be different than nsFont.
153     // The caller is responsible for calling CFRelease() on this parameter when done with it.
154     // * cgFont - CGFontRef representing the input font at the specified point size.
155     void loadFont(NSFont* nsFont, float fontSize, NSFont*& outNSFont, CGFontRef& cgFont);
156
157     NSFont *m_font;
158
159 #ifndef BUILDING_ON_TIGER
160     RetainPtr<CGFontRef> m_cgFont;
161 #else
162     CGFontRef m_cgFont; // It is not necessary to refcount this, since either an NSFont owns it or some CachedFont has it referenced.
163 #endif
164
165     mutable RetainPtr<CTFontRef> m_CTFont;
166
167     bool m_isColorBitmapFont;
168     
169 #if PLATFORM(CHROMIUM) && OS(DARWIN)
170     RefPtr<MemoryActivatedFont> m_inMemoryFont;
171 #endif
172 };
173
174 } // namespace WebCore
175
176 #endif