When saving in Text Editor the cursor remains at position

Author: HelioGuilherme66

CHANGELOG.adoc

@@ -14,6 +14,7 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 - Added on Text Editor, folding margin with markers style configurable with ``fold symbols`` in settings.cfg.
 
 === Changed
+- When saving in Text Editor, the cursor remains at position, instead of jumping to Tree selection.
 - Improved autocompletion lists, by using existing words in Test Suite file (still needs more improvements).
 - Create directories when needed in New Project dialog.
 - Improved the recognition of BDD/Gherkin prefixes when localized in autocomplete on Grid Editor.

README.adoc

@@ -40,7 +40,7 @@ Likewise, the current version of wxPython, is 4.2.2, but RIDE is known to work w
 
 `pip install -U robotframework-ride`
 
-(3.8 <= python <= 3.13) Install current development version (**2.2dev10**) with:
+(3.8 <= python <= 3.13) Install current development version (**2.2dev13**) with:
 
 `pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`
 

src/robotide/application/CHANGELOG.html

@@ -7,6 +7,8 @@
 </li><li class="listitem">
 Added on Text Editor, folding margin with markers style configurable with ``fold symbols`` in settings.cfg.
 </li></ul></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_changed"></a>1.2. Changed</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
+When saving in Text Editor, the cursor remains at position, instead of jumping to Tree selection.
+</li><li class="listitem">
 Improved autocompletion lists, by using existing words in Test Suite file (still needs more improvements).
 </li><li class="listitem">
 Create directories when needed in New Project dialog.

src/robotide/application/releasenotes.py

@@ -168,6 +168,7 @@ def set_content(self, html_win, content):
 </ul>
 <p><strong>New Features and Fixes Highlights</strong></p>
 <ul class="simple">
+<li>When saving in Text Editor, the cursor remains at position, instead of jumping to Tree selection.</li>
 <li>Improved autocompletion lists, by using existing words in Test Suite file (still needs more improvements).</li>
 <li>Fixed not set text color on row labels in Grid Editor. Now the General <b>secondary foreground</b> is applied.</li>
 <li>Added on Text Editor, tab indentation markers and <b>tab markers</b> boolean setting with default <b>True</b>.</li>
@@ -233,7 +234,7 @@ def set_content(self, html_win, content):
 <pre class="literal-block">python -m robotide.postinstall -install</pre>
 <p>or</p>
 <pre class="literal-block">ride_postinstall.py -install</pre>
-<p>RIDE {VERSION} was released on 17/March/2025.</p>
+<p>RIDE {VERSION} was released on 22/March/2025.</p>
 <!-- <br/>
 <h3>May The Fourth Be With You!</h3>
 <h3>Celebrate the bank holiday, 10th June, Day of Portugal, Portuguese Communities and Camões!!</h3>

src/robotide/editor/texteditor.py

@@ -88,7 +88,8 @@ def read_language(content):
 def obtain_language(existing, content):
     try:
         set_lang = shared_memory.ShareableList(name="language")
-    except AttributeError:  # Unittests fails here
+    except Exception as e: # AttributeError:  # Unittests fails here
+        print(f"DEBUG: texteditor.py obtain_language EXCEPTION: {e}")
         set_lang = []
     doc_lang = read_language(content)
     adoc_lang = []
@@ -384,6 +385,7 @@ def __init__(self, application):
         self._tab = None
         self._doc_language = None
         self._save_flag = 0
+        self.jump = True
         self.reformat = application.settings.get('reformat', False)
         self._register_shortcuts()
 
@@ -443,6 +445,7 @@ def on_open(self, event):
         self._open()
 
     def _open(self):
+        # print(f"DEBUG: texteditor.py TextEditorPlugin _open ENTER curpos={self._editor._position}")
         datafile_controller = self.tree.get_selected_datafile_controller()
         if datafile_controller:
             self._save_flag = 0
@@ -496,13 +499,16 @@ def _check_message(self, message: RideMessage) -> None:
             self._save_flag = 2
         if self.is_focused() and self._save_flag == 2 and isinstance(message, RideSaved):
             self._save_flag = 3
-            wx.CallAfter(self._editor.mark_file_dirty, False)
+            print(f"DEBUG: textedit.py TextEditorPlugin _check_message call undirty, {message}")
+            # wx.CallAfter(self._editor.mark_file_dirty, False)
+            self._editor.mark_file_dirty(False)
+            self.tree._data_undirty(message)
         # DEBUG: This is the unwanted chnge after saving but excluded in this block for performance
         # if self.is_focused() and self._save_flag == 3 and isinstance(message, RideDataChangedToDirty):
         #     self._save_flag = 4
         #     wx.CallAfter(self._editor.mark_file_dirty, False)
         if isinstance(message, RideBeforeSaving):
-            self._editor.is_saving = False
+            # self._editor.is_saving = False
             # Reset counter for Workaround for remarked dirty with Ctrl-S
             self._save_flag = 0
             self._apply_txt_changes_to_model()
@@ -511,7 +517,7 @@ def on_data_changed(self, message):
         """ This block is now inside try/except to avoid errors from unit test """
         try:
             if self.is_focused() and isinstance(message, RideDataChangedToDirty):
-                # print("DEBUG: textedit OnDataChanged returning RideDataChangedToDirty")
+                # print(f"DEBUG: textedit OnDataChanged returning RideDataChangedToDirty {self._save_flag=}")
                 return
             if self._should_process_data_changed_message(message):
                 # print(f"DEBUG: textedit after _should_process_data_changed_message save_flag={self._save_flag}")
@@ -532,21 +538,29 @@ def _should_process_data_changed_message(message):
         # and not isinstance(message, RideDataChangedToDirty))
 
     def on_tree_selection(self, message):
+        if not self.is_focused():
+            return
         # print(f"DEBUG: texteditor.py TextEditorPlugin on_tree_selection ENTER {message=} type={type(message.item)}")
         self._editor.store_position()
+        # self.jump = True
         if self.is_focused():
             next_datafile_controller = message.item and message.item.datafile_controller
             if self._editor.datafile_controller == message.item.datafile_controller == next_datafile_controller:
-                # print(f"DEBUG: OnTreeSelection Same FILE item type={type(message.item)}")
+                # print(f"DEBUG: OnTreeSelection Same FILE item type={type(message.item)}\n"
+                #      f"value of {self._save_flag=}")
                 self._editor.locate_tree_item(message.item)
+                self.jump = True
                 return
             if self._editor.dirty and not self._apply_txt_changes_to_model():
                 if self._editor.datafile_controller != next_datafile_controller:
                     self.tree.select_controller_node(self._editor.datafile_controller)
                 self._editor.set_editor_caret_position()
                 return
             if next_datafile_controller:
+                self.jump = True
                 self._open_data_for_controller(next_datafile_controller)
+                # print(f"DEBUG: OnTreeSelection OTHER FILE item type={type(message.item)}\n"
+                #       f"value of {self._save_flag=}")
                 wx.CallAfter(self._editor.locate_tree_item, message.item)
             self._set_read_only(message)
             self._editor.set_editor_caret_position()
@@ -588,7 +602,8 @@ def on_tab_change(self, message):
                 self._set_read_only(self._editor.source_editor.readonly)
             except Exception as e:  # DEBUG: When using only Text Editor exists error in message topic
                 print(e)
-            wx.CallAfter(self._editor.source_editor.on_style, None)  # DEBUG Text Edit, styles were not applied
+            # wx.CallAfter(self._editor.source_editor.on_style, None)  # DEBUG Text Edit, styles were not applied
+            self._editor.source_editor.on_style(None)
             self._editor.Refresh()
         elif message.oldtab == self.title:
             self._editor.remove_and_store_state()
@@ -600,8 +615,12 @@ def on_tab_changed(self, event):
         event.Skip()
 
     def _apply_txt_changes_to_model(self):
-        self._editor.is_saving = False
-        # print(f"DEBUG: textedit.py _apply_txt_changes_to_model CALL content_save lang={self._doc_language}")
+        if not self.is_focused() and not self._editor.dirty:
+            return
+        # self._editor.is_saving = False
+        # self._editor.store_position()
+        # print(f"DEBUG: textedit.py _apply_txt_changes_to_model CALL content_save lang={self._doc_language}"
+        #       f" curpos={self._editor._position}")
         if not self._editor.content_save(lang=self._doc_language):
             return False
         self._editor.reset()
@@ -945,7 +964,7 @@ def __init__(self, plugin, parent, title, data_validator):
         self._words_cache = set()  # Actual cache of words to add to suggestions
         self._stored_text = None
         self._ctrl_action = None
-        self.is_saving = False  # To avoid double calls to save
+        # self.is_saving = False  # To avoid double calls to save
         self.old_information_popup = None
         PUBLISHER.subscribe(self.on_settings_changed, RideSettingsChanged)
         PUBLISHER.subscribe(self.on_tab_change, RideNotebookTabChanging)
@@ -1068,7 +1087,7 @@ def set_editor_caret_position(self):
             return
         position = self._position
         self.source_editor.SetFocus()
-        # print(f"DEBUG: texteditor.py SourceEditor position={position}")
+        # print(f"DEBUG: texteditor.py SourceEditor set_editor_caret_position position={position}")
         if position:
             self.source_editor.SetCurrentPos(position)
             self.source_editor.SetSelection(self.restore_start_pos, self.restore_end_pos)
@@ -1153,12 +1172,16 @@ def _show_search_results(self, position, txt):
 
     def locate_tree_item(self, item):
         """ item is object received from message """
+        if not self.plugin.jump:
+            self.plugin.jump = True
+            return
         from wx.stc import STC_FIND_REGEXP
         search_end = len(self.source_editor.utf8_text)
         section_start = 0
         name_to_locate = r'^'+item.name+r'.*$'
         position = self.source_editor.FindText(section_start, search_end, name_to_locate, STC_FIND_REGEXP)
-        # print(f"DEBUG: TextEditor locate_tree_item name_to_locate={name_to_locate} position={position}")
+        # print(f"DEBUG: TextEditor locate_tree_item name_to_locate={name_to_locate} position={position}\n"
+        #       f"curpos={self._position} {self.is_saving=}")
         if position[0] != -1:
             # DEBUG: Make colours configurable?
             self.source_editor.SetSelBackground(True, Colour('orange'))
@@ -1320,7 +1343,7 @@ def open(self, data):
             self.language = self._data._language
         else:
             self.language = ['en']
-        # print(f"DEBUG: texteditor.py SourceEditor open ENTER language={self.language}")
+        # print(f"DEBUG: texteditor.py SourceEditor open ENTER language={self.language} curpos={self._position}")
         try:
             if hasattr(self._data, 'wrapper_data'):
                 if isinstance(self._data.wrapper_data, ResourceFileController):
@@ -1492,14 +1515,15 @@ def reset(self):
 
     def content_save(self, **args):
         self.store_position()
-        if self.dirty and not self.is_saving:
-            self.is_saving = True
+        # print(f"DEBUG: TextEditor.py SourceEditor content_save curpos={self._position}")
+        if self.dirty:
             # print(f"DEBUG: TextEditor.py SourceEditor content_save content={self.source_editor.utf8_text}\n"
             #       f"self.language={self.language} data={self._data}"
             #       f" calling validate_and_update with lang={args['lang']}")
+            self.plugin.jump = False
             if not self._data_validator.validate_and_update(self._data, self.source_editor.utf8_text,
                                                             lang=self.language):  # args['lang']
-                self.is_saving = False
+                self.plugin.jump = True
                 return False
         return True
 
@@ -1541,7 +1565,7 @@ def on_paste(self, event):
     @staticmethod
     def on_insert(event):
         __ = event
-        print(f"DEBUG: TextEditor called on_insert event={event}\n TO BE IMPLEMENTED")
+        # print(f"DEBUG: TextEditor called on_insert event={event}\n TO BE IMPLEMENTED")
         # self.insert_row()
 
     @staticmethod
@@ -1768,6 +1792,7 @@ def on_key_down(self, event):
             # This must be the last branch to activate actions before doc
             # DEBUG: coords = self._get_screen_coordinates()
             self.source_editor.show_kw_doc()
+        self.mark_file_dirty(self.source_editor.GetModify())
         event.Skip()
 
         # These commands are duplicated by global actions

src/robotide/lib/compat/pygments/robotframework.py

@@ -557,7 +557,10 @@ class _Table:
     def __init__(self, prev_tokenizer=None, new_lang=None):
         if self.new_lang is None:
             if new_lang is None:
-                set_lang = shared_memory.ShareableList(name="language")
+                try:
+                    set_lang = shared_memory.ShareableList(name="language")
+                except  FileNotFoundError:
+                    set_lang = ['En']
                 self.new_lang = Language.from_name(set_lang[0].replace('_', '-'))
             else:
                 self.new_lang = new_lang

src/robotide/spec/iteminfo.py

@@ -143,12 +143,16 @@ def __init__(self, name, value):
         VariableInfo.__init__(self, name, value, self.SOURCE)
 
     def __eq__(self, other):
+        if isinstance(other, str):
+            return  self.longname.lower() == other.lower()
         return self.longname.lower() == other.longname.lower()
 
     def __hash__(self):
         return hash(repr(self))
 
     def __lt__(self, other):
+        if isinstance(other, str):
+            return  self.longname.lower() < other.lower()
         return self.longname.lower() < other.longname.lower()
 
 

src/robotide/ui/treeplugin.py

@@ -234,6 +234,7 @@ def __init__(self, parent, action_registerer, settings=None):
         self._execution_results = None
         self._resources = []
         self._right_click = False
+        self.dirty = False
         # DEBUG: This menu is not working because is being attached to main frame
         # self._menu = wx.Menu()
         # self._menu.Append(wx.ID_CLOSE, item="&Close", helpString="Closes panel")
@@ -707,10 +708,14 @@ def delete_node(self, node):
         wx.CallAfter(self.SelectItem, parent)
 
     def _data_dirty(self, message):
-        self.controller.mark_controller_dirty(message.datafile)
+        # print("DEBUG: TreePlugin tree _data_dirty ENTER")
+        if not self.dirty:
+            self.dirty = True
+            self.controller.mark_controller_dirty(message.datafile)
 
     def _data_undirty(self, message):
         _ = message
+        # print("DEBUG: TreePlugin tree _data_undirty")
         self.unset_dirty()
 
     def unset_dirty(self):
@@ -719,6 +724,7 @@ def unset_dirty(self):
             handler = self.controller.get_handler(node)
             if text.startswith('*') and not handler.controller.dirty:
                 self.SetItemText(node, text[1:])
+                self.dirty = False
 
     def select_node_by_data(self, controller):
         """Find and select the tree item associated with the given controller.

src/robotide/version.py

@@ -15,4 +15,4 @@
 #
 # Automatically generated by `tasks.py`.
 
-VERSION = 'v2.2dev12'
+VERSION = 'v2.2dev13'