1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

import wx

    27

    28

from graphics.GraphicCommons import *

    29

from graphics.DebugDataConsumer import DebugDataConsumer

    30

from plcopen.structures import *

    31

    32

    33

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

    34

#                         Ladder Diagram PowerRail

    35

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

    36

    37

    38

class LD_PowerRail(Graphic_Element):

    39

    """

    40

    Class that implements the graphic representation of a power rail

    41

    """

    42

    43

    # Create a new power rail

    44

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

    45

        Graphic_Element.__init__(self, parent)

    46

        self.Type = None

    47

        self.Connectors = []

    48

        self.RealConnectors = None

    49

        self.Id = id

    50

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

    51

        self.SetType(type, connectors)

    52

    53

    def Flush(self):

    54

        for connector in self.Connectors:

    55

            connector.Flush()

    56

        self.Connectors = []

    57

    58

    # Make a clone of this LD_PowerRail

    59

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

    60

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

    61

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

    62

        if pos is not None:

    63

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

    64

        else:

    65

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

    66

        powerrail.Connectors = []

    67

        for connector in self.Connectors:

    68

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

    69

        return powerrail

    70

    71

    def GetConnectorTranslation(self, element):

    72

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

    73

                        [connector for connector in element.Connectors])))

    74

    75

    # Returns the RedrawRect

    76

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

    77

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

    78

        for connector in self.Connectors:

    79

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

    80

        if movex != 0 or movey != 0:

    81

            for connector in self.Connectors:

    82

                if connector.IsConnected():

    83

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

    84

        return rect

    85

    86

    # Forbids to change the power rail size

    87

    def SetSize(self, width, height):

    88

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

    89

            Graphic_Element.SetSize(self, width, height)

    90

        else:

    91

            Graphic_Element.SetSize(self, LD_POWERRAIL_WIDTH, height)

    92

        self.RefreshConnectors()

    93

    94

    # Forbids to select a power rail

    95

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

    96

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

    97

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

    98

        return False

    99

   100

    # Forbids to select a power rail

   101

    def IsInSelection(self, rect):

   102

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

   103

            return Graphic_Element.IsInSelection(self, rect)

   104

        return False

   105

   106

    # Deletes this power rail by calling the appropriate method

   107

    def Delete(self):

   108

        self.Parent.DeletePowerRail(self)

   109

   110

    # Unconnect all connectors

   111

    def Clean(self):

   112

        for connector in self.Connectors:

   113

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

   114

   115

    # Refresh the power rail bounding box

   116

    def RefreshBoundingBox(self):

   117

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

   118

   119

    # Refresh the power rail size

   120

    def RefreshSize(self):

   121

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

   122

        self.RefreshBoundingBox()

   123

   124

    # Returns the block minimum size

   125

    def GetMinSize(self, default=False):

   126

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

   127

                  if default else 0)

   128

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

   129

   130

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

   131

    def AddConnector(self):

   132

        self.InsertConnector(len(self.Connectors))

   133

   134

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

   135

    def InsertConnector(self, idx):

   136

        if self.Type == LEFTRAIL:

   137

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

   138

        elif self.Type == RIGHTRAIL:

   139

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

   140

        self.Connectors.insert(idx, connector)

   141

        self.RefreshSize()

   142

        self.RefreshConnectors()

   143

   144

    # Moves the divergence connector given

   145

    def MoveConnector(self, connector, movey):

   146

        position = connector.GetRelPosition()

   147

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

   148

        miny = self.Size[1]

   149

        maxy = 0

   150

        for connect in self.Connectors:

   151

            connect_pos = connect.GetRelPosition()

   152

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

   153

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

   154

        min_pos = self.Pos.y + miny

   155

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

   156

        if min_pos == self.Pos.y:

   157

            for connect in self.Connectors:

   158

                connect_pos = connect.GetRelPosition()

   159

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

   160

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

   161

        maxy = 0

   162

        for connect in self.Connectors:

   163

            connect_pos = connect.GetRelPosition()

   164

            maxy = max(maxy, connect_pos.y)

   165

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

   166

        connector.MoveConnected()

   167

        self.RefreshBoundingBox()

   168

   169

    # Returns the index in connectors list for the connector given

   170

    def GetConnectorIndex(self, connector):

   171

        if connector in self.Connectors:

   172

            return self.Connectors.index(connector)

   173

        return None

   174

   175

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

   176

    def DeleteConnector(self, idx):

   177

        self.Connectors.pop(idx)

   178

        self.RefreshConnectors()

   179

        self.RefreshSize()

   180

   181

    # Refresh the positions of the power rail connectors

   182

    def RefreshConnectors(self):

   183

        scaling = self.Parent.GetScaling()

   184

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

   185

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

   186

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

   187

            if self.RealConnectors:

   188

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

   189

            else:

   190

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

   191

            if scaling is not None:

   192

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

   193

            if self.Type == LEFTRAIL:

   194

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

   195

            elif self.Type == RIGHTRAIL:

   196

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

   197

        self.RefreshConnected()

   198

   199

    # Refresh the position of wires connected to power rail

   200

    def RefreshConnected(self, exclude=None):

   201

        for connector in self.Connectors:

   202

            connector.MoveConnected(exclude)

   203

   204

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

   205

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

   206

        # if a name is given

   207

        if name is not None:

   208

            # Test each connector if it exists

   209

            for connector in self.Connectors:

   210

                if name == connector.GetName():

   211

                    return connector

   212

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

   213

   214

    # Returns all the power rail connectors

   215

    def GetConnectors(self):

   216

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

   217

        if self.Type == LEFTRAIL:

   218

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

   219

        else:

   220

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

   221

   222

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

   223

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

   224

        for connector in self.Connectors:

   225

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

   226

                return connector

   227

        return None

   228

   229

    # Returns the power rail type

   230

    def SetType(self, type, connectors):

   231

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

   232

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

   233

            # the connectors list

   234

            self.Type = type

   235

            self.Clean()

   236

            self.Connectors = []

   237

            for dummy in range(connectors):

   238

                self.AddConnector()

   239

            self.RefreshSize()

   240

   241

    # Returns the power rail type

   242

    def GetType(self):

   243

        return self.Type

   244

   245

    # Method called when a LeftDown event have been generated

   246

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

   247

        self.RealConnectors = []

   248

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

   249

        if height > 0:

   250

            for connector in self.Connectors:

   251

                position = connector.GetRelPosition()

   252

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

   253

        elif len(self.Connectors) > 1:

   254

            self.RealConnectors = [x * 1 / (len(self.Connectors) - 1) for x in range(len(self.Connectors))]

   255

        else:

   256

            self.RealConnectors = [0.5]

   257

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

   258

   259

    # Method called when a LeftUp event have been generated

   260

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

   261

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

   262

        self.RealConnectors = None

   263

   264

    # Method called when a LeftDown event have been generated

   265

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

   266

        pos = GetScaledEventPosition(event, dc, scaling)

   267

        # Test if a connector have been handled

   268

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

   269

        if connector:

   270

            self.Handle = (HANDLE_CONNECTOR, connector)

   271

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

   272

            self.Selected = False

   273

            # Initializes the last position

   274

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

   275

        else:

   276

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

   277

   278

    # Method called when a LeftDClick event have been generated

   279

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

   280

        # Edit the powerrail properties

   281

        self.Parent.EditPowerRailContent(self)

   282

   283

    # Method called when a RightUp event have been generated

   284

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

   285

        handle_type, handle = self.Handle

   286

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

   287

            wires = handle.GetWires()

   288

            if len(wires) == 1:

   289

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

   290

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

   291

                else:

   292

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

   293

                block.RefreshModel(False)

   294

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

   295

        else:

   296

            self.Parent.PopupDefaultMenu()

   297

   298

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

   299

        self.Move(x, y)

   300

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

   301

            self.SetSize(width, height)

   302

        else:

   303

            self.SetSize(LD_POWERRAIL_WIDTH, height)

   304

   305

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

   306

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

   307

        handle_type, handle = self.Handle

   308

        # A connector has been handled

   309

        if handle_type == HANDLE_CONNECTOR:

   310

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

   311

            if scaling is not None:

   312

                position = handle.GetRelPosition()

   313

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

   314

            self.MoveConnector(handle, movey)

   315

            return 0, movey

   316

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

   317

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

   318

        return 0, 0

   319

   320

    # Refreshes the power rail model

   321

    def RefreshModel(self, move=True):

   322

        self.Parent.RefreshPowerRailModel(self)

   323

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

   324

        # of wires connected to connectors

   325

        if move and self.Type == LEFTRAIL:

   326

            for connector in self.Connectors:

   327

                connector.RefreshWires()

   328

   329

    # Draws power rail

   330

    def Draw(self, dc):

   331

        Graphic_Element.Draw(self, dc)

   332

        dc.SetPen(MiterPen(wx.BLACK))

   333

        dc.SetBrush(wx.BLACK_BRUSH)

   334

        # Draw a rectangle with the power rail size

   335

        if self.Type == LEFTRAIL:

   336

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

   337

        else:

   338

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

   339

        # Draw connectors

   340

        for connector in self.Connectors:

   341

            connector.Draw(dc)

   342

   343

   344

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

   345

#                         Ladder Diagram Contact

   346

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

   347

   348

   349

class LD_Contact(Graphic_Element, DebugDataConsumer):

   350

    """

   351

    Class that implements the graphic representation of a contact

   352

    """

   353

   354

    # Create a new contact

   355

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

   356

        Graphic_Element.__init__(self, parent)

   357

        DebugDataConsumer.__init__(self)

   358

        self.Type = type

   359

        self.Name = name

   360

        self.Id = id

   361

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

   362

        self.Highlights = {}

   363

        # Create an input and output connector

   364

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

   365

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

   366

        self.PreviousValue = False

   367

        self.PreviousSpreading = False

   368

        self.RefreshNameSize()

   369

        self.RefreshTypeSize()

   370

   371

    def Flush(self):

   372

        if self.Input is not None:

   373

            self.Input.Flush()

   374

            self.Input = None

   375

        if self.Output is not None:

   376

            self.Output.Flush()

   377

            self.Output = None

   378

   379

    def SetForced(self, forced):

   380

        if self.Forced != forced:

   381

            self.Forced = forced

   382

            if self.Visible:

   383

                self.Parent.ElementNeedRefresh(self)

   384

   385

    def SetValue(self, value):

   386

        if self.Type == CONTACT_RISING:

   387

            refresh = self.Value and not self.PreviousValue

   388

        elif self.Type == CONTACT_FALLING:

   389

            refresh = not self.Value and self.PreviousValue

   390

        else:

   391

            refresh = False

   392

        self.PreviousValue = self.Value

   393

        self.Value = value

   394

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

   395

            if self.Visible:

   396

                self.Parent.ElementNeedRefresh(self)

   397

            self.SpreadCurrent()

   398

   399

    def SpreadCurrent(self):

   400

        if self.Parent.Debug:

   401

            if self.Value is None:

   402

                self.Value = False

   403

            spreading = self.Input.ReceivingCurrent()

   404

            if spreading == "undefined":

   405

                spreading = False

   406

            if self.Type == CONTACT_NORMAL:

   407

                spreading &= self.Value

   408

            elif self.Type == CONTACT_REVERSE:

   409

                spreading &= not self.Value

   410

            elif self.Type == CONTACT_RISING:

   411

                spreading &= self.Value and not self.PreviousValue

   412

            elif self.Type == CONTACT_FALLING:

   413

                spreading &= not self.Value and self.PreviousValue

   414

            else:

   415

                spreading = False

   416

            if spreading and not self.PreviousSpreading:

   417

                self.Output.SpreadCurrent(True)

   418

            elif not spreading and self.PreviousSpreading:

   419

                self.Output.SpreadCurrent(False)

   420

            self.PreviousSpreading = spreading

   421

   422

    # Make a clone of this LD_Contact

   423

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

   424

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

   425

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

   426

        if pos is not None:

   427

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

   428

        else:

   429

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

   430

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

   431

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

   432

        return contact

   433

   434

    def GetConnectorTranslation(self, element):

   435

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

   436

   437

    # Returns the RedrawRect

   438

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

   439

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

   440

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

   441

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

   442

        if movex != 0 or movey != 0:

   443

            if self.Input.IsConnected():

   444

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

   445

            if self.Output.IsConnected():

   446

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

   447

        return rect

   448

   449

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

   450

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

   451

            movex = movey = 0

   452

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

   453

   454

    # Forbids to change the contact size

   455

    def SetSize(self, width, height):

   456

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

   457

            Graphic_Element.SetSize(self, width, height)

   458

            self.RefreshConnectors()

   459

   460

    # Delete this contact by calling the appropriate method

   461

    def Delete(self):

   462

        self.Parent.DeleteContact(self)

   463

   464

    # Unconnect input and output

   465

    def Clean(self):

   466

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

   467

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

   468

   469

    # Refresh the size of text for name

   470

    def RefreshNameSize(self):

   471

        if self.Name != "":

   472

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

   473

        else:

   474

            self.NameSize = 0, 0

   475

   476

    # Refresh the size of text for type

   477

    def RefreshTypeSize(self):

   478

        typetext = ""

   479

        if self.Type == CONTACT_REVERSE:

   480

            typetext = "/"

   481

        elif self.Type == CONTACT_RISING:

   482

            typetext = "P"

   483

        elif self.Type == CONTACT_FALLING:

   484

            typetext = "N"

   485

        if typetext != "":

   486

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

   487

        else:

   488

            self.TypeSize = 0, 0

   489

   490

    # Refresh the contact bounding box

   491

    def RefreshBoundingBox(self):

   492

        # Calculate the size of the name outside the contact

   493

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

   494

        # Calculate the bounding box size

   495

        if self.Name != "":

   496

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

   497

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

   498

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

   499

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

   500

        else:

   501

            bbx_x = self.Pos.x

   502

            bbx_width = self.Size[0]

   503

            bbx_y = self.Pos.y

   504

            bbx_height = self.Size[1]

   505

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

   506

   507

    # Returns the block minimum size

   508

    def GetMinSize(self):

   509

        return LD_ELEMENT_SIZE

   510