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) 2014 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::GetActions
  80    */
  81   void GetActions( Dali::TypeInfo::NameContainer& container ) const;
  82
  83   /**
  84    * @copydoc Dali::TypeInfo::GetSignals
  85    */
  86   void GetSignals( Dali::TypeInfo::NameContainer& container) const;
  87
  88   /**
  89    * @copydoc Dali::TypeInfo::GetProperties
  90    */
  91   void GetProperties( Dali::TypeInfo::NameContainer& container) const;
  92
  93   /**
  94    * Adds the property indices to the container specified.
  95    * @param[in/out] indices The container where the property indices are added.
  96    */
  97   void GetPropertyIndices( Property::IndexContainer& indices ) const;
  98
  99   /**
 100    * @copydoc Dali::TypeInfo::GetPropertyName() const
 101    */
 102   const std::string& GetPropertyName( Property::Index index ) const;
 103
 104   /*
 105    * Add an action function
 106    */
 107   void AddActionFunction( const std::string &actionName, Dali::TypeInfo::ActionFunction function );
 108
 109   /*
 110    * Add a function for connecting a signal.
 111    * @param[in] signalName The name of the signal.
 112    * @param[in] function The function used for connecting to the signal.
 113    */
 114   void AddConnectorFunction( const std::string& signalName, Dali::TypeInfo::SignalConnectorFunction function );
 115
 116   /**
 117    * Adds an event-thread only property to the type.
 118    * @param[in] name The name of the property.
 119    * @param[in] index The index of the property.
 120    * @param[in] type The Property::Type.
 121    * @param[in] setFunc The function to call to set the property (Can be NULL).
 122    * @param[in] getFunc The function to call to retrieve the value of the property.
 123    */
 124   void AddProperty( const std::string& name, Property::Index index, Property::Type type, Dali::TypeInfo::SetPropertyFunction setFunc, Dali::TypeInfo::GetPropertyFunction getFunc );
 125
 126   /**
 127    * Adds an animatable property to the type.
 128    * @param[in] name The name of the property.
 129    * @param[in] index The index of the property
 130    * @param[in] type The Property::Type.
 131    */
 132   void AddAnimatableProperty( const std::string& name, Property::Index index, Property::Type type );
 133
 134   /**
 135    * Do an action on base object
 136    * @param [in] object The base object to act upon
 137    * @param [in] actionName The name of the desired action
 138    * @param [in] properties The arguments of the action
 139    * @return bool If the action could be executed
 140    */
 141   bool DoActionTo(BaseObject *object, const std::string &actionName, const std::vector<Property::Value> &properties);
 142
 143   /**
 144    * Connects a callback function with the object's signals.
 145    * @param[in] object The object providing the signal.
 146    * @param[in] tracker Used to disconnect the signal.
 147    * @param[in] signalName The signal to connect to.
 148    * @param[in] functor A newly allocated FunctorDelegate.
 149    * @return True if the signal was connected.
 150    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 151    */
 152   bool ConnectSignal( BaseObject* object, ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functor );
 153
 154   /**
 155    * Retrieve the property count for this type.
 156    * @return The total number of properties.
 157    */
 158   unsigned int GetPropertyCount() const;
 159
 160   /**
 161    * Given a property name, retrieve the index.
 162    * @param[in] name The name of the property.
 163    * @return The index associated with that name.
 164    */
 165   Property::Index GetPropertyIndex( const std::string& name ) const;
 166
 167   /**
 168    * Checks if there is a setter for the property. If there is then it is writable.
 169    * @param[in] index The property index.
 170    * @return True, if writable, false otherwise.
 171    */
 172   bool IsPropertyWritable( Property::Index index ) const;
 173
 174   /**
 175    * Retrieve the Property::Type of the property at the given index.
 176    * @param[in] index The property index.
 177    * @return The Property::Type at that index.
 178    */
 179   Property::Type GetPropertyType( Property::Index index ) const;
 180
 181   /**
 182    * Sets the value of a property at the index specified for the given object.
 183    * @param[in] object The object whose property is to be set.
 184    * @param[in] index The property index.
 185    * @param[in] value The value to set.
 186    */
 187   void SetProperty( BaseObject *object, Property::Index index, const Property::Value& value ) const;
 188
 189   /**
 190    * Sets the value of a property with the name specified for the given object.
 191    * @param[in] object The object whose property is to be set.
 192    * @param[in] name The property name.
 193    * @param[in] value The value to set.
 194    */
 195   void SetProperty( BaseObject *object, const std::string& name, const Property::Value& value ) const;
 196
 197   /**
 198    * Retrieves the value of a property at the index specified for the given object.
 199    * @param[in] object The object whose property is to be queried.
 200    * @param[in] index The property index.
 201    * @return The current value of the property.
 202    */
 203   Property::Value GetProperty( const BaseObject *object, Property::Index index ) const;
 204
 205   /**
 206    * Retrieves the value of a property with the name specified for the given object.
 207    * @param[in] object The object whose property is to be queried.
 208    * @param[in] name The property name.
 209    * @return The current value of the property.
 210    */
 211   Property::Value GetProperty( const BaseObject *object, const std::string& name ) const;
 212
 213 private:
 214
 215   struct RegisteredProperty
 216   {
 217     RegisteredProperty()
 218     : type( Property::NONE ),
 219       setFunc( NULL ),
 220       getFunc( NULL ),
 221       name()
 222     {
 223     }
 224
 225     RegisteredProperty( Property::Type propType, Dali::TypeInfo::SetPropertyFunction set, Dali::TypeInfo::GetPropertyFunction get, const std::string& propName )
 226     : type( propType ),
 227       setFunc( set ),
 228       getFunc( get ),
 229       name( propName )
 230     {
 231     }
 232
 233     Property::Type type;
 234     Dali::TypeInfo::SetPropertyFunction setFunc;
 235     Dali::TypeInfo::GetPropertyFunction getFunc;
 236     std::string name;
 237   };
 238
 239   typedef std::pair<std::string, Dali::TypeInfo::SignalConnectorFunction > ConnectionPair;
 240   typedef std::pair<std::string, Dali::TypeInfo::ActionFunction > ActionPair;
 241   typedef std::pair<Property::Index, RegisteredProperty> RegisteredPropertyPair;
 242
 243   typedef std::vector< ActionPair > ActionContainer;
 244   typedef std::vector< ConnectionPair > ConnectorContainer;
 245   typedef std::vector< RegisteredPropertyPair > RegisteredPropertyContainer;
 246
 247   std::string mTypeName;
 248   std::string mBaseTypeName;
 249   Dali::TypeInfo::CreateFunction mCreate;
 250   ActionContainer mActions;
 251   ConnectorContainer mSignalConnectors;
 252   RegisteredPropertyContainer mRegisteredProperties;
 253 };
 254
 255 } // namespace Internal
 256
 257 // Helpers for public-api forwarding methods
 258
 259 inline Internal::TypeInfo& GetImplementation(Dali::TypeInfo& typeInfo)
 260 {
 261   DALI_ASSERT_ALWAYS(typeInfo);
 262
 263   BaseObject& handle = typeInfo.GetBaseObject();
 264
 265   return static_cast<Internal::TypeInfo&>(handle);
 266 }
 267
 268 inline const Internal::TypeInfo& GetImplementation(const Dali::TypeInfo& typeInfo)
 269 {
 270   DALI_ASSERT_ALWAYS(typeInfo);
 271
 272   const BaseObject& handle = typeInfo.GetBaseObject();
 273
 274   return static_cast<const Internal::TypeInfo&>(handle);
 275 }
 276
 277 } // namespace Dali
 278
 279 #endif // header