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 os

    26

import re

    27

from types import TupleType, StringType, UnicodeType

    28

    29

import wx

    30

import wx.grid

    31

import wx.lib.buttons

    32

    33

from plcopen.structures import LOCATIONDATATYPES, TestIdentifier, IEC_KEYWORDS, DefaultType

    34

from graphics.GraphicCommons import REFRESH_HIGHLIGHT_PERIOD, ERROR_HIGHLIGHT

    35

from dialogs.ArrayTypeDialog import ArrayTypeDialog

    36

from CustomGrid import CustomGrid

    37

from CustomTable import CustomTable

    38

from LocationCellEditor import LocationCellEditor

    39

from util.BitmapLibrary import GetBitmap

    40

from PLCControler import _VariableInfos

    41

from util.TranslationCatalogs import NoTranslate

    42

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

    43

#                                 Helpers

    44

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

    45

    46

[

    47

    TITLE, EDITORTOOLBAR, FILEMENU, EDITMENU, DISPLAYMENU, PROJECTTREE,

    48

    POUINSTANCEVARIABLESPANEL, LIBRARYTREE, SCALING, PAGETITLES

    49

] = range(10)

    50

    51

    52

def GetVariableTableColnames(location):

    53

    _ = NoTranslate

    54

    cols = ["#",

    55

            _("Name"),

    56

            _("Class"),

    57

            _("Type"),

    58

            _("Location"),

    59

            _("Initial Value"),

    60

            _("Option"),

    61

            _("Documentation")]

    62

    if not location:

    63

        del cols[4]  # remove 'Location' column

    64

    return cols

    65

    66

    67

def GetOptions(constant=True, retain=True, non_retain=True):

    68

    _ = NoTranslate

    69

    options = [""]

    70

    if constant:

    71

        options.append(_("Constant"))

    72

    if retain:

    73

        options.append(_("Retain"))

    74

    if non_retain:

    75

        options.append(_("Non-Retain"))

    76

    return options

    77

    78

    79

OPTIONS_DICT = dict([(_(option), option) for option in GetOptions()])

    80

    81

    82

def GetFilterChoiceTransfer():

    83

    _ = NoTranslate

    84

    return {_("All"): _("All"), _("Interface"): _("Interface"),

    85

            _("   Input"): _("Input"), _("   Output"): _("Output"), _("   InOut"): _("InOut"),

    86

            _("   External"): _("External"), _("Variables"): _("Variables"), _("   Local"): _("Local"),

    87

            _("   Temp"): _("Temp"), _("Global"): _("Global")}  # , _("Access") : _("Access")}

    88

    89

    90

VARIABLE_CHOICES_DICT = dict([(_(_class), _class) for _class in GetFilterChoiceTransfer().iterkeys()])

    91

VARIABLE_CLASSES_DICT = dict([(_(_class), _class) for _class in GetFilterChoiceTransfer().itervalues()])

    92

    93

CheckOptionForClass = {

    94

    "Local": lambda x: x,

    95

    "Temp": lambda x: "",

    96

    "Input": lambda x: {"Retain": "Retain", "Non-Retain": "Non-Retain"}.get(x, ""),

    97

    "InOut": lambda x: "",

    98

    "Output": lambda x: {"Retain": "Retain", "Non-Retain": "Non-Retain"}.get(x, ""),

    99

    "Global": lambda x: {"Constant": "Constant", "Retain": "Retain"}.get(x, ""),

   100

    "External": lambda x: {"Constant": "Constant"}.get(x, "")

   101

}

   102

   103

LOCATION_MODEL = re.compile("((?:%[IQM](?:\*|(?:[XBWLD]?[0-9]+(?:\.[0-9]+)*)))?)$")

   104

VARIABLE_NAME_SUFFIX_MODEL = re.compile("([0-9]*)$")

   105

   106

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

   107

#                            Variables Panel Table

   108

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

   109

   110

   111

class VariableTable(CustomTable):

   112

   113

    """

   114

    A custom wx.grid.Grid Table using user supplied data

   115

    """

   116

    def __init__(self, parent, data, colnames):

   117

        # The base class must be initialized *first*

   118

        CustomTable.__init__(self, parent, data, colnames)

   119

        self.old_value = None

   120

   121

    def GetValueByName(self, row, colname):

   122

        if row < self.GetNumberRows():

   123

            return getattr(self.data[row], colname)

   124

   125

    def SetValueByName(self, row, colname, value):

   126

        if row < self.GetNumberRows():

   127

            setattr(self.data[row], colname, value)

   128

   129

    def GetValue(self, row, col):

   130

        if row < self.GetNumberRows():

   131

            if col == 0:

   132

                return self.data[row].Number

   133

            colname = self.GetColLabelValue(col, False)

   134

            if colname == "Initial Value":

   135

                colname = "InitialValue"

   136

            value = getattr(self.data[row], colname, "")

   137

            if colname == "Type" and isinstance(value, TupleType):

   138

                if value[0] == "array":

   139

                    return "ARRAY [%s] OF %s" % (",".join(map(lambda x: "..".join(x), value[2])), value[1])

   140

            if not isinstance(value, (StringType, UnicodeType)):

   141

                value = str(value)

   142

            if colname in ["Class", "Option"]:

   143

                return _(value)

   144

            return value

   145

   146

    def SetValue(self, row, col, value):

   147

        if col < len(self.colnames):

   148

            colname = self.GetColLabelValue(col, False)

   149

            if colname == "Name":

   150

                self.old_value = getattr(self.data[row], colname)

   151

            elif colname == "Class":

   152

                value = VARIABLE_CLASSES_DICT[value]

   153

                self.SetValueByName(row, "Option", CheckOptionForClass[value](self.GetValueByName(row, "Option")))

   154

                if value == "External":

   155

                    self.SetValueByName(row, "InitialValue", "")

   156

            elif colname == "Option":

   157

                value = OPTIONS_DICT[value]

   158

            elif colname == "Initial Value":

   159

                colname = "InitialValue"

   160

            setattr(self.data[row], colname, value)

   161

   162

    def GetOldValue(self):

   163

        return self.old_value

   164

   165

    def _GetRowEdit(self, row):

   166

        row_edit = self.GetValueByName(row, "Edit")

   167

        var_type = self.Parent.GetTagName()

   168

        bodytype = self.Parent.Controler.GetEditedElementBodyType(var_type)

   169

        if bodytype in ["ST", "IL"]:

   170

            row_edit = True

   171

        return row_edit

   172

   173

    def _updateColAttrs(self, grid):

   174

        """

   175

        wx.grid.Grid -> update the column attributes to add the

   176

        appropriate renderer given the column name.

   177

   178

        Otherwise default to the default renderer.

   179

        """

   180

        for row in range(self.GetNumberRows()):

   181

            var_class = self.GetValueByName(row, "Class")

   182

            var_type = self.GetValueByName(row, "Type")

   183

            row_highlights = self.Highlights.get(row, {})

   184

            for col in range(self.GetNumberCols()):

   185

                editor = None

   186

                renderer = None

   187

                colname = self.GetColLabelValue(col, False)

   188

                if self.Parent.Debug:

   189

                    grid.SetReadOnly(row, col, True)

   190

                else:

   191

                    if colname == "Option":

   192

                        options = GetOptions(constant=var_class in ["Local", "External", "Global"],

   193

                                             retain=self.Parent.ElementType != "function" and var_class in ["Local", "Input", "Output", "Global"],

   194

                                             non_retain=self.Parent.ElementType != "function" and var_class in ["Local", "Input", "Output"])

   195

                        if len(options) > 1:

   196

                            editor = wx.grid.GridCellChoiceEditor()

   197

                            editor.SetParameters(",".join(map(_, options)))

   198

                        else:

   199

                            grid.SetReadOnly(row, col, True)

   200

                    elif col != 0 and self._GetRowEdit(row):

   201

                        grid.SetReadOnly(row, col, False)

   202

                        if colname == "Name":

   203

                            editor = wx.grid.GridCellTextEditor()

   204

                            renderer = wx.grid.GridCellStringRenderer()

   205

                        elif colname == "Initial Value":

   206

                            if var_class not in ["External", "InOut"]:

   207

                                if self.Parent.Controler.IsEnumeratedType(var_type):

   208

                                    editor = wx.grid.GridCellChoiceEditor()

   209

                                    editor.SetParameters(",".join([""] + self.Parent.Controler.GetEnumeratedDataValues(var_type)))

   210

                                else:

   211

                                    editor = wx.grid.GridCellTextEditor()

   212

                                renderer = wx.grid.GridCellStringRenderer()

   213

                            else:

   214

                                grid.SetReadOnly(row, col, True)

   215

                        elif colname == "Location":

   216

                            if var_class in ["Local", "Global"] and self.Parent.Controler.IsLocatableType(var_type):

   217

                                editor = LocationCellEditor(self, self.Parent.Controler)

   218

                                renderer = wx.grid.GridCellStringRenderer()

   219

                            else:

   220

                                grid.SetReadOnly(row, col, True)

   221

                        elif colname == "Class":

   222

                            if len(self.Parent.ClassList) == 1:

   223

                                grid.SetReadOnly(row, col, True)

   224

                            else:

   225

                                editor = wx.grid.GridCellChoiceEditor()

   226

                                excluded = []

   227

                                if self.Parent.IsFunctionBlockType(var_type):

   228

                                    excluded.extend(["Local", "Temp"])

   229

                                editor.SetParameters(",".join([_(choice) for choice in self.Parent.ClassList if choice not in excluded]))

   230

                    elif colname != "Documentation":

   231

                        grid.SetReadOnly(row, col, True)

   232

   233

                grid.SetCellEditor(row, col, editor)

   234

                grid.SetCellRenderer(row, col, renderer)

   235

   236

                if colname == "Location" and LOCATION_MODEL.match(self.GetValueByName(row, colname)) is None:

   237

                    highlight_colours = ERROR_HIGHLIGHT

   238

                else:

   239

                    highlight_colours = row_highlights.get(colname.lower(), [(wx.WHITE, wx.BLACK)])[-1]

   240

                grid.SetCellBackgroundColour(row, col, highlight_colours[0])

   241

                grid.SetCellTextColour(row, col, highlight_colours[1])

   242

            self.ResizeRow(grid, row)

   243

   244

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

   245

#                         Variable Panel Drop Target

   246

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

   247

   248

   249

class VariableDropTarget(wx.TextDropTarget):

   250

    '''

   251

    This allows dragging a variable location from somewhere to the Location

   252

    column of a variable row.

   253

   254

    The drag source should be a TextDataObject containing a Python tuple like:

   255

        ('%ID0.0.0', 'location', 'REAL')

   256

   257

    c_ext/CFileEditor.py has an example of this (you can drag a C extension

   258

    variable to the Location column of the variable panel).

   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.ParentWindow.Select()

   266

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

   267

        col = self.ParentWindow.VariablesGrid.XToCol(x)

   268

        row = self.ParentWindow.VariablesGrid.YToRow(y)

   269

        message = None

   270

        element_type = self.ParentWindow.ElementType

   271

        try:

   272

            values = eval(data)

   273

        except Exception:

   274

            message = _("Invalid value \"%s\" for variable grid element") % data

   275

            values = None

   276

        if not isinstance(values, TupleType):

   277

            message = _("Invalid value \"%s\" for variable grid element") % data

   278

            values = None

   279

        if values is not None:

   280

            if col != wx.NOT_FOUND and row != wx.NOT_FOUND:

   281

                colname = self.ParentWindow.Table.GetColLabelValue(col, False)

   282

                if colname == "Location" and values[1] == "location":

   283

                    if not self.ParentWindow.Table.GetValueByName(row, "Edit"):

   284

                        message = _("Can't give a location to a function block instance")

   285

                    elif self.ParentWindow.Table.GetValueByName(row, "Class") not in ["Local", "Global"]:

   286

                        message = _("Can only give a location to local or global variables")

   287

                    else:

   288

                        location = values[0]

   289

                        variable_type = self.ParentWindow.Table.GetValueByName(row, "Type")

   290

                        base_type = self.ParentWindow.Controler.GetBaseType(variable_type)

   291

   292

                        if values[2] is not None:

   293

                            base_location_type = self.ParentWindow.Controler.GetBaseType(values[2])

   294

                            if values[2] != variable_type and base_type != base_location_type:

   295

                                message = _("Incompatible data types between \"{a1}\" and \"{a2}\"").\

   296

                                          format(a1=values[2], a2=variable_type)

   297

   298

                        if message is None:

   299

                            if not location.startswith("%"):

   300

                                if location[0].isdigit() and base_type != "BOOL":

   301

                                    message = _("Incompatible size of data between \"%s\" and \"BOOL\"") % location

   302

                                elif location[0] not in LOCATIONDATATYPES:

   303

                                    message = _("Unrecognized data size \"%s\"") % location[0]

   304

                                elif base_type not in LOCATIONDATATYPES[location[0]]:

   305

                                    message = _("Incompatible size of data between \"{a1}\" and \"{a2}\"").\

   306

                                              format(a1=location, a2=variable_type)

   307

                                else:

   308

                                    dialog = wx.SingleChoiceDialog(

   309

                                        self.ParentWindow.ParentWindow.ParentWindow,

   310

                                        _("Select a variable class:"),

   311

                                        _("Variable class"),

   312

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

   313

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

   314

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

   315

                                        selected = dialog.GetSelection()

   316

                                    else:

   317

                                        selected = None

   318

                                    dialog.Destroy()

   319

                                    if selected is None:

   320

                                        return

   321

                                    if selected == 0:

   322

                                        location = "%I" + location

   323

                                    elif selected == 1:

   324

                                        location = "%Q" + location

   325

                                    else:

   326

                                        location = "%M" + location

   327

   328

                            if message is None:

   329

                                self.ParentWindow.Table.SetValue(row, col, location)

   330

                                self.ParentWindow.Table.ResetView(self.ParentWindow.VariablesGrid)

   331

                                self.ParentWindow.SaveValues()

   332

                elif colname == "Initial Value" and values[1] == "Constant":

   333

                    if not self.ParentWindow.Table.GetValueByName(row, "Edit"):

   334

                        message = _("Can't set an initial value to a function block instance")

   335

                    else:

   336

                        self.ParentWindow.Table.SetValue(row, col, values[0])

   337

                        self.ParentWindow.Table.ResetView(self.ParentWindow.VariablesGrid)

   338

                        self.ParentWindow.SaveValues()

   339

            elif (element_type not in ["config", "resource", "function"] and values[1] == "Global" and

   340

                  self.ParentWindow.Filter in ["All", "Interface", "External"] or

   341

                  element_type != "function" and values[1] in ["location", "NamedConstant"]):

   342

                if values[1] in ["location", "NamedConstant"]:

   343

                    var_name = values[3]

   344

                else:

   345

                    var_name = values[0]

   346

                tagname = self.ParentWindow.GetTagName()

   347

                dlg = wx.TextEntryDialog(

   348

                    self.ParentWindow.ParentWindow.ParentWindow,

   349

                    _("Confirm or change variable name"),

   350

                    _('Variable Drop'), var_name)

   351

                dlg.SetValue(var_name)

   352

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

   353

                dlg.Destroy()

   354

                if var_name is None:

   355

                    return

   356

                elif var_name.upper() in [

   357

                        name.upper() for name in

   358

                        self.ParentWindow.Controler.GetProjectPouNames(self.ParentWindow.Debug)]:

   359

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

   360

                elif not var_name.upper() in [

   361

                        name.upper()

   362

                        for name in self.ParentWindow.Controler.

   363

                        GetEditedElementVariables(tagname, self.ParentWindow.Debug)]:

   364

                    var_infos = self.ParentWindow.DefaultValue.copy()

   365

                    var_infos.Name = var_name

   366

                    var_infos.Type = values[2]

   367

                    var_infos.Documentation = values[4]

   368

                    if values[1] == "location":

   369

                        location = values[0]

   370

                        if not location.startswith("%"):

   371

                            dialog = wx.SingleChoiceDialog(

   372

                                self.ParentWindow.ParentWindow.ParentWindow,

   373

                                _("Select a variable class:"),

   374

                                _("Variable class"),

   375

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

   376

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

   377

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

   378

                                selected = dialog.GetSelection()

   379

                            else:

   380

                                selected = None

   381

                            dialog.Destroy()

   382

                            if selected is None:

   383

                                return

   384

                            if selected == 0:

   385

                                location = "%I" + location

   386

                            elif selected == 1:

   387

                                location = "%Q" + location

   388

                            else:

   389

                                location = "%M" + location

   390

                        if element_type == "functionBlock":

   391

                            configs = self.ParentWindow.Controler.GetProjectConfigNames(

   392

                                                                self.ParentWindow.Debug)

   393

                            if len(configs) == 0:

   394

                                return

   395

                            if not var_name.upper() in [

   396

                                    name.upper() for name in

   397

                                    self.ParentWindow.Controler.GetConfigurationVariableNames(configs[0])]:

   398

                                self.ParentWindow.Controler.AddConfigurationGlobalVar(

   399

                                    configs[0], values[2], var_name, location, "")

   400

                            var_infos.Class = "External"

   401

                        else:

   402

                            if element_type == "program":

   403

                                var_infos.Class = "Local"

   404

                            else:

   405

                                var_infos.Class = "Global"

   406

                            var_infos.Location = location

   407

                    elif values[1] == "NamedConstant":

   408

                        if element_type in ["functionBlock", "program"]:

   409

                            var_infos.Class = "Local"

   410

                            var_infos.InitialValue = values[0]

   411

                        else:

   412

                            return

   413

                    else:

   414

                        var_infos.Class = "External"

   415

                    var_infos.Number = len(self.ParentWindow.Values)

   416

                    self.ParentWindow.Values.append(var_infos)

   417

                    self.ParentWindow.SaveValues()

   418

                    self.ParentWindow.RefreshValues()

   419

                else:

   420

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

   421

   422

        if message is not None:

   423

            wx.CallAfter(self.ShowMessage, message)

   424

   425

    def ShowMessage(self, message):

   426

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

   427

        message.ShowModal()

   428

        message.Destroy()

   429

   430

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

   431

#                               Variable Panel

   432

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

   433

   434

   435

class VariablePanel(wx.Panel):

   436

   437

    def __init__(self, parent, window, controler, element_type, debug=False):

   438

        wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL)

   439

   440

        self.MainSizer = wx.FlexGridSizer(cols=1, hgap=10, rows=2, vgap=0)

   441

        self.MainSizer.AddGrowableCol(0)

   442

        self.MainSizer.AddGrowableRow(1)

   443

   444

        controls_sizer = wx.FlexGridSizer(cols=10, hgap=5, rows=1, vgap=5)

   445

        controls_sizer.AddGrowableCol(5)

   446

        controls_sizer.AddGrowableRow(0)

   447

        self.MainSizer.AddSizer(controls_sizer, border=5, flag=wx.GROW | wx.ALL)

   448

   449

        self.ReturnTypeLabel = wx.StaticText(self, label=_('Return Type:'))

   450

        controls_sizer.AddWindow(self.ReturnTypeLabel, flag=wx.ALIGN_CENTER_VERTICAL)

   451

   452

        self.ReturnType = wx.ComboBox(self,

   453

                                      size=wx.Size(145, -1), style=wx.CB_READONLY)

   454

        self.Bind(wx.EVT_COMBOBOX, self.OnReturnTypeChanged, self.ReturnType)

   455

        controls_sizer.AddWindow(self.ReturnType)

   456

   457

        self.DescriptionLabel = wx.StaticText(self, label=_('Description:'))

   458

        controls_sizer.AddWindow(self.DescriptionLabel, flag=wx.ALIGN_CENTER_VERTICAL)

   459

   460

        self.Description = wx.TextCtrl(self,

   461

                                       size=wx.Size(250, -1), style=wx.TE_PROCESS_ENTER)

   462

        self.Bind(wx.EVT_TEXT_ENTER, self.OnDescriptionChanged, self.Description)

   463

        self.Description.Bind(wx.EVT_KILL_FOCUS, self.OnDescriptionChanged)

   464

        controls_sizer.AddWindow(self.Description)

   465

   466

        class_filter_label = wx.StaticText(self, label=_('Class Filter:'))

   467

        controls_sizer.AddWindow(class_filter_label, flag=wx.ALIGN_CENTER_VERTICAL)

   468

   469

        self.ClassFilter = wx.ComboBox(self,

   470

                                       size=wx.Size(145, -1), style=wx.CB_READONLY)

   471

        self.Bind(wx.EVT_COMBOBOX, self.OnClassFilter, self.ClassFilter)

   472

        controls_sizer.AddWindow(self.ClassFilter)

   473

   474

        for name, bitmap, help in [

   475

                ("AddButton", "add_element", _("Add variable")),

   476

                ("DeleteButton", "remove_element", _("Remove variable")),

   477

                ("UpButton", "up", _("Move variable up")),

   478

                ("DownButton", "down", _("Move variable down"))]:

   479

            button = wx.lib.buttons.GenBitmapButton(self, bitmap=GetBitmap(bitmap),

   480

                                                    size=wx.Size(28, 28), style=wx.NO_BORDER)

   481

            button.SetToolTipString(help)

   482

            setattr(self, name, button)

   483

            controls_sizer.AddWindow(button)

   484

   485

        self.VariablesGrid = CustomGrid(self, style=wx.VSCROLL | wx.HSCROLL)

   486

        self.VariablesGrid.SetDropTarget(VariableDropTarget(self))

   487

        self.VariablesGrid.Bind(wx.grid.EVT_GRID_CELL_CHANGE,

   488

                                self.OnVariablesGridCellChange)

   489

        self.VariablesGrid.Bind(wx.grid.EVT_GRID_CELL_LEFT_CLICK,

   490

                                self.OnVariablesGridCellLeftClick)

   491

        self.VariablesGrid.Bind(wx.grid.EVT_GRID_EDITOR_SHOWN,