1

#!/usr/bin/env python

     2

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

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

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

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

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

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import wx

    26

    27

from graphics.GraphicCommons import *

    28

from graphics.DebugDataConsumer import DebugDataConsumer

    29

from plcopen.structures import *

    30

    31

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

    32

#                         Ladder Diagram PowerRail

    33

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

    34

    35

"""

    36

Class that implements the graphic representation of a power rail

    37

"""

    38

    39

class LD_PowerRail(Graphic_Element):

    40

    41

    # Create a new power rail

    42

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

    43

        Graphic_Element.__init__(self, parent)

    44

        self.Type = None

    45

        self.Connectors = []

    46

        self.RealConnectors = None

    47

        self.Id = id

    48

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

    49

        self.SetType(type, connectors)

    50

    51

    def Flush(self):

    52

        for connector in self.Connectors:

    53

            connector.Flush()

    54

        self.Connectors = []

    55

    56

    # Make a clone of this LD_PowerRail

    57

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

    58

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

    59

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

    60

        if pos is not None:

    61

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

    62

        else:

    63

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

    64

        powerrail.Connectors = []

    65

        for connector in self.Connectors:

    66

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

    67

        return powerrail

    68

    69

    def GetConnectorTranslation(self, element):

    70

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

    71

                        [connector for connector in element.Connectors]))

    72

    73

    # Returns the RedrawRect

    74

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

    75

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

    76

        for connector in self.Connectors:

    77

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

    78

        if movex != 0 or movey != 0:

    79

            for connector in self.Connectors:

    80

                if connector.IsConnected():

    81

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

    82

        return rect

    83

    84

    # Forbids to change the power rail size

    85

    def SetSize(self, width, height):

    86

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

    87

            Graphic_Element.SetSize(self, width, height)

    88

        else:

    89

            Graphic_Element.SetSize(self, LD_POWERRAIL_WIDTH, height)

    90

        self.RefreshConnectors()

    91

    92

    # Forbids to select a power rail

    93

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

    94

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

    95

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

    96

        return False

    97

    98

    # Forbids to select a power rail

    99

    def IsInSelection(self, rect):

   100

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

   101

            return Graphic_Element.IsInSelection(self, rect)

   102

        return False

   103

   104

    # Deletes this power rail by calling the appropriate method

   105

    def Delete(self):

   106

        self.Parent.DeletePowerRail(self)

   107

   108

    # Unconnect all connectors

   109

    def Clean(self):

   110

        for connector in self.Connectors:

   111

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

   112

   113

    # Refresh the power rail bounding box

   114

    def RefreshBoundingBox(self):

   115

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

   116

   117

    # Refresh the power rail size

   118

    def RefreshSize(self):

   119

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

   120

        self.RefreshBoundingBox()

   121

   122

    # Returns the block minimum size

   123

    def GetMinSize(self):

   124

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

   125

   126

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

   127

    def AddConnector(self):

   128

        self.InsertConnector(len(self.Connectors))

   129

   130

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

   131

    def InsertConnector(self, idx):

   132

        if self.Type == LEFTRAIL:

   133

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

   134

        elif self.Type == RIGHTRAIL:

   135

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

   136

        self.Connectors.insert(idx, connector)

   137

        self.RefreshSize()

   138

        self.RefreshConnectors()

   139

   140

    # Moves the divergence connector given

   141

    def MoveConnector(self, connector, movey):

   142

        position = connector.GetRelPosition()

   143

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

   144

        miny = self.Size[1]

   145

        maxy = 0

   146

        for connect in self.Connectors:

   147

            connect_pos = connect.GetRelPosition()

   148

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

   149

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

   150

        min_pos = self.Pos.y + miny

   151

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

   152

        if min_pos == self.Pos.y:

   153

            for connect in self.Connectors:

   154

                connect_pos = connect.GetRelPosition()

   155

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

   156

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

   157

        maxy = 0

   158

        for connect in self.Connectors:

   159

            connect_pos = connect.GetRelPosition()

   160

            maxy = max(maxy, connect_pos.y)

   161

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

   162

        connector.MoveConnected()

   163

        self.RefreshBoundingBox()

   164

   165

    # Returns the index in connectors list for the connector given

   166

    def GetConnectorIndex(self, connector):

   167

        if connector in self.Connectors:

   168

            return self.Connectors.index(connector)

   169

        return None

   170

   171

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

   172

    def DeleteConnector(self, idx):

   173

        self.Connectors.pop(idx)

   174

        self.RefreshConnectors()

   175

        self.RefreshSize()

   176

   177

    # Refresh the positions of the power rail connectors

   178

    def RefreshConnectors(self):

   179

        scaling = self.Parent.GetScaling()

   180

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

   181

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

   182

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

   183

            if self.RealConnectors:

   184

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

   185

            else:

   186

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

   187

            if scaling is not None:

   188

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

   189

            if self.Type == LEFTRAIL:

   190

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

   191

            elif self.Type == RIGHTRAIL:

   192

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

   193

        self.RefreshConnected()

   194

   195

    # Refresh the position of wires connected to power rail

   196

    def RefreshConnected(self, exclude = []):

   197

        for connector in self.Connectors:

   198

            connector.MoveConnected(exclude)

   199

   200

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

   201

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

   202

        # if a name is given

   203

        if name is not None:

   204

            # Test each connector if it exists

   205

            for connector in self.Connectors:

   206

                if name == connector.GetName():

   207

                    return connector

   208

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

   209

   210

    # Returns all the power rail connectors 

   211

    def GetConnectors(self):

   212

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

   213

        if self.Type == LEFTRAIL:

   214

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

   215

        else:

   216

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

   217

   218

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

   219

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

   220

        for connector in self.Connectors:

   221

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

   222

                return connector

   223

        return None

   224

   225

    # Returns the power rail type

   226

    def SetType(self, type, connectors):

   227

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

   228

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

   229

            # the connectors list

   230

            self.Type = type

   231

            self.Clean()

   232

            self.Connectors = []

   233

            for connector in xrange(connectors):

   234

                self.AddConnector()

   235

            self.RefreshSize()

   236

   237

    # Returns the power rail type

   238

    def GetType(self):

   239

        return self.Type

   240

   241

    # Method called when a LeftDown event have been generated

   242

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

   243

        self.RealConnectors = []

   244

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

   245

        if height > 0:

   246

            for connector in self.Connectors:

   247

                position = connector.GetRelPosition()

   248

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

   249

        elif len(self.Connectors) > 1:

   250

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

   251

        else:

   252

            self.RealConnectors = [0.5]

   253

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

   254

   255

    # Method called when a LeftUp event have been generated

   256

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

   257

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

   258

        self.RealConnectors = None

   259

   260

    # Method called when a LeftDown event have been generated

   261

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

   262

        pos = GetScaledEventPosition(event, dc, scaling)

   263

        # Test if a connector have been handled

   264

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

   265

        if connector:

   266

            self.Handle = (HANDLE_CONNECTOR, connector)

   267

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

   268

            self.Selected = False

   269

            # Initializes the last position

   270

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

   271

        else:

   272

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

   273

   274

    # Method called when a LeftDClick event have been generated

   275

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

   276

        # Edit the powerrail properties

   277

        self.Parent.EditPowerRailContent(self)

   278

   279

    # Method called when a RightUp event have been generated

   280

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

   281

        handle_type, handle = self.Handle

   282

        if handle_type == HANDLE_CONNECTOR:

   283

            wires = handle.GetWires()

   284

            if len(wires) == 1:

   285

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

   286

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

   287

                else:

   288

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

   289

                block.RefreshModel(False)

   290

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

   291

        else:

   292

            self.Parent.PopupDefaultMenu()

   293

   294

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

   295

        self.Move(x, y)

   296

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

   297

            self.SetSize(width, height)

   298

        else:

   299

            self.SetSize(LD_POWERRAIL_WIDTH, height)

   300

   301

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

   302

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

   303

        handle_type, handle = self.Handle

   304

        # A connector has been handled

   305

        if handle_type == HANDLE_CONNECTOR:

   306

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

   307

            if scaling is not None:

   308

                position = handle.GetRelPosition()

   309

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

   310

            self.MoveConnector(handle, movey)

   311

            return 0, movey

   312

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

   313

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

   314

        return 0, 0

   315

   316

    # Refreshes the power rail model

   317

    def RefreshModel(self, move=True):

   318

        self.Parent.RefreshPowerRailModel(self)

   319

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

   320

        # of wires connected to connectors

   321

        if move and self.Type == LEFTRAIL:

   322

            for connector in self.Connectors:

   323

                connector.RefreshWires()

   324

   325

    # Draws power rail

   326

    def Draw(self, dc):

   327

        Graphic_Element.Draw(self, dc)

   328

        dc.SetPen(MiterPen(wx.BLACK))

   329

        dc.SetBrush(wx.BLACK_BRUSH)

   330

        # Draw a rectangle with the power rail size

   331

        if self.Type == LEFTRAIL:

   332

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

   333

        else:

   334

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

   335

        # Draw connectors

   336

        for connector in self.Connectors:

   337

            connector.Draw(dc)

   338

   339

   340

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

   341

#                         Ladder Diagram Contact

   342

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

   343

   344

"""

   345

Class that implements the graphic representation of a contact

   346

"""

   347

   348

class LD_Contact(Graphic_Element, DebugDataConsumer):

   349

   350

    # Create a new contact

   351

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

   352

        Graphic_Element.__init__(self, parent)

   353

        DebugDataConsumer.__init__(self)

   354

        self.Type = type

   355

        self.Name = name

   356

        self.Id = id

   357

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

   358

        self.Highlights = {}

   359

        # Create an input and output connector

   360

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

   361

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

   362

        self.PreviousValue = False

   363

        self.PreviousSpreading = False

   364

        self.RefreshNameSize()

   365

        self.RefreshTypeSize()

   366

   367

    def Flush(self):

   368

        if self.Input is not None:

   369

            self.Input.Flush()

   370

            self.Input = None

   371

        if self.Output is not None:

   372

            self.Output.Flush()

   373

            self.Output = None

   374

   375

    def SetForced(self, forced):

   376

        if self.Forced != forced:

   377

            self.Forced = forced

   378

            if self.Visible:

   379

                self.Parent.ElementNeedRefresh(self)

   380

   381

    def SetValue(self, value):

   382

        if self.Type == CONTACT_RISING:

   383

            refresh = self.Value and not self.PreviousValue

   384

        elif self.Type == CONTACT_FALLING:

   385

            refresh = not self.Value and self.PreviousValue

   386

        else:

   387

            refresh = False

   388

        self.PreviousValue = self.Value

   389

        self.Value = value

   390

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

   391

            if self.Visible:

   392

                self.Parent.ElementNeedRefresh(self)

   393

            self.SpreadCurrent()

   394

   395

    def SpreadCurrent(self):

   396

        if self.Parent.Debug:

   397

            if self.Value is None:

   398

                self.Value = False

   399

            spreading = self.Input.ReceivingCurrent()

   400

            if self.Type == CONTACT_NORMAL:

   401

                spreading &= self.Value

   402

            elif self.Type == CONTACT_REVERSE:

   403

                spreading &= not self.Value

   404

            elif self.Type == CONTACT_RISING:

   405

                spreading &= self.Value and not self.PreviousValue

   406

            elif self.Type == CONTACT_FALLING:

   407

                spreading &= not self.Value and self.PreviousValue

   408

            else:

   409

                spreading = False

   410

            if spreading and not self.PreviousSpreading:

   411

                self.Output.SpreadCurrent(True)

   412

            elif not spreading and self.PreviousSpreading:

   413

                self.Output.SpreadCurrent(False)

   414

            self.PreviousSpreading = spreading

   415

   416

    # Make a clone of this LD_Contact

   417

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

   418

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

   419

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

   420

        if pos is not None:

   421

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

   422

        else:

   423

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

   424

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

   425

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

   426

        return contact

   427

   428

    def GetConnectorTranslation(self, element):

   429

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

   430

   431

    # Returns the RedrawRect

   432

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

   433

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

   434

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

   435

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

   436

        if movex != 0 or movey != 0:

   437

            if self.Input.IsConnected():

   438

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

   439

            if self.Output.IsConnected():

   440

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

   441

        return rect

   442

   443

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

   444

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

   445

            movex = movey = 0

   446

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

   447

   448

    # Forbids to change the contact size

   449

    def SetSize(self, width, height):

   450

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

   451

            Graphic_Element.SetSize(self, width, height)

   452

            self.RefreshConnectors()

   453

   454

    # Delete this contact by calling the appropriate method

   455

    def Delete(self):

   456

        self.Parent.DeleteContact(self)

   457

   458

    # Unconnect input and output

   459

    def Clean(self):

   460

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

   461

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

   462

   463

    # Refresh the size of text for name

   464

    def RefreshNameSize(self):

   465

        if self.Name != "":

   466

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

   467

        else:

   468

            self.NameSize = 0, 0

   469

   470

    # Refresh the size of text for type

   471

    def RefreshTypeSize(self):

   472

        typetext = ""

   473

        if self.Type == CONTACT_REVERSE:

   474

            typetext = "/"

   475

        elif self.Type == CONTACT_RISING:

   476

            typetext = "P"

   477

        elif self.Type == CONTACT_FALLING:

   478

            typetext = "N"

   479

        if typetext != "":

   480

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

   481

        else:

   482

            self.TypeSize = 0, 0

   483

   484

    # Refresh the contact bounding box

   485

    def RefreshBoundingBox(self):

   486

        # Calculate the size of the name outside the contact

   487

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

   488

        # Calculate the bounding box size

   489

        if self.Name != "":

   490

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

   491

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

   492

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

   493

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

   494

        else:

   495

            bbx_x = self.Pos.x

   496

            bbx_width = self.Size[0]

   497

            bbx_y = self.Pos.y

   498

            bbx_height = self.Size[1]

   499

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

   500

   501

    # Returns the block minimum size

   502

    def GetMinSize(self):

   503

        return LD_ELEMENT_SIZE

   504

   505

    # Refresh the position of wire connected to contact

   506

    def RefreshConnected(self, exclude = []):

   507

        self.Input.MoveConnected(exclude)

   508

        self.Output.MoveConnected(exclude)

   509

   510

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

   511

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

   512

        # if a name is given

   513

        if name is not None:

   514

            # Test input and output connector

   515

            #if name == self.Input.GetName():

   516

            #    return self.Input

   517

            if name == self.Output.GetName():

   518

                return self.Output

   519

        return self.FindNearestConnector(position, [self.Input, self.Output])

   520

   521

    # Returns input and output contact connectors 

   522

    def GetConnectors(self):

   523

        return {"inputs": [self.Input], "outputs": [self.Output]}

   524

   525

    # Test if point given is on contact input or output connector

   526

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

   527

        # Test input connector

   528

        if self.Input.TestPoint(pt, direction, exclude):

   529

            return self.Input