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

        self.InstanceChoice.Bind(wx.EVT_LEFT_DOWN, self.OnInstanceChoiceLeftDown)

    56

    57

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

    58

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

    59

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

    60

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

    61

                self.DebugButton)

    62

    63

        self.VariablesList = CT.CustomTreeCtrl(self,

    64

              style=wx.SUNKEN_BORDER,

    65

              agwStyle=CT.TR_NO_BUTTONS|

    66

                       CT.TR_SINGLE|

    67

                       CT.TR_HAS_VARIABLE_ROW_HEIGHT|

    68

                       CT.TR_HIDE_ROOT|

    69

                       CT.TR_NO_LINES|

    70

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

    71

        self.VariablesList.SetIndent(0)

    72

        self.VariablesList.SetSpacing(5)

    73

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

    74

        self.VariablesList.Bind(CT.EVT_TREE_ITEM_ACTIVATED,

    75

                self.OnVariablesListItemActivated)

    76

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

    77

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

    78

    79

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

    80

        buttons_sizer.AddWindow(self.ParentButton)

    81

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

    82

        buttons_sizer.AddWindow(self.DebugButton)

    83

        buttons_sizer.AddGrowableCol(1)

    84

        buttons_sizer.AddGrowableRow(0)

    85

    86

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

    87

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

    88

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

    89

        main_sizer.AddGrowableCol(0)

    90

        main_sizer.AddGrowableRow(1)

    91

    92

        self.SetSizer(main_sizer)

    93

    94

        self.ParentWindow = window

    95

        self.Controller = controller

    96

        self.Debug = debug

    97

        if not self.Debug:

    98

            self.DebugButton.Hide()

    99

   100

        self.PouTagName = None

   101

        self.PouInfos = None

   102

        self.PouInstance = None

   103

   104

    def __del__(self):

   105

        self.Controller = None

   106

   107

    def SetTreeImageList(self, tree_image_list):

   108

        self.VariablesList.SetImageList(tree_image_list)

   109

   110

    def SetController(self, controller):

   111

        self.Controller = controller

   112

   113

        self.RefreshView()

   114

   115

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

   116

        if self.Controller is not None:

   117

            self.PouTagName = tagname

   118

            if self.PouTagName == "Project":

   119

                config_name = self.Controller.GetProjectMainConfigurationName()

   120

                if config_name is not None:

   121

                    self.PouTagName = self.Controller.ComputeConfigurationName(config_name)

   122

            if pou_instance is not None:

   123

                self.PouInstance = pou_instance

   124

   125

        self.RefreshView()

   126

   127

    def ResetView(self):

   128

        self.Controller = None

   129

   130

        self.PouTagName = None

   131

        self.PouInfos = None

   132

        self.PouInstance = None

   133

   134

        self.RefreshView()

   135

   136

    def RefreshView(self):

   137

        self.Freeze()

   138

        self.VariablesList.DeleteAllItems()

   139

        self.InstanceChoice.Clear()

   140

        self.InstanceChoice.SetValue("")

   141

   142

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

   143

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

   144

        else:

   145

            self.PouInfos = None

   146

        if self.PouInfos is not None:

   147

            root = self.VariablesList.AddRoot("")

   148

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

   149

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

   150

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

   151

                else:

   152

                    text = var_infos["name"]

   153

   154

                panel = wx.Panel(self.VariablesList)

   155

   156

                buttons = []

   157

                if var_infos["class"] in ITEMS_VARIABLE:

   158

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

   159

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

   160

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

   161

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

   162

                              bitmap=GetBitmap("instance_graph"), 

   163

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

   164

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

   165

                        buttons.append(graph_button)

   166

                elif var_infos["edit"]:

   167

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

   168

                          bitmap=GetBitmap("edit"), 

   169

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

   170

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

   171

                    buttons.append(edit_button)

   172

   173

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

   174

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

   175

                          bitmap=GetBitmap("debug_instance"), 

   176

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

   177

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

   178

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

   179

                    buttons.append(debug_button)

   180

   181

                button_num = len(buttons)

   182

                if button_num > 0:

   183

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

   184

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

   185

                    panel_sizer = wx.BoxSizer(wx.HORIZONTAL)

   186

                    panel.SetSizer(panel_sizer)

   187

   188

                    for button in buttons:

   189

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

   190

                    panel_sizer.Layout()

   191

   192

                else:

   193

                    panel.Destroy()

   194

                    panel = None

   195

   196

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

   197

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

   198

                self.VariablesList.SetPyData(item, var_infos)

   199

   200

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

   201

            for instance in instances:

   202

                self.InstanceChoice.Append(instance)

   203

            if len(instances) == 1:

   204

                self.PouInstance = instances[0]

   205

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

   206

                self.PouInstance = None

   207

                self.InstanceChoice.SetSelection(0)

   208

            elif self.PouInstance in instances:

   209

                self.InstanceChoice.SetStringSelection(self.PouInstance)

   210

            else:

   211

                self.PouInstance = None

   212

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

   213

   214

        self.RefreshButtons()

   215

   216

        self.Thaw()

   217

   218

    def RefreshButtons(self):

   219

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

   220

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

   221

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

   222

   223

        root = self.VariablesList.GetRootItem()

   224

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

   225

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

   226

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

   227

                panel = self.VariablesList.GetItemWindow(item)

   228

                if panel is not None:

   229

                    for child in panel.GetChildren():

   230

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

   231

                            child.Enable(enabled)

   232

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

   233

   234

    def GenEditButtonCallback(self, infos):

   235

        def EditButtonCallback(event):

   236

            var_class = infos["class"]

   237

            if var_class == ITEM_RESOURCE:

   238

                tagname = self.Controller.ComputeConfigurationResourceName(

   239

                    self.InstanceChoice.GetStringSelection(), 

   240

                    infos["name"])

   241

            elif var_class == ITEM_TRANSITION:

   242

                tagname = self.Controller.ComputePouTransitionName(

   243

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

   244

                    infos["name"])

   245

            elif var_class == ITEM_ACTION:

   246

                tagname = self.Controller.ComputePouActionName(

   247

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

   248

                    infos["name"])

   249

            else:

   250

                var_class = ITEM_POU

   251

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

   252

            self.ParentWindow.EditProjectElement(var_class, tagname)

   253

            event.Skip()

   254

        return EditButtonCallback

   255

   256

    def GenDebugButtonCallback(self, infos):

   257

        def DebugButtonCallback(event):

   258

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

   259

                var_class = infos["class"]

   260

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

   261

                                      infos["name"])

   262

                if var_class in ITEMS_VARIABLE:

   263

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

   264

                elif var_class == ITEM_TRANSITION:

   265

                    self.ParentWindow.OpenDebugViewer(

   266

                        var_class,

   267

                        var_path,

   268

                        self.Controller.ComputePouTransitionName(

   269

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

   270

                            infos["name"]))

   271

                elif var_class == ITEM_ACTION:

   272

                    self.ParentWindow.OpenDebugViewer(

   273

                        var_class,

   274

                        var_path,

   275

                        self.Controller.ComputePouActionName(

   276

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

   277

                            infos["name"]))

   278

                else:

   279

                    self.ParentWindow.OpenDebugViewer(

   280

                        var_class,

   281

                        var_path,

   282

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

   283

            event.Skip()

   284

        return DebugButtonCallback

   285

   286

    def GenDebugButtonDClickCallback(self, infos):

   287

        def DebugButtonDClickCallback(event):

   288

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

   289

                if infos["class"] in ITEMS_VARIABLE:

   290

                    self.ParentWindow.AddDebugVariable(

   291

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

   292

                                   infos["name"]), 

   293

                        force=True,

   294

                        graph=True)

   295

            event.Skip()

   296

        return DebugButtonDClickCallback

   297

   298

    def GenGraphButtonCallback(self, infos):

   299

        def GraphButtonCallback(event):

   300

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

   301

                if infos["class"] in ITEMS_VARIABLE:

   302

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

   303

                                          infos["name"])

   304

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

   305

            event.Skip()

   306

        return GraphButtonCallback

   307

   308

    def ShowInstanceChoicePopup(self):

   309

        self.InstanceChoice.SetFocusFromKbd()

   310

        size = self.InstanceChoice.GetSize()

   311

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

   312

        event.m_x = size.width / 2

   313

        event.m_y = size.height / 2

   314

        event.SetEventObject(self.InstanceChoice)

   315

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

   316

        #event.m_keyCode = wx.WXK_SPACE

   317

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

   318

   319

    def OnParentButtonClick(self, event):

   320

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

   321

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

   322

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

   323

            if tagname is not None:

   324

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

   325

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

   326

        event.Skip()

   327

   328

    def OnInstanceChoiceChanged(self, event):

   329

        self.RefreshButtons()

   330

        event.Skip()

   331

   332

    def OnDebugButtonClick(self, event):

   333

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

   334

            self.ParentWindow.OpenDebugViewer(

   335

                self.PouInfos["class"],

   336

                self.InstanceChoice.GetStringSelection(),

   337

                self.PouTagName)

   338

        event.Skip()

   339

   340

    def OnVariablesListItemActivated(self, event):

   341

        selected_item = event.GetItem()

   342

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

   343

            item_infos = self.VariablesList.GetPyData(selected_item)

   344

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

   345

                instance_path = self.InstanceChoice.GetStringSelection()

   346

                if item_infos["class"] == ITEM_RESOURCE:

   347

                    if instance_path != "":

   348

                        tagname = self.Controller.ComputeConfigurationResourceName(

   349

                                       instance_path, 

   350

                                       item_infos["name"])

   351

                    else:

   352

                        tagname = None

   353

                else:

   354

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

   355

                if tagname is not None:

   356

                    if instance_path != "":

   357

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

   358

                    else:

   359

                        item_path = None

   360

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

   361

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

   362

        event.Skip()

   363

   364

    def OnVariablesListLeftDown(self, event):

   365

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

   366

            wx.CallAfter(self.ShowInstanceChoicePopup)

   367

        else:

   368

            instance_path = self.InstanceChoice.GetStringSelection()

   369

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

   370

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

   371

                item_infos = self.VariablesList.GetPyData(item)

   372

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

   373

                    self.ParentWindow.EnsureTabVisible(

   374

                        self.ParentWindow.DebugVariablePanel)

   375

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

   376

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

   377

                    dragSource = wx.DropSource(self.VariablesList)

   378

                    dragSource.SetData(data)

   379

                    dragSource.DoDragDrop()

   380

        event.Skip()

   381

   382

    def OnVariablesListKeyDown(self, event):

   383

        keycode = event.GetKeyCode()

   384

        if keycode != wx.WXK_LEFT:

   385

            event.Skip()

   386

   387

    def OnInstanceChoiceLeftDown(self, event):

   388

        event.Skip()