skia::textlayout Namespace Reference

Classes
struct	Block
class	CanvasParagraphPainter
class	Cluster
struct	Decoration
class	Decorations
class	DirText
class	FontArguments
class	FontCollection
struct	FontFeature
class	InternalLineMetrics
class	LangIterator
class	LineMetrics
class	OneLineShaper
class	Paragraph
class	ParagraphBuilder
class	ParagraphBuilderImpl
class	ParagraphCache
class	ParagraphCacheKey
class	ParagraphCacheValue
class	ParagraphImpl
class	ParagraphPainter
class	ParagraphPainterAutoRestore
struct	ParagraphStyle
struct	Placeholder
struct	PlaceholderStyle
struct	PositionWithAffinity
struct	ResolvedFontDescriptor
class	Run
struct	SkRange
struct	StrutStyle
struct	StyleBlock
class	StyleMetrics
class	TestFontCollection
struct	TextBox
class	TextLine
class	TextShadow
class	TextStyle
class	TextWrapper
class	TypefaceFontProvider
class	TypefaceFontStyleSet

Typedefs
typedef size_t	TextIndex
typedef SkRange< size_t >	TextRange
typedef size_t	BlockIndex
typedef SkRange< size_t >	BlockRange
typedef size_t	RunIndex
typedef size_t	ClusterIndex
typedef SkRange< size_t >	ClusterRange
typedef size_t	GraphemeIndex
typedef SkRange< GraphemeIndex >	GraphemeRange
typedef size_t	GlyphIndex
typedef SkRange< GlyphIndex >	GlyphRange

Enumerations
enum	Affinity { kUpstream , kDownstream }
enum class	RectHeightStyle {   kTight , kMax , kIncludeLineSpacingMiddle , kIncludeLineSpacingTop ,   kIncludeLineSpacingBottom , kStrut }
enum class	RectWidthStyle { kTight , kMax }
enum class	TextAlign {   kLeft , kRight , kCenter , kJustify ,   kStart , kEnd }
enum class	TextDirection { kRtl , kLtr }
enum class	TextBaseline { kAlphabetic , kIdeographic }
enum	TextHeightBehavior { kAll = 0x0 , kDisableFirstAscent = 0x1 , kDisableLastDescent = 0x2 , kDisableAll = 0x1 | 0x2 }
enum class	LineMetricStyle : uint8_t { Typographic , CSS }
enum	TextDecoration { kNoDecoration = 0x0 , kUnderline = 0x1 , kOverline = 0x2 , kLineThrough = 0x4 }
enum	TextDecorationStyle {   kSolid , kDouble , kDotted , kDashed ,   kWavy }
enum	TextDecorationMode { kGaps , kThrough }
enum	StyleType {   kNone , kAllAttributes , kFont , kForeground ,   kBackground , kShadow , kDecorations , kLetterSpacing ,   kWordSpacing }
enum class	PlaceholderAlignment {   kBaseline , kAboveBaseline , kBelowBaseline , kTop ,   kBottom , kMiddle }
	Where to vertically align the placeholder relative to the surrounding text. More...
enum	InternalState {   kUnknown = 0 , kIndexed = 1 , kShaped = 2 , kLineBroken = 5 ,   kFormatted = 6 , kDrawn = 7 }

Functions
template<typename C , typename UnaryFunction >
UnaryFunction	directional_for_each (C &c, bool forwards, UnaryFunction f)
static bool	nearlyZero (SkScalar x, SkScalar tolerance=SK_ScalarNearlyZero)
static bool	nearlyEqual (SkScalar x, SkScalar y, SkScalar tolerance=SK_ScalarNearlyZero)
bool	operator== (const FontArguments &a, const FontArguments &b)
bool	operator!= (const skia::textlayout::FontArguments &a, const skia::textlayout::FontArguments &b)
TextRange	operator* (const TextRange &a, const TextRange &b)
static bool	is_ascii_7bit_space (int c)
template<typename T >
bool	operator== (const SkSpan< T > &a, const SkSpan< T > &b)
template<typename T >
bool	operator<= (const SkSpan< T > &a, const SkSpan< T > &b)

Variables
const size_t	EMPTY_INDEX = std::numeric_limits<size_t>::max()
const SkRange< size_t >	EMPTY_RANGE = SkRange<size_t>(EMPTY_INDEX, EMPTY_INDEX)
constexpr TextDecoration	AllTextDecorations []
const SkRange< size_t >	EMPTY_TEXT = EMPTY_RANGE
const size_t	EMPTY_BLOCK = EMPTY_INDEX
const SkRange< size_t >	EMPTY_BLOCKS = EMPTY_RANGE
const size_t	EMPTY_RUN = EMPTY_INDEX
const size_t	EMPTY_CLUSTER = EMPTY_INDEX
const SkRange< size_t >	EMPTY_CLUSTERS = EMPTY_RANGE

Typedef Documentation

BlockIndex

typedef size_t skia::textlayout::BlockIndex

Definition at line 355 of file TextStyle.h.

BlockRange

typedef SkRange<size_t> skia::textlayout::BlockRange

Definition at line 356 of file TextStyle.h.

ClusterIndex

typedef size_t skia::textlayout::ClusterIndex

Definition at line 35 of file Run.h.

ClusterRange

typedef SkRange<size_t> skia::textlayout::ClusterRange

Definition at line 36 of file Run.h.

GlyphIndex

typedef size_t skia::textlayout::GlyphIndex

Definition at line 43 of file Run.h.

GlyphRange

typedef SkRange<GlyphIndex> skia::textlayout::GlyphRange

Definition at line 44 of file Run.h.

GraphemeIndex

typedef size_t skia::textlayout::GraphemeIndex

Definition at line 40 of file Run.h.

GraphemeRange

typedef SkRange<GraphemeIndex> skia::textlayout::GraphemeRange

Definition at line 41 of file Run.h.

RunIndex

typedef size_t skia::textlayout::RunIndex

Definition at line 32 of file Run.h.

TextIndex

typedef size_t skia::textlayout::TextIndex

Definition at line 336 of file TextStyle.h.

TextRange

typedef SkRange<size_t> skia::textlayout::TextRange

Definition at line 337 of file TextStyle.h.

Enumeration Type Documentation

Affinity

enum skia::textlayout::Affinity

Enumerator
kUpstream
kDownstream

Definition at line 16 of file DartTypes.h.

{ kUpstream, kDownstream };

InternalState

enum skia::textlayout::InternalState

Enumerator
kUnknown
kIndexed
kShaped
kLineBroken
kFormatted
kDrawn

Definition at line 71 of file ParagraphImpl.h.

                   {
  kUnknown = 0,
  kIndexed = 1,     // Text is indexed
  kShaped = 2,      // Text is shaped
  kLineBroken = 5,
  kFormatted = 6,
  kDrawn = 7
};

LineMetricStyle

enum class skia::textlayout::LineMetricStyle : uint8_t

strong

Enumerator
Typographic
CSS

Definition at line 143 of file DartTypes.h.

                           : uint8_t {
    // Use ascent, descent, etc from a fixed baseline.
    Typographic,
    // Use ascent, descent, etc like css with the leading split and with height adjustments
    CSS
};

PlaceholderAlignment

enum class skia::textlayout::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 87 of file TextStyle.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,
};

RectHeightStyle

enum class skia::textlayout::RectHeightStyle

strong

Enumerator
kTight
kMax
kIncludeLineSpacingMiddle
kIncludeLineSpacingTop
kIncludeLineSpacingBottom
kStrut

Definition at line 18 of file DartTypes.h.

                           {
    // Provide tight bounding boxes that fit heights per run.
    kTight,
 
    // The height of the boxes will be the maximum height of all runs in the
    // line. All rects in the same line will be the same height.
    kMax,
 
    // Extends the top and/or bottom edge of the bounds to fully cover any line
    // spacing. The top edge of each line should be the same as the bottom edge
    // of the line above. There should be no gaps in vertical coverage given any
    // ParagraphStyle line_height.
    //
    // The top and bottom of each rect will cover half of the
    // space above and half of the space below the line.
    kIncludeLineSpacingMiddle,
    // The line spacing will be added to the top of the rect.
    kIncludeLineSpacingTop,
    // The line spacing will be added to the bottom of the rect.
    kIncludeLineSpacingBottom,
    //
    kStrut
};

RectWidthStyle

enum class skia::textlayout::RectWidthStyle

strong

Enumerator
kTight
kMax

Definition at line 42 of file DartTypes.h.

                          {
    // Provide tight bounding boxes that fit widths to the runs of each line
    // independently.
    kTight,
 
    // Extends the width of the last rect of each line to match the position of
    // the widest rect over all the lines.
    kMax
};

StyleType

enum skia::textlayout::StyleType

Enumerator
kNone
kAllAttributes
kFont
kForeground
kBackground
kShadow
kDecorations
kLetterSpacing
kWordSpacing

Definition at line 58 of file TextStyle.h.

               {
    kNone,
    kAllAttributes,
    kFont,
    kForeground,
    kBackground,
    kShadow,
    kDecorations,
    kLetterSpacing,
    kWordSpacing
};

TextAlign

enum class skia::textlayout::TextAlign

strong

Enumerator
kLeft
kRight
kCenter
kJustify
kStart
kEnd

Definition at line 52 of file DartTypes.h.

                     {
    kLeft,
    kRight,
    kCenter,
    kJustify,
    kStart,
    kEnd,
};

TextBaseline

enum class skia::textlayout::TextBaseline

strong

Enumerator
kAlphabetic
kIdeographic

Definition at line 131 of file DartTypes.h.

                        {
    kAlphabetic,
    kIdeographic,
};

TextDecoration

enum skia::textlayout::TextDecoration

Enumerator
kNoDecoration
kUnderline
kOverline
kLineThrough

Definition at line 41 of file TextStyle.h.

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

TextDecorationMode

enum skia::textlayout::TextDecorationMode

Enumerator
kGaps
kThrough

Definition at line 56 of file TextStyle.h.

{ kGaps, kThrough };

TextDecorationStyle

enum skia::textlayout::TextDecorationStyle

Enumerator
kSolid
kDouble
kDotted
kDashed
kWavy

Definition at line 54 of file TextStyle.h.

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

TextDirection

enum class skia::textlayout::TextDirection

strong

Enumerator
kRtl
kLtr

Definition at line 61 of file DartTypes.h.

                         {
    kRtl,
    kLtr,
};

TextHeightBehavior

enum skia::textlayout::TextHeightBehavior

Enumerator
kAll
kDisableFirstAscent
kDisableLastDescent
kDisableAll

Definition at line 136 of file DartTypes.h.

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

Function Documentation

directional_for_each()

template<typename C , typename UnaryFunction >

UnaryFunction skia::textlayout::directional_for_each	(	C &	c,
		bool	forwards,
		UnaryFunction	f
	)

Definition at line 85 of file DartTypes.h.

                                                                         {
    return forwards
              ? std::for_each(std::begin(c), std::end(c), f)
              : std::for_each(std::rbegin(c), std::rend(c), f);
}

is_ascii_7bit_space()

static bool skia::textlayout::is_ascii_7bit_space ( int  c )

static

Definition at line 317 of file ParagraphImpl.cpp.

                                       {
    SkASSERT(c >= 0 && c <= 127);
 
    // Extracted from https://en.wikipedia.org/wiki/Whitespace_character
    //
    enum WS {
        kHT    = 9,
        kLF    = 10,
        kVT    = 11,
        kFF    = 12,
        kCR    = 13,
        kSP    = 32,    // too big to use as shift
    };
#define M(shift)    (1 << (shift))
    constexpr uint32_t kSpaceMask = M(kHT) | M(kLF) | M(kVT) | M(kFF) | M(kCR);
    // we check for Space (32) explicitly, since it is too large to shift
    return (c == kSP) || (c <= 31 && (kSpaceMask & M(c)));
#undef M
}

nearlyEqual()

static bool skia::textlayout::nearlyEqual ( SkScalar  x, SkScalar  y, SkScalar  tolerance = SK_ScalarNearlyZero  )

inlinestatic

Definition at line 31 of file TextStyle.h.

                                                                                                 {
    if (SkIsFinite(x, y)) {
        return SkScalarNearlyEqual(x, y, tolerance);
    }
    // Inf == Inf, anything else is false
    return x == y;
}

nearlyZero()

static bool skia::textlayout::nearlyZero ( SkScalar  x, SkScalar  tolerance = SK_ScalarNearlyZero  )

inlinestatic

Definition at line 24 of file TextStyle.h.

                                                                                    {
    if (SkIsFinite(x)) {
        return SkScalarNearlyZero(x, tolerance);
    }
    return false;
}

operator!=()

bool skia::textlayout::operator!=	(	const skia::textlayout::FontArguments &	a,
		const skia::textlayout::FontArguments &	b
	)

Definition at line 54 of file FontArguments.cpp.

                                                                                            {
    return !(a == b);
}

operator*()

TextRange skia::textlayout::operator*	(	const TextRange &	a,
		const TextRange &	b
	)

Definition at line 51 of file ParagraphImpl.cpp.

                                                            {
    if (a.start == b.start && a.end == b.end) return a;
    auto begin = std::max(a.start, b.start);
    auto end = std::min(a.end, b.end);
    return end > begin ? TextRange(begin, end) : EMPTY_TEXT;
}

operator<=()

template<typename T >

bool skia::textlayout::operator<=	(	const SkSpan< T > &	a,
		const SkSpan< T > &	b
	)

Definition at line 47 of file ParagraphImpl.h.

                                                                              {
    return a.begin() >= b.begin() && a.end() <= b.end();
}

operator==() [1/2]

bool skia::textlayout::operator==	(	const FontArguments &	a,
		const FontArguments &	b
	)

Definition at line 47 of file FontArguments.cpp.

                                                                {
    return a.fCollectionIndex == b.fCollectionIndex &&
           a.fCoordinates == b.fCoordinates &&
           a.fPaletteIndex == b.fPaletteIndex &&
           a.fPaletteOverrides == b.fPaletteOverrides;
}

operator==() [2/2]

template<typename T >

bool skia::textlayout::operator==	(	const SkSpan< T > &	a,
		const SkSpan< T > &	b
	)

Definition at line 43 of file ParagraphImpl.h.

                                                                              {
    return a.size() == b.size() && a.begin() == b.begin();
}

Variable Documentation

AllTextDecorations

constexpr TextDecoration skia::textlayout::AllTextDecorations[]

constexpr

Initial value:

= {
        kNoDecoration,
        kUnderline,
        kOverline,
        kLineThrough,
}

Definition at line 47 of file TextStyle.h.

                                                {
        kNoDecoration,
        kUnderline,
        kOverline,
        kLineThrough,
};

EMPTY_BLOCK

const size_t skia::textlayout::EMPTY_BLOCK = EMPTY_INDEX

Definition at line 357 of file TextStyle.h.

EMPTY_BLOCKS

const SkRange<size_t> skia::textlayout::EMPTY_BLOCKS = EMPTY_RANGE

Definition at line 358 of file TextStyle.h.

EMPTY_CLUSTER

const size_t skia::textlayout::EMPTY_CLUSTER = EMPTY_INDEX

Definition at line 37 of file Run.h.

EMPTY_CLUSTERS

const SkRange<size_t> skia::textlayout::EMPTY_CLUSTERS = EMPTY_RANGE

Definition at line 38 of file Run.h.

EMPTY_INDEX

const size_t skia::textlayout::EMPTY_INDEX = std::numeric_limits<size_t>::max()

Definition at line 91 of file DartTypes.h.

EMPTY_RANGE

const SkRange<size_t> skia::textlayout::EMPTY_RANGE = SkRange<size_t>(EMPTY_INDEX, EMPTY_INDEX)

Definition at line 128 of file DartTypes.h.

EMPTY_RUN

const size_t skia::textlayout::EMPTY_RUN = EMPTY_INDEX

Definition at line 33 of file Run.h.

EMPTY_TEXT

const SkRange<size_t> skia::textlayout::EMPTY_TEXT = EMPTY_RANGE

Definition at line 338 of file TextStyle.h.