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

def GetWireSize(block):

    35

    if isinstance(block, SFC_Step):

    36

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

    37

    else:

    38

        return SFC_WIRE_MIN_SIZE

    39

    40

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

    41

#                         Sequencial Function Chart Step

    42

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

    43

    44

    45

class SFC_Step(Graphic_Element, DebugDataConsumer):

    46

    """

    47

    Class that implements the graphic representation of a step

    48

    """

    49

    50

    # Create a new step

    51

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

    52

        Graphic_Element.__init__(self, parent)

    53

        DebugDataConsumer.__init__(self)

    54

        self.SetName(name)

    55

        self.Initial = initial

    56

        self.Id = id

    57

        self.Highlights = []

    58

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

    59

        # Create an input and output connector

    60

        if not self.Initial:

    61

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

    62

        else:

    63

            self.Input = None

    64

        self.Output = None

    65

        self.Action = None

    66

        self.PreviousValue = None

    67

        self.PreviousSpreading = False

    68

    69

    def Flush(self):

    70

        if self.Input is not None:

    71

            self.Input.Flush()

    72

            self.Input = None

    73

        if self.Output is not None:

    74

            self.Output.Flush()

    75

            self.Output = None

    76

        if self.Action is not None:

    77

            self.Action.Flush()

    78

            self.Action = None

    79

    80

    def SetForced(self, forced):

    81

        if self.Forced != forced:

    82

            self.Forced = forced

    83

            if self.Visible:

    84

                self.Parent.ElementNeedRefresh(self)

    85

    86

    def SetValue(self, value):

    87

        self.PreviousValue = self.Value

    88

        self.Value = value

    89

        if self.Value != self.PreviousValue:

    90

            if self.Visible:

    91

                self.Parent.ElementNeedRefresh(self)

    92

            self.SpreadCurrent()

    93

    94

    def SpreadCurrent(self):

    95

        if self.Parent.Debug:

    96

            spreading = self.Value

    97

            if spreading and not self.PreviousSpreading:

    98

                if self.Output is not None:

    99

                    self.Output.SpreadCurrent(True)

   100

                if self.Action is not None:

   101

                    self.Action.SpreadCurrent(True)

   102

            elif not spreading and self.PreviousSpreading:

   103

                if self.Output is not None:

   104

                    self.Output.SpreadCurrent(False)

   105

                if self.Action is not None:

   106

                    self.Action.SpreadCurrent(False)

   107

            self.PreviousSpreading = spreading

   108

   109

    # Make a clone of this SFC_Step

   110

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

   111

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

   112

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

   113

        if pos is not None:

   114

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

   115

        else:

   116

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

   117

        if self.Input:

   118

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

   119

        if self.Output:

   120

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

   121

        if self.Action:

   122

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

   123

        return step

   124

   125

    def GetConnectorTranslation(self, element):

   126

        connectors = {}

   127

        if self.Input is not None:

   128

            connectors[self.Input] = element.Input

   129

        if self.Output is not None:

   130

            connectors[self.Output] = element.Output

   131

        if self.Action is not None:

   132

            connectors[self.Action] = element.Action

   133

        return connectors

   134

   135

    # Returns the RedrawRect

   136

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

   137

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

   138

        if self.Input:

   139

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

   140

        if self.Output:

   141

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

   142

        if self.Action:

   143

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

   144

        if movex != 0 or movey != 0:

   145

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

   146

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

   147

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

   148

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

   149

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

   150

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

   151

        return rect

   152

   153

    # Delete this step by calling the appropriate method

   154

    def Delete(self):

   155

        self.Parent.DeleteStep(self)

   156

   157

    # Unconnect input and output

   158

    def Clean(self):

   159

        if self.Input:

   160

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

   161

        if self.Output:

   162

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

   163

        if self.Action:

   164

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

   165

   166

    # Refresh the size of text for name

   167

    def RefreshNameSize(self):

   168

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

   169

   170

    # Add output connector to step

   171

    def AddInput(self):

   172

        if not self.Input:

   173

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

   174

            self.RefreshBoundingBox()

   175

   176

    # Remove output connector from step

   177

    def RemoveInput(self):

   178

        if self.Input:

   179

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

   180

            self.Input = None

   181

            self.RefreshBoundingBox()

   182

   183

    # Add output connector to step

   184

    def AddOutput(self):

   185

        if not self.Output:

   186

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

   187

            self.RefreshBoundingBox()

   188

   189

    # Remove output connector from step

   190

    def RemoveOutput(self):

   191

        if self.Output:

   192

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

   193

            self.Output = None

   194

            self.RefreshBoundingBox()

   195

   196

    # Add action connector to step

   197

    def AddAction(self):

   198

        if not self.Action:

   199

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

   200

            self.RefreshBoundingBox()

   201

   202

    # Remove action connector from step

   203

    def RemoveAction(self):

   204

        if self.Action:

   205

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

   206

            self.Action = None

   207

            self.RefreshBoundingBox()

   208

   209

    # Refresh the step bounding box

   210

    def RefreshBoundingBox(self):

   211

        # TODO: check and remove dead coded

   212

        #

   213

        # Calculate the bounding box size

   214

        # if self.Action:

   215

        #     bbx_width = self.Size[0] + CONNECTOR_SIZE

   216

        # else:

   217

        #     bbx_width = self.Size[0]

   218

        # if self.Initial:

   219

        #     bbx_y = self.Pos.y

   220

        #     bbx_height = self.Size[1]

   221

        #     if self.Output:

   222

        #         bbx_height += CONNECTOR_SIZE

   223

        # else:

   224

        #     bbx_y = self.Pos.y - CONNECTOR_SIZE

   225

        #     bbx_height = self.Size[1] + CONNECTOR_SIZE

   226

        #     if self.Output:

   227

        #         bbx_height += CONNECTOR_SIZE

   228

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

   229

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

   230

   231

    # Refresh the positions of the step connectors

   232

    def RefreshConnectors(self):

   233

        scaling = self.Parent.GetScaling()

   234

        horizontal_pos = self.Size[0] / 2

   235

        vertical_pos = self.Size[1] / 2

   236

        if scaling is not None:

   237

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

   238

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

   239

        # Update input position if it exists

   240

        if self.Input:

   241

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

   242

        # Update output position

   243

        if self.Output:

   244

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

   245

        # Update action position if it exists

   246

        if self.Action:

   247

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

   248

        self.RefreshConnected()

   249

   250

    # Refresh the position of wires connected to step

   251

    def RefreshConnected(self, exclude=None):

   252

        if self.Input:

   253

            self.Input.MoveConnected(exclude)

   254

        if self.Output:

   255

            self.Output.MoveConnected(exclude)

   256

        if self.Action:

   257

            self.Action.MoveConnected(exclude)

   258

   259

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

   260

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

   261

        # if a name is given

   262

        if name is not None:

   263

            # Test input, output and action connector if they exists

   264

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

   265

            #    return self.Input

   266

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

   267

                return self.Output

   268

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

   269

                return self.Action

   270

        connectors = []

   271

        # Test input connector if it exists

   272

        if self.Input:

   273

            connectors.append(self.Input)

   274

        # Test output connector if it exists

   275

        if self.Output:

   276

            connectors.append(self.Output)

   277

        # Test action connector if it exists

   278

        if self.Action:

   279

            connectors.append(self.Action)

   280

        return self.FindNearestConnector(position, connectors)

   281

   282

    # Returns action step connector

   283

    def GetActionConnector(self):

   284

        return self.Action

   285

   286

    # Returns input and output step connectors

   287

    def GetConnectors(self):

   288

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

   289

        if self.Input:

   290

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

   291

        if self.Output:

   292

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

   293

        return connectors

   294

   295

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

   296

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

   297

        # Test input connector if it exists

   298

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

   299

            return self.Input

   300

        # Test output connector

   301

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

   302

            return self.Output

   303

        # Test action connector

   304

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

   305

            return self.Action

   306

        return None

   307

   308

    # Changes the step name

   309

    def SetName(self, name):

   310

        self.Name = name

   311

        self.RefreshNameSize()

   312

   313

    # Returns the step name

   314

    def GetName(self):

   315

        return self.Name

   316

   317

    # Returns the step initial property

   318

    def GetInitial(self):

   319

        return self.Initial

   320

   321

    # Returns the connector connected to input

   322

    def GetPreviousConnector(self):

   323

        if self.Input:

   324

            wires = self.Input.GetWires()

   325

            if len(wires) == 1:

   326

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

   327

        return None

   328

   329

    # Returns the connector connected to output

   330

    def GetNextConnector(self):

   331

        if self.Output:

   332

            wires = self.Output.GetWires()

   333

            if len(wires) == 1:

   334

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

   335

        return None

   336

   337

    # Returns the connector connected to action

   338

    def GetActionConnected(self):

   339

        if self.Action:

   340

            wires = self.Action.GetWires()

   341

            if len(wires) == 1:

   342

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

   343

        return None

   344

   345

    # Returns the number of action line

   346

    def GetActionExtraLineNumber(self):

   347

        if self.Action:

   348

            wires = self.Action.GetWires()

   349

            if len(wires) != 1:

   350

                return 0

   351

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

   352

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

   353

        return 0

   354

   355

    # Returns the step minimum size

   356

    def GetMinSize(self):

   357

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

   358

        if self.Initial:

   359

            return text_width + 14, text_height + 14

   360

        else:

   361

            return text_width + 10, text_height + 10

   362

   363

    # Updates the step size

   364

    def UpdateSize(self, width, height):

   365

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

   366

        diffy = height - self.Size.GetHeight()

   367

        self.Move(diffx, 0)

   368

        Graphic_Element.SetSize(self, width, height)

   369

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

   370

            self.RefreshConnected()

   371

        else:

   372

            self.RefreshOutputPosition((0, diffy))

   373

   374

    # Align input element with this step

   375

    def RefreshInputPosition(self):

   376

        if self.Input:

   377

            current_pos = self.Input.GetPosition(False)

   378

            input = self.GetPreviousConnector()

   379

            if input:

   380

                input_pos = input.GetPosition(False)

   381

                diffx = current_pos.x - input_pos.x

   382

                input_block = input.GetParentBlock()

   383

                if isinstance(input_block, SFC_Divergence):

   384

                    input_block.MoveConnector(input, diffx)

   385

                else:

   386

                    if isinstance(input_block, SFC_Step):

   387

                        input_block.MoveActionBlock((diffx, 0))

   388

                    input_block.Move(diffx, 0)

   389

                    input_block.RefreshInputPosition()

   390

   391

    # Align output element with this step

   392

    def RefreshOutputPosition(self, move=None):

   393

        if self.Output:

   394

            wires = self.Output.GetWires()

   395

            if len(wires) != 1:

   396

                return

   397

            current_pos = self.Output.GetPosition(False)

   398

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

   399

            output_pos = output.GetPosition(False)

   400

            diffx = current_pos.x - output_pos.x

   401

            output_block = output.GetParentBlock()

   402

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

   403

            diffy = wire_size - output_pos.y + current_pos.y

   404

            if diffy != 0:

   405

                if isinstance(output_block, SFC_Step):

   406

                    output_block.MoveActionBlock((diffx, diffy))

   407

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

   408

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

   409

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

   410

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

   411

                    output_block.RefreshOutputPosition((diffx, diffy))

   412

                else:

   413

                    output_block.RefreshPosition()

   414

            elif move:

   415

                if isinstance(output_block, SFC_Step):

   416

                    output_block.MoveActionBlock(move)

   417

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

   418

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

   419

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

   420

                    output_block.RefreshOutputPosition(move)

   421

                else:

   422

                    output_block.RefreshPosition()

   423

            elif isinstance(output_block, SFC_Divergence):

   424

                output_block.MoveConnector(output, diffx)

   425

            else:

   426

                if isinstance(output_block, SFC_Step):

   427

                    output_block.MoveActionBlock((diffx, 0))

   428

                output_block.Move(diffx, 0)

   429

                output_block.RefreshOutputPosition()

   430

   431

    # Refresh action element with this step

   432

    def MoveActionBlock(self, move):

   433

        if self.Action:

   434

            wires = self.Action.GetWires()

   435

            if len(wires) != 1:

   436

                return

   437

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

   438

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

   439

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

   440

   441

    # Resize the divergence from position and size given

   442

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

   443

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

   444

            self.UpdateSize(width, height)

   445

        else:

   446

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

   447

   448

    # Method called when a LeftDClick event have been generated

   449

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

   450

        # Edit the step properties

   451

        self.Parent.EditStepContent(self)

   452

   453

    # Method called when a RightUp event have been generated

   454

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

   455

        # Popup the menu with special items for a step

   456

        self.Parent.PopupDefaultMenu()

   457

   458

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

   459

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

   460

        handle_type, _handle = self.Handle

   461

        if handle_type == HANDLE_MOVE:

   462

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

   463

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

   464

            if scaling is not None:

   465

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

   466

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

   467

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

   468

                self.Move(movex, movey)

   469

                self.RefreshConnected()

   470

                return movex, movey

   471

            elif self.Initial:

   472

                self.MoveActionBlock((movex, movey))

   473

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

   474

                self.RefreshOutputPosition((movex, movey))

   475

                return movex, movey

   476

            else:

   477

                self.MoveActionBlock((movex, 0))

   478

                self.Move(movex, 0)

   479

                self.RefreshInputPosition()

   480

                self.RefreshOutputPosition()

   481

                return movex, 0

   482

        else:

   483

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

   484

   485

    # Refresh input element model

   486

    def RefreshInputModel(self):

   487

        if self.Input:

   488

            input = self.GetPreviousConnector()

   489

            if input:

   490

                input_block = input.GetParentBlock()

   491

                input_block.RefreshModel(False)

   492

                if not isinstance(input_block, SFC_Divergence):

   493

                    input_block.RefreshInputModel()

   494

   495

    # Refresh output element model

   496

    def RefreshOutputModel(self, move=False):

   497

        if self.Output:

   498

            output = self.GetNextConnector()

   499

            if output:

   500

                output_block = output.GetParentBlock()

   501

                output_block.RefreshModel(False)

   502

                if not isinstance(output_block, SFC_Divergence) or move:

   503

                    output_block.RefreshOutputModel(move)

   504

   505

    # Refreshes the step model

   506

    def RefreshModel(self, move=True):

   507

        self.Parent.RefreshStepModel(self)

   508

        if self.Action:

   509

            action = self.GetActionConnected()

   510

            if action:

   511

                action_block = action.GetParentBlock()

   512

                action_block.RefreshModel(False)

   513

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