skia::textlayout::ParagraphBuilderImpl Class Reference

#include <ParagraphBuilderImpl.h>

Inheritance diagram for skia::textlayout::ParagraphBuilderImpl:

Public Member Functions
	ParagraphBuilderImpl (const ParagraphStyle &style, sk_sp< FontCollection > fontCollection, sk_sp< SkUnicode > unicode)
	ParagraphBuilderImpl (const ParagraphStyle &style, sk_sp< FontCollection > fontCollection)
	~ParagraphBuilderImpl () override
void	pushStyle (const TextStyle &style) override
void	pop () override
TextStyle	peekStyle () override
void	addText (const std::u16string &text) override
void	addText (const char *text) override
void	addText (const char *text, size_t len) override
void	addPlaceholder (const PlaceholderStyle &placeholderStyle) override
std::unique_ptr< Paragraph >	Build () override
SkSpan< char >	getText () override
const ParagraphStyle &	getParagraphStyle () const override
void	Reset () override
Public Member Functions inherited from skia::textlayout::ParagraphBuilder
virtual	~ParagraphBuilder ()=default

Static Public Member Functions
static std::unique_ptr< ParagraphBuilder >	make (const ParagraphStyle &style, sk_sp< FontCollection > fontCollection, sk_sp< SkUnicode > unicode)
static std::unique_ptr< ParagraphBuilder >	make (const ParagraphStyle &style, sk_sp< FontCollection > fontCollection)
static bool	RequiresClientICU ()
Static Public Member Functions inherited from skia::textlayout::ParagraphBuilder
static std::unique_ptr< ParagraphBuilder >	make (const ParagraphStyle &style, sk_sp< FontCollection > fontCollection, sk_sp< SkUnicode > unicode)
static std::unique_ptr< ParagraphBuilder >	make (const ParagraphStyle &style, sk_sp< FontCollection > fontCollection)

Protected Member Functions
void	startStyledBlock ()
void	endRunIfNeeded ()
const TextStyle &	internalPeekStyle ()
void	addPlaceholder (const PlaceholderStyle &placeholderStyle, bool lastOne)
void	finalize ()
Protected Member Functions inherited from skia::textlayout::ParagraphBuilder
	ParagraphBuilder ()

Protected Attributes
SkString	fUtf8
skia_private::STArray< 4, TextStyle, true >	fTextStyles
skia_private::STArray< 4, Block, true >	fStyledBlocks
skia_private::STArray< 4, Placeholder, true >	fPlaceholders
sk_sp< FontCollection >	fFontCollection
ParagraphStyle	fParagraphStyle
sk_sp< SkUnicode >	fUnicode

Detailed Description

Definition at line 20 of file ParagraphBuilderImpl.h.

Constructor & Destructor Documentation

ParagraphBuilderImpl() [1/2]

skia::textlayout::ParagraphBuilderImpl::ParagraphBuilderImpl	(	const ParagraphStyle &	style,
		sk_sp< FontCollection >	fontCollection,
		sk_sp< SkUnicode >	unicode
	)

Definition at line 95 of file ParagraphBuilderImpl.cpp.

        : ParagraphBuilder()
        , fUtf8()
        , fFontCollection(std::move(fontCollection))
        , fParagraphStyle(style)
        , fUnicode(std::move(unicode))
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
        , fTextIsFinalized(false)
        , fUsingClientInfo(false)
#endif
{
    SkASSERT(fFontCollection);
    startStyledBlock();
}

ParagraphBuilderImpl() [2/2]

skia::textlayout::ParagraphBuilderImpl::ParagraphBuilderImpl	(	const ParagraphStyle &	style,
		sk_sp< FontCollection >	fontCollection
	)

Definition at line 75 of file ParagraphBuilderImpl.cpp.

        : ParagraphBuilderImpl(style, std::move(fontCollection), get_unicode())
{ }

~ParagraphBuilderImpl()

skia::textlayout::ParagraphBuilderImpl::~ParagraphBuilderImpl ( )

overridedefault

Member Function Documentation

addPlaceholder() [1/2]

void skia::textlayout::ParagraphBuilderImpl::addPlaceholder ( const PlaceholderStyle &  placeholderStyle )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 169 of file ParagraphBuilderImpl.cpp.

                                                                                  {
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    SkASSERT(!fTextIsFinalized);
#endif
    addPlaceholder(placeholderStyle, false);
}

addPlaceholder() [2/2]

void skia::textlayout::ParagraphBuilderImpl::addPlaceholder ( const PlaceholderStyle &  placeholderStyle, bool  lastOne  )

protected

Definition at line 176 of file ParagraphBuilderImpl.cpp.

                                                                                                {
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    // The very last placeholder is added automatically
    // and only AFTER finalize() is called
    SkASSERT(!fTextIsFinalized || lastOne);
#endif
    if (!fUtf8.isEmpty() && !lastOne) {
        // We keep the very last text style
        this->endRunIfNeeded();
    }
 
    BlockRange stylesBefore(fPlaceholders.empty() ? 0 : fPlaceholders.back().fBlocksBefore.end + 1,
                            fStyledBlocks.size());
    TextRange textBefore(fPlaceholders.empty() ? 0 : fPlaceholders.back().fRange.end,
                            fUtf8.size());
    auto start = fUtf8.size();
    auto topStyle = internalPeekStyle();
    if (!lastOne) {
        pushStyle(topStyle.cloneForPlaceholder());
        addText(std::u16string(1ull, 0xFFFC));
        pop();
    }
    auto end = fUtf8.size();
    fPlaceholders.emplace_back(start, end, placeholderStyle, topStyle, stylesBefore, textBefore);
}

addText() [1/3]

void skia::textlayout::ParagraphBuilderImpl::addText ( const char *  text )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 155 of file ParagraphBuilderImpl.cpp.

                                                   {
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    SkASSERT(!fTextIsFinalized);
#endif
    fUtf8.append(text);
}

addText() [2/3]

void skia::textlayout::ParagraphBuilderImpl::addText ( const char *  text, size_t  len  )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 162 of file ParagraphBuilderImpl.cpp.

                                                               {
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    SkASSERT(!fTextIsFinalized);
#endif
    fUtf8.append(text, len);
}

addText() [3/3]

void skia::textlayout::ParagraphBuilderImpl::addText ( const std::u16string &  text )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 147 of file ParagraphBuilderImpl.cpp.

                                                           {
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    SkASSERT(!fTextIsFinalized);
#endif
    auto utf8 = SkUnicode::convertUtf16ToUtf8(text);
    fUtf8.append(utf8);
}

Build()

std::unique_ptr< Paragraph > skia::textlayout::ParagraphBuilderImpl::Build ( )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 235 of file ParagraphBuilderImpl.cpp.

                                                     {
    this->finalize();
    // Add one fake placeholder with the rest of the text
    this->addPlaceholder(PlaceholderStyle(), true);
 
    fUTF8IndexForUTF16Index.clear();
    fUTF16IndexForUTF8Index.clear();
#if !defined(SK_DISABLE_LEGACY_PARAGRAPH_UNICODE) && defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    if (fUsingClientInfo && !fUnicode) {
        // This is the place where SkUnicode is paired with SkParagraph
        fUnicode = SkUnicodes::Client::Make(this->getText(),
                                            std::move(fWordsUtf16),
                                            std::move(fGraphemeBreaksUtf8),
                                            std::move(fLineBreaksUtf8));
    }
#endif
 
    SkASSERT_RELEASE(fUnicode);
    return std::make_unique<ParagraphImpl>(
            fUtf8, fParagraphStyle, fStyledBlocks, fPlaceholders, fFontCollection, fUnicode);
}

endRunIfNeeded()

void skia::textlayout::ParagraphBuilderImpl::endRunIfNeeded ( )

protected

Definition at line 202 of file ParagraphBuilderImpl.cpp.

                                          {
    if (fStyledBlocks.empty()) {
        return;
    }
 
    auto& last = fStyledBlocks.back();
    if (last.fRange.start == fUtf8.size()) {
        fStyledBlocks.pop_back();
    } else {
        last.fRange.end = fUtf8.size();
    }
}

finalize()

void skia::textlayout::ParagraphBuilderImpl::finalize ( )

protected

Definition at line 220 of file ParagraphBuilderImpl.cpp.

                                    {
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    if (fTextIsFinalized) {
        return;
    }
#endif
    if (!fUtf8.isEmpty()) {
        this->endRunIfNeeded();
    }
 
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    fTextIsFinalized = true;
#endif
}

getParagraphStyle()

const ParagraphStyle & skia::textlayout::ParagraphBuilderImpl::getParagraphStyle ( ) const

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 262 of file ParagraphBuilderImpl.cpp.

                                                                    {
    return fParagraphStyle;
}

getText()

SkSpan< char > skia::textlayout::ParagraphBuilderImpl::getText ( )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 257 of file ParagraphBuilderImpl.cpp.

                                           {
    this->finalize();
    return SkSpan<char>(fUtf8.isEmpty() ? nullptr : fUtf8.data(), fUtf8.size());
}

internalPeekStyle()

const TextStyle & skia::textlayout::ParagraphBuilderImpl::internalPeekStyle ( )

protected

Definition at line 135 of file ParagraphBuilderImpl.cpp.

                                                         {
    if (fTextStyles.empty()) {
        return fParagraphStyle.getTextStyle();
    } else {
        return fTextStyles.back();
    }
}

make() [1/2]

std::unique_ptr< ParagraphBuilder > skia::textlayout::ParagraphBuilderImpl::make ( const ParagraphStyle &  style, sk_sp< FontCollection >  fontCollection  )

static

Definition at line 70 of file ParagraphBuilderImpl.cpp.

                                                                                                   {
    return std::make_unique<ParagraphBuilderImpl>(style, std::move(fontCollection), get_unicode());
}

make() [2/2]

std::unique_ptr< ParagraphBuilder > skia::textlayout::ParagraphBuilderImpl::make ( const ParagraphStyle &  style, sk_sp< FontCollection >  fontCollection, sk_sp< SkUnicode >  unicode  )

static

Definition at line 88 of file ParagraphBuilderImpl.cpp.

                                                                                       {
    return std::make_unique<ParagraphBuilderImpl>(style, std::move(fontCollection),
                                                  std::move(unicode));
}

peekStyle()

TextStyle skia::textlayout::ParagraphBuilderImpl::peekStyle ( )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 143 of file ParagraphBuilderImpl.cpp.

                                          {
    return this->internalPeekStyle();
}

pop()

void skia::textlayout::ParagraphBuilderImpl::pop ( )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 124 of file ParagraphBuilderImpl.cpp.

                               {
    if (!fTextStyles.empty()) {
        fTextStyles.pop_back();
    } else {
        // In this case we use paragraph style and skip Pop operation
        SkDEBUGF("SkParagraphBuilder.Pop() called too many times.\n");
    }
 
    this->startStyledBlock();
}

pushStyle()

void skia::textlayout::ParagraphBuilderImpl::pushStyle ( const TextStyle &  style )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 113 of file ParagraphBuilderImpl.cpp.

                                                           {
    fTextStyles.push_back(style);
    if (!fStyledBlocks.empty() && fStyledBlocks.back().fRange.end == fUtf8.size() &&
        fStyledBlocks.back().fStyle == style) {
        // Just continue with the same style
    } else {
        // Go with the new style
        startStyledBlock();
    }
}

RequiresClientICU()

bool skia::textlayout::ParagraphBuilderImpl::RequiresClientICU ( )

static

Definition at line 337 of file ParagraphBuilderImpl.cpp.

                                             {
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    return true;
#else
    return false;
#endif
}

Reset()

void skia::textlayout::ParagraphBuilderImpl::Reset ( )

overridevirtual

Implements skia::textlayout::ParagraphBuilder.

Definition at line 320 of file ParagraphBuilderImpl.cpp.

                                 {
 
    fTextStyles.clear();
    fUtf8.reset();
    fStyledBlocks.clear();
    fPlaceholders.clear();
    fUTF8IndexForUTF16Index.clear();
    fUTF16IndexForUTF8Index.clear();
#if defined(SK_UNICODE_CLIENT_IMPLEMENTATION)
    fWordsUtf16.clear();
    fGraphemeBreaksUtf8.clear();
    fLineBreaksUtf8.clear();
    fTextIsFinalized = false;
#endif
    startStyledBlock();
}

startStyledBlock()

void skia::textlayout::ParagraphBuilderImpl::startStyledBlock ( )

protected

Definition at line 215 of file ParagraphBuilderImpl.cpp.

                                            {
    endRunIfNeeded();
    fStyledBlocks.emplace_back(fUtf8.size(), fUtf8.size(), internalPeekStyle());
}

Member Data Documentation

fFontCollection

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

protected

Definition at line 116 of file ParagraphBuilderImpl.h.

fParagraphStyle

ParagraphStyle skia::textlayout::ParagraphBuilderImpl::fParagraphStyle

protected

Definition at line 117 of file ParagraphBuilderImpl.h.

fPlaceholders

skia_private::STArray<4, Placeholder, true> skia::textlayout::ParagraphBuilderImpl::fPlaceholders

protected

Definition at line 115 of file ParagraphBuilderImpl.h.

fStyledBlocks

skia_private::STArray<4, Block, true> skia::textlayout::ParagraphBuilderImpl::fStyledBlocks

protected

Definition at line 114 of file ParagraphBuilderImpl.h.

fTextStyles

skia_private::STArray<4, TextStyle, true> skia::textlayout::ParagraphBuilderImpl::fTextStyles

protected

Definition at line 113 of file ParagraphBuilderImpl.h.

fUnicode

sk_sp<SkUnicode> skia::textlayout::ParagraphBuilderImpl::fUnicode

protected

Definition at line 119 of file ParagraphBuilderImpl.h.

fUtf8

SkString skia::textlayout::ParagraphBuilderImpl::fUtf8

protected

Definition at line 112 of file ParagraphBuilderImpl.h.

---

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

• third_party/skia/modules/skparagraph/src/ParagraphBuilderImpl.h
• third_party/skia/modules/skparagraph/src/ParagraphBuilderImpl.cpp