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

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