1 #ifndef DALI_INTERNAL_APPLICATION_H
2 #define DALI_INTERNAL_APPLICATION_H
5 * Copyright (c) 2018 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/public-api/adaptor-framework/application.h>
27 #include <dali/devel-api/adaptor-framework/singleton-service.h>
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>
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.
54 NONE, ///< The default state
55 PRE_INITIALIZED ///< Application is pre-initialized.
58 } // namespace Launchpad
60 class CommandLineOptions;
63 typedef Dali::Rect<int> PositionSize;
66 typedef IntrusivePtr<Application> ApplicationPtr;
69 * Implementation of the Application class.
71 class Application : public BaseObject, public Framework::Observer
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;
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
90 static ApplicationPtr New( int* argc, char **argv[], const std::string& stylesheet,
91 WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType );
94 * @copydoc Dali::DevelApplication::PreInitialize()
96 static void PreInitialize( int* argc, char** argv[] );
101 * @copydoc Dali::Application::MainLoop()
103 void MainLoop(Dali::Configuration::ContextLoss configuration);
106 * @copydoc Dali::Application::Lower()
111 * @copydoc Dali::Application::Quit()
116 * @copydoc Dali::Application::AddIdle()
118 bool AddIdle( CallbackBase* callback, bool hasReturnValue );
121 * @copydoc Dali::Application::GetAdaptor();
123 Dali::Adaptor& GetAdaptor();
126 * @copydoc Dali::Application::GetWindow();
128 Dali::Window GetWindow();
131 * @copydoc Dali::Application::GetRegion();
133 std::string GetRegion() const;
136 * @copydoc Dali::Application::GetLanguage();
138 std::string GetLanguage() const;
141 * @copydoc Dali::Application::ReplaceWindow();
143 void ReplaceWindow( const PositionSize& positionSize, const std::string& name);
146 * @copydoc Dali::Application::GetResourcePath();
148 static std::string GetResourcePath();
151 * @copydoc Dali::DevelApplication::GetDataPath()
153 static std::string GetDataPath();
156 * Retrieves the pre-initialized application.
158 * @return A pointer to the pre-initialized application
160 static ApplicationPtr GetPreInitializedApplication();
162 public: // Stereoscopy
165 * @copydoc Dali::Application::SetViewMode()
167 void SetViewMode( ViewMode viewMode );
170 * @copydoc Dali::Application::GetViewMode()
172 ViewMode GetViewMode() const;
175 * @copydoc Dali::Application::SetStereoBase()
177 void SetStereoBase( float stereoBase );
180 * @copydoc Dali::Application::GetStereoBase()
182 float GetStereoBase() const;
184 public: // Lifecycle functionality
187 * Called when OnInit is called or the framework is initialised.
192 * Called after OnInit is called or the framework is started.
197 * Called when OnTerminate is called or the framework is terminated.
202 * Called when OnPause is called or the framework is paused.
207 * Called when OnResume is called or the framework resumes from a paused state.
212 * Called when OnLanguageChanged is called or the framework informs the application that the language of the device has changed.
214 void DoLanguageChange();
216 public: // From Framework::Observer
219 * Called when the framework is initialised.
221 virtual void OnInit();
224 * Called when the framework is terminated.
226 virtual void OnTerminate();
229 * Called when the framework is paused.
231 virtual void OnPause();
234 * Called when the framework resumes from a paused state.
236 virtual void OnResume();
239 * Called when the framework received AppControlSignal.
240 * @param[in] The bundle data of AppControl event.
242 virtual void OnAppControl(void *data);
245 * Called when the framework informs the application that it should reset itself.
247 virtual void OnReset();
250 * Called when the framework informs the application that the language of the device has changed.
252 virtual void OnLanguageChanged();
255 * Called when the framework informs the application that the region of the device has changed.
257 virtual void OnRegionChanged();
260 * Called when the framework informs the application that the battery level of the device is low.
262 virtual void OnBatteryLow( Dali::DeviceStatus::Battery::Status status );
265 * Called when the framework informs the application that the memory level of the device is low.
267 virtual void OnMemoryLow( Dali::DeviceStatus::Memory::Status status );
272 * Signal handler when the adaptor's window resizes itself.
273 * @param[in] adaptor The adaptor
275 void OnResize(Dali::Adaptor& adaptor);
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 );
287 * @copydoc Dali::Application::InitSignal()
289 Dali::Application::AppSignalType& InitSignal() { return mInitSignal; }
292 * @copydoc Dali::Application::TerminateSignal()
294 Dali::Application::AppSignalType& TerminateSignal() { return mTerminateSignal; }
297 * @copydoc Dali::Application::PauseSignal()
299 Dali::Application::AppSignalType& PauseSignal() { return mPauseSignal; }
302 * @copydoc Dali::Application::ResumeSignal()
304 Dali::Application::AppSignalType& ResumeSignal() { return mResumeSignal; }
307 * @copydoc Dali::Application::ResetSignal()
309 Dali::Application::AppSignalType& ResetSignal() { return mResetSignal; }
312 * @copydoc Dali::Application::AppControlSignal()
314 Dali::Application::AppControlSignalType& AppControlSignal() { return mAppControlSignal; }
317 * @copydoc Dali::Application::ResizeSignal()
319 Dali::Application::AppSignalType& ResizeSignal() { return mResizeSignal; }
322 * @copydoc Dali::Application::LanguageChangedSignal()
324 Dali::Application::AppSignalType& LanguageChangedSignal() { return mLanguageChangedSignal; }
327 * @copydoc Dali::Application::RegionChangedSignal()
329 Dali::Application::AppSignalType& RegionChangedSignal() { return mRegionChangedSignal; }
332 * @copydoc Dali::Application::BatteryLowSignal()
334 Dali::Application::AppSignalType& BatteryLowSignal() { return mBatteryLowSignal; }
337 * @copydoc Dali::Application::MemoryLowSignal()
339 Dali::Application::AppSignalType& MemoryLowSignal() { return mMemoryLowSignal; }
342 * @copydoc Dali::Application::LowBatterySignal()
344 Dali::Application::LowBatterySignalType& LowBatterySignal() { return mLowBatterySignal; }
347 * @copydoc Dali::Application:::LowMemorySignal()
349 Dali::Application::LowMemorySignalType& LowMemorySignal() { return mLowMemorySignal; }
354 * Private Constructor
355 * @param[in] argc A pointer to the number of arguments
356 * @param[in] argv A pointer to the argument list
357 * @param[in] stylesheet The path to user defined theme file
358 * @param[in] windowMode A member of Dali::Application::WINDOW_MODE
359 * @param[in] positionSize A position and a size of the window
360 * @param[in] applicationType A member of Dali::Framework::Type
362 Application( int* argc, char **argv[], const std::string& stylesheet,
363 WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType );
368 virtual ~Application();
371 Application(const Application&);
372 Application& operator=(Application&);
380 * Creates the adaptor
382 void CreateAdaptor();
385 * Creates the adaptor builder
387 void CreateAdaptorBuilder();
390 * Quits from the main loop
392 void QuitFromMainLoop();
396 AppSignalType mInitSignal;
397 AppSignalType mTerminateSignal;
398 AppSignalType mPauseSignal;
399 AppSignalType mResumeSignal;
400 AppSignalType mResetSignal;
401 AppSignalType mResizeSignal;
402 AppControlSignalType mAppControlSignal;
403 AppSignalType mLanguageChangedSignal;
404 AppSignalType mRegionChangedSignal;
405 AppSignalType mBatteryLowSignal;
406 AppSignalType mMemoryLowSignal;
407 LowBatterySignalType mLowBatterySignal;
408 LowMemorySignalType mLowMemorySignal;
410 EventLoop* mEventLoop;
411 Framework* mFramework;
413 Dali::Configuration::ContextLoss mContextLossConfiguration;
414 CommandLineOptions* mCommandLineOptions;
416 Dali::SingletonService mSingletonService;
417 Dali::Internal::Adaptor::AdaptorBuilder* mAdaptorBuilder; ///< The adaptor builder
418 Dali::Adaptor* mAdaptor;
420 // The Main Window is that window created by the Application during initial startup
421 // (previously this was the only window)
422 Dali::Window mMainWindow; ///< Main Window instance
423 Dali::Application::WINDOW_MODE mMainWindowMode; ///< Window mode of the main window
424 std::string mMainWindowName; ///< Name of the main window as obtained from environment options
426 std::string mStylesheet;
427 EnvironmentOptions mEnvironmentOptions;
428 PositionSize mWindowPositionSize;
429 Launchpad::State mLaunchpadState;
430 bool mUseRemoteSurface;
432 SlotDelegate< Application > mSlotDelegate;
437 static ApplicationPtr gPreInitializedApplication;
440 inline Application& GetImplementation(Dali::Application& application)
442 DALI_ASSERT_ALWAYS(application && "application handle is empty");
444 BaseObject& handle = application.GetBaseObject();
446 return static_cast<Internal::Adaptor::Application&>(handle);
449 inline const Application& GetImplementation(const Dali::Application& application)
451 DALI_ASSERT_ALWAYS(application && "application handle is empty");
453 const BaseObject& handle = application.GetBaseObject();
455 return static_cast<const Internal::Adaptor::Application&>(handle);
459 } // namespace Adaptor
461 } // namespace Internal
465 #endif // DALI_INTERNAL_APPLICATION_H