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

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