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

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

    30

from util.BitmapLibrary import GetBitmap

    31

    32

class PouInstanceVariablesPanel(wx.Panel):

    33

    34

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

    35

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

    36

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

    37

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

    38

    39

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

    40

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

    41

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

    42

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

    43

                self.ParentButton)

    44

    45

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

    46

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

    47

                self.InstanceChoice)

    48

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

    49

    50

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

    51

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

    52

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

    53

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

    54

                self.DebugButton)

    55

    56

        self.VariablesList = CT.CustomTreeCtrl(self,

    57

              style=wx.SUNKEN_BORDER,

    58

              agwStyle=CT.TR_NO_BUTTONS|

    59

                       CT.TR_SINGLE|

    60

                       CT.TR_HAS_VARIABLE_ROW_HEIGHT|

    61

                       CT.TR_HIDE_ROOT|

    62

                       CT.TR_NO_LINES|

    63

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

    64

        self.VariablesList.SetIndent(0)

    65

        self.VariablesList.SetSpacing(5)

    66

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

    67

        self.VariablesList.Bind(CT.EVT_TREE_ITEM_ACTIVATED,

    68

                self.OnVariablesListItemActivated)

    69

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

    70

    71

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

    72

        buttons_sizer.AddWindow(self.ParentButton)

    73

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

    74

        buttons_sizer.AddWindow(self.DebugButton)

    75

        buttons_sizer.AddGrowableCol(1)

    76

        buttons_sizer.AddGrowableRow(0)

    77

    78

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

    79

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

    80

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

    81

        main_sizer.AddGrowableCol(0)

    82

        main_sizer.AddGrowableRow(1)

    83

    84

        self.SetSizer(main_sizer)

    85

    86

        self.ParentWindow = window

    87

        self.Controller = controller

    88

        self.Debug = debug

    89

        if not self.Debug:

    90

            self.DebugButton.Hide()

    91

    92

        self.PouTagName = None

    93

        self.PouInfos = None

    94

        self.PouInstance = None

    95

    96

    def __del__(self):

    97

        self.Controller = None

    98

    99

    def SetTreeImageList(self, tree_image_list):

   100

        self.VariablesList.SetImageList(tree_image_list)

   101

   102

    def SetController(self, controller):

   103

        self.Controller = controller

   104

   105

        self.RefreshView()

   106

   107

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

   108

        self.PouTagName = tagname

   113

        if pou_instance is not None:

   114

            self.PouInstance = pou_instance

   115

   116

        self.RefreshView()

   117

   118

    def ResetView(self):

   119

        self.Controller = None

   120

   121

        self.PouTagName = None

   122

        self.PouInfos = None

   123

        self.PouInstance = None

   124

   125

        self.RefreshView()

   126

   127

    def RefreshView(self):

   128

        self.VariablesList.DeleteAllItems()

   129

        self.InstanceChoice.Clear()

   130

        self.InstanceChoice.SetValue("")

   131

   132

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

   133

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

   134

        else:

   135

            self.PouInfos = None

   136

        if self.PouInfos is not None:

   137

            root = self.VariablesList.AddRoot("")

   138

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

   139

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

   140

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

   141

                else:

   142

                    text = var_infos["name"]

   143

   144

                panel = wx.Panel(self.VariablesList)

   145

   146

                buttons = []

   147

                if var_infos["class"] in ITEMS_VARIABLE:

   148

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

   149

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

   150

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

   151

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

   152

                              bitmap=GetBitmap("instance_graph"), 

   153

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

   154

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

   155

                        buttons.append(graph_button)

   156

                elif var_infos["edit"]:

   157

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

   158

                          bitmap=GetBitmap("edit"), 

   159

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

   160

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

   161

                    buttons.append(edit_button)

   162

   163

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

   164

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

   165

                          bitmap=GetBitmap("debug_instance"), 

   166

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

   167

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

   168

                    buttons.append(debug_button)

   169

   170

                button_num = len(buttons)

   171

                if button_num > 0:

   172

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

   173

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

   174

                    panel_sizer = wx.BoxSizer(wx.HORIZONTAL)

   175

                    panel.SetSizer(panel_sizer)

   176

   177

                    for button in buttons:

   178

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

   179

                    panel_sizer.Layout()

   180

   181

                else:

   182

                    panel.Destroy()

   183

                    panel = None

   184

   185

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

   186

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

   187

                self.VariablesList.SetPyData(item, var_infos)

   188

   189

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

   190

            for instance in instances:

   191

                self.InstanceChoice.Append(instance)

   192

            if len(instances) == 1:

   193

                self.PouInstance = instances[0]

   194

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

   195

                self.PouInstance = None

   196

                self.InstanceChoice.SetSelection(0)

   197

            elif self.PouInstance in instances:

   198

                self.InstanceChoice.SetStringSelection(self.PouInstance)

   199

            else:

   200

                self.PouInstance = None

   201

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

   202

   203

        self.RefreshButtons()

   204

   205

    def RefreshButtons(self):

   206

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

   207

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

   208

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

   209

   210

        root = self.VariablesList.GetRootItem()

   211

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

   212

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

   213

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

   214

                panel = self.VariablesList.GetItemWindow(item)

   215

                if panel is not None:

   216

                    for child in panel.GetChildren():

   217

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

   218

                            child.Enable(enabled)

   219

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

   220

   221

    def GenEditButtonCallback(self, infos):

   222

        def EditButtonCallback(event):

   223

            var_class = infos["class"]

   224

            if var_class == ITEM_RESOURCE:

   225

                tagname = self.Controller.ComputeConfigurationResourceName(

   226

                    self.InstanceChoice.GetStringSelection(), 

   227

                    infos["name"])

   228

            elif var_class == ITEM_TRANSITION:

   229

                tagname = self.Controller.ComputePouTransitionName(

   230

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

   231

                    infos["name"])

   232

            elif var_class == ITEM_ACTION:

   233

                tagname = self.Controller.ComputePouActionName(

   234

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

   235

                    infos["name"])

   236

            else:

   237

                var_class = ITEM_POU

   238

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

   239

            self.ParentWindow.EditProjectElement(var_class, tagname)

   240

            event.Skip()

   241

        return EditButtonCallback

   242

   243

    def GenDebugButtonCallback(self, infos):

   244

        def DebugButtonCallback(event):

   245

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

   246

                var_class = infos["class"]

   247

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

   248

                                      infos["name"])

   249

                if var_class in ITEMS_VARIABLE:

   250

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

   251

                elif var_class == ITEM_TRANSITION:

   252

                    self.ParentWindow.OpenDebugViewer(

   253

                        var_class,

   254

                        var_path,

   255

                        self.Controller.ComputePouTransitionName(

   256

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

   257

                            infos["name"]))

   258

                elif var_class == ITEM_ACTION:

   259

                    self.ParentWindow.OpenDebugViewer(

   260

                        var_class,

   261

                        var_path,

   262

                        self.Controller.ComputePouActionName(

   263

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

   264

                            infos["name"]))

   265

                else:

   266

                    self.ParentWindow.OpenDebugViewer(

   267

                        var_class,

   268

                        var_path,

   269

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

   270

            event.Skip()

   271

        return DebugButtonCallback

   272

   273

    def GenGraphButtonCallback(self, infos):

   274

        def GraphButtonCallback(event):

   275

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

   276

                if infos["class"] in ITEMS_VARIABLE:

   277

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

   278

                                          infos["name"])

   279

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

   280

            event.Skip()

   281

        return GraphButtonCallback

   282

   283

    def ShowInstanceChoicePopup(self):

   284

        self.InstanceChoice.SetFocusFromKbd()

   285

        size = self.InstanceChoice.GetSize()

   286

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

   287

        event.m_x = size.width / 2

   288

        event.m_y = size.height / 2

   289

        event.SetEventObject(self.InstanceChoice)

   290

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

   291

        #event.m_keyCode = wx.WXK_SPACE

   292

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

   293

   294

    def OnParentButtonClick(self, event):

   295

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

   296

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

   297

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

   298

            if tagname is not None:

   299

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

   300

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

   301

        event.Skip()

   302

   303

    def OnInstanceChoiceChanged(self, event):

   304

        self.RefreshButtons()

   305

        event.Skip()

   306

   307

    def OnDebugButtonClick(self, event):

   308

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

   309

            self.ParentWindow.OpenDebugViewer(

   310

                self.PouInfos["class"],

   311

                self.InstanceChoice.GetStringSelection(),

   312

                self.PouTagName)

   313

        event.Skip()

   314

   315

    def OnVariablesListItemActivated(self, event):

   316

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

   317

            instance_path = self.InstanceChoice.GetStringSelection()

   318

            selected_item = event.GetItem()

   319

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

   320

                item_infos = self.VariablesList.GetPyData(selected_item)

   321

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

   322

                    if item_infos["class"] == ITEM_RESOURCE:

   323

                        tagname = self.Controller.ComputeConfigurationResourceName(

   324

                                       instance_path, 

   325

                                       item_infos["name"])

   326

                    else:

   327

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

   328

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

   329

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

   330

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

   331

        event.Skip()

   332

   333

    def OnVariablesListLeftDown(self, event):

   334

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

   335

            wx.CallAfter(self.ShowInstanceChoicePopup)

   336

        else:

   337

            instance_path = self.InstanceChoice.GetStringSelection()

   338

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

   339

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

   340

                item_infos = self.VariablesList.GetPyData(item)

   341

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

   342

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

   343

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

   344

                    dragSource = wx.DropSource(self.VariablesList)

   345

                    dragSource.SetData(data)

   346

                    dragSource.DoDragDrop()

   347

        event.Skip()

   348

   349

    def OnInstanceChoiceLeftDown(self, event):

   350

        event.Skip()