[Tizen] Add MouseInOutEventSignal
[platform/core/uifw/dali-adaptor.git] / dali / internal / window-system / tizen-wayland / ecore-wl2 / window-base-ecore-wl2.h
1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_TIZENWAYLAND_WINDOW_BASE_ECORE_WL2_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_TIZENWAYLAND_WINDOW_BASE_ECORE_WL2_H
3
4 /*
5  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali/internal/window-system/common/window-base.h>
23
24 // EXTERNAL HEADERS
25 #include <Ecore.h>
26 #include <Ecore_Wl2.h>
27 #include <input-method-client-protocol.h>
28 #include <tizen-extension-client-protocol.h>
29 #include <wayland-egl.h>
30 #include <xkbcommon/xkbcommon.h>
31
32 namespace Dali
33 {
34 namespace Internal
35 {
36 namespace Adaptor
37 {
38 class WindowRenderSurface;
39 class WindowRenderSurfaceEcoreWl2;
40
41 /**
42  * WindowBaseEcoreWl2 class provides an WindowBase Ecore-Wayland2 implementation.
43  */
44 class WindowBaseEcoreWl2 : public WindowBase
45 {
46 public:
47   /**
48    * @brief Constructor
49    */
50   WindowBaseEcoreWl2(PositionSize positionSize, Any surface, bool isTransparent);
51
52   /**
53    * @brief Destructor
54    */
55   virtual ~WindowBaseEcoreWl2();
56
57 public:
58   /**
59    * @brief Called when the window iconify state is changed.
60    */
61   Eina_Bool OnIconifyStateChanged(void* data, int type, void* event);
62
63   /**
64    * @brief Called when the window gains focus.
65    */
66   Eina_Bool OnFocusIn(void* data, int type, void* event);
67
68   /**
69    * @brief Called when the window loses focus.
70    */
71   Eina_Bool OnFocusOut(void* data, int type, void* event);
72
73   /**
74    * @brief Called when the output is transformed.
75    */
76   Eina_Bool OnOutputTransform(void* data, int type, void* event);
77
78   /**
79    * @brief Called when the output transform should be ignored.
80    */
81   Eina_Bool OnIgnoreOutputTransform(void* data, int type, void* event);
82
83   /**
84    * @brief Called when a rotation event is recevied.
85    */
86   void OnRotation(void* data, int type, void* event);
87
88   /**
89    * @brief Called when a configure event is recevied.
90    */
91   void OnConfiguration(void* data, int type, void* event);
92
93   /**
94    * @brief Called when a touch down is received.
95    */
96   void OnMouseButtonDown(void* data, int type, void* event);
97
98   /**
99    * @brief Called when a touch up is received.
100    */
101   void OnMouseButtonUp(void* data, int type, void* event);
102
103   /**
104    * @brief Called when a touch motion is received.
105    */
106   void OnMouseButtonMove(void* data, int type, void* event);
107
108   /**
109    * @brief Called when a touch is canceled.
110    */
111   void OnMouseButtonCancel(void* data, int type, void* event);
112
113   /**
114    * @brief Called when a mouse wheel is received.
115    */
116   void OnMouseWheel(void* data, int type, void* event);
117
118   /**
119    * @brief Called when a mouse in or out is received.
120    */
121   void OnMouseInOut(void* data, int type, void* event, Dali::DevelWindow::MouseInOutEvent::Type action);
122
123   /**
124    * @brief Called when a detent rotation event is recevied.
125    */
126   void OnDetentRotation(void* data, int type, void* event);
127
128   /**
129    * @brief Called when a key down is received.
130    */
131   void OnKeyDown(void* data, int type, void* event);
132
133   /**
134    * @brief Called when a key up is received.
135    */
136   void OnKeyUp(void* data, int type, void* event);
137
138   /**
139    * @brief Called when the source window notifies us the content in clipboard is selected.
140    */
141   void OnDataSend(void* data, int type, void* event);
142
143   /**
144    * @brief Called when the source window sends us about the selected content.
145    */
146   void OnDataReceive(void* data, int type, void* event);
147
148   /**
149    * @brief Called when a font name is changed.
150    */
151   void OnFontNameChanged();
152
153   /**
154    * @brief Called when a font size is changed.
155    */
156   void OnFontSizeChanged();
157
158   /**
159    * @brief Called when a transition effect-start/end event is received.
160    */
161   void OnTransitionEffectEvent(WindowEffectState state, WindowEffectType type);
162
163   /**
164    * @brief Called when a keyboard repeat event is changed.
165    */
166   void OnKeyboardRepeatSettingsChanged();
167
168   /**
169    * @brief Called when a window redraw is requested.
170    */
171   void OnEcoreEventWindowRedrawRequest();
172
173   /**
174    * @brief Called when window's auxiliary is changed then display server send the changed message.
175    *
176    * @param[in] auxiliary's message data. It has key, value and integer list data.
177    */
178   void OnEcoreEventWindowAuxiliaryMessage(void* event);
179
180   /**
181    * @brief Called when a keymap is changed.
182    */
183   void KeymapChanged(void* data, int type, void* event);
184
185   /**
186    * @brief RegistryGlobalCallback
187    */
188   void RegistryGlobalCallback(void* data, struct wl_registry* registry, uint32_t name, const char* interface, uint32_t version);
189
190   /**
191    * @brief RegistryGlobalCallbackRemove
192    */
193   void RegistryGlobalCallbackRemove(void* data, struct wl_registry* registry, uint32_t id);
194
195   /**
196    * @brief TizenPolicyNotificationChangeDone
197    */
198   void TizenPolicyNotificationChangeDone(void* data, struct tizen_policy* tizenPolicy, struct wl_surface* surface, int32_t level, uint32_t state);
199
200   /**
201    * @brief TizenPolicyScreenModeChangeDone
202    */
203   void TizenPolicyScreenModeChangeDone(void* data, struct tizen_policy* tizenPolicy, struct wl_surface* surface, uint32_t mode, uint32_t state);
204
205   /**
206    * @brief DisplayPolicyBrightnessChangeDone
207    */
208   void DisplayPolicyBrightnessChangeDone(void* data, struct tizen_display_policy* displayPolicy, struct wl_surface* surface, int32_t brightness, uint32_t state);
209
210   /**
211    * @brief Gets the key code by keyName.
212    */
213   void GetKeyCode(std::string keyName, int32_t& keyCode);
214
215 public:
216   /**
217    * @copydoc Dali::Internal::Adaptor::WindowBase::GetNativeWindow()
218    */
219   Any GetNativeWindow() override;
220
221   /**
222    * @copydoc Dali::Internal::Adaptor::WindowBase::GetNativeWindowId()
223    */
224   int GetNativeWindowId() override;
225
226   /**
227    * @copydoc Dali::Internal::Adaptor::WindowBase::GetNativeWindowResourceId()
228    */
229   std::string GetNativeWindowResourceId() override;
230
231   /**
232    * @copydoc Dali::Internal::Adaptor::WindowBase::CreateEglWindow()
233    */
234   EGLNativeWindowType CreateEglWindow(int width, int height) override;
235
236   /**
237    * @copydoc Dali::Internal::Adaptor::WindowBase::DestroyEglWindow()
238    */
239   void DestroyEglWindow() override;
240
241   /**
242    * @copydoc Dali::Internal::Adaptor::WindowBase::SetEglWindowRotation()
243    */
244   void SetEglWindowRotation(int angle) override;
245
246   /**
247    * @copydoc Dali::Internal::Adaptor::WindowBase::SetEglWindowBufferTransform()
248    */
249   void SetEglWindowBufferTransform(int angle) override;
250
251   /**
252    * @copydoc Dali::Internal::Adaptor::WindowBase::SetEglWindowTransform()
253    */
254   void SetEglWindowTransform(int angle) override;
255
256   /**
257    * @copydoc Dali::Internal::Adaptor::WindowBase::ResizeEglWindow()
258    */
259   void ResizeEglWindow(PositionSize positionSize) override;
260
261   /**
262    * @copydoc Dali::Internal::Adaptor::WindowBase::IsEglWindowRotationSupported()
263    */
264   bool IsEglWindowRotationSupported() override;
265
266   /**
267    * @copydoc Dali::Internal::Adaptor::WindowBase::Move()
268    */
269   void Move(PositionSize positionSize) override;
270
271   /**
272    * @copydoc Dali::Internal::Adaptor::WindowBase::Resize()
273    */
274   void Resize(PositionSize positionSize) override;
275
276   /**
277    * @copydoc Dali::Internal::Adaptor::WindowBase::MoveResize()
278    */
279   void MoveResize(PositionSize positionSize) override;
280
281   /**
282    * @copydoc Dali::Internal::Adaptor::WindowBase::SetLayout()
283    */
284   void SetLayout(unsigned int numCols, unsigned int numRows, unsigned int column, unsigned int row, unsigned int colSpan, unsigned int rowSpan) override;
285
286   /**
287    * @copydoc Dali::Internal::Adaptor::WindowBase::SetClass()
288    */
289   void SetClass(const std::string& name, const std::string& className) override;
290
291   /**
292    * @copydoc Dali::Internal::Adaptor::WindowBase::Raise()
293    */
294   void Raise() override;
295
296   /**
297    * @copydoc Dali::Internal::Adaptor::WindowBase::Lower()
298    */
299   void Lower() override;
300
301   /**
302    * @copydoc Dali::Internal::Adaptor::WindowBase::Activate()
303    */
304   void Activate() override;
305
306   /**
307    * @copydoc Dali::Internal::Adaptor::WindowBase::Maximize()
308    */
309   void Maximize(bool maximize) override;
310
311   /**
312    * @copydoc Dali::Internal::Adaptor::WindowBase::IsMaximized()
313    */
314   bool IsMaximized() const override;
315
316   /**
317    * @copydoc Dali::Internal::Adaptor::WindowBase::SetMaximumSize()
318    */
319   void SetMaximumSize(Dali::Window::WindowSize size) override;
320
321   /**
322    * @copydoc Dali::Internal::Adaptor::WindowBase::Minimize()
323    */
324   void Minimize(bool minimize) override;
325
326   /**
327    * @copydoc Dali::Internal::Adaptor::WindowBase::IsMinimized()
328    */
329   bool IsMinimized() const override;
330
331   /**
332    * @copydoc Dali::Internal::Adaptor::WindowBase::SetMimimumSize()
333    */
334   void SetMimimumSize(Dali::Window::WindowSize size) override;
335
336   /**
337    * @copydoc Dali::Internal::Adaptor::WindowBase::SetAvailableAnlges()
338    */
339   void SetAvailableAnlges(const std::vector<int>& angles) override;
340
341   /**
342    * @copydoc Dali::Internal::Adaptor::WindowBase::SetPreferredAngle()
343    */
344   void SetPreferredAngle(int angle) override;
345
346   /**
347    * @copydoc Dali::Internal::Adaptor::WindowBase::SetAcceptFocus()
348    */
349   void SetAcceptFocus(bool accept) override;
350
351   /**
352    * @copydoc Dali::Internal::Adaptor::WindowBase::Show()
353    */
354   void Show() override;
355
356   /**
357    * @copydoc Dali::Internal::Adaptor::WindowBase::Hide()
358    */
359   void Hide() override;
360
361   /**
362    * @copydoc Dali::Internal::Adaptor::WindowBase::GetSupportedAuxiliaryHintCount()
363    */
364   unsigned int GetSupportedAuxiliaryHintCount() const override;
365
366   /**
367    * @copydoc Dali::Internal::Adaptor::WindowBase::GetSupportedAuxiliaryHint()
368    */
369   std::string GetSupportedAuxiliaryHint(unsigned int index) const override;
370
371   /**
372    * @copydoc Dali::Internal::Adaptor::WindowBase::AddAuxiliaryHint()
373    */
374   unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value) override;
375
376   /**
377    * @copydoc Dali::Internal::Adaptor::WindowBase::RemoveAuxiliaryHint()
378    */
379   bool RemoveAuxiliaryHint(unsigned int id) override;
380
381   /**
382    * @copydoc Dali::Internal::Adaptor::WindowBase::SetAuxiliaryHintValue()
383    */
384   bool SetAuxiliaryHintValue(unsigned int id, const std::string& value) override;
385
386   /**
387    * @copydoc Dali::Internal::Adaptor::WindowBase::GetAuxiliaryHintValue()
388    */
389   std::string GetAuxiliaryHintValue(unsigned int id) const override;
390
391   /**
392    * @copydoc Dali::Internal::Adaptor::WindowBase::GetAuxiliaryHintId()
393    */
394   unsigned int GetAuxiliaryHintId(const std::string& hint) const override;
395
396   /**
397    * @copydoc Dali::Internal::Adaptor::WindowBase::SetInputRegion()
398    */
399   void SetInputRegion(const Rect<int>& inputRegion) override;
400
401   /**
402    * @copydoc Dali::Internal::Adaptor::WindowBase::SetType()
403    */
404   void SetType(Dali::WindowType type) override;
405
406   /**
407    * @copydoc Dali::Internal::Adaptor::WindowBase::GetType()
408    */
409   Dali::WindowType GetType() const override;
410
411   /**
412    * @copydoc Dali::Internal::Adaptor::WindowBase::SetNotificationLevel()
413    */
414   Dali::WindowOperationResult SetNotificationLevel(Dali::WindowNotificationLevel level) override;
415
416   /**
417    * @copydoc Dali::Internal::Adaptor::WindowBase::GetNotificationLevel()
418    */
419   Dali::WindowNotificationLevel GetNotificationLevel() const override;
420
421   /**
422    * @copydoc Dali::Internal::Adaptor::WindowBase::SetOpaqueState()
423    */
424   void SetOpaqueState(bool opaque) override;
425
426   /**
427    * @copydoc Dali::Internal::Adaptor::WindowBase::SetScreenOffMode()
428    */
429   Dali::WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode) override;
430
431   /**
432    * @copydoc Dali::Internal::Adaptor::WindowBase::GetScreenOffMode()
433    */
434   WindowScreenOffMode GetScreenOffMode() const override;
435
436   /**
437    * @copydoc Dali::Internal::Adaptor::WindowBase::SetBrightness()
438    */
439   Dali::WindowOperationResult SetBrightness(int brightness) override;
440
441   /**
442    * @copydoc Dali::Internal::Adaptor::WindowBase::GetBrightness()
443    */
444   int GetBrightness() const override;
445
446   /**
447    * @copydoc Dali::Internal::Adaptor::WindowBase::GrabKey()
448    */
449   bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode) override;
450
451   /**
452    * @copydoc Dali::Internal::Adaptor::WindowBase::UngrabKey()
453    */
454   bool UngrabKey(Dali::KEY key) override;
455
456   /**
457    * @copydoc Dali::Internal::Adaptor::WindowBase::GrabKeyList()
458    */
459   bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result) override;
460
461   /**
462    * @copydoc Dali::Internal::Adaptor::WindowBase::UngrabKeyList()
463    */
464   bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result) override;
465
466   /**
467    * @copydoc Dali::Internal::Adaptor::WindowBase::GetDpi()
468    */
469   void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) override;
470
471   /**
472    * @copydoc Dali::Internal::Adaptor::WindowBase::GetWindowRotationAngle()
473    */
474   int GetWindowRotationAngle() const override;
475
476   /**
477    * @copydoc Dali::Internal::Adaptor::WindowBase::GetScreenRotationAngle()
478    */
479   int GetScreenRotationAngle() override;
480
481   /**
482    * @copydoc Dali::Internal::Adaptor::WindowBase::SetWindowRotationAngle()
483    */
484   void SetWindowRotationAngle(int degree) override;
485
486   /**
487    * @copydoc Dali::Internal::Adaptor::WindowBase::WindowRotationCompleted()
488    */
489   void WindowRotationCompleted(int degree, int width, int height) override;
490
491   /**
492    * @copydoc Dali::Internal::Adaptor::WindowBase::SetTransparency()
493    */
494   void SetTransparency(bool transparent) override;
495
496   /**
497    * @copydoc Dali::Internal::Adaptor::WindowBase::SetParent()
498    */
499   void SetParent(WindowBase* parentWinBase, bool belowParent) override;
500
501   /**
502    * @copydoc  Dali::Internal::Adaptor::WindowBase::CreateFrameRenderedSyncFence()
503    */
504   int CreateFrameRenderedSyncFence() override;
505
506   /**
507    * @copydoc  Dali::Internal::Adaptor::WindowBase::CreateFramePresentedSyncFence()
508    */
509   int CreateFramePresentedSyncFence() override;
510
511   /**
512    * @copydoc Dali::Internal::Adaptor::WindowBase::SetPositionSizeWithAngle()
513    */
514   void SetPositionSizeWithAngle(PositionSize positionSize, int angle) override;
515
516   /**
517    * @copydoc Dali::Internal::Adaptor::WindowBase::InitializeIme()
518    */
519   void InitializeIme() override;
520
521   /**
522    * @copydoc Dali::Internal::Adaptor::WindowBase::ImeWindowReadyToRender()
523    */
524   void ImeWindowReadyToRender() override;
525
526   /**
527    * @copydoc Dali::Internal::Adaptor::WindowBase::RequestMoveToServer()
528    */
529   void RequestMoveToServer() override;
530
531   /**
532    * @copydoc Dali::Internal::Adaptor::WindowBase::RequestResizeToServer()
533    */
534   void RequestResizeToServer(WindowResizeDirection direction) override;
535
536   /**
537    * @copydoc Dali::Internal::Adaptor::WindowBase::EnableFloatingMode()
538    */
539   void EnableFloatingMode(bool enable) override;
540
541   /**
542    * @copydoc Dali::Internal::Adaptor::WindowBase::IsFloatingModeEnabled()
543    */
544   bool IsFloatingModeEnabled() const override;
545
546   /**
547    * @copydoc Dali::Internal::Adaptor::WindowBase::IncludeInputRegion()
548    */
549   void IncludeInputRegion(const Rect<int>& inputRegion) override;
550
551   /**
552    * @copydoc Dali::Internal::Adaptor::WindowBase::ExcludeInputRegion()
553    */
554   void ExcludeInputRegion(const Rect<int>& inputRegion) override;
555
556 private:
557   /**
558    * Second stage initialization
559    */
560   void Initialize(PositionSize positionSize, Any surface, bool isTransparent);
561
562   /**
563    * @brief Create window
564    */
565   void CreateWindow(PositionSize positionSize);
566
567   /**
568    * @brief Return the window's position and size to recalulate with the default system coordinates.
569    * It is used when window is moved or resized for native ecore wayland window system.
570    *
571    * @param[in] positionSize the window's current position and size with current oriented window's coordinates.
572    * @return the re-calculated window's position and size on the default system coordinates.
573    */
574   PositionSize RecalculatePositionSizeToSystem(PositionSize positionSize);
575
576   /**
577    * @brief Return the window's position and size to recalulate with current oriented window's coordinates.
578    * It is used when window is moved or resized for dali and uppler layer framework.
579    *
580    * @param[in] positionSize the window's current position and size with the default system coordinates.
581    * @return the re-calculated window's position and size on current oriented window's coordinates.
582    */
583   PositionSize RecalculatePositionSizeToCurrentOrientation(PositionSize positionSize);
584
585   /**
586    * @brief Return the rect value to recalulate with the default system coordinates.
587    *
588    * Some native window APIs work the geometry value based on the default system coordinates.
589    * IncludeInputRegion() and ExcludeInputRegion() are one of them.
590    * When the window is rotated, current window's geometry already were set with the rotated angle.
591    * If IncludeInputRegion() or ExcludeInputRegion() are called with rotated angle by application,
592    * the rect's area should be re-calcuated on the default system coordinates.
593    *
594    * @param[in] rect the window's current position and size with current window rotation angle.
595    * @return the re-calculated rect on the default system coordinates.
596    */
597   Rect<int> RecalculateInputRect(const Rect<int>& rect);
598
599 protected:
600   // Undefined
601   WindowBaseEcoreWl2(const WindowBaseEcoreWl2&) = delete;
602
603   // Undefined
604   WindowBaseEcoreWl2& operator=(const WindowBaseEcoreWl2& rhs) = delete;
605
606 private:
607   typedef std::vector<std::pair<std::string, std::string> > AuxiliaryHints;
608   Dali::Vector<Ecore_Event_Handler*>                        mEcoreEventHandler;
609   Ecore_Wl2_Window*                                         mEcoreWindow;
610
611   wl_surface* mWlSurface;
612 #ifdef OVER_TIZEN_VERSION_7
613   zwp_input_panel_v1* mWlInputPanel;
614 #else
615   wl_input_panel*         mWlInputPanel;
616 #endif
617   wl_output* mWlOutput;
618 #ifdef OVER_TIZEN_VERSION_7
619   zwp_input_panel_surface_v1* mWlInputPanelSurface;
620 #else
621   wl_input_panel_surface* mWlInputPanelSurface;
622 #endif
623
624   wl_egl_window*        mEglWindow;
625   wl_display*           mDisplay;
626   wl_event_queue*       mEventQueue;
627   tizen_policy*         mTizenPolicy;
628   tizen_display_policy* mTizenDisplayPolicy;
629   xkb_keymap*           mKeyMap;
630
631   std::vector<std::string> mSupportedAuxiliaryHints;
632
633   // It is based on the default system coordinates.
634   Dali::PositionSize mWindowPositionSize;
635
636   AuxiliaryHints mAuxiliaryHints;
637
638   WindowType mType;
639   int        mNotificationLevel;
640   int        mScreenOffMode;
641   int        mBrightness;
642   int        mWindowRotationAngle;
643   int        mScreenRotationAngle;
644   int        mSupportedPreProtation;
645
646   uint32_t          mNotificationChangeState;
647   uint32_t          mScreenOffModeChangeState;
648   uint32_t          mBrightnessChangeState;
649   uint32_t          mLastSubmittedMoveResizeSerial;
650   volatile uint32_t mMoveResizeSerial;
651
652   bool mNotificationLevelChangeDone;
653   bool mScreenOffModeChangeDone;
654   bool mVisible : 1;
655   bool mOwnSurface;
656   bool mBrightnessChangeDone;
657 };
658
659 } // namespace Adaptor
660
661 } // namespace Internal
662
663 } // namespace Dali
664
665 #endif // DALI_INTERNAL_WINDOWSYSTEM_TIZENWAYLAND_WINDOW_BASE_ECORE_WL2_H