1 #ifndef DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H
2 #define DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H
5 * Copyright (c) 2021 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>
38 * @brief Stores an attribute pair: name, value.
42 const char* nameBuffer;
43 const char* valueBuffer;
49 * @brief Stores a tag and its attributes.
53 Vector<Attribute> attributes;
60 * @brief Compare if two tokens are equal.
62 * @pre @p string1 must be lower case. (The html-ish constant tokens)
63 * The @p stringBuffer2 parameter is transformed to lower case.
64 * This function is used in the mark-up parser.
65 * It has no sense to transform the constants html-ish tokens to lower case when
66 * it's known they already are.
68 * @param[in] string1 The html-ish constant token.
69 * @param[in] stringBuffer2 Pointer to the html-ish token buffer.
70 * @param[in] length The length of the html-ish token.
72 * @return @e true if both strings are equal.
74 bool TokenComparison(const std::string& string1, const char* const stringBuffer2, Length length);
77 * @brief Skips any unnecessary white space.
79 * @param[in,out] stringBuffer The string buffer. It's a const iterator pointing the current character.
80 * @param[in] stringEndBuffer Pointer to one character after the end of the string buffer.
82 void SkipWhiteSpace(const char*& stringBuffer,
83 const char* const stringEndBuffer);
86 * @Brief Jumps to the next white space.
88 * @param[in,out] stringBuffer The string buffer. It's a const iterator pointing the current character.
89 * @param[in] stringEndBuffer Pointer to one character after the end of the string buffer.
91 void JumpToWhiteSpace(const char*& stringBuffer,
92 const char* const stringEndBuffer);
95 * @brief Converts a string into an unsigned int.
97 * @param[in] uintStr An unsigned int packed inside a string.
99 * @return The unsigned int value.
101 unsigned int StringToUint(const char* const uintStr);
104 * @brief Converts a string into an hexadecimal unsigned int.
106 * @param[in] uintStr An hexadecimal unsigned int packed inside a string.
108 * @return The hexadecimal value.
110 unsigned int StringToHex(const char* const uintStr);
113 * @brief Converts a string into a float value.
115 * @param[in] floatStr A float packed inside a string.
117 * @return The float value.
119 float StringToFloat(const char* const floatStr);
122 * @brief Converts a float into a string.
124 * @param[in] value The float value.
125 * @param[out] floatStr The string.
127 void FloatToString(float value, std::string& floatStr);
130 * @brief Converts an unsigned int into a string.
132 * @param[in] value The unsigned int value.
133 * @param[out] uIntStr The string.
135 void UintToString(unsigned int value, std::string& uIntStr);
138 * @brief Converts an ARGB color packed in 4 byte unsigned int into a Vector4 color used in Dali.
140 * @param[in] color An ARGB color packed in an unsigned int.
141 * @param[out] retColor A Vector4 with the converted color.
143 void UintColorToVector4(unsigned int color, Vector4& retColor);
146 * @brief Converts a color packed inside a string into an ARGB Vector4 color.
148 * The string color could be in hexadecimal ( 0xFF0000FF ), webcolor ( #0000FF or #00F ) or some constant values:
149 * black, white, red, green, blue, yellow, magenta, cyan or transparent.
151 * @param[in] colorStr A color packed inside a string.
152 * @param[in] length The length of the color string.
153 * @param[out] retColor A color packed inside a Vector4.
155 void ColorStringToVector4(const char* const colorStr, Length length, Vector4& retColor);
158 * @brief Converts a color packed in a Vector4 into a string.
160 * Constant colors will be converted to the strings black, white, red, green, blue, yellow, magenta, cyan or transparent.
162 * If is not a constant color it will be converted to a string with hexadecimal ARGB content.
164 * @param[in] value The color value.
165 * @param[out] colorStr The string.
167 void Vector4ToColorString(const Vector4& value, std::string& vector2Str);
170 * @brief Converts a two dimension vector packed inside a string into a Vector2.
172 * @param[in] vectorStr The two dimension vector packed inside a string.
173 * @param[in] length The length of the string.
174 * @param[out] vector2 The Vector2.
176 void StringToVector2(const char* const vectorStr, Length length, Vector2& vector2);
179 * @brief Converts a Vector2 into a string.
181 * @param[in] value The vector2 value.
182 * @param[out] vector2Str The string.
184 void Vector2ToString(const Vector2& value, std::string& vector2Str);
188 } // namespace Toolkit
192 #endif // DALI_TOOLKIT_TEXT_MARKUP_PROCESSOR_HELPER_FUNCTIONS_H