Fix race-condition when window is resized or rotated.
[platform/core/uifw/dali-adaptor.git] / dali / internal / window-system / common / window-base.h
index a055c59..d0115ed 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_WINDOWSYSTEM_COMMON_WINDOW_BASE_H
 
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include <dali/integration-api/events/key-event-integ.h>
 #include <dali/integration-api/events/point.h>
 #include <dali/integration-api/events/wheel-event-integ.h>
+#include <cstdint>
 #include <string>
 #include <vector>
-#include <cstdint>
 
 // INTERNAL INCLUDES
-#include <dali/public-api/adaptor-framework/window.h>
-#include <dali/public-api/adaptor-framework/key-grab.h>
-#include <dali/public-api/adaptor-framework/style-change.h>
 #include <dali/devel-api/adaptor-framework/window-devel.h>
+#include <dali/internal/graphics/gles/egl-implementation.h>
 #include <dali/internal/window-system/common/damage-observer.h>
 #include <dali/internal/window-system/common/rotation-event.h>
-#include <dali/internal/graphics/gles/egl-implementation.h>
+#include <dali/public-api/adaptor-framework/key-grab.h>
+#include <dali/public-api/adaptor-framework/style-change.h>
+#include <dali/public-api/adaptor-framework/window-enumerations.h>
+#include <dali/public-api/adaptor-framework/window.h>
 
 namespace Dali
 {
@@ -41,14 +42,12 @@ namespace Internal
 {
 namespace Adaptor
 {
-
 /**
  * WindowBase interface
  */
 class WindowBase
 {
 public:
-
   /**
    * @brief Struct used to retrieve accessibility information
    */
@@ -64,26 +63,28 @@ public:
   };
 
   // Window
-  typedef Signal< void ( bool ) > IconifySignalType;
-  typedef Signal< void ( bool ) > FocusSignalType;
-  typedef Signal< void ( ) > OutputSignalType;
-  typedef Signal< void ( ) > DeleteSignalType;
-  typedef Signal< void ( const DamageArea& ) > DamageSignalType;
-  typedef Signal< void ( const RotationEvent& ) > RotationSignalType;
-  typedef Signal< void ( DevelWindow::EffectState, DevelWindow::EffectType ) > TransitionEffectEventSignalType;
-  typedef Signal< void ( ) > KeyboardRepeatSettingsChangedSignalType;
+  typedef Signal<void(bool)>                                IconifySignalType;
+  typedef Signal<void(bool)>                                FocusSignalType;
+  typedef Signal<void()>                                    OutputSignalType;
+  typedef Signal<void()>                                    DeleteSignalType;
+  typedef Signal<void(const DamageArea&)>                   DamageSignalType;
+  typedef Signal<void(const RotationEvent&)>                RotationSignalType;
+  typedef Signal<void(WindowEffectState, WindowEffectType)> TransitionEffectEventSignalType;
+  typedef Signal<void()>                                    KeyboardRepeatSettingsChangedSignalType;
+  typedef Signal<void()>                                    WindowRedrawRequestSignalType;
+  typedef Signal<void(Dali::PositionSize&)>                 UpdatePositionSizeType;
+  typedef Signal<void(const std::string&, const std::string&, const Property::Array&)>             AuxiliaryMessageSignalType;
 
   // Input events
-  typedef Signal< void ( Integration::Point&, uint32_t ) > TouchEventSignalType;
-  typedef Signal< void ( Integration::WheelEvent& ) > WheelEventSignalType;
-  typedef Signal< void( Integration::KeyEvent& ) > KeyEventSignalType;
+  typedef Signal<void(Integration::Point&, uint32_t)> TouchEventSignalType;
+  typedef Signal<void(Integration::WheelEvent&)>      WheelEventSignalType;
+  typedef Signal<void(Integration::KeyEvent&)>        KeyEventSignalType;
 
   // Clipboard
-  typedef Signal< void ( void* ) > SelectionSignalType;
+  typedef Signal<void(void*)> SelectionSignalType;
 
   // Accessibility
-  typedef Signal< void ( StyleChange::Type ) > StyleSignalType;
-  typedef Signal< void ( const AccessibilityInfo& ) > AccessibilitySignalType;
+  typedef Signal<void(StyleChange::Type)>        StyleSignalType;
 
   /**
    * @brief Default constructor
@@ -96,7 +97,6 @@ public:
   virtual ~WindowBase();
 
 public:
-
   /**
    * @brief Get the native window handle
    * @return The native window handle
@@ -110,9 +110,15 @@ public:
   virtual int GetNativeWindowId() = 0;
 
   /**
+   * @brief Get the native window resource id assinged by window manager
+   * @return The native window resource id
+   */
+  virtual std::string GetNativeWindowResourceId() = 0;
+
+  /**
    * @brief Create the egl window
    */
-  virtual EGLNativeWindowType CreateEglWindow( int width, int height ) = 0;
+  virtual EGLNativeWindowType CreateEglWindow(int width, int height) = 0;
 
   /**
    * @brief Destroy the egl window
@@ -122,22 +128,22 @@ public:
   /**
    * @brief Set the egl window rotation
    */
-  virtual void SetEglWindowRotation( int angle ) = 0;
+  virtual void SetEglWindowRotation(int angle) = 0;
 
   /**
    * @brief Set the egl window buffer transform
    */
-  virtual void SetEglWindowBufferTransform( int angle ) = 0;
+  virtual void SetEglWindowBufferTransform(int angle) = 0;
 
   /**
    * @brief Set the egl window transform
    */
-  virtual void SetEglWindowTransform( int angle ) = 0;
+  virtual void SetEglWindowTransform(int angle) = 0;
 
   /**
    * @brief Resize the egl window
    */
-  virtual void ResizeEglWindow( Dali::PositionSize positionSize ) = 0;
+  virtual void ResizeEglWindow(Dali::PositionSize positionSize) = 0;
 
   /**
    * @brief Returns whether the egl window support rotation or not
@@ -147,22 +153,22 @@ public:
   /**
    * @brief Move the window
    */
-  virtual void Move( Dali::PositionSize positionSize ) = 0;
+  virtual void Move(Dali::PositionSize positionSize) = 0;
 
   /**
    * @brief Resize the window
    */
-  virtual void Resize( Dali::PositionSize positionSize ) = 0;
+  virtual void Resize(Dali::PositionSize positionSize) = 0;
 
   /**
    * @brief Move and resize the window
    */
-  virtual void MoveResize( Dali::PositionSize positionSize ) = 0;
+  virtual void MoveResize(Dali::PositionSize positionSize) = 0;
 
   /**
    * @copydoc Dali::Window::SetClass()
    */
-  virtual void SetClass( const std::string& name, const std::string& className ) = 0;
+  virtual void SetClass(const std::string& name, const std::string& className) = 0;
 
   /**
    * @copydoc Dali::Window::Raise()
@@ -180,19 +186,49 @@ public:
   virtual void Activate() = 0;
 
   /**
+   * @copydoc Dali::DevelWindow::Maximize()
+   */
+  virtual void Maximize(bool maximize) = 0;
+
+  /**
+   * @copydoc Dali::DevelWindow::IsMaximized()
+   */
+  virtual bool IsMaximized() const = 0;
+
+  /**
+   * @copydoc Dali::DevelWindow::SetMaximumSize()
+   */
+  virtual void SetMaximumSize(Dali::Window::WindowSize size) = 0;
+
+  /**
+   * @copydoc Dali::DevelWindow::Minimize()
+   */
+  virtual void Minimize(bool minimize) = 0;
+
+  /**
+   * @copydoc Dali::DevelWindow::IsMinimized()
+   */
+  virtual bool IsMinimized() const = 0;
+
+  /**
+   * @copydoc Dali::DevelWindow::SetMimimumSize()
+   */
+  virtual void SetMimimumSize(Dali::Window::WindowSize size) = 0;
+
+  /**
    * @copydoc Dali::Window::SetAvailableOrientations()
    */
-  virtual void SetAvailableAnlges( const std::vector< int >& angles ) = 0;
+  virtual void SetAvailableAnlges(const std::vector<int>& angles) = 0;
 
   /**
    * @copydoc Dali::Window::SetPreferredOrientation()
    */
-  virtual void SetPreferredAngle( int angle ) = 0;
+  virtual void SetPreferredAngle(int angle) = 0;
 
   /**
    * @copydoc Dali::Window::SetAcceptFocus()
    */
-  virtual void SetAcceptFocus( bool accept ) = 0;
+  virtual void SetAcceptFocus(bool accept) = 0;
 
   /**
    * @copydoc Dali::Window::Show()
@@ -212,72 +248,77 @@ public:
   /**
    * @copydoc Dali::Window::GetSupportedAuxiliaryHint()
    */
-  virtual std::string GetSupportedAuxiliaryHint( unsigned int index ) const = 0;
+  virtual std::string GetSupportedAuxiliaryHint(unsigned int index) const = 0;
 
   /**
    * @copydoc Dali::Window::AddAuxiliaryHint()
    */
-  virtual unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value ) = 0;
+  virtual unsigned int AddAuxiliaryHint(const std::string& hint, const std::string& value) = 0;
 
   /**
    * @copydoc Dali::Window::RemoveAuxiliaryHint()
    */
-  virtual bool RemoveAuxiliaryHint( unsigned int id ) = 0;
+  virtual bool RemoveAuxiliaryHint(unsigned int id) = 0;
 
   /**
    * @copydoc Dali::Window::SetAuxiliaryHintValue()
    */
-  virtual bool SetAuxiliaryHintValue( unsigned int id, const std::string& value ) = 0;
+  virtual bool SetAuxiliaryHintValue(unsigned int id, const std::string& value) = 0;
 
   /**
    * @copydoc Dali::Window::GetAuxiliaryHintValue()
    */
-  virtual std::string GetAuxiliaryHintValue( unsigned int id ) const = 0;
+  virtual std::string GetAuxiliaryHintValue(unsigned int id) const = 0;
 
   /**
    * @copydoc Dali::Window::GetAuxiliaryHintId()
    */
-  virtual unsigned int GetAuxiliaryHintId( const std::string& hint ) const = 0;
+  virtual unsigned int GetAuxiliaryHintId(const std::string& hint) const = 0;
 
   /**
    * @copydoc Dali::Window::SetInputRegion()
    */
-  virtual void SetInputRegion( const Rect< int >& inputRegion ) = 0;
+  virtual void SetInputRegion(const Rect<int>& inputRegion) = 0;
 
   /**
    * @copydoc Dali::Window::SetType()
    */
-  virtual void SetType( Dali::Window::Type type ) = 0;
+  virtual void SetType(Dali::WindowType type) = 0;
+
+  /**
+   * @copydoc Dali::Window::GetType()
+   */
+  virtual Dali::WindowType GetType() const = 0;
 
   /**
    * @copydoc Dali::Window::SetNotificationLevel()
    */
-  virtual bool SetNotificationLevel( Dali::Window::NotificationLevel::Type level ) = 0;
+  virtual Dali::WindowOperationResult SetNotificationLevel(Dali::WindowNotificationLevel level) = 0;
 
   /**
    * @copydoc Dali::Window::GetNotificationLevel()
    */
-  virtual Dali::Window::NotificationLevel::Type GetNotificationLevel() const = 0;
+  virtual Dali::WindowNotificationLevel GetNotificationLevel() const = 0;
 
   /**
    * @copydoc Dali::Window::SetOpaqueState()
    */
-  virtual void SetOpaqueState( bool opaque ) = 0;
+  virtual void SetOpaqueState(bool opaque) = 0;
 
   /**
    * @copydoc Dali::Window::SetScreenOffMode()
    */
-  virtual bool SetScreenOffMode(Dali::Window::ScreenOffMode::Type screenOffMode) = 0;
+  virtual Dali::WindowOperationResult SetScreenOffMode(WindowScreenOffMode screenOffMode) = 0;
 
   /**
    * @copydoc Dali::Window::GetScreenOffMode()
    */
-  virtual Dali::Window::ScreenOffMode::Type GetScreenOffMode() const = 0;
+  virtual WindowScreenOffMode GetScreenOffMode() const = 0;
 
   /**
    * @copydoc Dali::Window::SetBrightness()
    */
-  virtual bool SetBrightness( int brightness ) = 0;
+  virtual Dali::WindowOperationResult SetBrightness(int brightness) = 0;
 
   /**
    * @copydoc Dali::Window::GetBrightness()
@@ -287,54 +328,91 @@ public:
   /**
    * @copydoc Dali::KeyGrab::GrabKey()
    */
-  virtual bool GrabKey( Dali::KEY key, KeyGrab::KeyGrabMode grabMode ) = 0;
+  virtual bool GrabKey(Dali::KEY key, KeyGrab::KeyGrabMode grabMode) = 0;
 
   /**
    * @copydoc Dali::KeyGrab::UngrabKey()
    */
-  virtual bool UngrabKey( Dali::KEY key ) = 0;
+  virtual bool UngrabKey(Dali::KEY key) = 0;
 
   /**
    * @copydoc Dali::KeyGrab::GrabKeyList()
    */
-  virtual bool GrabKeyList( const Dali::Vector< Dali::KEY >& key, const Dali::Vector< KeyGrab::KeyGrabMode >& grabMode, Dali::Vector< bool >& result ) = 0;
+  virtual bool GrabKeyList(const Dali::Vector<Dali::KEY>& key, const Dali::Vector<KeyGrab::KeyGrabMode>& grabMode, Dali::Vector<bool>& result) = 0;
 
   /**
    * @copydoc Dali::KeyGrab::UngrabKeyList()
    */
-  virtual bool UngrabKeyList( const Dali::Vector< Dali::KEY >& key, Dali::Vector< bool >& result ) = 0;
+  virtual bool UngrabKeyList(const Dali::Vector<Dali::KEY>& key, Dali::Vector<bool>& result) = 0;
 
   /**
    * @brief Get DPI
    * @param[out] dpiHorizontal set to the horizontal dpi
    * @param[out] dpiVertical set to the vertical dpi
    */
-  virtual void GetDpi( unsigned int& dpiHorizontal, unsigned int& dpiVertical ) = 0;
+  virtual void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) = 0;
 
   /**
-   * @brief Get the screen rotation angle of the window
+   * @brief Return the angle of the window's rotation.
+   * @return The window orientation
+   */
+  virtual int GetWindowRotationAngle() const = 0;
+
+  /**
+   * @brief Get the angle of screen rotation for the window
+   * @return The screen orientation
    */
   virtual int GetScreenRotationAngle() = 0;
 
   /**
-   * @brief Set the rotation angle of the window
+   * @brief Set the screen rotation angle of the window
    */
-  virtual void SetWindowRotationAngle( int degree ) = 0;
+  virtual void SetWindowRotationAngle(int degree) = 0;
 
   /**
    * @brief Inform the window rotation is completed
    */
-  virtual void WindowRotationCompleted( int degree, int width, int height ) = 0;
+  virtual void WindowRotationCompleted(int degree, int width, int height) = 0;
+
+  /**
+   * @brief starts the window is moved by display server
+   */
+  virtual void RequestMoveToServer() = 0;
+
+  /**
+   * @brief starts the window is resized by display server
+   *
+   * @param[in] direction It is direction of the started edge/side.
+   */
+  virtual void RequestResizeToServer(WindowResizeDirection direction) = 0;
+
+  /**
+   * @brief Enables the floating mode of window.
+   *
+   * The floating mode is to support making partial size window easliy.
+   * It is useful to make popup style window
+   * and this window is always upper than the other normal window.
+   *
+   * A special display server(as a Tizen display server) supports this mode.
+   *
+   * @param[in] enable Enable floating mode or not.
+   */
+  virtual void EnableFloatingMode(bool enable) = 0;
+
+  /**
+   * @brief Gets whether floating mode is enabled or not.
+   */
+  virtual bool IsFloatingModeEnabled() const = 0;
 
   /**
    * @copydoc Dali::Window::SetTransparency()
    */
-  virtual void SetTransparency( bool transparent ) = 0;
+  virtual void SetTransparency(bool transparent) = 0;
 
   /**
    * @copydoc Dali::Window::SetParent()
    */
-  virtual void SetParent( WindowBase* parentWinBase ) = 0;
+  virtual void SetParent(WindowBase* parentWinBase, bool belowParent) = 0;
 
   /**
    * @brief Create a sync fence that can tell the frame is rendered by the graphics driver.
@@ -348,12 +426,41 @@ public:
    */
   virtual int CreateFramePresentedSyncFence() = 0;
 
+  /**
+   * @copydoc Dali::Window::SetPositionSizeWithAngle()
+   */
+  virtual void SetPositionSizeWithAngle(PositionSize positionSize, int angle) = 0;
+
+  /**
+   * @brief Initialize for Ime window.
+   * It should be called when the window is only used for Ime keyboard window.
+   */
+  virtual void InitializeIme() = 0;
+
+  /**
+   * @brief Send the signal to display server for Ime Window is ready to render.
+   * It is used for compositing by display server.
+   */
+  virtual void ImeWindowReadyToRender() = 0;
+
+  /**
+   * @brief Includes input region.
+   * @param[in] inputRegion The added region to accept input events.
+   */
+  virtual void IncludeInputRegion(const Rect<int>& inputRegion) = 0;
+
+  /**
+   * @brief Excludes input region.
+   * @param[in] inputRegion The subtracted region to except input events.
+   */
+  virtual void ExcludeInputRegion(const Rect<int>& inputRegion) = 0;
+
   // Signals
 
   /**
    * @brief This signal is emitted when the window becomes iconified or deiconified.
    */
-   IconifySignalType& IconifyChangedSignal();
+  IconifySignalType& IconifyChangedSignal();
 
   /**
    * @brief This signal is emitted when the window focus is changed.
@@ -411,11 +518,6 @@ public:
   StyleSignalType& StyleChangedSignal();
 
   /**
-   * @brief This signal is emitted when an accessibility event is received.
-   */
-  AccessibilitySignalType& AccessibilitySignal();
-
-  /**
    * @brief This signal is emitted when window's transition animation is started or ended.
    */
   TransitionEffectEventSignalType& TransitionEffectEventSignal();
@@ -425,8 +527,22 @@ public:
    */
   KeyboardRepeatSettingsChangedSignalType& KeyboardRepeatSettingsChangedSignal();
 
-protected:
+  /**
+   * @brief This signal is emitted when the window redraw is requested.
+   */
+  WindowRedrawRequestSignalType& WindowRedrawRequestSignal();
+
+  /**
+   * @brief This signal is emitted when the window is resized or moved by display server.
+   */
+  UpdatePositionSizeType& UpdatePositionSizeSignal();
 
+  /**
+   * @brief This signal is emitted when the window is received the auxiliary message from display server.
+   */
+  AuxiliaryMessageSignalType& AuxiliaryMessageSignal();
+
+protected:
   // Undefined
   WindowBase(const WindowBase&) = delete;
 
@@ -434,7 +550,6 @@ protected:
   WindowBase& operator=(const WindowBase& rhs) = delete;
 
 protected:
-
   IconifySignalType                       mIconifyChangedSignal;
   FocusSignalType                         mFocusChangedSignal;
   OutputSignalType                        mOutputTransformedSignal;
@@ -447,14 +562,16 @@ protected:
   SelectionSignalType                     mSelectionDataSendSignal;
   SelectionSignalType                     mSelectionDataReceivedSignal;
   StyleSignalType                         mStyleChangedSignal;
-  AccessibilitySignalType                 mAccessibilitySignal;
   TransitionEffectEventSignalType         mTransitionEffectEventSignal;
   KeyboardRepeatSettingsChangedSignalType mKeyboardRepeatSettingsChangedSignal;
+  WindowRedrawRequestSignalType           mWindowRedrawRequestSignal;
+  UpdatePositionSizeType                  mUpdatePositionSizeSignal;
+  AuxiliaryMessageSignalType              mAuxiliaryMessageSignal;
 };
 
 } // namespace Adaptor
 
-} // namespace internal
+} // namespace Internal
 
 } // namespace Dali