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

from __future__ import division

    28

import wx

    29

from six.moves import xrange

    30

    31

from graphics.GraphicCommons import *

    32

from plcopen.structures import *

    33

    34

    35

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

    36

#                         Function Block Diagram Block

    37

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

    38

    39

    40

def TestConnectorName(name, block_type):

    41

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

    42

    43

    44

class FBD_Block(Graphic_Element):

    45

    """

    46

    Class that implements the graphic representation of a function block

    47

    """

    48

    49

    # Create a new block

    50

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

    51

        Graphic_Element.__init__(self, parent)

    52

        self.Type = None

    53

        self.Description = None

    54

        self.Extension = None

    55

        self.ExecutionControl = False

    56

        self.Id = id

    57

        self.SetName(name)

    58

        self.SetExecutionOrder(executionOrder)

    59

        self.Inputs = []

    60

        self.Outputs = []

    61

        self.Colour = wx.BLACK

    62

        self.Pen = MiterPen(wx.BLACK)

    63

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

    64

        self.Highlights = {}

    65

    66

    # Make a clone of this FBD_Block

    67

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

    68

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

    69

            name = self.Name

    70

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

    71

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

    72

        if pos is not None:

    73

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

    74

        else:

    75

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

    76

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

    77

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

    78

        return block

    79

    80

    def GetConnectorTranslation(self, element):

    81

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

    82

    83

    def Flush(self):

    84

        for input in self.Inputs:

    85

            input.Flush()

    86

        self.Inputs = []

    87

        for output in self.Outputs:

    88

            output.Flush()

    89

        self.Outputs = []

    90

    91

    # Returns the RedrawRect

    92

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

    93

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

    94

        if movex != 0 or movey != 0:

    95

            for input in self.Inputs:

    96

                if input.IsConnected():

    97

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

    98

            for output in self.Outputs:

    99

                if output.IsConnected():

   100

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

   101

        return rect

   102

   103

    # Delete this block by calling the appropriate method

   104

    def Delete(self):

   105

        self.Parent.DeleteBlock(self)

   106

   107

    # Unconnect all inputs and outputs

   108

    def Clean(self):

   109

        for input in self.Inputs:

   110

            input.UnConnect(delete=True)

   111

        for output in self.Outputs:

   112

            output.UnConnect(delete=True)

   113

   114

    # Refresh the size of text for name

   115

    def RefreshNameSize(self):

   116

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

   117

   118

    # Refresh the size of text for execution order

   119

    def RefreshExecutionOrderSize(self):

   120

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

   121

   122

    # Returns if the point given is in the bounding box

   123

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

   124

        if self.Name != "":

   125

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

   126

        else:

   127

            test_text = False

   128

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

   129

        return test_text or test_block

   130

   131

    # Returns the bounding box of the name outside the block

   132

    def GetTextBoundingBox(self):

   133

        # Calculate the size of the name outside the block

   134

        text_width, text_height = self.NameSize

   135

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

   136

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

   137

                       text_width,

   138

                       text_height)

   139

   140

    # Returns the bounding box of function block without name outside

   141

    def GetBlockBoundingBox(self, connectors=True):

   142

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

   143

        bbx_width, bbx_height = self.Size

   144

        if connectors:

   145

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

   146

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

   147

        if self.ExecutionOrder != 0:

   148

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

   149

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

   150

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

   151

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

   152

   153

    # Refresh the block bounding box

   154

    def RefreshBoundingBox(self):

   155

        self.BoundingBox = self.GetBlockBoundingBox()

   156

        if self.Name != "":

   157

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

   158

   159

    # Refresh the positions of the block connectors

   160

    def RefreshConnectors(self):

   161

        scaling = self.Parent.GetScaling()

   162

        # Calculate the size for the connector lines

   163

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

   164

        if lines > 0:

   165

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

   166

            # Update inputs and outputs positions

   167

            position = BLOCK_LINE_SIZE + linesize // 2

   168

            for i in xrange(lines):

   169

                if scaling is not None:

   170

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

   171

                else:

   172

                    ypos = position

   173

                if i < len(self.Inputs):

   174

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

   175

                if i < len(self.Outputs):

   176

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

   177

                position += linesize

   178

        self.RefreshConnected()

   179

   180

    # Refresh the positions of wires connected to inputs and outputs

   181

    def RefreshConnected(self, exclude=None):

   182

        for input in self.Inputs:

   183

            input.MoveConnected(exclude)

   184

        for output in self.Outputs:

   185

            output.MoveConnected(exclude)

   186

   187

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

   188

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

   189

        if input_name is not None:

   190

            # Test each input connector

   191

            for input in self.Inputs:

   192

                if input_name == input.GetName():

   193

                    return input

   194

        if output_name is not None:

   195

            # Test each output connector

   196

            for output in self.Outputs:

   197

                if output_name == output.GetName():

   198

                    return output

   199

        if input_name is None and output_name is None:

   200

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

   201

        return None

   202

   203

    def GetInputTypes(self):

   204

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

   205

   206

    def SetOutputValues(self, values):

   207

        for output in self.Outputs:

   208

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

   209

   210

    def GetConnectionResultType(self, connector, connectortype):

   211

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

   212

            return connectortype

   213

        resulttype = connectortype

   214

        for input in self.Inputs:

   215

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

   216

                inputtype = input.GetConnectedType()

   217

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

   218

                    resulttype = inputtype

   219

        for output in self.Outputs:

   220

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

   221

                outputtype = output.GetConnectedType()

   222

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

   223

                    resulttype = outputtype

   224

        return resulttype

   225

   226

    # Returns all the block connectors

   227

    def GetConnectors(self):

   228

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

   229

   230

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

   231

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

   232

        # Test each input connector

   233

        for input in self.Inputs:

   234

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

   235

                return input

   236

        # Test each output connector

   237

        for output in self.Outputs:

   238

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

   239

                return output

   240

        return None

   241

   242

    # Changes the block type

   243

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

   244

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

   245

            if type != self.Type:

   246

                self.Type = type

   247

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

   248

            self.Extension = extension

   249

            self.ExecutionControl = executionControl

   250

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

   251

            # inputs and outputs

   252

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

   253

            if blocktype:

   254

                self.Colour = wx.BLACK

   255

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

   256

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

   257

                if blocktype["extensible"]:

   258

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

   259

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

   260

                        start += 1

   261

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

   262

                comment = blocktype["comment"]

   263

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

   264

            else:

   265

                self.Colour = wx.RED

   266

                connectors = {} if connectors is None else connectors

   267

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

   268

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

   269

                self.Description = None

   270

            if self.ExecutionControl:

   271

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

   272

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

   273

            self.Pen = MiterPen(self.Colour)

   274

   275

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

   276

            input_connectors = []

   277

            for input_name, input_type, input_modifier in inputs:

   278

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

   279

                if input_modifier == "negated":

   280

                    connector.SetNegated(True)

   281

                elif input_modifier != "none":

   282

                    connector.SetEdge(input_modifier)

   283

                for input in self.Inputs:

   284

                    if input.GetName() == input_name:

   285

                        wires = input.GetWires()[:]

   286

                        input.UnConnect()

   287

                        for wire in wires:

   288

                            connector.Connect(wire)

   289

                        break

   290

                input_connectors.append(connector)

   291

            for input in self.Inputs:

   292

                input.UnConnect(delete=True)

   293

            self.Inputs = input_connectors

   294

   295

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

   296

            output_connectors = []

   297

            for output_name, output_type, output_modifier in outputs:

   298

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

   299

                if output_modifier == "negated":

   300

                    connector.SetNegated(True)

   301

                elif output_modifier != "none":

   302

                    connector.SetEdge(output_modifier)

   303

                for output in self.Outputs:

   304

                    if output.GetName() == output_name:

   305

                        wires = output.GetWires()[:]

   306

                        output.UnConnect()

   307

                        for wire in wires:

   308

                            connector.Connect(wire)

   309

                        break

   310

                output_connectors.append(connector)

   311

            for output in self.Outputs:

   312

                output.UnConnect(delete=True)

   313

            self.Outputs = output_connectors

   314

   315

            self.RefreshMinSize()

   316

            self.RefreshConnectors()

   317

            for output in self.Outputs:

   318

                output.RefreshWires()

   319

            self.RefreshBoundingBox()

   320

   321

    # Returns the block type

   322

    def GetType(self):

   323

        return self.Type

   324

   325

    # Changes the block name

   326

    def SetName(self, name):

   327

        self.Name = name

   328

        self.RefreshNameSize()

   329

   330

    # Returs the block name

   331

    def GetName(self):

   332

        return self.Name

   333

   334

    # Changes the extension name

   335

    def SetExtension(self, extension):

   336

        self.Extension = extension

   337

   338

    # Returs the extension name

   339

    def GetExtension(self):

   340

        return self.Extension

   341

   342

    # Changes the execution order

   343

    def SetExecutionOrder(self, executionOrder):

   344

        self.ExecutionOrder = executionOrder

   345

        self.RefreshExecutionOrderSize()

   346

   347

    # Returs the execution order

   348

    def GetExecutionOrder(self):

   349

        return self.ExecutionOrder

   350

   351

    # Returs the execution order

   352

    def GetExecutionControl(self):

   353

        return self.ExecutionControl

   354

   355

    # Refresh the block minimum size

   356

    def RefreshMinSize(self):

   357

        # Calculate the inputs maximum width

   358

        max_input = 0

   359

        for input in self.Inputs:

   360

            w, _h = input.GetNameSize()

   361

            max_input = max(max_input, w)

   362

        # Calculate the outputs maximum width

   363

        max_output = 0

   364

        for output in self.Outputs:

   365

            w, _h = output.GetNameSize()

   366

            max_output = max(max_output, w)

   367

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

   368

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

   369

        self.MinSize = width, height

   370

   371

    # Returns the block minimum size

   372

    def GetMinSize(self):

   373

        return self.MinSize

   374

   375

    # Changes the negated property of the connector handled

   376

    def SetConnectorNegated(self, negated):

   377

        handle_type, handle = self.Handle

   378

        if handle_type == HANDLE_CONNECTOR:

   379

            handle.SetNegated(negated)

   380

            self.RefreshModel(False)

   381

   382

    # Changes the edge property of the connector handled

   383

    def SetConnectorEdge(self, edge):

   384

        handle_type, handle = self.Handle

   385

        if handle_type == HANDLE_CONNECTOR:

   386

            handle.SetEdge(edge)

   387

            self.RefreshModel(False)

   388

   389

#    # Method called when a Motion event have been generated

   390

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

   391

#        if not event.Dragging():

   392

#            pos = event.GetLogicalPosition(dc)

   393

#            for input in self.Inputs:

   394

#                rect = input.GetRedrawRect()

   395

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

   396

#                    print "Find input"

   397

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

   398

#                    tip.SetBoundingRect(rect)

   399

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

   400

   401

    # Method called when a LeftDClick event have been generated

   402

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

   403

        # Edit the block properties

   404

        self.Parent.EditBlockContent(self)

   405

   406

    # Method called when a RightUp event have been generated

   407

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

   408

        pos = GetScaledEventPosition(event, dc, scaling)

   409

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

   410

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

   411

        if connector:

   412

            self.Handle = (HANDLE_CONNECTOR, connector)

   413

            self.Parent.PopupBlockMenu(connector)

   414

        else:

   415

            self.Parent.PopupBlockMenu()

   416

   417

    # Refreshes the block model

   418

    def RefreshModel(self, move=True):

   419

        self.Parent.RefreshBlockModel(self)

   420

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

   421

        if move:

   422

            for output in self.Outputs:

   423

                output.RefreshWires()

   424

   425

    def GetToolTipValue(self):

   426

        return self.Description

   427

   428

    # Adds an highlight to the block

   429

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

   430

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

   431

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

   432

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

   433

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

   434

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

   435

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

   436

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

   437

   438

    # Removes an highlight from the block

   439

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

   440

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

   441

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

   442

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

   443

                self.Highlights.pop(infos[0])

   444

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

   445

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

   446

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

   447

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

   448

   449

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

   450

    def ClearHighlight(self, highlight_type=None):

   451

        if highlight_type is None:

   452

            self.Highlights = {}

   453

        else:

   454

            highlight_items = self.Highlights.items()

   455

            for name, highlights in highlight_items:

   456

                highlights = ClearHighlights(highlights, highlight_type)

   457

                if len(highlights) == 0:

   458

                    self.Highlights.pop(name)

   459

        for input in self.Inputs:

   460

            input.ClearHighlights(highlight_type)

   461

        for output in self.Outputs:

   462

            output.ClearHighlights(highlight_type)

   463

   464

    # Draws block

   465

    def Draw(self, dc):

   466

        Graphic_Element.Draw(self, dc)

   467

        dc.SetPen(self.Pen)

   468

        dc.SetBrush(wx.WHITE_BRUSH)

   469

        dc.SetTextForeground(self.Colour)

   470

   471

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

   472

            name_size = dc.GetTextExtent(self.Name)

   473

            type_size = dc.GetTextExtent(self.Type)

   474

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

   475

        else:

   476

            name_size = self.NameSize

   477

            type_size = self.TypeSize

   478

            executionorder_size = self.ExecutionOrderSize

   479

   480

        # Draw a rectangle with the block size

   481

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

   482

        # Draw block name and block type

   483

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

   484

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

   485

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

   486

                    self.Pos.y + 5)

   487

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

   488

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

   489

        # Draw inputs and outputs connectors

   490

        for input in self.Inputs:

   491

            input.Draw(dc)

   492

        for output in self.Outputs:

   493

            output.Draw(dc)

   494

        if self.ExecutionOrder != 0:

   495

            # Draw block execution order

   496

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

   497

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

   498

   499

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

   500

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

   501

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

   502

   503

   504

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

   505

#                        Function Block Diagram Variable

   506

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