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>
31 #include <window-render-surface.h>
32 #include <drag-and-drop-detector-impl.h>
33 #include <indicator-impl.h>
34 #include <window-visibility-observer.h>
35 #include <orientation.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
86 ecore_x_input_multi_select( mEcoreWindow );
94 if ( mWindowPropertyHandler )
96 ecore_event_handler_del( mWindowPropertyHandler );
98 if ( mClientMessagehandler )
100 ecore_event_handler_del( mClientMessagehandler );
106 /// Called when the window properties are changed.
107 static Eina_Bool EcoreEventWindowPropertyChanged( void* data, int type, void* event )
109 Ecore_X_Event_Window_Property* propertyChangedEvent( (Ecore_X_Event_Window_Property*)event );
110 EventHandler* handler( (EventHandler*)data );
111 Eina_Bool handled( ECORE_CALLBACK_PASS_ON );
113 if ( handler && handler->mWindow )
115 WindowVisibilityObserver* observer( handler->mWindow->mAdaptor );
116 if ( observer && ( propertyChangedEvent->win == handler->mEcoreWindow ) )
118 Ecore_X_Window_State_Hint state( ecore_x_icccm_state_get( propertyChangedEvent->win ) );
122 case ECORE_X_WINDOW_STATE_HINT_WITHDRAWN:
124 // Window was hidden.
125 observer->OnWindowHidden();
126 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Withdrawn\n", handler->mEcoreWindow );
127 handled = ECORE_CALLBACK_DONE;
131 case ECORE_X_WINDOW_STATE_HINT_ICONIC:
133 // Window was iconified (minimised).
134 observer->OnWindowHidden();
135 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Iconfied\n", handler->mEcoreWindow );
136 handled = ECORE_CALLBACK_DONE;
140 case ECORE_X_WINDOW_STATE_HINT_NORMAL:
143 observer->OnWindowShown();
144 DALI_LOG_INFO( gWindowLogFilter, Debug::General, "Window (%d) Shown\n", handler->mEcoreWindow );
145 handled = ECORE_CALLBACK_DONE;
159 /// Called when the window properties are changed.
160 static Eina_Bool EcoreEventClientMessage( void* data, int type, void* event )
162 Eina_Bool handled( ECORE_CALLBACK_PASS_ON );
163 #ifndef DALI_PROFILE_UBUNTU
164 Ecore_X_Event_Client_Message* clientMessageEvent( (Ecore_X_Event_Client_Message*)event );
165 EventHandler* handler( (EventHandler*)data );
167 if (clientMessageEvent->message_type == ECORE_X_ATOM_E_DEICONIFY_APPROVE)
169 ECore::WindowRenderSurface* x11Window( dynamic_cast< ECore::WindowRenderSurface * >( handler->mWindow->mSurface ) );
170 WindowVisibilityObserver* observer( handler->mWindow->mAdaptor );
172 if ( observer && ( (unsigned int)clientMessageEvent->data.l[0] == handler->mEcoreWindow ) )
174 if (clientMessageEvent->data.l[1] == 0) //wm sends request message using value 0
176 observer->OnWindowShown();
178 // request to approve the deiconify. render-surface should send proper event after real rendering
181 x11Window->RequestToApproveDeiconify();
184 handled = ECORE_CALLBACK_DONE;
188 #endif // DALI_PROFILE_UBUNTU
195 Ecore_Event_Handler* mWindowPropertyHandler;
196 Ecore_Event_Handler* mClientMessagehandler;
197 Ecore_X_Window mEcoreWindow;
201 Window* Window::New(const PositionSize& posSize, const std::string& name, bool isTransparent)
203 Window* window = new Window();
204 window->mIsTransparent = isTransparent;
205 window->Initialize(posSize, name);
209 void Window::SetAdaptor(Dali::Adaptor& adaptor)
211 DALI_ASSERT_ALWAYS( !mStarted && "Adaptor already started" );
214 // Only create one overlay per window
215 Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation(adaptor);
216 Integration::Core& core = adaptorImpl.GetCore();
217 mOverlay = &core.GetSystemOverlay();
219 Dali::RenderTaskList taskList = mOverlay->GetOverlayRenderTasks();
220 taskList.CreateTask();
222 mAdaptor = &adaptorImpl;
223 mAdaptor->AddObserver( *this );
225 // Can only create the detector when we know the Core has been instantiated.
226 mDragAndDropDetector = DragAndDropDetector::New();
227 mAdaptor->SetDragAndDropDetector( &GetImplementation( mDragAndDropDetector ) );
231 mOrientation->SetAdaptor(adaptor);
234 if( mIndicator != NULL )
236 mIndicator->SetAdaptor(mAdaptor);
240 RenderSurface* Window::GetSurface()
245 void Window::SetIndicatorStyle( Dali::Window::IndicatorStyle style )
247 mIndicatorStyle = style;
250 void Window::ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode )
252 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "visible : %d\n", visibleMode );
253 DALI_ASSERT_DEBUG(mOverlay);
255 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
256 DALI_ASSERT_DEBUG(x11Window);
257 Ecore_X_Window xWinId = x11Window->GetXWindow();
259 mIndicatorVisible = visibleMode;
261 if ( mIndicatorVisible == Dali::Window::VISIBLE )
263 // when the indicator is visible, set proper mode for indicator server according to bg mode
264 if ( mIndicatorOpacityMode == Dali::Window::OPAQUE )
266 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_OPAQUE);
268 else if ( mIndicatorOpacityMode == Dali::Window::TRANSLUCENT )
270 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_TRANSLUCENT);
272 #if defined(DALI_PROFILE_MOBILE)
273 else if ( mIndicatorOpacityMode == Dali::Window::TRANSPARENT )
275 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_OPAQUE);
281 // when the indicator is not visible, set TRANSPARENT mode for indicator server
282 ecore_x_e_illume_indicator_opacity_set(xWinId, ECORE_X_ILLUME_INDICATOR_TRANSPARENT); // it means hidden indicator
285 DoShowIndicator( mIndicatorOrientation );
288 void Window::RotateIndicator(Dali::Window::WindowOrientation orientation)
290 DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "Orientation: %d\n", orientation );
292 DoRotateIndicator( orientation );
295 void Window::SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacityMode )
297 mIndicatorOpacityMode = opacityMode;
299 if( mIndicator != NULL )
301 mIndicator->SetOpacityMode( opacityMode );
305 void Window::SetClass(std::string name, std::string klass)
307 // Get render surface's x11 window
310 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
313 ecore_x_icccm_name_class_set( x11Window->GetXWindow(), name.c_str(), klass.c_str() );
320 mIndicatorStyle(Dali::Window::CHANGEABLE_COLOR),
321 mIndicatorVisible(Dali::Window::INVISIBLE),
322 mIndicatorIsShown(false),
323 mShowRotatedIndicatorOnClose(false),
325 mIsTransparent(false),
326 mWMRotationAppSet(false),
328 mIndicatorOrientation(Dali::Window::PORTRAIT),
329 mNextIndicatorOrientation(Dali::Window::PORTRAIT),
330 mIndicatorOpacityMode(Dali::Window::OPAQUE),
334 mPreferredOrientation(Dali::Window::PORTRAIT)
340 delete mEventHandler;
344 mOverlay->Remove( mIndicator->GetActor() );
345 Dali::RenderTaskList taskList = mOverlay->GetOverlayRenderTasks();
346 Dali::RenderTask indicatorTask = taskList.GetTask(0);
347 mOverlay->GetOverlayRenderTasks().RemoveTask(indicatorTask);
354 mAdaptor->RemoveObserver( *this );
355 mAdaptor->SetDragAndDropDetector( NULL );
362 void Window::Initialize(const PositionSize& windowPosition, const std::string& name)
364 // create an X11 window by default
366 ECore::WindowRenderSurface* windowSurface = new ECore::WindowRenderSurface( windowPosition, surface, name, mIsTransparent );
367 windowSurface->Map();
369 mSurface = windowSurface;
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::IndicatorVisibilityChanged(bool isVisible)
497 mIndicatorVisibilityChangedSignal.Emit(isVisible);
500 void Window::SetIndicatorActorRotation()
502 DALI_LOG_TRACE_METHOD( gWindowLogFilter );
503 DALI_ASSERT_DEBUG( mIndicator != NULL );
505 Dali::Actor actor = mIndicator->GetActor();
506 switch( mIndicatorOrientation )
508 case Dali::Window::PORTRAIT:
509 actor.SetParentOrigin( ParentOrigin::TOP_CENTER );
510 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
511 actor.SetOrientation( Degree(0), Vector3::ZAXIS );
513 case Dali::Window::PORTRAIT_INVERSE:
514 actor.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
515 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
516 actor.SetOrientation( Degree(180), Vector3::ZAXIS );
518 case Dali::Window::LANDSCAPE:
519 actor.SetParentOrigin( ParentOrigin::CENTER_LEFT );
520 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
521 actor.SetOrientation( Degree(270), Vector3::ZAXIS );
523 case Dali::Window::LANDSCAPE_INVERSE:
524 actor.SetParentOrigin( ParentOrigin::CENTER_RIGHT );
525 actor.SetAnchorPoint( AnchorPoint::TOP_CENTER );
526 actor.SetOrientation( Degree(90), Vector3::ZAXIS );
533 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
536 Ecore_X_Window win = x11Window->GetXWindow();
537 ecore_x_window_raise(win);
543 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
546 Ecore_X_Window win = x11Window->GetXWindow();
547 ecore_x_window_lower(win);
551 void Window::Activate()
553 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
556 Ecore_X_Window win = x11Window->GetXWindow();
557 ecore_x_netwm_client_active_request(ecore_x_window_root_get(win), win, 1 /* request type, 1:application, 2:pager */, 0);
561 Dali::DragAndDropDetector Window::GetDragAndDropDetector() const
563 return mDragAndDropDetector;
566 Dali::Any Window::GetNativeHandle() const
570 return mEventHandler->mEcoreWindow;
578 void Window::OnStart()
580 ShowIndicator( mIndicatorVisible );
583 void Window::OnPause()
587 void Window::OnResume()
589 // resume indicator status
590 if( mIndicator != NULL )
592 // Restore own indicator opacity
593 // Send opacity mode to indicator service when app resumed
594 mIndicator->SetOpacityMode( mIndicatorOpacityMode );
598 void Window::OnStop()
609 void Window::OnDestroy()
614 OrientationPtr Window::GetOrientation()
619 void Window::AddAvailableOrientation(Dali::Window::WindowOrientation orientation)
623 for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
625 if(mAvailableOrientations[i] == orientation)
634 mAvailableOrientations.push_back(orientation);
635 SetAvailableOrientations( mAvailableOrientations );
639 void Window::RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation)
641 for( std::vector<Dali::Window::WindowOrientation>::iterator iter = mAvailableOrientations.begin();
642 iter != mAvailableOrientations.end(); ++iter )
644 if( *iter == orientation )
646 mAvailableOrientations.erase( iter );
650 SetAvailableOrientations( mAvailableOrientations );
653 void Window::SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations)
655 DALI_ASSERT_ALWAYS( mAvailableOrientations.size() <= 4 && "Incorrect number of available orientations" );
657 mAvailableOrientations = orientations;
658 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
661 #ifndef DALI_PROFILE_UBUNTU
662 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
663 if( ! mWMRotationAppSet )
665 mWMRotationAppSet = true;
666 ecore_x_e_window_rotation_app_set(ecoreWindow, EINA_TRUE);
670 for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
672 rotations[i] = static_cast<int>(mAvailableOrientations[i]);
674 ecore_x_e_window_rotation_available_rotations_set(ecoreWindow, rotations, mAvailableOrientations.size() );
675 #endif // DALI_PROFILE_UBUNTU
679 const std::vector<Dali::Window::WindowOrientation>& Window::GetAvailableOrientations()
681 return mAvailableOrientations;
684 void Window::SetPreferredOrientation(Dali::Window::WindowOrientation orientation)
686 mPreferredOrientation = orientation;
688 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
691 #ifndef DALI_PROFILE_UBUNTU
692 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
694 if( ! mWMRotationAppSet )
696 mWMRotationAppSet = true;
697 ecore_x_e_window_rotation_app_set(ecoreWindow, EINA_TRUE);
700 ecore_x_e_window_rotation_preferred_rotation_set(ecoreWindow, orientation);
701 #endif // DALI_PROFILE_UBUNTU
705 Dali::Window::WindowOrientation Window::GetPreferredOrientation()
707 return mPreferredOrientation;
710 void Window::RotationDone( int orientation, int width, int height )
712 // Tell window manager we're done
713 ECore::WindowRenderSurface* x11Window = dynamic_cast< ECore::WindowRenderSurface * >( mSurface );
716 #ifndef DALI_PROFILE_UBUNTU
717 Ecore_X_Window ecoreWindow = x11Window->GetXWindow();
718 Ecore_X_Window root = ecore_x_window_root_get(ecoreWindow);
721 * send rotation done message to wm, even if window is already rotated.
722 * that's why wm must be wait for comming rotation done message
723 * after sending rotation request.
725 ecore_x_e_window_rotation_change_done_send(root, ecoreWindow, orientation, width, height);
728 * set rotate window property
730 int angles[2] = { orientation, orientation };
731 ecore_x_window_prop_property_set( ecoreWindow,
732 ECORE_X_ATOM_E_ILLUME_ROTATE_WINDOW_ANGLE,
733 ECORE_X_ATOM_CARDINAL, 32, &angles, 2 );
734 #endif // DALI_PROFILE_UBUNTU