Const correctness improvements for Property::Value.

GetArray() and GetMap() return non-const pointers, which allow const
objects being modified. While DALi itself doesn't seem to abuse this
in client code it may still lead to hard to trace bugs or UB at worst.

It makes sense that the modification of an element of a Property::Map
or Array that a Property::Value holds, means modification of the
Property::Value itself.

- GetArray/Map() const has been changed to return pointer-to-consts;
- a non-const counterpart has been added to each;

Change-Id: I187770bbb3cf355fbf1df95c909bad3ddc8cdb23
Signed-off-by: György Straub <g.straub@partner.samsung.com>

diff --git a/dali/internal/event/common/property-metadata.cpp b/dali/internal/event/common/property-metadata.cpp
index aa4d607d62f46a4187c3db6b8d3fa9abaaaa716e..1df9d5e9c53bb4008350b47462375b267d69deed 100644 (file)
--- a/dali/internal/event/common/property-metadata.cpp
+++ b/dali/internal/event/common/property-metadata.cpp
@@ -86,7 +86,7 @@ void PropertyMetadata::SetPropertyValue( const Property::Value& propertyValue )
 
     case Property::ARRAY:
     {
-      Property::Array* array = propertyValue.GetArray();
+      const Property::Array* array = propertyValue.GetArray();
       if( array )
       {
         value = *array;
@@ -96,7 +96,7 @@ void PropertyMetadata::SetPropertyValue( const Property::Value& propertyValue )
 
     case Property::MAP:
     {
-      Property::Map* map = propertyValue.GetMap();
+      const Property::Map* map = propertyValue.GetMap();
       if( map )
       {
         value = *map;

diff --git a/dali/internal/event/rendering/shader-impl.cpp b/dali/internal/event/rendering/shader-impl.cpp
index 1a7f11fa918f70ebb01b3ca05483362051f2605e..3c3dcf944ee6b4af61ae2457b20e660e26c3443f 100644 (file)
--- a/dali/internal/event/rendering/shader-impl.cpp
+++ b/dali/internal/event/rendering/shader-impl.cpp
@@ -124,7 +124,7 @@ void Shader::SetDefaultProperty( Property::Index index, const Property::Value& p
     {
       if( propertyValue.GetType() == Property::MAP )
       {
-        Dali::Property::Map* map = propertyValue.GetMap();
+        const Dali::Property::Map* map = propertyValue.GetMap();
         if( map )
         {
           std::string vertex;

diff --git a/dali/public-api/object/property-value.cpp b/dali/public-api/object/property-value.cpp
index 26887572a275b3224e38d782997bfdfdea6f73d9..09bb5c7bc7118280275e5393d7bfa0a391d9f2c2 100644 (file)
--- a/dali/public-api/object/property-value.cpp
+++ b/dali/public-api/object/property-value.cpp
@@ -1001,7 +1001,7 @@ bool Property::Value::Get(Property::Map& mapValue) const
   return converted;
 }
 
-Property::Array* Property::Value::GetArray() const
+Property::Array const* Property::Value::GetArray() const
 {
   if(mImpl && (mImpl->GetType() == ARRAY))
   {
@@ -1010,7 +1010,27 @@ Property::Array* Property::Value::GetArray() const
   return nullptr;
 }
 
-Property::Map* Property::Value::GetMap() const
+Property::Array* Property::Value::GetArray()
+{
+  Property::Array* array = nullptr;
+  if(mImpl && (mImpl->GetType() == ARRAY)) // type cannot change in mImpl so array is allocated
+  {
+    array = mImpl->GetArrayPtr();
+  }
+  return array;
+}
+
+Property::Map const* Property::Value::GetMap() const
+{
+  Property::Map* map = nullptr;
+  if(mImpl && (mImpl->GetType() == MAP)) // type cannot change in mImpl so map is allocated
+  {
+    map = mImpl->GetMapPtr();
+  }
+  return map;
+}
+
+Property::Map* Property::Value::GetMap()
 {
   if(mImpl && (mImpl->GetType() == MAP))
   {

diff --git a/dali/public-api/object/property-value.h b/dali/public-api/object/property-value.h
index a0e88db8a91a5d37a32b61c3a95080cd684bcbe9..d9e6f7d6ffdba90c21a363551b6b47cfceaccf78 100644 (file)
--- a/dali/public-api/object/property-value.h
+++ b/dali/public-api/object/property-value.h
@@ -470,20 +470,36 @@ public:
   bool Get(Property::Map& mapValue) const;
 
   /**
-   * @brief Retrieves the Array API of the Property::Value without copying the contents of the map.
+   * @brief Retrieves the Array API of the Property::Value without copying the contents of the array.
    *
-   * @SINCE_1_0.0
+   * @SINCE_1_9.32
    * @return The Array API of the Property::Value or NULL if not a Property::Array
    */
-  Property::Array* GetArray() const;
+  const Property::Array* GetArray() const;
+
+  /**
+   * @brief Retrieves the Array API of the Property::Value without copying the contents of the array.
+   *
+   * @SINCE_1_9.32
+   * @return The Array API of the Property::Value or NULL if not a Property::Array
+   */
+  Property::Array* GetArray();
 
   /**
    * @brief Retrieves the Map API of the Property::Value without copying the contents of the map.
    *
-   * @SINCE_1_0.0
+   * @SINCE_1_9.32
+   * @return The Map API of the Property::Value or NULL if not a Property::Map
+   */
+  const Property::Map* GetMap() const;
+
+  /**
+   * @brief Retrieves the Map API of the Property::Value without copying the contents of the map.
+   *
+   * @SINCE_1_9.32
    * @return The Map API of the Property::Value or NULL if not a Property::Map
    */
-  Property::Map* GetMap() const;
+  Property::Map* GetMap();
 
   /**
    * @brief Retrieves an extents.