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

    43

class ConfigurationEditor(EditorPanel):

    44

    45

    ID = ID_CONFIGURATIONEDITOR

    46

    VARIABLE_PANEL_TYPE = "config"

    47

    48

    def GetBufferState(self):

    49

        return self.Controler.GetBufferState()

    50

    51

    def Undo(self):

    52

        self.Controler.LoadPrevious()

    53

        self.ParentWindow.CloseTabsWithoutModel()

    54

    55

    def Redo(self):

    56

        self.Controler.LoadNext()

    57

        self.ParentWindow.CloseTabsWithoutModel()

    58

    59

    def HasNoModel(self):

    60

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

    61

    62

    63

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

    64

#                            Resource Editor class

    65

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

    66

    67

def GetTasksTableColnames():

    69

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

    70

    71

    72

def GetTaskTriggeringOptions():

    74

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

    75

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

    76

    78

    79

    80

def CheckSingle(single, varlist):

    81

    return single in varlist

    82

    83

    84

def GetInstancesTableColnames():

    86

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

    87

    88

    89

class ResourceTable(CustomTable):

    90

    91

    """

    92

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

    93

    """

    94

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

    95

        # The base class must be initialized *first*

    96

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

    97

        self.ColAlignements = []

    98

        self.ColSizes = []

    99

   100

    def GetColAlignements(self):

   101

        return self.ColAlignements

   102

   103

    def SetColAlignements(self, list):

   104

        self.ColAlignements = list

   105

   106

    def GetColSizes(self):

   107

        return self.ColSizes

   108

   109

    def SetColSizes(self, list):

   110

        self.ColSizes = list

   111

   112

    def GetValue(self, row, col):

   113

        if row < self.GetNumberRows():

   114

            colname = self.GetColLabelValue(col, False)

   115

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

   116

            if colname == "Triggering":

   117

                return _(value)

   118

            return value

   119

   120

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

   121

        if col < len(self.colnames):

   122

            colname = self.GetColLabelValue(col, False)

   123

            if colname == "Triggering":

   124

                value = TASKTRIGGERINGOPTIONS_DICT[value]

   125

            self.data[row][colname] = value

   126

   127

    def _updateColAttrs(self, grid):

   128

        """

   129

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

   130

        appropriate renderer given the column name.

   131

   132

        Otherwise default to the default renderer.

   133

        """

   134

   135

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

   136

            attr = wx.grid.GridCellAttr()

   137

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

   138

            grid.SetColAttr(col, attr)

   139

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

   140

   141

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

   142

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

   143

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

   144

                editor = None

   145

                renderer = None

   146

                error = False

   147

                colname = self.GetColLabelValue(col, False)

   148

                grid.SetReadOnly(row, col, False)

   149

                if colname == "Name":

   150

                    editor = wx.grid.GridCellTextEditor()

   151

                    renderer = wx.grid.GridCellStringRenderer()

   152

                elif colname == "Interval":

   153

                    editor = DurationCellEditor(self, colname)

   154

                    renderer = wx.grid.GridCellStringRenderer()

   155

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

   156

                        grid.SetReadOnly(row, col, True)

   157

                    interval = self.GetValueByName(row, colname)

   158

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

   159

                        error = True

   160

                elif colname == "Single":

   161

                    editor = SingleCellEditor(self,colname)

   162

                    editor.SetParameters(self.Parent.VariableList)

   163

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

   164

                        grid.SetReadOnly(row, col, True)

   165

                    single = self.GetValueByName(row, colname)

   166

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

   167

                        error = True

   168

                elif colname == "Triggering":

   169

                    editor = wx.grid.GridCellChoiceEditor()

   170

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

   171

                elif colname == "Type":

   172

                    editor = wx.grid.GridCellChoiceEditor()

   173

                    editor.SetParameters(self.Parent.TypeList)

   174

                elif colname == "Priority":

   175

                    editor = wx.grid.GridCellNumberEditor()

   176

                    editor.SetParameters("0,65535")

   177

                elif colname == "Task":

   178

                    editor = wx.grid.GridCellChoiceEditor()

   179

                    editor.SetParameters(self.Parent.TaskList)

   180

   181

                grid.SetCellEditor(row, col, editor)

   182

                grid.SetCellRenderer(row, col, renderer)

   183

   184

                if error:

   185

                    highlight_colours = ERROR_HIGHLIGHT

   186

                else:

   187

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

   188

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

   189

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

   190

            self.ResizeRow(grid, row)

   191

   192

   193

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

   194

#                        Highlights showing functions

   195

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

   196

   197

    def AddHighlight(self, infos, highlight_type):

   198

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

   199

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

   200

        col_highlights.append(highlight_type)

   201

   202

    def ClearHighlights(self, highlight_type=None):

   203

        if highlight_type is None:

   204

            self.Highlights = {}

   205

        else:

   206

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

   207

                row_items = row_highlights.items()

   208

                for col, col_highlights in row_items:

   209

                    if highlight_type in col_highlights:

   210

                        col_highlights.remove(highlight_type)

   211

                    if len(col_highlights) == 0:

   212

                        row_highlights.pop(col)

   213

   214

   215

   216

class ResourceEditor(EditorPanel):

   217

   218

    VARIABLE_PANEL_TYPE = "resource"

   219

   220

    def _init_Editor(self, parent):

   221

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

   222

   223

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

   224

        main_sizer.AddGrowableCol(0)

   225

        main_sizer.AddGrowableRow(0)

   226

        main_sizer.AddGrowableRow(1)

   227

   228

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

   229

        tasks_sizer.AddGrowableCol(0)

   230

        tasks_sizer.AddGrowableRow(1)

   231

        main_sizer.AddSizer(tasks_sizer, border=5,

   232

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

   233

   234

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

   235

        tasks_buttons_sizer.AddGrowableCol(0)

   236

        tasks_buttons_sizer.AddGrowableRow(0)

   237

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

   238

   239

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

   240

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

   241

   242

        for name, bitmap, help in [

   243

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

   244

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

   245

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

   246

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

   247

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

   248

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

   249

            button.SetToolTipString(help)

   250

            setattr(self, name, button)

   251

            tasks_buttons_sizer.AddWindow(button)

   252

   253

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

   254

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

   255

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

   256

   257

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

   258

        instances_sizer.AddGrowableCol(0)

   259

        instances_sizer.AddGrowableRow(1)

   260

        main_sizer.AddSizer(instances_sizer, border=5,

   261

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

   262

   263

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

   264

        instances_buttons_sizer.AddGrowableCol(0)

   265

        instances_buttons_sizer.AddGrowableRow(0)

   266

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

   267

   268

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

   269

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

   270

   271

        for name, bitmap, help in [

   272

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

   273

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

   274

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

   275

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

   276

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

   277

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

   278

            button.SetToolTipString(help)

   279

            setattr(self, name, button)

   280

            instances_buttons_sizer.AddWindow(button)

   281

   282

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

   283

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

   284

              self.OnInstancesGridCellChange)

   285

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

   286

   287

        self.Editor.SetSizer(main_sizer)

   288

   289

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

   290

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

   291

   292

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

   293

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

   294

   296

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

   297

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

   298

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

   299

        self.TasksGrid.SetTable(self.TasksTable)

   300

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

   301

                                   "Delete": self.DeleteTaskButton,

   302

                                   "Up": self.UpTaskButton,

   303

                                   "Down": self.DownTaskButton})

   304

   305

        def _AddTask(new_row):

   306

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

   307

            self.RefreshModel()

   308

            self.RefreshView()

   309

            return new_row

   310

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

   311

   312

        def _DeleteTask(row):

   313

            self.TasksTable.RemoveRow(row)

   314

            self.RefreshModel()

   315

            self.RefreshView()

   316

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

   317

   318

        def _MoveTask(row, move):

   319

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

   320

            if new_row != row:

   321

                self.RefreshModel()

   322

                self.RefreshView()

   323

            return new_row

   324

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

   325

   326

        self.TasksGrid.SetRowLabelSize(0)

   327

        self.TasksTable.ResetView(self.TasksGrid)

   328

        self.TasksGrid.RefreshButtons()

   329

   331

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

   332

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

   333

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

   334

        self.InstancesGrid.SetTable(self.InstancesTable)

   335

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

   336

                                       "Delete": self.DeleteInstanceButton,

   337

                                       "Up": self.UpInstanceButton,

   338

                                       "Down": self.DownInstanceButton})

   339

   340

        def _AddInstance(new_row):

   341

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

   342

            self.RefreshModel()

   343

            self.RefreshView()

   344

            return new_row

   345

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

   346

   347

        def _DeleteInstance(row):

   348

            self.InstancesTable.RemoveRow(row)

   349

            self.RefreshModel()

   350

            self.RefreshView()

   351

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

   352

   353

        def _MoveInstance(row, move):

   354

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

   355

            if new_row != row:

   356

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

   357

                    return row

   358

                self.InstancesTable.MoveRow(row, move)

   359

                self.RefreshModel()

   360

                self.RefreshView()

   361

            return new_row

   362

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

   363

   364

        def _RefreshInstanceButtons():

   365

            if self:

   366

                rows = self.InstancesTable.GetNumberRows()

   367

                row = self.InstancesGrid.GetGridCursorRow()

   368

                self.DeleteInstanceButton.Enable(rows > 0)

   369

                self.UpInstanceButton.Enable(row > 0 and

   370

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

   371

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

   372

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

   373

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

   374

   375

        self.InstancesGrid.SetRowLabelSize(0)

   376

        self.InstancesTable.ResetView(self.InstancesGrid)

   377

        self.InstancesGrid.RefreshButtons()

   378

   379

        self.TasksGrid.SetFocus()

   380

   381

    def __del__(self):

   382

        self.RefreshHighlightsTimer.Stop()

   383

   384

    def RefreshTypeList(self):

   385

        self.TypeList = ""

   386

        blocktypes = self.Controler.GetBlockResource()

   387

        for blocktype in blocktypes:

   388

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

   389

   390

    def RefreshTaskList(self):

   391

        self.TaskList = ""

   392

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

   393

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

   394

   395

    def RefreshVariableList(self):

   396

        self.VariableList = ""

   397

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

   398

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

   399

   400

    def RefreshModel(self):

   401

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

   402

        self.RefreshBuffer()

   403

   404

    # Buffer the last model state

   405

    def RefreshBuffer(self):

   406

        self.Controler.BufferProject()

   407

        self.ParentWindow.RefreshTitle()

   408

        self.ParentWindow.RefreshFileMenu()

   409

        self.ParentWindow.RefreshEditMenu()

   410

   411

    def GetBufferState(self):

   412

        return self.Controler.GetBufferState()

   413

   414

    def Undo(self):

   415

        self.Controler.LoadPrevious()

   416

        self.ParentWindow.CloseTabsWithoutModel()

   417

   418

    def Redo(self):

   419

        self.Controler.LoadNext()

   420

        self.ParentWindow.CloseTabsWithoutModel()

   421

   422

    def HasNoModel(self):

   423

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

   424

   425

    def RefreshView(self, variablepanel=True):

   426

        EditorPanel.RefreshView(self, variablepanel)

   427

   428

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

   429

        self.TasksTable.SetData(tasks)

   430

        self.InstancesTable.SetData(instances)

   431

        self.RefreshTypeList()

   432

        self.RefreshTaskList()

   433

        self.RefreshVariableList()

   434

        self.TasksTable.ResetView(self.TasksGrid)

   435

        self.InstancesTable.ResetView(self.InstancesGrid)

   436

        self.TasksGrid.RefreshButtons()

   437

        self.InstancesGrid.RefreshButtons()

   438

   439

    def ShowErrorMessage(self, message):

   440

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

   441

        dialog.ShowModal()

   442

        dialog.Destroy()

   443

   444

    def OnTasksGridCellChange(self, event):

   445

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

   446

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

   447

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

   448

            message = None

   449

   450

            if not TestIdentifier(value):

   451

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

   452

            elif value.upper() in IEC_KEYWORDS:

   453

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

   454

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

   455

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

   456

            if message is not None:

   457

                event.Veto()

   458

                wx.CallAfter(self.ShowErrorMessage, message)

   459

                return

   460

   461

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

   462

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

   463

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

   464

                if task in tasklist:

   465

                    tasklist.remove(task)

   466

            if len(tasklist) > 0:

   467

                old_name = tasklist[0].upper()

   468

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

   469

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

   470

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

   471

                    if old_name == name:

   472

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

   473

        self.RefreshModel()

   474

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

   475

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

   476

            wx.CallAfter(self.RefreshView, False)

   477

        event.Skip()

   478

   479

    def OnInstancesGridCellChange(self, event):

   480

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

   481

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

   482

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

   483

            message = None

   484

   485

            if not TestIdentifier(value):

   486

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

   487

            elif value.upper() in IEC_KEYWORDS:

   488

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

   490

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

   491

            if message is not None:

   492

                event.Veto()

   493

                wx.CallAfter(self.ShowErrorMessage, message)

   494

                return

   495

   496

        self.RefreshModel()

   497

        self.ParentWindow.RefreshPouInstanceVariablesPanel()

   498

        self.InstancesGrid.RefreshButtons()

   499

        event.Skip()

   500

   501

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

   502

#                        Highlights showing functions

   503

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

   504

   505

    def OnRefreshHighlightsTimer(self, event):

   506

        self.RefreshView()