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

def TestConnectorName(name, block_type):

    39

    return name in ["OUT", "MN", "MX"] or name.startswith("IN") and (block_type, name) != ("EXPT", "IN2")

    40

    41

class FBD_Block(Graphic_Element):

    42

    43

    # Create a new block

    44

    def __init__(self, parent, type, name, id = None, extension = 0, inputs = None, connectors = {}, executionControl = False, executionOrder = 0):

    45

        Graphic_Element.__init__(self, parent)

    46

        self.Type = None

    47

        self.Description = None

    48

        self.Extension = None

    49

        self.ExecutionControl = False

    50

        self.Id = id

    51

        self.SetName(name)

    52

        self.SetExecutionOrder(executionOrder)

    53

        self.Inputs = []

    54

        self.Outputs = []

    55

        self.Colour = wx.BLACK

    56

        self.Pen = MiterPen(wx.BLACK)

    57

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

    58

        self.Highlights = {}

    59

    60

    # Make a clone of this FBD_Block

    61

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

    62

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

    63

            name = self.Name

    64

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

    65

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

    66

        if pos is not None:

    67

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

    68

        else:

    69

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

    70

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

    71

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

    72

        return block

    73

    74

    def GetConnectorTranslation(self, element):

    75

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

    76

    77

    def Flush(self):

    78

        for input in self.Inputs:

    79

            input.Flush()

    80

        self.Inputs = []

    81

        for output in self.Outputs:

    82

            output.Flush()

    83

        self.Outputs = []

    84

    85

    # Returns the RedrawRect

    86

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

    87

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

    88

        if movex != 0 or movey != 0:

    89

            for input in self.Inputs:

    90

                if input.IsConnected():

    91

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

    92

            for output in self.Outputs:

    93

                if output.IsConnected():

    94

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

    95

        return rect

    96

    97

    # Delete this block by calling the appropriate method

    98

    def Delete(self):

    99

        self.Parent.DeleteBlock(self)

   100

   101

    # Unconnect all inputs and outputs

   102

    def Clean(self):

   103

        for input in self.Inputs:

   104

            input.UnConnect(delete = True)

   105

        for output in self.Outputs:

   106

            output.UnConnect(delete = True)

   107

   108

    # Refresh the size of text for name

   109

    def RefreshNameSize(self):

   110

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

   111

   112

    # Refresh the size of text for execution order

   113

    def RefreshExecutionOrderSize(self):

   114

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

   115

   116

    # Refresh the block bounding box

   117

    def RefreshBoundingBox(self):

   118

        # Calculate the size of the name outside the block

   119

        text_width, text_height = self.NameSize

   120

        # Calculate the bounding box size

   121

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

   122

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

   123

        if self.Name != "":

   124

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

   125

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

   126

        else:

   127

            bbx_y = self.Pos.y

   128

            bbx_height = self.Size[1]

   129

        if self.ExecutionOrder != 0:

   130

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

   131

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

   132

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

   133

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

   134

   135

    # Refresh the positions of the block connectors

   136

    def RefreshConnectors(self):

   137

        scaling = self.Parent.GetScaling()

   138

        # Calculate the size for the connector lines

   139

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

   140

        if lines > 0:

   141

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

   142

            # Update inputs and outputs positions

   143

            position = BLOCK_LINE_SIZE + linesize / 2

   144

            for i in xrange(lines):

   145

                if scaling is not None:

   146

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

   147

                else:

   148

                    ypos = position

   149

                if i < len(self.Inputs):

   150

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

   151

                if i < len(self.Outputs):

   152

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

   153

                position += linesize

   154

        self.RefreshConnected()

   155

   156

    # Refresh the positions of wires connected to inputs and outputs

   157

    def RefreshConnected(self, exclude = []):

   158

        for input in self.Inputs:

   159

            input.MoveConnected(exclude)

   160

        for output in self.Outputs:

   161

            output.MoveConnected(exclude)

   162

   163

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

   164

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

   165

        # if a name is given

   166

        if name is not None:

   167

            # Test each input and output connector

   168

            #for input in self.Inputs:

   169

            #    if name == input.GetName():

   170

            #        return input

   171

            for output in self.Outputs:

   172

                if name == output.GetName():

   173

                    return output

   174

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

   175

   176

    def GetInputTypes(self):

   177

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

   178

   179

    def SetOutputValues(self, values):

   180

        for output in self.Outputs:

   181

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

   182

   183

    def GetConnectionResultType(self, connector, connectortype):

   184

        if not TestConnectorName(connector.GetName(), self.Type):

   185

            return connectortype

   186

        resulttype = connectortype

   187

        for input in self.Inputs:

   188

            if input != connector and TestConnectorName(input.GetName(), self.Type):

   189

                inputtype = input.GetConnectedType()

   190

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

   191

                    resulttype = inputtype

   192

        for output in self.Outputs:

   193

            if output != connector and TestConnectorName(output.GetName(), self.Type):

   194

                outputtype = output.GetConnectedType()

   195

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

   196

                    resulttype = outputtype

   197

        return resulttype

   198

   199

    # Returns all the block connectors

   200

    def GetConnectors(self):

   201

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

   202

   203

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

   204

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

   205

        # Test each input connector

   206

        for input in self.Inputs:

   207

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

   208

                return input

   209

        # Test each output connector

   210

        for output in self.Outputs:

   211

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

   212

                return output

   213

        return None

   214

   215

    # Changes the block type

   216

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

   217

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

   218

            if type != self.Type:

   219

                self.Type = type

   220

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

   221

            self.Extension = extension

   222

            self.ExecutionControl = executionControl

   223

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

   224

            # inputs and outputs

   225

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

   226

            if blocktype:

   227

                self.Colour = wx.BLACK

   228

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

   229

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

   230

                if blocktype["extensible"]:

   231

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

   232

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

   233

                        start += 1

   234

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

   235

                comment = blocktype["comment"]

   236

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

   237

            else:

   238

                self.Colour = wx.RED

   239

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

   240

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

   241

                self.Description = None

   242

            if self.ExecutionControl:

   243

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

   244

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

   245

            self.Pen = MiterPen(self.Colour)

   246

            self.Clean()

   247

            # Extract the inputs properties and create the corresponding connector

   248

            self.Inputs = []

   249

            for input_name, input_type, input_modifier in inputs:

   250

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

   251

                if input_modifier == "negated":

   252

                    connector.SetNegated(True)

   253

                elif input_modifier != "none":

   254

                    connector.SetEdge(input_modifier)

   255

                self.Inputs.append(connector)

   256

            # Extract the outputs properties and create the corresponding connector

   257

            self.Outputs = []

   258

            for output_name, output_type, output_modifier in outputs:

   259

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

   260

                if output_modifier == "negated":

   261

                    connector.SetNegated(True)

   262

                elif output_modifier != "none":

   263

                    connector.SetEdge(output_modifier)

   264

                self.Outputs.append(connector)

   265

            self.RefreshMinSize()

   266

            self.RefreshConnectors()

   267

            self.RefreshBoundingBox()

   268

   269

    # Returns the block type

   270

    def GetType(self):

   271

        return self.Type

   272

   273

    # Changes the block name

   274

    def SetName(self, name):

   275

        self.Name = name

   276

        self.RefreshNameSize()

   277

   278

    # Returs the block name

   279

    def GetName(self):

   280

        return self.Name

   281

   282

    # Changes the extension name

   283

    def SetExtension(self, extension):

   284

        self.Extension = extension

   285

   286

    # Returs the extension name

   287

    def GetExtension(self):

   288

        return self.Extension

   289

   290

    # Changes the execution order

   291

    def SetExecutionOrder(self, executionOrder):

   292

        self.ExecutionOrder = executionOrder

   293

        self.RefreshExecutionOrderSize()

   294

   295

    # Returs the execution order

   296

    def GetExecutionOrder(self):

   297

        return self.ExecutionOrder

   298

   299

    # Returs the execution order

   300

    def GetExecutionControl(self):

   301

        return self.ExecutionControl

   302

   303

    # Refresh the block minimum size

   304

    def RefreshMinSize(self):

   305

        # Calculate the inputs maximum width

   306

        max_input = 0

   307

        for input in self.Inputs:

   308

            w, h = input.GetNameSize()

   309

            max_input = max(max_input, w)

   310

        # Calculate the outputs maximum width

   311

        max_output = 0

   312

        for output in self.Outputs:

   313

            w, h = output.GetNameSize()

   314

            max_output = max(max_output, w)

   315

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

   316

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

   317

        self.MinSize = width, height

   318

   319

    # Returns the block minimum size

   320

    def GetMinSize(self):

   321

        return self.MinSize

   322

   323

    # Changes the negated property of the connector handled

   324

    def SetConnectorNegated(self, negated):

   325

        handle_type, handle = self.Handle

   326

        if handle_type == HANDLE_CONNECTOR:

   327

            handle.SetNegated(negated)

   328

            self.RefreshModel(False)

   329

   330

    # Changes the edge property of the connector handled

   331

    def SetConnectorEdge(self, edge):

   332

        handle_type, handle = self.Handle

   333

        if handle_type == HANDLE_CONNECTOR:

   334

            handle.SetEdge(edge)

   335

            self.RefreshModel(False)

   336

   337

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

   338

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

   339

##        if not event.Dragging():

   340

##            pos = event.GetLogicalPosition(dc)

   341

##            for input in self.Inputs:

   342

##                rect = input.GetRedrawRect()

   343

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

   344

##                    print "Find input"

   345

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

   346

##                    tip.SetBoundingRect(rect)

   347

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

   348

   349

    # Method called when a LeftDClick event have been generated

   350

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

   351

        # Edit the block properties

   352

        self.Parent.EditBlockContent(self)

   353

   354

    # Method called when a RightUp event have been generated

   355

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

   356

        pos = GetScaledEventPosition(event, dc, scaling)

   357

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

   358

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

   359

        if connector:

   360

            self.Handle = (HANDLE_CONNECTOR, connector)

   361

            self.Parent.PopupBlockMenu(connector)

   362

        else:

   363

            self.Parent.PopupBlockMenu()

   364

   365

    # Refreshes the block model

   366

    def RefreshModel(self, move=True):

   367

        self.Parent.RefreshBlockModel(self)

   368

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

   369

        if move:

   370

            for output in self.Outputs:

   371

                output.RefreshWires()

   372

   373

    def GetToolTipValue(self):

   374

        return self.Description

   375

   376

    # Adds an highlight to the block

   377

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

   378

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

   379

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

   380

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

   381

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

   382

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

   383

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

   384

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

   385

   386

    # Removes an highlight from the block

   387

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

   388

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

   389

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

   390

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

   391

                self.Highlights.pop(infos[0])

   392

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

   393

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

   394

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

   395

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

   396

   397

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

   398

    def ClearHighlight(self, highlight_type=None):

   399

        if highlight_type is None:

   400

            self.Highlights = {}

   401

        else:

   402

            highlight_items = self.Highlights.items()

   403

            for name, highlights in highlight_items:

   404

                highlights = ClearHighlights(highlights, highlight_type)

   405

                if len(highlights) == 0:

   406

                    self.Highlights.pop(name)

   407

        for input in self.Inputs:

   408

            input.ClearHighlights(highlight_type)

   409

        for output in self.Outputs:

   410

            output.ClearHighlights(highlight_type)

   411

   412

    # Draws block

   413

    def Draw(self, dc):

   414

        Graphic_Element.Draw(self, dc)

   415

        dc.SetPen(self.Pen)

   416

        dc.SetBrush(wx.WHITE_BRUSH)

   417

        dc.SetTextForeground(self.Colour)

   418

   419

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

   420

            name_size = dc.GetTextExtent(self.Name)

   421

            type_size = dc.GetTextExtent(self.Type)

   422

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

   423

        else:

   424

            name_size = self.NameSize

   425

            type_size = self.TypeSize

   426

            executionorder_size = self.ExecutionOrderSize

   427

   428

        # Draw a rectangle with the block size

   429

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

   430

        # Draw block name and block type

   431

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

   432

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

   433

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

   434

                    self.Pos.y + 5)

   435

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

   436

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

   437

        # Draw inputs and outputs connectors

   438

        for input in self.Inputs:

   439

            input.Draw(dc)

   440

        for output in self.Outputs:

   441

            output.Draw(dc)

   442

        if self.ExecutionOrder != 0:

   443

            # Draw block execution order

   444

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

   445

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

   446

   447

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

   448

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

   449

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

   450

   451

   452

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

   453

#                        Function Block Diagram Variable

   454

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

   455

   456

"""

   457

Class that implements the graphic representation of a variable

   458

"""

   459

   460

class FBD_Variable(Graphic_Element):

   461

   462

    # Create a new variable

   463

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

   464

        Graphic_Element.__init__(self, parent)

   465

        self.Type = None

   466

        self.ValueType = None

   467

        self.Id = id

   468

        self.SetName(name)

   469

        self.SetExecutionOrder(executionOrder)

   470

        self.Input = None

   471

        self.Output = None

   472

        self.SetType(type, value_type)

   473

        self.Highlights = []

   474

   475

    # Make a clone of this FBD_Variable

   476

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

   477

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

   478

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

   479

        if pos is not None:

   480

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

   481

        else:

   482

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

   483

        if self.Input:

   484

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

   485

        if self.Output:

   486

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

   487

        return variable

   488

   489

    def GetConnectorTranslation(self, element):

   490

        connectors = {}

   491

        if self.Input is not None:

   492

            connectors[self.Input] = element.Input

   493

        if self.Output is not None:

   494

            connectors[self.Output] = element.Output

   495

        return connectors