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

import wx

    28

    29

from graphics.GraphicCommons import *

    30

from graphics.DebugDataConsumer import DebugDataConsumer

    31

from plcopen.structures import *

    32

    33

    34

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

    35

#                         Ladder Diagram PowerRail

    36

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

    37

    38

    39

class LD_PowerRail(Graphic_Element):

    40

    """

    41

    Class that implements the graphic representation of a power rail

    42

    """

    43

    44

    # Create a new power rail

    45

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

    46

        Graphic_Element.__init__(self, parent)

    47

        self.Type = None

    48

        self.Connectors = []

    49

        self.RealConnectors = None

    50

        self.Id = id

    51

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

    52

        self.SetType(type, connectors)

    53

    54

    def Flush(self):

    55

        for connector in self.Connectors:

    56

            connector.Flush()

    57

        self.Connectors = []

    58

    59

    # Make a clone of this LD_PowerRail

    60

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

    61

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

    62

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

    63

        if pos is not None:

    64

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

    65

        else:

    66

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

    67

        powerrail.Connectors = []

    68

        for connector in self.Connectors:

    69

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

    70

        return powerrail

    71

    72

    def GetConnectorTranslation(self, element):

    73

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

    74

                        [connector for connector in element.Connectors]))

    75

    76

    # Returns the RedrawRect

    77

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

    78

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

    79

        for connector in self.Connectors:

    80

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

    81

        if movex != 0 or movey != 0:

    82

            for connector in self.Connectors:

    83

                if connector.IsConnected():

    84

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

    85

        return rect

    86

    87

    # Forbids to change the power rail size

    88

    def SetSize(self, width, height):

    89

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

    90

            Graphic_Element.SetSize(self, width, height)

    91

        else:

    92

            Graphic_Element.SetSize(self, LD_POWERRAIL_WIDTH, height)

    93

        self.RefreshConnectors()

    94

    95

    # Forbids to select a power rail

    96

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

    97

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

    98

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

    99

        return False

   100

   101

    # Forbids to select a power rail

   102

    def IsInSelection(self, rect):

   103

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

   104

            return Graphic_Element.IsInSelection(self, rect)

   105

        return False

   106

   107

    # Deletes this power rail by calling the appropriate method

   108

    def Delete(self):

   109

        self.Parent.DeletePowerRail(self)

   110

   111

    # Unconnect all connectors

   112

    def Clean(self):

   113

        for connector in self.Connectors:

   114

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

   115

   116

    # Refresh the power rail bounding box

   117

    def RefreshBoundingBox(self):

   118

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

   119

   120

    # Refresh the power rail size

   121

    def RefreshSize(self):

   122

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

   123

        self.RefreshBoundingBox()

   124

   125

    # Returns the block minimum size

   126

    def GetMinSize(self, default=False):

   127

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

   128

                  if default else 0)

   129

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

   130

   131

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

   132

    def AddConnector(self):

   133

        self.InsertConnector(len(self.Connectors))

   134

   135

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

   136

    def InsertConnector(self, idx):

   137

        if self.Type == LEFTRAIL:

   138

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

   139

        elif self.Type == RIGHTRAIL:

   140

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

   141

        self.Connectors.insert(idx, connector)

   142

        self.RefreshSize()

   143

        self.RefreshConnectors()

   144

   145

    # Moves the divergence connector given

   146

    def MoveConnector(self, connector, movey):

   147

        position = connector.GetRelPosition()

   148

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

   149

        miny = self.Size[1]

   150

        maxy = 0

   151

        for connect in self.Connectors:

   152

            connect_pos = connect.GetRelPosition()

   153

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

   154

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

   155

        min_pos = self.Pos.y + miny

   156

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

   157

        if min_pos == self.Pos.y:

   158

            for connect in self.Connectors:

   159

                connect_pos = connect.GetRelPosition()

   160

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

   161

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

   162

        maxy = 0

   163

        for connect in self.Connectors:

   164

            connect_pos = connect.GetRelPosition()

   165

            maxy = max(maxy, connect_pos.y)

   166

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

   167

        connector.MoveConnected()

   168

        self.RefreshBoundingBox()

   169

   170

    # Returns the index in connectors list for the connector given

   171

    def GetConnectorIndex(self, connector):

   172

        if connector in self.Connectors:

   173

            return self.Connectors.index(connector)

   174

        return None

   175

   176

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

   177

    def DeleteConnector(self, idx):

   178

        self.Connectors.pop(idx)

   179

        self.RefreshConnectors()

   180

        self.RefreshSize()

   181

   182

    # Refresh the positions of the power rail connectors

   183

    def RefreshConnectors(self):

   184

        scaling = self.Parent.GetScaling()

   185

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

   186

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

   187

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

   188

            if self.RealConnectors:

   189

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

   190

            else:

   191

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

   192

            if scaling is not None:

   193

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

   194

            if self.Type == LEFTRAIL:

   195

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

   196

            elif self.Type == RIGHTRAIL:

   197

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

   198

        self.RefreshConnected()

   199

   200

    # Refresh the position of wires connected to power rail

   201

    def RefreshConnected(self, exclude=None):

   202

        for connector in self.Connectors:

   203

            connector.MoveConnected(exclude)

   204

   205

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

   206

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

   207

        # if a name is given

   208

        if name is not None:

   209

            # Test each connector if it exists

   210

            for connector in self.Connectors:

   211

                if name == connector.GetName():

   212

                    return connector

   213

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

   214

   215

    # Returns all the power rail connectors

   216

    def GetConnectors(self):

   217

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

   218

        if self.Type == LEFTRAIL:

   219

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

   220

        else:

   221

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

   222

   223

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

   224

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

   225

        for connector in self.Connectors:

   226

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

   227

                return connector

   228

        return None

   229

   230

    # Returns the power rail type

   231

    def SetType(self, type, connectors):

   232

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

   233

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

   234

            # the connectors list

   235

            self.Type = type

   236

            self.Clean()

   237

            self.Connectors = []

   238

            for dummy in xrange(connectors):

   239

                self.AddConnector()

   240

            self.RefreshSize()

   241

   242

    # Returns the power rail type

   243

    def GetType(self):

   244

        return self.Type

   245

   246

    # Method called when a LeftDown event have been generated

   247

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

   248

        self.RealConnectors = []

   249

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

   250

        if height > 0:

   251

            for connector in self.Connectors:

   252

                position = connector.GetRelPosition()

   253

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

   254

        elif len(self.Connectors) > 1:

   255

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

   256

        else:

   257

            self.RealConnectors = [0.5]

   258

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

   259

   260

    # Method called when a LeftUp event have been generated

   261

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

   262

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

   263

        self.RealConnectors = None

   264

   265

    # Method called when a LeftDown event have been generated

   266

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

   267

        pos = GetScaledEventPosition(event, dc, scaling)

   268

        # Test if a connector have been handled

   269

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

   270

        if connector:

   271

            self.Handle = (HANDLE_CONNECTOR, connector)

   272

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

   273

            self.Selected = False

   274

            # Initializes the last position

   275

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

   276

        else:

   277

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

   278

   279

    # Method called when a LeftDClick event have been generated

   280

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

   281

        # Edit the powerrail properties

   282

        self.Parent.EditPowerRailContent(self)

   283

   284

    # Method called when a RightUp event have been generated

   285

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

   286

        handle_type, handle = self.Handle

   287

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

   288

            wires = handle.GetWires()

   289

            if len(wires) == 1:

   290

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

   291

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

   292

                else:

   293

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

   294

                block.RefreshModel(False)

   295

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

   296

        else:

   297

            self.Parent.PopupDefaultMenu()

   298

   299

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

   300

        self.Move(x, y)

   301

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

   302

            self.SetSize(width, height)

   303

        else:

   304

            self.SetSize(LD_POWERRAIL_WIDTH, height)

   305

   306

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

   307

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

   308

        handle_type, handle = self.Handle

   309

        # A connector has been handled

   310

        if handle_type == HANDLE_CONNECTOR:

   311

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

   312

            if scaling is not None:

   313

                position = handle.GetRelPosition()

   314

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

   315

            self.MoveConnector(handle, movey)

   316

            return 0, movey

   317

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

   318

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

   319

        return 0, 0

   320

   321

    # Refreshes the power rail model

   322

    def RefreshModel(self, move=True):

   323

        self.Parent.RefreshPowerRailModel(self)

   324

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

   325

        # of wires connected to connectors

   326

        if move and self.Type == LEFTRAIL:

   327

            for connector in self.Connectors:

   328

                connector.RefreshWires()

   329

   330

    # Draws power rail

   331

    def Draw(self, dc):

   332

        Graphic_Element.Draw(self, dc)

   333

        dc.SetPen(MiterPen(wx.BLACK))

   334

        dc.SetBrush(wx.BLACK_BRUSH)

   335

        # Draw a rectangle with the power rail size

   336

        if self.Type == LEFTRAIL:

   337

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

   338

        else:

   339

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

   340

        # Draw connectors

   341

        for connector in self.Connectors:

   342

            connector.Draw(dc)

   343

   344

   345

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

   346

#                         Ladder Diagram Contact

   347

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

   348

   349

   350

class LD_Contact(Graphic_Element, DebugDataConsumer):

   351

    """

   352

    Class that implements the graphic representation of a contact

   353

    """

   354

   355

    # Create a new contact

   356

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

   357

        Graphic_Element.__init__(self, parent)

   358

        DebugDataConsumer.__init__(self)

   359

        self.Type = type

   360

        self.Name = name

   361

        self.Id = id

   362

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

   363

        self.Highlights = {}

   364

        # Create an input and output connector

   365

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

   366

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

   367

        self.PreviousValue = False

   368

        self.PreviousSpreading = False

   369

        self.RefreshNameSize()

   370

        self.RefreshTypeSize()

   371

   372

    def Flush(self):

   373

        if self.Input is not None:

   374

            self.Input.Flush()

   375

            self.Input = None

   376

        if self.Output is not None:

   377

            self.Output.Flush()

   378

            self.Output = None

   379

   380

    def SetForced(self, forced):

   381

        if self.Forced != forced:

   382

            self.Forced = forced

   383

            if self.Visible:

   384

                self.Parent.ElementNeedRefresh(self)

   385

   386

    def SetValue(self, value):

   387

        if self.Type == CONTACT_RISING:

   388

            refresh = self.Value and not self.PreviousValue

   389

        elif self.Type == CONTACT_FALLING:

   390

            refresh = not self.Value and self.PreviousValue

   391

        else:

   392

            refresh = False

   393

        self.PreviousValue = self.Value

   394

        self.Value = value

   395

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

   396

            if self.Visible:

   397

                self.Parent.ElementNeedRefresh(self)

   398

            self.SpreadCurrent()

   399

   400

    def SpreadCurrent(self):

   401

        if self.Parent.Debug:

   402

            if self.Value is None:

   403

                self.Value = False

   404

            spreading = self.Input.ReceivingCurrent()

   405

            if self.Type == CONTACT_NORMAL:

   406

                spreading &= self.Value

   407

            elif self.Type == CONTACT_REVERSE:

   408

                spreading &= not self.Value

   409

            elif self.Type == CONTACT_RISING:

   410

                spreading &= self.Value and not self.PreviousValue

   411

            elif self.Type == CONTACT_FALLING:

   412

                spreading &= not self.Value and self.PreviousValue

   413

            else:

   414

                spreading = False

   415

            if spreading and not self.PreviousSpreading:

   416

                self.Output.SpreadCurrent(True)

   417

            elif not spreading and self.PreviousSpreading:

   418

                self.Output.SpreadCurrent(False)

   419

            self.PreviousSpreading = spreading

   420

   421

    # Make a clone of this LD_Contact

   422

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

   423

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

   424

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

   425

        if pos is not None:

   426

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

   427

        else:

   428

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

   429

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

   430

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

   431

        return contact

   432

   433

    def GetConnectorTranslation(self, element):

   434

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

   435

   436

    # Returns the RedrawRect

   437

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

   438

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

   439

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

   440

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

   441

        if movex != 0 or movey != 0:

   442

            if self.Input.IsConnected():

   443

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

   444

            if self.Output.IsConnected():

   445

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

   446

        return rect

   447

   448

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

   449

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

   450

            movex = movey = 0

   451

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

   452

   453

    # Forbids to change the contact size

   454

    def SetSize(self, width, height):

   455

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

   456

            Graphic_Element.SetSize(self, width, height)

   457

            self.RefreshConnectors()

   458

   459

    # Delete this contact by calling the appropriate method

   460

    def Delete(self):

   461

        self.Parent.DeleteContact(self)

   462

   463

    # Unconnect input and output

   464

    def Clean(self):

   465

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

   466

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

   467

   468

    # Refresh the size of text for name

   469

    def RefreshNameSize(self):

   470

        if self.Name != "":

   471

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

   472

        else:

   473

            self.NameSize = 0, 0

   474

   475

    # Refresh the size of text for type

   476

    def RefreshTypeSize(self):

   477

        typetext = ""

   478

        if self.Type == CONTACT_REVERSE:

   479

            typetext = "/"

   480

        elif self.Type == CONTACT_RISING:

   481

            typetext = "P"

   482

        elif self.Type == CONTACT_FALLING:

   483

            typetext = "N"

   484

        if typetext != "":

   485

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

   486

        else:

   487

            self.TypeSize = 0, 0

   488

   489

    # Refresh the contact bounding box

   490

    def RefreshBoundingBox(self):

   491

        # Calculate the size of the name outside the contact

   492

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

   493

        # Calculate the bounding box size

   494

        if self.Name != "":

   495

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

   496

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

   497

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

   498

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

   499

        else:

   500

            bbx_x = self.Pos.x

   501

            bbx_width = self.Size[0]

   502

            bbx_y = self.Pos.y

   503

            bbx_height = self.Size[1]

   504

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

   505

   506

    # Returns the block minimum size

   507

    def GetMinSize(self):

   508

        return LD_ELEMENT_SIZE

   509

   510

    # Refresh the position of wire connected to contact

   511

    def RefreshConnected(self, exclude=None):

   512

        self.Input.MoveConnected(exclude)