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

import wx

    27

    28

from graphics.GraphicCommons import *

    29

from plcopen.structures import *

    30

    31

    32

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

    33

#                         Function Block Diagram Block

    34

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

    35

    36

    37

def TestConnectorName(name, block_type):

    38

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

    39

    40

    41

class FBD_Block(Graphic_Element):

    42

    """

    43

    Class that implements the graphic representation of a function block

    44

    """

    45

    46

    # Create a new block

    47

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

    48

        Graphic_Element.__init__(self, parent)

    49

        self.Type = None

    50

        self.Description = None

    51

        self.Extension = None

    52

        self.ExecutionControl = False

    53

        self.Id = id

    54

        self.SetName(name)

    55

        self.SetExecutionOrder(executionOrder)

    56

        self.Inputs = []

    57

        self.Outputs = []

    58

        self.Colour = wx.BLACK

    59

        self.Pen = MiterPen(wx.BLACK)

    60

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

    61

        self.Highlights = {}

    62

    63

    # Make a clone of this FBD_Block

    64

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

    65

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

    66

            name = self.Name

    67

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

    68

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

    69

        if pos is not None:

    70

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

    71

        else:

    72

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

    73

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

    74

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

    75

        return block

    76

    77

    def GetConnectorTranslation(self, element):

    78

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

    79

    80

    def Flush(self):

    81

        for input in self.Inputs:

    82

            input.Flush()

    83

        self.Inputs = []

    84

        for output in self.Outputs:

    85

            output.Flush()

    86

        self.Outputs = []

    87

    88

    # Returns the RedrawRect

    89

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

    90

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

    91

        if movex != 0 or movey != 0:

    92

            for input in self.Inputs:

    93

                if input.IsConnected():

    94

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

    95

            for output in self.Outputs:

    96

                if output.IsConnected():

    97

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

    98

        return rect

    99

   100

    # Delete this block by calling the appropriate method

   101

    def Delete(self):

   102

        self.Parent.DeleteBlock(self)

   103

   104

    # Unconnect all inputs and outputs

   105

    def Clean(self):

   106

        for input in self.Inputs:

   107

            input.UnConnect(delete=True)

   108

        for output in self.Outputs:

   109

            output.UnConnect(delete=True)

   110

   111

    # Refresh the size of text for name

   112

    def RefreshNameSize(self):

   113

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

   114

   115

    # Refresh the size of text for execution order

   116

    def RefreshExecutionOrderSize(self):

   117

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

   118

   119

    # Returns if the point given is in the bounding box

   120

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

   121

        if self.Name != "":

   122

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

   123

        else:

   124

            test_text = False

   125

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

   126

        return test_text or test_block

   127

   128

    # Returns the bounding box of the name outside the block

   129

    def GetTextBoundingBox(self):

   130

        # Calculate the size of the name outside the block

   131

        text_width, text_height = self.NameSize

   132

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

   133

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

   134

                       text_width,

   135

                       text_height)

   136

   137

    # Returns the bounding box of function block without name outside

   138

    def GetBlockBoundingBox(self, connectors=True):

   139

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

   140

        bbx_width, bbx_height = self.Size

   141

        if connectors:

   142

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

   143

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

   144

        if self.ExecutionOrder != 0:

   145

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

   146

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

   147

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

   148

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

   149

   150

    # Refresh the block bounding box

   151

    def RefreshBoundingBox(self):

   152

        self.BoundingBox = self.GetBlockBoundingBox()

   153

        if self.Name != "":

   154

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

   155

   156

    # Refresh the positions of the block connectors

   157

    def RefreshConnectors(self):

   158

        scaling = self.Parent.GetScaling()

   159

        # Calculate the size for the connector lines

   160

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

   161

        if lines > 0:

   162

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

   163

            # Update inputs and outputs positions

   164

            position = BLOCK_LINE_SIZE + linesize // 2

   165

            for i in range(lines):

   166

                if scaling is not None:

   167

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

   168

                else:

   169

                    ypos = position

   170

                if i < len(self.Inputs):

   171

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

   172

                if i < len(self.Outputs):

   173

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

   174

                position += linesize

   175

        self.RefreshConnected()

   176

   177

    # Refresh the positions of wires connected to inputs and outputs

   178

    def RefreshConnected(self, exclude=None):

   179

        for input in self.Inputs:

   180

            input.MoveConnected(exclude)

   181

        for output in self.Outputs:

   182

            output.MoveConnected(exclude)

   183

   184

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

   185

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

   186

        if input_name is not None:

   187

            # Test each input connector

   188

            for input in self.Inputs:

   189

                if input_name == input.GetName():

   190

                    return input

   191

        if output_name is not None:

   192

            # Test each output connector

   193

            for output in self.Outputs:

   194

                if output_name == output.GetName():

   195

                    return output

   196

        if input_name is None and output_name is None:

   197

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

   198

        return None

   199

   200

    def GetInputTypes(self):

   201

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

   202

   203

    def SetOutputValues(self, values):

   204

        for output in self.Outputs:

   205

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

   206

   207

    def GetConnectionResultType(self, connector, connectortype):

   208

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

   209

            return connectortype

   210

        resulttype = connectortype

   211

        for input in self.Inputs:

   212

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

   213

                inputtype = input.GetConnectedType()

   214

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

   215

                    resulttype = inputtype

   216

        for output in self.Outputs:

   217

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

   218

                outputtype = output.GetConnectedType()

   219

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

   220

                    resulttype = outputtype

   221

        return resulttype

   222

   223

    # Returns all the block connectors

   224

    def GetConnectors(self):

   225

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

   226

   227

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

   228

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

   229

        # Test each input connector

   230

        for input in self.Inputs:

   231

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

   232

                return input

   233

        # Test each output connector

   234

        for output in self.Outputs:

   235

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

   236

                return output

   237

        return None

   238

   239

    # Changes the block type

   240

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

   241

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

   242

            if type != self.Type:

   243

                self.Type = type

   244

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

   245

            self.Extension = extension

   246

            self.ExecutionControl = executionControl

   247

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

   248

            # inputs and outputs

   249

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

   250

            if blocktype:

   251

                self.Colour = wx.BLACK

   252

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

   253

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

   254

                if blocktype["extensible"]:

   255

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

   256

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

   257

                        start += 1

   258

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

   259

                comment = blocktype["comment"]

   260

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

   261

            else:

   262

                self.Colour = wx.RED

   263

                connectors = {} if connectors is None else connectors

   264

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

   265

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

   266

                self.Description = None

   267

            if self.ExecutionControl:

   268

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

   269

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

   270

            self.Pen = MiterPen(self.Colour)

   271

   272

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

   273

            input_connectors = []

   274

            for input_name, input_type, input_modifier in inputs:

   275

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

   276

                if input_modifier == "negated":

   277

                    connector.SetNegated(True)

   278

                elif input_modifier != "none":

   279

                    connector.SetEdge(input_modifier)

   280

                for input in self.Inputs:

   281

                    if input.GetName() == input_name:

   282

                        wires = input.GetWires()[:]

   283

                        input.UnConnect()

   284

                        for wire in wires:

   285

                            connector.Connect(wire)

   286

                        break

   287

                input_connectors.append(connector)

   288

            for input in self.Inputs:

   289

                input.UnConnect(delete=True)

   290

            self.Inputs = input_connectors

   291

   292

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

   293

            output_connectors = []

   294

            for output_name, output_type, output_modifier in outputs:

   295

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

   296

                if output_modifier == "negated":

   297

                    connector.SetNegated(True)

   298

                elif output_modifier != "none":

   299

                    connector.SetEdge(output_modifier)

   300

                for output in self.Outputs:

   301

                    if output.GetName() == output_name:

   302

                        wires = output.GetWires()[:]

   303

                        output.UnConnect()

   304

                        for wire in wires:

   305

                            connector.Connect(wire)

   306

                        break

   307

                output_connectors.append(connector)

   308

            for output in self.Outputs:

   309

                output.UnConnect(delete=True)

   310

            self.Outputs = output_connectors

   311

   312

            self.RefreshMinSize()

   313

            self.RefreshConnectors()

   314

            for output in self.Outputs:

   315

                output.RefreshWires()

   316

            self.RefreshBoundingBox()

   317

   318

    # Returns the block type

   319

    def GetType(self):

   320

        return self.Type

   321

   322

    # Changes the block name

   323

    def SetName(self, name):

   324

        self.Name = name

   325

        self.RefreshNameSize()

   326

   327

    # Returs the block name

   328

    def GetName(self):

   329

        return self.Name

   330

   331

    # Changes the extension name

   332

    def SetExtension(self, extension):

   333

        self.Extension = extension

   334

   335

    # Returs the extension name

   336

    def GetExtension(self):

   337

        return self.Extension

   338

   339

    # Changes the execution order

   340

    def SetExecutionOrder(self, executionOrder):

   341

        self.ExecutionOrder = executionOrder

   342

        self.RefreshExecutionOrderSize()

   343

   344

    # Returs the execution order

   345

    def GetExecutionOrder(self):

   346

        return self.ExecutionOrder

   347

   348

    # Returs the execution order

   349

    def GetExecutionControl(self):

   350

        return self.ExecutionControl

   351

   352

    # Refresh the block minimum size

   353

    def RefreshMinSize(self):

   354

        # Calculate the inputs maximum width

   355

        max_input = 0

   356

        for input in self.Inputs:

   357

            w, _h = input.GetNameSize()

   358

            max_input = max(max_input, w)

   359

        # Calculate the outputs maximum width

   360

        max_output = 0

   361

        for output in self.Outputs:

   362

            w, _h = output.GetNameSize()

   363

            max_output = max(max_output, w)

   364

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

   365

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

   366

        self.MinSize = width, height

   367

   368

    # Returns the block minimum size

   369

    def GetMinSize(self):

   370

        return self.MinSize

   371

   372

    # Changes the negated property of the connector handled

   373

    def SetConnectorNegated(self, negated):

   374

        handle_type, handle = self.Handle

   375

        if handle_type == HANDLE_CONNECTOR:

   376

            handle.SetNegated(negated)

   377

            self.RefreshModel(False)

   378

   379

    # Changes the edge property of the connector handled

   380

    def SetConnectorEdge(self, edge):

   381

        handle_type, handle = self.Handle

   382

        if handle_type == HANDLE_CONNECTOR:

   383

            handle.SetEdge(edge)

   384

            self.RefreshModel(False)

   385

   386

#    # Method called when a Motion event have been generated

   387

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

   388

#        if not event.Dragging():

   389

#            pos = event.GetLogicalPosition(dc)

   390

#            for input in self.Inputs:

   391

#                rect = input.GetRedrawRect()

   392

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

   393

#                    print "Find input"

   394

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

   395

#                    tip.SetBoundingRect(rect)

   396

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

   397

   398

    # Method called when a LeftDClick event have been generated

   399

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

   400

        # Edit the block properties

   401

        self.Parent.EditBlockContent(self)

   402

   403

    # Method called when a RightUp event have been generated

   404

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

   405

        pos = GetScaledEventPosition(event, dc, scaling)

   406

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

   407

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

   408

        if connector:

   409

            self.Handle = (HANDLE_CONNECTOR, connector)

   410

            self.Parent.PopupBlockMenu(connector)

   411

        else:

   412

            self.Parent.PopupBlockMenu()

   413

   414

    # Refreshes the block model

   415

    def RefreshModel(self, move=True):

   416

        self.Parent.RefreshBlockModel(self)

   417

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

   418

        if move:

   419

            for output in self.Outputs:

   420

                output.RefreshWires()

   421

   422

    def GetToolTipValue(self):

   423

        return self.Description

   424

   425

    # Adds an highlight to the block

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

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

   433

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

   434

   435

    # Removes an highlight from the block

   436

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

   437

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

   438

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

   439

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

   440

                self.Highlights.pop(infos[0])

   441

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

   442

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

   443

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

   444

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

   445

   446

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

   447

    def ClearHighlight(self, highlight_type=None):

   448

        if highlight_type is None:

   449

            self.Highlights = {}

   450

        else:

   451

            highlight_items = list(self.Highlights.items())

   452

            for name, highlights in highlight_items:

   453

                highlights = ClearHighlights(highlights, highlight_type)

   454

                if len(highlights) == 0:

   455

                    self.Highlights.pop(name)

   456

        for input in self.Inputs:

   457

            input.ClearHighlights(highlight_type)

   458

        for output in self.Outputs:

   459

            output.ClearHighlights(highlight_type)

   460

   461

    # Draws block

   462

    def Draw(self, dc):

   463

        Graphic_Element.Draw(self, dc)

   464

        dc.SetPen(self.Pen)

   465

        dc.SetBrush(wx.WHITE_BRUSH)

   466

        dc.SetTextForeground(self.Colour)

   467

   468

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

   469

            name_size = dc.GetTextExtent(self.Name)

   470

            type_size = dc.GetTextExtent(self.Type)

   471

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

   472

        else:

   473

            name_size = self.NameSize

   474

            type_size = self.TypeSize

   475

            executionorder_size = self.ExecutionOrderSize

   476

   477

        # Draw a rectangle with the block size

   478

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

   479

        # Draw block name and block type

   480

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

   481

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

   482

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

   483

                    self.Pos.y + 5)

   484

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

   485

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

   486

        # Draw inputs and outputs connectors

   487

        for input in self.Inputs:

   488

            input.Draw(dc)

   489

        for output in self.Outputs:

   490

            output.Draw(dc)

   491

        if self.ExecutionOrder != 0:

   492

            # Draw block execution order

   493

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

   494

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

   495

   496

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

   497

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

   498

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

   499

   500

   501

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

   502

#                        Function Block Diagram Variable

   503

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

   504

   505