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

    32

def ExtractNextBlocks(block, block_list):

    33

    current_list = [block]

    34

    while len(current_list) > 0:

    35

        next_list = []

    36

        for current in current_list:

    37

            connectors = current.GetConnectors()

    38

            input_connectors = []

    39

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

    40

                input_connectors = connectors

    41

            else:

    42

                if "inputs" in connectors:

    43

                    input_connectors = connectors["inputs"]

    44

                if "input" in connectors:

    45

                    input_connectors = [connectors["input"]]

    46

            for connector in input_connectors:

    47

                for wire, handle in connector.GetWires():

    48

                    next = wire.EndConnected.GetParentBlock()

    49

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

    50

                        block_list.append(next)

    51

                        next_list.append(next)

    52

        current_list = next_list

    53

    54

    55

def CalcBranchSize(elements, stops):

    56

    branch_size = 0

    57

    stop_list = stops

    58

    for stop in stops:

    59

        ExtractNextBlocks(stop, stop_list)

    60

    element_tree = {}

    61

    for element in elements:

    62

        if element not in element_tree:

    63

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

    64

            GenerateTree(element, element_tree, stop_list)

    65

        elif element_tree[element]:

    66

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

    67

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

    68

    for element, values in element_tree.items():

    69

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

    70

            removed = []

    71

            for child in values["children"]:

    72

                if child != "stop":

    73

                    # if child in elements:

    74

                    #     RemoveElement(child, element_tree)

    75

                    #     removed.append(child)

    76

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

    77

                        if element not in remove_stops["stop"]:

    78

                            remove_stops["stop"].append(element)

    79

                        if child not in remove_stops["start"]:

    80

                            remove_stops["start"].append(child)

    81

            for child in removed:

    82

                values["children"].remove(child)

    83

    for element in remove_stops["start"]:

    84

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

    85

    for element in remove_stops["stop"]:

    86

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

    87

    for element, values in element_tree.items():

    88

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

    89

            CalcWeight(element, element_tree)

    90

            if values["weight"]:

    91

                branch_size += values["weight"]

    92

            else:

    93

                return 1

    94

    return branch_size

    95

    96

    97

def RemoveElement(remove, element_tree):

    98

    if remove in element_tree and element_tree[remove]:

    99

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

   100

            if child != "stop":

   101

                RemoveElement(child, element_tree)

   102

        element_tree.pop(remove)

   103

#        element_tree[remove] = None

   104

   105

   106

def GenerateTree(element, element_tree, stop_list):

   107

    if element in element_tree:

   108

        connectors = element.GetConnectors()

   109

        input_connectors = []

   110

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

   111

            input_connectors = connectors

   112

        else:

   113

            if "inputs" in connectors:

   114

                input_connectors = connectors["inputs"]

   115

            if "input" in connectors:

   116

                input_connectors = [connectors["input"]]

   117

        for connector in input_connectors:

   118

            for wire, handle in connector.GetWires():

   119

                next = wire.EndConnected.GetParentBlock()

   120

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

   121

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

   122

                    #     RemoveElement(remove, element_tree)

   123

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

   124

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

   125

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

   126

                #     element_tree[next] = None

   127

                elif next not in element_tree or element_tree[next]:

   128

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

   129

                    if next in element_tree:

   130

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

   131

                    else:

   132

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

   133

                        GenerateTree(next, element_tree, stop_list)

   134

   135

   136

def CalcWeight(element, element_tree):

   137

    weight = 0

   138

    parts = None

   139

    if element in element_tree:

   140

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

   141

            if parent == "start":

   142

                weight += 1

   143

            elif parent in element_tree:

   144

                if not parts:

   145

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

   146

                else:

   147

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

   148

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

   149

                    CalcWeight(parent, element_tree)

   150

                if element_tree[parent]["weight"]:

   151

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

   152

                else:

   153

                    element_tree[element]["weight"] = None

   154

                    return

   155

            else:

   156

                element_tree[element]["weight"] = None

   157

                return

   158

        if not parts:

   159

            parts = 1

   160

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

   161

   162

   163

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

   164

#                     Ladder Diagram Graphic elements Viewer class

   165

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

   166

   167

   168

class LD_Viewer(Viewer):

   169

    """

   170

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

   171

    """

   172

   173

    def __init__(self, parent, tagname, window, controler, debug=False, instancepath=""):

   174

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

   175

        self.Rungs = []

   176

        self.RungComments = []

   177

        self.CurrentLanguage = "LD"

   178

   179

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

   180

    #                          Refresh functions

   181

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

   182

   183

    def ResetView(self):

   184

        self.Rungs = []

   185

        self.RungComments = []

   186

        Viewer.ResetView(self)

   187

   188

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

   189

        Viewer.RefreshView(self, variablepanel, selection)

   190

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   191

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

   192

                bbox = rung.GetBoundingBox()

   193

                if i < len(self.RungComments):

   194

                    if self.RungComments[i]:

   195

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

   196

                        if pos[1] > bbox.y:

   197

                            self.RungComments.insert(i, None)

   198

                else:

   199

                    self.RungComments.insert(i, None)

   200

   201

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

   202

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

   203

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   204

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

   205

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

   206

                rung = Graphic_Group(self)

   207

                rung.SelectElement(element)

   208

                self.Rungs.append(rung)

   209

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

   210

                rungs = []

   211

                for connector in instance["inputs"]:

   212

                    for link in connector["links"]:

   213

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

   214

                        rung = self.FindRung(connected)

   215

                        if rung not in rungs:

   216

                            rungs.append(rung)

   217

                if len(rungs) > 1:

   218

                    raise ValueError(

   219

                        _("Ladder element with id %d is on more than one rung.")

   220

                        % instance["id"])

   221

   222

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

   223

                element_connectors = element.GetConnectors()

   224

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

   225

                for connector in element_connectors["inputs"]:

   226

                    for wire, num in connector.GetWires():

   227

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

   228

                wx.CallAfter(self.RefreshPosition, element)

   229

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

   230

                rungs = []

   231

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

   232

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

   233

                    rung = self.FindRung(connected)

   234

                    if rung not in rungs:

   235

                        rungs.append(rung)

   236

                if len(rungs) > 1:

   237

                    raise ValueError(

   238

                        _("Ladder element with id %d is on more than one rung.")

   239

                        % instance["id"])

   240

   241

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

   242

                element_connectors = element.GetConnectors()

   243

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

   244

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

   245

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

   246

                wx.CallAfter(self.RefreshPosition, element)

   247

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

   248

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

   249

                pos = element.GetPosition()

   250

                i = 0

   251

                inserted = False

   252

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

   253

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

   254

                    if pos[1] < ipos[1]:

   255

                        self.RungComments.insert(i, element)

   256

                        inserted = True

   257

                    i += 1

   258

                if not inserted:

   259

                    self.RungComments.append(element)

   260

   261

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

   262

    #                          Search Element functions

   263

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

   264

   265

    def FindRung(self, element):

   266

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

   267

            if rung.IsElementIn(element):

   268

                return i

   269

        return None

   270

   271

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

   272

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   273

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

   274

   275

        dc = self.GetLogicalDC()

   276

        pos = event.GetLogicalPosition(dc)

   277

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

   278

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

   279

                return self.SelectedElement

   280

        elements = []

   281

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

   282

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

   283

                elements.append(element)

   284

        if len(elements) == 1:

   285

            return elements[0]

   286

        elif len(elements) > 1:

   287

            group = Graphic_Group(self)

   288

            for element in elements:

   289

                if self.IsBlock(element):

   290

                    return element

   291

                group.SelectElement(element)

   292

            return group

   293

        return None

   294

   295

    def SearchElements(self, bbox):

   296

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   297

            return Viewer.SearchElements(self, bbox)

   298

   299

        elements = []

   300

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

   301

            if element.IsInSelection(bbox):

   302

                elements.append(element)

   303

        return elements

   304

   305

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

   306

    #                          Mouse event functions

   307

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

   308

   309

    def OnViewerLeftDown(self, event):

   310

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   311

            Viewer.OnViewerLeftDown(self, event)

   312

        elif self.Mode == MODE_SELECTION:

   313

            element = self.FindElement(event)

   314

            if self.SelectedElement:

   315

                if not isinstance(self.SelectedElement, Graphic_Group):

   316

                    if self.SelectedElement != element:

   317

                        if self.IsWire(self.SelectedElement):

   318

                            self.SelectedElement.SetSelectedSegment(None)

   319

                        else:

   320

                            self.SelectedElement.SetSelected(False)

   321

                    else:

   322

                        self.SelectedElement = None

   323

                elif element and isinstance(element, Graphic_Group):

   324

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

   325

                        for elt in self.SelectedElement.GetElements():

   326

                            if self.IsWire(elt):

   327

                                elt.SetSelectedSegment(None)

   328

                        self.SelectedElement.SetSelected(False)

   329

                        self.SelectedElement = None

   330

                else:

   331

                    for elt in self.SelectedElement.GetElements():

   332

                        if self.IsWire(elt):

   333

                            elt.SetSelectedSegment(None)

   334

                    self.SelectedElement.SetSelected(False)

   335

                    self.SelectedElement = None

   336

            if element:

   337

                self.SelectedElement = element

   338

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

   339

                self.SelectedElement.Refresh()

   340

            else:

   341

                self.rubberBand.Reset()

   342

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

   343

        event.Skip()

   344

   345

    def OnViewerLeftUp(self, event):

   346

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   347

            Viewer.OnViewerLeftUp(self, event)

   348

        elif self.rubberBand.IsShown():

   349

            if self.Mode == MODE_SELECTION:

   350

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

   351

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

   352

                if len(elements) > 0:

   353

                    self.SelectedElement = Graphic_Group(self)

   354

                    self.SelectedElement.SetElements(elements)

   355

                    self.SelectedElement.SetSelected(True)

   356

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

   357

            dc = self.GetLogicalDC()

   358

            if not isinstance(self.SelectedElement, Graphic_Group):

   359

                if self.IsWire(self.SelectedElement):

   360

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

   361

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

   362

                        self.SelectedElement.SetSelectedSegment(result[0])

   363

                else:

   364

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

   365

            else:

   366

                for element in self.SelectedElement.GetElements():

   367

                    if self.IsWire(element):

   368

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

   369

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

   370

                            element.SetSelectedSegment(result[0])

   371

                    else:

   372

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

   373

            self.SelectedElement.Refresh()

   374

            wx.CallAfter(self.SetCurrentCursor, 0)

   375

        event.Skip()

   376

   377

    def OnViewerRightUp(self, event):

   378

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   379

            Viewer.OnViewerRightUp(self, event)

   380

        else:

   381

            element = self.FindElement(event)

   382

            if element:

   383

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

   384

                    self.SelectedElement.SetSelected(False)

   385

                self.SelectedElement = element

   386

                if self.IsWire(self.SelectedElement):

   387

                    self.SelectedElement.SetSelectedSegment(0)

   388

                else:

   389

                    self.SelectedElement.SetSelected(True)

   390

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

   391

                    self.SelectedElement.Refresh()

   392

                wx.CallAfter(self.SetCurrentCursor, 0)

   393

        event.Skip()

   394

   395

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

   396

    #                          Keyboard event functions

   397

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

   398

   399

    def OnChar(self, event):

   400

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   401

            Viewer.OnChar(self, event)

   402

        else:

   403

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

   404

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

   405

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

   406

            keycode = event.GetKeyCode()

   407

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

   408

                if self.IsBlock(self.SelectedElement):

   409

                    self.SelectedElement.Delete()

   410

                elif self.IsWire(self.SelectedElement):

   411

                    self.DeleteWire(self.SelectedElement)

   412

                elif isinstance(self.SelectedElement, Graphic_Group):

   413

                    all_wires = True

   414

                    for element in self.SelectedElement.GetElements():

   415

                        all_wires &= self.IsWire(element)

   416

                    if all_wires:

   417

                        self.DeleteWire(self.SelectedElement)

   418

                    else:

   419

                        self.SelectedElement.Delete()

   420

                self.RefreshBuffer()

   421

                self.RefreshScrollBars()

   422

                self.Refresh(False)

   423

            elif keycode == wx.WXK_LEFT:

   424

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

   425

                    self.Scroll(0, ypos)

   426

                elif event.ControlDown():

   427

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

   428

            elif keycode == wx.WXK_RIGHT:

   429

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

   430

                    self.Scroll(xmax, ypos)

   431

                elif event.ControlDown():

   432

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

   433

            elif keycode == wx.WXK_UP:

   434

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

   435

                    self.Scroll(xpos, 0)

   436

                elif event.ControlDown():

   437

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

   438

            elif keycode == wx.WXK_DOWN:

   439

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

   440

                    self.Scroll(xpos, ymax)

   441

                elif event.ControlDown():

   442

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

   443

            else:

   444

                event.Skip()

   445

   446

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

   447

    #                  Model adding functions from Drop Target

   448

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

   449

   450

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

   451

        if var_type == "BOOL":

   452

            id = self.GetNewId()

   453

            if var_class == INPUT:

   454

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

   455

                width, height = contact.GetMinSize()

   456

                if scaling is not None:

   457

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

   458

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

   459

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

   460

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

   461

                contact.SetPosition(x, y)

   462

                contact.SetSize(width, height)

   463

                self.AddBlock(contact)

   464

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

   465

                self.RefreshContactModel(contact)

   466

            else:

   467

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

   468

                width, height = coil.GetMinSize()

   469

                if scaling is not None:

   470

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

   471

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

   472

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

   473

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

   474

                coil.SetPosition(x, y)

   475

                coil.SetSize(width, height)

   476

                self.AddBlock(coil)

   477

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

   478

                self.RefreshCoilModel(coil)

   479

            self.RefreshBuffer()

   480

            self.RefreshScrollBars()

   481

            self.RefreshVisibleElements()

   482

            self.Refresh(False)

   483

        else:

   484

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

   485

   486

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

   487

    #                          Adding element functions

   488

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

   489

   490

    def AddLadderRung(self):

   491

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

   492

        dialog.SetPreviewFont(self.GetFont())

   493

        varlist = []

   494

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

   495

        if vars:

   496

            for var in vars:

   497

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

   498

                    varlist.append(var.Name)

   499

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

   500

        if returntype == "BOOL":

   501

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

   502

        dialog.SetVariables(varlist)

   503

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

   504

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

   505

            values = dialog.GetValues()

   506

            startx, starty = LD_OFFSET[0], 0

   507

            if len(self.Rungs) > 0:

   508

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

   509

                starty = bbox.y + bbox.height

   510

            starty += LD_OFFSET[1]

   511

            rung = Graphic_Group(self)

   512

   513

            # Create comment

   514

            id = self.GetNewId()

   515

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

   516

            comment.SetPosition(startx, starty)

   517

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