dali/internal/system/tizen-wayland/widget-application-impl-tizen.cpp

   1 /*
   2  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/system/tizen-wayland/widget-application-impl-tizen.h>
  20
  21 // INTERNAL INCLUDE
  22 #include <dali/devel-api/events/key-event-devel.h>
  23 #include <dali/internal/adaptor/common/adaptor-impl.h>
  24 #include <dali/internal/system/common/environment-variables.h>
  25 #include <dali/internal/system/tizen-wayland/widget-controller-tizen.h>
  26 #include <dali/public-api/adaptor-framework/widget-impl.h>
  27 #include <dali/public-api/adaptor-framework/widget.h>
  28
  29 // EXTERNAL INCLUDES
  30 #include <bundle.h>
  31 #include <widget_base.h>
  32
  33 namespace Dali
  34 {
  35 namespace Internal
  36 {
  37 namespace
  38 {
  39 /**
  40  * This Api is called when widget viewer send keyEvent.
  41  * In this API, widget framework create a new keyEvent, find the proper widget and send this event.
  42  * Finally widget framework receive feedback from widget.
  43  */
  44 #ifdef OVER_TIZEN_VERSION_7
  45 bool OnKeyEventCallback(const char* id, screen_connector_event_type_e eventType, int keyCode, const char* keyName, long long cls, long long subcls, const char* identifier, long long timestamp, void* userData)
  46 {
  47   Dali::Internal::Adaptor::WidgetApplicationTizen* application = static_cast<Dali::Internal::Adaptor::WidgetApplicationTizen*>(userData);
  48
  49   // Create new key for widget
  50   Dali::KeyEvent::State state = Dali::KeyEvent::DOWN;
  51   if(eventType == SCREEN_CONNECTOR_EVENT_TYPE_KEY_DOWN)
  52   {
  53     state = Dali::KeyEvent::DOWN;
  54   }
  55   else if(eventType == SCREEN_CONNECTOR_EVENT_TYPE_KEY_UP)
  56   {
  57     state = Dali::KeyEvent::UP;
  58   }
  59
  60   bool           consumed     = true;
  61   std::string    keyEventName = std::string(keyName);
  62   Dali::KeyEvent event        = Dali::DevelKeyEvent::New(keyEventName, "", "", keyCode, 0, timestamp, state, "", "", Device::Class::NONE, Device::Subclass::NONE);
  63
  64   if(application)
  65   {
  66     std::string            widgetId       = std::string(id);
  67     widget_base_instance_h instanceHandle = application->GetWidgetInstanceFromWidgetId(widgetId);
  68     if(instanceHandle)
  69     {
  70       consumed = application->FeedKeyEvent(instanceHandle, event);
  71     }
  72   }
  73
  74   return consumed;
  75 }
  76 #endif
  77
  78 int OnInstanceInit(widget_base_instance_h instanceHandle, bundle* content, int w, int h, void* classData)
  79 {
  80   char* id;
  81   widget_base_context_get_id(instanceHandle, &id);
  82
  83   widget_base_class_on_create(instanceHandle, content, w, h);
  84
  85   Dali::Internal::Adaptor::WidgetApplicationTizen* application = static_cast<Dali::Internal::Adaptor::WidgetApplicationTizen*>(classData);
  86
  87   Dali::Window window;
  88   if(application->GetWidgetCount() == 0)
  89   {
  90     window = application->GetWindow();
  91     DALI_LOG_RELEASE_INFO("Widget Instance use default Window(win:%p), so it need to bind widget (%dx%d) (id:%s) \n", window, w, h, std::string(id).c_str());
  92   }
  93   else
  94   {
  95     window = Dali::Window::New(PositionSize(0, 0, w, h), "", false);
  96     if(window)
  97     {
  98       DALI_LOG_RELEASE_INFO("Widget Instance create new Window  (win:%p, cnt:%d) (%dx%d) (id:%s )\n", window, application->GetWidgetCount(), w, h, std::string(id).c_str());
  99     }
 100     else
 101     {
 102       DALI_LOG_ERROR("This device can't support Multi Widget. it means UI may not be properly drawn.");
 103       window = application->GetWindow();
 104     }
 105   }
 106
 107   Any nativeHandle = window.GetNativeHandle();
 108
 109 #ifdef ECORE_WAYLAND2
 110   Ecore_Wl2_Window* wlWindow = AnyCast<Ecore_Wl2_Window*>(nativeHandle);
 111 #else
 112   Ecore_Wl_Window* wlWindow = AnyCast<Ecore_Wl_Window*>(nativeHandle);
 113 #endif
 114
 115   widget_base_context_window_bind(instanceHandle, id, wlWindow);
 116   window.SetSize(Dali::Window::WindowSize(w, h));
 117
 118   Dali::Internal::Adaptor::WidgetApplication::CreateWidgetFunctionPair pair           = application->GetWidgetCreatingFunctionPair(std::string(id));
 119   Dali::WidgetApplication::CreateWidgetFunction                        createFunction = pair.second;
 120
 121   Dali::Widget widgetInstance = createFunction(pair.first);
 122
 123   Dali::Internal::Adaptor::Widget::Impl* widgetImpl = new Dali::Internal::Adaptor::WidgetImplTizen(instanceHandle);
 124   Internal::Adaptor::GetImplementation(widgetInstance).SetImpl(widgetImpl);
 125
 126   application->AddWidget(instanceHandle, widgetInstance, window, std::string(id));
 127
 128   std::string encodedContentString = "";
 129
 130   if(bundle_get_count(content))
 131   {
 132     bundle_raw* bundleRaw;
 133     int         len;
 134     bundle_encode(content, &bundleRaw, &len);
 135     char* encodedContent = reinterpret_cast<char*>(bundleRaw);
 136     encodedContentString = std::string(encodedContent);
 137     free(bundleRaw);
 138   }
 139
 140   Internal::Adaptor::GetImplementation(widgetInstance).OnCreate(encodedContentString, window);
 141
 142   // connect keyEvent for widget
 143 #ifdef OVER_TIZEN_VERSION_7
 144   application->ConnectKeyEvent(window);
 145 #endif
 146
 147   return 0;
 148 }
 149
 150 int OnInstanceDestroy(widget_base_instance_h instanceHandle, widget_base_destroy_type_e reason, bundle* content, void* classData)
 151 {
 152   Dali::Internal::Adaptor::WidgetApplicationTizen* application = static_cast<Dali::Internal::Adaptor::WidgetApplicationTizen*>(classData);
 153
 154   // Get Dali::Widget instance.
 155   Dali::Widget widgetInstance = application->GetWidget(instanceHandle);
 156
 157   Dali::Widget::Termination destroyReason = Dali::Widget::Termination::TEMPORARY;
 158
 159   if(reason == WIDGET_BASE_DESTROY_TYPE_PERMANENT)
 160   {
 161     destroyReason = Dali::Widget::Termination::PERMANENT;
 162   }
 163
 164   std::string encodedContentString = "";
 165
 166   if(bundle_get_count(content))
 167   {
 168     bundle_raw* bundleRaw;
 169     int         len;
 170     bundle_encode(content, &bundleRaw, &len);
 171     char* encodedContent = reinterpret_cast<char*>(bundleRaw);
 172     encodedContentString = std::string(encodedContent);
 173     free(bundleRaw);
 174   }
 175
 176   Internal::Adaptor::GetImplementation(widgetInstance).OnTerminate(encodedContentString, destroyReason);
 177
 178   widget_base_class_on_destroy(instanceHandle, reason, content);
 179
 180   application->DeleteWidget(instanceHandle);
 181
 182   return 0;
 183 }
 184
 185 int OnInstancePause(widget_base_instance_h instanceHandle, void* classData)
 186 {
 187   widget_base_class_on_pause(instanceHandle);
 188
 189   Dali::Internal::Adaptor::WidgetApplicationTizen* application = static_cast<Dali::Internal::Adaptor::WidgetApplicationTizen*>(classData);
 190
 191   // Get Dali::Widget instance.
 192   Dali::Widget widgetInstance = application->GetWidget(instanceHandle);
 193
 194   Internal::Adaptor::GetImplementation(widgetInstance).OnPause();
 195
 196   return 0;
 197 }
 198
 199 int OnInstanceResume(widget_base_instance_h instanceHandle, void* classData)
 200 {
 201   widget_base_class_on_resume(instanceHandle);
 202
 203   Dali::Internal::Adaptor::WidgetApplicationTizen* application = static_cast<Dali::Internal::Adaptor::WidgetApplicationTizen*>(classData);
 204
 205   // Get Dali::Widget instance.
 206   Dali::Widget widgetInstance = application->GetWidget(instanceHandle);
 207
 208   Internal::Adaptor::GetImplementation(widgetInstance).OnResume();
 209
 210   return 0;
 211 }
 212
 213 int OnInstanceResize(widget_base_instance_h instanceHandle, int w, int h, void* classData)
 214 {
 215   widget_base_class_on_resize(instanceHandle, w, h);
 216
 217   Dali::Internal::Adaptor::WidgetApplicationTizen* application = static_cast<Dali::Internal::Adaptor::WidgetApplicationTizen*>(classData);
 218
 219   // Get Dali::Widget instance.
 220   Dali::Widget widgetInstance = application->GetWidget(instanceHandle);
 221   Dali::Window window         = application->GetWindowFromWidget(widgetInstance);
 222   window.SetSize(Dali::Window::WindowSize(w, h));
 223   Internal::Adaptor::GetImplementation(widgetInstance).OnResize(window);
 224
 225   return 0;
 226 }
 227
 228 int OnInstanceUpdate(widget_base_instance_h instanceHandle, bundle* content, int force, void* classData)
 229 {
 230   widget_base_class_on_update(instanceHandle, content, force);
 231
 232   Dali::Internal::Adaptor::WidgetApplicationTizen* application = static_cast<Dali::Internal::Adaptor::WidgetApplicationTizen*>(classData);
 233
 234   // Get Dali::Widget instance.
 235   Dali::Widget widgetInstance = application->GetWidget(instanceHandle);
 236
 237   std::string encodedContentString = "";
 238
 239   if(bundle_get_count(content))
 240   {
 241     bundle_raw* bundleRaw;
 242     int         len;
 243     bundle_encode(content, &bundleRaw, &len);
 244     char* encodedContent = reinterpret_cast<char*>(bundleRaw);
 245     encodedContentString = std::string(encodedContent);
 246     free(bundleRaw);
 247   }
 248
 249   Internal::Adaptor::GetImplementation(widgetInstance).OnUpdate(encodedContentString, force);
 250
 251   return 0;
 252 }
 253
 254 unsigned int GetEnvWidgetRenderRefreshRate()
 255 {
 256   const char* envVariable = std::getenv(DALI_WIDGET_REFRESH_RATE);
 257
 258   return envVariable ? std::atoi(envVariable) : 1u; // Default 60 fps
 259 }
 260
 261 } // anonymous namespace
 262
 263 namespace Adaptor
 264 {
 265 WidgetApplicationPtr WidgetApplicationTizen::New(
 266   int*               argc,
 267   char**             argv[],
 268   const std::string& stylesheet,
 269   const WindowData&  windowData)
 270 {
 271   return new WidgetApplicationTizen(argc, argv, stylesheet, windowData);
 272 }
 273
 274 WidgetApplicationTizen::WidgetApplicationTizen(int* argc, char** argv[], const std::string& stylesheet, const WindowData& windowData)
 275 : WidgetApplication(argc, argv, stylesheet, windowData),
 276   mConnectedKeyEvent(false),
 277   mReceivedKeyEvent(false)
 278 {
 279 }
 280
 281 WidgetApplicationTizen::~WidgetApplicationTizen()
 282 {
 283 }
 284
 285 void WidgetApplicationTizen::RegisterWidgetCreatingFunction(const std::string& widgetName, Dali::WidgetApplication::CreateWidgetFunction createFunction)
 286 {
 287   AddWidgetCreatingFunctionPair(CreateWidgetFunctionPair(widgetName, createFunction));
 288
 289   // Register widget class to widget framework
 290   widget_base_class cls = widget_base_class_get_default();
 291   cls.ops.create        = OnInstanceInit;
 292   cls.ops.destroy       = OnInstanceDestroy;
 293   cls.ops.pause         = OnInstancePause;
 294   cls.ops.resume        = OnInstanceResume;
 295   cls.ops.resize        = OnInstanceResize;
 296   cls.ops.update        = OnInstanceUpdate;
 297
 298   widget_base_class_add(cls, widgetName.c_str(), this);
 299 }
 300
 301 void WidgetApplicationTizen::AddWidgetCreatingFunctionPair(CreateWidgetFunctionPair pair)
 302 {
 303   mCreateWidgetFunctionContainer.push_back(pair);
 304 }
 305
 306 WidgetApplicationTizen::CreateWidgetFunctionPair WidgetApplicationTizen::GetWidgetCreatingFunctionPair(const std::string& widgetName)
 307 {
 308   int         idx      = widgetName.find(":");
 309   std::string widgetID = widgetName.substr(idx + 1);
 310   for(CreateWidgetFunctionContainer::const_iterator iter = mCreateWidgetFunctionContainer.begin(); iter != mCreateWidgetFunctionContainer.end(); ++iter)
 311   {
 312     if(widgetID.compare((*iter).first) == 0)
 313     {
 314       return *iter;
 315     }
 316   }
 317
 318   return CreateWidgetFunctionPair("", NULL);
 319 }
 320
 321 void WidgetApplicationTizen::AddWidget(widget_base_instance_h widgetBaseInstance, Dali::Widget widget, Dali::Window window, const std::string& widgetId)
 322 {
 323   mWidgetInstanceContainer.push_back(WidgetInstancePair(widgetBaseInstance, widget));
 324   Internal::Adaptor::GetImplementation(widget).SetInformation(window, widgetId);
 325 }
 326
 327 Dali::Widget WidgetApplicationTizen::GetWidget(widget_base_instance_h widgetBaseInstance) const
 328 {
 329   for(auto&& iter : mWidgetInstanceContainer)
 330   {
 331     if((iter).first == widgetBaseInstance)
 332     {
 333       return (iter).second;
 334     }
 335   }
 336   return Dali::Widget();
 337 }
 338
 339 void WidgetApplicationTizen::DeleteWidget(widget_base_instance_h widgetBaseInstance)
 340 {
 341   // Delete WidgetInstance
 342   auto widgetInstance = std::find_if(mWidgetInstanceContainer.begin(),
 343                                      mWidgetInstanceContainer.end(),
 344                                      [widgetBaseInstance](WidgetInstancePair pair) { return (pair.first == widgetBaseInstance); });
 345
 346   if(widgetInstance != mWidgetInstanceContainer.end())
 347   {
 348     mWidgetInstanceContainer.erase(widgetInstance);
 349   }
 350 }
 351
 352 Dali::Window WidgetApplicationTizen::GetWindowFromWidget(Dali::Widget widgetInstance) const
 353 {
 354   if(widgetInstance)
 355   {
 356     return Internal::Adaptor::GetImplementation(widgetInstance).GetWindow();
 357   }
 358
 359   return Dali::Window();
 360 }
 361
 362 widget_base_instance_h WidgetApplicationTizen::GetWidgetInstanceFromWidgetId(std::string& widgetId) const
 363 {
 364   for(auto&& iter : mWidgetInstanceContainer)
 365   {
 366     if(widgetId == Internal::Adaptor::GetImplementation((iter).second).GetWidgetId())
 367     {
 368       return (iter).first;
 369     }
 370   }
 371
 372   return nullptr;
 373 }
 374
 375 int WidgetApplicationTizen::GetWidgetCount()
 376 {
 377   return mWidgetInstanceContainer.size();
 378 }
 379
 380 void WidgetApplicationTizen::ConnectKeyEvent(Dali::Window window)
 381 {
 382   if(!mConnectedKeyEvent)
 383   {
 384 #ifdef OVER_TIZEN_VERSION_7
 385     screen_connector_provider_set_key_event_cb(OnKeyEventCallback, this);
 386 #endif
 387     mConnectedKeyEvent = true;
 388   }
 389   window.KeyEventSignal().Connect(this, &WidgetApplicationTizen::OnWindowKeyEvent);
 390 }
 391
 392 void WidgetApplicationTizen::OnWindowKeyEvent(const Dali::KeyEvent& event)
 393 {
 394   // If Widget Application consume key event, this api is not called.
 395   mReceivedKeyEvent = true;
 396 }
 397
 398 bool WidgetApplicationTizen::FeedKeyEvent(widget_base_instance_h instanceHandle, const Dali::KeyEvent& keyEvent)
 399 {
 400   bool consumed = true;
 401
 402   // Check if application consume key event
 403   Dali::Widget widgetInstance = GetWidget(instanceHandle);
 404   if(widgetInstance)
 405   {
 406     Dali::Window window = GetWindowFromWidget(widgetInstance);
 407
 408     // Reset the state of key received
 409     mReceivedKeyEvent = false;
 410
 411     // Feed the keyEvent to widget window
 412     DevelWindow::FeedKeyEvent(window, keyEvent);
 413
 414     // if the application is not using a key event, verify that the window in the widget has received a key event.
 415     if(Internal::Adaptor::GetImplementation(widgetInstance).IsKeyEventUsing() == false)
 416     {
 417       // if the window has received a key event, widget need to consume its key event
 418       consumed = (mReceivedKeyEvent) ? false : true;
 419     }
 420   }
 421
 422   return consumed;
 423 }
 424
 425 void WidgetApplicationTizen::OnInit()
 426 {
 427   WidgetApplication::OnInit();
 428
 429   Dali::Adaptor::Get().SetRenderRefreshRate(GetEnvWidgetRenderRefreshRate());
 430 }
 431
 432 // factory function, must be implemented
 433 namespace WidgetApplicationFactory
 434 {
 435 /**
 436  * Create a new widget application
 437  * @param[in]  argc         A pointer to the number of arguments
 438  * @param[in]  argv         A pointer to the argument list
 439  * @param[in]  stylesheet   The path to user defined theme file
 440  * @param[in]  windowData   The window data
 441  */
 442 Dali::Internal::Adaptor::WidgetApplicationPtr Create(int* argc, char** argv[], const std::string& stylesheet, const WindowData& windowData)
 443 {
 444   return WidgetApplicationTizen::New(argc, argv, stylesheet, windowData);
 445 }
 446
 447 } // namespace WidgetApplicationFactory
 448
 449 } // namespace Adaptor
 450
 451 } // namespace Internal
 452
 453 } // namespace Dali