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 _init_sizers(self, main_rows, main_growable_row,

    95

                            left_rows, left_growable_row,

    96

                            right_rows, right_growable_row):

    97

        """

    98

        Initialize common sizers

    99

        @param main_rows: Number of rows in main sizer

   100

        @param main_growable_row: Row that is growable in main sizer, None if no

   101

        row is growable

   102

        @param left_rows: Number of rows in left grid sizer

   103

        @param left_growable_row: Row that is growable in left grid sizer, None

   104

        if no row is growable

   105

        @param right_rows: Number of rows in right grid sizer

   106

        @param right_growable_row: Row that is growable in right grid sizer,

   107

        None if no row is growable

   108

        """

   109

        # Create dialog main sizer

   110

        self.MainSizer = wx.FlexGridSizer(cols=1, hgap=0, 

   111

                                          rows=main_rows, vgap=10)

   112

        self.MainSizer.AddGrowableCol(0)

   113

        if main_growable_row is not None:

   114

            self.MainSizer.AddGrowableRow(main_growable_row)

   115

   116

        # Create a sizer for dividing parameters in two columns

   117

        column_sizer = wx.BoxSizer(wx.HORIZONTAL)

   118

        self.MainSizer.AddSizer(column_sizer, border=20, 

   119

              flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)

   120

   121

        # Create a sizer for left column

   122

        self.LeftGridSizer = wx.FlexGridSizer(cols=1, hgap=0, 

   123

                                              rows=left_rows, vgap=5)

   124

        self.LeftGridSizer.AddGrowableCol(0)

   125

        if left_growable_row is not None:

   126

            self.LeftGridSizer.AddGrowableRow(left_growable_row)

   127

        column_sizer.AddSizer(self.LeftGridSizer, 1, border=5, 

   128

              flag=wx.GROW|wx.RIGHT)

   129

   130

        # Create a sizer for right column

   131

        self.RightGridSizer = wx.FlexGridSizer(cols=1, hgap=0, 

   132

                                               rows=right_rows, vgap=0)

   133

        self.RightGridSizer.AddGrowableCol(0)

   134

        if right_growable_row is not None:

   135

            self.RightGridSizer.AddGrowableRow(right_growable_row)

   136

        column_sizer.AddSizer(self.RightGridSizer, 1, border=5, 

   137

              flag=wx.GROW|wx.LEFT)

   138

   139

        self.SetSizer(self.MainSizer)

   140

   141

    def SetMinElementSize(self, size):

   142

        """

   143

        Define minimal graphic element size

   144

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

   145

        """

   146

        self.MinElementSize = size

   147

   148

    def GetMinElementSize(self):

   149

        """

   150

        Get minimal graphic element size

   151

        @return: Tuple containing minimal size (width, height) or None if no

   152

        element defined

   153

        May be overridden by inherited classes

   154

        """

   155

        if self.Element is None:

   156

            return None

   157

   158

        return self.Element.GetMinSize()

   159

   160

    def SetPreviewFont(self, font):

   161

        """

   162

        Set font of Preview panel

   163

        @param font: wx.Font object containing font style

   164

        """

   165

        self.Preview.SetFont(font)

   166

   167

    def RefreshVariableList(self):

   168

        """

   169

        Extract list of variables defined in POU

   170

        """

   171

        # Get list of variables defined in POU

   172

        self.VariableList = {

   173

            var.Name: (var.Class, var.Type)

   174

            for var in self.Controller.GetEditedElementInterfaceVars(

   175

                                                        self.TagName)

   176

            if var.Edit}

   177

   178

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

   179

        returntype = self.Controller.GetEditedElementInterfaceReturnType(

   180

                                                            self.TagName)

   181

        if returntype is not None:

   182

            self.VariableList[

   183

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

   184

                 ("Output", returntype)

   185

   186

        # Add POU name if POU is a transition

   187

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

   188

        if words[0] == "T":

   189

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

   190

   191

    def TestElementName(self, element_name):

   192

        """

   193

        Test displayed graphic element name

   194

        @param element_name: Graphic element name

   195

        """

   196

        # Variable containing error message format

   197

        message_format = None

   198

        # Get graphic element name in upper case

   199

        uppercase_element_name = element_name.upper()

   200

   201

        # Test if graphic element name is a valid identifier

   202

        if not TestIdentifier(element_name):

   203

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

   204

   205

        # Test that graphic element name isn't a keyword

   206

        elif uppercase_element_name in IEC_KEYWORDS:

   207

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

   208

   209

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

   210

        elif uppercase_element_name in self.Controller.GetProjectPouNames():

   211

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

   212

   213

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

   214

        # or another graphic element

   215

        elif ((self.DefaultElementName is None or 

   216

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

   217

              uppercase_element_name in self.Controller.\

   218

                    GetEditedElementVariables(self.TagName)):

   219

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

   220

   221

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

   222

        if message_format is not None:

   223

            self.ShowErrorMessage(message_format % element_name)

   224

            # Test failed

   225

            return False

   226

   227

        # Test succeed

   228

        return True

   229

   230

    def ShowErrorMessage(self, message):

   231

        """

   232

        Show an error message dialog over this dialog

   233

        @param message: Error message to display

   234

        """

   235

        dialog = wx.MessageDialog(self, message, 

   236

                                  _("Error"), 

   237

                                  wx.OK|wx.ICON_ERROR)

   238

        dialog.ShowModal()

   239

        dialog.Destroy()

   240

   241

    def OnOK(self, event):

   242

        """

   243

        Called when dialog OK button is pressed

   244

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

   245

        are valid

   246

        @param event: wx.Event from OK button

   247

        """

   248

        # Close dialog

   249

        self.EndModal(wx.ID_OK)

   250

   251

    def RefreshPreview(self):

   252

        """

   253

        Refresh preview panel of graphic element

   254

        May be overridden by inherited classes

   255

        """

   256

        # Init preview panel paint device context

   257

        dc = wx.ClientDC(self.Preview)

   258

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

   259

        dc.Clear()

   260

   261

        # Return immediately if no graphic element defined

   262

        if self.Element is None:

   263

            return

   264

   265

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

   266

        # parameters and graphic element min size defined

   267

        min_width, min_height = self.GetMinElementSize()

   268

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

   269

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

   270

        self.Element.SetSize(width, height)

   271

   272

        # Get element position and bounding box to center in preview

   273

        posx, posy = self.Element.GetPosition()

   274

        bbox = self.Element.GetBoundingBox()

   275

   276

        # Get Preview panel size

   277

        client_size = self.Preview.GetClientSize()

   278

   279

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

   280

        # calculate preview panel scale so that graphic element fit inside

   281

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

   282

                     float(bbox.height) / client_size.height) * 1.1

   283

                 if bbox.width * 1.1 > client_size.width or 

   284

                    bbox.height * 1.1 > client_size.height

   285

                 else 1.0)

   286

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

   287

   288

        # Center graphic element in preview panel

   289

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

   290

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

   291

        self.Element.SetPosition(x, y)

   292

   293

        # Draw graphic element

   294

        self.Element.Draw(dc)

   295

   296

    def OnPaint(self, event):

   297

        """

   298

        Called when Preview panel need to be redraw

   299

        @param event: wx.PaintEvent

   300

        """

   301

        self.RefreshPreview()

   302

        event.Skip()

   303