1 #ifndef __DALI_TYPE_REGISTRY_H__
2 #define __DALI_TYPE_REGISTRY_H__
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
26 #include <dali/public-api/object/base-handle.h>
27 #include <dali/public-api/object/type-info.h>
32 * @addtogroup dali_core_object
36 namespace Internal DALI_INTERNAL
42 * @brief The TypeRegistry allows registration of type instance creation functions.
44 * These can then be created later by name and down cast to the appropriate type.
46 * Usage: (Registering)
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.
55 * TypeRegistration myActorType(typeid(MyActor), typeid(Actor), CreateMyActor );
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 );
67 * TypeRegistry::TypeInfo type = TypeRegistry::Get().GetTypeInfo("MyActor");
68 * MyActor a = MyActor::DownCast(type.CreateInstance());
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.
81 * As namespaces are discarded the convention is to use a namespace ie
83 * 'class MyActor {}; namespace Internal { class MyActor {}; }'
85 * Warning: this arrangement will silently fail
87 * 'class MyActor {}; class MyActorImpl {};'
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.
96 class DALI_CORE_API TypeRegistry : public BaseHandle
100 * @brief Gets Type Registry handle.
103 * @return TypeRegistry handle
105 static TypeRegistry Get();
108 * @brief Allows the creation of an empty typeRegistry handle.
120 * @brief This copy constructor is required for (smart) pointer semantics.
123 * @param[in] handle A reference to the copied handle
125 TypeRegistry(const TypeRegistry& handle);
128 * @brief This assignment operator is required for (smart) pointer semantics.
131 * @param[in] rhs A reference to the copied handle
132 * @return A reference to this
134 TypeRegistry& operator=(const TypeRegistry& rhs);
137 * @brief Gets TypeInfo for a registered type.
140 * @param[in] uniqueTypeName A unique type name
141 * @return TypeInfo if the type exists, otherwise an empty handle
143 TypeInfo GetTypeInfo( const std::string &uniqueTypeName );
146 * @brief Gets TypeInfo for a registered type.
149 * @param[in] registerType The registered type info
150 * @return TypeInfo if the type exists, otherwise an empty handle
152 TypeInfo GetTypeInfo( const std::type_info& registerType );
155 * @brief Gets type name count.
160 size_t GetTypeNameCount() const;
163 * @brief Gets type names by index.
166 * @param[in] index The index to get the type name
167 * @return The type name or an empty string when index is not valid
169 std::string GetTypeName(size_t index) const;
171 public: // Not intended for application developers
175 * @brief This constructor is used by Dali Get() method.
178 * @param[in] typeRegistry A pointer to a Dali resource
180 explicit DALI_INTERNAL TypeRegistry(Internal::TypeRegistry*typeRegistry);
185 * @brief Registers a type from type info.
188 class DALI_CORE_API TypeRegistration
192 * @brief Constructor registers the type creation function.
195 * @param[in] registerType The type info for the type to be registered
196 * @param[in] baseType The base type info of registerType
197 * @param[in] f registerType Instance creation function
199 TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
200 TypeInfo::CreateFunction f );
203 * @brief Constructor registers the type creation function.
206 * @param[in] registerType the type info for the type to be registered
207 * @param[in] baseType the base type info of registerType
208 * @param[in] f registerType instance creation function
209 * @param[in] callCreateOnInit If true the creation function is called as part of Dali initialization
211 TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
212 TypeInfo::CreateFunction f, bool callCreateOnInit );
215 * @brief Constructor registers the type creation function for a named class or type.
217 * This allows types to be created dynamically from script. The name must be
218 * unique for successful registration.
220 * @param[in] name the name of the type to be registered
221 * @param[in] baseType the base type info of registerType
222 * @param[in] f registerType instance creation function
224 TypeRegistration( const std::string& name, const std::type_info& baseType,
225 TypeInfo::CreateFunction f );
228 * @brief The name the type is registered under (derived from type_info).
231 * @return The registered name or empty if unregistered
233 const std::string RegisteredName() const;
236 TypeRegistry mReference; ///< Reference to the type registry
237 std::string mName; ///< Name of the type
241 * @brief Registers a signal connector function to a registered type.
244 class DALI_CORE_API SignalConnectorType
248 * @brief Constructor registers the type creation function.
251 * @param[in] typeRegistration The TypeRegistration object
252 * @param[in] name The signal name
253 * @param[in] func The signal connector function
255 SignalConnectorType( TypeRegistration& typeRegistration, const std::string& name, TypeInfo::SignalConnectorFunction func );
259 * @brief Registers an action function.
262 class DALI_CORE_API TypeAction
266 * @brief Constructor registers the type creation function.
269 * @param[in] registered The TypeRegistration object
270 * @param[in] name The action name
271 * @param[in] f The action function
273 TypeAction( TypeRegistration ®istered, const std::string &name, TypeInfo::ActionFunction f);
277 * @brief Registers a property for the given type.
280 class DALI_CORE_API PropertyRegistration
285 * @brief This constructor registers the property with the registered type.
287 * This constructor is for event-thread only properties where the
288 * value of the property can be retrieved and set via specified
291 * Functions of the following type may be used for setFunc and getFunc respectively:
293 * void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
294 * Property::Value GetProperty( BaseObject* object, Property::Index index );
298 * @param[in] registered The TypeRegistration object
299 * @param[in] name The name of the property
300 * @param[in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive
301 * @param[in] type The property value type
302 * @param[in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only
303 * @param[in] getFunc The function to call to retrieve the current value of the property. MUST be provided
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.
310 PropertyRegistration( TypeRegistration& registered,
311 const std::string& name, Property::Index index, Property::Type type,
312 TypeInfo::SetPropertyFunction setFunc, TypeInfo::GetPropertyFunction getFunc );
316 * @brief Registers an animatable property for the given type.
319 class DALI_CORE_API AnimatablePropertyRegistration
324 * @brief This constructor registers the animatable property with the registered type.
326 * This constructor is for scene-graph only properties where the
327 * value of the property can be retrieved and set via specified
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 * @pre "registered" must be registered with the TypeRegistry.
337 AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
340 * @brief This constructor registers the animatable property with the registered default value.
342 * This constructor is for scene-graph only properties where the
343 * value of the property can be retrieved and set via specified
347 * @param[in] registered The TypeRegistration object
348 * @param[in] name The name of the property
349 * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
350 * @param[in] value The property default value
351 * @pre "registered" must be registered with the TypeRegistry.
353 AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, const Property::Value& value );
357 * @brief Registers a component of animatable property for the given component index.
360 class DALI_CORE_API AnimatablePropertyComponentRegistration
365 * @brief This constructor registers a component of an animatable property where
366 * the base animatable property must be a property that supports property component
367 * (i.e. Vector2, Vector3 or Vector4) and the base animatable property must have
370 * This constructor is for a component of scene-graph only properties where the
371 * value of the property can be retrieved and set via specified functions.
374 * @param[in] registered The TypeRegistration object
375 * @param[in] name The name of the component
376 * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
377 * @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
378 * @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)
379 * @pre "registered" must be registered with the TypeRegistry.
381 AnimatablePropertyComponentRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Index baseIndex, unsigned int componentIndex );
385 * @brief Registers a child property for the given type.
388 class DALI_CORE_API ChildPropertyRegistration
393 * @brief This constructor registers an event-thread only child property (i.e. a property
394 * that the parent supports in its children) with the registered type.
397 * @param[in] registered The TypeRegistration object
398 * @param[in] name The name of the property
399 * @param[in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive
400 * @param[in] type The property value type
401 * @pre "registered" must be registered with the TypeRegistry.
403 ChildPropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
406 * @brief This constructor registers an event-thread only child property (i.e. a property
407 * that the parent supports in its children) with the registered type.
410 * @param[in] registered The name of the registered type
411 * @param[in] name The name of the property
412 * @param[in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive
413 * @param[in] type The property value type
414 * @pre "registered" must be registered with the TypeRegistry.
416 ChildPropertyRegistration( const std::string& registered, const std::string& name, Property::Index index, Property::Type type );