actioninfo.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 re
 
import wx
 
from ..widgets import ImageProvider
from .shortcut import Shortcut
 
 
 
def ActionInfoCollection(data, event_handler, container=None):
 
    menu = None
    actions = []
    for row in data.splitlines():
        row = row.strip()
        if not row:
            continue
        elif row.startswith('[') and row.endswith(']'):
            menu = row[1:-1].strip()
        else:
            actions.append(_create_action_info(event_handler, menu, container, row))
    return actions
 
 
def _create_action_info(eventhandler, menu, container, row):
    if row.startswith('---'):
        return SeparatorInfo(menu)
    tokens = [t.strip() for t in row.split('|')]
    tokens += [''] * (5-len(tokens))
    name, doc, shortcut, icon, position = tokens
    if name.startswith('!'):
        name = name[1:]
        container = None
    eventhandler_name, name = _get_eventhandler_name_and_parsed_name(name)
    action = getattr(eventhandler, eventhandler_name)
    return ActionInfo(menu, name, action, container, shortcut, icon, doc, position)
 
 
def _get_eventhandler_name_and_parsed_name(name):
    eventhandler_name, name = _parse_shortcuts_from_name(name)
    return 'On%s' % eventhandler_name.replace(' ', '').replace('&', ''), name
 
 
def _parse_shortcuts_from_name(name):
    if '(' in name:
        eventhandler_name, shortcuts = name.split('(', 1)
        shortcuts = shortcuts.split(')')[0]
        elements = shortcuts.split(' or ')
        name = '%s (%s)' % (eventhandler_name, ' or '.join(Shortcut(e).printable for e in
                                                           elements))
        return eventhandler_name, name
    return name, name
 
 
 
class MenuInfo():
 
    def __init__(self):
        self.insertion_pointinsertion_point = _InsertionPoint()
 
    def is_separator(self):
        return False
 
    
    def set_menu_position(self, before=None, after=None):
        self.insertion_pointinsertion_point = _InsertionPoint(before, after)
 
 
 
class ActionInfo(MenuInfo):
 
    
    def __init__(self, menu_name, name, action=None, container=None,
                 shortcut=None, icon=None, doc='', position=-1):
        MenuInfo.__init__(self)
        self.menu_namemenu_name = menu_name
        self.namename = name
        self.actionaction = action
        self.containercontainer = container
        self.shortcutshortcut = Shortcut(shortcut)
        self._icon_icon = None
        self._icon_source_icon_source = icon
        self.docdoc = doc
        self._position_position = position
 
    @property
    icon = property
    
    def icon(self):
        if not self._icon_icon:
            self._icon_icon = self._get_icon_get_icon()
        return self._icon_icon
 
    def _get_icon(self):
        if not self._icon_source_icon_source:
            return None
        if isinstance(self._icon_source_icon_source, str):
            if self._icon_source_icon_source.startswith("CUSTOM_"):
                return ImageProvider().get_image_by_name(self._icon_source_icon_source[len("CUSTOM_"):])
            return wx.ArtProvider.GetBitmap(getattr(wx, self._icon_source_icon_source),
                                            wx.ART_TOOLBAR, (16, 16))
        return self._icon_source_icon_source
 
    @property
    position = property
    
    def position(self):
        if isinstance(self._position_position, int):
            return self._position_position
        elif isinstance(self._position_position, str):
            if len(self._position_position) > 0:
                return int(self._position_position.split("POSITION-")[-1])
        return -1
 
 
class SeparatorInfo(MenuInfo):
 
    
    def __init__(self, menu_name):
        MenuInfo.__init__(self)
        self.menu_namemenu_name = menu_name
 
    def is_separator(self):
        return True
 
 
class _InsertionPoint():
    
    _shortcut_remover = re.compile(' {2,}\‍([^()]+\‍)$')
 
    def __init__(self, before=None, after=None):
        self._item_item = before or after
        self._insert_before_insert_before = before is not None
 
    def get_index(self, menu):
        if not self._item_item:
            return menu.GetMenuItemCount()
        index = self._find_position_in_menu_find_position_in_menu(menu)
        if not index:
            return menu.GetMenuItemCount()
        if not self._insert_before_insert_before:
            index += 1
        return index
 
    def _find_position_in_menu(self, menu):
        for index in range(0, menu.GetMenuItemCount()):
            item = menu.FindItemByPosition(index)
            if self._get_menu_item_name_get_menu_item_name(item).lower() == self._item_item.lower():
                return index
        return None
 
    def _get_menu_item_name(self, item):
        if wx.VERSION < (4, 1, 0):
            return self._shortcut_remover_shortcut_remover.split(item.GetLabel())[0]
        return self._shortcut_remover_shortcut_remover.split(item.GetItemLabel())[0]