1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import wx

    26

import time

    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

    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

"""

   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, tagname, window, controler, debug = False, instancepath = ""):

   170

        Viewer.__init__(self, parent, tagname, window, controler, debug, instancepath)

   171

        self.Rungs = []

   172

        self.RungComments = []

   173

        self.CurrentLanguage = "LD"

   174

   175

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

   176

#                          Refresh functions

   177

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

   178

   179

    def ResetView(self):

   180

        self.Rungs = []

   181

        self.RungComments = []

   182

        Viewer.ResetView(self)

   183

   184

    def RefreshView(self, variablepanel=True, selection=None):

   185

        Viewer.RefreshView(self, variablepanel, selection)

   186

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   187

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

   188

                bbox = rung.GetBoundingBox()

   189

                if i < len(self.RungComments):

   190

                    if self.RungComments[i]:

   191

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

   192

                        if pos[1] > bbox.y:

   193

                            self.RungComments.insert(i, None)

   194

                else:

   195

                    self.RungComments.insert(i, None)

   196

   197

    def loadInstance(self, instance, ids, selection):

   198

        Viewer.loadInstance(self, instance, ids, selection)

   199

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   200

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

   201

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

   202

                rung = Graphic_Group(self)

   203

                rung.SelectElement(element)

   204

                self.Rungs.append(rung)

   205

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

   206

                rungs = []

   207

                for connector in instance["inputs"]:

   208

                    for link in connector["links"]:

   209

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

   210

                        rung = self.FindRung(connected)

   211

                        if rung not in rungs:

   212

                            rungs.append(rung)

   213

                if len(rungs) > 1:

   214

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

   215

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

   216

                element_connectors = element.GetConnectors()

   217

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

   218

                for connector in element_connectors["inputs"]:

   219

                    for wire, num in connector.GetWires():

   220

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

   221

                wx.CallAfter(self.RefreshPosition, element)

   222

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

   223

                rungs = []

   224

                for link in instance["inputs"][0]["links"]:

   225

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

   226

                    rung = self.FindRung(connected)

   227

                    if rung not in rungs:

   228

                        rungs.append(rung)

   229

                if len(rungs) > 1:

   230

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

   231

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

   232

                element_connectors = element.GetConnectors()

   233

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

   234

                for wire, num in element_connectors["inputs"][0].GetWires():

   235

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

   236

                wx.CallAfter(self.RefreshPosition, element)

   237

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

   238

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

   239

                pos = element.GetPosition()

   240

                i = 0

   241

                inserted = False

   242

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

   243

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

   244

                    if pos[1] < ipos[1]:

   245

                        self.RungComments.insert(i, element)

   246

                        inserted = True

   247

                    i += 1

   248

                if not inserted:

   249

                    self.RungComments.append(element)

   250

   251

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

   252

#                          Search Element functions

   253

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

   254

   255

    def FindRung(self, element):

   256

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

   257

            if rung.IsElementIn(element):

   258

                return i

   259

        return None

   260

   261

    def FindElement(self, event, exclude_group = False, connectors = True):

   262

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   263

            return Viewer.FindElement(self, event, exclude_group, connectors)

   264

   265

        dc = self.GetLogicalDC()

   266

        pos = event.GetLogicalPosition(dc)

   267

        if self.SelectedElement and not isinstance(self.SelectedElement, (Graphic_Group, Wire)):

   268

            if self.SelectedElement.HitTest(pos, connectors) or self.SelectedElement.TestHandle(pos) != (0, 0):

   269

                return self.SelectedElement

   270

        elements = []

   271

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

   272

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

   273

                elements.append(element)

   274

        if len(elements) == 1:

   275

            return elements[0]

   276

        elif len(elements) > 1:

   277

            group = Graphic_Group(self)

   278

            for element in elements:

   279

                if self.IsBlock(element):

   280

                    return element

   281

                group.SelectElement(element)

   282

            return group

   283

        return None

   284

   285

    def SearchElements(self, bbox):

   286

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   287

            return Viewer.SearchElements(self, bbox)

   288

   289

        elements = []

   290

        for element in self.Blocks.values() + self.Comments.values():

   291

            if element.IsInSelection(bbox):

   292

                elements.append(element)

   293

        return elements

   294

   295

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

   296

#                          Mouse event functions

   297

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

   298

   299

    def OnViewerLeftDown(self, event):

   300

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   301

            Viewer.OnViewerLeftDown(self, event)

   302

        elif self.Mode == MODE_SELECTION:

   303

            element = self.FindElement(event)

   304

            if self.SelectedElement:

   305

                if not isinstance(self.SelectedElement, Graphic_Group):

   306

                    if self.SelectedElement != element:

   307

                        if self.IsWire(self.SelectedElement):

   308

                            self.SelectedElement.SetSelectedSegment(None)

   309

                        else:

   310

                            self.SelectedElement.SetSelected(False)

   311

                    else:

   312

                        self.SelectedElement = None

   313

                elif element and isinstance(element, Graphic_Group):

   314

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

   315

                        for elt in self.SelectedElement.GetElements():

   316

                            if self.IsWire(elt):

   317

                                elt.SetSelectedSegment(None)

   318

                        self.SelectedElement.SetSelected(False)

   319

                        self.SelectedElement = None

   320

                else:

   321

                    for elt in self.SelectedElement.GetElements():

   322

                        if self.IsWire(elt):

   323

                            elt.SetSelectedSegment(None)

   324

                    self.SelectedElement.SetSelected(False)

   325

                    self.SelectedElement = None

   326

            if element:

   327

                self.SelectedElement = element

   328

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

   329

                self.SelectedElement.Refresh()

   330

            else:

   331

                self.rubberBand.Reset()

   332

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

   333

        event.Skip()

   334

   335

    def OnViewerLeftUp(self, event):

   336

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   337

            Viewer.OnViewerLeftUp(self, event)

   338

        elif self.rubberBand.IsShown():

   339

            if self.Mode == MODE_SELECTION:

   340

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

   341

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

   342

                if len(elements) > 0:

   343

                    self.SelectedElement = Graphic_Group(self)

   344

                    self.SelectedElement.SetElements(elements)

   345

                    self.SelectedElement.SetSelected(True)

   346

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

   347

            dc = self.GetLogicalDC()

   348

            if not isinstance(self.SelectedElement, Graphic_Group):

   349

                if self.IsWire(self.SelectedElement):

   350

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

   351

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

   352

                        self.SelectedElement.SetSelectedSegment(result[0])

   353

                else:

   354

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

   355

            else:

   356

                for element in self.SelectedElement.GetElements():

   357

                    if self.IsWire(element):

   358

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

   359

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

   360

                            element.SetSelectedSegment(result[0])

   361

                    else:

   362

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

   363

            self.SelectedElement.Refresh()

   364

            wx.CallAfter(self.SetCurrentCursor, 0)

   365

        event.Skip()

   366

   367

    def OnViewerRightUp(self, event):

   368

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   369

            Viewer.OnViewerRightUp(self, event)

   370

        else:

   371

            element = self.FindElement(event)

   372

            if element:

   373

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

   374

                    self.SelectedElement.SetSelected(False)

   375

                self.SelectedElement = element

   376

                if self.IsWire(self.SelectedElement):

   377

                    self.SelectedElement.SetSelectedSegment(0)

   378

                else:

   379

                    self.SelectedElement.SetSelected(True)

   380

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

   381

                    self.SelectedElement.Refresh()

   382

                wx.CallAfter(self.SetCurrentCursor, 0)

   383

        event.Skip()

   384

   385

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

   386

#                          Keyboard event functions

   387

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

   388

   389

    def OnChar(self, event):

   390

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   391

            Viewer.OnChar(self, event)

   392

        else:

   393

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

   394

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

   395

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

   396

            keycode = event.GetKeyCode()

   397

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

   398

                if self.IsBlock(self.SelectedElement):

   399

                    self.SelectedElement.Delete()

   400

                elif self.IsWire(self.SelectedElement):

   401

                    self.DeleteWire(self.SelectedElement)

   402

                elif isinstance(self.SelectedElement, Graphic_Group):

   403

                    all_wires = True

   404

                    for element in self.SelectedElement.GetElements():

   405

                        all_wires &= self.IsWire(element)

   406

                    if all_wires:

   407

                        self.DeleteWire(self.SelectedElement)

   408

                    else:

   409

                        self.SelectedElement.Delete()

   410

                self.RefreshBuffer()

   411

                self.RefreshScrollBars()

   412

                self.Refresh(False)

   413

            elif keycode == wx.WXK_LEFT:

   414

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

   415

                    self.Scroll(0, ypos)

   416

                elif event.ControlDown():

   417

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

   418

            elif keycode == wx.WXK_RIGHT:

   419

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

   420

                    self.Scroll(xmax, ypos)

   421

                elif event.ControlDown():

   422

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

   423

            elif keycode == wx.WXK_UP:

   424

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

   425

                    self.Scroll(xpos, 0)

   426

                elif event.ControlDown():

   427

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

   428

            elif keycode == wx.WXK_DOWN:

   429

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

   430

                    self.Scroll(xpos, ymax)

   431

                elif event.ControlDown():

   432

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

   433

            else:

   434

                event.Skip()

   435

   436

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

   437

#                  Model adding functions from Drop Target

   438

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

   439

   440

    def AddVariableBlock(self, x, y, scaling, var_class, var_name, var_type):

   441

        if var_type == "BOOL":

   442

            id = self.GetNewId()

   443

            if var_class == INPUT:

   444

                contact = LD_Contact(self, CONTACT_NORMAL, var_name, id)

   445

                width, height = contact.GetMinSize()

   446

                if scaling is not None:

   447

                    x = round(float(x) / float(scaling[0])) * scaling[0]

   448

                    y = round(float(y) / float(scaling[1])) * scaling[1]

   449

                    width = round(float(width) / float(scaling[0]) + 0.5) * scaling[0]

   450

                    height = round(float(height) / float(scaling[1]) + 0.5) * scaling[1]

   451

                contact.SetPosition(x, y)

   452

                contact.SetSize(width, height)

   453

                self.AddBlock(contact)

   454

                self.Controler.AddEditedElementContact(self.GetTagName(), id)

   455

                self.RefreshContactModel(contact)

   456

            else:

   457

                coil = LD_Coil(self, COIL_NORMAL, var_name, id)

   458

                width, height = coil.GetMinSize()

   459

                if scaling is not None:

   460

                    x = round(float(x) / float(scaling[0])) * scaling[0]

   461

                    y = round(float(y) / float(scaling[1])) * scaling[1]

   462

                    width = round(float(width) / float(scaling[0]) + 0.5) * scaling[0]

   463

                    height = round(float(height) / float(scaling[1]) + 0.5) * scaling[1]

   464

                coil.SetPosition(x, y)

   465

                coil.SetSize(width, height)

   466

                self.AddBlock(coil)

   467

                self.Controler.AddEditedElementCoil(self.GetTagName(), id)

   468

                self.RefreshCoilModel(coil)

   469

            self.RefreshBuffer()

   470

            self.RefreshScrollBars()

   471

            self.RefreshVisibleElements()

   472

            self.Refresh(False)

   473

        else:

   474

            Viewer.AddVariableBlock(self, x, y, scaling, var_class, var_name, var_type)

   475

   476

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

   477

#                          Adding element functions

   478

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

   479

   480

    def AddLadderRung(self):

   481

        dialog = LDElementDialog(self.ParentWindow, self.Controler, "coil")

   482

        dialog.SetPreviewFont(self.GetFont())

   483

        varlist = []

   484

        vars = self.Controler.GetEditedElementInterfaceVars(self.TagName, debug=self.Debug)

   485

        if vars:

   486

            for var in vars:

   487

                if var.Class != "Input" and var.Type == "BOOL":

   488

                    varlist.append(var.Name)

   489

        returntype = self.Controler.GetEditedElementInterfaceReturnType(self.TagName, debug=self.Debug)

   490

        if returntype == "BOOL":

   491

            varlist.append(self.Controler.GetEditedElementName(self.TagName))

   492

        dialog.SetVariables(varlist)

   493

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

   494

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

   495

            values = dialog.GetValues()

   496

            startx, starty = LD_OFFSET[0], 0

   497

            if len(self.Rungs) > 0:

   498

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

   499

                starty = bbox.y + bbox.height

   500

            starty += LD_OFFSET[1]

   501

            rung = Graphic_Group(self)

   502

   503

            # Create comment

   504

            id = self.GetNewId()

   505

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

   506

            comment.SetPosition(startx, starty)

   507

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

   508

            self.AddComment(comment)

   509

            self.RungComments.append(comment)

   510

            self.Controler.AddEditedElementComment(self.TagName, id)

   511

            self.RefreshCommentModel(comment)

   512

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

   513

   514

            # Create LeftPowerRail

   515

            id = self.GetNewId()

   516

            leftpowerrail = LD_PowerRail(self, LEFTRAIL, id)

   517

            leftpowerrail.SetPosition(startx, starty)

   518

            leftpowerrail_connectors = leftpowerrail.GetConnectors()

   519

            self.AddBlock(leftpowerrail)

   520

            rung.SelectElement(leftpowerrail)

   521

            self.Controler.AddEditedElementPowerRail(self.TagName, id, LEFTRAIL)

   522

            self.RefreshPowerRailModel(leftpowerrail)

   523

   524

            # Create Coil