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

import wx

    26

    27

from graphics.GraphicCommons import *

    28

from plcopen.structures import *

    29

    30

    31

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

    32

#                         Function Block Diagram Block

    33

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

    34

    35

    36

def TestConnectorName(name, block_type):

    37

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

    38

    39

    40

class FBD_Block(Graphic_Element):

    41

    """

    42

    Class that implements the graphic representation of a function block

    43

    """

    44

    45

    # Create a new block

    46

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

    47

        Graphic_Element.__init__(self, parent)

    48

        self.Type = None

    49

        self.Description = None

    50

        self.Extension = None

    51

        self.ExecutionControl = False

    52

        self.Id = id

    53

        self.SetName(name)

    54

        self.SetExecutionOrder(executionOrder)

    55

        self.Inputs = []

    56

        self.Outputs = []

    57

        self.Colour = wx.BLACK

    58

        self.Pen = MiterPen(wx.BLACK)

    59

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

    60

        self.Highlights = {}

    61

    62

    # Make a clone of this FBD_Block

    63

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

    64

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

    65

            name = self.Name

    66

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

    67

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

    68

        if pos is not None:

    69

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

    70

        else:

    71

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

    72

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

    73

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

    74

        return block

    75

    76

    def GetConnectorTranslation(self, element):

    77

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

    78

    79

    def Flush(self):

    80

        for input in self.Inputs:

    81

            input.Flush()

    82

        self.Inputs = []

    83

        for output in self.Outputs:

    84

            output.Flush()

    85

        self.Outputs = []

    86

    87

    # Returns the RedrawRect

    88

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

    89

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

    90

        if movex != 0 or movey != 0:

    91

            for input in self.Inputs:

    92

                if input.IsConnected():

    93

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

    94

            for output in self.Outputs:

    95

                if output.IsConnected():

    96

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

    97

        return rect

    98

    99

    # Delete this block by calling the appropriate method

   100

    def Delete(self):

   101

        self.Parent.DeleteBlock(self)

   102

   103

    # Unconnect all inputs and outputs

   104

    def Clean(self):

   105

        for input in self.Inputs:

   106

            input.UnConnect(delete=True)

   107

        for output in self.Outputs:

   108

            output.UnConnect(delete=True)

   109

   110

    # Refresh the size of text for name

   111

    def RefreshNameSize(self):

   112

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

   113

   114

    # Refresh the size of text for execution order

   115

    def RefreshExecutionOrderSize(self):

   116

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

   117

   118

    # Returns if the point given is in the bounding box

   119

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

   120

        if self.Name != "":

   121

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

   122

        else:

   123

            test_text = False

   124

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

   125

        return test_text or test_block

   126

   127

    # Returns the bounding box of the name outside the block

   128

    def GetTextBoundingBox(self):

   129

        # Calculate the size of the name outside the block

   130

        text_width, text_height = self.NameSize

   131

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

   132

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

   133

                       text_width,

   134

                       text_height)

   135

   136

    # Returns the bounding box of function block without name outside

   137

    def GetBlockBoundingBox(self, connectors=True):

   138

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

   139

        bbx_width, bbx_height = self.Size

   140

        if connectors:

   141

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

   142

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

   143

        if self.ExecutionOrder != 0:

   144

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

   145

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

   146

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

   147

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

   148

   149

    # Refresh the block bounding box

   150

    def RefreshBoundingBox(self):

   151

        self.BoundingBox = self.GetBlockBoundingBox()

   152

        if self.Name != "":

   153

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

   154

   155

    # Refresh the positions of the block connectors

   156

    def RefreshConnectors(self):

   157

        scaling = self.Parent.GetScaling()

   158

        # Calculate the size for the connector lines

   159

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

   160

        if lines > 0:

   161

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

   162

            # Update inputs and outputs positions

   163

            position = BLOCK_LINE_SIZE + linesize / 2

   164

            for i in xrange(lines):

   165

                if scaling is not None:

   166

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

   167

                else:

   168

                    ypos = position

   169

                if i < len(self.Inputs):

   170

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

   171

                if i < len(self.Outputs):

   172

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

   173

                position += linesize

   174

        self.RefreshConnected()

   175

   176

    # Refresh the positions of wires connected to inputs and outputs

   177

    def RefreshConnected(self, exclude=[]):

   178

        for input in self.Inputs:

   179

            input.MoveConnected(exclude)

   180

        for output in self.Outputs:

   181

            output.MoveConnected(exclude)

   182

   183

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

   184

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

   185

        if input_name is not None:

   186

            # Test each input connector

   187

            for input in self.Inputs:

   188

                if input_name == input.GetName():

   189

                    return input

   190

        if output_name is not None:

   191

            # Test each output connector

   192

            for output in self.Outputs:

   193

                if output_name == output.GetName():

   194

                    return output

   195

        if input_name is None and output_name is None:

   196

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

   197

        return None

   198

   199

    def GetInputTypes(self):

   200

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

   201

   202

    def SetOutputValues(self, values):

   203

        for output in self.Outputs:

   204

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

   205

   206

    def GetConnectionResultType(self, connector, connectortype):

   207

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

   208

            return connectortype

   209

        resulttype = connectortype

   210

        for input in self.Inputs:

   211

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

   212

                inputtype = input.GetConnectedType()

   213

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

   214

                    resulttype = inputtype

   215

        for output in self.Outputs:

   216

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

   217

                outputtype = output.GetConnectedType()

   218

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

   219

                    resulttype = outputtype

   220

        return resulttype

   221

   222

    # Returns all the block connectors

   223

    def GetConnectors(self):

   224

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

   225

   226

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

   227

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

   228

        # Test each input connector

   229

        for input in self.Inputs:

   230

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

   231

                return input

   232

        # Test each output connector

   233

        for output in self.Outputs:

   234

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

   235

                return output

   236

        return None

   237

   238

    # Changes the block type

   239

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

   240

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

   241

            if type != self.Type:

   242

                self.Type = type

   243

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

   244

            self.Extension = extension

   245

            self.ExecutionControl = executionControl

   246

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

   247

            # inputs and outputs

   248

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

   249

            if blocktype:

   250

                self.Colour = wx.BLACK

   251

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

   252

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

   253

                if blocktype["extensible"]:

   254

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

   256

                        start += 1

   257

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

   258

                comment = blocktype["comment"]

   259

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

   260

            else:

   261

                self.Colour = wx.RED

   262

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

   263

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

   264

                self.Description = None

   265

            if self.ExecutionControl:

   266

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

   267

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

   268

            self.Pen = MiterPen(self.Colour)

   269

   270

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

   271

            input_connectors = []

   272

            for input_name, input_type, input_modifier in inputs:

   273

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

   274

                if input_modifier == "negated":

   275

                    connector.SetNegated(True)

   276

                elif input_modifier != "none":

   277

                    connector.SetEdge(input_modifier)

   278

                for input in self.Inputs:

   279

                    if input.GetName() == input_name:

   280

                        wires = input.GetWires()[:]

   281

                        input.UnConnect()

   282

                        for wire in wires:

   283

                            connector.Connect(wire)

   284

                        break

   285

                input_connectors.append(connector)

   286

            for input in self.Inputs:

   287

                input.UnConnect(delete=True)

   288

            self.Inputs = input_connectors

   289

   290

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

   291

            output_connectors = []

   292

            for output_name, output_type, output_modifier in outputs:

   293

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

   294

                if output_modifier == "negated":

   295

                    connector.SetNegated(True)

   296

                elif output_modifier != "none":

   297

                    connector.SetEdge(output_modifier)

   298

                for output in self.Outputs:

   299

                    if output.GetName() == output_name:

   300

                        wires = output.GetWires()[:]

   301

                        output.UnConnect()

   302

                        for wire in wires:

   303

                            connector.Connect(wire)

   304

                        break

   305

                output_connectors.append(connector)

   306

            for output in self.Outputs:

   307

                output.UnConnect(delete=True)

   308

            self.Outputs = output_connectors

   309

   310

            self.RefreshMinSize()

   311

            self.RefreshConnectors()

   312

            for output in self.Outputs:

   313

                output.RefreshWires()

   314

            self.RefreshBoundingBox()

   315

   316

    # Returns the block type

   317

    def GetType(self):

   318

        return self.Type

   319

   320

    # Changes the block name

   321

    def SetName(self, name):

   322

        self.Name = name

   323

        self.RefreshNameSize()

   324

   325

    # Returs the block name

   326

    def GetName(self):

   327

        return self.Name

   328

   329

    # Changes the extension name

   330

    def SetExtension(self, extension):

   331

        self.Extension = extension

   332

   333

    # Returs the extension name

   334

    def GetExtension(self):

   335

        return self.Extension

   336

   337

    # Changes the execution order

   338

    def SetExecutionOrder(self, executionOrder):

   339

        self.ExecutionOrder = executionOrder

   340

        self.RefreshExecutionOrderSize()

   341

   342

    # Returs the execution order

   343

    def GetExecutionOrder(self):

   344

        return self.ExecutionOrder

   345

   346

    # Returs the execution order

   347

    def GetExecutionControl(self):

   348

        return self.ExecutionControl

   349

   350

    # Refresh the block minimum size

   351

    def RefreshMinSize(self):

   352

        # Calculate the inputs maximum width

   353

        max_input = 0

   354

        for input in self.Inputs:

   356

            max_input = max(max_input, w)

   357

        # Calculate the outputs maximum width

   358

        max_output = 0

   359

        for output in self.Outputs:

   361

            max_output = max(max_output, w)

   362

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

   363

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

   364

        self.MinSize = width, height

   365

   366

    # Returns the block minimum size

   367

    def GetMinSize(self):

   368

        return self.MinSize

   369

   370

    # Changes the negated property of the connector handled

   371

    def SetConnectorNegated(self, negated):

   372

        handle_type, handle = self.Handle

   373

        if handle_type == HANDLE_CONNECTOR:

   374

            handle.SetNegated(negated)

   375

            self.RefreshModel(False)

   376

   377

    # Changes the edge property of the connector handled

   378

    def SetConnectorEdge(self, edge):

   379

        handle_type, handle = self.Handle

   380

        if handle_type == HANDLE_CONNECTOR:

   381

            handle.SetEdge(edge)

   382

            self.RefreshModel(False)

   383

   384

#    # Method called when a Motion event have been generated

   385

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

   386

#        if not event.Dragging():

   387

#            pos = event.GetLogicalPosition(dc)

   388

#            for input in self.Inputs:

   389

#                rect = input.GetRedrawRect()

   390

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

   391

#                    print "Find input"

   392

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

   393

#                    tip.SetBoundingRect(rect)

   394

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

   395

   396

    # Method called when a LeftDClick event have been generated

   397

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

   398

        # Edit the block properties

   399

        self.Parent.EditBlockContent(self)

   400

   401

    # Method called when a RightUp event have been generated

   402

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

   403

        pos = GetScaledEventPosition(event, dc, scaling)

   404

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

   405

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

   406

        if connector:

   407

            self.Handle = (HANDLE_CONNECTOR, connector)

   408

            self.Parent.PopupBlockMenu(connector)

   409

        else:

   410

            self.Parent.PopupBlockMenu()

   411

   412

    # Refreshes the block model

   413

    def RefreshModel(self, move=True):

   414

        self.Parent.RefreshBlockModel(self)

   415

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

   416

        if move:

   417

            for output in self.Outputs:

   418

                output.RefreshWires()

   419

   420

    def GetToolTipValue(self):

   421

        return self.Description

   422

   423

    # Adds an highlight to the block

   424

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

   425

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

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

   433

    # Removes an highlight from the block

   434

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

   435

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

   436

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

   437

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

   438

                self.Highlights.pop(infos[0])

   439

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

   440

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

   441

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

   442

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

   443

   444

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

   445

    def ClearHighlight(self, highlight_type=None):

   446

        if highlight_type is None:

   447

            self.Highlights = {}

   448

        else:

   449

            highlight_items = self.Highlights.items()

   450

            for name, highlights in highlight_items:

   451

                highlights = ClearHighlights(highlights, highlight_type)

   452

                if len(highlights) == 0:

   453

                    self.Highlights.pop(name)

   454

        for input in self.Inputs:

   455

            input.ClearHighlights(highlight_type)

   456

        for output in self.Outputs:

   457

            output.ClearHighlights(highlight_type)

   458

   459

    # Draws block

   460

    def Draw(self, dc):

   461

        Graphic_Element.Draw(self, dc)

   462

        dc.SetPen(self.Pen)

   463

        dc.SetBrush(wx.WHITE_BRUSH)

   464

        dc.SetTextForeground(self.Colour)

   465

   466

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

   467

            name_size = dc.GetTextExtent(self.Name)

   468

            type_size = dc.GetTextExtent(self.Type)

   469

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

   470

        else:

   471

            name_size = self.NameSize

   472

            type_size = self.TypeSize

   473

            executionorder_size = self.ExecutionOrderSize

   474

   475

        # Draw a rectangle with the block size

   476

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

   477

        # Draw block name and block type

   478

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

   479

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

   480

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

   481

                    self.Pos.y + 5)

   482

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

   483

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

   484

        # Draw inputs and outputs connectors

   485

        for input in self.Inputs:

   486

            input.Draw(dc)

   487

        for output in self.Outputs:

   488

            output.Draw(dc)

   489

        if self.ExecutionOrder != 0:

   490

            # Draw block execution order

   491

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

   492

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

   493

   494

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

   495

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

   496

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

   497

   498

   499

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

   500

#                        Function Block Diagram Variable

   501

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

   502

   503

   504

class FBD_Variable(Graphic_Element):

   505

    """

   506

    Class that implements the graphic representation of a variable

   507

    """