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

    27

from __future__ import absolute_import

    28

import re

    29

    30

import wx

    31

    32

from graphics.FBD_Objects import FBD_Block

    33

from controls.LibraryPanel import LibraryPanel

    34

from dialogs.BlockPreviewDialog import BlockPreviewDialog

    35

    36

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

    37

#                                    Helpers

    38

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

    39

    40

    41

def GetBlockTypeDefaultNameModel(blocktype):

    42

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

    43

    44

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

    45

#                         Set Block Parameters Dialog

    46

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

    47

    48

    49

class FBDBlockDialog(BlockPreviewDialog):

    50

    """

    51

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

    52

    element

    53

    """

    54

    55

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

    56

        """

    57

        Constructor

    58

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

    59

        @param controller: Reference to project controller

    60

        @param tagname: Tagname of project POU edited

    61

        """

    62

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

    63

                                    title=_('Block Properties'))

    64

    65

        # Init common sizers

    66

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

    67

    68

        # Create static box around library panel

    69

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

    70

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

    71

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

    72

    73

        # Create Library panel and add it to static box

    74

        self.LibraryPanel = LibraryPanel(self)

    75

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

    76

    77

        # Set function to call when selection in Library panel changed

    78

        setattr(self.LibraryPanel, "_OnTreeItemSelected",

    79

                self.OnLibraryTreeItemSelected)

    80

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

    81

                                      flag=wx.GROW | wx.TOP)

    82

    83

        # Create sizer for other block parameters

    84

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

    85

        top_right_gridsizer.AddGrowableCol(1)

    86

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

    87

    88

        # Create label for block name

    89

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

    90

        top_right_gridsizer.AddWindow(name_label,

    91

                                      flag=wx.ALIGN_CENTER_VERTICAL)

    92

    93

        # Create text control for defining block name

    94

        self.BlockName = wx.TextCtrl(self)

    95

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

    96

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

    97

    98

        # Create label for extended block input number

    99

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

   100

        top_right_gridsizer.AddWindow(inputs_label,

   101

                                      flag=wx.ALIGN_CENTER_VERTICAL)

   102

   103

        # Create spin control for defining extended block input number

   104

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

   105

                                  style=wx.SP_ARROW_KEYS)

   106

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

   107

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

   108

   109

        # Create label for block execution order

   110

        execution_order_label = wx.StaticText(self,

   111

                                              label=_('Execution Order:'))

   112

        top_right_gridsizer.AddWindow(execution_order_label,

   113

                                      flag=wx.ALIGN_CENTER_VERTICAL)

   114

   115

        # Create spin control for defining block execution order

   116

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

   117

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

   118

                  self.ExecutionOrder)

   119

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

   120

   121

        # Create label for block execution control

   122

        execution_control_label = wx.StaticText(self,

   123

                                                label=_('Execution Control:'))

   124

        top_right_gridsizer.AddWindow(execution_control_label,

   125

                                      flag=wx.ALIGN_CENTER_VERTICAL)

   126

   127

        # Create check box to enable block execution control

   128

        self.ExecutionControl = wx.CheckBox(self)

   129

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

   130

                  self.ExecutionControl)

   131

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

   132

   133

        # Add preview panel and associated label to sizers

   134

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

   135

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

   136

   137

        # Add buttons sizer to sizers

   138

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

   139

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

   140

   141

        # Dictionary containing correspondence between parameter exchanged and

   142

        # control to fill with parameter value

   143

        self.ParamsControl = {

   144

            "extension": self.Inputs,

   145

            "executionOrder": self.ExecutionOrder,

   146

            "executionControl": self.ExecutionControl

   147

        }

   148

   149

        # Init controls value and sensibility

   150

        self.BlockName.SetValue("")

   151

        self.BlockName.Enable(False)

   152

        self.Inputs.Enable(False)

   153

   154

        # Variable containing last name typed

   155

        self.CurrentBlockName = None

   156

   157

        # Refresh Library panel values

   158

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

   159

        self.Fit()

   160

        self.LibraryPanel.SetFocus()

   161

   162

    def SetValues(self, values):

   163

        """

   164

        Set default block parameters

   165

        @param values: Block parameters values

   166

        """

   167

        # Extract block type defined in parameters

   168

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

   169

   170

        # Select block type in library panel

   171

        if blocktype is not None:

   172

            self.LibraryPanel.SelectTreeItem(blocktype,

   173

                                             values.get("inputs", None))

   174

   175

        # Define regular expression for determine if block name is block

   176

        # default name

   177

        default_name_model = GetBlockTypeDefaultNameModel(blocktype)

   178

   179

        # For each parameters defined, set corresponding control value

   180

        for name, value in values.items():

   181

   182

            # Parameter is block name

   183

            if name == "name":

   184

                if value != "":

   185

                    # Set default graphic element name for testing

   186

                    self.DefaultElementName = value

   187

   188

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

   189

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

   190

                    if default_name_model.match(value) is None:

   191

                        self.CurrentBlockName = value

   192

   193

                self.BlockName.ChangeValue(value)

   194

   195

            # Set value of other controls

   196

            else:

   197

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

   198

                if control is not None:

   199

                    control.SetValue(value)

   200

   201

        # Refresh preview panel

   202

        self.RefreshPreview()

   203

   204

    def GetValues(self):

   205

        """

   206

        Return block parameters defined in dialog

   207

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

   208

        """

   209

        values = self.LibraryPanel.GetSelectedBlock()

   210

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

   211

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

   212

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

   213

        values.update({

   214

            name: control.GetValue()

   215

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

   216

        return values

   217

   218

    def OnOK(self, event):

   219

        """

   220

        Called when dialog OK button is pressed

   221

        Test if parameters defined are valid

   222

        @param event: wx.Event from OK button

   223

        """

   224

        message = None

   225

   226

        # Get block type selected

   227

        selected = self.LibraryPanel.GetSelectedBlock()

   228

   229

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

   230

        block_name = self.BlockName.GetValue()

   231

        name_enabled = self.BlockName.IsEnabled()

   232

   233

        # Test that a type has been selected for block

   234

        if selected is None:

   235

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

   236

   237

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

   238

        elif name_enabled and block_name == "":

   239

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

   240

   241

        # Show error message if an error is detected

   242

        if message is not None:

   243

            self.ShowErrorMessage(message)

   244

   245

        # Test block name validity if necessary

   246

        elif not name_enabled or self.TestElementName(block_name):

   247

            # Call BlockPreviewDialog function

   248

            BlockPreviewDialog.OnOK(self, event)

   249

   250

    def OnLibraryTreeItemSelected(self, event):

   251

        """

   252

        Called when block type selected in library panel

   253

        @param event: wx.TreeEvent

   254

        """

   255

        # Get type selected in library panel

   256

        values = self.LibraryPanel.GetSelectedBlock()

   257

   258

        # Get block type informations

   259

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

   260

                                                  values["inputs"])

   261

                     if values is not None else None)

   262

   263

        # Set input number spin control according to block type informations

   264

        if blocktype is not None:

   265

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

   266

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

   267

        else:

   268

            self.Inputs.SetValue(2)

   269

            self.Inputs.Enable(False)

   270

   271

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

   272

        # current block name wasn't typed by user

   273

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

   274

            self.BlockName.Enable(True)

   275

   276

            if self.CurrentBlockName is None:

   277

                # Generate new block name according to block type, taking

   278

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

   279

                # block type

   280

                default_name_model = GetBlockTypeDefaultNameModel(values["type"])

   281

                block_name = (

   282

                    self.DefaultElementName

   283

                    if (self.DefaultElementName is not None and

   284

                        default_name_model.match(self.DefaultElementName))

   285

                    else self.Controller.GenerateNewName(

   286

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

   287

            else:

   288

                block_name = self.CurrentBlockName

   289

   290

            self.BlockName.ChangeValue(block_name)

   291

        else:

   292

            self.BlockName.Enable(False)

   293

            self.BlockName.ChangeValue("")

   294

   295

        # Refresh preview panel

   296

        self.RefreshPreview()

   297

   298

    def OnNameChanged(self, event):

   299

        """

   300

        Called when block name value changed

   301

        @param event: wx.TextEvent

   302

        """

   303

        if self.BlockName.IsEnabled():

   304

            # Save block name typed by user

   305

            self.CurrentBlockName = self.BlockName.GetValue()

   306

            self.RefreshPreview()

   307

        event.Skip()

   308

   309

    def OnInputsChanged(self, event):

   310

        """

   311

        Called when block inputs number changed

   312

        @param event: wx.SpinEvent

   313

        """

   314

        if self.Inputs.IsEnabled():

   315

            self.RefreshPreview()

   316

        event.Skip()

   317

   318

    def OnExecutionOrderChanged(self, event):

   319

        """

   320

        Called when block execution order value changed

   321

        @param event: wx.SpinEvent

   322

        """

   323

        self.RefreshPreview()

   324

        event.Skip()

   325

   326

    def OnExecutionControlChanged(self, event):

   327

        """

   328

        Called when block execution control value changed

   329

        @param event: wx.SpinEvent

   330

        """

   331

        self.RefreshPreview()

   332

        event.Skip()

   333

   334

    def DrawPreview(self):

   335

        """

   336

        Refresh preview panel of graphic element

   337

        Override BlockPreviewDialog function

   338

        """

   339

        # Get type selected in library panel

   340

        values = self.LibraryPanel.GetSelectedBlock()

   341

   342

        # If a block type is selected in library panel

   343

        if values is not None:

   344

            # Set graphic element displayed, creating a FBD block element

   345

            self.Element = FBD_Block(

   346

                self.Preview, values["type"],

   347

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

   348

                extension=self.Inputs.GetValue(),

   349

                inputs=values["inputs"],

   350

                executionControl=self.ExecutionControl.GetValue(),

   351

                executionOrder=self.ExecutionOrder.GetValue())

   352

   353

        # Reset graphic element displayed

   354

        else:

   355

            self.Element = None

   356

   357

        # Call BlockPreviewDialog function

   358

        BlockPreviewDialog.DrawPreview(self)