contentassist.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.
 
from os.path import relpath, dirname, isdir
from sys import platform
 
import wx
from wx import Colour
from wx.lib.expando import ExpandoTextCtrl
from wx.lib.filebrowsebutton import FileBrowseButton
 
from .. import context, utils
from ..context import IS_MAC
from ..namespace.suggesters import SuggestionSource
from ..spec.iteminfo import VariableInfo
from .popupwindow import RidePopupWindow, HtmlPopupWindow
 
 
_PREFERRED_POPUP_SIZE = (400, 200)
 
 
class _ContentAssistTextCtrlBase():
 
    def __init__(self, suggestion_source):
        from ..preferences import RideSettings
        
        _settings = RideSettings()
        self.general_settingsgeneral_settings = _settings['General']
        self.color_backgroundcolor_background = self.general_settingsgeneral_settings['background']
        self.color_foregroundcolor_foreground = self.general_settingsgeneral_settings['foreground']
        self.color_secondary_backgroundcolor_secondary_background = self.general_settingsgeneral_settings['secondary background']
        self.color_secondary_foregroundcolor_secondary_foreground = self.general_settingsgeneral_settings['secondary foreground']
        self.color_background_helpcolor_background_help = self.general_settingsgeneral_settings['background help']
        self.color_foreground_textcolor_foreground_text = self.general_settingsgeneral_settings['foreground text']
        self._popup_popup = ContentAssistPopup(self, suggestion_source)
        self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDownOnKeyDown)
        self.Bind(wx.EVT_CHAR, self.OnCharOnChar)
        self.Bind(wx.EVT_KILL_FOCUS, self.OnFocusLostOnFocusLost)
        self.Bind(wx.EVT_MOVE, self.OnFocusLostOnFocusLost)
        self.Bind(wx.EVT_WINDOW_DESTROY, self.OnDestroyOnDestroy)
        self._showing_content_assist_showing_content_assist = False
        self._row_row = None
        self.gherkin_prefixgherkin_prefix = ''  # Store gherkin prefix from input to add \
        # later after search is performed
        if IS_MAC:
            self.OSXDisableAllSmartSubstitutions()
 
    def set_row(self, row):
        self._row_row = row
 
    def OnKeyDown(self, event):
        # TODO: This might benefit from some cleanup
        keycode, control_down = event.GetKeyCode(), event.CmdDown()
        # Ctrl-Space handling needed for dialogs # DEBUG add Ctrl-m
        if (control_down or event.AltDown()) and keycode in [wx.WXK_SPACE, ord('m')]:
            self.show_content_assistshow_content_assist()
        elif keycode == wx.WXK_RETURN and self._popup_popup.is_shown():
            self.OnFocusLostOnFocusLost(event)
        elif keycode == wx.WXK_TAB:
            self.OnFocusLostOnFocusLost(event, False)
        elif keycode == wx.WXK_ESCAPE and self._popup_popup.is_shown():
            self._popup_popup.hide()
        elif keycode in [wx.WXK_UP, wx.WXK_DOWN, wx.WXK_PAGEUP, wx.WXK_PAGEDOWN] \
                and self._popup_popup.is_shown():
            self._popup_popup.select_and_scroll(keycode)
        elif keycode in (ord('1'), ord('2'), ord('5')) and event.ControlDown() and not \
                event.AltDown():
            self.execute_variable_creatorexecute_variable_creator(list_variable=(keycode == ord('2')),
                                          dict_variable=(keycode == ord('5')))
        elif keycode == ord('3') and event.ControlDown() and event.ShiftDown() \
                and not event.AltDown():
            self.execute_add_text(add_text='# ', on_the_left=True, on_the_right=False)
        elif keycode == ord('4') and event.ControlDown() and event.ShiftDown() \
                and not event.AltDown():
            self.execute_remove_text(remove_text='# ', on_the_left=True, on_the_right=False)
        elif self._popup_popup.is_shown() and keycode < 256:
            wx.CallAfter(self._populate_content_assist_populate_content_assist)
            event.Skip()
        else:
            event.Skip()
 
    def OnChar(self, event):
        keychar = event.GetUnicodeKey()
        # print(f"DEBUG: OnChar at contentassist {chr(keychar)} {keychar}")
        if keychar == wx.WXK_NONE:
            event.Skip()
            return
        if keychar in [ord('['), ord('{'), ord('('), ord("'"), ord('\"'), ord('`')]:
            # TODO fix recursion error in Linux
            if platform.lower().startswith('linux'):
                event.Skip()
            else:
                self.execute_enclose_textexecute_enclose_text(chr(keychar))
        else:
            event.Skip()
 
    def execute_variable_creator(self, list_variable=False, dict_variable=False):
        from_, to_ = self.GetSelection()
        if list_variable:
            symbol = '@'
        elif dict_variable:
            symbol = '&'
        else:
            symbol = '$'
        self.SetValue(self._variable_creator_value_variable_creator_value(
            self.Value, symbol, from_, to_))
        if from_ == to_:
            self.SetInsertionPoint(from_ + 2)
        else:
            self.SetInsertionPoint(to_ + 3)
            self.SetSelection(from_ + 2, to_ + 2)
 
    def _variable_creator_value(self, value, symbol, from_, to_):
        return value[:from_]+symbol+'{'+value[from_:to_]+'}'+value[to_:]
 
    def execute_enclose_text(self, keycode):
        # TODO move this code to kweditor and fix when in cell editor in Linux
        from_, to_ = self.GetSelection()
        self.SetValue(self._enclose_text_enclose_text(self.Value, keycode, from_, to_))
        elem = self
        if from_ == to_:
            elem.SetInsertionPoint(from_ + 1)
        else:
            elem.SetInsertionPoint(to_ + 2)
            elem.SetSelection(from_ + 1, to_ + 1)
 
    def _enclose_text(self, value, open_symbol, from_, to_):
        if open_symbol == '[':
            close_symbol = ']'
        elif open_symbol == '{':
            close_symbol = '}'
        elif open_symbol == '(':
            close_symbol = ')'
        else:
            close_symbol = open_symbol
        return value[:from_]+open_symbol+value[from_:to_]+close_symbol+value[to_:]
 
    def execute_sharp_comment(self):
        # Todo: Will only comment the left top cell for a multi cell select block!
        from_, to_ = self.GetSelection()
        #print(f"DEBUG: value from/to: " + str(from_) + " " + str(to_))
        #print(f"DEBUG: value selected: " + self.Value)
        add_text = '# '
        self.SetValue(self._add_text_add_text(self.Value, add_text, True, False, from_, to_))
        lenadd = len(add_text)
        elem = self
        elem.SetInsertionPoint(from_ + lenadd)
        if from_ != to_:
            elem.SetInsertionPoint(to_ + lenadd)
            elem.SetSelection(from_ + lenadd, to_ + lenadd)
            return
 
    @staticmethod
    def _add_text(value, add_text, on_the_left, on_the_right, from_, to_):
        if on_the_left and on_the_right:
            return value[:from_]+add_text+value[from_:to_]+add_text+value[to_:]
        if on_the_left:
            return value[:from_]+add_text+value[from_:to_]+value[to_:]
        if on_the_right:
            return value[:from_]+value[from_:to_]+add_text+value[to_:]
        return value
 
    def execute_sharp_uncomment(self):
        # Todo: Will only uncomment the left top cell for a multi cell select block!
        from_, to_ = self.GetSelection()
        lenold = len(self.Value)
        self.SetValue(self._remove_text_remove_text(self.Value, '# ', True, False, from_, to_))
        lenone = len(self.Value)
        diffone = lenold - lenone
        elem = self
        if from_ == to_:
            elem.SetInsertionPoint(from_ - diffone)
        else:
            elem.SetInsertionPoint(to_ - diffone)
            elem.SetSelection(from_ - diffone, to_ - diffone)
 
    def _remove_text(self, value, remove_text, on_the_left, on_the_right, from_, to_):
        if on_the_left and on_the_right:
            return value[:from_]+value[from_:to_].strip(remove_text)+remove_text+value[to_:]
        if on_the_left:
            return value[:from_]+value[from_:to_].lstrip(remove_text)+value[to_:]
        if on_the_right:
            return value[:from_]+value[from_:to_].rstrip(remove_text)+value[to_:]
        return value
 
    def OnFocusLost(self, event, set_value=True):
        event.Skip()
        if not self._popup_popup.is_shown():
            return
        if self.gherkin_prefixgherkin_prefix:
            value = self.gherkin_prefixgherkin_prefix + self._popup_popup.get_value() or self.GetValue()
        else:
            value = self._popup_popup.get_value() or self.GetValue()
        if set_value and value:
            self.SetValue(value)
            self.SetInsertionPoint(len(value))  # DEBUG was self.Value
        else:
            self.Clear()
        self.hidehide()
 
    def OnDestroy(self, event):
        # all pushed eventHandlers need to be popped before close
        # the last event handler is window object itself - do not pop itself
        while self.GetEventHandler() is not self:
            self.PopEventHandler()
 
    def reset(self):
        self._popup_popup.reset()
        self._showing_content_assist_showing_content_assist = False
 
    def show_content_assist(self):
        if self._showing_content_assist_showing_content_assist:
            return
        self._showing_content_assist_showing_content_assist = True
        if self._populate_content_assist_populate_content_assist():
            self._show_content_assist_show_content_assist()
 
    def _populate_content_assist(self):
        value = self.GetValue()
        (self.gherkin_prefixgherkin_prefix, value) = self._remove_bdd_prefix_remove_bdd_prefix(value)
        return self._popup_popup.content_assist_for(value, row=self._row_row)
 
    def _remove_bdd_prefix(self, name):
        for match in ['given ', 'when ', 'then ', 'and ', 'but ']:
            if name.lower().startswith(match):
                return name[:len(match)], name[len(match):]
        return '', name
 
    def _show_content_assist(self):
        _, height = self.GetSize()
        x, y = self.ClientToScreen((0, 0))
        self._popup_popup.show(x, y, height)
 
    def content_assist_value(self):
        suggestion = self._popup_popup.content_assist_value(self.Value)
        if suggestion is None:
            return suggestion
        else:
            return self.gherkin_prefixgherkin_prefix + suggestion
 
    def hide(self):
        self._popup_popup.hide()
        self._showing_content_assist_showing_content_assist = False
 
 
class ExpandingContentAssistTextCtrl(_ContentAssistTextCtrlBase,
                                     ExpandoTextCtrl):
 
    def __init__(self, parent, plugin, controller):
        ExpandoTextCtrl.__init__(self, parent, size=wx.DefaultSize,
                                 style=wx.WANTS_CHARS|wx.TE_NOHIDESEL)
        _ContentAssistTextCtrlBase.__init__(self, SuggestionSource(plugin, controller))
        self.SetBackgroundColour(context.POPUP_BACKGROUND)
        # self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(context.POPUP_FOREGROUND)
        # self.SetOwnForegroundColour(Colour(7, 0, 70))
 
 
class ContentAssistTextCtrl(_ContentAssistTextCtrlBase, wx.TextCtrl):
 
    def __init__(self, parent, suggestion_source, size=wx.DefaultSize):
        wx.TextCtrl.__init__(self, parent, size=size, style=wx.WANTS_CHARS|wx.TE_NOHIDESEL)
        _ContentAssistTextCtrlBase.__init__(self, suggestion_source)
        self.SetBackgroundColour(Colour(self.color_background_helpcolor_background_help))
        self.SetOwnBackgroundColour(Colour(self.color_background_helpcolor_background_help))
        self.SetForegroundColour(Colour(self.color_foreground_textcolor_foreground_text))
        self.SetOwnForegroundColour(Colour(self.color_foreground_textcolor_foreground_text))
 
 
class ContentAssistTextEditor(_ContentAssistTextCtrlBase, wx.TextCtrl):
 
    def __init__(self, parent, suggestion_source, pos, size=wx.DefaultSize):
        wx.TextCtrl.__init__(self, parent, -1, "", pos, size=size, style=wx.WANTS_CHARS|wx.BORDER_NONE|wx.WS_EX_TRANSIENT|wx.TE_PROCESS_ENTER|wx.TE_NOHIDESEL)
        _ContentAssistTextCtrlBase.__init__(self, suggestion_source)
        self.SetBackgroundColour(Colour(self.color_background_helpcolor_background_help))
        self.SetOwnBackgroundColour(Colour(self.color_background_helpcolor_background_help))
        self.SetForegroundColour(Colour(self.color_foreground_textcolor_foreground_text))
        self.SetOwnForegroundColour(Colour(self.color_foreground_textcolor_foreground_text))
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        self.SetOwnForegroundColour(Colour(7, 0, 70))
        """
 
 
class ContentAssistFileButton(_ContentAssistTextCtrlBase, FileBrowseButton):
 
    def __init__(self, parent, suggestion_source, label, controller,
                 size=wx.DefaultSize):
        FileBrowseButton.__init__(self, parent, labelText=label,
                                  size=size, fileMask="*",
                                  changeCallback=self.OnFileChangedOnFileChanged)
        self._parent_parent = parent
        self._controller_controller = controller
        self._browsed_browsed = False
        _ContentAssistTextCtrlBase.__init__(self, suggestion_source)
        self.SetBackgroundColour(Colour(context.POPUP_BACKGROUND))
        self.SetOwnBackgroundColour(Colour(context.POPUP_BACKGROUND))
        self.SetForegroundColour(Colour(context.POPUP_FOREGROUND))
        self.SetOwnForegroundColour(Colour(context.POPUP_FOREGROUND))
 
    def Bind(self, *args):
        self.textControl.Bind(*args)
 
    def __getattr__(self, item):
        return getattr(self.textControl, item)
 
    def OnBrowse(self, evt=None):
        self._browsed_browsed = True
        FileBrowseButton.OnBrowse(self, evt)
        self._browsed_browsed = False
 
    def OnDestroy(self, event):
        # all pushed eventHandlers need to be popped before close
        # the last event handler is window object itself - do not pop itself
        try:
            while self.GetEventHandler() is not self:
                self.PopEventHandler()
        except RuntimeError:
            pass
 
    def OnFileChanged(self, evt):
        if self._browsed_browsed:
            self._browsed_browsed = False
            self.SetValue(self._relative_path_relative_path(self.GetValue()))
            self._parent_parent.setFocusToOK()
 
    def _relative_path(self, value):
        src = self._controller_controller.datafile.source
        if utils.is_same_drive(src, value):
            path = relpath(value, src if isdir(src) else dirname(src))
        else:
            path = value
        return path.replace('\\', '/') if context.IS_WINDOWS else\
            path.replace('\\', '\\\\')
 
 
class Suggestions():
 
    def __init__(self, suggestion_source):
        self._suggestion_source_suggestion_source = suggestion_source
        self._previous_value_previous_value = None
        self._previous_choices_previous_choices = []
 
    def get_for(self, value, row=None):
        self._previous_choices_previous_choices = self._get_choices_get_choices(value, row)
        self._previous_value_previous_value = value
        return [k for k, _ in self._previous_choices_previous_choices]
 
    def get_item(self, name):
        for k, v in self._previous_choices_previous_choices:
            if k == name:
                return v
        raise Exception('Item not in choices "%s"' % (name))
 
    def _get_choices(self, value, row):
        if self._previous_value_previous_value and value.startswith(self._previous_value_previous_value):
            return [(key, val) for key, val in self._previous_choices_previous_choices
                    if utils.normalize(key).startswith(utils.normalize(value))]
        choices = self._suggestion_source_suggestion_source.get_suggestions(value, row)
        duplicate_names = self._get_duplicate_names_get_duplicate_names(choices)
        return self._format_choices_format_choices(choices, value, duplicate_names)
 
    def _get_duplicate_names(self, choices):
        results = set()
        normalized_names = [utils.normalize(ch.name) for ch in choices]
        for choice in choices:
            normalized = utils.normalize(choice.name)
            if normalized_names.count(normalized) > 1:
                results.add(normalized)
        return results
 
    def _format_choices(self, choices, prefix, duplicate_names):
        return [(self._format_format(val, prefix, duplicate_names), val) for val in
                choices]
 
    def _format(self, choice, prefix, duplicate_names):
        return choice.name if self._matches_unique_shortname_matches_unique_shortname(
            choice, prefix, duplicate_names) else choice.longname
 
    def _matches_unique_shortname(self, choice, prefix, duplicate_names):
        if isinstance(choice, VariableInfo):
            return True
        if not utils.normalize(choice.name).startswith(
                utils.normalize(prefix)):
            return False
        if utils.normalize(choice.name) in duplicate_names:
            return False
        return True
 
 
class ContentAssistPopup():
 
    def __init__(self, parent, suggestion_source):
        self._parent_parent = parent
        self._main_popup_main_popup = RidePopupWindow(parent, _PREFERRED_POPUP_SIZE)
        self._details_popup_details_popup = HtmlPopupWindow(parent, _PREFERRED_POPUP_SIZE)
        self._selection_selection = -1
        self._list_list = ContentAssistList(self._main_popup_main_popup,
                                       self.OnListItemSelectedOnListItemSelected,
                                       self.OnListItemActivatedOnListItemActivated)
        self._suggestions_suggestions = Suggestions(suggestion_source)
 
    def reset(self):
        self._selection_selection = -1
 
    def get_value(self):
        return self._selection_selection != -1 and self._list_list.get_text(
            self._selection_selection) or None
 
    def content_assist_for(self, value, row=None):
        self._choices_choices = self._suggestions_suggestions.get_for(value, row=row)
        if not self._choices_choices:
            self._list_list.ClearAll()
            self._parent_parent.hide()
            return False
        self._list_list.populate(self._choices_choices)
        return True
 
    def _starts(self, val1, val2):
        return val1.lower().startswith(val2.lower())
 
    def content_assist_value(self, value):
        if self._selection_selection > -1:
            return self._list_list.GetItem(self._selection_selection).GetText()
        return None
 
    def show(self, xcoord, ycoord, cell_height):
        self._main_popup_main_popup.SetPosition((xcoord,
                                      self._move_y_where_room_move_y_where_room(ycoord,
                                                              cell_height)))
        self._details_popup_details_popup.SetPosition((self._move_x_where_room_move_x_where_room(xcoord),
                                         self._move_y_where_room_move_y_where_room(ycoord,
                                                                 cell_height)))
        self._main_popup_main_popup.Show()
        self._list_list.SetFocus()
 
    def _move_x_where_room(self, start_x):
        width = _PREFERRED_POPUP_SIZE[0]
        max_horizontal = wx.GetDisplaySize()[0]
        free_right = max_horizontal - start_x - width
        free_left = start_x - width
        if max_horizontal - start_x < 2 * width:
            if free_left > free_right:
                return start_x - width
        return start_x + width
 
    def _move_y_where_room(self, start_y, cell_height):
        height = _PREFERRED_POPUP_SIZE[1]
        max_vertical = wx.GetDisplaySize()[1]
        if max_vertical - start_y - cell_height < height:
            return start_y - height
        return start_y + cell_height
 
    def is_shown(self):
        return self._main_popup_main_popup.IsShown()
 
    def select_and_scroll(self, keycode):
        sel = self._list_list.GetFirstSelected()
        if keycode == wx.WXK_DOWN:
            if sel < (self._list_list.GetItemCount() - 1):
                self._select_and_scroll_select_and_scroll(sel + 1)
            else:
                self._select_and_scroll_select_and_scroll(0)
        elif keycode == wx.WXK_UP:
            if sel > 0:
                self._select_and_scroll_select_and_scroll(sel - 1)
            else:
                self._select_and_scroll_select_and_scroll(self._list_list.GetItemCount() - 1)
        elif keycode == wx.WXK_PAGEDOWN:
            if self._list_list.ItemCount - self._selection_selection > 14:
                self._select_and_scroll_select_and_scroll(self._selection_selection + 14)
            else:
                self._select_and_scroll_select_and_scroll(self._list_list.ItemCount - 1)
        elif keycode == wx.WXK_PAGEUP:
            if self._selection_selection > 14:
                self._select_and_scroll_select_and_scroll(self._selection_selection - 14)
            else:
                self._select_and_scroll_select_and_scroll(0)
 
    def _select_and_scroll(self, selection):
        self._selection_selection = selection
        self._list_list.Select(self._selection_selection)
        self._list_list.EnsureVisible(self._selection_selection)
        value = self.get_valueget_value()
        if value:
            self._parent_parent.SetValue(value)
 
    def hide(self):
        self._selection_selection = -1
        self._main_popup_main_popup.Show(False)
        self._details_popup_details_popup.Show(False)
 
    def OnListItemActivated(self, event):
        self._parent_parent.OnFocusLost(event)
 
    def OnListItemSelected(self, event):
        self._selection_selection = event.GetIndex()
        item = self._suggestions_suggestions.get_item(event.GetText())
        if item.details:
            self._details_popup_details_popup.Show()
            self._details_popup_details_popup.set_content(item.details, item.name)
        elif self._details_popup_details_popup.IsShown():
            self._details_popup_details_popup.Show(False)
 
 
class ContentAssistList(wx.ListCtrl):
 
    def __init__(self, parent, selection_callback, activation_callback=None):
        from ..preferences import RideSettings
        
        _settings = RideSettings()
        self.general_settingsgeneral_settings = _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']
        style = wx.LC_REPORT | wx.LC_SINGLE_SEL | wx.LC_NO_HEADER
        wx.ListCtrl.__init__(self, parent, style=style)
        self._selection_callback_selection_callback = selection_callback
        self._activation_callback_activation_callback = activation_callback
        self.SetSize(parent.GetSize())
        self.SetBackgroundColour(self.color_background_helpcolor_background_help)
        self.SetForegroundColour(self.color_foreground_textcolor_foreground_text)
        self.Bind(wx.EVT_LIST_ITEM_SELECTED, selection_callback)
        self.Bind(wx.EVT_LIST_ITEM_ACTIVATED, activation_callback)
 
    def populate(self, data):
        self.ClearAll()
        self.InsertColumn(0, '', width=self.Size[0])
        for row, item in enumerate(data):
            self.InsertItem(row, item)
        self.Select(0)
 
    def get_text(self, index):
        return self.GetItem(index).GetText()