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 six.moves import xrange

    30

    31

from graphics.GraphicCommons import *

    32

from graphics.DebugDataConsumer import DebugDataConsumer

    33

from plcopen.structures import *

    34

    35

    36

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

    37

#                         Ladder Diagram PowerRail

    38

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

    39

    40

    41

class LD_PowerRail(Graphic_Element):

    42

    """

    43

    Class that implements the graphic representation of a power rail

    44

    """

    45

    46

    # Create a new power rail

    47

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

    48

        Graphic_Element.__init__(self, parent)

    49

        self.Type = None

    50

        self.Connectors = []

    51

        self.RealConnectors = None

    52

        self.Id = id

    53

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

    54

        self.SetType(type, connectors)

    55

    56

    def Flush(self):

    57

        for connector in self.Connectors:

    58

            connector.Flush()

    59

        self.Connectors = []

    60

    61

    # Make a clone of this LD_PowerRail

    62

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

    63

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

    64

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

    65

        if pos is not None:

    66

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

    67

        else:

    68

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

    69

        powerrail.Connectors = []

    70

        for connector in self.Connectors:

    71

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

    72

        return powerrail

    73

    74

    def GetConnectorTranslation(self, element):

    75

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

    76

                        [connector for connector in element.Connectors]))

    77

    78

    # Returns the RedrawRect

    79

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

    80

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

    81

        for connector in self.Connectors:

    82

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

    83

        if movex != 0 or movey != 0:

    84

            for connector in self.Connectors:

    85

                if connector.IsConnected():

    86

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

    87

        return rect

    88

    89

    # Forbids to change the power rail size

    90

    def SetSize(self, width, height):

    91

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

    92

            Graphic_Element.SetSize(self, width, height)

    93

        else:

    94

            Graphic_Element.SetSize(self, LD_POWERRAIL_WIDTH, height)

    95

        self.RefreshConnectors()

    96

    97

    # Forbids to select a power rail

    98

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

    99

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

   100

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

   101

        return False

   102

   103

    # Forbids to select a power rail

   104

    def IsInSelection(self, rect):

   105

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

   106

            return Graphic_Element.IsInSelection(self, rect)

   107

        return False

   108

   109

    # Deletes this power rail by calling the appropriate method

   110

    def Delete(self):

   111

        self.Parent.DeletePowerRail(self)

   112

   113

    # Unconnect all connectors

   114

    def Clean(self):

   115

        for connector in self.Connectors:

   116

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

   117

   118

    # Refresh the power rail bounding box

   119

    def RefreshBoundingBox(self):

   120

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

   121

   122

    # Refresh the power rail size

   123

    def RefreshSize(self):

   124

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

   125

        self.RefreshBoundingBox()

   126

   127

    # Returns the block minimum size

   128

    def GetMinSize(self, default=False):

   129

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

   130

                  if default else 0)

   131

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

   132

   133

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

   134

    def AddConnector(self):

   135

        self.InsertConnector(len(self.Connectors))

   136

   137

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

   138

    def InsertConnector(self, idx):

   139

        if self.Type == LEFTRAIL:

   140

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

   141

        elif self.Type == RIGHTRAIL:

   142

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

   143

        self.Connectors.insert(idx, connector)

   144

        self.RefreshSize()

   145

        self.RefreshConnectors()

   146

   147

    # Moves the divergence connector given

   148

    def MoveConnector(self, connector, movey):

   149

        position = connector.GetRelPosition()

   150

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

   151

        miny = self.Size[1]

   152

        maxy = 0

   153

        for connect in self.Connectors:

   154

            connect_pos = connect.GetRelPosition()

   155

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

   156

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

   157

        min_pos = self.Pos.y + miny

   158

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

   159

        if min_pos == self.Pos.y:

   160

            for connect in self.Connectors:

   161

                connect_pos = connect.GetRelPosition()

   162

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

   163

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

   164

        maxy = 0

   165

        for connect in self.Connectors:

   166

            connect_pos = connect.GetRelPosition()

   167

            maxy = max(maxy, connect_pos.y)

   168

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

   169

        connector.MoveConnected()

   170

        self.RefreshBoundingBox()

   171

   172

    # Returns the index in connectors list for the connector given

   173

    def GetConnectorIndex(self, connector):

   174

        if connector in self.Connectors:

   175

            return self.Connectors.index(connector)

   176

        return None

   177

   178

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

   179

    def DeleteConnector(self, idx):

   180

        self.Connectors.pop(idx)

   181

        self.RefreshConnectors()

   182

        self.RefreshSize()

   183

   184

    # Refresh the positions of the power rail connectors

   185

    def RefreshConnectors(self):

   186

        scaling = self.Parent.GetScaling()

   187

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

   188

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

   189

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

   190

            if self.RealConnectors:

   191

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

   192

            else:

   193

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

   194

            if scaling is not None:

   195

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

   196

            if self.Type == LEFTRAIL:

   197

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

   198

            elif self.Type == RIGHTRAIL:

   199

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

   200

        self.RefreshConnected()

   201

   202

    # Refresh the position of wires connected to power rail

   203

    def RefreshConnected(self, exclude=None):

   204

        for connector in self.Connectors:

   205

            connector.MoveConnected(exclude)

   206

   207

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

   208

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

   209

        # if a name is given

   210

        if name is not None:

   211

            # Test each connector if it exists

   212

            for connector in self.Connectors:

   213

                if name == connector.GetName():

   214

                    return connector

   215

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

   216

   217

    # Returns all the power rail connectors

   218

    def GetConnectors(self):

   219

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

   220

        if self.Type == LEFTRAIL:

   221

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

   222

        else:

   223

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

   224

   225

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

   226

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

   227

        for connector in self.Connectors:

   228

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

   229

                return connector

   230

        return None

   231

   232

    # Returns the power rail type

   233

    def SetType(self, type, connectors):

   234

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

   235

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

   236

            # the connectors list

   237

            self.Type = type

   238

            self.Clean()

   239

            self.Connectors = []

   240

            for dummy in xrange(connectors):

   241

                self.AddConnector()

   242

            self.RefreshSize()

   243

   244

    # Returns the power rail type

   245

    def GetType(self):

   246

        return self.Type

   247

   248

    # Method called when a LeftDown event have been generated

   249

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

   250

        self.RealConnectors = []

   251

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

   252

        if height > 0:

   253

            for connector in self.Connectors:

   254

                position = connector.GetRelPosition()

   255

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

   256

        elif len(self.Connectors) > 1:

   257

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

   258

        else:

   259

            self.RealConnectors = [0.5]

   260

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

   261

   262

    # Method called when a LeftUp event have been generated

   263

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

   264

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

   265

        self.RealConnectors = None

   266

   267

    # Method called when a LeftDown event have been generated

   268

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

   269

        pos = GetScaledEventPosition(event, dc, scaling)

   270

        # Test if a connector have been handled

   271

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

   272

        if connector:

   273

            self.Handle = (HANDLE_CONNECTOR, connector)

   274

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

   275

            self.Selected = False

   276

            # Initializes the last position

   277

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

   278

        else:

   279

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

   280

   281

    # Method called when a LeftDClick event have been generated

   282

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

   283

        # Edit the powerrail properties

   284

        self.Parent.EditPowerRailContent(self)

   285

   286

    # Method called when a RightUp event have been generated

   287

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

   288

        handle_type, handle = self.Handle

   289

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

   290

            wires = handle.GetWires()

   291

            if len(wires) == 1:

   292

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

   293

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

   294

                else:

   295

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

   296

                block.RefreshModel(False)

   297

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

   298

        else:

   299

            self.Parent.PopupDefaultMenu()

   300

   301

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

   302

        self.Move(x, y)

   303

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

   304

            self.SetSize(width, height)

   305

        else:

   306

            self.SetSize(LD_POWERRAIL_WIDTH, height)

   307

   308

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

   309

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

   310

        handle_type, handle = self.Handle

   311

        # A connector has been handled

   312

        if handle_type == HANDLE_CONNECTOR:

   313

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

   314

            if scaling is not None:

   315

                position = handle.GetRelPosition()

   316

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

   317

            self.MoveConnector(handle, movey)

   318

            return 0, movey

   319

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

   320

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

   321

        return 0, 0

   322

   323

    # Refreshes the power rail model

   324

    def RefreshModel(self, move=True):

   325

        self.Parent.RefreshPowerRailModel(self)

   326

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

   327

        # of wires connected to connectors

   328

        if move and self.Type == LEFTRAIL:

   329

            for connector in self.Connectors:

   330

                connector.RefreshWires()

   331

   332

    # Draws power rail

   333

    def Draw(self, dc):

   334

        Graphic_Element.Draw(self, dc)

   335

        dc.SetPen(MiterPen(wx.BLACK))

   336

        dc.SetBrush(wx.BLACK_BRUSH)

   337

        # Draw a rectangle with the power rail size

   338

        if self.Type == LEFTRAIL:

   339

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

   340

        else:

   341

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

   342

        # Draw connectors

   343

        for connector in self.Connectors:

   344

            connector.Draw(dc)

   345

   346

   347

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

   348

#                         Ladder Diagram Contact

   349

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

   350

   351

   352

class LD_Contact(Graphic_Element, DebugDataConsumer):

   353

    """

   354

    Class that implements the graphic representation of a contact

   355

    """

   356

   357

    # Create a new contact

   358

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

   359

        Graphic_Element.__init__(self, parent)

   360

        DebugDataConsumer.__init__(self)

   361

        self.Type = type

   362

        self.Name = name

   363

        self.Id = id

   364

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

   365

        self.Highlights = {}

   366

        # Create an input and output connector

   367

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

   368

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

   369

        self.PreviousValue = False

   370

        self.PreviousSpreading = False

   371

        self.RefreshNameSize()

   372

        self.RefreshTypeSize()

   373

   374

    def Flush(self):

   375

        if self.Input is not None:

   376

            self.Input.Flush()

   377

            self.Input = None

   378

        if self.Output is not None:

   379

            self.Output.Flush()

   380

            self.Output = None

   381

   382

    def SetForced(self, forced):

   383

        if self.Forced != forced:

   384

            self.Forced = forced

   385

            if self.Visible:

   386

                self.Parent.ElementNeedRefresh(self)

   387

   388

    def SetValue(self, value):

   389

        if self.Type == CONTACT_RISING:

   390

            refresh = self.Value and not self.PreviousValue

   391

        elif self.Type == CONTACT_FALLING:

   392

            refresh = not self.Value and self.PreviousValue

   393

        else:

   394

            refresh = False

   395

        self.PreviousValue = self.Value

   396

        self.Value = value

   397

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

   398

            if self.Visible:

   399

                self.Parent.ElementNeedRefresh(self)

   400

            self.SpreadCurrent()

   401

   402

    def SpreadCurrent(self):

   403

        if self.Parent.Debug:

   404

            if self.Value is None:

   405

                self.Value = False

   406

            spreading = self.Input.ReceivingCurrent()

   407

            if self.Type == CONTACT_NORMAL:

   408

                spreading &= self.Value

   409

            elif self.Type == CONTACT_REVERSE:

   410

                spreading &= not self.Value

   411

            elif self.Type == CONTACT_RISING:

   412

                spreading &= self.Value and not self.PreviousValue

   413

            elif self.Type == CONTACT_FALLING:

   414

                spreading &= not self.Value and self.PreviousValue

   415

            else:

   416

                spreading = False

   417

            if spreading and not self.PreviousSpreading:

   418

                self.Output.SpreadCurrent(True)

   419

            elif not spreading and self.PreviousSpreading:

   420

                self.Output.SpreadCurrent(False)

   421

            self.PreviousSpreading = spreading

   422

   423

    # Make a clone of this LD_Contact

   424

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

   425

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

   426

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

   427

        if pos is not None:

   428

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

   429

        else:

   430

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

   431

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

   432

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

   433

        return contact

   434

   435

    def GetConnectorTranslation(self, element):

   436

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

   437

   438

    # Returns the RedrawRect

   439

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

   440

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

   441

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

   442

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

   443

        if movex != 0 or movey != 0:

   444

            if self.Input.IsConnected():

   445

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

   446

            if self.Output.IsConnected():

   447

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

   448

        return rect

   449

   450

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

   451

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

   452

            movex = movey = 0

   453

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

   454

   455

    # Forbids to change the contact size

   456

    def SetSize(self, width, height):

   457

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

   458

            Graphic_Element.SetSize(self, width, height)

   459

            self.RefreshConnectors()

   460

   461

    # Delete this contact by calling the appropriate method

   462

    def Delete(self):

   463

        self.Parent.DeleteContact(self)

   464

   465

    # Unconnect input and output

   466

    def Clean(self):

   467

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

   468

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

   469

   470

    # Refresh the size of text for name

   471

    def RefreshNameSize(self):

   472

        if self.Name != "":

   473

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

   474

        else:

   475

            self.NameSize = 0, 0

   476

   477

    # Refresh the size of text for type

   478

    def RefreshTypeSize(self):

   479

        typetext = ""

   480

        if self.Type == CONTACT_REVERSE:

   481

            typetext = "/"

   482

        elif self.Type == CONTACT_RISING:

   483

            typetext = "P"

   484

        elif self.Type == CONTACT_FALLING:

   485

            typetext = "N"

   486

        if typetext != "":

   487

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

   488

        else:

   489

            self.TypeSize = 0, 0

   490

   491

    # Refresh the contact bounding box

   492

    def RefreshBoundingBox(self):

   493

        # Calculate the size of the name outside the contact

   494

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

   495

        # Calculate the bounding box size

   496

        if self.Name != "":

   497

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

   498

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

   499

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

   500

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

   501

        else:

   502

            bbx_x = self.Pos.x

   503

            bbx_width = self.Size[0]

   504

            bbx_y = self.Pos.y

   505

            bbx_height = self.Size[1]

   506

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

   507

   508

    # Returns the block minimum size

   509

    def GetMinSize(self):

   510

        return LD_ELEMENT_SIZE