UsageRunner.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 time
from threading import Thread
 
import wx
 
from robotide.usages import commands
# import FindUsages, FindResourceUsages, FindVariableUsages
from . import usagesdialog
# import UsagesDialog, UsagesDialogWithUserKwNavigation, ResourceImportUsageDialog
 
 
class Usages():
 
    def __init__(self, controller, highlight, name=None, kw_info=None):
        self._name_name = name or controller.name
        self._kw_info_kw_info = kw_info
        self._controller_controller = controller
        self._highlight_highlight = highlight
        self._dlg_dlg = self._usages_dialog_usages_dialog()
        self._worker_worker = Thread(target=self._run_run)
        self._dialog_closed_dialog_closed = False
 
    def _usages_dialog(self):
        if self._controller_controller.name == self._name_name:
            return usagesdialog.UsagesDialogWithUserKwNavigation(self._name_name, self._highlight_highlight, self._controller_controller)
        return usagesdialog.UsagesDialog(self._name_name)
 
    def show(self):
        self._dlg_dlg.add_selection_listener(self._highlight_highlight)
        self._dlg_dlg.Bind(wx.EVT_CLOSE, self._stop_stop)
        self._dlg_dlg.Show()
        self._worker_worker.start()
 
    def _run(self):
        wx.CallAfter(self._begin_search_begin_search)
        for usage in self._find_usages_find_usages():
            time.sleep(0)  # GIVE SPACE TO OTHER THREADS -- Thread.yield in Java
            if self._dialog_closed_dialog_closed:
                return
            wx.CallAfter(self._add_usage_add_usage, usage)
        wx.CallAfter(self._end_search_end_search)
 
    def _find_usages(self):
        return self._controller_controller.execute(commands.FindUsages(self._name_name, self._kw_info_kw_info))
 
    def _begin_search(self):
        if not self._dialog_closed_dialog_closed:
            self._dlg_dlg.begin_searching()
 
    def _add_usage(self, usage):
        if not self._dialog_closed_dialog_closed:
            self._dlg_dlg.add_usage(usage)
 
    def _end_search(self):
        if not self._dialog_closed_dialog_closed:
            self._dlg_dlg.end_searching()
 
    def _stop(self, event):
        self._dialog_closed_dialog_closed = True
        event.Skip()
 
 
class ResourceFileUsages(Usages):
 
    def __init__(self, controller, highlight):
        Usages.__init__(self, controller, highlight)
 
    def _usages_dialog(self):
        return usagesdialog.ResourceImportUsageDialog(self._controller_controller.display_name, self._highlight_highlight, self._controller_controller)
 
    def _find_usages(self):
        return self._controller_controller.execute(commands.FindResourceUsages())
 
 
class VariableUsages(Usages):
 
    def _find_usages(self):
        return self._controller_controller.execute(commands.FindVariableUsages(self._name_name))