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 types import *

    28

    29

import wx

    30

    31

from editors.Viewer import *

    32

    33

    34

def ExtractNextBlocks(block, block_list):

    35

    current_list = [block]

    36

    while len(current_list) > 0:

    37

        next_list = []

    38

        for current in current_list:

    39

            connectors = current.GetConnectors()

    40

            input_connectors = []

    41

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

    42

                input_connectors = connectors

    43

            else:

    44

                if "inputs" in connectors:

    45

                    input_connectors = connectors["inputs"]

    46

                if "input" in connectors:

    47

                    input_connectors = [connectors["input"]]

    48

            for connector in input_connectors:

    49

                for wire, _handle in connector.GetWires():

    50

                    next = wire.EndConnected.GetParentBlock()

    51

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

    52

                        block_list.append(next)

    53

                        next_list.append(next)

    54

        current_list = next_list

    55

    56

    57

def CalcBranchSize(elements, stops):

    58

    branch_size = 0

    59

    stop_list = stops

    60

    for stop in stops:

    61

        ExtractNextBlocks(stop, stop_list)

    62

    element_tree = {}

    63

    for element in elements:

    64

        if element not in element_tree:

    65

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

    66

            GenerateTree(element, element_tree, stop_list)

    67

        elif element_tree[element]:

    68

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

    69

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

    70

    for element, values in element_tree.items():

    71

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

    72

            removed = []

    73

            for child in values["children"]:

    74

                if child != "stop":

    75

                    # if child in elements:

    76

                    #     RemoveElement(child, element_tree)

    77

                    #     removed.append(child)

    78

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

    79

                        if element not in remove_stops["stop"]:

    80

                            remove_stops["stop"].append(element)

    81

                        if child not in remove_stops["start"]:

    82

                            remove_stops["start"].append(child)

    83

            for child in removed:

    84

                values["children"].remove(child)

    85

    for element in remove_stops["start"]:

    86

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

    87

    for element in remove_stops["stop"]:

    88

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

    89

    for element, values in element_tree.items():

    90

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

    91

            CalcWeight(element, element_tree)

    92

            if values["weight"]:

    93

                branch_size += values["weight"]

    94

            else:

    95

                return 1

    96

    return branch_size

    97

    98

    99

def RemoveElement(remove, element_tree):

   100

    if remove in element_tree and element_tree[remove]:

   101

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

   102

            if child != "stop":

   103

                RemoveElement(child, element_tree)

   104

        element_tree.pop(remove)

   105

#        element_tree[remove] = None

   106

   107

   108

def GenerateTree(element, element_tree, stop_list):

   109

    if element in element_tree:

   110

        connectors = element.GetConnectors()

   111

        input_connectors = []

   112

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

   113

            input_connectors = connectors

   114

        else:

   115

            if "inputs" in connectors:

   116

                input_connectors = connectors["inputs"]

   117

            if "input" in connectors:

   118

                input_connectors = [connectors["input"]]

   119

        for connector in input_connectors:

   120

            for wire, _handle in connector.GetWires():

   121

                next = wire.EndConnected.GetParentBlock()

   122

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

   123

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

   124

                    #     RemoveElement(remove, element_tree)

   125

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

   126

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

   127

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

   128

                #     element_tree[next] = None

   129

                elif next not in element_tree or element_tree[next]:

   130

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

   131

                    if next in element_tree:

   132

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

   133

                    else:

   134

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

   135

                        GenerateTree(next, element_tree, stop_list)

   136

   137

   138

def CalcWeight(element, element_tree):

   139

    weight = 0

   140

    parts = None

   141

    if element in element_tree:

   142

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

   143

            if parent == "start":

   144

                weight += 1

   145

            elif parent in element_tree:

   146

                if not parts:

   147

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

   148

                else:

   149

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

   150

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

   151

                    CalcWeight(parent, element_tree)

   152

                if element_tree[parent]["weight"]:

   153

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

   154

                else:

   155

                    element_tree[element]["weight"] = None

   156

                    return

   157

            else:

   158

                element_tree[element]["weight"] = None

   159

                return

   160

        if not parts:

   161

            parts = 1

   162

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

   163

   164

   165

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

   166

#                     Ladder Diagram Graphic elements Viewer class

   167

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

   168

   169

   170

class LD_Viewer(Viewer):

   171

    """

   172

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

   173

    """

   174

   175

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

   176

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

   177

        self.Rungs = []

   178

        self.RungComments = []

   179

        self.CurrentLanguage = "LD"

   180

   181

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

   182

    #                          Refresh functions

   183

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

   184

   185

    def ResetView(self):

   186

        self.Rungs = []

   187

        self.RungComments = []

   188

        Viewer.ResetView(self)

   189

   190

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

   191

        Viewer.RefreshView(self, variablepanel, selection)

   192

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   193

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

   194

                bbox = rung.GetBoundingBox()

   195

                if i < len(self.RungComments):

   196

                    if self.RungComments[i]:

   197

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

   198

                        if pos[1] > bbox.y:

   199

                            self.RungComments.insert(i, None)

   200

                else:

   201

                    self.RungComments.insert(i, None)

   202

   203

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

   204

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

   205

        if self.GetDrawingMode() != FREEDRAWING_MODE:

   206

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

   207

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

   208

                rung = Graphic_Group(self)

   209

                rung.SelectElement(element)

   210

                self.Rungs.append(rung)

   211

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

   212

                rungs = []

   213

                for connector in instance["inputs"]:

   214

                    for link in connector["links"]:

   215

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

   216

                        rung = self.FindRung(connected)

   217

                        if rung not in rungs:

   218

                            rungs.append(rung)

   219

                if len(rungs) > 1:

   220

                    raise ValueError(

   221

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

   222

                        % instance["id"])

   223

   224

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

   225

                element_connectors = element.GetConnectors()

   226

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

   227

                for connector in element_connectors["inputs"]:

   228

                    for wire, _num in connector.GetWires():

   229

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

   230

                wx.CallAfter(self.RefreshPosition, element)

   231

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

   232

                rungs = []

   233

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

   234

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

   235

                    rung = self.FindRung(connected)

   236

                    if rung not in rungs:

   237

                        rungs.append(rung)

   238

                if len(rungs) > 1:

   239

                    raise ValueError(

   240

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

   241

                        % instance["id"])

   242

   243

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

   244

                element_connectors = element.GetConnectors()

   245

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

   246

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

   247

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

   248

                wx.CallAfter(self.RefreshPosition, element)

   249

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

   250

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

   251

                pos = element.GetPosition()

   252

                i = 0

   253

                inserted = False

   254

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

   255

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

   256

                    if pos[1] < ipos[1]:

   257

                        self.RungComments.insert(i, element)

   258

                        inserted = True

   259

                    i += 1

   260

                if not inserted:

   261

                    self.RungComments.append(element)

   262

   263

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

   264

    #                          Search Element functions

   265

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

   266

   267

    def FindRung(self, element):

   268

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

   269

            if rung.IsElementIn(element):

   270

                return i

   271

        return None

   272

   273

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

   274

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   275

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

   276

   277

        dc = self.GetLogicalDC()

   278

        pos = event.GetLogicalPosition(dc)

   279

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

   280

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

   281

                return self.SelectedElement

   282

        elements = []

   283

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

   284

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

   285

                elements.append(element)

   286

        if len(elements) == 1:

   287

            return elements[0]

   288

        elif len(elements) > 1:

   289

            group = Graphic_Group(self)

   290

            for element in elements:

   291

                if self.IsBlock(element):

   292

                    return element

   293

                group.SelectElement(element)

   294

            return group

   295

        return None

   296

   297

    def SearchElements(self, bbox):

   298

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   299

            return Viewer.SearchElements(self, bbox)

   300

   301

        elements = []

   302

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

   303

            if element.IsInSelection(bbox):

   304

                elements.append(element)

   305

        return elements

   306

   307

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

   308

    #                          Mouse event functions

   309

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

   310

   311

    def OnViewerLeftDown(self, event):

   312

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   313

            Viewer.OnViewerLeftDown(self, event)

   314

        elif self.Mode == MODE_SELECTION:

   315

            element = self.FindElement(event)

   316

            if self.SelectedElement:

   317

                if not isinstance(self.SelectedElement, Graphic_Group):

   318

                    if self.SelectedElement != element:

   319

                        if self.IsWire(self.SelectedElement):

   320

                            self.SelectedElement.SetSelectedSegment(None)

   321

                        else:

   322

                            self.SelectedElement.SetSelected(False)

   323

                    else:

   324

                        self.SelectedElement = None

   325

                elif element and isinstance(element, Graphic_Group):

   326

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

   327

                        for elt in self.SelectedElement.GetElements():

   328

                            if self.IsWire(elt):

   329

                                elt.SetSelectedSegment(None)

   330

                        self.SelectedElement.SetSelected(False)

   331

                        self.SelectedElement = None

   332

                else:

   333

                    for elt in self.SelectedElement.GetElements():

   334

                        if self.IsWire(elt):

   335

                            elt.SetSelectedSegment(None)

   336

                    self.SelectedElement.SetSelected(False)

   337

                    self.SelectedElement = None

   338

            if element:

   339

                self.SelectedElement = element

   340

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

   341

                self.SelectedElement.Refresh()

   342

            else:

   343

                self.rubberBand.Reset()

   344

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

   345

        event.Skip()

   346

   347

    def OnViewerLeftUp(self, event):

   348

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   349

            Viewer.OnViewerLeftUp(self, event)

   350

        elif self.rubberBand.IsShown():

   351

            if self.Mode == MODE_SELECTION:

   352

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

   353

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

   354

                if len(elements) > 0:

   355

                    self.SelectedElement = Graphic_Group(self)

   356

                    self.SelectedElement.SetElements(elements)

   357

                    self.SelectedElement.SetSelected(True)

   358

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

   359

            dc = self.GetLogicalDC()

   360

            if not isinstance(self.SelectedElement, Graphic_Group):

   361

                if self.IsWire(self.SelectedElement):

   362

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

   363

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

   364

                        self.SelectedElement.SetSelectedSegment(result[0])

   365

                else:

   366

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

   367

            else:

   368

                for element in self.SelectedElement.GetElements():

   369

                    if self.IsWire(element):

   370

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

   371

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

   372

                            element.SetSelectedSegment(result[0])

   373

                    else:

   374

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

   375

            self.SelectedElement.Refresh()

   376

            wx.CallAfter(self.SetCurrentCursor, 0)

   377

        event.Skip()

   378

   379

    def OnViewerRightUp(self, event):

   380

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   381

            Viewer.OnViewerRightUp(self, event)

   382

        else:

   383

            element = self.FindElement(event)

   384

            if element:

   385

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

   386

                    self.SelectedElement.SetSelected(False)

   387

                self.SelectedElement = element

   388

                if self.IsWire(self.SelectedElement):

   389

                    self.SelectedElement.SetSelectedSegment(0)

   390

                else:

   391

                    self.SelectedElement.SetSelected(True)

   392

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

   393

                    self.SelectedElement.Refresh()

   394

                wx.CallAfter(self.SetCurrentCursor, 0)

   395

        event.Skip()

   396

   397

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

   398

    #                          Keyboard event functions

   399

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

   400

   401

    def OnChar(self, event):

   402

        if self.GetDrawingMode() == FREEDRAWING_MODE:

   403

            Viewer.OnChar(self, event)

   404

        else:

   405

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

   406

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

   407

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

   408

            keycode = event.GetKeyCode()

   409

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

   410

                if self.IsBlock(self.SelectedElement):

   411

                    self.SelectedElement.Delete()

   412

                elif self.IsWire(self.SelectedElement):

   413

                    self.DeleteWire(self.SelectedElement)

   414

                elif isinstance(self.SelectedElement, Graphic_Group):

   415

                    all_wires = True

   416

                    for element in self.SelectedElement.GetElements():

   417

                        all_wires &= self.IsWire(element)

   418

                    if all_wires:

   419

                        self.DeleteWire(self.SelectedElement)

   420

                    else:

   421

                        self.SelectedElement.Delete()

   422

                self.RefreshBuffer()

   423

                self.RefreshScrollBars()

   424

                self.Refresh(False)

   425

            elif keycode == wx.WXK_LEFT:

   426

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

   427

                    self.Scroll(0, ypos)

   428

                elif event.ControlDown():

   429

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

   430

            elif keycode == wx.WXK_RIGHT:

   431

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

   432

                    self.Scroll(xmax, ypos)

   433

                elif event.ControlDown():

   434

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

   435

            elif keycode == wx.WXK_UP:

   436

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

   437

                    self.Scroll(xpos, 0)

   438

                elif event.ControlDown():

   439

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

   440

            elif keycode == wx.WXK_DOWN:

   441

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

   442

                    self.Scroll(xpos, ymax)

   443

                elif event.ControlDown():

   444

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

   445

            else:

   446

                event.Skip()

   447

   448

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

   449

    #                  Model adding functions from Drop Target

   450

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

   451

   452

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

   453

        if var_type == "BOOL":

   454

            id = self.GetNewId()

   455

            if var_class == INPUT:

   456

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

   457

                width, height = contact.GetMinSize()

   458

                if scaling is not None:

   459

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

   460

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

   461

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

   462

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

   463

                contact.SetPosition(x, y)

   464

                contact.SetSize(width, height)

   465

                self.AddBlock(contact)

   466

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

   467

                self.RefreshContactModel(contact)

   468

            else:

   469

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

   470

                width, height = coil.GetMinSize()

   471

                if scaling is not None:

   472

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

   473

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

   474

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

   475

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

   476

                coil.SetPosition(x, y)

   477

                coil.SetSize(width, height)

   478

                self.AddBlock(coil)

   479

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

   480

                self.RefreshCoilModel(coil)

   481

            self.RefreshBuffer()

   482

            self.RefreshScrollBars()

   483

            self.RefreshVisibleElements()

   484

            self.Refresh(False)

   485

        else:

   486

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

   487

   488

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

   489

    #                          Adding element functions

   490

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

   491

   492

    def AddLadderRung(self):

   493

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

   494

        dialog.SetPreviewFont(self.GetFont())

   495

        varlist = []

   496

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

   497

        if vars:

   498

            for var in vars:

   499

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

   500

                    varlist.append(var.Name)

   501

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

   502

        if returntype == "BOOL":

   503

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

   504

        dialog.SetVariables(varlist)

   505

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

   506

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

   507

            values = dialog.GetValues()

   508

            startx, starty = LD_OFFSET[0], 0

   509

            if len(self.Rungs) > 0:

   510

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

   511

                starty = bbox.y + bbox.height

   512

            starty += LD_OFFSET[1]

   513

            rung = Graphic_Group(self)

   514

   515

            # Create comment

   516

            id = self.GetNewId()