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 GraphicCommons import *

    28

from plcopen.structures import *

    29

    30

def GetWireSize(block):

    31

    if isinstance(block, SFC_Step):

    32

        return SFC_WIRE_MIN_SIZE + block.GetActionExtraLineNumber() * SFC_ACTION_MIN_SIZE[1]

    33

    else:

    34

        return SFC_WIRE_MIN_SIZE

    35

    36

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

    37

#                         Sequencial Function Chart Step

    38

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

    39

    40

"""

    41

Class that implements the graphic representation of a step

    42

"""

    43

    44

class SFC_Step(Graphic_Element):

    45

    46

    # Create a new step

    47

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

    48

        Graphic_Element.__init__(self, parent)

    49

        self.SetName(name)

    50

        self.Initial = initial

    51

        self.Id = id

    52

        self.Error = None

    53

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

    54

        # Create an input and output connector

    55

        if not self.Initial:

    56

            self.Input = Connector(self, "", None, wx.Point(self.Size[0] / 2, 0), NORTH)

    57

        else:

    58

            self.Input = None

    59

        self.Output = None

    60

        self.Action = None

    61

        self.Value = None

    62

        self.PreviousValue = None

    63

        self.PreviousSpreading = False

    64

    65

    def Flush(self):

    66

        if self.Input is not None:

    67

            self.Input.Flush()

    68

            self.Input = None

    69

        if self.Output is not None:

    70

            self.Output.Flush()

    71

            self.Output = None

    72

        if self.Output is not None:

    73

            self.Action.Flush()

    74

            self.Action = None

    75

    76

    def SetValue(self, value):

    77

        self.PreviousValue = self.Value

    78

        self.Value = value

    79

        if self.Value != self.PreviousValue:

    80

            self.Refresh()

    81

            self.SpreadCurrent()

    82

    83

    def SpreadCurrent(self):

    84

        if self.Parent.Debug:

    85

            spreading = self.Value

    86

            if spreading and not self.PreviousSpreading:

    87

                if self.Output is not None:

    88

                    self.Output.SpreadCurrent(True)

    89

                if self.Action is not None:

    90

                    self.Action.SpreadCurrent(True)

    91

            elif not spreading and self.PreviousSpreading:

    92

                if self.Output is not None:

    93

                    self.Output.SpreadCurrent(False)

    94

                if self.Action is not None:

    95

                    self.Action.SpreadCurrent(False)

    96

            self.PreviousSpreading = spreading

    97

    98

    # Make a clone of this SFC_Step

    99

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

   100

        step = SFC_Step(parent, name, self.Initial, id)

   101

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

   102

        if pos is not None:

   103

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

   104

        if self.Input:

   105

            step.Input = self.Input.Clone(step)

   106

        if self.Output:

   107

            step.Output = self.Output.Clone(step)

   108

        if self.Action:

   109

            step.Action = self.Action.Clone(step)

   110

        return step

   111

   112

    # Returns the RedrawRect

   113

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

   114

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

   115

        if self.Input:

   116

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

   117

        if self.Output:

   118

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

   119

        if self.Action:

   120

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

   121

        if movex != 0 or movey != 0:

   122

            if self.Input and self.Input.IsConnected():

   123

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

   124

            if self.Output and self.Output.IsConnected():

   125

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

   126

            if self.Action and self.Action.IsConnected():

   127

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

   128

        return rect

   129

   130

    # Delete this step by calling the appropriate method

   131

    def Delete(self):

   132

        self.Parent.DeleteStep(self)

   133

   134

    # Unconnect input and output

   135

    def Clean(self):

   136

        if self.Input:

   137

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

   138

        if self.Output:

   139

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

   140

        if self.Action:

   141

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

   142

   143

    # Refresh the size of text for name

   144

    def RefreshNameSize(self):

   145

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

   146

   147

    # Add output connector to step

   148

    def AddInput(self):

   149

        if not self.Input:

   150

            self.Input = Connector(self, "", None, wx.Point(self.Size[0] / 2, 0), NORTH)

   151

            self.RefreshBoundingBox()

   152

   153

    # Remove output connector from step

   154

    def RemoveInput(self):

   155

        if self.Input:

   156

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

   157

            self.Input = None

   158

            self.RefreshBoundingBox()

   159

   160

    # Add output connector to step

   161

    def AddOutput(self):

   162

        if not self.Output:

   163

            self.Output = Connector(self, "", None, wx.Point(self.Size[0] / 2, self.Size[1]), SOUTH, onlyone = True)

   164

            self.RefreshBoundingBox()

   165

   166

    # Remove output connector from step

   167

    def RemoveOutput(self):

   168

        if self.Output:

   169

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

   170

            self.Output = None

   171

            self.RefreshBoundingBox()

   172

   173

    # Add action connector to step

   174

    def AddAction(self):

   175

        if not self.Action:

   176

            self.Action = Connector(self, "", None, wx.Point(self.Size[0], self.Size[1] / 2), EAST, onlyone = True)

   177

            self.RefreshBoundingBox()

   178

   179

    # Remove action connector from step

   180

    def RemoveAction(self):

   181

        if self.Action:

   182

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

   183

            self.Action = None

   184

            self.RefreshBoundingBox()

   185

   186

    # Refresh the step bounding box

   187

    def RefreshBoundingBox(self):

   188

        # Calculate the bounding box size

   189

        if self.Action:

   190

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   191

        else:

   192

            bbx_width = self.Size[0]

   193

        if self.Initial:

   194

            bbx_y = self.Pos.y

   195

            bbx_height = self.Size[1]

   196

            if self.Output:

   197

                bbx_height += CONNECTOR_SIZE

   198

        else:

   199

            bbx_y = self.Pos.y - CONNECTOR_SIZE

   200

            bbx_height = self.Size[1] + CONNECTOR_SIZE

   201

            if self.Output:

   202

                bbx_height += CONNECTOR_SIZE

   203

        #self.BoundingBox = wx.Rect(self.Pos.x, bbx_y, bbx_width + 1, bbx_height + 1)

   204

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

   205

   206

    # Refresh the positions of the step connectors

   207

    def RefreshConnectors(self):

   208

        scaling = self.Parent.GetScaling()

   209

        horizontal_pos = self.Size[0] / 2

   210

        vertical_pos = self.Size[1] / 2

   211

        if scaling is not None:

   212

            horizontal_pos = round(float(self.Pos.x + horizontal_pos) / float(scaling[0])) * scaling[0] - self.Pos.x

   213

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

   214

        # Update input position if it exists

   215

        if self.Input:

   216

            self.Input.SetPosition(wx.Point(horizontal_pos, 0))

   217

        # Update output position

   218

        if self.Output:

   219

            self.Output.SetPosition(wx.Point(horizontal_pos, self.Size[1]))

   220

        # Update action position if it exists

   221

        if self.Action:

   222

            self.Action.SetPosition(wx.Point(self.Size[0], vertical_pos))

   223

        self.RefreshConnected()

   224

   225

    # Refresh the position of wires connected to step

   226

    def RefreshConnected(self, exclude = []):

   227

        if self.Input:

   228

            self.Input.MoveConnected(exclude)

   229

        if self.Output:

   230

            self.Output.MoveConnected(exclude)

   231

        if self.Action:

   232

            self.Action.MoveConnected(exclude)

   233

   234

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

   235

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

   236

        # if a name is given

   237

        if name:

   238

            # Test input, output and action connector if they exists

   239

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

   240

                return self.Input

   241

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

   242

                return self.Output

   243

            if self.Action and name == self.Action.GetName():

   244

                return self.Action

   245

        # Test input connector if it exists

   246

        if self.Input:

   247

            input_pos = self.Input.GetRelPosition()

   248

            if position.x == self.Pos.x + input_pos.x and position.y == self.Pos.y + input_pos.y:

   249

                return self.Input

   250

        # Test output connector if it exists

   251

        if self.Output:

   252

            output_pos = self.Output.GetRelPosition()

   253

            if position.x == self.Pos.x + output_pos.x and position.y == self.Pos.y + output_pos.y:

   254

                return self.Output

   255

        # Test action connector if it exists

   256

        if self.Action:

   257

            action_pos = self.Action.GetRelPosition()

   258

            if position.x == self.Pos.x + action_pos.x and position.y == self.Pos.y + action_pos.y:

   259

                return self.Action

   260

        return None

   261

   262

    # Returns input and output step connectors 

   263

    def GetConnectors(self):

   264

        return {"input":self.Input,"output":self.Output,"action":self.Action}

   265

   266

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

   267

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

   268

        # Test input connector if it exists

   269

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

   270

            return self.Input

   271

        # Test output connector

   272

        if self.Output and self.Output.TestPoint(pt, direction, exclude):

   273

            return self.Output

   274

        # Test action connector

   275

        if self.Action and self.Action.TestPoint(pt, direction, exclude):

   276

            return self.Action

   277

        return None

   278

   279

    # Changes the step name

   280

    def SetName(self, name):

   281

        self.Name = name

   282

        self.RefreshNameSize()

   283

   284

    # Returns the step name

   285

    def GetName(self):

   286

        return self.Name

   287

   288

    # Returns the step initial property

   289

    def GetInitial(self):

   290

        return self.Initial

   291

   292

    # Returns the connector connected to input

   293

    def GetPreviousConnector(self):

   294

        if self.Input:

   295

            wires = self.Input.GetWires()

   296

            if len(wires) == 1:

   297

                return wires[0][0].GetOtherConnected(self.Input)

   298

        return None

   299

   300

    # Returns the connector connected to output

   301

    def GetNextConnector(self):

   302

        if self.Output:

   303

            wires = self.Output.GetWires()

   304

            if len(wires) == 1:

   305

                return wires[0][0].GetOtherConnected(self.Output)

   306

        return None

   307

   308

    # Returns the connector connected to action

   309

    def GetActionConnector(self):

   310

        if self.Action:

   311

            wires = self.Action.GetWires()

   312

            if len(wires) == 1:

   313

                return wires[0][0].GetOtherConnected(self.Action)

   314

        return None

   315

   316

    # Returns the number of action line

   317

    def GetActionExtraLineNumber(self):

   318

        if self.Action:

   319

            wires = self.Action.GetWires()

   320

            if len(wires) != 1:

   321

                return 0

   322

            action_block = wires[0][0].GetOtherConnected(self.Action).GetParentBlock()

   323

            return max(0, action_block.GetLineNumber() - 1)

   324

        return 0

   325

   326

    # Returns the step minimum size

   327

    def GetMinSize(self):

   328

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

   329

        if self.Initial:

   330

            return text_width + 14, text_height + 14

   331

        else:

   332

            return text_width + 10, text_height + 10

   333

   334

    # Updates the step size

   335

    def UpdateSize(self, width, height):

   336

        diffx = self.Size.GetWidth() / 2 - width / 2

   337

        diffy = height - self.Size.GetHeight()

   338

        self.Move(diffx, 0)

   339

        Graphic_Element.SetSize(self, width, height)

   340

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

   341

            self.RefreshConnected()

   342

        else:

   343

            self.RefreshOutputPosition((0, diffy))

   344

   345

    # Align input element with this step

   346

    def RefreshInputPosition(self):

   347

        if self.Input:

   348

            current_pos = self.Input.GetPosition(False)

   349

            input = self.GetPreviousConnector()

   350

            if input:

   351

                input_pos = input.GetPosition(False)

   352

                diffx = current_pos.x - input_pos.x

   353

                input_block = input.GetParentBlock()

   354

                if isinstance(input_block, SFC_Divergence):

   355

                    input_block.MoveConnector(input, diffx)

   356

                else:

   357

                    if isinstance(input_block, SFC_Step):

   358

                        input_block.MoveActionBlock((diffx, 0))

   359

                    input_block.Move(diffx, 0)

   360

                    input_block.RefreshInputPosition()

   361

   362

    # Align output element with this step

   363

    def RefreshOutputPosition(self, move = None):

   364

        if self.Output:

   365

            wires = self.Output.GetWires()

   366

            if len(wires) != 1:

   367

                return

   368

            current_pos = self.Output.GetPosition(False)

   369

            output = wires[0][0].GetOtherConnected(self.Output)

   370

            output_pos = output.GetPosition(False)

   371

            diffx = current_pos.x - output_pos.x

   372

            output_block = output.GetParentBlock()

   373

            wire_size = SFC_WIRE_MIN_SIZE + self.GetActionExtraLineNumber() * SFC_ACTION_MIN_SIZE[1]

   374

            diffy = wire_size - output_pos.y + current_pos.y

   375

            if diffy != 0:

   376

                if isinstance(output_block, SFC_Step):

   377

                    output_block.MoveActionBlock((diffx, diffy))

   378

                wires[0][0].SetPoints([wx.Point(current_pos.x, current_pos.y + wire_size),

   379

                    wx.Point(current_pos.x, current_pos.y)])

   380

                if not isinstance(output_block, SFC_Divergence) or output_block.GetConnectors()["inputs"].index(output) == 0:

   381

                    output_block.Move(diffx, diffy, self.Parent.Wires)

   382

                    output_block.RefreshOutputPosition((diffx, diffy))

   383

                else:

   384

                    output_block.RefreshPosition()

   385

            elif move:

   386

                if isinstance(output_block, SFC_Step):

   387

                    output_block.MoveActionBlock(move)

   388

                wires[0][0].Move(move[0], move[1], True)

   389

                if not isinstance(output_block, SFC_Divergence) or output_block.GetConnectors()["inputs"].index(output) == 0:

   390

                    output_block.Move(move[0], move[1], self.Parent.Wires)

   391

                    output_block.RefreshOutputPosition(move)

   392

                else:

   393

                    output_block.RefreshPosition()

   394

            elif isinstance(output_block, SFC_Divergence):

   395

                output_block.MoveConnector(output, diffx)

   396

            else:

   397

                if isinstance(output_block, SFC_Step):

   398

                    output_block.MoveActionBlock((diffx, 0))

   399

                output_block.Move(diffx, 0)

   400

                output_block.RefreshOutputPosition()

   401

   402

    # Refresh action element with this step

   403

    def MoveActionBlock(self, move):

   404

        if self.Action:

   405

            wires = self.Action.GetWires()

   406

            if len(wires) != 1:

   407

                return

   408

            action_block = wires[0][0].GetOtherConnected(self.Action).GetParentBlock()

   409

            action_block.Move(move[0], move[1], self.Parent.Wires)

   410

            wires[0][0].Move(move[0], move[1], True)

   411

   412

    # Resize the divergence from position and size given

   413

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

   414

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

   415

            self.UpdateSize(width, height)

   416

        else:

   417

            Graphic_Element.Resize(self, x, y, width, height)

   418

   419

    # Method called when a LeftDClick event have been generated

   420

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

   421

        # Edit the step properties

   422

        self.Parent.EditStepContent(self)

   423

   424

    # Method called when a RightUp event have been generated

   425

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

   426

        # Popup the menu with special items for a step

   427

        self.Parent.PopupDefaultMenu()

   428

   429

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

   430

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

   431

        handle_type, handle = self.Handle

   432

        if handle_type == HANDLE_MOVE:

   433

            movex = max(-self.BoundingBox.x, movex)

   434

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

   435

            if scaling is not None:

   436

                movex = round(float(self.Pos.x + movex) / float(scaling[0])) * scaling[0] - self.Pos.x

   437

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

   438

            action_block = None

   439

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

   440

                self.Move(movex, movey)

   441

                self.RefreshConnected()

   442

                return movex, movey

   443

            elif self.Initial:

   444

                self.MoveActionBlock((movex, movey))

   445

                self.Move(movex, movey, self.Parent.Wires)

   446

                self.RefreshOutputPosition((movex, movey))

   447

                return movex, movey

   448

            else:

   449

                self.MoveActionBlock((movex, 0))

   450

                self.Move(movex, 0)

   451

                self.RefreshInputPosition()

   452

                self.RefreshOutputPosition()

   453

                return movex, 0

   454

        else:

   455

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

   456

   457

    # Refresh input element model

   458

    def RefreshInputModel(self):

   459

        if self.Input:

   460

            input = self.GetPreviousConnector()

   461

            if input:                

   462

                input_block = input.GetParentBlock()

   463

                input_block.RefreshModel(False)

   464

                if not isinstance(input_block, SFC_Divergence):

   465

                    input_block.RefreshInputModel()

   466

   467

    # Refresh output element model

   468

    def RefreshOutputModel(self, move=False):

   469

        if self.Output:

   470

            output = self.GetNextConnector()

   471

            if output:

   472

                output_block = output.GetParentBlock()

   473

                output_block.RefreshModel(False)

   474

                if not isinstance(output_block, SFC_Divergence) or move:

   475

                    output_block.RefreshOutputModel(move)

   476

   477

    # Refreshes the step model

   478

    def RefreshModel(self, move=True):

   479

        self.Parent.RefreshStepModel(self)

   480

        if self.Action:

   481

            action = self.GetActionConnector()

   482

            if action:

   483

                action_block = action.GetParentBlock()

   484

                action_block.RefreshModel(False)

   485

        # If step has moved, refresh the model of wires connected to output

   486

        if move:

   487

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

   488

                self.RefreshInputModel()

   489

                self.RefreshOutputModel(self.Initial)

   490

            elif self.Output:

   491

                self.Output.RefreshWires()

   492

   493

    def AddError(self, infos, start, end):

   494

        if infos[0] == "name" and start[0] == 0 and end[0] == 0:

   495

            self.Error = (start[1], end[1])

   496

   497

    # Draws step

   498

    def Draw(self, dc):

   499

        Graphic_Element.Draw(self, dc)

   500

        if self.Value:

   501

            dc.SetPen(wx.GREEN_PEN)

   502

        else:

   503

            dc.SetPen(wx.BLACK_PEN)

   504

        dc.SetBrush(wx.WHITE_BRUSH)

   505

   506

        if getattr(dc, "printing", False):

   507

            name_size = dc.GetTextExtent(self.Name)

   508

        else:

   509

            name_size = self.NameSize