Laurent@814: #!/usr/bin/env python Laurent@814: # -*- coding: utf-8 -*- Laurent@814: Laurent@814: #This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor Laurent@814: #based on the plcopen standard. Laurent@814: # Laurent@814: #Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD Laurent@814: # Laurent@814: #See COPYING file for copyrights details. Laurent@814: # Laurent@814: #This library is free software; you can redistribute it and/or Laurent@814: #modify it under the terms of the GNU General Public Laurent@814: #License as published by the Free Software Foundation; either Laurent@814: #version 2.1 of the License, or (at your option) any later version. Laurent@814: # Laurent@814: #This library is distributed in the hope that it will be useful, Laurent@814: #but WITHOUT ANY WARRANTY; without even the implied warranty of Laurent@814: #MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Laurent@814: #General Public License for more details. Laurent@814: # Laurent@814: #You should have received a copy of the GNU General Public Laurent@814: #License along with this library; if not, write to the Free Software Laurent@814: #Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Laurent@814: Laurent@814: import wx Laurent@814: Laurent@814: #------------------------------------------------------------------------------- Laurent@814: # Helpers Laurent@814: #------------------------------------------------------------------------------- Laurent@814: Laurent@814: [CATEGORY, BLOCK] = range(2) Laurent@814: Laurent@814: #------------------------------------------------------------------------------- Laurent@814: # Library Panel Laurent@814: #------------------------------------------------------------------------------- Laurent@814: Laurent@814: class LibraryPanel(wx.Panel): Laurent@814: Laurent@814: def __init__(self, parent, enable_drag=False): Laurent@814: wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL) Laurent@814: Laurent@814: main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0) Laurent@814: main_sizer.AddGrowableCol(0) Laurent@814: main_sizer.AddGrowableRow(1) Laurent@814: Laurent@814: self.SearchCtrl = wx.SearchCtrl(self) Laurent@814: self.SearchCtrl.ShowSearchButton(True) Laurent@814: self.Bind(wx.EVT_TEXT, self.OnSearchCtrlChanged, self.SearchCtrl) Laurent@814: self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN, Laurent@814: self.OnSearchButtonClick, self.SearchCtrl) Laurent@814: search_textctrl = self.SearchCtrl.GetChildren()[0] Laurent@814: search_textctrl.Bind(wx.EVT_CHAR, self.OnKeyDown) Laurent@814: main_sizer.AddWindow(self.SearchCtrl, flag=wx.GROW) Laurent@814: Laurent@814: splitter_window = wx.SplitterWindow(self) Laurent@814: splitter_window.SetSashGravity(1.0) Laurent@814: main_sizer.AddWindow(splitter_window, flag=wx.GROW) Laurent@814: Laurent@814: self.Tree = wx.TreeCtrl(splitter_window, Laurent@814: size=wx.Size(0, 0), Laurent@814: style=wx.TR_HAS_BUTTONS| Laurent@814: wx.TR_SINGLE| Laurent@814: wx.SUNKEN_BORDER| Laurent@814: wx.TR_HIDE_ROOT| Laurent@814: wx.TR_LINES_AT_ROOT) Laurent@814: self.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeItemSelected, self.Tree) Laurent@814: self.Tree.Bind(wx.EVT_CHAR, self.OnKeyDown) Laurent@814: if enable_drag: Laurent@814: self.Bind(wx.EVT_TREE_BEGIN_DRAG, self.OnTreeBeginDrag, self.Tree) Laurent@814: Laurent@814: self.Comment = wx.TextCtrl(splitter_window, size=wx.Size(0, 80), Laurent@814: style=wx.TE_READONLY|wx.TE_MULTILINE) Laurent@814: Laurent@814: splitter_window.SplitHorizontally(self.Tree, self.Comment, -80) Laurent@814: Laurent@814: self.SetSizer(main_sizer) Laurent@814: Laurent@814: self.Controller = None Laurent@814: Laurent@814: self.BlockList = None Laurent@814: Laurent@814: def __del__(self): Laurent@814: self.Controller = None Laurent@814: Laurent@814: def SetController(self, controller): Laurent@814: self.Controller = controller Laurent@814: Laurent@814: def SetBlockList(self, blocklist): Laurent@814: self.BlockList = blocklist Laurent@814: self.RefreshTree() Laurent@814: Laurent@814: def SetFocus(self): Laurent@814: self.SearchCtrl.SetFocus() Laurent@814: Laurent@814: def ResetTree(self): Laurent@814: self.SearchCtrl.SetValue("") Laurent@814: self.Tree.DeleteAllItems() Laurent@814: self.Comment.SetValue("") Laurent@814: Laurent@814: def RefreshTree(self): Laurent@814: if self.Controller is not None: Laurent@814: to_delete = [] Laurent@814: selected_name = None Laurent@814: selected = self.Tree.GetSelection() Laurent@814: if selected.IsOk(): Laurent@814: selected_pydata = self.Tree.GetPyData(selected) Laurent@814: if selected_pydata is not None and selected_pydata["type"] != CATEGORY: Laurent@814: selected_name = self.Tree.GetItemText(selected) Laurent@814: if self.BlockList is not None: Laurent@814: blocktypes = self.BlockList Laurent@814: else: Laurent@814: blocktypes = self.Controller.GetBlockTypes() Laurent@814: root = self.Tree.GetRootItem() Laurent@814: if not root.IsOk(): Laurent@814: root = self.Tree.AddRoot("") Laurent@814: category_item, root_cookie = self.Tree.GetFirstChild(root) Laurent@814: for category in blocktypes: Laurent@814: category_name = category["name"] Laurent@814: if not category_item.IsOk(): Laurent@814: category_item = self.Tree.AppendItem(root, _(category_name)) Laurent@814: if wx.Platform != '__WXMSW__': Laurent@814: category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie) Laurent@814: else: Laurent@814: self.Tree.SetItemText(category_item, _(category_name)) Laurent@814: self.Tree.SetPyData(category_item, {"type" : CATEGORY}) Laurent@814: blocktype_item, category_cookie = self.Tree.GetFirstChild(category_item) Laurent@814: for blocktype in category["list"]: Laurent@814: if not blocktype_item.IsOk(): Laurent@814: blocktype_item = self.Tree.AppendItem(category_item, blocktype["name"]) Laurent@814: if wx.Platform != '__WXMSW__': Laurent@814: blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie) Laurent@814: else: Laurent@814: self.Tree.SetItemText(blocktype_item, blocktype["name"]) Laurent@814: block_data = {"type" : BLOCK, Laurent@814: "block_type" : blocktype["type"], Laurent@814: "inputs" : tuple([type for name, type, modifier in blocktype["inputs"]]), Laurent@814: "extension" : None} Laurent@814: if blocktype["extensible"]: Laurent@814: block_data["extension"] = len(blocktype["inputs"]) Laurent@814: self.Tree.SetPyData(blocktype_item, block_data) Laurent@814: if selected_name == blocktype["name"]: Laurent@814: self.Tree.SelectItem(blocktype_item) Laurent@814: comment = blocktype["comment"] Laurent@814: self.Comment.SetValue(_(comment) + blocktype.get("usage", "")) Laurent@814: blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie) Laurent@814: while blocktype_item.IsOk(): Laurent@814: to_delete.append(blocktype_item) Laurent@814: blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie) Laurent@814: category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie) Laurent@814: while category_item.IsOk(): Laurent@814: to_delete.append(category_item) Laurent@814: category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie) Laurent@814: for item in to_delete: Laurent@814: self.Tree.Delete(item) Laurent@814: Laurent@814: def GetSelectedBlock(self): Laurent@814: selected = self.Tree.GetSelection() Laurent@814: if (selected.IsOk() and Laurent@814: self.Tree.GetItemParent(selected) != self.Tree.GetRootItem() and Laurent@814: selected != self.Tree.GetRootItem()): Laurent@814: selected_data = self.Tree.GetPyData(selected) Laurent@814: return {"type": self.Tree.GetItemText(selected), Laurent@814: "inputs": selected_data["inputs"]} Laurent@814: return None Laurent@814: Laurent@814: def SelectTreeItem(self, name, inputs): Laurent@814: item = self.FindTreeItem(self.Tree.GetRootItem(), name, inputs) Laurent@814: if item is not None and item.IsOk(): Laurent@814: self.Tree.SelectItem(item) Laurent@814: self.Tree.EnsureVisible(item) Laurent@814: Laurent@814: def FindTreeItem(self, root, name, inputs = None): Laurent@814: if root.IsOk(): Laurent@814: pydata = self.Tree.GetPyData(root) Laurent@814: if pydata is not None: Laurent@814: type_inputs = pydata.get("inputs", None) Laurent@814: type_extension = pydata.get("extension", None) Laurent@814: if inputs is not None and type_inputs is not None: Laurent@814: if type_extension is not None: Laurent@814: same_inputs = type_inputs == inputs[:type_extension] Laurent@814: else: Laurent@814: same_inputs = type_inputs == inputs Laurent@814: else: Laurent@814: same_inputs = True Laurent@814: if pydata is not None and self.Tree.GetItemText(root) == name and same_inputs: Laurent@814: return root Laurent@814: else: Laurent@814: if wx.VERSION < (2, 6, 0): Laurent@814: item, root_cookie = self.Tree.GetFirstChild(root, 0) Laurent@814: else: Laurent@814: item, root_cookie = self.Tree.GetFirstChild(root) Laurent@814: while item.IsOk(): Laurent@814: result = self.FindTreeItem(item, name, inputs) Laurent@814: if result: Laurent@814: return result Laurent@814: item, root_cookie = self.Tree.GetNextChild(root, root_cookie) Laurent@814: return None Laurent@814: Laurent@814: def SearchInTree(self, value, mode="first"): Laurent@814: root = self.Tree.GetRootItem() Laurent@814: if not root.IsOk(): Laurent@814: return False Laurent@814: Laurent@814: if mode == "first": Laurent@814: item, item_cookie = self.Tree.GetFirstChild(root) Laurent@814: selected = None Laurent@814: else: Laurent@814: item = self.Tree.GetSelection() Laurent@814: selected = item Laurent@814: if not item.IsOk(): Laurent@814: item, item_cookie = self.Tree.GetFirstChild(root) Laurent@814: while item.IsOk(): Laurent@814: item_pydata = self.Tree.GetPyData(item) Laurent@814: if item_pydata["type"] == CATEGORY: Laurent@814: if mode == "previous": Laurent@814: child = self.Tree.GetLastChild(item) Laurent@814: else: Laurent@814: child, child_cookie = self.Tree.GetFirstChild(item) Laurent@814: if child.IsOk(): Laurent@814: item = child Laurent@814: elif mode == "previous": Laurent@814: item = self.Tree.GetPrevSibling(item) Laurent@814: else: Laurent@814: item = self.Tree.GetNextSibling(item) Laurent@814: else: Laurent@814: name = self.Tree.GetItemText(item) Laurent@1068: if name.upper().find(value.upper()) != -1 and item != selected: Laurent@814: child, child_cookie = self.Tree.GetFirstChild(root) Laurent@814: while child.IsOk(): Laurent@814: self.Tree.CollapseAllChildren(child) Laurent@814: child, child_cookie = self.Tree.GetNextChild(root, child_cookie) Laurent@814: self.Tree.SelectItem(item) Laurent@814: self.Tree.EnsureVisible(item) Laurent@814: return True Laurent@814: Laurent@814: elif mode == "previous": Laurent@814: previous = self.Tree.GetPrevSibling(item) Laurent@814: if previous.IsOk(): Laurent@814: item = previous Laurent@814: else: Laurent@814: parent = self.Tree.GetItemParent(item) Laurent@814: item = self.Tree.GetPrevSibling(parent) Laurent@814: Laurent@814: else: Laurent@814: next = self.Tree.GetNextSibling(item) Laurent@814: if next.IsOk(): Laurent@814: item = next Laurent@814: else: Laurent@814: parent = self.Tree.GetItemParent(item) Laurent@814: item = self.Tree.GetNextSibling(parent) Laurent@814: return False Laurent@814: Laurent@814: def OnSearchCtrlChanged(self, event): Laurent@814: self.SearchInTree(self.SearchCtrl.GetValue()) Laurent@814: event.Skip() Laurent@814: Laurent@814: def OnSearchButtonClick(self, event): Laurent@814: self.SearchInTree(self.SearchCtrl.GetValue(), "next") Laurent@814: event.Skip() Laurent@814: Laurent@814: def OnTreeItemSelected(self, event): Laurent@814: selected = event.GetItem() Laurent@814: pydata = self.Tree.GetPyData(selected) Laurent@814: if pydata is not None and pydata["type"] != CATEGORY: Laurent@814: blocktype = self.Controller.GetBlockType(self.Tree.GetItemText(selected), pydata["inputs"]) Laurent@814: if blocktype: Laurent@814: comment = blocktype["comment"] Laurent@814: self.Comment.SetValue(_(comment) + blocktype.get("usage", "")) Laurent@814: else: Laurent@814: self.Comment.SetValue("") Laurent@814: else: Laurent@814: self.Comment.SetValue("") Laurent@814: if getattr(self, "_OnTreeItemSelected", None) is not None: Laurent@814: self._OnTreeItemSelected(event) Laurent@814: event.Skip() Laurent@814: Laurent@814: def OnTreeBeginDrag(self, event): Laurent@814: selected = event.GetItem() Laurent@814: pydata = self.Tree.GetPyData(selected) Laurent@814: if pydata is not None and pydata["type"] == BLOCK: Laurent@814: data = wx.TextDataObject(str((self.Tree.GetItemText(selected), Laurent@814: pydata["block_type"], "", pydata["inputs"]))) Laurent@814: dragSource = wx.DropSource(self.Tree) Laurent@814: dragSource.SetData(data) Laurent@814: dragSource.DoDragDrop() Laurent@814: Laurent@814: def OnKeyDown(self, event): Laurent@814: keycode = event.GetKeyCode() Laurent@814: search_value = self.SearchCtrl.GetValue() Laurent@814: if keycode == wx.WXK_UP and search_value != "": Laurent@814: self.SearchInTree(search_value, "previous") Laurent@814: elif keycode == wx.WXK_DOWN and search_value != "": Laurent@814: self.SearchInTree(search_value, "next") Laurent@814: else: Laurent@814: event.Skip()