1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

# Copyright (C) 2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

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

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

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

    16

#

    17

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

    18

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

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

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

    23

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

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

    27

from __future__ import absolute_import

    28

import wx

    29

    30

from plcopen.structures import TestIdentifier, IEC_KEYWORDS

    31

from graphics.GraphicCommons import FREEDRAWING_MODE

    32

    33

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

    34

#                    Dialog with preview for graphic block

    35

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

    36

    37

    38

class BlockPreviewDialog(wx.Dialog):

    39

    """

    40

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

    41

    graphic created by dialog

    42

    """

    43

    44

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

    45

        """

    46

        Constructor

    47

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

    48

        @param controller: Reference to project controller

    49

        @param tagname: Tagname of project POU edited

    50

        @param title: Title of dialog frame

    51

        """

    52

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

    53

    54

        # Save reference to

    55

        self.Controller = controller

    56

        self.TagName = tagname

    57

    58

        # Label for preview

    59

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

    60

    61

        # Create Preview panel

    62

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

    63

        self.Preview.SetBackgroundColour(wx.WHITE)

    64

    65

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

    66

        # like Viewer

    67

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

    68

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

    69

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

    70

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

    71

    72

        # Bind paint event on Preview panel

    73

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

    74

    75

        # Add default dialog buttons sizer

    76

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

    77

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

    78

                  self.ButtonSizer.GetAffirmativeButton())

    79

    80

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

    81

        self.MinElementSize = None     # Graphic element minimal size

    82

    83

        # Variable containing the graphic element name when dialog is opened

    84

        self.DefaultElementName = None

    85

        self.Fit()

    86

    87

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

    88

        self.VariableList = {}

    89

    90

    def __del__(self):

    91

        """

    92

        Destructor

    93

        """

    94

        # Remove reference to project controller

    95

        self.Controller = None

    96

    97

    def _init_sizers(self,

    98

                     main_rows, main_growable_row,

    99

                     left_rows, left_growable_row,

   100

                     right_rows, right_growable_row):

   101

        """

   102

        Initialize common sizers

   103

        @param main_rows: Number of rows in main sizer

   104

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

   105

        row is growable

   106

        @param left_rows: Number of rows in left grid sizer

   107

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

   108

        if no row is growable

   109

        @param right_rows: Number of rows in right grid sizer

   110

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

   111

        None if no row is growable

   112

        """

   113

        # Create dialog main sizer

   114

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

   115

                                          rows=main_rows, vgap=10)

   116

        self.MainSizer.AddGrowableCol(0)

   117

        if main_growable_row is not None:

   118

            self.MainSizer.AddGrowableRow(main_growable_row)

   119

   120

        # Create a sizer for dividing parameters in two columns

   121

        self.ColumnSizer = wx.BoxSizer(wx.HORIZONTAL)

   122

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

   123

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

   124

   125

        # Create a sizer for left column

   126

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

   127

                                              rows=left_rows, vgap=5)

   128

        self.LeftGridSizer.AddGrowableCol(0)

   129

        if left_growable_row is not None:

   130

            self.LeftGridSizer.AddGrowableRow(left_growable_row)

   131

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

   132

                                  flag=wx.GROW | wx.RIGHT | wx.EXPAND)

   133

   134

        # Create a sizer for right column

   135

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

   136

                                               rows=right_rows, vgap=0)

   137

        self.RightGridSizer.AddGrowableCol(0)

   138

        if right_growable_row is not None:

   139

            self.RightGridSizer.AddGrowableRow(right_growable_row)

   140

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

   141

                                  flag=wx.GROW | wx.LEFT)

   142

   143

        self.SetSizer(self.MainSizer)

   144

   145

    def SetMinElementSize(self, size):

   146

        """

   147

        Define minimal graphic element size

   148

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

   149

        """

   150

        self.MinElementSize = size

   151

   152

    def GetMinElementSize(self):

   153

        """

   154

        Get minimal graphic element size

   155

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

   156

        element defined

   157

        May be overridden by inherited classes

   158

        """

   159

        if self.Element is None:

   160

            return None

   161

   162

        return self.Element.GetMinSize()

   163

   164

    def SetPreviewFont(self, font):

   165

        """

   166

        Set font of Preview panel

   167

        @param font: wx.Font object containing font style

   168

        """

   169

        self.Preview.SetFont(font)

   170

   171

    def RefreshVariableList(self):

   172

        """

   173

        Extract list of variables defined in POU

   174

        """

   175

        # Get list of variables defined in POU

   176

        self.VariableList = {

   177

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

   178

            for var in self.Controller.GetEditedElementInterfaceVars(self.TagName)

   179

            if var.Edit}

   180

   181

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

   182

        returntype = self.Controller.GetEditedElementInterfaceReturnType(self.TagName)

   183

        if returntype is not None:

   184

            self.VariableList[

   185

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

   186

                 ("Output", returntype)

   187

   188

        # Add POU name if POU is a transition

   189

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

   190

        if words[0] == "T":

   191

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

   192

   193

    def TestElementName(self, element_name):

   194

        """

   195

        Test displayed graphic element name

   196

        @param element_name: Graphic element name

   197

        """

   198

        # Variable containing error message format

   199

        message_format = None

   200

        # Get graphic element name in upper case

   201

        uppercase_element_name = element_name.upper()

   202

   203

        # Test if graphic element name is a valid identifier

   204

        if not TestIdentifier(element_name):

   205

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

   206

   207

        # Test that graphic element name isn't a keyword

   208

        elif uppercase_element_name in IEC_KEYWORDS:

   209

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

   210

   211

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

   212

        elif uppercase_element_name in self.Controller.GetProjectPouNames():

   213

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

   214

   215

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

   216

        # or another graphic element

   217

        elif ((self.DefaultElementName is None or

   218

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

   219

              uppercase_element_name in self.Controller.GetEditedElementVariables(self.TagName)):

   220

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

   221

   222

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

   223

        if message_format is not None:

   224

            self.ShowErrorMessage(message_format % element_name)

   225

            # Test failed

   226

            return False

   227

   228

        # Test succeed

   229

        return True

   230

   231

    def ShowErrorMessage(self, message):

   232

        """

   233

        Show an error message dialog over this dialog

   234

        @param message: Error message to display

   235

        """

   236

        dialog = wx.MessageDialog(self, message,

   237

                                  _("Error"),

   238

                                  wx.OK | wx.ICON_ERROR)

   239

        dialog.ShowModal()

   240

        dialog.Destroy()

   241

   242

    def OnOK(self, event):

   243

        """

   244

        Called when dialog OK button is pressed

   245

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

   246

        are valid

   247

        @param event: wx.Event from OK button

   248

        """

   249

        # Close dialog

   250

        self.EndModal(wx.ID_OK)

   251

   252

    def RefreshPreview(self):

   253

        """

   254

        Refresh preview panel of graphic element

   255

        May be overridden by inherited classes

   256

        """

   257

        # Init preview panel paint device context

   258

        dc = wx.ClientDC(self.Preview)

   259

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

   260

        dc.Clear()

   261

   262

        # Return immediately if no graphic element defined

   263

        if self.Element is None:

   264

            return

   265

   266

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

   267

        # parameters and graphic element min size defined

   268

        min_width, min_height = self.GetMinElementSize()

   269

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

   270

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

   271

        self.Element.SetSize(width, height)

   272

   273

        # Get element position and bounding box to center in preview

   274

        posx, posy = self.Element.GetPosition()

   275

        bbox = self.Element.GetBoundingBox()

   276

   277

        # Get Preview panel size

   278

        client_size = self.Preview.GetClientSize()

   279

   280

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

   281

        # calculate preview panel scale so that graphic element fit inside

   282

        k = 1.1 if (bbox.width * 1.1 > client_size.width or

   283

                    bbox.height * 1.1 > client_size.height) \

   284

            else 1.0

   285

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

   286

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

   287

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

   288

   289

        # Center graphic element in preview panel

   290

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

   291

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

   292

        self.Element.SetPosition(x, y)

   293

   294

        # Draw graphic element

   295

        self.Element.Draw(dc)

   296

   297

    def OnPaint(self, event):

   298

        """

   299

        Called when Preview panel need to be redraw

   300

        @param event: wx.PaintEvent

   301

        """

   302

        self.RefreshPreview()

   303

        event.Skip()