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

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

    47

 POUINSTANCEVARIABLESPANEL, LIBRARYTREE, SCALING, PAGETITLES

    48

] = range(10)

    49

    50

    51

def GetVariableTableColnames(location):

    52

    _ = NoTranslate

    53

    if location:

    54

    	return ["#", _("Name"), _("Class"), _("Type"), _("Location"), _("Initial Value"), _("Option"), _("Documentation")]

    55

    return ["#", _("Name"), _("Class"), _("Type"), _("Initial Value"), _("Option"), _("Documentation")]

    56

    57

    58

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

    59

    _ = NoTranslate

    60

    options = [""]

    61

    if constant:

    62

        options.append(_("Constant"))

    63

    if retain:

    64

        options.append(_("Retain"))

    65

    if non_retain:

    66

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

    67

    return options

    68

    69

    70

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

    71

    72

    73

def GetFilterChoiceTransfer():

    74

    _ = NoTranslate

    75

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

    76

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

    77

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

    78

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

    79

    80

    81

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

    82

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

    83

    84

CheckOptionForClass = {"Local": lambda x: x,

    85

                       "Temp": lambda x: "",

    86

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

    87

                       "InOut": lambda x: "",

    88

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

    89

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

    90

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

    91

                      }

    92

    93

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

    94

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

    95

    96

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

    97

#                            Variables Panel Table

    98

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

    99

   100

   101

class VariableTable(CustomTable):

   102

   103

    """

   104

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

   105

    """

   106

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

   107

        # The base class must be initialized *first*

   108

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

   109

        self.old_value = None

   110

   111

    def GetValueByName(self, row, colname):

   112

        if row < self.GetNumberRows():

   113

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

   114

   115

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

   116

        if row < self.GetNumberRows():

   117

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

   118

   119

    def GetValue(self, row, col):

   120

        if row < self.GetNumberRows():

   121

            if col == 0:

   122

                return self.data[row].Number

   123

            colname = self.GetColLabelValue(col, False)

   124

            if colname == "Initial Value":

   125

                colname = "InitialValue"

   126

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

   127

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

   128

                if value[0] == "array":

   129

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

   130

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

   131

                value = str(value)

   132

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

   133

                return _(value)

   134

            return value

   135

   136

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

   137

        if col < len(self.colnames):

   138

            colname = self.GetColLabelValue(col, False)

   139

            if colname == "Name":

   140

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

   141

            elif colname == "Class":

   142

                value = VARIABLE_CLASSES_DICT[value]

   143

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

   144

                if value == "External":

   145

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

   146

            elif colname == "Option":

   147

                value = OPTIONS_DICT[value]

   148

            elif colname == "Initial Value":

   149

                colname = "InitialValue"

   150

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

   151

   152

    def GetOldValue(self):

   153

        return self.old_value

   154

   155

    def _GetRowEdit(self, row):

   156

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

   157

        var_type = self.Parent.GetTagName()

   158

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

   159

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

   160

            row_edit = True

   161

        return row_edit

   162

   163

    def _updateColAttrs(self, grid):

   164

        """

   165

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

   166

        appropriate renderer given the column name.

   167

   168

        Otherwise default to the default renderer.

   169

        """

   170

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

   171

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

   172

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

   173

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

   174

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

   175

                editor = None

   176

                renderer = None

   177

                colname = self.GetColLabelValue(col, False)

   178

                if self.Parent.Debug:

   179

                    grid.SetReadOnly(row, col, True)

   180

                else:

   181

                    if colname == "Option":

   182

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

   183

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

   184

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

   185

                        if len(options) > 1:

   186

                            editor = wx.grid.GridCellChoiceEditor()

   187

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

   188

                        else:

   189

                            grid.SetReadOnly(row, col, True)

   190

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

   191

                        grid.SetReadOnly(row, col, False)

   192

                        if colname == "Name":

   193

                            editor = wx.grid.GridCellTextEditor()

   194

                            renderer = wx.grid.GridCellStringRenderer()

   195

                        elif colname == "Initial Value":

   196

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

   197

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

   198

                                    editor = wx.grid.GridCellChoiceEditor()

   199

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

   200

                                else:

   201

                                    editor = wx.grid.GridCellTextEditor()

   202

                                renderer = wx.grid.GridCellStringRenderer()

   203

                            else:

   204

                                grid.SetReadOnly(row, col, True)

   205

                        elif colname == "Location":

   206

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

   207

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

   208

                                renderer = wx.grid.GridCellStringRenderer()

   209

                            else:

   210

                                grid.SetReadOnly(row, col, True)

   211

                        elif colname == "Class":

   212

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

   213

                                grid.SetReadOnly(row, col, True)

   214

                            else:

   215

                                editor = wx.grid.GridCellChoiceEditor()

   216

                                excluded = []

   217

                                if self.Parent.IsFunctionBlockType(var_type):

   218

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

   219

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

   220

                    elif colname != "Documentation":

   221

                        grid.SetReadOnly(row, col, True)

   222

   223

                grid.SetCellEditor(row, col, editor)

   224

                grid.SetCellRenderer(row, col, renderer)

   225

   226

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

   227

                    highlight_colours = ERROR_HIGHLIGHT

   228

                else:

   229

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

   230

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

   231

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

   232

            self.ResizeRow(grid, row)

   233

   234

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

   235

#                         Variable Panel Drop Target

   236

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

   237

   238

   239

class VariableDropTarget(wx.TextDropTarget):

   240

    '''

   241

    This allows dragging a variable location from somewhere to the Location

   242

    column of a variable row.

   243

   244

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

   245

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

   246

   247

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

   248

    variable to the Location column of the variable panel).

   249

    '''

   250

    def __init__(self, parent):

   251

        wx.TextDropTarget.__init__(self)

   252

        self.ParentWindow = parent

   253

   254

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

   255

        self.ParentWindow.ParentWindow.Select()

   256

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

   257

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

   258

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

   259

        message = None

   260

        element_type = self.ParentWindow.ElementType

   261

        try:

   262

            values = eval(data)

   263

        except:

   264

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

   265

            values = None

   266

        if not isinstance(values, TupleType):

   267

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

   268

            values = None

   269

        if values is not None:

   270

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

   271

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

   272

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

   273

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

   274

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

   275

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

   276

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

   277

                    else:

   278

                        location = values[0]

   279

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

   280

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

   281

   282

                        if values[2] is not None:

   283

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

   284

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

   285

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

   286

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

   287

   288

                        if message is None:

   289

                            if not location.startswith("%"):

   290

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

   291

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

   292

                                elif location[0] not in LOCATIONDATATYPES:

   293

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

   294

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

   295

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

   296

                                              format(a1=location, a2=variable_type)

   297

                                else:

   298

                                    dialog = wx.SingleChoiceDialog(self.ParentWindow.ParentWindow.ParentWindow,

   299

                                          _("Select a variable class:"), _("Variable class"),

   300

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

   301

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

   302

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

   303

                                        selected = dialog.GetSelection()

   304

                                    else:

   305

                                        selected = None

   306

                                    dialog.Destroy()

   307

                                    if selected is None:

   308

                                        return

   309

                                    if selected == 0:

   310

                                        location = "%I" + location

   311

                                    elif selected == 1:

   312

                                        location = "%Q" + location

   313

                                    else:

   314

                                        location = "%M" + location

   315

   316

                            if message is None:

   317

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

   318

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

   319

                                self.ParentWindow.SaveValues()

   320

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

   321

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

   322

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

   323

                    else:

   324

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

   325

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

   326

                        self.ParentWindow.SaveValues()

   327

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

   328

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

   329

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

   330

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

   331

                    var_name = values[3]

   332

                else:

   333

                    var_name = values[0]

   334

                tagname = self.ParentWindow.GetTagName()

   335

                dlg = wx.TextEntryDialog(

   336

                    self.ParentWindow.ParentWindow.ParentWindow,

   337

                    _("Confirm or change variable name"),

   338

                    _('Variable Drop'), var_name)

   339

                dlg.SetValue(var_name)

   340

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

   341

                dlg.Destroy()

   342

                if var_name is None:

   343

                    return

   344

                elif var_name.upper() in [name.upper()

   345

                        for name in self.ParentWindow.Controler.GetProjectPouNames(self.ParentWindow.Debug)]:

   346

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

   347

                elif not var_name.upper() in [name.upper()

   348

                        for name in self.ParentWindow.Controler.

   349

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

   350

                    var_infos = self.ParentWindow.DefaultValue.copy()

   351

                    var_infos.Name = var_name

   352

                    var_infos.Type = values[2]

   353

                    var_infos.Documentation = values[4]

   354

                    if values[1] == "location":

   355

                        location = values[0]

   356

                        if not location.startswith("%"):

   357

                            dialog = wx.SingleChoiceDialog(self.ParentWindow.ParentWindow.ParentWindow,

   358

                                  _("Select a variable class:"), _("Variable class"),

   359

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

   360

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

   361

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

   362

                                selected = dialog.GetSelection()

   363

                            else:

   364

                                selected = None

   365

                            dialog.Destroy()

   366

                            if selected is None:

   367

                                return

   368

                            if selected == 0:

   369

                                location = "%I" + location

   370

                            elif selected == 1:

   371

                                location = "%Q" + location

   372

                            else:

   373

                                location = "%M" + location

   374

                        if element_type == "functionBlock":

   375

                            configs = self.ParentWindow.Controler.GetProjectConfigNames(

   376

                                                                self.ParentWindow.Debug)

   377

                            if len(configs) == 0:

   378

                                return

   379

                            if not var_name.upper() in [name.upper()

   380

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

   381

                                self.ParentWindow.Controler.AddConfigurationGlobalVar(

   382

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

   383

                            var_infos.Class = "External"

   384

                        else:

   385

                            if element_type == "program":

   386

                                var_infos.Class = "Local"

   387

                            else:

   388

                                var_infos.Class = "Global"

   389

                            var_infos.Location = location

   390

                    elif values[1] == "NamedConstant":

   391

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

   392

                            var_infos.Class = "Local"

   393

                            var_infos.InitialValue = values[0]

   394

                        else:

   395

                            return

   396

                    else:

   397

                        var_infos.Class = "External"

   398

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

   399

                    self.ParentWindow.Values.append(var_infos)

   400

                    self.ParentWindow.SaveValues()

   401

                    self.ParentWindow.RefreshValues()

   402

                else:

   403

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

   404

   405

        if message is not None:

   406

            wx.CallAfter(self.ShowMessage, message)

   407

   408

    def ShowMessage(self, message):

   409

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

   410

        message.ShowModal()

   411

        message.Destroy()

   412

   413

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

   414

#                               Variable Panel

   415

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

   416

   417

   418

class VariablePanel(wx.Panel):

   419

   420

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

   421

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

   422

   423

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

   424

        self.MainSizer.AddGrowableCol(0)

   425

        self.MainSizer.AddGrowableRow(1)

   426

   427

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

   428

        controls_sizer.AddGrowableCol(5)

   429

        controls_sizer.AddGrowableRow(0)

   430

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

   431

   432

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

   433

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

   434

   435

        self.ReturnType = wx.ComboBox(self,

   436

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

   437

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

   438

        controls_sizer.AddWindow(self.ReturnType)

   439

   440

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

   441

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

   442

   443

        self.Description = wx.TextCtrl(self,

   444

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

   445

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

   446

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

   447

        controls_sizer.AddWindow(self.Description)

   448

   449

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

   450

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

   451

   452

        self.ClassFilter = wx.ComboBox(self,

   453

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

   454

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

   455

        controls_sizer.AddWindow(self.ClassFilter)

   456

   457

        for name, bitmap, help in [

   458

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

   459

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

   460

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

   461

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

   462

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

   463

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

   464

            button.SetToolTipString(help)

   465

            setattr(self, name, button)

   466

            controls_sizer.AddWindow(button)

   467

   468

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

   469

        self.VariablesGrid.SetDropTarget(VariableDropTarget(self))

   470

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

   471

              self.OnVariablesGridCellChange)

   472

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

   473

              self.OnVariablesGridCellLeftClick)

   474

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

   475

              self.OnVariablesGridEditorShown)

   476

        self.MainSizer.AddWindow(self.VariablesGrid, flag=wx.GROW)

   477

   478

        self.SetSizer(self.MainSizer)

   479

   480

        self.ParentWindow = window

   481

        self.Controler = controler

   482

        self.ElementType = element_type

   483

        self.Debug = debug

   484

   485

        self.RefreshHighlightsTimer = wx.Timer(self, -1)

   486

        self.Bind(wx.EVT_TIMER, self.OnRefreshHighlightsTimer,

   487

              self.RefreshHighlightsTimer)

   488

   489

        self.Filter = "All"

   490

        self.FilterChoices = []

   491

        self.FilterChoiceTransfer = GetFilterChoiceTransfer()

   492