dali/internal/adaptor/common/application-impl.h

   1 #ifndef DALI_INTERNAL_APPLICATION_H
   2 #define DALI_INTERNAL_APPLICATION_H
   3
   4 /*
   5  * Copyright (c) 2018 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/math/rect.h>
  23 #include <dali/public-api/object/base-object.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/adaptor-framework/application.h>
  27 #include <dali/devel-api/adaptor-framework/singleton-service.h>
  28
  29 #include <dali/internal/adaptor/common/framework.h>
  30 #include <dali/internal/window-system/common/window-impl.h>
  31 #include <dali/internal/system/common/environment-options.h>
  32 #include <dali/internal/adaptor/common/adaptor-builder-impl.h>
  33
  34 namespace Dali
  35 {
  36 class Adaptor;
  37 class Window;
  38
  39 namespace Internal
  40 {
  41
  42 namespace Adaptor
  43 {
  44
  45 namespace Launchpad
  46 {
  47
  48 /**
  49  * @brief Launchpad is used to improve application launch performance.
  50  * When an application is pre-initialized, so files are preloaded, some functions are initialized and a window is made in advance.
  51  */
  52 enum State
  53 {
  54   NONE,              ///< The default state
  55   PRE_INITIALIZED    ///< Application is pre-initialized.
  56 };
  57
  58 } // namespace Launchpad
  59
  60 class CommandLineOptions;
  61 class EventLoop;
  62
  63 typedef Dali::Rect<int> PositionSize;
  64
  65 class Application;
  66 typedef IntrusivePtr<Application> ApplicationPtr;
  67
  68 /**
  69  * Implementation of the Application class.
  70  */
  71 class Application : public BaseObject, public Framework::Observer
  72 {
  73 public:
  74
  75   typedef Dali::Application::LowBatterySignalType LowBatterySignalType;
  76   typedef Dali::Application::LowMemorySignalType LowMemorySignalType;
  77   typedef Dali::Application::AppSignalType AppSignalType;
  78   typedef Dali::Application::AppControlSignalType AppControlSignalType;
  79   typedef Dali::Application::WINDOW_MODE WINDOW_MODE;
  80
  81   /**
  82    * Create a new application
  83    * @param[in]  argc         A pointer to the number of arguments
  84    * @param[in]  argv         A pointer to the argument list
  85    * @param[in]  stylesheet   The path to user defined theme file
  86    * @param[in]  windowMode   A member of Dali::Application::WINDOW_MODE
  87    * @param[in]  positionSize A position and a size of the window
  88    * @param[in]  applicationType  A member of Dali::Framework::Type
  89    */
  90   static ApplicationPtr New( int* argc, char **argv[], const std::string& stylesheet,
  91     WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType );
  92
  93   /**
  94    * @copydoc Dali::DevelApplication::PreInitialize()
  95    */
  96   static void PreInitialize( int* argc, char** argv[] );
  97
  98 public:
  99
 100   /**
 101    * @copydoc Dali::Application::MainLoop()
 102    */
 103   void MainLoop(Dali::Configuration::ContextLoss configuration);
 104
 105   /**
 106    * @copydoc Dali::Application::Lower()
 107    */
 108   void Lower();
 109
 110   /**
 111    * @copydoc Dali::Application::Quit()
 112    */
 113   void Quit();
 114
 115   /**
 116    * @copydoc Dali::Application::AddIdle()
 117    */
 118   bool AddIdle( CallbackBase* callback, bool hasReturnValue );
 119
 120   /**
 121    * @copydoc Dali::Application::GetAdaptor();
 122    */
 123   Dali::Adaptor& GetAdaptor();
 124
 125   /**
 126    * @copydoc Dali::Application::GetWindow();
 127    */
 128   Dali::Window GetWindow();
 129
 130   /**
 131    * @copydoc Dali::Application::GetRegion();
 132    */
 133   std::string GetRegion() const;
 134
 135   /**
 136    * @copydoc Dali::Application::GetLanguage();
 137    */
 138   std::string GetLanguage() const;
 139
 140   /**
 141    * @copydoc Dali::Application::ReplaceWindow();
 142    */
 143   void ReplaceWindow( const PositionSize& positionSize, const std::string& name);
 144
 145   /**
 146    * @copydoc Dali::Application::GetResourcePath();
 147    */
 148   static std::string GetResourcePath();
 149
 150   /**
 151    * Retrieves the pre-initialized application.
 152    *
 153    * @return A pointer to the pre-initialized application
 154    */
 155   static ApplicationPtr GetPreInitializedApplication();
 156
 157 public: // Lifecycle functionality
 158
 159   /**
 160    * Called when OnInit is called or the framework is initialised.
 161    */
 162   void DoInit();
 163
 164   /**
 165    * Called after OnInit is called or the framework is started.
 166    */
 167   void DoStart();
 168
 169   /**
 170    * Called when OnTerminate is called or the framework is terminated.
 171    */
 172   void DoTerminate();
 173
 174   /**
 175    * Called when OnPause is called or the framework is paused.
 176    */
 177   void DoPause();
 178
 179   /**
 180    * Called when OnResume is called or the framework resumes from a paused state.
 181    */
 182   void DoResume();
 183
 184   /**
 185    * Called when OnLanguageChanged is called or the framework informs the application that the language of the device has changed.
 186    */
 187   void DoLanguageChange();
 188
 189 public: // From Framework::Observer
 190
 191   /**
 192    * Called when the framework is initialised.
 193    */
 194   virtual void OnInit();
 195
 196   /**
 197    * Called when the framework is terminated.
 198    */
 199   virtual void OnTerminate();
 200
 201   /**
 202    * Called when the framework is paused.
 203    */
 204   virtual void OnPause();
 205
 206   /**
 207    * Called when the framework resumes from a paused state.
 208    */
 209   virtual void OnResume();
 210
 211   /**
 212   * Called when the framework received AppControlSignal.
 213   * @param[in] The bundle data of AppControl event.
 214   */
 215   virtual void OnAppControl(void *data);
 216
 217   /**
 218    * Called when the framework informs the application that it should reset itself.
 219    */
 220   virtual void OnReset();
 221
 222   /**
 223    * Called when the framework informs the application that the language of the device has changed.
 224    */
 225   virtual void OnLanguageChanged();
 226
 227   /**
 228   * Called when the framework informs the application that the region of the device has changed.
 229   */
 230   virtual void OnRegionChanged();
 231
 232   /**
 233   * Called when the framework informs the application that the battery level of the device is low.
 234   */
 235   virtual void OnBatteryLow( Dali::DeviceStatus::Battery::Status status );
 236
 237   /**
 238   * Called when the framework informs the application that the memory level of the device is low.
 239   */
 240   virtual void OnMemoryLow( Dali::DeviceStatus::Memory::Status status );
 241
 242 public:
 243
 244   /**
 245    * Signal handler when the adaptor's window resizes itself.
 246    * @param[in]  adaptor  The adaptor
 247    */
 248   void OnResize(Dali::Adaptor& adaptor);
 249
 250   /**
 251    * Sets a user defined theme file.
 252    * This should be called before initialization.
 253    * @param[in] stylesheet The path to user defined theme file
 254    */
 255   void SetStyleSheet( const std::string& stylesheet );
 256
 257 public:  // Signals
 258
 259   /**
 260    * @copydoc Dali::Application::InitSignal()
 261    */
 262   Dali::Application::AppSignalType& InitSignal() { return mInitSignal; }
 263
 264   /**
 265    * @copydoc Dali::Application::TerminateSignal()
 266    */
 267   Dali::Application::AppSignalType& TerminateSignal() { return mTerminateSignal; }
 268
 269   /**
 270    * @copydoc Dali::Application::PauseSignal()
 271    */
 272   Dali::Application::AppSignalType& PauseSignal() { return mPauseSignal; }
 273
 274   /**
 275    * @copydoc Dali::Application::ResumeSignal()
 276    */
 277   Dali::Application::AppSignalType& ResumeSignal() { return mResumeSignal; }
 278
 279   /**
 280    * @copydoc Dali::Application::ResetSignal()
 281    */
 282   Dali::Application::AppSignalType& ResetSignal() { return mResetSignal; }
 283
 284   /**
 285   * @copydoc Dali::Application::AppControlSignal()
 286   */
 287   Dali::Application::AppControlSignalType& AppControlSignal() { return mAppControlSignal; }
 288
 289   /**
 290    * @copydoc Dali::Application::ResizeSignal()
 291    */
 292   Dali::Application::AppSignalType& ResizeSignal() { return mResizeSignal; }
 293
 294   /**
 295    * @copydoc Dali::Application::LanguageChangedSignal()
 296    */
 297   Dali::Application::AppSignalType& LanguageChangedSignal() { return mLanguageChangedSignal; }
 298
 299   /**
 300   * @copydoc Dali::Application::RegionChangedSignal()
 301   */
 302   Dali::Application::AppSignalType& RegionChangedSignal() { return mRegionChangedSignal; }
 303
 304   /**
 305   * @copydoc Dali::Application::BatteryLowSignal()
 306   */
 307   Dali::Application::AppSignalType& BatteryLowSignal() { return mBatteryLowSignal; }
 308
 309   /**
 310   * @copydoc Dali::Application::MemoryLowSignal()
 311   */
 312   Dali::Application::AppSignalType& MemoryLowSignal() { return mMemoryLowSignal; }
 313
 314   /**
 315   * @copydoc Dali::Application::LowBatterySignal()
 316   */
 317   Dali::Application::LowBatterySignalType& LowBatterySignal() { return mLowBatterySignal; }
 318
 319   /**
 320   * @copydoc Dali::Application:::LowMemorySignal()
 321   */
 322   Dali::Application::LowMemorySignalType& LowMemorySignal() { return mLowMemorySignal; }
 323
 324 protected:
 325
 326   /**
 327    * Private Constructor
 328    * @param[in]  argc         A pointer to the number of arguments
 329    * @param[in]  argv         A pointer to the argument list
 330    * @param[in]  stylesheet   The path to user defined theme file
 331    * @param[in]  windowMode   A member of Dali::Application::WINDOW_MODE
 332    * @param[in]  positionSize A position and a size of the window
 333    * @param[in]  applicationType  A member of Dali::Framework::Type
 334    */
 335   Application( int* argc, char **argv[], const std::string& stylesheet,
 336       WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType );
 337
 338   /**
 339    * Destructor
 340    */
 341   virtual ~Application();
 342
 343   // Undefined
 344   Application(const Application&);
 345   Application& operator=(Application&);
 346
 347   /**
 348    * Creates the window
 349    */
 350   void CreateWindow();
 351
 352   /**
 353    * Creates the adaptor
 354    */
 355   void CreateAdaptor();
 356
 357   /**
 358    * Creates the adaptor builder
 359    */
 360   void CreateAdaptorBuilder();
 361
 362   /**
 363    * Quits from the main loop
 364    */
 365   void QuitFromMainLoop();
 366
 367 private:
 368
 369   AppSignalType                         mInitSignal;
 370   AppSignalType                         mTerminateSignal;
 371   AppSignalType                         mPauseSignal;
 372   AppSignalType                         mResumeSignal;
 373   AppSignalType                         mResetSignal;
 374   AppSignalType                         mResizeSignal;
 375   AppControlSignalType                  mAppControlSignal;
 376   AppSignalType                         mLanguageChangedSignal;
 377   AppSignalType                         mRegionChangedSignal;
 378   AppSignalType                         mBatteryLowSignal;
 379   AppSignalType                         mMemoryLowSignal;
 380   LowBatterySignalType                  mLowBatterySignal;
 381   LowMemorySignalType                   mLowMemorySignal;
 382
 383   EventLoop*                            mEventLoop;
 384   Framework*                            mFramework;
 385
 386   Dali::Configuration::ContextLoss      mContextLossConfiguration;
 387   CommandLineOptions*                   mCommandLineOptions;
 388
 389   Dali::SingletonService                   mSingletonService;
 390   Dali::Internal::Adaptor::AdaptorBuilder* mAdaptorBuilder;   ///< The adaptor builder
 391   Dali::Adaptor*                           mAdaptor;
 392
 393   // The Main Window is that window created by the Application during initial startup
 394   // (previously this was the only window)
 395   Dali::Window                             mMainWindow;       ///< Main Window instance
 396   Dali::Application::WINDOW_MODE           mMainWindowMode;   ///< Window mode of the main window
 397   std::string                              mMainWindowName;   ///< Name of the main window as obtained from environment options
 398
 399   std::string                              mStylesheet;
 400   EnvironmentOptions                       mEnvironmentOptions;
 401   PositionSize                             mWindowPositionSize;
 402   Launchpad::State                         mLaunchpadState;
 403   bool                                     mUseRemoteSurface;
 404
 405   SlotDelegate< Application >           mSlotDelegate;
 406
 407   static ApplicationPtr                 gPreInitializedApplication;
 408 };
 409
 410 inline Application& GetImplementation(Dali::Application& application)
 411 {
 412   DALI_ASSERT_ALWAYS(application && "application handle is empty");
 413
 414   BaseObject& handle = application.GetBaseObject();
 415
 416   return static_cast<Internal::Adaptor::Application&>(handle);
 417 }
 418
 419 inline const Application& GetImplementation(const Dali::Application& application)
 420 {
 421   DALI_ASSERT_ALWAYS(application && "application handle is empty");
 422
 423   const BaseObject& handle = application.GetBaseObject();
 424
 425   return static_cast<const Internal::Adaptor::Application&>(handle);
 426 }
 427
 428
 429 } // namespace Adaptor
 430
 431 } // namespace Internal
 432
 433 } // namespace Dali
 434
 435 #endif // DALI_INTERNAL_APPLICATION_H