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

     5

#based on the plcopen standard. 

     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 wx

    26

import wx.grid

    27

    28

    29

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

    30

#                          Configuration Editor class

    31

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

    32

    33

[ID_CONFIGURATIONEDITOR, 

    34

] = [wx.NewId() for _init_ctrls in range(1)]

    35

    36

class ConfigurationEditor(wx.Panel):

    37

    38

    def _init_ctrls(self, prnt):

    39

        wx.Panel.__init__(self, id=ID_CONFIGURATIONEDITOR, name='', parent=prnt,

    40

              size=wx.Size(0, 0), style=wx.SUNKEN_BORDER)

    41

    42

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

    43

        self._init_ctrls(parent)

    44

    45

        self.ParentWindow = window

    46

        self.Controler = controler

    47

        self.TagName = tagname

    48

    49

    def SetTagName(self, tagname):

    50

        self.TagName = tagname

    51

    52

    def GetTagName(self):

    53

        return self.TagName

    54

    55

    def IsViewing(self, tagname):

    56

        return self.TagName == tagname

    57

    58

    def IsDebugging(self):

    59

        return False

    60

    61

    def SetMode(self, mode):

    62

        pass

    63

    64

    def ResetBuffer(self):

    65

        pass

    66

    67

    def RefreshView(self):

    68

        pass

    69

    70

    def RefreshScaling(self, refresh=True):

    71

        pass

    72

    73

    def ClearErrors(self):

    74

        pass

    75

    76

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

    77

#                            Resource Editor class

    78

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

    79

    80

def GetTasksTableColnames():

    81

    _ = lambda x : x

    88

    89

def GetInstancesTableColnames():

    90

    _ = lambda x : x

    91

    return [_("Name"), _("Type"), _("Task")]

    92

    93

class ResourceTable(wx.grid.PyGridTableBase):

    94

    95

    """

    96

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

    97

    """

    98

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

    99

        # The base class must be initialized *first*

   100

        wx.grid.PyGridTableBase.__init__(self)

   101

        self.data = data

   102

        self.colnames = colnames

   103

        self.Errors = {}

   104

        self.Parent = parent

   105

   106

        self.ColAlignements = []

   107

        self.ColSizes = []

   108

        # XXX

   109

        # we need to store the row length and collength to

   110

        # see if the table has changed size

   111

        self._rows = self.GetNumberRows()

   112

        self._cols = self.GetNumberCols()

   113

   114

    def GetColAlignements(self):

   115

        return self.ColAlignements

   116

   117

    def SetColAlignements(self, list):

   118

        self.ColAlignements = list

   119

   120

    def GetColSizes(self):

   121

        return self.ColSizes

   122

   123

    def SetColSizes(self, list):

   124

        self.ColSizes = list

   125

   126

    def GetNumberCols(self):

   127

        return len(self.colnames)

   128

   129

    def GetNumberRows(self):

   130

        return len(self.data)

   131

   132

    def GetColLabelValue(self, col, translate=True):

   133

        if col < len(self.colnames):

   134

            if translate:

   135

                return _(self.colnames[col])

   136

            return self.colnames[col]

   137

   138

    def GetRowLabelValues(self, row, translate=True):

   139

        return row

   140

   141

    def GetValue(self, row, col):

   142

        if row < self.GetNumberRows():

   149

    def GetValueByName(self, row, colname):

   150

        return self.data[row].get(colname)

   151

   152

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

   153

        if col < len(self.colnames):

   158

   159

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

   160

        if colname in self.colnames:

   161

            self.data[row][colname] = value

   162

   163

    def ResetView(self, grid):

   164

        """

   165

        (wx.grid.Grid) -> Reset the grid view.   Call this to

   166

        update the grid if rows and columns have been added or deleted

   167

        """

   168

        grid.BeginBatch()

   169

        for current, new, delmsg, addmsg in [

   170

            (self._rows, self.GetNumberRows(), wx.grid.GRIDTABLE_NOTIFY_ROWS_DELETED, wx.grid.GRIDTABLE_NOTIFY_ROWS_APPENDED),

   171

            (self._cols, self.GetNumberCols(), wx.grid.GRIDTABLE_NOTIFY_COLS_DELETED, wx.grid.GRIDTABLE_NOTIFY_COLS_APPENDED),

   172

        ]:

   173

            if new < current:

   174

                msg = wx.grid.GridTableMessage(self,delmsg,new,current-new)

   175

                grid.ProcessTableMessage(msg)

   176

            elif new > current:

   177

                msg = wx.grid.GridTableMessage(self,addmsg,new-current)

   178

                grid.ProcessTableMessage(msg)

   179

                self.UpdateValues(grid)

   180

        grid.EndBatch()

   181

   182

        self._rows = self.GetNumberRows()

   183

        self._cols = self.GetNumberCols()

   184

        # update the column rendering scheme

   185

        self._updateColAttrs(grid)

   186

   187

        # update the scrollbars and the displayed part of the grid

   188

        grid.AdjustScrollbars()

   189

        grid.ForceRefresh()

   190

   191

    def UpdateValues(self, grid):

   192

        """Update all displayed values"""

   193

        # This sends an event to the grid table to update all of the values

   194

        msg = wx.grid.GridTableMessage(self, wx.grid.GRIDTABLE_REQUEST_VIEW_GET_VALUES)

   195

        grid.ProcessTableMessage(msg)

   196

   197

    def _updateColAttrs(self, grid):

   198

        """

   199

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

   200

        appropriate renderer given the column name.

   201

   202

        Otherwise default to the default renderer.

   203

        """

   204

   205

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

   206

            attr = wx.grid.GridCellAttr()

   207

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

   208

            grid.SetColAttr(col, attr)

   209

            grid.SetColSize(col, self.ColSizes[col])

   210

   211

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

   212

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

   213

                editor = None

   214

                renderer = None

   215

                colname = self.GetColLabelValue(col, False)

   216

                grid.SetReadOnly(row, col, False)

   218

                    editor = wx.grid.GridCellTextEditor()

   219

                    renderer = wx.grid.GridCellStringRenderer()

   221

                        grid.SetReadOnly(row, col, True)

   222

                elif colname == "Single":

   223

                    editor = wx.grid.GridCellChoiceEditor()

   224

                    editor.SetParameters(self.Parent.VariableList)

   226

                        grid.SetReadOnly(row, col, True)

   230

                elif colname == "Type":

   231

                    editor = wx.grid.GridCellChoiceEditor()

   232

                    editor.SetParameters(self.Parent.TypeList)

   233

                elif colname == "Priority":

   234

                    editor = wx.grid.GridCellNumberEditor()

   235

                    editor.SetParameters("0,65535")

   236

                elif colname == "Task":

   237

                    editor = wx.grid.GridCellChoiceEditor()

   238

                    editor.SetParameters(self.Parent.TaskList)

   239

   240

                grid.SetCellEditor(row, col, editor)

   241

                grid.SetCellRenderer(row, col, renderer)

   242

   243

                if row in self.Errors and self.Errors[row][0] == colname.lower():

   244

                    grid.SetCellBackgroundColour(row, col, wx.Colour(255, 255, 0))

   245

                    grid.SetCellTextColour(row, col, wx.RED)

   246

                    grid.MakeCellVisible(row, col)

   247

                else:

   248

                    grid.SetCellTextColour(row, col, wx.BLACK)

   249

                    grid.SetCellBackgroundColour(row, col, wx.WHITE)

   255

   256

    def SetData(self, data):

   257

        self.data = data

   258

   259

    def GetData(self):

   260

        return self.data

   261

   262

    def GetCurrentIndex(self):

   263

        return self.CurrentIndex

   264

   265

    def SetCurrentIndex(self, index):

   266

        self.CurrentIndex = index

   267

   268

    def AppendRow(self, row_content):

   269

        self.data.append(row_content)

   270

   274

    def RemoveRow(self, row_index):

   275

        self.data.pop(row_index)

   276

   278

        new_index = max(0, min(row_index + move, len(self.data) - 1))

   279

        if new_index != row_index:

   280

            self.data.insert(new_index, self.data.pop(row_index))

   283

   284

    def Empty(self):

   285

        self.data = []

   286

        self.editors = []

   287

   288

    def AddError(self, infos):

   289

        self.Errors[infos[0]] = infos[1:]

   290

   291

    def ClearErrors(self):

   292

        self.Errors = {}

   293

   294

[ID_RESOURCEEDITOR, ID_RESOURCEEDITORSTATICTEXT1,

   295

 ID_RESOURCEEDITORSTATICTEXT2, ID_RESOURCEEDITORINSTANCESGRID,

   296

 ID_RESOURCEEDITORTASKSGRID, ID_RESOURCEEDITORADDINSTANCEBUTTON,

   297

 ID_RESOURCEEDITORDELETEINSTANCEBUTTON, ID_RESOURCEEDITORUPINSTANCEBUTTON,

   298

 ID_RESOURCEEDITORDOWNINSTANCEBUTTON, ID_RESOURCEEDITORADDTASKBUTTON,

   299

 ID_RESOURCEEDITORDELETETASKBUTTON, ID_RESOURCEEDITORUPTASKBUTTON,

   300

 ID_RESOURCEEDITORDOWNTASKBUTTON,

   301

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

   302

   303

class ResourceEditor(wx.Panel):

   304

   305

    if wx.VERSION < (2, 6, 0):

   306

        def Bind(self, event, function, id = None):

   307

            if id is not None:

   308

                event(self, id, function)

   309

            else:

   310

                event(self, function)

   311

   312

    def _init_coll_InstancesSizer_Growables(self, parent):

   313

        parent.AddGrowableCol(0)

   314

        parent.AddGrowableRow(1)

   315

   316

    def _init_coll_InstancesSizer_Items(self, parent):

   317

        parent.AddSizer(self.InstancesButtonsSizer, 0, border=0, flag=wx.GROW)

   318

        parent.AddWindow(self.InstancesGrid, 0, border=0, flag=wx.GROW)

   319

   320

    def _init_coll_InstancesButtonsSizer_Growables(self, parent):

   321

        parent.AddGrowableCol(0)

   322

        parent.AddGrowableRow(0)

   323

   324

    def _init_coll_InstancesButtonsSizer_Items(self, parent):

   325

        parent.AddWindow(self.staticText2, 0, border=0, flag=wx.ALIGN_BOTTOM)

   326

        parent.AddWindow(self.AddInstanceButton, 0, border=0, flag=0)

   327

        parent.AddWindow(self.DeleteInstanceButton, 0, border=0, flag=0)

   328

        parent.AddWindow(self.UpInstanceButton, 0, border=0, flag=0)

   329

        parent.AddWindow(self.DownInstanceButton, 0, border=0, flag=0)

   330

   331

    def _init_coll_TasksSizer_Growables(self, parent):

   332

        parent.AddGrowableCol(0)

   333

        parent.AddGrowableRow(1)

   334

   335

    def _init_coll_TasksSizer_Items(self, parent):

   336

        parent.AddSizer(self.TasksButtonsSizer, 0, border=0, flag=wx.GROW)

   337

        parent.AddWindow(self.TasksGrid, 0, border=0, flag=wx.GROW)

   338

   339

    def _init_coll_TasksButtonsSizer_Growables(self, parent):

   340

        parent.AddGrowableCol(0)

   341

        parent.AddGrowableRow(0)

   342

   343

    def _init_coll_TasksButtonsSizer_Items(self, parent):

   344

        parent.AddWindow(self.staticText1, 0, border=0, flag=wx.ALIGN_BOTTOM)

   345

        parent.AddWindow(self.AddTaskButton, 0, border=0, flag=0)

   346

        parent.AddWindow(self.DeleteTaskButton, 0, border=0, flag=0)

   347

        parent.AddWindow(self.UpTaskButton, 0, border=0, flag=0)

   348

        parent.AddWindow(self.DownTaskButton, 0, border=0, flag=0)

   349

   350

    def _init_coll_MainGridSizer_Items(self, parent):

   351

        parent.AddSizer(self.TasksSizer, 0, border=5, flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)

   352

        parent.AddSizer(self.InstancesSizer, 0, border=5, flag=wx.GROW|wx.BOTTOM|wx.LEFT|wx.RIGHT)

   353

   354

    def _init_coll_MainGridSizer_Growables(self, parent):

   355

        parent.AddGrowableCol(0)

   356

        parent.AddGrowableRow(0)

   357

        parent.AddGrowableRow(1)

   358

   359

    def _init_sizers(self):

   360

        self.MainGridSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=5)

   361

        self.InstancesSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=5)

   362

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

   363

        self.TasksSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=5)

   364

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

   365

   366

        self._init_coll_MainGridSizer_Growables(self.MainGridSizer)

   367

        self._init_coll_MainGridSizer_Items(self.MainGridSizer)

   368

        self._init_coll_InstancesSizer_Growables(self.InstancesSizer)

   369

        self._init_coll_InstancesSizer_Items(self.InstancesSizer)

   370

        self._init_coll_InstancesButtonsSizer_Growables(self.InstancesButtonsSizer)

   371

        self._init_coll_InstancesButtonsSizer_Items(self.InstancesButtonsSizer)

   372

        self._init_coll_TasksSizer_Growables(self.TasksSizer)

   373

        self._init_coll_TasksSizer_Items(self.TasksSizer)

   374

        self._init_coll_TasksButtonsSizer_Growables(self.TasksButtonsSizer)

   375

        self._init_coll_TasksButtonsSizer_Items(self.TasksButtonsSizer)

   376

   377

        self.SetSizer(self.MainGridSizer)

   378

   379

    def _init_ctrls(self, prnt):

   380

        wx.Panel.__init__(self, id=ID_RESOURCEEDITOR, name='', parent=prnt,

   381

              size=wx.Size(0, 0), style=wx.SUNKEN_BORDER)

   382

   383

        self.staticText1 = wx.StaticText(id=ID_RESOURCEEDITORSTATICTEXT1,

   384

              label=_(u'Tasks:'), name='staticText2', parent=self, pos=wx.Point(0,

   385

              0), size=wx.DefaultSize, style=wx.ALIGN_CENTER)

   386

   387

        self.TasksGrid = wx.grid.Grid(id=ID_RESOURCEEDITORTASKSGRID,

   388

              name='TasksGrid', parent=self, pos=wx.Point(0, 0), 

   389

              size=wx.Size(-1, -1), style=wx.VSCROLL)

   390

        self.TasksGrid.SetFont(wx.Font(12, 77, wx.NORMAL, wx.NORMAL, False,

   391

              'Sans'))

   392

        self.TasksGrid.SetLabelFont(wx.Font(10, 77, wx.NORMAL, wx.NORMAL,

   393

              False, 'Sans'))

   394

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

   395

            self.TasksGrid.Bind(wx.grid.EVT_GRID_CELL_CHANGE, self.OnTasksGridCellChange)

   396

        else:

   397

            wx.grid.EVT_GRID_CELL_CHANGE(self.TasksGrid, self.OnTasksGridCellChange)

   398

   399

        self.AddTaskButton = wx.Button(id=ID_RESOURCEEDITORADDTASKBUTTON, label=_('Add Task'),

   400

              name='AddTaskButton', parent=self, pos=wx.Point(0, 0),

   401

              size=wx.DefaultSize, style=0)

   402

        self.Bind(wx.EVT_BUTTON, self.OnAddTaskButton, id=ID_RESOURCEEDITORADDTASKBUTTON)

   403

   404

        self.DeleteTaskButton = wx.Button(id=ID_RESOURCEEDITORDELETETASKBUTTON, label=_('Delete Task'),

   405

              name='DeleteTaskButton', parent=self, pos=wx.Point(0, 0),

   406

              size=wx.DefaultSize, style=0)

   407

        self.Bind(wx.EVT_BUTTON, self.OnDeleteTaskButton, id=ID_RESOURCEEDITORDELETETASKBUTTON)

   408

   409

        self.UpTaskButton = wx.Button(id=ID_RESOURCEEDITORUPTASKBUTTON, label='^',

   410

              name='UpTaskButton', parent=self, pos=wx.Point(0, 0),

   411

              size=wx.Size(32, 32), style=0)

   412

        self.Bind(wx.EVT_BUTTON, self.OnUpTaskButton, id=ID_RESOURCEEDITORUPTASKBUTTON)

   413

   414

        self.DownTaskButton = wx.Button(id=ID_RESOURCEEDITORDOWNTASKBUTTON, label='v',

   415

              name='DownTaskButton', parent=self, pos=wx.Point(0, 0),

   416

              size=wx.Size(32, 32), style=0)

   417

        self.Bind(wx.EVT_BUTTON, self.OnDownTaskButton, id=ID_RESOURCEEDITORDOWNTASKBUTTON)

   418

   419

        self.staticText2 = wx.StaticText(id=ID_RESOURCEEDITORSTATICTEXT2,

   420

              label=_(u'Instances:'), name='staticText1', parent=self,

   421

              pos=wx.Point(0, 0), size=wx.DefaultSize, style=wx.ALIGN_CENTER)

   422

   423

        self.InstancesGrid = wx.grid.Grid(id=ID_RESOURCEEDITORINSTANCESGRID,

   424

              name='InstancesGrid', parent=self, pos=wx.Point(0, 0), 

   425

              size=wx.Size(-1, -1), style=wx.VSCROLL)

   426

        self.InstancesGrid.SetFont(wx.Font(12, 77, wx.NORMAL, wx.NORMAL, False,

   427

              'Sans'))

   428

        self.InstancesGrid.SetLabelFont(wx.Font(10, 77, wx.NORMAL, wx.NORMAL,

   429

              False, 'Sans'))

   430

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

   431

            self.InstancesGrid.Bind(wx.grid.EVT_GRID_CELL_CHANGE, self.OnInstancesGridCellChange)

   432

        else:

   433

            wx.grid.EVT_GRID_CELL_CHANGE(self.InstancesGrid, self.OnInstancesGridCellChange)

   434

   435

        self.AddInstanceButton = wx.Button(id=ID_RESOURCEEDITORADDINSTANCEBUTTON, label=_('Add Instance'),

   436

              name='AddInstanceButton', parent=self, pos=wx.Point(0, 0),

   437

              size=wx.DefaultSize, style=0)

   438

        self.Bind(wx.EVT_BUTTON, self.OnAddInstanceButton, id=ID_RESOURCEEDITORADDINSTANCEBUTTON)

   439

   440

        self.DeleteInstanceButton = wx.Button(id=ID_RESOURCEEDITORDELETEINSTANCEBUTTON, label=_('Delete Instance'),

   441

              name='DeleteInstanceButton', parent=self, pos=wx.Point(0, 0),

   442

              size=wx.DefaultSize, style=0)

   443

        self.Bind(wx.EVT_BUTTON, self.OnDeleteInstanceButton, id=ID_RESOURCEEDITORDELETEINSTANCEBUTTON)

   444

   445

        self.UpInstanceButton = wx.Button(id=ID_RESOURCEEDITORUPINSTANCEBUTTON, label='^',

   446

              name='UpInstanceButton', parent=self, pos=wx.Point(0, 0),

   447

              size=wx.Size(32, 32), style=0)

   448

        self.Bind(wx.EVT_BUTTON, self.OnUpInstanceButton, id=ID_RESOURCEEDITORUPINSTANCEBUTTON)

   449

   450

        self.DownInstanceButton = wx.Button(id=ID_RESOURCEEDITORDOWNINSTANCEBUTTON, label='v',

   451

              name='DownInstanceButton', parent=self, pos=wx.Point(0, 0),

   452

              size=wx.Size(32, 32), style=0)

   453

        self.Bind(wx.EVT_BUTTON, self.OnDownInstanceButton, id=ID_RESOURCEEDITORDOWNINSTANCEBUTTON)

   454

   455

        self._init_sizers()

   456

   457

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

   458

        self._init_ctrls(parent)

   459

   460

        self.ParentWindow = window

   461

        self.Controler = controler

   462

        self.TagName = tagname

   463

   465

        self.TasksTable = ResourceTable(self, [], GetTasksTableColnames())

   468

        self.TasksGrid.SetTable(self.TasksTable)

   469

        self.TasksGrid.SetRowLabelSize(0)

   470

        self.TasksTable.ResetView(self.TasksGrid)

   471

   472

        self.InstancesDefaultValue = {"Name" : "", "Type" : "", "Task" : ""}

   473

        self.InstancesTable = ResourceTable(self, [], GetInstancesTableColnames())

   474

        self.InstancesTable.SetColAlignements([wx.ALIGN_LEFT, wx.ALIGN_LEFT, wx.ALIGN_LEFT])

   475

        self.InstancesTable.SetColSizes([200, 150, 150])

   476

        self.InstancesGrid.SetTable(self.InstancesTable)

   477

        self.InstancesGrid.SetRowLabelSize(0)

   478

        self.InstancesTable.ResetView(self.InstancesGrid)

   479

   480

    def SetTagName(self, tagname):

   481

        self.TagName = tagname

   482

   483

    def GetTagName(self):

   484

        return self.TagName

   485

   486

    def IsViewing(self, tagname):

   487

        return self.TagName == tagname

   488

   489

    def IsDebugging(self):

   490

        return False

   491

   492

    def SetMode(self, mode):

   493

        pass

   494

   495

    def RefreshTypeList(self):

   496

        self.TypeList = ""

   497

        blocktypes = self.Controler.GetBlockResource()

   498

        for blocktype in blocktypes:

   499

            self.TypeList += ",%s"%blocktype

   500

   501

    def RefreshTaskList(self):

   502

        self.TaskList = ""

   503

        for row in xrange(self.TasksTable.GetNumberRows()):

   504

            self.TaskList += ",%s"%self.TasksTable.GetValueByName(row, "Name")

   505