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 plcopen.structures import *

    28

from PLCControler import ITEM_POU

    29

    30

from Dialogs import *

    31

    32

SCROLLBAR_UNIT = 10

    33

WINDOW_BORDER = 10

    34

SCROLL_ZONE = 10

    35

    42

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

    43

#                       Graphic elements Viewer base class

    44

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

    45

    46

# ID Constants for menu items

    47

[ID_FBDVIEWERCONTEXTUALMENUITEMS0, ID_FBDVIEWERCONTEXTUALMENUITEMS1,

    48

 ID_FBDVIEWERCONTEXTUALMENUITEMS2, ID_FBDVIEWERCONTEXTUALMENUITEMS3,

    49

 ID_FBDVIEWERCONTEXTUALMENUITEMS5, ID_FBDVIEWERCONTEXTUALMENUITEMS6,

    50

 ID_FBDVIEWERCONTEXTUALMENUITEMS8, ID_FBDVIEWERCONTEXTUALMENUITEMS9,

    51

 ID_FBDVIEWERCONTEXTUALMENUITEMS11, ID_FBDVIEWERCONTEXTUALMENUITEMS12,

    52

] = [wx.NewId() for _init_coll_ContextualMenu_Items in range(10)]

    53

    54

    55

class ViewerDropTarget(wx.TextDropTarget):

    56

    57

    def __init__(self, parent):

    58

        wx.TextDropTarget.__init__(self)

    59

        self.ParentWindow = parent

    60

    61

    def OnDropText(self, x, y, data):

    62

        x, y = self.ParentWindow.CalcUnscrolledPosition(x, y)

    63

        values = eval(data)

    64

        if values[1] == "program":

    65

            message = wx.MessageDialog(self.ParentWindow, "Programs can't be used by other POUs!", "Error", wx.OK|wx.ICON_ERROR)

    66

            message.ShowModal()

    67

            message.Destroy()

    68

        elif values[1] in ["function", "functionBlock", "program"]:

    69

            name, type = self.ParentWindow.Controler.GetCurrentElementEditingType()

    70

            if name == values[0]:

    71

                message = wx.MessageDialog(self.ParentWindow, "\"%s\" can't use itself!"%name, "Error", wx.OK|wx.ICON_ERROR)

    72

                message.ShowModal()

    73

                message.Destroy()

    74

            elif type == "function" and values[1] != "function":

    75

                message = wx.MessageDialog(self.ParentWindow, "Function Blocks can't be used by Functions!", "Error", wx.OK|wx.ICON_ERROR)

    76

                message.ShowModal()

    77

                message.Destroy()

    78

            elif self.ParentWindow.Controler.PouIsUsedBy(name, values[0]):

    79

                message = wx.MessageDialog(self.ParentWindow, "\"%s\" is already used by \"%s\"!"%(name, values[0]), "Error", wx.OK|wx.ICON_ERROR)

    80

                message.ShowModal()

    81

                message.Destroy()

    82

            else:

    83

                blockname = values[2]

    84

                if values[1] != "function" and blockname == "":

    85

                    dialog = wx.TextEntryDialog(self.ParentWindow, "Block name", "Please enter a block name", "", wx.OK|wx.CANCEL|wx.CENTRE)

    86

                    if dialog.ShowModal():

    87

                        blockname = dialog.GetValue()

    88

                    dialog.Destroy()

    89

                id = self.ParentWindow.GetNewId()

    90

                block = FBD_Block(self.ParentWindow, values[0], blockname, id)

    91

                block.SetPosition(x, y)

    92

                width, height = block.GetMinSize()

    93

                block.SetSize(width, height)

    94

                self.ParentWindow.AddBlock(block)

    95

                self.ParentWindow.Controler.AddCurrentElementEditingBlock(id, values[0], blockname)

    96

                self.ParentWindow.RefreshBlockModel(block)

    97

                self.ParentWindow.RefreshBuffer()

    98

                self.ParentWindow.RefreshScrollBars()

    99

                self.ParentWindow.ParentWindow.RefreshEditor()

   100

                self.ParentWindow.Refresh()

   101

        elif values[1] != "location":

   102

            id = self.ParentWindow.GetNewId()

   103

            if values[1] == "Output":

   104

                var_type = OUTPUT

   105

            elif values[1] == "InOut":

   106

                var_type = INPUT

   107

            else:

   108

                var_type = INPUT

   109

            variable = FBD_Variable(self.ParentWindow, var_type, values[0], values[2], id)

   110

            variable.SetPosition(x, y)

   111

            width, height = variable.GetMinSize()

   112

            variable.SetSize(width, height)

   113

            self.ParentWindow.AddBlock(variable)

   114

            self.ParentWindow.Controler.AddCurrentElementEditingVariable(id, var_type)

   115

            self.ParentWindow.RefreshVariableModel(variable)

   116

            self.ParentWindow.RefreshBuffer()

   117

            self.ParentWindow.RefreshScrollBars()

   118

            self.ParentWindow.Refresh()

   119

   120

   121

"""

   122

Class that implements a Viewer based on a wx.ScrolledWindow for drawing and 

   123

manipulating graphic elements

   124

"""

   125

   126

class Viewer(wx.ScrolledWindow):

   127

   135

    # Create Contextual Menu items

   136

    def _init_coll_ContextualMenu_Items(self, parent):

   137

        # Create menu items

   139

              kind=wx.ITEM_RADIO, text=u'No Modifier')

   141

              kind=wx.ITEM_RADIO, text=u'Negated')

   143

              kind=wx.ITEM_RADIO, text=u'Rising Edge')

   145

              kind=wx.ITEM_RADIO, text=u'Falling Edge')

   146

        parent.AppendSeparator()

   148

              kind=wx.ITEM_NORMAL, text=u'Add Wire Segment')

   150

              kind=wx.ITEM_NORMAL, text=u'Delete Wire Segment')

   151

        parent.AppendSeparator()

   153

              kind=wx.ITEM_NORMAL, text=u'Add Divergence Branch')

   155

              kind=wx.ITEM_NORMAL, text=u'Delete Divergence Branch')

   156

        parent.AppendSeparator()

   158

              kind=wx.ITEM_NORMAL, text=u'Edit Block')

   160

              kind=wx.ITEM_NORMAL, text=u'Delete')

   161

        # Link menu event to corresponding called functions

   162

        self.Bind(wx.EVT_MENU, self.OnNoModifierMenu,

   163

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS0)

   164

        self.Bind(wx.EVT_MENU, self.OnNegatedMenu,

   165

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS1)

   166

        self.Bind(wx.EVT_MENU, self.OnRisingEdgeMenu,

   167

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS2)

   168

        self.Bind(wx.EVT_MENU, self.OnFallingEdgeMenu,

   169

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS3)

   170

        self.Bind(wx.EVT_MENU, self.OnAddSegmentMenu,

   171

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS5)

   172

        self.Bind(wx.EVT_MENU, self.OnDeleteSegmentMenu,

   173

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS6)

   174

        self.Bind(wx.EVT_MENU, self.OnAddBranchMenu,

   175

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS8)

   176

        self.Bind(wx.EVT_MENU, self.OnDeleteBranchMenu,

   177

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS9)

   178

        self.Bind(wx.EVT_MENU, self.OnEditBlockMenu,

   179

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS11)

   180

        self.Bind(wx.EVT_MENU, self.OnDeleteMenu,

   181

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS12)

   182

   183

    # Create and initialize Contextual Menu

   184

    def _init_menus(self):

   185

        self.ContextualMenu = wx.Menu(title='')

   186

   187

        self._init_coll_ContextualMenu_Items(self.ContextualMenu)

   188

   189

    # Create a new Viewer

   190

    def __init__(self, parent, window, controler):

   191

        wx.ScrolledWindow.__init__(self, parent, pos=wx.Point(0, 0), size=wx.Size(0, 0), 

   192

            style=wx.SUNKEN_BORDER | wx.HSCROLL | wx.VSCROLL)

   193

        self._init_menus()

   194

        # Adding a rubberband to Viewer

   195

        self.rubberBand = RubberBand(drawingSurface=self)

   196

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

   197

        self.ResetView()

   198

        self.Scaling = None

   199

        #self.Scaling = (8, 8)

   200

        self.DrawGrid = True

   202

   203

        # Initialize Block, Wire and Comment numbers

   204

        self.block_id = self.wire_id = self.comment_id = 0

   205

   206

        # Initialize Viewer mode to Selection mode

   207

        self.Mode = MODE_SELECTION

   208

        self.SavedMode = False

   210

   211

        self.ParentWindow = window

   212

        self.Controler = controler

   213

   214

        self.SetDropTarget(ViewerDropTarget(self))

   215

   216

        # Link Viewer event to corresponding methods

   217

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

   218

        self.Bind(wx.EVT_LEFT_DOWN, self.OnViewerLeftDown)

   219

        self.Bind(wx.EVT_LEFT_UP, self.OnViewerLeftUp)

   220

        self.Bind(wx.EVT_LEFT_DCLICK, self.OnViewerLeftDClick)

   221

        self.Bind(wx.EVT_RIGHT_UP, self.OnViewerRightUp)

   222

        self.Bind(wx.EVT_MOTION, self.OnViewerMotion)

   223

        self.Bind(wx.EVT_CHAR, self.OnChar)

   224

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

   225

            self.Bind(wx.EVT_SCROLLWIN, self.OnMoveWindow)

   226

            self.Bind(wx.EVT_SIZE, self.OnMoveWindow)

   227

   228

    # Returns a new id

   229

    def GetNewId(self):

   230

        self.current_id += 1

   231

        return self.current_id

   232

   233

    # Destructor

   234

    def __del__(self):

   235

        self.ResetView()

   236

   237

    def GetLogicalDC(self, buffered=False):

   238

        if buffered:

   239

            dc = wx.BufferedPaintDC(self)

   240

        else:

   241

            dc = wx.ClientDC(self)

   242

        if wx.Platform != '__WXMSW__':

   243

            dc.SetFont(wx.NORMAL_FONT)

   248

        return dc

   249

   250

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

   251

#                         Element management functions

   252

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

   253

   254

    def AddBlock(self, block):

   255

        self.block_id += 1

   256

        self.Blocks[block] = self.block_id

   257

   258

    def AddWire(self, wire):

   259

        self.wire_id += 1

   260

        self.Wires[wire] = self.wire_id

   261

   262

    def AddComment(self, comment):

   263

        self.comment_id += 1

   264

        self.Comments[comment] = self.comment_id

   265

   266

    def IsBlock(self, block):

   267

        return self.Blocks.get(block, False)

   268

   269

    def IsWire(self, wire):

   270

        return self.Wires.get(wire, False)

   271

   272

    def IsComment(self, comment):

   273

        return self.Comments.get(comment, False)

   274

   275

    def RemoveBlock(self, block):

   276

        self.Blocks.pop(block)

   277

   278

    def RemoveWire(self, wire):

   279

        self.Wires.pop(wire)

   280

   281

    def RemoveComment(self, comment):

   282

        self.Comments.pop(comment)

   283

   284

    def GetElements(self, sort_blocks=False, sort_wires=False, sort_comments=False):

   285

        blocks = self.Blocks.keys()

   286

        wires = self.Wires.keys()

   287

        comments = self.Comments.keys()

   288

        if sort_blocks:

   289

            blocks.sort(lambda x,y:self.Blocks[x].__cmp__(self.Blocks[y]))

   290

        if sort_wires:

   291

            wires.sort(lambda x,y:self.Wires[x].__cmp__(self.Wires[y]))

   292

        if sort_comments:

   293

            comments.sort(lambda x,y:self.Comments[x].__cmp__(self.Comments[y]))

   294

        return blocks + wires + comments

   295

   296

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

   297

#                              Reset functions

   298

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

   299

   300

    # Resets Viewer lists

   301

    def ResetView(self):

   302

        self.Blocks = {}

   303

        self.Wires = {}

   304

        self.Comments = {}

   305

        self.SelectedElement = None

   306

   307

    # Verify wires type compatibility

   308

    def VerifyVariableTypeCompatibility(self):

   309

        to_delete = []

   310

        for wire in self.Wires:

   311

            if not wire.IsConnectedCompatible():

   312

                to_delete.append(wire)

   313

        for wire in to_delete:

   314

            wire.Delete()

   315

   316

    # Remove all elements

   317

    def CleanView(self):

   318

        for block in self.Blocks.keys():

   319

            block.Clean()

   320

        self.ResetView()

   321

   322

    # Changes Viewer mode

   323

    def SetMode(self, mode):

   324

        if self.Mode != mode or mode == MODE_SELECTION:

   325

            self.Mode = mode

   326

            self.SavedMode = False

   327

        else:

   328

            self.SavedMode = True

   329

        # Reset selection

   330

        if self.Mode != MODE_SELECTION and self.SelectedElement:

   331

            self.SelectedElement.SetSelected(False)

   332

            self.SelectedElement = None

   333

            self.Refresh(False)

   334

   335

    # Return current drawing mode

   336

    def GetDrawingMode(self):

   337

        return self.ParentWindow.GetDrawingMode()

   338

   339

    # Buffer the last model state

   340

    def RefreshBuffer(self):

   341

        self.Controler.BufferProject()

   342

        self.ParentWindow.RefreshTitle()

   343

        self.ParentWindow.RefreshEditMenu()

   344

   345

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

   346

#                          Refresh functions

   347

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

   348

   349

    def ResetBuffer(self):

   350

        pass

   351

   352

    # Refresh Viewer elements

   353

    def RefreshView(self):

   354

        self.current_id = 0

   355

        # Start by reseting Viewer

   356

        self.ResetView()

   357

        instance = True

   358

        # List of ids of already loaded blocks

   359

        ids = []

   360

        # Load Blocks until they are all loaded

   361

        while instance:

   362

            instance = self.Controler.GetCurrentElementEditingInstanceInfos(exclude=ids)

   363

            if instance:

   364

                self.loadInstance(instance, ids)

   365

        self.RefreshScrollBars()

   366

        self.Refresh(False)

   367

   368

    def RefreshScrollBars(self):

   369

        xstart, ystart = self.GetViewStart()

   370

        window_size = self.GetClientSize()

   371

        maxx = maxy = 0

   372

        for element in self.GetElements():

   373

            posx, posy = element.GetPosition()

   374

            width, height = element.GetSize()

   375

            maxx = max(maxx, posx + width)

   376

            maxy = max(maxy, posy + height)

   377

        maxx = max(maxx + WINDOW_BORDER, xstart * SCROLLBAR_UNIT + window_size[0])

   378

        maxy = max(maxy + WINDOW_BORDER, ystart * SCROLLBAR_UNIT + window_size[1])

   379

        if self.rubberBand.IsShown():

   380

            extent = self.rubberBand.GetCurrentExtent()

   381

            maxx = max(maxx, extent.x + extent.width)

   382

            maxy = max(maxy, extent.y + extent.height)

   383

        self.SetScrollbars(SCROLLBAR_UNIT, SCROLLBAR_UNIT, 

   384

            maxx / SCROLLBAR_UNIT, maxy / SCROLLBAR_UNIT, xstart, ystart, True)

   385

   386

    # Load instance from given informations

   387

    def loadInstance(self, instance, ids):

   388

        ids.append(instance["id"])

   389

        self.current_id = max(self.current_id, instance["id"]) 

   390

        if instance["type"] == "input":

   391

            variable = FBD_Variable(self, INPUT, instance["name"], instance["value_type"], instance["id"])

   392

            variable.SetPosition(instance["x"], instance["y"])

   393

            variable.SetSize(instance["width"], instance["height"])

   394

            self.AddBlock(variable)

   395

            connectors = variable.GetConnectors()

   396

            connectors["output"].SetPosition(wx.Point(*instance["connector"]["position"]))

   397

            if instance["connector"]["negated"]:

   398

                connectors["output"].SetNegated(True)

   399

            if instance["connector"]["edge"]:

   400

                connectors["output"].SetEdge(instance["connector"]["edge"])

   401

        elif instance["type"] == "output":

   402

            variable = FBD_Variable(self, OUTPUT, instance["name"], instance["value_type"], instance["id"])

   403

            variable.SetPosition(instance["x"], instance["y"])

   404

            variable.SetSize(instance["width"], instance["height"])

   405

            self.AddBlock(variable)

   406

            connectors = variable.GetConnectors()

   407

            connectors["input"].SetPosition(wx.Point(*instance["connector"]["position"]))

   408

            if instance["connector"]["negated"]:

   409

                connectors["input"].SetNegated(True)

   410

            if instance["connector"]["edge"]:

   411

                connectors["input"].SetEdge(instance["connector"]["edge"])

   412

            self.CreateWires(connectors["input"], instance["connector"]["links"], ids)

   413

        elif instance["type"] == "inout":

   414

            variable = FBD_Variable(self, INOUT, instance["name"], instance["value_type"], instance["id"])

   415

            variable.SetPosition(instance["x"], instance["y"])

   416

            variable.SetSize(instance["width"], instance["height"])

   417

            self.AddBlock(variable)

   418

            connectors = variable.GetConnectors()

   419

            connectors["output"].SetPosition(wx.Point(*instance["connectors"]["output"]["position"]))

   420

            connectors["input"].SetPosition(wx.Point(*instance["connectors"]["input"]["position"]))

   421

            if instance["connectors"]["output"]["negated"]:

   422

                connectors["output"].SetNegated(True)

   423

            if instance["connectors"]["output"]["edge"]:

   424

                connectors["output"].SetEdge(instance["connectors"]["output"]["edge"])

   425

            if instance["connectors"]["input"]["negated"]:

   426

                connectors["input"].SetNegated(True)

   427

            if instance["connectors"]["input"]["edge"]:

   428

                connectors["input"].SetEdge(instance["connectors"]["input"]["edge"])

   429

            self.CreateWires(connectors["input"], instance["connectors"]["input"]["links"], ids)

   430

        elif instance["type"] == "continuation":

   431

            connection = FBD_Connector(self, CONTINUATION, instance["name"], instance["id"])

   432

            connection.SetPosition(instance["x"], instance["y"])

   433

            connection.SetSize(instance["width"], instance["height"])

   434

            self.AddBlock(connection)

   435

            connector = connection.GetConnector()

   436

            connector.SetPosition(wx.Point(*instance["connector"]["position"]))

   437

        elif instance["type"] == "connection":

   438

            connection = FBD_Connector(self, CONNECTOR, instance["name"], instance["id"])

   439

            connection.SetPosition(instance["x"], instance["y"])

   440

            connection.SetSize(instance["width"], instance["height"])

   441

            self.AddBlock(connection)

   442

            connector = connection.GetConnector()

   443

            connector.SetPosition(wx.Point(*instance["connector"]["position"]))

   444

            self.CreateWires(connector, instance["connector"]["links"], ids)

   445

        elif instance["type"] == "comment":

   446

            comment = Comment(self, instance["content"], instance["id"])

   447

            comment.SetPosition(instance["x"], instance["y"])

   448

            comment.SetSize(instance["width"], instance["height"])

   449

            self.AddComment(comment)

   450

        elif instance["type"] == "leftPowerRail":

   451

            leftpowerrail = LD_PowerRail(self, LEFTRAIL, instance["id"], [True for i in range(len(instance["connectors"]))])

   452

            leftpowerrail.SetPosition(instance["x"], instance["y"])

   453

            leftpowerrail.SetSize(instance["width"], instance["height"])

   454

            self.AddBlock(leftpowerrail)

   455

            connectors = leftpowerrail.GetConnectors()

   456

            for i, connector in enumerate(instance["connectors"]):

   457

                connectors[i].SetPosition(wx.Point(*connector["position"]))

   458

        elif instance["type"] == "rightPowerRail":

   459

            rightpowerrail = LD_PowerRail(self, RIGHTRAIL, instance["id"], [True for i in range(len(instance["connectors"]))])

   460

            rightpowerrail.SetPosition(instance["x"], instance["y"])

   461

            rightpowerrail.SetSize(instance["width"], instance["height"])

   462

            self.AddBlock(rightpowerrail)

   463

            connectors = rightpowerrail.GetConnectors()

   464

            for i, connector in enumerate(instance["connectors"]):

   465

                connectors[i].SetPosition(wx.Point(*connector["position"]))

   466

                self.CreateWires(connectors[i], connector["links"], ids)

   467

        elif instance["type"] == "contact":

   468

            if instance["negated"]:

   469

                negated = instance["negated"]

   470

            else:

   471

                negated = False

   472

            if instance["edge"]:

   473

                edge = instance["edge"]

   474

            else:

   475

                edge = "none"

   476

            if negated and edge == "none":

   477

                contact_type = CONTACT_REVERSE

   478

            elif not negated and edge == "rising":

   479

                contact_type = CONTACT_RISING

   480

            elif not negated and edge == "falling":

   481

                contact_type = CONTACT_FALLING

   482

            else:

   483

                contact_type = CONTACT_NORMAL

   484

            contact = LD_Contact(self, contact_type, instance["name"], instance["id"])

   485

            contact.SetPosition(instance["x"], instance["y"])

   486

            self.AddBlock(contact)

   487

            connectors = contact.GetConnectors()

   488

            connectors["input"].SetPosition(wx.Point(*instance["connectors"]["input"]["position"]))

   489

            self.CreateWires(connectors["input"], instance["connectors"]["input"]["links"], ids)

   490

            connectors["output"].SetPosition(wx.Point(*instance["connectors"]["output"]["position"]))

   491

        elif instance["type"] == "coil":

   492

            if instance["negated"]:

   493

                negated = instance["negated"]

   494

            else:

   495

                negated = False

   496

            if instance["storage"]:

   497

                storage = instance["storage"]

   498

            else:

   499

                storage = "none"