dali/devel-api/adaptor-framework/singleton-service.h

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