#include <Run.h>

Public Types
enum	BreakType { None , GraphemeBreak , SoftLineBreak , HardLineBreak }

Public Member Functions
	Cluster ()

	Cluster (ParagraphImpl *owner, RunIndex runIndex, size_t start, size_t end, SkSpan< const char > text, SkScalar width, SkScalar height)

	Cluster (TextRange textRange)

	Cluster (const Cluster &)=default

	~Cluster ()=default

SkScalar	sizeToChar (TextIndex ch) const

SkScalar	sizeFromChar (TextIndex ch) const

size_t	roundPos (SkScalar s) const

void	space (SkScalar shift)

ParagraphImpl *	getOwner () const

void	setOwner (ParagraphImpl *owner)

bool	isWhitespaceBreak () const

bool	isIntraWordBreak () const

bool	isHardBreak () const

bool	isIdeographic () const

bool	isSoftBreak () const

bool	isGraphemeBreak () const

bool	canBreakLineAfter () const

size_t	startPos () const

size_t	endPos () const

SkScalar	width () const

SkScalar	height () const

size_t	size () const

void	setHalfLetterSpacing (SkScalar halfLetterSpacing)

SkScalar	getHalfLetterSpacing () const

TextRange	textRange () const

RunIndex	runIndex () const

ParagraphImpl *	owner () const

Run *	runOrNull () const

Run &	run () const

SkFont	font () const

SkScalar	trimmedWidth (size_t pos) const

bool	contains (TextIndex ch) const

bool	belongs (TextRange text) const

bool	startsIn (TextRange text) const

Detailed Description

Definition at line 263 of file Run.h.

Member Enumeration Documentation

◆ BreakType

enum skia::textlayout::Cluster::BreakType

Enumerator
None
GraphemeBreak
SoftLineBreak
HardLineBreak

Definition at line 265 of file Run.h.

                   {
        None,
        GraphemeBreak,  // calculated for all clusters (UBRK_CHARACTER)
        SoftLineBreak,  // calculated for all clusters (UBRK_LINE & UBRK_CHARACTER)
        HardLineBreak,  // calculated for all clusters (UBRK_LINE)
    };

Constructor & Destructor Documentation

◆ Cluster() [1/4]

skia::textlayout::Cluster::Cluster ( )

inline

Definition at line 272 of file Run.h.

            : fOwner(nullptr)
            , fRunIndex(EMPTY_RUN)
            , fTextRange(EMPTY_TEXT)
            , fGraphemeRange(EMPTY_RANGE)
            , fStart(0)
            , fEnd()
            , fWidth()
            , fHeight()
            , fHalfLetterSpacing(0.0) {}

◆ Cluster() [2/4]

skia::textlayout::Cluster::Cluster	(	ParagraphImpl *	owner,
		RunIndex	runIndex,
		size_t	start,
		size_t	end,
		SkSpan< const char >	text,
		SkScalar	width,
		SkScalar	height
	)

Definition at line 337 of file ParagraphImpl.cpp.

        : fOwner(owner)
        , fRunIndex(runIndex)
        , fTextRange(text.begin() - fOwner->text().begin(), text.end() - fOwner->text().begin())
        , fGraphemeRange(EMPTY_RANGE)
        , fStart(start)
        , fEnd(end)
        , fWidth(width)
        , fHeight(height)
        , fHalfLetterSpacing(0.0)
        , fIsIdeographic(false) {
    size_t whiteSpacesBreakLen = 0;
    size_t intraWordBreakLen = 0;
 
    const char* ch = text.begin();
    if (text.end() - ch == 1 && *(const unsigned char*)ch <= 0x7F) {
        // I am not even sure it's worth it if we do not save a unicode call
        if (is_ascii_7bit_space(*ch)) {
            ++whiteSpacesBreakLen;
        }
    } else {
        for (auto i = fTextRange.start; i < fTextRange.end; ++i) {
            if (fOwner->codeUnitHasProperty(i, SkUnicode::CodeUnitFlags::kPartOfWhiteSpaceBreak)) {
                ++whiteSpacesBreakLen;
            }
            if (fOwner->codeUnitHasProperty(i, SkUnicode::CodeUnitFlags::kPartOfIntraWordBreak)) {
                ++intraWordBreakLen;
            }
            if (fOwner->codeUnitHasProperty(i, SkUnicode::CodeUnitFlags::kIdeographic)) {
                fIsIdeographic = true;
            }
        }
    }
 
    fIsWhiteSpaceBreak = whiteSpacesBreakLen == fTextRange.width();
    fIsIntraWordBreak = intraWordBreakLen == fTextRange.width();
    fIsHardBreak = fOwner->codeUnitHasProperty(fTextRange.end,
                                               SkUnicode::CodeUnitFlags::kHardLineBreakBefore);
}

◆ Cluster() [3/4]

skia::textlayout::Cluster::Cluster ( TextRange textRange )

inline

Definition at line 291 of file Run.h.

291: fTextRange(textRange), fGraphemeRange(EMPTY_RANGE) { }

skia::textlayout::Cluster::textRange

TextRange textRange() const

Definition Run.h:325

◆ Cluster() [4/4]

skia::textlayout::Cluster::Cluster ( const Cluster & )

default

◆ ~Cluster()

skia::textlayout::Cluster::~Cluster ( )

default

Member Function Documentation

◆ belongs()

bool skia::textlayout::Cluster::belongs ( TextRange text ) const

inline

Definition at line 338 of file Run.h.

                                       {
        return fTextRange.start >= text.start && fTextRange.end <= text.end;
    }

◆ canBreakLineAfter()

bool skia::textlayout::Cluster::canBreakLineAfter ( ) const

inline

Definition at line 315 of file Run.h.

315{ return isHardBreak() || isSoftBreak(); }

skia::textlayout::Cluster::isSoftBreak

bool isSoftBreak() const

Definition Run.cpp:346

skia::textlayout::Cluster::isHardBreak

bool isHardBreak() const

Definition Run.h:310

◆ contains()

bool skia::textlayout::Cluster::contains ( TextIndex ch ) const

inline

Definition at line 336 of file Run.h.

336{ return ch >= fTextRange.start && ch < fTextRange.end; }

◆ endPos()

size_t skia::textlayout::Cluster::endPos ( ) const

inline

Definition at line 317 of file Run.h.

317{ return fEnd; }

◆ font()

SkFont skia::textlayout::Cluster::font ( ) const

Definition at line 341 of file Run.cpp.

                           {
    SkASSERT(fRunIndex < fOwner->runs().size());
    return fOwner->run(fRunIndex).font();
}

◆ getHalfLetterSpacing()

SkScalar skia::textlayout::Cluster::getHalfLetterSpacing ( ) const

inline

Definition at line 323 of file Run.h.

323{ return fHalfLetterSpacing; }

◆ getOwner()

ParagraphImpl * skia::textlayout::Cluster::getOwner ( ) const

inline

Definition at line 305 of file Run.h.

305{ return fOwner; }

◆ height()

SkScalar skia::textlayout::Cluster::height ( ) const

inline

Definition at line 319 of file Run.h.

319{ return fHeight; }

◆ isGraphemeBreak()

bool skia::textlayout::Cluster::isGraphemeBreak ( ) const

Definition at line 351 of file Run.cpp.

                                    {
    return fOwner->codeUnitHasProperty(fTextRange.end, SkUnicode::CodeUnitFlags::kGraphemeStart);
}

◆ isHardBreak()

bool skia::textlayout::Cluster::isHardBreak ( ) const

inline

Definition at line 310 of file Run.h.

310{ return fIsHardBreak; }

◆ isIdeographic()

bool skia::textlayout::Cluster::isIdeographic ( ) const

inline

Definition at line 311 of file Run.h.

311{ return fIsIdeographic; }

◆ isIntraWordBreak()

bool skia::textlayout::Cluster::isIntraWordBreak ( ) const

inline

Definition at line 309 of file Run.h.

309{ return fIsIntraWordBreak; }

◆ isSoftBreak()

bool skia::textlayout::Cluster::isSoftBreak ( ) const

Definition at line 346 of file Run.cpp.

                                {
    return fOwner->codeUnitHasProperty(fTextRange.end,
                                       SkUnicode::CodeUnitFlags::kSoftLineBreakBefore);
}

◆ isWhitespaceBreak()

bool skia::textlayout::Cluster::isWhitespaceBreak ( ) const

inline

Definition at line 308 of file Run.h.

308{ return fIsWhiteSpaceBreak; }

◆ owner()

ParagraphImpl * skia::textlayout::Cluster::owner ( ) const

inline

Definition at line 328 of file Run.h.

328{ return fOwner; }

◆ roundPos()

size_t skia::textlayout::Cluster::roundPos ( SkScalar s ) const

Definition at line 296 of file Run.cpp.

                                         {
    auto ratio = (s * 1.0) / fWidth;
    return sk_double_floor2int(ratio * size());
}

◆ run()

Run & skia::textlayout::Cluster::run ( ) const

Definition at line 336 of file Run.cpp.

                        {
    SkASSERT(fRunIndex < fOwner->runs().size());
    return fOwner->run(fRunIndex);
}

◆ runIndex()

RunIndex skia::textlayout::Cluster::runIndex ( ) const

inline

Definition at line 327 of file Run.h.

327{ return fRunIndex; }

◆ runOrNull()

Run * skia::textlayout::Cluster::runOrNull ( ) const

Definition at line 329 of file Run.cpp.

                              {
    if (fRunIndex >= fOwner->runs().size()) {
        return nullptr;
    }
    return &fOwner->run(fRunIndex);
}

◆ setHalfLetterSpacing()

void skia::textlayout::Cluster::setHalfLetterSpacing ( SkScalar halfLetterSpacing )

inline

Definition at line 322 of file Run.h.

322{ fHalfLetterSpacing = halfLetterSpacing; }

◆ setOwner()

void skia::textlayout::Cluster::setOwner ( ParagraphImpl * owner )

inline

Definition at line 306 of file Run.h.

306{ fOwner = owner; }

◆ size()

size_t skia::textlayout::Cluster::size ( ) const

inline

Definition at line 320 of file Run.h.

320{ return fEnd - fStart; }

◆ sizeFromChar()

SkScalar skia::textlayout::Cluster::sizeFromChar ( TextIndex ch ) const

Definition at line 286 of file Run.cpp.

                                                 {
    if (ch < fTextRange.start || ch >= fTextRange.end) {
        return 0;
    }
    auto shift = fTextRange.end - ch - 1;
    auto ratio = shift * 1.0 / fTextRange.width();
 
    return SkDoubleToScalar(fWidth * ratio);
}

◆ sizeToChar()

SkScalar skia::textlayout::Cluster::sizeToChar ( TextIndex ch ) const

Definition at line 276 of file Run.cpp.

                                               {
    if (ch < fTextRange.start || ch >= fTextRange.end) {
        return 0;
    }
    auto shift = ch - fTextRange.start;
    auto ratio = shift * 1.0 / fTextRange.width();
 
    return SkDoubleToScalar(fWidth * ratio);
}

◆ space()

void skia::textlayout::Cluster::space ( SkScalar shift )

inline

Definition at line 301 of file Run.h.

                               {
        fWidth += shift;
    }

◆ startPos()

size_t skia::textlayout::Cluster::startPos ( ) const

inline

Definition at line 316 of file Run.h.

316{ return fStart; }

◆ startsIn()

bool skia::textlayout::Cluster::startsIn ( TextRange text ) const

inline

Definition at line 342 of file Run.h.

                                        {
        return fTextRange.start >= text.start && fTextRange.start < text.end;
    }

◆ textRange()

TextRange skia::textlayout::Cluster::textRange ( ) const

inline

Definition at line 325 of file Run.h.

325{ return fTextRange; }

◆ trimmedWidth()

SkScalar skia::textlayout::Cluster::trimmedWidth ( size_t pos ) const

Definition at line 301 of file Run.cpp.

                                               {
    // Find the width until the pos and return the min between trimmedWidth and the width(pos)
    // We don't have to take in account cluster shift since it's the same for 0 and for pos
    auto& run = fOwner->run(fRunIndex);
    return std::min(run.positionX(pos) - run.positionX(fStart), fWidth);
}

◆ width()

SkScalar skia::textlayout::Cluster::width ( ) const

inline

Definition at line 318 of file Run.h.

318{ return fWidth; }

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

third_party/skia/modules/skparagraph/src/Run.h
third_party/skia/modules/skparagraph/src/ParagraphImpl.cpp
third_party/skia/modules/skparagraph/src/Run.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ BreakType

Constructor & Destructor Documentation

◆ Cluster() [1/4]

◆ Cluster() [2/4]

◆ Cluster() [3/4]

◆ Cluster() [4/4]

◆ ~Cluster()

Member Function Documentation

◆ belongs()

◆ canBreakLineAfter()

◆ contains()

◆ endPos()

◆ font()

◆ getHalfLetterSpacing()

◆ getOwner()

◆ height()

◆ isGraphemeBreak()

◆ isHardBreak()

◆ isIdeographic()

◆ isIntraWordBreak()

◆ isSoftBreak()

◆ isWhitespaceBreak()

◆ owner()

◆ roundPos()

◆ run()

◆ runIndex()

◆ runOrNull()

◆ setHalfLetterSpacing()

◆ setOwner()

◆ size()

◆ sizeFromChar()

◆ sizeToChar()

◆ space()

◆ startPos()

◆ startsIn()

◆ textRange()

◆ trimmedWidth()

◆ width()