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

import wx

    26

import wx.lib.buttons

    27

import wx.grid

    28

    29

from graphics.GraphicCommons import REFRESH_HIGHLIGHT_PERIOD, ERROR_HIGHLIGHT

    30

from controls import CustomGrid, CustomTable, DurationCellEditor

    31

from dialogs.DurationEditorDialog import IEC_TIME_MODEL

    32

from EditorPanel import EditorPanel

    33

from util.BitmapLibrary import GetBitmap

    34

from plcopen.structures import LOCATIONDATATYPES, TestIdentifier, IEC_KEYWORDS, DefaultType

    35

from util.TranslationCatalogs import NoTranslate

    36

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

    37

#                          Configuration Editor class

    38

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

    39

    40

[

    41

    ID_CONFIGURATIONEDITOR,

    42

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

    43

    44

    45

class ConfigurationEditor(EditorPanel):

    46

    47

    ID = ID_CONFIGURATIONEDITOR

    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

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

    80

    81

    82

def SingleCellEditor(*x):

    83

    return wx.grid.GridCellChoiceEditor()

    84

    85

    86

def CheckSingle(single, varlist):

    87

    return single in varlist

    88

    89

    90

def GetInstancesTableColnames():

    91

    _ = NoTranslate

    92

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

    93

    94

    95

class ResourceTable(CustomTable):

    96

    97

    """

    98

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

    99

    """

   100

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

   101

        # The base class must be initialized *first*

   102

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

   103

        self.ColAlignements = []

   104

        self.ColSizes = []

   105

   106

    def GetColAlignements(self):

   107

        return self.ColAlignements

   108

   109

    def SetColAlignements(self, list):

   110

        self.ColAlignements = list

   111

   112

    def GetColSizes(self):

   113

        return self.ColSizes

   114

   115

    def SetColSizes(self, list):

   116

        self.ColSizes = list

   117

   118

    def GetValue(self, row, col):

   119

        if row < self.GetNumberRows():

   120

            colname = self.GetColLabelValue(col, False)

   121

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

   122

            if colname == "Triggering":

   123

                return _(value)

   124

            return value

   125

   126

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

   127

        if col < len(self.colnames):

   128

            colname = self.GetColLabelValue(col, False)

   129

            if colname == "Triggering":

   130

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   131

            self.data[row][colname] = value

   132

   133

    def _updateColAttrs(self, grid):

   134

        """

   135

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

   136

        appropriate renderer given the column name.

   137

   138

        Otherwise default to the default renderer.

   139

        """

   140

   141

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

   142

            attr = wx.grid.GridCellAttr()

   143

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

   144

            grid.SetColAttr(col, attr)

   145

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

   146

   147

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

   148

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

   149

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

   150

                editor = None

   151

                renderer = None

   152

                error = False

   153

                colname = self.GetColLabelValue(col, False)

   154

                grid.SetReadOnly(row, col, False)

   155

                if colname == "Name":

   156

                    editor = wx.grid.GridCellTextEditor()

   157

                    renderer = wx.grid.GridCellStringRenderer()

   158

                elif colname == "Interval":

   159

                    editor = DurationCellEditor(self, colname)

   160

                    renderer = wx.grid.GridCellStringRenderer()

   161

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

   162

                        grid.SetReadOnly(row, col, True)

   163

                    interval = self.GetValueByName(row, colname)

   164

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

   165

                        error = True

   166

                elif colname == "Single":

   167

                    editor = SingleCellEditor(self, colname)

   168

                    editor.SetParameters(self.Parent.VariableList)

   169

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

   170

                        grid.SetReadOnly(row, col, True)

   171

                    single = self.GetValueByName(row, colname)

   172

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

   173

                        error = True

   174

                elif colname == "Triggering":

   175

                    editor = wx.grid.GridCellChoiceEditor()

   176

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

   177

                elif colname == "Type":

   178

                    editor = wx.grid.GridCellChoiceEditor()

   179

                    editor.SetParameters(self.Parent.TypeList)

   180

                elif colname == "Priority":

   181

                    editor = wx.grid.GridCellNumberEditor()

   182

                    editor.SetParameters("0,65535")

   183

                elif colname == "Task":

   184

                    editor = wx.grid.GridCellChoiceEditor()

   185

                    editor.SetParameters(self.Parent.TaskList)

   186

   187

                grid.SetCellEditor(row, col, editor)

   188

                grid.SetCellRenderer(row, col, renderer)

   189

   190

                if error:

   191

                    highlight_colours = ERROR_HIGHLIGHT

   192

                else:

   193

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

   194

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

   195

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

   196

            self.ResizeRow(grid, row)

   197

   198

   199

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

   200

#                        Highlights showing functions

   201

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

   202

   203

    def AddHighlight(self, infos, highlight_type):

   204

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

   205

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

   206

        col_highlights.append(highlight_type)

   207

   208

    def ClearHighlights(self, highlight_type=None):

   209

        if highlight_type is None:

   210

            self.Highlights = {}

   211

        else:

   212

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

   213

                row_items = row_highlights.items()

   214

                for col, col_highlights in row_items:

   215

                    if highlight_type in col_highlights:

   216

                        col_highlights.remove(highlight_type)

   217

                    if len(col_highlights) == 0:

   218

                        row_highlights.pop(col)

   219

   220

   221

class ResourceEditor(EditorPanel):

   222

   223

    VARIABLE_PANEL_TYPE = "resource"

   224

   225

    def _init_Editor(self, parent):

   226

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

   227

   228

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

   229

        main_sizer.AddGrowableCol(0)

   230

        main_sizer.AddGrowableRow(0)

   231

        main_sizer.AddGrowableRow(1)

   232

   233

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

   234

        tasks_sizer.AddGrowableCol(0)

   235

        tasks_sizer.AddGrowableRow(1)

   236

        main_sizer.AddSizer(tasks_sizer, border=5,

   237

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

   238

   239

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

   240

        tasks_buttons_sizer.AddGrowableCol(0)

   241

        tasks_buttons_sizer.AddGrowableRow(0)

   242

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

   243

   244

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

   245

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

   246

   247

        for name, bitmap, help in [

   248

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

   249

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

   250

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

   251

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

   252

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

   253

                                                    bitmap=GetBitmap(bitmap),

   254

                                                    size=wx.Size(28, 28),

   255

                                                    style=wx.NO_BORDER)

   256

            button.SetToolTipString(help)

   257

            setattr(self, name, button)

   258

            tasks_buttons_sizer.AddWindow(button)

   259

   260

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

   261

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

   262

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

   263

   264

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

   265

        instances_sizer.AddGrowableCol(0)

   266

        instances_sizer.AddGrowableRow(1)

   267

        main_sizer.AddSizer(instances_sizer, border=5,

   268

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

   269

   270

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

   271

        instances_buttons_sizer.AddGrowableCol(0)

   272

        instances_buttons_sizer.AddGrowableRow(0)

   273

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

   274

   275

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

   276

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

   277

   278

        for name, bitmap, help in [

   279

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

   280

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

   281

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

   282

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

   283

            button = wx.lib.buttons.GenBitmapButton(

   284

                self.Editor, bitmap=GetBitmap(bitmap),

   285

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

   286

            button.SetToolTipString(help)

   287

            setattr(self, name, button)

   288

            instances_buttons_sizer.AddWindow(button)

   289

   290

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

   291

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

   292

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

   293

   294

        self.Editor.SetSizer(main_sizer)

   295

   296

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

   297

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

   298

   299

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

   300

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

   301

   302

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

   303

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

   304

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

   305

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

   306

        self.TasksGrid.SetTable(self.TasksTable)

   307

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

   308

                                   "Delete": self.DeleteTaskButton,

   309

                                   "Up": self.UpTaskButton,

   310

                                   "Down": self.DownTaskButton})

   311

   312

        def _AddTask(new_row):

   313

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

   314

            self.RefreshModel()

   315

            self.RefreshView()

   316

            return new_row

   317

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

   318

   319

        def _DeleteTask(row):

   320

            self.TasksTable.RemoveRow(row)

   321

            self.RefreshModel()

   322

            self.RefreshView()

   323

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

   324

   325

        def _MoveTask(row, move):

   326

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

   327

            if new_row != row:

   328

                self.RefreshModel()

   329

                self.RefreshView()

   330

            return new_row

   331

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

   332

   333

        self.TasksGrid.SetRowLabelSize(0)

   334

        self.TasksTable.ResetView(self.TasksGrid)

   335

        self.TasksGrid.RefreshButtons()

   336

   337

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

   338

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

   339

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

   340

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

   341

        self.InstancesGrid.SetTable(self.InstancesTable)

   342

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

   343

                                       "Delete": self.DeleteInstanceButton,

   344

                                       "Up": self.UpInstanceButton,

   345

                                       "Down": self.DownInstanceButton})

   346

   347

        def _AddInstance(new_row):

   348

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

   349

            self.RefreshModel()

   350

            self.RefreshView()

   351

            return new_row

   352

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

   353

   354

        def _DeleteInstance(row):

   355

            self.InstancesTable.RemoveRow(row)

   356

            self.RefreshModel()

   357

            self.RefreshView()

   358

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

   359

   360

        def _MoveInstance(row, move):

   361

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

   362

            if new_row != row:

   363

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

   364

                    return row

   365

                self.InstancesTable.MoveRow(row, move)

   366

                self.RefreshModel()

   367

                self.RefreshView()

   368

            return new_row

   369

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

   370

   371

        def _RefreshInstanceButtons():

   372

            if self:

   373

                rows = self.InstancesTable.GetNumberRows()

   374

                row = self.InstancesGrid.GetGridCursorRow()

   375

                self.DeleteInstanceButton.Enable(rows > 0)

   376

                self.UpInstanceButton.Enable(

   377

                    row > 0 and

   378

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

   379

                self.DownInstanceButton.Enable(

   380

                    0 <= row < rows - 1 and

   381

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

   382

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

   383

   384

        self.InstancesGrid.SetRowLabelSize(0)

   385

        self.InstancesTable.ResetView(self.InstancesGrid)

   386

        self.InstancesGrid.RefreshButtons()

   387

   388

        self.TasksGrid.SetFocus()

   389

   390

    def __del__(self):

   391

        self.RefreshHighlightsTimer.Stop()

   392

   393

    def RefreshTypeList(self):

   394

        self.TypeList = ""

   395

        blocktypes = self.Controler.GetBlockResource()

   396

        for blocktype in blocktypes:

   397

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

   398

   399

    def RefreshTaskList(self):

   400

        self.TaskList = ""

   401

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

   402

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

   403

   404

    def RefreshVariableList(self):

   405

        self.VariableList = ""

   406

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

   407

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

   408

   409

    def RefreshModel(self):

   410

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

   411

        self.RefreshBuffer()

   412

   413

    # Buffer the last model state

   414

    def RefreshBuffer(self):

   415

        self.Controler.BufferProject()

   416

        self.ParentWindow.RefreshTitle()

   417

        self.ParentWindow.RefreshFileMenu()

   418

        self.ParentWindow.RefreshEditMenu()

   419

   420

    def GetBufferState(self):

   421

        return self.Controler.GetBufferState()

   422

   423

    def Undo(self):

   424

        self.Controler.LoadPrevious()

   425

        self.ParentWindow.CloseTabsWithoutModel()

   426

   427

    def Redo(self):

   428

        self.Controler.LoadNext()

   429

        self.ParentWindow.CloseTabsWithoutModel()

   430

   431

    def HasNoModel(self):

   432

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

   433

   434

    def RefreshView(self, variablepanel=True):

   435

        EditorPanel.RefreshView(self, variablepanel)

   436

   437

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

   438

        self.TasksTable.SetData(tasks)

   439

        self.InstancesTable.SetData(instances)

   440

        self.RefreshTypeList()

   441

        self.RefreshTaskList()

   442

        self.RefreshVariableList()

   443

        self.TasksTable.ResetView(self.TasksGrid)

   444

        self.InstancesTable.ResetView(self.InstancesGrid)

   445

        self.TasksGrid.RefreshButtons()

   446

        self.InstancesGrid.RefreshButtons()

   447

   448

    def ShowErrorMessage(self, message):

   449

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

   450

        dialog.ShowModal()

   451

        dialog.Destroy()

   452

   453

    def OnTasksGridCellChange(self, event):

   454

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

   455

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

   456

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

   457

            message = None

   458

   459

            if not TestIdentifier(value):

   460

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

   461

            elif value.upper() in IEC_KEYWORDS:

   462

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

   463

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

   464

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

   465

            if message is not None:

   466

                event.Veto()

   467

                wx.CallAfter(self.ShowErrorMessage, message)

   468

                return

   469

   470

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

   471

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

   472

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

   473

                if task in tasklist:

   474

                    tasklist.remove(task)

   475

            if len(tasklist) > 0:

   476

                old_name = tasklist[0].upper()

   477

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

   478

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

   479

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

   480

                    if old_name == name:

   481

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

   482

        self.RefreshModel()

   483

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

   484

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

   485

            wx.CallAfter(self.RefreshView, False)

   486

        event.Skip()

   487

   488

    def OnInstancesGridCellChange(self, event):

   489

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

   490

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

   491

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

   492

            message = None

   493

   494

            if not TestIdentifier(value):

   495

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

   496

            elif value.upper() in IEC_KEYWORDS:

   497

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

   498

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

   499

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

   500

            if message is not None:

   501

                event.Veto()

   502

                wx.CallAfter(self.ShowErrorMessage, message)

   503

                return

   504

   505