1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

from __future__ import absolute_import

    27

import wx

    29

    30

from graphics.GraphicCommons import *

    31

from plcopen.structures import *

    32

    33

    34

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

    35

#                         Function Block Diagram Block

    36

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

    37

    38

    39

def TestConnectorName(name, block_type):

    40

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

    41

    42

    43

class FBD_Block(Graphic_Element):

    44

    """

    45

    Class that implements the graphic representation of a function block

    46

    """

    47

    48

    # Create a new block

    49

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

    50

        Graphic_Element.__init__(self, parent)

    51

        self.Type = None

    52

        self.Description = None

    53

        self.Extension = None

    54

        self.ExecutionControl = False

    55

        self.Id = id

    56

        self.SetName(name)

    57

        self.SetExecutionOrder(executionOrder)

    58

        self.Inputs = []

    59

        self.Outputs = []

    60

        self.Colour = wx.BLACK

    61

        self.Pen = MiterPen(wx.BLACK)

    62

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

    63

        self.Highlights = {}

    64

    65

    # Make a clone of this FBD_Block

    66

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

    67

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

    68

            name = self.Name

    69

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

    70

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

    71

        if pos is not None:

    72

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

    73

        else:

    74

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

    75

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

    76

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

    77

        return block

    78

    79

    def GetConnectorTranslation(self, element):

    80

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

    81

    82

    def Flush(self):

    83

        for input in self.Inputs:

    84

            input.Flush()

    85

        self.Inputs = []

    86

        for output in self.Outputs:

    87

            output.Flush()

    88

        self.Outputs = []

    89

    90

    # Returns the RedrawRect

    91

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

    92

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

    93

        if movex != 0 or movey != 0:

    94

            for input in self.Inputs:

    95

                if input.IsConnected():

    96

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

    97

            for output in self.Outputs:

    98

                if output.IsConnected():

    99

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

   100

        return rect

   101

   102

    # Delete this block by calling the appropriate method

   103

    def Delete(self):

   104

        self.Parent.DeleteBlock(self)

   105

   106

    # Unconnect all inputs and outputs

   107

    def Clean(self):

   108

        for input in self.Inputs:

   109

            input.UnConnect(delete=True)

   110

        for output in self.Outputs:

   111

            output.UnConnect(delete=True)

   112

   113

    # Refresh the size of text for name

   114

    def RefreshNameSize(self):

   115

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

   116

   117

    # Refresh the size of text for execution order

   118

    def RefreshExecutionOrderSize(self):

   119

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

   120

   121

    # Returns if the point given is in the bounding box

   122

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

   123

        if self.Name != "":

   124

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

   125

        else:

   126

            test_text = False

   127

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

   128

        return test_text or test_block

   129

   130

    # Returns the bounding box of the name outside the block

   131

    def GetTextBoundingBox(self):

   132

        # Calculate the size of the name outside the block

   133

        text_width, text_height = self.NameSize

   134

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

   135

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

   136

                       text_width,

   137

                       text_height)

   138

   139

    # Returns the bounding box of function block without name outside

   140

    def GetBlockBoundingBox(self, connectors=True):

   141

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

   142

        bbx_width, bbx_height = self.Size

   143

        if connectors:

   144

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

   145

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

   146

        if self.ExecutionOrder != 0:

   147

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

   148

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

   149

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

   150

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

   151

   152

    # Refresh the block bounding box

   153

    def RefreshBoundingBox(self):

   154

        self.BoundingBox = self.GetBlockBoundingBox()

   155

        if self.Name != "":

   156

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

   157

   158

    # Refresh the positions of the block connectors

   159

    def RefreshConnectors(self):

   160

        scaling = self.Parent.GetScaling()

   161

        # Calculate the size for the connector lines

   162

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

   163

        if lines > 0:

   164

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

   165

            # Update inputs and outputs positions

   166

            position = BLOCK_LINE_SIZE + linesize / 2

   167

            for i in xrange(lines):

   168

                if scaling is not None:

   169

                    ypos = round_scaling(self.Pos.y + position, scaling[1]) - self.Pos.y

   170

                else:

   171

                    ypos = position

   172

                if i < len(self.Inputs):

   173

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

   174

                if i < len(self.Outputs):

   175

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

   176

                position += linesize

   177

        self.RefreshConnected()

   178

   179

    # Refresh the positions of wires connected to inputs and outputs

   180

    def RefreshConnected(self, exclude=None):

   181

        for input in self.Inputs:

   182

            input.MoveConnected(exclude)

   183

        for output in self.Outputs:

   184

            output.MoveConnected(exclude)

   185

   186

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

   187

    def GetConnector(self, position, output_name=None, input_name=None):

   188

        if input_name is not None:

   189

            # Test each input connector

   190

            for input in self.Inputs:

   191

                if input_name == input.GetName():

   192

                    return input

   193

        if output_name is not None:

   194

            # Test each output connector

   195

            for output in self.Outputs:

   196

                if output_name == output.GetName():

   197

                    return output

   198

        if input_name is None and output_name is None:

   199

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

   200

        return None

   201

   202

    def GetInputTypes(self):

   203

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

   204

   205

    def SetOutputValues(self, values):

   206

        for output in self.Outputs:

   207

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

   208

   209

    def GetConnectionResultType(self, connector, connectortype):

   210

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

   211

            return connectortype

   212

        resulttype = connectortype

   213

        for input in self.Inputs:

   214

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

   215

                inputtype = input.GetConnectedType()

   216

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

   217

                    resulttype = inputtype

   218

        for output in self.Outputs:

   219

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

   220

                outputtype = output.GetConnectedType()

   221

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

   222

                    resulttype = outputtype

   223

        return resulttype

   224

   225

    # Returns all the block connectors

   226

    def GetConnectors(self):

   227

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

   228

   229

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

   230

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

   231

        # Test each input connector

   232

        for input in self.Inputs:

   233

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

   234

                return input

   235

        # Test each output connector

   236

        for output in self.Outputs:

   237

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

   238

                return output

   239

        return None

   240

   241

    # Changes the block type

   242

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

   243

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

   244

            if type != self.Type:

   245

                self.Type = type

   246

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

   247

            self.Extension = extension

   248

            self.ExecutionControl = executionControl

   249

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

   250

            # inputs and outputs

   251

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

   252

            if blocktype:

   253

                self.Colour = wx.BLACK

   254

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

   255

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

   256

                if blocktype["extensible"]:

   257

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

   258

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

   259

                        start += 1

   260

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

   261

                comment = blocktype["comment"]

   262

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

   263

            else:

   264

                self.Colour = wx.RED

   265

                connectors = {} if connectors is None else connectors

   266

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

   267

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

   268

                self.Description = None

   269

            if self.ExecutionControl:

   270

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

   271

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

   272

            self.Pen = MiterPen(self.Colour)

   273

   274

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

   275

            input_connectors = []

   276

            for input_name, input_type, input_modifier in inputs:

   277

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

   278

                if input_modifier == "negated":

   279

                    connector.SetNegated(True)

   280

                elif input_modifier != "none":

   281

                    connector.SetEdge(input_modifier)

   282

                for input in self.Inputs:

   283

                    if input.GetName() == input_name:

   284

                        wires = input.GetWires()[:]

   285

                        input.UnConnect()

   286

                        for wire in wires:

   287

                            connector.Connect(wire)

   288

                        break

   289

                input_connectors.append(connector)

   290

            for input in self.Inputs:

   291

                input.UnConnect(delete=True)

   292

            self.Inputs = input_connectors

   293

   294

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

   295

            output_connectors = []

   296

            for output_name, output_type, output_modifier in outputs:

   297

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

   298

                if output_modifier == "negated":

   299

                    connector.SetNegated(True)

   300

                elif output_modifier != "none":

   301

                    connector.SetEdge(output_modifier)

   302

                for output in self.Outputs:

   303

                    if output.GetName() == output_name:

   304

                        wires = output.GetWires()[:]

   305

                        output.UnConnect()

   306

                        for wire in wires:

   307

                            connector.Connect(wire)

   308

                        break

   309

                output_connectors.append(connector)

   310

            for output in self.Outputs:

   311

                output.UnConnect(delete=True)

   312

            self.Outputs = output_connectors

   313

   314

            self.RefreshMinSize()

   315

            self.RefreshConnectors()

   316

            for output in self.Outputs:

   317

                output.RefreshWires()

   318

            self.RefreshBoundingBox()

   319

   320

    # Returns the block type

   321

    def GetType(self):

   322

        return self.Type

   323

   324

    # Changes the block name

   325

    def SetName(self, name):

   326

        self.Name = name

   327

        self.RefreshNameSize()

   328

   329

    # Returs the block name

   330

    def GetName(self):

   331

        return self.Name

   332

   333

    # Changes the extension name

   334

    def SetExtension(self, extension):

   335

        self.Extension = extension

   336

   337

    # Returs the extension name

   338

    def GetExtension(self):

   339

        return self.Extension

   340

   341

    # Changes the execution order

   342

    def SetExecutionOrder(self, executionOrder):

   343

        self.ExecutionOrder = executionOrder

   344

        self.RefreshExecutionOrderSize()

   345

   346

    # Returs the execution order

   347

    def GetExecutionOrder(self):

   348

        return self.ExecutionOrder

   349

   350

    # Returs the execution order

   351

    def GetExecutionControl(self):

   352

        return self.ExecutionControl

   353

   354

    # Refresh the block minimum size

   355

    def RefreshMinSize(self):

   356

        # Calculate the inputs maximum width

   357

        max_input = 0

   358

        for input in self.Inputs:

   359

            w, _h = input.GetNameSize()

   360

            max_input = max(max_input, w)

   361

        # Calculate the outputs maximum width

   362

        max_output = 0

   363

        for output in self.Outputs:

   364

            w, _h = output.GetNameSize()

   365

            max_output = max(max_output, w)

   366

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

   367

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

   368

        self.MinSize = width, height

   369

   370

    # Returns the block minimum size

   371

    def GetMinSize(self):

   372

        return self.MinSize

   373

   374

    # Changes the negated property of the connector handled

   375

    def SetConnectorNegated(self, negated):

   376

        handle_type, handle = self.Handle

   377

        if handle_type == HANDLE_CONNECTOR:

   378

            handle.SetNegated(negated)

   379

            self.RefreshModel(False)

   380

   381

    # Changes the edge property of the connector handled

   382

    def SetConnectorEdge(self, edge):

   383

        handle_type, handle = self.Handle

   384

        if handle_type == HANDLE_CONNECTOR:

   385

            handle.SetEdge(edge)

   386

            self.RefreshModel(False)

   387

   388

#    # Method called when a Motion event have been generated

   389

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

   390

#        if not event.Dragging():

   391

#            pos = event.GetLogicalPosition(dc)

   392

#            for input in self.Inputs:

   393

#                rect = input.GetRedrawRect()

   394

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

   395

#                    print "Find input"

   396

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

   397

#                    tip.SetBoundingRect(rect)

   398

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

   399

   400

    # Method called when a LeftDClick event have been generated

   401

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

   402

        # Edit the block properties

   403

        self.Parent.EditBlockContent(self)

   404

   405

    # Method called when a RightUp event have been generated

   406

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

   407

        pos = GetScaledEventPosition(event, dc, scaling)

   408

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

   409

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

   410

        if connector:

   411

            self.Handle = (HANDLE_CONNECTOR, connector)

   412

            self.Parent.PopupBlockMenu(connector)

   413

        else:

   414

            self.Parent.PopupBlockMenu()

   415

   416

    # Refreshes the block model

   417

    def RefreshModel(self, move=True):

   418

        self.Parent.RefreshBlockModel(self)

   419

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

   420

        if move:

   421

            for output in self.Outputs:

   422

                output.RefreshWires()

   423

   424

    def GetToolTipValue(self):

   425

        return self.Description

   426

   427

    # Adds an highlight to the block

   428

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

   429

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

   430

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

   431

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

   432

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

   433

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

   434

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

   435

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

   436

   437

    # Removes an highlight from the block

   438

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

   439

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

   440

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

   441

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

   442

                self.Highlights.pop(infos[0])

   443

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

   444

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

   445

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

   446

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

   447

   448

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

   449

    def ClearHighlight(self, highlight_type=None):

   450

        if highlight_type is None:

   451

            self.Highlights = {}

   452

        else:

   453

            highlight_items = self.Highlights.items()

   454

            for name, highlights in highlight_items:

   455

                highlights = ClearHighlights(highlights, highlight_type)

   456

                if len(highlights) == 0:

   457

                    self.Highlights.pop(name)

   458

        for input in self.Inputs:

   459

            input.ClearHighlights(highlight_type)

   460

        for output in self.Outputs:

   461

            output.ClearHighlights(highlight_type)

   462

   463

    # Draws block

   464

    def Draw(self, dc):

   465

        Graphic_Element.Draw(self, dc)

   466

        dc.SetPen(self.Pen)

   467

        dc.SetBrush(wx.WHITE_BRUSH)

   468

        dc.SetTextForeground(self.Colour)

   469

   470

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

   471

            name_size = dc.GetTextExtent(self.Name)

   472

            type_size = dc.GetTextExtent(self.Type)

   473

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

   474

        else:

   475

            name_size = self.NameSize

   476

            type_size = self.TypeSize

   477

            executionorder_size = self.ExecutionOrderSize

   478

   479

        # Draw a rectangle with the block size

   480

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

   481

        # Draw block name and block type

   482

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

   483

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

   484

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

   485

                    self.Pos.y + 5)

   486

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

   487

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

   488

        # Draw inputs and outputs connectors

   489

        for input in self.Inputs:

   490

            input.Draw(dc)

   491

        for output in self.Outputs:

   492

            output.Draw(dc)

   493

        if self.ExecutionOrder != 0:

   494

            # Draw block execution order

   495

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

   496

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

   497

   498

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

   499

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

   500

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

   501

   502

   503

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

   504

#                        Function Block Diagram Variable

   505

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

   506

   507