laurent@684: #!/usr/bin/env python
laurent@684: # -*- coding: utf-8 -*-
laurent@684: 
laurent@684: #This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor
laurent@684: #based on the plcopen standard. 
laurent@684: #
laurent@684: #Copyright (C) 2012: Edouard TISSERANT and Laurent BESSARD
laurent@684: #
laurent@684: #See COPYING file for copyrights details.
laurent@684: #
laurent@684: #This library is free software; you can redistribute it and/or
laurent@684: #modify it under the terms of the GNU General Public
laurent@684: #License as published by the Free Software Foundation; either
laurent@684: #version 2.1 of the License, or (at your option) any later version.
laurent@684: #
laurent@684: #This library is distributed in the hope that it will be useful,
laurent@684: #but WITHOUT ANY WARRANTY; without even the implied warranty of
laurent@684: #MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
laurent@684: #General Public License for more details.
laurent@684: #
laurent@684: #You should have received a copy of the GNU General Public
laurent@684: #License along with this library; if not, write to the Free Software
laurent@684: #Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
laurent@684: 
laurent@684: import wx
laurent@684: import wx.lib.buttons
laurent@684: import wx.lib.agw.customtreectrl as CT
laurent@684: 
laurent@684: from PLCControler import ITEMS_VARIABLE, ITEM_CONFIGURATION, ITEM_RESOURCE, ITEM_POU
Laurent@714: from utils.BitmapLibrary import GetBitmap
laurent@684: 
laurent@684: class PouInstanceVariablesPanel(wx.Panel):
laurent@684:     
laurent@684:     def __init__(self, parent, window, controller, debug):
laurent@684:         wx.Panel.__init__(self, name='PouInstanceTreePanel', 
laurent@684:                 parent=parent, pos=wx.Point(0, 0), 
laurent@684:                 size=wx.Size(0, 0), style=wx.TAB_TRAVERSAL)
laurent@684:         
Laurent@714:         self.ParentButton = wx.lib.buttons.GenBitmapButton(self,
Laurent@714:               bitmap=GetBitmap("top"), size=wx.Size(28, 28), style=wx.NO_BORDER)
Laurent@714:         self.ParentButton.SetToolTipString(_("Parent instance"))
laurent@684:         self.Bind(wx.EVT_BUTTON, self.OnParentButtonClick, 
laurent@684:                 self.ParentButton)
laurent@684:         
Laurent@714:         self.InstanceChoice = wx.ComboBox(self, style=wx.CB_READONLY)
laurent@684:         self.Bind(wx.EVT_COMBOBOX, self.OnInstanceChoiceChanged,
laurent@684:                 self.InstanceChoice)
laurent@687:         self.InstanceChoice.Bind(wx.EVT_LEFT_DOWN, self.OnInstanceChoiceLeftDown)
laurent@684:         
Laurent@714:         self.DebugButton = wx.lib.buttons.GenBitmapButton(self, 
Laurent@714:               bitmap=GetBitmap("debug_instance"), size=wx.Size(28, 28), style=wx.NO_BORDER)
Laurent@714:         self.ParentButton.SetToolTipString(_("Debug instance"))
laurent@684:         self.Bind(wx.EVT_BUTTON, self.OnDebugButtonClick, 
laurent@684:                 self.DebugButton)
laurent@687:         
Laurent@714:         self.VariablesList = CT.CustomTreeCtrl(self,
laurent@684:               style=wx.SUNKEN_BORDER,
laurent@684:               agwStyle=CT.TR_NO_BUTTONS|
laurent@684:                        CT.TR_SINGLE|
laurent@684:                        CT.TR_HAS_VARIABLE_ROW_HEIGHT|
laurent@684:                        CT.TR_HIDE_ROOT|
Edouard@686:                        CT.TR_NO_LINES|
laurent@687:                        getattr(CT, "TR_ALIGN_WINDOWS_RIGHT", CT.TR_ALIGN_WINDOWS))
Edouard@686:         self.VariablesList.SetIndent(0)
Edouard@686:         self.VariablesList.SetSpacing(5)
Edouard@686:         self.VariablesList.DoSelectItem = lambda *x,**y:True
laurent@684:         self.VariablesList.Bind(CT.EVT_TREE_ITEM_ACTIVATED,
laurent@684:                 self.OnVariablesListItemActivated)
laurent@687:         self.VariablesList.Bind(wx.EVT_LEFT_DOWN, self.OnVariablesListLeftDown)
laurent@684:         
laurent@684:         buttons_sizer = wx.FlexGridSizer(cols=3, hgap=0, rows=1, vgap=0)
Laurent@714:         buttons_sizer.AddWindow(self.ParentButton)
Laurent@714:         buttons_sizer.AddWindow(self.InstanceChoice, flag=wx.GROW)
Laurent@714:         buttons_sizer.AddWindow(self.DebugButton)
laurent@684:         buttons_sizer.AddGrowableCol(1)
laurent@684:         buttons_sizer.AddGrowableRow(0)
laurent@684:         
laurent@684:         main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)
Laurent@714:         main_sizer.AddSizer(buttons_sizer, flag=wx.GROW)
Laurent@714:         main_sizer.AddWindow(self.VariablesList, flag=wx.GROW)
laurent@684:         main_sizer.AddGrowableCol(0)
laurent@684:         main_sizer.AddGrowableRow(1)
laurent@684:         
laurent@684:         self.SetSizer(main_sizer)
laurent@684:         
laurent@684:         self.ParentWindow = window
laurent@684:         self.Controller = controller
laurent@684:         self.Debug = debug
laurent@684:         if not self.Debug:
laurent@684:             self.DebugButton.Hide()
laurent@684:         
laurent@684:         self.PouTagName = None
laurent@684:         self.PouInfos = None
laurent@684:         self.PouInstance = None
laurent@684:         
laurent@684:     def __del__(self):
laurent@684:         self.Controller = None
laurent@684:     
laurent@684:     def SetTreeImageList(self, tree_image_list):
laurent@684:         self.VariablesList.SetImageList(tree_image_list)
laurent@684:     
laurent@684:     def SetController(self, controller):
laurent@684:         self.Controller = controller
laurent@687:     
laurent@687:         self.RefreshView()
laurent@687:     
laurent@684:     def SetPouType(self, tagname, pou_instance=None):
laurent@684:         self.PouTagName = tagname
laurent@684:         if pou_instance is not None:
laurent@684:             self.PouInstance = pou_instance
laurent@684:         
laurent@684:         self.RefreshView()
laurent@684:     
laurent@684:     def ResetView(self):
laurent@687:         self.Controller = None
laurent@687:         
laurent@684:         self.PouTagName = None
laurent@684:         self.PouInfos = None
laurent@684:         self.PouInstance = None
laurent@684:         
laurent@684:         self.RefreshView()
laurent@684:     
laurent@684:     def RefreshView(self):
laurent@684:         self.VariablesList.DeleteAllItems()
laurent@684:         self.InstanceChoice.Clear()
laurent@687:         self.InstanceChoice.SetValue("")
laurent@684:         
Laurent@701:         if self.Controller is not None and self.PouTagName is not None:
laurent@684:             self.PouInfos = self.Controller.GetPouVariables(self.PouTagName, self.Debug)
laurent@684:         else:
laurent@684:             self.PouInfos = None
laurent@684:         if self.PouInfos is not None:
laurent@684:             root = self.VariablesList.AddRoot("")
laurent@684:             for var_infos in self.PouInfos["variables"]:
laurent@684:                 if var_infos.get("type", None) is not None:
laurent@684:                     text = "%(name)s (%(type)s)" % var_infos
laurent@684:                 else:
laurent@684:                     text = var_infos["name"]
laurent@684:                 
laurent@684:                 panel = wx.Panel(self.VariablesList)
laurent@684:                     
laurent@684:                 buttons = []
laurent@684:                 if var_infos["class"] in ITEMS_VARIABLE:
laurent@684:                     if (var_infos["debug"] and self.Debug and
laurent@684:                         (self.Controller.IsOfType(var_infos["type"], "ANY_NUM", True) or
laurent@684:                          self.Controller.IsOfType(var_infos["type"], "ANY_BIT", True))):
Laurent@714:                         graph_button = wx.lib.buttons.GenBitmapButton(panel, 
Laurent@714:                               bitmap=GetBitmap("instance_graph"), 
Laurent@714:                               size=wx.Size(28, 28), style=wx.NO_BORDER)
laurent@684:                         self.Bind(wx.EVT_BUTTON, self.GenGraphButtonCallback(var_infos), graph_button)
laurent@684:                         buttons.append(graph_button)
laurent@684:                 elif var_infos["edit"]:
Laurent@714:                     edit_button = wx.lib.buttons.GenBitmapButton(panel, 
Laurent@714:                           bitmap=GetBitmap("edit"), 
Laurent@714:                           size=wx.Size(28, 28), style=wx.NO_BORDER)
laurent@684:                     self.Bind(wx.EVT_BUTTON, self.GenEditButtonCallback(var_infos), edit_button)
laurent@684:                     buttons.append(edit_button)
laurent@684:                 
laurent@684:                 if var_infos["debug"] and self.Debug:
Laurent@714:                     debug_button = wx.lib.buttons.GenBitmapButton(panel, 
Laurent@714:                           bitmap=GetBitmap("debug_instance"), 
Laurent@714:                           size=wx.Size(28, 28), style=wx.NO_BORDER)
laurent@684:                     self.Bind(wx.EVT_BUTTON, self.GenDebugButtonCallback(var_infos), debug_button)
laurent@684:                     buttons.append(debug_button)
laurent@684:                 
laurent@684:                 button_num = len(buttons)
laurent@684:                 if button_num > 0:
laurent@684:                     panel.SetSize(wx.Size(button_num * 32, 28))
laurent@684:                     panel.SetBackgroundColour(self.VariablesList.GetBackgroundColour())
laurent@684:                     panel_sizer = wx.BoxSizer(wx.HORIZONTAL)
laurent@684:                     panel.SetSizer(panel_sizer)
laurent@684:                     
laurent@684:                     for button in buttons:
laurent@684:                         panel_sizer.AddWindow(button, 0, border=4, flag=wx.LEFT)
laurent@692:                     panel_sizer.Layout()
laurent@692:                     
laurent@684:                 else:
laurent@684:                     panel.Destroy()
laurent@684:                     panel = None
laurent@684:                 
laurent@684:                 item = self.VariablesList.AppendItem(root, text, wnd=panel)
laurent@684:                 self.VariablesList.SetItemImage(item, self.ParentWindow.GetTreeImage(var_infos["class"]))
laurent@684:                 self.VariablesList.SetPyData(item, var_infos)
laurent@684:             
laurent@684:             instances = self.Controller.SearchPouInstances(self.PouTagName, self.Debug)
laurent@684:             for instance in instances:
laurent@684:                 self.InstanceChoice.Append(instance)
laurent@687:             if len(instances) == 1:
laurent@687:                 self.PouInstance = instances[0]
laurent@684:             if self.PouInfos["class"] in [ITEM_CONFIGURATION, ITEM_RESOURCE]:
laurent@684:                 self.PouInstance = None
laurent@684:                 self.InstanceChoice.SetSelection(0)
laurent@684:             elif self.PouInstance in instances:
laurent@684:                 self.InstanceChoice.SetStringSelection(self.PouInstance)
laurent@684:             else:
laurent@684:                 self.PouInstance = None
laurent@684:                 self.InstanceChoice.SetValue(_("Select an instance"))
laurent@684:         
laurent@684:         self.RefreshButtons()
laurent@684:         
laurent@684:     def RefreshButtons(self):
laurent@684:         enabled = self.InstanceChoice.GetSelection() != -1
laurent@684:         self.ParentButton.Enable(enabled and self.PouInfos["class"] != ITEM_CONFIGURATION)
laurent@684:         self.DebugButton.Enable(enabled and self.PouInfos["debug"] and self.Debug)
laurent@684:         
laurent@684:         root = self.VariablesList.GetRootItem()
laurent@684:         if root is not None and root.IsOk():
laurent@684:             item, item_cookie = self.VariablesList.GetFirstChild(root)
laurent@684:             while item is not None and item.IsOk():
laurent@684:                 panel = self.VariablesList.GetItemWindow(item)
laurent@684:                 if panel is not None:
laurent@684:                     for child in panel.GetChildren():
laurent@684:                         if child.GetName() != "edit":
laurent@684:                             child.Enable(enabled)
laurent@684:                 item, item_cookie = self.VariablesList.GetNextChild(root, item_cookie)
laurent@684:     
laurent@684:     def GenEditButtonCallback(self, infos):
laurent@684:         def EditButtonCallback(event):
laurent@684:             var_class = infos["class"]
laurent@684:             if var_class == ITEM_RESOURCE:
laurent@684:                 tagname = self.Controller.ComputeConfigurationResourceName(
laurent@684:                     self.InstanceChoice.GetStringSelection(), 
laurent@684:                     infos["name"])
laurent@684:             else:
laurent@684:                 var_class = ITEM_POU
laurent@684:                 tagname = self.Controller.ComputePouName(infos["type"])
laurent@684:             self.ParentWindow.EditProjectElement(var_class, tagname)
laurent@684:             event.Skip()
laurent@684:         return EditButtonCallback
laurent@684:     
laurent@684:     def GenDebugButtonCallback(self, infos):
laurent@684:         def DebugButtonCallback(event):
laurent@684:             if self.InstanceChoice.GetSelection() != -1:
laurent@684:                 var_class = infos["class"]
laurent@684:                 var_path = "%s.%s" % (self.InstanceChoice.GetStringSelection(), 
laurent@684:                                       infos["name"])
laurent@684:                 if var_class in ITEMS_VARIABLE:
laurent@684:                     self.ParentWindow.AddDebugVariable(var_path, force=True)
laurent@684:                 else:
laurent@684:                     self.ParentWindow.OpenDebugViewer(
laurent@684:                         infos["class"],
laurent@684:                         var_path,
laurent@684:                         self.Controller.ComputePouName(infos["type"]))
laurent@684:             event.Skip()
laurent@684:         return DebugButtonCallback
laurent@684:     
laurent@684:     def GenGraphButtonCallback(self, infos):
laurent@684:         def GraphButtonCallback(event):
laurent@684:             if self.InstanceChoice.GetSelection() != -1:
laurent@684:                 if infos["class"] in ITEMS_VARIABLE:
laurent@684:                     var_path = "%s.%s" % (self.InstanceChoice.GetStringSelection(), 
laurent@684:                                           infos["name"])
laurent@684:                     self.ParentWindow.OpenGraphicViewer(var_path)
laurent@684:             event.Skip()
laurent@684:         return GraphButtonCallback
laurent@684:     
laurent@687:     def ShowInstanceChoicePopup(self):
laurent@687:         self.InstanceChoice.SetFocusFromKbd()
laurent@687:         size = self.InstanceChoice.GetSize()
laurent@687:         event = wx.MouseEvent(wx.EVT_LEFT_DOWN._getEvtType())
laurent@687:         event.m_x = size.width / 2
laurent@687:         event.m_y = size.height / 2
laurent@687:         event.SetEventObject(self.InstanceChoice)
laurent@687:         #event = wx.KeyEvent(wx.EVT_KEY_DOWN._getEvtType())
laurent@687:         #event.m_keyCode = wx.WXK_SPACE
laurent@687:         self.InstanceChoice.GetEventHandler().ProcessEvent(event)
laurent@687:     
laurent@684:     def OnParentButtonClick(self, event):
laurent@684:         if self.InstanceChoice.GetSelection() != -1:
laurent@684:             parent_path = self.InstanceChoice.GetStringSelection().rsplit(".", 1)[0]
laurent@687:             tagname = self.Controller.GetPouInstanceTagName(parent_path, self.Debug)
laurent@684:             if tagname is not None:
laurent@684:                 wx.CallAfter(self.SetPouType, tagname, parent_path)
laurent@684:                 wx.CallAfter(self.ParentWindow.SelectProjectTreeItem, tagname)
laurent@684:         event.Skip()
laurent@684:         
laurent@684:     def OnInstanceChoiceChanged(self, event):
laurent@684:         self.RefreshButtons()
laurent@684:         event.Skip()
laurent@684:         
laurent@684:     def OnDebugButtonClick(self, event):
laurent@684:         if self.InstanceChoice.GetSelection() != -1:
laurent@684:             self.ParentWindow.OpenDebugViewer(
laurent@684:                 self.PouInfos["class"],
laurent@684:                 self.InstanceChoice.GetStringSelection(),
laurent@684:                 self.PouTagName)
laurent@684:         event.Skip()
laurent@684:         
laurent@684:     def OnVariablesListItemActivated(self, event):
laurent@684:         if self.InstanceChoice.GetSelection() != -1:
laurent@684:             instance_path = self.InstanceChoice.GetStringSelection()
Edouard@686:             selected_item = event.GetItem()
laurent@684:             if selected_item is not None and selected_item.IsOk():
laurent@684:                 item_infos = self.VariablesList.GetPyData(selected_item)
laurent@687:                 if item_infos is not None and item_infos["class"] not in ITEMS_VARIABLE:
laurent@684:                     if item_infos["class"] == ITEM_RESOURCE:
laurent@684:                         tagname = self.Controller.ComputeConfigurationResourceName(
laurent@684:                                        instance_path, 
laurent@684:                                        item_infos["name"])
laurent@684:                     else:
laurent@684:                         tagname = self.Controller.ComputePouName(item_infos["type"])
laurent@684:                     item_path = "%s.%s" % (instance_path, item_infos["name"])
laurent@684:                     wx.CallAfter(self.SetPouType, tagname, item_path)
laurent@684:                     wx.CallAfter(self.ParentWindow.SelectProjectTreeItem, tagname)
laurent@684:         event.Skip()
laurent@684:     
laurent@687:     def OnVariablesListLeftDown(self, event):
laurent@687:         if self.InstanceChoice.GetSelection() == -1:
laurent@687:             wx.CallAfter(self.ShowInstanceChoicePopup)
laurent@687:         event.Skip()
laurent@687:         
laurent@687:     def OnInstanceChoiceLeftDown(self, event):
laurent@687:         event.Skip()