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) 2007: 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 graphics import *

    28

    29

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

    30

#                          Create New Block Dialog

    31

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

    32

    33

[ID_FBDBLOCKDIALOG, ID_FBDBLOCKDIALOGNAME, 

    34

 ID_FBDBLOCKDIALOGTYPETREE, ID_FBDBLOCKDIALOGTYPEDESC, 

    35

 ID_FBDBLOCKDIALOGINPUTS, ID_FBDBLOCKDIALOGPREVIEW, 

    36

 ID_FBDBLOCKDIALOGEXECUTIONORDER, ID_FBDBLOCKDIALOGEXECUTIONCONTROL, 

    37

 ID_FBDBLOCKDIALOGSTATICTEXT1, ID_FBDBLOCKDIALOGSTATICTEXT2, 

    38

 ID_FBDBLOCKDIALOGSTATICTEXT3, ID_FBDBLOCKDIALOGSTATICTEXT4, 

    39

 ID_FBDBLOCKDIALOGSTATICTEXT5, ID_FBDBLOCKDIALOGSTATICTEXT6, 

    40

] = [wx.NewId() for _init_ctrls in range(14)]

    41

    42

[CATEGORY, BLOCK] = range(2)

    43

    44

class FBDBlockDialog(wx.Dialog):

    45

    46

    if wx.VERSION < (2, 6, 0):

    47

        def Bind(self, event, function, id = None):

    48

            if id is not None:

    49

                event(self, id, function)

    50

            else:

    51

                event(self, function)

    52

    53

    def _init_coll_flexGridSizer1_Items(self, parent):

    54

        parent.AddSizer(self.MainSizer, 0, border=20, flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)

    55

        parent.AddSizer(self.ButtonSizer, 0, border=20, flag=wx.ALIGN_RIGHT|wx.BOTTOM|wx.LEFT|wx.RIGHT)

    56

    57

    def _init_coll_flexGridSizer1_Growables(self, parent):

    58

        parent.AddGrowableCol(0)

    59

        parent.AddGrowableRow(0)

    60

    61

    def _init_coll_MainSizer_Items(self, parent):

    62

        parent.AddSizer(self.LeftBoxSizer, 1, border=5, flag=wx.GROW|wx.RIGHT)

    63

        parent.AddSizer(self.RightGridSizer, 1, border=5, flag=wx.GROW|wx.LEFT)

    64

    65

    def _init_coll_LeftBoxSizer_Items(self, parent):

    66

        parent.AddWindow(self.TypeTree, 3, border=5, flag=wx.GROW|wx.BOTTOM)

    67

        parent.AddWindow(self.TypeDesc, 1, border=0, flag=wx.GROW)

    68

    69

    def _init_coll_RightGridSizer_Items(self, parent):

    70

        parent.AddSizer(self.RightUpGridSizer, 0, border=0, flag=wx.GROW)

    71

        parent.AddWindow(self.staticText6, 0, border=0, flag=wx.GROW)

    72

        parent.AddWindow(self.Preview, 0, border=0, flag=wx.GROW)

    73

    74

    def _init_coll_RightGridSizer_Growables(self, parent):

    75

        parent.AddGrowableCol(0)

    76

        parent.AddGrowableRow(2)

    77

    78

    def _init_coll_RightUpGridSizer_Items(self, parent):

    79

        parent.AddWindow(self.staticText2, 0, border=4, flag=wx.ALIGN_CENTER_VERTICAL|wx.TOP)

    80

        parent.AddWindow(self.BlockName, 0, border=0, flag=wx.GROW)

    81

        parent.AddWindow(self.staticText3, 0, border=4, flag=wx.ALIGN_CENTER_VERTICAL|wx.TOP)

    82

        parent.AddWindow(self.Inputs, 0, border=0, flag=wx.GROW)

    83

        parent.AddWindow(self.staticText4, 0, border=4, flag=wx.ALIGN_CENTER_VERTICAL|wx.TOP)

    84

        parent.AddWindow(self.ExecutionOrder, 0, border=0, flag=wx.GROW)

    85

        parent.AddWindow(self.staticText5, 0, border=4, flag=wx.ALIGN_CENTER_VERTICAL|wx.TOP)

    86

        parent.AddWindow(self.ExecutionControl, 0, border=0, flag=wx.GROW)

    87

    88

    def _init_coll_RightUpGridSizer_Growables(self, parent):

    89

        parent.AddGrowableCol(1)

    90

    91

    def _init_sizers(self):

    92

        self.flexGridSizer1 = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=10)

    93

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

    94

        self.LeftBoxSizer = wx.StaticBoxSizer(self.staticbox1, wx.VERTICAL)

    95

        self.RightGridSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=3, vgap=5)

    96

        self.RightUpGridSizer = wx.FlexGridSizer(cols=2, hgap=5, rows=4, vgap=5)

    97

    98

        self._init_coll_flexGridSizer1_Items(self.flexGridSizer1)

    99

        self._init_coll_flexGridSizer1_Growables(self.flexGridSizer1)

   100

        self._init_coll_MainSizer_Items(self.MainSizer)

   101

        self._init_coll_LeftBoxSizer_Items(self.LeftBoxSizer)

   102

        self._init_coll_RightGridSizer_Items(self.RightGridSizer)

   103

        self._init_coll_RightGridSizer_Growables(self.RightGridSizer)

   104

        self._init_coll_RightUpGridSizer_Items(self.RightUpGridSizer)

   105

        self._init_coll_RightUpGridSizer_Growables(self.RightUpGridSizer)

   106

   107

        self.SetSizer(self.flexGridSizer1)

   108

   109

    def _init_ctrls(self, prnt):

   110

        wx.Dialog.__init__(self, id=ID_FBDBLOCKDIALOG,

   111

              name='FBDBlockDialog', parent=prnt,

   112

              size=wx.Size(600, 400), style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER,

   113

              title=_('Block Properties'))

   114

        self.SetClientSize(wx.Size(600, 400))

   115

   116

        self.staticbox1 = wx.StaticBox(id=ID_FBDBLOCKDIALOGSTATICTEXT1,

   117

              label=_('Type:'), name='staticBox1', parent=self,

   118

              pos=wx.Point(0, 0), size=wx.Size(0, 0), style=0)

   119

   120

        self.staticText2 = wx.StaticText(id=ID_FBDBLOCKDIALOGSTATICTEXT2,

   121

              label=_('Name:'), name='staticText2', parent=self,

   122

              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

   123

   124

        self.staticText3 = wx.StaticText(id=ID_FBDBLOCKDIALOGSTATICTEXT2,

   125

              label=_('Inputs:'), name='staticText4', parent=self,

   126

              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

   127

   128

        self.staticText4 = wx.StaticText(id=ID_FBDBLOCKDIALOGSTATICTEXT4,

   129

              label=_('Execution Order:'), name='staticText4', parent=self,

   130

              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

   131

   132

        self.staticText5 = wx.StaticText(id=ID_FBDBLOCKDIALOGSTATICTEXT5,

   133

              label=_('Execution Control:'), name='staticText5', parent=self,

   134

              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

   135

   136

        self.staticText6 = wx.StaticText(id=ID_FBDBLOCKDIALOGSTATICTEXT6,

   137

              label=_('Preview:'), name='staticText6', parent=self,

   138

              pos=wx.Point(0, 0), size=wx.DefaultSize, style=0)

   139

   140

        self.TypeTree = wx.TreeCtrl(id=ID_FBDBLOCKDIALOGTYPETREE,

   141

              name='TypeTree', parent=self, pos=wx.Point(0, 0),

   142

              size=wx.Size(0, 0), style=wx.TR_HAS_BUTTONS|wx.TR_SINGLE|wx.SUNKEN_BORDER|wx.TR_HIDE_ROOT|wx.TR_LINES_AT_ROOT)

   143

        self.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTypeTreeItemSelected,

   144

              id=ID_FBDBLOCKDIALOGTYPETREE)

   145

   146

        self.TypeDesc = wx.TextCtrl(id=ID_FBDBLOCKDIALOGTYPEDESC,

   147

              name='TypeDesc', parent=self, pos=wx.Point(0, 0),

   148

              size=wx.Size(0, 0), style=wx.TE_READONLY|wx.TE_MULTILINE)

   149

   150

        self.BlockName = wx.TextCtrl(id=ID_FBDBLOCKDIALOGNAME, value='',

   151

              name='BlockName', parent=self, pos=wx.Point(0, 0),

   152

              size=wx.Size(0, 24), style=0)

   153

        self.Bind(wx.EVT_TEXT, self.OnNameChanged, id=ID_FBDBLOCKDIALOGNAME)

   154

   155

        self.Inputs = wx.SpinCtrl(id=ID_FBDBLOCKDIALOGINPUTS,

   156

              name='Inputs', parent=self, pos=wx.Point(0, 0),

   157

              size=wx.Size(0, 24), style=wx.SP_ARROW_KEYS, min=2, max=20)

   158

        self.Bind(wx.EVT_SPINCTRL, self.OnInputsChanged, id=ID_FBDBLOCKDIALOGINPUTS)

   159

   160

        self.ExecutionOrder = wx.SpinCtrl(id=ID_FBDBLOCKDIALOGEXECUTIONORDER,

   161

              name='ExecutionOrder', parent=self, pos=wx.Point(0, 0),

   162

              size=wx.Size(0, 24), style=wx.SP_ARROW_KEYS, min=0)

   163

        self.Bind(wx.EVT_SPINCTRL, self.OnExecutionOrderChanged, id=ID_FBDBLOCKDIALOGEXECUTIONORDER)

   164

   165

        self.ExecutionControl = wx.CheckBox(id=ID_FBDBLOCKDIALOGEXECUTIONCONTROL,

   166

              name='ExecutionControl', parent=self, pos=wx.Point(0, 0),

   167

              size=wx.Size(0, 24), style=0)

   168

        self.Bind(wx.EVT_CHECKBOX, self.OnExecutionOrderChanged, id=ID_FBDBLOCKDIALOGEXECUTIONCONTROL)

   169

   170

        self.Preview = wx.Panel(id=ID_FBDBLOCKDIALOGPREVIEW,

   171

              name='Preview', parent=self, pos=wx.Point(0, 0),

   172

              size=wx.Size(0, 0), style=wx.TAB_TRAVERSAL|wx.SIMPLE_BORDER)

   173

        self.Preview.SetBackgroundColour(wx.Colour(255,255,255))

   174

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

   175

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

   176

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

   177

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

   178

   179

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

   180

        if wx.VERSION >= (2, 5, 0):

   181

            self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.ButtonSizer.GetAffirmativeButton().GetId())

   182

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

   183

        else:

   184

            self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.ButtonSizer.GetChildren()[0].GetSizer().GetChildren()[0].GetWindow().GetId())

   185

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

   186

   187

        self._init_sizers()

   188

   189

    def __init__(self, parent, controler):

   190

        self.Controler = controler

   191

        self._init_ctrls(parent)

   192

        self.BlockName.SetValue("")

   193

        self.BlockName.Enable(False)

   194

        self.Inputs.Enable(False)

   195

        self.Block = None

   196

        self.MinBlockSize = None

   197

        self.First = True

   198

   199

        self.PouNames = []

   200

        self.PouElementNames = []

   201

   202

        self.TypeTree.SetFocus()

   203

   204

    def SetPreviewFont(self, font):

   205

        self.Preview.SetFont(font)

   206

   207

    def FindTreeItem(self, root, name, inputs = None):

   208

        if root.IsOk():

   209

            pydata = self.TypeTree.GetPyData(root)

   210

            if pydata is not None:

   211

                type_inputs = pydata.get("inputs", None)

   212

                type_extension = pydata.get("extension", None)

   213

                if inputs is not None and type_inputs is not None:

   214

                    if type_extension is not None:

   215

                        same_inputs = type_inputs == inputs[:type_extension]

   216

                    else:

   217

                        same_inputs = type_inputs == inputs

   218

                else:

   219

                    same_inputs = True

   220

            if pydata is not None and self.TypeTree.GetItemText(root) == name and same_inputs:

   221

                return root

   222

            else:

   223

                if wx.VERSION < (2, 6, 0):

   224

                    item, root_cookie = self.TypeTree.GetFirstChild(root, 0)

   225

                else:

   226

                    item, root_cookie = self.TypeTree.GetFirstChild(root)

   227

                while item.IsOk():

   228

                    result = self.FindTreeItem(item, name, inputs)

   229

                    if result:

   230

                        return result

   231

                    item, root_cookie = self.TypeTree.GetNextChild(root, root_cookie)

   232

        return None

   233

   234

    def OnOK(self, event):

   235

        selected = self.TypeTree.GetSelection()

   236

        block_name = self.BlockName.GetValue()

   237

        name_enabled = self.BlockName.IsEnabled()

   238

        if not selected.IsOk() or self.TypeTree.GetItemParent(selected) == self.TypeTree.GetRootItem() or selected == self.TypeTree.GetRootItem():

   239

            message = wx.MessageDialog(self, _("Form isn't complete. Valid block type must be selected!"), _("Error"), wx.OK|wx.ICON_ERROR)

   240

            message.ShowModal()

   241

            message.Destroy()

   242

        elif name_enabled and block_name == "":

   243

            message = wx.MessageDialog(self, _("Form isn't complete. Name must be filled!"), _("Error"), wx.OK|wx.ICON_ERROR)

   244

            message.ShowModal()

   245

            message.Destroy()

   246

        elif name_enabled and not TestIdentifier(block_name):

   247

            message = wx.MessageDialog(self, _("\"%s\" is not a valid identifier!")%block_name, _("Error"), wx.OK|wx.ICON_ERROR)

   248

            message.ShowModal()

   249

            message.Destroy()

   250

        elif name_enabled and block_name.upper() in IEC_KEYWORDS:

   251

            message = wx.MessageDialog(self, _("\"%s\" is a keyword. It can't be used!")%block_name, _("Error"), wx.OK|wx.ICON_ERROR)

   252

            message.ShowModal()

   253

            message.Destroy()

   254

        elif name_enabled and block_name.upper() in self.PouNames:

   255

            message = wx.MessageDialog(self, _("\"%s\" pou already exists!")%block_name, _("Error"), wx.OK|wx.ICON_ERROR)

   256

            message.ShowModal()

   257

            message.Destroy()

   258

        elif name_enabled and block_name.upper() in self.PouElementNames:

   259

            message = wx.MessageDialog(self, _("\"%s\" element for this pou already exists!")%block_name, _("Error"), wx.OK|wx.ICON_ERROR)

   260

            message.ShowModal()

   261

            message.Destroy()

   262

        else:

   263

            self.EndModal(wx.ID_OK)

   264

   265

    def SetBlockList(self, blocktypes):

   266

        root = self.TypeTree.AddRoot("")

   267

        for category in blocktypes:

   268

            category_name = category["name"]

   269

            category_item = self.TypeTree.AppendItem(root, _(category_name))

   270

            self.TypeTree.SetPyData(category_item, {"type" : CATEGORY})

   271

            for blocktype in category["list"]:

   272

                blocktype_item = self.TypeTree.AppendItem(category_item, blocktype["name"])

   273

                block_data = {"type" : BLOCK, 

   274

                              "inputs" : tuple([type for name, type, modifier in blocktype["inputs"]]),

   275

                              "extension" : None}

   276

                if blocktype["extensible"]:

   277

                    block_data["extension"] = len(blocktype["inputs"])

   278

                self.TypeTree.SetPyData(blocktype_item, block_data)

   279

   280

    def SetMinBlockSize(self, size):

   281

        self.MinBlockSize = size

   282

   283

    def SetPouNames(self, pou_names):

   284

        self.PouNames = [pou_name.upper() for pou_name in pou_names]

   285

   286

    def SetPouElementNames(self, element_names):

   287

        self.PouElementNames = [element_name.upper() for element_name in element_names]

   288

   289

    def SetValues(self, values):

   290

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

   291

        if blocktype is not None:

   292

            inputs = values.get("inputs", None)

   293

            item = self.FindTreeItem(self.TypeTree.GetRootItem(), blocktype, inputs)

   294

            if item:

   295

                self.TypeTree.SelectItem(item)

   296

                self.TypeTree.EnsureVisible(item)

   297

        for name, value in values.items():

   298

            if name == "name":

   299

                self.BlockName.SetValue(value)

   300

            elif name == "extension":

   301

                self.Inputs.SetValue(value)

   302

            elif name == "executionOrder":

   303

                self.ExecutionOrder.SetValue(value)

   304

            elif name == "executionControl":

   305

                   self.ExecutionControl.SetValue(value)

   306

        self.RefreshPreview()

   307

   308

    def GetValues(self):

   309

        values = {}

   310

        item = self.TypeTree.GetSelection()

   311

        values["type"] = self.TypeTree.GetItemText(item)

   312

        values["inputs"] = self.TypeTree.GetPyData(item)["inputs"]

   313

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

   314

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

   315

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

   316

        values["extension"] = self.Inputs.GetValue()

   317

        values["executionOrder"] = self.ExecutionOrder.GetValue()

   318

        values["executionControl"] = self.ExecutionControl.GetValue()

   319

        return values

   320

   321

    def OnTypeTreeItemSelected(self, event):

   322

        self.BlockName.SetValue("")

   323

        selected = event.GetItem()

   324

        pydata = self.TypeTree.GetPyData(selected)

   325

        if pydata["type"] != CATEGORY:

   326

            blocktype = self.Controler.GetBlockType(self.TypeTree.GetItemText(selected), pydata["inputs"])

   327

            if blocktype:

   328

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

   329

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

   330

                self.BlockName.Enable(blocktype["type"] != "function")

   331

                comment = blocktype["comment"]

   332

                self.TypeDesc.SetValue(_(comment) + blocktype.get("usage", ""))

   333

                wx.CallAfter(self.RefreshPreview)

   334

            else:

   335

                self.BlockName.Enable(False)

   336

                self.Inputs.Enable(False)

   337

                self.Inputs.SetValue(2)

   338

                self.TypeDesc.SetValue("")

   339

                wx.CallAfter(self.ErasePreview)

   340

        else:

   341

            self.BlockName.Enable(False)

   342

            self.Inputs.Enable(False)

   343

            self.Inputs.SetValue(2)

   344

            self.TypeDesc.SetValue("")

   345

            wx.CallAfter(self.ErasePreview)

   346

        event.Skip()

   347

   348

    def OnNameChanged(self, event):

   349

        if self.BlockName.IsEnabled():

   350

            self.RefreshPreview()

   351

        event.Skip()

   352

   353

    def OnInputsChanged(self, event):

   354

        if self.Inputs.IsEnabled():

   355

            self.RefreshPreview()

   356

        event.Skip()

   357

   358

    def OnExecutionOrderChanged(self, event):

   359

        self.RefreshPreview()

   360

        event.Skip()

   361

   362

    def OnExecutionControlChanged(self, event):

   363

        self.RefreshPreview()

   364

        event.Skip()

   365

   366

    def ErasePreview(self):

   367

        dc = wx.ClientDC(self.Preview)

   368

        dc.Clear()

   369

        self.Block = None

   370

   371

    def RefreshPreview(self):

   372

        dc = wx.ClientDC(self.Preview)

   373

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

   374

        dc.Clear()

   375

        item = self.TypeTree.GetSelection()

   376

        if item.IsOk():

   377

            pydata = self.TypeTree.GetPyData(item)

   378

            if pydata["type"] == CATEGORY:

   379

                self.Block = None

   380

            else:

   381

                blocktype = self.TypeTree.GetItemText(item)

   382

                if blocktype:

   383

                    self.Block = FBD_Block(self.Preview, blocktype, 

   384

                            self.BlockName.GetValue(), 

   385

                            extension = self.Inputs.GetValue(), 

   386

                            inputs = pydata["inputs"], 

   387

                            executionControl = self.ExecutionControl.GetValue(), 

   388

                            executionOrder = self.ExecutionOrder.GetValue())

   389

                    width, height = self.MinBlockSize

   390

                    min_width, min_height = self.Block.GetMinSize()

   391

                    width, height = max(min_width, width), max(min_height, height)

   392

                    self.Block.SetSize(width, height)

   393

                    clientsize = self.Preview.GetClientSize()

   394

                    x = (clientsize.width - width) / 2

   395

                    y = (clientsize.height - height) / 2

   396

                    self.Block.SetPosition(x, y)

   397

                    self.Block.Draw(dc)

   398

                else:

   399

                    self.Block = None

   400

   401

    def OnPaint(self, event):

   402

        if self.Block is not None:

   403

            self.RefreshPreview()

   404

        event.Skip()