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

    # Returns if the point given is in the bounding box

   117

    def HitTest(self, pt, connectors=True):

   118

        if self.Name != "":

   119

            test_text = self.GetTextBoundingBox().InsideXY(pt.x, pt.y)

   120

        else:

   121

            test_text = False

   122

        test_block = self.GetBlockBoundingBox(connectors).InsideXY(pt.x, pt.y)

   123

        return test_text or test_block

   124

   125

    # Returns the bounding box of the name outside the block

   126

    def GetTextBoundingBox(self):

   127

        # Calculate the size of the name outside the block

   128

        text_width, text_height = self.NameSize

   129

        return wx.Rect(self.Pos.x + (self.Size[0] - text_width) / 2,

   130

                       self.Pos.y - (text_height + 2),

   131

                       text_width,

   132

                       text_height)

   133

   134

    # Returns the bounding box of function block without name outside

   135

    def GetBlockBoundingBox(self, connectors=True):

   136

        bbx_x, bbx_y = self.Pos.x, self.Pos.y

   137

        bbx_width, bbx_height = self.Size

   138

        if connectors:

   139

            bbx_x -= min(1, len(self.Inputs)) * CONNECTOR_SIZE

   140

            bbx_width += (min(1, len(self.Inputs)) + min(1, len(self.Outputs))) * CONNECTOR_SIZE

   141

        if self.ExecutionOrder != 0:

   142

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

   143

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

   144

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

   145

        return wx.Rect(bbx_x, bbx_y, bbx_width + 1, bbx_height + 1)

   146

   147

    # Refresh the block bounding box

   148

    def RefreshBoundingBox(self):

   149

        self.BoundingBox = self.GetBlockBoundingBox()

   150

        if self.Name != "":

   151

            self.BoundingBox.Union(self.GetTextBoundingBox())

   152

   153

    # Refresh the positions of the block connectors

   154

    def RefreshConnectors(self):

   155

        scaling = self.Parent.GetScaling()

   156

        # Calculate the size for the connector lines

   157

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

   158

        if lines > 0:

   159

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

   160

            # Update inputs and outputs positions

   161

            position = BLOCK_LINE_SIZE + linesize / 2

   162

            for i in xrange(lines):

   163

                if scaling is not None:

   164

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

   165

                else:

   166

                    ypos = position

   167

                if i < len(self.Inputs):

   168

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

   169

                if i < len(self.Outputs):

   170

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

   171

                position += linesize

   172

        self.RefreshConnected()

   173

   174

    # Refresh the positions of wires connected to inputs and outputs

   175

    def RefreshConnected(self, exclude = []):

   176

        for input in self.Inputs:

   177

            input.MoveConnected(exclude)

   178

        for output in self.Outputs:

   179

            output.MoveConnected(exclude)

   180

   181

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

   182

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

   183

        # if a name is given

   184

        if name is not None:

   185

            # Test each input and output connector

   186

            #for input in self.Inputs:

   187

            #    if name == input.GetName():

   188

            #        return input

   189

            for output in self.Outputs:

   190

                if name == output.GetName():

   191

                    return output

   192

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

   193

   194

    def GetInputTypes(self):

   195

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

   196

   197

    def SetOutputValues(self, values):

   198

        for output in self.Outputs:

   199

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

   200

   201

    def GetConnectionResultType(self, connector, connectortype):

   202

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

   203

            return connectortype

   204

        resulttype = connectortype

   205

        for input in self.Inputs:

   206

            if input != connector and input.GetType(True) == "ANY" and TestConnectorName(input.GetName(), self.Type):

   207

                inputtype = input.GetConnectedType()

   208

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

   209

                    resulttype = inputtype

   210

        for output in self.Outputs:

   211

            if output != connector and output.GetType(True) == "ANY" and TestConnectorName(output.GetName(), self.Type):

   212

                outputtype = output.GetConnectedType()

   213

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

   214

                    resulttype = outputtype

   215

        return resulttype

   216

   217

    # Returns all the block connectors

   218

    def GetConnectors(self):

   219

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

   220

   221

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

   222

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

   223

        # Test each input connector

   224

        for input in self.Inputs:

   225

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

   226

                return input

   227

        # Test each output connector

   228

        for output in self.Outputs:

   229

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

   230

                return output

   231

        return None

   232

   233

    # Changes the block type

   234

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

   235

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

   236

            if type != self.Type:

   237

                self.Type = type

   238

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

   239

            self.Extension = extension

   240

            self.ExecutionControl = executionControl

   241

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

   242

            # inputs and outputs

   243

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

   244

            if blocktype:

   245

                self.Colour = wx.BLACK

   246

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

   247

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

   248

                if blocktype["extensible"]:

   249

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

   250

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

   251

                        start += 1

   252

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

   253

                comment = blocktype["comment"]

   254

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

   255

            else:

   256

                self.Colour = wx.RED

   257

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

   258

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

   259

                self.Description = None

   260

            if self.ExecutionControl:

   261

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

   262

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

   263

            self.Pen = MiterPen(self.Colour)

   264

   265

            # Extract the inputs properties and create or modify the corresponding connector

   266

            idx = 0

   267

            for idx, (input_name, input_type, input_modifier) in enumerate(inputs):

   268

                if idx < len(self.Inputs):

   269

                    connector = self.Inputs[idx]

   270

                    connector.SetName(input_name)

   271

                    connector.SetType(input_type)

   272

                else:

   273

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

   274

                    self.Inputs.append(connector)

   275

                if input_modifier == "negated":

   276

                    connector.SetNegated(True)

   277

                elif input_modifier != "none":

   278

                    connector.SetEdge(input_modifier)

   279

            for i in xrange(idx + 1, len(self.Inputs)):

   280

                self.Inputs[i].UnConnect(delete = True)

   281

            self.Inputs = self.Inputs[:idx + 1]

   282

   283

            # Extract the outputs properties and create or modify the corresponding connector

   284

            idx = 0

   285

            for idx, (output_name, output_type, output_modifier) in enumerate(outputs):

   286

                if idx < len(self.Outputs):

   287

                    connector = self.Outputs[idx]

   288

                    connector.SetName(output_name)

   289

                    connector.SetType(output_type)

   290

                else:

   291

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

   292

                    self.Outputs.append(connector)

   293

                if output_modifier == "negated":

   294

                    connector.SetNegated(True)

   295

                elif output_modifier != "none":

   296

                    connector.SetEdge(output_modifier)

   297

            for i in xrange(idx + 1, len(self.Outputs)):

   298

                self.Outputs[i].UnConnect(delete = True)

   299

            self.Outputs = self.Outputs[:idx + 1]

   300

   301

            self.RefreshMinSize()

   302

            self.RefreshConnectors()

   303

            self.RefreshBoundingBox()

   304

   305

    # Returns the block type

   306

    def GetType(self):

   307

        return self.Type

   308

   309

    # Changes the block name

   310

    def SetName(self, name):

   311

        self.Name = name

   312

        self.RefreshNameSize()

   313

   314

    # Returs the block name

   315

    def GetName(self):

   316

        return self.Name

   317

   318

    # Changes the extension name

   319

    def SetExtension(self, extension):

   320

        self.Extension = extension

   321

   322

    # Returs the extension name

   323

    def GetExtension(self):

   324

        return self.Extension

   325

   326

    # Changes the execution order

   327

    def SetExecutionOrder(self, executionOrder):

   328

        self.ExecutionOrder = executionOrder

   329

        self.RefreshExecutionOrderSize()

   330

   331

    # Returs the execution order

   332

    def GetExecutionOrder(self):

   333

        return self.ExecutionOrder

   334

   335

    # Returs the execution order

   336

    def GetExecutionControl(self):

   337

        return self.ExecutionControl

   338

   339

    # Refresh the block minimum size

   340

    def RefreshMinSize(self):

   341

        # Calculate the inputs maximum width

   342

        max_input = 0

   343

        for input in self.Inputs:

   344

            w, h = input.GetNameSize()

   345

            max_input = max(max_input, w)

   346

        # Calculate the outputs maximum width

   347

        max_output = 0

   348

        for output in self.Outputs:

   349

            w, h = output.GetNameSize()

   350

            max_output = max(max_output, w)

   351

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

   352

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

   353

        self.MinSize = width, height

   354

   355

    # Returns the block minimum size

   356

    def GetMinSize(self):

   357

        return self.MinSize

   358

   359

    # Changes the negated property of the connector handled

   360

    def SetConnectorNegated(self, negated):

   361

        handle_type, handle = self.Handle

   362

        if handle_type == HANDLE_CONNECTOR:

   363

            handle.SetNegated(negated)

   364

            self.RefreshModel(False)

   365

   366

    # Changes the edge property of the connector handled

   367

    def SetConnectorEdge(self, edge):

   368

        handle_type, handle = self.Handle

   369

        if handle_type == HANDLE_CONNECTOR:

   370

            handle.SetEdge(edge)

   371

            self.RefreshModel(False)

   372

   373

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

   374

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

   375

##        if not event.Dragging():

   376

##            pos = event.GetLogicalPosition(dc)

   377

##            for input in self.Inputs:

   378

##                rect = input.GetRedrawRect()

   379

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

   380

##                    print "Find input"

   381

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

   382

##                    tip.SetBoundingRect(rect)

   383

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

   384

   385

    # Method called when a LeftDClick event have been generated

   386

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

   387

        # Edit the block properties

   388

        self.Parent.EditBlockContent(self)

   389

   390

    # Method called when a RightUp event have been generated

   391

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

   392

        pos = GetScaledEventPosition(event, dc, scaling)

   393

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

   394

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

   395

        if connector:

   396

            self.Handle = (HANDLE_CONNECTOR, connector)

   397

            self.Parent.PopupBlockMenu(connector)

   398

        else:

   399

            self.Parent.PopupBlockMenu()

   400

   401

    # Refreshes the block model

   402

    def RefreshModel(self, move=True):

   403

        self.Parent.RefreshBlockModel(self)

   404

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

   405

        if move:

   406

            for output in self.Outputs:

   407

                output.RefreshWires()

   408

   409

    def GetToolTipValue(self):

   410

        return self.Description

   411

   412

    # Adds an highlight to the block

   413

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

   414

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

   415

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

   416

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

   417

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

   418

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

   419

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

   420

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

   421

   422

    # Removes an highlight from the block

   423

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

   424

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

   425

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

   426

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

   427

                self.Highlights.pop(infos[0])

   428

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

   429

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

   430

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

   431

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

   432

   433

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

   434

    def ClearHighlight(self, highlight_type=None):

   435

        if highlight_type is None:

   436

            self.Highlights = {}

   437

        else:

   438

            highlight_items = self.Highlights.items()

   439

            for name, highlights in highlight_items:

   440

                highlights = ClearHighlights(highlights, highlight_type)

   441

                if len(highlights) == 0:

   442

                    self.Highlights.pop(name)

   443

        for input in self.Inputs:

   444

            input.ClearHighlights(highlight_type)

   445

        for output in self.Outputs:

   446

            output.ClearHighlights(highlight_type)

   447

   448

    # Draws block

   449

    def Draw(self, dc):

   450

        Graphic_Element.Draw(self, dc)

   451

        dc.SetPen(self.Pen)

   452

        dc.SetBrush(wx.WHITE_BRUSH)

   453

        dc.SetTextForeground(self.Colour)

   454

   455

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

   456

            name_size = dc.GetTextExtent(self.Name)

   457

            type_size = dc.GetTextExtent(self.Type)

   458

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

   459

        else:

   460

            name_size = self.NameSize

   461

            type_size = self.TypeSize

   462

            executionorder_size = self.ExecutionOrderSize

   463

   464

        # Draw a rectangle with the block size

   465

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

   466

        # Draw block name and block type

   467

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

   468

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

   469

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

   470

                    self.Pos.y + 5)

   471

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

   472

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

   473

        # Draw inputs and outputs connectors

   474

        for input in self.Inputs:

   475

            input.Draw(dc)

   476

        for output in self.Outputs:

   477

            output.Draw(dc)

   478

        if self.ExecutionOrder != 0:

   479

            # Draw block execution order

   480

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

   481

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

   482

   483

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

   484

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

   485

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

   486

   487

   488

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

   489

#                        Function Block Diagram Variable

   490

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

   491

   492

"""

   493

Class that implements the graphic representation of a variable

   494

"""

   495