Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 19659 fix 3b #20650

Open
wants to merge 4 commits into
base: v4
Choose a base branch
from
Open

Issue 19659 fix 3b #20650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b5151f6
small fix with CCLOGs
mnievas Feb 2, 2021
5568ae2
Proposal 1 Korean failing
mnievas Feb 3, 2021
73472c1
wordSeparatorMode
mnievas Feb 6, 2021
6384604
Rolling back guild.grandle
mnievas Feb 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 60 additions & 12 deletions cocos/ui/UIRichText.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,6 +842,7 @@ ValueMap MyXMLVisitor::tagAttrMapWithXMLElement(const char ** attrs)

const std::string RichText::KEY_VERTICAL_SPACE("KEY_VERTICAL_SPACE");
const std::string RichText::KEY_WRAP_MODE("KEY_WRAP_MODE");
const std::string RichText::KEY_WORD_SEPARATOR_MODE("KEY_WORD_SEPARATOR_MODE");
const std::string RichText::KEY_HORIZONTAL_ALIGNMENT("KEY_HORIZONTAL_ALIGNMENT");
const std::string RichText::KEY_FONT_COLOR_STRING("KEY_FONT_COLOR_STRING");
const std::string RichText::KEY_FONT_SIZE("KEY_FONT_SIZE");
Expand Down Expand Up @@ -886,6 +887,7 @@ RichText::RichText()
{
_defaults[KEY_VERTICAL_SPACE] = 0.0f;
_defaults[KEY_WRAP_MODE] = static_cast<int>(WrapMode::WRAP_PER_WORD);
_defaults[KEY_WORD_SEPARATOR_MODE] = static_cast<int>(WordSeparatorMode::WordSeparatorBasedOnDevice);
_defaults[KEY_HORIZONTAL_ALIGNMENT] = static_cast<int>(HorizontalAlignment::LEFT);
_defaults[KEY_FONT_COLOR_STRING] = "#ffffff";
_defaults[KEY_FONT_SIZE] = 12.0f;
Expand Down Expand Up @@ -1007,6 +1009,20 @@ void RichText::setWrapMode(RichText::WrapMode wrapMode)
}
}

RichText::WordSeparatorMode RichText::getWordSeparatorMode()
{
return static_cast<RichText::WordSeparatorMode>(_defaults.at(KEY_WORD_SEPARATOR_MODE).asInt());
}

void RichText::setWordSeparatorMode(RichText::WordSeparatorMode wordSeparatorMode)
{
if (static_cast<RichText::WordSeparatorMode>(_defaults.at(KEY_WORD_SEPARATOR_MODE).asInt()) != wordSeparatorMode)
{
_defaults[KEY_WORD_SEPARATOR_MODE] = static_cast<int>(wordSeparatorMode);
_formatTextDirty = true;
}
}

RichText::HorizontalAlignment RichText::getHorizontalAlignment() const
{
return static_cast<RichText::HorizontalAlignment>(_defaults.at(KEY_HORIZONTAL_ALIGNMENT).asInt());
Expand Down Expand Up @@ -1223,6 +1239,9 @@ void RichText::setDefaults(const ValueMap& defaults)
}
if (defaults.find(KEY_WRAP_MODE) != defaults.end()) {
_defaults[KEY_WRAP_MODE] = defaults.at(KEY_WRAP_MODE).asInt();
}
if (defaults.find(KEY_WORD_SEPARATOR_MODE) != defaults.end()) {
_defaults[KEY_WORD_SEPARATOR_MODE] = defaults.at(KEY_WORD_SEPARATOR_MODE).asInt();
}
if (defaults.find(KEY_HORIZONTAL_ALIGNMENT) != defaults.end()) {
_defaults[KEY_HORIZONTAL_ALIGNMENT] = defaults.at(KEY_HORIZONTAL_ALIGNMENT).asInt();
Expand Down Expand Up @@ -1496,48 +1515,76 @@ void RichText::formatText()
}

namespace {

typedef bool (*FUNC_PTR_WRAPPABLE_WORD)(const StringUtils::StringUTF8::CharUTF8& ch);

inline bool isUTF8CharWrappable(const StringUtils::StringUTF8::CharUTF8& ch)
{
return (!ch.isASCII() || !std::isalnum(ch._char[0], std::locale()));
}

int getPrevWordPos(const StringUtils::StringUTF8& text, int idx)
inline bool isUTF8CharSpaceSlashNotHighUnicodeWrappable(const StringUtils::StringUTF8::CharUTF8& ch)
{
return ch._char.c_str()[0] == 32 || ch._char.c_str()[0] == 45; // space or '-'
}

inline bool isUTF8CharSpaceSlashAndKCJWrappable(const StringUtils::StringUTF8::CharUTF8& ch)
{
int len = strlen((char*) ch._char.c_str());
return ch._char.c_str()[0] == 32 || ch._char.c_str()[0] == 45 || len >= 3; // space or '-' or CJK Unified Ideographs (Chinese, Japanese, and Korean)
}

int getPrevWordPos(const StringUtils::StringUTF8& text, int idx, FUNC_PTR_WRAPPABLE_WORD func)
{
if (idx <= 0)
return -1;

// start from idx-1
const StringUtils::StringUTF8::CharUTF8Store& str = text.getString();
auto it = std::find_if(str.rbegin() + (str.size() - idx + 1), str.rend(), isUTF8CharWrappable);
auto it = std::find_if(str.rbegin() + (str.size() - idx + 1), str.rend(), func);
if (it == str.rend())
return -1;
return static_cast<int>(it.base() - str.begin());
}

int getNextWordPos(const StringUtils::StringUTF8& text, int idx)
int getNextWordPos(const StringUtils::StringUTF8& text, int idx, FUNC_PTR_WRAPPABLE_WORD func)
{
const StringUtils::StringUTF8::CharUTF8Store& str = text.getString();
if (idx + 1 >= static_cast<int>(str.size()))
return static_cast<int>(str.size());

auto it = std::find_if(str.begin() + idx + 1, str.end(), isUTF8CharWrappable);
auto it = std::find_if(str.begin() + idx + 1, str.end(), func);
return static_cast<int>(it - str.begin());
}

bool isWrappable(const StringUtils::StringUTF8& text)
bool isWrappable(const StringUtils::StringUTF8& text, FUNC_PTR_WRAPPABLE_WORD func)
{
const StringUtils::StringUTF8::CharUTF8Store& str = text.getString();
return std::any_of(str.begin(), str.end(), isUTF8CharWrappable);
return std::any_of(str.begin(), str.end(), func);
}

int findSplitPositionForWord(Label* label, const StringUtils::StringUTF8& text, int estimatedIdx, float originalLeftSpaceWidth, float newLineWidth)
int findSplitPositionForWord(Label* label, const StringUtils::StringUTF8& text, int estimatedIdx,
float originalLeftSpaceWidth, float newLineWidth, RichText::WordSeparatorMode wordSeparatorMode)
{
FUNC_PTR_WRAPPABLE_WORD charWrappableFunctionPointer = &isUTF8CharWrappable;
switch (wordSeparatorMode) {
case RichText::WordSeparatorSpaceSlashAndKCJ:
charWrappableFunctionPointer = &isUTF8CharSpaceSlashAndKCJWrappable;
break;
case RichText::WordSeparatorSpaceSlashNotHighUnicode:
charWrappableFunctionPointer = &isUTF8CharSpaceSlashNotHighUnicodeWrappable;
break;
case RichText::WordSeparatorBasedOnDevice:
charWrappableFunctionPointer = &isUTF8CharWrappable;
break;
}

bool startingNewLine = (newLineWidth == originalLeftSpaceWidth);
if (!isWrappable(text))
if (!isWrappable(text, charWrappableFunctionPointer))
return (startingNewLine ? static_cast<int>(text.length()) : 0);

// The adjustment of the new line position
int idx = getNextWordPos(text, estimatedIdx);
int idx = getNextWordPos(text, estimatedIdx, charWrappableFunctionPointer);
std::string leftStr = text.getAsCharSequence(0, idx);
label->setString(leftStr);
float textRendererWidth = label->getContentSize().width;
Expand All @@ -1546,7 +1593,7 @@ namespace {
while (1)
{
// try to erase a word
int newidx = getPrevWordPos(text, idx);
int newidx = getPrevWordPos(text, idx, charWrappableFunctionPointer);
if (newidx >= 0)
{
leftStr = text.getAsCharSequence(0, newidx);
Expand All @@ -1566,7 +1613,7 @@ namespace {
while (1)
{
// try to append a word
int newidx = getNextWordPos(text, idx);
int newidx = getNextWordPos(text, idx, charWrappableFunctionPointer);
leftStr = text.getAsCharSequence(0, newidx);
label->setString(leftStr);
textRendererWidth = label->getContentSize().width;
Expand Down Expand Up @@ -1646,6 +1693,7 @@ void RichText::handleTextRenderer(const std::string& text, const std::string& fo
{
bool fileExist = FileUtils::getInstance()->isFileExist(fontName);
RichText::WrapMode wrapMode = static_cast<RichText::WrapMode>(_defaults.at(KEY_WRAP_MODE).asInt());
RichText::WordSeparatorMode wordSeparatorMode = static_cast<RichText::WordSeparatorMode>(_defaults.at(KEY_WORD_SEPARATOR_MODE).asInt());

// split text by \n
std::stringstream ss(text);
Expand Down Expand Up @@ -1719,7 +1767,7 @@ void RichText::handleTextRenderer(const std::string& text, const std::string& fo

int leftLength = 0;
if (wrapMode == WRAP_PER_WORD)
leftLength = findSplitPositionForWord(textRenderer, utf8Text, estimatedIdx, _leftSpaceWidth, _customSize.width);
leftLength = findSplitPositionForWord(textRenderer, utf8Text, estimatedIdx, _leftSpaceWidth, _customSize.width, wordSeparatorMode);
else
leftLength = findSplitPositionForChar(textRenderer, utf8Text, estimatedIdx, _leftSpaceWidth, _customSize.width);

Expand Down
9 changes: 9 additions & 0 deletions cocos/ui/UIRichText.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,12 @@ class CC_GUI_DLL RichText : public Widget
WRAP_PER_WORD,
WRAP_PER_CHAR
};

enum WordSeparatorMode: int {
WordSeparatorBasedOnDevice, /*!< The wrapping will be compute based on the device setting */
WordSeparatorSpaceSlashNotHighUnicode, /*!< Spaces and '-' will be consider words separators. Recommended for Korean */
WordSeparatorSpaceSlashAndKCJ /*!< Spaces, '-' and KCJ unicodes will be consider words separators. */
};

enum class HorizontalAlignment {
LEFT,
Expand All @@ -372,6 +378,7 @@ class CC_GUI_DLL RichText : public Widget

static const std::string KEY_VERTICAL_SPACE; /*!< key of vertical space */
static const std::string KEY_WRAP_MODE; /*!< key of per word, or per char */
static const std::string KEY_WORD_SEPARATOR_MODE; /*!< key of word separator mode */
static const std::string KEY_HORIZONTAL_ALIGNMENT; /*!< key of left, right, or center */
static const std::string KEY_FONT_COLOR_STRING; /*!< key of font color */
static const std::string KEY_FONT_SIZE; /*!< key of font size */
Expand Down Expand Up @@ -486,6 +493,8 @@ class CC_GUI_DLL RichText : public Widget

void setWrapMode(WrapMode wrapMode); /*!< sets the wrapping mode: WRAP_PER_CHAR or WRAP_PER_WORD */
WrapMode getWrapMode() const; /*!< returns the current wrapping mode */
void setWordSeparatorMode(WordSeparatorMode wordSeparatorMode); /*!< sets the word separator mode */
WordSeparatorMode getWordSeparatorMode(); /*!< returns the current word separator mode */
void setHorizontalAlignment(HorizontalAlignment a); /*!< sets the horizontal alignment mode: LEFT, CENTER, or RIGHT */
HorizontalAlignment getHorizontalAlignment() const; /*!< returns the current horizontal alignment mode */
void setFontColor(const std::string& color); /*!< Set the font color. @param color the #RRGGBB hexadecimal notation. */
Expand Down
Loading