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 <boost/function.hpp>
  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 SLP 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 language of the device is changed.
  80      */
  81     virtual void OnLanguageChanged() {}
  82   };
  83
  84 public:
  85
  86   /**
  87    * Constructor
  88    * @param[in]  observer  The observer of the Framework.
  89    * @param[in]  argc      A pointer to the number of arguments.
  90    * @param[in]  argv      A pointer the the argument list.
  91    */
  92   Framework(Observer& observer, int* argc, char ***argv, const std::string& name);
  93
  94   /**
  95    * Destructor
  96    */
  97   ~Framework();
  98
  99 public:
 100
 101   /**
 102    * Runs the main loop of framework
 103    */
 104   void Run();
 105
 106   /**
 107    * Quits the main loop
 108    */
 109   void Quit();
 110
 111   /**
 112    * Checks whether the main loop of the framework is running.
 113    * @return true, if the main loop is running, false otherwise.
 114    */
 115   bool IsMainLoopRunning();
 116
 117   /**
 118    * If the main loop aborts unexpectedly, then the connected callback function is called.
 119    * @param[in]  callBack  The function to call.
 120    * @note Only one callback can be registered.  The last callback to be set will be called on abort.
 121    */
 122   void AddAbortCallback(boost::function<void(void)> callBack);
 123
 124   /**
 125    * Gets bundle name which was passed in app_reset callback.
 126    */
 127   std::string GetBundleName() const;
 128
 129   /**
 130    * Gets bundle id which was passed in app_reset callback.
 131    */
 132   std::string GetBundleId() const;
 133
 134 private:
 135
 136   // Undefined
 137   Framework(const Framework&);
 138   Framework& operator=(Framework&);
 139
 140 private:
 141   /**
 142    * Called by the SLP framework when an application lifecycle event occurs.
 143    * @param[in]  type  The type of event occurred.
 144    */
 145   bool SlpAppStatusHandler(int type);
 146
 147   /**
 148    * Called app_reset callback was called with bundle.
 149    */
 150   void SetBundleName(const std::string& name);
 151
 152   /**
 153    * Called app_reset callback was called with bundle.
 154    */
 155   void SetBundleId(const std::string& id);
 156
 157   /**
 158    * Called if the application is aborted.
 159    */
 160   void AbortCallback();
 161
 162   /**
 163    * Called for initializing on specified backend. (X11 or Wayland)
 164    */
 165   void InitThreads();
 166
 167 private:
 168   Observer&          mObserver;
 169   bool               mInitialised;
 170   bool               mRunning;
 171   int*               mArgc;
 172   char***            mArgv;
 173   std::string        mName;
 174   std::string        mBundleName;
 175   std::string        mBundleId;
 176   AbortHandler       mAbortHandler;
 177
 178 private: // impl members
 179
 180   struct Impl;
 181   Impl* mImpl;
 182
 183 };
 184
 185 } // namespace Adaptor
 186
 187 } // namespace Internal
 188
 189 } // namespace Dali
 190
 191 #endif // __DALI_INTERNAL_FRAMEWORK_H__