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) 2007: 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

    27

#-------------------------------------------------------------------------------

    28

#                                 Helpers

    29

#-------------------------------------------------------------------------------

    30

    31

[CATEGORY, BLOCK] = range(2)

    32

    33

#-------------------------------------------------------------------------------

    34

#                              Library Panel

    35

#-------------------------------------------------------------------------------

    36

    37

class LibraryPanel(wx.Panel):

    38

    39

    def __init__(self, parent, enable_drag=False):

    40

        wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL)

    41

    42

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

    43

        main_sizer.AddGrowableCol(0)

    44

        main_sizer.AddGrowableRow(1)

    45

    46

        self.SearchCtrl = wx.SearchCtrl(self)

    47

        self.SearchCtrl.ShowSearchButton(True)

    48

        self.Bind(wx.EVT_TEXT, self.OnSearchCtrlChanged, self.SearchCtrl)

    49

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN, 

    50

              self.OnSearchButtonClick, self.SearchCtrl)

    51

        search_textctrl = self.SearchCtrl.GetChildren()[0]

    52

        search_textctrl.Bind(wx.EVT_CHAR, self.OnKeyDown)

    53

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

    54

    55

        self.Tree = wx.TreeCtrl(self, 

    56

              style=wx.TR_HAS_BUTTONS|

    57

                    wx.TR_SINGLE|

    58

                    wx.SUNKEN_BORDER|

    59

                    wx.TR_HIDE_ROOT|

    60

                    wx.TR_LINES_AT_ROOT)

    61

        self.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeItemSelected, self.Tree)

    62

        self.Tree.Bind(wx.EVT_CHAR, self.OnKeyDown)

    63

        if enable_drag:

    64

            self.Bind(wx.EVT_TREE_BEGIN_DRAG, self.OnTreeBeginDrag, self.Tree)

    65

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

    66

    67

        self.Comment = wx.TextCtrl(self, size=wx.Size(0, 80), 

    68

              style=wx.TE_READONLY|wx.TE_MULTILINE)

    69

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

    70

    71

        self.SetSizer(main_sizer)

    72

    73

        self.Controller = None

    74

    75

        self.BlockList = None

    76

    77

    def __del__(self):

    78

        self.Controller = None

    79

    80

    def SetController(self, controller):

    81

        self.Controller = controller

    82

    83

    def SetBlockList(self, blocklist):

    84

        self.BlockList = blocklist

    85

        self.RefreshTree()

    86

    87

    def SetFocus(self):

    88

        self.SearchCtrl.SetFocus()

    89

    90

    def ResetTree(self):

    91

        self.SearchCtrl.SetValue("")

    92

        self.Tree.DeleteAllItems()

    93

        self.Comment.SetValue("")

    94

    95

    def RefreshTree(self):

    96

        if self.Controller is not None:

    97

            to_delete = []

    98

            selected_name = None

    99

            selected = self.Tree.GetSelection()

   100

            if selected.IsOk():

   101

                selected_pydata = self.Tree.GetPyData(selected)

   102

                if selected_pydata is not None and selected_pydata["type"] != CATEGORY:

   103

                    selected_name = self.Tree.GetItemText(selected)

   104

            if self.BlockList is not None:

   105

                blocktypes = self.BlockList

   106

            else:

   107

                blocktypes = self.Controller.GetBlockTypes()

   108

            root = self.Tree.GetRootItem()

   109

            if not root.IsOk():

   110

                root = self.Tree.AddRoot("")

   111

            category_item, root_cookie = self.Tree.GetFirstChild(root)

   112

            for category in blocktypes:

   113

                category_name = category["name"]

   114

                if not category_item.IsOk():

   115

                    category_item = self.Tree.AppendItem(root, _(category_name))

   116

                    if wx.Platform != '__WXMSW__':

   117

                        category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie)

   118

                else:

   119

                    self.Tree.SetItemText(category_item, _(category_name))

   120

                self.Tree.SetPyData(category_item, {"type" : CATEGORY})

   121

                blocktype_item, category_cookie = self.Tree.GetFirstChild(category_item)

   122

                for blocktype in category["list"]:

   123

                    if not blocktype_item.IsOk():

   124

                        blocktype_item = self.Tree.AppendItem(category_item, blocktype["name"])

   125

                        if wx.Platform != '__WXMSW__':

   126

                            blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie)

   127

                    else:

   128

                        self.Tree.SetItemText(blocktype_item, blocktype["name"])

   129

                    block_data = {"type" : BLOCK, 

   130

                                  "block_type" : blocktype["type"], 

   131

                                  "inputs" : tuple([type for name, type, modifier in blocktype["inputs"]]), 

   132

                                  "extension" : None}

   133

                    if blocktype["extensible"]:

   134

                        block_data["extension"] = len(blocktype["inputs"])

   135

                    self.Tree.SetPyData(blocktype_item, block_data)

   136

                    if selected_name == blocktype["name"]:

   137

                        self.Tree.SelectItem(blocktype_item)

   138

                        comment = blocktype["comment"]

   139

                        self.Comment.SetValue(_(comment) + blocktype.get("usage", ""))

   140

                    blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie)

   141

                while blocktype_item.IsOk():

   142

                    to_delete.append(blocktype_item)

   143

                    blocktype_item, category_cookie = self.Tree.GetNextChild(category_item, category_cookie)

   144

                category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie)

   145

            while category_item.IsOk():

   146

                to_delete.append(category_item)

   147

                category_item, root_cookie = self.Tree.GetNextChild(root, root_cookie)

   148

            for item in to_delete:

   149

                self.Tree.Delete(item)

   150

   151

    def GetSelectedBlock(self):

   152

        selected = self.Tree.GetSelection()

   153

        if (selected.IsOk() and 

   154

            self.Tree.GetItemParent(selected) != self.Tree.GetRootItem() and 

   155

            selected != self.Tree.GetRootItem()):

   156

            selected_data = self.Tree.GetPyData(selected)

   157

            return {"type": self.Tree.GetItemText(selected), 

   158

                    "inputs": selected_data["inputs"]}

   159

        return None

   160

   161

    def SelectTreeItem(self, name, inputs):

   162

        item = self.FindTreeItem(self.Tree.GetRootItem(), name, inputs)

   163

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

   164

            self.Tree.SelectItem(item)

   165

            self.Tree.EnsureVisible(item)

   166

   167

    def FindTreeItem(self, root, name, inputs = None):

   168

        if root.IsOk():

   169

            pydata = self.Tree.GetPyData(root)

   170

            if pydata is not None:

   171

                type_inputs = pydata.get("inputs", None)

   172

                type_extension = pydata.get("extension", None)

   173

                if inputs is not None and type_inputs is not None:

   174

                    if type_extension is not None:

   175

                        same_inputs = type_inputs == inputs[:type_extension]

   176

                    else:

   177

                        same_inputs = type_inputs == inputs

   178

                else:

   179

                    same_inputs = True

   180

            if pydata is not None and self.Tree.GetItemText(root) == name and same_inputs:

   181

                return root

   182

            else:

   183

                if wx.VERSION < (2, 6, 0):

   184

                    item, root_cookie = self.Tree.GetFirstChild(root, 0)

   185

                else:

   186

                    item, root_cookie = self.Tree.GetFirstChild(root)

   187

                while item.IsOk():

   188

                    result = self.FindTreeItem(item, name, inputs)

   189

                    if result:

   190

                        return result

   191

                    item, root_cookie = self.Tree.GetNextChild(root, root_cookie)

   192

        return None

   193

   194

    def SearchInTree(self, value, mode="first"):

   195

        root = self.Tree.GetRootItem()

   196

        if not root.IsOk():

   197

            return False

   198

   199

        if mode == "first":

   200

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

   201

            selected = None

   202

        else:

   203

            item = self.Tree.GetSelection()

   204

            selected = item

   205

            if not item.IsOk():

   206

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

   207

        while item.IsOk():

   208

            item_pydata = self.Tree.GetPyData(item)

   209

            if item_pydata["type"] == CATEGORY:

   210

                if mode == "previous":

   211

                    child = self.Tree.GetLastChild(item)

   212

                else:

   213

                    child, child_cookie = self.Tree.GetFirstChild(item)

   214

                if child.IsOk():

   215

                    item = child

   216

                elif mode == "previous":

   217

                    item = self.Tree.GetPrevSibling(item)

   218

                else:

   219

                    item = self.Tree.GetNextSibling(item)

   220

            else:

   221

                name = self.Tree.GetItemText(item)

   222

                if name.upper().startswith(value.upper()) and item != selected:

   223

                    child, child_cookie = self.Tree.GetFirstChild(root)

   224

                    while child.IsOk():

   225

                        self.Tree.CollapseAllChildren(child)

   226

                        child, child_cookie = self.Tree.GetNextChild(root, child_cookie)

   227

                    self.Tree.SelectItem(item)

   228

                    self.Tree.EnsureVisible(item)

   229

                    return True

   230

   231

                elif mode == "previous":

   232

                    previous = self.Tree.GetPrevSibling(item)

   233

                    if previous.IsOk():

   234

                        item = previous

   235

                    else:

   236

                        parent = self.Tree.GetItemParent(item)

   237

                        item = self.Tree.GetPrevSibling(parent)

   238

   239

                else:

   240

                    next = self.Tree.GetNextSibling(item)

   241

                    if next.IsOk():

   242

                        item = next

   243

                    else:

   244

                        parent = self.Tree.GetItemParent(item)

   245

                        item = self.Tree.GetNextSibling(parent)

   246

        return False

   247

   248

    def OnSearchCtrlChanged(self, event):

   249

        self.SearchInTree(self.SearchCtrl.GetValue())

   250

        event.Skip()

   251

   252

    def OnSearchButtonClick(self, event):

   253

        self.SearchInTree(self.SearchCtrl.GetValue(), "next")

   254

        event.Skip()

   255

   256

    def OnTreeItemSelected(self, event):

   257

        selected = event.GetItem()

   258

        pydata = self.Tree.GetPyData(selected)

   259

        if pydata is not None and pydata["type"] != CATEGORY:

   260

            blocktype = self.Controller.GetBlockType(self.Tree.GetItemText(selected), pydata["inputs"])

   261

            if blocktype:

   262

                comment = blocktype["comment"]

   263

                self.Comment.SetValue(_(comment) + blocktype.get("usage", ""))

   264

            else:

   265

                self.Comment.SetValue("")

   266

        else:

   267

            self.Comment.SetValue("")

   268

        if getattr(self, "_OnTreeItemSelected", None) is not None:

   269

            self._OnTreeItemSelected(event)

   270

        event.Skip()

   271

   272

    def OnTreeBeginDrag(self, event):

   273

        selected = event.GetItem()

   274

        pydata = self.Tree.GetPyData(selected)

   275

        if pydata is not None and pydata["type"] == BLOCK:

   276

            data = wx.TextDataObject(str((self.Tree.GetItemText(selected), 

   277

                pydata["block_type"], "", pydata["inputs"])))

   278

            dragSource = wx.DropSource(self.Tree)

   279

            dragSource.SetData(data)

   280

            dragSource.DoDragDrop()

   281

   282

    def OnKeyDown(self, event):

   283

        keycode = event.GetKeyCode()

   284

        search_value = self.SearchCtrl.GetValue()

   285

        if keycode == wx.WXK_UP and search_value != "":

   286

            self.SearchInTree(search_value, "previous")

   287

        elif keycode == wx.WXK_DOWN and search_value != "":

   288

            self.SearchInTree(search_value, "next")

   289

        else:

   290

            event.Skip()