reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 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 | |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 11 | #include "SkFontStyle.h" |
bungeman | f6c7107 | 2016-01-21 14:17:47 -0800 | [diff] [blame] | 12 | #include "SkRefCnt.h" |
| 13 | #include "SkScalar.h" |
| 14 | #include "SkTypes.h" |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 15 | |
| 16 | class SkData; |
bungeman | 41868fe | 2015-05-20 09:21:04 -0700 | [diff] [blame] | 17 | class SkFontData; |
bungeman | 5f213d9 | 2015-01-27 05:39:10 -0800 | [diff] [blame] | 18 | class SkStreamAsset; |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 19 | class SkString; |
reed@google.com | 0b98326 | 2013-04-11 18:27:26 +0000 | [diff] [blame] | 20 | class SkTypeface; |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 21 | |
reed@google.com | aae71ba | 2013-04-10 13:10:40 +0000 | [diff] [blame] | 22 | class SK_API SkFontStyleSet : public SkRefCnt { |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 23 | public: |
reed@google.com | 83787c5 | 2013-03-26 17:19:15 +0000 | [diff] [blame] | 24 | virtual int count() = 0; |
| 25 | virtual void getStyle(int index, SkFontStyle*, SkString* style) = 0; |
| 26 | virtual SkTypeface* createTypeface(int index) = 0; |
reed@google.com | 964988f | 2013-03-29 14:57:22 +0000 | [diff] [blame] | 27 | virtual SkTypeface* matchStyle(const SkFontStyle& pattern) = 0; |
| 28 | |
| 29 | static SkFontStyleSet* CreateEmpty(); |
commit-bot@chromium.org | ef284a8 | 2013-07-11 22:29:29 +0000 | [diff] [blame] | 30 | |
bungeman | 147ea2f | 2015-11-12 09:50:08 -0800 | [diff] [blame] | 31 | protected: |
| 32 | SkTypeface* matchStyleCSS3(const SkFontStyle& pattern); |
| 33 | |
commit-bot@chromium.org | ef284a8 | 2013-07-11 22:29:29 +0000 | [diff] [blame] | 34 | private: |
| 35 | typedef SkRefCnt INHERITED; |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 36 | }; |
| 37 | |
reed@google.com | aae71ba | 2013-04-10 13:10:40 +0000 | [diff] [blame] | 38 | class SK_API SkFontMgr : public SkRefCnt { |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 39 | public: |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 40 | int countFamilies() const; |
| 41 | void getFamilyName(int index, SkString* familyName) const; |
| 42 | SkFontStyleSet* createStyleSet(int index) const; |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 43 | |
bungeman@google.com | 9fc5c68 | 2013-11-12 15:25:29 +0000 | [diff] [blame] | 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. |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 47 | * |
erikchen | 2b1516f | 2015-12-03 12:12:13 -0800 | [diff] [blame] | 48 | * Passing |nullptr| as the parameter will return the default system font. |
| 49 | * |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 50 | * It is possible that this will return a style set not accessible from |
| 51 | * createStyleSet(int) due to hidden or auto-activated fonts. |
bungeman@google.com | 9fc5c68 | 2013-11-12 15:25:29 +0000 | [diff] [blame] | 52 | */ |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 53 | SkFontStyleSet* matchFamily(const char familyName[]) const; |
reed@google.com | 964988f | 2013-03-29 14:57:22 +0000 | [diff] [blame] | 54 | |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 55 | /** |
| 56 | * Find the closest matching typeface to the specified familyName and style |
| 57 | * and return a ref to it. The caller must call unref() on the returned |
| 58 | * object. Will never return NULL, as it will return the default font if |
| 59 | * no matching font is found. |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 60 | * |
erikchen | 2b1516f | 2015-12-03 12:12:13 -0800 | [diff] [blame] | 61 | * Passing |nullptr| as the parameter for |familyName| will return the |
| 62 | * default system font. |
| 63 | * |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 64 | * It is possible that this will return a style set not accessible from |
| 65 | * createStyleSet(int) or matchFamily(const char[]) due to hidden or |
| 66 | * auto-activated fonts. |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 67 | */ |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 68 | SkTypeface* matchFamilyStyle(const char familyName[], const SkFontStyle&) const; |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 69 | |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 70 | /** |
| 71 | * Use the system fallback to find a typeface for the given character. |
bungeman | c20386e | 2014-10-23 07:08:05 -0700 | [diff] [blame] | 72 | * Note that bcp47 is a combination of ISO 639, 15924, and 3166-1 codes, |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 73 | * so it is fine to just pass a ISO 639 here. |
| 74 | * |
| 75 | * Will return NULL if no family can be found for the character |
| 76 | * in the system fallback. |
bungeman | c20386e | 2014-10-23 07:08:05 -0700 | [diff] [blame] | 77 | * |
erikchen | 2b1516f | 2015-12-03 12:12:13 -0800 | [diff] [blame] | 78 | * Passing |nullptr| as the parameter for |familyName| will return the |
| 79 | * default system font. |
| 80 | * |
bungeman | c20386e | 2014-10-23 07:08:05 -0700 | [diff] [blame] | 81 | * bcp47[0] is the least significant fallback, bcp47[bcp47Count-1] is the |
| 82 | * most significant. If no specified bcp47 codes match, any font with the |
| 83 | * requested character will be matched. |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 84 | */ |
| 85 | SkTypeface* matchFamilyStyleCharacter(const char familyName[], const SkFontStyle&, |
bungeman | c20386e | 2014-10-23 07:08:05 -0700 | [diff] [blame] | 86 | const char* bcp47[], int bcp47Count, |
| 87 | SkUnichar character) const; |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 88 | |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 89 | SkTypeface* matchFaceStyle(const SkTypeface*, const SkFontStyle&) const; |
reed@google.com | 95625db | 2013-03-25 20:44:02 +0000 | [diff] [blame] | 90 | |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 91 | /** |
| 92 | * Create a typeface for the specified data and TTC index (pass 0 for none) |
| 93 | * or NULL if the data is not recognized. The caller must call unref() on |
| 94 | * the returned object if it is not null. |
| 95 | */ |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 96 | SkTypeface* createFromData(SkData*, int ttcIndex = 0) const; |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 97 | |
| 98 | /** |
| 99 | * Create a typeface for the specified stream and TTC index |
| 100 | * (pass 0 for none) or NULL if the stream is not recognized. The caller |
| 101 | * must call unref() on the returned object if it is not null. |
| 102 | */ |
bungeman | 5f213d9 | 2015-01-27 05:39:10 -0800 | [diff] [blame] | 103 | SkTypeface* createFromStream(SkStreamAsset*, int ttcIndex = 0) const; |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 104 | |
bungeman | f6c7107 | 2016-01-21 14:17:47 -0800 | [diff] [blame] | 105 | struct FontParameters { |
| 106 | struct Axis { |
| 107 | SkFourByteTag fTag; |
| 108 | SkScalar fStyleValue; |
| 109 | }; |
| 110 | |
| 111 | FontParameters() : fCollectionIndex(0), fAxisCount(0), fAxes(nullptr) {} |
| 112 | |
| 113 | /** Specify the index of the desired font. |
| 114 | * |
| 115 | * Font formats like ttc, dfont, cff, cid, pfr, t42, t1, and fon may actually be indexed |
| 116 | * collections of fonts. |
| 117 | */ |
| 118 | FontParameters& setCollectionIndex(int collectionIndex) { |
| 119 | fCollectionIndex = collectionIndex; |
| 120 | return *this; |
| 121 | } |
| 122 | |
| 123 | /** Specify the GX variation axis values. |
| 124 | * |
| 125 | * Any axes not specified will use the default value. Specified axes not present in the |
| 126 | * font will be ignored. |
| 127 | * |
| 128 | * @param axes not copied. This pointer must remain valid for life of FontParameters. |
| 129 | */ |
| 130 | FontParameters& setAxes(const Axis* axes, int axisCount) { |
| 131 | fAxisCount = axisCount; |
| 132 | fAxes = axes; |
| 133 | return *this; |
| 134 | } |
| 135 | |
| 136 | int getCollectionIndex() const { |
| 137 | return fCollectionIndex; |
| 138 | } |
| 139 | const Axis* getAxes(int* axisCount) const { |
| 140 | *axisCount = fAxisCount; |
| 141 | return fAxes; |
| 142 | } |
| 143 | private: |
| 144 | int fCollectionIndex; |
| 145 | int fAxisCount; |
| 146 | const Axis* fAxes; |
| 147 | }; |
| 148 | /* Experimental, API subject to change. */ |
| 149 | SkTypeface* createFromStream(SkStreamAsset*, const FontParameters&) const; |
| 150 | |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 151 | /** |
bungeman | 41868fe | 2015-05-20 09:21:04 -0700 | [diff] [blame] | 152 | * Create a typeface from the specified font data. |
bungeman | 41868fe | 2015-05-20 09:21:04 -0700 | [diff] [blame] | 153 | * Will return NULL if the typeface could not be created. |
| 154 | * The caller must call unref() on the returned object if it is not null. |
| 155 | */ |
bungeman | f93d711 | 2016-09-16 06:24:20 -0700 | [diff] [blame] | 156 | SkTypeface* createFromFontData(std::unique_ptr<SkFontData>) const; |
bungeman | 41868fe | 2015-05-20 09:21:04 -0700 | [diff] [blame] | 157 | |
| 158 | /** |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 159 | * Create a typeface for the specified fileName and TTC index |
| 160 | * (pass 0 for none) or NULL if the file is not found, or its contents are |
| 161 | * not recognized. The caller must call unref() on the returned object |
| 162 | * if it is not null. |
| 163 | */ |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 164 | SkTypeface* createFromFile(const char path[], int ttcIndex = 0) const; |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 165 | |
bungeman | 11a77c6 | 2016-04-12 13:45:06 -0700 | [diff] [blame] | 166 | SkTypeface* legacyCreateTypeface(const char familyName[], SkFontStyle style) const; |
reed@google.com | 30ddd61 | 2013-07-30 17:47:39 +0000 | [diff] [blame] | 167 | |
reed@google.com | 95625db | 2013-03-25 20:44:02 +0000 | [diff] [blame] | 168 | /** |
| 169 | * Return a ref to the default fontmgr. The caller must call unref() on |
| 170 | * the returned object. |
| 171 | */ |
| 172 | static SkFontMgr* RefDefault(); |
| 173 | |
| 174 | protected: |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 175 | virtual int onCountFamilies() const = 0; |
| 176 | virtual void onGetFamilyName(int index, SkString* familyName) const = 0; |
| 177 | virtual SkFontStyleSet* onCreateStyleSet(int index)const = 0; |
reed@google.com | 95625db | 2013-03-25 20:44:02 +0000 | [diff] [blame] | 178 | |
bungeman@google.com | 9fc5c68 | 2013-11-12 15:25:29 +0000 | [diff] [blame] | 179 | /** May return NULL if the name is not found. */ |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 180 | virtual SkFontStyleSet* onMatchFamily(const char familyName[]) const = 0; |
reed@google.com | 964988f | 2013-03-29 14:57:22 +0000 | [diff] [blame] | 181 | |
reed@google.com | 95625db | 2013-03-25 20:44:02 +0000 | [diff] [blame] | 182 | virtual SkTypeface* onMatchFamilyStyle(const char familyName[], |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 183 | const SkFontStyle&) const = 0; |
bungeman@google.com | 72cf4fc | 2014-03-21 22:48:32 +0000 | [diff] [blame] | 184 | virtual SkTypeface* onMatchFamilyStyleCharacter(const char familyName[], const SkFontStyle&, |
bungeman | c20386e | 2014-10-23 07:08:05 -0700 | [diff] [blame] | 185 | const char* bcp47[], int bcp47Count, |
djsollen | 33068c1 | 2014-11-14 10:52:53 -0800 | [diff] [blame] | 186 | SkUnichar character) const = 0; |
reed@google.com | 95625db | 2013-03-25 20:44:02 +0000 | [diff] [blame] | 187 | virtual SkTypeface* onMatchFaceStyle(const SkTypeface*, |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 188 | const SkFontStyle&) const = 0; |
reed@google.com | 95625db | 2013-03-25 20:44:02 +0000 | [diff] [blame] | 189 | |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 190 | virtual SkTypeface* onCreateFromData(SkData*, int ttcIndex) const = 0; |
bungeman | 5f213d9 | 2015-01-27 05:39:10 -0800 | [diff] [blame] | 191 | virtual SkTypeface* onCreateFromStream(SkStreamAsset*, int ttcIndex) const = 0; |
bungeman | 41868fe | 2015-05-20 09:21:04 -0700 | [diff] [blame] | 192 | // TODO: make pure virtual. |
bungeman | f6c7107 | 2016-01-21 14:17:47 -0800 | [diff] [blame] | 193 | virtual SkTypeface* onCreateFromStream(SkStreamAsset*, const FontParameters&) const; |
bungeman | f93d711 | 2016-09-16 06:24:20 -0700 | [diff] [blame] | 194 | virtual SkTypeface* onCreateFromFontData(std::unique_ptr<SkFontData>) const; |
commit-bot@chromium.org | 967dee3 | 2014-02-04 22:35:01 +0000 | [diff] [blame] | 195 | virtual SkTypeface* onCreateFromFile(const char path[], int ttcIndex) const = 0; |
bungeman@google.com | fb1663a | 2013-10-24 22:32:43 +0000 | [diff] [blame] | 196 | |
bungeman | 11a77c6 | 2016-04-12 13:45:06 -0700 | [diff] [blame] | 197 | virtual SkTypeface* onLegacyCreateTypeface(const char familyName[], SkFontStyle) const = 0; |
bungeman | 11a77c6 | 2016-04-12 13:45:06 -0700 | [diff] [blame] | 198 | |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 199 | private: |
reed@google.com | 95625db | 2013-03-25 20:44:02 +0000 | [diff] [blame] | 200 | static SkFontMgr* Factory(); // implemented by porting layer |
skia.committer@gmail.com | e60ed08 | 2013-03-26 07:01:04 +0000 | [diff] [blame] | 201 | |
reed@google.com | c452d82 | 2013-03-25 18:44:17 +0000 | [diff] [blame] | 202 | typedef SkRefCnt INHERITED; |
| 203 | }; |
| 204 | |
| 205 | #endif |