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

        else:

    65

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

    66

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

    67

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

    68

        return block

    69

    70

    def GetConnectorTranslation(self, element):

    71

        return dict(zip(self.Inputs + self.Outputs, element.Inputs + element.Outputs))

    72

    73

    def Flush(self):

    74

        for input in self.Inputs:

    75

            input.Flush()

    76

        self.Inputs = []

    77

        for output in self.Outputs:

    78

            output.Flush()

    79

        self.Outputs = []

    80

    81

    # Returns the RedrawRect

    82

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

    83

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

    84

        if movex != 0 or movey != 0:

    85

            for input in self.Inputs:

    86

                if input.IsConnected():

    87

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

    88

            for output in self.Outputs:

    89

                if output.IsConnected():

    90

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

    91

        return rect

    92

    93

    # Delete this block by calling the appropriate method

    94

    def Delete(self):

    95

        self.Parent.DeleteBlock(self)

    96

    97

    # Unconnect all inputs and outputs

    98

    def Clean(self):

    99

        for input in self.Inputs:

   100

            input.UnConnect(delete = True)

   101

        for output in self.Outputs:

   102

            output.UnConnect(delete = True)

   103

   104

    # Refresh the size of text for name

   105

    def RefreshNameSize(self):

   106

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

   107

   108

    # Refresh the size of text for execution order

   109

    def RefreshExecutionOrderSize(self):

   110

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

   111

   112

    # Refresh the block bounding box

   113

    def RefreshBoundingBox(self):

   114

        # Calculate the size of the name outside the block

   115

        text_width, text_height = self.NameSize

   116

        # Calculate the bounding box size

   117

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

   118

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

   119

        if self.Name != "":

   120

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

   121

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

   122

        else:

   123

            bbx_y = self.Pos.y

   124

            bbx_height = self.Size[1]

   125

        if self.ExecutionOrder != 0:

   126

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

   127

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

   128

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

   129

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

   130

   131

    # Refresh the positions of the block connectors

   132

    def RefreshConnectors(self):

   133

        scaling = self.Parent.GetScaling()

   134

        # Calculate the size for the connector lines

   135

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

   136

        if lines > 0:

   137

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

   138

            # Update inputs and outputs positions

   139

            position = BLOCK_LINE_SIZE + linesize / 2

   140

            for i in xrange(lines):

   141

                if scaling is not None:

   142

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

   143

                else:

   144

                    ypos = position

   145

                if i < len(self.Inputs):

   146

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

   147

                if i < len(self.Outputs):

   148

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

   149

                position += linesize

   150

        self.RefreshConnected()

   151

   152

    # Refresh the positions of wires connected to inputs and outputs

   153

    def RefreshConnected(self, exclude = []):

   154

        for input in self.Inputs:

   155

            input.MoveConnected(exclude)

   156

        for output in self.Outputs:

   157

            output.MoveConnected(exclude)

   158

   159

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

   160

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

   161

        # if a name is given

   162

        if name:

   163

            # Test each input and output connector

   164

            for input in self.Inputs:

   165

                if name == input.GetName():

   166

                    return input

   167

            for output in self.Outputs:

   168

                if name == output.GetName():

   169

                    return output

   170

        # Test each input connector

   171

        for input in self.Inputs:

   172

            input_pos = input.GetRelPosition()

   173

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

   174

                return input

   175

        # Test each output connector

   176

        for output in self.Outputs:

   177

            output_pos = output.GetRelPosition()

   178

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

   179

                return output

   180

        return None

   181

   182

    def GetInputTypes(self):

   183

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

   184

   185

    def SetOutputValues(self, values):

   186

        for output in self.Outputs:

   187

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

   188

   189

    def GetConnectionResultType(self, connector, connectortype):

   190

        resulttype = connectortype

   191

        for input in self.Inputs:

   192

            name = input.GetName()

   193

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

   194

                inputtype = input.GetConnectedType()

   195

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

   196

                    resulttype = inputtype

   197

        for output in self.Outputs:

   198

            name = output.GetName()

   199

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

   200

                outputtype = output.GetConnectedType()

   201

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

   202

                    resulttype = outputtype

   203

        return resulttype

   204

   205

    # Returns all the block connectors

   206

    def GetConnectors(self):

   207

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

   208

   209

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

   210

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

   211

        # Test each input connector

   212

        for input in self.Inputs:

   213

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

   214

                return input

   215

        # Test each output connector

   216

        for output in self.Outputs:

   217

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

   218

                return output

   219

        return None

   220

   221

    # Changes the block type

   222

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

   223

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

   224

            if type != self.Type:

   225

                self.Type = type

   226

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

   227

            self.Extension = extension

   228

            self.ExecutionControl = executionControl

   229

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

   230

            # inputs and outputs

   231

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

   232

            if blocktype:

   233

                self.Colour = wx.BLACK

   234

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

   235

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

   236

                if blocktype["extensible"]:

   237

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

   238

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

   239

                        start += 1

   240

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

   241

            else:

   242

                self.Colour = wx.RED

   243

                if "inputs" in connectors:

   244

                    inputs = connectors["inputs"]

   245

                else:

   246

                    inputs = []

   247

                if "outputs" in connectors:

   248

                    outputs = connectors["outputs"]

   249

                else:

   250

                    outputs = []

   251

            if self.ExecutionControl:

   252

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

   253

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

   254

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

   255

            self.Clean()

   256

            # Extract the inputs properties and create the corresponding connector

   257

            self.Inputs = []

   258

            for input_name, input_type, input_modifier in inputs:

   259

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

   260

                if input_modifier == "negated":

   261

                    connector.SetNegated(True)

   262

                elif input_modifier != "none":

   263

                    connector.SetEdge(input_modifier)

   264

                self.Inputs.append(connector)

   265

            # Extract the outputs properties and create the corresponding connector

   266

            self.Outputs = []

   267

            for output_name, output_type, output_modifier in outputs:

   268

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

   269

                if output_modifier == "negated":

   270

                    connector.SetNegated(True)

   271

                elif output_modifier != "none":

   272

                    connector.SetEdge(output_modifier)

   273

                self.Outputs.append(connector)

   274

            self.RefreshMinSize()

   275

            self.RefreshConnectors()

   276

            self.RefreshBoundingBox()

   277

   278

    # Returns the block type

   279

    def GetType(self):

   280

        return self.Type

   281

   282

    # Changes the block name

   283

    def SetName(self, name):

   284

        self.Name = name

   285

        self.RefreshNameSize()

   286

   287

    # Returs the block name

   288

    def GetName(self):

   289

        return self.Name

   290

   291

    # Changes the extension name

   292

    def SetExtension(self, extension):

   293

        self.Extension = extension

   294

   295

    # Returs the extension name

   296

    def GetExtension(self):

   297

        return self.Extension

   298

   299

    # Changes the execution order

   300

    def SetExecutionOrder(self, executionOrder):

   301

        self.ExecutionOrder = executionOrder

   302

        self.RefreshExecutionOrderSize()

   303

   304

    # Returs the execution order

   305

    def GetExecutionOrder(self):

   306

        return self.ExecutionOrder

   307

   308

    # Returs the execution order

   309

    def GetExecutionControl(self):

   310

        return self.ExecutionControl

   311

   312

    # Refresh the block minimum size

   313

    def RefreshMinSize(self):

   314

        # Calculate the inputs maximum width

   315

        max_input = 0

   316

        for input in self.Inputs:

   317

            w, h = input.GetNameSize()

   318

            max_input = max(max_input, w)

   319

        # Calculate the outputs maximum width

   320

        max_output = 0

   321

        for output in self.Outputs:

   322

            w, h = output.GetNameSize()

   323

            max_output = max(max_output, w)

   324

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

   325

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

   326

        self.MinSize = width, height

   327

   328

    # Returns the block minimum size

   329

    def GetMinSize(self):

   330

        return self.MinSize

   331

   332

    # Changes the negated property of the connector handled

   333

    def SetConnectorNegated(self, negated):

   334

        handle_type, handle = self.Handle

   335

        if handle_type == HANDLE_CONNECTOR:

   336

            handle.SetNegated(negated)

   337

            self.RefreshModel(False)

   338

   339

    # Changes the edge property of the connector handled

   340

    def SetConnectorEdge(self, edge):

   341

        handle_type, handle = self.Handle

   342

        if handle_type == HANDLE_CONNECTOR:

   343

            handle.SetEdge(edge)

   344

            self.RefreshModel(False)

   345

   346

##    # Method called when a Motion event have been generated

   347

##    def OnMotion(self, event, dc, scaling):

   348

##        if not event.Dragging():

   349

##            pos = event.GetLogicalPosition(dc)

   350

##            for input in self.Inputs:

   351

##                rect = input.GetRedrawRect()

   352

##                if rect.InsideXY(pos.x, pos.y):

   353

##                    print "Find input"

   354

##                    tip = wx.TipWindow(self.Parent, "Test")

   355

##                    tip.SetBoundingRect(rect)

   356

##        return Graphic_Element.OnMotion(self, event, dc, scaling)

   357

   358

    # Method called when a LeftDClick event have been generated

   359

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

   360

        # Edit the block properties

   361

        self.Parent.EditBlockContent(self)

   362

   363

    # Method called when a RightUp event have been generated

   364

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

   365

        pos = GetScaledEventPosition(event, dc, scaling)

   366

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

   367

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

   368

        if connector:

   369

            self.Handle = (HANDLE_CONNECTOR, connector)

   370

            self.Parent.PopupBlockMenu(connector)

   371

        else:

   372

            self.Parent.PopupBlockMenu()

   373

   374

    # Refreshes the block model

   375

    def RefreshModel(self, move=True):

   376

        self.Parent.RefreshBlockModel(self)

   377

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

   378

        if move:

   379

            for output in self.Outputs:

   380

                output.RefreshWires()

   381

   382

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

   383

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

   384

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

   385

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

   386

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

   387

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

   388

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

   389

   390

    # Draws block

   391

    def Draw(self, dc):

   392

        Graphic_Element.Draw(self, dc)

   393

        dc.SetPen(self.Pen)

   394

        dc.SetBrush(wx.WHITE_BRUSH)

   395

        dc.SetTextForeground(self.Colour)

   396

   397

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

   398

            name_size = dc.GetTextExtent(self.Name)

   399

            type_size = dc.GetTextExtent(self.Type)

   400

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

   401

        else:

   402

            name_size = self.NameSize

   403

            type_size = self.TypeSize

   404

            executionorder_size = self.ExecutionOrderSize

   405

   406

        # Draw a rectangle with the block size

   407

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

   408

        # Draw block name and block type

   409

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

   410

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

   411

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

   412

                    self.Pos.y + 5)

   413

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

   414

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

   415

        # Draw inputs and outputs connectors

   416

        for input in self.Inputs:

   417

            input.Draw(dc)

   418

        for output in self.Outputs:

   419

            output.Draw(dc)

   420

        if self.ExecutionOrder != 0:

   421

            # Draw block execution order

   422

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

   423

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

   424

        if "name" in self.Errors:

   425

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

   426

        if "type" in self.Errors:

   427

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

   428

        dc.SetTextForeground(wx.BLACK)

   429

   430

   431

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

   432

#                        Function Block Diagram Variable

   433

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

   434

   435

"""

   436

Class that implements the graphic representation of a variable

   437

"""

   438

   439

class FBD_Variable(Graphic_Element):

   440

   441

    # Create a new variable

   442

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

   443

        Graphic_Element.__init__(self, parent)

   444

        self.Type = None

   445

        self.ValueType = None

   446

        self.Id = id

   447

        self.SetName(name)

   448

        self.SetExecutionOrder(executionOrder)

   449

        self.Input = None

   450

        self.Output = None

   451

        self.SetType(type, value_type)

   452

        self.Errors = []

   453

   454

    # Make a clone of this FBD_Variable

   455

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

   456

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

   457

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

   458

        if pos is not None:

   459

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

   460

        else:

   461

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

   462

        if self.Input:

   463

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

   464

        if self.Output:

   465

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

   466

        return variable

   467

   468

    def GetConnectorTranslation(self, element):

   469

        connectors = {}

   470

        if self.Input is not None:

   471

            connectors[self.Input] = element.Input

   472

        if self.Output is not None:

   473

            connectors[self.Output] = element.Output

   474

        return connectors

   475

   476

    def Flush(self):

   477

        if self.Input is not None:

   478

            self.Input.Flush()

   479

            self.Input = None

   480

        if self.Output is not None:

   481

            self.Output.Flush()

   482

            self.Output = None

   483

   484

    # Returns the RedrawRect

   485

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

   486

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

   487

        if movex != 0 or movey != 0:

   488

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

   489

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

   490

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

   491

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

   492

        return rect

   493

   494

    # Unconnect connector

   495

    def Clean(self):

   496

        if self.Input:

   497

            self.Input.UnConnect(delete = True)