summaryrefslogtreecommitdiffstats
path: root/gfx/thebes/gfxSVGGlyphs.h
blob: c4d0c86ecb75f3235fb4dc909b318345b1cf9515 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef GFX_SVG_GLYPHS_WRAPPER_H
#define GFX_SVG_GLYPHS_WRAPPER_H

#include "gfxFontUtils.h"
#include "mozilla/gfx/2D.h"
#include "nsString.h"
#include "nsClassHashtable.h"
#include "nsBaseHashtable.h"
#include "nsHashKeys.h"
#include "gfxPattern.h"
#include "mozilla/gfx/UserData.h"
#include "mozilla/SVGContextPaint.h"
#include "nsRefreshObservers.h"

class nsIContentViewer;
class gfxSVGGlyphs;

namespace mozilla {
class PresShell;
class SVGContextPaint;
namespace dom {
class Document;
class Element;
}  // namespace dom
}  // namespace mozilla

/**
 * Wraps an SVG document contained in the SVG table of an OpenType font.
 * There may be multiple SVG documents in an SVG table which we lazily parse
 *   so we have an instance of this class for every document in the SVG table
 *   which contains a glyph ID which has been used
 * Finds and looks up elements contained in the SVG document which have glyph
 *   mappings to be drawn by gfxSVGGlyphs
 */
class gfxSVGGlyphsDocument final : public nsAPostRefreshObserver {
  typedef mozilla::dom::Element Element;

 public:
  gfxSVGGlyphsDocument(const uint8_t* aBuffer, uint32_t aBufLen,
                       gfxSVGGlyphs* aSVGGlyphs);

  Element* GetGlyphElement(uint32_t aGlyphId);

  ~gfxSVGGlyphsDocument();

  void DidRefresh() override;

  size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;

 private:
  nsresult ParseDocument(const uint8_t* aBuffer, uint32_t aBufLen);

  nsresult SetupPresentation();

  void FindGlyphElements(Element* aElement);

  void InsertGlyphId(Element* aGlyphElement);

  // Weak so as not to create a cycle. mOwner owns us so this can't dangle.
  gfxSVGGlyphs* mOwner;
  RefPtr<mozilla::dom::Document> mDocument;
  nsCOMPtr<nsIContentViewer> mViewer;
  RefPtr<mozilla::PresShell> mPresShell;

  nsBaseHashtable<nsUint32HashKey, Element*, Element*> mGlyphIdMap;

  nsCString mSVGGlyphsDocumentURI;
};

/**
 * Used by |gfxFontEntry| to represent the SVG table of an OpenType font.
 * Handles lazy parsing of the SVG documents in the table, looking up SVG glyphs
 *   and rendering SVG glyphs.
 * Each |gfxFontEntry| owns at most one |gfxSVGGlyphs| instance.
 */
class gfxSVGGlyphs {
 private:
  typedef mozilla::dom::Element Element;

 public:
  /**
   * @param aSVGTable The SVG table from the OpenType font
   *
   * The gfxSVGGlyphs object takes over ownership of the blob references
   * that are passed in, and will hb_blob_destroy() them when finished;
   * the caller should -not- destroy these references.
   */
  gfxSVGGlyphs(hb_blob_t* aSVGTable, gfxFontEntry* aFontEntry);

  /**
   * Releases our references to the SVG table and cleans up everything else.
   */
  ~gfxSVGGlyphs();

  /**
   * This is called when the refresh driver has ticked.
   */
  void DidRefresh();

  /**
   * Find the |gfxSVGGlyphsDocument| containing an SVG glyph for |aGlyphId|.
   * If |aGlyphId| does not map to an SVG document, return null.
   * If a |gfxSVGGlyphsDocument| has not been created for the document, create
   * one.
   */
  gfxSVGGlyphsDocument* FindOrCreateGlyphsDocument(uint32_t aGlyphId);

  /**
   * Return true iff there is an SVG glyph for |aGlyphId|
   */
  bool HasSVGGlyph(uint32_t aGlyphId);

  /**
   * Render the SVG glyph for |aGlyphId|
   * @param aContextPaint Information on text context paints.
   *   See |SVGContextPaint|.
   */
  void RenderGlyph(gfxContext* aContext, uint32_t aGlyphId,
                   mozilla::SVGContextPaint* aContextPaint);

  /**
   * Get the extents for the SVG glyph associated with |aGlyphId|
   * @param aSVGToAppSpace The matrix mapping the SVG glyph space to the
   *   target context space
   */
  bool GetGlyphExtents(uint32_t aGlyphId, const gfxMatrix& aSVGToAppSpace,
                       gfxRect* aResult);

  size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;

  gfxFontEntry* FontEntry() const { return mFontEntry; }

 private:
  Element* GetGlyphElement(uint32_t aGlyphId);

  nsClassHashtable<nsUint32HashKey, gfxSVGGlyphsDocument> mGlyphDocs;
  nsBaseHashtable<nsUint32HashKey, Element*, Element*> mGlyphIdMap;

  hb_blob_t* mSVGData;

  // pointer to the font entry that owns this gfxSVGGlyphs object
  gfxFontEntry* MOZ_NON_OWNING_REF mFontEntry;

  const struct Header {
    mozilla::AutoSwap_PRUint16 mVersion;
    mozilla::AutoSwap_PRUint32 mDocIndexOffset;
    mozilla::AutoSwap_PRUint32 mColorPalettesOffset;
  } * mHeader;

  struct IndexEntry {
    mozilla::AutoSwap_PRUint16 mStartGlyph;
    mozilla::AutoSwap_PRUint16 mEndGlyph;
    mozilla::AutoSwap_PRUint32 mDocOffset;
    mozilla::AutoSwap_PRUint32 mDocLength;
  };

  const struct DocIndex {
    mozilla::AutoSwap_PRUint16 mNumEntries;
    IndexEntry mEntries[1]; /* actual length = mNumEntries */
  } * mDocIndex;

  static int CompareIndexEntries(const void* _a, const void* _b);
};

/**
 * XXX This is a complete hack and should die (see bug 1291494).
 *
 * This class is used when code fails to pass through an SVGContextPaint from
 * the context in which we are painting.  In that case we create one of these
 * as a fallback and have it wrap the gfxContext's current gfxPattern and
 * pretend that that is the paint context's fill pattern.  In some contexts
 * that will be the case, in others it will not.  As we convert more code to
 * Moz2D the less likely it is that this hack will work.  It will also make
 * converting to Moz2D harder.
 */
class SimpleTextContextPaint : public mozilla::SVGContextPaint {
 private:
  static const mozilla::gfx::DeviceColor sZero;

  static gfxMatrix SetupDeviceToPatternMatrix(gfxPattern* aPattern,
                                              const gfxMatrix& aCTM) {
    if (!aPattern) {
      return gfxMatrix();
    }
    gfxMatrix deviceToUser = aCTM;
    if (!deviceToUser.Invert()) {
      return gfxMatrix(0, 0, 0, 0, 0, 0);  // singular
    }
    return deviceToUser * aPattern->GetMatrix();
  }

 public:
  SimpleTextContextPaint(gfxPattern* aFillPattern, gfxPattern* aStrokePattern,
                         const gfxMatrix& aCTM)
      : mFillPattern(aFillPattern ? aFillPattern : new gfxPattern(sZero)),
        mStrokePattern(aStrokePattern ? aStrokePattern
                                      : new gfxPattern(sZero)) {
    mFillMatrix = SetupDeviceToPatternMatrix(aFillPattern, aCTM);
    mStrokeMatrix = SetupDeviceToPatternMatrix(aStrokePattern, aCTM);
  }

  already_AddRefed<gfxPattern> GetFillPattern(
      const DrawTarget* aDrawTarget, float aOpacity, const gfxMatrix& aCTM,
      imgDrawingParams& aImgParams) override {
    if (mFillPattern) {
      mFillPattern->SetMatrix(aCTM * mFillMatrix);
    }
    RefPtr<gfxPattern> fillPattern = mFillPattern;
    return fillPattern.forget();
  }

  already_AddRefed<gfxPattern> GetStrokePattern(
      const DrawTarget* aDrawTarget, float aOpacity, const gfxMatrix& aCTM,
      imgDrawingParams& aImgParams) override {
    if (mStrokePattern) {
      mStrokePattern->SetMatrix(aCTM * mStrokeMatrix);
    }
    RefPtr<gfxPattern> strokePattern = mStrokePattern;
    return strokePattern.forget();
  }

  float GetFillOpacity() const override { return mFillPattern ? 1.0f : 0.0f; }

  float GetStrokeOpacity() const override {
    return mStrokePattern ? 1.0f : 0.0f;
  }

 private:
  RefPtr<gfxPattern> mFillPattern;
  RefPtr<gfxPattern> mStrokePattern;

  // Device space to pattern space transforms
  gfxMatrix mFillMatrix;
  gfxMatrix mStrokeMatrix;
};

#endif