1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

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

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 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

from plcopen.structures import LOCATIONDATATYPES, TestIdentifier, IEC_KEYWORDS, DefaultType

    35

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

    36

#                          Configuration Editor class

    37

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

    38

    39

[ID_CONFIGURATIONEDITOR,

    40

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

    41

    42

    43

class ConfigurationEditor(EditorPanel):

    44

    45

    ID = ID_CONFIGURATIONEDITOR

    46

    VARIABLE_PANEL_TYPE = "config"

    47

    48

    def GetBufferState(self):

    49

        return self.Controler.GetBufferState()

    50

    51

    def Undo(self):

    52

        self.Controler.LoadPrevious()

    53

        self.ParentWindow.CloseTabsWithoutModel()

    54

    55

    def Redo(self):

    56

        self.Controler.LoadNext()

    57

        self.ParentWindow.CloseTabsWithoutModel()

    58

    59

    def HasNoModel(self):

    60

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

    61

    62

    63

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

    64

#                            Resource Editor class

    65

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

    66

    67

def GetTasksTableColnames():

    68

    _ = lambda x: x

    69

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

    70

    71

    72

def GetTaskTriggeringOptions():

    73

    _ = lambda x: x

    74

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

    77

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

    78

    79

SingleCellEditor = lambda *x: wx.grid.GridCellChoiceEditor()

    80

    81

    82

def CheckSingle(single, varlist):

    83

    return single in varlist

    84

    85

    86

def GetInstancesTableColnames():

    87

    _ = lambda x: x

    88

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

    89

    90

    91

class ResourceTable(CustomTable):

    92

    93

    """

    94

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

    95

    """

    96

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

    97

        # The base class must be initialized *first*

    98

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

    99

        self.ColAlignements = []

   100

        self.ColSizes = []

   101

   102

    def GetColAlignements(self):

   103

        return self.ColAlignements

   104

   105

    def SetColAlignements(self, list):

   106

        self.ColAlignements = list

   107

   108

    def GetColSizes(self):

   109

        return self.ColSizes

   110

   111

    def SetColSizes(self, list):

   112

        self.ColSizes = list

   113

   114

    def GetValue(self, row, col):

   115

        if row < self.GetNumberRows():

   116

            colname = self.GetColLabelValue(col, False)

   117

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

   118

            if colname == "Triggering":

   119

                return _(value)

   120

            return value

   121

   122

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

   123

        if col < len(self.colnames):

   124

            colname = self.GetColLabelValue(col, False)

   125

            if colname == "Triggering":

   126

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   127

            self.data[row][colname] = value

   128

   129

    def _updateColAttrs(self, grid):

   130

        """

   131

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

   132

        appropriate renderer given the column name.

   133

   134

        Otherwise default to the default renderer.

   135

        """

   136

   137

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

   138

            attr = wx.grid.GridCellAttr()

   139

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

   140

            grid.SetColAttr(col, attr)

   141

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

   142

   143

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

   144

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

   145

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

   146

                editor = None

   147

                renderer = None

   148

                error = False

   149

                colname = self.GetColLabelValue(col, False)

   150

                grid.SetReadOnly(row, col, False)

   151

                if colname == "Name":

   152

                    editor = wx.grid.GridCellTextEditor()

   153

                    renderer = wx.grid.GridCellStringRenderer()

   154

                elif colname == "Interval":

   155

                    editor = DurationCellEditor(self, colname)

   156

                    renderer = wx.grid.GridCellStringRenderer()

   157

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

   158

                        grid.SetReadOnly(row, col, True)

   159

                    interval = self.GetValueByName(row, colname)

   160

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

   161

                        error = True

   162

                elif colname == "Single":

   163

                    editor = SingleCellEditor(self, colname)

   164

                    editor.SetParameters(self.Parent.VariableList)

   165

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

   166

                        grid.SetReadOnly(row, col, True)

   167

                    single = self.GetValueByName(row, colname)

   168

                    if single != "" and not CheckSingle(single, self.Parent.VariableList):

   169

                        error = True

   170

                elif colname == "Triggering":

   171

                    editor = wx.grid.GridCellChoiceEditor()

   172

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

   173

                elif colname == "Type":

   174

                    editor = wx.grid.GridCellChoiceEditor()

   175

                    editor.SetParameters(self.Parent.TypeList)

   176

                elif colname == "Priority":

   177

                    editor = wx.grid.GridCellNumberEditor()

   178

                    editor.SetParameters("0,65535")

   179

                elif colname == "Task":

   180

                    editor = wx.grid.GridCellChoiceEditor()

   181

                    editor.SetParameters(self.Parent.TaskList)

   182

   183

                grid.SetCellEditor(row, col, editor)

   184

                grid.SetCellRenderer(row, col, renderer)

   185

   186

                if error:

   187

                    highlight_colours = ERROR_HIGHLIGHT

   188

                else:

   189

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

   190

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

   191

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

   192

            self.ResizeRow(grid, row)

   193

   194

   195

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

   196

#                        Highlights showing functions

   197

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

   198

   199

    def AddHighlight(self, infos, highlight_type):

   200

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

   201

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

   202

        col_highlights.append(highlight_type)

   203

   204

    def ClearHighlights(self, highlight_type=None):

   205

        if highlight_type is None:

   206

            self.Highlights = {}

   207

        else:

   208

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

   209

                row_items = row_highlights.items()

   210

                for col, col_highlights in row_items:

   211

                    if highlight_type in col_highlights:

   212

                        col_highlights.remove(highlight_type)

   213

                    if len(col_highlights) == 0:

   214

                        row_highlights.pop(col)

   215

   216

   217

class ResourceEditor(EditorPanel):

   218

   219

    VARIABLE_PANEL_TYPE = "resource"

   220

   221

    def _init_Editor(self, parent):

   222

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

   223

   224

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

   225

        main_sizer.AddGrowableCol(0)

   226

        main_sizer.AddGrowableRow(0)

   227

        main_sizer.AddGrowableRow(1)

   228

   229

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

   230

        tasks_sizer.AddGrowableCol(0)

   231

        tasks_sizer.AddGrowableRow(1)

   232

        main_sizer.AddSizer(tasks_sizer, border=5,

   233

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

   234

   235

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

   236

        tasks_buttons_sizer.AddGrowableCol(0)

   237

        tasks_buttons_sizer.AddGrowableRow(0)

   238

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

   239

   240

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

   241

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

   242

   243

        for name, bitmap, help in [

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

            button.SetToolTipString(help)

   251

            setattr(self, name, button)

   252

            tasks_buttons_sizer.AddWindow(button)

   253

   254

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

   255

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

   256

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

   257

   258

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

   259

        instances_sizer.AddGrowableCol(0)

   260

        instances_sizer.AddGrowableRow(1)

   261

        main_sizer.AddSizer(instances_sizer, border=5,

   262

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

   263

   264

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

   265

        instances_buttons_sizer.AddGrowableCol(0)

   266

        instances_buttons_sizer.AddGrowableRow(0)

   267

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

   268

   269

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

   270

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

   271

   272

        for name, bitmap, help in [

   273

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

   274

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

   275

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

   276

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

   277

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

   278

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

   279

            button.SetToolTipString(help)

   280

            setattr(self, name, button)

   281

            instances_buttons_sizer.AddWindow(button)

   282

   283

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

   284

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

   285

              self.OnInstancesGridCellChange)

   286

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

   287

   288

        self.Editor.SetSizer(main_sizer)

   289

   290

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

   291

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

   292

   293

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

   294

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

   295

   296

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

   297

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

   298

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

   299

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

   300

        self.TasksGrid.SetTable(self.TasksTable)

   301

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

   302

                                   "Delete": self.DeleteTaskButton,

   303

                                   "Up": self.UpTaskButton,

   304

                                   "Down": self.DownTaskButton})

   305

   306

        def _AddTask(new_row):

   307

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

   308

            self.RefreshModel()

   309

            self.RefreshView()

   310

            return new_row

   311

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

   312

   313

        def _DeleteTask(row):

   314

            self.TasksTable.RemoveRow(row)

   315

            self.RefreshModel()

   316

            self.RefreshView()

   317

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

   318

   319

        def _MoveTask(row, move):

   320

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

   321

            if new_row != row:

   322

                self.RefreshModel()

   323

                self.RefreshView()

   324

            return new_row

   325

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

   326

   327

        self.TasksGrid.SetRowLabelSize(0)

   328

        self.TasksTable.ResetView(self.TasksGrid)

   329

        self.TasksGrid.RefreshButtons()

   330

   331

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

   332

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

   333

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

   334

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

   335

        self.InstancesGrid.SetTable(self.InstancesTable)

   336

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

   337

                                       "Delete": self.DeleteInstanceButton,

   338

                                       "Up": self.UpInstanceButton,

   339

                                       "Down": self.DownInstanceButton})

   340

   341

        def _AddInstance(new_row):

   342

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

   343

            self.RefreshModel()

   344

            self.RefreshView()

   345

            return new_row

   346

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

   347

   348

        def _DeleteInstance(row):

   349

            self.InstancesTable.RemoveRow(row)

   350

            self.RefreshModel()

   351

            self.RefreshView()

   352

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

   353

   354

        def _MoveInstance(row, move):

   355

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

   356

            if new_row != row:

   357

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

   358

                    return row

   359

                self.InstancesTable.MoveRow(row, move)

   360

                self.RefreshModel()

   361

                self.RefreshView()

   362

            return new_row

   363

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

   364

   365

        def _RefreshInstanceButtons():

   366

            if self:

   367

                rows = self.InstancesTable.GetNumberRows()

   368

                row = self.InstancesGrid.GetGridCursorRow()

   369

                self.DeleteInstanceButton.Enable(rows > 0)

   370

                self.UpInstanceButton.Enable(row > 0 and

   371

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

   372

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

   373

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

   374

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

   375

   376

        self.InstancesGrid.SetRowLabelSize(0)

   377

        self.InstancesTable.ResetView(self.InstancesGrid)

   378

        self.InstancesGrid.RefreshButtons()

   379

   380

        self.TasksGrid.SetFocus()

   381

   382

    def __del__(self):

   383

        self.RefreshHighlightsTimer.Stop()

   384

   385

    def RefreshTypeList(self):

   386

        self.TypeList = ""

   387

        blocktypes = self.Controler.GetBlockResource()

   388

        for blocktype in blocktypes:

   389

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

   390

   391

    def RefreshTaskList(self):

   392

        self.TaskList = ""

   393

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

   394

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

   395

   396

    def RefreshVariableList(self):

   397

        self.VariableList = ""

   398

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

   399

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

   400

   401

    def RefreshModel(self):

   402

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

   403

        self.RefreshBuffer()

   404

   405

    # Buffer the last model state

   406

    def RefreshBuffer(self):

   407

        self.Controler.BufferProject()

   408

        self.ParentWindow.RefreshTitle()

   409

        self.ParentWindow.RefreshFileMenu()

   410

        self.ParentWindow.RefreshEditMenu()

   411

   412

    def GetBufferState(self):

   413

        return self.Controler.GetBufferState()

   414

   415

    def Undo(self):

   416

        self.Controler.LoadPrevious()

   417

        self.ParentWindow.CloseTabsWithoutModel()

   418

   419

    def Redo(self):

   420

        self.Controler.LoadNext()

   421

        self.ParentWindow.CloseTabsWithoutModel()

   422

   423

    def HasNoModel(self):

   424

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

   425

   426

    def RefreshView(self, variablepanel=True):

   427

        EditorPanel.RefreshView(self, variablepanel)

   428

   429

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

   430

        self.TasksTable.SetData(tasks)

   431

        self.InstancesTable.SetData(instances)

   432

        self.RefreshTypeList()

   433

        self.RefreshTaskList()

   434

        self.RefreshVariableList()

   435

        self.TasksTable.ResetView(self.TasksGrid)

   436

        self.InstancesTable.ResetView(self.InstancesGrid)

   437

        self.TasksGrid.RefreshButtons()

   438

        self.InstancesGrid.RefreshButtons()

   439

   440

    def ShowErrorMessage(self, message):

   441

        dialog = wx.MessageDialog(self, message, _("Error"), wx.OK | wx.ICON_ERROR)

   442

        dialog.ShowModal()

   443

        dialog.Destroy()

   444

   445

    def OnTasksGridCellChange(self, event):

   446

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

   447

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

   448

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

   449

            message = None

   450

   451

            if not TestIdentifier(value):

   452

                message = _("\"%s\" is not a valid identifier!") % value

   453

            elif value.upper() in IEC_KEYWORDS:

   454

                message = _("\"%s\" is a keyword. It can't be used!") % value

   455

            elif value.upper() in [var["Name"].upper() for i, var in enumerate(self.TasksTable.data) if i != row]:

   456

                message = _("A task with the same name already exists!")

   457

            if message is not None:

   458

                event.Veto()

   459

                wx.CallAfter(self.ShowErrorMessage, message)

   460

                return

   461

   462

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

   463

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

   464

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

   465

                if task in tasklist:

   466

                    tasklist.remove(task)

   467

            if len(tasklist) > 0:

   468

                old_name = tasklist[0].upper()

   469

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

   470

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

   471

                    name = self.InstancesTable.GetValueByName(i, "Task").upper()

   472

                    if old_name == name:

   473

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

   474

        self.RefreshModel()

   475

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

   476

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

   477

            wx.CallAfter(self.RefreshView, False)

   478

        event.Skip()

   479

   480

    def OnInstancesGridCellChange(self, event):

   481

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

   482

        if self.InstancesTable.GetColLabelValue(col, False) == "Name":

   483

            value = self.InstancesTable.GetValue(row, col)

   484

            message = None

   485

   486

            if not TestIdentifier(value):

   487

                message = _("\"%s\" is not a valid identifier!") % value

   488

            elif value.upper() in IEC_KEYWORDS:

   489

                message = _("\"%s\" is a keyword. It can't be used!") % value

   490

            elif value.upper() in [var["Name"].upper() for i, var in enumerate(self.InstancesTable.data) if i != row]:

   491

                message = _("An instance with the same name already exists!")

   492

            if message is not None:

   493

                event.Veto()

   494

                wx.CallAfter(self.ShowErrorMessage, message)

   495

                return

   496

   497

        self.RefreshModel()

   498

        self.ParentWindow.RefreshPouInstanceVariablesPanel()

   499

        self.InstancesGrid.RefreshButtons()

   500

        event.Skip()

   501

   502

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

   503

#                        Highlights showing functions

   504

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

   505