2 * Copyright (c) 2014 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 "window-impl.h"
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>
32 #include <window-render-surface.h>
33 #include <drag-and-drop-detector-impl.h>
34 #include <indicator-impl.h>
35 #include <window-visibility-observer.h>
36 #include <orientation-impl.h>
40 const float INDICATOR_ANIMATION_DURATION( 0.18f ); // 180 milli seconds
41 const float INDICATOR_SHOW_Y_POSITION( 0.0f );
42 const float INDICATOR_HIDE_Y_POSITION( -52.0f );
51 #if defined(DEBUG_ENABLED)
52 Debug::Filter* gWindowLogFilter = Debug::Filter::New(Debug::Concise, false, "LOG_WINDOW");
56 * TODO: Abstract Window class out and move this into a window implementation for Ecore
58 struct Window::EventHandler
62 * @param[in] window A pointer to the window class.
64 EventHandler( Window* window )
66 mWindowPropertyHandler( ecore_event_handler_add( ECORE_X_EVENT_WINDOW_PROPERTY, EcoreEventWindowPropertyChanged, this ) ),
67 mClientMessagehandler( ecore_event_handler_add( ECORE_X_EVENT_CLIENT_MESSAGE, EcoreEventClientMessage, this ) ),
70 // store ecore window handle
71 ECore::WindowRenderSurface* x11Window( dynamic_cast< ECore::WindowRenderSurface * >( mWindow->mSurface ) );
74 mEcoreWindow = x11Window->GetXWindow();
76 DALI_ASSERT_ALWAYS( mEcoreWindow != 0 && "There is no ecore x window");
78 #ifndef DALI_PROFILE_UBUNTU
79 // set property on window to get deiconify approve client message
81 ecore_x_window_prop_card32_set(mEcoreWindow,
82 ECORE_X_ATOM_E_DEICONIFY_APPROVE,
84 #endif // DALI_PROFILE_UBUNTU
92 if ( mWindowPropertyHandler )
94 ecore_event_handler_del( mWindowPropertyHandler );
96 if ( mClientMessagehandler )
98 ecore_event_handler_del( mClientMessagehandler );
104 /// Called when the window properties are changed.
105 static Eina_Bool EcoreEventWindowPropertyChanged( void* data, int type, void* event )
107 Ecore_X_Event_Window_Property* propertyChangedEvent( (Ecore_X_Event_Window_Property*)event );
108 EventHandler* handler( (EventHandler*)data );
109 Eina_Bool handled( ECORE_CALLBACK_PASS_ON );
111 if ( handler && handler->mWindow )
113 WindowVisibilityObserver* observer( handler->mWindow->mAdaptor );
114 if ( observer && ( propertyChangedEvent->win == handler->mEcoreWindow ) )
116 Ecore_X_Window_State_Hint state( ecore_x_icccm_state_get( propertyChangedEvent->win ) );
120 case ECORE_X_WINDOW_STATE_HINT_WITHDRAWN:
122 // Window was hidden.
123 observer->OnWindowHidden();
124 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Withdrawn\n", handler->mEcoreWindow );
125 handled = ECORE_CALLBACK_DONE;
129 case ECORE_X_WINDOW_STATE_HINT_ICONIC:
131 // Window was iconified (minimised).
132 observer->OnWindowHidden();
133 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Iconfied\n", handler->mEcoreWindow );
134 handled = ECORE_CALLBACK_DONE;
138 case ECORE_X_WINDOW_STATE_HINT_NORMAL:
141 observer->OnWindowShown();
142 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Shown\n", handler->mEcoreWindow );
143 handled = ECORE_CALLBACK_DONE;
157 /// Called when the window properties are changed.
158 static Eina_Bool EcoreEventClientMessage( void* data, int type, void* event )
160 Eina_Bool handled( ECORE_CALLBACK_PASS_ON );
161 #ifndef DALI_PROFILE_UBUNTU
162 Ecore_X_Event_Client_Message* clientMessageEvent( (Ecore_X_Event_Client_Message*)event );
163 EventHandler* handler( (EventHandler*)data );
165 if (clientMessageEvent->message_type == ECORE_X_ATOM_E_DEICONIFY_APPROVE)
167 ECore::WindowRenderSurface* x11Window( dynamic_cast< ECore::WindowRenderSurface * >( handler->mWindow->mSurface ) );
168 WindowVisibilityObserver* observer( handler->mWindow->mAdaptor );
170 if ( observer && ( (unsigned int)clientMessageEvent->data.l[0] == handler->mEcoreWindow ) )
172 if (clientMessageEvent->data.l[1] == 0) //wm sends request message using value 0
174 observer->OnWindowShown();
176 // request to approve the deiconify. render-surface should send proper event after real rendering
179 x11Window->RequestToApproveDeiconify();
182 handled = ECORE_CALLBACK_DONE;
186 #endif // DALI_PROFILE_UBUNTU
193 Ecore_Event_Handler* mWindowPropertyHandler;
194 Ecore_Event_Handler* mClientMessagehandler;
195 Ecore_X_Window mEcoreWindow;
199 Window* Window::New(const PositionSize& posSize, const std::string& name, bool isTransparent)
201 Window* window = new Window();
202 window->mIsTransparent = isTransparent;
203 window->Initialize(posSize, name);
207 void Window::SetAdaptor(Dali::Adaptor& adaptor)
209 DALI_ASSERT_ALWAYS( !mStarted && "Adaptor already started" );
212 // Only create one overlay per window
213 Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation(adaptor);
214 Integration::Core& core = adaptorImpl.GetCore();
215 mOverlay = &core.GetSystemOverlay();
217 Dali::RenderTaskList taskList = mOverlay->GetOverlayRenderTasks();
218 taskList.CreateTask();
220 mAdaptor = &adaptorImpl;
221 mAdaptor->AddObserver( *this );
223 // Can only create the detector when we know the Core has been instantiated.
224 mDragAndDropDetector = DragAndDropDetector::New();
225 mAdaptor->SetDragAndDropDetector( &GetImplementation( mDragAndDropDetector ) );
229 mOrientation->SetAdaptor(adaptor);
232 if( mIndicator != NULL )
234 mIndicator->SetAdaptor(mAdaptor);
238 RenderSurface* Window::GetSurface()
243 void Window::SetIndicatorStyle( Dali::Window::IndicatorStyle style )
245 mIndicatorStyle = style;
248 void Window::ShowIndicator( bool show )
250 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "%s\n", show?"SHOW":"HIDE" );
251 DALI_ASSERT_DEBUG(mOverlay);
255 mIndicatorVisible = Dali::Window::VISIBLE;
259 mIndicatorVisible = Dali::Window::INVISIBLE;
262 DoShowIndicator( mIndicatorOrientation );
265 void Window::ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode )
267 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "visible : %d\n", visibleMode );
268 DALI_ASSERT_DEBUG(mOverlay);
270 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
271 DALI_ASSERT_DEBUG(x11Window);
272 Ecore_X_Window xWinId = x11Window->GetXWindow();
274 mIndicatorVisible = visibleMode;
276 if ( mIndicatorVisible == Dali::Window::VISIBLE )
278 // when the indicator is visible, set proper mode for indicator server according to bg mode
279 if ( mIndicatorOpacityMode == Dali::Window::OPAQUE )
281 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_OPAQUE);
283 else if ( mIndicatorOpacityMode == Dali::Window::TRANSLUCENT )
285 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_TRANSLUCENT);
287 #if defined(DALI_PROFILE_MOBILE)
288 else if ( mIndicatorOpacityMode == Dali::Window::TRANSPARENT )
290 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_BG_TRANSPARENT);
296 // when the indicator is not visible, set TRANSPARENT mode for indicator server
297 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_TRANSPARENT); // it means hidden indicator
300 DoShowIndicator( mIndicatorOrientation );
303 void Window::RotateIndicator(Dali::Window::WindowOrientation orientation)
305 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "Orientation: %d\n", orientation );
307 DoRotateIndicator( orientation );
310 void Window::SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacityMode )
312 mIndicatorOpacityMode = opacityMode;
314 if( mIndicator != NULL )
316 mIndicator->SetOpacityMode( opacityMode );
320 void Window::SetClass(std::string name, std::string klass)
322 // Get render surface's x11 window
325 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
328 ecore_x_icccm_name_class_set( x11Window->GetXWindow(), name.c_str(), klass.c_str() );
335 mIndicatorStyle(Dali::Window::CHANGEABLE_COLOR),
336 mIndicatorVisible(Dali::Window::VISIBLE),
337 mIndicatorIsShown(false),
338 mShowRotatedIndicatorOnClose(false),
340 mIsTransparent(false),
341 mWMRotationAppSet(false),
343 mIndicatorOrientation(Dali::Window::PORTRAIT),
344 mNextIndicatorOrientation(Dali::Window::PORTRAIT),
345 mIndicatorOpacityMode(Dali::Window::OPAQUE),
353 delete mEventHandler;
357 mAdaptor->RemoveObserver( *this );
358 mAdaptor->SetDragAndDropDetector( NULL );
365 void Window::Initialize(const PositionSize& windowPosition, const std::string& name)
367 // create an X11 window by default
370 mSurface = new ECore::WindowRenderSurface( windowPosition, surface, display, name, mIsTransparent );
371 mOrientation = Orientation::New(this);
373 // create event handler for X11 window
374 mEventHandler = new EventHandler( this );
377 void Window::DoShowIndicator( Dali::Window::WindowOrientation lastOrientation )
379 if( mIndicator == NULL )
381 if( mIndicatorVisible != Dali::Window::INVISIBLE )
383 mIndicator = new Indicator( mAdaptor, mIndicatorOrientation, mIndicatorStyle, this );
384 mIndicator->SetOpacityMode( mIndicatorOpacityMode );
385 Dali::Actor actor = mIndicator->GetActor();
386 SetIndicatorActorRotation();
387 mOverlay->Add(actor);
389 // else don't create a hidden indicator
391 else // Already have indicator
393 if( mIndicatorVisible == Dali::Window::VISIBLE )
395 // If we are resuming, and rotation has changed,
396 if( mIndicatorIsShown == false && mIndicatorOrientation != mNextIndicatorOrientation )
398 // then close current indicator and open new one
399 mShowRotatedIndicatorOnClose = true;
400 mIndicator->Close(); // May synchronously call IndicatorClosed() callback & 1 level of recursion
401 // Don't show actor - will contain indicator for old orientation.
406 // set indicator visible mode
407 if( mIndicator != NULL )
409 mIndicator->SetVisible( mIndicatorVisible );
412 bool show = (mIndicatorVisible != Dali::Window::INVISIBLE );
413 SetIndicatorProperties( show, lastOrientation );
414 mIndicatorIsShown = show;
417 void Window::DoRotateIndicator( Dali::Window::WindowOrientation orientation )
419 if( mIndicatorIsShown )
421 mShowRotatedIndicatorOnClose = true;
422 mNextIndicatorOrientation = orientation;
423 mIndicator->Close(); // May synchronously call IndicatorClosed() callback
427 // Save orientation for when the indicator is next shown
428 mShowRotatedIndicatorOnClose = false;
429 mNextIndicatorOrientation = orientation;
433 void Window::SetIndicatorProperties( bool isShow, Dali::Window::WindowOrientation lastOrientation )
435 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
438 Ecore_X_Window win = x11Window->GetXWindow();
440 int show_state = static_cast<int>( isShow );
441 ecore_x_window_prop_property_set( win,
442 ECORE_X_ATOM_E_ILLUME_INDICATOR_STATE,
443 ECORE_X_ATOM_CARDINAL, 32, &show_state, 1);
447 ecore_x_e_illume_indicator_state_set(win, ECORE_X_ILLUME_INDICATOR_STATE_ON);
451 ecore_x_e_illume_indicator_state_set(win, ECORE_X_ILLUME_INDICATOR_STATE_OFF);
456 void Window::IndicatorTypeChanged(Indicator::Type type)
458 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
461 #ifndef DALI_PROFILE_UBUNTU
462 Ecore_X_Window win = x11Window->GetXWindow();
465 case Indicator::INDICATOR_TYPE_1:
466 ecore_x_e_illume_indicator_type_set( win, ECORE_X_ILLUME_INDICATOR_TYPE_1 );
469 case Indicator::INDICATOR_TYPE_2:
470 ecore_x_e_illume_indicator_type_set( win, ECORE_X_ILLUME_INDICATOR_TYPE_2 );
473 case Indicator::INDICATOR_TYPE_UNKNOWN:
477 #endif // DALI_PROFILE_UBUNTU
481 void Window::IndicatorClosed( Indicator* indicator )
483 DALI_LOG_TRACE_METHOD( gWindowLogFilter );
485 if( mShowRotatedIndicatorOnClose )
487 Dali::Window::WindowOrientation currentOrientation = mIndicatorOrientation;
488 mIndicator->Open(mNextIndicatorOrientation);
489 mIndicatorOrientation = mNextIndicatorOrientation;
490 SetIndicatorActorRotation();
491 DoShowIndicator(currentOrientation);
495 void Window::SetIndicatorActorRotation()
497 DALI_LOG_TRACE_METHOD( gWindowLogFilter );
498 DALI_ASSERT_DEBUG( mIndicator != NULL );
500 Dali::Actor actor = mIndicator->GetActor();
501 switch( mIndicatorOrientation )
503 case Dali::Window::PORTRAIT:
504 actor.SetParentOrigin( ParentOrigin::TOP_CENTER );
505 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
506 actor.SetRotation( Degree(0), Vector3::ZAXIS );
508 case Dali::Window::PORTRAIT_INVERSE:
509 actor.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
510 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
511 actor.SetRotation( Degree(180), Vector3::ZAXIS );
513 case Dali::Window::LANDSCAPE:
514 actor.SetParentOrigin( ParentOrigin::CENTER_LEFT );
515 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
516 actor.SetRotation( Degree(270), Vector3::ZAXIS );
518 case Dali::Window::LANDSCAPE_INVERSE:
519 actor.SetParentOrigin( ParentOrigin::CENTER_RIGHT );
520 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
521 actor.SetRotation( Degree(90), Vector3::ZAXIS );
528 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
531 Ecore_X_Window win = x11Window->GetXWindow();
532 ecore_x_window_raise(win);
538 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
541 Ecore_X_Window win = x11Window->GetXWindow();
542 ecore_x_window_lower(win);
546 void Window::Activate()
548 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
551 Ecore_X_Window win = x11Window->GetXWindow();
552 ecore_x_netwm_client_active_request(ecore_x_window_root_get(win), win, 1 /* request type, 1:application, 2:pager */, 0);
556 Dali::DragAndDropDetector Window::GetDragAndDropDetector() const
558 return mDragAndDropDetector;
561 void Window::OnStart()
563 DoShowIndicator( mIndicatorOrientation );
566 void Window::OnPause()
570 void Window::OnResume()
572 // resume indicator status
573 if( mIndicator != NULL )
575 // Restore own indicator opacity
576 // Send opacity mode to indicator service when app resumed
577 mIndicator->SetOpacityMode( mIndicatorOpacityMode );
581 void Window::OnStop()
592 void Window::OnDestroy()
597 OrientationPtr Window::GetOrientation()
602 void Window::AddAvailableOrientation(Dali::Window::WindowOrientation orientation)
606 for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
608 if(mAvailableOrientations[i] == orientation)
617 mAvailableOrientations.push_back(orientation);
618 SetAvailableOrientations( mAvailableOrientations );
622 void Window::RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation)
624 for( std::vector<Dali::Window::WindowOrientation>::iterator iter = mAvailableOrientations.begin();
625 iter != mAvailableOrientations.end(); ++iter )
627 if( *iter == orientation )
629 mAvailableOrientations.erase( iter );
633 SetAvailableOrientations( mAvailableOrientations );
636 void Window::SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations)
638 DALI_ASSERT_ALWAYS( mAvailableOrientations.size() <= 4 && "Incorrect number of available orientations" );
640 mAvailableOrientations = orientations;
641 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
644 #ifndef DALI_PROFILE_UBUNTU
645 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
646 if( ! mWMRotationAppSet )
648 mWMRotationAppSet = true;
649 ecore_x_e_window_rotation_app_set(ecoreWindow, EINA_TRUE);
653 for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
655 rotations[i] = static_cast<int>(mAvailableOrientations[i]);
657 ecore_x_e_window_rotation_available_rotations_set(ecoreWindow, rotations, mAvailableOrientations.size() );
658 #endif // DALI_PROFILE_UBUNTU
662 const std::vector<Dali::Window::WindowOrientation>& Window::GetAvailableOrientations()
664 return mAvailableOrientations;
667 void Window::SetPreferredOrientation(Dali::Window::WindowOrientation orientation)
669 mPreferredOrientation = orientation;
671 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
674 #ifndef DALI_PROFILE_UBUNTU
675 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
677 if( ! mWMRotationAppSet )
679 mWMRotationAppSet = true;
680 ecore_x_e_window_rotation_app_set(ecoreWindow, EINA_TRUE);
683 ecore_x_e_window_rotation_preferred_rotation_set(ecoreWindow, orientation);
684 #endif // DALI_PROFILE_UBUNTU
688 Dali::Window::WindowOrientation Window::GetPreferredOrientation()
690 return mPreferredOrientation;
693 void Window::RotationDone( int orientation, int width, int height )
695 // Tell window manager we're done
696 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
699 #ifndef DALI_PROFILE_UBUNTU
700 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
701 Ecore_X_Window root = ecore_x_window_root_get(ecoreWindow);
704 * send rotation done message to wm, even if window is already rotated.
705 * that's why wm must be wait for comming rotation done message
706 * after sending rotation request.
708 ecore_x_e_window_rotation_change_done_send(root, ecoreWindow, orientation, width, height);
711 * set rotate window property
713 int angles[2] = { orientation, orientation };
714 ecore_x_window_prop_property_set( ecoreWindow,
715 ECORE_X_ATOM_E_ILLUME_ROTATE_WINDOW_ANGLE,
716 ECORE_X_ATOM_CARDINAL, 32, &angles, 2 );
717 #endif // DALI_PROFILE_UBUNTU