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

from __future__ import absolute_import

    27

from __future__ import division

    29

    30

import wx

    31

from six.moves import xrange

    32

    33

from editors.Viewer import *

    34

    35

    36

def ExtractNextBlocks(block, block_list):

    37

    current_list = [block]

    38

    while len(current_list) > 0:

    39

        next_list = []

    40

        for current in current_list:

    41

            connectors = current.GetConnectors()

    42

            input_connectors = []

    43

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

    44

                input_connectors = connectors

    45

            else:

    46

                if "inputs" in connectors:

    47

                    input_connectors = connectors["inputs"]

    48

                if "input" in connectors:

    49

                    input_connectors = [connectors["input"]]

    50

            for connector in input_connectors:

    51

                for wire, _handle in connector.GetWires():

    52

                    next = wire.EndConnected.GetParentBlock()

    53

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

    54

                        block_list.append(next)

    55

                        next_list.append(next)

    56

        current_list = next_list

    57

    58

    59

def CalcBranchSize(elements, stops):

    60

    branch_size = 0

    61

    stop_list = stops

    62

    for stop in stops:

    63

        ExtractNextBlocks(stop, stop_list)

    64

    element_tree = {}

    65

    for element in elements:

    66

        if element not in element_tree:

    67

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

    68

            GenerateTree(element, element_tree, stop_list)

    69

        elif element_tree[element]:

    70

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

    71

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

    72

    for element, values in element_tree.items():

    73

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

    74

            removed = []

    75

            for child in values["children"]:

    76

                if child != "stop":

    77

                    # if child in elements:

    78

                    #     RemoveElement(child, element_tree)

    79

                    #     removed.append(child)

    80

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

    81

                        if element not in remove_stops["stop"]:

    82

                            remove_stops["stop"].append(element)

    83

                        if child not in remove_stops["start"]:

    84

                            remove_stops["start"].append(child)

    85

            for child in removed:

    86

                values["children"].remove(child)

    87

    for element in remove_stops["start"]:

    88

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

    89

    for element in remove_stops["stop"]:

    90

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

    91

    for element, values in element_tree.items():

    92

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

    93

            CalcWeight(element, element_tree)

    94

            if values["weight"]:

    95

                branch_size += values["weight"]

    96

            else:

    97

                return 1

    98

    return branch_size

    99

   100

   101

def RemoveElement(remove, element_tree):

   102

    if remove in element_tree and element_tree[remove]:

   103

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

   104

            if child != "stop":

   105

                RemoveElement(child, element_tree)

   106

        element_tree.pop(remove)

   107

#        element_tree[remove] = None

   108

   109

   110

def GenerateTree(element, element_tree, stop_list):

   111

    if element in element_tree:

   112

        connectors = element.GetConnectors()

   113

        input_connectors = []

   114

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

   115

            input_connectors = connectors

   116

        else:

   117

            if "inputs" in connectors:

   118

                input_connectors = connectors["inputs"]

   119

            if "input" in connectors:

   120

                input_connectors = [connectors["input"]]

   121

        for connector in input_connectors:

   122

            for wire, _handle in connector.GetWires():

   123

                next = wire.EndConnected.GetParentBlock()

   124

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

   125

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

   126

                    #     RemoveElement(remove, element_tree)

   127

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

   128

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

   129

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

   130

                #     element_tree[next] = None

   131

                elif next not in element_tree or element_tree[next]:

   132

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

   133

                    if next in element_tree:

   134

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

   135

                    else:

   136

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

   137

                        GenerateTree(next, element_tree, stop_list)

   138

   139

   140

def CalcWeight(element, element_tree):

   141

    weight = 0

   142

    parts = None

   143

    if element in element_tree:

   144

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

   145

            if parent == "start":

   146

                weight += 1

   147

            elif parent in element_tree:

   148

                if not parts:

   149

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

   150

                else:

   151

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

   152

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

   153

                    CalcWeight(parent, element_tree)

   154

                if element_tree[parent]["weight"]:

   155

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

   156

                else:

   157

                    element_tree[element]["weight"] = None

   158

                    return

   159

            else:

   160

                element_tree[element]["weight"] = None

   161

                return

   162

        if not parts:

   163

            parts = 1

   164

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

   165

   166

   167

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

   168

#                     Ladder Diagram Graphic elements Viewer class

   169

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

   170

   171

   172

class LD_Viewer(Viewer):

   173

    """

   174

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

   175

    """

   176

   177

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

   178

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

   179

        self.Rungs = []

   180

        self.RungComments = []

   181

        self.CurrentLanguage = "LD"

   182

   183

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

   184

    #                          Refresh functions

   185

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

   186

   187

    def ResetView(self):

   188

        self.Rungs = []

   189

        self.RungComments = []

   190

        Viewer.ResetView(self)

   191

   192

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

   193

        Viewer.RefreshView(self, variablepanel, selection)

   194

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   195

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

   196

                bbox = rung.GetBoundingBox()

   197

                if i < len(self.RungComments):

   198

                    if self.RungComments[i]:

   199

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

   200

                        if pos[1] > bbox.y:

   201

                            self.RungComments.insert(i, None)

   202

                else:

   203

                    self.RungComments.insert(i, None)

   204

   205

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

   206

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

   207

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   208

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

   209

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

   210

                rung = Graphic_Group(self)

   211

                rung.SelectElement(element)

   212

                self.Rungs.append(rung)

   213

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

   214

                rungs = []

   215

                for connector in instance["inputs"]:

   216

                    for link in connector["links"]:

   217

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

   218

                        rung = self.FindRung(connected)

   219

                        if rung not in rungs:

   220

                            rungs.append(rung)

   221

                if len(rungs) > 1:

   222

                    raise ValueError(

   223

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

   224

                        % instance["id"])

   225

   226

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

   227

                element_connectors = element.GetConnectors()

   228

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

   229

                for connector in element_connectors["inputs"]:

   230

                    for wire, _num in connector.GetWires():

   231

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

   232

                wx.CallAfter(self.RefreshPosition, element)

   233

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

   234

                rungs = []

   235

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

   236

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

   237

                    rung = self.FindRung(connected)

   238

                    if rung not in rungs:

   239

                        rungs.append(rung)

   240

                if len(rungs) > 1:

   241

                    raise ValueError(

   242

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

   243

                        % instance["id"])

   244

   245

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

   246

                element_connectors = element.GetConnectors()

   247

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

   248

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

   249

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

   250

                wx.CallAfter(self.RefreshPosition, element)

   251

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

   252

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

   253

                pos = element.GetPosition()

   254

                i = 0

   255

                inserted = False

   256

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

   257

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

   258

                    if pos[1] < ipos[1]:

   259

                        self.RungComments.insert(i, element)

   260

                        inserted = True

   261

                    i += 1

   262

                if not inserted:

   263

                    self.RungComments.append(element)

   264

   265

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

   266

    #                          Search Element functions

   267

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

   268

   269

    def FindRung(self, element):

   270

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

   271

            if rung.IsElementIn(element):

   272

                return i

   273

        return None

   274

   275

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

   276

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   277

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

   278

   279

        dc = self.GetLogicalDC()

   280

        pos = event.GetLogicalPosition(dc)

   281

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

   282

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

   283

                return self.SelectedElement

   284

        elements = []

   285

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

   286

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

   287

                elements.append(element)

   288

        if len(elements) == 1:

   289

            return elements[0]

   290

        elif len(elements) > 1:

   291

            group = Graphic_Group(self)

   292

            for element in elements:

   293

                if self.IsBlock(element):

   294

                    return element

   295

                group.SelectElement(element)

   296

            return group

   297

        return None

   298

   299

    def SearchElements(self, bbox):

   300

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   301

            return Viewer.SearchElements(self, bbox)

   302

   303

        elements = []

   304

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

   305

            if element.IsInSelection(bbox):

   306

                elements.append(element)

   307

        return elements

   308

   309

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

   310

    #                          Mouse event functions

   311

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

   312

   313

    def OnViewerLeftDown(self, event):

   314

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   315

            Viewer.OnViewerLeftDown(self, event)

   316

        elif self.Mode == MODE_SELECTION:

   317

            element = self.FindElement(event)

   318

            if self.SelectedElement:

   319

                if not isinstance(self.SelectedElement, Graphic_Group):

   320

                    if self.SelectedElement != element:

   321

                        if self.IsWire(self.SelectedElement):

   322

                            self.SelectedElement.SetSelectedSegment(None)

   323

                        else:

   324

                            self.SelectedElement.SetSelected(False)

   325

                    else:

   326

                        self.SelectedElement = None

   327

                elif element and isinstance(element, Graphic_Group):

   328

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

   329

                        for elt in self.SelectedElement.GetElements():

   330

                            if self.IsWire(elt):

   331

                                elt.SetSelectedSegment(None)

   332

                        self.SelectedElement.SetSelected(False)

   333

                        self.SelectedElement = None

   334

                else:

   335

                    for elt in self.SelectedElement.GetElements():

   336

                        if self.IsWire(elt):

   337

                            elt.SetSelectedSegment(None)

   338

                    self.SelectedElement.SetSelected(False)

   339

                    self.SelectedElement = None

   340

            if element:

   341

                self.SelectedElement = element

   342

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

   343

                self.SelectedElement.Refresh()

   344

            else:

   345

                self.rubberBand.Reset()

   346

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

   347

        event.Skip()

   348

   349

    def OnViewerLeftUp(self, event):

   350

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   351

            Viewer.OnViewerLeftUp(self, event)

   352

        elif self.rubberBand.IsShown():

   353

            if self.Mode == MODE_SELECTION:

   354

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

   355

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

   356

                if len(elements) > 0:

   357

                    self.SelectedElement = Graphic_Group(self)

   358

                    self.SelectedElement.SetElements(elements)

   359

                    self.SelectedElement.SetSelected(True)

   360

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

   361

            dc = self.GetLogicalDC()

   362

            if not isinstance(self.SelectedElement, Graphic_Group):

   363

                if self.IsWire(self.SelectedElement):

   364

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

   365

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

   366

                        self.SelectedElement.SetSelectedSegment(result[0])

   367

                else:

   368

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

   369

            else:

   370

                for element in self.SelectedElement.GetElements():

   371

                    if self.IsWire(element):

   372

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

   373

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

   374

                            element.SetSelectedSegment(result[0])

   375

                    else:

   376

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

   377

            self.SelectedElement.Refresh()

   378

            wx.CallAfter(self.SetCurrentCursor, 0)

   379

        event.Skip()

   380

   381

    def OnViewerRightUp(self, event):

   382

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   383

            Viewer.OnViewerRightUp(self, event)

   384

        else:

   385

            element = self.FindElement(event)

   386

            if element:

   387

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

   388

                    self.SelectedElement.SetSelected(False)

   389

                self.SelectedElement = element

   390

                if self.IsWire(self.SelectedElement):

   391

                    self.SelectedElement.SetSelectedSegment(0)

   392

                else:

   393

                    self.SelectedElement.SetSelected(True)

   394

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

   395

                    self.SelectedElement.Refresh()

   396

                wx.CallAfter(self.SetCurrentCursor, 0)

   397

        event.Skip()

   398

   399

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

   400

    #                          Keyboard event functions

   401

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

   402

   403

    def OnChar(self, event):

   404

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   405

            Viewer.OnChar(self, event)

   406

        else:

   407

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

   408

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

   409

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

   410

            keycode = event.GetKeyCode()

   411

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

   412

                if self.IsBlock(self.SelectedElement):

   413

                    self.SelectedElement.Delete()

   414

                elif self.IsWire(self.SelectedElement):

   415

                    self.DeleteWire(self.SelectedElement)

   416

                elif isinstance(self.SelectedElement, Graphic_Group):

   417

                    all_wires = True

   418

                    for element in self.SelectedElement.GetElements():

   419

                        all_wires &= self.IsWire(element)

   420

                    if all_wires:

   421

                        self.DeleteWire(self.SelectedElement)

   422

                    else:

   423

                        self.SelectedElement.Delete()

   424

                self.RefreshBuffer()

   425

                self.RefreshScrollBars()

   426

                self.Refresh(False)

   427

            elif keycode == wx.WXK_LEFT:

   428

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

   429

                    self.Scroll(0, ypos)

   430

                elif event.ControlDown():

   431

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

   432

            elif keycode == wx.WXK_RIGHT:

   433

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

   434

                    self.Scroll(xmax, ypos)

   435

                elif event.ControlDown():

   436

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

   437

            elif keycode == wx.WXK_UP:

   438

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

   439

                    self.Scroll(xpos, 0)

   440

                elif event.ControlDown():

   441

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

   442

            elif keycode == wx.WXK_DOWN:

   443

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

   444

                    self.Scroll(xpos, ymax)

   445

                elif event.ControlDown():

   446

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

   447

            else:

   448

                event.Skip()

   449

   450

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

   451

    #                  Model adding functions from Drop Target

   452

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

   453

   454

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

   455

        if var_type == "BOOL":

   456

            id = self.GetNewId()

   457

            if var_class == INPUT:

   458

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

   459

                width, height = contact.GetMinSize()

   460

                if scaling is not None:

   461

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

   462

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

   463

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

   464

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

   465

                contact.SetPosition(x, y)

   466

                contact.SetSize(width, height)

   467

                self.AddBlock(contact)

   468

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

   469

                self.RefreshContactModel(contact)

   470

            else:

   471

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

   472

                width, height = coil.GetMinSize()

   473

                if scaling is not None:

   474

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

   475

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

   476

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

   477

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

   478

                coil.SetPosition(x, y)

   479

                coil.SetSize(width, height)

   480

                self.AddBlock(coil)

   481

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

   482

                self.RefreshCoilModel(coil)

   483

            self.RefreshBuffer()

   484

            self.RefreshScrollBars()

   485

            self.RefreshVisibleElements()

   486

            self.Refresh(False)

   487

        else:

   488

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

   489

   490

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

   491

    #                          Adding element functions

   492

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

   493

   494

    def AddLadderRung(self):

   495

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

   496

        dialog.SetPreviewFont(self.GetFont())

   497

        varlist = []

   498

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

   499

        if vars:

   500

            for var in vars:

   501

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

   502

                    varlist.append(var.Name)

   503

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

   504

        if returntype == "BOOL":

   505

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

   506

        dialog.SetVariables(varlist)

   507

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

   508

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

   509

            values = dialog.GetValues()

   510

            startx, starty = LD_OFFSET[0], 0

   511

            if len(self.Rungs) > 0:

   512

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

   513

                starty = bbox.y + bbox.height

   514

            starty += LD_OFFSET[1]