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 util.TranslationCatalogs import NoTranslate

    35

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

    36

    37

    38

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

    39

#                          Configuration Editor class

    40

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

    41

    42

    43

[

    44

    ID_CONFIGURATIONEDITOR,

    45

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

    46

    47

    48

class ConfigurationEditor(EditorPanel):

    49

    50

    ID = ID_CONFIGURATIONEDITOR

    51

    VARIABLE_PANEL_TYPE = "config"

    52

    53

    def GetBufferState(self):

    54

        return self.Controler.GetBufferState()

    55

    56

    def Undo(self):

    57

        self.Controler.LoadPrevious()

    58

        self.ParentWindow.CloseTabsWithoutModel()

    59

    60

    def Redo(self):

    61

        self.Controler.LoadNext()

    62

        self.ParentWindow.CloseTabsWithoutModel()

    63

    64

    def HasNoModel(self):

    65

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

    66

    67

    68

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

    69

#                            Resource Editor class

    70

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

    71

    72

def GetTasksTableColnames():

    73

    _ = NoTranslate

    74

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

    75

    76

    77

def GetTaskTriggeringOptions():

    78

    _ = NoTranslate

    79

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

    80

    81

    82

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

    83

    84

    85

def SingleCellEditor(*x):

    86

    return wx.grid.GridCellChoiceEditor()

    87

    88

    89

def CheckSingle(single, varlist):

    90

    return single in varlist

    91

    92

    93

def GetInstancesTableColnames():

    94

    _ = NoTranslate

    95

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

    96

    97

    98

class ResourceTable(CustomTable):

    99

   100

    """

   101

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

   102

    """

   103

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

   104

        # The base class must be initialized *first*

   105

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

   106

        self.ColAlignements = []

   107

        self.ColSizes = []

   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 = 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:

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

   305

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

   306

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

   307

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

   308

        self.TasksGrid.SetTable(self.TasksTable)

   309

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

   310

                                   "Delete": self.DeleteTaskButton,

   311

                                   "Up": self.UpTaskButton,

   312

                                   "Down": self.DownTaskButton})

   313

   314

        def _AddTask(new_row):

   315

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

   316

            self.RefreshModel()

   317

            self.RefreshView()

   318

            return new_row

   319

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

   320

   321

        def _DeleteTask(row):

   322

            self.TasksTable.RemoveRow(row)

   323

            self.RefreshModel()

   324

            self.RefreshView()

   325

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

   326

   327

        def _MoveTask(row, move):

   328

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

   329

            if new_row != row:

   330

                self.RefreshModel()

   331

                self.RefreshView()

   332

            return new_row

   333

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

   334

   335

        self.TasksGrid.SetRowLabelSize(0)

   336

        self.TasksTable.ResetView(self.TasksGrid)

   337

        self.TasksGrid.RefreshButtons()

   338

   339

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

   340

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

   341

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

   342

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

   343

        self.InstancesGrid.SetTable(self.InstancesTable)

   344

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

   345

                                       "Delete": self.DeleteInstanceButton,

   346

                                       "Up": self.UpInstanceButton,

   347

                                       "Down": self.DownInstanceButton})

   348

   349

        def _AddInstance(new_row):

   350

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

   351

            self.RefreshModel()

   352

            self.RefreshView()

   353

            return new_row

   354

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

   355

   356

        def _DeleteInstance(row):

   357

            self.InstancesTable.RemoveRow(row)

   358

            self.RefreshModel()

   359

            self.RefreshView()

   360

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

   361

   362

        def _MoveInstance(row, move):

   363

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

   364

            if new_row != row:

   365

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

   366

                    return row

   367

                self.InstancesTable.MoveRow(row, move)

   368

                self.RefreshModel()

   369

                self.RefreshView()

   370

            return new_row

   371

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

   372

   373

        def _RefreshInstanceButtons():

   374

            if self:

   375

                rows = self.InstancesTable.GetNumberRows()

   376

                row = self.InstancesGrid.GetGridCursorRow()

   377

                self.DeleteInstanceButton.Enable(rows > 0)

   378

                self.UpInstanceButton.Enable(

   379

                    row > 0 and

   380

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

   381

                self.DownInstanceButton.Enable(

   382

                    0 <= row < rows - 1 and

   383

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

   384

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

   385

   386

        self.InstancesGrid.SetRowLabelSize(0)

   387

        self.InstancesTable.ResetView(self.InstancesGrid)

   388

        self.InstancesGrid.RefreshButtons()

   389

   390

        self.TasksGrid.SetFocus()

   391

   392

    def __del__(self):

   393

        self.RefreshHighlightsTimer.Stop()

   394

   395

    def RefreshTypeList(self):

   396

        self.TypeList = ""

   397

        blocktypes = self.Controler.GetBlockResource()

   398

        for blocktype in blocktypes:

   399

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

   400

   401

    def RefreshTaskList(self):

   402

        self.TaskList = ""

   403

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

   404

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

   405

   406

    def RefreshVariableList(self):

   407

        self.VariableList = ""

   408

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

   409

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

   410

   411

    def RefreshModel(self):

   412

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

   413

        self.RefreshBuffer()

   414

   415

    # Buffer the last model state

   416

    def RefreshBuffer(self):

   417

        self.Controler.BufferProject()

   418

        self.ParentWindow.RefreshTitle()

   419

        self.ParentWindow.RefreshFileMenu()

   420

        self.ParentWindow.RefreshEditMenu()

   421

   422

    def GetBufferState(self):

   423

        return self.Controler.GetBufferState()

   424

   425

    def Undo(self):

   426

        self.Controler.LoadPrevious()

   427

        self.ParentWindow.CloseTabsWithoutModel()

   428

   429

    def Redo(self):

   430

        self.Controler.LoadNext()

   431

        self.ParentWindow.CloseTabsWithoutModel()

   432

   433

    def HasNoModel(self):

   434

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

   435

   436

    def RefreshView(self, variablepanel=True):

   437

        EditorPanel.RefreshView(self, variablepanel)

   438

   439

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

   440

        self.TasksTable.SetData(tasks)

   441

        self.InstancesTable.SetData(instances)

   442

        self.RefreshTypeList()

   443

        self.RefreshTaskList()

   444

        self.RefreshVariableList()

   445

        self.TasksTable.ResetView(self.TasksGrid)

   446

        self.InstancesTable.ResetView(self.InstancesGrid)

   447

        self.TasksGrid.RefreshButtons()

   448

        self.InstancesGrid.RefreshButtons()

   449

   450

    def ShowErrorMessage(self, message):

   451

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

   452

        dialog.ShowModal()

   453

        dialog.Destroy()

   454

   455

    def OnTasksGridCellChange(self, event):

   456

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

   457

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

   458

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

   459

            message = None

   460

   461

            if not TestIdentifier(value):

   462

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

   463

            elif value.upper() in IEC_KEYWORDS:

   464

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

   465

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

   466

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

   467

            if message is not None:

   468

                event.Veto()

   469

                wx.CallAfter(self.ShowErrorMessage, message)

   470

                return

   471

   472

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

   473

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

   474

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

   475

                if task in tasklist:

   476

                    tasklist.remove(task)

   477

            if len(tasklist) > 0:

   478

                old_name = tasklist[0].upper()

   479

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

   480

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

   481

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

   482

                    if old_name == name:

   483

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

   484

        self.RefreshModel()

   485

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

   486

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

   487

            wx.CallAfter(self.RefreshView, False)

   488

        event.Skip()

   489

   490

    def OnInstancesGridCellChange(self, event):

   491

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

   492

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

   493

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

   494

            message = None

   495

   496

            if not TestIdentifier(value):

   497

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

   498

            elif value.upper() in IEC_KEYWORDS:

   499

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

   500

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

   501

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

   502

            if message is not None:

   503

                event.Veto()