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