1 #ifndef DALI_TYPE_REGISTRY_H
2 #define DALI_TYPE_REGISTRY_H
5 * Copyright (c) 2020 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.
22 #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 struct 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 Move constructor.
141 * @param[in] rhs A reference to the moved handle
143 TypeRegistry(TypeRegistry&& rhs);
146 * @brief Move assignment operator.
149 * @param[in] rhs A reference to the moved handle
150 * @return A reference to this handle
152 TypeRegistry& operator=(TypeRegistry&& rhs);
155 * @brief Gets TypeInfo for a registered type.
158 * @param[in] uniqueTypeName A unique type name
159 * @return TypeInfo if the type exists, otherwise an empty handle
161 TypeInfo GetTypeInfo(const std::string& uniqueTypeName);
164 * @brief Gets TypeInfo for a registered type.
167 * @param[in] registerType The registered type info
168 * @return TypeInfo if the type exists, otherwise an empty handle
170 TypeInfo GetTypeInfo(const std::type_info& registerType);
173 * @brief Gets type name count.
178 size_t GetTypeNameCount() const;
181 * @brief Gets type names by index.
184 * @param[in] index The index to get the type name
185 * @return The type name or an empty string when index is not valid
187 std::string GetTypeName(size_t index) const;
189 public: // Not intended for application developers
192 * @brief This constructor is used by Dali Get() method.
195 * @param[in] typeRegistry A pointer to a Dali resource
197 explicit DALI_INTERNAL TypeRegistry(Internal::TypeRegistry* typeRegistry);
202 * @brief Registers a type from type info.
205 class DALI_CORE_API TypeRegistration
209 * @brief Constructor registers the type creation function.
212 * @param[in] registerType The type info for the type to be registered
213 * @param[in] baseType The base type info of registerType
214 * @param[in] f registerType Instance creation function
216 TypeRegistration(const std::type_info& registerType, const std::type_info& baseType, TypeInfo::CreateFunction f);
219 * @brief Constructor registers the type creation function.
222 * @param[in] registerType the type info for the type to be registered
223 * @param[in] baseType the base type info of registerType
224 * @param[in] f registerType instance creation function
225 * @param[in] callCreateOnInit If true the creation function is called as part of Dali initialization
227 TypeRegistration(const std::type_info& registerType, const std::type_info& baseType, TypeInfo::CreateFunction f, bool callCreateOnInit);
230 * @brief Constructor registers the type creation function.
233 * @param[in] registerType the type info for the type to be registered
234 * @param[in] baseType the base type info of registerType
235 * @param[in] f registerType instance creation function
236 * @param[in] defaultProperties the default property meta-data
238 TypeRegistration(const std::type_info& registerType, const std::type_info& baseType, TypeInfo::CreateFunction f, const DefaultPropertyMetadata& defaultProperties);
241 * @brief Constructor registers the type creation function for a named class or type.
243 * This allows types to be created dynamically from script. The name must be
244 * unique for successful registration.
246 * @param[in] name the name of the type to be registered
247 * @param[in] baseType the base type info of registerType
248 * @param[in] f registerType instance creation function
250 TypeRegistration(std::string name, const std::type_info& baseType, TypeInfo::CreateFunction f);
253 * @brief The name the type is registered under (derived from type_info).
256 * @return The registered name or empty if unregistered
258 const std::string& RegisteredName() const;
261 TypeRegistry mReference; ///< Reference to the type registry
262 std::string mName; ///< Name of the type
266 * @brief Registers a signal connector function to a registered type.
269 class DALI_CORE_API SignalConnectorType
273 * @brief Constructor registers the type creation function.
276 * @param[in] typeRegistration The TypeRegistration object
277 * @param[in] name The signal name
278 * @param[in] func The signal connector function
280 SignalConnectorType(TypeRegistration& typeRegistration, std::string name, TypeInfo::SignalConnectorFunction func);
284 * @brief Registers an action function.
287 class DALI_CORE_API TypeAction
291 * @brief Constructor registers the type creation function.
294 * @param[in] registered The TypeRegistration object
295 * @param[in] name The action name
296 * @param[in] f The action function
298 TypeAction(TypeRegistration& registered, std::string name, TypeInfo::ActionFunction f);
302 * @brief Registers a property for the given type.
305 class DALI_CORE_API PropertyRegistration
309 * @brief This constructor registers the property with the registered type.
311 * This constructor is for event-thread only properties where the
312 * value of the property can be retrieved and set via specified
315 * Functions of the following type may be used for setFunc and getFunc respectively:
317 * void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
318 * Property::Value GetProperty( BaseObject* object, Property::Index index );
322 * @param[in] registered The TypeRegistration object
323 * @param[in] name The name of the property
324 * @param[in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive
325 * @param[in] type The property value type
326 * @param[in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only
327 * @param[in] getFunc The function to call to retrieve the current value of the property. MUST be provided
328 * @pre "registered" must be registered with the TypeRegistry.
329 * @note The "index" value must be between START_INDEX and MAX_INDEX inclusive.
330 * @note If "setFunc" is NULL, then the property becomes a read-only property.
331 * @note "getFunc" MUST be provided.
334 PropertyRegistration(TypeRegistration& registered,
336 Property::Index index,
338 TypeInfo::SetPropertyFunction setFunc,
339 TypeInfo::GetPropertyFunction getFunc);
343 * @brief Registers an animatable property for the given type.
346 class DALI_CORE_API AnimatablePropertyRegistration
350 * @brief This constructor registers the animatable property with the registered type.
352 * This constructor is for scene-graph only properties where the
353 * value of the property can be retrieved and set via specified
357 * @param[in] registered The TypeRegistration object
358 * @param[in] name The name of the property
359 * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
360 * @param[in] type The property value type
361 * @pre "registered" must be registered with the TypeRegistry.
363 AnimatablePropertyRegistration(TypeRegistration& registered, std::string name, Property::Index index, Property::Type type);
366 * @brief This constructor registers the animatable property with the registered default value.
368 * This constructor is for scene-graph only properties where the
369 * value of the property can be retrieved and set via specified
373 * @param[in] registered The TypeRegistration object
374 * @param[in] name The name of the property
375 * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
376 * @param[in] value The property default value
377 * @pre "registered" must be registered with the TypeRegistry.
379 AnimatablePropertyRegistration(TypeRegistration& registered, std::string name, Property::Index index, const Property::Value& value);
383 * @brief Registers a component of animatable property for the given component index.
386 class DALI_CORE_API AnimatablePropertyComponentRegistration
390 * @brief This constructor registers a component of an animatable property where
391 * the base animatable property must be a property that supports property component
392 * (i.e. Vector2, Vector3 or Vector4) and the base animatable property must have
395 * This constructor is for a component of scene-graph only properties where the
396 * value of the property can be retrieved and set via specified functions.
399 * @param[in] registered The TypeRegistration object
400 * @param[in] name The name of the component
401 * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
402 * @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
403 * @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)
404 * @pre "registered" must be registered with the TypeRegistry.
406 AnimatablePropertyComponentRegistration(TypeRegistration& registered, std::string name, Property::Index index, Property::Index baseIndex, uint32_t componentIndex);
410 * @brief Registers a child property for the given type.
413 class DALI_CORE_API ChildPropertyRegistration
417 * @brief This constructor registers an event-thread only child property (i.e. a property
418 * that the parent supports in its children) with the registered type.
421 * @param[in] registered The TypeRegistration object
422 * @param[in] name The name of the property
423 * @param[in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive
424 * @param[in] type The property value type
425 * @pre "registered" must be registered with the TypeRegistry.
427 ChildPropertyRegistration(TypeRegistration& registered, std::string name, Property::Index index, Property::Type type);
430 * @brief This constructor registers an event-thread only child property (i.e. a property
431 * that the parent supports in its children) with the registered type.
434 * @param[in] registered The name of the registered type
435 * @param[in] name The name of the property
436 * @param[in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive
437 * @param[in] type The property value type
438 * @pre "registered" must be registered with the TypeRegistry.
440 ChildPropertyRegistration(std::string registered, std::string name, Property::Index index, Property::Type type);