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

    36

def AppendMenu(parent, help, id, kind, text):

    37

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

    38

        parent.Append(help=help, id=id, kind=kind, text=text)

    39

    else:

    40

        parent.Append(helpString=help, id=id, kind=kind, item=text)

    41

    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

 ID_FBDVIEWERCONTEXTUALMENUITEMS14, ID_FBDVIEWERCONTEXTUALMENUITEMS15,

    53

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

    54

    55

    56

class ViewerDropTarget(wx.TextDropTarget):

    57

    58

    def __init__(self, parent):

    59

        wx.TextDropTarget.__init__(self)

    60

        self.ParentWindow = parent

    61

    62

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

    63

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

    64

        values = eval(data)

    65

        if values[1] == "program":

    66

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

    67

            message.ShowModal()

    68

            message.Destroy()

    69

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

    71

            if name == values[0]:

    72

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

    73

                message.ShowModal()

    74

                message.Destroy()

    75

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

    76

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

    77

                message.ShowModal()

    78

                message.Destroy()

    79

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

    80

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

    81

                message.ShowModal()

    82

                message.Destroy()

    83

            else:

    84

                blockname = values[2]

    85

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

    86

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

    87

                    if dialog.ShowModal():

    88

                        blockname = dialog.GetValue()

    89

                    dialog.Destroy()

    90

                id = self.ParentWindow.GetNewId()

    91

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

    92

                block.SetPosition(x, y)

    93

                width, height = block.GetMinSize()

    94

                block.SetSize(width, height)

    95

                self.ParentWindow.AddBlock(block)

    97

                self.ParentWindow.RefreshBlockModel(block)

    98

                self.ParentWindow.RefreshBuffer()

    99

                self.ParentWindow.RefreshScrollBars()

   100

                self.ParentWindow.ParentWindow.RefreshEditor()

   101

                self.ParentWindow.Refresh()

   102

        elif values[1] != "location":

   125

   143

   144

"""

   145

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

   146

manipulating graphic elements

   147

"""

   148

   149

class Viewer(wx.ScrolledWindow):

   150

   151

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

   152

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

   153

            if id is not None:

   154

                event(self, id, function)

   155

            else:

   156

                event(self, function)

   157

   158

    # Create Contextual Menu items

   159

    def _init_coll_ContextualMenu_Items(self, parent):

   160

        # Create menu items

   161

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS0,

   162

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

   163

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS1,

   164

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

   165

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS2,

   166

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

   167

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS3,

   168

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

   169

        parent.AppendSeparator()

   170

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS5,

   171

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

   172

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS6,

   173

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

   174

        parent.AppendSeparator()

   175

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS8,

   176

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

   177

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS9,

   178

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

   179

        parent.AppendSeparator()

   180

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS11,

   181

              kind=wx.ITEM_NORMAL, text=u'Clear Execution Order')

   182

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS12,

   183

              kind=wx.ITEM_NORMAL, text=u'Reset Execution Order')

   184

        parent.AppendSeparator()

   185

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS14,

   186

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

   187

        AppendMenu(parent, help='', id=ID_FBDVIEWERCONTEXTUALMENUITEMS15,

   188

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

   189

        # Link menu event to corresponding called functions

   190

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

   191

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS0)

   192

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

   193

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS1)

   194

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

   195

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS2)

   196

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

   197

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS3)

   198

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

   199

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS5)

   200

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

   201

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS6)

   202

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

   203

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS8)

   204

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

   205

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS9)

   206

        self.Bind(wx.EVT_MENU, self.OnClearExecutionOrderMenu,

   207

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS11)

   208

        self.Bind(wx.EVT_MENU, self.OnResetExecutionOrderMenu,

   209

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS12)

   210

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

   211

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS14)

   212

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

   213

              id=ID_FBDVIEWERCONTEXTUALMENUITEMS15)

   214

   215

    # Create and initialize Contextual Menu

   216

    def _init_menus(self):

   217

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

   218

   219

        self._init_coll_ContextualMenu_Items(self.ContextualMenu)

   220

   221

    # Create a new Viewer

   223

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

   224

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

   225

        self._init_menus()

   226

        # Adding a rubberband to Viewer

   227

        self.rubberBand = RubberBand(drawingSurface=self)

   228

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

   229

        self.ResetView()

   230

        self.Scaling = None

   231

        #self.Scaling = (8, 8)

   232

        self.DrawGrid = True

   233

        self.current_id = 0

   235

   236

        # Initialize Block, Wire and Comment numbers

   237

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

   238

   239

        # Initialize Viewer mode to Selection mode

   240

        self.Mode = MODE_SELECTION

   241

        self.SavedMode = False

   242

        self.CurrentLanguage = "FBD"

   243

   244

        self.ParentWindow = window

   245

        self.Controler = controler

   246

   247

        self.SetDropTarget(ViewerDropTarget(self))

   248

   249

        # Link Viewer event to corresponding methods

   250

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

   251

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

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

   270

    # Returns a new id

   271

    def GetNewId(self):

   272

        self.current_id += 1

   273

        return self.current_id

   274

   275

    # Destructor

   276

    def __del__(self):

   277

        self.ResetView()

   278

   279

    def GetLogicalDC(self, buffered=False):

   280

        if buffered:

   281

            dc = wx.BufferedPaintDC(self)

   282

        else:

   283

            dc = wx.ClientDC(self)

   284

        if wx.Platform != '__WXMSW__':

   285

            dc.SetFont(wx.NORMAL_FONT)

   286

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

   287

            self.DoPrepareDC(dc)

   288

        else:

   289

            self.PrepareDC(dc)

   290

        return dc

   291

   292

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

   293

#                         Element management functions

   294

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

   295

   296

    def AddBlock(self, block):

   297

        self.block_id += 1

   298

        self.Blocks[block] = self.block_id

   299

   300

    def AddWire(self, wire):

   301

        self.wire_id += 1

   302

        self.Wires[wire] = self.wire_id

   303

   304

    def AddComment(self, comment):

   305

        self.comment_id += 1

   306

        self.Comments[comment] = self.comment_id

   307

   308

    def IsBlock(self, block):

   309

        return self.Blocks.get(block, False)

   310

   311

    def IsWire(self, wire):

   312

        return self.Wires.get(wire, False)

   313

   314

    def IsComment(self, comment):

   315

        return self.Comments.get(comment, False)

   316

   317

    def RemoveBlock(self, block):

   318

        self.Blocks.pop(block)

   319

   320

    def RemoveWire(self, wire):

   321

        self.Wires.pop(wire)

   322

   323

    def RemoveComment(self, comment):

   324

        self.Comments.pop(comment)

   325

   326

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

   327

        blocks = self.Blocks.keys()

   328

        wires = self.Wires.keys()

   329

        comments = self.Comments.keys()

   330

        if sort_blocks:

   331

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

   332

        if sort_wires:

   333

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

   334

        if sort_comments:

   335

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

   336

        return blocks + wires + comments

   337

   338

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

   339

#                              Reset functions

   340

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

   341

   342

    # Resets Viewer lists

   343

    def ResetView(self):

   344

        self.Blocks = {}

   345

        self.Wires = {}

   346

        self.Comments = {}

   347

        self.SelectedElement = None

   348

   349

    # Remove all elements

   350

    def CleanView(self):

   351

        for block in self.Blocks.keys():

   352

            block.Clean()

   353

        self.ResetView()

   354

   355

    # Changes Viewer mode

   356

    def SetMode(self, mode):

   357

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

   358

            self.Mode = mode

   359

            self.SavedMode = False

   360

        else:

   361

            self.SavedMode = True

   362

        # Reset selection

   363

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

   364

            self.SelectedElement.SetSelected(False)

   365

            self.SelectedElement = None

   366

            self.Refresh(False)

   367

   368

    # Return current drawing mode

   369

    def GetDrawingMode(self):

   370

        return self.ParentWindow.GetDrawingMode()

   371

   372

    # Buffer the last model state

   373

    def RefreshBuffer(self):

   374

        self.Controler.BufferProject()

   375

        self.ParentWindow.RefreshTitle()

   376

        self.ParentWindow.RefreshEditMenu()

   377

   378

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

   379

#                          Refresh functions

   380

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

   381

   382

    def ResetBuffer(self):

   383

        pass

   384

   385

    # Refresh Viewer elements

   386

    def RefreshView(self):

   387

        self.current_id = 0

   388

        # Start by reseting Viewer

   389

        self.ResetView()

   390

        instance = True

   391

        # List of ids of already loaded blocks

   392

        ids = []

   393

        # Load Blocks until they are all loaded

   394

        while instance:

   396

            if instance:

   397

                self.loadInstance(instance, ids)

   398

        self.RefreshScrollBars()

   407

        self.Refresh(False)

   408

   409

    def RefreshScrollBars(self):

   410

        xstart, ystart = self.GetViewStart()

   411

        window_size = self.GetClientSize()

   412

        maxx = maxy = 0

   413

        for element in self.GetElements():

   414

            posx, posy = element.GetPosition()

   415

            width, height = element.GetSize()

   416

            maxx = max(maxx, posx + width)

   417

            maxy = max(maxy, posy + height)

   418

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

   419

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

   420

        if self.rubberBand.IsShown():

   421

            extent = self.rubberBand.GetCurrentExtent()

   422

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

   423

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

   424

        self.SetScrollbars(SCROLLBAR_UNIT, SCROLLBAR_UNIT, 

   425

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

   426

   427

    # Load instance from given informations

   428

    def loadInstance(self, instance, ids):

   429

        ids.append(instance["id"])

   430

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

   431

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

   432

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

   433

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

   434

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

   435

            self.AddBlock(variable)

   436

            connectors = variable.GetConnectors()

   437

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

   438

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

   439

                connectors["output"].SetNegated(True)

   440

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

   441

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

   442

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

   443

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

   444

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

   445

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

   446

            self.AddBlock(variable)

   447

            connectors = variable.GetConnectors()

   448

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

   449

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

   450

                connectors["input"].SetNegated(True)

   451

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

   452

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

   453

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

   454

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

   455

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

   456

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

   457

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

   458

            self.AddBlock(variable)

   459

            connectors = variable.GetConnectors()

   460

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

   461

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

   462

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

   463

                connectors["output"].SetNegated(True)

   464

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

   465

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

   466

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

   467

                connectors["input"].SetNegated(True)

   468

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

   469

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

   470

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

   471

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

   472

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

   473

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

   474

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

   475

            self.AddBlock(connection)

   476

            connector = connection.GetConnector()

   477

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

   478

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

   479

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

   480

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

   481

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

   482

            self.AddBlock(connection)

   483

            connector = connection.GetConnector()

   484

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

   485

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

   486

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

   487

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

   488

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

   489

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

   490

            self.AddComment(comment)

   491

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

   492

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

   493

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

   494

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

   495

            self.AddBlock(leftpowerrail)

   496

            connectors = leftpowerrail.GetConnectors()