1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

# This program is free software; you can redistribute it and/or

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

# of the License, or (at your option) any later version.

    15

#

    16

# This program 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

    19

# GNU General Public License for more details.

    20

#

    21

# You should have received a copy of the GNU General Public License

    22

# along with this program; if not, write to the Free Software

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

from __future__ import absolute_import

    26

import wx

    27

    28

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

    29

#                                 Helpers

    30

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

    31

    32

    33

[CATEGORY, BLOCK] = range(2)

    34

    35

    36

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

    37

#                              Library Panel

    38

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

    39

    40

    41

class LibraryPanel(wx.Panel):

    42

    """

    43

    Class that implements a panel displaying a tree containing an hierarchical list

    44

    of functions and function blocks available in project an a search control for

    45

    quickly find one functions or function blocks in this list and a text control

    46

    displaying informations about selected functions or function blocks

    47

    """

    48

    49

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

    50

        """

    51

        Constructor

    52

        @param parent: Parent wx.Window of LibraryPanel

    53

        @param enable_drag: Flag indicating that function or function block can

    54

        be drag'n drop from LibraryPanel (default: False)

    55

        """

    56

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

    57

    58

        # Define LibraryPanel main sizer

    59

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

    60

        main_sizer.AddGrowableCol(0)

    61

        main_sizer.AddGrowableRow(1)

    62

    63

        # Add SearchCtrl to main sizer

    64

        self.SearchCtrl = wx.SearchCtrl(self)

    65

        # Add a button with a magnifying glass, essentially to show that this

    66

        # control is for searching in tree

    67

        self.SearchCtrl.ShowSearchButton(True)

    68

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

    69

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN,

    70

                  self.OnSearchButtonClick, self.SearchCtrl)

    71

        # Bind keyboard event on SearchCtrl text control to catch UP and DOWN

    72

        # for search previous and next occurrence

    73

    74

        # This protects from fail to start when no children[0] available (possible for wxPython 3.0)

    75

        if self.SearchCtrl.GetChildren():

    76

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

    77

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

    78

    79

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

    80

    81

        # Add Splitter window for tree and block comment to main sizer

    82

        splitter_window = wx.SplitterWindow(self)

    83

        splitter_window.SetSashGravity(1.0)

    84

        main_sizer.AddWindow(splitter_window, flag=wx.GROW)

    85

    86

        # Add TreeCtrl for functions and function blocks library in splitter

    87

        # window

    88

        self.Tree = wx.TreeCtrl(splitter_window,

    89

                                size=wx.Size(0, 0),

    90

                                style=(wx.TR_HAS_BUTTONS |

    91

                                       wx.TR_SINGLE |

    92

                                       wx.SUNKEN_BORDER |

    93

                                       wx.TR_HIDE_ROOT |

    94

                                       wx.TR_LINES_AT_ROOT))

    95

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

    96

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

    97

        # If drag'n drop is enabled, bind event generated when a drag begins on

    98

        # tree to start a drag'n drop

    99

        if enable_drag:

   100

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

   101

   102

        # Add TextCtrl for function and function block informations

   103

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

   104

                                   style=wx.TE_READONLY | wx.TE_MULTILINE)

   105

   106

        splitter_window.SplitHorizontally(self.Tree, self.Comment, -80)

   107

   108

        self.SetSizer(main_sizer)

   109

   110

        # Reference to the project controller

   111

        self.Controller = None

   112

   113

        # Variable storing functions and function blocks library to display

   114

        self.BlockList = None

   115

   116

    def __del__(self):

   117

        """

   118

        Destructor

   119

        """

   120

        # Remove reference to project controller

   121

        self.Controller = None

   122

   123

    def SetController(self, controller):

   124

        """

   125

        Set reference to project controller

   126

        @param controller: Reference to project controller

   127

        """

   128

        self.Controller = controller

   129

   130

    def SetBlockList(self, blocklist):

   131

        """

   132

        Set function and function block library to display in TreeCtrl

   133

        @param blocklist: Function and function block library

   134

        """

   135

        # Save functions and function blocks library

   136

        self.BlockList = blocklist

   137

        # Refresh TreeCtrl values

   138

        self.RefreshTree()

   139

   140

    def SetFocus(self):

   141

        """

   142

        Called to give focus to LibraryPanel

   143

        Override wx.Window SetFocus method

   144

        """

   145

        # Give focus to SearchCtrl

   146

        self.SearchCtrl.SetFocus()

   147

   148

    def ResetTree(self):

   149

        """

   150

        Reset LibraryPanel values displayed in controls

   151

        """

   152

        # Clear SearchCtrl, TreeCtrl and TextCtrl

   153

        self.SearchCtrl.SetValue("")

   154

        self.Tree.DeleteAllItems()

   155

        self.Comment.SetValue("")

   156

   157

    def RefreshTree(self):

   158

        """

   159

        Refresh LibraryPanel values displayed in controls

   160

        """

   161

        # Get function and function blocks library

   162

        blocktypes = self.BlockList

   163

        if blocktypes is None and self.Controller is not None:

   164

            # Get library from project controller if not defined

   165

            blocktypes = self.Controller.GetBlockTypes()

   166

   167

        # Refresh TreeCtrl values if a library is defined

   168

        if blocktypes is not None:

   169

            # List that will contain tree items to be deleted when TreeCtrl

   170

            # will be refreshed

   171

            items_to_delete = []

   172

   173

            # Get current selected item for selected it when values refreshed

   174

            selected_item = self.Tree.GetSelection()

   175

            selected_pydata = (self.Tree.GetPyData(selected_item)

   176

                               if (selected_item.IsOk() and

   177

                                   selected_item != self.Tree.GetRootItem())

   178

                               else None)

   179

            # Don't save selected item if it is a category

   180

            selected_infos = ((self.Tree.GetItemText(selected_item),

   181

                               selected_pydata["inputs"])

   182

                              if (selected_pydata is not None and

   183

                                  selected_pydata["type"] == BLOCK)

   184

                              else (None, None))

   185

   186

            # Get TreeCtrl root item (hidden)

   187

            root = self.Tree.GetRootItem()

   188

            if not root.IsOk():

   189

                # Create root if not present

   190

                root = self.Tree.AddRoot("")

   191

   192

            # Iterate over functions and function blocks library categories and

   193

            # add a tree item to root item for each of them

   194

   195

            # Get first child under root item

   196

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

   197

            for category in blocktypes:

   198

                # Store category name in a local variable to prevent script

   199

                # extracting translated strings for gettext to consider "name"

   200

                # to be translated

   201

                category_name = category["name"]

   202

   203

                # Tree item already exists, set item label

   204

                if category_item.IsOk():

   205

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

   206

   207

                # Tree item doesn't exist, add new one to root

   208

                else:

   209

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

   210

                    # On Windows, needs to get next child of root to have a

   211

                    # reference to the newly added tree item

   212

                    if wx.Platform != '__WXMSW__':

   213

                        category_item, root_cookie = \

   214

                            self.Tree.GetNextChild(root, root_cookie)

   215

   216

                # Set data associated to tree item (only save that item is a

   217

                # category)

   218

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

   219

   220

                # Iterate over functions and function blocks defined in library

   221

                # category add a tree item to category tree item for each of

   222

                # them

   223

   224

                # Get first child under category tree item

   225

                blocktype_item, category_cookie = \

   226

                    self.Tree.GetFirstChild(category_item)

   227

                for blocktype in category["list"]:

   228

   229

                    # Tree item already exists, set item label

   230

                    if blocktype_item.IsOk():

   231

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

   232

   233

                    # Tree item doesn't exist, add new one to category item

   234

                    else:

   235

                        blocktype_item = self.Tree.AppendItem(

   236

                            category_item, blocktype["name"])

   237

                        # See comment when adding category

   238

                        if wx.Platform != '__WXMSW__':

   239

                            blocktype_item, category_cookie = \

   240

                                self.Tree.GetNextChild(category_item,

   241

                                                       category_cookie)

   242

   243

                    # Define data to associate to block tree item

   244

                    comment = blocktype["comment"]

   245

                    block_data = {

   246

                        "type":       BLOCK,

   247

                        "block_type": blocktype["type"],

   248

                        "inputs":     tuple([type

   249

                                             for _name, type, _modifier

   250

                                             in blocktype["inputs"]]),

   251

                        "extension":  (len(blocktype["inputs"])

   252

                                       if blocktype["extensible"] else None),

   253

                        "comment":    _(comment) + blocktype.get("usage", "")

   254

                    }

   255

                    self.Tree.SetPyData(blocktype_item, block_data)

   256

   257

                    # Select block tree item in tree if it corresponds to

   258

                    # previously selected one

   259

                    if selected_infos == (blocktype["name"],

   260

                                          blocktype["inputs"]):

   261

                        self.Tree.SelectItem(blocktype_item)

   262

   263

                        # Update TextCtrl value

   264

                        self.Comment.SetValue(block_data["comment"])

   265

   266

                    # Get next block tree item under category tree item

   267

                    blocktype_item, category_cookie = \

   268

                        self.Tree.GetNextChild(category_item, category_cookie)

   269

   270

                # Add every remaining tree item under category tree item after

   271

                # updating all block items to the list of items to delete

   272

                while blocktype_item.IsOk():

   273

                    items_to_delete.append(blocktype_item)

   274

                    blocktype_item, category_cookie = \

   275

                        self.Tree.GetNextChild(category_item, category_cookie)

   276

   277

                # Get next category tree item under root item

   278

                category_item, root_cookie = \

   279

                    self.Tree.GetNextChild(root, root_cookie)

   280

   281

            # Add every remaining tree item under root item after updating all

   282

            # category items to the list of items to delete

   283

            while category_item.IsOk():

   284

                items_to_delete.append(category_item)

   285

                category_item, root_cookie = \

   286

                    self.Tree.GetNextChild(root, root_cookie)

   287

   288

            # Remove all items in list of items to delete from TreeCtrl

   289

            for item in items_to_delete:

   290

                self.Tree.Delete(item)

   291

   292

    def GetSelectedBlock(self):

   293

        """

   294

        Get selected block informations

   295

        @return: {"type": block_type_name, "inputs": [input_type,...]} or None

   296

        if no block selected

   297

        """

   298

        # Get selected item associated data in tree

   299

        selected_item = self.Tree.GetSelection()

   300

        selected_pydata = (self.Tree.GetPyData(selected_item)

   301

                           if (selected_item.IsOk() and

   302

                               selected_item != self.Tree.GetRootItem())

   303

                           else None)

   304

   305

        # Return value is None if selected tree item is root or a category

   306

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

   307

                 "inputs": selected_pydata["inputs"]}

   308

                if (selected_pydata is not None and

   309

                    selected_pydata["type"] == BLOCK)

   310

                else None)

   311

   312

    def SelectTreeItem(self, name, inputs):

   313

        """

   314

        Select Tree item corresponding to block informations given

   315

        @param name: Block type name

   316

        @param inputs: List of block inputs type [input_type,...]

   317

        """

   318

        # Find tree item corresponding to block informations

   319

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

   320

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

   321

            # Select tree item found

   322

            self.Tree.SelectItem(item)

   323

            self.Tree.EnsureVisible(item)

   324

   325

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

   326

        """

   327

        Find Tree item corresponding to block informations given

   328

        Function is recursive

   329

        @param item: Item to test

   330

        @param name: Block type name

   331

        @param inputs: List of block inputs type [input_type,...]

   332

        """

   333

        # Return immediately if item isn't valid

   334

        if not item.IsOk():

   335

            return None

   336

   337

        # Get data associated to item to test

   338

        item_pydata = self.Tree.GetPyData(item)

   339

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

   340

            # Only test item corresponding to block

   341

   342

            # Test if block inputs type are the same than those given

   343

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

   344

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

   345

            if inputs is not None and type_inputs is not None:

   346

                same_inputs = reduce(

   347

                    lambda x, y: x and y,

   348

                    map(

   349

                        lambda x: x[0] == x[1] or x[0] == 'ANY' or x[1] == 'ANY',

   350

                        zip(type_inputs,

   351

                            (inputs[:type_extension]

   352

                             if type_extension is not None

   353

                             else inputs))),

   354

                    True)

   355

            else:

   356

                same_inputs = True

   357

   358

            # Return item if  block data corresponds to informations given

   359

            if self.Tree.GetItemText(item) == name and same_inputs:

   360

                return item

   361

   362

        # Test item children if item doesn't correspond

   363

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

   364

        while child.IsOk():

   365

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

   366

            if result:

   367

                return result

   368

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

   369

   370

        return None

   371

   372

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

   373

        """

   374

        Search in Tree and select item that name contains string given

   375

        @param value: String contained in block name to find

   376

        @param mode: Search mode ('first', 'previous' or 'next')

   377

        (default: 'first')

   378

        @return: True if an item was found

   379

        """

   380

        # Return immediately if root isn't valid

   381

        root = self.Tree.GetRootItem()

   382

        if not root.IsOk():

   383

            return False

   384

   385

        # Set function to navigate in Tree item sibling according to search

   386

        # mode defined

   387

        sibling_function = (self.Tree.GetPrevSibling

   388

                            if mode == "previous"

   389

                            else self.Tree.GetNextSibling)

   390

   391

        # Get current selected item (for next and previous mode)

   392

        item = self.Tree.GetSelection()

   393

        if not item.IsOk() or mode == "first":

   394

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

   395

            selected = None

   396

        else:

   397

            selected = item

   398

   399

        # Navigate through tree items until one matching found or reach tree

   400

        # starting or ending

   401

        while item.IsOk():

   402

   403

            # Get item data to get item type

   404

            item_pydata = self.Tree.GetPyData(item)

   405

   406

            # Item is a block category

   407

            if (item == root) or item_pydata["type"] == CATEGORY:

   408

   409

                # Get category first or last child according to search mode

   410

                # defined

   411

                child = (self.Tree.GetLastChild(item)

   412

                         if mode == "previous"

   413

                         else self.Tree.GetFirstChild(item)[0])

   414

   415

                # If category has no child, go to sibling category

   416

                item = (child if child.IsOk() else sibling_function(item))

   417

   418

            # Item is a block

   419

            else:

   420

   421

                # Extract item block name

   422

                name = self.Tree.GetItemText(item)

   423

                # Test if block name contains string given

   424

                if name.upper().find(value.upper()) != -1 and item != selected:

   425

                    # Select block and collapse all categories other than block

   426

                    # category

   427

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

   428

                    while child.IsOk():

   429

                        self.Tree.CollapseAllChildren(child)

   430

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

   431

                    self.Tree.SelectItem(item)

   432

                    self.Tree.EnsureVisible(item)

   433

                    return True

   434

   435

                # Go to next item sibling if block not found

   436

                next = sibling_function(item)

   437

   438

                # If category has no other child, go to next category sibling

   439

                item = (next

   440

                        if next.IsOk()

   441

                        else sibling_function(self.Tree.GetItemParent(item)))

   442

   443

        return False

   444

   445

    def OnSearchCtrlChanged(self, event):

   446

        """

   447

        Called when SearchCtrl text control value changed

   448

        @param event: TextCtrl change event

   449

        """

   450

        # Search for block containing SearchCtrl value in 'first' mode

   451

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

   452

        event.Skip()

   453

   454

    def OnSearchButtonClick(self, event):

   455

        """

   456

        Called when SearchCtrl search button was clicked

   457

        @param event: Button clicked event

   458

        """

   459

        # Search for block containing SearchCtrl value in 'next' mode

   460

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

   461

        event.Skip()

   462

   463

    def OnTreeItemSelected(self, event):

   464

        """

   465

        Called when tree item is selected

   466

        @param event: wx.TreeEvent

   467

        """

   468

        # Update TextCtrl value with block selected usage

   469

        item_pydata = self.Tree.GetPyData(event.GetItem())

   470

        self.Comment.SetValue(

   471

            item_pydata["comment"]

   472

            if item_pydata is not None and item_pydata["type"] == BLOCK

   473

            else "")

   474

   475

        # Call extra function defined when tree item is selected

   476

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

   477

            self._OnTreeItemSelected(event)

   478

   479

        event.Skip()

   480

   481

    def OnTreeBeginDrag(self, event):

   482

        """

   483

        Called when a drag is started in tree

   484

        @param event: wx.TreeEvent

   485

        """

   486

        selected_item = event.GetItem()