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();
197 char* region = nullptr;
198 char* language = nullptr;
199 system_settings_get_value_string(SYSTEM_SETTINGS_KEY_LOCALE_COUNTRY, ®ion);
200 system_settings_get_value_string(SYSTEM_SETTINGS_KEY_LOCALE_LANGUAGE, &language);
202 if(region != nullptr)
204 mRegion = std::string(region);
208 if(language != nullptr)
210 mLanguage = std::string(language);
217 delete mAbortCallBack;
219 // we're quiting the main loop so
220 // mCallbackManager->RemoveAllCallBacks() does not need to be called
221 // to delete our abort handler
222 delete mCallbackManager;
228 switch(mApplicationType)
232 ret = AppNormalMain();
237 ret = AppWidgetMain();
242 ret = AppWatchMain();
245 #ifdef COMPONENT_APPLICATION_SUPPORT
248 ret = AppComponentMain();
258 switch(mApplicationType)
275 #ifdef COMPONENT_APPLICATION_SUPPORT
285 void SetLanguage(const std::string& language)
287 mLanguage = language;
290 void SetRegion(const std::string& region)
295 std::string GetLanguage() const
300 std::string GetRegion() const
306 Type mApplicationType;
307 CallbackBase* mAbortCallBack;
308 CallbackManager* mCallbackManager;
309 std::string mLanguage;
312 Framework* mFramework;
313 AppCore::AppEventHandlerPtr handlers[5];
314 #ifdef APPCORE_WATCH_AVAILABLE
315 watch_app_lifecycle_callback_s mWatchCallback;
316 app_event_handler_h watchHandlers[5];
319 static int AppCreate(void* data)
321 appcore_ui_base_on_create();
322 return static_cast<int>(static_cast<Framework*>(data)->Create());
325 static int AppTerminate(void* data)
327 appcore_ui_base_on_terminate();
328 Observer* observer = &static_cast<Framework*>(data)->mObserver;
330 observer->OnTerminate();
335 static int AppPause(void* data)
337 appcore_ui_base_on_pause();
338 Observer* observer = &static_cast<Framework*>(data)->mObserver;
345 static int AppResume(void* data)
347 appcore_ui_base_on_resume();
348 Observer* observer = &static_cast<Framework*>(data)->mObserver;
350 observer->OnResume();
355 static void ProcessBundle(Framework* framework, bundle* bundleData)
357 if(bundleData == NULL)
363 char* bundleName = const_cast<char*>(bundle_get_val(bundleData, "name"));
364 if(bundleName != NULL)
366 framework->SetBundleName(bundleName);
370 char* bundleId = const_cast<char*>(bundle_get_val(bundleData, "id"));
373 framework->SetBundleId(bundleId);
378 * Called by AppCore when the application is launched from another module (e.g. homescreen).
379 * @param[in] b the bundle data which the launcher module sent
381 static int AppControl(bundle* bundleData, void* data)
383 app_control_h appControl = NULL;
385 appcore_ui_base_on_control(bundleData);
389 if(app_control_create_event(bundleData, &appControl) != TIZEN_ERROR_NONE)
391 DALI_LOG_ERROR("Failed to create an app_control handle");
396 if(app_control_create(&appControl) != TIZEN_ERROR_NONE)
398 DALI_LOG_ERROR("Failed to create an app_control handle");
402 Framework* framework = static_cast<Framework*>(data);
403 Observer* observer = &framework->mObserver;
405 ProcessBundle(framework, bundleData);
408 observer->OnAppControl(appControl);
410 app_control_destroy(appControl);
415 static void AppInit(int argc, char** argv, void* data)
417 #pragma GCC diagnostic push
418 #pragma GCC diagnostic ignored "-Wold-style-cast"
421 ecore_app_args_set(argc, (const char**)argv);
423 #pragma GCC diagnostic pop
426 static void AppFinish(void)
430 if(getenv("AUL_LOADER_INIT"))
432 setenv("AUL_LOADER_INIT", "0", 1);
437 static void AppRun(void* data)
439 ecore_main_loop_begin();
442 static void AppExit(void* data)
444 ecore_main_loop_quit();
447 static void AppLanguageChanged(AppCore::AppEventInfoPtr event, void* data)
449 Framework* framework = static_cast<Framework*>(data);
450 Observer* observer = &framework->mObserver;
452 if(event && event->value)
454 framework->SetLanguage(std::string(static_cast<const char*>(event->value)));
455 observer->OnLanguageChanged();
459 DALI_LOG_ERROR("NULL pointer in Language changed event\n");
463 static void AppDeviceRotated(AppCore::AppEventInfoPtr event_info, void* data)
467 static void AppRegionChanged(AppCore::AppEventInfoPtr event, void* data)
469 Framework* framework = static_cast<Framework*>(data);
470 Observer* observer = &framework->mObserver;
472 if(event && event->value)
474 framework->SetRegion(std::string(static_cast<const char*>(event->value)));
475 observer->OnRegionChanged();
479 DALI_LOG_ERROR("NULL pointer in Region changed event\n");
483 static void AppBatteryLow(AppCore::AppEventInfoPtr event, void* data)
485 Observer* observer = &static_cast<Framework*>(data)->mObserver;
486 int status = *static_cast<int*>(event->value);
487 Dali::DeviceStatus::Battery::Status result = Dali::DeviceStatus::Battery::NORMAL;
489 // convert to dali battery status
494 result = Dali::DeviceStatus::Battery::POWER_OFF;
499 result = Dali::DeviceStatus::Battery::CRITICALLY_LOW;
505 observer->OnBatteryLow(result);
508 static void AppMemoryLow(AppCore::AppEventInfoPtr event, void* data)
510 Observer* observer = &static_cast<Framework*>(data)->mObserver;
511 int status = *static_cast<int*>(event->value);
512 Dali::DeviceStatus::Memory::Status result = Dali::DeviceStatus::Memory::NORMAL;
514 // convert to dali memmory status
519 result = Dali::DeviceStatus::Memory::NORMAL;
524 result = Dali::DeviceStatus::Memory::LOW;
529 result = Dali::DeviceStatus::Memory::CRITICALLY_LOW;
535 observer->OnMemoryLow(result);
542 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_BATTERY], AppCore::LOW_BATTERY, AppBatteryLow, mFramework);
543 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_MEMORY], AppCore::LOW_MEMORY, AppMemoryLow, mFramework);
544 AppCore::AppAddEventHandler(&handlers[AppCore::DEVICE_ORIENTATION_CHANGED], AppCore::DEVICE_ORIENTATION_CHANGED, AppDeviceRotated, mFramework);
545 AppCore::AppAddEventHandler(&handlers[AppCore::LANGUAGE_CHANGED], AppCore::LANGUAGE_CHANGED, AppLanguageChanged, mFramework);
546 AppCore::AppAddEventHandler(&handlers[AppCore::REGION_FORMAT_CHANGED], AppCore::REGION_FORMAT_CHANGED, AppRegionChanged, mFramework);
548 appcore_ui_base_ops ops = appcore_ui_base_get_default_ops();
550 /* override methods */
551 ops.base.create = AppCreate;
552 ops.base.control = AppControl;
553 ops.base.terminate = AppTerminate;
554 ops.pause = AppPause;
555 ops.resume = AppResume;
556 ops.base.init = AppInit;
557 ops.base.finish = AppFinish;
558 ops.base.run = AppRun;
559 ops.base.exit = AppExit;
561 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);
563 if(ret != TIZEN_ERROR_NONE)
566 appcore_ui_base_fini();
568 return TIZEN_ERROR_NONE;
573 appcore_ui_base_exit();
581 static int WidgetAppCreate(void* data)
583 widget_base_on_create();
584 return static_cast<int>(static_cast<Framework*>(data)->Create());
587 static int WidgetAppTerminate(void* data)
589 Observer* observer = &static_cast<Framework*>(data)->mObserver;
590 observer->OnTerminate();
592 widget_base_on_terminate();
598 if(!IsWidgetFeatureEnabled())
600 DALI_LOG_ERROR("widget feature is not supported");
604 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_BATTERY], AppCore::LOW_BATTERY, AppBatteryLow, mFramework);
605 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_MEMORY], AppCore::LOW_MEMORY, AppMemoryLow, mFramework);
606 AppCore::AppAddEventHandler(&handlers[AppCore::DEVICE_ORIENTATION_CHANGED], AppCore::DEVICE_ORIENTATION_CHANGED, AppDeviceRotated, mFramework);
607 AppCore::AppAddEventHandler(&handlers[AppCore::LANGUAGE_CHANGED], AppCore::LANGUAGE_CHANGED, AppLanguageChanged, mFramework);
608 AppCore::AppAddEventHandler(&handlers[AppCore::REGION_FORMAT_CHANGED], AppCore::REGION_FORMAT_CHANGED, AppRegionChanged, mFramework);
610 widget_base_ops ops = widget_base_get_default_ops();
612 /* override methods */
613 ops.create = WidgetAppCreate;
614 ops.terminate = WidgetAppTerminate;
616 ops.finish = AppFinish;
620 int result = widget_base_init(ops, *mFramework->mArgc, *mFramework->mArgv, mFramework);
627 #ifdef APPCORE_WATCH_AVAILABLE
628 static bool WatchAppCreate(int width, int height, void* data)
630 return static_cast<Framework*>(data)->Create();
633 static void WatchAppTimeTick(watch_time_h time, void* data)
635 Observer* observer = &static_cast<Framework*>(data)->mObserver;
636 WatchTime curTime(time);
638 observer->OnTimeTick(curTime);
641 static void WatchAppAmbientTick(watch_time_h time, void* data)
643 Observer* observer = &static_cast<Framework*>(data)->mObserver;
644 WatchTime curTime(time);
646 observer->OnAmbientTick(curTime);
649 static void WatchAppAmbientChanged(bool ambient, void* data)
651 Observer* observer = &static_cast<Framework*>(data)->mObserver;
653 observer->OnAmbientChanged(ambient);
656 static void WatchAppControl(app_control_h app_control, void* data)
658 Framework* framework = static_cast<Framework*>(data);
659 Observer* observer = &framework->mObserver;
660 bundle* bundleData = NULL;
662 app_control_to_bundle(app_control, &bundleData);
663 ProcessBundle(framework, bundleData);
666 observer->OnAppControl(app_control);
669 static void WatchAppTerminate(void* data)
671 Observer* observer = &static_cast<Framework*>(data)->mObserver;
673 observer->OnTerminate();
676 static void WatchAppPause(void* data)
678 Observer* observer = &static_cast<Framework*>(data)->mObserver;
683 static void WatchAppResume(void* data)
685 Observer* observer = &static_cast<Framework*>(data)->mObserver;
687 observer->OnResume();
696 #ifdef APPCORE_WATCH_AVAILABLE
697 mWatchCallback.create = WatchAppCreate;
698 mWatchCallback.app_control = WatchAppControl;
699 mWatchCallback.terminate = WatchAppTerminate;
700 mWatchCallback.pause = WatchAppPause;
701 mWatchCallback.resume = WatchAppResume;
702 mWatchCallback.time_tick = WatchAppTimeTick;
703 mWatchCallback.ambient_tick = WatchAppAmbientTick;
704 mWatchCallback.ambient_changed = WatchAppAmbientChanged;
706 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_BATTERY], AppCore::LOW_BATTERY, AppBatteryLow, mFramework);
707 AppCore::AppAddEventHandler(&handlers[AppCore::LOW_MEMORY], AppCore::LOW_MEMORY, AppMemoryLow, mFramework);
708 AppCore::AppAddEventHandler(&handlers[AppCore::LANGUAGE_CHANGED], AppCore::LANGUAGE_CHANGED, AppLanguageChanged, mFramework);
709 AppCore::AppAddEventHandler(&handlers[AppCore::REGION_FORMAT_CHANGED], AppCore::REGION_FORMAT_CHANGED, AppRegionChanged, mFramework);
711 ret = watch_app_main(*mFramework->mArgc, *mFramework->mArgv, &mWatchCallback, mFramework);
718 #ifdef APPCORE_WATCH_AVAILABLE
723 #ifdef COMPONENT_APPLICATION_SUPPORT
724 int AppComponentMain()
726 /*Crate component_based_app_base_lifecycle_callback*/
727 component_based_app_base_lifecycle_callback_s callback;
728 callback.init = AppInit;
729 callback.run = AppRun;
730 callback.exit = AppExit;
731 callback.create = ComponentAppCreate;
732 callback.terminate = ComponentAppTerminate;
733 callback.fini = ComponentAppFinish;
735 return component_based_app_base_main(*mFramework->mArgc, *mFramework->mArgv, &callback, mFramework);
739 static void* ComponentAppCreate(void* data)
741 Framework* framework = static_cast<Framework*>(data);
742 Observer* observer = &framework->mObserver;
745 return Dali::AnyCast<void*>(observer->OnCreate());
748 static void ComponentAppTerminate(void* data)
750 Observer* observer = &static_cast<Framework*>(data)->mObserver;
751 observer->OnTerminate();
754 static void ComponentAppFinish(void* data)
758 if(getenv("AUL_LOADER_INIT"))
760 setenv("AUL_LOADER_INIT", "0", 1);
765 void AppComponentExit()
767 component_based_app_base_exit();
774 Impl(const Impl& impl);
777 Impl& operator=(const Impl& impl);
780 Framework::Framework(Framework::Observer& observer, int* argc, char*** argv, Type type)
781 : mObserver(observer),
789 mAbortHandler(MakeCallback(this, &Framework::AbortCallback)),
792 bool featureFlag = true;
793 system_info_get_platform_bool("tizen.org/feature/opengles.version.2_0", &featureFlag);
795 if(featureFlag == false)
797 set_last_result(TIZEN_ERROR_NOT_SUPPORTED);
799 #ifdef DALI_ELDBUS_AVAILABLE
800 // Initialize ElDBus.
801 DALI_LOG_INFO(gDBusLogging, Debug::General, "Starting DBus Initialization\n");
806 mImpl = new Impl(this, type);
809 Framework::~Framework()
816 #ifdef DALI_ELDBUS_AVAILABLE
818 DALI_LOG_INFO(gDBusLogging, Debug::General, "Shutting down DBus\n");
825 bool Framework::Create()
832 void Framework::Run()
837 ret = mImpl->AppMain();
838 if(ret != APP_ERROR_NONE)
840 DALI_LOG_ERROR("Framework::Run(), ui_app_main() is failed. err = %d\n", ret);
845 void Framework::Quit()
850 bool Framework::IsMainLoopRunning()
855 void Framework::AddAbortCallback(CallbackBase* callback)
857 mImpl->mAbortCallBack = callback;
860 std::string Framework::GetBundleName() const
865 void Framework::SetBundleName(const std::string& name)
870 std::string Framework::GetBundleId() const
875 std::string Framework::GetResourcePath()
877 std::string resourcePath = "";
878 #if defined(TIZEN_PLATFORM_CONFIG_SUPPORTED) && TIZEN_PLATFORM_CONFIG_SUPPORTED
879 char* app_rsc_path = app_get_resource_path();
882 resourcePath = app_rsc_path;
885 #else // For backwards compatibility with older Tizen versions
887 // "DALI_APPLICATION_PACKAGE" is used to get the already configured Application package path.
888 const char* environmentVariable = "DALI_APPLICATION_PACKAGE";
889 char* value = getenv(environmentVariable);
892 resourcePath = value;
895 if(resourcePath.back() != '/')
900 #endif //TIZEN_PLATFORM_CONFIG_SUPPORTED
905 std::string Framework::GetDataPath()
908 char* dataPath = app_get_data_path();
917 void Framework::SetBundleId(const std::string& id)
922 void Framework::AbortCallback()
924 // if an abort call back has been installed run it.
925 if(mImpl->mAbortCallBack)
927 CallbackBase::Execute(*mImpl->mAbortCallBack);
935 void Framework::InitThreads()
939 void Framework::SetLanguage(const std::string& language)
941 mImpl->SetLanguage(language);
944 void Framework::SetRegion(const std::string& region)
946 mImpl->SetRegion(region);
949 std::string Framework::GetLanguage() const
951 return mImpl->GetLanguage();
954 std::string Framework::GetRegion() const
956 return mImpl->GetRegion();
959 } // namespace Adaptor
961 } // namespace Internal