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

    # Destructor

    68

    def __del__(self):

    69

        self.Inputs = []

    70

        self.Outputs = []

    71

    72

    # Returns the RedrawRect

    73

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

    74

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

    75

        if movex != 0 or movey != 0:

    76

            for input in self.Inputs:

    77

                if input.IsConnected():

    78

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

    79

            for output in self.Outputs:

    80

                if output.IsConnected():

    81

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

    82

        return rect

    83

    84

    # Delete this block by calling the appropriate method

    85

    def Delete(self):

    86

        self.Parent.DeleteBlock(self)

    87

    88

    # Unconnect all inputs and outputs

    89

    def Clean(self):

    90

        for input in self.Inputs:

    91

            input.UnConnect(delete = True)

    92

        for output in self.Outputs:

    93

            output.UnConnect(delete = True)

    94

    95

    # Refresh the size of text for name

    96

    def RefreshNameSize(self):

    97

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

    98

    99

    # Refresh the size of text for execution order

   100

    def RefreshExecutionOrderSize(self):

   101

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

   102

   103

    # Refresh the block bounding box

   104

    def RefreshBoundingBox(self):

   105

        # Calculate the size of the name outside the block

   106

        text_width, text_height = self.NameSize

   107

        # Calculate the bounding box size

   108

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

   109

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

   110

        if self.Name != "":

   111

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

   112

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

   113

        else:

   114

            bbx_y = self.Pos.y

   115

            bbx_height = self.Size[1]

   116

        if self.ExecutionOrder != 0:

   117

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

   118

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

   119

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

   120

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

   121

   122

    # Refresh the positions of the block connectors

   123

    def RefreshConnectors(self):

   124

        scaling = self.Parent.GetScaling()

   125

        # Calculate the size for the connector lines

   126

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

   127

        if lines > 0:

   128

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

   129

            # Update inputs and outputs positions

   130

            position = BLOCK_LINE_SIZE + linesize / 2

   131

            for i in xrange(lines):

   132

                if scaling is not None:

   133

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

   134

                else:

   135

                    ypos = position

   136

                if i < len(self.Inputs):

   137

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

   138

                if i < len(self.Outputs):

   139

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

   140

                position += linesize

   141

        self.RefreshConnected()

   142

   143

    # Refresh the positions of wires connected to inputs and outputs

   144

    def RefreshConnected(self, exclude = []):

   145

        for input in self.Inputs:

   146

            input.MoveConnected(exclude)

   147

        for output in self.Outputs:

   148

            output.MoveConnected(exclude)

   149

   150

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

   151

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

   152

        # if a name is given

   153

        if name:

   154

            # Test each input and output connector

   155

            for input in self.Inputs:

   156

                if name == input.GetName():

   157

                    return input

   158

            for output in self.Outputs:

   159

                if name == output.GetName():

   160

                    return output

   161

        # Test each input connector

   162

        for input in self.Inputs:

   163

            input_pos = input.GetRelPosition()

   164

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

   165

                return input

   166

        # Test each output connector

   167

        for output in self.Outputs:

   168

            output_pos = output.GetRelPosition()

   169

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

   170

                return output

   171

        return None

   172

   173

    def GetInputTypes(self):

   174

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

   175

   176

    def SetOutputValues(self, values):

   177

        for output in self.Outputs:

   178

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

   179

   180

    def GetConnectionResultType(self, connector, connectortype):

   181

        resulttype = connectortype

   182

        for input in self.Inputs:

   183

            name = input.GetName()

   184

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

   185

                inputtype = input.GetConnectedType()

   186

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

   187

                    resulttype = inputtype

   188

        for output in self.Outputs:

   189

            name = output.GetName()

   190

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

   191

                outputtype = output.GetConnectedType()

   192

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

   193

                    resulttype = outputtype

   194

        return resulttype

   195

   196

    # Returns all the block connectors

   197

    def GetConnectors(self):

   198

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

   199

   200

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

   201

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

   202

        # Test each input connector

   203

        for input in self.Inputs:

   204

            if input.TestPoint(pt, exclude):

   205

                return input

   206

        # Test each output connector

   207

        for output in self.Outputs:

   208

            if output.TestPoint(pt, exclude):

   209

                return output

   210

        return None

   211

   212

    # Changes the block type

   213

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

   214

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

   215

            if type != self.Type:

   216

                self.Type = type

   217

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

   218

            self.Extension = extension

   219

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

   220

            # inputs and outputs

   221

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

   222

            if blocktype:

   223

                self.Colour = wx.BLACK

   224

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

   225

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

   226

                if blocktype["extensible"]:

   227

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

   228

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

   229

                        start += 1

   230

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

   231

            else:

   232

                self.Colour = wx.RED

   233

                if "inputs" in connectors:

   234

                    inputs = connectors["inputs"]

   235

                else:

   236

                    inputs = []

   237

                if "outputs" in connectors:

   238

                    outputs = connectors["outputs"]

   239

                else:

   240

                    outputs = []

   241

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

   242

            self.Clean()

   243

            # Extract the inputs properties and create the corresponding connector

   244

            self.Inputs = []

   245

            for input_name, input_type, input_modifier in inputs:

   246

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

   247

                if input_modifier == "negated":

   248

                    connector.SetNegated(True)

   249

                elif input_modifier != "none":

   250

                    connector.SetEdge(input_modifier)

   251

                self.Inputs.append(connector)

   252

            # Extract the outputs properties and create the corresponding connector

   253

            self.Outputs = []

   254

            for output_name, output_type, output_modifier in outputs:

   255

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

   256

                if output_modifier == "negated":

   257

                    connector.SetNegated(True)

   258

                elif output_modifier != "none":

   259

                    connector.SetEdge(output_modifier)

   260

                self.Outputs.append(connector)

   261

            self.RefreshMinSize()

   262

            self.RefreshConnectors()

   263

            self.RefreshBoundingBox()

   264

   265

    # Returns the block type

   266

    def GetType(self):

   267

        return self.Type

   268

   269

    # Changes the block name

   270

    def SetName(self, name):

   271

        self.Name = name

   272

        self.RefreshNameSize()

   273

   274

    # Returs the block name

   275

    def GetName(self):

   276

        return self.Name

   277

   278

    # Changes the extension name

   279

    def SetExtension(self, extension):

   280

        self.Extension = extension

   281

   282

    # Returs the extension name

   283

    def GetExtension(self):

   284

        return self.Extension

   285

   286

    # Changes the execution order

   287

    def SetExecutionOrder(self, executionOrder):

   288

        self.ExecutionOrder = executionOrder

   289

        self.RefreshExecutionOrderSize()

   290

   291

    # Returs the execution order

   292

    def GetExecutionOrder(self):

   293

        return self.ExecutionOrder

   294

   295

    # Refresh the block minimum size

   296

    def RefreshMinSize(self):

   297

        # Calculate the inputs maximum width

   298

        max_input = 0

   299

        for input in self.Inputs:

   300

            w, h = input.GetNameSize()

   301

            max_input = max(max_input, w)

   302

        # Calculate the outputs maximum width

   303

        max_output = 0

   304

        for output in self.Outputs:

   305

            w, h = output.GetNameSize()

   306

            max_output = max(max_output, w)

   307

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

   308

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

   309

        self.MinSize = width, height

   310

   311

    # Returns the block minimum size

   312

    def GetMinSize(self):

   313

        return self.MinSize

   314

   315

    # Changes the negated property of the connector handled

   316

    def SetConnectorNegated(self, negated):

   317

        handle_type, handle = self.Handle

   318

        if handle_type == HANDLE_CONNECTOR:

   319

            handle.SetNegated(negated)

   320

            self.RefreshModel(False)

   321

   322

    # Changes the edge property of the connector handled

   323

    def SetConnectorEdge(self, edge):

   324

        handle_type, handle = self.Handle

   325

        if handle_type == HANDLE_CONNECTOR:

   326

            handle.SetEdge(edge)

   327

            self.RefreshModel(False)

   328

   329

    # Method called when a LeftDClick event have been generated

   330

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

   331

        # Edit the block properties

   332

        self.Parent.EditBlockContent(self)

   333

   334

    # Method called when a RightUp event have been generated

   335

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

   336

        pos = GetScaledEventPosition(event, dc, scaling)

   337

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

   338

        connector = self.TestConnector(pos, False)

   339

        if connector:

   340

            self.Handle = (HANDLE_CONNECTOR, connector)

   341

            self.Parent.PopupBlockMenu(connector)

   342

        else:

   343

            self.Parent.PopupBlockMenu()

   344

   345

    # Refreshes the block model

   346

    def RefreshModel(self, move=True):

   347

        self.Parent.RefreshBlockModel(self)

   348

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

   349

        if move:

   350

            for output in self.Outputs:

   351

                output.RefreshWires()

   352

   353

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

   354

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

   355

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

   356

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

   357

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

   358

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

   359

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

   360

   361

    # Draws block

   362

    def Draw(self, dc):

   363

        Graphic_Element.Draw(self, dc)

   364

        dc.SetPen(self.Pen)

   365

        dc.SetBrush(wx.WHITE_BRUSH)

   366

        dc.SetTextForeground(self.Colour)

   367

   368

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

   369

            name_size = dc.GetTextExtent(self.Name)

   370

            type_size = dc.GetTextExtent(self.Type)

   371

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

   372

        else:

   373

            name_size = self.NameSize

   374

            type_size = self.TypeSize

   375

            executionorder_size = self.ExecutionOrderSize

   376

   377

        # Draw a rectangle with the block size

   378

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

   379

        # Draw block name and block type

   380

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

   381

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

   382

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

   383

                    self.Pos.y + 5)

   384

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

   385

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

   386

        # Draw inputs and outputs connectors

   387

        for input in self.Inputs:

   388

            input.Draw(dc)

   389

        for output in self.Outputs:

   390

            output.Draw(dc)

   391

        if self.ExecutionOrder != 0:

   392

            # Draw block execution order

   393

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

   394

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

   395

        if "name" in self.Errors:

   396

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

   397

        if "type" in self.Errors:

   398

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

   399

        dc.SetTextForeground(wx.BLACK)

   400

   401

   402

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

   403

#                        Function Block Diagram Variable

   404

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

   405

   406

"""

   407

Class that implements the graphic representation of a variable

   408

"""

   409

   410

class FBD_Variable(Graphic_Element):

   411

   412

    # Create a new variable

   413

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

   414

        Graphic_Element.__init__(self, parent)

   415

        self.Type = None

   416

        self.ValueType = None

   417

        self.Id = id

   418

        self.SetName(name)

   419

        self.SetExecutionOrder(executionOrder)

   420

        self.Input = None

   421

        self.Output = None

   422

        self.SetType(type, value_type)

   423

        self.Errors = []

   424

   425

    # Make a clone of this FBD_Variable

   426

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

   427

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

   428

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

   429

        if pos is not None:

   430

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

   431

        if self.Input:

   432

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

   433

        if self.Output:

   434

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

   435

        return variable

   436

   437

    # Destructor

   438

    def __del__(self):

   439

        self.Input = None

   440

        self.Output = None

   441

   442

    # Returns the RedrawRect

   443

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

   444

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

   445

        if movex != 0 or movey != 0:

   446

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

   447

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

   448

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

   449

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

   450

        return rect

   451

   452

    # Unconnect connector

   453

    def Clean(self):

   454

        if self.Input:

   455

            self.Input.UnConnect(delete = True)

   456

        if self.Output:

   457

            self.Output.UnConnect(delete = True)

   458

   459

    # Delete this variable by calling the appropriate method

   460

    def Delete(self):

   461

        self.Parent.DeleteVariable(self)

   462

   463

    # Refresh the size of text for name

   464

    def RefreshNameSize(self):

   465

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

   466

   467

    # Refresh the size of text for execution order

   468

    def RefreshExecutionOrderSize(self):

   469

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

   470

   471

    # Refresh the variable bounding box

   472

    def RefreshBoundingBox(self):

   473

        if self.Type in (OUTPUT, INOUT):

   474

            bbx_x = self.Pos.x - CONNECTOR_SIZE

   475

        else:

   476

            bbx_x = self.Pos.x

   477

        if self.Type == INOUT:

   478

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

   479

        else:

   480

            bbx_width = self.Size[0] + CONNECTOR_SIZE

   481

        bbx_height = self.Size[1]

   482

        if self.ExecutionOrder != 0:

   483

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

   484

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

   485

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

   486

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

   487

   488

    # Refresh the position of the variable connector

   489

    def RefreshConnectors(self):

   490

        scaling = self.Parent.GetScaling()

   491

        if scaling is not None:

   492

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

   493

        else:

   494

            position = self.Size[1] / 2

   495

        if self.Input:

   496

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

   497

        if self.Output:

   498

            self.Output.SetPosition(wx.Point(self.Size[0], position))

   499

        self.RefreshConnected()

   500