1

#!/usr/bin/env python

     2

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

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     6

#

     7

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

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

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

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import re

    26

from types import TupleType

    27

    28

import wx

    29

import wx.grid

    30

import wx.lib.buttons

    31

    33

from graphics.GraphicCommons import REFRESH_HIGHLIGHT_PERIOD

    34

from controls import CustomEditableListBox, CustomGrid, CustomTable

    35

from dialogs import ArrayTypeDialog

    36

from EditorPanel import EditorPanel

    37

from util.BitmapLibrary import GetBitmap

    38

    39

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

    40

#                                    Helpers

    41

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

    42

    43

DIMENSION_MODEL = re.compile("([0-9]+)\.\.([0-9]+)$")

    44

    45

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

    46

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

    47

    48

def GetElementsTableColnames():

    49

    _ = lambda x : x

    50

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

    51

    52

def GetDatatypeTypes():

    53

    _ = lambda x : x

    54

    return [_("Directly"), _("Subrange"), _("Enumerated"), _("Array"), _("Structure")]

    55

DATATYPE_TYPES_DICT = dict([(_(datatype), datatype) for datatype in GetDatatypeTypes()])

    56

    57

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

    58

#                            Structure Elements Table

    59

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

    60

    61

class ElementsTable(CustomTable):

    63

    """

    64

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

    65

    """

    66

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

    67

        # The base class must be initialized *first*

    68

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

    69

        self.old_value = None

    71

    def GetValue(self, row, col):

    72

        if row < self.GetNumberRows():

    73

            if col == 0:

    74

                return row + 1

    75

            colname = self.GetColLabelValue(col, False)

    76

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

    77

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

    78

                if value[0] == "array":

    79

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

    80

            return str(value)

    82

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

    83

        if col < len(self.colnames):

    84

            colname = self.GetColLabelValue(col, False)

    85

            if colname == "Name":

    86

                self.old_value = self.data[row][colname]

    87

            self.data[row][colname] = value

    89

    def GetOldValue(self):

    90

        return self.old_value

    92

    def _updateColAttrs(self, grid):

    93

        """

    94

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

    95

        appropriate renderer given the column name.

    96

    97

        Otherwise default to the default renderer.

    98

        """

   100

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

   101

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

   102

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

   103

                editor = None

   104

                renderer = None

   105

                colname = self.GetColLabelValue(col, False)

   106

                if col != 0:

   107

                    grid.SetReadOnly(row, col, False)

   108

                    if colname == "Name":

   109

                        editor = wx.grid.GridCellTextEditor()

   110

                        renderer = wx.grid.GridCellStringRenderer()

   111

                    elif colname == "Initial Value":

   112

                        editor = wx.grid.GridCellTextEditor()

   113

                        renderer = wx.grid.GridCellStringRenderer()

   114

                    elif colname == "Type":

   115

                        editor = wx.grid.GridCellTextEditor()

   116

                else:

   117

                    grid.SetReadOnly(row, col, True)

   119

                grid.SetCellEditor(row, col, editor)

   120

                grid.SetCellRenderer(row, col, renderer)

   122

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

   123

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

   124

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

   125

            self.ResizeRow(grid, row)

   127

    def AddHighlight(self, infos, highlight_type):

   128

        row_highlights = self.Highlights.setdefault(infos[0], {})

   129

        if infos[1] == "initial":

   130

            col_highlights = row_highlights.setdefault("initial value", [])

   131

        else:

   132

            col_highlights = row_highlights.setdefault(infos[1], [])

   133

        col_highlights.append(highlight_type)

   134

   135

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

   136

#                          Datatype Editor class

   137

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

   138

   139

class DataTypeEditor(EditorPanel):

   141

    def _init_Editor(self, parent):

   142

        self.Editor = wx.Panel(parent, style=wx.SUNKEN_BORDER)

   144

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

   145

        self.MainSizer.AddGrowableCol(0)

   146

        self.MainSizer.AddGrowableRow(1)

   148

        top_sizer = wx.BoxSizer(wx.HORIZONTAL)

   150

              flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)

   152

        derivation_type_label = wx.StaticText(self.Editor, label=_('Derivation Type:'))

   154

              flag=wx.ALIGN_CENTER_VERTICAL|wx.LEFT|wx.RIGHT)

   156

        self.DerivationType = wx.ComboBox(self.Editor,

   157

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

   158

        self.Bind(wx.EVT_COMBOBOX, self.OnDerivationTypeChanged, self.DerivationType)

   159

        top_sizer.AddWindow(self.DerivationType, border=5, flag=wx.GROW|wx.RIGHT)

   161

        typeinfos_staticbox = wx.StaticBox(self.Editor, label=_('Type infos:'))

   162

        typeinfos_sizer = wx.StaticBoxSizer(typeinfos_staticbox, wx.HORIZONTAL)

   164

              flag=wx.GROW|wx.BOTTOM|wx.LEFT|wx.RIGHT)

   166

        # Panel for Directly derived data types

   167

   168

        self.DirectlyPanel = wx.Panel(self.Editor, style=wx.TAB_TRAVERSAL)

   169

        typeinfos_sizer.AddWindow(self.DirectlyPanel, 1)

   171

        directly_panel_sizer = wx.BoxSizer(wx.HORIZONTAL)

   174

              label=_('Base Type:'))

   176

              flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   178

        self.DirectlyBaseType = wx.ComboBox(self.DirectlyPanel, style=wx.CB_READONLY)

   179

        self.Bind(wx.EVT_COMBOBOX, self.OnInfosChanged, self.DirectlyBaseType)

   181

              flag=wx.GROW|wx.ALL)

   183

        directly_initialvalue_label = wx.StaticText(self.DirectlyPanel,

   184

              label=_('Initial Value:'))

   186

              flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   189

              style=wx.TE_PROCESS_ENTER|wx.TE_RICH)

   190

        self.Bind(wx.EVT_TEXT_ENTER, self.OnReturnKeyPressed, self.DirectlyInitialValue)

   192

              flag=wx.ALL)

   194

        self.DirectlyPanel.SetSizer(directly_panel_sizer)

   196

        # Panel for Subrange data types

   197

   198

        self.SubrangePanel = wx.Panel(self.Editor, style=wx.TAB_TRAVERSAL)

   199

        typeinfos_sizer.AddWindow(self.SubrangePanel, 1)

   201

        subrange_panel_sizer = wx.GridSizer(cols=4, hgap=5, rows=3, vgap=0)

   203

        subrange_basetype_label = wx.StaticText(self.SubrangePanel,

   204

              label=_('Base Type:'))

   206

              flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   208

        self.SubrangeBaseType = wx.ComboBox(self.SubrangePanel, style=wx.CB_READONLY)

   210

              self.SubrangeBaseType)

   212

              flag=wx.GROW|wx.ALL)

   214

        subrange_initialvalue_label = wx.StaticText(self.SubrangePanel,

   215

              label=_('Initial Value:'))

   217

              flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   220

              style=wx.TAB_TRAVERSAL)

   221

        self.Bind(wx.EVT_SPINCTRL, self.OnInfosChanged, self.SubrangeInitialValue)

   223

              flag=wx.GROW|wx.ALL)

   225

        subrange_minimum_label = wx.StaticText(self.SubrangePanel, label=_('Minimum:'))

   227

              flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   229

        self.SubrangeMinimum = wx.SpinCtrl(self.SubrangePanel, style=wx.TAB_TRAVERSAL)

   230

        self.Bind(wx.EVT_SPINCTRL, self.OnSubrangeMinimumChanged, self.SubrangeMinimum)

   232

              flag=wx.GROW|wx.ALL)

   234

        for i in xrange(2):

   235

            subrange_panel_sizer.AddWindow(wx.Size(0, 0), 1)

   237

        subrange_maximum_label = wx.StaticText(self.SubrangePanel,

   238

              label=_('Maximum:'))

   240

              flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   242

        self.SubrangeMaximum = wx.SpinCtrl(self.SubrangePanel, style=wx.TAB_TRAVERSAL)

   243

        self.Bind(wx.EVT_SPINCTRL, self.OnSubrangeMaximumChanged, self.SubrangeMaximum)

   246

              flag=wx.GROW|wx.ALL)

   248

        self.SubrangePanel.SetSizer(subrange_panel_sizer)

   250

        # Panel for Enumerated data types

   252

        self.EnumeratedPanel = wx.Panel(self.Editor, style=wx.TAB_TRAVERSAL)

   253

        typeinfos_sizer.AddWindow(self.EnumeratedPanel, 1)

   255

        enumerated_panel_sizer = wx.BoxSizer(wx.HORIZONTAL)

   260

                                        wx.gizmos.EL_ALLOW_DELETE)

   261

        setattr(self.EnumeratedValues, "_OnLabelEndEdit", self.OnEnumeratedValueEndEdit)

   262

        for func in ["_OnAddButton", "_OnDelButton", "_OnUpButton", "_OnDownButton"]:

   263

            setattr(self.EnumeratedValues, func, self.OnEnumeratedValuesChanged)

   265

              flag=wx.GROW|wx.ALL)

   267

        enumerated_panel_rightsizer = wx.BoxSizer(wx.HORIZONTAL)

   268

        enumerated_panel_sizer.AddSizer(enumerated_panel_rightsizer, 1)

   270

        enumerated_initialvalue_label = wx.StaticText(self.EnumeratedPanel,

   271

              label=_('Initial Value:'))

   273

              border=5, flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   276

              style=wx.CB_READONLY)

   277

        self.Bind(wx.EVT_COMBOBOX, self.OnInfosChanged, self.EnumeratedInitialValue)

   279

              border=5, flag=wx.ALL)

   281

        self.EnumeratedPanel.SetSizer(enumerated_panel_sizer)

   283

        # Panel for Array data types

   284

   285

        self.ArrayPanel = wx.Panel(self.Editor, style=wx.TAB_TRAVERSAL)

   286

        typeinfos_sizer.AddWindow(self.ArrayPanel, 1)

   288

        array_panel_sizer = wx.FlexGridSizer(cols=2, hgap=5, rows=2, vgap=0)

   289

        array_panel_sizer.AddGrowableCol(0)

   290

        array_panel_sizer.AddGrowableCol(1)

   291

        array_panel_sizer.AddGrowableRow(1)

   293

        array_panel_leftSizer = wx.BoxSizer(wx.HORIZONTAL)

   294

        array_panel_sizer.AddSizer(array_panel_leftSizer, flag=wx.GROW)

   296

        array_basetype_label = wx.StaticText(self.ArrayPanel, label=_('Base Type:'))

   298

              flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   300

        self.ArrayBaseType = wx.ComboBox(self.ArrayPanel, style=wx.CB_READONLY)

   301

        self.Bind(wx.EVT_COMBOBOX, self.OnInfosChanged, self.ArrayBaseType)

   303

              flag=wx.GROW|wx.ALL)

   305

        array_panel_rightsizer = wx.BoxSizer(wx.HORIZONTAL)

   306

        array_panel_sizer.AddSizer(array_panel_rightsizer, flag=wx.GROW)

   308

        array_initialvalue_label = wx.StaticText(self.ArrayPanel,

   309

              label=_('Initial Value:'))

   311

              flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL)

   313

        self.ArrayInitialValue = wx.TextCtrl(self.ArrayPanel,

   314

              style=wx.TE_PROCESS_ENTER|wx.TE_RICH)

   315

        self.Bind(wx.EVT_TEXT_ENTER, self.OnReturnKeyPressed, self.ArrayInitialValue)

   320

              label=_("Dimensions:"), style=wx.gizmos.EL_ALLOW_NEW|

   321

                                            wx.gizmos.EL_ALLOW_EDIT|

   322

                                            wx.gizmos.EL_ALLOW_DELETE)

   324

                     "_OnUpButton", "_OnDownButton"]:

   325

            setattr(self.ArrayDimensions, func, self.OnDimensionsChanged)

   327

              flag=wx.GROW|wx.ALL)

   329

        self.ArrayPanel.SetSizer(array_panel_sizer)

   331

        # Panel for Structure data types

   333

        self.StructurePanel = wx.Panel(self.Editor, style=wx.TAB_TRAVERSAL)

   334

        typeinfos_sizer.AddWindow(self.StructurePanel, 1)

   336

        structure_panel_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)

   337

        structure_panel_sizer.AddGrowableCol(0)

   338

        structure_panel_sizer.AddGrowableRow(1)

   340

        structure_button_sizer = wx.FlexGridSizer(cols=5, hgap=5, rows=1, vgap=0)

   341

        structure_button_sizer.AddGrowableCol(0)

   342

        structure_button_sizer.AddGrowableRow(0)

   344

              flag=wx.ALL|wx.GROW)

   346

        structure_elements_label = wx.StaticText(self.StructurePanel,

   347

              label=_('Elements :'))

   348

        structure_button_sizer.AddWindow(structure_elements_label, flag=wx.ALIGN_BOTTOM)

   350

        for name, bitmap, help in [

   351

                ("StructureAddButton", "add_element", _("Add element")),

   352

                ("StructureDeleteButton", "remove_element", _("Remove element")),

   353

                ("StructureUpButton", "up", _("Move element up")),

   354

                ("StructureDownButton", "down", _("Move element down"))]:

   355

            button = wx.lib.buttons.GenBitmapButton(self.StructurePanel,

   356

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

   357

            button.SetToolTipString(help)

   358

            setattr(self, name, button)

   359

            structure_button_sizer.AddWindow(button)

   362

              size=wx.Size(0, 150), style=wx.VSCROLL)

   364

              self.OnStructureElementsGridCellChange)

   366

              self.OnStructureElementsGridEditorShown)

   367

        structure_panel_sizer.AddWindow(self.StructureElementsGrid, flag=wx.GROW)

   369

        self.StructurePanel.SetSizer(structure_panel_sizer)

   371

        self.Editor.SetSizer(self.MainSizer)

   373

    def __init__(self, parent, tagname, window, controler):

   374

        EditorPanel.__init__(self, parent, tagname, window, controler)

   377

        self.StructureElementsTable = ElementsTable(self, [], GetElementsTableColnames())

   378

        self.StructureColSizes = [40, 150, 100, 250]

   379

        self.StructureColAlignements = [wx.ALIGN_CENTER, wx.ALIGN_LEFT, wx.ALIGN_LEFT, wx.ALIGN_LEFT]

   381

        self.StructureElementsGrid.SetTable(self.StructureElementsTable)

   382

        self.StructureElementsGrid.SetButtons({"Add": self.StructureAddButton,

   383

                                               "Delete": self.StructureDeleteButton,

   384

                                               "Up": self.StructureUpButton,

   385

                                               "Down": self.StructureDownButton})

   387

        def _AddStructureElement(new_row):

   388

            self.StructureElementsTable.InsertRow(new_row, self.StructureElementDefaultValue.copy())

   389

            self.RefreshTypeInfos()

   390

            self.StructureElementsTable.ResetView(self.StructureElementsGrid)

   391

            return new_row

   392

        setattr(self.StructureElementsGrid, "_AddRow", _AddStructureElement)

   394

        def _DeleteStructureElement(row):

   395

            self.StructureElementsTable.RemoveRow(row)

   396

            self.RefreshTypeInfos()

   397

            self.StructureElementsTable.ResetView(self.StructureElementsGrid)

   398

        setattr(self.StructureElementsGrid, "_DeleteRow", _DeleteStructureElement)

   400

        def _MoveStructureElement(row, move):

   401

            new_row = self.StructureElementsTable.MoveRow(row, move)

   402

            if new_row != row:

   403

                self.RefreshTypeInfos()

   404

                self.StructureElementsTable.ResetView(self.StructureElementsGrid)

   405

            return new_row

   406

        setattr(self.StructureElementsGrid, "_MoveRow", _MoveStructureElement)

   408

        self.StructureElementsGrid.SetRowLabelSize(0)

   409

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

   410

            attr = wx.grid.GridCellAttr()

   411

            attr.SetAlignment(self.StructureColAlignements[col], wx.ALIGN_CENTRE)

   412

            self.StructureElementsGrid.SetColAttr(col, attr)

   413

            self.StructureElementsGrid.SetColMinimalWidth(col, self.StructureColSizes[col])

   414

            self.StructureElementsGrid.AutoSizeColumn(col, False)

   415

        self.StructureElementsGrid.RefreshButtons()

   417

        for datatype in GetDatatypeTypes():

   418

            self.DerivationType.Append(_(datatype))

   419

        self.SubrangePanel.Hide()

   420

        self.EnumeratedPanel.Hide()

   421

        self.ArrayPanel.Hide()

   422

        self.StructurePanel.Hide()

   423

        self.CurrentPanel = "Directly"

   424

        self.Highlights = []

   425

        self.Initializing = False

   427

        self.HighlightControls = {

   428

            ("Directly", "base"): self.DirectlyBaseType,

   429

            ("Directly", "initial"): self.DirectlyInitialValue,

   430

            ("Subrange", "base"): self.SubrangeBaseType,

   431

            ("Subrange", "lower"): self.SubrangeMinimum,

   432

            ("Subrange", "upper"): self.SubrangeMaximum,

   433

            ("Subrange", "initial"): self.SubrangeInitialValue,

   434

            ("Enumerated", "value"): self.EnumeratedValues,

   435

            ("Enumerated", "initial"): self.EnumeratedInitialValue,

   436

            ("Array", "initial"): self.ArrayInitialValue,

   437

            ("Array", "base"): self.ArrayBaseType,

   438

            ("Array", "range"): self.ArrayDimensions,

   439

        }

   441

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

   442

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

   444

    def __del__(self):

   445

        self.RefreshHighlightsTimer.Stop()

   447

    def GetBufferState(self):

   448

        return self.Controler.GetBufferState()

   450

    def Undo(self):

   451

        self.Controler.LoadPrevious()

   452

        self.ParentWindow.CloseTabsWithoutModel()

   454

    def Redo(self):

   455

        self.Controler.LoadNext()

   456

        self.ParentWindow.CloseTabsWithoutModel()

   458

    def HasNoModel(self):

   459

        return self.Controler.GetEditedElement(self.TagName) is None

   461

    def RefreshView(self):

   462

        self.Initializing = True

   463

        self.DirectlyBaseType.Clear()

   464

        self.ArrayBaseType.Clear()

   465

        for datatype in self.Controler.GetDataTypes(self.TagName):

   466

            self.DirectlyBaseType.Append(datatype)

   467

            self.ArrayBaseType.Append(datatype)

   468

        self.DirectlyBaseType.SetSelection(0)

   469

        self.SubrangeBaseType.Clear()

   470

        words = self.TagName.split("::")

   471

        for base_type in self.Controler.GetSubrangeBaseTypes(words[1]):

   472

            self.SubrangeBaseType.Append(base_type)

   473

        self.SubrangeBaseType.SetSelection(0)

   474

        self.RefreshBoundsRange()

   475

        type_infos = self.Controler.GetDataTypeInfos(self.TagName)

   476

        if type_infos is not None:

   477

            datatype = type_infos["type"]

   478

            self.DerivationType.SetStringSelection(_(datatype))

   479

            if type_infos["type"] == "Directly":

   480

                self.DirectlyBaseType.SetStringSelection(type_infos["base_type"])

   481

                self.DirectlyInitialValue.SetValue(type_infos["initial"])

   482

            elif type_infos["type"] == "Subrange":

   483

                self.SubrangeBaseType.SetStringSelection(type_infos["base_type"])

   484

                self.RefreshBoundsRange()

   485

                self.SubrangeMinimum.SetValue(int(type_infos["min"]))

   486

                self.SubrangeMaximum.SetValue(int(type_infos["max"]))

   487

                self.RefreshSubrangeInitialValueRange()

   488

                if type_infos["initial"] != "":

   489

                    self.SubrangeInitialValue.SetValue(int(type_infos["initial"]))

   490

                else:

   491

                    self.SubrangeInitialValue.SetValue(type_infos["min"])

   492

            elif type_infos["type"] == "Enumerated":

   493

                self.EnumeratedValues.SetStrings(type_infos["values"])

   494

                self.RefreshEnumeratedValues()

   495

                self.EnumeratedInitialValue.SetStringSelection(type_infos["initial"])

   496

            elif type_infos["type"] == "Array":

   497

                self.ArrayBaseType.SetStringSelection(type_infos["base_type"])

   498

                self.ArrayDimensions.SetStrings(map(lambda x : "..".join(x), type_infos["dimensions"]))

   499

                self.ArrayInitialValue.SetValue(type_infos["initial"])

   500

            elif type_infos["type"] == "Structure":

   501

                self.StructureElementsTable.SetData(type_infos["elements"])

   502

            self.RefreshDisplayedInfos()

   503

        self.ShowHighlights()

   504

        self.StructureElementsTable.ResetView(self.StructureElementsGrid)

   505

        self.StructureElementsGrid.RefreshButtons()

   506

        self.Initializing = False