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/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(Dali::Configuration::ContextLoss configuration);
 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::ReplaceWindow();
 141    */
 142   void ReplaceWindow( const PositionSize& positionSize, const std::string& name);
 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: // Stereoscopy
 162
 163   /**
 164    * @copydoc Dali::Application::SetViewMode()
 165    */
 166   void SetViewMode( ViewMode viewMode );
 167
 168   /**
 169    * @copydoc Dali::Application::GetViewMode()
 170    */
 171   ViewMode GetViewMode() const;
 172
 173   /**
 174    * @copydoc Dali::Application::SetStereoBase()
 175    */
 176   void SetStereoBase( float stereoBase );
 177
 178   /**
 179    * @copydoc Dali::Application::GetStereoBase()
 180    */
 181   float GetStereoBase() const;
 182
 183 public: // From Framework::Observer
 184
 185   /**
 186    * Called when the framework is initialised.
 187    */
 188   virtual void OnInit();
 189
 190   /**
 191    * Called when the framework is terminated.
 192    */
 193   virtual void OnTerminate();
 194
 195   /**
 196    * Called when the framework is paused.
 197    */
 198   virtual void OnPause();
 199
 200   /**
 201    * Called when the framework resumes from a paused state.
 202    */
 203   virtual void OnResume();
 204
 205   /**
 206   * Called when the framework received AppControlSignal.
 207   * @param[in] The bundle data of AppControl event.
 208   */
 209   virtual void OnAppControl(void *data);
 210
 211   /**
 212    * Called when the framework informs the application that it should reset itself.
 213    */
 214   virtual void OnReset();
 215
 216   /**
 217    * Called when the framework informs the application that the language of the device has changed.
 218    */
 219   virtual void OnLanguageChanged();
 220
 221   /**
 222   * Called when the framework informs the application that the region of the device has changed.
 223   */
 224   virtual void OnRegionChanged();
 225
 226   /**
 227   * Called when the framework informs the application that the battery level of the device is low.
 228   */
 229   virtual void OnBatteryLow( Dali::DeviceStatus::Battery::Status status );
 230
 231   /**
 232   * Called when the framework informs the application that the memory level of the device is low.
 233   */
 234   virtual void OnMemoryLow( Dali::DeviceStatus::Memory::Status status );
 235
 236 public:
 237
 238   /**
 239    * Signal handler when the adaptor's window resizes itself.
 240    * @param[in]  adaptor  The adaptor
 241    */
 242   void OnResize(Dali::Adaptor& adaptor);
 243
 244   /**
 245    * Sets a user defined theme file.
 246    * This should be called before initialization.
 247    * @param[in] stylesheet The path to user defined theme file
 248    */
 249   void SetStyleSheet( const std::string& stylesheet );
 250
 251   /**
 252    * Sets a command line options.
 253    * This is used in case of the preinitialized application.
 254    * @param[in] argc A pointer to the number of arguments
 255    * @param[in] argv A pointer to the argument list
 256    */
 257   void SetCommandLineOptions( int* argc, char **argv[] );
 258
 259 public:  // Signals
 260
 261   /**
 262    * @copydoc Dali::Application::InitSignal()
 263    */
 264   Dali::Application::AppSignalType& InitSignal() { return mInitSignal; }
 265
 266   /**
 267    * @copydoc Dali::Application::TerminateSignal()
 268    */
 269   Dali::Application::AppSignalType& TerminateSignal() { return mTerminateSignal; }
 270
 271   /**
 272    * @copydoc Dali::Application::PauseSignal()
 273    */
 274   Dali::Application::AppSignalType& PauseSignal() { return mPauseSignal; }
 275
 276   /**
 277    * @copydoc Dali::Application::ResumeSignal()
 278    */
 279   Dali::Application::AppSignalType& ResumeSignal() { return mResumeSignal; }
 280
 281   /**
 282    * @copydoc Dali::Application::ResetSignal()
 283    */
 284   Dali::Application::AppSignalType& ResetSignal() { return mResetSignal; }
 285
 286   /**
 287   * @copydoc Dali::Application::AppControlSignal()
 288   */
 289   Dali::Application::AppControlSignalType& AppControlSignal() { return mAppControlSignal; }
 290
 291   /**
 292    * @copydoc Dali::Application::ResizeSignal()
 293    */
 294   Dali::Application::AppSignalType& ResizeSignal() { return mResizeSignal; }
 295
 296   /**
 297    * @copydoc Dali::Application::LanguageChangedSignal()
 298    */
 299   Dali::Application::AppSignalType& LanguageChangedSignal() { return mLanguageChangedSignal; }
 300
 301   /**
 302   * @copydoc Dali::Application::RegionChangedSignal()
 303   */
 304   Dali::Application::AppSignalType& RegionChangedSignal() { return mRegionChangedSignal; }
 305
 306   /**
 307   * @copydoc Dali::Application::BatteryLowSignal()
 308   */
 309   Dali::Application::AppSignalType& BatteryLowSignal() { return mBatteryLowSignal; }
 310
 311   /**
 312   * @copydoc Dali::Application::MemoryLowSignal()
 313   */
 314   Dali::Application::AppSignalType& MemoryLowSignal() { return mMemoryLowSignal; }
 315
 316   /**
 317   * @copydoc Dali::Application::LowBatterySignal()
 318   */
 319   Dali::Application::LowBatterySignalType& LowBatterySignal() { return mLowBatterySignal; }
 320
 321   /**
 322   * @copydoc Dali::Application:::LowMemorySignal()
 323   */
 324   Dali::Application::LowMemorySignalType& LowMemorySignal() { return mLowMemorySignal; }
 325
 326 protected:
 327
 328   /**
 329    * Private Constructor
 330    * @param[in]  argc         A pointer to the number of arguments
 331    * @param[in]  argv         A pointer to the argument list
 332    * @param[in]  stylesheet   The path to user defined theme file
 333    * @param[in]  windowMode   A member of Dali::Application::WINDOW_MODE
 334    * @param[in]  positionSize A position and a size of the window
 335    * @param[in]  applicationType  A member of Dali::Framework::Type
 336    */
 337   Application( int* argc, char **argv[], const std::string& stylesheet,
 338       WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType );
 339
 340   /**
 341    * Destructor
 342    */
 343   virtual ~Application();
 344
 345   // Undefined
 346   Application(const Application&);
 347   Application& operator=(Application&);
 348
 349   /**
 350    * Creates the window
 351    */
 352   void CreateWindow();
 353
 354   /**
 355    * Creates the adaptor
 356    */
 357   void CreateAdaptor();
 358
 359   /**
 360    * Creates the adaptor builder
 361    */
 362   void CreateAdaptorBuilder();
 363
 364   /**
 365    * Quits from the main loop
 366    */
 367   void QuitFromMainLoop();
 368
 369 private:
 370
 371   AppSignalType                         mInitSignal;
 372   AppSignalType                         mTerminateSignal;
 373   AppSignalType                         mPauseSignal;
 374   AppSignalType                         mResumeSignal;
 375   AppSignalType                         mResetSignal;
 376   AppSignalType                         mResizeSignal;
 377   AppControlSignalType                  mAppControlSignal;
 378   AppSignalType                         mLanguageChangedSignal;
 379   AppSignalType                         mRegionChangedSignal;
 380   AppSignalType                         mBatteryLowSignal;
 381   AppSignalType                         mMemoryLowSignal;
 382   LowBatterySignalType                  mLowBatterySignal;
 383   LowMemorySignalType                   mLowMemorySignal;
 384
 385   EventLoop*                            mEventLoop;
 386   Framework*                            mFramework;
 387
 388   Dali::Configuration::ContextLoss      mContextLossConfiguration;
 389   CommandLineOptions*                   mCommandLineOptions;
 390
 391   Dali::SingletonService                   mSingletonService;
 392   Dali::Internal::Adaptor::AdaptorBuilder* mAdaptorBuilder;   ///< The adaptor builder
 393   Dali::Adaptor*                           mAdaptor;
 394
 395   // The Main Window is that window created by the Application during initial startup
 396   // (previously this was the only window)
 397   Dali::Window                             mMainWindow;       ///< Main Window instance
 398   Dali::Application::WINDOW_MODE           mMainWindowMode;   ///< Window mode of the main window
 399   std::string                              mMainWindowName;   ///< Name of the main window as obtained from environment options
 400
 401   bool                                     mMainWindowReplaced;   ///< Whether the main window has been replaced
 402
 403   std::string                              mStylesheet;
 404   EnvironmentOptions                       mEnvironmentOptions;
 405   PositionSize                             mWindowPositionSize;
 406   Launchpad::State                         mLaunchpadState;
 407   bool                                     mUseRemoteSurface;
 408
 409   SlotDelegate< Application >              mSlotDelegate;
 410
 411   ViewMode                                 mViewMode;
 412   float                                    mStereoBase;
 413
 414   static ApplicationPtr                    gPreInitializedApplication;
 415 };
 416
 417 inline Application& GetImplementation(Dali::Application& application)
 418 {
 419   DALI_ASSERT_ALWAYS(application && "application handle is empty");
 420
 421   BaseObject& handle = application.GetBaseObject();
 422
 423   return static_cast<Internal::Adaptor::Application&>(handle);
 424 }
 425
 426 inline const Application& GetImplementation(const Dali::Application& application)
 427 {
 428   DALI_ASSERT_ALWAYS(application && "application handle is empty");
 429
 430   const BaseObject& handle = application.GetBaseObject();
 431
 432   return static_cast<const Internal::Adaptor::Application&>(handle);
 433 }
 434
 435
 436 } // namespace Adaptor
 437
 438 } // namespace Internal
 439
 440 } // namespace Dali
 441
 442 #endif // DALI_INTERNAL_APPLICATION_H