1 #ifndef DALI_INTERNAL_APPLICATION_H
2 #define DALI_INTERNAL_APPLICATION_H
5 * Copyright (c) 2020 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/common/singleton-service.h>
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>
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.
53 NONE, ///< The default state
54 PRE_INITIALIZED ///< Application is pre-initialized.
57 } // namespace Launchpad
59 class CommandLineOptions;
62 typedef Dali::Rect<int> PositionSize;
65 typedef IntrusivePtr<Application> ApplicationPtr;
68 * Implementation of the Application class.
70 class Application : public BaseObject, public Framework::Observer
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;
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
89 static ApplicationPtr New( int* argc, char **argv[], const std::string& stylesheet,
90 WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType );
93 * @copydoc Dali::DevelApplication::PreInitialize()
95 static void PreInitialize( int* argc, char** argv[] );
100 * @copydoc Dali::Application::MainLoop()
105 * @copydoc Dali::Application::Lower()
110 * @copydoc Dali::Application::Quit()
115 * @copydoc Dali::Application::AddIdle()
117 bool AddIdle( CallbackBase* callback, bool hasReturnValue );
120 * @copydoc Dali::Application::GetAdaptor();
122 Dali::Adaptor& GetAdaptor();
125 * @copydoc Dali::Application::GetWindow();
127 Dali::Window GetWindow();
130 * @copydoc Dali::Application::GetRegion();
132 std::string GetRegion() const;
135 * @copydoc Dali::Application::GetLanguage();
137 std::string GetLanguage() const;
140 * @copydoc Dali::Application::GetObjectRegistry();
142 Dali::ObjectRegistry GetObjectRegistry() const;
145 * @copydoc Dali::Application::GetResourcePath();
147 static std::string GetResourcePath();
150 * @copydoc Dali::DevelApplication::GetDataPath()
152 static std::string GetDataPath();
155 * Retrieves the pre-initialized application.
157 * @return A pointer to the pre-initialized application
159 static ApplicationPtr GetPreInitializedApplication();
161 public: // From Framework::Observer
164 * Called when the framework is initialised.
166 virtual void OnInit();
169 * Called when the framework is terminated.
171 virtual void OnTerminate();
174 * Called when the framework is paused.
176 virtual void OnPause();
179 * Called when the framework resumes from a paused state.
181 virtual void OnResume();
184 * Called when the framework received AppControlSignal.
185 * @param[in] The bundle data of AppControl event.
187 virtual void OnAppControl(void *data);
190 * Called when the framework informs the application that it should reset itself.
192 virtual void OnReset();
195 * Called when the framework informs the application that the language of the device has changed.
197 virtual void OnLanguageChanged();
200 * Called when the framework informs the application that the region of the device has changed.
202 virtual void OnRegionChanged();
205 * Called when the framework informs the application that the battery level of the device is low.
207 virtual void OnBatteryLow( Dali::DeviceStatus::Battery::Status status );
210 * Called when the framework informs the application that the memory level of the device is low.
212 virtual void OnMemoryLow( Dali::DeviceStatus::Memory::Status status );
215 * Called when the framework informs the application that the platform surface is created.
217 virtual void OnSurfaceCreated( Any newSurface );
220 * Called when the framework informs the application that the platform surface is destroyed.
222 virtual void OnSurfaceDestroyed( Any newSurface );
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
231 void SetStyleSheet( const std::string& stylesheet );
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
239 void SetCommandLineOptions( int* argc, char **argv[] );
244 * @copydoc Dali::Application::InitSignal()
246 Dali::Application::AppSignalType& InitSignal() { return mInitSignal; }
249 * @copydoc Dali::Application::TerminateSignal()
251 Dali::Application::AppSignalType& TerminateSignal() { return mTerminateSignal; }
254 * @copydoc Dali::Application::PauseSignal()
256 Dali::Application::AppSignalType& PauseSignal() { return mPauseSignal; }
259 * @copydoc Dali::Application::ResumeSignal()
261 Dali::Application::AppSignalType& ResumeSignal() { return mResumeSignal; }
264 * @copydoc Dali::Application::ResetSignal()
266 Dali::Application::AppSignalType& ResetSignal() { return mResetSignal; }
269 * @copydoc Dali::Application::AppControlSignal()
271 Dali::Application::AppControlSignalType& AppControlSignal() { return mAppControlSignal; }
274 * @copydoc Dali::Application::LanguageChangedSignal()
276 Dali::Application::AppSignalType& LanguageChangedSignal() { return mLanguageChangedSignal; }
279 * @copydoc Dali::Application::RegionChangedSignal()
281 Dali::Application::AppSignalType& RegionChangedSignal() { return mRegionChangedSignal; }
284 * @copydoc Dali::Application::LowBatterySignal()
286 Dali::Application::LowBatterySignalType& LowBatterySignal() { return mLowBatterySignal; }
289 * @copydoc Dali::Application:::LowMemorySignal()
291 Dali::Application::LowMemorySignalType& LowMemorySignal() { return mLowMemorySignal; }
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
304 Application( int* argc, char **argv[], const std::string& stylesheet,
305 WINDOW_MODE windowMode, const PositionSize& positionSize, Framework::Type applicationType );
310 virtual ~Application();
313 Application(const Application&);
314 Application& operator=(Application&);
322 * Creates the adaptor
324 void CreateAdaptor();
327 * Creates the adaptor builder
329 void CreateAdaptorBuilder();
332 * Quits from the main loop
334 void QuitFromMainLoop();
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;
349 EventLoop* mEventLoop;
350 Framework* mFramework;
352 CommandLineOptions* mCommandLineOptions;
354 Dali::Internal::Adaptor::AdaptorBuilder* mAdaptorBuilder; ///< The adaptor builder
355 Dali::Adaptor* mAdaptor;
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
363 std::string mStylesheet;
364 EnvironmentOptions mEnvironmentOptions;
365 PositionSize mWindowPositionSize;
366 Launchpad::State mLaunchpadState;
367 bool mUseRemoteSurface;
369 SlotDelegate< Application > mSlotDelegate;
371 static ApplicationPtr gPreInitializedApplication;
374 inline Application& GetImplementation(Dali::Application& application)
376 DALI_ASSERT_ALWAYS(application && "application handle is empty");
378 BaseObject& handle = application.GetBaseObject();
380 return static_cast<Internal::Adaptor::Application&>(handle);
383 inline const Application& GetImplementation(const Dali::Application& application)
385 DALI_ASSERT_ALWAYS(application && "application handle is empty");
387 const BaseObject& handle = application.GetBaseObject();
389 return static_cast<const Internal::Adaptor::Application&>(handle);
393 } // namespace Adaptor
395 } // namespace Internal
399 #endif // DALI_INTERNAL_APPLICATION_H