txt Namespace Reference

Namespaces
namespace	testing

Classes
class	AssetFontManager
class	DynamicFontManager
class	FontAssetProvider
class	FontCollection
class	FontFeatures
class	FontVariations
class	LineMetrics
class	Paragraph
class	ParagraphBuilder
class	ParagraphBuilderSkia
	ParagraphBuilder implementation using Skia's text layout module. More...
class	ParagraphSkia
class	ParagraphStyle
class	PlaceholderRun
class	RunMetrics
class	SkiaParagraphBuilderTests
class	TestFontManager
class	TextShadow
class	TextStyle
class	TypefaceFontAssetProvider
class	TypefaceFontStyleSet

Typedefs
using	PaintID = skt::ParagraphPainter::PaintID

Enumerations
enum class	FontStyle {   normal ,   italic }
enum	FontWeight : int { normal = 400 }
enum class	TextAlign {   left ,   right ,   center ,   justify ,   start ,   end }
enum class	TextDirection {   rtl ,   ltr }
enum	TextHeightBehavior {   kAll = 0x0 ,   kDisableFirstAscent = 0x1 ,   kDisableLastDescent = 0x2 ,   kDisableAll = 0x1 | 0x2 }
enum class	PlaceholderAlignment {   kBaseline ,   kAboveBaseline ,   kBelowBaseline ,   kTop ,   kBottom ,   kMiddle }
	Where to vertically align the placeholder relative to the surrounding text. More...
enum	TextBaseline {   kAlphabetic ,   kIdeographic }
enum	TextDecoration {   kNone = 0x0 ,   kUnderline = 0x1 ,   kOverline = 0x2 ,   kLineThrough = 0x4 }
enum	TextDecorationStyle {   kSolid ,   kDouble ,   kDotted ,   kDashed ,   kWavy }

Functions
std::vector< std::string >	GetDefaultFontFamilies ()
sk_sp< SkFontMgr >	GetDefaultFontManager (uint32_t font_initialization_data)
void	RegisterSystemFonts (const DynamicFontManager &dynamic_font_manager)
fml::CFRef< CTFontRef >	MatchSystemUIFont (float desired_weight, float size)
	TEST_F (SkiaParagraphBuilderTests, ParagraphStrutStyle)
const std::string &	GetFontDir ()
void	SetFontDir (const std::string &dir)

Variables
const FourCharCode	kWeightTag = 'wght'
static std::string	gFontDir

Typedef Documentation

PaintID

using txt::PaintID = typedef skt::ParagraphPainter::PaintID

Definition at line 21 of file paragraph_skia.cc.

Enumeration Type Documentation

FontStyle

enum class txt::FontStyle

strong

Enumerator
normal
italic

Definition at line 10 of file font_style.h.

                     {
  // NOLINTBEGIN(readability-identifier-naming)
  normal,
  italic,
  // NOLINTEND(readability-identifier-naming)
};

FontWeight

enum txt::FontWeight : int

Enumerator
normal

Definition at line 10 of file font_weight.h.

                : int {
  // NOLINTBEGIN(readability-identifier-naming)
  normal = 400,  // Normal/Regular
  // NOLINTEND(readability-identifier-naming)
};

PlaceholderAlignment

enum class txt::PlaceholderAlignment

strong

Where to vertically align the placeholder relative to the surrounding text.

Enumerator
kBaseline	Match the baseline of the placeholder with the baseline.
kAboveBaseline	Align the bottom edge of the placeholder with the baseline such that the placeholder sits on top of the baseline.
kBelowBaseline	Align the top edge of the placeholder with the baseline specified in such that the placeholder hangs below the baseline.
kTop	Align the top edge of the placeholder with the top edge of the font. When the placeholder is very tall, the extra space will hang from the top and extend through the bottom of the line.
kBottom	Align the bottom edge of the placeholder with the top edge of the font. When the placeholder is very tall, the extra space will rise from the bottom and extend through the top of the line.
kMiddle	Align the middle of the placeholder with the middle of the text. When the placeholder is very tall, the extra space will grow equally from the top and bottom of the line.

Definition at line 13 of file placeholder_run.h.

                                {
  /// Match the baseline of the placeholder with the baseline.
  kBaseline,
 
  /// Align the bottom edge of the placeholder with the baseline such that the
  /// placeholder sits on top of the baseline.
  kAboveBaseline,
 
  /// Align the top edge of the placeholder with the baseline specified in
  /// such that the placeholder hangs below the baseline.
  kBelowBaseline,
 
  /// Align the top edge of the placeholder with the top edge of the font.
  /// When the placeholder is very tall, the extra space will hang from
  /// the top and extend through the bottom of the line.
  kTop,
 
  /// Align the bottom edge of the placeholder with the top edge of the font.
  /// When the placeholder is very tall, the extra space will rise from
  /// the bottom and extend through the top of the line.
  kBottom,
 
  /// Align the middle of the placeholder with the middle of the text. When the
  /// placeholder is very tall, the extra space will grow equally from
  /// the top and bottom of the line.
  kMiddle,
};

TextAlign

enum class txt::TextAlign

strong

Enumerator
left
right
center
justify
start
end

Definition at line 17 of file paragraph_style.h.

                     {
  // NOLINTBEGIN(readability-identifier-naming)
  left,
  right,
  center,
  justify,
  start,
  end,
  // NOLINTEND(readability-identifier-naming)
};

TextBaseline

enum txt::TextBaseline

Enumerator
kAlphabetic
kIdeographic

Definition at line 10 of file text_baseline.h.

                  {
  kAlphabetic,
  kIdeographic,
};

TextDecoration

enum txt::TextDecoration

Enumerator
kNone
kUnderline
kOverline
kLineThrough

Definition at line 12 of file text_decoration.h.

                    {
  kNone = 0x0,
  kUnderline = 0x1,
  kOverline = 0x2,
  kLineThrough = 0x4,
};

TextDecorationStyle

enum txt::TextDecorationStyle

Enumerator
kSolid
kDouble
kDotted
kDashed
kWavy

Definition at line 19 of file text_decoration.h.

{ kSolid, kDouble, kDotted, kDashed, kWavy };

TextDirection

enum class txt::TextDirection

strong

Enumerator
rtl
ltr

Definition at line 28 of file paragraph_style.h.

                         {
  // NOLINTBEGIN(readability-identifier-naming)
  rtl,
  ltr,
  // NOLINTEND(readability-identifier-naming)
};

TextHeightBehavior

enum txt::TextHeightBehavior

Enumerator
kAll
kDisableFirstAscent
kDisableLastDescent
kDisableAll

Definition at line 49 of file paragraph_style.h.

                        {
  kAll = 0x0,
  kDisableFirstAscent = 0x1,
  kDisableLastDescent = 0x2,
  kDisableAll = 0x1 | 0x2,
};

Function Documentation

GetDefaultFontFamilies()

std::vector< std::string > txt::GetDefaultFontFamilies

(

)

Definition at line 13 of file platform.cc.

                                              {
  return {"Arial"};
}

Referenced by txt::FontCollection::CreateSktFontCollection().

GetDefaultFontManager()

sk_sp< SkFontMgr > txt::GetDefaultFontManager

(

uint32_t

font_initialization_data = 0

)

Definition at line 17 of file platform.cc.

                                                                          {
#if defined(SK_FONTMGR_FREETYPE_EMPTY_AVAILABLE)
  static sk_sp<SkFontMgr> mgr = SkFontMgr_New_Custom_Empty();
#else
  static sk_sp<SkFontMgr> mgr = SkFontMgr::RefEmpty();
#endif
  return mgr;
}

Referenced by flutter::testing::CreateTestFontOfSize(), impeller::DlPlayground::CreateTestFontOfSize(), flutter::AssetManagerFontStyleSet::createTypeface(), impeller::interop::CreateTypefaceFromFontData(), flutter::GetTestFontData(), flutter::FontCollection::LoadFontFromList(), flutter::PerformanceOverlayLayer::MakeStatisticsFont(), flutter::PrefetchDefaultFontManager(), flutter::testing::RenderTextInCanvasSkia(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

GetFontDir()

const std::string & txt::GetFontDir

(

)

Definition at line 11 of file txt_test_utils.cc.

                              {
  return gFontDir;
}

References gFontDir.

Referenced by BENCHMARK_DEFINE_F(), main(), and SkParagraphFixture::SetUp().

MatchSystemUIFont()

fml::CFRef< CTFontRef > txt::MatchSystemUIFont	(	float	desired_weight,
		float	size
	)

Definition at line 46 of file platform_mac.mm.

                                                                        {
  fml::CFRef<CTFontRef> ct_font(
      CTFontCreateUIFontForLanguage(kCTFontUIFontSystem, size, nullptr));
 
  if (desired_weight == kNormalWeightValue) {
    return ct_font;
  }
 
  fml::CFRef<CFMutableDictionaryRef> variations(CFDictionaryCreateMutable(
      kCFAllocatorDefault, 1, &kCFTypeDictionaryKeyCallBacks,
      &kCFTypeDictionaryValueCallBacks));
 
  auto add_axis_to_variations = [&variations](const FourCharCode tag,
                                              float desired_value,
                                              float normal_value) {
    if (desired_value != normal_value) {
      fml::CFRef<CFNumberRef> tag_number(
          CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &tag));
      fml::CFRef<CFNumberRef> value_number(CFNumberCreate(
          kCFAllocatorDefault, kCFNumberFloatType, &desired_value));
      CFDictionarySetValue(variations, tag_number, value_number);
    }
  };
  add_axis_to_variations(kWeightTag, desired_weight, kNormalWeightValue);
 
  fml::CFRef<CFMutableDictionaryRef> attributes(CFDictionaryCreateMutable(
      kCFAllocatorDefault, 1, &kCFTypeDictionaryKeyCallBacks,
      &kCFTypeDictionaryValueCallBacks));
  CFDictionarySetValue(attributes, kCTFontVariationAttribute, variations);
 
  fml::CFRef<CTFontDescriptorRef> var_font_desc(
      CTFontDescriptorCreateWithAttributes(attributes));
 
  return fml::CFRef<CTFontRef>(
      CTFontCreateCopyWithAttributes(ct_font, size, nullptr, var_font_desc));
}

References kNormalWeightValue, kWeightTag, and flutter::size.

Referenced by RegisterSystemFonts().

RegisterSystemFonts()

void txt::RegisterSystemFonts

(

const DynamicFontManager &

dynamic_font_manager

)

Definition at line 83 of file platform_mac.mm.

                                                                         {
  // iOS loads different system fonts when size is greater than 28 or lower
  // than 17. The "familyName" property returned from CoreText stays the same
  // despite the typeface is different.
  //
  // Below code manually loads and registers the larger font. The existing
  // fallback correctly loads the smaller font. The code also iterates through
  // the possible font weights from 100 - 900 to correctly load all of them, as
  // a CTFont object for the large system font does not include all of the font
  // weights by default.
  //
  // Darwin system fonts from 17 to 28 also have dynamic spacing based on sizes.
  // These two fonts do not match the spacings when sizes are from 17 to 28.
  // The spacing should be handled by the app or the framework.
  //
  // See https://www.wwdcnotes.com/notes/wwdc20/10175/ for Apple's document on
  // this topic.
  auto register_weighted_font = [&dynamic_font_manager](const int weight) {
    sk_sp<SkTypeface> large_system_font_weighted = SkMakeTypefaceFromCTFont(
        MatchSystemUIFont(weight, kSFProDisplayBreakPoint));
    if (large_system_font_weighted) {
      dynamic_font_manager.font_provider().RegisterTypeface(
          large_system_font_weighted, kSFProDisplayName);
    }
  };
  for (int i = 0; i < 8; i++) {
    const int font_weight = i * 100;
    register_weighted_font(font_weight);
  }
  // The value 780 returns a font weight of 800.
  register_weighted_font(780);
  // The value of 810 returns a font weight of 900.
  register_weighted_font(810);
}

References txt::DynamicFontManager::font_provider(), i, kSFProDisplayBreakPoint, kSFProDisplayName, MatchSystemUIFont(), and txt::TypefaceFontAssetProvider::RegisterTypeface().

Referenced by txt::testing::TEST_F().

SetFontDir()

void txt::SetFontDir

(

const std::string &

dir

)

Definition at line 15 of file txt_test_utils.cc.

                                      {
  gFontDir = dir;
}

References gFontDir.

Referenced by main().

TEST_F()

txt::TEST_F	(	SkiaParagraphBuilderTests	,
		ParagraphStrutStyle
	)

Definition at line 21 of file paragraph_builder_skia_tests.cc.

                                                       {
  ParagraphStyle style = ParagraphStyle();
  auto collection = std::make_shared<FontCollection>();
  auto builder = ParagraphBuilderSkia(style, collection, false);
 
  auto strut_style = builder.TxtToSkia(style).getStrutStyle();
  ASSERT_FALSE(strut_style.getHalfLeading());
 
  style.strut_half_leading = true;
  strut_style = builder.TxtToSkia(style).getStrutStyle();
  ASSERT_TRUE(strut_style.getHalfLeading());
}

References txt::ParagraphStyle::strut_half_leading.

Variable Documentation

gFontDir

std::string txt::gFontDir

static

Definition at line 9 of file txt_test_utils.cc.

Referenced by GetFontDir(), and SetFontDir().

kWeightTag

const FourCharCode txt::kWeightTag = 'wght'

Definition at line 31 of file platform_mac.mm.

Referenced by MatchSystemUIFont().