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

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

    36

#                          Configuration Editor class

    37

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

    38

    39

[ID_CONFIGURATIONEDITOR,

    40

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

    41

    42

class ConfigurationEditor(EditorPanel):

    43

    44

    ID = ID_CONFIGURATIONEDITOR

    45

    VARIABLE_PANEL_TYPE = "config"

    46

    47

    def GetBufferState(self):

    48

        return self.Controler.GetBufferState()

    49

    50

    def Undo(self):

    51

        self.Controler.LoadPrevious()

    52

        self.ParentWindow.CloseTabsWithoutModel()

    53

    54

    def Redo(self):

    55

        self.Controler.LoadNext()

    56

        self.ParentWindow.CloseTabsWithoutModel()

    57

    58

    def HasNoModel(self):

    59

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

    60

    61

    62

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

    63

#                            Resource Editor class

    64

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

    65

    66

def GetTasksTableColnames():

    67

    _ = lambda x : x

    68

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

    69

    70

def GetTaskTriggeringOptions():

    71

    _ = lambda x : x

    72

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

    73

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

    74

    75

SingleCellEditor = lambda *x : wx.grid.GridCellChoiceEditor()

    76

    77

def CheckSingle(single, varlist):

    78

    return single in varlist

    79

    80

    81

def GetInstancesTableColnames():

    82

    _ = lambda x : x

    83

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

    84

    85

class ResourceTable(CustomTable):

    86

    87

    """

    88

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

    89

    """

    90

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

    91

        # The base class must be initialized *first*

    92

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

    93

        self.ColAlignements = []

    94

        self.ColSizes = []

    95

    96

    def GetColAlignements(self):

    97

        return self.ColAlignements

    98

    99

    def SetColAlignements(self, list):

   100

        self.ColAlignements = list

   101

   102

    def GetColSizes(self):

   103

        return self.ColSizes

   104

   105

    def SetColSizes(self, list):

   106

        self.ColSizes = list

   107

   108

    def GetValue(self, row, col):

   109

        if row < self.GetNumberRows():

   110

            colname = self.GetColLabelValue(col, False)

   111

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

   112

            if colname == "Triggering":

   113

                return _(value)

   114

            return value

   115

   116

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

   117

        if col < len(self.colnames):

   118

            colname = self.GetColLabelValue(col, False)

   119

            if colname == "Triggering":

   120

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   121

            self.data[row][colname] = value

   122

   123

    def _updateColAttrs(self, grid):

   124

        """

   125

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

   126

        appropriate renderer given the column name.

   127

   128

        Otherwise default to the default renderer.

   129

        """

   130

   131

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

   132

            attr = wx.grid.GridCellAttr()

   133

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

   134

            grid.SetColAttr(col, attr)

   135

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

   136

   137

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

   138

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

   139

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

   140

                editor = None

   141

                renderer = None

   142

                error = False

   143

                colname = self.GetColLabelValue(col, False)

   144

                grid.SetReadOnly(row, col, False)

   145

                if colname == "Name":

   146

                    editor = wx.grid.GridCellTextEditor()

   147

                    renderer = wx.grid.GridCellStringRenderer()

   148

                elif colname == "Interval":

   149

                    editor = DurationCellEditor(self, colname)

   150

                    renderer = wx.grid.GridCellStringRenderer()

   151

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

   152

                        grid.SetReadOnly(row, col, True)

   153

                    interval = self.GetValueByName(row, colname)

   154

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

   155

                        error = True

   156

                elif colname == "Single":

   157

                    editor = SingleCellEditor(self,colname)

   158

                    editor.SetParameters(self.Parent.VariableList)

   159

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

   160

                        grid.SetReadOnly(row, col, True)

   161

                    single = self.GetValueByName(row, colname)

   162

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

   163

                        error = True

   164

                elif colname == "Triggering":

   165

                    editor = wx.grid.GridCellChoiceEditor()

   166

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

   167

                elif colname == "Type":

   168

                    editor = wx.grid.GridCellChoiceEditor()

   169

                    editor.SetParameters(self.Parent.TypeList)

   170

                elif colname == "Priority":

   171

                    editor = wx.grid.GridCellNumberEditor()

   172

                    editor.SetParameters("0,65535")

   173

                elif colname == "Task":

   174

                    editor = wx.grid.GridCellChoiceEditor()

   175

                    editor.SetParameters(self.Parent.TaskList)

   176

   177

                grid.SetCellEditor(row, col, editor)

   178

                grid.SetCellRenderer(row, col, renderer)

   179

   180

                if error:

   181

                    highlight_colours = ERROR_HIGHLIGHT

   182

                else:

   183

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

   184

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

   185

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

   186

            self.ResizeRow(grid, row)

   187

   188

   189

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

   190

#                        Highlights showing functions

   191

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

   192

   193

    def AddHighlight(self, infos, highlight_type):

   194

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

   195

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

   196

        col_highlights.append(highlight_type)

   197

   198

    def ClearHighlights(self, highlight_type=None):

   199

        if highlight_type is None:

   200

            self.Highlights = {}

   201

        else:

   202

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

   203

                row_items = row_highlights.items()

   204

                for col, col_highlights in row_items:

   205

                    if highlight_type in col_highlights:

   206

                        col_highlights.remove(highlight_type)

   207

                    if len(col_highlights) == 0:

   208

                        row_highlights.pop(col)

   209

   210

   211

   212

class ResourceEditor(EditorPanel):

   213

   214

    VARIABLE_PANEL_TYPE = "resource"

   215

   216

    def _init_Editor(self, parent):

   217

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

   218

   219

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

   220

        main_sizer.AddGrowableCol(0)

   221

        main_sizer.AddGrowableRow(0)

   222

        main_sizer.AddGrowableRow(1)

   223

   224

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

   225

        tasks_sizer.AddGrowableCol(0)

   226

        tasks_sizer.AddGrowableRow(1)

   227

        main_sizer.AddSizer(tasks_sizer, border=5,

   228

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

   229

   230

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

   231

        tasks_buttons_sizer.AddGrowableCol(0)

   232

        tasks_buttons_sizer.AddGrowableRow(0)

   233

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

   234

   235

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

   236

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

   237

   238

        for name, bitmap, help in [

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

            button.SetToolTipString(help)

   246

            setattr(self, name, button)

   247

            tasks_buttons_sizer.AddWindow(button)

   248

   249

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

   250

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

   251

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

   252

   253

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

   254

        instances_sizer.AddGrowableCol(0)

   255

        instances_sizer.AddGrowableRow(1)

   256

        main_sizer.AddSizer(instances_sizer, border=5,

   257

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

   258

   259

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

   260

        instances_buttons_sizer.AddGrowableCol(0)

   261

        instances_buttons_sizer.AddGrowableRow(0)

   262

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

   263

   264

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

   265

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

   266

   267

        for name, bitmap, help in [

   268

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

   269

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

   270

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

   271

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

   272

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

   273

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

   274

            button.SetToolTipString(help)

   275

            setattr(self, name, button)

   276

            instances_buttons_sizer.AddWindow(button)

   277

   278

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

   279

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

   280

              self.OnInstancesGridCellChange)

   281

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

   282

   283

        self.Editor.SetSizer(main_sizer)

   284

   285

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

   286

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

   287

   288

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

   289

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

   290

   291

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

   292

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

   293

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

   294

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

   295

        self.TasksGrid.SetTable(self.TasksTable)

   296

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

   297

                                   "Delete": self.DeleteTaskButton,

   298

                                   "Up": self.UpTaskButton,

   299

                                   "Down": self.DownTaskButton})

   300

   301

        def _AddTask(new_row):

   302

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

   303

            self.RefreshModel()

   304

            self.RefreshView()

   305

            return new_row

   306

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

   307

   308

        def _DeleteTask(row):

   309

            self.TasksTable.RemoveRow(row)

   310

            self.RefreshModel()

   311

            self.RefreshView()

   312

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

   313

   314

        def _MoveTask(row, move):

   315

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

   316

            if new_row != row:

   317

                self.RefreshModel()

   318

                self.RefreshView()

   319

            return new_row

   320

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

   321

   322

        self.TasksGrid.SetRowLabelSize(0)

   323

        self.TasksTable.ResetView(self.TasksGrid)

   324

        self.TasksGrid.RefreshButtons()

   325

   326

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

   327

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

   328

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

   329

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

   330

        self.InstancesGrid.SetTable(self.InstancesTable)

   331

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

   332

                                       "Delete": self.DeleteInstanceButton,

   333

                                       "Up": self.UpInstanceButton,

   334

                                       "Down": self.DownInstanceButton})

   335

   336

        def _AddInstance(new_row):

   337

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

   338

            self.RefreshModel()

   339

            self.RefreshView()

   340

            return new_row

   341

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

   342

   343

        def _DeleteInstance(row):

   344

            self.InstancesTable.RemoveRow(row)

   345

            self.RefreshModel()

   346

            self.RefreshView()

   347

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

   348

   349

        def _MoveInstance(row, move):

   350

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

   351

            if new_row != row:

   352

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

   353

                    return row

   354

                self.InstancesTable.MoveRow(row, move)

   355

                self.RefreshModel()

   356

                self.RefreshView()

   357

            return new_row

   358

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

   359

   360

        def _RefreshInstanceButtons():

   361

            if self:

   362

                rows = self.InstancesTable.GetNumberRows()

   363

                row = self.InstancesGrid.GetGridCursorRow()

   364

                self.DeleteInstanceButton.Enable(rows > 0)

   365

                self.UpInstanceButton.Enable(row > 0 and

   366

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

   367

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

   368

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

   369

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

   370

   371

        self.InstancesGrid.SetRowLabelSize(0)

   372

        self.InstancesTable.ResetView(self.InstancesGrid)

   373

        self.InstancesGrid.RefreshButtons()

   374

   375

        self.TasksGrid.SetFocus()

   376

   377

    def __del__(self):

   378

        self.RefreshHighlightsTimer.Stop()

   379

   380

    def RefreshTypeList(self):

   381

        self.TypeList = ""

   382

        blocktypes = self.Controler.GetBlockResource()

   383

        for blocktype in blocktypes:

   384

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

   385

   386

    def RefreshTaskList(self):

   387

        self.TaskList = ""

   388

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

   389

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

   390

   391

    def RefreshVariableList(self):

   392

        self.VariableList = ""

   393

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

   394

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

   395

   396

    def RefreshModel(self):

   397

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

   398

        self.RefreshBuffer()

   399

   400

    # Buffer the last model state

   401

    def RefreshBuffer(self):

   402

        self.Controler.BufferProject()

   403

        self.ParentWindow.RefreshTitle()

   404

        self.ParentWindow.RefreshFileMenu()

   405

        self.ParentWindow.RefreshEditMenu()

   406

   407

    def GetBufferState(self):

   408

        return self.Controler.GetBufferState()

   409

   410

    def Undo(self):

   411

        self.Controler.LoadPrevious()

   412

        self.ParentWindow.CloseTabsWithoutModel()

   413

   414

    def Redo(self):

   415

        self.Controler.LoadNext()

   416

        self.ParentWindow.CloseTabsWithoutModel()

   417

   418

    def HasNoModel(self):

   419

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

   420

   421

    def RefreshView(self, variablepanel=True):

   422

        EditorPanel.RefreshView(self, variablepanel)

   423

   424

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

   425

        self.TasksTable.SetData(tasks)

   426

        self.InstancesTable.SetData(instances)

   427

        self.RefreshTypeList()

   428

        self.RefreshTaskList()

   429

        self.RefreshVariableList()

   430

        self.TasksTable.ResetView(self.TasksGrid)

   431

        self.InstancesTable.ResetView(self.InstancesGrid)

   432

        self.TasksGrid.RefreshButtons()

   433

        self.InstancesGrid.RefreshButtons()

   434

   435

    def ShowErrorMessage(self, message):

   436

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

   437

        dialog.ShowModal()

   438

        dialog.Destroy()

   439

   440

    def OnTasksGridCellChange(self, event):

   441

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

   442

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

   443

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

   444

            message = None

   445

   446

            if not TestIdentifier(value):

   447

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

   448

            elif value.upper() in IEC_KEYWORDS:

   449

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

   450

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

   451

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

   452

            if message is not None:

   453

                event.Veto()

   454

                wx.CallAfter(self.ShowErrorMessage, message)

   455

                return

   456

   457

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

   458

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

   459

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

   460

                if task in tasklist:

   461

                    tasklist.remove(task)

   462

            if len(tasklist) > 0:

   463

                old_name = tasklist[0].upper()

   464

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

   465

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

   466

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

   467

                    if old_name == name:

   468

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

   469

        self.RefreshModel()

   470

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

   471

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

   472

            wx.CallAfter(self.RefreshView, False)

   473

        event.Skip()

   474

   475

    def OnInstancesGridCellChange(self, event):

   476

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

   477

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

   478

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

   479

            message = None

   480

   481

            if not TestIdentifier(value):

   482

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

   483

            elif value.upper() in IEC_KEYWORDS:

   484

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

   485

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

   486

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

   487

            if message is not None:

   488

                event.Veto()

   489

                wx.CallAfter(self.ShowErrorMessage, message)

   490

                return

   491

   492

        self.RefreshModel()

   493

        self.ParentWindow.RefreshPouInstanceVariablesPanel()

   494

        self.InstancesGrid.RefreshButtons()

   495

        event.Skip()

   496

   497

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

   498

#                        Highlights showing functions

   499

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

   500

   501

    def OnRefreshHighlightsTimer(self, event):

   502

        self.RefreshView()

   503

        event.Skip()

   504

   505

    def AddHighlight(self, infos, start, end, highlight_type):

   506

        EditorPanel.AddHighlight(self, infos, start, end, highlight_type)

   507

   508

        if infos[0] == "task":