1 #ifndef DALI_INTERNAL_OBJECT_REGISTRY_H
2 #define DALI_INTERNAL_OBJECT_REGISTRY_H
5 * Copyright (c) 2021 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 <dali/public-api/object/base-object.h>
23 #include <dali/public-api/object/object-registry.h>
24 #include <dali/public-api/object/ref-object.h>
39 using ObjectRegistryPtr = IntrusivePtr<ObjectRegistry>;
42 * The ObjectRegistry notifies it's observers when an object is created.
43 * There is a single instance of Object registry for each Dali-core instance.
44 * All Dali Objects need to register with ObjectRegistry to be observed by
45 * feedback plugin's and other observers.
47 class ObjectRegistry : public BaseObject
51 * Create the objectRegistry
53 static ObjectRegistryPtr New();
56 * Registers the Object into the Object Registry, which notifies
57 * about this object creation to its observers using signals. As
58 * the signals use a BaseHandle, the object must already have a
59 * ref-count > 0, otherwise it will get deleted on signal completion.
60 * @pre The object is not already registered.
61 * @pre the object is ref counted (held in an intrusive pointer)
62 * @param[in] object Pointer to the object.
64 void RegisterObject(Dali::BaseObject* object);
67 * Unregisters the Object from the Object Registry, Which notifies
68 * about this object destruction to its observers.
69 * @pre The object is already registered.
70 * @param[in] object Pointer to the object.
72 void UnregisterObject(Dali::BaseObject* object);
75 * @copydoc Dali::ObjectRegistry::ObjectCreatedSignal()
77 Dali::ObjectRegistry::ObjectCreatedSignalType& ObjectCreatedSignal()
79 return mObjectCreatedSignal;
83 * @copydoc Dali::ObjectRegistry::ObjectDestroyedSignal()
85 Dali::ObjectRegistry::ObjectDestroyedSignalType& ObjectDestroyedSignal()
87 return mObjectDestroyedSignal;
91 * Connects a callback function with the object registry signals.
92 * @param[in] object The object providing the signal.
93 * @param[in] tracker Used to disconnect the signal.
94 * @param[in] signalName The signal to connect to.
95 * @param[in] functor A newly allocated FunctorDelegate.
96 * @return True if the signal was connected.
97 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
99 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
103 * Protected constructor; see also ObjectRegistry::New()
108 * A reference counted object may only be deleted by calling Unreference()
110 ~ObjectRegistry() override;
113 Dali::ObjectRegistry::ObjectCreatedSignalType mObjectCreatedSignal;
114 Dali::ObjectRegistry::ObjectDestroyedSignalType mObjectDestroyedSignal;
117 } // namespace Internal
119 // Helpers for public-api forwarding methods
121 inline Internal::ObjectRegistry& GetImplementation(Dali::ObjectRegistry& objectRegistry)
123 DALI_ASSERT_ALWAYS(objectRegistry && "ObjectRegistry handle is empty");
125 BaseObject& handle = objectRegistry.GetBaseObject();
127 return static_cast<Internal::ObjectRegistry&>(handle);
130 inline const Internal::ObjectRegistry& GetImplementation(const Dali::ObjectRegistry& objectRegistry)
132 DALI_ASSERT_ALWAYS(objectRegistry && "ObjectRegistry handle is empty");
134 const BaseObject& handle = objectRegistry.GetBaseObject();
136 return static_cast<const Internal::ObjectRegistry&>(handle);
141 #endif // DALI_INTERNAL_OBJECT_REGISTRY_H