2 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali/internal/adaptor/common/framework.h>
22 #include <app_common.h>
23 #include <app_control_internal.h>
24 #include <appcore_ui_base.h>
26 #include <dali/internal/system/linux/dali-ecore.h>
28 #include <bundle_internal.h>
29 #include <system_info.h>
30 #include <system_settings.h>
31 #include <widget_base.h>
32 // CONDITIONAL INCLUDES
33 #ifdef APPCORE_WATCH_AVAILABLE
34 #include <appcore-watch/watch_app.h>
36 #ifdef DALI_ELDBUS_AVAILABLE
38 #endif // DALI_ELDBUS_AVAILABLE
40 #if defined(TIZEN_PLATFORM_CONFIG_SUPPORTED) && TIZEN_PLATFORM_CONFIG_SUPPORTED
41 #include <tzplatform_config.h>
42 #endif // TIZEN_PLATFORM_CONFIG_SUPPORTED
44 #ifdef COMPONENT_APPLICATION_SUPPORT
45 #include <component_based_app_base.h>
48 #include <dali/integration-api/debug.h>
51 #include <dali/internal/system/common/callback-manager.h>
61 #if defined(DEBUG_ENABLED)
62 Integration::Log::Filter* gDBusLogging = Integration::Log::Filter::New(Debug::NoLogging, false, "LOG_ADAPTOR_EVENTS_DBUS");
65 bool IsWidgetFeatureEnabled()
67 static bool feature = false;
68 static bool retrieved = false;
76 ret = system_info_get_platform_bool("http://tizen.org/feature/shell.appwidget", &feature);
77 if(ret != SYSTEM_INFO_ERROR_NONE)
79 DALI_LOG_ERROR("failed to get system info");
87 } // anonymous namespace
93 LOW_MEMORY, //< The low memory event
94 LOW_BATTERY, //< The low battery event
95 LANGUAGE_CHANGED, //< The system language changed event
96 DEVICE_ORIENTATION_CHANGED, //< The device orientation changed event
97 REGION_FORMAT_CHANGED, //< The region format changed event
98 SUSPENDED_STATE_CHANGED, //< The suspended state changed event of the application
99 UPDATE_REQUESTED, //< The update requested event. This event can occur when an app needs to be updated. It is dependent on target devices.
102 static int AppEventConverter[APPCORE_BASE_EVENT_MAX] =
104 [LOW_MEMORY] = APPCORE_BASE_EVENT_LOW_MEMORY,
105 [LOW_BATTERY] = APPCORE_BASE_EVENT_LOW_BATTERY,
106 [LANGUAGE_CHANGED] = APPCORE_BASE_EVENT_LANG_CHANGE,
107 [DEVICE_ORIENTATION_CHANGED] = APPCORE_BASE_EVENT_DEVICE_ORIENTATION_CHANGED,
108 [REGION_FORMAT_CHANGED] = APPCORE_BASE_EVENT_REGION_CHANGE,
109 [SUSPENDED_STATE_CHANGED] = APPCORE_BASE_EVENT_SUSPENDED_STATE_CHANGE,
118 typedef struct AppEventInfo* AppEventInfoPtr;
120 typedef void (*AppEventCallback)(AppEventInfoPtr eventInfo, void* userData);
122 struct AppEventHandler
130 typedef struct AppEventHandler* AppEventHandlerPtr;
132 int EventCallback(void* event, void* data)
134 AppEventHandlerPtr handler = static_cast<AppEventHandlerPtr>(data);
136 struct AppEventInfo appEvent;
138 appEvent.type = handler->type;
139 appEvent.value = event;
142 handler->cb(&appEvent, handler->data);
147 int AppAddEventHandler(AppEventHandlerPtr* eventHandler, AppEventType eventType, AppEventCallback callback, void* userData)
149 AppEventHandlerPtr handler;
151 handler = static_cast<AppEventHandlerPtr>(calloc(1, sizeof(struct AppEventHandler)));
154 DALI_LOG_ERROR("failed to create handler");
155 return TIZEN_ERROR_UNKNOWN;
159 handler->type = eventType;
160 handler->cb = callback;
161 handler->data = userData;
162 handler->raw = appcore_base_add_event(static_cast<appcore_base_event>(AppEventConverter[static_cast<int>(eventType)]), EventCallback, handler);
164 *eventHandler = handler;
166 return TIZEN_ERROR_NONE;
170 } // namespace AppCore
173 * Impl to hide EFL data members
175 struct Framework::Impl
178 Impl(void* data, Type type)
179 : mAbortCallBack(NULL),
180 mCallbackManager(NULL)
181 #ifdef APPCORE_WATCH_AVAILABLE
186 mFramework = static_cast<Framework*>(data);
188 #ifndef APPCORE_WATCH_AVAILABLE
191 throw Dali::DaliException("", "Watch Application is not supported.");
194 mApplicationType = type;
195 mCallbackManager = CallbackManager::New();
200 delete mAbortCallBack;
202 // we're quiting the main loop so
203 // mCallbackManager->RemoveAllCallBacks() does not need to be called
204 // to delete our abort handler
205 delete mCallbackManager;
211 switch(mApplicationType)
215 ret = AppNormalMain();
220 ret = AppWidgetMain();
225 ret = AppWatchMain();
228 #ifdef COMPONENT_APPLICATION_SUPPORT
231 ret = AppComponentMain();
241 switch(mApplicationType)
258 #ifdef COMPONENT_APPLICATION_SUPPORT
268 void SetLanguage(const std::string& language)
270 mLanguage = language;
273 void SetRegion(const std::string& region)
278 std::string GetLanguage()
280 if(mLanguage.empty())
282 char* language = nullptr;
283 system_settings_get_value_string(SYSTEM_SETTINGS_KEY_LOCALE_LANGUAGE, &language);
285 if(language != nullptr)
287 mLanguage = std::string(language);
294 std::string GetRegion()
298 char* region = nullptr;
299 system_settings_get_value_string(SYSTEM_SETTINGS_KEY_LOCALE_COUNTRY, ®ion);
301 if(region != nullptr)
303 mRegion = std::string(region);
311 Type mApplicationType;
312 CallbackBase* mAbortCallBack;
313 CallbackManager* mCallbackManager;
314 std::string mLanguage{};
315 std::string mRegion{};
317 Framework* mFramework;
318 AppCore::AppEventHandlerPtr handlers[5];
319 #ifdef APPCORE_WATCH_AVAILABLE
320 watch_app_lifecycle_callback_s mWatchCallback;
321 app_event_handler_h watchHandlers[5];
324 static int AppCreate(void* data)
326 appcore_ui_base_on_create();
327 return static_cast<int>(static_cast<Framework*>(data)->Create());
330 static int AppTerminate(void* data)
332 appcore_ui_base_on_terminate();
333 Observer* observer = &static_cast<Framework*>(data)->mObserver;
335 observer->OnTerminate();
340 static int AppPause(void* data)
342 appcore_ui_base_on_pause();
343 Observer* observer = &static_cast<Framework*>(data)->mObserver;
350 static int AppResume(void* data)
352 appcore_ui_base_on_resume();
353 Observer* observer = &static_cast<Framework*>(data)->mObserver;
355 observer->OnResume();
360 static void ProcessBundle(Framework* framework, bundle* bundleData)
362 if(bundleData == NULL)
368 char* bundleName = const_cast<char*>(bundle_get_val(bundleData, "name"));
369 if(bundleName != NULL)
371 framework->SetBundleName(bundleName);
375 char* bundleId = const_cast<char*>(bundle_get_val(bundleData, "id"));
378 framework->SetBundleId(bundleId);
383 * Called by AppCore when the application is launched from another module (e.g. homescreen).
384 * @param[in] b the bundle data which the launcher module sent
386 static int AppControl(bundle* bundleData, void* data)
388 app_control_h appControl = NULL;
390 appcore_ui_base_on_control(bundleData);
394 if(app_control_create_event(bundleData, &appControl) != TIZEN_ERROR_NONE)
396 DALI_LOG_ERROR("Failed to create an app_control handle");
401 if(app_control_create(&appControl) != TIZEN_ERROR_NONE)
403 DALI_LOG_ERROR("Failed to create an app_control handle");
407 Framework* framework = static_cast<Framework*>(data);
408 Observer* observer = &framework->mObserver;
410 ProcessBundle(framework, bundleData);
413 observer->OnAppControl(appControl);
415 app_control_destroy(appControl);
420 static void AppInit(int argc, char** argv, void* data)
422 #pragma GCC diagnostic push
423 #pragma GCC diagnostic ignored "-Wold-style-cast"
426 ecore_app_args_set(argc, (const char**)argv);
428 #pragma GCC diagnostic pop
431 static void AppFinish(void)
435 if(getenv("AUL_LOADER_INIT"))
437 setenv("AUL_LOADER_INIT", "0", 1);
442 static void AppRun(void* data)
444 ecore_main_loop_begin();
447 static void AppExit(void* data)
449 ecore_main_loop_quit();
452 static void AppLanguageChanged(AppCore::AppEventInfoPtr event, void* data)
454 Framework* framework = static_cast<Framework*>(data);
455 Observer* observer = &framework->mObserver;
457 if(event && event->value)
459 framework->SetLanguage(std::string(static_cast<const char*>(event->value)));
460 observer->OnLanguageChanged();
464 DALI_LOG_ERROR("NULL pointer in Language changed event\n");
468 static void AppDeviceRotated(AppCore::AppEventInfoPtr event_info, void* data)
472 static void AppRegionChanged(AppCore::AppEventInfoPtr event, void* data)
474 Framework* framework = static_cast<Framework*>(data);
475 Observer* observer = &framework->mObserver;
477 if(event && event->value)
479 framework->SetRegion(std::string(static_cast<const char*>(event->value)));
480 observer->OnRegionChanged();
484 DALI_LOG_ERROR("NULL pointer in Region changed event\n");
488 static void AppBatteryLow(AppCore::AppEventInfoPtr event, void* data)
490 Observer* observer = &static_cast<Framework*>(data)->mObserver;
491 int status = *static_cast<int*>(event->value);
492 Dali::DeviceStatus::Battery::Status result = Dali::DeviceStatus::Battery::NORMAL;
494 // convert to dali battery status
499 result = Dali::DeviceStatus::Battery::POWER_OFF;
504 result = Dali::DeviceStatus::Battery::CRITICALLY_LOW;
510 observer->OnBatteryLow(result);
513 static void AppMemoryLow(AppCore::AppEventInfoPtr event, void* data)
515 Observer* observer = &static_cast<Framework*>(data)->mObserver;
516 int status = *static_cast<int*>(event->value);
517 Dali::DeviceStatus::Memory::Status result = Dali::DeviceStatus::Memory::NORMAL;
519 // convert to dali memmory status
524 result = Dali::DeviceStatus::Memory::NORMAL;
529 result = Dali::DeviceStatus::Memory::LOW;
534 result = Dali::DeviceStatus::Memory::CRITICALLY_LOW;
540 observer->OnMemoryLow(result);
547 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_BATTERY], AppCore::LOW_BATTERY, AppBatteryLow, mFramework);
548 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_MEMORY], AppCore::LOW_MEMORY, AppMemoryLow, mFramework);
549 AppCore::AppAddEventHandler(&handlers[AppCore::DEVICE_ORIENTATION_CHANGED], AppCore::DEVICE_ORIENTATION_CHANGED, AppDeviceRotated, mFramework);
550 AppCore::AppAddEventHandler(&handlers[AppCore::LANGUAGE_CHANGED], AppCore::LANGUAGE_CHANGED, AppLanguageChanged, mFramework);
551 AppCore::AppAddEventHandler(&handlers[AppCore::REGION_FORMAT_CHANGED], AppCore::REGION_FORMAT_CHANGED, AppRegionChanged, mFramework);
553 appcore_ui_base_ops ops = appcore_ui_base_get_default_ops();
555 /* override methods */
556 ops.base.create = AppCreate;
557 ops.base.control = AppControl;
558 ops.base.terminate = AppTerminate;
559 ops.pause = AppPause;
560 ops.resume = AppResume;
561 ops.base.init = AppInit;
562 ops.base.finish = AppFinish;
563 ops.base.run = AppRun;
564 ops.base.exit = AppExit;
566 ret = appcore_ui_base_init(ops, *mFramework->mArgc, *mFramework->mArgv, mFramework, APPCORE_UI_BASE_HINT_WINDOW_GROUP_CONTROL | APPCORE_UI_BASE_HINT_WINDOW_STACK_CONTROL | APPCORE_UI_BASE_HINT_BG_LAUNCH_CONTROL | APPCORE_UI_BASE_HINT_HW_ACC_CONTROL | APPCORE_UI_BASE_HINT_WINDOW_AUTO_CONTROL);
568 if(ret != TIZEN_ERROR_NONE)
571 appcore_ui_base_fini();
573 return TIZEN_ERROR_NONE;
578 appcore_ui_base_exit();
586 static int WidgetAppCreate(void* data)
588 widget_base_on_create();
589 return static_cast<int>(static_cast<Framework*>(data)->Create());
592 static int WidgetAppTerminate(void* data)
594 Observer* observer = &static_cast<Framework*>(data)->mObserver;
595 observer->OnTerminate();
597 widget_base_on_terminate();
603 if(!IsWidgetFeatureEnabled())
605 DALI_LOG_ERROR("widget feature is not supported");
609 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_BATTERY], AppCore::LOW_BATTERY, AppBatteryLow, mFramework);
610 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_MEMORY], AppCore::LOW_MEMORY, AppMemoryLow, mFramework);
611 AppCore::AppAddEventHandler(&handlers[AppCore::DEVICE_ORIENTATION_CHANGED], AppCore::DEVICE_ORIENTATION_CHANGED, AppDeviceRotated, mFramework);
612 AppCore::AppAddEventHandler(&handlers[AppCore::LANGUAGE_CHANGED], AppCore::LANGUAGE_CHANGED, AppLanguageChanged, mFramework);
613 AppCore::AppAddEventHandler(&handlers[AppCore::REGION_FORMAT_CHANGED], AppCore::REGION_FORMAT_CHANGED, AppRegionChanged, mFramework);
615 widget_base_ops ops = widget_base_get_default_ops();
617 /* override methods */
618 ops.create = WidgetAppCreate;
619 ops.terminate = WidgetAppTerminate;
621 ops.finish = AppFinish;
625 int result = widget_base_init(ops, *mFramework->mArgc, *mFramework->mArgv, mFramework);
632 #ifdef APPCORE_WATCH_AVAILABLE
633 static bool WatchAppCreate(int width, int height, void* data)
635 return static_cast<Framework*>(data)->Create();
638 static void WatchAppTimeTick(watch_time_h time, void* data)
640 Observer* observer = &static_cast<Framework*>(data)->mObserver;
641 WatchTime curTime(time);
643 observer->OnTimeTick(curTime);
646 static void WatchAppAmbientTick(watch_time_h time, void* data)
648 Observer* observer = &static_cast<Framework*>(data)->mObserver;
649 WatchTime curTime(time);
651 observer->OnAmbientTick(curTime);
654 static void WatchAppAmbientChanged(bool ambient, void* data)
656 Observer* observer = &static_cast<Framework*>(data)->mObserver;
658 observer->OnAmbientChanged(ambient);
661 static void WatchAppControl(app_control_h app_control, void* data)
663 Framework* framework = static_cast<Framework*>(data);
664 Observer* observer = &framework->mObserver;
665 bundle* bundleData = NULL;
667 app_control_to_bundle(app_control, &bundleData);
668 ProcessBundle(framework, bundleData);
671 observer->OnAppControl(app_control);
674 static void WatchAppTerminate(void* data)
676 Observer* observer = &static_cast<Framework*>(data)->mObserver;
678 observer->OnTerminate();
681 static void WatchAppPause(void* data)
683 Observer* observer = &static_cast<Framework*>(data)->mObserver;
688 static void WatchAppResume(void* data)
690 Observer* observer = &static_cast<Framework*>(data)->mObserver;
692 observer->OnResume();
701 #ifdef APPCORE_WATCH_AVAILABLE
702 mWatchCallback.create = WatchAppCreate;
703 mWatchCallback.app_control = WatchAppControl;
704 mWatchCallback.terminate = WatchAppTerminate;
705 mWatchCallback.pause = WatchAppPause;
706 mWatchCallback.resume = WatchAppResume;
707 mWatchCallback.time_tick = WatchAppTimeTick;
708 mWatchCallback.ambient_tick = WatchAppAmbientTick;
709 mWatchCallback.ambient_changed = WatchAppAmbientChanged;
711 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_BATTERY], AppCore::LOW_BATTERY, AppBatteryLow, mFramework);
712 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_MEMORY], AppCore::LOW_MEMORY, AppMemoryLow, mFramework);
713 AppCore::AppAddEventHandler(&handlers[AppCore::LANGUAGE_CHANGED], AppCore::LANGUAGE_CHANGED, AppLanguageChanged, mFramework);
714 AppCore::AppAddEventHandler(&handlers[AppCore::REGION_FORMAT_CHANGED], AppCore::REGION_FORMAT_CHANGED, AppRegionChanged, mFramework);
716 ret = watch_app_main(*mFramework->mArgc, *mFramework->mArgv, &mWatchCallback, mFramework);
723 #ifdef APPCORE_WATCH_AVAILABLE
728 #ifdef COMPONENT_APPLICATION_SUPPORT
729 int AppComponentMain()
731 /*Crate component_based_app_base_lifecycle_callback*/
732 component_based_app_base_lifecycle_callback_s callback;
733 callback.init = AppInit;
734 callback.run = AppRun;
735 callback.exit = AppExit;
736 callback.create = ComponentAppCreate;
737 callback.terminate = ComponentAppTerminate;
738 callback.fini = ComponentAppFinish;
740 return component_based_app_base_main(*mFramework->mArgc, *mFramework->mArgv, &callback, mFramework);
744 static void* ComponentAppCreate(void* data)
746 Framework* framework = static_cast<Framework*>(data);
747 Observer* observer = &framework->mObserver;
750 return Dali::AnyCast<void*>(observer->OnCreate());
753 static void ComponentAppTerminate(void* data)
755 Observer* observer = &static_cast<Framework*>(data)->mObserver;
756 observer->OnTerminate();
759 static void ComponentAppFinish(void* data)
763 if(getenv("AUL_LOADER_INIT"))
765 setenv("AUL_LOADER_INIT", "0", 1);
770 void AppComponentExit()
772 component_based_app_base_exit();
779 Impl(const Impl& impl);
782 Impl& operator=(const Impl& impl);
785 Framework::Framework(Framework::Observer& observer, int* argc, char*** argv, Type type)
786 : mObserver(observer),
794 mAbortHandler(MakeCallback(this, &Framework::AbortCallback)),
797 bool featureFlag = true;
798 system_info_get_platform_bool("tizen.org/feature/opengles.version.2_0", &featureFlag);
800 if(featureFlag == false)
802 set_last_result(TIZEN_ERROR_NOT_SUPPORTED);
804 #ifdef DALI_ELDBUS_AVAILABLE
805 // Initialize ElDBus.
806 DALI_LOG_INFO(gDBusLogging, Debug::General, "Starting DBus Initialization\n");
811 mImpl = new Impl(this, type);
814 Framework::~Framework()
821 #ifdef DALI_ELDBUS_AVAILABLE
823 DALI_LOG_INFO(gDBusLogging, Debug::General, "Shutting down DBus\n");
830 bool Framework::Create()
837 void Framework::Run()
842 ret = mImpl->AppMain();
843 if(ret != APP_ERROR_NONE)
845 DALI_LOG_ERROR("Framework::Run(), ui_app_main() is failed. err = %d\n", ret);
850 void Framework::Quit()
855 bool Framework::IsMainLoopRunning()
860 void Framework::AddAbortCallback(CallbackBase* callback)
862 mImpl->mAbortCallBack = callback;
865 std::string Framework::GetBundleName() const
870 void Framework::SetBundleName(const std::string& name)
875 std::string Framework::GetBundleId() const
880 std::string Framework::GetResourcePath()
882 std::string resourcePath = "";
883 #if defined(TIZEN_PLATFORM_CONFIG_SUPPORTED) && TIZEN_PLATFORM_CONFIG_SUPPORTED
884 char* app_rsc_path = app_get_resource_path();
887 resourcePath = app_rsc_path;
890 #else // For backwards compatibility with older Tizen versions
892 // "DALI_APPLICATION_PACKAGE" is used to get the already configured Application package path.
893 const char* environmentVariable = "DALI_APPLICATION_PACKAGE";
894 char* value = getenv(environmentVariable);
897 resourcePath = value;
900 if(resourcePath.back() != '/')
905 #endif //TIZEN_PLATFORM_CONFIG_SUPPORTED
910 std::string Framework::GetDataPath()
913 char* dataPath = app_get_data_path();
922 void Framework::SetBundleId(const std::string& id)
927 void Framework::AbortCallback()
929 // if an abort call back has been installed run it.
930 if(mImpl->mAbortCallBack)
932 CallbackBase::Execute(*mImpl->mAbortCallBack);
940 void Framework::InitThreads()
944 void Framework::SetLanguage(const std::string& language)
946 mImpl->SetLanguage(language);
949 void Framework::SetRegion(const std::string& region)
951 mImpl->SetRegion(region);
954 std::string Framework::GetLanguage() const
956 return mImpl->GetLanguage();
959 std::string Framework::GetRegion() const
961 return mImpl->GetRegion();
964 } // namespace Adaptor
966 } // namespace Internal