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 SingleCellEditor(*x):

    80

    return wx.grid.GridCellChoiceEditor()

    81

    82

    83

def CheckSingle(single, varlist):

    84

    return single in varlist

    85

    86

    87

def GetInstancesTableColnames():

    88

    _ = NoTranslate

    89

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

    90

    91

    92

class ResourceTable(CustomTable):

    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

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

   102

                                                for option in GetTaskTriggeringOptions()])

   103

   104

    def GetColAlignements(self):

   105

        return self.ColAlignements

   106

   107

    def SetColAlignements(self, list):

   108

        self.ColAlignements = list

   109

   110

    def GetColSizes(self):

   111

        return self.ColSizes

   112

   113

    def SetColSizes(self, list):

   114

        self.ColSizes = list

   115

   116

    def GetValue(self, row, col):

   117

        if row < self.GetNumberRows():

   118

            colname = self.GetColLabelValue(col, False)

   119

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

   120

            if colname == "Triggering":

   121

                return _(value)

   122

            return value

   123

   124

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

   125

        if col < len(self.colnames):

   126

            colname = self.GetColLabelValue(col, False)

   127

            if colname == "Triggering":

   128

                value = self.TASKTRIGGERINGOPTIONS_DICT[value]

   129

            self.data[row][colname] = value

   130

   131

    def _updateColAttrs(self, grid):

   132

        """

   133

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

   134

        appropriate renderer given the column name.

   135

   136

        Otherwise default to the default renderer.

   137

        """

   138

   139

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

   140

            attr = wx.grid.GridCellAttr()

   141

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

   142

            grid.SetColAttr(col, attr)

   143

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

   144

   145

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

   146

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

   147

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

   148

                editor = None

   149

                renderer = None

   150

                error = False

   151

                colname = self.GetColLabelValue(col, False)

   152

                grid.SetReadOnly(row, col, False)

   153

                if colname == "Name":

   154

                    editor = wx.grid.GridCellTextEditor()

   155

                    renderer = wx.grid.GridCellStringRenderer()

   156

                elif colname == "Interval":

   157

                    editor = DurationCellEditor(self, colname)

   158

                    renderer = wx.grid.GridCellStringRenderer()

   159

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

   160

                        grid.SetReadOnly(row, col, True)

   161

                    interval = self.GetValueByName(row, colname)

   162

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

   163

                        error = True

   164

                elif colname == "Single":

   165

                    editor = SingleCellEditor(self, colname)

   166

                    editor.SetParameters(self.Parent.VariableList)

   167

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

   168

                        grid.SetReadOnly(row, col, True)

   169

                    single = self.GetValueByName(row, colname)

   170

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

   171

                        error = True

   172

                elif colname == "Triggering":

   173

                    editor = wx.grid.GridCellChoiceEditor()

   174

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

   175

                elif colname == "Type":

   176

                    editor = wx.grid.GridCellChoiceEditor()

   177

                    editor.SetParameters(self.Parent.TypeList)

   178

                elif colname == "Priority":

   179

                    editor = wx.grid.GridCellNumberEditor()

   180

                    editor.SetParameters("0,65535")

   181

                elif colname == "Task":

   182

                    editor = wx.grid.GridCellChoiceEditor()

   183

                    editor.SetParameters(self.Parent.TaskList)

   184

   185

                grid.SetCellEditor(row, col, editor)

   186

                grid.SetCellRenderer(row, col, renderer)

   187

   188

                if error:

   189

                    highlight_colours = ERROR_HIGHLIGHT

   190

                else:

   191

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

   192

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

   193

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

   194

            self.ResizeRow(grid, row)

   195

   196

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

   197

    #                        Highlights showing functions

   198

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

   199

   200

    def AddHighlight(self, infos, highlight_type):

   201

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

   202

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

   203

        col_highlights.append(highlight_type)

   204

   205

    def ClearHighlights(self, highlight_type=None):

   206

        if highlight_type is None:

   207

            self.Highlights = {}

   208

        else:

   209

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

   210

                row_items = row_highlights.items()

   211

                for col, col_highlights in row_items:

   212

                    if highlight_type in col_highlights:

   213

                        col_highlights.remove(highlight_type)

   214

                    if len(col_highlights) == 0:

   215

                        row_highlights.pop(col)

   216

   217

   218

class ResourceEditor(EditorPanel):

   219

   220

    VARIABLE_PANEL_TYPE = "resource"

   221

   222

    def _init_Editor(self, parent):

   223

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

   224

   225

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

   226

        main_sizer.AddGrowableCol(0)

   227

        main_sizer.AddGrowableRow(0)

   228

        main_sizer.AddGrowableRow(1)

   229

   230

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

   231

        tasks_sizer.AddGrowableCol(0)

   232

        tasks_sizer.AddGrowableRow(1)

   233

        main_sizer.AddSizer(tasks_sizer, border=5,

   234

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

   235

   236

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

   237

        tasks_buttons_sizer.AddGrowableCol(0)

   238

        tasks_buttons_sizer.AddGrowableRow(0)

   239

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

   240

   241

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

   242

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

   243

   244

        for name, bitmap, help in [

   245

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

   246

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

   247

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

   248

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

   249

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

   250

                                                    bitmap=GetBitmap(bitmap),

   251

                                                    size=wx.Size(28, 28),

   252

                                                    style=wx.NO_BORDER)

   253

            button.SetToolTipString(help)

   254

            setattr(self, name, button)

   255

            tasks_buttons_sizer.AddWindow(button)

   256

   257

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

   258

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

   259

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

   260

   261

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

   262

        instances_sizer.AddGrowableCol(0)

   263

        instances_sizer.AddGrowableRow(1)

   264

        main_sizer.AddSizer(instances_sizer, border=5,

   265

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

   266

   267

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

   268

        instances_buttons_sizer.AddGrowableCol(0)

   269

        instances_buttons_sizer.AddGrowableRow(0)

   270

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

   271

   272

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

   273

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

   274

   275

        for name, bitmap, help in [

   276

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

   277

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

   278

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

   279

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

   280

            button = wx.lib.buttons.GenBitmapButton(

   281

                self.Editor, bitmap=GetBitmap(bitmap),

   282

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

   283

            button.SetToolTipString(help)

   284

            setattr(self, name, button)

   285

            instances_buttons_sizer.AddWindow(button)

   286

   287

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

   288

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

   289

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

   290

   291

        self.Editor.SetSizer(main_sizer)

   292

   293

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

   294

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

   295

   296

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

   297

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

   298

   299

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

   300

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

   301

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

   302

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

   303

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

   304

        self.TasksGrid.SetTable(self.TasksTable)

   305

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

   306

                                   "Delete": self.DeleteTaskButton,

   307

                                   "Up": self.UpTaskButton,

   308

                                   "Down": self.DownTaskButton})

   309

   310

        def _AddTask(new_row):

   311

            if new_row > 0:

   312

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

   313

                old_name = row_content['Name']

   314

                row_content['Name'] =\

   315

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

   316

            else:

   317

                row_content = self.TasksDefaultValue.copy()

   318

   319

            self.TasksTable.InsertRow(new_row, row_content)

   320

            self.RefreshModel()

   321

            self.RefreshView()

   322

            return new_row

   323

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

   324

   325

        def _DeleteTask(row):

   326

            self.TasksTable.RemoveRow(row)

   327

            self.RefreshModel()

   328

            self.RefreshView()

   329

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

   330

   331

        def _MoveTask(row, move):

   332

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

   333

            if new_row != row:

   334

                self.RefreshModel()

   335

                self.RefreshView()

   336

            return new_row

   337

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

   338

   339

        self.TasksGrid.SetRowLabelSize(0)

   340

        self.TasksTable.ResetView(self.TasksGrid)

   341

        self.TasksGrid.RefreshButtons()

   342

   343

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

   344

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

   345

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

   346

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

   347

        self.InstancesGrid.SetTable(self.InstancesTable)

   348

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

   349

                                       "Delete": self.DeleteInstanceButton,

   350

                                       "Up": self.UpInstanceButton,

   351

                                       "Down": self.DownInstanceButton})

   352

   353

        def _AddInstance(new_row):

   354

            if new_row > 0:

   355

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

   356

                old_name = row_content['Name']

   357

                row_content['Name'] =\

   358

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

   359

            else:

   360

                row_content = self.InstancesDefaultValue.copy()

   361

   362

            self.InstancesTable.InsertRow(new_row, row_content)

   363

            self.RefreshModel()

   364

            self.RefreshView()

   365

            return new_row

   366

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

   367

   368

        def _DeleteInstance(row):

   369

            self.InstancesTable.RemoveRow(row)

   370

            self.RefreshModel()

   371

            self.RefreshView()

   372

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

   373

   374

        def _MoveInstance(row, move):

   375

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

   376

            if new_row != row:

   377

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

   378

                    return row

   379

                self.InstancesTable.MoveRow(row, move)

   380

                self.RefreshModel()

   381

                self.RefreshView()

   382

            return new_row

   383

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

   384

   385

        def _RefreshInstanceButtons():

   386

            if self:

   387

                rows = self.InstancesTable.GetNumberRows()

   388

                row = self.InstancesGrid.GetGridCursorRow()

   389

                self.DeleteInstanceButton.Enable(rows > 0)

   390

                self.UpInstanceButton.Enable(

   391

                    row > 0 and

   392

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

   393

                self.DownInstanceButton.Enable(

   394

                    0 <= row < rows - 1 and

   395

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

   396

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

   397

   398

        self.InstancesGrid.SetRowLabelSize(0)

   399

        self.InstancesTable.ResetView(self.InstancesGrid)

   400

        self.InstancesGrid.RefreshButtons()

   401

   402

        self.TasksGrid.SetFocus()

   403

   404

    def __del__(self):

   405

        self.RefreshHighlightsTimer.Stop()

   406

   407

    def RefreshTypeList(self):

   408

        self.TypeList = ""

   409

        blocktypes = self.Controler.GetBlockResource()

   410

        for blocktype in blocktypes:

   411

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

   412

   413

    def RefreshTaskList(self):

   414

        self.TaskList = ""

   415

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

   416

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

   417

   418

    def RefreshVariableList(self):

   419

        self.VariableList = ""

   420

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

   421

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

   422

   423

    def RefreshModel(self):

   424

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

   425

        self.RefreshBuffer()

   426

   427

    # Buffer the last model state

   428

    def RefreshBuffer(self):

   429

        self.Controler.BufferProject()

   430

        self.ParentWindow.RefreshTitle()

   431

        self.ParentWindow.RefreshFileMenu()

   432

        self.ParentWindow.RefreshEditMenu()

   433

   434

    def GetBufferState(self):

   435

        return self.Controler.GetBufferState()

   436

   437

    def Undo(self):

   438

        self.Controler.LoadPrevious()

   439

        self.ParentWindow.CloseTabsWithoutModel()

   440

   441

    def Redo(self):

   442

        self.Controler.LoadNext()

   443

        self.ParentWindow.CloseTabsWithoutModel()

   444

   445

    def HasNoModel(self):

   446

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

   447

   448

    def RefreshView(self, variablepanel=True):

   449

        EditorPanel.RefreshView(self, variablepanel)

   450

   451

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

   452

        self.TasksTable.SetData(tasks)

   453

        self.InstancesTable.SetData(instances)

   454

        self.RefreshTypeList()

   455

        self.RefreshTaskList()

   456

        self.RefreshVariableList()

   457

        self.TasksTable.ResetView(self.TasksGrid)

   458

        self.InstancesTable.ResetView(self.InstancesGrid)

   459

        self.TasksGrid.RefreshButtons()

   460

        self.InstancesGrid.RefreshButtons()

   461

   462

    def ShowErrorMessage(self, message):

   463

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

   464

        dialog.ShowModal()

   465

        dialog.Destroy()

   466

   467

    def OnTasksGridCellChange(self, event):

   468

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

   469

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

   470

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

   471

            message = None

   472

   473

            if not TestIdentifier(value):

   474

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

   475

            elif value.upper() in IEC_KEYWORDS:

   476

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

   477

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

   478

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

   479

            if message is not None:

   480

                event.Veto()

   481

                wx.CallAfter(self.ShowErrorMessage, message)

   482

                return

   483

   484

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

   485

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

   486

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

   487

                if task in tasklist:

   488

                    tasklist.remove(task)

   489

            if len(tasklist) > 0:

   490

                old_name = tasklist[0].upper()

   491

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

   492

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

   493

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

   494

                    if old_name == name:

   495

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

   496

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

   497

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

   498

        self.RefreshModel()

   499

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

   500

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

   501

            wx.CallAfter(self.RefreshView, False)

   502

        event.Skip()

   503