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 math

    29

from time import time as gettime

    30

from threading import Lock

    31

    32

import wx

    33

from six.moves import xrange

    34

    35

from plcopen.structures import *

    36

from plcopen.types_enums import ComputePouName

    37

from PLCControler import ITEM_VAR_LOCAL, ITEM_POU, ITEM_PROGRAM, ITEM_FUNCTIONBLOCK

    38

    39

from graphics.GraphicCommons import *

    40

from graphics.FBD_Objects import *

    41

from graphics.LD_Objects import *

    42

from graphics.SFC_Objects import *

    43

from graphics.RubberBand import RubberBand

    44

from graphics.DebugDataConsumer import DebugDataConsumer

    45

    46

from dialogs import *

    47

from editors.DebugViewer import DebugViewer, REFRESH_PERIOD

    48

from editors.EditorPanel import EditorPanel

    49

    50

SCROLLBAR_UNIT = 10

    51

WINDOW_BORDER = 10

    52

SCROLL_ZONE = 10

    53

    54

CURSORS = None

    55

SFC_Objects = (SFC_Step, SFC_ActionBlock, SFC_Transition, SFC_Divergence, SFC_Jump)

    56

    57

    58

def ResetCursors():

    59

    global CURSORS

    60

    if CURSORS is None:

    61

        CURSORS = [wx.NullCursor,

    62

                   wx.StockCursor(wx.CURSOR_HAND),

    63

                   wx.StockCursor(wx.CURSOR_SIZENWSE),

    64

                   wx.StockCursor(wx.CURSOR_SIZENESW),

    65

                   wx.StockCursor(wx.CURSOR_SIZEWE),

    66

                   wx.StockCursor(wx.CURSOR_SIZENS)]

    67

    68

    69

def AppendMenu(parent, help, id, kind, text):

    70

    parent.Append(help=help, id=id, kind=kind, text=text)

    71

    72

    73

if wx.Platform == '__WXMSW__':

    74

    faces = {

    75

        'times': 'Times New Roman',

    76

        'mono':  'Courier New',

    77

        'helv':  'Arial',

    78

        'other': 'Comic Sans MS',

    79

        'size':  10,

    80

    }

    81

else:

    82

    faces = {

    83

        'times': 'Times',

    84

        'mono':  'Courier',

    85

        'helv':  'Helvetica',

    86

        'other': 'new century schoolbook',

    87

        'size':  10,

    88

    }

    89

    90

if wx.Platform == '__WXMSW__':

    91

    MAX_ZOOMIN = 4

    92

else:

    93

    MAX_ZOOMIN = 7

    94

ZOOM_FACTORS = [math.sqrt(2) ** x for x in xrange(-6, MAX_ZOOMIN)]

    95

    96

    97

def GetVariableCreationFunction(variable_type):

    98

    def variableCreationFunction(viewer, id, specific_values):

    99

        return FBD_Variable(viewer,

   100

                            variable_type,

   101

                            specific_values.name,

   102

                            specific_values.value_type,

   103

                            id,

   104

                            specific_values.execution_order)

   105

    return variableCreationFunction

   106

   107

   108

def GetConnectorCreationFunction(connector_type):

   109

    def connectorCreationFunction(viewer, id, specific_values):

   110

        return FBD_Connector(viewer,

   111

                             connector_type,

   112

                             specific_values.name,

   113

                             id)

   114

    return connectorCreationFunction

   115

   116

   117

def commentCreationFunction(viewer, id, specific_values):

   118

    return Comment(viewer, specific_values.content, id)

   119

   120

   121

def GetPowerRailCreationFunction(powerrail_type):

   122

    def powerRailCreationFunction(viewer, id, specific_values):

   123

        return LD_PowerRail(viewer,

   124

                            powerrail_type,

   125

                            id,

   126

                            specific_values.connectors)

   127

    return powerRailCreationFunction

   128

   129

   130

def NEGATED_VALUE(x):

   131

    return x if x is not None else False

   132

   133

   134

def MODIFIER_VALUE(x):

   135

    return x if x is not None else 'none'

   136

   137

   138

CONTACT_TYPES = {(True, "none"): CONTACT_REVERSE,

   139

                 (False, "rising"): CONTACT_RISING,

   140

                 (False, "falling"): CONTACT_FALLING}

   141

   142

   143

def contactCreationFunction(viewer, id, specific_values):

   144

    contact_type = CONTACT_TYPES.get((NEGATED_VALUE(specific_values.negated),

   145

                                      MODIFIER_VALUE(specific_values.edge)),

   146

                                     CONTACT_NORMAL)

   147

    return LD_Contact(viewer, contact_type, specific_values.name, id)

   148

   149

   150

COIL_TYPES = {(True, "none", "none"): COIL_REVERSE,

   151

              (False, "none", "set"): COIL_SET,

   152

              (False, "none", "reset"): COIL_RESET,

   153

              (False, "rising", "none"): COIL_RISING,

   154

              (False, "falling", "none"): COIL_FALLING}

   155

   156

   157

def coilCreationFunction(viewer, id, specific_values):

   158

    coil_type = COIL_TYPES.get((NEGATED_VALUE(specific_values.negated),

   159

                                MODIFIER_VALUE(specific_values.edge),

   160

                                MODIFIER_VALUE(specific_values.storage)),

   161

                               COIL_NORMAL)

   162

    return LD_Coil(viewer, coil_type, specific_values.name, id)

   163

   164

   165

def stepCreationFunction(viewer, id, specific_values):

   166

    step = SFC_Step(viewer,

   167

                    specific_values.name,

   168

                    specific_values.initial,

   169

                    id)

   170

    if specific_values.action is not None:

   171

        step.AddAction()

   172

        connector = step.GetActionConnector()

   173

        connector.SetPosition(wx.Point(*specific_values.action.position))

   174

    return step

   175

   176

   177

def transitionCreationFunction(viewer, id, specific_values):

   178

    transition = SFC_Transition(viewer,

   179

                                specific_values.condition_type,

   180

                                specific_values.condition,

   181

                                specific_values.priority,

   182

                                id)

   183

    return transition

   184

   185

   186

divergence_types = [SELECTION_DIVERGENCE,

   187

                    SELECTION_CONVERGENCE, SIMULTANEOUS_DIVERGENCE, SIMULTANEOUS_CONVERGENCE]

   188

   189

   190

def GetDivergenceCreationFunction(divergence_type):

   191

    def divergenceCreationFunction(viewer, id, specific_values):

   192

        return SFC_Divergence(viewer, divergence_type,

   193

                              specific_values.connectors, id)

   194

    return divergenceCreationFunction

   195

   196

   197

def jumpCreationFunction(viewer, id, specific_values):

   198

    return SFC_Jump(viewer, specific_values.target, id)

   199

   200

   201

def actionBlockCreationFunction(viewer, id, specific_values):

   202

    return SFC_ActionBlock(viewer, specific_values.actions, id)

   203

   204

   205

ElementCreationFunctions = {

   206

    "input": GetVariableCreationFunction(INPUT),

   207

    "output": GetVariableCreationFunction(OUTPUT),

   208

    "inout": GetVariableCreationFunction(INOUT),

   209

    "connector": GetConnectorCreationFunction(CONNECTOR),

   210

    "continuation": GetConnectorCreationFunction(CONTINUATION),

   211

    "comment": commentCreationFunction,

   212

    "leftPowerRail": GetPowerRailCreationFunction(LEFTRAIL),

   213

    "rightPowerRail": GetPowerRailCreationFunction(RIGHTRAIL),

   214

    "contact": contactCreationFunction,

   215

    "coil": coilCreationFunction,

   216

    "step": stepCreationFunction,

   217

    "transition": transitionCreationFunction,

   218

    "selectionDivergence": GetDivergenceCreationFunction(SELECTION_DIVERGENCE),

   219

    "selectionConvergence": GetDivergenceCreationFunction(SELECTION_CONVERGENCE),

   220

    "simultaneousDivergence": GetDivergenceCreationFunction(SIMULTANEOUS_DIVERGENCE),

   221

    "simultaneousConvergence": GetDivergenceCreationFunction(SIMULTANEOUS_CONVERGENCE),

   222

    "jump": jumpCreationFunction,

   223

    "actionBlock": actionBlockCreationFunction,

   224

}

   225

   226

   227

def sort_blocks(block_infos1, block_infos2):

   228

    x1, y1 = block_infos1[0].GetPosition()

   229

    x2, y2 = block_infos2[0].GetPosition()

   230

    if y1 == y2:

   231

        return cmp(x1, x2)

   232

    else:

   233

        return cmp(y1, y2)

   234

   235

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

   236

#                       Graphic elements Viewer base class

   237

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

   238

   239

   240

# ID Constants for alignment menu items

   241

[

   242

    ID_VIEWERALIGNMENTMENUITEMS0, ID_VIEWERALIGNMENTMENUITEMS1,

   243

    ID_VIEWERALIGNMENTMENUITEMS2, ID_VIEWERALIGNMENTMENUITEMS4,

   244

    ID_VIEWERALIGNMENTMENUITEMS5, ID_VIEWERALIGNMENTMENUITEMS6,

   245

] = [wx.NewId() for _init_coll_AlignmentMenu_Items in range(6)]

   246

   247

# ID Constants for contextual menu items

   248

[

   249

    ID_VIEWERCONTEXTUALMENUITEMS0, ID_VIEWERCONTEXTUALMENUITEMS1,

   250

    ID_VIEWERCONTEXTUALMENUITEMS2, ID_VIEWERCONTEXTUALMENUITEMS3,

   251

    ID_VIEWERCONTEXTUALMENUITEMS5, ID_VIEWERCONTEXTUALMENUITEMS6,

   252

    ID_VIEWERCONTEXTUALMENUITEMS8, ID_VIEWERCONTEXTUALMENUITEMS9,

   253

    ID_VIEWERCONTEXTUALMENUITEMS11, ID_VIEWERCONTEXTUALMENUITEMS12,

   254

    ID_VIEWERCONTEXTUALMENUITEMS14, ID_VIEWERCONTEXTUALMENUITEMS16,

   255

    ID_VIEWERCONTEXTUALMENUITEMS17,

   256

] = [wx.NewId() for _init_coll_ContextualMenu_Items in range(13)]

   257

   258

   259

class ViewerDropTarget(wx.TextDropTarget):

   260

   261

    def __init__(self, parent):

   262

        wx.TextDropTarget.__init__(self)

   263

        self.ParentWindow = parent

   264

   265

    def OnDropText(self, x, y, data):

   266

        self.ParentWindow.Select()

   267

        tagname = self.ParentWindow.GetTagName()

   268

        pou_name, pou_type = self.ParentWindow.Controler.GetEditedElementType(tagname, self.ParentWindow.Debug)

   269

        x, y = self.ParentWindow.CalcUnscrolledPosition(x, y)

   270

        x = int(x / self.ParentWindow.ViewScale[0])

   271

        y = int(y / self.ParentWindow.ViewScale[1])

   272

        scaling = self.ParentWindow.Scaling

   273

        message = None

   274

        try:

   275

            values = eval(data)

   276

        except Exception:

   277

            message = _("Invalid value \"%s\" for viewer block") % data

   278

            values = None

   280

            message = _("Invalid value \"%s\" for viewer block") % data

   281

            values = None

   282

        if values is not None:

   283

            if values[1] == "debug":

   284

                pass

   285

            elif values[1] == "program":

   286

                message = _("Programs can't be used by other POUs!")

   287

            elif values[1] in ["function", "functionBlock"]:

   288

                if pou_name == values[0]:

   289

                    message = _("\"%s\" can't use itself!") % pou_name

   290

                elif pou_type == "function" and values[1] != "function":

   291

                    message = _("Function Blocks can't be used in Functions!")

   292

                elif self.ParentWindow.Controler.PouIsUsedBy(pou_name, values[0], self.ParentWindow.Debug):

   293

                    message = _("\"{a1}\" is already used by \"{a2}\"!").format(a1=pou_name, a2=values[0])

   294

                else:

   295

                    blockname = values[2]

   296

                    if len(values) > 3:

   297

                        blockinputs = values[3]

   298

                    else:

   299

                        blockinputs = None

   300

                    if values[1] != "function" and blockname == "":

   301

                        blockname = self.ParentWindow.GenerateNewName(blocktype=values[0])

   302

                    if blockname.upper() in [name.upper() for name in self.ParentWindow.Controler.GetProjectPouNames(self.ParentWindow.Debug)]:

   303

                        message = _("\"%s\" pou already exists!") % blockname

   304

                    elif blockname.upper() in [name.upper() for name in self.ParentWindow.Controler.GetEditedElementVariables(tagname, self.ParentWindow.Debug)]:

   305

                        message = _("\"%s\" element for this pou already exists!") % blockname

   306

                    else:

   307

                        id = self.ParentWindow.GetNewId()

   308

                        block = FBD_Block(self.ParentWindow, values[0], blockname, id, inputs=blockinputs)

   309

                        width, height = block.GetMinSize()

   310

                        if scaling is not None:

   311

                            x = round(x / scaling[0]) * scaling[0]

   312

                            y = round(y / scaling[1]) * scaling[1]

   313

                            width = round(width / scaling[0] + 0.5) * scaling[0]

   314

                            height = round(height / scaling[1] + 0.5) * scaling[1]

   315

                        block.SetPosition(x, y)

   316

                        block.SetSize(width, height)

   317

                        self.ParentWindow.AddBlock(block)

   318

                        self.ParentWindow.Controler.AddEditedElementBlock(tagname, id, values[0], blockname)

   319

                        self.ParentWindow.RefreshBlockModel(block)

   320

                        self.ParentWindow.RefreshBuffer()

   321

                        self.ParentWindow.RefreshScrollBars()

   322

                        self.ParentWindow.RefreshVisibleElements()

   323

                        self.ParentWindow.RefreshVariablePanel()

   324

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   325

                        self.ParentWindow.Refresh(False)

   326

            elif values[1] == "location":

   327

                if pou_type == "program":

   328

                    location = values[0]

   329

                    if not location.startswith("%"):

   330

                        dialog = wx.SingleChoiceDialog(

   331

                            self.ParentWindow.ParentWindow,

   332

                            _("Select a variable class:"),

   333

                            _("Variable class"),

   334

                            [_("Input"), _("Output"), _("Memory")],

   335

                            wx.DEFAULT_DIALOG_STYLE | wx.OK | wx.CANCEL)

   336

                        if dialog.ShowModal() == wx.ID_OK:

   337

                            selected = dialog.GetSelection()

   338

                        else:

   339

                            selected = None

   340

                        dialog.Destroy()

   341

                        if selected is None:

   342

                            return

   343

                        if selected == 0:

   344

                            location = "%I" + location

   345

                        elif selected == 1:

   346

                            location = "%Q" + location

   347

                        else:

   348

                            location = "%M" + location

   349

                    var_name = values[3]

   350

                    dlg = wx.TextEntryDialog(

   351

                        self.ParentWindow.ParentWindow,

   352

                        _("Confirm or change variable name"),

   353

                        _('Variable Drop'), var_name)

   354

                    dlg.SetValue(var_name)

   355

                    var_name = dlg.GetValue() if dlg.ShowModal() == wx.ID_OK else None

   356

                    dlg.Destroy()

   357

                    if var_name is None:

   358

                        return

   359

                    elif var_name.upper() in [name.upper() for name in self.ParentWindow.Controler.GetProjectPouNames(self.ParentWindow.Debug)]:

   360

                        message = _("\"%s\" pou already exists!") % var_name

   361

                    elif not var_name.upper() in [name.upper() for name in self.ParentWindow.Controler.GetEditedElementVariables(tagname, self.ParentWindow.Debug)]:

   362

                        if location[1] == "Q":

   363

                            var_class = OUTPUT

   364

                        else:

   365

                            var_class = INPUT

   366

                        if values[2] is not None:

   367

                            var_type = values[2]

   368

                        else:

   369

                            var_type = LOCATIONDATATYPES.get(location[2], ["BOOL"])[0]

   370

                        self.ParentWindow.Controler.AddEditedElementPouVar(tagname, var_type, var_name, location=location, description=values[4])

   371

                        self.ParentWindow.RefreshVariablePanel()

   372

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   373

                        self.ParentWindow.AddVariableBlock(x, y, scaling, var_class, var_name, var_type)

   374

                    else:

   375

                        message = _("\"%s\" element for this pou already exists!") % var_name

   376

            elif values[1] == "NamedConstant":

   377

                if pou_type == "program":

   378

                    initval = values[0]

   379

                    var_name = values[3]

   380

                    dlg = wx.TextEntryDialog(

   381

                        self.ParentWindow.ParentWindow,

   382

                        _("Confirm or change variable name"),

   383

                        _('Variable Drop'), var_name)

   384

                    dlg.SetValue(var_name)

   385

                    var_name = dlg.GetValue() if dlg.ShowModal() == wx.ID_OK else None

   386

                    dlg.Destroy()

   387

                    if var_name is None:

   388

                        return

   389

                    elif var_name.upper() in [name.upper() for name in self.ParentWindow.Controler.GetProjectPouNames(self.ParentWindow.Debug)]:

   390

                        message = _("\"%s\" pou already exists!") % var_name

   391

                    elif not var_name.upper() in [name.upper() for name in self.ParentWindow.Controler.GetEditedElementVariables(tagname, self.ParentWindow.Debug)]:

   392

                        var_class = INPUT

   393

                        var_type = values[2]

   394

                        self.ParentWindow.Controler.AddEditedElementPouVar(tagname, var_type, var_name, description=values[4], initval=initval)

   395

                        self.ParentWindow.RefreshVariablePanel()

   396

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   397

                        self.ParentWindow.AddVariableBlock(x, y, scaling, var_class, var_name, var_type)

   398

                    else:

   399

                        message = _("\"%s\" element for this pou already exists!") % var_name

   400

            elif values[1] == "Global":

   401

                var_name = values[0]

   402

                dlg = wx.TextEntryDialog(

   403

                    self.ParentWindow.ParentWindow,

   404

                    _("Confirm or change variable name"),

   405

                    _('Variable Drop'), var_name)

   406

                dlg.SetValue(var_name)

   407

                var_name = dlg.GetValue() if dlg.ShowModal() == wx.ID_OK else None

   408

                dlg.Destroy()

   409

                if var_name is None:

   410

                    return

   411

                elif var_name.upper() in [name.upper() for name in self.ParentWindow.Controler.GetProjectPouNames(self.ParentWindow.Debug)]:

   412

                    message = _("\"%s\" pou already exists!") % var_name

   413

                elif not var_name.upper() in [name.upper() for name in self.ParentWindow.Controler.GetEditedElementVariables(tagname, self.ParentWindow.Debug)]:

   414

                    self.ParentWindow.Controler.AddEditedElementPouExternalVar(tagname, values[2], var_name)

   415

                    self.ParentWindow.RefreshVariablePanel()

   416

                    self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   417

                    self.ParentWindow.AddVariableBlock(x, y, scaling, INPUT, var_name, values[2])

   418

                else:

   419

                    message = _("\"%s\" element for this pou already exists!") % var_name

   420

            elif values[1] == "Constant":

   421

                self.ParentWindow.AddVariableBlock(x, y, scaling, INPUT, values[0], None)

   422

            elif values[3] == tagname:

   423

                if values[1] == "Output":

   424

                    var_class = OUTPUT

   425

                elif values[1] == "InOut":

   426

                    var_class = INPUT

   427

                else:

   428

                    var_class = INPUT

   429

                tree = dict([(var.Name, var.Tree) for var in self.ParentWindow.Controler.GetEditedElementInterfaceVars(tagname, True, self.ParentWindow.Debug)]).get(values[0], None)

   430

                if tree is not None:

   431

                    if len(tree[0]) > 0:

   432

                        menu = wx.Menu(title='')

   433

                        self.GenerateTreeMenu(x, y, scaling, menu, "", var_class, [(values[0], values[2], tree)])

   434

                        self.ParentWindow.PopupMenuXY(menu)

   435

                    else:

   436

                        self.ParentWindow.AddVariableBlock(x, y, scaling, var_class, values[0], values[2])

   437

                else:

   438

                    message = _("Unknown variable \"%s\" for this POU!") % values[0]

   439

            else:

   440

                message = _("Variable don't belong to this POU!")

   441

        if message is not None:

   442

            wx.CallAfter(self.ShowMessage, message)

   443

   444

    def GenerateTreeMenu(self, x, y, scaling, menu, base_path, var_class, tree):

   445

        for child_name, child_type, (child_tree, child_dimensions) in tree:

   446

            if base_path:

   447

                child_path = "%s.%s" % (base_path, child_name)

   448

            else:

   449

                child_path = child_name

   450

            if len(child_dimensions) > 0:

   451

                child_path += "[%s]" % ",".join([str(dimension[0]) for dimension in child_dimensions])

   452

                child_name += "[]"

   453

            new_id = wx.NewId()

   454

            AppendMenu(menu, help='', id=new_id, kind=wx.ITEM_NORMAL, text=child_name)

   455

            self.ParentWindow.Bind(wx.EVT_MENU, self.GetAddVariableBlockFunction(x, y, scaling, var_class, child_path, child_type), id=new_id)

   456

            if len(child_tree) > 0:

   457

                new_id = wx.NewId()

   458

                child_menu = wx.Menu(title='')

   459

                self.GenerateTreeMenu(x, y, scaling, child_menu, child_path, var_class, child_tree)

   460

                menu.AppendMenu(new_id, "%s." % child_name, child_menu)

   461

   462

    def GetAddVariableBlockFunction(self, x, y, scaling, var_class, var_name, var_type):

   463

        def AddVariableFunction(event):

   464

            self.ParentWindow.AddVariableBlock(x, y, scaling, var_class, var_name, var_type)

   465

        return AddVariableFunction

   466

   467

    def ShowMessage(self, message):

   468

        message = wx.MessageDialog(self.ParentWindow, message, _("Error"), wx.OK | wx.ICON_ERROR)

   469

        message.ShowModal()

   470

        message.Destroy()

   471

   472

   473

class DebugInstanceName(DebugDataConsumer):

   474

    VALUE_TRANSLATION = None

   475

   476

    def __init__(self, parent):

   477

        DebugDataConsumer.__init__(self)

   478

        self.Parent = parent

   479

        self.ActionLastState = None

   480

        self.ActionState = None

   481

        self.x_offset = 2

   482

        self.y_offset = 2

   483

   484

        if self.VALUE_TRANSLATION is None:

   485

            self.__class__.VALUE_TRANSLATION = {True: _("Active"), False: _("Inactive")}

   486

   487

    def SetValue(self, value):

   488

        self.ActionState = value

   489

        if self.ActionState != self.ActionLastState:

   490

            self.ActionLastState = self.ActionState

   491

            wx.CallAfter(self.Parent.ElementNeedRefresh, self)

   492

   493

    def GetInstanceName(self):

   494

        return _("Debug: %s") % self.Parent.InstancePath

   495

   496

    def GetRedrawRect(self):

   497

        x, y = self.Parent.CalcUnscrolledPosition(self.x_offset, self.y_offset)

   498

        dc = self.Parent.GetLogicalDC()

   499

        ipw, _iph = dc.GetTextExtent(self.GetInstanceName())