mirror of
https://github.com/cocos/cocos-engine.git
synced 2026-09-09 17:20:33 +08:00
218 lines
7.0 KiB
C++
218 lines
7.0 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2014 cocos2d-x.org
|
|
Copyright (c) 2014-2016 Chukong Technologies Inc.
|
|
Copyright (c) 2017-2022 Xiamen Yaji Software Co., Ltd.
|
|
|
|
http://www.cocos.com
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated engine source code (the "Software"), a limited,
|
|
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
|
|
to use Cocos Creator solely to develop games on your target platforms. You shall
|
|
not use Cocos Creator software for developing other software or tools that's
|
|
used for developing games. You are not granted to publish, distribute,
|
|
sublicense, and/or sell copies of Cocos Creator.
|
|
|
|
The software or tools in this License Agreement are licensed, not sold.
|
|
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include <sstream>
|
|
#include <string>
|
|
#include <vector>
|
|
#include "base/Macros.h"
|
|
|
|
#if (CC_PLATFORM == CC_PLATFORM_ANDROID || CC_PLATFORM == CC_PLATFORM_OHOS)
|
|
#include "platform/java/jni/JniHelper.h"
|
|
#endif
|
|
|
|
namespace cc {
|
|
|
|
namespace StringUtils { //NOLINT
|
|
|
|
template <typename T>
|
|
std::string toString(T arg) {
|
|
std::stringstream ss;
|
|
ss << arg;
|
|
return ss.str();
|
|
}
|
|
|
|
std::string CC_DLL format(const char *format, ...) CC_FORMAT_PRINTF(1, 2);
|
|
|
|
/**
|
|
* @brief Converts from UTF8 string to UTF16 string.
|
|
*
|
|
* This function resizes \p outUtf16 to required size and
|
|
* fill its contents with result UTF16 string if conversion success.
|
|
* If conversion fails it guarantees not to change \p outUtf16.
|
|
*
|
|
* @param inUtf8 The source UTF8 string to be converted from.
|
|
* @param outUtf16 The output string to hold the result UTF16s.
|
|
* @return True if succeed, otherwise false.
|
|
* @note Please check the return value before using \p outUtf16
|
|
* e.g.
|
|
* @code
|
|
* std::u16string utf16;
|
|
* bool ret = StringUtils::UTF8ToUTF16("你好hello", utf16);
|
|
* if (ret) {
|
|
* do_some_thing_with_utf16(utf16);
|
|
* }
|
|
* @endcode
|
|
*/
|
|
CC_DLL bool UTF8ToUTF16(const std::string &inUtf8, std::u16string &outUtf16); //NOLINT
|
|
|
|
/**
|
|
* @brief Same as \a UTF8ToUTF16 but converts form UTF8 to UTF32.
|
|
*
|
|
* @see UTF8ToUTF16
|
|
*/
|
|
CC_DLL bool UTF8ToUTF32(const std::string &inUtf8, std::u32string &outUtf32); //NOLINT
|
|
|
|
/**
|
|
* @brief Same as \a UTF8ToUTF16 but converts form UTF16 to UTF8.
|
|
*
|
|
* @see UTF8ToUTF16
|
|
*/
|
|
CC_DLL bool UTF16ToUTF8(const std::u16string &inUtf16, std::string &outUtf8); //NOLINT
|
|
|
|
/**
|
|
* @brief Same as \a UTF8ToUTF16 but converts form UTF16 to UTF32.
|
|
*
|
|
* @see UTF8ToUTF16
|
|
*/
|
|
CC_DLL bool UTF16ToUTF32(const std::u16string &inUtf16, std::u32string &outUtf32); //NOLINT
|
|
|
|
/**
|
|
* @brief Same as \a UTF8ToUTF16 but converts form UTF32 to UTF8.
|
|
*
|
|
* @see UTF8ToUTF16
|
|
*/
|
|
CC_DLL bool UTF32ToUTF8(const std::u32string &inUtf32, std::string &outUtf8); //NOLINT
|
|
|
|
/**
|
|
* @brief Same as \a UTF8ToUTF16 but converts form UTF32 to UTF16.
|
|
*
|
|
* @see UTF8ToUTF16
|
|
*/
|
|
CC_DLL bool UTF32ToUTF16(const std::u32string &inUtf32, std::u16string &outUtf16); //NOLINT
|
|
|
|
/**
|
|
* @brief Skip some bad char code.
|
|
*/
|
|
CC_DLL void UTF8LooseFix(const std::string &in, std::string &out); //NOLINT
|
|
|
|
#if (CC_PLATFORM == CC_PLATFORM_ANDROID || CC_PLATFORM == CC_PLATFORM_OHOS)
|
|
|
|
/**
|
|
* @brief convert jstring to utf8 std::string, same function with env->getStringUTFChars.
|
|
* because getStringUTFChars can not pass special emoticon
|
|
* @param env The JNI Env
|
|
* @param srcjStr The jstring which want to convert
|
|
* @param ret True if the conversion succeeds and the ret pointer isn't null
|
|
* @returns the result of utf8 string
|
|
*/
|
|
CC_DLL std::string getStringUTFCharsJNI(JNIEnv *env, jstring srcjStr, bool *ret = nullptr);
|
|
|
|
/**
|
|
* @brief create a jstring with utf8 std::string, same function with env->newStringUTF
|
|
* because newStringUTF can not convert special emoticon
|
|
* @param env The JNI Env
|
|
* @param srcjStr The std::string which want to convert
|
|
* @param ret True if the conversion succeeds and the ret pointer isn't null
|
|
* @returns the result of jstring,the jstring need to DeleteLocalRef(jstring);
|
|
*/
|
|
CC_DLL jstring newStringUTFJNI(JNIEnv *env, const std::string &utf8Str, bool *ret = nullptr);
|
|
#endif
|
|
|
|
/**
|
|
* @brief Trims the unicode spaces at the end of char16_t vector.
|
|
*/
|
|
CC_DLL void trimUTF16Vector(std::vector<char16_t> &str); //NOLINT
|
|
|
|
/**
|
|
* @brief Whether the character is a whitespace character.
|
|
* @param ch The unicode character.
|
|
* @returns Whether the character is a white space character.
|
|
*
|
|
* @see http://en.wikipedia.org/wiki/Whitespace_character#Unicode
|
|
*
|
|
*/
|
|
CC_DLL bool isUnicodeSpace(char16_t ch);
|
|
|
|
/**
|
|
* @brief Whether the character is a Chinese/Japanese/Korean character.
|
|
* @param ch The unicode character.
|
|
* @returns Whether the character is a Chinese character.
|
|
*
|
|
* @see http://www.searchtb.com/2012/04/chinese_encode.html
|
|
* @see http://tieba.baidu.com/p/748765987
|
|
*
|
|
*/
|
|
CC_DLL bool isCJKUnicode(char16_t ch);
|
|
|
|
/**
|
|
* @brief Returns the length of the string in characters.
|
|
* @param utf8 An UTF-8 encoded string.
|
|
* @returns The length of the string in characters.
|
|
*/
|
|
CC_DLL long getCharacterCountInUTF8String(const std::string &utf8); //NOLINT
|
|
|
|
/**
|
|
* @brief Gets the index of the last character that is not equal to the character given.
|
|
* @param str The string to be searched.
|
|
* @param c The character to be searched for.
|
|
* @returns The index of the last character that is not \p c.
|
|
*/
|
|
CC_DLL unsigned int getIndexOfLastNotChar16(const std::vector<char16_t> &str, char16_t c);
|
|
|
|
/**
|
|
* @brief Gets char16_t vector from a given utf16 string.
|
|
*/
|
|
CC_DLL std::vector<char16_t> getChar16VectorFromUTF16String(const std::u16string &utf16);
|
|
|
|
/**
|
|
* Utf8 sequence
|
|
* Store all utf8 chars as std::string
|
|
* Build from std::string
|
|
*/
|
|
class CC_DLL StringUTF8 {
|
|
public:
|
|
struct CharUTF8 {
|
|
std::string _char;
|
|
bool isAnsi() { return _char.size() == 1; }
|
|
};
|
|
using CharUTF8Store = std::vector<CharUTF8>;
|
|
|
|
StringUTF8() = default;
|
|
explicit StringUTF8(const std::string &newStr);
|
|
~StringUTF8() = default;
|
|
|
|
std::size_t length() const;
|
|
void replace(const std::string &newStr);
|
|
|
|
std::string getAsCharSequence() const;
|
|
|
|
bool deleteChar(std::size_t pos);
|
|
bool insert(std::size_t pos, const std::string &insertStr);
|
|
bool insert(std::size_t pos, const StringUTF8 &insertStr);
|
|
|
|
CharUTF8Store &getString() { return _str; }
|
|
|
|
private:
|
|
CharUTF8Store _str;
|
|
};
|
|
|
|
} // namespace StringUtils
|
|
|
|
} // namespace cc
|