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

from dialogs import DurationEditorDialog

    30

    31

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

    32

#                          Configuration Editor class

    33

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

    34

    35

[ID_CONFIGURATIONEDITOR, 

    36

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

    37

    38

class ConfigurationEditor(wx.Panel):

    39

    40

    def _init_ctrls(self, prnt):

    41

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

    42

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

    43

    44

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

    45

        self._init_ctrls(parent)

    46

    47

        self.ParentWindow = window

    48

        self.Controler = controler

    49

        self.TagName = tagname

    50

    51

    def SetTagName(self, tagname):

    52

        self.TagName = tagname

    53

    54

    def GetTagName(self):

    55

        return self.TagName

    56

    57

    def IsViewing(self, tagname):

    58

        return self.TagName == tagname

    59

    60

    def IsDebugging(self):

    61

        return False

    62

    63

    def SetMode(self, mode):

    64

        pass

    65

    66

    def ResetBuffer(self):

    67

        pass

    68

    69

    def RefreshView(self):

    70

        pass

    71

    72

    def RefreshScaling(self, refresh=True):

    73

        pass

    74

    75

    def ClearHighlights(self):

    76

        pass

    77

    78

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

    79

#                            Resource Editor class

    80

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

    81

    82

def GetTasksTableColnames():

    83

    _ = lambda x : x

    84

    return [_("Name"), _("Triggering"), _("Single"), _("Interval"), _("Priority")]

    85

    86

def GetTaskTriggeringOptions():

    87

    _ = lambda x : x

    88

    return [_("Interrupt"), _("Cyclic")]

    89

TASKTRIGGERINGOPTIONS_DICT = dict([(_(option), option) for option in GetTaskTriggeringOptions()])

    90

    91

def GetInstancesTableColnames():

    92

    _ = lambda x : x

    93

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

    94

    95

class ResourceTable(wx.grid.PyGridTableBase):

    96

    97

    """

    98

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

    99

    """

   100

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

   101

        # The base class must be initialized *first*

   102

        wx.grid.PyGridTableBase.__init__(self)

   103

        self.data = data

   104

        self.colnames = colnames

   105

        self.Highlights = {}

   106

        self.Parent = parent

   107

   108

        self.ColAlignements = []

   109

        self.ColSizes = []

   110

        # XXX

   111

        # we need to store the row length and collength to

   112

        # see if the table has changed size

   113

        self._rows = self.GetNumberRows()

   114

        self._cols = self.GetNumberCols()

   115

   116

    def GetColAlignements(self):

   117

        return self.ColAlignements

   118

   119

    def SetColAlignements(self, list):

   120

        self.ColAlignements = list

   121

   122

    def GetColSizes(self):

   123

        return self.ColSizes

   124

   125

    def SetColSizes(self, list):

   126

        self.ColSizes = list

   127

   128

    def GetNumberCols(self):

   129

        return len(self.colnames)

   130

   131

    def GetNumberRows(self):

   132

        return len(self.data)

   133

   134

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

   135

        if col < len(self.colnames):

   136

            if translate:

   137

                return _(self.colnames[col])

   138

            return self.colnames[col]

   139

   140

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

   141

        return row

   142

   143

    def GetValue(self, row, col):

   144

        if row < self.GetNumberRows():

   145

            colname = self.GetColLabelValue(col, False)

   146

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

   147

            if colname == "Triggering":

   148

                return _(value)

   149

            return value

   150

   151

    def GetValueByName(self, row, colname):

   152

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

   153

   154

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

   155

        if col < len(self.colnames):

   156

            colname = self.GetColLabelValue(col, False)

   157

            if colname == "Triggering":

   158

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   159

            self.data[row][colname] = value

   160

   161

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

   162

        if colname in self.colnames:

   163

            self.data[row][colname] = value

   164

   165

    def ResetView(self, grid):

   166

        """

   167

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

   168

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

   169

        """

   170

        grid.BeginBatch()

   171

        for current, new, delmsg, addmsg in [

   172

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

   173

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

   174

        ]:

   175

            if new < current:

   176

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

   177

                grid.ProcessTableMessage(msg)

   178

            elif new > current:

   179

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

   180

                grid.ProcessTableMessage(msg)

   181

                self.UpdateValues(grid)

   182

        grid.EndBatch()

   183

   184

        self._rows = self.GetNumberRows()

   185

        self._cols = self.GetNumberCols()

   186

        # update the column rendering scheme

   187

        self._updateColAttrs(grid)

   188

   189

        # update the scrollbars and the displayed part of the grid

   190

        grid.AdjustScrollbars()

   191

        grid.ForceRefresh()

   192

   193

    def UpdateValues(self, grid):

   194

        """Update all displayed values"""

   195

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

   196

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

   197

        grid.ProcessTableMessage(msg)

   198

   199

    def _updateColAttrs(self, grid):

   200

        """

   201

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

   202

        appropriate renderer given the column name.

   203

   204

        Otherwise default to the default renderer.

   205

        """

   206

   207

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

   208

            attr = wx.grid.GridCellAttr()

   209

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

   210

            grid.SetColAttr(col, attr)

   211

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

   212

   213

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

   214

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

   215

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

   216

                editor = None

   217

                renderer = None

   218

                colname = self.GetColLabelValue(col, False)

   219

                grid.SetReadOnly(row, col, False)

   220

                if colname == "Name":

   221

                    editor = wx.grid.GridCellTextEditor()

   222

                    renderer = wx.grid.GridCellStringRenderer()

   223

                elif colname == "Interval":

   224

                    editor = DurationCellEditor(self)

   225

                    renderer = wx.grid.GridCellStringRenderer()

   226

                    if self.GetValueByName(row, "Triggering") != "Cyclic":

   227

                        grid.SetReadOnly(row, col, True)

   228

                elif colname == "Single":

   229

                    editor = wx.grid.GridCellChoiceEditor()

   230

                    editor.SetParameters(self.Parent.VariableList)

   231

                    if self.GetValueByName(row, "Triggering") != "Interrupt":

   232

                        grid.SetReadOnly(row, col, True)

   233

                elif colname == "Triggering":

   234

                    editor = wx.grid.GridCellChoiceEditor()

   235

                    editor.SetParameters(",".join([""] + GetTaskTriggeringOptions()))

   236

                elif colname == "Type":

   237

                    editor = wx.grid.GridCellChoiceEditor()

   238

                    editor.SetParameters(self.Parent.TypeList)

   239

                elif colname == "Priority":

   240

                    editor = wx.grid.GridCellNumberEditor()

   241

                    editor.SetParameters("0,65535")

   242

                elif colname == "Task":

   243

                    editor = wx.grid.GridCellChoiceEditor()

   244

                    editor.SetParameters(self.Parent.TaskList)

   245

   246

                grid.SetCellEditor(row, col, editor)

   247

                grid.SetCellRenderer(row, col, renderer)

   248

   249

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

   250

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

   251

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

   252

            if wx.Platform == '__WXMSW__':

   253

                grid.SetRowMinimalHeight(row, 20)

   254

            else:

   255

                grid.SetRowMinimalHeight(row, 28)

   256

            grid.AutoSizeRow(row, False)

   257

   258

    def SetData(self, data):

   259

        self.data = data

   260

   261

    def GetData(self):

   262

        return self.data

   263

   264

    def GetCurrentIndex(self):

   265

        return self.CurrentIndex

   266

   267

    def SetCurrentIndex(self, index):

   268

        self.CurrentIndex = index

   269

   270

    def AppendRow(self, row_content):

   271

        self.data.append(row_content)

   272

   273

    def InsertRow(self, index, row_content):

   274

        self.data.insert(index, row_content)

   275

   276

    def RemoveRow(self, row_index):

   277

        self.data.pop(row_index)

   278

   279

    def MoveRow(self, row_index, move):

   280

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

   281

        if new_index != row_index:

   282

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

   285

    def Empty(self):

   286

        self.data = []

   288

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

   289

#                        Highlights showing functions

   290

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

   291

   292

    def AddHighlight(self, infos, highlight_type):

   293

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

   294

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

   295

        col_highlights.append(highlight_type)

   297

    def ClearHighlights(self, highlight_type=None):

   298

        if highlight_type is None:

   299

            self.Highlights = {}

   300

        else:

   301

            for row, row_highlights in self.Highlights.iteritems():

   302

                row_items = row_highlights.items()

   303

                for col, col_highlights in row_items:

   304

                    if highlight_type in col_highlights:

   305

                        col_highlights.remove(highlight_type)

   306

                    if len(col_highlights) == 0:

   307

                        row_highlights.pop(col)

   308

   309

[ID_RESOURCEEDITOR, ID_RESOURCEEDITORSTATICTEXT1,

   310

 ID_RESOURCEEDITORSTATICTEXT2, ID_RESOURCEEDITORINSTANCESGRID,

   311

 ID_RESOURCEEDITORTASKSGRID, ID_RESOURCEEDITORADDINSTANCEBUTTON,

   312

 ID_RESOURCEEDITORDELETEINSTANCEBUTTON, ID_RESOURCEEDITORUPINSTANCEBUTTON,

   313

 ID_RESOURCEEDITORDOWNINSTANCEBUTTON, ID_RESOURCEEDITORADDTASKBUTTON,

   314

 ID_RESOURCEEDITORDELETETASKBUTTON, ID_RESOURCEEDITORUPTASKBUTTON,

   315

 ID_RESOURCEEDITORDOWNTASKBUTTON,

   316

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

   317

   318

class ResourceEditor(wx.Panel):

   319

   320

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

   321

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

   322

            if id is not None:

   323

                event(self, id, function)

   324

            else:

   325

                event(self, function)

   326

   327

    def _init_coll_InstancesSizer_Growables(self, parent):

   328

        parent.AddGrowableCol(0)

   329

        parent.AddGrowableRow(1)

   330

   331

    def _init_coll_InstancesSizer_Items(self, parent):

   332

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

   333

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

   334

   335

    def _init_coll_InstancesButtonsSizer_Growables(self, parent):

   336

        parent.AddGrowableCol(0)

   337

        parent.AddGrowableRow(0)

   338

   339

    def _init_coll_InstancesButtonsSizer_Items(self, parent):

   340

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

   341

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

   342

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

   343

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

   344

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

   345

   346

    def _init_coll_TasksSizer_Growables(self, parent):

   347

        parent.AddGrowableCol(0)

   348

        parent.AddGrowableRow(1)

   349

   350

    def _init_coll_TasksSizer_Items(self, parent):

   351

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

   352

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

   353

   354

    def _init_coll_TasksButtonsSizer_Growables(self, parent):

   355

        parent.AddGrowableCol(0)

   356

        parent.AddGrowableRow(0)

   357

   358

    def _init_coll_TasksButtonsSizer_Items(self, parent):

   359

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

   360

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

   361

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

   362

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

   363

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

   364

   365

    def _init_coll_MainGridSizer_Items(self, parent):

   366

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

   367

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

   368

   369

    def _init_coll_MainGridSizer_Growables(self, parent):

   370

        parent.AddGrowableCol(0)

   371

        parent.AddGrowableRow(0)

   372

        parent.AddGrowableRow(1)

   373

   374

    def _init_sizers(self):

   375

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

   376

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

   377

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

   378

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

   379

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

   380

   381

        self._init_coll_MainGridSizer_Growables(self.MainGridSizer)

   382

        self._init_coll_MainGridSizer_Items(self.MainGridSizer)

   383

        self._init_coll_InstancesSizer_Growables(self.InstancesSizer)

   384

        self._init_coll_InstancesSizer_Items(self.InstancesSizer)

   385

        self._init_coll_InstancesButtonsSizer_Growables(self.InstancesButtonsSizer)

   386

        self._init_coll_InstancesButtonsSizer_Items(self.InstancesButtonsSizer)

   387

        self._init_coll_TasksSizer_Growables(self.TasksSizer)

   388

        self._init_coll_TasksSizer_Items(self.TasksSizer)

   389

        self._init_coll_TasksButtonsSizer_Growables(self.TasksButtonsSizer)

   390

        self._init_coll_TasksButtonsSizer_Items(self.TasksButtonsSizer)

   391

   392

        self.SetSizer(self.MainGridSizer)

   393

   394

    def _init_ctrls(self, prnt):

   395

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

   396

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

   397

   398

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

   399

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

   400

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

   401

   403

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

   404

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

   405

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

   406

              'Sans'))

   407

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

   408

              False, 'Sans'))

   410

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

   411

        else:

   412

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

   413

   414

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

   415

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

   416

              size=wx.DefaultSize, style=0)

   418

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

   419

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

   420

              size=wx.DefaultSize, style=0)

   422

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

   423

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

   424

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

   426

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

   427

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

   428

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

   430

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

   431

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

   432

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

   433

   435

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

   436

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

   437

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

   438

              'Sans'))

   439

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

   440

              False, 'Sans'))

   442

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

   443

        else:

   444

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

   445

   446

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

   447

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

   448

              size=wx.DefaultSize, style=0)

   450

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

   451

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

   452

              size=wx.DefaultSize, style=0)

   454

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

   455

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

   456

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

   458

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

   459

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

   460

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

   462

        self._init_sizers()

   463

   464

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

   465

        self._init_ctrls(parent)

   466

   467

        self.ParentWindow = window

   468

        self.Controler = controler

   469

        self.TagName = tagname

   470

   471

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

   472

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

   473

   474

        self.TasksDefaultValue = {"Name" : "", "Triggering" : "", "Single" : "", "Interval" : "", "Priority" : 0}

   475

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

   476

        self.TasksTable.SetColAlignements([wx.ALIGN_LEFT, wx.ALIGN_LEFT, wx.ALIGN_LEFT, wx.ALIGN_RIGHT, wx.ALIGN_RIGHT])

   477

        self.TasksTable.SetColSizes([200, 100, 100, 150, 100])

   478

        self.TasksGrid.SetTable(self.TasksTable)