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

    28

    29

from graphics.GraphicCommons import *

    30

from plcopen.structures import *

    31

    32

    33

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

    34

#                         Function Block Diagram Block

    35

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

    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

    42

class FBD_Block(Graphic_Element):

    43

    """

    44

    Class that implements the graphic representation of a function block

    45

    """

    46

    47

    # Create a new block

    48

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

    49

        Graphic_Element.__init__(self, parent)

    50

        self.Type = None

    51

        self.Description = None

    52

        self.Extension = None

    53

        self.ExecutionControl = False

    54

        self.Id = id

    55

        self.SetName(name)

    56

        self.SetExecutionOrder(executionOrder)

    57

        self.Inputs = []

    58

        self.Outputs = []

    59

        self.Colour = wx.BLACK

    60

        self.Pen = MiterPen(wx.BLACK)

    61

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

    62

        self.Highlights = {}

    63

    64

    # Make a clone of this FBD_Block

    65

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

    66

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

    67

            name = self.Name

    68

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

    69

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

    70

        if pos is not None:

    71

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

    72

        else:

    73

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

    74

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

    75

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

    76

        return block

    77

    78

    def GetConnectorTranslation(self, element):

    79

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

    80

    81

    def Flush(self):

    82

        for input in self.Inputs:

    83

            input.Flush()

    84

        self.Inputs = []

    85

        for output in self.Outputs:

    86

            output.Flush()

    87

        self.Outputs = []

    88

    89

    # Returns the RedrawRect

    90

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

    91

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

    92

        if movex != 0 or movey != 0:

    93

            for input in self.Inputs:

    94

                if input.IsConnected():

    95

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

    96

            for output in self.Outputs:

    97

                if output.IsConnected():

    98

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

    99

        return rect

   100

   101

    # Delete this block by calling the appropriate method

   102

    def Delete(self):

   103

        self.Parent.DeleteBlock(self)

   104

   105

    # Unconnect all inputs and outputs

   106

    def Clean(self):

   107

        for input in self.Inputs:

   108

            input.UnConnect(delete=True)

   109

        for output in self.Outputs:

   110

            output.UnConnect(delete=True)

   111

   112

    # Refresh the size of text for name

   113

    def RefreshNameSize(self):

   114

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

   115

   116

    # Refresh the size of text for execution order

   117

    def RefreshExecutionOrderSize(self):

   118

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

   119

   120

    # Returns if the point given is in the bounding box

   121

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

   122

        if self.Name != "":

   123

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

   124

        else:

   125

            test_text = False

   126

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

   127

        return test_text or test_block

   128

   129

    # Returns the bounding box of the name outside the block

   130

    def GetTextBoundingBox(self):

   131

        # Calculate the size of the name outside the block

   132

        text_width, text_height = self.NameSize

   133

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

   134

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

   135

                       text_width,

   136

                       text_height)

   137

   138

    # Returns the bounding box of function block without name outside

   139

    def GetBlockBoundingBox(self, connectors=True):

   140

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

   141

        bbx_width, bbx_height = self.Size

   142

        if connectors:

   143

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

   144

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

   145

        if self.ExecutionOrder != 0:

   146

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

   147

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

   148

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

   149

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

   150

   151

    # Refresh the block bounding box

   152

    def RefreshBoundingBox(self):

   153

        self.BoundingBox = self.GetBlockBoundingBox()

   154

        if self.Name != "":

   155

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

   156

   157

    # Refresh the positions of the block connectors

   158

    def RefreshConnectors(self):

   159

        scaling = self.Parent.GetScaling()

   160

        # Calculate the size for the connector lines

   161

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

   162

        if lines > 0:

   163

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

   164

            # Update inputs and outputs positions

   165

            position = BLOCK_LINE_SIZE + linesize / 2

   166

            for i in xrange(lines):

   167

                if scaling is not None:

   168

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

   169

                else:

   170

                    ypos = position

   171

                if i < len(self.Inputs):

   172

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

   173

                if i < len(self.Outputs):

   174

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

   175

                position += linesize

   176

        self.RefreshConnected()

   177

   178

    # Refresh the positions of wires connected to inputs and outputs

   179

    def RefreshConnected(self, exclude=None):

   180

        for input in self.Inputs:

   181

            input.MoveConnected(exclude)

   182

        for output in self.Outputs:

   183

            output.MoveConnected(exclude)

   184

   185

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

   186

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

   187

        if input_name is not None:

   188

            # Test each input connector

   189

            for input in self.Inputs:

   190

                if input_name == input.GetName():

   191

                    return input

   192

        if output_name is not None:

   193

            # Test each output connector

   194

            for output in self.Outputs:

   195

                if output_name == output.GetName():

   196

                    return output

   197

        if input_name is None and output_name is None:

   198

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

   199

        return None

   200

   201

    def GetInputTypes(self):

   202

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

   203

   204

    def SetOutputValues(self, values):

   205

        for output in self.Outputs:

   206

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

   207

   208

    def GetConnectionResultType(self, connector, connectortype):

   209

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

   210

            return connectortype

   211

        resulttype = connectortype

   212

        for input in self.Inputs:

   213

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

   214

                inputtype = input.GetConnectedType()

   215

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

   216

                    resulttype = inputtype

   217

        for output in self.Outputs:

   218

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

   219

                outputtype = output.GetConnectedType()

   220

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

   221

                    resulttype = outputtype

   222

        return resulttype

   223

   224

    # Returns all the block connectors

   225

    def GetConnectors(self):

   226

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

   227

   228

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

   229

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

   230

        # Test each input connector

   231

        for input in self.Inputs:

   232

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

   233

                return input

   234

        # Test each output connector

   235

        for output in self.Outputs:

   236

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

   237

                return output

   238

        return None

   239

   240

    # Changes the block type

   241

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

   242

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

   243

            if type != self.Type:

   244

                self.Type = type

   245

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

   246

            self.Extension = extension

   247

            self.ExecutionControl = executionControl

   248

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

   249

            # inputs and outputs

   250

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

   251

            if blocktype:

   252

                self.Colour = wx.BLACK

   253

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

   254

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

   255

                if blocktype["extensible"]:

   256

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

   257

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

   258

                        start += 1

   259

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

   260

                comment = blocktype["comment"]

   261

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

   262

            else:

   263

                self.Colour = wx.RED

   264

                connectors = {} if connectors is None else connectors

   265

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

   266

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

   267

                self.Description = None

   268

            if self.ExecutionControl:

   269

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

   270

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

   271

            self.Pen = MiterPen(self.Colour)

   272

   273

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

   274

            input_connectors = []

   275

            for input_name, input_type, input_modifier in inputs:

   276

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

   277

                if input_modifier == "negated":

   278

                    connector.SetNegated(True)

   279

                elif input_modifier != "none":

   280

                    connector.SetEdge(input_modifier)

   281

                for input in self.Inputs:

   282

                    if input.GetName() == input_name:

   283

                        wires = input.GetWires()[:]

   284

                        input.UnConnect()

   285

                        for wire in wires:

   286

                            connector.Connect(wire)

   287

                        break

   288

                input_connectors.append(connector)

   289

            for input in self.Inputs:

   290

                input.UnConnect(delete=True)

   291

            self.Inputs = input_connectors

   292

   293

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

   294

            output_connectors = []

   295

            for output_name, output_type, output_modifier in outputs:

   296

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

   297

                if output_modifier == "negated":

   298

                    connector.SetNegated(True)

   299

                elif output_modifier != "none":

   300

                    connector.SetEdge(output_modifier)

   301

                for output in self.Outputs:

   302

                    if output.GetName() == output_name:

   303

                        wires = output.GetWires()[:]

   304

                        output.UnConnect()

   305

                        for wire in wires:

   306

                            connector.Connect(wire)

   307

                        break

   308

                output_connectors.append(connector)

   309

            for output in self.Outputs:

   310

                output.UnConnect(delete=True)

   311

            self.Outputs = output_connectors

   312

   313

            self.RefreshMinSize()

   314

            self.RefreshConnectors()

   315

            for output in self.Outputs:

   316

                output.RefreshWires()

   317

            self.RefreshBoundingBox()

   318

   319

    # Returns the block type

   320

    def GetType(self):

   321

        return self.Type

   322

   323

    # Changes the block name

   324

    def SetName(self, name):

   325

        self.Name = name

   326

        self.RefreshNameSize()

   327

   328

    # Returs the block name

   329

    def GetName(self):

   330

        return self.Name

   331

   332

    # Changes the extension name

   333

    def SetExtension(self, extension):

   334

        self.Extension = extension

   335

   336

    # Returs the extension name

   337

    def GetExtension(self):

   338

        return self.Extension

   339

   340

    # Changes the execution order

   341

    def SetExecutionOrder(self, executionOrder):

   342

        self.ExecutionOrder = executionOrder

   343

        self.RefreshExecutionOrderSize()

   344

   345

    # Returs the execution order

   346

    def GetExecutionOrder(self):

   347

        return self.ExecutionOrder

   348

   349

    # Returs the execution order

   350

    def GetExecutionControl(self):

   351

        return self.ExecutionControl

   352

   353

    # Refresh the block minimum size

   354

    def RefreshMinSize(self):

   355

        # Calculate the inputs maximum width

   356

        max_input = 0

   357

        for input in self.Inputs:

   358

            w, _h = input.GetNameSize()

   359

            max_input = max(max_input, w)

   360

        # Calculate the outputs maximum width

   361

        max_output = 0

   362

        for output in self.Outputs:

   363

            w, _h = output.GetNameSize()

   364

            max_output = max(max_output, w)

   365

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

   366

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

   367

        self.MinSize = width, height

   368

   369

    # Returns the block minimum size

   370

    def GetMinSize(self):

   371

        return self.MinSize

   372

   373

    # Changes the negated property of the connector handled

   374

    def SetConnectorNegated(self, negated):

   375

        handle_type, handle = self.Handle

   376

        if handle_type == HANDLE_CONNECTOR:

   377

            handle.SetNegated(negated)

   378

            self.RefreshModel(False)

   379

   380

    # Changes the edge property of the connector handled

   381

    def SetConnectorEdge(self, edge):

   382

        handle_type, handle = self.Handle

   383

        if handle_type == HANDLE_CONNECTOR:

   384

            handle.SetEdge(edge)

   385

            self.RefreshModel(False)

   386

   387

#    # Method called when a Motion event have been generated

   388

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

   389

#        if not event.Dragging():

   390

#            pos = event.GetLogicalPosition(dc)

   391

#            for input in self.Inputs:

   392

#                rect = input.GetRedrawRect()

   393

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

   394

#                    print "Find input"

   395

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

   396

#                    tip.SetBoundingRect(rect)

   397

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

   398

   399

    # Method called when a LeftDClick event have been generated

   400

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

   401

        # Edit the block properties

   402

        self.Parent.EditBlockContent(self)

   403

   404

    # Method called when a RightUp event have been generated

   405

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

   406

        pos = GetScaledEventPosition(event, dc, scaling)

   407

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

   408

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

   409

        if connector:

   410

            self.Handle = (HANDLE_CONNECTOR, connector)

   411

            self.Parent.PopupBlockMenu(connector)

   412

        else:

   413

            self.Parent.PopupBlockMenu()

   414

   415

    # Refreshes the block model

   416

    def RefreshModel(self, move=True):

   417

        self.Parent.RefreshBlockModel(self)

   418

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

   419

        if move:

   420

            for output in self.Outputs:

   421

                output.RefreshWires()

   422

   423

    def GetToolTipValue(self):

   424

        return self.Description

   425

   426

    # Adds an highlight to the block

   427

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

   428

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

   429

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

   430

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

   431

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

   432

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

   433

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

   434

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

   435

   436

    # Removes an highlight from the block

   437

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

   438

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

   439

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

   440

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

   441

                self.Highlights.pop(infos[0])

   442

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

   443

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

   444

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

   445

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

   446

   447

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

   448

    def ClearHighlight(self, highlight_type=None):

   449

        if highlight_type is None:

   450

            self.Highlights = {}

   451

        else:

   452

            highlight_items = self.Highlights.items()

   453

            for name, highlights in highlight_items:

   454

                highlights = ClearHighlights(highlights, highlight_type)

   455

                if len(highlights) == 0:

   456

                    self.Highlights.pop(name)

   457

        for input in self.Inputs:

   458

            input.ClearHighlights(highlight_type)

   459

        for output in self.Outputs:

   460

            output.ClearHighlights(highlight_type)

   461

   462

    # Draws block

   463

    def Draw(self, dc):

   464

        Graphic_Element.Draw(self, dc)

   465

        dc.SetPen(self.Pen)

   466

        dc.SetBrush(wx.WHITE_BRUSH)

   467

        dc.SetTextForeground(self.Colour)

   468

   469

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

   470

            name_size = dc.GetTextExtent(self.Name)

   471

            type_size = dc.GetTextExtent(self.Type)

   472

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

   473

        else:

   474

            name_size = self.NameSize

   475

            type_size = self.TypeSize

   476

            executionorder_size = self.ExecutionOrderSize

   477

   478

        # Draw a rectangle with the block size

   479

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

   480

        # Draw block name and block type

   481

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

   482

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

   483

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

   484

                    self.Pos.y + 5)

   485

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

   486

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

   487

        # Draw inputs and outputs connectors

   488

        for input in self.Inputs:

   489

            input.Draw(dc)

   490

        for output in self.Outputs:

   491

            output.Draw(dc)

   492

        if self.ExecutionOrder != 0:

   493

            # Draw block execution order

   494

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

   495

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

   496

   497

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

   498

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

   499

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

   500

   501

   502

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

   503

#                        Function Block Diagram Variable

   504

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

   505

   506

   507

class FBD_Variable(Graphic_Element):