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

   1 #ifndef __DALI_TYPE_REGISTRY_H__
   2 #define __DALI_TYPE_REGISTRY_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
  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 DALI_IMPORT_API
  30 {
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class TypeRegistry;
  35 }
  36
  37 /**
  38  * @brief The TypeRegistry allows registration of type instance creation functions.
  39  *
  40  * These can then be created later by name and down cast to the appropriate type.
  41  *
  42  * Usage: (Registering)
  43  *
  44  * In my-actor.cpp
  45  * @code
  46  * // Note: object construction in namespace scope is defined in a translation unit as being
  47  * //       in appearance order (C++ standard 3.6/2). So TypeRegistration is declared first in
  48  * //       the cpp file below. Signal, action and property declarations follow in any order.
  49  * namespace
  50  * {
  51  *   TypeRegistration myActorType(typeid(MyActor), typeid(Actor), CreateMyActor );
  52  *
  53  *   SignalConnectorType( myActorType, "highlighted", ConnectSignalForMyActor );
  54  *   TypeAction( myActorType, "open", DoMyActorAction );
  55  *   TypeAction( myActorType, "close", DoMyActorAction );
  56  *   PropertyRegistration( myActorType, "status", PropertyRegistration::START_INDEX, Property::BOOLEAN, SetPropertyFunction, GetPropertyFunction );
  57  * }
  58  * @endcode
  59  *
  60  * Usage: (Creation)
  61  *
  62  * @code
  63  *   TypeRegistry::TypeInfo type = TypeRegistry::Get().GetTypeInfo("MyActor");
  64  *   MyActor a = MyActor::DownCast(type.CreateInstance());
  65  *   if(a)
  66  *   {
  67  *     ...
  68  *   }
  69  * @endcode
  70  *
  71  * CustomActor
  72  *
  73  *  Actors that inherit from the CustomActor framework must ensure the implementation
  74  *  class has an identical name to the Actor class. This is to ensure the class can be
  75  *  found at runtime for signals and actions. Otherwise these will silently fail.
  76  *
  77  *  As namespaces are discarded the convention is to use a namespace ie
  78  *
  79  *    'class MyActor {}; namespace Internal { class MyActor {}; }'
  80  *
  81  *  Warning: this arrangement will silently fail
  82  *
  83  *    'class MyActor {}; class MyActorImpl {};'
  84  *
  85  * Naming Conventions
  86  *
  87  *   Signal and action names follow properties and are by convention lower case hyphen
  88  *   separated ie 'next-page'. This maintains consistency with the scripted interface.
  89  *
  90  */
  91 class TypeRegistry : public BaseHandle
  92 {
  93 public:
  94   typedef std::vector<std::string> NameContainer; ///< Container of type names
  95
  96   /**
  97    * @brief Get Type Registry handle.
  98    *
  99    * @return TypeRegistry handle
 100    */
 101   static TypeRegistry Get();
 102
 103   /**
 104    * @brief Allows the creation of an empty typeRegistry handle.
 105    */
 106   TypeRegistry();
 107
 108   /**
 109    * @brief destructor.
 110    */
 111   ~TypeRegistry();
 112
 113   /**
 114    * @brief This copy constructor is required for (smart) pointer semantics.
 115    *
 116    * @param [in] handle A reference to the copied handle
 117    */
 118   TypeRegistry(const TypeRegistry& handle);
 119
 120   /**
 121    * @brief This assignment operator is required for (smart) pointer semantics.
 122    *
 123    * @param [in] rhs  A reference to the copied handle
 124    * @return A reference to this
 125    */
 126   TypeRegistry& operator=(const TypeRegistry& rhs);
 127
 128   /**
 129    * @brief This method is defined to allow assignment of the NULL value,
 130    * and will throw an exception if passed any other value.
 131    *
 132    * Assigning to NULL is an alias for Reset().
 133    * @param [in] rhs  A NULL pointer
 134    * @return A reference to this handle
 135    */
 136   TypeRegistry& operator=(BaseHandle::NullType* rhs);
 137
 138   /**
 139    * @brief Get TypeInfo for a registered type.
 140    *
 141    * @param [in] uniqueTypeName A unique type name
 142    * @return TypeInfo if the type exists otherwise an empty handle
 143    */
 144   TypeInfo GetTypeInfo( const std::string &uniqueTypeName );
 145
 146   /**
 147    * @brief Get TypeInfo for a registered type.
 148    *
 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 names.
 156    *
 157    * @return list of known types by name
 158    */
 159   NameContainer GetTypeNames() const;
 160
 161 public: // Not intended for application developers
 162
 163   /**
 164    * @brief This constructor is used by Dali Get() method.
 165    *
 166    * @param [in] typeRegistry A pointer to a Dali resource
 167    */
 168   explicit DALI_INTERNAL TypeRegistry(Internal::TypeRegistry*typeRegistry);
 169 };
 170
 171 /**
 172  * @brief Register a type from type info.
 173  */
 174 class TypeRegistration
 175 {
 176 public:
 177   /**
 178    * @brief Constructor registers the type creation function.
 179    *
 180    * @param [in] registerType the type info for the type to be registered
 181    * @param [in] baseType the base type info of registerType
 182    * @param [in] f registerType instance creation function
 183    */
 184   TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
 185                     TypeInfo::CreateFunction f );
 186
 187   /**
 188    * @brief Constructor registers the type creation function.
 189    *
 190    * @param [in] registerType the type info for the type to be registered
 191    * @param [in] baseType the base type info of registerType
 192    * @param [in] f registerType instance creation function
 193    * @param [in] callCreateOnInit If true the creation function is called as part of Dali initialisation
 194    */
 195   TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
 196                     TypeInfo::CreateFunction f, bool callCreateOnInit );
 197
 198   /**
 199    * @brief Constructor registers the type creation function for a named class or type.
 200    *
 201    * This allows types to be created dynamically from script. The name must be
 202    * unique for successful registration.
 203    * @param [in] name the name of the type to be registered
 204    * @param [in] baseType the base type info of registerType
 205    * @param [in] f registerType instance creation function
 206    */
 207   TypeRegistration( const std::string& name, const std::type_info& baseType,
 208                     TypeInfo::CreateFunction f );
 209
 210   /**
 211    * @brief The name the type is registered under (derived from type_info).
 212    *
 213    * @return the registered name or empty if unregistered
 214    */
 215   const std::string RegisteredName() const;
 216
 217 private:
 218   TypeRegistry mReference; ///< Reference to the type registry
 219   std::string mName;       ///< Name of the type
 220 };
 221
 222 /**
 223  * @brief Register a signal connector function to a registered type.
 224  */
 225 class SignalConnectorType
 226 {
 227 public:
 228   /**
 229    * @brief Constructor registers the type creation function.
 230    *
 231    * @param [in] typeRegistration The TypeRegistration object
 232    * @param [in] name The signal name
 233    * @param [in] func The signal connector function
 234    */
 235   SignalConnectorType( TypeRegistration& typeRegistration, const std::string& name, TypeInfo::SignalConnectorFunctionV2 func );
 236 };
 237
 238 /**
 239  * @brief Register an action function.
 240  */
 241 class TypeAction
 242 {
 243 public:
 244   /**
 245    * @brief Constructor registers the type creation function.
 246    *
 247    * @param [in] registered The TypeRegistration object
 248    * @param [in] name The action name
 249    * @param [in] f The action function
 250    */
 251   TypeAction( TypeRegistration &registered, const std::string &name, TypeInfo::ActionFunction f);
 252 };
 253
 254 /**
 255  * @brief Register a property for the given type.
 256  */
 257 class PropertyRegistration
 258 {
 259 public:
 260
 261   /**
 262    * @brief This constructor registers the property with the registered type.
 263    *
 264    * This constructor is for event-thread only properties where the
 265    * value of the property can be retrieved and set via specified
 266    * functions.
 267    *
 268    * Functions of the following type may be used for setFunc and getFunc respectively:
 269    * @code
 270    *   void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 271    *   Property::Value GetProperty( BaseObject* object, Property::Index index );
 272    * @endcode
 273    *
 274    * @param [in] registered The TypeRegistration object
 275    * @param [in] name The name of the property
 276    * @param [in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive.
 277    * @param [in] type The property value type.
 278    * @param [in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only.
 279    * @param [in] getFunc The function to call to retrieve the current value of the property. MUST be provided.
 280    *
 281    * @note The "index" value must be between START_INDEX and MAX_INDEX inclusive.
 282    * @note If "setFunc" is NULL, then the property becomes a read-only property.
 283    * @note "getFunc" MUST be provided
 284    *
 285    * @pre "registered" must be registered with the TypeRegistry.
 286    */
 287   PropertyRegistration( TypeRegistration& registered,
 288                         const std::string& name, Property::Index index, Property::Type type,
 289                         TypeInfo::SetPropertyFunction setFunc, TypeInfo::GetPropertyFunction getFunc );
 290 };
 291
 292 } // namespace Dali
 293
 294 #endif // header