Add Internal::IndexedMap
[platform/core/uifw/dali-core.git] / dali / internal / event / common / type-info-impl.h
index d3fcfda..37c43ed 100644 (file)
@@ -1,8 +1,9 @@
-#ifndef __DALI_INTERNAL_TYPE_INFO_H__
-#define __DALI_INTERNAL_TYPE_INFO_H__
+#ifndef DALI_INTERNAL_TYPE_INFO_H
+#define DALI_INTERNAL_TYPE_INFO_H
+#define USE_INDEXED_MAP_CONTAINER_AT_TYPE_INFO /// For safety. If some problem occured, just remove this define.
 
 /*
- * Copyright (c) 2018 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 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.
 #include <string>
 
 // INTERNAL INCLUDES
+#ifdef USE_INDEXED_MAP_CONTAINER_AT_TYPE_INFO
+#include <dali/internal/common/indexed-const-string-map.h>
+#include <dali/internal/common/indexed-integer-map.h>
+#endif
+
+#include <dali/devel-api/object/csharp-type-info.h>
+#include <dali/internal/common/const-string.h>
+#include <dali/internal/event/object/default-property-metadata.h>
 #include <dali/public-api/object/base-handle.h>
 #include <dali/public-api/object/base-object.h>
+#include <dali/public-api/object/property.h>
 #include <dali/public-api/object/type-info.h>
-#include <dali/devel-api/object/csharp-type-info.h>
 
 namespace Dali
 {
-
 namespace Internal
 {
+class PropertyDetails;
+class TypeRegistry;
 
 /**
  * A TypeInfo class to support registered type creation, and introspection of available
@@ -49,7 +59,7 @@ public:
    * @param [baseName] the base type registered name
    * @param [creator] the creator function for this type
    */
-  TypeInfo(const std::string& name, const std::string& baseName, Dali::TypeInfo::CreateFunction creator);
+  TypeInfo(const std::string& name, const std::string& baseName, Dali::TypeInfo::CreateFunction creator, const Dali::PropertyDetails* defaultProperties, Property::Index defaultPropertyCount);
 
   /**
    * Create TypeInfo for a csharp object
@@ -62,7 +72,7 @@ public:
   /**
    * Destructor
    */
-  virtual ~TypeInfo();
+  ~TypeInfo() override;
 
   /**
    * @copydoc Dali::TypeInfo::GetName
@@ -87,22 +97,22 @@ public:
   /**
    * @copydoc Dali::TypeInfo::GetActionCount
    */
-  size_t GetActionCount() const;
+  uint32_t GetActionCount() const;
 
   /**
    * @copydoc Dali::TypeInfo::GetActionName
    */
-  std::string GetActionName(size_t index) const;
+  std::string GetActionName(uint32_t index) const;
 
   /**
    * @copydoc Dali::TypeInfo::GetSignalCount
    */
-  size_t GetSignalCount() const;
+  uint32_t GetSignalCount() const;
 
   /**
    * @copydoc Dali::TypeInfo::GetSignalName
    */
-  std::string GetSignalName(size_t index) const;
+  std::string GetSignalName(uint32_t index) const;
 
   /**
    * @copydoc Dali::TypeInfo::GetPropertyCount
@@ -113,44 +123,53 @@ public:
    * Adds the property indices to the container specified.
    * @param[in/out] indices The container where the property indices are added.
    */
-  void GetPropertyIndices( Property::IndexContainer& indices ) const;
+  void GetPropertyIndices(Property::IndexContainer& indices) const;
 
   /**
    * @copydoc Dali::TypeInfo::GetPropertyName() const
+   * this API exists to keep the old public API, which cannot be changed
+   */
+  std::string_view GetRegisteredPropertyName(Property::Index index) const;
+
+  /**
+   * Returns the property name for given index
+   *
+   * @param index of the property
+   * @return name or empty string
    */
-  const std::string& GetPropertyName( Property::Index index ) const;
+  std::string_view GetPropertyName(Property::Index index) const;
 
   /*
    * Add an action function
    */
-  void AddActionFunction( const std::string &actionName, Dali::TypeInfo::ActionFunction function );
+  void AddActionFunction(std::string actionName, Dali::TypeInfo::ActionFunction function);
 
   /*
    * Add a function for connecting a signal.
    * @param[in] signalName The name of the signal.
    * @param[in] function The function used for connecting to the signal.
    */
-  void AddConnectorFunction( const std::string& signalName, Dali::TypeInfo::SignalConnectorFunction function );
+  void AddConnectorFunction(std::string signalName, Dali::TypeInfo::SignalConnectorFunction function);
 
   /**
    * Adds an event-thread only property to the type.
    * @param[in] name The name of the property.
    * @param[in] index The index of the property.
    * @param[in] type The Property::Type.
-   * @param[in] setFunc The function to call to set the property (Can be NULL).
+   * @param[in] setFunc The function to call to set the property (Can be nullptr).
    * @param[in] getFunc The function to call to retrieve the value of the property.
    */
-  void AddProperty( const std::string& name, Property::Index index, Property::Type type, Dali::TypeInfo::SetPropertyFunction setFunc, Dali::TypeInfo::GetPropertyFunction getFunc );
+  void AddProperty(std::string name, Property::Index index, Property::Type type, Dali::TypeInfo::SetPropertyFunction setFunc, Dali::TypeInfo::GetPropertyFunction getFunc);
 
   /**
    * Adds an event-thread only property to the type.
    * @param[in] name The name of the property.
    * @param[in] index The index of the property.
    * @param[in] type The Property::Type.
-   * @param[in] setFunc The function to call to set the property (Can be NULL).
+   * @param[in] setFunc The function to call to set the property (Can be nullptr).
    * @param[in] getFunc The function to call to retrieve the value of the property.
    */
-  void AddProperty( const std::string& name, Property::Index index, Property::Type type, Dali::CSharpTypeInfo::SetPropertyFunction setFunc, Dali::CSharpTypeInfo::GetPropertyFunction getFunc);
+  void AddProperty(std::string name, Property::Index index, Property::Type type, Dali::CSharpTypeInfo::SetPropertyFunction setFunc, Dali::CSharpTypeInfo::GetPropertyFunction getFunc);
 
   /**
    * Adds an animatable property to the type.
@@ -158,7 +177,7 @@ public:
    * @param[in] index The index of the property
    * @param[in] type The Property::Type.
    */
-  void AddAnimatableProperty( const std::string& name, Property::Index index, Property::Type type );
+  void AddAnimatableProperty(std::string name, Property::Index index, Property::Type type);
 
   /**
    * Adds an animatable property with the given default value.
@@ -166,7 +185,7 @@ public:
    * @param[in] index The index of the property
    * @param[in] type The Property::Type.
    */
-  void AddAnimatableProperty( const std::string& name, Property::Index index, const Property::Value& defaultValue );
+  void AddAnimatableProperty(std::string name, Property::Index index, Property::Value defaultValue);
 
   /**
    * Adds a component of an animatable property to the type.
@@ -176,7 +195,7 @@ public:
    * @param[in] baseIndex The index of the base animatable property
    * @param[in] component The index The index of the component.
    */
-  void AddAnimatablePropertyComponent( const std::string& name, Property::Index index, Property::Index baseIndex, uint32_t componentIndex );
+  void AddAnimatablePropertyComponent(std::string name, Property::Index index, Property::Index baseIndex, uint32_t componentIndex);
 
   /**
    * Adds a child property to the type.
@@ -184,7 +203,7 @@ public:
    * @param[in] index The index of the property
    * @param[in] type The Property::Type.
    */
-  void AddChildProperty( const std::string& name, Property::Index index, Property::Type type );
+  void AddChildProperty(std::string name, Property::Index index, Property::Type type);
 
   /**
    * Do an action on base object
@@ -193,7 +212,7 @@ public:
    * @param [in] properties The arguments of the action
    * @return bool If the action could be executed
    */
-  bool DoActionTo(BaseObject *object, const std::string &actionName, const Property::Map &properties);
+  bool DoActionTo(BaseObject* object, const std::string& actionName, const Property::Map& properties);
 
   /**
    * Connects a callback function with the object's signals.
@@ -204,76 +223,87 @@ public:
    * @return True if the signal was connected.
    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
    */
-  bool ConnectSignal( BaseObject* object, ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functor );
+  bool ConnectSignal(BaseObject* object, ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functor);
 
   /**
    * Given a property name, retrieve the index.
    * @param[in] name The name of the property.
    * @return The index associated with that name.
    */
-  Property::Index GetPropertyIndex( const std::string& name ) const;
+  Property::Index GetPropertyIndex(ConstString name) const;
 
   /**
    * Given a property index, retrieve the index of its base property.
    * @param[in] index The index of the property.
    * @return The index of the base property associated with the given property index.
    */
-  Property::Index GetBasePropertyIndex( Property::Index index ) const;
+  Property::Index GetBasePropertyIndex(Property::Index index) const;
 
   /**
    * Given a property index, retrieve its component index.
    * @param[in] index The index of the property.
    * @return The component index associated with that property index.
    */
-  int32_t GetComponentIndex( Property::Index index ) const;
+  int32_t GetComponentIndex(Property::Index index) const;
 
   /**
-   * Checks if there is a setter for the property. If there is then it is writable.
    * @param[in] index The property index.
    * @return True, if writable, false otherwise.
    */
-  bool IsPropertyWritable( Property::Index index ) const;
+  bool IsPropertyWritable(Property::Index index) const;
+
+  /**
+   * @param[in] index The property index.
+   * @return True, if animatable, false otherwise.
+   */
+  bool IsPropertyAnimatable(Property::Index index) const;
+
+  /**
+   * @param[in] index The property index.
+   * @return True, if a constraint input, false otherwise.
+   */
+  bool IsPropertyAConstraintInput(Property::Index index) const;
 
   /**
    * Retrieve the Property::Type of the property at the given index.
    * @param[in] index The property index.
    * @return The Property::Type at that index.
    */
-  Property::Type GetPropertyType( Property::Index index ) const;
+  Property::Type GetPropertyType(Property::Index index) const;
 
   /**
    * Given a child property name, retrieve the index.
    * @param[in] name The name of the child property.
    * @return The index associated with that name.
    */
-  Property::Index GetChildPropertyIndex( const std::string& name ) const;
+  Property::Index GetChildPropertyIndex(ConstString name) const;
 
   /**
    * Retrieve the name of the child property at the given index.
    * @param[in] index The property index.
    * @return The name of the child property.
    */
-  const std::string& GetChildPropertyName( Property::Index index ) const;
+  std::string_view GetChildPropertyName(Property::Index index) const;
 
   /**
    * Retrieve the Property::Type of the child property at the given index.
    * @param[in] index The property index.
    * @return The Property::Type at that index.
    */
-  Property::Type GetChildPropertyType( Property::Index index ) const;
+  Property::Type GetChildPropertyType(Property::Index index) const;
 
   /**
    * Retrive the child indices into the given container.
    * @param[in,out] indices The container to put the child indices into
    */
-  void GetChildPropertyIndices( Property::IndexContainer& indices ) const;
+  void GetChildPropertyIndices(Property::IndexContainer& indices) const;
 
   /**
    * Retrieve the default value of the property at the given index.
    * @param[in] index The property index.
    * @return The default property value at that index.
    */
-  Property::Value GetPropertyDefaultValue( Property::Index index ) const;
+  Property::Value GetPropertyDefaultValue(Property::Index index) const;
 
   /**
    * Sets the value of a property at the index specified for the given object.
@@ -281,7 +311,7 @@ public:
    * @param[in] index The property index.
    * @param[in] value The value to set.
    */
-  void SetProperty( BaseObject *object, Property::Index index, const Property::Value& value ) const;
+  void SetProperty(BaseObject* object, Property::Index index, Property::Value value) const;
 
   /**
    * Sets the value of a property with the name specified for the given object.
@@ -289,7 +319,7 @@ public:
    * @param[in] name The property name.
    * @param[in] value The value to set.
    */
-  void SetProperty( BaseObject *object, const std::string& name, const Property::Value& value ) const;
+  void SetProperty(BaseObject* object, const std::string& name, Property::Value value) const;
 
   /**
    * Retrieves the value of a property at the index specified for the given object.
@@ -297,7 +327,7 @@ public:
    * @param[in] index The property index.
    * @return The current value of the property.
    */
-  Property::Value GetProperty( const BaseObject *object, Property::Index index ) const;
+  Property::Value GetProperty(const BaseObject* object, Property::Index index) const;
 
   /**
    * Retrieves the value of a property with the name specified for the given object.
@@ -305,104 +335,105 @@ public:
    * @param[in] name The property name.
    * @return The current value of the property.
    */
-  Property::Value GetProperty( const BaseObject *object, const std::string& name ) const;
+  Property::Value GetProperty(const BaseObject* object, const std::string& name) const;
 
 private:
-
   struct RegisteredProperty
   {
-    RegisteredProperty()
-    : type( Property::NONE ),
-      setFunc( NULL ),
-      getFunc( NULL ),
-      name(),
-      basePropertyIndex(Property::INVALID_INDEX),
-      componentIndex(Property::INVALID_COMPONENT_INDEX)
-    {
-    }
-
-    RegisteredProperty( Property::Type propType, const std::string& propName, Property::Index basePropertyIndex, int32_t componentIndex )
-        : type( propType ),
-          setFunc( NULL ),
-          getFunc( NULL ),
-          name( propName ),
-          basePropertyIndex(basePropertyIndex),
-          componentIndex(componentIndex)
+    RegisteredProperty(Property::Type propType, ConstString propName, Property::Index basePropertyIndex, int32_t componentIndex)
+    : type(propType),
+      setFunc(nullptr),
+      getFunc(nullptr),
+      name(propName),
+      basePropertyIndex(basePropertyIndex),
+      componentIndex(componentIndex)
     {
     }
 
-
-    RegisteredProperty( Property::Type propType, Dali::TypeInfo::SetPropertyFunction set, Dali::TypeInfo::GetPropertyFunction get, const std::string& propName, Property::Index basePropertyIndex, int componentIndex )
-    : type( propType ),
-      setFunc( set ),
-      getFunc( get ),
-      name( propName ),
+    RegisteredProperty(Property::Type propType, Dali::TypeInfo::SetPropertyFunction set, Dali::TypeInfo::GetPropertyFunction get, ConstString propName, Property::Index basePropertyIndex, int componentIndex)
+    : type(propType),
+      setFunc(set),
+      getFunc(get),
+      name(propName),
       basePropertyIndex(basePropertyIndex),
       componentIndex(componentIndex)
     {
     }
 
-    RegisteredProperty( Property::Type propType, Dali::CSharpTypeInfo::SetPropertyFunction set, Dali::CSharpTypeInfo::GetPropertyFunction get, const std::string& propName, Property::Index basePropertyIndex, int componentIndex )
-    : type( propType ),
-      cSharpSetFunc( set ),
-      cSharpGetFunc( get ),
-      name( propName ),
+    RegisteredProperty(Property::Type propType, Dali::CSharpTypeInfo::SetPropertyFunction set, Dali::CSharpTypeInfo::GetPropertyFunction get, ConstString propName, Property::Index basePropertyIndex, int componentIndex)
+    : type(propType),
+      cSharpSetFunc(set),
+      cSharpGetFunc(get),
+      name(propName),
       basePropertyIndex(basePropertyIndex),
       componentIndex(componentIndex)
     {
     }
 
-
-    Property::Type type;
+    Property::Type type = Property::NONE;
     union
     {
-      Dali::TypeInfo::SetPropertyFunction setFunc;
-      Dali::CSharpTypeInfo::SetPropertyFunction cSharpSetFunc;
+      Dali::TypeInfo::SetPropertyFunction       setFunc = nullptr;
+      Dali::CSharpTypeInfo::SetPropertyFunction cSharpSetFunc; // only one field can be initialized but this will have same value anyways
     };
     union
     {
-      Dali::TypeInfo::GetPropertyFunction getFunc;
-      Dali::CSharpTypeInfo::GetPropertyFunction cSharpGetFunc;
+      Dali::TypeInfo::GetPropertyFunction       getFunc = nullptr;
+      Dali::CSharpTypeInfo::GetPropertyFunction cSharpGetFunc; // only one field can be initialized but this will have same value anyways
     };
-    std::string name;
-    Property::Index basePropertyIndex;
-    int32_t componentIndex;
+    ConstString     name;
+    Property::Index basePropertyIndex = Property::INVALID_INDEX;
+    int32_t         componentIndex    = Property::INVALID_COMPONENT_INDEX;
   };
 
-  typedef std::pair<std::string, Dali::TypeInfo::SignalConnectorFunction > ConnectionPair;
-  typedef std::pair<std::string, Dali::TypeInfo::ActionFunction > ActionPair;
-  typedef std::pair<Property::Index, RegisteredProperty> RegisteredPropertyPair;
-  typedef std::pair<Property::Index, Property::Value> PropertyDefaultValuePair;
-
-  typedef std::vector< ActionPair > ActionContainer;
-  typedef std::vector< ConnectionPair > ConnectorContainer;
-  typedef std::vector< RegisteredPropertyPair > RegisteredPropertyContainer;
-  typedef std::vector< PropertyDefaultValuePair > PropertyDefaultValueContainer;
-
+  using ActionPair     = std::pair<std::string, Dali::TypeInfo::ActionFunction>;
+  using ConnectionPair = std::pair<std::string, Dali::TypeInfo::SignalConnectorFunction>;
+#ifdef USE_INDEXED_MAP_CONTAINER_AT_TYPE_INFO
+  using RegisteredPropertyPair   = std::pair<std::uint32_t, RegisteredProperty>;
+  using PropertyDefaultValuePair = std::pair<std::uint32_t, Property::Value>;
+#else
+  using RegisteredPropertyPair        = std::pair<Property::Index, RegisteredProperty>;
+  using PropertyDefaultValuePair      = std::pair<Property::Index, Property::Value>;
+#endif
+
+#ifdef USE_INDEXED_MAP_CONTAINER_AT_TYPE_INFO
+  using ActionContainer               = Dali::Internal::IndexedConstStringMap<Dali::TypeInfo::ActionFunction>;
+  using ConnectorContainer            = Dali::Internal::IndexedConstStringMap<Dali::TypeInfo::SignalConnectorFunction>;
+  using RegisteredPropertyContainer   = Dali::Internal::IndexedIntegerMap<RegisteredProperty>;
+  using PropertyDefaultValueContainer = Dali::Internal::IndexedIntegerMap<Property::Value>;
+#else
+  using ActionContainer               = std::vector<ActionPair>;
+  using ConnectorContainer            = std::vector<ConnectionPair>;
+  using RegisteredPropertyContainer   = std::vector<RegisteredPropertyPair>;
+  using PropertyDefaultValueContainer = std::vector<PropertyDefaultValuePair>;
+#endif
 
   /**
    * Append properties from registeredProperties onto indices.
    * @param[in,out] indices The vector to append indices onto
    * @param[in] registeredProperties The container to retrive indices from
    */
-  void AppendProperties( Dali::Property::IndexContainer& indices,
-                         const TypeInfo::RegisteredPropertyContainer& registeredProperties ) const;
+  void AppendProperties(Dali::Property::IndexContainer&              indices,
+                        const TypeInfo::RegisteredPropertyContainer& registeredProperties) const;
 
 private:
-
-  std::string mTypeName;
-  std::string mBaseTypeName;
-  bool        mCSharpType:1;    ///< Whether this type info is for a CSharp control (instead of C++)
+  TypeRegistry&               mTypeRegistry;
+  mutable Internal::TypeInfo* mBaseType; // allow changing from const methods, initialised inside constructor
+  std::string                 mTypeName;
+  std::string                 mBaseTypeName;
   union
   {
-    Dali::TypeInfo::CreateFunction mCreate;
-    Dali::CSharpTypeInfo::CreateFunction mCSharpCreate;
+    Dali::TypeInfo::CreateFunction       mCreate = nullptr;
+    Dali::CSharpTypeInfo::CreateFunction mCSharpCreate; // only one field can be initialized but this will have same value anyways
   };
-  ActionContainer mActions;
-  ConnectorContainer mSignalConnectors;
-  RegisteredPropertyContainer mRegisteredProperties;
-  RegisteredPropertyContainer mRegisteredChildProperties;
+  ActionContainer               mActions;
+  ConnectorContainer            mSignalConnectors;
+  RegisteredPropertyContainer   mRegisteredProperties;
+  RegisteredPropertyContainer   mRegisteredChildProperties;
   PropertyDefaultValueContainer mPropertyDefaultValues;
+  const Dali::PropertyDetails*  mDefaultProperties    = nullptr;
+  Property::Index               mDefaultPropertyCount = 0;
+  bool                          mCSharpType           = false; ///< Whether this type info is for a CSharp control (instead of C++)
 };
 
 } // namespace Internal
@@ -429,4 +460,4 @@ inline const Internal::TypeInfo& GetImplementation(const Dali::TypeInfo& typeInf
 
 } // namespace Dali
 
-#endif // header
+#endif // DALI_INTERNAL_TYPE_INFO_H