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 re

    26

import math

    27

from time import time as gettime

    28

from types import TupleType

    29

from threading import Lock

    30

    31

import wx

    32

    33

from plcopen.structures import *

    34

from PLCControler import ITEM_VAR_LOCAL, ITEM_POU, ITEM_PROGRAM, ITEM_FUNCTIONBLOCK

    35

from graphics.DebugDataConsumer import DebugDataConsumer

    36

    37

from dialogs import *

    38

from graphics import *

    39

from editors.DebugViewer import DebugViewer, REFRESH_PERIOD

    40

from EditorPanel import EditorPanel

    41

    42

SCROLLBAR_UNIT = 10

    43

WINDOW_BORDER = 10

    44

SCROLL_ZONE = 10

    45

    46

CURSORS = None

    47

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

    48

    49

    50

def ResetCursors():

    51

    global CURSORS

    52

    if CURSORS is None:

    53

        CURSORS = [wx.NullCursor,

    54

                   wx.StockCursor(wx.CURSOR_HAND),

    55

                   wx.StockCursor(wx.CURSOR_SIZENWSE),

    56

                   wx.StockCursor(wx.CURSOR_SIZENESW),

    57

                   wx.StockCursor(wx.CURSOR_SIZEWE),

    58

                   wx.StockCursor(wx.CURSOR_SIZENS)]

    59

    60

    61

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

    62

    if wx.VERSION >= (2, 6, 0):

    63

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

    64

    else:

    65

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

    66

    67

    68

if wx.Platform == '__WXMSW__':

    69

    faces = {

    70

        'times': 'Times New Roman',

    71

        'mono':  'Courier New',

    72

        'helv':  'Arial',

    73

        'other': 'Comic Sans MS',

    74

        'size':  10,

    75

    }

    76

else:

    77

    faces = {

    78

        'times': 'Times',

    79

        'mono':  'Courier',

    80

        'helv':  'Helvetica',

    81

        'other': 'new century schoolbook',

    82

        'size':  12,

    83

    }

    84

    85

if wx.Platform == '__WXMSW__':

    86

    MAX_ZOOMIN = 4

    87

else:

    88

    MAX_ZOOMIN = 7

    89

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

    90

    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

# ID Constants for alignment menu items

   236

[ID_VIEWERALIGNMENTMENUITEMS0, ID_VIEWERALIGNMENTMENUITEMS1,

   237

 ID_VIEWERALIGNMENTMENUITEMS2, ID_VIEWERALIGNMENTMENUITEMS4,

   238

 ID_VIEWERALIGNMENTMENUITEMS5, ID_VIEWERALIGNMENTMENUITEMS6,

   239

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

   240

   241

# ID Constants for contextual menu items

   242

[ID_VIEWERCONTEXTUALMENUITEMS0, ID_VIEWERCONTEXTUALMENUITEMS1,

   243

 ID_VIEWERCONTEXTUALMENUITEMS2, ID_VIEWERCONTEXTUALMENUITEMS3,

   244

 ID_VIEWERCONTEXTUALMENUITEMS5, ID_VIEWERCONTEXTUALMENUITEMS6,

   245

 ID_VIEWERCONTEXTUALMENUITEMS8, ID_VIEWERCONTEXTUALMENUITEMS9,

   246

 ID_VIEWERCONTEXTUALMENUITEMS11, ID_VIEWERCONTEXTUALMENUITEMS12,

   247

 ID_VIEWERCONTEXTUALMENUITEMS14, ID_VIEWERCONTEXTUALMENUITEMS16,

   248

 ID_VIEWERCONTEXTUALMENUITEMS17,

   249

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

   250

   251

   252

class ViewerDropTarget(wx.TextDropTarget):

   253

   254

    def __init__(self, parent):

   255

        wx.TextDropTarget.__init__(self)

   256

        self.ParentWindow = parent

   257

   258

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

   259

        self.ParentWindow.Select()

   260

        tagname = self.ParentWindow.GetTagName()

   261

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

   262

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

   263

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

   264

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

   265

        scaling = self.ParentWindow.Scaling

   266

        message = None

   267

        try:

   268

            values = eval(data)

   269

        except:

   270

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

   271

            values = None

   272

        if not isinstance(values, TupleType):

   273

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

   274

            values = None

   275

        if values is not None:

   276

            if values[1] == "debug":

   277

                pass

   278

            elif values[1] == "program":

   279

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

   280

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

   281

                words = tagname.split("::")

   282

                if pou_name == values[0]:

   283

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

   284

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

   285

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

   286

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

   287

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

   288

                else:

   289

                    blockname = values[2]

   290

                    if len(values) > 3:

   291

                        blockinputs = values[3]

   292

                    else:

   293

                        blockinputs = None

   294

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

   295

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

   296

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

   297

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

   298

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

   299

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

   300

                    else:

   301

                        id = self.ParentWindow.GetNewId()

   302

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

   303

                        width, height = block.GetMinSize()

   304

                        if scaling is not None:

   305

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

   306

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

   307

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

   308

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

   309

                        block.SetPosition(x, y)

   310

                        block.SetSize(width, height)

   311

                        self.ParentWindow.AddBlock(block)

   312

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

   313

                        self.ParentWindow.RefreshBlockModel(block)

   314

                        self.ParentWindow.RefreshBuffer()

   315

                        self.ParentWindow.RefreshScrollBars()

   316

                        self.ParentWindow.RefreshVisibleElements()

   317

                        self.ParentWindow.RefreshVariablePanel()

   318

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   319

                        self.ParentWindow.Refresh(False)

   320

            elif values[1] == "location":

   321

                if pou_type == "program":

   322

                    location = values[0]

   323

                    if not location.startswith("%"):

   330

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

   331

                            selected = dialog.GetSelection()

   332

                        else:

   333

                            selected = None

   334

                        dialog.Destroy()

   335

                        if selected is None:

   336

                            return

   337

                        if selected == 0:

   338

                            location = "%I" + location

   339

                        elif selected == 1:

   340

                            location = "%Q" + location

   341

                        else:

   342

                            location = "%M" + location

   343

                    var_name = values[3]

   344

                    dlg = wx.TextEntryDialog(

   345

                        self.ParentWindow.ParentWindow,

   346

                        _("Confirm or change variable name"),

   347

                        _('Variable Drop'), var_name)

   348

                    dlg.SetValue(var_name)

   349

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

   350

                    dlg.Destroy()

   351

                    if var_name is None:

   352

                        return

   353

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

   354

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

   355

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

   356

                        if location[1] == "Q":

   357

                            var_class = OUTPUT

   358

                        else:

   359

                            var_class = INPUT

   360

                        if values[2] is not None:

   361

                            var_type = values[2]

   362

                        else:

   363

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

   364

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

   365

                        self.ParentWindow.RefreshVariablePanel()

   366

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   367

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

   368

                    else:

   369

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

   370

            elif values[1] == "NamedConstant":

   371

                if pou_type == "program":

   372

                    initval = values[0]

   373

                    var_name = values[3]

   374

                    dlg = wx.TextEntryDialog(

   375

                        self.ParentWindow.ParentWindow,

   376

                        _("Confirm or change variable name"),

   377

                        _('Variable Drop'), var_name)

   378

                    dlg.SetValue(var_name)

   379

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

   380

                    dlg.Destroy()

   381

                    if var_name is None:

   382

                        return

   383

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

   384

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

   385

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

   386

                        var_class = INPUT

   387

                        var_type = values[2]

   388

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

   389

                        self.ParentWindow.RefreshVariablePanel()

   390

                        self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   391

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

   392

                    else:

   393

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

   394

            elif values[1] == "Global":

   395

                var_name = values[0]

   396

                dlg = wx.TextEntryDialog(

   397

                    self.ParentWindow.ParentWindow,

   398

                    _("Confirm or change variable name"),

   399

                    _('Variable Drop'), var_name)

   400

                dlg.SetValue(var_name)

   401

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

   402

                dlg.Destroy()

   403

                if var_name is None:

   404

                    return

   405

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

   406

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

   407

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

   408

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

   409

                    self.ParentWindow.RefreshVariablePanel()

   410

                    self.ParentWindow.ParentWindow.RefreshPouInstanceVariablesPanel()

   411

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

   412

                else:

   413

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

   414

            elif values[1] == "Constant":

   415

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

   416

            elif values[3] == tagname:

   417

                if values[1] == "Output":

   418

                    var_class = OUTPUT

   419

                elif values[1] == "InOut":

   420

                    var_class = INPUT

   421

                else:

   422

                    var_class = INPUT

   423

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

   424

                if tree is not None:

   425

                    if len(tree[0]) > 0:

   426

                        menu = wx.Menu(title='')

   427

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

   428

                        self.ParentWindow.PopupMenuXY(menu)

   429

                    else:

   430

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

   431

                else:

   432

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

   433

            else:

   434

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

   435

        if message is not None:

   436

            wx.CallAfter(self.ShowMessage, message)

   437

   438

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

   439

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

   440

            if base_path:

   441

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

   442

            else:

   443

                child_path = child_name

   444

            if len(child_dimensions) > 0:

   445

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

   446

                child_name += "[]"

   447

            new_id = wx.NewId()

   448

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

   449

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

   450

            if len(child_tree) > 0:

   451

                new_id = wx.NewId()

   452

                child_menu = wx.Menu(title='')

   453

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

   454

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

   455

   456

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

   457

        def AddVariableFunction(event):

   458

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

   459

        return AddVariableFunction

   460

   461

    def ShowMessage(self, message):

   462

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

   463

        message.ShowModal()

   464

        message.Destroy()

   465

   466

   467

class DebugInstanceName(DebugDataConsumer):

   468

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

   469

   470

    def __init__(self, parent):

   471

        DebugDataConsumer.__init__(self)

   472

        self.Parent = parent

   473

        self.ActionLastState = None

   474

        self.ActionState = None

   475

        self.x_offset = 2

   476

        self.y_offset = 2

   477

   478

    def SetValue(self, value):

   479

        self.ActionState = value

   480

        if self.ActionState != self.ActionLastState:

   481

            self.ActionLastState = self.ActionState

   482

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

   483

   484

    def GetInstanceName(self):

   485

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

   486

   487

    def GetRedrawRect(self):

   488

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

   489

        dc = self.Parent.GetLogicalDC()

   490

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

   491

        vw, vh = 0, 0

   492

        for value in self.VALUE_TRANSLATION.itervalues():

   493

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

   494

            vw = max(vw, w)

   495

            vh = max(vh, h)

   496

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

   497

   498

    def Draw(self, dc):

   499

        scalex, scaley = dc.GetUserScale()

   500

        dc.SetUserScale(1, 1)

   501

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

   502