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

    26

from __future__ import absolute_import

    27

import wx

    28

import wx.lib.buttons

    29

import wx.grid

    30

from six.moves import xrange

    31

    32

from graphics.GraphicCommons import REFRESH_HIGHLIGHT_PERIOD, ERROR_HIGHLIGHT

    33

from controls import CustomGrid, CustomTable, DurationCellEditor

    34

from dialogs.DurationEditorDialog import IEC_TIME_MODEL

    35

from editors.EditorPanel import EditorPanel

    36

from util.BitmapLibrary import GetBitmap

    37

from util.TranslationCatalogs import NoTranslate

    38

from plcopen.structures import TestIdentifier, IEC_KEYWORDS

    39

    40

    41

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

    42

#                          Configuration Editor class

    43

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

    44

    45

    46

[

    47

    ID_CONFIGURATIONEDITOR,

    48

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

    49

    50

    51

class ConfigurationEditor(EditorPanel):

    52

    53

    ID = ID_CONFIGURATIONEDITOR

    54

    VARIABLE_PANEL_TYPE = "config"

    55

    56

    def GetBufferState(self):

    57

        return self.Controler.GetBufferState()

    58

    59

    def Undo(self):

    60

        self.Controler.LoadPrevious()

    61

        self.ParentWindow.CloseTabsWithoutModel()

    62

    63

    def Redo(self):

    64

        self.Controler.LoadNext()

    65

        self.ParentWindow.CloseTabsWithoutModel()

    66

    67

    def HasNoModel(self):

    68

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

    69

    70

    71

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

    72

#                            Resource Editor class

    73

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

    74

    75

def GetTasksTableColnames():

    76

    _ = NoTranslate

    77

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

    78

    79

    80

def GetTaskTriggeringOptions():

    81

    _ = NoTranslate

    82

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

    83

    84

    85

def SingleCellEditor(*x):

    86

    return wx.grid.GridCellChoiceEditor()

    87

    88

    89

def CheckSingle(single, varlist):

    90

    return single in varlist

    91

    92

    93

def GetInstancesTableColnames():

    94

    _ = NoTranslate

    95

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

    96

    97

    98

class ResourceTable(CustomTable):

    99

    """

   100

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

   101

    """

   102

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

   103

        # The base class must be initialized *first*

   104

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

   105

        self.ColAlignements = []

   106

        self.ColSizes = []

   107

        self.TASKTRIGGERINGOPTIONS_DICT = dict([(_(option), option)

   108

                                                for option in GetTaskTriggeringOptions()])

   109

   110

    def GetColAlignements(self):

   111

        return self.ColAlignements

   112

   113

    def SetColAlignements(self, list):

   114

        self.ColAlignements = list

   115

   116

    def GetColSizes(self):

   117

        return self.ColSizes

   118

   119

    def SetColSizes(self, list):

   120

        self.ColSizes = list

   121

   122

    def GetValue(self, row, col):

   123

        if row < self.GetNumberRows():

   124

            colname = self.GetColLabelValue(col, False)

   125

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

   126

            if colname == "Triggering":

   127

                return _(value)

   128

            return value

   129

   130

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

   131

        if col < len(self.colnames):

   132

            colname = self.GetColLabelValue(col, False)

   133

            if colname == "Triggering":

   134

                value = self.TASKTRIGGERINGOPTIONS_DICT[value]

   135

            self.data[row][colname] = value

   136

   137

    def _updateColAttrs(self, grid):

   138

        """

   139

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

   140

        appropriate renderer given the column name.

   141

   142

        Otherwise default to the default renderer.

   143

        """

   144

   145

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

   146

            attr = wx.grid.GridCellAttr()

   147

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

   148

            grid.SetColAttr(col, attr)

   149

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

   150

   151

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

   152

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

   153

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

   154

                editor = None

   155

                renderer = None

   156

                error = False

   157

                colname = self.GetColLabelValue(col, False)

   158

                grid.SetReadOnly(row, col, False)

   159

                if colname == "Name":

   160

                    editor = wx.grid.GridCellTextEditor()

   161

                    renderer = wx.grid.GridCellStringRenderer()

   162

                elif colname == "Interval":

   163

                    editor = DurationCellEditor(self, colname)

   164

                    renderer = wx.grid.GridCellStringRenderer()

   165

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

   166

                        grid.SetReadOnly(row, col, True)

   167

                    interval = self.GetValueByName(row, colname)

   168

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

   169

                        error = True

   170

                elif colname == "Single":

   171

                    editor = SingleCellEditor(self, colname)

   172

                    editor.SetParameters(self.Parent.VariableList)

   173

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

   174

                        grid.SetReadOnly(row, col, True)

   175

                    single = self.GetValueByName(row, colname)

   176

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

   177

                        error = True

   178

                elif colname == "Triggering":

   179

                    editor = wx.grid.GridCellChoiceEditor()

   180

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

   181

                elif colname == "Type":

   182

                    editor = wx.grid.GridCellChoiceEditor()

   183

                    editor.SetParameters(self.Parent.TypeList)

   184

                elif colname == "Priority":

   185

                    editor = wx.grid.GridCellNumberEditor()

   186

                    editor.SetParameters("0,65535")

   187

                elif colname == "Task":

   188

                    editor = wx.grid.GridCellChoiceEditor()

   189

                    editor.SetParameters(self.Parent.TaskList)

   190

   191

                grid.SetCellEditor(row, col, editor)

   192

                grid.SetCellRenderer(row, col, renderer)

   193

   194

                if error:

   195

                    highlight_colours = ERROR_HIGHLIGHT

   196

                else:

   197

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

   198

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

   199

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

   200

            self.ResizeRow(grid, row)

   201

   202

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

   203

    #                        Highlights showing functions

   204

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

   205

   206

    def AddHighlight(self, infos, highlight_type):

   207

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

   208

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

   209

        col_highlights.append(highlight_type)

   210

   211

    def ClearHighlights(self, highlight_type=None):

   212

        if highlight_type is None:

   213

            self.Highlights = {}

   214

        else:

   215

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

   216

                row_items = row_highlights.items()

   217

                for col, col_highlights in row_items:

   218

                    if highlight_type in col_highlights:

   219

                        col_highlights.remove(highlight_type)

   220

                    if len(col_highlights) == 0:

   221

                        row_highlights.pop(col)

   222

   223

   224

class ResourceEditor(EditorPanel):

   225

   226

    VARIABLE_PANEL_TYPE = "resource"

   227

   228

    def _init_Editor(self, parent):

   229

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

   230

   231

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

   232

        main_sizer.AddGrowableCol(0)

   233

        main_sizer.AddGrowableRow(0)

   234

        main_sizer.AddGrowableRow(1)

   235

   236

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

   237

        tasks_sizer.AddGrowableCol(0)

   238

        tasks_sizer.AddGrowableRow(1)

   239

        main_sizer.AddSizer(tasks_sizer, border=5,

   240

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

   241

   242

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

   243

        tasks_buttons_sizer.AddGrowableCol(0)

   244

        tasks_buttons_sizer.AddGrowableRow(0)

   245

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

   246

   247

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

   248

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

   249

   250

        for name, bitmap, help in [

   251

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

   252

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

   253

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

   254

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

   255

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

   256

                                                    bitmap=GetBitmap(bitmap),

   257

                                                    size=wx.Size(28, 28),

   258

                                                    style=wx.NO_BORDER)

   259

            button.SetToolTipString(help)

   260

            setattr(self, name, button)

   261

            tasks_buttons_sizer.AddWindow(button)

   262

   263

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

   264

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

   265

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

   266

   267

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

   268

        instances_sizer.AddGrowableCol(0)

   269

        instances_sizer.AddGrowableRow(1)

   270

        main_sizer.AddSizer(instances_sizer, border=5,

   271

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

   272

   273

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

   274

        instances_buttons_sizer.AddGrowableCol(0)

   275

        instances_buttons_sizer.AddGrowableRow(0)

   276

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

   277

   278

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

   279

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

   280

   281

        for name, bitmap, help in [

   282

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

   283

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

   284

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

   285

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

   286

            button = wx.lib.buttons.GenBitmapButton(

   287

                self.Editor, bitmap=GetBitmap(bitmap),

   288

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

   289

            button.SetToolTipString(help)

   290

            setattr(self, name, button)

   291

            instances_buttons_sizer.AddWindow(button)

   292

   293

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

   294

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

   295

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

   296

   297

        self.Editor.SetSizer(main_sizer)

   298

   299

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

   300

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

   301

   302

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

   303

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

   304

   305

        self.TasksDefaultValue = {"Name": "task0", "Triggering": "Cyclic",

   306

                                  "Single": "", "Interval": "T#20ms", "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

            if new_row > 0:

   318

                row_content = self.TasksTable.data[new_row-1].copy()

   319

                old_name = row_content['Name']

   320

                row_content['Name'] =\

   321

                    self.Controler.GenerateNewName(self.TagName, old_name, old_name+'%d')

   322

            else:

   323

                row_content = self.TasksDefaultValue.copy()

   324

   325

            self.TasksTable.InsertRow(new_row, row_content)

   326

            self.RefreshModel()

   327

            self.RefreshView()

   328

            return new_row

   329

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

   330

   331

        def _DeleteTask(row):

   332

            self.TasksTable.RemoveRow(row)

   333

            self.RefreshModel()

   334

            self.RefreshView()

   335

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

   336

   337

        def _MoveTask(row, move):

   338

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

   339

            if new_row != row:

   340

                self.RefreshModel()

   341

                self.RefreshView()

   342

            return new_row

   343

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

   344

   345

        self.TasksGrid.SetRowLabelSize(0)

   346

        self.TasksTable.ResetView(self.TasksGrid)

   347

        self.TasksGrid.RefreshButtons()

   348

   349

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

   350

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

   351

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

   352

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

   353

        self.InstancesGrid.SetTable(self.InstancesTable)

   354

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

   355

                                       "Delete": self.DeleteInstanceButton,

   356

                                       "Up": self.UpInstanceButton,

   357

                                       "Down": self.DownInstanceButton})

   358

   359

        def _AddInstance(new_row):

   360

            if new_row > 0:

   361

                row_content = self.InstancesTable.data[new_row - 1].copy()

   362

                old_name = row_content['Name']

   363

                row_content['Name'] =\

   364

                    self.Controler.GenerateNewName(self.TagName, old_name, old_name+'%d')

   365

            else:

   366

                row_content = self.InstancesDefaultValue.copy()

   367

   368

            self.InstancesTable.InsertRow(new_row, row_content)

   369

            self.RefreshModel()

   370

            self.RefreshView()

   371

            return new_row

   372

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

   373

   374

        def _DeleteInstance(row):

   375

            self.InstancesTable.RemoveRow(row)

   376

            self.RefreshModel()

   377

            self.RefreshView()

   378

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

   379

   380

        def _MoveInstance(row, move):

   381

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

   382

            if new_row != row:

   383

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

   384

                    return row

   385

                self.InstancesTable.MoveRow(row, move)

   386

                self.RefreshModel()

   387

                self.RefreshView()

   388

            return new_row

   389

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

   390

   391

        def _RefreshInstanceButtons():

   392

            if self:

   393

                rows = self.InstancesTable.GetNumberRows()

   394

                row = self.InstancesGrid.GetGridCursorRow()

   395

                self.DeleteInstanceButton.Enable(rows > 0)

   396

                self.UpInstanceButton.Enable(

   397

                    row > 0 and

   398

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

   399

                self.DownInstanceButton.Enable(

   400

                    0 <= row < rows - 1 and

   401

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

   402

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

   403

   404

        self.InstancesGrid.SetRowLabelSize(0)

   405

        self.InstancesTable.ResetView(self.InstancesGrid)

   406

        self.InstancesGrid.RefreshButtons()

   407

   408

        self.TasksGrid.SetFocus()

   409

   410

    def __del__(self):

   411

        self.RefreshHighlightsTimer.Stop()

   412

   413

    def RefreshTypeList(self):

   414

        self.TypeList = ""

   415

        blocktypes = self.Controler.GetBlockResource()

   416

        for blocktype in blocktypes:

   417

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

   418

   419

    def RefreshTaskList(self):

   420

        self.TaskList = ""

   421

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

   422

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

   423

   424

    def RefreshVariableList(self):

   425

        self.VariableList = ""

   426

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

   427

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

   428

   429

    def RefreshModel(self):

   430

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

   431

        self.RefreshBuffer()

   432

   433

    # Buffer the last model state

   434

    def RefreshBuffer(self):

   435

        self.Controler.BufferProject()

   436

        self.ParentWindow.RefreshTitle()

   437

        self.ParentWindow.RefreshFileMenu()

   438

        self.ParentWindow.RefreshEditMenu()

   439

   440

    def GetBufferState(self):

   441

        return self.Controler.GetBufferState()

   442

   443

    def Undo(self):

   444

        self.Controler.LoadPrevious()

   445

        self.ParentWindow.CloseTabsWithoutModel()

   446

   447

    def Redo(self):

   448

        self.Controler.LoadNext()

   449

        self.ParentWindow.CloseTabsWithoutModel()

   450

   451

    def HasNoModel(self):

   452

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

   453

   454

    def RefreshView(self, variablepanel=True):

   455

        EditorPanel.RefreshView(self, variablepanel)

   456

   457

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

   458

        self.TasksTable.SetData(tasks)

   459

        self.InstancesTable.SetData(instances)

   460

        self.RefreshTypeList()

   461

        self.RefreshTaskList()

   462

        self.RefreshVariableList()

   463

        self.TasksTable.ResetView(self.TasksGrid)

   464

        self.InstancesTable.ResetView(self.InstancesGrid)

   465

        self.TasksGrid.RefreshButtons()

   466

        self.InstancesGrid.RefreshButtons()

   467

   468

    def ShowErrorMessage(self, message):

   469

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

   470

        dialog.ShowModal()

   471

        dialog.Destroy()

   472

   473

    def OnTasksGridCellChange(self, event):

   474

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

   475

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

   476

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

   477

            message = None

   478

   479

            if not TestIdentifier(value):

   480

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

   481

            elif value.upper() in IEC_KEYWORDS:

   482

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

   483

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

   484

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

   485

            if message is not None:

   486

                event.Veto()

   487

                wx.CallAfter(self.ShowErrorMessage, message)

   488

                return

   489

   490

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

   491

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

   492

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

   493

                if task in tasklist:

   494

                    tasklist.remove(task)

   495

            if len(tasklist) > 0:

   496

                old_name = tasklist[0].upper()

   497

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

   498

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

   499

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

   500

                    if old_name == name:

   501

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

   502

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

   503