2 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 #include <dali/public-api/object/property-array.h>
21 #include <dali/public-api/object/property-map.h>
22 #include <dali/devel-api/adaptor-framework/color-controller.h>
25 #include <dali-toolkit/internal/builder/builder-impl.h>
26 #include <dali-toolkit/internal/builder/builder-get-is.inl.h>
27 #include <dali-toolkit/internal/builder/replacement.h>
40 * Set a property value from a tree node.
41 * This function guesses the type of the property from the format of the string in the node.
42 * This is not always possible and could be surprising.
43 * @param node The node string to convert from
44 * @param value The property value to set
45 * @return true if the string could be converted.
47 bool SetPropertyFromNode( const TreeNode& node, Property::Value& value );
50 * Set a property value from a tree node as SetPropertyFromNode() above
51 * @param node The node string to convert from
52 * @param value The property value to set
53 * @param replacement The overriding replacement map (if any)
54 * @return true if the string could be converted.
56 bool SetPropertyFromNode( const TreeNode& node, Property::Value& value,
57 const Replacement& replacement );
60 * Set a property value as the given type from a tree node.
61 * @param node The node string to convert from
62 * @param type The property type to convert to.
63 * @param value The property value to set
64 * @return true if the string could be converted to the correct type.
66 bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value );
69 * Set a property value as the given type from a tree node as SetPropertyFromNode() above
70 * @param node The node string to convert from
71 * @param type The property type to convert to.
72 * @param value The property value to set
73 * @param replacement The overriding replacement map (if any)
74 * @return true if the string could be converted to the correct type.
76 bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value,
77 const Replacement& replacement );
84 * Converts a HTML style 'color' hex string ("#FF0000" for bright red) to a Vector4.
85 * The Vector4 alpha component will be set to 1.0f
86 * @param hexString The HTML style hex string
87 * @return a Vector4 containing the new color value
89 Vector4 HexStringToVector4( const char* s )
91 unsigned int value(0u);
92 std::istringstream( s ) >> std::hex >> value;
93 return Vector4( ((value >> 16 ) & 0xff ) / 255.0f,
94 ((value >> 8 ) & 0xff ) / 255.0f,
95 (value & 0xff ) / 255.0f,
103 * A property value type can be forced when its unknown by a disambiguation convention in the json
104 * ie "myarray": [1,2,3,4] ; would be a vector but
105 * "myarray": {'type-cast':'array', 'value':[1,2,3,4]} would be an array
106 * @param child The node whos string to search for a disambiguated type
107 * @param value The value to set
108 * @param overrideMap The user overriding constant map
109 * @param defaultMap The default map.
110 * @return True if child contained a disambiguated string that could be converted.
112 bool Disambiguated(const TreeNode& child, // ConstantLut& constantLut,
113 Dali::Property::Value& value,
114 const Replacement& replacement )
116 OptionalString childType = IsString( IsChild(child, "type-cast") );
117 OptionalChild childValue = IsChild(child, "value");
119 if( childType && childValue && (2 == child.Size()) )
121 // this case allows disambiguation but normally the type is guessed
122 // 2 == child.count() is an extra check as the user could have a user dictionary/map with
123 // type-cast and value keys. If they do then a work around is to add a bogus key to not run this case.
124 if(*childType == "boolean")
126 return SetPropertyFromNode( *childValue, Dali::Property::BOOLEAN, value, replacement);
128 else if(*childType == "float")
130 return SetPropertyFromNode( *childValue, Dali::Property::FLOAT, value, replacement);
132 else if(*childType == "vector2")
134 return SetPropertyFromNode( *childValue, Dali::Property::VECTOR2, value, replacement);
136 else if(*childType == "vector3")
138 return SetPropertyFromNode( *childValue, Dali::Property::VECTOR3, value, replacement);
140 else if(*childType == "vector4")
142 return SetPropertyFromNode( *childValue, Dali::Property::VECTOR4, value, replacement);
144 else if(*childType == "rotation")
146 return SetPropertyFromNode( *childValue, Dali::Property::ROTATION, value, replacement);
148 else if(*childType == "rect")
150 return SetPropertyFromNode( *childValue, Dali::Property::RECTANGLE, value, replacement);
152 else if(*childType == "string")
154 return SetPropertyFromNode( *childValue, Dali::Property::STRING, value, replacement);
156 else if(*childType == "map")
158 return SetPropertyFromNode( *childValue, Dali::Property::MAP, value, replacement);
160 else if(*childType == "array")
162 return SetPropertyFromNode( *childValue, Dali::Property::ARRAY, value, replacement);
166 // else we failed to disambiguate
171 bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value)
173 Replacement noReplacement;
174 return SetPropertyFromNode( node, type, value, noReplacement );
177 bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value,
178 const Replacement& replacer )
184 case Property::BOOLEAN:
186 if( OptionalBoolean v = replacer.IsBoolean(node) )
193 case Property::FLOAT:
195 if( OptionalFloat v = replacer.IsFloat(node) )
202 case Property::INTEGER:
204 if( OptionalInteger v = replacer.IsInteger(node) )
211 case Property::UNSIGNED_INTEGER:
213 if( OptionalUnsignedInt v = replacer.IsUnsignedInteger( node) )
220 case Property::VECTOR2:
222 if( OptionalVector2 v = replacer.IsVector2(node) )
229 case Property::VECTOR3:
231 if( OptionalVector3 v = replacer.IsVector3(node) )
238 case Property::VECTOR4:
240 if( OptionalVector4 v = replacer.IsVector4(node) )
245 else if( OptionalString s = replacer.IsString(node) )
247 if( (*s)[0] == '#' && 7 == (*s).size() )
249 value = HexStringToVector4( &(*s)[1] );
252 else if( Dali::ColorController::Get() )
255 done = Dali::ColorController::Get().RetrieveColor( *s, color );
259 else if( TreeNode::OBJECT == node.GetType() )
261 // check for "r", "g" and "b" child color component nodes
262 OptionalInteger r = replacer.IsInteger( IsChild(node, "r") );
263 OptionalInteger g = replacer.IsInteger( IsChild(node, "g") );
264 OptionalInteger b = replacer.IsInteger( IsChild(node, "b") );
267 float red( (*r) * (1.0f/255.0f) );
268 float green( (*g) * (1.0f/255.0f) );
269 float blue( (*b) * (1.0f/255.0f) );
270 // check for optional "a" (alpha) node, default to fully opaque if it is not found.
272 OptionalInteger a = replacer.IsInteger( IsChild(node, "a") );
275 alpha = (*a) * (1.0f/255.0f);
277 value = Vector4( red, green, blue, alpha );
283 case Property::MATRIX3:
285 if( OptionalMatrix3 v = replacer.IsMatrix3(node) )
292 case Property::MATRIX:
294 if( OptionalMatrix v = replacer.IsMatrix(node) )
301 case Property::RECTANGLE:
303 if( OptionalRect v = replacer.IsRect(node) )
310 case Property::ROTATION:
314 if( OptionalVector4 ov = replacer.IsVector4(node) )
316 const Vector4& v = *ov;
317 // angle, axis as per spec
318 value = Quaternion(Radian(Degree(v[3])),
319 Vector3(v[0],v[1],v[2]));
325 // degrees Euler as per spec
326 if( OptionalVector3 v = replacer.IsVector3(node) )
328 value = Quaternion(Radian(Degree((*v).x)),
329 Radian(Degree((*v).y)),
330 Radian(Degree((*v).z)));
336 case Property::STRING:
338 if( OptionalString v = replacer.IsString(node) )
345 case Property::ARRAY:
347 if( replacer.IsArray( node, value ) )
353 value = Property::Value(Property::ARRAY);
354 Property::Array* array = value.GetArray();
356 TreeNode::ConstIterator iter(node.CBegin());
357 for( ; i < node.Size(); ++i, ++iter)
359 Property::Value childValue;
360 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
362 array->PushBack( childValue );
366 if( array->Count() == node.Size() )
379 if( replacer.IsMap( node, value ) )
385 value = Property::Value(Property::MAP);
386 Property::Map* map = value.GetMap();
388 TreeNode::ConstIterator iter(node.CBegin());
389 for( ; i < node.Size(); ++i, ++iter)
391 Property::Value childValue;
392 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
394 map->Insert( (*iter).first, childValue );
398 if( map->Count() == node.Size() )
418 bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
421 Replacement replacer;
422 return SetPropertyFromNode( node, value, replacer );
425 bool SetPropertyFromNode( const TreeNode& node, Property::Value& value,
426 const Replacement& replacer )
430 // some values are ambiguous as we have no Property::Type but can be disambiguated in the json
432 // Currently Rotations and Rectangle must always be disambiguated when a type isnt available
433 if( Disambiguated( node, value, replacer ) )
441 // our current heuristic for deciding an array is actually a vector and not say a map
442 // is to check if the values are all floats
443 bool allNumbers = true;
444 for(TreeConstIter iter = node.CBegin(); iter != node.CEnd(); ++iter)
446 OptionalFloat f = IsFloat((*iter).second);
456 // prefer finding vectors over presuming composite Property::Array...
457 if( OptionalMatrix v = IsMatrix(node) )
462 else if( OptionalMatrix3 v = IsMatrix3(node) )
467 else if( OptionalVector4 v = IsVector4(node) )
472 else if( OptionalVector3 v = IsVector3(node) )
477 else if( OptionalVector2 v = IsVector2(node) )
482 else if( 4 == node.Size() )
484 if( OptionalVector4 v = IsVector4(node) )
492 value = Property::Value(Property::ARRAY);
493 Property::Array* array = value.GetArray();
495 for(TreeConstIter iter = node.CBegin(); iter != node.CEnd(); ++iter)
497 Property::Value childValue;
498 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
500 array->PushBack( childValue );
509 // presume an array or map
510 // container of size 1
511 TreeNode::ConstIterator iter = node.CBegin();
513 // its seems legal with current json parser for a map to have an empty key
514 // but here we take that to mean the structure is a list
515 if( ((*iter).first) == 0 )
517 value = Property::Value(Property::ARRAY);
518 Property::Array* array = value.GetArray();
519 for(unsigned int i = 0; i < node.Size(); ++i, ++iter)
521 Property::Value childValue;
522 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
524 array->PushBack( childValue );
531 value = Property::Value(Property::MAP);
532 Property::Map* map = value.GetMap();
533 for(unsigned int i = 0; i < node.Size(); ++i, ++iter)
535 Property::Value childValue;
536 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
538 map->Insert( (*iter).first, childValue );
545 else // if( 0 == node.size() )
547 // no children so either one of bool, float, integer, string
548 OptionalBoolean aBool = replacer.IsBoolean(node);
549 OptionalInteger anInt = replacer.IsInteger(node);
550 OptionalFloat aFloat = replacer.IsFloat(node);
551 OptionalString aString = replacer.IsString(node);
555 // a bool is also an int but here we presume int
569 // Note: These are both floats and strings
572 // This means we can't have a string with purely numeric content without disambiguation.
585 // string always succeeds with the current json parser so its last
592 } // if( node.size() )
594 } // if Disambiguated()
597 } // bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
600 } // namespace Internal
602 } // namespace Toolkit