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

    61

    62

    63

class ViewerDropTarget(wx.TextDropTarget):

    64

    65

    def __init__(self, parent):

    66

        wx.TextDropTarget.__init__(self)

    67

        self.ParentWindow = parent

    68

    69

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

    70

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

    71

        values = eval(data)

    72

        if values[1] == "program":

    73

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

    74

            message.ShowModal()

    75

            message.Destroy()

    76

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

    77

            name, type = self.ParentWindow.Controler.GetEditedElementType(self.ParentWindow.GetTagName())

    78

            if name == values[0]:

    79

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

    80

                message.ShowModal()

    81

                message.Destroy()

    82

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

    83

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

    84

                message.ShowModal()

    85

                message.Destroy()

    86

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

    87

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

    88

                message.ShowModal()

    89

                message.Destroy()

    90

            else:

    91

                blockname = values[2]

    92

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

    93

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

    94

                    if dialog.ShowModal():

    95

                        blockname = dialog.GetValue()

    96

                    dialog.Destroy()

    97

                id = self.ParentWindow.GetNewId()

    98

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

    99

                block.SetPosition(x, y)

   100

                width, height = block.GetMinSize()

   101

                block.SetSize(width, height)

   102

                self.ParentWindow.AddBlock(block)

   103

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

   104

                self.ParentWindow.RefreshBlockModel(block)

   105

                self.ParentWindow.RefreshBuffer()

   106

                self.ParentWindow.RefreshScrollBars()

   107

                self.ParentWindow.ParentWindow.RefreshEditor()

   108

                self.ParentWindow.Refresh()

   109

        elif values[1] != "location":

   110

            if values[3] == self.ParentWindow.GetTagName():

   111

                id = self.ParentWindow.GetNewId()

   112

                if values[1] == "Output":

   113

                    var_type = OUTPUT

   114

                elif values[1] == "InOut":

   115

                    var_type = INPUT

   116

                else:

   117

                    var_type = INPUT

   118

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

   119

                variable.SetPosition(x, y)

   120

                width, height = variable.GetMinSize()

   121

                variable.SetSize(width, height)

   122

                self.ParentWindow.AddBlock(variable)

   123

                self.ParentWindow.Controler.AddEditedElementVariable(self.ParentWindow.TagName, id, var_type)

   124

                self.ParentWindow.RefreshVariableModel(variable)

   125

                self.ParentWindow.RefreshBuffer()

   126

                self.ParentWindow.RefreshScrollBars()

   127

                self.ParentWindow.Refresh()

   128

            else:

   129

                message = wx.MessageDialog(self.ParentWindow, "Variable don't belong to this POU!", "Error", wx.OK|wx.ICON_ERROR)

   130

                message.ShowModal()

   131

                message.Destroy()

   132

   133

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

   134

    import wx.aui

   135

   136

    class MDIViewer(wx.aui.AuiMDIChildFrame):

   137

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

   138

            wx.aui.AuiMDIChildFrame.__init__(self, parent, -1, title = "")

   139

   140

            sizer = wx.BoxSizer(wx.HORIZONTAL)

   141

   142

            self.Viewer = Viewer(self, tagname, window, controler)

   143

   144

            sizer.AddWindow(self.Viewer, 1, border=0, flag=wx.GROW)

   145

   146

            self.SetSizer(sizer)

   147

   148

        def GetViewer(self):

   149

            return self.Viewer

   150

   151

"""

   152

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

   153

manipulating graphic elements

   154

"""

   155

   156

class Viewer(wx.ScrolledWindow):

   157

   158

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

   159

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

   160

            if id is not None:

   161

                event(self, id, function)

   162

            else:

   163

                event(self, function)

   164

   195

    # Create Contextual Menu items

   196

    def _init_coll_ContextualMenu_Items(self, parent):

   197

        # Create menu items

   199

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

   201

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

   203

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

   205

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

   206

        parent.AppendSeparator()

   208

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

   210

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

   211

        parent.AppendSeparator()

   213

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

   215

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

   216

        parent.AppendSeparator()

   218

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

   220

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

   221

        parent.AppendSeparator()

   225

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

   227

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

   228

        # Link menu event to corresponding called functions

   229

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

   231

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

   233

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

   235

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

   237

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

   239

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

   241

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

   243

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

   245

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

   247

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

   249

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

   251

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

   253

   254

    # Create and initialize Contextual Menu

   255

    def _init_menus(self):

   257

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

   258

   260

        self._init_coll_ContextualMenu_Items(self.ContextualMenu)

   261

   262

    # Create a new Viewer

   263

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

   264

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

   265

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

   266

        self._init_menus()

   267

        # Adding a rubberband to Viewer

   268

        self.rubberBand = RubberBand(drawingSurface=self)

   269

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

   270

        self.ResetView()

   271

        self.Scaling = None

   272

        #self.Scaling = (8, 8)

   273

        self.DrawGrid = True

   275

        self.current_id = 0

   276

        self.TagName = tagname

   277

   278

        # Initialize Block, Wire and Comment numbers

   279

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

   280

   281

        # Initialize Viewer mode to Selection mode

   282

        self.Mode = MODE_SELECTION

   283

        self.SavedMode = False

   284

        self.CurrentLanguage = "FBD"

   285

   286

        self.ParentWindow = window

   287

        self.Controler = controler

   288

   289

        self.SetDropTarget(ViewerDropTarget(self))

   290

   291

        # Link Viewer event to corresponding methods

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

   303

    def SetTagName(self, tagname):

   304

        self.TagName = tagname

   305

   306

    def GetTagName(self):

   307

        return self.TagName

   308

   309

    def IsViewing(self, tagname):

   310

        return self.TagName == tagname

   311

   312

    # Returns a new id

   313

    def GetNewId(self):

   314

        self.current_id += 1

   315

        return self.current_id

   316

   317

    # Destructor

   318

    def __del__(self):

   319

        self.ResetView()

   320

   321

    def GetLogicalDC(self, buffered=False):

   322

        if buffered:

   323

            dc = wx.BufferedPaintDC(self)

   324

        else:

   325

            dc = wx.ClientDC(self)

   326

        if wx.Platform == '__WXMSW__':

   327

            dc.SetFont(wx.Font(10, wx.SWISS, wx.NORMAL, wx.NORMAL))

   328

        else:

   329

            dc.SetFont(wx.NORMAL_FONT)

   330

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

   331

            self.DoPrepareDC(dc)

   332

        else:

   333

            self.PrepareDC(dc)

   334

        return dc

   335

   336

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

   337

#                         Element management functions

   338

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

   339

   340

    def AddBlock(self, block):

   341

        self.block_id += 1

   342

        self.Blocks[block] = self.block_id

   343

   344

    def AddWire(self, wire):

   345

        self.wire_id += 1

   346

        self.Wires[wire] = self.wire_id

   347

   348

    def AddComment(self, comment):

   349

        self.comment_id += 1

   350

        self.Comments[comment] = self.comment_id

   351

   352

    def IsBlock(self, block):

   353

        return self.Blocks.get(block, False)

   354

   355

    def IsWire(self, wire):

   356

        return self.Wires.get(wire, False)

   357

   358

    def IsComment(self, comment):

   359

        return self.Comments.get(comment, False)

   360

   361

    def RemoveBlock(self, block):

   362

        self.Blocks.pop(block)

   363

   364

    def RemoveWire(self, wire):

   365

        self.Wires.pop(wire)

   366

   367

    def RemoveComment(self, comment):

   368

        self.Comments.pop(comment)

   369

   370

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

   371

        blocks = self.Blocks.keys()

   372

        wires = self.Wires.keys()

   373

        comments = self.Comments.keys()

   374

        if sort_blocks:

   375

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

   376

        if sort_wires:

   377

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

   378

        if sort_comments:

   379

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

   380

        return blocks + wires + comments

   381

   382

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

   383

#                              Reset functions

   384

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

   385

   386

    # Resets Viewer lists

   387

    def ResetView(self):

   388

        self.Blocks = {}

   389

        self.Wires = {}

   390

        self.Comments = {}

   391

        self.SelectedElement = None

   392

   393

    # Remove all elements

   394

    def CleanView(self):

   395

        for block in self.Blocks.keys():

   396

            block.Clean()

   397

        self.ResetView()

   398

   399

    # Changes Viewer mode

   400

    def SetMode(self, mode):

   401

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

   402

            self.Mode = mode

   403

            self.SavedMode = False

   404

        else:

   405

            self.SavedMode = True

   406

        # Reset selection

   407

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

   408

            self.SelectedElement.SetSelected(False)

   409

            self.SelectedElement = None

   410

            self.Refresh(False)

   411

   412

    # Return current drawing mode

   413

    def GetDrawingMode(self):

   414

        return self.ParentWindow.GetDrawingMode()

   415

   416

    # Buffer the last model state

   417

    def RefreshBuffer(self):

   418

        self.Controler.BufferProject()

   419

        self.ParentWindow.RefreshTitle()

   420

        self.ParentWindow.RefreshEditMenu()

   421

   422

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

   423

#                          Refresh functions

   424

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

   425

   426

    def ResetBuffer(self):

   427

        pass

   428

   429

    # Refresh Viewer elements

   430

    def RefreshView(self):

   431

        self.current_id = 0

   432

        # Start by reseting Viewer

   433

        self.ResetView()

   434

        instance = True

   435

        # List of ids of already loaded blocks

   436

        ids = []

   437

        # Load Blocks until they are all loaded

   438

        while instance:

   439

            instance = self.Controler.GetEditedElementInstanceInfos(self.TagName, exclude=ids)

   440

            if instance:

   441

                self.loadInstance(instance, ids)

   442

        self.RefreshScrollBars()

   443

   444

        to_delete = []

   445

        for wire in self.Wires:

   446

            if not wire.IsConnectedCompatible():

   447

                to_delete.append(wire)

   448

        for wire in to_delete:

   449

            wire.Delete()

   450

   451

        self.Refresh(False)

   452

   453

    def RefreshScrollBars(self):

   454

        xstart, ystart = self.GetViewStart()

   455

        window_size = self.GetClientSize()

   456

        maxx = maxy = 0

   457

        for element in self.GetElements():

   458

            posx, posy = element.GetPosition()

   459

            width, height = element.GetSize()

   460

            maxx = max(maxx, posx + width)

   461

            maxy = max(maxy, posy + height)

   462

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

   463

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

   464

        if self.rubberBand.IsShown():

   465

            extent = self.rubberBand.GetCurrentExtent()

   466

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

   467

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

   468

        self.SetScrollbars(SCROLLBAR_UNIT, SCROLLBAR_UNIT, 

   469

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

   470

   471

    # Load instance from given informations

   472

    def loadInstance(self, instance, ids):

   473

        ids.append(instance["id"])

   474

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

   475

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

   476

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

   477

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

   478

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

   479

            self.AddBlock(variable)

   480

            connectors = variable.GetConnectors()

   481

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

   482

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

   483

                connectors["output"].SetNegated(True)

   484

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

   485

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

   486

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

   487

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

   488

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

   489

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

   490

            self.AddBlock(variable)

   491

            connectors = variable.GetConnectors()

   492

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

   493

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

   494

                connectors["input"].SetNegated(True)

   495