1 #ifndef DALI_TOOLKIT_CHARACTER_SET_CONVERSION_H
2 #define DALI_TOOLKIT_CHARACTER_SET_CONVERSION_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
35 * @brief Retrieves the number of bytes of a utf8 character.
37 * @param[in] utf8LeadByte The lead byte of the utf8 character.
39 * @return The number of bytes of the character.
41 uint8_t GetUtf8Length( uint8_t utf8LeadByte );
44 * @brief Retrieves the number of characters of the text array encoded in UTF8
46 * @param[in] utf8 The pointer to the UTF8 array.
47 * @param[in] length The length of the UTF8 array.
49 * @return The number of characters.
51 uint32_t GetNumberOfUtf8Characters( const uint8_t* const utf8, uint32_t length );
54 * @brief Retrieves the number of bytes needed to encode in UTF8 the given text array encoded in UTF32.
56 * @param[in] utf32 The pointer to the UTF32 array.
57 * @param[in] numberOfCharacters The number of characters of the UTF32 array.
59 * @return The number of bytes.
61 uint32_t GetNumberOfUtf8Bytes( const uint32_t* const utf32, uint32_t numberOfCharacters );
64 * @brief Converts a text array encoded in UTF8 into a text array encoded in UTF32.
66 * The @p utf32 buffer needs to be big enough to store all the characters.
68 * If the text contains a single 'CR' character or a pair 'CR'+'LF', they are replaced by a 'LF'.
70 * @note GetNumberOfUtf8Characters() does not convert 'CR' or 'CR'+'LF' to 'LF' so the return number
71 * of characters of that method may be higher than the number of characters returned by this one.
73 * @param[in] utf8 The pointer to the UTF8 array.
74 * @param[in] length The length of the UTF8 array.
75 * @param[out] utf32 The pointer to the UTF32 array.
77 * @return The number of characters.
79 uint32_t Utf8ToUtf32( const uint8_t* const utf8, uint32_t length, uint32_t* utf32 );
82 * @brief Converts a text array encoded in UTF32 into a text array encoded in UTF8.
84 * The @p utf8 buffer needs to be big enough to store all the characters.
86 * @param[in] utf32 The pointer to the UTF32 array.
87 * @param[in] numberOfCharacters The number of characters of the UTF32 array.
88 * @param[out] utf8 The pointer to the UTF8 array.
90 * @return The number of bytes.
92 uint32_t Utf32ToUtf8( const uint32_t* const utf32, uint32_t numberOfCharacters, uint8_t* utf8 );
95 * @brief Converts a text array encoded in UTF32 into a text array encoded in UTF8.
97 * @param[in] utf32 The pointer to the UTF32 array.
98 * @param[in] numberOfCharacters The number of characters of the UTF32 array.
99 * @param[out] utf8 The UTF8 characters will be stored here.
101 void Utf32ToUtf8( const uint32_t* const utf32, uint32_t numberOfCharacters, std::string& utf8 );
105 } // namespace Toolkit
109 #endif // DALI_TOOLKIT_CHARACTER_SET_CONVERSION_H