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

from __future__ import division

    28

from future.builtins import round

    29

    30

import wx

    31

from six.moves import xrange

    32

    33

from graphics.GraphicCommons import *

    34

from graphics.DebugDataConsumer import DebugDataConsumer

    35

from plcopen.structures import *

    36

    37

    38

def GetWireSize(block):

    39

    if isinstance(block, SFC_Step):

    40

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

    41

    else:

    42

        return SFC_WIRE_MIN_SIZE

    43

    44

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

    45

#                         Sequencial Function Chart Step

    46

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

    47

    48

    49

class SFC_Step(Graphic_Element, DebugDataConsumer):

    50

    """

    51

    Class that implements the graphic representation of a step

    52

    """

    53

    54

    # Create a new step

    55

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

    56

        Graphic_Element.__init__(self, parent)

    57

        DebugDataConsumer.__init__(self)

    58

        self.SetName(name)

    59

        self.Initial = initial

    60

        self.Id = id

    61

        self.Highlights = []

    62

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

    63

        # Create an input and output connector

    64

        if not self.Initial:

    65

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

    66

        else:

    67

            self.Input = None

    68

        self.Output = None

    69

        self.Action = None

    70

        self.PreviousValue = None

    71

        self.PreviousSpreading = False

    72

    73

    def Flush(self):

    74

        if self.Input is not None:

    75

            self.Input.Flush()

    76

            self.Input = None

    77

        if self.Output is not None:

    78

            self.Output.Flush()

    79

            self.Output = None

    80

        if self.Action is not None:

    81

            self.Action.Flush()

    82

            self.Action = None

    83

    84

    def SetForced(self, forced):

    85

        if self.Forced != forced:

    86

            self.Forced = forced

    87

            if self.Visible:

    88

                self.Parent.ElementNeedRefresh(self)

    89

    90

    def SetValue(self, value):

    91

        self.PreviousValue = self.Value

    92

        self.Value = value

    93

        if self.Value != self.PreviousValue:

    94

            if self.Visible:

    95

                self.Parent.ElementNeedRefresh(self)

    96

            self.SpreadCurrent()

    97

    98

    def SpreadCurrent(self):

    99

        if self.Parent.Debug:

   100

            spreading = self.Value

   101

            if spreading and not self.PreviousSpreading:

   102

                if self.Output is not None:

   103

                    self.Output.SpreadCurrent(True)

   104

                if self.Action is not None:

   105

                    self.Action.SpreadCurrent(True)

   106

            elif not spreading and self.PreviousSpreading:

   107

                if self.Output is not None:

   108

                    self.Output.SpreadCurrent(False)

   109

                if self.Action is not None:

   110

                    self.Action.SpreadCurrent(False)

   111

            self.PreviousSpreading = spreading

   112

   113

    # Make a clone of this SFC_Step

   114

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

   115

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

   116

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

   117

        if pos is not None:

   118

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

   119

        else:

   120

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

   121

        if self.Input:

   122

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

   123

        if self.Output:

   124

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

   125

        if self.Action:

   126

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

   127

        return step

   128

   129

    def GetConnectorTranslation(self, element):

   130

        connectors = {}

   131

        if self.Input is not None:

   132

            connectors[self.Input] = element.Input

   133

        if self.Output is not None:

   134

            connectors[self.Output] = element.Output

   135

        if self.Action is not None:

   136

            connectors[self.Action] = element.Action

   137

        return connectors

   138

   139

    # Returns the RedrawRect

   140

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

   141

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

   142

        if self.Input:

   143

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

   144

        if self.Output:

   145

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

   146

        if self.Action:

   147

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

   148

        if movex != 0 or movey != 0:

   149

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

   150

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

   151

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

   152

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

   153

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

   154

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

   155

        return rect

   156

   157

    # Delete this step by calling the appropriate method

   158

    def Delete(self):

   159

        self.Parent.DeleteStep(self)

   160

   161

    # Unconnect input and output

   162

    def Clean(self):

   163

        if self.Input:

   164

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

   165

        if self.Output:

   166

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

   167

        if self.Action:

   168

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

   169

   170

    # Refresh the size of text for name

   171

    def RefreshNameSize(self):

   172

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

   173

   174

    # Add output connector to step

   175

    def AddInput(self):

   176

        if not self.Input:

   177

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

   178

            self.RefreshBoundingBox()

   179

   180

    # Remove output connector from step

   181

    def RemoveInput(self):

   182

        if self.Input:

   183

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

   184

            self.Input = None

   185

            self.RefreshBoundingBox()

   186

   187

    # Add output connector to step

   188

    def AddOutput(self):

   189

        if not self.Output:

   190

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

   191

            self.RefreshBoundingBox()

   192

   193

    # Remove output connector from step

   194

    def RemoveOutput(self):

   195

        if self.Output:

   196

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

   197

            self.Output = None

   198

            self.RefreshBoundingBox()

   199

   200

    # Add action connector to step

   201

    def AddAction(self):

   202

        if not self.Action:

   203

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

   204

            self.RefreshBoundingBox()

   205

   206

    # Remove action connector from step

   207

    def RemoveAction(self):

   208

        if self.Action:

   209

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

   210

            self.Action = None

   211

            self.RefreshBoundingBox()

   212

   213

    # Refresh the step bounding box

   214

    def RefreshBoundingBox(self):

   215

        # TODO: check and remove dead coded

   216

        #

   217

        # Calculate the bounding box size

   218

        # if self.Action:

   219

        #     bbx_width = self.Size[0] + CONNECTOR_SIZE

   220

        # else:

   221

        #     bbx_width = self.Size[0]

   222

        # if self.Initial:

   223

        #     bbx_y = self.Pos.y

   224

        #     bbx_height = self.Size[1]

   225

        #     if self.Output:

   226

        #         bbx_height += CONNECTOR_SIZE

   227

        # else:

   228

        #     bbx_y = self.Pos.y - CONNECTOR_SIZE

   229

        #     bbx_height = self.Size[1] + CONNECTOR_SIZE

   230

        #     if self.Output:

   231

        #         bbx_height += CONNECTOR_SIZE

   232

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

   233

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

   234

   235

    # Refresh the positions of the step connectors

   236

    def RefreshConnectors(self):

   237

        scaling = self.Parent.GetScaling()

   238

        horizontal_pos = self.Size[0] // 2

   239

        vertical_pos = self.Size[1] // 2

   240

        if scaling is not None:

   241

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

   242

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

   243

        # Update input position if it exists

   244

        if self.Input:

   245

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

   246

        # Update output position

   247

        if self.Output:

   248

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

   249

        # Update action position if it exists

   250

        if self.Action:

   251

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

   252

        self.RefreshConnected()

   253

   254

    # Refresh the position of wires connected to step

   255

    def RefreshConnected(self, exclude=None):

   256

        if self.Input:

   257

            self.Input.MoveConnected(exclude)

   258

        if self.Output:

   259

            self.Output.MoveConnected(exclude)

   260

        if self.Action:

   261

            self.Action.MoveConnected(exclude)

   262

   263

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

   264

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

   265

        # if a name is given

   266

        if name is not None:

   267

            # Test input, output and action connector if they exists

   268

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

   269

            #    return self.Input

   270

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

   271

                return self.Output

   272

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

   273

                return self.Action

   274

        connectors = []

   275

        # Test input connector if it exists

   276

        if self.Input:

   277

            connectors.append(self.Input)

   278

        # Test output connector if it exists

   279

        if self.Output:

   280

            connectors.append(self.Output)

   281

        # Test action connector if it exists

   282

        if self.Action:

   283

            connectors.append(self.Action)

   284

        return self.FindNearestConnector(position, connectors)

   285

   286

    # Returns action step connector

   287

    def GetActionConnector(self):

   288

        return self.Action

   289

   290

    # Returns input and output step connectors

   291

    def GetConnectors(self):

   292

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

   293

        if self.Input:

   294

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

   295

        if self.Output:

   296

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

   297

        return connectors

   298

   299

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

   300

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

   301

        # Test input connector if it exists

   302

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

   303

            return self.Input

   304

        # Test output connector

   305

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

   306

            return self.Output

   307

        # Test action connector

   308

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

   309

            return self.Action

   310

        return None

   311

   312

    # Changes the step name

   313

    def SetName(self, name):

   314

        self.Name = name

   315

        self.RefreshNameSize()

   316

   317

    # Returns the step name

   318

    def GetName(self):

   319

        return self.Name

   320

   321

    # Returns the step initial property

   322

    def GetInitial(self):

   323

        return self.Initial

   324

   325

    # Returns the connector connected to input

   326

    def GetPreviousConnector(self):

   327

        if self.Input:

   328

            wires = self.Input.GetWires()

   329

            if len(wires) == 1:

   330

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

   331

        return None

   332

   333

    # Returns the connector connected to output

   334

    def GetNextConnector(self):

   335

        if self.Output:

   336

            wires = self.Output.GetWires()

   337

            if len(wires) == 1:

   338

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

   339

        return None

   340

   341

    # Returns the connector connected to action

   342

    def GetActionConnected(self):

   343

        if self.Action:

   344

            wires = self.Action.GetWires()

   345

            if len(wires) == 1:

   346

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

   347

        return None

   348

   349

    # Returns the number of action line

   350

    def GetActionExtraLineNumber(self):

   351

        if self.Action:

   352

            wires = self.Action.GetWires()

   353

            if len(wires) != 1:

   354

                return 0

   355

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

   356

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

   357

        return 0

   358

   359

    # Returns the step minimum size

   360

    def GetMinSize(self):

   361

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

   362

        if self.Initial:

   363

            return text_width + 14, text_height + 14

   364

        else:

   365

            return text_width + 10, text_height + 10

   366

   367

    # Updates the step size

   368

    def UpdateSize(self, width, height):

   369

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

   370

        diffy = height - self.Size.GetHeight()

   371

        self.Move(diffx, 0)

   372

        Graphic_Element.SetSize(self, width, height)

   373

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

   374

            self.RefreshConnected()

   375

        else:

   376

            self.RefreshOutputPosition((0, diffy))

   377

   378

    # Align input element with this step

   379

    def RefreshInputPosition(self):

   380

        if self.Input:

   381

            current_pos = self.Input.GetPosition(False)

   382

            input = self.GetPreviousConnector()

   383

            if input:

   384

                input_pos = input.GetPosition(False)

   385

                diffx = current_pos.x - input_pos.x

   386

                input_block = input.GetParentBlock()

   387

                if isinstance(input_block, SFC_Divergence):

   388

                    input_block.MoveConnector(input, diffx)

   389

                else:

   390

                    if isinstance(input_block, SFC_Step):

   391

                        input_block.MoveActionBlock((diffx, 0))

   392

                    input_block.Move(diffx, 0)

   393

                    input_block.RefreshInputPosition()

   394

   395

    # Align output element with this step

   396

    def RefreshOutputPosition(self, move=None):

   397

        if self.Output:

   398

            wires = self.Output.GetWires()

   399

            if len(wires) != 1:

   400

                return

   401

            current_pos = self.Output.GetPosition(False)

   402

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

   403

            output_pos = output.GetPosition(False)

   404

            diffx = current_pos.x - output_pos.x

   405

            output_block = output.GetParentBlock()

   406

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

   407

            diffy = wire_size - output_pos.y + current_pos.y

   408

            if diffy != 0:

   409

                if isinstance(output_block, SFC_Step):

   410

                    output_block.MoveActionBlock((diffx, diffy))

   411

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

   412

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

   413

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

   414

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

   415

                    output_block.RefreshOutputPosition((diffx, diffy))

   416

                else:

   417

                    output_block.RefreshPosition()

   418

            elif move:

   419

                if isinstance(output_block, SFC_Step):

   420

                    output_block.MoveActionBlock(move)

   421

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

   422

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

   423

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

   424

                    output_block.RefreshOutputPosition(move)

   425

                else:

   426

                    output_block.RefreshPosition()

   427

            elif isinstance(output_block, SFC_Divergence):

   428

                output_block.MoveConnector(output, diffx)

   429

            else:

   430

                if isinstance(output_block, SFC_Step):

   431

                    output_block.MoveActionBlock((diffx, 0))

   432

                output_block.Move(diffx, 0)

   433

                output_block.RefreshOutputPosition()

   434

   435

    # Refresh action element with this step

   436

    def MoveActionBlock(self, move):

   437

        if self.Action:

   438

            wires = self.Action.GetWires()

   439

            if len(wires) != 1:

   440

                return

   441

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

   442

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

   443

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

   444

   445

    # Resize the divergence from position and size given

   446

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

   447

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

   448

            self.UpdateSize(width, height)

   449

        else:

   450

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

   451

   452

    # Method called when a LeftDClick event have been generated

   453

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

   454

        # Edit the step properties

   455

        self.Parent.EditStepContent(self)

   456

   457

    # Method called when a RightUp event have been generated

   458

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

   459

        # Popup the menu with special items for a step

   460

        self.Parent.PopupDefaultMenu()

   461

   462

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

   463

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

   464

        handle_type, _handle = self.Handle

   465

        if handle_type == HANDLE_MOVE:

   466

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

   467

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

   468

            if scaling is not None:

   469

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

   470

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

   471

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

   472

                self.Move(movex, movey)

   473

                self.RefreshConnected()

   474

                return movex, movey

   475

            elif self.Initial:

   476

                self.MoveActionBlock((movex, movey))

   477

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

   478

                self.RefreshOutputPosition((movex, movey))

   479

                return movex, movey

   480

            else:

   481

                self.MoveActionBlock((movex, 0))

   482

                self.Move(movex, 0)

   483

                self.RefreshInputPosition()

   484

                self.RefreshOutputPosition()

   485

                return movex, 0

   486

        else:

   487

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

   488

   489

    # Refresh input element model

   490

    def RefreshInputModel(self):

   491

        if self.Input:

   492

            input = self.GetPreviousConnector()

   493

            if input:

   494

                input_block = input.GetParentBlock()

   495

                input_block.RefreshModel(False)

   496

                if not isinstance(input_block, SFC_Divergence):

   497

                    input_block.RefreshInputModel()

   498

   499

    # Refresh output element model

   500

    def RefreshOutputModel(self, move=False):

   501

        if self.Output:

   502

            output = self.GetNextConnector()

   503

            if output:

   504

                output_block = output.GetParentBlock()

   505

                output_block.RefreshModel(False)

   506

                if not isinstance(output_block, SFC_Divergence) or move:

   507

                    output_block.RefreshOutputModel(move)

   508

   509

    # Refreshes the step model

   510

    def RefreshModel(self, move=True):

   511

        self.Parent.RefreshStepModel(self)