1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2013: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import wx

    26

    27

from plcopen.structures import TestIdentifier, IEC_KEYWORDS

    28

from graphics.GraphicCommons import FREEDRAWING_MODE

    29

    30

#-------------------------------------------------------------------------------

    31

#                    Dialog with preview for graphic block

    32

#-------------------------------------------------------------------------------

    33

    34

"""

    35

Class that implements a generic dialog containing a preview panel for displaying

    36

graphic created by dialog

    37

"""

    38

    39

class BlockPreviewDialog(wx.Dialog):

    40

    41

    def __init__(self, parent, controller, tagname, size, title):

    42

        """

    43

        Constructor

    44

        @param parent: Parent wx.Window of dialog for modal

    45

        @param controller: Reference to project controller

    46

        @param tagname: Tagname of project POU edited

    47

        @param size: wx.Size object containing size of dialog

    48

        @param title: Title of dialog frame

    49

        """

    50

        wx.Dialog.__init__(self, parent, size=size, title=title)

    51

    52

        # Save reference to

    53

        self.Controller = controller

    54

        self.TagName = tagname

    55

    56

        # Label for preview

    57

        self.PreviewLabel = wx.StaticText(self, label=_('Preview:'))

    58

    59

        # Create Preview panel

    60

        self.Preview = wx.Panel(self, style=wx.SIMPLE_BORDER)

    61

        self.Preview.SetBackgroundColour(wx.WHITE)

    62

    63

        # Add function to preview panel so that it answers to graphic elements

    64

        # like Viewer

    65

        setattr(self.Preview, "GetDrawingMode", lambda:FREEDRAWING_MODE)

    66

        setattr(self.Preview, "GetScaling", lambda:None)

    67

        setattr(self.Preview, "GetBlockType", controller.GetBlockType)

    68

        setattr(self.Preview, "IsOfType", controller.IsOfType)

    69

    70

        # Bind paint event on Preview panel

    71

        self.Preview.Bind(wx.EVT_PAINT, self.OnPaint)

    72

    73

        # Add default dialog buttons sizer

    74

        self.ButtonSizer = self.CreateButtonSizer(wx.OK|wx.CANCEL|wx.CENTRE)

    75

        self.Bind(wx.EVT_BUTTON, self.OnOK, 

    76

                  self.ButtonSizer.GetAffirmativeButton())

    77

    78

        self.Element = None            # Graphic element to display in preview

    79

        self.MinElementSize = None     # Graphic element minimal size

    80

    81

        # Variable containing the graphic element name when dialog is opened

    82

        self.DefaultElementName = None

    83

    84

        # List of variables defined in POU {var_name: (var_class, var_type),...}

    85

        self.VariableList = {}

    86

    87

    def __del__(self):

    88

        """

    89

        Destructor

    90

        """

    91

        # Remove reference to project controller

    92

        self.Controller = None

    93

    94

    def SetMinElementSize(self, size):

    95

        """

    96

        Define minimal graphic element size

    97

        @param size: Tuple containing minimal size (width, height)

    98

        """

    99

        self.MinElementSize = size

   100

   101

    def SetPreviewFont(self, font):

   102

        """

   103

        Set font of Preview panel

   104

        @param font: wx.Font object containing font style

   105

        """

   106

        self.Preview.SetFont(font)

   107

   108

    def RefreshVariableList(self):

   109

        """

   110

        Extract list of variables defined in POU

   111

        """

   112

        # Get list of variables defined in POU

   113

        self.VariableList = {

   114

            var["Name"]: (var["Class"], var["Type"])

   115

            for var in self.Controller.GetEditedElementInterfaceVars(

   116

                                                        self.TagName)

   117

            if var["Edit"]}

   118

   119

        # Add POU name to variable list if POU is a function 

   120

        returntype = self.Controller.GetEditedElementInterfaceReturnType(

   121

                                                            self.TagName)

   122

        if returntype is not None:

   123

            self.VariableList[

   124

                self.Controller.GetEditedElementName(self.TagName)] = \

   125

                 ("Output", returntype)

   126

   127

        # Add POU name if POU is a transition

   128

        words = self.TagName.split("::")

   129

        if words[0] == "T":

   130

            self.VariableList[words[2]] = ("Output", "BOOL")

   131

   132

    def TestElementName(self, element_name):

   133

        """

   134

        Test displayed graphic element name

   135

        @param element_name: Graphic element name

   136

        """

   137

        # Variable containing error message format

   138

        message_format = None

   139

        # Get graphic element name in upper case

   140

        uppercase_element_name = element_name.upper()

   141

   142

        # Test if graphic element name is a valid identifier

   143

        if not TestIdentifier(element_name):

   144

            message_format = _("\"%s\" is not a valid identifier!")

   145

   146

        # Test that graphic element name isn't a keyword

   147

        elif uppercase_element_name in IEC_KEYWORDS:

   148

            message_format = _("\"%s\" is a keyword. It can't be used!")

   149

   150

        # Test that graphic element name isn't a POU name

   151

        elif uppercase_element_name in self.Controller.GetProjectPouNames():

   152

            message_format = _("\"%s\" pou already exists!")

   153

   154

        # Test that graphic element name isn't already used in POU by a variable

   155

        # or another graphic element

   156

        elif ((self.DefaultElementName is None or 

   157

               self.DefaultElementName.upper() != uppercase_element_name) and 

   158

              uppercase_element_name in self.Controller.\

   159

                    GetEditedElementVariables(self.TagName)):

   160

            message_format = _("\"%s\" element for this pou already exists!")

   161

   162

        # If an error have been identify, show error message dialog

   163

        if message_format is not None:

   164

            self.ShowErrorMessage(message_format % element_name)

   165

            # Test failed

   166

            return False

   167

   168

        # Test succeed

   169

        return True

   170

   171

    def ShowErrorMessage(self, message):

   172

        """

   173

        Show an error message dialog over this dialog

   174

        @param message: Error message to display

   175

        """

   176

        dialog = wx.MessageDialog(self, message, 

   177

                                  _("Error"), 

   178

                                  wx.OK|wx.ICON_ERROR)

   179

        dialog.ShowModal()

   180

        dialog.Destroy()

   181

   182

    def OnOK(self, event):

   183

        """

   184

        Called when dialog OK button is pressed

   185

        Need to be overridden by inherited classes to check that dialog values

   186

        are valid

   187

        @param event: wx.Event from OK button

   188

        """

   189

        # Close dialog

   190

        self.EndModal(wx.ID_OK)

   191

   192

    def RefreshPreview(self):

   193

        """

   194

        Refresh preview panel of graphic element

   195

        May be overridden by inherited classes

   196

        """

   197

        # Init preview panel paint device context

   198

        dc = wx.ClientDC(self.Preview)

   199

        dc.SetFont(self.Preview.GetFont())

   200

        dc.Clear()

   201

   202

        # Return immediately if no graphic element defined

   203

        if self.Element is None:

   204

            return

   205

   206

        # Calculate block size according to graphic element min size due to its

   207

        # parameters and graphic element min size defined

   208

        min_width, min_height = self.Element.GetMinSize()

   209

        width = max(self.MinElementSize[0], min_width)

   210

        height = max(self.MinElementSize[1], min_height)

   211

        self.Element.SetSize(width, height)

   212

   213

        # Get Preview panel size

   214

        client_size = self.Preview.GetClientSize()

   215

   216

        # If graphic element is too big to be displayed in preview panel,

   217

        # calculate preview panel scale so that graphic element fit inside

   218

        scale = (max(float(width) / client_size.width, 

   219

                     float(height) / client_size.height) * 1.2

   220

                 if width * 1.2 > client_size.width or 

   221

                    height * 1.2 > client_size.height

   222

                 else 1.0)

   223

        dc.SetUserScale(1.0 / scale, 1.0 / scale)

   224

   225

        # Center graphic element in preview panel

   226

        x = int(client_size.width * scale - width) / 2

   227

        y = int(client_size.height * scale - height) / 2

   228

        self.Element.SetPosition(x, y)

   229

   230

        # Draw graphic element

   231

        self.Element.Draw(dc)

   232

   233

    def OnPaint(self, event):

   234

        """

   235

        Called when Preview panel need to be redraw

   236

        @param event: wx.PaintEvent

   237

        """

   238

        self.RefreshPreview()

   239

        event.Skip()

   240