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

    30

    31

class PouInstanceVariablesPanel(wx.Panel):

    32

    33

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

    34

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

    35

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

    36

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

    37

    38

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

    39

              name='ParentButton', parent=self, 

    40

              bitmap=window.GenerateBitmap("up"), 

    41

              pos=wx.Point(0, 0), size=wx.Size(28, 28), 

    42

              style=wx.NO_BORDER)

    43

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

    44

                self.ParentButton)

    45

    46

        self.InstanceChoice = wx.ComboBox(name='InstanceChoice', 

    47

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

    48

              size=wx.Size(0, 28), style=wx.CB_READONLY)

    49

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

    50

                self.InstanceChoice)

    51

    52

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

    53

              name='DebugButton', parent=self, 

    54

              bitmap=window.GenerateBitmap("debug"), 

    55

              pos=wx.Point(0, 0), size=wx.Size(28, 28), 

    56

              style=wx.NO_BORDER)

    57

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

    58

                self.DebugButton)

    59

    60

        self.VariablesList = CT.CustomTreeCtrl(

    61

              name='VariablesList', parent=self,

    62

              pos=wx.Point(0, 0), size=wx.Size(0, 0), 

    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|

    73

        self.VariablesList.Bind(CT.EVT_TREE_ITEM_ACTIVATED,

    74

                self.OnVariablesListItemActivated)

    75

    76

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

    77

        buttons_sizer.AddWindow(self.ParentButton, 0, border=0, flag=0)

    78

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

    79

        buttons_sizer.AddWindow(self.DebugButton, 0, border=0, flag=0)

    80

        buttons_sizer.AddGrowableCol(1)

    81

        buttons_sizer.AddGrowableRow(0)

    82

    83

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

    84

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

    85

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

    86

        main_sizer.AddGrowableCol(0)

    87

        main_sizer.AddGrowableRow(1)

    88

    89

        self.SetSizer(main_sizer)

    90

    91

        self.ParentWindow = window

    92

        self.Controller = controller

    93

        self.Debug = debug

    94

        if not self.Debug:

    95

            self.DebugButton.Hide()

    96

    97

        self.PouTagName = None

    98

        self.PouInfos = None

    99

        self.PouInstance = None

   100

   101

    def __del__(self):

   102

        self.Controller = None

   103

   104

    def SetTreeImageList(self, tree_image_list):

   105

        self.VariablesList.SetImageList(tree_image_list)

   106

   107

    def SetController(self, controller):

   108

        self.Controller = controller

   109

   110

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

   111

        self.PouTagName = tagname

   112

        if pou_instance is not None:

   113

            self.PouInstance = pou_instance

   114

   115

        self.RefreshView()

   116

   117

    def ResetView(self):

   118

        self.PouTagName = None

   119

        self.PouInfos = None

   120

        self.PouInstance = None

   121

   122

        self.RefreshView()

   123

   124

    def RefreshView(self):

   125

        self.VariablesList.DeleteAllItems()

   126

        self.InstanceChoice.Clear()

   127

   128

        if self.PouTagName is not None:

   129

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

   130

        else:

   131

            self.PouInfos = None

   132

        if self.PouInfos is not None:

   133

            root = self.VariablesList.AddRoot("")

   134

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

   135

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

   136

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

   137

                else:

   138

                    text = var_infos["name"]

   139

   140

                panel = wx.Panel(self.VariablesList)

   141

   142

                buttons = []

   143

                if var_infos["class"] in ITEMS_VARIABLE:

   144

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

   145

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

   146

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

   147

                        graph_button = wx.lib.buttons.GenBitmapButton(name="graph", 

   148

                              parent=panel, bitmap=self.ParentWindow.GenerateBitmap("graph"), 

   149

                              pos=wx.Point(0, 0), size=wx.Size(28, 28), style=wx.NO_BORDER)

   150

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

   151

                        buttons.append(graph_button)

   152

                elif var_infos["edit"]:

   153

                    edit_button = wx.lib.buttons.GenBitmapButton(name="edit", 

   154

                          parent=panel, bitmap=self.ParentWindow.GenerateBitmap("edit"), 

   155

                          pos=wx.Point(0, 0), size=wx.Size(28, 28), style=wx.NO_BORDER)

   156

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

   157

                    buttons.append(edit_button)

   158

   159

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

   160

                    debug_button = wx.lib.buttons.GenBitmapButton(name="debug", 

   161

                          parent=panel, bitmap=self.ParentWindow.GenerateBitmap("debug"), 

   162

                          pos=wx.Point(0, 0), size=wx.Size(28, 28), style=wx.NO_BORDER)

   163

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

   164

                    buttons.append(debug_button)

   165

   166

                button_num = len(buttons)

   167

                if button_num > 0:

   168

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

   169

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

   170

                    panel_sizer = wx.BoxSizer(wx.HORIZONTAL)

   171

                    panel.SetSizer(panel_sizer)

   172

   173

                    for button in buttons:

   174

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

   175

                else:

   176

                    panel.Destroy()

   177

                    panel = None

   178

   179

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

   180

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

   181

                self.VariablesList.SetPyData(item, var_infos)

   182

   183

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

   184

            for instance in instances:

   185

                self.InstanceChoice.Append(instance)

   186

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

   187

                self.PouInstance = None

   188

                self.InstanceChoice.SetSelection(0)

   189

            elif self.PouInstance in instances:

   190

                self.InstanceChoice.SetStringSelection(self.PouInstance)

   191

            else:

   192

                self.PouInstance = None

   193

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

   194

   195

        self.RefreshButtons()

   196

   197

    def RefreshButtons(self):

   198

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

   199

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

   200

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

   201

   202

        root = self.VariablesList.GetRootItem()

   203

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

   204

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

   205

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

   206

                panel = self.VariablesList.GetItemWindow(item)

   207

                if panel is not None:

   208

                    for child in panel.GetChildren():

   209

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

   210

                            child.Enable(enabled)

   211

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

   212

   213

    def GenEditButtonCallback(self, infos):

   214

        def EditButtonCallback(event):

   215

            var_class = infos["class"]

   216

            if var_class == ITEM_RESOURCE:

   217

                tagname = self.Controller.ComputeConfigurationResourceName(

   218

                    self.InstanceChoice.GetStringSelection(), 

   219

                    infos["name"])

   220

            else:

   221

                var_class = ITEM_POU

   222

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

   223

            self.ParentWindow.EditProjectElement(var_class, tagname)

   224

            event.Skip()

   225

        return EditButtonCallback

   226

   227

    def GenDebugButtonCallback(self, infos):

   228

        def DebugButtonCallback(event):

   229

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

   230

                var_class = infos["class"]

   231

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

   232

                                      infos["name"])

   233

                if var_class in ITEMS_VARIABLE:

   234

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

   235

                else:

   236

                    self.ParentWindow.OpenDebugViewer(

   237

                        infos["class"],

   238

                        var_path,

   239

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

   240

            event.Skip()

   241

        return DebugButtonCallback

   242

   243

    def GenGraphButtonCallback(self, infos):

   244

        def GraphButtonCallback(event):

   245

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

   246

                if infos["class"] in ITEMS_VARIABLE:

   247

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

   248

                                          infos["name"])

   249

                    self.ParentWindow.OpenGraphicViewer(var_path)

   250

            event.Skip()

   251

        return GraphButtonCallback

   252

   253

    def OnParentButtonClick(self, event):

   254

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

   255

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

   256

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

   257

            if tagname is not None:

   258

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

   259

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

   260

        event.Skip()

   261

   262

    def OnInstanceChoiceChanged(self, event):

   263

        self.RefreshButtons()

   264

        event.Skip()

   265

   266

    def OnDebugButtonClick(self, event):

   267

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

   268

            self.ParentWindow.OpenDebugViewer(

   269

                self.PouInfos["class"],

   270

                self.InstanceChoice.GetStringSelection(),

   271

                self.PouTagName)

   272

        event.Skip()

   273

   274

    def OnVariablesListItemActivated(self, event):

   275

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

   276

            instance_path = self.InstanceChoice.GetStringSelection()

   278

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

   279

                item_infos = self.VariablesList.GetPyData(selected_item)

   280

                if item_infos["class"] not in ITEMS_VARIABLE:

   281

                    if item_infos["class"] == ITEM_RESOURCE:

   282

                        tagname = self.Controller.ComputeConfigurationResourceName(

   283

                                       instance_path, 

   284

                                       item_infos["name"])

   285

                    else:

   286

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

   287

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

   288

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

   289

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

   290

        event.Skip()

   291