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

class ConfigurationEditor(EditorPanel):

    47

    48

    VARIABLE_PANEL_TYPE = "config"

    49

    50

    def GetBufferState(self):

    51

        return self.Controler.GetBufferState()

    52

    53

    def Undo(self):

    54

        self.Controler.LoadPrevious()

    55

        self.ParentWindow.CloseTabsWithoutModel()

    56

    57

    def Redo(self):

    58

        self.Controler.LoadNext()

    59

        self.ParentWindow.CloseTabsWithoutModel()

    60

    61

    def HasNoModel(self):

    62

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

    63

    64

    65

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

    66

#                            Resource Editor class

    67

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

    68

    69

def GetTasksTableColnames():

    70

    _ = NoTranslate

    71

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

    72

    73

    74

def GetTaskTriggeringOptions():

    75

    _ = NoTranslate

    76

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

    77

    78

    79

def CheckSingle(single, varlist):

    80

    return single in varlist

    81

    82

    83

def GetInstancesTableColnames():

    84

    _ = NoTranslate

    85

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

    86

    87

    88

class ResourceTable(CustomTable):

    89

    """

    90

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

    91

    """

    92

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

    93

        # The base class must be initialized *first*

    94

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

    95

        self.ColAlignements = []

    96

        self.ColSizes = []

    97

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

    98

                                                for option in GetTaskTriggeringOptions()])

    99

   100

    def GetColAlignements(self):

   101

        return self.ColAlignements

   102

   103

    def SetColAlignements(self, list):

   104

        self.ColAlignements = list

   105

   106

    def GetColSizes(self):

   107

        return self.ColSizes

   108

   109

    def SetColSizes(self, list):

   110

        self.ColSizes = list

   111

   112

    def GetValue(self, row, col):

   113

        if row < self.GetNumberRows():

   114

            colname = self.GetColLabelValue(col, False)

   115

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

   116

            if colname == "Triggering":

   117

                return _(value)

   118

            return value

   119

   120

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

   121

        if col < len(self.colnames):

   122

            colname = self.GetColLabelValue(col, False)

   123

            if colname == "Triggering":

   124

                value = self.TASKTRIGGERINGOPTIONS_DICT[value]

   125

            self.data[row][colname] = value

   126

   127

    def _updateColAttrs(self, grid):

   128

        """

   129

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

   130

        appropriate renderer given the column name.

   131

   132

        Otherwise default to the default renderer.

   133

        """

   134

   135

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

   136

            attr = wx.grid.GridCellAttr()

   137

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

   138

            grid.SetColAttr(col, attr)

   139

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

   140

   141

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

   142

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

   143

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

   144

                editor = None

   145

                renderer = None

   146

                error = False

   147

                colname = self.GetColLabelValue(col, False)

   148

                grid.SetReadOnly(row, col, False)

   149

                if colname == "Name":

   150

                    editor = wx.grid.GridCellTextEditor()

   151

                    renderer = wx.grid.GridCellStringRenderer()

   152

                elif colname == "Interval":

   153

                    editor = DurationCellEditor(self, colname)

   154

                    renderer = wx.grid.GridCellStringRenderer()

   155

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

   156

                        grid.SetReadOnly(row, col, True)

   157

                    interval = self.GetValueByName(row, colname)

   158

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

   159

                        error = True

   160

                elif colname == "Single":

   161

                    editor = wx.grid.GridCellChoiceEditor(self.Parent.VariableList)

   162

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

   163

                        grid.SetReadOnly(row, col, True)

   164

                    single = self.GetValueByName(row, colname)

   165

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

   166

                        error = True

   167

                elif colname == "Triggering":

   168

                    editor = wx.grid.GridCellChoiceEditor(map(_, GetTaskTriggeringOptions()))

   169

                elif colname == "Type":

   170

                    editor = wx.grid.GridCellChoiceEditor(self.Parent.TypeList)

   171

                elif colname == "Priority":

   172

                    editor = wx.grid.GridCellNumberEditor()

   173

                    editor.SetParameters("0,65535")

   174

                elif colname == "Task":

   175

                    editor = wx.grid.GridCellChoiceEditor(self.Parent.TaskList)

   176

   177

                grid.SetCellEditor(row, col, editor)

   178

                grid.SetCellRenderer(row, col, renderer)

   179

   180

                if error:

   181

                    highlight_colours = ERROR_HIGHLIGHT

   182

                else:

   183

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

   184

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

   185

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

   186

            self.ResizeRow(grid, row)

   187

   188

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

   189

    #                        Highlights showing functions

   190

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

   191

   192

    def AddHighlight(self, infos, highlight_type):

   193

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

   194

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

   195

        col_highlights.append(highlight_type)

   196

   197

    def ClearHighlights(self, highlight_type=None):

   198

        if highlight_type is None:

   199

            self.Highlights = {}

   200

        else:

   201

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

   202

                row_items = row_highlights.items()

   203

                for col, col_highlights in row_items:

   204

                    if highlight_type in col_highlights:

   205

                        col_highlights.remove(highlight_type)

   206

                    if len(col_highlights) == 0:

   207

                        row_highlights.pop(col)

   208

   209

   210

class ResourceEditor(EditorPanel):

   211

   212

    VARIABLE_PANEL_TYPE = "resource"

   213

   214

    def _init_Editor(self, parent):

   215

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

   216

   217

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

   218

        main_sizer.AddGrowableCol(0)

   219

        main_sizer.AddGrowableRow(0)

   220

        main_sizer.AddGrowableRow(1)

   221

   222

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

   223

        tasks_sizer.AddGrowableCol(0)

   224

        tasks_sizer.AddGrowableRow(1)

   225

        main_sizer.Add(tasks_sizer, border=5,

   226

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

   227

   228

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

   229

        tasks_buttons_sizer.AddGrowableCol(0)

   230

        tasks_buttons_sizer.AddGrowableRow(0)

   231

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

   232

   233

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

   234

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

   235

   236

        for name, bitmap, help in [

   237

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

   238

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

   239

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

   240

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

   241

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

   242

                                                    bitmap=GetBitmap(bitmap),

   243

                                                    size=wx.Size(28, 28),

   244

                                                    style=wx.NO_BORDER)

   245

            button.SetToolTip(help)

   246

            setattr(self, name, button)

   247

            tasks_buttons_sizer.Add(button)

   248

   249

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

   250

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

   251

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

   252

   253

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

   254

        instances_sizer.AddGrowableCol(0)

   255

        instances_sizer.AddGrowableRow(1)

   256

        main_sizer.Add(instances_sizer, border=5,

   257

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

   258

   259

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

   260

        instances_buttons_sizer.AddGrowableCol(0)

   261

        instances_buttons_sizer.AddGrowableRow(0)

   262

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

   263

   264

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

   265

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

   266

   267

        for name, bitmap, help in [

   268

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

   269

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

   270

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

   271

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

   272

            button = wx.lib.buttons.GenBitmapButton(

   273

                self.Editor, bitmap=GetBitmap(bitmap),

   274

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

   275

            button.SetToolTip(help)

   276

            setattr(self, name, button)

   277

            instances_buttons_sizer.Add(button)

   278

   279

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

   280

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

   281

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

   282

   283

        self.Editor.SetSizer(main_sizer)

   284

   285

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

   286

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

   287

   288

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

   289

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

   290

   291

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

   292

                                  "Single": "", "Interval": "T#20ms", "Priority": 0}

   293

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

   294

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

   295

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

   296

        self.TasksGrid.SetTable(self.TasksTable)

   297

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

   298

                                   "Delete": self.DeleteTaskButton,

   299

                                   "Up": self.UpTaskButton,

   300

                                   "Down": self.DownTaskButton})

   301

   302

        def _AddTask(new_row):

   303

            if new_row > 0:

   304

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

   305

                old_name = row_content['Name']

   306

                row_content['Name'] =\

   307

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

   308

            else:

   309

                row_content = self.TasksDefaultValue.copy()

   310

   311

            self.TasksTable.InsertRow(new_row, row_content)

   312

            self.RefreshModel()

   313

            self.RefreshView()

   314

            return new_row

   315

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

   316

   317

        def _DeleteTask(row):

   318

            self.TasksTable.RemoveRow(row)

   319

            self.RefreshModel()

   320

            self.RefreshView()

   321

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

   322

   323

        def _MoveTask(row, move):

   324

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

   325

            if new_row != row:

   326

                self.RefreshModel()

   327

                self.RefreshView()

   328

            return new_row

   329

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

   330

   331

        self.TasksGrid.SetRowLabelSize(0)

   332

        self.TasksTable.ResetView(self.TasksGrid)

   333

        self.TasksGrid.RefreshButtons()

   334

   335

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

   336

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

   337

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

   338

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

   339

        self.InstancesGrid.SetTable(self.InstancesTable)

   340

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

   341

                                       "Delete": self.DeleteInstanceButton,

   342

                                       "Up": self.UpInstanceButton,

   343

                                       "Down": self.DownInstanceButton})

   344

   345

        def _AddInstance(new_row):

   346

            if new_row > 0:

   347

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

   348

                old_name = row_content['Name']

   349

                row_content['Name'] =\

   350

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

   351

            else:

   352

                row_content = self.InstancesDefaultValue.copy()

   353

   354

            self.InstancesTable.InsertRow(new_row, row_content)

   355

            self.RefreshModel()

   356

            self.RefreshView()

   357

            return new_row

   358

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

   359

   360

        def _DeleteInstance(row):

   361

            self.InstancesTable.RemoveRow(row)

   362

            self.RefreshModel()

   363

            self.RefreshView()

   364

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

   365

   366

        def _MoveInstance(row, move):

   367

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

   368

            if new_row != row:

   369

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

   370

                    return row

   371

                self.InstancesTable.MoveRow(row, move)

   372

                self.RefreshModel()

   373

                self.RefreshView()

   374

            return new_row

   375

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

   376

   377

        def _RefreshInstanceButtons():

   378

            if self:

   379

                rows = self.InstancesTable.GetNumberRows()

   380

                row = self.InstancesGrid.GetGridCursorRow()

   381

                self.DeleteInstanceButton.Enable(rows > 0)

   382

                self.UpInstanceButton.Enable(

   383

                    row > 0 and

   384

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

   385

                self.DownInstanceButton.Enable(

   386

                    0 <= row < rows - 1 and

   387

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

   388

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

   389

   390

        self.InstancesGrid.SetRowLabelSize(0)

   391

        self.InstancesTable.ResetView(self.InstancesGrid)

   392

        self.InstancesGrid.RefreshButtons()

   393

   394

        self.TasksGrid.SetFocus()

   395

   396

    def __del__(self):

   397

        self.RefreshHighlightsTimer.Stop()

   398

   399

    def RefreshTypeList(self):

   400

        self.TypeList = []

   401

        blocktypes = self.Controler.GetBlockResource()

   402

        for blocktype in blocktypes:

   403

            self.TypeList.append(blocktype)

   404

   405

    def RefreshTaskList(self):

   406

        self.TaskList = []

   407

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

   408

            self.TaskList.append(self.TasksTable.GetValueByName(row, "Name"))

   409

   410

    def RefreshVariableList(self):

   411

        self.VariableList = []

   412

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

   413

            self.VariableList.append(variable)

   414

   415

    def RefreshModel(self):

   416

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

   417

        self.RefreshBuffer()

   418

   419

    # Buffer the last model state

   420

    def RefreshBuffer(self):

   421

        self.Controler.BufferProject()

   422

        self.ParentWindow.RefreshTitle()

   423

        self.ParentWindow.RefreshFileMenu()

   424

        self.ParentWindow.RefreshEditMenu()

   425

   426

    def GetBufferState(self):

   427

        return self.Controler.GetBufferState()

   428

   429

    def Undo(self):

   430

        self.Controler.LoadPrevious()

   431

        self.ParentWindow.CloseTabsWithoutModel()

   432

   433

    def Redo(self):

   434

        self.Controler.LoadNext()

   435

        self.ParentWindow.CloseTabsWithoutModel()

   436

   437

    def HasNoModel(self):

   438

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

   439

   440

    def RefreshView(self, variablepanel=True):

   441

        EditorPanel.RefreshView(self, variablepanel)

   442

   443

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

   444

        self.TasksTable.SetData(tasks)

   445

        self.InstancesTable.SetData(instances)

   446

        self.RefreshTypeList()

   447

        self.RefreshTaskList()

   448

        self.RefreshVariableList()

   449

        self.TasksTable.ResetView(self.TasksGrid)

   450

        self.InstancesTable.ResetView(self.InstancesGrid)

   451

        self.TasksGrid.RefreshButtons()

   452

        self.InstancesGrid.RefreshButtons()

   453

   454

    def ShowErrorMessage(self, message):

   455

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

   456

        dialog.ShowModal()

   457

        dialog.Destroy()

   458

   459

    def OnTasksGridCellChange(self, event):

   460

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

   461

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

   462

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

   463

            message = None

   464

   465

            if not TestIdentifier(value):

   466

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

   467

            elif value.upper() in IEC_KEYWORDS:

   468

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

   469

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

   470

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

   471

            if message is not None:

   472

                event.Veto()

   473

                wx.CallAfter(self.ShowErrorMessage, message)

   474

                return

   475

   476

            tasklist = [name for name in self.TaskList if name != ""]

   477

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

   478

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

   479

                if task in tasklist:

   480

                    tasklist.remove(task)

   481

            if len(tasklist) > 0:

   482

                old_name = tasklist[0].upper()

   483

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

   484

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

   485

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

   486

                    if old_name == name:

   487

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

   488

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

   489

            self.TasksTable.SetValueByName(row, "Interval", "T#20ms")

   490

        self.RefreshModel()

   491

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

   492

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

   493

            wx.CallAfter(self.RefreshView, False)

   494

        event.Skip()

   495

   496

    def OnInstancesGridCellChange(self, event):

   497

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

   498

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

   499

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

   500

            message = None