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

from types import *

    27

    28

from Viewer import *

    29

    30

def ExtractNextBlocks(block, block_list):

    31

    current_list = [block]

    32

    while len(current_list) > 0:

    33

        next_list = []

    34

        for current in current_list:

    35

            connectors = current.GetConnectors()

    36

            input_connectors = []

    37

            if isinstance(current, LD_PowerRail) and current.GetType() == RIGHTRAIL:

    38

                input_connectors = connectors

    39

            else:

    40

                if "inputs" in connectors:

    41

                    input_connectors = connectors["inputs"]

    42

                if "input" in connectors:

    43

                    input_connectors = [connectors["input"]]

    44

            for connector in input_connectors:

    45

                for wire, handle in connector.GetWires():

    46

                    next = wire.EndConnected.GetParentBlock()

    47

                    if not isinstance(next, LD_PowerRail) and next not in block_list:

    48

                        block_list.append(next)

    49

                        next_list.append(next)

    50

        current_list = next_list

    51

    52

def CalcBranchSize(elements, stops):

    53

    branch_size = 0

    54

    stop_list = stops

    55

    for stop in stops:

    56

        ExtractNextBlocks(stop, stop_list)

    57

    element_tree = {}

    58

    for element in elements:

    59

        if element not in element_tree:

    60

            element_tree[element] = {"parents":["start"], "children":[], "weight":None}

    61

            GenerateTree(element, element_tree, stop_list)

    62

        elif element_tree[element]:

    63

            element_tree[element]["parents"].append("start")

    64

    remove_stops = {"start":[], "stop":[]}

    65

    for element, values in element_tree.items():

    66

        if "stop" in values["children"]:

    67

            removed = []

    68

            for child in values["children"]:

    69

                if child != "stop":

    70

##                    if child in elements:

    71

##                        RemoveElement(child, element_tree)

    72

##                        removed.append(child)

    73

                    if "start" in element_tree[child]["parents"]:

    74

                        if element not in remove_stops["stop"]:

    75

                            remove_stops["stop"].append(element)

    76

                        if child not in remove_stops["start"]:

    77

                            remove_stops["start"].append(child)

    78

            for child in removed:

    79

                values["children"].remove(child)

    80

    for element in remove_stops["start"]:

    81

        element_tree[element]["parents"].remove("start")

    82

    for element in remove_stops["stop"]:

    83

        element_tree[element]["children"].remove("stop")

    84

    for element, values in element_tree.items():

    85

        if values and "stop" in values["children"]:

    86

            CalcWeight(element, element_tree)

    87

            if values["weight"]:

    88

                branch_size += values["weight"]

    89

            else:

    90

                return 1

    91

    #print branch_size

    92

    return branch_size

    93

    94

def RemoveElement(remove, element_tree):

    95

    if remove in element_tree and element_tree[remove]:

    96

        for child in element_tree[remove]["children"]:

    97

            if child != "stop":

    98

                RemoveElement(child, element_tree)

    99

        element_tree.pop(remove)

   100

##        element_tree[remove] = None

   101

   102

def GenerateTree(element, element_tree, stop_list):

   103

    if element in element_tree:

   104

        connectors = element.GetConnectors()

   105

        input_connectors = []

   106

        if isinstance(element, LD_PowerRail) and element.GetType() == RIGHTRAIL:

   107

            input_connectors = connectors

   108

        else:

   109

            if "inputs" in connectors:

   110

                input_connectors = connectors["inputs"]

   111

            if "input" in connectors:

   112

                input_connectors = [connectors["input"]]

   113

        for connector in input_connectors:

   114

            for wire, handle in connector.GetWires():

   115

                next = wire.EndConnected.GetParentBlock()

   116

                if isinstance(next, LD_PowerRail) and next.GetType() == LEFTRAIL or next in stop_list:

   117

##                    for remove in element_tree[element]["children"]:

   118

##                        RemoveElement(remove, element_tree)

   119

##                    element_tree[element]["children"] = ["stop"]

   120

                    element_tree[element]["children"].append("stop")

   121

##                elif element_tree[element]["children"] == ["stop"]:

   122

##                    element_tree[next] = None

   123

                elif next not in element_tree or element_tree[next]:

   124

                    element_tree[element]["children"].append(next)

   125

                    if next in element_tree:

   126

                        element_tree[next]["parents"].append(element)

   127

                    else:

   128

                        element_tree[next] = {"parents":[element], "children":[], "weight":None}

   129

                        GenerateTree(next, element_tree, stop_list)

   130

   131

def CalcWeight(element, element_tree):

   132

    weight = 0

   133

    parts = None

   134

    if element in element_tree:

   135

        for parent in element_tree[element]["parents"]:

   136

            if parent == "start":

   137

                weight += 1

   138

            elif parent in element_tree:

   139

                if not parts:

   140

                    parts = len(element_tree[parent]["children"])

   141

                else:

   142

                    parts = min(parts, len(element_tree[parent]["children"]))

   143

                if not element_tree[parent]["weight"]:

   144

                    CalcWeight(parent, element_tree)

   145

                if element_tree[parent]["weight"]:

   146

                    weight += element_tree[parent]["weight"]

   147

                else:

   148

                    element_tree[element]["weight"] = None

   149

                    return

   150

            else:

   151

                element_tree[element]["weight"] = None

   152

                return

   153

        if not parts:

   154

            parts = 1

   155

        element_tree[element]["weight"] = max(1, weight / parts)

   156

   157

   158

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

   159

#                     Ladder Diagram Graphic elements Viewer class

   160

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

   161

   162

"""

   163

Class derived from Viewer class that implements a Viewer of Ladder Diagram

   164

"""

   165

   166

class LD_Viewer(Viewer):

   167

   168

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

   169

        Viewer.__init__(self, parent, window, controler)

   170

        self.Rungs = []

   171

        self.RungComments = []

   172

   173

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

   174

#                          Refresh functions

   175

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

   176

   177

    def RefreshView(self):

   178

        Viewer.RefreshView(self)

   179

        for i, rung in enumerate(self.Rungs):

   180

            bbox = rung.GetBoundingBox()

   181

            if i < len(self.RungComments):

   186

            else:

   187

                self.RungComments.insert(i, None)

   188

   189

    def loadInstance(self, instance, ids):

   190

        Viewer.loadInstance(self, instance, ids)

   191

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

   192

            element = self.FindElementById(instance["id"])

   193

            rung = Graphic_Group(self)

   194

            rung.SelectElement(element)

   195

            self.Rungs.append(rung)

   196

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

   197

            rungs = []

   198

            for connector in instance["connectors"]:

   199

                for link in connector["links"]:

   200

                    connected = self.FindElementById(link["refLocalId"])

   201

                    rung = self.FindRung(connected)

   202

                    if rung not in rungs:

   203

                        rungs.append(rung)

   204

            if len(rungs) > 1:

   205

                raise "ValueError", "Ladder element with id %d is on more than one rung."%instance["id"]

   206

            element = self.FindElementById(instance["id"])

   207

            self.Rungs[rungs[0]].SelectElement(element)

   208

            for connector in element.GetConnectors():

   209

                for wire, num in connector.GetWires():

   210

                    self.Rungs[rungs[0]].SelectElement(wire)

   213

        elif instance["type"] in ["contact", "coil"]:

   214

            rungs = []

   215

            for link in instance["connectors"]["input"]["links"]:

   216

                connected = self.FindElementById(link["refLocalId"])

   217

                rung = self.FindRung(connected)

   218

                if rung not in rungs:

   219

                    rungs.append(rung)

   220

            if len(rungs) > 1:

   221

                raise "ValueError", "Ladder element with id %d is on more than one rung."%instance["id"]

   222

            element = self.FindElementById(instance["id"])

   223

            self.Rungs[rungs[0]].SelectElement(element)

   224

            for wire, num in element.GetConnectors()["input"].GetWires():

   225

                self.Rungs[rungs[0]].SelectElement(wire)

   228

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

   229

            element = self.FindElementById(instance["id"])

   230

            pos = element.GetPosition()

   231

            i = 0

   232

            inserted = False

   233

            while i < len(self.RungComments) and not inserted: 

   234

                ipos = self.RungComments[i].GetPosition()

   235

                if pos[1] < ipos[1]:

   236

                    self.RungComments.insert(i, element)

   237

                    inserted = True

   238

                i += 1

   239

            if not inserted:

   240

                self.RungComments.append(element)

   241

   242

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

   243

#                          Search Element functions

   244

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

   245

   246

    def FindRung(self, element):

   247

        for i, rung in enumerate(self.Rungs):

   248

            if rung.IsElementIn(element):

   249

                return i

   250

        return None

   251

   252

    def FindElement(self, pos):

   253

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   254

            return Viewer.FindElement(self, pos)

   255

   256

        elements = []

   257

        for element in self.GetElements(sort_wires=True):

   258

            if element.HitTest(pos) or element.TestHandle(pos) != (0, 0):

   259

                elements.append(element)

   260

        if len(elements) == 1:

   261

            return elements[0]

   262

        elif len(elements) > 1:

   263

            group = Graphic_Group(self)

   264

            for element in elements:

   265

                if self.IsBlock(element):

   266

                    return element

   267

                group.SelectElement(element)

   268

            return group

   269

        return None

   270

   271

    def SearchElements(self, bbox):

   272

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   273

            return Viewer.SearchElements(self, bbox)

   274

   275

        elements = []

   276

        for element in self.Blocks:

   277

            if element.IsInSelection(bbox):

   278

                elements.append(element)

   279

        return elements

   280

   281

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

   282

#                          Mouse event functions

   283

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

   284

   285

    def OnViewerLeftDown(self, event):

   286

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   287

            Viewer.OnViewerLeftDown(self, event)

   288

        elif self.Mode == MODE_SELECTION:

   289

            dc = self.GetLogicalDC()

   290

            pos = event.GetLogicalPosition(dc)

   291

            element = self.FindElement(pos)

   292

            if self.SelectedElement:

   293

                if not isinstance(self.SelectedElement, Graphic_Group):

   294

                    if self.SelectedElement != element:

   295

                        if self.IsWire(self.SelectedElement):

   296

                            self.SelectedElement.SetSelectedSegment(None)

   297

                        else:

   298

                            self.SelectedElement.SetSelected(False)

   299

                    else:

   300

                        self.SelectedElement = None

   301

                elif element and isinstance(element, Graphic_Group):

   302

                    if self.SelectedElement.GetElements() != element.GetElements():

   303

                        for elt in self.SelectedElement.GetElements():

   304

                            if self.IsWire(elt):

   305

                                elt.SetSelectedSegment(None)

   306

                        self.SelectedElement.SetSelected(False)

   307

                        self.SelectedElement = None

   308

                else:

   309

                    for elt in self.SelectedElement.GetElements():

   310

                        if self.IsWire(elt):

   311

                            elt.SetSelectedSegment(None)

   312

                    self.SelectedElement.SetSelected(False)

   313

                    self.SelectedElement = None

   314

                self.Refresh()

   315

            if element:

   316

                self.SelectedElement = element

   317

                self.SelectedElement.OnLeftDown(event, dc, self.Scaling)

   318

                self.Refresh()

   319

            else:

   320

                self.rubberBand.Reset()

   321

                self.rubberBand.OnLeftDown(event, dc, self.Scaling)

   322

        event.Skip()

   323

   324

    def OnViewerLeftUp(self, event):

   325

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   326

            Viewer.OnViewerLeftUp(self, event)

   327

        elif self.rubberBand.IsShown():

   328

            if self.Mode == MODE_SELECTION:

   329

                elements = self.SearchElements(self.rubberBand.GetCurrentExtent())

   330

                self.rubberBand.OnLeftUp(event, self.GetLogicalDC(), self.Scaling)

   331

                if len(elements) > 0:

   332

                    self.SelectedElement = Graphic_Group(self)

   333

                    self.SelectedElement.SetElements(elements)

   334

                    self.SelectedElement.SetSelected(True)

   335

                    self.Refresh()

   336

        elif self.Mode == MODE_SELECTION and self.SelectedElement:

   337

            dc = self.GetLogicalDC() 

   338

            if not isinstance(self.SelectedElement, Graphic_Group):

   339

                if self.IsWire(self.SelectedElement):

   340

                    result = self.SelectedElement.TestSegment(event.GetLogicalPosition(dc), True)

   341

                    if result and result[1] in [EAST, WEST]:

   342

                        self.SelectedElement.SetSelectedSegment(result[0])

   343

                else:

   344

                    self.SelectedElement.OnLeftUp(event, dc, self.Scaling)

   345

            else:

   346

                for element in self.SelectedElement.GetElements():

   347

                    if self.IsWire(element):

   348

                        result = element.TestSegment(event.GetLogicalPosition(dc), True)

   349

                        if result and result[1] in [EAST, WEST]:

   350

                            element.SetSelectedSegment(result[0])

   351

                    else:

   352

                        element.OnLeftUp(event, dc, self.Scaling)

   353

            wx.CallAfter(self.SetCursor, wx.NullCursor)

   354

            self.ReleaseMouse()

   355

            self.Refresh()

   356

        event.Skip()

   357

   358

    def OnViewerRightUp(self, event):

   359

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   360

            Viewer.OnViewerRightUp(self, event)

   361

        else:

   362

            dc = self.GetLogicalDC()

   363

            pos = event.GetLogicalPosition(dc)

   364

            element = self.FindElement(pos)

   365

            if element:

   366

                if self.SelectedElement and self.SelectedElement != element:

   367

                    self.SelectedElement.SetSelected(False)

   368

                self.SelectedElement = element

   369

                if self.IsWire(self.SelectedElement):

   370

                    self.SelectedElement.SetSelectedSegment(0)

   371

                else:

   372

                    self.SelectedElement.SetSelected(True)

   373

                    self.SelectedElement.OnRightUp(event, dc, self.Scaling)

   374

                wx.CallAfter(self.SetCursor, wx.NullCursor)

   375

                self.ReleaseMouse()

   376

                self.Refresh()

   377

        event.Skip()

   378

   379

    def OnViewerLeftDClick(self, event):

   380

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   381

            Viewer.OnViewerLeftDClick(self, event)

   382

        elif self.Mode == MODE_SELECTION and self.SelectedElement:

   383

            self.SelectedElement.OnLeftDClick(event, self.GetLogicalDC(), self.Scaling)

   384

            self.Refresh()

   385

        event.Skip()

   386

   387

    def OnViewerMotion(self, event):

   388

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   389

            Viewer.OnViewerMotion(self, event)

   390

        elif self.rubberBand.IsShown():

   391

            self.rubberBand.OnMotion(event, self.GetLogicalDC(), self.Scaling)

   392

        event.Skip()

   393

   394

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

   395

#                          Keyboard event functions

   396

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

   397

   398

    def OnChar(self, event):

   399

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   400

            Viewer.OnChar(self, event)

   401

        else:

   402

            xpos, ypos = self.GetScrollPos(wx.HORIZONTAL), self.GetScrollPos(wx.VERTICAL)

   403

            xmax = self.GetScrollRange(wx.HORIZONTAL) - self.GetScrollThumb(wx.HORIZONTAL)

   404

            ymax = self.GetScrollRange(wx.VERTICAL) - self.GetScrollThumb(wx.VERTICAL)

   405

            keycode = event.GetKeyCode()

   406

            if keycode == wx.WXK_DELETE and self.SelectedElement:

   407

                if self.IsBlock(self.SelectedElement):

   408

                    self.SelectedElement.Delete()

   409

                elif self.IsWire(self.SelectedElement):

   410

                    self.DeleteWire(self.SelectedElement)

   411

                elif isinstance(self.SelectedElement, Graphic_Group):

   412

                    all_wires = True

   413

                    for element in self.SelectedElement.GetElements():

   414

                        all_wires &= self.IsWire(element)

   415

                    if all_wires:

   416

                        self.DeleteWire(self.SelectedElement)

   417

                    else:

   418

                        self.SelectedElement.Delete()

   419

                self.RefreshBuffer()

   420

                self.RefreshScrollBars()

   421

                self.Refresh()

   422

            elif keycode == wx.WXK_LEFT:

   423

                if event.ControlDown() and event.ShiftDown():

   424

                    self.Scroll(0, ypos)

   425

                elif event.ControlDown():

   426

                    self.Scroll(max(0, xpos - 1), ypos)

   427

            elif keycode == wx.WXK_RIGHT:

   428

                if event.ControlDown() and event.ShiftDown():

   429

                    self.Scroll(xmax, ypos)

   430

                elif event.ControlDown():

   431

                    self.Scroll(min(xpos + 1, xmax), ypos)

   432

            elif keycode == wx.WXK_UP:

   433

                if event.ControlDown() and event.ShiftDown():

   434

                    self.Scroll(xpos, 0)

   435

                elif event.ControlDown():

   436

                    self.Scroll(xpos, max(0, ypos - 1))

   437

            elif keycode == wx.WXK_DOWN:

   438

                if event.ControlDown() and event.ShiftDown():

   439

                    self.Scroll(xpos, ymax)

   440

                elif event.ControlDown():

   441

                    self.Scroll(xpos, min(ypos + 1, ymax))

   442

        event.Skip()

   443

   444

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

   445

#                          Adding element functions

   446

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

   447

   448

    def AddLadderRung(self):

   449

        dialog = LDElementDialog(self.Parent, "coil")

   450

        varlist = []

   451

        vars = self.Controler.GetCurrentElementEditingInterfaceVars()

   452

        if vars:

   453

            for var in vars:

   454

                if var["Class"] != "Input" and var["Type"] == "BOOL":

   455

                    varlist.append(var["Name"])

   456

        returntype = self.Controler.GetCurrentElementEditingInterfaceReturnType()

   457

        if returntype == "BOOL":

   458

            varlist.append(self.Controler.GetCurrentElementEditingName())

   459

        dialog.SetVariables(varlist)

   460

        dialog.SetValues({"name":"","type":COIL_NORMAL})

   461

        if dialog.ShowModal() == wx.ID_OK:

   462

            values = dialog.GetValues()

   463

            startx, starty = LD_OFFSET[0], 0

   464

            if len(self.Rungs) > 0:

   465

                bbox = self.Rungs[-1].GetBoundingBox()

   466

                starty = bbox.y + bbox.height

   467

            starty += LD_OFFSET[1]

   468

            rung = Graphic_Group(self)

   469

            # Create comment

   470

            id = self.GetNewId()

   471

            comment = Comment(self, "Commentaire", id)

   472

            comment.SetPosition(startx, starty)

   473

            comment.SetSize(LD_COMMENT_DEFAULTSIZE[0], LD_COMMENT_DEFAULTSIZE[1])

   474

            self.AddComment(comment)

   475

            self.RungComments.append(comment)

   476

            self.Controler.AddCurrentElementEditingComment(id)

   477

            self.RefreshCommentModel(comment)

   478

            starty += LD_COMMENT_DEFAULTSIZE[1] + LD_OFFSET[1]

   479

            # Create LeftPowerRail

   480

            id = self.GetNewId()

   481

            leftpowerrail = LD_PowerRail(self, LEFTRAIL, id)

   482

            leftpowerrail.SetPosition(startx, starty)

   483

            self.AddBlock(leftpowerrail)

   484

            rung.SelectElement(leftpowerrail)

   485

            self.Controler.AddCurrentElementEditingPowerRail(id, LEFTRAIL)

   486

            self.RefreshPowerRailModel(leftpowerrail)

   487

            # Create Coil

   488

            id = self.GetNewId()

   489

            coil = LD_Coil(self, values["type"], values["name"], id)

   490

            coil.SetPosition(startx, starty + (LD_LINE_SIZE - LD_ELEMENT_SIZE[1]) / 2)

   491

            self.AddBlock(coil)

   492

            rung.SelectElement(coil)

   493

            self.Controler.AddCurrentElementEditingCoil(id)

   494

            # Create Wire between LeftPowerRail and Coil

   495

            wire = Wire(self)

   496

            start_connector = coil.GetConnectors()["input"]

   497

            end_connector = leftpowerrail.GetConnectors()[0]

   498

            start_connector.Connect((wire, 0), False)

   499

            end_connector.Connect((wire, -1), False)

   500

            wire.ConnectStartPoint(None, start_connector)

   501

            wire.ConnectEndPoint(None, end_connector)

   502

            self.AddWire(wire)

   503

            rung.SelectElement(wire)

   504

            # Create RightPowerRail

   505

            id = self.GetNewId()

   506

            rightpowerrail = LD_PowerRail(self, RIGHTRAIL, id)

   507

            rightpowerrail.SetPosition(startx, starty)

   508

            self.AddBlock(rightpowerrail)

   509

            rung.SelectElement(rightpowerrail)