adaptors/ecore/wayland/window-impl-ecore-wl.cpp

   1 /*
   2  * Copyright (c) 2014 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 "window-impl.h"
  20
  21 // EXTERNAL HEADERS
  22 #include <Ecore.h>
  23 #include <Ecore_Wayland.h>
  24
  25 #include <dali/integration-api/core.h>
  26 #include <dali/integration-api/system-overlay.h>
  27 #include <dali/public-api/render-tasks/render-task.h>
  28 #include <dali/public-api/render-tasks/render-task-list.h>
  29 #include <orientation.h>
  30
  31 // INTERNAL HEADERS
  32 #include <window-render-surface.h>
  33 #include <drag-and-drop-detector-impl.h>
  34 #include <ecore-indicator-impl.h>
  35 #include <window-visibility-observer.h>
  36 #include <orientation-impl.h>
  37 namespace
  38 {
  39 const float INDICATOR_ANIMATION_DURATION( 0.18f ); // 180 milli seconds
  40 const float INDICATOR_SHOW_Y_POSITION( 0.0f );
  41 const float INDICATOR_HIDE_Y_POSITION( -52.0f );
  42 }
  43
  44 namespace Dali
  45 {
  46 namespace Internal
  47 {
  48 namespace Adaptor
  49 {
  50 #if defined(DEBUG_ENABLED)
  51 Debug::Filter* gWindowLogFilter = Debug::Filter::New(Debug::Concise, false, "LOG_WINDOW");
  52 #endif
  53
  54 /**
  55  * TODO: Abstract Window class out and move this into a window implementation for Ecore
  56  */
  57 struct Window::EventHandler
  58 {
  59   /**
  60    * Constructor
  61    * @param[in]  window  A pointer to the window class.
  62    */
  63   EventHandler( Window* window )
  64   : mWindow( window ),
  65     mWindowPropertyHandler( NULL ),
  66     mWindowIconifyStateHandler( NULL ),
  67     mEcoreWindow( 0 )
  68   {
  69     // store ecore window handle
  70     ECore::WindowRenderSurface* wlWindow( dynamic_cast< ECore::WindowRenderSurface * >( mWindow->mSurface ) );
  71     if( wlWindow )
  72     {
  73       mEcoreWindow = wlWindow->GetWlWindow();
  74     }
  75     DALI_ASSERT_ALWAYS( mEcoreWindow != 0 && "There is no ecore Wl window");
  76
  77 #ifndef DALI_PROFILE_UBUNTU
  78     if( mWindow->mEcoreEventHander )
  79     {
  80       mWindowIconifyStateHandler = ecore_event_handler_add( ECORE_WL_EVENT_WINDOW_ICONIFY_STATE_CHANGE, EcoreEventWindowIconifyStateChanged, this );
  81     }
  82 #endif
  83
  84   }
  85
  86   /**
  87    * Destructor
  88    */
  89   ~EventHandler()
  90   {
  91     if ( mWindowPropertyHandler )
  92     {
  93       ecore_event_handler_del( mWindowPropertyHandler );
  94     }
  95     if ( mWindowIconifyStateHandler )
  96     {
  97       ecore_event_handler_del( mWindowIconifyStateHandler );
  98     }
  99   }
 100
 101   // Static methods
 102
 103   /// Called when the window properties are changed.
 104   static Eina_Bool EcoreEventWindowPropertyChanged( void* data, int type, void* event )
 105   {
 106     return EINA_FALSE;
 107   }
 108
 109 #ifndef DALI_PROFILE_UBUNTU
 110   /// Called when the window iconify state is changed.
 111   static Eina_Bool EcoreEventWindowIconifyStateChanged( void* data, int type, void* event )
 112   {
 113     Ecore_Wl_Event_Window_Iconify_State_Change* iconifyChangedEvent( (Ecore_Wl_Event_Window_Iconify_State_Change*)event );
 114     EventHandler* handler( (EventHandler*)data );
 115     Eina_Bool handled( ECORE_CALLBACK_PASS_ON );
 116
 117     if ( handler && handler->mWindow )
 118     {
 119       WindowVisibilityObserver* observer( handler->mWindow->mAdaptor );
 120       if ( observer && ( iconifyChangedEvent->win == (unsigned int) ecore_wl_window_id_get( handler->mEcoreWindow ) ) )
 121       {
 122         if( iconifyChangedEvent->iconified == EINA_TRUE )
 123         {
 124           observer->OnWindowHidden();
 125           DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Iconfied\n", handler->mEcoreWindow );
 126         }
 127         else
 128         {
 129           observer->OnWindowShown();
 130           DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Shown\n", handler->mEcoreWindow );
 131         }
 132         handled = ECORE_CALLBACK_DONE;
 133       }
 134     }
 135
 136     return handled;
 137   }
 138 #endif
 139
 140   // Data
 141   Window* mWindow;
 142   Ecore_Event_Handler* mWindowPropertyHandler;
 143   Ecore_Event_Handler* mWindowIconifyStateHandler;
 144   Ecore_Wl_Window* mEcoreWindow;
 145 };
 146
 147
 148 Window* Window::New(const PositionSize& posSize, const std::string& name, const std::string& className, bool isTransparent)
 149 {
 150   Window* window = new Window();
 151   window->mIsTransparent = isTransparent;
 152   window->Initialize(posSize, name, className);
 153   return window;
 154 }
 155
 156 void Window::SetAdaptor(Dali::Adaptor& adaptor)
 157 {
 158   DALI_ASSERT_ALWAYS( !mStarted && "Adaptor already started" );
 159   mStarted = true;
 160
 161   // Only create one overlay per window
 162   Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation(adaptor);
 163   Integration::Core& core = adaptorImpl.GetCore();
 164   mOverlay = &core.GetSystemOverlay();
 165
 166   Dali::RenderTaskList taskList = mOverlay->GetOverlayRenderTasks();
 167   taskList.CreateTask();
 168
 169   mAdaptor = &adaptorImpl;
 170   mAdaptor->AddObserver( *this );
 171
 172   // Can only create the detector when we know the Core has been instantiated.
 173   mDragAndDropDetector = DragAndDropDetector::New();
 174   mAdaptor->SetDragAndDropDetector( &GetImplementation( mDragAndDropDetector ) );
 175
 176   if( mOrientation )
 177   {
 178     mOrientation->SetAdaptor(adaptor);
 179   }
 180
 181   if( mIndicator != NULL )
 182   {
 183     mIndicator->SetAdaptor(mAdaptor);
 184   }
 185 }
 186
 187 RenderSurface* Window::GetSurface()
 188 {
 189   return mSurface;
 190 }
 191
 192 void Window::ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode )
 193 {
 194   DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "visible : %d\n", visibleMode );
 195   DALI_ASSERT_DEBUG(mOverlay);
 196
 197   ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
 198   DALI_ASSERT_DEBUG(wlSurface);
 199   Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
 200
 201   mIndicatorVisible = visibleMode;
 202
 203   if ( mIndicatorVisible == Dali::Window::VISIBLE )
 204   {
 205     // when the indicator is visible, set proper mode for indicator server according to bg mode
 206     if ( mIndicatorOpacityMode == Dali::Window::OPAQUE )
 207     {
 208       ecore_wl_window_indicator_opacity_set(wlWindow, ECORE_WL_INDICATOR_OPAQUE);
 209     }
 210     else if ( mIndicatorOpacityMode == Dali::Window::TRANSLUCENT )
 211     {
 212       ecore_wl_window_indicator_opacity_set(wlWindow, ECORE_WL_INDICATOR_TRANSLUCENT);
 213     }
 214     else if ( mIndicatorOpacityMode == Dali::Window::TRANSPARENT )
 215     {
 216       ecore_wl_window_indicator_opacity_set(wlWindow, ECORE_WL_INDICATOR_OPAQUE);
 217     }
 218   }
 219   else
 220   {
 221     // when the indicator is not visible, set TRANSPARENT mode for indicator server
 222     ecore_wl_window_indicator_opacity_set(wlWindow, ECORE_WL_INDICATOR_TRANSPARENT); // it means hidden indicator
 223   }
 224
 225   DoShowIndicator( mIndicatorOrientation );
 226 }
 227
 228 void Window::RotateIndicator(Dali::Window::WindowOrientation orientation)
 229 {
 230   DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "Orientation: %d\n", orientation );
 231
 232   DoRotateIndicator( orientation );
 233 }
 234
 235 void Window::SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacityMode )
 236 {
 237   mIndicatorOpacityMode = opacityMode;
 238
 239   if( mIndicator != NULL )
 240   {
 241     mIndicator->SetOpacityMode( opacityMode );
 242   }
 243 }
 244
 245 void Window::SetClass(std::string name, std::string klass)
 246 {
 247 }
 248
 249 Window::Window()
 250 : mSurface(NULL),
 251   mIndicatorVisible(Dali::Window::VISIBLE),
 252   mIndicatorIsShown(false),
 253   mShowRotatedIndicatorOnClose(false),
 254   mStarted(false),
 255   mIsTransparent(false),
 256   mWMRotationAppSet(false),
 257   mEcoreEventHander(true),
 258   mIndicator(NULL),
 259   mIndicatorOrientation(Dali::Window::PORTRAIT),
 260   mNextIndicatorOrientation(Dali::Window::PORTRAIT),
 261   mIndicatorOpacityMode(Dali::Window::OPAQUE),
 262   mOverlay(NULL),
 263   mAdaptor(NULL),
 264   mEventHandler(NULL),
 265   mPreferredOrientation(Dali::Window::PORTRAIT)
 266 {
 267 }
 268
 269 Window::~Window()
 270 {
 271   delete mEventHandler;
 272
 273   if( mIndicator )
 274   {
 275     mIndicator->Close();
 276     delete mIndicator;
 277   }
 278
 279   if ( mAdaptor )
 280   {
 281     mAdaptor->RemoveObserver( *this );
 282     mAdaptor->SetDragAndDropDetector( NULL );
 283     mAdaptor = NULL;
 284   }
 285
 286   delete mSurface;
 287 }
 288
 289 void Window::Initialize(const PositionSize& windowPosition, const std::string& name, const std::string& className)
 290 {
 291   // create an Wayland window by default
 292   Any surface;
 293   ECore::WindowRenderSurface* windowSurface = new ECore::WindowRenderSurface( windowPosition, surface, name, mIsTransparent );
 294   SetClass( name, className );
 295   windowSurface->Map();
 296
 297   mSurface = windowSurface;
 298
 299   std::string appId;
 300   mAdaptor->GetAppId( appId );
 301   Ecore_Wl_Window* wlWindow = windowSurface ->GetWlWindow();
 302   ecore_wl_window_class_name_set(wlWindow, appId.c_str());
 303
 304   mOrientation = Orientation::New(this);
 305
 306   // create event handler for Wayland window
 307   mEventHandler = new EventHandler( this );
 308 }
 309
 310 void Window::DoShowIndicator( Dali::Window::WindowOrientation lastOrientation )
 311 {
 312   if( mIndicator == NULL )
 313   {
 314     if( mIndicatorVisible != Dali::Window::INVISIBLE )
 315     {
 316       mIndicator = new Indicator( mAdaptor, mIndicatorOrientation, this );
 317       mIndicator->SetOpacityMode( mIndicatorOpacityMode );
 318       Dali::Actor actor = mIndicator->GetActor();
 319       SetIndicatorActorRotation();
 320       mOverlay->Add(actor);
 321     }
 322     // else don't create a hidden indicator
 323   }
 324   else // Already have indicator
 325   {
 326     if( mIndicatorVisible == Dali::Window::VISIBLE )
 327     {
 328       // If we are resuming, and rotation has changed,
 329       if( mIndicatorIsShown == false && mIndicatorOrientation != mNextIndicatorOrientation )
 330       {
 331         // then close current indicator and open new one
 332         mShowRotatedIndicatorOnClose = true;
 333         mIndicator->Close(); // May synchronously call IndicatorClosed() callback & 1 level of recursion
 334         // Don't show actor - will contain indicator for old orientation.
 335       }
 336     }
 337   }
 338
 339   // set indicator visible mode
 340   if( mIndicator != NULL )
 341   {
 342     mIndicator->SetVisible( mIndicatorVisible );
 343   }
 344
 345   bool show = (mIndicatorVisible != Dali::Window::INVISIBLE );
 346   SetIndicatorProperties( show, lastOrientation );
 347   mIndicatorIsShown = show;
 348 }
 349
 350 void Window::DoRotateIndicator( Dali::Window::WindowOrientation orientation )
 351 {
 352   if( mIndicatorIsShown )
 353   {
 354     mShowRotatedIndicatorOnClose = true;
 355     mNextIndicatorOrientation = orientation;
 356     mIndicator->Close(); // May synchronously call IndicatorClosed() callback
 357   }
 358   else
 359   {
 360     // Save orientation for when the indicator is next shown
 361     mShowRotatedIndicatorOnClose = false;
 362     mNextIndicatorOrientation = orientation;
 363   }
 364 }
 365
 366 void Window::SetIndicatorProperties( bool isShow, Dali::Window::WindowOrientation lastOrientation )
 367 {
 368   ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
 369
 370   if( wlSurface )
 371   {
 372     Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
 373     if ( isShow )
 374     {
 375       ecore_wl_window_indicator_state_set(wlWindow, ECORE_WL_INDICATOR_STATE_ON);
 376     }
 377     else
 378     {
 379       ecore_wl_window_indicator_state_set(wlWindow, ECORE_WL_INDICATOR_STATE_OFF);
 380     }
 381   }
 382 }
 383
 384 void Window::IndicatorTypeChanged(Indicator::Type type)
 385 {
 386 #if defined(DALI_PROFILE_MOBILE)
 387   ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
 388
 389   if( wlSurface )
 390   {
 391     Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
 392     switch(type)
 393     {
 394       case Indicator::INDICATOR_TYPE_1:
 395         ecore_wl_indicator_visible_type_set(wlWindow, ECORE_WL_INDICATOR_VISIBLE_TYPE_SHOWN);
 396         break;
 397
 398       case Indicator::INDICATOR_TYPE_2:
 399         ecore_wl_indicator_visible_type_set(wlWindow, ECORE_WL_INDICATOR_VISIBLE_TYPE_HIDDEN);
 400         break;
 401
 402       case Indicator::INDICATOR_TYPE_UNKNOWN:
 403       default:
 404         break;
 405     }
 406   }
 407 #endif //MOBILE
 408 }
 409
 410 void Window::IndicatorClosed( IndicatorInterface* indicator )
 411 {
 412   DALI_LOG_TRACE_METHOD( gWindowLogFilter );
 413
 414   if( mShowRotatedIndicatorOnClose )
 415   {
 416     Dali::Window::WindowOrientation currentOrientation = mIndicatorOrientation;
 417     mIndicator->Open(mNextIndicatorOrientation);
 418     mIndicatorOrientation = mNextIndicatorOrientation;
 419     SetIndicatorActorRotation();
 420     DoShowIndicator(currentOrientation);
 421   }
 422 }
 423
 424 void Window::IndicatorVisibilityChanged(bool isVisible)
 425 {
 426   mIndicatorVisibilityChangedSignal.Emit(isVisible);
 427 }
 428
 429 void Window::SetIndicatorActorRotation()
 430 {
 431   DALI_LOG_TRACE_METHOD( gWindowLogFilter );
 432   DALI_ASSERT_DEBUG( mIndicator != NULL );
 433
 434   Dali::Actor actor = mIndicator->GetActor();
 435   switch( mIndicatorOrientation )
 436   {
 437     case Dali::Window::PORTRAIT:
 438       actor.SetParentOrigin( ParentOrigin::TOP_CENTER );
 439       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
 440       actor.SetOrientation( Degree(0), Vector3::ZAXIS );
 441       break;
 442     case Dali::Window::PORTRAIT_INVERSE:
 443       actor.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
 444       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
 445       actor.SetOrientation( Degree(180), Vector3::ZAXIS );
 446       break;
 447     case Dali::Window::LANDSCAPE:
 448       actor.SetParentOrigin( ParentOrigin::CENTER_LEFT );
 449       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
 450       actor.SetOrientation( Degree(270), Vector3::ZAXIS );
 451       break;
 452     case Dali::Window::LANDSCAPE_INVERSE:
 453       actor.SetParentOrigin( ParentOrigin::CENTER_RIGHT );
 454       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
 455       actor.SetOrientation( Degree(90), Vector3::ZAXIS );
 456       break;
 457   }
 458 }
 459
 460 void Window::Raise()
 461 {
 462 }
 463
 464 void Window::Lower()
 465 {
 466 }
 467
 468 void Window::Activate()
 469 {
 470 }
 471
 472 Dali::DragAndDropDetector Window::GetDragAndDropDetector() const
 473 {
 474   return mDragAndDropDetector;
 475 }
 476
 477 Dali::Any Window::GetNativeHandle() const
 478 {
 479   if(mEventHandler)
 480   {
 481     return mEventHandler->mEcoreWindow;
 482   }
 483   else
 484   {
 485     return Dali::Any();
 486   }
 487 }
 488
 489 void Window::OnStart()
 490 {
 491   DoShowIndicator( mIndicatorOrientation );
 492 }
 493
 494 void Window::OnPause()
 495 {
 496 }
 497
 498 void Window::OnResume()
 499 {
 500   // resume indicator status
 501   if( mIndicator != NULL )
 502   {
 503     // Restore own indicator opacity
 504     // Send opacity mode to indicator service when app resumed
 505     mIndicator->SetOpacityMode( mIndicatorOpacityMode );
 506   }
 507 }
 508
 509 void Window::OnStop()
 510 {
 511   if( mIndicator )
 512   {
 513     mIndicator->Close();
 514   }
 515
 516   delete mIndicator;
 517   mIndicator = NULL;
 518 }
 519
 520 void Window::OnDestroy()
 521 {
 522   mAdaptor = NULL;
 523 }
 524
 525 void Window::AddAvailableOrientation(Dali::Window::WindowOrientation orientation)
 526 {
 527   bool found = false;
 528
 529   for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
 530   {
 531     if(mAvailableOrientations[i] == orientation)
 532     {
 533       found = true;
 534       break;
 535     }
 536   }
 537
 538   if( ! found )
 539   {
 540     mAvailableOrientations.push_back(orientation);
 541     SetAvailableOrientations( mAvailableOrientations );
 542   }
 543 }
 544
 545 void Window::RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation)
 546 {
 547   for( std::vector<Dali::Window::WindowOrientation>::iterator iter = mAvailableOrientations.begin();
 548        iter != mAvailableOrientations.end(); ++iter )
 549   {
 550     if( *iter == orientation )
 551     {
 552       mAvailableOrientations.erase( iter );
 553       break;
 554     }
 555   }
 556   SetAvailableOrientations( mAvailableOrientations );
 557 }
 558
 559 void Window::SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations)
 560 {
 561   DALI_ASSERT_ALWAYS( mAvailableOrientations.size() <= 4 && "Incorrect number of available orientations" );
 562 }
 563
 564 const std::vector<Dali::Window::WindowOrientation>& Window::GetAvailableOrientations()
 565 {
 566   return mAvailableOrientations;
 567 }
 568
 569 void Window::SetPreferredOrientation(Dali::Window::WindowOrientation orientation)
 570 {
 571   mPreferredOrientation = orientation;
 572 }
 573
 574 Dali::Window::WindowOrientation Window::GetPreferredOrientation()
 575 {
 576   return mPreferredOrientation;
 577 }
 578
 579 void Window::RotationDone( int orientation, int width, int height )
 580 {
 581 }
 582
 583
 584 } // Adaptor
 585 } // Internal
 586 } // Dali