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.lib.buttons

    27

import wx.grid

    28

    29

from graphics.GraphicCommons import REFRESH_HIGHLIGHT_PERIOD

    30

from controls import CustomGrid, CustomTable, EditorPanel, DurationCellEditor

    31

from utils.BitmapLibrary import GetBitmap

    32

    33

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

    34

#                          Configuration Editor class

    35

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

    36

    37

[ID_CONFIGURATIONEDITOR, 

    38

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

    39

    40

class ConfigurationEditor(EditorPanel):

    41

    42

    ID = ID_CONFIGURATIONEDITOR

    43

    VARIABLE_PANEL_TYPE = "config"

    44

    45

    def GetBufferState(self):

    46

        return self.Controler.GetBufferState()

    47

    48

    def Undo(self):

    49

        self.Controler.LoadPrevious()

    50

        self.ParentWindow.CloseTabsWithoutModel()

    51

    52

    def Redo(self):

    53

        self.Controler.LoadNext()

    54

        self.ParentWindow.CloseTabsWithoutModel()

    55

    56

    def HasNoModel(self):

    57

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

    58

    59

    60

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

    61

#                            Resource Editor class

    62

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

    63

    64

def GetTasksTableColnames():

    65

    _ = lambda x : x

    66

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

    67

    68

def GetTaskTriggeringOptions():

    69

    _ = lambda x : x

    70

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

    71

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

    72

    73

def GetInstancesTableColnames():

    74

    _ = lambda x : x

    75

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

    76

    77

class ResourceTable(CustomTable):

    78

    79

    """

    80

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

    81

    """

    82

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

    83

        # The base class must be initialized *first*

    84

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

    85

        self.ColAlignements = []

    86

        self.ColSizes = []

    87

    88

    def GetColAlignements(self):

    89

        return self.ColAlignements

    90

    91

    def SetColAlignements(self, list):

    92

        self.ColAlignements = list

    93

    94

    def GetColSizes(self):

    95

        return self.ColSizes

    96

    97

    def SetColSizes(self, list):

    98

        self.ColSizes = list

    99

   100

    def GetValue(self, row, col):

   101

        if row < self.GetNumberRows():

   102

            colname = self.GetColLabelValue(col, False)

   103

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

   104

            if colname == "Triggering":

   105

                return _(value)

   106

            return value

   107

   108

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

   109

        if col < len(self.colnames):

   110

            colname = self.GetColLabelValue(col, False)

   111

            if colname == "Triggering":

   112

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   113

            self.data[row][colname] = value

   114

   115

    def _updateColAttrs(self, grid):

   116

        """

   117

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

   118

        appropriate renderer given the column name.

   119

   120

        Otherwise default to the default renderer.

   121

        """

   122

   123

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

   124

            attr = wx.grid.GridCellAttr()

   125

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

   126

            grid.SetColAttr(col, attr)

   127

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

   128

   129

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

   130

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

   131

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

   132

                editor = None

   133

                renderer = None

   134

                colname = self.GetColLabelValue(col, False)

   135

                grid.SetReadOnly(row, col, False)

   136

                if colname == "Name":

   137

                    editor = wx.grid.GridCellTextEditor()

   138

                    renderer = wx.grid.GridCellStringRenderer()

   139

                elif colname == "Interval":

   140

                    editor = DurationCellEditor(self)

   141

                    renderer = wx.grid.GridCellStringRenderer()

   142

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

   143

                        grid.SetReadOnly(row, col, True)

   144

                elif colname == "Single":

   145

                    editor = wx.grid.GridCellChoiceEditor()

   146

                    editor.SetParameters(self.Parent.VariableList)

   147

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

   148

                        grid.SetReadOnly(row, col, True)

   149

                elif colname == "Triggering":

   150

                    editor = wx.grid.GridCellChoiceEditor()

   151

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

   152

                elif colname == "Type":

   153

                    editor = wx.grid.GridCellChoiceEditor()

   154

                    editor.SetParameters(self.Parent.TypeList)

   155

                elif colname == "Priority":

   156

                    editor = wx.grid.GridCellNumberEditor()

   157

                    editor.SetParameters("0,65535")

   158

                elif colname == "Task":

   159

                    editor = wx.grid.GridCellChoiceEditor()

   160

                    editor.SetParameters(self.Parent.TaskList)

   161

   162

                grid.SetCellEditor(row, col, editor)

   163

                grid.SetCellRenderer(row, col, renderer)

   164

   165

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

   166

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

   167

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

   168

            self.ResizeRow(grid, row)

   169

   170

   171

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

   172

#                        Highlights showing functions

   173

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

   174

   175

    def AddHighlight(self, infos, highlight_type):

   176

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

   177

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

   178

        col_highlights.append(highlight_type)

   179

   180

    def ClearHighlights(self, highlight_type=None):

   181

        if highlight_type is None:

   182

            self.Highlights = {}

   183

        else:

   184

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

   185

                row_items = row_highlights.items()

   186

                for col, col_highlights in row_items:

   187

                    if highlight_type in col_highlights:

   188

                        col_highlights.remove(highlight_type)

   189

                    if len(col_highlights) == 0:

   190

                        row_highlights.pop(col)

   191

   192

   193

   194

class ResourceEditor(EditorPanel):

   195

   196

    VARIABLE_PANEL_TYPE = "resource"

   197

   198

    def _init_Editor(self, parent):

   199

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

   200

   201

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

   202

        main_sizer.AddGrowableCol(0)

   203

        main_sizer.AddGrowableRow(0)

   204

        main_sizer.AddGrowableRow(1)

   205

   206

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

   207

        tasks_sizer.AddGrowableCol(0)

   208

        tasks_sizer.AddGrowableRow(1)

   209

        main_sizer.AddSizer(tasks_sizer, border=5, 

   210

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

   211

   212

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

   213

        tasks_buttons_sizer.AddGrowableCol(0)

   214

        tasks_buttons_sizer.AddGrowableRow(0)

   215

        tasks_sizer.AddSizer(tasks_buttons_sizer, flag=wx.GROW)

   216

   217

        tasks_label = wx.StaticText(self.Editor, label=_(u'Tasks:'))

   218

        tasks_buttons_sizer.AddWindow(tasks_label, flag=wx.ALIGN_BOTTOM)

   219

   220

        for name, bitmap, help in [

   221

                ("AddTaskButton", "add_element", _("Add task")),

   222

                ("DeleteTaskButton", "remove_element", _("Remove task")),

   223

                ("UpTaskButton", "up", _("Move task up")),

   224

                ("DownTaskButton", "down", _("Move task down"))]:

   225

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

   226

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

   227

            button.SetToolTipString(help)

   228

            setattr(self, name, button)

   229

            tasks_buttons_sizer.AddWindow(button)

   230

   231

        self.TasksGrid = CustomGrid(self.Editor, style=wx.VSCROLL)

   232

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

   233

        tasks_sizer.AddWindow(self.TasksGrid, flag=wx.GROW)

   234

   235

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

   236

        instances_sizer.AddGrowableCol(0)

   237

        instances_sizer.AddGrowableRow(1)

   238

        main_sizer.AddSizer(instances_sizer, border=5, 

   239

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

   240

   241

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

   242

        instances_buttons_sizer.AddGrowableCol(0)

   243

        instances_buttons_sizer.AddGrowableRow(0)

   244

        instances_sizer.AddSizer(instances_buttons_sizer, flag=wx.GROW)

   245

   246

        instances_label = wx.StaticText(self.Editor, label=_(u'Instances:'))

   247

        instances_buttons_sizer.AddWindow(instances_label, flag=wx.ALIGN_BOTTOM)

   248

   249

        for name, bitmap, help in [

   250

                ("AddInstanceButton", "add_element", _("Add instance")),

   251

                ("DeleteInstanceButton", "remove_element", _("Remove instance")),

   252

                ("UpInstanceButton", "up", _("Move instance up")),

   253

                ("DownInstanceButton", "down", _("Move instance down"))]:

   254

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

   255

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

   256

            button.SetToolTipString(help)

   257

            setattr(self, name, button)

   258

            instances_buttons_sizer.AddWindow(button)

   259

   260

        self.InstancesGrid = CustomGrid(self.Editor, style=wx.VSCROLL)

   261

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

   262

              self.OnInstancesGridCellChange)

   263

        instances_sizer.AddWindow(self.InstancesGrid, flag=wx.GROW)

   264

   265

        self.Editor.SetSizer(main_sizer)

   266

   267

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

   268

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

   269

   270

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

   271

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

   272

   273

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

   274

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

   275

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

   276

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

   277

        self.TasksGrid.SetTable(self.TasksTable)

   278

        self.TasksGrid.SetButtons({"Add": self.AddTaskButton,

   279

                                   "Delete": self.DeleteTaskButton,

   280

                                   "Up": self.UpTaskButton,

   281

                                   "Down": self.DownTaskButton})

   282

   283

        def _AddTask(new_row):

   284

            self.TasksTable.InsertRow(new_row, self.TasksDefaultValue.copy())

   285

            self.RefreshModel()

   286

            self.RefreshView()

   287

            return new_row

   288

        setattr(self.TasksGrid, "_AddRow", _AddTask)

   289

   290

        def _DeleteTask(row):

   291

            self.TasksTable.RemoveRow(row)

   292

            self.RefreshModel()

   293

            self.RefreshView()

   294

        setattr(self.TasksGrid, "_DeleteRow", _DeleteTask)

   295

   296

        def _MoveTask(row, move):

   297

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

   298

            if new_row != row:

   299

                self.RefreshModel()

   300

                self.RefreshView()

   301

            return new_row

   302

        setattr(self.TasksGrid, "_MoveRow", _MoveTask)

   303

   304

        self.TasksGrid.SetRowLabelSize(0)

   305

        self.TasksTable.ResetView(self.TasksGrid)

   306

        self.TasksGrid.RefreshButtons()

   307

   308

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

   309

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

   310

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

   311

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

   312

        self.InstancesGrid.SetTable(self.InstancesTable)

   313

        self.InstancesGrid.SetButtons({"Add": self.AddInstanceButton,

   314

                                       "Delete": self.DeleteInstanceButton,

   315

                                       "Up": self.UpInstanceButton,

   316

                                       "Down": self.DownInstanceButton})

   317

   318

        def _AddInstance(new_row):

   319

            self.InstancesTable.InsertRow(new_row, self.InstancesDefaultValue.copy())

   320

            self.RefreshModel()

   321

            self.RefreshView()

   322

            return new_row

   323

        setattr(self.InstancesGrid, "_AddRow", _AddInstance)

   324

   325

        def _DeleteInstance(row):

   326

            self.InstancesTable.RemoveRow(row)

   327

            self.RefreshModel()

   328

            self.RefreshView()

   329

        setattr(self.InstancesGrid, "_DeleteRow", _DeleteInstance)

   330

   331

        def _MoveInstance(row, move):

   332

            new_row = max(0, min(row + move, self.InstancesTable.GetNumberRows() - 1))

   333

            if new_row != row:

   334

                if self.InstancesTable.GetValueByName(row, "Task") != self.InstancesTable.GetValueByName(new_row, "Task"):

   335

                    return row 

   336

                self.InstancesTable.MoveRow(row, move)

   337

                self.RefreshModel()

   338

                self.RefreshView()

   339

            return new_row

   340

        setattr(self.InstancesGrid, "_MoveRow", _MoveInstance)

   341

   342

        def _RefreshInstanceButtons():

   343

            if self:

   344

                rows = self.InstancesTable.GetNumberRows()

   345

                row = self.InstancesGrid.GetGridCursorRow()

   346

                self.DeleteInstanceButton.Enable(rows > 0)

   347

                self.UpInstanceButton.Enable(row > 0 and 

   348

                    self.InstancesTable.GetValueByName(row, "Task") == self.InstancesTable.GetValueByName(row - 1, "Task"))

   349

                self.DownInstanceButton.Enable(0 <= row < rows - 1 and 

   350

                    self.InstancesTable.GetValueByName(row, "Task") == self.InstancesTable.GetValueByName(row + 1, "Task"))

   351

        setattr(self.InstancesGrid, "RefreshButtons", _RefreshInstanceButtons)

   352

   353

        self.InstancesGrid.SetRowLabelSize(0)

   354

        self.InstancesTable.ResetView(self.InstancesGrid)

   355

        self.InstancesGrid.RefreshButtons()

   356

   357

        self.TasksGrid.SetFocus()

   358

   359

    def __del__(self):

   360

        self.RefreshHighlightsTimer.Stop()

   361

   362

    def RefreshTypeList(self):

   363

        self.TypeList = ""

   364

        blocktypes = self.Controler.GetBlockResource()

   365

        for blocktype in blocktypes:

   366

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

   367

   368

    def RefreshTaskList(self):

   369

        self.TaskList = ""

   370

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

   371

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

   372

   373

    def RefreshVariableList(self):

   374

        self.VariableList = ""

   375

        for variable in self.Controler.GetEditedResourceVariables(self.TagName):

   376

            self.VariableList += ",%s"%variable

   377

   378

    def RefreshModel(self):

   379

        self.Controler.SetEditedResourceInfos(self.TagName, self.TasksTable.GetData(), self.InstancesTable.GetData())

   380

        self.RefreshBuffer()

   381

   382

    # Buffer the last model state

   383

    def RefreshBuffer(self):

   384

        self.Controler.BufferProject()

   385

        self.ParentWindow.RefreshTitle()

   386

        self.ParentWindow.RefreshFileMenu()

   387

        self.ParentWindow.RefreshEditMenu()

   388

   389

    def GetBufferState(self):

   390

        return self.Controler.GetBufferState()

   391

   392

    def Undo(self):

   393

        self.Controler.LoadPrevious()

   394

        self.ParentWindow.CloseTabsWithoutModel()

   395

   396

    def Redo(self):

   397

        self.Controler.LoadNext()

   398

        self.ParentWindow.CloseTabsWithoutModel()

   399

   400

    def HasNoModel(self):

   401

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

   402

   403

    def RefreshView(self, variablepanel=True):

   404

        EditorPanel.RefreshView(self, variablepanel)

   405

   406

        tasks, instances = self.Controler.GetEditedResourceInfos(self.TagName)

   407

        self.TasksTable.SetData(tasks)

   408

        self.InstancesTable.SetData(instances)

   409

        self.RefreshTypeList()

   410

        self.RefreshTaskList()

   411

        self.RefreshVariableList()

   412

        self.TasksTable.ResetView(self.TasksGrid)

   413

        self.InstancesTable.ResetView(self.InstancesGrid)

   414

        self.TasksGrid.RefreshButtons()

   415

        self.InstancesGrid.RefreshButtons()

   416

   417

    def OnTasksGridCellChange(self, event):

   418

        row, col = event.GetRow(), event.GetCol()

   419

        if self.TasksTable.GetColLabelValue(col) == "Name":

   420

            tasklist = [name for name in self.TaskList.split(",") if name != ""]

   421

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

   422

                task = self.TasksTable.GetValueByName(i, "Name")

   423

                if task in tasklist:

   424

                    tasklist.remove(task)

   425

            if len(tasklist) > 0:

   426

                old_name = tasklist[0]

   427

                new_name = self.TasksTable.GetValue(row, col)

   428

                for i in xrange(self.InstancesTable.GetNumberRows()):

   429

                    if self.InstancesTable.GetValueByName(i, "Task") == old_name:

   430

                        self.InstancesTable.SetValueByName(i, "Task", new_name)

   431

        self.RefreshModel()

   432

        colname = self.TasksTable.GetColLabelValue(col, False)

   433

        if colname in ["Triggering", "Name"]:

   434

            wx.CallAfter(self.RefreshView, False)

   435

        event.Skip()

   436

   437

    def OnInstancesGridCellChange(self, event):

   438

        self.RefreshModel()

   439

        self.ParentWindow.RefreshPouInstanceVariablesPanel()

   440

        self.InstancesGrid.RefreshButtons()

   441

        event.Skip()

   442

   443

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

   444

#                        Highlights showing functions

   445

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

   446

   447

    def OnRefreshHighlightsTimer(self, event):

   448

        self.RefreshView()

   449

        event.Skip()

   450

   451

    def AddHighlight(self, infos, start, end, highlight_type):

   452

        if infos[0] == "task":

   453

            self.TasksTable.AddHighlight(infos[1:], highlight_type)

   454

        elif infos[0] == "instance":

   455

            self.InstancesTable.AddHighlight(infos[1:], highlight_type)

   456

        self.RefreshHighlightsTimer.Start(int(REFRESH_HIGHLIGHT_PERIOD * 1000), oneShot=True)

   457

   458

    def ClearHighlights(self, highlight_type=None):

   459

        EditorPanel.ClearHighlights(self, highlight_type)

   460

   461

        self.TasksTable.ClearHighlights(highlight_type)

   462

        self.InstancesTable.ClearHighlights(highlight_type)

   463

        self.TasksTable.ResetView(self.TasksGrid)

   464

        self.InstancesTable.ResetView(self.InstancesGrid)