Home | History | Annotate | Download | only in core
      1 /*
      2  * Copyright 2013 Google Inc.
      3  *
      4  * Use of this source code is governed by a BSD-style license that can be
      5  * found in the LICENSE file.
      6  */
      7 
      8 #ifndef SkFontMgr_DEFINED
      9 #define SkFontMgr_DEFINED
     10 
     11 #include "SkFontArguments.h"
     12 #include "SkFontStyle.h"
     13 #include "SkRefCnt.h"
     14 #include "SkTypes.h"
     15 
     16 class SkData;
     17 class SkFontData;
     18 class SkStreamAsset;
     19 class SkString;
     20 class SkTypeface;
     21 
     22 class SK_API SkFontStyleSet : public SkRefCnt {
     23 public:
     24     virtual int count() = 0;
     25     virtual void getStyle(int index, SkFontStyle*, SkString* style) = 0;
     26     virtual SkTypeface* createTypeface(int index) = 0;
     27     virtual SkTypeface* matchStyle(const SkFontStyle& pattern) = 0;
     28 
     29     static SkFontStyleSet* CreateEmpty();
     30 
     31 protected:
     32     SkTypeface* matchStyleCSS3(const SkFontStyle& pattern);
     33 
     34 private:
     35     typedef SkRefCnt INHERITED;
     36 };
     37 
     38 class SK_API SkFontMgr : public SkRefCnt {
     39 public:
     40     int countFamilies() const;
     41     void getFamilyName(int index, SkString* familyName) const;
     42     SkFontStyleSet* createStyleSet(int index) const;
     43 
     44     /**
     45      *  The caller must call unref() on the returned object.
     46      *  Never returns NULL; will return an empty set if the name is not found.
     47      *
     48      *  Passing nullptr as the parameter will return the default system family.
     49      *  Note that most systems don't have a default system family, so passing nullptr will often
     50      *  result in the empty set.
     51      *
     52      *  It is possible that this will return a style set not accessible from
     53      *  createStyleSet(int) due to hidden or auto-activated fonts.
     54      */
     55     SkFontStyleSet* matchFamily(const char familyName[]) const;
     56 
     57     /**
     58      *  Find the closest matching typeface to the specified familyName and style
     59      *  and return a ref to it. The caller must call unref() on the returned
     60      *  object. Will return nullptr if no 'good' match is found.
     61      *
     62      *  Passing |nullptr| as the parameter for |familyName| will return the
     63      *  default system font.
     64      *
     65      *  It is possible that this will return a style set not accessible from
     66      *  createStyleSet(int) or matchFamily(const char[]) due to hidden or
     67      *  auto-activated fonts.
     68      */
     69     SkTypeface* matchFamilyStyle(const char familyName[], const SkFontStyle&) const;
     70 
     71     /**
     72      *  Use the system fallback to find a typeface for the given character.
     73      *  Note that bcp47 is a combination of ISO 639, 15924, and 3166-1 codes,
     74      *  so it is fine to just pass a ISO 639 here.
     75      *
     76      *  Will return NULL if no family can be found for the character
     77      *  in the system fallback.
     78      *
     79      *  Passing |nullptr| as the parameter for |familyName| will return the
     80      *  default system font.
     81      *
     82      *  bcp47[0] is the least significant fallback, bcp47[bcp47Count-1] is the
     83      *  most significant. If no specified bcp47 codes match, any font with the
     84      *  requested character will be matched.
     85      */
     86     SkTypeface* matchFamilyStyleCharacter(const char familyName[], const SkFontStyle&,
     87                                           const char* bcp47[], int bcp47Count,
     88                                           SkUnichar character) const;
     89 
     90     SkTypeface* matchFaceStyle(const SkTypeface*, const SkFontStyle&) const;
     91 
     92     /**
     93      *  Create a typeface for the specified data and TTC index (pass 0 for none)
     94      *  or NULL if the data is not recognized. The caller must call unref() on
     95      *  the returned object if it is not null.
     96      */
     97     sk_sp<SkTypeface> makeFromData(sk_sp<SkData>, int ttcIndex = 0) const;
     98 
     99     /**
    100      *  Create a typeface for the specified stream and TTC index
    101      *  (pass 0 for none) or NULL if the stream is not recognized. The caller
    102      *  must call unref() on the returned object if it is not null.
    103      */
    104     sk_sp<SkTypeface> makeFromStream(std::unique_ptr<SkStreamAsset>, int ttcIndex = 0) const;
    105 
    106     /* Experimental, API subject to change. */
    107     sk_sp<SkTypeface> makeFromStream(std::unique_ptr<SkStreamAsset>, const SkFontArguments&) const;
    108 
    109     /**
    110      *  Create a typeface from the specified font data.
    111      *  Will return NULL if the typeface could not be created.
    112      *  The caller must call unref() on the returned object if it is not null.
    113      */
    114     sk_sp<SkTypeface> makeFromFontData(std::unique_ptr<SkFontData>) const;
    115 
    116     /**
    117      *  Create a typeface for the specified fileName and TTC index
    118      *  (pass 0 for none) or NULL if the file is not found, or its contents are
    119      *  not recognized. The caller must call unref() on the returned object
    120      *  if it is not null.
    121      */
    122     sk_sp<SkTypeface> makeFromFile(const char path[], int ttcIndex = 0) const;
    123 
    124     sk_sp<SkTypeface> legacyMakeTypeface(const char familyName[], SkFontStyle style) const;
    125 
    126     /** Return the default fontmgr. */
    127     static sk_sp<SkFontMgr> RefDefault();
    128 
    129 protected:
    130     virtual int onCountFamilies() const = 0;
    131     virtual void onGetFamilyName(int index, SkString* familyName) const = 0;
    132     virtual SkFontStyleSet* onCreateStyleSet(int index)const  = 0;
    133 
    134     /** May return NULL if the name is not found. */
    135     virtual SkFontStyleSet* onMatchFamily(const char familyName[]) const = 0;
    136 
    137     virtual SkTypeface* onMatchFamilyStyle(const char familyName[],
    138                                            const SkFontStyle&) const = 0;
    139     virtual SkTypeface* onMatchFamilyStyleCharacter(const char familyName[], const SkFontStyle&,
    140                                                     const char* bcp47[], int bcp47Count,
    141                                                     SkUnichar character) const = 0;
    142     virtual SkTypeface* onMatchFaceStyle(const SkTypeface*,
    143                                          const SkFontStyle&) const = 0;
    144 
    145     virtual sk_sp<SkTypeface> onMakeFromData(sk_sp<SkData>, int ttcIndex) const = 0;
    146     virtual sk_sp<SkTypeface> onMakeFromStreamIndex(std::unique_ptr<SkStreamAsset>,
    147                                                     int ttcIndex) const = 0;
    148     virtual sk_sp<SkTypeface> onMakeFromStreamArgs(std::unique_ptr<SkStreamAsset>,
    149                                                    const SkFontArguments&) const;
    150     virtual sk_sp<SkTypeface> onMakeFromFontData(std::unique_ptr<SkFontData>) const;
    151     virtual sk_sp<SkTypeface> onMakeFromFile(const char path[], int ttcIndex) const = 0;
    152 
    153     virtual sk_sp<SkTypeface> onLegacyMakeTypeface(const char familyName[], SkFontStyle) const = 0;
    154 
    155 private:
    156 
    157     /** Implemented by porting layer to return the default factory. */
    158     static sk_sp<SkFontMgr> Factory();
    159 
    160     typedef SkRefCnt INHERITED;
    161 };
    162 
    163 #endif
    164