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

    28

    29

import wx

    30

    31

from plcopen.structures import TestIdentifier, IEC_KEYWORDS

    32

from graphics.GraphicCommons import FREEDRAWING_MODE

    33

    34

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

    35

#                    Dialog with preview for graphic block

    36

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

    37

    38

    39

class BlockPreviewDialog(wx.Dialog):

    40

    """

    41

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

    42

    graphic created by dialog

    43

    """

    44

    45

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

    46

        """

    47

        Constructor

    48

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

    49

        @param controller: Reference to project controller

    50

        @param tagname: Tagname of project POU edited

    51

        @param title: Title of dialog frame

    52

        """

    53

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

    54

    55

        # Save reference to

    56

        self.Controller = controller

    57

        self.TagName = tagname

    58

    59

        # Label for preview

    60

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

    61

    62

        # Create Preview panel

    63

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

    64

        self.Preview.SetBackgroundColour(wx.WHITE)

    65

    66

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

    67

        # like Viewer

    68

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

    69

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

    70

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

    71

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

    72

    73

        # Bind paint event on Preview panel

    74

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

    75

    76

        # Add default dialog buttons sizer

    77

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

    78

        self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.GetAffirmativeId())

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

    91

                     main_rows, main_growable_row,

    92

                     left_rows, left_growable_row,

    93

                     right_rows, right_growable_row):

    94

        """

    95

        Initialize common sizers

    96

        @param main_rows: Number of rows in main sizer

    97

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

    98

        row is growable

    99

        @param left_rows: Number of rows in left grid sizer

   100

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

   101

        if no row is growable

   102

        @param right_rows: Number of rows in right grid sizer

   103

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

   104

        None if no row is growable

   105

        """

   106

        # Create dialog main sizer

   107

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

   108

                                          rows=main_rows, vgap=10)

   109

        self.MainSizer.AddGrowableCol(0)

   110

        if main_growable_row is not None:

   111

            self.MainSizer.AddGrowableRow(main_growable_row)

   112

   113

        # Create a sizer for dividing parameters in two columns

   114

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

   115

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

   116

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

   117

   118

        # Create a sizer for left column

   119

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

   120

                                              rows=left_rows, vgap=5)

   121

        self.LeftGridSizer.AddGrowableCol(0)

   122

        if left_growable_row is not None:

   123

            self.LeftGridSizer.AddGrowableRow(left_growable_row)

   124

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

   125

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

   126

   127

        # Create a sizer for right column

   128

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

   129

                                               rows=right_rows, vgap=0)

   130

        self.RightGridSizer.AddGrowableCol(0)

   131

        if right_growable_row is not None:

   132

            self.RightGridSizer.AddGrowableRow(right_growable_row)

   133

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

   134

                                  flag=wx.GROW | wx.LEFT)

   135

   136

        self.SetSizer(self.MainSizer)

   137

   138

    def SetMinElementSize(self, size):

   139

        """

   140

        Define minimal graphic element size

   141

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

   142

        """

   143

        self.MinElementSize = size

   144

   145

    def GetMinElementSize(self):

   146

        """

   147

        Get minimal graphic element size

   148

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

   149

        element defined

   150

        May be overridden by inherited classes

   151

        """

   152

        if self.Element is None:

   153

            return None

   154

   155

        return self.Element.GetMinSize()

   156

   157

    def SetPreviewFont(self, font):

   158

        """

   159

        Set font of Preview panel

   160

        @param font: wx.Font object containing font style

   161

        """

   162

        self.Preview.SetFont(font)

   163

   164

    def RefreshVariableList(self):

   165

        """

   166

        Extract list of variables defined in POU

   167

        """

   168

        # Get list of variables defined in POU

   169

        self.VariableList = {

   170

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

   171

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

   172

            if var.Edit}

   173

   174

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

   175

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

   176

        if returntype is not None:

   177

            self.VariableList[

   178

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

   179

                 ("Output", returntype)

   180

   181

        # Add POU name if POU is a transition

   182

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

   183

        if words[0] == "T":

   184

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

   185

   186

    def TestElementName(self, element_name):

   187

        """

   188

        Test displayed graphic element name

   189

        @param element_name: Graphic element name

   190

        """

   191

        # Variable containing error message format

   192

        message_format = None

   193

        # Get graphic element name in upper case

   194

        uppercase_element_name = element_name.upper()

   195

   196

        # Test if graphic element name is a valid identifier

   197

        if not TestIdentifier(element_name):

   198

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

   199

   200

        # Test that graphic element name isn't a keyword

   201

        elif uppercase_element_name in IEC_KEYWORDS:

   202

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

   203

   204

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

   205

        elif uppercase_element_name in self.Controller.GetProjectPouNames():

   206

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

   207

   208

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

   209

        # or another graphic element

   210

        elif ((self.DefaultElementName is None or

   211

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

   212

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

   213

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

   214

   215

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

   216

        if message_format is not None:

   217

            self.ShowErrorMessage(message_format % element_name)

   218

            # Test failed

   219

            return False

   220

   221

        # Test succeed

   222

        return True

   223

   224

    def ShowErrorMessage(self, message):

   225

        """

   226

        Show an error message dialog over this dialog

   227

        @param message: Error message to display

   228

        """

   229

        dialog = wx.MessageDialog(self, message,

   230

                                  _("Error"),

   231

                                  wx.OK | wx.ICON_ERROR)

   232

        dialog.ShowModal()

   233

        dialog.Destroy()

   234

   235

    def OnOK(self, event):

   236

        """

   237

        Called when dialog OK button is pressed

   238

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

   239

        are valid

   240

        @param event: wx.Event from OK button

   241

        """

   242

        # Close dialog

   243

        self.EndModal(wx.ID_OK)

   244

   245

    def RefreshPreview(self):

   246

        """Triggers EVT_PAINT event to refresh UI"""

   247

        self.Refresh()

   248

   249

    def DrawPreview(self):

   250

        """

   251

        Refresh preview panel of graphic element

   252

        May be overridden by inherited classes

   253

        """

   254

        # Init preview panel paint device context

   255

        dc = wx.PaintDC(self.Preview)

   256

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

   257

        dc.Clear()

   258

   259

        # Return immediately if no graphic element defined

   260

        if self.Element is None:

   261

            return

   262

   263

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

   264

        # parameters and graphic element min size defined

   265

        min_width, min_height = self.GetMinElementSize()

   266

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

   267

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

   268

        self.Element.SetSize(width, height)

   269

   270

        # Get element position and bounding box to center in preview

   271

        posx, posy = self.Element.GetPosition()

   272

        bbox = self.Element.GetBoundingBox()

   273

   274

        # Get Preview panel size

   275

        client_size = self.Preview.GetClientSize()

   276

   277

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

   278

        # calculate preview panel scale so that graphic element fit inside

   279

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

   280

                    bbox.height * 1.1 > client_size.height) \

   281

            else 1.0

   282

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

   283

                     bbox.height / client_size.height) * k)

   284

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

   285

   286

        # Center graphic element in preview panel

   287

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

   288

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

   289

        self.Element.SetPosition(x, y)

   290

   291

        # Draw graphic element

   292

        self.Element.Draw(dc)

   293

   294

    def OnPaint(self, event):

   295

        """

   296

        Called when Preview panel need to be redraw

   297

        @param event: wx.PaintEvent

   298

        """

   299

        self.DrawPreview()

   300

        event.Skip()