kweditor.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import json
from json.decoder import JSONDecodeError
 
import wx
from wx import grid, Colour
from wx.grid import GridCellEditor
 
from .contentassist import ExpandingContentAssistTextCtrl
from .editordialogs import UserKeywordNameDialog, ScalarVariableDialog, ListVariableDialog
from .gridbase import GridEditor, linesep
from .gridcolorizer import Colorizer
from .tooltips import GridToolTips
from .. import context
from .. import robotapi
from ..context import IS_MAC
from ..controller.cellinfo import TipMessage, ContentType, CellType
from ..controller.ctrlcommands import ChangeCellValue, ClearArea, \
    PasteArea, DeleteRows, AddRows, CommentRows, InsertCells, DeleteCells, \
    UncommentRows, Undo, Redo, RenameKeywordOccurrences, ExtractKeyword, \
    AddKeywordFromCells, MoveRowsUp, MoveRowsDown, ExtractScalar, ExtractList, \
    InsertArea
from ..editor.cellrenderer import CellRenderer
from ..pluginapi import Plugin
from ..publish import (RideItemStepsChanged, RideSaved, RideSettingsChanged,
                       PUBLISHER, RideBeforeSaving)
from ..ui.progress import RenameProgressObserver
from ..usages.UsageRunner import Usages, VariableUsages
from ..utils import variablematcher
from ..widgets import RIDEDialog, PopupMenu, PopupMenuItems
 
 
_DEFAULT_FONT_SIZE = 11
 
 
def requires_focus(function):
    def _row_header_selected_on_linux(self):
        return self.FindFocus() is None
 
    def decorated_function(self, *args):
        if not self.has_focus():
            return
        if self.has_focus() or self.IsCellEditControlShown() or _row_header_selected_on_linux(self):
            function(self, *args)
 
    return decorated_function
 
 
class KeywordEditor(GridEditor, Plugin):
    
    _no_cell = (-1, -1)
    
    _popup_menu_shown = False
    dirty = property(lambda self: self._controller_controller.dirty)
    update_value = lambda *args: None
    
    _popup_items = [
                       'Create Keyword',
                       'Extract Keyword',
                       'Extract Variable',
                       'Rename Keyword',
                       'Find Where Used',
                       'JSON Editor\tCtrl-Shift-J',
                       '---',
                       'Go to Definition\tCtrl-B',
                       '---',
                       'Undo\tCtrl-Z',
                       'Redo\tCtrl-Y',
                       '---',
                       'Make Variable\tCtrl-1',
                       'Make List Variable\tCtrl-2',
                       'Make Dict Variable\tCtrl-5',
                       '---',
                       'Comment Cells\tCtrl-Shift-3',
                       'Uncomment Cells\tCtrl-Shift-4',
                       'Move Cursor Down\tAlt-Enter',
                       '---',
                       'Comment Rows\tCtrl-3',
                       'Uncomment Rows\tCtrl-4',
                       'Move Rows Up\tAlt-Up',
                       'Move Rows Down\tAlt-Down',
                       'Swap Row Up\tCtrl-T',
                       '---',
                   ] + GridEditor._popup_items
 
    def __init__(self, parent, controller, tree):
        self.settingssettingssettings = parent.plugin.global_settings['Grid']
        self.general_settingsgeneral_settingsgeneral_settings = parent.plugin.global_settings['General']
        # self.color_background_help = self.general_settings.get('background help', (240, 242, 80))
        # self.color_foreground_text = self.general_settings.get('foreground text', (7, 0, 70))
        self.color_backgroundcolor_backgroundcolor_background = self.general_settingsgeneral_settingsgeneral_settings['background']
        self.color_foregroundcolor_foregroundcolor_foreground = self.general_settingsgeneral_settingsgeneral_settings['foreground']
        self.color_secondary_backgroundcolor_secondary_backgroundcolor_secondary_background = self.general_settingsgeneral_settingsgeneral_settings['secondary background']
        self.color_secondary_foregroundcolor_secondary_foregroundcolor_secondary_foreground = self.general_settingsgeneral_settingsgeneral_settings['secondary foreground']
        self.color_background_helpcolor_background_helpcolor_background_help = self.general_settingsgeneral_settingsgeneral_settings['background help']
        self.color_foreground_textcolor_foreground_textcolor_foreground_text = self.general_settingsgeneral_settingsgeneral_settings['foreground text']
        GridEditor.__init__(
            self, parent, len(controller.steps) + 5,
            max((controller.max_columns + 1), 5),
            parent.plugin._grid_popup_creator)
        self._parent_parent = parent
        self._plugin_plugin = parent.plugin
        self._cell_selected_cell_selected = False
        self._colorizer_colorizer = Colorizer(self, controller)
        self._controller_controller = controller
        self._configure_grid_configure_grid()
        self._updating_namespace_updating_namespace = False
        self._controller_controller.datafile_controller.register_for_namespace_updates(
            self._namespace_updated_namespace_updated_namespace_updated)
        self._tooltips_tooltips = GridToolTips(self)
        self._marked_cell_marked_cell = None
        self._make_bindings_make_bindings()
        self._write_steps_write_steps(self._controller_controller)
        self.autosizeautosize()
        self._tree_tree = tree
        self._has_been_clicked_has_been_clicked = False
        self._counter_counter = 0  # Workaround for double delete actions
        self._dcells_dcells = None  # Workaround for double delete actions
        self._icells_icells = None  # Workaround for double insert actions
        self.InheritAttributes()
 
        # TODO: This is ineffective, why?
        """
        self.SetBackgroundColour(Colour(self.color_secondary_background))
        self.SetOwnBackgroundColour(Colour(self.color_secondary_background))
        self.SetForegroundColour(Colour(self.color_secondary_foreground))
        self.SetOwnForegroundColour(Colour(self.color_secondary_foreground))
        """
        # self.Refresh()
        PUBLISHER.subscribe(self._before_saving_before_saving, RideBeforeSaving)
        PUBLISHER.subscribe(self._data_changed_data_changed, RideItemStepsChanged)
        # PUBLISHER.subscribe(self.OnSettingsChanged, RideSettingsChanged)
        PUBLISHER.subscribe(self._ps_on_resize_grid_ps_on_resize_grid, RideSaved)
 
    def _namespace_updated(self):
        if not self._updating_namespace_updating_namespace:
            self._updating_namespace_updating_namespace = True
            # See following issue for history of the next line:
            # http://code.google.com/p/robotframework-ride/issues/detail?id=1108
            wx.CallAfter(
                wx.CallLater, 200, self._update_based_on_namespace_change_update_based_on_namespace_change)
 
    def _update_based_on_namespace_change(self):
        try:
            self._colorize_grid_colorize_grid()
        finally:
            self._updating_namespace_updating_namespace = False
 
    def _ps_on_resize_grid(self, message):
        self._resize_grid_resize_grid()
 
    @requires_focus
    def _resize_grid(self):
        if self.settingssettingssettings.get("auto size cols", False):
            self.AutoSizeColumns(False)
        if self.settingssettingssettings.get("word wrap", True):
            self.AutoSizeRows(False)
 
    def _set_cells(self):
        col_size = self.settingssettingssettings.get("col size", 150)
        max_col_size = self.settingssettingssettings.get("max col size", 450)
        auto_col_size = self.settingssettingssettings.get("auto size cols", False)
        word_wrap = self.settingssettingssettings.get("word wrap", True)
 
        self.SetDefaultRenderer(
            CellRenderer(col_size, max_col_size, auto_col_size, word_wrap))
        self.SetRowLabelSize(wx.grid.GRID_AUTOSIZE)
        self.SetColLabelSize(0)
 
        if auto_col_size:
            self.SetDefaultColSize(wx.grid.GRID_AUTOSIZE, resizeExistingCols=True)
        else:
            self.SetDefaultColSize(col_size, resizeExistingCols=True)
            self.SetColMinimalAcceptableWidth(col_size)
 
        if auto_col_size:
            self.Bind(grid.EVT_GRID_CMD_COL_SIZE, self.OnCellColSizeChangedOnCellColSizeChanged)
        else:
            self.Unbind(grid.EVT_GRID_CMD_COL_SIZE)
 
        if word_wrap:
            self.SetDefaultRowSize(wx.grid.GRID_AUTOSIZE)
        self.SetDefaultCellOverflow(False)  # DEBUG
        self.autosizeautosize()
        self._colorize_grid_colorize_grid()
 
    def _configure_grid(self):
        self._set_cells_set_cells()
        self.SetDefaultEditor(
            ContentAssistCellEditor(self._plugin_plugin, self._controller_controller))
        self._set_fonts_set_fonts()
 
    def _set_fonts(self, update_cells=False):
        font_size = self.settingssettingssettings.get('font size', _DEFAULT_FONT_SIZE)
        font_family = wx.FONTFAMILY_MODERN if self.settingssettingssettings['fixed font'] \
            else wx.FONTFAMILY_DEFAULT
        font_face = self.settingssettingssettings.get('font face', None)
        if font_face is None:
            font = wx.Font(font_size, font_family, wx.FONTSTYLE_NORMAL, wx.FONTWEIGHT_NORMAL)
            self.settingssettingssettings.set('font face', font.GetFaceName())
        else:
            font = wx.Font(font_size, font_family, wx.FONTSTYLE_NORMAL, wx.FONTWEIGHT_NORMAL, False, font_face)
        self.SetDefaultCellFont(font)
        for row in range(self.NumberRows):
            for col in range(self.NumberCols):
                self.SetCellFont(row, col, font)
                self.ForceRefresh()
 
    def _make_bindings(self):
        self.Bind(grid.EVT_GRID_EDITOR_SHOWN, self.OnEditorOnEditor)
        self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDownOnKeyDown)
        self.Bind(wx.EVT_CHAR, self.OnCharOnChar)
        self.Bind(wx.EVT_KEY_UP, self.OnKeyUpOnKeyUp)
        self.GetGridWindow().Bind(wx.EVT_MOTION, self.OnMotionOnMotion)
        self.Bind(grid.EVT_GRID_CELL_LEFT_CLICK, self.OnCellLeftClickOnCellLeftClick)
        self.Bind(grid.EVT_GRID_LABEL_RIGHT_CLICK, self.OnLabelRightClickOnLabelRightClick)
        self.Bind(grid.EVT_GRID_LABEL_LEFT_CLICK, self.OnLabelLeftClickOnLabelLeftClick)
        self.Bind(wx.EVT_KILL_FOCUS, self.OnKillFocusOnKillFocus)
 
    def get_tooltip_content(self):
        if self.IsCellEditControlShown() or self._popup_menu_shown_popup_menu_shown_popup_menu_shown:
            return ''
        cell = self.cell_under_cursorcell_under_cursorcell_under_cursor
        cell_info = self._controller_controller.get_cell_info(cell.Row, cell.Col)
        return TipMessage(cell_info)
 
    
    def OnSettingsChanged(self, message):
        section, setting = message.keys
        if section == 'Grid':
            if 'font' in setting:
                self._set_fonts_set_fonts(update_cells=True)
            elif ('col size' in setting
                  or 'max col size' in setting
                  or 'auto size cols' in setting
                  or 'word wrap' in setting):
                self._set_cells_set_cells()
                return
            self.autosizeautosize()
            self._colorize_grid_colorize_grid()
 
    def OnSelectCell(self, event):
        self._cell_selected_cell_selected = True
        GridEditor.OnSelectCell(self, event)
        self._colorize_grid_colorize_grid()
        event.Skip()
 
    def OnKillFocus(self, event):
        self._tooltips_tooltips.hide()
        self._hide_link_if_necessary_hide_link_if_necessary()
        event.Skip()
 
    def _execute(self, command):
        return self._controller_controller.execute(command)
 
    def _toggle_underlined(self, cell):
        font = self.GetCellFont(cell.Row, cell.Col)
        font.SetUnderlined(not font.Underlined)
        self.SetCellFont(cell.Row, cell.Col, font)
        self.Refresh()
 
    def OnLabelRightClick(self, event):
        if event.Col == -1:
            self._row_label_right_click_row_label_right_click(event)
        else:
            self._col_label_right_click_col_label_right_click(event)
 
    def _row_label_right_click(self, event):
        selected_row = event.GetRow()
        selected_rows = self.selectionselection.rows()
        if selected_row not in selected_rows:
            self.SelectRow(selected_row, addToSelected=False)
            self.SetGridCursor(event.Row, 0)
        popupitems = [
                    'Comment Rows\tCtrl-3',
                    'Uncomment Rows\tCtrl-4',
                    'Move Rows Up\tAlt-Up',
                    'Move Rows Down\tAlt-Down',
                    'Swap Row Up\tCtrl-T',
                    'Insert Rows\tCtrl-I',
                    'Delete Rows\tCtrl-D',
                    '---',
                    'Comment Cells\tCtrl-Shift-3',
                    'Uncomment Cells\tCtrl-Shift-4',
                    ]
        PopupMenu(self, PopupMenuItems(self, popupitems))
        event.Skip()
 
    def _col_label_right_click(self, event):
        pass
 
    def OnLabelLeftClick(self, event):
        if event.Col == -1:
            self._row_label_left_click(event)
        else:
            self._col_label_left_click(event)
 
    def _row_label_left_click(self, event):
        if event.ShiftDown() or event.ControlDown():
            self.ClearSelection()
            cursor_row = self.GetGridCursorRow()
            event_row = event.Row
            start, end = (cursor_row, event_row) \
                if cursor_row < event_row else (event_row, cursor_row)
            for row in range(start, end + 1):
                self.SelectRow(row, addToSelected=True)
        else:
            self.SelectRow(event.Row, addToSelected=False)
            self.SetGridCursor(event.Row, 0)
 
    def _col_label_left_click(self, event):
        pass
 
    def OnMoveCursorDown(self, event=None):
        self._move_cursor_down(event)
 
    def OnInsertRows(self, event):
        self._execute_execute(AddRows(self.selectionselection.rows()))
        self.ClearSelection()
        self._resize_grid_resize_grid()
        self._skip_except_on_mac_skip_except_on_mac(event)
 
    def _skip_except_on_mac(self, event):  # TODO Do we still need this?
        if event is not None and not IS_MAC:
            # print("DEBUG skip!")
            event.Skip()
 
    def OnInsertCells(self, event=None):
        # TODO remove below workaround for double actions
        if self._counter_counter == 1:
            if self._icells_icells == (
                    self.selectionselection.topleft, self.selectionselection.bottomright):
                self._counter_counter = 0
                self._icells_icells = None
                return
        else:
            self._counter_counter = 1
 
        self._icells_icells = (self.selectionselection.topleft,
                        self.selectionselection.bottomright)
        self._execute_execute(InsertCells(self.selectionselection.topleft,
                                  self.selectionselection.bottomright))
        self._resize_grid_resize_grid()
        self._skip_except_on_mac_skip_except_on_mac(event)
 
    def OnDeleteCells(self, event=None):
        # TODO remove below workaround for double actions
        if self._counter_counter == 1:
            if self._dcells_dcells == (self.selectionselection.topleft,
                                self.selectionselection.bottomright):
                self._counter_counter = 0
                self._dcells_dcells = None
                return
        else:
            self._counter_counter = 1
 
        self._dcells_dcells = (self.selectionselection.topleft, self.selectionselection.bottomright)
        self._execute_execute(DeleteCells(self.selectionselection.topleft, self.selectionselection.bottomright))
        self._resize_grid_resize_grid()
        self._skip_except_on_mac_skip_except_on_mac(event)
 
    # DEBUG @requires_focus
    def OnCommentRows(self, event=None):
        self._execute_execute(CommentRows(self.selectionselection.rows()))
        self._resize_grid_resize_grid()
        self._skip_except_on_mac_skip_except_on_mac(event)
 
    # DEBUG @requires_focus
    def OnUncommentRows(self, event=None):
        self._execute_execute(UncommentRows(self.selectionselection.rows()))
        self._resize_grid_resize_grid()
        self._skip_except_on_mac_skip_except_on_mac(event)
 
    def OnMoveRowsUp(self, event=None):
        self._row_move_row_move(MoveRowsUp, -1)
 
    def OnMoveRowsDown(self, event=None):
        self._row_move_row_move(MoveRowsDown, 1)
 
    def OnSwapRowUp(self, event=None):
        self._row_move_row_move(MoveRowsUp, 1, True)
 
    def _row_move(self, command, change, swap=False):
        # Workaround for double actions, see issue #2048
        if self._counter_counter == 1:
            if IS_MAC:
                row=self.GetGridCursorRow() + change
                col=self.GetGridCursorCol()
                if row >= 0:
                    self.SetGridCursor(row, col)
                self._counter_counter = 0
                return
        else:
            self._counter_counter += 1
        rows = self.selectionselection.rows()
        if self._execute_execute(command(rows)):
            if swap:
                wx.CallAfter(self._select_rows_select_rows, [r for r in rows])
            else:
                wx.CallAfter(self._select_rows_select_rows, [r + change for r in rows])
        self._resize_grid_resize_grid()
 
    def _select_rows(self, rows):
        self.ClearSelection()
        for r in rows:
            self.SelectRow(r, True)
 
    def OnMotion(self, event):
        if IS_MAC:
            if self.IsCellEditControlShown():
                return
        event.Skip()
 
    def _before_saving(self, message):
        if self.IsCellEditControlShown():
            # Fix: cannot save modifications in edit mode
            # Exit edit mode before saving
            self.HideCellEditControl()
            self.SaveEditControlValue()
            self.SetFocus()
 
    def _data_changed(self, message):
        if self._controller_controller == message.item:
            self._write_steps_write_steps(message.item)
 
    def _write_steps(self, controller):
        data = []
        self._write_headers_write_headers(controller)
        for step in controller.steps:
            data.append(self._format_comments_format_comments(step.as_list()))
        self.ClearGrid()
        self._write_data_write_data(data, update_history=False)
        self._colorize_grid_colorize_grid()
 
    def _write_headers(self, controller):
        headers = controller.data.parent.header[1:]
        if not headers:
            self.SetColLabelSize(0)
            return
        self.SetColLabelSize(wx.grid.GRID_AUTOSIZE)  # DEBUG
        for col, header in enumerate(headers):
            self.SetColLabelValue(col, header)
        for empty_col in range(col + 1, self.NumberCols + 1):
            self.SetColLabelValue(empty_col, '')
 
    def _colorize_grid(self):
        selection_content = \
            self._get_single_selection_content_or_none_on_first_call_get_single_selection_content_or_none_on_first_call()
        if selection_content is None:
            self.highlighthighlight(None)
        else:
            self._parent_parent.highlight(selection_content, expand=False)
 
    def highlight(self, text, expand=True):
        # Below CallAfter was causing C++ assertions(objects not found)
        # When calling Preferences Grid Colors change
        wx.CallLater(100, self._colorizer_colorizer.colorize, text)
 
    def autosize(self):
        wx.CallAfter(self.AutoSizeColumns, False)
        wx.CallAfter(self.AutoSizeRows, False)
 
    def _get_single_selection_content_or_none_on_first_call(self):
        if self._cell_selected_cell_selected:
            return self.get_single_selection_contentget_single_selection_content()
 
    def _format_comments(self, data):
        # TODO: This should be moved to robot.model
        in_comment = False
        ret = []
        for cell in data:
            if cell.strip().startswith('#'):
                in_comment = True
            if in_comment:
                cell = cell.replace(' |', '')
            ret.append(cell)
        return ret
 
    def cell_value_edited(self, row, col, value):
        self._execute_execute(ChangeCellValue(row, col, value))
        wx.CallAfter(self.AutoSizeColumn, col, False)
        wx.CallAfter(self.AutoSizeRow, row, False)
 
    def get_selected_datafile_controller(self):
        return self._controller_controller.datafile_controller
 
    # DEBUG @requires_focus
    def OnCopy(self, event=None):
        # print("DEBUG: OnCopy called event %s\n" % str(event))
        self.copycopy()
 
    # DEBUG @requires_focus
    def OnCut(self, event=None):
        self._clipboard_handler_clipboard_handler.cut()
        self.OnDeleteOnDelete(event)
 
    def OnDelete(self, event=None):
        if not self.IsCellEditControlShown():
            self._execute_execute(ClearArea(self.selectionselection.topleft,
                                    self.selectionselection.bottomright))
            self._resize_grid_resize_grid()
 
    # DEBUG    @requires_focus
    def OnPaste(self, event=None):
        if self.IsCellEditControlShown():
            self.pastepaste()
        else:
            self._execute_clipboard_command_execute_clipboard_command(PasteArea)
        self._resize_grid_resize_grid()
 
    def _execute_clipboard_command(self, command_class):
        if not self.IsCellEditControlShown():
            data = self._clipboard_handler_clipboard_handler.clipboard_content()
            if data:
                data = [[data]] if isinstance(data, str) else data
                self._execute_execute(command_class(self.selectionselection.topleft, data))
 
    # DEBUG @requires_focus
    def OnInsert(self, event=None):
        self._execute_clipboard_command_execute_clipboard_command(InsertArea)
        self._resize_grid_resize_grid()
 
    def OnDeleteRows(self, event):
        self._execute_execute(DeleteRows(self.selectionselection.rows()))
        self.ClearSelection()
        self._resize_grid_resize_grid()
        self._skip_except_on_mac_skip_except_on_mac(event)
 
    # DEBUG @requires_focus
    def OnUndo(self, event=None):
        if not self.IsCellEditControlShown():
            self._execute_execute(Undo())
        else:
            self.GetCellEditor(*self.selectionselection.cell).Reset()
        self._resize_grid_resize_grid()
 
    # DEBUG @requires_focus
    def OnRedo(self, event=None):
        self._execute_execute(Redo())
        self._resize_grid_resize_grid()
 
    def close(self):
        self._colorizer_colorizer.close()
        self.savesave()
        PUBLISHER.unsubscribe_all(self)
        if self._namespace_updated_namespace_updated_namespace_updated:
            # Prevent re-entry to unregister method
            self._controller_controller.datafile_controller.unregister_namespace_updates(
                self._namespace_updated_namespace_updated_namespace_updated)
        self._namespace_updated_namespace_updated_namespace_updated = None
 
    def save(self):
        self._tooltips_tooltips.hide()
        if self.IsCellEditControlShown():
            cell_editor = self.GetCellEditor(*self.selectionselection.cell)
            cell_editor.EndEdit(self.selectionselection.topleft.row,
                                self.selectionselection.topleft.col, self)
 
    def show_content_assist(self):
        if self.IsCellEditControlShown():
            self.GetCellEditor(*self.selectionselection.cell).show_content_assist(self.selectionselection.cell)
 
    def refresh_datafile(self, item, event):
        self._tree_tree.refresh_datafile(item, event)
 
    def _calculate_position(self):
        x, y = wx.GetMousePosition()
        return x, y + 20
 
    def OnEditor(self, event):
        self._tooltips_tooltips.hide()
        row_height = self.GetRowSize(self.selectionselection.topleft.row)
        self.GetCellEditor(*self.selectionselection.cell).SetHeight(row_height)
        event.Skip()
 
    def _move_cursor_down(self, event):
        self.DisableCellEditControl()
        if event:
            try:
                shiftdown = event.ShiftDown()
            except AttributeError:
                shiftdown = False
        else:
            shiftdown = False
        self.MoveCursorDown(shiftdown)
 
    def OnKeyDown(self, event):
        keycode = event.GetUnicodeKey() or event.GetKeyCode()
        if event.ControlDown():
            if event.ShiftDown():
                if keycode == ord('I'):
                    self.OnInsertCellsOnInsertCellsOnInsertCells()
                elif keycode == ord('J'):
                    self.OnJsonEditorOnJsonEditor(event)
                elif keycode == ord('D'):
                    self.OnDeleteCellsOnDeleteCellsOnDeleteCells()
                """
                elif keycode == ord('3'):
                    self._open_cell_editor_and_execute_sharp_comment()
                elif keycode == ord('4'):
                    self._open_cell_editor_and_execute_sharp_uncomment()
                """
            else:
                if keycode == wx.WXK_SPACE:
                    self._open_cell_editor_with_content_assist_open_cell_editor_with_content_assist()
                    return  # event must not be skipped in this case
                elif keycode == ord('C'):
                    self.OnCopyOnCopy(event)
                elif keycode == ord('X'):
                    self.OnCutOnCut(event)
                elif keycode == ord('V'):
                    self.OnPasteOnPaste(event)
                elif keycode == ord('Z'):
                    self.OnUndoOnUndo(event)
                elif keycode == ord('A'):
                    self.OnSelectAllOnSelectAll(event)
                elif keycode == ord('B'):
                    self._navigate_to_matching_user_keyword_navigate_to_matching_user_keyword(
                        self.GetGridCursorRow(), self.GetGridCursorCol())
                elif keycode == ord('F'):
                    if not self.has_focushas_focus():
                        self.SetFocus()  # Avoiding Search field on Text Edit
                elif keycode in (ord('1'), ord('2'), ord('5')):
                    self._open_cell_editor_and_execute_variable_creator_open_cell_editor_and_execute_variable_creator(
                        list_variable=(keycode == ord('2')),
                        dict_variable=(keycode == ord('5')))
                elif keycode == ord('T'):
                        self._row_move_row_move(MoveRowsUp, 1, True)
                else:
                    self.show_cell_informationshow_cell_information()
        elif event.AltDown():
            if keycode == wx.WXK_SPACE:
                self._open_cell_editor_with_content_assist_open_cell_editor_with_content_assist()  # Mac CMD
            elif keycode in [wx.WXK_DOWN, wx.WXK_UP]:
                self._move_rows_move_rows(keycode)
            elif keycode == wx.WXK_RETURN:
                if self.IsCellEditControlShown():
                    event.GetEventObject().WriteText(linesep)
                else:
                    self._move_cursor_down_move_cursor_down(event)
                return  # event must not be skipped in this case
        else:
            if keycode == wx.WXK_WINDOWS_MENU:
                self.OnCellRightClickOnCellRightClickOnCellRightClick(event)
            elif keycode == wx.WXK_BACK:
                self._move_grid_cursor_move_grid_cursor(event, keycode)
            elif keycode == wx.WXK_RETURN:
                if self.IsCellEditControlShown():
                    self._move_grid_cursor_move_grid_cursor(event, keycode)
                else:
                    self._open_cell_editor_open_cell_editor()
                return  # event must not be skipped in this case
            elif keycode == wx.WXK_F2:
                self._open_cell_editor_open_cell_editor()
        event.Skip()
 
    def OnChar(self, event):
        keychar = event.GetUnicodeKey()
        if keychar < ord(' '):
            return
        if keychar in [ord('['), ord('{'), ord('('), ord("'"), ord('\"'), ord('`')]:
            self._open_cell_editor_open_cell_editor().execute_enclose_text(chr(keychar))
        else:
            event.Skip()
 
    def OnGoToDefinition(self, event):
        self._navigate_to_matching_user_keyword_navigate_to_matching_user_keyword(
            self.GetGridCursorRow(), self.GetGridCursorCol())
 
    def show_cell_information(self):
        cell = self.cell_under_cursorcell_under_cursorcell_under_cursor
        value = self._cell_value_cell_value(cell)
        if value:
            self._show_user_keyword_link_show_user_keyword_link(cell, value)
            self._show_keyword_details_show_keyword_details(cell, value)
 
    def _cell_value(self, cell):
        if cell == self._no_cell_no_cell:
            return None
        return self.GetCellValue(cell.Row, cell.Col)
 
    def _show_user_keyword_link(self, cell, value):
        if cell != self._marked_cell_marked_cell and self._plugin_plugin.get_user_keyword(value):
            self._toggle_underlined_toggle_underlined(cell)
            self._marked_cell_marked_cell = cell
 
    def _show_keyword_details(self, cell, value):
        details = self._plugin_plugin.get_keyword_details(value)
        if not details:
            info = self._controller_controller.get_cell_info(cell.Row, cell.Col)
            if info.cell_type == CellType.KEYWORD and info.content_type == \
                    ContentType.STRING:
                details = """\
        <b>Keyword was not detected by RIDE</b>
        <br>Possible corrections:<br>
        <ul>
            <li>Import library or resource file containing the keyword.</li>
            <li>For library import errors: Consider importing library spec XML
            (Tools / Import Library Spec XML or by adding the XML file with the
            correct name to PYTHONPATH) to enable keyword completion
            for example for Java libraries.
            Library spec XML can be created using libdoc tool from Robot Frame\
work.</li>
        </ul>"""
        if details:
            self._tooltips_tooltips.show_info_at(
                details, value, self._cell_to_screen_coordinates_cell_to_screen_coordinates(cell))
 
    def _cell_to_screen_coordinates(self, cell):
        point = self.CellToRect(cell.Row, cell.Col).GetTopRight()
        point.x += self.GetRowLabelSize() + 5
        return self.ClientToScreen(self.CalcScrolledPosition(point))
 
    def _move_rows(self, keycode):
        if keycode == wx.WXK_UP:
            self.OnMoveRowsUpOnMoveRowsUp()
        else:
            self.OnMoveRowsDownOnMoveRowsDown()
 
    def _move_grid_cursor(self, event, keycode):
        self.DisableCellEditControl()
        if keycode == wx.WXK_RETURN:
            self.MoveCursorRight(event.ShiftDown())
        else:
            self.MoveCursorLeft(event.ShiftDown())
 
    def move_grid_cursor_and_edit(self):
        # cell = self.cell_under_cursor()
        # self.MoveCursorRight(False)
        self._open_cell_editor_open_cell_editor()
 
    def OnKeyUp(self, event):
        event.Skip()  # DEBUG seen this skip as soon as possible
        self._tooltips_tooltips.hide()
        self._hide_link_if_necessary_hide_link_if_necessary()
        #  event.Skip()
 
    def _open_cell_editor(self):
        if not self.IsCellEditControlEnabled():
            self.EnableCellEditControl()
        row = self.GetGridCursorRow()
        celleditor = self.GetCellEditor(self.GetGridCursorCol(), row)
        celleditor.Show(True)
        return celleditor
 
    def _open_cell_editor_with_content_assist(self):
        # print(f"DEBUG: kweditor call _open_cell_editor_with_content_assist")
        wx.CallAfter(self._open_cell_editor_open_cell_editor().show_content_assist)
        # wx.CallAfter(self._move_grid_cursor, wx.grid.GridEvent(), wx.WXK_RETURN)
 
    def _open_cell_editor_and_execute_variable_creator(
            self, list_variable=False, dict_variable=False):
        wx.CallAfter(self._open_cell_editor_open_cell_editor().execute_variable_creator,
                     list_variable, dict_variable)
 
    def OnMakeVariable(self, event):
        self._open_cell_editor_and_execute_variable_creator_open_cell_editor_and_execute_variable_creator(list_variable=False)
 
    def OnMakeListVariable(self, event):
        self._open_cell_editor_and_execute_variable_creator_open_cell_editor_and_execute_variable_creator(list_variable=True)
 
    def OnMakeDictVariable(self, event):
        self._open_cell_editor_and_execute_variable_creator_open_cell_editor_and_execute_variable_creator(dict_variable=True)
 
    def _open_cell_editor_and_execute_sharp_comment(self):
        # Meant for a single cell selection!
        wx.CallAfter(self._open_cell_editor_open_cell_editor().execute_sharp_comment)
 
    def _open_cell_editor_and_execute_sharp_uncomment(self):
        # Meant for a single cell selection!
        wx.CallAfter(self._open_cell_editor_open_cell_editor().execute_sharp_uncomment)
 
    def OnCommentCells(self, event):
        self._open_cell_editor_and_execute_sharp_comment_open_cell_editor_and_execute_sharp_comment()
 
    def OnUncommentCells(self, event):
        self._open_cell_editor_and_execute_sharp_uncomment_open_cell_editor_and_execute_sharp_uncomment()
 
    def OnCellRightClick(self, event):
        self._tooltips_tooltips.hide()
        self._popup_menu_shown_popup_menu_shown_popup_menu_shown = True
        GridEditor.OnCellRightClick(self, event)
        self._popup_menu_shown_popup_menu_shown_popup_menu_shown = False
 
    def OnSelectAll(self, event):
        self.SelectAll()
 
    def OnCellColSizeChanged(self, event):
        wx.CallAfter(self.AutoSizeRows, False)
        event.Skip()
 
    def OnCellLeftClick(self, event):
        self._tooltips_tooltips.hide()
        if event.ControlDown():
            if self._navigate_to_matching_user_keyword_navigate_to_matching_user_keyword(event.Row, event.Col):
                return
        if not self._has_been_clicked_has_been_clicked:
            self.SetGridCursor(event.Row, event.Col)
            self._has_been_clicked_has_been_clicked = True
        else:
            event.Skip()
 
    def _navigate_to_matching_user_keyword(self, row, col):
        value = self.GetCellValue(row, col)
        uk = self._plugin_plugin.get_user_keyword(value)
        if uk:
            self._toggle_underlined_toggle_underlined((grid.GridCellCoords(row, col)))
            self._marked_cell_marked_cell = None
            wx.CallAfter(self._tree_tree.select_user_keyword_node, uk)
            return True
        return False
 
    def _is_active_window(self):
        return self.IsShownOnScreen() and self.FindFocus()
 
    def _hide_link_if_necessary(self):
        if not self._marked_cell_marked_cell:
            return
        self._toggle_underlined_toggle_underlined(self._marked_cell_marked_cell)
        self._marked_cell_marked_cell = None
 
    def OnCreateKeyword(self, event):
        cells = self._data_cells_from_current_row_data_cells_from_current_row()
        if not cells:
            return
        try:
            self._execute_execute(AddKeywordFromCells(cells))
        except ValueError as err:
            wx.MessageBox(str(err))
 
    def _data_cells_from_current_row(self):
        currow, curcol = self.selectionselection.cell
        rowdata = self._row_data_row_data(currow)[curcol:]
        return self._strip_trailing_empty_cells_strip_trailing_empty_cells(self._remove_comments_remove_comments(rowdata))
 
    def _remove_comments(self, data):
        for index, cell in enumerate(data):
            if cell.strip().startswith('#'):
                return data[:index]
        return data
 
    def OnExtractKeyword(self, event):
        dlg = UserKeywordNameDialog(self._controller_controller)
        if dlg.ShowModal() == wx.ID_OK:
            name, args = dlg.get_value()
            rows = self.selectionselection.topleft.row, self.selectionselection.bottomright.row
            self._execute_execute(ExtractKeyword(name, args, rows))
 
    def OnExtractVariable(self, event):
        cells = self.selectionselection.cells()
        if len(cells) == 1:
            self._extract_scalar_extract_scalar(cells[0])
        elif min(row for row, _ in cells) == max(row for row, _ in cells):
            self._extract_list_extract_list(cells)
        self._resize_grid_resize_grid()
 
    def OnFindWhereUsed(self, event):
        is_variable, searchstring = self._get_is_variable_and_searchstring_get_is_variable_and_searchstring()
        if searchstring:
            self._execute_find_where_used_execute_find_where_used(is_variable, searchstring)
 
    def _get_is_variable_and_searchstring(self):
        cellvalue = self.GetCellValue(*self.selectionselection.cells()[0])
        if self._cell_value_contains_multiple_search_items_cell_value_contains_multiple_search_items(cellvalue):
            choice_dialog = ChooseUsageSearchStringDialog(cellvalue)
            choice_dialog.ShowModal()
            is_var, value = choice_dialog.GetStringSelection()
            choice_dialog.Destroy()
            return is_var, value
        else:
            return variablematcher.is_variable(cellvalue), cellvalue
 
    def _execute_find_where_used(self, is_variable, searchstring):
        usages_dialog_class = VariableUsages if is_variable else Usages
        usages_dialog_class(
            self._controller_controller,
            self._tree_tree.highlight, searchstring).show()
 
    def _cell_value_contains_multiple_search_items(self, value):
        variables = variablematcher.find_variable_basenames(value)
        return variables and variables[0] != value
 
    def _extract_scalar(self, cell):
        var = robotapi.Variable(
            self._controller_controller.datafile.variable_table, '',
            self.GetCellValue(*cell), '')
        dlg = ScalarVariableDialog(
            self._controller_controller.datafile_controller.variables, var)
        if dlg.ShowModal() == wx.ID_OK:
            name, value = dlg.get_value()
            comment = dlg.get_comment()
            self._execute_execute(ExtractScalar(name, value, comment, cell))
 
    def _extract_list(self, cells):
        var = robotapi.Variable(
            self._controller_controller.datafile.variable_table,
            '', [self.GetCellValue(*cell) for cell in cells], '')
        dlg = ListVariableDialog(
            self._controller_controller.datafile_controller.variables, var, self._plugin_plugin)
        if dlg.ShowModal() == wx.ID_OK:
            name, value = dlg.get_value()
            comment = dlg.get_comment()
            self._execute_execute(ExtractList(name, value, comment, cells))
 
    def OnRenameKeyword(self, event):
        old_name = self._current_cell_value_current_cell_value()
        if not old_name.strip() or variablematcher.is_variable(old_name):
            return
        new_name = wx.GetTextFromUser('New name', 'Rename Keyword',
                                      default_value=old_name)
        if new_name:
            self._execute_execute(RenameKeywordOccurrences(
                old_name, new_name, RenameProgressObserver(self.GetParent())))
 
    # Add one new Dialog to edit pretty json String TODO: use better editor with more functions
    def OnJsonEditor(self, event=None):
        if event:
            event.Skip()
        dialog = RIDEDialog()
        dialog.SetTitle('JSON Editor')
        dialog.SetSizer(wx.BoxSizer(wx.HORIZONTAL))
        okBtn = wx.Button(dialog, wx.ID_OK, "Save")
        cnlBtn = wx.Button(dialog, wx.ID_CANCEL, "Cancel")
        richText = wx.TextCtrl(dialog, wx.ID_ANY, "If supported by the native "
                                                  "control, this is reversed, "
                                                  "and this is a different "
                                                  "font.",
                               size=(400, 475),
                               style=wx.HSCROLL | wx.TE_MULTILINE | wx.TE_NOHIDESEL)
        dialog.Sizer.Add(richText, flag=wx.GROW, proportion=1)
        dialog.Sizer.Add(okBtn, flag=wx.ALL)
        dialog.Sizer.Add(cnlBtn, flag=wx.ALL)
        # Get cell value of parent grid
        if self.is_jsonis_json(self._current_cell_value_current_cell_value()):
            jsonStr = json.loads(self._current_cell_value_current_cell_value())
            richText.SetValue(
                json.dumps(jsonStr, indent=4, ensure_ascii=False))
        else:
            richText.SetValue(self._current_cell_value_current_cell_value())
        dialog.SetSize((650, 550))
        # If click Save, then save the value in richText into the original
        # grid cell, and clear all indent.
        if dialog.ShowModal() == wx.ID_OK:
            content = richText.GetValue()
            if self.is_jsonis_json(content):
                strJson = json.loads(content)
                self.cell_value_editedcell_value_edited(self.selectionselection.cell[0], self.selectionselection.cell[1],
                                       json.dumps(strJson, ensure_ascii=False))
            else:
                try:
                    json.loads(content)  # Yes, we need the error
                except JSONDecodeError as e:
                        res = wx.MessageDialog(dialog,
                                               f"Error in JSON: {e}\n\n"
                                               "Save anyway?",
                                               "Validation Error!",
                                               wx.YES_NO)
                        res.InheritAttributes()
                        response = res.ShowModal()
                        if response == wx.ID_YES:
                            self.cell_value_editedcell_value_edited(self.selectionselection.cell[0],
                                                   self.selectionselection.cell[1],
                                                   richText.GetValue())
                        else:
                            pass
 
    # If the jsonStr is json format, then return True
    def is_json(self, jsonStr):
        try:
            json.loads(jsonStr)
        except JSONDecodeError:
            return False
        return True
 
 
class ContentAssistCellEditor(GridCellEditor):
 
    def __init__(self, plugin, controller):
        self.settingssettings = plugin.global_settings['Grid']
        self.general_settingsgeneral_settings = plugin.global_settings['General']
        self.color_background_helpcolor_background_help = self.general_settingsgeneral_settings['background help']
        self.color_foreground_textcolor_foreground_text = self.general_settingsgeneral_settings['foreground text']
        GridCellEditor.__init__(self)
        self._plugin_plugin = plugin
        self._controller_controller = controller
        self._grid_grid = None
        self._original_value_original_value = None
        self._value_value = None
        self._tc_tc = None
        self._counter_counter = 0
 
    def show_content_assist(self, args=None):
        if self._tc_tc:
            self._tc_tc.show_content_assist()
 
    def execute_variable_creator(self, list_variable=False,
                                 dict_variable=False):
        self._tc_tc.execute_variable_creator(list_variable, dict_variable)
 
    def execute_enclose_text(self, keycode):
        self._tc_tc.execute_enclose_text(keycode)
 
    def execute_sharp_comment(self):
        self._tc_tc.execute_sharp_comment()
 
    def execute_sharp_uncomment(self):
        self._tc_tc.execute_sharp_uncomment()
 
    def Create(self, parent, id, evthandler):
        self._tc_tc = ExpandingContentAssistTextCtrl(
            parent, self._plugin_plugin, self._controller_controller)
        self.SetControl(self._tc_tc)
        if evthandler:
            self._tc_tc.PushEventHandler(evthandler)
 
    def SetSize(self, rect):
        self._tc_tc.SetSize(rect.x, rect.y, rect.width + 2, rect.height + 2, wx.SIZE_ALLOW_MINUS_ONE)
 
    def SetHeight(self, height):
        self._height_height = height
 
    def BeginEdit(self, row, col, grid):
        self._counter_counter = 0
        self._tc_tc.SetSize((-1, self._height_height))
        self._tc_tc.SetBackgroundColour(self.color_background_helpcolor_background_help)  # DEBUG: We are now in Edit mode
        self._tc_tc.SetForegroundColour(self.color_foreground_textcolor_foreground_text)
        self._tc_tc.set_row(row)
        self._original_value_original_value = grid.GetCellValue(row, col)
        self._tc_tc.SetValue(self._original_value_original_value)
        self._tc_tc.SetSelection(0, self._tc_tc.GetLastPosition())
        self._tc_tc.SetFocus()
        self._grid_grid = grid
 
    def EndEdit(self, row, col, grid, *ignored):
        value = self._get_value_get_value()
        if value != self._original_value_original_value:
            self._value_value = value
            # print(f"DEBUG: kweditor returning ContentAssistCellEditor.EndEdit {value} and moving right")
            wx.CallAfter(self._grid_grid.move_grid_cursor_and_edit)
            return value
        else:
            self._tc_tc.hide()
            grid.SetFocus()
 
    def ApplyEdit(self, row, col, grid):
        val = self._tc_tc.GetValue()
        grid.GetTable().SetValue(row, col, val)  # update the table
        self._original_value_original_value = ''
        self._tc_tc.SetValue('')
        # if self._value and val != '':  # DEBUG Fix #1967 crash when click other cell
        # this will cause deleting all text in edit mode not working
        self._grid_grid.cell_value_edited(row, col, self._value_value)
 
    def _get_value(self):
        suggestion = self._tc_tc.content_assist_value()
        return suggestion or self._tc_tc.GetValue()
 
    def Reset(self):
        self._tc_tc.SetValue(self._original_value_original_value)
        self._tc_tc.reset()
 
    def StartingKey(self, event):
        key = event.GetKeyCode()
        event.Skip()  # DEBUG seen this skip as soon as possible
        if key == wx.WXK_DELETE or key > 255:
            # print(f"DEBUG: Delete key at ContentAssist key {key}")
            self._grid_grid.HideCellEditControl()
        elif key == wx.WXK_BACK:
            self._tc_tc.SetValue(self._original_value_original_value)
        else:
            self._tc_tc.SetValue(chr(key))
        self._tc_tc.SetFocus()
        self._tc_tc.SetInsertionPointEnd()
 
    def Clone(self):
        return ContentAssistCellEditor()
 
 
class ChooseUsageSearchStringDialog(wx.Dialog):
 
    def __init__(self, cellvalue):
        wx.Dialog.__init__(self, None, wx.ID_ANY, "Find Where Used",
                           style=wx.DEFAULT_DIALOG_STYLE)
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        """
        self.captioncaption = "Please select what you want to check for usage"
        variables = set(variablematcher.find_variable_basenames(cellvalue))
        self.choiceschoices = [(False, cellvalue)] + [(True, v) for v in variables]
        self.choices_stringchoices_string = ["Complete cell content"] + \
                              ["Variable " + var.replace("&", "&&") for var
                               in variables]
        self._build_ui_build_ui()
 
    def _build_ui(self):
        self.radiobox_choicesradiobox_choices = wx.RadioBox(
            self, choices=self.choices_stringchoices_string, style=wx.RA_SPECIFY_COLS,
            majorDimension=1)
        sizer = wx.BoxSizer(wx.VERTICAL)
        sizer.Add(wx.StaticText(self, label=self.captioncaption), 0, wx.ALL |
                  wx.EXPAND, 5)
        sizer.Add(self.radiobox_choicesradiobox_choices, 0, wx.ALL | wx.EXPAND, 5)
        sizer.Add(wx.Button(self, wx.ID_OK, label="Search"),
                  0, wx.ALL | wx.ALIGN_CENTER, 5)
        big_sizer = wx.BoxSizer(wx.VERTICAL)
        big_sizer.Add(sizer, 0, wx.ALL, 10)
        self.SetSizer(big_sizer)
        self.Fit()
        self.CenterOnParent()
 
    def GetStringSelection(self):
        return self.choiceschoices[self.radiobox_choicesradiobox_choices.GetSelection()]