dali/internal/system/android/callback-manager-android.h

   1 #ifndef DALI_INTERNAL_ADAPTOR_SYSTEM_ANDROID_CALLBACK_MANAGER_H
   2 #define DALI_INTERNAL_ADAPTOR_SYSTEM_ANDROID_CALLBACK_MANAGER_H
   3
   4 /*
   5  * Copyright (c) 2023 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 <list>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/internal/system/common/callback-manager.h>
  26
  27 namespace Dali
  28 {
  29 namespace Internal
  30 {
  31 namespace Adaptor
  32 {
  33 struct CallbackData;
  34
  35 /**
  36  * Ecore interface to install call backs in the applications main loop.
  37  */
  38 class AndroidCallbackManager : public CallbackManager
  39 {
  40 public:
  41   /**
  42    * @brief constructor
  43    */
  44   AndroidCallbackManager();
  45
  46   /**
  47    * @brief destructor
  48    */
  49   ~AndroidCallbackManager() = default;
  50
  51   /**
  52    * @copydoc CallbackManager::AddIdleCallback()
  53    */
  54   bool AddIdleCallback(CallbackBase* callback, bool hasReturnValue) override;
  55
  56   /**
  57    * @copydoc CallbackManager::RemoveIdleCallback()
  58    */
  59   void RemoveIdleCallback(CallbackBase* callback) override;
  60
  61   /**
  62    * @copydoc CallbackManager::ProcessIdle()
  63    */
  64   bool ProcessIdle() override;
  65
  66   /**
  67    * @copydoc CallbackManager::ProcessIdle()
  68    */
  69   void ClearIdleCallbacks() override;
  70
  71   /**
  72    * @copydoc CallbackManager::AddIdleEntererCallback()
  73    */
  74   bool AddIdleEntererCallback(CallbackBase* callback) override;
  75
  76   /**
  77    * @copydoc CallbackManager::RemoveIdleEntererCallback()
  78    */
  79   void RemoveIdleEntererCallback(CallbackBase* callback) override;
  80
  81   /**
  82    * @copydoc CallbackManager::Start()
  83    */
  84   void Start() override;
  85
  86   /**
  87    * @copydoc CallbackManager::Stop()
  88    */
  89   void Stop() override;
  90
  91 private:
  92   /**
  93    * @brief Remove all idle call backs that are pending
  94    * Called by Stop()
  95    * Always called from the main thread
  96    */
  97   void RemoveAllCallbacks();
  98
  99   /**
 100    * @brief Removes a single call back from the container
 101    * Always called from main thread
 102    * @param callbackData callback data
 103    */
 104   void RemoveCallbackFromContainer(CallbackData* callbackData);
 105
 106   /**
 107    * @brief Remove a standard call back from ecore
 108    * Always called from main thread
 109    * @param callbackData callback data
 110    */
 111   void RemoveStandardCallback(CallbackData* callbackData);
 112
 113   // Undefined
 114   AndroidCallbackManager(const AndroidCallbackManager&) = delete;
 115   AndroidCallbackManager& operator=(AndroidCallbackManager&) = delete;
 116
 117 private:
 118   typedef std::list<CallbackData*> CallbackList;
 119
 120   bool         mRunning;           ///< flag is set to true if when running
 121   CallbackList mCallbackContainer; ///< container of live idle callbacks
 122 };
 123
 124 } // namespace Adaptor
 125
 126 } // namespace Internal
 127
 128 } // namespace Dali
 129
 130 #endif // DALI_INTERNAL_ADAPTOR_SYSTEM_ANDROID_CALLBACK_MANAGER_H