dali/devel-api/common/singleton-service.h

   1 #ifndef DALI_SINGELTON_SERVICE_H
   2 #define DALI_SINGELTON_SERVICE_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23 #include <typeinfo>
  24
  25 namespace Dali
  26 {
  27 namespace Internal DALI_INTERNAL
  28 {
  29 class ThreadLocalStorage;
  30 }
  31
  32 /**
  33  * @brief Allows the registration of a class as a singleton
  34  *
  35  * @note This class is created by the Application class and is destroyed when the Application class is destroyed.
  36  *
  37  * @see Application
  38  */
  39 class DALI_CORE_API SingletonService : public BaseHandle
  40 {
  41 public:
  42   /**
  43    * @brief Create an uninitialized handle.
  44    *
  45    * This can be initialized by calling SingletonService::Get().
  46    */
  47   SingletonService();
  48
  49   /**
  50    * @brief Retrieves a handle to the SingletonService.
  51    *
  52    * @return A handle to the SingletonService if it is available. This will be an empty handle if
  53    *         the service is not available.
  54    */
  55   static SingletonService Get();
  56
  57   /**
  58    * @brief Destructor
  59    *
  60    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  61    */
  62   ~SingletonService();
  63
  64   /**
  65    * @brief Registers the singleton of Dali handle with its type info.
  66    *
  67    * The singleton will be kept alive for the lifetime of the service.
  68    *
  69    * @note This is not intended for application developers.
  70    * @param[in] info The type info of the Dali handle generated by the compiler.
  71    * @param[in] singleton The Dali handle to be registered
  72    */
  73   void Register(const std::type_info& info, BaseHandle singleton);
  74
  75   /**
  76    * @brief Unregisters all singletons.
  77    *
  78    * @note This is not intended for application developers.
  79    */
  80   void UnregisterAll();
  81
  82   /**
  83    * @brief Gets the singleton for the given type.
  84    *
  85    * @note This is not intended for application developers.
  86    * @param[in] info The type info of the given type.
  87    * @return the Dali handle if it is registered as a singleton or an uninitialized handle.
  88    */
  89   BaseHandle GetSingleton(const std::type_info& info) const;
  90
  91 public: // Not intended for application developers
  92   /**
  93    * @brief This constructor is used by SingletonService::Get().
  94    * @param[in] singletonService A pointer to the internal singleton-service object.
  95    */
  96   explicit DALI_INTERNAL SingletonService(Internal::ThreadLocalStorage* singletonService);
  97 };
  98
  99 } // namespace Dali
 100
 101 #endif // DALI_SINGELTON_SERVICE_H