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 = MiterPen(wx.BLACK)

    53

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

    54

        self.Highlights = {}

    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

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

   171

   172

    def GetInputTypes(self):

   173

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

   174

   175

    def SetOutputValues(self, values):

   176

        for output in self.Outputs:

   177

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

   178

   179

    def GetConnectionResultType(self, connector, connectortype):

   180

        resulttype = connectortype

   181

        undefined = True

   182

        for input in self.Inputs:

   183

            name = input.GetName()

   184

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

   185

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

   186

                inputtype = input.GetConnectedType()

   187

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

   188

                    resulttype = inputtype

   189

        for output in self.Outputs:

   190

            name = output.GetName()

   191

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

   192

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

   193

                outputtype = output.GetConnectedType()

   194

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

   195

                    resulttype = outputtype

   196

        if not undefined:

   197

            return resulttype

   198

        return "ANY"

   199

   200

    # Returns all the block connectors

   201

    def GetConnectors(self):

   202

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

   203

   204

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

   205

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

   206

        # Test each input connector

   207

        for input in self.Inputs:

   208

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

   209

                return input

   210

        # Test each output connector

   211

        for output in self.Outputs:

   212

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

   213

                return output

   214

        return None

   215

   216

    # Changes the block type

   217

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

   218

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

   219

            if type != self.Type:

   220

                self.Type = type

   221

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

   222

            self.Extension = extension

   223

            self.ExecutionControl = executionControl

   224

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

   225

            # inputs and outputs

   226

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

   227

            if blocktype:

   228

                self.Colour = wx.BLACK

   229

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

   230

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

   231

                if blocktype["extensible"]:

   232

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

   233

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

   234

                        start += 1

   235

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

   236

            else:

   237

                self.Colour = wx.RED

   238

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

   239

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

   240

            if self.ExecutionControl:

   241

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

   242

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

   243

            self.Pen = MiterPen(self.Colour)

   244

            self.Clean()

   245

            # Extract the inputs properties and create the corresponding connector

   246

            self.Inputs = []

   247

            for input_name, input_type, input_modifier in inputs:

   248

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

   249

                if input_modifier == "negated":

   250

                    connector.SetNegated(True)

   251

                elif input_modifier != "none":

   252

                    connector.SetEdge(input_modifier)

   253

                self.Inputs.append(connector)

   254

            # Extract the outputs properties and create the corresponding connector

   255

            self.Outputs = []

   256

            for output_name, output_type, output_modifier in outputs:

   257

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

   258

                if output_modifier == "negated":

   259

                    connector.SetNegated(True)

   260

                elif output_modifier != "none":

   261

                    connector.SetEdge(output_modifier)

   262

                self.Outputs.append(connector)

   263

            self.RefreshMinSize()

   264

            self.RefreshConnectors()

   265

            self.RefreshBoundingBox()

   266

   267

    # Returns the block type

   268

    def GetType(self):

   269

        return self.Type

   270

   271

    # Changes the block name

   272

    def SetName(self, name):

   273

        self.Name = name

   274

        self.RefreshNameSize()

   275

   276

    # Returs the block name

   277

    def GetName(self):

   278

        return self.Name

   279

   280

    # Changes the extension name

   281

    def SetExtension(self, extension):

   282

        self.Extension = extension

   283

   284

    # Returs the extension name

   285

    def GetExtension(self):

   286

        return self.Extension

   287

   288

    # Changes the execution order

   289

    def SetExecutionOrder(self, executionOrder):

   290

        self.ExecutionOrder = executionOrder

   291

        self.RefreshExecutionOrderSize()

   292

   293

    # Returs the execution order

   294

    def GetExecutionOrder(self):

   295

        return self.ExecutionOrder

   296

   297

    # Returs the execution order

   298

    def GetExecutionControl(self):

   299

        return self.ExecutionControl

   300

   301

    # Refresh the block minimum size

   302

    def RefreshMinSize(self):

   303

        # Calculate the inputs maximum width

   304

        max_input = 0

   305

        for input in self.Inputs:

   306

            w, h = input.GetNameSize()

   307

            max_input = max(max_input, w)

   308

        # Calculate the outputs maximum width

   309

        max_output = 0

   310

        for output in self.Outputs:

   311

            w, h = output.GetNameSize()

   312

            max_output = max(max_output, w)

   313

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

   314

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

   315

        self.MinSize = width, height

   316

   317

    # Returns the block minimum size

   318

    def GetMinSize(self):

   319

        return self.MinSize

   320

   321

    # Changes the negated property of the connector handled

   322

    def SetConnectorNegated(self, negated):

   323

        handle_type, handle = self.Handle

   324

        if handle_type == HANDLE_CONNECTOR:

   325

            handle.SetNegated(negated)

   326

            self.RefreshModel(False)

   327

   328

    # Changes the edge property of the connector handled

   329

    def SetConnectorEdge(self, edge):

   330

        handle_type, handle = self.Handle

   331

        if handle_type == HANDLE_CONNECTOR:

   332

            handle.SetEdge(edge)

   333

            self.RefreshModel(False)

   334

   335

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

   336

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

   337

##        if not event.Dragging():

   338

##            pos = event.GetLogicalPosition(dc)

   339

##            for input in self.Inputs:

   340

##                rect = input.GetRedrawRect()

   341

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

   342

##                    print "Find input"

   343

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

   344

##                    tip.SetBoundingRect(rect)

   345

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

   346

   347

    # Method called when a LeftDClick event have been generated

   348

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

   349

        # Edit the block properties

   350

        self.Parent.EditBlockContent(self)

   351

   352

    # Method called when a RightUp event have been generated

   353

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

   354

        pos = GetScaledEventPosition(event, dc, scaling)

   355

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

   356

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

   357

        if connector:

   358

            self.Handle = (HANDLE_CONNECTOR, connector)

   359

            self.Parent.PopupBlockMenu(connector)

   360

        else:

   361

            self.Parent.PopupBlockMenu()

   362

   363

    # Refreshes the block model

   364

    def RefreshModel(self, move=True):

   365

        self.Parent.RefreshBlockModel(self)

   366

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

   367

        if move:

   368

            for output in self.Outputs:

   369

                output.RefreshWires()

   370

   371

    # Adds an highlight to the block

   372

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

   373

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

   374

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

   375

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

   376

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

   377

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

   378

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

   379

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

   380

   381

    # Removes an highlight from the block

   382

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

   383

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

   384

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

   385

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

   386

                self.Highlights.pop(infos[0])

   387

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

   388

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

   389

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

   390

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

   391

   392

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

   393

    def ClearHighlight(self, highlight_type=None):

   394

        if highlight_type is None:

   395

            self.Highlights = {}

   396

        else:

   397

            highlight_items = self.Highlights.items()

   398

            for name, highlights in highlight_items:

   399

                highlights = ClearHighlights(highlights, highlight_type)

   400

                if len(highlights) == 0:

   401

                    self.Highlights.pop(name)

   402

        for input in self.Inputs:

   403

            input.ClearHighlights(highlight_type)

   404

        for output in self.Outputs:

   405

            output.ClearHighlights(highlight_type)

   406

   407

    # Draws block

   408

    def Draw(self, dc):

   409

        Graphic_Element.Draw(self, dc)

   410

        dc.SetPen(self.Pen)

   411

        dc.SetBrush(wx.WHITE_BRUSH)

   412

        dc.SetTextForeground(self.Colour)

   413

   414

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

   415

            name_size = dc.GetTextExtent(self.Name)

   416

            type_size = dc.GetTextExtent(self.Type)

   417

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

   418

        else:

   419

            name_size = self.NameSize

   420

            type_size = self.TypeSize

   421

            executionorder_size = self.ExecutionOrderSize

   422

   423

        # Draw a rectangle with the block size

   424

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

   425

        # Draw block name and block type

   426

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

   427

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

   428

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

   429

                    self.Pos.y + 5)

   430

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

   431

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

   432

        # Draw inputs and outputs connectors

   433

        for input in self.Inputs:

   434

            input.Draw(dc)

   435

        for output in self.Outputs:

   436

            output.Draw(dc)

   437

        if self.ExecutionOrder != 0:

   438

            # Draw block execution order

   439

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

   440

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

   441

   442

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

   443

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

   444

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

   445

   446

   447

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

   448

#                        Function Block Diagram Variable

   449

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

   450

   451

"""

   452

Class that implements the graphic representation of a variable

   453

"""

   454

   455

class FBD_Variable(Graphic_Element):

   456

   457

    # Create a new variable

   458

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

   459

        Graphic_Element.__init__(self, parent)

   460

        self.Type = None

   461

        self.ValueType = None

   462

        self.Id = id

   463

        self.SetName(name)

   464

        self.SetExecutionOrder(executionOrder)

   465

        self.Input = None

   466

        self.Output = None

   467

        self.SetType(type, value_type)

   468

        self.Highlights = []

   469

   470

    # Make a clone of this FBD_Variable

   471

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

   472

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

   473

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

   474

        if pos is not None:

   475

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

   476

        else:

   477

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

   478

        if self.Input:

   479

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

   480

        if self.Output:

   481

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

   482

        return variable

   483

   484

    def GetConnectorTranslation(self, element):

   485

        connectors = {}

   486

        if self.Input is not None:

   487

            connectors[self.Input] = element.Input

   488

        if self.Output is not None:

   489

            connectors[self.Output] = element.Output

   490

        return connectors

   491

   492

    def Flush(self):

   493

        if self.Input is not None:

   494

            self.Input.Flush()

   495

            self.Input = None

   496