usagesdialog.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 wx
 
from wx import Colour
from ..widgets import RIDEDialog, VirtualList, VerticalSizer, ImageList, ImageProvider, ButtonWithHandler
from ..widgets.list import ListModel
 
class UsagesDialog(RIDEDialog):
 
    def __init__(self, name, usages=None):
        self._name_name = name
        self._selection_listeners_selection_listeners = []
        title = "'%s'" % (name)
        RIDEDialog.__init__(self, title=title, size=(650, 400))
        # set Left to Right direction (while we don't have localization)
        self.SetLayoutDirection(wx.Layout_LeftToRight)
        self.SetSizer(VerticalSizer())
        self.SetBackgroundColour(Colour(self.color_background))
        self.SetForegroundColour(Colour(self.color_foreground))
        self._add_view_components_add_view_components()
        self.usagesusages = usages or UsagesListModel([])
        self.usage_listusage_list = VirtualList(self, self.usagesusages.headers,
                                      self.usagesusages)
        self.usage_listusage_list.SetBackgroundColour(Colour(self.color_secondary_background))
        self.usage_listusage_list.SetForegroundColour(Colour(self.color_secondary_foreground))
        self.usage_listusage_list.add_selection_listener(self._usage_selected_usage_selected)
        self.Sizer.add_expanding(self.usage_listusage_list)
 
    def add_usage(self, usage):
        self.usagesusages.add_usage(usage)
 
    def begin_searching(self):
        from ..ui.searchdots import DottedSearch
        self._dots_dots = DottedSearch(self, self._update_searching_update_searching)
        self._dots_dots.start()
 
    def _update_searching(self, dots):
        self.SetTitle("'%s' - %d matches found - Searching%s" % (self._name_name, self.usagesusages.total_usages, dots))
        self.usage_listusage_list.refresh()
 
    def end_searching(self):
        self._dots_dots.stop()
        self.SetTitle("'%s' - %d matches" % (self._name_name, self.usagesusages.total_usages))
        self.usage_listusage_list.refresh()
 
    def _usage_selected(self, idx):
        for listener in self._selection_listeners_selection_listeners:
            listener(self.usagesusages.usage(idx).item.parent, self._name_name)
 
    def add_selection_listener(self, listener):
        self._selection_listeners_selection_listeners.append(listener)
 
    def _add_view_components(self):
        pass
 
 
class UsagesDialogWithUserKwNavigation(UsagesDialog):
 
    def __init__(self, name, highlight, controller, usages=None):
        self.OnGotodefinitionOnGotodefinition = lambda evt: highlight(controller, name)
        UsagesDialog.__init__(self, name, usages=usages)
 
    def _add_view_components(self):
        button = ButtonWithHandler(self, 'Go to definition')
        button.SetBackgroundColour(Colour(self.color_secondary_background))
        button.SetForegroundColour(Colour(self.color_secondary_foreground))
        self.Sizer.Add(button, 0, wx.ALL, 3)
 
 
def ResourceImportUsageDialog(name, highlight, controller):
    return UsagesDialogWithUserKwNavigation(name, highlight, controller, usages=ResourceImportListModel([]))
 
 
class _UsagesListModel(ListModel):
 
    def __init__(self, usages):
        self._usages_usages = usages
        self._create_image_list_create_image_list()
 
    def _create_image_list(self):
        images = ImageList(16, 16)
        provider = ImageProvider()
        images.add(provider.TESTCASEIMG)
        images.add(provider.KEYWORDIMG)
        images.add(provider.DATAFILEIMG)
        images.add(provider.DATADIRIMG)
        self._images_images = images
 
    @property
    images = property
    
    def images(self):
        return self._images_images
 
    def image(self, item):
        # TODO: better mechanism for item type recognition
        parent_type = self._usages_usages[item].parent.__class__.__name__
        return {'TestCaseController': 0,
                'UserKeywordController': 1,
                'TestCaseFileController': 2,
                'ResourceFileController': 2,
                'TestDataDirectoryController': 3}.get(parent_type, -1)
 
    def add_usage(self, usage):
        self._usages_usages.append(usage)
 
    def usage(self, idx):
        return self._usages_usages[idx]
 
    @property
    total_usages = property
    
    def total_usages(self):
        return sum(u.count for u in self._usages_usages)
 
    @property
    count = property
    
    def count(self):
        return len(self._usages_usages)
 
 
class UsagesListModel(_UsagesListModel):
 
    def __init__(self, usages):
        _UsagesListModel.__init__(self, usages)
        self.headersheaders = ['Location', 'Usage', 'Source']
 
    def item_text(self, row, col):
        u = self.usageusage(row)
        return [u.location,  u.usage, u.source][col]
 
 
class ResourceImportListModel(_UsagesListModel):
 
    def __init__(self, usages):
        _UsagesListModel.__init__(self, usages)
        self.headersheaders = ['Name', 'Location']
        self._cannot_rename_item_attr_cannot_rename_item_attr = wx.ListItemAttr()
        self._cannot_rename_item_attr_cannot_rename_item_attr.SetBackgroundColour(wx.Colour(255, 64, 64))
 
    def item_text(self, row, col):
        u = self.usageusage(row)
        return [u.name, u.location][col]
 
    def item_attributes(self, idx):
        if self._usages_usages[idx].can_be_renamed:
            return None
        return self._cannot_rename_item_attr_cannot_rename_item_attr
 
    @property
    total_usages = property
    
    def total_usages(self):
        return len(self._usages_usages)
 
 
class RecursiveResourceImportListModel(_UsagesListModel):
 
    def __init__(self, usages):
        _UsagesListModel.__init__(self, usages)
        self.headersheaders = ['Imported name', 'Imported Location', 'Importing Name', 'Importing Location']
 
    def item_text(self, row, col):
        u = self.usageusage(row)
        return [u.res_name, u.res_src, u.name, u.location][col]