Bug 8880, remove the remaining drawing/hit testing code from
[WebKit-https.git] / WebCore / platform / Font.h
1 /*
2  * This file is part of the html renderer for KDE.
3  *
4  * Copyright (C) 2000 Lars Knoll (knoll@kde.org)
5  *           (C) 2000 Antti Koivisto (koivisto@kde.org)
6  *           (C) 2000 Dirk Mueller (mueller@kde.org)
7  * Copyright (C) 2003, 2006 Apple Computer, Inc.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  *
24  */
25
26 #ifndef FONT_H
27 #define FONT_H
28
29 #include "Color.h"
30 #include "FontDescription.h"
31 #include "TextDirection.h"
32 #include "GlyphBuffer.h"
33
34 #if __APPLE__
35 // FIXME: Should not be necessary.
36 #include "FontPlatformData.h"
37 #endif
38
39 namespace WebCore {
40
41 class FontFallbackList;
42 class GraphicsContext;
43 class IntPoint;
44 class IntRect;
45 class FloatRect;
46 class FloatPoint;
47
48 enum Pitch { UnknownPitch, FixedPitch, VariablePitch };
49
50 class TextRun
51 {
52 public:
53     TextRun(const UChar* c, int len)
54     :m_characters(c), m_len(len), m_from(0), m_to(len)
55     {}
56
57     TextRun(const UChar* c, int len, int from, int to) // This constructor is only used in one place in Mac-specific code.
58     :m_characters(c), m_len(len), m_from(from), m_to(to)
59     {}
60
61     TextRun(const StringImpl* s, int offset = 0, int length = -1, int from = -1, int to = -1)
62     :m_characters(s->characters() + offset), m_len(length == -1 ? s->length() - offset : length), m_from(adjustFrom(from)), m_to(adjustTo(to))
63     {}
64
65     const UChar operator[](int i) const { return m_characters[i]; }
66     const UChar* data(int i) const { return &m_characters[i]; }
67
68     int adjustFrom(int from) const { return from == -1 ? 0 : from; }
69     int adjustTo(int to) const { return to == -1 ? m_len : to; }
70     void makeComplete() { m_from = 0; m_to = m_len; }
71
72     const UChar* characters() const { return m_characters; }
73     int length() const { return m_len; }
74     int from() const { return m_from; }
75     int to() const { return m_to; }
76
77 private:
78     const UChar* m_characters;
79     int m_len;
80     int m_from;
81     int m_to;
82 };
83
84 class TextStyle
85 {
86 public:
87     TextStyle(int tabWidth = 0, int xpos = 0, int padding = 0, bool rtl = false, bool directionalOverride = false,
88               bool applyRunRounding = true, bool applyWordRounding = true, bool attemptFontSubstitution = true)
89     :m_tabWidth(tabWidth), m_xpos(xpos), m_padding(padding), m_rtl(rtl), m_directionalOverride(directionalOverride),
90      m_applyRunRounding(applyRunRounding), m_applyWordRounding(applyWordRounding), m_attemptFontSubstitution(attemptFontSubstitution)
91     {}
92     
93     int tabWidth() const { return m_tabWidth; }
94     int xPos() const { return m_xpos; }
95     int padding() const { return m_padding; }
96     bool rtl() const { return m_rtl; }
97     bool ltr() const { return !m_rtl; }
98     bool directionalOverride() const { return m_directionalOverride; }
99     bool applyRunRounding() const { return m_applyRunRounding; }
100     bool applyWordRounding() const { return m_applyWordRounding; }
101     bool attemptFontSubstitution() const { return m_attemptFontSubstitution; }
102
103     void disableRoundingHacks() { m_applyRunRounding = m_applyWordRounding = false; }
104     void setRTL(bool b) { m_rtl = b; }
105     
106 private:
107     int m_tabWidth;
108     int m_xpos;
109     int m_padding;
110     bool m_rtl;
111     bool m_directionalOverride;
112     bool m_applyRunRounding;
113     bool m_applyWordRounding;
114     bool m_attemptFontSubstitution;
115 };
116
117 class Font {
118 public:
119     Font();
120     Font(const FontDescription&, short letterSpacing, short wordSpacing);
121 #if __APPLE__
122     Font(const FontPlatformData& fontPlatformData); // This constructor is only used by Mac-specific code that already has a native font.
123 #endif
124     ~Font();
125     
126     Font(const Font&);
127     Font& operator=(const Font&);
128
129     bool operator==(const Font& other) const {
130         // Our FontData doesn't have to be checked, since
131         // checking the font description will be fine.
132         return (m_fontDescription == other.m_fontDescription &&
133                 m_letterSpacing == other.m_letterSpacing &&
134                 m_wordSpacing == other.m_wordSpacing);
135     }
136
137     bool operator!=(const Font& other) const {
138         return !(*this == other);
139     }
140
141     const FontDescription& fontDescription() const { return m_fontDescription; }
142
143     int pixelSize() const { return fontDescription().computedPixelSize(); }
144     float size() const { return fontDescription().computedSize(); }
145     
146     void update() const;
147
148     void drawText(GraphicsContext*, const TextRun&, const TextStyle&, const FloatPoint&) const;
149
150     int width(const TextRun&, const TextStyle& = TextStyle()) const;
151     float floatWidth(const TextRun&, const TextStyle& = TextStyle()) const;
152     
153     int offsetForPosition(const TextRun&, const TextStyle&, int position, bool includePartialGlyphs) const;
154     FloatRect selectionRectForText(const TextRun&, const TextStyle&, const IntPoint&, int h) const;
155
156     bool isSmallCaps() const { return m_fontDescription.smallCaps(); }
157
158     short wordSpacing() const { return m_wordSpacing; }
159     short letterSpacing() const { return m_letterSpacing; }
160     void setWordSpacing(short s) { m_wordSpacing = s; }
161     void setLetterSpacing(short s) { m_letterSpacing = s; }
162
163     bool isFixedPitch() const;
164     bool isPrinterFont() const { return m_fontDescription.usePrinterFont(); }
165
166     FontFamily& firstFamily() { return m_fontDescription.firstFamily(); }
167     const FontFamily& family() const { return m_fontDescription.family(); }
168
169     bool italic() const { return m_fontDescription.italic(); }
170     unsigned weight() const { return m_fontDescription.weight(); }
171
172 #if __APPLE__
173     // FIXME: Shouldn't need to access FontPlatformData... should just need NSFont.
174     NSString* getNSFamily() const { return m_fontDescription.family().getNSFamily(); }    
175     NSFont* getNSFont() const { return platformFont().font; }
176     const FontPlatformData& platformFont() const;
177 #endif
178
179     // Metrics that we query the FontFallbackList for.
180     int ascent() const;
181     int descent() const;
182     int height() const { return ascent() + descent(); }
183     int lineSpacing() const;
184     float xHeight() const;
185
186     const FontData* primaryFont() const;
187
188 private:
189 #if __APPLE__
190     // FIXME: This will eventually be cross-platform, but we want to keep Windows compiling for now.
191     bool canUseGlyphCache(const TextRun&) const;
192     void drawSimpleText(GraphicsContext*, const TextRun&, const TextStyle&, const FloatPoint&) const;
193     void drawGlyphs(GraphicsContext*, const FontData*, const GlyphBuffer&, int from, int to, const FloatPoint&) const;
194     void drawComplexText(GraphicsContext*, const TextRun&, const TextStyle&, const FloatPoint&) const;
195     float floatWidthForSimpleText(const TextRun&, const TextStyle&, const FontData* substituteFont, float* startX, GlyphBuffer*) const;
196     float floatWidthForComplexText(const TextRun&, const TextStyle&) const;
197     int offsetForPositionForSimpleText(const TextRun&, const TextStyle&, int position, bool includePartialGlyphs) const;
198     int offsetForPositionForComplexText(const TextRun&, const TextStyle&, int position, bool includePartialGlyphs) const;
199     FloatRect selectionRectForSimpleText(const TextRun&, const TextStyle&, const IntPoint&, int h) const;
200     FloatRect selectionRectForComplexText(const TextRun&, const TextStyle&, const IntPoint&, int h) const;
201
202     friend struct WidthIterator;
203     
204     // Useful for debugging the complex font rendering code path.
205 public:
206     static void setAlwaysUseComplexPath(bool);
207     static bool gAlwaysUseComplexPath;
208     
209     static const uint8_t gRoundingHackCharacterTable[256];
210     static bool treatAsSpace(UChar c) { return c == ' ' || c == '\t' || c == '\n' || c == 0x00A0; }
211     static bool isRoundingHackCharacter(UChar32 c)
212     {
213         return (((c & ~0xFF) == 0 && gRoundingHackCharacterTable[c])); 
214     }
215 #endif
216
217 private:
218     FontDescription m_fontDescription;
219     mutable RefPtr<FontFallbackList> m_fontList;
220     short m_letterSpacing;
221     short m_wordSpacing;
222 };
223
224 }
225
226 #endif