skia::textlayout::Paragraph Class Reference

#include <Paragraph.h>

Inheritance diagram for skia::textlayout::Paragraph:

Classes
struct	ExtendedVisitorInfo
struct	FontInfo
struct	GlyphClusterInfo
struct	GlyphInfo
struct	VisitorInfo

Public Types
enum	VisitorFlags { kWhiteSpace_VisitorFlag = 1 << 0 }
using	Visitor = std::function< void(int lineNumber, const VisitorInfo *)>
using	ExtendedVisitor = std::function< void(int lineNumber, const ExtendedVisitorInfo *)>

Public Member Functions
	Paragraph (ParagraphStyle style, sk_sp< FontCollection > fonts)
virtual	~Paragraph ()=default
SkScalar	getMaxWidth ()
SkScalar	getHeight ()
SkScalar	getMinIntrinsicWidth ()
SkScalar	getMaxIntrinsicWidth ()
SkScalar	getAlphabeticBaseline ()
SkScalar	getIdeographicBaseline ()
SkScalar	getLongestLine ()
bool	didExceedMaxLines ()
virtual void	layout (SkScalar width)=0
virtual void	paint (SkCanvas *canvas, SkScalar x, SkScalar y)=0
virtual void	paint (ParagraphPainter *painter, SkScalar x, SkScalar y)=0
virtual std::vector< TextBox >	getRectsForRange (unsigned start, unsigned end, RectHeightStyle rectHeightStyle, RectWidthStyle rectWidthStyle)=0
virtual std::vector< TextBox >	getRectsForPlaceholders ()=0
virtual PositionWithAffinity	getGlyphPositionAtCoordinate (SkScalar dx, SkScalar dy)=0
virtual SkRange< size_t >	getWordBoundary (unsigned offset)=0
virtual void	getLineMetrics (std::vector< LineMetrics > &)=0
virtual size_t	lineNumber ()=0
virtual void	markDirty ()=0
virtual int32_t	unresolvedGlyphs ()=0
virtual std::unordered_set< SkUnichar >	unresolvedCodepoints ()=0
virtual void	updateTextAlign (TextAlign textAlign)=0
virtual void	updateFontSize (size_t from, size_t to, SkScalar fontSize)=0
virtual void	updateForegroundPaint (size_t from, size_t to, SkPaint paint)=0
virtual void	updateBackgroundPaint (size_t from, size_t to, SkPaint paint)=0
virtual void	visit (const Visitor &)=0
virtual void	extendedVisit (const ExtendedVisitor &)=0
virtual int	getPath (int lineNumber, SkPath *dest)=0
virtual bool	containsEmoji (SkTextBlob *textBlob)=0
virtual bool	containsColorFontOrBitmap (SkTextBlob *textBlob)=0
virtual int	getLineNumberAt (TextIndex codeUnitIndex) const =0
virtual int	getLineNumberAtUTF16Offset (size_t codeUnitIndex)=0
virtual bool	getLineMetricsAt (int lineNumber, LineMetrics *lineMetrics) const =0
virtual TextRange	getActualTextRange (int lineNumber, bool includeSpaces) const =0
virtual bool	getGlyphClusterAt (TextIndex codeUnitIndex, GlyphClusterInfo *glyphInfo)=0
virtual bool	getClosestGlyphClusterAt (SkScalar dx, SkScalar dy, GlyphClusterInfo *glyphInfo)=0
virtual bool	getGlyphInfoAtUTF16Offset (size_t codeUnitIndex, GlyphInfo *glyphInfo)=0
virtual bool	getClosestUTF16GlyphInfoAt (SkScalar dx, SkScalar dy, GlyphInfo *glyphInfo)=0
virtual SkFont	getFontAt (TextIndex codeUnitIndex) const =0
virtual SkFont	getFontAtUTF16Offset (size_t codeUnitIndex)=0
virtual std::vector< FontInfo >	getFonts () const =0

Static Public Member Functions
static SkPath	GetPath (SkTextBlob *textBlob)

Protected Attributes
sk_sp< FontCollection >	fFontCollection
ParagraphStyle	fParagraphStyle
SkScalar	fAlphabeticBaseline
SkScalar	fIdeographicBaseline
SkScalar	fHeight
SkScalar	fWidth
SkScalar	fMaxIntrinsicWidth
SkScalar	fMinIntrinsicWidth
SkScalar	fLongestLine
bool	fExceededMaxLines

Detailed Description

Definition at line 19 of file Paragraph.h.

Member Typedef Documentation

ExtendedVisitor

using skia::textlayout::Paragraph::ExtendedVisitor = std::function<void(int lineNumber, const ExtendedVisitorInfo*)>

Definition at line 112 of file Paragraph.h.

Visitor

using skia::textlayout::Paragraph::Visitor = std::function<void(int lineNumber, const VisitorInfo*)>

Definition at line 98 of file Paragraph.h.

Member Enumeration Documentation

VisitorFlags

enum skia::textlayout::Paragraph::VisitorFlags

Enumerator
kWhiteSpace_VisitorFlag

Definition at line 83 of file Paragraph.h.

                      {
        kWhiteSpace_VisitorFlag = 1 << 0,
    };

Constructor & Destructor Documentation

Paragraph()

skia::textlayout::Paragraph::Paragraph	(	ParagraphStyle	style,
		sk_sp< FontCollection >	fonts
	)

Definition at line 58 of file ParagraphImpl.cpp.

            : fFontCollection(std::move(fonts))
            , fParagraphStyle(std::move(style))
            , fAlphabeticBaseline(0)
            , fIdeographicBaseline(0)
            , fHeight(0)
            , fWidth(0)
            , fMaxIntrinsicWidth(0)
            , fMinIntrinsicWidth(0)
            , fLongestLine(0)
            , fExceededMaxLines(0)
{
    SkASSERT(fFontCollection);
}

~Paragraph()

virtual skia::textlayout::Paragraph::~Paragraph ( )

virtualdefault

Member Function Documentation

containsColorFontOrBitmap()

virtual bool skia::textlayout::Paragraph::containsColorFontOrBitmap ( SkTextBlob *  textBlob )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

containsEmoji()

virtual bool skia::textlayout::Paragraph::containsEmoji ( SkTextBlob *  textBlob )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

didExceedMaxLines()

bool skia::textlayout::Paragraph::didExceedMaxLines ( )

inline

Definition at line 40 of file Paragraph.h.

{ return fExceededMaxLines; }

extendedVisit()

virtual void skia::textlayout::Paragraph::extendedVisit ( const ExtendedVisitor &  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getActualTextRange()

virtual TextRange skia::textlayout::Paragraph::getActualTextRange ( int  lineNumber, bool  includeSpaces  ) const

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getAlphabeticBaseline()

SkScalar skia::textlayout::Paragraph::getAlphabeticBaseline ( )

inline

Definition at line 34 of file Paragraph.h.

{ return fAlphabeticBaseline; }

getClosestGlyphClusterAt()

virtual bool skia::textlayout::Paragraph::getClosestGlyphClusterAt ( SkScalar  dx, SkScalar  dy, GlyphClusterInfo *  glyphInfo  )

pure virtual

Finds the closest glyph cluster for a visual text position

Parameters

dx	x coordinate
dy	y coordinate
glyphInfo	a glyph cluster info filled if not null

Returns

true if glyph cluster was found; false if not (which usually means the paragraph is empty)

Implemented in skia::textlayout::ParagraphImpl.

getClosestUTF16GlyphInfoAt()

virtual bool skia::textlayout::Paragraph::getClosestUTF16GlyphInfoAt ( SkScalar  dx, SkScalar  dy, GlyphInfo *  glyphInfo  )

pure virtual

Finds the information associated with the closest glyph to the given paragraph coordinates.

Parameters

dx	x coordinate
dy	y coordinate
glyphInfo	an optional GlyphInfo struct to hold the information associated with the glyph found. The text indices and text ranges are described using UTF-16 offsets

Returns

true if a graphme cluster was found; false if not (which usually means the paragraph is empty)

Implemented in skia::textlayout::ParagraphImpl.

getFontAt()

virtual SkFont skia::textlayout::Paragraph::getFontAt ( TextIndex  codeUnitIndex ) const

pure virtual

Returns the font that is used to shape the text at the position

Parameters

codeUnitIndex

text index

Returns

font info or an empty font info if the text is not found

Implemented in skia::textlayout::ParagraphImpl.

getFontAtUTF16Offset()

virtual SkFont skia::textlayout::Paragraph::getFontAtUTF16Offset ( size_t  codeUnitIndex )

pure virtual

Returns the font used to shape the text at the given UTF-16 offset.

Parameters

codeUnitIndex

a UTF-16 offset in the paragraph

Returns

font info or an empty font info if the text is not found

Implemented in skia::textlayout::ParagraphImpl.

getFonts()

virtual std::vector< FontInfo > skia::textlayout::Paragraph::getFonts ( ) const

pure virtual

Returns the information about all the fonts used to shape the paragraph text

Returns

a list of fonts and text ranges

Implemented in skia::textlayout::ParagraphImpl.

getGlyphClusterAt()

virtual bool skia::textlayout::Paragraph::getGlyphClusterAt ( TextIndex  codeUnitIndex, GlyphClusterInfo *  glyphInfo  )

pure virtual

Finds a glyph cluster for text index

Parameters

codeUnitIndex	a text index
glyphInfo	a glyph cluster info filled if not null

Returns

true if glyph cluster was found; false if not

Implemented in skia::textlayout::ParagraphImpl.

getGlyphInfoAtUTF16Offset()

virtual bool skia::textlayout::Paragraph::getGlyphInfoAtUTF16Offset ( size_t  codeUnitIndex, GlyphInfo *  glyphInfo  )

pure virtual

Retrives the information associated with the glyph located at the given codeUnitIndex.

Parameters

codeUnitIndex	a UTF-16 offset into the paragraph
glyphInfo	an optional GlyphInfo struct to hold the information associated with the glyph found at the given index

Returns

false only if the offset is out of bounds

Implemented in skia::textlayout::ParagraphImpl.

getGlyphPositionAtCoordinate()

virtual PositionWithAffinity skia::textlayout::Paragraph::getGlyphPositionAtCoordinate ( SkScalar  dx, SkScalar  dy  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getHeight()

SkScalar skia::textlayout::Paragraph::getHeight ( )

inline

Definition at line 28 of file Paragraph.h.

{ return fHeight; }

getIdeographicBaseline()

SkScalar skia::textlayout::Paragraph::getIdeographicBaseline ( )

inline

Definition at line 36 of file Paragraph.h.

{ return fIdeographicBaseline; }

getLineMetrics()

virtual void skia::textlayout::Paragraph::getLineMetrics ( std::vector< LineMetrics > &  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getLineMetricsAt()

virtual bool skia::textlayout::Paragraph::getLineMetricsAt ( int  lineNumber, LineMetrics *  lineMetrics  ) const

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getLineNumberAt()

virtual int skia::textlayout::Paragraph::getLineNumberAt ( TextIndex  codeUnitIndex ) const

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getLineNumberAtUTF16Offset()

virtual int skia::textlayout::Paragraph::getLineNumberAtUTF16Offset ( size_t  codeUnitIndex )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getLongestLine()

SkScalar skia::textlayout::Paragraph::getLongestLine ( )

inline

Definition at line 38 of file Paragraph.h.

{ return fLongestLine; }

getMaxIntrinsicWidth()

SkScalar skia::textlayout::Paragraph::getMaxIntrinsicWidth ( )

inline

Definition at line 32 of file Paragraph.h.

{ return fMaxIntrinsicWidth; }

getMaxWidth()

SkScalar skia::textlayout::Paragraph::getMaxWidth ( )

inline

Definition at line 26 of file Paragraph.h.

{ return fWidth; }

getMinIntrinsicWidth()

SkScalar skia::textlayout::Paragraph::getMinIntrinsicWidth ( )

inline

Definition at line 30 of file Paragraph.h.

{ return fMinIntrinsicWidth; }

getPath()

virtual int skia::textlayout::Paragraph::getPath ( int  lineNumber, SkPath *  dest  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

GetPath()

SkPath skia::textlayout::Paragraph::GetPath ( SkTextBlob *  textBlob )

static

Definition at line 1504 of file ParagraphImpl.cpp.

                                              {
    SkPath path;
    SkTextBlobRunIterator iter(textBlob);
    while (!iter.done()) {
        SkFont font = iter.font();
        struct Rec { SkPath* fDst; SkPoint fOffset; const SkPoint* fPos; } rec =
            {&path, {textBlob->bounds().left(), textBlob->bounds().top()},
             iter.points()};
        font.getPaths(iter.glyphs(), iter.glyphCount(),
            [](const SkPath* src, const SkMatrix& mx, void* ctx) {
                Rec* rec = (Rec*)ctx;
                if (src) {
                    SkMatrix tmp(mx);
                    tmp.postTranslate(rec->fPos->fX - rec->fOffset.fX,
                                      rec->fPos->fY - rec->fOffset.fY);
                    rec->fDst->addPath(*src, tmp);
                }
                rec->fPos += 1;
            },
            &rec);
        iter.next();
    }
    return path;
}

getRectsForPlaceholders()

virtual std::vector< TextBox > skia::textlayout::Paragraph::getRectsForPlaceholders ( )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getRectsForRange()

virtual std::vector< TextBox > skia::textlayout::Paragraph::getRectsForRange ( unsigned  start, unsigned  end, RectHeightStyle  rectHeightStyle, RectWidthStyle  rectWidthStyle  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

getWordBoundary()

virtual SkRange< size_t > skia::textlayout::Paragraph::getWordBoundary ( unsigned  offset )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

layout()

virtual void skia::textlayout::Paragraph::layout ( SkScalar  width )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

lineNumber()

virtual size_t skia::textlayout::Paragraph::lineNumber ( )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

markDirty()

virtual void skia::textlayout::Paragraph::markDirty ( )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

paint() [1/2]

virtual void skia::textlayout::Paragraph::paint ( ParagraphPainter *  painter, SkScalar  x, SkScalar  y  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

paint() [2/2]

virtual void skia::textlayout::Paragraph::paint ( SkCanvas *  canvas, SkScalar  x, SkScalar  y  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

unresolvedCodepoints()

virtual std::unordered_set< SkUnichar > skia::textlayout::Paragraph::unresolvedCodepoints ( )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

unresolvedGlyphs()

virtual int32_t skia::textlayout::Paragraph::unresolvedGlyphs ( )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

updateBackgroundPaint()

virtual void skia::textlayout::Paragraph::updateBackgroundPaint ( size_t  from, size_t  to, SkPaint  paint  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

updateFontSize()

virtual void skia::textlayout::Paragraph::updateFontSize ( size_t  from, size_t  to, SkScalar  fontSize  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

updateForegroundPaint()

virtual void skia::textlayout::Paragraph::updateForegroundPaint ( size_t  from, size_t  to, SkPaint  paint  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

updateTextAlign()

virtual void skia::textlayout::Paragraph::updateTextAlign ( TextAlign  textAlign )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

visit()

virtual void skia::textlayout::Paragraph::visit ( const Visitor &  )

pure virtual

Implemented in skia::textlayout::ParagraphImpl.

Member Data Documentation

fAlphabeticBaseline

SkScalar skia::textlayout::Paragraph::fAlphabeticBaseline

protected

Definition at line 277 of file Paragraph.h.

fExceededMaxLines

bool skia::textlayout::Paragraph::fExceededMaxLines

protected

Definition at line 284 of file Paragraph.h.

fFontCollection

sk_sp<FontCollection> skia::textlayout::Paragraph::fFontCollection

protected

Definition at line 273 of file Paragraph.h.

fHeight

SkScalar skia::textlayout::Paragraph::fHeight

protected

Definition at line 279 of file Paragraph.h.

fIdeographicBaseline

SkScalar skia::textlayout::Paragraph::fIdeographicBaseline

protected

Definition at line 278 of file Paragraph.h.

fLongestLine

SkScalar skia::textlayout::Paragraph::fLongestLine

protected

Definition at line 283 of file Paragraph.h.

fMaxIntrinsicWidth

SkScalar skia::textlayout::Paragraph::fMaxIntrinsicWidth

protected

Definition at line 281 of file Paragraph.h.

fMinIntrinsicWidth

SkScalar skia::textlayout::Paragraph::fMinIntrinsicWidth

protected

Definition at line 282 of file Paragraph.h.

fParagraphStyle

ParagraphStyle skia::textlayout::Paragraph::fParagraphStyle

protected

Definition at line 274 of file Paragraph.h.

fWidth

SkScalar skia::textlayout::Paragraph::fWidth

protected

Definition at line 280 of file Paragraph.h.

---

The documentation for this class was generated from the following files:

• third_party/skia/modules/skparagraph/include/Paragraph.h
• third_party/skia/modules/skparagraph/src/ParagraphImpl.cpp