1 #ifndef DALI_INTERNAL_APPLICATION_H
2 #define DALI_INTERNAL_APPLICATION_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/math/rect.h>
23 #include <dali/public-api/object/base-object.h>
26 #include <dali/devel-api/common/singleton-service.h>
27 #include <dali/public-api/adaptor-framework/application.h>
29 #include <dali/internal/adaptor/common/adaptor-builder-impl.h>
30 #include <dali/internal/adaptor/common/framework.h>
31 #include <dali/internal/system/common/environment-options.h>
45 * @brief Launchpad is used to improve application launch performance.
46 * When an application is pre-initialized, so files are preloaded, some functions are initialized and a window is made in advance.
50 NONE, ///< The default state
51 PRE_INITIALIZED ///< Application is pre-initialized.
54 } // namespace Launchpad
56 class CommandLineOptions;
59 typedef Dali::Rect<int> PositionSize;
62 typedef IntrusivePtr<Application> ApplicationPtr;
65 * Implementation of the Application class.
67 class Application : public BaseObject, public Framework::Observer, public Framework::TaskObserver
70 typedef Dali::Application::LowBatterySignalType LowBatterySignalType;
71 typedef Dali::Application::LowMemorySignalType LowMemorySignalType;
72 typedef Dali::Application::DeviceOrientationChangedSignalType DeviceOrientationChangedSignalType;
73 typedef Dali::Application::AppSignalType AppSignalType;
74 typedef Dali::Application::AppControlSignalType AppControlSignalType;
75 typedef Dali::Application::WINDOW_MODE WINDOW_MODE;
78 * Create a new application
79 * @param[in] argc A pointer to the number of arguments
80 * @param[in] argv A pointer to the argument list
81 * @param[in] stylesheet The path to user defined theme file
82 * @param[in] windowMode A member of Dali::Application::WINDOW_MODE
83 * @param[in] positionSize A position and a size of the window
84 * @param[in] applicationType A member of Dali::Framework::Type
85 * @param[in] type It is window type for default window.
86 * @param[in] useUiThread True if the application would create a UI thread
88 static ApplicationPtr New(int* argc, char** argv[], const std::string& stylesheet, WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType, WindowType type, bool useUiThread);
91 * @copydoc Dali::DevelApplication::PreInitialize()
93 static void PreInitialize(int* argc, char** argv[]);
97 * @copydoc Dali::Application::MainLoop()
102 * @copydoc Dali::Application::Lower()
107 * @copydoc Dali::Application::Quit()
112 * @copydoc Dali::Application::AddIdle()
114 bool AddIdle(CallbackBase* callback, bool hasReturnValue);
117 * @copydoc Dali::Application::GetAdaptor();
119 Dali::Adaptor& GetAdaptor();
122 * @copydoc Dali::Application::GetWindow();
124 Dali::Window GetWindow();
127 * @copydoc Dali::Application::GetRegion();
129 std::string GetRegion() const;
132 * @copydoc Dali::Application::GetLanguage();
134 std::string GetLanguage() const;
137 * @copydoc Dali::Application::GetObjectRegistry();
139 Dali::ObjectRegistry GetObjectRegistry() const;
142 * @copydoc Dali::Application::GetResourcePath();
144 static std::string GetResourcePath();
147 * @copydoc Dali::DevelApplication::GetDataPath()
149 static std::string GetDataPath();
152 * Retrieves the pre-initialized application.
154 * @return A pointer to the pre-initialized application
156 static ApplicationPtr GetPreInitializedApplication();
159 * Stores PositionSize of window
161 void StoreWindowPositionSize(PositionSize positionSize);
163 public: // From Framework::Observer
165 * Called when the framework is initialised.
167 void OnInit() override;
170 * Called when the framework is terminated.
172 void OnTerminate() override;
175 * Called when the framework is paused.
177 void OnPause() override;
180 * Called when the framework resumes from a paused state.
182 void OnResume() override;
185 * Called when the framework received AppControlSignal.
186 * @param[in] The bundle data of AppControl event.
188 void OnAppControl(void* data) override;
191 * Called when the framework informs the application that it should reset itself.
193 void OnReset() override;
196 * Called when the framework informs the application that the language of the device has changed.
198 void OnLanguageChanged() override;
201 * Called when the framework informs the application that the region of the device has changed.
203 void OnRegionChanged() override;
206 * Called when the framework informs the application that the battery level of the device is low.
208 void OnBatteryLow(Dali::DeviceStatus::Battery::Status status) override;
211 * Called when the framework informs the application that the memory level of the device is low.
213 void OnMemoryLow(Dali::DeviceStatus::Memory::Status status) override;
216 * Called when the framework informs the application that device orientation is changed.
218 void OnDeviceOrientationChanged(Dali::DeviceStatus::Orientation::Status status) override;
221 * Called when the framework informs the application that the platform surface is created.
223 void OnSurfaceCreated(Any newSurface) override;
226 * Called when the framework informs the application that the platform surface is destroyed.
228 void OnSurfaceDestroyed(Any newSurface) override;
230 public: // From Framework::TaskObserver
232 * Called when the framework is initialised.
234 void OnTaskInit() override;
237 * Called when the framework is terminated.
239 void OnTaskTerminate() override;
242 * Called when the framework received AppControlSignal.
243 * @param[in] The bundle data of AppControl event.
245 void OnTaskAppControl(void* data) override;
248 * Called when the framework informs the application that the language of the device has changed.
250 void OnTaskLanguageChanged() override;
253 * Called when the framework informs the application that the region of the device has changed.
255 void OnTaskRegionChanged() override;
258 * Called when the framework informs the application that the battery level of the device is low.
260 void OnTaskBatteryLow(Dali::DeviceStatus::Battery::Status status) override;
263 * Called when the framework informs the application that the memory level of the device is low.
265 void OnTaskMemoryLow(Dali::DeviceStatus::Memory::Status status) override;
268 * Called when the framework informs the application that the device orientation is changed.
270 * Device orientation changed event is from Application Framework(Sensor Framework), it means it is system event.
271 * If UIThreading is enable, DALI application has the main thread and UI thread.
272 * This event is emitted in main thread, then it is posted to the UI thread in this callback function.
274 void OnTaskDeviceOrientationChanged(Dali::DeviceStatus::Orientation::Status status) override;
278 * Sets a user defined theme file.
279 * This should be called before initialization.
280 * @param[in] stylesheet The path to user defined theme file
282 void SetStyleSheet(const std::string& stylesheet);
285 * Sets a command line options.
286 * This is used in case of the preinitialized application.
287 * @param[in] argc A pointer to the number of arguments
288 * @param[in] argv A pointer to the argument list
290 void SetCommandLineOptions(int* argc, char** argv[]);
293 * Sets default window type.
294 * This is used in case of the preinitialized application.
295 * @param[in] type the window type for default window
297 void SetDefaultWindowType(WindowType type);
301 * @copydoc Dali::Application::InitSignal()
303 Dali::Application::AppSignalType& InitSignal()
309 * @copydoc Dali::Application::TerminateSignal()
311 Dali::Application::AppSignalType& TerminateSignal()
313 return mTerminateSignal;
317 * @copydoc Dali::Application::PauseSignal()
319 Dali::Application::AppSignalType& PauseSignal()
325 * @copydoc Dali::Application::ResumeSignal()
327 Dali::Application::AppSignalType& ResumeSignal()
329 return mResumeSignal;
333 * @copydoc Dali::Application::ResetSignal()
335 Dali::Application::AppSignalType& ResetSignal()
341 * @copydoc Dali::Application::AppControlSignal()
343 Dali::Application::AppControlSignalType& AppControlSignal()
345 return mAppControlSignal;
349 * @copydoc Dali::Application::LanguageChangedSignal()
351 Dali::Application::AppSignalType& LanguageChangedSignal()
353 return mLanguageChangedSignal;
357 * @copydoc Dali::Application::RegionChangedSignal()
359 Dali::Application::AppSignalType& RegionChangedSignal()
361 return mRegionChangedSignal;
365 * @copydoc Dali::Application::LowBatterySignal()
367 Dali::Application::LowBatterySignalType& LowBatterySignal()
369 return mLowBatterySignal;
373 * @copydoc Dali::Application:::LowMemorySignal()
375 Dali::Application::LowMemorySignalType& LowMemorySignal()
377 return mLowMemorySignal;
381 * @copydoc Dali::Application:::DeviceOrientationChangedSignalType()
383 Dali::Application::DeviceOrientationChangedSignalType& DeviceOrientationChangedSignal()
385 return mDeviceOrientationChangedSignal;
389 * @copydoc Dali::Application::TaskInitSignal()
391 Dali::Application::AppSignalType& TaskInitSignal()
393 return mTaskInitSignal;
397 * @copydoc Dali::Application::TaskTerminateSignal()
399 Dali::Application::AppSignalType& TaskTerminateSignal()
401 return mTaskTerminateSignal;
405 * @copydoc Dali::Application::TaskAppControlSignal()
407 Dali::Application::AppControlSignalType& TaskAppControlSignal()
409 return mTaskAppControlSignal;
413 * @copydoc Dali::Application::TaskLanguageChangedSignal()
415 Dali::Application::AppSignalType& TaskLanguageChangedSignal()
417 return mTaskLanguageChangedSignal;
421 * @copydoc Dali::Application::TaskRegionChangedSignal()
423 Dali::Application::AppSignalType& TaskRegionChangedSignal()
425 return mTaskRegionChangedSignal;
429 * @copydoc Dali::Application::TaskLowBatterySignal()
431 Dali::Application::LowBatterySignalType& TaskLowBatterySignal()
433 return mTaskLowBatterySignal;
437 * @copydoc Dali::Application::TaskLowMemorySignal()
439 Dali::Application::LowMemorySignalType& TaskLowMemorySignal()
441 return mTaskLowMemorySignal;
445 * @copydoc Dali::Application::TaskDeviceOrientationChangedSignal()
447 Dali::Application::DeviceOrientationChangedSignalType& TaskDeviceOrientationChangedSignal()
449 return mTaskDeviceOrientationChangedSignal;
454 * Private Constructor
455 * @param[in] argc A pointer to the number of arguments
456 * @param[in] argv A pointer to the argument list
457 * @param[in] stylesheet The path to user defined theme file
458 * @param[in] windowMode A member of Dali::Application::WINDOW_MODE
459 * @param[in] positionSize A position and a size of the window
460 * @param[in] applicationType A member of Dali::Framework::Type
461 * @param[in] type The default window's type.
462 * @param[in] useUiThread True if the application would create UI thread
464 Application(int* argc, char** argv[], const std::string& stylesheet, WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType, WindowType type, bool useUiThread);
469 ~Application() override;
472 Application(const Application&);
473 Application& operator=(Application&);
476 * Creates the default window
481 * Creates the adaptor
483 void CreateAdaptor();
486 * Creates the adaptor builder
488 void CreateAdaptorBuilder();
491 * Quits from the main loop
493 void QuitFromMainLoop();
496 * Changes size of preInitialized window
498 void ChangePreInitializedWindowSize();
501 AppSignalType mInitSignal;
502 AppSignalType mTerminateSignal;
503 AppSignalType mPauseSignal;
504 AppSignalType mResumeSignal;
505 AppSignalType mResetSignal;
506 AppControlSignalType mAppControlSignal;
507 AppSignalType mLanguageChangedSignal;
508 AppSignalType mRegionChangedSignal;
509 LowBatterySignalType mLowBatterySignal;
510 LowMemorySignalType mLowMemorySignal;
511 DeviceOrientationChangedSignalType mDeviceOrientationChangedSignal;
513 AppSignalType mTaskInitSignal;
514 AppSignalType mTaskTerminateSignal;
515 AppControlSignalType mTaskAppControlSignal;
516 AppSignalType mTaskLanguageChangedSignal;
517 AppSignalType mTaskRegionChangedSignal;
518 LowBatterySignalType mTaskLowBatterySignal;
519 LowMemorySignalType mTaskLowMemorySignal;
520 DeviceOrientationChangedSignalType mTaskDeviceOrientationChangedSignal;
522 EventLoop* mEventLoop;
523 Framework* mFramework;
525 CommandLineOptions* mCommandLineOptions;
527 Dali::Internal::Adaptor::AdaptorBuilder* mAdaptorBuilder; ///< The adaptor builder
528 Dali::Adaptor* mAdaptor;
530 // The Main Window is that window created by the Application during initial startup
531 // (previously this was the only window)
532 Dali::Window mMainWindow; ///< Main Window instance
533 Dali::Application::WINDOW_MODE mMainWindowMode; ///< Window mode of the main window
534 std::string mMainWindowName; ///< Name of the main window as obtained from environment options
536 std::string mStylesheet;
537 EnvironmentOptions mEnvironmentOptions;
538 PositionSize mWindowPositionSize;
539 Launchpad::State mLaunchpadState;
540 bool mUseRemoteSurface;
541 WindowType mDefaultWindowType; ///< Default window's type. It is used when Application is created.
544 SlotDelegate<Application> mSlotDelegate;
546 static ApplicationPtr gPreInitializedApplication;
549 inline Application& GetImplementation(Dali::Application& application)
551 DALI_ASSERT_ALWAYS(application && "application handle is empty");
553 BaseObject& handle = application.GetBaseObject();
555 return static_cast<Internal::Adaptor::Application&>(handle);
558 inline const Application& GetImplementation(const Dali::Application& application)
560 DALI_ASSERT_ALWAYS(application && "application handle is empty");
562 const BaseObject& handle = application.GetBaseObject();
564 return static_cast<const Internal::Adaptor::Application&>(handle);
567 } // namespace Adaptor
569 } // namespace Internal
573 #endif // DALI_INTERNAL_APPLICATION_H