dali/internal/event/common/object-registry-impl.h

   1 #ifndef DALI_INTERNAL_OBJECT_REGISTRY_H
   2 #define DALI_INTERNAL_OBJECT_REGISTRY_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/object/ref-object.h>
  23 #include <dali/public-api/object/object-registry.h>
  24 #include <dali/public-api/object/base-object.h>
  25
  26 namespace Dali
  27 {
  28
  29 struct Vector2;
  30
  31 namespace Internal
  32 {
  33
  34 namespace SceneGraph
  35 {
  36 class UpdateManager;
  37 }
  38
  39 class ObjectRegistry;
  40
  41 using ObjectRegistryPtr = IntrusivePtr<ObjectRegistry>;
  42
  43 /**
  44  * The ObjectRegistry notifies it's observers when an object is created.
  45  * There is a single instance of Object registry for each Dali-core instance.
  46  * All Dali Objects need to register with ObjectRegistry to be observed by
  47  * feedback plugin's and other observers.
  48  */
  49 class ObjectRegistry : public BaseObject
  50 {
  51 public:
  52
  53   /**
  54    * Create the objectRegistry
  55    */
  56   static ObjectRegistryPtr New();
  57
  58   /**
  59    * Registers the Object into the Object Registry, which notifies
  60    * about this object creation to its observers using signals. As
  61    * the signals use a BaseHandle, the object must already have a
  62    * ref-count > 0, otherwise it will get deleted on signal completion.
  63    * @pre The object is not already registered.
  64    * @pre the object is ref counted (held in an intrusive pointer)
  65    * @param[in] object Pointer to the object.
  66    */
  67   void RegisterObject( Dali::BaseObject* object );
  68
  69   /**
  70    * Unregisters the Object from the Object Registry, Which notifies
  71    * about this object destruction to its observers.
  72    * @pre The object is already registered.
  73    * @param[in] object Pointer to the object.
  74    */
  75   void UnregisterObject( Dali::BaseObject* object );
  76
  77   /**
  78    * @copydoc Dali::ObjectRegistry::ObjectCreatedSignal()
  79    */
  80   Dali::ObjectRegistry::ObjectCreatedSignalType& ObjectCreatedSignal()
  81   {
  82     return mObjectCreatedSignal;
  83   }
  84
  85   /**
  86    * @copydoc Dali::ObjectRegistry::ObjectDestroyedSignal()
  87    */
  88   Dali::ObjectRegistry::ObjectDestroyedSignalType& ObjectDestroyedSignal()
  89   {
  90     return mObjectDestroyedSignal;
  91   }
  92
  93   /**
  94    * Connects a callback function with the object registry signals.
  95    * @param[in] object The object providing the signal.
  96    * @param[in] tracker Used to disconnect the signal.
  97    * @param[in] signalName The signal to connect to.
  98    * @param[in] functor A newly allocated FunctorDelegate.
  99    * @return True if the signal was connected.
 100    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 101    */
 102   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 103
 104 private:
 105
 106   /**
 107    * Protected constructor; see also ObjectRegistry::New()
 108    */
 109   ObjectRegistry();
 110
 111   /**
 112    * A reference counted object may only be deleted by calling Unreference()
 113    */
 114   ~ObjectRegistry();
 115
 116 private:
 117
 118   Dali::ObjectRegistry::ObjectCreatedSignalType mObjectCreatedSignal;
 119   Dali::ObjectRegistry::ObjectDestroyedSignalType mObjectDestroyedSignal;
 120
 121 };
 122
 123 } // namespace Internal
 124
 125 // Helpers for public-api forwarding methods
 126
 127 inline Internal::ObjectRegistry& GetImplementation(Dali::ObjectRegistry& objectRegistry)
 128 {
 129   DALI_ASSERT_ALWAYS( objectRegistry && "ObjectRegistry handle is empty" );
 130
 131   BaseObject& handle = objectRegistry.GetBaseObject();
 132
 133   return static_cast<Internal::ObjectRegistry&>(handle);
 134 }
 135
 136 inline const Internal::ObjectRegistry& GetImplementation(const Dali::ObjectRegistry& objectRegistry)
 137 {
 138   DALI_ASSERT_ALWAYS( objectRegistry && "ObjectRegistry handle is empty" );
 139
 140   const BaseObject& handle = objectRegistry.GetBaseObject();
 141
 142   return static_cast<const Internal::ObjectRegistry&>(handle);
 143 }
 144
 145 } // namespace Dali
 146
 147 #endif // DALI_INTERNAL_OBJECT_REGISTRY_H