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

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

    31

#                         Function Block Diagram Block

    32

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

    33

    34

"""

    35

Class that implements the graphic representation of a function block

    36

"""

    37

    38

class FBD_Block(Graphic_Element):

    39

    40

    # Create a new block

    41

    def __init__(self, parent, type, name, id = None, extension = 0, inputs = None, connectors = {}, executionControl = False, executionOrder = 0):

    42

        Graphic_Element.__init__(self, parent)

    43

        self.Type = None

    44

        self.Extension = None

    45

        self.ExecutionControl = False

    46

        self.Id = id

    47

        self.SetName(name)

    48

        self.SetExecutionOrder(executionOrder)

    49

        self.Inputs = []

    50

        self.Outputs = []

    51

        self.Colour = wx.BLACK

    52

        self.Pen = wx.BLACK_PEN

    53

        self.SetType(type, extension, inputs, connectors, executionControl)

    54

        self.Errors = {}

    55

    56

    # Make a clone of this FBD_Block

    57

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

    58

        if self.Name != "" and name == "":

    59

            name = self.Name

    60

        block = FBD_Block(parent, self.Type, name, id, self.Extension)

    61

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

    62

        if pos is not None:

    63

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

    64

        block.Inputs = [input.Clone(block) for input in self.Inputs]

    65

        block.Outputs = [output.Clone(block) for output in self.Outputs]

    66

        return block

    67

    68

    def Flush(self):

    69

        for input in self.Inputs:

    70

            input.Flush()

    71

        self.Inputs = []

    72

        for output in self.Outputs:

    73

            output.Flush()

    74

        self.Outputs = []

    75

    76

    # Returns the RedrawRect

    77

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

    78

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

    79

        if movex != 0 or movey != 0:

    80

            for input in self.Inputs:

    81

                if input.IsConnected():

    82

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

    83

            for output in self.Outputs:

    84

                if output.IsConnected():

    85

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

    86

        return rect

    87

    88

    # Delete this block by calling the appropriate method

    89

    def Delete(self):

    90

        self.Parent.DeleteBlock(self)

    91

    92

    # Unconnect all inputs and outputs

    93

    def Clean(self):

    94

        for input in self.Inputs:

    95

            input.UnConnect(delete = True)

    96

        for output in self.Outputs:

    97

            output.UnConnect(delete = True)

    98

    99

    # Refresh the size of text for name

   100

    def RefreshNameSize(self):

   101

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

   102

   103

    # Refresh the size of text for execution order

   104

    def RefreshExecutionOrderSize(self):

   105

        self.ExecutionOrderSize = self.Parent.GetTextExtent(str(self.ExecutionOrder))

   106

   107

    # Refresh the block bounding box

   108

    def RefreshBoundingBox(self):

   109

        # Calculate the size of the name outside the block

   110

        text_width, text_height = self.NameSize

   111

        # Calculate the bounding box size

   112

        bbx_x = self.Pos.x - max(min(1, len(self.Inputs)) * CONNECTOR_SIZE, (text_width - self.Size[0]) / 2)

   113

        bbx_width = self.Size[0] + 1 + (min(1, len(self.Inputs)) + min(1, len(self.Outputs))) * CONNECTOR_SIZE

   114

        if self.Name != "":

   115

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

   116

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

   117

        else:

   118

            bbx_y = self.Pos.y

   119

            bbx_height = self.Size[1]

   120

        if self.ExecutionOrder != 0:

   121

            bbx_x = min(bbx_x, self.Pos.x + self.Size[0] - self.ExecutionOrderSize[0])

   122

            bbx_width = max(bbx_width, bbx_width + self.Pos.x + self.ExecutionOrderSize[0] - bbx_x - self.Size[0])

   123

            bbx_height = bbx_height + (self.ExecutionOrderSize[1] + 2)

   124

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

   125

   126

    # Refresh the positions of the block connectors

   127

    def RefreshConnectors(self):

   128

        scaling = self.Parent.GetScaling()

   129

        # Calculate the size for the connector lines

   130

        lines = max(len(self.Inputs), len(self.Outputs))

   131

        if lines > 0:

   132

            linesize = max((self.Size[1] - BLOCK_LINE_SIZE) / lines, BLOCK_LINE_SIZE)

   133

            # Update inputs and outputs positions

   134

            position = BLOCK_LINE_SIZE + linesize / 2

   135

            for i in xrange(lines):

   136

                if scaling is not None:

   137

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

   138

                else:

   139

                    ypos = position

   140

                if i < len(self.Inputs):

   141

                    self.Inputs[i].SetPosition(wx.Point(0, ypos))

   142

                if i < len(self.Outputs):

   143

                    self.Outputs[i].SetPosition(wx.Point(self.Size[0], ypos))

   144

                position += linesize

   145

        self.RefreshConnected()

   146

   147

    # Refresh the positions of wires connected to inputs and outputs

   148

    def RefreshConnected(self, exclude = []):

   149

        for input in self.Inputs:

   150

            input.MoveConnected(exclude)

   151

        for output in self.Outputs:

   152

            output.MoveConnected(exclude)

   153

   154

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

   155

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

   156

        # if a name is given

   157

        if name:

   158

            # Test each input and output connector

   159

            for input in self.Inputs:

   160

                if name == input.GetName():

   161

                    return input

   162

            for output in self.Outputs:

   163

                if name == output.GetName():

   164

                    return output

   165

        # Test each input connector

   166

        for input in self.Inputs:

   167

            input_pos = input.GetRelPosition()

   168

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

   169

                return input

   170

        # Test each output connector

   171

        for output in self.Outputs:

   172

            output_pos = output.GetRelPosition()

   173

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

   174

                return output

   175

        return None

   176

   177

    def GetInputTypes(self):

   178

        return tuple([input.GetType(True) for input in self.Inputs if input.GetName() != "EN"])

   179

   180

    def SetOutputValues(self, values):

   181

        for output in self.Outputs:

   182

            output.SetValue(values.get(ouput.getName(), None))

   183

   184

    def GetConnectionResultType(self, connector, connectortype):

   185

        resulttype = connectortype

   186

        for input in self.Inputs:

   187

            name = input.GetName()

   188

            if input != connector and (name.startswith("IN") or name in ["MN", "MX"]):

   189

                inputtype = input.GetConnectedType()

   190

                if resulttype is None or inputtype is not None and self.IsOfType(inputtype, resulttype):

   191

                    resulttype = inputtype

   192

        for output in self.Outputs:

   193

            name = output.GetName()

   194

            if output != connector and name == "OUT" and not self.IsEndType(output.GetType()):

   195

                outputtype = output.GetConnectedType()

   196

                if resulttype is None or outputtype is not None and self.IsOfType(outputtype, resulttype):

   197

                    resulttype = outputtype

   198

        return resulttype

   199

   200

    # Returns all the block connectors

   201

    def GetConnectors(self):

   202

        return {"inputs" : self.Inputs, "outputs" : self.Outputs}

   203

   204

    # Test if point given is on one of the block connectors

   205

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

   206

        # Test each input connector

   207

        for input in self.Inputs:

   208

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

   209

                return input

   210

        # Test each output connector

   211

        for output in self.Outputs:

   212

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

   213

                return output

   214

        return None

   215

   216

    # Changes the block type

   217

    def SetType(self, type, extension, inputs = None, connectors = {}, executionControl = False):

   218

        if type != self.Type or self.Extension != extension or executionControl != self.ExecutionControl: 

   219

            if type != self.Type:

   220

                self.Type = type

   221

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

   222

            self.Extension = extension

   223

            self.ExecutionControl = executionControl

   224

            # Find the block definition from type given and create the corresponding

   225

            # inputs and outputs

   226

            blocktype = self.Parent.GetBlockType(type, inputs)

   227

            if blocktype:

   228

                self.Colour = wx.BLACK

   229

                inputs = [input for input in blocktype["inputs"]]

   230

                outputs = [output for output in blocktype["outputs"]]

   231

                if blocktype["extensible"]:

   232

                    start = int(inputs[-1][0].replace("IN", ""))

   233

                    for i in xrange(self.Extension - len(blocktype["inputs"])):

   234

                        start += 1

   235

                        inputs.append(("IN%d"%start, inputs[-1][1], inputs[-1][2]))

   236

            else:

   237

                self.Colour = wx.RED

   238

                if "inputs" in connectors:

   239

                    inputs = connectors["inputs"]

   240

                else:

   241

                    inputs = []

   242

                if "outputs" in connectors:

   243

                    outputs = connectors["outputs"]

   244

                else:

   245

                    outputs = []

   246

            if self.ExecutionControl:

   247

                inputs.insert(0, ("EN","BOOL","none"))

   248

                outputs.insert(0, ("ENO","BOOL","none"))

   249

            self.Pen = wx.Pen(self.Colour)

   250

            self.Clean()

   251

            # Extract the inputs properties and create the corresponding connector

   252

            self.Inputs = []

   253

            for input_name, input_type, input_modifier in inputs:

   254

                connector = Connector(self, input_name, input_type, wx.Point(0, 0), WEST, onlyone = True)

   255

                if input_modifier == "negated":

   256

                    connector.SetNegated(True)

   257

                elif input_modifier != "none":

   258

                    connector.SetEdge(input_modifier)

   259

                self.Inputs.append(connector)

   260

            # Extract the outputs properties and create the corresponding connector

   261

            self.Outputs = []

   262

            for output_name, output_type, output_modifier in outputs:

   263

                connector = Connector(self, output_name, output_type, wx.Point(0, 0), EAST)

   264

                if output_modifier == "negated":

   265

                    connector.SetNegated(True)

   266

                elif output_modifier != "none":

   267

                    connector.SetEdge(output_modifier)

   268

                self.Outputs.append(connector)

   269

            self.RefreshMinSize()

   270

            self.RefreshConnectors()

   271

            self.RefreshBoundingBox()

   272

   273

    # Returns the block type

   274

    def GetType(self):

   275

        return self.Type

   276

   277

    # Changes the block name

   278

    def SetName(self, name):

   279

        self.Name = name

   280

        self.RefreshNameSize()

   281

   282

    # Returs the block name

   283

    def GetName(self):

   284

        return self.Name

   285

   286

    # Changes the extension name

   287

    def SetExtension(self, extension):

   288

        self.Extension = extension

   289

   290

    # Returs the extension name

   291

    def GetExtension(self):

   292

        return self.Extension

   293

   294

    # Changes the execution order

   295

    def SetExecutionOrder(self, executionOrder):

   296

        self.ExecutionOrder = executionOrder

   297

        self.RefreshExecutionOrderSize()

   298

   299

    # Returs the execution order

   300

    def GetExecutionOrder(self):

   301

        return self.ExecutionOrder

   302

   303

    # Returs the execution order

   304

    def GetExecutionControl(self):

   305

        return self.ExecutionControl

   306

   307

    # Refresh the block minimum size

   308

    def RefreshMinSize(self):

   309

        # Calculate the inputs maximum width

   310

        max_input = 0

   311

        for input in self.Inputs:

   312

            w, h = input.GetNameSize()

   313

            max_input = max(max_input, w)

   314

        # Calculate the outputs maximum width

   315

        max_output = 0

   316

        for output in self.Outputs:

   317

            w, h = output.GetNameSize()

   318

            max_output = max(max_output, w)

   319

        width = max(self.TypeSize[0] + 10, max_input + max_output + 15)

   320

        height = (max(len(self.Inputs), len(self.Outputs)) + 1) * BLOCK_LINE_SIZE

   321

        self.MinSize = width, height

   322

   323

    # Returns the block minimum size

   324

    def GetMinSize(self):

   325

        return self.MinSize

   326

   327

    # Changes the negated property of the connector handled

   328

    def SetConnectorNegated(self, negated):

   329

        handle_type, handle = self.Handle

   330

        if handle_type == HANDLE_CONNECTOR:

   331

            handle.SetNegated(negated)

   332

            self.RefreshModel(False)

   333

   334

    # Changes the edge property of the connector handled

   335

    def SetConnectorEdge(self, edge):

   336

        handle_type, handle = self.Handle

   337

        if handle_type == HANDLE_CONNECTOR:

   338

            handle.SetEdge(edge)

   339

            self.RefreshModel(False)

   340

   341

    # Method called when a LeftDClick event have been generated

   342

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

   343

        # Edit the block properties

   344

        self.Parent.EditBlockContent(self)

   345

   346

    # Method called when a RightUp event have been generated

   347

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

   348

        pos = GetScaledEventPosition(event, dc, scaling)

   349

        # Popup the menu with special items for a block and a connector if one is handled

   350

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

   351

        if connector:

   352

            self.Handle = (HANDLE_CONNECTOR, connector)

   353

            self.Parent.PopupBlockMenu(connector)

   354

        else:

   355

            self.Parent.PopupBlockMenu()

   356

   357

    # Refreshes the block model

   358

    def RefreshModel(self, move=True):

   359

        self.Parent.RefreshBlockModel(self)

   360

        # If block has moved, refresh the model of wires connected to outputs

   361

        if move:

   362

            for output in self.Outputs:

   363

                output.RefreshWires()

   364

   365

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

   366

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

   367

            self.Errors[infos[0]] = (start, end)

   368

        elif infos[0] == "input" and infos[1] < len(self.Inputs):

   369

            self.Inputs[infos[1]].AddError(infos[2:], start, end)

   370

        elif infos[0] == "output" and infos[1] < len(self.Outputs):

   371

            self.Outputs[infos[1]].AddError(infos[2:], start, end)

   372

   373

    # Draws block

   374

    def Draw(self, dc):

   375

        Graphic_Element.Draw(self, dc)

   376

        dc.SetPen(self.Pen)

   377

        dc.SetBrush(wx.WHITE_BRUSH)

   378

        dc.SetTextForeground(self.Colour)

   379

   380

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

   381

            name_size = dc.GetTextExtent(self.Name)

   382

            type_size = dc.GetTextExtent(self.Type)

   383

            executionorder_size = dc.GetTextExtent(str(self.ExecutionOrder))

   384

        else:

   385

            name_size = self.NameSize

   386

            type_size = self.TypeSize

   387

            executionorder_size = self.ExecutionOrderSize

   388

   389

        # Draw a rectangle with the block size

   390

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

   391

        # Draw block name and block type

   392

        name_pos = (self.Pos.x + (self.Size[0] - name_size[0]) / 2,

   393

                    self.Pos.y - (name_size[1] + 2))

   394

        type_pos = (self.Pos.x + (self.Size[0] - type_size[0]) / 2,

   395

                    self.Pos.y + 5)

   396

        dc.DrawText(self.Name, name_pos[0], name_pos[1])

   397

        dc.DrawText(self.Type, type_pos[0], type_pos[1])

   398

        # Draw inputs and outputs connectors

   399

        for input in self.Inputs:

   400

            input.Draw(dc)

   401

        for output in self.Outputs:

   402

            output.Draw(dc)

   403

        if self.ExecutionOrder != 0:

   404

            # Draw block execution order

   405

            dc.DrawText(str(self.ExecutionOrder), self.Pos.x + self.Size[0] - executionorder_size[0],

   406

                    self.Pos.y + self.Size[1] + 2)

   407

        if "name" in self.Errors:

   408

            HighlightErrorZone(dc, name_pos[0], name_pos[1], name_size[0], name_size[1])

   409

        if "type" in self.Errors:

   410

            HighlightErrorZone(dc, type_pos[0], type_pos[1], type_size[0], type_size[1])    

   411

        dc.SetTextForeground(wx.BLACK)

   412

   413

   414

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

   415

#                        Function Block Diagram Variable

   416

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

   417

   418

"""

   419

Class that implements the graphic representation of a variable

   420

"""

   421

   422

class FBD_Variable(Graphic_Element):

   423

   424

    # Create a new variable

   425

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

   426

        Graphic_Element.__init__(self, parent)

   427

        self.Type = None

   428

        self.ValueType = None

   429

        self.Id = id

   430

        self.SetName(name)

   431

        self.SetExecutionOrder(executionOrder)

   432

        self.Input = None

   433

        self.Output = None

   434

        self.SetType(type, value_type)

   435

        self.Errors = []

   436

   437

    # Make a clone of this FBD_Variable

   438

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

   439

        variable = FBD_Variable(parent, self.Type, self.Name, self.ValueType, id)

   440

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

   441

        if pos is not None:

   442

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

   443

        if self.Input:

   444

            variable.Input = self.Input.Clone(variable)

   445

        if self.Output:

   446

            variable.Output = self.Output.Clone(variable)

   447

        return variable

   448

   449

    def Flush(self):

   450

        if self.Input is not None:

   451

            self.Input.Flush()

   452

            self.Input = None

   453

        if self.Output is not None:

   454

            self.Output.Flush()

   455

            self.Output = None

   456

   457

    # Returns the RedrawRect

   458

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

   459

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

   460

        if movex != 0 or movey != 0:

   461

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

   462

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

   463

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

   464

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

   465

        return rect

   466

   467

    # Unconnect connector

   468

    def Clean(self):

   469

        if self.Input:

   470

            self.Input.UnConnect(delete = True)

   471

        if self.Output:

   472

            self.Output.UnConnect(delete = True)

   473

   474

    # Delete this variable by calling the appropriate method

   475

    def Delete(self):

   476

        self.Parent.DeleteVariable(self)

   477

   478

    # Refresh the size of text for name

   479

    def RefreshNameSize(self):

   480

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

   481

   482

    # Refresh the size of text for execution order

   483

    def RefreshExecutionOrderSize(self):

   484

        self.ExecutionOrderSize = self.Parent.GetTextExtent(str(self.ExecutionOrder))

   485

   486

    # Refresh the variable bounding box

   487

    def RefreshBoundingBox(self):

   488

        if self.Type in (OUTPUT, INOUT):

   489

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   490

        else:

   491

            bbx_x = self.Pos.x

   492

        if self.Type == INOUT:

   493

            bbx_width = self.Size[0] + 2 * CONNECTOR_SIZE

   494

        else:

   495

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   496

        bbx_height = self.Size[1]

   497

        if self.ExecutionOrder != 0:

   498

            bbx_x = min(bbx_x, self.Pos.x + self.Size[0] - self.ExecutionOrderSize[0])