dali-toolkit/internal/text/character-set-conversion.h

   1 #ifndef __DALI_TOOLKIT_CHARACTER_SET_CONVERSION_H__
   2 #define __DALI_TOOLKIT_CHARACTER_SET_CONVERSION_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <stdint.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/common/dali-common.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 /**
  34  * @brief Retrieves the number of characters of the text array encoded in UTF8
  35  *
  36  * @param[in] utf8 The pointer to the UTF8 array.
  37  * @param[in] length The length of the UTF8 array.
  38  *
  39  * @return The number of characters.
  40  */
  41 DALI_IMPORT_API uint32_t GetNumberOfUtf8Characters( const uint8_t* const utf8, uint32_t length );
  42
  43 /**
  44  * @brief Retrieves the number of bytes needed to encode in UTF8 the given text array encoded in UTF32.
  45  *
  46  * @param[in] utf32 The pointer to the UTF32 array.
  47  * @param[in] numberOfCharacters The number of characters of the UTF32 array.
  48  *
  49  * @return The number of bytes.
  50  */
  51 DALI_IMPORT_API uint32_t GetNumberOfUtf8Bytes( const uint32_t* const utf32, uint32_t numberOfCharacters );
  52
  53 /**
  54  * @brief Converts a text array encoded in UTF8 into a text array encoded in UTF32.
  55  *
  56  * The @p utf32 buffer needs to be big enough to store all the characters.
  57  *
  58  * @param[in] utf8 The pointer to the UTF8 array.
  59  * @param[in] length The length of the UTF8 array.
  60  * @param[out] utf32 The pointer to the UTF32 array.
  61  *
  62  * @return The number of characters.
  63  */
  64 DALI_IMPORT_API uint32_t Utf8ToUtf32( const uint8_t* const utf8, uint32_t length, uint32_t* utf32 );
  65
  66 /**
  67  * @brief Converts a text array encoded in UTF32 into a text array encoded in UTF8.
  68  *
  69  * The @p utf8 buffer needs to be big enough to store all the characters.
  70  *
  71  * @param[in] utf32 The pointer to the UTF32 array.
  72  * @param[in] numberOfCharacters The number of characters of the UTF32 array.
  73  * @param[out] utf8 The pointer to the UTF8 array.
  74  *
  75  * @return The number of bytes.
  76  */
  77 DALI_IMPORT_API uint32_t Utf32ToUtf8( const uint32_t* const utf32, uint32_t numberOfCharacters, uint8_t* utf8 );
  78
  79 } // namespace Toolkit
  80
  81 } // namespace Dali
  82
  83 #endif // __DALI_TOOLKIT_CHARACTER_SET_CONVERSION_H__