1 #ifndef DALI_TYPE_REGISTRY_H
2 #define DALI_TYPE_REGISTRY_H
5 * Copyright (c) 2019 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.
23 #include <cstdint> // uint32_t
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
40 class DefaultPropertyMetadata;
43 * @brief The TypeRegistry allows registration of type instance creation functions.
45 * These can then be created later by name and down cast to the appropriate type.
47 * Usage: (Registering)
51 * // Note: object construction in namespace scope is defined in a translation unit as being
52 * // in appearance order (C++ standard 3.6/2). So TypeRegistration is declared first in
53 * // the cpp file below. Signal, action and property declarations follow in any order.
56 * TypeRegistration myActorType(typeid(MyActor), typeid(Actor), CreateMyActor );
58 * SignalConnectorType( myActorType, "highlighted", ConnectSignalForMyActor );
59 * TypeAction( myActorType, "open", DoMyActorAction );
60 * TypeAction( myActorType, "close", DoMyActorAction );
61 * PropertyRegistration( myActorType, "status", PropertyRegistration::START_INDEX, Property::BOOLEAN, SetPropertyFunction, GetPropertyFunction );
68 * TypeRegistry::TypeInfo type = TypeRegistry::Get().GetTypeInfo("MyActor");
69 * MyActor a = MyActor::DownCast(type.CreateInstance());
78 * Actors that inherit from the CustomActor framework must ensure the implementation
79 * class has an identical name to the Actor class. This is to ensure the class can be
80 * found at runtime for signals and actions. Otherwise these will silently fail.
82 * As namespaces are discarded the convention is to use a namespace ie
84 * 'class MyActor {}; namespace Internal { class MyActor {}; }'
86 * Warning: this arrangement will silently fail
88 * 'class MyActor {}; class MyActorImpl {};'
92 * Signal and action names follow properties and are by convention lower case hyphen
93 * separated ie 'next-page'. This maintains consistency with the scripted interface.
97 class DALI_CORE_API TypeRegistry : public BaseHandle
101 * @brief Gets Type Registry handle.
104 * @return TypeRegistry handle
106 static TypeRegistry Get();
109 * @brief Allows the creation of an empty typeRegistry handle.
121 * @brief This copy constructor is required for (smart) pointer semantics.
124 * @param[in] handle A reference to the copied handle
126 TypeRegistry(const TypeRegistry& handle);
129 * @brief This assignment operator is required for (smart) pointer semantics.
132 * @param[in] rhs A reference to the copied handle
133 * @return A reference to this
135 TypeRegistry& operator=(const TypeRegistry& rhs);
138 * @brief Gets TypeInfo for a registered type.
141 * @param[in] uniqueTypeName A unique type name
142 * @return TypeInfo if the type exists, otherwise an empty handle
144 TypeInfo GetTypeInfo( const std::string &uniqueTypeName );
147 * @brief Gets TypeInfo for a registered type.
150 * @param[in] registerType The registered type info
151 * @return TypeInfo if the type exists, otherwise an empty handle
153 TypeInfo GetTypeInfo( const std::type_info& registerType );
156 * @brief Gets type name count.
161 size_t GetTypeNameCount() const;
164 * @brief Gets type names by index.
167 * @param[in] index The index to get the type name
168 * @return The type name or an empty string when index is not valid
170 std::string GetTypeName(size_t index) const;
172 public: // Not intended for application developers
176 * @brief This constructor is used by Dali Get() method.
179 * @param[in] typeRegistry A pointer to a Dali resource
181 explicit DALI_INTERNAL TypeRegistry(Internal::TypeRegistry*typeRegistry);
186 * @brief Registers a type from type info.
189 class DALI_CORE_API TypeRegistration
193 * @brief Constructor registers the type creation function.
196 * @param[in] registerType The type info for the type to be registered
197 * @param[in] baseType The base type info of registerType
198 * @param[in] f registerType Instance creation function
200 TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
201 TypeInfo::CreateFunction f );
204 * @brief Constructor registers the type creation function.
207 * @param[in] registerType the type info for the type to be registered
208 * @param[in] baseType the base type info of registerType
209 * @param[in] f registerType instance creation function
210 * @param[in] callCreateOnInit If true the creation function is called as part of Dali initialization
212 TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
213 TypeInfo::CreateFunction f, bool callCreateOnInit );
216 * @brief Constructor registers the type creation function.
219 * @param[in] registerType the type info for the type to be registered
220 * @param[in] baseType the base type info of registerType
221 * @param[in] f registerType instance creation function
222 * @param[in] defaultProperties the default property meta-data
224 TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
225 TypeInfo::CreateFunction f, const DefaultPropertyMetadata& defaultProperties );
228 * @brief Constructor registers the type creation function for a named class or type.
230 * This allows types to be created dynamically from script. The name must be
231 * unique for successful registration.
233 * @param[in] name the name of the type to be registered
234 * @param[in] baseType the base type info of registerType
235 * @param[in] f registerType instance creation function
237 TypeRegistration( const std::string& name, const std::type_info& baseType,
238 TypeInfo::CreateFunction f );
241 * @brief The name the type is registered under (derived from type_info).
244 * @return The registered name or empty if unregistered
246 const std::string RegisteredName() const;
249 TypeRegistry mReference; ///< Reference to the type registry
250 std::string mName; ///< Name of the type
254 * @brief Registers a signal connector function to a registered type.
257 class DALI_CORE_API SignalConnectorType
261 * @brief Constructor registers the type creation function.
264 * @param[in] typeRegistration The TypeRegistration object
265 * @param[in] name The signal name
266 * @param[in] func The signal connector function
268 SignalConnectorType( TypeRegistration& typeRegistration, const std::string& name, TypeInfo::SignalConnectorFunction func );
272 * @brief Registers an action function.
275 class DALI_CORE_API TypeAction
279 * @brief Constructor registers the type creation function.
282 * @param[in] registered The TypeRegistration object
283 * @param[in] name The action name
284 * @param[in] f The action function
286 TypeAction( TypeRegistration ®istered, const std::string &name, TypeInfo::ActionFunction f);
290 * @brief Registers a property for the given type.
293 class DALI_CORE_API PropertyRegistration
298 * @brief This constructor registers the property with the registered type.
300 * This constructor is for event-thread only properties where the
301 * value of the property can be retrieved and set via specified
304 * Functions of the following type may be used for setFunc and getFunc respectively:
306 * void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
307 * Property::Value GetProperty( BaseObject* object, Property::Index index );
311 * @param[in] registered The TypeRegistration object
312 * @param[in] name The name of the property
313 * @param[in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive
314 * @param[in] type The property value type
315 * @param[in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only
316 * @param[in] getFunc The function to call to retrieve the current value of the property. MUST be provided
317 * @pre "registered" must be registered with the TypeRegistry.
318 * @note The "index" value must be between START_INDEX and MAX_INDEX inclusive.
319 * @note If "setFunc" is NULL, then the property becomes a read-only property.
320 * @note "getFunc" MUST be provided.
323 PropertyRegistration( TypeRegistration& registered,
324 const std::string& name, Property::Index index, Property::Type type,
325 TypeInfo::SetPropertyFunction setFunc, TypeInfo::GetPropertyFunction getFunc );
329 * @brief Registers an animatable property for the given type.
332 class DALI_CORE_API AnimatablePropertyRegistration
337 * @brief This constructor registers the animatable property with the registered type.
339 * This constructor is for scene-graph only properties where the
340 * value of the property can be retrieved and set via specified
344 * @param[in] registered The TypeRegistration object
345 * @param[in] name The name of the property
346 * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
347 * @param[in] type The property value type
348 * @pre "registered" must be registered with the TypeRegistry.
350 AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
353 * @brief This constructor registers the animatable property with the registered default value.
355 * This constructor is for scene-graph only properties where the
356 * value of the property can be retrieved and set via specified
360 * @param[in] registered The TypeRegistration object
361 * @param[in] name The name of the property
362 * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
363 * @param[in] value The property default value
364 * @pre "registered" must be registered with the TypeRegistry.
366 AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, const Property::Value& value );
370 * @brief Registers a component of animatable property for the given component index.
373 class DALI_CORE_API AnimatablePropertyComponentRegistration
378 * @brief This constructor registers a component of an animatable property where
379 * the base animatable property must be a property that supports property component
380 * (i.e. Vector2, Vector3 or Vector4) and the base animatable property must have
383 * This constructor is for a component of scene-graph only properties where the
384 * value of the property can be retrieved and set via specified functions.
387 * @param[in] registered The TypeRegistration object
388 * @param[in] name The name of the component
389 * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
390 * @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
391 * @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)
392 * @pre "registered" must be registered with the TypeRegistry.
394 AnimatablePropertyComponentRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Index baseIndex, uint32_t componentIndex );
398 * @brief Registers a child property for the given type.
401 class DALI_CORE_API ChildPropertyRegistration
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 TypeRegistration object
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( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
419 * @brief This constructor registers an event-thread only child property (i.e. a property
420 * that the parent supports in its children) with the registered type.
423 * @param[in] registered The name of the registered type
424 * @param[in] name The name of the property
425 * @param[in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive
426 * @param[in] type The property value type
427 * @pre "registered" must be registered with the TypeRegistry.
429 ChildPropertyRegistration( const std::string& registered, const std::string& name, Property::Index index, Property::Type type );