adaptors/common/framework.h

   1 #ifndef __DALI_INTERNAL_FRAMEWORK_H__
   2 #define __DALI_INTERNAL_FRAMEWORK_H__
   3
   4 /*
   5  * Copyright (c) 2014 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 <string>
  23 #include <dali/public-api/signals/callback.h>
  24
  25 // INTERNAL INCLUDES
  26 #include "abort-handler.h"
  27
  28 namespace Dali
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 namespace Adaptor
  35 {
  36
  37 /**
  38  * The Framework class is used to register callbacks with the TIZEN platform so that
  39  * we know when any of the application lifecycle events occur.  This includes events
  40  * like when our application is to be initialised, terminated, paused, resumed etc.
  41  */
  42 class Framework
  43 {
  44 public:
  45
  46   /**
  47    * Observer class for the framework.
  48    */
  49   class Observer
  50   {
  51   public:
  52
  53     /**
  54      * Invoked when the application is to be initialised.
  55      */
  56     virtual void OnInit() {}
  57
  58     /**
  59      * Invoked when the application is to be terminated.
  60      */
  61     virtual void OnTerminate() {}
  62
  63     /**
  64      * Invoked when the application is to be paused.
  65      */
  66     virtual void OnPause() {}
  67
  68     /**
  69      * Invoked when the application is to be resumed.
  70      */
  71     virtual void OnResume() {}
  72
  73     /**
  74      * Invoked when the application is to be reset.
  75      */
  76     virtual void OnReset() {}
  77
  78     /**
  79     * Invoked when the AppControl message is received.
  80     * @param[in] The bundle data of AppControl message.
  81     */
  82     virtual void OnAppControl(void *) {}
  83
  84     /**
  85      * Invoked when the language of the device is changed.
  86      */
  87     virtual void OnLanguageChanged() {}
  88
  89     /**
  90     * Invoked when the region is changed.
  91     */
  92     virtual void OnRegionChanged() {}
  93
  94     /**
  95     * Invoked when the battery level of the device is low.
  96     */
  97     virtual void OnBatteryLow() {}
  98
  99     /**
 100     * Invoked when the memory level of the device is low.
 101     */
 102     virtual void OnMemoryLow() {}
 103   };
 104
 105 public:
 106
 107   /**
 108    * Constructor
 109    * @param[in]  observer  The observer of the Framework.
 110    * @param[in]  argc      A pointer to the number of arguments.
 111    * @param[in]  argv      A pointer the the argument list.
 112    */
 113   Framework(Observer& observer, int* argc, char ***argv, const std::string& name);
 114
 115   /**
 116    * Destructor
 117    */
 118   ~Framework();
 119
 120 public:
 121
 122   /**
 123    * Runs the main loop of framework
 124    */
 125   void Run();
 126
 127   /**
 128    * Quits the main loop
 129    */
 130   void Quit();
 131
 132   /**
 133    * Checks whether the main loop of the framework is running.
 134    * @return true, if the main loop is running, false otherwise.
 135    */
 136   bool IsMainLoopRunning();
 137
 138   /**
 139    * If the main loop aborts unexpectedly, then the connected callback function is called.
 140    * @param[in]  callBack  The function to call.
 141    * @note Only one callback can be registered.  The last callback to be set will be called on abort.
 142    * @note The ownership of callback is passed onto this class.
 143    */
 144   void AddAbortCallback( CallbackBase* callback );
 145
 146   /**
 147    * Gets bundle name which was passed in app_reset callback.
 148    */
 149   std::string GetBundleName() const;
 150
 151   /**
 152    * Gets bundle id which was passed in app_reset callback.
 153    */
 154   std::string GetBundleId() const;
 155
 156 private:
 157
 158   // Undefined
 159   Framework(const Framework&);
 160   Framework& operator=(Framework&);
 161
 162 private:
 163   /**
 164    * Called by the App framework when an application lifecycle event occurs.
 165    * @param[in] type The type of event occurred.
 166    * @param[in] bundleData The bundle data of event occurred.
 167    */
 168   bool AppStatusHandler(int type, void *bundleData);
 169
 170   /**
 171    * Called app_reset callback was called with bundle.
 172    */
 173   void SetBundleName(const std::string& name);
 174
 175   /**
 176    * Called app_reset callback was called with bundle.
 177    */
 178   void SetBundleId(const std::string& id);
 179
 180   /**
 181    * Called if the application is aborted.
 182    */
 183   void AbortCallback();
 184
 185   /**
 186    * Called for initializing on specified backend. (X11 or Wayland)
 187    */
 188   void InitThreads();
 189
 190 private:
 191   Observer&          mObserver;
 192   bool               mInitialised;
 193   bool               mRunning;
 194   int*               mArgc;
 195   char***            mArgv;
 196   std::string        mName;
 197   std::string        mBundleName;
 198   std::string        mBundleId;
 199   AbortHandler       mAbortHandler;
 200
 201 private: // impl members
 202
 203   struct Impl;
 204   Impl* mImpl;
 205
 206 };
 207
 208 } // namespace Adaptor
 209
 210 } // namespace Internal
 211
 212 } // namespace Dali
 213
 214 #endif // __DALI_INTERNAL_FRAMEWORK_H__