dali/internal/event/common/type-info-impl.h

   1 #ifndef __DALI_INTERNAL_TYPE_INFO_H__
   2 #define __DALI_INTERNAL_TYPE_INFO_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/object/base-handle.h>
  26 #include <dali/public-api/object/base-object.h>
  27 #include <dali/public-api/object/type-info.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 /**
  36  * A TypeInfo class to support registered type creation, and introspection of available
  37  * actions and signal connection.
  38  * It also supports doing actions and connecting signal handlers. Note this is properly
  39  * conducted through the BaseHandle interface which uses the TypeRegistry to walk
  40  * all base classes.
  41  */
  42 class TypeInfo : public BaseObject
  43 {
  44 public:
  45   /**
  46    * Create TypeInfo
  47    * @param [name] the registered name
  48    * @param [baseName] the base type registered name
  49    * @param [creator] the creator function for this type
  50    */
  51   TypeInfo(const std::string &name, const std::string &baseName, Dali::TypeInfo::CreateFunction creator);
  52
  53   /**
  54    *
  55    */
  56   ~TypeInfo();
  57
  58   /**
  59    * @copydoc Dali::TypeInfo::GetName
  60    */
  61   const std::string& GetName() const;
  62
  63   /**
  64    * @copydoc Dali::TypeInfo::GetBaseName
  65    */
  66   const std::string& GetBaseName() const;
  67
  68   /**
  69    * @copydoc TypeInfo::CreateFunction
  70    */
  71   BaseHandle CreateInstance() const;
  72
  73   /**
  74    * @copydoc Dali::TypeInfo::GetCreator
  75    */
  76   Dali::TypeInfo::CreateFunction GetCreator() const;
  77
  78   /**
  79    * @copydoc Dali::TypeInfo::GetActionCount
  80    */
  81   size_t GetActionCount() const;
  82
  83   /**
  84    * @copydoc Dali::TypeInfo::GetActionName
  85    */
  86   std::string GetActionName(size_t index) const;
  87
  88   /**
  89    * @copydoc Dali::TypeInfo::GetSignalCount
  90    */
  91   size_t GetSignalCount() const;
  92
  93   /**
  94    * @copydoc Dali::TypeInfo::GetSignalName
  95    */
  96   std::string GetSignalName(size_t index) const;
  97
  98   /**
  99    * @copydoc Dali::TypeInfo::GetPropertyCount
 100    */
 101   size_t GetPropertyCount() const;
 102
 103   /**
 104    * @copydoc Dali::TypeInfo::GetPropertyName
 105    */
 106   std::string GetPropertyName(size_t index) const;
 107
 108   /**
 109    * Adds the property indices to the container specified.
 110    * @param[in/out] indices The container where the property indices are added.
 111    */
 112   void GetPropertyIndices( Property::IndexContainer& indices ) const;
 113
 114   /**
 115    * @copydoc Dali::TypeInfo::GetPropertyName() const
 116    */
 117   const std::string& GetPropertyName( Property::Index index ) const;
 118
 119   /*
 120    * Add an action function
 121    */
 122   void AddActionFunction( const std::string &actionName, Dali::TypeInfo::ActionFunction function );
 123
 124   /*
 125    * Add a function for connecting a signal.
 126    * @param[in] signalName The name of the signal.
 127    * @param[in] function The function used for connecting to the signal.
 128    */
 129   void AddConnectorFunction( const std::string& signalName, Dali::TypeInfo::SignalConnectorFunction function );
 130
 131   /**
 132    * Adds an event-thread only property to the type.
 133    * @param[in] name The name of the property.
 134    * @param[in] index The index of the property.
 135    * @param[in] type The Property::Type.
 136    * @param[in] setFunc The function to call to set the property (Can be NULL).
 137    * @param[in] getFunc The function to call to retrieve the value of the property.
 138    */
 139   void AddProperty( const std::string& name, Property::Index index, Property::Type type, Dali::TypeInfo::SetPropertyFunction setFunc, Dali::TypeInfo::GetPropertyFunction getFunc );
 140
 141   /**
 142    * Adds an animatable property to the type.
 143    * @param[in] name The name of the property.
 144    * @param[in] index The index of the property
 145    * @param[in] type The Property::Type.
 146    */
 147   void AddAnimatableProperty( const std::string& name, Property::Index index, Property::Type type );
 148
 149   /**
 150    * Adds an animatable property with the given default value.
 151    * @param[in] name The name of the property.
 152    * @param[in] index The index of the property
 153    * @param[in] type The Property::Type.
 154    */
 155   void AddAnimatableProperty( const std::string& name, Property::Index index, const Property::Value& defaultValue );
 156
 157   /**
 158    * Adds a component of an animatable property to the type.
 159    * The animatable property must have been type-registered and must be a Vector2, Vector3 or Vector4 type.
 160    * @param[in] name The name of the component.
 161    * @param[in] index The index of the property
 162    * @param[in] baseIndex The index of the base animatable property
 163    * @param[in] component The index The index of the component.
 164    */
 165   void AddAnimatablePropertyComponent( const std::string& name, Property::Index index, Property::Index baseIndex, unsigned int componentIndex );
 166
 167   /**
 168    * Do an action on base object
 169    * @param [in] object The base object to act upon
 170    * @param [in] actionName The name of the desired action
 171    * @param [in] properties The arguments of the action
 172    * @return bool If the action could be executed
 173    */
 174   bool DoActionTo(BaseObject *object, const std::string &actionName, const Property::Map &properties);
 175
 176   /**
 177    * Connects a callback function with the object's signals.
 178    * @param[in] object The object providing the signal.
 179    * @param[in] tracker Used to disconnect the signal.
 180    * @param[in] signalName The signal to connect to.
 181    * @param[in] functor A newly allocated FunctorDelegate.
 182    * @return True if the signal was connected.
 183    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 184    */
 185   bool ConnectSignal( BaseObject* object, ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functor );
 186
 187   /**
 188    * Given a property name, retrieve the index.
 189    * @param[in] name The name of the property.
 190    * @return The index associated with that name.
 191    */
 192   Property::Index GetPropertyIndex( const std::string& name ) const;
 193
 194   /**
 195    * Given a property index, retrieve the index of its base property.
 196    * @param[in] index The index of the property.
 197    * @return The index of the base property associated with the given property index.
 198    */
 199   Property::Index GetBasePropertyIndex( Property::Index index ) const;
 200
 201   /**
 202    * Given a property index, retrieve its component index.
 203    * @param[in] index The index of the property.
 204    * @return The component index associated with that property index.
 205    */
 206   int GetComponentIndex( Property::Index index ) const;
 207
 208   /**
 209    * Checks if there is a setter for the property. If there is then it is writable.
 210    * @param[in] index The property index.
 211    * @return True, if writable, false otherwise.
 212    */
 213   bool IsPropertyWritable( Property::Index index ) const;
 214
 215   /**
 216    * Retrieve the Property::Type of the property at the given index.
 217    * @param[in] index The property index.
 218    * @return The Property::Type at that index.
 219    */
 220   Property::Type GetPropertyType( Property::Index index ) const;
 221
 222   /**
 223    * Retrieve the default value of the property at the given index.
 224    * @param[in] index The property index.
 225    * @return The default property value at that index.
 226    */
 227   Property::Value GetPropertyDefaultValue( Property::Index index ) const;
 228
 229   /**
 230    * Sets the value of a property at the index specified for the given object.
 231    * @param[in] object The object whose property is to be set.
 232    * @param[in] index The property index.
 233    * @param[in] value The value to set.
 234    */
 235   void SetProperty( BaseObject *object, Property::Index index, const Property::Value& value ) const;
 236
 237   /**
 238    * Sets the value of a property with the name specified for the given object.
 239    * @param[in] object The object whose property is to be set.
 240    * @param[in] name The property name.
 241    * @param[in] value The value to set.
 242    */
 243   void SetProperty( BaseObject *object, const std::string& name, const Property::Value& value ) const;
 244
 245   /**
 246    * Retrieves the value of a property at the index specified for the given object.
 247    * @param[in] object The object whose property is to be queried.
 248    * @param[in] index The property index.
 249    * @return The current value of the property.
 250    */
 251   Property::Value GetProperty( const BaseObject *object, Property::Index index ) const;
 252
 253   /**
 254    * Retrieves the value of a property with the name specified for the given object.
 255    * @param[in] object The object whose property is to be queried.
 256    * @param[in] name The property name.
 257    * @return The current value of the property.
 258    */
 259   Property::Value GetProperty( const BaseObject *object, const std::string& name ) const;
 260
 261 private:
 262
 263   struct RegisteredProperty
 264   {
 265     RegisteredProperty()
 266     : type( Property::NONE ),
 267       setFunc( NULL ),
 268       getFunc( NULL ),
 269       name(),
 270       basePropertyIndex(Property::INVALID_INDEX),
 271       componentIndex(Property::INVALID_COMPONENT_INDEX)
 272     {
 273     }
 274
 275     RegisteredProperty( Property::Type propType, Dali::TypeInfo::SetPropertyFunction set, Dali::TypeInfo::GetPropertyFunction get, const std::string& propName, Property::Index basePropertyIndex, int componentIndex )
 276     : type( propType ),
 277       setFunc( set ),
 278       getFunc( get ),
 279       name( propName ),
 280       basePropertyIndex(basePropertyIndex),
 281       componentIndex(componentIndex)
 282     {
 283     }
 284
 285     Property::Type type;
 286     Dali::TypeInfo::SetPropertyFunction setFunc;
 287     Dali::TypeInfo::GetPropertyFunction getFunc;
 288     std::string name;
 289     Property::Index basePropertyIndex;
 290     int componentIndex;
 291   };
 292
 293   typedef std::pair<std::string, Dali::TypeInfo::SignalConnectorFunction > ConnectionPair;
 294   typedef std::pair<std::string, Dali::TypeInfo::ActionFunction > ActionPair;
 295   typedef std::pair<Property::Index, RegisteredProperty> RegisteredPropertyPair;
 296   typedef std::pair<Property::Index, Property::Value> PropertyDefaultValuePair;
 297
 298   typedef std::vector< ActionPair > ActionContainer;
 299   typedef std::vector< ConnectionPair > ConnectorContainer;
 300   typedef std::vector< RegisteredPropertyPair > RegisteredPropertyContainer;
 301   typedef std::vector< PropertyDefaultValuePair > PropertyDefaultValueContainer;
 302
 303   std::string mTypeName;
 304   std::string mBaseTypeName;
 305   Dali::TypeInfo::CreateFunction mCreate;
 306   ActionContainer mActions;
 307   ConnectorContainer mSignalConnectors;
 308   RegisteredPropertyContainer mRegisteredProperties;
 309   PropertyDefaultValueContainer mPropertyDefaultValues;
 310 };
 311
 312 } // namespace Internal
 313
 314 // Helpers for public-api forwarding methods
 315
 316 inline Internal::TypeInfo& GetImplementation(Dali::TypeInfo& typeInfo)
 317 {
 318   DALI_ASSERT_ALWAYS(typeInfo);
 319
 320   BaseObject& handle = typeInfo.GetBaseObject();
 321
 322   return static_cast<Internal::TypeInfo&>(handle);
 323 }
 324
 325 inline const Internal::TypeInfo& GetImplementation(const Dali::TypeInfo& typeInfo)
 326 {
 327   DALI_ASSERT_ALWAYS(typeInfo);
 328
 329   const BaseObject& handle = typeInfo.GetBaseObject();
 330
 331   return static_cast<const Internal::TypeInfo&>(handle);
 332 }
 333
 334 } // namespace Dali
 335
 336 #endif // header