1 #ifndef DALI_INTERNAL_WINDOWSYSTEM_TIZENWAYLAND_WINDOW_BASE_ECORE_WL2_H
2 #define DALI_INTERNAL_WINDOWSYSTEM_TIZENWAYLAND_WINDOW_BASE_ECORE_WL2_H
5 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/internal/window-system/common/window-base.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>
38 class WindowRenderSurface;
39 class WindowRenderSurfaceEcoreWl2;
42 * WindowBaseEcoreWl2 class provides an WindowBase Ecore-Wayland2 implementation.
44 class WindowBaseEcoreWl2 : public WindowBase
50 WindowBaseEcoreWl2(PositionSize positionSize, Any surface, bool isTransparent);
55 virtual ~WindowBaseEcoreWl2();
59 * @brief Called when the window iconify state is changed.
61 Eina_Bool OnIconifyStateChanged(void* data, int type, void* event);
64 * @brief Called when the window gains focus.
66 Eina_Bool OnFocusIn(void* data, int type, void* event);
69 * @brief Called when the window loses focus.
71 Eina_Bool OnFocusOut(void* data, int type, void* event);
74 * @brief Called when the output is transformed.
76 Eina_Bool OnOutputTransform(void* data, int type, void* event);
79 * @brief Called when the output transform should be ignored.
81 Eina_Bool OnIgnoreOutputTransform(void* data, int type, void* event);
84 * @brief Called when a rotation event is recevied.
86 void OnRotation(void* data, int type, void* event);
89 * @brief Called when a configure event is recevied.
91 void OnConfiguration(void* data, int type, void* event);
94 * @brief Called when a touch down is received.
96 void OnMouseButtonDown(void* data, int type, void* event);
99 * @brief Called when a touch up is received.
101 void OnMouseButtonUp(void* data, int type, void* event);
104 * @brief Called when a touch motion is received.
106 void OnMouseButtonMove(void* data, int type, void* event);
109 * @brief Called when a touch is canceled.
111 void OnMouseButtonCancel(void* data, int type, void* event);
114 * @brief Called when a mouse wheel is received.
116 void OnMouseWheel(void* data, int type, void* event);
119 * @brief Called when a mouse in or out is received.
121 void OnMouseInOut(void* data, int type, void* event, Dali::DevelWindow::MouseInOutEvent::Type action);
124 * @brief Called when a detent rotation event is recevied.
126 void OnDetentRotation(void* data, int type, void* event);
129 * @brief Called when a key down is received.
131 void OnKeyDown(void* data, int type, void* event);
134 * @brief Called when a key up is received.
136 void OnKeyUp(void* data, int type, void* event);
139 * @brief Called when the source window notifies us the content in clipboard is selected.
141 void OnDataSend(void* data, int type, void* event);
144 * @brief Called when the source window sends us about the selected content.
146 void OnDataReceive(void* data, int type, void* event);
149 * @brief Called when a font name is changed.
151 void OnFontNameChanged();
154 * @brief Called when a font size is changed.
156 void OnFontSizeChanged();
159 * @brief Called when a transition effect-start/end event is received.
161 void OnTransitionEffectEvent(WindowEffectState state, WindowEffectType type);
164 * @brief Called when a keyboard repeat event is changed.
166 void OnKeyboardRepeatSettingsChanged();
169 * @brief Called when a window redraw is requested.
171 void OnEcoreEventWindowRedrawRequest();
174 * @brief Called when window's auxiliary is changed then display server send the changed message.
176 * @param[in] auxiliary's message data. It has key, value and integer list data.
178 void OnEcoreEventWindowAuxiliaryMessage(void* event);
181 * @brief Called when a keymap is changed.
183 void KeymapChanged(void* data, int type, void* event);
186 * @brief RegistryGlobalCallback
188 void RegistryGlobalCallback(void* data, struct wl_registry* registry, uint32_t name, const char* interface, uint32_t version);
191 * @brief RegistryGlobalCallbackRemove
193 void RegistryGlobalCallbackRemove(void* data, struct wl_registry* registry, uint32_t id);
196 * @brief TizenPolicyNotificationChangeDone
198 void TizenPolicyNotificationChangeDone(void* data, struct tizen_policy* tizenPolicy, struct wl_surface* surface, int32_t level, uint32_t state);
201 * @brief TizenPolicyScreenModeChangeDone
203 void TizenPolicyScreenModeChangeDone(void* data, struct tizen_policy* tizenPolicy, struct wl_surface* surface, uint32_t mode, uint32_t state);
206 * @brief DisplayPolicyBrightnessChangeDone
208 void DisplayPolicyBrightnessChangeDone(void* data, struct tizen_display_policy* displayPolicy, struct wl_surface* surface, int32_t brightness, uint32_t state);
211 * @brief Gets the key code by keyName.
213 void GetKeyCode(std::string keyName, int32_t& keyCode);
217 * @copydoc Dali::Internal::Adaptor::WindowBase::GetNativeWindow()
219 Any GetNativeWindow() override;
222 * @copydoc Dali::Internal::Adaptor::WindowBase::GetNativeWindowId()
224 int GetNativeWindowId() override;
227 * @copydoc Dali::Internal::Adaptor::WindowBase::GetNativeWindowResourceId()
229 std::string GetNativeWindowResourceId() override;
232 * @copydoc Dali::Internal::Adaptor::WindowBase::CreateEglWindow()
234 EGLNativeWindowType CreateEglWindow(int width, int height) override;
237 * @copydoc Dali::Internal::Adaptor::WindowBase::DestroyEglWindow()
239 void DestroyEglWindow() override;
242 * @copydoc Dali::Internal::Adaptor::WindowBase::SetEglWindowRotation()
244 void SetEglWindowRotation(int angle) override;
247 * @copydoc Dali::Internal::Adaptor::WindowBase::SetEglWindowBufferTransform()
249 void SetEglWindowBufferTransform(int angle) override;
252 * @copydoc Dali::Internal::Adaptor::WindowBase::SetEglWindowTransform()
254 void SetEglWindowTransform(int angle) override;
257 * @copydoc Dali::Internal::Adaptor::WindowBase::ResizeEglWindow()
259 void ResizeEglWindow(PositionSize positionSize) override;
262 * @copydoc Dali::Internal::Adaptor::WindowBase::IsEglWindowRotationSupported()
264 bool IsEglWindowRotationSupported() override;
267 * @copydoc Dali::Internal::Adaptor::WindowBase::Move()
269 void Move(PositionSize positionSize) override;
272 * @copydoc Dali::Internal::Adaptor::WindowBase::Resize()
274 void Resize(PositionSize positionSize) override;
277 * @copydoc Dali::Internal::Adaptor::WindowBase::MoveResize()
279 void MoveResize(PositionSize positionSize) override;
282 * @copydoc Dali::Internal::Adaptor::WindowBase::SetLayout()
284 void SetLayout(unsigned int numCols, unsigned int numRows, unsigned int column, unsigned int row, unsigned int colSpan, unsigned int rowSpan) override;
287 * @copydoc Dali::Internal::Adaptor::WindowBase::SetClass()
289 void SetClass(const std::string& name, const std::string& className) override;
292 * @copydoc Dali::Internal::Adaptor::WindowBase::Raise()
294 void Raise() override;
297 * @copydoc Dali::Internal::Adaptor::WindowBase::Lower()
299 void Lower() override;
302 * @copydoc Dali::Internal::Adaptor::WindowBase::Activate()
304 void Activate() override;
307 * @copydoc Dali::Internal::Adaptor::WindowBase::Maximize()
309 void Maximize(bool maximize) override;
312 * @copydoc Dali::Internal::Adaptor::WindowBase::IsMaximized()
314 bool IsMaximized() const override;
317 * @copydoc Dali::Internal::Adaptor::WindowBase::SetMaximumSize()
319 void SetMaximumSize(Dali::Window::WindowSize size) override;
322 * @copydoc Dali::Internal::Adaptor::WindowBase::Minimize()
324 void Minimize(bool minimize) override;
327 * @copydoc Dali::Internal::Adaptor::WindowBase::IsMinimized()
329 bool IsMinimized() const override;
332 * @copydoc Dali::Internal::Adaptor::WindowBase::SetMimimumSize()
334 void SetMimimumSize(Dali::Window::WindowSize size) override;
337 * @copydoc Dali::Internal::Adaptor::WindowBase::SetAvailableAnlges()
339 void SetAvailableAnlges(const std::vector<int>& angles) override;
342 * @copydoc Dali::Internal::Adaptor::WindowBase::SetPreferredAngle()
344 void SetPreferredAngle(int angle) override;
347 * @copydoc Dali::Internal::Adaptor::WindowBase::SetAcceptFocus()
349 void SetAcceptFocus(bool accept) override;
352 * @copydoc Dali::Internal::Adaptor::WindowBase::Show()
354 void Show() override;
357 * @copydoc Dali::Internal::Adaptor::WindowBase::Hide()
359 void Hide() override;
362 * @copydoc Dali::Internal::Adaptor::WindowBase::GetSupportedAuxiliaryHintCount()
364 unsigned int GetSupportedAuxiliaryHintCount() const override;
367 * @copydoc Dali::Internal::Adaptor::WindowBase::GetSupportedAuxiliaryHint()
369 std::string GetSupportedAuxiliaryHint(unsigned int index) const override;
372 * @copydoc Dali::Internal::Adaptor::WindowBase::AddAuxiliaryHint()
374 unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value) override;
377 * @copydoc Dali::Internal::Adaptor::WindowBase::RemoveAuxiliaryHint()
379 bool RemoveAuxiliaryHint(unsigned int id) override;
382 * @copydoc Dali::Internal::Adaptor::WindowBase::SetAuxiliaryHintValue()
384 bool SetAuxiliaryHintValue(unsigned int id, const std::string& value) override;
387 * @copydoc Dali::Internal::Adaptor::WindowBase::GetAuxiliaryHintValue()
389 std::string GetAuxiliaryHintValue(unsigned int id) const override;
392 * @copydoc Dali::Internal::Adaptor::WindowBase::GetAuxiliaryHintId()
394 unsigned int GetAuxiliaryHintId(const std::string& hint) const override;
397 * @copydoc Dali::Internal::Adaptor::WindowBase::SetInputRegion()
399 void SetInputRegion(const Rect<int>& inputRegion) override;
402 * @copydoc Dali::Internal::Adaptor::WindowBase::SetType()
404 void SetType(Dali::WindowType type) override;
407 * @copydoc Dali::Internal::Adaptor::WindowBase::GetType()
409 Dali::WindowType GetType() const override;
412 * @copydoc Dali::Internal::Adaptor::WindowBase::SetNotificationLevel()
414 Dali::WindowOperationResult SetNotificationLevel(Dali::WindowNotificationLevel level) override;
417 * @copydoc Dali::Internal::Adaptor::WindowBase::GetNotificationLevel()
419 Dali::WindowNotificationLevel GetNotificationLevel() const override;
422 * @copydoc Dali::Internal::Adaptor::WindowBase::SetOpaqueState()
424 void SetOpaqueState(bool opaque) override;
427 * @copydoc Dali::Internal::Adaptor::WindowBase::SetScreenOffMode()
429 Dali::WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode) override;
432 * @copydoc Dali::Internal::Adaptor::WindowBase::GetScreenOffMode()
434 WindowScreenOffMode GetScreenOffMode() const override;
437 * @copydoc Dali::Internal::Adaptor::WindowBase::SetBrightness()
439 Dali::WindowOperationResult SetBrightness(int brightness) override;
442 * @copydoc Dali::Internal::Adaptor::WindowBase::GetBrightness()
444 int GetBrightness() const override;
447 * @copydoc Dali::Internal::Adaptor::WindowBase::GrabKey()
449 bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode) override;
452 * @copydoc Dali::Internal::Adaptor::WindowBase::UngrabKey()
454 bool UngrabKey(Dali::KEY key) override;
457 * @copydoc Dali::Internal::Adaptor::WindowBase::GrabKeyList()
459 bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result) override;
462 * @copydoc Dali::Internal::Adaptor::WindowBase::UngrabKeyList()
464 bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result) override;
467 * @copydoc Dali::Internal::Adaptor::WindowBase::GetDpi()
469 void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) override;
472 * @copydoc Dali::Internal::Adaptor::WindowBase::GetWindowRotationAngle()
474 int GetWindowRotationAngle() const override;
477 * @copydoc Dali::Internal::Adaptor::WindowBase::GetScreenRotationAngle()
479 int GetScreenRotationAngle() override;
482 * @copydoc Dali::Internal::Adaptor::WindowBase::SetWindowRotationAngle()
484 void SetWindowRotationAngle(int degree) override;
487 * @copydoc Dali::Internal::Adaptor::WindowBase::WindowRotationCompleted()
489 void WindowRotationCompleted(int degree, int width, int height) override;
492 * @copydoc Dali::Internal::Adaptor::WindowBase::SetTransparency()
494 void SetTransparency(bool transparent) override;
497 * @copydoc Dali::Internal::Adaptor::WindowBase::SetParent()
499 void SetParent(WindowBase* parentWinBase, bool belowParent) override;
502 * @copydoc Dali::Internal::Adaptor::WindowBase::CreateFrameRenderedSyncFence()
504 int CreateFrameRenderedSyncFence() override;
507 * @copydoc Dali::Internal::Adaptor::WindowBase::CreateFramePresentedSyncFence()
509 int CreateFramePresentedSyncFence() override;
512 * @copydoc Dali::Internal::Adaptor::WindowBase::SetPositionSizeWithAngle()
514 void SetPositionSizeWithAngle(PositionSize positionSize, int angle) override;
517 * @copydoc Dali::Internal::Adaptor::WindowBase::InitializeIme()
519 void InitializeIme() override;
522 * @copydoc Dali::Internal::Adaptor::WindowBase::ImeWindowReadyToRender()
524 void ImeWindowReadyToRender() override;
527 * @copydoc Dali::Internal::Adaptor::WindowBase::RequestMoveToServer()
529 void RequestMoveToServer() override;
532 * @copydoc Dali::Internal::Adaptor::WindowBase::RequestResizeToServer()
534 void RequestResizeToServer(WindowResizeDirection direction) override;
537 * @copydoc Dali::Internal::Adaptor::WindowBase::EnableFloatingMode()
539 void EnableFloatingMode(bool enable) override;
542 * @copydoc Dali::Internal::Adaptor::WindowBase::IsFloatingModeEnabled()
544 bool IsFloatingModeEnabled() const override;
547 * @copydoc Dali::Internal::Adaptor::WindowBase::IncludeInputRegion()
549 void IncludeInputRegion(const Rect<int>& inputRegion) override;
552 * @copydoc Dali::Internal::Adaptor::WindowBase::ExcludeInputRegion()
554 void ExcludeInputRegion(const Rect<int>& inputRegion) override;
558 * Second stage initialization
560 void Initialize(PositionSize positionSize, Any surface, bool isTransparent);
563 * @brief Create window
565 void CreateWindow(PositionSize positionSize);
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.
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.
574 PositionSize RecalculatePositionSizeToSystem(PositionSize positionSize);
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.
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.
583 PositionSize RecalculatePositionSizeToCurrentOrientation(PositionSize positionSize);
586 * @brief Return the rect value to recalulate with the default system coordinates.
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.
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.
597 Rect<int> RecalculateInputRect(const Rect<int>& rect);
601 WindowBaseEcoreWl2(const WindowBaseEcoreWl2&) = delete;
604 WindowBaseEcoreWl2& operator=(const WindowBaseEcoreWl2& rhs) = delete;
607 typedef std::vector<std::pair<std::string, std::string> > AuxiliaryHints;
608 Dali::Vector<Ecore_Event_Handler*> mEcoreEventHandler;
609 Ecore_Wl2_Window* mEcoreWindow;
611 wl_surface* mWlSurface;
612 #ifdef OVER_TIZEN_VERSION_7
613 zwp_input_panel_v1* mWlInputPanel;
615 wl_input_panel* mWlInputPanel;
617 wl_output* mWlOutput;
618 #ifdef OVER_TIZEN_VERSION_7
619 zwp_input_panel_surface_v1* mWlInputPanelSurface;
621 wl_input_panel_surface* mWlInputPanelSurface;
624 wl_egl_window* mEglWindow;
625 wl_display* mDisplay;
626 wl_event_queue* mEventQueue;
627 tizen_policy* mTizenPolicy;
628 tizen_display_policy* mTizenDisplayPolicy;
631 std::vector<std::string> mSupportedAuxiliaryHints;
633 // It is based on the default system coordinates.
634 Dali::PositionSize mWindowPositionSize;
636 AuxiliaryHints mAuxiliaryHints;
639 int mNotificationLevel;
642 int mWindowRotationAngle;
643 int mScreenRotationAngle;
644 int mSupportedPreProtation;
646 uint32_t mNotificationChangeState;
647 uint32_t mScreenOffModeChangeState;
648 uint32_t mBrightnessChangeState;
649 uint32_t mLastSubmittedMoveResizeSerial;
650 volatile uint32_t mMoveResizeSerial;
652 bool mNotificationLevelChangeDone;
653 bool mScreenOffModeChangeDone;
656 bool mBrightnessChangeDone;
659 } // namespace Adaptor
661 } // namespace Internal
665 #endif // DALI_INTERNAL_WINDOWSYSTEM_TIZENWAYLAND_WINDOW_BASE_ECORE_WL2_H