Changed all property & signal names to lowerCamelCase
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / builder / builder-set-property.cpp
index 5b079bb..7cd45b6 100644 (file)
@@ -1,22 +1,31 @@
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2015 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// EXTERNAL INCLUDES
+#include <sstream>
+#include <dali/public-api/object/property-array.h>
+#include <dali/public-api/object/property-map.h>
+#include <dali/devel-api/adaptor-framework/color-controller.h>
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/internal/builder/builder-impl.h>
 #include <dali-toolkit/internal/builder/builder-get-is.inl.h>
+#include <dali-toolkit/internal/builder/replacement.h>
+
 
 namespace Dali
 {
@@ -38,6 +47,16 @@ namespace Internal
 bool SetPropertyFromNode( const TreeNode& node, Property::Value& value );
 
 /*
+ * Set a property value from a tree node as SetPropertyFromNode() above
+ * @param node  The node string to convert from
+ * @param value The property value to set
+ * @param replacement The overriding replacement map (if any)
+ * @return true if the string could be converted.
+ */
+bool SetPropertyFromNode( const TreeNode& node, Property::Value& value,
+                          const Replacement& replacement );
+
+/*
  * Set a property value as the given type from a tree node.
  * @param node The node string to convert from
  * @param type The property type to convert to.
@@ -46,18 +65,55 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Value& value );
  */
 bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value );
 
+/*
+ * Set a property value as the given type from a tree node as SetPropertyFromNode() above
+ * @param node The node string to convert from
+ * @param type The property type to convert to.
+ * @param value The property value to set
+ * @param replacement The overriding replacement map (if any)
+ * @return true if the string could be converted to the correct type.
+ */
+bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value,
+                          const Replacement& replacement );
+
+
+namespace
+{
+
+/**
+ * Converts a HTML style 'color' hex string ("#FF0000" for bright red) to a Vector4.
+ * The Vector4 alpha component will be set to 1.0f
+ * @param hexString The HTML style hex string
+ * @return a Vector4 containing the new color value
+ */
+Vector4 HexStringToVector4( const char* s )
+{
+  unsigned int value(0u);
+  std::istringstream( s ) >> std::hex >> value;
+  return Vector4( ((value >> 16 ) & 0xff ) / 255.0f,
+                  ((value >> 8 ) & 0xff ) / 255.0f,
+                  (value & 0xff ) / 255.0f,
+                  1.0f );
+}
+
+} // anon namespace
+
+
 /**
  * A property value type can be forced when its unknown by a disambiguation convention in the json
  * ie  "myarray": [1,2,3,4] ; would be a vector but
- *     "myarray": {'type-cast':'array', 'value':[1,2,3,4]} would be an array
+ *     "myarray": {"typeCast":"array", "value":[1,2,3,4]} would be an array
  * @param child The node whos string to search for a disambiguated type
  * @param value The value to set
+ * @param overrideMap The user overriding constant map
+ * @param defaultMap The default map.
  * @return True if child contained a disambiguated string that could be converted.
  */
 bool Disambiguated(const TreeNode& child, // ConstantLut& constantLut,
-                   Dali::Property::Value& value)
+                   Dali::Property::Value& value,
+                   const Replacement& replacement )
 {
-  OptionalString childType = IsString( IsChild(child, "type-cast") );
+  OptionalString childType = IsString( IsChild(child, "typeCast") );
   OptionalChild childValue = IsChild(child, "value");
 
   if( childType && childValue && (2 == child.Size()) )
@@ -67,43 +123,43 @@ bool Disambiguated(const TreeNode& child, // ConstantLut& constantLut,
     // type-cast and value keys. If they do then a work around is to add a bogus key to not run this case.
     if(*childType == "boolean")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::BOOLEAN, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::BOOLEAN, value, replacement);
     }
     else if(*childType == "float")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::FLOAT, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::FLOAT, value, replacement);
     }
     else if(*childType == "vector2")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::VECTOR2, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::VECTOR2, value, replacement);
     }
     else if(*childType == "vector3")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::VECTOR3, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::VECTOR3, value, replacement);
     }
     else if(*childType == "vector4")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::VECTOR4, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::VECTOR4, value, replacement);
     }
     else if(*childType == "rotation")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::ROTATION, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::ROTATION, value, replacement);
     }
     else if(*childType == "rect")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::RECTANGLE, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::RECTANGLE, value, replacement);
     }
     else if(*childType == "string")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::STRING, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::STRING, value, replacement);
     }
     else if(*childType == "map")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::MAP, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::MAP, value, replacement);
     }
     else if(*childType == "array")
     {
-      return SetPropertyFromNode( *childValue, Dali::Property::ARRAY, value);
+      return SetPropertyFromNode( *childValue, Dali::Property::ARRAY, value, replacement);
     }
   }
 
@@ -111,7 +167,15 @@ bool Disambiguated(const TreeNode& child, // ConstantLut& constantLut,
   return false;
 }
 
-bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value )
+
+bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value)
+{
+  Replacement noReplacement;
+  return SetPropertyFromNode( node, type, value, noReplacement );
+}
+
+bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::Value& value,
+                          const Replacement& replacer )
 {
   bool done = false;
 
@@ -119,7 +183,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
   {
     case Property::BOOLEAN:
     {
-      if( OptionalBoolean v = IsBoolean(node) )
+      if( OptionalBoolean v = replacer.IsBoolean(node) )
       {
         value = *v;
         done = true;
@@ -128,7 +192,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     }
     case Property::FLOAT:
     {
-      if( OptionalFloat v = IsFloat(node) )
+      if( OptionalFloat v = replacer.IsFloat(node) )
       {
         value = *v;
         done = true;
@@ -137,28 +201,16 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     }
     case Property::INTEGER:
     {
-      if( OptionalInteger v = IsInteger(node) )
+      if( OptionalInteger v = replacer.IsInteger(node) )
       {
         value = *v;
         done = true;
       }
       break;
     }
-    case Property::UNSIGNED_INTEGER:
-    {
-      if( OptionalInteger v = IsInteger(node) )
-      {
-        if( *v >= 0 ) // with a loss of resolution....
-        {
-          value = *v;
-          done = true;
-        }
-      }
-      break;
-    }
     case Property::VECTOR2:
     {
-      if( OptionalVector2 v = IsVector2(node) )
+      if( OptionalVector2 v = replacer.IsVector2(node) )
       {
         value = *v;
         done = true;
@@ -167,7 +219,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     }
     case Property::VECTOR3:
     {
-      if( OptionalVector3 v = IsVector3(node) )
+      if( OptionalVector3 v = replacer.IsVector3(node) )
       {
         value = *v;
         done = true;
@@ -176,16 +228,52 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     }
     case Property::VECTOR4:
     {
-      if( OptionalVector4 v = IsVector4(node) )
+      if( OptionalVector4 v = replacer.IsVector4(node) )
       {
         value = *v;
         done = true;
-       }
+      }
+      else if( OptionalString s = replacer.IsString(node) )
+      {
+        if( (*s)[0] == '#' && 7 == (*s).size() )
+        {
+          value = HexStringToVector4( &(*s)[1] );
+          done = true;
+        }
+        else if( Dali::ColorController::Get() )
+        {
+          Vector4 color;
+          done = Dali::ColorController::Get().RetrieveColor( *s, color );
+          value = color;
+        }
+      }
+      else if( TreeNode::OBJECT == node.GetType() )
+      {
+        // check for "r", "g" and "b" child color component nodes
+        OptionalInteger r = replacer.IsInteger( IsChild(node, "r") );
+        OptionalInteger g = replacer.IsInteger( IsChild(node, "g") );
+        OptionalInteger b = replacer.IsInteger( IsChild(node, "b") );
+        if( r && g && b )
+        {
+          float red( (*r) * (1.0f/255.0f) );
+          float green( (*g) * (1.0f/255.0f) );
+          float blue( (*b) * (1.0f/255.0f) );
+          // check for optional "a" (alpha) node, default to fully opaque if it is not found.
+          float alpha( 1.0f );
+          OptionalInteger a = replacer.IsInteger( IsChild(node, "a") );
+          if( a )
+          {
+            alpha = (*a) * (1.0f/255.0f);
+          }
+          value = Vector4( red, green, blue, alpha );
+          done = true;
+        }
+      }
       break;
     }
     case Property::MATRIX3:
     {
-      if( OptionalMatrix3 v = IsMatrix3(node) )
+      if( OptionalMatrix3 v = replacer.IsMatrix3(node) )
       {
         value = *v;
         done = true;
@@ -194,7 +282,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     }
     case Property::MATRIX:
     {
-      if( OptionalMatrix v = IsMatrix(node) )
+      if( OptionalMatrix v = replacer.IsMatrix(node) )
       {
         value = *v;
         done = true;
@@ -203,7 +291,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     }
     case Property::RECTANGLE:
     {
-      if( OptionalRect v = IsRect(node) )
+      if( OptionalRect v = replacer.IsRect(node) )
       {
         value = *v;
         done = true;
@@ -214,7 +302,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     {
       if(4 == node.Size())
       {
-        if( OptionalVector4 ov = IsVector4(node) )
+        if( OptionalVector4 ov = replacer.IsVector4(node) )
         {
           const Vector4& v = *ov;
           // angle, axis as per spec
@@ -226,7 +314,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
       else
       {
         // degrees Euler as per spec
-        if( OptionalVector3 v = IsVector3(node) )
+        if( OptionalVector3 v = replacer.IsVector3(node) )
         {
           value = Quaternion(Radian(Degree((*v).x)),
                              Radian(Degree((*v).y)),
@@ -238,7 +326,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     }
     case Property::STRING:
     {
-      if( OptionalString v = IsString(node) )
+      if( OptionalString v = replacer.IsString(node) )
       {
         value = *v;
         done = true;
@@ -247,77 +335,103 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Type type, Property::V
     }
     case Property::ARRAY:
     {
-      if(node.Size())
+      if( replacer.IsArray( node, value ) )
+      {
+        done = true;
+      }
+      else if(node.Size())
       {
         value = Property::Value(Property::ARRAY);
+        Property::Array* array = value.GetArray();
+
         unsigned int i = 0;
         TreeNode::ConstIterator iter(node.CBegin());
-        for( ; i < node.Size(); ++i, ++iter)
+
+        if( array )
         {
-          Property::Value v;
-          if( SetPropertyFromNode( (*iter).second, v) )
+          for( ; i < node.Size(); ++i, ++iter)
           {
-            value.AppendItem(v);
+            Property::Value childValue;
+            if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
+            {
+              array->PushBack( childValue );
+            }
           }
-        }
 
-        if( value.GetSize() == static_cast<int>(node.Size()) )
-        {
-          done = true;
-        }
-        else
-        {
-          done = false;
+          if( array->Count() == node.Size() )
+          {
+            done = true;
+          }
+          else
+          {
+            done = false;
+          }
         }
       }
       break;
     }
     case Property::MAP:
     {
-      if(node.Size())
+      if( replacer.IsMap( node, value ) )
+      {
+        done = true;
+      }
+      else if(node.Size())
       {
         value = Property::Value(Property::MAP);
+        Property::Map* map = value.GetMap();
+
         unsigned int i = 0;
         TreeNode::ConstIterator iter(node.CBegin());
-        for( ; i < node.Size(); ++i, ++iter)
+
+        if( map )
         {
-          Property::Value v;
-          if( SetPropertyFromNode( (*iter).second, v) )
+          for( ; i < node.Size(); ++i, ++iter)
           {
-            value.SetValue( (*iter).first, v );
+            Property::Value childValue;
+            if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
+            {
+              map->Insert( (*iter).first, childValue );
+            }
           }
-        }
 
-        if( value.GetSize() == static_cast<int>(node.Size()) )
-        {
-          done = true;
-        }
-        else
-        {
-          done = false;
+          if( map->Count() == node.Size() )
+          {
+            done = true;
+          }
+          else
+          {
+            done = false;
+          }
         }
       }
       break;
     }
-    case Property::TYPE_COUNT:
     case Property::NONE:
     {
       break;
     }
-  }
+  } // switch type
 
   return done;
 }
 
-
 bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
+
+{
+  Replacement replacer;
+  return SetPropertyFromNode( node, value, replacer );
+}
+
+bool SetPropertyFromNode( const TreeNode& node, Property::Value& value,
+                          const Replacement& replacer )
 {
   bool done = false;
 
   // some values are ambiguous as we have no Property::Type but can be disambiguated in the json
 
   // Currently Rotations and Rectangle must always be disambiguated when a type isnt available
-  if( Disambiguated( node, value ) )
+  if( Disambiguated( node, value, replacer ) )
   {
     done = true;
   }
@@ -351,7 +465,7 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
           value = *v;
           done = true;
         }
-        if( OptionalVector4 v = IsVector4(node) )
+        else if( OptionalVector4 v = IsVector4(node) )
         {
           value = *v;
           done = true;
@@ -377,14 +491,18 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
         else
         {
           value = Property::Value(Property::ARRAY);
-          Property::Value v;
+          Property::Array* array = value.GetArray();
 
-          for(TreeConstIter iter = node.CBegin(); iter != node.CEnd(); ++iter)
+          if( array )
           {
-            if( SetPropertyFromNode( (*iter).second, v) )
+            for(TreeConstIter iter = node.CBegin(); iter != node.CEnd(); ++iter)
             {
-              value.AppendItem(v);
-              done = true;
+              Property::Value childValue;
+              if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
+              {
+                array->PushBack( childValue );
+                done = true;
+              }
             }
           }
         }
@@ -401,26 +519,36 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
         if( ((*iter).first) == 0 )
         {
           value = Property::Value(Property::ARRAY);
-          Property::Value v;
-          for(unsigned int i = 0; i < node.Size(); ++i, ++iter)
+          Property::Array* array = value.GetArray();
+
+          if( array )
           {
-            if( SetPropertyFromNode( (*iter).second, v) )
+            for(unsigned int i = 0; i < node.Size(); ++i, ++iter)
             {
-              value.AppendItem(v);
-              done = true;
+              Property::Value childValue;
+              if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
+              {
+                array->PushBack( childValue );
+                done = true;
+              }
             }
           }
         }
         else
         {
           value = Property::Value(Property::MAP);
-          Property::Value v;
-          for(unsigned int i = 0; i < node.Size(); ++i, ++iter)
+          Property::Map* map = value.GetMap();
+
+          if( map )
           {
-            if( SetPropertyFromNode( (*iter).second, v) )
+            for(unsigned int i = 0; i < node.Size(); ++i, ++iter)
             {
-              value.SetValue((*iter).first, v);
-              done = true;
+              Property::Value childValue;
+              if( SetPropertyFromNode( (*iter).second, childValue, replacer ) )
+              {
+                map->Insert( (*iter).first, childValue );
+                done = true;
+              }
             }
           }
         }
@@ -429,10 +557,10 @@ bool SetPropertyFromNode( const TreeNode& node, Property::Value& value )
     else // if( 0 == node.size() )
     {
       // no children so either one of bool, float, integer, string
-      OptionalBoolean aBool    = IsBoolean(node);
-      OptionalInteger anInt    = IsInteger(node);
-      OptionalFloat   aFloat   = IsFloat(node);
-      OptionalString  aString  = IsString(node);
+      OptionalBoolean aBool    = replacer.IsBoolean(node);
+      OptionalInteger anInt    = replacer.IsInteger(node);
+      OptionalFloat   aFloat   = replacer.IsFloat(node);
+      OptionalString  aString  = replacer.IsString(node);
 
       if(aBool)
       {