SkUnicode Class Reference

#include <SkUnicode.h>

Inheritance diagram for SkUnicode:

Classes
struct	BidiRegion
struct	LineBreakBefore

Public Types
enum	CodeUnitFlags {   kNoCodeUnitFlag = 0x00 , kPartOfWhiteSpaceBreak = 0x01 , kGraphemeStart = 0x02 , kSoftLineBreakBefore = 0x04 ,   kHardLineBreakBefore = 0x08 , kPartOfIntraWordBreak = 0x10 , kControl = 0x20 , kTabulation = 0x40 ,   kGlyphClusterStart = 0x80 , kIdeographic = 0x100 , kEmoji = 0x200 , kWordBreak = 0x400 ,   kSentenceBreak = 0x800 }
enum class	TextDirection { kLTR , kRTL }
enum class	LineBreakType { kSoftLineBreak = 0 , kHardLineBreak = 100 }
enum class	BreakType { kWords , kGraphemes , kLines , kSentences }
typedef size_t	Position
typedef uint8_t	BidiLevel

Public Member Functions
	~SkUnicode () override=default
virtual SkString	toUpper (const SkString &)=0
virtual SkString	toUpper (const SkString &, const char *locale)=0
virtual bool	isControl (SkUnichar utf8)=0
virtual bool	isWhitespace (SkUnichar utf8)=0
virtual bool	isSpace (SkUnichar utf8)=0
virtual bool	isTabulation (SkUnichar utf8)=0
virtual bool	isHardBreak (SkUnichar utf8)=0
virtual bool	isEmoji (SkUnichar utf8)=0
virtual bool	isEmojiComponent (SkUnichar utf8)=0
virtual bool	isEmojiModifierBase (SkUnichar utf8)=0
virtual bool	isEmojiModifier (SkUnichar utf8)=0
virtual bool	isRegionalIndicator (SkUnichar utf8)=0
virtual bool	isIdeographic (SkUnichar utf8)=0
virtual std::unique_ptr< SkBidiIterator >	makeBidiIterator (const uint16_t text[], int count, SkBidiIterator::Direction)=0
virtual std::unique_ptr< SkBidiIterator >	makeBidiIterator (const char text[], int count, SkBidiIterator::Direction)=0
virtual std::unique_ptr< SkBreakIterator >	makeBreakIterator (const char locale[], BreakType breakType)=0
virtual std::unique_ptr< SkBreakIterator >	makeBreakIterator (BreakType type)=0
virtual bool	getBidiRegions (const char utf8[], int utf8Units, TextDirection dir, std::vector< BidiRegion > *results)=0
virtual bool	getWords (const char utf8[], int utf8Units, const char *locale, std::vector< Position > *results)=0
virtual bool	getUtf8Words (const char utf8[], int utf8Units, const char *locale, std::vector< Position > *results)=0
virtual bool	getSentences (const char utf8[], int utf8Units, const char *locale, std::vector< Position > *results)=0
virtual bool	computeCodeUnitFlags (char utf8[], int utf8Units, bool replaceTabs, skia_private::TArray< SkUnicode::CodeUnitFlags, true > *results)=0
virtual bool	computeCodeUnitFlags (char16_t utf16[], int utf16Units, bool replaceTabs, skia_private::TArray< SkUnicode::CodeUnitFlags, true > *results)=0
template<typename Callback >
void	forEachCodepoint (const char *utf8, int32_t utf8Units, Callback &&callback)
template<typename Callback >
void	forEachCodepoint (const char16_t *utf16, int32_t utf16Units, Callback &&callback)
template<typename Callback >
void	forEachBidiRegion (const uint16_t utf16[], int utf16Units, SkBidiIterator::Direction dir, Callback &&callback)
template<typename Callback >
void	forEachBreak (const char16_t utf16[], int utf16Units, SkUnicode::BreakType type, Callback &&callback)
virtual void	reorderVisual (const BidiLevel runLevels[], int levelsCount, int32_t logicalFromVisual[])=0
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Static Public Member Functions
static bool	hasTabulationFlag (SkUnicode::CodeUnitFlags flags)
static bool	hasHardLineBreakFlag (SkUnicode::CodeUnitFlags flags)
static bool	hasSoftLineBreakFlag (SkUnicode::CodeUnitFlags flags)
static bool	hasGraphemeStartFlag (SkUnicode::CodeUnitFlags flags)
static bool	hasControlFlag (SkUnicode::CodeUnitFlags flags)
static bool	hasPartOfWhiteSpaceBreakFlag (SkUnicode::CodeUnitFlags flags)
static bool	extractBidi (const char utf8[], int utf8Units, TextDirection dir, std::vector< BidiRegion > *bidiRegions)
static SkString	convertUtf16ToUtf8 (const char16_t *utf16, int utf16Units)
static SkString	convertUtf16ToUtf8 (const std::u16string &utf16)
static std::u16string	convertUtf8ToUtf16 (const char *utf8, int utf8Units)
static std::u16string	convertUtf8ToUtf16 (const SkString &utf8)
template<typename Appender8 , typename Appender16 >
static bool	extractUtfConversionMapping (SkSpan< const char > utf8, Appender8 &&appender8, Appender16 &&appender16)

Detailed Description

Definition at line 77 of file SkUnicode.h.

Member Typedef Documentation

BidiLevel

typedef uint8_t SkUnicode::BidiLevel

Definition at line 99 of file SkUnicode.h.

Position

typedef size_t SkUnicode::Position

Definition at line 98 of file SkUnicode.h.

Member Enumeration Documentation

BreakType

enum class SkUnicode::BreakType

strong

Enumerator
kWords
kGraphemes
kLines
kSentences

Definition at line 112 of file SkUnicode.h.

{ kWords, kGraphemes, kLines, kSentences };

CodeUnitFlags

enum SkUnicode::CodeUnitFlags

Enumerator
kNoCodeUnitFlag
kPartOfWhiteSpaceBreak
kGraphemeStart
kSoftLineBreakBefore
kHardLineBreakBefore
kPartOfIntraWordBreak
kControl
kTabulation
kGlyphClusterStart
kIdeographic
kEmoji
kWordBreak
kSentenceBreak

Definition at line 79 of file SkUnicode.h.

                           {
            kNoCodeUnitFlag = 0x00,
            kPartOfWhiteSpaceBreak = 0x01,
            kGraphemeStart = 0x02,
            kSoftLineBreakBefore = 0x04,
            kHardLineBreakBefore = 0x08,
            kPartOfIntraWordBreak = 0x10,
            kControl = 0x20,
            kTabulation = 0x40,
            kGlyphClusterStart = 0x80,
            kIdeographic = 0x100,
            kEmoji = 0x200,
            kWordBreak = 0x400,
            kSentenceBreak = 0x800,
        };

LineBreakType

enum class SkUnicode::LineBreakType

strong

Enumerator
kSoftLineBreak
kHardLineBreak

Definition at line 107 of file SkUnicode.h.

                                 {
            kSoftLineBreak = 0,
            kHardLineBreak = 100,
        };

TextDirection

enum class SkUnicode::TextDirection

strong

Enumerator
kLTR
kRTL

Definition at line 94 of file SkUnicode.h.

                                 {
            kLTR,
            kRTL,
        };

Constructor & Destructor Documentation

~SkUnicode()

SkUnicode::~SkUnicode ( )

overridedefault

Member Function Documentation

computeCodeUnitFlags() [1/2]

virtual bool SkUnicode::computeCodeUnitFlags ( char  utf8[], int  utf8Units, bool  replaceTabs, skia_private::TArray< SkUnicode::CodeUnitFlags, true > *  results  )

pure virtual

Implemented in SkUnicode_icu4x, SkUnicode_libgrapheme, SkUnicode_client, and SkUnicode_icu.

computeCodeUnitFlags() [2/2]

virtual bool SkUnicode::computeCodeUnitFlags ( char16_t  utf16[], int  utf16Units, bool  replaceTabs, skia_private::TArray< SkUnicode::CodeUnitFlags, true > *  results  )

pure virtual

Implemented in SkUnicode_icu4x, SkUnicode_libgrapheme, SkUnicode_client, and SkUnicode_icu.

convertUtf16ToUtf8() [1/2]

SkString SkUnicode::convertUtf16ToUtf8 ( const char16_t *  utf16, int  utf16Units  )

static

Definition at line 14 of file SkUnicode.cpp.

                                                                            {
 
    int utf8Units = SkUTF::UTF16ToUTF8(nullptr, 0, (uint16_t*)utf16, utf16Units);
    if (utf8Units < 0) {
        SkDEBUGF("Convert error: Invalid utf16 input");
        return SkString();
    }
    AutoTArray<char> utf8(utf8Units);
    SkDEBUGCODE(int dstLen =) SkUTF::UTF16ToUTF8(utf8.data(), utf8Units, (uint16_t*)utf16, utf16Units);
    SkASSERT(dstLen == utf8Units);
 
    return SkString(utf8.data(), utf8Units);
}

convertUtf16ToUtf8() [2/2]

SkString SkUnicode::convertUtf16ToUtf8 ( const std::u16string &  utf16 )

static

Definition at line 28 of file SkUnicode.cpp.

                                                                {
    return convertUtf16ToUtf8(utf16.c_str(), utf16.size());
}

convertUtf8ToUtf16() [1/2]

std::u16string SkUnicode::convertUtf8ToUtf16 ( const char *  utf8, int  utf8Units  )

static

Definition at line 32 of file SkUnicode.cpp.

                                                                          {
 
    int utf16Units = SkUTF::UTF8ToUTF16(nullptr, 0, utf8, utf8Units);
    if (utf16Units < 0) {
        SkDEBUGF("Convert error: Invalid utf8 input");
        return std::u16string();
    }
 
    AutoTArray<uint16_t> utf16(utf16Units);
    SkDEBUGCODE(int dstLen =) SkUTF::UTF8ToUTF16(utf16.data(), utf16Units, utf8, utf8Units);
    SkASSERT(dstLen == utf16Units);
 
    return std::u16string((char16_t *)utf16.data(), utf16Units);
}

convertUtf8ToUtf16() [2/2]

std::u16string SkUnicode::convertUtf8ToUtf16 ( const SkString &  utf8 )

static

Definition at line 47 of file SkUnicode.cpp.

                                                               {
    return convertUtf8ToUtf16(utf8.c_str(), utf8.size());
}

extractBidi()

static bool SkUnicode::extractBidi ( const char  utf8[], int  utf8Units, TextDirection  dir, std::vector< BidiRegion > *  bidiRegions  )

static

extractUtfConversionMapping()

template<typename Appender8 , typename Appender16 >

static bool SkUnicode::extractUtfConversionMapping ( SkSpan< const char >  utf8, Appender8 &&  appender8, Appender16 &&  appender16  )

inlinestatic

Definition at line 193 of file SkUnicode.h.

                                                                                                                         {
            size_t size8 = 0;
            size_t size16 = 0;
            auto ptr = utf8.begin();
            auto end = utf8.end();
            while (ptr < end) {
 
                size_t index = SkToSizeT(ptr - utf8.begin());
                SkUnichar u = SkUTF::NextUTF8(&ptr, end);
 
                // All UTF8 code units refer to the same codepoint
                size_t next = SkToSizeT(ptr - utf8.begin());
                for (auto i = index; i < next; ++i) {
                    //fUTF16IndexForUTF8Index.emplace_back(fUTF8IndexForUTF16Index.size());
                    appender16(size8);
                    ++size16;
                }
                //SkASSERT(fUTF16IndexForUTF8Index.size() == next);
                SkASSERT(size16 == next);
                if (size16 != next) {
                    return false;
                }
 
                // One or two UTF16 code units refer to the same codepoint
                uint16_t buffer[2];
                size_t count = SkUTF::ToUTF16(u, buffer);
                //fUTF8IndexForUTF16Index.emplace_back(index);
                appender8(index);
                ++size8;
                if (count > 1) {
                    //fUTF8IndexForUTF16Index.emplace_back(index);
                    appender8(index);
                    ++size8;
                }
            }
            //fUTF16IndexForUTF8Index.emplace_back(fUTF8IndexForUTF16Index.size());
            appender16(size8);
            ++size16;
            //fUTF8IndexForUTF16Index.emplace_back(fText.size());
            appender8(utf8.size());
            ++size8;
 
            return true;
        }

forEachBidiRegion()

template<typename Callback >

void SkUnicode::forEachBidiRegion ( const uint16_t  utf16[], int  utf16Units, SkBidiIterator::Direction  dir, Callback &&  callback  )

inline

Definition at line 266 of file SkUnicode.h.

                                                                                                                         {
            auto iter = makeBidiIterator(utf16, utf16Units, dir);
            const uint16_t* start16 = utf16;
            const uint16_t* end16 = utf16 + utf16Units;
            SkBidiIterator::Level currentLevel = 0;
 
            SkBidiIterator::Position pos16 = 0;
            while (pos16 <= iter->getLength()) {
                auto level = iter->getLevelAt(pos16);
                if (pos16 == 0) {
                    currentLevel = level;
                } else if (level != currentLevel) {
                    callback(pos16, start16 - utf16, currentLevel);
                    currentLevel = level;
                }
                if (start16 == end16) {
                    break;
                }
                SkUnichar u = SkUTF::NextUTF16(&start16, end16);
                pos16 += SkUTF::ToUTF16(u);
            }
        }

forEachBreak()

template<typename Callback >

void SkUnicode::forEachBreak ( const char16_t  utf16[], int  utf16Units, SkUnicode::BreakType  type, Callback &&  callback  )

inline

Definition at line 290 of file SkUnicode.h.

                                                                                                                {
            auto iter = makeBreakIterator(type);
            iter->setText(utf16, utf16Units);
            auto pos = iter->first();
            do {
                callback(pos, iter->status());
                pos = iter->next();
            } while (!iter->isDone());
        }

forEachCodepoint() [1/2]

template<typename Callback >

void SkUnicode::forEachCodepoint ( const char *  utf8, int32_t  utf8Units, Callback &&  callback  )

inline

Definition at line 239 of file SkUnicode.h.

                                                                                        {
            const char* current = utf8;
            const char* end = utf8 + utf8Units;
            while (current < end) {
                auto before = current - utf8;
                SkUnichar unichar = SkUTF::NextUTF8(&current, end);
                if (unichar < 0) unichar = 0xFFFD;
                auto after = current - utf8;
                uint16_t buffer[2];
                size_t count = SkUTF::ToUTF16(unichar, buffer);
                callback(unichar, before, after, count);
            }
        }

forEachCodepoint() [2/2]

template<typename Callback >

void SkUnicode::forEachCodepoint ( const char16_t *  utf16, int32_t  utf16Units, Callback &&  callback  )

inline

Definition at line 254 of file SkUnicode.h.

                                                                                              {
            const char16_t* current = utf16;
            const char16_t* end = utf16 + utf16Units;
            while (current < end) {
                auto before = current - utf16;
                SkUnichar unichar = SkUTF::NextUTF16((const uint16_t**)&current, (const uint16_t*)end);
                auto after = current - utf16;
                callback(unichar, before, after);
            }
        }

getBidiRegions()

virtual bool SkUnicode::getBidiRegions ( const char  utf8[], int  utf8Units, TextDirection  dir, std::vector< BidiRegion > *  results  )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_icu4x, and SkUnicode_libgrapheme.

getSentences()

virtual bool SkUnicode::getSentences ( const char  utf8[], int  utf8Units, const char *  locale, std::vector< Position > *  results  )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_icu4x, and SkUnicode_libgrapheme.

getUtf8Words()

virtual bool SkUnicode::getUtf8Words ( const char  utf8[], int  utf8Units, const char *  locale, std::vector< Position > *  results  )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_icu4x, and SkUnicode_libgrapheme.

getWords()

virtual bool SkUnicode::getWords ( const char  utf8[], int  utf8Units, const char *  locale, std::vector< Position > *  results  )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_icu4x, and SkUnicode_libgrapheme.

hasControlFlag()

bool SkUnicode::hasControlFlag ( SkUnicode::CodeUnitFlags  flags )

static

Definition at line 67 of file SkUnicode.cpp.

                                                           {
    return (flags & SkUnicode::kControl) == SkUnicode::kControl;
}

hasGraphemeStartFlag()

bool SkUnicode::hasGraphemeStartFlag ( SkUnicode::CodeUnitFlags  flags )

static

Definition at line 63 of file SkUnicode.cpp.

                                                                 {
    return (flags & SkUnicode::kGraphemeStart) == SkUnicode::kGraphemeStart;
}

hasHardLineBreakFlag()

bool SkUnicode::hasHardLineBreakFlag ( SkUnicode::CodeUnitFlags  flags )

static

Definition at line 55 of file SkUnicode.cpp.

                                                                 {
    return (flags & SkUnicode::kHardLineBreakBefore) == SkUnicode::kHardLineBreakBefore;
}

hasPartOfWhiteSpaceBreakFlag()

bool SkUnicode::hasPartOfWhiteSpaceBreakFlag ( SkUnicode::CodeUnitFlags  flags )

static

Definition at line 71 of file SkUnicode.cpp.

                                                                         {
    return (flags & SkUnicode::kPartOfWhiteSpaceBreak) == SkUnicode::kPartOfWhiteSpaceBreak;
}

hasSoftLineBreakFlag()

bool SkUnicode::hasSoftLineBreakFlag ( SkUnicode::CodeUnitFlags  flags )

static

Definition at line 59 of file SkUnicode.cpp.

                                                                 {
    return (flags & SkUnicode::kSoftLineBreakBefore) == SkUnicode::kSoftLineBreakBefore;
}

hasTabulationFlag()

bool SkUnicode::hasTabulationFlag ( SkUnicode::CodeUnitFlags  flags )

static

Definition at line 51 of file SkUnicode.cpp.

                                                              {
    return (flags & SkUnicode::kTabulation) == SkUnicode::kTabulation;
}

isControl()

virtual bool SkUnicode::isControl ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicodeHardCodedCharProperties, SkUnicode_icu, and SkUnicode_icu4x.

isEmoji()

virtual bool SkUnicode::isEmoji ( SkUnichar  utf8 )

pure virtual

Returns if a code point may start an emoji sequence. Returns true for '#', '*', and '0'-'9' since they may start an emoji sequence. To determine if a list of code points begins with an emoji sequence, use getEmojiSequence.

Implemented in SkUnicode_icu, SkUnicodeHardCodedCharProperties, and SkUnicode_icu4x.

isEmojiComponent()

virtual bool SkUnicode::isEmojiComponent ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicode_icu, SkUnicodeHardCodedCharProperties, and SkUnicode_icu4x.

isEmojiModifier()

virtual bool SkUnicode::isEmojiModifier ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicode_icu, SkUnicodeHardCodedCharProperties, and SkUnicode_icu4x.

isEmojiModifierBase()

virtual bool SkUnicode::isEmojiModifierBase ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicode_icu, SkUnicodeHardCodedCharProperties, and SkUnicode_icu4x.

isHardBreak()

virtual bool SkUnicode::isHardBreak ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicodeHardCodedCharProperties, SkUnicode_icu, and SkUnicode_icu4x.

isIdeographic()

virtual bool SkUnicode::isIdeographic ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicode_icu, SkUnicodeHardCodedCharProperties, and SkUnicode_icu4x.

isRegionalIndicator()

virtual bool SkUnicode::isRegionalIndicator ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicode_icu, SkUnicodeHardCodedCharProperties, and SkUnicode_icu4x.

isSpace()

virtual bool SkUnicode::isSpace ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicodeHardCodedCharProperties, SkUnicode_icu, and SkUnicode_icu4x.

isTabulation()

virtual bool SkUnicode::isTabulation ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicodeHardCodedCharProperties, SkUnicode_icu, and SkUnicode_icu4x.

isWhitespace()

virtual bool SkUnicode::isWhitespace ( SkUnichar  utf8 )

pure virtual

Implemented in SkUnicodeHardCodedCharProperties, SkUnicode_icu, and SkUnicode_icu4x.

makeBidiIterator() [1/2]

virtual std::unique_ptr< SkBidiIterator > SkUnicode::makeBidiIterator ( const char  text[], int  count, SkBidiIterator::Direction    )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_icu4x, and SkUnicode_libgrapheme.

makeBidiIterator() [2/2]

virtual std::unique_ptr< SkBidiIterator > SkUnicode::makeBidiIterator ( const uint16_t  text[], int  count, SkBidiIterator::Direction    )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_icu4x, and SkUnicode_libgrapheme.

makeBreakIterator() [1/2]

virtual std::unique_ptr< SkBreakIterator > SkUnicode::makeBreakIterator ( BreakType  type )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu4x, SkUnicode_libgrapheme, and SkUnicode_icu.

makeBreakIterator() [2/2]

virtual std::unique_ptr< SkBreakIterator > SkUnicode::makeBreakIterator ( const char  locale[], BreakType  breakType  )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu4x, SkUnicode_libgrapheme, and SkUnicode_icu.

reorderVisual()

virtual void SkUnicode::reorderVisual ( const BidiLevel  runLevels[], int  levelsCount, int32_t  logicalFromVisual[]  )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_icu4x, and SkUnicode_libgrapheme.

toUpper() [1/2]

virtual SkString SkUnicode::toUpper ( const SkString &  )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_icu4x, and SkUnicode_libgrapheme.

toUpper() [2/2]

virtual SkString SkUnicode::toUpper ( const SkString &  , const char *  locale  )

pure virtual

Implemented in SkUnicode_client, SkUnicode_icu, SkUnicode_libgrapheme, and SkUnicode_icu4x.

---

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

• third_party/skia/modules/skunicode/include/SkUnicode.h
• third_party/skia/modules/skunicode/src/SkUnicode.cpp