1 #ifndef __DALI_TYPE_REGISTRY_H__
2 #define __DALI_TYPE_REGISTRY_H__
5 * Copyright (c) 2015 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.
95 class DALI_IMPORT_API TypeRegistry : public BaseHandle
99 * @brief Get Type Registry handle.
101 * @return TypeRegistry handle
103 static TypeRegistry Get();
106 * @brief Allows the creation of an empty typeRegistry handle.
116 * @brief This copy constructor is required for (smart) pointer semantics.
118 * @param [in] handle A reference to the copied handle
120 TypeRegistry(const TypeRegistry& handle);
123 * @brief This assignment operator is required for (smart) pointer semantics.
125 * @param [in] rhs A reference to the copied handle
126 * @return A reference to this
128 TypeRegistry& operator=(const TypeRegistry& rhs);
131 * @brief Get TypeInfo for a registered type.
133 * @param [in] uniqueTypeName A unique type name
134 * @return TypeInfo if the type exists otherwise an empty handle
136 TypeInfo GetTypeInfo( const std::string &uniqueTypeName );
139 * @brief Get TypeInfo for a registered type.
141 * @param [in] registerType The registered type info
142 * @return TypeInfo if the type exists otherwise an empty handle
144 TypeInfo GetTypeInfo( const std::type_info& registerType );
147 * @brief Get type name count.
151 size_t GetTypeNameCount() const;
154 * @brief Get type names by index.
156 * @return The type name or an empty string when index is not valid
158 std::string GetTypeName(size_t index) const;
160 public: // Not intended for application developers
163 * @brief This constructor is used by Dali Get() method.
165 * @param [in] typeRegistry A pointer to a Dali resource
167 explicit DALI_INTERNAL TypeRegistry(Internal::TypeRegistry*typeRegistry);
171 * @brief Register a type from type info.
173 class DALI_IMPORT_API TypeRegistration
177 * @brief Constructor registers the type creation function.
179 * @param [in] registerType the type info for the type to be registered
180 * @param [in] baseType the base type info of registerType
181 * @param [in] f registerType instance creation function
183 TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
184 TypeInfo::CreateFunction f );
187 * @brief Constructor registers the type creation function.
189 * @param [in] registerType the type info for the type to be registered
190 * @param [in] baseType the base type info of registerType
191 * @param [in] f registerType instance creation function
192 * @param [in] callCreateOnInit If true the creation function is called as part of Dali initialisation
194 TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
195 TypeInfo::CreateFunction f, bool callCreateOnInit );
198 * @brief Constructor registers the type creation function for a named class or type.
200 * This allows types to be created dynamically from script. The name must be
201 * unique for successful registration.
202 * @param [in] name the name of the type to be registered
203 * @param [in] baseType the base type info of registerType
204 * @param [in] f registerType instance creation function
206 TypeRegistration( const std::string& name, const std::type_info& baseType,
207 TypeInfo::CreateFunction f );
210 * @brief The name the type is registered under (derived from type_info).
212 * @return the registered name or empty if unregistered
214 const std::string RegisteredName() const;
217 TypeRegistry mReference; ///< Reference to the type registry
218 std::string mName; ///< Name of the type
222 * @brief Register a signal connector function to a registered type.
224 class DALI_IMPORT_API SignalConnectorType
228 * @brief Constructor registers the type creation function.
230 * @param [in] typeRegistration The TypeRegistration object
231 * @param [in] name The signal name
232 * @param [in] func The signal connector function
234 SignalConnectorType( TypeRegistration& typeRegistration, const std::string& name, TypeInfo::SignalConnectorFunction func );
238 * @brief Register an action function.
240 class DALI_IMPORT_API TypeAction
244 * @brief Constructor registers the type creation function.
246 * @param [in] registered The TypeRegistration object
247 * @param [in] name The action name
248 * @param [in] f The action function
250 TypeAction( TypeRegistration ®istered, const std::string &name, TypeInfo::ActionFunction f);
254 * @brief Register a property for the given type.
256 class DALI_IMPORT_API PropertyRegistration
261 * @brief This constructor registers the property with the registered type.
263 * This constructor is for event-thread only properties where the
264 * value of the property can be retrieved and set via specified
267 * Functions of the following type may be used for setFunc and getFunc respectively:
269 * void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
270 * Property::Value GetProperty( BaseObject* object, Property::Index index );
273 * @param [in] registered The TypeRegistration object
274 * @param [in] name The name of the property
275 * @param [in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive.
276 * @param [in] type The property value type.
277 * @param [in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only.
278 * @param [in] getFunc The function to call to retrieve the current value of the property. MUST be provided.
280 * @note The "index" value must be between START_INDEX and MAX_INDEX inclusive.
281 * @note If "setFunc" is NULL, then the property becomes a read-only property.
282 * @note "getFunc" MUST be provided
284 * @pre "registered" must be registered with the TypeRegistry.
286 PropertyRegistration( TypeRegistration& registered,
287 const std::string& name, Property::Index index, Property::Type type,
288 TypeInfo::SetPropertyFunction setFunc, TypeInfo::GetPropertyFunction getFunc );
292 * @brief Register an animatable property for the given type.
294 class DALI_IMPORT_API AnimatablePropertyRegistration
299 * @brief This constructor registers the animatable property with the registered type.
301 * This constructor is for scene-graph only properties where the
302 * value of the property can be retrieved and set via specified
305 * @param [in] registered The TypeRegistration object
306 * @param [in] name The name of the property
307 * @param [in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
308 * @param [in] type The property value type.
310 * @pre "registered" must be registered with the TypeRegistry.
312 AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
316 * @brief Register a component of animatable property for the given component index.
318 class DALI_IMPORT_API AnimatablePropertyComponentRegistration
323 * @brief This constructor registers a component of an animatable property where
324 * the base animatable property must be a property that supports property component
325 * (i.e. Vector2, Vector3 or Vector4) and the base animatable property must have
328 * This constructor is for a component of scene-graph only properties where the
329 * value of the property can be retrieved and set via specified functions.
331 * @param [in] registered The TypeRegistration object
332 * @param [in] name The name of the component
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] 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.
335 * @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).
337 * @pre "registered" must be registered with the TypeRegistry.
339 AnimatablePropertyComponentRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Index baseIndex, unsigned int componentIndex );