Improve text editor (#2619)

* Add bracket match validation. WIP better content assist Text Editor

* Final improvements in autocomplete in Text Editor

Author: HelioGuilherme66

CHANGELOG.adoc

@@ -10,6 +10,7 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 
 === Added
 
+- Added indication of matching brackets, ``()``, ``{}``, ``[]``, in Text Editor
 - Added context menu to RIDE tray icon. Options Show, Hide and Close
 - Added sincronization with Project Explorer to navigate to selected item, Test Case, Keyword, Variable, in Text Editor
   Note: This feature is working fine in Fedora 38, but not on Windows and macOS.
@@ -24,6 +25,10 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 - Fixed title of User Keyword in Grid Editor always showing ``Find Usages`` instead of the keyword name
 - Fixed renaming keywords when they were arguments of ``Run Keywords`` in Setups and Teardowns
 
+=== Changed
+
+- Improve Text Editor auto-suggestions to keep libraries prefixes.
+
 == https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.0.6.rst[2.0.6] - 2023-06-10
 
 === Added

src/robotide/application/releasenotes.py

@@ -168,15 +168,16 @@ def set_content(self, html_win, content):
 </ul>
 <p><strong>New Features and Fixes Highlights</strong></p>
 <ul class="simple">
+<li>Added indication of matching brackets, <b>()</b>, <b>"""'''{}'''f"""</b>, <b>[]</b>, in Text Editor</li>
 <li>Fixed non syncronized expanding/collapse of Settings panel in Grid Editor, on Linux</li>
-<li>Fixed not working the deletion of cells commented with ``# `` in Grid Editor with ``Ctrl-Shift-D``</li> 
+<li>Fixed not working the deletion of cells commented with <b># </b> in Grid Editor with <b>Ctrl-Shift-D</b></li> 
 <li>Fixed empty line being always added to the Variables section in Text Editor</li>
 <li>Improved project file system changes and reloading</li>
 <li>Added context menu to RIDE tray icon. Options Show, Hide and Close</li>
 <li>Added sincronization with Project Explorer to navigate to selected item, Test Case, Keyword, Variable, in Text
  Editor</li>
-<li>Control commands (``FOR``, ``IF``, ``TRY``, etc) will only be colorized as valid keywords when typed in all caps in Grid Editor</li>
-<li>Newlines in Grid Editor can be made visible with the `filter newlines` set to False, by editing `settings.cfg`</li>
+<li>Control commands (<b>FOR</b>, <b>IF</b>, <b>TRY</b>, etc) will only be colorized as valid keywords when typed in all caps in Grid Editor</li>
+<li>Newlines in Grid Editor can be made visible with the <b>filter newlines</b> set to False, by editing <em>settings.cfg</em></li>
 <li>Improve auto-suggestions of keywords in Grid Editor by allowing to close suggestions list with keys ARROW_LEFT or ARROW_RIGHT</li>
 <li>Improve Text Editor auto-suggestions by using: selected text, text at left or at right of cursor</li>
 </ul>
@@ -229,6 +230,6 @@ def set_content(self, html_win, content):
 <pre class="literal-block">
 python -m robotide.postinstall -install
 </pre>
-<p>RIDE {VERSION} was released on 06/Aug/2023.</p>
+<p>RIDE {VERSION} was released on 13/Aug/2023.</p>
 </div>
 """

src/robotide/editor/texteditor.py

@@ -612,13 +612,17 @@ def on_content_assist(self, event):
             return
         self.store_position()
         selected = self.source_editor.get_selected_or_near_text()
-        sugs = [s.name for s in self._suggestions.get_suggestions(
-            selected or '')]
+        sugs = []
+        for start in selected:
+            sugs.extend(s.name for s in self._suggestions.get_suggestions(start))
+        if len(sugs) > 0:
+            sugs = [s for s in sugs if s != '']
         if sugs:
             self.source_editor.AutoCompSetDropRestOfWord(True)
             self.source_editor.AutoCompSetSeparator(ord(';'))
             self.source_editor.AutoCompShow(0, ";".join(sugs))
             self._showing_list = True
+            self.set_editor_caret_position()
         else:
             self.source_editor.SetInsertionPoint(self._position)  # We should know if list was canceled or value change
 
@@ -1479,16 +1483,75 @@ class RobotDataEditor(stc.StyledTextCtrl):
 
     def __init__(self, parent, readonly=False):
         stc.StyledTextCtrl.__init__(self, parent)
+        self.parent = parent
         self._settings = parent.source_editor_parent.app.settings
         self.readonly = readonly
         self.SetMarginType(self.margin, stc.STC_MARGIN_NUMBER)
         self.SetLexer(stc.STC_LEX_CONTAINER)
         self.SetReadOnly(True)
         self.SetUseTabs(False)
         self.SetTabWidth(parent.tab_size)
+        self.Bind(stc.EVT_STC_UPDATEUI, self.on_update_ui)
         self.Bind(stc.EVT_STC_STYLENEEDED, self.on_style)
         self.Bind(stc.EVT_STC_ZOOM, self.on_zoom)
+        # DEBUG:
+        self.Bind(wx.EVT_KEY_DOWN, self.on_key_pressed)
         self.stylizer = RobotStylizer(self, self._settings, self.readonly)
+        # register some images for use in the AutoComplete box.
+        # self.RegisterImage(1, Smiles.GetBitmap())  # DEBUG was images.
+        self.RegisterImage(1, wx.ArtProvider.GetBitmap(wx.ART_FLOPPY, size=(16, 16)))
+        self.RegisterImage(2, wx.ArtProvider.GetBitmap(wx.ART_NEW, size=(16, 16)))
+        self.RegisterImage(3, wx.ArtProvider.GetBitmap(wx.ART_COPY, size=(16, 16)))
+
+    def on_key_pressed(self, event):
+        if self.CallTipActive():
+            self.CallTipCancel()
+        key = event.GetKeyCode()
+        if key == 32 and event.ControlDown():
+            pos = self.GetCurrentPos()
+
+            # Tips
+            if event.ShiftDown():
+                self.CallTipSetBackground("yellow")
+                self.CallTipShow(pos, 'lots of of text: blah, blah, blah\n\n'
+                                 'show some suff, maybe parameters..\n\n'
+                                 'fubar(param1, param2)')
+            # Code completion
+            else:
+                """
+                kw = list(keyword.kwlist[:])
+                kw.append("zzzzzz?2")
+                kw.append("aaaaa?2")
+                kw.append("__init__?3")
+                kw.append("zzaaaaa?2")
+                kw.append("zzbaaaa?2")
+                kw.append("this_is_a_longer_value")
+                # kw.append("this_is_a_much_much_much_much_much_much_much_longer_value")
+
+                kw.sort()  # Python sorts are case-sensitive
+                self.AutoCompSetIgnoreCase(True)  # so this needs to match
+
+                # Images are specified with an appended "?type"
+                for i in range(len(kw)):
+                    if kw[i] in keyword.kwlist:
+                        kw[i] = kw[i] + "?1"
+                self.AutoCompSetDropRestOfWord(True)
+                self.AutoCompSetSeparator(ord(';'))
+                self.AutoCompShow(0, ";".join(kw))
+                """
+                selected = self.get_selected_or_near_text()
+                sugs = []
+                for start in selected:
+                    sugs.extend(s.name for s in self.parent._suggestions.get_suggestions(start))
+                if len(sugs) > 0:
+                    sugs = [s for s in sugs if s != '']
+                if sugs:
+                    self.AutoCompSetDropRestOfWord(True)
+                    self.AutoCompSetIgnoreCase(True)
+                    self.AutoCompSetSeparator(ord(';'))
+                    self.AutoCompShow(0, ";".join(sugs))
+        else:
+            event.Skip()
 
     def set_text(self, text):
         self.SetReadOnly(False)
@@ -1522,32 +1585,98 @@ def calc_margin_width(self):
         return width + self.TextWidth(style, "1")
 
     def get_selected_or_near_text(self):
+        content = set()
         # First get selected text
         selected = self.GetSelectedText()
         if selected:
-            self.SetInsertionPoint(self.GetSelectionStart())
-            return selected
+            start_pos = self.GetSelectionStart()
+            if selected.endswith('.'):  # Special cases for libraries prefix
+                self.SetInsertionPoint(start_pos + len(selected))
+            elif len(selected.split('.')) > 1:
+                parts = selected.split('.')
+                self.SetSelectionStart(start_pos + len(parts[0]) + 1)
+                self.SetSelectionEnd(start_pos + len(selected))
+                self.SetInsertionPoint(start_pos + len(parts[0]) + 1)
+            else:
+                self.SetSelectionStart(start_pos)
+                self.SetSelectionEnd(start_pos + len(selected))
+                self.SetInsertionPoint(start_pos + len(selected))
+            content.add(selected.strip())
         # Next get text on the left
-        cur_pos = self.GetInsertionPoint()
-        self.WordLeftEndExtend()
-        selected = self.GetSelectedText()
-        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
-        cur_pos = self.GetInsertionPoint()
-        self.SetSelectionStart(cur_pos)
-        self.WordRightEndExtend()
-        selected = self.GetSelectedText()
-        select = selected.strip()
-        if select and len(select) > 0:
-            cur_pos = self.GetInsertionPoint()
-            self.SetInsertionPoint(cur_pos - len(select))
-            return select
+        text = self.GetCurLine()[0]
+        start_pos = self.GetInsertionPoint()
+        line = self.GetCurrentLine()
+        line_end = self.GetLineEndPosition(line)
+        size = self.GetLineLength(line)
+        min_pos = line_end - size
+        pos_in_line = start_pos - min_pos
+        if pos_in_line > 0:
+            start_chr = end_chr = None
+            for i in range(pos_in_line, 1, -1):
+                if text[i] == ' ' and text[i-1] == ' ':
+                    start_chr = i + 1
+                    break
+            for i in range(pos_in_line, size):
+                if text[i] == ' ' and text[i+1] == ' ':
+                    end_chr = i
+                    break
+            value = None
+            if start_chr is not None:
+                if end_chr is not None:
+                    value = text[start_chr:end_chr]
+                else:
+                    value = text[start_chr:].strip()
+            elif end_chr is not None:
+                value = text[pos_in_line:end_chr]
+            if value:
+                # self.SetInsertionPoint(self.GetSelectionStart())
+                if start_chr:
+                    start_pos = min_pos + start_chr
+                else:
+                    start_pos = min_pos + pos_in_line
+                if value.endswith('.'):  # Special cases for libraries prefix
+                    self.SetInsertionPoint(start_pos + len(value))
+                elif len(value.split('.')) > 1:
+                    parts = value.split('.')
+                    self.SetSelectionStart(start_pos + len(parts[0]) + 1)
+                    self.SetSelectionEnd(start_pos + len(value))
+                    self.SetInsertionPoint(start_pos + len(parts[0]) + 1)
+                else:
+                    self.SetSelectionStart(start_pos)
+                    self.SetSelectionEnd(start_pos + len(value))
+                    self.SetInsertionPoint(start_pos)
+                content.add(value)
+        return content if content else ['']
+
+    def on_update_ui(self, evt):
+        _ = evt
+        # check for matching braces
+        brace_at_caret = -1
+        brace_opposite = -1
+        char_before = None
+        caret_pos = self.GetCurrentPos()
+
+        if caret_pos > 0:
+            char_before = self.GetCharAt(caret_pos - 1)
+
+        # check before
+        if char_before and chr(char_before) in "[]{}()":
+            brace_at_caret = caret_pos - 1
+
+        # check after
+        if brace_at_caret < 0:
+            char_after = self.GetCharAt(caret_pos)
+
+            if char_after and chr(char_after) in "[]{}()":
+                brace_at_caret = caret_pos
+
+        if brace_at_caret >= 0:
+            brace_opposite = self.BraceMatch(brace_at_caret)
+
+        if brace_at_caret != -1 and brace_opposite == -1:
+            self.BraceBadLight(brace_at_caret)
+        else:
+            self.BraceHighlight(brace_at_caret, brace_opposite)
 
 
 class FromStringIOPopulator(robotapi.populators.FromFilePopulator):

src/robotide/ui/mainframe.py

@@ -254,9 +254,15 @@ def on_close(self, event):
             PUBLISHER.unsubscribe(self._set_label, RideTreeSelection)
             RideClosing().publish()
             # DEBUG: Wrap in try/except for RunTime error
-            self._task_bar_icon.RemoveIcon()
-            self._task_bar_icon.Destroy()
-            self.Destroy()
+            try:
+                self._task_bar_icon.RemoveIcon()
+                self._task_bar_icon.Destroy()
+            except RuntimeError:
+                pass
+            try:
+                self.Destroy()
+            except RuntimeError:
+                pass
             app = wx.GetApp()
             if app is not self._application:
                 # other wx app instance created unexpectedly

src/robotide/version.py

@@ -14,4 +14,4 @@
 #  limitations under the License.
 #
 # Automatically generated by `tasks.py`.
-VERSION = 'v2.0.7dev9'
+VERSION = 'v2.0.7dev10'