ecore_evas: added window manager rotation to manage the rotation of windows by the WM.

Summary: The window manager rotation allows the WM to controls the rotation of application windows. It is designed to support synchronized rotation for the multiple application windows at same time.

Reviewers: raster, seoz, cedric, Hermet

Reviewed By: raster

CC: cedric

Differential Revision: https://phab.enlightenment.org/D529

5 files changed, 271 insertions, 2 deletions

diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 3625316549..2ef08e50f3 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -684,6 +684,87 @@ EAPI void        ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const
  */
 EAPI Eina_Bool   ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsigned int *count);
 /**
+ * @brief Query if the underlying windowing system supports the window manager rotation.
+ *
+ * @param ee The Ecore_Evas
+ * @return @c EINA_TRUE if the window manager rotation is supported, @c EINA_FALSE otherwise.
+ *
+ * @warning Support for this depends on the underlying windowing system.
+ * @since 1.9.0
+ */
+EAPI Eina_Bool   ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee);
+/**
+ * @brief Set the preferred rotation hint.
+ *
+ * @param ee The Ecore_Evas to set
+ * @param rotation Value to set the preferred rotation hint
+ *
+ * @warning Support for this depends on the underlying windowing system.
+ * @since 1.9.0
+ */
+EAPI void        ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, int rotation);
+/**
+ * @brief Get the preferred rotation hint.
+ *
+ * @param ee The Ecore_Evas to get the preferred rotation hint from.
+ * @return The preferred rotation hint, -1 on failure.
+ *
+ * @warning Support for this depends on the underlying windowing system.
+ * @since 1.9.0
+ */
+EAPI int         ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas *ee);
+/**
+ * @brief Set the array of available window rotations.
+ *
+ * @param ee The Ecore_Evas to set
+ * @param rotations The integer array of available window rotations
+ * @param count The number of members in rotations
+ *
+ * @warning Support for this depends on the underlying windowing system.
+ * @since 1.9.0
+ */
+EAPI void        ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, const int *rotations, unsigned int count);
+/**
+ * @brief Get the array of available window rotations.
+ *
+ * @param ee The Ecore_Evas to get available window rotations from.
+ * @param rotations Where to return the integer array of available window rotations
+ * @param count Where to return the number of members in rotations
+ * @return EINA_TRUE if available window rotations exist, EINA_FALSE otherwise
+ *
+ * @warning Support for this depends on the underlying windowing system.
+ * @since 1.9.0
+ */
+EAPI Eina_Bool   ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas *ee, int **rotations, unsigned int *count);
+/**
+ * @brief Set manual rotation done mode of Ecore_Evas's window
+ *
+ * @param ee The Ecore_Evas
+ * @param set If true, the window manager will not rotate the Ecore_Evas's window until
+ * the rotation done event is received by ecore_evas_wm_rotation_manual_rotation_done.
+ * If false, the manual rotation mode is disabled.
+ *
+ * @since 1.9.0
+ */
+EAPI void        ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, Eina_Bool set);
+/**
+ * @brief Get manual rotation done mode of Ecore_Evas's window
+ *
+ * @param ee The Ecore_Evas
+ * @return If true, the manual rotation done mode is enabled
+ *
+ * @since 1.9.0
+ */
+EAPI Eina_Bool   ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Evas *ee);
+/**
+ * @brief Set rotation finish manually
+ *
+ * @param ee The Ecore_Evas
+ *
+ * @since 1.9.0
+ */
+EAPI void        ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee);
+/**
  * @brief Send message to parent ecore
  *
  * @param ee The Ecore_Evas to set
diff --git a/src/lib/ecore_evas/ecore_evas.c b/src/lib/ecore_evas/ecore_evas.c
index 37be5f8a76..43e4b8691f 100644
--- a/src/lib/ecore_evas/ecore_evas.c
+++ b/src/lib/ecore_evas/ecore_evas.c
@@ -1946,6 +1946,153 @@ ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsig
      return EINA_FALSE;
 }
 
+EAPI Eina_Bool
+ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee)
+{
+   if (!ECORE_MAGIC_CHECK(ee, ECORE_MAGIC_EVAS))
+     {
+        ECORE_MAGIC_FAIL(ee, ECORE_MAGIC_EVAS,
+                         "ecore_evas_wm_rotation_supported_get");
+        return EINA_FALSE;
+     }
+   return ee->prop.wm_rot.supported;
+}
+
+EAPI void
+ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, int rotation)
+{
+   if (!ECORE_MAGIC_CHECK(ee, ECORE_MAGIC_EVAS))
+     {
+        ECORE_MAGIC_FAIL(ee, ECORE_MAGIC_EVAS,
+                         "ecore_evas_wm_rotation_preferred_rotation_set");
+        return;
+     }
+   if (rotation != -1)
+     {
+        if (ee->prop.wm_rot.available_rots)
+          {
+             Eina_Bool found = EINA_FALSE;
+             unsigned int i;
+             for (i = 0; i < ee->prop.wm_rot.count; i++)
+               {
+                  if (ee->prop.wm_rot.available_rots[i] == rotation)
+                    {
+                       found = EINA_TRUE;
+                       break;
+                    }
+               }
+             if (!found) return;
+          }
+     }
+   IFC(ee, fn_wm_rot_preferred_rotation_set) (ee, rotation);
+   IFE;
+}
+
+EAPI int
+ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas *ee)
+{
+   if (!ECORE_MAGIC_CHECK(ee, ECORE_MAGIC_EVAS))
+     {
+        ECORE_MAGIC_FAIL(ee, ECORE_MAGIC_EVAS,
+                         "ecore_evas_wm_rotation_preferred_rotation_get");
+        return -1;
+     }
+   return ee->prop.wm_rot.preferred_rot;
+}
+
+EAPI void
+ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, const int *rotations, unsigned int count)
+{
+   if (!ECORE_MAGIC_CHECK(ee, ECORE_MAGIC_EVAS))
+     {
+        ECORE_MAGIC_FAIL(ee, ECORE_MAGIC_EVAS,
+                         "ecore_evas_wm_rotation_available_rotations_set");
+        return;
+     }
+   IFC(ee, fn_wm_rot_available_rotations_set) (ee, rotations, count);
+   IFE;
+}
+
+EAPI Eina_Bool
+ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas *ee, int **rotations, unsigned int *count)
+{
+   if (!ECORE_MAGIC_CHECK(ee, ECORE_MAGIC_EVAS))
+     {
+        ECORE_MAGIC_FAIL(ee, ECORE_MAGIC_EVAS,
+                         "ecore_evas_wm_rotation_available_rotations_get");
+        return EINA_FALSE;
+     }
+   if ((!rotations) || (!count))
+     return EINA_FALSE;
+
+   if ((!ee->prop.wm_rot.available_rots) || (ee->prop.wm_rot.count == 0))
+     return EINA_FALSE;
+
+   *rotations = calloc(ee->prop.wm_rot.count, sizeof(int));
+   if (!*rotations) return EINA_FALSE;
+
+   memcpy(*rotations, ee->prop.wm_rot.available_rots, sizeof(int) * ee->prop.wm_rot.count);
+   *count = ee->prop.wm_rot.count;
+
+   return EINA_TRUE;
+}
+
+EAPI void
+ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, Eina_Bool set)
+{
+   if (!ECORE_MAGIC_CHECK(ee, ECORE_MAGIC_EVAS))
+     {
+        ECORE_MAGIC_FAIL(ee, ECORE_MAGIC_EVAS,
+                         "ecore_evas_wm_rotation_manual_rotation_done_set");
+        return;
+     }
+
+   if (!ee->prop.wm_rot.app_set)
+     {
+        return;
+     }
+
+   IFC(ee, fn_wm_rot_manual_rotation_done_set) (ee, set);
+   IFE;
+}
+
+EAPI Eina_Bool
+ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Evas *ee)
+{
+   if (!ECORE_MAGIC_CHECK(ee, ECORE_MAGIC_EVAS))
+     {
+        ECORE_MAGIC_FAIL(ee, ECORE_MAGIC_EVAS,
+                         "ecore_evas_wm_rotation_manual_rotation_done_get");
+        return EINA_FALSE;
+     }
+
+   if (!ee->prop.wm_rot.app_set)
+     {
+        return EINA_FALSE;
+     }
+
+   return ee->prop.wm_rot.manual_mode.set;
+}
+
+EAPI void
+ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee)
+{
+   if (!ECORE_MAGIC_CHECK(ee, ECORE_MAGIC_EVAS))
+     {
+        ECORE_MAGIC_FAIL(ee, ECORE_MAGIC_EVAS,
+                         "ecore_evas_wm_rotation_manual_rotation_done");
+        return;
+     }
+
+   if (!ee->prop.wm_rot.app_set)
+     {
+        return;
+     }
+
+   IFC(ee, fn_wm_rot_manual_rotation_done) (ee);
+   IFE;
+}
+
 EAPI void
 ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on)
 {
@@ -2703,6 +2850,11 @@ _ecore_evas_free(Ecore_Evas *ee)
    ee->prop.profile.name = NULL;
    _ecore_evas_window_available_profiles_free(ee);
    ee->prop.profile.available_list = NULL;
+   if (ee->prop.wm_rot.available_rots) free(ee->prop.wm_rot.available_rots);
+   ee->prop.wm_rot.available_rots = NULL;
+   if (ee->prop.wm_rot.manual_mode.timer)
+     ecore_timer_del(ee->prop.wm_rot.manual_mode.timer);
+   ee->prop.wm_rot.manual_mode.timer = NULL;
    if (ee->prop.cursor.object) evas_object_del(ee->prop.cursor.object);
    ee->prop.cursor.object = NULL;
    if (ee->evas) evas_free(ee->evas);
diff --git a/src/lib/ecore_evas/ecore_evas_buffer.c b/src/lib/ecore_evas/ecore_evas_buffer.c
index 0b9e124ac5..5c4a739ba7 100644
--- a/src/lib/ecore_evas/ecore_evas_buffer.c
+++ b/src/lib/ecore_evas/ecore_evas_buffer.c
@@ -581,7 +581,15 @@ static Ecore_Evas_Engine_Func _ecore_buffer_engine_func =
      NULL, // screen_geometry_get
      NULL,  // screen_dpi_get
      _ecore_evas_buffer_msg_parent_send,
-     _ecore_evas_buffer_msg_send
+     _ecore_evas_buffer_msg_send,
+
+     NULL, // pointer_xy_get
+     NULL, // pointer_warp
+
+     NULL, // wm_rot_preferred_rotation_set
+     NULL, // wm_rot_available_rotations_set
+     NULL, // wm_rot_manual_rotation_done_set
+     NULL  // wm_rot_manual_rotation_done
 };
 
 static void *
diff --git a/src/lib/ecore_evas/ecore_evas_ews.c b/src/lib/ecore_evas/ecore_evas_ews.c
index 9aa1dba319..84c9a0f495 100644
--- a/src/lib/ecore_evas/ecore_evas_ews.c
+++ b/src/lib/ecore_evas/ecore_evas_ews.c
@@ -698,7 +698,15 @@ static const Ecore_Evas_Engine_Func _ecore_ews_engine_func =
      _ecore_evas_ews_screen_geometry_get,
      NULL,  // screen_dpi_get
      NULL,
-     NULL   // msg_send
+     NULL,  // msg_send
+
+     NULL,  // pointer_xy_get
+     NULL,  // pointer_warp
+
+     NULL,  // wm_rot_preferred_rotation_set
+     NULL,  // wm_rot_available_rotations_set
+     NULL, // wm_rot_manual_rotation_done_set
+     NULL  // wm_rot_manual_rotation_done
 };
 
 void
diff --git a/src/lib/ecore_evas/ecore_evas_private.h b/src/lib/ecore_evas/ecore_evas_private.h
index ca7a801a13..cc514d5d8e 100644
--- a/src/lib/ecore_evas/ecore_evas_private.h
+++ b/src/lib/ecore_evas/ecore_evas_private.h
@@ -115,6 +115,11 @@ struct _Ecore_Evas_Engine_Func
    /* 1.8 abstractions */
    void (*fn_pointer_xy_get) (const Ecore_Evas *ee, Evas_Coord *x, Evas_Coord *y);
    Eina_Bool (*fn_pointer_warp) (const Ecore_Evas *ee, Evas_Coord x, Evas_Coord y);
+
+   void (*fn_wm_rot_preferred_rotation_set) (Ecore_Evas *ee, int rot);
+   void (*fn_wm_rot_available_rotations_set) (Ecore_Evas *ee, const int *rots, unsigned int count);
+   void (*fn_wm_rot_manual_rotation_done_set) (Ecore_Evas *ee, Eina_Bool set);
+   void (*fn_wm_rot_manual_rotation_done) (Ecore_Evas *ee);
 };
 
 struct _Ecore_Evas_Interface
@@ -186,6 +191,21 @@ struct _Ecore_Evas
             int       x, y;
          } hot;
       } cursor;
+      struct {
+         Eina_Bool       supported;      // indicate that the underlying window system supports window manager rotation protocol
+         Eina_Bool       app_set;        // indicate that the ee supports window manager rotation protocol
+         Eina_Bool       win_resize;     // indicate that the ee will be resized by the WM
+         int             angle;          // rotation value which is decided by the WM 
+         int             w, h;           // window size to rotate
+         int             preferred_rot;  // preferred rotation hint
+         int            *available_rots; // array of avaialable rotation values
+         unsigned int    count;          // number of elements of available_rots
+         struct {
+            Eina_Bool    set;
+            Eina_Bool    wait_for_done;
+            Ecore_Timer *timer;
+         } manual_mode;
+      } wm_rot;
       int             layer;
       Ecore_Window    window;
       unsigned char   avoid_damage;