1 #ifndef __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H__
2 #define __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H__
5 * Copyright (c) 2015 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.
22 #include <dali/public-api/common/dali-vector.h>
26 #include <dali-toolkit/internal/text/text-definitions.h>
41 * @brief Stores an attribute pair: name, value.
45 const char* nameBuffer;
46 const char* valueBuffer;
52 * @brief Stores a tag and its attributes.
56 Vector<Attribute> attributes;
63 * @brief Compare if two tokens are equal.
65 * @pre @p string1 must be lower case. (The html-ish constant tokens)
66 * The @p stringBuffer2 parameter is transformed to lower case.
67 * This function is used in the mark-up parser.
68 * It has no sense to transform the constants html-ish tokens to lower case when
69 * it's known they already are.
71 * @param[in] string1 The html-ish constant token.
72 * @param[in] stringBuffer2 Pointer to the html-ish token buffer.
73 * @param[in] length The length of the html-ish token.
75 * @return @e true if both strings are equal.
77 bool TokenComparison( const std::string& string1, const char* const stringBuffer2, Length length );
80 * @brief Skips any unnecessary white space.
82 * @param[in,out] stringBuffer The string buffer. It's a const iterator pointing the current character.
83 * @param[in] stringEndBuffer Pointer to one character after the end of the string buffer.
85 void SkipWhiteSpace( const char*& stringBuffer,
86 const char* const stringEndBuffer );
89 * @Brief Jumps to the next white space.
91 * @param[in,out] stringBuffer The string buffer. It's a const iterator pointing the current character.
92 * @param[in] stringEndBuffer Pointer to one character after the end of the string buffer.
94 void JumpToWhiteSpace( const char*& stringBuffer,
95 const char* const stringEndBuffer );
98 * @brief Converts a string into an hexadecimal unsigned int.
100 * @param[in] uintStr An hexadecimal unsigned int packed inside a string.
102 * @return The hexadecimal value.
104 unsigned int StringToHex( const char* const uintStr );
107 * @brief Converts a string into a float value.
109 * @param[in] floatStr A float packed inside a string.
111 * @return The float value.
113 float StringToFloat( const char* const floatStr );
116 * @brief Converts a float into a string.
118 * @param[in] value The float value.
119 * @param[out] floatStr The string.
121 void FloatToString( float value, std::string& floatStr );
124 * @brief Converts an unsigned int into a string.
126 * @param[in] value The unsigned int value.
127 * @param[out] uIntStr The string.
129 void UintToString( unsigned int value, std::string& uIntStr );
132 * @brief Converts an ARGB color packed in 4 byte unsigned int into a Vector4 color used in Dali.
134 * @param[in] color An ARGB color packed in an unsigned int.
135 * @param[out] retColor A Vector4 with the converted color.
137 void UintColorToVector4( unsigned int color, Vector4& retColor );
140 * @brief Converts a color packed inside a string into an ARGB Vector4 color.
142 * The string color could be in hexadecimal ( 0xFF0000FF ), webcolor ( #0000FF or #00F ) or some constant values:
143 * black, white, red, green, blue, yellow, magenta, cyan or transparent.
145 * @param[in] colorStr A color packed inside a string.
146 * @param[in] length The length of the color string.
147 * @param[out] retColor A color packed inside a Vector4.
149 void ColorStringToVector4( const char* const colorStr, Length length, Vector4& retColor );
152 * @brief Converts a color packed in a Vector4 into a string.
154 * Constant colors will be converted to the strings black, white, red, green, blue, yellow, magenta, cyan or transparent.
156 * If is not a constant color it will be converted to a string with hexadecimal ARGB content.
158 * @param[in] value The color value.
159 * @param[out] colorStr The string.
161 void Vector4ToColorString( const Vector4& value, std::string& vector2Str );
164 * @brief Converts a two dimension vector packed inside a string into a Vector2.
166 * @param[in] vectorStr The two dimension vector packed inside a string.
167 * @param[in] length The length of the string.
168 * @param[out] vector2 The Vector2.
170 void StringToVector2( const char* const vectorStr, Length length, Vector2& vector2 );
173 * @brief Converts a Vector2 into a string.
175 * @param[in] value The vector2 value.
176 * @param[out] vector2Str The string.
178 void Vector2ToString( const Vector2& value, std::string& vector2Str );
182 } // namespace Toolkit
186 #endif // __DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H__