FontFamily.h revision 13f1aae02bacd475722bc8ea3fc2cf6abc1a82e3
19cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien/* 29cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * Copyright (C) 2013 The Android Open Source Project 39cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * 49cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * Licensed under the Apache License, Version 2.0 (the "License"); 59cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * you may not use this file except in compliance with the License. 69cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * You may obtain a copy of the License at 79cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * 89cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * http://www.apache.org/licenses/LICENSE-2.0 99cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * 109cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * Unless required by applicable law or agreed to in writing, software 119cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * distributed under the License is distributed on an "AS IS" BASIS, 129cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * See the License for the specific language governing permissions and 149cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien * limitations under the License. 159cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien */ 169cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 179cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#ifndef MINIKIN_FONT_FAMILY_H 189cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#define MINIKIN_FONT_FAMILY_H 199cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 209cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#include <vector> 21a5bb91190edbea0be0e78a8511b3c920b6e99c4eBehdad Esfahbod#include <string> 229cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 234d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien#include <utils/TypeHelpers.h> 244d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 25b80c1f19c58b927820a8a24bf2218e5645724608Raph Levien#include <minikin/MinikinRefCounted.h> 2613f1aae02bacd475722bc8ea3fc2cf6abc1a82e3Raph Levien#include <minikin/SparseBitSet.h> 27b80c1f19c58b927820a8a24bf2218e5645724608Raph Levien 289cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Leviennamespace android { 299cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 307b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levienclass MinikinFont; 317b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 327b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien// FontLanguage is a compact representation of a bcp-47 language tag. It 337b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien// does not capture all possible information, only what directly affects 347b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien// font rendering. 357b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levienclass FontLanguage { 367b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien friend class FontStyle; 377b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levienpublic: 387b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien FontLanguage() : mBits(0) { } 397b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 407b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien // Parse from string 417b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien FontLanguage(const char* buf, size_t size); 427b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 437b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien bool operator==(const FontLanguage other) const { return mBits == other.mBits; } 44a5bb91190edbea0be0e78a8511b3c920b6e99c4eBehdad Esfahbod operator bool() const { return mBits != 0; } 45a5bb91190edbea0be0e78a8511b3c920b6e99c4eBehdad Esfahbod 46a5bb91190edbea0be0e78a8511b3c920b6e99c4eBehdad Esfahbod std::string getString() const; 477b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 487b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien // 0 = no match, 1 = language matches, 2 = language and script match 497b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien int match(const FontLanguage other) const; 507b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 517b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levienprivate: 527b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien explicit FontLanguage(uint32_t bits) : mBits(bits) { } 537b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 547b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien uint32_t bits() const { return mBits; } 557b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 567b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const uint32_t kBaseLangMask = 0xffff; 577b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const uint32_t kScriptMask = (1 << 18) - (1 << 16); 587b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const uint32_t kHansFlag = 1 << 16; 597b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const uint32_t kHantFlag = 1 << 17; 607b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien uint32_t mBits; 617b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien}; 627b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 639cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// FontStyle represents all style information needed to select an actual font 649cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// from a collection. The implementation is packed into a single 32-bit word 659cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien// so it can be efficiently copied, embedded in other objects, etc. 669cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienclass FontStyle { 679cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienpublic: 689cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien FontStyle(int weight = 4, bool italic = false) { 699cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien bits = (weight & kWeightMask) | (italic ? kItalicMask : 0); 709cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien } 717b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien FontStyle(FontLanguage lang, int variant = 0, int weight = 4, bool italic = false) { 727b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien bits = (weight & kWeightMask) | (italic ? kItalicMask : 0) 737b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien | (variant << kVariantShift) | (lang.bits() << kLangShift); 747b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien } 754d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien int getWeight() const { return bits & kWeightMask; } 764d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien bool getItalic() const { return (bits & kItalicMask) != 0; } 777b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien int getVariant() const { return (bits >> kVariantShift) & kVariantMask; } 787b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien FontLanguage getLanguage() const { return FontLanguage(bits >> kLangShift); } 797b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 804d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien bool operator==(const FontStyle other) const { return bits == other.bits; } 814d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 824d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien hash_t hash() const { return bits; } 839cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienprivate: 847b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const uint32_t kWeightMask = (1 << 4) - 1; 857b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const uint32_t kItalicMask = 1 << 4; 867b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const int kVariantShift = 5; 877b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const uint32_t kVariantMask = (1 << 2) - 1; 887b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien static const int kLangShift = 7; 899cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien uint32_t bits; 909cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien}; 919cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 927b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levienenum FontVariant { 937b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien VARIANT_DEFAULT = 0, 947b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien VARIANT_COMPACT = 1, 957b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien VARIANT_ELEGANT = 2, 967b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien}; 977b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 984d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levieninline hash_t hash_type(const FontStyle &style) { 994d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien return style.hash(); 1004d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien} 1014d4e6bc8118d15542f1f2a9218f0f7a91a29474fRaph Levien 1029a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien// attributes representing transforms (fake bold, fake italic) to match styles 1039a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levienclass FontFakery { 1049a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levienpublic: 1059a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien FontFakery() : mFakeBold(false), mFakeItalic(false) { } 1069a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien FontFakery(bool fakeBold, bool fakeItalic) : mFakeBold(fakeBold), mFakeItalic(fakeItalic) { } 1079a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien // TODO: want to support graded fake bolding 1089a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien bool isFakeBold() { return mFakeBold; } 1099a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien bool isFakeItalic() { return mFakeItalic; } 1109a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levienprivate: 1119a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien bool mFakeBold; 1129a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien bool mFakeItalic; 1139a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien}; 1149a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien 1159a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levienstruct FakedFont { 1169a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien // ownership is the enclosing FontCollection 1179a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien MinikinFont* font; 1189a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien FontFakery fakery; 1199a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien}; 1209a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien 121b80c1f19c58b927820a8a24bf2218e5645724608Raph Levienclass FontFamily : public MinikinRefCounted { 1229cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienpublic: 1237b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien FontFamily() { } 1247b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 1257b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien FontFamily(FontLanguage lang, int variant) : mLang(lang), mVariant(variant) { 1267b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien } 1277b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 128b80c1f19c58b927820a8a24bf2218e5645724608Raph Levien ~FontFamily(); 129b80c1f19c58b927820a8a24bf2218e5645724608Raph Levien 1309cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // Add font to family, extracting style information from the font 131bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien bool addFont(MinikinFont* typeface); 1329cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 133bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien void addFont(MinikinFont* typeface, FontStyle style); 1349a5f713add8cfb91ac2c9ed5c917309053201ab6Raph Levien FakedFont getClosestMatch(FontStyle style) const; 1359cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 1367b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien FontLanguage lang() const { return mLang; } 1377b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien int variant() const { return mVariant; } 1387b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien 1399cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien // API's for enumerating the fonts in a family. These don't guarantee any particular order 1409cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien size_t getNumFonts() const; 141bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien MinikinFont* getFont(size_t index) const; 1429cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien FontStyle getStyle(size_t index) const; 14313f1aae02bacd475722bc8ea3fc2cf6abc1a82e3Raph Levien 14413f1aae02bacd475722bc8ea3fc2cf6abc1a82e3Raph Levien // Get Unicode coverage. Lifetime of returned bitset is same as receiver. 14513f1aae02bacd475722bc8ea3fc2cf6abc1a82e3Raph Levien const SparseBitSet* getCoverage(); 1469cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levienprivate: 147c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien void addFontLocked(MinikinFont* typeface, FontStyle style); 148c31e3883456e018d742e9f29815ba5ff8b315ea1Raph Levien 1499cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien class Font { 1509cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien public: 151bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien Font(MinikinFont* typeface, FontStyle style) : 1529cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien typeface(typeface), style(style) { } 153bcc3dc5a2591a95a57e379e27cbad69c18e91e67Raph Levien MinikinFont* typeface; 1549cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien FontStyle style; 1559cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien }; 1567b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien FontLanguage mLang; 1577b221d97b7b64dc5ce457e19666d55d042e22e62Raph Levien int mVariant; 1589cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien std::vector<Font> mFonts; 15913f1aae02bacd475722bc8ea3fc2cf6abc1a82e3Raph Levien 16013f1aae02bacd475722bc8ea3fc2cf6abc1a82e3Raph Levien SparseBitSet mCoverage; 16113f1aae02bacd475722bc8ea3fc2cf6abc1a82e3Raph Levien bool mCoverageValid; 1629cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien}; 1639cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 1649cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien} // namespace android 1659cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien 1669cc9bbe1461f359f0b27c5e7645c17dda001ab1dRaph Levien#endif // MINIKIN_FONT_FAMILY_H 167