1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2012: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

import wx

    26

import wx.lib.buttons

    27

import wx.lib.agw.customtreectrl as CT

    28

    29

try:

    30

    import matplotlib

    31

    matplotlib.use('WX')

    32

    USE_MPL = True

    33

except:

    34

    USE_MPL = False

    35

    36

from PLCControler import ITEMS_VARIABLE, ITEM_CONFIGURATION, ITEM_RESOURCE, ITEM_POU, ITEM_TRANSITION, ITEM_ACTION

    37

from util.BitmapLibrary import GetBitmap

    38

    39

class PouInstanceVariablesPanel(wx.Panel):

    40

    41

    def __init__(self, parent, window, controller, debug):

    42

        wx.Panel.__init__(self, name='PouInstanceTreePanel', 

    43

                parent=parent, pos=wx.Point(0, 0), 

    44

                size=wx.Size(0, 0), style=wx.TAB_TRAVERSAL)

    45

    46

        self.ParentButton = wx.lib.buttons.GenBitmapButton(self,

    47

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

    48

        self.ParentButton.SetToolTipString(_("Parent instance"))

    49

        self.Bind(wx.EVT_BUTTON, self.OnParentButtonClick, 

    50

                self.ParentButton)

    51

    52

        self.InstanceChoice = wx.ComboBox(self, size=wx.Size(0, 0), style=wx.CB_READONLY)

    53

        self.Bind(wx.EVT_COMBOBOX, self.OnInstanceChoiceChanged,

    54

                self.InstanceChoice)

    55

    56

        self.DebugButton = wx.lib.buttons.GenBitmapButton(self, 

    57

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

    58

        self.DebugButton.SetToolTipString(_("Debug instance"))

    59

        self.Bind(wx.EVT_BUTTON, self.OnDebugButtonClick, 

    60

                self.DebugButton)

    61

    62

        self.VariablesList = CT.CustomTreeCtrl(self,

    63

              style=wx.SUNKEN_BORDER,

    64

              agwStyle=CT.TR_NO_BUTTONS|

    65

                       CT.TR_SINGLE|

    66

                       CT.TR_HAS_VARIABLE_ROW_HEIGHT|

    67

                       CT.TR_HIDE_ROOT|

    68

                       CT.TR_NO_LINES|

    69

                       getattr(CT, "TR_ALIGN_WINDOWS_RIGHT", CT.TR_ALIGN_WINDOWS))

    70

        self.VariablesList.SetIndent(0)

    71

        self.VariablesList.SetSpacing(5)

    72

        self.VariablesList.DoSelectItem = lambda *x,**y:True

    73

        self.VariablesList.Bind(CT.EVT_TREE_ITEM_ACTIVATED,

    74

                self.OnVariablesListItemActivated)

    75

        self.VariablesList.Bind(wx.EVT_LEFT_DOWN, self.OnVariablesListLeftDown)

    76

        self.VariablesList.Bind(wx.EVT_KEY_DOWN, self.OnVariablesListKeyDown)

    77

    78

        buttons_sizer = wx.FlexGridSizer(cols=3, hgap=0, rows=1, vgap=0)

    79

        buttons_sizer.AddWindow(self.ParentButton)

    80

        buttons_sizer.AddWindow(self.InstanceChoice, flag=wx.GROW)

    81

        buttons_sizer.AddWindow(self.DebugButton)

    82

        buttons_sizer.AddGrowableCol(1)

    83

        buttons_sizer.AddGrowableRow(0)

    84

    85

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

    86

        main_sizer.AddSizer(buttons_sizer, flag=wx.GROW)

    87

        main_sizer.AddWindow(self.VariablesList, flag=wx.GROW)

    88

        main_sizer.AddGrowableCol(0)

    89

        main_sizer.AddGrowableRow(1)

    90

    91

        self.SetSizer(main_sizer)

    92

    93

        self.ParentWindow = window

    94

        self.Controller = controller

    95

        self.Debug = debug

    96

        if not self.Debug:

    97

            self.DebugButton.Hide()

    98

    99

        self.PouTagName = None

   100

        self.PouInfos = None

   101

        self.PouInstance = None

   102

   103

    def __del__(self):

   104

        self.Controller = None

   105

   106

    def SetTreeImageList(self, tree_image_list):

   107

        self.VariablesList.SetImageList(tree_image_list)

   108

   109

    def SetController(self, controller):

   110

        self.Controller = controller

   111

   112

        self.RefreshView()

   113

   114

    def SetPouType(self, tagname, pou_instance=None):

   115

        if self.Controller is not None:

   116

            if tagname == "Project":

   117

                config_name = self.Controller.GetProjectMainConfigurationName()

   118

                if config_name is not None:

   119

                    tagname = self.Controller.ComputeConfigurationName(config_name)

   120

            if pou_instance is not None:

   121

                self.PouInstance = pou_instance

   122

   123

            if self.PouTagName != tagname:

   124

                self.PouTagName = tagname

   125

                self.RefreshView()

   126

            else:

   127

                self.RefreshInstanceChoice()

   128

        else:

   129

            self.RefreshView()

   130

   131

    def ResetView(self):

   132

        self.Controller = None

   133

   134

        self.PouTagName = None

   135

        self.PouInfos = None

   136

        self.PouInstance = None

   137

   138

        self.RefreshView()

   139

   140

    def RefreshView(self):

   141

        self.Freeze()

   142

        self.VariablesList.DeleteAllItems()

   143

   144

        if self.Controller is not None and self.PouTagName is not None:

   145

            self.PouInfos = self.Controller.GetPouVariables(self.PouTagName, self.Debug)

   146

        else:

   147

            self.PouInfos = None

   148

        if self.PouInfos is not None:

   149

            root = self.VariablesList.AddRoot("")

   150

            for var_infos in self.PouInfos["variables"]:

   151

                if var_infos.get("type", None) is not None:

   152

                    text = "%(name)s (%(type)s)" % var_infos

   153

                else:

   154

                    text = var_infos["name"]

   155

   156

                panel = wx.Panel(self.VariablesList)

   157

   158

                buttons = []

   159

                if var_infos["class"] in ITEMS_VARIABLE:

   160

                    if (not USE_MPL and var_infos["debug"] and self.Debug and

   161

                        (self.Controller.IsOfType(var_infos["type"], "ANY_NUM", True) or

   162

                         self.Controller.IsOfType(var_infos["type"], "ANY_BIT", True))):

   163

                        graph_button = wx.lib.buttons.GenBitmapButton(panel, 

   164

                              bitmap=GetBitmap("instance_graph"), 

   165

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

   166

                        self.Bind(wx.EVT_BUTTON, self.GenGraphButtonCallback(var_infos), graph_button)

   167

                        buttons.append(graph_button)

   168

                elif var_infos["edit"]:

   169

                    edit_button = wx.lib.buttons.GenBitmapButton(panel, 

   170

                          bitmap=GetBitmap("edit"), 

   171

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

   172

                    self.Bind(wx.EVT_BUTTON, self.GenEditButtonCallback(var_infos), edit_button)

   173

                    buttons.append(edit_button)

   174

   175

                if var_infos["debug"] and self.Debug:

   176

                    debug_button = wx.lib.buttons.GenBitmapButton(panel, 

   177

                          bitmap=GetBitmap("debug_instance"), 

   178

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

   179

                    self.Bind(wx.EVT_BUTTON, self.GenDebugButtonCallback(var_infos), debug_button)

   180

                    debug_button.Bind(wx.EVT_LEFT_DCLICK, self.GenDebugButtonDClickCallback(var_infos))

   181

                    buttons.append(debug_button)

   182

   183

                button_num = len(buttons)

   184

                if button_num > 0:

   185

                    panel.SetSize(wx.Size(button_num * 32, 28))

   186

                    panel.SetBackgroundColour(self.VariablesList.GetBackgroundColour())

   187

                    panel_sizer = wx.BoxSizer(wx.HORIZONTAL)

   188

                    panel.SetSizer(panel_sizer)

   189

   190

                    for button in buttons:

   191

                        panel_sizer.AddWindow(button, 0, border=4, flag=wx.LEFT)

   192

                    panel_sizer.Layout()

   193

   194

                else:

   195

                    panel.Destroy()

   196

                    panel = None

   197

   198

                item = self.VariablesList.AppendItem(root, text, wnd=panel)

   199

                self.VariablesList.SetItemImage(item, self.ParentWindow.GetTreeImage(var_infos["class"]))

   200

                self.VariablesList.SetPyData(item, var_infos)

   201

   202

        self.RefreshInstanceChoice()

   203

        self.RefreshButtons()

   204

   205

        self.Thaw()

   206

   207

    def RefreshInstanceChoice(self):

   208

        self.InstanceChoice.Clear()

   209

        self.InstanceChoice.SetValue("")

   210

        if self.Controller is not None and self.PouInfos is not None:

   211

            instances = self.Controller.SearchPouInstances(self.PouTagName, self.Debug)

   212

            for instance in instances:

   213

                self.InstanceChoice.Append(instance)

   214

            if len(instances) == 1:

   215

                self.PouInstance = instances[0]

   216

            if self.PouInfos["class"] in [ITEM_CONFIGURATION, ITEM_RESOURCE]:

   217

                self.PouInstance = None

   218

                self.InstanceChoice.SetSelection(0)

   219

            elif self.PouInstance in instances:

   220

                self.InstanceChoice.SetStringSelection(self.PouInstance)

   221

            else:

   222

                self.PouInstance = None

   223

                self.InstanceChoice.SetValue(_("Select an instance"))

   224

   225

    def RefreshButtons(self):

   226

        enabled = self.InstanceChoice.GetSelection() != -1

   227

        self.ParentButton.Enable(enabled and self.PouInfos["class"] != ITEM_CONFIGURATION)

   228

        self.DebugButton.Enable(enabled and self.PouInfos["debug"] and self.Debug)

   229

   230

        root = self.VariablesList.GetRootItem()

   231

        if root is not None and root.IsOk():

   232

            item, item_cookie = self.VariablesList.GetFirstChild(root)

   233

            while item is not None and item.IsOk():

   234

                panel = self.VariablesList.GetItemWindow(item)

   235

                if panel is not None:

   236

                    for child in panel.GetChildren():

   237

                        if child.GetName() != "edit":

   238

                            child.Enable(enabled)

   239

                item, item_cookie = self.VariablesList.GetNextChild(root, item_cookie)

   240

   241

    def GenEditButtonCallback(self, infos):

   242

        def EditButtonCallback(event):

   243

            var_class = infos["class"]

   244

            if var_class == ITEM_RESOURCE:

   245

                tagname = self.Controller.ComputeConfigurationResourceName(

   246

                    self.InstanceChoice.GetStringSelection(), 

   247

                    infos["name"])

   248

            elif var_class == ITEM_TRANSITION:

   249

                tagname = self.Controller.ComputePouTransitionName(

   250

                    self.PouTagName.split("::")[1],

   251

                    infos["name"])

   252

            elif var_class == ITEM_ACTION:

   253

                tagname = self.Controller.ComputePouActionName(

   254

                    self.PouTagName.split("::")[1],

   255

                    infos["name"])

   256

            else:

   257

                var_class = ITEM_POU

   258

                tagname = self.Controller.ComputePouName(infos["type"])

   259

            self.ParentWindow.EditProjectElement(var_class, tagname)

   260

            event.Skip()

   261

        return EditButtonCallback

   262

   263

    def GenDebugButtonCallback(self, infos):

   264

        def DebugButtonCallback(event):

   265

            if self.InstanceChoice.GetSelection() != -1:

   266

                var_class = infos["class"]

   267

                var_path = "%s.%s" % (self.InstanceChoice.GetStringSelection(), 

   268

                                      infos["name"])

   269

                if var_class in ITEMS_VARIABLE:

   270

                    self.ParentWindow.AddDebugVariable(var_path, force=True)

   271

                elif var_class == ITEM_TRANSITION:

   272

                    self.ParentWindow.OpenDebugViewer(

   273

                        var_class,

   274

                        var_path,

   275

                        self.Controller.ComputePouTransitionName(

   276

                            self.PouTagName.split("::")[1],

   277

                            infos["name"]))

   278

                elif var_class == ITEM_ACTION:

   279

                    self.ParentWindow.OpenDebugViewer(

   280

                        var_class,

   281

                        var_path,

   282

                        self.Controller.ComputePouActionName(

   283

                            self.PouTagName.split("::")[1],

   284

                            infos["name"]))

   285

                else:

   286

                    self.ParentWindow.OpenDebugViewer(

   287

                        var_class,

   288

                        var_path,

   289

                        self.Controller.ComputePouName(infos["type"]))

   290

            event.Skip()

   291

        return DebugButtonCallback

   292

   293

    def GenDebugButtonDClickCallback(self, infos):

   294

        def DebugButtonDClickCallback(event):

   295

            if self.InstanceChoice.GetSelection() != -1:

   296

                if infos["class"] in ITEMS_VARIABLE:

   297

                    self.ParentWindow.AddDebugVariable(

   298

                        "%s.%s" % (self.InstanceChoice.GetStringSelection(), 

   299

                                   infos["name"]), 

   300

                        force=True,

   301

                        graph=True)

   302

            event.Skip()

   303

        return DebugButtonDClickCallback

   304

   305

    def GenGraphButtonCallback(self, infos):

   306

        def GraphButtonCallback(event):

   307

            if self.InstanceChoice.GetSelection() != -1:

   308

                if infos["class"] in ITEMS_VARIABLE:

   309

                    var_path = "%s.%s" % (self.InstanceChoice.GetStringSelection(), 

   310

                                          infos["name"])

   311

                    self.ParentWindow.OpenDebugViewer(infos["class"], var_path, infos["type"])

   312

            event.Skip()

   313

        return GraphButtonCallback

   314

   315

    def ShowInstanceChoicePopup(self):

   316

        self.InstanceChoice.SetFocusFromKbd()

   317

        size = self.InstanceChoice.GetSize()

   318

        event = wx.MouseEvent(wx.EVT_LEFT_DOWN._getEvtType())

   319

        event.m_x = size.width / 2

   320

        event.m_y = size.height / 2

   321

        event.SetEventObject(self.InstanceChoice)

   322

        #event = wx.KeyEvent(wx.EVT_KEY_DOWN._getEvtType())

   323

        #event.m_keyCode = wx.WXK_SPACE

   324

        self.InstanceChoice.GetEventHandler().ProcessEvent(event)

   325

   326

    def OnParentButtonClick(self, event):

   327

        if self.InstanceChoice.GetSelection() != -1:

   328

            parent_path = self.InstanceChoice.GetStringSelection().rsplit(".", 1)[0]

   329

            tagname = self.Controller.GetPouInstanceTagName(parent_path, self.Debug)

   330

            if tagname is not None:

   331

                wx.CallAfter(self.SetPouType, tagname, parent_path)

   332

                wx.CallAfter(self.ParentWindow.SelectProjectTreeItem, tagname)

   333

        event.Skip()

   334

   335

    def OnInstanceChoiceChanged(self, event):

   336

        self.RefreshButtons()

   337

        event.Skip()

   338

   339

    def OnDebugButtonClick(self, event):

   340

        if self.InstanceChoice.GetSelection() != -1:

   341

            self.ParentWindow.OpenDebugViewer(

   342

                self.PouInfos["class"],

   343

                self.InstanceChoice.GetStringSelection(),

   344

                self.PouTagName)

   345

        event.Skip()

   346

   347

    def OnVariablesListItemActivated(self, event):

   348

        selected_item = event.GetItem()

   349

        if selected_item is not None and selected_item.IsOk():

   350

            item_infos = self.VariablesList.GetPyData(selected_item)

   351

            if item_infos is not None and item_infos["class"] not in ITEMS_VARIABLE:

   352

                instance_path = self.InstanceChoice.GetStringSelection()

   353

                if item_infos["class"] == ITEM_RESOURCE:

   354

                    if instance_path != "":

   355

                        tagname = self.Controller.ComputeConfigurationResourceName(

   356

                                       instance_path, 

   357

                                       item_infos["name"])

   358

                    else:

   359

                        tagname = None

   360

                else:

   361

                    tagname = self.Controller.ComputePouName(item_infos["type"])

   362

                if tagname is not None:

   363

                    if instance_path != "":

   364

                        item_path = "%s.%s" % (instance_path, item_infos["name"])

   365

                    else:

   366

                        item_path = None

   367

                    self.SetPouType(tagname, item_path)

   368

                    self.ParentWindow.SelectProjectTreeItem(tagname)

   369

        event.Skip()

   370

   371

    def OnVariablesListLeftDown(self, event):

   372

        if self.InstanceChoice.GetSelection() == -1:

   373

            wx.CallAfter(self.ShowInstanceChoicePopup)

   374

        else:

   375

            instance_path = self.InstanceChoice.GetStringSelection()

   376

            item, flags = self.VariablesList.HitTest(event.GetPosition())

   377

            if item is not None and flags & CT.TREE_HITTEST_ONITEMLABEL:

   378

                item_infos = self.VariablesList.GetPyData(item)

   379

                if item_infos is not None and item_infos["class"] in ITEMS_VARIABLE:

   380

                    self.ParentWindow.EnsureTabVisible(

   381

                        self.ParentWindow.DebugVariablePanel)

   382

                    item_path = "%s.%s" % (instance_path, item_infos["name"])

   383

                    data = wx.TextDataObject(str((item_path, "debug")))

   384

                    dragSource = wx.DropSource(self.VariablesList)

   385

                    dragSource.SetData(data)

   386

                    dragSource.DoDragDrop()

   387

        event.Skip()

   388

   389

    def OnVariablesListKeyDown(self, event):

   390

        keycode = event.GetKeyCode()

   391

        if keycode != wx.WXK_LEFT:

   392

            event.Skip()

   393