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

    28

import wx

    29

from future.builtins import round

    30

from six.moves import xrange

    31

    32

from graphics.GraphicCommons import *

    33

from graphics.DebugDataConsumer import DebugDataConsumer

    34

from plcopen.structures import *

    35

    36

    37

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

    38

#                         Ladder Diagram PowerRail

    39

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

    40

    41

    42

class LD_PowerRail(Graphic_Element):

    43

    """

    44

    Class that implements the graphic representation of a power rail

    45

    """

    46

    47

    # Create a new power rail

    48

    def __init__(self, parent, type, id=None, connectors=1):

    49

        Graphic_Element.__init__(self, parent)

    50

        self.Type = None

    51

        self.Connectors = []

    52

        self.RealConnectors = None

    53

        self.Id = id

    54

        self.Extensions = [LD_LINE_SIZE // 2, LD_LINE_SIZE // 2]

    55

        self.SetType(type, connectors)

    56

    57

    def Flush(self):

    58

        for connector in self.Connectors:

    59

            connector.Flush()

    60

        self.Connectors = []

    61

    62

    # Make a clone of this LD_PowerRail

    63

    def Clone(self, parent, id=None, pos=None):

    64

        powerrail = LD_PowerRail(parent, self.Type, id)

    65

        powerrail.SetSize(self.Size[0], self.Size[1])

    66

        if pos is not None:

    67

            powerrail.SetPosition(pos.x, pos.y)

    68

        else:

    69

            powerrail.SetPosition(self.Pos.x, self.Pos.y)

    70

        powerrail.Connectors = []

    71

        for connector in self.Connectors:

    72

            powerrail.Connectors.append(connector.Clone(powerrail))

    73

        return powerrail

    74

    75

    def GetConnectorTranslation(self, element):

    76

        return dict(zip([connector for connector in self.Connectors],

    77

                        [connector for connector in element.Connectors]))

    78

    79

    # Returns the RedrawRect

    80

    def GetRedrawRect(self, movex=0, movey=0):

    81

        rect = Graphic_Element.GetRedrawRect(self, movex, movey)

    82

        for connector in self.Connectors:

    83

            rect = rect.Union(connector.GetRedrawRect(movex, movey))

    84

        if movex != 0 or movey != 0:

    85

            for connector in self.Connectors:

    86

                if connector.IsConnected():

    87

                    rect = rect.Union(connector.GetConnectedRedrawRect(movex, movey))

    88

        return rect

    89

    90

    # Forbids to change the power rail size

    91

    def SetSize(self, width, height):

    92

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

    93

            Graphic_Element.SetSize(self, width, height)

    94

        else:

    95

            Graphic_Element.SetSize(self, LD_POWERRAIL_WIDTH, height)

    96

        self.RefreshConnectors()

    97

    98

    # Forbids to select a power rail

    99

    def HitTest(self, pt, connectors=True):

   100

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   101

            return Graphic_Element.HitTest(self, pt, connectors) or self.TestConnector(pt, exclude=False) is not None

   102

        return False

   103

   104

    # Forbids to select a power rail

   105

    def IsInSelection(self, rect):

   106

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   107

            return Graphic_Element.IsInSelection(self, rect)

   108

        return False

   109

   110

    # Deletes this power rail by calling the appropriate method

   111

    def Delete(self):

   112

        self.Parent.DeletePowerRail(self)

   113

   114

    # Unconnect all connectors

   115

    def Clean(self):

   116

        for connector in self.Connectors:

   117

            connector.UnConnect(delete=self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

   118

   119

    # Refresh the power rail bounding box

   120

    def RefreshBoundingBox(self):

   121

        self.BoundingBox = wx.Rect(self.Pos.x, self.Pos.y, self.Size[0] + 1, self.Size[1] + 1)

   122

   123

    # Refresh the power rail size

   124

    def RefreshSize(self):

   125

        self.Size = wx.Size(LD_POWERRAIL_WIDTH, max(LD_LINE_SIZE * len(self.Connectors), self.Size[1]))

   126

        self.RefreshBoundingBox()

   127

   128

    # Returns the block minimum size

   129

    def GetMinSize(self, default=False):

   130

        height = (LD_LINE_SIZE * (len(self.Connectors) - 1)

   131

                  if default else 0)

   132

        return LD_POWERRAIL_WIDTH, height + self.Extensions[0] + self.Extensions[1]

   133

   134

    # Add a connector or a blank to this power rail at the last place

   135

    def AddConnector(self):

   136

        self.InsertConnector(len(self.Connectors))

   137

   138

    # Add a connector or a blank to this power rail at the place given

   139

    def InsertConnector(self, idx):

   140

        if self.Type == LEFTRAIL:

   141

            connector = Connector(self, "", "BOOL", wx.Point(self.Size[0], 0), EAST)

   142

        elif self.Type == RIGHTRAIL:

   143

            connector = Connector(self, "", "BOOL", wx.Point(0, 0), WEST)

   144

        self.Connectors.insert(idx, connector)

   145

        self.RefreshSize()

   146

        self.RefreshConnectors()

   147

   148

    # Moves the divergence connector given

   149

    def MoveConnector(self, connector, movey):

   150

        position = connector.GetRelPosition()

   151

        connector.SetPosition(wx.Point(position.x, position.y + movey))

   152

        miny = self.Size[1]

   153

        maxy = 0

   154

        for connect in self.Connectors:

   155

            connect_pos = connect.GetRelPosition()

   156

            miny = min(miny, connect_pos.y - self.Extensions[0])

   157

            maxy = max(maxy, connect_pos.y - self.Extensions[0])

   158

        min_pos = self.Pos.y + miny

   159

        self.Pos.y = min(min_pos, self.Pos.y)

   160

        if min_pos == self.Pos.y:

   161

            for connect in self.Connectors:

   162

                connect_pos = connect.GetRelPosition()

   163

                connect.SetPosition(wx.Point(connect_pos.x, connect_pos.y - miny))

   164

        self.Connectors.sort(lambda x, y: cmp(x.Pos.y, y.Pos.y))

   165

        maxy = 0

   166

        for connect in self.Connectors:

   167

            connect_pos = connect.GetRelPosition()

   168

            maxy = max(maxy, connect_pos.y)

   169

        self.Size[1] = max(maxy + self.Extensions[1], self.Size[1])

   170

        connector.MoveConnected()

   171

        self.RefreshBoundingBox()

   172

   173

    # Returns the index in connectors list for the connector given

   174

    def GetConnectorIndex(self, connector):

   175

        if connector in self.Connectors:

   176

            return self.Connectors.index(connector)

   177

        return None

   178

   179

    # Delete the connector or blank from connectors list at the index given

   180

    def DeleteConnector(self, idx):

   181

        self.Connectors.pop(idx)

   182

        self.RefreshConnectors()

   183

        self.RefreshSize()

   184

   185

    # Refresh the positions of the power rail connectors

   186

    def RefreshConnectors(self):

   187

        scaling = self.Parent.GetScaling()

   188

        height = self.Size[1] - self.Extensions[0] - self.Extensions[1]

   189

        interval = height / max(len(self.Connectors) - 1, 1)

   190

        for i, connector in enumerate(self.Connectors):

   191

            if self.RealConnectors:

   192

                position = self.Extensions[0] + int(round(self.RealConnectors[i] * height))

   193

            else:

   194

                position = self.Extensions[0] + int(round(i * interval))

   195

            if scaling is not None:

   196

                position = round((self.Pos.y + position) / scaling[1]) * scaling[1] - self.Pos.y

   197

            if self.Type == LEFTRAIL:

   198

                connector.SetPosition(wx.Point(self.Size[0], position))

   199

            elif self.Type == RIGHTRAIL:

   200

                connector.SetPosition(wx.Point(0, position))

   201

        self.RefreshConnected()

   202

   203

    # Refresh the position of wires connected to power rail

   204

    def RefreshConnected(self, exclude=None):

   205

        for connector in self.Connectors:

   206

            connector.MoveConnected(exclude)

   207

   208

    # Returns the power rail connector that starts with the point given if it exists

   209

    def GetConnector(self, position, name=None):

   210

        # if a name is given

   211

        if name is not None:

   212

            # Test each connector if it exists

   213

            for connector in self.Connectors:

   214

                if name == connector.GetName():

   215

                    return connector

   216

        return self.FindNearestConnector(position, [connector for connector in self.Connectors if connector is not None])

   217

   218

    # Returns all the power rail connectors

   219

    def GetConnectors(self):

   220

        connectors = [connector for connector in self.Connectors if connector]

   221

        if self.Type == LEFTRAIL:

   222

            return {"inputs": [], "outputs": connectors}

   223

        else:

   224

            return {"inputs": connectors, "outputs": []}

   225

   226

    # Test if point given is on one of the power rail connectors

   227

    def TestConnector(self, pt, direction=None, exclude=True):

   228

        for connector in self.Connectors:

   229

            if connector.TestPoint(pt, direction, exclude):

   230

                return connector

   231

        return None

   232

   233

    # Returns the power rail type

   234

    def SetType(self, type, connectors):

   235

        if type != self.Type or len(self.Connectors) != connectors:

   236

            # Create a connector or a blank according to 'connectors' and add it in

   237

            # the connectors list

   238

            self.Type = type

   239

            self.Clean()

   240

            self.Connectors = []

   241

            for dummy in xrange(connectors):

   242

                self.AddConnector()

   243

            self.RefreshSize()

   244

   245

    # Returns the power rail type

   246

    def GetType(self):

   247

        return self.Type

   248

   249

    # Method called when a LeftDown event have been generated

   250

    def OnLeftDown(self, event, dc, scaling):

   251

        self.RealConnectors = []

   252

        height = self.Size[1] - self.Extensions[0] - self.Extensions[1]

   253

        if height > 0:

   254

            for connector in self.Connectors:

   255

                position = connector.GetRelPosition()

   256

                self.RealConnectors.append(max(0., min((position.y - self.Extensions[0]) / height, 1.)))

   257

        elif len(self.Connectors) > 1:

   258

            self.RealConnectors = map(lambda x: x * 1 / (len(self.Connectors) - 1), xrange(len(self.Connectors)))

   259

        else:

   260

            self.RealConnectors = [0.5]

   261

        Graphic_Element.OnLeftDown(self, event, dc, scaling)

   262

   263

    # Method called when a LeftUp event have been generated

   264

    def OnLeftUp(self, event, dc, scaling):

   265

        Graphic_Element.OnLeftUp(self, event, dc, scaling)

   266

        self.RealConnectors = None

   267

   268

    # Method called when a LeftDown event have been generated

   269

    def OnRightDown(self, event, dc, scaling):

   270

        pos = GetScaledEventPosition(event, dc, scaling)

   271

        # Test if a connector have been handled

   272

        connector = self.TestConnector(pos, exclude=False)

   273

        if connector:

   274

            self.Handle = (HANDLE_CONNECTOR, connector)

   275

            wx.CallAfter(self.Parent.SetCurrentCursor, 1)

   276

            self.Selected = False

   277

            # Initializes the last position

   278

            self.oldPos = GetScaledEventPosition(event, dc, scaling)

   279

        else:

   280

            Graphic_Element.OnRightDown(self, event, dc, scaling)

   281

   282

    # Method called when a LeftDClick event have been generated

   283

    def OnLeftDClick(self, event, dc, scaling):

   284

        # Edit the powerrail properties

   285

        self.Parent.EditPowerRailContent(self)

   286

   287

    # Method called when a RightUp event have been generated

   288

    def OnRightUp(self, event, dc, scaling):

   289

        handle_type, handle = self.Handle

   290

        if handle_type == HANDLE_CONNECTOR and self.Dragging and self.oldPos:

   291

            wires = handle.GetWires()

   292

            if len(wires) == 1:

   293

                if handle == wires[0][0].StartConnected:

   294

                    block = wires[0][0].EndConnected.GetParentBlock()

   295

                else:

   296

                    block = wires[0][0].StartConnected.GetParentBlock()

   297

                block.RefreshModel(False)

   298

            Graphic_Element.OnRightUp(self, event, dc, scaling)

   299

        else:

   300

            self.Parent.PopupDefaultMenu()

   301

   302

    def Resize(self, x, y, width, height):

   303

        self.Move(x, y)

   304

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   305

            self.SetSize(width, height)

   306

        else:

   307

            self.SetSize(LD_POWERRAIL_WIDTH, height)

   308

   309

    # Refreshes the powerrail state according to move defined and handle selected

   310

    def ProcessDragging(self, movex, movey, event, scaling):

   311

        handle_type, handle = self.Handle

   312

        # A connector has been handled

   313

        if handle_type == HANDLE_CONNECTOR:

   314

            movey = max(-self.BoundingBox.y, movey)

   315

            if scaling is not None:

   316

                position = handle.GetRelPosition()

   317

                movey = round((self.Pos.y + position.y + movey) / scaling[1]) * scaling[1] - self.Pos.y - position.y

   318

            self.MoveConnector(handle, movey)

   319

            return 0, movey

   320

        elif self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   321

            return Graphic_Element.ProcessDragging(self, movex, movey, event, scaling)

   322

        return 0, 0

   323

   324

    # Refreshes the power rail model

   325

    def RefreshModel(self, move=True):

   326

        self.Parent.RefreshPowerRailModel(self)

   327

        # If power rail has moved and power rail is of type LEFT, refresh the model

   328

        # of wires connected to connectors

   329

        if move and self.Type == LEFTRAIL:

   330

            for connector in self.Connectors:

   331

                connector.RefreshWires()

   332

   333

    # Draws power rail

   334

    def Draw(self, dc):

   335

        Graphic_Element.Draw(self, dc)

   336

        dc.SetPen(MiterPen(wx.BLACK))

   337

        dc.SetBrush(wx.BLACK_BRUSH)

   338

        # Draw a rectangle with the power rail size

   339

        if self.Type == LEFTRAIL:

   340

            dc.DrawRectangle(self.Pos.x + self.Size[0] - LD_POWERRAIL_WIDTH, self.Pos.y, LD_POWERRAIL_WIDTH + 1, self.Size[1] + 1)

   341

        else:

   342

            dc.DrawRectangle(self.Pos.x, self.Pos.y, LD_POWERRAIL_WIDTH + 1, self.Size[1] + 1)

   343

        # Draw connectors

   344

        for connector in self.Connectors:

   345

            connector.Draw(dc)

   346

   347

   348

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

   349

#                         Ladder Diagram Contact

   350

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

   351

   352

   353

class LD_Contact(Graphic_Element, DebugDataConsumer):

   354

    """

   355

    Class that implements the graphic representation of a contact

   356

    """

   357

   358

    # Create a new contact

   359

    def __init__(self, parent, type, name, id=None):

   360

        Graphic_Element.__init__(self, parent)

   361

        DebugDataConsumer.__init__(self)

   362

        self.Type = type

   363

        self.Name = name

   364

        self.Id = id

   365

        self.Size = wx.Size(LD_ELEMENT_SIZE[0], LD_ELEMENT_SIZE[1])

   366

        self.Highlights = {}

   367

        # Create an input and output connector

   368

        self.Input = Connector(self, "", "BOOL", wx.Point(0, self.Size[1] // 2 + 1), WEST)

   369

        self.Output = Connector(self, "", "BOOL", wx.Point(self.Size[0], self.Size[1] // 2 + 1), EAST)

   370

        self.PreviousValue = False

   371

        self.PreviousSpreading = False

   372

        self.RefreshNameSize()

   373

        self.RefreshTypeSize()

   374

   375

    def Flush(self):

   376

        if self.Input is not None:

   377

            self.Input.Flush()

   378

            self.Input = None

   379

        if self.Output is not None:

   380

            self.Output.Flush()

   381

            self.Output = None

   382

   383

    def SetForced(self, forced):

   384

        if self.Forced != forced:

   385

            self.Forced = forced

   386

            if self.Visible:

   387

                self.Parent.ElementNeedRefresh(self)

   388

   389

    def SetValue(self, value):

   390

        if self.Type == CONTACT_RISING:

   391

            refresh = self.Value and not self.PreviousValue

   392

        elif self.Type == CONTACT_FALLING:

   393

            refresh = not self.Value and self.PreviousValue

   394

        else:

   395

            refresh = False

   396

        self.PreviousValue = self.Value

   397

        self.Value = value

   398

        if self.Value != self.PreviousValue or refresh:

   399

            if self.Visible:

   400

                self.Parent.ElementNeedRefresh(self)

   401

            self.SpreadCurrent()

   402

   403

    def SpreadCurrent(self):

   404

        if self.Parent.Debug:

   405

            if self.Value is None:

   406

                self.Value = False

   407

            spreading = self.Input.ReceivingCurrent()

   408

            if self.Type == CONTACT_NORMAL:

   409

                spreading &= self.Value

   410

            elif self.Type == CONTACT_REVERSE:

   411

                spreading &= not self.Value

   412

            elif self.Type == CONTACT_RISING:

   413

                spreading &= self.Value and not self.PreviousValue

   414

            elif self.Type == CONTACT_FALLING:

   415

                spreading &= not self.Value and self.PreviousValue

   416

            else:

   417

                spreading = False

   418

            if spreading and not self.PreviousSpreading:

   419

                self.Output.SpreadCurrent(True)

   420

            elif not spreading and self.PreviousSpreading:

   421

                self.Output.SpreadCurrent(False)

   422

            self.PreviousSpreading = spreading

   423

   424

    # Make a clone of this LD_Contact

   425

    def Clone(self, parent, id=None, pos=None):

   426

        contact = LD_Contact(parent, self.Type, self.Name, id)

   427

        contact.SetSize(self.Size[0], self.Size[1])

   428

        if pos is not None:

   429

            contact.SetPosition(pos.x, pos.y)

   430

        else:

   431

            contact.SetPosition(self.Pos.x, self.Pos.y)

   432

        contact.Input = self.Input.Clone(contact)

   433

        contact.Output = self.Output.Clone(contact)

   434

        return contact

   435

   436

    def GetConnectorTranslation(self, element):

   437

        return {self.Input: element.Input, self.Output: element.Output}

   438

   439

    # Returns the RedrawRect

   440

    def GetRedrawRect(self, movex=0, movey=0):

   441

        rect = Graphic_Element.GetRedrawRect(self, movex, movey)

   442

        rect = rect.Union(self.Input.GetRedrawRect(movex, movey))

   443

        rect = rect.Union(self.Output.GetRedrawRect(movex, movey))

   444

        if movex != 0 or movey != 0:

   445

            if self.Input.IsConnected():

   446

                rect = rect.Union(self.Input.GetConnectedRedrawRect(movex, movey))

   447

            if self.Output.IsConnected():

   448

                rect = rect.Union(self.Output.GetConnectedRedrawRect(movex, movey))

   449

        return rect

   450

   451

    def ProcessDragging(self, movex, movey, event, scaling):

   452

        if self.Parent.GetDrawingMode() != FREEDRAWING_MODE:

   453

            movex = movey = 0

   454

        return Graphic_Element.ProcessDragging(self, movex, movey, event, scaling, height_fac=2)

   455

   456

    # Forbids to change the contact size

   457

    def SetSize(self, width, height):

   458

        if self.Parent.GetDrawingMode() == FREEDRAWING_MODE:

   459

            Graphic_Element.SetSize(self, width, height)

   460

            self.RefreshConnectors()

   461

   462

    # Delete this contact by calling the appropriate method

   463

    def Delete(self):

   464

        self.Parent.DeleteContact(self)

   465

   466

    # Unconnect input and output

   467

    def Clean(self):

   468

        self.Input.UnConnect(delete=self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

   469

        self.Output.UnConnect(delete=self.Parent.GetDrawingMode() == FREEDRAWING_MODE)

   470

   471

    # Refresh the size of text for name

   472

    def RefreshNameSize(self):

   473

        if self.Name != "":

   474

            self.NameSize = self.Parent.GetTextExtent(self.Name)

   475

        else:

   476

            self.NameSize = 0, 0

   477

   478

    # Refresh the size of text for type

   479

    def RefreshTypeSize(self):

   480

        typetext = ""

   481

        if self.Type == CONTACT_REVERSE:

   482

            typetext = "/"

   483

        elif self.Type == CONTACT_RISING:

   484

            typetext = "P"

   485

        elif self.Type == CONTACT_FALLING:

   486

            typetext = "N"

   487

        if typetext != "":

   488

            self.TypeSize = self.Parent.GetTextExtent(typetext)

   489

        else:

   490

            self.TypeSize = 0, 0

   491

   492

    # Refresh the contact bounding box

   493

    def RefreshBoundingBox(self):

   494

        # Calculate the size of the name outside the contact

   495

        text_width, text_height = self.Parent.GetTextExtent(self.Name)

   496

        # Calculate the bounding box size

   497

        if self.Name != "":

   498

            bbx_x = self.Pos.x - max(0, (text_width - self.Size[0]) // 2)

   499

            bbx_width = max(self.Size[0], text_width)

   500

            bbx_y = self.Pos.y - (text_height + 2)

   501

            bbx_height = self.Size[1] + (text_height + 2)

   502

        else:

   503

            bbx_x = self.Pos.x

   504

            bbx_width = self.Size[0]

   505

            bbx_y = self.Pos.y

   506

            bbx_height = self.Size[1]

   507

        self.BoundingBox = wx.Rect(bbx_x, bbx_y, bbx_width + 1, bbx_height + 1)

   508

   509

    # Returns the block minimum size

   510

    def GetMinSize(self):