dali/public-api/object/type-registry.h

   1 #ifndef __DALI_TYPE_REGISTRY_H__
   2 #define __DALI_TYPE_REGISTRY_H__
   3
   4 /*
   5  * Copyright (c) 2016 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
  22 // EXTERNAL INCLUDES
  23 #include <typeinfo>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/object/base-handle.h>
  27 #include <dali/public-api/object/type-info.h>
  28
  29 namespace Dali
  30 {
  31 /**
  32  * @addtogroup dali_core_object
  33  * @{
  34  */
  35
  36 namespace Internal DALI_INTERNAL
  37 {
  38 class TypeRegistry;
  39 }
  40
  41 /**
  42  * @brief The TypeRegistry allows registration of type instance creation functions.
  43  *
  44  * These can then be created later by name and down cast to the appropriate type.
  45  *
  46  * Usage: (Registering)
  47  *
  48  * In my-actor.cpp
  49  * @code
  50  * // Note: object construction in namespace scope is defined in a translation unit as being
  51  * //       in appearance order (C++ standard 3.6/2). So TypeRegistration is declared first in
  52  * //       the cpp file below. Signal, action and property declarations follow in any order.
  53  * namespace
  54  * {
  55  *   TypeRegistration myActorType(typeid(MyActor), typeid(Actor), CreateMyActor );
  56  *
  57  *   SignalConnectorType( myActorType, "highlighted", ConnectSignalForMyActor );
  58  *   TypeAction( myActorType, "open", DoMyActorAction );
  59  *   TypeAction( myActorType, "close", DoMyActorAction );
  60  *   PropertyRegistration( myActorType, "status", PropertyRegistration::START_INDEX, Property::BOOLEAN, SetPropertyFunction, GetPropertyFunction );
  61  * }
  62  * @endcode
  63  *
  64  * Usage: (Creation)
  65  *
  66  * @code
  67  *   TypeRegistry::TypeInfo type = TypeRegistry::Get().GetTypeInfo("MyActor");
  68  *   MyActor a = MyActor::DownCast(type.CreateInstance());
  69  *   if(a)
  70  *   {
  71  *     ...
  72  *   }
  73  * @endcode
  74  *
  75  * CustomActor
  76  *
  77  *  Actors that inherit from the CustomActor framework must ensure the implementation
  78  *  class has an identical name to the Actor class. This is to ensure the class can be
  79  *  found at runtime for signals and actions. Otherwise these will silently fail.
  80  *
  81  *  As namespaces are discarded the convention is to use a namespace ie
  82  *
  83  *    'class MyActor {}; namespace Internal { class MyActor {}; }'
  84  *
  85  *  Warning: this arrangement will silently fail
  86  *
  87  *    'class MyActor {}; class MyActorImpl {};'
  88  *
  89  * Naming Conventions
  90  *
  91  *   Signal and action names follow properties and are by convention lower case hyphen
  92  *   separated ie 'next-page'. This maintains consistency with the scripted interface.
  93  *
  94  * @SINCE_1_0.0
  95  */
  96 class DALI_IMPORT_API TypeRegistry : public BaseHandle
  97 {
  98 public:
  99   /**
 100    * @brief Get Type Registry handle.
 101    *
 102    * @SINCE_1_0.0
 103    * @return TypeRegistry handle
 104    */
 105   static TypeRegistry Get();
 106
 107   /**
 108    * @brief Allows the creation of an empty typeRegistry handle.
 109    * @SINCE_1_0.0
 110    */
 111   TypeRegistry();
 112
 113   /**
 114    * @brief destructor.
 115    * @SINCE_1_0.0
 116    */
 117   ~TypeRegistry();
 118
 119   /**
 120    * @brief This copy constructor is required for (smart) pointer semantics.
 121    *
 122    * @SINCE_1_0.0
 123    * @param [in] handle A reference to the copied handle
 124    */
 125   TypeRegistry(const TypeRegistry& handle);
 126
 127   /**
 128    * @brief This assignment operator is required for (smart) pointer semantics.
 129    *
 130    * @SINCE_1_0.0
 131    * @param [in] rhs  A reference to the copied handle
 132    * @return A reference to this
 133    */
 134   TypeRegistry& operator=(const TypeRegistry& rhs);
 135
 136   /**
 137    * @brief Get TypeInfo for a registered type.
 138    *
 139    * @SINCE_1_0.0
 140    * @param [in] uniqueTypeName A unique type name
 141    * @return TypeInfo if the type exists otherwise an empty handle
 142    */
 143   TypeInfo GetTypeInfo( const std::string &uniqueTypeName );
 144
 145   /**
 146    * @brief Get TypeInfo for a registered type.
 147    *
 148    * @SINCE_1_0.0
 149    * @param [in] registerType The registered type info
 150    * @return TypeInfo if the type exists otherwise an empty handle
 151    */
 152   TypeInfo GetTypeInfo( const std::type_info& registerType );
 153
 154   /**
 155    * @brief Get type name count.
 156    *
 157    * @SINCE_1_0.0
 158    * @return The count
 159    */
 160   size_t GetTypeNameCount() const;
 161
 162   /**
 163    * @brief Get type names by index.
 164    *
 165    * @SINCE_1_0.0
 166    * @return The type name or an empty string when index is not valid
 167    */
 168   std::string GetTypeName(size_t index) const;
 169
 170 public: // Not intended for application developers
 171
 172   /// @cond internal
 173   /**
 174    * @brief This constructor is used by Dali Get() method.
 175    *
 176    * @SINCE_1_0.0
 177    * @param [in] typeRegistry A pointer to a Dali resource
 178    */
 179   explicit DALI_INTERNAL TypeRegistry(Internal::TypeRegistry*typeRegistry);
 180   /// @endcond
 181 };
 182
 183 /**
 184  * @brief Register a type from type info.
 185  * @SINCE_1_0.0
 186  */
 187 class DALI_IMPORT_API TypeRegistration
 188 {
 189 public:
 190   /**
 191    * @brief Constructor registers the type creation function.
 192    *
 193    * @SINCE_1_0.0
 194    * @param [in] registerType the type info for the type to be registered
 195    * @param [in] baseType the base type info of registerType
 196    * @param [in] f registerType instance creation function
 197    */
 198   TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
 199                     TypeInfo::CreateFunction f );
 200
 201   /**
 202    * @brief Constructor registers the type creation function.
 203    *
 204    * @SINCE_1_0.0
 205    * @param [in] registerType the type info for the type to be registered
 206    * @param [in] baseType the base type info of registerType
 207    * @param [in] f registerType instance creation function
 208    * @param [in] callCreateOnInit If true the creation function is called as part of Dali initialisation
 209    */
 210   TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
 211                     TypeInfo::CreateFunction f, bool callCreateOnInit );
 212
 213   /**
 214    * @brief Constructor registers the type creation function for a named class or type.
 215    *
 216    * This allows types to be created dynamically from script. The name must be
 217    * unique for successful registration.
 218    * @SINCE_1_0.0
 219    * @param [in] name the name of the type to be registered
 220    * @param [in] baseType the base type info of registerType
 221    * @param [in] f registerType instance creation function
 222    */
 223   TypeRegistration( const std::string& name, const std::type_info& baseType,
 224                     TypeInfo::CreateFunction f );
 225
 226   /**
 227    * @brief The name the type is registered under (derived from type_info).
 228    *
 229    * @SINCE_1_0.0
 230    * @return the registered name or empty if unregistered
 231    */
 232   const std::string RegisteredName() const;
 233
 234 private:
 235   TypeRegistry mReference; ///< Reference to the type registry
 236   std::string mName;       ///< Name of the type
 237 };
 238
 239 /**
 240  * @brief Register a signal connector function to a registered type.
 241  * @SINCE_1_0.0
 242  */
 243 class DALI_IMPORT_API SignalConnectorType
 244 {
 245 public:
 246   /**
 247    * @brief Constructor registers the type creation function.
 248    *
 249    * @SINCE_1_0.0
 250    * @param [in] typeRegistration The TypeRegistration object
 251    * @param [in] name The signal name
 252    * @param [in] func The signal connector function
 253    */
 254   SignalConnectorType( TypeRegistration& typeRegistration, const std::string& name, TypeInfo::SignalConnectorFunction func );
 255 };
 256
 257 /**
 258  * @brief Register an action function.
 259  * @SINCE_1_0.0
 260  */
 261 class DALI_IMPORT_API TypeAction
 262 {
 263 public:
 264   /**
 265    * @brief Constructor registers the type creation function.
 266    *
 267    * @SINCE_1_0.0
 268    * @param [in] registered The TypeRegistration object
 269    * @param [in] name The action name
 270    * @param [in] f The action function
 271    */
 272   TypeAction( TypeRegistration &registered, const std::string &name, TypeInfo::ActionFunction f);
 273 };
 274
 275 /**
 276  * @brief Register a property for the given type.
 277  * @SINCE_1_0.0
 278  */
 279 class DALI_IMPORT_API PropertyRegistration
 280 {
 281 public:
 282
 283   /**
 284    * @brief This constructor registers the property with the registered type.
 285    *
 286    * This constructor is for event-thread only properties where the
 287    * value of the property can be retrieved and set via specified
 288    * functions.
 289    *
 290    * Functions of the following type may be used for setFunc and getFunc respectively:
 291    * @code
 292    *   void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 293    *   Property::Value GetProperty( BaseObject* object, Property::Index index );
 294    * @endcode
 295    *
 296    * @SINCE_1_0.0
 297    * @param [in] registered The TypeRegistration object
 298    * @param [in] name The name of the property
 299    * @param [in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive.
 300    * @param [in] type The property value type.
 301    * @param [in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only.
 302    * @param [in] getFunc The function to call to retrieve the current value of the property. MUST be provided.
 303    *
 304    * @pre "registered" must be registered with the TypeRegistry.
 305    * @note The "index" value must be between START_INDEX and MAX_INDEX inclusive.
 306    * @note If "setFunc" is NULL, then the property becomes a read-only property.
 307    * @note "getFunc" MUST be provided
 308    *
 309    */
 310   PropertyRegistration( TypeRegistration& registered,
 311                         const std::string& name, Property::Index index, Property::Type type,
 312                         TypeInfo::SetPropertyFunction setFunc, TypeInfo::GetPropertyFunction getFunc );
 313 };
 314
 315 /**
 316  * @brief Register an animatable property for the given type.
 317  * @SINCE_1_0.0
 318  */
 319 class DALI_IMPORT_API AnimatablePropertyRegistration
 320 {
 321 public:
 322
 323   /**
 324    * @brief This constructor registers the animatable property with the registered type.
 325    *
 326    * This constructor is for scene-graph only properties where the
 327    * value of the property can be retrieved and set via specified
 328    * functions.
 329    *
 330    * @SINCE_1_0.0
 331    * @param [in] registered The TypeRegistration object
 332    * @param [in] name The name of the property
 333    * @param [in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
 334    * @param [in] type The property value type.
 335    *
 336    * @pre "registered" must be registered with the TypeRegistry.
 337    */
 338   AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
 339
 340   /**
 341    * @brief This constructor registers the animatable property with the registered default value.
 342    *
 343    * This constructor is for scene-graph only properties where the
 344    * value of the property can be retrieved and set via specified
 345    * functions.
 346    *
 347    * @SINCE_1_1.18
 348    * @param [in] registered The TypeRegistration object
 349    * @param [in] name The name of the property
 350    * @param [in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
 351    * @param [in] value The property default value.
 352    *
 353    * @pre "registered" must be registered with the TypeRegistry.
 354    */
 355   AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, const Property::Value& value );
 356 };
 357
 358 /**
 359  * @brief Register a component of animatable property for the given component index.
 360  * @SINCE_1_0.0
 361  */
 362 class DALI_IMPORT_API AnimatablePropertyComponentRegistration
 363 {
 364 public:
 365
 366   /**
 367    * @brief This constructor registers a component of an animatable property where
 368    * the base animatable property must be a property that supports property component
 369    * (i.e. Vector2, Vector3 or Vector4) and the base animatable property must have
 370    * been registered.
 371    *
 372    * This constructor is for a component of scene-graph only properties where the
 373    * value of the property can be retrieved and set via specified functions.
 374    *
 375    * @SINCE_1_0.0
 376    * @param [in] registered The TypeRegistration object
 377    * @param [in] name The name of the component
 378    * @param [in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
 379    * @param [in] baseIndex The index of the base animatable property. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
 380    * @param [in] componentIndex The index of the component (e.g. 0 for the x component of a Vector2 property and 1 for the y component of a Vector2 property).
 381    *
 382    * @pre "registered" must be registered with the TypeRegistry.
 383    */
 384   AnimatablePropertyComponentRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Index baseIndex, unsigned int componentIndex );
 385 };
 386
 387 /**
 388  * @brief Register a child property for the given type.
 389  * @SINCE_1_1.35
 390  */
 391 class DALI_IMPORT_API ChildPropertyRegistration
 392 {
 393 public:
 394
 395   /**
 396    * @brief This constructor registers an event-thread only child property (i.e. a property
 397    * that the parent supports in its children) with the registered type.
 398    *
 399    * @SINCE_1_1.35
 400    * @param [in] registered The TypeRegistration object
 401    * @param [in] name The name of the property
 402    * @param [in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
 403    * @param [in] type The property value type.
 404    *
 405    * @pre "registered" must be registered with the TypeRegistry.
 406    */
 407   ChildPropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
 408 };
 409
 410
 411 /**
 412  * @}
 413  */
 414 } // namespace Dali
 415
 416 #endif // header