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

    26

from functools import reduce

    27

import wx

    28

    29

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

    30

#                                 Helpers

    31

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

    32

    33

    34

[CATEGORY, BLOCK] = list(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 SetController(self, controller):

   118

        """

   119

        Set reference to project controller

   120

        @param controller: Reference to project controller

   121

        """

   122

        self.Controller = controller

   123

   124

    def SetBlockList(self, blocklist):

   125

        """

   126

        Set function and function block library to display in TreeCtrl

   127

        @param blocklist: Function and function block library

   128

        """

   129

        # Save functions and function blocks library

   130

        self.BlockList = blocklist

   131

        # Refresh TreeCtrl values

   132

        self.RefreshTree()

   133

   134

    def SetFocus(self):

   135

        """

   136

        Called to give focus to LibraryPanel

   137

        Override wx.Window SetFocus method

   138

        """

   139

        # Give focus to SearchCtrl

   140

        self.SearchCtrl.SetFocus()

   141

   142

    def ResetTree(self):

   143

        """

   144

        Reset LibraryPanel values displayed in controls

   145

        """

   146

        # Clear SearchCtrl, TreeCtrl and TextCtrl

   147

        self.SearchCtrl.SetValue("")

   148

        self.Tree.DeleteAllItems()

   149

        self.Comment.SetValue("")

   150

   151

    def RefreshTree(self):

   152

        """

   153

        Refresh LibraryPanel values displayed in controls

   154

        """

   155

        # Get function and function blocks library

   156

        blocktypes = self.BlockList

   157

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

   158

            # Get library from project controller if not defined

   159

            blocktypes = self.Controller.GetBlockTypes()

   160

   161

        # Refresh TreeCtrl values if a library is defined

   162

        if blocktypes is not None:

   163

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

   164

            # will be refreshed

   165

            items_to_delete = []

   166

   167

            # Get current selected item for selected it when values refreshed

   168

            selected_item = self.Tree.GetSelection()

   169

            selected_pydata = (self.Tree.GetItemData(selected_item)

   170

                               if (selected_item.IsOk() and

   171

                                   selected_item != self.Tree.GetRootItem())

   172

                               else None)

   173

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

   174

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

   175

                               selected_pydata["inputs"])

   176

                              if (selected_pydata is not None and

   177

                                  selected_pydata["type"] == BLOCK)

   178

                              else (None, None))

   179

   180

            # Get TreeCtrl root item (hidden)

   181

            root = self.Tree.GetRootItem()

   182

            if not root.IsOk():

   183

                # Create root if not present

   184

                root = self.Tree.AddRoot("")

   185

   186

            # Iterate over functions and function blocks library categories and

   187

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

   188

   189

            # Get first child under root item

   190

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

   191

            for category in blocktypes:

   192

                # Store category name in a local variable to prevent script

   193

                # extracting translated strings for gettext to consider "name"

   194

                # to be translated

   195

                category_name = category["name"]

   196

   197

                # Tree item already exists, set item label

   198

                if category_item.IsOk():

   199

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

   200

   201

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

   202

                else:

   203

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

   204

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

   205

                    # reference to the newly added tree item

   206

                    if wx.Platform != '__WXMSW__':

   207

                        category_item, root_cookie = \

   208

                            self.Tree.GetNextChild(root, root_cookie)

   209

   210

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

   211

                # category)

   212

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

   213

   214

                # Iterate over functions and function blocks defined in library

   215

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

   216

                # them

   217

   218

                # Get first child under category tree item

   219

                blocktype_item, category_cookie = \

   220

                    self.Tree.GetFirstChild(category_item)

   221

                for blocktype in category["list"]:

   222

   223

                    # Tree item already exists, set item label

   224

                    if blocktype_item.IsOk():

   225

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

   226

   227

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

   228

                    else:

   229

                        blocktype_item = self.Tree.AppendItem(

   230

                            category_item, blocktype["name"])

   231

                        # See comment when adding category

   232

                        if wx.Platform != '__WXMSW__':

   233

                            blocktype_item, category_cookie = \

   234

                                self.Tree.GetNextChild(category_item,

   235

                                                       category_cookie)

   236

   237

                    # Define data to associate to block tree item

   238

                    comment = blocktype["comment"]

   239

                    block_data = {

   240

                        "type":       BLOCK,

   241

                        "block_type": blocktype["type"],

   242

                        "inputs":     tuple([type

   243

                                             for _name, type, _modifier

   244

                                             in blocktype["inputs"]]),

   245

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

   246

                                       if blocktype["extensible"] else None),

   247

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

   248

                    }

   249

                    self.Tree.SetItemData(blocktype_item, block_data)

   250

   251

                    # Select block tree item in tree if it corresponds to

   252

                    # previously selected one

   253

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

   254

                                          blocktype["inputs"]):

   255

                        self.Tree.SelectItem(blocktype_item)

   256

   257

                        # Update TextCtrl value

   258

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

   259

   260

                    # Get next block tree item under category tree item

   261

                    blocktype_item, category_cookie = \

   262

                        self.Tree.GetNextChild(category_item, category_cookie)

   263

   264

                # Add every remaining tree item under category tree item after

   265

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

   266

                while blocktype_item.IsOk():

   267

                    items_to_delete.append(blocktype_item)

   268

                    blocktype_item, category_cookie = \

   269

                        self.Tree.GetNextChild(category_item, category_cookie)

   270

   271

                # Get next category tree item under root item

   272

                category_item, root_cookie = \

   273

                    self.Tree.GetNextChild(root, root_cookie)

   274

   275

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

   276

            # category items to the list of items to delete

   277

            while category_item.IsOk():

   278

                items_to_delete.append(category_item)

   279

                category_item, root_cookie = \

   280

                    self.Tree.GetNextChild(root, root_cookie)

   281

   282

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

   283

            for item in items_to_delete:

   284

                self.Tree.Delete(item)

   285

   286

    def GetSelectedBlock(self):

   287

        """

   288

        Get selected block informations

   289

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

   290

        if no block selected

   291

        """

   292

        # Get selected item associated data in tree

   293

        selected_item = self.Tree.GetSelection()

   294

        selected_pydata = (self.Tree.GetItemData(selected_item)

   295

                           if (selected_item.IsOk() and

   296

                               selected_item != self.Tree.GetRootItem())

   297

                           else None)

   298

   299

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

   300

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

   301

                 "inputs": selected_pydata["inputs"]}

   302

                if (selected_pydata is not None and

   303

                    selected_pydata["type"] == BLOCK)

   304

                else None)

   305

   306

    def SelectTreeItem(self, name, inputs):

   307

        """

   308

        Select Tree item corresponding to block informations given

   309

        @param name: Block type name

   310

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

   311

        """

   312

        # Find tree item corresponding to block informations

   313

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

   314

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

   315

            # Select tree item found

   316

            self.Tree.SelectItem(item)

   317

            self.Tree.EnsureVisible(item)

   318

   319

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

   320

        """

   321

        Find Tree item corresponding to block informations given

   322

        Function is recursive

   323

        @param item: Item to test

   324

        @param name: Block type name

   325

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

   326

        """

   327

        # Return immediately if item isn't valid

   328

        if not item.IsOk():

   329

            return None

   330

   331

        # Get data associated to item to test

   332

        item_pydata = self.Tree.GetItemData(item)

   333

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

   334

            # Only test item corresponding to block

   335

   336

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

   337

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

   338

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

   339

            if inputs is not None and type_inputs is not None:

   340

                same_inputs = reduce(

   341

                    lambda x, y: x and y,

   342

                    [x[0] == x[1] or x[0] == 'ANY' or x[1] == 'ANY' for x in zip(type_inputs,

   343

                            (inputs[:type_extension]

   344

                             if type_extension is not None

   345

                             else inputs))],

   346

                    True)

   347

            else:

   348

                same_inputs = True

   349

   350

            # Return item if  block data corresponds to informations given

   351

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

   352

                return item

   353

   354

        # Test item children if item doesn't correspond

   355

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

   356

        while child.IsOk():

   357

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

   358

            if result:

   359

                return result

   360

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

   361

   362

        return None

   363

   364

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

   365

        """

   366

        Search in Tree and select item that name contains string given

   367

        @param value: String contained in block name to find

   368

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

   369

        (default: 'first')

   370

        @return: True if an item was found

   371

        """

   372

        # Return immediately if root isn't valid

   373

        root = self.Tree.GetRootItem()

   374

        if not root.IsOk():

   375

            return False

   376

   377

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

   378

        # mode defined

   379

        sibling_function = (self.Tree.GetPrevSibling

   380

                            if mode == "previous"

   381

                            else self.Tree.GetNextSibling)

   382

   383

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

   384

        item = self.Tree.GetSelection()

   385

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

   386

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

   387

            selected = None

   388

        else:

   389

            selected = item

   390

   391

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

   392

        # starting or ending

   393

        while item.IsOk():

   394

   395

            # Get item data to get item type

   396

            item_pydata = self.Tree.GetItemData(item)

   397

   398

            # Item is a block category

   399

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

   400

   401

                # Get category first or last child according to search mode

   402

                # defined

   403

                child = (self.Tree.GetLastChild(item)

   404

                         if mode == "previous"

   405

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

   406

   407

                # If category has no child, go to sibling category

   408

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

   409

   410

            # Item is a block

   411

            else:

   412

   413

                # Extract item block name

   414

                name = self.Tree.GetItemText(item)

   415

                # Test if block name contains string given

   416

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

   417

                    # Select block and collapse all categories other than block

   418

                    # category

   419

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

   420

                    while child.IsOk():

   421

                        self.Tree.CollapseAllChildren(child)

   422

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

   423

                    self.Tree.SelectItem(item)

   424

                    self.Tree.EnsureVisible(item)

   425

                    return True

   426

   427

                # Go to next item sibling if block not found

   428

                next = sibling_function(item)

   429

   430

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

   431

                item = (next

   432

                        if next.IsOk()

   433

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

   434

   435

        return False

   436

   437

    def OnSearchCtrlChanged(self, event):

   438

        """

   439

        Called when SearchCtrl text control value changed

   440

        @param event: TextCtrl change event

   441

        """

   442

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

   443

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

   444

        event.Skip()

   445

   446

    def OnSearchButtonClick(self, event):

   447

        """

   448

        Called when SearchCtrl search button was clicked

   449

        @param event: Button clicked event

   450

        """

   451

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

   452

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

   453

        event.Skip()

   454

   455

    def OnTreeItemSelected(self, event):

   456

        """

   457

        Called when tree item is selected

   458

        @param event: wx.TreeEvent

   459

        """

   460

        # Update TextCtrl value with block selected usage

   461

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

   462

        self.Comment.SetValue(

   463

            item_pydata["comment"]

   464

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

   465

            else "")

   466

   467

        # Call extra function defined when tree item is selected

   468

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

   469

            self._OnTreeItemSelected(event)

   470

   471

        event.Skip()

   472

   473

    def OnTreeBeginDrag(self, event):

   474

        """

   475

        Called when a drag is started in tree

   476

        @param event: wx.TreeEvent

   477

        """

   478

        selected_item = event.GetItem()

   479

        item_pydata = self.Tree.GetItemData(selected_item)

   480

   481

        # Item dragged is a block

   482

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

   483

            # Start a drag'n drop

   484

            data = wx.TextDataObject(str(

   485

                (self.Tree.GetItemText(selected_item),