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::VECTOR2:
213 if( OptionalVector2 v = replacer.IsVector2(node) )
220 case Property::VECTOR3:
222 if( OptionalVector3 v = replacer.IsVector3(node) )
229 case Property::VECTOR4:
231 if( OptionalVector4 v = replacer.IsVector4(node) )
236 else if( OptionalString s = replacer.IsString(node) )
238 if( (*s)[0] == '#' && 7 == (*s).size() )
240 value = HexStringToVector4( &(*s)[1] );
243 else if( Dali::ColorController::Get() )
246 done = Dali::ColorController::Get().RetrieveColor( *s, color );
250 else if( TreeNode::OBJECT == node.GetType() )
252 // check for "r", "g" and "b" child color component nodes
253 OptionalInteger r = replacer.IsInteger( IsChild(node, "r") );
254 OptionalInteger g = replacer.IsInteger( IsChild(node, "g") );
255 OptionalInteger b = replacer.IsInteger( IsChild(node, "b") );
258 float red( (*r) * (1.0f/255.0f) );
259 float green( (*g) * (1.0f/255.0f) );
260 float blue( (*b) * (1.0f/255.0f) );
261 // check for optional "a" (alpha) node, default to fully opaque if it is not found.
263 OptionalInteger a = replacer.IsInteger( IsChild(node, "a") );
266 alpha = (*a) * (1.0f/255.0f);
268 value = Vector4( red, green, blue, alpha );
274 case Property::MATRIX3:
276 if( OptionalMatrix3 v = replacer.IsMatrix3(node) )
283 case Property::MATRIX:
285 if( OptionalMatrix v = replacer.IsMatrix(node) )
292 case Property::RECTANGLE:
294 if( OptionalRect v = replacer.IsRect(node) )
301 case Property::ROTATION:
305 if( OptionalVector4 ov = replacer.IsVector4(node) )
307 const Vector4& v = *ov;
308 // angle, axis as per spec
309 value = Quaternion(Radian(Degree(v[3])),
310 Vector3(v[0],v[1],v[2]));
316 // degrees Euler as per spec
317 if( OptionalVector3 v = replacer.IsVector3(node) )
319 value = Quaternion(Radian(Degree((*v).x)),
320 Radian(Degree((*v).y)),
321 Radian(Degree((*v).z)));
327 case Property::STRING:
329 if( OptionalString v = replacer.IsString(node) )
336 case Property::ARRAY:
338 if( replacer.IsArray( node, value ) )
344 value = Property::Value(Property::ARRAY);
345 Property::Array* array = value.GetArray();
347 TreeNode::ConstIterator iter(node.CBegin());
348 for( ; i < node.Size(); ++i, ++iter)
350 Property::Value childValue;
351 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
353 array->PushBack( childValue );
357 if( array->Count() == node.Size() )
370 if( replacer.IsMap( node, value ) )
376 value = Property::Value(Property::MAP);
377 Property::Map* map = value.GetMap();
379 TreeNode::ConstIterator iter(node.CBegin());
380 for( ; i < node.Size(); ++i, ++iter)
382 Property::Value childValue;
383 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
385 map->Insert( (*iter).first, childValue );
389 if( map->Count() == node.Size() )
409 bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
412 Replacement replacer;
413 return SetPropertyFromNode( node, value, replacer );
416 bool SetPropertyFromNode( const TreeNode& node, Property::Value& value,
417 const Replacement& replacer )
421 // some values are ambiguous as we have no Property::Type but can be disambiguated in the json
423 // Currently Rotations and Rectangle must always be disambiguated when a type isnt available
424 if( Disambiguated( node, value, replacer ) )
432 // our current heuristic for deciding an array is actually a vector and not say a map
433 // is to check if the values are all floats
434 bool allNumbers = true;
435 for(TreeConstIter iter = node.CBegin(); iter != node.CEnd(); ++iter)
437 OptionalFloat f = IsFloat((*iter).second);
447 // prefer finding vectors over presuming composite Property::Array...
448 if( OptionalMatrix v = IsMatrix(node) )
453 else if( OptionalMatrix3 v = IsMatrix3(node) )
458 else if( OptionalVector4 v = IsVector4(node) )
463 else if( OptionalVector3 v = IsVector3(node) )
468 else if( OptionalVector2 v = IsVector2(node) )
473 else if( 4 == node.Size() )
475 if( OptionalVector4 v = IsVector4(node) )
483 value = Property::Value(Property::ARRAY);
484 Property::Array* array = value.GetArray();
486 for(TreeConstIter iter = node.CBegin(); iter != node.CEnd(); ++iter)
488 Property::Value childValue;
489 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
491 array->PushBack( childValue );
500 // presume an array or map
501 // container of size 1
502 TreeNode::ConstIterator iter = node.CBegin();
504 // its seems legal with current json parser for a map to have an empty key
505 // but here we take that to mean the structure is a list
506 if( ((*iter).first) == 0 )
508 value = Property::Value(Property::ARRAY);
509 Property::Array* array = value.GetArray();
510 for(unsigned int i = 0; i < node.Size(); ++i, ++iter)
512 Property::Value childValue;
513 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
515 array->PushBack( childValue );
522 value = Property::Value(Property::MAP);
523 Property::Map* map = value.GetMap();
524 for(unsigned int i = 0; i < node.Size(); ++i, ++iter)
526 Property::Value childValue;
527 if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
529 map->Insert( (*iter).first, childValue );
536 else // if( 0 == node.size() )
538 // no children so either one of bool, float, integer, string
539 OptionalBoolean aBool = replacer.IsBoolean(node);
540 OptionalInteger anInt = replacer.IsInteger(node);
541 OptionalFloat aFloat = replacer.IsFloat(node);
542 OptionalString aString = replacer.IsString(node);
546 // a bool is also an int but here we presume int
560 // Note: These are both floats and strings
563 // This means we can't have a string with purely numeric content without disambiguation.
576 // string always succeeds with the current json parser so its last
583 } // if( node.size() )
585 } // if Disambiguated()
588 } // bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
591 } // namespace Internal
593 } // namespace Toolkit