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

from controls import LibraryPanel

    29

    30

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

    31

#                          Create New Block Dialog

    32

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

    33

    34

[ID_FBDBLOCKDIALOG, ID_FBDBLOCKDIALOGNAME, 

    35

 ID_FBDBLOCKDIALOGTYPETREE, ID_FBDBLOCKDIALOGTYPEDESC, 

    36

 ID_FBDBLOCKDIALOGINPUTS, ID_FBDBLOCKDIALOGPREVIEW, 

    37

 ID_FBDBLOCKDIALOGEXECUTIONORDER, ID_FBDBLOCKDIALOGEXECUTIONCONTROL, 

    38

 ID_FBDBLOCKDIALOGSTATICTEXT1, ID_FBDBLOCKDIALOGSTATICTEXT2, 

    39

 ID_FBDBLOCKDIALOGSTATICTEXT3, ID_FBDBLOCKDIALOGSTATICTEXT4, 

    40

 ID_FBDBLOCKDIALOGSTATICTEXT5, ID_FBDBLOCKDIALOGSTATICTEXT6, 

    41

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

    42

    43

[CATEGORY, BLOCK] = range(2)

    44

    45

class FBDBlockDialog(wx.Dialog):

    46

    47

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

    48

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

    49

            if id is not None:

    50

                event(self, id, function)

    51

            else:

    52

                event(self, function)

    53

    54

    def _init_coll_flexGridSizer1_Items(self, parent):

    55

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

    56

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

    57

    58

    def _init_coll_flexGridSizer1_Growables(self, parent):

    59

        parent.AddGrowableCol(0)

    60

        parent.AddGrowableRow(0)

    61

    62

    def _init_coll_MainSizer_Items(self, parent):

    63

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

    64

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

    65

    66

    def _init_coll_LeftBoxSizer_Items(self, parent):

    67

        parent.AddWindow(self.LibraryPanel, 1, border=5, flag=wx.GROW|wx.TOP)

    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.LibraryPanel = LibraryPanel(self)

   141

   142

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

   143

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

   144

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

   145

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

   146

   147

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

   148

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

   149

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

   150

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

   151

   152

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

   153

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

   154

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

   155

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

   156

   157

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

   158

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

   159

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

   160

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

   161

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

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

   169

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

   170

   171

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

   172

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

   173

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

   174

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

   175

        else:

   176

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

   177

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

   178

   179

        self._init_sizers()

   180

   181

    def __init__(self, parent, controler):

   182

        self.Controler = controler

   183

        self._init_ctrls(parent)

   184

        self.BlockName.SetValue("")

   185

        self.BlockName.Enable(False)

   186

        self.Inputs.Enable(False)

   187

        self.Block = None

   188

        self.MinBlockSize = None

   189

        self.First = True

   190

   191

        self.PouNames = []

   192

        self.PouElementNames = []

   193

   194

        self.LibraryPanel.SetControler(controler)

   195

        setattr(self.LibraryPanel, "_OnTreeItemSelected", self.OnLibraryTreeItemSelected)

   196

        self.LibraryPanel.SetFocus()

   197

   198

    def SetBlockList(self, blocklist):

   199

        self.LibraryPanel.SetBlockList(blocklist)

   200

   201

    def SetPreviewFont(self, font):

   202

        self.Preview.SetFont(font)

   203

   204

    def OnOK(self, event):

   205

        selected = self.LibraryPanel.GetSelectedBlock()

   206

        block_name = self.BlockName.GetValue()

   207

        name_enabled = self.BlockName.IsEnabled()

   208

        if selected is None:

   209

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

   210

            message.ShowModal()

   211

            message.Destroy()

   212

        elif name_enabled and block_name == "":

   213

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

   214

            message.ShowModal()

   215

            message.Destroy()

   216

        elif name_enabled and not TestIdentifier(block_name):

   217

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

   218

            message.ShowModal()

   219

            message.Destroy()

   220

        elif name_enabled and block_name.upper() in IEC_KEYWORDS:

   221

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

   222

            message.ShowModal()

   223

            message.Destroy()

   224

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

   225

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

   226

            message.ShowModal()

   227

            message.Destroy()

   228

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

   229

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

   230

            message.ShowModal()

   231

            message.Destroy()

   232

        else:

   233

            self.EndModal(wx.ID_OK)

   234

   235

    def SetMinBlockSize(self, size):

   236

        self.MinBlockSize = size

   237

   238

    def SetPouNames(self, pou_names):

   239

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

   240

   241

    def SetPouElementNames(self, element_names):

   242

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

   243

   244

    def SetValues(self, values):

   245

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

   246

        if blocktype is not None:

   247

            self.LibraryPanel.SelectTreeItem(blocktype, values.get("inputs", None))

   248

        for name, value in values.items():

   249

            if name == "name":

   250

                self.BlockName.SetValue(value)

   251

            elif name == "extension":

   252

                self.Inputs.SetValue(value)

   253

            elif name == "executionOrder":

   254

                self.ExecutionOrder.SetValue(value)

   255

            elif name == "executionControl":

   256

                   self.ExecutionControl.SetValue(value)

   257

        self.RefreshPreview()

   258

   259

    def GetValues(self):

   260

        values = self.LibraryPanel.GetSelectedBlock()

   261

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

   262

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

   263

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

   264

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

   265

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

   266

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

   267

        return values

   268

   269

    def OnLibraryTreeItemSelected(self, event):

   270

        values = self.LibraryPanel.GetSelectedBlock()

   271

        if values is not None:

   272

            blocktype = self.Controler.GetBlockType(values["type"], values["inputs"])

   273

        else:

   274

            blocktype = None

   275

        if blocktype is not None:

   276

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

   277

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

   278

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

   279

            wx.CallAfter(self.RefreshPreview)

   280

        else:

   281

            self.BlockName.Enable(False)

   282

            self.Inputs.Enable(False)

   283

            self.Inputs.SetValue(2)

   284

            wx.CallAfter(self.ErasePreview)

   285

   286

    def OnNameChanged(self, event):

   287

        if self.BlockName.IsEnabled():

   288

            self.RefreshPreview()

   289

        event.Skip()

   290

   291

    def OnInputsChanged(self, event):

   292

        if self.Inputs.IsEnabled():

   293

            self.RefreshPreview()

   294

        event.Skip()

   295

   296

    def OnExecutionOrderChanged(self, event):

   297

        self.RefreshPreview()

   298

        event.Skip()

   299

   300

    def OnExecutionControlChanged(self, event):

   301

        self.RefreshPreview()

   302

        event.Skip()

   303

   304

    def ErasePreview(self):

   305

        dc = wx.ClientDC(self.Preview)

   306

        dc.Clear()

   307

        self.Block = None

   308

   309

    def RefreshPreview(self):

   310

        dc = wx.ClientDC(self.Preview)

   311

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

   312

        dc.Clear()

   313

        values = self.LibraryPanel.GetSelectedBlock()

   314

        if values is not None:

   315

            self.Block = FBD_Block(self.Preview, values["type"], 

   316

                    self.BlockName.GetValue(), 

   317

                    extension = self.Inputs.GetValue(), 

   318

                    inputs = values["inputs"], 

   319

                    executionControl = self.ExecutionControl.GetValue(), 

   320

                    executionOrder = self.ExecutionOrder.GetValue())

   321

            width, height = self.MinBlockSize

   322

            min_width, min_height = self.Block.GetMinSize()

   323

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

   324

            self.Block.SetSize(width, height)

   325

            clientsize = self.Preview.GetClientSize()

   326

            x = (clientsize.width - width) / 2

   327

            y = (clientsize.height - height) / 2

   328

            self.Block.SetPosition(x, y)

   329

            self.Block.Draw(dc)

   330

        else:

   331

            self.Block = None        

   332

   333

    def OnPaint(self, event):

   334

        if self.Block is not None:

   335

            self.RefreshPreview()

   336

        event.Skip()