[3.0] Add key grab/ungrab API for Tizen (X11/Wayland)
[platform/core/uifw/dali-adaptor.git] / adaptors / wayland / window-impl-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 <indicator-impl.h>
35 #include <window-visibility-observer.h>
36 #include <orientation-impl.h>
37
38 namespace
39 {
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 );
43 }
44
45 namespace Dali
46 {
47 namespace Internal
48 {
49 namespace Adaptor
50 {
51 #if defined(DEBUG_ENABLED)
52 Debug::Filter* gWindowLogFilter = Debug::Filter::New(Debug::Concise, false, "LOG_WINDOW");
53 #endif
54
55 /**
56  * TODO: Abstract Window class out and move this into a window implementation for Ecore
57  */
58 struct Window::EventHandler
59 {
60   /**
61    * Constructor
62    * @param[in]  window  A pointer to the window class.
63    */
64   EventHandler( Window* window )
65   : mWindow( window ),
66     mWindowPropertyHandler( NULL ),
67     mClientMessagehandler( NULL ),
68     mEcoreWindow( 0 )
69   {
70     // store ecore window handle
71     ECore::WindowRenderSurface* wlWindow( dynamic_cast< ECore::WindowRenderSurface * >( mWindow->mSurface ) );
72     if( wlWindow )
73     {
74       mEcoreWindow = wlWindow->GetWlWindow();
75     }
76     DALI_ASSERT_ALWAYS( mEcoreWindow != 0 && "There is no ecore wl window");
77   }
78
79   /**
80    * Destructor
81    */
82   ~EventHandler()
83   {
84     if ( mWindowPropertyHandler )
85     {
86       ecore_event_handler_del( mWindowPropertyHandler );
87     }
88     if ( mClientMessagehandler )
89     {
90       ecore_event_handler_del( mClientMessagehandler );
91     }
92   }
93
94   // Static methods
95
96   /// Called when the window properties are changed.
97   static Eina_Bool EcoreEventWindowPropertyChanged( void* data, int type, void* event )
98   {
99     return EINA_FALSE;
100   }
101
102   /// Called when the window properties are changed.
103   static Eina_Bool EcoreEventClientMessage( void* data, int type, void* event )
104   {
105     return EINA_FALSE;
106   }
107
108   // Data
109   Window* mWindow;
110   Ecore_Event_Handler* mWindowPropertyHandler;
111   Ecore_Event_Handler* mClientMessagehandler;
112   Ecore_Wl_Window* mEcoreWindow;
113 };
114
115
116 Window* Window::New(const PositionSize& posSize, const std::string& name, bool isTransparent)
117 {
118   Window* window = new Window();
119   window->mIsTransparent = isTransparent;
120   window->Initialize(posSize, name);
121   return window;
122 }
123
124 void Window::SetAdaptor(Dali::Adaptor& adaptor)
125 {
126   DALI_ASSERT_ALWAYS( !mStarted && "Adaptor already started" );
127   mStarted = true;
128
129   // Only create one overlay per window
130   Internal::Adaptor::Adaptor& adaptorImpl = Internal::Adaptor::Adaptor::GetImplementation(adaptor);
131   Integration::Core& core = adaptorImpl.GetCore();
132   mOverlay = &core.GetSystemOverlay();
133
134   Dali::RenderTaskList taskList = mOverlay->GetOverlayRenderTasks();
135   taskList.CreateTask();
136
137   mAdaptor = &adaptorImpl;
138   mAdaptor->AddObserver( *this );
139
140   // Can only create the detector when we know the Core has been instantiated.
141   mDragAndDropDetector = DragAndDropDetector::New();
142   mAdaptor->SetDragAndDropDetector( &GetImplementation( mDragAndDropDetector ) );
143
144   if( mOrientation )
145   {
146     mOrientation->SetAdaptor(adaptor);
147   }
148
149   if( mIndicator != NULL )
150   {
151     mIndicator->SetAdaptor(mAdaptor);
152   }
153 }
154
155 RenderSurface* Window::GetSurface()
156 {
157   return mSurface;
158 }
159
160 void Window::ShowIndicator( Dali::Window::IndicatorVisibleMode visibleMode )
161 {
162   DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "visible : %d\n", visibleMode );
163   DALI_ASSERT_DEBUG(mOverlay);
164
165   DoShowIndicator( mIndicatorOrientation );
166 }
167
168 void Window::RotateIndicator(Dali::Window::WindowOrientation orientation)
169 {
170   DALI_LOG_TRACE_METHOD_FMT( gWindowLogFilter, "Orientation: %d\n", orientation );
171
172   DoRotateIndicator( orientation );
173 }
174
175 void Window::SetIndicatorBgOpacity( Dali::Window::IndicatorBgOpacity opacityMode )
176 {
177   mIndicatorOpacityMode = opacityMode;
178
179   if( mIndicator != NULL )
180   {
181     mIndicator->SetOpacityMode( opacityMode );
182   }
183 }
184
185 void Window::SetClass(std::string name, std::string klass)
186 {
187 }
188
189 Window::Window()
190 : mSurface(NULL),
191   mIndicatorVisible(Dali::Window::VISIBLE),
192   mIndicatorIsShown(false),
193   mShowRotatedIndicatorOnClose(false),
194   mStarted(false),
195   mIsTransparent(false),
196   mWMRotationAppSet(false),
197   mIndicator(NULL),
198   mIndicatorOrientation(Dali::Window::PORTRAIT),
199   mNextIndicatorOrientation(Dali::Window::PORTRAIT),
200   mIndicatorOpacityMode(Dali::Window::OPAQUE),
201   mOverlay(NULL),
202   mAdaptor(NULL)
203 {
204 }
205
206 Window::~Window()
207 {
208   delete mEventHandler;
209
210   if( mIndicator )
211   {
212     mIndicator->Close();
213     delete mIndicator;
214   }
215
216   if ( mAdaptor )
217   {
218     mAdaptor->RemoveObserver( *this );
219     mAdaptor->SetDragAndDropDetector( NULL );
220     mAdaptor = NULL;
221   }
222
223   delete mSurface;
224 }
225
226 void Window::Initialize(const PositionSize& windowPosition, const std::string& name)
227 {
228   // create an Wayland window by default
229   Any surface;
230   ECore::WindowRenderSurface* windowSurface = new ECore::WindowRenderSurface( windowPosition, surface, name, mIsTransparent );
231   windowSurface->Map();
232
233   mSurface = windowSurface;
234
235   mOrientation = Orientation::New(this);
236
237   // create event handler for Wayland window
238   mEventHandler = new EventHandler( this );
239 }
240
241 void Window::DoShowIndicator( Dali::Window::WindowOrientation lastOrientation )
242 {
243   if( mIndicator == NULL )
244   {
245     if( mIndicatorVisible != Dali::Window::INVISIBLE )
246     {
247       mIndicator = new Indicator( mAdaptor, mIndicatorOrientation, this );
248       mIndicator->SetOpacityMode( mIndicatorOpacityMode );
249       Dali::Actor actor = mIndicator->GetActor();
250       SetIndicatorActorRotation();
251       mOverlay->Add(actor);
252     }
253     // else don't create a hidden indicator
254   }
255   else // Already have indicator
256   {
257     if( mIndicatorVisible == Dali::Window::VISIBLE )
258     {
259       // If we are resuming, and rotation has changed,
260       if( mIndicatorIsShown == false && mIndicatorOrientation != mNextIndicatorOrientation )
261       {
262         // then close current indicator and open new one
263         mShowRotatedIndicatorOnClose = true;
264         mIndicator->Close(); // May synchronously call IndicatorClosed() callback & 1 level of recursion
265         // Don't show actor - will contain indicator for old orientation.
266       }
267     }
268   }
269
270   // set indicator visible mode
271   if( mIndicator != NULL )
272   {
273     mIndicator->SetVisible( mIndicatorVisible );
274   }
275
276   bool show = (mIndicatorVisible != Dali::Window::INVISIBLE );
277   SetIndicatorProperties( show, lastOrientation );
278   mIndicatorIsShown = show;
279 }
280
281 void Window::DoRotateIndicator( Dali::Window::WindowOrientation orientation )
282 {
283   if( mIndicatorIsShown )
284   {
285     mShowRotatedIndicatorOnClose = true;
286     mNextIndicatorOrientation = orientation;
287     mIndicator->Close(); // May synchronously call IndicatorClosed() callback
288   }
289   else
290   {
291     // Save orientation for when the indicator is next shown
292     mShowRotatedIndicatorOnClose = false;
293     mNextIndicatorOrientation = orientation;
294   }
295 }
296
297 void Window::SetIndicatorProperties( bool isShow, Dali::Window::WindowOrientation lastOrientation )
298 {
299 }
300
301 void Window::IndicatorTypeChanged(Indicator::Type type)
302 {
303 }
304
305 void Window::IndicatorClosed( Indicator* indicator )
306 {
307   DALI_LOG_TRACE_METHOD( gWindowLogFilter );
308
309   if( mShowRotatedIndicatorOnClose )
310   {
311     Dali::Window::WindowOrientation currentOrientation = mIndicatorOrientation;
312     mIndicator->Open(mNextIndicatorOrientation);
313     mIndicatorOrientation = mNextIndicatorOrientation;
314     SetIndicatorActorRotation();
315     DoShowIndicator(currentOrientation);
316   }
317 }
318
319 void Window::IndicatorVisibilityChanged(bool isVisible)
320 {
321   mIndicatorVisibilityChangedSignal.Emit(isVisible);
322 }
323
324 void Window::SetIndicatorActorRotation()
325 {
326   DALI_LOG_TRACE_METHOD( gWindowLogFilter );
327   DALI_ASSERT_DEBUG( mIndicator != NULL );
328
329   Dali::Actor actor = mIndicator->GetActor();
330   switch( mIndicatorOrientation )
331   {
332     case Dali::Window::PORTRAIT:
333       actor.SetParentOrigin( ParentOrigin::TOP_CENTER );
334       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
335       actor.SetOrientation( Degree(0), Vector3::ZAXIS );
336       break;
337     case Dali::Window::PORTRAIT_INVERSE:
338       actor.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
339       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
340       actor.SetOrientation( Degree(180), Vector3::ZAXIS );
341       break;
342     case Dali::Window::LANDSCAPE:
343       actor.SetParentOrigin( ParentOrigin::CENTER_LEFT );
344       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
345       actor.SetOrientation( Degree(270), Vector3::ZAXIS );
346       break;
347     case Dali::Window::LANDSCAPE_INVERSE:
348       actor.SetParentOrigin( ParentOrigin::CENTER_RIGHT );
349       actor.SetAnchorPoint(  AnchorPoint::TOP_CENTER );
350       actor.SetOrientation( Degree(90), Vector3::ZAXIS );
351       break;
352   }
353 }
354
355 void Window::Raise()
356 {
357 }
358
359 void Window::Lower()
360 {
361 }
362
363 void Window::Activate()
364 {
365 }
366
367 Dali::DragAndDropDetector Window::GetDragAndDropDetector() const
368 {
369   return mDragAndDropDetector;
370 }
371
372 Dali::Any Window::GetNativeHandle() const
373 {
374   if(mEventHandler)
375   {
376     return mEventHandler->mEcoreWindow;
377   }
378   else
379   {
380     return Dali::Any();
381   }
382 }
383
384 void Window::OnStart()
385 {
386   DoShowIndicator( mIndicatorOrientation );
387 }
388
389 void Window::OnPause()
390 {
391 }
392
393 void Window::OnResume()
394 {
395   // resume indicator status
396   if( mIndicator != NULL )
397   {
398     // Restore own indicator opacity
399     // Send opacity mode to indicator service when app resumed
400     mIndicator->SetOpacityMode( mIndicatorOpacityMode );
401   }
402 }
403
404 void Window::OnStop()
405 {
406   if( mIndicator )
407   {
408     mIndicator->Close();
409   }
410
411   delete mIndicator;
412   mIndicator = NULL;
413 }
414
415 void Window::OnDestroy()
416 {
417   mAdaptor = NULL;
418 }
419
420 void Window::AddAvailableOrientation(Dali::Window::WindowOrientation orientation)
421 {
422   bool found = false;
423
424   for( std::size_t i=0; i<mAvailableOrientations.size(); i++ )
425   {
426     if(mAvailableOrientations[i] == orientation)
427     {
428       found = true;
429       break;
430     }
431   }
432
433   if( ! found )
434   {
435     mAvailableOrientations.push_back(orientation);
436     SetAvailableOrientations( mAvailableOrientations );
437   }
438 }
439
440 void Window::RemoveAvailableOrientation(Dali::Window::WindowOrientation orientation)
441 {
442   for( std::vector<Dali::Window::WindowOrientation>::iterator iter = mAvailableOrientations.begin();
443        iter != mAvailableOrientations.end(); ++iter )
444   {
445     if( *iter == orientation )
446     {
447       mAvailableOrientations.erase( iter );
448       break;
449     }
450   }
451   SetAvailableOrientations( mAvailableOrientations );
452 }
453
454 void Window::SetAvailableOrientations(const std::vector<Dali::Window::WindowOrientation>& orientations)
455 {
456   DALI_ASSERT_ALWAYS( mAvailableOrientations.size() <= 4 && "Incorrect number of available orientations" );
457 }
458
459 const std::vector<Dali::Window::WindowOrientation>& Window::GetAvailableOrientations()
460 {
461   return mAvailableOrientations;
462 }
463
464 void Window::SetPreferredOrientation(Dali::Window::WindowOrientation orientation)
465 {
466   mPreferredOrientation = orientation;
467 }
468
469 Dali::Window::WindowOrientation Window::GetPreferredOrientation()
470 {
471   return mPreferredOrientation;
472 }
473
474 void Window::RotationDone( int orientation, int width, int height )
475 {
476 }
477
478
479 } // Adaptor
480 } // Internal
481 } // Dali