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) 2007: 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

import re

    27

    28

import wx

    29

    30

from graphics.FBD_Objects import FBD_Block

    31

from controls.LibraryPanel import LibraryPanel

    32

from BlockPreviewDialog import BlockPreviewDialog

    33

    34

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

    35

#                                    Helpers

    36

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

    37

    38

    39

def GetBlockTypeDefaultNameModel(blocktype):

    40

    return re.compile("%s[0-9]+" % blocktype if blocktype is not None else ".*")

    41

    42

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

    43

#                         Set Block Parameters Dialog

    44

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

    45

    46

    47

class FBDBlockDialog(BlockPreviewDialog):

    48

    """

    49

    Class that implements a dialog for defining parameters of a FBD block graphic

    50

    element

    51

    """

    52

    53

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

    54

        """

    55

        Constructor

    56

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

    57

        @param controller: Reference to project controller

    58

        @param tagname: Tagname of project POU edited

    59

        """

    60

        BlockPreviewDialog.__init__(self, parent, controller, tagname,

    61

                                    title=_('Block Properties'))

    62

    63

        # Init common sizers

    64

        self._init_sizers(2, 0, 1, 0, 3, 2)

    65

    66

        # Create static box around library panel

    67

        type_staticbox = wx.StaticBox(self, label=_('Type:'))

    68

        left_staticboxsizer = wx.StaticBoxSizer(type_staticbox, wx.VERTICAL)

    69

        self.LeftGridSizer.AddSizer(left_staticboxsizer, border=5, flag=wx.GROW)

    70

    71

        # Create Library panel and add it to static box

    72

        self.LibraryPanel = LibraryPanel(self)

    73

        self.LibraryPanel.SetInitialSize(wx.Size(-1, 400))

    74

    75

        # Set function to call when selection in Library panel changed

    76

        setattr(self.LibraryPanel, "_OnTreeItemSelected",

    77

                self.OnLibraryTreeItemSelected)

    78

        left_staticboxsizer.AddWindow(self.LibraryPanel, 1, border=5,

    79

                                      flag=wx.GROW | wx.TOP)

    80

    81

        # Create sizer for other block parameters

    82

        top_right_gridsizer = wx.FlexGridSizer(cols=2, hgap=0, rows=4, vgap=5)

    83

        top_right_gridsizer.AddGrowableCol(1)

    84

        self.RightGridSizer.AddSizer(top_right_gridsizer, flag=wx.GROW)

    85

    86

        # Create label for block name

    87

        name_label = wx.StaticText(self, label=_('Name:'))

    88

        top_right_gridsizer.AddWindow(name_label,

    89

                                      flag=wx.ALIGN_CENTER_VERTICAL)

    90

    91

        # Create text control for defining block name

    92

        self.BlockName = wx.TextCtrl(self)

    93

        self.Bind(wx.EVT_TEXT, self.OnNameChanged, self.BlockName)

    94

        top_right_gridsizer.AddWindow(self.BlockName, flag=wx.GROW)

    95

    96

        # Create label for extended block input number

    97

        inputs_label = wx.StaticText(self, label=_('Inputs:'))

    98

        top_right_gridsizer.AddWindow(inputs_label,

    99

                                      flag=wx.ALIGN_CENTER_VERTICAL)

   100

   101

        # Create spin control for defining extended block input number

   102

        self.Inputs = wx.SpinCtrl(self, min=2, max=20,

   103

                                  style=wx.SP_ARROW_KEYS)

   104

        self.Bind(wx.EVT_SPINCTRL, self.OnInputsChanged, self.Inputs)

   105

        top_right_gridsizer.AddWindow(self.Inputs, flag=wx.GROW)

   106

   107

        # Create label for block execution order

   108

        execution_order_label = wx.StaticText(self,

   109

                                              label=_('Execution Order:'))

   110

        top_right_gridsizer.AddWindow(execution_order_label,

   111

                                      flag=wx.ALIGN_CENTER_VERTICAL)

   112

   113

        # Create spin control for defining block execution order

   114

        self.ExecutionOrder = wx.SpinCtrl(self, min=0, style=wx.SP_ARROW_KEYS)

   115

        self.Bind(wx.EVT_SPINCTRL, self.OnExecutionOrderChanged,

   116

                  self.ExecutionOrder)

   117

        top_right_gridsizer.AddWindow(self.ExecutionOrder, flag=wx.GROW)

   118

   119

        # Create label for block execution control

   120

        execution_control_label = wx.StaticText(self,

   121

                                                label=_('Execution Control:'))

   122

        top_right_gridsizer.AddWindow(execution_control_label,

   123

                                      flag=wx.ALIGN_CENTER_VERTICAL)

   124

   125

        # Create check box to enable block execution control

   126

        self.ExecutionControl = wx.CheckBox(self)

   127

        self.Bind(wx.EVT_CHECKBOX, self.OnExecutionOrderChanged,

   128

                  self.ExecutionControl)

   129

        top_right_gridsizer.AddWindow(self.ExecutionControl, flag=wx.GROW)

   130

   131

        # Add preview panel and associated label to sizers

   132

        self.RightGridSizer.AddWindow(self.PreviewLabel, flag=wx.GROW)

   133

        self.RightGridSizer.AddWindow(self.Preview, flag=wx.GROW)

   134

   135

        # Add buttons sizer to sizers

   136

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

   137

                                flag=wx.ALIGN_RIGHT | wx.BOTTOM | wx.LEFT | wx.RIGHT)

   138

   139

        # Dictionary containing correspondence between parameter exchanged and

   140

        # control to fill with parameter value

   141

        self.ParamsControl = {

   142

            "extension": self.Inputs,

   143

            "executionOrder": self.ExecutionOrder,

   144

            "executionControl": self.ExecutionControl

   145

        }

   146

   147

        # Init controls value and sensibility

   148

        self.BlockName.SetValue("")

   149

        self.BlockName.Enable(False)

   150

        self.Inputs.Enable(False)

   151

   152

        # Variable containing last name typed

   153

        self.CurrentBlockName = None

   154

   155

        # Refresh Library panel values

   156

        self.LibraryPanel.SetBlockList(controller.GetBlockTypes(tagname))

   157

        self.Fit()

   158

        self.LibraryPanel.SetFocus()

   159

   160

    def SetValues(self, values):

   161

        """

   162

        Set default block parameters

   163

        @param values: Block parameters values

   164

        """

   165

        # Extract block type defined in parameters

   166

        blocktype = values.get("type", None)

   167

   168

        # Select block type in library panel

   169

        if blocktype is not None:

   170

            self.LibraryPanel.SelectTreeItem(blocktype,

   171

                                             values.get("inputs", None))

   172

   173

        # Define regular expression for determine if block name is block

   174

        # default name

   175

        default_name_model = GetBlockTypeDefaultNameModel(blocktype)

   176

   177

        # For each parameters defined, set corresponding control value

   178

        for name, value in values.items():

   179

   180

            # Parameter is block name

   181

            if name == "name":

   182

                if value != "":

   183

                    # Set default graphic element name for testing

   184

                    self.DefaultElementName = value

   185

   186

                    # Test if block name is type default block name and save

   187

                    # block name if not (name have been typed by user)

   188

                    if default_name_model.match(value) is None:

   189

                        self.CurrentBlockName = value

   190

   191

                self.BlockName.ChangeValue(value)

   192

   193

            # Set value of other controls

   194

            else:

   195

                control = self.ParamsControl.get(name, None)

   196

                if control is not None:

   197

                    control.SetValue(value)

   198

   199

        # Refresh preview panel

   200

        self.RefreshPreview()

   201

   202

    def GetValues(self):

   203

        """

   204

        Return block parameters defined in dialog

   205

        @return: {parameter_name: parameter_value,...}

   206

        """

   207

        values = self.LibraryPanel.GetSelectedBlock()

   208

        if self.BlockName.IsEnabled() and self.BlockName.GetValue() != "":

   209

            values["name"] = self.BlockName.GetValue()

   210

        values["width"], values["height"] = self.Element.GetSize()

   211

        values.update({

   212

            name: control.GetValue()

   213

            for name, control in self.ParamsControl.iteritems()})

   214

        return values

   215

   216

    def OnOK(self, event):

   217

        """

   218

        Called when dialog OK button is pressed

   219

        Test if parameters defined are valid

   220

        @param event: wx.Event from OK button

   221

        """

   222

        message = None

   223

   224

        # Get block type selected

   225

        selected = self.LibraryPanel.GetSelectedBlock()

   226

   227

        # Get block type name and if block is a function block

   228

        block_name = self.BlockName.GetValue()

   229

        name_enabled = self.BlockName.IsEnabled()

   230

   231

        # Test that a type has been selected for block

   232

        if selected is None:

   233

            message = _("Form isn't complete. Valid block type must be selected!")

   234

   235

        # Test, if block is a function block, that a name have been defined

   236

        elif name_enabled and block_name == "":

   237

            message = _("Form isn't complete. Name must be filled!")

   238

   239

        # Show error message if an error is detected

   240

        if message is not None:

   241

            self.ShowErrorMessage(message)

   242

   243

        # Test block name validity if necessary

   244

        elif not name_enabled or self.TestElementName(block_name):

   245

            # Call BlockPreviewDialog function

   246

            BlockPreviewDialog.OnOK(self, event)

   247

   248

    def OnLibraryTreeItemSelected(self, event):

   249

        """

   250

        Called when block type selected in library panel

   251

        @param event: wx.TreeEvent

   252

        """

   253

        # Get type selected in library panel

   254

        values = self.LibraryPanel.GetSelectedBlock()

   255

   256

        # Get block type informations

   257

        blocktype = (self.Controller.GetBlockType(values["type"],

   258

                                                  values["inputs"])

   259

                     if values is not None else None)

   260

   261

        # Set input number spin control according to block type informations

   262

        if blocktype is not None:

   263

            self.Inputs.SetValue(len(blocktype["inputs"]))

   264

            self.Inputs.Enable(blocktype["extensible"])

   265

        else:

   266

            self.Inputs.SetValue(2)

   267

            self.Inputs.Enable(False)

   268

   269

        # Update block name with default value if block type is a function and

   270

        # current block name wasn't typed by user

   271

        if blocktype is not None and blocktype["type"] != "function":

   272

            self.BlockName.Enable(True)

   273

   274

            if self.CurrentBlockName is None:

   275

                # Generate new block name according to block type, taking

   276

                # default element name if it was already a default name for this

   277

                # block type

   278

                default_name_model = GetBlockTypeDefaultNameModel(values["type"])

   279

                block_name = (

   280

                    self.DefaultElementName

   281

                    if (self.DefaultElementName is not None and

   282

                        default_name_model.match(self.DefaultElementName))

   283

                    else self.Controller.GenerateNewName(

   284

                        self.TagName, None, values["type"]+"%d", 0))

   285

            else:

   286

                block_name = self.CurrentBlockName

   287

   288

            self.BlockName.ChangeValue(block_name)

   289

        else:

   290

            self.BlockName.Enable(False)

   291

            self.BlockName.ChangeValue("")

   292

   293

        # Refresh preview panel

   294

        self.RefreshPreview()

   295

   296

    def OnNameChanged(self, event):

   297

        """

   298

        Called when block name value changed

   299

        @param event: wx.TextEvent

   300

        """

   301

        if self.BlockName.IsEnabled():

   302

            # Save block name typed by user

   303

            self.CurrentBlockName = self.BlockName.GetValue()

   304

            self.RefreshPreview()

   305

        event.Skip()

   306

   307

    def OnInputsChanged(self, event):

   308

        """

   309

        Called when block inputs number changed

   310

        @param event: wx.SpinEvent

   311

        """

   312

        if self.Inputs.IsEnabled():

   313

            self.RefreshPreview()

   314

        event.Skip()

   315

   316

    def OnExecutionOrderChanged(self, event):

   317

        """

   318

        Called when block execution order value changed

   319

        @param event: wx.SpinEvent

   320

        """

   321

        self.RefreshPreview()

   322

        event.Skip()

   323

   324

    def OnExecutionControlChanged(self, event):

   325

        """

   326

        Called when block execution control value changed

   327

        @param event: wx.SpinEvent

   328

        """

   329

        self.RefreshPreview()

   330

        event.Skip()

   331

   332

    def RefreshPreview(self):

   333

        """

   334

        Refresh preview panel of graphic element

   335

        Override BlockPreviewDialog function

   336

        """

   337

        # Get type selected in library panel

   338

        values = self.LibraryPanel.GetSelectedBlock()

   339

   340

        # If a block type is selected in library panel

   341

        if values is not None:

   342

            # Set graphic element displayed, creating a FBD block element

   343

            self.Element = FBD_Block(

   344

                self.Preview, values["type"],

   345

                (self.BlockName.GetValue() if self.BlockName.IsEnabled() else ""),

   346

                extension=self.Inputs.GetValue(),

   347

                inputs=values["inputs"],

   348

                executionControl=self.ExecutionControl.GetValue(),

   349

                executionOrder=self.ExecutionOrder.GetValue())

   350

   351

        # Reset graphic element displayed

   352

        else:

   353

            self.Element = None

   354

   355

        # Call BlockPreviewDialog function

   356

        BlockPreviewDialog.RefreshPreview(self)