2007-11-19 Doug Turner <dougt@meer.net>
[WebKit-https.git] / WebCore / platform / GlyphPageTreeNode.h
1 /*
2  * Copyright (C) 2006, 2007 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef GlyphPageTreeNode_h
30 #define GlyphPageTreeNode_h
31
32 #include <wtf/RefCounted.h>
33 #include <wtf/unicode/Unicode.h>
34 #include <wtf/Noncopyable.h>
35 #include <wtf/HashMap.h>
36
37 namespace WebCore {
38
39 class FontData;
40 class GlyphPageTreeNode;
41
42 typedef unsigned short Glyph;
43
44 // Holds the glyph index and the corresponding FontData information for a given
45 // character.
46 struct GlyphData {
47     Glyph glyph;
48     const FontData* fontData;
49 };
50
51 // A GlyphPage contains a fixed-size set of GlyphData mappings for a contiguous
52 // range of characters in the Unicode code space. GlyphPages are indexed
53 // starting from 0 and incrementing for each 256 glyphs.
54 //
55 // One page may actually include glyphs from other fonts if the characters are
56 // missing in the parimary font. It is owned by exactly one GlyphPageTreeNode,
57 // although multiple nodes may reference it as their "page" if they are supposed
58 // to be overriding the parent's node, but provide no additional information.
59 struct GlyphPage : public RefCounted<GlyphPage> {
60     GlyphPage()
61         : m_owner(0)
62     {
63     }
64
65     GlyphPage(GlyphPageTreeNode* owner)
66         : m_owner(owner)
67     {
68     }
69
70     static const size_t size = 256; // Covers Latin-1 in a single page.
71     GlyphData m_glyphs[size];
72     GlyphPageTreeNode* m_owner;
73
74     const GlyphData& glyphDataForCharacter(UChar32 c) const { return m_glyphs[c % size]; }
75     void setGlyphDataForCharacter(UChar32 c, Glyph g, const FontData* f)
76     {
77         setGlyphDataForIndex(c % size, g, f);
78     }
79     void setGlyphDataForIndex(unsigned index, Glyph g, const FontData* f)
80     {
81         ASSERT(index < size);
82         m_glyphs[index].glyph = g;
83         m_glyphs[index].fontData = f;
84     }
85     GlyphPageTreeNode* owner() const { return m_owner; }
86     // Implemented by the platform.
87     bool fill(UChar* characterBuffer, unsigned bufferLength, const FontData* fontData);
88 };
89
90 // The glyph page tree is a data structure that maps (FontData, glyph page number)
91 // to a GlyphPage.  Level 0 (the "root") is special. There is one root
92 // GlyphPageTreeNode for each glyph page number.  The roots do not have a
93 // GlyphPage associated with them, and their initializePage() function is never
94 // called to fill the glyphs.
95 //
96 // Each root node maps a FontData pointer to another GlyphPageTreeNode at
97 // level 1 (the "root child") that stores the actual glyphs for a specific font data.
98 // These nodes will only have a GlyphPage if they have glyphs for that range.
99 //
100 // Levels greater than one correspond to subsequent levels of the fallback list
101 // for that font. These levels override their parent's page of glyphs by
102 // filling in holes with the new font (thus making a more complete page).
103 //
104 // A NULL FontData pointer corresponds to the system fallback
105 // font. It is tracked separately from the regular pages and overrides so that
106 // the glyph pages do not get polluted with these last-resort glyphs. The
107 // system fallback page is not populated at construction like the other pages,
108 // but on demand for each glyph, because the system may need to use different
109 // fallback fonts for each. This lazy population is done by the Font.
110 class GlyphPageTreeNode {
111 public:
112     GlyphPageTreeNode()
113         : m_parent(0)
114         , m_level(0)
115         , m_isSystemFallback(false)
116         , m_systemFallbackChild(0)
117         , m_customFontCount(0)
118 #ifndef NDEBUG
119         , m_pageNumber(0)
120 #endif
121     {
122     }
123
124     ~GlyphPageTreeNode();
125
126     static HashMap<int, GlyphPageTreeNode*>* roots;
127     static GlyphPageTreeNode* pageZeroRoot;
128
129     static GlyphPageTreeNode* getRootChild(const FontData* fontData, unsigned pageNumber)
130     {
131         return getRoot(pageNumber)->getChild(fontData, pageNumber);
132     }
133
134     static void pruneTreeCustomFontData(const FontData*);
135
136     void pruneCustomFontData(const FontData*);
137
138     GlyphPageTreeNode* parent() const { return m_parent; }
139     GlyphPageTreeNode* getChild(const FontData*, unsigned pageNumber);
140
141     // Returns a page of glyphs (or NULL if there are no glyphs in this page's character range).
142     GlyphPage* page() const { return m_page.get(); }
143
144     // Returns the level of this node. See class-level comment.
145     unsigned level() const { return m_level; }
146
147     // The system fallback font has special rules (see above).
148     bool isSystemFallback() const { return m_isSystemFallback; }
149
150 private:
151     static GlyphPageTreeNode* getRoot(unsigned pageNumber);
152     void initializePage(const FontData*, unsigned pageNumber);
153
154     GlyphPageTreeNode* m_parent;
155     RefPtr<GlyphPage> m_page;
156     unsigned m_level;
157     bool m_isSystemFallback;
158     HashMap<const FontData*, GlyphPageTreeNode*> m_children;
159     GlyphPageTreeNode* m_systemFallbackChild;
160     unsigned m_customFontCount;
161
162 #ifndef NDEBUG
163     unsigned m_pageNumber;
164 #endif
165 };
166
167 } // namespace WebCore
168
169 #endif // GlyphPageTreeNode_h