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 = {}, executionOrder = 0):

    42

        Graphic_Element.__init__(self, parent)

    43

        self.Type = None

    44

        self.Extension = None

    45

        self.Id = id

    46

        self.SetName(name)

    47

        self.SetExecutionOrder(executionOrder)

    48

        self.Inputs = []

    49

        self.Outputs = []

    50

        self.Colour = wx.BLACK

    51

        self.Pen = wx.BLACK_PEN

    52

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

    53

        self.Errors = {}

    54

    55

    # Make a clone of this FBD_Block

    56

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

    57

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

    58

            name = self.Name

    59

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

    60

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

    61

        if pos is not None:

    62

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

    63

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

    64

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

    65

        return block

    66

    67

    def Flush(self):

    68

        for input in self.Inputs:

    69

            input.Flush()

    70

        self.Inputs = []

    71

        for output in self.Outputs:

    72

            output.Flush()

    73

        self.Outputs = []

    74

    75

    # Returns the RedrawRect

    76

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

    77

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

    78

        if movex != 0 or movey != 0:

    79

            for input in self.Inputs:

    80

                if input.IsConnected():

    81

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

    82

            for output in self.Outputs:

    83

                if output.IsConnected():

    84

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

    85

        return rect

    86

    87

    # Delete this block by calling the appropriate method

    88

    def Delete(self):

    89

        self.Parent.DeleteBlock(self)

    90

    91

    # Unconnect all inputs and outputs

    92

    def Clean(self):

    93

        for input in self.Inputs:

    94

            input.UnConnect(delete = True)

    95

        for output in self.Outputs:

    96

            output.UnConnect(delete = True)

    97

    98

    # Refresh the size of text for name

    99

    def RefreshNameSize(self):

   100

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

   101

   102

    # Refresh the size of text for execution order

   103

    def RefreshExecutionOrderSize(self):

   104

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

   105

   106

    # Refresh the block bounding box

   107

    def RefreshBoundingBox(self):

   108

        # Calculate the size of the name outside the block

   109

        text_width, text_height = self.NameSize

   110

        # Calculate the bounding box size

   111

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

   112

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

   113

        if self.Name != "":

   114

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

   115

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

   116

        else:

   117

            bbx_y = self.Pos.y

   118

            bbx_height = self.Size[1]

   119

        if self.ExecutionOrder != 0:

   120

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

   121

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

   122

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

   123

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

   124

   125

    # Refresh the positions of the block connectors

   126

    def RefreshConnectors(self):

   127

        scaling = self.Parent.GetScaling()

   128

        # Calculate the size for the connector lines

   129

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

   130

        if lines > 0:

   131

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

   132

            # Update inputs and outputs positions

   133

            position = BLOCK_LINE_SIZE + linesize / 2

   134

            for i in xrange(lines):

   135

                if scaling is not None:

   136

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

   137

                else:

   138

                    ypos = position

   139

                if i < len(self.Inputs):

   140

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

   141

                if i < len(self.Outputs):

   142

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

   143

                position += linesize

   144

        self.RefreshConnected()

   145

   146

    # Refresh the positions of wires connected to inputs and outputs

   147

    def RefreshConnected(self, exclude = []):

   148

        for input in self.Inputs:

   149

            input.MoveConnected(exclude)

   150

        for output in self.Outputs:

   151

            output.MoveConnected(exclude)

   152

   153

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

   154

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

   155

        # if a name is given

   156

        if name:

   157

            # Test each input and output connector

   158

            for input in self.Inputs:

   159

                if name == input.GetName():

   160

                    return input

   161

            for output in self.Outputs:

   162

                if name == output.GetName():

   163

                    return output

   164

        # Test each input connector

   165

        for input in self.Inputs:

   166

            input_pos = input.GetRelPosition()

   167

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

   168

                return input

   169

        # Test each output connector

   170

        for output in self.Outputs:

   171

            output_pos = output.GetRelPosition()

   172

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

   173

                return output

   174

        return None

   175

   176

    def GetInputTypes(self):

   177

        return tuple([input.GetType(True) for input in self.Inputs])

   178

   179

    def SetOutputValues(self, values):

   180

        for output in self.Outputs:

   181

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

   182

   183

    def GetConnectionResultType(self, connector, connectortype):

   184

        resulttype = connectortype

   185

        for input in self.Inputs:

   186

            name = input.GetName()

   187

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

   188

                inputtype = input.GetConnectedType()

   189

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

   190

                    resulttype = inputtype

   191

        for output in self.Outputs:

   192

            name = output.GetName()

   193

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

   194

                outputtype = output.GetConnectedType()

   195

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

   196

                    resulttype = outputtype

   197

        return resulttype

   198

   199

    # Returns all the block connectors

   200

    def GetConnectors(self):

   201

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

   202

   203

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

   204

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

   205

        # Test each input connector

   206

        for input in self.Inputs:

   207

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

   208

                return input

   209

        # Test each output connector

   210

        for output in self.Outputs:

   211

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

   212

                return output

   213

        return None

   214

   215

    # Changes the block type

   216

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

   217

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

   218

            if type != self.Type:

   219

                self.Type = type

   220

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

   221

            self.Extension = extension

   222

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

   223

            # inputs and outputs

   224

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

   225

            if blocktype:

   226

                self.Colour = wx.BLACK

   227

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

   228

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

   229

                if blocktype["extensible"]:

   230

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

   231

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

   232

                        start += 1

   233

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

   234

            else:

   235

                self.Colour = wx.RED

   236

                if "inputs" in connectors:

   237

                    inputs = connectors["inputs"]

   238

                else:

   239

                    inputs = []

   240

                if "outputs" in connectors:

   241

                    outputs = connectors["outputs"]

   242

                else:

   243

                    outputs = []

   244

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

   245

            self.Clean()

   246

            # Extract the inputs properties and create the corresponding connector

   247

            self.Inputs = []

   248

            for input_name, input_type, input_modifier in inputs:

   249

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

   250

                if input_modifier == "negated":

   251

                    connector.SetNegated(True)

   252

                elif input_modifier != "none":

   253

                    connector.SetEdge(input_modifier)

   254

                self.Inputs.append(connector)

   255

            # Extract the outputs properties and create the corresponding connector

   256

            self.Outputs = []

   257

            for output_name, output_type, output_modifier in outputs:

   258

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

   259

                if output_modifier == "negated":

   260

                    connector.SetNegated(True)

   261

                elif output_modifier != "none":

   262

                    connector.SetEdge(output_modifier)

   263

                self.Outputs.append(connector)

   264

            self.RefreshMinSize()

   265

            self.RefreshConnectors()

   266

            self.RefreshBoundingBox()

   267

   268

    # Returns the block type

   269

    def GetType(self):

   270

        return self.Type

   271

   272

    # Changes the block name

   273

    def SetName(self, name):

   274

        self.Name = name

   275

        self.RefreshNameSize()

   276

   277

    # Returs the block name

   278

    def GetName(self):

   279

        return self.Name

   280

   281

    # Changes the extension name

   282

    def SetExtension(self, extension):

   283

        self.Extension = extension

   284

   285

    # Returs the extension name

   286

    def GetExtension(self):

   287

        return self.Extension

   288

   289

    # Changes the execution order

   290

    def SetExecutionOrder(self, executionOrder):

   291

        self.ExecutionOrder = executionOrder

   292

        self.RefreshExecutionOrderSize()

   293

   294

    # Returs the execution order

   295

    def GetExecutionOrder(self):

   296

        return self.ExecutionOrder

   297

   298

    # Refresh the block minimum size

   299

    def RefreshMinSize(self):

   300

        # Calculate the inputs maximum width

   301

        max_input = 0

   302

        for input in self.Inputs:

   303

            w, h = input.GetNameSize()

   304

            max_input = max(max_input, w)

   305

        # Calculate the outputs maximum width

   306

        max_output = 0

   307

        for output in self.Outputs:

   308

            w, h = output.GetNameSize()

   309

            max_output = max(max_output, w)

   310

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

   311

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

   312

        self.MinSize = width, height

   313

   314

    # Returns the block minimum size

   315

    def GetMinSize(self):

   316

        return self.MinSize

   317

   318

    # Changes the negated property of the connector handled

   319

    def SetConnectorNegated(self, negated):

   320

        handle_type, handle = self.Handle

   321

        if handle_type == HANDLE_CONNECTOR:

   322

            handle.SetNegated(negated)

   323

            self.RefreshModel(False)

   324

   325

    # Changes the edge property of the connector handled

   326

    def SetConnectorEdge(self, edge):

   327

        handle_type, handle = self.Handle

   328

        if handle_type == HANDLE_CONNECTOR:

   329

            handle.SetEdge(edge)

   330

            self.RefreshModel(False)

   331

   332

    # Method called when a LeftDClick event have been generated

   333

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

   334

        # Edit the block properties

   335

        self.Parent.EditBlockContent(self)

   336

   337

    # Method called when a RightUp event have been generated

   338

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

   339

        pos = GetScaledEventPosition(event, dc, scaling)

   340

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

   341

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

   342

        if connector:

   343

            self.Handle = (HANDLE_CONNECTOR, connector)

   344

            self.Parent.PopupBlockMenu(connector)

   345

        else:

   346

            self.Parent.PopupBlockMenu()

   347

   348

    # Refreshes the block model

   349

    def RefreshModel(self, move=True):

   350

        self.Parent.RefreshBlockModel(self)

   351

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

   352

        if move:

   353

            for output in self.Outputs:

   354

                output.RefreshWires()

   355

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

   364

    # Draws block

   365

    def Draw(self, dc):

   366

        Graphic_Element.Draw(self, dc)

   367

        dc.SetPen(self.Pen)

   368

        dc.SetBrush(wx.WHITE_BRUSH)

   369

        dc.SetTextForeground(self.Colour)

   370

   371

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

   372

            name_size = dc.GetTextExtent(self.Name)

   373

            type_size = dc.GetTextExtent(self.Type)

   374

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

   375

        else:

   376

            name_size = self.NameSize

   377

            type_size = self.TypeSize

   378

            executionorder_size = self.ExecutionOrderSize

   379

   380

        # Draw a rectangle with the block size

   381

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

   382

        # Draw block name and block type

   383

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

   384

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

   385

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

   386

                    self.Pos.y + 5)

   387

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

   388

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

   389

        # Draw inputs and outputs connectors

   390

        for input in self.Inputs:

   391

            input.Draw(dc)

   392

        for output in self.Outputs:

   393

            output.Draw(dc)

   394

        if self.ExecutionOrder != 0:

   395

            # Draw block execution order

   396

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

   397

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

   398

        if "name" in self.Errors:

   399

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

   400

        if "type" in self.Errors:

   401

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

   402

        dc.SetTextForeground(wx.BLACK)

   403

   404

   405

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

   406

#                        Function Block Diagram Variable

   407

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

   408

   409

"""

   410

Class that implements the graphic representation of a variable

   411

"""

   412

   413

class FBD_Variable(Graphic_Element):

   414

   415

    # Create a new variable

   416

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

   417

        Graphic_Element.__init__(self, parent)

   418

        self.Type = None

   419

        self.ValueType = None

   420

        self.Id = id

   421

        self.SetName(name)

   422

        self.SetExecutionOrder(executionOrder)

   423

        self.Input = None

   424

        self.Output = None

   425

        self.SetType(type, value_type)

   426

        self.Errors = []

   427

   428

    # Make a clone of this FBD_Variable

   429

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

   430

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

   431

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

   432

        if pos is not None:

   433

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

   434

        if self.Input:

   435

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

   436

        if self.Output:

   437

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

   438

        return variable

   439

   440

    def Flush(self):

   441

        if self.Input is not None:

   442

            self.Input.Flush()

   443

            self.Input = None

   444

        if self.Output is not None:

   445

            self.Output.Flush()

   446

            self.Output = None

   447

   448

    # Returns the RedrawRect

   449

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

   450

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

   451

        if movex != 0 or movey != 0:

   452

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

   453

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

   454

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

   455

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

   456

        return rect

   457

   458

    # Unconnect connector

   459

    def Clean(self):

   460

        if self.Input:

   461

            self.Input.UnConnect(delete = True)

   462

        if self.Output:

   463

            self.Output.UnConnect(delete = True)

   464

   465

    # Delete this variable by calling the appropriate method

   466

    def Delete(self):

   467

        self.Parent.DeleteVariable(self)

   468

   469

    # Refresh the size of text for name

   470

    def RefreshNameSize(self):

   471

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

   472

   473

    # Refresh the size of text for execution order

   474

    def RefreshExecutionOrderSize(self):

   475

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

   476

   477

    # Refresh the variable bounding box

   478

    def RefreshBoundingBox(self):

   479

        if self.Type in (OUTPUT, INOUT):

   480

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   481

        else:

   482

            bbx_x = self.Pos.x

   483

        if self.Type == INOUT:

   484

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

   485

        else:

   486

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   487

        bbx_height = self.Size[1]

   488

        if self.ExecutionOrder != 0:

   489

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

   490

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

   491

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

   492

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

   493

   494

    # Refresh the position of the variable connector

   495

    def RefreshConnectors(self):

   496

        scaling = self.Parent.GetScaling()

   497

        if scaling is not None:

   498

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

   499

        else: