The Tor Browser / file revision

 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 4 -*-

  * 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_FONT_H

 #define GFX_FONT_H

 #include "gfxTypes.h"

 #include "nsString.h"

 #include "gfxPoint.h"

 #include "gfxFontUtils.h"

 #include "nsTArray.h"

 #include "nsTHashtable.h"

 #include "nsHashKeys.h"

 #include "gfxSkipChars.h"

 #include "gfxRect.h"

 #include "nsExpirationTracker.h"

 #include "gfxPlatform.h"

 #include "nsIAtom.h"

 #include "mozilla/HashFunctions.h"

 #include "nsIMemoryReporter.h"

 #include "nsIObserver.h"

 #include "gfxFontFeatures.h"

 #include "mozilla/MemoryReporting.h"

 #include "mozilla/Attributes.h"

 #include <algorithm>

 #include "DrawMode.h"

 #include "nsUnicodeScriptCodes.h"

 #include "nsDataHashtable.h"

 #include "harfbuzz/hb.h"

 #include "mozilla/gfx/2D.h"

 typedef struct _cairo_scaled_font cairo_scaled_font_t;

 typedef struct gr_face            gr_face;

 #ifdef DEBUG

 #include <stdio.h>

 #endif

 class gfxContext;

 class gfxTextRun;

 class gfxFont;

 class gfxFontFamily;

 class gfxFontGroup;

 class gfxGraphiteShaper;

 class gfxHarfBuzzShaper;

 class gfxUserFontSet;

 class gfxUserFontData;

 class gfxShapedText;

 class gfxShapedWord;

 class gfxSVGGlyphs;

 class gfxMathTable;

 class gfxTextContextPaint;

 class FontInfoData;

 class nsILanguageAtomService;

 #define FONT_MAX_SIZE                  2000.0

 #define NO_FONT_LANGUAGE_OVERRIDE      0

 struct FontListSizes;

 struct gfxTextRunDrawCallbacks;

 namespace mozilla {

 namespace gfx {

 class GlyphRenderingOptions;

 }

 }

 struct gfxFontStyle {

     gfxFontStyle();

     gfxFontStyle(uint8_t aStyle, uint16_t aWeight, int16_t aStretch,

                  gfxFloat aSize, nsIAtom *aLanguage,

                  float aSizeAdjust, bool aSystemFont,

                  bool aPrinterFont,

                  const nsString& aLanguageOverride);

     gfxFontStyle(const gfxFontStyle& aStyle);

     // the language (may be an internal langGroup code rather than an actual

     // language code) specified in the document or element's lang property,

     // or inferred from the charset

     nsRefPtr<nsIAtom> language;

     // Features are composed of (1) features from style rules (2) features

     // from feature setttings rules and (3) family-specific features.  (1) and

     // (3) are guaranteed to be mutually exclusive

     // custom opentype feature settings

     nsTArray<gfxFontFeature> featureSettings;

     // Some font-variant property values require font-specific settings

     // defined via @font-feature-values rules.  These are resolved after

     // font matching occurs.

     // -- list of value tags for specific alternate features

     nsTArray<gfxAlternateValue> alternateValues;

     // -- object used to look these up once the font is matched

     nsRefPtr<gfxFontFeatureValueSet> featureValueLookup;

     // The logical size of the font, in pixels

     gfxFloat size;

     // The aspect-value (ie., the ratio actualsize:actualxheight) that any

     // actual physical font created from this font structure must have when

     // rendering or measuring a string. A value of 0 means no adjustment

     // needs to be done.

     float sizeAdjust;

     // Language system tag, to override document language;

     // an OpenType "language system" tag represented as a 32-bit integer

     // (see http://www.microsoft.com/typography/otspec/languagetags.htm).

     // Normally 0, so font rendering will use the document or element language

     // (see above) to control any language-specific rendering, but the author

     // can override this for cases where the options implemented in the font

     // do not directly match the actual language. (E.g. lang may be Macedonian,

     // but the font in use does not explicitly support this; the author can

     // use font-language-override to request the Serbian option in the font

     // in order to get correct glyph shapes.)

     uint32_t languageOverride;

     // The weight of the font: 100, 200, ... 900.

     uint16_t weight;

     // The stretch of the font (the sum of various NS_FONT_STRETCH_*

     // constants; see gfxFontConstants.h).

     int8_t stretch;

     // Say that this font is a system font and therefore does not

     // require certain fixup that we do for fonts from untrusted

     // sources.

     bool systemFont : 1;

     // Say that this font is used for print or print preview.

     bool printerFont : 1;

     // Used to imitate -webkit-font-smoothing: antialiased

     bool useGrayscaleAntialiasing : 1;

     // The style of font (normal, italic, oblique)

     uint8_t style : 2;

     // Return the final adjusted font size for the given aspect ratio.

     // Not meant to be called when sizeAdjust = 0.

     gfxFloat GetAdjustedSize(gfxFloat aspect) const {

         NS_ASSERTION(sizeAdjust != 0.0, "Not meant to be called when sizeAdjust = 0");

         gfxFloat adjustedSize = std::max(NS_round(size*(sizeAdjust/aspect)), 1.0);

         return std::min(adjustedSize, FONT_MAX_SIZE);

     }

     PLDHashNumber Hash() const {

         return ((style + (systemFont << 7) +

             (weight << 8)) + uint32_t(size*1000) + uint32_t(sizeAdjust*1000)) ^

             nsISupportsHashKey::HashKey(language);

     }

     int8_t ComputeWeight() const;

     bool Equals(const gfxFontStyle& other) const {

         return

             (*reinterpret_cast<const uint64_t*>(&size) ==

              *reinterpret_cast<const uint64_t*>(&other.size)) &&

             (style == other.style) &&

             (systemFont == other.systemFont) &&

             (printerFont == other.printerFont) &&

             (useGrayscaleAntialiasing == other.useGrayscaleAntialiasing) &&

             (weight == other.weight) &&

             (stretch == other.stretch) &&

             (language == other.language) &&

             (*reinterpret_cast<const uint32_t*>(&sizeAdjust) ==

              *reinterpret_cast<const uint32_t*>(&other.sizeAdjust)) &&

             (featureSettings == other.featureSettings) &&

             (languageOverride == other.languageOverride) &&

             (alternateValues == other.alternateValues) &&

             (featureValueLookup == other.featureValueLookup);

     }

     static void ParseFontFeatureSettings(const nsString& aFeatureString,

                                          nsTArray<gfxFontFeature>& aFeatures);

     static uint32_t ParseFontLanguageOverride(const nsString& aLangTag);

 };

 class gfxCharacterMap : public gfxSparseBitSet {

 public:

     nsrefcnt AddRef() {

         NS_PRECONDITION(int32_t(mRefCnt) >= 0, "illegal refcnt");

         ++mRefCnt;

         NS_LOG_ADDREF(this, mRefCnt, "gfxCharacterMap", sizeof(*this));

         return mRefCnt;

     }

     nsrefcnt Release() {

         NS_PRECONDITION(0 != mRefCnt, "dup release");

         --mRefCnt;

         NS_LOG_RELEASE(this, mRefCnt, "gfxCharacterMap");

         if (mRefCnt == 0) {

             NotifyReleased();

             // |this| has been deleted.

             return 0;

         }

         return mRefCnt;

     }

     gfxCharacterMap() :

         mHash(0), mBuildOnTheFly(false), mShared(false)

     { }

     void CalcHash() { mHash = GetChecksum(); }

     size_t SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const {

         return gfxSparseBitSet::SizeOfExcludingThis(aMallocSizeOf);

     }

     // hash of the cmap bitvector

     uint32_t mHash;

     // if cmap is built on the fly it's never shared

     bool mBuildOnTheFly;

     // cmap is shared globally

     bool mShared;

 protected:

     void NotifyReleased();

     nsAutoRefCnt mRefCnt;

 private:

     gfxCharacterMap(const gfxCharacterMap&);

     gfxCharacterMap& operator=(const gfxCharacterMap&);

 };

 class gfxFontEntry {

 public:

     NS_INLINE_DECL_REFCOUNTING(gfxFontEntry)

     gfxFontEntry(const nsAString& aName, bool aIsStandardFace = false);

     // unique name for the face, *not* the family; not necessarily the

     // "real" or user-friendly name, may be an internal identifier

     const nsString& Name() const { return mName; }

     // family name

     const nsString& FamilyName() const { return mFamilyName; }

     // The following two methods may be relatively expensive, as they

     // will (usually, except on Linux) load and parse the 'name' table;

     // they are intended only for the font-inspection API, not for

     // perf-critical layout/drawing work.

     // The "real" name of the face, if available from the font resource;

     // returns Name() if nothing better is available.

     virtual nsString RealFaceName();

     uint16_t Weight() const { return mWeight; }

     int16_t Stretch() const { return mStretch; }

     bool IsUserFont() const { return mIsUserFont; }

     bool IsLocalUserFont() const { return mIsLocalUserFont; }

     bool IsFixedPitch() const { return mFixedPitch; }

     bool IsItalic() const { return mItalic; }

     bool IsBold() const { return mWeight >= 600; } // bold == weights 600 and above

     bool IgnoreGDEF() const { return mIgnoreGDEF; }

     bool IgnoreGSUB() const { return mIgnoreGSUB; }

     virtual bool IsSymbolFont();

     virtual bool HasFontTable(uint32_t aTableTag);

     inline bool HasGraphiteTables() {

         if (!mCheckedForGraphiteTables) {

             CheckForGraphiteTables();

             mCheckedForGraphiteTables = true;

         }

         return mHasGraphiteTables;

     }

     inline bool HasCmapTable() {

         if (!mCharacterMap) {

             ReadCMAP();

             NS_ASSERTION(mCharacterMap, "failed to initialize character map");

         }

         return mHasCmapTable;

     }

     inline bool HasCharacter(uint32_t ch) {

         if (mCharacterMap && mCharacterMap->test(ch)) {

             return true;

         }

         return TestCharacterMap(ch);

     }

     virtual bool SkipDuringSystemFallback() { return false; }

     virtual bool TestCharacterMap(uint32_t aCh);

     nsresult InitializeUVSMap();

     uint16_t GetUVSGlyph(uint32_t aCh, uint32_t aVS);

     // All concrete gfxFontEntry subclasses (except gfxProxyFontEntry) need

     // to override this, otherwise the font will never be used as it will

     // be considered to support no characters.

     // ReadCMAP() must *always* set the mCharacterMap pointer to a valid

     // gfxCharacterMap, even if empty, as other code assumes this pointer

     // can be safely dereferenced.

     virtual nsresult ReadCMAP(FontInfoData *aFontInfoData = nullptr);

     bool TryGetSVGData(gfxFont* aFont);

     bool HasSVGGlyph(uint32_t aGlyphId);

     bool GetSVGGlyphExtents(gfxContext *aContext, uint32_t aGlyphId,

                             gfxRect *aResult);

     bool RenderSVGGlyph(gfxContext *aContext, uint32_t aGlyphId, int aDrawMode,

                         gfxTextContextPaint *aContextPaint);

     // Call this when glyph geometry or rendering has changed

     // (e.g. animated SVG glyphs)

     void NotifyGlyphsChanged();

     enum MathConstant {

         // The order of the constants must match the order of the fields

         // defined in the MATH table.

         ScriptPercentScaleDown,

         ScriptScriptPercentScaleDown,

         DelimitedSubFormulaMinHeight,

         DisplayOperatorMinHeight,

         MathLeading,

         AxisHeight,

         AccentBaseHeight,

         FlattenedAccentBaseHeight,

         SubscriptShiftDown,

         SubscriptTopMax,

         SubscriptBaselineDropMin,

         SuperscriptShiftUp,

         SuperscriptShiftUpCramped,

         SuperscriptBottomMin,

         SuperscriptBaselineDropMax,

         SubSuperscriptGapMin,

         SuperscriptBottomMaxWithSubscript,

         SpaceAfterScript,

         UpperLimitGapMin,

         UpperLimitBaselineRiseMin,

         LowerLimitGapMin,

         LowerLimitBaselineDropMin,

         StackTopShiftUp,

         StackTopDisplayStyleShiftUp,

         StackBottomShiftDown,

         StackBottomDisplayStyleShiftDown,

         StackGapMin,

         StackDisplayStyleGapMin,

         StretchStackTopShiftUp,

         StretchStackBottomShiftDown,

         StretchStackGapAboveMin,

         StretchStackGapBelowMin,

         FractionNumeratorShiftUp,

         FractionNumeratorDisplayStyleShiftUp,

         FractionDenominatorShiftDown,

         FractionDenominatorDisplayStyleShiftDown,

         FractionNumeratorGapMin,

         FractionNumDisplayStyleGapMin,

         FractionRuleThickness,

         FractionDenominatorGapMin,

         FractionDenomDisplayStyleGapMin,

         SkewedFractionHorizontalGap,

         SkewedFractionVerticalGap,

         OverbarVerticalGap,

         OverbarRuleThickness,

         OverbarExtraAscender,

         UnderbarVerticalGap,

         UnderbarRuleThickness,

         UnderbarExtraDescender,

         RadicalVerticalGap,

         RadicalDisplayStyleVerticalGap,

         RadicalRuleThickness,

         RadicalExtraAscender,

         RadicalKernBeforeDegree,

         RadicalKernAfterDegree,

         RadicalDegreeBottomRaisePercent

     };

     // Call TryGetMathTable to try to load the Open Type MATH table. The other

     // functions forward the call to the gfxMathTable class. The GetMath...()

     // functions MUST NOT be called unless TryGetMathTable() has returned true.

     bool     TryGetMathTable(gfxFont* aFont);

     gfxFloat GetMathConstant(MathConstant aConstant);

     bool     GetMathItalicsCorrection(uint32_t aGlyphID,

                                       gfxFloat* aItalicCorrection);

     uint32_t GetMathVariantsSize(uint32_t aGlyphID, bool aVertical,

                                  uint16_t aSize);

     bool     GetMathVariantsParts(uint32_t aGlyphID, bool aVertical,

                                   uint32_t aGlyphs[4]);

     virtual bool MatchesGenericFamily(const nsACString& aGeneric) const {

         return true;

     }

     virtual bool SupportsLangGroup(nsIAtom *aLangGroup) const {

         return true;

     }

     // Access to raw font table data (needed for Harfbuzz):

     // returns a pointer to data owned by the fontEntry or the OS,

     // which will remain valid until the blob is destroyed.

     // The data MUST be treated as read-only; we may be getting a

     // reference to a shared system font cache.

     //

     // The default implementation uses CopyFontTable to get the data

     // into a byte array, and maintains a cache of loaded tables.

     //

     // Subclasses should override this if they can provide more efficient

     // access than copying table data into our own buffers.

     //

     // Get blob that encapsulates a specific font table, or nullptr if

     // the table doesn't exist in the font.

     //

     // Caller is responsible to call hb_blob_destroy() on the returned blob

     // (if non-nullptr) when no longer required. For transient access to a

     // table, use of AutoTable (below) is generally preferred.

     virtual hb_blob_t *GetFontTable(uint32_t aTag);

     // Stack-based utility to return a specified table, automatically releasing

     // the blob when the AutoTable goes out of scope.

     class AutoTable {

     public:

         AutoTable(gfxFontEntry* aFontEntry, uint32_t aTag)

         {

             mBlob = aFontEntry->GetFontTable(aTag);

         }

         ~AutoTable() {

             if (mBlob) {

                 hb_blob_destroy(mBlob);

             }

         }

         operator hb_blob_t*() const { return mBlob; }

     private:

         hb_blob_t* mBlob;

         // not implemented:

         AutoTable(const AutoTable&) MOZ_DELETE;

         AutoTable& operator=(const AutoTable&) MOZ_DELETE;

     };

     already_AddRefed<gfxFont> FindOrMakeFont(const gfxFontStyle *aStyle,

                                              bool aNeedsBold);

     // Get an existing font table cache entry in aBlob if it has been

     // registered, or return false if not.  Callers must call

     // hb_blob_destroy on aBlob if true is returned.

     //

     // Note that some gfxFont implementations may not call this at all,

     // if it is more efficient to get the table from the OS at that level.

     bool GetExistingFontTable(uint32_t aTag, hb_blob_t** aBlob);

     // Elements of aTable are transferred (not copied) to and returned in a

     // new hb_blob_t which is registered on the gfxFontEntry, but the initial

     // reference is owned by the caller.  Removing the last reference

     // unregisters the table from the font entry.

     //

     // Pass nullptr for aBuffer to indicate that the table is not present and

     // nullptr will be returned.  Also returns nullptr on OOM.

     hb_blob_t *ShareFontTableAndGetBlob(uint32_t aTag,

                                         FallibleTArray<uint8_t>* aTable);

     // Get the font's unitsPerEm from the 'head' table, in the case of an

     // sfnt resource. Will return kInvalidUPEM for non-sfnt fonts,

     // if present on the platform.

     uint16_t UnitsPerEm();

     enum {

         kMinUPEM = 16,    // Limits on valid unitsPerEm range, from the

         kMaxUPEM = 16384, // OpenType spec

         kInvalidUPEM = uint16_t(-1)

     };

     // Shaper face accessors:

     // NOTE that harfbuzz and graphite handle ownership/lifetime of the face

     // object in completely different ways.

     // Get HarfBuzz face corresponding to this font file.

     // Caller must release with hb_face_destroy() when finished with it,

     // and the font entry will be notified via ForgetHBFace.

     hb_face_t* GetHBFace();

     virtual void ForgetHBFace();

     // Get Graphite face corresponding to this font file.

     // Caller must call gfxFontEntry::ReleaseGrFace when finished with it.

     gr_face* GetGrFace();

     virtual void ReleaseGrFace(gr_face* aFace);

     // Release any SVG-glyphs document this font may have loaded.

     void DisconnectSVG();

     // Called to notify that aFont is being destroyed. Needed when we're tracking

     // the fonts belonging to this font entry.

     void NotifyFontDestroyed(gfxFont* aFont);

     // For memory reporting

     virtual void AddSizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf,

                                         FontListSizes* aSizes) const;

     virtual void AddSizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf,

                                         FontListSizes* aSizes) const;

     // Used when checking for complex script support, to mask off cmap ranges

     struct ScriptRange {

         uint32_t         rangeStart;

         uint32_t         rangeEnd;

         hb_tag_t         tags[3]; // one or two OpenType script tags to check,

                                   // plus a NULL terminator

     };

     bool SupportsScriptInGSUB(const hb_tag_t* aScriptTags);

     nsString         mName;

     nsString         mFamilyName;

     bool             mItalic      : 1;

     bool             mFixedPitch  : 1;

     bool             mIsProxy     : 1;

     bool             mIsValid     : 1;

     bool             mIsBadUnderlineFont : 1;

     bool             mIsUserFont  : 1;

     bool             mIsLocalUserFont  : 1;

     bool             mStandardFace : 1;

     bool             mSymbolFont  : 1;

     bool             mIgnoreGDEF  : 1;

     bool             mIgnoreGSUB  : 1;

     bool             mSVGInitialized : 1;

     bool             mMathInitialized : 1;

     bool             mHasSpaceFeaturesInitialized : 1;

     bool             mHasSpaceFeatures : 1;

     bool             mHasSpaceFeaturesKerning : 1;

     bool             mHasSpaceFeaturesNonKerning : 1;

     bool             mSkipDefaultFeatureSpaceCheck : 1;

     bool             mHasGraphiteTables : 1;

     bool             mCheckedForGraphiteTables : 1;

     bool             mHasCmapTable : 1;

     bool             mGrFaceInitialized : 1;

     // bitvector of substitution space features per script, one each

     // for default and non-default features

     uint32_t         mDefaultSubSpaceFeatures[(MOZ_NUM_SCRIPT_CODES + 31) / 32];

     uint32_t         mNonDefaultSubSpaceFeatures[(MOZ_NUM_SCRIPT_CODES + 31) / 32];

     uint16_t         mWeight;

     int16_t          mStretch;

     nsRefPtr<gfxCharacterMap> mCharacterMap;

     uint32_t         mUVSOffset;

     nsAutoArrayPtr<uint8_t> mUVSData;

     nsAutoPtr<gfxUserFontData> mUserFontData;

     nsAutoPtr<gfxSVGGlyphs> mSVGGlyphs;

     // list of gfxFonts that are using SVG glyphs

     nsTArray<gfxFont*> mFontsUsingSVGGlyphs;

     nsAutoPtr<gfxMathTable> mMathTable;

     nsTArray<gfxFontFeature> mFeatureSettings;

     uint32_t         mLanguageOverride;

 protected:

     friend class gfxPlatformFontList;

     friend class gfxMacPlatformFontList;

     friend class gfxUserFcFontEntry;

     friend class gfxFontFamily;

     friend class gfxSingleFaceMacFontFamily;

     gfxFontEntry();

     // Protected destructor, to discourage deletion outside of Release():

     virtual ~gfxFontEntry();

     virtual gfxFont *CreateFontInstance(const gfxFontStyle *aFontStyle, bool aNeedsBold) {

         NS_NOTREACHED("oops, somebody didn't override CreateFontInstance");

         return nullptr;

     }

     virtual void CheckForGraphiteTables();

     // Copy a font table into aBuffer.

     // The caller will be responsible for ownership of the data.

     virtual nsresult CopyFontTable(uint32_t aTableTag,

                                    FallibleTArray<uint8_t>& aBuffer) {

         NS_NOTREACHED("forgot to override either GetFontTable or CopyFontTable?");

         return NS_ERROR_FAILURE;

     }

     // Return a blob that wraps a table found within a buffer of font data.

     // The blob does NOT own its data; caller guarantees that the buffer

     // will remain valid at least as long as the blob.

     // Returns null if the specified table is not found.

     // This method assumes aFontData is valid 'sfnt' data; before using this,

     // caller is responsible to do any sanitization/validation necessary.

     hb_blob_t* GetTableFromFontData(const void* aFontData, uint32_t aTableTag);

     // lookup the cmap in cached font data

     virtual already_AddRefed<gfxCharacterMap>

     GetCMAPFromFontInfo(FontInfoData *aFontInfoData,

                         uint32_t& aUVSOffset,

                         bool& aSymbolFont);

     // Font's unitsPerEm from the 'head' table, if available (will be set to

     // kInvalidUPEM for non-sfnt font formats)

     uint16_t mUnitsPerEm;

     // Shaper-specific face objects, shared by all instantiations of the same

     // physical font, regardless of size.

     // Usually, only one of these will actually be created for any given font

     // entry, depending on the font tables that are present.

     // hb_face_t is refcounted internally, so each shaper that's using it will

     // bump the ref count when it acquires the face, and "destroy" (release) it

     // in its destructor. The font entry has only this non-owning reference to

     // the face; when the face is deleted, it will tell the font entry to forget

     // it, so that a new face will be created next time it is needed.

     hb_face_t* mHBFace;

     static hb_blob_t* HBGetTable(hb_face_t *face, uint32_t aTag, void *aUserData);

     // Callback that the hb_face will use to tell us when it is being deleted.

     static void HBFaceDeletedCallback(void *aUserData);

     // gr_face is -not- refcounted, so it will be owned directly by the font

     // entry, and we'll keep a count of how many references we've handed out;

     // each shaper is responsible to call ReleaseGrFace on its entry when

     // finished with it, so that we know when it can be deleted.

     gr_face*   mGrFace;

     // hashtable to map raw table data ptr back to its owning blob, for use by

     // graphite table-release callback

     nsDataHashtable<nsPtrHashKey<const void>,void*>* mGrTableMap;

     // number of current users of this entry's mGrFace

     nsrefcnt mGrFaceRefCnt;

     static const void* GrGetTable(const void *aAppFaceHandle,

                                   unsigned int aName,

                                   size_t *aLen);

     static void GrReleaseTable(const void *aAppFaceHandle,

                                const void *aTableBuffer);

 private:

     /**

      * Font table hashtable, to support GetFontTable for harfbuzz.

      *

      * The harfbuzz shaper (and potentially other clients) needs access to raw

      * font table data. This needs to be cached so that it can be used

      * repeatedly (each time we construct a text run; in some cases, for

      * each character/glyph within the run) without re-fetching large tables

      * every time.

      * 

      * Because we may instantiate many gfxFonts for the same physical font

      * file (at different sizes), we should ensure that they can share a

      * single cached copy of the font tables. To do this, we implement table

      * access and sharing on the fontEntry rather than the font itself.

      *

      * The default implementation uses GetFontTable() to read font table

      * data into byte arrays, and wraps them in blobs which are registered in

      * a hashtable.  The hashtable can then return pre-existing blobs to

      * harfbuzz.

      *

      * Harfbuzz will "destroy" the blobs when it is finished with them.  When

      * the last blob reference is removed, the FontTableBlobData user data

      * will remove the blob from the hashtable if still registered.

      */

     class FontTableBlobData;

     /**

      * FontTableHashEntry manages the entries of hb_blob_t's containing font

      * table data.

      *

      * This is used to share font tables across fonts with the same

      * font entry (but different sizes) for use by HarfBuzz.  The hashtable

      * does not own a strong reference to the blob, but keeps a weak pointer,

      * managed by FontTableBlobData.  Similarly FontTableBlobData keeps only a

      * weak pointer to the hashtable, managed by FontTableHashEntry.

      */

     class FontTableHashEntry : public nsUint32HashKey

     {

     public:

         // Declarations for nsTHashtable

         typedef nsUint32HashKey KeyClass;

         typedef KeyClass::KeyType KeyType;

         typedef KeyClass::KeyTypePointer KeyTypePointer;

         FontTableHashEntry(KeyTypePointer aTag)

             : KeyClass(aTag)

             , mSharedBlobData(nullptr)

             , mBlob(nullptr)

         { }

         // NOTE: This assumes the new entry belongs to the same hashtable as

         // the old, because the mHashtable pointer in mSharedBlobData (if

         // present) will not be updated.

         FontTableHashEntry(FontTableHashEntry&& toMove)

             : KeyClass(mozilla::Move(toMove))

             , mSharedBlobData(mozilla::Move(toMove.mSharedBlobData))

             , mBlob(mozilla::Move(toMove.mBlob))

         {

             toMove.mSharedBlobData = nullptr;

             toMove.mBlob = nullptr;

         }

         ~FontTableHashEntry() { Clear(); }

         // FontTable/Blob API

         // Transfer (not copy) elements of aTable to a new hb_blob_t and

         // return ownership to the caller.  A weak reference to the blob is

         // recorded in the hashtable entry so that others may use the same

         // table.

         hb_blob_t *

         ShareTableAndGetBlob(FallibleTArray<uint8_t>& aTable,

                              nsTHashtable<FontTableHashEntry> *aHashtable);

         // Return a strong reference to the blob.

         // Callers must hb_blob_destroy the returned blob.

         hb_blob_t *GetBlob() const;

         void Clear();

         static size_t

         SizeOfEntryExcludingThis(FontTableHashEntry *aEntry,

                                  mozilla::MallocSizeOf aMallocSizeOf,

                                  void* aUserArg);

     private:

         static void DeleteFontTableBlobData(void *aBlobData);

         // not implemented

         FontTableHashEntry& operator=(FontTableHashEntry& toCopy);

         FontTableBlobData *mSharedBlobData;

         hb_blob_t *mBlob;

     };

     nsAutoPtr<nsTHashtable<FontTableHashEntry> > mFontTableCache;

     gfxFontEntry(const gfxFontEntry&);

     gfxFontEntry& operator=(const gfxFontEntry&);

 };

 // used when iterating over all fonts looking for a match for a given character

 struct GlobalFontMatch {

     GlobalFontMatch(const uint32_t aCharacter,

                     int32_t aRunScript,

                     const gfxFontStyle *aStyle) :

         mCh(aCharacter), mRunScript(aRunScript), mStyle(aStyle),

         mMatchRank(0), mCount(0), mCmapsTested(0)

         {

         }

     const uint32_t         mCh;          // codepoint to be matched

     int32_t                mRunScript;   // Unicode script for the codepoint

     const gfxFontStyle*    mStyle;       // style to match

     int32_t                mMatchRank;   // metric indicating closest match

     nsRefPtr<gfxFontEntry> mBestMatch;   // current best match

     nsRefPtr<gfxFontFamily> mMatchedFamily; // the family it belongs to

     uint32_t               mCount;       // number of fonts matched

     uint32_t               mCmapsTested; // number of cmaps tested

 };

 class gfxFontFamily {

 public:

     NS_INLINE_DECL_REFCOUNTING(gfxFontFamily)

     gfxFontFamily(const nsAString& aName) :

         mName(aName),

         mOtherFamilyNamesInitialized(false),

         mHasOtherFamilyNames(false),

         mFaceNamesInitialized(false),

         mHasStyles(false),

         mIsSimpleFamily(false),

         mIsBadUnderlineFamily(false),

         mFamilyCharacterMapInitialized(false),

         mSkipDefaultFeatureSpaceCheck(false)

         { }

     const nsString& Name() { return mName; }

     virtual void LocalizedName(nsAString& aLocalizedName);

     virtual bool HasOtherFamilyNames();

     nsTArray<nsRefPtr<gfxFontEntry> >& GetFontList() { return mAvailableFonts; }

     void AddFontEntry(nsRefPtr<gfxFontEntry> aFontEntry) {

         // bug 589682 - set the IgnoreGDEF flag on entries for Italic faces

         // of Times New Roman, because of buggy table in those fonts

         if (aFontEntry->IsItalic() && !aFontEntry->IsUserFont() &&

             Name().EqualsLiteral("Times New Roman"))

         {

             aFontEntry->mIgnoreGDEF = true;

         }

         aFontEntry->mFamilyName = Name();

         aFontEntry->mSkipDefaultFeatureSpaceCheck = mSkipDefaultFeatureSpaceCheck;

         mAvailableFonts.AppendElement(aFontEntry);

     }

     // note that the styles for this family have been added

     bool HasStyles() { return mHasStyles; }

     void SetHasStyles(bool aHasStyles) { mHasStyles = aHasStyles; }

     // choose a specific face to match a style using CSS font matching

     // rules (weight matching occurs here).  may return a face that doesn't

     // precisely match (e.g. normal face when no italic face exists).

     // aNeedsSyntheticBold is set to true when synthetic bolding is

     // needed, false otherwise

     gfxFontEntry *FindFontForStyle(const gfxFontStyle& aFontStyle, 

                                    bool& aNeedsSyntheticBold);

     // checks for a matching font within the family

     // used as part of the font fallback process

     void FindFontForChar(GlobalFontMatch *aMatchData);

     // checks all fonts for a matching font within the family

     void SearchAllFontsForChar(GlobalFontMatch *aMatchData);

     // read in other family names, if any, and use functor to add each into cache

     virtual void ReadOtherFamilyNames(gfxPlatformFontList *aPlatformFontList);

     // helper method for reading localized family names from the name table

     // of a single face

     static void ReadOtherFamilyNamesForFace(const nsAString& aFamilyName,

                                             const char *aNameData,

                                             uint32_t aDataLength,

                                             nsTArray<nsString>& aOtherFamilyNames,

                                             bool useFullName);

     // set when other family names have been read in

     void SetOtherFamilyNamesInitialized() {

         mOtherFamilyNamesInitialized = true;

     }

     // read in other localized family names, fullnames and Postscript names

     // for all faces and append to lookup tables

     virtual void ReadFaceNames(gfxPlatformFontList *aPlatformFontList,

                                bool aNeedFullnamePostscriptNames,

                                FontInfoData *aFontInfoData = nullptr);

     // find faces belonging to this family (platform implementations override this;

     // should be made pure virtual once all subclasses have been updated)

     virtual void FindStyleVariations(FontInfoData *aFontInfoData = nullptr) { }

     // search for a specific face using the Postscript name

     gfxFontEntry* FindFont(const nsAString& aPostscriptName);

     // read in cmaps for all the faces

     void ReadAllCMAPs(FontInfoData *aFontInfoData = nullptr);

     bool TestCharacterMap(uint32_t aCh) {

         if (!mFamilyCharacterMapInitialized) {

             ReadAllCMAPs();

         }

         return mFamilyCharacterMap.test(aCh);

     }

     void ResetCharacterMap() {

         mFamilyCharacterMap.reset();

         mFamilyCharacterMapInitialized = false;

     }

     // mark this family as being in the "bad" underline offset blacklist

     void SetBadUnderlineFamily() {

         mIsBadUnderlineFamily = true;

         if (mHasStyles) {

             SetBadUnderlineFonts();

         }

     }

     bool IsBadUnderlineFamily() const { return mIsBadUnderlineFamily; }

     // sort available fonts to put preferred (standard) faces towards the end

     void SortAvailableFonts();

     // check whether the family fits into the simple 4-face model,

     // so we can use simplified style-matching;

     // if so set the mIsSimpleFamily flag (defaults to False before we've checked)

     void CheckForSimpleFamily();

     // For memory reporter

     virtual void AddSizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf,

                                         FontListSizes* aSizes) const;

     virtual void AddSizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf,

                                         FontListSizes* aSizes) const;

     // Only used for debugging checks - does a linear search

     bool ContainsFace(gfxFontEntry* aFontEntry) {

         uint32_t i, numFonts = mAvailableFonts.Length();

         for (i = 0; i < numFonts; i++) {

             if (mAvailableFonts[i] == aFontEntry) {

                 return true;

             }

         }

         return false;

     }

     void SetSkipSpaceFeatureCheck(bool aSkipCheck) {

         mSkipDefaultFeatureSpaceCheck = aSkipCheck;

     }

 protected:

     // Protected destructor, to discourage deletion outside of Release():

     virtual ~gfxFontFamily()

     {

     }

     // fills in an array with weights of faces that match style,

     // returns whether any matching entries found

     virtual bool FindWeightsForStyle(gfxFontEntry* aFontsForWeights[],

                                        bool anItalic, int16_t aStretch);

     bool ReadOtherFamilyNamesForFace(gfxPlatformFontList *aPlatformFontList,

                                      hb_blob_t           *aNameTable,

                                      bool                 useFullName = false);

     // set whether this font family is in "bad" underline offset blacklist.

     void SetBadUnderlineFonts() {

         uint32_t i, numFonts = mAvailableFonts.Length();

         for (i = 0; i < numFonts; i++) {

             if (mAvailableFonts[i]) {

                 mAvailableFonts[i]->mIsBadUnderlineFont = true;

             }

         }

     }

     nsString mName;

     nsTArray<nsRefPtr<gfxFontEntry> >  mAvailableFonts;

     gfxSparseBitSet mFamilyCharacterMap;

     bool mOtherFamilyNamesInitialized : 1;

     bool mHasOtherFamilyNames : 1;

     bool mFaceNamesInitialized : 1;

     bool mHasStyles : 1;

     bool mIsSimpleFamily : 1;

     bool mIsBadUnderlineFamily : 1;

     bool mFamilyCharacterMapInitialized : 1;

     bool mSkipDefaultFeatureSpaceCheck : 1;

     enum {

         // for "simple" families, the faces are stored in mAvailableFonts

         // with fixed positions:

         kRegularFaceIndex    = 0,

         kBoldFaceIndex       = 1,

         kItalicFaceIndex     = 2,

         kBoldItalicFaceIndex = 3,

         // mask values for selecting face with bold and/or italic attributes

         kBoldMask   = 0x01,

         kItalicMask = 0x02

     };

 };

 struct gfxTextRange {

     enum {

         // flags for recording the kind of font-matching that was used

         kFontGroup      = 0x0001,

         kPrefsFallback  = 0x0002,

         kSystemFallback = 0x0004

     };

     gfxTextRange(uint32_t aStart, uint32_t aEnd,

                  gfxFont* aFont, uint8_t aMatchType)

         : start(aStart),

           end(aEnd),

           font(aFont),

           matchType(aMatchType)

     { }

     uint32_t Length() const { return end - start; }

     uint32_t start, end;

     nsRefPtr<gfxFont> font;

     uint8_t matchType;

 };

 /**

  * Font cache design:

  * 

  * The mFonts hashtable contains most fonts, indexed by (gfxFontEntry*, style).

  * It does not add a reference to the fonts it contains.

  * When a font's refcount decreases to zero, instead of deleting it we

  * add it to our expiration tracker.

  * The expiration tracker tracks fonts with zero refcount. After a certain

  * period of time, such fonts expire and are deleted.

  *

  * We're using 3 generations with a ten-second generation interval, so

  * zero-refcount fonts will be deleted 20-30 seconds after their refcount

  * goes to zero, if timer events fire in a timely manner.

  *

  * The font cache also handles timed expiration of cached ShapedWords

  * for "persistent" fonts: it has a repeating timer, and notifies

  * each cached font to "age" its shaped words. The words will be released

  * by the fonts if they get aged three times without being re-used in the

  * meantime.

  *

  * Note that the ShapedWord timeout is much larger than the font timeout,

  * so that in the case of a short-lived font, we'll discard the gfxFont

  * completely, with all its words, and avoid the cost of aging the words

  * individually. That only happens with longer-lived fonts.

  */

 struct FontCacheSizes {

     FontCacheSizes()

         : mFontInstances(0), mShapedWords(0)

     { }

     size_t mFontInstances; // memory used by instances of gfxFont subclasses

     size_t mShapedWords; // memory used by the per-font shapedWord caches

 };

 class gfxFontCache MOZ_FINAL : public nsExpirationTracker<gfxFont,3> {

 public:

     enum {

         FONT_TIMEOUT_SECONDS = 10,

         SHAPED_WORD_TIMEOUT_SECONDS = 60

     };

     gfxFontCache();

     ~gfxFontCache();

     /*

      * Get the global gfxFontCache.  You must call Init() before

      * calling this method --- the result will not be null.

      */

     static gfxFontCache* GetCache() {

         return gGlobalCache;

     }

     static nsresult Init();

     // It's OK to call this even if Init() has not been called.

     static void Shutdown();

     // Look up a font in the cache. Returns an addrefed pointer, or null

     // if there's nothing matching in the cache

     already_AddRefed<gfxFont> Lookup(const gfxFontEntry *aFontEntry,

                                      const gfxFontStyle *aStyle);

     // We created a new font (presumably because Lookup returned null);

     // put it in the cache. The font's refcount should be nonzero. It is

     // allowable to add a new font even if there is one already in the

     // cache with the same key; we'll forget about the old one.

     void AddNew(gfxFont *aFont);

     // The font's refcount has gone to zero; give ownership of it to

     // the cache. We delete it if it's not acquired again after a certain

     // amount of time.

     void NotifyReleased(gfxFont *aFont);

     // This gets called when the timeout has expired on a zero-refcount

     // font; we just delete it.

     virtual void NotifyExpired(gfxFont *aFont);

     // Cleans out the hashtable and removes expired fonts waiting for cleanup.

     // Other gfxFont objects may be still in use but they will be pushed

     // into the expiration queues and removed.

     void Flush() {

         mFonts.Clear();

         AgeAllGenerations();

     }

     void FlushShapedWordCaches() {

         mFonts.EnumerateEntries(ClearCachedWordsForFont, nullptr);

     }

     void AddSizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf,

                                 FontCacheSizes* aSizes) const;

     void AddSizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf,

                                 FontCacheSizes* aSizes) const;

 protected:

     class MemoryReporter MOZ_FINAL : public nsIMemoryReporter

     {

     public:

         NS_DECL_ISUPPORTS

         NS_DECL_NSIMEMORYREPORTER

     };

     // Observer for notifications that the font cache cares about

     class Observer MOZ_FINAL

         : public nsIObserver

     {

     public:

         NS_DECL_ISUPPORTS

         NS_DECL_NSIOBSERVER

     };

     void DestroyFont(gfxFont *aFont);

     static gfxFontCache *gGlobalCache;

     struct Key {

         const gfxFontEntry* mFontEntry;

         const gfxFontStyle* mStyle;

         Key(const gfxFontEntry* aFontEntry, const gfxFontStyle* aStyle)

             : mFontEntry(aFontEntry), mStyle(aStyle) {}

     };

     class HashEntry : public PLDHashEntryHdr {

     public:

         typedef const Key& KeyType;

         typedef const Key* KeyTypePointer;

         // When constructing a new entry in the hashtable, we'll leave this

         // blank. The caller of Put() will fill this in.

         HashEntry(KeyTypePointer aStr) : mFont(nullptr) { }

         HashEntry(const HashEntry& toCopy) : mFont(toCopy.mFont) { }

         ~HashEntry() { }

         bool KeyEquals(const KeyTypePointer aKey) const;

         static KeyTypePointer KeyToPointer(KeyType aKey) { return &aKey; }

         static PLDHashNumber HashKey(const KeyTypePointer aKey) {

             return mozilla::HashGeneric(aKey->mStyle->Hash(), aKey->mFontEntry);

         }

         enum { ALLOW_MEMMOVE = true };

         gfxFont* mFont;

     };

     static size_t AddSizeOfFontEntryExcludingThis(HashEntry* aHashEntry,

                                                   mozilla::MallocSizeOf aMallocSizeOf,

                                                   void* aUserArg);

     nsTHashtable<HashEntry> mFonts;

     static PLDHashOperator ClearCachedWordsForFont(HashEntry* aHashEntry, void*);

     static PLDHashOperator AgeCachedWordsForFont(HashEntry* aHashEntry, void*);

     static void WordCacheExpirationTimerCallback(nsITimer* aTimer, void* aCache);

     nsCOMPtr<nsITimer>      mWordCacheExpirationTimer;

 };

 class gfxTextPerfMetrics {

 public:

     struct TextCounts {

         uint32_t    numContentTextRuns;

         uint32_t    numChromeTextRuns;

         uint32_t    numChars;

         uint32_t    maxTextRunLen;

         uint32_t    wordCacheSpaceRules;

         uint32_t    wordCacheLong;

         uint32_t    wordCacheHit;

         uint32_t    wordCacheMiss;

         uint32_t    fallbackPrefs;

         uint32_t    fallbackSystem;

         uint32_t    textrunConst;

         uint32_t    textrunDestr;

     };

     uint32_t reflowCount;

     // counts per reflow operation

     TextCounts current;

     // totals for the lifetime of a document

     TextCounts cumulative;

     gfxTextPerfMetrics() {

         memset(this, 0, sizeof(gfxTextPerfMetrics));

     }

     // add current totals to cumulative ones

     void Accumulate() {

         if (current.numChars == 0) {

             return;

         }

         cumulative.numContentTextRuns += current.numContentTextRuns;

         cumulative.numChromeTextRuns += current.numChromeTextRuns;

         cumulative.numChars += current.numChars;

         if (current.maxTextRunLen > cumulative.maxTextRunLen) {

             cumulative.maxTextRunLen = current.maxTextRunLen;

         }

         cumulative.wordCacheSpaceRules += current.wordCacheSpaceRules;

         cumulative.wordCacheLong += current.wordCacheLong;

         cumulative.wordCacheHit += current.wordCacheHit;

         cumulative.wordCacheMiss += current.wordCacheMiss;

         cumulative.fallbackPrefs += current.fallbackPrefs;

         cumulative.fallbackSystem += current.fallbackSystem;

         cumulative.textrunConst += current.textrunConst;

         cumulative.textrunDestr += current.textrunDestr;

         memset(&current, 0, sizeof(current));

     }

 };

 class gfxTextRunFactory {

     NS_INLINE_DECL_REFCOUNTING(gfxTextRunFactory)

 public:

     // Flags in the mask 0xFFFF0000 are reserved for textrun clients

     // Flags in the mask 0x0000F000 are reserved for per-platform fonts

     // Flags in the mask 0x00000FFF are set by the textrun creator.

     enum {

         CACHE_TEXT_FLAGS    = 0xF0000000,

         USER_TEXT_FLAGS     = 0x0FFF0000,

         PLATFORM_TEXT_FLAGS = 0x0000F000,

         TEXTRUN_TEXT_FLAGS  = 0x00000FFF,

         SETTABLE_FLAGS      = CACHE_TEXT_FLAGS | USER_TEXT_FLAGS,

         /**

          * When set, the text string pointer used to create the text run

          * is guaranteed to be available during the lifetime of the text run.

          */

         TEXT_IS_PERSISTENT           = 0x0001,

         /**

          * When set, the text is known to be all-ASCII (< 128).

          */

         TEXT_IS_ASCII                = 0x0002,

         /**

          * When set, the text is RTL.

          */

         TEXT_IS_RTL                  = 0x0004,

         /**

          * When set, spacing is enabled and the textrun needs to call GetSpacing

          * on the spacing provider.

          */

         TEXT_ENABLE_SPACING          = 0x0008,

         /**

          * When set, GetHyphenationBreaks may return true for some character

          * positions, otherwise it will always return false for all characters.

          */

         TEXT_ENABLE_HYPHEN_BREAKS    = 0x0010,

         /**

          * When set, the text has no characters above 255 and it is stored

          * in the textrun in 8-bit format.

          */

         TEXT_IS_8BIT                 = 0x0020,

         /**

          * When set, the RunMetrics::mBoundingBox field will be initialized

          * properly based on glyph extents, in particular, glyph extents that

          * overflow the standard font-box (the box defined by the ascent, descent

          * and advance width of the glyph). When not set, it may just be the

          * standard font-box even if glyphs overflow.

          */

         TEXT_NEED_BOUNDING_BOX       = 0x0040,

         /**

          * When set, optional ligatures are disabled. Ligatures that are

          * required for legible text should still be enabled.

          */

         TEXT_DISABLE_OPTIONAL_LIGATURES = 0x0080,

         /**

          * When set, the textrun should favour speed of construction over

          * quality. This may involve disabling ligatures and/or kerning or

          * other effects.

          */

         TEXT_OPTIMIZE_SPEED          = 0x0100,

         /**

          * For internal use by the memory reporter when accounting for

          * storage used by textruns.

          * Because the reporter may visit each textrun multiple times while

          * walking the frame trees and textrun cache, it needs to mark

          * textruns that have been seen so as to avoid multiple-accounting.

          */

         TEXT_RUN_SIZE_ACCOUNTED      = 0x0200,

         /**

          * When set, the textrun should discard control characters instead of

          * turning them into hexboxes.

          */

         TEXT_HIDE_CONTROL_CHARACTERS = 0x0400,

         /**

          * nsTextFrameThebes sets these, but they're defined here rather than

          * in nsTextFrameUtils.h because ShapedWord creation/caching also needs

          * to check the _INCOMING flag

          */

         TEXT_TRAILING_ARABICCHAR = 0x20000000,

         /**

          * When set, the previous character for this textrun was an Arabic

          * character.  This is used for the context detection necessary for

          * bidi.numeral implementation.

          */

         TEXT_INCOMING_ARABICCHAR = 0x40000000,

         // Set if the textrun should use the OpenType 'math' script.

         TEXT_USE_MATH_SCRIPT = 0x80000000,

         TEXT_UNUSED_FLAGS = 0x10000000

     };

     /**

      * This record contains all the parameters needed to initialize a textrun.

      */

     struct Parameters {

         // A reference context suggesting where the textrun will be rendered

         gfxContext   *mContext;

         // Pointer to arbitrary user data (which should outlive the textrun)

         void         *mUserData;

         // A description of which characters have been stripped from the original

         // DOM string to produce the characters in the textrun. May be null

         // if that information is not relevant.

         gfxSkipChars *mSkipChars;

         // A list of where linebreaks are currently placed in the textrun. May

         // be null if mInitialBreakCount is zero.

         uint32_t     *mInitialBreaks;

         uint32_t      mInitialBreakCount;

         // The ratio to use to convert device pixels to application layout units

         int32_t       mAppUnitsPerDevUnit;

     };

 protected:

     // Protected destructor, to discourage deletion outside of Release():

     virtual ~gfxTextRunFactory() {}

 };

 /**

  * This stores glyph bounds information for a particular gfxFont, at

  * a particular appunits-per-dev-pixel ratio (because the compressed glyph

  * width array is stored in appunits).

  * 

  * We store a hashtable from glyph IDs to float bounding rects. For the

  * common case where the glyph has no horizontal left bearing, and no

  * y overflow above the font ascent or below the font descent, and tight

  * bounding boxes are not required, we avoid storing the glyph ID in the hashtable

  * and instead consult an array of 16-bit glyph XMost values (in appunits).

  * This array always has an entry for the font's space glyph --- the width is

  * assumed to be zero.

  */

 class gfxGlyphExtents {

 public:

     gfxGlyphExtents(int32_t aAppUnitsPerDevUnit) :

         mAppUnitsPerDevUnit(aAppUnitsPerDevUnit) {

         MOZ_COUNT_CTOR(gfxGlyphExtents);

     }

     ~gfxGlyphExtents();

     enum { INVALID_WIDTH = 0xFFFF };

     void NotifyGlyphsChanged() {

         mTightGlyphExtents.Clear();

     }

     // returns INVALID_WIDTH => not a contained glyph

     // Otherwise the glyph has no before-bearing or vertical bearings,

     // and the result is its width measured from the baseline origin, in

     // appunits.

     uint16_t GetContainedGlyphWidthAppUnits(uint32_t aGlyphID) const {

         return mContainedGlyphWidths.Get(aGlyphID);

     }

     bool IsGlyphKnown(uint32_t aGlyphID) const {

         return mContainedGlyphWidths.Get(aGlyphID) != INVALID_WIDTH ||

             mTightGlyphExtents.GetEntry(aGlyphID) != nullptr;

     }

     bool IsGlyphKnownWithTightExtents(uint32_t aGlyphID) const {

         return mTightGlyphExtents.GetEntry(aGlyphID) != nullptr;

     }

     // Get glyph extents; a rectangle relative to the left baseline origin

     // Returns true on success. Can fail on OOM or when aContext is null

     // and extents were not (successfully) prefetched.

     bool GetTightGlyphExtentsAppUnits(gfxFont *aFont, gfxContext *aContext,

             uint32_t aGlyphID, gfxRect *aExtents);

     void SetContainedGlyphWidthAppUnits(uint32_t aGlyphID, uint16_t aWidth) {

         mContainedGlyphWidths.Set(aGlyphID, aWidth);

     }

     void SetTightGlyphExtents(uint32_t aGlyphID, const gfxRect& aExtentsAppUnits);

     int32_t GetAppUnitsPerDevUnit() { return mAppUnitsPerDevUnit; }

     size_t SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;

     size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;

 private:

     class HashEntry : public nsUint32HashKey {

     public:

         // When constructing a new entry in the hashtable, we'll leave this

         // blank. The caller of Put() will fill this in.

         HashEntry(KeyTypePointer aPtr) : nsUint32HashKey(aPtr) {}

         HashEntry(const HashEntry& toCopy) : nsUint32HashKey(toCopy) {

           x = toCopy.x; y = toCopy.y; width = toCopy.width; height = toCopy.height;

         }

         float x, y, width, height;

     };

     enum { BLOCK_SIZE_BITS = 7, BLOCK_SIZE = 1 << BLOCK_SIZE_BITS }; // 128-glyph blocks

     class GlyphWidths {

     public:

         void Set(uint32_t aIndex, uint16_t aValue);

         uint16_t Get(uint32_t aIndex) const {

             uint32_t block = aIndex >> BLOCK_SIZE_BITS;

             if (block >= mBlocks.Length())

                 return INVALID_WIDTH;

             uintptr_t bits = mBlocks[block];

             if (!bits)

                 return INVALID_WIDTH;

             uint32_t indexInBlock = aIndex & (BLOCK_SIZE - 1);

             if (bits & 0x1) {

                 if (GetGlyphOffset(bits) != indexInBlock)

                     return INVALID_WIDTH;

                 return GetWidth(bits);

             }

             uint16_t *widths = reinterpret_cast<uint16_t *>(bits);

             return widths[indexInBlock];

         }

         uint32_t SizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;

         ~GlyphWidths();

     private:

         static uint32_t GetGlyphOffset(uintptr_t aBits) {

             NS_ASSERTION(aBits & 0x1, "This is really a pointer...");

             return (aBits >> 1) & ((1 << BLOCK_SIZE_BITS) - 1);

         }

         static uint32_t GetWidth(uintptr_t aBits) {

             NS_ASSERTION(aBits & 0x1, "This is really a pointer...");

             return aBits >> (1 + BLOCK_SIZE_BITS);

         }

         static uintptr_t MakeSingle(uint32_t aGlyphOffset, uint16_t aWidth) {

             return (aWidth << (1 + BLOCK_SIZE_BITS)) + (aGlyphOffset << 1) + 1;

         }

         nsTArray<uintptr_t> mBlocks;

     };

     GlyphWidths             mContainedGlyphWidths;

     nsTHashtable<HashEntry> mTightGlyphExtents;

     int32_t                 mAppUnitsPerDevUnit;

 private:

     // not implemented:

     gfxGlyphExtents(const gfxGlyphExtents& aOther) MOZ_DELETE;

     gfxGlyphExtents& operator=(const gfxGlyphExtents& aOther) MOZ_DELETE;

 };

 /**

  * gfxFontShaper

  *

  * This class implements text shaping (character to glyph mapping and

  * glyph layout). There is a gfxFontShaper subclass for each text layout

  * technology (uniscribe, core text, harfbuzz,....) we support.

  *

  * The shaper is responsible for setting up glyph data in gfxTextRuns.

  *

  * A generic, platform-independent shaper relies only on the standard

  * gfxFont interface and can work with any concrete subclass of gfxFont.

  *

  * Platform-specific implementations designed to interface to platform

  * shaping APIs such as Uniscribe or CoreText may rely on features of a

  * specific font subclass to access native font references

  * (such as CTFont, HFONT, DWriteFont, etc).

  */

 class gfxFontShaper {

 public:

     gfxFontShaper(gfxFont *aFont)

         : mFont(aFont)

     {

         NS_ASSERTION(aFont, "shaper requires a valid font!");

     }

     virtual ~gfxFontShaper() { }

     // Shape a piece of text and store the resulting glyph data into

     // aShapedText. Parameters aOffset/aLength indicate the range of

     // aShapedText to be updated; aLength is also the length of aText.

     virtual bool ShapeText(gfxContext      *aContext,

                            const char16_t *aText,

                            uint32_t         aOffset,

                            uint32_t         aLength,

                            int32_t          aScript,

                            gfxShapedText   *aShapedText) = 0;

     gfxFont *GetFont() const { return mFont; }

     // returns true if features exist in output, false otherwise

     static bool

     MergeFontFeatures(const gfxFontStyle *aStyle,

                       const nsTArray<gfxFontFeature>& aFontFeatures,

                       bool aDisableLigatures,

                       const nsAString& aFamilyName,

                       nsDataHashtable<nsUint32HashKey,uint32_t>& aMergedFeatures);

 protected:

     // the font this shaper is working with

     gfxFont * mFont;

 };

 /* a SPECIFIC single font family */

 class gfxFont {

     friend class gfxHarfBuzzShaper;

     friend class gfxGraphiteShaper;

 public:

     nsrefcnt AddRef(void) {

         NS_PRECONDITION(int32_t(mRefCnt) >= 0, "illegal refcnt");

         if (mExpirationState.IsTracked()) {

             gfxFontCache::GetCache()->RemoveObject(this);

         }

         ++mRefCnt;

         NS_LOG_ADDREF(this, mRefCnt, "gfxFont", sizeof(*this));

         return mRefCnt;

     }

     nsrefcnt Release(void) {

         NS_PRECONDITION(0 != mRefCnt, "dup release");

         --mRefCnt;

         NS_LOG_RELEASE(this, mRefCnt, "gfxFont");

         if (mRefCnt == 0) {

             NotifyReleased();

             // |this| may have been deleted.

             return 0;

         }

         return mRefCnt;

     }

     int32_t GetRefCount() { return mRefCnt; }

     // options to specify the kind of AA to be used when creating a font

     typedef enum {

         kAntialiasDefault,

         kAntialiasNone,

         kAntialiasGrayscale,

         kAntialiasSubpixel

     } AntialiasOption;

 protected:

     nsAutoRefCnt mRefCnt;

     cairo_scaled_font_t *mScaledFont;

     void NotifyReleased() {

         gfxFontCache *cache = gfxFontCache::GetCache();

         if (cache) {

             // Don't delete just yet; return the object to the cache for

             // possibly recycling within some time limit

             cache->NotifyReleased(this);

         } else {

             // The cache may have already been shut down.

             delete this;

         }

     }

     gfxFont(gfxFontEntry *aFontEntry, const gfxFontStyle *aFontStyle,

             AntialiasOption anAAOption = kAntialiasDefault,

             cairo_scaled_font_t *aScaledFont = nullptr);

 public:

     virtual ~gfxFont();

     bool Valid() const {

         return mIsValid;

     }

     // options for the kind of bounding box to return from measurement

     typedef enum {

         LOOSE_INK_EXTENTS,

             // A box that encloses all the painted pixels, and may

             // include sidebearings and/or additional ascent/descent

             // within the glyph cell even if the ink is smaller.

         TIGHT_INK_EXTENTS,

             // A box that tightly encloses all the painted pixels

             // (although actually on Windows, at least, it may be

             // slightly larger than strictly necessary because

             // we can't get precise extents with ClearType).

         TIGHT_HINTED_OUTLINE_EXTENTS

             // A box that tightly encloses the glyph outline,

             // ignoring possible antialiasing pixels that extend

             // beyond this.

             // NOTE: The default implementation of gfxFont::Measure(),

             // which works with the glyph extents cache, does not

             // differentiate between this and TIGHT_INK_EXTENTS.

             // Whether the distinction is important depends on the

             // antialiasing behavior of the platform; currently the

             // distinction is only implemented in the gfxWindowsFont

             // subclass, because of ClearType's tendency to paint

             // outside the hinted outline.

             // Also NOTE: it is relatively expensive to request this,

             // as it does not use cached glyph extents in the font.

     } BoundingBoxType;

     const nsString& GetName() const { return mFontEntry->Name(); }

     const gfxFontStyle *GetStyle() const { return &mStyle; }

     virtual cairo_scaled_font_t* GetCairoScaledFont() { return mScaledFont; }

     virtual gfxFont* CopyWithAntialiasOption(AntialiasOption anAAOption) {

         // platforms where this actually matters should override

         return nullptr;

     }

     virtual gfxFloat GetAdjustedSize() {

         return mAdjustedSize > 0.0 ? mAdjustedSize : mStyle.size;

     }

     float FUnitsToDevUnitsFactor() const {

         // check this was set up during font initialization

         NS_ASSERTION(mFUnitsConvFactor > 0.0f, "mFUnitsConvFactor not valid");

         return mFUnitsConvFactor;

     }

     // check whether this is an sfnt we can potentially use with harfbuzz

     bool FontCanSupportHarfBuzz() {

         return mFontEntry->HasCmapTable();

     }

     // check whether this is an sfnt we can potentially use with Graphite

     bool FontCanSupportGraphite() {

         return mFontEntry->HasGraphiteTables();

     }

     // Subclasses may choose to look up glyph ids for characters.

     // If they do not override this, gfxHarfBuzzShaper will fetch the cmap

     // table and use that.

     virtual bool ProvidesGetGlyph() const {

         return false;

     }

     // Map unicode character to glyph ID.

     // Only used if ProvidesGetGlyph() returns true.

     virtual uint32_t GetGlyph(uint32_t unicode, uint32_t variation_selector) {

         return 0;

     }

     // Return the horizontal advance of a glyph.

     gfxFloat GetGlyphHAdvance(gfxContext *aCtx, uint16_t aGID);

     // Return Azure GlyphRenderingOptions for drawing this font.

     virtual mozilla::TemporaryRef<mozilla::gfx::GlyphRenderingOptions>

       GetGlyphRenderingOptions() { return nullptr; }

     gfxFloat SynthesizeSpaceWidth(uint32_t aCh);

     // Font metrics

     struct Metrics {

         gfxFloat xHeight;

         gfxFloat superscriptOffset;

         gfxFloat subscriptOffset;

         gfxFloat strikeoutSize;

         gfxFloat strikeoutOffset;

         gfxFloat underlineSize;

         gfxFloat underlineOffset;

         gfxFloat internalLeading;

         gfxFloat externalLeading;

         gfxFloat emHeight;

         gfxFloat emAscent;

         gfxFloat emDescent;

         gfxFloat maxHeight;

         gfxFloat maxAscent;

         gfxFloat maxDescent;

         gfxFloat maxAdvance;

         gfxFloat aveCharWidth;

         gfxFloat spaceWidth;

         gfxFloat zeroOrAveCharWidth;  // width of '0', or if there is

                                       // no '0' glyph in this font,

                                       // equal to .aveCharWidth

     };

     virtual const gfxFont::Metrics& GetMetrics() = 0;

     /**

      * We let layout specify spacing on either side of any

      * character. We need to specify both before and after

      * spacing so that substring measurement can do the right things.

      * These values are in appunits. They're always an integral number of

      * appunits, but we specify them in floats in case very large spacing

      * values are required.

      */

     struct Spacing {

         gfxFloat mBefore;

         gfxFloat mAfter;

     };

     /**

      * Metrics for a particular string

      */

     struct RunMetrics {

         RunMetrics() {

             mAdvanceWidth = mAscent = mDescent = 0.0;

         }

         void CombineWith(const RunMetrics& aOther, bool aOtherIsOnLeft);

         // can be negative (partly due to negative spacing).

         // Advance widths should be additive: the advance width of the

         // (offset1, length1) plus the advance width of (offset1 + length1,

         // length2) should be the advance width of (offset1, length1 + length2)

         gfxFloat mAdvanceWidth;

         // For zero-width substrings, these must be zero!

         gfxFloat mAscent;  // always non-negative

         gfxFloat mDescent; // always non-negative

         // Bounding box that is guaranteed to include everything drawn.

         // If a tight boundingBox was requested when these metrics were

         // generated, this will tightly wrap the glyphs, otherwise it is

         // "loose" and may be larger than the true bounding box.

         // Coordinates are relative to the baseline left origin, so typically

         // mBoundingBox.y == -mAscent

         gfxRect  mBoundingBox;

     };

     /**

      * Draw a series of glyphs to aContext. The direction of aTextRun must

      * be honoured.

      * @param aStart the first character to draw

      * @param aEnd draw characters up to here

      * @param aBaselineOrigin the baseline origin; the left end of the baseline

      * for LTR textruns, the right end of the baseline for RTL textruns. On return,

      * this should be updated to the other end of the baseline. In application

      * units, really!

      * @param aSpacing spacing to insert before and after characters (for RTL

      * glyphs, before-spacing is inserted to the right of characters). There

      * are aEnd - aStart elements in this array, unless it's null to indicate

      * that there is no spacing.

      * @param aDrawMode specifies whether the fill or stroke of the glyph should be

      * drawn, or if it should be drawn into the current path

      * @param aContextPaint information about how to construct the fill and

      * stroke pattern. Can be nullptr if we are not stroking the text, which

      * indicates that the current source from aContext should be used for filling

      * 

      * Callers guarantee:

      * -- aStart and aEnd are aligned to cluster and ligature boundaries

      * -- all glyphs use this font

      * 

      * The default implementation builds a cairo glyph array and

      * calls cairo_show_glyphs or cairo_glyph_path.

      */

     virtual void Draw(gfxTextRun *aTextRun, uint32_t aStart, uint32_t aEnd,

                       gfxContext *aContext, DrawMode aDrawMode, gfxPoint *aBaselineOrigin,

                       Spacing *aSpacing, gfxTextContextPaint *aContextPaint,

                       gfxTextRunDrawCallbacks *aCallbacks);

     /**

      * Measure a run of characters. See gfxTextRun::Metrics.

      * @param aTight if false, then return the union of the glyph extents

      * with the font-box for the characters (the rectangle with x=0,width=

      * the advance width for the character run,y=-(font ascent), and height=

      * font ascent + font descent). Otherwise, we must return as tight as possible

      * an approximation to the area actually painted by glyphs.

      * @param aContextForTightBoundingBox when aTight is true, this must

      * be non-null.

      * @param aSpacing spacing to insert before and after glyphs. The bounding box

      * need not include the spacing itself, but the spacing affects the glyph

      * positions. null if there is no spacing.

      * 

      * Callers guarantee:

      * -- aStart and aEnd are aligned to cluster and ligature boundaries

      * -- all glyphs use this font

      * 

      * The default implementation just uses font metrics and aTextRun's

      * advances, and assumes no characters fall outside the font box. In

      * general this is insufficient, because that assumption is not always true.

      */

     virtual RunMetrics Measure(gfxTextRun *aTextRun,

                                uint32_t aStart, uint32_t aEnd,

                                BoundingBoxType aBoundingBoxType,

                                gfxContext *aContextForTightBoundingBox,

                                Spacing *aSpacing);

     /**

      * Line breaks have been changed at the beginning and/or end of a substring

      * of the text. Reshaping may be required; glyph updating is permitted.

      * @return true if anything was changed, false otherwise

      */

     bool NotifyLineBreaksChanged(gfxTextRun *aTextRun,

                                    uint32_t aStart, uint32_t aLength)

     { return false; }

     // Expiration tracking

     nsExpirationState *GetExpirationState() { return &mExpirationState; }

     // Get the glyphID of a space

     virtual uint32_t GetSpaceGlyph() = 0;

     gfxGlyphExtents *GetOrCreateGlyphExtents(int32_t aAppUnitsPerDevUnit);

     // You need to call SetupCairoFont on the aCR just before calling this

     virtual void SetupGlyphExtents(gfxContext *aContext, uint32_t aGlyphID,

                                    bool aNeedTight, gfxGlyphExtents *aExtents);

     // This is called by the default Draw() implementation above.

     virtual bool SetupCairoFont(gfxContext *aContext) = 0;

     virtual bool AllowSubpixelAA() { return true; }

     bool IsSyntheticBold() { return mApplySyntheticBold; }

     // Amount by which synthetic bold "fattens" the glyphs:

     // For size S up to a threshold size T, we use (0.25 + 3S / 4T),

     // so that the result ranges from 0.25 to 1.0; thereafter,

     // simply use (S / T).

     gfxFloat GetSyntheticBoldOffset() {

         gfxFloat size = GetAdjustedSize();

         const gfxFloat threshold = 48.0;

         return size < threshold ? (0.25 + 0.75 * size / threshold) :

                                   (size / threshold);

     }

     gfxFontEntry *GetFontEntry() { return mFontEntry.get(); }

     bool HasCharacter(uint32_t ch) {

         if (!mIsValid)

             return false;

         return mFontEntry->HasCharacter(ch); 

     }

     uint16_t GetUVSGlyph(uint32_t aCh, uint32_t aVS) {

         if (!mIsValid) {

             return 0;

         }

         return mFontEntry->GetUVSGlyph(aCh, aVS); 

     }

     // call the (virtual) InitTextRun method to do glyph generation/shaping,

     // limiting the length of text passed by processing the run in multiple

     // segments if necessary

     template<typename T>

     bool SplitAndInitTextRun(gfxContext *aContext,

                              gfxTextRun *aTextRun,

                              const T *aString,

                              uint32_t aRunStart,

                              uint32_t aRunLength,

                              int32_t aRunScript);

     // Get a ShapedWord representing the given text (either 8- or 16-bit)

     // for use in setting up a gfxTextRun.

     template<typename T>

     gfxShapedWord* GetShapedWord(gfxContext *aContext,

                                  const T *aText,

                                  uint32_t aLength,

                                  uint32_t aHash,

                                  int32_t aRunScript,

                                  int32_t aAppUnitsPerDevUnit,

                                  uint32_t aFlags,

                                  gfxTextPerfMetrics *aTextPerf);

     // Ensure the ShapedWord cache is initialized. This MUST be called before

     // any attempt to use GetShapedWord().

     void InitWordCache() {

         if (!mWordCache) {

             mWordCache = new nsTHashtable<CacheHashEntry>;

         }

     }

     // Called by the gfxFontCache timer to increment the age of all the words,

     // so that they'll expire after a sufficient period of non-use

     void AgeCachedWords() {

         if (mWordCache) {

             (void)mWordCache->EnumerateEntries(AgeCacheEntry, this);

         }

     }

     // Discard all cached word records; called on memory-pressure notification.

     void ClearCachedWords() {

         if (mWordCache) {

             mWordCache->Clear();

         }

     }

     // Glyph rendering/geometry has changed, so invalidate data as necessary.

     void NotifyGlyphsChanged();

     virtual void AddSizeOfExcludingThis(mozilla::MallocSizeOf aMallocSizeOf,

                                         FontCacheSizes* aSizes) const;

     virtual void AddSizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf,

                                         FontCacheSizes* aSizes) const;

     typedef enum {

         FONT_TYPE_DWRITE,

         FONT_TYPE_GDI,

         FONT_TYPE_FT2,

         FONT_TYPE_MAC,

         FONT_TYPE_OS2,

         FONT_TYPE_CAIRO

     } FontType;

     virtual FontType GetType() const = 0;

     virtual mozilla::TemporaryRef<mozilla::gfx::ScaledFont> GetScaledFont(mozilla::gfx::DrawTarget *aTarget)

     { return gfxPlatform::GetPlatform()->GetScaledFontForFont(aTarget, this); }

     bool KerningDisabled() {

         return mKerningSet && !mKerningEnabled;

     }

     /**

      * Subclass this object to be notified of glyph changes. Delete the object

      * when no longer needed.

      */

     class GlyphChangeObserver {

     public:

         virtual ~GlyphChangeObserver()

         {

             if (mFont) {

                 mFont->RemoveGlyphChangeObserver(this);

             }

         }

         // This gets called when the gfxFont dies.

         void ForgetFont() { mFont = nullptr; }

         virtual void NotifyGlyphsChanged() = 0;

     protected:

         GlyphChangeObserver(gfxFont *aFont) : mFont(aFont)

         {

             mFont->AddGlyphChangeObserver(this);

         }

         gfxFont* mFont;

     };

     friend class GlyphChangeObserver;

     bool GlyphsMayChange()

     {

         // Currently only fonts with SVG glyphs can have animated glyphs

         return mFontEntry->TryGetSVGData(this);

     }

     static void DestroySingletons() {

         delete sScriptTagToCode;

         delete sDefaultFeatures;

     }

 protected:

     // subclasses may provide (possibly hinted) glyph widths (in font units);

     // if they do not override this, harfbuzz will use unhinted widths

     // derived from the font tables

     virtual bool ProvidesGlyphWidths() {

         return false;

     }

     // The return value is interpreted as a horizontal advance in 16.16 fixed

     // point format.

     virtual int32_t GetGlyphWidth(gfxContext *aCtx, uint16_t aGID) {

         return -1;

     }

     void AddGlyphChangeObserver(GlyphChangeObserver *aObserver);

     void RemoveGlyphChangeObserver(GlyphChangeObserver *aObserver);

     // whether font contains substitution lookups containing spaces

     bool HasSubstitutionRulesWithSpaceLookups(int32_t aRunScript);

     // do spaces participate in shaping rules? if so, can't used word cache

     bool SpaceMayParticipateInShaping(int32_t aRunScript);

     // For 8-bit text, expand to 16-bit and then call the following method.

     bool ShapeText(gfxContext    *aContext,

                    const uint8_t *aText,

                    uint32_t       aOffset, // dest offset in gfxShapedText

                    uint32_t       aLength,

                    int32_t        aScript,

                    gfxShapedText *aShapedText, // where to store the result

                    bool           aPreferPlatformShaping = false);

     // Call the appropriate shaper to generate glyphs for aText and store

     // them into aShapedText.

     virtual bool ShapeText(gfxContext      *aContext,

                            const char16_t *aText,

                            uint32_t         aOffset,

                            uint32_t         aLength,

                            int32_t          aScript,

                            gfxShapedText   *aShapedText,

                            bool             aPreferPlatformShaping = false);

     // Helper to adjust for synthetic bold and set character-type flags

     // in the shaped text; implementations of ShapeText should call this

     // after glyph shaping has been completed.

     void PostShapingFixup(gfxContext      *aContext,

                           const char16_t *aText,

                           uint32_t         aOffset, // position within aShapedText

                           uint32_t         aLength,

                           gfxShapedText   *aShapedText);

     // Shape text directly into a range within a textrun, without using the

     // font's word cache. Intended for use when the font has layout features

     // that involve space, and therefore require shaping complete runs rather

     // than isolated words, or for long strings that are inefficient to cache.

     // This will split the text on "invalid" characters (tab/newline) that are

     // not handled via normal shaping, but does not otherwise divide up the

     // text.

     template<typename T>

     bool ShapeTextWithoutWordCache(gfxContext *aContext,

                                    const T    *aText,

                                    uint32_t    aOffset,

                                    uint32_t    aLength,

                                    int32_t     aScript,

                                    gfxTextRun *aTextRun);

     // Shape a fragment of text (a run that is known to contain only

     // "valid" characters, no newlines/tabs/other control chars).

     // All non-wordcache shaping goes through here; this is the function

     // that will ensure we don't pass excessively long runs to the various

     // platform shapers.

     template<typename T>

     bool ShapeFragmentWithoutWordCache(gfxContext *aContext,

                                        const T    *aText,

                                        uint32_t    aOffset,

                                        uint32_t    aLength,

                                        int32_t     aScript,

                                        gfxTextRun *aTextRun);

     void CheckForFeaturesInvolvingSpace();

     // whether a given feature is included in feature settings from both the

     // font and the style. aFeatureOn set if resolved feature value is non-zero

     bool HasFeatureSet(uint32_t aFeature, bool& aFeatureOn);

     // used when analyzing whether a font has space contextual lookups

     static nsDataHashtable<nsUint32HashKey, int32_t> *sScriptTagToCode;

     static nsTHashtable<nsUint32HashKey>             *sDefaultFeatures;

     nsRefPtr<gfxFontEntry> mFontEntry;

     struct CacheHashKey {

         union {

             const uint8_t   *mSingle;

             const char16_t *mDouble;

         }                mText;

         uint32_t         mLength;

         uint32_t         mFlags;

         int32_t          mScript;

         int32_t          mAppUnitsPerDevUnit;

         PLDHashNumber    mHashKey;

         bool             mTextIs8Bit;

         CacheHashKey(const uint8_t *aText, uint32_t aLength,

                      uint32_t aStringHash,

                      int32_t aScriptCode, int32_t aAppUnitsPerDevUnit,

                      uint32_t aFlags)

             : mLength(aLength),

               mFlags(aFlags),

               mScript(aScriptCode),

               mAppUnitsPerDevUnit(aAppUnitsPerDevUnit),

               mHashKey(aStringHash + aScriptCode +

                   aAppUnitsPerDevUnit * 0x100 + aFlags * 0x10000),

               mTextIs8Bit(true)

         {

             NS_ASSERTION(aFlags & gfxTextRunFactory::TEXT_IS_8BIT,

                          "8-bit flag should have been set");

             mText.mSingle = aText;

         }

         CacheHashKey(const char16_t *aText, uint32_t aLength,

                      uint32_t aStringHash,

                      int32_t aScriptCode, int32_t aAppUnitsPerDevUnit,

                      uint32_t aFlags)

             : mLength(aLength),

               mFlags(aFlags),

               mScript(aScriptCode),

               mAppUnitsPerDevUnit(aAppUnitsPerDevUnit),

               mHashKey(aStringHash + aScriptCode +

                   aAppUnitsPerDevUnit * 0x100 + aFlags * 0x10000),

               mTextIs8Bit(false)

         {

             // We can NOT assert that TEXT_IS_8BIT is false in aFlags here,

             // because this might be an 8bit-only word from a 16-bit textrun,

             // in which case the text we're passed is still in 16-bit form,

             // and we'll have to use an 8-to-16bit comparison in KeyEquals.

             mText.mDouble = aText;

         }

     };

     class CacheHashEntry : public PLDHashEntryHdr {

     public:

         typedef const CacheHashKey &KeyType;

         typedef const CacheHashKey *KeyTypePointer;

         // When constructing a new entry in the hashtable, the caller of Put()

         // will fill us in.

         CacheHashEntry(KeyTypePointer aKey) { }

         CacheHashEntry(const CacheHashEntry& toCopy) { NS_ERROR("Should not be called"); }

         ~CacheHashEntry() { }

         bool KeyEquals(const KeyTypePointer aKey) const;

         static KeyTypePointer KeyToPointer(KeyType aKey) { return &aKey; }

         static PLDHashNumber HashKey(const KeyTypePointer aKey) {

             return aKey->mHashKey;

         }

         enum { ALLOW_MEMMOVE = true };

         nsAutoPtr<gfxShapedWord> mShapedWord;

     };

     static size_t

     WordCacheEntrySizeOfExcludingThis(CacheHashEntry*   aHashEntry,

                                       mozilla::MallocSizeOf aMallocSizeOf,

                                       void*             aUserArg);

     nsAutoPtr<nsTHashtable<CacheHashEntry> > mWordCache;

     static PLDHashOperator AgeCacheEntry(CacheHashEntry *aEntry, void *aUserData);

     static const uint32_t  kShapedWordCacheMaxAge = 3;

     bool                       mIsValid;

     // use synthetic bolding for environments where this is not supported

     // by the platform

     bool                       mApplySyntheticBold;

     bool                       mKerningSet;     // kerning explicitly set?

     bool                       mKerningEnabled; // if set, on or off?

     nsExpirationState          mExpirationState;

     gfxFontStyle               mStyle;

     nsAutoTArray<gfxGlyphExtents*,1> mGlyphExtentsArray;

     nsAutoPtr<nsTHashtable<nsPtrHashKey<GlyphChangeObserver> > > mGlyphChangeObservers;

     gfxFloat                   mAdjustedSize;

     float                      mFUnitsConvFactor; // conversion factor from font units to dev units

     // the AA setting requested for this font - may affect glyph bounds

     AntialiasOption            mAntialiasOption;

     // a copy of the font without antialiasing, if needed for separate

     // measurement by mathml code

     nsAutoPtr<gfxFont>         mNonAAFont;

     // we may switch between these shapers on the fly, based on the script

     // of the text run being shaped

     nsAutoPtr<gfxFontShaper>   mPlatformShaper;

     nsAutoPtr<gfxFontShaper>   mHarfBuzzShaper;

     nsAutoPtr<gfxFontShaper>   mGraphiteShaper;

     mozilla::RefPtr<mozilla::gfx::ScaledFont> mAzureScaledFont;

     // Create a default platform text shaper for this font.

     // (TODO: This should become pure virtual once all font backends have

     // been updated.)

     virtual void CreatePlatformShaper() { }

     // Helper for subclasses that want to initialize standard metrics from the

     // tables of sfnt (TrueType/OpenType) fonts.

     // This will use mFUnitsConvFactor if it is already set, else compute it

     // from mAdjustedSize and the unitsPerEm in the font's 'head' table.

     // Returns TRUE and sets mIsValid=TRUE if successful;

     // Returns TRUE but leaves mIsValid=FALSE if the font seems to be broken.

     // Returns FALSE if the font does not appear to be an sfnt at all,

     // and should be handled (if possible) using other APIs.

     bool InitMetricsFromSfntTables(Metrics& aMetrics);

     // Helper to calculate various derived metrics from the results of

     // InitMetricsFromSfntTables or equivalent platform code

     void CalculateDerivedMetrics(Metrics& aMetrics);

     // some fonts have bad metrics, this method sanitize them.

     // if this font has bad underline offset, aIsBadUnderlineFont should be true.

     void SanitizeMetrics(gfxFont::Metrics *aMetrics, bool aIsBadUnderlineFont);

     bool RenderSVGGlyph(gfxContext *aContext, gfxPoint aPoint, DrawMode aDrawMode,

                         uint32_t aGlyphId, gfxTextContextPaint *aContextPaint);

     bool RenderSVGGlyph(gfxContext *aContext, gfxPoint aPoint, DrawMode aDrawMode,

                         uint32_t aGlyphId, gfxTextContextPaint *aContextPaint,

                         gfxTextRunDrawCallbacks *aCallbacks,

                         bool& aEmittedGlyphs);

     // Bug 674909. When synthetic bolding text by drawing twice, need to

     // render using a pixel offset in device pixels, otherwise text

     // doesn't appear bolded, it appears as if a bad text shadow exists

     // when a non-identity transform exists.  Use an offset factor so that

     // the second draw occurs at a constant offset in device pixels.

     // This helper calculates the scale factor we need to apply to the

     // synthetic-bold offset.

     static double CalcXScale(gfxContext *aContext);

 };

 // proportion of ascent used for x-height, if unable to read value from font

 #define DEFAULT_XHEIGHT_FACTOR 0.56f

 /*

  * gfxShapedText is an abstract superclass for gfxShapedWord and gfxTextRun.

  * These are objects that store a list of zero or more glyphs for each character.

  * For each glyph we store the glyph ID, the advance, and possibly x/y-offsets.

  * The idea is that a string is rendered by a loop that draws each glyph

  * at its designated offset from the current point, then advances the current

  * point by the glyph's advance in the direction of the textrun (LTR or RTL).

  * Each glyph advance is always rounded to the nearest appunit; this ensures

  * consistent results when dividing the text in a textrun into multiple text

  * frames (frame boundaries are always aligned to appunits). We optimize

  * for the case where a character has a single glyph and zero xoffset and yoffset,

  * and the glyph ID and advance are in a reasonable range so we can pack all

  * necessary data into 32 bits.

  *

  * gfxFontShaper can shape text into either a gfxShapedWord (cached by a gfxFont)

  * or directly into a gfxTextRun (for cases where we want to shape textruns in

  * their entirety rather than using cached words, because there may be layout

  * features that depend on the inter-word spaces).

  */

 class gfxShapedText

 {

 public:

     gfxShapedText(uint32_t aLength, uint32_t aFlags,

                   int32_t aAppUnitsPerDevUnit)

         : mLength(aLength)

         , mFlags(aFlags)

         , mAppUnitsPerDevUnit(aAppUnitsPerDevUnit)

     { }

     virtual ~gfxShapedText() { }

     /**

      * This class records the information associated with a character in the

      * input string. It's optimized for the case where there is one glyph

      * representing that character alone.

      * 

      * A character can have zero or more associated glyphs. Each glyph

      * has an advance width and an x and y offset.

      * A character may be the start of a cluster.

      * A character may be the start of a ligature group.

      * A character can be "missing", indicating that the system is unable

      * to render the character.

      * 

      * All characters in a ligature group conceptually share all the glyphs

      * associated with the characters in a group.

      */

     class CompressedGlyph {

     public:

         CompressedGlyph() { mValue = 0; }

         enum {

             // Indicates that a cluster and ligature group starts at this

             // character; this character has a single glyph with a reasonable

             // advance and zero offsets. A "reasonable" advance

             // is one that fits in the available bits (currently 12) (specified

             // in appunits).

             FLAG_IS_SIMPLE_GLYPH  = 0x80000000U,

             // Indicates whether a linebreak is allowed before this character;

             // this is a two-bit field that holds a FLAG_BREAK_TYPE_xxx value

             // indicating the kind of linebreak (if any) allowed here.

             FLAGS_CAN_BREAK_BEFORE = 0x60000000U,

             FLAGS_CAN_BREAK_SHIFT = 29,

             FLAG_BREAK_TYPE_NONE   = 0,

             FLAG_BREAK_TYPE_NORMAL = 1,

             FLAG_BREAK_TYPE_HYPHEN = 2,

             FLAG_CHAR_IS_SPACE     = 0x10000000U,

             // The advance is stored in appunits

             ADVANCE_MASK  = 0x0FFF0000U,

             ADVANCE_SHIFT = 16,

             GLYPH_MASK = 0x0000FFFFU,

             // Non-simple glyphs may or may not have glyph data in the

             // corresponding mDetailedGlyphs entry. They have the following

             // flag bits:

             // When NOT set, indicates that this character corresponds to a

             // missing glyph and should be skipped (or possibly, render the character

             // Unicode value in some special way). If there are glyphs,

             // the mGlyphID is actually the UTF16 character code. The bit is

             // inverted so we can memset the array to zero to indicate all missing.

             FLAG_NOT_MISSING              = 0x01,

             FLAG_NOT_CLUSTER_START        = 0x02,

             FLAG_NOT_LIGATURE_GROUP_START = 0x04,

             FLAG_CHAR_IS_TAB              = 0x08,

             FLAG_CHAR_IS_NEWLINE          = 0x10,

             FLAG_CHAR_IS_LOW_SURROGATE    = 0x20,

             CHAR_IDENTITY_FLAGS_MASK      = 0x38,

             GLYPH_COUNT_MASK = 0x00FFFF00U,

             GLYPH_COUNT_SHIFT = 8

         };

         // "Simple glyphs" have a simple glyph ID, simple advance and their

         // x and y offsets are zero. Also the glyph extents do not overflow

         // the font-box defined by the font ascent, descent and glyph advance width.

         // These case is optimized to avoid storing DetailedGlyphs.

         // Returns true if the glyph ID aGlyph fits into the compressed representation

         static bool IsSimpleGlyphID(uint32_t aGlyph) {

             return (aGlyph & GLYPH_MASK) == aGlyph;

         }

         // Returns true if the advance aAdvance fits into the compressed representation.

         // aAdvance is in appunits.

         static bool IsSimpleAdvance(uint32_t aAdvance) {

             return (aAdvance & (ADVANCE_MASK >> ADVANCE_SHIFT)) == aAdvance;

         }

         bool IsSimpleGlyph() const { return (mValue & FLAG_IS_SIMPLE_GLYPH) != 0; }

         uint32_t GetSimpleAdvance() const { return (mValue & ADVANCE_MASK) >> ADVANCE_SHIFT; }

         uint32_t GetSimpleGlyph() const { return mValue & GLYPH_MASK; }

         bool IsMissing() const { return (mValue & (FLAG_NOT_MISSING|FLAG_IS_SIMPLE_GLYPH)) == 0; }

         bool IsClusterStart() const {

             return (mValue & FLAG_IS_SIMPLE_GLYPH) || !(mValue & FLAG_NOT_CLUSTER_START);

         }

         bool IsLigatureGroupStart() const {

             return (mValue & FLAG_IS_SIMPLE_GLYPH) || !(mValue & FLAG_NOT_LIGATURE_GROUP_START);

         }

         bool IsLigatureContinuation() const {

             return (mValue & FLAG_IS_SIMPLE_GLYPH) == 0 &&

                 (mValue & (FLAG_NOT_LIGATURE_GROUP_START | FLAG_NOT_MISSING)) ==

                     (FLAG_NOT_LIGATURE_GROUP_START | FLAG_NOT_MISSING);

         }

         // Return true if the original character was a normal (breakable,

         // trimmable) space (U+0020). Not true for other characters that

         // may happen to map to the space glyph (U+00A0).

         bool CharIsSpace() const {

             return (mValue & FLAG_CHAR_IS_SPACE) != 0;

         }

         bool CharIsTab() const {

             return !IsSimpleGlyph() && (mValue & FLAG_CHAR_IS_TAB) != 0;

         }

         bool CharIsNewline() const {

             return !IsSimpleGlyph() && (mValue & FLAG_CHAR_IS_NEWLINE) != 0;

         }

         bool CharIsLowSurrogate() const {

             return !IsSimpleGlyph() && (mValue & FLAG_CHAR_IS_LOW_SURROGATE) != 0;

         }

         uint32_t CharIdentityFlags() const {

             return IsSimpleGlyph() ? 0 : (mValue & CHAR_IDENTITY_FLAGS_MASK);

         }

         void SetClusterStart(bool aIsClusterStart) {

             NS_ASSERTION(!IsSimpleGlyph(),

                          "can't call SetClusterStart on simple glyphs");

             if (aIsClusterStart) {

                 mValue &= ~FLAG_NOT_CLUSTER_START;

             } else {

                 mValue |= FLAG_NOT_CLUSTER_START;

             }

         }

         uint8_t CanBreakBefore() const {

             return (mValue & FLAGS_CAN_BREAK_BEFORE) >> FLAGS_CAN_BREAK_SHIFT;

         }

         // Returns FLAGS_CAN_BREAK_BEFORE if the setting changed, 0 otherwise

         uint32_t SetCanBreakBefore(uint8_t aCanBreakBefore) {

             NS_ASSERTION(aCanBreakBefore <= 2,

                          "Bogus break-before value!");

             uint32_t breakMask = (uint32_t(aCanBreakBefore) << FLAGS_CAN_BREAK_SHIFT);

             uint32_t toggle = breakMask ^ (mValue & FLAGS_CAN_BREAK_BEFORE);

             mValue ^= toggle;

             return toggle;

         }

         CompressedGlyph& SetSimpleGlyph(uint32_t aAdvanceAppUnits, uint32_t aGlyph) {

             NS_ASSERTION(IsSimpleAdvance(aAdvanceAppUnits), "Advance overflow");

             NS_ASSERTION(IsSimpleGlyphID(aGlyph), "Glyph overflow");

             NS_ASSERTION(!CharIdentityFlags(), "Char identity flags lost");

             mValue = (mValue & (FLAGS_CAN_BREAK_BEFORE | FLAG_CHAR_IS_SPACE)) |

                 FLAG_IS_SIMPLE_GLYPH |

                 (aAdvanceAppUnits << ADVANCE_SHIFT) | aGlyph;

             return *this;

         }

         CompressedGlyph& SetComplex(bool aClusterStart, bool aLigatureStart,

                 uint32_t aGlyphCount) {

             mValue = (mValue & (FLAGS_CAN_BREAK_BEFORE | FLAG_CHAR_IS_SPACE)) |

                 FLAG_NOT_MISSING |

                 CharIdentityFlags() |

                 (aClusterStart ? 0 : FLAG_NOT_CLUSTER_START) |

                 (aLigatureStart ? 0 : FLAG_NOT_LIGATURE_GROUP_START) |

                 (aGlyphCount << GLYPH_COUNT_SHIFT);

             return *this;

         }

         /**

          * Missing glyphs are treated as ligature group starts; don't mess with

          * the cluster-start flag (see bugs 618870 and 619286).

          */

         CompressedGlyph& SetMissing(uint32_t aGlyphCount) {

             mValue = (mValue & (FLAGS_CAN_BREAK_BEFORE | FLAG_NOT_CLUSTER_START |

                                 FLAG_CHAR_IS_SPACE)) |

                 CharIdentityFlags() |

                 (aGlyphCount << GLYPH_COUNT_SHIFT);

             return *this;

         }

         uint32_t GetGlyphCount() const {

             NS_ASSERTION(!IsSimpleGlyph(), "Expected non-simple-glyph");

             return (mValue & GLYPH_COUNT_MASK) >> GLYPH_COUNT_SHIFT;

         }

         void SetIsSpace() {

             mValue |= FLAG_CHAR_IS_SPACE;

         }

         void SetIsTab() {

             NS_ASSERTION(!IsSimpleGlyph(), "Expected non-simple-glyph");

             mValue |= FLAG_CHAR_IS_TAB;

         }

         void SetIsNewline() {

             NS_ASSERTION(!IsSimpleGlyph(), "Expected non-simple-glyph");

             mValue |= FLAG_CHAR_IS_NEWLINE;

         }

         void SetIsLowSurrogate() {

             NS_ASSERTION(!IsSimpleGlyph(), "Expected non-simple-glyph");

             mValue |= FLAG_CHAR_IS_LOW_SURROGATE;

         }

     private:

         uint32_t mValue;

     };

     // Accessor for the array of CompressedGlyph records, which will be in

     // a different place in gfxShapedWord vs gfxTextRun

     virtual CompressedGlyph *GetCharacterGlyphs() = 0;

     /**

      * When the glyphs for a character don't fit into a CompressedGlyph record

      * in SimpleGlyph format, we use an array of DetailedGlyphs instead.

      */

     struct DetailedGlyph {

         /** The glyphID, or the Unicode character

          * if this is a missing glyph */

         uint32_t mGlyphID;

         /** The advance, x-offset and y-offset of the glyph, in appunits

          *  mAdvance is in the text direction (RTL or LTR)

          *  mXOffset is always from left to right

          *  mYOffset is always from top to bottom */   

         int32_t  mAdvance;

         float    mXOffset, mYOffset;

     };

     void SetGlyphs(uint32_t aCharIndex, CompressedGlyph aGlyph,

                    const DetailedGlyph *aGlyphs);

     void SetMissingGlyph(uint32_t aIndex, uint32_t aChar, gfxFont *aFont);

     void SetIsSpace(uint32_t aIndex) {

         GetCharacterGlyphs()[aIndex].SetIsSpace();

     }

     void SetIsLowSurrogate(uint32_t aIndex) {

         SetGlyphs(aIndex, CompressedGlyph().SetComplex(false, false, 0), nullptr);

         GetCharacterGlyphs()[aIndex].SetIsLowSurrogate();

     }

     bool HasDetailedGlyphs() const {

         return mDetailedGlyphs != nullptr;

     }

     bool IsClusterStart(uint32_t aPos) {

         NS_ASSERTION(aPos < GetLength(), "aPos out of range");

         return GetCharacterGlyphs()[aPos].IsClusterStart();

     }

     bool IsLigatureGroupStart(uint32_t aPos) {

         NS_ASSERTION(aPos < GetLength(), "aPos out of range");

         return GetCharacterGlyphs()[aPos].IsLigatureGroupStart();

     }

     // NOTE that this must not be called for a character offset that does

     // not have any DetailedGlyph records; callers must have verified that

     // GetCharacterGlyphs()[aCharIndex].GetGlyphCount() is greater than zero.

     DetailedGlyph *GetDetailedGlyphs(uint32_t aCharIndex) {

         NS_ASSERTION(GetCharacterGlyphs() && HasDetailedGlyphs() &&

                      !GetCharacterGlyphs()[aCharIndex].IsSimpleGlyph() &&

                      GetCharacterGlyphs()[aCharIndex].GetGlyphCount() > 0,

                      "invalid use of GetDetailedGlyphs; check the caller!");

         return mDetailedGlyphs->Get(aCharIndex);

     }

     void AdjustAdvancesForSyntheticBold(float aSynBoldOffset,

                                         uint32_t aOffset, uint32_t aLength);

     // Mark clusters in the CompressedGlyph records, starting at aOffset,

     // based on the Unicode properties of the text in aString.

     // This is also responsible to set the IsSpace flag for space characters.

     void SetupClusterBoundaries(uint32_t         aOffset,

                                 const char16_t *aString,

                                 uint32_t         aLength);

     // In 8-bit text, there won't actually be any clusters, but we still need

     // the space-marking functionality.

     void SetupClusterBoundaries(uint32_t       aOffset,

                                 const uint8_t *aString,

                                 uint32_t       aLength);

     uint32_t Flags() const {

         return mFlags;

     }

     bool IsRightToLeft() const {

         return (Flags() & gfxTextRunFactory::TEXT_IS_RTL) != 0;

     }

     float GetDirection() const {

         return IsRightToLeft() ? -1.0f : 1.0f;

     }

     bool DisableLigatures() const {

         return (Flags() & gfxTextRunFactory::TEXT_DISABLE_OPTIONAL_LIGATURES) != 0;

     }

     bool TextIs8Bit() const {

         return (Flags() & gfxTextRunFactory::TEXT_IS_8BIT) != 0;

     }

     int32_t GetAppUnitsPerDevUnit() const {

         return mAppUnitsPerDevUnit;

     }

     uint32_t GetLength() const {

         return mLength;

     }

     bool FilterIfIgnorable(uint32_t aIndex, uint32_t aCh);

 protected:

     // Allocate aCount DetailedGlyphs for the given index

     DetailedGlyph *AllocateDetailedGlyphs(uint32_t aCharIndex,

                                           uint32_t aCount);

     // For characters whose glyph data does not fit the "simple" glyph criteria

     // in CompressedGlyph, we use a sorted array to store the association

     // between the source character offset and an index into an array 

     // DetailedGlyphs. The CompressedGlyph record includes a count of

     // the number of DetailedGlyph records that belong to the character,

     // starting at the given index.

     class DetailedGlyphStore {

     public:

         DetailedGlyphStore()

             : mLastUsed(0)

         { }

         // This is optimized for the most common calling patterns:

         // we rarely need random access to the records, access is most commonly

         // sequential through the textRun, so we record the last-used index

         // and check whether the caller wants the same record again, or the

         // next; if not, it's most likely we're starting over from the start

         // of the run, so we check the first entry before resorting to binary

         // search as a last resort.

         // NOTE that this must not be called for a character offset that does

         // not have any DetailedGlyph records; callers must have verified that

         // mCharacterGlyphs[aOffset].GetGlyphCount() is greater than zero

         // before calling this, otherwise the assertions here will fire (in a

         // debug build), and we'll probably crash.

         DetailedGlyph* Get(uint32_t aOffset) {

             NS_ASSERTION(mOffsetToIndex.Length() > 0,

                          "no detailed glyph records!");

             DetailedGlyph* details = mDetails.Elements();

             // check common cases (fwd iteration, initial entry, etc) first

             if (mLastUsed < mOffsetToIndex.Length() - 1 &&

                 aOffset == mOffsetToIndex[mLastUsed + 1].mOffset) {

                 ++mLastUsed;

             } else if (aOffset == mOffsetToIndex[0].mOffset) {

                 mLastUsed = 0;

             } else if (aOffset == mOffsetToIndex[mLastUsed].mOffset) {

                 // do nothing

             } else if (mLastUsed > 0 &&

                        aOffset == mOffsetToIndex[mLastUsed - 1].mOffset) {

                 --mLastUsed;

             } else {

                 mLastUsed =

                     mOffsetToIndex.BinaryIndexOf(aOffset, CompareToOffset());

             }

             NS_ASSERTION(mLastUsed != nsTArray<DGRec>::NoIndex,

                          "detailed glyph record missing!");

             return details + mOffsetToIndex[mLastUsed].mIndex;

         }

         DetailedGlyph* Allocate(uint32_t aOffset, uint32_t aCount) {

             uint32_t detailIndex = mDetails.Length();

             DetailedGlyph *details = mDetails.AppendElements(aCount);

             if (!details) {

                 return nullptr;

             }

             // We normally set up glyph records sequentially, so the common case

             // here is to append new records to the mOffsetToIndex array;

             // test for that before falling back to the InsertElementSorted

             // method.

             if (mOffsetToIndex.Length() == 0 ||

                 aOffset > mOffsetToIndex[mOffsetToIndex.Length() - 1].mOffset) {

                 if (!mOffsetToIndex.AppendElement(DGRec(aOffset, detailIndex))) {

                     return nullptr;

                 }

             } else {

                 if (!mOffsetToIndex.InsertElementSorted(DGRec(aOffset, detailIndex),

                                                         CompareRecordOffsets())) {

                     return nullptr;

                 }

             }

             return details;

         }

         size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) {

             return aMallocSizeOf(this) +

                 mDetails.SizeOfExcludingThis(aMallocSizeOf) +

                 mOffsetToIndex.SizeOfExcludingThis(aMallocSizeOf);

         }

     private:

         struct DGRec {

             DGRec(const uint32_t& aOffset, const uint32_t& aIndex)

                 : mOffset(aOffset), mIndex(aIndex) { }

             uint32_t mOffset; // source character offset in the textrun

             uint32_t mIndex;  // index where this char's DetailedGlyphs begin

         };

         struct CompareToOffset {

             bool Equals(const DGRec& a, const uint32_t& b) const {

                 return a.mOffset == b;

             }

             bool LessThan(const DGRec& a, const uint32_t& b) const {

                 return a.mOffset < b;

             }

         };

         struct CompareRecordOffsets {

             bool Equals(const DGRec& a, const DGRec& b) const {

                 return a.mOffset == b.mOffset;

             }

             bool LessThan(const DGRec& a, const DGRec& b) const {

                 return a.mOffset < b.mOffset;

             }

         };

         // Concatenated array of all the DetailedGlyph records needed for the

         // textRun; individual character offsets are associated with indexes

         // into this array via the mOffsetToIndex table.

         nsTArray<DetailedGlyph>     mDetails;

         // For each character offset that needs DetailedGlyphs, we record the

         // index in mDetails where the list of glyphs begins. This array is

         // sorted by mOffset.

         nsTArray<DGRec>             mOffsetToIndex;

         // Records the most recently used index into mOffsetToIndex, so that

         // we can support sequential access more quickly than just doing

         // a binary search each time.

         nsTArray<DGRec>::index_type mLastUsed;

     };

     nsAutoPtr<DetailedGlyphStore>   mDetailedGlyphs;

     // Number of char16_t characters and CompressedGlyph glyph records

     uint32_t                        mLength;

     // Shaping flags (direction, ligature-suppression)

     uint32_t                        mFlags;

     int32_t                         mAppUnitsPerDevUnit;

 };

 /*

  * gfxShapedWord: an individual (space-delimited) run of text shaped with a

  * particular font, without regard to external context.

  *

  * The glyph data is copied into gfxTextRuns as needed from the cache of

  * ShapedWords associated with each gfxFont instance.

  */

 class gfxShapedWord : public gfxShapedText

 {

 public:

     // Create a ShapedWord that can hold glyphs for aLength characters,

     // with mCharacterGlyphs sized appropriately.

     //

     // Returns null on allocation failure (does NOT use infallible alloc)

     // so caller must check for success.

     //

     // This does NOT perform shaping, so the returned word contains no

     // glyph data; the caller must call gfxFont::ShapeText() with appropriate

     // parameters to set up the glyphs.

     static gfxShapedWord* Create(const uint8_t *aText, uint32_t aLength,

                                  int32_t aRunScript,

                                  int32_t aAppUnitsPerDevUnit,

                                  uint32_t aFlags) {

         NS_ASSERTION(aLength <= gfxPlatform::GetPlatform()->WordCacheCharLimit(),

                      "excessive length for gfxShapedWord!");

         // Compute size needed including the mCharacterGlyphs array