X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Fmarkup-processor-helper-functions.h;h=d7633182d19a3e3704240948dadb6015981253a8;hp=cf494d22297816a2f45d68bd20649740a4a43b6c;hb=528ee21711fc507b20ddb031cf6b1d71f1f44e75;hpb=69669144df0027a66725f167fd1b99e12b8860ad diff --git a/dali-toolkit/internal/text/markup-processor-helper-functions.h b/dali-toolkit/internal/text/markup-processor-helper-functions.h index cf494d2..d763318 100644 --- a/dali-toolkit/internal/text/markup-processor-helper-functions.h +++ b/dali-toolkit/internal/text/markup-processor-helper-functions.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H__ -#define __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H__ +#ifndef DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H +#define DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,16 +24,17 @@ // INTERNAL INCLUDES #include +#include namespace Dali { +struct Vector2; +struct Vector4; namespace Toolkit { - namespace Text { - /** * @brief Stores an attribute pair: name, value. */ @@ -41,20 +42,20 @@ struct Attribute { const char* nameBuffer; const char* valueBuffer; - Length nameLength; - Length valueLength; + Length nameLength; + Length valueLength; }; /** * @brief Stores a tag and its attributes. */ - struct Tag - { - Vector attributes; - const char* buffer; - Length length; - bool isEndTag; - }; +struct Tag +{ + Vector attributes; + const char* buffer; + Length length; + bool isEndTag; +}; /** * @brief Compare if two tokens are equal. @@ -71,16 +72,146 @@ struct Attribute * * @return @e true if both strings are equal. */ -bool TokenComparison( const std::string& string1, const char* const stringBuffer2, Length length ); +bool TokenComparison(const std::string& string1, const char* const stringBuffer2, Length length); /** * @brief Skips any unnecessary white space. * - * @param[in,out] markupStringBuffer The mark-up string buffer. It's a const iterator pointing the current character. - * @param[in] markupStringEndBuffer Pointer to one character after the end of the mark-up string buffer. + * @param[in,out] stringBuffer The string buffer. It's a const iterator pointing the current character. + * @param[in] stringEndBuffer Pointer to one character after the end of the string buffer. + */ +void SkipWhiteSpace(const char*& stringBuffer, + const char* const stringEndBuffer); + +/** + * @Brief Jumps to the next white space. + * + * @param[in,out] stringBuffer The string buffer. It's a const iterator pointing the current character. + * @param[in] stringEndBuffer Pointer to one character after the end of the string buffer. + */ +void JumpToWhiteSpace(const char*& stringBuffer, + const char* const stringEndBuffer); + +/** +* @brief Converts a string into an unsigned int. +* +* @param[in] uintStr An unsigned int packed inside a string. +* +* @return The unsigned int value. +*/ +unsigned int StringToUint(const char* const uintStr); + +/** + * @brief Converts a string into an hexadecimal unsigned int. + * + * @param[in] uintStr An hexadecimal unsigned int packed inside a string. + * + * @return The hexadecimal value. + */ +unsigned int StringToHex(const char* const uintStr); + +/** + * @brief Converts a string into a float value. + * + * @param[in] floatStr A float packed inside a string. + * + * @return The float value. + */ +float StringToFloat(const char* const floatStr); + +/** + * @brief Converts a float into a string. + * + * @param[in] value The float value. + * @param[out] floatStr The string. + */ +void FloatToString(float value, std::string& floatStr); + +/** + * @brief Converts an unsigned int into a string. + * + * @param[in] value The unsigned int value. + * @param[out] uIntStr The string. + */ +void UintToString(unsigned int value, std::string& uIntStr); + +/** + * @brief Converts an ARGB color packed in 4 byte unsigned int into a Vector4 color used in Dali. + * + * @param[in] color An ARGB color packed in an unsigned int. + * @param[out] retColor A Vector4 with the converted color. + */ +void UintColorToVector4(unsigned int color, Vector4& retColor); + +/** + * @brief Converts a color packed inside a string into an ARGB Vector4 color. + * + * The string color could be in hexadecimal ( 0xFF0000FF ), webcolor ( #0000FF or #00F ) or some constant values: + * black, white, red, green, blue, yellow, magenta, cyan or transparent. + * + * @param[in] colorStr A color packed inside a string. + * @param[in] length The length of the color string. + * @param[out] retColor A color packed inside a Vector4. + */ +void ColorStringToVector4(const char* const colorStr, Length length, Vector4& retColor); + +/** + * @brief Converts a color packed in a Vector4 into a string. + * + * Constant colors will be converted to the strings black, white, red, green, blue, yellow, magenta, cyan or transparent. + * + * If is not a constant color it will be converted to a string with hexadecimal ARGB content. + * + * @param[in] value The color value. + * @param[out] colorStr The string. + */ +void Vector4ToColorString(const Vector4& value, std::string& vector2Str); + +/** + * @brief Converts a two dimension vector packed inside a string into a Vector2. + * + * @param[in] vectorStr The two dimension vector packed inside a string. + * @param[in] length The length of the string. + * @param[out] vector2 The Vector2. + */ +void StringToVector2(const char* const vectorStr, Length length, Vector2& vector2); + +/** + * @brief Converts a Vector2 into a string. + * + * @param[in] value The vector2 value. + * @param[out] vector2Str The string. + */ +void Vector2ToString(const Vector2& value, std::string& vector2Str); + +/** + * @brief Converts a string into its value in the enum Text::Underline::Type. + * + * @param[in] typeStr The underline type value packed inside a string. + * @param[in] length The length of the string. + * @param[out] retType The Underline type. + */ +void UnderlineTypeStringToTypeValue(const char* const typeStr, Length length, Text::Underline::Type& retType); + +/** + * @brief Converts a string into a float value. + * + * @param[in] floatStr A float packed inside a string. + * + * @return The float value. + */ +float StringToFloat(const char* const floatStr); + +/** + * @brief Converts a string into its value in the enum Text::HorizontalAlignment::Type. + * + * @param[in] typeStr The horizontal-alignment type value packed inside a string. + * @param[in] length The length of the string. + * @param[out] retType The HorizontalAlignment type. + * + * @return Whether the value parsed or not. */ -void SkipWhiteSpace( const char*& markupStringBuffer, - const char* const markupStringEndBuffer ); +bool HorizontalAlignmentTypeStringToTypeValue(const char* const typeStr, Length length, Text::HorizontalAlignment::Type& retType); } // namespace Text @@ -88,4 +219,4 @@ void SkipWhiteSpace( const char*& markupStringBuffer, } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H__ +#endif // DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H