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): 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

#Lesser 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

from wxPython.wx import *

    26

import wx

    27

from types import *

    28

    29

from Viewer import *

    30

    31

def ExtractNextBlocks(block, block_list):

    32

    current_list = [block]

    33

    while len(current_list) > 0:

    34

        next_list = []

    35

        for current in current_list:

    36

            connectors = current.GetConnectors()

    37

            input_connectors = []

    38

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

    39

                input_connectors = connectors

    40

            else:

    41

                if "inputs" in connectors:

    42

                    input_connectors = connectors["inputs"]

    43

                if "input" in connectors:

    44

                    input_connectors = [connectors["input"]]

    45

            for connector in input_connectors:

    46

                for wire, handle in connector.GetWires():

    47

                    next = wire.EndConnected.GetParentBlock()

    48

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

    49

                        block_list.append(next)

    50

                        next_list.append(next)

    51

        current_list = next_list

    52

    53

def CalcBranchSize(elements, stops):

    54

    branch_size = 0

    55

    stop_list = stops

    56

    for stop in stops:

    57

        ExtractNextBlocks(stop, stop_list)

    58

    element_tree = {}

    59

    for element in elements:

    60

        if element not in element_tree:

    61

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

    62

            GenerateTree(element, element_tree, stop_list)

    63

        elif element_tree[element]:

    64

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

    65

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

    66

    for element, values in element_tree.items():

    67

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

    68

            removed = []

    69

            for child in values["children"]:

    70

                if child != "stop":

    71

##                    if child in elements:

    72

##                        RemoveElement(child, element_tree)

    73

##                        removed.append(child)

    74

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

    75

                        if element not in remove_stops["stop"]:

    76

                            remove_stops["stop"].append(element)

    77

                        if child not in remove_stops["start"]:

    78

                            remove_stops["start"].append(child)

    79

            for child in removed:

    80

                values["children"].remove(child)

    81

    for element in remove_stops["start"]:

    82

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

    83

    for element in remove_stops["stop"]:

    84

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

    85

    for element, values in element_tree.items():

    86

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

    87

            CalcWeight(element, element_tree)

    88

            if values["weight"]:

    89

                branch_size += values["weight"]

    90

            else:

    91

                return 1

    92

    #print branch_size

    93

    return branch_size

    94

    95

def RemoveElement(remove, element_tree):

    96

    if remove in element_tree and element_tree[remove]:

    97

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

    98

            if child != "stop":

    99

                RemoveElement(child, element_tree)

   100

        element_tree.pop(remove)

   101

##        element_tree[remove] = None

   102

   103

def GenerateTree(element, element_tree, stop_list):

   104

    if element in element_tree:

   105

        connectors = element.GetConnectors()

   106

        input_connectors = []

   107

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

   108

            input_connectors = connectors

   109

        else:

   110

            if "inputs" in connectors:

   111

                input_connectors = connectors["inputs"]

   112

            if "input" in connectors:

   113

                input_connectors = [connectors["input"]]

   114

        for connector in input_connectors:

   115

            for wire, handle in connector.GetWires():

   116

                next = wire.EndConnected.GetParentBlock()

   117

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

   118

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

   119

##                        RemoveElement(remove, element_tree)

   120

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

   121

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

   122

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

   123

##                    element_tree[next] = None

   124

                elif next not in element_tree or element_tree[next]:

   125

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

   126

                    if next in element_tree:

   127

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

   128

                    else:

   129

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

   130

                        GenerateTree(next, element_tree, stop_list)

   131

   132

def CalcWeight(element, element_tree):

   133

    weight = 0

   134

    parts = None

   135

    if element in element_tree:

   136

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

   137

            if parent == "start":

   138

                weight += 1

   139

            elif parent in element_tree:

   140

                if not parts:

   141

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

   142

                else:

   143

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

   144

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

   145

                    CalcWeight(parent, element_tree)

   146

                if element_tree[parent]["weight"]:

   147

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

   148

                else:

   149

                    element_tree[element]["weight"] = None

   150

                    return

   151

            else:

   152

                element_tree[element]["weight"] = None

   153

                return

   154

        if not parts:

   155

            parts = 1

   156

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

   157

   158

   159

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

   160

#                     Ladder Diagram Graphic elements Viewer class

   161

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

   162

   163

"""

   164

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

   165

"""

   166

   167

class LD_Viewer(Viewer):

   168

   169

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

   170

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

   171

        self.Rungs = []

   172

        self.RungComments = []

   173

   174

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

   175

#                          Refresh functions

   176

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

   177

   178

    def RefreshView(self):

   179

        Viewer.RefreshView(self)

   180

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

   181

            bbox = rung.GetBoundingBox()

   182

            if i < len(self.RungComments):

   183

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

   184

                if pos[1] > bbox.y:

   185

                    self.RungComments.insert(i, None)

   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)

   211

            self.RefreshPosition(element)

   212

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

   213

            rungs = []

   214

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

   215

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

   216

                rung = self.FindRung(connected)

   217

                if rung not in rungs:

   218

                    rungs.append(rung)

   219

            if len(rungs) > 1:

   220

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

   221

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

   222

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

   223

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

   224

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

   225

            self.RefreshPosition(element)

   226

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

   227

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

   228

            pos = element.GetPosition()

   229

            i = 0

   230

            inserted = False

   231

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

   232

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

   233

                if pos[1] < ipos[1]:

   234

                    self.RungComments.insert(i, element)

   235

                    inserted = True

   236

                i += 1

   237

            if not inserted:

   238

                self.RungComments.append(element)

   239

   240

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

   241

#                          Search Element functions

   242

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

   243

   244

    def FindRung(self, element):

   245

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

   246

            if rung.IsElementIn(element):

   247

                return i

   248

        return None

   249

   250

    def FindElement(self, pos):

   251

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   252

            return Viewer.FindElement(self, pos)

   253

   254

        elements = []

   255

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

   256

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

   257

                elements.append(element)

   258

        if len(elements) == 1:

   259

            return elements[0]

   260

        elif len(elements) > 1:

   261

            group = Graphic_Group(self)

   262

            for element in elements:

   263

                if self.IsBlock(element):

   264

                    return element

   265

                group.SelectElement(element)

   266

            return group

   267

        return None

   268

   269

    def SearchElements(self, bbox):

   270

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   271

            return Viewer.SearchElements(self, bbox)

   272

   273

        elements = []

   274

        for element in self.Blocks:

   275

            if element.IsInSelection(bbox):

   276

                elements.append(element)

   277

        return elements

   278

   279

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

   280

#                          Mouse event functions

   281

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

   282

   283

    def OnViewerLeftDown(self, event):

   284

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   285

            Viewer.OnViewerLeftDown(self, event)

   286

        elif self.Mode == MODE_SELECTION:

   287

            dc = self.GetLogicalDC()

   288

            pos = event.GetLogicalPosition(dc)

   289

            element = self.FindElement(pos)

   290

            if self.SelectedElement:

   291

                if not isinstance(self.SelectedElement, Graphic_Group):

   292

                    if self.SelectedElement != element:

   293

                        if self.IsWire(self.SelectedElement):

   294

                            self.SelectedElement.SetSelectedSegment(None)

   295

                        else:

   296

                            self.SelectedElement.SetSelected(False)

   297

                    else:

   298

                        self.SelectedElement = None

   299

                elif element and isinstance(element, Graphic_Group):

   300

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

   301

                        for elt in self.SelectedElement.GetElements():

   302

                            if self.IsWire(elt):

   303

                                elt.SetSelectedSegment(None)

   304

                        self.SelectedElement.SetSelected(False)

   305

                        self.SelectedElement = None

   306

                else:

   307

                    for elt in self.SelectedElement.GetElements():

   308

                        if self.IsWire(elt):

   309

                            elt.SetSelectedSegment(None)

   310

                    self.SelectedElement.SetSelected(False)

   311

                    self.SelectedElement = None

   312

                self.Refresh()

   313

            if element:

   314

                self.SelectedElement = element

   315

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

   316

                self.Refresh()

   317

            else:

   318

                self.rubberBand.Reset()

   319

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

   320

        event.Skip()

   321

   322

    def OnViewerLeftUp(self, event):

   323

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   324

            Viewer.OnViewerLeftUp(self, event)

   325

        elif self.rubberBand.IsShown():

   326

            if self.Mode == MODE_SELECTION:

   327

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

   328

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

   329

                if len(elements) > 0:

   330

                    self.SelectedElement = Graphic_Group(self)

   331

                    self.SelectedElement.SetElements(elements)

   332

                    self.SelectedElement.SetSelected(True)

   333

                    self.Refresh()

   334

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

   335

            dc = self.GetLogicalDC() 

   336

            if not isinstance(self.SelectedElement, Graphic_Group):

   337

                if self.IsWire(self.SelectedElement):

   338

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

   339

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

   340

                        self.SelectedElement.SetSelectedSegment(result[0])

   341

                else:

   342

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

   343

            else:

   344

                for element in self.SelectedElement.GetElements():

   345

                    if self.IsWire(element):

   346

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

   347

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

   348

                            element.SetSelectedSegment(result[0])

   349

                    else:

   350

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

   351

            wxCallAfter(self.SetCursor, wxNullCursor)

   352

            self.ReleaseMouse()

   353

            self.Refresh()

   354

        event.Skip()

   355

   356

    def OnViewerRightUp(self, event):

   357

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   358

            Viewer.OnViewerRightUp(self, event)

   359

        else:

   360

            dc = self.GetLogicalDC()

   361

            pos = event.GetLogicalPosition(dc)

   362

            element = self.FindElement(pos)

   363

            if element:

   364

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

   365

                    self.SelectedElement.SetSelected(False)

   366

                self.SelectedElement = element

   367

                if self.IsWire(self.SelectedElement):

   368

                    self.SelectedElement.SetSelectedSegment(0)

   369

                else:

   370

                    self.SelectedElement.SetSelected(True)

   371

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

   372

                wxCallAfter(self.SetCursor, wxNullCursor)

   373

                self.ReleaseMouse()

   374

                self.Refresh()

   375

        event.Skip()

   376

   377

    def OnViewerLeftDClick(self, event):

   378

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   379

            Viewer.OnViewerLeftDClick(self, event)

   380

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

   381

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

   382

            self.Refresh()

   383

        event.Skip()

   384

   385

    def OnViewerMotion(self, event):

   386

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   387

            Viewer.OnViewerMotion(self, event)

   388

        elif self.rubberBand.IsShown():

   389

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

   390

        event.Skip()

   391

   392

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

   393

#                          Keyboard event functions

   394

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

   395

   396

    def OnChar(self, event):

   397

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   398

            Viewer.OnChar(self, event)

   399

        else:

   400

            keycode = event.GetKeyCode()

   401

            if keycode == WXK_DELETE and self.SelectedElement:

   402

                if self.IsBlock(self.SelectedElement):

   403

                    self.SelectedElement.Delete()

   404

                elif self.IsWire(self.SelectedElement):

   405

                    self.DeleteWire(self.SelectedElement)

   406

                elif isinstance(self.SelectedElement, Graphic_Group):

   407

                    all_wires = True

   408

                    for element in self.SelectedElement.GetElements():

   409

                        all_wires &= self.IsWire(element)

   410

                    if all_wires:

   411

                        self.DeleteWire(self.SelectedElement)

   412

                    else:

   413

                        self.SelectedElement.Delete()

   414

            self.Refresh()

   415

        event.Skip()

   416

   417

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

   418

#                          Adding element functions

   419

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

   420

   421

    def AddLadderRung(self):

   422

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

   423

        varlist = []

   424

        vars = self.Controler.GetCurrentElementEditingInterfaceVars()

   425

        if vars:

   426

            for var in vars:

   427

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

   428

                    varlist.append(var["Name"])

   429

        returntype = self.Controler.GetCurrentElementEditingInterfaceReturnType()

   430

        if returntype == "BOOL":

   431

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

   432

        dialog.SetVariables(varlist)

   433

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

   434

        if dialog.ShowModal() == wxID_OK:

   435

            values = dialog.GetValues()

   436

            startx, starty = LD_OFFSET[0], 0

   437

            if len(self.Rungs) > 0:

   438

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

   439

                starty = bbox.y + bbox.height

   440

            starty += LD_OFFSET[1]

   441

            rung = Graphic_Group(self)

   442

            # Create comment

   443

            id = self.GetNewId()

   444

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

   445

            comment.SetPosition(startx, starty)

   446

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

   447

            self.AddComment(comment)

   448

            self.RungComments.append(comment)

   449

            self.Controler.AddCurrentElementEditingComment(id)

   450

            self.RefreshCommentModel(comment)

   451

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

   452

            # Create LeftPowerRail

   453

            id = self.GetNewId()

   454

            leftpowerrail = LD_PowerRail(self, LEFTRAIL, id)

   455

            leftpowerrail.SetPosition(startx, starty)

   456

            self.AddBlock(leftpowerrail)

   457

            rung.SelectElement(leftpowerrail)

   458

            self.Controler.AddCurrentElementEditingPowerRail(id, LEFTRAIL)

   459

            self.RefreshPowerRailModel(leftpowerrail)

   460

            # Create Coil

   461

            id = self.GetNewId()

   462

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

   463

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

   464

            self.AddBlock(coil)

   465

            rung.SelectElement(coil)

   466

            self.Controler.AddCurrentElementEditingCoil(id)

   467

            # Create Wire between LeftPowerRail and Coil

   468

            wire = Wire(self)

   469

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

   470

            end_connector = leftpowerrail.GetConnectors()[0]

   471

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

   472

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

   473

            wire.ConnectStartPoint(None, start_connector)

   474

            wire.ConnectEndPoint(None, end_connector)

   476

            rung.SelectElement(wire)

   477

            # Create RightPowerRail

   478

            id = self.GetNewId()

   479

            rightpowerrail = LD_PowerRail(self, RIGHTRAIL, id)

   480

            rightpowerrail.SetPosition(startx, starty)

   481

            self.AddBlock(rightpowerrail)

   482

            rung.SelectElement(rightpowerrail)

   483

            self.Controler.AddCurrentElementEditingPowerRail(id, RIGHTRAIL)

   484

            # Create Wire between LeftPowerRail and Coil

   485

            wire = Wire(self)

   486

            start_connector = rightpowerrail.GetConnectors()[0]

   487

            end_connector = coil.GetConnectors()["output"]

   488

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

   489

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

   490

            wire.ConnectStartPoint(None, start_connector)

   491

            wire.ConnectEndPoint(None, end_connector)

   493

            rung.SelectElement(wire)

   494

            self.RefreshPosition(coil)

   495

            self.Rungs.append(rung)

   496

            self.Refresh()

   497

   498

    def AddLadderContact(self):

   499

        wires = []

   500

        if self.IsWire(self.SelectedElement):

   501

            left_element = self.SelectedElement.EndConnected

   502

            if not isinstance(left_element.GetParentBlock(), LD_Coil):

   503

                wires.append(self.SelectedElement)

   504

        elif self.SelectedElement and isinstance(self.SelectedElement,Graphic_Group):

   505

            if False not in [self.IsWire(element) for element in self.SelectedElement.GetElements()]:

   506

                for element in self.SelectedElement.GetElements():

   507

                    wires.append(element)

   508

        if len(wires) > 0:

   509

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

   510

            varlist = []

   511

            vars = self.Controler.GetCurrentElementEditingInterfaceVars()

   512

            if vars: