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 math

    28

from time import time as gettime

    29

from types import TupleType

    30

from threading import Lock

    31

    32

import wx

    33

    34

from plcopen.structures import *

    35

from plcopen.types_enums import ComputePouName

    36

from PLCControler import ITEM_VAR_LOCAL, ITEM_POU, ITEM_PROGRAM, ITEM_FUNCTIONBLOCK

    37

    38

from graphics.GraphicCommons import *

    39

from graphics.FBD_Objects import *

    40

from graphics.LD_Objects import *

    41

from graphics.SFC_Objects import *

    42

from graphics.RubberBand import RubberBand

    43

from graphics.DebugDataConsumer import DebugDataConsumer

    44

    45

from dialogs import *

    46

from editors.DebugViewer import DebugViewer, REFRESH_PERIOD

    47

from editors.EditorPanel import EditorPanel

    48

    49

SCROLLBAR_UNIT = 10

    50

WINDOW_BORDER = 10

    51

SCROLL_ZONE = 10

    52

    53

CURSORS = None

    54

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

    55

    56

    57

def ResetCursors():

    58

    global CURSORS

    59

    if CURSORS is None:

    60

        CURSORS = [wx.NullCursor,

    61

                   wx.StockCursor(wx.CURSOR_HAND),

    62

                   wx.StockCursor(wx.CURSOR_SIZENWSE),

    63

                   wx.StockCursor(wx.CURSOR_SIZENESW),

    64

                   wx.StockCursor(wx.CURSOR_SIZEWE),

    65

                   wx.StockCursor(wx.CURSOR_SIZENS)]

    66

    67

    68

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

    69

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

    70

    71

    72

if wx.Platform == '__WXMSW__':

    73

    faces = {

    74

        'times': 'Times New Roman',

    75

        'mono':  'Courier New',

    76

        'helv':  'Arial',

    77

        'other': 'Comic Sans MS',

    78

        'size':  10,

    79

    }

    80

else:

    81

    faces = {

    82

        'times': 'Times',

    83

        'mono':  'Courier',

    84

        'helv':  'Helvetica',

    85

        'other': 'new century schoolbook',

    86

        'size':  10,

    87

    }

    88

    89

if wx.Platform == '__WXMSW__':

    90

    MAX_ZOOMIN = 4

    91

else:

    92

    MAX_ZOOMIN = 7

    93

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

    94

    95

    96

def GetVariableCreationFunction(variable_type):

    97

    def variableCreationFunction(viewer, id, specific_values):

    98

        return FBD_Variable(viewer,

    99

                            variable_type,

   100

                            specific_values.name,

   101

                            specific_values.value_type,

   102

                            id,

   103

                            specific_values.execution_order)

   104

    return variableCreationFunction

   105

   106

   107

def GetConnectorCreationFunction(connector_type):

   108

    def connectorCreationFunction(viewer, id, specific_values):

   109

        return FBD_Connector(viewer,

   110

                             connector_type,

   111

                             specific_values.name,

   112

                             id)

   113

    return connectorCreationFunction

   114

   115

   116

def commentCreationFunction(viewer, id, specific_values):

   117

    return Comment(viewer, specific_values.content, id)

   118

   119

   120

def GetPowerRailCreationFunction(powerrail_type):

   121

    def powerRailCreationFunction(viewer, id, specific_values):

   122

        return LD_PowerRail(viewer,

   123

                            powerrail_type,

   124

                            id,

   125

                            specific_values.connectors)

   126

    return powerRailCreationFunction

   127

   128

   129

def NEGATED_VALUE(x):

   130

    return x if x is not None else False

   131

   132

   133

def MODIFIER_VALUE(x):

   134

    return x if x is not None else 'none'

   135

   136

   137

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

   138

                 (False, "rising"): CONTACT_RISING,

   139

                 (False, "falling"): CONTACT_FALLING}

   140

   141

   142

def contactCreationFunction(viewer, id, specific_values):

   143

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

   144

                                      MODIFIER_VALUE(specific_values.edge)),

   145

                                     CONTACT_NORMAL)

   146

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

   147

   148

   149

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

   150

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

   151

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

   152

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

   153

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

   154

   155

   156

def coilCreationFunction(viewer, id, specific_values):

   157

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

   158

                                MODIFIER_VALUE(specific_values.edge),

   159

                                MODIFIER_VALUE(specific_values.storage)),

   160

                               COIL_NORMAL)

   161

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

   162

   163

   164

def stepCreationFunction(viewer, id, specific_values):

   165

    step = SFC_Step(viewer,

   166

                    specific_values.name,

   167

                    specific_values.initial,

   168

                    id)

   169

    if specific_values.action is not None:

   170

        step.AddAction()

   171

        connector = step.GetActionConnector()

   172

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

   173

    return step

   174

   175

   176

def transitionCreationFunction(viewer, id, specific_values):

   177

    transition = SFC_Transition(viewer,

   178

                                specific_values.condition_type,

   179

                                specific_values.condition,

   180

                                specific_values.priority,

   181

                                id)

   182

    return transition

   183

   184

   185

divergence_types = [SELECTION_DIVERGENCE,

   186

                    SELECTION_CONVERGENCE, SIMULTANEOUS_DIVERGENCE, SIMULTANEOUS_CONVERGENCE]

   187

   188

   189

def GetDivergenceCreationFunction(divergence_type):

   190

    def divergenceCreationFunction(viewer, id, specific_values):

   191

        return SFC_Divergence(viewer, divergence_type,

   192

                              specific_values.connectors, id)

   193

    return divergenceCreationFunction

   194

   195

   196

def jumpCreationFunction(viewer, id, specific_values):

   197

    return SFC_Jump(viewer, specific_values.target, id)

   198

   199

   200

def actionBlockCreationFunction(viewer, id, specific_values):

   201

    return SFC_ActionBlock(viewer, specific_values.actions, id)

   202

   203

   204

ElementCreationFunctions = {

   205

    "input": GetVariableCreationFunction(INPUT),

   206

    "output": GetVariableCreationFunction(OUTPUT),

   207

    "inout": GetVariableCreationFunction(INOUT),

   208

    "connector": GetConnectorCreationFunction(CONNECTOR),

   209

    "continuation": GetConnectorCreationFunction(CONTINUATION),

   210

    "comment": commentCreationFunction,

   211

    "leftPowerRail": GetPowerRailCreationFunction(LEFTRAIL),

   212

    "rightPowerRail": GetPowerRailCreationFunction(RIGHTRAIL),

   213

    "contact": contactCreationFunction,

   214

    "coil": coilCreationFunction,

   215

    "step": stepCreationFunction,

   216

    "transition": transitionCreationFunction,

   217

    "selectionDivergence": GetDivergenceCreationFunction(SELECTION_DIVERGENCE),

   218

    "selectionConvergence": GetDivergenceCreationFunction(SELECTION_CONVERGENCE),

   219

    "simultaneousDivergence": GetDivergenceCreationFunction(SIMULTANEOUS_DIVERGENCE),

   220

    "simultaneousConvergence": GetDivergenceCreationFunction(SIMULTANEOUS_CONVERGENCE),

   221

    "jump": jumpCreationFunction,

   222

    "actionBlock": actionBlockCreationFunction,

   223

}

   224

   225

   226

def sort_blocks(block_infos1, block_infos2):

   227

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

   228

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

   229

    if y1 == y2:

   230

        return cmp(x1, x2)

   231

    else:

   232

        return cmp(y1, y2)

   233

   234

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

   235

#                       Graphic elements Viewer base class

   236

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

   237

   238

   239

# ID Constants for alignment menu items

   240

[

   241

    ID_VIEWERALIGNMENTMENUITEMS0, ID_VIEWERALIGNMENTMENUITEMS1,

   242

    ID_VIEWERALIGNMENTMENUITEMS2, ID_VIEWERALIGNMENTMENUITEMS4,

   243

    ID_VIEWERALIGNMENTMENUITEMS5, ID_VIEWERALIGNMENTMENUITEMS6,

   244

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

   245

   246

# ID Constants for contextual menu items

   247

[

   248

    ID_VIEWERCONTEXTUALMENUITEMS0, ID_VIEWERCONTEXTUALMENUITEMS1,

   249

    ID_VIEWERCONTEXTUALMENUITEMS2, ID_VIEWERCONTEXTUALMENUITEMS3,

   250

    ID_VIEWERCONTEXTUALMENUITEMS5, ID_VIEWERCONTEXTUALMENUITEMS6,

   251

    ID_VIEWERCONTEXTUALMENUITEMS8, ID_VIEWERCONTEXTUALMENUITEMS9,

   252

    ID_VIEWERCONTEXTUALMENUITEMS11, ID_VIEWERCONTEXTUALMENUITEMS12,

   253

    ID_VIEWERCONTEXTUALMENUITEMS14, ID_VIEWERCONTEXTUALMENUITEMS16,

   254

    ID_VIEWERCONTEXTUALMENUITEMS17,

   255

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

   256

   257

   258

class ViewerDropTarget(wx.TextDropTarget):

   259

   260

    def __init__(self, parent):

   261

        wx.TextDropTarget.__init__(self)

   262

        self.ParentWindow = parent

   263

   264

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

   265

        self.ParentWindow.Select()

   266

        tagname = self.ParentWindow.GetTagName()

   267

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

   268

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

   269

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

   270

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

   271

        scaling = self.ParentWindow.Scaling

   272

        message = None

   273

        try:

   274

            values = eval(data)

   275

        except Exception:

   276

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

   277

            values = None

   278

        if not isinstance(values, TupleType):

   279

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

   280

            values = None

   281

        if values is not None:

   282

            if values[1] == "debug":

   283

                pass

   284

            elif values[1] == "program":

   285

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

   286

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

   287

                if pou_name == values[0]:

   288

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

   289

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

   290

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

   291

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

   292

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

   293

                else:

   294

                    blockname = values[2]

   295

                    if len(values) > 3:

   296

                        blockinputs = values[3]

   297

                    else:

   298

                        blockinputs = None

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

                    else:

   306

                        id = self.ParentWindow.GetNewId()

   307

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

   308

                        width, height = block.GetMinSize()

   309

                        if scaling is not None:

   310

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

   311

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

   312

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

   313

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

   314

                        block.SetPosition(x, y)

   315

                        block.SetSize(width, height)

   316

                        self.ParentWindow.AddBlock(block)

   317

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

   318

                        self.ParentWindow.RefreshBlockModel(block)

   319

                        self.ParentWindow.RefreshBuffer()

   320

                        self.ParentWindow.RefreshScrollBars()

   321

                        self.ParentWindow.RefreshVisibleElements()

   322

                        self.ParentWindow.RefreshVariablePanel()

   323

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   324

                        self.ParentWindow.Refresh(False)

   325

            elif values[1] == "location":

   326

                if pou_type == "program":

   327

                    location = values[0]

   328

                    if not location.startswith("%"):

   329

                        dialog = wx.SingleChoiceDialog(

   330

                            self.ParentWindow.ParentWindow,

   331

                            _("Select a variable class:"),

   332

                            _("Variable class"),

   333

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

   334

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

   335

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

   336

                            selected = dialog.GetSelection()

   337

                        else:

   338

                            selected = None

   339

                        dialog.Destroy()

   340

                        if selected is None:

   341

                            return

   342

                        if selected == 0:

   343

                            location = "%I" + location

   344

                        elif selected == 1:

   345

                            location = "%Q" + location

   346

                        else:

   347

                            location = "%M" + location

   348

                    var_name = values[3]

   349

                    dlg = wx.TextEntryDialog(

   350

                        self.ParentWindow.ParentWindow,

   351

                        _("Confirm or change variable name"),

   352

                        _('Variable Drop'), var_name)

   353

                    dlg.SetValue(var_name)

   354

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

   355

                    dlg.Destroy()

   356

                    if var_name is None:

   357

                        return

   358

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

   359

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

   360

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

   361

                        if location[1] == "Q":

   362

                            var_class = OUTPUT

   363

                        else:

   364

                            var_class = INPUT

   365

                        if values[2] is not None:

   366

                            var_type = values[2]

   367

                        else:

   368

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

   369

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

   370

                        self.ParentWindow.RefreshVariablePanel()

   371

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   372

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

   373

                    else:

   374

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

   375

            elif values[1] == "NamedConstant":

   376

                if pou_type == "program":

   377

                    initval = values[0]

   378

                    var_name = values[3]

   379

                    dlg = wx.TextEntryDialog(

   380

                        self.ParentWindow.ParentWindow,

   381

                        _("Confirm or change variable name"),

   382

                        _('Variable Drop'), var_name)

   383

                    dlg.SetValue(var_name)

   384

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

   385

                    dlg.Destroy()

   386

                    if var_name is None:

   387

                        return

   388

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

   389

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

   390

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

   391

                        var_class = INPUT

   392

                        var_type = values[2]

   393

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

   394

                        self.ParentWindow.RefreshVariablePanel()

   395

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   396

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

   397

                    else:

   398

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

   399

            elif values[1] == "Global":

   400

                var_name = values[0]

   401

                dlg = wx.TextEntryDialog(

   402

                    self.ParentWindow.ParentWindow,

   403

                    _("Confirm or change variable name"),

   404

                    _('Variable Drop'), var_name)

   405

                dlg.SetValue(var_name)

   406

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

   407

                dlg.Destroy()

   408

                if var_name is None:

   409

                    return

   410

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

   411

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

   412

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

   413

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

   414

                    self.ParentWindow.RefreshVariablePanel()

   415

                    self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   416

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

   417

                else:

   418

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

   419

            elif values[1] == "Constant":

   420

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

   421

            elif values[3] == tagname:

   422

                if values[1] == "Output":

   423

                    var_class = OUTPUT

   424

                elif values[1] == "InOut":

   425

                    var_class = INPUT

   426

                else:

   427

                    var_class = INPUT

   428

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

   429

                if tree is not None:

   430

                    if len(tree[0]) > 0:

   431

                        menu = wx.Menu(title='')

   432

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

   433

                        self.ParentWindow.PopupMenuXY(menu)

   434

                    else:

   435

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

   436

                else:

   437

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

   438

            else:

   439

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

   440

        if message is not None:

   441

            wx.CallAfter(self.ShowMessage, message)

   442

   443

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

   444

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

   445

            if base_path:

   446

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

   447

            else:

   448

                child_path = child_name

   449

            if len(child_dimensions) > 0:

   450

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

   451

                child_name += "[]"

   452

            new_id = wx.NewId()

   453

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

   454

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

   455

            if len(child_tree) > 0:

   456

                new_id = wx.NewId()

   457

                child_menu = wx.Menu(title='')

   458

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

   459

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

   460

   461

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

   462

        def AddVariableFunction(event):

   463

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

   464

        return AddVariableFunction

   465

   466

    def ShowMessage(self, message):

   467

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

   468

        message.ShowModal()

   469

        message.Destroy()

   470

   471

   472

class DebugInstanceName(DebugDataConsumer):

   473

    VALUE_TRANSLATION = None

   474

   475

    def __init__(self, parent):

   476

        DebugDataConsumer.__init__(self)

   477

        self.Parent = parent

   478

        self.ActionLastState = None

   479

        self.ActionState = None

   480

        self.x_offset = 2

   481

        self.y_offset = 2

   482

   483

        if self.VALUE_TRANSLATION is None:

   484

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

   485

   486

    def SetValue(self, value):

   487

        self.ActionState = value

   488

        if self.ActionState != self.ActionLastState:

   489

            self.ActionLastState = self.ActionState

   490

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

   491

   492

    def GetInstanceName(self):

   493

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

   494

   495

    def GetRedrawRect(self):

   496

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

   497

        dc = self.Parent.GetLogicalDC()

   498

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

   499

        vw, vh = 0, 0

   500