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

    27

import wx

    28

import wx.lib.buttons

    29

import wx.grid

    30

    31

from graphics.GraphicCommons import REFRESH_HIGHLIGHT_PERIOD, ERROR_HIGHLIGHT

    32

from controls import CustomGrid, CustomTable, DurationCellEditor

    33

from dialogs.DurationEditorDialog import IEC_TIME_MODEL

    35

from util.BitmapLibrary import GetBitmap

    36

from util.TranslationCatalogs import NoTranslate

    37

from plcopen.structures import TestIdentifier, IEC_KEYWORDS

    38

    39

    40

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

    41

#                          Configuration Editor class

    42

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

    43

    44

    45

[

    46

    ID_CONFIGURATIONEDITOR,

    47

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

    48

    49

    50

class ConfigurationEditor(EditorPanel):

    51

    52

    ID = ID_CONFIGURATIONEDITOR

    53

    VARIABLE_PANEL_TYPE = "config"

    54

    55

    def GetBufferState(self):

    56

        return self.Controler.GetBufferState()

    57

    58

    def Undo(self):

    59

        self.Controler.LoadPrevious()

    60

        self.ParentWindow.CloseTabsWithoutModel()

    61

    62

    def Redo(self):

    63

        self.Controler.LoadNext()

    64

        self.ParentWindow.CloseTabsWithoutModel()

    65

    66

    def HasNoModel(self):

    67

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

    68

    69

    70

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

    71

#                            Resource Editor class

    72

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

    73

    74

def GetTasksTableColnames():

    75

    _ = NoTranslate

    76

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

    77

    78

    79

def GetTaskTriggeringOptions():

    80

    _ = NoTranslate

    81

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

    82

    83

    84

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

    85

    86

    87

def SingleCellEditor(*x):

    88

    return wx.grid.GridCellChoiceEditor()

    89

    90

    91

def CheckSingle(single, varlist):

    92

    return single in varlist

    93

    94

    95

def GetInstancesTableColnames():

    96

    _ = NoTranslate

    97

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

    98

    99

   100

class ResourceTable(CustomTable):

   101

   102

    """

   103

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

   104

    """

   105

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

   106

        # The base class must be initialized *first*

   107

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

   108

        self.ColAlignements = []

   109

        self.ColSizes = []

   110

   111

    def GetColAlignements(self):

   112

        return self.ColAlignements

   113

   114

    def SetColAlignements(self, list):

   115

        self.ColAlignements = list

   116

   117

    def GetColSizes(self):

   118

        return self.ColSizes

   119

   120

    def SetColSizes(self, list):

   121

        self.ColSizes = list

   122

   123

    def GetValue(self, row, col):

   124

        if row < self.GetNumberRows():

   125

            colname = self.GetColLabelValue(col, False)

   126

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

   127

            if colname == "Triggering":

   128

                return _(value)

   129

            return value

   130

   131

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

   132

        if col < len(self.colnames):

   133

            colname = self.GetColLabelValue(col, False)

   134

            if colname == "Triggering":

   135

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   136

            self.data[row][colname] = value

   137

   138

    def _updateColAttrs(self, grid):

   139

        """

   140

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

   141

        appropriate renderer given the column name.

   142

   143

        Otherwise default to the default renderer.

   144

        """

   145

   146

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

   147

            attr = wx.grid.GridCellAttr()

   148

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

   149

            grid.SetColAttr(col, attr)

   150

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

   151

   152

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

   153

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

   154

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

   155

                editor = None

   156

                renderer = None

   157

                error = False

   158

                colname = self.GetColLabelValue(col, False)

   159

                grid.SetReadOnly(row, col, False)

   160

                if colname == "Name":

   161

                    editor = wx.grid.GridCellTextEditor()

   162

                    renderer = wx.grid.GridCellStringRenderer()

   163

                elif colname == "Interval":

   164

                    editor = DurationCellEditor(self, colname)

   165

                    renderer = wx.grid.GridCellStringRenderer()

   166

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

   167

                        grid.SetReadOnly(row, col, True)

   168

                    interval = self.GetValueByName(row, colname)

   169

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

   170

                        error = True

   171

                elif colname == "Single":

   172

                    editor = SingleCellEditor(self, colname)

   173

                    editor.SetParameters(self.Parent.VariableList)

   174

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

   175

                        grid.SetReadOnly(row, col, True)

   176

                    single = self.GetValueByName(row, colname)

   177

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

   178

                        error = True

   179

                elif colname == "Triggering":

   180

                    editor = wx.grid.GridCellChoiceEditor()

   181

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

   182

                elif colname == "Type":

   183

                    editor = wx.grid.GridCellChoiceEditor()

   184

                    editor.SetParameters(self.Parent.TypeList)

   185

                elif colname == "Priority":

   186

                    editor = wx.grid.GridCellNumberEditor()

   187

                    editor.SetParameters("0,65535")

   188

                elif colname == "Task":

   189

                    editor = wx.grid.GridCellChoiceEditor()

   190

                    editor.SetParameters(self.Parent.TaskList)

   191

   192

                grid.SetCellEditor(row, col, editor)

   193

                grid.SetCellRenderer(row, col, renderer)

   194

   195

                if error:

   196

                    highlight_colours = ERROR_HIGHLIGHT

   197

                else:

   198

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

   199

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

   200

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

   201

            self.ResizeRow(grid, row)

   202

   203

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

   204

    #                        Highlights showing functions

   205

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

   206

   207

    def AddHighlight(self, infos, highlight_type):

   208

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

   209

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

   210

        col_highlights.append(highlight_type)

   211

   212

    def ClearHighlights(self, highlight_type=None):

   213

        if highlight_type is None:

   214

            self.Highlights = {}

   215

        else:

   216

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

   217

                row_items = row_highlights.items()

   218

                for col, col_highlights in row_items:

   219

                    if highlight_type in col_highlights:

   220

                        col_highlights.remove(highlight_type)

   221

                    if len(col_highlights) == 0:

   222

                        row_highlights.pop(col)

   223

   224

   225

class ResourceEditor(EditorPanel):

   226

   227

    VARIABLE_PANEL_TYPE = "resource"

   228

   229

    def _init_Editor(self, parent):

   230

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

   231

   232

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

   233

        main_sizer.AddGrowableCol(0)

   234

        main_sizer.AddGrowableRow(0)

   235

        main_sizer.AddGrowableRow(1)

   236

   237

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

   238

        tasks_sizer.AddGrowableCol(0)

   239

        tasks_sizer.AddGrowableRow(1)

   240

        main_sizer.AddSizer(tasks_sizer, border=5,

   241

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

   242

   243

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

   244

        tasks_buttons_sizer.AddGrowableCol(0)

   245

        tasks_buttons_sizer.AddGrowableRow(0)

   246

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

   247

   248

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

   249

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

   250

   251

        for name, bitmap, help in [

   252

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

   253

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

   254

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

   255

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

   256

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

   257

                                                    bitmap=GetBitmap(bitmap),

   258

                                                    size=wx.Size(28, 28),

   259

                                                    style=wx.NO_BORDER)

   260

            button.SetToolTipString(help)

   261

            setattr(self, name, button)

   262

            tasks_buttons_sizer.AddWindow(button)

   263

   264

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

   265

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

   266

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

   267

   268

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

   269

        instances_sizer.AddGrowableCol(0)

   270

        instances_sizer.AddGrowableRow(1)

   271

        main_sizer.AddSizer(instances_sizer, border=5,

   272

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

   273

   274

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

   275

        instances_buttons_sizer.AddGrowableCol(0)

   276

        instances_buttons_sizer.AddGrowableRow(0)

   277

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

   278

   279

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

   280

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

   281

   282

        for name, bitmap, help in [

   283

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

   284

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

   285

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

   286

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

   287

            button = wx.lib.buttons.GenBitmapButton(

   288

                self.Editor, bitmap=GetBitmap(bitmap),

   289

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

   290

            button.SetToolTipString(help)

   291

            setattr(self, name, button)

   292

            instances_buttons_sizer.AddWindow(button)

   293

   294

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

   295

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

   296

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

   297

   298

        self.Editor.SetSizer(main_sizer)

   299

   300

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

   301

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

   302

   303

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

   304

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

   305

   306

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

   307

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

   308

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

   309

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

   310

        self.TasksGrid.SetTable(self.TasksTable)

   311

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

   312

                                   "Delete": self.DeleteTaskButton,

   313

                                   "Up": self.UpTaskButton,

   314

                                   "Down": self.DownTaskButton})

   315

   316

        def _AddTask(new_row):

   317

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

   318

            self.RefreshModel()

   319

            self.RefreshView()

   320

            return new_row

   321

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

   322

   323

        def _DeleteTask(row):

   324

            self.TasksTable.RemoveRow(row)

   325

            self.RefreshModel()

   326

            self.RefreshView()

   327

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

   328

   329

        def _MoveTask(row, move):

   330

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

   331

            if new_row != row:

   332

                self.RefreshModel()

   333

                self.RefreshView()

   334

            return new_row

   335

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

   336

   337

        self.TasksGrid.SetRowLabelSize(0)

   338

        self.TasksTable.ResetView(self.TasksGrid)

   339

        self.TasksGrid.RefreshButtons()

   340

   341

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

   342

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

   343

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

   344

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

   345

        self.InstancesGrid.SetTable(self.InstancesTable)

   346

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

   347

                                       "Delete": self.DeleteInstanceButton,

   348

                                       "Up": self.UpInstanceButton,

   349

                                       "Down": self.DownInstanceButton})

   350

   351

        def _AddInstance(new_row):

   352

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

   353

            self.RefreshModel()

   354

            self.RefreshView()

   355

            return new_row

   356

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

   357

   358

        def _DeleteInstance(row):

   359

            self.InstancesTable.RemoveRow(row)

   360

            self.RefreshModel()

   361

            self.RefreshView()

   362

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

   363

   364

        def _MoveInstance(row, move):

   365

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

   366

            if new_row != row:

   367

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

   368

                    return row

   369

                self.InstancesTable.MoveRow(row, move)

   370

                self.RefreshModel()

   371

                self.RefreshView()

   372

            return new_row

   373

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

   374

   375

        def _RefreshInstanceButtons():

   376

            if self:

   377

                rows = self.InstancesTable.GetNumberRows()

   378

                row = self.InstancesGrid.GetGridCursorRow()

   379

                self.DeleteInstanceButton.Enable(rows > 0)

   380

                self.UpInstanceButton.Enable(

   381

                    row > 0 and

   382

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

   383

                self.DownInstanceButton.Enable(

   384

                    0 <= row < rows - 1 and

   385

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

   386

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

   387

   388

        self.InstancesGrid.SetRowLabelSize(0)

   389

        self.InstancesTable.ResetView(self.InstancesGrid)

   390

        self.InstancesGrid.RefreshButtons()

   391

   392

        self.TasksGrid.SetFocus()

   393

   394

    def __del__(self):

   395

        self.RefreshHighlightsTimer.Stop()

   396

   397

    def RefreshTypeList(self):

   398

        self.TypeList = ""

   399

        blocktypes = self.Controler.GetBlockResource()

   400

        for blocktype in blocktypes:

   401

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

   402

   403

    def RefreshTaskList(self):

   404

        self.TaskList = ""

   405

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

   406

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

   407

   408

    def RefreshVariableList(self):

   409

        self.VariableList = ""

   410

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

   411

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

   412

   413

    def RefreshModel(self):

   414

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

   415

        self.RefreshBuffer()

   416

   417

    # Buffer the last model state

   418

    def RefreshBuffer(self):

   419

        self.Controler.BufferProject()

   420

        self.ParentWindow.RefreshTitle()

   421

        self.ParentWindow.RefreshFileMenu()

   422

        self.ParentWindow.RefreshEditMenu()

   423

   424

    def GetBufferState(self):

   425

        return self.Controler.GetBufferState()

   426

   427

    def Undo(self):

   428

        self.Controler.LoadPrevious()

   429

        self.ParentWindow.CloseTabsWithoutModel()

   430

   431

    def Redo(self):

   432

        self.Controler.LoadNext()

   433

        self.ParentWindow.CloseTabsWithoutModel()

   434

   435

    def HasNoModel(self):

   436

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

   437

   438

    def RefreshView(self, variablepanel=True):

   439

        EditorPanel.RefreshView(self, variablepanel)

   440

   441

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

   442

        self.TasksTable.SetData(tasks)

   443

        self.InstancesTable.SetData(instances)

   444

        self.RefreshTypeList()

   445

        self.RefreshTaskList()

   446

        self.RefreshVariableList()

   447

        self.TasksTable.ResetView(self.TasksGrid)

   448

        self.InstancesTable.ResetView(self.InstancesGrid)

   449

        self.TasksGrid.RefreshButtons()

   450

        self.InstancesGrid.RefreshButtons()

   451

   452

    def ShowErrorMessage(self, message):

   453

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

   454

        dialog.ShowModal()

   455

        dialog.Destroy()

   456

   457

    def OnTasksGridCellChange(self, event):

   458

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

   459

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

   460

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

   461

            message = None

   462

   463

            if not TestIdentifier(value):

   464

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

   465

            elif value.upper() in IEC_KEYWORDS:

   466

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

   467

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

   468

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

   469

            if message is not None:

   470

                event.Veto()

   471

                wx.CallAfter(self.ShowErrorMessage, message)

   472

                return

   473

   474

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

   475

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

   476

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

   477

                if task in tasklist:

   478

                    tasklist.remove(task)

   479

            if len(tasklist) > 0:

   480

                old_name = tasklist[0].upper()

   481

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

   482

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

   483

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

   484

                    if old_name == name:

   485

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

   486

        self.RefreshModel()

   487

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

   488

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

   489

            wx.CallAfter(self.RefreshView, False)

   490

        event.Skip()

   491

   492

    def OnInstancesGridCellChange(self, event):

   493

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

   494

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

   495

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

   496

            message = None

   497

   498

            if not TestIdentifier(value):

   499

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

   500

            elif value.upper() in IEC_KEYWORDS:

   501

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

   502

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

   503

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