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

from functools import reduce

    27

import wx

    28

    29

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

    30

#                                 Helpers

    31

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

    32

    33

    34

[CATEGORY, BLOCK] = range(2)

    35

    36

    37

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

    38

#                              Library Panel

    39

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

    40

    41

    42

class LibraryPanel(wx.Panel):

    43

    """

    44

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

    45

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

    46

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

    47

    displaying informations about selected functions or function blocks

    48

    """

    49

    50

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

    51

        """

    52

        Constructor

    53

        @param parent: Parent wx.Window of LibraryPanel

    54

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

    55

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

    56

        """

    57

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

    58

    59

        # Define LibraryPanel main sizer

    60

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

    61

        main_sizer.AddGrowableCol(0)

    62

        main_sizer.AddGrowableRow(1)

    63

    64

        # Add SearchCtrl to main sizer

    65

        self.SearchCtrl = wx.SearchCtrl(self)

    66

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

    67

        # control is for searching in tree

    68

        self.SearchCtrl.ShowSearchButton(True)

    69

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

    70

        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN,

    71

                  self.OnSearchButtonClick, self.SearchCtrl)

    72

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

    73

        # for search previous and next occurrence

    74

    75

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

    76

        if self.SearchCtrl.GetChildren():

    77

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

    78

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

    79

    80

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

    81

    82

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

    83

        splitter_window = wx.SplitterWindow(self)

    84

        splitter_window.SetSashGravity(1.0)

    85

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

    86

    87

        # Add TreeCtrl for functions and function blocks library in splitter

    88

        # window

    89

        self.Tree = wx.TreeCtrl(splitter_window,

    90

                                size=wx.Size(0, 0),

    91

                                style=(wx.TR_HAS_BUTTONS |

    92

                                       wx.TR_SINGLE |

    93

                                       wx.SUNKEN_BORDER |

    94

                                       wx.TR_HIDE_ROOT |

    95

                                       wx.TR_LINES_AT_ROOT))

    96

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

    97

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

    98

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

    99

        # tree to start a drag'n drop

   100

        if enable_drag:

   101

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

   102

   103

        # Add TextCtrl for function and function block informations

   104

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

   105

                                   style=wx.TE_READONLY | wx.TE_MULTILINE)

   106

   107

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

   108

   109

        self.SetSizer(main_sizer)

   110

   111

        # Reference to the project controller

   112

        self.Controller = None

   113

   114

        # Variable storing functions and function blocks library to display

   115

        self.BlockList = None

   116

   117

    def __del__(self):

   118

        """

   119

        Destructor

   120

        """

   121

        # Remove reference to project controller

   122

        self.Controller = None

   123

   124

    def SetController(self, controller):

   125

        """

   126

        Set reference to project controller

   127

        @param controller: Reference to project controller

   128

        """

   129

        self.Controller = controller

   130

   131

    def SetBlockList(self, blocklist):

   132

        """

   133

        Set function and function block library to display in TreeCtrl

   134

        @param blocklist: Function and function block library

   135

        """

   136

        # Save functions and function blocks library

   137

        self.BlockList = blocklist

   138

        # Refresh TreeCtrl values

   139

        self.RefreshTree()

   140

   141

    def SetFocus(self):

   142

        """

   143

        Called to give focus to LibraryPanel

   144

        Override wx.Window SetFocus method

   145

        """

   146

        # Give focus to SearchCtrl

   147

        self.SearchCtrl.SetFocus()

   148

   149

    def ResetTree(self):

   150

        """

   151

        Reset LibraryPanel values displayed in controls

   152

        """

   153

        # Clear SearchCtrl, TreeCtrl and TextCtrl

   154

        self.SearchCtrl.SetValue("")

   155

        self.Tree.DeleteAllItems()

   156

        self.Comment.SetValue("")

   157

   158

    def RefreshTree(self):

   159

        """

   160

        Refresh LibraryPanel values displayed in controls

   161

        """

   162

        # Get function and function blocks library

   163

        blocktypes = self.BlockList

   164

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

   165

            # Get library from project controller if not defined

   166

            blocktypes = self.Controller.GetBlockTypes()

   167

   168

        # Refresh TreeCtrl values if a library is defined

   169

        if blocktypes is not None:

   170

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

   171

            # will be refreshed

   172

            items_to_delete = []

   173

   174

            # Get current selected item for selected it when values refreshed

   175

            selected_item = self.Tree.GetSelection()

   176

            selected_pydata = (self.Tree.GetPyData(selected_item)

   177

                               if (selected_item.IsOk() and

   178

                                   selected_item != self.Tree.GetRootItem())

   179

                               else None)

   180

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

   181

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

   182

                               selected_pydata["inputs"])

   183

                              if (selected_pydata is not None and

   184

                                  selected_pydata["type"] == BLOCK)

   185

                              else (None, None))

   186

   187

            # Get TreeCtrl root item (hidden)

   188

            root = self.Tree.GetRootItem()

   189

            if not root.IsOk():

   190

                # Create root if not present

   191

                root = self.Tree.AddRoot("")

   192

   193

            # Iterate over functions and function blocks library categories and

   194

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

   195

   196

            # Get first child under root item

   197

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

   198

            for category in blocktypes:

   199

                # Store category name in a local variable to prevent script

   200

                # extracting translated strings for gettext to consider "name"

   201

                # to be translated

   202

                category_name = category["name"]

   203

   204

                # Tree item already exists, set item label

   205

                if category_item.IsOk():

   206

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

   207

   208

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

   209

                else:

   210

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

   211

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

   212

                    # reference to the newly added tree item

   213

                    if wx.Platform != '__WXMSW__':

   214

                        category_item, root_cookie = \

   215

                            self.Tree.GetNextChild(root, root_cookie)

   216

   217

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

   218

                # category)

   219

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

   220

   221

                # Iterate over functions and function blocks defined in library

   222

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

   223

                # them

   224

   225

                # Get first child under category tree item

   226

                blocktype_item, category_cookie = \

   227

                    self.Tree.GetFirstChild(category_item)

   228

                for blocktype in category["list"]:

   229

   230

                    # Tree item already exists, set item label

   231

                    if blocktype_item.IsOk():

   232

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

   233

   234

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

   235

                    else:

   236

                        blocktype_item = self.Tree.AppendItem(

   237

                            category_item, blocktype["name"])

   238

                        # See comment when adding category

   239

                        if wx.Platform != '__WXMSW__':

   240

                            blocktype_item, category_cookie = \

   241

                                self.Tree.GetNextChild(category_item,

   242

                                                       category_cookie)

   243

   244

                    # Define data to associate to block tree item

   245

                    comment = blocktype["comment"]

   246

                    block_data = {

   247

                        "type":       BLOCK,

   248

                        "block_type": blocktype["type"],

   249

                        "inputs":     tuple([type

   250

                                             for _name, type, _modifier

   251

                                             in blocktype["inputs"]]),

   252

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

   253

                                       if blocktype["extensible"] else None),

   254

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

   255

                    }

   256

                    self.Tree.SetItemData(blocktype_item, block_data)

   257

   258

                    # Select block tree item in tree if it corresponds to

   259

                    # previously selected one

   260

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

   261

                                          blocktype["inputs"]):

   262

                        self.Tree.SelectItem(blocktype_item)

   263

   264

                        # Update TextCtrl value

   265

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

   266

   267

                    # Get next block tree item under category tree item

   268

                    blocktype_item, category_cookie = \

   269

                        self.Tree.GetNextChild(category_item, category_cookie)

   270

   271

                # Add every remaining tree item under category tree item after

   272

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

   273

                while blocktype_item.IsOk():

   274

                    items_to_delete.append(blocktype_item)

   275

                    blocktype_item, category_cookie = \

   276

                        self.Tree.GetNextChild(category_item, category_cookie)

   277

   278

                # Get next category tree item under root item

   279

                category_item, root_cookie = \

   280

                    self.Tree.GetNextChild(root, root_cookie)

   281

   282

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

   283

            # category items to the list of items to delete

   284

            while category_item.IsOk():

   285

                items_to_delete.append(category_item)

   286

                category_item, root_cookie = \

   287

                    self.Tree.GetNextChild(root, root_cookie)

   288

   289

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

   290

            for item in items_to_delete:

   291

                self.Tree.Delete(item)

   292

   293

    def GetSelectedBlock(self):

   294

        """

   295

        Get selected block informations

   296

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

   297

        if no block selected

   298

        """

   299

        # Get selected item associated data in tree

   300

        selected_item = self.Tree.GetSelection()

   301

        selected_pydata = (self.Tree.GetPyData(selected_item)

   302

                           if (selected_item.IsOk() and

   303

                               selected_item != self.Tree.GetRootItem())

   304

                           else None)

   305

   306

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

   307

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

   308

                 "inputs": selected_pydata["inputs"]}

   309

                if (selected_pydata is not None and

   310

                    selected_pydata["type"] == BLOCK)

   311

                else None)

   312

   313

    def SelectTreeItem(self, name, inputs):

   314

        """

   315

        Select Tree item corresponding to block informations given

   316

        @param name: Block type name

   317

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

   318

        """

   319

        # Find tree item corresponding to block informations

   320

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

   321

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

   322

            # Select tree item found

   323

            self.Tree.SelectItem(item)

   324

            self.Tree.EnsureVisible(item)

   325

   326

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

   327

        """

   328

        Find Tree item corresponding to block informations given

   329

        Function is recursive

   330

        @param item: Item to test

   331

        @param name: Block type name

   332

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

   333

        """

   334

        # Return immediately if item isn't valid

   335

        if not item.IsOk():

   336

            return None

   337

   338

        # Get data associated to item to test

   339

        item_pydata = self.Tree.GetPyData(item)

   340

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

   341

            # Only test item corresponding to block

   342

   343

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

   344

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

   345

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

   346

            if inputs is not None and type_inputs is not None:

   347

                same_inputs = reduce(

   348

                    lambda x, y: x and y,

   349

                    map(

   350

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

   351

                        zip(type_inputs,

   352

                            (inputs[:type_extension]

   353

                             if type_extension is not None

   354

                             else inputs))),

   355

                    True)

   356

            else:

   357

                same_inputs = True

   358

   359

            # Return item if  block data corresponds to informations given

   360

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

   361

                return item

   362

   363

        # Test item children if item doesn't correspond

   364

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

   365

        while child.IsOk():

   366

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

   367

            if result:

   368

                return result

   369

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

   370

   371

        return None

   372

   373

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

   374

        """

   375

        Search in Tree and select item that name contains string given

   376

        @param value: String contained in block name to find

   377

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

   378

        (default: 'first')

   379

        @return: True if an item was found

   380

        """

   381

        # Return immediately if root isn't valid

   382

        root = self.Tree.GetRootItem()

   383

        if not root.IsOk():

   384

            return False

   385

   386

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

   387

        # mode defined

   388

        sibling_function = (self.Tree.GetPrevSibling

   389

                            if mode == "previous"

   390

                            else self.Tree.GetNextSibling)

   391

   392

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

   393

        item = self.Tree.GetSelection()

   394

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

   395

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

   396

            selected = None

   397

        else:

   398

            selected = item

   399

   400

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

   401

        # starting or ending

   402

        while item.IsOk():

   403

   404

            # Get item data to get item type

   405

            item_pydata = self.Tree.GetPyData(item)

   406

   407

            # Item is a block category

   408

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

   409

   410

                # Get category first or last child according to search mode

   411

                # defined

   412

                child = (self.Tree.GetLastChild(item)

   413

                         if mode == "previous"

   414

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

   415

   416

                # If category has no child, go to sibling category

   417

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

   418

   419

            # Item is a block

   420

            else:

   421

   422

                # Extract item block name

   423

                name = self.Tree.GetItemText(item)

   424

                # Test if block name contains string given

   425

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

   426

                    # Select block and collapse all categories other than block

   427

                    # category

   428

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

   429

                    while child.IsOk():

   430

                        self.Tree.CollapseAllChildren(child)

   431

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

   432

                    self.Tree.SelectItem(item)

   433

                    self.Tree.EnsureVisible(item)

   434

                    return True

   435

   436

                # Go to next item sibling if block not found

   437

                next = sibling_function(item)

   438

   439

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

   440

                item = (next

   441

                        if next.IsOk()

   442

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

   443

   444

        return False

   445

   446

    def OnSearchCtrlChanged(self, event):

   447

        """

   448

        Called when SearchCtrl text control value changed

   449

        @param event: TextCtrl change event

   450

        """

   451

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

   452

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

   453

        event.Skip()

   454

   455

    def OnSearchButtonClick(self, event):

   456

        """

   457

        Called when SearchCtrl search button was clicked

   458

        @param event: Button clicked event

   459

        """

   460

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

   461

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

   462

        event.Skip()

   463

   464

    def OnTreeItemSelected(self, event):

   465

        """

   466

        Called when tree item is selected

   467

        @param event: wx.TreeEvent

   468

        """

   469

        # Update TextCtrl value with block selected usage

   470

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

   471

        self.Comment.SetValue(

   472

            item_pydata["comment"]

   473

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

   474

            else "")

   475

   476

        # Call extra function defined when tree item is selected

   477

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

   478

            self._OnTreeItemSelected(event)

   479

   480

        event.Skip()

   481

   482

    def OnTreeBeginDrag(self, event):

   483

        """

   484

        Called when a drag is started in tree

   485

        @param event: wx.TreeEvent