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.Description = None

    45

        self.Extension = None

    46

        self.ExecutionControl = False

    47

        self.Id = id

    48

        self.SetName(name)

    49

        self.SetExecutionOrder(executionOrder)

    50

        self.Inputs = []

    51

        self.Outputs = []

    52

        self.Colour = wx.BLACK

    53

        self.Pen = MiterPen(wx.BLACK)

    54

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

    55

        self.Highlights = {}

    56

    57

    # Make a clone of this FBD_Block

    58

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

    59

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

    60

            name = self.Name

    61

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

    62

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

    63

        if pos is not None:

    64

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

    65

        else:

    66

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

    67

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

    68

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

    69

        return block

    70

    71

    def GetConnectorTranslation(self, element):

    72

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

    73

    74

    def Flush(self):

    75

        for input in self.Inputs:

    76

            input.Flush()

    77

        self.Inputs = []

    78

        for output in self.Outputs:

    79

            output.Flush()

    80

        self.Outputs = []

    81

    82

    # Returns the RedrawRect

    83

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

    84

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

    85

        if movex != 0 or movey != 0:

    86

            for input in self.Inputs:

    87

                if input.IsConnected():

    88

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

    89

            for output in self.Outputs:

    90

                if output.IsConnected():

    91

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

    92

        return rect

    93

    94

    # Delete this block by calling the appropriate method

    95

    def Delete(self):

    96

        self.Parent.DeleteBlock(self)

    97

    98

    # Unconnect all inputs and outputs

    99

    def Clean(self):

   100

        for input in self.Inputs:

   101

            input.UnConnect(delete = True)

   102

        for output in self.Outputs:

   103

            output.UnConnect(delete = True)

   104

   105

    # Refresh the size of text for name

   106

    def RefreshNameSize(self):

   107

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

   108

   109

    # Refresh the size of text for execution order

   110

    def RefreshExecutionOrderSize(self):

   111

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

   112

   113

    # Refresh the block bounding box

   114

    def RefreshBoundingBox(self):

   115

        # Calculate the size of the name outside the block

   116

        text_width, text_height = self.NameSize

   117

        # Calculate the bounding box size

   118

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

   119

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

   120

        if self.Name != "":

   121

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

   122

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

   123

        else:

   124

            bbx_y = self.Pos.y

   125

            bbx_height = self.Size[1]

   126

        if self.ExecutionOrder != 0:

   127

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

   128

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

   129

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

   130

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

   131

   132

    # Refresh the positions of the block connectors

   133

    def RefreshConnectors(self):

   134

        scaling = self.Parent.GetScaling()

   135

        # Calculate the size for the connector lines

   136

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

   137

        if lines > 0:

   138

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

   139

            # Update inputs and outputs positions

   140

            position = BLOCK_LINE_SIZE + linesize / 2

   141

            for i in xrange(lines):

   142

                if scaling is not None:

   143

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

   144

                else:

   145

                    ypos = position

   146

                if i < len(self.Inputs):

   147

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

   148

                if i < len(self.Outputs):

   149

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

   150

                position += linesize

   151

        self.RefreshConnected()

   152

   153

    # Refresh the positions of wires connected to inputs and outputs

   154

    def RefreshConnected(self, exclude = []):

   155

        for input in self.Inputs:

   156

            input.MoveConnected(exclude)

   157

        for output in self.Outputs:

   158

            output.MoveConnected(exclude)

   159

   160

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

   161

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

   162

        # if a name is given

   164

            # Test each input and output connector

   168

            for output in self.Outputs:

   169

                if name == output.GetName():

   170

                    return output

   171

        return self.FindNearestConnector(position, self.Inputs + self.Outputs)

   172

   173

    def GetInputTypes(self):

   174

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

   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

        undefined = True

   183

        for input in self.Inputs:

   184

            name = input.GetName()

   185

            undefined = undefined and input.GetType(True) == "ANY"

   186

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

   187

                inputtype = input.GetConnectedType()

   188

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

   189

                    resulttype = inputtype

   190

        for output in self.Outputs:

   191

            name = output.GetName()

   192

            undefined = undefined and output.GetType(True) == "ANY"

   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

        if not undefined:

   198

            return resulttype

   199

        return "ANY"

   200

   201

    # Returns all the block connectors

   202

    def GetConnectors(self):

   203

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

   204

   205

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

   206

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

   207

        # Test each input connector

   208

        for input in self.Inputs:

   209

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

   210

                return input

   211

        # Test each output connector

   212

        for output in self.Outputs:

   213

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

   214

                return output

   215

        return None

   216

   217

    # Changes the block type

   218

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

   219

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

   220

            if type != self.Type:

   221

                self.Type = type

   222

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

   223

            self.Extension = extension

   224

            self.ExecutionControl = executionControl

   225

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

   226

            # inputs and outputs

   227

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

   228

            if blocktype:

   229

                self.Colour = wx.BLACK

   230

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

   231

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

   232

                if blocktype["extensible"]:

   233

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

   234

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

   235

                        start += 1

   236

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

   237

                comment = blocktype["comment"]

   238

                self.Description = _(comment) + blocktype.get("usage", "")

   239

            else:

   240

                self.Colour = wx.RED

   241

                inputs = connectors.get("inputs", [])

   242

                outputs = connectors.get("outputs", [])

   243

                self.Description = None

   244

            if self.ExecutionControl:

   245

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

   246

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

   247

            self.Pen = MiterPen(self.Colour)

   248

            self.Clean()

   249

            # Extract the inputs properties and create the corresponding connector

   250

            self.Inputs = []

   251

            for input_name, input_type, input_modifier in inputs:

   252

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

   253

                if input_modifier == "negated":

   254

                    connector.SetNegated(True)

   255

                elif input_modifier != "none":

   256

                    connector.SetEdge(input_modifier)

   257

                self.Inputs.append(connector)

   258

            # Extract the outputs properties and create the corresponding connector

   259

            self.Outputs = []

   260

            for output_name, output_type, output_modifier in outputs:

   261

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

   262

                if output_modifier == "negated":

   263

                    connector.SetNegated(True)

   264

                elif output_modifier != "none":

   265

                    connector.SetEdge(output_modifier)

   266

                self.Outputs.append(connector)

   267

            self.RefreshMinSize()

   268

            self.RefreshConnectors()

   269

            self.RefreshBoundingBox()

   270

   271

    # Returns the block type

   272

    def GetType(self):

   273

        return self.Type

   274

   275

    # Changes the block name

   276

    def SetName(self, name):

   277

        self.Name = name

   278

        self.RefreshNameSize()

   279

   280

    # Returs the block name

   281

    def GetName(self):

   282

        return self.Name

   283

   284

    # Changes the extension name

   285

    def SetExtension(self, extension):

   286

        self.Extension = extension

   287

   288

    # Returs the extension name

   289

    def GetExtension(self):

   290

        return self.Extension

   291

   292

    # Changes the execution order

   293

    def SetExecutionOrder(self, executionOrder):

   294

        self.ExecutionOrder = executionOrder

   295

        self.RefreshExecutionOrderSize()

   296

   297

    # Returs the execution order

   298

    def GetExecutionOrder(self):

   299

        return self.ExecutionOrder

   300

   301

    # Returs the execution order

   302

    def GetExecutionControl(self):

   303

        return self.ExecutionControl

   304

   305

    # Refresh the block minimum size

   306

    def RefreshMinSize(self):

   307

        # Calculate the inputs maximum width

   308

        max_input = 0

   309

        for input in self.Inputs:

   310

            w, h = input.GetNameSize()

   311

            max_input = max(max_input, w)

   312

        # Calculate the outputs maximum width

   313

        max_output = 0

   314

        for output in self.Outputs:

   315

            w, h = output.GetNameSize()

   316

            max_output = max(max_output, w)

   317

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

   318

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

   319

        self.MinSize = width, height

   320

   321

    # Returns the block minimum size

   322

    def GetMinSize(self):

   323

        return self.MinSize

   324

   325

    # Changes the negated property of the connector handled

   326

    def SetConnectorNegated(self, negated):

   327

        handle_type, handle = self.Handle

   328

        if handle_type == HANDLE_CONNECTOR:

   329

            handle.SetNegated(negated)

   330

            self.RefreshModel(False)

   331

   332

    # Changes the edge property of the connector handled

   333

    def SetConnectorEdge(self, edge):

   334

        handle_type, handle = self.Handle

   335

        if handle_type == HANDLE_CONNECTOR:

   336

            handle.SetEdge(edge)

   337

            self.RefreshModel(False)

   338

   339

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

   340

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

   341

##        if not event.Dragging():

   342

##            pos = event.GetLogicalPosition(dc)

   343

##            for input in self.Inputs:

   344

##                rect = input.GetRedrawRect()

   345

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

   346

##                    print "Find input"

   347

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

   348

##                    tip.SetBoundingRect(rect)

   349

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

   350

   351

    # Method called when a LeftDClick event have been generated

   352

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

   353

        # Edit the block properties

   354

        self.Parent.EditBlockContent(self)

   355

   356

    # Method called when a RightUp event have been generated

   357

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

   358

        pos = GetScaledEventPosition(event, dc, scaling)

   359

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

   360

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

   361

        if connector:

   362

            self.Handle = (HANDLE_CONNECTOR, connector)

   363

            self.Parent.PopupBlockMenu(connector)

   364

        else:

   365

            self.Parent.PopupBlockMenu()

   366

   367

    # Refreshes the block model

   368

    def RefreshModel(self, move=True):

   369

        self.Parent.RefreshBlockModel(self)

   370

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

   371

        if move:

   372

            for output in self.Outputs:

   373

                output.RefreshWires()

   374

   375

    def GetToolTipValue(self):

   376

        return self.Description

   377

   378

    # Adds an highlight to the block

   379

    def AddHighlight(self, infos, start, end ,highlight_type):

   380

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

   381

            highlights = self.Highlights.setdefault(infos[0], [])

   382

            AddHighlight(highlights, (start, end, highlight_type))

   383

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

   384

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

   385

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

   386

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

   387

   388

    # Removes an highlight from the block

   389

    def RemoveHighlight(self, infos, start, end, highlight_type):

   390

        if infos[0] in ["type", "name"]:

   391

            highlights = self.Highlights.get(infos[0], [])

   392

            if RemoveHighlight(highlights, (start, end, highlight_type)) and len(highlights) == 0:

   393

                self.Highlights.pop(infos[0])

   394

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

   395

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

   396

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

   397

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

   398

   399

    # Removes all the highlights of one particular type from the block

   400

    def ClearHighlight(self, highlight_type=None):

   401

        if highlight_type is None:

   402

            self.Highlights = {}

   403

        else:

   404

            highlight_items = self.Highlights.items()

   405

            for name, highlights in highlight_items:

   406

                highlights = ClearHighlights(highlights, highlight_type)

   407

                if len(highlights) == 0:

   408

                    self.Highlights.pop(name)

   409

        for input in self.Inputs:

   410

            input.ClearHighlights(highlight_type)

   411

        for output in self.Outputs:

   412

            output.ClearHighlights(highlight_type)

   413

   414

    # Draws block

   415

    def Draw(self, dc):

   416

        Graphic_Element.Draw(self, dc)

   417

        dc.SetPen(self.Pen)

   418

        dc.SetBrush(wx.WHITE_BRUSH)

   419

        dc.SetTextForeground(self.Colour)

   420

   421

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

   422

            name_size = dc.GetTextExtent(self.Name)

   423

            type_size = dc.GetTextExtent(self.Type)

   424

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

   425

        else:

   426

            name_size = self.NameSize

   427

            type_size = self.TypeSize

   428

            executionorder_size = self.ExecutionOrderSize

   429

   430

        # Draw a rectangle with the block size

   431

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

   432

        # Draw block name and block type

   433

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

   434

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

   435

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

   436

                    self.Pos.y + 5)

   437

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

   438

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

   439

        # Draw inputs and outputs connectors

   440

        for input in self.Inputs:

   441

            input.Draw(dc)

   442

        for output in self.Outputs:

   443

            output.Draw(dc)

   444

        if self.ExecutionOrder != 0:

   445

            # Draw block execution order

   446

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

   447

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

   448

   449

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

   450

            DrawHighlightedText(dc, self.Name, self.Highlights.get("name", []), name_pos[0], name_pos[1])

   451

            DrawHighlightedText(dc, self.Type, self.Highlights.get("type", []), type_pos[0], type_pos[1])

   452

   453

   454

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

   455

#                        Function Block Diagram Variable

   456

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

   457

   458

"""

   459

Class that implements the graphic representation of a variable

   460

"""

   461

   462

class FBD_Variable(Graphic_Element):

   463

   464

    # Create a new variable

   465

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

   466

        Graphic_Element.__init__(self, parent)

   467

        self.Type = None

   468

        self.ValueType = None

   469

        self.Id = id

   470

        self.SetName(name)

   471

        self.SetExecutionOrder(executionOrder)

   472

        self.Input = None

   473

        self.Output = None

   474

        self.SetType(type, value_type)

   475

        self.Highlights = []

   476

   477

    # Make a clone of this FBD_Variable

   478

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

   479

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

   480

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

   481

        if pos is not None:

   482

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

   483

        else:

   484

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

   485

        if self.Input:

   486

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

   487

        if self.Output:

   488

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

   489

        return variable

   490

   491

    def GetConnectorTranslation(self, element):

   492

        connectors = {}

   493

        if self.Input is not None:

   494

            connectors[self.Input] = element.Input

   495

        if self.Output is not None: