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   mIndicator(NULL),
 258   mIndicatorOrientation(Dali::Window::PORTRAIT),
 259   mNextIndicatorOrientation(Dali::Window::PORTRAIT),
 260   mIndicatorOpacityMode(Dali::Window::OPAQUE),
 261   mOverlay(NULL),
 262   mAdaptor(NULL),
 263   mEventHandler(NULL),
 264   mPreferredOrientation(Dali::Window::PORTRAIT)
 265 {
 266 }
 267
 268 Window::~Window()
 269 {
 270   delete mEventHandler;
 271
 272   if( mIndicator )
 273   {
 274     mIndicator->Close();
 275     delete mIndicator;
 276   }
 277
 278   if ( mAdaptor )
 279   {
 280     mAdaptor->RemoveObserver( *this );
 281     mAdaptor->SetDragAndDropDetector( NULL );
 282     mAdaptor = NULL;
 283   }
 284
 285   delete mSurface;
 286 }
 287
 288 void Window::Initialize(const PositionSize& windowPosition, const std::string& name, const std::string& className)
 289 {
 290   // create an Wayland window by default
 291   Any surface;
 292   ECore::WindowRenderSurface* windowSurface = new ECore::WindowRenderSurface( windowPosition, surface, name, mIsTransparent );
 293   SetClass( name, className );
 294   windowSurface->Map();
 295
 296   mSurface = windowSurface;
 297
 298   std::string appId;
 299   mAdaptor->GetAppId( appId );
 300   Ecore_Wl_Window* wlWindow = windowSurface ->GetWlWindow();
 301   ecore_wl_window_class_name_set(wlWindow, appId.c_str());
 302
 303   mOrientation = Orientation::New(this);
 304
 305   // create event handler for Wayland window
 306   mEventHandler = new EventHandler( this );
 307 }
 308
 309 void Window::DoShowIndicator( Dali::Window::WindowOrientation lastOrientation )
 310 {
 311   if( mIndicator == NULL )
 312   {
 313     if( mIndicatorVisible != Dali::Window::INVISIBLE )
 314     {
 315       mIndicator = new Indicator( mAdaptor, mIndicatorOrientation, this );
 316       mIndicator->SetOpacityMode( mIndicatorOpacityMode );
 317       Dali::Actor actor = mIndicator->GetActor();
 318       SetIndicatorActorRotation();
 319       mOverlay->Add(actor);
 320     }
 321     // else don't create a hidden indicator
 322   }
 323   else // Already have indicator
 324   {
 325     if( mIndicatorVisible == Dali::Window::VISIBLE )
 326     {
 327       // If we are resuming, and rotation has changed,
 328       if( mIndicatorIsShown == false && mIndicatorOrientation != mNextIndicatorOrientation )
 329       {
 330         // then close current indicator and open new one
 331         mShowRotatedIndicatorOnClose = true;
 332         mIndicator->Close(); // May synchronously call IndicatorClosed() callback & 1 level of recursion
 333         // Don't show actor - will contain indicator for old orientation.
 334       }
 335     }
 336   }
 337
 338   // set indicator visible mode
 339   if( mIndicator != NULL )
 340   {
 341     mIndicator->SetVisible( mIndicatorVisible );
 342   }
 343
 344   bool show = (mIndicatorVisible != Dali::Window::INVISIBLE );
 345   SetIndicatorProperties( show, lastOrientation );
 346   mIndicatorIsShown = show;
 347 }
 348
 349 void Window::DoRotateIndicator( Dali::Window::WindowOrientation orientation )
 350 {
 351   if( mIndicatorIsShown )
 352   {
 353     mShowRotatedIndicatorOnClose = true;
 354     mNextIndicatorOrientation = orientation;
 355     mIndicator->Close(); // May synchronously call IndicatorClosed() callback
 356   }
 357   else
 358   {
 359     // Save orientation for when the indicator is next shown
 360     mShowRotatedIndicatorOnClose = false;
 361     mNextIndicatorOrientation = orientation;
 362   }
 363 }
 364
 365 void Window::SetIndicatorProperties( bool isShow, Dali::Window::WindowOrientation lastOrientation )
 366 {
 367   ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
 368
 369   if( wlSurface )
 370   {
 371     Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
 372     if ( isShow )
 373     {
 374       ecore_wl_window_indicator_state_set(wlWindow, ECORE_WL_INDICATOR_STATE_ON);
 375     }
 376     else
 377     {
 378       ecore_wl_window_indicator_state_set(wlWindow, ECORE_WL_INDICATOR_STATE_OFF);
 379     }
 380   }
 381 }
 382
 383 void Window::IndicatorTypeChanged(Indicator::Type type)
 384 {
 385 #if defined(DALI_PROFILE_MOBILE)
 386   ECore::WindowRenderSurface* wlSurface( dynamic_cast< ECore::WindowRenderSurface * >( mSurface ) );
 387
 388   if( wlSurface )
 389   {
 390     Ecore_Wl_Window* wlWindow = wlSurface->GetWlWindow();
 391     switch(type)
 392     {
 393       case Indicator::INDICATOR_TYPE_1:
 394         ecore_wl_indicator_visible_type_set(wlWindow, ECORE_WL_INDICATOR_VISIBLE_TYPE_SHOWN);
 395         break;
 396
 397       case Indicator::INDICATOR_TYPE_2:
 398         ecore_wl_indicator_visible_type_set(wlWindow, ECORE_WL_INDICATOR_VISIBLE_TYPE_HIDDEN);
 399         break;
 400
 401       case Indicator::INDICATOR_TYPE_UNKNOWN:
 402       default:
 403         break;
 404     }
 405   }
 406 #endif //MOBILE
 407 }
 408
 409 void Window::IndicatorClosed( IndicatorInterface* indicator )
 410 {
 411   DALI_LOG_TRACE_METHOD( gWindowLogFilter );
 412
 413   if( mShowRotatedIndicatorOnClose )
 414   {
 415     Dali::Window::WindowOrientation currentOrientation = mIndicatorOrientation;
 416     mIndicator->Open(mNextIndicatorOrientation);
 417     mIndicatorOrientation = mNextIndicatorOrientation;
 418     SetIndicatorActorRotation();
 419     DoShowIndicator(currentOrientation);
 420   }
 421 }
 422
 423 void Window::IndicatorVisibilityChanged(bool isVisible)
 424 {
 425   mIndicatorVisibilityChangedSignal.Emit(isVisible);
 426 }
 427
 428 void Window::SetIndicatorActorRotation()
 429 {
 430   DALI_LOG_TRACE_METHOD( gWindowLogFilter );
 431   DALI_ASSERT_DEBUG( mIndicator != NULL );
 432
 433   Dali::Actor actor = mIndicator->GetActor();
 434   switch( mIndicatorOrientation )
 435   {
 436     case Dali::Window::PORTRAIT:
 437       actor.SetParentOrigin( ParentOrigin::TOP_CENTER );
 438       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
 439       actor.SetOrientation( Degree(0), Vector3::ZAXIS );
 440       break;
 441     case Dali::Window::PORTRAIT_INVERSE:
 442       actor.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
 443       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
 444       actor.SetOrientation( Degree(180), Vector3::ZAXIS );
 445       break;
 446     case Dali::Window::LANDSCAPE:
 447       actor.SetParentOrigin( ParentOrigin::CENTER_LEFT );
 448       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
 449       actor.SetOrientation( Degree(270), Vector3::ZAXIS );
 450       break;
 451     case Dali::Window::LANDSCAPE_INVERSE:
 452       actor.SetParentOrigin( ParentOrigin::CENTER_RIGHT );
 453       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
 454       actor.SetOrientation( Degree(90), Vector3::ZAXIS );
 455       break;
 456   }
 457 }
 458
 459 void Window::Raise()
 460 {
 461 }
 462
 463 void Window::Lower()
 464 {
 465 }
 466
 467 void Window::Activate()
 468 {
 469 }
 470
 471 Dali::DragAndDropDetector Window::GetDragAndDropDetector() const
 472 {
 473   return mDragAndDropDetector;
 474 }
 475
 476 Dali::Any Window::GetNativeHandle() const
 477 {
 478   if(mEventHandler)
 479   {
 480     return mEventHandler->mEcoreWindow;
 481   }
 482   else
 483   {
 484     return Dali::Any();
 485   }
 486 }
 487
 488 void Window::OnStart()
 489 {
 490   DoShowIndicator( mIndicatorOrientation );
 491 }
 492
 493 void Window::OnPause()
 494 {
 495 }
 496
 497 void Window::OnResume()
 498 {
 499   // resume indicator status
 500   if( mIndicator != NULL )
 501   {
 502     // Restore own indicator opacity
 503     // Send opacity mode to indicator service when app resumed
 504     mIndicator->SetOpacityMode( mIndicatorOpacityMode );
 505   }
 506 }
 507
 508 void Window::OnStop()
 509 {
 510   if( mIndicator )
 511   {
 512     mIndicator->Close();
 513   }
 514
 515   delete mIndicator;
 516   mIndicator = NULL;
 517 }
 518
 519 void Window::OnDestroy()
 520 {
 521   mAdaptor = NULL;
 522 }
 523
 524 void Window::AddAvailableOrientation(Dali::Window::WindowOrientation orientation)
 525 {
 526   bool found = false;
 527
 528   for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
 529   {
 530     if(mAvailableOrientations[i] == orientation)
 531     {
 532       found = true;
 533       break;
 534     }
 535   }
 536
 537   if( ! found )
 538   {
 539     mAvailableOrientations.push_back(orientation);
 540     SetAvailableOrientations( mAvailableOrientations );
 541   }
 542 }
 543
 544 void Window::RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation)
 545 {
 546   for( std::vector<Dali::Window::WindowOrientation>::iterator iter = mAvailableOrientations.begin();
 547        iter != mAvailableOrientations.end(); ++iter )
 548   {
 549     if( *iter == orientation )
 550     {
 551       mAvailableOrientations.erase( iter );
 552       break;
 553     }
 554   }
 555   SetAvailableOrientations( mAvailableOrientations );
 556 }
 557
 558 void Window::SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations)
 559 {
 560   DALI_ASSERT_ALWAYS( mAvailableOrientations.size() <= 4 && "Incorrect number of available orientations" );
 561 }
 562
 563 const std::vector<Dali::Window::WindowOrientation>& Window::GetAvailableOrientations()
 564 {
 565   return mAvailableOrientations;
 566 }
 567
 568 void Window::SetPreferredOrientation(Dali::Window::WindowOrientation orientation)
 569 {
 570   mPreferredOrientation = orientation;
 571 }
 572
 573 Dali::Window::WindowOrientation Window::GetPreferredOrientation()
 574 {
 575   return mPreferredOrientation;
 576 }
 577
 578 void Window::RotationDone( int orientation, int width, int height )
 579 {
 580 }
 581
 582
 583 } // Adaptor
 584 } // Internal
 585 } // Dali