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, DebugDataConsumer):

    45

    46

    # Create a new step

    47

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

    48

        Graphic_Element.__init__(self, parent)

    49

        DebugDataConsumer.__init__(self)

    50

        self.SetName(name)

    51

        self.Initial = initial

    52

        self.Id = id

    53

        self.Highlights = []

    54

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

    55

        # Create an input and output connector

    56

        if not self.Initial:

    57

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

    58

        else:

    59

            self.Input = None

    60

        self.Output = None

    61

        self.Action = 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 SetForced(self, forced):

    77

        if self.Forced != forced:

    78

            self.Forced = forced

    79

            if self.Visible:

    80

                self.Parent.ElementNeedRefresh(self)

    81

    82

    def SetValue(self, value):

    83

        self.PreviousValue = self.Value

    84

        self.Value = value

    85

        if self.Value != self.PreviousValue:

    86

            if self.Visible:

    87

                self.Parent.ElementNeedRefresh(self)

    88

            self.SpreadCurrent()

    89

    90

    def SpreadCurrent(self):

    91

        if self.Parent.Debug:

    92

            spreading = self.Value

    93

            if spreading and not self.PreviousSpreading:

    94

                if self.Output is not None:

    95

                    self.Output.SpreadCurrent(True)

    96

                if self.Action is not None:

    97

                    self.Action.SpreadCurrent(True)

    98

            elif not spreading and self.PreviousSpreading:

    99

                if self.Output is not None:

   100

                    self.Output.SpreadCurrent(False)

   101

                if self.Action is not None:

   102

                    self.Action.SpreadCurrent(False)

   103

            self.PreviousSpreading = spreading

   104

   105

    # Make a clone of this SFC_Step

   106

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

   107

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

   108

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

   109

        if pos is not None:

   110

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

   111

        else:

   112

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

   113

        if self.Input:

   114

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

   115

        if self.Output:

   116

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

   117

        if self.Action:

   118

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

   119

        return step

   120

   121

    def GetConnectorTranslation(self, element):

   122

        connectors = {}

   123

        if self.Input is not None:

   124

            connectors[self.Input] = element.Input

   125

        if self.Output is not None:

   126

            connectors[self.Output] = element.Output

   127

        if self.Action is not None:

   128

            connectors[self.Action] = element.Action

   129

        return connectors

   130

   131

    # Returns the RedrawRect

   132

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

   133

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

   134

        if self.Input:

   135

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

   136

        if self.Output:

   137

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

   138

        if self.Action:

   139

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

   140

        if movex != 0 or movey != 0:

   141

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

   142

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

   143

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

   144

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

   145

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

   146

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

   147

        return rect

   148

   149

    # Delete this step by calling the appropriate method

   150

    def Delete(self):

   151

        self.Parent.DeleteStep(self)

   152

   153

    # Unconnect input and output

   154

    def Clean(self):

   155

        if self.Input:

   156

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

   157

        if self.Output:

   158

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

   159

        if self.Action:

   160

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

   161

   162

    # Refresh the size of text for name

   163

    def RefreshNameSize(self):

   164

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

   165

   166

    # Add output connector to step

   167

    def AddInput(self):

   168

        if not self.Input:

   169

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

   170

            self.RefreshBoundingBox()

   171

   172

    # Remove output connector from step

   173

    def RemoveInput(self):

   174

        if self.Input:

   175

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

   176

            self.Input = None

   177

            self.RefreshBoundingBox()

   178

   179

    # Add output connector to step

   180

    def AddOutput(self):

   181

        if not self.Output:

   182

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

   183

            self.RefreshBoundingBox()

   184

   185

    # Remove output connector from step

   186

    def RemoveOutput(self):

   187

        if self.Output:

   188

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

   189

            self.Output = None

   190

            self.RefreshBoundingBox()

   191

   192

    # Add action connector to step

   193

    def AddAction(self):

   194

        if not self.Action:

   195

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

   196

            self.RefreshBoundingBox()

   197

   198

    # Remove action connector from step

   199

    def RemoveAction(self):

   200

        if self.Action:

   201

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

   202

            self.Action = None

   203

            self.RefreshBoundingBox()

   204

   205

    # Refresh the step bounding box

   206

    def RefreshBoundingBox(self):

   207

        # Calculate the bounding box size

   208

        if self.Action:

   209

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   210

        else:

   211

            bbx_width = self.Size[0]

   212

        if self.Initial:

   213

            bbx_y = self.Pos.y

   214

            bbx_height = self.Size[1]

   215

            if self.Output:

   216

                bbx_height += CONNECTOR_SIZE

   217

        else:

   218

            bbx_y = self.Pos.y - CONNECTOR_SIZE

   219

            bbx_height = self.Size[1] + CONNECTOR_SIZE

   220

            if self.Output:

   221

                bbx_height += CONNECTOR_SIZE

   222

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

   223

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

   224

   225

    # Refresh the positions of the step connectors

   226

    def RefreshConnectors(self):

   227

        scaling = self.Parent.GetScaling()

   228

        horizontal_pos = self.Size[0] / 2

   229

        vertical_pos = self.Size[1] / 2

   230

        if scaling is not None:

   231

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

   232

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

   233

        # Update input position if it exists

   234

        if self.Input:

   235

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

   236

        # Update output position

   237

        if self.Output:

   238

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

   239

        # Update action position if it exists

   240

        if self.Action:

   241

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

   242

        self.RefreshConnected()

   243

   244

    # Refresh the position of wires connected to step

   245

    def RefreshConnected(self, exclude = []):

   246

        if self.Input:

   247

            self.Input.MoveConnected(exclude)

   248

        if self.Output:

   249

            self.Output.MoveConnected(exclude)

   250

        if self.Action:

   251

            self.Action.MoveConnected(exclude)

   252

   253

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

   254

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

   255

        # if a name is given

   256

        if name is not None:

   257

            # Test input, output and action connector if they exists

   258

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

   259

            #    return self.Input

   260

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

   261

                return self.Output

   262

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

   263

                return self.Action

   264

        connectors = []

   265

        # Test input connector if it exists

   266

        if self.Input:

   267

            connectors.append(self.Input)

   268

        # Test output connector if it exists

   269

        if self.Output:

   270

            connectors.append(self.Output)

   271

        # Test action connector if it exists

   272

        if self.Action:

   273

            connectors.append(self.Action)

   274

        return self.FindNearestConnector(position, connectors)

   275

   276

    # Returns action step connector 

   277

    def GetActionConnector(self):

   278

        return self.Action

   279

   280

    # Returns input and output step connectors 

   281

    def GetConnectors(self):

   282

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

   283

        if self.Input:

   284

            connectors["inputs"].append(self.Input)

   285

        if self.Output:

   286

            connectors["outputs"].append(self.Output)

   287

        return connectors

   288

   289

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

   290

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

   291

        # Test input connector if it exists

   292

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

   293

            return self.Input

   294

        # Test output connector

   295

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

   296

            return self.Output

   297

        # Test action connector

   298

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

   299

            return self.Action

   300

        return None

   301

   302

    # Changes the step name

   303

    def SetName(self, name):

   304

        self.Name = name

   305

        self.RefreshNameSize()

   306

   307

    # Returns the step name

   308

    def GetName(self):

   309

        return self.Name

   310

   311

    # Returns the step initial property

   312

    def GetInitial(self):

   313

        return self.Initial

   314

   315

    # Returns the connector connected to input

   316

    def GetPreviousConnector(self):

   317

        if self.Input:

   318

            wires = self.Input.GetWires()

   319

            if len(wires) == 1:

   320

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

   321

        return None

   322

   323

    # Returns the connector connected to output

   324

    def GetNextConnector(self):

   325

        if self.Output:

   326

            wires = self.Output.GetWires()

   327

            if len(wires) == 1:

   328

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

   329

        return None

   330

   331

    # Returns the connector connected to action

   332

    def GetActionConnected(self):

   333

        if self.Action:

   334

            wires = self.Action.GetWires()

   335

            if len(wires) == 1:

   336

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

   337

        return None

   338

   339

    # Returns the number of action line

   340

    def GetActionExtraLineNumber(self):

   341

        if self.Action:

   342

            wires = self.Action.GetWires()

   343

            if len(wires) != 1:

   344

                return 0

   345

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

   346

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

   347

        return 0

   348

   349

    # Returns the step minimum size

   350

    def GetMinSize(self):

   351

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

   352

        if self.Initial:

   353

            return text_width + 14, text_height + 14

   354

        else:

   355

            return text_width + 10, text_height + 10

   356

   357

    # Updates the step size

   358

    def UpdateSize(self, width, height):

   359

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

   360

        diffy = height - self.Size.GetHeight()

   361

        self.Move(diffx, 0)

   362

        Graphic_Element.SetSize(self, width, height)

   363

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

   364

            self.RefreshConnected()

   365

        else:

   366

            self.RefreshOutputPosition((0, diffy))

   367

   368

    # Align input element with this step

   369

    def RefreshInputPosition(self):

   370

        if self.Input:

   371

            current_pos = self.Input.GetPosition(False)

   372

            input = self.GetPreviousConnector()

   373

            if input:

   374

                input_pos = input.GetPosition(False)

   375

                diffx = current_pos.x - input_pos.x

   376

                input_block = input.GetParentBlock()

   377

                if isinstance(input_block, SFC_Divergence):

   378

                    input_block.MoveConnector(input, diffx)

   379

                else:

   380

                    if isinstance(input_block, SFC_Step):

   381

                        input_block.MoveActionBlock((diffx, 0))

   382

                    input_block.Move(diffx, 0)

   383

                    input_block.RefreshInputPosition()

   384

   385

    # Align output element with this step

   386

    def RefreshOutputPosition(self, move = None):

   387

        if self.Output:

   388

            wires = self.Output.GetWires()

   389

            if len(wires) != 1:

   390

                return

   391

            current_pos = self.Output.GetPosition(False)

   392

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

   393

            output_pos = output.GetPosition(False)

   394

            diffx = current_pos.x - output_pos.x

   395

            output_block = output.GetParentBlock()

   396

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

   397

            diffy = wire_size - output_pos.y + current_pos.y

   398

            if diffy != 0:

   399

                if isinstance(output_block, SFC_Step):

   400

                    output_block.MoveActionBlock((diffx, diffy))

   401

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

   402

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

   403

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

   404

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

   405

                    output_block.RefreshOutputPosition((diffx, diffy))

   406

                else:

   407

                    output_block.RefreshPosition()

   408

            elif move:

   409

                if isinstance(output_block, SFC_Step):

   410

                    output_block.MoveActionBlock(move)

   411

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

   412

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

   413

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

   414

                    output_block.RefreshOutputPosition(move)

   415

                else:

   416

                    output_block.RefreshPosition()

   417

            elif isinstance(output_block, SFC_Divergence):

   418

                output_block.MoveConnector(output, diffx)

   419

            else:

   420

                if isinstance(output_block, SFC_Step):

   421

                    output_block.MoveActionBlock((diffx, 0))

   422

                output_block.Move(diffx, 0)

   423

                output_block.RefreshOutputPosition()

   424

   425

    # Refresh action element with this step

   426

    def MoveActionBlock(self, move):

   427

        if self.Action:

   428

            wires = self.Action.GetWires()

   429

            if len(wires) != 1:

   430

                return

   431

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

   432

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

   433

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

   434

   435

    # Resize the divergence from position and size given

   436

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

   437

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

   438

            self.UpdateSize(width, height)

   439

        else:

   440

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

   441

   442

    # Method called when a LeftDClick event have been generated

   443

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

   444

        # Edit the step properties

   445

        self.Parent.EditStepContent(self)

   446

   447

    # Method called when a RightUp event have been generated

   448

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

   449

        # Popup the menu with special items for a step

   450

        self.Parent.PopupDefaultMenu()

   451

   452

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

   453

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

   454

        handle_type, handle = self.Handle

   455

        if handle_type == HANDLE_MOVE:

   456

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

   457

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

   458

            if scaling is not None:

   459

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

   460

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

   461

            action_block = None

   462

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

   463

                self.Move(movex, movey)

   464

                self.RefreshConnected()

   465

                return movex, movey

   466

            elif self.Initial:

   467

                self.MoveActionBlock((movex, movey))

   468

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

   469

                self.RefreshOutputPosition((movex, movey))

   470

                return movex, movey

   471

            else:

   472

                self.MoveActionBlock((movex, 0))

   473

                self.Move(movex, 0)

   474

                self.RefreshInputPosition()

   475

                self.RefreshOutputPosition()

   476

                return movex, 0

   477

        else:

   478

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

   479

   480

    # Refresh input element model

   481

    def RefreshInputModel(self):

   482

        if self.Input:

   483

            input = self.GetPreviousConnector()

   484

            if input:                

   485

                input_block = input.GetParentBlock()

   486

                input_block.RefreshModel(False)

   487

                if not isinstance(input_block, SFC_Divergence):

   488

                    input_block.RefreshInputModel()

   489

   490

    # Refresh output element model

   491

    def RefreshOutputModel(self, move=False):

   492

        if self.Output:

   493

            output = self.GetNextConnector()

   494

            if output:

   495

                output_block = output.GetParentBlock()

   496

                output_block.RefreshModel(False)

   497

                if not isinstance(output_block, SFC_Divergence) or move:

   498

                    output_block.RefreshOutputModel(move)

   499

   500

    # Refreshes the step model

   501

    def RefreshModel(self, move=True):

   502

        self.Parent.RefreshStepModel(self)

   503

        if self.Action:

   504

            action = self.GetActionConnected()

   505

            if action:

   506

                action_block = action.GetParentBlock()

   507

                action_block.RefreshModel(False)

   508

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

   509

        if move:

   510

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

   511

                self.RefreshInputModel()

   512

                self.RefreshOutputModel(self.Initial)

   513

            elif self.Output:

   514

                self.Output.RefreshWires()

   515

   516

    # Adds an highlight to the connection

   517

    def AddHighlight(self, infos, start, end, highlight_type):

   518

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

   519

            AddHighlight(self.Highlights, (start, end, highlight_type))

   520

   521

    # Removes an highlight from the connection

   522

    def RemoveHighlight(self, infos, start, end, highlight_type):

   523

        if infos[0] == "name":

   524

            RemoveHighlight(self.Highlights, (start, end, highlight_type))

   525

   526

    # Removes all the highlights of one particular type from the connection

   527

    def ClearHighlight(self, highlight_type=None):

   528

        ClearHighlights(self.Highlights, highlight_type)

   529

   530