preview.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.html
from io import StringIO
from ..pluginapi import Plugin, TreeAwarePluginMixin
from ..action import ActionInfo
from ..publish import (RideTreeSelection, RideNotebookTabChanged, RideTestCaseAdded, RideUserKeywordAdded)
from ..robotapi import TestCase, UserKeyword
from ..widgets import ButtonWithHandler, Font
from ..utils import Printing
 
 
 
class PreviewPlugin(Plugin, TreeAwarePluginMixin):
    datafile = property(lambda self: self.get_selected_datafileget_selected_datafile())
 
    def __init__(self, application):
        Plugin.__init__(self, application, default_settings={'format': 'HTML'})
        self._panel_panel = None
 
    def enable(self):
        self.register_actionregister_action(ActionInfo('Tools','Preview', self.OnShowPreviewOnShowPreview,
                                        shortcut='F6',
                                        doc='Show preview of the current file',
                                        position=71))
        self.subscribesubscribe(self.OnTreeSelectionOnTreeSelection, RideTreeSelection)
        self.subscribesubscribe(self.OnTabChangedOnTabChanged, RideNotebookTabChanged)
        self.subscribesubscribe(self._update_preview_update_preview, RideTestCaseAdded)
        self.subscribesubscribe(self._update_preview_update_preview, RideUserKeywordAdded)
        self.add_self_as_tree_aware_pluginadd_self_as_tree_aware_plugin()
 
    def disable(self):
        self.remove_self_from_tree_aware_pluginsremove_self_from_tree_aware_plugins()
        self.unsubscribe_allunsubscribe_all()
        self.unregister_actionsunregister_actions()
        self.delete_tabdelete_tab(self._panel_panel)
        self._panel_panel = None
 
    def is_focused(self):
        return self.tab_is_visibletab_is_visible(self._panel_panel)
 
    def OnShowPreview(self, event):
        if not self._panel_panel:
            self._panel_panel = PreviewPanel(self, self.notebooknotebook)
        self.show_tabshow_tab(self._panel_panel)
        self._update_preview_update_preview(None)
 
    def OnTreeSelection(self, message):
        if self.is_focusedis_focused():
            self._panel_panel.tree_node_selected(message.item)
 
    def OnTabChanged(self, message):
        self._update_preview_update_preview(None)
 
    def _update_preview(self, message):
        if self.is_focusedis_focused() and self.datafiledatafiledatafile:
            self._panel_panel.update_preview()
 
 
class PreviewPanel(wx.Panel):
    
    _formats = ['HTML', 'Text (Spaces)', 'Text (Pipes)']
 
    def __init__(self, parent, notebook):
        wx.Panel.__init__(self, notebook)
        self._parent_parent = parent
        main_sizer = wx.BoxSizer(wx.VERTICAL)
        self.SetSizer(main_sizer)
        self._format_format = parent.format
        self.__view__view = None
        self._printing_printing = Printing(self)
        box = wx.BoxSizer(wx.HORIZONTAL)
        box.Add(self._chooser_chooser())
        if wx.VERSION < (4, 1, 0):
            box.Add(self._print_button_print_button(), 1, wx.ALIGN_CENTER_VERTICAL | wx.EXPAND)
        else:
            box.Add(self._print_button_print_button(), 1, wx.EXPAND)
        self.Sizer.Add(box)
        notebook.AddPage(self, "Preview")
 
    def OnPrint(self, evt):
        self._printing_printing.preview_text(self._get_content_get_content())
 
    @property
    _file_format = property
    
    def _file_format(self):
        if self._format_format == 'HTML':
            return self._format_format.lower()
        return 'txt'
 
    @property
    _pipe_separated = property
    
    def _pipe_separated(self):
        return 'Pipes' in self._format_format
 
    def _chooser(self):
        chooser = wx.RadioBox(self, label='Format', choices=self._formats_formats)
        chooser.SetStringSelection(self._format_format)
        self.Bind(wx.EVT_RADIOBOX, self.OnTypeChangedOnTypeChanged, chooser)
        return chooser
 
    def _print_button(self):
        return ButtonWithHandler(self, 'Print')
 
    @property
    _view = property
    
    def _view(self):
        view_class = HtmlView if self._file_format_file_format_file_format == 'html' else TxtView
        if isinstance(self.__view__view, view_class):
            return self.__view__view
        self._remove_current_view_remove_current_view()
        self.__view__view = self._create_view_create_view(view_class)
        return self.__view__view
 
    def _remove_current_view(self):
        if self.__view__view:
            self.Sizer.Remove(self.__view__view)
            self.__view__view.Destroy()
 
    def _create_view(self, view_class):
        view = view_class(self)
        self.Sizer.Add(view, 1, wx.EXPAND|wx.ALL, border=8)
        self.Sizer.Layout()
        return view
 
    def tree_node_selected(self, item):
        self.update_previewupdate_preview()
        self._view_view_view.scroll_to_subitem(item)
 
    def update_preview(self):
        self._view_view_view.set_content(self._get_content_get_content())
 
    def _get_content(self):
        datafile = self._parent_parent.datafile
        if not datafile:
            return ''
        output = StringIO()
        try:
            datafile.save(
                output=output,
                format=self._file_format_file_format_file_format,
                pipe_separated=self._pipe_separated_pipe_separated_pipe_separated,
                txt_separating_spaces=self._parent_parent.global_settings['txt number of spaces']
            )
        except Exception as e:
            return "Creating preview of '%s' failed: %s" % (datafile.name, e)
        else:
            return output.getvalue()
 
    def OnTypeChanged(self, event):
        self._format_format = event.String
        self.update_previewupdate_preview()
        self._parent_parent.save_setting('format', self._format_format)
 
 
class HtmlView(wx.html.HtmlWindow):
 
    def __init__(self, parent):
        wx.html.HtmlWindow.__init__(self, parent)
        self.SetStandardFonts()
 
    def set_content(self, content):
        self.SetPage(content)
 
    def scroll_to_subitem(self, item):
        anchor = self._get_anchor_get_anchor(item.data)
        if self.HasAnchor(anchor):
            self.ScrollToAnchor(anchor)
            self.ScrollLines(-1)
        else:
            self.Scroll(0,0)
 
    def _get_anchor(self, data):
        if isinstance(data, UserKeyword):
            return 'keyword_%s' % data.name
        if isinstance(data, TestCase):
            return 'test_%s' % data.name
        return ''
 
 
class TxtView(wx.TextCtrl):
 
    def __init__(self, parent):
        wx.TextCtrl.__init__(self, parent, style=wx.TE_MULTILINE|wx.TE_NOHIDESEL)
        self.SetEditable(False)
        self.SetFont(Font().fixed)
 
    def set_content(self, content):
        self.SetValue(content)
 
    def scroll_to_subitem(self, item):
        pass