1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program is distributed in the hope that it will be useful,

    17

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

    26

import math

    27

from time import time as gettime

    28

from threading import Lock

    29

    30

import wx

    31

    32

from plcopen.structures import *

    33

from plcopen.types_enums import ComputePouName

    34

from PLCControler import ITEM_VAR_LOCAL, ITEM_POU, ITEM_PROGRAM, ITEM_FUNCTIONBLOCK

    35

    36

from graphics.GraphicCommons import *

    37

from graphics.FBD_Objects import *

    38

from graphics.LD_Objects import *

    39

from graphics.SFC_Objects import *

    40

from graphics.RubberBand import RubberBand

    41

from graphics.DebugDataConsumer import DebugDataConsumer

    42

    43

from dialogs import *

    44

from editors.DebugViewer import DebugViewer, REFRESH_PERIOD

    45

from editors.EditorPanel import EditorPanel

    46

    47

SCROLLBAR_UNIT = 10

    48

WINDOW_BORDER = 10

    49

SCROLL_ZONE = 10

    50

    51

CURSORS = None

    52

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

    53

    54

    55

def ResetCursors():

    56

    global CURSORS

    57

    if CURSORS is None:

    58

        CURSORS = [wx.NullCursor,

    59

                   wx.Cursor(wx.CURSOR_HAND),

    60

                   wx.Cursor(wx.CURSOR_SIZENWSE),

    61

                   wx.Cursor(wx.CURSOR_SIZENESW),

    62

                   wx.Cursor(wx.CURSOR_SIZEWE),

    63

                   wx.Cursor(wx.CURSOR_SIZENS)]

    64

    65

    66

if wx.Platform == '__WXMSW__':

    67

    faces = {

    68

        'times': 'Times New Roman',

    69

        'mono':  'Courier New',

    70

        'helv':  'Arial',

    71

        'other': 'Comic Sans MS',

    72

        'size':  10,

    73

    }

    74

else:

    75

    faces = {

    76

        'times': 'Times',

    77

        'mono':  'FreeMono',

    78

        'helv':  'Helvetica',

    79

        'other': 'new century schoolbook',

    80

        'size':  10,

    81

    }

    82

    83

if wx.Platform == '__WXMSW__':

    84

    MAX_ZOOMIN = 4

    85

else:

    86

    MAX_ZOOMIN = 7

    87

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

    88

    89

    90

WX_NO_LOGICAL = "gtk3" in wx.PlatformInfo

    91

    92

def GetVariableCreationFunction(variable_type):

    93

    def variableCreationFunction(viewer, id, specific_values):

    94

        return FBD_Variable(viewer,

    95

                            variable_type,

    96

                            specific_values.name,

    97

                            specific_values.value_type,

    98

                            id,

    99

                            specific_values.execution_order)

   100

    return variableCreationFunction

   101

   102

   103

def GetConnectorCreationFunction(connector_type):

   104

    def connectorCreationFunction(viewer, id, specific_values):

   105

        return FBD_Connector(viewer,

   106

                             connector_type,

   107

                             specific_values.name,

   108

                             id)

   109

    return connectorCreationFunction

   110

   111

   112

def commentCreationFunction(viewer, id, specific_values):

   113

    return Comment(viewer, specific_values.content, id)

   114

   115

   116

def GetPowerRailCreationFunction(powerrail_type):

   117

    def powerRailCreationFunction(viewer, id, specific_values):

   118

        return LD_PowerRail(viewer,

   119

                            powerrail_type,

   120

                            id,

   121

                            specific_values.connectors)

   122

    return powerRailCreationFunction

   123

   124

   125

def NEGATED_VALUE(x):

   126

    return x if x is not None else False

   127

   128

   129

def MODIFIER_VALUE(x):

   130

    return x if x is not None else 'none'

   131

   132

   133

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

   134

                 (False, "rising"): CONTACT_RISING,

   135

                 (False, "falling"): CONTACT_FALLING}

   136

   137

   138

def contactCreationFunction(viewer, id, specific_values):

   139

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

   140

                                      MODIFIER_VALUE(specific_values.edge)),

   141

                                     CONTACT_NORMAL)

   142

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

   143

   144

   145

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

   146

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

   147

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

   148

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

   149

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

   150

   151

   152

def coilCreationFunction(viewer, id, specific_values):

   153

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

   154

                                MODIFIER_VALUE(specific_values.edge),

   155

                                MODIFIER_VALUE(specific_values.storage)),

   156

                               COIL_NORMAL)

   157

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

   158

   159

   160

def stepCreationFunction(viewer, id, specific_values):

   161

    step = SFC_Step(viewer,

   162

                    specific_values.name,

   163

                    specific_values.initial,

   164

                    id)

   165

    if specific_values.action is not None:

   166

        step.AddAction()

   167

        connector = step.GetActionConnector()

   168

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

   169

    return step

   170

   171

   172

def transitionCreationFunction(viewer, id, specific_values):

   173

    transition = SFC_Transition(viewer,

   174

                                specific_values.condition_type,

   175

                                specific_values.condition,

   176

                                specific_values.priority,

   177

                                id)

   178

    return transition

   179

   180

   181

divergence_types = [SELECTION_DIVERGENCE,

   182

                    SELECTION_CONVERGENCE, SIMULTANEOUS_DIVERGENCE, SIMULTANEOUS_CONVERGENCE]

   183

   184

   185

def GetDivergenceCreationFunction(divergence_type):

   186

    def divergenceCreationFunction(viewer, id, specific_values):

   187

        return SFC_Divergence(viewer, divergence_type,

   188

                              specific_values.connectors, id)

   189

    return divergenceCreationFunction

   190

   191

   192

def jumpCreationFunction(viewer, id, specific_values):

   193

    return SFC_Jump(viewer, specific_values.target, id)

   194

   195

   196

def actionBlockCreationFunction(viewer, id, specific_values):

   197

    return SFC_ActionBlock(viewer, specific_values.actions, id)

   198

   199

   200

ElementCreationFunctions = {

   201

    "input": GetVariableCreationFunction(INPUT),

   202

    "output": GetVariableCreationFunction(OUTPUT),

   203

    "inout": GetVariableCreationFunction(INOUT),

   204

    "connector": GetConnectorCreationFunction(CONNECTOR),

   205

    "continuation": GetConnectorCreationFunction(CONTINUATION),

   206

    "comment": commentCreationFunction,

   207

    "leftPowerRail": GetPowerRailCreationFunction(LEFTRAIL),

   208

    "rightPowerRail": GetPowerRailCreationFunction(RIGHTRAIL),

   209

    "contact": contactCreationFunction,

   210

    "coil": coilCreationFunction,

   211

    "step": stepCreationFunction,

   212

    "transition": transitionCreationFunction,

   213

    "selectionDivergence": GetDivergenceCreationFunction(SELECTION_DIVERGENCE),

   214

    "selectionConvergence": GetDivergenceCreationFunction(SELECTION_CONVERGENCE),

   215

    "simultaneousDivergence": GetDivergenceCreationFunction(SIMULTANEOUS_DIVERGENCE),

   216

    "simultaneousConvergence": GetDivergenceCreationFunction(SIMULTANEOUS_CONVERGENCE),

   217

    "jump": jumpCreationFunction,

   218

    "actionBlock": actionBlockCreationFunction,

   219

}

   220

   221

   222

def sort_blocks(block_infos1, block_infos2):

   223

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

   224

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

   225

    if y1 == y2:

   226

        return cmp(x1, x2)

   227

    else:

   228

        return cmp(y1, y2)

   229

   230

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

   231

#                       Graphic elements Viewer base class

   232

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

   233

   234

   235

class ViewerDropTarget(wx.TextDropTarget):

   236

   237

    def __init__(self, parent):

   238

        wx.TextDropTarget.__init__(self)

   239

        self.ParentWindow = parent

   240

   241

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

   242

        self.ParentWindow.Select()

   243

        tagname = self.ParentWindow.GetTagName()

   244

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

   245

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

   246

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

   247

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

   248

        scaling = self.ParentWindow.Scaling

   249

        message = None

   250

        try:

   251

            values = eval(data)

   252

        except Exception:

   253

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

   254

            values = None

   255

        if not isinstance(values, tuple):

   256

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

   257

            values = None

   258

        if values is not None:

   259

            if values[1] == "debug":

   260

                pass

   261

            elif values[1] == "program":

   262

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

   263

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

   264

                if pou_name == values[0]:

   265

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

   266

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

   267

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

   268

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

   269

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

   270

                else:

   271

                    blockname = values[2]

   272

                    if len(values) > 3:

   273

                        blockinputs = values[3]

   274

                    else:

   275

                        blockinputs = None

   276

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

   277

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

   278

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

   279

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

   280

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

   281

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

   282

                    else:

   283

                        id = self.ParentWindow.GetNewId()

   284

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

   285

                        width, height = block.GetMinSize()

   286

                        if scaling is not None:

   287

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

   288

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

   289

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

   290

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

   291

                        block.SetPosition(x, y)

   292

                        block.SetSize(width, height)

   293

                        self.ParentWindow.AddBlock(block)

   294

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

   295

                        self.ParentWindow.RefreshBlockModel(block)

   296

                        self.ParentWindow.RefreshBuffer()

   297

                        self.ParentWindow.RefreshScrollBars()

   298

                        self.ParentWindow.RefreshVisibleElements()

   299

                        self.ParentWindow.RefreshVariablePanel()

   300

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   301

                        self.ParentWindow.Refresh(False)

   302

            elif values[1] == "location":

   303

                if pou_type == "program":

   304

                    location = values[0]

   305

                    if not location.startswith("%"):

   306

                        dialog = wx.SingleChoiceDialog(

   307

                            self.ParentWindow.ParentWindow,

   308

                            _("Select a variable class:"),

   309

                            _("Variable class"),

   310

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

   311

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

   312

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

   313

                            selected = dialog.GetSelection()

   314

                        else:

   315

                            selected = None

   316

                        dialog.Destroy()

   317

                        if selected is None:

   318

                            return False

   319

                        if selected == 0:

   320

                            location = "%I" + location

   321

                        elif selected == 1:

   322

                            location = "%Q" + location

   323

                        else:

   324

                            location = "%M" + location

   325

                    var_name = values[3]

   326

                    dlg = wx.TextEntryDialog(

   327

                        self.ParentWindow.ParentWindow,

   328

                        _("Confirm or change variable name"),

   329

                        _('Variable Drop'), var_name)

   330

                    dlg.SetValue(var_name)

   331

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

   332

                    dlg.Destroy()

   333

                    if var_name is None:

   334

                        return False

   335

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

   336

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

   337

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

   338

                        if location[1] == "Q":

   339

                            var_class = OUTPUT

   340

                        else:

   341

                            var_class = INPUT

   342

                        if values[2] is not None:

   343

                            var_type = values[2]

   344

                        else:

   345

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

   346

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

   347

                        self.ParentWindow.RefreshVariablePanel()

   348

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   349

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

   350

                    else:

   351

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

   352

            elif values[1] == "NamedConstant":

   353

                if pou_type == "program":

   354

                    initval = values[0]

   355

                    var_name = values[3]

   356

                    dlg = wx.TextEntryDialog(

   357

                        self.ParentWindow.ParentWindow,

   358

                        _("Confirm or change variable name"),

   359

                        _('Variable Drop'), var_name)

   360

                    dlg.SetValue(var_name)

   361

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

   362

                    dlg.Destroy()

   363

                    if var_name is None:

   364

                        return False

   365

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

   366

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

   367

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

   368

                        var_class = INPUT

   369

                        var_type = values[2]

   370

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

   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] == "Global":

   377

                var_name = values[0]

   378

                dlg = wx.TextEntryDialog(

   379

                    self.ParentWindow.ParentWindow,

   380

                    _("Confirm or change variable name"),

   381

                    _('Variable Drop'), var_name)

   382

                dlg.SetValue(var_name)

   383

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

   384

                dlg.Destroy()

   385

                if var_name is None:

   386

                    return False

   387

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

   388

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

   389

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

   390

                    kwargs = dict(description=values[4]) if len(values)>4 else {}

   391

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

   392

                    self.ParentWindow.RefreshVariablePanel()

   393

                    self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   394

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

   395

                else:

   396

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

   397

            elif values[1] == "Constant":

   398

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

   399

            elif values[3] == tagname:

   400

                if values[1] == "Output":

   401

                    var_class = OUTPUT

   402

                elif values[1] == "InOut":

   403

                    var_class = INPUT

   404

                else:

   405

                    var_class = INPUT

   406

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

   407

                if tree is not None:

   408

                    if len(tree[0]) > 0:

   409

                        menu = wx.Menu(title='')

   410

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

   411

                        self.ParentWindow.PopupMenu(menu)

   412

                    else:

   413

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

   414

                else:

   415

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

   416

            else:

   417

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

   418

        if message is not None:

   419

            wx.CallAfter(self.ShowMessage, message)

   420

            return False

   421

        return True

   422

   423

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

   424

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

   425

            if base_path:

   426

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

   427

            else:

   428

                child_path = child_name

   429

            if len(child_dimensions) > 0:

   430

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

   431

                child_name += "[]"

   432

   433

            item = self.AppendItem(menu,

   434

                child_name,

   435

                self.GetAddVariableBlockFunction(x, y, scaling, var_class, child_path, child_type))

   436

            if len(child_tree) > 0:

   437

                child_menu = wx.Menu(title='')

   438

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

   439

                menu.AppendMenu(wx.ID_ANY, "%s." % child_name, child_menu)

   440

   441

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

   442

        def AddVariableFunction(event):

   443

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

   444

        return AddVariableFunction

   445

   446

    def ShowMessage(self, message):

   447

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

   448

        message.ShowModal()

   449

        message.Destroy()

   450

   451

   452

class DebugInstanceName(DebugDataConsumer):

   453

    VALUE_TRANSLATION = None

   454

   455

    def __init__(self, parent):

   456

        DebugDataConsumer.__init__(self)

   457

        self.Parent = parent

   458

        self.ActionLastState = None

   459

        self.ActionState = None

   460

        self.x_offset = 2

   461

        self.y_offset = 2

   462

   463

        if self.VALUE_TRANSLATION is None:

   464

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

   465

   466

    def SetValue(self, value):

   467

        self.ActionState = value

   468

        if self.ActionState != self.ActionLastState:

   469

            self.ActionLastState = self.ActionState

   470

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

   471

   472

    def GetInstanceName(self):

   473

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

   474

   475

    def GetRedrawRect(self):

   476

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

   477

        dc = self.Parent.GetLogicalDC()

   478

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

   479

        vw, vh = 0, 0

   480

        for value in self.VALUE_TRANSLATION.values():

   481

            w, h = dc.GetTextExtent(" (%s)" % value)

   482

            vw = max(vw, w)

   483

            vh = max(vh, h)

   484

        return wx.Rect(ipw + x, y, vw, vh)

   485

   486

    def Draw(self, dc):

   487

        scalex, scaley = dc.GetUserScale()

   488

        dc.SetUserScale(1, 1)

   489

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

   490

   491

        text = self.GetInstanceName()

   492

        if self.ActionState is not None:

   493

            text += " ("

   494

   495

        dc.DrawText(text, x, y)

   496

        tw, _th = dc.GetTextExtent(text)

   497