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

[ID_CONFIGURATIONEDITOR,

    41

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

    42

    43

    44

class ConfigurationEditor(EditorPanel):

    45

    46

    ID = ID_CONFIGURATIONEDITOR

    47

    VARIABLE_PANEL_TYPE = "config"

    48

    49

    def GetBufferState(self):

    50

        return self.Controler.GetBufferState()

    51

    52

    def Undo(self):

    53

        self.Controler.LoadPrevious()

    54

        self.ParentWindow.CloseTabsWithoutModel()

    55

    56

    def Redo(self):

    57

        self.Controler.LoadNext()

    58

        self.ParentWindow.CloseTabsWithoutModel()

    59

    60

    def HasNoModel(self):

    61

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

    62

    63

    64

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

    65

#                            Resource Editor class

    66

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

    67

    68

def GetTasksTableColnames():

    69

    _ = NoTranslate

    70

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

    71

    72

    73

def GetTaskTriggeringOptions():

    74

    _ = NoTranslate

    75

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

    76

    77

    78

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

    79

    80

    81

def SingleCellEditor(*x):

    82

    return wx.grid.GridCellChoiceEditor()

    83

    84

    85

def CheckSingle(single, varlist):

    86

    return single in varlist

    87

    88

    89

def GetInstancesTableColnames():

    90

    _ = NoTranslate

    91

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

    92

    93

    94

class ResourceTable(CustomTable):

    95

    96

    """

    97

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

    98

    """

    99

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

   100

        # The base class must be initialized *first*

   101

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

   102

        self.ColAlignements = []

   103

        self.ColSizes = []

   104

   105

    def GetColAlignements(self):

   106

        return self.ColAlignements

   107

   108

    def SetColAlignements(self, list):

   109

        self.ColAlignements = list

   110

   111

    def GetColSizes(self):

   112

        return self.ColSizes

   113

   114

    def SetColSizes(self, list):

   115

        self.ColSizes = list

   116

   117

    def GetValue(self, row, col):

   118

        if row < self.GetNumberRows():

   119

            colname = self.GetColLabelValue(col, False)

   120

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

   121

            if colname == "Triggering":

   122

                return _(value)

   123

            return value

   124

   125

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

   126

        if col < len(self.colnames):

   127

            colname = self.GetColLabelValue(col, False)

   128

            if colname == "Triggering":

   129

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   130

            self.data[row][colname] = value

   131

   132

    def _updateColAttrs(self, grid):

   133

        """

   134

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

   135

        appropriate renderer given the column name.

   136

   137

        Otherwise default to the default renderer.

   138

        """

   139

   140

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

   141

            attr = wx.grid.GridCellAttr()

   142

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

   143

            grid.SetColAttr(col, attr)

   144

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

   145

   146

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

   147

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

   148

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

   149

                editor = None

   150

                renderer = None

   151

                error = False

   152

                colname = self.GetColLabelValue(col, False)

   153

                grid.SetReadOnly(row, col, False)

   154

                if colname == "Name":

   155

                    editor = wx.grid.GridCellTextEditor()

   156

                    renderer = wx.grid.GridCellStringRenderer()

   157

                elif colname == "Interval":

   158

                    editor = DurationCellEditor(self, colname)

   159

                    renderer = wx.grid.GridCellStringRenderer()

   160

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

   161

                        grid.SetReadOnly(row, col, True)

   162

                    interval = self.GetValueByName(row, colname)

   163

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

   164

                        error = True

   165

                elif colname == "Single":

   166

                    editor = SingleCellEditor(self, colname)

   167

                    editor.SetParameters(self.Parent.VariableList)

   168

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

   169

                        grid.SetReadOnly(row, col, True)

   170

                    single = self.GetValueByName(row, colname)

   171

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

   172

                        error = True

   173

                elif colname == "Triggering":

   174

                    editor = wx.grid.GridCellChoiceEditor()

   175

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

   176

                elif colname == "Type":

   177

                    editor = wx.grid.GridCellChoiceEditor()

   178

                    editor.SetParameters(self.Parent.TypeList)

   179

                elif colname == "Priority":

   180

                    editor = wx.grid.GridCellNumberEditor()

   181

                    editor.SetParameters("0,65535")

   182

                elif colname == "Task":

   183

                    editor = wx.grid.GridCellChoiceEditor()

   184

                    editor.SetParameters(self.Parent.TaskList)

   185

   186

                grid.SetCellEditor(row, col, editor)

   187

                grid.SetCellRenderer(row, col, renderer)

   188

   189

                if error:

   190

                    highlight_colours = ERROR_HIGHLIGHT

   191

                else:

   192

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

   193

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

   194

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

   195

            self.ResizeRow(grid, row)

   196

   197

   198

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

   199

#                        Highlights showing functions

   200

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

   201

   202

    def AddHighlight(self, infos, highlight_type):

   203

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

   204

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

   205

        col_highlights.append(highlight_type)

   206

   207

    def ClearHighlights(self, highlight_type=None):

   208

        if highlight_type is None:

   209

            self.Highlights = {}

   210

        else:

   211

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

   212

                row_items = row_highlights.items()

   213

                for col, col_highlights in row_items:

   214

                    if highlight_type in col_highlights:

   215

                        col_highlights.remove(highlight_type)

   216

                    if len(col_highlights) == 0:

   217

                        row_highlights.pop(col)

   218

   219

   220

class ResourceEditor(EditorPanel):

   221

   222

    VARIABLE_PANEL_TYPE = "resource"

   223

   224

    def _init_Editor(self, parent):

   225

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

   226

   227

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

   228

        main_sizer.AddGrowableCol(0)

   229

        main_sizer.AddGrowableRow(0)

   230

        main_sizer.AddGrowableRow(1)

   231

   232

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

   233

        tasks_sizer.AddGrowableCol(0)

   234

        tasks_sizer.AddGrowableRow(1)

   235

        main_sizer.AddSizer(tasks_sizer, border=5,

   236

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

   237

   238

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

   239

        tasks_buttons_sizer.AddGrowableCol(0)

   240

        tasks_buttons_sizer.AddGrowableRow(0)

   241

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

   242

   243

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

   244

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

   245

   246

        for name, bitmap, help in [

   247

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

   248

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

   249

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

   250

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

   251

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

   252

                  bitmap=GetBitmap(bitmap), size=wx.Size(28, 28), 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(self.Editor,

   281

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

   282

            button.SetToolTipString(help)

   283

            setattr(self, name, button)

   284

            instances_buttons_sizer.AddWindow(button)

   285

   286

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

   287

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

   288

              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": "", "Triggering": "", "Single": "", "Interval": "", "Priority": 0}

   300

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

   301

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

   302

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

   303

        self.TasksGrid.SetTable(self.TasksTable)

   304

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

   305

                                   "Delete": self.DeleteTaskButton,

   306

                                   "Up": self.UpTaskButton,

   307

                                   "Down": self.DownTaskButton})

   308

   309

        def _AddTask(new_row):

   310

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

   311

            self.RefreshModel()

   312

            self.RefreshView()

   313

            return new_row

   314

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

   315

   316

        def _DeleteTask(row):

   317

            self.TasksTable.RemoveRow(row)

   318

            self.RefreshModel()

   319

            self.RefreshView()

   320

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

   321

   322

        def _MoveTask(row, move):

   323

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

   324

            if new_row != row:

   325

                self.RefreshModel()

   326

                self.RefreshView()

   327

            return new_row

   328

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

   329

   330

        self.TasksGrid.SetRowLabelSize(0)

   331

        self.TasksTable.ResetView(self.TasksGrid)

   332

        self.TasksGrid.RefreshButtons()

   333

   334

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

   335

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

   336

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

   337

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

   338

        self.InstancesGrid.SetTable(self.InstancesTable)

   339

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

   340

                                       "Delete": self.DeleteInstanceButton,

   341

                                       "Up": self.UpInstanceButton,

   342

                                       "Down": self.DownInstanceButton})

   343

   344

        def _AddInstance(new_row):

   345

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

   346

            self.RefreshModel()

   347

            self.RefreshView()

   348

            return new_row

   349

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

   350

   351

        def _DeleteInstance(row):

   352

            self.InstancesTable.RemoveRow(row)

   353

            self.RefreshModel()

   354

            self.RefreshView()

   355

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

   356

   357

        def _MoveInstance(row, move):

   358

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

   359

            if new_row != row:

   360

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

   361

                    return row

   362

                self.InstancesTable.MoveRow(row, move)

   363

                self.RefreshModel()

   364

                self.RefreshView()

   365

            return new_row

   366

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

   367

   368

        def _RefreshInstanceButtons():

   369

            if self:

   370

                rows = self.InstancesTable.GetNumberRows()

   371

                row = self.InstancesGrid.GetGridCursorRow()

   372

                self.DeleteInstanceButton.Enable(rows > 0)

   373

                self.UpInstanceButton.Enable(row > 0 and

   374

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

   375

                self.DownInstanceButton.Enable(0 <= row < rows - 1 and

   376

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

   377

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

   378

   379

        self.InstancesGrid.SetRowLabelSize(0)

   380

        self.InstancesTable.ResetView(self.InstancesGrid)

   381

        self.InstancesGrid.RefreshButtons()

   382

   383

        self.TasksGrid.SetFocus()

   384

   385

    def __del__(self):

   386

        self.RefreshHighlightsTimer.Stop()

   387

   388

    def RefreshTypeList(self):

   389

        self.TypeList = ""

   390

        blocktypes = self.Controler.GetBlockResource()

   391

        for blocktype in blocktypes:

   392

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

   393

   394

    def RefreshTaskList(self):

   395

        self.TaskList = ""

   396

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

   397

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

   398

   399

    def RefreshVariableList(self):

   400

        self.VariableList = ""

   401

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

   402

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

   403

   404

    def RefreshModel(self):

   405

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

   406

        self.RefreshBuffer()

   407

   408

    # Buffer the last model state

   409

    def RefreshBuffer(self):

   410

        self.Controler.BufferProject()

   411

        self.ParentWindow.RefreshTitle()

   412

        self.ParentWindow.RefreshFileMenu()

   413

        self.ParentWindow.RefreshEditMenu()

   414

   415

    def GetBufferState(self):

   416

        return self.Controler.GetBufferState()

   417

   418

    def Undo(self):

   419

        self.Controler.LoadPrevious()

   420

        self.ParentWindow.CloseTabsWithoutModel()

   421

   422

    def Redo(self):

   423

        self.Controler.LoadNext()

   424

        self.ParentWindow.CloseTabsWithoutModel()

   425

   426

    def HasNoModel(self):

   427

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

   428

   429

    def RefreshView(self, variablepanel=True):

   430

        EditorPanel.RefreshView(self, variablepanel)

   431

   432

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

   433

        self.TasksTable.SetData(tasks)

   434

        self.InstancesTable.SetData(instances)

   435

        self.RefreshTypeList()

   436

        self.RefreshTaskList()

   437

        self.RefreshVariableList()

   438

        self.TasksTable.ResetView(self.TasksGrid)

   439

        self.InstancesTable.ResetView(self.InstancesGrid)

   440

        self.TasksGrid.RefreshButtons()

   441

        self.InstancesGrid.RefreshButtons()

   442

   443

    def ShowErrorMessage(self, message):

   444

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

   445

        dialog.ShowModal()

   446

        dialog.Destroy()

   447

   448

    def OnTasksGridCellChange(self, event):

   449

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

   450

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

   451

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

   452

            message = None

   453

   454

            if not TestIdentifier(value):

   455

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

   456

            elif value.upper() in IEC_KEYWORDS:

   457

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

   458

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

   459

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

   460

            if message is not None:

   461

                event.Veto()

   462

                wx.CallAfter(self.ShowErrorMessage, message)

   463

                return

   464

   465

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

   466

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

   467

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

   468

                if task in tasklist:

   469

                    tasklist.remove(task)

   470

            if len(tasklist) > 0:

   471

                old_name = tasklist[0].upper()

   472

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

   473

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

   474

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

   475

                    if old_name == name:

   476

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

   477

        self.RefreshModel()

   478

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

   479

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

   480

            wx.CallAfter(self.RefreshView, False)

   481

        event.Skip()

   482

   483

    def OnInstancesGridCellChange(self, event):

   484

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

   485

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

   486

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

   487

            message = None

   488

   489

            if not TestIdentifier(value):

   490

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

   491

            elif value.upper() in IEC_KEYWORDS:

   492

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

   493

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

   494

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

   495

            if message is not None:

   496

                event.Veto()

   497

                wx.CallAfter(self.ShowErrorMessage, message)

   498

                return

   499

   500

        self.RefreshModel()

   501

        self.ParentWindow.RefreshPouInstanceVariablesPanel()

   502

        self.InstancesGrid.RefreshButtons()

   503

        event.Skip()

   504

   505

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