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

    26

import wx

    27

    28

from editors.Viewer import *

    29

    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

    54

def CalcBranchSize(elements, stops):

    55

    branch_size = 0

    56

    stop_list = stops

    57

    for stop in stops:

    58

        ExtractNextBlocks(stop, stop_list)

    59

    element_tree = {}

    60

    for element in elements:

    61

        if element not in element_tree:

    62

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

    63

            GenerateTree(element, element_tree, stop_list)

    64

        elif element_tree[element]:

    65

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

    66

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

    67

    for element, values in list(element_tree.items()):

    68

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

    69

            removed = []

    70

            for child in values["children"]:

    71

                if child != "stop":

    72

                    # if child in elements:

    73

                    #     RemoveElement(child, element_tree)

    74

                    #     removed.append(child)

    75

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

    76

                        if element not in remove_stops["stop"]:

    77

                            remove_stops["stop"].append(element)

    78

                        if child not in remove_stops["start"]:

    79

                            remove_stops["start"].append(child)

    80

            for child in removed:

    81

                values["children"].remove(child)

    82

    for element in remove_stops["start"]:

    83

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

    84

    for element in remove_stops["stop"]:

    85

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

    86

    for element, values in list(element_tree.items()):

    87

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

    88

            CalcWeight(element, element_tree)

    89

            if values["weight"]:

    90

                branch_size += values["weight"]

    91

            else:

    92

                return 1

    93

    return branch_size

    94

    95

    96

def RemoveElement(remove, element_tree):

    97

    if remove in element_tree and element_tree[remove]:

    98

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

    99

            if child != "stop":

   100

                RemoveElement(child, element_tree)

   101

        element_tree.pop(remove)

   102

#        element_tree[remove] = None

   103

   104

   105

def GenerateTree(element, element_tree, stop_list):

   106

    if element in element_tree:

   107

        connectors = element.GetConnectors()

   108

        input_connectors = []

   109

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

   110

            input_connectors = connectors

   111

        else:

   112

            if "inputs" in connectors:

   113

                input_connectors = connectors["inputs"]

   114

            if "input" in connectors:

   115

                input_connectors = [connectors["input"]]

   116

        for connector in input_connectors:

   117

            for wire, _handle in connector.GetWires():

   118

                next = wire.EndConnected.GetParentBlock()

   119

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

   120

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

   121

                    #     RemoveElement(remove, element_tree)

   122

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

   123

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

   124

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

   125

                #     element_tree[next] = None

   126

                elif next not in element_tree or element_tree[next]:

   127

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

   128

                    if next in element_tree:

   129

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

   130

                    else:

   131

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

   132

                        GenerateTree(next, element_tree, stop_list)

   133

   134

   135

def CalcWeight(element, element_tree):

   136

    weight = 0

   137

    parts = None

   138

    if element in element_tree:

   139

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

   140

            if parent == "start":

   141

                weight += 1

   142

            elif parent in element_tree:

   143

                if not parts:

   144

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

   145

                else:

   146

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

   147

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

   148

                    CalcWeight(parent, element_tree)

   149

                if element_tree[parent]["weight"]:

   150

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

   151

                else:

   152

                    element_tree[element]["weight"] = None

   153

                    return

   154

            else:

   155

                element_tree[element]["weight"] = None

   156

                return

   157

        if not parts:

   158

            parts = 1

   159

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

   160

   161

   162

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

   163

#                     Ladder Diagram Graphic elements Viewer class

   164

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

   165

   166

   167

class LD_Viewer(Viewer):

   168

    """

   169

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

   170

    """

   171

   172

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

   173

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

   174

        self.Rungs = []

   175

        self.RungComments = []

   176

        self.CurrentLanguage = "LD"

   177

   178

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

   179

    #                          Refresh functions

   180

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

   181

   182

    def ResetView(self):

   183

        self.Rungs = []

   184

        self.RungComments = []

   185

        Viewer.ResetView(self)

   186

   187

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

   188

        Viewer.RefreshView(self, variablepanel, selection)

   189

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   190

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

   191

                bbox = rung.GetBoundingBox()

   192

                if i < len(self.RungComments):

   193

                    if self.RungComments[i]:

   194

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

   195

                        if pos[1] > bbox.y:

   196

                            self.RungComments.insert(i, None)

   197

                else:

   198

                    self.RungComments.insert(i, None)

   199

   200

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

   201

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

   202

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   203

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

   204

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

   205

                rung = Graphic_Group(self)

   206

                rung.SelectElement(element)

   207

                self.Rungs.append(rung)

   208

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

   209

                rungs = []

   210

                for connector in instance["inputs"]:

   211

                    for link in connector["links"]:

   212

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

   213

                        rung = self.FindRung(connected)

   214

                        if rung not in rungs:

   215

                            rungs.append(rung)

   216

                if len(rungs) > 1:

   217

                    raise ValueError(

   218

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

   219

                        % instance["id"])

   220

   221

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

   222

                element_connectors = element.GetConnectors()

   223

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

   224

                for connector in element_connectors["inputs"]:

   225

                    for wire, _num in connector.GetWires():

   226

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

   227

                wx.CallAfter(self.RefreshPosition, element)

   228

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

   229

                rungs = []

   230

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

   231

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

   232

                    rung = self.FindRung(connected)

   233

                    if rung not in rungs:

   234

                        rungs.append(rung)

   235

                if len(rungs) > 1:

   236

                    raise ValueError(

   237

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

   238

                        % instance["id"])

   239

   240

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

   241

                element_connectors = element.GetConnectors()

   242

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

   243

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

   244

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

   245

                wx.CallAfter(self.RefreshPosition, element)

   246

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

   247

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

   248

                pos = element.GetPosition()

   249

                i = 0

   250

                inserted = False

   251

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

   252

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

   253

                    if pos[1] < ipos[1]:

   254

                        self.RungComments.insert(i, element)

   255

                        inserted = True

   256

                    i += 1

   257

                if not inserted:

   258

                    self.RungComments.append(element)

   259

   260

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

   261

    #                          Search Element functions

   262

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

   263

   264

    def FindRung(self, element):

   265

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

   266

            if rung.IsElementIn(element):

   267

                return i

   268

        return None

   269

   270

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

   271

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   272

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

   273

   274

        dc = self.GetLogicalDC()

   275

        pos = event.GetLogicalPosition(dc)

   276

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

   277

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

   278

                return self.SelectedElement

   279

        elements = []

   280

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

   281

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

   282

                elements.append(element)

   283

        if len(elements) == 1:

   284

            return elements[0]

   285

        elif len(elements) > 1:

   286

            group = Graphic_Group(self)

   287

            for element in elements:

   288

                if self.IsBlock(element):

   289

                    return element

   290

                group.SelectElement(element)

   291

            return group

   292

        return None

   293

   294

    def SearchElements(self, bbox):

   295

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   296

            return Viewer.SearchElements(self, bbox)

   297

   298

        elements = []

   299

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

   300

            if element.IsInSelection(bbox):

   301

                elements.append(element)

   302

        return elements

   303

   304

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

   305

    #                          Mouse event functions

   306

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

   307

   308

    def OnViewerLeftDown(self, event):

   309

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   310

            Viewer.OnViewerLeftDown(self, event)

   311

        elif self.Mode == MODE_SELECTION:

   312

            element = self.FindElement(event)

   313

            if self.SelectedElement:

   314

                if not isinstance(self.SelectedElement, Graphic_Group):

   315

                    if self.SelectedElement != element:

   316

                        if self.IsWire(self.SelectedElement):

   317

                            self.SelectedElement.SetSelectedSegment(None)

   318

                        else:

   319

                            self.SelectedElement.SetSelected(False)

   320

                    else:

   321

                        self.SelectedElement = None

   322

                elif element and isinstance(element, Graphic_Group):

   323

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

   324

                        for elt in self.SelectedElement.GetElements():

   325

                            if self.IsWire(elt):

   326

                                elt.SetSelectedSegment(None)

   327

                        self.SelectedElement.SetSelected(False)

   328

                        self.SelectedElement = None

   329

                else:

   330

                    for elt in self.SelectedElement.GetElements():

   331

                        if self.IsWire(elt):

   332

                            elt.SetSelectedSegment(None)

   333

                    self.SelectedElement.SetSelected(False)

   334

                    self.SelectedElement = None

   335

            if element:

   336

                self.SelectedElement = element

   337

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

   338

                self.SelectedElement.Refresh()

   339

            else:

   340

                self.rubberBand.Reset()

   341

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

   342

        event.Skip()

   343

   344

    def OnViewerLeftUp(self, event):

   345

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   346

            Viewer.OnViewerLeftUp(self, event)

   347

        elif self.rubberBand.IsShown():

   348

            if self.Mode == MODE_SELECTION:

   349

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

   350

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

   351

                if len(elements) > 0:

   352

                    self.SelectedElement = Graphic_Group(self)

   353

                    self.SelectedElement.SetElements(elements)

   354

                    self.SelectedElement.SetSelected(True)

   355

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

   356

            dc = self.GetLogicalDC()

   357

            if not isinstance(self.SelectedElement, Graphic_Group):

   358

                if self.IsWire(self.SelectedElement):

   359

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

   360

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

   361

                        self.SelectedElement.SetSelectedSegment(result[0])

   362

                else:

   363

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

   364

            else:

   365

                for element in self.SelectedElement.GetElements():

   366

                    if self.IsWire(element):

   367

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

   368

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

   369

                            element.SetSelectedSegment(result[0])

   370

                    else:

   371

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

   372

            self.SelectedElement.Refresh()

   373

            wx.CallAfter(self.SetCurrentCursor, 0)

   374

        event.Skip()

   375

   376

    def OnViewerRightUp(self, event):

   377

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   378

            Viewer.OnViewerRightUp(self, event)

   379

        else:

   380

            element = self.FindElement(event)

   381

            if element:

   382

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

   383

                    self.SelectedElement.SetSelected(False)

   384

                self.SelectedElement = element

   385

                if self.IsWire(self.SelectedElement):

   386

                    self.SelectedElement.SetSelectedSegment(0)

   387

                else:

   388

                    self.SelectedElement.SetSelected(True)

   389

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

   390

                    self.SelectedElement.Refresh()

   391

                wx.CallAfter(self.SetCurrentCursor, 0)

   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(False)

   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

            else:

   443

                event.Skip()

   444

   445

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

   446

    #                  Model adding functions from Drop Target

   447

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

   448

   449

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

   450

        if var_type == "BOOL":

   451

            id = self.GetNewId()

   452

            if var_class == INPUT:

   453

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

   454

                width, height = contact.GetMinSize()

   455

                if scaling is not None:

   456

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

   457

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

   458

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

   459

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

   460

                contact.SetPosition(x, y)

   461

                contact.SetSize(width, height)

   462

                self.AddBlock(contact)

   463

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

   464

                self.RefreshContactModel(contact)

   465

            else:

   466

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

   467

                width, height = coil.GetMinSize()

   468

                if scaling is not None:

   469

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

   470

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

   471

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

   472

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

   473

                coil.SetPosition(x, y)

   474

                coil.SetSize(width, height)

   475

                self.AddBlock(coil)

   476

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

   477

                self.RefreshCoilModel(coil)

   478

            self.RefreshBuffer()

   479

            self.RefreshScrollBars()

   480

            self.RefreshVisibleElements()

   481

            self.Refresh(False)

   482

        else:

   483

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

   484

   485

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

   486

    #                          Adding element functions

   487

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

   488

   489

    def AddLadderRung(self):

   490

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

   491

        dialog.SetPreviewFont(self.GetFont())

   492

        varlist = []

   493

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

   494

        if vars:

   495

            for var in vars:

   496

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

   497

                    varlist.append(var.Name)

   498

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

   499

        if returntype == "BOOL":

   500

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

   501

        dialog.SetVariables(varlist)

   502

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

   503

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

   504

            values = dialog.GetValues()

   505

            startx, starty = LD_OFFSET[0], 0

   506

            if len(self.Rungs) > 0:

   507

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

   508

                starty = bbox.y + bbox.height

   509

            starty += LD_OFFSET[1]

   510

            rung = Graphic_Group(self)

   511

   512

            # Create comment

   513

            id = self.GetNewId()

   514

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

   515