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

    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

    34

from editors.EditorPanel import EditorPanel

    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

def SingleCellEditor(*x):

    85

    return wx.grid.GridCellChoiceEditor()

    86

    87

    88

def CheckSingle(single, varlist):

    89

    return single in varlist

    90

    91

    92

def GetInstancesTableColnames():

    93

    _ = NoTranslate

    94

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

    95

    96

    97

class ResourceTable(CustomTable):

    98

    """

    99

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

   100

    """

   101

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

   102

        # The base class must be initialized *first*

   103

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

   104

        self.ColAlignements = []

   105

        self.ColSizes = []

   106

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

   107

                                                for option in GetTaskTriggeringOptions()])

   108

   109

    def GetColAlignements(self):

   110

        return self.ColAlignements

   111

   112

    def SetColAlignements(self, list):

   113

        self.ColAlignements = list

   114

   115

    def GetColSizes(self):

   116

        return self.ColSizes

   117

   118

    def SetColSizes(self, list):

   119

        self.ColSizes = list

   120

   121

    def GetValue(self, row, col):

   122

        if row < self.GetNumberRows():

   123

            colname = self.GetColLabelValue(col, False)

   124

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

   125

            if colname == "Triggering":

   126

                return _(value)

   127

            return value

   128

   129

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

   130

        if col < len(self.colnames):

   131

            colname = self.GetColLabelValue(col, False)

   132

            if colname == "Triggering":

   133

                value = self.TASKTRIGGERINGOPTIONS_DICT[value]

   134

            self.data[row][colname] = value

   135

   136

    def _updateColAttrs(self, grid):

   137

        """

   138

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

   139

        appropriate renderer given the column name.

   140

   141

        Otherwise default to the default renderer.

   142

        """

   143

   144

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

   145

            attr = wx.grid.GridCellAttr()

   146

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

   147

            grid.SetColAttr(col, attr)

   148

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

   149

   150

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

   151

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

   152

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

   153

                editor = None

   154

                renderer = None

   155

                error = False

   156

                colname = self.GetColLabelValue(col, False)

   157

                grid.SetReadOnly(row, col, False)

   158

                if colname == "Name":

   159

                    editor = wx.grid.GridCellTextEditor()

   160

                    renderer = wx.grid.GridCellStringRenderer()

   161

                elif colname == "Interval":

   162

                    editor = DurationCellEditor(self, colname)

   163

                    renderer = wx.grid.GridCellStringRenderer()

   164

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

   165

                        grid.SetReadOnly(row, col, True)

   166

                    interval = self.GetValueByName(row, colname)

   167

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

   168

                        error = True

   169

                elif colname == "Single":

   170

                    editor = SingleCellEditor(self, colname)

   171

                    editor.SetParameters(self.Parent.VariableList)

   172

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

   173

                        grid.SetReadOnly(row, col, True)

   174

                    single = self.GetValueByName(row, colname)

   175

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

   176

                        error = True

   177

                elif colname == "Triggering":

   178

                    editor = wx.grid.GridCellChoiceEditor()

   179

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

   180

                elif colname == "Type":

   181

                    editor = wx.grid.GridCellChoiceEditor()

   182

                    editor.SetParameters(self.Parent.TypeList)

   183

                elif colname == "Priority":

   184

                    editor = wx.grid.GridCellNumberEditor()

   185

                    editor.SetParameters("0,65535")

   186

                elif colname == "Task":

   187

                    editor = wx.grid.GridCellChoiceEditor()

   188

                    editor.SetParameters(self.Parent.TaskList)

   189

   190

                grid.SetCellEditor(row, col, editor)

   191

                grid.SetCellRenderer(row, col, renderer)

   192

   193

                if error:

   194

                    highlight_colours = ERROR_HIGHLIGHT

   195

                else:

   196

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

   197

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

   198

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

   199

            self.ResizeRow(grid, row)

   200

   201

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

   202

    #                        Highlights showing functions

   203

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

   204

   205

    def AddHighlight(self, infos, highlight_type):

   206

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

   207

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

   208

        col_highlights.append(highlight_type)

   209

   210

    def ClearHighlights(self, highlight_type=None):

   211

        if highlight_type is None:

   212

            self.Highlights = {}

   213

        else:

   214

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

   215

                row_items = row_highlights.items()

   216

                for col, col_highlights in row_items:

   217

                    if highlight_type in col_highlights:

   218

                        col_highlights.remove(highlight_type)

   219

                    if len(col_highlights) == 0:

   220

                        row_highlights.pop(col)

   221

   222

   223

class ResourceEditor(EditorPanel):

   224

   225

    VARIABLE_PANEL_TYPE = "resource"

   226

   227

    def _init_Editor(self, parent):

   228

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

   229

   230

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

   231

        main_sizer.AddGrowableCol(0)

   232

        main_sizer.AddGrowableRow(0)

   233

        main_sizer.AddGrowableRow(1)

   234

   235

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

   236

        tasks_sizer.AddGrowableCol(0)

   237

        tasks_sizer.AddGrowableRow(1)

   238

        main_sizer.AddSizer(tasks_sizer, border=5,

   239

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

   240

   241

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

   242

        tasks_buttons_sizer.AddGrowableCol(0)

   243

        tasks_buttons_sizer.AddGrowableRow(0)

   244

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

   245

   246

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

   247

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

   248

   249

        for name, bitmap, help in [

   250

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

   251

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

   252

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

   253

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

   254

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

   255

                                                    bitmap=GetBitmap(bitmap),

   256

                                                    size=wx.Size(28, 28),

   257

                                                    style=wx.NO_BORDER)

   258

            button.SetToolTipString(help)

   259

            setattr(self, name, button)

   260

            tasks_buttons_sizer.AddWindow(button)

   261

   262

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

   263

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

   264

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

   265

   266

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

   267

        instances_sizer.AddGrowableCol(0)

   268

        instances_sizer.AddGrowableRow(1)

   269

        main_sizer.AddSizer(instances_sizer, border=5,

   270

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

   271

   272

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

   273

        instances_buttons_sizer.AddGrowableCol(0)

   274

        instances_buttons_sizer.AddGrowableRow(0)

   275

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

   276

   277

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

   278

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

   279

   280

        for name, bitmap, help in [

   281

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

   282

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

   283

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

   284

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

   285

            button = wx.lib.buttons.GenBitmapButton(

   286

                self.Editor, bitmap=GetBitmap(bitmap),

   287

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

   288

            button.SetToolTipString(help)

   289

            setattr(self, name, button)

   290

            instances_buttons_sizer.AddWindow(button)

   291

   292

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

   293

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

   294

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

   295

   296

        self.Editor.SetSizer(main_sizer)

   297

   298

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

   299

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

   300

   301

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

   302

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

   303

   304

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

   305

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

   306

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

   307

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

   308

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

   309

        self.TasksGrid.SetTable(self.TasksTable)

   310

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

   311

                                   "Delete": self.DeleteTaskButton,

   312

                                   "Up": self.UpTaskButton,

   313

                                   "Down": self.DownTaskButton})

   314

   315

        def _AddTask(new_row):

   316

            if new_row > 0:

   317

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

   318

                old_name = row_content['Name']

   319

                row_content['Name'] =\

   320

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

   321

            else:

   322

                row_content = self.TasksDefaultValue.copy()

   323

   324

            self.TasksTable.InsertRow(new_row, row_content)

   325

            self.RefreshModel()

   326

            self.RefreshView()

   327

            return new_row

   328

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

   329

   330

        def _DeleteTask(row):

   331

            self.TasksTable.RemoveRow(row)

   332

            self.RefreshModel()

   333

            self.RefreshView()

   334

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

   335

   336

        def _MoveTask(row, move):

   337

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

   338

            if new_row != row:

   339

                self.RefreshModel()

   340

                self.RefreshView()

   341

            return new_row

   342

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

   343

   344

        self.TasksGrid.SetRowLabelSize(0)

   345

        self.TasksTable.ResetView(self.TasksGrid)

   346

        self.TasksGrid.RefreshButtons()

   347

   348

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

   349

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

   350

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

   351

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

   352

        self.InstancesGrid.SetTable(self.InstancesTable)

   353

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

   354

                                       "Delete": self.DeleteInstanceButton,

   355

                                       "Up": self.UpInstanceButton,

   356

                                       "Down": self.DownInstanceButton})

   357

   358

        def _AddInstance(new_row):

   359

            if new_row > 0:

   360

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

   361

                old_name = row_content['Name']

   362

                row_content['Name'] =\

   363

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

   364

            else:

   365

                row_content = self.InstancesDefaultValue.copy()

   366

   367

            self.InstancesTable.InsertRow(new_row, row_content)

   368

            self.RefreshModel()

   369

            self.RefreshView()

   370

            return new_row

   371

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

   372

   373

        def _DeleteInstance(row):

   374

            self.InstancesTable.RemoveRow(row)

   375

            self.RefreshModel()

   376

            self.RefreshView()

   377

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

   378

   379

        def _MoveInstance(row, move):

   380

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

   381

            if new_row != row:

   382

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

   383

                    return row

   384

                self.InstancesTable.MoveRow(row, move)

   385

                self.RefreshModel()

   386

                self.RefreshView()

   387

            return new_row

   388

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

   389

   390

        def _RefreshInstanceButtons():

   391

            if self:

   392

                rows = self.InstancesTable.GetNumberRows()

   393

                row = self.InstancesGrid.GetGridCursorRow()

   394

                self.DeleteInstanceButton.Enable(rows > 0)

   395

                self.UpInstanceButton.Enable(

   396

                    row > 0 and

   397

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

   398

                self.DownInstanceButton.Enable(

   399

                    0 <= row < rows - 1 and

   400

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

   401

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

   402

   403

        self.InstancesGrid.SetRowLabelSize(0)

   404

        self.InstancesTable.ResetView(self.InstancesGrid)

   405

        self.InstancesGrid.RefreshButtons()

   406

   407

        self.TasksGrid.SetFocus()

   408

   409

    def __del__(self):

   410

        self.RefreshHighlightsTimer.Stop()

   411

   412

    def RefreshTypeList(self):

   413

        self.TypeList = ""

   414

        blocktypes = self.Controler.GetBlockResource()

   415

        for blocktype in blocktypes:

   416

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

   417

   418

    def RefreshTaskList(self):

   419

        self.TaskList = ""

   420

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

   421

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

   422

   423

    def RefreshVariableList(self):

   424

        self.VariableList = ""

   425

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

   426

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

   427

   428

    def RefreshModel(self):

   429

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

   430

        self.RefreshBuffer()

   431

   432

    # Buffer the last model state

   433

    def RefreshBuffer(self):

   434

        self.Controler.BufferProject()

   435

        self.ParentWindow.RefreshTitle()

   436

        self.ParentWindow.RefreshFileMenu()

   437

        self.ParentWindow.RefreshEditMenu()

   438

   439

    def GetBufferState(self):

   440

        return self.Controler.GetBufferState()

   441

   442

    def Undo(self):

   443

        self.Controler.LoadPrevious()

   444

        self.ParentWindow.CloseTabsWithoutModel()

   445

   446

    def Redo(self):

   447

        self.Controler.LoadNext()

   448

        self.ParentWindow.CloseTabsWithoutModel()

   449

   450

    def HasNoModel(self):

   451

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

   452

   453

    def RefreshView(self, variablepanel=True):

   454

        EditorPanel.RefreshView(self, variablepanel)

   455

   456

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

   457

        self.TasksTable.SetData(tasks)

   458

        self.InstancesTable.SetData(instances)

   459

        self.RefreshTypeList()

   460

        self.RefreshTaskList()

   461

        self.RefreshVariableList()

   462

        self.TasksTable.ResetView(self.TasksGrid)

   463

        self.InstancesTable.ResetView(self.InstancesGrid)

   464

        self.TasksGrid.RefreshButtons()

   465

        self.InstancesGrid.RefreshButtons()

   466

   467

    def ShowErrorMessage(self, message):

   468

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

   469

        dialog.ShowModal()

   470

        dialog.Destroy()

   471

   472

    def OnTasksGridCellChange(self, event):

   473

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

   474

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

   475

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

   476

            message = None

   477

   478

            if not TestIdentifier(value):

   479

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

   480

            elif value.upper() in IEC_KEYWORDS:

   481

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

   482

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

   483

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

   484

            if message is not None:

   485

                event.Veto()

   486

                wx.CallAfter(self.ShowErrorMessage, message)

   487

                return

   488

   489

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

   490

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

   491

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

   492

                if task in tasklist:

   493

                    tasklist.remove(task)

   494

            if len(tasklist) > 0:

   495

                old_name = tasklist[0].upper()

   496

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

   497

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

   498

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

   499

                    if old_name == name:

   500

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

   501

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

   502

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

   503