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 wx

    26

import wx.lib.buttons

    27

import wx.grid

    28

    29

from graphics.GraphicCommons import REFRESH_HIGHLIGHT_PERIOD, ERROR_HIGHLIGHT

    30

from controls import CustomGrid, CustomTable, DurationCellEditor

    31

from dialogs.DurationEditorDialog import IEC_TIME_MODEL

    32

from EditorPanel import EditorPanel

    33

from util.BitmapLibrary import GetBitmap

    34

    35

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

    36

#                          Configuration Editor class

    37

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

    38

    40

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

    41

    42

class ConfigurationEditor(EditorPanel):

    44

    ID = ID_CONFIGURATIONEDITOR

    45

    VARIABLE_PANEL_TYPE = "config"

    47

    def GetBufferState(self):

    48

        return self.Controler.GetBufferState()

    50

    def Undo(self):

    51

        self.Controler.LoadPrevious()

    52

        self.ParentWindow.CloseTabsWithoutModel()

    54

    def Redo(self):

    55

        self.Controler.LoadNext()

    56

        self.ParentWindow.CloseTabsWithoutModel()

    58

    def HasNoModel(self):

    59

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

    60

    61

    62

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

    63

#                            Resource Editor class

    64

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

    65

    66

def GetTasksTableColnames():

    67

    _ = lambda x : x

    68

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

    69

    70

def GetTaskTriggeringOptions():

    71

    _ = lambda x : x

    72

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

    73

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

    74

    75

def GetInstancesTableColnames():

    76

    _ = lambda x : x

    77

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

    78

    79

class ResourceTable(CustomTable):

    81

    """

    82

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

    83

    """

    84

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

    85

        # The base class must be initialized *first*

    86

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

    87

        self.ColAlignements = []

    88

        self.ColSizes = []

    90

    def GetColAlignements(self):

    91

        return self.ColAlignements

    93

    def SetColAlignements(self, list):

    94

        self.ColAlignements = list

    95

    96

    def GetColSizes(self):

    97

        return self.ColSizes

    99

    def SetColSizes(self, list):

   100

        self.ColSizes = list

   101

   102

    def GetValue(self, row, col):

   103

        if row < self.GetNumberRows():

   104

            colname = self.GetColLabelValue(col, False)

   105

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

   106

            if colname == "Triggering":

   107

                return _(value)

   108

            return value

   110

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

   111

        if col < len(self.colnames):

   112

            colname = self.GetColLabelValue(col, False)

   113

            if colname == "Triggering":

   114

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   115

            self.data[row][colname] = value

   119

    def _updateColAttrs(self, grid):

   120

        """

   121

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

   122

        appropriate renderer given the column name.

   123

   124

        Otherwise default to the default renderer.

   125

        """

   127

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

   128

            attr = wx.grid.GridCellAttr()

   129

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

   130

            grid.SetColAttr(col, attr)

   131

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

   133

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

   134

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

   135

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

   136

                editor = None

   137

                renderer = None

   138

                error = False

   139

                colname = self.GetColLabelValue(col, False)

   140

                grid.SetReadOnly(row, col, False)

   141

                if colname == "Name":

   142

                    editor = wx.grid.GridCellTextEditor()

   143

                    renderer = wx.grid.GridCellStringRenderer()

   144

                elif colname == "Interval":

   145

                    editor = DurationCellEditor(self, colname)

   146

                    renderer = wx.grid.GridCellStringRenderer()

   147

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

   148

                        grid.SetReadOnly(row, col, True)

   149

                    interval = self.GetValueByName(row, colname)

   150

                    if interval != "" and IEC_TIME_MODEL.match(interval.upper()) is None:

   151

                        error = True

   152

                elif colname == "Single":

   154

                    editor.SetParameters(self.Parent.VariableList)

   155

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

   156

                        grid.SetReadOnly(row, col, True)

   157

                elif colname == "Triggering":

   158

                    editor = wx.grid.GridCellChoiceEditor()

   159

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

   160

                elif colname == "Type":

   161

                    editor = wx.grid.GridCellChoiceEditor()

   162

                    editor.SetParameters(self.Parent.TypeList)

   163

                elif colname == "Priority":

   164

                    editor = wx.grid.GridCellNumberEditor()

   165

                    editor.SetParameters("0,65535")

   166

                elif colname == "Task":

   167

                    editor = wx.grid.GridCellChoiceEditor()

   168

                    editor.SetParameters(self.Parent.TaskList)

   170

                grid.SetCellEditor(row, col, editor)

   171

                grid.SetCellRenderer(row, col, renderer)

   173

                if error:

   174

                    highlight_colours = ERROR_HIGHLIGHT

   175

                else:

   176

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

   177

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

   178

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

   179

            self.ResizeRow(grid, row)

   180

   182

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

   183

#                        Highlights showing functions

   184

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

   185

   186

    def AddHighlight(self, infos, highlight_type):

   187

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

   188

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

   189

        col_highlights.append(highlight_type)

   191

    def ClearHighlights(self, highlight_type=None):

   192

        if highlight_type is None:

   193

            self.Highlights = {}

   194

        else:

   195

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

   196

                row_items = row_highlights.items()

   197

                for col, col_highlights in row_items:

   198

                    if highlight_type in col_highlights:

   199

                        col_highlights.remove(highlight_type)

   200

                    if len(col_highlights) == 0:

   201

                        row_highlights.pop(col)

   202

   203

   204

   205

class ResourceEditor(EditorPanel):

   207

    VARIABLE_PANEL_TYPE = "resource"

   208

   209

    def _init_Editor(self, parent):

   210

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

   212

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

   213

        main_sizer.AddGrowableCol(0)

   214

        main_sizer.AddGrowableRow(0)

   215

        main_sizer.AddGrowableRow(1)

   217

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

   218

        tasks_sizer.AddGrowableCol(0)

   219

        tasks_sizer.AddGrowableRow(1)

   221

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

   223

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

   224

        tasks_buttons_sizer.AddGrowableCol(0)

   225

        tasks_buttons_sizer.AddGrowableRow(0)

   226

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

   228

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

   229

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

   231

        for name, bitmap, help in [

   232

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

   233

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

   234

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

   235

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

   237

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

   238

            button.SetToolTipString(help)

   239

            setattr(self, name, button)

   240

            tasks_buttons_sizer.AddWindow(button)

   242

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

   243

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

   244

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

   246

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

   247

        instances_sizer.AddGrowableCol(0)

   248

        instances_sizer.AddGrowableRow(1)

   250

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

   252

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

   253

        instances_buttons_sizer.AddGrowableCol(0)

   254

        instances_buttons_sizer.AddGrowableRow(0)

   255

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

   257

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

   258

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

   260

        for name, bitmap, help in [

   261

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

   262

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

   263

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

   264

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

   266

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

   267

            button.SetToolTipString(help)

   268

            setattr(self, name, button)

   269

            instances_buttons_sizer.AddWindow(button)

   271

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

   273

              self.OnInstancesGridCellChange)

   274

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

   276

        self.Editor.SetSizer(main_sizer)

   278

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

   279

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

   281

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

   282

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

   284

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

   285

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

   286

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

   287

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

   288

        self.TasksGrid.SetTable(self.TasksTable)

   289

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

   290

                                   "Delete": self.DeleteTaskButton,

   291

                                   "Up": self.UpTaskButton,

   292

                                   "Down": self.DownTaskButton})

   294

        def _AddTask(new_row):

   295

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

   296

            self.RefreshModel()

   297

            self.RefreshView()

   298

            return new_row

   299

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

   301

        def _DeleteTask(row):

   302

            self.TasksTable.RemoveRow(row)

   303

            self.RefreshModel()

   304

            self.RefreshView()

   305

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

   307

        def _MoveTask(row, move):

   308

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

   309

            if new_row != row:

   310

                self.RefreshModel()

   311

                self.RefreshView()

   312

            return new_row

   313

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

   315

        self.TasksGrid.SetRowLabelSize(0)

   316

        self.TasksTable.ResetView(self.TasksGrid)

   317

        self.TasksGrid.RefreshButtons()

   319

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

   320

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

   321

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

   322

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

   323

        self.InstancesGrid.SetTable(self.InstancesTable)

   324

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

   325

                                       "Delete": self.DeleteInstanceButton,

   326

                                       "Up": self.UpInstanceButton,

   327

                                       "Down": self.DownInstanceButton})

   329

        def _AddInstance(new_row):

   330

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

   331

            self.RefreshModel()

   332

            self.RefreshView()

   333

            return new_row

   334

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

   336

        def _DeleteInstance(row):

   337

            self.InstancesTable.RemoveRow(row)

   338

            self.RefreshModel()

   339

            self.RefreshView()

   340

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

   342

        def _MoveInstance(row, move):

   343

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

   344

            if new_row != row:

   345

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

   347

                self.InstancesTable.MoveRow(row, move)

   348

                self.RefreshModel()

   349

                self.RefreshView()

   350

            return new_row

   351

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

   353

        def _RefreshInstanceButtons():

   354

            if self:

   355

                rows = self.InstancesTable.GetNumberRows()

   356

                row = self.InstancesGrid.GetGridCursorRow()

   357

                self.DeleteInstanceButton.Enable(rows > 0)

   359

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

   361

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

   362

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

   364

        self.InstancesGrid.SetRowLabelSize(0)

   365

        self.InstancesTable.ResetView(self.InstancesGrid)

   366

        self.InstancesGrid.RefreshButtons()

   368

        self.TasksGrid.SetFocus()

   370

    def __del__(self):

   371

        self.RefreshHighlightsTimer.Stop()

   372

   373

    def RefreshTypeList(self):

   374

        self.TypeList = ""

   375

        blocktypes = self.Controler.GetBlockResource()

   376

        for blocktype in blocktypes:

   377

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

   378

   379

    def RefreshTaskList(self):

   380

        self.TaskList = ""

   381

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

   382

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

   383

   384

    def RefreshVariableList(self):

   385

        self.VariableList = ""

   386

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

   387

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

   389

    def RefreshModel(self):

   390

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

   391

        self.RefreshBuffer()

   393

    # Buffer the last model state

   394

    def RefreshBuffer(self):

   395

        self.Controler.BufferProject()

   396

        self.ParentWindow.RefreshTitle()

   397

        self.ParentWindow.RefreshFileMenu()

   398

        self.ParentWindow.RefreshEditMenu()

   399

   400

    def GetBufferState(self):

   401

        return self.Controler.GetBufferState()

   403

    def Undo(self):

   404

        self.Controler.LoadPrevious()

   405

        self.ParentWindow.CloseTabsWithoutModel()

   407

    def Redo(self):

   408

        self.Controler.LoadNext()

   409

        self.ParentWindow.CloseTabsWithoutModel()

   411

    def HasNoModel(self):

   412

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

   413

   414

    def RefreshView(self, variablepanel=True):

   415

        EditorPanel.RefreshView(self, variablepanel)

   417

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

   418

        self.TasksTable.SetData(tasks)

   419

        self.InstancesTable.SetData(instances)

   420

        self.RefreshTypeList()

   421

        self.RefreshTaskList()

   422

        self.RefreshVariableList()

   423

        self.TasksTable.ResetView(self.TasksGrid)

   424

        self.InstancesTable.ResetView(self.InstancesGrid)

   425

        self.TasksGrid.RefreshButtons()

   426

        self.InstancesGrid.RefreshButtons()

   428

    def OnTasksGridCellChange(self, event):

   429

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

   430

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

   431

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

   432

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

   433

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

   434

                if task in tasklist:

   435

                    tasklist.remove(task)

   436

            if len(tasklist) > 0:

   437

                old_name = tasklist[0]

   438

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

   439

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

   440

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

   441

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

   442

        self.RefreshModel()

   443

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

   444

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

   445

            wx.CallAfter(self.RefreshView, False)

   446

        event.Skip()

   447

   448

    def OnInstancesGridCellChange(self, event):

   449

        self.RefreshModel()

   450

        self.ParentWindow.RefreshPouInstanceVariablesPanel()

   451

        self.InstancesGrid.RefreshButtons()

   452

        event.Skip()

   453

   454

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

   455

#                        Highlights showing functions

   456

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

   458

    def OnRefreshHighlightsTimer(self, event):

   459

        self.RefreshView()

   460

        event.Skip()

   462

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

   463

        EditorPanel.AddHighlight(self, infos, start, end, highlight_type)

   465

        if infos[0] == "task":

   466

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

   467

        elif infos[0] == "instance":

   468

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

   469

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

   470

   471

    def ClearHighlights(self, highlight_type=None):

   472

        EditorPanel.ClearHighlights(self, highlight_type)

   474

        self.TasksTable.ClearHighlights(highlight_type)

   475

        self.InstancesTable.ClearHighlights(highlight_type)

   476

        self.TasksTable.ResetView(self.TasksGrid)

   477

        self.InstancesTable.ResetView(self.InstancesGrid)