Improve auto-suggestions in Grid and Text Editors (#2589)

Author: HelioGuilherme66

CHANGELOG.adoc

@@ -6,7 +6,12 @@ All notable changes to this project will be documented in this file.
 The format is based on http://keepachangelog.com/en/1.0.0/[Keep a Changelog]
 and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioning].
 
-// == https://github.com/robotframework/RIDE[Unreleased]
+== https://github.com/robotframework/RIDE[Unreleased]
+
+=== Changed
+
+- Improve auto-suggestions of keywords in Grid Editor by allowing to close suggestions list with keys ARROW_LEFT or ARROW_RIGHT
+- Improve Text Editor auto-suggestions by using: selected text, text at left or at right of cursor
 
 == https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.0.5.rst[2.0.5] - 2023-05-08
 

src/robotide/editor/contentassist.py

@@ -90,6 +90,16 @@ def OnKeyDown(self, event):
         # Ctrl-Space handling needed for dialogs # DEBUG add Ctrl-m
         if (control_down or alt_down) and key_code in [wx.WXK_SPACE, ord('m')]:
             self.show_content_assist()
+        elif key_code in (wx.WXK_RIGHT, wx.WXK_LEFT):  # To skip list and continue editing
+            if self._popup.is_shown():
+                value = self.GetValue()
+                if value:
+                    self.SetValue(value)
+                    self.SetInsertionPoint(len(value))
+                    self._popup.hide()
+                    self.reset()
+            else:
+                event.Skip()
         elif key_code == wx.WXK_RETURN and self._popup.is_shown():
             self.OnFocusLost(event)
         elif key_code == wx.WXK_TAB:
@@ -493,8 +503,8 @@ def __init__(self, parent, suggestion_source):
         self._details_popup = HtmlPopupWindow(parent, _PREFERRED_POPUP_SIZE)
         self._selection = -1
         self._list: ContentAssistList = ContentAssistList(self._main_popup,
-                                                          self.OnListItemSelected,
-                                                          self.OnListItemActivated)
+                                                          self.on_list_item_selected,
+                                                          self.on_list_item_activated)
         self._suggestions = Suggestions(suggestion_source)
         self._choices = None
 
@@ -586,11 +596,11 @@ def hide(self):
         self._main_popup.Show(False)
         self._details_popup.Show(False)
 
-    def OnListItemActivated(self, event):
+    def on_list_item_activated(self, event):
         _ = event
         self._parent.fill_suggestion()
 
-    def OnListItemSelected(self, event):
+    def on_list_item_selected(self, event):
         self._selection = event.GetIndex()
         item = self._suggestions.get_item(event.GetText())
         if item.details:

src/robotide/editor/texteditor.py

@@ -501,12 +501,12 @@ def show_help_dialog(event):
         HtmlDialog("Getting syntax colorization", content).Show()
 
     def store_position(self, force=False):
-        _ = force
         if self.source_editor and self.datafile_controller:
             cur_pos = self.source_editor.GetCurrentPos()
             if cur_pos > 0:  # Cheating because it always goes to zero
                 self._position = cur_pos
-                self.source_editor.GotoPos(self._position)
+                if force:
+                    self.source_editor.GotoPos(self._position)
 
     def set_editor_caret_position(self):
         if not self.is_focused():  # DEBUG was typing text when at Grid Editor
@@ -587,9 +587,9 @@ def _show_search_results(self, position, txt):
 
     def OnContentAssist(self, event):
         _ = event
-        self._showing_list = False
-        # if not self.is_focused():
-        #    return
+        if self._showing_list:
+            self._showing_list = False  # Avoid double calls
+            return
         self.store_position()
         selected = self.source_editor.get_selected_or_near_text()
         sugs = [s.name for s in self._suggestions.get_suggestions(
@@ -599,6 +599,8 @@ def OnContentAssist(self, event):
             self.source_editor.AutoCompSetSeparator(ord(';'))
             self.source_editor.AutoCompShow(0, ";".join(sugs))
             self._showing_list = True
+        else:
+            self.source_editor.SetInsertionPoint(self._position)  # We should know if list was canceled or value change
 
     def open(self, data):
         self.reset()
@@ -1500,25 +1502,29 @@ def calc_margin_width(self):
     def get_selected_or_near_text(self):
         # First get selected text
         selected = self.GetSelectedText()
-        self.SetInsertionPoint(self.GetInsertionPoint() - len(selected))
         if selected:
+            self.SetInsertionPoint(self.GetSelectionStart())
             return selected
         # Next get text on the left
-        self.SetSelectionEnd(self.GetInsertionPoint())
+        cur_pos = self.GetInsertionPoint()
         self.WordLeftEndExtend()
         selected = self.GetSelectedText()
-        select = selected.strip()
-        self.SetInsertionPoint(self.GetInsertionPoint() + len(selected)
-                               - len(select))
+        select = selected.lstrip()
         if select and len(select) > 0:
+            start_pos = cur_pos - len(select)
+            self.SetInsertionPoint(start_pos)
+            self.SetSelectionStart(start_pos)
+            self.SetSelectionEnd(cur_pos - len(select))
             return select
         # Finally get text on the right
-        self.SetSelectionStart(self.GetInsertionPoint())
+        cur_pos = self.GetInsertionPoint()
+        self.SetSelectionStart(cur_pos)
         self.WordRightEndExtend()
         selected = self.GetSelectedText()
         select = selected.strip()
-        self.SetInsertionPoint(self.GetInsertionPoint() - len(select))
         if select and len(select) > 0:
+            cur_pos = self.GetInsertionPoint()
+            self.SetInsertionPoint(cur_pos - len(select))
             return select
 
 

src/robotide/version.py

@@ -14,4 +14,4 @@
 #  limitations under the License.
 #
 # Automatically generated by `tasks.py`.
-VERSION = 'v2.0.5'
+VERSION = 'v2.0.6dev1'