Efl.Text.Cursor

Summary:
Implementation of new cursor text object.

This Patch Contains :
1- Remove Efl.Text.Cursor & Efl.Text_Markup_Interactive interfaces and replace them with one Class Efl.Text.Cursor
   => there are some modifications on cursor methods

2- Update all related classes to use Efl.Text.Cursor object instead of the old interfaces

3- If class uses Efl.Text_Cursor_Cursor (handle), mainly annotation it will stay as it is until we update other annotations into attribute_factory

4- Add main cursor property into efl.text.interactive

5- Add cursor_new method in efl.ui.text  (I think we may move it into efl.text.interactive interface)

There still some parts that need discussion: especially cursor movement functionality, I prefer to move function with Enum, instead of special function for each movement.

```
enum @beta Efl.Text.Cursor_Move_Type
{
   [[Text cursor movement types]]
   char_next,       [[Advances to the next character]]
   char_prev,       [[Advances to the previous character]]
   cluster_next,    [[Advances to the next grapheme cluster]]
   cluster_prev,    [[Advances to the previous grapheme cluster]]
   paragraph_start, [[Advances to the first character in this paragraph]]
   paragraph_end,   [[Advances to the last character in this paragraph]]
   word_start,      [[Advance to current word start]]
   word_end,        [[Advance to current word end]]
   line_start,      [[Advance to current line first character]]
   line_end,        [[Advance to current line last character]]
   paragraph_first, [[Advance to current paragraph first character]]
   paragraph_last,  [[Advance to current paragraph last character]]
   paragraph_next,  [[Advances to the start of the next text node]]
   paragraph_prev   [[Advances to the end of the previous text node]]
}
move {
         [[Move the cursor]]
         params {
            @in type: Efl.Text.Cursor_Move_Type; [[The type of movement]]
         }
         return: bool; [[True if actually moved]]
      }
```

or old way:
```
char_next {
         [[Advances to the next character]]
         // FIXME: Make the number of characters we moved by? Useful for all the other functions
         return: bool; [[True if actually moved]]
      }
      char_prev {
         [[Advances to the previous character]]
         return: bool; [[True if actually moved]]
      }

      char_delete {
         [[Deletes a single character from position pointed by given cursor.]]
      }

      cluster_next {
         [[Advances to the next grapheme cluster]]
         return: bool; [[True if actually moved]]
      }
      cluster_prev {
         [[Advances to the previous grapheme cluster]]
         return: bool; [[True if actually moved]]
      }

      // FIXME: paragraph_end is inconsistent with word_end. The one goes to the last character and the other after the last character.
      paragraph_start {
         [[Advances to the first character in this paragraph]]
         return: bool; [[True if actually moved]]
      }
      paragraph_end {
         [[Advances to the last character in this paragraph]]
         return: bool; [[True if actually moved]]
      }
      word_start {
         [[Advance to current word start]]
         return: bool; [[True if actually moved]]
      }
      word_end {
         [[Advance to current word end]]
         return: bool; [[True if actually moved]]
      }
      line_start {
         [[Advance to current line first character]]
         return: bool; [[True if actually moved]]
      }
      line_end {
          [[Advance to current line last character]]
         return: bool; [[True if actually moved]]
      }
      paragraph_first {
         [[Advance to current paragraph first character]]
         return: bool; [[True if actually moved]]
      }
      paragraph_last {
         [[Advance to current paragraph last character]]
         return: bool; [[True if actually moved]]
      }
      paragraph_next {
         [[Advances to the start of the next text node]]
         return: bool; [[True if actually moved]]
      }
      paragraph_prev {
         [[Advances to the end of the previous text node]]
         return: bool; [[True if actually moved]]
      }
```

Reviewers: woohyun, tasn, segfaultxavi

Reviewed By: woohyun

Subscribers: a.srour, bu5hm4n, segfaultxavi, cedric, #reviewers, #committers

Tags: #efl

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

1 files changed, 0 insertions, 246 deletions

diff --git a/src/lib/efl/interfaces/efl_text_cursor.eo b/src/lib/efl/interfaces/efl_text_cursor.eo
deleted file mode 100644
index cef645a173..0000000000
--- a/src/lib/efl/interfaces/efl_text_cursor.eo
+++ /dev/null
@@ -1,246 +0,0 @@
-import eina_types;
-import efl_text_types;
-
-enum @beta Efl.Text_Cursor_Get_Type {
-   [[All available cursor states]]
-   default = 0,     [[Main cursor state (alias to "main")]]
-   main,            [[Main cursor state]]
-   selection_begin, [[Selection begin cursor state]]
-   selection_end,   [[Selection end cursor state]]
-   preedit_start,   [[Pre-edit start cursor state]]
-   preedit_end,     [[Pre-edit end cursor state]]
-   user,            [[User cursor state]]
-   user_extra       [[User extra cursor state]]
-}
-
-enum @beta Efl.Text_Cursor_Type
-{
-   [[Text cursor types]]
-   before, [[Cursor type before]]
-   under [[Cursor type under]]
-}
-
-interface @beta Efl.Text_Cursor {
-   [[Cursor API
-   ]]
-   methods {
-      // Cursor
-      @property text_cursor {
-         [[The object's main cursor.
-         ]]
-         get {
-            return: ptr(Efl.Text_Cursor_Cursor); [[Text cursor object]]
-         }
-         keys {
-            get_type: Efl.Text_Cursor_Get_Type; [[Cursor type]]
-         }
-      }
-      @property cursor_position {
-         [[Cursor position]]
-         set {  }
-         get {  }
-         values {
-            position: int; [[Cursor position]]
-         }
-         keys {
-            cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      @property cursor_content {
-         [[The content of the cursor (the character under the cursor)]]
-         get {
-         }
-         values {
-            content: Eina.Unicode; [[The unicode codepoint of the character]]
-         }
-         keys {
-            cur: ptr(const(Efl.Text_Cursor_Cursor)); [[Cursor object]]
-         }
-      }
-      @property cursor_geometry {
-         [[Returns the geometry of two cursors ("split cursor"), if logical cursor is
-           between LTR/RTL text, also considering paragraph direction.
-           Upper cursor is shown for the text of the same direction as paragraph,
-           lower cursor - for opposite.
-
-           Split cursor geometry is valid only  in '|' cursor mode.
-           In this case $true is returned and $cx2, $cy2, $cw2, $ch2 are set.
-         ]]
-         get {
-            return: bool; [[ $true if split cursor, $false otherwise.]]
-         }
-         keys {
-            cur: ptr(const(Efl.Text_Cursor_Cursor)); [[Cursor object]]
-            ctype: Efl.Text_Cursor_Type; [[The type of the cursor.]]
-         }
-         values {
-            cx: int; [[The x of the cursor (or upper cursor)]]
-            cy: int; [[The y of the cursor (or upper cursor)]]
-            cw: int; [[The width of the cursor (or upper cursor)]]
-            ch: int; [[The height of the cursor (or upper cursor)]]
-            cx2: int; [[The x of the lower cursor]]
-            cy2: int; [[The y of the lower cursor]]
-            cw2: int; [[The width of the lower cursor]]
-            ch2: int; [[The height of the lower cursor]]
-         }
-      }
-      cursor_new {
-         [[Create new cursor]]
-         return: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-      }
-      cursor_free {
-         [[Free existing cursor]]
-         params {
-            cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_equal {
-         [[Check if two cursors are equal]]
-         params {
-            @in cur1: ptr(const(Efl.Text_Cursor_Cursor)); [[Cursor 1 object]]
-            @in cur2: ptr(const(Efl.Text_Cursor_Cursor)); [[Cursor 2 object]]
-         }
-         return: bool; [[$true if cursors are equal, $false otherwise]]
-      }
-      cursor_compare {
-         [[Compare two cursors]]
-         params {
-            @in cur1: ptr(const(Efl.Text_Cursor_Cursor)); [[Cursor 1 object]]
-            @in cur2: ptr(const(Efl.Text_Cursor_Cursor)); [[Cursor 2 object]]
-         }
-         return: int; [[Difference between cursors]]
-      }
-      cursor_copy {
-         [[Copy existing cursor]]
-         params {
-            /* @out */ dst: ptr(Efl.Text_Cursor_Cursor); [[Destination cursor]]
-            @in src: ptr(const(Efl.Text_Cursor_Cursor)); [[Source cursor]]
-         }
-      }
-      cursor_char_next {
-         [[Advances to the next character]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_char_prev {
-         [[Advances to the previous character]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_cluster_next {
-         [[Advances to the next grapheme cluster]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_cluster_prev {
-         [[Advances to the previous grapheme cluster]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_paragraph_char_first {
-         [[Advances to the first character in this paragraph]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_paragraph_char_last {
-         [[Advances to the last character in this paragraph]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_word_start {
-         [[Advance to current word start]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_word_end {
-         [[Advance to current word end]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_line_char_first {
-         [[Advance to current line first character]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_line_char_last {
-          [[Advance to current line last character]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_paragraph_first {
-         [[Advance to current paragraph first character]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_paragraph_last {
-         [[Advance to current paragraph last character]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_paragraph_next {
-         [[Advances to the start of the next text node]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_paragraph_prev {
-         [[Advances to the end of the previous text node]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-      cursor_line_jump_by {
-         [[Jump the cursor by the given number of lines]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-            by: int; [[Number of lines]]
-         }
-      }
-      cursor_coord_set {
-         [[Set cursor coordinates]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-            @in x: int; [[X coord to set by.]]
-            @in y: int; [[Y coord to set by.]]
-         }
-      }
-      cursor_cluster_coord_set {
-         [[Set cursor coordinates according to grapheme clusters.
-           It does not allow to put a cursor to the middle of a grapheme cluster.
-         ]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-            @in x: int; [[X coord to set by.]]
-            @in y: int; [[Y coord to set by.]]
-         }
-      }
-      cursor_text_insert {
-         [[Adds text to the current cursor position and set the cursor to
-           *after* the start of the text just added.
-         ]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-            @in text: string; [[Text to append (UTF-8 format).]]
-         }
-         return: int; [[Length of the appended text.]]
-      }
-      cursor_char_delete {
-         [[Deletes a single character from position pointed by given cursor.]]
-         params {
-            /* @inout */ cur: ptr(Efl.Text_Cursor_Cursor); [[Cursor object]]
-         }
-      }
-   }
-}