This patch makes drawHighlightForText a completely cross-platform method
[WebKit-https.git] / WebCore / platform / FontData.h
1 /*
2  * This file is part of the internal font implementation.  It should not be included by anyone other than
3  * FontMac.cpp, FontWin.cpp and Font.cpp.
4  *
5  * Copyright (C) 2006 Apple Computer, Inc.
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., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  *
22  */
23
24 #if __APPLE__
25 typedef UInt16                          ATSGlyphRef;
26 typedef struct OpaqueATSUStyle*         ATSUStyle;
27
28 #if __OBJC__
29 @class NSColor;
30 #else
31 class NSColor;
32 #endif
33
34 #include "FloatPoint.h"
35 #include "FontPlatformData.h"
36 #include "GlyphBuffer.h"
37
38 // FIXME: Temporary.  Only needed to support API that's going to move.
39 #include <unicode/uchar.h>
40 #include <unicode/unorm.h>
41
42 namespace WebCore
43 {
44
45 class FloatRect;
46 class Color;
47 class FontDescription;
48
49 struct WebCoreTextStyle
50 {
51     NSColor *textColor;
52     NSColor *backgroundColor;
53     int letterSpacing;
54     int wordSpacing;
55     int padding;
56     int tabWidth;
57     int xpos;
58     NSString **families;
59     bool smallCaps;
60     bool rtl;
61     bool directionalOverride;
62     bool applyRunRounding;
63     bool applyWordRounding;
64     bool attemptFontSubstitution;
65 };
66
67 struct WebCoreTextRun
68 {
69     const UniChar *characters;
70     unsigned int length;
71     int from;
72     int to;
73 };
74
75 struct WebCoreTextGeometry
76 {
77     FloatPoint point;
78     float selectionY;
79     float selectionHeight;
80     bool useFontMetricsForSelectionYAndHeight;
81 };
82
83 void WebCoreInitializeTextRun(WebCoreTextRun *run, const UniChar *characters, unsigned int length, int from, int to);
84 void WebCoreInitializeEmptyTextStyle(WebCoreTextStyle *style);
85 void WebCoreInitializeEmptyTextGeometry(WebCoreTextGeometry *geometry);
86 void WebCoreInitializeFont(FontPlatformData *font);
87
88 typedef struct WidthMap WidthMap;
89 typedef struct GlyphMap GlyphMap;
90
91 class FontData
92 {
93 public:
94     FontData(const FontPlatformData& f);
95     ~FontData();
96
97 public:
98     const FontPlatformData& platformData() const { return m_font; }
99     FontData* smallCapsFontData() const;
100
101     // vertical metrics
102     int ascent() const { return m_ascent; }
103     int descent() const { return m_descent; }
104     int lineSpacing() const { return m_lineSpacing; }
105     int lineGap() const { return m_lineGap; }
106
107     float xHeight() const;
108
109     // horizontal metrics
110     float floatWidthForRun(const WebCoreTextRun* run, const WebCoreTextStyle* style);
111
112     // drawing
113     void drawRun(const WebCoreTextRun* run, const WebCoreTextStyle* style, const WebCoreTextGeometry* geometry);
114     FloatRect selectionRectForRun(const WebCoreTextRun* run, const WebCoreTextStyle* style, const WebCoreTextGeometry* geometry);
115     void drawLineForCharacters(const FloatPoint& point, float yOffset, int width, const Color& color, float thickness);
116     void drawLineForMisspelling(const FloatPoint& point, int width);
117     int misspellingLineThickness() const { return 3; }
118
119     // selection point check 
120     int pointToOffset(const WebCoreTextRun* run, const WebCoreTextStyle* style, int x, bool includePartialGlyphs);
121
122     // FIXME: These are temporary API and will eventually move to the fallback list.
123     Glyph glyphForCharacter(const FontData **renderer, unsigned c) const;
124     const FontData* findSubstituteFontData(const UChar* characters, unsigned numCharacters, const FontDescription&) const;
125     void updateGlyphMapEntry(UChar c, Glyph glyph, const FontData *substituteRenderer) const;
126     // End temporary API
127
128     float widthForGlyph(Glyph glyph) const;
129     
130 private:
131     int misspellingLinePatternWidth() const { return 4; }
132     int misspellingLinePatternGapWidth() const { return 1; } // the number of transparent pixels after the dot
133
134 public:
135     int m_ascent;
136     int m_descent;
137     int m_lineSpacing;
138     int m_lineGap;
139     
140     void* m_styleGroup;
141     
142     FontPlatformData m_font;
143     mutable GlyphMap* m_characterToGlyphMap;
144     mutable WidthMap* m_glyphToWidthMap;
145
146     bool m_treatAsFixedPitch;
147     ATSGlyphRef m_spaceGlyph;
148     float m_spaceWidth;
149     float m_adjustedSpaceWidth;
150     float m_syntheticBoldOffset;
151     
152     mutable FontData* m_smallCapsFontData;
153     mutable ATSUStyle m_ATSUStyle;
154     mutable bool m_ATSUStyleInitialized;
155     mutable bool m_ATSUMirrors;
156 };
157
158 }
159
160 #else
161
162 #include "FontPlatformData.h"
163
164 namespace WebCore {
165
166 class FontDescription;
167
168 class FontData
169 {
170 public:
171 #if WIN32
172     FontData(HFONT font, const FontDescription& fontDescription)
173         :m_platformData(font, fontDescription) {}
174 #endif
175
176     const FontPlatformData& platformData() const { return m_platformData; }
177
178     void setMetrics(int ascent, int descent, int xHeight, int lineSpacing)
179     {
180         m_ascent = ascent;
181         m_descent = descent;
182         m_xHeight = xHeight;
183         m_lineSpacing = lineSpacing;
184     }
185
186     int ascent() const { return m_ascent; }
187     int descent() const { return m_descent; }
188     int xHeight() const { return m_xHeight; }
189     int lineSpacing() const { return m_lineSpacing; }
190
191 private:
192     FontPlatformData m_platformData;
193     int m_ascent;
194     int m_descent;
195     int m_xHeight;
196     int m_lineSpacing;
197 };
198
199 }
200 #endif